gnu: linux: Use package properties to modularize initrd build.

* doc/guix.texi (operating-system Reference): Document initrd-modules change.
(Initial RAM Disk): Inform about deprecation of '%base-initrd-modules' and
document 'base-initrd-modules'.
* gnu/packages/linux.scm (make-linux*): New argument
'produced-modules'. Handle GEXP in 'defconfig' arguments.
(virtio-modules, default-linux-libre-initrd-modules): New variable.
(make-linux-libre*): Adjust to instruct 'make-linux*' which modules a Debian
configuration will produce.
* gnu/system.scm (<operating-system>): Compute default operating systems
initrd modules with 'base-initrd-modules'.
* gnu/system/linux-initrd.scm (default-initrd-modules): Remove in favor of
'base-initrd-modules' which takes a mandatory kernel argument from which to
extract the initrd-modules from the package properties.
(base-initrd-modules): New procedure.
(%base-initrd-modules): Deprecate in favor of 'base-initrd-modules'.

1 files changed, 86 insertions, 17 deletions

diff --git a/gnu/packages/linux.scm b/gnu/packages/linux.scm
index 6965528ab7a..252328f4230 100644
--- a/gnu/packages/linux.scm
+++ b/gnu/packages/linux.scm
@@ -1047,7 +1047,7 @@ ARCH and optionally VARIANT, or #f if there is no such configuration."
   (and (version>=? version "5.10")
        (not (version>=? version "6.2")))) ;patch applied upstream
 
-(define* (make-linux* version source supported-systems
+(define* (make-linux* version source supported-systems produced-modules
                       #:key
                       (extra-version #f)
                       ;; A function that takes an arch and a variant.
@@ -1055,6 +1055,30 @@ ARCH and optionally VARIANT, or #f if there is no such configuration."
                       (configuration-file #f)
                       (defconfig "defconfig")
                       (extra-options (default-extra-linux-options version)))
+  "Create a Linux package from VERSION using SOURCE for SUPPORTED-SYSTEMS.
+
+Produced modules will use package-properties to convey which modules the given
+configuration produced either by CONFIGURATION-FILE or DEFCONFIG will yield.
+This allows 'operating-system' records to infer their 'intrd-modules' value
+from their 'kernel' field package.
+
+EXTRA-VERSION will control the emitted package name as well as the
+EXTRAVERSION value of the kernel build.
+
+CONFIGURATION-FILE is a file-like object which will be used as the
+configuration file to use for building the kernel.  If used the DEFCONFIG
+argument will be ignored.
+
+DEFCONFIG can either be a string, which will control the make target that
+generates the configuration file used for building the kernel, or a GEXP which
+should produce the '.config' file that will be used for building the kernel.
+
+EXTRA-OPTIONS will be appended to the configuration file provided by
+CONFIGURATION-FILE or generated by DEFCONFIG.  It must be an alist where each element has the form:
+(KERNEL-OPTION . VALUE)
+
+KERNEL-OPTION must be a string and VALUE can be '#t', '#f' or 'm' for
+instructing that the configuration option should build a kernel module."
   (package
     (name (if extra-version
               (string-append "linux-" extra-version)
@@ -1133,7 +1157,13 @@ ARCH and optionally VARIANT, or #f if there is no such configuration."
                     (begin
                       (copy-file config ".config")
                       (chmod ".config" #o666))
-                    (invoke "make" #$defconfig))
+                    #$(cond
+                       ((string? defconfig)
+                        #~(invoke "make" #$defconfig))
+                       ((promise? defconfig)
+                        (force defconfig))
+                       (else
+                        defconfig)))
                 ;; Appending works even when the option wasn't in the file.
                 ;; The last one prevails if duplicated.
                 (let ((port (open-file ".config" "a"))
@@ -1211,7 +1241,9 @@ ARCH and optionally VARIANT, or #f if there is no such configuration."
     (home-page #f)
     (synopsis #f)
     (description #f)
-    (license #f)))
+    (license #f)
+    (properties
+     `((base-initrd-modules . ,produced-modules)))))
 
 (define* (make-linux-libre version gnu-revision hash-string supported-systems
                            #:key
@@ -1240,6 +1272,39 @@ ARCH and optionally VARIANT, or #f if there is no such configuration."
                      #:defconfig defconfig
                      #:extra-options extra-options))
 
+(define virtio-modules
+  ;; Modules for Linux para-virtualized devices, for use in QEMU guests.
+  '("virtio_pci" "virtio_balloon" "virtio_blk" "virtio_net"
+    "virtio_console" "virtio-rng" "virtio_mmio" "virtio_scsi"))
+
+(define default-linux-libre-initrd-modules
+  ;; Default set of modules that need to be available in the initrd when
+  ;; booting Linux-libre.
+  (let* ((generic `("ahci"                                     ;for SATA controllers
+                    "nvme"                                     ;for NVMe controllers
+                    "usb-storage" "uas"                        ;for the installation image etc.
+                    "usbhid" "hid-generic"                     ;keyboards during early boot
+                    "mmc_block"                                ;for MMC block device driver
+                    "dm-crypt" "xts" "serpent_generic" "wp512" ;for encrypted root partitions
+                    "nls_iso8859-1"                            ;for `mkfs.fat`, et.al
+                    ,@virtio-modules))
+         (_86 (cons*
+               "hid-apple"
+               "pata_acpi" "pata_atiixp" ;for ATA controllers
+               "isci"
+               generic))
+         (others (cons*
+                  "hid-apple"
+                  generic)))
+    `(("x86_64-linux"      . ,_86)
+      ("i686-linux"        . ,_86)
+      ("armhf-linux"       . ,others)
+      ("aarch64-linux"     . ,others)
+      ("mips64el-linux"    . ,others)
+      ("powerpc-linux"     . ,others)
+      ("powerpc64le-linux" . ,others)
+      ("riscv64-linux"     . ,generic))))
+
 (define* (make-linux-libre* version gnu-revision source supported-systems
                             #:key
                             (extra-version #f)
@@ -1248,21 +1313,25 @@ ARCH and optionally VARIANT, or #f if there is no such configuration."
                             (configuration-file #f)
                             (defconfig "defconfig")
                             (extra-options (default-extra-linux-options version)))
-  (package
-    (inherit (make-linux* version source supported-systems
-                          #:extra-version extra-version
-                          #:configuration-file configuration-file
-                          #:defconfig defconfig
-                          #:extra-options extra-options))
-    (name (if extra-version
-              (string-append "linux-libre-" extra-version)
-              "linux-libre"))
-    (home-page "https://www.gnu.org/software/linux-libre/")
-    (synopsis "100% free redistribution of a cleaned Linux kernel")
-    (description "GNU Linux-Libre is a free (as in freedom) variant of the
+  (let ((linux (make-linux* version source supported-systems
+                            default-linux-libre-initrd-modules
+                            #:extra-version extra-version
+                            #:configuration-file configuration-file
+                            #:defconfig defconfig
+                            #:extra-options extra-options)))
+    (package
+      (inherit linux)
+      (name (if extra-version
+                (string-append "linux-libre-" extra-version)
+                "linux-libre"))
+      (home-page "https://www.gnu.org/software/linux-libre/")
+      (synopsis "100% free redistribution of a cleaned Linux kernel")
+      (description "GNU Linux-Libre is a free (as in freedom) variant of the
 Linux kernel.  It has been modified to remove all non-free binary blobs.")
-    (license license:gpl2)
-    (properties %linux-libre-timeout-properties)))
+      (license license:gpl2)
+      (properties (append %linux-libre-timeout-properties
+                          (package-properties linux))))))
+
 
 
 ;;;