From 6d8107c967a554e23b0c58c8933894d4468ad596 Mon Sep 17 00:00:00 2001 From: Ludovic Courtès Date: Mon, 7 Oct 2024 10:24:43 +0200 Subject: shell: Enable caching when using deterministic package transformations. MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Until now, using any package transformation would disable the automatic GC root creation and caching in ‘guix shell’. This change introduces a finer-grain distinction: a command like: guix shell --tune inkscape is now subject to caching, whereas: guix shell --with-latest=inkscape inkscape remains non-cacheable. * guix/transformations.scm (%transformations-with-external-dependencies): New variable. (cacheable-transformation-option-key?): New procedure. * guix/scripts/shell.scm (profile-cached-gc-root): In the ‘transformation-option-key?’ clause, call ‘loop’ when ‘cacheable-transformation-option-key?’ returns true. Change-Id: I847b661dfea20ecf851db2023a5c7ea8c5b5ca7c --- guix/scripts/shell.scm | 13 ++++++++----- guix/transformations.scm | 20 +++++++++++++++++++- 2 files changed, 27 insertions(+), 6 deletions(-) diff --git a/guix/scripts/shell.scm b/guix/scripts/shell.scm index 0584a7e018..d23362a15d 100644 --- a/guix/scripts/shell.scm +++ b/guix/scripts/shell.scm @@ -1,5 +1,5 @@ ;;; GNU Guix --- Functional package management for GNU -;;; Copyright © 2021-2023 Ludovic Courtès +;;; Copyright © 2021-2024 Ludovic Courtès ;;; Copyright © 2023 Janneke Nieuwenhuizen ;;; ;;; This file is part of GNU Guix. @@ -25,6 +25,7 @@ (define-module (guix scripts shell) show-native-build-options-help) #:autoload (guix transformations) (options->transformation transformation-option-key? + cacheable-transformation-option-key? show-transformation-options-help) #:autoload (guix grafts) (%graft?) #:use-module (guix scripts) @@ -417,11 +418,13 @@ (define (key->file key) ;; Arbitrary expressions might be non-deterministic or otherwise depend ;; on external state so do not cache when they're used. (values #f #f)) - ((((? transformation-option-key?) . _) . _) + ((((? transformation-option-key? key) . _) . rest) ;; Transformation options are potentially "non-deterministic", or at - ;; least depending on external state (with-source, with-commit, etc.), - ;; so do not cache anything when they're used. - (values #f #f)) + ;; least depending on external state (with-source, with-commit, etc.). + ;; Cache only those that are known to be "cacheable". + (if (cacheable-transformation-option-key? key) + (loop rest system file (cons (first opts) specs)) + (values #f #f))) ((('profile . _) . _) ;; If the user already specified a profile, there's nothing more to ;; cache. diff --git a/guix/transformations.scm b/guix/transformations.scm index 582f8a2729..ea8b7a0844 100644 --- a/guix/transformations.scm +++ b/guix/transformations.scm @@ -1,5 +1,5 @@ ;;; GNU Guix --- Functional package management for GNU -;;; Copyright © 2016-2023 Ludovic Courtès +;;; Copyright © 2016-2024 Ludovic Courtès ;;; Copyright © 2021 Marius Bakke ;;; Copyright © 2023 Sarthak Shah ;;; Copyright © 2023, 2024 Efraim Flashner @@ -63,6 +63,7 @@ (define-module (guix transformations) show-transformation-options-help transformation-option-key? + cacheable-transformation-option-key? %transformation-options)) ;;; Commentary: @@ -938,6 +939,16 @@ (define %transformations (with-latest . ,transform-package-latest) (with-version . ,transform-package-version))) +(define %transformations-with-external-dependencies + ;; Subset of options that depend on external resources and that can thus be + ;; considered "non-deterministic" and non-cacheable. + '(with-source + with-branch + with-git-url + with-patch + with-latest + with-version)) + (define (transformation-procedure key) "Return the transformation procedure associated with KEY, a symbol such as 'with-source', or #f if there is none." @@ -952,6 +963,13 @@ (define (transformation-option-key? key) For example, (transformation-option-key? 'with-input) => #t." (->bool (transformation-procedure key))) +(define (cacheable-transformation-option-key? key) + "Return true if KEY corresponds to a transformation option whose result can +be cached--i.e., the transformation is deterministic and does not depend on +external resources." + (and (transformation-option-key? key) + (not (memq key %transformations-with-external-dependencies)))) + ;;; ;;; Command-line handling. -- cgit v1.2.3