Kernel module - ArchWiki

Jump to content

# Kernel module

From ArchWiki

Related articles

- Boot debugging
- Kernels
- Kernel parameters
- Compile kernel module

Kernel modules are pieces of code that can be loaded and unloaded into the kernel upon demand. They extend the functionality of the kernel without the need to reboot the system.

To create a kernel module, you can read The Linux Kernel Module Programming Guide. A module can be configured as built-in or loadable. To dynamically load or remove a module, it has to be configured as a loadable module in the kernel configuration (the line related to the module will therefore display the letter `M`).

## Obtaining information

Modules are stored in `/usr/lib/modules/kernel_release`. You can use the command `uname -r` to get your current kernel release version.

Note: Module names often use underscores (`_`) or dashes (`-`); however, those symbols are interchangeable when using the `modprobe` command and in configuration files in `/etc/modprobe.d/`.

To show what kernel modules are currently loaded:

    $ lsmod

To show information about a module:

    $ modinfo module_name

To list the options that are set for a loaded module:

    $ systool -v -m module_name

To display the comprehensive configuration of all the modules:

    $ modprobe -c | less

To display the configuration of a particular module:

    $ modprobe -c | grep module_name

List the dependencies of a module (or alias), including the module itself:

    $ modprobe --show-depends module_name

## Automatic module loading with systemd

Today, all necessary modules loading is handled automatically by udev, so if you do not need to use any out-of-tree kernel modules, there is no need to put modules that should be loaded at boot in any configuration file. However, there are cases where you might want to load an extra module during the boot process, or blacklist another one for your computer to function properly.

Kernel modules can be explicitly listed in files under `/etc/modules-load.d/` for systemd to load them during boot. Each configuration file is named in the style of `/etc/modules-load.d/program.conf`. Configuration files simply contain a list of kernel modules names to load, separated by newlines. Empty lines and lines whose first non-whitespace character is `#` or `;` are ignored.

    /etc/modules-load.d/virtio-net.conf

    # Load virtio_net.ko at boot
    virtio_net

See modules-load.d(5) for more details.

## Manual module handling

Kernel modules are handled by tools provided by kmod package. You can use these tools manually.

Note: If you have upgraded your kernel but have not yet rebooted, modprobe will fail with no error message and exit with code 1, because the path `/usr/lib/modules/$(uname -r)/` no longer exists. Check manually if this path exists when modprobe failed to determine if this is the case.

To load a module:

    # modprobe module_name

To load a module by filename (i.e. one that is not installed in `/usr/lib/modules/$(uname -r)/`):

    # insmod filename [args]

To unload a module:

    # modprobe -r module_name

Or, alternatively:

    # rmmod module_name

## Setting module options

To pass a parameter to a kernel module, you can pass them manually with modprobe or assure certain parameters are always applied using a modprobe configuration file or by using the kernel command line.

### Manually at load time using modprobe

The basic way to pass parameters to a module is using the modprobe command. Parameters are specified on command line using simple `key=value` assignments:

    # modprobe module_name parameter_name=parameter_value

### Using files in /etc/modprobe.d/

Files in `/etc/modprobe.d/` directory can be used to pass module settings to udev, which will use `modprobe` to manage the loading of the modules during system boot. Configuration files in this directory can have any name, given that they end with the .conf extension. The syntax is:

    /etc/modprobe.d/myfilename.conf

    options module_name parameter_name=parameter_value

For example:

    /etc/modprobe.d/thinkfan.conf

    # On ThinkPads, this lets the 'thinkfan' daemon control fan speed
    options thinkpad_acpi fan_control=1

Note: If any of the affected modules is loaded from the initramfs, then you will need to add the appropriate .conf file to `FILES` in mkinitcpio.conf or use the `modconf` hook, so that it will be included in the initramfs. To see the contents of the default initramfs use lsinitcpio.

### Using kernel command line

