summaryrefslogtreecommitdiff
path: root/var/spack/repos/builtin/packages/go-bootstrap/package.py
blob: 0a77c7ffc9c27ecc5090fa333990176ef2574f39 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
# Copyright 2013-2023 Lawrence Livermore National Security, LLC and other
# Spack Project Developers. See the top-level COPYRIGHT file for details.
#
# SPDX-License-Identifier: (Apache-2.0 OR MIT)

import re

from spack.package import *

# THIS PACKAGE SHOULD NOT EXIST
# it exists to make up for the inability to:
# * use an external go compiler
# * have go depend on itself
# * have a sensible way to find gccgo without a dep on gcc


class GoBootstrap(Package):
    """Old C-bootstrapped go to bootstrap real go"""

    homepage = "https://golang.org"

    extendable = True

    # NOTE: Go@1.4.x is the only supported bootstrapping compiler because all
    # later versions require a Go compiler to build.
    # See: https://golang.org/doc/install/source#go14 and
    # https://github.com/golang/go/issues/17545 and
    # https://github.com/golang/go/issues/16352
    version(
        "1.4-bootstrap-20171003",
        sha256="f4ff5b5eb3a3cae1c993723f3eab519c5bae18866b5e5f96fe1102f0cb5c3e52",
        url="https://dl.google.com/go/go1.4-bootstrap-20171003.tar.gz",
    )
    version(
        "1.4-bootstrap-20170531",
        sha256="49f806f66762077861b7de7081f586995940772d29d4c45068c134441a743fa2",
        url="https://storage.googleapis.com/golang/go1.4-bootstrap-20170531.tar.gz",
    )
    version(
        "1.4-bootstrap-20161024",
        sha256="398c70d9d10541ba9352974cc585c43220b6d8dbcd804ba2c9bd2fbf35fab286",
        url="https://storage.googleapis.com/golang/go1.4-bootstrap-20161024.tar.gz",
    )

    provides("golang@:1.4-bootstrap-20171003")

    depends_on("git", type=("build", "link", "run"))

    conflicts(
        "os=monterey",
        msg="go-bootstrap won't build on MacOS Monterey: "
        "try `brew install go` and `spack external find go`",
    )
    conflicts("target=aarch64:", msg="Go bootstrap doesn't support aarch64 architectures")

    # This virtual package allows a fallback to gccgo for aarch64,
    # where go-bootstrap cannot be built(aarch64 was added with Go 1.5)
    provides("go-external-or-gccgo-bootstrap")

    # Support for aarch64 was added in Go 1.5, use an external package or gccgo instead:
    conflicts("@:1.4", when="target=aarch64:")

    executables = ["^go$"]

    # When the user adds a go compiler using ``spack external find go-bootstrap``,
    # this lets us get the version for packages.yaml. Then, the solver can avoid
    # to build the bootstrap go compiler(for aarch64, it's only gccgo) from source:
    @classmethod
    def determine_version(cls, exe):
        """Return the version of an externally provided go executable or ``None``"""
        output = Executable(exe)("version", output=str, error=str)
        match = re.search(r"go version go(\S+)", output)
        return match.group(1) if match else None

    def patch(self):
        if self.spec.satisfies("@:1.4.3"):
            # NOTE: Older versions of Go attempt to download external files that have
            # since been moved while running the test suite.  This patch modifies the
            # test files so that these tests don't cause false failures.
            # See: https://github.com/golang/go/issues/15694
            test_suite_file = FileFilter(join_path("src", "run.bash"))
            test_suite_file.filter(
                r"^(.*)(\$GOROOT/src/cmd/api/run.go)(.*)$",
                r"# \1\2\3",
            )

        # Go uses a hardcoded limit of 4096 bytes for its printf functions.
        # This can cause environment variables to be truncated.
        filter_file("char buf[4096];", "char buf[131072];", "src/cmd/dist/unix.c", string=True)

    def install(self, spec, prefix):
        env["CGO_ENABLED"] = "0"
        bash = which("bash")
        with working_dir("src"):
            bash("{0}.bash".format("all" if self.run_tests else "make"))

        install_tree(".", prefix)

    def setup_dependent_build_environment(self, env, dependent_spec):
        """Set GOROOT_BOOTSTRAP: When using an external compiler, get its GOROOT env"""
        if self.spec.external:
            # Use the go compiler added by ``spack external find go-bootstrap``:
            goroot = Executable(self.spec.prefix.bin.go)("env", "GOROOT", output=str)
        else:
            goroot = self.spec.prefix
        env.set("GOROOT_BOOTSTRAP", goroot)

    def setup_build_environment(self, env):
        env.set("GOROOT_FINAL", self.spec.prefix)