build/go: Support cross compiling.

* guix/build-system/go.scm (go-target): New procedure.
(go-build): Add goarch, goos keywords. Adjust bag depending if doing a
native or cross compile.
(go-cross-build): New procedure.
* guix/build/go-build-system.scm (setup-go-environment): Accept goarch,
goos keywords. Set go environment variables based on target architecture.
* doc/guix.texi (Build Systems): Mention new go-build-system keywords.
This commit is contained in:
Efraim Flashner 2021-04-26 21:13:06 +03:00
parent 43f9757f80
commit de4f5df95d
No known key found for this signature in database
GPG key ID: 41AAE7DCCA3D8351
3 changed files with 171 additions and 17 deletions

View file

@ -7759,6 +7759,13 @@ Packages that provide Go libraries should install their source code into
the built output. The key @code{#:install-source?}, which defaults to the built output. The key @code{#:install-source?}, which defaults to
@code{#t}, controls whether or not the source code is installed. It can @code{#t}, controls whether or not the source code is installed. It can
be set to @code{#f} for packages that only provide executable files. be set to @code{#f} for packages that only provide executable files.
Packages can be cross-built, and if a specific architecture or operating
system is desired then the keywords @code{#:goarch} and @code{#:goos}
can be used to force the package to be built for that architecture and
operating system. The combinations known to Go can be found
@url{"https://golang.org/doc/install/source#environment", in their
documentation}.
@end defvr @end defvr
@defvr {Scheme Variable} glib-or-gtk-build-system @defvr {Scheme Variable} glib-or-gtk-build-system

View file

@ -2,6 +2,7 @@
;;; Copyright © 2016 Petter <petter@mykolab.ch> ;;; Copyright © 2016 Petter <petter@mykolab.ch>
;;; Copyright © 2017 Leo Famulari <leo@famulari.name> ;;; Copyright © 2017 Leo Famulari <leo@famulari.name>
;;; Copyright © 2020 Jakub Kądziołka <kuba@kadziolka.net> ;;; Copyright © 2020 Jakub Kądziołka <kuba@kadziolka.net>
;;; Copyright © 2021 Efraim Flashner <efraim@flashner.co.il>
;;; ;;;
;;; This file is part of GNU Guix. ;;; This file is part of GNU Guix.
;;; ;;;
@ -27,6 +28,7 @@ (define-module (guix build-system go)
#:use-module (guix packages) #:use-module (guix packages)
#:use-module (ice-9 match) #:use-module (ice-9 match)
#:use-module (ice-9 regex) #:use-module (ice-9 regex)
#:use-module (srfi srfi-1)
#:export (%go-build-system-modules #:export (%go-build-system-modules
go-build go-build
go-build-system go-build-system
@ -78,6 +80,24 @@ (define (go-pseudo-version? version)
commit hash and its date rather than a proper release tag." commit hash and its date rather than a proper release tag."
(regexp-exec %go-pseudo-version-rx version)) (regexp-exec %go-pseudo-version-rx version))
(define (go-target target)
;; Parse the nix-system equivalent of the target and set the
;; target for compilation accordingly.
(match (string-split (gnu-triplet->nix-system target) #\-)
((arch os)
(list (match arch
("aarch64" "arm64")
("armhf" "arm")
("powerpc64le" "ppc64le")
("powerpc64" "ppc64")
("i686" "386")
("x86_64" "amd64")
("mips64el" "mips64le")
(_ arch))
(match os
((or "mingw32" "cygwin") "windows")
(_ os))))))
(define %go-build-system-modules (define %go-build-system-modules
;; Build-side modules imported and used by default. ;; Build-side modules imported and used by default.
`((guix build go-build-system) `((guix build go-build-system)
@ -98,22 +118,37 @@ (define* (lower name
(define private-keywords (define private-keywords
'(#:source #:target #:go #:inputs #:native-inputs)) '(#:source #:target #:go #:inputs #:native-inputs))
(and (not target) ;XXX: no cross-compilation (bag
(bag (name name)
(name name) (system system)
(system system) (target target)
(host-inputs `(,@(if source (build-inputs `(,@(if source
`(("source" ,source)) `(("source" ,source))
'()) '())
,@inputs ,@`(("go" ,go))
,@native-inputs
,@(if target '() inputs)
,@(if target
;; Use the standard cross inputs of
;; 'gnu-build-system'.
(standard-cross-packages target 'host)
'())
;; Keep the standard inputs of 'gnu-build-system'.
,@(standard-packages)))
(host-inputs (if target inputs '()))
;; Keep the standard inputs of 'gnu-build-system'. ;; The cross-libc is really a target package, but for bootstrapping
,@(standard-packages))) ;; reasons, we can't put it in 'host-inputs'. Namely, 'cross-gcc' is a
(build-inputs `(("go" ,go) ;; native package, so it would end up using a "native" variant of
,@native-inputs)) ;; 'cross-libc' (built with 'gnu-build'), whereas all the other packages
(outputs outputs) ;; would use a target variant (built with 'gnu-cross-build'.)
(build go-build) (target-inputs (if target
(arguments (strip-keyword-arguments private-keywords arguments))))) (standard-cross-packages target 'target)
'()))
(outputs outputs)
(build (if target go-cross-build go-build))
(arguments (strip-keyword-arguments private-keywords arguments))))
(define* (go-build store name inputs (define* (go-build store name inputs
#:key #:key
@ -128,6 +163,8 @@ (define* (go-build store name inputs
(tests? #t) (tests? #t)
(allow-go-reference? #f) (allow-go-reference? #f)
(system (%current-system)) (system (%current-system))
(goarch (first (go-target (%current-system))))
(goos (last (go-target (%current-system))))
(guile #f) (guile #f)
(imported-modules %go-build-system-modules) (imported-modules %go-build-system-modules)
(modules '((guix build go-build-system) (modules '((guix build go-build-system)
@ -147,6 +184,8 @@ (define builder
#:system ,system #:system ,system
#:phases ,phases #:phases ,phases
#:outputs %outputs #:outputs %outputs
#:goarch ,goarch
#:goos ,goos
#:search-paths ',(map search-path-specification->sexp #:search-paths ',(map search-path-specification->sexp
search-paths) search-paths)
#:install-source? ,install-source? #:install-source? ,install-source?
@ -174,6 +213,98 @@ (define guile-for-build
#:outputs outputs #:outputs outputs
#:guile-for-build guile-for-build)) #:guile-for-build guile-for-build))
(define* (go-cross-build store name
#:key
target native-drvs target-drvs
(phases '(@ (guix build go-build-system)
%standard-phases))
(outputs '("out"))
(search-paths '())
(native-search-paths '())
(install-source? #t)
(import-path "")
(unpack-path "")
(build-flags ''())
(tests? #f) ; nothing can be done
(allow-go-reference? #f)
(system (%current-system))
(goarch (first (go-target target)))
(goos (last (go-target target)))
(guile #f)
(imported-modules %go-build-system-modules)
(modules '((guix build go-build-system)
(guix build union)
(guix build utils))))
"Cross-build NAME using GO, where TARGET is a GNU triplet and with INPUTS."
(define builder
`(begin
(use-modules ,@modules)
(let ()
(define %build-host-inputs
',(map (match-lambda
((name (? derivation? drv) sub ...)
`(,name . ,(apply derivation->output-path drv sub)))
((name path)
`(,name . ,path)))
native-drvs))
(define %build-target-inputs
',(map (match-lambda
((name (? derivation? drv) sub ...)
`(,name . ,(apply derivation->output-path drv sub)))
((name (? package? pkg) sub ...)
(let ((drv (package-cross-derivation store pkg
target system)))
`(,name . ,(apply derivation->output-path drv sub))))
((name path)
`(,name . ,path)))
target-drvs))
(go-build #:name ,name
#:source ,(match (assoc-ref native-drvs "source")
(((? derivation? source))
(derivation->output-path source))
((source)
source)
(source
source))
#:system ,system
#:phases ,phases
#:outputs %outputs
#:target ,target
#:goarch ,goarch
#:goos ,goos
#:inputs %build-target-inputs
#:native-inputs %build-host-inputs
#:search-paths ',(map search-path-specification->sexp
search-paths)
#:native-search-paths ',(map
search-path-specification->sexp
native-search-paths)
#:install-source? ,install-source?
#:import-path ,import-path
#:unpack-path ,unpack-path
#:build-flags ,build-flags
#:tests? ,tests?
#:allow-go-reference? ,allow-go-reference?
#:inputs %build-inputs))))
(define guile-for-build
(match guile
((? package?)
(package-derivation store guile system #:graft? #f))
(#f ; the default
(let* ((distro (resolve-interface '(gnu packages commencement)))
(guile (module-ref distro 'guile-final)))
(package-derivation store guile system #:graft? #f)))))
(build-expression->derivation store name builder
#:system system
#:inputs (append native-drvs target-drvs)
#:outputs outputs
#:modules imported-modules
#:guile-for-build guile-for-build))
(define go-build-system (define go-build-system
(build-system (build-system
(name 'go) (name 'go)

View file

@ -4,7 +4,7 @@
;;; Copyright © 2019 Maxim Cournoyer <maxim.cournoyer@gmail.com> ;;; Copyright © 2019 Maxim Cournoyer <maxim.cournoyer@gmail.com>
;;; Copyright © 2020 Jack Hill <jackhill@jackhill.us> ;;; Copyright © 2020 Jack Hill <jackhill@jackhill.us>
;;; Copyright © 2020 Jakub Kądziołka <kuba@kadziolka.net> ;;; Copyright © 2020 Jakub Kądziołka <kuba@kadziolka.net>
;;; Copyright © 2020 Efraim Flashner <efraim@flashner.co.il> ;;; Copyright © 2020, 2021 Efraim Flashner <efraim@flashner.co.il>
;;; ;;;
;;; This file is part of GNU Guix. ;;; This file is part of GNU Guix.
;;; ;;;
@ -131,7 +131,7 @@ (define-module (guix build go-build-system)
;; ;;
;; Code: ;; Code:
(define* (setup-go-environment #:key inputs outputs #:allow-other-keys) (define* (setup-go-environment #:key inputs outputs goos goarch #:allow-other-keys)
"Prepare a Go build environment for INPUTS and OUTPUTS. Build a file system "Prepare a Go build environment for INPUTS and OUTPUTS. Build a file system
union of INPUTS. Export GOPATH, which helps the compiler find the source code union of INPUTS. Export GOPATH, which helps the compiler find the source code
of the package being built and its dependencies, and GOBIN, which determines of the package being built and its dependencies, and GOBIN, which determines
@ -149,6 +149,22 @@ (define* (setup-go-environment #:key inputs outputs #:allow-other-keys)
;; GOPATH behavior. ;; GOPATH behavior.
(setenv "GO111MODULE" "off") (setenv "GO111MODULE" "off")
(setenv "GOBIN" (string-append (assoc-ref outputs "out") "/bin")) (setenv "GOBIN" (string-append (assoc-ref outputs "out") "/bin"))
;; Make sure we're building for the correct architecture and OS targets
;; that Guix targets.
(setenv "GOARCH" goarch)
(setenv "GOOS" goos)
(match goarch
("arm"
(setenv "GOARM" "7"))
((or "mips" "mipsel")
(setenv "GOMIPS" "hardfloat"))
((or "mips64" "mips64le")
(setenv "GOMIPS64" "hardfloat"))
((or "ppc64" "ppc64le")
(setenv "GOPPC64" "power8"))
(_ #t))
(let ((tmpdir (tmpnam))) (let ((tmpdir (tmpnam)))
(match (go-inputs inputs) (match (go-inputs inputs)
(((names . directories) ...) (((names . directories) ...)