python: add docstring to insert and remove methods

python: add docstring to rmmod

python: update version to 0.9

python: Update README

Last update changed API slightly:
* loaded_modules renamed to modules
* returns a module object instead of (name, size)

python: MANIFEST.in: add AUTHORS to distibuted source files.

python: Ran update-copyright.py.

python: .update-copyright.conf: update to pipe separators.

This brings the config file up to speed with the following
update-copyright commit:

  commit 3c68a1a48419d8b2bbc2ce0e7f1700b996ec30e9
  Author: W. Trevor King <wking@tremily.us>
  Date:   Fri Oct 19 21:52:48 2012 -0400

    project: for consistency, also separate ignored paths with pipes.

python: .update-copyright.conf: add MANIFEST.in to ignored files.

python: .update-copyright.conf: add Red Hat alias for Andy Grover.

He seems to be assigning copyright of files he writes to Red Hat.
Avoiding .mailmap so the git log will still attribute changes to him.
I'm not sure which name should go in the AUTHORS file.

python: .update-copyright.conf: add README.rst to ignored files.

python: .mailmap: consolidate Andy Grover email addresses.

python: .update-copyright.conf: add copyright configuration.

Use my external update-copyright package to maintain copyright blurbs.

http://pypi.python.org/pypi/update-copyright/

python: module: fix versions -> info typo in Module._info_get() error message.

python: Initialize Kmod.mod_dir to None in __cinit__().

python: Use an OrderedDict for Module.info (preserving modinfo ordering).

python: Add Module.info attribute.

python: Use Cython's libc.errno for EEXIST.

python: Add Module.versions attribute.

python: README.rst: add .rst symlink for GitHub.

python: README: mention Cython dependency.

python: README: cleanup reStructuredText syntax.

python: Add missing copyright blurbs.

python: Add docstrings to kmod.kmod and kmod.kmod.Kmod.

python: MANIFEST.in: add missing source to the sdist tarball.

python: Add additional out Module attributes (path, refcnt, ...).

python: Convert to Cython.

With Cython we get easier memory handling and Python 3 compatibility.

python: update FSF address in COPYING and COPYING.LESSER

Please FSF, never move again.

python: whitespace

python: add proper error handling to loaded_modules()

We need to check the result of basically all Py* calls and cleanup
properly if they fail.

python: Improve README's description of kmod

Based on text from kmod's README.

python: Make setup.py version match version in .c

python: Add README

python: More cleanup and renaming of stuff. Add docstrings.

python: Add support for listing loaded modules, modprobe, rmmod

And other misc. cleanups and changes.

python: use c99 init for struct init

move casts of pyobject -> kmodobject to the functions from the struct
init.

python: a skeleton that compiles

python: initial checkin

build-sys: try harder to shut up compiler wrt strict-aliasing

With -Wstrict-aliasing=2 we get the following warning:

libkmod/libkmod-signature.c:124:20: note: in expansion of macro 'get_unaligned'
  sig_len = be32toh(get_unaligned(&modsig->sig_len));

However there's nothing wrong with it. modsig->sig_len is uint32_t and
get_unaligned in this case returns uint32_t. There's notstrict aliasing
violation.

libkmod: Fix unaligned access

From Jan Engelhardt:

Program received signal SIGBUS, Bus error.
[Switching to process 11100]
0x00035278 in kmod_module_signature_info (file=0x4eeb8, sig_info=0xffffc254)
    at libkmod/libkmod-signature.c:124
124             sig_len = be32toh(modsig->sig_len);
(gdb) p modsig
$1 = (const struct module_signature *) 0xf7dfe143

modsig->sig_len can be unaligned if modsig is unaligned, so the padding
in the struct has no effect since we are mapping it to the mem buffer.

build-sys: Remove -Werror from CFLAGS

Just let the warnings be emmited, but don't fail on them.

build-sys: Remove bogus line causing warning

./configure: line 14316: xyes: command not found

We are not using have_manpages, so remove it.

Add test for depmod using search dirs with same prefix

Test depmod with search dirs "foo" and "foobar". Previously to 49b33c1
("depmod: do not allow partial matches with "search" directive") we were
failing this test due to matching the prefix without checking if
it's the full dir name.

We are adding 2 tests here in order to catch the case we only pass the
test due to processing the directories in a favourable order.

depmod: do not allow partial matches with "search" directive

Currently e.g. "search foo foobar built-in" will cause unpredictable
results if baz.ko is in both foo/ and foobar/, since "foo" in search may
match both of those directories and the preferred module therefore
depends on processing order.

Fix the code to ensure that the match is performed on full pathname
components only.

Add test for simple search order in depmod

