1 ;;; GNU Guix --- Functional package management for GNU
2 ;;; Copyright © 2013, 2014, 2015, 2016, 2017, 2018 Ludovic Courtès <ludo@gnu.org>
3 ;;; Copyright © 2016 Mark H Weaver <mhw@netris.org>
4 ;;; Copyright © 2016 Jan Nieuwenhuizen <janneke@gnu.org>
5 ;;; Copyright © 2017 Mathieu Othacehe <m.othacehe@gmail.com>
7 ;;; This file is part of GNU Guix.
9 ;;; GNU Guix is free software; you can redistribute it and/or modify it
10 ;;; under the terms of the GNU General Public License as published by
11 ;;; the Free Software Foundation; either version 3 of the License, or (at
12 ;;; your option) any later version.
14 ;;; GNU Guix is distributed in the hope that it will be useful, but
15 ;;; WITHOUT ANY WARRANTY; without even the implied warranty of
16 ;;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 ;;; GNU General Public License for more details.
19 ;;; You should have received a copy of the GNU General Public License
20 ;;; along with GNU Guix. If not, see <http://www.gnu.org/licenses/>.
22 (define-module (gnu system linux-initrd)
23 #:use-module (guix monads)
24 #:use-module (guix store)
25 #:use-module (guix gexp)
26 #:use-module (guix utils)
27 #:use-module ((guix store)
28 #:select (%store-prefix))
29 #:use-module ((guix derivations)
30 #:select (derivation->output-path))
31 #:use-module (guix modules)
32 #:use-module (gnu packages compression)
33 #:use-module (gnu packages disk)
34 #:use-module (gnu packages linux)
35 #:use-module (gnu packages guile)
36 #:use-module ((gnu packages make-bootstrap)
37 #:select (%guile-static-stripped))
38 #:use-module (gnu system file-systems)
39 #:use-module (gnu system mapped-devices)
40 #:use-module (ice-9 match)
41 #:use-module (ice-9 regex)
42 #:use-module (ice-9 vlist)
43 #:use-module (srfi srfi-1)
44 #:use-module (srfi srfi-26)
45 #:export (expression->initrd
54 ;;; Tools to build initial RAM disks (initrd's) for Linux-Libre, and in
55 ;;; particular initrd's that run Guile.
60 (define* (expression->initrd exp
62 (guile %guile-static-stripped)
65 (system (%current-system)))
66 "Return a derivation that builds a Linux initrd (a gzipped cpio archive)
67 containing GUILE and that evaluates EXP, a G-expression, upon booting. All
68 the derivations referenced by EXP are automatically copied to the initrd."
70 ;; General Linux overview in `Documentation/early-userspace/README' and
71 ;; `Documentation/filesystems/ramfs-rootfs-initramfs.txt'.
74 (program-file "init" exp #:guile guile))
77 (with-imported-modules (source-module-closure
78 '((gnu build linux-initrd)))
80 (use-modules (gnu build linux-initrd))
84 ;; The guile used in the initrd must be present in the store, so
85 ;; that module loading works once the root is switched.
87 ;; To ensure that is the case, add an explicit reference to the
88 ;; guile package used in the initrd to the output.
90 ;; This fixes guix-patches bug #28399, "Fix mysql activation, and
92 (call-with-output-file (string-append #$ output "/references")
94 (simple-format port "~A\n" #$guile)))
96 (build-initrd (string-append #$output "/initrd")
99 ;; Copy everything INIT refers to into the initrd.
100 #:references-graphs '("closure")
101 #:gzip (string-append #$gzip "/bin/gzip")))))
103 (gexp->derivation name builder
104 #:references-graphs `(("closure" ,init))))
106 (define (flat-linux-module-directory linux modules)
107 "Return a flat directory containing the Linux kernel modules listed in
108 MODULES and taken from LINUX."
110 (with-imported-modules (source-module-closure
111 '((gnu build linux-modules)))
113 (use-modules (gnu build linux-modules)
118 (string-append #$linux "/lib/modules"))
121 (let* ((lookup (cut find-module-file module-dir <>))
122 (modules (map lookup '#$modules)))
124 (recursive-module-dependencies modules
125 #:lookup-module lookup))))
128 (for-each (lambda (module)
129 (format #t "copying '~a'...~%" module)
131 (string-append #$output "/"
133 (delete-duplicates modules)))))
135 (computed-file "linux-modules" build-exp))
137 (define* (raw-initrd file-systems
142 (helper-packages '())
146 "Return a monadic derivation that builds a raw initrd, with kernel
147 modules taken from LINUX. FILE-SYSTEMS is a list of file-systems to be
148 mounted by the initrd, possibly in addition to the root file system specified
149 on the kernel command line via '--root'. LINUX-MODULES is a list of kernel
150 modules to be loaded at boot time. MAPPED-DEVICES is a list of device
151 mappings to realize before FILE-SYSTEMS are mounted.
152 HELPER-PACKAGES is a list of packages to be copied in the initrd. It may include
153 e2fsck/static or other packages needed by the initrd to check root partition.
155 When QEMU-NETWORKING? is true, set up networking with the standard QEMU
158 When VOLATILE-ROOT? is true, the root file system is writable but any changes
161 ON-ERROR is passed to 'call-with-error-handling'; it determines what happens
163 (define device-mapping-commands
164 ;; List of gexps to open the mapped devices.
166 (let* ((source (mapped-device-source md))
167 (target (mapped-device-target md))
168 (type (mapped-device-type md))
169 (open (mapped-device-kind-open type)))
170 (open source target)))
174 (flat-linux-module-directory linux linux-modules))
177 (with-imported-modules (source-module-closure
178 '((gnu build linux-boot)
180 (guix build bournish)
181 (gnu system file-systems)
182 (gnu build file-systems)))
184 (use-modules (gnu build linux-boot)
185 (gnu system file-systems)
187 (guix build bournish) ;add the 'bournish' meta-command
190 ;; FIXME: The following modules are for
191 ;; LUKS-DEVICE-MAPPING. We should instead propagate
192 ;; this info via gexps.
193 ((gnu build file-systems)
194 #:select (find-partition-by-luks-uuid))
197 (with-output-to-port (%make-void-port "w")
199 (set-path-environment-variable "PATH" '("bin" "sbin")
200 '#$helper-packages)))
202 (boot-system #:mounts
203 (map spec->file-system
204 '#$(map file-system->spec file-systems))
205 #:pre-mount (lambda ()
206 (and #$@device-mapping-commands))
207 #:linux-modules '#$linux-modules
208 #:linux-module-directory '#$kodir
209 #:qemu-guest-networking? #$qemu-networking?
210 #:volatile-root? '#$volatile-root?
211 #:on-error '#$on-error)))
212 #:name "raw-initrd"))
214 (define* (file-system-packages file-systems #:key (volatile-root? #f))
215 "Return the list of statically-linked, stripped packages to check
217 `(,@(if (find (lambda (fs)
218 (string-prefix? "ext" (file-system-type fs)))
222 ,@(if (find (lambda (fs)
223 (string-suffix? "fat" (file-system-type fs)))
225 (list fatfsck/static)
227 ,@(if (find (file-system-type-predicate "btrfs") file-systems)
228 (list btrfs-progs/static)
231 (define-syntax vhash ;TODO: factorize
233 "Build a vhash with the given key/value mappings."
236 ((_ (key others ... => value) rest ...)
237 (vhash-cons key value
238 (vhash (others ... => value) rest ...)))
239 ((_ (=> value) rest ...)
242 (define-syntax lookup-procedure
244 "Return a procedure that lookups keys in the given dictionary."
245 ((_ mapping ... (else default))
246 (let ((table (vhash mapping ...)))
248 (match (vhash-assoc key table)
250 ((key . value) value)))))))
252 (define file-system-type-modules
253 ;; Given a file system type, return the list of modules it needs.
254 (lookup-procedure ("cifs" => '("md4" "ecb" "cifs"))
255 ("9p" => '("9p" "9pnet_virtio"))
256 ("btrfs" => '("btrfs"))
257 ("iso9660" => '("isofs"))
260 (define (file-system-modules file-systems)
261 "Return the list of Linux modules needed to mount FILE-SYSTEMS."
262 (append-map (compose file-system-type-modules file-system-type)
265 (define* (default-initrd-modules #:optional (system (%current-system)))
266 "Return the list of modules included in the initrd by default."
267 (define virtio-modules
268 ;; Modules for Linux para-virtualized devices, for use in QEMU guests.
269 '("virtio_pci" "virtio_balloon" "virtio_blk" "virtio_net"
270 "virtio_console" "virtio-rng"))
272 `("ahci" ;for SATA controllers
273 "usb-storage" "uas" ;for the installation image etc.
274 "usbhid" "hid-generic" "hid-apple" ;keyboards during early boot
275 "dm-crypt" "xts" "serpent_generic" "wp512" ;for encrypted root partitions
276 "nls_iso8859-1" ;for `mkfs.fat`, et.al
277 ,@(if (string-match "^(x86_64|i[3-6]86)-" system)
278 '("pata_acpi" "pata_atiixp" ;for ATA controllers
279 "isci") ;for SAS controllers like Intel C602
284 (define-syntax %base-initrd-modules
285 ;; This more closely matches our naming convention.
286 (identifier-syntax (default-initrd-modules)))
288 (define* (base-initrd file-systems
295 (extra-modules '()) ;deprecated
297 "Return a monadic derivation that builds a generic initrd, with kernel
298 modules taken from LINUX. FILE-SYSTEMS is a list of file-systems to be
299 mounted by the initrd, possibly in addition to the root file system specified
300 on the kernel command line via '--root'. MAPPED-DEVICES is a list of device
301 mappings to realize before FILE-SYSTEMS are mounted.
303 QEMU-NETWORKING? and VOLATILE-ROOT? behaves as in raw-initrd.
305 The initrd is automatically populated with all the kernel modules necessary
306 for FILE-SYSTEMS and for the given options. Additional kernel
307 modules can be listed in LINUX-MODULES. They will be added to the initrd, and
308 loaded at boot time in the order in which they appear."
309 (define linux-modules*
310 ;; Modules added to the initrd and loaded from the initrd.
312 ,@(file-system-modules file-systems)
318 (define helper-packages
319 (file-system-packages file-systems #:volatile-root? volatile-root?))
321 (raw-initrd file-systems
323 #:linux-modules linux-modules*
324 #:mapped-devices mapped-devices
325 #:helper-packages helper-packages
326 #:qemu-networking? qemu-networking?
327 #:volatile-root? volatile-root?
328 #:on-error on-error))
330 ;;; linux-initrd.scm ends here