1# Require CMake 3.10. If available, use the policies up to CMake 3.22. 2cmake_minimum_required (VERSION 3.10...3.22) 3 4project (benchmark VERSION 1.8.3 LANGUAGES CXX) 5 6option(BENCHMARK_ENABLE_TESTING "Enable testing of the benchmark library." ON) 7option(BENCHMARK_ENABLE_EXCEPTIONS "Enable the use of exceptions in the benchmark library." ON) 8option(BENCHMARK_ENABLE_LTO "Enable link time optimisation of the benchmark library." OFF) 9option(BENCHMARK_USE_LIBCXX "Build and test using libc++ as the standard library." OFF) 10option(BENCHMARK_ENABLE_WERROR "Build Release candidates with -Werror." ON) 11option(BENCHMARK_FORCE_WERROR "Build Release candidates with -Werror regardless of compiler issues." OFF) 12 13if("${CMAKE_CXX_COMPILER_ID}" STREQUAL "PGI") 14 # PGC++ maybe reporting false positives. 15 set(BENCHMARK_ENABLE_WERROR OFF) 16endif() 17if("${CMAKE_CXX_COMPILER_ID}" STREQUAL "NVHPC") 18 set(BENCHMARK_ENABLE_WERROR OFF) 19endif() 20if(BENCHMARK_FORCE_WERROR) 21 set(BENCHMARK_ENABLE_WERROR ON) 22endif(BENCHMARK_FORCE_WERROR) 23 24if(NOT MSVC) 25 option(BENCHMARK_BUILD_32_BITS "Build a 32 bit version of the library." OFF) 26else() 27 set(BENCHMARK_BUILD_32_BITS OFF CACHE BOOL "Build a 32 bit version of the library - unsupported when using MSVC)" FORCE) 28endif() 29option(BENCHMARK_ENABLE_INSTALL "Enable installation of benchmark. (Projects embedding benchmark may want to turn this OFF.)" ON) 30option(BENCHMARK_ENABLE_DOXYGEN "Build documentation with Doxygen." OFF) 31option(BENCHMARK_INSTALL_DOCS "Enable installation of documentation." ON) 32 33# Allow unmet dependencies to be met using CMake's ExternalProject mechanics, which 34# may require downloading the source code. 35option(BENCHMARK_DOWNLOAD_DEPENDENCIES "Allow the downloading and in-tree building of unmet dependencies" OFF) 36 37# This option can be used to disable building and running unit tests which depend on gtest 38# in cases where it is not possible to build or find a valid version of gtest. 39option(BENCHMARK_ENABLE_GTEST_TESTS "Enable building the unit tests which depend on gtest" ON) 40option(BENCHMARK_USE_BUNDLED_GTEST "Use bundled GoogleTest. If disabled, the find_package(GTest) will be used." ON) 41 42option(BENCHMARK_ENABLE_LIBPFM "Enable performance counters provided by libpfm" OFF) 43 44# Export only public symbols 45set(CMAKE_CXX_VISIBILITY_PRESET hidden) 46set(CMAKE_VISIBILITY_INLINES_HIDDEN ON) 47 48if(MSVC) 49 # As of CMake 3.18, CMAKE_SYSTEM_PROCESSOR is not set properly for MSVC and 50 # cross-compilation (e.g. Host=x86_64, target=aarch64) requires using the 51 # undocumented, but working variable. 52 # See https://gitlab.kitware.com/cmake/cmake/-/issues/15170 53 set(CMAKE_SYSTEM_PROCESSOR ${MSVC_CXX_ARCHITECTURE_ID}) 54 if(${CMAKE_SYSTEM_PROCESSOR} MATCHES "ARM") 55 set(CMAKE_CROSSCOMPILING TRUE) 56 endif() 57endif() 58 59set(ENABLE_ASSEMBLY_TESTS_DEFAULT OFF) 60function(should_enable_assembly_tests) 61 if(CMAKE_BUILD_TYPE) 62 string(TOLOWER ${CMAKE_BUILD_TYPE} CMAKE_BUILD_TYPE_LOWER) 63 if (${CMAKE_BUILD_TYPE_LOWER} MATCHES "coverage") 64 # FIXME: The --coverage flag needs to be removed when building assembly 65 # tests for this to work. 66 return() 67 endif() 68 endif() 69 if (MSVC) 70 return() 71 elseif(NOT CMAKE_SYSTEM_PROCESSOR MATCHES "x86_64") 72 return() 73 elseif(NOT CMAKE_SIZEOF_VOID_P EQUAL 8) 74 # FIXME: Make these work on 32 bit builds 75 return() 76 elseif(BENCHMARK_BUILD_32_BITS) 77 # FIXME: Make these work on 32 bit builds 78 return() 79 endif() 80 find_program(LLVM_FILECHECK_EXE FileCheck) 81 if (LLVM_FILECHECK_EXE) 82 set(LLVM_FILECHECK_EXE "${LLVM_FILECHECK_EXE}" CACHE PATH "llvm filecheck" FORCE) 83 message(STATUS "LLVM FileCheck Found: ${LLVM_FILECHECK_EXE}") 84 else() 85 message(STATUS "Failed to find LLVM FileCheck") 86 return() 87 endif() 88 set(ENABLE_ASSEMBLY_TESTS_DEFAULT ON PARENT_SCOPE) 89endfunction() 90should_enable_assembly_tests() 91 92# This option disables the building and running of the assembly verification tests 93option(BENCHMARK_ENABLE_ASSEMBLY_TESTS "Enable building and running the assembly tests" 94 ${ENABLE_ASSEMBLY_TESTS_DEFAULT}) 95 96# Make sure we can import out CMake functions 97list(APPEND CMAKE_MODULE_PATH "${CMAKE_CURRENT_SOURCE_DIR}/cmake/Modules") 98list(APPEND CMAKE_MODULE_PATH "${CMAKE_CURRENT_SOURCE_DIR}/cmake") 99 100 101# Read the git tags to determine the project version 102include(GetGitVersion) 103get_git_version(GIT_VERSION) 104 105# If no git version can be determined, use the version 106# from the project() command 107if ("${GIT_VERSION}" STREQUAL "0.0.0") 108 set(VERSION "${benchmark_VERSION}") 109else() 110 set(VERSION "${GIT_VERSION}") 111endif() 112# Tell the user what versions we are using 113message(STATUS "Google Benchmark version: ${VERSION}") 114 115# The version of the libraries 116set(GENERIC_LIB_VERSION ${VERSION}) 117string(SUBSTRING ${VERSION} 0 1 GENERIC_LIB_SOVERSION) 118 119# Import our CMake modules 120include(AddCXXCompilerFlag) 121include(CheckCXXCompilerFlag) 122include(CheckLibraryExists) 123include(CXXFeatureCheck) 124 125check_library_exists(rt shm_open "" HAVE_LIB_RT) 126 127if (BENCHMARK_BUILD_32_BITS) 128 add_required_cxx_compiler_flag(-m32) 129endif() 130 131if (MSVC) 132 set(BENCHMARK_CXX_STANDARD 14) 133else() 134 set(BENCHMARK_CXX_STANDARD 11) 135endif() 136 137set(CMAKE_CXX_STANDARD ${BENCHMARK_CXX_STANDARD}) 138set(CMAKE_CXX_STANDARD_REQUIRED YES) 139set(CMAKE_CXX_EXTENSIONS OFF) 140 141if (MSVC) 142 # Turn compiler warnings up to 11 143 string(REGEX REPLACE "[-/]W[1-4]" "" CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS}") 144 set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} /W4") 145 add_definitions(-D_CRT_SECURE_NO_WARNINGS) 146 147 if (NOT BENCHMARK_ENABLE_EXCEPTIONS) 148 add_cxx_compiler_flag(-EHs-) 149 add_cxx_compiler_flag(-EHa-) 150 add_definitions(-D_HAS_EXCEPTIONS=0) 151 endif() 152 # Link time optimisation 153 if (BENCHMARK_ENABLE_LTO) 154 set(CMAKE_CXX_FLAGS_RELEASE "${CMAKE_CXX_FLAGS_RELEASE} /GL") 155 set(CMAKE_STATIC_LINKER_FLAGS_RELEASE "${CMAKE_STATIC_LINKER_FLAGS_RELEASE} /LTCG") 156 set(CMAKE_SHARED_LINKER_FLAGS_RELEASE "${CMAKE_SHARED_LINKER_FLAGS_RELEASE} /LTCG") 157 set(CMAKE_EXE_LINKER_FLAGS_RELEASE "${CMAKE_EXE_LINKER_FLAGS_RELEASE} /LTCG") 158 159 set(CMAKE_CXX_FLAGS_RELWITHDEBINFO "${CMAKE_CXX_FLAGS_RELWITHDEBINFO} /GL") 160 string(REGEX REPLACE "[-/]INCREMENTAL" "/INCREMENTAL:NO" CMAKE_STATIC_LINKER_FLAGS_RELWITHDEBINFO "${CMAKE_STATIC_LINKER_FLAGS_RELWITHDEBINFO}") 161 set(CMAKE_STATIC_LINKER_FLAGS_RELWITHDEBINFO "${CMAKE_STATIC_LINKER_FLAGS_RELWITHDEBINFO} /LTCG") 162 string(REGEX REPLACE "[-/]INCREMENTAL" "/INCREMENTAL:NO" CMAKE_SHARED_LINKER_FLAGS_RELWITHDEBINFO "${CMAKE_SHARED_LINKER_FLAGS_RELWITHDEBINFO}") 163 set(CMAKE_SHARED_LINKER_FLAGS_RELWITHDEBINFO "${CMAKE_SHARED_LINKER_FLAGS_RELWITHDEBINFO} /LTCG") 164 string(REGEX REPLACE "[-/]INCREMENTAL" "/INCREMENTAL:NO" CMAKE_EXE_LINKER_FLAGS_RELWITHDEBINFO "${CMAKE_EXE_LINKER_FLAGS_RELWITHDEBINFO}") 165 set(CMAKE_EXE_LINKER_FLAGS_RELWITHDEBINFO "${CMAKE_EXE_LINKER_FLAGS_RELWITHDEBINFO} /LTCG") 166 167 set(CMAKE_CXX_FLAGS_MINSIZEREL "${CMAKE_CXX_FLAGS_MINSIZEREL} /GL") 168 set(CMAKE_STATIC_LINKER_FLAGS_MINSIZEREL "${CMAKE_STATIC_LINKER_FLAGS_MINSIZEREL} /LTCG") 169 set(CMAKE_SHARED_LINKER_FLAGS_MINSIZEREL "${CMAKE_SHARED_LINKER_FLAGS_MINSIZEREL} /LTCG") 170 set(CMAKE_EXE_LINKER_FLAGS_MINSIZEREL "${CMAKE_EXE_LINKER_FLAGS_MINSIZEREL} /LTCG") 171 endif() 172else() 173 # Turn compiler warnings up to 11 174 add_cxx_compiler_flag(-Wall) 175 add_cxx_compiler_flag(-Wextra) 176 add_cxx_compiler_flag(-Wshadow) 177 add_cxx_compiler_flag(-Wfloat-equal) 178 add_cxx_compiler_flag(-Wold-style-cast) 179 if(BENCHMARK_ENABLE_WERROR) 180 add_cxx_compiler_flag(-Werror) 181 endif() 182 if (NOT BENCHMARK_ENABLE_TESTING) 183 # Disable warning when compiling tests as gtest does not use 'override'. 184 add_cxx_compiler_flag(-Wsuggest-override) 185 endif() 186 add_cxx_compiler_flag(-pedantic) 187 add_cxx_compiler_flag(-pedantic-errors) 188 add_cxx_compiler_flag(-Wshorten-64-to-32) 189 add_cxx_compiler_flag(-fstrict-aliasing) 190 # Disable warnings regarding deprecated parts of the library while building 191 # and testing those parts of the library. 192 add_cxx_compiler_flag(-Wno-deprecated-declarations) 193 if (CMAKE_CXX_COMPILER_ID STREQUAL "Intel" OR CMAKE_CXX_COMPILER_ID STREQUAL "IntelLLVM") 194 # Intel silently ignores '-Wno-deprecated-declarations', 195 # warning no. 1786 must be explicitly disabled. 196 # See #631 for rationale. 197 add_cxx_compiler_flag(-wd1786) 198 add_cxx_compiler_flag(-fno-finite-math-only) 199 endif() 200 # Disable deprecation warnings for release builds (when -Werror is enabled). 201 if(BENCHMARK_ENABLE_WERROR) 202 add_cxx_compiler_flag(-Wno-deprecated) 203 endif() 204 if (NOT BENCHMARK_ENABLE_EXCEPTIONS) 205 add_cxx_compiler_flag(-fno-exceptions) 206 endif() 207 208 if (HAVE_CXX_FLAG_FSTRICT_ALIASING) 209 if (NOT CMAKE_CXX_COMPILER_ID STREQUAL "Intel" AND NOT CMAKE_CXX_COMPILER_ID STREQUAL "IntelLLVM") #ICC17u2: Many false positives for Wstrict-aliasing 210 add_cxx_compiler_flag(-Wstrict-aliasing) 211 endif() 212 endif() 213 # ICC17u2: overloaded virtual function "benchmark::Fixture::SetUp" is only partially overridden 214 # (because of deprecated overload) 215 add_cxx_compiler_flag(-wd654) 216 add_cxx_compiler_flag(-Wthread-safety) 217 if (HAVE_CXX_FLAG_WTHREAD_SAFETY) 218 cxx_feature_check(THREAD_SAFETY_ATTRIBUTES "-DINCLUDE_DIRECTORIES=${PROJECT_SOURCE_DIR}/include") 219 endif() 220 221 # On most UNIX like platforms g++ and clang++ define _GNU_SOURCE as a 222 # predefined macro, which turns on all of the wonderful libc extensions. 223 # However g++ doesn't do this in Cygwin so we have to define it ourselves 224 # since we depend on GNU/POSIX/BSD extensions. 225 if (CYGWIN) 226 add_definitions(-D_GNU_SOURCE=1) 227 endif() 228 229 if (QNXNTO) 230 add_definitions(-D_QNX_SOURCE) 231 endif() 232 233 # Link time optimisation 234 if (BENCHMARK_ENABLE_LTO) 235 add_cxx_compiler_flag(-flto) 236 add_cxx_compiler_flag(-Wno-lto-type-mismatch) 237 if ("${CMAKE_CXX_COMPILER_ID}" STREQUAL "GNU") 238 find_program(GCC_AR gcc-ar) 239 if (GCC_AR) 240 set(CMAKE_AR ${GCC_AR}) 241 endif() 242 find_program(GCC_RANLIB gcc-ranlib) 243 if (GCC_RANLIB) 244 set(CMAKE_RANLIB ${GCC_RANLIB}) 245 endif() 246 elseif("${CMAKE_CXX_COMPILER_ID}" MATCHES "Clang") 247 include(llvm-toolchain) 248 endif() 249 endif() 250 251 # Coverage build type 252 set(BENCHMARK_CXX_FLAGS_COVERAGE "${CMAKE_CXX_FLAGS_DEBUG}" 253 CACHE STRING "Flags used by the C++ compiler during coverage builds." 254 FORCE) 255 set(BENCHMARK_EXE_LINKER_FLAGS_COVERAGE "${CMAKE_EXE_LINKER_FLAGS_DEBUG}" 256 CACHE STRING "Flags used for linking binaries during coverage builds." 257 FORCE) 258 set(BENCHMARK_SHARED_LINKER_FLAGS_COVERAGE "${CMAKE_SHARED_LINKER_FLAGS_DEBUG}" 259 CACHE STRING "Flags used by the shared libraries linker during coverage builds." 260 FORCE) 261 mark_as_advanced( 262 BENCHMARK_CXX_FLAGS_COVERAGE 263 BENCHMARK_EXE_LINKER_FLAGS_COVERAGE 264 BENCHMARK_SHARED_LINKER_FLAGS_COVERAGE) 265 set(CMAKE_BUILD_TYPE "${CMAKE_BUILD_TYPE}" CACHE STRING 266 "Choose the type of build, options are: None Debug Release RelWithDebInfo MinSizeRel Coverage.") 267 add_cxx_compiler_flag(--coverage COVERAGE) 268endif() 269 270if (BENCHMARK_USE_LIBCXX) 271 if ("${CMAKE_CXX_COMPILER_ID}" MATCHES "Clang") 272 add_cxx_compiler_flag(-stdlib=libc++) 273 elseif ("${CMAKE_CXX_COMPILER_ID}" STREQUAL "GNU" OR 274 "${CMAKE_CXX_COMPILER_ID}" STREQUAL "Intel" OR 275 "${CMAKE_CXX_COMPILER_ID}" STREQUAL "IntelLLVM") 276 add_cxx_compiler_flag(-nostdinc++) 277 message(WARNING "libc++ header path must be manually specified using CMAKE_CXX_FLAGS") 278 # Adding -nodefaultlibs directly to CMAKE_<TYPE>_LINKER_FLAGS will break 279 # configuration checks such as 'find_package(Threads)' 280 list(APPEND BENCHMARK_CXX_LINKER_FLAGS -nodefaultlibs) 281 # -lc++ cannot be added directly to CMAKE_<TYPE>_LINKER_FLAGS because 282 # linker flags appear before all linker inputs and -lc++ must appear after. 283 list(APPEND BENCHMARK_CXX_LIBRARIES c++) 284 else() 285 message(FATAL_ERROR "-DBENCHMARK_USE_LIBCXX:BOOL=ON is not supported for compiler") 286 endif() 287endif(BENCHMARK_USE_LIBCXX) 288 289set(EXTRA_CXX_FLAGS "") 290if (WIN32 AND "${CMAKE_CXX_COMPILER_ID}" MATCHES "Clang") 291 # Clang on Windows fails to compile the regex feature check under C++11 292 set(EXTRA_CXX_FLAGS "-DCMAKE_CXX_STANDARD=14") 293endif() 294 295# C++ feature checks 296# Determine the correct regular expression engine to use 297cxx_feature_check(STD_REGEX ${EXTRA_CXX_FLAGS}) 298cxx_feature_check(GNU_POSIX_REGEX ${EXTRA_CXX_FLAGS}) 299cxx_feature_check(POSIX_REGEX ${EXTRA_CXX_FLAGS}) 300if(NOT HAVE_STD_REGEX AND NOT HAVE_GNU_POSIX_REGEX AND NOT HAVE_POSIX_REGEX) 301 message(FATAL_ERROR "Failed to determine the source files for the regular expression backend") 302endif() 303if (NOT BENCHMARK_ENABLE_EXCEPTIONS AND HAVE_STD_REGEX 304 AND NOT HAVE_GNU_POSIX_REGEX AND NOT HAVE_POSIX_REGEX) 305 message(WARNING "Using std::regex with exceptions disabled is not fully supported") 306endif() 307 308cxx_feature_check(STEADY_CLOCK) 309# Ensure we have pthreads 310set(THREADS_PREFER_PTHREAD_FLAG ON) 311find_package(Threads REQUIRED) 312cxx_feature_check(PTHREAD_AFFINITY) 313 314if (BENCHMARK_ENABLE_LIBPFM) 315 find_package(PFM) 316endif() 317 318# Set up directories 319include_directories(${PROJECT_SOURCE_DIR}/include) 320 321# Build the targets 322add_subdirectory(src) 323 324if (BENCHMARK_ENABLE_TESTING) 325 enable_testing() 326 if (BENCHMARK_ENABLE_GTEST_TESTS AND 327 NOT (TARGET gtest AND TARGET gtest_main AND 328 TARGET gmock AND TARGET gmock_main)) 329 if (BENCHMARK_USE_BUNDLED_GTEST) 330 include(GoogleTest) 331 else() 332 find_package(GTest CONFIG REQUIRED) 333 add_library(gtest ALIAS GTest::gtest) 334 add_library(gtest_main ALIAS GTest::gtest_main) 335 add_library(gmock ALIAS GTest::gmock) 336 add_library(gmock_main ALIAS GTest::gmock_main) 337 endif() 338 endif() 339 add_subdirectory(test) 340endif() 341