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

Author: stephanmeesters

CMakePresets.json

@@ -109,7 +109,8 @@
             "inherits": "win32",
             "displayName": "Windows 32bit Profile",
             "cacheVariables": {
-                "RTS_BUILD_OPTION_PROFILE": "ON"
+                "RTS_BUILD_OPTION_PROFILE": "ON",
+                "RTS_BUILD_OPTION_PROFILE_TRACY": "ON"
             }
         },
         {
@@ -143,7 +144,8 @@
             "inherits": "win32-vcpkg",
             "displayName": "Windows 32bit VCPKG Profile",
             "cacheVariables": {
-                "RTS_BUILD_OPTION_PROFILE": "ON"
+                "RTS_BUILD_OPTION_PROFILE": "ON",
+                "RTS_BUILD_OPTION_PROFILE_TRACY": "ON"
             }
         },
         {
@@ -488,4 +490,4 @@
             ]
         }
     ]
-}
+}

Core/CMakeLists.txt

@@ -31,6 +31,10 @@ target_link_libraries(corei_always_no_pch INTERFACE
     resources
 )
 
+if(RTS_BUILD_OPTION_PROFILE AND RTS_BUILD_OPTION_PROFILE_TRACY)
+    target_link_libraries(corei_libraries_include INTERFACE Tracy::TracyClient)
+endif()
+
 # Set where the build results will end up
 set(CMAKE_RUNTIME_OUTPUT_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR})
 

Core/Libraries/Include/rts/profile.h

@@ -27,6 +27,18 @@
 // Proxy header for profile module
 //////////////////////////////////////////////////////////////////////////////
 
-#  pragma once
+#pragma once
 
+#ifdef TRACY_ENABLE
+#include <tracy/Tracy.hpp>
+#define TRACY_FRAMEIMAGE_SIZE 256
+#else
 #include "../../Source/profile/profile.h"
+#define ZoneScopedN(name) ((void)0)
+#define ZoneScopedNC(name, color) ((void)0)
+#define TracyPlot(name, value) ((void)0)
+#define FrameMark ((void)0)
+#define FrameMarkNamed(name) ((void)0)
+#define FrameImage(image, width, height, offset, flip) ((void)0)
+#define TracyMessage(txt, size) ((void)0)
+#endif

GeneralsMD/Code/GameEngine/CMakeLists.txt

@@ -1169,6 +1169,12 @@ target_link_libraries(z_gameengine PRIVATE
     zi_always
 )
 
+if(RTS_BUILD_OPTION_PROFILE AND RTS_BUILD_OPTION_PROFILE_TRACY)
+    target_link_libraries(z_gameengine PRIVATE
+        Tracy::TracyClient
+    )
+endif()
+
 target_link_libraries(z_gameengine PUBLIC
     corei_gameengine_public
     z_wwvegas

GeneralsMD/Code/GameEngineDevice/CMakeLists.txt

@@ -216,6 +216,11 @@ target_link_libraries(z_gameenginedevice PRIVATE
     zi_always
     zi_main
 )
+if(RTS_BUILD_OPTION_PROFILE AND RTS_BUILD_OPTION_PROFILE_TRACY)
+    target_link_libraries(z_gameenginedevice PRIVATE
+        Tracy::TracyClient
+    )
+endif()
 
 target_link_libraries(z_gameenginedevice PUBLIC
     corei_gameenginedevice_public

GeneralsMD/Code/Main/CMakeLists.txt

@@ -25,6 +25,12 @@ target_link_libraries(z_generals PRIVATE
     zi_always
 )
 
+if(RTS_BUILD_OPTION_PROFILE AND RTS_BUILD_OPTION_PROFILE_TRACY)
+    target_link_libraries(z_generals PRIVATE
+        Tracy::TracyClient
+    )
+endif()
+
 # TODO Originally referred to build host and user, replace with git info perhaps?
 file(WRITE ${CMAKE_CURRENT_BINARY_DIR}/GeneratedVersion.h
 "#pragma once

cmake/config-build.cmake

@@ -8,6 +8,7 @@ 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)
 option(RTS_BUILD_OPTION_FFMPEG "Enable FFmpeg support" OFF)
+option(RTS_BUILD_OPTION_PROFILE_TRACY "Enable Tracy profiling for profile builds." OFF)
 
 if(NOT RTS_BUILD_ZEROHOUR AND NOT RTS_BUILD_GENERALS)
     set(RTS_BUILD_ZEROHOUR TRUE)
@@ -71,5 +72,18 @@ else()
 endif()
 
 if(RTS_BUILD_OPTION_PROFILE)
-    target_compile_definitions(core_config INTERFACE RTS_PROFILE)
+    if(RTS_BUILD_OPTION_PROFILE_TRACY)
+        find_package(Tracy CONFIG QUIET)
+        if(NOT Tracy_FOUND)
+            include(${CMAKE_CURRENT_LIST_DIR}/tracy.cmake)
+        endif()
+        if(NOT TARGET Tracy::TracyClient)
+            message(FATAL_ERROR "Tracy is enabled but Tracy::TracyClient was not found.")
+        endif()
+        target_compile_definitions(core_config INTERFACE
+                TRACY_ENABLE
+        )
+    else ()
+        target_compile_definitions(core_config INTERFACE RTS_PROFILE)
+    endif()
 endif()

cmake/tracy.cmake

@@ -0,0 +1,7 @@
+FetchContent_Declare(
+    tracy
+    GIT_REPOSITORY https://github.com/wolfpld/tracy
+    GIT_TAG        v0.13.1
+)
+
+FetchContent_MakeAvailable(tracy)

vcpkg-lock.json

@@ -42,6 +42,12 @@
             "version-string": "1.3.1",
             "port-version": 0,
             "git-tree": "3f05e04b9aededb96786a911a16193cdb711f0c9"
+        },
+        {
+            "name": "tracy",
+            "version-string": "0.11.1",
+            "port-version": 2,
+            "git-tree": "ff802e1b85c20b5f276c4b82aaa60fc933444ab2"
         }
     ]
 }

vcpkg.json

@@ -3,6 +3,7 @@
     "builtin-baseline": "b02e341c927f16d991edbd915d8ea43eac52096c",
     "dependencies": [
       "zlib",
-      "ffmpeg"
+      "ffmpeg",
+      "tracy"
     ]
-  }
+  }