Allow users to hide Gen X columns (#1764)

adamsitnik · web-flow · commit f372668e0281 · 2021-08-04T18:01:10.000+02:00
* don't display Gen X collumn if there were no collections for X generation

* add MemoryDiagnoserConfig, allow users to customize MemoryDiagnoser
diff --git a/src/BenchmarkDotNet/Attributes/MemoryDiagnoserAttribute.cs b/src/BenchmarkDotNet/Attributes/MemoryDiagnoserAttribute.cs
@@ -9,9 +9,10 @@ public class MemoryDiagnoserAttribute : Attribute, IConfigSource
     {
         public IConfig Config { get; }
 
-        public MemoryDiagnoserAttribute()
+        /// <param name="displayGenColumns">Display Garbage Collections per Generation columns (Gen 0, Gen 1, Gen 2). True by default.</param>
+        public MemoryDiagnoserAttribute(bool displayGenColumns = true)
         {
-            Config = ManualConfig.CreateEmpty().AddDiagnoser(MemoryDiagnoser.Default);
+            Config = ManualConfig.CreateEmpty().AddDiagnoser(new MemoryDiagnoser(new MemoryDiagnoserConfig(displayGenColumns)));
         }
     }
 }
diff --git a/src/BenchmarkDotNet/Columns/MetricColumn.cs b/src/BenchmarkDotNet/Columns/MetricColumn.cs
@@ -16,7 +16,7 @@ public class MetricColumn : IColumn
         public string Legend => descriptor.Legend;
         public bool AlwaysShow => true;
         public ColumnCategory Category => ColumnCategory.Metric;
-        public int PriorityInCategory => 0;
+        public int PriorityInCategory => descriptor.PriorityInCategory;
         public bool IsNumeric => true;
         public UnitType UnitType => descriptor.UnitType;
 
diff --git a/src/BenchmarkDotNet/Configs/ImmutableConfig.cs b/src/BenchmarkDotNet/Configs/ImmutableConfig.cs
@@ -92,7 +92,7 @@ internal ImmutableConfig(
         public IAnalyser GetCompositeAnalyser() => new CompositeAnalyser(analysers);
         public IDiagnoser GetCompositeDiagnoser() => new CompositeDiagnoser(diagnosers);
 
-        public bool HasMemoryDiagnoser() => diagnosers.Contains(MemoryDiagnoser.Default);
+        public bool HasMemoryDiagnoser() => diagnosers.OfType<MemoryDiagnoser>().Any();
 
         public bool HasThreadingDiagnoser() => diagnosers.Contains(ThreadingDiagnoser.Default);
 
diff --git a/src/BenchmarkDotNet/Diagnosers/AllocatedNativeMemoryDescriptor.cs b/src/BenchmarkDotNet/Diagnosers/AllocatedNativeMemoryDescriptor.cs
@@ -12,6 +12,7 @@ internal class AllocatedNativeMemoryDescriptor : IMetricDescriptor
         public UnitType UnitType => UnitType.Size;
         public string Unit => SizeUnit.B.Name;
         public bool TheGreaterTheBetter => false;
+        public int PriorityInCategory => 0;
     }
 
     internal class NativeMemoryLeakDescriptor : IMetricDescriptor
@@ -23,5 +24,6 @@ internal class NativeMemoryLeakDescriptor : IMetricDescriptor
         public UnitType UnitType => UnitType.Size;
         public string Unit => SizeUnit.B.Name;
         public bool TheGreaterTheBetter => false;
+        public int PriorityInCategory => 0;
     }
 }
