Support for Tracy profiler

Author: zach2good

.gitignore

@@ -197,3 +197,6 @@ cmake_install.cmake
 /conf/search_server.conf
 /conf/server_message.conf
 /conf/server_message_fr.conf
+
+# Tracy download
+tracy/

CMakeLists.txt

@@ -13,6 +13,7 @@ include(StandardProjectSettings)
 include(CompilerWarnings)
 include(Sanitizers)
 include(ClangTidy)
+include(Tracy)
 
 message(STATUS "CMAKE_VERSION: ${CMAKE_VERSION}")
 message(STATUS "CMAKE_BUILD_TYPE: ${CMAKE_BUILD_TYPE}")

CMakeSettings.json

@@ -47,6 +47,30 @@
       "ctestCommandArgs": "",
       "inheritEnvironments": [ "msvc_x64_x64" ],
       "variables": []
+    },
+    {
+      "name": "x64-Debug-Tracy",
+      "generator": "Ninja",
+      "configurationType": "Debug",
+      "buildRoot": "${projectDir}\\out\\build\\${name}",
+      "installRoot": "${projectDir}\\out\\install\\${name}",
+      "cmakeCommandArgs": "-DMYSQL_INCLUDE_DIR=${projectDir}\\ext\\include\\mysql -DMYSQL_LIBRARY=${projectDir}\\ext\\lib64\\libmariadb64.lib -DTRACY_ENABLE=ON",
+      "buildCommandArgs": "",
+      "ctestCommandArgs": "",
+      "inheritEnvironments": [ "msvc_x64_x64" ],
+      "variables": []
+    },
+    {
+      "name": "x64-Release-Tracy",
+      "generator": "Ninja",
+      "configurationType": "RelWithDebInfo",
+      "buildRoot": "${projectDir}\\out\\build\\${name}",
+      "installRoot": "${projectDir}\\out\\install\\${name}",
+      "cmakeCommandArgs": "-DMYSQL_INCLUDE_DIR=${projectDir}\\ext\\include\\mysql -DMYSQL_LIBRARY=${projectDir}\\ext\\lib64\\libmariadb64.lib -DTRACY_ENABLE=ON",
+      "buildCommandArgs": "",
+      "ctestCommandArgs": "",
+      "inheritEnvironments": [ "msvc_x64_x64" ],
+      "variables": []
     }
   ]
 }

cmake/StandardProjectSettings.cmake

@@ -66,7 +66,7 @@ if(MSVC)
 endif()
 
 if(UNIX)
-
+    link_libraries(dl)
 endif()
 
 # TODO: These should be applied on a per-target level, not globally like this!

cmake/Tracy.cmake

@@ -0,0 +1,27 @@
+# Enable on command-line with 'cmake -DTRACY_ENABLE=ON ..'
+
+option(TRACY_ENABLE "Enable Tracy profiling." OFF)
+message(STATUS "TRACY_ENABLE: ${TRACY_ENABLE}")
+
+if(TRACY_ENABLE)
+    set(TRACY_LINK https://github.com/wolfpld/tracy/archive/v0.7.3.tar.gz)
+    if(NOT EXISTS ${CMAKE_SOURCE_DIR}/tracy/tracy-0.7.3/TracyClient.cpp)
+        file(MAKE_DIRECTORY ${CMAKE_SOURCE_DIR}/tracy)
+        file(DOWNLOAD
+                ${TRACY_LINK}
+                ${CMAKE_SOURCE_DIR}/tracy/tracy.tar.gz
+                TIMEOUT 60
+                SHOW_PROGRESS)
+        execute_process(COMMAND "${CMAKE_COMMAND}" -E
+                tar xf "${CMAKE_SOURCE_DIR}/tracy/tracy.tar.gz"
+                WORKING_DIRECTORY ${CMAKE_SOURCE_DIR}/tracy)
+    endif()
+
+    add_library(tracy_client ${CMAKE_SOURCE_DIR}/tracy/tracy-0.7.3/TracyClient.cpp)
+    target_include_directories(tracy_client PUBLIC ${CMAKE_SOURCE_DIR}/tracy/tracy-0.7.3/)
+    target_compile_definitions(tracy_client PUBLIC TRACY_ENABLE TRACY_ON_DEMAND TRACY_NO_EXIT TRACY_NO_BROADCAST)
+
+    if(MSVC AND CMAKE_SIZEOF_VOID_P EQUAL 4)
+        set(CMAKE_EXE_LINKER_FLAGS "${CMAKE_EXE_LINKER_FLAGS} /LARGEADDRESSAWARE")
+    endif()
+endif(TRACY_ENABLE)

src/common/CMakeLists.txt

@@ -43,4 +43,7 @@ target_link_libraries(
   project_options
   # project_warnings
   )
- 
+ 
+if(TRACY_ENABLE)
+    target_link_libraries(common PUBLIC tracy_client)
+endif(TRACY_ENABLE)

src/common/cbasetypes.h

@@ -48,4 +48,6 @@ using server_clock = std::chrono::system_clock;
 using time_point = server_clock::time_point;
 using duration = server_clock::duration;
 
+#include "tracy.h"
+
 #endif /* _CBASETYPES_H_ */

src/common/showmsg.cpp

@@ -687,6 +687,10 @@ int _vShowMessage(MSGTYPE flag, const std::string& string)
         }
     }
 
