;;; GNU Guix --- Functional package management for GNU
-;;; Copyright © 2013, 2014 Ludovic Courtès <ludo@gnu.org>
+;;; Copyright © 2013, 2014, 2015, 2016 Ludovic Courtès <ludo@gnu.org>
+;;; Copyright © 2016 Christopher Allan Webber <cwebber@dustycloud.org>
+;;; Copyright © 2016 Leo Famulari <leo@famulari.name>
+;;; Copyright © 2017 Mathieu Othacehe <m.othacehe@gmail.com>
;;;
;;; This file is part of GNU Guix.
;;;
#:use-module (guix derivations)
#:use-module (guix packages)
#:use-module (guix monads)
- #:use-module ((gnu packages base)
- #:select (%final-inputs))
+ #:use-module (guix records)
+ #:use-module (guix modules)
+
+ #:use-module ((gnu build vm)
+ #:select (qemu-command))
+ #:use-module (gnu packages base)
+ #:use-module (gnu packages bootloaders)
#: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 parted)
+ #: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)
#:use-module (gnu packages admin)
#:use-module (gnu system shadow)
- #:use-module (gnu system linux)
+ #:use-module (gnu system pam)
#: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)
#:export (expression->derivation-in-linux-vm
qemu-image
+ virtualized-operating-system
system-qemu-image
+
system-qemu-image/shared-store
- system-qemu-image/shared-store-script))
+ system-qemu-image/shared-store-script
+ system-disk-image))
\f
;;; Commentary:
;;;
;;; Code:
-(define* (input->name+output tuple #:key (system (%current-system)))
- "Return as a monadic value a name/file-name pair corresponding to TUPLE, an
-input tuple. The output file name is when building for SYSTEM."
- (with-monad %store-monad
- (match tuple
- ((input (? package? package))
- (mlet %store-monad ((out (package-file package #:system system)))
- (return `(,input . ,out))))
- ((input (? package? package) sub-drv)
- (mlet %store-monad ((out (package-file package
- #:output sub-drv
- #:system system)))
- (return `(,input . ,out))))
- ((input (? derivation? drv))
- (return `(,input . ,(derivation->output-path drv))))
- ((input (? derivation? drv) sub-drv)
- (return `(,input . ,(derivation->output-path drv sub-drv))))
- ((input (and (? string?) (? store-path?) file))
- (return `(,input . ,file))))))
-
(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.
(system (%current-system))
(linux linux-libre)
initrd
- (qemu qemu-headless)
+ (qemu qemu-minimal)
(env-vars '())
- (modules
- '((guix build vm)
- (guix build linux-initrd)
- (guix build utils)))
(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
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
-DISK-IMAGE-SIZE bytes and return it.
-
-MODULES is the set of modules imported in the execution environment of EXP.
+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.
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))
+ ((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 -> (car (assoc-ref %final-inputs "coreutils")))
+ #~(primitive-load #$user-builder)))
+ (coreutils -> (canonical-package coreutils))
(initrd (if initrd ; use the default initrd?
(return initrd)
- (qemu-initrd %linux-vm-file-systems
- #:guile-modules-in-chroot? #t))))
+ (base-initrd %linux-vm-file-systems
+ #:linux linux
+ #:virtio? #t
+ #:qemu-networking? #t))))
(define builder
;; Code that launches the VM that evaluates EXP.
- #~(begin
- (use-modules (guix build utils)
- (guix 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-size #$disk-image-size
- #:references-graphs graphs))))
+ (with-imported-modules (source-module-closure '((guix build utils)
+ (gnu build vm)))
+ #~(begin
+ (use-modules (guix build utils)
+ (gnu build vm))
+
+ (let ((inputs '#$(list qemu coreutils))
+ (linux (string-append #$linux "/"
+ #$(system-linux-image-file-name)))
+ (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 `((guix build utils)
- (guix build vm)
- (guix build linux-initrd))
#:guile-for-build guile-for-build
#:references-graphs references-graphs)))
(define* (qemu-image #:key
(name "qemu-image")
(system (%current-system))
- (qemu qemu-headless)
+ (qemu qemu-minimal)
(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)
- (populate #f)
(inputs '())
copy-inputs?)
- "Return a bootable, stand-alone QEMU image, with a root partition of type
-FILE-SYSTEM-TYPE. The returned image is a full disk image, with a GRUB
-installation that uses GRUB-CONFIGURATION as its configuration
+ "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.
-
-POPULATE is a list of directives stating directories or symlinks to be created
-in the disk image partition. It is evaluated once the image has been
-populated with INPUTS-TO-COPY. It can be used to provide additional files,
-such as /etc files."
- (mlet %store-monad
- ((graph (sequence %store-monad (map input->name+output inputs))))
- (expression->derivation-in-linux-vm
- name
- #~(begin
- (use-modules (guix build vm)
- (guix build utils))
-
- (let ((inputs
- '#$(append (list qemu parted grub e2fsprogs util-linux)
- (map (compose car (cut assoc-ref %final-inputs <>))
- '("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
+the image."
+ (expression->derivation-in-linux-vm
+ name
+ (with-imported-modules (source-module-closure '((gnu build vm)
+ (guix build utils)))
+ #~(begin
+ (use-modules (gnu build vm)
+ (guix build utils))
+
+ (let ((inputs
+ '#$(append (list qemu parted grub e2fsprogs)
+ (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)))
+ ((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 #: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
- #:directives '#$populate)
- (reboot))))
- #:system system
- #:make-disk-image? #t
- #:disk-image-size disk-image-size
- #:references-graphs graph)))
+ (set-path-environment-variable "PATH" '("bin" "sbin") inputs)
+
+ (let* ((graphs '#$(match inputs
+ (((names . _) ...)
+ names)))
+ (initialize (root-partition-initializer
+ #:closures graphs
+ #:copy-closures? #$copy-inputs?
+ #:register-closures? #$register-closures?
+ #:system-directory #$os-derivation))
+ (partitions (list (partition
+ (size #$(- disk-image-size
+ (* 10 (expt 2 20))))
+ (label #$file-system-label)
+ (file-system #$file-system-type)
+ (bootable? #t)
+ (initializer initialize)))))
+ (initialize-hard-disk "/dev/vda"
+ #:partitions partitions
+ #:grub.cfg #$grub-configuration)
+ (reboot)))))
+ #:system system
+ #:make-disk-image? #t
+ #:disk-image-size disk-image-size
+ #:disk-image-format disk-image-format
+ #:references-graphs inputs))
\f
;;;
-;;; Stand-alone VM image.
+;;; VM and disk images.
;;;
-(define (operating-system-build-gid os)
- "Return as a monadic value the group id for build users of OS, or #f."
- (mlet %store-monad ((services (operating-system-services os)))
- (return (any (lambda (service)
- (and (equal? '(guix-daemon)
- (service-provision service))
- (match (service-user-groups service)
- ((group)
- (user-group-id group)))))
- services))))
-
-(define (operating-system-default-contents os)
- "Return a list of directives suitable for 'system-qemu-image' describing the
-basic contents of the root file system of OS."
- (mlet* %store-monad ((os-drv (operating-system-derivation os))
- (build-gid (operating-system-build-gid os))
- (profile (operating-system-profile os)))
- (return #~((directory #$(%store-prefix) 0 #$(or build-gid 0))
- (directory "/etc")
- (directory "/var/log") ; for dmd
- (directory "/var/run/nscd")
- (directory "/var/guix/gcroots")
- ("/var/guix/gcroots/system" -> #$os-drv)
- (directory "/run")
- ("/run/current-system" -> #$profile)
- (directory "/bin")
- ("/bin/sh" -> "/run/current-system/bin/bash")
- (directory "/tmp")
- (directory "/var/guix/profiles/per-user/root" 0 0)
-
- (directory "/root" 0 0) ; an exception
- (directory "/home" 0 0)))))
+(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. Assume USB
+ ;; mass storage devices (usb-storage.ko) are available.
+ (initrd (lambda (file-systems . rest)
+ (apply base-initrd file-systems
+ #:volatile-root? #t
+ 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))
+ (bootcfg (operating-system-bootcfg os)))
+ (qemu-image #:name name
+ #:os-derivation os-drv
+ #:grub-configuration bootcfg
+ #: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)
+ ("bootcfg" ,bootcfg))))))
(define* (system-qemu-image os
#:key
(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
+ rest)))
+
;; Force our own root file system.
(file-systems (cons (file-system
(mount-point "/")
file-systems-to-keep)))))
(mlet* %store-monad
((os-drv (operating-system-derivation os))
- (os-dir -> (derivation->output-path os-drv))
- (grub.cfg -> (string-append os-dir "/grub.cfg"))
- (populate (operating-system-default-contents os)))
- (qemu-image #:grub-configuration grub.cfg
- #:populate populate
+ (bootcfg (operating-system-bootcfg os)))
+ (qemu-image #:os-derivation os-drv
+ #:grub-configuration bootcfg
#:disk-image-size disk-image-size
#:file-system-type file-system-type
- #:inputs `(("system" ,os-drv))
+ #:inputs `(("system" ,os-drv)
+ ("bootcfg" ,bootcfg))
#:copy-inputs? #t))))
-(define (virtualized-operating-system os)
+\f
+;;;
+;;; VMs that share file systems with the host.
+;;;
+
+(define (file-system->mount-tag fs)
+ "Return a 9p mount tag for host file system FS."
+ ;; QEMU mount tags cannot contain slashes and cannot start with '_'.
+ ;; Compute an identifier that corresponds to the rules.
+ (string-append "TAG"
+ (string-map (match-lambda
+ (#\/ #\_)
+ (chr chr))
+ fs)))
+
+(define (mapping->file-system mapping)
+ "Return a 9p file system that realizes MAPPING."
+ (match mapping
+ (($ <file-system-mapping> source target writable?)
+ (file-system
+ (mount-point target)
+ (device (file-system->mount-tag source))
+ (type "9p")
+ (flags (if writable? '() '(read-only)))
+ (options (string-append "trans=virtio"))
+ (check? #f)
+ (create-mount-point? #t)))))
+
+(define* (virtualized-operating-system os mappings #:optional (full-boot? #f))
"Return an operating system based on OS suitable for use in a virtualized
-environment with the store shared with the host."
+environment with the store shared with the host. MAPPINGS is a list of
+<file-system-mapping> to realize in the virtualized OS."
+ (define user-file-systems
+ ;; Remove file systems that conflict with those added below, 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 "/")
+ (and (eq? 'device (file-system-title fs))
+ (string-prefix? "/dev/" source)))))
+ (operating-system-file-systems os)))
+
+ (define virtual-file-systems
+ (cons (file-system
+ (mount-point "/")
+ (device "/dev/vda1")
+ (type "ext4"))
+
+ (append (map mapping->file-system mappings)
+ user-file-systems)))
+
(operating-system (inherit os)
- (initrd (cut qemu-initrd <> #:volatile-root? #t))
- (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))))))
+ (initrd (lambda (file-systems . rest)
+ (apply base-initrd file-systems
+ #:volatile-root? #t
+ #:virtio? #t
+ rest)))
+
+ ;; Disable swap.
+ (swap-devices '())
+
+ ;; XXX: When FULL-BOOT? is true, do not add a 9p mount for /gnu/store
+ ;; since that would lead the bootloader config to look for the kernel and
+ ;; initrd in it.
+ (file-systems (if full-boot?
+ virtual-file-systems
+ (cons
+ (file-system
+ (inherit (mapping->file-system %store-mapping))
+ (needed-for-boot? #t))
+ virtual-file-systems)))))
(define* (system-qemu-image/shared-store
os
- #:key (disk-image-size (* 15 (expt 2 20))))
+ #:key
+ full-boot?
+ (disk-image-size (* (if full-boot? 500 30) (expt 2 20))))
"Return a derivation that builds a QEMU image of OS that shares its store
-with the host."
- (mlet* %store-monad
- ((os-drv (operating-system-derivation os))
- (os-dir -> (derivation->output-path os-drv))
- (grub.cfg -> (string-append os-dir "/grub.cfg"))
- (populate (operating-system-default-contents os)))
- (qemu-image #:grub-configuration grub.cfg
- #:populate populate
+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))
+ (bootcfg (operating-system-bootcfg os)))
+ ;; XXX: When FULL-BOOT? is true, we end up creating an image that contains
+ ;; BOOTCFG 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 bootcfg
#:disk-image-size disk-image-size
- #:inputs `(("system" ,os-drv))
+ #:inputs (if full-boot?
+ `(("bootcfg" ,bootcfg))
+ '())
;; XXX: Passing #t here is too slow, so let it off by default.
#:register-closures? #f
- #:copy-inputs? #f)))
-
-(define* (system-qemu-image/shared-store-script
- os
- #:key
- (qemu qemu)
- (graphic? #t))
+ #:copy-inputs? full-boot?)))
+
+(define* (common-qemu-options image shared-fs)
+ "Return the a string-value gexp with the common QEMU options to boot IMAGE,
+with '-virtfs' options for the host file systems listed in SHARED-FS."
+
+ (define (virtfs-option fs)
+ #~(format #f "-virtfs local,path=~s,security_model=none,mount_tag=~s"
+ #$fs #$(file-system->mount-tag fs)))
+
+ #~(;; Only enable kvm if we see /dev/kvm exists.
+ ;; This allows users without hardware virtualization to still use these
+ ;; commands.
+ #$@(if (file-exists? "/dev/kvm")
+ '("-enable-kvm")
+ '())
+
+ "-no-reboot"
+ "-net nic,model=virtio"
+
+ #$@(map virtfs-option shared-fs)
+ "-vga std"
+ (format #f "-drive file=~a,if=virtio,cache=writeback,werror=report,readonly"
+ #$image)
+ "-m 256"))
+
+(define* (system-qemu-image/shared-store-script os
+ #:key
+ (qemu qemu)
+ (graphic? #t)
+ (mappings '())
+ full-boot?
+ (disk-image-size
+ (* (if full-boot? 500 30)
+ (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."
- (mlet* %store-monad
- ((os -> (virtualized-operating-system os))
- (os-drv (operating-system-derivation os))
- (image (system-qemu-image/shared-store os)))
+OS that shares its store with the host.
+
+MAPPINGS is a list of <file-system-mapping> specifying mapping of host file
+systems into the guest.
+
+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 mappings full-boot?))
+ (os-drv (operating-system-derivation os))
+ (image (system-qemu-image/shared-store
+ os
+ #:full-boot? full-boot?
+ #:disk-image-size disk-image-size)))
+ (define kernel-arguments
+ #~(list #$@(if graphic? #~() #~("console=ttyS0"))
+ #+@(operating-system-kernel-arguments os os-drv "/dev/vda1")))
+
+ (define qemu-exec
+ #~(list (string-append #$qemu "/bin/" #$(qemu-command (%current-system)))
+ #$@(if full-boot?
+ #~()
+ #~("-kernel" #$(operating-system-kernel-file os)
+ "-initrd" #$(file-append os-drv "/initrd")
+ (format #f "-append ~s"
+ (string-join #$kernel-arguments " "))))
+ #$@(common-qemu-options image
+ (map file-system-mapping-source
+ (cons %store-mapping mappings)))))
+
(define builder
#~(call-with-output-file #$output
(lambda (port)
- (display
- (string-append "#!" #$bash "/bin/sh
-exec " #$qemu "/bin/qemu-system-x86_64 -enable-kvm -no-reboot -net nic,model=virtio \
- -virtfs local,path=" #$(%store-prefix) ",security_model=none,mount_tag=store \
- -net user \
- -kernel " #$(operating-system-kernel os) "/bzImage \
- -initrd " #$os-drv "/initrd \
--append \"" #$(if graphic? "" "console=ttyS0 ")
- "--load=" #$os-drv "/boot --root=/dev/vda1\" \
- -serial stdio \
- -drive file=" #$image
- ",if=virtio,cache=writeback,werror=report,readonly\n")
- port)
+ (format port "#!~a~% exec ~a \"$@\"~%"
+ #$(file-append bash "/bin/sh")
+ (string-join #$qemu-exec " "))
(chmod port #o555))))
(gexp->derivation "run-vm.sh" builder)))
HCoop / jackhill / guix / guix.git / blobdiff