depmod: fix debug print parameter order

libkmod-elf: Fix check by class in get_modversions()

Commit 51c409b ("Cache the offset of crc") unintentinally changed the
comparison "if (elf->class & KMOD_ELF_32)" to
"if (elf->class == KMOD_ELF_32)".

This has been reported by Serge Voilokov <serge0x76@gmail.com>:

On Raspberry PI elf->class equals KMOD_ELF_32|KMOD_ELF_LSB so
valid condition should be (elf->class & KMOD_ELF_32) instead of
(elf->class == KMOD_ELF_32).

This fixes "modprobe --dump-modversions" failing on 32b systems.

testsuite: Fix uname() during glibc startup

In a specific configuration (chroot with the linux32 personality), the
modprobe_install_cmd_loop test failed, because the bash process handling
the install command segfaulted. The backtrace showed a uname() call
during libpthread initialization, at which point the environ pointer
hadn't been initialized yet:

Program terminated with signal SIGSEGV, Segmentation fault.
#0  0x080c1591 in getenv (name=<optimized out>,
    name@entry=0xf775f850 "TESTSUITE_UNAME_R") at getenv.c:81
81       for (i = 0, len = strlen (name); environ[i]; i++)
(gdb) bt
#0  0x080c1591 in getenv (name=<optimized out>,
    name@entry=0xf775f850 "TESTSUITE_UNAME_R") at getenv.c:81
#1  0xf775f754 in uname (u=u@entry=0xff946350) at testsuite/uname.c:32
#2  0xf74ffc6c in is_smp_system ()
    at ../nptl/sysdeps/unix/sysv/linux/i386/smp.h:39
#3  __pthread_initialize_minimal_internal () at nptl-init.c:460
#4  0xf74fe32c in _init () at ../sysdeps/i386/crti.S:74
#5  0x00000000 in ?? ()
(gdb) p environ
$1 = (char **) 0x0

I don't know why it only happend in the chroot, but glibc can call its
own functions and impose any restrictions before main() is started, so
we have to adapt.

Also, do not return error if there is an environment, but the
environment variable is not found. If uname() is called by kmod, then
the respective test will simply fail later. If it's something else
calling uname(), then we do not want to disturb the program.

man: use systemd as example instead of udev

Nowadays udev doesn't create nodes in /dev anymore. This role is rather
taken by systemd-tmpfiles on early boot so reference it generically as
systemd.

man: clarify the support to modules.dep file

build-sys: Do not require xsltproc for installation of man pages

Same reason as found in this commit to systemd:

commit 4ca39b280fce3c60d2fdecbd478fd9bf7f9d3e64
Author: Mike Gilbert <floppym@gentoo.org>
Date:   Sun Feb 23 11:21:13 2014 -0500

    configure: Do not require xsltproc for installation of man pages

    The release tarballs ship with pre-generated man pages, so we do not
    need xsltproc for a typical end-user build.

    Developers will probably have xsltproc anyway, but if not they will now
    encounter a build-time failure instead of an error in configure.

build-sys: add small redirecting Makefiles

