Merge pull request swiftlang#65802 from Catfish-Man/contiguous-conundrum-tests

Add a few basic smoke test benchmarks for the default RangeReplaceableCollection append methods

Author: swift-ci

benchmark/CMakeLists.txt

@@ -121,6 +121,7 @@ set(SWIFT_BENCH_MODULES
     single-source/NSDictionaryCastToSwift
     single-source/NSErrorTest
     single-source/NSStringConversion
+    single-source/NaiveRangeReplaceableCollectionConformance
     single-source/NibbleSort
     single-source/NIOChannelPipeline
     single-source/NopDeinit

benchmark/single-source/NaiveRangeReplaceableCollectionConformance.swift

@@ -0,0 +1,101 @@
+//===--- NaiveRangeReplaceableCollectionConformance.swift -----------------===//
+//
+// This source file is part of the Swift.org open source project
+//
+// Copyright (c) 2023 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
+// See https://swift.org/CONTRIBUTORS.txt for the list of Swift project authors
+//
+//===----------------------------------------------------------------------===//
+
+import TestsUtils
+
+var contiguous:[UInt8] = []
+
+public let benchmarks = [
+    BenchmarkInfo(name: "NaiveRRC.append.largeContiguous",
+                  runFunction: runAppendLargeContiguous,
+                  tags: [.validation, .api],
+                  setUpFunction: { contiguous = [UInt8](repeating: 7, count: 1_000) }),
+    BenchmarkInfo(name: "NaiveRRC.append.smallContiguousRepeated",
+                  runFunction: runAppendSmallContiguousRepeatedly,
+                  tags: [.validation, .api],
+                  setUpFunction: { contiguous = [UInt8](repeating: 7, count: 1) }),
+    BenchmarkInfo(name: "NaiveRRC.init.largeContiguous",
+                  runFunction: runInitLargeContiguous,
+                  tags: [.validation, .api],
+                  setUpFunction: { contiguous = [UInt8](repeating: 7, count: 1_000) })
+]
+
+struct NaiveRRC : RangeReplaceableCollection {
+  
+  var storage:[UInt8] = []
+  
+  init() {}
+  
+  func index(after i: Int) -> Int {
+    i + 1
+  }
+  
+  func index(before i: Int) -> Int {
+    i - 1
+  }
+  
+  var startIndex: Int {
+    0
+  }
+  
+  var endIndex: Int {
+    count
+  }
+  
+  var count: Int {
+    storage.count
+  }
+  
+  subscript(position: Int) -> UInt8 {
+    get {
+      storage[position]
+    }
+    set(newValue) {
+      storage[position] = newValue
+    }
+  }
+  
+  mutating func replaceSubrange(_ subrange: Range<Int>, with newElements: some Collection<UInt8>) {
+    storage.replaceSubrange(subrange, with: newElements)
+  }
+  
+  mutating func reserveCapacity(_ n: Int) {
+    storage.reserveCapacity(n)
+  }
+}
+
+@inline(never)
+public func runAppendLargeContiguous(N: Int) {
+  for _ in 1...N {
+    var rrc = NaiveRRC()
+    rrc.append(contentsOf: contiguous)
+    blackHole(rrc)
+  }
+}
+
+@inline(never)
+public func runAppendSmallContiguousRepeatedly(N: Int) {
+  for _ in 1...N {
+    var rrc = NaiveRRC()
+    for _ in 1...5_000 {
+      rrc.append(contentsOf: contiguous)
+    }
+    blackHole(rrc)
+  }
+}
+
+@inline(never)
+public func runInitLargeContiguous(N: Int) {
+  for _ in 1...N {
+    blackHole(NaiveRRC(contiguous))
+  }
+}

benchmark/utils/main.swift

@@ -112,6 +112,7 @@ import Memset
 import MirrorTest
 import MonteCarloE
 import MonteCarloPi
+import NaiveRangeReplaceableCollectionConformance
 import NibbleSort
 import NIOChannelPipeline
 import NSDictionaryCastToSwift
@@ -303,6 +304,7 @@ register(Memset.benchmarks)
 register(MirrorTest.benchmarks)
 register(MonteCarloE.benchmarks)
 register(MonteCarloPi.benchmarks)
+register(NaiveRangeReplaceableCollectionConformance.benchmarks)
 register(NSDictionaryCastToSwift.benchmarks)
 register(NSErrorTest.benchmarks)
 #if canImport(Darwin)