feat(profiling): Include Tracy profiler library in the solution (TheSuperHackers#2202)

Author: stephanmeesters

CMakePresets.json

@@ -110,7 +110,8 @@
             "inherits": "win32",
             "displayName": "Windows 32bit Profile",
             "cacheVariables": {
-                "RTS_BUILD_OPTION_PROFILE": "ON"
+                "RTS_BUILD_OPTION_PROFILE": "ON",
+                "RTS_BUILD_OPTION_PROFILE_TRACY": "ON"
             }
         },
         {

Core/CMakeLists.txt

@@ -22,6 +22,7 @@ target_sources(corei_libraries_include PRIVATE
 )
 target_link_libraries(corei_always INTERFACE
     core_config
+    core_profile_tracy
     core_utility
     corei_libraries_include
     resources

Core/Libraries/Include/rts/profile.h

@@ -27,6 +27,43 @@
 // Proxy header for profile module
 //////////////////////////////////////////////////////////////////////////////
 
-#  pragma once
+#pragma once
 
+#if defined(RTS_PROFILE_LEGACY)
 #include "../../Source/profile/profile.h"
+#endif
+
+#if defined(RTS_PROFILE_TRACY)
+
+#include <tracy/Tracy.hpp>
+
+#define PROFILER_ENABLED
+#define PROFILER_FRAME_IMAGE_SIZE 256 // Horizontal size of the frame image in pixels.
+#define PROFILER_FRAME_IMAGE_INTERVAL_MS 500 // Will capture every render frame if set to 0
+#define PROFILER_SECTION ZoneScoped
+#define PROFILER_SECTION_NAME(name) ZoneScopedN(name)
+#define PROFILER_SECTION_COLOR(color) ZoneScopedC(color)
+#define PROFILER_SECTION_NAMECOLOR(name, color) ZoneScopedNC(name, color)
+#define PROFILER_FRAME_MARK FrameMark
+#define PROFILER_FRAME_MARK_NAME(name) FrameMarkNamed(name)
+#define PROFILER_FRAME_IMAGE(image, width, height, offset, flip) FrameImage(image, width, height, offset, flip)
+#define PROFILER_MSG(txt, size) TracyMessage(txt, size)
+#define PROFILER_PLOT(name, value) TracyPlot(name, value)
+#define PROFILER_IS_CONNECTED TracyIsConnected
+
+#else
+
+#define PROFILER_FRAME_IMAGE_SIZE 0
+#define PROFILER_FRAME_IMAGE_INTERVAL_MS 0
+#define PROFILER_SECTION ((void)0)
+#define PROFILER_SECTION_NAME(name) ((void)0)
+#define PROFILER_SECTION_COLOR(color) ((void)0)
+#define PROFILER_SECTION_NAMECOLOR(name, color) ((void)0)
+#define PROFILER_FRAME_MARK ((void)0)
+#define PROFILER_FRAME_MARK_NAME(name) ((void)0)
+#define PROFILER_FRAME_IMAGE(image, width, height, offset, flip) ((void)0)
+#define PROFILER_MSG(txt, size) ((void)0)
+#define PROFILER_PLOT(name, value) ((void)0)
+#define PROFILER_IS_CONNECTED false
+
+#endif

Core/Libraries/Source/debug/debug_debug.cpp

@@ -1498,7 +1498,7 @@ void Debug::WriteBuildInfo()
     (*this) << " internal " << m_intVersion;
   #if defined(RTS_DEBUG)
     operator<<(" debug");
-  #elif defined(RTS_PROFILE_LEGACY)
+  #elif defined(RTS_PROFILE_LEGACY) || defined(RTS_PROFILE_TRACY)
     operator<<(" profile");
   #else
     operator<<(" release");

cmake/config-build.cmake

@@ -4,6 +4,7 @@ option(RTS_BUILD_CORE_EXTRAS "Build core extra tools/tests" OFF)
 option(RTS_BUILD_ZEROHOUR "Build Zero Hour code." ON)
 option(RTS_BUILD_GENERALS "Build Generals code." ON)
 option(RTS_BUILD_OPTION_PROFILE "Build code with the \"Profile\" configuration." OFF)
+option(RTS_BUILD_OPTION_PROFILE_TRACY "Build code with Tracy profiling enabled." OFF)
 option(RTS_BUILD_OPTION_DEBUG "Build code with the \"Debug\" configuration." OFF)
 option(RTS_BUILD_OPTION_ASAN "Build code with Address Sanitizer." OFF)
 option(RTS_BUILD_OPTION_VC6_FULL_DEBUG "Build VC6 with full debug info." OFF)
@@ -75,3 +76,10 @@ endif()
 if(RTS_BUILD_OPTION_PROFILE)
     target_compile_definitions(core_config INTERFACE RTS_PROFILE_LEGACY)
 endif()
+
+# Define a dummy Tracy target when the build option is disabled.
+if(RTS_BUILD_OPTION_PROFILE_TRACY)
+    include(cmake/tracy.cmake)
+else()
+    add_library(core_profile_tracy INTERFACE)
+endif()

cmake/tracy.cmake

@@ -0,0 +1,19 @@
+find_package(Tracy CONFIG QUIET)
+if(NOT Tracy_FOUND)
+    FetchContent_Declare(
+        tracy
+        GIT_REPOSITORY https://github.com/TheSuperHackers/tracy
+        GIT_TAG        05cceee0df3b8d7c6fa87e9638af311dbabc63cb # 0.13.1
+    )
+    FetchContent_MakeAvailable(tracy)
+endif()
+
+if(NOT TARGET TracyClient)
+    message(FATAL_ERROR "Tracy is enabled but TracyClient was not found.")
+endif()
+
+target_compile_definitions(TracyClient INTERFACE
+    RTS_PROFILE_TRACY
+)
+
+add_library(core_profile_tracy ALIAS TracyClient)