Merge pull request #763 from FunkinCrew/feature/tracy

Add Tracy support for performance profiling

.vscode/settings.json

@@ -96,6 +96,11 @@
       "target": "windows",
       "args": ["-debug", "-DFEATURE_DEBUG_FUNCTIONS"]
     },
+    {
+      "label": "Windows / Debug (Tracy)",
+      "target": "windows",
+      "args": ["-debug", "-DFEATURE_DEBUG_TRACY", "-DFEATURE_DEBUG_FUNCTIONS"]
+    },
     {
       "label": "Linux / Debug",
       "target": "linux",

hmm.json

@@ -98,8 +98,8 @@
       "name": "hxcpp",
       "type": "git",
       "dir": null,
-      "ref": "904ea40643b050a5a154c5e4c33a83fd2aec18b1",
-      "url": "https://github.com/HaxeFoundation/hxcpp"
+      "ref": "c6bac3d6c7d683f25104296b2f4c50f8c90b8349",
+      "url": "https://github.com/cortex-engine/hxcpp"
     },
     {
       "name": "hxcpp-debug-server",

project.hxp

@@ -149,6 +149,21 @@ class Project extends HXProject {
 	 */
 	static final FEATURE_DEBUG_FUNCTIONS:FeatureFlag = "FEATURE_DEBUG_FUNCTIONS";
 
+	/**
+	 * `-DFEATURE_DEBUG_TRACY`
+	 * If this flag is enabled, the game will have the necessary hooks for the Tracy profiler.
+	 * Only enable this if you're using the correct fork of Haxe to support this.
+	 * @see https://github.com/HaxeFoundation/hxcpp/pull/1153
+	 */
+	static final FEATURE_DEBUG_TRACY:FeatureFlag = "FEATURE_DEBUG_TRACY";
+
+	/**
+	 * `-DFEATURE_LOG_TRACE`
+	 * If this flag is enabled, the game will print debug traces to the console.
+	 * Disable to improve performance a bunch.
+	 */
+	static final FEATURE_LOG_TRACE:FeatureFlag = "FEATURE_LOG_TRACE";
+
 	/**
 	 * `-DFEATURE_DISCORD_RPC`
 	 * If this flag is enabled, the game will enable the Discord Remote Procedure Call library.
@@ -453,6 +468,7 @@ class Project extends HXProject {
 
 		// Should be true on debug builds or if GITHUB_BUILD is enabled.
 		FEATURE_DEBUG_FUNCTIONS.apply(this, isDebug() || GITHUB_BUILD.isEnabled(this));
+		FEATURE_LOG_TRACE.apply(this, isDebug());
 
 		// Should default to true on workspace builds and false on release builds.
 		REDIRECT_ASSETS_FOLDER.apply(this, isDebug() && isDesktop());
@@ -516,6 +532,16 @@ class Project extends HXProject {
 
 		// Cleaner looking compiler errors.
 		setHaxedef("message.reporting", "pretty");
+
+		if (FEATURE_DEBUG_TRACY.isEnabled(this)) {
+			setHaxedef("HXCPP_TELEMETRY"); // Enable telemetry
+			setHaxedef("HXCPP_TRACY"); // Enable Tracy telemetry
+			setHaxedef("HXCPP_TRACY_MEMORY"); // Track memory allocations
+			// setHaxedef("HXCPP_TRACY_ON_DEMAND"); // Only collect telemetry when Tracy is open and reachable
+			// setHaxedef("HXCPP_TRACY_INCLUDE_CALLSTACKS"); // Inspect callstacks per zone, inflating telemetry data
+
+			setHaxedef("absolute-paths"); // Fix source locations so Tracy can see them
+		}
   }
 
 	/**

source/cpp/vm/tracy/TracyProfiler.hx

@@ -0,0 +1,102 @@
+/*
+ * Pulled from Tracey profiler PR
+ * @see https://github.com/HaxeFoundation/haxe/pull/11772
+ */
+
+package cpp.vm.tracy;
+
+#if (!HXCPP_TRACY)
+#error "This class cannot be used without -D HXCPP_TRACY"
+#end
+enum abstract PlotFormatType(cpp.UInt8) from cpp.UInt8 to cpp.UInt8
+{
+  var Number = 0;
+  var Memory = 1;
+  var Percentage = 2;
+}
+
+@:include('hx/TelemetryTracy.h')
+extern class Native_TracyProfiler
+{
+  /**
+    Mark a frame. Call this at the end of each frame loop.
+  **/
+  @:native('::__hxcpp_tracy_framemark')
+  public static function frameMark():Void;
+
+  /**
+    Print a message into Tracy's log.
+  **/
+  @:native('::__hxcpp_tracy_message')
+  public static function message(_msg:String, ?_color:Int = 0x000000):Void;
+
+  /**
+    Tracy can collect additional information about the profiled application,
+    which will be available in the trace description.
+    This can include data such as the source repository revision,
+    the application’s environment (dev/prod), etc.
+  **/
+  @:native('::__hxcpp_tracy_message_app_info')
+  public static function messageAppInfo(_info:String):Void;
+
+  /**
+    Plot a named value to tracy. This will generate a graph in the profiler for you.
+  **/
+  @:native('::__hxcpp_tracy_plot')
+  public static function plot(_name:String, _val:cpp.Float32):Void;
+
+  /**
+    Configure how values are plotted and displayed.
+  **/
+  @:native('::__hxcpp_tracy_plot_config')
+  public static function plotConfig(_name:String, _format:PlotFormatType, ?_step:Bool = false, ?_fill:Bool = false, ?_color:Int = 0x000000):Void;
+
+  /**
+    Set a name for the current thread this function is called in. Supply an optional groupHint so threads become grouped in Tracy's UI.
+  **/
+  @:native('::__hxcpp_tracy_set_thread_name_and_group')
+  public static function setThreadName(_name:String, ?_groupHint:Int = 1):Void;
+
+  /**
+    Create a custom named scoped zone in your code.
+  **/
+  @:native('HXCPP_TRACY_ZONE')
+  public static function zoneScoped(_name:String):Void;
+}
+
+#if (scriptable || cppia)
+class Cppia_TracyProfiler
+{
+  @:inheritDoc(cpp.vm.tracy.Native_TracyProfiler.frameMark)
+  public static function frameMark()
+    Native_TracyProfiler.frameMark();
+
+  @:inheritDoc(cpp.vm.tracy.Native_TracyProfiler.message)
+  public static function message(_msg:String, ?_color:Int = 0x000000)
+    Native_TracyProfiler.message(_msg, _color);
+
+  @:inheritDoc(cpp.vm.tracy.Native_TracyProfiler.messageAppInfo)
+  public static function messageAppInfo(_info:String)
+    Native_TracyProfiler.messageAppInfo(_info);
+
+  @:inheritDoc(cpp.vm.tracy.Native_TracyProfiler.plot)
+  public static function plot(_name:String, _val:Float)
+    Native_TracyProfiler.plot(_name, _val);
+
+  @:inheritDoc(cpp.vm.tracy.Native_TracyProfiler.plotConfig)
+  public static function plotConfig(_name:String, _format:PlotFormatType, ?_step:Bool = false, ?_fill:Bool = false, ?_color:Int = 0x000000)
+    Native_TracyProfiler.plotConfig(_name, _format, _step, _fill, _color);
+
+  @:inheritDoc(cpp.vm.tracy.Native_TracyProfiler.setThreadName)
+  public static function setThreadName(_name:String, ?_groupHint:Int = 1)
+    Native_TracyProfiler.setThreadName(_name, _groupHint);
+
+  @:inheritDoc(cpp.vm.tracy.Native_TracyProfiler.zoneScoped)
+  public static function zoneScoped(_name:String)
+    Native_TracyProfiler.zoneScoped(_name);
+}
+
+typedef TracyProfiler = Cppia_TracyProfiler;
+#else
+typedef TracyProfiler = Native_TracyProfiler;
+#end

source/funkin/util/logging/AnsiTrace.hx

@@ -6,7 +6,7 @@ class AnsiTrace
   // but adds nice cute ANSI things
   public static function trace(v:Dynamic, ?info:haxe.PosInfos)
   {
-    #if TREMOVE
+    #if NO_FEATURE_LOG_TRACE
     return;
     #end
     var str = formatOutput(v, info);