feat(google_benchmark): expose codspeed mode as a cmake option

Author: GuillaumeLagrange

core/CMakeLists.txt

@@ -17,20 +17,83 @@ add_library(codspeed src/codspeed.cpp src/walltime.cpp src/uri.cpp)
 # Version
 add_compile_definitions(CODSPEED_VERSION="${CODSPEED_VERSION}")
 
+# Specify the include directories for users of the library
+target_include_directories(
+    codspeed
+    PUBLIC $<BUILD_INTERFACE:${PROJECT_SOURCE_DIR}/include>
+)
+
 # Disable valgrind compilation errors
 if(CMAKE_CXX_COMPILER_ID MATCHES "GNU|Clang")
     # Disable the old-style-cast warning for the specific target
     target_compile_options(codspeed PRIVATE -Wno-old-style-cast)
 endif()
 
-# Specify the include directories for users of the library
-target_include_directories(
+execute_process(
+    COMMAND git rev-parse --show-toplevel
+    OUTPUT_VARIABLE GIT_ROOT_DIR
+    OUTPUT_STRIP_TRAILING_WHITESPACE
+    RESULT_VARIABLE GIT_COMMAND_RESULT
+)
+
+if(NOT GIT_COMMAND_RESULT EQUAL 0)
+    message(
+        WARNING
+        "Failed to determine the git root directory.\
+        Check that git is in your PATH, and that you are in a git repository.\
+        Continuing, but codspeed features will not be useable"
+    )
+    # Default to user's cmake source directory
+    set(GIT_ROOT_DIR ${CMAKE_SOURCE_DIR})
+endif()
+
+target_compile_definitions(
     codspeed
-    PUBLIC $<BUILD_INTERFACE:${PROJECT_SOURCE_DIR}/include>
+    INTERFACE -DCODSPEED_GIT_ROOT_DIR="${GIT_ROOT_DIR}"
+)
+
+set(CODSPEED_MODE_ALLOWED_VALUES "OFF" "instrumentation" "walltime")
+set(CODSPEED_MODE "OFF" CACHE STRING "Build mode for Codspeed")
+set_property(
+    CACHE CODSPEED_MODE
+    PROPERTY STRINGS ${CODSPEED_MODE_ALLOWED_VALUES}
 )
 
+if(NOT CODSPEED_MODE STREQUAL "OFF")
+    target_compile_definitions(codspeed INTERFACE -DCODSPEED_ENABLED)
+
+    if(NOT CMAKE_BUILD_TYPE)
+        message(
+            WARNING
+            "CMAKE_BUILD_TYPE is not set. Consider setting it to 'RelWithDebInfo'."
+        )
+    elseif(NOT CMAKE_BUILD_TYPE STREQUAL "RelWithDebInfo")
+        message(
+            WARNING
+            "CMAKE_BUILD_TYPE is set to '${CMAKE_BUILD_TYPE}', but 'RelWithDebInfo' is recommended."
+        )
+    endif()
+
+    # Define a preprocessor macro based on the build mode
+    if(CODSPEED_MODE STREQUAL "instrumentation")
+        target_compile_definitions(
+            codspeed
+            INTERFACE -DCODSPEED_INSTRUMENTATION
+        )
+    elseif(CODSPEED_MODE STREQUAL "walltime")
+        target_compile_definitions(codspeed INTERFACE -DCODSPEED_WALLTIME)
+    else()
+        message(
+            FATAL_ERROR
+            "Invalid build mode: ${CODSPEED_MODE}. Use one of ${CODSPEED_MODE_ALLOWED_VALUES}."
+        )
+    endif()
+endif()
+
+message(STATUS "Codspeed mode: ${CODSPEED_MODE}")
+
 option(ENABLE_TESTS "Enable building the unit tests which depend on gtest" OFF)
 if(ENABLE_TESTS)
-    enable_testing() 
+    enable_testing()
     add_subdirectory(test)
 endif()

google_benchmark/cmake/Codspeed.cmake

@@ -1,44 +1 @@
 add_subdirectory(${PROJECT_SOURCE_DIR}/../core codspeed)
-
-execute_process(
-    COMMAND git rev-parse --show-toplevel
-    OUTPUT_VARIABLE GIT_ROOT_DIR
-    OUTPUT_STRIP_TRAILING_WHITESPACE
-    RESULT_VARIABLE GIT_COMMAND_RESULT
-)
-
-if(NOT GIT_COMMAND_RESULT EQUAL 0)
-    message(
-        WARNING
-        "Failed to determine the git root directory.\
-        Check that git is in your PATH, and that you are in a git repository.\
-        Continuing, but codspeed features will not be useable"
-    )
-    # Default to user's cmake source directory
-    set(GIT_ROOT_DIR ${CMAKE_SOURCE_DIR})
-endif()
-
-target_compile_definitions(
-    codspeed
-    INTERFACE -DCODSPEED_GIT_ROOT_DIR="${GIT_ROOT_DIR}"
-)
-
-if(DEFINED CODSPEED_MODE)
-    target_compile_definitions(codspeed INTERFACE -DCODSPEED_ENABLED)
-    # Define a preprocessor macro based on the build mode
-    if(CODSPEED_MODE STREQUAL "instrumentation")
-        target_compile_definitions(
-            codspeed
-            INTERFACE -DCODSPEED_INSTRUMENTATION
-        )
-    elseif(CODSPEED_MODE STREQUAL "walltime")
-        target_compile_definitions(codspeed INTERFACE -DCODSPEED_WALLTIME)
-    else()
-        message(
-            FATAL_ERROR
-            "Invalid build mode: ${CODSPEED_MODE}. Use 'instrumentation' or 'walltime'."
-        )
-    endif()
-endif()
-
-message(STATUS "Build mode set to: ${CODSPEED_MODE}")