Warning, /EICrecon/CMakeLists.txt is written in an unsupported language. File is not indexed.
0001 # cmake-format: off
0002 #
0003 # Variables to control this CMake build:
0004 # ===================================================================================
0005 # CMake flag | environment variable | Description
0006 # ===================================================================================
0007 # -- (under review) | EDM4HEP_ROOT | Edm4Hep installation directory
0008 #------------------------------------------------------------------------------------
0009 # -DCMAKE_CXX_STANDARD | 17 - standard for C++ compilation
0010 # ===================================================================================
0011 #
0012 #
0013 # ==============================================================
0014 # DEPENDENCIES (used by find_package)
0015 # ==============================================================
0016 # Name | Description
0017 # ==============================================================
0018 # JANA | Jana2 framework
0019 # EDM4HEP | Event data model based on podio
0020 # podio | IO library
0021 # DD4hep | Geometry framework
0022 # ROOT | CERN ROOT
0023 # spdlog | Formatting library
0024 # IRT | Indirect Ray Tracing library
0025 # ==============================================================
0026 #
0027 # cmake-format: on
0028
0029 cmake_minimum_required(VERSION 3.24)
0030
0031 # 3.27: find_package() uses upper-case <PACKAGENAME>_ROOT variables
0032 cmake_policy(SET CMP0144 NEW)
0033
0034 project(EICrecon LANGUAGES CXX)
0035
0036 # CMake includes
0037 include(CheckCXXCompilerFlag)
0038
0039 # Set version based on git
0040 include(cmake/git_version.cmake)
0041 set_git_version(CMAKE_PROJECT_VERSION)
0042
0043 # Set a default build type if none was specified
0044 set(default_build_type "Release")
0045 if(NOT CMAKE_BUILD_TYPE AND NOT CMAKE_CONFIGURATION_TYPES)
0046 message(
0047 STATUS
0048 "Setting build type to '${default_build_type}' as none was specified.")
0049 set(CMAKE_BUILD_TYPE
0050 "${default_build_type}"
0051 CACHE STRING "Choose the type of build." FORCE)
0052 # Set the possible values of build type for cmake-gui
0053 set_property(CACHE CMAKE_BUILD_TYPE PROPERTY STRINGS "Debug" "Release"
0054 "MinSizeRel" "RelWithDebInfo")
0055 endif()
0056
0057 # Minimal dependency versions
0058 set(Acts_VERSION_MIN 39.2.0)
0059 set(algorithms_VERSION_MIN 1.0.0)
0060 set(DD4hep_VERSION_MIN 1.21)
0061 set(EDM4EIC_VERSION_MIN 8.0)
0062 set(EDM4HEP_VERSION_MIN 0.99.0)
0063 set(Eigen3_VERSION_MIN 3.3)
0064 set(FastJet_VERSION_MIN 3)
0065 set(FastJetContrib_VERSION_MIN 1.46)
0066 set(fmt_VERSION_MIN 9.0.0)
0067 set(IRT_VERSION_MIN 1.0.5)
0068 set(JANA_VERSION_MIN 2.4.0)
0069 set(onnxruntime_MIN_VERSION 1.17)
0070 set(podio_VERSION_MIN 1.3)
0071 set(ROOT_VERSION_MIN 6.28)
0072 set(spdlog_VERSION_MIN 1.11.0)
0073
0074 # Set default standard to C++20
0075 set(CMAKE_CXX_STANDARD_MIN 20)
0076 set(CMAKE_CXX_STANDARD
0077 ${CMAKE_CXX_STANDARD_MIN}
0078 CACHE STRING "C++ standard to be used")
0079 if(CMAKE_CXX_STANDARD LESS CMAKE_CXX_STANDARD_MIN)
0080 message(
0081 FATAL_ERROR
0082 "Unsupported C++ standard: ${CMAKE_CXX_STANDARD} (at least ${CMAKE_CXX_STANDARD_MIN} required)"
0083 )
0084 endif()
0085 set(CMAKE_CXX_STANDARD_REQUIRED ON)
0086 set(CMAKE_CXX_EXTENSIONS OFF)
0087
0088 # Infrastructure to support use of --no-as-needed
0089 include(CheckLinkerFlag)
0090 check_linker_flag(CXX "LINKER:--no-as-needed" CXX_LINKER_HAS_no_as_needed)
0091 set(CMAKE_CXX_LINK_LIBRARY_USING_NO_AS_NEEDED_SUPPORTED TRUE)
0092 set(CMAKE_CXX_LINK_LIBRARY_USING_NO_AS_NEEDED
0093 "LINKER:--push-state,--no-as-needed" "<LINK_ITEM>" "LINKER:--pop-state")
0094
0095 # Export compile commands as json for run-clang-tidy
0096 set(CMAKE_EXPORT_COMPILE_COMMANDS ON)
0097
0098 # Also use clang-tidy integration in CMake
0099 option(ENABLE_CLANG_TIDY "Enable clang-tidy integration in cmake" OFF)
0100 if(ENABLE_CLANG_TIDY)
0101 find_program(CLANG_TIDY_EXE NAMES "clang-tidy")
0102 if(CLANG_TIDY_EXE)
0103 message(STATUS "clang-tidy found: ${CLANG_TIDY_EXE}")
0104 set(CMAKE_CXX_CLANG_TIDY
0105 "${CLANG_TIDY_EXE}"
0106 CACHE STRING "" FORCE)
0107 else()
0108 set(CMAKE_CXX_CLANG_TIDY
0109 ""
0110 CACHE STRING "" FORCE)
0111 endif()
0112 endif()
0113
0114 # LINK_WHAT_YOU_USE support
0115 option(ENABLE_LINK_WHAT_YOU_USE
0116 "Enable LINK_WHAT_YOU_USE to detect unnecessary link dependencies" OFF)
0117 if(ENABLE_LINK_WHAT_YOU_USE)
0118 message(STATUS "LINK_WHAT_YOU_USE enabled")
0119 set(CMAKE_LINK_WHAT_YOU_USE TRUE)
0120
0121 # Set output directory for LINK_WHAT_YOU_USE logs
0122 set(LINK_WHAT_YOU_USE_OUTPUT_DIR "${CMAKE_BINARY_DIR}/link_what_you_use_logs")
0123
0124 # Set up custom check script for better output control; CMake will append the
0125 # binary file path as the last argument
0126 set(CMAKE_LINK_WHAT_YOU_USE_CHECK
0127 "${CMAKE_COMMAND}" "-DOUTPUT_DIR=${LINK_WHAT_YOU_USE_OUTPUT_DIR}" -P
0128 "${CMAKE_SOURCE_DIR}/cmake/link_what_you_use_check.cmake")
0129
0130 message(
0131 STATUS
0132 "LINK_WHAT_YOU_USE logs will be written to: ${LINK_WHAT_YOU_USE_OUTPUT_DIR}"
0133 )
0134 endif()
0135
0136 # Enable -fPIC for all targets
0137 set(CMAKE_POSITION_INDEPENDENT_CODE ON)
0138
0139 # Install to the top directory by default
0140 if(${CMAKE_INSTALL_PREFIX_INITIALIZED_TO_DEFAULT})
0141 set(CMAKE_INSTALL_PREFIX
0142 ${CMAKE_SOURCE_DIR}
0143 CACHE PATH "Install in top directory by default" FORCE)
0144 endif()
0145
0146 # Install to standard location
0147 include(GNUInstallDirs)
0148
0149 # Default plugins installation directory is 'plugins'
0150 if(NOT DEFINED PLUGIN_OUTPUT_DIRECTORY)
0151 set(PLUGIN_OUTPUT_DIRECTORY "lib/${PROJECT_NAME}/plugins")
0152 message(STATUS "${CMAKE_PROJECT_NAME}: Set default PLUGIN_OUTPUT_DIRECTORY")
0153 endif()
0154 message(
0155 STATUS
0156 "${CMAKE_PROJECT_NAME}: PLUGIN_OUTPUT_DIRECTORY: ${PLUGIN_OUTPUT_DIRECTORY}"
0157 )
0158
0159 # Default plugins static libraries installation directory is 'lib'
0160 if(NOT DEFINED PLUGIN_LIBRARY_OUTPUT_DIRECTORY)
0161 set(PLUGIN_LIBRARY_OUTPUT_DIRECTORY "lib")
0162 message(STATUS "${CMAKE_PROJECT_NAME}: Set default PLUGIN_OUTPUT_DIRECTORY")
0163 endif()
0164 message(
0165 STATUS
0166 "${CMAKE_PROJECT_NAME}: PLUGIN_LIBRARY_OUTPUT_DIRECTORY: ${PLUGIN_LIBRARY_OUTPUT_DIRECTORY}"
0167 )
0168
0169 # Use, i.e. don't skip the full RPATH for the build tree, and use relative paths
0170 # for relocatable build products
0171 set(CMAKE_SKIP_BUILD_RPATH FALSE)
0172 set(CMAKE_BUILD_RPATH_USE_ORIGIN TRUE)
0173
0174 # When building, don't use the install RPATH already (but later on when
0175 # installing)
0176 set(CMAKE_BUILD_WITH_INSTALL_RPATH FALSE)
0177 set(CMAKE_SKIP_INSTALL_RPATH FALSE)
0178 set(CMAKE_INSTALL_RPATH
0179 "${CMAKE_INSTALL_PREFIX}/${PLUGIN_LIBRARY_OUTPUT_DIRECTORY};${CMAKE_INSTALL_PREFIX}/${PLUGIN_OUTPUT_DIRECTORY}"
0180 )
0181
0182 # Add the automatically determined parts of the RPATH which point to directories
0183 # outside the build tree to the install RPATH
0184 set(CMAKE_INSTALL_RPATH_USE_LINK_PATH TRUE)
0185
0186 # Check and print what JANA2 is used
0187 find_package(JANA ${JANA_VERSION_MIN} REQUIRED)
0188 message(STATUS "${CMAKE_PROJECT_NAME}: JANA2 CMake : ${JANA_DIR}")
0189 message(STATUS "${CMAKE_PROJECT_NAME}: JANA2 includes: ${JANA_INCLUDE_DIR}")
0190 message(STATUS "${CMAKE_PROJECT_NAME}: JANA2 library : ${JANA_LIBRARY}")
0191
0192 # Algorithms
0193 find_package(algorithms ${algorithms_VERSION_MIN} REQUIRED Core)
0194
0195 # PODIO, EDM4HEP, EDM4EIC event models
0196 find_package(Eigen3 ${Eigen3_VERSION_MIN} REQUIRED)
0197 find_package(podio ${podio_VERSION_MIN} REQUIRED)
0198 find_package(EDM4HEP ${EDM4HEP_VERSION_MIN} REQUIRED)
0199 find_package(EDM4EIC ${EDM4EIC_VERSION_MIN} REQUIRED)
0200
0201 # fmt
0202 find_package(fmt ${fmt_VERSION_MIN} REQUIRED)
0203
0204 # spdlog
0205 find_package(spdlog ${spdlog_VERSION_MIN} REQUIRED)
0206
0207 # Guidelines Support Library
0208 find_package(Microsoft.GSL CONFIG)
0209
0210 # Remove PODIO_JSON_OUTPUT (ref: https://github.com/AIDASoft/podio/issues/475)
0211 get_target_property(EDM4HEP_INTERFACE_COMPILE_DEFINITIONS EDM4HEP::edm4hep
0212 INTERFACE_COMPILE_DEFINITIONS)
0213 if(EDM4HEP_INTERFACE_COMPILE_DEFINITIONS)
0214 list(FILTER EDM4HEP_INTERFACE_COMPILE_DEFINITIONS EXCLUDE REGEX
0215 [[^PODIO_JSON_OUTPUT$]])
0216 set_property(
0217 TARGET EDM4HEP::edm4hep PROPERTY INTERFACE_COMPILE_DEFINITIONS
0218 ${EDM4HEP_INTERFACE_COMPILE_DEFINITIONS})
0219 endif()
0220 get_target_property(EDM4EIC_INTERFACE_COMPILE_DEFINITIONS EDM4EIC::edm4eic
0221 INTERFACE_COMPILE_DEFINITIONS)
0222 if(EDM4EIC_INTERFACE_COMPILE_DEFINITIONS)
0223 list(FILTER EDM4EIC_INTERFACE_COMPILE_DEFINITIONS EXCLUDE REGEX
0224 [[^PODIO_JSON_OUTPUT$]])
0225 set_property(
0226 TARGET EDM4EIC::edm4eic PROPERTY INTERFACE_COMPILE_DEFINITIONS
0227 ${EDM4EIC_INTERFACE_COMPILE_DEFINITIONS})
0228 endif()
0229
0230 # DD4Hep is required for the most of the part
0231 find_package(DD4hep ${DD4hep_VERSION_MIN} REQUIRED)
0232
0233 # ACTS cmake-lint: disable=C0103
0234 find_package(Acts REQUIRED COMPONENTS Core PluginDD4hep PluginJson)
0235 set(Acts_VERSION
0236 "${Acts_VERSION_MAJOR}.${Acts_VERSION_MINOR}.${Acts_VERSION_PATCH}")
0237 if(${Acts_VERSION} VERSION_LESS ${Acts_VERSION_MIN})
0238 message(
0239 FATAL_ERROR
0240 "Acts version ${Acts_VERSION_MIN} or higher required, but ${Acts_VERSION} found"
0241 )
0242 endif()
0243 if(${Acts_VERSION} VERSION_GREATER_EQUAL "43.0.0")
0244 set(Acts_NAMESPACE_PREFIX Acts::)
0245 else()
0246 set(Acts_NAMESPACE_PREFIX Acts)
0247 endif()
0248 # Acts::Core
0249 get_target_property(ACTS_COMPILE_FEATURES ${Acts_NAMESPACE_PREFIX}Core
0250 INTERFACE_COMPILE_FEATURES)
0251 if(NOT "cxx_std_${CMAKE_CXX_STANDARD}" IN_LIST ACTS_COMPILE_FEATURES)
0252 message(
0253 WARNING
0254 "Acts has not been built with the requested C++ standard ${CMAKE_CXX_STANDARD}."
0255 )
0256 endif()
0257
0258 # Workaround for multiple definition bug in Acts < 40
0259 # (https://github.com/acts-project/acts/pull/4380)
0260 if(Acts_VERSION VERSION_LESS "40.0.0")
0261 if(TARGET ${Acts_NAMESPACE_PREFIX}PluginPodio)
0262 message(STATUS "Checking if older Acts version needs linker flags...")
0263 try_compile(
0264 Acts_needs_allow_multiple_definition
0265 ${CMAKE_BINARY_DIR}/Acts_needs_allow_multiple_definition
0266 SOURCES
0267 ${PROJECT_SOURCE_DIR}/cmake/Acts_needs_allow_multiple_definition/main.cc
0268 ${PROJECT_SOURCE_DIR}/cmake/Acts_needs_allow_multiple_definition/a.cc
0269 ${PROJECT_SOURCE_DIR}/cmake/Acts_needs_allow_multiple_definition/b.cc
0270 LINK_LIBRARIES podio::podio ${Acts_NAMESPACE_PREFIX}Core
0271 ${Acts_NAMESPACE_PREFIX}PluginPodio)
0272 if(NOT Acts_needs_allow_multiple_definition)
0273 message(WARNING "This Acts version requires --allow-multiple-definition. "
0274 "This may mask other multiple definition issues. "
0275 "Ref: https://github.com/acts-project/acts/pull/4380.")
0276 check_linker_flag(CXX "LINKER:--allow-multiple-definition"
0277 CXX_LINKER_HAS_allow_multiple_definition)
0278 if(CXX_LINKER_HAS_allow_multiple_definition)
0279 add_link_options("LINKER:--allow-multiple-definition")
0280 endif()
0281 endif()
0282 endif()
0283 endif()
0284
0285 # ROOT
0286 find_package(ROOT ${ROOT_VERSION_MIN} REQUIRED)
0287 # Check that ROOT is compiled with a modern enough c++ standard
0288 get_target_property(ROOT_COMPILE_FEATURES ROOT::Core INTERFACE_COMPILE_FEATURES)
0289 if(NOT "cxx_std_${CMAKE_CXX_STANDARD}" IN_LIST ROOT_COMPILE_FEATURES)
0290 message(
0291 WARNING
0292 "ROOT has not been built with the requested C++ standard ${CMAKE_CXX_STANDARD}."
0293 )
0294 endif()
0295
0296 # ONNX Runtime
0297 find_package(onnxruntime ${onnxruntime_MIN_VERSION} CONFIG)
0298
0299 # Add CMake additional functionality:
0300 include(cmake/jana_plugin.cmake) # Add common settings for plugins
0301 list(APPEND CMAKE_MODULE_PATH ${PROJECT_SOURCE_DIR}/cmake) # Find
0302 # Find<Modules>.cmake
0303
0304 enable_testing()
0305
0306 # Address sanitizer
0307 option(USE_ASAN "Compile with address sanitizer" OFF)
0308 if(${USE_ASAN})
0309 add_compile_options(-fsanitize=address -fno-omit-frame-pointer -g -O1)
0310 add_link_options(-fsanitize=address)
0311 install(FILES .github/asan.supp .github/lsan.supp
0312 DESTINATION ${CMAKE_INSTALL_DATADIR}/${PROJECT_NAME})
0313 endif()
0314
0315 # Thread sanitizer
0316 option(USE_TSAN "Compile with thread sanitizer" OFF)
0317 if(${USE_TSAN})
0318 add_compile_options(-fsanitize=thread -g -O1)
0319 add_link_options(-fsanitize=thread)
0320 install(FILES .github/tsan.supp
0321 DESTINATION ${CMAKE_INSTALL_DATADIR}/${PROJECT_NAME})
0322 endif()
0323
0324 # Undefined behavior sanitizer
0325 option(USE_UBSAN "Compile with undefined behavior sanitizer" OFF)
0326 if(${USE_UBSAN})
0327 foreach(sanitizer undefined float-divide-by-zero unsigned-integer-overflow
0328 implicit-conversion local-bounds nullability)
0329 check_cxx_compiler_flag("-fsanitize=${sanitizer}"
0330 CXX_COMPILER_HAS_sanitize_${sanitizer})
0331 if(CXX_COMPILER_HAS_sanitize_${sanitizer})
0332 add_compile_options(-fsanitize=${sanitizer})
0333 add_link_options(-fsanitize=${sanitizer})
0334 endif()
0335 endforeach()
0336 add_compile_options(-g -O1)
0337 install(FILES .github/ubsan.supp
0338 DESTINATION ${CMAKE_INSTALL_DATADIR}/${PROJECT_NAME})
0339 endif()
0340
0341 # Compress debug symbols if supported
0342 check_cxx_compiler_flag("-gz" CXX_COMPILER_HAS_gz)
0343 if(CXX_COMPILER_HAS_gz)
0344 set(CMAKE_CXX_FLAGS_DEBUG "${CMAKE_CXX_FLAGS_DEBUG} -gz")
0345 set(CMAKE_CXX_FLAGS_RELWITHDEBINFO "${CMAKE_CXX_FLAGS_RELWITHDEBINFO} -gz")
0346 endif()
0347
0348 add_subdirectory(src/services)
0349 add_subdirectory(src/algorithms)
0350 add_subdirectory(src/benchmarks)
0351 add_subdirectory(src/detectors)
0352 add_subdirectory(src/extensions)
0353 add_subdirectory(src/factories)
0354 add_subdirectory(src/global)
0355 add_subdirectory(src/scripts)
0356 add_subdirectory(src/tests)
0357 add_subdirectory(src/utilities)
0358
0359 # Install all cmake helpers
0360 include(CMakePackageConfigHelpers)
0361 configure_package_config_file(
0362 cmake/${PROJECT_NAME}Config.cmake.in
0363 ${CMAKE_CURRENT_BINARY_DIR}/cmake/${PROJECT_NAME}Config.cmake
0364 INSTALL_DESTINATION ${CMAKE_INSTALL_LIBDIR}/cmake/${PROJECT_NAME})
0365 write_basic_package_version_file(
0366 ${CMAKE_CURRENT_BINARY_DIR}/cmake/${PROJECT_NAME}ConfigVersion.cmake
0367 VERSION ${CMAKE_PROJECT_VERSION}
0368 COMPATIBILITY SameMajorVersion)
0369 install(
0370 FILES ${CMAKE_CURRENT_BINARY_DIR}/cmake/${PROJECT_NAME}Config.cmake
0371 ${CMAKE_CURRENT_BINARY_DIR}/cmake/${PROJECT_NAME}ConfigVersion.cmake
0372 DESTINATION ${CMAKE_INSTALL_LIBDIR}/cmake/${PROJECT_NAME})
0373 install(
0374 EXPORT ${PROJECT_NAME}Targets
0375 NAMESPACE ${PROJECT_NAME}::
0376 DESTINATION ${CMAKE_INSTALL_LIBDIR}/cmake/${PROJECT_NAME})
0377 install(
0378 DIRECTORY cmake/
0379 DESTINATION ${CMAKE_INSTALL_LIBDIR}/cmake/${PROJECT_NAME}
0380 FILES_MATCHING
0381 PATTERN *.cmake)
