contrib/guix/libexec/prelude.bash - master - githubmirror/bitcoin

contrib/guix/libexec/prelude.bash
130 строк4 KB
Hennadii Stepanov
guix: Add copyright headers to Guix scripts
23 июл 2026, 13:13
23 июл 2026, 13:13711eb10
#!/usr/bin/env bash
# Copyright (c) The Bitcoin Core developers
# Distributed under the MIT software license, see the accompanying
# file COPYING or https://opensource.org/license/mit.
export LC_ALL=C.UTF-8
set -o errexit -o pipefail

source contrib/shell/realpath.bash
source contrib/shell/git-utils.bash

################
# Required non-builtin commands should be invocable
################

check_tools() {
    for cmd in "$@"; do
        if ! command -v "$cmd" > /dev/null 2>&1; then
            echo "ERR: This script requires that '$cmd' is installed and available in your \$PATH"
            exit 1
        fi
    done
}

################
# SOURCE_DATE_EPOCH should not unintentionally be set
################

check_source_date_epoch() {
    if [ -n "$SOURCE_DATE_EPOCH" ] && [ -z "$FORCE_SOURCE_DATE_EPOCH" ]; then
        cat << EOF
ERR: Environment variable SOURCE_DATE_EPOCH is set which may break reproducibility.

     Aborting...

Hint: You may want to:
      1. Unset this variable: \`unset SOURCE_DATE_EPOCH\` before rebuilding
      2. Set the 'FORCE_SOURCE_DATE_EPOCH' environment variable if you insist on
         using your own epoch
EOF
        exit 1
    fi
}

check_tools cat env readlink dirname basename git

################
# We should be at the top directory of the repository
################

same_dir() {
    local resolved1 resolved2
    resolved1="$(bash_realpath "${1}")"
    resolved2="$(bash_realpath "${2}")"
    [ "$resolved1" = "$resolved2" ]
}

if ! same_dir "${PWD}" "$(git_root)"; then
cat << EOF
ERR: This script must be invoked from the top level of the git repository

Hint: This may look something like:
    env FOO=BAR ./contrib/guix/guix-<blah>

EOF
exit 1
fi

################
# Execute "$@" in a pinned, possibly older version of Guix, for reproducibility
# across time.
time-machine() {
    # shellcheck disable=SC2086
    guix time-machine --url=https://codeberg.org/guix/guix.git \
                      --commit=c5eee3336cc1d10a3cc1c97fde2809c3451624d3 \
                      --cores="$JOBS" \
                      --keep-failed \
                      --fallback \
                      ${SUBSTITUTE_URLS:+--substitute-urls="$SUBSTITUTE_URLS"} \
                      ${ADDITIONAL_GUIX_COMMON_FLAGS} ${ADDITIONAL_GUIX_TIMEMACHINE_FLAGS} \
                      -- "$@"
}

# Usage: distsrc_for_host HOST [SUFFIX] [BASE]
#
#   HOST: The current platform triple we're building for
#   SUFFIX: Optional. If provided, appended to the directory name as "-SUFFIX"
#   BASE: Optional. If provided, replaces ${DISTSRC_BASE}
#
distsrc_for_host() {
    echo "${3:-${DISTSRC_BASE}}/distsrc-${VERSION}-${1}${2:+-${2}}"
}

# Usage: outdir_for_host HOST [SUFFIX] [BASE]
#
#   HOST: The current platform triple we're building for
#   SUFFIX: Optional. If provided, appended to the directory name as "-SUFFIX"
#   BASE: Optional. If provided, replaces ${OUTDIR_BASE}
#
outdir_for_host() {
    echo "${3:-${OUTDIR_BASE}}/${1}${2:+-${2}}"
}

# Usage: profiledir_for_host HOST [SUFFIX]
#
#   HOST: The current platform triple we're building for
#   SUFFIX: Optional. If provided, appended to the directory name as "-SUFFIX"
#
profiledir_for_host() {
    echo "${PROFILES_BASE}/${1}${2:+-${2}}"
}

################
# Set common variables
################

VERSION="${FORCE_VERSION:-$(git_head_version)}"
DISTNAME="${DISTNAME:-bitcoin-${VERSION}}"

version_base_prefix="${PWD}/guix-build-"
VERSION_BASE="${version_base_prefix}${VERSION}"  # TOP

DISTSRC_BASE="${DISTSRC_BASE:-${VERSION_BASE}}"

OUTDIR_BASE="${OUTDIR_BASE:-${VERSION_BASE}/output}"

var_base_basename="var"
VAR_BASE="${VAR_BASE:-${VERSION_BASE}/${var_base_basename}}"

profiles_base_basename="profiles"
PROFILES_BASE="${PROFILES_BASE:-${VAR_BASE}/${profiles_base_basename}}"