1 ;;; GNU Guix --- Functional package management for GNU
2 ;;; Copyright © 2012, 2013, 2014, 2015, 2016, 2017, 2018, 2019, 2020 Ludovic Courtès <ludo@gnu.org>
3 ;;; Copyright © 2016, 2017 Mathieu Lirzin <mthl@gnu.org>
5 ;;; This file is part of GNU Guix.
7 ;;; GNU Guix is free software; you can redistribute it and/or modify it
8 ;;; under the terms of the GNU General Public License as published by
9 ;;; the Free Software Foundation; either version 3 of the License, or (at
10 ;;; your option) any later version.
12 ;;; GNU Guix is distributed in the hope that it will be useful, but
13 ;;; WITHOUT ANY WARRANTY; without even the implied warranty of
14 ;;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 ;;; GNU General Public License for more details.
17 ;;; You should have received a copy of the GNU General Public License
18 ;;; along with GNU Guix. If not, see <http://www.gnu.org/licenses/>.
20 (define-module (guix derivations)
21 #:use-module (srfi srfi-1)
22 #:use-module (srfi srfi-9)
23 #:use-module (srfi srfi-9 gnu)
24 #:use-module (srfi srfi-11)
25 #:use-module (srfi srfi-26)
26 #:use-module (srfi srfi-34)
27 #:use-module (srfi srfi-35)
28 #:use-module (ice-9 binary-ports)
29 #:use-module (rnrs bytevectors)
30 #:use-module (ice-9 match)
31 #:use-module (ice-9 rdelim)
32 #:use-module (ice-9 vlist)
33 #:use-module (guix store)
34 #:use-module (guix utils)
35 #:use-module (guix base16)
36 #:use-module (guix memoization)
37 #:use-module (guix combinators)
38 #:use-module (guix deprecation)
39 #:use-module (guix diagnostics)
40 #:use-module (guix i18n)
41 #:use-module (guix monads)
42 #:use-module (gcrypt hash)
43 #:use-module (guix base32)
44 #:use-module (guix records)
45 #:use-module (guix sets)
46 #:export (<derivation>
53 derivation-builder-arguments
54 derivation-builder-environment-vars
56 derivation-prerequisites
58 derivation-prerequisites-to-build ;deprecated
62 derivation-output-path
63 derivation-output-hash-algo
64 derivation-output-hash
65 derivation-output-recursive?
71 derivation-input-derivation
72 derivation-input-sub-derivations
73 derivation-input-output-paths
74 derivation-input-output-path
75 valid-derivation-input?
79 derivation-error-derivation
80 &derivation-missing-output-error
81 derivation-missing-output-error?
82 derivation-missing-output
85 derivation-output-names
86 fixed-output-derivation?
87 offloadable-derivation?
88 substitutable-derivation?
95 read-derivation-from-file
97 derivation->output-path
98 derivation->output-paths
99 derivation-path->output-path
100 derivation-path->output-paths
103 invalidate-derivation-caches!
111 file-search-error-file-name
112 file-search-error-search-path
115 module->source-file-name
116 build-expression->derivation)
118 ;; Re-export it from here for backward compatibility.
119 #:re-export (%guile-for-build))
122 ;;; Error conditions.
125 (define-condition-type &derivation-error &store-error
127 (derivation derivation-error-derivation))
129 (define-condition-type &derivation-missing-output-error &derivation-error
130 derivation-missing-output-error?
131 (output derivation-missing-output))
134 ;;; Nix derivations, as implemented in Nix's `derivations.cc'.
137 (define-immutable-record-type <derivation>
138 (make-derivation outputs inputs sources system builder args env-vars
141 (outputs derivation-outputs) ; list of name/<derivation-output> pairs
142 (inputs derivation-inputs) ; list of <derivation-input>
143 (sources derivation-sources) ; list of store paths
144 (system derivation-system) ; string
145 (builder derivation-builder) ; store path
146 (args derivation-builder-arguments) ; list of strings
147 (env-vars derivation-builder-environment-vars) ; list of name/value pairs
148 (file-name derivation-file-name)) ; the .drv file name
150 (define-immutable-record-type <derivation-output>
151 (make-derivation-output path hash-algo hash recursive?)
153 (path derivation-output-path) ; store path
154 (hash-algo derivation-output-hash-algo) ; symbol | #f
155 (hash derivation-output-hash) ; bytevector | #f
156 (recursive? derivation-output-recursive?)) ; Boolean
158 (define-immutable-record-type <derivation-input>
159 (make-derivation-input drv sub-derivations)
161 (drv derivation-input-derivation) ; <derivation>
162 (sub-derivations derivation-input-sub-derivations)) ; list of strings
165 (define (derivation-input-path input)
166 "Return the file name of the derivation INPUT refers to."
167 (derivation-file-name (derivation-input-derivation input)))
169 (define* (derivation-input drv #:optional
170 (outputs (derivation-output-names drv)))
171 "Return a <derivation-input> for the OUTPUTS of DRV."
172 ;; This is a public interface meant to be more convenient than
173 ;; 'make-derivation-input' and giving us more control.
174 (make-derivation-input drv outputs))
176 (define (derivation-input-key input)
177 "Return an object for which 'equal?' and 'hash' are constant-time, and which
178 can thus be used as a key for INPUT in lookup tables."
179 (cons (derivation-input-path input)
180 (derivation-input-sub-derivations input)))
182 (set-record-type-printer! <derivation>
184 (format port "#<derivation ~a => ~a ~a>"
185 (derivation-file-name drv)
189 (derivation-output-path output)))
190 (derivation-outputs drv)))
191 (number->string (object-address drv) 16))))
193 (define (derivation-name drv)
194 "Return the base name of DRV."
195 (let ((base (store-path-package-name (derivation-file-name drv))))
196 (string-drop-right base 4)))
198 (define (derivation-output-names drv)
199 "Return the names of the outputs of DRV."
200 (match (derivation-outputs drv)
204 (define (fixed-output-derivation? drv)
205 "Return #t if DRV is a fixed-output derivation, such as the result of a
206 download with a fixed hash (aka. `fetchurl')."
209 (("out" . ($ <derivation-output> _ (? symbol?) (? bytevector?)))))
213 (define (derivation-input<? input1 input2)
214 "Compare INPUT1 and INPUT2, two <derivation-input>."
215 (string<? (derivation-input-path input1)
216 (derivation-input-path input2)))
218 (define (derivation-input-output-paths input)
219 "Return the list of output paths corresponding to INPUT, a
222 (($ <derivation-input> drv sub-drvs)
223 (map (cut derivation->output-path drv <>)
226 (define (derivation-input-output-path input)
227 "Return the output file name of INPUT. If INPUT has more than one outputs,
230 (($ <derivation-input> drv (output))
231 (derivation->output-path drv output))))
233 (define (valid-derivation-input? store input)
234 "Return true if INPUT is valid--i.e., if all the outputs it requests are in
236 (every (cut valid-path? store <>)
237 (derivation-input-output-paths input)))
239 (define (coalesce-duplicate-inputs inputs)
240 "Return a list of inputs, such that when INPUTS contains the same DRV twice,
241 they are coalesced, with their sub-derivations merged. This is needed because
242 Nix itself keeps only one of them."
243 (define (find pred lst) ;inlinable copy of 'find'
244 (let loop ((lst lst))
248 (if (pred head) head (loop tail))))))
250 (fold (lambda (input result)
252 (($ <derivation-input> (= derivation-file-name path) sub-drvs)
254 (match (find (match-lambda
255 (($ <derivation-input> (= derivation-file-name p)
261 ((and dup ($ <derivation-input> drv sub-drvs2))
262 ;; Merge DUP with INPUT.
263 (let ((sub-drvs (delete-duplicates
264 (append sub-drvs sub-drvs2))))
265 (cons (make-derivation-input drv (sort sub-drvs string<?))
266 (delq dup result))))))))
270 (define* (derivation-prerequisites drv #:optional (cut? (const #f)))
271 "Return the list of derivation-inputs required to build DRV, recursively.
273 CUT? is a predicate that is passed a derivation-input and returns true to
274 eliminate the given input and its dependencies from the search. An example of
275 such a predicate is 'valid-derivation-input?'; when it is used as CUT?, the
276 result is the set of prerequisites of DRV not already in valid."
280 (let ((inputs (remove (lambda (input)
281 (or (set-contains? input-set
282 (derivation-input-key input))
284 (derivation-inputs drv))))
286 (append inputs result)
287 (fold set-insert input-set
288 (map derivation-input-key inputs))
289 (map derivation-input-derivation inputs)))))
291 (define (offloadable-derivation? drv)
292 "Return true if DRV can be offloaded, false otherwise."
293 (match (assoc "preferLocalBuild"
294 (derivation-builder-environment-vars drv))
295 (("preferLocalBuild" . "1") #f)
298 (define (substitutable-derivation? drv)
299 "Return #t if DRV can be substituted."
300 (match (assoc "allowSubstitutes"
301 (derivation-builder-environment-vars drv))
302 (("allowSubstitutes" . value)
303 (string=? value "1"))
306 (define (derivation-output-paths drv sub-drvs)
307 "Return the output paths of outputs SUB-DRVS of DRV."
309 (($ <derivation> outputs)
310 (map (lambda (sub-drv)
311 (derivation-output-path (assoc-ref outputs sub-drv)))
314 (define* (derivation-input-fold proc seed inputs
315 #:key (cut? (const #f)))
316 "Perform a breadth-first traversal of INPUTS, calling PROC on each input
317 with the current result, starting from SEED. Skip recursion on inputs that
319 (let loop ((inputs inputs)
326 (let ((key (derivation-input-key input)))
327 (cond ((set-contains? visited key)
328 (loop rest result visited))
330 (loop rest result (set-insert key visited)))
332 (let ((drv (derivation-input-derivation input)))
333 (loop (append (derivation-inputs drv) rest)
335 (set-insert key visited))))))))))
337 (define* (substitution-oracle store inputs-or-drv
338 #:key (mode (build-mode normal)))
339 "Return a one-argument procedure that, when passed a store file name,
340 returns a 'substitutable?' if it's substitutable and #f otherwise.
342 The returned procedure knows about all substitutes for all the derivation
343 inputs or derivations listed in INPUTS-OR-DRV, *except* those that are already
344 valid (that is, it won't bother checking whether an item is substitutable if
345 it's already on disk); it also knows about their prerequisites, unless they
346 are themselves substitutable.
348 Creating a single oracle (thus making a single 'substitutable-path-info' call) and
349 reusing it is much more efficient than calling 'has-substitutes?' or similar
350 repeatedly, because it avoids the costs associated with launching the
351 substituter many times."
353 (cut valid-derivation-input? store <>))
355 (define (closure inputs)
357 (derivation-input-fold (lambda (input closure)
358 (let ((drv (derivation-input-derivation input)))
359 (if (substitutable-derivation? drv)
364 #:cut? valid-input?)))
366 (let* ((inputs (closure (map (match-lambda
367 ((? derivation-input? input)
370 (derivation-input drv)))
372 (items (append-map derivation-input-output-paths inputs))
373 (subst (fold (lambda (subst vhash)
374 (vhash-cons (substitutable-path subst) subst
377 (substitutable-path-info store items))))
379 (match (vhash-assoc item subst)
381 ((key . value) value)))))
383 (define (dependencies-of-substitutables substitutables inputs)
384 "Return the subset of INPUTS whose output file names is among the references
386 (let ((items (fold set-insert (set)
387 (append-map substitutable-references substitutables))))
388 (filter (lambda (input)
389 (any (cut set-contains? items <>)
390 (derivation-input-output-paths input)))
393 (define* (derivation-build-plan store inputs
395 (mode (build-mode normal))
398 store inputs #:mode mode)))
399 "Given INPUTS, a list of derivation-inputs, return two values: the list of
400 derivations to build, and the list of substitutable items that, together,
401 allow INPUTS to be realized.
403 SUBSTITUTABLE-INFO must be a one-argument procedure similar to that returned
404 by 'substitution-oracle'."
405 (define (built? item)
406 (valid-path? store item))
408 (define (input-built? input)
409 ;; In 'check' mode, assume that DRV is not built.
410 (and (not (and (eqv? mode (build-mode check))
411 (member input inputs)))
412 (every built? (derivation-input-output-paths input))))
414 (define (input-substitutable-info input)
415 (and (substitutable-derivation? (derivation-input-derivation input))
416 (let* ((items (derivation-input-output-paths input))
417 (info (filter-map substitutable-info items)))
418 (and (= (length info) (length items))
421 (let loop ((inputs inputs) ;list of <derivation-input>
422 (build '()) ;list of <derivation>
423 (substitute '()) ;list of <substitutable>
424 (visited (set))) ;set of <derivation-input>
427 (values build substitute))
429 (let ((key (derivation-input-key input))
430 (deps (derivation-inputs
431 (derivation-input-derivation input))))
432 (cond ((set-contains? visited key)
433 (loop rest build substitute visited))
434 ((input-built? input)
435 (loop rest build substitute
436 (set-insert key visited)))
437 ((input-substitutable-info input)
439 (lambda (substitutables)
440 (loop (append (dependencies-of-substitutables substitutables
444 (append substitutables substitute)
445 (set-insert key visited))))
447 (loop (append deps rest)
448 (cons (derivation-input-derivation input) build)
450 (set-insert key visited)))))))))
452 (define-deprecated (derivation-prerequisites-to-build store drv #:rest rest)
453 derivation-build-plan
454 (let-values (((build download)
455 (apply derivation-build-plan store
456 (list (derivation-input drv)) rest)))
457 (values (map derivation-input build) download)))
459 (define* (read-derivation drv-port
460 #:optional (read-derivation-from-file
461 read-derivation-from-file))
462 "Read the derivation from DRV-PORT and return the corresponding <derivation>
463 object. Call READ-DERIVATION-FROM-FILE to read derivations declared as inputs
464 of the derivation being parsed.
466 Most of the time you'll want to use 'read-derivation-from-file', which caches
467 things as appropriate and is thus more efficient."
469 (define comma (string->symbol ","))
471 (define (ununquote x)
473 (('unquote x) (ununquote x))
474 ((x ...) (map ununquote x))
477 (define (outputs->alist x)
478 (fold-right (lambda (output result)
482 (make-derivation-output path #f #f #f)
484 ((name path hash-algo hash)
486 (let* ((rec? (string-prefix? "r:" hash-algo))
487 (algo (string->symbol
489 (string-drop hash-algo 2)
491 (hash (base16-string->bytevector hash)))
493 (make-derivation-output path algo
499 (define (make-input-drvs x)
500 (fold-right (lambda (input result)
502 ((path (sub-drvs ...))
503 (let ((drv (read-derivation-from-file path)))
504 (cons (make-derivation-input drv sub-drvs)
509 ;; The contents of a derivation are typically ASCII, but choosing
510 ;; UTF-8 allows us to take the fast path for Guile's `scm_getc'.
511 (set-port-encoding! drv-port "UTF-8")
513 (let loop ((exp (read drv-port))
517 (let ((result (reverse result)))
519 (('Derive ((outputs ...) (input-drvs ...)
523 ((? string? args) ...)
525 (make-derivation (outputs->alist outputs)
526 (make-input-drvs input-drvs)
529 (fold-right alist-cons '() var value)
530 (port-filename drv-port)))
532 (error "failed to parse derivation" drv-port result)))))
533 ((? (cut eq? <> comma))
534 (loop (read drv-port) result))
536 (loop (read drv-port)
537 (cons (ununquote exp) result))))))
539 (define %derivation-cache
540 ;; Maps derivation file names to <derivation> objects.
541 ;; XXX: This is redundant with 'atts-cache' in the store.
542 (make-weak-value-hash-table 200))
544 (define (read-derivation-from-file file)
545 "Read the derivation in FILE, a '.drv' file, and return the corresponding
546 <derivation> object."
547 ;; Memoize that operation because 'read-derivation' is quite expensive,
548 ;; and because the same argument is read more than 15 times on average
549 ;; during something like (package-derivation s gdb).
550 (or (and file (hash-ref %derivation-cache file))
551 (let ((drv (call-with-input-file file read-derivation)))
552 (hash-set! %derivation-cache file drv)
555 (define-inlinable (write-sequence lst write-item port)
556 ;; Write each element of LST with WRITE-ITEM to PORT, separating them with a
561 ((prefix (... ...) last)
562 (for-each (lambda (item)
563 (write-item item port)
566 (write-item last port))))
568 (define-inlinable (write-list lst write-item port)
569 ;; Write LST as a derivation list to PORT, using WRITE-ITEM to write each
572 (write-sequence lst write-item port)
575 (define-inlinable (write-tuple lst write-item port)
576 ;; Same, but write LST as a tuple.
578 (write-sequence lst write-item port)
581 (define (write-derivation drv port)
582 "Write the ATerm-like serialization of DRV to PORT. See Section 2.4 of
583 Eelco Dolstra's PhD dissertation for an overview of a previous version of
586 ;; Make sure we're using the faster implementation.
587 (define format simple-format)
589 (define (write-string-list lst)
590 (write-list lst write port))
592 (define (write-output output port)
594 ((name . ($ <derivation-output> path hash-algo hash recursive?))
595 (write-tuple (list name path
597 (string-append (if recursive? "r:" "")
598 (symbol->string hash-algo))
600 (or (and=> hash bytevector->base16-string)
605 (define (write-input input port)
607 (($ <derivation-input> obj sub-drvs)
610 ;; 'derivation/masked-inputs' produces objects that contain a string
611 ;; instead of a <derivation>, so we need to account for that.
612 (display (if (derivation? obj)
613 (derivation-file-name obj)
617 (write-string-list sub-drvs)
618 (display ")" port))))
620 (define (write-env-var env-var port)
627 (display ")" port))))
629 ;; Assume all the lists we are writing are already sorted.
631 (($ <derivation> outputs inputs sources
632 system builder args env-vars)
633 (display "Derive(" port)
634 (write-list outputs write-output port)
636 (write-list inputs write-input port)
638 (write-string-list sources)
639 (simple-format port ",\"~a\",\"~a\"," system builder)
640 (write-string-list args)
642 (write-list env-vars write-env-var port)
643 (display ")" port))))
645 (define derivation->bytevector
647 "Return the external representation of DRV as a UTF-8-encoded string."
648 (with-fluids ((%default-port-encoding "UTF-8"))
649 (call-with-values open-bytevector-output-port
650 (lambda (port get-bytevector)
651 (write-derivation drv port)
652 (get-bytevector))))))
654 (define* (derivation->output-path drv #:optional (output "out"))
655 "Return the store path of its output OUTPUT. Raise a
656 '&derivation-missing-output-error' condition if OUTPUT is not an output of
658 (let ((output* (assoc-ref (derivation-outputs drv) output)))
660 (derivation-output-path output*)
661 (raise (condition (&derivation-missing-output-error
663 (output output)))))))
665 (define (derivation->output-paths drv)
666 "Return the list of name/path pairs of the outputs of DRV."
669 (cons name (derivation-output-path output))))
670 (derivation-outputs drv)))
672 (define derivation-path->output-path
673 ;; This procedure is called frequently, so memoize it.
674 (let ((memoized (mlambda (path output)
675 (derivation->output-path (read-derivation-from-file path)
677 (lambda* (path #:optional (output "out"))
678 "Read the derivation from PATH (`/gnu/store/xxx.drv'), and return the store
679 path of its output OUTPUT."
680 (memoized path output))))
682 (define (derivation-path->output-paths path)
683 "Read the derivation from PATH (`/gnu/store/xxx.drv'), and return the
684 list of name/path pairs of its outputs."
685 (derivation->output-paths (read-derivation-from-file path)))
689 ;;; Derivation primitive.
692 (define derivation-base16-hash
694 "Return a string containing the base16 representation of the hash of DRV."
695 (bytevector->base16-string (derivation-hash drv))))
697 (define (derivation/masked-inputs drv)
698 "Assuming DRV is a regular derivation (not fixed-output), replace the file
699 name of each input with that input's hash."
701 (($ <derivation> outputs inputs sources
702 system builder args env-vars)
703 (let ((inputs (map (match-lambda
704 (($ <derivation-input> drv sub-drvs)
705 (let ((hash (derivation-base16-hash drv)))
706 (make-derivation-input hash sub-drvs))))
708 (make-derivation outputs
709 (sort (delete-duplicates inputs)
711 (string<? (derivation-input-derivation drv1)
712 (derivation-input-derivation drv2))))
714 system builder args env-vars
717 (define derivation-hash ; `hashDerivationModulo' in derivations.cc
719 "Return the hash of DRV, modulo its fixed-output inputs, as a bytevector."
721 (($ <derivation> ((_ . ($ <derivation-output> path
722 (? symbol? hash-algo) (? bytevector? hash)
723 (? boolean? recursive?)))))
724 ;; A fixed-output derivation.
727 (string-append "fixed:out:"
728 (if recursive? "r:" "")
729 (symbol->string hash-algo)
730 ":" (bytevector->base16-string hash)
734 ;; XXX: At this point this remains faster than `port-sha256', because
735 ;; the SHA256 port's `write' method gets called for every single
737 (sha256 (derivation->bytevector (derivation/masked-inputs drv)))))))
740 (define (warn-about-derivation-deprecation name)
741 ;; TRANSLATORS: 'derivation' must not be translated; it refers to the
742 ;; 'derivation' procedure.
743 (warning (G_ "in '~a': deprecated 'derivation' calling convention used~%")
746 (define* (derivation store name builder args
748 (system (%current-system)) (env-vars '())
749 (inputs '()) (sources '())
751 hash hash-algo recursive?
753 allowed-references disallowed-references
754 leaked-env-vars local-build?
757 (%deprecation-warning? #t))
758 "Build a derivation with the given arguments, and return the resulting
759 <derivation> object. When HASH and HASH-ALGO are given, a
760 fixed-output derivation is created---i.e., one whose result is known in
761 advance, such as a file download. If, in addition, RECURSIVE? is true, then
762 that fixed output may be an executable file or a directory and HASH must be
763 the hash of an archive containing this output.
765 When REFERENCES-GRAPHS is true, it must be a list of file name/store path
766 pairs. In that case, the reference graph of each store path is exported in
767 the build environment in the corresponding file, in a simple text format.
769 When ALLOWED-REFERENCES is true, it must be a list of store items or outputs
770 that the derivation's outputs may refer to. Likewise, DISALLOWED-REFERENCES,
771 if true, must be a list of things the outputs may not refer to.
773 When LEAKED-ENV-VARS is true, it must be a list of strings denoting
774 environment variables that are allowed to \"leak\" from the daemon's
775 environment to the build environment. This is only applicable to fixed-output
776 derivations--i.e., when HASH is true. The main use is to allow variables such
777 as \"http_proxy\" to be passed to derivations that download files.
779 When LOCAL-BUILD? is true, declare that the derivation is not a good candidate
780 for offloading and should rather be built locally. This is the case for small
781 derivations where the costs of data transfers would outweigh the benefits.
783 When SUBSTITUTABLE? is false, declare that substitutes of the derivation's
784 output should not be used.
786 PROPERTIES must be an association list describing \"properties\" of the
787 derivation. It is kept as-is, uninterpreted, in the derivation."
788 (define (add-output-paths drv)
789 ;; Return DRV with an actual store path for each of its output and the
790 ;; corresponding environment variable.
792 (($ <derivation> outputs inputs sources
793 system builder args env-vars)
794 (let* ((drv-hash (derivation-hash drv))
795 (outputs (map (match-lambda
796 ((output-name . ($ <derivation-output>
800 (fixed-output-path name hash
804 (output-path output-name
807 (make-derivation-output path algo
810 (make-derivation outputs inputs sources system builder args
814 (or (and=> (assoc-ref outputs name)
815 derivation-output-path)
820 (define (user+system-env-vars)
821 ;; Some options are passed to the build daemon via the env. vars of
822 ;; derivations (urgh!). We hide that from our API, but here is the place
823 ;; where we kludgify those options.
824 (let ((env-vars `(,@(if local-build?
825 `(("preferLocalBuild" . "1"))
827 ,@(if (not substitutable?)
828 `(("allowSubstitutes" . "0"))
830 ,@(if allowed-references
831 `(("allowedReferences"
832 . ,(string-join allowed-references)))
834 ,@(if disallowed-references
835 `(("disallowedReferences"
836 . ,(string-join disallowed-references)))
838 ,@(if leaked-env-vars
840 . ,(string-join leaked-env-vars)))
844 (lst `(("guix properties"
845 . ,(object->string properties)))))
847 (match references-graphs
849 (let ((value (map (cut string-append <> " " <>)
851 ;; XXX: This all breaks down if an element of FILE or PATH contains
853 `(("exportReferencesGraph" . ,(string-join value " "))
858 (define (env-vars-with-empty-outputs env-vars)
859 ;; Return a variant of ENV-VARS where each OUTPUTS is associated with an
860 ;; empty string, even outputs that do not appear in ENV-VARS.
861 (let ((e (map (match-lambda
863 (if (member name outputs)
867 (fold (lambda (output-name env-vars)
868 (if (assoc output-name env-vars)
870 (append env-vars `((,output-name . "")))))
874 (define-syntax-rule (warn-deprecation name)
875 (when %deprecation-warning?
876 (warn-about-derivation-deprecation name)))
878 (define input->derivation-input
880 ((? derivation-input? input)
882 (((? derivation? drv))
883 (warn-deprecation name)
884 (make-derivation-input drv '("out")))
885 (((? derivation? drv) sub-drvs ...)
886 (warn-deprecation name)
887 (make-derivation-input drv sub-drvs))
889 (warn-deprecation name)
892 (define input->source
894 (((? string? input) . _)
895 (warn-deprecation name)
896 (if (direct-store-path? input)
898 (add-to-store store (basename input)
902 ;; Note: lists are sorted alphabetically, to conform with the behavior of
903 ;; C++ `std::map' in Nix itself.
905 (let* ((outputs (map (lambda (name)
906 ;; Return outputs with an empty path.
908 (make-derivation-output "" hash-algo
910 (sort outputs string<?)))
911 (sources (sort (delete-duplicates
912 (append (filter-map input->source inputs)
915 (inputs (sort (coalesce-duplicate-inputs
916 (filter-map input->derivation-input inputs))
918 (env-vars (sort (env-vars-with-empty-outputs
919 (user+system-env-vars))
921 (string<? (car e1) (car e2)))))
922 (drv-masked (make-derivation outputs inputs sources
923 system builder args env-vars #f))
924 (drv (add-output-paths drv-masked)))
926 (let* ((file (add-data-to-store store (string-append name ".drv")
927 (derivation->bytevector drv)
928 (append (map derivation-input-path inputs)
930 (drv* (set-field drv (derivation-file-name) file)))
931 ;; Preserve pointer equality. This improves the performance of
932 ;; 'eq?'-memoization on derivations.
933 (or (hash-ref %derivation-cache file)
935 (hash-set! %derivation-cache file drv*)
938 (define (invalidate-derivation-caches!)
939 "Invalidate internal derivation caches. This is mostly useful for
940 long-running processes that know what they're doing. Use with care!"
941 ;; Typically this is meant to be used by Cuirass and Hydra, which can clear
942 ;; caches when they start evaluating packages for another architecture.
943 (invalidate-memoization! derivation-base16-hash)
945 ;; FIXME: Comment out to work around <https://bugs.gnu.org/36487>.
946 ;; (hash-clear! %derivation-cache)
949 (define derivation-properties
951 "Return the property alist associated with DRV."
952 (match (assoc "guix properties"
953 (derivation-builder-environment-vars drv))
954 ((_ . str) (call-with-input-string str read))
957 (define* (map-derivation store drv mapping
958 #:key (system (%current-system)))
959 "Given MAPPING, a list of pairs of derivations, return a derivation based on
960 DRV where all the 'car's of MAPPING have been replaced by its 'cdr's,
962 (define (substitute str initial replacements)
963 (fold (lambda (path replacement result)
964 (string-replace-substring result path
967 initial replacements))
969 (define (substitute-file file initial replacements)
971 (with-fluids ((%default-port-encoding #f))
972 (call-with-input-file file read-string)))
974 (let ((updated (substitute contents initial replacements)))
975 (if (string=? updated contents)
977 ;; XXX: permissions aren't preserved.
978 (add-text-to-store store (store-path-package-name file)
981 (define input->output-paths
983 ((? derivation-input? input)
984 (derivation-input-output-paths input))
988 (let ((mapping (fold (lambda (pair result)
990 (((? derivation? orig) . replacement)
991 (vhash-cons (derivation-file-name orig)
993 ((file . replacement)
994 (vhash-cons file replacement result))))
997 (define rewritten-input
998 ;; Rewrite the given input according to MAPPING, and return an input
999 ;; in the format used in 'derivation' calls.
1000 (mlambda (input loop)
1002 (($ <derivation-input> drv (sub-drvs ...))
1003 (match (vhash-assoc (derivation-file-name drv) mapping)
1004 ((_ . (? derivation? replacement))
1005 (derivation-input replacement sub-drvs))
1006 ((_ . (? string? source))
1009 (derivation-input (loop drv) sub-drvs)))))))
1011 (let loop ((drv drv))
1012 (let* ((inputs (map (cut rewritten-input <> loop)
1013 (derivation-inputs drv)))
1014 (initial (append-map derivation-input-output-paths
1015 (derivation-inputs drv)))
1016 (replacements (append-map input->output-paths inputs))
1018 ;; Sources typically refer to the output directories of the
1019 ;; original inputs, INITIAL. Rewrite them by substituting
1021 (sources (map (lambda (source)
1022 (match (vhash-assoc source mapping)
1026 (substitute-file source
1027 initial replacements))))
1028 (derivation-sources drv)))
1030 ;; Now augment the lists of initials and replacements.
1031 (initial (append (derivation-sources drv) initial))
1032 (replacements (append sources replacements))
1033 (name (store-path-package-name
1034 (string-drop-right (derivation-file-name drv)
1036 (derivation store name
1037 (substitute (derivation-builder drv)
1038 initial replacements)
1039 (map (cut substitute <> initial replacements)
1040 (derivation-builder-arguments drv))
1042 #:env-vars (map (match-lambda
1045 . ,(substitute value initial
1047 (derivation-builder-environment-vars drv))
1048 #:inputs (filter derivation-input? inputs)
1049 #:sources (append sources (filter string? inputs))
1050 #:outputs (derivation-output-names drv)
1051 #:hash (match (derivation-outputs drv)
1052 ((($ <derivation-output> _ algo hash))
1055 #:hash-algo (match (derivation-outputs drv)
1056 ((($ <derivation-output> _ algo hash))
1062 ;;; Store compatibility layer.
1065 (define* (build-derivations store derivations
1066 #:optional (mode (build-mode normal)))
1067 "Build DERIVATIONS, a list of <derivation> or <derivation-input> objects,
1068 .drv file names, or derivation/output pairs, using the specified MODE."
1069 (build-things store (map (match-lambda
1070 ((? derivation? drv)
1071 (derivation-file-name drv))
1072 ((? derivation-input? input)
1073 (cons (derivation-input-path input)
1075 (derivation-input-sub-derivations input)
1077 ((? string? file) file)
1078 (((? derivation? drv) . output)
1079 (cons (derivation-file-name drv)
1081 (((? string? file) . output)
1082 (cons file output)))
1088 ;;; Guile-based builders.
1091 (define (parent-directories file-name)
1092 "Return the list of parent dirs of FILE-NAME, in the order in which an
1093 `mkdir -p' implementation would make them."
1094 (let ((not-slash (char-set-complement (char-set #\/))))
1096 (fold (lambda (dir result)
1101 (cons (string-append prev "/" dir)
1104 (remove (cut string=? <> ".")
1105 (string-tokenize (dirname file-name) not-slash))))))
1107 (define* (imported-files store files ;deprecated
1108 #:key (name "file-import"))
1109 "Return a store item that contains FILES. FILES must be a list
1110 of (FINAL-PATH . FILE-NAME) pairs; each FILE-NAME is read from the file
1111 system, imported, and appears under FINAL-PATH in the resulting store path."
1112 (add-file-tree-to-store store
1114 ,@(file-mapping->tree files))))
1116 ;; The "file not found" error condition.
1117 (define-condition-type &file-search-error &error
1119 (file file-search-error-file-name)
1120 (path file-search-error-search-path))
1122 (define search-path*
1123 ;; A memoizing version of 'search-path' so 'imported-modules' does not end
1124 ;; up looking for the same files over and over again.
1125 (mlambda (path file)
1126 "Search for FILE in PATH and memoize the result. Raise a
1127 '&file-search-error' condition if it could not be found."
1128 (or (search-path path file)
1130 (&file-search-error (file file)
1133 (define (module->source-file-name module)
1134 "Return the file name corresponding to MODULE, a Guile module name (a list
1136 (string-append (string-join (map symbol->string module) "/")
1139 (define* (%imported-modules store modules ;deprecated
1140 #:key (name "module-import")
1141 (module-path %load-path))
1142 "Return a store item that contains the source files of MODULES, a list of
1143 module names such as `(ice-9 q)'. All of MODULES must be in the MODULE-PATH
1145 ;; TODO: Determine the closure of MODULES, build the `.go' files,
1146 ;; canonicalize the source files through read/write, etc.
1147 (let ((files (map (lambda (m)
1148 (let ((f (module->source-file-name m)))
1149 (cons f (search-path* module-path f))))
1151 (imported-files store files #:name name)))
1153 (define* (%compiled-modules store modules ;deprecated
1154 #:key (name "module-import-compiled")
1155 (system (%current-system))
1156 (guile (%guile-for-build))
1157 (module-path %load-path))
1158 "Return a derivation that builds a tree containing the `.go' files
1159 corresponding to MODULES. All the MODULES are built in a context where
1160 they can refer to each other."
1161 (let* ((module-dir (%imported-modules store modules
1162 #:module-path module-path))
1163 (files (map (lambda (m)
1164 (let ((f (string-join (map symbol->string m)
1166 (cons (string-append f ".go")
1167 (string-append module-dir "/" f ".scm"))))
1171 (use-modules (system base compile))
1172 (let ((out (assoc-ref %outputs "out")))
1177 (cons ,module-dir %load-path))
1179 ,@(map (match-lambda
1181 (let ((make-parent-dirs (map (lambda (dir)
1182 `(unless (file-exists? ,dir)
1184 (parent-directories output))))
1187 (compile-file ,input
1188 #:output-file ,output
1189 #:opts %auto-compilation-options)))))
1192 (build-expression->derivation store name builder
1193 #:inputs `(("modules" ,module-dir))
1195 #:guile-for-build guile
1196 #:local-build? #t)))
1198 (define %module-cache
1199 ;; Map a list of modules to its 'imported+compiled-modules' result.
1202 (define* (imported+compiled-modules store modules #:key
1203 (system (%current-system))
1204 (guile (%guile-for-build)))
1205 "Return a pair containing the derivation to import MODULES and that where
1206 MODULES are compiled."
1208 (list modules (derivation-file-name guile) system))
1210 (or (hash-ref %module-cache key)
1211 (let ((result (cons (%imported-modules store modules)
1212 (%compiled-modules store modules
1213 #:system system #:guile guile))))
1214 (hash-set! %module-cache key result)
1217 (define* (build-expression->derivation store name exp ;deprecated
1219 (system (%current-system))
1222 hash hash-algo recursive?
1228 disallowed-references
1229 local-build? (substitutable? #t)
1231 "Return a derivation that executes Scheme expression EXP as a builder
1232 for derivation NAME. INPUTS must be a list of (NAME DRV-PATH SUB-DRV)
1233 tuples; when SUB-DRV is omitted, \"out\" is assumed. MODULES is a list
1234 of names of Guile modules from the current search path to be copied in
1235 the store, compiled, and made available in the load path during the
1238 EXP is evaluated in an environment where %OUTPUT is bound to the main
1239 output path, %OUTPUTS is bound to a list of output/path pairs, and where
1240 %BUILD-INPUTS is bound to an alist of string/output-path pairs made from
1241 INPUTS. Optionally, ENV-VARS is a list of string pairs specifying the
1242 name and value of environment variables visible to the builder. The
1243 builder terminates by passing the result of EXP to `exit'; thus, when
1244 EXP returns #f, the build is considered to have failed.
1246 EXP is built using GUILE-FOR-BUILD (a derivation). When GUILE-FOR-BUILD is
1247 omitted or is #f, the value of the `%guile-for-build' fluid is used instead.
1249 See the `derivation' procedure for the meaning of REFERENCES-GRAPHS,
1250 ALLOWED-REFERENCES, DISALLOWED-REFERENCES, LOCAL-BUILD?, SUBSTITUTABLE?,
1253 (or guile-for-build (%guile-for-build)))
1256 (string-append (derivation->output-path guile-drv)
1259 (define module-form?
1261 (((or 'define-module 'use-modules) _ ...) #t)
1265 ;; When passed an input that is a source, return its path; otherwise
1268 ((_ (? derivation?) _ ...)
1271 (and (not (derivation-path? path))
1274 (let* ((prologue `(begin
1277 ;; Module forms must appear at the top-level so
1278 ;; that any macros they export can be expanded.
1279 (filter module-form? exp))
1282 (define %output (getenv "out"))
1285 (cons o (getenv o)))
1287 (define %build-inputs
1288 ',(map (match-lambda
1290 (let ((sub (match rest
1296 (derivation->output-path drv sub))
1297 ((derivation-path? drv)
1298 (derivation-path->output-path drv
1303 ,@(if (null? modules)
1305 ;; Remove our own settings.
1306 '((unsetenv "GUILE_LOAD_COMPILED_PATH")))
1308 ;; Guile sets it, but remove it to avoid conflicts when
1309 ;; building Guile-using packages.
1310 (unsetenv "LD_LIBRARY_PATH")))
1311 (builder (add-text-to-store store
1312 (string-append name "-guile-builder")
1314 ;; Explicitly use UTF-8 for determinism,
1315 ;; and also because UTF-8 output is faster.
1316 (with-fluids ((%default-port-encoding
1318 (call-with-output-string
1320 (write prologue port)
1325 (remove module-form? exp))
1329 ;; The references don't really matter
1330 ;; since the builder is always used in
1331 ;; conjunction with the drv that needs
1332 ;; it. For clarity, we add references
1333 ;; to the subset of INPUTS that are
1334 ;; sources, avoiding references to other
1335 ;; .drv; otherwise, BUILDER's hash would
1336 ;; depend on those, even if they are
1338 (filter-map source-path inputs)))
1340 (mod+go-drv (if (pair? modules)
1341 (imported+compiled-modules store modules
1345 (mod-dir (car mod+go-drv))
1346 (go-drv (cdr mod+go-drv))
1348 (derivation->output-path go-drv))))
1349 (derivation store name guile
1350 `("--no-auto-compile"
1351 ,@(if mod-dir `("-L" ,mod-dir) '())
1354 ;; 'build-expression->derivation' is somewhat deprecated so
1355 ;; don't bother warning here.
1356 #:%deprecation-warning? #f
1360 #:inputs `((,(or guile-for-build (%guile-for-build)))
1363 ,@(if mod-dir `((,mod-dir) (,go-drv)) '()))
1365 ;; When MODULES is non-empty, shamelessly clobber
1366 ;; $GUILE_LOAD_COMPILED_PATH.
1367 #:env-vars (if go-dir
1368 `(("GUILE_LOAD_COMPILED_PATH" . ,go-dir)
1369 ,@(alist-delete "GUILE_LOAD_COMPILED_PATH"
1373 #:hash hash #:hash-algo hash-algo
1374 #:recursive? recursive?
1376 #:references-graphs references-graphs
1377 #:allowed-references allowed-references
1378 #:disallowed-references disallowed-references
1379 #:local-build? local-build?
1380 #:substitutable? substitutable?
1381 #:properties properties)))
1385 ;;; Monadic interface.
1388 (define built-derivations
1389 (store-lift build-derivations))
1391 (define raw-derivation
1392 (store-lift derivation))