<
aboutsummaryrefslogtreecommitdiff
path: root/gnu/build/install.scm
blob: 9085e22e09881dfe9e35d9c0db900bfdd6eacaf3 (about) (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
;;; GNU Guix --- Functional package management for GNU
;;; Copyright © 2013, 2014, 2015 Ludovic Courtès <ludo@gnu.org>
;;;
;;; This file is part of GNU Guix.
;;;
;;; GNU Guix is free software; you can redistribute it and/or modify it
;;; under the terms of the GNU General Public License as published by
;;; the Free Software Foundation; either version 3 of the License, or (at
;;; your option) any later version.
;;;
;;; GNU Guix is distributed in the hope that it will be useful, but
;;; WITHOUT ANY WARRANTY; without even the implied warranty of
;;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
;;; GNU General Public License for more details.
;;;
;;; You should have received a copy of the GNU General Public License
;;; along with GNU Guix.  If not, see <http://www.gnu.org/licenses/>.

(define-module (gnu build install)
  #:use-module (guix build utils)
  #:use-module (guix build store-copy)
  #:use-module (srfi srfi-26)
  #:use-module (ice-9 match)
  #:export (install-grub
            populate-root-file-system
            reset-timestamps
            register-closure
            populate-single-profile-directory))

;;; Commentary:
;;;
;;; This module supports the installation of the GNU system on a hard disk.
;;; It is meant to be used both in a build environment (in derivations that
;;; build VM images), and on the bare metal (when really installing the
;;; system.)
;;;
;;; Code:

(define* (install-grub grub.cfg device mount-point)
  "Install GRUB with GRUB.CFG on DEVICE, which is assumed to be mounted on
MOUNT-POINT.

Note that the caller must make sure that GRUB.CFG is registered as a GC root
so that the fonts, background images, etc. referred to by GRUB.CFG are not
GC'd."
  (let* ((target (string-append mount-point "/boot/grub/grub.cfg"))
         (pivot  (string-append target ".new")))
    (mkdir-p (dirname target))

    ;; Copy GRUB.CFG instead of just symlinking it, because symlinks won't
    ;; work when /boot is on a separate partition.  Do that atomically.
    (copy-file grub.cfg pivot)
    (rename-file pivot target)

    (unless (zero? (system* "grub-install" "--no-floppy"
                            "--boot-directory"
                            (string-append mount-point "/boot")
                            device))
      (error "failed to install GRUB"))))

