Skip to content

Specify default opt/debug options for different CMAKE_BUILD_TYPEs #409

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

Merged
knoepfel merged 4 commits into from
Mar 19, 2026
Merged

Specify default opt/debug options for different CMAKE_BUILD_TYPEs #409

Changes from 3 commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
7977bee
Specify default opt/debug options for different `CMAKE_BUILD_TYPE`s
greenc-FNAL Mar 10, 2026
2d43e34
Apply cmake-format fixes
github-actions[bot] Mar 11, 2026
7c2d602
Use DEFINED CACHE{} guard; remove FORCE for build-type flags
greenc-FNAL Mar 18, 2026
bedb14b
Apply cmake-format fixes
github-actions[bot] Mar 18, 2026
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
119 changes: 81 additions & 38 deletions CMakeLists.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ FetchContent_Declare(
GIT_SHALLOW ON
EXCLUDE_FROM_ALL # Do not install
FIND_PACKAGE_ARGS 4.01.01
)
)
# ... and the Catch2 unit testing framework
FetchContent_Declare(
Catch2
Expand All @@ -19,7 +19,7 @@ FetchContent_Declare(
GIT_SHALLOW ON
EXCLUDE_FROM_ALL # Do not install
FIND_PACKAGE_ARGS
)
)
# ... and Microsoft's C++ Guideline Support Library
FetchContent_Declare(
GSL
Expand All @@ -28,7 +28,7 @@ FetchContent_Declare(
GIT_SHALLOW ON
EXCLUDE_FROM_ALL # Do not install
FIND_PACKAGE_ARGS NAMES Microsoft.GSL
)
)
# ... and the Mimic C++ mocking framework
FetchContent_Declare(
mimicpp
Expand All @@ -37,22 +37,60 @@ FetchContent_Declare(
GIT_SHALLOW ON
EXCLUDE_FROM_ALL # Do not install
FIND_PACKAGE_ARGS
)
)

# ##############################################################################
# Initial compilation flags for build types we care about. Setting these in the
# cache before project() prevents CMake's per-compiler defaults from overwriting
# them; using DEFINED CACHE{} respects any value the user has already placed in
# the cache (e.g. via -D on the command line).
if(NOT DEFINED CACHE{CMAKE_CXX_FLAGS_DEBUG})
set(CMAKE_CXX_FLAGS_DEBUG
"-Og -g"
CACHE STRING "Flags used by the CXX compiler during DEBUG builds."
)
endif()

if(NOT DEFINED CACHE{CMAKE_CXX_FLAGS_RELEASE})
set(CMAKE_CXX_FLAGS_RELEASE
"-O3 -g0 -DNDEBUG"
CACHE STRING "Flags used by the CXX compiler during RELEASE builds."
)
endif()

if(NOT DEFINED CACHE{CMAKE_CXX_FLAGS_RELWITHDEBINFO})
set(CMAKE_CXX_FLAGS_RELWITHDEBINFO
"-O3 -fno-omit-frame-pointer -g -DNDEBUG"
CACHE STRING
"Flags used by the CXX compiler during RELWITHDEBINFO builds."
)
endif()
# ##############################################################################

# Make cetmodules available
FetchContent_MakeAvailable(cetmodules)
find_package(cetmodules 4.01.01 REQUIRED)

# ##############################################################################
# Main project declaration
project(phlex VERSION 0.1.0 LANGUAGES CXX)
project(
phlex
VERSION 0.1.0
LANGUAGES CXX
)
cet_cmake_env()
# ##############################################################################

# Set CI/test timeouts to a conservative value to avoid long stalls in CI.
# Use cache variables so generated CTest/Dart files pick this up when configured.
set(DART_TESTING_TIMEOUT 90 CACHE STRING "Timeout (s) for Dart/CTest runs")
set(CTEST_TEST_TIMEOUT 90 CACHE STRING "Per-test timeout (s) for CTest")
# Set CI/test timeouts to a conservative value to avoid long stalls in CI. Use
# cache variables so generated CTest/Dart files pick this up when configured.
set(DART_TESTING_TIMEOUT
90
CACHE STRING "Timeout (s) for Dart/CTest runs"
)
set(CTEST_TEST_TIMEOUT
90
CACHE STRING "Per-test timeout (s) for CTest"
)

# Make tools available
FetchContent_MakeAvailable(Catch2 GSL mimicpp)
Expand All @@ -64,13 +102,7 @@ option(ENABLE_ASAN "Enable Address Sanitizer" OFF)
option(PHLEX_USE_FORM "Enable experimental integration with FORM" OFF)
option(ENABLE_COVERAGE "Enable code coverage instrumentation" OFF)

add_compile_options(
-Wall
-Werror
-Wunused
-Wunused-parameter
-pedantic
)
add_compile_options(-Wall -Werror -Wunused -Wunused-parameter -pedantic)

