Merge pull request #3312 from hundeboll/modules-and-firmware-includes

Modules and firmware includes

mkosi/kmod.py

@@ -10,6 +10,7 @@
 
 from mkosi.log import complete_step, log_step
 from mkosi.run import chroot_cmd, run
+from mkosi.sandbox import chase
 from mkosi.util import chdir, parents_below
 
 
@@ -180,6 +181,15 @@ def gen_required_kernel_modules(
             mods = set(modulesd.rglob("*.ko*"))
         firmware = set()
 
+    # Some firmware dependencies are symbolic links, so the targets for those must be included in the list
+    # of required firmware files too. Intermediate symlinks are not included, and so links pointing to links
+    # results in dangling symlinks in the final image.
+    for fw in firmware.copy():
+        if (root / fw).is_symlink():
+            target = Path(chase(os.fspath(root), os.fspath(fw)))
+            if target.exists():
+                firmware.add(target.relative_to(root))
+
     yield from sorted(
         itertools.chain(
             {

mkosi/resources/man/mkosi.1.md

@@ -1016,10 +1016,10 @@ boolean argument: either `1`, `yes`, or `true` to enable, or `0`, `no`,
 
 `KernelModulesInclude=`, `--kernel-modules-include=`
 :   Takes a list of regex patterns that specify kernel modules to include in the image. Patterns should be
-    relative to the `/usr/lib/modules/<kver>/kernel` directory. mkosi checks for a match anywhere in the module
-    path (e.g. `i915` will match against `drivers/gpu/drm/i915.ko`). All modules that match any of the
-    specified patterns are included in the image. All module and firmware dependencies of the matched modules
-    are included in the image as well.
+    relative to `/usr/lib/modules/<kver>/<subdir>` paths. mkosi checks for a match anywhere in the module path
+    (e.g. `i915` will match against `drivers/gpu/drm/i915.ko`). All modules that match any of the specified
+    patterns are included in the image. All module and firmware dependencies of the matched modules are included
+    in the image as well.
 
     If the special value `default` is used, the default kernel modules
     defined in the `mkosi-initrd` configuration are included as well.

tests/test_initrd.py

@@ -225,9 +225,9 @@ def test_initrd_size(config: ImageConfig) -> None:
         maxsize = 1024**2 * {
             Distribution.fedora: 63,
             Distribution.debian: 62,
-            Distribution.ubuntu: 56,
+            Distribution.ubuntu: 57,
             Distribution.arch: 83,
             Distribution.opensuse: 64,
-        }.get(config.distribution, 57)
+        }.get(config.distribution, 58)
 
         assert (Path(image.output_dir) / "image.initrd").stat().st_size <= maxsize