bitcoin/ci/test/00_setup_env_native_asan.sh

#!/usr/bin/env bash
#
# Copyright (c) 2019-present The Bitcoin Core developers
# Distributed under the MIT software license, see the accompanying
# file COPYING or http://www.opensource.org/licenses/mit-license.php.

export LC_ALL=C.UTF-8

export CI_IMAGE_NAME_TAG="docker.io/ubuntu:24.04"

# Only install BCC tracing packages in CI. Container has to match the host for BCC to work.
if [[ "${INSTALL_BCC_TRACING_TOOLS}" == "true" ]]; then
  # Required for USDT functional tests to run
  BPFCC_PACKAGE="bpfcc-tools linux-headers-$(uname --kernel-release)"
  export CI_CONTAINER_CAP="--privileged -v /sys/kernel:/sys/kernel:rw"
else
  BPFCC_PACKAGE=""
  export CI_CONTAINER_CAP="--cap-add SYS_PTRACE"  # If run with (ASan + LSan), the container needs access to ptrace (https://github.com/google/sanitizers/issues/764)
fi

export CONTAINER_NAME=ci_native_asan
export PACKAGES="systemtap-sdt-dev clang-18 llvm-18 libclang-rt-18-dev python3-zmq qtbase5-dev qttools5-dev-tools libevent-dev libboost-dev libdb5.3++-dev libminiupnpc-dev libnatpmp-dev libzmq3-dev libqrencode-dev libsqlite3-dev ${BPFCC_PACKAGE}"
export NO_DEPENDS=1
export GOAL="install"
export BITCOIN_CONFIG="--enable-usdt --enable-zmq --with-incompatible-bdb --with-gui=qt5 \
CPPFLAGS='-DARENA_DEBUG -DDEBUG_LOCKORDER' \
--with-sanitizers=address,float-divide-by-zero,integer,undefined \
CC='clang-18 -ftrivial-auto-var-init=pattern' CXX='clang++-18 -ftrivial-auto-var-init=pattern'"
ci: Add environment files for all settings 2019-08-15 16:51:31 -04:00			`#!/usr/bin/env bash`
			`#`
ci: Add missing docker.io prefix to CI_IMAGE_NAME_TAG 2023-08-23 22:48:44 +02:00			`# Copyright (c) 2019-present The Bitcoin Core developers`
ci: Add environment files for all settings 2019-08-15 16:51:31 -04:00			`# Distributed under the MIT software license, see the accompanying`
			`# file COPYING or http://www.opensource.org/licenses/mit-license.php.`

			`export LC_ALL=C.UTF-8`

ci: Use Ubuntu 24.04 Noble for asan 2023-12-04 12:35:04 +01:00			`export CI_IMAGE_NAME_TAG="docker.io/ubuntu:24.04"`
ci: move Asan / LSan / USDT job to Github Actions Moving it from Cirrus CI so it can be easier to maintain and used by forks 2024-06-07 23:32:27 +01:00
			`# Only install BCC tracing packages in CI. Container has to match the host for BCC to work.`
			`if [[ "${INSTALL_BCC_TRACING_TOOLS}" == "true" ]]; then`
			`# Required for USDT functional tests to run`
Revert "ci: Temporarily disable bpfcc-tools" This reverts commit fac012c7262f036e9b6f5800e57dcd63870a871c. 2024-04-09 09:17:34 +02:00			`BPFCC_PACKAGE="bpfcc-tools linux-headers-$(uname --kernel-release)"`
ci: Add missing linux-headers package to ASan task Otherwise the task will throw in skip_if_no_python_bcc. Also, adjust CI_CONTAINER_CAP for all needed permissions. 2023-07-26 13:05:29 +02:00			`export CI_CONTAINER_CAP="--privileged -v /sys/kernel:/sys/kernel:rw"`
ci: only run USDT interface tests on CirrusCI As mentioned in #26571, the task running the USDT interface tests fail when run in docker. cc7335edc87c6ef34429b4df94f53973db520aac in #25528 added that the tests are run in a VM in Cirrus CI. Running them locally in docker containers might not work: - We use [bcc] as tracing toolkit which requires the kernel headers to compile the BPF bytecode. As docker containers use the hosts kernel and don't run their own, there is a potential for mismatches between kernel headers available in the container and the host kernel. This results in a failure loading the BPF byte code. - Privilges are required to load the BPF byte code into the kernel. Normally, the docker containers aren't run with these. - We currently use an untrusted third-party PPA to install the bpfcc-tools package on Ubuntu 22.04. Using this on a local dev system could be a security risk. To not hinder the ASan + LSan + UBSan part of the CI task, the USDT tests are disabled on non-CirrusCI runs. [bcc]: https://github.com/iovisor/bcc 2022-11-28 21:26:26 +01:00			`else`
ci: Add missing linux-headers package to ASan task Otherwise the task will throw in skip_if_no_python_bcc. Also, adjust CI_CONTAINER_CAP for all needed permissions. 2023-07-26 13:05:29 +02:00			`BPFCC_PACKAGE=""`
			`export CI_CONTAINER_CAP="--cap-add SYS_PTRACE" # If run with (ASan + LSan), the container needs access to ptrace (https://github.com/google/sanitizers/issues/764)`
