feat: add new UI pages (#12)

* feat: filter GC heap stat by generation
* feat: show error for http request
* feat: add dump info
* feat: add strings
* feat: add roots
* fix: address column style
* feat: add object root path
* feat: add UI screens

Author: Ne4to

Directory.Build.props

@@ -7,7 +7,7 @@
   </PropertyGroup>
 
   <PropertyGroup>
-    <VersionPrefix>0.1.0</VersionPrefix>
+    <VersionPrefix>0.2.0</VersionPrefix>
     <RepositoryUrl>https://github.com/Ne4to/Heartbeat</RepositoryUrl>
     <PublishRepositoryUrl>true</PublishRepositoryUrl>
     <PackageLicenseExpression>MIT</PackageLicenseExpression>

Heartbeat.sln

@@ -25,6 +25,14 @@ Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "src", "src", "{677CC7ED-C15
 EndProject
 Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "DebugHost", "src\DebugHost\DebugHost.csproj", "{F1FF76E5-3DEE-4C64-8A62-8A645B981D1D}"
 EndProject
+Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "scripts", "scripts", "{88EB58BA-FB0F-4A15-B366-BB033820126B}"
+	ProjectSection(SolutionItems) = preProject
+		scripts\reinstall-dev-tool.ps1 = scripts\reinstall-dev-tool.ps1
+		scripts\update-ts-client.ps1 = scripts\update-ts-client.ps1
+	EndProjectSection
+EndProject
+Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "MinimalRepo", "tests\MinimalRepo\MinimalRepo.csproj", "{3D11554D-E09C-4710-B071-D90BB2447F46}"
+EndProject
 Global
 	GlobalSection(SolutionConfigurationPlatforms) = preSolution
 		Debug|Any CPU = Debug|Any CPU
@@ -161,6 +169,30 @@ Global
 		{F1FF76E5-3DEE-4C64-8A62-8A645B981D1D}.Release|x64.Build.0 = Release|Any CPU
 		{F1FF76E5-3DEE-4C64-8A62-8A645B981D1D}.Release|x86.ActiveCfg = Release|Any CPU
 		{F1FF76E5-3DEE-4C64-8A62-8A645B981D1D}.Release|x86.Build.0 = Release|Any CPU
+		{3D11554D-E09C-4710-B071-D90BB2447F46}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
+		{3D11554D-E09C-4710-B071-D90BB2447F46}.Debug|Any CPU.Build.0 = Debug|Any CPU
+		{3D11554D-E09C-4710-B071-D90BB2447F46}.Debug|arm64.ActiveCfg = Debug|Any CPU
+		{3D11554D-E09C-4710-B071-D90BB2447F46}.Debug|arm64.Build.0 = Debug|Any CPU
+		{3D11554D-E09C-4710-B071-D90BB2447F46}.Debug|x64.ActiveCfg = Debug|Any CPU
+		{3D11554D-E09C-4710-B071-D90BB2447F46}.Debug|x64.Build.0 = Debug|Any CPU
+		{3D11554D-E09C-4710-B071-D90BB2447F46}.Debug|x86.ActiveCfg = Debug|Any CPU
+		{3D11554D-E09C-4710-B071-D90BB2447F46}.Debug|x86.Build.0 = Debug|Any CPU
+		{3D11554D-E09C-4710-B071-D90BB2447F46}.DebugLocal|Any CPU.ActiveCfg = Debug|Any CPU
+		{3D11554D-E09C-4710-B071-D90BB2447F46}.DebugLocal|Any CPU.Build.0 = Debug|Any CPU
+		{3D11554D-E09C-4710-B071-D90BB2447F46}.DebugLocal|arm64.ActiveCfg = Debug|Any CPU
+		{3D11554D-E09C-4710-B071-D90BB2447F46}.DebugLocal|arm64.Build.0 = Debug|Any CPU
+		{3D11554D-E09C-4710-B071-D90BB2447F46}.DebugLocal|x64.ActiveCfg = Debug|Any CPU
+		{3D11554D-E09C-4710-B071-D90BB2447F46}.DebugLocal|x64.Build.0 = Debug|Any CPU
+		{3D11554D-E09C-4710-B071-D90BB2447F46}.DebugLocal|x86.ActiveCfg = Debug|Any CPU
+		{3D11554D-E09C-4710-B071-D90BB2447F46}.DebugLocal|x86.Build.0 = Debug|Any CPU
+		{3D11554D-E09C-4710-B071-D90BB2447F46}.Release|Any CPU.ActiveCfg = Release|Any CPU
+		{3D11554D-E09C-4710-B071-D90BB2447F46}.Release|Any CPU.Build.0 = Release|Any CPU
+		{3D11554D-E09C-4710-B071-D90BB2447F46}.Release|arm64.ActiveCfg = Release|Any CPU
+		{3D11554D-E09C-4710-B071-D90BB2447F46}.Release|arm64.Build.0 = Release|Any CPU
+		{3D11554D-E09C-4710-B071-D90BB2447F46}.Release|x64.ActiveCfg = Release|Any CPU
+		{3D11554D-E09C-4710-B071-D90BB2447F46}.Release|x64.Build.0 = Release|Any CPU
+		{3D11554D-E09C-4710-B071-D90BB2447F46}.Release|x86.ActiveCfg = Release|Any CPU
+		{3D11554D-E09C-4710-B071-D90BB2447F46}.Release|x86.Build.0 = Release|Any CPU
 	EndGlobalSection
 	GlobalSection(SolutionProperties) = preSolution
 		HideSolutionNode = FALSE
@@ -171,6 +203,8 @@ Global
 		{9E63F5A0-7695-474C-A946-64D75F8D9617} = {677CC7ED-C157-4885-884A-5C88B08A90C6}
 		{D4060CFE-8141-49CE-99A5-559599D0E6B4} = {677CC7ED-C157-4885-884A-5C88B08A90C6}
 		{F1FF76E5-3DEE-4C64-8A62-8A645B981D1D} = {E52617F0-FB17-4C0C-A70A-26A3C11A8647}
+		{88EB58BA-FB0F-4A15-B366-BB033820126B} = {BE3A3B9E-B429-4D93-8E8D-9A23CCA4DA19}
+		{3D11554D-E09C-4710-B071-D90BB2447F46} = {E52617F0-FB17-4C0C-A70A-26A3C11A8647}
 	EndGlobalSection
 	GlobalSection(ExtensibilityGlobals) = postSolution
 		SolutionGuid = {9BC4B059-33F1-4B7C-B5D9-DA6D2F1E5076}

README.md

@@ -1,12 +1,18 @@
 # Heartbeat
 Diagnostics utility to analyze memory dumps of a .NET application
-
-## Installation
 [![NuGet Badge](https://buildstats.info/nuget/heartbeat?includePreReleases=true&dWidth=0)](https://www.nuget.org/packages/Heartbeat/)
-```
+
+## Getting started
+
+```shell
 dotnet tool install --global Heartbeat
+heartbeat --dump <path-to-dump-file>
 ```
+Open `http://localhost:5000/` in web browser.
+See [UI screen]([https://](https://github.com/Ne4to/Heartbeat/tree/master/assets)) for examples
 
+<!---
+TODO: update description
 ## Summary
 
 The purpose of the Heartbeat is finding runtime issues of .NET application in the production environment such as spontaneous high memory / CPU usage, high latency and so on.
@@ -36,11 +42,11 @@ Issue Finder example:
 - Find hot stack traces;
 - Find hung System.Threading.Tasks.Task objects;
 - Find System.Threading.Tasks.Task state.
-
+-->
 ## Usage
 
 ```
-  Heartbeat [options]
+heartbeat [options]
 
 Options:
   --dump <dump> (REQUIRED)  Path to a dump file
@@ -49,4 +55,7 @@ Options:
   --ignore-dac-mismatch     Ignore mismatches between DAC versions
   --version                 Show version information
   -?, -h, --help            Show help and usage information
-```
+```
+<!---
+TODO: add screens
+-->

assets/01-dashboard.jpeg

@@ -0,0 +1,9 @@
+<?xml version="1.0" encoding="utf-8"?>
+<configuration>
+  <packageSources>
+    <!--To inherit the global NuGet package sources remove the <clear/> line below -->
+    <clear />
+    <add key="nuget" value="https://api.nuget.org/v3/index.json" />
+    <add key="dotnet-tools" value="https://pkgs.dev.azure.com/dnceng/public/_packaging/dotnet-tools/nuget/v3/index.json" />
+  </packageSources>
+</configuration>

assets/02-heap-dump.jpeg

@@ -12,7 +12,8 @@ try
     Get-Date -Format ''
     $VersionSuffix = "rc.$(Get-Date -Format 'yyyy-MM-dd-HHmm')"
     dotnet pack --version-suffix $VersionSuffix
-    $PackageVersion = "0.1.0-$VersionSuffix"
+    # TODO get VersionPrefix from Directory.Build.props
+    $PackageVersion = "0.2.0-$VersionSuffix"
     dotnet tool install --global --add-source ./src/Heartbeat/nupkg Heartbeat --version $PackageVersion
 }
 catch {

assets/03-segments.jpeg

@@ -1,9 +1,9 @@
 $ErrorActionPreference = "Stop"
 
 $RepositoryRoot = Split-Path $PSScriptRoot
-$FrontendRoot = Join-Path $RepositoryRoot 'src/Heartbeat.WebUI/ClientApp'
+$FrontendRoot = Join-Path $RepositoryRoot 'src/Heartbeat/ClientApp'
 $ContractPath = Join-Path $FrontendRoot 'api.yml'
-$DllPath = Join-Path $RepositoryRoot 'src/Heartbeat.WebUI/bin/Debug/net8.0/Heartbeat.WebUI.dll'
+$DllPath = Join-Path $RepositoryRoot 'src/Heartbeat/bin/Debug/net8.0/Heartbeat.dll'
 
 Push-Location
 try
@@ -14,6 +14,7 @@ try
     dotnet build --configuration Debug
 
     Set-Location $FrontendRoot
+    $env:HEARTBEAT_GENERATE_CONTRACTS = 'true'
     dotnet swagger tofile --yaml --output $ContractPath $DllPath Heartbeat
     dotnet kiota generate -l typescript --openapi $ContractPath -c HeartbeatClient -o ./src/client
 
@@ -25,4 +26,5 @@ catch {
 }
 finally {
     Pop-Location
+    $env:HEARTBEAT_GENERATE_CONTRACTS = $null
 }

assets/04-roots.jpeg

@@ -5,7 +5,7 @@
     </PropertyGroup>
 
     <ItemGroup>
-      <PackageReference Include="Microsoft.Diagnostics.Runtime" Version="3.1.456101" />
+      <PackageReference Include="Microsoft.Diagnostics.Runtime" Version="3.1.506101" />
     </ItemGroup>
 
     <ItemGroup>

assets/05-modules.jpeg

@@ -2,15 +2,17 @@
 using Heartbeat.Runtime.Analyzers.Interfaces;
 using Heartbeat.Runtime.Extensions;
 
+using Microsoft.Diagnostics.Runtime;
 using Microsoft.Extensions.Logging;
 
 namespace Heartbeat.Runtime.Analyzers;
 
-public sealed class ObjectTypeStatisticsAnalyzer : AnalyzerBase, ILoggerDump, IWithTraversingHeapMode
+public sealed class HeapDumpStatisticsAnalyzer : AnalyzerBase, ILoggerDump, IWithTraversingHeapMode
 {
     public TraversingHeapModes TraversingHeapMode { get; set; } = TraversingHeapModes.All;
+    public Generation? Generation { get; set; }
 
-    public ObjectTypeStatisticsAnalyzer(RuntimeContext context) : base(context)
+    public HeapDumpStatisticsAnalyzer(RuntimeContext context) : base(context)
     {
     }
 
@@ -34,7 +36,7 @@ private void WriteLog(ILogger logger, int topTypeCount)
     public IReadOnlyCollection<ObjectTypeStatistics> GetObjectTypeStatistics()
     {
         return (
-            from obj in Context.EnumerateObjects(TraversingHeapMode)
+            from obj in Context.EnumerateObjects(TraversingHeapMode, Generation)
             let objSize = obj.Size
             //group new { size = objSize } by type.Name into g
             group objSize by obj.Type

assets/06-strings.jpeg

@@ -27,7 +27,7 @@ private void WriteLog(ILogger logger, TraversingHeapModes traversingMode)
     private IEnumerable<ClrObject> GetLongestStrings(int count, TraversingHeapModes traversingMode)
     {
         var query =
-            from clrObject in Context.EnumerateObjectsByTypeName("System.String", traversingMode)
+            from clrObject in Context.EnumerateStrings(traversingMode)
             orderby clrObject.Size descending
             select clrObject;
 

assets/07-string-duplicates.jpeg

@@ -1,13 +1,15 @@
 using Heartbeat.Runtime.Analyzers.Interfaces;
 using Heartbeat.Runtime.Extensions;
 
+using Microsoft.Diagnostics.Runtime;
 using Microsoft.Extensions.Logging;
 
 namespace Heartbeat.Runtime.Analyzers;
 
 public sealed class StringDuplicateAnalyzer : AnalyzerBase, ILoggerDump, IWithTraversingHeapMode
 {
     public TraversingHeapModes TraversingHeapMode { get; set; } = TraversingHeapModes.All;
+    public Generation? Generation { get; set; }
 
     public StringDuplicateAnalyzer(RuntimeContext context) : base(context)
     {
@@ -38,22 +40,37 @@ private void LogStringDuplicates(ILogger logger,
         }
     }
 
+    internal record struct StringDuplicateInfo(int Count, int FullLength)
+    {
+        public StringDuplicateInfo IncrementCount() => this with { Count = Count + 1 };
+    };
+
     public IReadOnlyList<StringDuplicate> GetStringDuplicates()
     {
-        var stringCount = new Dictionary<string, int>(StringComparer.OrdinalIgnoreCase);
+        var stringCount = new Dictionary<string, StringDuplicateInfo>(StringComparer.OrdinalIgnoreCase);
 
         var query =
-            from clrObject in Context.EnumerateObjectsByTypeName("System.String", TraversingHeapMode)
-            select clrObject.AsString();
+            from clrObject in Context.EnumerateStrings(TraversingHeapMode, Generation)
+            select clrObject;
 
         foreach (var stringInstance in query)
         {
-            stringCount.IncrementValue(stringInstance);
+            var stringValue = stringInstance.AsString()!;
+            
+            if (stringCount.TryGetValue(stringValue, out var currentValue))
+            {
+                stringCount[stringValue] = currentValue.IncrementCount();
+            }
+            else
+            {
+                var fullLength = stringInstance.ReadField<int>("_stringLength");
+                stringCount[stringValue] = new StringDuplicateInfo(1, fullLength);
+            }
         }
-
+        
         return stringCount
-            .Where(kvp => kvp.Value > 1)
-            .Select(kvp => new StringDuplicate(kvp.Key, kvp.Value, kvp.Key.Length))
+            .Where(kvp => kvp.Value.Count > 1)
+            .Select(kvp => new StringDuplicate(kvp.Key, kvp.Value.Count, kvp.Value.FullLength))
             .ToArray();
     }
 
@@ -72,7 +89,7 @@ public IReadOnlyCollection<StringDuplicate> GetStringDuplicates(int minDuplicate
                 continue;
             }
 
-            result.Add(new StringDuplicate(stringValue.Truncate(truncateLength), instanceCount, stringDuplicate.Length));
+            result.Add(new StringDuplicate(stringValue.Truncate(truncateLength), instanceCount, stringDuplicate.FullLength));
         }
 
         return result;

assets/08-single-objest.jpeg

@@ -3,7 +3,17 @@
 public record DumpInfo(string DumpFileName, string DacFileName, bool CanWalkHeap);
 public record ObjectInfo(Address Address, TypeInfo Type);
 public record HttpClientInfo(Address Address, TimeSpan Timeout);
-public record StringDuplicate(string Value, int Count, int Length);
+
+public record StringDuplicate(string Value, int Count, int FullLength)
+{
+    public Size WastedMemory { get; } = new((ulong)((Count - 1) * (
+        FullLength * sizeof(char) // chars
+        + sizeof(int) // int _stringLength field
+        + sizeof(char) // char _firstChar field
+        + IntPtr.Size * 2 // object header (method table + syncblk)
+        )));
+};
+
 public record ObjectTypeStatistics(MethodTable MethodTable, string TypeName, Size TotalSize, int InstanceCount);
 public record CancellationTokenSourceInfo(bool CanBeCanceled, bool IsCancellationRequested, bool IsCancellationCompleted);
 public record TimerQueueTimerInfo(Address Address, uint DueTime, uint Period, bool Cancelled, CancellationTokenSourceInfo? CancellationState);

assets/09-object-list.jpeg

@@ -76,4 +76,9 @@ public static ClrModule GetModuleByFileName(this ClrHeap heap, string fileName)
 
         return null;
     }
+
+    public static Generation GetGeneration(this ClrHeap heap, ulong address)
+    {
+        return heap.GetSegmentByAddress(address)?.GetGeneration(address) ?? Generation.Unknown;
+    }
 }

nuget.config

@@ -1,3 +1,5 @@
+using Heartbeat.Runtime.Proxies;
+
 using Microsoft.Diagnostics.Runtime;
 
 namespace Heartbeat.Runtime;
@@ -26,13 +28,11 @@ public HeapIndex(ClrHeap heap)
         {
             // Pop an object, ignore it if we've seen it before.
             var address = eval.Pop();
-            if (_walkableFromRoot.Contains(address))
+            if (!_walkableFromRoot.Add(address))
             {
                 continue;
             }
 
-            _walkableFromRoot.Add(address);
-
             // Grab the type. We will only get null here in the case of heap corruption.
             ClrType? type = heap.GetObjectType(address);
             if (type == null)
@@ -54,41 +54,50 @@ public HeapIndex(ClrHeap heap)
 
         void EnumerateArrayElements(ulong address)
         {
-            //heap.Runtime.DacLibrary.OwningLibrary.
-
             var obj = heap.GetObject(address);
             var array = obj.AsArray();
-            throw new NotImplementedException();
-            //var componentType = ((ClrmdArrayType)array.typ).ComponentType;
-
-            //if (componentType.IsObjectReference)
-            //{
-            //    foreach (var arrayElement in ArrayProxy.EnumerateObjectItems(array))
-            //    {
-            //        if (!arrayElement.IsNull)
-            //        {
-            //            AddReference(address, arrayElement.Address);
-            //            eval.Push(arrayElement.Address);
-            //        }
-            //    }
-            //}
-            //else
-            //{
-            //    // throw new NotSupportedException($"Enumerating array of {componentType} type is not supported");
-            //}
+            if (array.Type.ComponentType?.IsObjectReference ?? false)
+            {
+                foreach (var arrayElement in ArrayProxy.EnumerateObjectItems(array))
+                {
+                    if (arrayElement is { IsNull: false, IsValid: true })
+                    {
+                        AddReference(address, arrayElement.Address);
+                        eval.Push(arrayElement.Address);
+                    }
+                }
+            }
+            else if (array.Type.ComponentType?.IsValueType ?? false)
+            {
+                // TODO test and compare with WinDbg / dotnet dump
+                foreach (var arrayElement in ArrayProxy.EnumerateValueTypes(array))
+                {
+                    if (arrayElement.IsValid && arrayElement.Type != null)
+                    {
+                        EnumerateFields(arrayElement.Type, arrayElement.Address, address);
+                    }
+                }
+            }
+            else
+            {
+                throw new NotSupportedException($"Enumerating array of {array.Type.ComponentType} type is not supported");
+            }
         }
 
-        void EnumerateFields(ClrType? type, ulong address)
+        void EnumerateFields(ClrType type, ulong objectAddress, ulong? parentAddress = null)
         {
-
             foreach (var instanceField in type.Fields)
             {
                 if (instanceField.IsObjectReference)
                 {
-                    var fieldObject = instanceField.ReadObject(address, false);
+                    var fieldObject = instanceField.ReadObject(objectAddress, false);
                     if (!fieldObject.IsNull)
                     {
-                        AddReference(address, fieldObject.Address);
+                        AddReference(objectAddress, fieldObject.Address);
+                        if (parentAddress != null)
+                        {
+                            AddReference(parentAddress.Value, fieldObject.Address);
+                        }
                         eval.Push(fieldObject.Address);
                     }
                 }