bitcoin

mirror of https://github.com/bitcoin/bitcoin.git synced 2024-11-19 01:42:58 +01:00

History

merge-script 338bc2cd26 Merge bitcoin/bitcoin#30454 : build: Introduce CMake-based build system `41051290ab` cmake: Ignore build subdirectories within source directory (Hennadii Stepanov) `6ce50fd9d0` doc: Update for CMake-based build system (Hennadii Stepanov) `9730288a0c` ci: Migrate CI scripts to CMake (Hennadii Stepanov) `c360837ca5` cmake, lint: Adjust `lint_includes_build_config` (Hennadii Stepanov) `3885441ee0` cmake: Add presets for native Windows builds (Hennadii Stepanov) `7681746b20` cmake: Add vcpkg manifest file (Hennadii Stepanov) `8b6f1c4353` cmake: Add `Coverage` and `CoverageFuzz` scripts (Hennadii Stepanov) `65bdbc1ff2` cmake: Add `docs` build target (Hennadii Stepanov) `fb75ebbc33` cmake: Add compiler diagnostic flags (Hennadii Stepanov) `e821f0a37a` cmake: Migrate Guix build scripts to CMake (Hennadii Stepanov) `747adb6ffe` cmake: Add `Maintenance` module (Hennadii Stepanov) `1f60b30df0` cmake: Add `APPEND_{CPP,C,CXX,LD}FLAGS` cache variables (Hennadii Stepanov) `2b43c45b13` cmake: Add `AddWindowsResources` module (Hennadii Stepanov) `973a3b0c5d` cmake: Implement `install` build target (Hennadii Stepanov) `84ac35cfd4` cmake: Add cross-compiling support (Hennadii Stepanov) `0d01c228a7` build: Generate `toolchain.cmake` in depends (Hennadii Stepanov) `91a799247d` depends: Add host-specific `cmake_system_version` variables (Hennadii Stepanov) `9b31209b4c` depends: Rename `cmake_system` -> `cmake_system_name` (Hennadii Stepanov) `4a5208a81d` Revert "build, qt: Do not install .prl files" (Hennadii Stepanov) `6522af62af` depends: Amend handling flags environment variables (Hennadii Stepanov) `90cec4d251` cmake: Add `MULTIPROCESS` option (Hennadii Stepanov) `bb1a450dcb` cmake: Build `bitcoin-chainstate` executable (Hennadii Stepanov) `aed38ea58c` cmake: Build `bitcoinkernel` library (Hennadii Stepanov) `975d67369b` cmake: Build `test_bitcoin-qt` executable (Hennadii Stepanov) `10fcc668a3` cmake: Add `WITH_DBUS` option (Hennadii Stepanov) `5bb5a4bc75` cmake: Add `libqrencode` optional package support (Hennadii Stepanov) `57a6e2ef4a` cmake: Build `bitcoin-qt` executable (Hennadii Stepanov) `30f642952c` cmake: Add `WERROR` option (Hennadii Stepanov) `c98d4a4c34` cmake: Add `REDUCE_EXPORTS` option (Hennadii Stepanov) `a01cb6e63f` cmake: Add `HARDENING` option (Hennadii Stepanov) `a8a2e364ac` cmake: Add Python-based tests (Hennadii Stepanov) `3d85379570` cmake: Add fuzzing options (Hennadii Stepanov) `908530e312` cmake: Add `SANITIZERS` option (Hennadii Stepanov) `8bb0e85631` cmake: Build `bench_bitcoin` executable (Hennadii Stepanov) `801735163a` cmake: Add external signer support (Hennadii Stepanov) `353e0c9e96` cmake: Add `systemtap-sdt` optional package support (Hennadii Stepanov) `d2fda82b49` cmake: Add `libzmq` optional package support (Hennadii Stepanov) `ae7b39a0e1` cmake: Add `libminiupnpc` optional package support (Hennadii Stepanov) `6480e1dcdb` cmake: Add `libnatpmp` optional package support (Hennadii Stepanov) `e73e9304a1` cmake: Build `bitcoin-util` executable (Hennadii Stepanov) `027c6d7caa` cmake: Build `bitcoin-tx` executable (Hennadii Stepanov) `d10c5c34c3` cmake: Add wallet functionality (Hennadii Stepanov) `ab2e99b0d9` cmake: Create test suite for `ctest` (Hennadii Stepanov) `959370bd76` cmake: Build `test_bitcoin` executable (Hennadii Stepanov) `b27bf9700d` cmake: Build `bitcoin-cli` executable (Hennadii Stepanov) `a9813df826` cmake: Build `bitcoind` executable (Hennadii Stepanov) `97829ce2d5` cmake: Add `FindLibevent` module (Hennadii Stepanov) `3118e40c61` cmake: Build `bitcoin_consensus` library (Hennadii Stepanov) `809a2f1929` cmake: Build `bitcoin_util` static library (Hennadii Stepanov) `0a9a521a70` cmake: Build `bitcoin_crypto` library (Hennadii Stepanov) `958971f476` cmake: Build `univalue` static library (Hennadii Stepanov) `752747fda8` cmake: Generate `obj/build.h` header (Hennadii Stepanov) `1f0a78edf3` cmake: Build `minisketch` static library (Hennadii Stepanov) `12bfbc8154` cmake: Build `leveldb` static library (Hennadii Stepanov) `51985c5304` cmake: Build `crc32c` static library (Hennadii Stepanov) `db7a198f29` cmake: Build `secp256k1` subtree (Hennadii Stepanov) `dbb7ed14e8` cmake: Add `ccache` support (Hennadii Stepanov) `cedfdf6c72` cmake: Redefine/adjust per-configuration flags (Hennadii Stepanov) `b6b5e732c8` cmake: Add global compiler and linker flags (Hennadii Stepanov) `f98327931b` cmake: Add `TryAppendLinkerFlag` module (Hennadii Stepanov) `4a0af29697` cmake: Add `TryAppendCXXFlags` module (Hennadii Stepanov) `35cffc497d` cmake: Add POSIX threads support (Hennadii Stepanov) `fd72d00ffe` cmake: Add position independent code support (Hennadii Stepanov) `07069e2bb0` cmake: Add introspection module (Hennadii Stepanov) `27d687fc1f` cmake: Add `config/bitcoin-config.h` support (Hennadii Stepanov) `fe5cdace5f` cmake: Print compiler and linker flags in summary (Hennadii Stepanov) `70683884c5` cmake: Introduce interface libraries to encapsulate common flags (Hennadii Stepanov) `a2317e27b7` cmake: Add root `CMakeLists.txt` file (Hennadii Stepanov) Pull request description: This PR introduces a new CMake-based build system, which is a drop-in replacement for the current Autotools-based build system. ML announcement: https://groups.google.com/g/bitcoindev/c/hgKkfQWzrTo As discussed during the recent CoreDev meetup in April, the switch from Autotools to CMake is intended to happen as soon as possible after branching 28.x off, which means that 29.0 will be built using CMake. This PR branch is essentially the [staging branch](https://github.com/hebasto/bitcoin/tree/cmake-staging), with every change reviewed and tested by a group of contributors, including (in alphabetical order): - [achow101](https://github.com/achow101) - [fanquake](https://github.com/fanquake) - [maflcko](https://github.com/maflcko) - [m3dwards](https://github.com/m3dwards) - [pablomartin4btc](https://github.com/pablomartin4btc) - [real-or-random](https://github.com/real-or-random) - [ryanofsky](https://github.com/ryanofsky) - [sipsorcery](https://github.com/sipsorcery) - [TheCharlatan](https://github.com/TheCharlatan) - [theStack](https://github.com/theStack) - [theuni](https://github.com/theuni) - [vasild*](https://github.com/vasild) Reviewing in a separate staging repo was suggested in https://github.com/bitcoin/bitcoin/pull/27060#issuecomment-1431798320. The accompanying changes to the OSS-Fuzz project are available in https://github.com/hebasto/oss-fuzz/pull/8. Please refer to the [build options parity table](https://gist.github.com/hebasto/2ef97d3a726bfce08ded9df07f7dab5e). The "auto" value is no longer available; non-default values must be specified explicitly. Additionally, the new default values have been chosen to suit the everyday build experience for the majority of developers. System requirements for using the CMake-based build system: - CMake >= 3.22 (if not available in your system's repository, it can be downloaded from https://cmake.org/download/) - a build tool of your choice: - any Make (GNU Make is no longer a requirement); GNU Make is still required to build depends - Ninja (https://ninja-build.org/) - MSBuild - Xcode A note for Windows users: The default installation of the latest version of MSVC 17.10.4 includes both CMake 3.28.3 and the vcpkg package manager). --- We, the build system developers, kindly ask reviewers to refrain from making suggestions that are not directly related to the migration process or can be implemented separately. Bugs in the scripts and errors in the updated documentation should be the focus of this PR. Please be advised that comments not aligned with this PR's goal may be ignored. Thank you all for your understanding. ACKs for top commit: maflcko: review ACK `41051290ab` 🐥 sipsorcery: ACK `41051290ab`. vasild: ACK `41051290ab` TheCharlatan: ACK `41051290ab` pablomartin4btc: tACK `41051290ab` i-am-yuvi: tACK [`4105129`](`41051290ab`) theuni: ACK `41051290ab`. fanquake: ACK `41051290ab` Tree-SHA512: 6c1445054436c6c00ad63bfa0f19d64091a2b25c9bd694f85bf2218ac358ffb774d6c000685b3ca1e9b50401babed989fa2a0694b774c211d226bfd1944c9b39		2024-08-28 10:51:24 +01:00
..
lint	lint: Find function calls in default arguments	2024-08-09 08:11:16 +02:00
retry	build: update retry to current version	2019-10-30 18:49:57 -04:00
test	Merge bitcoin/bitcoin#30454 : build: Introduce CMake-based build system	2024-08-28 10:51:24 +01:00
lint_imagefile	lint: Add missing docker.io prefix to ci/lint_imagefile	2024-07-22 17:27:14 +02:00
lint_run_all.sh	lint: Use consistent out-of-tree build for python and test_runner	2024-07-22 14:01:24 +02:00
README.md	docs: ci multi-arch requires qemu	2024-02-20 10:55:33 +00:00
test_imagefile	ci: Fix macOS-cross SDK rsync	2023-08-16 10:30:50 +02:00
test_run_all.sh	ci: move-only CI_CONTAINER_ID to 02_run_container.sh	2023-10-09 16:17:04 +02:00

