aboutsummaryrefslogtreecommitdiff
;;; GNU Guix --- Functional package management for GNU
;;; Copyright © 2014 John Darrington <jmd@gnu.org>
;;; Copyright © 2014, 2016 Mark H Weaver <mhw@netris.org>
;;; Copyright © 2016, 2018, 2024 Ricardo Wurmus <rekado@elephly.net>
;;; Copyright © 2017, 2020 Marius Bakke <mbakke@fastmail.com>
;;; Copyright © 2018 Tobias Geerinckx-Rice <me@tobias.gr>
;;; Copyright © 2020, 2021, 2022, 2024 Maxim Cournoyer <maxim.cournoyer@gmail.com>
;;; Copyright © 2020 Boris A. Dekshteyn <boris.dekshteyn@gmail.com>
;;; Copyright © 2020 Ekaitz Zarraga <ekaitz@elenq.tech>
;;; Copyright © 2023, 2024 Efraim Flashner <efraim@flashner.co.il>
;;;
;;; This file is part of GNU Guix.
;;;
;;; GNU Guix is free software; you can redistribute it and/or modify it
;;; under the terms of the GNU General Public License as published by
;;; the Free Software Foundation; either version 3 of the License, or (at
;;; your option) any later version.
;;;
;;; GNU Guix is distributed in the hope that it will be useful, but
;;; WITHOUT ANY WARRANTY; without even the implied warranty of
;;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
;;; GNU General Public License for more details.
;;;
;;; You should have received a copy of the GNU General Public License
;;; along with GNU Guix.  If not, see <http://www.gnu.org/licenses/>.