If the module is built into the kernel, you can also pass options to the module using the kernel command line. For all common bootloaders, the following syntax is correct:

    module_name.parameter_name=parameter_value

For example:

    thinkpad_acpi.fan_control=1

Simply add this to your bootloader's kernel-line, as described in Kernel Parameters.

## Aliasing

Aliases are alternate names for a module. For example: `alias my-mod really_long_modulename` means you can use `modprobe my-mod` instead of `modprobe really_long_modulename`. You can also use shell-style wildcards, so `alias my-mod* really_long_modulename` means that `modprobe my-mod-something` has the same effect. Create an alias:

    /etc/modprobe.d/myalias.conf

    alias mymod really_long_module_name

Some modules have aliases which are used to automatically load them when they are needed by an application. Disabling these aliases can prevent automatic loading but will still allow the modules to be manually loaded.

    /etc/modprobe.d/modprobe.conf

    # Prevent Bluetooth autoload
    alias net-pf-31 off

## Blacklisting

Blacklisting, in the context of kernel modules, is a mechanism to prevent the kernel module from loading. This could be useful if, for example, the associated hardware is not needed, or if loading that module causes problems: for instance there may be two kernel modules that try to control the same piece of hardware, and loading them together would result in a conflict.

Some modules are loaded as part of the initramfs. `mkinitcpio -M` will print out all automatically detected modules: to prevent the initramfs from loading some of those modules, blacklist them in a .conf file under `/etc/modprobe.d` and it shall be added in by the `modconf` hook during image generation. Running `mkinitcpio -v` will list all modules pulled in by the various hooks (e.g. `filesystems` hook, `block` hook, etc.). Remember to add that .conf file to the `FILES` array in `/etc/mkinitcpio.conf` if you do not have the `modconf` hook in your `HOOKS` array (e.g. you have deviated from the default configuration), and once you have blacklisted the modules regenerate the initramfs, and reboot afterwards.

### Using files in /etc/modprobe.d/

Create a .conf file inside `/etc/modprobe.d/` and append a line for each module you want to blacklist, using the `blacklist` keyword. If for example you want to prevent the `pcspkr` module from loading:

    /etc/modprobe.d/nobeep.conf

    # Do not load the 'pcspkr' module on boot.
    blacklist pcspkr

Note: The `blacklist` command will blacklist a module so that it will not be loaded automatically, but the module may be loaded if another non-blacklisted module depends on it or if it is loaded manually.

However, there is a workaround for this behaviour; the `install` command instructs modprobe to run a custom command instead of inserting the module in the kernel as normal, so you can force the module to always fail loading with:

    /etc/modprobe.d/blacklist.conf

    ...
    install module_name /bin/true
    ...

This will effectively blacklist that module and any other that depends on it.

### Using kernel command line

Tip: This can be very useful if a broken module makes it impossible to boot your system.

You can also blacklist modules from the bootloader.

Simply add `module_blacklist=modname1,modname2,modname3` to your bootloader's kernel line, as described in Kernel parameters.

Note: When you are blacklisting more than one module, note that they are separated by commas only. Spaces or anything else might presumably break the syntax.

## Troubleshooting

### Modules do not load

In case a specific module does not load and the boot log (accessible by running `journalctl -b` as root) says that the module is blacklisted, but the directory `/etc/modprobe.d/` does not show a corresponding entry, check another modprobe source folder at `/usr/lib/modprobe.d/` for blacklisting entries.

A module will not be loaded if the "vermagic" string contained within the kernel module does not match the value of the currently running kernel. If it is known that the module is compatible with the current running kernel the "vermagic" check can be ignored with `modprobe --force-vermagic`.

Warning: Ignoring the version checks for a kernel module can cause a kernel to crash or a system to exhibit undefined behavior due to incompatibility. Use `--force-vermagic` only with the utmost caution.

## See also

- Disable PC speaker beep
- Writing a WMI driver - an LWM introduction

Categories:

- Kernel
- Hardware detection and troubleshooting
- Boot process