[jackhill/guix/guix.git] / gnu / system / vm.scm

;;; GNU Guix --- Functional package management for GNU
;;; Copyright © 2013, 2014 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 system vm)
  #:use-module (guix config)
  #:use-module (guix store)
  #:use-module (guix gexp)
  #:use-module (guix derivations)
  #:use-module (guix packages)
  #:use-module (guix monads)
  #:use-module ((gnu build vm)
                #:select (qemu-command))
  #:use-module (gnu packages base)
  #:use-module (gnu packages guile)
  #:use-module (gnu packages gawk)
  #:use-module (gnu packages bash)
  #:use-module (gnu packages less)
  #:use-module (gnu packages qemu)
  #:use-module (gnu packages disk)
  #:use-module (gnu packages zile)
  #:use-module (gnu packages grub)
  #:use-module (gnu packages linux)
  #:use-module (gnu packages package-management)
  #:use-module ((gnu packages make-bootstrap)
                #:select (%guile-static-stripped))
  #:use-module (gnu packages admin)

  #:use-module (gnu system shadow)
  #:use-module (gnu system linux)
  #:use-module (gnu system linux-initrd)
  #:use-module (gnu system grub)
  #:use-module (gnu system file-systems)
  #:use-module (gnu system)
  #:use-module (gnu services)

  #:use-module (srfi srfi-1)
  #:use-module (srfi srfi-26)
  #:use-module (ice-9 match)

  #:export (expression->derivation-in-linux-vm
            qemu-image
            system-qemu-image
            system-qemu-image/shared-store
            system-qemu-image/shared-store-script
            system-disk-image))

\f
;;; Commentary:
;;;
;;; Tools to evaluate build expressions within virtual machines.
;;;
;;; Code:

(define %linux-vm-file-systems
  ;; File systems mounted for 'derivation-in-linux-vm'.  The store and /xchg
  ;; directory are shared with the host over 9p.
  (list (file-system
          (mount-point (%store-prefix))
          (device "store")
          (type "9p")
          (needed-for-boot? #t)
          (options "trans=virtio")
          (check? #f))
        (file-system
          (mount-point "/xchg")
          (device "xchg")
          (type "9p")
          (needed-for-boot? #t)
          (options "trans=virtio")
          (check? #f))))

(define* (expression->derivation-in-linux-vm name exp
                                             #:key
                                             (system (%current-system))
                                             (linux linux-libre)
                                             initrd
                                             (qemu qemu-headless)
                                             (env-vars '())
                                             (modules
                                              '((gnu build vm)
                                                (gnu build install)
                                                (gnu build linux-boot)
                                                (gnu build file-systems)
                                                (guix build utils)
                                                (guix build store-copy)))
                                             (guile-for-build
                                              (%guile-for-build))

                                             (make-disk-image? #f)
                                             (references-graphs #f)
                                             (memory-size 256)
                                             (disk-image-format "qcow2")
                                             (disk-image-size
                                              (* 100 (expt 2 20))))
  "Evaluate EXP in a QEMU virtual machine running LINUX with INITRD (a
derivation).  In the virtual machine, EXP has access to all its inputs from the
store; it should put its output files in the `/xchg' directory, which is
copied to the derivation's output when the VM terminates.  The virtual machine
runs with MEMORY-SIZE MiB of memory.

When MAKE-DISK-IMAGE? is true, then create a QEMU disk image of type
DISK-IMAGE-FORMAT (e.g., 'qcow2' or 'raw'), of DISK-IMAGE-SIZE bytes and
return it.

MODULES is the set of modules imported in the execution environment of EXP.

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."
  (mlet* %store-monad
      ((module-dir   (imported-modules modules))
       (compiled     (compiled-modules modules))
       (user-builder (gexp->file "builder-in-linux-vm" exp))
       (loader       (gexp->file "linux-vm-loader"
                                 #~(begin
                                     (set! %load-path
                                           (cons #$module-dir %load-path))
                                     (set! %load-compiled-path
                                           (cons #$compiled
                                                 %load-compiled-path))
                                     (primitive-load #$user-builder))))
       (coreutils -> (canonical-package coreutils))
       (initrd       (if initrd                   ; use the default initrd?
                         (return initrd)
                         (base-initrd %linux-vm-file-systems
                                      #:virtio? #t
                                      #:qemu-networking? #t))))

    (define builder
      ;; Code that launches the VM that evaluates EXP.
      #~(begin
          (use-modules (guix build utils)
                       (gnu build vm))

          (let ((inputs  '#$(list qemu coreutils))
                (linux   (string-append #$linux "/bzImage"))
                (initrd  (string-append #$initrd "/initrd"))
                (loader  #$loader)
                (graphs  '#$(match references-graphs
                              (((graph-files . _) ...) graph-files)
                              (_ #f))))

            (set-path-environment-variable "PATH" '("bin") inputs)

            (load-in-linux-vm loader
                              #:output #$output
                              #:linux linux #:initrd initrd
                              #:memory-size #$memory-size
                              #:make-disk-image? #$make-disk-image?
                              #:disk-image-format #$disk-image-format
                              #:disk-image-size #$disk-image-size
                              #:references-graphs graphs))))

    (gexp->derivation name builder
                      ;; TODO: Require the "kvm" feature.
                      #:system system
                      #:env-vars env-vars
                      #:modules modules
                      #:guile-for-build guile-for-build
                      #:references-graphs references-graphs)))

(define* (qemu-image #:key
                     (name "qemu-image")
                     (system (%current-system))
                     (qemu qemu-headless)
                     (disk-image-size (* 100 (expt 2 20)))
                     (disk-image-format "qcow2")
                     (file-system-type "ext4")
                     file-system-label
                     os-derivation
                     grub-configuration
                     (register-closures? #t)
                     (inputs '())
                     copy-inputs?)
  "Return a bootable, stand-alone QEMU image of type DISK-IMAGE-FORMAT (e.g.,
'qcow2' or 'raw'), with a root partition of type FILE-SYSTEM-TYPE.
Optionally, FILE-SYSTEM-LABEL can be specified as the volume name for the root
partition.  The returned image is a full disk image that runs OS-DERIVATION,
with a GRUB installation that uses GRUB-CONFIGURATION as its configuration
file (GRUB-CONFIGURATION must be the name of a file in the VM.)

INPUTS is a list of inputs (as for packages).  When COPY-INPUTS? is true, copy
all of INPUTS into the image being built.  When REGISTER-CLOSURES? is true,
register INPUTS in the store database of the image so that Guix can be used in
the image."
  (expression->derivation-in-linux-vm
   name
   #~(begin
       (use-modules (gnu build vm)
                    (guix build utils))

       (let ((inputs
              '#$(append (list qemu parted grub e2fsprogs util-linux)
                         (map canonical-package
                              (list sed grep coreutils findutils gawk))
                         (if register-closures? (list guix) '())))

             ;; This variable is unused but allows us to add INPUTS-TO-COPY
             ;; as inputs.
             (to-register
              '#$(map (match-lambda
                       ((name thing) thing)
                       ((name thing output) `(,thing ,output)))
                      inputs)))

         (set-path-environment-variable "PATH" '("bin" "sbin") inputs)

         (let ((graphs '#$(match inputs
                            (((names . _) ...)
                             names))))
           (initialize-hard-disk "/dev/vda"
                                 #:system-directory #$os-derivation
                                 #:grub.cfg #$grub-configuration
                                 #:closures graphs
                                 #:copy-closures? #$copy-inputs?
                                 #:register-closures? #$register-closures?
                                 #:disk-image-size #$disk-image-size
                                 #:file-system-type #$file-system-type
                                 #:file-system-label #$file-system-label)
           (reboot))))
   #:system system
   #:make-disk-image? #t
   #:disk-image-size disk-image-size
   #:disk-image-format disk-image-format
   #:references-graphs inputs))

\f
;;;
;;; VM and disk images.
;;;

(define* (system-disk-image os
                            #:key
                            (name "disk-image")
                            (file-system-type "ext4")
                            (disk-image-size (* 900 (expt 2 20)))
                            (volatile? #t))
  "Return the derivation of a disk image of DISK-IMAGE-SIZE bytes of the
system described by OS.  Said image can be copied on a USB stick as is.  When
VOLATILE? is true, the root file system is made volatile; this is useful
to USB sticks meant to be read-only."
  (define root-label
    ;; Volume name of the root file system.  Since we don't know which device
    ;; will hold it, we use the volume name to find it (using the UUID would
    ;; be even better, but somewhat less convenient.)
    "gnu-disk-image")

  (define file-systems-to-keep
    (remove (lambda (fs)
              (string=? (file-system-mount-point fs) "/"))
            (operating-system-file-systems os)))

  (let ((os (operating-system (inherit os)
              ;; Since this is meant to be used on real hardware, don't
              ;; install QEMU networking or anything like that, but make sure
              ;; USB mass storage devices are available.
              (initrd (lambda (file-systems . rest)
                        (apply base-initrd file-systems
                               #:volatile-root? #t
                               #:extra-modules '("usb-storage.ko")
                               rest)))

              ;; Force our own root file system.
              (file-systems (cons (file-system
                                    (mount-point "/")
                                    (device root-label)
                                    (title 'label)
                                    (type file-system-type))
                                  file-systems-to-keep)))))

    (mlet* %store-monad ((os-drv   (operating-system-derivation os))
                         (grub.cfg (operating-system-grub.cfg os)))
      (qemu-image #:name name
                  #:os-derivation os-drv
                  #:grub-configuration grub.cfg
                  #:disk-image-size disk-image-size
                  #:disk-image-format "raw"
                  #:file-system-type file-system-type
                  #:file-system-label root-label
                  #:copy-inputs? #t
                  #:register-closures? #t
                  #:inputs `(("system" ,os-drv)
                             ("grub.cfg" ,grub.cfg))))))

(define* (system-qemu-image os
                            #:key
                            (file-system-type "ext4")
                            (disk-image-size (* 900 (expt 2 20))))
  "Return the derivation of a freestanding QEMU image of DISK-IMAGE-SIZE bytes
of the GNU system as described by OS."
  (define file-systems-to-keep
    ;; Keep only file systems other than root and not normally bound to real
    ;; devices.
    (remove (lambda (fs)
              (let ((target (file-system-mount-point fs))
                    (source (file-system-device fs)))
                (or (string=? target "/")
                    (string-prefix? "/dev/" source))))
            (operating-system-file-systems os)))

  (let ((os (operating-system (inherit os)
              ;; Use an initrd with the whole QEMU shebang.
              (initrd (lambda (file-systems . rest)
                        (apply base-initrd file-systems
                               #:virtio? #t
                               #:qemu-networking? #t
                               rest)))

              ;; Force our own root file system.
              (file-systems (cons (file-system
                                    (mount-point "/")
                                    (device "/dev/sda1")
                                    (type file-system-type))
                                  file-systems-to-keep)))))
    (mlet* %store-monad
        ((os-drv      (operating-system-derivation os))
         (grub.cfg    (operating-system-grub.cfg os)))
      (qemu-image  #:os-derivation os-drv
                   #:grub-configuration grub.cfg
                   #:disk-image-size disk-image-size
                   #:file-system-type file-system-type
                   #:inputs `(("system" ,os-drv)
                              ("grub.cfg" ,grub.cfg))
                   #:copy-inputs? #t))))

(define (virtualized-operating-system os)
  "Return an operating system based on OS suitable for use in a virtualized
environment with the store shared with the host."
  (operating-system (inherit os)
    (initrd (lambda (file-systems . rest)
              (apply base-initrd file-systems
                     #:volatile-root? #t
                     #:virtio? #t
                     #:qemu-networking? #t
                     rest)))

    ;; Disable swap.
    (swap-devices '())

    (file-systems (cons* (file-system
                           (mount-point "/")
                           (device "/dev/vda1")
                           (type "ext4"))
                         (file-system
                           (mount-point (%store-prefix))
                           (device "store")
                           (type "9p")
                           (needed-for-boot? #t)
                           (options "trans=virtio")
                           (check? #f))

                         ;; Remove file systems that conflict with those
                         ;; above, or that are normally bound to real devices.
                         (remove (lambda (fs)
                                   (let ((target (file-system-mount-point fs))
                                         (source (file-system-device fs)))
                                     (or (string=? target (%store-prefix))
                                         (string=? target "/")
                                         (string-prefix? "/dev/" source))))
                                 (operating-system-file-systems os))))))

(define* (system-qemu-image/shared-store
          os
          #:key
          full-boot?
          (disk-image-size (* (if full-boot? 500 15) (expt 2 20))))
  "Return a derivation that builds a QEMU image of OS that shares its store
with the host.

When FULL-BOOT? is true, return an image that does a complete boot sequence,
bootloaded included; thus, make a disk image that contains everything the
bootloader refers to: OS kernel, initrd, bootloader data, etc."
  (mlet* %store-monad ((os-drv   (operating-system-derivation os))
                       (grub.cfg (operating-system-grub.cfg os)))
    ;; XXX: When FULL-BOOT? is true, we end up creating an image that contains
    ;; GRUB.CFG and all its dependencies, including the output of OS-DRV.
    ;; This is more than needed (we only need the kernel, initrd, GRUB for its
    ;; font, and the background image), but it's hard to filter that.
    (qemu-image #:os-derivation os-drv
                #:grub-configuration grub.cfg
                #:disk-image-size disk-image-size
                #:inputs (if full-boot?
                             `(("grub.cfg" ,grub.cfg))
                             '())

                ;; XXX: Passing #t here is too slow, so let it off by default.
                #:register-closures? #f
                #:copy-inputs? full-boot?)))

(define* (common-qemu-options image)
  "Return the a string-value gexp with the common QEMU options to boot IMAGE."
#~(string-append
     " -enable-kvm -no-reboot -net nic,model=virtio \
  -virtfs local,path=" #$(%store-prefix) ",security_model=none,mount_tag=store \
  -net user \
  -serial stdio \
  -drive file=" #$image
  ",if=virtio,cache=writeback,werror=report,readonly \
  -m 256"))

(define* (system-qemu-image/shared-store-script os
                                                #:key
                                                (qemu qemu)
                                                (graphic? #t)
                                                full-boot?
                                                (disk-image-size
                                                 (* (if full-boot? 500 15)
                                                    (expt 2 20))))
  "Return a derivation that builds a script to run a virtual machine image of
OS that shares its store with the host.

When FULL-BOOT? is true, the returned script runs everything starting from the
bootloader; otherwise it directly starts the operating system kernel.  The
DISK-IMAGE-SIZE parameter specifies the size in bytes of the root disk image;
it is mostly useful when FULL-BOOT?  is true."
  (mlet* %store-monad ((os ->  (virtualized-operating-system os))
                       (os-drv (operating-system-derivation os))
                       (image  (system-qemu-image/shared-store
                                os
                                #:full-boot? full-boot?
                                #:disk-image-size disk-image-size)))
    (define builder
      #~(call-with-output-file #$output
          (lambda (port)
            (display
             (string-append "#!" #$bash "/bin/sh
exec " #$qemu "/bin/" #$(qemu-command (%current-system))

#$@(if full-boot?
       #~()
       #~(" -kernel " #$(operating-system-kernel os) "/bzImage \
            -initrd " #$os-drv "/initrd \
            -append \"" #$(if graphic? "" "console=ttyS0 ")
            "--system=" #$os-drv " --load=" #$os-drv "/boot --root=/dev/vda1\" "))
#$(common-qemu-options image)
" \"$@\"\n")
             port)
            (chmod port #o555))))

    (gexp->derivation "run-vm.sh" builder)))

;;; vm.scm ends here
Commit	Line	Data
04086015	1	;;; GNU Guix --- Functional package management for GNU
735c6dd7	2	;;; Copyright © 2013, 2014 Ludovic Courtès <ludo@gnu.org>
04086015 LC	3	;;;
	4	;;; This file is part of GNU Guix.
	5	;;;
	6	;;; GNU Guix is free software; you can redistribute it and/or modify it
	7	;;; under the terms of the GNU General Public License as published by
	8	;;; the Free Software Foundation; either version 3 of the License, or (at
	9	;;; your option) any later version.
	10	;;;
	11	;;; GNU Guix is distributed in the hope that it will be useful, but
	12	;;; WITHOUT ANY WARRANTY; without even the implied warranty of
	13	;;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
	14	;;; GNU General Public License for more details.
	15	;;;
	16	;;; You should have received a copy of the GNU General Public License
	17	;;; along with GNU Guix. If not, see <http://www.gnu.org/licenses/>.
	18
	19	(define-module (gnu system vm)
93d44bd8	20	#:use-module (guix config)
04086015	21	#:use-module (guix store)
02100028	22	#:use-module (guix gexp)
04086015 LC	23	#:use-module (guix derivations)
04086015 LC	24	#:use-module (guix packages)
d9f0a237	25	#:use-module (guix monads)
548f7a8f	26	#:use-module ((gnu build vm)
66670cf3	27	#:select (qemu-command))
bdb36958	28	#:use-module (gnu packages base)
1b89a66e	29	#:use-module (gnu packages guile)
bdb36958	30	#:use-module (gnu packages gawk)
1b89a66e	31	#:use-module (gnu packages bash)
4f62d8d6	32	#:use-module (gnu packages less)
04086015	33	#:use-module (gnu packages qemu)
cc4a2aeb	34	#:use-module (gnu packages disk)
5b16ff09	35	#:use-module (gnu packages zile)
04086015 LC	36	#:use-module (gnu packages grub)
04086015 LC	37	#:use-module (gnu packages linux)
30f25b03	38	#:use-module (gnu packages package-management)
04086015 LC	39	#:use-module ((gnu packages make-bootstrap)
04086015 LC	40	#:select (%guile-static-stripped))
9de46ffb	41	#:use-module (gnu packages admin)
0ded70f3 LC	42
	43	#:use-module (gnu system shadow)
	44	#:use-module (gnu system linux)
735c6dd7	45	#:use-module (gnu system linux-initrd)
0ded70f3	46	#:use-module (gnu system grub)
c5df1839	47	#:use-module (gnu system file-systems)
033adfe7	48	#:use-module (gnu system)
db4fdc04	49	#:use-module (gnu services)
0ded70f3	50
ca85d7bc	51	#:use-module (srfi srfi-1)
04086015 LC	52	#:use-module (srfi srfi-26)
04086015 LC	53	#:use-module (ice-9 match)
0ded70f3	54
04086015	55	#:export (expression->derivation-in-linux-vm
aedb72fb	56	qemu-image
fd3bfc44 LC	57	system-qemu-image
fd3bfc44 LC	58	system-qemu-image/shared-store
1e77fedb LC	59	system-qemu-image/shared-store-script
1e77fedb LC	60	system-disk-image))
04086015 LC	61
	62	\f
	63	;;; Commentary:
	64	;;;
	65	;;; Tools to evaluate build expressions within virtual machines.
	66	;;;
	67	;;; Code:
	68
83bcd0b8 LC	69	(define %linux-vm-file-systems
	70	;; File systems mounted for 'derivation-in-linux-vm'. The store and /xchg
	71	;; directory are shared with the host over 9p.
	72	(list (file-system
	73	(mount-point (%store-prefix))
	74	(device "store")
	75	(type "9p")
	76	(needed-for-boot? #t)
3c05b4bc LC	77	(options "trans=virtio")
3c05b4bc LC	78	(check? #f))
83bcd0b8 LC	79	(file-system
	80	(mount-point "/xchg")
	81	(device "xchg")
	82	(type "9p")
	83	(needed-for-boot? #t)
3c05b4bc LC	84	(options "trans=virtio")
3c05b4bc LC	85	(check? #f))))
83bcd0b8	86
d9f0a237	87	(define* (expression->derivation-in-linux-vm name exp
04086015	88	#:key
2455085a	89	(system (%current-system))
04086015	90	(linux linux-libre)
735c6dd7	91	initrd
f200b03e	92	(qemu qemu-headless)
04086015	93	(env-vars '())
1aa0033b	94	(modules
548f7a8f LC	95	'((gnu build vm)
548f7a8f LC	96	(gnu build install)
8a9e21d1	97	(gnu build linux-boot)
e2f4b305	98	(gnu build file-systems)
6fd1a796 LC	99	(guix build utils)
6fd1a796 LC	100	(guix build store-copy)))
04086015 LC	101	(guile-for-build
	102	(%guile-for-build))
	103
	104	(make-disk-image? #f)
ca85d7bc	105	(references-graphs #f)
defa1b9b	106	(memory-size 256)
c4a74364	107	(disk-image-format "qcow2")
04086015 LC	108	(disk-image-size
04086015 LC	109	(* 100 (expt 2 20))))
735c6dd7	110	"Evaluate EXP in a QEMU virtual machine running LINUX with INITRD (a
1aa0033b	111	derivation). In the virtual machine, EXP has access to all its inputs from the
735c6dd7	112	store; it should put its output files in the `/xchg' directory, which is
defa1b9b LC	113	copied to the derivation's output when the VM terminates. The virtual machine
defa1b9b LC	114	runs with MEMORY-SIZE MiB of memory.
04086015	115
c4a74364 LC	116	When MAKE-DISK-IMAGE? is true, then create a QEMU disk image of type
	117	DISK-IMAGE-FORMAT (e.g., 'qcow2' or 'raw'), of DISK-IMAGE-SIZE bytes and
	118	return it.
ca85d7bc	119
1aa0033b	120	MODULES is the set of modules imported in the execution environment of EXP.
ade5ce7a	121
ca85d7bc LC	122	When REFERENCES-GRAPHS is true, it must be a list of file name/store path
	123	pairs, as for `derivation'. The files containing the reference graphs are
	124	made available under the /xchg CIFS share."
d9f0a237	125	(mlet* %store-monad
1aa0033b LC	126	((module-dir (imported-modules modules))
	127	(compiled (compiled-modules modules))
	128	(user-builder (gexp->file "builder-in-linux-vm" exp))
02100028 LC	129	(loader (gexp->file "linux-vm-loader"
	130	#~(begin
	131	(set! %load-path
	132	(cons #$module-dir %load-path))
	133	(set! %load-compiled-path
	134	(cons #$compiled
	135	%load-compiled-path))
	136	(primitive-load #$user-builder))))
bdb36958	137	(coreutils -> (canonical-package coreutils))
d4254711	138	(initrd (if initrd ; use the default initrd?
735c6dd7	139	(return initrd)
060238ae	140	(base-initrd %linux-vm-file-systems
24e0160a	141	#:virtio? #t
6c1df081	142	#:qemu-networking? #t))))
1aa0033b LC	143
	144	(define builder
	145	;; Code that launches the VM that evaluates EXP.
	146	#~(begin
	147	(use-modules (guix build utils)
548f7a8f	148	(gnu build vm))
1aa0033b LC	149
	150	(let ((inputs '#$(list qemu coreutils))
	151	(linux (string-append #$linux "/bzImage"))
	152	(initrd (string-append #$initrd "/initrd"))
	153	(loader #$loader)
	154	(graphs '#$(match references-graphs
	155	(((graph-files . _) ...) graph-files)
	156	(_ #f))))
	157
	158	(set-path-environment-variable "PATH" '("bin") inputs)
	159
	160	(load-in-linux-vm loader
	161	#:output #$output
	162	#:linux linux #:initrd initrd
	163	#:memory-size #$memory-size
	164	#:make-disk-image? #$make-disk-image?
c4a74364	165	#:disk-image-format #$disk-image-format
1aa0033b LC	166	#:disk-image-size #$disk-image-size
	167	#:references-graphs graphs))))
	168
	169	(gexp->derivation name builder
	170	;; TODO: Require the "kvm" feature.
	171	#:system system
	172	#:env-vars env-vars
5ce3defe	173	#:modules modules
1aa0033b LC	174	#:guile-for-build guile-for-build
1aa0033b LC	175	#:references-graphs references-graphs)))
d9f0a237 LC	176
d9f0a237 LC	177	(define* (qemu-image #:key
04086015 LC	178	(name "qemu-image")
04086015 LC	179	(system (%current-system))
1aa0033b	180	(qemu qemu-headless)
04086015	181	(disk-image-size (* 100 (expt 2 20)))
c4a74364	182	(disk-image-format "qcow2")
03ddfaf5	183	(file-system-type "ext4")
ef9fc40d	184	file-system-label
f2c403ea	185	os-derivation
0e2ddecd	186	grub-configuration
150e20dd	187	(register-closures? #t)
150e20dd LC	188	(inputs '())
150e20dd LC	189	copy-inputs?)
c4a74364	190	"Return a bootable, stand-alone QEMU image of type DISK-IMAGE-FORMAT (e.g.,
ef9fc40d LC	191	'qcow2' or 'raw'), with a root partition of type FILE-SYSTEM-TYPE.
ef9fc40d LC	192	Optionally, FILE-SYSTEM-LABEL can be specified as the volume name for the root
f2c403ea LC	193	partition. The returned image is a full disk image that runs OS-DERIVATION,
	194	with a GRUB installation that uses GRUB-CONFIGURATION as its configuration
	195	file (GRUB-CONFIGURATION must be the name of a file in the VM.)
93d44bd8	196
150e20dd LC	197	INPUTS is a list of inputs (as for packages). When COPY-INPUTS? is true, copy
	198	all of INPUTS into the image being built. When REGISTER-CLOSURES? is true,
	199	register INPUTS in the store database of the image so that Guix can be used in
b4140694	200	the image."
b53833b2 LC	201	(expression->derivation-in-linux-vm
	202	name
	203	#~(begin
	204	(use-modules (gnu build vm)
	205	(guix build utils))
1aa0033b	206
b53833b2 LC	207	(let ((inputs
	208	'#$(append (list qemu parted grub e2fsprogs util-linux)
	209	(map canonical-package
	210	(list sed grep coreutils findutils gawk))
	211	(if register-closures? (list guix) '())))
1aa0033b	212
b53833b2 LC	213	;; This variable is unused but allows us to add INPUTS-TO-COPY
	214	;; as inputs.
	215	(to-register
	216	'#$(map (match-lambda
	217	((name thing) thing)
	218	((name thing output) `(,thing ,output)))
	219	inputs)))
1aa0033b	220
b53833b2	221	(set-path-environment-variable "PATH" '("bin" "sbin") inputs)
1aa0033b	222
b53833b2 LC	223	(let ((graphs '#$(match inputs
	224	(((names . _) ...)
	225	names))))
	226	(initialize-hard-disk "/dev/vda"
	227	#:system-directory #$os-derivation
	228	#:grub.cfg #$grub-configuration
	229	#:closures graphs
	230	#:copy-closures? #$copy-inputs?
	231	#:register-closures? #$register-closures?
	232	#:disk-image-size #$disk-image-size
	233	#:file-system-type #$file-system-type
	234	#:file-system-label #$file-system-label)
	235	(reboot))))
	236	#:system system
	237	#:make-disk-image? #t
	238	#:disk-image-size disk-image-size
	239	#:disk-image-format disk-image-format
	240	#:references-graphs inputs))
04086015 LC	241
	242	\f
	243	;;;
1e77fedb	244	;;; VM and disk images.
04086015 LC	245	;;;
04086015 LC	246
1e77fedb LC	247	(define* (system-disk-image os
1e77fedb LC	248	#:key
56ef7fcc	249	(name "disk-image")
1e77fedb LC	250	(file-system-type "ext4")
	251	(disk-image-size (* 900 (expt 2 20)))
	252	(volatile? #t))
	253	"Return the derivation of a disk image of DISK-IMAGE-SIZE bytes of the
	254	system described by OS. Said image can be copied on a USB stick as is. When
	255	VOLATILE? is true, the root file system is made volatile; this is useful
	256	to USB sticks meant to be read-only."
10ace2c4 LC	257	(define root-label
	258	;; Volume name of the root file system. Since we don't know which device
	259	;; will hold it, we use the volume name to find it (using the UUID would
	260	;; be even better, but somewhat less convenient.)
	261	"gnu-disk-image")
	262
1e77fedb LC	263	(define file-systems-to-keep
	264	(remove (lambda (fs)
	265	(string=? (file-system-mount-point fs) "/"))
	266	(operating-system-file-systems os)))
	267
	268	(let ((os (operating-system (inherit os)
932e1f92 LC	269	;; Since this is meant to be used on real hardware, don't
	270	;; install QEMU networking or anything like that, but make sure
	271	;; USB mass storage devices are available.
52ac153e LC	272	(initrd (lambda (file-systems . rest)
	273	(apply base-initrd file-systems
	274	#:volatile-root? #t
	275	#:extra-modules '("usb-storage.ko")
	276	rest)))
1e77fedb LC	277
	278	;; Force our own root file system.
	279	(file-systems (cons (file-system
	280	(mount-point "/")
10ace2c4	281	(device root-label)
d4c87617	282	(title 'label)
1e77fedb LC	283	(type file-system-type))
	284	file-systems-to-keep)))))
	285
	286	(mlet* %store-monad ((os-drv (operating-system-derivation os))
	287	(grub.cfg (operating-system-grub.cfg os)))
56ef7fcc	288	(qemu-image #:name name
f2c403ea	289	#:os-derivation os-drv
56ef7fcc	290	#:grub-configuration grub.cfg
1e77fedb LC	291	#:disk-image-size disk-image-size
	292	#:disk-image-format "raw"
	293	#:file-system-type file-system-type
10ace2c4	294	#:file-system-label root-label
1e77fedb LC	295	#:copy-inputs? #t
	296	#:register-closures? #t
	297	#:inputs `(("system" ,os-drv)
	298	("grub.cfg" ,grub.cfg))))))
	299
0b14d1d7	300	(define* (system-qemu-image os
66f23d66 LC	301	#:key
	302	(file-system-type "ext4")
	303	(disk-image-size (* 900 (expt 2 20))))
	304	"Return the derivation of a freestanding QEMU image of DISK-IMAGE-SIZE bytes
	305	of the GNU system as described by OS."
1eeccc2f LC	306	(define file-systems-to-keep
	307	;; Keep only file systems other than root and not normally bound to real
	308	;; devices.
	309	(remove (lambda (fs)
	310	(let ((target (file-system-mount-point fs))
	311	(source (file-system-device fs)))
	312	(or (string=? target "/")
	313	(string-prefix? "/dev/" source))))
	314	(operating-system-file-systems os)))
	315
66f23d66	316	(let ((os (operating-system (inherit os)
e84d8b30	317	;; Use an initrd with the whole QEMU shebang.
52ac153e LC	318	(initrd (lambda (file-systems . rest)
	319	(apply base-initrd file-systems
	320	#:virtio? #t
	321	#:qemu-networking? #t
	322	rest)))
e84d8b30	323
1eeccc2f LC	324	;; Force our own root file system.
1eeccc2f LC	325	(file-systems (cons (file-system
66f23d66 LC	326	(mount-point "/")
66f23d66 LC	327	(device "/dev/sda1")
1eeccc2f LC	328	(type file-system-type))
1eeccc2f LC	329	file-systems-to-keep)))))
66f23d66 LC	330	(mlet* %store-monad
66f23d66 LC	331	((os-drv (operating-system-derivation os))
b4140694	332	(grub.cfg (operating-system-grub.cfg os)))
f2c403ea LC	333	(qemu-image #:os-derivation os-drv
f2c403ea LC	334	#:grub-configuration grub.cfg
66f23d66 LC	335	#:disk-image-size disk-image-size
66f23d66 LC	336	#:file-system-type file-system-type
b4140694 LC	337	#:inputs `(("system" ,os-drv)
b4140694 LC	338	("grub.cfg" ,grub.cfg))
150e20dd	339	#:copy-inputs? #t))))
04086015	340
83bcd0b8 LC	341	(define (virtualized-operating-system os)
	342	"Return an operating system based on OS suitable for use in a virtualized
	343	environment with the store shared with the host."
	344	(operating-system (inherit os)
52ac153e LC	345	(initrd (lambda (file-systems . rest)
	346	(apply base-initrd file-systems
	347	#:volatile-root? #t
	348	#:virtio? #t
	349	#:qemu-networking? #t
	350	rest)))
65fb4515 LC	351
	352	;; Disable swap.
	353	(swap-devices '())
	354
1eeccc2f LC	355	(file-systems (cons* (file-system
	356	(mount-point "/")
	357	(device "/dev/vda1")
	358	(type "ext4"))
	359	(file-system
	360	(mount-point (%store-prefix))
	361	(device "store")
	362	(type "9p")
	363	(needed-for-boot? #t)
	364	(options "trans=virtio")
	365	(check? #f))
	366
	367	;; Remove file systems that conflict with those
	368	;; above, or that are normally bound to real devices.
	369	(remove (lambda (fs)
	370	(let ((target (file-system-mount-point fs))
	371	(source (file-system-device fs)))
	372	(or (string=? target (%store-prefix))
	373	(string=? target "/")
	374	(string-prefix? "/dev/" source))))
	375	(operating-system-file-systems os))))))
83bcd0b8	376
fd3bfc44	377	(define* (system-qemu-image/shared-store
0b14d1d7	378	os
6aa260af LC	379	#:key
	380	full-boot?
	381	(disk-image-size (* (if full-boot? 500 15) (expt 2 20))))
fd3bfc44	382	"Return a derivation that builds a QEMU image of OS that shares its store
6aa260af LC	383	with the host.
	384
	385	When FULL-BOOT? is true, return an image that does a complete boot sequence,
	386	bootloaded included; thus, make a disk image that contains everything the
	387	bootloader refers to: OS kernel, initrd, bootloader data, etc."
	388	(mlet* %store-monad ((os-drv (operating-system-derivation os))
	389	(grub.cfg (operating-system-grub.cfg os)))
	390	;; XXX: When FULL-BOOT? is true, we end up creating an image that contains
	391	;; GRUB.CFG and all its dependencies, including the output of OS-DRV.
	392	;; This is more than needed (we only need the kernel, initrd, GRUB for its
	393	;; font, and the background image), but it's hard to filter that.
f2c403ea LC	394	(qemu-image #:os-derivation os-drv
f2c403ea LC	395	#:grub-configuration grub.cfg
150e20dd	396	#:disk-image-size disk-image-size
6aa260af LC	397	#:inputs (if full-boot?
	398	`(("grub.cfg" ,grub.cfg))
	399	'())
150e20dd LC	400
	401	;; XXX: Passing #t here is too slow, so let it off by default.
	402	#:register-closures? #f
6aa260af	403	#:copy-inputs? full-boot?)))
fd3bfc44	404
3c1f0e3b LC	405	(define* (common-qemu-options image)
	406	"Return the a string-value gexp with the common QEMU options to boot IMAGE."
	407	#~(string-append
	408	" -enable-kvm -no-reboot -net nic,model=virtio \
	409	-virtfs local,path=" #$(%store-prefix) ",security_model=none,mount_tag=store \
	410	-net user \
	411	-serial stdio \
	412	-drive file=" #$image
	413	",if=virtio,cache=writeback,werror=report,readonly \
810568b3	414	-m 256"))
3c1f0e3b	415
ab11f0be LC	416	(define* (system-qemu-image/shared-store-script os
	417	#:key
	418	(qemu qemu)
	419	(graphic? #t)
6aa260af LC	420	full-boot?
	421	(disk-image-size
	422	(* (if full-boot? 500 15)
	423	(expt 2 20))))
fd3bfc44	424	"Return a derivation that builds a script to run a virtual machine image of
6aa260af LC	425	OS that shares its store with the host.
	426
	427	When FULL-BOOT? is true, the returned script runs everything starting from the
	428	bootloader; otherwise it directly starts the operating system kernel. The
	429	DISK-IMAGE-SIZE parameter specifies the size in bytes of the root disk image;
	430	it is mostly useful when FULL-BOOT? is true."
	431	(mlet* %store-monad ((os -> (virtualized-operating-system os))
	432	(os-drv (operating-system-derivation os))
	433	(image (system-qemu-image/shared-store
	434	os
	435	#:full-boot? full-boot?
	436	#:disk-image-size disk-image-size)))
fd3bfc44	437	(define builder
02100028 LC	438	#~(call-with-output-file #$output
	439	(lambda (port)
	440	(display
	441	(string-append "#!" #$bash "/bin/sh
66670cf3	442	exec " #$qemu "/bin/" #$(qemu-command (%current-system))
ab11f0be LC	443
	444	#$@(if full-boot?
	445	#~()
	446	#~(" -kernel " #$(operating-system-kernel os) "/bzImage \
	447	-initrd " #$os-drv "/initrd \
	448	-append \"" #$(if graphic? "" "console=ttyS0 ")
	449	"--system=" #$os-drv " --load=" #$os-drv "/boot --root=/dev/vda1\" "))
810568b3 LC	450	#$(common-qemu-options image)
810568b3 LC	451	" \"$@\"\n")
02100028 LC	452	port)
	453	(chmod port #o555))))
	454
	455	(gexp->derivation "run-vm.sh" builder)))
fd3bfc44	456
04086015	457	;;; vm.scm ends here