src/make.bash

   1 #!/usr/bin/env bash
   2 # Copyright 2009 The Go Authors. All rights reserved.
   3 # Use of this source code is governed by a BSD-style
   4 # license that can be found in the LICENSE file.
   5
   6 # See golang.org/s/go15bootstrap for an overview of the build process.
   7
   8 # Environment variables that control make.bash:
   9 #
  10 # GOROOT_FINAL: The expected final Go root, baked into binaries.
  11 # The default is the location of the Go tree during the build.
  12 #
  13 # GOHOSTARCH: The architecture for host tools (compilers and
  14 # binaries).  Binaries of this type must be executable on the current
  15 # system, so the only common reason to set this is to set
  16 # GOHOSTARCH=386 on an amd64 machine.
  17 #
  18 # GOARCH: The target architecture for installed packages and tools.
  19 #
  20 # GOOS: The target operating system for installed packages and tools.
  21 #
  22 # GO_GCFLAGS: Additional go tool compile arguments to use when
  23 # building the packages and commands.
  24 #
  25 # GO_LDFLAGS: Additional go tool link arguments to use when
  26 # building the commands.
  27 #
  28 # CGO_ENABLED: Controls cgo usage during the build. Set it to 1
  29 # to include all cgo related files, .c and .go file with "cgo"
  30 # build directive, in the build. Set it to 0 to ignore them.
  31 #
  32 # GO_EXTLINK_ENABLED: Set to 1 to invoke the host linker when building
  33 # packages that use cgo.  Set to 0 to do all linking internally.  This
  34 # controls the default behavior of the linker's -linkmode option.  The
  35 # default value depends on the system.
  36 #
  37 # GO_LDSO: Sets the default dynamic linker/loader (ld.so) to be used
  38 # by the internal linker.
  39 #
  40 # CC: Command line to run to compile C code for GOHOSTARCH.
  41 # Default is "gcc". Also supported: "clang".
  42 #
  43 # CC_FOR_TARGET: Command line to run to compile C code for GOARCH.
  44 # This is used by cgo. Default is CC.
  45 #
  46 # CC_FOR_${GOOS}_${GOARCH}: Command line to run to compile C code for specified ${GOOS} and ${GOARCH}.
  47 # (for example, CC_FOR_linux_arm)
  48 # If this is not set, the build will use CC_FOR_TARGET if appropriate, or CC.
  49 #
  50 # CXX_FOR_TARGET: Command line to run to compile C++ code for GOARCH.
  51 # This is used by cgo. Default is CXX, or, if that is not set,
  52 # "g++" or "clang++".
  53 #
  54 # CXX_FOR_${GOOS}_${GOARCH}: Command line to run to compile C++ code for specified ${GOOS} and ${GOARCH}.
  55 # (for example, CXX_FOR_linux_arm)
  56 # If this is not set, the build will use CXX_FOR_TARGET if appropriate, or CXX.
  57 #
  58 # FC: Command line to run to compile Fortran code for GOARCH.
  59 # This is used by cgo. Default is "gfortran".
  60 #
  61 # PKG_CONFIG: Path to pkg-config tool. Default is "pkg-config".
  62 #
  63 # GO_DISTFLAGS: extra flags to provide to "dist bootstrap".
  64 # (Or just pass them to the make.bash command line.)
  65 #
  66 # GOBUILDTIMELOGFILE: If set, make.bash and all.bash write
  67 # timing information to this file. Useful for profiling where the
  68 # time goes when these scripts run.
  69 #
  70 # GOROOT_BOOTSTRAP: A working Go tree >= Go 1.17 for bootstrap.
  71 # If $GOROOT_BOOTSTRAP/bin/go is missing, $(go env GOROOT) is
  72 # tried for all "go" in $PATH. By default, one of $HOME/go1.17,
  73 # $HOME/sdk/go1.17, or $HOME/go1.4, whichever exists, in that order.
  74 # We still check $HOME/go1.4 to allow for build scripts that still hard-code
  75 # that name even though they put newer Go toolchains there.
  76
  77 set -e
  78
  79 if [ ! -f run.bash ]; then
  80         echo 'make.bash must be run from $GOROOT/src' 1>&2
  81         exit 1
  82 fi
  83
  84 if [ "$GOBUILDTIMELOGFILE" != "" ]; then
  85         echo $(LC_TIME=C date) start make.bash >"$GOBUILDTIMELOGFILE"
  86 fi
  87
  88 # Test for Windows.
  89 case "$(uname)" in
  90 *MINGW* | *WIN32* | *CYGWIN*)
  91         echo 'ERROR: Do not use make.bash to build on Windows.'
  92         echo 'Use make.bat instead.'
  93         echo
  94         exit 1
  95         ;;
  96 esac
  97
  98 # Test for bad ld.
  99 if ld --version 2>&1 | grep 'gold.* 2\.20' >/dev/null; then
 100         echo 'ERROR: Your system has gold 2.20 installed.'
 101         echo 'This version is shipped by Ubuntu even though'
 102         echo 'it is known not to work on Ubuntu.'
 103         echo 'Binaries built with this linker are likely to fail in mysterious ways.'
 104         echo
 105         echo 'Run sudo apt-get remove binutils-gold.'
 106         echo
 107         exit 1
 108 fi
 109
 110 # Test for bad SELinux.
 111 # On Fedora 16 the selinux filesystem is mounted at /sys/fs/selinux,
 112 # so loop through the possible selinux mount points.
 113 for se_mount in /selinux /sys/fs/selinux
 114 do
 115         if [ -d $se_mount -a -f $se_mount/booleans/allow_execstack -a -x /usr/sbin/selinuxenabled ] && /usr/sbin/selinuxenabled; then
 116                 if ! cat $se_mount/booleans/allow_execstack | grep -c '^1 1$' >> /dev/null ; then
 117                         echo "WARNING: the default SELinux policy on, at least, Fedora 12 breaks "
 118                         echo "Go. You can enable the features that Go needs via the following "
 119                         echo "command (as root):"
 120                         echo "  # setsebool -P allow_execstack 1"
 121                         echo
 122                         echo "Note that this affects your system globally! "
 123                         echo
 124                         echo "The build will continue in five seconds in case we "
 125                         echo "misdiagnosed the issue..."
 126
 127                         sleep 5
 128                 fi
 129         fi
 130 done
 131
 132 # Test for debian/kFreeBSD.
 133 # cmd/dist will detect kFreeBSD as freebsd/$GOARCH, but we need to
 134 # disable cgo manually.
 135 if [ "$(uname -s)" = "GNU/kFreeBSD" ]; then
 136         export CGO_ENABLED=0
 137 fi
 138
 139 # Clean old generated file that will cause problems in the build.
 140 rm -f ./runtime/runtime_defs.go
 141
 142 # Finally!  Run the build.
 143
 144 verbose=false
 145 vflag=""
 146 if [ "$1" = "-v" ]; then
 147         verbose=true
 148         vflag=-v
 149         shift
 150 fi
 151
 152 goroot_bootstrap_set=${GOROOT_BOOTSTRAP+"true"}
 153 if [ -z "$GOROOT_BOOTSTRAP" ]; then
 154         GOROOT_BOOTSTRAP="$HOME/go1.4"
 155         for d in sdk/go1.17 go1.17; do
 156                 if [ -d "$HOME/$d" ]; then
 157                         GOROOT_BOOTSTRAP="$HOME/$d"
 158                 fi
 159         done
 160 fi
 161 export GOROOT_BOOTSTRAP
 162
 163 export GOROOT="$(cd .. && pwd)"
 164 IFS=$'\n'; for go_exe in $(type -ap go); do
 165         if [ ! -x "$GOROOT_BOOTSTRAP/bin/go" ]; then
 166                 goroot=$(GOROOT='' GOOS='' GOARCH='' "$go_exe" env GOROOT)
 167                 if [ "$goroot" != "$GOROOT" ]; then
 168                         if [ "$goroot_bootstrap_set" = "true" ]; then
 169                                 printf 'WARNING: %s does not exist, found %s from env\n' "$GOROOT_BOOTSTRAP/bin/go" "$go_exe" >&2
 170                                 printf 'WARNING: set %s as GOROOT_BOOTSTRAP\n' "$goroot" >&2
 171                         fi
 172                         GOROOT_BOOTSTRAP=$goroot
 173                 fi
 174         fi
 175 done; unset IFS
 176 if [ ! -x "$GOROOT_BOOTSTRAP/bin/go" ]; then
 177         echo "ERROR: Cannot find $GOROOT_BOOTSTRAP/bin/go." >&2
 178         echo "Set \$GOROOT_BOOTSTRAP to a working Go tree >= Go 1.17." >&2
 179         exit 1
 180 fi
 181 # Get the exact bootstrap toolchain version to help with debugging.
 182 # We clear GOOS and GOARCH to avoid an ominous but harmless warning if
 183 # the bootstrap doesn't support them.
 184 GOROOT_BOOTSTRAP_VERSION=$(GOOS= GOARCH= GOEXPERIMENT= $GOROOT_BOOTSTRAP/bin/go version | sed 's/go version //')
 185 echo "Building Go cmd/dist using $GOROOT_BOOTSTRAP. ($GOROOT_BOOTSTRAP_VERSION)"
 186 if $verbose; then
 187         echo cmd/dist
 188 fi
 189 if [ "$GOROOT_BOOTSTRAP" = "$GOROOT" ]; then
 190         echo "ERROR: \$GOROOT_BOOTSTRAP must not be set to \$GOROOT" >&2
 191         echo "Set \$GOROOT_BOOTSTRAP to a working Go tree >= Go 1.17." >&2
 192         exit 1
 193 fi
 194 rm -f cmd/dist/dist
 195 GOROOT="$GOROOT_BOOTSTRAP" GOOS="" GOARCH="" GO111MODULE=off GOEXPERIMENT="" GOENV=off GOFLAGS="" "$GOROOT_BOOTSTRAP/bin/go" build -o cmd/dist/dist ./cmd/dist
 196
 197 # -e doesn't propagate out of eval, so check success by hand.
 198 eval $(./cmd/dist/dist env -p || echo FAIL=true)
 199 if [ "$FAIL" = true ]; then
 200         exit 1
 201 fi
 202
 203 if $verbose; then
 204         echo
 205 fi
 206
 207 if [ "$1" = "--dist-tool" ]; then
 208         # Stop after building dist tool.
 209         mkdir -p "$GOTOOLDIR"
 210         if [ "$2" != "" ]; then
 211                 cp cmd/dist/dist "$2"
 212         fi
 213         mv cmd/dist/dist "$GOTOOLDIR"/dist
 214         exit 0
 215 fi
 216
 217 # Run dist bootstrap to complete make.bash.
 218 # Bootstrap installs a proper cmd/dist, built with the new toolchain.
 219 # Throw ours, built with the bootstrap toolchain, away after bootstrap.
 220 ./cmd/dist/dist bootstrap -a $vflag $GO_DISTFLAGS "$@"
 221 rm -f ./cmd/dist/dist
 222
 223 # DO NOT ADD ANY NEW CODE HERE.
 224 # The bootstrap+rm above are the final step of make.bash.
 225 # If something must be added, add it to cmd/dist's cmdbootstrap,
 226 # to avoid needing three copies in three different shell languages
 227 # (make.bash, make.bat, make.rc).