kmmodreg(1M)

NAME

kmmodreg — register or unregister loadable kernel modules with the running kernel

SYNOPSIS

/usr/sbin/kmmodreg [[-M module_name]...] [-r mod_register_root] [-c mod_reg_root]

/usr/sbin/kmmodreg [[-U module_name]...] [-r mod_register_root] [-c mod_reg_root]

DESCRIPTION

kmmodreg registers all of the loadable kernel modules listed in the mod_register file located under either /stand/dlkm.current_vmunix/ when the running kernel is current_vmunix, or /stand/dlkm when the running kernel is /stand/vmunix. All loadable kernel modules need to be registered by kmmodreg before they can be automatically-loaded by the running kernel (i.e., upon module access by an application or user process), or demand-loaded by an administrator issuing the kmadmin command.

The mod_register file is generated whenever config is run to create a new kernel and contains the registration information for any (and all) configured loadable modules. When config -M is run to configure a loadable kernel module, the entries for the module are appended to the mod_register. The mod_register file is not expected to be edited manually. An individual module's registration information is also created by config and stored in the mod_reg file located under /stand/dlkm/mod_bld.d directory.

Options

kmmodreg takes the following options:

-r mod_register_root: Use to specify a directory other than /stand/dlkm.current_vmunix or /stand/dlkm/ as the location for the mod_register file that is used to register modules.
-c mod_reg_root: Use the individual module registration information under the mod_reg_root directory instead of /stand/dlkm/mod_bld.d.
-M module_name [module_name]: Register the specified loadable kernel module, and append an entry (or entries) for the module(s) to the mod_register file. This will effect registration of the specified module(s) at every system reboot.
-U module_name: Unregister the specified loadable kernel module, and remove an entry (or entries) for the module from the mod_register file, so it will not be registered every time the system is rebooted.

NOTES

The kmmodreg command is executed automatically at every system reboot. kmupdate also calls kmmodreg, with the -M option, when a loadable kernel module configuration is requested. kmmodreg can also be invoked as a user-level command to register all of the loadable kernel modules.

WARNINGS

The mod_register file format may change or be eliminated in the future.

FILES

/stand/dlkm: Default mod_register_root directory
/stand/dlkm.current_vmunix/mod_register: Default mod_register file
/stand/dlkm/mod_bld.d/module_name/mod_reg: Module registration information

Each mod_register file entry provides registration information about a single module. The information is contained in a single-line entry. All fields are positional and are separated by colons. The subfields are separated by commas. The entry is of the form:

module-name:module-type:type-specific-data

where:

module-name identifies the module to which the entry belongs
module-type contains an integer representing the module type
type-specific-data includes additional information that depends on the type of the module

RETURN VALUE

An exit value of zero indicates successful completion of the command. If errors occur, kmmodreg reports error messages for each error and exits with the return value 1. If the error is a failure to register a module, an error message is reported, but the command continues processing the remaining modules listed in the mod_register file. If no modules are processed, kmmodreg returns a value of 2.

kmmodreg(1M)

Technical documentation

» Table of Contents

» Index