Inside Bitcoin

1#!/usr/bin/env bash
2# Copyright (c) The Bitcoin Core developers
3# Distributed under the MIT software license, see the accompanying
4# file COPYING or https://opensource.org/license/mit.
5export LC_ALL=C.UTF-8
6set -o errexit -o pipefail
7
8# Environment variables for determinism
9export TAR_OPTIONS="--no-same-owner --owner=0 --group=0 --numeric-owner --mtime='@${SOURCE_DATE_EPOCH}' --sort=name"
10export TZ=UTC
11
12# Although Guix _does_ set umask when building its own packages (in our case,
13# this is all packages in manifest.scm), it does not set it for `guix
14# shell`. It does make sense for at least `guix shell --container`
15# to set umask, so if that change gets merged upstream and we bump the
16# time-machine to a commit which includes the aforementioned change, we can
17# remove this line.
18#
19# This line should be placed before any commands which creates files.
20umask 0022
21
22if [ -n "$V" ]; then
23    # Print both unexpanded (-v) and expanded (-x) forms of commands as they are
24    # read from this file.
25    set -vx
26    # Set VERBOSE for CMake-based builds
27    export VERBOSE="$V"
28fi
29
30# Check that required environment variables are set
31cat << EOF
32Required environment variables as seen inside the container:
33    DIST_ARCHIVE_BASE: ${DIST_ARCHIVE_BASE:?not set}
34    DISTNAME: ${DISTNAME:?not set}
35    HOST: ${HOST:?not set}
36    SOURCE_DATE_EPOCH: ${SOURCE_DATE_EPOCH:?not set}
37    JOBS: ${JOBS:?not set}
38    DISTSRC: ${DISTSRC:?not set}
39    OUTDIR: ${OUTDIR:?not set}
40EOF
41
42export ACTUAL_OUTDIR="${OUTDIR}"
43export OUTDIR="${DISTSRC}/output"
44export INSTALLPATH="${DISTSRC}/installed/${DISTNAME}"
45
46#####################
47# Environment Setup #
48#####################
49
50# The depends folder also serves as a base-prefix for depends packages for
51# $HOSTs after successfully building.
52export BASEPREFIX="${PWD}/depends"
53
54# Given a package name and an output name, return the path of that output in our
55# current guix environment
56store_path() {
57    grep --extended-regexp "/[^-]{32}-${1}-[^-]+${2:+-${2}}" "${GUIX_ENVIRONMENT}/manifest" \
58        | head --lines=1 \
59        | sed --expression='s|\x29*$||' \
60              --expression='s|^[[:space:]]*"||' \
61              --expression='s|"[[:space:]]*$||'
62}
63
64# Sanity check CROSS_*_PATH directories
65check_cross_paths() {
66    local p paths
67    IFS=':' read -ra paths <<< "$1"
68    for p in "${paths[@]}"; do
69        if [ -n "$p" ] && [ ! -d "$p" ]; then
70            echo "'$p' doesn't exist or isn't a directory... Aborting..." >&2
71            return 1
72        fi
73    done
74}
75
76# Given a hostname, determine the correct value for -Wl,--dynamic-linker.
77glibc_dynamic_linker() {
78    case "$1" in
79        x86_64-linux-gnu)      echo /lib64/ld-linux-x86-64.so.2 ;;
80        arm-linux-gnueabihf)   echo /lib/ld-linux-armhf.so.3 ;;
81        aarch64-linux-gnu)     echo /lib/ld-linux-aarch64.so.1 ;;
82        riscv64-linux-gnu)     echo /lib/ld-linux-riscv64-lp64d.so.1 ;;
83        powerpc64-linux-gnu)   echo /lib64/ld64.so.1 ;;
84        powerpc64le-linux-gnu) echo /lib64/ld64.so.2 ;;
85        *)                     exit 1 ;;
86    esac
87}
88
89gcc_toolchain() {
90    # Set environment variables to point the NATIVE toolchain to the right
91    # includes/libs
92    local NATIVE_GCC NATIVE_GCC_STATIC CROSS_GLIBC CROSS_GLIBC_STATIC CROSS_KERNEL CROSS_GCC CROSS_GCC_LIB_STORE CROSS_GCC_LIBS CROSS_GCC_LIB
93
94    NATIVE_GCC="$(store_path gcc-toolchain)"
95
96    # Set native toolchain
97    export build_CC="${NATIVE_GCC}/bin/gcc -isystem ${NATIVE_GCC}/include"
98    export build_CXX="${NATIVE_GCC}/bin/g++ -isystem ${NATIVE_GCC}/include/c++ -isystem ${NATIVE_GCC}/include"
99
100    NATIVE_GCC_STATIC="$(store_path gcc-toolchain static)"
101    export LIBRARY_PATH="${NATIVE_GCC}/lib:${NATIVE_GCC_STATIC}/lib"
102
103    # Set environment variables to point the CROSS toolchain to the right
104    # includes/libs for $HOST
105    CROSS_GLIBC="$(store_path "glibc-cross-${HOST}")"
106    CROSS_GLIBC_STATIC="$(store_path "glibc-cross-${HOST}" static)"
107    CROSS_KERNEL="$(store_path "linux-libre-headers-cross-${HOST}")"
108    CROSS_GCC="$(store_path "gcc-cross-${HOST}")"
109    CROSS_GCC_LIB_STORE="$(store_path "gcc-cross-${HOST}" lib)"
110    CROSS_GCC_LIBS=( "${CROSS_GCC_LIB_STORE}/lib/gcc/${HOST}"/* ) # This expands to an array of directories...
111    CROSS_GCC_LIB="${CROSS_GCC_LIBS[0]}" # ...we just want the first one (there should only be one)
112
113    export CROSS_C_INCLUDE_PATH="${CROSS_GCC_LIB}/include:${CROSS_GCC_LIB}/include-fixed:${CROSS_GLIBC}/include:${CROSS_KERNEL}/include"
114    export CROSS_CPLUS_INCLUDE_PATH="${CROSS_GCC}/include/c++:${CROSS_GCC}/include/c++/${HOST}:${CROSS_GCC}/include/c++/backward:${CROSS_C_INCLUDE_PATH}"
115    export CROSS_LIBRARY_PATH="${CROSS_GCC_LIB_STORE}/lib:${CROSS_GCC_LIB}:${CROSS_GLIBC}/lib:${CROSS_GLIBC_STATIC}/lib"
116
117    check_cross_paths "${CROSS_C_INCLUDE_PATH}:${CROSS_CPLUS_INCLUDE_PATH}:${CROSS_LIBRARY_PATH}"
118}
119
120llvm_toolchain() {
121    local CLANG_TOOLCHAIN LIB_CXX
122
123    CLANG_TOOLCHAIN="$(store_path clang-toolchain)"
124    LIB_CXX="$(store_path libcxx)"
125
126    export build_CC="${CLANG_TOOLCHAIN}/bin/clang -isystem ${CLANG_TOOLCHAIN}/include"
127    export build_CXX="${CLANG_TOOLCHAIN}/bin/clang++ -stdlib=libc++ -isystem ${LIB_CXX}/include/c++/v1 -isystem ${CLANG_TOOLCHAIN}/include"
128    export build_LDFLAGS="-fuse-ld=lld -rtlib=compiler-rt -unwindlib=libunwind -L${LIB_CXX}/lib -Wl,-rpath,${LIB_CXX}/lib"
129    export build_AR="${CLANG_TOOLCHAIN}/bin/llvm-ar"
130    export build_RANLIB="${CLANG_TOOLCHAIN}/bin/llvm-ranlib"
131    export build_OBJDUMP="${CLANG_TOOLCHAIN}/bin/llvm-objdump"
132    export build_NM="${CLANG_TOOLCHAIN}/bin/llvm-nm"
133    export build_STRIP="${CLANG_TOOLCHAIN}/bin/llvm-strip"
134}
135
136mingw_w64_toolchain() {
137    # Set environment variables to point the NATIVE toolchain to the right
138    # includes/libs
139    local NATIVE_GCC CROSS_GLIBC CROSS_GCC CROSS_GCC_LIB_STORE CROSS_GCC_LIBS CROSS_GCC_LIB
140
141    NATIVE_GCC="$(store_path gcc-toolchain)"
142
143    # Set native toolchain
144    export build_CC="${NATIVE_GCC}/bin/gcc -isystem ${NATIVE_GCC}/include"
145    export build_CXX="${NATIVE_GCC}/bin/g++ -isystem ${NATIVE_GCC}/include/c++ -isystem ${NATIVE_GCC}/include"
146
147    # Set environment variables to point the CROSS toolchain to the right
148    # includes/libs for $HOST
149    # Determine output paths to use in CROSS_* environment variables
150    CROSS_GLIBC="$(store_path "mingw-w64-x86_64-winpthreads")"
151    CROSS_GCC="$(store_path "gcc-cross-${HOST}")"
152    CROSS_GCC_LIB_STORE="$(store_path "gcc-cross-${HOST}" lib)"
153    CROSS_GCC_LIBS=( "${CROSS_GCC_LIB_STORE}/lib/gcc/${HOST}"/* ) # This expands to an array of directories...
154    CROSS_GCC_LIB="${CROSS_GCC_LIBS[0]}" # ...we just want the first one (there should only be one)
155
156    # The search path ordering is generally:
157    #    1. gcc-related search paths
158    #    2. libc-related search paths
159    #    2. kernel-header-related search paths (not applicable to mingw-w64 hosts)
160    export CROSS_C_INCLUDE_PATH="${CROSS_GCC_LIB}/include:${CROSS_GCC_LIB}/include-fixed:${CROSS_GLIBC}/include"
161    export CROSS_CPLUS_INCLUDE_PATH="${CROSS_GCC}/include/c++:${CROSS_GCC}/include/c++/${HOST}:${CROSS_GCC}/include/c++/backward:${CROSS_C_INCLUDE_PATH}"
162    export CROSS_LIBRARY_PATH="${CROSS_GCC_LIB_STORE}/lib:${CROSS_GCC_LIB}:${CROSS_GLIBC}/lib"
163
164    check_cross_paths "${CROSS_C_INCLUDE_PATH}:${CROSS_CPLUS_INCLUDE_PATH}:${CROSS_LIBRARY_PATH}"
165}
166
167# Disable Guix ld auto-rpath behavior
168export GUIX_LD_WRAPPER_DISABLE_RPATH=yes
169
170# Make /usr/bin if it doesn't exist
171[ -e /usr/bin ] || mkdir -p /usr/bin
172
173# Symlink env to a conventional path
174[ -e /usr/bin/env ]  || ln -s --no-dereference "$(command -v env)"  /usr/bin/env
175
176###########################
177# Source Tarball Building #
178###########################
179
180GIT_ARCHIVE="${DIST_ARCHIVE_BASE}/${DISTNAME}.tar.gz"
181
182# Create the source tarball if not already there
183if [ ! -e "$GIT_ARCHIVE" ]; then
184    mkdir -p "$(dirname "$GIT_ARCHIVE")"
185    git archive --prefix="${DISTNAME}/" --output="$GIT_ARCHIVE" HEAD
186fi
187
188mkdir -p "$OUTDIR"
189
190unset LIBRARY_PATH
191unset CPATH
192unset C_INCLUDE_PATH
193unset CPLUS_INCLUDE_PATH
194unset OBJC_INCLUDE_PATH
195unset OBJCPLUS_INCLUDE_PATH
196