kmod/libkmod
Jan Engelhardt 867da6fcfb kmod: build: cure compiler warnings showing up externally
When building a C source file with gcc-7 -Wshift-overflow=2, this warning
springs up:

libkmod.h: warning: result of "1 << 31" requires 33 bits to
represent, but "int" only has 32 bits [-Wshift-overflow=]

Change the two _KMOD_* identifiers to fit into 32 bits.
2018-06-18 09:46:56 -07: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-config.c libkmod-config: fix parsing quoted kernel cmdline on params 2017-02-16 09:18:35 -08: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 Remove FSF mailing address 2014-12-25 23:41:34 -02:00
libkmod-index.c Check return of fseek while reading index 2015-02-28 16:11:53 -03:00
libkmod-index.h Remove FSF mailing address 2014-12-25 23:41:34 -02:00
libkmod-internal.h libkmod: modinfo: implement signature output 2017-04-11 09:04:28 -07:00
libkmod-list.c Remove FSF mailing address 2014-12-25 23:41:34 -02:00
libkmod-module.c libkmod-module: check for NULL before accessing pointers 2018-04-05 14:54:43 -07:00
libkmod-signature.c libkmod: modinfo: implement signature output 2017-04-11 09:04:28 -07:00
libkmod.c libkmod: export new kmod_get_dirname() function 2015-09-30 15:28:24 -03:00
libkmod.h kmod: build: cure compiler warnings showing up externally 2018-06-18 09:46:56 -07:00
libkmod.pc.in libkmod: remove external cflags from .pc file 2011-12-24 20:28:11 +01: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 */
      }
   }