if(CMAKE_CXX_COMPILER_ID STREQUAL "GNU")
if(CMAKE_CXX_COMPILER_VERSION VERSION_GREATER_EQUAL "14.1")
Expand Down Expand Up @@ -99,11 +131,10 @@ find_package(spdlog REQUIRED)
# Apply ThreadSanitizer flags if enabled
if(ENABLE_TSAN)
# Check if the compiler supports ThreadSanitizer
if(
CMAKE_CXX_COMPILER_ID MATCHES "Clang"
OR CMAKE_CXX_COMPILER_ID MATCHES "AppleClang"
OR CMAKE_CXX_COMPILER_ID MATCHES "GNU"
)
if(CMAKE_CXX_COMPILER_ID MATCHES "Clang"
OR CMAKE_CXX_COMPILER_ID MATCHES "AppleClang"
OR CMAKE_CXX_COMPILER_ID MATCHES "GNU"
)
message(STATUS "Enabling ThreadSanitizer")
# Add the sanitizer flag
add_compile_options(
Expand All @@ -113,20 +144,22 @@ if(ENABLE_TSAN)
# Ensure no optimizations interfere with TSan
"$<$<COMPILE_LANG_AND_ID:CXX,GNU>:-fno-omit-frame-pointer>"
"$<$<COMPILE_LANG_AND_ID:CXX,GNU>:-fno-optimize-sibling-calls>"
)
)
add_link_options(-fsanitize=thread)
else()
message(FATAL_ERROR "ThreadSanitizer is not supported with ${CMAKE_CXX_COMPILER_ID}")
message(
FATAL_ERROR
"ThreadSanitizer is not supported with ${CMAKE_CXX_COMPILER_ID}"
)
endif()
endif()

if(ENABLE_ASAN)
# Check if the compiler supports AddressSanitizer
if(
CMAKE_CXX_COMPILER_ID MATCHES "Clang"
OR CMAKE_CXX_COMPILER_ID MATCHES "AppleClang"
OR CMAKE_CXX_COMPILER_ID MATCHES "GNU"
)
if(CMAKE_CXX_COMPILER_ID MATCHES "Clang"
OR CMAKE_CXX_COMPILER_ID MATCHES "AppleClang"
OR CMAKE_CXX_COMPILER_ID MATCHES "GNU"
)
message(STATUS "Enabling AddressSanitizer")
# Add the sanitizer flag
add_compile_options(
Expand All @@ -136,34 +169,44 @@ if(ENABLE_ASAN)
# Ensure no optimizations interfere with ASan
"$<$<COMPILE_LANG_AND_ID:CXX,GNU>:-fno-omit-frame-pointer>"
"$<$<COMPILE_LANG_AND_ID:CXX,GNU>:-fno-optimize-sibling-calls>"
)
)
add_link_options(-fsanitize=address)
else()
message(FATAL_ERROR "AddressSanitizer is not supported with ${CMAKE_CXX_COMPILER_ID}")
message(
FATAL_ERROR
"AddressSanitizer is not supported with ${CMAKE_CXX_COMPILER_ID}"
)
endif()
endif()

# Configure code coverage if enabled
if(ENABLE_COVERAGE)
# Check if the compiler supports code coverage
if(
CMAKE_CXX_COMPILER_ID MATCHES "GNU"
OR CMAKE_CXX_COMPILER_ID MATCHES "Clang"
OR CMAKE_CXX_COMPILER_ID MATCHES "AppleClang"
)
if(CMAKE_CXX_COMPILER_ID MATCHES "GNU"
OR CMAKE_CXX_COMPILER_ID MATCHES "Clang"
OR CMAKE_CXX_COMPILER_ID MATCHES "AppleClang"
)
message(STATUS "Enabling code coverage instrumentation")

# Set the build type to Coverage if not specified
if(NOT CMAKE_BUILD_TYPE)
set(CMAKE_BUILD_TYPE Coverage CACHE STRING "Build type" FORCE)
set(CMAKE_BUILD_TYPE
Coverage
CACHE STRING "Build type" FORCE
)
endif()
else()
message(FATAL_ERROR "Code coverage is not supported with ${CMAKE_CXX_COMPILER_ID}")
message(
FATAL_ERROR "Code coverage is not supported with ${CMAKE_CXX_COMPILER_ID}"
)
endif()
endif()

if(NOT CMAKE_BUILD_TYPE)
set(CMAKE_BUILD_TYPE RelWithDebInfo CACHE STRING "Build type" FORCE)
set(CMAKE_BUILD_TYPE
RelWithDebInfo
CACHE STRING "Build type" FORCE
)
endif()

add_subdirectory(phlex)
Expand Down
Loading