Bring instruction pointer exporter back to live (#1550)

* make sure that TraceLogParser populates IP to hardware counter dictionary

* make EtwProfiler implement the property required by InstructionPointerExporter

* improve the exported file name so it contains runtime ID and arch info

Author: adamsitnik

src/BenchmarkDotNet.Diagnostics.Windows/EtwProfiler.cs

@@ -49,7 +49,7 @@ public EtwProfiler(EtwProfilerConfig config)
 
         public IEnumerable<IAnalyser> Analysers => Array.Empty<IAnalyser>();
 
-        public IReadOnlyDictionary<BenchmarkCase, PmcStats> Results => ImmutableDictionary<BenchmarkCase, PmcStats>.Empty;
+        public IReadOnlyDictionary<BenchmarkCase, PmcStats> Results => BuildPmcStats();
 
         internal IReadOnlyDictionary<BenchmarkCase, string> BenchmarkToEtlFile => benchmarkToEtlFile;
 
@@ -149,5 +149,24 @@ private void Stop(DiagnoserActionParameters parameters)
         /// This increases the likelihood that all relevant events are processed by the collection thread by the time we are done with the benchmark.
         /// </summary>
         private static void WaitForDelayedEvents() => Thread.Sleep(TimeSpan.FromMilliseconds(500));
+
+        private IReadOnlyDictionary<BenchmarkCase, PmcStats> BuildPmcStats()
+        {
+            var builder = ImmutableDictionary.CreateBuilder<BenchmarkCase, PmcStats>();
+
+            foreach (var benchmarkToCounter in benchmarkToCounters)
+            {
+                var uniqueCounters = benchmarkToCounter.Value.Select(x => x.Counter).Distinct().ToImmutableArray();
+
+                var pmcStats = new PmcStats(
+                    uniqueCounters,
+                    counter => benchmarkToCounter.Value.Single(pmc => pmc.Counter == counter)
+                );
+
+                builder.Add(benchmarkToCounter.Key, pmcStats);
+            }
+
+            return builder.ToImmutable();
+        }
     }
 }

src/BenchmarkDotNet.Diagnostics.Windows/Tracing/TraceLogParser.cs

@@ -133,7 +133,7 @@ public IEnumerable<Metric> CalculateMetrics(Dictionary<int, int> profileSourceId
             var overheadIterations = CreateIterationData(overheadTimestamps);
             var workloadIterations = CreateIterationData(workloadTimestamps);
 
-            SumCountersPerIterations(profileSourceIdToInterval, workloadIterations, overheadIterations);
+            SumCountersPerIterations(profileSourceIdToInterval, workloadIterations, overheadIterations, counters);
 
             var workloadTotalPerCounter = Sum(workloadIterations);
             var overheadTotalPerCounter = Sum(overheadIterations);
@@ -172,15 +172,22 @@ private IterationData[] CreateIterationData(List<double> startStopTimeStamps)
             return iterations;
         }
 
-        private void SumCountersPerIterations(Dictionary<int, int> profileSourceIdToInterval, IterationData[] workloadIterations, IterationData[] overheadIterations)
+        private void SumCountersPerIterations(Dictionary<int, int> profileSourceIdToInterval, IterationData[] workloadIterations, IterationData[] overheadIterations,
+            PreciseMachineCounter[] counters)
         {
+            var profileSourceIdToCounter = counters.ToDictionary(counter => counter.ProfileSourceId);
+
             foreach (var sample in samples)
             {
                 var interval = profileSourceIdToInterval[sample.profileSource];
 
                 foreach (var workloadIteration in workloadIterations)
                     if (workloadIteration.TryHandle(sample.timeStamp, sample.profileSource, interval))
+                    {
+                        profileSourceIdToCounter[sample.profileSource].OnSample(sample.instructionPointer);
+
                         goto next;
+                    }
 
                 foreach (var overheadIteration in overheadIterations)
                     if (overheadIteration.TryHandle(sample.timeStamp, sample.profileSource, interval))

src/BenchmarkDotNet/Exporters/InstructionPointerExporter.cs

@@ -1,8 +1,11 @@
 using System.Collections.Generic;
 using System.IO;
 using System.Linq;
+using System.Text;
 using BenchmarkDotNet.Diagnosers;
 using BenchmarkDotNet.Disassemblers;
+using BenchmarkDotNet.Extensions;
+using BenchmarkDotNet.Helpers;
 using BenchmarkDotNet.Loggers;
 using BenchmarkDotNet.Reports;
 using BenchmarkDotNet.Running;
@@ -46,9 +49,12 @@ public IEnumerable<string> ExportToFiles(Summary summary, ILogger consoleLogger)
 
         private string Export(Summary summary, BenchmarkCase benchmarkCase, DisassemblyResult disassemblyResult, PmcStats pmcStats)
         {
-            string filePath = $"{Path.Combine(summary.ResultsDirectoryPath, benchmarkCase.Descriptor.WorkloadMethod.Name)}-{benchmarkCase.Job.Environment.Jit}-{benchmarkCase.Job.Environment.Platform}-instructionPointer.html";
-            if (File.Exists(filePath))
-                File.Delete(filePath);
+            string filePath = Path.Combine(summary.ResultsDirectoryPath,
+                                            $"{FolderNameHelper.ToFolderName(benchmarkCase.Descriptor.Type)}." +
+                                            $"{benchmarkCase.Descriptor.WorkloadMethod.Name}." +
+                                            $"{GetShortRuntimeInfo(summary[benchmarkCase].GetRuntimeInfo())}.counters.html");
+
+            filePath.DeleteFileIfExists();
 
             var totals = SumHardwareCountersStatsOfBenchmarkedCode(disassemblyResult, pmcStats);
             var perMethod = SumHardwareCountersPerMethod(disassemblyResult, pmcStats);
@@ -251,6 +257,38 @@ private void Export(ILogger logger, BenchmarkCase benchmarkCase, Dictionary<Hard
             logger.WriteLine("</tbody></table></body></html>");
         }
 
+        // fullInfo is sth like ".NET Core 2.1.21 (CoreCLR 4.6.29130.01, CoreFX 4.6.29130.02), X64 RyuJIT"
+        private static string GetShortRuntimeInfo(string fullInfo)
+        {
+            var builder = new StringBuilder();
+
+            for (int i = 0; i < fullInfo.IndexOf('(') - 1; i++)
+            {
+                if (fullInfo[i] != ' ')
+                {
+                    builder.Append(fullInfo[i]);
+                }
+                else
+                {
+                    builder.Append('_');
+                }
+            }
+
+            for (int i = fullInfo.LastIndexOf(',') + 1; i < fullInfo.Length; i++)
+            {
+                if (fullInfo[i] != ' ')
+                {
+                    builder.Append(fullInfo[i]);
+                }
+                else
+                {
+                    builder.Append('_');
+                }
+            }
+
+            return builder.ToString();
+        }
+
         private class CodeWithCounters
         {
             internal SourceCode Code { get; set; }