These redirecting makefiles simplifies compiling from some editors and
when CWD is not the root of the source tree. This is similar to what was
introduced in systemd in 340d89e ("build-sys: add small redirecting
Makefiles to simplify compilation from within emacs")

testsuite: add test for '.' correctly parsed in param's value

In kcmdline it's possible to have a dot in the param's value. The
support for this was added in 66f3228 ("libkmod: Add support for '.' in
module parameter on kcmdline") and is needed to correctly support some
modules that depend on it.

This test was added in order to make sure the commit  aa87854
("libkmod-config: Only match dot before '=' in /proc/cmdline") didn't
break it. Although that commit  message says it's allowing to match a
dot before '=' it's actually enforcing the first part of the string to
be always in the format "<module-name>.param". Dots after '=' are still
correctly allowed.

testsuite: add test to ignore unrelated strings in kcmdline

Strings unrelated to modules and modprobe should be ignored and not
appear in the output of "modprobe -c".

This adds a test for the fix provided in aa87854 ("libkmod-config: Only
match dot before '=' in /proc/cmdline").

testsuite: give a more suitable description to test

We are not only checking if those options are correctly parsed from
kcmdline, but if in fact they are being passed to the final
(f)init_module call. This is why we use 'modprobe --show-depends'
instead of the simpler 'modprobe -c'.

testsuite: add test for kcmdline params with no value

Use "modprobe -c" to dump the configuration. Since we configure our
rootfs to have only a /proc/cmdline file, this should dump the knowledge
we have from its parsed content.

Test if <module>.option, without any value is correctly parsed, as fixed
in commit 493dc65 ("libkmod: Fix getting param with no value from kcmdline")

libkmod-config: Only match dot before '=' in /proc/cmdline

Otherwise, we also parse strings like

  BOOT_IMAGE=/boot/vmlinuz-3.12.12-57.g5f654cf-default

In practice, this is not a problem, because there is no module named
BOOT_IMAGE=/boot/vmlinuz-3. It just disturbs in modprobe -c output.

libkmod-config,depmod: Accept special files as configuration files, too

If we can open it and read it, it's good enough for us. Otherwise, we
cannot use -C /dev/null to skip the system configuration for instance:

$ ./tools/modprobe -C /dev/null -c
libkmod: ERROR libkmod/libkmod-config.c:821 conf_files_list: unsupported
file mode /dev/null: 0x21b6
...

libkmod-module: Simplify kmod_module_insert_module()

Store the file and elf pointer in the kmod_module structure and have it
freed together with the module.

Add some tests for kernels without finit_module(2)

testsuite: Do not provide finit_module(2) on older kernels

If the test's uname -r is less that 3.8, return -ENOSYS from
finit_module(), so that the fallback is tested.

testsuite: Add test for modprobe --force

There is no check if the correct flags are passed to finit_module, but
at least we cover the respective code path in kmod.

testsuite: Check the list of loaded modules after a test

Add a ->modules_loaded member to struct test, which is a comma-separated
list of modules that should be present after the test finishes. Both
missing and excess modules cause an error.

Remove "rmmod -w" documentation and getopt entry

This patch removes the cmdopts declaration and the documentation. They
were leftover from the -w removal.

man: insmod documentation fix

Add comma between lsmod(8) and modinfo(8)

Signed-off-by: Lukas Berk <lberk@redhat.com>

Remove duplicate includes

Found by
https://raw.github.com/karelzak/util-linux/master/tools/checkincludes.pl

man: Change my contact email address

kmod 16

Use C11's noreturn

Also define noreturn w/o <stdnoreturn.h> and move it to macro.h instead
of in the testsuite.

Based on similar commit on systemd by Shawn Landden
<shawn@churchofgit.com>.

module: use _cleanup_free and remove useless call to free()

file: use _cleanup_free_

array: avoid duplicate code to reallocate

util: Be OOM-safe and use _cleanup_free_

testsuite: add basic test for getline_wrapped

util: use _cleanup_free_ on path_make_absolute_cwd()

config: Use _cleanup_free_

util: Add cleanup attribute

testsuite: Move test-alias to test-util

Move file so we can use the same file to test other functions from
libkmod-util.c

build: Allow disabling maintainer mode

This allows make rules for generated build files (i.e.  configure,
Makefile.in, ... ) to be skipped.  This is useful when
the source is stored without timestamps (for example in CVS or GIT).

When the build rules trigger to regenerate the build files, it tries to
use the same autotools version (currently 1.14) as was originally used
for the release.  Since many of our build machines run Debian Squeeze,
they only have autotools 1.11 available and the build fails.

Currently, we have to work around this by touching all the generated
files before building to avoid triggering the make rule. With this
patch, we would be able to just run configure with
--disable-maintainer-mode instead.  The patch sets the default to enable
to not change the default behavior.

build-sys: enable colored diagnostics if available

Makefile.am: add mkdir testsuite

If we are note building in the existing source tree and have disabled
dependency-tracking then the testsuite directory is not created during
the configure phase and will not exist when the cp of ROOTFS_PRISTINE
occurs, thus causing an error and fail.

Makefile.am: Add target to all cross-compilation of testsuite

The buildtest-TESTS target allows for cross-compilation of the testsuites
without the actual running of the tests that check normally does.

NEWS: add entries

rmmod: remove --wait option

Let libkmod enforce KMOD_REMOVE_NOWAIT.

libkmod: always pass O_NONBLOCK to kernel

Not passsing O_NONBLOCK to delete_module() is deprecated since kmod 11
and is being removed from the kernel. Force this flag in libkmod.

libkmod-hash: always align n_buckets to power of 2

By aligning n_buckets to power of 2 we can turn the "bucket = hashval %
n_buckets" into a less expensive bucket = hashval & (n_buckets - 1).
This removes the DIV instruction as shown below.

Before:
xor    %edx,%edx
divl   0x8(%rbx)
mov    %edx,%eax
add    $0x1,%rax
shl    $0x4,%rax
add    %rbx,%rax

After:
lea    -0x1(%rdi),%edx
and    %edx,%eax
add    $0x1,%rax
shl    $0x4,%rax
add    %rbx,%rax

With a microbenchmark, measuring the time to locate the bucket (i.e.
time_to_calculate_hashval + time_to_calculate_bucket_position) we have
the results below (time in clock cycles):

keylen      before   after
2-10          79.0    61.9 (-21.65%)
11-17         81.0    64.4 (-20.48%)
18-25         90.0    73.2 (-18.69%)
26-32        104.7    87.0 (-16.82%)
33-40        108.4    89.6 (-17.37%)
41-48        111.2    91.9 (-17.38%)
49-55        120.1   102.1 (-15.04%)
56-63        134.4   115.7 (-13.91%)

As expected the gain is constant, regardless of the key length.
The time to clculate the hashval varies with the key length, which
explains the bigger gains for short keys.

util: Add ALIGN_POWER2

Add static inline function to align a value to it's next power of 2.
This is commonly done by a SWAR like the one in:

http://aggregate.org/MAGIC/#Next Largest Power of 2

However a microbench shows that the implementation herer is a faster.
It doesn't really impact the possible user of this function, but it's
interesting nonetheless.

Using a x86_64 i7 Ivy Bridge it shows a ~4% advantage by using clz
instead instead of the OR and SHL chain. And this is by using a BSR
since Ivy Bridge doesn't have LZCNT. New Haswell processors have the
LZCNT instruction which can make this even better. ARM also has a CLZ
instruction so it should be better, too.

Code used to test:

...
v = val[i];
t1 = get_cycles(0);
a = ALIGN_POWER2(v);
t1 = get_cycles(t1);

t2 = get_cycles(0);
v = nlpo2(v);
t2 = get_cycles(t2);

printf("%u\t%llu\t%llu\t%d\n", v, t1, t2, v == a);
...

In which val is an array of 20 random unsigned int, nlop2 is the SWAR
implementation and get_cycles uses RDTSC to measure the performance.

Averages:
ALIGN_POWER2:  30 cycles
nlop2: 31.4 cycles

depmod: warn on invalid devname specification

During the last merge window (3.12) a couple of modules gained devname
aliases, but without the necessary major and minor information. These were
then silently ignored when generating modules.devname.

Complain loudly to avoid such errors sneaking in undetected in the future:

    depmod: ERROR: Module 'zram' has devname (zram) but lacks major and minor information. Ignoring.
    depmod: ERROR: Module 'uhid' has devname (uhid) but lacks major and minor information. Ignoring.

Cc: Kay Sievers <kay@vrfy.org>
Cc: Lucas De Marchi <lucas.demarchi@profusion.mobi>

build: remove check for typeof

It's used in so many places without checking, that's really pointless to
check for it in macro.h.

Also remove AC_C_TYPEOF from configure.ac since we don't use -ansi.

Add configure check for _Static_assert()

Commit 8efede20ef ("Use _Static_assert") introduced the usage of
_Static_assert(). However, _Static_assert() is a fairly new thing,
since it was introduced only in gcc 4.6. In order to support older
compilers, this patch adds a configure.in test that checks whether
_Static_assert() is usable or not, and adjust the behavior of the
assert_cc() macro accordingly.

Fix usage of readdir_r()

With readdir_r() we should be providing enough space to store the dir
name. This could be accomplished by define an union like systemd does:

union dirent_storage {
struct dirent de;
uint8_t storage[offsetof(struct dirent, d_name) +
((NAME_MAX + 1 + sizeof(long)) & ~(sizeof(long) - 1))];
};

However in all places that we use readdir_r() we have no concerns about
reentrance nor we have problems with threads. Thus use the simpler
readdir() instead.

We also remove the error logging here (that could be added back by
checking errno), but it was not adding much value so it's gone.

testsuite: fix usage of reserved names

stdout and stderr are names reserved for the implementation
and musl uses them rightfully as macro - and the expansion
causes (of course) unexpected results.

rename the struct members stdout to out and stderr
to err, to be 1) compliant 2) cause compilation to
succeed.

fixes build with musl libc.

kmod 15

libkmod: Fix getting param with no value from kcmdline

testsuite: Add test for parameter with no value in kcmdline

Currently we fail to add the module option if the parameter doesn't have
a value.

depmod: add missing "else" clause

It occurred to an openSUSE user that our mkinitrd would throw a
warning when used with kmod:

libkmod: conf_files_list: unsupported file mode /dev/null: 0x21b6

Grepping for the error message revealed that there might be a missing
"else" keyword here, since it is unusual to put an "if" directly after
closing brace.

shell-completion: Make options accept '=' as last char

build: Install bash completion data

shell-completion: Add kmod static-nodes

shell-completion: Add initial completion for kmod

Based on journalctl and udevadm from systemd and adapted to kmod needs.

NEWS: Add entries