kmod/libkmod
Lucas De Marchi ecced7dd77 doc: fix out of tree build 2012-01-09 13:32:31 -02:00
..
docs doc: fix out of tree build 2012-01-09 13:32:31 -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
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 Update copyright 2012-01-09 00:41:07 -02:00
libkmod-elf.c Update copyright 2012-01-09 00:41:07 -02:00
libkmod-file.c Update copyright 2012-01-09 00:41:07 -02:00
libkmod-hash.c Update copyright 2012-01-09 00:41:07 -02:00
libkmod-hash.h hash: add iterator 2011-12-27 18:11:58 -02:00
libkmod-index.c Update copyright 2012-01-09 00:41:07 -02:00
libkmod-index.h Update copyright 2012-01-09 00:41:07 -02:00
libkmod-list.c doc: organize sections 2012-01-09 05:28:57 -02:00
libkmod-module.c doc: organize sections 2012-01-09 05:28:57 -02:00
libkmod-private.h file: take a weakref to ctx 2012-01-04 08:49:15 -02:00
libkmod-util.c Update copyright 2012-01-09 00:41:07 -02:00
libkmod-util.h Replace NAME_MAX with PATH_MAX for module aliases 2012-01-08 01:02:29 -02:00
libkmod.c doc: fix order of param descriptions 2012-01-09 03:30:10 -02:00
libkmod.h Match param names on header and source code 2012-01-09 03:29:48 -02:00
libkmod.pc.in libkmod: remove external cflags from .pc file 2011-12-24 20:28:11 +01:00
libkmod.sym Add call to check if resources are valid 2012-01-01 06:18:16 -02:00
macro.h doc: fix comments format 2012-01-09 03:29:29 -02: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 */
      }
   }