60/73: gnu: zig: Build reproducibly.

[guix-commits]

hako pushed a commit to branch wip-zig-bootstrap
in repository guix.

commit 3730493ab8d310323068df502237e579dabaee80
Author: Hilton Chain <hako@ultrarare.space>
AuthorDate: Tue Nov 19 20:27:49 2024 +0800

    gnu: zig: Build reproducibly.
    
    * guix/build/zig-utils.scm; New file.
    * Makefile.am (MODULES): Add it.
    * guix/build-system/zig.scm (%zig-build-system-modules): Add it.
    * guix/build/zig-build-system.scm (configure,zig-target): Move to zig-utils
    and export.
    * gnu/packages/zig.scm (zig-0.9)[arguments]: Add zig-build-system modules.
    <#:configure-flags>: Set ZIG_TARGET_TRIPLE for native builds too.
    Move applicable flags from zig-0.10 here.
    <#:phases>: Apply 'zig-configure.
    Remove 'set-cache-dir.
    (zig-0.10)[arguments]<#:configure-flags>: Adjust accordingly.
    (zig-0.10.0-610)[arguments]<#:configure-flags>: Remove ZIG_TARGET_TRIPLE.
    
    Change-Id: Ie5d7d249ae7f199409136bf201d95cad2dc7a781
---
 Makefile.am                     |  1 +
 gnu/packages/zig.scm            | 52 +++++++++++++++++++-----------
 guix/build-system/zig.scm       |  1 +
 guix/build/zig-build-system.scm | 39 ++--------------------
 guix/build/zig-utils.scm        | 71 +++++++++++++++++++++++++++++++++++++++++
 5 files changed, 109 insertions(+), 55 deletions(-)

diff --git a/Makefile.am b/Makefile.am
index e94ba87797..0e4883b6bb 100644
--- a/Makefile.am
+++ b/Makefile.am
@@ -284,6 +284,7 @@ MODULES =                                   \
   guix/build/bournish.scm                      \
   guix/build/qt-utils.scm                      \
   guix/build/zig-build-system.scm              \
+  guix/build/zig-utils.scm                     \
   guix/build/make-bootstrap.scm                        \
   guix/search-paths.scm                                \
   guix/packages.scm                            \
diff --git a/gnu/packages/zig.scm b/gnu/packages/zig.scm
index 00bd2324e9..19b644d8a2 100644
--- a/gnu/packages/zig.scm
+++ b/gnu/packages/zig.scm
@@ -22,6 +22,7 @@
 (define-module (gnu packages zig)
   #:use-module (guix gexp)
   #:use-module (guix packages)
+  #:use-module (guix platform)
   #:use-module (guix utils)
   #:use-module (guix download)
   #:use-module (guix git-download)
@@ -73,11 +74,24 @@
     (build-system cmake-build-system)
     (arguments
      (list
+      #:imported-modules
+      (cons '(guix build zig-utils)
+            %cmake-build-system-modules)
+      #:modules
+      (cons '(guix build zig-utils)
+            '((guix build cmake-build-system)
+              (guix build utils)))
       #:configure-flags
-      #~(list #$@(if (%current-target-system)
-                     (list (string-append "-DZIG_TARGET_TRIPLE="
-                                          (%current-target-system)))
-                     '()))
+      #~(list (string-append "-DZIG_LIB_DIR=" #$output "/lib/zig")
+              "-DZIG_TARGET_MCPU=baseline"
+              (string-append
+               "-DZIG_TARGET_TRIPLE="
+               (zig-target
+                #$(platform-target
+                   (lookup-platform-by-target-or-system
+                    (or (%current-target-system)
+                        (%current-system))))))
+              "-DZIG_USE_LLVM_CONFIG=ON")
       #:out-of-source? #f         ; for tests
       ;; There are too many unclear test failures.
       #:tests? (not (or (target-riscv64?)
@@ -100,15 +114,14 @@
                          ;; Is this symbol x86 only in glibc?
                          ((".*link_static_lib_as_system_lib.*") "")))))
                  '())
