d9b9ef75a8
Summary: This patch does the following: 1. Checks in a copy of the Google Benchmark library into the libc++ repo under `utils/google-benchmark`. 2. Teaches libc++ how to build Google Benchmark against both (A) in-tree libc++ and (B) the platforms native STL. 3. Allows performance benchmarks to be built as part of the libc++ build. Building the benchmarks (and Google Benchmark) is off by default. It must be enabled using the CMake option `-DLIBCXX_INCLUDE_BENCHMARKS=ON`. When this option is enabled the tests under `libcxx/benchmarks` can be built using the `libcxx-benchmarks` target. On Linux platforms where libstdc++ is the default STL the CMake option `-DLIBCXX_BUILD_BENCHMARKS_NATIVE_STDLIB=ON` can be used to build each benchmark test against libstdc++ as well. This is useful for comparing performance between standard libraries. Support for benchmarks is currently very minimal. They must be manually run by the user and there is no mechanism for detecting performance regressions. Known Issues: * `-DLIBCXX_INCLUDE_BENCHMARKS=ON` is only supported for Clang, and not GCC, since the `-stdlib=libc++` option is needed to build Google Benchmark. Reviewers: danalbert, dberlin, chandlerc, mclow.lists, jroelofs Subscribers: chandlerc, dberlin, tberghammer, danalbert, srhines, hfinkel Differential Revision: https://reviews.llvm.org/D22240 git-svn-id: https://llvm.org/svn/llvm-project/libcxx/trunk@276049 91177308-0d34-0410-b5e6-96231b3b80d8
120 lines
4.7 KiB
CMake
120 lines
4.7 KiB
CMake
include(ExternalProject)
|
|
include(CheckCXXCompilerFlag)
|
|
|
|
#==============================================================================
|
|
# Build Google Benchmark for libc++
|
|
#==============================================================================
|
|
check_cxx_compiler_flag(-stdlib=libc++ LIBCXX_HAS_NO_STDLIB_LIBCXX_FLAG)
|
|
if (NOT LIBCXX_HAS_NO_STDLIB_LIBCXX_FLAG)
|
|
message(FATAL "Benchmark requires support for the -stdlib=libc++ flag")
|
|
endif()
|
|
|
|
set(BENCHMARK_LIBCXX_COMPILE_FLAGS
|
|
-Wno-unused-command-line-argument
|
|
-nostdinc++
|
|
-cxx-isystem ${LIBCXX_SOURCE_DIR}/include
|
|
-stdlib=libc++)
|
|
set(BENCHMARK_LIBCXX_LINK_FLAGS
|
|
-L${LIBCXX_LIBRARY_DIR}
|
|
-Wl,-rpath,${LIBCXX_LIBRARY_DIR})
|
|
split_list(BENCHMARK_LIBCXX_COMPILE_FLAGS)
|
|
split_list(BENCHMARK_LIBCXX_LINK_FLAGS)
|
|
|
|
ExternalProject_Add(google-benchmark-libcxx
|
|
EXCLUDE_FROM_ALL ON
|
|
DEPENDS cxx
|
|
PREFIX benchmark-libcxx
|
|
SOURCE_DIR ${LIBCXX_SOURCE_DIR}/utils/google-benchmark
|
|
INSTALL_DIR ${CMAKE_CURRENT_BINARY_DIR}/benchmark-libcxx
|
|
CMAKE_CACHE_DEFAULT_ARGS
|
|
-DCMAKE_BUILD_TYPE:STRING=RELEASE
|
|
-DCMAKE_INSTALL_PREFIX:PATH=<INSTALL_DIR>
|
|
-DCMAKE_CXX_FLAGS:STRING=${BENCHMARK_LIBCXX_COMPILE_FLAGS}
|
|
-DCMAKE_SHARED_LINK_FLAGS:STRING=${BENCHMARK_LIBCXX_LINK_FLAGS}
|
|
-DCMAKE_EXE_LINK_FLAGS:STRING=${BENCHMARK_LIBCXX_LINK_FLAGS}
|
|
-DBENCHMARK_ENABLE_TESTING:BOOL=OFF)
|
|
|
|
#==============================================================================
|
|
# Build Google Benchmark for the native stdlib
|
|
#==============================================================================
|
|
if (LIBCXX_BUILD_BENCHMARK_NATIVE_STDLIB)
|
|
ExternalProject_Add(google-benchmark-native
|
|
EXCLUDE_FROM_ALL ON
|
|
PREFIX benchmark-native
|
|
SOURCE_DIR ${LIBCXX_SOURCE_DIR}/utils/google-benchmark
|
|
INSTALL_DIR ${CMAKE_CURRENT_BINARY_DIR}/benchmark-native
|
|
CMAKE_CACHE_ARGS
|
|
-DBENCHMARK_ENABLE_TESTING:BOOL=OFF
|
|
CMAKE_CACHE_DEFAULT_ARGS
|
|
-DCMAKE_BUILD_TYPE:STRING=RELEASE
|
|
-DCMAKE_INSTALL_PREFIX:PATH=<INSTALL_DIR>)
|
|
endif()
|
|
|
|
#==============================================================================
|
|
# Benchmark tests configuration
|
|
#==============================================================================
|
|
add_custom_target(libcxx-benchmarks)
|
|
|
|
set(BENCHMARK_LIBCXX_INSTALL ${CMAKE_CURRENT_BINARY_DIR}/benchmark-libcxx)
|
|
set(BENCHMARK_NATIVE_INSTALL ${CMAKE_CURRENT_BINARY_DIR}/benchmark-native)
|
|
set(BENCHMARK_TEST_COMPILE_FLAGS
|
|
-std=c++14 -O2
|
|
-I${BENCHMARK_LIBCXX_INSTALL}/include
|
|
)
|
|
set(BENCHMARK_TEST_LIBCXX_COMPILE_FLAGS
|
|
-nostdinc++
|
|
${BENCHMARK_TEST_COMPILE_FLAGS}
|
|
-Wno-user-defined-literals
|
|
)
|
|
set(BENCHMARK_TEST_LIBCXX_LINK_FLAGS
|
|
-nodefaultlibs
|
|
-L${BENCHMARK_LIBCXX_INSTALL}/lib/
|
|
)
|
|
set(BENCHMARK_TEST_NATIVE_LINK_FLAGS
|
|
-L${BENCHMARK_NATIVE_INSTALL}/lib/
|
|
)
|
|
split_list(BENCHMARK_TEST_COMPILE_FLAGS)
|
|
split_list(BENCHMARK_TEST_LIBCXX_COMPILE_FLAGS)
|
|
split_list(BENCHMARK_TEST_LIBCXX_LINK_FLAGS)
|
|
split_list(BENCHMARK_TEST_NATIVE_LINK_FLAGS)
|
|
macro(add_benchmark_test name source_file)
|
|
set(libcxx_target ${name}_libcxx)
|
|
add_executable(${libcxx_target} EXCLUDE_FROM_ALL ${source_file})
|
|
add_dependencies(${libcxx_target} cxx google-benchmark-libcxx)
|
|
add_dependencies(libcxx-benchmarks ${libcxx_target})
|
|
target_link_libraries(${libcxx_target} cxx -lbenchmark)
|
|
set_target_properties(${libcxx_target}
|
|
PROPERTIES
|
|
OUTPUT_NAME "${name}.libcxx.out"
|
|
COMPILE_FLAGS "${BENCHMARK_TEST_LIBCXX_COMPILE_FLAGS}"
|
|
LINK_FLAGS "${BENCHMARK_TEST_LIBCXX_LINK_FLAGS}")
|
|
if (LIBCXX_BUILD_BENCHMARK_NATIVE_STDLIB)
|
|
set(native_target ${name}_native)
|
|
add_executable(${native_target} EXCLUDE_FROM_ALL ${source_file})
|
|
add_dependencies(${native_target} google-benchmark-native)
|
|
target_link_libraries(${native_target} -lbenchmark)
|
|
if (LIBCXX_HAS_PTHREAD_LIB)
|
|
target_link_libraries(${native_target} -pthread)
|
|
endif()
|
|
add_dependencies(libcxx-benchmarks ${native_target})
|
|
set_target_properties(${native_target}
|
|
PROPERTIES
|
|
OUTPUT_NAME "${name}.native.out"
|
|
INCLUDE_DIRECTORIES ""
|
|
COMPILE_FLAGS "${BENCHMARK_TEST_COMPILE_FLAGS}"
|
|
LINK_FLAGS "${BENCHMARK_TEST_NATIVE_LINK_FLAGS}")
|
|
endif()
|
|
endmacro()
|
|
|
|
|
|
#==============================================================================
|
|
# Register Benchmark tests
|
|
#==============================================================================
|
|
file(GLOB BENCHMARK_TESTS "*.bench.cpp")
|
|
foreach(test_path ${BENCHMARK_TESTS})
|
|
get_filename_component(test_file "${test_path}" NAME)
|
|
message(STATUS "TEST: ${test_file}")
|
|
string(REPLACE ".bench.cpp" "" test_name "${test_file}")
|
|
add_benchmark_test(${test_name} ${test_file})
|
|
endforeach()
|