Enable profiling with Tracy profiler (#192)

jeongseok-meta · facebook-github-bot · commit e87f7acdd4c9 · 2025-02-01T22:05:08.000-08:00
Summary: This PR adds support for profiling using [Tracy](https://github.com/wolfpld/tracy). - Add CMake option, `MOMENTUM_ENABLE_PROFILING`, to enable/disable building with profiling annotations - Add CMake option, `MOMENTUM_USE_SYSTEM_TRACY`, to choose whether to use Tracy from system or fetching from the repo. - Add profile annotation macros for Tracy (currently incomplete) ## Checklist: - [x] Adheres to the [style guidelines](https://facebookincubator.github.io/momentum/docs/developer_guide/style_guide) - [x] Codebase formatted by running `pixi run lint` Pull Request resolved: #192 Test Plan: ``` # Console 1: Open Tracy GUI window pixi run tracy # Console 2: Run executable to profile. For example: pixi build test pixi shell ./build/default/cpp/release/character_solver_test ``` <img width="1271" alt="image" src="https://github.com/user-attachments/assets/1ba9a4db-237f-4cdd-aa03-eae59df76432" /> Reviewed By: yutingye Differential Revision: D68994492 Pulled By: jeongseok-meta fbshipit-source-id: 92a156641a9c4367585dcd2b5ed6e338aa79a34d
diff --git a/CMakeLists.txt b/CMakeLists.txt
@@ -63,10 +63,21 @@ mt_option(MOMENTUM_BUILD_IO_FBX "Build with IO FBX" OFF)
 mt_option(MOMENTUM_BUILD_PYMOMENTUM "Build Python binding" OFF)
 mt_option(MOMENTUM_BUILD_TESTING "Enable building tests" OFF)
 mt_option(MOMENTUM_BUILD_EXAMPLES "Enable building examples" OFF)
+mt_option(MOMENTUM_ENABLE_PROFILING "Enable building with profiling annotations" OFF)
 mt_option(MOMENTUM_ENABLE_SIMD "Enable building with SIMD instructions" ON)
 mt_option(MOMENTUM_USE_SYSTEM_GOOGLETEST "Use GoogleTest installed in system" OFF)
 mt_option(MOMENTUM_USE_SYSTEM_PYBIND11 "Use pybind11 installed in system" OFF)
 mt_option(MOMENTUM_USE_SYSTEM_RERUN_CPP_SDK "Use Rerun C++ SDK installed in system" OFF)
+mt_option(MOMENTUM_USE_SYSTEM_TRACY "Use Tracy installed in system" OFF)
+
+if(MOMENTUM_ENABLE_PROFILING AND CMAKE_SYSTEM_NAME STREQUAL "Darwin" AND CMAKE_SYSTEM_PROCESSOR STREQUAL "x86_64")
+  # Force disable profiling on Mac x86 to avoid initialization failure:
+  # "Tracy Profiler initialization failure: CPU doesn't support invariant TSC."
+  # Defining TRACY_NO_INVARIANT_CHECK=1 or TRACY_TIMER_FALLBACK is not recommended,
+  # as it may lead to inaccurate profiling results.
+  message(WARNING "MOMENTUM_ENABLE_PROFILING was set to ON, but Tracy profiling is not supported on Mac x86 due to CPU incompatibility. Disabling profiling.")
+  set(MOMENTUM_ENABLE_PROFILING OFF CACHE BOOL "Enable building with profiling annotations" FORCE)
+endif()
 
 mt_print_options()
 
@@ -88,6 +99,7 @@ find_package(nlohmann_json CONFIG REQUIRED)
 find_package(openfbx CONFIG REQUIRED)
 find_package(re2 MODULE REQUIRED)
 find_package(spdlog CONFIG REQUIRED)
+
 if(MOMENTUM_USE_SYSTEM_RERUN_CPP_SDK)
   find_package(rerun_sdk CONFIG REQUIRED)
 else()
@@ -98,6 +110,26 @@ else()
   FetchContent_MakeAvailable(rerun_sdk)
 endif()
 
+if(MOMENTUM_ENABLE_PROFILING)
+  if(MOMENTUM_USE_SYSTEM_TRACY)
+    find_package(Tracy CONFIG REQUIRED)
+  else()
+    include(FetchContent)
+    FetchContent_Declare(tracy
+      GIT_REPOSITORY https://github.com/wolfpld/tracy.git
+      GIT_TAG v0.11.1
+      GIT_SHALLOW TRUE
+      GIT_PROGRESS TRUE
+    )
+    FetchContent_MakeAvailable(tracy)
+    if(MSVC)
+      target_compile_options(TracyClient PRIVATE /W0)
+    else()
+      target_compile_options(TracyClient PRIVATE -w)
+    endif()
+  endif()
+endif()
+
 # 1st party
 # TODO: Make Axel as a separate project and change to find_package(axel CONFIG REQUIRED)
 add_subdirectory(axel)
diff --git a/axel/CMakeLists.txt b/axel/CMakeLists.txt
@@ -71,6 +71,11 @@ target_link_libraries(${target_name}
     drjit
 )
 
+if(MOMENTUM_ENABLE_PROFILING)
+  target_link_libraries(${target_name} PUBLIC Tracy::TracyClient)
+  target_compile_definitions(${target_name} PUBLIC -DAXEL_WITH_TRACY_PROFILER=1)
+endif()
+
 #===============================================================================
 # Install axel
 #===============================================================================
diff --git a/axel/axel-config.cmake.in b/axel/axel-config.cmake.in
@@ -12,6 +12,10 @@ find_dependency(Eigen3 3.4.0 CONFIG)
 find_dependency(Microsoft.GSL CONFIG)
 find_dependency(Dispenso CONFIG)
 
+if(@MOMENTUM_ENABLE_PROFILING@)
+  find_dependency(Tracy CONFIG)
+endif()
+
 include("${CMAKE_CURRENT_LIST_DIR}/@PROJECT_NAME@Targets.cmake")
 
 check_required_components("@PROJECT_NAME@")
diff --git a/axel/axel/Profile.h b/axel/axel/Profile.h
@@ -7,10 +7,45 @@
 
 #pragma once
 
-#if defined(AXEL_WITH_XR_PROFILE)
+#if defined(AXEL_WITH_XR_PROFILER)
 
 #include <arvr/libraries/profile_redirect/annotate.hpp>
 
+#elif defined(AXEL_WITH_TRACY_PROFILER)
+
+#include <tracy/Tracy.hpp>
+#include <tracy/TracyC.h>
+#include <stack>
+
+#define _XR_PROFILE_CONCATENATE_DETAIL(x, y) x##y
+#define _XR_PROFILE_CONCATENATE(x, y) _XR_PROFILE_CONCATENATE_DETAIL(x, y)
+#define _XR_PROFILE_MAKE_UNIQUE(x) _XR_PROFILE_CONCATENATE(x, __LINE__)
+
+#define XR_PROFILE_FUNCTION() ZoneScoped
+#define XR_PROFILE_FUNCTION_CATEGORY(CATEGORY)
+#define XR_PROFILE_EVENT(NAME) ZoneNamedN(_XR_PROFILE_MAKE_UNIQUE(__tracy), NAME, true)
+#define XR_PROFILE_EVENT_DYNAMIC(NAME) ZoneTransientN(_XR_PROFILE_MAKE_UNIQUE(__tracy), NAME, true)
+#define XR_PROFILE_CATEGORY(NAME, CATEGORY)
+#define XR_PROFILE_PREPARE_PUSH_POP() std::stack<TracyCZoneCtx> ___tracy_xr_stack
+#define XR_PROFILE_PUSH(NAME)                                                                    \
+  static const struct ___tracy_source_location_data TracyConcat(                                 \
+      __tracy_source_location, TracyLine) = {NAME, __func__, TracyFile, (uint32_t)TracyLine, 0}; \
+  ___tracy_xr_stack.push(                                                                        \
+      ___tracy_emit_zone_begin(&TracyConcat(__tracy_source_location, TracyLine), true));
+#define XR_PROFILE_POP()                  \
+  TracyCZoneEnd(___tracy_xr_stack.top()); \
+  ___tracy_xr_stack.pop()
+#define XR_PROFILE_THREAD(THREAD_NAME)           \
+  {                                              \
+    /* support both std::string and c strings */ \
+    std::string threadNameStr(THREAD_NAME);      \
+    TracyCSetThreadName(threadNameStr.c_str());  \
+  }
+#define XR_PROFILE_UPDATE()
+#define XR_PROFILE_BEGIN_FRAME() FrameMark
+#define XR_PROFILE_END_FRAME()
+#define XR_PROFILE_METADATA(NAME, DATA)
+
 #else
 
 #define XR_PROFILE_FUNCTION()
diff --git a/cmake/momentum-config.cmake.in b/cmake/momentum-config.cmake.in
@@ -26,6 +26,10 @@ find_dependency(openfbx CONFIG)
 find_dependency(re2 MODULE)
 find_dependency(spdlog CONFIG)
 
+if(@MOMENTUM_ENABLE_PROFILING@)
+  find_dependency(Tracy CONFIG)
+endif()
+
 list(REMOVE_AT CMAKE_MODULE_PATH -1)
 
 include("${CMAKE_CURRENT_LIST_DIR}/@PROJECT_NAME@Targets.cmake")
diff --git a/cmake/mt_defs.cmake b/cmake/mt_defs.cmake
@@ -243,8 +243,15 @@ function(mt_library)
   )
   target_include_directories(${_ARG_NAME} ${private_or_interface} ${_ARG_PRIVATE_INCLUDE_DIRECTORIES})
   target_compile_features(${_ARG_NAME} ${public_or_interface} cxx_std_17)
+
   target_link_libraries(${_ARG_NAME} ${public_or_interface} ${_ARG_PUBLIC_LINK_LIBRARIES})
   target_link_libraries(${_ARG_NAME} ${private_or_interface} ${_ARG_PRIVATE_LINK_LIBRARIES})
+
+  if(MOMENTUM_ENABLE_PROFILING)
+    target_link_libraries(${_ARG_NAME} ${public_or_interface} Tracy::TracyClient)
+    target_compile_definitions(${_ARG_NAME} ${public_or_interface} -DMOMENTUM_WITH_TRACY_PROFILER=1)
+  endif()
+
   set_target_properties(${_ARG_NAME} PROPERTIES
     OUTPUT_NAME momentum_${_ARG_NAME}
     POSITION_INDEPENDENT_CODE ON
diff --git a/momentum/common/profile.h b/momentum/common/profile.h
@@ -7,7 +7,7 @@
 
 #pragma once
 
-#if defined(MOMENTUM_WITH_XR_PROFILE)
+#if defined(MOMENTUM_WITH_XR_PROFILER)
 
 #include <arvr/libraries/profile_redirect/annotate.hpp>
 
@@ -25,6 +25,41 @@
 #define MT_PROFILE_END_FRAME() XR_PROFILE_END_FRAME()
 #define MT_PROFILE_METADATA(NAME, DATA) XR_PROFILE_METADATA(NAME, DATA)
 
+#elif defined(MOMENTUM_WITH_TRACY_PROFILER)
+
+#include <tracy/Tracy.hpp>
+#include <tracy/TracyC.h>
+#include <stack>
+
+#define _MT_PROFILE_CONCATENATE_DETAIL(x, y) x##y
+#define _MT_PROFILE_CONCATENATE(x, y) _MT_PROFILE_CONCATENATE_DETAIL(x, y)
+#define _MT_PROFILE_MAKE_UNIQUE(x) _MT_PROFILE_CONCATENATE(x, __LINE__)
+
+#define MT_PROFILE_FUNCTION() ZoneScoped
+#define MT_PROFILE_FUNCTION_CATEGORY(CATEGORY)
+#define MT_PROFILE_EVENT(NAME) ZoneNamedN(_MT_PROFILE_MAKE_UNIQUE(__tracy), NAME, true)
+#define MT_PROFILE_EVENT_DYNAMIC(NAME) ZoneTransientN(_MT_PROFILE_MAKE_UNIQUE(__tracy), NAME, true)
+#define MT_PROFILE_CATEGORY(NAME, CATEGORY)
+#define MT_PROFILE_PREPARE_PUSH_POP() std::stack<TracyCZoneCtx> ___tracy_xr_stack
+#define MT_PROFILE_PUSH(NAME)                                                                    \
+  static const struct ___tracy_source_location_data TracyConcat(                                 \
+      __tracy_source_location, TracyLine) = {NAME, __func__, TracyFile, (uint32_t)TracyLine, 0}; \
+  ___tracy_xr_stack.push(                                                                        \
+      ___tracy_emit_zone_begin(&TracyConcat(__tracy_source_location, TracyLine), true));
+#define MT_PROFILE_POP()                  \
+  TracyCZoneEnd(___tracy_xr_stack.top()); \
+  ___tracy_xr_stack.pop()
+#define MT_PROFILE_THREAD(THREAD_NAME)           \
+  {                                              \
+    /* support both std::string and c strings */ \
+    std::string threadNameStr(THREAD_NAME);      \
+    TracyCSetThreadName(threadNameStr.c_str());  \
+  }
+#define MT_PROFILE_UPDATE()
+#define MT_PROFILE_BEGIN_FRAME() FrameMark
+#define MT_PROFILE_END_FRAME()
+#define MT_PROFILE_METADATA(NAME, DATA)
+
 #else
 
 #define MT_PROFILE_FUNCTION()
diff --git a/pixi.lock b/pixi.lock
diff --git a/pixi.toml b/pixi.toml