diff --git a/src/BenchmarkDotNet/Diagnosers/MemoryDiagnoser.cs b/src/BenchmarkDotNet/Diagnosers/MemoryDiagnoser.cs
@@ -15,9 +15,11 @@ public class MemoryDiagnoser : IDiagnoser
     {
         private const string DiagnoserId = nameof(MemoryDiagnoser);
 
-        public static readonly MemoryDiagnoser Default = new MemoryDiagnoser();
+        public static readonly MemoryDiagnoser Default = new MemoryDiagnoser(new MemoryDiagnoserConfig(displayGenColumns: true));
 
-        private MemoryDiagnoser() { } // we want to have only a single instance of MemoryDiagnoser
+        public MemoryDiagnoser(MemoryDiagnoserConfig config) => Config = config;
+
+        public MemoryDiagnoserConfig Config { get; }
 
         public RunMode GetRunMode(BenchmarkCase benchmarkCase) => RunMode.NoOverhead;
 
@@ -33,9 +35,13 @@ public void Handle(HostSignal signal, DiagnoserActionParameters parameters) { }
 
         public IEnumerable<Metric> ProcessResults(DiagnoserResults diagnoserResults)
         {
-            yield return new Metric(GarbageCollectionsMetricDescriptor.Gen0, diagnoserResults.GcStats.Gen0Collections / (double)diagnoserResults.GcStats.TotalOperations * 1000);
-            yield return new Metric(GarbageCollectionsMetricDescriptor.Gen1, diagnoserResults.GcStats.Gen1Collections / (double)diagnoserResults.GcStats.TotalOperations * 1000);
-            yield return new Metric(GarbageCollectionsMetricDescriptor.Gen2, diagnoserResults.GcStats.Gen2Collections / (double)diagnoserResults.GcStats.TotalOperations * 1000);
+            if (diagnoserResults.GcStats.Gen0Collections > 0 && Config.DisplayGenColumns)
+                yield return new Metric(GarbageCollectionsMetricDescriptor.Gen0, diagnoserResults.GcStats.Gen0Collections / (double)diagnoserResults.GcStats.TotalOperations * 1000);
+            if (diagnoserResults.GcStats.Gen1Collections > 0 && Config.DisplayGenColumns)
+                yield return new Metric(GarbageCollectionsMetricDescriptor.Gen1, diagnoserResults.GcStats.Gen1Collections / (double)diagnoserResults.GcStats.TotalOperations * 1000);
+            if (diagnoserResults.GcStats.Gen2Collections > 0 && Config.DisplayGenColumns)
+                yield return new Metric(GarbageCollectionsMetricDescriptor.Gen2, diagnoserResults.GcStats.Gen2Collections / (double)diagnoserResults.GcStats.TotalOperations * 1000);
+
             yield return new Metric(AllocatedMemoryMetricDescriptor.Instance, diagnoserResults.GcStats.GetBytesAllocatedPerOperation(diagnoserResults.BenchmarkCase));
         }
 
@@ -50,6 +56,7 @@ private class AllocatedMemoryMetricDescriptor : IMetricDescriptor
             public UnitType UnitType => UnitType.Size;
             public string Unit => SizeUnit.B.Name;
             public bool TheGreaterTheBetter => false;
+            public int PriorityInCategory => GC.MaxGeneration + 1;
         }
 
         private class GarbageCollectionsMetricDescriptor : IMetricDescriptor
@@ -63,6 +70,7 @@ private GarbageCollectionsMetricDescriptor(int generationId)
                 Id = $"Gen{generationId}Collects";
                 DisplayName = $"Gen {generationId}";
                 Legend = $"GC Generation {generationId} collects per 1000 operations";
+                PriorityInCategory = generationId;
             }
 
             public string Id { get; }
@@ -72,6 +80,7 @@ private GarbageCollectionsMetricDescriptor(int generationId)
             public UnitType UnitType => UnitType.Dimensionless;
             public string Unit => "Count";
             public bool TheGreaterTheBetter => false;
+            public int PriorityInCategory { get; }
         }
     }
 }
diff --git a/src/BenchmarkDotNet/Diagnosers/MemoryDiagnoserConfig.cs b/src/BenchmarkDotNet/Diagnosers/MemoryDiagnoserConfig.cs
@@ -0,0 +1,16 @@
+﻿using JetBrains.Annotations;
+
+namespace BenchmarkDotNet.Diagnosers
+{
+    public class MemoryDiagnoserConfig
+    {
+        /// <param name="displayGenColumns">Display Garbage Collections per Generation columns (Gen 0, Gen 1, Gen 2). True by default.</param>
+        [PublicAPI]
+        public MemoryDiagnoserConfig(bool displayGenColumns = true)
+        {
+            DisplayGenColumns = displayGenColumns;
+        }
+
+        public bool DisplayGenColumns { get; }
+    }
+}
diff --git a/src/BenchmarkDotNet/Diagnosers/PmcMetricDescriptor.cs b/src/BenchmarkDotNet/Diagnosers/PmcMetricDescriptor.cs
@@ -20,5 +20,6 @@ internal PmcMetricDescriptor(PreciseMachineCounter counter)
         public string NumberFormat => "N0";
         public UnitType UnitType => UnitType.Dimensionless;
         public string Unit => "Count";
