make.bash

#!/usr/bin/env bash
# Copyright 2009 The Go Authors. All rights reserved.
# Use of this source code is governed by a BSD-style
# license that can be found in the LICENSE file.

# Environment variables that control make.bash:
#
# GOROOT_FINAL: The expected final Go root, baked into binaries.
# The default is the location of the Go tree during the build.
#
# GOHOSTARCH: The architecture for host tools (compilers and
# binaries).  Binaries of this type must be executable on the current
# system, so the only common reason to set this is to set
# GOHOSTARCH=386 on an amd64 machine.
#
# GOARCH: The target architecture for installed packages and tools.
#
# GOOS: The target operating system for installed packages and tools.
#
# GO_GCFLAGS: Additional 5g/6g/8g arguments to use when
# building the packages and commands.
#
# GO_LDFLAGS: Additional 5l/6l/8l arguments to use when
# building the commands.
#
# CGO_ENABLED: Controls cgo usage during the build. Set it to 1
# to include all cgo related files, .c and .go file with "cgo"
# build directive, in the build. Set it to 0 to ignore them.

set -e
if [ ! -f run.bash ]; then
  echo 'make.bash must be run from $GOROOT/src' 1>&2
	exit 1
fi

# Test for Windows.
case "$(uname)" in
*MINGW* | *WIN32* | *CYGWIN*)
	echo 'ERROR: Do not use make.bash to build on Windows.'
	echo 'Use make.bat instead.'
	echo
	exit 1
	;;
esac

# Test for bad ld.
if ld --version 2>&1 | grep 'gold.* 2\.20' >/dev/null; then
	echo 'ERROR: Your system has gold 2.20 installed.'
	echo 'This version is shipped by Ubuntu even though'
	echo 'it is known not to work on Ubuntu.'
	echo 'Binaries built with this linker are likely to fail in mysterious ways.'
	echo
	echo 'Run sudo apt-get remove binutils-gold.'
	echo
	exit 1
fi

# Test for bad SELinux.
# On Fedora 16 the selinux filesystem is mounted at /sys/fs/selinux,
# so loop through the possible selinux mount points.
for se_mount in /selinux /sys/fs/selinux
do
	if [ -d $se_mount -a -f $se_mount/booleans/allow_execstack -a -x /usr/sbin/selinuxenabled ] && /usr/sbin/selinuxenabled; then
		if ! cat $se_mount/booleans/allow_execstack | grep -c '^1 1$' >> /dev/null ; then
			echo "WARNING: the default SELinux policy on, at least, Fedora 12 breaks "
			echo "Go. You can enable the features that Go needs via the following "
			echo "command (as root):"
			echo "  # setsebool -P allow_execstack 1"
			echo
			echo "Note that this affects your system globally! "
			echo
			echo "The build will continue in five seconds in case we "
			echo "misdiagnosed the issue..."

			sleep 5
		fi
	fi
done

# Clean old generated file that will cause problems in the build.
rm -f ./pkg/runtime/runtime_defs.go

# Finally!  Run the build.

echo '# Building C bootstrap tool.'
echo cmd/dist
# export当前Go源码所在跟目录为GOROOT
export GOROOT="$(cd .. && pwd)"
# 如果GOROOT_FINAL没有设置，则使用$GOROOT的值当做GOROOT_FINAL
GOROOT_FINAL="${GOROOT_FINAL:-$GOROOT}"
DEFGOROOT='-DGOROOT_FINAL="'"$GOROOT_FINAL"'"'

# 如果在amd64机子上编译Go本身为32位，可以设置 $GOHOSTARCH=386。不建议这么做
mflag=""
case "$GOHOSTARCH" in
386) mflag=-m32;;
amd64) mflag=-m64;;
esac

# gcc编译：编译cmd/dist下所有的c文件
# -m：指定处理器架构，以便进行优化（-m32、-m64）或为空（一般为空）
# -O：优化选项，一般为：-O2。优化得到的程序比没优化的要小，执行速度可能也有所提高
# -Wall：生成所有警告信息
# -Werror：所有警告信息都变成错误
# -ggdb：为gdb生成调试信息（-g是生成调试信息）
# -o：生成指定的输出文件
# -I：指定额外的文件搜索路径
# -D：相当于C语言中的#define GOROOT_FINAL="$GOROOT_FINAL"
gcc $mflag -O2 -Wall -Werror -ggdb -o cmd/dist/dist -Icmd/dist "$DEFGOROOT" cmd/dist/*.c

# 编译完 dist 工具后，运行dist。目的是设置相关环境变量
# 比如：$GOTOOLDIR 环境变量就是这里设置的
eval $(./cmd/dist/dist env -p)
echo

# 运行make.bash时传递--dist-tool参数可以仅编译dist工具
if [ "$1" = "--dist-tool" ]; then
	# Stop after building dist tool.
	mkdir -p "$GOTOOLDIR"
	if [ "$2" != "" ]; then
		cp cmd/dist/dist "$2"
	fi
	mv cmd/dist/dist "$GOTOOLDIR"/dist
	exit 0
fi

# 构建 编译器和Go引导工具
# $GOHOSTOS/$GOHOSTARCH 是运行dist设置的
echo "# Building compilers and Go bootstrap tool for host, $GOHOSTOS/$GOHOSTARCH."
# 表示重新构建
buildall="-a"
# 传递--no-clean 表示不重新构建
if [ "$1" = "--no-clean" ]; then
	buildall=""
fi
# 构建Go引导工具
./cmd/dist/dist bootstrap $buildall -v # builds go_bootstrap
# Delay move of dist tool to now, because bootstrap may clear tool directory.
mv cmd/dist/dist "$GOTOOLDIR"/dist
"$GOTOOLDIR"/go_bootstrap clean -i std
echo

# $GOHOSTARCH 与 $GOARCH的区别：（$GOHOSTOS 与 $GOOS的区别一样）
#	GOARCH 表示Go写出来的程序会在什么架构运行（目标操作系统）；
#	GOHOSTARCH 表示运行make.bash这个脚本的系统架构
# 一般它们是相等的，只有在需要交叉编译时才会不一样。
if [ "$GOHOSTARCH" != "$GOARCH" -o "$GOHOSTOS" != "$GOOS" ]; then
	# 即使交叉编译，本机的Go环境还是必须得有
	echo "# Building packages and commands for host, $GOHOSTOS/$GOHOSTARCH."
	GOOS=$GOHOSTOS GOARCH=$GOHOSTARCH \
		"$GOTOOLDIR"/go_bootstrap install -gcflags "$GO_GCFLAGS" -ldflags "$GO_LDFLAGS" -v std
	echo
fi

echo "# Building packages and commands for $GOOS/$GOARCH."
"$GOTOOLDIR"/go_bootstrap install -gcflags "$GO_GCFLAGS" -ldflags "$GO_LDFLAGS" -v std
echo

rm -f "$GOTOOLDIR"/go_bootstrap

# 是否打印安装成功的提示信息。一般为：
#	Installed Go for $GOOS/$GOARCH in $GOROOT
#	Installed commands in $GOROOT/bin
if [ "$1" != "--no-banner" ]; then
	"$GOTOOLDIR"/dist banner
fi