Move _TinyArray into a separate module

and apply review feedback
apple · Jun 19, 2023 · e2f3a52 · e2f3a52
1 parent 6a42c66
commit e2f3a52
Show file tree

Hide file tree

Showing 13 changed files with 113 additions and 71 deletions.
diff --git a/...sts_01_allocation_counters/test_01_resources/test_tiny_array_cow_append_contents_of.swift b/...sts_01_allocation_counters/test_01_resources/test_tiny_array_cow_append_contents_of.swift
@@ -12,14 +12,19 @@
 //
 //===----------------------------------------------------------------------===//
 
-@_spi(IntegrationTests) import X509
+import _CertificateInternals
 
 func run(identifier: String) {
     measure(identifier: identifier) {
-        var tinyArray = TinyArray<Int>()
-        for i in 0..<1000 {
-            tinyArray.append(i)
+        var count = 0
+        for _ in 0..<1000 {
+            var tinyArray = _TinyArray<Int>()
+            for i in 0..<1000 {
+                tinyArray.append(i)
+            }
+            count += tinyArray.count
         }
-        return tinyArray.count
+
+        return count
     }
 }
diff --git a/..._01_allocation_counters/test_01_resources/test_tiny_array_non_allocating_operations.swift b/..._01_allocation_counters/test_01_resources/test_tiny_array_non_allocating_operations.swift
@@ -12,17 +12,19 @@
 //
 //===----------------------------------------------------------------------===//
 
-@_spi(IntegrationTests) import X509
+import _CertificateInternals
 
 func run(identifier: String) {
     measure(identifier: identifier) {
         var counts = 0
-        counts += TinyArray(CollectionOfOne(1)).count
-
-        do {
-            var array = TinyArray<Int>()
-            array.append(contentsOf: CollectionOfOne(1))
-            counts += array.count
+        for _ in 0..<1000 {
+            counts += _TinyArray(CollectionOfOne(1)).count
+
+            do {
+                var array = _TinyArray<Int>()
+                array.append(contentsOf: CollectionOfOne(1))
+                counts += array.count
+            }
         }
 
         return counts

diff --git a/Package.swift b/Package.swift
@@ -33,6 +33,7 @@ let package = Package(
         .target(
             name: "X509",
             dependencies: [
+                "_CertificateInternals",
                 .product(name: "SwiftASN1", package: "swift-asn1"),
                 .product(name: "Crypto", package: "swift-crypto"),
                 .product(name: "_CryptoExtras", package: "swift-crypto"),
@@ -55,6 +56,16 @@ let package = Package(
                 .copy("PEMTestRSACertificate.pem"),
                 .copy("CSR Vectors/"),
             ]),
+        .target(
+            name: "_CertificateInternals",
+            exclude: [
+                "CMakeLists.txt",
+            ]),
+        .testTarget(
+            name: "CertificateInternalsTests",
+            dependencies: [
+                "_CertificateInternals",
+            ]),
     ]
 )
 

diff --git a/Sources/CMakeLists.txt b/Sources/CMakeLists.txt
@@ -13,3 +13,4 @@
 ##===----------------------------------------------------------------------===##
 
 add_subdirectory(X509)
+add_subdirectory(_CertificateInternals)
diff --git a/Sources/X509/CMakeLists.txt b/Sources/X509/CMakeLists.txt
@@ -81,7 +81,6 @@ add_library(X509
   "SEC1PrivateKey.swift"
   "Signature.swift"
   "SignatureAlgorithm.swift"
-  "TinyArray.swift"
   "Verifier/AnyPolicy.swift"
   "Verifier/CertificateStore.swift"
   "Verifier/PolicyBuilder.swift"

diff --git a/Sources/_CertificateInternals/CMakeLists.txt b/Sources/_CertificateInternals/CMakeLists.txt
@@ -0,0 +1,23 @@
+##===----------------------------------------------------------------------===##
+##
+## This source file is part of the SwiftCertificates open source project
+##
+## Copyright (c) 2023 Apple Inc. and the SwiftCertificates project authors
+## Licensed under Apache License v2.0
+##
+## See LICENSE.txt for license information
+## See CONTRIBUTORS.txt for the list of SwiftCertificates project authors
+##
+## SPDX-License-Identifier: Apache-2.0
+##
+##===----------------------------------------------------------------------===##
+
+add_library(_CertificateInternals
+  "TinyArray.swift")
+
+target_link_libraries(X509 PUBLIC)
+set_target_properties(_CertificateInternals PROPERTIES
+  INTERFACE_INCLUDE_DIRECTORIES ${CMAKE_Swift_MODULE_DIRECTORY})
+
+_install_target(_CertificateInternals)
+set_property(GLOBAL APPEND PROPERTY SWIFT_CERTIFICATES_EXPORTS _TinyArray)
diff --git a/Sources/X509/TinyArray.swift → ...es/_CertificateInternals/_TinyArray.swift b/Sources/X509/TinyArray.swift → ...es/_CertificateInternals/_TinyArray.swift
@@ -17,7 +17,7 @@ import Foundation
 /// ``TinyArray`` is a ``RandomAccessCollection`` optimised to store zero or one ``Element``.
 /// It supports arbitrary many elements but if only up to one ``Element`` is stored it does **not** allocate separate storage on the heap
 /// and instead stores the ``Element`` inline.
-@_spi(IntegrationTests) public struct TinyArray<Element> {
+public struct _TinyArray<Element> {
     @usableFromInline
     enum Storage {
         case one(Element)
@@ -30,79 +30,79 @@ import Foundation
 
 // MARK: - TinyArray "public" interface
 
-extension TinyArray: Equatable where Element: Equatable {}
-extension TinyArray: Hashable where Element: Hashable {}
-extension TinyArray: Sendable where Element: Sendable {}
+extension _TinyArray: Equatable where Element: Equatable {}
+extension _TinyArray: Hashable where Element: Hashable {}
+extension _TinyArray: Sendable where Element: Sendable {}
 
-extension TinyArray: RandomAccessCollection {
-    @_spi(IntegrationTests) public typealias Element = Element
+extension _TinyArray: RandomAccessCollection {
+    public typealias Element = Element
 
-    @_spi(IntegrationTests) public typealias Index = Int
+    public typealias Index = Int
 
     @inlinable
-    @_spi(IntegrationTests) public subscript(position: Int) -> Element {
+    public subscript(position: Int) -> Element {
         get {
             self.storage[position]
         }
     }
 
     @inlinable
-    @_spi(IntegrationTests) public var startIndex: Int {
+    public var startIndex: Int {
         self.storage.startIndex
     }
 
     @inlinable
-    @_spi(IntegrationTests) public var endIndex: Int {
+    public var endIndex: Int {
         self.storage.endIndex
     }
 }
 
-extension TinyArray {
+extension _TinyArray {
     @inlinable
-    @_spi(IntegrationTests) public init(_ elements: some Sequence<Element>) {
+    public init(_ elements: some Sequence<Element>) {
         self.storage = .init(elements)
     }
 
     @inlinable
-    @_spi(IntegrationTests) public init(_ elements: some Sequence<Result<Element, some Error>>) throws {
+    public init(_ elements: some Sequence<Result<Element, some Error>>) throws {
         self.storage = try .init(elements)
     }
 
     @inlinable
-    @_spi(IntegrationTests) public init() {
+    public init() {
         self.storage = .init()
     }
 
     @inlinable
-    @_spi(IntegrationTests) public mutating func append(_ newElement: Element) {
+    public mutating func append(_ newElement: Element) {
         self.storage.append(newElement)
     }
 
     @inlinable
-    @_spi(IntegrationTests) public mutating func append(contentsOf newElements: some Sequence<Element>){
+    public mutating func append(contentsOf newElements: some Sequence<Element>){
         self.storage.append(contentsOf: newElements)
     }
 
     @discardableResult
     @inlinable
-    @_spi(IntegrationTests) public mutating func remove(at index: Int) -> Element {
+    public mutating func remove(at index: Int) -> Element {
         self.storage.remove(at: index)
     }
 
     @inlinable
-    @_spi(IntegrationTests) public mutating func removeAll(where shouldBeRemoved: (Element) throws -> Bool) rethrows {
+    public mutating func removeAll(where shouldBeRemoved: (Element) throws -> Bool) rethrows {
         try self.storage.removeAll(where: shouldBeRemoved)
     }
 
     @inlinable
-    @_spi(IntegrationTests) public mutating func sort(by areInIncreasingOrder: (Element, Element) throws -> Bool) rethrows {
+    public mutating func sort(by areInIncreasingOrder: (Element, Element) throws -> Bool) rethrows {
         try self.storage.sort(by: areInIncreasingOrder)
     }
 }
 
 // MARK: - TinyArray.Storage "private" implementation
 
-extension TinyArray.Storage: Equatable where Element: Equatable {
+extension _TinyArray.Storage: Equatable where Element: Equatable {
     @inlinable
     static func ==(lhs: Self, rhs: Self) -> Bool {
         switch (lhs, rhs) {
@@ -123,7 +123,7 @@ extension TinyArray.Storage: Equatable where Element: Equatable {
         }
     }
 }
-extension TinyArray.Storage: Hashable where Element: Hashable {
+extension _TinyArray.Storage: Hashable where Element: Hashable {
     @inlinable
     func hash(into hasher: inout Hasher) {
         // same strategy as Array: https://github.com/apple/swift/blob/b42019005988b2d13398025883e285a81d323efa/stdlib/public/core/Array.swift#L1801
@@ -133,9 +133,9 @@ extension TinyArray.Storage: Hashable where Element: Hashable {
         }
     }
 }
-extension TinyArray.Storage: Sendable where Element: Sendable {}
+extension _TinyArray.Storage: Sendable where Element: Sendable {}
 
-extension TinyArray.Storage: RandomAccessCollection {
+extension _TinyArray.Storage: RandomAccessCollection {
     @inlinable
     subscript(position: Int) -> Element {
         get {
@@ -165,7 +165,7 @@ extension TinyArray.Storage: RandomAccessCollection {
     }
 }
 
-extension TinyArray.Storage {
+extension _TinyArray.Storage {
     @inlinable
     init(_ elements: some Sequence<Element>) {
         self = .arbitrary([])

diff --git a/Tests/X509Tests/TinyArrayTests.swift → ...ficateInternalsTests/TinyArrayTests.swift b/Tests/X509Tests/TinyArrayTests.swift → ...ficateInternalsTests/TinyArrayTests.swift
@@ -13,20 +13,20 @@
 //===----------------------------------------------------------------------===//
 
 import XCTest
-@_spi(IntegrationTests) import X509
+import _CertificateInternals
 
 final class TinyArrayTests: XCTestCase {
     private func _assertEqual(
         _ expected: @autoclosure () -> some Sequence<Int>,
-        initial: @autoclosure () -> TinyArray<Int>,
-        _ mutate: (inout TinyArray<Int>) -> (),
+        initial: @autoclosure () -> _TinyArray<Int>,
+        _ mutate: (inout _TinyArray<Int>) -> (),
         file: StaticString = #filePath,
         line: UInt = #line
     ) {
         var actual = initial()
         mutate(&actual)
         XCTAssertEqual(Array(actual), Array(expected()), file: file, line: line)
-        let expected = TinyArray(expected())
+        let expected = _TinyArray(expected())
         XCTAssertEqual(actual, expected, file: file, line: line)
         var acutalHasher = Hasher()
         acutalHasher.combine(actual)
@@ -37,8 +37,8 @@ final class TinyArrayTests: XCTestCase {
 
     private func assertEqual(
         _ expected: [Int],
-        initial: @autoclosure () -> TinyArray<Int> = TinyArray(),
-        _ mutate: (inout TinyArray<Int>) -> (),
+        initial: @autoclosure () -> _TinyArray<Int> = _TinyArray(),
+        _ mutate: (inout _TinyArray<Int>) -> (),
         file: StaticString = #filePath,
         line: UInt = #line
     ) {
@@ -48,17 +48,17 @@ final class TinyArrayTests: XCTestCase {
     }
 
     func testInit() {
-        XCTAssertEqual(Array(TinyArray([Int]())), [])
-        XCTAssertEqual(Array(TinyArray<Int>()), [])
-        XCTAssertEqual(TinyArray<Int>(), TinyArray<Int>([]))
+        XCTAssertEqual(Array(_TinyArray([Int]())), [])
+        XCTAssertEqual(Array(_TinyArray<Int>()), [])
+        XCTAssertEqual(_TinyArray<Int>(), _TinyArray<Int>([]))
 
-        XCTAssertEqual(Array(TinyArray<Int>(CollectionOfOne(1))), [1])
-        XCTAssertEqual(Array(TinyArray<Int>([1])), [1])
-        XCTAssertEqual(Array(TinyArray<Int>([1, 2])), [1, 2])
+        XCTAssertEqual(Array(_TinyArray<Int>(CollectionOfOne(1))), [1])
+        XCTAssertEqual(Array(_TinyArray<Int>([1])), [1])
+        XCTAssertEqual(Array(_TinyArray<Int>([1, 2])), [1, 2])
 
-        XCTAssertEqual(Array(TinyArray<Int>([1, 2, 3])), [1, 2, 3])
-        XCTAssertEqual(Array(TinyArray<Int>([1, 2, 3, 4])), [1, 2, 3, 4])
-        XCTAssertEqual(Array(TinyArray<Int>([1, 2, 3, 4, 5])), [1, 2, 3, 4, 5])
+        XCTAssertEqual(Array(_TinyArray<Int>([1, 2, 3])), [1, 2, 3])
+        XCTAssertEqual(Array(_TinyArray<Int>([1, 2, 3, 4])), [1, 2, 3, 4])
+        XCTAssertEqual(Array(_TinyArray<Int>([1, 2, 3, 4, 5])), [1, 2, 3, 4, 5])
     }
 
     func testAppend() {
@@ -279,27 +279,27 @@ final class TinyArrayTests: XCTestCase {
     }
 
     func testThrowingInitFromResult() {
-        XCTAssertEqual(Array(try TinyArray<Int>(CollectionOfOne(Result<_, Error>.success(1)))), [1])
-        XCTAssertEqual(Array(try TinyArray([Result<_, Error>.success(1)])), [1])
-        XCTAssertEqual(Array(try TinyArray([Result<_, Error>.success(1), .success(2)])), [1, 2])
-        XCTAssertEqual(Array(try TinyArray([Result<_, Error>.success(1), .success(2), .success(3)])), [1, 2, 3])
-        XCTAssertEqual(Array(try TinyArray([Result<_, Error>.success(1), .success(2), .success(3), .success(4)])), [1, 2, 3, 4])
-        XCTAssertEqual(Array(try TinyArray([Result<_, Error>.success(1), .success(2), .success(3), .success(4), .success(5)])), [1, 2, 3, 4, 5])
+        XCTAssertEqual(Array(try _TinyArray<Int>(CollectionOfOne(Result<_, Error>.success(1)))), [1])
+        XCTAssertEqual(Array(try _TinyArray([Result<_, Error>.success(1)])), [1])
+        XCTAssertEqual(Array(try _TinyArray([Result<_, Error>.success(1), .success(2)])), [1, 2])
+        XCTAssertEqual(Array(try _TinyArray([Result<_, Error>.success(1), .success(2), .success(3)])), [1, 2, 3])
+        XCTAssertEqual(Array(try _TinyArray([Result<_, Error>.success(1), .success(2), .success(3), .success(4)])), [1, 2, 3, 4])
+        XCTAssertEqual(Array(try _TinyArray([Result<_, Error>.success(1), .success(2), .success(3), .success(4), .success(5)])), [1, 2, 3, 4, 5])
 
         struct MyError: Error {}
 
-        XCTAssertThrowsError(Array(try TinyArray<Int>([Result.failure(MyError())])))
-        XCTAssertThrowsError(Array(try TinyArray<Int>([Result.failure(MyError()), Result.failure(MyError())])))
-        XCTAssertThrowsError(Array(try TinyArray<Int>([.success(1), Result.failure(MyError())])))
-        XCTAssertThrowsError(Array(try TinyArray<Int>([.success(1), Result.failure(MyError()), .success(2)])))
-        XCTAssertThrowsError(Array(try TinyArray<Int>([.success(1), .success(2), Result.failure(MyError())])))
-        XCTAssertThrowsError(Array(try TinyArray<Int>([.success(1), .success(2), Result.failure(MyError()), .success(4)])))
-        XCTAssertThrowsError(Array(try TinyArray<Int>([.success(1), .success(2), .success(3), Result.failure(MyError())])))
-        XCTAssertThrowsError(Array(try TinyArray<Int>([.success(1), .success(2), .success(3), .success(4), Result.failure(MyError())])))
+        XCTAssertThrowsError(Array(try _TinyArray<Int>([Result.failure(MyError())])))
+        XCTAssertThrowsError(Array(try _TinyArray<Int>([Result.failure(MyError()), Result.failure(MyError())])))
+        XCTAssertThrowsError(Array(try _TinyArray<Int>([.success(1), Result.failure(MyError())])))
+        XCTAssertThrowsError(Array(try _TinyArray<Int>([.success(1), Result.failure(MyError()), .success(2)])))
+        XCTAssertThrowsError(Array(try _TinyArray<Int>([.success(1), .success(2), Result.failure(MyError())])))
+        XCTAssertThrowsError(Array(try _TinyArray<Int>([.success(1), .success(2), Result.failure(MyError()), .success(4)])))
+        XCTAssertThrowsError(Array(try _TinyArray<Int>([.success(1), .success(2), .success(3), Result.failure(MyError())])))
+        XCTAssertThrowsError(Array(try _TinyArray<Int>([.success(1), .success(2), .success(3), .success(4), Result.failure(MyError())])))
     }
 }
 
-extension TinyArray: ExpressibleByArrayLiteral {
+extension _TinyArray: ExpressibleByArrayLiteral {
     public typealias ArrayLiteralElement = Element
 
     public init(arrayLiteral elements: Element...) {

diff --git a/docker/docker-compose.2204.57.yaml b/docker/docker-compose.2204.57.yaml
@@ -13,7 +13,7 @@ services:
     image: swift-certificates:22.04-5.7
     environment:
       - WARN_AS_ERROR_ARG=-Xswiftc -warnings-as-errors
-      - MAX_ALLOCS_ALLOWED_tiny_array_cow_append_contents_of=10
+      - MAX_ALLOCS_ALLOWED_tiny_array_cow_append_contents_of=10000
       - MAX_ALLOCS_ALLOWED_tiny_array_non_allocating_operations=0
       # - SANITIZER_ARG=--sanitize=thread # TSan broken still
 

diff --git a/docker/docker-compose.2204.58.yaml b/docker/docker-compose.2204.58.yaml
@@ -14,7 +14,7 @@ services:
     environment:
       - WARN_AS_ERROR_ARG=-Xswiftc -warnings-as-errors
       - IMPORT_CHECK_ARG=--explicit-target-dependency-import-check error
-      - MAX_ALLOCS_ALLOWED_tiny_array_cow_append_contents_of=10
+      - MAX_ALLOCS_ALLOWED_tiny_array_cow_append_contents_of=10000
       - MAX_ALLOCS_ALLOWED_tiny_array_non_allocating_operations=0
       # - SANITIZER_ARG=--sanitize=thread # TSan broken still
 

diff --git a/docker/docker-compose.2204.59.yaml b/docker/docker-compose.2204.59.yaml
@@ -13,7 +13,7 @@ services:
     environment:
       - WARN_AS_ERROR_ARG=-Xswiftc -warnings-as-errors
       - IMPORT_CHECK_ARG=--explicit-target-dependency-import-check error
-      - MAX_ALLOCS_ALLOWED_tiny_array_cow_append_contents_of=10
+      - MAX_ALLOCS_ALLOWED_tiny_array_cow_append_contents_of=10000
       - MAX_ALLOCS_ALLOWED_tiny_array_non_allocating_operations=0
       # - SANITIZER_ARG=--sanitize=thread # TSan broken still
 

diff --git a/docker/docker-compose.2204.main.yaml b/docker/docker-compose.2204.main.yaml
@@ -13,7 +13,7 @@ services:
     environment:
       - WARN_AS_ERROR_ARG=-Xswiftc -warnings-as-errors
       - IMPORT_CHECK_ARG=--explicit-target-dependency-import-check error
-      - MAX_ALLOCS_ALLOWED_tiny_array_cow_append_contents_of=10
+      - MAX_ALLOCS_ALLOWED_tiny_array_cow_append_contents_of=10000
       - MAX_ALLOCS_ALLOWED_tiny_array_non_allocating_operations=0
       # - SANITIZER_ARG=--sanitize=thread # TSan broken still
 

diff --git a/scripts/update_cmakelists.sh b/scripts/update_cmakelists.sh
@@ -56,4 +56,5 @@ function update_cmakelists_source() {
 }
 
 update_cmakelists_source "X509" "*.swift"
+update_cmakelists_source "_CertificateInternals" "*.swift"