Elektra  0.8.17
Macros | Enumerations | Functions
kdbprivate.h File Reference

Private declarations. More...

#include <kdb.h>
#include <kdbconfig.h>
#include <kdbextension.h>
#include <kdbhelper.h>
#include <kdbplugin.h>
#include <kdbproposal.h>
#include <kdbtypes.h>
#include <limits.h>
Include dependency graph for kdbprivate.h:
This graph shows which files directly or indirectly include this file:

Macros

#define KEYSET_SIZE   16
 The minimal allocation size of a keyset inclusive NULL byte. More...
 
#define NR_OF_PLUGINS   10
 How many plugins can exist in an backend. More...
 
#define COMMIT_PLUGIN   7
 The index of the commit plugin.
 
#define STORAGE_PLUGIN   5
 The index of the storage plugin.
 
#define RESOLVER_PLUGIN   0
 The index of the resolver plugin.
 
#define APPROXIMATE_NR_OF_BACKENDS   16
 Trie optimization.
 
#define MAX_LEN_INT   31
 The maximum of how many characters an integer needs as decimal number. More...
 
#define KDB_SYSTEM_ELEKTRA   "system/elektra"
 Backend mounting information. More...
 
#define test_bit(var, bit)   ((var) & (bit))
 Test a bit. More...
 
#define set_bit(var, bit)   ((var) |= (bit))
 Set a bit. More...
 
#define clear_bit(var, bit)   ((var) &= ~(bit))
 Clear a bit. More...
 

Enumerations

enum  keyflag_t { KEY_FLAG_SYNC = 1, KEY_FLAG_RO_NAME = 1 << 1, KEY_FLAG_RO_VALUE = 1 << 2, KEY_FLAG_RO_META = 1 << 3 }
 Key Flags. More...
 
enum  ksflag_t { KS_FLAG_SYNC = 1 }
 Ks Flags. More...
 
enum  GlobalpluginPositions
 Helper for identifying global plugin positions.
 
enum  splitflag_t { SPLIT_FLAG_SYNC = 1, SPLIT_FLAG_CASCADING = 1 << 1 }
 

Functions

Split * elektraSplitNew (void)
 Allocates a new split object. More...
 
void elektraSplitDel (Split *keysets)
 Delete a split object. More...
 
void elektraSplitResize (Split *ret)
 Doubles the size of how many parts of keysets can be appended. More...
 
void elektraSplitRemove (Split *split, size_t where)
 Remove one part of split. More...
 
ssize_t elektraSplitAppend (Split *split, Backend *backend, Key *parentKey, int syncbits)
 Increases the size of split and appends a new empty keyset. More...
 
ssize_t elektraSplitSearchBackend (Split *split, Backend *backend, Key *key)
 Determines if the backend is already inserted or not. More...
 
int elektraSplitSearchRoot (Split *split, Key *parentKey)
 
int elektraSplitBuildup (Split *split, KDB *handle, Key *parentKey)
 Walks through kdb->split and adds all backends below parentKey to split. More...
 
void elektraSplitUpdateFileName (Split *split, KDB *handle, Key *key)
 Update the (configuration) file name for the parent key. More...
 
int elektraSplitAppoint (Split *split, KDB *handle, KeySet *ks)
 Appoints all keys from ks to yet unsynced splits. More...
 
int elektraSplitGet (Split *split, Key *warningKey, KDB *handle)
 Does some work after getting of backends is finished. More...
 
int elektraSplitMerge (Split *split, KeySet *dest)
 Merges together all parts of split into dest. More...
 
int elektraSplitCheckSize (Split *split)
 Check if any of the split is uninitialized. More...
 
int elektraSplitDivide (Split *split, KDB *handle, KeySet *ks)
 Splits up the keysets and search for a sync bit in every key. More...
 
int elektraSplitSync (Split *split)
 Add sync bits everywhere keys were removed/added. More...
 
void elektraSplitPrepare (Split *split)
 Prepares for kdbSet() mainloop afterwards. More...
 
int elektraSplitUpdateSize (Split *split)
 Also update sizes after kdbSet() to recognize multiple kdbSet() attempts. More...
 
Backend * elektraBackendOpen (KeySet *elektra_config, KeySet *modules, Key *errorKey)
 Builds a backend out of the configuration supplied from: More...
 
Backend * elektraBackendOpenMissing (Key *mountpoint)
 Opens the internal backend that indicates that a backend is missing at that place. More...
 