ci: only run USDT interface tests on CirrusCI As mentioned in #26571, the task running the USDT interface tests fail when run in docker. cc7335edc87c6ef34429b4df94f53973db520aac in #25528 added that the tests are run in a VM in Cirrus CI. Running them locally in docker containers might not work: - We use [bcc] as tracing toolkit which requires the kernel headers to compile the BPF bytecode. As docker containers use the hosts kernel and don't run their own, there is a potential for mismatches between kernel headers available in the container and the host kernel. This results in a failure loading the BPF byte code. - Privilges are required to load the BPF byte code into the kernel. Normally, the docker containers aren't run with these. - We currently use an untrusted third-party PPA to install the bpfcc-tools package on Ubuntu 22.04. Using this on a local dev system could be a security risk. To not hinder the ASan + LSan + UBSan part of the CI task, the USDT tests are disabled on non-CirrusCI runs. [bcc]: https://github.com/iovisor/bcc 2022-11-28 21:26:26 +01:00			`fi`
ci: run USDT interface test in a VM Our CI tasks are run by CirrusCI in Docker containers in a Google Compute Engine based Kubernetes environment. These containers have limited capabilities - especially CAP_SYS_ADMIN is missing. See https://github.com/bitcoin/bitcoin/issues/23296#issuecomment-1024920845 We need elevated privileges to hook into the USDT tracepoints. We use a CirrusCI "compute_engine_instance" (a VM, not a container) where we have the required privileges. The ubunut-mininmal-2204-lts was choosen with debian-11 being an alternative. Both pack an outdated 'bpfcc-tools' package (v0.18.0) from 2020. This version prints warnings to stderr during BPF bytecode compilation, which causes our functional test runner to fail. This is fixed in newer verison. Until debian-12 or a newer Ubuntu release is avaliable as image in GCE (https://cloud.google.com/compute/docs/images/os-details), we use a third-party and untrusted PPA that releases up-to-date versions of the package. The official iovisor (authors of BCC) PPA is outdated too. An alternative would be to compile BCC from source in the CI. Co-authored-by: MacroFake <falke.marco@gmail.com> 2022-07-01 13:49:55 +02:00
test: set a name for CI Docker containers 2020-02-05 08:43:10 +08:00			`export CONTAINER_NAME=ci_native_asan`
ci: Use clang-18 in asan/fuzz/tsan task 2024-03-29 15:24:39 +01:00			`export PACKAGES="systemtap-sdt-dev clang-18 llvm-18 libclang-rt-18-dev python3-zmq qtbase5-dev qttools5-dev-tools libevent-dev libboost-dev libdb5.3++-dev libminiupnpc-dev libnatpmp-dev libzmq3-dev libqrencode-dev libsqlite3-dev ${BPFCC_PACKAGE}"`
ci: Add environment files for all settings 2019-08-15 16:51:31 -04:00			`export NO_DEPENDS=1`
			`export GOAL="install"`
ci: Drop `--enable-c++20` option This option has ceased to exist since https://github.com/bitcoin/bitcoin/pull/28349. 2024-03-17 16:54:47 +00:00			`export BITCOIN_CONFIG="--enable-usdt --enable-zmq --with-incompatible-bdb --with-gui=qt5 \`
ci: Enable float-divide-by-zero check 2023-05-30 12:04:22 +02:00			`CPPFLAGS='-DARENA_DEBUG -DDEBUG_LOCKORDER' \`
ci: Asan with -ftrivial-auto-var-init=pattern 2023-08-28 21:32:41 +02:00			`--with-sanitizers=address,float-divide-by-zero,integer,undefined \`
ci: Use clang-18 in asan/fuzz/tsan task 2024-03-29 15:24:39 +01:00			`CC='clang-18 -ftrivial-auto-var-init=pattern' CXX='clang++-18 -ftrivial-auto-var-init=pattern'"`