Struct linapi::modules::LoadedModule

pub struct LoadedModule { /* fields omitted */ }

Describes a loaded Linux kernel Module

Methods

impl LoadedModule

pub fn from_name(name: &str) -> Self

Get an already loaded module by name

Panics

• If no such module exists

pub fn get_loaded() -> Vec<Self>

Get currently loaded dynamic kernel modules

Note

Modules can be unloaded, and if that happens methods on LoadedModule will panic

pub fn unload(self)

Unload the module.

Panics

• On failure

pub unsafe fn force_unload(self)

Forcefully unload a kernel module.

Safety

Force unloading is wildly dangerous and will taint your kernel.

It can cause modules to be unloaded while still in use, or unload modules not designed to be unloaded.

Panics

• On failure

pub fn name(&self) -> &str

Name of the module

pub fn module_type(&self) -> Type

Module type, Builtin or Dynamic

pub fn parameters(&self) -> HashMap<String, Vec<u8>>

Module parameters.

The kernel exposes these as files in a directory, and their contents are entirely module specific, hence Vec<(String, Vec<u8>)>, which can be std::io::Read.

Stability

The stability of parameters depends entirely on the specific module.

pub fn ref_count(&self) -> Option<u32>

Module reference count.

If the module is built-in, or if the kernel was not built with CONFIG_MODULE_UNLOAD, this will be None

pub fn size(&self) -> u64

Module size in bytes

pub fn taint(&self) -> Option<Taint>

Module taint, or None if untainted.

See Taint for details.

pub fn holders(&self) -> Vec<Self>

List of other modules that use/reference this one.

Note

This uses the holders sysfs folder, which is completely undocumented by the kernel, beware.

pub fn file_path(&self) -> PathBuf

Path to the module file.

Note

There is no guarantee the returned path is the same module. The file may have changed on disk.

This is equivalent to find_module_file(&module.name())

pub fn status(&self) -> Status

Module status.

Note

This uses the undocumented initstate file, which is probably module_state from linux/module.h.

Trait Implementations

impl Debug for LoadedModule

fn fmt(&self, f: &mut Formatter) -> Result

Formats the value using the given formatter.

impl UEvent for LoadedModule

fn write(
    &self,
    action: UEventAction,
    uuid: Option<String>,
    args: HashMap<String, String>
)

Write a synthetic uevent

fn read(&self) -> HashMap<String, String>

Return the Key=Value pairs in the uevent file.