Tracy

Directory.Packages.props

@@ -1,7 +1,8 @@
 <Project>
-    <Import Project="RobustToolbox/Directory.Packages.props" />
-    <ItemGroup>
-        <PackageVersion Include="NUnit.ConsoleRunner" Version="3.15.0" />
-        <PackageVersion Include="Byond.TopicSender" Version="8.0.1" />
-    </ItemGroup>
+  <Import Project="RobustToolbox/Directory.Packages.props" />
+  <ItemGroup>
+    <PackageVersion Include="NUnit.ConsoleRunner" Version="3.15.0" />
+    <PackageVersion Include="Byond.TopicSender" Version="8.0.1" />
+    <PackageVersion Include="Tracy-CSharp" Version="0.11.1-hotfix" />
+  </ItemGroup>
 </Project>

OpenDreamRuntime/DreamManager.cs

@@ -81,15 +81,17 @@ public void StartWorld() {
             Initialized = true;
             InitializedTick = _gameTiming.CurTick;
 
-            // Call global <init> with waitfor=FALSE
-            _objectTree.GlobalInitProc?.Spawn(WorldInstance, new());
+            using (Profiler.BeginZone("StartWorld", color:(uint)Color.OrangeRed.ToArgb())) {
+                // Call global <init> with waitfor=FALSE
+                _objectTree.GlobalInitProc?.Spawn(WorldInstance, new());
 
-            // Call New() on all /area and /turf that exist, each with waitfor=FALSE separately. If <global init> created any /area, call New a SECOND TIME
-            // new() up /objs and /mobs from compiled-in maps [order: (1,1) then (2,1) then (1,2) then (2,2)]
-            _dreamMapManager.InitializeAtoms(_compiledJson.Maps);
+                // Call New() on all /area and /turf that exist, each with waitfor=FALSE separately. If <global init> created any /area, call New a SECOND TIME
+                // new() up /objs and /mobs from compiled-in maps [order: (1,1) then (2,1) then (1,2) then (2,2)]
+                _dreamMapManager.InitializeAtoms(_compiledJson.Maps);
 
-            // Call world.New()
-            WorldInstance.SpawnProc("New");
+                // Call world.New()
+                WorldInstance.SpawnProc("New");
+            }
         }
 
         public void Shutdown() {
@@ -102,13 +104,26 @@ public void Shutdown() {
         public void Update() {
             if (!Initialized)
                 return;
+            using (Profiler.BeginZone("Tick", color:(uint)Color.OrangeRed.ToArgb()))
+            {
+                using (Profiler.BeginZone("DM Execution", color:(uint)Color.LightPink.ToArgb()))
+                    _procScheduler.Process();
+
+                using (Profiler.BeginZone("Map Update", color:(uint)Color.LightPink.ToArgb())){
+                    UpdateStat();
+                    _dreamMapManager.UpdateTiles();
+                }
+
+                using (Profiler.BeginZone("Disk IO", color:(uint)Color.LightPink.ToArgb()))
+                    DreamObjectSavefile.FlushAllUpdates();
+
+                WorldInstance.SetVariableValue("cpu", WorldInstance.GetVariable("tick_usage"));
+
+                using (Profiler.BeginZone("Deletion Queue", color:(uint)Color.LightPink.ToArgb()))
+                    ProcessDelQueue();
+            }
 
-            _procScheduler.Process();
-            UpdateStat();
-            _dreamMapManager.UpdateTiles();
-            DreamObjectSavefile.FlushAllUpdates();
-            WorldInstance.SetVariableValue("cpu", WorldInstance.GetVariable("tick_usage"));
-            ProcessDelQueue();
+            Profiler.EmitFrameMark();
         }
 
         public void ProcessDelQueue() {

OpenDreamRuntime/DreamThread.cs

@@ -137,7 +137,8 @@ public DMError(string message)
     public abstract class ProcState : IDisposable {
         private static int _idCounter = 0;
         public int Id { get; } = ++_idCounter;
-
+        public abstract (string SourceFile, int Line) TracyLocationId { get; }
+        public ProfilerZone? TracyZoneId { get; set; }
         public DreamThread Thread { get; set; }
 
         [Access(typeof(ProcScheduler))]
@@ -210,7 +211,10 @@ public static DreamValue Run(DreamProc proc, DreamObject src, DreamObject? usr,
             var context = new DreamThread(proc.ToString());
 
             if (proc is NativeProc nativeProc) {
-                return nativeProc.Call(context, src, usr, new(arguments));
+                // ReSharper disable ExplicitCallerInfoArgument
+                using(Profiler.BeginZone(filePath:"Native Proc", lineNumber:0, memberName:nativeProc.Name))
+                    return nativeProc.Call(context, src, usr, new(arguments));
+                // ReSharper restore ExplicitCallerInfoArgument
             }
 
             var state = proc.CreateState(context, src, usr, new DreamProcArguments(arguments));
@@ -252,6 +256,13 @@ public DreamValue ReentrantResume(ProcState? untilState, out ProcStatus resultSt
                 while (_current != null) {
                     ProcStatus status;
                     try {
+                        if (Profiler.IsActivated() && _current.TracyZoneId is null && _current.Proc != null) { //IsActivated() call just for optimisation reasons
+                            var location =_current.TracyLocationId;
+                            var procpath = (_current.Proc.OwningType.Path.Equals("/") ? "/proc/" : _current.Proc.OwningType.Path+"/") +_current.Proc.Name;
+                            // ReSharper disable ExplicitCallerInfoArgument
+                            _current.TracyZoneId = Profiler.BeginZone(filePath: location.SourceFile, lineNumber: location.Line, memberName: procpath);
+                            // ReSharper restore ExplicitCallerInfoArgument
+                        }
                         // _current.Resume may mutate our state!!!
                         status = _current.Resume();
                     } catch (DMError dmError) {
@@ -274,8 +285,18 @@ public DreamValue ReentrantResume(ProcState? untilState, out ProcStatus resultSt
                     switch (status) {
                         // The entire Thread is stopping
                         case ProcStatus.Cancelled:
+                            if (_current.TracyZoneId is not null) {
+                                _current.TracyZoneId.Value.Dispose();
+                                _current.TracyZoneId = null;
+                            }
                             var current = _current;
                             _current = null;
+                            foreach (var s in _stack) {
+                                if (s.TracyZoneId is null)
+                                    continue;
+                                s.TracyZoneId.Value.Dispose();
+                                s.TracyZoneId = null;
+                            }
                             _stack.Clear();
                             resultStatus = status;
                             return current.Result;
@@ -298,6 +319,17 @@ public DreamValue ReentrantResume(ProcState? untilState, out ProcStatus resultSt
 
                         // The context is done executing for now
                         case ProcStatus.Deferred:
+                            if (_current.TracyZoneId is not null) {
+                                _current.TracyZoneId.Value.Dispose();
+                                _current.TracyZoneId = null;
+                            }
+
+                            foreach (var s in _stack) {
+                                if (s.TracyZoneId is null)
+                                    continue;
+                                s.TracyZoneId.Value.Dispose();
+                                s.TracyZoneId = null;
+                            }
                             // We return the current return value here even though it may not be the final result
                             resultStatus = status;
                             return _current.Result;
@@ -334,6 +366,11 @@ public void PushProcState(ProcState state) {
         }
 
         public void PopProcState(bool dispose = true) {
+            if (_current?.TracyZoneId is not null) {
+                _current.TracyZoneId.Value.Dispose();
+                _current.TracyZoneId = null;
+            }
+
             if (_current?.WaitFor == false) {
                 _syncCount--;
             }

OpenDreamRuntime/DreamValue.cs

@@ -65,10 +65,13 @@
 
     private object? _refValue;
     private readonly float _floatValue;
+    //ReSharper disable once NotAccessedField.Local
+    private readonly ProfilerMemory? _tracyMemoryId; //only used for strings, since everything else is a value type or handled in DreamObject
 
     public DreamValue(string value) {
         DebugTools.Assert(value != null);
         Type = DreamValueType.String;
+        _tracyMemoryId = Profiler.BeginMemoryZone((ulong) (1+value.Length*sizeof(char)), "string");
         _refValue = value;
     }
 

OpenDreamRuntime/EntryPoint.cs

@@ -52,6 +52,9 @@ public override void Init() {
                         break;
                     }
 
+            if(_configManager.GetCVar(OpenDreamCVars.TracyEnable))
+                Profiler.ActivateTracy();
+
             _prototypeManager.LoadDirectory(new ResPath("/Resources/Prototypes"));
 
             _serverInfoManager.Initialize();

OpenDreamRuntime/Objects/DreamObject.cs

@@ -17,6 +17,7 @@
 namespace OpenDreamRuntime.Objects {
     [Virtual]
     public class DreamObject {
+        private readonly ProfilerMemory? _tracyMemoryId;
         public DreamObjectDefinition ObjectDefinition;
 
         [Access(typeof(DreamObject))]
@@ -87,6 +88,8 @@ public DreamObject(DreamObjectDefinition objectDefinition) {
             if (this is not DreamObjectAtom && IsSubtypeOf(ObjectTree.Datum)) {
                 ObjectDefinition.DreamManager.Datums.AddLast(new WeakDreamRef(this));
             }
+
+            _tracyMemoryId = Profiler.BeginMemoryZone((ulong)(Unsafe.SizeOf<DreamObject>() + ObjectDefinition.Variables.Count * Unsafe.SizeOf<DreamValue>() ), "/datum");
         }
 
         public virtual void Initialize(DreamProcArguments args) {
@@ -106,6 +109,7 @@ protected virtual void HandleDeletion(bool possiblyThreaded) {
             Variables = null;
 
             ObjectDefinition = null!;
+            _tracyMemoryId?.ReleaseMemory();
         }
 
         /// <summary>
@@ -145,6 +149,7 @@ public void Delete(bool possiblyThreaded = false) {
         }
 
         public bool IsSubtypeOf(TreeEntry ancestor) {
+            if(Deleted) return false;
             return ObjectDefinition.IsSubtypeOf(ancestor);
         }
 

OpenDreamRuntime/Objects/DreamObjectTree.cs

@@ -139,42 +139,44 @@ public IEnumerable<TreeEntry> GetAllDescendants(TreeEntry treeEntry) {
     /// (by calling the result of <see cref="DreamObject.InitProc(DreamThread, DreamObject?, DreamProcArguments)"/> or <see cref="DreamObject.InitSpawn(DreamProcArguments)"/>)
     /// </remarks>
     public DreamObject CreateObject(TreeEntry type) {
-        if (type == List)
-            return CreateList();
-        if (type == Savefile)
-            return new DreamObjectSavefile(Savefile.ObjectDefinition);
-        if (type.ObjectDefinition.IsSubtypeOf(DatabaseQuery))
-            return new DreamObjectDatabaseQuery(type.ObjectDefinition);
-        if (type.ObjectDefinition.IsSubtypeOf(Database))
-            return new DreamObjectDatabase(type.ObjectDefinition);
-        if (type.ObjectDefinition.IsSubtypeOf(Matrix))
-            return new DreamObjectMatrix(type.ObjectDefinition);
-        if (type.ObjectDefinition.IsSubtypeOf(Sound))
-            return new DreamObjectSound(type.ObjectDefinition);
-        if (type.ObjectDefinition.IsSubtypeOf(Regex))
-            return new DreamObjectRegex(type.ObjectDefinition);
-        if (type.ObjectDefinition.IsSubtypeOf(Image))
-            return new DreamObjectImage(type.ObjectDefinition);
-        if (type.ObjectDefinition.IsSubtypeOf(Icon))
-            return new DreamObjectIcon(type.ObjectDefinition);
-        if (type.ObjectDefinition.IsSubtypeOf(Filter))
-            return new DreamObjectFilter(type.ObjectDefinition);
-        if (type.ObjectDefinition.IsSubtypeOf(Mob))
-            return new DreamObjectMob(type.ObjectDefinition);
-        if (type.ObjectDefinition.IsSubtypeOf(Movable))
-            return new DreamObjectMovable(type.ObjectDefinition);
-        if (type.ObjectDefinition.IsSubtypeOf(Area))
-            return new DreamObjectArea(type.ObjectDefinition);
-        if (type.ObjectDefinition.IsSubtypeOf(Atom))
-            return new DreamObjectAtom(type.ObjectDefinition);
-        if (type.ObjectDefinition.IsSubtypeOf(Client))
-            throw new Exception("Cannot create objects of type /client");
-        if (type.ObjectDefinition.IsSubtypeOf(Turf))
-            throw new Exception("New turfs must be created by the map manager");
-        if (type.ObjectDefinition.IsSubtypeOf(Exception))
-            return new DreamObjectException(type.ObjectDefinition);
-
-        return new DreamObject(type.ObjectDefinition);
+        using(Profiler.BeginZone($"new {type}")){
+            if (type == List)
+                return CreateList();
+            if (type == Savefile)
+                return new DreamObjectSavefile(Savefile.ObjectDefinition);
+            if (type.ObjectDefinition.IsSubtypeOf(DatabaseQuery))
+                return new DreamObjectDatabaseQuery(type.ObjectDefinition);
+            if (type.ObjectDefinition.IsSubtypeOf(Database))
+                return new DreamObjectDatabase(type.ObjectDefinition);
+            if (type.ObjectDefinition.IsSubtypeOf(Matrix))
+                return new DreamObjectMatrix(type.ObjectDefinition);
+            if (type.ObjectDefinition.IsSubtypeOf(Sound))
+                return new DreamObjectSound(type.ObjectDefinition);
+            if (type.ObjectDefinition.IsSubtypeOf(Regex))
+                return new DreamObjectRegex(type.ObjectDefinition);
+            if (type.ObjectDefinition.IsSubtypeOf(Image))
+                return new DreamObjectImage(type.ObjectDefinition);
+            if (type.ObjectDefinition.IsSubtypeOf(Icon))
+                return new DreamObjectIcon(type.ObjectDefinition);
+            if (type.ObjectDefinition.IsSubtypeOf(Filter))
+                return new DreamObjectFilter(type.ObjectDefinition);
+            if (type.ObjectDefinition.IsSubtypeOf(Mob))
+                return new DreamObjectMob(type.ObjectDefinition);
+            if (type.ObjectDefinition.IsSubtypeOf(Movable))
+                return new DreamObjectMovable(type.ObjectDefinition);
+            if (type.ObjectDefinition.IsSubtypeOf(Area))
+                return new DreamObjectArea(type.ObjectDefinition);
+            if (type.ObjectDefinition.IsSubtypeOf(Atom))
+                return new DreamObjectAtom(type.ObjectDefinition);
+            if (type.ObjectDefinition.IsSubtypeOf(Client))
+                throw new Exception("Cannot create objects of type /client");
+            if (type.ObjectDefinition.IsSubtypeOf(Turf))
+                throw new Exception("New turfs must be created by the map manager");
+            if (type.ObjectDefinition.IsSubtypeOf(Exception))
+                return new DreamObjectException(type.ObjectDefinition);
+
+            return new DreamObject(type.ObjectDefinition);
+        }
     }
 
     public T CreateObject<T>(TreeEntry type) where T : DreamObject {

OpenDreamRuntime/OpenDreamRuntime.csproj

@@ -14,6 +14,7 @@
   </ItemGroup>
   <ItemGroup>
     <PackageReference Include="Byond.TopicSender" />
+    <PackageReference Include="Tracy-CSharp" />
   </ItemGroup>
 
   <Import Project="..\RobustToolbox\MSBuild\Robust.Properties.targets" />

OpenDreamRuntime/Procs/AsyncNativeProc.cs

@@ -26,6 +26,8 @@ public sealed class State : ProcState {
             private AsyncNativeProc? _proc;
             public override DreamProc? Proc => _proc;
 
+            public override (string SourceFile, int Line) TracyLocationId => ("Async Native Proc", 0);
+
             private Func<State, Task<DreamValue>> _taskFunc;
             private Task? _task;
 

OpenDreamRuntime/Procs/DMProc.cs

@@ -50,6 +50,8 @@ public DMProc(int id, TreeEntry owningType, ProcDefinitionJson json, string? nam
         }
 
         public (string Source, int Line) GetSourceAtOffset(int offset) {
+            if(SourceInfo.Count == 0)
+                return ("<No Source Attached>",0);
             SourceInfoJson current = SourceInfo[0];
             string source = ObjectTree.Strings[current.File!.Value];
 
@@ -151,6 +153,8 @@ public sealed class NullProcState : ProcState {
 
         public override DreamProc? Proc => _proc;
 
+        public override (string SourceFile, int Line) TracyLocationId => ("<NO-OP>",0);
+
         private DreamProc? _proc;
 
         public override ProcStatus Resume() {
@@ -354,6 +358,9 @@ public sealed class DMProcState : ProcState {
         private DMProc _proc;
         public override DMProc Proc => _proc;
 
+        public override (string SourceFile, int Line) TracyLocationId => _proc.GetSourceAtOffset(_pc+1);
+
+
         /// Static initializer for maintainer friendly OpcodeHandlers to performance friendly _opcodeHandlers
         static unsafe DMProcState() {
             int maxOpcode = (int)_opcodeHandlers.Keys.Max();
@@ -481,7 +488,10 @@ public void SetReturn(DreamValue value) {
         public ProcStatus Call(DreamProc proc, DreamObject? src, DreamProcArguments arguments) {
             if (proc is NativeProc p) {
                 // Skip a whole song and dance.
-                Push(p.Call(Thread, src, Usr, arguments));
+                // ReSharper disable ExplicitCallerInfoArgument
+                using(Profiler.BeginZone(filePath:"Native Proc", lineNumber:0, memberName:p.Name))
+                    Push(p.Call(Thread, src, Usr, arguments));
+                // ReSharper restore ExplicitCallerInfoArgument
                 return ProcStatus.Continue;
             }
 

OpenDreamRuntime/Procs/InitDreamObject.cs

@@ -9,7 +9,7 @@ internal sealed class InitDreamObjectState : ProcState {
         private readonly DreamObjectTree _objectTree;
 
         private enum Stage {
-            // Need to call the object's (init) proc
+        // Need to call the object's (init) proc
             Init,
 
             // Need to call IDreamMetaObject.OnObjectCreated & New
@@ -42,6 +42,8 @@ public void Initialize(DreamThread thread, DreamObject dreamObject, DreamObject?
 
         public override DreamProc? Proc => null;
 
+        public override (string SourceFile, int Line) TracyLocationId => ($"new {_dreamObject.ObjectDefinition.Type}",0);
+
         public override void AppendStackFrame(StringBuilder builder) {
             builder.AppendLine($"new {_dreamObject.ObjectDefinition.Type}");
         }