1 ;;; GNU Guix --- Functional package management for GNU
2 ;;; Copyright © 2013, 2014, 2015, 2016, 2017, 2018, 2019, 2020 Ludovic Courtès <ludo@gnu.org>
3 ;;; Copyright © 2016 Christopher Allan Webber <cwebber@dustycloud.org>
4 ;;; Copyright © 2016, 2017 Leo Famulari <leo@famulari.name>
5 ;;; Copyright © 2017 Mathieu Othacehe <m.othacehe@gmail.com>
6 ;;; Copyright © 2017 Marius Bakke <mbakke@fastmail.com>
7 ;;; Copyright © 2018 Chris Marusich <cmmarusich@gmail.com>
9 ;;; This file is part of GNU Guix.
11 ;;; GNU Guix is free software; you can redistribute it and/or modify it
12 ;;; under the terms of the GNU General Public License as published by
13 ;;; the Free Software Foundation; either version 3 of the License, or (at
14 ;;; your option) any later version.
16 ;;; GNU Guix is distributed in the hope that it will be useful, but
17 ;;; WITHOUT ANY WARRANTY; without even the implied warranty of
18 ;;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19 ;;; GNU General Public License for more details.
21 ;;; You should have received a copy of the GNU General Public License
22 ;;; along with GNU Guix. If not, see <http://www.gnu.org/licenses/>.
24 (define-module (gnu system vm)
25 #:use-module (guix config)
26 #:use-module (guix store)
27 #:use-module (guix gexp)
28 #:use-module (guix derivations)
29 #:use-module (guix packages)
30 #:use-module (guix monads)
31 #:use-module (guix records)
32 #:use-module (guix modules)
33 #:use-module (guix utils)
34 #:use-module (gcrypt hash)
35 #:use-module (guix base32)
36 #:use-module ((guix self) #:select (make-config.scm))
38 #:use-module ((gnu build vm)
39 #:select (qemu-command))
40 #:use-module (gnu packages base)
41 #:use-module (gnu packages bootloaders)
42 #:use-module (gnu packages cdrom)
43 #:use-module (gnu packages compression)
44 #:use-module (gnu packages guile)
45 #:autoload (gnu packages gnupg) (guile-gcrypt)
46 #:use-module (gnu packages gawk)
47 #:use-module (gnu packages bash)
48 #:use-module (gnu packages less)
49 #:use-module (gnu packages virtualization)
50 #:use-module (gnu packages disk)
51 #:use-module (gnu packages zile)
52 #:use-module (gnu packages linux)
53 #:use-module ((gnu packages make-bootstrap)
54 #:select (%guile-static-stripped))
55 #:use-module (gnu packages admin)
57 #:use-module (gnu bootloader)
58 #:use-module (gnu bootloader grub)
59 #:use-module (gnu system shadow)
60 #:use-module (gnu system pam)
61 #:use-module (gnu system linux-container)
62 #:use-module (gnu system linux-initrd)
63 #:use-module (gnu bootloader)
64 #:use-module (gnu system file-systems)
65 #:use-module (gnu system)
66 #:use-module (gnu services)
67 #:use-module (gnu services base)
68 #:use-module (gnu system uuid)
70 #:use-module (srfi srfi-1)
71 #:use-module (srfi srfi-26)
72 #:use-module (rnrs bytevectors)
73 #:use-module (ice-9 match)
75 #:export (expression->derivation-in-linux-vm
77 virtualized-operating-system
80 system-qemu-image/shared-store
81 system-qemu-image/shared-store-script
91 ;;; Tools to evaluate build expressions within virtual machines.
95 (define %linux-vm-file-systems
96 ;; File systems mounted for 'derivation-in-linux-vm'. These are shared with
99 ;; The 9p documentation says that cache=loose is "intended for exclusive,
100 ;; read-only mounts", without additional details. It's much faster than the
101 ;; default cache=none, especially when copying and registering store items.
102 ;; Thus, use cache=loose, except for /xchg where we want to ensure
105 (mount-point (%store-prefix))
108 (needed-for-boot? #t)
110 (options "trans=virtio,cache=loose")
113 (mount-point "/xchg")
116 (needed-for-boot? #t)
117 (options "trans=virtio")
123 (needed-for-boot? #t)
124 (options "trans=virtio,cache=loose")
128 ;; Select (guix …) and (gnu …) modules, except (guix config).
131 (('guix rest ...) #t)
135 (define gcrypt-sqlite3&co
136 ;; Guile-Gcrypt, Guile-SQLite3, and their propagated inputs.
137 (append-map (lambda (package)
139 (match (package-transitive-propagated-inputs package)
140 (((labels packages) ...)
142 (list guile-gcrypt guile-sqlite3)))
144 (define* (expression->derivation-in-linux-vm name exp
146 (system (%current-system)) target
154 %linux-vm-file-systems)
156 (single-file-output? #f)
157 (make-disk-image? #f)
158 (references-graphs #f)
160 (disk-image-format "qcow2")
161 (disk-image-size 'guess))
162 "Evaluate EXP in a QEMU virtual machine running LINUX with INITRD (a
163 derivation). The virtual machine runs with MEMORY-SIZE MiB of memory. In the
164 virtual machine, EXP has access to FILE-SYSTEMS, which, by default, includes a
165 9p share of the store, the '/xchg' where EXP should put its output file(s),
166 and a 9p share of /tmp.
168 If SINGLE-FILE-OUTPUT? is true, copy a single file from '/xchg' to OUTPUT.
169 Otherwise, copy the contents of /xchg to a new directory OUTPUT.
171 When MAKE-DISK-IMAGE? is true, then create a QEMU disk image of type
172 DISK-IMAGE-FORMAT (e.g., 'qcow2' or 'raw'), of DISK-IMAGE-SIZE bytes and
173 return it. When DISK-IMAGE-SIZE is 'guess, estimate the image size based
174 based on the size of the closure of REFERENCES-GRAPHS.
176 When REFERENCES-GRAPHS is true, it must be a list of file name/store path
177 pairs, as for `derivation'. The files containing the reference graphs are
178 made available under the /xchg CIFS share."
180 (program-file "builder-in-linux-vm" exp))
183 ;; Invoke USER-BUILDER instead using 'primitive-load'. The reason for
184 ;; this is to allow USER-BUILDER to dlopen stuff by using a full-featured
185 ;; Guile, which it couldn't do using the statically-linked guile used in
186 ;; the initrd. See example at
187 ;; <https://lists.gnu.org/archive/html/guix-devel/2017-10/msg00233.html>.
188 (program-file "linux-vm-loader"
189 ;; When USER-BUILDER succeeds, reboot (indicating a
190 ;; success), otherwise die, which causes a kernel panic
191 ;; ("Attempted to kill init!").
192 #~(if (zero? (system* #$user-builder))
196 (let ((initrd (or initrd
197 (base-initrd file-systems
198 #:on-error 'backtrace
200 #:linux-modules %base-initrd-modules
201 #:qemu-networking? #t))))
204 ;; Code that launches the VM that evaluates EXP.
205 (with-extensions gcrypt-sqlite3&co
206 (with-imported-modules `(,@(source-module-closure
209 #:select? not-config?)
211 ;; For consumption by (gnu store database).
212 ((guix config) => ,(make-config.scm)))
214 (use-modules (guix build utils)
217 (let* ((native-inputs
218 '#+(list qemu (canonical-package coreutils)))
219 (linux (string-append #$linux "/"
220 #$(system-linux-image-file-name)))
223 (graphs '#$(match references-graphs
224 (((graph-files . _) ...) graph-files)
226 (target #$(or (%current-target-system) (%current-system)))
227 (size #$(if (eq? 'guess disk-image-size)
228 #~(+ (* 70 (expt 2 20)) ;ESP
229 (estimated-partition-size graphs))
232 (set-path-environment-variable "PATH" '("bin") native-inputs)
234 (load-in-linux-vm loader
236 #:linux linux #:initrd initrd
237 #:qemu (qemu-command target)
238 #:memory-size #$memory-size
239 #:make-disk-image? #$make-disk-image?
240 #:single-file-output? #$single-file-output?
241 ;; FIXME: ‘target-arm32?’ and
242 ;; ‘target-aarch64?’ may not operate on the
243 ;; right system/target values. Rewrite
244 ;; using ‘let-system’ when available.
245 #:target-arm32? #$(target-arm32?)
246 #:target-aarch64? #$(target-aarch64?)
247 #:disk-image-format #$disk-image-format
248 #:disk-image-size size
249 #:references-graphs graphs))))))
251 (gexp->derivation name builder
252 ;; TODO: Require the "kvm" feature.
256 #:guile-for-build guile-for-build
257 #:references-graphs references-graphs)))
259 (define (has-guix-service-type? os)
260 "Return true if OS contains a service of the type GUIX-SERVICE-TYPE."
261 (not (not (find (lambda (service)
262 (eq? (service-kind service) guix-service-type))
263 (operating-system-services os)))))
265 (define* (iso9660-image #:key
266 (name "iso9660-image")
269 (system (%current-system))
270 (target (%current-target-system))
275 (register-closures? (has-guix-service-type? os))
277 (grub-mkrescue-environment '()))
278 "Return a bootable, stand-alone iso9660 image.
280 INPUTS is a list of inputs (as for packages)."
282 (and register-closures?
283 (local-file (search-path %load-path
284 "guix/store/schema.sql"))))
286 (expression->derivation-in-linux-vm
288 (with-extensions gcrypt-sqlite3&co
289 (with-imported-modules `(,@(source-module-closure '((gnu build vm)
290 (guix store database)
292 #:select? not-config?)
293 ((guix config) => ,(make-config.scm)))
295 (use-modules (gnu build vm)
296 (guix store database)
299 (sql-schema #$schema)
301 ;; Allow non-ASCII file names--e.g., 'nss-certs'--to be decoded.
302 (setenv "GUIX_LOCPATH"
303 #+(file-append glibc-utf8-locales "/lib/locale"))
304 (setlocale LC_ALL "en_US.utf8")
307 '#$(append (list parted e2fsprogs dosfstools xorriso)
308 (map canonical-package
309 (list sed grep coreutils findutils gawk))))
312 (graphs '#$(match inputs
315 ;; This variable is unused but allows us to add INPUTS-TO-COPY
318 '#$(map (match-lambda
320 ((name thing output) `(,thing ,output)))
323 (set-path-environment-variable "PATH" '("bin" "sbin") inputs)
324 (make-iso9660-image #$xorriso
325 '#$grub-mkrescue-environment
326 #$(bootloader-package bootloader)
330 #:register-closures? #$register-closures?
332 #:volume-id #$file-system-label
333 #:volume-uuid #$(and=> file-system-uuid
334 uuid-bytevector))))))
338 ;; Keep a local file system for /tmp so that we can populate it directly as
339 ;; root and have files owned by root. See <https://bugs.gnu.org/31752>.
340 #:file-systems (remove (lambda (file-system)
341 (string=? (file-system-mount-point file-system)
343 %linux-vm-file-systems)
345 #:make-disk-image? #f
346 #:single-file-output? #t
347 #:references-graphs inputs
349 ;; Xorriso seems to be quite memory-hungry, so increase the VM's RAM size.
352 (define* (qemu-image #:key
354 (system (%current-system))
355 (target (%current-target-system))
357 (disk-image-size 'guess)
358 (disk-image-format "qcow2")
359 (file-system-type "ext4")
365 (register-closures? (has-guix-service-type? os))
368 "Return a bootable, stand-alone QEMU image of type DISK-IMAGE-FORMAT (e.g.,
369 'qcow2' or 'raw'), with a root partition of type FILE-SYSTEM-TYPE.
370 Optionally, FILE-SYSTEM-LABEL can be specified as the volume name for the root
371 partition; likewise FILE-SYSTEM-UUID, if true, specifies the UUID of the root
372 partition (a UUID object).
374 The returned image is a full disk image that runs OS-DERIVATION,
375 with a GRUB installation that uses GRUB-CONFIGURATION as its configuration
376 file (GRUB-CONFIGURATION must be the name of a file in the VM.)
378 INPUTS is a list of inputs (as for packages). When COPY-INPUTS? is true, copy
379 all of INPUTS into the image being built. When REGISTER-CLOSURES? is true,
380 register INPUTS in the store database of the image so that Guix can be used in
381 the image. By default, REGISTER-CLOSURES? is set to true only if a service of
382 type GUIX-SERVICE-TYPE is present in the services definition of the operating
385 (and register-closures?
386 (local-file (search-path %load-path
387 "guix/store/schema.sql"))))
389 (expression->derivation-in-linux-vm
391 (with-extensions gcrypt-sqlite3&co
392 (with-imported-modules `(,@(source-module-closure '((gnu build vm)
393 (gnu build bootloader)
394 (guix store database)
396 #:select? not-config?)
397 ((guix config) => ,(make-config.scm)))
399 (use-modules (gnu build bootloader)
401 (guix store database)
404 (ice-9 binary-ports))
406 (sql-schema #$schema)
408 ;; Allow non-ASCII file names--e.g., 'nss-certs'--to be decoded.
409 (setenv "GUIX_LOCPATH"
410 #+(file-append glibc-utf8-locales "/lib/locale"))
411 (setlocale LC_ALL "en_US.utf8")
414 '#$(append (list parted e2fsprogs dosfstools)
415 (map canonical-package
416 (list sed grep coreutils findutils gawk))))
418 ;; This variable is unused but allows us to add INPUTS-TO-COPY
421 '#$(map (match-lambda
423 ((name thing output) `(,thing ,output)))
426 (set-path-environment-variable "PATH" '("bin" "sbin") inputs)
428 (let* ((graphs '#$(match inputs
431 (initialize (root-partition-initializer
433 #:copy-closures? #$copy-inputs?
434 #:register-closures? #$register-closures?
435 #:system-directory #$os
437 ;; Disable deduplication to speed things up,
438 ;; and because it doesn't help much for a
439 ;; single system generation.
441 (root-size #$(if (eq? 'guess disk-image-size)
443 ;; Minimum 20 MiB root size
445 (estimated-partition-size
446 (map (cut string-append "/xchg/" <>)
449 (* 50 (expt 2 20)))))
454 (label #$file-system-label)
455 (uuid #$(and=> file-system-uuid
457 (file-system #$file-system-type)
459 (initializer initialize)))
460 ;; Append a small EFI System Partition for use with UEFI
461 ;; bootloaders if we are not targeting ARM because UEFI
462 ;; support in U-Boot is experimental.
464 ;; FIXME: ‘target-arm?’ may be not operate on the right
465 ;; system/target values. Rewrite using ‘let-system’ when
470 ;; The standalone grub image is about 10MiB, but
471 ;; leave some room for custom or multiple images.
472 (size (* 40 (expt 2 20)))
473 (label "GNU-ESP") ;cosmetic only
474 ;; Use "vfat" here since this property is used
475 ;; when mounting. The actual FAT-ness is based
476 ;; on file system size (16 in this case).
479 (grub-efi #$(and (not (target-arm?)) grub-efi)))
480 (initialize-hard-disk "/dev/vda"
481 #:partitions partitions
484 #$(bootloader-package bootloader)
485 #:bootcfg #$bootcfg-drv
487 #$(bootloader-configuration-file bootloader)
488 #:bootloader-installer
489 #$(bootloader-installer bootloader)))))))
492 #:make-disk-image? #t
493 #:disk-image-size disk-image-size
494 #:disk-image-format disk-image-format
495 #:references-graphs inputs))
497 (define* (system-docker-image os
499 (name "guix-docker-image")
500 (register-closures? (has-guix-service-type? os)))
501 "Build a docker image. OS is the desired <operating-system>. NAME is the
502 base name to use for the output file. When REGISTER-CLOSURES? is true,
503 register the closure of OS with Guix in the resulting Docker image. By
504 default, REGISTER-CLOSURES? is set to true only if a service of type
505 GUIX-SERVICE-TYPE is present in the services definition of the operating
508 (and register-closures?
509 (local-file (search-path %load-path
510 "guix/store/schema.sql"))))
513 ;; Program that runs the boot script of OS, which in turn starts shepherd.
514 (program-file "boot-program"
515 #~(let ((system (cadr (command-line))))
516 (setenv "GUIX_NEW_SYSTEM" system)
517 (execl #$(file-append guile-2.2 "/bin/guile")
518 "guile" "--no-auto-compile"
519 (string-append system "/boot")))))
522 (let ((os (operating-system-with-gc-roots
523 (containerized-operating-system os '())
524 (list boot-program)))
525 (name (string-append name ".tar.gz"))
526 (graph "system-graph"))
528 (with-extensions (cons guile-json-3 ;for (guix docker)
529 gcrypt-sqlite3&co) ;for (guix store database)
530 (with-imported-modules `(,@(source-module-closure
532 (guix store database)
534 (guix build store-copy)
536 #:select? not-config?)
537 ((guix config) => ,(make-config.scm)))
539 (use-modules (guix docker)
543 (guix build store-copy)
544 (guix store database))
546 ;; Set the SQL schema location.
547 (sql-schema #$schema)
549 ;; Allow non-ASCII file names--e.g., 'nss-certs'--to be decoded.
550 (setenv "GUIX_LOCPATH"
551 #+(file-append glibc-utf8-locales "/lib/locale"))
552 (setlocale LC_ALL "en_US.utf8")
554 (let* (;; This initializer requires elevated privileges that are
555 ;; not normally available in the build environment (e.g.,
556 ;; it needs to create device nodes). In order to obtain
557 ;; such privileges, we run it as root in a VM.
558 (initialize (root-partition-initializer
559 #:closures '(#$graph)
560 #:register-closures? #$register-closures?
561 #:system-directory #$os
562 ;; De-duplication would fail due to
563 ;; cross-device link errors, so don't do it.
565 ;; Even as root in a VM, the initializer would fail due to
566 ;; lack of privileges if we use a root-directory that is on
567 ;; a file system that is shared with the host (e.g., /tmp).
568 (root-directory "/guixsd-system-root"))
569 (set-path-environment-variable "PATH" '("bin" "sbin") '(#+tar))
570 (mkdir root-directory)
571 (initialize root-directory)
573 (string-append "/xchg/" #$name) ;; The output file.
574 (cons* root-directory
576 (call-with-input-file
577 (string-append "/xchg/" #$graph)
578 read-reference-graph)))
580 #:entry-point '(#$boot-program #$os)
581 #:compressor '(#+(file-append gzip "/bin/gzip") "-9n")
582 #:creation-time (make-time time-utc 0 1)
583 #:transformations `((,root-directory -> ""))))))))
585 (expression->derivation-in-linux-vm
587 #:make-disk-image? #f
588 #:single-file-output? #t
589 #:references-graphs `((,graph ,os)))))
593 ;;; VM and disk images.
596 (define* (operating-system-uuid os #:optional (type 'dce))
597 "Compute UUID object with a deterministic \"UUID\" for OS, of the given
598 TYPE (one of 'iso9660 or 'dce). Return a UUID object."
599 ;; Note: For this to be deterministic, we must not hash things that contains
600 ;; (directly or indirectly) procedures, for example. That rules out
601 ;; anything that contains gexps, thunk or delayed record fields, etc.
604 (compose service-type-name service-kind))
606 (define (file-system-digest fs)
607 ;; Return a hashable digest that does not contain 'dependencies' since
608 ;; this field can contain procedures.
609 (let ((device (file-system-device fs)))
610 (list (file-system-mount-point fs)
611 (file-system-type fs)
612 (file-system-device->string device)
613 (file-system-options fs))))
615 (if (eq? type 'iso9660)
616 (let ((pad (compose (cut string-pad <> 2 #\0)
618 (h (hash (map service-name (operating-system-services os))
621 (string->iso9660-uuid
622 (string-append "1970-01-01-"
623 (pad (hash (operating-system-host-name os) 24)) "-"
624 (pad (quotient h 60)) "-"
625 (pad (modulo h 60)) "-"
626 (pad (hash (map file-system-digest
627 (operating-system-file-systems os))
631 (uint-list->bytevector
632 (list (hash (map file-system-digest
633 (operating-system-file-systems os))
635 (hash (operating-system-host-name os)
637 (hash (map service-name (operating-system-services os))
639 (hash (map file-system-digest (operating-system-file-systems os))
645 (define* (system-disk-image os
648 (file-system-type "ext4")
649 (disk-image-size (* 900 (expt 2 20)))
651 "Return the derivation of a disk image of DISK-IMAGE-SIZE bytes of the
652 system described by OS. Said image can be copied on a USB stick as is. When
653 VOLATILE? is true, the root file system is made volatile; this is useful
654 to USB sticks meant to be read-only."
655 (define normalize-label
656 ;; ISO labels are all-caps (case-insensitive), but since
657 ;; 'find-partition-by-label' is case-sensitive, make it all-caps here.
658 (if (string=? "iso9660" file-system-type)
663 ;; Volume name of the root file system.
664 (normalize-label "Guix_image"))
666 (define (root-uuid os)
667 ;; UUID of the root file system, computed in a deterministic fashion.
668 ;; This is what we use to locate the root file system so it has to be
669 ;; different from the user's own file system UUIDs.
670 (operating-system-uuid os
671 (if (string=? file-system-type "iso9660")
675 (define file-systems-to-keep
677 (string=? (file-system-mount-point fs) "/"))
678 (operating-system-file-systems os)))
680 (let* ((os (operating-system (inherit os)
681 ;; Since this is meant to be used on real hardware, don't
682 ;; install QEMU networking or anything like that. Assume USB
683 ;; mass storage devices (usb-storage.ko) are available.
684 (initrd (lambda (file-systems . rest)
685 (apply (operating-system-initrd os)
687 #:volatile-root? volatile?
690 (bootloader (if (string=? "iso9660" file-system-type)
691 (bootloader-configuration
692 (inherit (operating-system-bootloader os))
693 (bootloader grub-mkrescue-bootloader))
694 (operating-system-bootloader os)))
696 ;; Force our own root file system. (We need a "/" file system
697 ;; to call 'root-uuid'.)
698 (file-systems (cons (file-system
700 (device "/dev/placeholder")
701 (type file-system-type))
702 file-systems-to-keep))))
703 (uuid (root-uuid os))
704 (os (operating-system
706 (file-systems (cons (file-system
709 (type file-system-type))
710 file-systems-to-keep))))
711 (bootcfg (operating-system-bootcfg os)))
712 (if (string=? "iso9660" file-system-type)
713 (iso9660-image #:name name
714 #:file-system-label root-label
715 #:file-system-uuid uuid
717 #:bootcfg-drv bootcfg
718 #:bootloader (bootloader-configuration-bootloader
719 (operating-system-bootloader os))
720 #:inputs `(("system" ,os)
721 ("bootcfg" ,bootcfg))
722 #:grub-mkrescue-environment
723 '(("MKRESCUE_SED_MODE" . "mbr_hfs")))
724 (qemu-image #:name name
726 #:bootcfg-drv bootcfg
727 #:bootloader (bootloader-configuration-bootloader
728 (operating-system-bootloader os))
729 #:disk-image-size disk-image-size
730 #:disk-image-format "raw"
731 #:file-system-type file-system-type
732 #:file-system-label root-label
733 #:file-system-uuid uuid
735 #:inputs `(("system" ,os)
736 ("bootcfg" ,bootcfg))))))
738 (define* (system-qemu-image os
740 (file-system-type "ext4")
741 (disk-image-size (* 900 (expt 2 20))))
742 "Return the derivation of a freestanding QEMU image of DISK-IMAGE-SIZE bytes
743 of the GNU system as described by OS."
744 (define file-systems-to-keep
745 ;; Keep only file systems other than root and not normally bound to real
748 (let ((target (file-system-mount-point fs))
749 (source (file-system-device fs)))
750 (or (string=? target "/")
751 (string-prefix? "/dev/" source))))
752 (operating-system-file-systems os)))
755 ;; UUID of the root file system.
756 (operating-system-uuid os
757 (if (string=? file-system-type "iso9660")
762 (let* ((os (operating-system (inherit os)
763 ;; Assume we have an initrd with the whole QEMU shebang.
765 ;; Force our own root file system. Refer to it by UUID so that
766 ;; it works regardless of how the image is used ("qemu -hda",
768 (file-systems (cons (file-system
771 (type file-system-type))
772 file-systems-to-keep))))
773 (bootcfg (operating-system-bootcfg os)))
775 #:bootcfg-drv bootcfg
776 #:bootloader (bootloader-configuration-bootloader
777 (operating-system-bootloader os))
778 #:disk-image-size disk-image-size
779 #:file-system-type file-system-type
780 #:file-system-uuid root-uuid
781 #:inputs `(("system" ,os)
782 ("bootcfg" ,bootcfg))
787 ;;; VMs that share file systems with the host.
790 (define (file-system->mount-tag fs)
791 "Return a 9p mount tag for host file system FS."
792 ;; QEMU mount tags must be ASCII, at most 31-byte long, cannot contain
793 ;; slashes, and cannot start with '_'. Compute an identifier that
794 ;; corresponds to the rules.
796 (string-drop (bytevector->base32-string
797 (sha1 (string->utf8 fs)))
800 (define (mapping->file-system mapping)
801 "Return a 9p file system that realizes MAPPING."
803 (($ <file-system-mapping> source target writable?)
806 (device (file-system->mount-tag source))
808 (flags (if writable? '() '(read-only)))
809 (options "trans=virtio,cache=loose")
811 (create-mount-point? #t)))))
813 (define* (virtualized-operating-system os mappings #:optional (full-boot? #f))
814 "Return an operating system based on OS suitable for use in a virtualized
815 environment with the store shared with the host. MAPPINGS is a list of
816 <file-system-mapping> to realize in the virtualized OS."
817 (define user-file-systems
818 ;; Remove file systems that conflict with those added below, or that are
819 ;; normally bound to real devices.
821 (let ((target (file-system-mount-point fs))
822 (source (file-system-device fs)))
823 (or (string=? target (%store-prefix))
824 (string=? target "/")
825 (and (string? source)
826 (string-prefix? "/dev/" source))
828 ;; Labels and UUIDs are necessarily invalid in the VM.
829 (and (file-system-mount? fs)
830 (or (file-system-label? source)
832 (operating-system-file-systems os)))
834 (define virtual-file-systems
840 (append (map mapping->file-system mappings)
843 (operating-system (inherit os)
845 ;; XXX: Until we run QEMU with UEFI support (with the OVMF firmware),
846 ;; force the traditional i386/BIOS method.
847 ;; See <https://bugs.gnu.org/28768>.
848 (bootloader (bootloader-configuration
849 (inherit (operating-system-bootloader os))
850 (bootloader grub-bootloader)
851 (target "/dev/vda")))
853 (initrd (lambda (file-systems . rest)
854 (apply (operating-system-initrd os)
862 ;; XXX: When FULL-BOOT? is true, do not add a 9p mount for /gnu/store
863 ;; since that would lead the bootloader config to look for the kernel and
865 (file-systems (if full-boot?
869 (inherit (mapping->file-system %store-mapping))
870 (needed-for-boot? #t))
871 virtual-file-systems)))))
873 (define* (system-qemu-image/shared-store
877 (disk-image-size (* (if full-boot? 500 30) (expt 2 20))))
878 "Return a derivation that builds a QEMU image of OS that shares its store
881 When FULL-BOOT? is true, return an image that does a complete boot sequence,
882 bootloaded included; thus, make a disk image that contains everything the
883 bootloader refers to: OS kernel, initrd, bootloader data, etc."
885 ;; Use a fixed UUID to improve determinism.
886 (operating-system-uuid os 'dce))
889 (operating-system-bootcfg os))
891 ;; XXX: When FULL-BOOT? is true, we end up creating an image that contains
892 ;; BOOTCFG and all its dependencies, including the output of OS.
893 ;; This is more than needed (we only need the kernel, initrd, GRUB for its
894 ;; font, and the background image), but it's hard to filter that.
896 #:bootcfg-drv bootcfg
897 #:bootloader (bootloader-configuration-bootloader
898 (operating-system-bootloader os))
899 #:disk-image-size disk-image-size
900 #:file-system-uuid root-uuid
901 #:inputs (if full-boot?
902 `(("bootcfg" ,bootcfg))
905 ;; XXX: Passing #t here is too slow, so let it off by default.
906 #:register-closures? #f
907 #:copy-inputs? full-boot?))
909 (define* (common-qemu-options image shared-fs)
910 "Return the a string-value gexp with the common QEMU options to boot IMAGE,
911 with '-virtfs' options for the host file systems listed in SHARED-FS."
913 (define (virtfs-option fs)
914 #~(format #f "-virtfs local,path=~s,security_model=none,mount_tag=~s"
915 #$fs #$(file-system->mount-tag fs)))
917 #~(;; Only enable kvm if we see /dev/kvm exists.
918 ;; This allows users without hardware virtualization to still use these
920 #$@(if (file-exists? "/dev/kvm")
925 "-object" "rng-random,filename=/dev/urandom,id=guixsd-vm-rng"
926 "-device" "virtio-rng-pci,rng=guixsd-vm-rng"
928 #$@(map virtfs-option shared-fs)
930 (format #f "-drive file=~a,if=virtio,cache=writeback,werror=report,readonly"
933 (define* (system-qemu-image/shared-store-script os
941 (* (if full-boot? 500 70)
944 "Return a derivation that builds a script to run a virtual machine image of
945 OS that shares its store with the host. The virtual machine runs with
946 MEMORY-SIZE MiB of memory.
948 MAPPINGS is a list of <file-system-mapping> specifying mapping of host file
949 systems into the guest.
951 When FULL-BOOT? is true, the returned script runs everything starting from the
952 bootloader; otherwise it directly starts the operating system kernel. The
953 DISK-IMAGE-SIZE parameter specifies the size in bytes of the root disk image;
954 it is mostly useful when FULL-BOOT? is true."
955 (mlet* %store-monad ((os -> (virtualized-operating-system os mappings full-boot?))
956 (image (system-qemu-image/shared-store
958 #:full-boot? full-boot?
959 #:disk-image-size disk-image-size)))
960 (define kernel-arguments
961 #~(list #$@(if graphic? #~() #~("console=ttyS0"))
962 #+@(operating-system-kernel-arguments os "/dev/vda1")))
965 #~(list (string-append #$qemu "/bin/" #$(qemu-command (%current-system)))
968 #~("-kernel" #$(operating-system-kernel-file os)
969 "-initrd" #$(file-append os "/initrd")
970 (format #f "-append ~s"
971 (string-join #$kernel-arguments " "))))
972 #$@(common-qemu-options image
973 (map file-system-mapping-source
974 (cons %store-mapping mappings)))
975 "-m " (number->string #$memory-size)
979 #~(call-with-output-file #$output
981 (format port "#!~a~% exec ~a \"$@\"~%"
982 #$(file-append bash "/bin/sh")
983 (string-join #$qemu-exec " "))
984 (chmod port #o555))))
986 (gexp->derivation "run-vm.sh" builder)))
990 ;;; High-level abstraction.
993 (define-record-type* <virtual-machine> %virtual-machine
996 (operating-system virtual-machine-operating-system) ;<operating-system>
997 (qemu virtual-machine-qemu ;<package>
999 (graphic? virtual-machine-graphic? ;Boolean
1001 (memory-size virtual-machine-memory-size ;integer (MiB)
1003 (disk-image-size virtual-machine-disk-image-size ;integer (bytes)
1005 (port-forwardings virtual-machine-port-forwardings ;list of integer pairs
1008 (define-syntax virtual-machine
1010 "Declare a virtual machine running the specified OS, with the given
1013 (%virtual-machine (operating-system os)))
1015 (%virtual-machine fields ...))))
1017 (define (port-forwardings->qemu-options forwardings)
1018 "Return the QEMU option for the given port FORWARDINGS as a string, where
1019 FORWARDINGS is a list of host-port/guest-port pairs."
1022 ((host-port . guest-port)
1023 (string-append "hostfwd=tcp::"
1024 (number->string host-port)
1025 "-:" (number->string guest-port))))
1029 (define-gexp-compiler (virtual-machine-compiler (vm <virtual-machine>)
1031 ;; XXX: SYSTEM and TARGET are ignored.
1033 (($ <virtual-machine> os qemu graphic? memory-size disk-image-size ())
1034 (system-qemu-image/shared-store-script os
1037 #:memory-size memory-size
1040 (($ <virtual-machine> os qemu graphic? memory-size disk-image-size
1043 `("-nic" ,(string-append
1044 "user,model=virtio-net-pci,"
1045 (port-forwardings->qemu-options forwardings)))))
1046 (system-qemu-image/shared-store-script os
1049 #:memory-size memory-size
1052 #:options options)))))
1054 ;;; vm.scm ends here