778af2a760
* omnitrace namespace
* Kokkos + Lulesh example/tests
* Sampling support + more
- OMNITRACE_BUILD_TESTING option
- sampling support
- pthread_gotcha
- fixes to labels for mpi_gotcha, fork_gotcha, omnitrace_component
- tasking::block_signals, tasking::unblock_signals
- instrumentation mode option in omnitrace exe
- argument option groups in omnitrace exe
- categories in omnitrace settings
- remove TIMEMORY_ prefixed options
* Release workflow updates
* Updated settings printing
* Fixed defaults in README
* Tweak setting defaults in README
* CMake fixes
* cmake-format
* clang-format
* LULESH_USE_MPI OFF
* LULESH_USE_MPI fix
* timemory add_secondary fix
* timemory ambiguous internal namespace fix
* Update timemory submodule
* Handle output path/prefix in omnitrace
- updated timemory
- updated test environment
* sampling + papi fix
* Fix to sampling without PAPI
* Fix for using too many processors in CI
* formatting
* Updated CI
- minor cmake tweaks
- updated timemory submodule
* Updated CI
* Updated CI
* CI + timemory updates
- data race fixes
* CI updates + debug for sampling
* Sampling updates
- moved tasking::{block,unblock}_signals to sampling namespace
- improvements to sampling w.r.t. thread-locality
* Minimum OMNITRACE_THREAD_COUNT of 128
* Handle multiple dims in sampler data
* Configure libunwind support for timemory
* Improved safeguards for sampling
- updated CI
- lulesh runtime-instrument test tweak
* formatting
* CI updates + sampler updates + misc
- fixed stack-buffer-overflow in omnitrace (get_*file_line_info)
- test labels
- steady_clock instead of system_clock in sampler
- update dyninst submodule with upgradePlaceholder fix
- disable OMNITRACE_BUILD_TESTING by default
* Updated timemory submodule
- hidden visibility for timemory
- storage finalizers do not capture this
* Update timemory submodule
- component visibility updates
* Reworked header includes
- use <...> for timemory headers
- always include <library/defines.hpp>
* Rename some config options
* Update PTL submodule
* Update kokkos submodule
* Updated sampling
* Updated CI
* Reworked instrumentation exe
- lowered min-address-range threshold to 256
- extended whole function exclude
* CI fix + timemory submodule update
- TIMEMORY_VISIBLE on component base
- RelWithDebugInfo -> RelWithDebInfo
- Info output for parallel-overhead
* Sampling flags + transpose update + CI update
- disable critical trace for parallel-overhead in CI
- SA_RESTART only in sampler
- reworked transpose example to use fewer threads
* CI update
- removed ubuntu-focal-external-debug
- reduced data artifacts upload
* CI timeouts
- updated timemory submodule
- minor tweaks to omnitrace exe logging
* LICENSE updates (partial)
* CI Test stage timeout extension
* Docker and Packaging updates
* Miscellaneous fixes/tweaks
- gpu.hpp / gpu.cpp
- disable roctracer component if no devices
- re-enable InstrStackFrames by default
- disable sampling by default
- pthread_gotcha::m_enable_sampling is false by default
- timemory submodule update w/ sampler and pop(tid) updates
- fix minor bug in sampler logic
- CMake: OMNITRACE_USE_HIP option
- roctracer + timemory fix
* Replaced OMNITRACE_USE_ROCTRACER with OMNITRACE_USE_HIP where appropriate
* cmake format
* Sampler deadlock fixes
* Removed debug messages from sampler
* Fix for MPI detection + test tweaks + misc
* Sampler deadlock fixes + misc
- removed papi_tot_ins
- pthread_gotcha blocks signals globally until sampler is setup
- metadata specialization for sampling components
- OMNITRACE_INSTRUMENTATION_MODE -> OMNITRACE_MODE
- default sampling delay increased to 0.05 from 1.0e-6
- removed {block,unblock}_signals from critical_trace and ptl
- no longer necessary to use
- sampling delay minimum is 1.0e-3
- OMNITRACE_BUILD_HIDDEN_VISIBILITY
* omnitrace-avail + libunwind update + restructure
- restructured omnitrace components
- build custom omnitrace-avail executable
- updated libunwind to avoid malloc in get_unw_backtrace
* Fix remaining reorganization issues
- removed some duplicate code
- fixed some trait specializations after implicit instatiation
- formatting
* ensure_storage fix + avail improvements
- fix ensure_storage when component not avail
- suppress irrelevant info in omnitrace-avail
* Delay settings initialization
- slight tweak to tests w/ MPI
* Disable OpenMPI testing w/ ubuntu-bionic
- MPI testing is hanging bc of network interface issue on system:
> [[20462,1],0]: A high-performance Open MPI point-to-point messaging module
> was unable to find any relevant network interfaces:
> Module: OpenFabrics (openib)
> Host: fv-az19-371
> Another transport will be used instead, although this may result in
> lower performance.
> NOTE: You can disable this warning by setting the MCA parameter
> btl_base_warn_component_unused to 0.
355 γραμμές
13 KiB
CMake
355 γραμμές
13 KiB
CMake
cmake_minimum_required(VERSION 3.15 FATAL_ERROR)
|
|
|
|
if(CMAKE_SOURCE_DIR STREQUAL CMAKE_BINARY_DIR AND CMAKE_CURRENT_SOURCE_DIR STREQUAL
|
|
CMAKE_SOURCE_DIR)
|
|
set(MSG "")
|
|
message(STATUS "Warning! Building from the source directory is not recommended")
|
|
message(STATUS "If unintented, please remove 'CMakeCache.txt' and 'CMakeFiles'")
|
|
message(STATUS "and build from a separate directory")
|
|
message(AUTHOR_WARNING "In-source build")
|
|
endif()
|
|
|
|
if(NOT UNIX OR APPLE)
|
|
message(
|
|
AUTHOR_WARNING
|
|
"omnitrace only supports Linux. Configure and/or build is likely to fail")
|
|
endif()
|
|
|
|
file(READ "${CMAKE_CURRENT_SOURCE_DIR}/VERSION" FULL_VERSION_STRING LIMIT_COUNT 1)
|
|
string(REGEX REPLACE "(\n|\r)" "" FULL_VERSION_STRING "${FULL_VERSION_STRING}")
|
|
string(REGEX REPLACE "([0-9]+)\.([0-9]+)\.([0-9]+)(.*)" "\\1.\\2.\\3" OMNITRACE_VERSION
|
|
"${FULL_VERSION_STRING}")
|
|
|
|
project(
|
|
omnitrace
|
|
LANGUAGES C CXX
|
|
VERSION ${OMNITRACE_VERSION}
|
|
DESCRIPTION "CPU/GPU Application tracing with static/dynamic binary instrumentation"
|
|
HOMEPAGE_URL "https://github.com/AARInternal/omnitrace")
|
|
|
|
message(
|
|
STATUS
|
|
"[${PROJECT_NAME}] version ${PROJECT_VERSION_MAJOR}.${PROJECT_VERSION_MINOR}.${PROJECT_VERSION_PATCH}"
|
|
)
|
|
set(CMAKE_MODULE_PATH ${PROJECT_SOURCE_DIR}/cmake ${PROJECT_SOURCE_DIR}/cmake/Modules
|
|
${CMAKE_MODULE_PATH})
|
|
set(BUILD_SHARED_LIBS
|
|
ON
|
|
CACHE BOOL "Build shared libraries")
|
|
set(BUILD_STATIC_LIBS
|
|
OFF
|
|
CACHE BOOL "Build static libraries")
|
|
set(CMAKE_POSITION_INDEPENDENT_CODE
|
|
ON
|
|
CACHE BOOL "Build position independent code")
|
|
|
|
if("${CMAKE_BUILD_TYPE}" STREQUAL "")
|
|
set(CMAKE_BUILD_TYPE
|
|
RelWithDebInfo
|
|
CACHE STRING "Build type" FORCE)
|
|
endif()
|
|
|
|
include(GNUInstallDirs) # install directories
|
|
include(MacroUtilities) # various functions and macros
|
|
include(Compilers) # compiler identification
|
|
include(BuildSettings) # compiler flags
|
|
|
|
set(CMAKE_CXX_STANDARD
|
|
17
|
|
CACHE STRING "CXX language standard")
|
|
omnitrace_add_feature(CMAKE_CXX_STANDARD "CXX language standard")
|
|
omnitrace_add_feature(CMAKE_BUILD_TYPE "Build optimization level")
|
|
omnitrace_add_option(CMAKE_CXX_STANDARD_REQUIRED "Require C++ language standard" ON)
|
|
omnitrace_add_option(CMAKE_CXX_EXTENSIONS "Compiler specific language extensions" OFF)
|
|
omnitrace_add_option(CMAKE_INSTALL_RPATH_USE_LINK_PATH "Enable rpath to linked libraries"
|
|
ON)
|
|
|
|
omnitrace_add_option(OMNITRACE_USE_CLANG_TIDY "Enable clang-tidy" OFF)
|
|
omnitrace_add_option(OMNITRACE_USE_MPI "Enable MPI support" OFF)
|
|
omnitrace_add_option(OMNITRACE_USE_HIP "Enable HIP support" ON)
|
|
omnitrace_add_option(OMNITRACE_USE_ROCTRACER "Enable roctracer support"
|
|
${OMNITRACE_USE_HIP})
|
|
omnitrace_add_option(OMNITRACE_USE_MPI_HEADERS
|
|
"Enable wrapping MPI functions w/o enabling MPI dependency" OFF)
|
|
omnitrace_add_option(OMNITRACE_BUILD_DYNINST "Build dyninst from submodule" OFF)
|
|
omnitrace_add_option(OMNITRACE_BUILD_TESTING "Enable building the testing suite" OFF)
|
|
omnitrace_add_option(OMNITRACE_CUSTOM_DATA_SOURCE "Enable custom data source" OFF)
|
|
omnitrace_add_option(OMNITRACE_BUILD_HIDDEN_VISIBILITY
|
|
"Build with hidden visibility (disable for Debug builds)" ON)
|
|
|
|
if(NOT OMNITRACE_USE_HIP)
|
|
set(OMNITRACE_USE_ROCTRACER
|
|
OFF
|
|
CACHE BOOL "Disabled via OMNITRACE_USE_HIP=OFF" FORCE)
|
|
endif()
|
|
|
|
include(ProcessorCount)
|
|
processorcount(OMNITRACE_PROCESSOR_COUNT)
|
|
math(EXPR OMNITRACE_THREAD_COUNT "16 * ${OMNITRACE_PROCESSOR_COUNT}")
|
|
if(OMNITRACE_THREAD_COUNT LESS 128)
|
|
set(OMNITRACE_THREAD_COUNT 128)
|
|
endif()
|
|
set(OMNITRACE_MAX_THREADS
|
|
"${OMNITRACE_THREAD_COUNT}"
|
|
CACHE
|
|
STRING
|
|
"Maximum number of threads in the host application. Likely only needs to be increased if host app does not use thread-pool but creates many threads"
|
|
)
|
|
omnitrace_add_feature(
|
|
OMNITRACE_MAX_THREADS
|
|
"Maximum number of total threads supported in the host application (default: max of 128 or 16 * nproc)"
|
|
)
|
|
|
|
# default visibility settings
|
|
set(CMAKE_C_VISIBILITY_PRESET
|
|
"default"
|
|
CACHE STRING "Visibility preset for non-inline C functions")
|
|
set(CMAKE_CXX_VISIBILITY_PRESET
|
|
"default"
|
|
CACHE STRING "Visibility preset for non-inline C++ functions/objects")
|
|
set(CMAKE_VISIBILITY_INLINES_HIDDEN
|
|
OFF
|
|
CACHE BOOL "Visibility preset for inline functions")
|
|
set(CMAKE_EXPORT_COMPILE_COMMANDS ON)
|
|
|
|
include(Formatting) # format target
|
|
include(Packages) # finds third-party libraries
|
|
|
|
if(OMNITRACE_USE_HIP OR OMNITRACE_USE_ROCTRACER)
|
|
find_package(HIP QUIET)
|
|
if(HIP_VERSION_MAJOR GREATER_EQUAL 4 AND HIP_VERSION_MINOR GREATER 3)
|
|
set(roctracer_kfdwrapper_LIBRARY)
|
|
endif()
|
|
else()
|
|
set(HIP_VERSION "0.0.0")
|
|
set(HIP_VERSION_MAJOR 0)
|
|
set(HIP_VERSION_MINOR 0)
|
|
set(HIP_VERSION_PATCH 0)
|
|
endif()
|
|
|
|
configure_file(${PROJECT_SOURCE_DIR}/include/library/defines.hpp.in
|
|
${PROJECT_BINARY_DIR}/include/library/defines.hpp @ONLY)
|
|
|
|
omnitrace_activate_clang_tidy()
|
|
|
|
# custom visibility settings
|
|
if(OMNITRACE_BUILD_HIDDEN_VISIBILITY)
|
|
set(CMAKE_C_VISIBILITY_PRESET "hidden")
|
|
set(CMAKE_CXX_VISIBILITY_PRESET "hidden")
|
|
set(CMAKE_VISIBILITY_INLINES_HIDDEN ON)
|
|
endif()
|
|
|
|
if(OMNITRACE_BUILD_LTO)
|
|
set(CMAKE_INTERPROCEDURAL_OPTIMIZATION ON)
|
|
endif()
|
|
|
|
# ------------------------------------------------------------------------------#
|
|
#
|
|
# omnitrace-library target
|
|
#
|
|
# ------------------------------------------------------------------------------#
|
|
|
|
set(library_sources
|
|
${CMAKE_CURRENT_LIST_DIR}/src/library.cpp
|
|
${CMAKE_CURRENT_LIST_DIR}/src/library/config.cpp
|
|
${CMAKE_CURRENT_LIST_DIR}/src/library/critical_trace.cpp
|
|
${CMAKE_CURRENT_LIST_DIR}/src/library/gpu.cpp
|
|
${CMAKE_CURRENT_LIST_DIR}/src/library/perfetto.cpp
|
|
${CMAKE_CURRENT_LIST_DIR}/src/library/ptl.cpp
|
|
${CMAKE_CURRENT_LIST_DIR}/src/library/sampling.cpp
|
|
${CMAKE_CURRENT_LIST_DIR}/src/library/thread_data.cpp
|
|
${CMAKE_CURRENT_LIST_DIR}/src/library/timemory.cpp
|
|
${CMAKE_CURRENT_LIST_DIR}/src/library/components/backtrace.cpp
|
|
${CMAKE_CURRENT_LIST_DIR}/src/library/components/fork_gotcha.cpp
|
|
${CMAKE_CURRENT_LIST_DIR}/src/library/components/mpi_gotcha.cpp
|
|
${CMAKE_CURRENT_LIST_DIR}/src/library/components/omnitrace.cpp
|
|
${CMAKE_CURRENT_LIST_DIR}/src/library/components/pthread_gotcha.cpp
|
|
${perfetto_DIR}/sdk/perfetto.cc)
|
|
|
|
set(library_headers
|
|
${CMAKE_CURRENT_LIST_DIR}/include/library.hpp
|
|
${CMAKE_CURRENT_LIST_DIR}/include/library/api.hpp
|
|
${CMAKE_CURRENT_LIST_DIR}/include/library/config.hpp
|
|
${CMAKE_CURRENT_LIST_DIR}/include/library/common.hpp
|
|
${CMAKE_CURRENT_LIST_DIR}/include/library/critical_trace.hpp
|
|
${CMAKE_CURRENT_LIST_DIR}/include/library/debug.hpp
|
|
${CMAKE_CURRENT_LIST_DIR}/include/library/gpu.hpp
|
|
${CMAKE_CURRENT_LIST_DIR}/include/library/perfetto.hpp
|
|
${CMAKE_CURRENT_LIST_DIR}/include/library/ptl.hpp
|
|
${CMAKE_CURRENT_LIST_DIR}/include/library/sampling.hpp
|
|
${CMAKE_CURRENT_LIST_DIR}/include/library/state.hpp
|
|
${CMAKE_CURRENT_LIST_DIR}/include/library/thread_data.hpp
|
|
${CMAKE_CURRENT_LIST_DIR}/include/library/timemory.hpp
|
|
${CMAKE_CURRENT_LIST_DIR}/include/library/components/fwd.hpp
|
|
${CMAKE_CURRENT_LIST_DIR}/include/library/components/backtrace.hpp
|
|
${CMAKE_CURRENT_LIST_DIR}/include/library/components/fork_gotcha.hpp
|
|
${CMAKE_CURRENT_LIST_DIR}/include/library/components/mpi_gotcha.hpp
|
|
${CMAKE_CURRENT_LIST_DIR}/include/library/components/omnitrace.hpp
|
|
${CMAKE_CURRENT_LIST_DIR}/include/library/components/pthread_gotcha.hpp
|
|
${perfetto_DIR}/sdk/perfetto.h)
|
|
|
|
add_library(omnitrace-library SHARED ${library_sources} ${library_headers})
|
|
|
|
if(OMNITRACE_USE_ROCTRACER)
|
|
target_sources(
|
|
omnitrace-library
|
|
PRIVATE
|
|
${CMAKE_CURRENT_LIST_DIR}/src/library/components/roctracer.cpp
|
|
${CMAKE_CURRENT_LIST_DIR}/src/library/components/roctracer_callbacks.cpp
|
|
${CMAKE_CURRENT_LIST_DIR}/include/library/components/roctracer.hpp
|
|
${CMAKE_CURRENT_LIST_DIR}/include/library/components/roctracer_callbacks.hpp)
|
|
endif()
|
|
|
|
target_include_directories(omnitrace-library SYSTEM PRIVATE ${perfetto_DIR}/sdk)
|
|
|
|
target_compile_definitions(
|
|
omnitrace-library
|
|
PRIVATE OMNITRACE_MAX_THREADS=${OMNITRACE_MAX_THREADS}
|
|
$<IF:$<BOOL:${OMNITRACE_CUSTOM_DATA_SOURCE}>,CUSTOM_DATA_SOURCE,>)
|
|
|
|
target_link_libraries(
|
|
omnitrace-library
|
|
PUBLIC $<BUILD_INTERFACE:omnitrace::omnitrace-headers>
|
|
$<BUILD_INTERFACE:omnitrace::omnitrace-threading>
|
|
$<BUILD_INTERFACE:omnitrace::omnitrace-compile-options>
|
|
$<BUILD_INTERFACE:omnitrace::omnitrace-hip>
|
|
$<BUILD_INTERFACE:omnitrace::omnitrace-roctracer>
|
|
$<BUILD_INTERFACE:omnitrace::omnitrace-mpi>
|
|
$<BUILD_INTERFACE:omnitrace::omnitrace-ptl>
|
|
$<BUILD_INTERFACE:timemory::timemory-headers>
|
|
$<BUILD_INTERFACE:timemory::timemory-gotcha>
|
|
$<BUILD_INTERFACE:timemory::timemory-cxx-shared>
|
|
$<IF:$<BOOL:${OMNITRACE_USE_SANITIZER}>,omnitrace::omnitrace-sanitizer,>)
|
|
|
|
if(OMNITRACE_DYNINST_API_RT)
|
|
get_filename_component(OMNITRACE_DYNINST_API_RT_DIR "${OMNITRACE_DYNINST_API_RT}"
|
|
DIRECTORY)
|
|
endif()
|
|
|
|
set_target_properties(
|
|
omnitrace-library
|
|
PROPERTIES OUTPUT_NAME omnitrace
|
|
INSTALL_RPATH
|
|
"\$ORIGIN:\$ORIGIN/timemory/libunwind:\$ORIGIN/dyninst-tpls/libs")
|
|
|
|
install(
|
|
TARGETS omnitrace-library
|
|
DESTINATION ${CMAKE_INSTALL_LIBDIR}
|
|
OPTIONAL)
|
|
|
|
# ------------------------------------------------------------------------------#
|
|
#
|
|
# omnitrace-avail target
|
|
#
|
|
# ------------------------------------------------------------------------------#
|
|
|
|
add_executable(omnitrace-avail ${CMAKE_CURRENT_LIST_DIR}/src/avail.cpp
|
|
${CMAKE_CURRENT_LIST_DIR}/include/avail.hpp)
|
|
|
|
target_include_directories(omnitrace-avail PRIVATE ${CMAKE_CURRENT_LIST_DIR}/include)
|
|
target_compile_definitions(omnitrace-avail PRIVATE OMNITRACE_EXTERN_COMPONENTS=0)
|
|
target_link_libraries(omnitrace-avail PRIVATE omnitrace-library)
|
|
set_target_properties(omnitrace-avail PROPERTIES INSTALL_RPATH_USE_LINK_PATH ON)
|
|
|
|
install(
|
|
TARGETS omnitrace-avail
|
|
DESTINATION bin
|
|
OPTIONAL)
|
|
|
|
# ------------------------------------------------------------------------------#
|
|
#
|
|
# omnitrace-exe target
|
|
#
|
|
# ------------------------------------------------------------------------------#
|
|
|
|
add_executable(
|
|
omnitrace-exe
|
|
${_EXCLUDE} ${CMAKE_CURRENT_LIST_DIR}/src/omnitrace.cpp
|
|
${CMAKE_CURRENT_LIST_DIR}/include/omnitrace.hpp
|
|
${CMAKE_CURRENT_LIST_DIR}/src/omnitrace/details.cpp)
|
|
|
|
target_link_libraries(
|
|
omnitrace-exe
|
|
PRIVATE omnitrace::omnitrace-headers
|
|
omnitrace::omnitrace-dyninst
|
|
omnitrace::omnitrace-compile-options
|
|
$<BUILD_INTERFACE:timemory::timemory-headers>
|
|
$<IF:$<BOOL:${OMNITRACE_USE_SANITIZER}>,omnitrace::omnitrace-sanitizer,>)
|
|
|
|
set_target_properties(
|
|
omnitrace-exe
|
|
PROPERTIES
|
|
OUTPUT_NAME omnitrace
|
|
INSTALL_RPATH_USE_LINK_PATH ON
|
|
INSTALL_RPATH
|
|
"\$ORIGIN/../${CMAKE_INSTALL_LIBDIR}:\$ORIGIN/../${CMAKE_INSTALL_LIBDIR}/timemory/libunwind:\$ORIGIN/../${CMAKE_INSTALL_LIBDIR}/dyninst-tpls/lib"
|
|
)
|
|
|
|
install(
|
|
TARGETS omnitrace-exe
|
|
DESTINATION ${CMAKE_INSTALL_BINDIR}
|
|
OPTIONAL)
|
|
|
|
# ------------------------------------------------------------------------------#
|
|
#
|
|
# miscellaneous installs
|
|
#
|
|
# ------------------------------------------------------------------------------#
|
|
|
|
configure_file(${PROJECT_SOURCE_DIR}/scripts/setup-env.sh.in
|
|
${PROJECT_BINARY_DIR}/scripts/setup-env.sh @ONLY)
|
|
|
|
install(
|
|
PROGRAMS ${PROJECT_SOURCE_DIR}/scripts/omnitrace-merge.jl
|
|
DESTINATION ${CMAKE_INSTALL_BINDIR}
|
|
OPTIONAL)
|
|
|
|
install(
|
|
FILES ${PROJECT_SOURCE_DIR}/roctrace.cfg
|
|
DESTINATION ${CMAKE_INSTALL_DATAROOTDIR}/${PROJECT_NAME}
|
|
OPTIONAL)
|
|
|
|
install(
|
|
FILES ${PROJECT_BINARY_DIR}/scripts/setup-env.sh
|
|
DESTINATION ${CMAKE_INSTALL_DATAROOTDIR}/${PROJECT_NAME}
|
|
OPTIONAL)
|
|
|
|
# ------------------------------------------------------------------------------#
|
|
#
|
|
# examples
|
|
#
|
|
# ------------------------------------------------------------------------------#
|
|
|
|
if(OMNITRACE_BUILD_TESTING)
|
|
add_subdirectory(examples)
|
|
endif()
|
|
|
|
# ------------------------------------------------------------------------------#
|
|
#
|
|
# tests
|
|
#
|
|
# ------------------------------------------------------------------------------#
|
|
|
|
if(OMNITRACE_BUILD_TESTING)
|
|
include(CTest)
|
|
enable_testing()
|
|
|
|
add_subdirectory(tests)
|
|
endif()
|
|
|
|
# ------------------------------------------------------------------------------#
|
|
#
|
|
# packaging
|
|
#
|
|
# ------------------------------------------------------------------------------#
|
|
|
|
include(ConfigCPack)
|
|
|
|
# ------------------------------------------------------------------------------#
|
|
#
|
|
# config info
|
|
#
|
|
# ------------------------------------------------------------------------------#
|
|
|
|
omnitrace_print_features()
|