Commit | Line | Data |
---|---|---|
04086015 | 1 | ;;; GNU Guix --- Functional package management for GNU |
09844816 | 2 | ;;; Copyright © 2013, 2014, 2015, 2016, 2017, 2018, 2019, 2020 Ludovic Courtès <ludo@gnu.org> |
944d2b17 | 3 | ;;; Copyright © 2016 Christopher Allan Webber <cwebber@dustycloud.org> |
2ca712bd | 4 | ;;; Copyright © 2016, 2017 Leo Famulari <leo@famulari.name> |
07f812c4 | 5 | ;;; Copyright © 2017 Mathieu Othacehe <m.othacehe@gmail.com> |
ecf5d537 | 6 | ;;; Copyright © 2017 Marius Bakke <mbakke@fastmail.com> |
8c9bf294 | 7 | ;;; Copyright © 2018 Chris Marusich <cmmarusich@gmail.com> |
04086015 LC |
8 | ;;; |
9 | ;;; This file is part of GNU Guix. | |
10 | ;;; | |
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. | |
15 | ;;; | |
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. | |
20 | ;;; | |
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/>. | |
23 | ||
24 | (define-module (gnu system vm) | |
93d44bd8 | 25 | #:use-module (guix config) |
04086015 | 26 | #:use-module (guix store) |
02100028 | 27 | #:use-module (guix gexp) |
04086015 LC |
28 | #:use-module (guix derivations) |
29 | #:use-module (guix packages) | |
d9f0a237 | 30 | #:use-module (guix monads) |
fcf63cf8 | 31 | #:use-module (guix records) |
239c6e27 | 32 | #:use-module (guix modules) |
00e39b2e | 33 | #:use-module (guix utils) |
ca719424 | 34 | #:use-module (gcrypt hash) |
dffc5ab5 | 35 | #:use-module (guix base32) |
c45477d2 | 36 | #:use-module ((guix self) #:select (make-config.scm)) |
fcf63cf8 | 37 | |
548f7a8f | 38 | #:use-module ((gnu build vm) |
66670cf3 | 39 | #:select (qemu-command)) |
bdb36958 | 40 | #:use-module (gnu packages base) |
862e38d5 | 41 | #:use-module (gnu packages bootloaders) |
be1033a3 | 42 | #:use-module (gnu packages cdrom) |
a335f6fc | 43 | #:use-module (gnu packages compression) |
1b89a66e | 44 | #:use-module (gnu packages guile) |
ca719424 | 45 | #:autoload (gnu packages gnupg) (guile-gcrypt) |
bdb36958 | 46 | #:use-module (gnu packages gawk) |
1b89a66e | 47 | #:use-module (gnu packages bash) |
4f62d8d6 | 48 | #:use-module (gnu packages less) |
59132b80 | 49 | #:use-module (gnu packages virtualization) |
cc4a2aeb | 50 | #:use-module (gnu packages disk) |
5b16ff09 | 51 | #:use-module (gnu packages zile) |
04086015 | 52 | #:use-module (gnu packages linux) |
9de46ffb | 53 | #:use-module (gnu packages admin) |
0ded70f3 | 54 | |
9121ce55 | 55 | #:use-module (gnu bootloader) |
9b396c0c | 56 | #:use-module (gnu bootloader grub) |
0ded70f3 | 57 | #:use-module (gnu system shadow) |
6e828634 | 58 | #:use-module (gnu system pam) |
69cae3d3 | 59 | #:use-module (gnu system linux-container) |
735c6dd7 | 60 | #:use-module (gnu system linux-initrd) |
b09a8da4 | 61 | #:use-module (gnu bootloader) |
c5df1839 | 62 | #:use-module (gnu system file-systems) |
033adfe7 | 63 | #:use-module (gnu system) |
db4fdc04 | 64 | #:use-module (gnu services) |
d03de6be | 65 | #:use-module (gnu services base) |
9b336338 | 66 | #:use-module (gnu system uuid) |
0ded70f3 | 67 | |
ca85d7bc | 68 | #:use-module (srfi srfi-1) |
04086015 | 69 | #:use-module (srfi srfi-26) |
5f7fe1c5 | 70 | #:use-module (rnrs bytevectors) |
04086015 | 71 | #:use-module (ice-9 match) |
0ded70f3 | 72 | |
04086015 | 73 | #:export (expression->derivation-in-linux-vm |
aedb72fb | 74 | qemu-image |
e9f693d0 | 75 | virtualized-operating-system |
fd3bfc44 | 76 | system-qemu-image |
fcf63cf8 | 77 | |
fd3bfc44 | 78 | system-qemu-image/shared-store |
1e77fedb | 79 | system-qemu-image/shared-store-script |
f19cf27c | 80 | system-disk-image-in-vm |
a335f6fc | 81 | system-docker-image |
ed419fa0 LC |
82 | |
83 | virtual-machine | |
84 | virtual-machine?)) | |
04086015 LC |
85 | |
86 | \f | |
87 | ;;; Commentary: | |
88 | ;;; | |
89 | ;;; Tools to evaluate build expressions within virtual machines. | |
90 | ;;; | |
91 | ;;; Code: | |
92 | ||
83bcd0b8 | 93 | (define %linux-vm-file-systems |
8c9bf294 CM |
94 | ;; File systems mounted for 'derivation-in-linux-vm'. These are shared with |
95 | ;; the host over 9p. | |
66ec3895 LC |
96 | ;; |
97 | ;; The 9p documentation says that cache=loose is "intended for exclusive, | |
98 | ;; read-only mounts", without additional details. It's much faster than the | |
99 | ;; default cache=none, especially when copying and registering store items. | |
100 | ;; Thus, use cache=loose, except for /xchg where we want to ensure | |
101 | ;; consistency. | |
83bcd0b8 LC |
102 | (list (file-system |
103 | (mount-point (%store-prefix)) | |
104 | (device "store") | |
105 | (type "9p") | |
106 | (needed-for-boot? #t) | |
fce22547 LC |
107 | (flags '(read-only)) |
108 | (options "trans=virtio,cache=loose") | |
3c05b4bc | 109 | (check? #f)) |
83bcd0b8 LC |
110 | (file-system |
111 | (mount-point "/xchg") | |
112 | (device "xchg") | |
113 | (type "9p") | |
114 | (needed-for-boot? #t) | |
66ec3895 | 115 | (options "trans=virtio") |
8c9bf294 CM |
116 | (check? #f)) |
117 | (file-system | |
118 | (mount-point "/tmp") | |
119 | (device "tmp") | |
120 | (type "9p") | |
121 | (needed-for-boot? #t) | |
fce22547 | 122 | (options "trans=virtio,cache=loose") |
3c05b4bc | 123 | (check? #f)))) |
83bcd0b8 | 124 | |
c45477d2 LC |
125 | (define not-config? |
126 | ;; Select (guix …) and (gnu …) modules, except (guix config). | |
127 | (match-lambda | |
128 | (('guix 'config) #f) | |
129 | (('guix rest ...) #t) | |
130 | (('gnu rest ...) #t) | |
131 | (rest #f))) | |
132 | ||
ca719424 LC |
133 | (define gcrypt-sqlite3&co |
134 | ;; Guile-Gcrypt, Guile-SQLite3, and their propagated inputs. | |
135 | (append-map (lambda (package) | |
136 | (cons package | |
910d0121 LC |
137 | (match (package-transitive-propagated-inputs package) |
138 | (((labels packages) ...) | |
139 | packages)))) | |
ca719424 | 140 | (list guile-gcrypt guile-sqlite3))) |
c45477d2 | 141 | |
d9f0a237 | 142 | (define* (expression->derivation-in-linux-vm name exp |
04086015 | 143 | #:key |
b3477234 | 144 | (system (%current-system)) |
04086015 | 145 | (linux linux-libre) |
735c6dd7 | 146 | initrd |
06da1a6b | 147 | (qemu qemu-minimal) |
04086015 | 148 | (env-vars '()) |
04086015 LC |
149 | (guile-for-build |
150 | (%guile-for-build)) | |
50e53c1c LC |
151 | (file-systems |
152 | %linux-vm-file-systems) | |
04086015 | 153 | |
8d033e3e | 154 | (single-file-output? #f) |
04086015 | 155 | (make-disk-image? #f) |
ca85d7bc | 156 | (references-graphs #f) |
defa1b9b | 157 | (memory-size 256) |
c4a74364 | 158 | (disk-image-format "qcow2") |
a328f66a LC |
159 | (disk-image-size 'guess) |
160 | ||
161 | (substitutable? #t)) | |
735c6dd7 | 162 | "Evaluate EXP in a QEMU virtual machine running LINUX with INITRD (a |
8d033e3e | 163 | derivation). The virtual machine runs with MEMORY-SIZE MiB of memory. In the |
50e53c1c LC |
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. | |
8d033e3e LC |
167 | |
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. | |
04086015 | 170 | |
c4a74364 LC |
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 | |
a8ac4f08 LC |
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. | |
ca85d7bc LC |
175 | |
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 | |
a328f66a LC |
178 | made available under the /xchg CIFS share. |
179 | ||
180 | SUBSTITUTABLE? determines whether the returned derivation should be marked as | |
181 | substitutable." | |
be43c08b LC |
182 | (define user-builder |
183 | (program-file "builder-in-linux-vm" exp)) | |
184 | ||
185 | (define loader | |
186 | ;; Invoke USER-BUILDER instead using 'primitive-load'. The reason for | |
187 | ;; this is to allow USER-BUILDER to dlopen stuff by using a full-featured | |
188 | ;; Guile, which it couldn't do using the statically-linked guile used in | |
189 | ;; the initrd. See example at | |
190 | ;; <https://lists.gnu.org/archive/html/guix-devel/2017-10/msg00233.html>. | |
191 | (program-file "linux-vm-loader" | |
be6520e6 LC |
192 | ;; Communicate USER-BUILDER's exit status via /xchg so that |
193 | ;; the host can distinguish between success, failure, and | |
194 | ;; kernel panic. | |
195 | #~(let ((status (system* #$user-builder))) | |
196 | (call-with-output-file "/xchg/.exit-status" | |
197 | (lambda (port) | |
198 | (write status port))) | |
199 | (sync) | |
200 | (reboot)))) | |
be43c08b | 201 | |
502f609d LC |
202 | (define-syntax-rule (check predicate) |
203 | (let-system (system target) | |
204 | (predicate (or target system)))) | |
205 | ||
e34ae75d LC |
206 | (let ((initrd (or initrd |
207 | (base-initrd file-systems | |
208 | #:on-error 'backtrace | |
209 | #:linux linux | |
210 | #:linux-modules %base-initrd-modules | |
211 | #:qemu-networking? #t)))) | |
1aa0033b LC |
212 | |
213 | (define builder | |
214 | ;; Code that launches the VM that evaluates EXP. | |
ca719424 | 215 | (with-extensions gcrypt-sqlite3&co |
c45477d2 LC |
216 | (with-imported-modules `(,@(source-module-closure |
217 | '((guix build utils) | |
218 | (gnu build vm)) | |
219 | #:select? not-config?) | |
ca719424 LC |
220 | |
221 | ;; For consumption by (gnu store database). | |
222 | ((guix config) => ,(make-config.scm))) | |
c45477d2 LC |
223 | #~(begin |
224 | (use-modules (guix build utils) | |
225 | (gnu build vm)) | |
226 | ||
d4ddf22d MO |
227 | (let* ((native-inputs |
228 | '#+(list qemu (canonical-package coreutils))) | |
b3477234 LC |
229 | (linux (string-append |
230 | #+linux "/" | |
231 | #+(system-linux-image-file-name system))) | |
232 | (initrd #+initrd) | |
233 | (loader #+loader) | |
c45477d2 LC |
234 | (graphs '#$(match references-graphs |
235 | (((graph-files . _) ...) graph-files) | |
236 | (_ #f))) | |
502f609d LC |
237 | (target #$(let-system (system target) |
238 | (or target system))) | |
c45477d2 LC |
239 | (size #$(if (eq? 'guess disk-image-size) |
240 | #~(+ (* 70 (expt 2 20)) ;ESP | |
241 | (estimated-partition-size graphs)) | |
242 | disk-image-size))) | |
243 | ||
d4ddf22d | 244 | (set-path-environment-variable "PATH" '("bin") native-inputs) |
c45477d2 LC |
245 | |
246 | (load-in-linux-vm loader | |
247 | #:output #$output | |
248 | #:linux linux #:initrd initrd | |
d4ddf22d | 249 | #:qemu (qemu-command target) |
c45477d2 LC |
250 | #:memory-size #$memory-size |
251 | #:make-disk-image? #$make-disk-image? | |
252 | #:single-file-output? #$single-file-output? | |
c45477d2 LC |
253 | #:disk-image-format #$disk-image-format |
254 | #:disk-image-size size | |
255 | #:references-graphs graphs)))))) | |
1aa0033b LC |
256 | |
257 | (gexp->derivation name builder | |
258 | ;; TODO: Require the "kvm" feature. | |
259 | #:system system | |
b3477234 | 260 | #:target #f ;EXP is always executed natively |
1aa0033b | 261 | #:env-vars env-vars |
1aa0033b | 262 | #:guile-for-build guile-for-build |
a328f66a LC |
263 | #:references-graphs references-graphs |
264 | #:substitutable? substitutable?))) | |
d9f0a237 | 265 | |
d03de6be MC |
266 | (define (has-guix-service-type? os) |
267 | "Return true if OS contains a service of the type GUIX-SERVICE-TYPE." | |
268 | (not (not (find (lambda (service) | |
269 | (eq? (service-kind service) guix-service-type)) | |
270 | (operating-system-services os))))) | |
271 | ||
d9f0a237 | 272 | (define* (qemu-image #:key |
04086015 LC |
273 | (name "qemu-image") |
274 | (system (%current-system)) | |
d4ddf22d | 275 | (target (%current-target-system)) |
06da1a6b | 276 | (qemu qemu-minimal) |
a8ac4f08 | 277 | (disk-image-size 'guess) |
c4a74364 | 278 | (disk-image-format "qcow2") |
03ddfaf5 | 279 | (file-system-type "ext4") |
4d1ff68d | 280 | (file-system-options '()) |
cd45d656 | 281 | (device-nodes 'linux) |
82782d8c | 282 | (extra-directives '()) |
ef9fc40d | 283 | file-system-label |
fd3b4b98 | 284 | file-system-uuid |
8bff7dc2 | 285 | os |
9121ce55 MO |
286 | bootcfg-drv |
287 | bootloader | |
d03de6be | 288 | (register-closures? (has-guix-service-type? os)) |
150e20dd | 289 | (inputs '()) |
a328f66a LC |
290 | copy-inputs? |
291 | (substitutable? #t)) | |
c4a74364 | 292 | "Return a bootable, stand-alone QEMU image of type DISK-IMAGE-FORMAT (e.g., |
ef9fc40d LC |
293 | 'qcow2' or 'raw'), with a root partition of type FILE-SYSTEM-TYPE. |
294 | Optionally, FILE-SYSTEM-LABEL can be specified as the volume name for the root | |
fd3b4b98 | 295 | partition; likewise FILE-SYSTEM-UUID, if true, specifies the UUID of the root |
4d1ff68d LC |
296 | partition (a UUID object). FILE-SYSTEM-OPTIONS is an optional list of |
297 | command-line options passed to 'mkfs.ext4' (or similar). | |
fd3b4b98 LC |
298 | |
299 | The returned image is a full disk image that runs OS-DERIVATION, | |
f2c403ea LC |
300 | with a GRUB installation that uses GRUB-CONFIGURATION as its configuration |
301 | file (GRUB-CONFIGURATION must be the name of a file in the VM.) | |
93d44bd8 | 302 | |
150e20dd LC |
303 | INPUTS is a list of inputs (as for packages). When COPY-INPUTS? is true, copy |
304 | all of INPUTS into the image being built. When REGISTER-CLOSURES? is true, | |
305 | register INPUTS in the store database of the image so that Guix can be used in | |
d03de6be MC |
306 | the image. By default, REGISTER-CLOSURES? is set to true only if a service of |
307 | type GUIX-SERVICE-TYPE is present in the services definition of the operating | |
82782d8c LC |
308 | system. |
309 | ||
cd45d656 LC |
310 | When DEVICE-NODES is 'linux, create Linux-device block and character devices |
311 | under /dev. When it is 'hurd, do Hurdish things. | |
312 | ||
82782d8c LC |
313 | EXTRA-DIRECTIVES is an optional list of directives to populate the root file |
314 | system that is passed to 'populate-root-file-system'." | |
c45477d2 LC |
315 | (define schema |
316 | (and register-closures? | |
317 | (local-file (search-path %load-path | |
318 | "guix/store/schema.sql")))) | |
319 | ||
b53833b2 LC |
320 | (expression->derivation-in-linux-vm |
321 | name | |
ca719424 | 322 | (with-extensions gcrypt-sqlite3&co |
c45477d2 LC |
323 | (with-imported-modules `(,@(source-module-closure '((gnu build vm) |
324 | (gnu build bootloader) | |
325 | (guix store database) | |
326 | (guix build utils)) | |
327 | #:select? not-config?) | |
ca719424 | 328 | ((guix config) => ,(make-config.scm))) |
c45477d2 LC |
329 | #~(begin |
330 | (use-modules (gnu build bootloader) | |
331 | (gnu build vm) | |
cd45d656 LC |
332 | ((gnu build linux-boot) |
333 | #:select (make-essential-device-nodes | |
334 | make-hurd-device-nodes)) | |
c45477d2 LC |
335 | (guix store database) |
336 | (guix build utils) | |
337 | (srfi srfi-26) | |
338 | (ice-9 binary-ports)) | |
339 | ||
340 | (sql-schema #$schema) | |
341 | ||
9c941364 LC |
342 | ;; Allow non-ASCII file names--e.g., 'nss-certs'--to be decoded. |
343 | (setenv "GUIX_LOCPATH" | |
344 | #+(file-append glibc-utf8-locales "/lib/locale")) | |
345 | (setlocale LC_ALL "en_US.utf8") | |
346 | ||
c45477d2 | 347 | (let ((inputs |
d4ddf22d | 348 | '#$(append (list parted e2fsprogs dosfstools) |
c45477d2 LC |
349 | (map canonical-package |
350 | (list sed grep coreutils findutils gawk)))) | |
351 | ||
352 | ;; This variable is unused but allows us to add INPUTS-TO-COPY | |
353 | ;; as inputs. | |
354 | (to-register | |
355 | '#$(map (match-lambda | |
356 | ((name thing) thing) | |
357 | ((name thing output) `(,thing ,output))) | |
358 | inputs))) | |
359 | ||
360 | (set-path-environment-variable "PATH" '("bin" "sbin") inputs) | |
361 | ||
362 | (let* ((graphs '#$(match inputs | |
363 | (((names . _) ...) | |
364 | names))) | |
365 | (initialize (root-partition-initializer | |
82782d8c | 366 | #:extra-directives '#$extra-directives |
c45477d2 LC |
367 | #:closures graphs |
368 | #:copy-closures? #$copy-inputs? | |
369 | #:register-closures? #$register-closures? | |
8bff7dc2 | 370 | #:system-directory #$os |
b5460d95 | 371 | |
cd45d656 LC |
372 | #:make-device-nodes |
373 | #$(match device-nodes | |
374 | ('linux #~make-essential-device-nodes) | |
375 | ('hurd #~make-hurd-device-nodes)) | |
376 | ||
b5460d95 LC |
377 | ;; Disable deduplication to speed things up, |
378 | ;; and because it doesn't help much for a | |
379 | ;; single system generation. | |
380 | #:deduplicate? #f)) | |
c45477d2 LC |
381 | (root-size #$(if (eq? 'guess disk-image-size) |
382 | #~(max | |
383 | ;; Minimum 20 MiB root size | |
384 | (* 20 (expt 2 20)) | |
385 | (estimated-partition-size | |
386 | (map (cut string-append "/xchg/" <>) | |
387 | graphs))) | |
388 | (- disk-image-size | |
389 | (* 50 (expt 2 20))))) | |
390 | (partitions | |
391 | (append | |
392 | (list (partition | |
393 | (size root-size) | |
394 | (label #$file-system-label) | |
395 | (uuid #$(and=> file-system-uuid | |
396 | uuid-bytevector)) | |
397 | (file-system #$file-system-type) | |
4d1ff68d | 398 | (file-system-options '#$file-system-options) |
c45477d2 LC |
399 | (flags '(boot)) |
400 | (initializer initialize))) | |
401 | ;; Append a small EFI System Partition for use with UEFI | |
402 | ;; bootloaders if we are not targeting ARM because UEFI | |
403 | ;; support in U-Boot is experimental. | |
404 | ;; | |
1ee72bb5 | 405 | ;; FIXME: ‘target-arm?’ may be not operate on the right |
c45477d2 LC |
406 | ;; system/target values. Rewrite using ‘let-system’ when |
407 | ;; available. | |
1ee72bb5 | 408 | (if #$(target-arm?) |
c45477d2 LC |
409 | '() |
410 | (list (partition | |
411 | ;; The standalone grub image is about 10MiB, but | |
412 | ;; leave some room for custom or multiple images. | |
413 | (size (* 40 (expt 2 20))) | |
414 | (label "GNU-ESP") ;cosmetic only | |
415 | ;; Use "vfat" here since this property is used | |
416 | ;; when mounting. The actual FAT-ness is based | |
417 | ;; on file system size (16 in this case). | |
418 | (file-system "vfat") | |
1ee72bb5 MO |
419 | (flags '(esp))))))) |
420 | (grub-efi #$(and (not (target-arm?)) grub-efi))) | |
c45477d2 LC |
421 | (initialize-hard-disk "/dev/vda" |
422 | #:partitions partitions | |
1ee72bb5 | 423 | #:grub-efi grub-efi |
c45477d2 LC |
424 | #:bootloader-package |
425 | #$(bootloader-package bootloader) | |
426 | #:bootcfg #$bootcfg-drv | |
427 | #:bootcfg-location | |
428 | #$(bootloader-configuration-file bootloader) | |
429 | #:bootloader-installer | |
430 | #$(bootloader-installer bootloader))))))) | |
b53833b2 LC |
431 | #:system system |
432 | #:make-disk-image? #t | |
433 | #:disk-image-size disk-image-size | |
434 | #:disk-image-format disk-image-format | |
a328f66a LC |
435 | #:references-graphs inputs |
436 | #:substitutable? substitutable?)) | |
04086015 | 437 | |
a335f6fc CM |
438 | (define* (system-docker-image os |
439 | #:key | |
247649d4 | 440 | (name "guix-docker-image") |
d6c43d7b LC |
441 | (register-closures? (has-guix-service-type? os)) |
442 | shared-network?) | |
a335f6fc | 443 | "Build a docker image. OS is the desired <operating-system>. NAME is the |
d6c43d7b LC |
444 | base name to use for the output file. When SHARED-NETWORK? is true, assume |
445 | that the container will share network with the host and thus doesn't need a | |
446 | DHCP client, nscd, and so on. | |
447 | ||
448 | When REGISTER-CLOSURES? is true, register the closure of OS with Guix in the | |
449 | resulting Docker image. By default, REGISTER-CLOSURES? is set to true only if | |
450 | a service of type GUIX-SERVICE-TYPE is present in the services definition of | |
451 | the operating system." | |
c45477d2 LC |
452 | (define schema |
453 | (and register-closures? | |
454 | (local-file (search-path %load-path | |
455 | "guix/store/schema.sql")))) | |
9f160a0d | 456 | |
247649d4 LC |
457 | (define boot-program |
458 | ;; Program that runs the boot script of OS, which in turn starts shepherd. | |
459 | (program-file "boot-program" | |
460 | #~(let ((system (cadr (command-line)))) | |
461 | (setenv "GUIX_NEW_SYSTEM" system) | |
462 | (execl #$(file-append guile-2.2 "/bin/guile") | |
463 | "guile" "--no-auto-compile" | |
464 | (string-append system "/boot"))))) | |
465 | ||
466 | ||
467 | (let ((os (operating-system-with-gc-roots | |
d6c43d7b LC |
468 | (containerized-operating-system os '() |
469 | #:shared-network? | |
470 | shared-network?) | |
247649d4 | 471 | (list boot-program))) |
69cae3d3 LC |
472 | (name (string-append name ".tar.gz")) |
473 | (graph "system-graph")) | |
a335f6fc | 474 | (define build |
81c3dc32 | 475 | (with-extensions (cons guile-json-3 ;for (guix docker) |
ca719424 | 476 | gcrypt-sqlite3&co) ;for (guix store database) |
9f160a0d LC |
477 | (with-imported-modules `(,@(source-module-closure |
478 | '((guix docker) | |
c45477d2 | 479 | (guix store database) |
9f160a0d | 480 | (guix build utils) |
c45477d2 | 481 | (guix build store-copy) |
9f160a0d LC |
482 | (gnu build vm)) |
483 | #:select? not-config?) | |
ca719424 | 484 | ((guix config) => ,(make-config.scm))) |
9f160a0d LC |
485 | #~(begin |
486 | (use-modules (guix docker) | |
487 | (guix build utils) | |
488 | (gnu build vm) | |
489 | (srfi srfi-19) | |
c45477d2 LC |
490 | (guix build store-copy) |
491 | (guix store database)) | |
492 | ||
493 | ;; Set the SQL schema location. | |
494 | (sql-schema #$schema) | |
9f160a0d | 495 | |
ed504caf LC |
496 | ;; Allow non-ASCII file names--e.g., 'nss-certs'--to be decoded. |
497 | (setenv "GUIX_LOCPATH" | |
498 | #+(file-append glibc-utf8-locales "/lib/locale")) | |
499 | (setlocale LC_ALL "en_US.utf8") | |
500 | ||
c45477d2 | 501 | (let* (;; This initializer requires elevated privileges that are |
9f160a0d LC |
502 | ;; not normally available in the build environment (e.g., |
503 | ;; it needs to create device nodes). In order to obtain | |
504 | ;; such privileges, we run it as root in a VM. | |
505 | (initialize (root-partition-initializer | |
506 | #:closures '(#$graph) | |
507 | #:register-closures? #$register-closures? | |
69cae3d3 | 508 | #:system-directory #$os |
9f160a0d LC |
509 | ;; De-duplication would fail due to |
510 | ;; cross-device link errors, so don't do it. | |
511 | #:deduplicate? #f)) | |
512 | ;; Even as root in a VM, the initializer would fail due to | |
513 | ;; lack of privileges if we use a root-directory that is on | |
514 | ;; a file system that is shared with the host (e.g., /tmp). | |
515 | (root-directory "/guixsd-system-root")) | |
c45477d2 | 516 | (set-path-environment-variable "PATH" '("bin" "sbin") '(#+tar)) |
9f160a0d LC |
517 | (mkdir root-directory) |
518 | (initialize root-directory) | |
519 | (build-docker-image | |
520 | (string-append "/xchg/" #$name) ;; The output file. | |
521 | (cons* root-directory | |
6892f0a2 LC |
522 | (map store-info-item |
523 | (call-with-input-file | |
524 | (string-append "/xchg/" #$graph) | |
525 | read-reference-graph))) | |
69cae3d3 | 526 | #$os |
247649d4 | 527 | #:entry-point '(#$boot-program #$os) |
9f160a0d LC |
528 | #:compressor '(#+(file-append gzip "/bin/gzip") "-9n") |
529 | #:creation-time (make-time time-utc 0 1) | |
66ec3895 | 530 | #:transformations `((,root-directory -> "")))))))) |
247649d4 | 531 | |
a335f6fc | 532 | (expression->derivation-in-linux-vm |
be43c08b | 533 | name build |
a335f6fc CM |
534 | #:make-disk-image? #f |
535 | #:single-file-output? #t | |
69cae3d3 | 536 | #:references-graphs `((,graph ,os))))) |
a335f6fc | 537 | |
04086015 LC |
538 | \f |
539 | ;;; | |
1e77fedb | 540 | ;;; VM and disk images. |
04086015 LC |
541 | ;;; |
542 | ||
f19cf27c MO |
543 | (define* (system-disk-image-in-vm os |
544 | #:key | |
545 | (name "disk-image") | |
546 | (file-system-type "ext4") | |
547 | (disk-image-size (* 900 (expt 2 20))) | |
548 | (volatile? #t) | |
549 | (substitutable? #t)) | |
1e77fedb LC |
550 | "Return the derivation of a disk image of DISK-IMAGE-SIZE bytes of the |
551 | system described by OS. Said image can be copied on a USB stick as is. When | |
552 | VOLATILE? is true, the root file system is made volatile; this is useful | |
a328f66a LC |
553 | to USB sticks meant to be read-only. |
554 | ||
555 | SUBSTITUTABLE? determines whether the returned derivation should be marked as | |
556 | substitutable." | |
10ace2c4 | 557 | (define root-label |
77f52962 | 558 | "Guix_image") |
10ace2c4 | 559 | |
5be7aecd | 560 | (define (root-uuid os) |
5f7fe1c5 LC |
561 | ;; UUID of the root file system, computed in a deterministic fashion. |
562 | ;; This is what we use to locate the root file system so it has to be | |
563 | ;; different from the user's own file system UUIDs. | |
77f52962 | 564 | (operating-system-uuid os 'dce)) |
5f7fe1c5 | 565 | |
1e77fedb LC |
566 | (define file-systems-to-keep |
567 | (remove (lambda (fs) | |
568 | (string=? (file-system-mount-point fs) "/")) | |
569 | (operating-system-file-systems os))) | |
570 | ||
8bff7dc2 LC |
571 | (let* ((os (operating-system (inherit os) |
572 | ;; Since this is meant to be used on real hardware, don't | |
573 | ;; install QEMU networking or anything like that. Assume USB | |
574 | ;; mass storage devices (usb-storage.ko) are available. | |
575 | (initrd (lambda (file-systems . rest) | |
576 | (apply (operating-system-initrd os) | |
577 | file-systems | |
67ed5442 | 578 | #:volatile-root? volatile? |
8bff7dc2 LC |
579 | rest))) |
580 | ||
77f52962 | 581 | (bootloader (operating-system-bootloader os)) |
8bff7dc2 | 582 | |
5be7aecd LC |
583 | ;; Force our own root file system. (We need a "/" file system |
584 | ;; to call 'root-uuid'.) | |
8bff7dc2 LC |
585 | (file-systems (cons (file-system |
586 | (mount-point "/") | |
5be7aecd LC |
587 | (device "/dev/placeholder") |
588 | (type file-system-type)) | |
589 | file-systems-to-keep)))) | |
590 | (uuid (root-uuid os)) | |
591 | (os (operating-system | |
592 | (inherit os) | |
593 | (file-systems (cons (file-system | |
594 | (mount-point "/") | |
595 | (device uuid) | |
8bff7dc2 LC |
596 | (type file-system-type)) |
597 | file-systems-to-keep)))) | |
598 | (bootcfg (operating-system-bootcfg os))) | |
77f52962 MO |
599 | (qemu-image #:name name |
600 | #:os os | |
601 | #:bootcfg-drv bootcfg | |
602 | #:bootloader (bootloader-configuration-bootloader | |
603 | (operating-system-bootloader os)) | |
604 | #:disk-image-size disk-image-size | |
605 | #:disk-image-format "raw" | |
606 | #:file-system-type file-system-type | |
607 | #:file-system-label root-label | |
608 | #:file-system-uuid uuid | |
609 | #:copy-inputs? #t | |
610 | #:inputs `(("system" ,os) | |
611 | ("bootcfg" ,bootcfg)) | |
612 | #:substitutable? substitutable?))) | |
1e77fedb | 613 | |
0b14d1d7 | 614 | (define* (system-qemu-image os |
66f23d66 LC |
615 | #:key |
616 | (file-system-type "ext4") | |
617 | (disk-image-size (* 900 (expt 2 20)))) | |
618 | "Return the derivation of a freestanding QEMU image of DISK-IMAGE-SIZE bytes | |
619 | of the GNU system as described by OS." | |
1eeccc2f LC |
620 | (define file-systems-to-keep |
621 | ;; Keep only file systems other than root and not normally bound to real | |
622 | ;; devices. | |
623 | (remove (lambda (fs) | |
624 | (let ((target (file-system-mount-point fs)) | |
625 | (source (file-system-device fs))) | |
626 | (or (string=? target "/") | |
627 | (string-prefix? "/dev/" source)))) | |
628 | (operating-system-file-systems os))) | |
629 | ||
61b94b8c LC |
630 | (define root-uuid |
631 | ;; UUID of the root file system. | |
632 | (operating-system-uuid os | |
633 | (if (string=? file-system-type "iso9660") | |
634 | 'iso9660 | |
635 | 'dce))) | |
636 | ||
637 | ||
8bff7dc2 LC |
638 | (let* ((os (operating-system (inherit os) |
639 | ;; Assume we have an initrd with the whole QEMU shebang. | |
640 | ||
641 | ;; Force our own root file system. Refer to it by UUID so that | |
642 | ;; it works regardless of how the image is used ("qemu -hda", | |
643 | ;; Xen, etc.). | |
644 | (file-systems (cons (file-system | |
645 | (mount-point "/") | |
646 | (device root-uuid) | |
647 | (type file-system-type)) | |
648 | file-systems-to-keep)))) | |
649 | (bootcfg (operating-system-bootcfg os))) | |
650 | (qemu-image #:os os | |
651 | #:bootcfg-drv bootcfg | |
652 | #:bootloader (bootloader-configuration-bootloader | |
653 | (operating-system-bootloader os)) | |
654 | #:disk-image-size disk-image-size | |
655 | #:file-system-type file-system-type | |
656 | #:file-system-uuid root-uuid | |
657 | #:inputs `(("system" ,os) | |
658 | ("bootcfg" ,bootcfg)) | |
659 | #:copy-inputs? #t))) | |
04086015 | 660 | |
fcf63cf8 LC |
661 | \f |
662 | ;;; | |
663 | ;;; VMs that share file systems with the host. | |
664 | ;;; | |
665 | ||
96ffa27b LC |
666 | (define (file-system->mount-tag fs) |
667 | "Return a 9p mount tag for host file system FS." | |
dffc5ab5 LC |
668 | ;; QEMU mount tags must be ASCII, at most 31-byte long, cannot contain |
669 | ;; slashes, and cannot start with '_'. Compute an identifier that | |
670 | ;; corresponds to the rules. | |
96ffa27b | 671 | (string-append "TAG" |
dffc5ab5 LC |
672 | (string-drop (bytevector->base32-string |
673 | (sha1 (string->utf8 fs))) | |
674 | 4))) | |
96ffa27b | 675 | |
fcf63cf8 LC |
676 | (define (mapping->file-system mapping) |
677 | "Return a 9p file system that realizes MAPPING." | |
678 | (match mapping | |
679 | (($ <file-system-mapping> source target writable?) | |
680 | (file-system | |
681 | (mount-point target) | |
682 | (device (file-system->mount-tag source)) | |
683 | (type "9p") | |
684 | (flags (if writable? '() '(read-only))) | |
e0d96774 | 685 | (options "trans=virtio,cache=loose") |
fcf63cf8 LC |
686 | (check? #f) |
687 | (create-mount-point? #t))))) | |
688 | ||
909de139 | 689 | (define* (virtualized-operating-system os mappings #:optional (full-boot? #f)) |
83bcd0b8 | 690 | "Return an operating system based on OS suitable for use in a virtualized |
fcf63cf8 LC |
691 | environment with the store shared with the host. MAPPINGS is a list of |
692 | <file-system-mapping> to realize in the virtualized OS." | |
693 | (define user-file-systems | |
694 | ;; Remove file systems that conflict with those added below, or that are | |
695 | ;; normally bound to real devices. | |
696 | (remove (lambda (fs) | |
697 | (let ((target (file-system-mount-point fs)) | |
698 | (source (file-system-device fs))) | |
699 | (or (string=? target (%store-prefix)) | |
700 | (string=? target "/") | |
a5acc17a | 701 | (and (string? source) |
f00515b4 LC |
702 | (string-prefix? "/dev/" source)) |
703 | ||
704 | ;; Labels and UUIDs are necessarily invalid in the VM. | |
705 | (and (file-system-mount? fs) | |
a5acc17a | 706 | (or (file-system-label? source) |
f00515b4 | 707 | (uuid? source)))))) |
fcf63cf8 LC |
708 | (operating-system-file-systems os))) |
709 | ||
909de139 DC |
710 | (define virtual-file-systems |
711 | (cons (file-system | |
712 | (mount-point "/") | |
713 | (device "/dev/vda1") | |
714 | (type "ext4")) | |
715 | ||
716 | (append (map mapping->file-system mappings) | |
717 | user-file-systems))) | |
718 | ||
83bcd0b8 | 719 | (operating-system (inherit os) |
9b396c0c LC |
720 | |
721 | ;; XXX: Until we run QEMU with UEFI support (with the OVMF firmware), | |
722 | ;; force the traditional i386/BIOS method. | |
723 | ;; See <https://bugs.gnu.org/28768>. | |
724 | (bootloader (bootloader-configuration | |
132823c2 | 725 | (inherit (operating-system-bootloader os)) |
9b396c0c LC |
726 | (bootloader grub-bootloader) |
727 | (target "/dev/vda"))) | |
728 | ||
52ac153e | 729 | (initrd (lambda (file-systems . rest) |
b8e77811 MO |
730 | (apply (operating-system-initrd os) |
731 | file-systems | |
52ac153e | 732 | #:volatile-root? #t |
52ac153e | 733 | rest))) |
65fb4515 LC |
734 | |
735 | ;; Disable swap. | |
736 | (swap-devices '()) | |
737 | ||
909de139 DC |
738 | ;; XXX: When FULL-BOOT? is true, do not add a 9p mount for /gnu/store |
739 | ;; since that would lead the bootloader config to look for the kernel and | |
740 | ;; initrd in it. | |
741 | (file-systems (if full-boot? | |
742 | virtual-file-systems | |
743 | (cons | |
744 | (file-system | |
745 | (inherit (mapping->file-system %store-mapping)) | |
746 | (needed-for-boot? #t)) | |
747 | virtual-file-systems))))) | |
83bcd0b8 | 748 | |
fd3bfc44 | 749 | (define* (system-qemu-image/shared-store |
0b14d1d7 | 750 | os |
6aa260af LC |
751 | #:key |
752 | full-boot? | |
4c0416ae | 753 | (disk-image-size (* (if full-boot? 500 30) (expt 2 20)))) |
fd3bfc44 | 754 | "Return a derivation that builds a QEMU image of OS that shares its store |
6aa260af LC |
755 | with the host. |
756 | ||
757 | When FULL-BOOT? is true, return an image that does a complete boot sequence, | |
758 | bootloaded included; thus, make a disk image that contains everything the | |
759 | bootloader refers to: OS kernel, initrd, bootloader data, etc." | |
56f9d442 LC |
760 | (define root-uuid |
761 | ;; Use a fixed UUID to improve determinism. | |
762 | (operating-system-uuid os 'dce)) | |
763 | ||
8bff7dc2 LC |
764 | (define bootcfg |
765 | (operating-system-bootcfg os)) | |
766 | ||
767 | ;; XXX: When FULL-BOOT? is true, we end up creating an image that contains | |
768 | ;; BOOTCFG and all its dependencies, including the output of OS. | |
769 | ;; This is more than needed (we only need the kernel, initrd, GRUB for its | |
770 | ;; font, and the background image), but it's hard to filter that. | |
771 | (qemu-image #:os os | |
772 | #:bootcfg-drv bootcfg | |
773 | #:bootloader (bootloader-configuration-bootloader | |
774 | (operating-system-bootloader os)) | |
775 | #:disk-image-size disk-image-size | |
776 | #:file-system-uuid root-uuid | |
777 | #:inputs (if full-boot? | |
778 | `(("bootcfg" ,bootcfg)) | |
779 | '()) | |
780 | ||
781 | ;; XXX: Passing #t here is too slow, so let it off by default. | |
782 | #:register-closures? #f | |
783 | #:copy-inputs? full-boot?)) | |
fd3bfc44 | 784 | |
96ffa27b LC |
785 | (define* (common-qemu-options image shared-fs) |
786 | "Return the a string-value gexp with the common QEMU options to boot IMAGE, | |
787 | with '-virtfs' options for the host file systems listed in SHARED-FS." | |
26a076ed | 788 | |
96ffa27b | 789 | (define (virtfs-option fs) |
26a076ed DC |
790 | #~(format #f "-virtfs local,path=~s,security_model=none,mount_tag=~s" |
791 | #$fs #$(file-system->mount-tag fs))) | |
96ffa27b | 792 | |
26a076ed | 793 | #~(;; Only enable kvm if we see /dev/kvm exists. |
944d2b17 CAW |
794 | ;; This allows users without hardware virtualization to still use these |
795 | ;; commands. | |
26a076ed DC |
796 | #$@(if (file-exists? "/dev/kvm") |
797 | '("-enable-kvm") | |
798 | '()) | |
799 | ||
800 | "-no-reboot" | |
53793927 | 801 | "-nic" "user,model=virtio-net-pci" |
2ca712bd LF |
802 | "-object" "rng-random,filename=/dev/urandom,id=guixsd-vm-rng" |
803 | "-device" "virtio-rng-pci,rng=guixsd-vm-rng" | |
26a076ed DC |
804 | |
805 | #$@(map virtfs-option shared-fs) | |
806 | "-vga std" | |
807 | (format #f "-drive file=~a,if=virtio,cache=writeback,werror=report,readonly" | |
ebfb71d4 | 808 | #$image))) |
3c1f0e3b | 809 | |
ab11f0be LC |
810 | (define* (system-qemu-image/shared-store-script os |
811 | #:key | |
812 | (qemu qemu) | |
813 | (graphic? #t) | |
ebfb71d4 | 814 | (memory-size 256) |
fcf63cf8 | 815 | (mappings '()) |
6aa260af LC |
816 | full-boot? |
817 | (disk-image-size | |
9a1bfe76 | 818 | (* (if full-boot? 500 70) |
ed419fa0 LC |
819 | (expt 2 20))) |
820 | (options '())) | |
fd3bfc44 | 821 | "Return a derivation that builds a script to run a virtual machine image of |
ebfb71d4 JN |
822 | OS that shares its store with the host. The virtual machine runs with |
823 | MEMORY-SIZE MiB of memory. | |
6aa260af | 824 | |
fcf63cf8 LC |
825 | MAPPINGS is a list of <file-system-mapping> specifying mapping of host file |
826 | systems into the guest. | |
827 | ||
6aa260af LC |
828 | When FULL-BOOT? is true, the returned script runs everything starting from the |
829 | bootloader; otherwise it directly starts the operating system kernel. The | |
830 | DISK-IMAGE-SIZE parameter specifies the size in bytes of the root disk image; | |
831 | it is mostly useful when FULL-BOOT? is true." | |
909de139 | 832 | (mlet* %store-monad ((os -> (virtualized-operating-system os mappings full-boot?)) |
6aa260af LC |
833 | (image (system-qemu-image/shared-store |
834 | os | |
835 | #:full-boot? full-boot? | |
836 | #:disk-image-size disk-image-size))) | |
26a076ed | 837 | (define kernel-arguments |
83071b05 | 838 | #~(list #$@(if graphic? #~() #~("console=ttyS0")) |
a7ef45d9 | 839 | #+@(operating-system-kernel-arguments os "/dev/vda1"))) |
26a076ed DC |
840 | |
841 | (define qemu-exec | |
842 | #~(list (string-append #$qemu "/bin/" #$(qemu-command (%current-system))) | |
843 | #$@(if full-boot? | |
844 | #~() | |
845 | #~("-kernel" #$(operating-system-kernel-file os) | |
a7ef45d9 | 846 | "-initrd" #$(file-append os "/initrd") |
26a076ed DC |
847 | (format #f "-append ~s" |
848 | (string-join #$kernel-arguments " ")))) | |
849 | #$@(common-qemu-options image | |
850 | (map file-system-mapping-source | |
ebfb71d4 | 851 | (cons %store-mapping mappings))) |
ed419fa0 LC |
852 | "-m " (number->string #$memory-size) |
853 | #$@options)) | |
26a076ed | 854 | |
fd3bfc44 | 855 | (define builder |
02100028 LC |
856 | #~(call-with-output-file #$output |
857 | (lambda (port) | |
26a076ed DC |
858 | (format port "#!~a~% exec ~a \"$@\"~%" |
859 | #$(file-append bash "/bin/sh") | |
860 | (string-join #$qemu-exec " ")) | |
02100028 LC |
861 | (chmod port #o555)))) |
862 | ||
863 | (gexp->derivation "run-vm.sh" builder))) | |
fd3bfc44 | 864 | |
ed419fa0 LC |
865 | \f |
866 | ;;; | |
867 | ;;; High-level abstraction. | |
868 | ;;; | |
869 | ||
870 | (define-record-type* <virtual-machine> %virtual-machine | |
871 | make-virtual-machine | |
872 | virtual-machine? | |
873 | (operating-system virtual-machine-operating-system) ;<operating-system> | |
874 | (qemu virtual-machine-qemu ;<package> | |
875 | (default qemu)) | |
876 | (graphic? virtual-machine-graphic? ;Boolean | |
877 | (default #f)) | |
878 | (memory-size virtual-machine-memory-size ;integer (MiB) | |
879 | (default 256)) | |
eb152070 CB |
880 | (disk-image-size virtual-machine-disk-image-size ;integer (bytes) |
881 | (default 'guess)) | |
ed419fa0 LC |
882 | (port-forwardings virtual-machine-port-forwardings ;list of integer pairs |
883 | (default '()))) | |
884 | ||
885 | (define-syntax virtual-machine | |
886 | (syntax-rules () | |
887 | "Declare a virtual machine running the specified OS, with the given | |
888 | options." | |
889 | ((_ os) ;shortcut | |
890 | (%virtual-machine (operating-system os))) | |
891 | ((_ fields ...) | |
892 | (%virtual-machine fields ...)))) | |
893 | ||
894 | (define (port-forwardings->qemu-options forwardings) | |
895 | "Return the QEMU option for the given port FORWARDINGS as a string, where | |
896 | FORWARDINGS is a list of host-port/guest-port pairs." | |
897 | (string-join | |
898 | (map (match-lambda | |
899 | ((host-port . guest-port) | |
900 | (string-append "hostfwd=tcp::" | |
901 | (number->string host-port) | |
902 | "-:" (number->string guest-port)))) | |
903 | forwardings) | |
904 | ",")) | |
905 | ||
906 | (define-gexp-compiler (virtual-machine-compiler (vm <virtual-machine>) | |
907 | system target) | |
908 | ;; XXX: SYSTEM and TARGET are ignored. | |
909 | (match vm | |
eb152070 | 910 | (($ <virtual-machine> os qemu graphic? memory-size disk-image-size ()) |
ed419fa0 LC |
911 | (system-qemu-image/shared-store-script os |
912 | #:qemu qemu | |
913 | #:graphic? graphic? | |
eb152070 CB |
914 | #:memory-size memory-size |
915 | #:disk-image-size | |
916 | disk-image-size)) | |
917 | (($ <virtual-machine> os qemu graphic? memory-size disk-image-size | |
918 | forwardings) | |
ed419fa0 | 919 | (let ((options |
8e53fe2b MB |
920 | `("-nic" ,(string-append |
921 | "user,model=virtio-net-pci," | |
ed419fa0 LC |
922 | (port-forwardings->qemu-options forwardings))))) |
923 | (system-qemu-image/shared-store-script os | |
924 | #:qemu qemu | |
925 | #:graphic? graphic? | |
926 | #:memory-size memory-size | |
eb152070 CB |
927 | #:disk-image-size |
928 | disk-image-size | |
ed419fa0 LC |
929 | #:options options))))) |
930 | ||
04086015 | 931 | ;;; vm.scm ends here |