#:use-module (guix records)
#:use-module (guix packages)
#:use-module (guix derivations)
+ #:use-module (guix profiles)
#:use-module (gnu packages base)
#:use-module (gnu packages bash)
+ #:use-module (gnu packages guile)
+ #:use-module (gnu packages which)
#:use-module (gnu packages admin)
+ #:use-module (gnu packages linux)
+ #:use-module (gnu packages pciutils)
#:use-module (gnu packages package-management)
+ #:use-module (gnu packages which)
+ #:use-module (gnu packages less)
+ #:use-module (gnu packages zile)
+ #:use-module (gnu packages nano)
+ #:use-module (gnu packages lsof)
+ #:use-module (gnu packages gawk)
+ #:use-module (gnu packages compression)
+ #:use-module (gnu packages firmware)
+ #:autoload (gnu packages cryptsetup) (cryptsetup)
#:use-module (gnu services)
#:use-module (gnu services dmd)
#:use-module (gnu services base)
#:use-module (gnu system shadow)
#:use-module (gnu system linux)
#:use-module (gnu system linux-initrd)
+ #:use-module (gnu system file-systems)
#:use-module (ice-9 match)
#:use-module (srfi srfi-1)
#:use-module (srfi srfi-26)
#:export (operating-system
operating-system?
+
+ operating-system-bootloader
operating-system-services
operating-system-user-services
operating-system-packages
- operating-system-bootloader-entries
operating-system-host-name
+ operating-system-hosts-file
operating-system-kernel
operating-system-initrd
operating-system-users
operating-system-groups
+ operating-system-issue
operating-system-packages
operating-system-timezone
operating-system-locale
+ operating-system-mapped-devices
operating-system-file-systems
+ operating-system-activation-script
operating-system-derivation
operating-system-profile
operating-system-grub.cfg
- <file-system>
- file-system
- file-system?
- file-system-device
- file-system-mount-point
- file-system-type
- file-system-needed-for-boot?
- file-system-flags
- file-system-options
+ local-host-aliases
+ %setuid-programs
+ %base-packages
+ %base-firmware
- %fuse-control-file-system
- %binary-format-file-system))
+ luks-device-mapping))
;;; Commentary:
;;;
operating-system?
(kernel operating-system-kernel ; package
(default linux-libre))
- (bootloader operating-system-bootloader ; package
- (default grub))
- (bootloader-entries operating-system-bootloader-entries ; list
- (default '()))
+ (bootloader operating-system-bootloader) ; <grub-configuration>
+
(initrd operating-system-initrd ; (list fs) -> M derivation
- (default qemu-initrd))
+ (default base-initrd))
+ (firmware operating-system-firmware ; list of packages
+ (default %base-firmware))
(host-name operating-system-host-name) ; string
+ (hosts-file operating-system-hosts-file ; M item | #f
+ (default #f))
- (file-systems operating-system-file-systems ; list of fs
+ (mapped-devices operating-system-mapped-devices ; list of <mapped-device>
+ (default '()))
+ (file-systems operating-system-file-systems) ; list of fs
+ (swap-devices operating-system-swap-devices ; list of strings
(default '()))
(users operating-system-users ; list of user accounts
(default '()))
(groups operating-system-groups ; list of user groups
- (default (list (user-group
- (name "root")
- (id 0)))))
+ (default %base-groups))
(skeletons operating-system-skeletons ; list of name/monadic value
(default (default-skeletons)))
+ (issue operating-system-issue ; string
+ (default %default-issue))
(packages operating-system-packages ; list of (PACKAGE OUTPUT...)
- (default (list coreutils ; or just PACKAGE
- grep
- sed
- findutils
- guile
- bash
- (@ (gnu packages dmd) dmd)
- guix
- tzdata)))
+ (default %base-packages)) ; or just PACKAGE
(timezone operating-system-timezone) ; string
- (locale operating-system-locale) ; string
+ (locale operating-system-locale ; string
+ (default "en_US.UTF-8"))
(services operating-system-user-services ; list of monadic services
(default %base-services))
(default %sudoers-specification)))
\f
-;;;
-;;; File systems.
-;;;
-
-;; File system declaration.
-(define-record-type* <file-system> file-system
- make-file-system
- file-system?
- (device file-system-device) ; string
- (mount-point file-system-mount-point) ; string
- (type file-system-type) ; string
- (flags file-system-flags ; list of symbols
- (default '()))
- (options file-system-options ; string or #f
- (default #f))
- (needed-for-boot? file-system-needed-for-boot? ; Boolean
- (default #f))
- (check? file-system-check? ; Boolean
- (default #t)))
-
-(define %fuse-control-file-system
- ;; Control file system for Linux' file systems in user-space (FUSE).
- (file-system
- (device "fusectl")
- (mount-point "/sys/fs/fuse/connections")
- (type "fusectl")
- (check? #f)))
-
-(define %binary-format-file-system
- ;; Support for arbitrary executable binary format.
- (file-system
- (device "binfmt_misc")
- (mount-point "/proc/sys/fs/binfmt_misc")
- (type "binfmt_misc")
- (check? #f)))
-
-\f
;;;
;;; Derivation.
;;;
-(define* (union inputs
- #:key (guile (%guile-for-build)) (system (%current-system))
- (name "union"))
- "Return a derivation that builds the union of INPUTS. INPUTS is a list of
-input tuples."
- (define builder
- #~(begin
- (use-modules (guix build union))
-
- (define inputs '#$inputs)
-
- (setvbuf (current-output-port) _IOLBF)
- (setvbuf (current-error-port) _IOLBF)
-
- (format #t "building union `~a' with ~a packages...~%"
- #$output (length inputs))
- (union-build #$output inputs)))
-
- (gexp->derivation name builder
- #:system system
- #:modules '((guix build union))
- #:guile-for-build guile
- #:local-build? #t))
-
(define* (file-union name files)
"Return a derivation that builds a directory containing all of FILES. Each
item in FILES must be a list where the first element is the file name to use
(gexp->derivation name builder))
+(define (directory-union name things)
+ "Return a directory that is the union of THINGS."
+ (match things
+ ((one)
+ ;; Only one thing; return it.
+ (with-monad %store-monad (return one)))
+ (_
+ (gexp->derivation name
+ #~(begin
+ (use-modules (guix build union))
+ (union-build #$output '#$things))
+ #:modules '((guix build union))
+ #:local-build? #t))))
+
\f
;;;
;;; Services.
;;;
+(define (open-luks-device source target)
+ "Return a gexp that maps SOURCE to TARGET as a LUKS device, using
+'cryptsetup'."
+ #~(zero? (system* (string-append #$cryptsetup "/sbin/cryptsetup")
+ "open" "--type" "luks"
+ #$source #$target)))
+
+(define (close-luks-device source target)
+ "Return a gexp that closes TARGET, a LUKS device."
+ #~(zero? (system* (string-append #$cryptsetup "/sbin/cryptsetup")
+ "close" #$target)))
+
+(define luks-device-mapping
+ ;; The type of LUKS mapped devices.
+ (mapped-device-kind
+ (open open-luks-device)
+ (close close-luks-device)))
+
(define (other-file-system-services os)
"Return file system services for the file systems of OS that are not marked
as 'needed-for-boot'."
(string=? "/" (file-system-mount-point fs))))
(operating-system-file-systems os)))
+ (define (device-mappings fs)
+ (filter (lambda (md)
+ (string=? (string-append "/dev/mapper/"
+ (mapped-device-target md))
+ (file-system-device fs)))
+ (operating-system-mapped-devices os)))
+
+ (define (requirements fs)
+ (map (lambda (md)
+ (symbol-append 'device-mapping-
+ (string->symbol (mapped-device-target md))))
+ (device-mappings fs)))
+
(sequence %store-monad
- (map (match-lambda
- (($ <file-system> device target type flags opts #f check?)
- (file-system-service device target type
- #:check? check?
- #:options opts)))
+ (map (lambda (fs)
+ (match fs
+ (($ <file-system> device title target type flags opts
+ #f check? create?)
+ (file-system-service device target type
+ #:title title
+ #:requirements (requirements fs)
+ #:check? check?
+ #:create-mount-point? create?
+ #:options opts
+ #:flags flags))))
file-systems)))
+(define (mapped-device-user device file-systems)
+ "Return a file system among FILE-SYSTEMS that uses DEVICE, or #f."
+ (let ((target (string-append "/dev/mapper/" (mapped-device-target device))))
+ (find (lambda (fs)
+ (string=? (file-system-device fs) target))
+ file-systems)))
+
+(define (operating-system-user-mapped-devices os)
+ "Return the subset of mapped devices that can be installed in
+user-land--i.e., those not needed during boot."
+ (let ((devices (operating-system-mapped-devices os))
+ (file-systems (operating-system-file-systems os)))
+ (filter (lambda (md)
+ (let ((user (mapped-device-user md file-systems)))
+ (or (not user)
+ (not (file-system-needed-for-boot? user)))))
+ devices)))
+
+(define (operating-system-boot-mapped-devices os)
+ "Return the subset of mapped devices that must be installed during boot,
+from the initrd."
+ (let ((devices (operating-system-mapped-devices os))
+ (file-systems (operating-system-file-systems os)))
+ (filter (lambda (md)
+ (let ((user (mapped-device-user md file-systems)))
+ (and user (file-system-needed-for-boot? user))))
+ devices)))
+
+(define (device-mapping-services os)
+ "Return the list of device-mapping services for OS as a monadic list."
+ (sequence %store-monad
+ (map (lambda (md)
+ (let* ((source (mapped-device-source md))
+ (target (mapped-device-target md))
+ (type (mapped-device-type md))
+ (open (mapped-device-kind-open type))
+ (close (mapped-device-kind-close type)))
+ (device-mapping-service target
+ (open source target)
+ (close source target))))
+ (operating-system-user-mapped-devices os))))
+
+(define (swap-services os)
+ "Return the list of swap services for OS as a monadic list."
+ (sequence %store-monad
+ (map swap-service (operating-system-swap-devices os))))
+
(define (essential-services os)
"Return the list of essential services for OS. These are special services
that implement part of what's declared in OS are responsible for low-level
bookkeeping."
- (mlet* %store-monad ((root-fs (root-file-system-service))
+ (define known-fs
+ (map file-system-mount-point (operating-system-file-systems os)))
+
+ (mlet* %store-monad ((mappings (device-mapping-services os))
+ (root-fs (root-file-system-service))
(other-fs (other-file-system-services os))
+ (unmount (user-unmount-service known-fs))
+ (swaps (swap-services os))
(procs (user-processes-service
(map (compose first service-provision)
other-fs)))
(host-name (host-name-service
(operating-system-host-name os))))
- (return (cons* host-name procs root-fs other-fs))))
+ (return (cons* host-name procs root-fs unmount
+ (append other-fs mappings swaps)))))
(define (operating-system-services os)
"Return all the services of OS, including \"internal\" services that do not
;;; /etc.
;;;
+(define %base-firmware
+ ;; Firmware usable by default.
+ (list ath9k-htc-firmware))
+
+(define %base-packages
+ ;; Default set of packages globally visible. It should include anything
+ ;; required for basic administrator tasks.
+ (cons* procps psmisc which less zile nano
+ (@ (gnu packages admin) dmd) guix
+ lsof ;for Guix's 'list-runtime-roots'
+ pciutils usbutils
+ util-linux inetutils isc-dhcp wireless-tools
+ net-tools ; XXX: remove when Inetutils suffices
+
+ ;; Get 'insmod' & co. from kmod, not module-init-tools, since udev
+ ;; already depends on it anyway.
+ kmod eudev
+
+ e2fsprogs kbd
+
+ ;; The packages below are also in %FINAL-INPUTS, so take them from
+ ;; there to avoid duplication.
+ (map canonical-package
+ (list guile-2.0 bash coreutils findutils grep sed
+ diffutils patch gawk tar gzip bzip2 xz lzip))))
+
+(define %default-issue
+ ;; Default contents for /etc/issue.
+ "
+This is the GNU system. Welcome.\n")
+
+(define (local-host-aliases host-name)
+ "Return aliases for HOST-NAME, to be used in /etc/hosts."
+ (string-append "127.0.0.1 localhost " host-name "\n"
+ "::1 localhost " host-name "\n"))
+
+(define (default-/etc/hosts host-name)
+ "Return the default /etc/hosts file."
+ (text-file "hosts" (local-host-aliases host-name)))
+
(define* (etc-directory #:key
(locale "C") (timezone "Europe/Paris")
+ (issue "Hello!\n")
(skeletons '())
(pam-services '())
(profile "/run/current-system/profile")
+ hosts-file
(sudoers ""))
"Return a derivation that builds the static part of the /etc directory."
(mlet* %store-monad
/bin/sh
/run/current-system/profile/bin/sh
/run/current-system/profile/bin/bash\n"))
- (issue (text-file "issue" "
-This is an alpha preview of the GNU system. Welcome.
+ (issue (text-file "issue" issue))
-This image features the GNU Guix package manager, which was used to
-build it (http://www.gnu.org/software/guix/). The init system is
-GNU dmd (http://www.gnu.org/software/dmd/).
-
-You can log in as 'guest' or 'root' with no password.
-"))
+ ;; For now, generate a basic config so that /etc/hosts is honored.
+ (nsswitch (text-file "nsswitch.conf"
+ "hosts: files dns\n"))
;; TODO: Generate bashrc from packages' search-paths.
(bashrc (text-file* "bashrc" "
-export PS1='\\u@\\h\\$ '
+export PS1='\\u@\\h \\w\\$ '
export LC_ALL=\"" locale "\"
export TZ=\"" timezone "\"
export TZDIR=\"" tzdata "/share/zoneinfo\"
-export PATH=/run/setuid-programs:/run/current-system/profile/sbin
-export PATH=$HOME/.guix-profile/bin:/run/current-system/profile/bin:$PATH
+# Tell 'modprobe' & co. where to look for modules.
+export LINUX_MODULE_DIRECTORY=/run/booted-system/kernel/lib/modules
+
+export PATH=$HOME/.guix-profile/bin:/run/current-system/profile/bin
+export PATH=/run/setuid-programs:/run/current-system/profile/sbin:$PATH
export CPATH=$HOME/.guix-profile/include:" profile "/include
export LIBRARY_PATH=$HOME/.guix-profile/lib:" profile "/lib
+export INFOPATH=$HOME/.guix-profile/share/info:/run/current-system/profile/share/info
alias ls='ls -p --color'
alias ll='ls -l'
"))
("pam.d" ,#~#$pam.d)
("login.defs" ,#~#$login.defs)
("issue" ,#~#$issue)
+ ("nsswitch.conf" ,#~#$nsswitch)
("skel" ,#~#$skel)
("shells" ,#~#$shells)
("profile" ,#~#$bashrc)
+ ("hosts" ,#~#$hosts-file)
("localtime" ,#~(string-append #$tzdata "/share/zoneinfo/"
#$timezone))
("sudoers" ,#~#$sudoers)))))
(define (operating-system-profile os)
- "Return a derivation that builds the default profile of OS."
- ;; TODO: Replace with a real profile with a manifest.
- (union (operating-system-packages os)
- #:name "default-profile"))
+ "Return a derivation that builds the system profile of OS."
+ (profile-derivation (manifest (map package->manifest-entry
+ (operating-system-packages os)))))
(define %root-account
;; Default root account.
(append (operating-system-pam-services os)
(append-map service-pam-services services))))
(profile-drv (operating-system-profile os))
- (skeletons (operating-system-skeletons os)))
+ (skeletons (operating-system-skeletons os))
+ (/etc/hosts (or (operating-system-hosts-file os)
+ (default-/etc/hosts (operating-system-host-name os)))))
(etc-directory #:pam-services pam-services
#:skeletons skeletons
+ #:issue (operating-system-issue os)
#:locale (operating-system-locale os)
#:timezone (operating-system-timezone os)
+ #:hosts-file /etc/hosts
#:sudoers (operating-system-sudoers os)
#:profile profile-drv)))
(list #~(string-append #$shadow "/bin/passwd")
#~(string-append #$shadow "/bin/su")
#~(string-append #$inetutils "/bin/ping")
- #~(string-append #$sudo "/bin/sudo"))))
+ #~(string-append #$sudo "/bin/sudo")
+ #~(string-append #$fuse "/bin/fusermount"))))
(define %sudoers-specification
;; Default /etc/sudoers contents: 'root' and all members of the 'wheel'
'active-groups'."
#~(list #$(user-group-name group)
#$(user-group-password group)
- #$(user-group-id group)))
+ #$(user-group-id group)
+ #$(user-group-system? group)))
(define (user-account->gexp account)
"Turn ACCOUNT, a <user-account> object, into a list-valued gexp suitable for
#$(user-account-comment account)
#$(user-account-home-directory account)
,#$(user-account-shell account) ; this one is a gexp
- #$(user-account-password account)))
-
-(define (operating-system-boot-script os)
- "Return the boot script for OS---i.e., the code started by the initrd once
-we're running in the final root."
+ #$(user-account-password account)
+ #$(user-account-system? account)))
+
+(define (modprobe-wrapper)
+ "Return a wrapper for the 'modprobe' command that knows where modules live.
+
+This wrapper is typically invoked by the Linux kernel ('call_modprobe', in
+kernel/kmod.c), a situation where the 'LINUX_MODULE_DIRECTORY' environment
+variable is not set---hence the need for this wrapper."
+ (let ((modprobe "/run/current-system/profile/bin/modprobe"))
+ (gexp->script "modprobe"
+ #~(begin
+ (setenv "LINUX_MODULE_DIRECTORY"
+ "/run/booted-system/kernel/lib/modules")
+ (apply execl #$modprobe
+ (cons #$modprobe (cdr (command-line))))))))
+
+(define (operating-system-activation-script os)
+ "Return the activation script for OS---i.e., the code that \"activates\" the
+stateful part of OS, including user accounts and groups, special directories,
+etc."
(define %modules
- '((guix build activation)
- (guix build utils)
- (guix build linux-initrd)))
+ '((gnu build activation)
+ (gnu build linux-boot)
+ (gnu build file-systems)
+ (guix build utils)))
+
+ (define (service-activations services)
+ ;; Return the activation scripts for SERVICES.
+ (let ((gexps (filter-map service-activate services)))
+ (sequence %store-monad (map (cut gexp->file "activate-service.scm" <>)
+ gexps))))
(mlet* %store-monad ((services (operating-system-services os))
+ (actions (service-activations services))
(etc (operating-system-etc-directory os))
(modules (imported-modules %modules))
(compiled (compiled-modules %modules))
- (dmd-conf (dmd-configuration-file services))
+ (modprobe (modprobe-wrapper))
+ (firmware (directory-union
+ "firmware" (operating-system-firmware os)))
(accounts (operating-system-accounts os)))
(define setuid-progs
(operating-system-setuid-programs os))
(define group-specs
(map user-group->gexp groups))
- (gexp->file "boot"
+ (gexp->file "activate"
#~(begin
(eval-when (expand load eval)
;; Make sure 'use-modules' below succeeds.
(set! %load-compiled-path
(cons #$compiled %load-compiled-path)))
- (use-modules (guix build activation))
+ (use-modules (gnu build activation))
+
+ ;; Make sure /bin/sh is valid and current.
+ (activate-/bin/sh
+ (string-append #$(canonical-package bash)
+ "/bin/sh"))
;; Populate /etc.
(activate-etc #$etc)
;; Activate setuid programs.
(activate-setuid-programs (list #$@setuid-progs))
+ ;; Tell the kernel to use our 'modprobe' command.
+ (activate-modprobe #$modprobe)
+
+ ;; Tell the kernel where firmware is.
+ (activate-firmware
+ (string-append #$firmware "/lib/firmware"))
+
+ ;; Run the services' activation snippets.
+ ;; TODO: Use 'load-compiled'.
+ (for-each primitive-load '#$actions)
+
;; Set up /run/current-system.
- (activate-current-system #:boot? #t)
+ (activate-current-system)))))
+
+(define (operating-system-boot-script os)
+ "Return the boot script for OS---i.e., the code started by the initrd once
+we're running in the final root."
+ (mlet* %store-monad ((services (operating-system-services os))
+ (activate (operating-system-activation-script os))
+ (dmd-conf (dmd-configuration-file services)))
+ (gexp->file "boot"
+ #~(begin
+ ;; Activate the system.
+ ;; TODO: Use 'load-compiled'.
+ (primitive-load #$activate)
+
+ ;; Keep track of the booted system.
+ (false-if-exception (delete-file "/run/booted-system"))
+ (symlink (readlink "/run/current-system")
+ "/run/booted-system")
;; Close any remaining open file descriptors to be on the
;; safe side. This must be the very last thing we do,
(define (operating-system-root-file-system os)
"Return the root file system of OS."
(find (match-lambda
- (($ <file-system> _ "/") #t)
+ (($ <file-system> _ _ "/") #t)
(_ #f))
(operating-system-file-systems os)))
"Return a gexp denoting the initrd file of OS."
(define boot-file-systems
(filter (match-lambda
- (($ <file-system> device "/")
+ (($ <file-system> device title "/")
#t)
- (($ <file-system> device mount-point type flags options boot?)
+ (($ <file-system> device title mount-point type flags
+ options boot?)
boot?))
(operating-system-file-systems os)))
- (mlet %store-monad
- ((initrd ((operating-system-initrd os) boot-file-systems)))
+ (define mapped-devices
+ (operating-system-boot-mapped-devices os))
+
+ (define make-initrd
+ (operating-system-initrd os))
+
+ (mlet %store-monad ((initrd (make-initrd boot-file-systems
+ #:mapped-devices mapped-devices)))
(return #~(string-append #$initrd "/initrd"))))
-(define (operating-system-grub.cfg os)
- "Return the GRUB configuration file for OS."
+(define (kernel->grub-label kernel)
+ "Return a label for the GRUB menu entry that boots KERNEL."
+ (string-append "GNU system with "
+ (string-titlecase (package-name kernel)) " "
+ (package-version kernel)
+ " (technology preview)"))
+
+(define* (operating-system-grub.cfg os #:optional (old-entries '()))
+ "Return the GRUB configuration file for OS. Use OLD-ENTRIES to populate the
+\"old entries\" menu."
(mlet* %store-monad
((system (operating-system-derivation os))
(root-fs -> (operating-system-root-file-system os))
(kernel -> (operating-system-kernel os))
(entries -> (list (menu-entry
- (label (string-append
- "GNU system with "
- (package-full-name kernel)
- " (technology preview)"))
+ (label (kernel->grub-label kernel))
(linux kernel)
(linux-arguments
(list (string-append "--root="
#~(string-append "--load=" #$system
"/boot")))
(initrd #~(string-append #$system "/initrd"))))))
- (grub-configuration-file entries)))
+ (grub-configuration-file (operating-system-bootloader os) entries
+ #:old-entries old-entries)))
+
+(define (operating-system-parameters-file os)
+ "Return a file that describes the boot parameters of OS. The primary use of
+this file is the reconstruction of GRUB menu entries for old configurations."
+ (mlet %store-monad ((initrd (operating-system-initrd-file os))
+ (root -> (operating-system-root-file-system os))
+ (label -> (kernel->grub-label
+ (operating-system-kernel os))))
+ (gexp->file "parameters"
+ #~(boot-parameters (version 0)
+ (label #$label)
+ (root-device #$(file-system-device root))
+ (kernel #$(operating-system-kernel os))
+ (initrd #$initrd)))))
(define (operating-system-derivation os)
"Return a derivation that builds OS."
(etc (operating-system-etc-directory os))
(boot (operating-system-boot-script os))
(kernel -> (operating-system-kernel os))
- (initrd (operating-system-initrd-file os)))
+ (initrd (operating-system-initrd-file os))
+ (params (operating-system-parameters-file os)))
(file-union "system"
`(("boot" ,#~#$boot)
("kernel" ,#~#$kernel)
+ ("parameters" ,#~#$params)
("initrd" ,initrd)
("profile" ,#~#$profile)
("etc" ,#~#$etc)))))