(define (evaluate-populate-directive directive target)
  "Evaluate DIRECTIVE, an sexp describing a file or directory to create under
directory TARGET."
  (let loop ((directive directive))
    (catch 'system-error
      (lambda ()
        (match directive
          (('directory name)
           (mkdir-p (string-append target name)))
          (('directory name uid gid)
           (let ((dir (string-append target name)))
             (mkdir-p dir)
             (chown dir uid gid)))
          (('directory name uid gid mode)
           (loop `(directory ,name ,uid ,gid))
           (chmod (string-append target name) mode))
          ((new '-> old)
           (let try ()
             (catch 'system-error
               (lambda ()
                 (symlink old (string-append target new)))
               (lambda args
                 ;; When doing 'guix system init' on the current '/', some
                 ;; symlinks may already exists.  Override them.
                 (if (= EEXIST (system-error-errno args))
                     (begin
                       (delete-file (string-append target new))
                       (try))
                     (apply throw args))))))))
      (lambda args
        ;; Usually we can only get here when installing to an existing root,
        ;; as with 'guix system init foo.scm /'.
        (format (current-error-port)
                "error: failed to evaluate directive: ~s~%"
                directive)
        (apply throw args)))))

(define (directives store)
  "Return a list of directives to populate the root file system that will host
STORE."
  `(;; Note: the store's GID is fixed precisely so we can set it here rather
    ;; than at activation time.
    (directory ,store 0 30000 #o1775)

    (directory "/etc")
    (directory "/var/log")                          ; for dmd
    (directory "/var/guix/gcroots")
    (directory "/var/empty")                        ; for no-login accounts
    (directory "/var/db")                           ; for dhclient, etc.
    (directory "/var/run")
    (directory "/run")
    (directory "/mnt")
    (directory "/var/guix/profiles/per-user/root" 0 0)

    ;; Link to the initial system generation.
    ("/var/guix/profiles/system" -> "system-1-link")

    ("/var/guix/gcroots/booted-system" -> "/run/booted-system")
    ("/var/guix/gcroots/current-system" -> "/run/current-system")

    (directory "/bin")
    (directory "/tmp" 0 0 #o1777)                 ; sticky bit
    (directory "/var/tmp" 0 0 #o1777)
    (directory "/var/lock" 0 0 #o1777)

    (directory "/root" 0 0)                       ; an exception
    (directory "/home" 0 0)))

(define (populate-root-file-system system target)
  "Make the essential non-store files and directories on TARGET.  This
includes /etc, /var, /run, /bin/sh, etc., and all the symlinks to SYSTEM."
  (for-each (cut evaluate-populate-directive <> target)
            (directives (%store-directory)))

  ;; Add system generation 1.
  (let ((generation-1 (string-append target
                                     "/var/guix/profiles/system-1-link")))
    (let try ()
      (catch 'system-error
        (lambda ()
          (symlink system generation-1))
        (lambda args
          ;; If GENERATION-1 already exists, overwrite it.
          (if (= EEXIST (system-error-errno args))
              (begin
                (delete-file generation-1)
                (try))
              (apply throw args)))))))

(define (reset-timestamps directory)
  "Reset the timestamps of all the files under DIRECTORY, so that they appear
as created and modified at the Epoch."
  (display "clearing file timestamps...\n")
  (for-each (lambda (file)
              (let ((s (lstat file)))
                ;; XXX: Guile uses libc's 'utime' function (not 'futime'), so
                ;; the timestamp of symlinks cannot be changed, and there are
                ;; symlinks here pointing to /gnu/store, which is the host,
                ;; read-only store.
                (unless (eq? (stat:type s) 'symlink)
                  (utime file 0 0 0 0))))
            (find-files directory "")))

(define* (register-closure store closure
                           #:key (deduplicate? #t))
  "Register CLOSURE in STORE, where STORE is the directory name of the target
store and CLOSURE is the name of a file containing a reference graph as used
by 'guix-register'.  As a side effect, this resets timestamps on store files
and, if DEDUPLICATE? is true, deduplicates files common to CLOSURE and the
rest of STORE."
  (let ((status (apply system* "guix-register" "--prefix" store
                       (append (if deduplicate? '() '("--no-deduplication"))
                               (list closure)))))
    (unless (zero? status)
      (error "failed to register store items" closure))))

(define* (populate-single-profile-directory directory
                                            #:key profile closure
                                            deduplicate?)
  "Populate DIRECTORY with a store containing PROFILE, whose closure is given
in the file called CLOSURE (as generated by #:references-graphs.)  DIRECTORY
is initialized to contain a single profile under /root pointing to PROFILE.
DEDUPLICATE? determines whether to deduplicate files in the store.

This is used to create the self-contained Guix tarball."
  (define (scope file)
    (string-append directory "/" file))

  (define %root-profile
    "/var/guix/profiles/per-user/root")

  (define (mkdir-p* dir)
    (mkdir-p (scope dir)))

  (define (symlink* old new)
    (symlink old (scope new)))

  ;; Populate the store.
  (populate-store (list closure) directory)
  (register-closure (canonicalize-path directory) closure
                    #:deduplicate? deduplicate?)

  ;; XXX: 'guix-register' registers profiles as GC roots but the symlink
  ;; target uses $TMPDIR.  Fix that.
  (delete-file (scope "/var/guix/gcroots/profiles"))
  (symlink* "/var/guix/profiles"
            "/var/guix/gcroots/profiles")

  ;; Make root's profile, which makes it a GC root.
  (mkdir-p* %root-profile)
  (symlink* profile
            (string-append %root-profile "/guix-profile-1-link"))
  (symlink* (string-append %root-profile "/guix-profile-1-link")
            (string-append %root-profile "/guix-profile"))

  (mkdir-p* "/root")
  (symlink* (string-append %root-profile "/guix-profile")
            "/root/.guix-profile"))

;;; install.scm ends here
aemon' has provisions to remount it read-write in its own name ;; space. (file-system (device (%store-prefix)) (mount-point (%store-prefix)) (type "none") (check? #f) (flags '(read-only bind-mount no-atime)))) (define %control-groups ;; The cgroup2 file system. (list (file-system (device "none") (mount-point "/sys/fs/cgroup") (type "cgroup2") (check? #f) (create-mount-point? #f)))) (define %elogind-file-systems ;; We don't use systemd, but these file systems are needed for elogind, ;; which was extracted from systemd. (append (list (file-system (device "none") (mount-point "/run/systemd") (type "tmpfs") (check? #f) (flags '(no-suid no-dev no-exec)) (options "mode=0755") (create-mount-point? #t)) (file-system (device "none") (mount-point "/run/user") (type "tmpfs") (check? #f) (flags '(no-suid no-dev no-exec)) (options "mode=0755") (create-mount-point? #t)) ;; Elogind uses cgroups to organize processes, allowing it to map PIDs ;; to sessions. Elogind's cgroup hierarchy isn't associated with any ;; resource controller ("subsystem"). (file-system (device "cgroup") (mount-point "/sys/fs/cgroup/elogind") (type "cgroup") (check? #f) (options "none,name=elogind") (create-mount-point? #t) (dependencies (list (car %control-groups))))) %control-groups)) (define %base-file-systems ;; List of basic file systems to be mounted. Note that /proc and /sys are ;; currently mounted by the initrd. (list %pseudo-terminal-file-system %debug-file-system %shared-memory-file-system %efivars-file-system %immutable-store)) (define %base-live-file-systems ;; This is the bare minimum to use live file-systems. ;; Used in installation-os. (list (file-system (mount-point "/") (device (file-system-label "Guix_image")) (type "ext4")) ;; Make /tmp a tmpfs instead of keeping the overlayfs. This ;; originally was used for unionfs because FUSE creates ;; '.fuse_hiddenXYZ' files for each open file, and this confuses ;; Guix's test suite, for instance (see ;; <http://bugs.gnu.org/23056>). We keep this for overlayfs to be ;; on the safe side. (file-system (mount-point "/tmp") (device "none") (type "tmpfs") (check? #f)))) ;; File systems for Linux containers differ from %base-file-systems in that ;; they impose additional restrictions such as no-exec or need different ;; options to function properly. ;; ;; The file system flags and options conform to the libcontainer ;; specification: ;; https://github.com/docker/libcontainer/blob/master/SPEC.md#filesystem (define %container-file-systems (list ;; Pseudo-terminal file system. (file-system (device "none") (mount-point "/dev/pts") (type "devpts") (flags '(no-exec no-suid)) (needed-for-boot? #t) (create-mount-point? #t) (check? #f) (options "newinstance,ptmxmode=0666,mode=620")) ;; Shared memory file system. (file-system (device "tmpfs") (mount-point "/dev/shm") (type "tmpfs") (flags '(no-exec no-suid no-dev)) (options "mode=1777,size=65536k") (needed-for-boot? #t) (create-mount-point? #t) (check? #f)) ;; Message queue file system. (file-system (device "mqueue") (mount-point "/dev/mqueue") (type "mqueue") (flags '(no-exec no-suid no-dev)) (needed-for-boot? #t) (create-mount-point? #t) (check? #f)))) ;;; ;;; Shared file systems, for VMs/containers. ;;; ;; Mapping of host file system SOURCE to mount point TARGET in the guest. (define-record-type* <file-system-mapping> file-system-mapping make-file-system-mapping file-system-mapping? (source file-system-mapping-source) ;string (target file-system-mapping-target) ;string (writable? file-system-mapping-writable? ;Boolean (default #f))) (define (file-system-mapping->bind-mount mapping) "Return a file system that realizes MAPPING, a <file-system-mapping>, using a bind mount." (match mapping (($ <file-system-mapping> source target writable?) (file-system (mount-point target) (device source) (type "none") (flags (if writable? '(bind-mount) '(bind-mount read-only))) (check? #f) (create-mount-point? #t))))) (define %store-mapping ;; Mapping of the host's store into the guest. (file-system-mapping (source (%store-prefix)) (target (%store-prefix)) (writable? #f))) (define %network-configuration-files ;; List of essential network configuration files. '("/etc/resolv.conf" "/etc/nsswitch.conf" "/etc/services" "/etc/hosts")) (define %network-file-mappings ;; List of file mappings for essential network files. (filter-map (lambda (file) (file-system-mapping (source file) (target file) ;; XXX: On some GNU/Linux systems, /etc/resolv.conf is a ;; symlink to a file in a tmpfs which, for an unknown reason, ;; cannot be bind mounted read-only within the container. (writable? (string=? file "/etc/resolv.conf")))) %network-configuration-files)) (define (file-system-type-predicate type) "Return a predicate that, when passed a file system, returns #t if that file system has the given TYPE." (lambda (fs) (string=? (file-system-type fs) type))) (define (file-system-mount-point-predicate mount-point) "Return a predicate that, when passed a file system, returns #t if that file system has the given MOUNT-POINT." (lambda (fs) (string=? (file-system-mount-point fs) mount-point))) ;;; ;;; Btrfs specific helpers. ;;; (define (btrfs-subvolume? fs) "Predicate to check if FS, a file-system object, is a Btrfs subvolume." (and-let* ((btrfs-file-system? (string= "btrfs" (file-system-type fs))) (option-keys (map (match-lambda ((key . value) key) (key key)) (file-system-options->alist (file-system-options fs))))) (find (cut string-prefix? "subvol" <>) option-keys))) (define (btrfs-store-subvolume-file-name file-systems) "Return the subvolume file name within the Btrfs top level onto which the store is located, else #f." (define (prepend-slash/maybe s) (if (string=? "/" (string-take s 1)) s (string-append "/" s))) (and-let* ((btrfs-subvolume-fs (filter btrfs-subvolume? file-systems)) (btrfs-subvolume-fs* (sort btrfs-subvolume-fs (lambda (fs1 fs2) (> (file-name-depth (file-system-mount-point fs1)) (file-name-depth (file-system-mount-point fs2)))))) (store-subvolume-fs (find (lambda (fs) (file-prefix? (file-system-mount-point fs) (%store-prefix))) btrfs-subvolume-fs*)) (options (file-system-options->alist (file-system-options store-subvolume-fs)))) ;; XXX: Deriving the subvolume name based from a subvolume ID is not ;; supported, as we'd need to query the actual file system. (or (and=> (assoc-ref options "subvol") prepend-slash/maybe) (raise (condition (&message (message "The store is on a Btrfs subvolume, but the \ subvolume name is unknown.")) (&fix-hint (hint (G_ "Use the @code{subvol} Btrfs file system option.")))))))) ;;; ;;; Swap space ;;; (define-record-type* <swap-space> swap-space make-swap-space swap-space? this-swap-space (target swap-space-target) (dependencies swap-space-dependencies (default '())) (priority swap-space-priority (default #f)) (discard? swap-space-discard? (default #f))) ;;; file-systems.scm ends here