-          (add-after 'configure 'set-cache-dir
-            (lambda _
-              ;; Set cache dir, otherwise Zig looks for `$HOME/.cache'.
-              (setenv "ZIG_GLOBAL_CACHE_DIR"
-                      (string-append (getcwd) "/zig-cache"))))
+          (add-before 'configure 'zig-configure zig-configure)
           (delete 'check)
           (add-after 'install 'check
             (lambda* (#:key tests? #:allow-other-keys)
               (when tests?
+                ;; error(libc_installation): msvc_lib_dir may not be empty for
+                ;; windows-msvc.
+                (unsetenv "ZIG_LIBC")
                 (invoke (string-append #$output "/bin/zig")
                         ;; Testing the standard library takes >7.5GB RAM, and
                         ;; will fail if it is OOM-killed.  The 'test-toolchain'
@@ -177,20 +190,13 @@ toolchain.  Among other features it provides
      (substitute-keyword-arguments
          (strip-keyword-arguments '(#:tests?) (package-arguments zig-0.9))
        ((#:configure-flags flags ''())
-        #~(cons* "-DZIG_TARGET_MCPU=baseline"
-                 "-DZIG_SHARED_LLVM=ON"
-                 (string-append "-DZIG_LIB_DIR=" #$output "/lib/zig")
-                 #$flags))
+        #~(cons "-DZIG_SHARED_LLVM=ON"
+                #$flags))
        ((#:phases phases '%standard-phases)
         #~(modify-phases #$phases
             #$@(if (target-riscv64?)
                    `((delete 'adjust-tests))
                    '())
-            (add-after 'unpack 'set-CC
-              (lambda _
-                ;; Set CC, since the stage 2 zig relies on it to find the libc
-                ;; installation, and otherwise silently links against its own.
-                (setenv "CC" #$(cc-for-target))))
             (add-after 'patch-source-shebangs 'patch-more-shebangs
               (lambda* (#:key inputs #:allow-other-keys)
                 ;; Zig uses information about an ELF file to determine the
@@ -200,6 +206,9 @@ toolchain.  Among other features it provides
             (replace 'check
               (lambda* (#:key tests? #:allow-other-keys)
                 (when tests?
+                  ;; error(libc_installation): msvc_lib_dir may not be empty 
for
+                  ;; windows-msvc.
+                  (unsetenv "ZIG_LIBC")
                   (invoke (string-append #$output "/bin/zig")
                           "build" "test"
                           ;; We're not testing the compiler bootstrap chain.
@@ -268,6 +277,13 @@ toolchain.  Among other features it provides
        (substitute-keyword-arguments (package-arguments base)
          ;; Patch for fixing RUNPATH not applied to intermediate versions.
          ((#:validate-runpath? _ #t) #f)
+         ;; Patch for cross-compilation not applied to intermediate versions.
+         ((#:modules modules '())
+          (cons '(srfi srfi-1) modules))
+         ((#:configure-flags flags #~())
+          #~(filter (lambda (flag)
+                      (not (string-contains flag "ZIG_TARGET_TRIPLE")))
+                    #$flags))
          ;; Disable tests for intermediate versions.
          ((#:tests? _ #t) #f)
          ((#:phases phases '%standard-phases)
diff --git a/guix/build-system/zig.scm b/guix/build-system/zig.scm
index ad8a96b607..97bd9361c8 100644
--- a/guix/build-system/zig.scm
+++ b/guix/build-system/zig.scm
@@ -39,6 +39,7 @@
 (define %zig-build-system-modules
   ;; Build-side modules imported by default.
   `((guix build zig-build-system)
+    (guix build zig-utils)
     ,@%default-gnu-imported-modules))
 
 (define* (zig-build name inputs
diff --git a/guix/build/zig-build-system.scm b/guix/build/zig-build-system.scm
index f79d7dfb66..005c4c19e3 100644
--- a/guix/build/zig-build-system.scm
+++ b/guix/build/zig-build-system.scm
@@ -19,6 +19,7 @@
 (define-module (guix build zig-build-system)
   #:use-module ((guix build gnu-build-system) #:prefix gnu:)
   #:use-module (guix build utils)
+  #:use-module (guix build zig-utils)
   #:use-module (ice-9 popen)
   #:use-module (ice-9 rdelim)
   #:use-module (ice-9 ftw)
@@ -32,42 +33,6 @@
 
 ;; Interesting guide here:
 ;; https://github.com/riverwm/river/blob/master/PACKAGING.md
-(define global-cache-dir "zig-cache")
-
-(define* (configure #:key inputs target #:allow-other-keys)
-  ;; Set cache dir, otherwise Zig looks for `$HOME/.cache'.
-  (setenv "ZIG_GLOBAL_CACHE_DIR" global-cache-dir)
-
-  (setenv "PKG_CONFIG"
-          (if target
-              (string-append target "-pkg-config")
-              "pkg-config"))
-
-  ;; Libc paths for target.
-  (let ((libc (assoc-ref inputs (if target "cross-libc" "libc")))
-        (port (open-file "/tmp/guix-zig-libc-paths" "w" #:encoding "utf8")))
-    (display
-     (string-append "\
-include_dir=" libc "/include
-sys_include_dir=" libc "/include
-crt_dir=" libc "/lib
-msvc_lib_dir=
-kernel32_lib_dir=
-gcc_dir=")
-     port)
-    (close-port port))
-  (setenv "ZIG_LIBC" "/tmp/guix-zig-libc-paths"))
-
-(define (zig-target target)
-  (cond ((string=? "i686-linux-gnu" target)
-         "x86-linux-gnu")
-        ((string=? "i586-pc-gnu" target)
-         "x86-hurd-gnu")
-        ((string=? "x86_64-w64-mingw32" target)
-         "x86_64-windows-gnu")
-        ((string=? "i686-w64-mingw32" target)
-         "x86-windows-gnu")
-        (else target)))
 
 (define* (build #:key
                 zig-build-flags
@@ -117,7 +82,7 @@ gcc_dir=")
 (define %standard-phases
   (modify-phases gnu:%standard-phases
     (delete 'bootstrap)
-    (replace 'configure configure)
+    (replace 'configure zig-configure)
     (replace 'build build)
     (replace 'check check)
     (replace 'install install)))
diff --git a/guix/build/zig-utils.scm b/guix/build/zig-utils.scm
new file mode 100644
index 0000000000..f336c71c5e
--- /dev/null
+++ b/guix/build/zig-utils.scm
@@ -0,0 +1,71 @@
+;;; GNU Guix --- Functional package management for GNU
+;;; Copyright © 2024 Hilton Chain <hako@ultrarare.space>
+;;; Copyright © 2024 Efraim Flashner <efraim@flashner.co.il>
+;;;
+;;; This file is part of GNU Guix.
+;;;
+;;; GNU Guix is free software; you can redistribute it and/or modify it
+;;; under the terms of the GNU General Public License as published by
+;;; the Free Software Foundation; either version 3 of the License, or (at
+;;; your option) any later version.
+;;;
+;;; GNU Guix is distributed in the hope that it will be useful, but
+;;; WITHOUT ANY WARRANTY; without even the implied warranty of
+;;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+;;; GNU General Public License for more details.
+;;;
+;;; You should have received a copy of the GNU General Public License
+;;; along with GNU Guix.  If not, see <http://www.gnu.org/licenses/>.
+
+(define-module (guix build zig-utils)
+  #:use-module (guix build utils)
+  #:export (zig-configure
+            zig-target))
+
+;;;
+;;;  Common procedures for zig and zig-build-system.
+;;;
+
+(define* (zig-configure #:key inputs target #:allow-other-keys)
+  ;; Set cache dir, otherwise Zig looks for `$HOME/.cache'.
+  (setenv "ZIG_GLOBAL_CACHE_DIR" "/tmp/zig-cache")
+  (setenv "ZIG_LOCAL_CACHE_DIR"  "/tmp/zig-cache")
+
+  ;; XXX: Required for unpatched intermediade versions?
+  ;; Set CC, since the stage 2 zig relies on it to find the libc
+  ;; installation, and otherwise silently links against its own.
+  (setenv "CC"
+          (if target
+              (string-append target "-gcc")
+              "gcc"))
+
+  (setenv "PKG_CONFIG"
+          (if target
+              (string-append target "-pkg-config")
+              "pkg-config"))
+
+  ;; Libc paths for target.
+  (let ((libc (assoc-ref inputs (if target "cross-libc" "libc")))
+        (port (open-file "/tmp/guix-zig-libc-paths" "w" #:encoding "utf8")))
+    (display
+     (string-append "\
+include_dir=" libc "/include
+sys_include_dir=" libc "/include
+crt_dir=" libc "/lib
+msvc_lib_dir=
+kernel32_lib_dir=
+gcc_dir=")
+     port)
+    (close-port port))
+  (setenv "ZIG_LIBC" "/tmp/guix-zig-libc-paths"))
+
+(define (zig-target target)
+  (cond ((string=? "i686-linux-gnu" target)
+         "x86-linux-gnu")
+        ((string=? "i586-pc-gnu" target)
+         "x86-hurd-gnu")
+        ((string=? "x86_64-w64-mingw32" target)
+         "x86_64-windows-gnu")
+        ((string=? "i686-w64-mingw32" target)
+         "x86-windows-gnu")
+        (else target)))