Backend * elektraBackendOpenDefault (KeySet *modules, const char *file, Key *errorKey)
 Opens a default backend using the plugin named KDB_RESOLVER and KDB_STORAGE. More...
 
Backend * elektraBackendOpenModules (KeySet *modules, Key *errorKey)
 
Backend * elektraBackendOpenVersion (Key *errorKey)
 Opens the internal version backend. More...
 
int elektraBackendUpdateSize (Backend *backend, Key *parent, int size)
 Update internal size in backend. More...
 
int elektraProcessPlugin (Key *cur, int *pluginNumber, char **pluginName, char **referenceName, Key *errorKey)
 
int elektraProcessPlugins (Plugin **plugins, KeySet *modules, KeySet *referencePlugins, KeySet *config, KeySet *systemConfig, Key *errorKey)
 Load a plugin. More...
 
Plugin * elektraPluginOpen (const char *backendname, KeySet *modules, KeySet *config, Key *errorKey)
 Opens a plugin. More...
 
int elektraTrieClose (Trie *trie, Key *errorKey)
 Closes the trie and all opened backends within. More...
 
Backend * elektraTrieLookup (Trie *trie, const Key *key)
 Internal Datastructure for mountpoints. More...
 
int elektraMountOpen (KDB *kdb, KeySet *config, KeySet *modules, Key *errorKey)
 Creates a trie from a given configuration. More...
 
int elektraMountDefault (KDB *kdb, KeySet *modules, int inFallback, Key *errorKey)
 Reopens the default backend and mounts the default backend if needed. More...
 
int elektraMountModules (KDB *kdb, KeySet *modules, Key *errorKey)
 Mount all module configurations. More...
 
int elektraMountVersion (KDB *kdb, Key *errorKey)
 Mount the version backend. More...
 
int elektraMountBackend (KDB *kdb, Backend *backend, Key *errorKey)
 Mounts a backend into the trie. More...
 
Key * elektraMountGetMountpoint (KDB *handle, const Key *where)
 Lookup a mountpoint in a handle for a specific key. More...
 
Backend * elektraMountGetBackend (KDB *handle, const Key *key)
 Lookup a backend handle for a specific key. More...
 
Key * elektraKsPrev (KeySet *ks)
 Returns the previous Key in a KeySet. More...
 
Key * elektraKsPopAtCursor (KeySet *ks, cursor_t pos)
 Pop key at given cursor position. More...
 
int elektraKeyLock (Key *key, enum elektraLockOptions what)
 Permanently locks a part of the key. More...
 
ssize_t elektraMemcpy (Key **array1, Key **array2, size_t size)
 Internal Methods for Elektra. More...
 
ssize_t elektraMemmove (Key **array1, Key **array2, size_t size)
 Copies the key array2 into where array1 points. More...
 
char * elektraStrNDup (const char *s, size_t l)
 Copy buffer into new allocated memory. More...
 
int elektraValidateKeyName (const char *name, size_t size)
 Validates whether the supplied keyname is valid. More...
 
KeySet * elektraRenameKeys (KeySet *config, const char *name)
 Takes the first key and cuts off this common part for all other keys, instead name will be prepended. More...
 
int keyIsSystem (const Key *key)
 Check whether a key is under the system namespace or not. More...
 
int keyIsUser (const Key *key)
 Check whether a key is under the user namespace or not. More...
 

Detailed Description

Private declarations.

Macro Definition Documentation

#define clear_bit (   var,
  bit 
)    ((var) &= ~(bit))

Clear a bit.

See also
set_bit()
#define KDB_SYSTEM_ELEKTRA   "system/elektra"

Backend mounting information.

This key directory tells you where each backend is mounted to which mountpoint.

#define KEYSET_SIZE   16

The minimal allocation size of a keyset inclusive NULL byte.

ksGetAlloc() will return one less because it says how much can actually be stored.

#define MAX_LEN_INT   31

The maximum of how many characters an integer needs as decimal number.

#define NR_OF_PLUGINS   10

How many plugins can exist in an backend.

#define set_bit (   var,
  bit 
)    ((var) |= (bit))

Set a bit.

See also
clear_bit()
#define test_bit (   var,
  bit 
)    ((var) & (bit))

Test a bit.

See also
set_bit(), clear_bit()

Enumeration Type Documentation

enum keyflag_t

Key Flags.

Store a synchronizer state so that the Elektra knows if something has changed or not.

Enumerator
KEY_FLAG_SYNC 

