diff mbox series

[bug#55220,v2,2/6] platform: Add discovery support.

Message ID 20220507161126.14553-3-othacehe@gnu.org
State New
Headers
Series Add --list-systems and --list-targets options. |

Commit Message

Mathieu Othacehe May 7, 2022, 4:11 p.m. UTC 
* gnu/platform.scm (platform-modules, systems, targets,
lookup-platform-by-system, lookup-platform-by-target,
lookup-platform-by-target-or-system
platform-system->target,
platform-target->system): New procedures.
(%platforms): New variable.

Signed-off-by: Mathieu Othacehe <othacehe@gnu.org>
---
 gnu/platform.scm | 101 +++++++++++++++++++++++++++++++++++++++++++++--
 1 file changed, 98 insertions(+), 3 deletions(-)

Comments

Maxime Devos May 9, 2022, 8:58 p.m. UTC | #1 
Mathieu Othacehe schreef op za 07-05-2022 om 18:11 [+0200]:
> * gnu/platform.scm (platform-modules, systems, targets,
> lookup-platform-by-system, lookup-platform-by-target,
> lookup-platform-by-target-or-system
> platform-system->target,
> platform-target->system): New procedures.
> (%platforms): New variable.
> [...]

Food for later: I'm wondering if it would make sense to (long term)
let %current-system/%current-target-system be a <platform> record
and eliminate nix-system->gnu-triplet, gnu-triplet->nix-system in
favour of platform-target & platform-system.  That could avoid the
problem of forgetting that targets and nix systems have different
formats, making a class of cross-compilation bugs less likely ...

Greetings,
Maxime.
Maxim Cournoyer May 22, 2022, 1:34 a.m. UTC | #2 
Hi,

Maxime Devos <maximedevos@telenet.be> writes:

> Mathieu Othacehe schreef op za 07-05-2022 om 18:11 [+0200]:
>> * gnu/platform.scm (platform-modules, systems, targets,
>> lookup-platform-by-system, lookup-platform-by-target,
>> lookup-platform-by-target-or-system
>> platform-system->target,
>> platform-target->system): New procedures.
>> (%platforms): New variable.
>> [...]
>
> Food for later: I'm wondering if it would make sense to (long term)
> let %current-system/%current-target-system be a <platform> record
> and eliminate nix-system->gnu-triplet, gnu-triplet->nix-system in
> favour of platform-target & platform-system.  That could avoid the
> problem of forgetting that targets and nix systems have different
> formats, making a class of cross-compilation bugs less likely ...

That sounds like a good idea to me.  I was bit by that in the past,
probably not for the last time.

Maxim
Mathieu Othacehe May 22, 2022, 1:06 p.m. UTC | #3 
Hey,

> Food for later: I'm wondering if it would make sense to (long term)
> let %current-system/%current-target-system be a <platform> record
> and eliminate nix-system->gnu-triplet, gnu-triplet->nix-system in
> favour of platform-target & platform-system.  That could avoid the
> problem of forgetting that targets and nix systems have different
> formats, making a class of cross-compilation bugs less likely ...

I think that's what we should aim for the future. Getting rid of
system/triplet strings and using platforms everywhere instead will be
less error prone, even if there is still some work to get there.

Mathieu
diff mbox series

Patch

diff --git a/gnu/platform.scm b/gnu/platform.scm
index bb6519c71a..4c5211e107 100644
--- a/gnu/platform.scm
+++ b/gnu/platform.scm
@@ -17,22 +17,117 @@ 
 ;;; along with GNU Guix.  If not, see <http://www.gnu.org/licenses/>.
 
 (define-module (gnu platform)
+  #:use-module (guix discovery)
+  #:use-module (guix memoization)
   #:use-module (guix records)
+  #:use-module (guix ui)
+  #:use-module (srfi srfi-1)
   #:export (platform
             platform?
             platform-target
             platform-system
-            platform-linux-architecture))
+            platform-linux-architecture
+
+            platform-modules
+            platforms
+            lookup-platform-by-system
+            lookup-platform-by-target
+            lookup-platform-by-target-or-system
+            platform-system->target
+            platform-target->system
+
+            systems
+            targets))
 
 
 ;;;
 ;;; Platform record.
 ;;;
 
-;; Description of a platform supported by the GNU system.
+;; Description of a platform supported by GNU Guix.
+;;
+;; The 'target' field must be a valid GNU triplet as defined here:
+;; https://www.gnu.org/software/autoconf/manual/autoconf-2.68/html_node/Specifying-Target-Triplets.html.
+;; It is used for cross-compilation purposes.
+;;
+;; The 'system' field is the name of the corresponding system as defined in
+;; the (gnu packages bootstrap) module.  It can be for instance
+;; "aarch64-linux" or "armhf-linux".  It is used to emulate a different host
+;; architecture, for instance i686-linux on x86_64-linux-gnu, or armhf-linux
+;; on x86_64-linux, using the QEMU binfmt transparent emulation mechanism.
+;;
+;; The 'linux-architecture' is only relevant if the kernel is Linux.  In that
+;; case, it corresponds to the ARCH variable used when building Linux.
 (define-record-type* <platform> platform make-platform
   platform?
   (target             platform-target)               ;"x86_64-linux-gnu"
   (system             platform-system)               ;"x86_64-linux"
-  (linux-architecture platform-linux-architecture    ;"amd64"
+  (linux-architecture platform-linux-architecture    ;"x86"
                       (default #f)))
+
+;;;
+;;; Platforms.
+;;;
+
+(define (platform-modules)
+  "Return the list of platform modules."
+  (all-modules (map (lambda (entry)
+                      `(,entry . "gnu/platforms"))
+                    %load-path)
+               #:warn warn-about-load-error))
+
+(define platforms
+  ;; The list of publically-known platforms.
+  (memoize
+   (lambda ()
+     (fold-module-public-variables (lambda (obj result)
+                                     (if (platform? obj)
+                                         (cons obj result)
+                                         result))
+                                   '()
+                                   (platform-modules)))))
+
+(define (lookup-platform-by-system system)
+  "Return the platform corresponding to the given SYSTEM."
+  (find (lambda (platform)
+          (let ((s (platform-system platform)))
+            (and (string? s) (string=? s system))))
+        (platforms)))
+
+(define (lookup-platform-by-target target)
+  "Return the platform corresponding to the given TARGET."
+  (find (lambda (platform)
+          (let ((t (platform-target platform)))
+            (and (string? t) (string=? t target))))
+        (platforms)))
+
+(define (lookup-platform-by-target-or-system target-or-system)
+  "Return the platform corresponding to the given TARGET or SYSTEM."
+  (or (lookup-platform-by-target target-or-system)
+      (lookup-platform-by-system target-or-system)))
+
+(define (platform-system->target system)
+  "Return the target matching the given SYSTEM if it exists or false
+otherwise."
+  (let ((platform (lookup-platform-by-system system)))
+    (and=> platform platform-target)))
+
+(define (platform-target->system target)
+  "Return the system matching the given TARGET if it exists or false
+otherwise."
+  (let ((platform (lookup-platform-by-target system)))
+    (and=> platform platform-system)))
+
+
+;;;
+;;; Systems & Targets.
+;;;
+
+(define (systems)
+  "Return the list of supported systems."
+  (delete-duplicates
+   (filter-map platform-system (platforms))))
+
+(define (targets)
+  "Return the list of supported targets."
+  (map platform-target (platforms)))