From patchwork Wed Aug 7 00:11:15 2024 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Lilah Tascheter X-Patchwork-Id: 66838 Return-Path: X-Original-To: patchwork@mira.cbaines.net Delivered-To: patchwork@mira.cbaines.net Received: by mira.cbaines.net (Postfix, from userid 113) id 4497727BBEC; Wed, 7 Aug 2024 01:14:07 +0100 (BST) X-Spam-Checker-Version: SpamAssassin 3.4.6 (2021-04-09) on mira.cbaines.net X-Spam-Level: X-Spam-Status: No, score=-4.4 required=5.0 tests=BAYES_00,DKIM_INVALID, DKIM_SIGNED,FROM_SUSPICIOUS_NTLD,MAILING_LIST_MULTI,PDS_OTHER_BAD_TLD, RCVD_IN_VALIDITY_CERTIFIED,RCVD_IN_VALIDITY_RPBL,RCVD_IN_VALIDITY_SAFE, SPF_HELO_PASS,URIBL_BLOCKED autolearn=unavailable autolearn_force=no version=3.4.6 Received: from lists.gnu.org (lists.gnu.org [209.51.188.17]) by mira.cbaines.net (Postfix) with ESMTPS id A948E27BBE2 for ; Wed, 7 Aug 2024 01:14:05 +0100 (BST) Received: from localhost ([::1] helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1sbUJG-0004QP-8H; Tue, 06 Aug 2024 20:13:46 -0400 Received: from eggs.gnu.org ([2001:470:142:3::10]) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1sbUJE-0004Jn-HC for guix-patches@gnu.org; Tue, 06 Aug 2024 20:13:44 -0400 Received: from debbugs.gnu.org ([2001:470:142:5::43]) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_128_GCM_SHA256:128) (Exim 4.90_1) (envelope-from ) id 1sbUJE-00027i-71; Tue, 06 Aug 2024 20:13:44 -0400 DKIM-Signature: v=1; a=rsa-sha256; q=dns/txt; c=relaxed/relaxed; d=debbugs.gnu.org; s=debbugs-gnu-org; h=MIME-Version:References:In-Reply-To:Date:From:To:Subject; bh=GjrXfij5RX9qb7IHSScxv59yMM33C8u3PeXsgfI8yFM=; b=TUCVNxj++CbrfJNAK/CxBRDJ8lmfHnLciOzVXd9GdOdAjcbH0hvmH1AX1UCZoAYEJD7MS2OlcAJB+ak49tE3iaoYS4CO4awgXjVJPzKKs3DRtJCvWmjL9Za3JfgTc8RTJc8bOnKeypvq8I3NoUZxfObiZsH5pXB/sTehlnHP1d8i3UzF1wCQZGqdwjNthnkDa8eMoESRX02+nJdgaiT9Oe3VSaTz6YumdhwVZ4Z8Za9jFXNgPo4R4aFCvFe+tmLeCMWfrVRSM6kpFgYL9YpFp+PEH0aVRjAXNxyUh9efyDbeSg2HEfBxpc90SEKnz5JmPwr5xzv5lIDXcoUK7EdlDA==; Received: from Debian-debbugs by debbugs.gnu.org with local (Exim 4.84_2) (envelope-from ) id 1sbUJX-0006xL-D3; Tue, 06 Aug 2024 20:14:03 -0400 X-Loop: help-debbugs@gnu.org Subject: [bug#72457] [PATCH v5 02/15] gnu: Add bootloader target infastructure. Resent-From: Lilah Tascheter Original-Sender: "Debbugs-submit" Resent-CC: guix@cbaines.net, dev@jpoiret.xyz, lilah@lunabee.space, ludo@gnu.org, othacehe@gnu.org, zimon.toutoune@gmail.com, me@tobias.gr, guix-patches@gnu.org Resent-Date: Wed, 07 Aug 2024 00:14:03 +0000 Resent-Message-ID: Resent-Sender: help-debbugs@gnu.org X-GNU-PR-Message: followup 72457 X-GNU-PR-Package: guix-patches X-GNU-PR-Keywords: patch To: 72457@debbugs.gnu.org Cc: Lilah Tascheter , Sergey Trofimov , Christopher Baines , Josselin Poiret , Lilah Tascheter , Ludovic Court??s , Mathieu Othacehe , Simon Tournier , Tobias Geerinckx-Rice X-Debbugs-Original-Xcc: Christopher Baines , Josselin Poiret , Lilah Tascheter , Ludovic Court??s , Mathieu Othacehe , Simon Tournier , Tobias Geerinckx-Rice Received: via spool by 72457-submit@debbugs.gnu.org id=B72457.172298962926621 (code B ref 72457); Wed, 07 Aug 2024 00:14:03 +0000 Received: (at 72457) by debbugs.gnu.org; 7 Aug 2024 00:13:49 +0000 Received: from localhost ([127.0.0.1]:33231 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1sbUJI-0006vF-9r for submit@debbugs.gnu.org; Tue, 06 Aug 2024 20:13:49 -0400 Received: from sendmail.purelymail.com ([34.202.193.197]:33132) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1sbUJF-0006uY-Ao for 72457@debbugs.gnu.org; Tue, 06 Aug 2024 20:13:46 -0400 Authentication-Results: purelymail.com; auth=pass DKIM-Signature: a=rsa-sha256; b=h4KvbqNXTAlR9CY5j8fzpHh6rt9ziGO6HijytABv9iT5LN0KRCwoW54rhjT+JEXiz6OMjtO19n2XzZvdh8mKJgAsYAeJn5p9hzCiKm5ddRhQNSmdHLrPWdFApWi4SvrzIUqGI0/5wKXxAag8rqESS1/BcexLK+Zr8/PPk+/VgpbnmNxaKWkElvC4U6swYfOEpO1EleXBo2iCE9eJe14yAlWn02CMzaxj4LocKfAep/+jL6BOfZ7iCugGdWIcrSWeU6uEAky+F6z4IIef4/6UWuPZ6zFIvqce3lywUGB+Z9vLIG0tG6Y6Y8pLyUml9aTlcaXeZ4sS2W2ha8YlBGLbcA==; s=purelymail3; d=lunabee.space; v=1; bh=HX1nYy/zwZ3IawonY9iRlGbuoXA36lvt5DMOH9H7gl4=; h=Received:From:To:Subject:Date; DKIM-Signature: a=rsa-sha256; b=LiLIyKF/FAvYnRh2C+59bDrWoKhWSow3FhIai8xwNpbSMu7dbsRmGjnCIsmIHOKl4K8Olcb7oi2qPe6YBohlFGu6DN8AVgLjkmDz9SHvkLhfjtdO/QCC3vmeF6A7haH4wGWW9CYzIjo0nxJAb3gIFHxtApGfqFF24MZRxUraYKMWS+ehH9aom7cgYHAUCcv8kZO2xQ1kEfkLWVkyjEPcMdeo0KzCaQ2zQ/TgZ8UiwiK/UDECpV/k6cKVPDa7DIFb4j9ziNSJx8nz8TTom0SI3As561XQSiVRq487uFpFpUl7oirhN6pKkhPThPwWFLoy43fX8STTMbVkZe7UN8zbuQ==; s=purelymail3; d=purelymail.com; v=1; bh=HX1nYy/zwZ3IawonY9iRlGbuoXA36lvt5DMOH9H7gl4=; h=Feedback-ID:Received:From:To:Subject:Date; Feedback-ID: 8937:2070:null:purelymail X-Pm-Original-To: 72457@debbugs.gnu.org Received: by smtp.purelymail.com (Purelymail SMTP) with ESMTPSA id -1661201426; (version=TLSv1.3 cipher=TLS_AES_256_GCM_SHA384); Wed, 07 Aug 2024 00:13:07 +0000 (UTC) Date: Tue, 6 Aug 2024 19:11:15 -0500 Message-ID: In-Reply-To: References: MIME-Version: 1.0 X-MIME-Autoconverted: from 8bit to quoted-printable by Purelymail X-BeenThere: debbugs-submit@debbugs.gnu.org X-Mailman-Version: 2.1.18 Precedence: list X-BeenThere: guix-patches@gnu.org List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-Patchwork-Original-From: Lilah Tascheter via Guix-patches From: Lilah Tascheter Reply-To: Lilah Tascheter Errors-To: guix-patches-bounces+patchwork=mira.cbaines.net@gnu.org Sender: guix-patches-bounces+patchwork=mira.cbaines.net@gnu.org X-getmail-retrieved-from-mailbox: Patches * gnu/bootloader.scm (bootloader-target): New record. (&target-error): New condition. (pathcat, get-target-of-type, parent-of, unfold-pathcat, target-base?, type-major?, ensure, ensure-target-types, ensure-majors, gbegin): New procedures. (define-literal, with-targets, :path, :devpath, :device, :fs, :label, :uuid): New macros. (bootloader-modules): Prevent mutual imports. * guix/ui.scm (call-with-error-handling)[target-error?]: Handle target-errors. Change-Id: I3f07c9096dd8b91c04449b6360b3b7d21640da14 --- gnu/bootloader.scm | 212 ++++++++++++++++++++++++++++++++++++++++++++- guix/ui.scm | 8 ++ 2 files changed, 217 insertions(+), 3 deletions(-) diff --git a/gnu/bootloader.scm b/gnu/bootloader.scm index f32e90e79d..3ddc112cc6 100644 --- a/gnu/bootloader.scm +++ b/gnu/bootloader.scm @@ -31,10 +31,11 @@ (define-module (gnu bootloader) #:use-module (guix profiles) #:use-module (guix records) #:use-module (guix deprecation) - #:use-module ((guix ui) #:select (warn-about-load-error)) #:use-module (guix diagnostics) #:use-module (guix i18n) + #:use-module (guix modules) #:use-module (srfi srfi-1) + #:use-module (srfi srfi-26) #:use-module (srfi srfi-34) #:use-module (srfi srfi-35) #:use-module (ice-9 match) @@ -63,6 +64,26 @@ (define-module (gnu bootloader) bootloader-configuration-file bootloader-configuration-file-generator + + bootloader-target + bootloader-target? + bootloader-target-type + bootloader-target-expected? + bootloader-target-path + bootloader-target-offset + bootloader-target-device + bootloader-target-file-system + bootloader-target-label + bootloader-target-uuid + + target-error? + target-error-type + target-error-targets + + gbegin + :path :devpath :device :fs :label :uuid + with-targets + bootloader-configuration bootloader-configuration? bootloader-configuration-bootloader @@ -236,6 +257,191 @@ (define-record-type* (configuration-file bootloader-configuration-file) (configuration-file-generator bootloader-configuration-file-generator)) + +;;; +;;; Bootloader target record. +;;; + +;; represents different kinds of targets in a normalized form. + +(define-record-type* + bootloader-target make-bootloader-target bootloader-target? + (type bootloader-target-type) ; symbol + (expected? bootloader-target-expected? (default #f)) ; bool + + (path bootloader-target-path (default #f)) ; string|#f + (offset bootloader-target-offset (thunked) ; symbol|#f + (default (and (bootloader-target-path this-record) + (not (eq? (bootloader-target-type this-record) 'root)) + 'root))) + (device bootloader-target-device (default #f)) ; string|#f + (file-system bootloader-target-file-system (default #f)) ; string|#f + (label bootloader-target-label (default #f)) ; string|#f + (uuid bootloader-target-uuid (default #f))) ; uuid|#f + +(define-condition-type &target-error &error target-error? + (type target-error-type) + (targets target-error-targets)) + +(define (pathcat p1 p2) + (string-append (string-trim-right p1 #\/) "/" (string-trim p2 #\/))) + +(define* (get-target-of-type type targets #:optional (require? #f)) + "Finds a target in TARGETS of type TYPE, optionally providing an error when +not found if REQUIRE? is provided." + (let* ((pred (lambda (target) (eq? type (bootloader-target-type target)))) + (candidates (filter pred targets)) + (ret (if (pair? candidates) (car candidates) #f))) + (if (and require? (not ret)) + (raise (condition + (&message (message (G_ "required, but not provided"))) + (&target-error (type type) (targets targets)))) + ret))) + +(define (parent-of target targets) + (and=> (bootloader-target-offset target) + (cut get-target-of-type <> targets #t))) + +(define (unfold-pathcat target targets) + (let ((quit (lambda (t) (not (and=> t bootloader-target-path))))) + (reduce pathcat #f + (unfold quit bootloader-target-path (cut parent-of <> targets) target)))) + +(define (target-base? t) + (or (not t) (match-record t + (expected? offset device label uuid) + (or device label uuid (not offset) expected?)))) + +(define (type-major? target) (memq target '(root esp disk))) + +(define (ensure types targets end) + (let* ((used-in (cute unfold end identity (cut parent-of <> targets) <>)) + (cons-in (lambda (t) (cons t (used-in t)))) + (ensure (map (cut get-target-of-type <> targets #t) types))) + (filter ->bool (apply append (map cons-in ensure))))) + +(define* (ensure-target-types types targets #:optional (base? #f)) + "Ensures all TYPES are provided in TARGETS. Returns #t iff every ensured +target and its requirements are fully provided. Errors out when a required TYPE +isn't provided. When BASE?, only ensure path requirements up to a device." + (not (any bootloader-target-expected? + (ensure types targets (if base? target-base? not))))) + +(define (ensure-majors types targets) + "Errors out when a required TYPE isn't provided, or when use of multiple major +targets is detected." + (let* ((all (map bootloader-target-type (ensure types targets target-base?))) + (majors (delete-duplicates (filter type-major? all) eq?))) + (if (< (length majors) 2) #t + (raise (condition (&message (message (G_ "multiple major targets used"))) + (&target-error (type majors) (targets targets))))))) + + + +(define (gbegin . gex) + "Sequence provided g-expressions." + (case (length gex) ((0) #f) ((1) (car gex)) (else #~(begin #$@gex)))) + +;; syntax matching on free literals breaks easily, so bind them +(define-syntax-rule (define-literal id) (define-syntax id (syntax-rules ()))) +(define-literal :path) +(define-literal :devpath) +(define-literal :device) +(define-literal :fs) +(define-literal :label) +(define-literal :uuid) + +(define-syntax with-targets + (cut syntax-case <> () + ((_ targets-expr block ...) + (let* ((genvars (compose generate-temporaries iota)) + (targets (car (genvars 1))) + + (path? (cut syntax-case <> (:path) ((_ :path) #t) (_ #f))) + (qualified? (cut syntax-case <> (=>) + ((_ => spec ...) (any path? #'(spec ...))) + (_ #f))) + + (resolve + (lambda (in target base) + (with-syntax ((target target) (base base) (targets targets)) + (syntax-case in + (:path :devpath :device :fs :label :uuid) + ((name _) (not (identifier? #'name)) + #`(_ (syntax-error "binds must be to identifiers" #,in))) + ((name :device) #'(name (bootloader-target-device base))) + ((name :label) #'(name (bootloader-target-label base))) + ((name :uuid) #'(name (bootloader-target-uuid base))) + ((name :fs) #'(name (bootloader-target-file-system base))) + ((name :path) #'(name (unfold-pathcat target targets))) + ((name :devpath) + #'(name (pathcat "/" (bootloader-target-path target)))) + (_ #`(_ (syntax-error "invalid binding spec" #,in))))))) + (binds + (lambda (spec) + (syntax-case spec (=>) + ((type => binds ...) + (with-syntax (((target base) (genvars 2)) (targets targets)) + (append + #`((get (lambda (t) (get-target-of-type t targets #t))) + (target (get type)) + (base (if (target-base? target) target + (get (bootloader-target-offset target))))) + (map (cut resolve <> #'target #'base) #'(binds ...))))) + (_ #f)))) + + (blocks + (cut syntax-case <> () + ((spec ... expr) + (let* ((specs #'(spec ...)) + (lets (apply append (filter-map binds specs))) + (type (cut syntax-case <> (=>) + ((t => _ ...) #'t) (t #'t)))) + (receive (full part) (partition qualified? specs) + #`(and (ensure-majors (list #,@(map type specs)) #,targets) + (ensure-target-types (list #,@(map type part)) + #,targets #t) + (ensure-target-types (list #,@(map type full)) + #,targets #f) + (let* #,lets expr))))) + (bad #'(syntax-error "malformed block" bad))))) + "Using the list TARGETS, evaluate and sequence each BLOCK to produce a +gexp. BLOCK is a set of SPECs followed by an EXPR (evaluating to a gexp). Each +SPEC denotes a type of target to guard EXPR on their existance and +full-qualification. This procedure is linear in regards to BLOCKs. + +SPEC may be of the following forms: +@itemize +@item 'TYPE Requires TYPE to be fully present or promised. Errors otherwise. +@item ('TYPE => (VAR COMPONENT) ...): As type, but also binds variables. TYPE's + COMPONENT is bound to the variable VAR as described below. +@end itemize + +Available COMPONENTs are: +@itemize +@item :path (fully-qualified) +@item :devpath (relative from device) +@item :device (auto-detected from uuid and label if not user-provided) +@item :fs +@item :label +@item :uuid +@end itemize + +Note that installers may be called multiple times with different targets being +fully-qualified. To ensure that targets aren't installed multiple times, make sure +that each BLOCK ensures at least one major target, either directly or indirectly. +Corrolarily, at most one major target should be ensured per BLOCK, under the same +conditions. Major targets originate from disk image handling, and are currently: +@itemize +@item disk +@item root +@item esp +@end itemize" + #`(let ((#,targets targets-expr)) + (apply gbegin (filter ->bool + (list #,@(map blocks #'(block ...)))))))) + (bad #'(syntax-error "must provide targets" bad)))) + ;;; ;;; Bootloader configuration record. @@ -305,10 +511,10 @@ (define (bootloader-configuration-targets config) (define (bootloader-modules) "Return the list of bootloader modules." + ;; don't provide #:warn to prevent mutual imports (all-modules (map (lambda (entry) `(,entry . "gnu/bootloader")) - %load-path) - #:warn warn-about-load-error)) + %load-path))) (define %bootloaders ;; The list of publically-known bootloaders. diff --git a/guix/ui.scm b/guix/ui.scm index 9db6f6e9d7..1c9300c9eb 100644 --- a/guix/ui.scm +++ b/guix/ui.scm @@ -36,6 +36,8 @@ ;;; along with GNU Guix. If not, see . (define-module (guix ui) + #:use-module ((gnu bootloader) + #:select (target-error? target-error-type target-error-targets)) #:use-module (guix i18n) #:use-module (guix colors) #:use-module (guix diagnostics) @@ -857,6 +859,12 @@ (define (call-with-error-handling thunk) (invoke-error-stop-signal c) (cons (invoke-error-program c) (invoke-error-arguments c)))) + ((target-error? c) + (leave (G_ "bootloader-target '~a'~@[: ~a~] ~ + among the following targets:~%~{~y~}") + (target-error-type c) + (and (message-condition? c) (condition-message c)) + (target-error-targets c))) ((formatted-message? c) (apply report-error