Cleanup benchmark protocols

Author: rctcwyvrn

Sources/RegexBenchmark/Benchmark.swift

@@ -3,33 +3,40 @@ import Foundation
 
 protocol RegexBenchmark {
   var name: String { get }
-  mutating func compile()
   func run()
   func debug()
 }
 
-struct Benchmark: RegexBenchmark {
-  let name: String
-  var regex: Regex<AnyRegexOutput>
-  let type: MatchType
-  let target: String
+protocol SwiftRegexBenchmark: RegexBenchmark {
+  var regex: Regex<AnyRegexOutput> { get set }
+  mutating func compile()
+  mutating func enableTracing()
+  mutating func enableMetrics()
+}
 
-  enum MatchType {
-    case whole
-    case first
-    case allMatches
-  }
-  
+extension SwiftRegexBenchmark {
   mutating func compile() {
     let _ = regex._forceAction(.recompile)
   }
-  
   mutating func enableTracing() {
     let _ = regex._forceAction(.addOptions(.enableTracing))
   }
   mutating func enableMetrics() {
     let _ = regex._forceAction(.addOptions([.enableMetrics, .disableOptimizations]))
   }
+}
+
+struct Benchmark: SwiftRegexBenchmark {
+  let name: String
+  var regex: Regex<AnyRegexOutput>
+  let type: MatchType
+  let target: String
+
+  enum MatchType {
+    case whole
+    case first
+    case allMatches
+  }
 
   func run() {
     switch type {
@@ -55,9 +62,6 @@ struct NSBenchmark: RegexBenchmark {
     case first
   }
 
-  // Not measured for NSRegularExpression
-  mutating func compile() {}
-  
   func run() {
     switch type {
     case .allMatches: blackHole(regex.matches(in: target, range: range))
@@ -67,20 +71,10 @@ struct NSBenchmark: RegexBenchmark {
 }
 
 /// A benchmark running a regex on strings in input set
-struct InputListBenchmark: RegexBenchmark {
+struct InputListBenchmark: SwiftRegexBenchmark {
   let name: String
   var regex: Regex<AnyRegexOutput>
   let targets: [String]
-  
-  mutating func compile() {
-    blackHole(regex._forceAction(.recompile))
-  }
-  mutating func enableTracing() {
-    let _ = regex._forceAction(.addOptions(.enableTracing))
-  }
-  mutating func enableMetrics() {
-    let _ = regex._forceAction(.addOptions(.enableMetrics))
-  }
 
   func run() {
     for target in targets {
@@ -103,8 +97,6 @@ struct InputListNSBenchmark: RegexBenchmark {
   func range(in target: String) -> NSRange {
     NSRange(target.startIndex..<target.endIndex, in: target)
   }
-  
-  mutating func compile() {}
 
   func run() {
     for target in targets {

Sources/RegexBenchmark/BenchmarkRunner.swift

@@ -18,18 +18,7 @@ struct BenchmarkRunner {
     suite.append(benchmark)
   }
 
-  mutating func register(_ benchmark: Benchmark) {
-    var benchmark = benchmark
-    if enableTracing {
-      benchmark.enableTracing()
-    }
-    if enableMetrics {
-      benchmark.enableMetrics()
-    }
-    suite.append(benchmark)
-  }
-  
-  mutating func register(_ benchmark: InputListBenchmark) {
+  mutating func register(_ benchmark: some SwiftRegexBenchmark) {
     var benchmark = benchmark
     if enableTracing {
       benchmark.enableTracing()
@@ -44,24 +33,28 @@ struct BenchmarkRunner {
     benchmark: some RegexBenchmark,
     samples: Int
   ) -> BenchmarkResult {
-    var benchmark = benchmark
     var runtimes: [Time] = []
-    var compileTimes: [Time] = []
     // Initial run to make sure the regex has been compiled
     benchmark.run()
 
-    // Measure compilataion time
-    for _ in 0..<samples {
-      let start = Tick.now
-      benchmark.compile()
-      let end = Tick.now
-      let time = end.elapsedTime(since: start)
-      compileTimes.append(time)
+    // Measure compilataion time for Swift regex
+    let compileTime: Time
+    if benchmark is SwiftRegexBenchmark {
+      var benchmark = benchmark as! SwiftRegexBenchmark
+      var compileTimes: [Time] = []
+      for _ in 0..<samples {
+        let start = Tick.now
+        benchmark.compile()
+        let end = Tick.now
+        let time = end.elapsedTime(since: start)
+        compileTimes.append(time)
+      }
+      compileTimes.sort()
+      compileTime = compileTimes[samples/2]
+    } else {
+      compileTime = .zero
     }
 
-    compileTimes.sort()
-    let compileTime = compileTimes[samples/2]
-    
     // FIXME: use suspendingclock?
     for _ in 0..<samples {
       let start = Tick.now