Merge pull request swiftlang#14901 from milseman/bench_builder

[benchmark] Add interpolation; more stable builder

Author: milseman

benchmark/single-source/StringBuilder.swift

@@ -39,7 +39,7 @@ func buildString(_ i: String) -> String {
 @inline(never)
 public func run_StringBuilder(_ N: Int) {
   for _ in 1...5000*N {
-    _ = buildString(getString("a"))
+    blackHole(buildString(getString("a")))
   }
 }
 
@@ -52,7 +52,7 @@ func addString(_ i: String) -> String {
 @inline(never)
 public func run_StringAdder(_ N: Int) {
   for _ in 1...5000*N {
-    _ = addString(getString("a"))
+    blackHole(addString(getString("a")))
   }
 }
 
@@ -68,11 +68,10 @@ func buildStringUTF16(_ i: String) -> String {
 @inline(never)
 public func run_StringUTF16Builder(_ N: Int) {
   for _ in 1...5000*N {
-    _ = buildStringUTF16("a")
+    blackHole(buildStringUTF16(getString("a")))
   }
 }
 
-
 @inline(never)
 func buildStringLong(_ i: String) -> String {
   var sb = i
@@ -81,12 +80,10 @@ func buildStringLong(_ i: String) -> String {
   return sb
 }
 
-
-
 @inline(never)
 public func run_StringBuilderLong(_ N: Int) {
   for _ in 1...5000*N {
-    _ = buildStringLong("👻")
+    blackHole(buildStringLong(getString("👻")))
   }
 }
 
@@ -108,10 +105,16 @@ func buildString(
 
 @inline(never)
 public func run_StringWordBuilder(_ N: Int) {
-  _ = buildString(word: "bumfuzzle", count: 50_000 * N, reservingCapacity: false)
+  blackHole(buildString(
+    word: getString("bumfuzzle"),
+    count: 50_000 * N,
+    reservingCapacity: false))
 }
 
 @inline(never)
 public func run_StringWordBuilderReservingCapacity(_ N: Int) {
-  _ = buildString(word: "bumfuzzle", count: 50_000 * N, reservingCapacity: true)
+  blackHole(buildString(
+    word: getString("bumfuzzle"),
+    count: 50_000 * N,
+    reservingCapacity: true))
 }

benchmark/single-source/StringInterpolation.swift

@@ -16,6 +16,14 @@ public let StringInterpolation = BenchmarkInfo(
   name: "StringInterpolation",
   runFunction: run_StringInterpolation,
   tags: [.validation, .api, .String])
+public let StringInterpolationSmall = BenchmarkInfo(
+  name: "StringInterpolationSmall",
+  runFunction: run_StringInterpolationSmall,
+  tags: [.validation, .api, .String])
+public let StringInterpolationManySmallSegments = BenchmarkInfo(
+  name: "StringInterpolationManySmallSegments",
+  runFunction: run_StringInterpolationManySmallSegments,
+  tags: [.validation, .api, .String])
 
 class RefTypePrintable : CustomStringConvertible {
   var description: String {
@@ -33,15 +41,66 @@ public func run_StringInterpolation(_ N: Int) {
   for _ in 1...100*N {
     var result = 0
     for _ in 1...reps {
-      let s = "\(anInt) abcdefdhijklmn \(aRefCountedObject) abcdefdhijklmn \u{01}"
+      let s: String = getString(
+        "\(anInt) abcdefdhijklmn \(aRefCountedObject) abcdefdhijklmn \u{01}")
       let utf16 = s.utf16
 
       // FIXME: if String is not stored as UTF-16 on this platform, then the
       // following operation has a non-trivial cost and needs to be replaced
       // with an operation on the native storage type.
-      result = result &+ Int(utf16[utf16.index(before: utf16.endIndex)])
+      result = result &+ Int(utf16.last!)
+      blackHole(s)
+    }
+    CheckResults(result == refResult)
+  }
+}
+
+@inline(never)
+public func run_StringInterpolationSmall(_ N: Int) {
+  let reps = 100
+  let refResult = reps
+  let anInt: Int64 = 0x42
+
+  for _ in 1...100*N {
+    var result = 0
+    for _ in 1...reps {
+      let s: String = getString(
+        "\(getString("int")): \(anInt) \(getString("abc")) \u{01}")
+      result = result &+ Int(s.utf8.last!)
+      blackHole(s)
     }
     CheckResults(result == refResult)
   }
 }
 
+@inline(never)
+public func run_StringInterpolationManySmallSegments(_ N: Int) {
+  let numHex: UInt = min(UInt(N), 0x0FFF_FFFF_FFFF_FFFF)
+  let numOct: UInt = min(UInt(N), 0x0000_03FF_FFFF_FFFF)
+  let numBin: UInt = min(UInt(N), 0x7FFF)
+  let segments = [
+    "abc",
+    String(numHex, radix: 16),
+    "0123456789",
+    String(Double.pi/2),
+    "*barely* small!",
+    String(numOct, radix: 8),
+    "",
+    String(numBin, radix: 2),
+  ]
+  assert(segments.count == 8)
+
+  func getSegment(_ i: Int) -> String {
+    return getString(segments[i])
+  }
+
+  let reps = 100
+  for _ in 1...100*N {
+    for _ in 1...reps {
+      blackHole("""
+        \(getSegment(0)) \(getSegment(1))/\(getSegment(2))_\(getSegment(3))
+        \(getSegment(4)) \(getSegment(5)), \(getSegment(6))~~\(getSegment(7))
+        """)
+    }
+  }
+}

benchmark/utils/main.swift

@@ -276,6 +276,8 @@ registerBenchmark(StringComparison)
 registerBenchmark(StringEdits)
 registerBenchmark(StringEnum)
 registerBenchmark(StringInterpolation)
+registerBenchmark(StringInterpolationSmall)
+registerBenchmark(StringInterpolationManySmallSegments)
 registerBenchmark(StringMatch)
 registerBenchmark(StringRemoveDupes)
 registerBenchmark(StringTests)