split module autodetect into lsmod and lspci options, add nosound and novideo modules

Signed-off-by: Zen <[email protected]>

Author: desultory

config_example.toml

@@ -1,13 +1,15 @@
 # This config will decrypt the LUKS volume with uuid "fdf442da-0574-4531-98c7-55227a041f1d", mapping it to "/dev/mapper/root"
 # It will attempt to mount the btrfs volume with label "rootfs" to /mnt/root
-# It will pull all current kernel modules from the active kernel version
+# It will pull all current kernel modules from lspci -k results
 # The "ugrd.base.kmod_nvme" module will be used to load the nvme module if it's not detected in lsmod
 # The "ugrd.base.cpio" module will pack the initramfs into a cpio archive
 
 modules = [
   "ugrd.base.base",
   "ugrd.base.kmod",
   "ugrd.base.kmod_nvme",
+  "ugrd.base.kmod_nosound",
+  "ugrd.base.kmod_novideo",
   "ugrd.crypto.cryptsetup",
   "ugrd.base.btrfs",
   "ugrd.base.cpio",
@@ -18,7 +20,7 @@ out_dir = "/usr/src/initramfs"  # Output here instead of /tmp/initramfs_out
 
 # Optionally supply a kernel version, uses the current kernel version if not specified
 #kernel_version = "6.1.53-gentoo-dist"
-kmod_autodetect = true
+kmod_autodetect_lspci = true
 
 # Create device nodes only inside the CPIO
 mknod_cpio = true

readme.md

@@ -122,8 +122,9 @@ Modules can use `_kmod_depend` to add required modules. Simply using the `ugrd.c
 The following parameters can be used to change the kernel module pulling and initializing behavior:
 
 * `kernel_version` (uname -r) is used to specify the kernel version to pull modules for, should be a directory under `/lib/modules/<kernel_version>`.
-* `kmod_autodetect` (false) if set to `true`, will populate `kernel_modules` with modules listed in `lsmod`.
 * `kmod_init`  is used to specify kernel modules to load at boot. If set, ONLY these modules will be loaded with modprobe.
+* `kmod_autodetect_lspci` (false) if set to `true`, will populate `kernel_modules` with modules listed in `lspci -k`.
+* `kmod_autodetect_lsmod` (false) if set to `true`, will populate `kernel_modules` with modules listed in `lsmod`.
 * `kernel_modules` is used to define a list of kernel module names to pull into the initramfs. These modules will not be `modprobe`'d automatically if `kmod_init` is also set.
 * `kmod_ignore` is used to specify kernel modules to ignore. If a module depends on one of these, it will throw an error and drop it from being included.
 * `kmod_ignore_softdeps` (false) ignore softdeps when checking kernel module dependencies.
@@ -136,6 +137,8 @@ Some helper modules have been created to make importing required kernel modules
 
 `base.ugrd.kmod_nvme`, `kmod_usb`, and `kmod_fat` can be used to load modules for NVME's, USB storage, and the FAT file system respectively.
 
+Similarly `base.ugrd.kmod_novideo` and `kmod_nosound` exist to ignore video and sound devices that may appear when autodetecting modules.
+
 #### base.console
 
 This module creates an agetty session. This is used by the `ugrd.crypto.gpg` module so the tty can be used for input and output.

ugrd/base/kmod.py

@@ -1,6 +1,6 @@
 __author__ = 'desultory'
 
-__version__ = '0.4.5'
+__version__ = '0.4.7'
 
 from pathlib import Path
 
@@ -153,7 +153,34 @@ def resolve_kmod(self, module_name):
         self.logger.warning("[%s] Kernel module has no dependencies." % module_name)
 
 
-def get_all_modules(self):
+def get_lspci_modules(self):
+    """
+    Gets the name of all kernel modules being used by hardware visible in lspci -k
+    """
+    try:
+        cmd = self._run(['lspci', '-k'])
+    except RuntimeError as e:
+        raise DependencyResolutionError("Failed to get list of kernel modules") from e
+
+    raw_modules = set()
+    # Iterate over all output lines
+    for line in cmd.stdout.decode('utf-8').split('\n'):
+        # If the line contains the string 'Kernel modules:' or 'Kernel driver in use:', it contains the name of a kernel module
+        if 'Kernel modules:' in line or 'Kernel driver in use:' in line:
+            module = line.split(':')[1]
+            if ',' in module:
+                # If there are multiple modules, split them and add them to the module set
+                for module in module.split(','):
+                    raw_modules.add(module.strip())
+            else:
+                # Add the single module to the module set
+                raw_modules.add(module.strip())
+
+    self.logger.debug("Kernel modules in use by hardware: %s" % raw_modules)
+    return list(raw_modules)
+
+
+def get_lsmod_modules(self):
     """
     Gets the name of all currently installed kernel modules
     """
@@ -215,10 +242,14 @@ def calculate_modules(self):
     Adds the contents of _kmod_depend if specified.
     If kernel_modules is empty, pulls all currently loaded kernel modules.
     """
-    if self.config_dict['kmod_autodetect']:
-        self.logger.info("Autodetecting kernel modules")
-        autodetected_modules = get_all_modules(self)
-        self.logger.info("Autodetected kernel modules: %s" % autodetected_modules)
+    if self.config_dict['kmod_autodetect_lsmod']:
+        autodetected_modules = get_lsmod_modules(self)
+        self.logger.info("Autodetected kernel modules from lsmod: %s" % autodetected_modules)
+        self.config_dict['kernel_modules'] = autodetected_modules
+
+    if self.config_dict['kmod_autodetect_lspci']:
+        autodetected_modules = get_lspci_modules(self)
+        self.logger.info("Autodetected kernel modules from lscpi -k: %s" % autodetected_modules)
         self.config_dict['kernel_modules'] = autodetected_modules
 
     if self.config_dict['_kmod_depend']:

ugrd/base/kmod.toml

@@ -1,11 +1,15 @@
 binaries = [ "modprobe", "lsmod" ]
 
+# Ignore this because it's only builtin
+kmod_ignore = ['pcieport', 'piix4_smbus']
+
 [custom_parameters]
 kernel_modules = "NoDupFlatList"  # Kernel modules to pull into the initramfs
 kernel_version = "str"  # Kernel version to use for the initramfs
 kmod_ignore_softdeps = "bool"  # Whether or not softdeps are ignored
 kmod_init = "NoDupFlatList"  # Kernel modules to load at initramfs startup
-kmod_autodetect = "bool"  # Whether or not to automatically pull currently loaded kernel modules
+kmod_autodetect_lsmod = "bool"  # Whether or not to automatically pull currently loaded kernel modules
+kmod_autodetect_lspci = "bool"  # Whether or not to automatically pull kernel modules from lspci -k
 kmod_ignore = "NoDupFlatList"  # Kernel modules to ignore when loading
 _kmod_depend = "NoDupFlatList"  # Meant to be used internally, defines kernel modules to automatically load, typically within other module config
 

ugrd/base/kmod_nosound.toml

@@ -0,0 +1,3 @@
+mod_depends = ['ugrd.base.kmod']
+
+kmod_ignore = ['snd_hda_intel', 'snd-hda-core', 'snd-hda-codec', 'snd', 'snd-intel-dspcfg', 'snd-pcm', 'snd-hwdep', 'soundcore', 'snd-intel-sdw-acpi', 'snd-timer']

ugrd/base/kmod_novideo.toml

@@ -0,0 +1,3 @@
+mod_depends = ['ugrd.base.kmod']
+
+kmod_ignore = ['amdgpu', 'drm_kms_helper', 'ttm', 'drm_display_helper', 'gpu-sched', 'drm_buddy', 'video', 'drm_ttm_helper']

ugrd/initramfs_generator.py

@@ -1,6 +1,6 @@
 
 __author__ = "desultory"
-__version__ = "0.6.2"
+__version__ = "0.6.4"
 
 from tomllib import load
 from pathlib import Path