kmod_module_new_from_lookup ()

int
kmod_module_new_from_lookup (struct kmod_ctx *ctx,
                             const char *given_alias,
                             struct kmod_list **list);

Create a new list of kmod modules using an alias or module name and lookup libkmod's configuration files and indexes in order to find the module. Once it's found in one of the places, it stops searching and create the list of modules that is saved in list .

The search order is: 1. aliases in configuration file; 2. module names in modules.dep index; 3. symbol aliases in modules.symbols index; 4. aliases in modules.alias index.

The initial refcount is 1, and needs to be decremented to release the resources of the kmod_module. The returned list must be released by calling kmod_module_unref_list(). Since libkmod keeps track of all kmod_modules created, they are all released upon ctx destruction too. Do not unref ctx before all the desired operations with the returned list are completed.

kmod_module_new_from_name ()

int
kmod_module_new_from_name (struct kmod_ctx *ctx,
                           const char *name,
                           struct kmod_module **mod);

Create a new struct kmod_module using the module name. name can not be an alias, file name or anything else; it must be a module name. There's no check if the module exists in the system.

This function is also used internally by many others that return a new struct kmod_module or a new list of modules.

The initial refcount is 1, and needs to be decremented to release the resources of the kmod_module. Since libkmod keeps track of all kmod_modules created, they are all released upon ctx destruction too. Do not unref ctx before all the desired operations with the returned kmod_module are done.

kmod_module_new_from_path ()

int
kmod_module_new_from_path (struct kmod_ctx *ctx,
                           const char *path,
                           struct kmod_module **mod);

Create a new struct kmod_module using the module path. path must be an existent file with in the filesystem and must be accessible to libkmod.

The initial refcount is 1, and needs to be decremented to release the resources of the kmod_module. Since libkmod keeps track of all kmod_modules created, they are all released upon ctx destruction too. Do not unref ctx before all the desired operations with the returned kmod_module are done.

If path is relative, it's treated as relative to the current working directory. Otherwise, give an absolute path.

kmod_module_ref ()

struct kmod_module *
kmod_module_ref (struct kmod_module *mod);

Take a reference of the kmod module, incrementing its refcount.

kmod_module_unref ()

struct kmod_module *
kmod_module_unref (struct kmod_module *mod);

Drop a reference of the kmod module. If the refcount reaches zero, its resources are released.

kmod_module_unref_list ()

int
kmod_module_unref_list (struct kmod_list *list);

Drop a reference of each kmod module in list and releases the resources taken by the list itself.

kmod_module_insert_module ()

int
kmod_module_insert_module (struct kmod_module *mod,
                           unsigned int flags,
                           const char *options);

Insert a module in Linux kernel. It opens the file pointed by mod , mmap'ing it and passing to kernel.

kmod_module_probe_insert_module ()

int
kmod_module_probe_insert_module (struct kmod_module *mod,
                                 unsigned int flags,
                                 const char *extra_options,
                                 int (*run_install) (struct kmod_module *m, const char *cmdline, void *data),
                                 const void *data,
                                 void (*print_action) (struct kmod_module *m, bool install, const char *options));

Insert a module in Linux kernel resolving dependencies, soft dependencies, install commands and applying blacklist.

If run_install is NULL, this function will fork and exec by calling system(3). Don't pass a NULL argument in run_install if your binary is setuid/setgid (see warning in system(3)). If you need control over the execution of an install command, give a callback function instead.

kmod_module_remove_module ()

int
kmod_module_remove_module (struct kmod_module *mod,
                           unsigned int flags);

Remove a module from Linux kernel.

kmod_module_get_module ()

struct kmod_module *
kmod_module_get_module (const struct kmod_list *entry);

Get the kmod module of this entry in the list, increasing its refcount. After it's used, unref it. Since the refcount is incremented upon return, you still have to call kmod_module_unref_list() to release the list of kmod modules.

kmod_module_get_dependencies ()

struct kmod_list *
kmod_module_get_dependencies (const struct kmod_module *mod);

Search the modules.dep index to find the dependencies of the given mod . The result is cached in mod , so subsequent calls to this function will return the already searched list of modules.

kmod_module_get_softdeps ()

int
kmod_module_get_softdeps (const struct kmod_module *mod,
                          struct kmod_list **pre,
                          struct kmod_list **post);

Get soft dependencies for this kmod module. Soft dependencies come from configuration file and are not cached in mod because it may include dependency cycles that would make we leak kmod_module. Any call to this function will search for this module in configuration, allocate a list and return the result.

Both pre and post are newly created list of kmod_module and should be unreferenced with kmod_module_unref_list().

kmod_module_apply_filter ()

int
kmod_module_apply_filter (const struct kmod_ctx *ctx,
                          enum kmod_filter filter_type,
                          const struct kmod_list *input,
                          struct kmod_list **output);

Given a list input , this function filter it out by the filter mask and save it in output .

kmod_module_get_filtered_blacklist ()

int
kmod_module_get_filtered_blacklist (const struct kmod_ctx *ctx,
                                    const struct kmod_list *input,
                                    struct kmod_list **output);

This function should not be used. Use kmod_module_apply_filter instead.

Given a list input , this function filter it out with config's blacklist and save it in output .

kmod_module_get_install_commands ()

const char *
kmod_module_get_install_commands (const struct kmod_module *mod);

