From b6b1eed1d5a33801400b1742088b3baae8cf71f2 Mon Sep 17 00:00:00 2001 From: Bartosz Taudul Date: Tue, 31 Mar 2026 21:27:08 +0200 Subject: [PATCH] Externalize option setting macros. Add one for non-booleans. --- CMakeLists.txt | 85 +++++++++++++++++++++++---------------------- cmake/options.cmake | 25 +++++++++++++ 2 files changed, 69 insertions(+), 41 deletions(-) create mode 100644 cmake/options.cmake diff --git a/CMakeLists.txt b/CMakeLists.txt index cfbfad50..9b2cfbb5 100644 --- a/CMakeLists.txt +++ b/CMakeLists.txt @@ -105,59 +105,62 @@ if(TRACY_Fortran) add_library(Tracy::TracyClient_Fortran ALIAS TracyClientF90) endif() -macro(set_option option help value) - option(${option} ${help} ${value}) +include(cmake/options.cmake) + +# Local wrapper that also sets compile definitions for TracyClient +macro(tracy_set_option option help value) + set_option(${option} "${help}" ${value}) if(${option}) - message(STATUS "${option}: ON") target_compile_definitions(TracyClient PUBLIC ${option}) - else() - message(STATUS "${option}: OFF") endif() endmacro() -set_option(TRACY_ENABLE "Enable profiling" ON) -set_option(TRACY_ON_DEMAND "On-demand profiling" OFF) -set(TRACY_CALLSTACK "" CACHE STRING "Override the callstack collection depth for tracy zones") -set_option(TRACY_NO_CALLSTACK "Disable all callstack related functionality" OFF) -set_option(TRACY_NO_CALLSTACK_INLINES "Disables the inline functions in callstacks" OFF) -set_option(TRACY_ONLY_LOCALHOST "Only listen on the localhost interface" OFF) -set_option(TRACY_NO_BROADCAST "Disable client discovery by broadcast to local network" OFF) -set_option(TRACY_ONLY_IPV4 "Tracy will only accept connections on IPv4 addresses (disable IPv6)" OFF) -set_option(TRACY_NO_CODE_TRANSFER "Disable collection of source code" OFF) -set_option(TRACY_NO_CONTEXT_SWITCH "Disable capture of context switches" OFF) -set_option(TRACY_NO_EXIT "Client executable does not exit until all profile data is sent to server" OFF) -set_option(TRACY_NO_SAMPLING "Disable call stack sampling" OFF) -set_option(TRACY_NO_VERIFY "Disable zone validation for C API" OFF) -set_option(TRACY_NO_VSYNC_CAPTURE "Disable capture of hardware Vsync events" OFF) -set_option(TRACY_NO_FRAME_IMAGE "Disable the frame image support and its thread" OFF) -set_option(TRACY_NO_SYSTEM_TRACING "Disable systrace sampling" OFF) -set_option(TRACY_PATCHABLE_NOPSLEDS "Enable nopsleds for efficient patching by system-level tools (e.g. rr)" OFF) -set_option(TRACY_DELAYED_INIT "Enable delayed initialization of the library (init on first call)" OFF) -set_option(TRACY_MANUAL_LIFETIME "Enable the manual lifetime management of the profile" OFF) -set_option(TRACY_FIBERS "Enable fibers support" OFF) -set_option(TRACY_NO_CRASH_HANDLER "Disable crash handling" OFF) -set_option(TRACY_TIMER_FALLBACK "Use lower resolution timers" OFF) -set_option(TRACY_DISALLOW_HW_TIMER "Disallow hardware timer (may be useful on VMs). Requires TRACY_TIMER_FALLBACK=ON" OFF) -set_option(TRACY_LIBUNWIND_BACKTRACE "Use libunwind backtracing where supported" OFF) -set_option(TRACY_SYMBOL_OFFLINE_RESOLVE "Instead of full runtime symbol resolution, only resolve the image path and offset to enable offline symbol resolution" OFF) -set_option(TRACY_LIBBACKTRACE_ELF_DYNLOAD_SUPPORT "Enable libbacktrace to support dynamically loaded elfs in symbol resolution resolution after the first symbol resolve operation" OFF) -set_option(TRACY_DEBUGINFOD "Enable debuginfod support" OFF) -set_option(TRACY_IGNORE_MEMORY_FAULTS "Ignore instrumentation errors from memory free events that do not have a matching allocation" OFF) +# Local wrapper for value options that also sets compile definitions for TracyClient +macro(tracy_set_option_value var help default) + set_option_value(${var} "${help}" "${default}") + if(${var}) + target_compile_definitions(TracyClient PUBLIC ${var}=${${var}}) + endif() +endmacro() -if(TRACY_CALLSTACK) - message(STATUS "TRACY_CALLSTACK: ${TRACY_CALLSTACK}") - target_compile_definitions(TracyClient PUBLIC TRACY_CALLSTACK=${TRACY_CALLSTACK}) -endif() +tracy_set_option(TRACY_ENABLE "Enable profiling" ON) +tracy_set_option(TRACY_ON_DEMAND "On-demand profiling" OFF) +tracy_set_option_value(TRACY_CALLSTACK "Override the callstack collection depth for tracy zones" "") +tracy_set_option(TRACY_NO_CALLSTACK "Disable all callstack related functionality" OFF) +tracy_set_option(TRACY_NO_CALLSTACK_INLINES "Disables the inline functions in callstacks" OFF) +tracy_set_option(TRACY_ONLY_LOCALHOST "Only listen on the localhost interface" OFF) +tracy_set_option(TRACY_NO_BROADCAST "Disable client discovery by broadcast to local network" OFF) +tracy_set_option(TRACY_ONLY_IPV4 "Tracy will only accept connections on IPv4 addresses (disable IPv6)" OFF) +tracy_set_option(TRACY_NO_CODE_TRANSFER "Disable collection of source code" OFF) +tracy_set_option(TRACY_NO_CONTEXT_SWITCH "Disable capture of context switches" OFF) +tracy_set_option(TRACY_NO_EXIT "Client executable does not exit until all profile data is sent to server" OFF) +tracy_set_option(TRACY_NO_SAMPLING "Disable call stack sampling" OFF) +tracy_set_option(TRACY_NO_VERIFY "Disable zone validation for C API" OFF) +tracy_set_option(TRACY_NO_VSYNC_CAPTURE "Disable capture of hardware Vsync events" OFF) +tracy_set_option(TRACY_NO_FRAME_IMAGE "Disable the frame image support and its thread" OFF) +tracy_set_option(TRACY_NO_SYSTEM_TRACING "Disable systrace sampling" OFF) +tracy_set_option(TRACY_PATCHABLE_NOPSLEDS "Enable nopsleds for efficient patching by system-level tools (e.g. rr)" OFF) +tracy_set_option(TRACY_DELAYED_INIT "Enable delayed initialization of the library (init on first call)" OFF) +tracy_set_option(TRACY_MANUAL_LIFETIME "Enable the manual lifetime management of the profile" OFF) +tracy_set_option(TRACY_FIBERS "Enable fibers support" OFF) +tracy_set_option(TRACY_NO_CRASH_HANDLER "Disable crash handling" OFF) +tracy_set_option(TRACY_TIMER_FALLBACK "Use lower resolution timers" OFF) +tracy_set_option(TRACY_DISALLOW_HW_TIMER "Disallow hardware timer (may be useful on VMs). Requires TRACY_TIMER_FALLBACK=ON" OFF) +tracy_set_option(TRACY_LIBUNWIND_BACKTRACE "Use libunwind backtracing where supported" OFF) +tracy_set_option(TRACY_SYMBOL_OFFLINE_RESOLVE "Instead of full runtime symbol resolution, only resolve the image path and offset to enable offline symbol resolution" OFF) +tracy_set_option(TRACY_LIBBACKTRACE_ELF_DYNLOAD_SUPPORT "Enable libbacktrace to support dynamically loaded elfs in symbol resolution resolution after the first symbol resolve operation" OFF) +tracy_set_option(TRACY_DEBUGINFOD "Enable debuginfod support" OFF) +tracy_set_option(TRACY_IGNORE_MEMORY_FAULTS "Ignore instrumentation errors from memory free events that do not have a matching allocation" OFF) # advanced -set_option(TRACY_VERBOSE "[advanced] Verbose output from the profiler" OFF) +tracy_set_option(TRACY_VERBOSE "[advanced] Verbose output from the profiler" OFF) mark_as_advanced(TRACY_VERBOSE) -set_option(TRACY_NO_INTERNAL_MESSAGE "[advanced] Prevent the profiler from logging messages" OFF) +tracy_set_option(TRACY_NO_INTERNAL_MESSAGE "[advanced] Prevent the profiler from logging messages" OFF) mark_as_advanced(TRACY_NO_INTERNAL_MESSAGE) -set_option(TRACY_DEMANGLE "[advanced] Don't use default demangling function - You'll need to provide your own" OFF) +tracy_set_option(TRACY_DEMANGLE "[advanced] Don't use default demangling function - You'll need to provide your own" OFF) mark_as_advanced(TRACY_DEMANGLE) if(rocprofiler-sdk_FOUND) - set_option(TRACY_ROCPROF_CALIBRATION "[advanced] Use continuous calibration of the Rocprof GPU time." OFF) + tracy_set_option(TRACY_ROCPROF_CALIBRATION "[advanced] Use continuous calibration of the Rocprof GPU time." OFF) mark_as_advanced(TRACY_ROCPROF_CALIBRATION) endif() diff --git a/cmake/options.cmake b/cmake/options.cmake new file mode 100644 index 00000000..a361bc89 --- /dev/null +++ b/cmake/options.cmake @@ -0,0 +1,25 @@ +# Reusable option macros for CMake projects +# +# Usage: +# set_option(OPTION_NAME "Help text" ON/OFF) - for boolean options +# set_option_value(VAR_NAME "Help text" "value") - for value options (CACHE STRING) + +# Boolean options (ON/OFF) +macro(set_option option help value) + option(${option} ${help} ${value}) + if(${option}) + message(STATUS "${option}: ON") + else() + message(STATUS "${option}: OFF") + endif() +endmacro() + +# Value options (strings, numbers, etc.) +macro(set_option_value var help default) + set(${var} ${default} CACHE STRING "${help}") + if(${var}) + message(STATUS "${var}: ${${var}}") + else() + message(STATUS "${var}: (not set)") + endif() +endmacro()