+        public int PriorityInCategory => 0;
     }
 }
diff --git a/src/BenchmarkDotNet/Diagnosers/ThreadingDiagnoser.cs b/src/BenchmarkDotNet/Diagnosers/ThreadingDiagnoser.cs
@@ -61,6 +61,7 @@ private class CompletedWorkItemCountMetricDescriptor : IMetricDescriptor
             public UnitType UnitType => UnitType.Dimensionless;
             public string Unit => "Count";
             public bool TheGreaterTheBetter => false;
+            public int PriorityInCategory => 0;
         }
 
         private class LockContentionCountMetricDescriptor : IMetricDescriptor
@@ -74,6 +75,7 @@ private class LockContentionCountMetricDescriptor : IMetricDescriptor
             public UnitType UnitType => UnitType.Dimensionless;
             public string Unit => "Count";
             public bool TheGreaterTheBetter => false;
+            public int PriorityInCategory => 0;
         }
     }
 }
diff --git a/src/BenchmarkDotNet/Disassemblers/DisassemblyDiagnoser.cs b/src/BenchmarkDotNet/Disassemblers/DisassemblyDiagnoser.cs
@@ -169,6 +169,7 @@ private class NativeCodeSizeMetricDescriptor : IMetricDescriptor
             public UnitType UnitType => UnitType.Size;
             public string Unit => SizeUnit.B.Name;
             public bool TheGreaterTheBetter => false;
+            public int PriorityInCategory => 0;
         }
     }
 }
diff --git a/src/BenchmarkDotNet/Reports/Metric.cs b/src/BenchmarkDotNet/Reports/Metric.cs
@@ -32,6 +32,8 @@ public interface IMetricDescriptor
         [PublicAPI] string Unit { get; }
 
         [PublicAPI] bool TheGreaterTheBetter { get; }
+
+        [PublicAPI] int PriorityInCategory { get; }
     }
 
     public class MetricDescriptorEqualityComparer : EqualityComparer<IMetricDescriptor>
diff --git a/tests/BenchmarkDotNet.Tests/Reports/FakeMetricDescriptor.cs b/tests/BenchmarkDotNet.Tests/Reports/FakeMetricDescriptor.cs
@@ -19,5 +19,6 @@ public FakeMetricDescriptor(string id, string legend, string numberFormat = null
         public UnitType UnitType { get; }
         public string Unit { get; }
         public bool TheGreaterTheBetter { get; }
+        public int PriorityInCategory => 0;
     }
 }
diff --git a/tests/BenchmarkDotNet.Tests/Reports/SummaryTests.cs b/tests/BenchmarkDotNet.Tests/Reports/SummaryTests.cs
@@ -92,6 +92,7 @@ private sealed class FakeMetricDescriptor : IMetricDescriptor
             public UnitType UnitType { get; }
             public string Unit { get; } = nameof(Unit);
             public bool TheGreaterTheBetter { get; }
+            public int PriorityInCategory => 0;
         }
     }
 }

Original file line number	Diff line number	Diff line change
`@@ -9,9 +9,10 @@ public class MemoryDiagnoserAttribute : Attribute, IConfigSource`
`9`	`9`	`{`
`10`	`10`	`public IConfig Config { get; }`
`11`	`11`
`12`		`- public MemoryDiagnoserAttribute()`
	`12`	`+ /// <param name="displayGenColumns">Display Garbage Collections per Generation columns (Gen 0, Gen 1, Gen 2). True by default.</param>`
	`13`	`+ public MemoryDiagnoserAttribute(bool displayGenColumns = true)`
`13`	`14`	`{`
`14`		`- Config = ManualConfig.CreateEmpty().AddDiagnoser(MemoryDiagnoser.Default);`
	`15`	`+ Config = ManualConfig.CreateEmpty().AddDiagnoser(new MemoryDiagnoser(new MemoryDiagnoserConfig(displayGenColumns)));`
