1 ;;; GNU Guix --- Functional package management for GNU
2 ;;; Copyright © 2012, 2013, 2014, 2015, 2016, 2017, 2018, 2019 Ludovic Courtès <ludo@gnu.org>
3 ;;; Copyright © 2013 Mark H Weaver <mhw@netris.org>
4 ;;; Copyright © 2014 Eric Bavier <bavier@member.fsf.org>
5 ;;; Copyright © 2016, 2017 Alex Kost <alezost@gmail.com>
6 ;;; Copyright © 2016 Mathieu Lirzin <mthl@gnu.org>
8 ;;; This file is part of GNU Guix.
10 ;;; GNU Guix is free software; you can redistribute it and/or modify it
11 ;;; under the terms of the GNU General Public License as published by
12 ;;; the Free Software Foundation; either version 3 of the License, or (at
13 ;;; your option) any later version.
15 ;;; GNU Guix is distributed in the hope that it will be useful, but
16 ;;; WITHOUT ANY WARRANTY; without even the implied warranty of
17 ;;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 ;;; GNU General Public License for more details.
20 ;;; You should have received a copy of the GNU General Public License
21 ;;; along with GNU Guix. If not, see <http://www.gnu.org/licenses/>.
23 (define-module (gnu packages)
24 #:use-module (guix packages)
25 #:use-module (guix ui)
26 #:use-module (guix utils)
27 #:use-module (guix discovery)
28 #:use-module (guix memoization)
29 #:use-module ((guix build utils)
30 #:select ((package-name->name+version
31 . hyphen-separated-name->name+version)
33 #:autoload (guix profiles) (packages->manifest)
34 #:use-module (guix describe)
35 #:use-module (guix deprecation)
36 #:use-module (ice-9 vlist)
37 #:use-module (ice-9 match)
38 #:autoload (ice-9 binary-ports) (put-bytevector)
39 #:autoload (system base compile) (compile)
40 #:use-module (srfi srfi-1)
41 #:use-module (srfi srfi-11)
42 #:use-module (srfi srfi-26)
43 #:use-module (srfi srfi-34)
44 #:use-module (srfi srfi-35)
45 #:use-module (srfi srfi-39)
46 #:export (search-patch
52 %default-package-module-path
55 fold-available-packages
57 find-newest-available-packages
59 find-package-locations
60 find-best-packages-by-name
62 specification->package
63 specification->package+output
64 specification->location
65 specifications->manifest
67 generate-package-cache))
71 ;;; General utilities for the software distribution---i.e., the modules under
72 ;;; (gnu packages ...).
76 ;; By default, we store patches and auxiliary files
77 ;; alongside Guile modules. This is so that these extra files can be
78 ;; found without requiring a special setup, such as a specific
79 ;; installation directory and an extra environment variable. One
80 ;; advantage of this setup is that everything just works in an
81 ;; auto-compilation setting.
83 (define %auxiliary-files-path
85 (map (cut string-append <> "/gnu/packages/aux-files")
88 (define (search-auxiliary-file file-name)
89 "Search the auxiliary FILE-NAME. Return #f if not found."
90 (search-path (%auxiliary-files-path) file-name))
92 (define (search-patch file-name)
93 "Search the patch FILE-NAME. Raise an error if not found."
94 (or (search-path (%patch-path) file-name)
96 (&message (message (format #f (G_ "~a: patch not found")
99 (define-syntax-rule (search-patches file-name ...)
100 "Return the list of absolute file names corresponding to each
101 FILE-NAME found in %PATCH-PATH."
102 (list (search-patch file-name) ...))
104 (define %distro-root-directory
105 ;; Absolute file name of the module hierarchy. Since (gnu packages …) might
106 ;; live in a directory different from (guix), try to get the best match.
107 (letrec-syntax ((dirname* (syntax-rules ()
110 ((_ file head tail ...)
111 (dirname (dirname* file tail ...)))))
112 (try (syntax-rules ()
113 ((_ (file things ...) rest ...)
114 (match (search-path %load-path file)
118 (dirname* absolute things ...))))
121 (try ("gnu/packages/base.scm" gnu/ packages/)
122 ("gnu/packages.scm" gnu/)
125 (define %default-package-module-path
126 ;; Default search path for package modules.
127 `((,%distro-root-directory . "gnu/packages")))
129 (define (cache-is-authoritative?)
130 "Return true if the pre-computed package cache is authoritative. It is not
131 authoritative when entries have been added via GUIX_PACKAGE_PATH or '-L'
133 (equal? (%package-module-path)
134 (append %default-package-module-path
135 (package-path-entries))))
137 (define %package-module-path
138 ;; Search path for package modules. Each item must be either a directory
139 ;; name or a pair whose car is a directory and whose cdr is a sub-directory
140 ;; to narrow the search.
141 (let*-values (((not-colon)
142 (char-set-complement (char-set #\:)))
144 (string-tokenize (or (getenv "GUIX_PACKAGE_PATH") "")
146 ((channels-scm channels-go)
147 (package-path-entries)))
148 ;; Automatically add channels and items from $GUIX_PACKAGE_PATH to Guile's
149 ;; search path. For historical reasons, $GUIX_PACKAGE_PATH goes to the
150 ;; front; channels go to the back so that they don't override Guix' own
153 (append environment %load-path channels-scm))
154 (set! %load-compiled-path
155 (append environment %load-compiled-path channels-go))
159 %default-package-module-path
163 ;; Define it after '%package-module-path' so that '%load-path' contains user
164 ;; directories, allowing patches in $GUIX_PACKAGE_PATH to be found.
166 (map (lambda (directory)
167 (if (string=? directory %distro-root-directory)
168 (string-append directory "/gnu/packages/patches")
172 ;; This procedure is used by Emacs-Guix up to 0.5.1.1, so keep it for now.
173 ;; See <https://github.com/alezost/guix.el/issues/30>.
174 (define-deprecated find-newest-available-packages
175 find-packages-by-name
177 "Return a vhash keyed by package names, and with
178 associated values of the form
180 (newest-version newest-package ...)
182 where the preferred package is listed first."
183 (fold-packages (lambda (p r)
184 (let ((name (package-name p))
185 (version (package-version p)))
186 (match (vhash-assoc name r)
187 ((_ newest-so-far . pkgs)
188 (case (version-compare version newest-so-far)
189 ((>) (vhash-cons name `(,version ,p) r))
190 ((=) (vhash-cons name `(,version ,p ,@pkgs) r))
192 (#f (vhash-cons name `(,version ,p) r)))))
195 (define (fold-available-packages proc init)
196 "Fold PROC over the list of available packages. For each available package,
197 PROC is called along these lines:
199 (PROC NAME VERSION RESULT
204 PROC can use #:allow-other-keys to ignore the bits it's not interested in.
205 When a package cache is available, this procedure does not actually load any
208 (load-package-cache (current-profile)))
210 (if (and cache (cache-is-authoritative?))
211 (vhash-fold (lambda (name vector result)
213 (#(name version module symbol outputs
214 supported? deprecated?
216 (proc name version result
219 (location file line column))
220 #:supported? supported?
221 #:deprecated? deprecated?))))
224 (fold-packages (lambda (package result)
225 (proc (package-name package)
226 (package-version package)
228 #:outputs (package-outputs package)
229 #:location (package-location package)
231 (->bool (supported-package? package))
234 (package-superseded package))))
237 (define* (fold-packages proc init
239 (modules (all-modules (%package-module-path)
241 warn-about-load-error))
242 #:key (select? (negate hidden-package?)))
243 "Call (PROC PACKAGE RESULT) for each available package defined in one of
244 MODULES that matches SELECT?, using INIT as the initial value of RESULT. It
245 is guaranteed to never traverse the same package twice."
246 (fold-module-public-variables (lambda (object result)
247 (if (and (package? object) (select? object))
253 (define %package-cache-file
254 ;; Location of the package cache.
255 "/lib/guix/package.cache")
257 (define load-package-cache
259 "Attempt to load the package cache. On success return a vhash keyed by
260 package names. Return #f on failure."
267 (load-compiled (string-append profile %package-cache-file)))
268 (fold (lambda (item vhash)
270 (#(name version module symbol outputs
271 supported? deprecated?
273 (vhash-cons name item vhash))))
277 (if (= ENOENT (system-error-errno args))
279 (apply throw args))))))))
281 (define find-packages-by-name/direct ;bypass the cache
282 (let ((packages (delay
283 (fold-packages (lambda (p r)
284 (vhash-cons (package-name p) p r))
286 (version>? (lambda (p1 p2)
287 (version>? (package-version p1) (package-version p2)))))
288 (lambda* (name #:optional version)
289 "Return the list of packages with the given NAME. If VERSION is not #f,
290 then only return packages whose version is prefixed by VERSION, sorted in
291 decreasing version order."
292 (let ((matching (sort (vhash-fold* cons '() name (force packages))
295 (filter (lambda (package)
296 (version-prefix? version (package-version package)))
300 (define (cache-lookup cache name)
301 "Lookup package NAME in CACHE. Return a list sorted in increasing version
303 (define (package-version<? v1 v2)
304 (version>? (vector-ref v2 1) (vector-ref v1 1)))
306 (sort (vhash-fold* cons '() name cache)
309 (define* (find-packages-by-name name #:optional version)
310 "Return the list of packages with the given NAME. If VERSION is not #f,
311 then only return packages whose version is prefixed by VERSION, sorted in
312 decreasing version order."
314 (load-package-cache (current-profile)))
316 (if (and (cache-is-authoritative?) cache)
317 (match (cache-lookup cache name)
319 ((#(_ versions modules symbols _ _ _ _ _ _) ...)
320 (fold (lambda (version* module symbol result)
321 (if (or (not version)
322 (version-prefix? version version*))
323 (cons (module-ref (resolve-interface module)
328 versions modules symbols)))
329 (find-packages-by-name/direct name version)))
331 (define* (find-package-locations name #:optional version)
332 "Return a list of version/location pairs corresponding to each package
333 matching NAME and VERSION."
335 (load-package-cache (current-profile)))
337 (if (and cache (cache-is-authoritative?))
338 (match (cache-lookup cache name)
340 ((#(name versions modules symbols outputs
341 supported? deprecated?
342 files lines columns) ...)
343 (fold (lambda (version* file line column result)
346 (version-prefix? version version*)))
347 (alist-cons version* (location file line column)
351 versions files lines columns)))
352 (map (lambda (package)
353 (cons (package-version package) (package-location package)))
354 (find-packages-by-name/direct name version))))
356 (define (find-best-packages-by-name name version)
357 "If version is #f, return the list of packages named NAME with the highest
358 version numbers; otherwise, return the list of packages named NAME and at
361 (find-packages-by-name name version)
362 (match (find-packages-by-name name)
366 ;; Return the subset of MATCHES with the higher version number.
367 (let ((highest (package-version (first matches))))
368 (take-while (lambda (p)
369 (string=? (package-version p) highest))
372 (define (generate-package-cache directory)
373 "Generate under DIRECTORY a cache of all the available packages.
375 The primary purpose of the cache is to speed up package lookup by name such
376 that we don't have to traverse and load all the package modules, thereby also
377 reducing the memory footprint."
379 (string-append directory %package-cache-file))
381 (define (expand-cache module symbol variable result+seen)
382 (match (false-if-exception (variable-ref variable))
383 ((? package? package)
386 (if (or (vhash-assq package seen)
387 (hidden-package? package))
389 (cons (cons `#(,(package-name package)
390 ,(package-version package)
391 ,(module-name module)
393 ,(package-outputs package)
394 ,(->bool (supported-package? package))
395 ,(->bool (package-superseded package))
396 ,@(let ((loc (package-location package)))
398 `(,(location-file loc)
400 ,(location-column loc))
403 (vhash-consq package #t seen))))))
409 (fold-module-public-variables* expand-cache
410 (cons '() vlist-null)
411 (all-modules (%package-module-path)
413 warn-about-load-error))))
415 (mkdir-p (dirname cache-file))
416 (call-with-output-file cache-file
418 ;; Store the cache as a '.go' file. This makes loading fast and reduces
419 ;; heap usage since some of the static data is directly mmapped.
423 #:opts '(#:to-file? #t)))))
427 (define %sigint-prompt
428 ;; The prompt to jump to upon SIGINT.
429 (make-prompt-tag "interruptible"))
431 (define (call-with-sigint-handler thunk handler)
432 "Call THUNK and return its value. Upon SIGINT, call HANDLER with the signal
433 number in the context of the continuation of the call to this function, and
434 return its return value."
435 (call-with-prompt %sigint-prompt
439 (sigaction SIGINT SIG_DFL)
440 (abort-to-prompt %sigint-prompt signum)))
444 (cut sigaction SIGINT SIG_DFL)))
450 ;;; Package specification.
453 (define* (%find-package spec name version)
454 (match (find-best-packages-by-name name version)
457 (warning (G_ "ambiguous package specification `~a'~%") spec)
458 (warning (G_ "choosing ~a@~a from ~a~%")
459 (package-name pkg) (package-version pkg)
460 (location->string (package-location pkg))))
461 (match (package-superseded pkg)
463 (info (G_ "package '~a' has been superseded by '~a'~%")
464 (package-name pkg) (package-name new))
470 (leave (G_ "~A: package not found for version ~a~%") name version)
471 (leave (G_ "~A: unknown package~%") name)))))
473 (define (specification->package spec)
474 "Return a package matching SPEC. SPEC may be a package name, or a package
475 name followed by an at-sign and a version number. If the version number is not
476 present, return the preferred newest version."
477 (let-values (((name version) (package-name->name+version spec)))
478 (%find-package spec name version)))
480 (define (specification->location spec)
481 "Return the location of the highest-numbered package matching SPEC, a
482 specification such as \"guile@2\" or \"emacs\"."
483 (let-values (((name version) (package-name->name+version spec)))
484 (match (find-package-locations name version)
487 (leave (G_ "~A: package not found for version ~a~%") name version)
488 (leave (G_ "~A: unknown package~%") name)))
490 (let* ((highest (match lst (((version . _) _ ...) version)))
491 (locations (take-while (match-lambda
492 ((version . location)
493 (string=? version highest)))
496 (((version . location) . rest)
498 (warning (G_ "ambiguous package specification `~a'~%") spec)
499 (warning (G_ "choosing ~a@~a from ~a~%")
501 (location->string location)))
504 (define* (specification->package+output spec #:optional (output "out"))
505 "Return the package and output specified by SPEC, or #f and #f; SPEC may
506 optionally contain a version number and an output name, as in these examples:
513 If SPEC does not specify a version number, return the preferred newest
514 version; if SPEC does not specify an output, return OUTPUT.
516 When OUTPUT is false and SPEC does not specify any output, return #f as the
518 (let-values (((name version sub-drv)
519 (package-specification->name+version+output spec output)))
520 (match (%find-package spec name version)
524 (if (or (and (not output) (not sub-drv))
525 (member sub-drv (package-outputs package)))
526 (values package sub-drv)
527 (leave (G_ "package `~a' lacks output `~a'~%")
528 (package-full-name package)
531 (define (specifications->manifest specs)
532 "Given SPECS, a list of specifications such as \"emacs@25.2\" or
533 \"guile:debug\", return a profile manifest."
534 ;; This procedure exists mostly so users of 'guix package -m' don't have to
535 ;; fiddle with multiple-value returns.
537 (map (compose list specification->package+output) specs)))