;;; GNU Guix --- Functional package management for GNU ;;; Copyright © 2012-2023 Ludovic Courtès ;;; Copyright © 2014, 2015, 2017, 2018, 2019 Mark H Weaver ;;; Copyright © 2015 Eric Bavier ;;; Copyright © 2016 Alex Kost ;;; Copyright © 2017, 2019, 2020, 2022 Efraim Flashner ;;; Copyright © 2019 Marius Bakke ;;; Copyright © 2020, 2021 Maxim Cournoyer ;;; Copyright © 2021 Chris Marusich ;;; Copyright © 2022 Maxime Devos ;;; Copyright © 2022 jgart ;;; Copyright © 2023 Simon Tournier ;;; ;;; 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 . (define-module (guix packages) #:use-module ((guix build utils) #:select (compressor tarball? strip-store-file-name)) #:use-module (guix utils) #:use-module (guix records) #:use-module (guix store) #:use-module (guix monads) #:use-module (guix gexp) #:use-module (guix base32) #:autoload (guix base64) (base64-decode) #:use-module (guix grafts) #:use-module (guix derivations) #:use-module (guix memoization) #:use-module (guix build-system) #:use-module (guix search-paths) #:use-module (guix sets) #:use-module (guix deprecation) #:use-module ((guix diagnostics) #:select (formatted-message define-with-syntax-properties)) #:autoload (guix licenses) (license?) #:use-module (guix i18n) #:use-module (ice-9 match) #:use-module (ice-9 vlist) #:use-module (ice-9 regex) #:use-module (srfi srfi-1) #:use-module (srfi srfi-9 gnu) #:use-module (srfi srfi-26) #:use-module (srfi srfi-34) #:use-module (srfi srfi-35) #:use-module (srfi srfi-71) #:use-module (rnrs bytevectors) #:use-module (web uri) #:autoload (texinfo) (texi-fragment->stexi) #:re-export (%current-system %current-target-system search-path-specification) ;for convenience #:replace ((define-public* . define-public)) #:export (content-hash content-hash? content-hash-algorithm content-hash-value origin origin? this-origin origin-uri origin-method origin-hash origin-file-name origin-actual-file-name origin-patches origin-patch-flags origin-patch-inputs origin-patch-guile origin-snippet origin-modules base32 base64 package package? this-package package-name package-upstream-name package-upstream-name* package-version package-full-name package-source package-build-system package-arguments package-inputs package-native-inputs package-propagated-inputs package-outputs package-native-search-paths package-search-paths package-replacement package-synopsis package-description package-license package-home-page package-supported-systems package-properties package-location package-definition-location hidden-package hidden-package? package-superseded deprecated-package package-field-location this-package-input this-package-native-input lookup-package-input lookup-package-native-input lookup-package-propagated-input lookup-package-direct-input prepend ;syntactic keyword replace ;syntactic keyword modify-inputs package-direct-sources package-transitive-sources package-direct-inputs package-transitive-inputs package-transitive-target-inputs package-transitive-native-inputs package-transitive-propagated-inputs package-transitive-native-search-paths package-transitive-supported-systems package-mapping package-input-rewriting package-input-rewriting/spec package-source-derivation package-derivation package-cross-derivation package-output package-grafts package-patched-vulnerabilities package-with-patches package-with-extra-patches package-with-c-toolchain package/inherit transitive-input-references %32bit-supported-systems %64bit-supported-systems %supported-systems %hurd-systems %cuirass-supported-systems supported-package? &package-error package-error? package-error-package package-license-error? package-error-invalid-license &package-input-error package-input-error? &package-cyclic-dependency-error package-cyclic-dependency-error? package-error-dependency-cycle package-error-invalid-input &package-cross-build-system-error package-cross-build-system-error? package->bag bag->derivation bag-direct-inputs bag-transitive-inputs bag-transitive-host-inputs bag-transitive-build-inputs bag-transitive-target-inputs package-development-inputs package-closure default-guile guile-for-grafts default-guile-derivation set-guile-for-build package-file package->derivation package->cross-derivation origin->derivation)) ;; The 'source-module-closure' procedure ca. 1.2.0 did not recognize ;; #:re-export-and-replace: . ;; Work around it. The #:replace? argument is only supported by ;; Guile 2.2.7 and later, work-around it if necessary to allow ;; time-travel from 1.1.0, see . (let ((major (string->number (major-version)))) (if (or (>= major 3) (and (= major 2) (= (string->number (minor-version)) 2) ; there is no Guile 2.3.X (>= (string->number (micro-version)) 7))) (module-re-export! (current-module) '(delete) #:replace? #t) (module-re-export! (current-module) '(delete)))) ;;; Commentary: ;;; ;;; This module provides a high-level mechanism to define packages in a ;;; Guix-based distribution. ;;; ;;; Code: (define-syntax-rule (define-compile-time-decoder name string->bytevector) "Define NAME as a macro that runs STRING->BYTEVECTOR at macro expansion time if possible." (define-syntax name (lambda (s) "Return the bytevector corresponding to the given textual representation." (syntax-case s () ((_ str) (string? (syntax->datum #'str)) ;; A literal string: do the conversion at expansion time. (with-syntax ((bv (string->bytevector (syntax->datum #'str)))) #''bv)) ((_ str) #'(string->bytevector str)))))) (define-compile-time-decoder base32 nix-base32-string->bytevector) (define-compile-time-decoder base64 base64-decode) ;; Crytographic content hash. (define-immutable-record-type (%content-hash algorithm value) content-hash? (algorithm content-hash-algorithm) ;symbol (value content-hash-value)) ;bytevector (define-syntax-rule (define-content-hash-constructor name (algorithm size) ...) "Define NAME as a constructor that ensures that (1) its second argument is among the listed ALGORITHM, and (2), when possible, that its first argument has the right size for the chosen algorithm." (define-syntax name (lambda (s) (syntax-case s (algorithm ...) ((_ bv algorithm) (let ((bv* (syntax->datum #'bv))) (when (and (bytevector? bv*) (not (= size (bytevector-length bv*)))) (syntax-violation 'content-hash "invalid content hash length" s)) #'(%content-hash 'algorithm bv))) ...)))) (define-content-hash-constructor build-content-hash (sha256 32) (sha512 64) (sha3-256 32) (sha3-512 64) (blake2s-256 64)) (define-syntax content-hash (lambda (s) "Return a content hash with the given parameters. The default hash algorithm is sha256. If the first argument is a literal string, it is decoded as base32. Otherwise, it must be a bytevector." ;; What we'd really want here is something like C++ 'constexpr'. (syntax-case s () ((_ str) (string? (syntax->datum #'str)) #'(content-hash str sha256)) ((_ str algorithm) (string? (syntax->datum #'str)) (with-syntax ((bv (base32 (syntax->datum #'str)))) #'(content-hash bv algorithm))) ((_ (id str) algorithm) (and (string? (syntax->datum #'str)) (free-identifier=? #'id #'base32)) (with-syntax ((bv (nix-base32-string->bytevector (syntax->datum #'str)))) #'(content-hash bv algorithm))) ((_ (id str) algorithm) (and (string? (syntax->datum #'str)) (free-identifier=? #'id #'base64)) (with-syntax ((bv (base64-decode (syntax->datum #'str)))) #'(content-hash bv algorithm))) ((_ bv) #'(content-hash bv sha256)) ((_ bv hash) #'(build-content-hash bv hash))))) (define (print-content-hash hash port) (format port "#" (content-hash-algorithm hash) (and=> (content-hash-value hash) bytevector->nix-base32-string))) (set-record-type-printer! print-content-hash) ;; The source of a package, such as a tarball URL and fetcher---called ;; "origin" to avoid name clash with `package-source', `source', etc. (define-record-type* %origin make-origin origin? this-origin (uri origin-uri) ; string (method origin-method) ; procedure (hash origin-hash) ; (file-name origin-file-name (default #f)) ; optional file name ;; Patches are delayed so that the 'search-patch' calls are made lazily, ;; which reduces I/O on startup and allows patch-not-found errors to be ;; gracefully handled at run time. (patches origin-patches ; list of file names (default '()) (delayed)) (snippet origin-snippet (default #f)) ; sexp or #f (patch-flags origin-patch-flags ; string-list gexp (default %default-patch-flags)) ;; Patching requires Guile, GNU Patch, and a few more. These two fields are ;; used to specify these dependencies when needed. (patch-inputs origin-patch-inputs ; input list or #f (default #f)) (modules origin-modules ; list of module names (default '())) (patch-guile origin-patch-guile ; package or #f (default #f))) (define-syntax origin-compatibility-helper (syntax-rules (sha256) ((_ () (fields ...)) (%origin fields ...)) ((_ ((sha256 exp) rest ...) (others ...)) (%origin others ... (hash (content-hash exp sha256)) rest ...)) ((_ (field rest ...) (others ...)) (origin-compatibility-helper (rest ...) (others ... field))))) (define-syntax-rule (origin fields ...) "Build an record, automatically converting 'sha256' field specifications to 'hash'." (origin-compatibility-helper (fields ...) ())) (define (print-origin origin port) "Write a concise representation of ORIGIN to PORT." (match origin (($ uri method hash file-name patches) (simple-format port "#" uri hash (force patches) (number->string (object-address origin) 16))))) (set-record-type-printer! print-origin) (define %default-patch-flags #~("-p1")) (define (origin-actual-file-name origin) "Return the file name of ORIGIN, either its 'file-name' field or the file name of its URI." (define (uri->file-name uri) ;; Return the 'base name' of URI or URI itself, where URI is a string. (let ((path (and=> (string->uri uri) uri-path))) (if path (basename path) uri))) (or (origin-file-name origin) (match (origin-uri origin) ((head . tail) (uri->file-name head)) ((? string? uri) (uri->file-name uri)) (else ;; git, svn, cvs, etc. reference #f)))) ;; Work around limitations in the 'snippet' mechanism. It is not possible for ;; a 'snippet' to produce a tarball with a different base name than the ;; original downloaded source. Moreover, cherry picking dozens of upsteam ;; patches and applying them suddenly is often impractical; especially when a ;; comprehensive code reformatting is done upstream. Mainly designed for ;; Linux and IceCat packages. ;; XXXX: do not make part of public API (export) such radical capability ;; before a detailed review process. (define* (computed-origin-method gexp-promise hash-algo hash #:optional (name "source") #:key (system (%current-system)) (guile (default-guile))) "Return a derivation that executes the G-expression that results from forcing GEXP-PROMISE." (mlet %store-monad ((guile (package->derivation guile system))) (gexp->derivation (or name "computed-origin") (force gexp-promise) #:graft? #f ;nothing to graft #:system system #:guile-for-build guile))) (define %32bit-supported-systems ;; This is the list of 32-bit system types that are supported. '("i686-linux" "armhf-linux" "i586-gnu" "powerpc-linux")) (define %64bit-supported-systems ;; This is the list of 64-bit system types that are supported. '("x86_64-linux" "mips64el-linux" "aarch64-linux" "powerpc64le-linux" "riscv64-linux")) (define %supported-systems ;; This is the list of system types that are supported. By default, we ;; expect all packages to build successfully here. (append %64bit-supported-systems %32bit-supported-systems)) (define %hurd-systems ;; The GNU/Hurd systems for which support is being developed. '("i586-gnu")) (define %cuirass-supported-systems ;; This is the list of system types for which build machines are available. ;; ;; XXX: MIPS is unavailable in CI: ;; . (fold delete %supported-systems '("mips64el-linux" "powerpc-linux" "riscv64-linux"))) (define-inlinable (sanitize-inputs inputs) "Sanitize INPUTS by turning it into a list of name/package tuples if it's not already the case." (cond ((null? inputs) inputs) ((and (pair? (car inputs)) (string? (caar inputs))) inputs) (else (map add-input-label inputs)))) (define-syntax current-location-vector (lambda (s) "Like 'current-source-location' but expand to a literal vector with one-indexed line numbers." ;; Storing a literal vector in .go files is more efficient than storing an ;; alist: less initialization code, fewer relocations, etc. (syntax-case s () ((_) (match (syntax-source s) (#f #f) (properties (let ((file (assq-ref properties 'filename)) (line (assq-ref properties 'line)) (column (assq-ref properties 'column))) (and file line column #`#(#,file #,(+ 1 line) #,column))))))))) (define-inlinable (sanitize-location loc) ;; Convert LOC to a vector or to #f. (cond ((vector? loc) loc) ((not loc) loc) (else (vector (location-file loc) (location-line loc) (location-column loc))))) (define-syntax-parameter current-definition-location ;; Location of the encompassing 'define-public'. (const #f)) (define-syntax define-public* (lambda (s) "Like 'define-public' but set 'current-definition-location' for the lexical scope of its body." (define location (match (syntax-source s) (#f #f) (properties (let ((line (assq-ref properties 'line)) (column (assq-ref properties 'column))) ;; Don't repeat the file name since it's redundant with 'location'. ;; Encode the whole thing so that it fits in a fixnum on 32-bit ;; platforms, which leaves us 29 bits: 7 bits for COLUMN (which is ;; almost always zero), and 22 bits for LINE. (and line column (logior (ash (logand #x7f column) 22) (logand (- (expt 2 22) 1) (+ 1 line)))))))) (syntax-case s () ((_ prototype body ...) #`(define-public prototype (syntax-parameterize ((current-definition-location (lambda (s) #,location))) body ...)))))) (define-syntax validate-texinfo (let ((validate? (getenv "GUIX_UNINSTALLED"))) (define ensure-thread-safe-texinfo-parser! ;; Work around for Guile <= 3.0.7. (let ((patched? (or (> (string->number (major-version)) 3) (> (string->number (minor-version)) 0) (> (string->number (micro-version)) 7))) (next-token-of/thread-safe (lambda (pred port) (let loop ((chars '())) (match (read-char port) ((? eof-object?) (list->string (reverse! chars))) (chr (let ((chr* (pred chr))) (if chr* (loop (cons chr* chars)) (begin (unread-char chr port) (list->string (reverse! chars))))))))))) (lambda () (unless patched? (set! (@@ (texinfo) next-token-of) next-token-of/thread-safe) (set! patched? #t))))) (lambda (s) "Raise a syntax error when passed a literal string that is not valid Texinfo. Otherwise, return the string." (syntax-case s () ((_ str) (string? (syntax->datum #'str)) (if validate? (catch 'parser-error (lambda () (ensure-thread-safe-texinfo-parser!) (texi-fragment->stexi (syntax->datum #'str)) #'str) (lambda _ (syntax-violation 'package "invalid Texinfo markup" #'str))) #'str)) ((_ obj) #'obj))))) (define-syntax valid-license-value? (syntax-rules (list package-license) "Return #t if the given value is a valid license field, #f otherwise." ;; Arrange so that the answer can be given at macro-expansion time in the ;; most common cases. ((_ (list x ...)) (and (license? x) ...)) ((_ (package-license _)) #t) ((_ obj) (or (license? obj) ;; Note: Avoid 'not' below due to . (eq? #f obj) ;#f is considered valid (let ((x obj)) (and (pair? x) (every license? x))))))) (define-with-syntax-properties (validate-license (value properties)) (unless (valid-license-value? value) (raise (make-compound-condition (condition (&error-location (location (source-properties->location properties)))) (condition (&package-license-error (package #f) (license value))) (formatted-message (G_ "~s: invalid package license~%") value)))) value) ;; A package. (define-record-type* package make-package package? this-package (name package-name) ; string (version package-version) ; string (source package-source) ; instance (build-system package-build-system) ; instance (arguments package-arguments ; arguments for the build method (default '()) (thunked)) (inputs package-inputs ; input packages or derivations (default '()) (thunked) (sanitize sanitize-inputs)) (propagated-inputs package-propagated-inputs ; same, but propagated (default '()) (thunked) (sanitize sanitize-inputs)) (native-inputs package-native-inputs ; native input packages/derivations (default '()) (thunked) (sanitize sanitize-inputs)) (outputs package-outputs ; list of strings (default '("out"))) ; lists of ; , ; for native and cross ; inputs (native-search-paths package-native-search-paths (default '())) (search-paths package-search-paths (default '())) ;; The 'replacement' field is marked as "innate" because it never makes ;; sense to inherit a replacement as is. See the 'package/inherit' macro. (replacement package-replacement ; package | #f (default #f) (thunked) (innate)) (synopsis package-synopsis (sanitize validate-texinfo)) ; one-line description (description package-description (sanitize validate-texinfo)) ; one or two paragraphs (license package-license ; (list of) (sanitize validate-license)) (home-page package-home-page) ; string (supported-systems package-supported-systems ; list of strings (default %supported-systems)) (properties package-properties (default '())) ; alist for anything else (location package-location-vector (default (current-location-vector)) (innate) (sanitize sanitize-location)) (definition-location package-definition-location-code (default (current-definition-location)) (innate))) (define (add-input-label input) "Add an input label to INPUT." (match input ((? package? package) (list (package-name package) package)) (((? package? package) output) ;XXX: ugly? (list (package-name package) package output)) ((? gexp-input?) ;XXX: misplaced because 'native?' field is ignored? (let ((obj (gexp-input-thing input)) (output (gexp-input-output input))) `(,(if (package? obj) (package-name obj) "_") ,obj ,@(if (string=? output "out") '() (list output))))) (x `("_" ,x)))) (set-record-type-printer! (lambda (package port) (let ((loc (package-location package)) (format simple-format)) (format port "#" (package-name package) (package-version package) (if loc (format #f "~a:~a " (location-file loc) (location-line loc)) "") (number->string (object-address package) 16))))) (define (package-location package) "Return the source code location of PACKAGE as a record, or #f if it is not known." (match (package-location-vector package) (#f #f) (#(file line column) (location file line column)))) (define (package-definition-location package) "Like 'package-location', but return the location of the definition itself--i.e., that of the enclosing 'define-public' form, if any, or #f." (match (package-definition-location-code package) (#f #f) (code (let ((column (bit-extract code 22 29)) (line (bit-extract code 0 21))) (match (package-location-vector package) (#f #f) (#(file _ _) (location file line column))))))) (define-syntax-rule (package/inherit p overrides ...) "Like (package (inherit P) OVERRIDES ...), except that the same transformation is done to the package P's replacement, if any. P must be a bare identifier, and will be bound to either P or its replacement when evaluating OVERRIDES." (let loop ((p p)) (package (inherit p) overrides ... (replacement (and=> (package-replacement p) loop))))) (define (package-upstream-name package) "Return the upstream name of PACKAGE, which could be different from the name it has in Guix." (or (assq-ref (package-properties package) 'upstream-name) (package-name package))) (define (package-upstream-name* package) "Return the upstream name of PACKAGE, accounting for commonly-used package name prefixes in addition to the @code{upstream-name} property." (let ((namespaces (list "cl-" "ecl-" "emacs-" "ghc-" "go-" "guile-" "java-" "julia-" "lua-" "minetest-" "node-" "ocaml-" "perl-" "python-" "r-" "ruby-" "rust-" "sbcl-" "texlive-")) (name (package-name package))) (or (assq-ref (package-properties package) 'upstream-name) (let loop ((prefixes namespaces)) (match prefixes (() name) ((prefix rest ...) (if (string-prefix? prefix name) (substring name (string-length prefix)) (loop rest)))))))) (define (hidden-package p) "Return a \"hidden\" version of P--i.e., one that 'fold-packages' and thus, user interfaces, ignores." (package (inherit p) (location (package-location p)) (properties `((hidden? . #t) ,@(package-properties p))))) (define (hidden-package? p) "Return true if P is \"hidden\"--i.e., must not be visible to user interfaces." (assoc-ref (package-properties p) 'hidden?)) (define (package-superseded p) "Return the package that supersedes P, or #f if P is still current." (assoc-ref (package-properties p) 'superseded)) (define (deprecated-package old-name p) "Return a package called OLD-NAME and marked as superseded by P, a package object." (package (inherit p) (name old-name) (properties `((superseded . ,p))))) (define (package-field-location package field) "Return the source code location of the definition of FIELD for PACKAGE, or #f if it could not be determined." (match (package-location package) (($ file line column) (match (search-path %load-path file) ((? string? file-found) (catch 'system-error (lambda () ;; In general we want to keep relative file names for modules. (call-with-input-file file-found (lambda (port) (go-to-location port line column) (match (read port) ((or ('package inits ...) ('package/inherit _ inits ...)) (let ((field (assoc field inits))) (match field ((_ value) (let ((loc (and=> (source-properties value) source-properties->location))) (and loc ;; Preserve the original file name, which may be a ;; relative file name. (set-field loc (location-file) file)))) (_ #f)))) (_ #f))))) (lambda _ #f))) (#f ;; FILE could not be found in %LOAD-PATH. #f))) (_ #f))) (define-syntax-rule (this-package-input name) "Return the input NAME of the package being defined--i.e., an input from the ‘inputs’ or ‘propagated-inputs’ field. Native inputs are not considered. If this input does not exist, return #f instead." (or (lookup-package-input this-package name) (lookup-package-propagated-input this-package name))) (define-syntax-rule (this-package-native-input name) "Return the native package input NAME of the package being defined--i.e., an input from the ‘native-inputs’ field. If this native input does not exist, return #f instead." (lookup-package-native-input this-package name)) ;; Error conditions. (define-condition-type &package-error &error package-error? (package package-error-package)) (define-condition-type &package-license-error &package-error package-license-error? (license package-error-invalid-license)) (define-condition-type &package-input-error &package-error package-input-error? (input package-error-invalid-input)) (define-condition-type &package-cyclic-dependency-error &package-error package-cyclic-dependency-error? (cycle package-error-dependency-cycle)) (define-condition-type &package-cross-build-system-error &package-error package-cross-build-system-error?) (define* (package-full-name package #:optional (delimiter "@")) "Return the full name of PACKAGE--i.e., `NAME@VERSION'. By specifying DELIMITER (a string), you can customize what will appear between the name and the version. By default, DELIMITER is \"@\"." (string-append (package-name package) delimiter (package-version package))) (define (patch-file-name patch) "Return the basename of PATCH's file name, or #f if the file name could not be determined." (match patch ((? string?) (basename patch)) ((? origin?) (and=> (origin-actual-file-name patch) basename)))) (define %vulnerability-regexp ;; Regexp matching a CVE identifier in patch file names. (make-regexp "CVE-[0-9]{4}-[0-9]+")) (define (package-patched-vulnerabilities package) "Return the list of patched vulnerabilities of PACKAGE as a list of CVE identifiers. The result is inferred from the file names of patches." (define (patch-vulnerabilities patch) (map (cut match:substring <> 0) (list-matches %vulnerability-regexp patch))) (let ((patches (filter-map patch-file-name (or (and=> (package-source package) origin-patches) '())))) (append-map patch-vulnerabilities patches))) (define (%standard-patch-inputs system) (let* ((canonical (module-ref (resolve-interface '(gnu packages base)) 'canonical-package)) (ref (lambda (module var) ;; Make sure 'canonical-package' is not influenced by ;; '%current-target-system' since we're going to use the ;; native package anyway. (parameterize ((%current-target-system #f) (%current-system system)) (canonical (module-ref (resolve-interface module) var)))))) `(("tar" ,(ref '(gnu packages base) 'tar)) ("xz" ,(ref '(gnu packages compression) 'xz)) ("bzip2" ,(ref '(gnu packages compression) 'bzip2)) ("gzip" ,(ref '(gnu packages compression) 'gzip)) ("lzip" ,(ref '(gnu packages compression) 'lzip)) ("unzip" ,(ref '(gnu packages compression) 'unzip)) ("patch" ,(ref '(gnu packages base) 'patch)) ("locales" ,(parameterize ((%current-target-system #f) (%current-system system)) (canonical ((module-ref (resolve-interface '(gnu packages base)) 'libc-utf8-locales-for-target)))))))) (define (default-guile) "Return the default Guile package used to run the build code of derivations." (let ((distro (resolve-interface '(gnu packages commencement)))) (module-ref distro 'guile-final))) (define (guile-for-grafts) "Return the Guile package used to build grafting derivations." (let ((distro (resolve-interface '(gnu packages commencement)))) (module-ref distro 'guile-final))) (define* (default-guile-derivation #:optional (system (%current-system))) "Return the derivation for SYSTEM of the default Guile package used to run the build code of derivation." (package->derivation (default-guile) system #:graft? #f)) (define* (patch-and-repack source patches #:key inputs (snippet #f) (flags %default-patch-flags) (modules '()) (guile-for-build (%guile-for-build)) (system (%current-system))) "Unpack SOURCE (a derivation or store path), apply all of PATCHES, and repack the tarball using the tools listed in INPUTS. When SNIPPET is true, it must be an s-expression that will run from within the directory where SOURCE was unpacked, after all of PATCHES have been applied. MODULES specifies modules in scope when evaluating SNIPPET." (define source-file-name ;; SOURCE is usually a derivation, but it could be a store file. (if (derivation? source) (derivation->output-path source) source)) (define lookup-input ;; The default value of the 'patch-inputs' field, and thus INPUTS is #f, ;; so deal with that. (let ((inputs (or inputs (%standard-patch-inputs system)))) (lambda (name) (match (assoc-ref inputs name) ((package) package) (#f #f))))) (define original-file-name (strip-store-file-name source-file-name)) (define (numeric-extension? file-name) ;; Return true if FILE-NAME ends with digits. (and=> (file-extension file-name) (cut string-every char-set:hex-digit <>))) (define (checkout? directory) ;; Return true if DIRECTORY is a checkout (git, svn, etc). (string-suffix? "-checkout" directory)) (define (tarxz-name file-name) ;; Return a '.tar.xz' file name based on FILE-NAME. (let ((base (if (numeric-extension? file-name) original-file-name (file-sans-extension file-name)))) (string-append base (if (equal? (file-extension base) "tar") ".xz" ".tar.xz")))) (define instantiate-patch (match-lambda ((? string? patch) ;deprecated (local-file patch #:recursive? #t)) ((? struct? patch) ;origin, local-file, etc. patch))) (let ((tar (lookup-input "tar")) (gzip (lookup-input "gzip")) (bzip2 (lookup-input "bzip2")) (lzip (lookup-input "lzip")) (xz (lookup-input "xz")) (patch (lookup-input "patch")) (locales (lookup-input "locales")) (comp (and=> (compressor source-file-name) lookup-input)) (patches (map instantiate-patch patches))) (define build (with-imported-modules '((guix build utils)) #~(begin (use-modules (ice-9 ftw) (ice-9 match) (ice-9 regex) (srfi srfi-1) (srfi srfi-26) (guix build utils)) ;; The --sort option was added to GNU tar in version 1.28, released ;; 2014-07-28. During bootstrap we must cope with older versions. (define tar-supports-sort? (zero? (system* (string-append #+tar "/bin/tar") "cf" "/dev/null" "--files-from=/dev/null" "--sort=name"))) (define (apply-patch patch) (format (current-error-port) "applying '~a'...~%" patch) ;; Use '--force' so that patches that do not apply perfectly are ;; rejected. Use '--no-backup-if-mismatch' to prevent making ;; "*.orig" file if a patch is applied with offset. (invoke (string-append #+patch "/bin/patch") "--force" "--no-backup-if-mismatch" #+@flags "--input" patch)) (define (first-file directory) ;; Return the name of the first file in DIRECTORY. (car (scandir directory (lambda (name) (not (member name '("." ".."))))))) (define (repack directory output) ;; Write to OUTPUT a compressed tarball containing DIRECTORY. (unless tar-supports-sort? (call-with-output-file ".file_list" (lambda (port) (for-each (lambda (name) (format port "~a~%" name)) (find-files directory #:directories? #t #:fail-on-error? #t))))) (apply invoke #+(file-append tar "/bin/tar") "cvfa" output ;; Avoid non-determinism in the archive. Set the mtime ;; to 1 as is the case in the store (software like gzip ;; behaves differently when it stumbles upon mtime = 0). "--mtime=@1" "--owner=root:0" "--group=root:0" (if tar-supports-sort? `("--sort=name" ,directory) '("--no-recursion" "--files-from=.file_list")))) ;; Encoding/decoding errors shouldn't be silent. (fluid-set! %default-port-conversion-strategy 'error) (when #+locales ;; First of all, install a UTF-8 locale so that UTF-8 file names ;; are correctly interpreted. During bootstrap, LOCALES is #f. (setenv "LOCPATH" (string-append #+locales "/lib/locale/" #+(and locales (version-major+minor (package-version locales))))) (setlocale LC_ALL "en_US.utf8")) (setenv "PATH" (string-append #+xz "/bin" (if #+comp (string-append ":" #+comp "/bin") ""))) (setenv "XZ_DEFAULTS" (string-join (%xz-parallel-args))) ;; SOURCE may be either a directory, a tarball or a simple file. (let ((name (strip-store-file-name #+source)) (command (and=> #+comp (cut string-append <> "/bin/" (compressor #+source))))) (if (file-is-directory? #+source) (copy-recursively #+source name) (cond ((tarball? #+source) (invoke (string-append #+tar "/bin/tar") "xvf" #+source)) ((and=> (compressor #+source) (cut string= "unzip" <>)) ;; Note: Referring to the store unzip here (#+unzip) ;; would introduce a cycle. (invoke "unzip" #+source)) (else (copy-file #+source name) (when command (invoke command "--decompress" name)))))) (let* ((file (first-file ".")) (directory (if (file-is-directory? file) file "."))) (format (current-error-port) "source is at '~a'~%" file) (with-directory-excursion directory (for-each apply-patch '#+patches) #+(if snippet #~(let ((module (make-fresh-user-module))) (module-use-interfaces! module (map resolve-interface '#+modules)) ((@ (system base compile) compile) '#+(if (pair? snippet) (sexp->gexp snippet) snippet) #:to 'value #:opts %auto-compilation-options #:env module)) #~#t)) ;; If SOURCE is a directory (such as a checkout), return a ;; directory. Otherwise create a tarball. (cond ((file-is-directory? #+source) (copy-recursively directory #$output #:log (%make-void-port "w"))) ((or #+comp (tarball? #+source)) (repack directory #$output)) (else ;single uncompressed file (copy-file file #$output))))))) (let ((name (if (or (checkout? original-file-name) (not (compressor original-file-name))) original-file-name (tarxz-name original-file-name)))) (gexp->derivation name build #:graft? #f #:system system #:guile-for-build guile-for-build #:properties `((type . origin) (patches . ,(length patches))))))) (define (package-with-patches original patches) "Return package ORIGINAL with PATCHES applied." (package (inherit original) (source (origin (inherit (package-source original)) (patches patches))) (location (package-location original)))) (define (package-with-extra-patches original patches) "Return package ORIGINAL with all PATCHES appended to its list of patches." (package-with-patches original (append (origin-patches (package-source original)) patches))) (define (package-with-c-toolchain package toolchain) "Return a variant of PACKAGE that uses TOOLCHAIN instead of the default GNU C/C++ toolchain. TOOLCHAIN must be a list of inputs (label/package tuples) providing equivalent functionality, such as the 'gcc-toolchain' package." (let ((bs (package-build-system package))) (package/inherit package (build-system (build-system-with-c-toolchain bs toolchain))))) (define (transitive-inputs inputs) "Return the closure of INPUTS when considering the 'propagated-inputs' edges. Omit duplicate inputs, except for those already present in INPUTS itself. This is implemented as a breadth-first traversal such that INPUTS is preserved, and only duplicate propagated inputs are removed." (define (seen? seen item outputs) ;; FIXME: We're using pointer identity here, which is extremely sensitive ;; to memoization in package-producing procedures; see ;; . (match (vhash-assq item seen) ((_ . o) (equal? o outputs)) (_ #f))) (let loop ((inputs inputs) (result '()) (propagated '()) (first? #t) (seen vlist-null)) (match inputs (() (if (null? propagated) (reverse result) (loop (reverse (concatenate propagated)) result '() #f seen))) (((and input (label (? package? package) outputs ...)) rest ...) (if (and (not first?) (seen? seen package outputs)) (loop rest result propagated first? seen) (loop rest (cons input result) (cons (package-propagated-inputs package) propagated) first? (vhash-consq package outputs seen)))) ((input rest ...) (loop rest (cons input result) propagated first? seen))))) (define (lookup-input inputs name) "Lookup NAME among INPUTS, an input list." ;; Note: Currently INPUTS is assumed to be an input list that contains input ;; labels. In the future, input labels will be gone and this procedure will ;; check package names. (match (assoc-ref inputs name) ((obj) obj) ((obj _) obj) (#f #f))) (define (lookup-package-input package name) "Look up NAME among PACKAGE's inputs. Return it if found, #f otherwise." (lookup-input (package-inputs package) name)) (define (lookup-package-native-input package name) "Look up NAME among PACKAGE's native inputs. Return it if found, #f otherwise." (lookup-input (package-native-inputs package) name)) (define (lookup-package-propagated-input package name) "Look up NAME among PACKAGE's propagated inputs. Return it if found, #f otherwise." (lookup-input (package-propagated-inputs package) name)) (define (lookup-package-direct-input package name) "Look up NAME among PACKAGE's direct inputs. Return it if found, #f otherwise." (lookup-input (package-direct-inputs package) name)) (define (replace-input name replacement inputs) "Replace input NAME by REPLACEMENT within INPUTS." (map (lambda (input) (match input (((? string? label) _ . outputs) (if (string=? label name) (match replacement ;does REPLACEMENT specify an output? ((_ _) (cons label replacement)) (_ (cons* label replacement outputs))) input)))) inputs)) (define-syntax prepend (lambda (s) (syntax-violation 'prepend "'prepend' may only be used within 'modify-inputs'" s))) (define-syntax replace (lambda (s) (syntax-violation 'replace "'replace' may only be used within 'modify-inputs'" s))) (define-syntax modify-inputs (syntax-rules (delete prepend append replace) "Modify the given package inputs, as returned by 'package-inputs' & co., according to the given clauses. The example below removes the GMP and ACL inputs of Coreutils and adds libcap: (modify-inputs (package-inputs coreutils) (delete \"gmp\" \"acl\") (prepend libcap)) Other types of clauses include 'append' and 'replace'. The first argument must be a labeled input list; the result is also a labeled input list." ;; Note: This macro hides the fact that INPUTS, as returned by ;; 'package-inputs' & co., is actually an alist with labels. Eventually, ;; it will operate on list of inputs without labels. ((_ inputs (delete name) clauses ...) (modify-inputs (alist-delete name inputs) clauses ...)) ((_ inputs (delete names ...) clauses ...) (modify-inputs (fold alist-delete inputs (list names ...)) clauses ...)) ((_ inputs (prepend lst ...) clauses ...) (modify-inputs (append (map add-input-label (list lst ...)) inputs) clauses ...)) ((_ inputs (append lst ...) clauses ...) (modify-inputs (append inputs (map add-input-label (list lst ...))) clauses ...)) ((_ inputs (replace name replacement) clauses ...) (modify-inputs (replace-input name replacement inputs) clauses ...)) ((_ inputs) inputs))) (define (package-direct-sources package) "Return all source origins associated with PACKAGE; including origins in PACKAGE's inputs and patches." (define (expand source) (cons source (filter origin? (origin-patches source)))) `(,@(match (package-source package) ((? origin? origin) (expand origin)) (_ '())) ,@(filter-map (match-lambda ((_ (? origin? orig) _ ...) orig) (_ #f)) (package-direct-inputs package)))) (define (package-transitive-sources package) "Return PACKAGE's direct sources, and their direct sources, recursively." (delete-duplicates (concatenate (filter-map (match-lambda ((_ (? origin? orig) _ ...) (list orig)) ((_ (? package? p) _ ...) (package-direct-sources p)) (_ #f)) (bag-transitive-inputs (package->bag package)))))) (define (package-direct-inputs package) "Return all the direct inputs of PACKAGE---i.e, its direct inputs along with their propagated inputs." (append (package-native-inputs package) (package-inputs package) (package-propagated-inputs package))) (define (package-transitive-inputs package) "Return the transitive inputs of PACKAGE---i.e., its direct inputs along with their propagated inputs, recursively." (transitive-inputs (package-direct-inputs package))) (define (package-transitive-target-inputs package) "Return the transitive target inputs of PACKAGE---i.e., its direct inputs along with their propagated inputs, recursively. This only includes inputs for the target system, and not native inputs." (transitive-inputs (append (package-inputs package) (package-propagated-inputs package)))) (define (package-transitive-native-inputs package) "Return the transitive native inputs of PACKAGE---i.e., its direct inputs along with their propagated inputs, recursively. This only includes inputs for the host system (\"native inputs\"), and not target inputs." (transitive-inputs (package-native-inputs package))) (define (package-transitive-propagated-inputs package) "Return the propagated inputs of PACKAGE, and their propagated inputs, recursively." (transitive-inputs (package-propagated-inputs package))) (define (package-transitive-native-search-paths package) "Return the list of search paths for PACKAGE and its propagated inputs, recursively." (append (package-native-search-paths package) (append-map (match-lambda ((label (? package? p) _ ...) (package-native-search-paths p)) (_ '())) (package-transitive-propagated-inputs package)))) (define (transitive-input-references alist inputs) "Return a list of (assoc-ref ALIST