kmod/libkmod
Dave Reisner 486f901392 module: support reading coresize from /sys if supported
Linux 3.3 introduced the coresize attribute in /sys/module/*. When
available, use this instead of parsing some portion of /proc/modules.
2012-06-29 13:04:41 -04:00
..
docs doc: silent man page generation and fix gtk-doc warnings 2012-04-15 18:10:10 -03: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
README Rename project from libkmod to kmod 2011-12-12 16:54:18 -02:00
libkmod-array.c Update copyright 2012-01-09 00:41:07 -02:00
libkmod-array.h utils/array: add array_remove_at() 2012-01-03 15:58:24 -02:00
libkmod-config.c libkmod-config: refactor functions to get config 2012-06-12 01:43:46 -03:00
libkmod-elf.c Silence clang warnings with __unused__ attribute 2012-05-23 20:31:18 -03:00
libkmod-file.c libkmod-file: gracefully handle errors from zlib 2012-05-08 10:22:13 -03:00
libkmod-hash.c libkmod-hash: use generic function for unaligned access 2012-05-21 20:43:39 -03:00
libkmod-hash.h hash: add iterator 2011-12-27 18:11:58 -02:00
libkmod-index.c libkmod-index: protect ourselves from corrupted indexes 2012-06-06 09:36:29 -03:00
libkmod-index.h libkmod-index: do not pre-populate mmap 2012-03-02 20:33:26 -03:00
libkmod-list.c libkmod-list: allow to append an empty list 2012-01-17 21:16:23 -02:00
libkmod-module.c module: support reading coresize from /sys if supported 2012-06-29 13:04:41 -04:00
libkmod-private.h libkmod-config: refactor functions to get config 2012-06-12 01:43:46 -03:00
libkmod-util.c libkmod-util: split function for usec conversion 2012-06-06 01:08:56 -03:00
libkmod-util.h libkmod-util: split function for usec conversion 2012-06-06 01:08:56 -03:00
libkmod.c libkmod-config: refactor functions to get config 2012-06-12 01:43:46 -03:00
libkmod.h libkmod/module: add kmod_module_apply_filter method 2012-02-24 10:53:42 -05:00
libkmod.pc.in libkmod: remove external cflags from .pc file 2011-12-24 20:28:11 +01:00
libkmod.sym build: remove private symbol from linker script 2012-05-10 21:11:27 -03:00
macro.h Silence clang warnings with __unused__ attribute 2012-05-23 20:31:18 -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 with 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 */
      }
   }