Home

Awesome

Linux Modules

standard-readme compliant linux_modules crates.io version and link linux_modules Crates.io license linux_modules docs.rs badge

Tool To Manage Linux Kernel Modules

This is a tool to manage your Linux Kernel Modules. It is an alternative to modprobe, and supports listing, adding, and removing modules, as well as displaying information on them.

It does not yet support modprobe style dependencies or aliases, and is not capable of displaying module signature data, except whether one exists or not.

Install

cargo install linux_modules

Usage

CLI

$ nms info loop
╭───────────────────┬──────────────────────────────────────╮
│ File              ┆ /lib/modules/6.3.1-arch2-1/kernel/dr │
│                   ┆ ivers/block/loop.ko.zst              │
╞═══════════════════╪══════════════════════════════════════╡
│ Authors           ┆                                      │
├╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌┼╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌┤
│ License           ┆ GPL                                  │
├╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌┼╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌┤
│ Description       ┆                                      │
├╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌┼╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌┤
│ Version           ┆                                      │
├╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌┼╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌┤
│ Firmware          ┆                                      │
├╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌┼╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌┤
│ Alias             ┆ devname:loop-control                 │
│                   ┆ char-major-10-237                    │
│                   ┆ block-major-7-*                      │
├╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌┼╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌┤
│ Dependencies      ┆                                      │
├╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌┼╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌┤
│ Soft Dependencies ┆                                      │
├╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌┼╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌┤
│ In Tree           ┆ true                                 │
├╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌┼╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌┤
│ Retpoline         ┆ true                                 │
├╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌┼╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌┤
│ Staging           ┆ false                                │
├╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌┼╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌┤
│ Version Magic     ┆ 6.3.1-arch2-1 SMP preempt mod_unload │
├╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌┼╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌┤
│ Source Checksum   ┆ B9EBD1F7F134B1C20C5B09B              │
├╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌┼╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌┤
│ Parameters        ┆ ╭────────────┬───────────┬─────────╮ │
│                   ┆ │ Name       ┆ Descripti ┆ Type    │ │
│                   ┆ │            ┆ on        ┆         │ │
│                   ┆ ╞════════════╪═══════════╪═════════╡ │
│                   ┆ │ hw_queue_d ┆ Queue     ┆ Unknown │ │
│                   ┆ │ epth       ┆ depth for ┆         │ │
│                   ┆ │            ┆ each      ┆         │ │
│                   ┆ │            ┆ hardware  ┆         │ │
│                   ┆ │            ┆ queue.    ┆         │ │
│                   ┆ │            ┆ Default:  ┆         │ │
│                   ┆ │            ┆ 128       ┆         │ │
│                   ┆ ├╌╌╌╌╌╌╌╌╌╌╌╌┼╌╌╌╌╌╌╌╌╌╌╌┼╌╌╌╌╌╌╌╌╌┤ │
│                   ┆ │ max_loop   ┆ Maximum   ┆ int     │ │
│                   ┆ │            ┆ number of ┆         │ │
│                   ┆ │            ┆ loop      ┆         │ │
│                   ┆ │            ┆ devices   ┆         │ │
│                   ┆ ├╌╌╌╌╌╌╌╌╌╌╌╌┼╌╌╌╌╌╌╌╌╌╌╌┼╌╌╌╌╌╌╌╌╌┤ │
│                   ┆ │ max_part   ┆ Maximum   ┆ int     │ │
│                   ┆ │            ┆ number of ┆         │ │
│                   ┆ │            ┆ partition ┆         │ │
│                   ┆ │            ┆ s per     ┆         │ │
│                   ┆ │            ┆ loop      ┆         │ │
│                   ┆ │            ┆ device    ┆         │ │
│                   ┆ ╰────────────┴───────────┴─────────╯ │
├╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌┼╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌┤
│ Signature         ┆ true                                 │
╰───────────────────┴──────────────────────────────────────╯

Note that the table size will adapt to your terminal. This example uses size 60.

Pager

nms info and nms list automatically pipe output to a pager, defaulting to less, but this may be customized through environment variables.

See the pager crate for details on how to customize what pager is used.

Changelog

Please see CHANGELOG for version history

Contributing

This crate is not looking for contributors at this time.

However, feel free to ask questions and request bindings using github issues, or suggest/discuss API improvements.

Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as below, without any additional terms or conditions.

License

Licensed under either of

at your option.