mirror of https://github.com/google/benchmark.git
355 lines
14 KiB
CMake
355 lines
14 KiB
CMake
# Require CMake 3.10. If available, use the policies up to CMake 3.22.
|
|
cmake_minimum_required (VERSION 3.10...3.22)
|
|
|
|
project (benchmark VERSION 1.8.3 LANGUAGES CXX)
|
|
|
|
option(BENCHMARK_ENABLE_TESTING "Enable testing of the benchmark library." ON)
|
|
option(BENCHMARK_ENABLE_EXCEPTIONS "Enable the use of exceptions in the benchmark library." ON)
|
|
option(BENCHMARK_ENABLE_LTO "Enable link time optimisation of the benchmark library." OFF)
|
|
option(BENCHMARK_USE_LIBCXX "Build and test using libc++ as the standard library." OFF)
|
|
option(BENCHMARK_ENABLE_WERROR "Build Release candidates with -Werror." ON)
|
|
option(BENCHMARK_FORCE_WERROR "Build Release candidates with -Werror regardless of compiler issues." OFF)
|
|
|
|
if("${CMAKE_CXX_COMPILER_ID}" STREQUAL "PGI")
|
|
# PGC++ maybe reporting false positives.
|
|
set(BENCHMARK_ENABLE_WERROR OFF)
|
|
endif()
|
|
if("${CMAKE_CXX_COMPILER_ID}" STREQUAL "NVHPC")
|
|
set(BENCHMARK_ENABLE_WERROR OFF)
|
|
endif()
|
|
if(BENCHMARK_FORCE_WERROR)
|
|
set(BENCHMARK_ENABLE_WERROR ON)
|
|
endif(BENCHMARK_FORCE_WERROR)
|
|
|
|
if(NOT (MSVC OR CMAKE_CXX_SIMULATE_ID STREQUAL "MSVC"))
|
|
option(BENCHMARK_BUILD_32_BITS "Build a 32 bit version of the library." OFF)
|
|
else()
|
|
set(BENCHMARK_BUILD_32_BITS OFF CACHE BOOL "Build a 32 bit version of the library - unsupported when using MSVC)" FORCE)
|
|
endif()
|
|
option(BENCHMARK_ENABLE_INSTALL "Enable installation of benchmark. (Projects embedding benchmark may want to turn this OFF.)" ON)
|
|
option(BENCHMARK_ENABLE_DOXYGEN "Build documentation with Doxygen." OFF)
|
|
option(BENCHMARK_INSTALL_DOCS "Enable installation of documentation." ON)
|
|
|
|
# Allow unmet dependencies to be met using CMake's ExternalProject mechanics, which
|
|
# may require downloading the source code.
|
|
option(BENCHMARK_DOWNLOAD_DEPENDENCIES "Allow the downloading and in-tree building of unmet dependencies" OFF)
|
|
|
|
# This option can be used to disable building and running unit tests which depend on gtest
|
|
# in cases where it is not possible to build or find a valid version of gtest.
|
|
option(BENCHMARK_ENABLE_GTEST_TESTS "Enable building the unit tests which depend on gtest" ON)
|
|
option(BENCHMARK_USE_BUNDLED_GTEST "Use bundled GoogleTest. If disabled, the find_package(GTest) will be used." ON)
|
|
|
|
option(BENCHMARK_ENABLE_LIBPFM "Enable performance counters provided by libpfm" OFF)
|
|
|
|
# Export only public symbols
|
|
set(CMAKE_CXX_VISIBILITY_PRESET hidden)
|
|
set(CMAKE_VISIBILITY_INLINES_HIDDEN ON)
|
|
|
|
if(CMAKE_CXX_COMPILER_ID STREQUAL "MSVC")
|
|
# As of CMake 3.18, CMAKE_SYSTEM_PROCESSOR is not set properly for MSVC and
|
|
# cross-compilation (e.g. Host=x86_64, target=aarch64) requires using the
|
|
# undocumented, but working variable.
|
|
# See https://gitlab.kitware.com/cmake/cmake/-/issues/15170
|
|
set(CMAKE_SYSTEM_PROCESSOR ${MSVC_CXX_ARCHITECTURE_ID})
|
|
if(${CMAKE_SYSTEM_PROCESSOR} MATCHES "ARM")
|
|
set(CMAKE_CROSSCOMPILING TRUE)
|
|
endif()
|
|
endif()
|
|
|
|
set(ENABLE_ASSEMBLY_TESTS_DEFAULT OFF)
|
|
function(should_enable_assembly_tests)
|
|
if(CMAKE_BUILD_TYPE)
|
|
string(TOLOWER ${CMAKE_BUILD_TYPE} CMAKE_BUILD_TYPE_LOWER)
|
|
if (${CMAKE_BUILD_TYPE_LOWER} MATCHES "coverage")
|
|
# FIXME: The --coverage flag needs to be removed when building assembly
|
|
# tests for this to work.
|
|
return()
|
|
endif()
|
|
endif()
|
|
if (MSVC OR CMAKE_CXX_SIMULATE_ID STREQUAL "MSVC")
|
|
return()
|
|
elseif(NOT CMAKE_SYSTEM_PROCESSOR MATCHES "x86_64")
|
|
return()
|
|
elseif(NOT CMAKE_SIZEOF_VOID_P EQUAL 8)
|
|
# FIXME: Make these work on 32 bit builds
|
|
return()
|
|
elseif(BENCHMARK_BUILD_32_BITS)
|
|
# FIXME: Make these work on 32 bit builds
|
|
return()
|
|
endif()
|
|
find_program(LLVM_FILECHECK_EXE FileCheck)
|
|
if (LLVM_FILECHECK_EXE)
|
|
set(LLVM_FILECHECK_EXE "${LLVM_FILECHECK_EXE}" CACHE PATH "llvm filecheck" FORCE)
|
|
message(STATUS "LLVM FileCheck Found: ${LLVM_FILECHECK_EXE}")
|
|
else()
|
|
message(STATUS "Failed to find LLVM FileCheck")
|
|
return()
|
|
endif()
|
|
set(ENABLE_ASSEMBLY_TESTS_DEFAULT ON PARENT_SCOPE)
|
|
endfunction()
|
|
should_enable_assembly_tests()
|
|
|
|
# This option disables the building and running of the assembly verification tests
|
|
option(BENCHMARK_ENABLE_ASSEMBLY_TESTS "Enable building and running the assembly tests"
|
|
${ENABLE_ASSEMBLY_TESTS_DEFAULT})
|
|
|
|
# Make sure we can import out CMake functions
|
|
list(APPEND CMAKE_MODULE_PATH "${CMAKE_CURRENT_SOURCE_DIR}/cmake/Modules")
|
|
list(APPEND CMAKE_MODULE_PATH "${CMAKE_CURRENT_SOURCE_DIR}/cmake")
|
|
|
|
|
|
# Read the git tags to determine the project version
|
|
include(GetGitVersion)
|
|
get_git_version(GIT_VERSION)
|
|
|
|
# If no git version can be determined, use the version
|
|
# from the project() command
|
|
if ("${GIT_VERSION}" STREQUAL "0.0.0")
|
|
set(VERSION "v${benchmark_VERSION}")
|
|
else()
|
|
set(VERSION "${GIT_VERSION}")
|
|
endif()
|
|
|
|
# Normalize version: drop "v" prefix, replace first "-" with ".",
|
|
# drop everything after second "-" (including said "-").
|
|
string(STRIP ${VERSION} VERSION)
|
|
if(VERSION MATCHES v[^-]*-)
|
|
string(REGEX REPLACE "v([^-]*)-([0-9]+)-.*" "\\1.\\2" NORMALIZED_VERSION ${VERSION})
|
|
else()
|
|
string(REGEX REPLACE "v(.*)" "\\1" NORMALIZED_VERSION ${VERSION})
|
|
endif()
|
|
|
|
# Tell the user what versions we are using
|
|
message(STATUS "Google Benchmark version: ${VERSION}, normalized to ${NORMALIZED_VERSION}")
|
|
|
|
# The version of the libraries
|
|
set(GENERIC_LIB_VERSION ${NORMALIZED_VERSION})
|
|
string(SUBSTRING ${NORMALIZED_VERSION} 0 1 GENERIC_LIB_SOVERSION)
|
|
|
|
# Import our CMake modules
|
|
include(AddCXXCompilerFlag)
|
|
include(CheckCXXCompilerFlag)
|
|
include(CheckLibraryExists)
|
|
include(CXXFeatureCheck)
|
|
|
|
check_library_exists(rt shm_open "" HAVE_LIB_RT)
|
|
|
|
if (BENCHMARK_BUILD_32_BITS)
|
|
add_required_cxx_compiler_flag(-m32)
|
|
endif()
|
|
|
|
if (MSVC OR CMAKE_CXX_SIMULATE_ID STREQUAL "MSVC")
|
|
set(BENCHMARK_CXX_STANDARD 14)
|
|
else()
|
|
set(BENCHMARK_CXX_STANDARD 11)
|
|
endif()
|
|
|
|
set(CMAKE_CXX_STANDARD ${BENCHMARK_CXX_STANDARD})
|
|
set(CMAKE_CXX_STANDARD_REQUIRED YES)
|
|
set(CMAKE_CXX_EXTENSIONS OFF)
|
|
|
|
if (MSVC)
|
|
# Turn compiler warnings up to 11
|
|
string(REGEX REPLACE "[-/]W[1-4]" "" CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS}")
|
|
set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} /W4")
|
|
add_definitions(-D_CRT_SECURE_NO_WARNINGS)
|
|
|
|
if (NOT BENCHMARK_ENABLE_EXCEPTIONS)
|
|
add_cxx_compiler_flag(-EHs-)
|
|
add_cxx_compiler_flag(-EHa-)
|
|
add_definitions(-D_HAS_EXCEPTIONS=0)
|
|
endif()
|
|
# Link time optimisation
|
|
if (BENCHMARK_ENABLE_LTO)
|
|
set(CMAKE_CXX_FLAGS_RELEASE "${CMAKE_CXX_FLAGS_RELEASE} /GL")
|
|
set(CMAKE_STATIC_LINKER_FLAGS_RELEASE "${CMAKE_STATIC_LINKER_FLAGS_RELEASE} /LTCG")
|
|
set(CMAKE_SHARED_LINKER_FLAGS_RELEASE "${CMAKE_SHARED_LINKER_FLAGS_RELEASE} /LTCG")
|
|
set(CMAKE_EXE_LINKER_FLAGS_RELEASE "${CMAKE_EXE_LINKER_FLAGS_RELEASE} /LTCG")
|
|
|
|
set(CMAKE_CXX_FLAGS_RELWITHDEBINFO "${CMAKE_CXX_FLAGS_RELWITHDEBINFO} /GL")
|
|
string(REGEX REPLACE "[-/]INCREMENTAL" "/INCREMENTAL:NO" CMAKE_STATIC_LINKER_FLAGS_RELWITHDEBINFO "${CMAKE_STATIC_LINKER_FLAGS_RELWITHDEBINFO}")
|
|
set(CMAKE_STATIC_LINKER_FLAGS_RELWITHDEBINFO "${CMAKE_STATIC_LINKER_FLAGS_RELWITHDEBINFO} /LTCG")
|
|
string(REGEX REPLACE "[-/]INCREMENTAL" "/INCREMENTAL:NO" CMAKE_SHARED_LINKER_FLAGS_RELWITHDEBINFO "${CMAKE_SHARED_LINKER_FLAGS_RELWITHDEBINFO}")
|
|
set(CMAKE_SHARED_LINKER_FLAGS_RELWITHDEBINFO "${CMAKE_SHARED_LINKER_FLAGS_RELWITHDEBINFO} /LTCG")
|
|
string(REGEX REPLACE "[-/]INCREMENTAL" "/INCREMENTAL:NO" CMAKE_EXE_LINKER_FLAGS_RELWITHDEBINFO "${CMAKE_EXE_LINKER_FLAGS_RELWITHDEBINFO}")
|
|
set(CMAKE_EXE_LINKER_FLAGS_RELWITHDEBINFO "${CMAKE_EXE_LINKER_FLAGS_RELWITHDEBINFO} /LTCG")
|
|
|
|
set(CMAKE_CXX_FLAGS_MINSIZEREL "${CMAKE_CXX_FLAGS_MINSIZEREL} /GL")
|
|
set(CMAKE_STATIC_LINKER_FLAGS_MINSIZEREL "${CMAKE_STATIC_LINKER_FLAGS_MINSIZEREL} /LTCG")
|
|
set(CMAKE_SHARED_LINKER_FLAGS_MINSIZEREL "${CMAKE_SHARED_LINKER_FLAGS_MINSIZEREL} /LTCG")
|
|
set(CMAKE_EXE_LINKER_FLAGS_MINSIZEREL "${CMAKE_EXE_LINKER_FLAGS_MINSIZEREL} /LTCG")
|
|
endif()
|
|
else()
|
|
# Turn on Large-file Support
|
|
add_definitions(-D_FILE_OFFSET_BITS=64)
|
|
add_definitions(-D_LARGEFILE64_SOURCE)
|
|
add_definitions(-D_LARGEFILE_SOURCE)
|
|
# Turn compiler warnings up to 11
|
|
add_cxx_compiler_flag(-Wall)
|
|
add_cxx_compiler_flag(-Wextra)
|
|
add_cxx_compiler_flag(-Wshadow)
|
|
add_cxx_compiler_flag(-Wfloat-equal)
|
|
add_cxx_compiler_flag(-Wold-style-cast)
|
|
if(BENCHMARK_ENABLE_WERROR)
|
|
add_cxx_compiler_flag(-Werror)
|
|
endif()
|
|
if (NOT BENCHMARK_ENABLE_TESTING)
|
|
# Disable warning when compiling tests as gtest does not use 'override'.
|
|
add_cxx_compiler_flag(-Wsuggest-override)
|
|
endif()
|
|
add_cxx_compiler_flag(-pedantic)
|
|
add_cxx_compiler_flag(-pedantic-errors)
|
|
add_cxx_compiler_flag(-Wshorten-64-to-32)
|
|
add_cxx_compiler_flag(-fstrict-aliasing)
|
|
# Disable warnings regarding deprecated parts of the library while building
|
|
# and testing those parts of the library.
|
|
add_cxx_compiler_flag(-Wno-deprecated-declarations)
|
|
if (CMAKE_CXX_COMPILER_ID STREQUAL "Intel" OR CMAKE_CXX_COMPILER_ID STREQUAL "IntelLLVM")
|
|
# Intel silently ignores '-Wno-deprecated-declarations',
|
|
# warning no. 1786 must be explicitly disabled.
|
|
# See #631 for rationale.
|
|
add_cxx_compiler_flag(-wd1786)
|
|
add_cxx_compiler_flag(-fno-finite-math-only)
|
|
endif()
|
|
# Disable deprecation warnings for release builds (when -Werror is enabled).
|
|
if(BENCHMARK_ENABLE_WERROR)
|
|
add_cxx_compiler_flag(-Wno-deprecated)
|
|
endif()
|
|
if (NOT BENCHMARK_ENABLE_EXCEPTIONS)
|
|
add_cxx_compiler_flag(-fno-exceptions)
|
|
endif()
|
|
|
|
if (HAVE_CXX_FLAG_FSTRICT_ALIASING)
|
|
if (NOT CMAKE_CXX_COMPILER_ID STREQUAL "Intel" AND NOT CMAKE_CXX_COMPILER_ID STREQUAL "IntelLLVM") #ICC17u2: Many false positives for Wstrict-aliasing
|
|
add_cxx_compiler_flag(-Wstrict-aliasing)
|
|
endif()
|
|
endif()
|
|
# ICC17u2: overloaded virtual function "benchmark::Fixture::SetUp" is only partially overridden
|
|
# (because of deprecated overload)
|
|
add_cxx_compiler_flag(-wd654)
|
|
add_cxx_compiler_flag(-Wthread-safety)
|
|
if (HAVE_CXX_FLAG_WTHREAD_SAFETY)
|
|
cxx_feature_check(THREAD_SAFETY_ATTRIBUTES "-DINCLUDE_DIRECTORIES=${PROJECT_SOURCE_DIR}/include")
|
|
endif()
|
|
|
|
# On most UNIX like platforms g++ and clang++ define _GNU_SOURCE as a
|
|
# predefined macro, which turns on all of the wonderful libc extensions.
|
|
# However g++ doesn't do this in Cygwin so we have to define it ourselves
|
|
# since we depend on GNU/POSIX/BSD extensions.
|
|
if (CYGWIN)
|
|
add_definitions(-D_GNU_SOURCE=1)
|
|
endif()
|
|
|
|
if (QNXNTO)
|
|
add_definitions(-D_QNX_SOURCE)
|
|
endif()
|
|
|
|
# Link time optimisation
|
|
if (BENCHMARK_ENABLE_LTO)
|
|
add_cxx_compiler_flag(-flto)
|
|
add_cxx_compiler_flag(-Wno-lto-type-mismatch)
|
|
if ("${CMAKE_CXX_COMPILER_ID}" STREQUAL "GNU")
|
|
find_program(GCC_AR gcc-ar)
|
|
if (GCC_AR)
|
|
set(CMAKE_AR ${GCC_AR})
|
|
endif()
|
|
find_program(GCC_RANLIB gcc-ranlib)
|
|
if (GCC_RANLIB)
|
|
set(CMAKE_RANLIB ${GCC_RANLIB})
|
|
endif()
|
|
elseif("${CMAKE_CXX_COMPILER_ID}" MATCHES "Clang")
|
|
include(llvm-toolchain)
|
|
endif()
|
|
endif()
|
|
|
|
# Coverage build type
|
|
set(BENCHMARK_CXX_FLAGS_COVERAGE "${CMAKE_CXX_FLAGS_DEBUG}"
|
|
CACHE STRING "Flags used by the C++ compiler during coverage builds."
|
|
FORCE)
|
|
set(BENCHMARK_EXE_LINKER_FLAGS_COVERAGE "${CMAKE_EXE_LINKER_FLAGS_DEBUG}"
|
|
CACHE STRING "Flags used for linking binaries during coverage builds."
|
|
FORCE)
|
|
set(BENCHMARK_SHARED_LINKER_FLAGS_COVERAGE "${CMAKE_SHARED_LINKER_FLAGS_DEBUG}"
|
|
CACHE STRING "Flags used by the shared libraries linker during coverage builds."
|
|
FORCE)
|
|
mark_as_advanced(
|
|
BENCHMARK_CXX_FLAGS_COVERAGE
|
|
BENCHMARK_EXE_LINKER_FLAGS_COVERAGE
|
|
BENCHMARK_SHARED_LINKER_FLAGS_COVERAGE)
|
|
set(CMAKE_BUILD_TYPE "${CMAKE_BUILD_TYPE}" CACHE STRING
|
|
"Choose the type of build, options are: None Debug Release RelWithDebInfo MinSizeRel Coverage.")
|
|
add_cxx_compiler_flag(--coverage COVERAGE)
|
|
endif()
|
|
|
|
if (BENCHMARK_USE_LIBCXX)
|
|
if ("${CMAKE_CXX_COMPILER_ID}" MATCHES "Clang")
|
|
add_cxx_compiler_flag(-stdlib=libc++)
|
|
elseif ("${CMAKE_CXX_COMPILER_ID}" STREQUAL "GNU" OR
|
|
"${CMAKE_CXX_COMPILER_ID}" STREQUAL "Intel" OR
|
|
"${CMAKE_CXX_COMPILER_ID}" STREQUAL "IntelLLVM")
|
|
add_cxx_compiler_flag(-nostdinc++)
|
|
message(WARNING "libc++ header path must be manually specified using CMAKE_CXX_FLAGS")
|
|
# Adding -nodefaultlibs directly to CMAKE_<TYPE>_LINKER_FLAGS will break
|
|
# configuration checks such as 'find_package(Threads)'
|
|
list(APPEND BENCHMARK_CXX_LINKER_FLAGS -nodefaultlibs)
|
|
# -lc++ cannot be added directly to CMAKE_<TYPE>_LINKER_FLAGS because
|
|
# linker flags appear before all linker inputs and -lc++ must appear after.
|
|
list(APPEND BENCHMARK_CXX_LIBRARIES c++)
|
|
else()
|
|
message(FATAL_ERROR "-DBENCHMARK_USE_LIBCXX:BOOL=ON is not supported for compiler")
|
|
endif()
|
|
endif(BENCHMARK_USE_LIBCXX)
|
|
|
|
set(EXTRA_CXX_FLAGS "")
|
|
if (WIN32 AND "${CMAKE_CXX_COMPILER_ID}" MATCHES "Clang")
|
|
# Clang on Windows fails to compile the regex feature check under C++11
|
|
set(EXTRA_CXX_FLAGS "-DCMAKE_CXX_STANDARD=14")
|
|
endif()
|
|
|
|
# C++ feature checks
|
|
# Determine the correct regular expression engine to use
|
|
cxx_feature_check(STD_REGEX ${EXTRA_CXX_FLAGS})
|
|
cxx_feature_check(GNU_POSIX_REGEX ${EXTRA_CXX_FLAGS})
|
|
cxx_feature_check(POSIX_REGEX ${EXTRA_CXX_FLAGS})
|
|
if(NOT HAVE_STD_REGEX AND NOT HAVE_GNU_POSIX_REGEX AND NOT HAVE_POSIX_REGEX)
|
|
message(FATAL_ERROR "Failed to determine the source files for the regular expression backend")
|
|
endif()
|
|
if (NOT BENCHMARK_ENABLE_EXCEPTIONS AND HAVE_STD_REGEX
|
|
AND NOT HAVE_GNU_POSIX_REGEX AND NOT HAVE_POSIX_REGEX)
|
|
message(WARNING "Using std::regex with exceptions disabled is not fully supported")
|
|
endif()
|
|
|
|
cxx_feature_check(STEADY_CLOCK)
|
|
# Ensure we have pthreads
|
|
set(THREADS_PREFER_PTHREAD_FLAG ON)
|
|
find_package(Threads REQUIRED)
|
|
cxx_feature_check(PTHREAD_AFFINITY)
|
|
|
|
if (BENCHMARK_ENABLE_LIBPFM)
|
|
find_package(PFM REQUIRED)
|
|
endif()
|
|
|
|
# Set up directories
|
|
include_directories(${PROJECT_SOURCE_DIR}/include)
|
|
|
|
# Build the targets
|
|
add_subdirectory(src)
|
|
|
|
if (BENCHMARK_ENABLE_TESTING)
|
|
enable_testing()
|
|
if (BENCHMARK_ENABLE_GTEST_TESTS AND
|
|
NOT (TARGET gtest AND TARGET gtest_main AND
|
|
TARGET gmock AND TARGET gmock_main))
|
|
if (BENCHMARK_USE_BUNDLED_GTEST)
|
|
include(GoogleTest)
|
|
else()
|
|
find_package(GTest CONFIG REQUIRED)
|
|
add_library(gtest ALIAS GTest::gtest)
|
|
add_library(gtest_main ALIAS GTest::gtest_main)
|
|
add_library(gmock ALIAS GTest::gmock)
|
|
add_library(gmock_main ALIAS GTest::gmock_main)
|
|
endif()
|
|
endif()
|
|
add_subdirectory(test)
|
|
endif()
|