kmod/libkmod
Lucas De Marchi ec8818bcfb libkmod-module: Fix return code for kmod_module_new_from_lookup()
When kmod_module_new_from_lookup() resolves to an alias, `err` will be
set to a positive value from the lookup function. Do not return a
positive value to follow the behavior when it matches a module name
and the documentation.

Reviewed-by: Luis Chamberlain <mcgrof@kernel.org>
2022-02-20 20:58:11 -08:00
..
docs libkmod: fix integration with gtk-doc 2016-06-28 12:15:38 -03:00
python Fix include in python bindings 2015-01-02 13:11:39 -02:00
.gitignore Rename libabc to libkmod 2011-11-21 14:35:35 -02:00
COPYING Change licenses 2011-12-12 18:24:35 -02:00
Makefile build-sys: add small redirecting Makefiles 2014-03-06 01:59:58 -03:00
README README: Move items from TODO 2013-07-17 02:31:27 -03:00
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 Remove FSF mailing address 2014-12-25 23:41:34 -02:00
libkmod-module.c libkmod-module: Fix return code for kmod_module_new_from_lookup() 2022-02-20 20:58:11 -08: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 Lookup aliases in the modules.builtin.modinfo 2019-12-18 16:56:58 -08:00
libkmod.pc.in add Zstandard compression support 2020-09-10 21:55:01 -07:00
libkmod.sym libkmod: export new kmod_get_dirname() function 2015-09-30 15:28:24 -03: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 */
      }
   }