kmod/libkmod
Randy MacLeod 9b34db1ae6 Add back-up implementation of be32toh()
Older systems may not have the be32toh function defined. Check for this
and fall back to checking the endianness and calling bswap_32 directly
if needed.  This works on both old and new systems.

[Thomas De Schampheleire <thomas.de.schampheleire@gmail.com>:
address comments raised by Lucas De Marchi [1], update commit message]
[1] http://www.spinics.net/lists/linux-modules/msg01129.html
2014-09-29 17:13:26 -03:00
..
docs build-sys: add small redirecting Makefiles 2014-03-06 01:59:58 -03:00
python build-sys: add hooks to build python bindings 2014-03-26 22:30:56 -03:00
.gitignore
COPYING
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-array.c array: avoid duplicate code to reallocate 2013-11-18 11:29:11 -02:00
libkmod-array.h Use #pragma once instead of #ifndef 2012-07-18 10:31:50 -03:00
libkmod-config.c config: also parse softdeps from modules 2014-04-01 08:13:54 -03:00
libkmod-elf.c libkmod-elf: Fix check by class in get_modversions() 2014-03-07 01:24:39 -03:00
libkmod-file.c file: use _cleanup_free_ 2013-11-18 11:43:10 -02:00
libkmod-hash.c Fix use-after-free in hash implementation. 2014-05-18 16:04:50 -03:00
libkmod-hash.h Use #pragma once instead of #ifndef 2012-07-18 10:31:50 -03:00
libkmod-index.c libkmod-index.c: Fix error message 2014-09-04 16:29:47 -03:00
libkmod-index.h Update copyright notices 2013-01-16 11:27:45 -02:00
libkmod-internal.h libkmod: Ignore errors from softdeps 2014-04-01 07:40:37 -03:00
libkmod-list.c Use "-internal" suffix instead of "-private" 2013-07-04 16:13:11 -03:00
libkmod-module.c Add missing O_CLOEXEC in kmod_module_get_size() 2014-06-19 18:01:37 -03:00
libkmod-signature.c Add back-up implementation of be32toh() 2014-09-29 17:13:26 -03:00
libkmod-util.c util: Be OOM-safe and use _cleanup_free_ 2013-11-18 11:01:16 -02:00
libkmod-util.h util: Add cleanup attribute 2013-11-18 04:35:04 -02:00
libkmod.c Free realnames if kmod_lookup_alias_from_alias_bin() fails 2014-05-14 20:19:52 -03:00
libkmod.h libkmod: always pass O_NONBLOCK to kernel 2013-09-20 01:37:24 -05:00
libkmod.pc.in
libkmod.sym build: remove private symbol from linker script 2012-05-10 21:11:27 -03:00
macro.h Use C11's noreturn 2013-12-17 19:10:16 -02:00
missing.h Add back-up implementation of be32toh() 2014-09-29 17:13:26 -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 */
      }
   }