kmod/libkmod
Lucas De Marchi 1eff942e37 libkmod: cache open file for later access
If we are accessing several times the modules and reading some sections
by sucessive calls to the functions below, we are incurring in a penalty
of having to open, parse the header and close the file. For each
function.

	- kmod_module_get_info()
	- kmod_module_get_versions()
	- kmod_module_get_symbols()
	- kmod_module_get_dependency_symbols()

These functions are particularly important to depmod. It calls all of
them, for each module. Moreover there's a huge bottleneck in the open
operation if we are using compression. Every time we open the module we
need to uncompress the file and after getting the information we need we
discard the result. This is clearly shown by profiling depmod with perf
(record + report), using compressed modules:

 64.07%  depmod  libz.so.1.2.7       [.] 0x00000000000074b8                                            ◆
 18.18%  depmod  libz.so.1.2.7       [.] crc32                                                         ▒
  2.42%  depmod  libz.so.1.2.7       [.] inflate                                                       ▒
  1.17%  depmod  libc-2.16.so        [.] __memcpy_ssse3_back                                           ▒
  0.96%  depmod  [kernel.kallsyms]   [k] copy_user_generic_string                                      ▒
  0.89%  depmod  libc-2.16.so        [.] __strcmp_sse42                                                ▒
  0.82%  depmod  [kernel.kallsyms]   [k] hrtimer_interrupt                                             ▒
  0.77%  depmod  libc-2.16.so        [.] _int_malloc                                                   ▒
  0.44%  depmod  kmod-nolib          [.] kmod_elf_get_strings                                          ▒
  0.41%  depmod  kmod-nolib          [.] kmod_elf_get_dependency_symbols                               ▒
  0.37%  depmod  kmod-nolib          [.] kmod_elf_get_section                                          ▒
  0.36%  depmod  kmod-nolib          [.] kmod_elf_get_symbols
  ...

Average of running depmod 5 times, dropping caches between them, in a
slow spinning disk:

Before:   12.25 +- 0.20
After:     8.20 +- 0.21
m-i-t:     9.62 +- 0.27

So this patch leads to an improvement of ~33% over unpatched version,
ending up with 15% speedup over module-init-tools.
2012-10-18 02:09:55 -03: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
libkmod-array.c Update copyright 2012-01-09 00:41:07 -02:00
libkmod-array.h Use #pragma once instead of #ifndef 2012-07-18 10:31:50 -03:00
libkmod-config.c libkmod: Add support for '.' in module parameter on kcmdline 2012-10-09 09:56:50 -03:00
libkmod-elf.c Silence clang warnings with __unused__ attribute 2012-05-23 20:31:18 -03:00
libkmod-file.c libkmod: cache open file for later access 2012-10-18 02:09:55 -03:00
libkmod-hash.c libkmod-hash: Plug possible memory leak when free_value is defined 2012-10-12 12:34:27 -03:00
libkmod-hash.h Use #pragma once instead of #ifndef 2012-07-18 10:31:50 -03:00
libkmod-index.c libkmod-index: protect ourselves from corrupted indexes 2012-06-06 09:36:29 -03:00
libkmod-index.h Use #pragma once instead of #ifndef 2012-07-18 10:31:50 -03:00
libkmod-list.c libkmod-list: allow to append an empty list 2012-01-17 21:16:23 -02:00
libkmod-module.c libkmod: cache open file for later access 2012-10-18 02:09:55 -03:00
libkmod-private.h libkmod: cache open file for later access 2012-10-18 02:09:55 -03:00
libkmod-util.c libkmod-util: split function for usec conversion 2012-06-06 01:08:56 -03:00
libkmod-util.h Use #pragma once instead of #ifndef 2012-07-18 10:31:50 -03:00
libkmod.c build-sys: Remove --with-rootprefix option 2012-10-02 00:27:31 -03:00
libkmod.h libkmod-module: Add KMOD_PROBE_APPLY_BLACKLIST_ALIAS_ONLY flag 2012-08-17 09:42:15 -03: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 Use #pragma once instead of #ifndef 2012-07-18 10:31:50 -03:00
README Rename project from libkmod to kmod 2011-12-12 16:54:18 -02:00

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 */
      }
   }