README.md

CI Scripts

This directory contains scripts for each build step in each build stage.

Running a Stage Locally

Be aware that the tests will be built and run in-place, so please run at your own risk. If the repository is not a fresh git clone, you might have to clean files from previous builds or test runs first.

The ci needs to perform various sysadmin tasks such as installing packages or writing to the user's home directory. While it should be fine to run the ci system locally on you development box, the ci scripts can generally be assumed to have received less review and testing compared to other parts of the codebase. If you want to keep the work tree clean, you might want to run the ci system in a virtual machine with a Linux operating system of your choice.

To allow for a wide range of tested environments, but also ensure reproducibility to some extent, the test stage requires bash, docker, and python3 to be installed. To run on different architectures than the host qemu is also required. To install all requirements on Ubuntu, run

sudo apt install bash docker.io python3 qemu-user-static

It is recommended to run the ci system in a clean env. To run the test stage with a specific configuration,

env -i HOME="$HOME" PATH="$PATH" USER="$USER" bash -c 'FILE_ENV="./ci/test/00_setup_env_arm.sh" ./ci/test_run_all.sh'

Configurations

The test files (FILE_ENV) are constructed to test a wide range of configurations, rather than a single pass/fail. This helps to catch build failures and logic errors that present on platforms other than the ones the author has tested.

Some builders use the dependency-generator in ./depends, rather than using the system package manager to install build dependencies. This guarantees that the tester is using the same versions as the release builds, which also use ./depends.

It is also possible to force a specific configuration without modifying the file. For example,

env -i HOME="$HOME" PATH="$PATH" USER="$USER" bash -c 'MAKEJOBS="-j1" FILE_ENV="./ci/test/00_setup_env_arm.sh" ./ci/test_run_all.sh'

The files starting with 0n (n greater than 0) are the scripts that are run in order.

Cache

In order to avoid rebuilding all dependencies for each build, the binaries are cached and reused when possible. Changes in the dependency-generator will trigger cache-invalidation and rebuilds as necessary.