Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

cmake: Emulate GNU Autotools 'make check -jN' #1294

Closed
wants to merge 1 commit into from

Conversation

hebasto
Copy link
Member

@hebasto hebasto commented May 4, 2023

It seems parallelism is requested for make check target when building with CMake and the "Unix Makefiles" generator which is the default on Linux and macOS. See:

13:53 < sipa> make -j check doesn't actually parallellize in the cmake build, which is a bit unfortunate

Is make check being run with multiple jobs? I assume not

With this PR, it is possible to build like that:

cmake -S . -B  build
make -C build -j $(nproc)
make check -C build -j $(nproc)

Making this PR a draft as it seems low priority and the diff seems a bit hackish.

My personal preference is to use the CMake's native ctest command :)

Anyway, this PR fixes an item in #1235.


UPD. Here is a couple of alternative approaches:

export CTEST_PARALLEL_LEVEL=$(nproc)
  • use the test target and (undocumented) ARGS variable:
make test -C build ARGS=-j$(nproc)

# Emulate GNU Autotools 'make check -jN'.
add_custom_target(check
COMMAND @$(CMAKE_COMMAND) -E cmake_echo_color --switch=$(COLOR) --cyan \"Running tests...\"
COMMAND ${CMAKE_CTEST_COMMAND} --force-new-ctest-process -$(MAKEFLAGS)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Passing $MAKEFLAGS to ctest is indeed pretty hackish (and ctest doesn't like -j without an integer and some users have more MAKEFLAGS set in their env...)

@real-or-random
Copy link
Contributor

My personal preference is to use the CMake's native ctest command :)

Yep, we should just update the CMake build docs in the README. We could even remove the "make check" emulation entirely if this is more CMake-ish. What do you think?

@hebasto
Copy link
Member Author

hebasto commented May 5, 2023

My personal preference is to use the CMake's native ctest command :)

Yep, we should just update the CMake build docs in the README. We could even remove the "make check" emulation entirely if this is more CMake-ish. What do you think?

As we discussed at CoreDev, it would be better for the common good to use a unified approach for both projects, Bitcoin Core and libsecp256k1. A similar discussion is currently taking place in Bitcoin Core (here, here and here). Regarding your question, I think it would be advisable to ask for the opinions of developers who expressed concerns about make check, namely @sipa and @fanquake.

@hebasto
Copy link
Member Author

hebasto commented May 5, 2023

I've updated the PR description with a couple of alternatives.

@real-or-random
Copy link
Contributor

As we discussed at CoreDev, it would be better for the common good to use a unified approach for both projects, Bitcoin Core and libsecp256k1

@hebasto Has been any progress on this point in Core?

@hebasto
Copy link
Member Author

hebasto commented Jan 17, 2024

As we discussed at CoreDev, it would be better for the common good to use a unified approach for both projects, Bitcoin Core and libsecp256k1

@hebasto Has been any progress on this point in Core?

In the https://github.com/hebasto/bitcoin/tree/cmake-staging, we lean to use the native CMake's invocations in all scripts (CI, Guix etc). This approach is agnostic to the underlying build system, and make check parallelism issue is no longer a concern.

However, it might change in the future :)

real-or-random added a commit to real-or-random/secp256k1 that referenced this pull request Jan 17, 2024
@real-or-random
Copy link
Contributor

In the hebasto/bitcoin@cmake-staging, we lean to use the native CMake's invocations in all scripts (CI, Guix etc). This approach is agnostic to the underlying build system, and make check parallelism issue is no longer a concern.

Let's stick with this for now. Then people can use ctest -j3 or ctest -j$(nproc) or they can also set CTEST_PARALLEL_LEVEL="$(nproc)" similar to MAKEFLAGS="-j($proc)". Just be aware that ctest -j (without an explicit int) doesn't have an effect.

@hebasto hebasto closed this Jan 17, 2024
theStack pushed a commit to theStack/secp256k1 that referenced this pull request Jan 24, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants