Add Parent/Child Name Tree to GenericEvents to provide new non-default Hierarchical / Stack view (#46)

* Add ParentTree to GenericEvents and provide new non-default Hierarchical / Stack view of this named "Perfetto Trace Events - Process-Thread-ParentNameTree"

Author: ivberg

PerfDataExtensions/Tables/CpuSamplingTable.cs

@@ -11,8 +11,8 @@
 using PerfDataExtensions.DataOutputTypes;
 using PerfDataExtensions.Tables.Generators;
 using System.Linq;
-using PerfDataExtensions.Tables.AccessProviders;
 using static PerfDataExtensions.Tables.TimeHelper;
+using Utilities.AccessProviders;
 
 namespace PerfDataExtensions.Tables
 {

PerfDataExtensions/Tables/PerfTxtCpuSamplingTable.cs

@@ -5,7 +5,6 @@
 using Microsoft.Diagnostics.Tracing.Stacks;
 using Microsoft.Performance.SDK;
 using Microsoft.Performance.SDK.Processing;
-using PerfDataExtensions.Tables.AccessProviders;
 using PerfDataExtensions.Tables.Generators;
 using System;
 using System.Collections.Concurrent;
@@ -14,6 +13,7 @@
 using System.Linq;
 using System.Threading;
 using static PerfDataExtensions.Tables.TimeHelper;
+using Utilities.AccessProviders;
 
 namespace PerfDataExtensions.Tables
 {

PerfettoCds/Pipeline/CompositeDataCookers/PerfettoGenericEventCooker.cs

@@ -50,6 +50,7 @@ public sealed class PerfettoGenericEventCooker : CookedDataReflector, IComposite
         public static readonly DataCookerPath DataCookerPath = PerfettoPluginConstants.GenericEventCookerPath;
 
         public string Description => "Generic Event composite cooker";
+        const string Root = "[Root]";
 
         public DataCookerPath Path => DataCookerPath;
 
@@ -90,6 +91,9 @@ public sealed class PerfettoGenericEventCooker : CookedDataReflector, IComposite
         // The name of the optional ProviderGuid mapping file
         private const string ProviderMappingXmlFilename = "ProviderMapping.xml";
 
+        // In order to consolidate like paths for common events and thus reduce memory / processing
+        private Dictionary<int, string[]> ParentEventNameTreeBranchDictKeyNotReversed = new Dictionary<int, string[]>();
+
         public PerfettoGenericEventCooker() : base(PerfettoPluginConstants.GenericEventCookerPath)
         {
             this.GenericEvents =
@@ -236,15 +240,37 @@ join processTrack in processTrackData on slice.TrackId equals processTrack.Id in
 
                 int parentTreeDepthLevel = 0;
                 long? currentParentId = result.slice.ParentId;
-                
+                List<string> tmpParentEventNameTreeBranch = new List<string>();
+                tmpParentEventNameTreeBranch.Add(result.slice.Name);
+
                 // Walk the parent tree
                 while (currentParentId.HasValue)
                 {
                     var parentPerfettoSliceEvent = sliceData[(int) currentParentId.Value];
                     // Debug.Assert(parentPerfettoSliceEvent == null || (parentPerfettoSliceEvent.Id == currentParentId.Value)); // Should be guaranteed by slice Id ordering. Since we are relying on index being the Id
-                    currentParentId = parentPerfettoSliceEvent != null ? parentPerfettoSliceEvent.ParentId : null;
+                    
+                    if (parentPerfettoSliceEvent != null)
+                    {
+                        currentParentId = parentPerfettoSliceEvent.ParentId;
+                        tmpParentEventNameTreeBranch.Add(parentPerfettoSliceEvent.Name);
+                    }
+                    else
+                    {
+                        currentParentId =  null;
+                    }
+
                     parentTreeDepthLevel++;
                 }
+                tmpParentEventNameTreeBranch.Add(Root);
+
+                string[] finalParentEventNameTreeBranch;
+                var tmpParentEventNameTreeBranchHashCodeNotReversed = tmpParentEventNameTreeBranch.GetHashCode();
+                if (!ParentEventNameTreeBranchDictKeyNotReversed.TryGetValue(tmpParentEventNameTreeBranchHashCodeNotReversed, out finalParentEventNameTreeBranch))
+                {
+                    tmpParentEventNameTreeBranch.Reverse();
+                    finalParentEventNameTreeBranch = tmpParentEventNameTreeBranch.ToArray();
+                    ParentEventNameTreeBranchDictKeyNotReversed.Add(tmpParentEventNameTreeBranchHashCodeNotReversed, finalParentEventNameTreeBranch);
+                }
 
                 PerfettoGenericEvent ev = new PerfettoGenericEvent
                 (
@@ -264,7 +290,8 @@ join processTrack in processTrackData on slice.TrackId equals processTrack.Id in
                    provider,
                    result.threadTrack,
                    result.slice.ParentId,
-                   parentTreeDepthLevel
+                   parentTreeDepthLevel,
+                   finalParentEventNameTreeBranch
                 );
                 this.GenericEvents.AddEvent(ev);
             }

PerfettoCds/Pipeline/DataOutput/PerfettoGenericEvent.cs

@@ -41,6 +41,8 @@ public readonly struct PerfettoGenericEvent
 
         public PerfettoThreadTrackEvent ThreadTrack { get; }
 
+        public string[] ParentEventNameTree { get; }
+
         public PerfettoGenericEvent(string eventName, 
             string type, 
             TimestampDelta duration, 
@@ -55,7 +57,8 @@ public PerfettoGenericEvent(string eventName,
             string provider,
             PerfettoThreadTrackEvent threadTrack,
             long? parentId,
-            int parentTreeDepthLevel)
+            int parentTreeDepthLevel,
+            string[] parentEventNameTree)
         {
             EventName = eventName;
             Type = type;
@@ -72,6 +75,7 @@ public PerfettoGenericEvent(string eventName,
             ThreadTrack = threadTrack;
             ParentId = parentId;
             ParentTreeDepthLevel = parentTreeDepthLevel;
+            ParentEventNameTree = parentEventNameTree;
         }
     }
 }