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