(define-module (gnu packages inkscape)
  #:use-module ((guix licenses) #:prefix license:)
  #:use-module (guix packages)
  #:use-module (guix download)
  #:use-module (guix gexp)
  #:use-module (guix utils)
  #:use-module (guix build-system cmake)
  #:use-module (gnu packages)
  #:use-module (gnu packages algebra)
  #:use-module (gnu packages bash)
  #:use-module (gnu packages bdw-gc)
  #:use-module (gnu packages boost)
  #:use-module (gnu packages check)
  #:use-module (gnu packages gettext)
  #:use-module (gnu packages glib)
  #:use-module (gnu packages gnome)
  #:use-module (gnu packages graphics)
  #:use-module (gnu packages gtk)
  #:use-module (gnu packages imagemagick)
  #:use-module (gnu packages libreoffice)
  #:use-module (gnu packages maths)
  #:use-module (gnu packages perl)
  #:use-module (gnu packages pdf)
  #:use-module (gnu packages popt)
  #:use-module (gnu packages python)
  #:use-module (gnu packages python-web)
  #:use-module (gnu packages python-xyz)
  #:use-module (gnu packages readline)
  #:use-module (gnu packages xml)
  #:use-module (gnu packages ghostscript)
  #:use-module (gnu packages fontutils)
  #:use-module (gnu packages image)
  #:use-module (gnu packages pkg-config)
  #:use-module (srfi srfi-1))

;;; A variant of Inkscape intended to be bumped only on core-updates, to avoid
;;; rebuilding 2k+ packages through dblatex.  It should only be used as a
;;; native-input since it might not receive timely security updates.
(define-public inkscape/stable
  (hidden-package
   (package
     (name "inkscape")
     (version "1.3.2")
     (source
      (origin
        (method url-fetch)
        (uri (string-append "https://media.inkscape.org/dl/"
                            "resources/file/"
                            "inkscape-" version ".tar.xz"))
        (sha256
         (base32 "0sq81smxwypgnp7r3wgza8w25dsz9qa8ga79sc85xzj3qi6q9lfv"))
        (modules '((guix build utils)
                   (ice-9 format)))
        (snippet
         '(begin
            (let-syntax
                ;; XXX: The build system doesn't currently support using
                ;; system libraries over bundled ones (see:
                ;; https://gitlab.com/inkscape/inkscape/issues/876).
                ((unbundle
                  (syntax-rules ()
                    ((_ (name source-dir use-pkg-config?) ...)
                     (begin
                       ;; Delete bundled source directories.
                       (delete-file-recursively source-dir) ...
                       (substitute* '("src/CMakeLists.txt"
                                      "src/3rdparty/CMakeLists.txt")
                         (((string-append ".*add_subdirectory\\("
                                          (basename source-dir) "\\).*"))
                          "") ...)
                       ;; Remove bundled entries from INKSCAPE_TARGET_LIBS.
                       (substitute* "src/CMakeLists.txt"
                         (((string-append name "_LIB.*")) "") ...)
                       ;; Register the external libraries, so that their
                       ;; headers are added to INKSCAPE_INCS_SYS and their
                       ;; shared libraries added to INKSCAPE_LIBS.
                       (if use-pkg-config?
                           (let* ((width (string-length "pkg_check_modules("))
                                  (indent (string-join (make-list width " ") "")))
                             (substitute* "CMakeScripts/DefineDependsandFlags.cmake"
                               (("^pkg_check_modules\\(INKSCAPE_DEP REQUIRED.*" start)
                                (string-append start
                                               (format #f "~a~a~%" indent name)))))
                           (substitute* "CMakeScripts/DefineDependsandFlags.cmake"
                             (("^find_package\\(Iconv REQUIRED\\).*" start)
                              (string-append (format #f "
find_path(~a_INCLUDE_DIR NAMES ~:*~a/~:*~a.h ~:*~a.h)
if(NOT ~:*~a_INCLUDE_DIR)
  message(FATAL_ERROR \"~:*~a headers not found\")
else()
  list(APPEND INKSCAPE_INCS_SYS ${~:*~a_INCLUDE_DIR})
endif()

find_library(~:*~a_LIB NAMES ~:*~a)
if(NOT ~:*~a_LIB)
  message(FATAL_ERROR \"~:*~a library not found\")
else()
  list(APPEND INKSCAPE_LIBS ~:*~a_LIB)
endif()~%~%"
                                                     name)
                                             start)))) ...
                                             ;; Fix the references to the headers of the
                                             ;; unbundled libraries.
                                             (substitute* (find-files "." "\\.h$|\\.cpp$")
                                               (((string-append "#include (\"|<)3rdparty/"
                                                                (basename source-dir)) _ quote)
                                                (string-append "#include " quote
                                                               (basename source-dir)))
                                               ...))))))
              (unbundle ("2geom" "src/3rdparty/2geom" #t)
                        ;; libcroco cannot be unbundled as it is heavily
                        ;; modified (see:
                        ;; https://gitlab.com/inkscape/inkscape/issues/876#note_276114904).
                        ;; ("croco" "src/3rdparty/libcroco" #t)
                        ;; FIXME: Unbundle the following libraries once they
                        ;; have been packaged.
                        ;; ("cola" "src/3rdparty/adaptagrams/libcola")
                        ;; ("avoid" "src/3rdparty/adaptagrams/libavoid")
                        ;; ("vpsc" "src/3rdparty/adaptagrams/libvpsc")
                        ;; libuemf cannot be unbundled as it slightly modified
                        ;; from upstream (see:
                        ;; https://gitlab.com/inkscape/inkscape/issues/973).
                        ;; ("uemf" "src/3rdparty/libuemf" #f)
                        ;; FIXME: libdepixelize upstream is ancient and doesn't
                        ;; build with a recent lib2geom
                        ;; (see: https://bugs.launchpad.net/libdepixelize/+bug/1862458).
                        ;;("depixelize" "src/3rdparty/libdepixelize")
                        ("autotrace" "src/3rdparty/autotrace" #t)))
            ;; Lift the requirement on the double-conversion library, as
            ;; it is only needed by lib2geom, which is now unbundled.
            (substitute* "CMakeScripts/DefineDependsandFlags.cmake"
              ((".*find_package\\(DoubleConversion.*") ""))))))
     (build-system cmake-build-system)
     (arguments
      (list
       #:test-target "check"         ;otherwise some test binaries are missing
       #:disallowed-references (list imagemagick/stable)
       #:imported-modules `(,@%cmake-build-system-modules
                            (guix build glib-or-gtk-build-system))
       #:modules '((guix build cmake-build-system)
                   ((guix build glib-or-gtk-build-system) #:prefix glib-or-gtk:)
                   (guix build utils))
       ;; Disable imagemagick support in the stable variant, to reduce the
       ;; number of dependents of the 'imagemagick' package.
       #:configure-flags
       #~(list "-DWITH_IMAGE_MAGICK=OFF"
               ;; TODO: Remove after next release, since the problematic
               ;; libsoup/soup.h include is no longer used.
               (string-append "-DCMAKE_CXX_FLAGS=-I"
                              (search-input-directory %build-inputs
                                                      "/include/libsoup-2.4")))
       #:phases
       #~(modify-phases %standard-phases
           (add-after 'unpack 'generate-gdk-pixbuf-loaders-cache-file
             (assoc-ref glib-or-gtk:%standard-phases
                        'generate-gdk-pixbuf-loaders-cache-file))
           #$@(if (or (target-aarch64?)
                      (target-ppc64le?)
                      (target-riscv64?))
                  '((add-after 'unpack 'disable-more-tests
                      (lambda _
                        ;; https://gitlab.com/inkscape/inkscape/-/issues/3554#note_1035680690
                        (substitute* "testfiles/CMakeLists.txt"
                          (("lpe64-test") "#lpe64-test")
                          (("    lpe-test") "    #lpe-test")
                          (("add_subdirectory\\(lpe_tests\\)") ""))
                        ;; https://gitlab.com/inkscape/inkscape/-/issues/3554#note_1035539888
                        ;; According to upstream, this is a false positive.
                        (substitute* "testfiles/rendering_tests/CMakeLists.txt"
                          (("add_rendering_test\\(test-use" all)
                           (string-append "#" all)))
                        ;; https://gitlab.com/inkscape/inkscape/-/issues/3554#note_1035539888
                        ;; Allegedly a precision error in the gamma.
                        (substitute* "testfiles/cli_tests/CMakeLists.txt"
                          (("add_cli_test\\(export-png-color-mode-gray-8_png" all)
                           (string-append "#" all))
                          ;; These also seem to be failing due to precision errors.
                          (("add_pdfinput_test\\(font-(spacing|style) 1 draw-all" all)
                           (string-append "#" all))))))
                  '())
           #$@(if (or (target-x86-32?)
                      (target-arm32?))
                  '((add-after 'unpack 'fix-32bit-size_t-format
                      (lambda _
                        ;; Fix an error due to format type mismatch with 32-bit size_t.
                        (substitute* "testfiles/src/visual-bounds-test.cpp"
                          (("%lu") "%u")))))
                  '())
           (add-after 'unpack 'set-home
             ;; Mute Inkscape warnings during tests.
             (lambda _
               (setenv "HOME" (getcwd))))
           ;; Move the check phase after the install phase, as when run in the
           ;; tests, Inkscape relies on files that are not yet installed, such
           ;; as the "share/inkscape/ui/units.xml" file.
           (delete 'check)
           (add-after 'install 'check
             ;; Use ctest directly so that we can easily exclude problematic
             ;; tests.
             (lambda* (#:key parallel-tests? tests? #:allow-other-keys)
               (when tests?
                 ;; The following tests fails, perhaps due to building without
                 ;; ImageMagick (see:
                 ;; https://gitlab.com/inkscape/inbox/-/issues/10005).
                 (let ((job-count (if parallel-tests?
                                      (number->string (parallel-job-count))
                                      "1"))
                       (skipped-tests
                        (list "cli_export-type-caseinsensitive_check_output"
                              "cli_export-type_xaml_check_output"
                              "cli_export-height_export-use-hints_check_output"
                              "cli_export-plain-svg_check_output"
                              "cli_export-use-hints_export-id_check_output"
                              "cli_export-extension_svg_check_output"
                              "cli_export-extension_ps_check_output"
                              "cli_export-extension_eps_check_output"
                              "cli_export-extension_pdf_check_output"
                              "cli_export-plain-extension-svg_check_output"
                              ;; These fail non-deterministically (see:
                              ;; https://gitlab.com/inkscape/inbox/-/issues/10005).
                              "cli_export-ps-level_3_check_output"
                              "cli_export-ps-level_3_content_check_output"
                              "cli_export-ps-level_2_content_check_output"
                              "cli_export-ps-level_2_check_output"
                          ;; These fail on i686 but not x86-64
                          #$@(if (target-x86-32?)
                                 '("cli_pdfinput-font-spacing_check_output"
                                   "cli_pdfinput-font-style_check_output"
                                   "cli_pdfinput-latex_check_output"
                                   "cli_pdfinput-multi-page-sample_check_output"
                                   "test_lpe")
                                 '()))))
                   (invoke "make" "-j" job-count "tests")
                   (invoke "ctest" "-j" job-count
                           "--output-on-error"
                           "-E" (string-append
                                 "(" (string-join skipped-tests "|") ")"))))))
           (add-after 'install 'glib-or-gtk-compile-schemas
             (assoc-ref glib-or-gtk:%standard-phases 'glib-or-gtk-compile-schemas))
           (add-after 'glib-or-gtk-compile-schemas 'glib-or-gtk-wrap
             (assoc-ref glib-or-gtk:%standard-phases 'glib-or-gtk-wrap))
           (add-after 'install 'wrap-program
             ;; Ensure Python is available at runtime.
             (lambda* (#:key inputs #:allow-other-keys)
               (wrap-program (string-append #$output "/bin/inkscape")
                 `("PATH" prefix
                   (,(dirname (search-input-file inputs "bin/python"))))
                 `("GUIX_PYTHONPATH" prefix
                   (,(getenv "GUIX_PYTHONPATH")))
                 ;; Wrapping GDK_PIXBUF_MODULE_FILE allows Inkscape to load
                 ;; its own icons in pure environments.
                 `("GDK_PIXBUF_MODULE_FILE" =
                   (,(getenv "GDK_PIXBUF_MODULE_FILE")))
                 ;; Ensure GObject Introspection typelibs are found.
                 `("GI_TYPELIB_PATH" ":" prefix
                   (,(getenv "GI_TYPELIB_PATH")))))))))
     (inputs
      (list (librsvg-for-system)        ;for the pixbuf loader
            autotrace
            bash-minimal
            boost
            freetype
            gdl-minimal
            gsl
            gspell
            gtk+
            gtkmm-3
            lcms
            lib2geom
            libcdr
            libgc
            libjpeg-turbo
            libpng
            libsoup-minimal-2
            libvisio
            libwpd
            libwpg
            libxml2
            libxslt
            poppler
            popt
            potrace
            ;; These Python dependencies are used by the Inkscape extension
            ;; management system.  To verify that it is working, visit the
            ;; Extensions -> Manage Extensions... menu.
            python-appdirs
            python-cssselect
            python-lxml
            python-numpy
            python-pygobject
            python-pyserial
            python-requests
            python-scour
            python-wrapper
            readline))
     (native-inputs
      (list `(,glib "bin")
            bc
            gettext-minimal
            googletest
            imagemagick/stable          ;for tests
            perl
            pkg-config))
     (home-page "https://inkscape.org/")
     (synopsis "Vector graphics editor")
     (description "Inkscape is a vector graphics editor.  What sets Inkscape
apart is its use of Scalable Vector Graphics (SVG), an XML-based W3C standard,
as the native format.")
     (license license:gpl3+))))           ;see the file COPYING

(define-public inkscape
  (package
    (inherit inkscape/stable)
    (name "inkscape")
    (version "1.3.2")
    (source
     (origin
       (inherit (package-source inkscape/stable))
       (method url-fetch)
       (uri (string-append "https://media.inkscape.org/dl/"
                           "resources/file/"
                           "inkscape-" version ".tar.xz"))
       (sha256
        (base32 "0sq81smxwypgnp7r3wgza8w25dsz9qa8ga79sc85xzj3qi6q9lfv"))))
    (build-system cmake-build-system)
    (arguments
     (substitute-keyword-arguments (package-arguments inkscape/stable)
       ((#:configure-flags flags ''())
        ;; Enable ImageMagick support.
        #~(delete "-DWITH_IMAGE_MAGICK=OFF" #$flags))
       ((#:phases phases)
        #~(modify-phases #$phases
            #$@(if (target-x86-32?)
                   #~()            ;XXX: there are remaining failures on i686
                   #~((replace 'check
                        ;; Re-instate the tests disabled in inkscape/stable, now that
                        ;; their ImageMagick requirement is satisfied.
                        (assoc-ref %standard-phases 'check))))

            (replace 'wrap-program
              ;; Ensure Python is available at runtime.
              (lambda _
                (wrap-program (string-append #$output "/bin/inkscape")
                  `("GUIX_PYTHONPATH" prefix
                    (,(getenv "GUIX_PYTHONPATH")))
                  ;; Wrapping GDK_PIXBUF_MODULE_FILE allows Inkscape to load
                  ;; its own icons in pure environments.
                  `("GDK_PIXBUF_MODULE_FILE" =
                    (,(getenv "GDK_PIXBUF_MODULE_FILE"))))))))))
    (inputs (modify-inputs (package-inputs inkscape/stable)
              (append imagemagick)))    ;for libMagickCore and libMagickWand
    (native-inputs
     (modify-inputs (package-native-inputs inkscape/stable)
                    ;; Only use 1 imagemagick across the package build.
                    (replace "imagemagick" imagemagick)))
    (properties (alist-delete 'hidden? (package-properties inkscape/stable)))))
generated by cgit
-configuration-max-clients config)) "\n" "max_size = " (number->string (virtlog-configuration-max-size config)) "\n" "max_backups = " (number->string (virtlog-configuration-max-backups config)) "\n"))) (define (virtlogd-shepherd-service config) (let* ((config-file (virtlogd-conf-file config)) (libvirt (virtlog-configuration-libvirt config))) (list (shepherd-service (documentation "Run the virtlog daemon.") (provision '(virtlogd)) (start #~(make-forkexec-constructor (list (string-append #$libvirt "/sbin/virtlogd") "-f" #$config-file))) (stop #~(make-kill-destructor)))))) (define virtlog-service-type (service-type (name 'virtlogd) (extensions (list (service-extension shepherd-root-service-type virtlogd-shepherd-service))) (default-value (virtlog-configuration)) (description "Run @command{virtlogd}, a daemon libvirt that is used to manage logs from @acronym{VM, virtual machine} consoles."))) (define (generate-libvirt-documentation) (generate-documentation `((libvirt-configuration ,libvirt-configuration-fields)) 'libvirt-configuration)) ;;; ;;; Transparent QEMU emulation via binfmt_misc. ;;; ;; Platforms that QEMU can emulate. (define-record-type* <qemu-platform> qemu-platform make-qemu-platform qemu-platform? (name qemu-platform-name) ;string (family qemu-platform-family) ;string (magic qemu-platform-magic) ;bytevector (mask qemu-platform-mask) ;bytevector ;; Default flags: ;; ;; "F": fix binary. Open the qemu-user binary (statically linked) as soon ;; as binfmt_misc interpretation is handled. ;; ;; "P": preserve argv[0]. QEMU 6.0 detects whether it's started with this ;; flag and automatically does the right thing. Without this flag, ;; argv[0] is replaced by the absolute file name of the executable, an ;; observable difference that can cause discrepancies. (flags qemu-platform-flags (default "FP"))) ;string (define-syntax bv (lambda (s) "Expand the given string into a bytevector." (syntax-case s () ((_ str) (string? (syntax->datum #'str)) (let ((bv (u8-list->bytevector (map char->integer (string->list (syntax->datum #'str)))))) bv))))) ;;; The platform descriptions below are taken from ;;; 'scripts/qemu-binfmt-conf.sh' in QEMU. (define %i386 (qemu-platform (name "i386") (family "i386") (magic (bv "\x7fELF\x01\x01\x01\x00\x00\x00\x00\x00\x00\x00\x00\x00\x02\x00\x03\x00")) (mask (bv "\xff\xff\xff\xff\xff\xfe\xfe\xff\xff\xff\xff\xff\xff\xff\xff\xff\xfe\xff\xff\xff")))) (define %i486 (qemu-platform (name "i486") (family "i386") (magic (bv "\x7fELF\x01\x01\x01\x00\x00\x00\x00\x00\x00\x00\x00\x00\x02\x00\x06\x00")) (mask (bv "\xff\xff\xff\xff\xff\xfe\xfe\x00\xff\xff\xff\xff\xff\xff\xff\xff\xfe\xff\xff\xff")))) (define %x86_64 (qemu-platform (name "x86_64") (family "i386") (magic (bv "\x7fELF\x02\x01\x01\x00\x00\x00\x00\x00\x00\x00\x00\x00\x02\x00\x3e\x00")) (mask (bv "\xff\xff\xff\xff\xff\xfe\xfe\x00\xff\xff\xff\xff\xff\xff\xff\xff\xfe\xff\xff\xff")))) (define %alpha (qemu-platform (name "alpha") (family "alpha") (magic (bv "\x7fELF\x02\x01\x01\x00\x00\x00\x00\x00\x00\x00\x00\x00\x02\x00\x26\x90")) (mask (bv "\xff\xff\xff\xff\xff\xfe\xfe\xff\xff\xff\xff\xff\xff\xff\xff\xff\xfe\xff\xff\xff")))) (define %arm (qemu-platform (name "arm") (family "arm") (magic (bv "\x7fELF\x01\x01\x01\x00\x00\x00\x00\x00\x00\x00\x00\x00\x02\x00\x28\x00")) (mask (bv "\xff\xff\xff\xff\xff\xff\xff\x00\xff\xff\xff\xff\xff\xff\xff\xff\xfe\xff\xff\xff")))) (define %armeb (qemu-platform (name "armeb") (family "armeb") (magic (bv "\x7fELF\x01\x02\x01\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x02\x00\x28")) (mask (bv "\xff\xff\xff\xff\xff\xff\xff\x00\xff\xff\xff\xff\xff\xff\xff\xff\xff\xfe\xff\xff")))) (define %sparc (qemu-platform (name "sparc") (family "sparc") (magic (bv "\x7fELF\x01\x02\x01\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x02\x00\x02")) (mask (bv "\xff\xff\xff\xff\xff\xff\xff\xff\xff\xff\xff\xff\xff\xff\xff\xff\xff\xfe\xff\xff")))) (define %sparc32plus (qemu-platform (name "sparc32plus") (family "sparc") (magic (bv "\x7fELF\x01\x02\x01\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x02\x00\x12")) (mask (bv "\xff\xff\xff\xff\xff\xff\xff\xff\xff\xff\xff\xff\xff\xff\xff\xff\xff\xfe\xff\xff")))) (define %sparc64 (qemu-platform (name "sparc64") (family "sparc") (magic (bv "\x7fELF\x02\x02\x01\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x02\x00\x2b")) (mask (bv "\xff\xff\xff\xff\xff\xff\xff\x00\xff\xff\xff\xff\xff\xff\xff\xff\xff\xfe\xff\xff")))) (define %ppc (qemu-platform (name "ppc") (family "ppc") (magic (bv "\x7fELF\x01\x02\x01\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x02\x00\x14")) (mask (bv "\xff\xff\xff\xff\xff\xff\xff\x00\xff\xff\xff\xff\xff\xff\xff\xff\xff\xfe\xff\xff")))) (define %ppc64 (qemu-platform (name "ppc64") (family "ppc") (magic (bv "\x7fELF\x02\x02\x01\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x02\x00\x15")) (mask (bv "\xff\xff\xff\xff\xff\xff\xff\x00\xff\xff\xff\xff\xff\xff\xff\xff\xff\xfe\xff\xff")))) (define %ppc64le (qemu-platform (name "ppc64le") (family "ppcle") (magic (bv "\x7fELF\x02\x01\x01\x00\x00\x00\x00\x00\x00\x00\x00\x00\x02\x00\x15\x00")) (mask (bv "\xff\xff\xff\xff\xff\xff\xff\x00\xff\xff\xff\xff\xff\xff\xff\xff\xfe\xff\xff\x00")))) (define %m68k (qemu-platform (name "m68k") (family "m68k") (magic (bv "\x7fELF\x01\x02\x01\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x02\x00\x04")) (mask (bv "\xff\xff\xff\xff\xff\xff\xfe\xfe\xff\xff\xff\xff\xff\xff\xff\xff\xff\xfe\xff\xff")))) ;; XXX: We could use the other endianness on a MIPS host. (define %mips (qemu-platform (name "mips") (family "mips") (magic (bv "\x7fELF\x01\x02\x01\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x02\x00\x08")) (mask (bv "\xff\xff\xff\xff\xff\xff\xff\x00\xff\xff\xff\xff\xff\xff\xff\xff\xff\xfe\xff\xff")))) (define %mipsel (qemu-platform (name "mipsel") (family "mips") (magic (bv "\x7fELF\x01\x01\x01\x00\x00\x00\x00\x00\x00\x00\x00\x00\x02\x00\x08\x00")) (mask (bv "\xff\xff\xff\xff\xff\xff\xff\x00\xff\xff\xff\xff\xff\xff\xff\xff\xfe\xff\xff\xff")))) (define %mipsn32 (qemu-platform (name "mipsn32") (family "mips") (magic (bv "\x7fELF\x01\x02\x01\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x02\x00\x08")) (mask (bv "\xff\xff\xff\xff\xff\xff\xff\x00\xff\xff\xff\xff\xff\xff\xff\xff\xff\xfe\xff\xff")))) (define %mipsn32el (qemu-platform (name "mipsn32el") (family "mips") (magic (bv "\x7fELF\x01\x01\x01\x00\x00\x00\x00\x00\x00\x00\x00\x00\x02\x00\x08\x00")) (mask (bv "\xff\xff\xff\xff\xff\xff\xff\x00\xff\xff\xff\xff\xff\xff\xff\xff\xfe\xff\xff\xff")))) (define %mips64 (qemu-platform (name "mips64") (family "mips") (magic (bv "\x7fELF\x02\x02\x01\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x02\x00\x08")) (mask (bv "\xff\xff\xff\xff\xff\xff\xff\x00\xff\xff\xff\xff\xff\xff\xff\xff\xff\xfe\xff\xff")))) (define %mips64el (qemu-platform (name "mips64el") (family "mips") (magic (bv "\x7fELF\x02\x01\x01\x00\x00\x00\x00\x00\x00\x00\x00\x00\x02\x00\x08\x00")) (mask (bv "\xff\xff\xff\xff\xff\xff\xff\x00\xff\xff\xff\xff\xff\xff\xff\xff\xfe\xff\xff\xff")))) (define %sh4 (qemu-platform (name "sh4") (family "sh4") (magic (bv "\x7fELF\x01\x01\x01\x00\x00\x00\x00\x00\x00\x00\x00\x00\x02\x00\x2a\x00")) (mask (bv "\xff\xff\xff\xff\xff\xff\xff\xff\xff\xff\xff\xff\xff\xff\xff\xff\xfe\xff\xff\xff")))) (define %sh4eb (qemu-platform (name "sh4eb") (family "sh4") (magic (bv "\x7fELF\x01\x02\x01\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x02\x00\x2a")) (mask (bv "\xff\xff\xff\xff\xff\xff\xff\xff\xff\xff\xff\xff\xff\xff\xff\xff\xff\xfe\xff\xff")))) (define %s390x (qemu-platform (name "s390x") (family "s390x") (magic (bv "\x7fELF\x02\x02\x01\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x02\x00\x16")) (mask (bv "\xff\xff\xff\xff\xff\xff\xff\xff\xff\xff\xff\xff\xff\xff\xff\xff\xff\xfe\xff\xff")))) (define %aarch64 (qemu-platform (name "aarch64") (family "arm") (magic (bv "\x7fELF\x02\x01\x01\x00\x00\x00\x00\x00\x00\x00\x00\x00\x02\x00\xb7\x00")) (mask (bv "\xff\xff\xff\xff\xff\xff\xff\x00\xff\xff\xff\xff\xff\xff\xff\xff\xfe\xff\xff\xff")))) (define %aarch64be (qemu-platform (name "aarch64be") (family "armeb") (magic (bv "\x7fELF\x02\x02\x01\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x02\x00\xb7")) (mask (bv "\xff\xff\xff\xff\xff\xff\xff\x00\xff\xff\xff\xff\xff\xff\xff\xff\xff\xfe\xff\xff")))) (define %hppa (qemu-platform (name "hppa") (family "hppa") (magic (bv "\x7f\x45\x4c\x46\x01\x02\x01\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x02\x00\x0f")) (mask (bv "\xff\xff\xff\xff\xff\xff\xff\x00\xff\xff\xff\xff\xff\xff\xff\xff\xff\xfe\xff\xff")))) (define %riscv32 (qemu-platform (name "riscv32") (family "riscv") (magic (bv "\x7fELF\x01\x01\x01\x00\x00\x00\x00\x00\x00\x00\x00\x00\x02\x00\xf3\x00")) (mask (bv "\xff\xff\xff\xff\xff\xff\xff\x00\xff\xff\xff\xff\xff\xff\xff\xff\xfe\xff\xff\xff")))) (define %riscv64 (qemu-platform (name "riscv64") (family "riscv") (magic (bv "\x7fELF\x02\x01\x01\x00\x00\x00\x00\x00\x00\x00\x00\x00\x02\x00\xf3\x00")) (mask (bv "\xff\xff\xff\xff\xff\xff\xff\x00\xff\xff\xff\xff\xff\xff\xff\xff\xfe\xff\xff\xff")))) (define %xtensa (qemu-platform (name "xtensa") (family "xtensa") (magic (bv "\x7fELF\x01\x01\x01\x00\x00\x00\x00\x00\x00\x00\x00\x00\x02\x00\x5e\x00")) (mask (bv "\xff\xff\xff\xff\xff\xff\xff\x00\xff\xff\xff\xff\xff\xff\xff\xff\xfe\xff\xff\xff")))) (define %xtensaeb (qemu-platform (name "xtensaeb") (family "xtensaeb") (magic (bv "\x7fELF\x01\x02\x01\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x02\x00\x5e")) (mask (bv "\xff\xff\xff\xff\xff\xff\xff\x00\xff\xff\xff\xff\xff\xff\xff\xff\xff\xfe\xff\xff")))) (define %microblaze (qemu-platform (name "microblaze") (family "microblaze") (magic (bv "\x7fELF\x01\x02\x01\x00\x00\x00\x00\x00\x00\x00\x00\x00\x02\x00\xba\xab")) (mask (bv "\xff\xff\xff\xff\xff\xff\xff\x00\xff\xff\xff\xff\xff\xff\xff\xff\xfe\xff\xff\xff")))) (define %microblazeel (qemu-platform (name "microblazeel") (family "microblazeel") (magic (bv "\x7fELF\x01\x01\x01\x00\x00\x00\x00\x00\x00\x00\x00\x00\x02\x00\xab\xba")) (mask (bv "\xff\xff\xff\xff\xff\xff\xff\x00\xff\xff\xff\xff\xff\xff\xff\xff\xfe\xff\xff\xff")))) (define %or1k (qemu-platform (name "or1k") (family "or1k") (magic (bv "\x7fELF\x01\x02\x01\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x02\x00\x5c")) (mask (bv "\xff\xff\xff\xff\xff\xff\xff\x00\xff\xff\xff\xff\xff\xff\xff\xff\xff\xfe\xff\xff")))) (define %hexagon (qemu-platform (name "hexagon") (family "hexagon") (magic (bv "\x7fELF\x01\x01\x01\x00\x00\x00\x00\x00\x00\x00\x00\x00\x02\x00\xa4\x00")) (mask (bv "\xff\xff\xff\xff\xff\xff\xff\x00\xff\xff\xff\xff\xff\xff\xff\xff\xfe\xff\xff\xff")))) (define %loongarch64 (qemu-platform (name "loongarch64") (family "loongarch") (magic (bv "\x7fELF\x02\x01\x01\x00\x00\x00\x00\x00\x00\x00\x00\x00\x02\x00\x02\x01")) (mask (bv "\xff\xff\xff\xff\xff\xff\xff\xfc\x00\xff\xff\xff\xff\xff\xff\xff\xfe\xff\xff\xff")))) ;; binfmt_misc: register: failed to install interpreter file /gnu/store/... ;; i486 and aarch64be aren't supported by the qemu-binfmt service. (define %qemu-platforms (list %i386 %x86_64 %alpha %arm %sparc32plus %sparc64 %ppc %ppc64 %ppc64le %m68k %mips %mipsel %mipsn32 %mipsn32el %mips64 %mips64el %sh4 %sh4eb %s390x %aarch64 %hppa %riscv32 %riscv64 %xtensa %xtensaeb %microblaze %microblazeel %or1k %hexagon %loongarch64)) (define (lookup-qemu-platforms . names) "Return the list of QEMU platforms that match NAMES--a list of names such as \"arm\", \"hppa\", etc." (filter (lambda (platform) (member (qemu-platform-name platform) names)) %qemu-platforms)) (define-record-type* <qemu-binfmt-configuration> qemu-binfmt-configuration make-qemu-binfmt-configuration qemu-binfmt-configuration? (qemu qemu-binfmt-configuration-qemu (default qemu)) (platforms qemu-binfmt-configuration-platforms (default '()))) ;safest default (define (qemu-platform->binfmt qemu platform) "Return a gexp that evaluates to a binfmt string for PLATFORM, using the given QEMU package." (define (bytevector->binfmt-string bv) ;; Return a binfmt-friendly string representing BV. Hex-encode every ;; character, in particular because the doc notes "that you must escape ;; any NUL bytes; parsing halts at the first one". (string-concatenate (map (lambda (n) (string-append "\\x" (string-pad (number->string n 16) 2 #\0))) (bytevector->u8-list bv)))) (match platform (($ <qemu-platform> name family magic mask flags) ;; See 'Documentation/binfmt_misc.txt' in the kernel. #~(string-append ":qemu-" #$name ":M::" #$(bytevector->binfmt-string magic) ":" #$(bytevector->binfmt-string mask) ":" #$qemu:static "/bin/qemu-" #$name ":" #$flags)))) (define %binfmt-mount-point (file-system-mount-point %binary-format-file-system)) (define %binfmt-register-file (string-append %binfmt-mount-point "/register")) (define qemu-binfmt-shepherd-services (match-lambda (($ <qemu-binfmt-configuration> qemu platforms) (list (shepherd-service (provision '(qemu-binfmt)) (documentation "Install binfmt_misc handlers for QEMU.") (requirement '(file-system-/proc/sys/fs/binfmt_misc)) (start #~(lambda () ;; Register the handlers for all of PLATFORMS. (for-each (lambda (str) (call-with-output-file #$%binfmt-register-file (lambda (port) (display str port)))) (list #$@(map (cut qemu-platform->binfmt qemu <>) platforms))) #t)) (stop #~(lambda (_) ;; Unregister the handlers. (for-each (lambda (name) (let ((file (string-append #$%binfmt-mount-point "/qemu-" name))) (call-with-output-file file (lambda (port) (display "-1" port))))) '#$(map qemu-platform-name platforms)) #f))))))) (define qemu-binfmt-service-type ;; TODO: Make a separate binfmt_misc service out of this? (service-type (name 'qemu-binfmt) (extensions (list (service-extension file-system-service-type (const (list %binary-format-file-system))) (service-extension shepherd-root-service-type qemu-binfmt-shepherd-services))) (default-value (qemu-binfmt-configuration)) (description "This service supports transparent emulation of binaries compiled for other architectures using QEMU and the @code{binfmt_misc} functionality of the kernel Linux."))) ;;; ;;; QEMU guest agent service. ;;; (define-configuration qemu-guest-agent-configuration (qemu (file-like qemu-minimal) "QEMU package.") (device (string "") "Path to device or socket used to communicate with the host. If not specified, the QEMU default path is used.")) (define (qemu-guest-agent-shepherd-service config) (let ((qemu (qemu-guest-agent-configuration-qemu config)) (device (qemu-guest-agent-configuration-device config))) (list (shepherd-service (provision '(qemu-guest-agent)) ;; The service needs to depend on udev, which brings up devices like ;; those under /dev/virtio-ports. (requirement '(user-processes udev)) (documentation "Run the QEMU guest agent.") (start #~(make-forkexec-constructor `(,(string-append #$qemu "/bin/qemu-ga") "--statedir" "/var/run" ,@(if (string-null? #$device) '() (list "--path" #$device))) #:log-file "/var/log/qemu-ga.log")) (stop #~(make-kill-destructor)))))) (define qemu-guest-agent-service-type (service-type (name 'qemu-guest-agent) (extensions (list (service-extension shepherd-root-service-type qemu-guest-agent-shepherd-service))) (default-value (qemu-guest-agent-configuration)) (description "Run the QEMU guest agent."))) ;;; ;;; Guest agent for VMs running under Xen ;;; (define-configuration/no-serialization xe-guest-utilities-configuration (package (package xe-guest-utilities) "Xen guest management utilities package.") (pid-file (string "/var/run/xe-daemon.pid") "Path to the file holding the PID of xe-deamon.") (log-file (string "/var/log/xe-guest-utilties.log") "Path to xe-guest-utilities log file.")) (define (generate-xe-guest-utilities-documentation) "Generate documentation for xe-guest-utilities-configuration fields" (generate-documentation `((xe-guest-utilities-configuration ,xe-guest-utilities-configuration-fields)) 'xe-guest-utilities-configuration)) (define (xe-guest-utilities-shepherd-service config) (let ((xe-guest-utils (xe-guest-utilities-configuration-package config)) (pid-file (xe-guest-utilities-configuration-pid-file config)) (log-file (xe-guest-utilities-configuration-log-file config))) (list (shepherd-service (provision '(xen-guest-agent)) (requirement '(networking user-processes udev)) (documentation "Run the Xen guest management agent.") (start #~(lambda _ (let ((pid (make-forkexec-constructor (list #$(file-append xe-guest-utils "/sbin/xe-daemon") "-p" #$pid-file) #:log-file #$log-file #:pid-file #$pid-file #:environment-variables (list (string-append "PATH=" #$(file-append xe-guest-utils "/bin") ":" ;; logger #$(file-append inetutils "/bin")))))) ;; Run xe-linux-distribution script before starting the actual ;; daemon. The script collects some basic system information that ;; is shared back to the Xen host. (system* #$(file-append xe-guest-utils "/sbin/xe-linux-distribution") "/var/cache/xe-linux-distribution") ;; Finally, start and return the PID made by ;; make-forkexec-constructor. pid))) (stop #~(make-kill-destructor)))))) (define (xe-guest-utilities-udev-rules-service config) (let ((guest-utils (xe-guest-utilities-configuration-package config))) (list (file->udev-rule "z10_xen-vcpu-hotplug.rules" (file-append guest-utils "/lib/udev/rules.d/z10_xen-vcpu-hotplug.rules"))))) (define xe-guest-utilities-service-type (service-type (name 'xe-guest-utilities) (extensions (list (service-extension shepherd-root-service-type xe-guest-utilities-shepherd-service) (service-extension udev-service-type xe-guest-utilities-udev-rules-service))) (default-value (xe-guest-utilities-configuration)) (description "Run the Xen guest management utilities."))) ;;; ;;; Secrets for guest VMs. ;;; (define (secret-service-shepherd-services address) "Return a Shepherd service that fetches sensitive material at local PORT, over TCP. Reboot upon failure." ;; This is a Shepherd service, rather than an activation snippet, to make ;; sure it is started once 'networking' is up so it can accept incoming ;; connections. (list (shepherd-service (documentation "Fetch secrets from the host at startup time.") (provision '(secret-service-client)) (requirement '(loopback networking)) (modules '((gnu build secret-service) (guix build utils))) (start (with-imported-modules '((gnu build secret-service) (guix build utils)) #~(lambda () ;; Since shepherd's output port goes to /dev/log, write this ;; message to stderr so it's visible on the Mach console. (format (current-error-port) "receiving secrets from the host...~%") (force-output (current-error-port)) (let ((sent (secret-service-receive-secrets #$address))) (unless sent (sleep 3) (reboot)))))) (stop #~(const #f))))) (define secret-service-type (service-type (name 'secret-service) (extensions (list (service-extension shepherd-root-service-type secret-service-shepherd-services) ;; Make every Shepherd service depend on ;; 'secret-service-client'. (service-extension user-processes-service-type (const '(secret-service-client))))) (description "This service fetches secret key and other sensitive material over TCP at boot time. This service is meant to be used by virtual machines (VMs) that can only be accessed by their host."))) (define* (secret-service-operating-system os #:optional (address #~(make-socket-address AF_INET INADDR_ANY 1004))) "Return an operating system based on OS that includes the secret-service, that will be listening to receive secret keys on ADDRESS." (operating-system (inherit os) (services ;; Turn off SSH and Guix key generation that normally happens during ;; activation: that requires entropy and thus takes time during boot, and ;; those keys are going to be overwritten by secrets received from the ;; host anyway. (cons (service secret-service-type address) (modify-services (operating-system-user-services os) (openssh-service-type config => (openssh-configuration (inherit config) (generate-host-keys? #f))) (guix-service-type config => (guix-configuration (inherit config) (generate-substitute-key? #f)))))))) ;;; ;;; Offloading-as-a-service. ;;; (define-record-type* <virtual-build-machine> virtual-build-machine make-virtual-build-machine virtual-build-machine? this-virtual-build-machine (name virtual-build-machine-name (default 'build-vm)) (image virtual-build-machine-image (thunked) (default (virtual-build-machine-default-image this-virtual-build-machine))) (qemu virtual-build-machine-qemu (default qemu-minimal)) (cpu virtual-build-machine-cpu (thunked) (default (qemu-cpu-model-for-date (virtual-build-machine-systems this-virtual-build-machine) (virtual-build-machine-date this-virtual-build-machine)))) (cpu-count virtual-build-machine-cpu-count (default 4)) (memory-size virtual-build-machine-memory-size ;integer (MiB) (default 2048)) (date virtual-build-machine-date ;; Default to a date "in the past" assuming a common use case ;; is to rebuild old packages. (default (make-date 0 0 00 00 01 01 2020 0))) (port-forwardings virtual-build-machine-port-forwardings (default `((,%build-vm-ssh-port . 22) (,%build-vm-secrets-port . 1004)))) (systems virtual-build-machine-systems (default (list (%current-system)))) (auto-start? virtual-build-machine-auto-start? (default #f))) (define %build-vm-ssh-port ;; Default host port where the guest's SSH port is forwarded. 11022) (define %build-vm-secrets-port ;; Host port to communicate secrets to the build VM. ;; FIXME: Anyone on the host can talk to it; use virtio ports or AF_VSOCK ;; instead. 11044) (define %x86-64-intel-cpu-models ;; List of release date/CPU model pairs representing Intel's x86_64 models. ;; The list is taken from ;; <https://en.wikipedia.org/wiki/List_of_Intel_CPU_microarchitectures>. ;; CPU model strings are those found in 'qemu-system-x86_64 -cpu help'. (letrec-syntax ((cpu-models (syntax-rules () ((_ (date model) rest ...) (alist-cons (date->time-utc (string->date date "~Y-~m-~d")) model (cpu-models rest ...))) ((_) '())))) (reverse (cpu-models ("2006-01-01" "core2duo") ("2010-01-01" "Westmere") ("2008-01-01" "Nehalem") ("2011-01-01" "SandyBridge") ("2012-01-01" "IvyBridge") ("2013-01-01" "Haswell") ("2014-01-01" "Broadwell") ("2015-01-01" "Skylake-Client"))))) (define (qemu-cpu-model-for-date systems date) "Return the QEMU name of a CPU model for SYSTEMS that was current at DATE." (if (any (cut string-prefix? "x86_64-" <>) systems) (let ((time (date->time-utc date))) (any (match-lambda ((release-date . model) (and (time<? release-date time) model))) %x86-64-intel-cpu-models)) ;; TODO: Add models for other architectures. "host")) (define (virtual-build-machine-ssh-port config) "Return the host port where CONFIG has its VM's SSH port forwarded." (any (match-lambda ((host-port . 22) host-port) (_ #f)) (virtual-build-machine-port-forwardings config))) (define (virtual-build-machine-secrets-port config) "Return the host port where CONFIG has its VM's secrets port forwarded." (any (match-lambda ((host-port . 1004) host-port) (_ #f)) (virtual-build-machine-port-forwardings config))) (define %minimal-vm-syslog-config ;; Minimal syslog configuration for a VM. (plain-file "vm-syslog.conf" "\ # Log most messages to the console, which goes to the serial # output, allowing the host to log it. *.info;auth.notice;authpriv.none -/dev/console # The rest. *.=debug -/var/log/debug authpriv.*;auth.info /var/log/secure ")) (define %virtual-build-machine-operating-system (operating-system (host-name "build-machine") (locale "en_US.utf8") (locale-definitions ;; Save space by providing only one locale. (list (locale-definition (name "en_US.utf8") (source "en_US") (charset "UTF-8")))) (bootloader (bootloader-configuration ;unused (bootloader grub-minimal-bootloader) (targets '("/dev/null")))) (file-systems (cons (file-system ;unused (mount-point "/") (device "none") (type "tmpfs")) %base-file-systems)) (users (cons (user-account (name "offload") (group "users") (supplementary-groups '("kvm")) (comment "Account used for offloading")) %base-user-accounts)) (services (cons* (service static-networking-service-type (list %qemu-static-networking)) (service openssh-service-type (openssh-configuration (openssh openssh-sans-x))) ;; Run GC once per hour. (simple-service 'perdiodic-gc mcron-service-type (list #~(job "12 * * * *" "guix gc -F 2G"))) (modify-services %base-services ;; By default, the secret service introduces a ;; pre-initialized /etc/guix/acl file in the VM. Thus, ;; clear 'authorize-key?' so that it's not overridden ;; at activation time. ;; Since it's used for offloading, disable substitutes ;; (this avoids network issues). (guix-service-type config => (guix-configuration (inherit config) (authorize-key? #f) (use-substitutes? #f))) (syslog-service-type config => (syslog-configuration (config-file %minimal-vm-syslog-config))) (delete mingetty-service-type) (delete console-font-service-type)))))) (define %default-virtual-build-machine-image-size ;; Size of the default disk image of virtual build machines. It should be ;; large enough to let users build a few things. (* 20 (expt 2 30))) (define (virtual-build-machine-default-image config) (let* ((type (lookup-image-type-by-name 'mbr-raw)) (base (os->image %virtual-build-machine-operating-system #:type type))) (image (inherit base) (name (symbol-append 'build-vm- (virtual-build-machine-name config))) (format 'compressed-qcow2) (partition-table-type 'mbr) (volatile-root? #f) (shared-store? #f) (size %default-virtual-build-machine-image-size) (partitions (match (image-partitions base) ((root) ;; Increase the size of the root partition to match ;; that of the disk image. (let ((root-size (- size (* 50 (expt 2 20))))) (list (partition (inherit root) (size root-size)))))))))) (define (virtual-build-machine-account-name config) (string-append "build-vm-" (symbol->string (virtual-build-machine-name config)))) (define (virtual-build-machine-accounts config) (let ((name (virtual-build-machine-account-name config))) (list (user-group (name name) (system? #t)) (user-account (name name) (group name) (supplementary-groups '("kvm")) (comment "Privilege separation user for the virtual build machine") (home-directory "/var/empty") (shell (file-append shadow "/sbin/nologin")) (system? #t))))) (define (build-vm-shepherd-services config) (define transform (compose secret-service-operating-system operating-system-with-locked-root-account operating-system-with-offloading-account (lambda (os) (virtualized-operating-system os #:full-boot? #t)))) (define transformed-image (let ((base (virtual-build-machine-image config))) (image (inherit base) (operating-system (transform (image-operating-system base)))))) (define command (linux-image-startup-command transformed-image #:qemu (virtual-build-machine-qemu config) #:cpu (virtual-build-machine-cpu config) #:cpu-count (virtual-build-machine-cpu-count config) #:memory-size (virtual-build-machine-memory-size config) #:port-forwardings (virtual-build-machine-port-forwardings config) #:date (virtual-build-machine-date config))) (define user (virtual-build-machine-account-name config)) (list (shepherd-service (documentation "Run the build virtual machine service.") (provision (list (virtual-build-machine-name config))) (requirement '(user-processes)) (modules `((gnu build secret-service) (guix build utils) ,@%default-modules)) (start (with-imported-modules (source-module-closure '((gnu build secret-service) (guix build utils))) #~(lambda arguments (let* ((pid (fork+exec-command (append #$command arguments) #:user #$user #:group "kvm" #:environment-variables ;; QEMU tries to write to /var/tmp ;; by default. '("TMPDIR=/tmp"))) (port #$(virtual-build-machine-secrets-port config)) (root #$(virtual-build-machine-secret-root config)) (address (make-socket-address AF_INET INADDR_LOOPBACK port))) (catch #t (lambda _ (if (secret-service-send-secrets address root) pid (begin (kill (- pid) SIGTERM) #f))) (lambda (key . args) (kill (- pid) SIGTERM) (apply throw key args))))))) (stop #~(make-kill-destructor)) (actions (list (shepherd-action (name 'configuration) (documentation "Display the configuration of this virtual build machine.") (procedure #~(lambda (_) (format #t "CPU: ~a~%" #$(virtual-build-machine-cpu config)) (format #t "number of CPU cores: ~a~%" #$(virtual-build-machine-cpu-count config)) (format #t "memory size: ~a MiB~%" #$(virtual-build-machine-memory-size config)) (format #t "initial date: ~a~%" #$(date->string (virtual-build-machine-date config)))))))) (auto-start? (virtual-build-machine-auto-start? config))))) (define (authorize-guest-substitutes-on-host) "Return a program that authorizes the guest's archive signing key (passed as an argument) on the host." (define not-config? (match-lambda ('(guix config) #f) (('guix _ ...) #t) (('gnu _ ...) #t) (_ #f))) (define run (with-extensions (list guile-gcrypt) (with-imported-modules `(((guix config) => ,(make-config.scm)) ,@(source-module-closure '((guix pki) (guix build utils)) #:select? not-config?)) #~(begin (use-modules (ice-9 match) (ice-9 textual-ports) (gcrypt pk-crypto) (guix pki) (guix build utils)) (match (command-line) ((_ guest-config-directory) (let ((guest-key (string-append guest-config-directory "/signing-key.pub"))) (if (file-exists? guest-key) ;; Add guest key to the host's ACL. (let* ((key (string->canonical-sexp (call-with-input-file guest-key get-string-all))) (acl (public-keys->acl (cons key (acl->public-keys (current-acl)))))) (with-atomic-file-replacement %acl-file (lambda (_ port) (write-acl acl port)))) (format (current-error-port) "warning: guest key missing from '~a'~%" guest-key))))))))) (program-file "authorize-guest-substitutes-on-host" run)) (define (initialize-build-vm-substitutes) "Initialize the Hurd VM's key pair and ACL and store it on the host." (define run (with-imported-modules '((guix build utils)) #~(begin (use-modules (guix build utils) (ice-9 match)) (define host-key "/etc/guix/signing-key.pub") (define host-acl "/etc/guix/acl") (match (command-line) ((_ guest-config-directory) (setenv "GUIX_CONFIGURATION_DIRECTORY" guest-config-directory) (invoke #+(file-append guix "/bin/guix") "archive" "--generate-key") (when (file-exists? host-acl) ;; Copy the host ACL. (copy-file host-acl (string-append guest-config-directory "/acl"))) (when (file-exists? host-key) ;; Add the host key to the childhurd's ACL. (let ((key (open-fdes host-key O_RDONLY))) (close-fdes 0) (dup2 key 0) (execl #+(file-append guix "/bin/guix") "guix" "archive" "--authorize")))))))) (program-file "initialize-build-vm-substitutes" run)) (define* (build-vm-activation secret-directory #:key offloading-ssh-key (offloading? #t)) (with-imported-modules '((guix build utils)) #~(begin (use-modules (guix build utils)) (define secret-directory #$secret-directory) (define ssh-directory (string-append secret-directory "/etc/ssh")) (define guix-directory (string-append secret-directory "/etc/guix")) (define offloading-ssh-key #$offloading-ssh-key) (unless (file-exists? ssh-directory) ;; Generate SSH host keys under SSH-DIRECTORY. (mkdir-p ssh-directory) (invoke #$(file-append openssh "/bin/ssh-keygen") "-A" "-f" secret-directory)) (unless (or (not #$offloading?) (file-exists? offloading-ssh-key)) ;; Generate a user SSH key pair for the host to use when offloading ;; to the guest. (mkdir-p (dirname offloading-ssh-key)) (invoke #$(file-append openssh "/bin/ssh-keygen") "-t" "ed25519" "-N" "" "-f" offloading-ssh-key) ;; Authorize it in the guest for user 'offloading'. (let ((authorizations (string-append ssh-directory "/authorized_keys.d/offloading"))) (mkdir-p (dirname authorizations)) (copy-file (string-append offloading-ssh-key ".pub") authorizations) (chmod (dirname authorizations) #o555))) (unless (file-exists? guix-directory) (invoke #$(initialize-build-vm-substitutes) guix-directory)) (when #$offloading? ;; Authorize the archive signing key from GUIX-DIRECTORY in the host. (invoke #$(authorize-guest-substitutes-on-host) guix-directory))))) (define (virtual-build-machine-offloading-ssh-key config) "Return the name of the file containing the SSH key of user 'offloading'." (string-append "/etc/guix/offload/ssh/virtual-build-machine/" (symbol->string (virtual-build-machine-name config)))) (define (virtual-build-machine-activation config) "Return a gexp to activate the build VM according to CONFIG." (build-vm-activation (virtual-build-machine-secret-root config) #:offloading? #t #:offloading-ssh-key (virtual-build-machine-offloading-ssh-key config))) (define (virtual-build-machine-secret-root config) (string-append "/etc/guix/virtual-build-machines/" (symbol->string (virtual-build-machine-name config)))) (define (check-vm-availability config) "Return a Scheme file that evaluates to true if the service corresponding to CONFIG, a <virtual-build-machine>, is up and running." (define service-name (virtual-build-machine-name config)) (scheme-file "check-build-vm-availability.scm" #~(begin (use-modules (gnu services herd) (srfi srfi-34)) (guard (c ((service-not-found-error? c) #f)) (->bool (live-service-running (current-service '#$service-name))))))) (define (build-vm-guix-extension config) (define vm-ssh-key (string-append (virtual-build-machine-secret-root config) "/etc/ssh/ssh_host_ed25519_key.pub")) (define host-ssh-key (virtual-build-machine-offloading-ssh-key config)) (guix-extension (build-machines (list #~(if (primitive-load #$(check-vm-availability config)) (list (build-machine (name "localhost") (port #$(virtual-build-machine-ssh-port config)) (systems '#$(virtual-build-machine-systems config)) (user "offloading") (host-key (call-with-input-file #$vm-ssh-key (@ (ice-9 textual-ports) get-string-all))) (private-key #$host-ssh-key))) '()))))) (define virtual-build-machine-service-type (service-type (name 'build-vm) (extensions (list (service-extension shepherd-root-service-type build-vm-shepherd-services) (service-extension guix-service-type build-vm-guix-extension) (service-extension account-service-type virtual-build-machine-accounts) (service-extension activation-service-type virtual-build-machine-activation))) (description "Create a @dfn{virtual build machine}: a virtual machine (VM) that builds can be offloaded to. By default, the virtual machine starts with a clock running at some point in the past.") (default-value (virtual-build-machine)))) ;;; ;;; The Hurd in VM service: a Childhurd. ;;; (define (operating-system-with-offloading-account os) (define accounts (list (user-group (name "offloading") (system? #t)) (user-account (name "offloading") (group "offloading") (system? #t) (comment "Offloading privilege separation user") (home-directory "/var/run/offloading") (shell (file-append bash-minimal "/bin/sh"))))) (operating-system (inherit os) (services (cons (simple-service 'offloading-account account-service-type accounts) (operating-system-user-services os))))) (define (operating-system-with-locked-root-account os) "Return OS with a 'root' account whose password is uninitialized, thereby preventing password-based authentication as 'root'." (define root ;; %ROOT-ACCOUNT has an empty password; change that to an uninitialized ;; password. (user-account (inherit %root-account) (password #f))) (operating-system (inherit os) (users (cons root (operating-system-users os))))) (define %hurd-vm-operating-system (operating-system (inherit %hurd-default-operating-system) (host-name "childhurd") (timezone "Europe/Amsterdam") (bootloader (bootloader-configuration (bootloader grub-minimal-bootloader) (targets '("/dev/vda")) (timeout 0))) (packages (cons* gdb-minimal (operating-system-packages %hurd-default-operating-system))) (services (cons* (service openssh-service-type (openssh-configuration (openssh openssh-sans-x) (use-pam? #f) (permit-root-login 'prohibit-password) (allow-empty-passwords? #t) (password-authentication? #t))) ;; By default, the secret service introduces a pre-initialized ;; /etc/guix/acl file in the childhurd. Thus, clear ;; 'authorize-key?' so that it's not overridden at activation ;; time. (modify-services %base-services+qemu-networking/hurd (guix-service-type config => (guix-configuration (inherit config) (authorize-key? #f)))))))) (define-record-type* <hurd-vm-configuration> hurd-vm-configuration make-hurd-vm-configuration hurd-vm-configuration? (os hurd-vm-configuration-os ;<operating-system> (default %hurd-vm-operating-system)) (qemu hurd-vm-configuration-qemu ;file-like (default qemu-minimal)) (image hurd-vm-configuration-image ;<image> (thunked) (default (hurd-vm-disk-image this-record))) (disk-size hurd-vm-configuration-disk-size ;number or 'guess (default 'guess)) (memory-size hurd-vm-configuration-memory-size ;number (default 2048)) (options hurd-vm-configuration-options ;list of string (default `("--snapshot"))) (id hurd-vm-configuration-id ;#f or integer [1..] (default #f)) (net-options hurd-vm-configuration-net-options ;list of string (thunked) (default (hurd-vm-net-options this-record))) (offloading? hurd-vm-configuration-offloading? ;Boolean (default #t)) (secret-root hurd-vm-configuration-secret-root ;string (default "/etc/childhurd"))) (define (hurd-vm-disk-image config) "Return a disk-image for the Hurd according to CONFIG. The secret-service is added to the OS specified in CONFIG." (define transform (compose secret-service-operating-system ;; When offloading is enabled, (1) add the 'offloading' account, ;; and (2) prevent users from logging in as 'root' without a ;; password as this would allow any user on the host to populate ;; the host's store indirectly (for example by logging in as root ;; in the Hurd VM over VNC). (if (hurd-vm-configuration-offloading? config) (compose operating-system-with-locked-root-account operating-system-with-offloading-account) identity))) (let* ((os (transform (hurd-vm-configuration-os config))) (disk-size (hurd-vm-configuration-disk-size config)) (type (lookup-image-type-by-name 'hurd-qcow2)) (os->image (image-type-constructor type))) (image (inherit (os->image os)) (size disk-size)))) (define (hurd-vm-port config base) "Return the forwarded vm port for this childhurd config." (let ((id (or (hurd-vm-configuration-id config) 0))) (+ base (* 1000 id)))) (define %hurd-vm-secrets-port 11004) (define %hurd-vm-ssh-port 10022) (define %hurd-vm-vnc-port 15900) (define (hurd-vm-net-options config) `("--device" "rtl8139,netdev=net0" "--netdev" ,(string-append "user,id=net0" ",hostfwd=tcp:127.0.0.1:" (number->string (hurd-vm-port config %hurd-vm-secrets-port)) "-:1004" ",hostfwd=tcp:127.0.0.1:" (number->string (hurd-vm-port config %hurd-vm-ssh-port)) "-:22" ",hostfwd=tcp:127.0.0.1:" (number->string (hurd-vm-port config %hurd-vm-vnc-port)) "-:5900"))) (define (hurd-vm-shepherd-service config) "Return a <shepherd-service> for a Hurd in a Virtual Machine with CONFIG." (let ((image (hurd-vm-configuration-image config)) (qemu (hurd-vm-configuration-qemu config)) (memory-size (hurd-vm-configuration-memory-size config)) (options (hurd-vm-configuration-options config)) (id (hurd-vm-configuration-id config)) (net-options (hurd-vm-configuration-net-options config)) (provisions '(hurd-vm childhurd))) (define vm-command ;; XXX: Use the x86_64 emulator instead of the i386 one to work around ;; "Bad ram pointer" issues: <https://issues.guix.gnu.org/66053>. #~(append (list #$(file-append qemu "/bin/qemu-system-x86_64") "-m" (number->string #$memory-size) #$@net-options #$@options "--hda" #+(system-image image) ;; Cause the service to be respawned if the guest ;; reboots (it can reboot for instance if it did not ;; receive valid secrets, or if it crashed.) "--no-reboot") (if (file-exists? "/dev/kvm") '("--enable-kvm") '()))) (list (shepherd-service (documentation "Run the Hurd in a Virtual Machine: a Childhurd.") (provision (if id (map (cute symbol-append <> (string->symbol (number->string id))) provisions) provisions)) (requirement '(loopback networking user-processes)) (start (with-imported-modules (source-module-closure '((gnu build secret-service) (guix build utils))) #~(lambda () (let* ((pid (fork+exec-command #$vm-command #:user "childhurd" ;; XXX TODO: use "childhurd" after ;; updating Shepherd #:group "kvm" #:environment-variables ;; QEMU tries to write to /var/tmp ;; by default. '("TMPDIR=/tmp"))) (port #$(hurd-vm-port config %hurd-vm-secrets-port)) (root #$(hurd-vm-configuration-secret-root config)) (address (make-socket-address AF_INET INADDR_LOOPBACK port))) (catch #t (lambda _ ;; XXX: 'secret-service-send-secrets' won't complete until ;; the guest has booted and its secret service server is ;; running, which could take 20+ seconds during which PID 1 ;; is stuck waiting. (if (secret-service-send-secrets address root) pid (begin (kill (- pid) SIGTERM) #f))) (lambda (key . args) (kill (- pid) SIGTERM) (apply throw key args))))))) (modules `((gnu build secret-service) (guix build utils) ,@%default-modules)) (stop #~(make-kill-destructor)))))) (define %hurd-vm-accounts (list (user-group (name "childhurd") (system? #t)) (user-account (name "childhurd") (group "childhurd") (supplementary-groups '("kvm")) (comment "Privilege separation user for the childhurd") (home-directory "/var/empty") (shell (file-append shadow "/sbin/nologin")) (system? #t)))) (define (hurd-vm-activation config) "Return a gexp to activate the Hurd VM according to CONFIG." (build-vm-activation (hurd-vm-configuration-secret-root config) #:offloading? (hurd-vm-configuration-offloading? config) #:offloading-ssh-key (hurd-vm-configuration-offloading-ssh-key config))) (define (hurd-vm-configuration-offloading-ssh-key config) "Return the name of the file containing the SSH key of user 'offloading'." (string-append "/etc/guix/offload/ssh/childhurd" (or (and=> (hurd-vm-configuration-id config) number->string) ""))) (define (hurd-vm-guix-extension config) "When offloading is enabled, add this childhurd to the list of offlading machines in /etc/guix/machines.scm." (if (hurd-vm-configuration-offloading? config) (let* ((image (hurd-vm-configuration-image config)) (platform (image-platform image)) (system (platform-system platform)) (vm-ssh-key (string-append (hurd-vm-configuration-secret-root config) "/etc/ssh/ssh_host_ed25519_key.pub")) (host-ssh-key (hurd-vm-configuration-offloading-ssh-key config))) (guix-extension (build-machines (list #~(build-machine (name "localhost") (port #$(hurd-vm-port config %hurd-vm-ssh-port)) (systems '(#$system)) (host-key (call-with-input-file #$vm-ssh-key (@ (ice-9 textual-ports) get-string-all))) (user "offloading") (overload-threshold 1.8) ;current load reporting is off by 1 (private-key #$host-ssh-key)))))) (guix-extension))) (define hurd-vm-service-type (service-type (name 'hurd-vm) (extensions (list (service-extension shepherd-root-service-type hurd-vm-shepherd-service) (service-extension account-service-type (const %hurd-vm-accounts)) (service-extension guix-service-type hurd-vm-guix-extension) (service-extension activation-service-type hurd-vm-activation))) (default-value (hurd-vm-configuration)) (description "Provide a virtual machine (VM) running GNU/Hurd, also known as a @dfn{childhurd}.")))
generated by cgit