|
| 1 | +cmake_minimum_required(VERSION 3.28) |
| 2 | + |
| 3 | +project(randomshake VERSION 0.1.0 LANGUAGES CXX) |
| 4 | + |
| 5 | +# --- Options --- |
| 6 | +option(RANDOMSHAKE_BUILD_TESTS "Build tests" OFF) |
| 7 | +option(RANDOMSHAKE_BUILD_EXAMPLES "Build examples" OFF) |
| 8 | +option(RANDOMSHAKE_BUILD_BENCHMARKS "Build benchmarks" OFF) |
| 9 | +option(RANDOMSHAKE_FETCH_DEPS "Fetch missing dependencies (GTest, Benchmark)" OFF) |
| 10 | + |
| 11 | +# --- Top-level-only settings (skipped when consumed via FetchContent/add_subdirectory) --- |
| 12 | +if(PROJECT_IS_TOP_LEVEL) |
| 13 | + set(CMAKE_EXPORT_COMPILE_COMMANDS ON) |
| 14 | + |
| 15 | + option(RANDOMSHAKE_ENABLE_LTO "Enable Interprocedural Optimization (LTO)" ON) |
| 16 | + option(RANDOMSHAKE_NATIVE_OPT "Enable -march=native (not suitable for cross-compilation)" OFF) |
| 17 | + option(RANDOMSHAKE_ASAN "Enable AddressSanitizer" OFF) |
| 18 | + option(RANDOMSHAKE_UBSAN "Enable UndefinedBehaviorSanitizer" OFF) |
| 19 | + |
| 20 | + # --- Tools --- |
| 21 | + find_program(CLANG_TIDY_EXE clang-tidy) |
| 22 | + find_program(CLANG_FORMAT_EXE clang-format) |
| 23 | + |
| 24 | + if(CLANG_TIDY_EXE) |
| 25 | + file(GLOB_RECURSE TIDY_SOURCES "examples/*.cpp") |
| 26 | + |
| 27 | + add_custom_target(tidy |
| 28 | + COMMAND ${CLANG_TIDY_EXE} -p ${CMAKE_BINARY_DIR} --config-file=${CMAKE_CURRENT_SOURCE_DIR}/.clang-tidy --header-filter=${CMAKE_CURRENT_SOURCE_DIR}/include/randomshake/.* ${TIDY_SOURCES} |
| 29 | + WORKING_DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR} |
| 30 | + COMMENT "Running clang-tidy" |
| 31 | + ) |
| 32 | + endif() |
| 33 | + |
| 34 | + if(CLANG_FORMAT_EXE) |
| 35 | + file(GLOB_RECURSE FORMAT_SOURCES |
| 36 | + "include/**/*.hpp" "examples/*.cpp" |
| 37 | + "benches/*.hpp" "benches/*.cpp" |
| 38 | + "tests/*.hpp" "tests/*.cpp") |
| 39 | + |
| 40 | + add_custom_target(format |
| 41 | + COMMAND ${CLANG_FORMAT_EXE} -i -style=file ${FORMAT_SOURCES} |
| 42 | + WORKING_DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR} |
| 43 | + COMMENT "Running clang-format" |
| 44 | + ) |
| 45 | + endif() |
| 46 | + |
| 47 | + # --- Standard settings --- |
| 48 | + set(CMAKE_CXX_STANDARD 20) |
| 49 | + set(CMAKE_CXX_STANDARD_REQUIRED ON) |
| 50 | + set(CMAKE_CXX_EXTENSIONS OFF) |
| 51 | + |
| 52 | + # --- Compiler Warnings --- |
| 53 | + if(MSVC) |
| 54 | + set(RANDOMSHAKE_WARNING_FLAGS /W4) |
| 55 | + else() |
| 56 | + set(RANDOMSHAKE_WARNING_FLAGS -Wall -Wextra -Wpedantic -Wshadow -Wconversion -Wformat=2 -Wcast-qual -Wold-style-cast -Wundef -Werror) |
| 57 | + if(CMAKE_CXX_COMPILER_ID MATCHES "Clang") |
| 58 | + list(APPEND RANDOMSHAKE_WARNING_FLAGS -Wno-pass-failed) |
| 59 | + endif() |
| 60 | + endif() |
| 61 | + |
| 62 | + # --- Sanitizers --- |
| 63 | + if(RANDOMSHAKE_ASAN) |
| 64 | + add_compile_options(-fsanitize=address -fno-omit-frame-pointer -fno-optimize-sibling-calls) |
| 65 | + add_link_options(-fsanitize=address) |
| 66 | + endif() |
| 67 | + |
| 68 | + if(RANDOMSHAKE_UBSAN) |
| 69 | + add_compile_options(-fsanitize=undefined -fno-omit-frame-pointer -fno-optimize-sibling-calls -fno-sanitize-recover=undefined) |
| 70 | + add_link_options(-fsanitize=undefined) |
| 71 | + endif() |
| 72 | + |
| 73 | + # --- Native Optimization --- |
| 74 | + if(RANDOMSHAKE_NATIVE_OPT) |
| 75 | + add_compile_options(-march=native) |
| 76 | + message(STATUS "Enabled -march=native (machine-specific optimization)") |
| 77 | + endif() |
| 78 | + |
| 79 | + # --- LTO --- |
| 80 | + if(RANDOMSHAKE_ENABLE_LTO) |
| 81 | + include(CheckIPOSupported) |
| 82 | + check_ipo_supported(RESULT result OUTPUT output) |
| 83 | + if(result) |
| 84 | + set(CMAKE_INTERPROCEDURAL_OPTIMIZATION TRUE) |
| 85 | + else() |
| 86 | + message(WARNING "LTO is not supported: ${output}") |
| 87 | + endif() |
| 88 | + endif() |
| 89 | +endif() |
| 90 | + |
| 91 | +# --- Dependency: sha3 (via FetchContent) --- |
| 92 | +include(FetchContent) |
| 93 | +FetchContent_Declare( |
| 94 | + sha3 |
| 95 | + GIT_REPOSITORY https://github.com/itzmeanjan/sha3.git |
| 96 | + GIT_TAG master |
| 97 | + GIT_SHALLOW TRUE |
| 98 | +) |
| 99 | +FetchContent_MakeAvailable(sha3) |
| 100 | + |
| 101 | +# --- Library (header-only → INTERFACE) --- |
| 102 | +add_library(randomshake INTERFACE) |
| 103 | +target_include_directories(randomshake INTERFACE |
| 104 | + $<BUILD_INTERFACE:${CMAKE_CURRENT_SOURCE_DIR}/include> |
| 105 | + $<INSTALL_INTERFACE:include> |
| 106 | +) |
| 107 | +target_link_libraries(randomshake INTERFACE sha3) |
| 108 | +target_compile_features(randomshake INTERFACE cxx_std_20) |
| 109 | + |
| 110 | +# --- Tests --- |
| 111 | +if(RANDOMSHAKE_BUILD_TESTS) |
| 112 | + enable_testing() |
| 113 | + if(RANDOMSHAKE_FETCH_DEPS) |
| 114 | + message(STATUS "Fetching GTest...") |
| 115 | + include(FetchContent) |
| 116 | + FetchContent_Declare( |
| 117 | + googletest |
| 118 | + URL https://github.com/google/googletest/archive/refs/tags/v1.17.0.zip |
| 119 | + DOWNLOAD_EXTRACT_TIMESTAMP TRUE |
| 120 | + ) |
| 121 | + set(gtest_force_shared_crt ON CACHE BOOL "" FORCE) |
| 122 | + FetchContent_MakeAvailable(googletest) |
| 123 | + else() |
| 124 | + find_package(GTest REQUIRED) |
| 125 | + endif() |
| 126 | + |
| 127 | + file(GLOB TEST_SOURCES CONFIGURE_DEPENDS "tests/*.cpp") |
| 128 | + |
| 129 | + add_executable(randomshake_tests ${TEST_SOURCES}) |
| 130 | + target_link_libraries(randomshake_tests PRIVATE randomshake GTest::gtest_main) |
| 131 | + target_include_directories(randomshake_tests PRIVATE tests) |
| 132 | + target_compile_options(randomshake_tests PRIVATE ${RANDOMSHAKE_WARNING_FLAGS}) |
| 133 | + |
| 134 | + include(GoogleTest) |
| 135 | + gtest_discover_tests(randomshake_tests) |
| 136 | +endif() |
| 137 | + |
| 138 | +# --- Benchmarks --- |
| 139 | +if(RANDOMSHAKE_BUILD_BENCHMARKS) |
| 140 | + if(RANDOMSHAKE_FETCH_DEPS) |
| 141 | + message(STATUS "Fetching Google Benchmark...") |
| 142 | + include(FetchContent) |
| 143 | + FetchContent_Declare( |
| 144 | + benchmark |
| 145 | + URL https://github.com/google/benchmark/archive/refs/tags/v1.9.5.zip |
| 146 | + DOWNLOAD_EXTRACT_TIMESTAMP TRUE |
| 147 | + ) |
| 148 | + set(BENCHMARK_ENABLE_TESTING OFF CACHE BOOL "" FORCE) |
| 149 | + set(BENCHMARK_ENABLE_INSTALL OFF CACHE BOOL "" FORCE) |
| 150 | + FetchContent_MakeAvailable(benchmark) |
| 151 | + else() |
| 152 | + find_package(benchmark REQUIRED) |
| 153 | + endif() |
| 154 | + |
| 155 | + file(GLOB BENCHMARK_SOURCES CONFIGURE_DEPENDS "benches/*.cpp") |
| 156 | + find_library(LIBPFM pfm) |
| 157 | + |
| 158 | + add_executable(randomshake_benchmarks ${BENCHMARK_SOURCES}) |
| 159 | + target_link_libraries(randomshake_benchmarks PRIVATE randomshake benchmark::benchmark_main) |
| 160 | + |
| 161 | + if(LIBPFM) |
| 162 | + target_link_libraries(randomshake_benchmarks PRIVATE ${LIBPFM}) |
| 163 | + message(STATUS "Found libpfm: ${LIBPFM} - linking it to benchmarks") |
| 164 | + endif() |
| 165 | + |
| 166 | + target_include_directories(randomshake_benchmarks PRIVATE benches) |
| 167 | + target_compile_options(randomshake_benchmarks PRIVATE ${RANDOMSHAKE_WARNING_FLAGS}) |
| 168 | +endif() |
| 169 | + |
| 170 | +# --- Examples --- |
| 171 | +if(RANDOMSHAKE_BUILD_EXAMPLES) |
| 172 | + file(GLOB EXAMPLE_SOURCES CONFIGURE_DEPENDS "examples/*.cpp") |
| 173 | + foreach(ex_src ${EXAMPLE_SOURCES}) |
| 174 | + get_filename_component(ex_name ${ex_src} NAME_WE) |
| 175 | + set(ex_target "${ex_name}_example") |
| 176 | + add_executable(${ex_target} ${ex_src}) |
| 177 | + target_link_libraries(${ex_target} PRIVATE randomshake) |
| 178 | + target_compile_options(${ex_target} PRIVATE ${RANDOMSHAKE_WARNING_FLAGS}) |
| 179 | + endforeach() |
| 180 | +endif() |
| 181 | + |
| 182 | +# --- Install --- |
| 183 | +include(GNUInstallDirs) |
| 184 | +install(TARGETS randomshake EXPORT randomshake-config INCLUDES DESTINATION ${CMAKE_INSTALL_INCLUDEDIR}) |
| 185 | +install(DIRECTORY include/ DESTINATION ${CMAKE_INSTALL_INCLUDEDIR}) |
| 186 | +install(EXPORT randomshake-config NAMESPACE randomshake:: DESTINATION ${CMAKE_INSTALL_LIBDIR}/cmake/randomshake) |
0 commit comments