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# Source the common prelude, which:
9#   1. Checks if we're at the top directory of the Bitcoin Core repository
10#   2. Defines a few common functions and variables
11#
12# shellcheck source=libexec/prelude.bash
13source "$(dirname "${BASH_SOURCE[0]}")/libexec/prelude.bash"
14
15
16###################
17## SANITY CHECKS ##
18###################
19
20################
21# Required non-builtin commands should be invocable
22################
23
24check_tools cat mkdir make getent curl git guix
25
26################
27# GUIX_BUILD_OPTIONS should be empty
28################
29#
30# GUIX_BUILD_OPTIONS is an environment variable recognized by guix commands that
31# can perform builds. This seems like what we want instead of
32# ADDITIONAL_GUIX_COMMON_FLAGS, but the value of GUIX_BUILD_OPTIONS is actually
33# _appended_ to normal command-line options. Meaning that they will take
34# precedence over the command-specific ADDITIONAL_GUIX_<CMD>_FLAGS.
35#
36# This seems like a poor user experience. Thus we check for GUIX_BUILD_OPTIONS's
37# existence here and direct users of this script to use our (more flexible)
38# custom environment variables.
39if [ -n "$GUIX_BUILD_OPTIONS" ]; then
40cat << EOF
41Error: Environment variable GUIX_BUILD_OPTIONS is not empty:
42  '$GUIX_BUILD_OPTIONS'
43
44Unfortunately this script is incompatible with GUIX_BUILD_OPTIONS, please unset
45GUIX_BUILD_OPTIONS and use ADDITIONAL_GUIX_COMMON_FLAGS to set build options
46across guix commands or ADDITIONAL_GUIX_<CMD>_FLAGS to set build options for a
47specific guix command.
48
49See contrib/guix/README.md for more details.
50EOF
51exit 1
52fi
53
54################
55# The git worktree should not be dirty
56################
57
58if ! git diff-index --quiet HEAD -- && [ -z "$FORCE_DIRTY_WORKTREE" ]; then
59cat << EOF
60ERR: The current git worktree is dirty, which may lead to broken builds.
61
62     Aborting...
63
64Hint: To make your git worktree clean, You may want to:
65      1. Commit your changes,
66      2. Stash your changes, or
67      3. Set the 'FORCE_DIRTY_WORKTREE' environment variable if you insist on
68         using a dirty worktree
69EOF
70exit 1
71fi
72
73mkdir -p "$VERSION_BASE"
74
75################
76# SOURCE_DATE_EPOCH should not unintentionally be set
77################
78
79check_source_date_epoch
80
81################
82# Build directories should not exist
83################
84
85# Default to building for all supported HOSTs (overridable by environment)
86# powerpc64le-linux-gnu currently disabled due non-determinism issues across build arches.
87export HOSTS="${HOSTS:-x86_64-linux-gnu arm-linux-gnueabihf aarch64-linux-gnu riscv64-linux-gnu powerpc64-linux-gnu
88                       x86_64-w64-mingw32
89                       x86_64-apple-darwin arm64-apple-darwin}"
90
91# Accumulate a list of build directories that already exist...
92hosts_distsrc_exists=""
93for host in $HOSTS; do
94    if [ -e "$(distsrc_for_host "$host")" ]; then
95        hosts_distsrc_exists+=" ${host}"
96    fi
97done
98
99if [ -n "$hosts_distsrc_exists" ]; then
100# ...so that we can print them out nicely in an error message
101cat << EOF
102ERR: Build directories for this commit already exist for the following platform
103     triples you're attempting to build, probably because of previous builds.
104     Please remove, or otherwise deal with them prior to starting another build.
105
106     Aborting...
107
108Hint: To blow everything away, you may want to use:
109
110  $ ./contrib/guix/guix-clean
111
112Specifically, this will remove all files without an entry in the index,
113excluding the SDK directory, the depends download cache, the depends built
114packages cache, the garbage collector roots for Guix environments, and the
115output directory.
116EOF
117for host in $hosts_distsrc_exists; do
118    echo "     ${host} '$(distsrc_for_host "$host")'"
119done
120exit 1
121else
122    mkdir -p "$DISTSRC_BASE"
123fi
124
125################
126# When building for darwin, the macOS SDK should exist
127################
128
129for host in $HOSTS; do
130    case "$host" in
131        *darwin*)
132            OSX_SDK="$(make -C "${PWD}/depends" --no-print-directory HOST="$host" print-OSX_SDK | sed 's@^[^=]\+=@@g')"
133            if [ -e "$OSX_SDK" ]; then
134                echo "Found macOS SDK at '${OSX_SDK}', using..."
135                break
136            else
137                echo "macOS SDK does not exist at '${OSX_SDK}', please place the extracted, untarred SDK there to perform darwin builds, or define SDK_PATH environment variable. Exiting..."
138                exit 1
139            fi
140            ;;
141    esac
142done
143
144################
145# VERSION_BASE should have enough space
146################
147
148avail_KiB="$(df -Pk "$VERSION_BASE" | sed 1d | tr -s ' ' | cut -d' ' -f4)"
149total_required_KiB=0
150for host in $HOSTS; do
151    case "$host" in
152        *darwin*) required_KiB=440000 ;;
153        *mingw*)  required_KiB=7600000 ;;
154        *)        required_KiB=6400000 ;;
155    esac
156    total_required_KiB=$((total_required_KiB+required_KiB))
157done
158
159if (( total_required_KiB > avail_KiB )); then
160    total_required_GiB=$((total_required_KiB / 1048576))
161    avail_GiB=$((avail_KiB / 1048576))
162    echo "Performing a Bitcoin Core Guix build for the selected HOSTS requires ${total_required_GiB} GiB, however, only ${avail_GiB} GiB is available. Please free up some disk space before performing the build."
163    exit 1
164fi
165
166################
167# Check that we can connect to the guix-daemon
168################
169
170cat << EOF
171Checking that we can connect to the guix-daemon...
172
173Hint: If this hangs, you may want to try turning your guix-daemon off and on
174      again.
175
176EOF
177if ! guix gc --list-failures > /dev/null; then
178cat << EOF
179
180ERR: Failed to connect to the guix-daemon, please ensure that one is running and
181     reachable.
182EOF
183exit 1
184fi
185
186# Developer note: we could use `guix repl` for this check and run:
187#
188#     (import (guix store)) (close-connection (open-connection))
189#
190# However, the internal API is likely to change more than the CLI invocation
191
192################
193# Services database must have basic entries
194################
195
196if ! getent services http https ftp > /dev/null 2>&1; then
197cat << EOF
198ERR: Your system's C library cannot find service database entries for at least
199     one of the following services: http, https, ftp.
200
201Hint: Most likely, /etc/services does not exist yet (common for docker images
202      and minimal distros), or you don't have permissions to access it.
203
204      If /etc/services does not exist yet, you may want to install the
205      appropriate package for your distro which provides it.
206
207          On Debian/Ubuntu: netbase
208          On Arch Linux: iana-etc
209
210      For more information, see: getent(1), services(5)
211
212EOF
213
214fi
215
216#########
217# SETUP #
218#########
219
220# Determine the maximum number of jobs to run simultaneously (overridable by
221# environment)
222JOBS="${JOBS:-$(nproc)}"
223
224# Usage: host_to_commonname HOST
225#
226#   HOST: The current platform triple we're building for
227#
228host_to_commonname() {
229    case "$1" in
230        *darwin*) echo osx ;;
231        *mingw*)  echo win ;;
232        *linux*)  echo linux ;;
233        *)        exit 1 ;;
234    esac
235}
236
237# Determine the reference time used for determinism (overridable by environment)
238SOURCE_DATE_EPOCH="${SOURCE_DATE_EPOCH:-$(git -c log.showSignature=false log --format=%at -1)}"
239
240# Precious directories are those which should not be cleaned between successive
241# guix builds
242depends_precious_dir_names="SOURCES_PATH BASE_CACHE SDK_PATH"
243base_dir_names="OUTDIR_BASE PROFILES_BASE"
244precious_dir_names="${depends_precious_dir_names} ${base_dir_names}"
245
246# If the user explicitly specified a precious directory, create it so we
247# can map it into the container
248for precious_dir_name in $precious_dir_names; do
249    precious_dir_path="${!precious_dir_name}"
250    if [ -n "$precious_dir_path" ]; then