+#ifdef TRACY_ENABLE
+    TracyMessage(string.c_str(), string.size());
+#endif
+
     return 0;
 }
 void ClearScreen(void)

src/common/tracy.h

@@ -0,0 +1,46 @@
+#ifndef _TRACY_H
+#define _TRACY_H
+
+#ifdef TRACY_ENABLE
+    #include "fmt/format.h"
+    #include "Tracy.hpp"
+
+    #define TracyFrameMark FrameMark
+    #define TracyZoneScoped ZoneScoped
+    #define TracyZoneScopedN(n) ZoneScopedN(n)
+    #define TracyZoneText(n, l) ZoneText(n, l)
+    #define TracyZoneScopedC(c) ZoneScopedC(c)
+    #define TracyZoneString(str) ZoneText(str.c_str(), str.size())
+    #define TracyZoneCString(cstr) ZoneText(cstr, std::strlen(cstr))
+    #define TracyZoneIString(istr) TracyZoneCString(reinterpret_cast<const char*>(istr))
+
+    inline std::string Hex8ToString(uint8 hex)
+    {
+        return fmt::format("0x{:2X}", hex);
+    }
+
+    inline std::string Hex16ToString(uint16 hex)
+    {
+        return fmt::format("0x{:4X}", hex);
+    }
+
+    #define TracyZoneHex8(num) auto str = Hex8ToString(num); TracyZoneText(str.c_str(), str.size());
+    #define TracyZoneHex16(num) auto str = Hex16ToString(num); TracyZoneText(str.c_str(), str.size());
+
+    #define TracyReportLuaMemory(L) TracyPlotConfig("Lua Memory Usage", tracy::PlotFormatType::Memory); TracyPlot("Lua Memory Usage", static_cast<double>(lua_gc(L, LUA_GCCOUNT, 0)) * 1024.0);
+
+#else // Empty stubs for regular builds
+    #define TracyFrameMark
+    #define TracyZoneScoped
+    #define TracyZoneScopedN(n)
+    #define TracyZoneText(n, l)
+    #define TracyZoneScopedC(c)
+    #define TracyZoneString(str)
+    #define TracyZoneCString(cstr)
+    #define TracyZoneIString(istr)
+    #define TracyZoneHex8(num)
+    #define TracyZoneHex16(num)
+    #define TracyReportLuaMemory(L)
+#endif
+
+#endif // _TRACY_H

src/map/CMakeLists.txt

@@ -145,6 +145,10 @@ target_link_libraries(topaz_game
     #project_warnings
 )
 
+if(TRACY_ENABLE)
+    target_link_libraries(topaz_game PUBLIC tracy_client)
+endif(TRACY_ENABLE)
+
 if(APPLE)
     link_options(topaz_game PUBLIC -pagezero_size 10000 -image_base 100000000)
 endif()

src/map/ai/ai_container.cpp

@@ -334,6 +334,7 @@ void CAIContainer::Reset()
 
 void CAIContainer::Tick(time_point _tick)
 {
+    TracyZoneScoped;
     m_PrevTick = m_Tick;
     m_Tick = _tick;