Key need sync. If name, value or metadata are changed this flag will be set, so that the backend will sync the key to database.

KEY_FLAG_RO_NAME 

Read only flag for name. Key name is read only and not allowed to be changed. All attempts to change the name will lead to an error. Needed for meta keys and keys that are in a data structure that depends on name ordering.

KEY_FLAG_RO_VALUE 

Read only flag for value. Key value is read only and not allowed to be changed. All attempts to change the value will lead to an error. Needed for meta keys

KEY_FLAG_RO_META 

Read only flag for meta. Key meta is read only and not allowed to be changed. All attempts to change the value will lead to an error. Needed for meta keys.

enum ksflag_t

Ks Flags.

Store a synchronizer state so that the Elektra knows if something has changed or not.

Enumerator
KS_FLAG_SYNC 

KeySet need sync. If keys were popped from the Keyset this flag will be set, so that the backend will sync the keys to database.

Enumerator
SPLIT_FLAG_SYNC 

KeySet in Split need sync. Is there any key in there which need to be synced? If keys were popped from the Keyset this flag will be set, so that the backend will sync the keys to database.

SPLIT_FLAG_CASCADING 

Do we need relative checks? Is this a cascading backend?

Function Documentation

Backend* elektraBackendOpen ( KeySet *  elektraConfig,
KeySet *  modules,
Key *  errorKey 
)

Builds a backend out of the configuration supplied from:

system/elektra/mountpoints/<name>

The root key must be like the above example. You do not need to rewind the keyset. But every key must be below the root key.

The internal consistency will be checked in this function. If necessary parts are missing, like no plugins, they cant be loaded or similar 0 will be returned.

ksCut() is perfectly suitable for cutting out the configuration like needed.

Note
The given KeySet will be deleted within the function, don't use it afterwards.
Parameters
elektraConfigthe configuration to work with. It is used to build up this backend.
modulesused to load new modules or get references to existing one
errorKeythe key where an error and warnings are added
Returns
a pointer to a freshly allocated backend this could be the requested backend or a so called "missing backend".
Return values
0if out of memory
Backend* elektraBackendOpenDefault ( KeySet *  modules,
const char *  file,
Key *  errorKey 
)

Opens a default backend using the plugin named KDB_RESOLVER and KDB_STORAGE.

Parameters
modulesthe modules to work with
errorKeythe key to issue warnings and errors to
Returns
the fresh allocated default backend or 0 if it failed
Backend* elektraBackendOpenMissing ( Key *  mp)

Opens the internal backend that indicates that a backend is missing at that place.

Returns
the fresh allocated backend or 0 if no memory
Backend* elektraBackendOpenModules ( KeySet *  modules,
Key *  errorKey 
)
Returns
a backend which gives plugin configuration of the module which is currently point to.
Parameters
modulesthe modules to work with
errorKeythe key to issue warnings and errors to
Backend* elektraBackendOpenVersion ( Key *  errorKey)

Opens the internal version backend.

Parameters
errorKeythe key to issue warnings and errors to
Returns
the fresh allocated default backend or 0 if it failed
int elektraBackendUpdateSize ( Backend *  backend,
Key *  parent,
int  size 
)

Update internal size in backend.

Parameters
backendthe backend to update
parentfor parent
sizeto update (-1 default, 0 empty, >0 otherwise)
Precondition
parent must be serializable namespace
Return values
-1if invalid parent (assert)
0on success
int elektraKeyLock ( Key *  key,
enum elektraLockOptions  what 
)

Permanently locks a part of the key.

This can be:

  • KEY_FLAG_LOCK_NAME to lock the name
  • KEY_FLAG_LOCK_VALUE to lock the value
  • KEY_FLAG_LOCK_META to lock the meta data

To unlock the key, duplicate it.

It is also possible to lock when the key is created with keyNew().

Some data structures need to lock the key (most likely its name), so that the ordering does not get confused.

Parameters
keywhich name should be locked
See also
keyNew(), keyDup(), ksAppendKey()
Return values
>0the bits that were successfully locked
0if everything was locked before
-1if it could not be locked (nullpointer)
Key* elektraKsPopAtCursor ( KeySet *  ks,
cursor_t  pos 
)

Pop key at given cursor position.

Parameters
ksthe keyset to pop key from
cwhere to pop

The internal cursor will be rewinded using ksRewind(). You can use ksGetCursor() and ksSetCursor() jump back to the previous position. e.g. to pop at current position within ksNext() loop:

1 cursor_t c = ksGetCursor(ks);
2 keyDel (ksPopAtCursor(ks, c));
3 ksSetCursor(ks, c);
4 ksPrev(ks); // to have correct key after next ksNext()
Warning
do not use, will be superseded by external iterator API
Returns
the popped key
Return values
0if ks is 0
Key* elektraKsPrev ( KeySet *  ks)

Returns the previous Key in a KeySet.

KeySets have an internal cursor that can be reset with ksRewind(). Every time ksPrev() is called the cursor is decremented and the new current Key is returned.

You'll get a NULL pointer if the key before begin of the KeySet was reached.

Don't delete the key, use ksPop() if you want to delete it.

Returns
the new current Key
See also
ksRewind(), ksCurrent()
ssize_t elektraMemcpy ( Key **  array1,
Key **  array2,
size_t  size 
)

Internal Methods for Elektra.

To use them:

1 #include <kdbinternal.h>

There are some areas where libraries have to reimplement some basic functions to archive support for non-standard systems, for testing purposes or to provide a little more convenience. Copies the key array2 into where array1 points. It copies size elements.

Overlapping is prohibited, use elektraMemmove() instead.

Parameters
array1the destination
array2the source
sizehow many pointer to Keys to copy
Return values
-1on null pointers
0if nothing was done
Returns
size how many keys were copied
ssize_t elektraMemmove ( Key **  array1,
Key **  array2,
size_t  size 
)

Copies the key array2 into where array1 points.

It copies size elements.

Overlapping is ok. If they do not overlap consider elektraMemcpy() instead.

Parameters
array1the destination
array2the source
sizehow many pointer to Keys to copy
Return values
-1on null pointers
0if nothing was done
Returns
size how many keys were copied
int elektraMountBackend ( KDB *  kdb,
Backend *  backend,
Key *  errorKey 
)

Mounts a backend into the trie.

Precondition
user must pass correctly allocated backend
Postcondition
sets reference counter of backend
Warning
in case of init and default backends, the reference counter needs to be modified after calling elektraMountBackend.
Parameters
kdbthe handle to work with
backendthe backend to mount
errorKeythe key used to report warnings
Return values
-1on failure
1on success
int elektraMountDefault ( KDB *  kdb,
KeySet *  modules,
int  inFallback,
Key *  errorKey 
)

Reopens the default backend and mounts the default backend if needed.

Precondition
Default Backend is closed. elektraMountOpen was executed before.
Parameters
kdbthe handle to work with
modulesthe current list of loaded modules
errorKeythe key used to report warnings
Return values
-1on error
0on success
Backend* elektraMountGetBackend ( KDB *  handle,
const Key *  key 
)

Lookup a backend handle for a specific key.

The required canonical name is ensured by using a key as parameter, which will transform the key to canonical representation.

Will return handle when no more specific KDB could be found.

If key is 0 or invalid the default backend will be returned.

Parameters
handleis the data structure, where the mounted directories are saved.
keythe key, that should be looked up.
Returns
the backend handle associated with the key
Key* elektraMountGetMountpoint ( KDB *  handle,
const Key *  where 
)

Lookup a mountpoint in a handle for a specific key.

Will return a key representing the mountpoint or null if there is no appropriate mountpoint e.g. its the root mountpoint.

Example:
1 Key * key = keyNew ("system/template");
2 KDB * handle = kdbOpen();
3 Key *mountpoint=0;
4 mountpoint=kdbGetMountpoint(handle, key);
5 
6 printf("The backend I am using is %s mounted in %s\n",
7  keyValue(mountpoint),
8  keyName(mountpoint));
9 kdbClose (handle);
10 keyDel (key);
Parameters
handleis the data structure, where the mounted directories are saved.
wherethe key, that should be looked up.
Returns
the mountpoint associated with the key
int elektraMountModules ( KDB *  kdb,
KeySet *  modules,
Key *  errorKey 
)

Mount all module configurations.

Parameters
kdbthe handle to work with
modulesthe current list of loaded modules
errorKeythe key used to report warnings
Return values
-1if not rootkey was found
0otherwise
int elektraMountOpen ( KDB *  kdb,
KeySet *  config,
KeySet *  modules,
Key *  errorKey 
)

Creates a trie from a given configuration.

The config will be deleted within this function.

