build: Introduce CMake-based build system #75

hebasto · 2022-10-20T00:02:25Z

This PR introduces a new CMake-based build system, which can be reused in downstream projects, including Bitcoin Core.

Additionally, a GitHub Actions CI task for MSVC and clang-cl has been added, following this feedback.

Autotools vs CMake configuration option parity

Autotools	CMake
`--disable-ccache`	N/A
`--enable-tests`	`-DMINISKETCH_BUILD_TESTS`
`--enable-benchmark`	`-DMINISKETCH_BUILD_BENCHMARK`
`--enable-fields=,-separated list`	`-DMINISKETCH_FIELDS=;-separated list`
	`-DMINISKETCH_INSTALL`

Notes on the implementation

The default CMAKE_BUILD_TYPE is left unset.
CMake's per-configuration compiler flags are not modified. As a result, they may include -DNDEBUG.
The target name test is reserved. Therefore, the testing binary has been renamed to test-noverify. Alternatively, following the naming used in the libsecp256k1 repo, the test binaries could be renamed as:
- test --> noverify_tests
- test-verify --> verify_tests

hebasto · 2022-10-20T00:03:02Z

Chasing for Concept (N)ACKs...

hebasto · 2022-10-23T09:42:45Z

The currently suggesting minimal CMake-based build system implementation is enough for:

building binaries on Windows natively, including CI
integrating with Bitcoin Core CMake-based build system as easy as

add_subdirectory(minisketch EXCLUDE_FROM_ALL)
target_compile_definitions(minisketch
  PRIVATE
    DISABLE_DEFAULT_FIELDS
    ENABLE_FIELD_32
)

To became a full fledged one, the current minimal CMake-based build system requires some additional features:

more robustness (e.g., checking compiler/linker flags before applying them)
ability to install the built artifacts
ability to export the built artifacts and, probably, packaging of them
documentation

Although, those features are not required for this PR goal, i.e., providing a native Windows CI task.

hebasto · 2022-10-31T13:19:35Z

Updated 5851544 -> d2408e0 (pr75.03 -> pr75.04, diff):

policy CMP0063 set explicitly to avoid CMake warnings
the default CMake build directory added to the .gitignore file

theuni · 2023-03-17T20:23:38Z

Imo this should be renamed "Add CMake buildsystem". I looked for this a while back and didn't find it because CMake isn't mentioned in the title.

Concept ACK. Will review next week.

theuni · 2023-03-31T14:31:58Z

@sipa Are you interested in CMake for this project?

sipa · 2023-03-31T20:17:37Z

@theuni Yeah, will look soon.

theuni · 2023-03-31T20:32:41Z

@sipa No rush. I was just looking for a concept ACK.

I worked up a CMake impl as well before seeing this PR. I think we'd benefit from parts of each, so I'll get with @hebasto on creating a combined version for review.

hebasto · 2023-04-16T12:11:21Z

Imo this should be renamed "Add CMake buildsystem".

Done.

sipa · 2024-04-11T10:11:50Z

I'm happy to add a CMake build system for minisketch. I will need review from people more experienced with build systems, though.

hebasto · 2024-04-11T11:09:34Z

I'm happy to add a CMake build system for minisketch. I will need review from people more experienced with build systems, though.

I'm going to update this PR shortly.

hebasto · 2024-04-16T17:00:07Z

Reworked.

The PR description has been updated.

The approach from hebasto/bitcoin#93 was used for printing summary.

theuni · 2024-04-26T14:05:29Z

CMakeLists.txt

+endif()
+
+if(MINGW)
+  add_link_options(-static)


I don't think we should port this functionality. Instead we should use the CMake shared/static selection machinery.

This affects only benchmark/test binaries and allows to run them on the build system via Wine when building either a static library or a shared one.

UPD. It also links libstdc++-6 to libminisketch.dll statically when cross-compiling for Windows and -DBUILD_SHARED_LIBS=YES is provided.

Consider

cmake -B build \ -DCMAKE_BUILD_TYPE=Release \ -DCMAKE_SYSTEM_NAME=Windows \ -DCMAKE_CXX_COMPILER=x86_64-w64-mingw32-g++-posix cmake --build build --target test wine ./build/src/test.exe

or

cmake -B build \ -DCMAKE_BUILD_TYPE=Release \ -DCMAKE_SYSTEM_NAME=Windows \ -DCMAKE_CXX_COMPILER=x86_64-w64-mingw32-g++-posix \ -DBUILD_SHARED_LIBS=YES cmake --build build --target test wine ./build/src/test.exe

src/CMakeLists.txt

CMakeLists.txt

theuni · 2024-04-26T14:30:14Z

CMakeLists.txt

+)
+
+if(DEFINED CMAKE_CXX_STANDARD)
+  if(CMAKE_CXX_STANDARD EQUAL 98 OR CMAKE_CXX_STANDARD LESS 11)


Hah! Stupid CMake :)

Y2K problem :)

hebasto · 2024-04-26T16:02:17Z

Addressed @theuni's comments.

sipa · 2025-05-13T18:03:10Z

What is the status here?

hebasto · 2025-05-13T18:05:06Z

What is the status here?

I'll push an update shortly.

hebasto · 2025-06-01T01:53:58Z

Rebased.

PR description has been updated:

a GitHub Actions CI task for MSVC and clang-cl has been added

