gnu: Add GNU dmd.
[jackhill/guix/guix.git] / gnu / system / vm.scm
index fedf0ee..68d205d 100644 (file)
 ;;; along with GNU Guix.  If not, see <http://www.gnu.org/licenses/>.
 
 (define-module (gnu system vm)
+  #:use-module (guix config)
   #:use-module (guix store)
   #:use-module (guix derivations)
   #:use-module (guix packages)
-  #:use-module ((gnu packages base) #:select (%final-inputs guile-final))
+  #:use-module ((gnu packages base) #:select (%final-inputs
+                                              guile-final
+                                              coreutils))
+  #:use-module (gnu packages guile)
+  #:use-module (gnu packages bash)
   #:use-module (gnu packages qemu)
   #:use-module (gnu packages parted)
   #:use-module (gnu packages grub)
   #:use-module (gnu packages linux-initrd)
   #:use-module ((gnu packages make-bootstrap)
                 #:select (%guile-static-stripped))
+  #:use-module (gnu packages system)
+
+  #:use-module (gnu system shadow)
+  #:use-module (gnu system linux)
+  #:use-module (gnu system grub)
+
+  #:use-module (srfi srfi-1)
   #:use-module (srfi srfi-26)
   #:use-module (ice-9 match)
+
   #:export (expression->derivation-in-linux-vm
-            qemu-image))
+            qemu-image
+            system-qemu-image))
 
 \f
 ;;; Commentary:
@@ -53,6 +67,7 @@
                                               (%guile-for-build))
 
                                              (make-disk-image? #f)
+                                             (references-graphs #f)
                                              (disk-image-size
                                               (* 100 (expt 2 20))))
   "Evaluate EXP in a QEMU virtual machine running LINUX with INITRD.  In the
@@ -61,13 +76,22 @@ its output files in the `/xchg' directory, which is copied to the derivation's
 output when the VM terminates.
 
 When MAKE-DISK-IMAGE? is true, then create a QEMU disk image of
-DISK-IMAGE-SIZE bytes and return it."
+DISK-IMAGE-SIZE bytes and return it.
+
+When REFERENCES-GRAPHS is true, it must be a list of file name/store path
+pairs, as for `derivation'.  The files containing the reference graphs are
+made available under the /xchg CIFS share."
+  ;; FIXME: Allow use of macros from other modules, as done in
+  ;; `build-expression->derivation'.
+
   (define input-alist
     (map (match-lambda
-          ((input package)
+          ((input (? package? package))
            `(,input . ,(package-output store package "out" system)))