`15`	`16`	`}`
`16`	`17`	`}`
`17`	`18`	`}`
Original file line number	Diff line number	Diff line change
`@@ -12,6 +12,7 @@ internal class AllocatedNativeMemoryDescriptor : IMetricDescriptor`
`12`	`12`	`public UnitType UnitType => UnitType.Size;`
`13`	`13`	`public string Unit => SizeUnit.B.Name;`
`14`	`14`	`public bool TheGreaterTheBetter => false;`
	`15`	`+ public int PriorityInCategory => 0;`
`15`	`16`	`}`
`16`	`17`
`17`	`18`	`internal class NativeMemoryLeakDescriptor : IMetricDescriptor`
`@@ -23,5 +24,6 @@ internal class NativeMemoryLeakDescriptor : IMetricDescriptor`
`23`	`24`	`public UnitType UnitType => UnitType.Size;`
`24`	`25`	`public string Unit => SizeUnit.B.Name;`
`25`	`26`	`public bool TheGreaterTheBetter => false;`
	`27`	`+ public int PriorityInCategory => 0;`
`26`	`28`	`}`
`27`	`29`	`}`
Original file line number	Diff line number	Diff line change
`@@ -15,9 +15,11 @@ public class MemoryDiagnoser : IDiagnoser`
`15`	`15`	`{`
`16`	`16`	`private const string DiagnoserId = nameof(MemoryDiagnoser);`
`17`	`17`
`18`		`- public static readonly MemoryDiagnoser Default = new MemoryDiagnoser();`
	`18`	`+ public static readonly MemoryDiagnoser Default = new MemoryDiagnoser(new MemoryDiagnoserConfig(displayGenColumns: true));`
`19`	`19`
`20`		`- private MemoryDiagnoser() { } // we want to have only a single instance of MemoryDiagnoser`
	`20`	`+ public MemoryDiagnoser(MemoryDiagnoserConfig config) => Config = config;`
	`21`	`+`
	`22`	`+ public MemoryDiagnoserConfig Config { get; }`
`21`	`23`
`22`	`24`	`public RunMode GetRunMode(BenchmarkCase benchmarkCase) => RunMode.NoOverhead;`
`23`	`25`
`@@ -33,9 +35,13 @@ public void Handle(HostSignal signal, DiagnoserActionParameters parameters) { }`
`33`	`35`
`34`	`36`	`public IEnumerable<Metric> ProcessResults(DiagnoserResults diagnoserResults)`
`35`	`37`	`{`
`36`		`- yield return new Metric(GarbageCollectionsMetricDescriptor.Gen0, diagnoserResults.GcStats.Gen0Collections / (double)diagnoserResults.GcStats.TotalOperations * 1000);`
`37`		`- yield return new Metric(GarbageCollectionsMetricDescriptor.Gen1, diagnoserResults.GcStats.Gen1Collections / (double)diagnoserResults.GcStats.TotalOperations * 1000);`
`38`		`- yield return new Metric(GarbageCollectionsMetricDescriptor.Gen2, diagnoserResults.GcStats.Gen2Collections / (double)diagnoserResults.GcStats.TotalOperations * 1000);`
	`38`	`+ if (diagnoserResults.GcStats.Gen0Collections > 0 && Config.DisplayGenColumns)`
	`39`	`+ yield return new Metric(GarbageCollectionsMetricDescriptor.Gen0, diagnoserResults.GcStats.Gen0Collections / (double)diagnoserResults.GcStats.TotalOperations * 1000);`
	`40`	`+ if (diagnoserResults.GcStats.Gen1Collections > 0 && Config.DisplayGenColumns)`
	`41`	`+ yield return new Metric(GarbageCollectionsMetricDescriptor.Gen1, diagnoserResults.GcStats.Gen1Collections / (double)diagnoserResults.GcStats.TotalOperations * 1000);`
	`42`	`+ if (diagnoserResults.GcStats.Gen2Collections > 0 && Config.DisplayGenColumns)`
	`43`	`+ yield return new Metric(GarbageCollectionsMetricDescriptor.Gen2, diagnoserResults.GcStats.Gen2Collections / (double)diagnoserResults.GcStats.TotalOperations * 1000);`
	`44`	`+`
`39`	`45`	`yield return new Metric(AllocatedMemoryMetricDescriptor.Instance, diagnoserResults.GcStats.GetBytesAllocatedPerOperation(diagnoserResults.BenchmarkCase));`
`40`	`46`	`}`
`41`	`47`
`@@ -50,6 +56,7 @@ private class AllocatedMemoryMetricDescriptor : IMetricDescriptor`
`50`	`56`	`public UnitType UnitType => UnitType.Size;`
`51`	`57`	`public string Unit => SizeUnit.B.Name;`
`52`	`58`	`public bool TheGreaterTheBetter => false;`
	`59`	`+ public int PriorityInCategory => GC.MaxGeneration + 1;`
`53`	`60`	`}`
`54`	`61`
`55`	`62`	`private class GarbageCollectionsMetricDescriptor : IMetricDescriptor`
`@@ -63,6 +70,7 @@ private GarbageCollectionsMetricDescriptor(int generationId)`
`63`	`70`	`Id = $"Gen{generationId}Collects";`
`64`	`71`	`DisplayName = $"Gen {generationId}";`
`65`	`72`	`Legend = $"GC Generation {generationId} collects per 1000 operations";`
	`73`	`+ PriorityInCategory = generationId;`
`66`	`74`	`}`
`67`	`75`
`68`	`76`	`public string Id { get; }`
`@@ -72,6 +80,7 @@ private GarbageCollectionsMetricDescriptor(int generationId)`
`72`	`80`	`public UnitType UnitType => UnitType.Dimensionless;`
`73`	`81`	`public string Unit => "Count";`
`74`	`82`	`public bool TheGreaterTheBetter => false;`
	`83`	`+ public int PriorityInCategory { get; }`
`75`	`84`	`}`
`76`	`85`	`}`
`77`	`86`	`}`
Original file line number	Diff line number	Diff line change
`@@ -20,5 +20,6 @@ internal PmcMetricDescriptor(PreciseMachineCounter counter)`
`20`	`20`	`public string NumberFormat => "N0";`
`21`	`21`	`public UnitType UnitType => UnitType.Dimensionless;`
`22`	`22`	`public string Unit => "Count";`
	`23`	`+ public int PriorityInCategory => 0;`
`23`	`24`	`}`
`24`	`25`	`}`
Original file line number	Diff line number	Diff line change
`@@ -61,6 +61,7 @@ private class CompletedWorkItemCountMetricDescriptor : IMetricDescriptor`
`61`	`61`	`public UnitType UnitType => UnitType.Dimensionless;`
`62`	`62`	`public string Unit => "Count";`
`63`	`63`	`public bool TheGreaterTheBetter => false;`
	`64`	`+ public int PriorityInCategory => 0;`
`64`	`65`	`}`
`65`	`66`
`66`	`67`	`private class LockContentionCountMetricDescriptor : IMetricDescriptor`
`@@ -74,6 +75,7 @@ private class LockContentionCountMetricDescriptor : IMetricDescriptor`
`74`	`75`	`public UnitType UnitType => UnitType.Dimensionless;`
`75`	`76`	`public string Unit => "Count";`
`76`	`77`	`public bool TheGreaterTheBetter => false;`
	`78`	`+ public int PriorityInCategory => 0;`
`77`	`79`	`}`
`78`	`80`	`}`
`79`	`81`	`}`
Original file line number	Diff line number	Diff line change
`@@ -169,6 +169,7 @@ private class NativeCodeSizeMetricDescriptor : IMetricDescriptor`
`169`	`169`	`public UnitType UnitType => UnitType.Size;`
`170`	`170`	`public string Unit => SizeUnit.B.Name;`
`171`	`171`	`public bool TheGreaterTheBetter => false;`
	`172`	`+ public int PriorityInCategory => 0;`
`172`	`173`	`}`
`173`	`174`	`}`
`174`	`175`	`}`
Original file line number	Diff line number	Diff line change
`@@ -32,6 +32,8 @@ public interface IMetricDescriptor`
`32`	`32`	`[PublicAPI] string Unit { get; }`
`33`	`33`
`34`	`34`	`[PublicAPI] bool TheGreaterTheBetter { get; }`
	`35`	`+`
	`36`	`+ [PublicAPI] int PriorityInCategory { get; }`
`35`	`37`	`}`
`36`	`38`
`37`	`39`	`public class MetricDescriptorEqualityComparer : EqualityComparer<IMetricDescriptor>`