mapped-devices: Allow target to be list of strings.
[jackhill/guix/guix.git] / gnu / system.scm
CommitLineData
033adfe7 1;;; GNU Guix --- Functional package management for GNU
cda75110 2;;; Copyright © 2013, 2014, 2015, 2016, 2017, 2018, 2019, 2020 Ludovic Courtès <ludo@gnu.org>
5e738ac2 3;;; Copyright © 2015 Mark H Weaver <mhw@netris.org>
5dccaffe 4;;; Copyright © 2015, 2016 Alex Kost <alezost@gmail.com>
1ef8b72a 5;;; Copyright © 2016 Chris Marusich <cmmarusich@gmail.com>
c76b3046 6;;; Copyright © 2017 Mathieu Othacehe <m.othacehe@gmail.com>
5144df2c 7;;; Copyright © 2019 Meiyo Peng <meiyo.peng@gmail.com>
9d449b94 8;;; Copyright © 2019 Miguel Ángel Arruga Vivas <rosen644835@gmail.com>
5c79f238 9;;; Copyright © 2020 Danny Milosavljevic <dannym@scratchpost.org>
93664fee 10;;; Copyright © 2020 Brice Waegeneire <brice@waegenei.re>
e06664da 11;;; Copyright © 2020 Florian Pelz <pelzflorian@pelzflorian.de>
b460ba79 12;;; Copyright © 2020 Maxim Cournoyer <maxim.cournoyer@gmail.com>
45b2cb43 13;;; Copyright © 2020 Jan (janneke) Nieuwenhuizen <jannek@gnu.org>
e6e07628 14;;; Copyright © 2020 Efraim Flashner <efraim@flashner.co.il>
033adfe7
LC
15;;;
16;;; This file is part of GNU Guix.
17;;;
18;;; GNU Guix is free software; you can redistribute it and/or modify it
19;;; under the terms of the GNU General Public License as published by
20;;; the Free Software Foundation; either version 3 of the License, or (at
21;;; your option) any later version.
22;;;
23;;; GNU Guix is distributed in the hope that it will be useful, but
24;;; WITHOUT ANY WARRANTY; without even the implied warranty of
25;;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
26;;; GNU General Public License for more details.
27;;;
28;;; You should have received a copy of the GNU General Public License
29;;; along with GNU Guix. If not, see <http://www.gnu.org/licenses/>.
30
31(define-module (gnu system)
bdc61ff9 32 #:use-module (guix inferior)
033adfe7
LC
33 #:use-module (guix store)
34 #:use-module (guix monads)
02100028 35 #:use-module (guix gexp)
033adfe7
LC
36 #:use-module (guix records)
37 #:use-module (guix packages)
38 #:use-module (guix derivations)
29fce8b6 39 #:use-module (guix profiles)
a5e2fc73
LC
40 #:use-module ((guix utils) #:select (substitute-keyword-arguments))
41 #:use-module (guix i18n)
42 #:use-module (guix diagnostics)
e6e07628 43 #:use-module (gnu packages admin)
033adfe7
LC
44 #:use-module (gnu packages base)
45 #:use-module (gnu packages bash)
e6e07628 46 #:use-module (gnu packages compression)
912b857e 47 #:use-module (gnu packages cross-base)
e6e07628
EF
48 #:use-module (gnu packages cryptsetup)
49 #:use-module (gnu packages disk)
50 #:use-module (gnu packages file-systems)
51 #:use-module (gnu packages firmware)
52 #:use-module (gnu packages gawk)
bdb36958 53 #:use-module (gnu packages guile)
01ac0e6b 54 #:use-module (gnu packages guile-xyz)
912b857e 55 #:use-module (gnu packages hurd)
6f436c54 56 #:use-module (gnu packages less)
e6e07628 57 #:use-module (gnu packages linux)
18316d86 58 #:use-module (gnu packages man)
e6e07628 59 #:use-module (gnu packages nano)
4170af49 60 #:use-module (gnu packages nvi)
e6e07628
EF
61 #:use-module (gnu packages package-management)
62 #:use-module (gnu packages pciutils)
939c5c31 63 #:use-module (gnu packages texinfo)
e6e07628 64 #:use-module (gnu packages zile)
db4fdc04 65 #:use-module (gnu services)
0190c1c0 66 #:use-module (gnu services shepherd)
db4fdc04 67 #:use-module (gnu services base)
b09a8da4 68 #:use-module (gnu bootloader)
033adfe7 69 #:use-module (gnu system shadow)
996ed739 70 #:use-module (gnu system nss)
598e19dc 71 #:use-module (gnu system locale)
6e828634 72 #:use-module (gnu system pam)
735c6dd7 73 #:use-module (gnu system linux-initrd)
9b336338 74 #:use-module (gnu system uuid)
c5df1839 75 #:use-module (gnu system file-systems)
060d62a7 76 #:use-module (gnu system mapped-devices)
033adfe7
LC
77 #:use-module (ice-9 match)
78 #:use-module (srfi srfi-1)
79 #:use-module (srfi srfi-26)
598e19dc
LC
80 #:use-module (srfi srfi-34)
81 #:use-module (srfi srfi-35)
3382bfe9 82 #:use-module (rnrs bytevectors)
033adfe7
LC
83 #:export (operating-system
84 operating-system?
d8bead6c 85 this-operating-system
d5b429ab
LC
86
87 operating-system-bootloader
033adfe7 88 operating-system-services
69cae3d3 89 operating-system-essential-services
f8885eca 90 operating-system-default-essential-services
217a5b85 91 operating-system-user-services
033adfe7 92 operating-system-packages
fd3bfc44 93 operating-system-host-name
c65e1834 94 operating-system-hosts-file
2018fb2a 95 operating-system-hurd
fd3bfc44 96 operating-system-kernel
44d5f54e 97 operating-system-kernel-file
33f0aa88 98 operating-system-kernel-arguments
3f03a198
LC
99 operating-system-label
100 operating-system-default-label
bc499b11 101 operating-system-initrd-modules
fd3bfc44
LC
102 operating-system-initrd
103 operating-system-users
104 operating-system-groups
548d4c13 105 operating-system-issue
fd3bfc44
LC
106 operating-system-timezone
107 operating-system-locale
598e19dc 108 operating-system-locale-definitions
34760ae7 109 operating-system-locale-libcs
5dae0186 110 operating-system-mapped-devices
83bcd0b8 111 operating-system-file-systems
6b779207 112 operating-system-store-file-system
2bdd7ac1
LC
113 operating-system-user-mapped-devices
114 operating-system-boot-mapped-devices
b25937e3 115 operating-system-activation-script
b2fef041
LC
116 operating-system-user-accounts
117 operating-system-shepherd-service-names
20abb8c4 118 operating-system-user-kernel-arguments
9ef37e81
BW
119 operating-system-firmware
120 operating-system-keyboard-layout
121 operating-system-name-service-switch
122 operating-system-pam-services
123 operating-system-setuid-programs
124 operating-system-skeletons
125 operating-system-sudoers-file
126 operating-system-swap-devices
a9f2c210 127 operating-system-kernel-loadable-modules
9e12da31 128 operating-system-location
033adfe7 129
1aa0033b 130 operating-system-derivation
83bcd0b8 131 operating-system-profile
c76b3046 132 operating-system-bootcfg
239db054
DT
133 operating-system-etc-directory
134 operating-system-locale-directory
135 operating-system-boot-script
78fbf2bd 136 operating-system-uuid
239db054 137
43fe431c 138 system-linux-image-file-name
9fcfe30d 139 operating-system-with-gc-roots
33b7cb7a 140 operating-system-with-provenance
43fe431c 141
45b2cb43
JN
142 hurd-default-essential-services
143
b8300494
AK
144 boot-parameters
145 boot-parameters?
146 boot-parameters-label
147 boot-parameters-root-device
f96752e3 148 boot-parameters-bootloader-name
a28cfee8 149 boot-parameters-bootloader-menu-entries
1ef8b72a 150 boot-parameters-store-device
582cf925 151 boot-parameters-store-directory-prefix
1ef8b72a 152 boot-parameters-store-mount-point
9d449b94 153 boot-parameters-locale
b8300494
AK
154 boot-parameters-kernel
155 boot-parameters-kernel-arguments
d7b342d8 156 boot-parameters-initrd
912b857e 157 boot-parameters-multiboot-modules
4e4e0185 158 read-boot-parameters
9530e73b 159 read-boot-parameters-file
1975c754 160 boot-parameters->menu-entry
b8300494 161
568841d4 162 local-host-aliases
d0f3a672 163 %root-account
df5ce088 164 %setuid-programs
f6b95031 165 %sudoers-specification
5dae0186 166 %base-packages
93664fee
BW
167 %base-packages-interactive
168 %base-packages-linux
169 %base-packages-networking
e6e07628 170 %base-packages-disk-utilities
93664fee 171 %base-packages-utils
e06664da
FP
172 %base-firmware
173 %default-kernel-arguments))
033adfe7
LC
174
175;;; Commentary:
176;;;
177;;; This module supports whole-system configuration.
178;;;
179;;; Code:
180
a7ef45d9
LC
181(define (bootable-kernel-arguments system root-device)
182 "Return a list of kernel arguments (gexps) to boot SYSTEM from ROOT-DEVICE."
183 (list (string-append "--root="
99e676db
MC
184 ;; Note: Always use the DCE format because that's what
185 ;; (gnu build linux-boot) expects for the '--root'
186 ;; kernel command-line option.
187 (file-system-device->string root-device
188 #:uuid-type 'dce))
a7ef45d9
LC
189 #~(string-append "--system=" #$system)
190 #~(string-append "--load=" #$system "/boot")))
33f0aa88 191
033adfe7
LC
192;; System-wide configuration.
193;; TODO: Add per-field docstrings/stexi.
194(define-record-type* <operating-system> operating-system
195 make-operating-system
196 operating-system?
d8bead6c
LC
197 this-operating-system
198
033adfe7 199 (kernel operating-system-kernel ; package
57082417 200 (default linux-libre))
5c79f238
DM
201 (kernel-loadable-modules operating-system-kernel-loadable-modules
202 (default '())) ; list of packages
af98d25a 203 (kernel-arguments operating-system-user-kernel-arguments
e06664da 204 (default %default-kernel-arguments)) ; list of gexps/strings
2018fb2a
JN
205 (hurd operating-system-hurd
206 (default #f)) ; package
b09a8da4 207 (bootloader operating-system-bootloader) ; <bootloader-configuration>
3f03a198
LC
208 (label operating-system-label ; string
209 (thunked)
210 (default (operating-system-default-label this-operating-system)))
d5b429ab 211
ae7a316b
LC
212 (keyboard-layout operating-system-keyboard-layout ;#f | <keyboard-layout>
213 (default #f))
e34ae75d 214 (initrd operating-system-initrd ; (list fs) -> file-like
060238ae 215 (default base-initrd))
bc499b11
LC
216 (initrd-modules operating-system-initrd-modules ; list of strings
217 (thunked) ; it's system-dependent
218 (default %base-initrd-modules))
219
f34c56be
LC
220 (firmware operating-system-firmware ; list of packages
221 (default %base-firmware))
033adfe7
LC
222
223 (host-name operating-system-host-name) ; string
24e02c28 224 (hosts-file operating-system-hosts-file ; file-like | #f
c65e1834 225 (default #f))
033adfe7 226
5dae0186
LC
227 (mapped-devices operating-system-mapped-devices ; list of <mapped-device>
228 (default '()))
8a6d2731 229 (file-systems operating-system-file-systems) ; list of fs
2a13d05e
LC
230 (swap-devices operating-system-swap-devices ; list of strings
231 (default '()))
033adfe7
LC
232
233 (users operating-system-users ; list of user accounts
bf87f38a 234 (default %base-user-accounts))
033adfe7 235 (groups operating-system-groups ; list of user groups
773e956d 236 (default %base-groups))
033adfe7 237
ac3c14fb 238 (skeletons operating-system-skeletons ; list of name/file-like value
40281c54 239 (default (default-skeletons)))
548d4c13
LC
240 (issue operating-system-issue ; string
241 (default %default-issue))
40281c54 242
033adfe7 243 (packages operating-system-packages ; list of (PACKAGE OUTPUT...)
6f436c54 244 (default %base-packages)) ; or just PACKAGE
033adfe7
LC
245
246 (timezone operating-system-timezone) ; string
8a6d2731 247 (locale operating-system-locale ; string
598e19dc
LC
248 (default "en_US.utf8"))
249 (locale-definitions operating-system-locale-definitions ; list of <locale-definition>
250 (default %default-locale-definitions))
34760ae7
LC
251 (locale-libcs operating-system-locale-libcs ; list of <packages>
252 (default %default-locale-libcs))
996ed739
LC
253 (name-service-switch operating-system-name-service-switch ; <name-service-switch>
254 (default %default-nss))
033adfe7 255
69cae3d3
LC
256 (essential-services operating-system-essential-services ; list of services
257 (thunked)
f8885eca
LC
258 (default (operating-system-default-essential-services
259 this-operating-system)))
ac3c14fb 260 (services operating-system-user-services ; list of services
09e028f4
LC
261 (default %base-services))
262
263 (pam-services operating-system-pam-services ; list of PAM services
264 (default (base-pam-services)))
265 (setuid-programs operating-system-setuid-programs
69689380 266 (default %setuid-programs)) ; list of string-valued gexps
033adfe7 267
f5a9ffa0 268 (sudoers-file operating-system-sudoers-file ; file-like
9e12da31
LC
269 (default %sudoers-specification))
270
271 (location operating-system-location ; <location>
272 (default (and=> (current-source-location)
273 source-properties->location))
274 (innate)))
033adfe7 275
a7ef45d9 276(define (operating-system-kernel-arguments os root-device)
33f0aa88
DM
277 "Return all the kernel arguments, including the ones not specified
278directly by the user."
a7ef45d9
LC
279 (append (bootable-kernel-arguments os root-device)
280 (operating-system-user-kernel-arguments os)))
33f0aa88 281
2717a89a 282\f
8e815c5b
LC
283;;;
284;;; Boot parameters
285;;;
286
287(define-record-type* <boot-parameters>
288 boot-parameters make-boot-parameters boot-parameters?
289 (label boot-parameters-label)
290 ;; Because we will use the 'store-device' to create the GRUB search command,
291 ;; the 'store-device' has slightly different semantics than 'root-device'.
292 ;; The 'store-device' can be a file system uuid, a file system label, or #f,
2df44e93
MÁAV
293 ;; but it cannot be a device file name such as "/dev/sda3", since GRUB would
294 ;; not understand that. The 'root-device', on the other hand, corresponds
8e815c5b 295 ;; exactly to the device field of the <file-system> object representing the
2df44e93
MÁAV
296 ;; OS's root file system, so it might be a device file name like
297 ;; "/dev/sda3". The 'store-directory-prefix' field contains #f or the store
298 ;; file name inside the 'store-device' as it is seen by GRUB, e.g. it would
299 ;; contain "/storefs" if the store is located in that subvolume of a btrfs
582cf925 300 ;; partition.
8e815c5b 301 (root-device boot-parameters-root-device)
f96752e3 302 (bootloader-name boot-parameters-bootloader-name)
a28cfee8
LC
303 (bootloader-menu-entries ;list of <menu-entry>
304 boot-parameters-bootloader-menu-entries)
8e815c5b
LC
305 (store-device boot-parameters-store-device)
306 (store-mount-point boot-parameters-store-mount-point)
582cf925 307 (store-directory-prefix boot-parameters-store-directory-prefix)
9d449b94 308 (locale boot-parameters-locale)
8e815c5b
LC
309 (kernel boot-parameters-kernel)
310 (kernel-arguments boot-parameters-kernel-arguments)
912b857e
JN
311 (initrd boot-parameters-initrd)
312 (multiboot-modules boot-parameters-multiboot-modules))
8e815c5b 313
90d23ed9
LC
314(define (ensure-not-/dev device)
315 "If DEVICE starts with a slash, return #f. This is meant to filter out
316Linux device names such as /dev/sda, and to preserve GRUB device names and
317file system labels."
318 (if (and (string? device) (string-prefix? "/" device))
319 #f
320 device))
321
8e815c5b
LC
322(define (read-boot-parameters port)
323 "Read boot parameters from PORT and return the corresponding
324<boot-parameters> object or #f if the format is unrecognized."
075681d3
LC
325 (define device-sexp->device
326 (match-lambda
327 (('uuid (? symbol? type) (? bytevector? bv))
328 (bytevector->uuid bv type))
a5acc17a
LC
329 (('file-system-label (? string? label))
330 (file-system-label label))
075681d3
LC
331 ((? bytevector? bv) ;old format
332 (bytevector->uuid bv 'dce))
333 ((? string? device)
1c3b709e
S
334 (if (string-contains device ":/")
335 device ; nfs-root
336 ;; It used to be that we would not distinguish between labels and
337 ;; device names. Try to infer the right thing here.
338 (if (string-prefix? "/" device)
339 device
340 (file-system-label device))))))
075681d3 341
8e815c5b
LC
342 (match (read port)
343 (('boot-parameters ('version 0)
344 ('label label) ('root-device root)
912b857e 345 ('kernel kernel)
8e815c5b
LC
346 rest ...)
347 (boot-parameters
348 (label label)
7940188e 349 (root-device (device-sexp->device root))
8e815c5b 350
f96752e3
MO
351 (bootloader-name
352 (match (assq 'bootloader-name rest)
bcaf67c4
MO
353 ((_ args) args)
354 (#f 'grub))) ; for compatibility reasons.
355
a28cfee8
LC
356 (bootloader-menu-entries
357 (match (assq 'bootloader-menu-entries rest)
358 ((_ entries) (map sexp->menu-entry entries))
359 (#f '())))
360
912b857e
JN
361 ;; In the past, we would store the directory name of linux instead of
362 ;; the absolute file name of its image. Detect that and correct it.
363 (kernel (if (string=? kernel (direct-store-path kernel))
364 (string-append kernel "/"
8e815c5b 365 (system-linux-image-file-name))
912b857e 366 kernel))
8e815c5b
LC
367
368 (kernel-arguments
369 (match (assq 'kernel-arguments rest)
370 ((_ args) args)
371 (#f '()))) ;the old format
372
373 (initrd
374 (match (assq 'initrd rest)
375 (('initrd ('string-append directory file)) ;the old format
376 (string-append directory file))
377 (('initrd (? string? file))
12906d3e
JN
378 file)
379 (#f #f)))
8e815c5b 380
aa864ebd
JN
381 (multiboot-modules
382 (match (assq 'multiboot-modules rest)
383 ((_ args) args)
384 (#f '())))
912b857e 385
9d449b94
MÁAV
386 (locale
387 (match (assq 'locale rest)
388 ((_ locale) locale)
389 (#f #f)))
390
8e815c5b 391 (store-device
db4e8fd5
LC
392 ;; Linux device names like "/dev/sda1" are not suitable GRUB device
393 ;; identifiers, so we just filter them out.
394 (ensure-not-/dev
395 (match (assq 'store rest)
396 (('store ('device #f) _ ...)
397 root-device)
398 (('store ('device device) _ ...)
399 (device-sexp->device device))
400 (_ ;the old format
401 root-device))))
8e815c5b 402
582cf925
MÁAV
403 (store-directory-prefix
404 (match (assq 'store rest)
405 (('store . store-data)
406 (match (assq 'directory-prefix store-data)
407 (('directory-prefix prefix) prefix)
408 ;; No directory-prefix found.
409 (_ #f)))
410 (_
411 ;; No store found, old format.
412 #f)))
413
8e815c5b
LC
414 (store-mount-point
415 (match (assq 'store rest)
416 (('store ('device _) ('mount-point mount-point) _ ...)
417 mount-point)
418 (_ ;the old format
419 "/")))))
420 (x ;unsupported format
b1059b38
LC
421 (warning (G_ "unrecognized boot parameters at '~a'~%")
422 (port-filename port))
8e815c5b
LC
423 #f)))
424
425(define (read-boot-parameters-file system)
426 "Read boot parameters from SYSTEM's (system or generation) \"parameters\"
427file and returns the corresponding <boot-parameters> object or #f if the
428format is unrecognized.
429The object has its kernel-arguments extended in order to make it bootable."
430 (let* ((file (string-append system "/parameters"))
431 (params (call-with-input-file file read-boot-parameters))
a7ef45d9
LC
432 (root (boot-parameters-root-device params)))
433 (boot-parameters
434 (inherit params)
435 (kernel-arguments (append (bootable-kernel-arguments system root)
436 (boot-parameters-kernel-arguments params))))))
8b22107e 437
1975c754 438(define (boot-parameters->menu-entry conf)
912b857e
JN
439 (let* ((kernel (boot-parameters-kernel conf))
440 (multiboot-modules (boot-parameters-multiboot-modules conf))
441 (multiboot? (pair? multiboot-modules)))
442 (menu-entry
443 (label (boot-parameters-label conf))
444 (device (boot-parameters-store-device conf))
445 (device-mount-point (boot-parameters-store-mount-point conf))
446 (linux (and (not multiboot?) kernel))
535a6be2 447 (linux-arguments (if (not multiboot?)
912b857e
JN
448 (boot-parameters-kernel-arguments conf)
449 '()))
450 (initrd (boot-parameters-initrd conf))
451 (multiboot-kernel (and multiboot? kernel))
452 (multiboot-arguments (if multiboot?
453 (boot-parameters-kernel-arguments conf)
454 '()))
455 (multiboot-modules (if multiboot?
456 (boot-parameters-multiboot-modules conf)
457 '())))))
8b22107e 458
8e815c5b 459\f
40281c54
LC
460;;;
461;;; Services.
462;;;
463
aa1145df
LC
464(define (non-boot-file-system-service os)
465 "Return the file system service for the file systems of OS that are not
466marked as 'needed-for-boot'."
023f391c 467 (define file-systems
4d6b879c 468 (remove file-system-needed-for-boot?
023f391c
LC
469 (operating-system-file-systems os)))
470
68a58775
LC
471 (define mapped-devices-for-boot
472 (operating-system-boot-mapped-devices os))
473
5dae0186 474 (define (device-mappings fs)
ab64483f 475 (let ((device (file-system-device fs)))
29824d80 476 (if (string? device) ;title is 'device
ab64483f 477 (filter (lambda (md)
788df2ec
MT
478 (any (cut string=? device <>)
479 (map (cut string-append "/dev/mapper" <>)
480 (mapped-device-targets md))))
ab64483f
LC
481 (operating-system-mapped-devices os))
482 '())))
5dae0186 483
e502bf89
LC
484 (define (add-dependencies fs)
485 ;; Add the dependencies due to device mappings to FS.
486 (file-system
487 (inherit fs)
488 (dependencies
68a58775
LC
489 (delete-duplicates
490 (remove (cut member <> mapped-devices-for-boot)
491 (append (device-mappings fs)
492 (file-system-dependencies fs)))
493 eq?))))
e502bf89 494
aa1145df
LC
495 (service file-system-service-type
496 (map add-dependencies file-systems)))
023f391c 497
68a58775
LC
498(define (mapped-device-users device file-systems)
499 "Return the subset of FILE-SYSTEMS that use DEVICE."
788df2ec
MT
500 (let ((targets (map (cut string-append "/dev/mapper/" <>)
501 (mapped-device-targets device))))
68a58775
LC
502 (filter (lambda (fs)
503 (or (member device (file-system-dependencies fs))
504 (and (string? (file-system-device fs))
788df2ec 505 (any (cut string=? (file-system-device fs) <>) targets))))
68a58775 506 file-systems)))
de1c158f
LC
507
508(define (operating-system-user-mapped-devices os)
509 "Return the subset of mapped devices that can be installed in
510user-land--i.e., those not needed during boot."
9cb426b8
LC
511 (let ((devices (operating-system-mapped-devices os))
512 (file-systems (operating-system-file-systems os)))
513 (filter (lambda (md)
68a58775
LC
514 (let ((users (mapped-device-users md file-systems)))
515 (not (any file-system-needed-for-boot? users))))
9cb426b8 516 devices)))
de1c158f
LC
517
518(define (operating-system-boot-mapped-devices os)
519 "Return the subset of mapped devices that must be installed during boot,
520from the initrd."
9cb426b8
LC
521 (let ((devices (operating-system-mapped-devices os))
522 (file-systems (operating-system-file-systems os)))
523 (filter (lambda (md)
68a58775
LC
524 (let ((users (mapped-device-users md file-systems)))
525 (any file-system-needed-for-boot? users)))
9cb426b8 526 devices)))
de1c158f 527
5dae0186 528(define (device-mapping-services os)
be1c2c54 529 "Return the list of device-mapping services for OS as a list."
4da8c19e 530 (map device-mapping-service
be1c2c54 531 (operating-system-user-mapped-devices os)))
5dae0186 532
2a13d05e 533(define (swap-services os)
be1c2c54
LC
534 "Return the list of swap services for OS."
535 (map swap-service (operating-system-swap-devices os)))
2a13d05e 536
0c053a39
LC
537(define* (system-linux-image-file-name #:optional
538 (target (or (%current-target-system)
539 (%current-system))))
540 "Return the basename of the kernel image file for TARGET."
541 (cond
542 ((string-prefix? "arm" target) "zImage")
543 ((string-prefix? "mips" target) "vmlinuz")
544 ((string-prefix? "aarch64" target) "Image")
545 (else "bzImage")))
44d5f54e
LC
546
547(define (operating-system-kernel-file os)
548 "Return an object representing the absolute file name of the kernel image of
549OS."
912b857e
JN
550 (if (operating-system-hurd os)
551 (file-append (operating-system-kernel os) "/boot/gnumach")
552 (file-append (operating-system-kernel os)
553 "/" (system-linux-image-file-name))))
44d5f54e 554
f91ad0b1
DM
555(define (package-for-kernel target-kernel module-package)
556 "Return a package like MODULE-PACKAGE, adapted for TARGET-KERNEL, if
557possible (that is if there's a LINUX keyword argument in the build system)."
558 (package
559 (inherit module-package)
560 (arguments
561 (substitute-keyword-arguments (package-arguments module-package)
562 ((#:linux kernel #f)
563 target-kernel)))))
564
e06664da
FP
565(define %default-modprobe-blacklist
566 ;; List of kernel modules to blacklist by default.
fd31731b
FP
567 '("usbmouse" ;races with bcm5974, see <https://bugs.gnu.org/35574>
568 "usbkbd")) ;races with usbhid, see <https://issues.guix.gnu.org/35574#18>
e06664da
FP
569
570(define %default-kernel-arguments
571 ;; Default arguments passed to the kernel.
572 (list (string-append "modprobe.blacklist="
573 (string-join %default-modprobe-blacklist ","))
574 "quiet"))
575
69cae3d3 576(define* (operating-system-directory-base-entries os)
d62e201c
LC
577 "Return the basic entries of the 'system' directory of OS for use as the
578value of the SYSTEM-SERVICE-TYPE service."
cda75110
LC
579 (let* ((locale (operating-system-locale-directory os))
580 (kernel (operating-system-kernel os))
2b76179e 581 (hurd (operating-system-hurd os))
cda75110 582 (modules (operating-system-kernel-loadable-modules os))
2b76179e
JN
583 (kernel (if hurd
584 kernel
585 (profile
586 (content (packages->manifest
587 (cons kernel
588 (map (lambda (module)
589 (if (package? module)
590 (package-for-kernel kernel
591 module)
592 module))
593 modules))))
594 (hooks (list linux-module-database)))))
595 (initrd (and (not hurd) (operating-system-initrd-file os)))
cda75110 596 (params (operating-system-boot-parameters-file os)))
0e5c2d5e 597 `(("kernel" ,kernel)
2b76179e 598 ,@(if hurd `(("hurd" ,hurd)) '())
0e5c2d5e 599 ("parameters" ,params)
2b76179e 600 ,@(if initrd `(("initrd" ,initrd)) '())
0e5c2d5e 601 ("locale" ,locale)))) ;used by libc
69cae3d3 602
f8885eca 603(define (operating-system-default-essential-services os)
217a5b85
LC
604 "Return the list of essential services for OS. These are special services
605that implement part of what's declared in OS are responsible for low-level
69cae3d3 606bookkeeping."
d6e2a622
LC
607 (define known-fs
608 (map file-system-mount-point (operating-system-file-systems os)))
609
be1c2c54
LC
610 (let* ((mappings (device-mapping-services os))
611 (root-fs (root-file-system-service))
aa1145df 612 (other-fs (non-boot-file-system-service os))
be1c2c54 613 (swaps (swap-services os))
206a28d8 614 (procs (service user-processes-service-type))
d62e201c 615 (host-name (host-name-service (operating-system-host-name os)))
69cae3d3 616 (entries (operating-system-directory-base-entries os)))
d62e201c
LC
617 (cons* (service system-service-type entries)
618 %boot-service
0adfe95a 619
661c237b 620 ;; %SHEPHERD-ROOT-SERVICE must come last so that the gexp that
d4053c71 621 ;; execs shepherd comes last in the boot script (XXX). Likewise,
661c237b 622 ;; the cleanup service must come first so that its gexp runs before
d4053c71 623 ;; activation code.
be7be9e8 624 (service cleanup-service-type #f)
661c237b
LC
625 %activation-service
626 %shepherd-root-service
0adfe95a
LC
627
628 (pam-root-service (operating-system-pam-services os))
629 (account-service (append (operating-system-accounts os)
630 (operating-system-groups os))
631 (operating-system-skeletons os))
632 (operating-system-etc-service os)
aea1a42e
LC
633 (service fstab-service-type
634 (filter file-system-needed-for-boot?
635 (operating-system-file-systems os)))
6bad7524
SB
636 (session-environment-service
637 (operating-system-environment-variables os))
6c445817 638 host-name procs root-fs
0adfe95a
LC
639 (service setuid-program-service-type
640 (operating-system-setuid-programs os))
af4c3fd5
LC
641 (service profile-service-type
642 (operating-system-packages os))
aa1145df
LC
643 other-fs
644 (append mappings swaps
0adfe95a 645
69cae3d3
LC
646 ;; Add the firmware service.
647 (list %linux-bare-metal-service
648 (service firmware-service-type
649 (operating-system-firmware os)))))))
650
45b2cb43 651(define (hurd-default-essential-services os)
2b76179e
JN
652 (let ((entries (operating-system-directory-base-entries os)))
653 (list (service system-service-type entries)
654 %boot-service
655 %hurd-startup-service
656 %activation-service
657 %shepherd-root-service
658 (service user-processes-service-type)
659 (account-service (append (operating-system-accounts os)
660 (operating-system-groups os))
661 (operating-system-skeletons os))
662 (root-file-system-service)
663 (service file-system-service-type '())
664 (service fstab-service-type
665 (filter file-system-needed-for-boot?
666 (operating-system-file-systems os)))
667 (pam-root-service (operating-system-pam-services os))
668 (operating-system-etc-service os)
16f8ea06
JN
669 (service setuid-program-service-type
670 (operating-system-setuid-programs os))
2b76179e 671 (service profile-service-type (operating-system-packages os)))))
45b2cb43 672
69cae3d3
LC
673(define* (operating-system-services os)
674 "Return all the services of OS, including \"essential\" services."
d466b1fc
LC
675 (instantiate-missing-services
676 (append (operating-system-user-services os)
69cae3d3 677 (operating-system-essential-services os))))
217a5b85 678
9fcfe30d
LC
679(define (operating-system-with-gc-roots os roots)
680 "Return a variant of OS where ROOTS are registered as GC roots."
681 (operating-system
682 (inherit os)
683
684 ;; We use this procedure for the installation OS, which already defines GC
685 ;; roots. Add ROOTS to those.
686 (services (cons (simple-service 'extra-root
687 gc-root-service-type roots)
688 (operating-system-user-services os)))))
689
12a3d7d6
LC
690(define (operating-system-configuration-file os)
691 "Return the configuration file of OS, based on its 'location' field, or #f
692if it could not be determined."
693 (let ((file (and=> (operating-system-location os)
694 location-file)))
695 (and file
696 (or (and (string-prefix? "/" file) file)
697 (search-path %load-path file)))))
698
699(define* (operating-system-with-provenance os
700 #:optional
701 (config-file
702 (operating-system-configuration-file
703 os)))
33b7cb7a
LC
704 "Return a variant of OS that stores its own provenance information,
705including CONFIG-FILE, if available. This is achieved by adding an instance
706of PROVENANCE-SERVICE-TYPE to its services."
707 (operating-system
708 (inherit os)
709 (services (cons (service provenance-service-type config-file)
710 (operating-system-user-services os)))))
711
40281c54
LC
712\f
713;;;
714;;; /etc.
715;;;
716
f34c56be
LC
717(define %base-firmware
718 ;; Firmware usable by default.
52db41af
EB
719 (list ath9k-htc-firmware
720 openfwwf-firmware))
f34c56be 721
93664fee
BW
722(define %base-packages-utils
723 ;; Default set of utilities packages.
724 (cons* procps psmisc which
725 (@ (gnu packages admin) shadow) ;for 'passwd'
726
275b37e8 727 guile-3.0-latest
93664fee
BW
728
729 ;; The packages below are also in %FINAL-INPUTS, so take them from
730 ;; there to avoid duplication.
030f6f48
MB
731 (list bash coreutils findutils grep sed
732 diffutils patch gawk tar gzip bzip2 xz lzip)))
93664fee
BW
733
734(define %base-packages-linux
735 ;; Default set of linux specific packages.
736 (list pciutils usbutils
737 util-linux+udev
738 ;; Get 'insmod' & co. from kmod, not module-init-tools, since udev
739 ;; already depends on it anyway.
740 kmod eudev))
741
742(define %base-packages-interactive
743 ;; Default set of common interactive packages.
744 (list less zile nano
4170af49 745 nvi
93664fee
BW
746 man-db
747 info-reader ;the standalone Info reader (no Perl)
748 bash-completion
749 kbd
750 ;; The 'sudo' command is already in %SETUID-PROGRAMS, but we also
751 ;; want the other commands and the man pages (notably because
752 ;; auto-completion in Emacs shell relies on man pages.)
753 sudo
754 guile-readline guile-colorized))
755
756(define %base-packages-networking
757 ;; Default set of networking packages.
758 (list inetutils isc-dhcp
759 iproute
760 ;; wireless-tools is deprecated in favor of iw, but it's still what
761 ;; many people are familiar with, so keep it around.
762 iw wireless-tools))
763
e6e07628
EF
764(define %base-packages-disk-utilities
765 ;; A well-rounded set of packages for interacting with disks, partitions
766 ;; and filesystems.
767 (list parted gptfdisk ddrescue
768 ;; We used to provide fdisk from GNU fdisk, but as of version 2.0.0a
769 ;; it pulls Guile 1.8, which takes unreasonable space; furthermore
770 ;; util-linux's fdisk is already available, in %base-packages-linux.
771 cryptsetup mdadm
772 dosfstools
773 btrfs-progs
774 f2fs-tools
775 jfsutils))
776
6f436c54
LC
777(define %base-packages
778 ;; Default set of packages globally visible. It should include anything
779 ;; required for basic administrator tasks.
93664fee
BW
780 (append (list e2fsprogs)
781 %base-packages-interactive
782 %base-packages-linux
783 %base-packages-networking
784 %base-packages-utils))
6f436c54 785
548d4c13
LC
786(define %default-issue
787 ;; Default contents for /etc/issue.
788 "
789This is the GNU system. Welcome.\n")
790
568841d4
LC
791(define (local-host-aliases host-name)
792 "Return aliases for HOST-NAME, to be used in /etc/hosts."
793 (string-append "127.0.0.1 localhost " host-name "\n"
794 "::1 localhost " host-name "\n"))
795
c65e1834
LC
796(define (default-/etc/hosts host-name)
797 "Return the default /etc/hosts file."
24e02c28 798 (plain-file "hosts" (local-host-aliases host-name)))
c65e1834 799
38437763
LC
800(define (validated-sudoers-file file)
801 "Return a copy of FILE, a sudoers file, after checking that it is
802syntactically correct."
803 (computed-file "sudoers"
804 (with-imported-modules '((guix build utils))
805 #~(begin
806 (use-modules (guix build utils))
807
808 (invoke #+(file-append sudo "/sbin/visudo")
809 "--check" "--file" #$file)
810 (copy-file #$file #$output)))))
811
0adfe95a
LC
812(define* (operating-system-etc-service os)
813 "Return a <service> that builds containing the static part of the /etc
814directory."
f5ca79d2 815 (let* ((login.defs
e453da13
LF
816 (plain-file "login.defs"
817 (string-append
818 "# Default paths for non-login shells started by su(1).\n"
819 "ENV_PATH /run/setuid-programs:"
820 "/run/current-system/profile/bin:"
821 "/run/current-system/profile/sbin\n"
822 "ENV_SUPATH /run/setuid-programs:"
823 "/run/current-system/profile/bin:"
824 "/run/current-system/profile/sbin\n")))
0adfe95a 825
f5ca79d2
JN
826 (hurd (operating-system-hurd os))
827 (issue (plain-file "issue" (operating-system-issue os)))
828 (nsswitch (operating-system-name-service-switch os))
829 (nsswitch (and nsswitch
830 (plain-file "nsswitch.conf"
831 (name-service-switch->string nsswitch))))
832 (sudoers (operating-system-sudoers-file os))
0adfe95a
LC
833
834 ;; Startup file for POSIX-compliant login shells, which set system-wide
835 ;; environment variables.
836 (profile (mixed-text-file "profile" "\
c05c4321 837# Crucial variables that could be missing in the profiles' 'etc/profile'
d9959421
LC
838# because they would require combining both profiles.
839# FIXME: See <http://bugs.gnu.org/20255>.
97ab2c0f 840export MANPATH=$HOME/.guix-profile/share/man:/run/current-system/profile/share/man
8d09bfe2 841export INFOPATH=$HOME/.guix-profile/share/info:/run/current-system/profile/share/info
00239d05
SB
842export XDG_DATA_DIRS=$HOME/.guix-profile/share:/run/current-system/profile/share
843export XDG_CONFIG_DIRS=$HOME/.guix-profile/etc/xdg:/run/current-system/profile/etc/xdg
844
ce380150
TD
845# Make sure libXcursor finds cursors installed into user or system profiles. See <http://bugs.gnu.org/24445>
846export XCURSOR_PATH=$HOME/.icons:$HOME/.guix-profile/share/icons:/run/current-system/profile/share/icons
847
d9959421
LC
848# Ignore the default value of 'PATH'.
849unset PATH
850
851# Load the system profile's settings.
bd7e136d 852GUIX_PROFILE=/run/current-system/profile ; \\
669786da 853. /run/current-system/profile/etc/profile
d9959421 854
cad7e6ab
CSLL
855# Since 'lshd' does not use pam_env, /etc/environment must be explicitly
856# loaded when someone logs in via SSH. See <http://bugs.gnu.org/22175>.
857# We need 'PATH' to be defined here, for 'cat' and 'cut'. Do this before
858# reading the user's 'etc/profile' to allow variables to be overridden.
859if [ -f /etc/environment -a -n \"$SSH_CLIENT\" \\
860 -a -z \"$LINUX_MODULE_DIRECTORY\" ]
861then
862 . /etc/environment
863 export `cat /etc/environment | cut -d= -f1`
864fi
865
8d09bfe2
LC
866# Arrange so that ~/.config/guix/current comes first.
867for profile in \"$HOME/.guix-profile\" \"$HOME/.config/guix/current\"
cdc5b932
LC
868do
869 if [ -f \"$profile/etc/profile\" ]
870 then
871 # Load the user profile's settings.
872 GUIX_PROFILE=\"$profile\" ; \\
873 . \"$profile/etc/profile\"
874 else
875 # At least define this one so that basic things just work
876 # when the user installs their first package.
877 export PATH=\"$profile/bin:$PATH\"
878 fi
879done
d9959421 880
a854525a
LC
881# Prepend setuid programs.
882export PATH=/run/setuid-programs:$PATH
883
8d09bfe2
LC
884# Arrange so that ~/.config/guix/current/share/info comes first.
885export INFOPATH=\"$HOME/.config/guix/current/share/info:$INFOPATH\"
886
11202482
LC
887# Set the umask, notably for users logging in via 'lsh'.
888# See <http://bugs.gnu.org/22650>.
889umask 022
2a5f0db4 890
c08da2ee
LC
891# Allow Hunspell-based applications (IceCat, LibreOffice, etc.) to
892# find dictionaries.
893export DICPATH=\"$HOME/.guix-profile/share/hunspell:/run/current-system/profile/share/hunspell\"
894
4af7c83b
LC
895# Allow GStreamer-based applications to find plugins.
896export GST_PLUGIN_PATH=\"$HOME/.guix-profile/lib/gstreamer-1.0\"
897
1d167b6e
LC
898if [ -n \"$BASH_VERSION\" -a -f /etc/bashrc ]
899then
900 # Load Bash-specific initialization code.
669786da 901 . /etc/bashrc
1d167b6e 902fi
40281c54 903"))
1d167b6e 904
0adfe95a 905 (bashrc (plain-file "bashrc" "\
1d167b6e
LC
906# Bash-specific initialization.
907
908# The 'bash-completion' package.
909if [ -f /run/current-system/profile/etc/profile.d/bash_completion.sh ]
910then
911 # Bash-completion sources ~/.bash_completion. It installs a dynamic
912 # completion loader that searches its own completion files as well
913 # as those in ~/.guix-profile and /run/current-system/profile.
914 source /run/current-system/profile/etc/profile.d/bash_completion.sh
0adfe95a
LC
915fi\n")))
916 (etc-service
9e41130b
LC
917 `(("services" ,(file-append net-base "/etc/services"))
918 ("protocols" ,(file-append net-base "/etc/protocols"))
919 ("rpc" ,(file-append net-base "/etc/rpc"))
0adfe95a
LC
920 ("login.defs" ,#~#$login.defs)
921 ("issue" ,#~#$issue)
f5ca79d2 922 ,@(if nsswitch `(("nsswitch.conf" ,#~#$nsswitch)) '())
0adfe95a
LC
923 ("profile" ,#~#$profile)
924 ("bashrc" ,#~#$bashrc)
925 ("hosts" ,#~#$(or (operating-system-hosts-file os)
926 (default-/etc/hosts (operating-system-host-name os))))
c694520b
TD
927 ;; Write the operating-system-host-name to /etc/hostname to prevent
928 ;; NetworkManager from changing the system's hostname when connecting
929 ;; to certain networks. Some discussion at
930 ;; https://lists.gnu.org/archive/html/help-guix/2017-09/msg00037.html
931 ("hostname" ,(plain-file "hostname" (operating-system-host-name os)))
2a80d9e5
TS
932 ;; Some programs (e.g., GLib) look at /etc/timezone to find the
933 ;; name of the current timezone. For details, see
934 ;; https://lists.gnu.org/archive/html/guix-devel/2019-07/msg00166.html
935 ("timezone" ,(plain-file "timezone" (operating-system-timezone os)))
9e41130b
LC
936 ("localtime" ,(file-append tzdata "/share/zoneinfo/"
937 (operating-system-timezone os)))
38437763
LC
938 ,@(if sudoers
939 `(("sudoers" ,(validated-sudoers-file sudoers)))
940 '())
f5ca79d2
JN
941 ,@(if hurd
942 `(("login" ,(file-append hurd "/etc/login"))
5681ce50
JN
943 ("motd" ,(file-append hurd "/etc/motd"))
944 ("ttys" ,(file-append hurd "/etc/ttys")))
f5ca79d2 945 '())))))
033adfe7 946
ab6a279a
LC
947(define %root-account
948 ;; Default root account.
949 (user-account
950 (name "root")
951 (password "")
952 (uid 0) (group "root")
953 (comment "System administrator")
954 (home-directory "/root")))
955
0b6f49ef 956(define (operating-system-accounts os)
0adfe95a
LC
957 "Return the user accounts for OS, including an obligatory 'root' account,
958and excluding accounts requested by services."
959 ;; Make sure there's a root account.
960 (if (find (lambda (user)
961 (and=> (user-account-uid user) zero?))
962 (operating-system-users os))
963 (operating-system-users os)
964 (cons %root-account (operating-system-users os))))
0b6f49ef 965
84765839
LC
966(define (maybe-string->file file-name thing)
967 "If THING is a string, return a <plain-file> with THING as its content.
968Otherwise just return THING.
969
970This is for backward-compatibility of fields that used to be strings and are
971now file-like objects.."
972 (match thing
973 ((? string?)
69daee23 974 (warning (G_ "using a string for file '~a' is deprecated; \
84765839
LC
975use 'plain-file' instead~%")
976 file-name)
977 (plain-file file-name thing))
978 (x
979 x)))
980
24e02c28
LC
981(define (maybe-file->monadic file-name thing)
982 "If THING is a value in %STORE-MONAD, return it as is; otherwise return
983THING in the %STORE-MONAD.
984
985This is for backward-compatibility of fields that used to be monadic values
986and are now file-like objects."
987 (with-monad %store-monad
988 (match thing
989 ((? procedure?)
69daee23 990 (warning (G_ "using a monadic value for '~a' is deprecated; \
24e02c28
LC
991use 'plain-file' instead~%")
992 file-name)
993 thing)
994 (x
995 (return x)))))
996
0b6f49ef
LC
997(define (operating-system-etc-directory os)
998 "Return that static part of the /etc directory of OS."
0adfe95a
LC
999 (etc-directory
1000 (fold-services (operating-system-services os)
1001 #:target-type etc-service-type)))
033adfe7 1002
6bad7524
SB
1003(define (operating-system-environment-variables os)
1004 "Return the environment variables of OS for
1005@var{session-environment-service-type}, to be used in @file{/etc/environment}."
1006 `(("LANG" . ,(operating-system-locale os))
54757499
LC
1007 ;; Note: No need to set 'TZ' since (1) we provide /etc/localtime, and (2)
1008 ;; it doesn't work for setuid binaries. See <https://bugs.gnu.org/29212>.
9e41130b 1009 ("TZDIR" . ,(file-append tzdata "/share/zoneinfo"))
6bad7524
SB
1010 ;; Tell 'modprobe' & co. where to look for modules.
1011 ("LINUX_MODULE_DIRECTORY" . "/run/booted-system/kernel/lib/modules")
1012 ;; These variables are honored by OpenSSL (libssl) and Git.
1013 ("SSL_CERT_DIR" . "/etc/ssl/certs")
1014 ("SSL_CERT_FILE" . "/etc/ssl/certs/ca-certificates.crt")
1015 ("GIT_SSL_CAINFO" . "/etc/ssl/certs/ca-certificates.crt")
ae05e366
LC
1016
1017 ;; 'GTK_DATA_PREFIX' must name one directory where GTK+ themes are
1018 ;; searched for.
1019 ("GTK_DATA_PREFIX" . "/run/current-system/profile")
1020
6bad7524
SB
1021 ;; By default, applications that use D-Bus, such as Emacs, abort at startup
1022 ;; when /etc/machine-id is missing. Make sure these warnings are non-fatal.
946465bb
LC
1023 ("DBUS_FATAL_WARNINGS" . "0")
1024
1025 ;; XXX: Normally we wouldn't need to do this, but our glibc@2.23 package
1026 ;; used to look things up in 'PREFIX/lib/locale' instead of
1027 ;; '/run/current-system/locale' as was intended. Keep this hack around so
1028 ;; that people who still have glibc@2.23-using packages in their profiles
1029 ;; can use them correctly.
1030 ;; TODO: Remove when glibc@2.23 is long gone.
1031 ("GUIX_LOCPATH" . "/run/current-system/locale")))
6bad7524 1032
09e028f4
LC
1033(define %setuid-programs
1034 ;; Default set of setuid-root programs.
3b65abac 1035 (let ((shadow (@ (gnu packages admin) shadow)))
9e41130b 1036 (list (file-append shadow "/bin/passwd")
f6c6970e 1037 (file-append shadow "/bin/sg")
9e41130b 1038 (file-append shadow "/bin/su")
f6c6970e 1039 (file-append shadow "/bin/newgrp")
852241eb
SB
1040 (file-append shadow "/bin/newuidmap")
1041 (file-append shadow "/bin/newgidmap")
9e41130b
LC
1042 (file-append inetutils "/bin/ping")
1043 (file-append inetutils "/bin/ping6")
1044 (file-append sudo "/bin/sudo")
5144df2c 1045 (file-append sudo "/bin/sudoedit")
19944227
LC
1046 (file-append fuse "/bin/fusermount")
1047
1048 ;; To allow mounts with the "user" option, "mount" and "umount" must
1049 ;; be setuid-root.
1050 (file-append util-linux "/bin/mount")
1051 (file-append util-linux "/bin/umount"))))
69689380
LC
1052
1053(define %sudoers-specification
1054 ;; Default /etc/sudoers contents: 'root' and all members of the 'wheel'
1055 ;; group can do anything. See
1056 ;; <http://www.sudo.ws/sudo/man/1.8.10/sudoers.man.html>.
1057 ;; TODO: Add a declarative API.
84765839
LC
1058 (plain-file "sudoers" "\
1059root ALL=(ALL) ALL
1060%wheel ALL=(ALL) ALL\n"))
09e028f4 1061
69cae3d3 1062(define* (operating-system-activation-script os)
484a2b3a
LC
1063 "Return the activation script for OS---i.e., the code that \"activates\" the
1064stateful part of OS, including user accounts and groups, special directories,
1065etc."
69cae3d3 1066 (let* ((services (operating-system-services os))
0adfe95a
LC
1067 (activation (fold-services services
1068 #:target-type activation-service-type)))
1069 (activation-service->script activation)))
484a2b3a 1070
69cae3d3 1071(define* (operating-system-boot-script os)
484a2b3a 1072 "Return the boot script for OS---i.e., the code started by the initrd once
69cae3d3
LC
1073we're running in the final root."
1074 (let* ((services (operating-system-services os))
d62e201c 1075 (boot (fold-services services #:target-type boot-service-type)))
efe7d19a 1076 (service-value boot)))
2106d3fc 1077
b2fef041
LC
1078(define (operating-system-user-accounts os)
1079 "Return the list of user accounts of OS."
1080 (let* ((services (operating-system-services os))
1081 (account (fold-services services
1082 #:target-type account-service-type)))
1083 (filter user-account?
efe7d19a 1084 (service-value account))))
b2fef041
LC
1085
1086(define (operating-system-shepherd-service-names os)
1087 "Return the list of Shepherd service names for OS."
1088 (append-map shepherd-service-provision
efe7d19a 1089 (service-value
b2fef041
LC
1090 (fold-services (operating-system-services os)
1091 #:target-type
1092 shepherd-root-service-type))))
1093
69cae3d3 1094(define* (operating-system-derivation os)
d62e201c 1095 "Return a derivation that builds OS."
69cae3d3 1096 (let* ((services (operating-system-services os))
d62e201c
LC
1097 (system (fold-services services)))
1098 ;; SYSTEM contains the derivation as a monadic value.
efe7d19a 1099 (service-value system)))
d62e201c 1100
69cae3d3 1101(define* (operating-system-profile os)
af4c3fd5
LC
1102 "Return a derivation that builds the system profile of OS."
1103 (mlet* %store-monad
69cae3d3 1104 ((services -> (operating-system-services os))
af4c3fd5
LC
1105 (profile (fold-services services
1106 #:target-type profile-service-type)))
1107 (match profile
1108 (("profile" profile)
1109 (return profile)))))
1110
83bcd0b8
LC
1111(define (operating-system-root-file-system os)
1112 "Return the root file system of OS."
d7e9e0bb
LC
1113 (or (find (lambda (fs)
1114 (string=? "/" (file-system-mount-point fs)))
1115 (operating-system-file-systems os))
1116 (raise (condition
1117 (&message (message "missing root file system"))
1118 (&error-location
1119 (location (operating-system-location os)))))))
83bcd0b8 1120
b4140694
LC
1121(define (operating-system-initrd-file os)
1122 "Return a gexp denoting the initrd file of OS."
83bcd0b8 1123 (define boot-file-systems
4d6b879c 1124 (filter file-system-needed-for-boot?
83bcd0b8
LC
1125 (operating-system-file-systems os)))
1126
de1c158f
LC
1127 (define mapped-devices
1128 (operating-system-boot-mapped-devices os))
1129
1130 (define make-initrd
1131 (operating-system-initrd os))
1132
d422cbb3
LC
1133 (make-initrd boot-file-systems
1134 #:linux (operating-system-kernel os)
1135 #:linux-modules
1136 (operating-system-initrd-modules os)
ae7a316b
LC
1137 #:mapped-devices mapped-devices
1138 #:keyboard-layout (operating-system-keyboard-layout os)))
b4140694 1139
78fbf2bd
MO
1140(define* (operating-system-uuid os #:optional (type 'dce))
1141 "Compute UUID object with a deterministic \"UUID\" for OS, of the given
1142TYPE (one of 'iso9660 or 'dce). Return a UUID object."
1143 ;; Note: For this to be deterministic, we must not hash things that contains
1144 ;; (directly or indirectly) procedures, for example. That rules out
1145 ;; anything that contains gexps, thunk or delayed record fields, etc.
1146
1147 (define service-name
1148 (compose service-type-name service-kind))
1149
1150 (define (file-system-digest fs)
1151 ;; Return a hashable digest that does not contain 'dependencies' since
1152 ;; this field can contain procedures.
1153 (let ((device (file-system-device fs)))
1154 (list (file-system-mount-point fs)
1155 (file-system-type fs)
1156 (file-system-device->string device)
1157 (file-system-options fs))))
1158
1159 (if (eq? type 'iso9660)
1160 (let ((pad (compose (cut string-pad <> 2 #\0)
1161 number->string))
1162 (h (hash (map service-name (operating-system-services os))
1163 3600)))
1164 (bytevector->uuid
1165 (string->iso9660-uuid
1166 (string-append "1970-01-01-"
1167 (pad (hash (operating-system-host-name os) 24)) "-"
1168 (pad (quotient h 60)) "-"
1169 (pad (modulo h 60)) "-"
1170 (pad (hash (map file-system-digest
1171 (operating-system-file-systems os))
1172 100))))
1173 'iso9660))
1174 (bytevector->uuid
1175 (uint-list->bytevector
1176 (list (hash (map file-system-digest
1177 (operating-system-file-systems os))
1178 (- (expt 2 32) 1))
1179 (hash (operating-system-host-name os)
1180 (- (expt 2 32) 1))
1181 (hash (map service-name (operating-system-services os))
1182 (- (expt 2 32) 1))
1183 (hash (map file-system-digest (operating-system-file-systems os))
1184 (- (expt 2 32) 1)))
1185 (endianness little)
1186 4)
1187 type)))
1188
f5582b2c
LC
1189(define (locale-name->definition* name)
1190 "Variant of 'locale-name->definition' that raises an error upon failure."
1191 (match (locale-name->definition name)
1192 (#f
d51bfe24 1193 (raise (formatted-message (G_ "~a: invalid locale name") name)))
f5582b2c
LC
1194 (def def)))
1195
598e19dc
LC
1196(define (operating-system-locale-directory os)
1197 "Return the directory containing the locales compiled for the definitions
1198listed in OS. The C library expects to find it under
1199/run/current-system/locale."
f5582b2c
LC
1200 (define name
1201 (operating-system-locale os))
1202
1203 (define definitions
1204 ;; While we're at it, check whether NAME is defined and add it if needed.
1205 (if (member name (map locale-definition-name
1206 (operating-system-locale-definitions os)))
1207 (operating-system-locale-definitions os)
1208 (cons (locale-name->definition* name)
1209 (operating-system-locale-definitions os))))
1210
1211 (locale-directory definitions
34760ae7 1212 #:libcs (operating-system-locale-libcs os)))
598e19dc 1213
e6cd8581 1214(define* (kernel->boot-label kernel #:key hurd)
c2e9942b 1215 "Return a label for the bootloader menu entry that boots KERNEL."
e6cd8581
JN
1216 (cond ((package? hurd)
1217 (string-append "GNU with the "
1218 (string-titlecase (package-name hurd)) " "
1219 (package-version hurd)))
1220 ((package? kernel)
bdc61ff9
P
1221 (string-append "GNU with "
1222 (string-titlecase (package-name kernel)) " "
4ce3a326 1223 (package-version kernel)))
bdc61ff9
P
1224 ((inferior-package? kernel)
1225 (string-append "GNU with "
b12f8720 1226 (string-titlecase (inferior-package-name kernel)) " "
4ce3a326 1227 (inferior-package-version kernel)))
bdc61ff9 1228 (else "GNU")))
2d23e6f0 1229
3f03a198
LC
1230(define (operating-system-default-label os)
1231 "Return the default label for OS, as it will appear in the bootloader menu
1232entry."
e6cd8581
JN
1233 (kernel->boot-label (operating-system-kernel os)
1234 #:hurd (operating-system-hurd os)))
3f03a198 1235
6b779207
LC
1236(define (store-file-system file-systems)
1237 "Return the file system object among FILE-SYSTEMS that contains the store."
1238 (match (filter (lambda (fs)
1239 (and (file-system-mount? fs)
1240 (not (memq 'bind-mount (file-system-flags fs)))
1241 (string-prefix? (file-system-mount-point fs)
1242 (%store-prefix))))
1243 file-systems)
1244 ((and candidates (head . tail))
1245 (reduce (lambda (fs1 fs2)
1246 (if (> (string-length (file-system-mount-point fs1))
1247 (string-length (file-system-mount-point fs2)))
1248 fs1
1249 fs2))
1250 head
1251 candidates))))
1252
1253(define (operating-system-store-file-system os)
1254 "Return the file system that contains the store of OS."
1255 (store-file-system (operating-system-file-systems os)))
1256
c76b3046 1257(define* (operating-system-bootcfg os #:optional (old-entries '()))
5ece56dc
LC
1258 "Return the bootloader configuration file for OS. Use OLD-ENTRIES,
1259a list of <menu-entry>, to populate the \"old entries\" menu."
b460ba79
MC
1260 (let* ((file-systems (operating-system-file-systems os))
1261 (root-fs (operating-system-root-file-system os))
9782c822 1262 (root-device (file-system-device root-fs))
eaf09639 1263 (locale (operating-system-locale os))
9782c822
LC
1264 (params (operating-system-boot-parameters
1265 os root-device
1266 #:system-kernel-arguments? #t))
1267 (entry (boot-parameters->menu-entry params))
1268 (bootloader-conf (operating-system-bootloader os)))
b460ba79 1269
46c296dc
LC
1270 (define generate-config-file
1271 (bootloader-configuration-file-generator
1272 (bootloader-configuration-bootloader bootloader-conf)))
1273
9782c822 1274 (generate-config-file bootloader-conf (list entry)
b460ba79 1275 #:old-entries old-entries
eaf09639 1276 #:locale locale
e7b86a0d 1277 #:store-directory-prefix
b460ba79 1278 (btrfs-store-subvolume-file-name file-systems))))
b4140694 1279
912b857e
JN
1280(define (operating-system-multiboot-modules os)
1281 (if (operating-system-hurd os) (hurd-multiboot-modules os) '()))
1282
1283(define (hurd-multiboot-modules os)
1284 (let* ((hurd (operating-system-hurd os))
1285 (root-file-system-command
1286 (list (file-append hurd "/hurd/ext2fs.static")
1287 "ext2fs"
1288 "--multiboot-command-line='${kernel-command-line}'"
1289 "--host-priv-port='${host-port}'"
1290 "--device-master-port='${device-port}'"
1291 "--exec-server-task='${exec-task}'"
1292 "--store-type=typed"
f25e8f76 1293 "--x-xattr-translator-records"
912b857e
JN
1294 "'${root}'" "'$(task-create)'" "'$(task-resume)'"))
1295 (target (%current-target-system))
1296 (libc (if target
1297 (with-parameters ((%current-target-system #f))
1298 ;; TODO: cross-libc has extra patches for the Hurd;
1299 ;; remove in next rebuild cycle
1300 (cross-libc target))
1301 glibc))
1302 (exec-server-command
1303 (list (file-append libc "/lib/ld.so.1") "exec"
1304 (file-append hurd "/hurd/exec") "'$(exec-task=task-create)'")))
1305 (list root-file-system-command exec-server-command)))
1306
a7ef45d9
LC
1307(define* (operating-system-boot-parameters os root-device
1308 #:key system-kernel-arguments?)
1309 "Return a monadic <boot-parameters> record that describes the boot
1310parameters of OS. When SYSTEM-KERNEL-ARGUMENTS? is true, add kernel arguments
1311such as '--root' and '--load' to <boot-parameters>."
395782f2 1312 (let* ((initrd (and (not (operating-system-hurd os))
912b857e 1313 (operating-system-initrd-file os)))
35b44681 1314 (store (operating-system-store-file-system os))
582cf925 1315 (file-systems (operating-system-file-systems os))
9d449b94 1316 (locale (operating-system-locale os))
35b44681
LC
1317 (bootloader (bootloader-configuration-bootloader
1318 (operating-system-bootloader os)))
1319 (bootloader-name (bootloader-name bootloader))
912b857e
JN
1320 (label (operating-system-label os))
1321 (multiboot-modules (operating-system-multiboot-modules os)))
35b44681
LC
1322 (boot-parameters
1323 (label label)
1324 (root-device root-device)
1325 (kernel (operating-system-kernel-file os))
1326 (kernel-arguments
1327 (if system-kernel-arguments?
1328 (operating-system-kernel-arguments os root-device)
1329 (operating-system-user-kernel-arguments os)))
1330 (initrd initrd)
912b857e 1331 (multiboot-modules multiboot-modules)
35b44681 1332 (bootloader-name bootloader-name)
a28cfee8
LC
1333 (bootloader-menu-entries
1334 (bootloader-configuration-menu-entries (operating-system-bootloader os)))
9d449b94 1335 (locale locale)
35b44681 1336 (store-device (ensure-not-/dev (file-system-device store)))
582cf925 1337 (store-directory-prefix (btrfs-store-subvolume-file-name file-systems))
35b44681 1338 (store-mount-point (file-system-mount-point store)))))
40fad1c2 1339
9b336338
LC
1340(define (device->sexp device)
1341 "Serialize DEVICE as an sexp (really, as an object with a read syntax.)"
1342 (match device
1343 ((? uuid? uuid)
075681d3 1344 `(uuid ,(uuid-type uuid) ,(uuid-bytevector uuid)))
a5acc17a
LC
1345 ((? file-system-label? label)
1346 `(file-system-label ,(file-system-label->string label)))
9b336338
LC
1347 (_
1348 device)))
1349
a7ef45d9
LC
1350(define* (operating-system-boot-parameters-file os
1351 #:key system-kernel-arguments?)
40fad1c2
DM
1352 "Return a file that describes the boot parameters of OS. The primary use of
1353this file is the reconstruction of GRUB menu entries for old configurations.
a7ef45d9
LC
1354
1355When SYSTEM-KERNEL-ARGUMENTS? is true, add kernel arguments such as '--root'
1356and '--load' to the returned file (since the returned file is then usually
1357stored into the content-addressed \"system\" directory, it's usually not a
1358good idea to give it because the content hash would change by the content hash
40fad1c2 1359being stored into the \"parameters\" file)."
35b44681
LC
1360 (let* ((root (operating-system-root-file-system os))
1361 (device (file-system-device root))
1362 (params (operating-system-boot-parameters
1363 os device
1364 #:system-kernel-arguments?
1365 system-kernel-arguments?)))
2e37d158
LC
1366 (scheme-file "parameters"
1367 #~(boot-parameters
1368 (version 0)
1369 (label #$(boot-parameters-label params))
1370 (root-device
1371 #$(device->sexp
1372 (boot-parameters-root-device params)))
1373 (kernel #$(boot-parameters-kernel params))
1374 (kernel-arguments
1375 #$(boot-parameters-kernel-arguments params))
2b76179e
JN
1376 #$@(if (boot-parameters-initrd params)
1377 #~((initrd #$(boot-parameters-initrd params)))
1378 #~())
1379 #$@(if (pair? (boot-parameters-multiboot-modules params))
1380 #~((multiboot-modules
1381 #$(boot-parameters-multiboot-modules params)))
1382 #~())
2e37d158
LC
1383 (bootloader-name #$(boot-parameters-bootloader-name params))
1384 (bootloader-menu-entries
1385 #$(map menu-entry->sexp
1386 (or (and=> (operating-system-bootloader os)
1387 bootloader-configuration-menu-entries)
1388 '())))
9d449b94 1389 (locale #$(boot-parameters-locale params))
2e37d158
LC
1390 (store
1391 (device
1392 #$(device->sexp (boot-parameters-store-device params)))
1393 (mount-point #$(boot-parameters-store-mount-point
582cf925
MÁAV
1394 params))
1395 (directory-prefix
1396 #$(boot-parameters-store-directory-prefix params))))
2e37d158 1397 #:set-load-path? #f)))
64e40dbb 1398
96da5d62
LC
1399(define-gexp-compiler (operating-system-compiler (os <operating-system>)
1400 system target)
1401 ((store-lift
1402 (lambda (store)
1403 ;; XXX: This is not super elegant but we can't pass SYSTEM and TARGET to
1404 ;; 'operating-system-derivation'.
1405 (run-with-store store (operating-system-derivation os)
1406 #:system system
1407 #:target target)))))
1408
033adfe7 1409;;; system.scm ends here