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 git guix
25
26################
27# Required env vars should be non-empty
28################
29
30cmd_usage() {
31    cat <<EOF
32Synopsis:
33
34    env DETACHED_SIGS_REPO=<path/to/bitcoin-detached-sigs> \\
35      ./contrib/guix/guix-codesign
36
37EOF
38}
39
40if [ -z "$DETACHED_SIGS_REPO" ]; then
41    cmd_usage
42    exit 1
43fi
44
45################
46# GUIX_BUILD_OPTIONS should be empty
47################
48#
49# GUIX_BUILD_OPTIONS is an environment variable recognized by guix commands that
50# can perform builds. This seems like what we want instead of
51# ADDITIONAL_GUIX_COMMON_FLAGS, but the value of GUIX_BUILD_OPTIONS is actually
52# _appended_ to normal command-line options. Meaning that they will take
53# precedence over the command-specific ADDITIONAL_GUIX_<CMD>_FLAGS.
54#
55# This seems like a poor user experience. Thus we check for GUIX_BUILD_OPTIONS's
56# existence here and direct users of this script to use our (more flexible)
57# custom environment variables.
58if [ -n "$GUIX_BUILD_OPTIONS" ]; then
59cat << EOF
60Error: Environment variable GUIX_BUILD_OPTIONS is not empty:
61  '$GUIX_BUILD_OPTIONS'
62
63Unfortunately this script is incompatible with GUIX_BUILD_OPTIONS, please unset
64GUIX_BUILD_OPTIONS and use ADDITIONAL_GUIX_COMMON_FLAGS to set build options
65across guix commands or ADDITIONAL_GUIX_<CMD>_FLAGS to set build options for a
66specific guix command.
67
68See contrib/guix/README.md for more details.
69EOF
70exit 1
71fi
72
73################
74# SOURCE_DATE_EPOCH should not unintentionally be set
75################
76
77check_source_date_epoch
78
79################
80# The codesignature git worktree should not be dirty
81################
82
83if ! git -C "$DETACHED_SIGS_REPO" diff-index --quiet HEAD -- && [ -z "$FORCE_DIRTY_WORKTREE" ]; then
84    cat << EOF
85ERR: The DETACHED CODESIGNATURE git worktree is dirty, which may lead to broken builds.
86
87     Aborting...
88
89Hint: To make your git worktree clean, You may want to:
90      1. Commit your changes,
91      2. Stash your changes, or
92      3. Set the 'FORCE_DIRTY_WORKTREE' environment variable if you insist on
93         using a dirty worktree
94EOF
95    exit 1
96fi
97
98################
99# Build directories should not exist
100################
101
102# Default to building for all supported HOSTs (overridable by environment)
103export HOSTS="${HOSTS:-x86_64-w64-mingw32 x86_64-apple-darwin arm64-apple-darwin}"
104
105# Accumulate a list of build directories that already exist...
106hosts_distsrc_exists=""
107for host in $HOSTS; do
108    if [ -e "$(distsrc_for_host "$host" codesigned)" ]; then
109        hosts_distsrc_exists+=" ${host}"
110    fi
111done
112
113if [ -n "$hosts_distsrc_exists" ]; then
114# ...so that we can print them out nicely in an error message
115cat << EOF
116ERR: Build directories for this commit already exist for the following platform
117     triples you're attempting to build, probably because of previous builds.
118     Please remove, or otherwise deal with them prior to starting another build.
119
120     Aborting...
121
122Hint: To blow everything away, you may want to use:
123
124  $ ./contrib/guix/guix-clean
125
126Specifically, this will remove all files without an entry in the index,
127excluding the SDK directory, the depends download cache, the depends built
128packages cache, the garbage collector roots for Guix environments, and the
129output directory.
130EOF
131for host in $hosts_distsrc_exists; do
132    echo "     ${host} '$(distsrc_for_host "$host" codesigned)'"
133done
134exit 1
135else
136    mkdir -p "$DISTSRC_BASE"
137fi
138
139
140################
141# Codesigning tarballs SHOULD exist
142################
143
144# Usage: codesigning_tarball_for_host HOST [BASE]
145#
146#   HOST: The current platform triple we're building for
147#   BASE: Optional. If provided, replaces ${OUTDIR_BASE}
148#
149codesigning_tarball_for_host() {
150    case "$1" in
151        *mingw*)
152            echo "$(outdir_for_host "$1" "" "$2")/${DISTNAME}-win64-codesigning.tar.gz"
153            ;;
154        *darwin*)
155            echo "$(outdir_for_host "$1" "" "$2")/${DISTNAME}-${1}-codesigning.tar.gz"
156            ;;
157        *)
158            exit 1
159            ;;
160    esac
161}
162
163# Accumulate a list of build directories that already exist...
164hosts_codesigning_tarball_missing=""
165for host in $HOSTS; do
166    if [ ! -e "$(codesigning_tarball_for_host "$host")" ]; then
167        hosts_codesigning_tarball_missing+=" ${host}"
168    fi
169done
170
171if [ -n "$hosts_codesigning_tarball_missing" ]; then
172    # ...so that we can print them out nicely in an error message
173    cat << EOF
174ERR: Codesigning tarballs do not exist
175...
176
177EOF
178for host in $hosts_codesigning_tarball_missing; do
179    echo "     ${host} '$(codesigning_tarball_for_host "$host")'"
180done
181exit 1
182fi
183
184################
185# Check that we can connect to the guix-daemon
186################
187
188cat << EOF
189Checking that we can connect to the guix-daemon...
190
191Hint: If this hangs, you may want to try turning your guix-daemon off and on
192      again.
193
194EOF
195if ! guix gc --list-failures > /dev/null; then
196    cat << EOF
197
198ERR: Failed to connect to the guix-daemon, please ensure that one is running and
199     reachable.
200EOF
201    exit 1
202fi
203
204# Developer note: we could use `guix repl` for this check and run:
205#
206#     (import (guix store)) (close-connection (open-connection))
207#
208# However, the internal API is likely to change more than the CLI invocation
209
210
211#########
212# SETUP #
213#########
214
215# Determine the maximum number of jobs to run simultaneously (overridable by
216# environment)
217JOBS="${JOBS:-$(nproc)}"
218
219# Determine the reference time used for determinism (overridable by environment)
220SOURCE_DATE_EPOCH="${SOURCE_DATE_EPOCH:-$(git -c log.showSignature=false log --format=%at -1)}"
221
222# Make sure an output directory exists for our builds
223OUTDIR_BASE="${OUTDIR_BASE:-${VERSION_BASE}/output}"
224mkdir -p "$OUTDIR_BASE"
225
226#########
227# BUILD #
228#########
229
230# Function to be called when codesigning for host ${1} and the user interrupts
231# the codesign
232int_trap() {
233cat << EOF
234** INT received while codesigning ${1}, you may want to clean up the relevant
235   work directories (e.g. distsrc-*) before recodesigning
236
237Hint: To blow everything away, you may want to use:
238
239  $ ./contrib/guix/guix-clean
240
241Specifically, this will remove all files without an entry in the index,
242excluding the SDK directory, the depends download cache, the depends built
243packages cache, the garbage collector roots for Guix environments, and the
244output directory.
245EOF
246}
247
248# Deterministically build Bitcoin Core
249# shellcheck disable=SC2153
250for host in $HOSTS; do