1 ;;; GNU Guix --- Functional package management for GNU
2 ;;; Copyright © 2014, 2015, 2016, 2017, 2018, 2019, 2020 Ludovic Courtès <ludo@gnu.org>
4 ;;; This file is part of GNU Guix.
6 ;;; GNU Guix is free software; you can redistribute it and/or modify it
7 ;;; under the terms of the GNU General Public License as published by
8 ;;; the Free Software Foundation; either version 3 of the License, or (at
9 ;;; your option) any later version.
11 ;;; GNU Guix is distributed in the hope that it will be useful, but
12 ;;; WITHOUT ANY WARRANTY; without even the implied warranty of
13 ;;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 ;;; GNU General Public License for more details.
16 ;;; You should have received a copy of the GNU General Public License
17 ;;; along with GNU Guix. If not, see <http://www.gnu.org/licenses/>.
19 (define-module (guix grafts)
20 #:use-module (guix store)
21 #:use-module (guix monads)
22 #:use-module (guix records)
23 #:use-module (guix derivations)
24 #:use-module ((guix utils) #:select (%current-system))
25 #:use-module (guix sets)
26 #:use-module (srfi srfi-1)
27 #:use-module (srfi srfi-9 gnu)
28 #:use-module (srfi srfi-26)
29 #:use-module (srfi srfi-34)
30 #:use-module (ice-9 match)
31 #:use-module (ice-9 vlist)
37 graft-replacement-output
40 graft-derivation/shallow
46 (define-record-type* <graft> graft make-graft
48 (origin graft-origin) ;derivation | store item
49 (origin-output graft-origin-output ;string | #f
51 (replacement graft-replacement) ;derivation | store item
52 (replacement-output graft-replacement-output ;string | #f
55 (define (write-graft graft port)
56 "Write a concise representation of GRAFT to PORT."
57 (define (->string thing output)
58 (if (derivation? thing)
59 (derivation->output-path thing output)
63 (($ <graft> origin origin-output replacement replacement-output)
64 (format port "#<graft ~a ==> ~a ~a>"
65 (->string origin origin-output)
66 (->string replacement replacement-output)
67 (number->string (object-address graft) 16)))))
69 (set-record-type-printer! <graft> write-graft)
71 (define (graft-origin-file-name graft)
72 "Return the output file name of the origin of GRAFT."
74 (($ <graft> (? derivation? origin) output)
75 (derivation->output-path origin output))
76 (($ <graft> (? string? item))
79 (define* (graft-derivation/shallow store drv grafts
81 (name (derivation-name drv))
82 (outputs (derivation-output-names drv))
83 (guile (%guile-for-build))
84 (system (%current-system)))
85 "Return a derivation called NAME, which applies GRAFTS to the specified
86 OUTPUTS of DRV. This procedure performs \"shallow\" grafting in that GRAFTS
87 are not recursively applied to dependencies of DRV."
88 ;; XXX: Someday rewrite using gexps.
90 ;; List of store item pairs.
92 (($ <graft> source source-output target target-output)
93 (cons (if (derivation? source)
94 (derivation->output-path source source-output)
96 (if (derivation? target)
97 (derivation->output-path target target-output)
102 (map (lambda (output)
104 (derivation-output-path
105 (assoc-ref (derivation-outputs drv) output))))
110 (use-modules (guix build graft)
114 (let* ((old-outputs ',output-pairs)
115 (mapping (append ',mapping
118 (cons (assoc-ref old-outputs name)
121 (graft old-outputs %outputs mapping))))
128 (graft (count . ,(length grafts)))))
131 ((($ <graft> sources source-outputs targets target-outputs) ...)
132 (let ((sources (zip sources source-outputs))
133 (targets (zip targets target-outputs)))
134 (build-expression->derivation store name build
136 #:guile-for-build guile
137 #:modules '((guix build graft)
139 (guix build debug-link)
141 #:inputs `(,@(map (lambda (out)
144 ,@(append (map add-label sources)
145 (map add-label targets)))
148 ;; Grafts are computationally cheap so no
149 ;; need to offload or substitute.
153 #:properties properties)))))
155 (define (non-self-references store drv outputs)
156 "Return the list of references of the OUTPUTS of DRV, excluding self
158 (define (references* items)
159 ;; Return the references of ITEMS.
160 (guard (c ((store-protocol-error? c)
161 ;; ITEMS are not in store so build INPUT first.
162 (and (build-derivations store (list drv))
163 (append-map (cut references/cached store <>) items))))
164 (append-map (cut references/cached store <>) items)))
166 (let ((refs (references* (map (cut derivation->output-path drv <>)
168 (self (match (derivation->output-paths drv)
169 (((names . items) ...)
171 (remove (cut member <> self) refs)))
173 (define-syntax-rule (with-cache key exp ...)
174 "Cache the value of monadic expression EXP under KEY."
175 (mlet %state-monad ((cache (current-state)))
176 (match (vhash-assoc key cache)
177 ((_ . result) ;cache hit
180 (mlet %state-monad ((result (begin exp ...))
181 (cache (current-state)))
183 (set-current-state (vhash-cons key result cache))
184 (return result)))))))
186 (define (reference-origin drv item)
187 "Return the derivation/output pair among the inputs of DRV, recursively,
188 that produces ITEM. Return #f if ITEM is not produced by a derivation (i.e.,
189 it's a content-addressed \"source\"), or if it's not produced by a dependency
191 ;; Perform a breadth-first traversal of the dependency graph of DRV in
192 ;; search of the derivation that produces ITEM.
193 (let loop ((drv (list drv))
199 (if (set-contains? visited drv)
201 (let ((inputs (derivation-inputs drv)))
202 (or (any (lambda (input)
203 (let ((drv (derivation-input-derivation input)))
206 (and (string=? file item)
208 (derivation->output-paths drv))))
210 (loop (append rest (map derivation-input-derivation inputs))
211 (set-insert drv visited)))))))))
213 (define* (cumulative-grafts store drv grafts
215 (outputs (derivation-output-names drv))
216 (guile (%guile-for-build))
217 (system (%current-system)))
218 "Augment GRAFTS with additional grafts resulting from the application of
219 GRAFTS to the dependencies of DRV. Return the resulting list of grafts.
221 This is a monadic procedure in %STATE-MONAD where the state is a vhash mapping
222 derivations to the corresponding set of grafts."
223 (define (graft-origin? drv graft)
224 ;; Return true if DRV corresponds to the origin of GRAFT.
226 (($ <graft> (? derivation? origin) output)
227 (match (assoc-ref (derivation->output-paths drv) output)
230 (derivation->output-path origin output)))
236 (define (dependency-grafts item)
237 (match (reference-origin drv item)
239 ;; If GRAFTS already contains a graft from DRV, do not override it.
240 (if (find (cut graft-origin? drv <>) grafts)
241 (state-return grafts)
242 (cumulative-grafts store drv grafts
243 #:outputs (list output)
247 (state-return grafts))))
249 (with-cache (cons (derivation-file-name drv) outputs)
250 (match (non-self-references store drv outputs)
253 (deps ;one or more dependencies
254 (mlet %state-monad ((grafts (mapm %state-monad dependency-grafts deps)))
255 (let ((grafts (delete-duplicates (concatenate grafts) equal?)))
256 (match (filter (lambda (graft)
257 (member (graft-origin-file-name graft) deps))
262 ;; Use APPLICABLE, the subset of GRAFTS that is really
263 ;; applicable to DRV, to avoid creating several identical
264 ;; grafted variants of DRV.
265 (let* ((new (graft-derivation/shallow store drv applicable
269 (grafts (append (map (lambda (output)
272 (origin-output output)
274 (replacement-output output)))
277 (return grafts))))))))))
279 (define* (graft-derivation store drv grafts
281 (guile (%guile-for-build))
282 (outputs (derivation-output-names drv))
283 (system (%current-system)))
284 "Apply GRAFTS to the OUTPUTS of DRV and all their dependencies, recursively.
285 That is, if GRAFTS apply only indirectly to DRV, graft the dependencies of
286 DRV, and graft DRV itself to refer to those grafted dependencies."
287 (match (run-with-state
288 (cumulative-grafts store drv grafts
290 #:guile guile #:system system)
291 vlist-null) ;the initial cache
293 ;; If FIRST is not a graft for DRV, it means that GRAFTS are not
294 ;; applicable to DRV and nothing needs to be done.
295 (if (equal? drv (graft-origin first))
296 (graft-replacement first)
300 ;; The following might feel more at home in (guix packages) but since (guix
301 ;; gexp), which is a lower level, needs them, we put them here.
304 ;; Whether to honor package grafts by default.
307 (define (set-grafting enable?)
308 "This monadic procedure enables grafting when ENABLE? is true, and disables
309 it otherwise. It returns the previous setting."
311 (values (%graft? enable?) store)))
314 "Return a Boolean indicating whether grafting is enabled."
316 (values (%graft?) store)))
319 ;; eval: (put 'with-cache 'scheme-indent-function 1)
322 ;;; grafts.scm ends here