kmod_new ()

struct kmod_ctx *
kmod_new (const char *dirname,
          const char * const *config_paths);

Create kmod library context. This reads the kmod configuration and fills in the default values.

The initial refcount is 1, and needs to be decremented to release the resources of the kmod library context.

kmod_ref ()

struct kmod_ctx *
kmod_ref (struct kmod_ctx *ctx);

Take a reference of the kmod library context.

kmod_unref ()

struct kmod_ctx *
kmod_unref (struct kmod_ctx *ctx);

Drop a reference of the kmod library context. If the refcount reaches zero, the resources of the context will be released.

kmod_load_resources ()

int
kmod_load_resources (struct kmod_ctx *ctx);

Load indexes and keep them open in ctx . This way it's faster to lookup information within the indexes. If this function is not called before a search, the necessary index is always opened and closed.

If user will do more than one or two lookups, insertions, deletions, most likely it's good to call this function first. Particularly in a daemon like udev that on bootup issues hundreds of calls to lookup the index, calling this function will speedup the searches.

kmod_unload_resources ()

void
kmod_unload_resources (struct kmod_ctx *ctx);

Unload all the indexes. This will free the resources to maintain the index open and all subsequent searches will need to open and close the index.

User is free to call kmod_load_resources() and kmod_unload_resources() as many times as wanted during the lifecycle of ctx . For example, if a daemon knows that when starting up it will lookup a lot of modules, it could call kmod_load_resources() and after the first burst of searches is gone, it could free the resources by calling kmod_unload_resources().

kmod_validate_resources ()

int
kmod_validate_resources (struct kmod_ctx *ctx);

Check if indexes and configuration files changed on disk and the current context is not valid anymore.

kmod_dump_index ()

int
kmod_dump_index (struct kmod_ctx *ctx,
                 enum kmod_index type,
                 int fd);

Dump index to file descriptor. Note that this function doesn't use stdio.h so call fflush() before calling this function to be sure data is written in order.

kmod_set_log_priority ()

void
kmod_set_log_priority (struct kmod_ctx *ctx,
                       int priority);

Set the current logging priority. The value controls which messages are logged.

kmod_get_log_priority ()

int
kmod_get_log_priority (const struct kmod_ctx *ctx);

kmod_set_log_fn ()

void
kmod_set_log_fn (struct kmod_ctx *ctx,
                 void (*log_fn) (void *log_data, int priority, const char *file, int line, const char *fn, const char *format, va_list args),
                 const void *data);

The built-in logging writes to stderr. It can be overridden by a custom function, to plug log messages into the user's logging functionality.

kmod_get_userdata ()

void *
kmod_get_userdata (const struct kmod_ctx *ctx);

Retrieve stored data pointer from library context. This might be useful to access from callbacks.

kmod_set_userdata ()

void
kmod_set_userdata (struct kmod_ctx *ctx,
                   const void *userdata);

Store custom userdata in the library context.

struct kmod_ctx

struct kmod_ctx;

Opaque object representing the library context.