-          ((input package sub-drv)
-           `(,input . ,(package-output store package sub-drv system))))
+          ((input (? package? package) sub-drv)
+           `(,input . ,(package-output store package sub-drv system)))
+          ((input (and (? string?) (? store-path?) file))
+           `(,input . ,file)))
          inputs))
 
   (define exp*
@@ -77,8 +101,10 @@ DISK-IMAGE-SIZE bytes and return it."
 
   (define builder
     ;; Code that launches the VM that evaluates EXP.
-    `(begin
-       (use-modules (guix build utils))
+    `(let ()
+       (use-modules (guix build utils)
+                    (srfi srfi-1)
+                    (ice-9 rdelim))
 
        (let ((out     (assoc-ref %outputs "out"))
              (cu      (string-append (assoc-ref %build-inputs "coreutils")
@@ -104,6 +130,17 @@ DISK-IMAGE-SIZE bytes and return it."
               '(begin))
 
          (mkdir "xchg")
+
+         ;; Copy the reference-graph files under xchg/ so EXP can access it.
+         (begin
+           ,@(match references-graphs
+               (((graph-files . _) ...)
+                (map (lambda (file)
+                       `(copy-file ,file
+                                   ,(string-append "xchg/" file)))
+                     graph-files))
+               (#f '())))
+
          (and (zero?
                (system* qemu "-nographic" "-no-reboot"
                         "-net" "nic,model=e1000"
@@ -134,92 +171,162 @@ DISK-IMAGE-SIZE bytes and return it."
                                     ("coreutils" ,(->drv coreutils))
                                     ("builder" ,user-builder)
                                     ,@(map (match-lambda
-                                            ((name package sub-drv ...)
+                                            ((name (? package? package)
+                                                   sub-drv ...)
                                              `(,name ,(->drv package)
-                                                     ,@sub-drv)))
+                                                     ,@sub-drv))
+                                            ((name (? string? file))
+                                             `(,name ,file)))
                                            inputs))
                                   #:env-vars env-vars
-                                  #:modules `((guix build utils)
-                                              ,@modules)
-                                  #:guile-for-build guile-for-build)))
+                                  #:modules (delete-duplicates
+                                             `((guix build utils)
+                                               ,@modules))
+                                  #:guile-for-build guile-for-build
+                                  #:references-graphs references-graphs)))
 
 (define* (qemu-image store #:key
                      (name "qemu-image")
                      (system (%current-system))
                      (disk-image-size (* 100 (expt 2 20)))
-                     (linux linux-libre)
-                     (initrd qemu-initrd)
-                     (inputs '()))
-  "Return a bootable, stand-alone QEMU image."
+                     grub-configuration
+                     (populate #f)
+                     (inputs '())
+                     (inputs-to-copy '()))
+  "Return a bootable, stand-alone QEMU image.  The returned image is a full
+disk image, with a GRUB installation that uses GRUB-CONFIGURATION as its
+configuration file.
+
+INPUTS-TO-COPY is a list of inputs (as for packages) whose closure is copied
+into the image being built.
+
+When POPULATE is true, it must be the store file name of a Guile script to run
+in the disk image partition once it has been populated with INPUTS-TO-COPY.
+It can be used to provide additional files, such as /etc files."
+  (define input->name+derivation
+    (match-lambda
+     ((name (? package? package))
+      `(,name . ,(derivation->output-path
+                  (package-derivation store package system))))
+     ((name (? package? package) sub-drv)
+      `(,name . ,(derivation->output-path
+                  (package-derivation store package system)
+                  sub-drv)))
+     ((input (and (? string?) (? store-path?) file))
+      `(,input . ,file))))
+
   (expression->derivation-in-linux-vm
    store "qemu-image"
-   `(let ((parted  (string-append (assoc-ref %build-inputs "parted")
-                                  "/sbin/parted"))
-          (mkfs    (string-append (assoc-ref %build-inputs "e2fsprogs")
-                                  "/sbin/mkfs.ext3"))
-          (grub    (string-append (assoc-ref %build-inputs "grub")
-                                  "/sbin/grub-install"))
-          (umount  (string-append (assoc-ref %build-inputs "util-linux")
-                                  "/bin/umount")) ; XXX: add to Guile
-          (initrd  (string-append (assoc-ref %build-inputs "initrd")
-                                  "/initrd"))
-          (linux   (string-append (assoc-ref %build-inputs "linux")
-                                  "/bzImage"))
-          (makedev (lambda (major minor)
-                     (+ (* major 256) minor))))
-
-      ;; GRUB is full of shell scripts.
-      (setenv "PATH"
-              (string-append (dirname grub) ":"
-                             (assoc-ref %build-inputs "coreutils") "/bin:"
-                             (assoc-ref %build-inputs "findutils") "/bin:"
-                             (assoc-ref %build-inputs "sed") "/bin:"
-                             (assoc-ref %build-inputs "grep") "/bin:"
-                             (assoc-ref %build-inputs "gawk") "/bin"))
-
-      (display "creating partition table...\n")
-      (mknod "/dev/vda" 'block-special #o644 (makedev 8 0))
-      (and (zero? (system* parted "/dev/vda" "mklabel" "msdos"
-                           "mkpart" "primary" "ext2" "1MiB"
-                           ,(format #f "~aB"
-                                    (- disk-image-size
-                                       (* 5 (expt 2 20))))))
-           (begin
-             (display "creating ext3 partition...\n")
-             (mknod "/dev/vda1" 'block-special #o644 (makedev 8 1))
-             (and (zero? (system* mkfs "-F" "/dev/vda1"))
-                  (begin
-                    (display "mounting partition...\n")
-                    (mkdir "/fs")
-                    (mount "/dev/vda1" "/fs" "ext3")
-                    (mkdir "/fs/boot")
-                    (mkdir "/fs/boot/grub")
-                    (copy-file linux "/fs/boot/bzImage")
-                    (copy-file initrd "/fs/boot/initrd")
-                    (call-with-output-file "/fs/boot/grub/grub.cfg"
-                      (lambda (p)
-                        (display "
-set default=1
-set timeout=5
-search.file /boot/bzImage
-
-menuentry \"Boot-to-Guile! (GNU System technology preview)\" {
-  linux /boot/bzImage --repl
-  initrd /boot/initrd
-}" p)))
-                    (and (zero?
-                          (system* grub "--no-floppy"
-                                   "--boot-directory" "/fs/boot"
-                                   "/dev/vda"))
-                         (zero?
-                          (system* umount "/fs"))
-                         (reboot)))))))
+   `(let ()
+      (use-modules (ice-9 rdelim)
+                   (srfi srfi-1)
+                   (guix build utils)
+                   (guix build linux-initrd))
+
+      (let ((parted  (string-append (assoc-ref %build-inputs "parted")
+                                    "/sbin/parted"))
+            (mkfs    (string-append (assoc-ref %build-inputs "e2fsprogs")
+                                    "/sbin/mkfs.ext3"))
+            (grub    (string-append (assoc-ref %build-inputs "grub")
+                                    "/sbin/grub-install"))
+            (umount  (string-append (assoc-ref %build-inputs "util-linux")
+                                    "/bin/umount")) ; XXX: add to Guile
+            (grub.cfg (assoc-ref %build-inputs "grub.cfg")))
+
+        (define (read-reference-graph port)
+          ;; Return a list of store paths from the reference graph at PORT.
+          ;; The data at PORT is the format produced by #:references-graphs.
+          (let loop ((line   (read-line port))
+                     (result '()))
+            (cond ((eof-object? line)
+                   (delete-duplicates result))
+                  ((string-prefix? "/" line)
+                   (loop (read-line port)
+                         (cons line result)))
+                  (else
+                   (loop (read-line port)
+                         result)))))
+
+        (define (things-to-copy)
+          ;; Return the list of store files to copy to the image.
+          (define (graph-from-file file)
+            (call-with-input-file file
+              read-reference-graph))
+
+          ,(match inputs-to-copy
+             (((graph-files . _) ...)
+              `(let* ((graph-files ',(map (cut string-append "/xchg/" <>)
+                                          graph-files))
+                      (paths       (append-map graph-from-file graph-files)))
+                 (delete-duplicates paths)))
+             (#f ''())))
+
+        ;; GRUB is full of shell scripts.
+        (setenv "PATH"
+                (string-append (dirname grub) ":"
+                               (assoc-ref %build-inputs "coreutils") "/bin:"
+                               (assoc-ref %build-inputs "findutils") "/bin:"
+                               (assoc-ref %build-inputs "sed") "/bin:"
+                               (assoc-ref %build-inputs "grep") "/bin:"
+                               (assoc-ref %build-inputs "gawk") "/bin"))
+
+        (display "creating partition table...\n")
+        (and (zero? (system* parted "/dev/vda" "mklabel" "msdos"
+                             "mkpart" "primary" "ext2" "1MiB"
+                             ,(format #f "~aB"
+                                      (- disk-image-size
+                                         (* 5 (expt 2 20))))))
+             (begin
+               (display "creating ext3 partition...\n")
+               (and (zero? (system* mkfs "-F" "/dev/vda1"))
+                    (begin
+                      (display "mounting partition...\n")
+                      (mkdir "/fs")
+                      (mount "/dev/vda1" "/fs" "ext3")
+                      (mkdir-p "/fs/boot/grub")
+                      (symlink grub.cfg "/fs/boot/grub/grub.cfg")
+
+                      ;; Populate the image's store.
+                      (mkdir-p (string-append "/fs" ,%store-directory))
+                      (for-each (lambda (thing)
+                                  (copy-recursively thing
+                                                    (string-append "/fs"
+                                                                   thing)))
+                                (cons grub.cfg (things-to-copy)))
+
+                      ;; Populate /dev.
+                      (make-essential-device-nodes #:root "/fs")
+
+                      (and=> (assoc-ref %build-inputs "populate")
+                             (lambda (populate)
+                               (chdir "/fs")
+                               (primitive-load populate)
+                               (chdir "/")))
+
+                      (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
+                                    ;; /nix/store, which is the host,
+                                    ;; read-only store.
+                                    (unless (eq? (stat:type s) 'symlink)
+                                      (utime file 0 0 0 0))))
+                                (find-files "/fs" ".*"))
+
+                      (and (zero?
+                            (system* grub "--no-floppy"
+                                     "--boot-directory" "/fs/boot"
+                                     "/dev/vda"))
+                           (zero? (system* umount "/fs"))
+                           (reboot))))))))
    #:system system
    #:inputs `(("parted" ,parted)
               ("grub" ,grub)
               ("e2fsprogs" ,e2fsprogs)
-              ("linux" ,linux-libre)
-              ("initrd" ,qemu-initrd)
+              ("grub.cfg" ,grub-configuration)
 
               ;; For shell scripts.
               ("sed" ,(car (assoc-ref %final-inputs "sed")))
@@ -227,41 +334,101 @@ menuentry \"Boot-to-Guile! (GNU System technology preview)\" {
               ("coreutils" ,(car (assoc-ref %final-inputs "coreutils")))
               ("findutils" ,(car (assoc-ref %final-inputs "findutils")))
               ("gawk" ,(car (assoc-ref %final-inputs "gawk")))
-              ("util-linux" ,util-linux))
+              ("util-linux" ,util-linux)
+
+              ,@(if populate
+                    `(("populate" ,populate))
+                    '())
+
+              ,@inputs-to-copy)
    #:make-disk-image? #t
-   #:disk-image-size disk-image-size))
+   #:disk-image-size disk-image-size
+   #:references-graphs (map input->name+derivation inputs-to-copy)
+   #:modules '((guix build utils)
+               (guix build linux-initrd))))
 
 \f
 ;;;
-;;; Guile 2.0 potluck examples.
+;;; Stand-alone VM image.
 ;;;
 
-(define (example1)
-  (let ((store #f))
-    (dynamic-wind
-      (lambda ()
-        (set! store (open-connection)))
-      (lambda ()
-        (parameterize ((%guile-for-build (package-derivation store guile-final)))
-          (expression->derivation-in-linux-vm
-           store "vm-test"
-           '(begin
-              (display "hello from boot!\n")
-              (call-with-output-file "/xchg/hello"
-                (lambda (p)
-                  (display "world" p)))))))
-      (lambda ()
-        (close-connection store)))))
-
-(define (example2)
-  (let ((store #f))
-    (dynamic-wind
-      (lambda ()
-        (set! store (open-connection)))
-      (lambda ()
-        (parameterize ((%guile-for-build (package-derivation store guile-final)))
-          (qemu-image store #:disk-image-size (* 30 (expt 2 20)))))
-      (lambda ()
-        (close-connection store)))))
+(define (system-qemu-image store)
+  "Return the derivation of a QEMU image of the GNU system."
+  (define %pam-services
+    ;; Services known to PAM.
+    (list %pam-other-services
+          (unix-pam-service "login" #:allow-empty-passwords? #t)))
+
+  (parameterize ((%guile-for-build (package-derivation store guile-final)))
+    (let* ((bash-drv  (package-derivation store bash))
+           (bash-file (string-append (derivation->output-path bash-drv)
+                                     "/bin/bash"))
+           (accounts  (list (vector "root" "" 0 0 "System administrator"
+                                    "/" bash-file)))
+           (passwd    (passwd-file store accounts))
+           (shadow    (passwd-file store accounts #:shadow? #t))
+           (pam.d-drv (pam-services->directory store %pam-services))
+           (pam.d     (derivation->output-path pam.d-drv))
+           (populate
+            (add-text-to-store store "populate-qemu-image"
+                               (object->string
+                                `(begin
+                                   (mkdir-p "etc")
+                                   (symlink ,shadow "etc/shadow")
+                                   (symlink ,passwd "etc/passwd")
+                                   (symlink "/dev/null"
+                                            "etc/login.defs")
+                                   (symlink ,pam.d "etc/pam.d")
+                                   (mkdir-p "var/run")))
+                               (list passwd)))
+           (out     (derivation->output-path
+                     (package-derivation store mingetty)))
+           (getty   (string-append out "/sbin/mingetty"))
+           (iu-drv  (package-derivation store inetutils))
+           (syslogd (string-append (derivation->output-path iu-drv)
+                                   "/libexec/syslogd"))
+           (boot  (add-text-to-store store "boot"
+                                     (object->string
+                                      `(begin
+                                         ;; Become the session leader,
+                                         ;; so that mingetty can do
+                                         ;; 'TIOCSCTTY'.
+                                         (setsid)
+
+                                         (when (zero? (primitive-fork))
+                                           (format #t "starting syslogd as ~a~%"
+                                                   (getpid))
+                                           (execl ,syslogd "syslogd"))
+
+                                         ;; Directly into mingetty. XXX
+                                         ;; (execl ,getty "mingetty"
+                                         ;;        "--noclear" "tty1")
+                                         (execl ,bash-file "bash")))
+                                     (list out)))
+           (entries  (list (menu-entry
+                            (label "Boot-to-Guile! (GNU System technology preview)")
+                            (linux linux-libre)
+                            (linux-arguments `("--root=/dev/vda1"
+                                               ,(string-append "--load=" boot)))
+                            (initrd gnu-system-initrd))))
+           (grub.cfg (grub-configuration-file store entries)))
+      (build-derivations store (list pam.d-drv))
+      (qemu-image store
+                  #:grub-configuration grub.cfg
+                  #:populate populate
+                  #:disk-image-size (* 400 (expt 2 20))
+                  #:inputs-to-copy `(("boot" ,boot)
+                                     ("linux" ,linux-libre)
+                                     ("initrd" ,gnu-system-initrd)
+                                     ("coreutils" ,coreutils)
+                                     ("bash" ,bash)
+                                     ("guile" ,guile-2.0)
+                                     ("mingetty" ,mingetty)
+                                     ("inetutils" ,inetutils)
+
+                                     ;; Configuration.
+                                     ("etc-pam.d" ,pam.d)
+                                     ("etc-passwd" ,passwd)
+                                     ("etc-shadow" ,shadow))))))
 
 ;;; vm.scm ends here