1 ;;; GNU Guix --- Functional package management for GNU
2 ;;; Copyright © 2012-2020, 2022 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>
7 ;;; Copyright © 2022 Antero Mejr <antero@mailbox.org>
9 ;;; This file is part of GNU Guix.
11 ;;; GNU Guix is free software; you can redistribute it and/or modify it
12 ;;; under the terms of the GNU General Public License as published by
13 ;;; the Free Software Foundation; either version 3 of the License, or (at
14 ;;; your option) any later version.
16 ;;; GNU Guix is distributed in the hope that it will be useful, but
17 ;;; WITHOUT ANY WARRANTY; without even the implied warranty of
18 ;;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19 ;;; GNU General Public License for more details.
21 ;;; You should have received a copy of the GNU General Public License
22 ;;; along with GNU Guix. If not, see <http://www.gnu.org/licenses/>.
24 (define-module (gnu packages)
25 #:use-module (guix packages)
26 #:use-module (guix ui)
27 #:use-module (guix utils)
28 #:use-module (guix diagnostics)
29 #:use-module (guix discovery)
30 #:use-module (guix memoization)
31 #:use-module ((guix build utils)
32 #:select ((package-name->name+version
33 . hyphen-separated-name->name+version)
35 #:use-module (guix profiles)
36 #:use-module (guix describe)
37 #:use-module (guix deprecation)
38 #:use-module (ice-9 vlist)
39 #:use-module (ice-9 match)
40 #:use-module (ice-9 binary-ports)
41 #:autoload (system base compile) (compile)
42 #:use-module (srfi srfi-1)
43 #:use-module (srfi srfi-26)
44 #:use-module (srfi srfi-34)
45 #:use-module (srfi srfi-35)
46 #:use-module (srfi srfi-39)
47 #:use-module (srfi srfi-71)
48 #:export (search-patch
54 %default-package-module-path
55 cache-is-authoritative?
58 fold-available-packages
60 find-newest-available-packages
62 find-package-locations
63 find-best-packages-by-name
65 specification->package
66 specification->package+output
67 specification->location
68 specifications->manifest
69 specifications->packages
71 package-unique-version-prefix
73 generate-package-cache))
77 ;;; General utilities for the software distribution---i.e., the modules under
78 ;;; (gnu packages ...).
82 ;; By default, we store patches and auxiliary files
83 ;; alongside Guile modules. This is so that these extra files can be
84 ;; found without requiring a special setup, such as a specific
85 ;; installation directory and an extra environment variable. One
86 ;; advantage of this setup is that everything just works in an
87 ;; auto-compilation setting.
89 (define %auxiliary-files-path
91 (map (cut string-append <> "/gnu/packages/aux-files")
94 (define (search-auxiliary-file file-name)
95 "Search the auxiliary FILE-NAME. Return #f if not found."
96 (search-path (%auxiliary-files-path) file-name))
98 (define (search-patch file-name)
99 "Search the patch FILE-NAME. Raise an error if not found."
100 (or (search-path (%patch-path) file-name)
101 (raise (formatted-message (G_ "~a: patch not found")
104 (define-syntax-rule (search-patches file-name ...)
105 "Return the list of absolute file names corresponding to each
106 FILE-NAME found in %PATCH-PATH."
107 (list (search-patch file-name) ...))
109 (define %distro-root-directory
110 ;; Absolute file name of the module hierarchy. Since (gnu packages …) might
111 ;; live in a directory different from (guix), try to get the best match.
112 (letrec-syntax ((dirname* (syntax-rules ()
115 ((_ file head tail ...)
116 (dirname (dirname* file tail ...)))))
117 (try (syntax-rules ()
118 ((_ (file things ...) rest ...)
119 (match (search-path %load-path file)
123 (dirname* absolute things ...))))
126 (try ("gnu/packages/base.scm" gnu/ packages/)
127 ("gnu/packages.scm" gnu/)
130 (define %default-package-module-path
131 ;; Default search path for package modules.
132 `((,%distro-root-directory . "gnu/packages")))
134 (define (cache-is-authoritative?)
135 "Return true if the pre-computed package cache is authoritative. It is not
136 authoritative when entries have been added via GUIX_PACKAGE_PATH or '-L'
138 (equal? (%package-module-path)
139 (append %default-package-module-path
140 (package-path-entries))))
142 (define %package-module-path
143 ;; Search path for package modules. Each item must be either a directory
144 ;; name or a pair whose car is a directory and whose cdr is a sub-directory
145 ;; to narrow the search.
146 (let* ((not-colon (char-set-complement (char-set #\:)))
147 (environment (string-tokenize (or (getenv "GUIX_PACKAGE_PATH") "")
149 (channels-scm channels-go (package-path-entries)))
150 ;; Automatically add channels and items from $GUIX_PACKAGE_PATH to Guile's
151 ;; search path. For historical reasons, $GUIX_PACKAGE_PATH goes to the
152 ;; front; channels go to the back so that they don't override Guix' own
155 (append environment %load-path channels-scm))
156 (set! %load-compiled-path
157 (append environment %load-compiled-path channels-go))
161 %default-package-module-path
165 ;; Define it after '%package-module-path' so that '%load-path' contains user
166 ;; directories, allowing patches in $GUIX_PACKAGE_PATH to be found.
168 (map (lambda (directory)
169 (if (string=? directory %distro-root-directory)
170 (string-append directory "/gnu/packages/patches")
174 ;; This procedure is used by Emacs-Guix up to 0.5.1.1, so keep it for now.
175 ;; See <https://github.com/alezost/guix.el/issues/30>.
176 (define-deprecated find-newest-available-packages
177 find-packages-by-name
179 "Return a vhash keyed by package names, and with
180 associated values of the form
182 (newest-version newest-package ...)
184 where the preferred package is listed first."
185 (fold-packages (lambda (p r)
186 (let ((name (package-name p))
187 (version (package-version p)))
188 (match (vhash-assoc name r)
189 ((_ newest-so-far . pkgs)
190 (case (version-compare version newest-so-far)
191 ((>) (vhash-cons name `(,version ,p) r))
192 ((=) (vhash-cons name `(,version ,p ,@pkgs) r))
194 (#f (vhash-cons name `(,version ,p) r)))))
197 (define (fold-available-packages proc init)
198 "Fold PROC over the list of available packages. For each available package,
199 PROC is called along these lines:
201 (PROC NAME VERSION RESULT
206 PROC can use #:allow-other-keys to ignore the bits it's not interested in.
207 When a package cache is available, this procedure does not actually load any
210 (load-package-cache (current-profile)))
212 (if (and cache (cache-is-authoritative?))
213 (vhash-fold (lambda (name vector result)
215 (#(name version module symbol outputs
216 supported? deprecated?
218 (proc name version result
221 (location file line column))
222 #:supported? supported?
223 #:deprecated? deprecated?))))
226 (fold-packages (lambda (package result)
227 (proc (package-name package)
228 (package-version package)
230 #:outputs (package-outputs package)
231 #:location (package-location package)
233 (->bool (supported-package? package))
236 (package-superseded package))))
239 (define* (fold-packages proc init
241 (modules (all-modules (%package-module-path)
243 warn-about-load-error))
244 #:key (select? (negate hidden-package?)))
245 "Call (PROC PACKAGE RESULT) for each available package defined in one of
246 MODULES that matches SELECT?, using INIT as the initial value of RESULT. It
247 is guaranteed to never traverse the same package twice."
248 (fold-module-public-variables (lambda (object result)
249 (if (and (package? object) (select? object))
255 (define %package-cache-file
256 ;; Location of the package cache.
257 "/lib/guix/package.cache")
259 (define load-package-cache
261 "Attempt to load the package cache. On success return a vhash keyed by
262 package names. Return #f on failure."
269 (load-compiled (string-append profile %package-cache-file)))
270 (fold (lambda (item vhash)
272 (#(name version module symbol outputs
273 supported? deprecated?
275 (vhash-cons name item vhash))))
279 (if (= ENOENT (system-error-errno args))
281 (apply throw args))))))))
283 (define find-packages-by-name/direct ;bypass the cache
284 (let ((packages (delay
285 (fold-packages (lambda (p r)
286 (vhash-cons (package-name p) p r))
288 (version>? (lambda (p1 p2)
289 (version>? (package-version p1) (package-version p2)))))
290 (lambda* (name #:optional version)
291 "Return the list of packages with the given NAME. If VERSION is not #f,
292 then only return packages whose version is prefixed by VERSION, sorted in
293 decreasing version order."
294 (let ((matching (sort (vhash-fold* cons '() name (force packages))
297 (filter (lambda (package)
298 (version-prefix? version (package-version package)))
302 (define (cache-lookup cache name)
303 "Lookup package NAME in CACHE. Return a list sorted in increasing version
305 (define (package-version<? v1 v2)
306 (version>? (vector-ref v2 1) (vector-ref v1 1)))
308 (sort (vhash-fold* cons '() name cache)
311 (define* (find-packages-by-name name #:optional version)
312 "Return the list of packages with the given NAME. If VERSION is not #f,
313 then only return packages whose version is prefixed by VERSION, sorted in
314 decreasing version order."
316 (load-package-cache (current-profile)))
318 (if (and (cache-is-authoritative?) cache)
319 (match (cache-lookup cache name)
321 ((#(_ versions modules symbols _ _ _ _ _ _) ...)
322 (fold (lambda (version* module symbol result)
323 (if (or (not version)
324 (version-prefix? version version*))
325 (cons (module-ref (resolve-interface module)
330 versions modules symbols)))
331 (find-packages-by-name/direct name version)))
333 (define* (find-package-locations name #:optional version)
334 "Return a list of version/location pairs corresponding to each package
335 matching NAME and VERSION."
337 (load-package-cache (current-profile)))
339 (if (and cache (cache-is-authoritative?))
340 (match (cache-lookup cache name)
342 ((#(name versions modules symbols outputs
343 supported? deprecated?
344 files lines columns) ...)
345 (fold (lambda (version* file line column result)
348 (version-prefix? version version*)))
349 (alist-cons version* (location file line column)
353 versions files lines columns)))
354 (map (lambda (package)
355 (cons (package-version package) (package-location package)))
356 (find-packages-by-name/direct name version))))
358 (define (find-best-packages-by-name name version)
359 "If version is #f, return the list of packages named NAME with the highest
360 version numbers; otherwise, return the list of packages named NAME and at
363 (find-packages-by-name name version)
364 (match (find-packages-by-name name)
368 ;; Return the subset of MATCHES with the higher version number.
369 (let ((highest (package-version (first matches))))
370 (take-while (lambda (p)
371 (string=? (package-version p) highest))
374 ;; Prevent Guile 3 from inlining this procedure so we can mock it in tests.
375 (set! find-best-packages-by-name find-best-packages-by-name)
377 (define (generate-package-cache directory)
378 "Generate under DIRECTORY a cache of all the available packages.
380 The primary purpose of the cache is to speed up package lookup by name such
381 that we don't have to traverse and load all the package modules, thereby also
382 reducing the memory footprint."
384 (string-append directory %package-cache-file))
388 (((module symbol variable) (result . seen))
389 (let ((package (variable-ref variable)))
390 (if (or (vhash-assq package seen)
391 (hidden-package? package))
393 (cons (cons `#(,(package-name package)
394 ,(package-version package)
395 ,(module-name module)
397 ,(package-outputs package)
398 ,(->bool (supported-package? package))
399 ,(->bool (package-superseded package))
400 ,@(let ((loc (package-location package)))
402 `(,(location-file loc)
404 ,(location-column loc))
407 (vhash-consq package #t seen)))))))
411 ((module symbol variable)
412 (let ((value (variable-ref variable)))
413 (string-append (package-name value) (package-version value)
414 (object->string module)
415 (symbol->string symbol))))))
417 (define (entry<? a b)
418 (string<? (entry-key a) (entry-key b)))
421 ;; First sort variables so that 'expand-cache' later dismisses
422 ;; already-seen package objects in a deterministic fashion.
424 (fold-module-public-variables* (lambda (module symbol variable lst)
425 (let ((value (false-if-exception
426 (variable-ref variable))))
428 (cons (list module symbol variable)
432 (all-modules (%package-module-path)
434 warn-about-load-error))
438 (first (fold expand-cache (cons '() vlist-null) variables)))
440 (mkdir-p (dirname cache-file))
441 (call-with-output-file cache-file
443 ;; Store the cache as a '.go' file. This makes loading fast and reduces
444 ;; heap usage since some of the static data is directly mmapped.
448 #:opts '(#:to-file? #t)))))
452 (define %sigint-prompt
453 ;; The prompt to jump to upon SIGINT.
454 (make-prompt-tag "interruptible"))
456 (define (call-with-sigint-handler thunk handler)
457 "Call THUNK and return its value. Upon SIGINT, call HANDLER with the signal
458 number in the context of the continuation of the call to this function, and
459 return its return value."
460 (call-with-prompt %sigint-prompt
464 (sigaction SIGINT SIG_DFL)
465 (abort-to-prompt %sigint-prompt signum)))
469 (cut sigaction SIGINT SIG_DFL)))
475 ;;; Package specification.
478 (define* (%find-package spec name version)
479 (match (find-best-packages-by-name name version)
482 (warning (G_ "ambiguous package specification `~a'~%") spec)
483 (warning (G_ "choosing ~a@~a from ~a~%")
484 (package-name pkg) (package-version pkg)
485 (location->string (package-location pkg))))
486 (match (package-superseded pkg)
488 (info (G_ "package '~a' has been superseded by '~a'~%")
489 (package-name pkg) (package-name new))
495 (leave (G_ "~A: package not found for version ~a~%") name version)
496 (leave (G_ "~A: unknown package~%") name)))))
498 (define (specification->package spec)
499 "Return a package matching SPEC. SPEC may be a package name, or a package
500 name followed by an at-sign and a version number. If the version number is not
501 present, return the preferred newest version."
502 (let ((name version (package-name->name+version spec)))
503 (%find-package spec name version)))
505 (define (specification->location spec)
506 "Return the location of the highest-numbered package matching SPEC, a
507 specification such as \"guile@2\" or \"emacs\"."
508 (let ((name version (package-name->name+version spec)))
509 (match (find-package-locations name version)
512 (leave (G_ "~A: package not found for version ~a~%") name version)
513 (leave (G_ "~A: unknown package~%") name)))
515 (let* ((highest (match lst (((version . _) _ ...) version)))
516 (locations (take-while (match-lambda
517 ((version . location)
518 (string=? version highest)))
521 (((version . location) . rest)
523 (warning (G_ "ambiguous package specification `~a'~%") spec)
524 (warning (G_ "choosing ~a@~a from ~a~%")
526 (location->string location)))
529 (define* (specification->package+output spec #:optional (output "out"))
530 "Return the package and output specified by SPEC, or #f and #f; SPEC may
531 optionally contain a version number and an output name, as in these examples:
538 If SPEC does not specify a version number, return the preferred newest
539 version; if SPEC does not specify an output, return OUTPUT.
541 When OUTPUT is false and SPEC does not specify any output, return #f as the
543 (let ((name version sub-drv
544 (package-specification->name+version+output spec output)))
545 (match (%find-package spec name version)
549 (if (or (and (not output) (not sub-drv))
550 (member sub-drv (package-outputs package)))
551 (values package sub-drv)
552 (leave (G_ "package `~a' lacks output `~a'~%")
553 (package-full-name package)
556 (define (specifications->packages specs)
557 "Given SPECS, a list of specifications such as \"emacs@25.2\" or
558 \"guile:debug\", return a list of package/output tuples."
559 ;; This procedure exists so users of 'guix home' don't have to write out the
560 ;; (map (compose list specification->package+output)... boilerplate.
561 (map (compose list specification->package+output) specs))
563 (define (specifications->manifest specs)
564 "Given SPECS, a list of specifications such as \"emacs@25.2\" or
565 \"guile:debug\", return a profile manifest."
566 ;; This procedure exists mostly so users of 'guix package -m' don't have to
567 ;; fiddle with multiple-value returns.
569 (specifications->packages specs)))
571 (define (package-unique-version-prefix name version)
572 "Search among all the versions of package NAME that are available, and
573 return the shortest unambiguous version prefix to designate VERSION. If only
574 one version of the package is available, return the empty string."
575 (match (map package-version (find-packages-by-name name))
577 ;; A single version of NAME is available, so do not specify the version
578 ;; number, even if the available version doesn't match VERSION.
581 ;; If VERSION is the latest version, don't specify any version.
582 ;; Otherwise return the shortest unique version prefix. Note that this
583 ;; is based on the currently available packages so the result may vary
585 (if (every (cut version>? version <>)
586 (delete version versions))
588 (version-unique-prefix version versions)))))