Note
elektraMountDefault is not allowed to be executed before
Parameters
kdbthe handle to work with
modulesthe current list of loaded modules
configthe configuration which should be used to build up the trie.
errorKeythe key used to report warnings
Return values
-1on failure
0on success
int elektraMountVersion ( KDB *  kdb,
Key *  errorKey 
)

Mount the version backend.

Parameters
kdbthe handle to work with
errorKeythe key used to report warnings
Return values
0on success
Plugin* elektraPluginOpen ( const char *  name,
KeySet *  modules,
KeySet *  config,
Key *  errorKey 
)

Opens a plugin.

The config will be used as is. So be sure to transfer ownership of the config to it, with e.g. ksDup(). elektraPluginClose() will delete the config.

Returns
a pointer to a new created plugin or 0 on error
int elektraProcessPlugin ( Key *  cur,
int *  pluginNumber,
char **  pluginName,
char **  referenceName,
Key *  errorKey 
)
Return values
1and an allocated string of the pluginName if a new plugins should be created.
2and an allocated string of the referenceName if an old plugin should be used
3and both if a new plugin should be created and made available for later back referencing.
-1on error
int elektraProcessPlugins ( Plugin **  plugins,
KeySet *  modules,
KeySet *  referencePlugins,
KeySet *  config,
KeySet *  systemConfig,
Key *  errorKey 
)

Load a plugin.

The array of plugins must be set to 0. Its length is NR_OF_PLUGINS.

systemConfig will only be used, not deleted.

Parameters
configthe config with the information how the plugins should be put together
systemConfigthe shared (system) config for the plugins. Every plugin additional get this config.
Return values
-1on failure
KeySet* elektraRenameKeys ( KeySet *  config,
const char *  name 
)

Takes the first key and cuts off this common part for all other keys, instead name will be prepended.

Returns
a new allocated keyset with keys in user namespace.

The first key is removed in the resulting keyset.

ssize_t elektraSplitAppend ( Split *  split,
Backend *  backend,
Key *  parentKey,
int  syncbits 
)

Increases the size of split and appends a new empty keyset.

Initializes the element with the given parameters at size-1 to be used.

Will automatically resize split if needed.

Parameters
splitthe split object to work with
backendthe backend which should be appended
parentKeythe parentKey which should be appended
syncbitsthe initial syncstate which should be appended
Return values
-1if no split is found
Returns
the position of the new element: size-1
int elektraSplitAppoint ( Split *  split,
KDB *  handle,
KeySet *  ks 
)

Appoints all keys from ks to yet unsynced splits.

Precondition
elektraSplitBuildup() need to be executed before.
Parameters
splitthe split object to work with
handleto determine to which backend a key belongs
ksthe keyset to appoint to split
Return values
1on success
-1if no backend was found for a key
int elektraSplitBuildup ( Split *  split,
KDB *  kdb,
Key *  parentKey 
)

Walks through kdb->split and adds all backends below parentKey to split.

Sets syncbits to 2 if it is a default or root backend (which needs splitting). The information is copied from kdb->split.

Precondition
split needs to be empty, directly after creation with elektraSplitNew().
there needs to be a valid defaultBackend but its ok not to have a trie inside KDB.
parentKey must be a valid key! (could be implemented more generally, but that would require splitting up of keysets of the same backend)
Parameters
splitwill get all backends appended
kdbthe handle to get information about backends
parentKeythe information below which key the backends are from interest
Return values
1always
int elektraSplitCheckSize ( Split *  split)

Check if any of the split is uninitialized.

Parameters
split
Return values
-1if size is wrong
1if everything is ok
void elektraSplitDel ( Split *  keysets)

Delete a split object.

Will free all allocated resources of a split keyset.

Parameters
keysetsthe split object to work with
int elektraSplitDivide ( Split *  split,
KDB *  handle,
KeySet *  ks 
)

Splits up the keysets and search for a sync bit in every key.

It does not check if there were removed keys, see elektraSplitSync() for the next step.

It does not create new backends, this has to be done by buildup before.

Precondition
elektraSplitBuildup() need to be executed before.
Parameters
splitthe split object to work with
handleto get information where the individual keys belong
ksthe keyset to divide
Return values
0if there were no sync bits
1if there were sync bits
-1if no backend was found for any key
int elektraSplitGet ( Split *  split,
Key *  warningKey,
KDB *  handle 
)

Does some work after getting of backends is finished.

  • Update sizes
  • Removal of wrong keys
Precondition
elektraSplitAppoint() needs to be executed before.
  • check if keys are in correct backend
  • remove syncbits
  • update sizes in the backends