Get install commands for this kmod module. Install commands come from the configuration file and are cached in mod . The first call to this function will search for this module in configuration and subsequent calls return the cached string. The install commands are returned as they were in the configuration, concatenated by ';'. No other processing is made in this string.

kmod_module_get_remove_commands ()

const char *
kmod_module_get_remove_commands (const struct kmod_module *mod);

Get remove commands for this kmod module. Remove commands come from the configuration file and are cached in mod . The first call to this function will search for this module in configuration and subsequent calls return the cached string. The remove commands are returned as they were in the configuration, concatenated by ';'. No other processing is made in this string.

kmod_module_get_name ()

const char *
kmod_module_get_name (const struct kmod_module *mod);

Get the name of this kmod module. Name is always available, independently if it was created by kmod_module_new_from_name() or another function and it's always normalized (dashes are replaced with underscores).

kmod_module_get_options ()

const char *
kmod_module_get_options (const struct kmod_module *mod);

Get options of this kmod module. Options come from the configuration file and are cached in mod . The first call to this function will search for this module in configuration and subsequent calls return the cached string.

kmod_module_get_path ()

const char *
kmod_module_get_path (const struct kmod_module *mod);

Get the path of this kmod module. If this kmod module was not created by path, it can search the modules.dep index in order to find out the module under context's dirname.

kmod_module_get_dependency_symbols ()

int
kmod_module_get_dependency_symbols (const struct kmod_module *mod,
                                    struct kmod_list **list);

Get a list of entries in ELF section ".symtab" or "__ksymtab_strings".

After use, free the list by calling kmod_module_dependency_symbols_free_list().

kmod_module_dependency_symbol_get_bind ()

int
kmod_module_dependency_symbol_get_bind
                               (const struct kmod_list *entry);

Get the bind type of a kmod module dependency_symbol.

kmod_module_dependency_symbol_get_crc ()

uint64_t
kmod_module_dependency_symbol_get_crc (const struct kmod_list *entry);

Get the crc of a kmod module dependency_symbol.

kmod_module_dependency_symbol_get_symbol ()

const char *
kmod_module_dependency_symbol_get_symbol
                               (const struct kmod_list *entry);

Get the dependency symbol of a kmod module

kmod_module_dependency_symbols_free_list ()

void
kmod_module_dependency_symbols_free_list
                               (struct kmod_list *list);

Release the resources taken by list

kmod_module_get_sections ()

struct kmod_list *
kmod_module_get_sections (const struct kmod_module *mod);

Get a list of kmod sections of this mod , as returned by Linux Kernel. The structure contained in this list is internal to libkmod and their fields can be obtained by calling kmod_module_section_get_name() and kmod_module_section_get_address().

After use, free the list by calling kmod_module_section_free_list().

kmod_module_section_free_list ()

void
kmod_module_section_free_list (struct kmod_list *list);

Release the resources taken by list

kmod_module_section_get_address ()

unsigned long
kmod_module_section_get_address (const struct kmod_list *entry);

Get the address of a kmod module section.

After use, free the list by calling kmod_module_section_free_list().

kmod_module_section_get_name ()

const char *
kmod_module_section_get_name (const struct kmod_list *entry);

kmod_module_get_symbols ()

int
kmod_module_get_symbols (const struct kmod_module *mod,
                         struct kmod_list **list);

Get a list of entries in ELF section ".symtab" or "__ksymtab_strings".

After use, free the list by calling kmod_module_symbols_free_list().

kmod_module_symbol_get_crc ()

uint64_t
kmod_module_symbol_get_crc (const struct kmod_list *entry);

Get the crc of a kmod module symbol.

kmod_module_symbol_get_symbol ()

const char *
kmod_module_symbol_get_symbol (const struct kmod_list *entry);

Get the symbol of a kmod module symbols.

kmod_module_symbols_free_list ()

void
kmod_module_symbols_free_list (struct kmod_list *list);

Release the resources taken by list

kmod_module_get_versions ()

int
kmod_module_get_versions (const struct kmod_module *mod,
                          struct kmod_list **list);

Get a list of entries in ELF section "__versions".

After use, free the list by calling kmod_module_versions_free_list().

kmod_module_version_get_crc ()

uint64_t
kmod_module_version_get_crc (const struct kmod_list *entry);

Get the crc of a kmod module version.

kmod_module_version_get_symbol ()

const char *
kmod_module_version_get_symbol (const struct kmod_list *entry);

Get the symbol of a kmod module versions.

kmod_module_versions_free_list ()

void
kmod_module_versions_free_list (struct kmod_list *list);

Release the resources taken by list

kmod_module_get_info ()

int
kmod_module_get_info (const struct kmod_module *mod,
                      struct kmod_list **list);

Get a list of entries in ELF section ".modinfo", these contain alias, license, depends, vermagic and other keys with respective values. If the module is signed (CONFIG_MODULE_SIG), information about the module signature is included as well: signer, sig_key and sig_hashalgo.

After use, free the list by calling kmod_module_info_free_list().

kmod_module_info_free_list ()

void
kmod_module_info_free_list (struct kmod_list *list);

Release the resources taken by list

kmod_module_info_get_key ()

const char *
kmod_module_info_get_key (const struct kmod_list *entry);

Get the key of a kmod module info.

kmod_module_info_get_value ()

const char *
kmod_module_info_get_value (const struct kmod_list *entry);

Get the value of a kmod module info.

struct kmod_module

struct kmod_module;

Opaque object representing a module.