@sipa

Could you please enable Actions in this repository?

hebasto · 2025-06-01T02:04:39Z

CMakeLists.txt

@@ -0,0 +1,116 @@
+cmake_minimum_required(VERSION 3.22)


The cmake_minimum_required() command does two things:

Sets the minimum required version of CMake for the project.

Sets the policy settings.

Rationale for point 1:

Minimum required version 3.22 allows to build on Ubuntu 22.04 LTS.

Same as in Bitcoin Core.

Rationale for point 2:

From Professional CMake: A Practical Guide, 21st Edition, Section 13.1:

This gives projects confidence that developers should be able to update to any newer version of CMake at their convenience, and the project will still build as it did before.

Some other developers, namely @ryanofsky and @purpleKarrot, disagree.
See: bitcoin-core/libmultiprocess#163.

hebasto · 2025-06-01T02:07:23Z

CMakeLists.txt

+# ============================================================
+# Project Initialization
+# ============================================================
+enable_testing()


I believe this is superior to include(CTest), as the latter has a few drawbacks.

Some other developers, namely @purpleKarrot, disagree.
See: bitcoin-core/libmultiprocess#145

hebasto force-pushed the 221019-ci-msvc branch from bd57926 to 14503b1 Compare October 23, 2022 08:00

hebasto marked this pull request as ready for review October 23, 2022 08:02

hebasto force-pushed the 221019-ci-msvc branch from 14503b1 to 30fdfb3 Compare October 23, 2022 09:40

hebasto force-pushed the 221019-ci-msvc branch from 30fdfb3 to 5851544 Compare October 30, 2022 20:41

hebasto mentioned this pull request Oct 30, 2022

build: Add CMake-based build system bitcoin-core/secp256k1#1113

Merged

hebasto force-pushed the 221019-ci-msvc branch from 5851544 to d2408e0 Compare October 31, 2022 13:14

hebasto changed the title ~~ci: Add "x86_64: Windows (VS 2022)" task~~ build: Add CMake buildsystem Apr 16, 2023

hebasto force-pushed the 221019-ci-msvc branch 2 times, most recently from 66b4133 to b486457 Compare April 16, 2024 16:44

theuni reviewed Apr 26, 2024

View reviewed changes

hebasto force-pushed the 221019-ci-msvc branch from b486457 to cbbfdae Compare April 26, 2024 16:01

hebasto force-pushed the 221019-ci-msvc branch from cbbfdae to 300dd9a Compare April 26, 2024 16:26

theuni mentioned this pull request Apr 26, 2024

Fix or disable conversion warnings? #84

Closed

hebasto marked this pull request as draft March 5, 2025 14:14

hebasto force-pushed the 221019-ci-msvc branch from 300dd9a to 900d0c8 Compare June 1, 2025 01:07

hebasto marked this pull request as ready for review June 1, 2025 01:09

hebasto force-pushed the 221019-ci-msvc branch 2 times, most recently from 6d4c1cf to 43bbb56 Compare June 1, 2025 01:24

hebasto added 3 commits June 1, 2025 02:28

build: Add CMake-based build system

52424a5

doc: Add "Building with CMake" section to README.md

a10452a

ci: Add GHA workflow with native Windows job

2b67966

hebasto force-pushed the 221019-ci-msvc branch from 43bbb56 to 2b67966 Compare June 1, 2025 01:28

hebasto changed the title ~~build: Add CMake buildsystem~~ build: Introduce CMake-based buildsystem Jun 1, 2025

hebasto changed the title ~~build: Introduce CMake-based buildsystem~~ build: Introduce CMake-based build system Jun 1, 2025

hebasto commented Jun 1, 2025

View reviewed changes

build: Introduce CMake-based build system #75

Are you sure you want to change the base?

build: Introduce CMake-based build system #75

Conversation

hebasto commented Oct 20, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Autotools vs CMake configuration option parity

Notes on the implementation

Uh oh!

hebasto commented Oct 20, 2022

Uh oh!

hebasto commented Oct 23, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

hebasto commented Oct 31, 2022

Uh oh!

theuni commented Mar 17, 2023

Uh oh!

theuni commented Mar 31, 2023

Uh oh!

sipa commented Mar 31, 2023

Uh oh!

theuni commented Mar 31, 2023

Uh oh!

hebasto commented Apr 16, 2023

Uh oh!

sipa commented Apr 11, 2024

Uh oh!

hebasto commented Apr 11, 2024

Uh oh!

hebasto commented Apr 16, 2024

Uh oh!

theuni Apr 26, 2024

Choose a reason for hiding this comment

Uh oh!

hebasto Apr 26, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

hebasto Apr 26, 2024

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

theuni Apr 26, 2024

Choose a reason for hiding this comment

Uh oh!

hebasto Apr 26, 2024

Choose a reason for hiding this comment

Uh oh!

hebasto commented Apr 26, 2024

Uh oh!

sipa commented May 13, 2025

Uh oh!

hebasto commented May 13, 2025

Uh oh!

hebasto commented Jun 1, 2025

Uh oh!

hebasto Jun 1, 2025

Choose a reason for hiding this comment

Uh oh!

hebasto Jun 1, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

hebasto commented Oct 20, 2022 •

edited

Loading

hebasto commented Oct 23, 2022 •

edited

Loading

hebasto Apr 26, 2024 •

edited

Loading