kmod/libkmod
Lucas De Marchi 3a92fc6309 libkmod: Allow to ignore log message on module removal
Caller may want to handle retries, in which case the log message is not
appropriate.

Signed-off-by: Lucas De Marchi <lucas.de.marchi@gmail.com>
2022-06-26 23:23:46 -07:00
..
docs docs: Add missing functions to documentation 2022-03-03 00:57:10 -08:00
python
.gitignore
COPYING
Makefile
README
libkmod-builtin.c libkmod: fix possible double free with wrong modules.builtin.modinfo 2021-04-17 13:41:42 -07:00
libkmod-config.c libkmod-config: fix a memory leak when kmod_list_append() fails 2021-04-09 08:12:01 -07:00
libkmod-elf.c libkmod-elf: resolve CRC if module is built with MODULE_REL_CRCS 2017-08-04 08:20:24 -07:00
libkmod-file.c add Zstandard compression support 2020-09-10 21:55:01 -07:00
libkmod-index.c libkmod: fix return error when opening index 2020-03-23 12:37:40 -07:00
libkmod-index.h libkmod: fix return error when opening index 2020-03-23 12:37:40 -07:00
libkmod-internal.h libkmod: add a library notice log level print 2021-09-23 00:59:38 -07:00
libkmod-list.c
libkmod-module.c libkmod: Allow to ignore log message on module removal 2022-06-26 23:23:46 -07:00
libkmod-signature.c libkmod-signature: use PKCS#7 instead of CMS 2019-05-28 15:22:18 -07:00
libkmod.c Support /usr/local for configuration files 2021-01-18 18:26:36 -08:00
libkmod.h libkmod: Allow to ignore log message on module removal 2022-06-26 23:23:46 -07:00
libkmod.pc.in add Zstandard compression support 2020-09-10 21:55:01 -07:00
libkmod.sym libkmod: Add lookup from module name 2022-02-20 20:58:11 -08:00

README

libkmod - linux kernel module handling library

ABSTRACT
========

libkmod was created to allow programs to easily insert, remove and
list modules, also checking its properties, dependencies and aliases.

there is no shared/global context information and it can be used by
multiple sites on a single program, also being able to be used from
threads, although it's not thread safe (you must lock explicitly).


OVERVIEW
========

Every user should create and manage it's own library context with:

   struct kmod_ctx *ctx = kmod_new(kernel_dirname);
   kmod_unref(ctx);


Modules can be created by various means:

   struct kmod_module *mod;
   int err;

   err = kmod_module_new_from_path(ctx, path, &mod);
   if (err < 0) {
      /* code */
   } else {
      /* code */
      kmod_module_unref(mod);
   }

   err = kmod_module_new_from_name(ctx, name, &mod);
   if (err < 0) {
      /* code */
   } else {
      /* code */
      kmod_module_unref(mod);
   }


Or could be resolved from a known alias to a list of alternatives:

   struct kmod_list *list, *itr;
   int err;
   err = kmod_module_new_from_lookup(ctx, alias, &list);
   if (err < 0) {
      /* code */
   } else {
      kmod_list_foreach(itr, list) {
         struct kmod_module *mod = kmod_module_get_module(itr);
         /* code */
      }
   }