Parameters
splitthe split object to work with
warningKeypostcondition violations are reported here
handlethe handle to preprocess the keys
Return values
1on success
-1if no backend was found for a key or split->parents has invalid namespace
int elektraSplitMerge ( Split *  split,
KeySet *  dest 
)

Merges together all parts of split into dest.

Parameters
splitthe split object to work with
destthe destination keyset where all keysets are appended.
Return values
1on success
Split* elektraSplitNew ( void  )

Allocates a new split object.

Splits up a keyset into multiple keysets where each of them will passed to the correct kdbSet().

Initially the size is 0 and alloc is APPROXIMATE_NR_OF_BACKENDS.

Returns
a fresh allocated split object
See also
elektraSplitDel()
void elektraSplitPrepare ( Split *  split)

Prepares for kdbSet() mainloop afterwards.

All splits which do not need sync are removed and a deep copy of the remaining keysets is done.

Parameters
splitthe split object to work with
void elektraSplitRemove ( Split *  split,
size_t  where 
)

Remove one part of split.

Parameters
splitthe split object to work with
wherethe position to cut away
Precondition
where must be within the size of the split
Postcondition
split will be removed
void elektraSplitResize ( Split *  split)

Doubles the size of how many parts of keysets can be appended.

Parameters
splitthe split object to work with
ssize_t elektraSplitSearchBackend ( Split *  split,
Backend *  backend,
Key *  parent 
)

Determines if the backend is already inserted or not.

Warning
If no parent Key is given, the default/root backends won't be searched.
Parameters
splitthe split object to work with
backendthe backend to search for
parentthe key to check for domains in default/root backends.
Returns
pos of backend if it already exist
Return values
-1if it does not exist
int elektraSplitSearchRoot ( Split *  split,
Key *  parentKey 
)
Return values
1if one of the backends in split has all keys below parentKey
0if parentKey == 0 or there are keys below or same than parentKey which do not fit in any of split keysets
Parameters
splitthe split object to work with
parentKeythe key which relation is searched for
int elektraSplitSync ( Split *  split)

Add sync bits everywhere keys were removed/added.

  • checks if the size of a previous kdbGet() is unchanged.
  • checks if in correct state (kdbGet() needs to be executed before)

Only elektraSplitDivide() together with this function can really decide if sync is needed or not.

Precondition
split needs to be processed with elektraSplitDivide() before.
Return values
0if kdbSet() is not needed
1if kdbSet() is needed
-1on wrong keys (also has assert, should not happen)
-2wrong spec state: kdbGet() was not executed before
-3wrong dir state: kdbGet() was not executed before
-4wrong user state: kdbGet() was not executed before
-5wrong system state: kdbGet() was not executed before
Precondition
user/system was split before.
Parameters
splitthe split object to work with
void elektraSplitUpdateFileName ( Split *  split,
KDB *  handle,
Key *  key 
)

Update the (configuration) file name for the parent key.

Parameters
splitthe split to work with
handlethe handle to work with
keythe parentKey that should be updated (name must be correct)
int elektraSplitUpdateSize ( Split *  split)

Also update sizes after kdbSet() to recognize multiple kdbSet() attempts.

Warning
cant use the same code with elektraSplitGet because there is no default split part for kdbSet().
char* elektraStrNDup ( const char *  s,
size_t  l 
)

Copy buffer into new allocated memory.

You need to free the memory yourself.

This function also works with \0 characters in the buffer. The length is taken as given, it must be correct.

Returns
0 if out of memory, a pointer otherwise
Parameters
smust be a allocated buffer
lthe length of s
int elektraTrieClose ( Trie *  trie,
Key *  errorKey 
)

Closes the trie and all opened backends within.

Parameters
triethe trie to close
errorKeythe key used to report warnings
Return values
0on success
Backend* elektraTrieLookup ( Trie *  trie,
const Key *  key 
)

Internal Datastructure for mountpoints.

Lookups a backend inside the trie.

Returns
the backend if found
0 otherwise
Parameters
triethe trie object to work with
keythe name of this key will be looked up
int elektraValidateKeyName ( const char *  name,
size_t  size 
)

Validates whether the supplied keyname is valid.

The function looks for tangling escape characters in the end and for a minimum length.

Does not check for valid namespaces

Precondition
size must be at least 2
Parameters
namethe key name that is to be checked
sizea elektraStrLen of the key name
Return values
trueif the supplied keyname part is valid
falseif its invalid