Skip to content

Adds PROCESSORS property to tests based on number of ranks and threads #749

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.

Sign up for GitHub

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

Draft
kennyweiss wants to merge 3 commits into
base: develop
Choose a base branch
from
Draft

Adds PROCESSORS property to tests based on number of ranks and threads #749

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
c3a09c1
Adds the PROCESSORS property to each test, accounting for MPI ranks a…
kennyweiss Dec 21, 2025
0197de1
Update RELEASE-NOTES
kennyweiss Dec 22, 2025
b2fd465
Account for padding on NUM_MPI_TASKS and NUM_OMP_THREADS parameters i…
kennyweiss Dec 22, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions RELEASE-NOTES.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,10 @@ The project release numbers follow [Semantic Versioning](http://semver.org/spec/

## [Unreleased] - Release date yyyy-mm-dd

### Added
- Adds `PROCESSORS` property to tests based on the number of mpi ranks (`NUM_MPI_THREADS`) and OpenMP threads (`NUM_OMP_THREADS`).
This gives CTest more context for scheduling tests.

### Changed
- Removed default use of `/bigobj` flag for Visual Studio builds. Projects should add this flag explicitly if needed for windows builds.
- Removed `-Winline` from being added to GoogleTest for Clang/Intel as it is a noop and caused a warning on Intel.
Expand Down
38 changes: 33 additions & 5 deletions cmake/BLTMacros.cmake
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -461,8 +461,10 @@ macro(blt_add_test)
# Handle MPI
if( arg_NUM_MPI_TASKS )
# first check that the number of ranks is a positive integer
string(REGEX MATCH "^-?[0-9]+$" _is_integer "${arg_NUM_MPI_TASKS}")
if( NOT _is_integer OR arg_NUM_MPI_TASKS LESS 1)
set(_num_mpi_tasks "${arg_NUM_MPI_TASKS}")
string(STRIP "${_num_mpi_tasks}" _num_mpi_tasks)
string(REGEX MATCH "^-?[0-9]+$" _is_integer "${_num_mpi_tasks}")
if( NOT _is_integer OR _num_mpi_tasks LESS 1)
message(FATAL_ERROR "In blt_add_test(), attempted to run an mpi test with invalid NUM_MPI_TASKS: ${arg_NUM_MPI_TASKS}")
endif()

Expand All @@ -475,8 +477,8 @@ macro(blt_add_test)
set(_mpiexec ${MPIEXEC})
endif()

set(_test_command ${_mpiexec} ${MPIEXEC_NUMPROC_FLAG} ${arg_NUM_MPI_TASKS} ${BLT_MPI_COMMAND_APPEND} ${_test_command} )
elseif( arg_NUM_MPI_TASKS EQUAL 1)
set(_test_command ${_mpiexec} ${MPIEXEC_NUMPROC_FLAG} ${_num_mpi_tasks} ${BLT_MPI_COMMAND_APPEND} ${_test_command} )
elseif( _num_mpi_tasks EQUAL 1)
# no-op: Allow NUM_MPI_TASKS to be 1 when not using MPI
else()
message(FATAL_ERROR "In blt_add_test(), attempted to invoke a test with ${arg_NUM_MPI_TASKS} ranks in a non-mpi configuration")
Expand All @@ -490,10 +492,36 @@ macro(blt_add_test)

# Handle OpenMP
if( arg_NUM_OMP_THREADS )
# Ensure the number of OpenMP threads is a positive integer
set(_num_omp_threads "${arg_NUM_OMP_THREADS}")
string(STRIP "${_num_omp_threads}" _num_omp_threads)
string(REGEX MATCH "^-?[0-9]+$" _is_integer "${_num_omp_threads}")
if( NOT _is_integer OR _num_omp_threads LESS 1)
message(FATAL_ERROR "In blt_add_test(), attempted to run a test with invalid NUM_OMP_THREADS: ${arg_NUM_OMP_THREADS}")
endif()

set_property(TEST ${arg_NAME}
APPEND PROPERTY ENVIRONMENT OMP_NUM_THREADS=${arg_NUM_OMP_THREADS})
APPEND PROPERTY ENVIRONMENT OMP_NUM_THREADS=${_num_omp_threads})
endif()

# Inform CTest how many processor slots this test needs for scheduling.
# When tests are parallelized with `ctest --parallel/-j`, CTest uses this
# property to avoid oversubscribing the available resources.
set(_blt_num_mpi_tasks 1)
if( arg_NUM_MPI_TASKS )
set(_blt_num_mpi_tasks ${_num_mpi_tasks})
endif()

set(_blt_num_omp_threads 1)
if( arg_NUM_OMP_THREADS )
set(_blt_num_omp_threads ${_num_omp_threads})
endif()

math(EXPR _blt_test_processors "${_blt_num_mpi_tasks} * ${_blt_num_omp_threads}")

set_tests_properties(${arg_NAME}
PROPERTIES PROCESSORS ${_blt_test_processors})

endmacro(blt_add_test)


Expand Down
4 changes: 4 additions & 0 deletions docs/api/target.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -315,6 +315,10 @@ is useful on machines that require extra arguments to ``MPIEXEC``.
If ``NUM_OMP_THREADS`` is given, this macro will set the environment variable ``OMP_NUM_THREADS``
before running this test. This is done by appending to the CMake tests property.

This macro also sets the CTest ``PROCESSORS`` property to help with test scheduling when using
``ctest --parallel/-j``. The value is computed as ``NUM_MPI_TASKS * NUM_OMP_THREADS``, treating
any omitted value as 1.

.. note::
If you do not require this macros command line assistance, you can call CMake's
``add_test()`` directly. For example, you may have a script checked into your
Expand Down