More benchmarker features

Sources/RegexBenchmark/Benchmark.swift

@@ -1,8 +1,9 @@
-import _StringProcessing
+@_spi(RegexBenchmark) import _StringProcessing
 import Foundation
 
 protocol RegexBenchmark {
   var name: String { get }
+  func compile()
   func run()
   func debug()
 }
@@ -19,6 +20,10 @@ struct Benchmark: RegexBenchmark {
     case allMatches
   }
 
+  func compile() {
+    blackHole(regex._compileRegex())
+  }
+
   func run() {
     switch type {
     case .whole: blackHole(target.wholeMatch(of: regex))
@@ -43,6 +48,8 @@ struct NSBenchmark: RegexBenchmark {
     case first
   }
 
+  func compile() {}
+
   func run() {
     switch type {
     case .allMatches: blackHole(regex.matches(in: target, range: range))
@@ -57,6 +64,10 @@ struct InputListBenchmark: RegexBenchmark {
   let regex: Regex<AnyRegexOutput>
   let targets: [String]
 
+  func compile() {
+    blackHole(regex._compileRegex())
+  }
+
   func run() {
     for target in targets {
       blackHole(target.wholeMatch(of: regex))
@@ -79,6 +90,8 @@ struct InputListNSBenchmark: RegexBenchmark {
     NSRange(target.startIndex..<target.endIndex, in: target)
   }
 
+  func compile() {}
+
   func run() {
     for target in targets {
       let range = range(in: target)
@@ -89,6 +102,9 @@ struct InputListNSBenchmark: RegexBenchmark {
 
 /// A benchmark meant to be ran across multiple engines
 struct CrossBenchmark {
+  /// Suffix added onto NSRegularExpression benchmarks
+  static let nsSuffix = "_NS"
+
   /// The base name of the benchmark
   var baseName: String
 
@@ -127,7 +143,7 @@ struct CrossBenchmark {
           target: input))
       runner.register(
         NSBenchmark(
-          name: baseName + "Whole_NS",
+          name: baseName + "Whole" + CrossBenchmark.nsSuffix,
           regex: nsRegex,
           type: .first,
           target: input))
@@ -140,7 +156,7 @@ struct CrossBenchmark {
           target: input))
       runner.register(
         NSBenchmark(
-          name: baseName + "All_NS",
+          name: baseName + "All" + CrossBenchmark.nsSuffix,
           regex: nsRegex,
           type: .allMatches,
           target: input))
@@ -153,7 +169,7 @@ struct CrossBenchmark {
             target: input))
         runner.register(
           NSBenchmark(
-            name: baseName + "First_NS",
+            name: baseName + "First" + CrossBenchmark.nsSuffix,
             regex: nsRegex,
             type: .first,
             target: input))

Sources/RegexBenchmark/BenchmarkChart.swift

@@ -0,0 +1,81 @@
+//===----------------------------------------------------------------------===//
+//
+// This source file is part of the Swift.org open source project
+//
+// Copyright (c) 2021-2022 Apple Inc. and the Swift project authors
+// Licensed under Apache License v2.0 with Runtime Library Exception
+//
+// See https://swift.org/LICENSE.txt for license information
+//
+//===----------------------------------------------------------------------===//
+
+#if os(macOS)
+
+import Charts
+import SwiftUI
+
+struct BenchmarkChart: View {
+  var comparisons: [BenchmarkResult.Comparison]
+
+  var sortedComparisons: [BenchmarkResult.Comparison] {
+    comparisons.sorted { a, b in
+      a.latest.median.seconds/a.baseline.median.seconds <
+        b.latest.median.seconds/b.baseline.median.seconds
+    }
+  }
+  var body: some View {
+    VStack(alignment: .leading) {
+      Chart {
+        ForEach(sortedComparisons) { comparison in
+          let new = comparison.latest.median.seconds
+          let old = comparison.baseline.median.seconds
+          chartBody(
+            name: comparison.name,
+            new: new,
+            old: old,
+            sampleCount: comparison.latest.samples)
+        }
+        // Baseline
+        RuleMark(y: .value("Time", 1.0))
+        .foregroundStyle(.red)
+        .lineStyle(.init(lineWidth: 1, dash: [2]))
+
+      }.frame(idealHeight: 400)
+    }
+  }
+
+  @ChartContentBuilder
+  func chartBody(
+    name: String,
+    new: TimeInterval,
+    old: TimeInterval,
+    sampleCount: Int
+  ) -> some ChartContent {
+    // Normalized runtime
+    BarMark(
+      x: .value("Name", name),
+      y: .value("Normalized runtime", new / old))
+    .foregroundStyle(LinearGradient(
+      colors: [.accentColor, new - old <= 0 ? .green : .yellow],
+      startPoint: .bottom,
+      endPoint: .top))
+  }
+}
+
+struct BenchmarkResultApp: App {
+  static var comparisons: [BenchmarkResult.Comparison]?
+
+  var body: some Scene {
+    WindowGroup {
+      if let comparisons = Self.comparisons {
+        ScrollView {
+          BenchmarkChart(comparisons: comparisons)
+        }
+      } else {
+        Text("No data")
+      }
+    }
+  }
+}
+
+#endif