Skip to content

Remove a few inlinability annotations #383

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Jul 22, 2025
Merged

Remove a few inlinability annotations #383

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
fa6dc68
Add a few more inlinability annotation
glbrntt Jul 22, 2025
8bd415f
fewer inlinables
glbrntt Jul 22, 2025
fbf5db7
Merge branch 'main' into more-inlinables
glbrntt Jul 22, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
38 changes: 2 additions & 36 deletions Sources/Crypto/Util/SecureBytes.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,15 +21,12 @@ private let emptyStorage:SecureBytes.Backing = SecureBytes.Backing.createEmpty()

@available(macOS 10.15, iOS 13, watchOS 6, tvOS 13, macCatalyst 13, visionOS 1.0, *)
struct SecureBytes {
@usableFromInline
var backing: Backing

@inlinable
init() {
self = .init(count: 0)
}

@usableFromInline
init(count: Int) {
if count == 0 {
self.backing = emptyStorage
Expand All @@ -43,7 +40,6 @@ struct SecureBytes {
}

/// Allows initializing a SecureBytes object with a closure that will initialize the memory.
@usableFromInline
init(unsafeUninitializedCapacity: Int, initializingWith callback: (inout UnsafeMutableRawBufferPointer, inout Int) throws -> Void) rethrows {
self.backing = Backing.create(capacity: unsafeUninitializedCapacity)
try self.backing._withVeryUnsafeMutableBytes { veryUnsafePointer in
Expand All @@ -59,7 +55,6 @@ struct SecureBytes {

@available(macOS 10.15, iOS 13, watchOS 6, tvOS 13, macCatalyst 13, visionOS 1.0, *)
extension SecureBytes {
@inlinable
mutating func append<C: Collection>(_ data: C) where C.Element == UInt8 {
let requiredCapacity = self.count + data.count
let backingCapacity = self.backing.allocatedCapacity
Expand All @@ -71,7 +66,6 @@ extension SecureBytes {
self.backing._appendBytes(data)
}

@usableFromInline
mutating func reserveCapacity(_ n: Int) {
let backingCapacity = self.backing.allocatedCapacity
if backingCapacity >= n {
Expand All @@ -95,32 +89,27 @@ extension SecureBytes: Equatable {
// MARK: - Collection conformance
@available(macOS 10.15, iOS 13, watchOS 6, tvOS 13, macCatalyst 13, visionOS 1.0, *)
extension SecureBytes: Collection {
@usableFromInline
@available(macOS 10.15, iOS 13, watchOS 6, tvOS 13, macCatalyst 13, visionOS 1.0, *)
struct Index {
/* fileprivate but usableFromInline */ @usableFromInline var offset: Int
/* fileprivate but usableFromInline */ var offset: Int

/*@inlinable*/ @usableFromInline internal init(offset: Int) {
/*@inlinable*/ internal init(offset: Int) {
self.offset = offset
}
}

@inlinable
var startIndex: Index {
return Index(offset: 0)
}

@inlinable
var endIndex: Index {
return Index(offset: self.count)
}

@inlinable
var count: Int {
return self.backing.count
}

@inlinable
subscript(_ index: Index) -> UInt8 {
get {
return self.backing[offset: index.offset]
Expand All @@ -130,7 +119,6 @@ extension SecureBytes: Collection {
}
}

@inlinable
func index(after index: Index) -> Index {
return index.advanced(by: 1)
}
Expand All @@ -139,7 +127,6 @@ extension SecureBytes: Collection {
// MARK: - BidirectionalCollection conformance
@available(macOS 10.15, iOS 13, watchOS 6, tvOS 13, macCatalyst 13, visionOS 1.0, *)
extension SecureBytes: BidirectionalCollection {
@inlinable
func index(before index: Index) -> Index {
return index.advanced(by: -1)
}
Expand All @@ -156,7 +143,6 @@ extension SecureBytes: MutableCollection { }
// MARK: - RangeReplaceableCollection conformance
@available(macOS 10.15, iOS 13, watchOS 6, tvOS 13, macCatalyst 13, visionOS 1.0, *)
extension SecureBytes: RangeReplaceableCollection {
@inlinable
mutating func replaceSubrange<C: Collection>(_ subrange: Range<Index>, with newElements: C) where C.Element == UInt8 {
let requiredCapacity = self.backing.count - subrange.count + newElements.count
let backingCapacity = self.backing.allocatedCapacity
Expand All @@ -182,7 +168,6 @@ extension SecureBytes: RangeReplaceableCollection {
}

// The default implementation of this from RangeReplaceableCollection can't take advantage of `ContiguousBytes`, so we override it here
@inlinable
public mutating func append<Elements: Sequence>(contentsOf newElements: Elements) where Elements.Element == UInt8 {
let done:Void? = newElements.withContiguousStorageIfAvailable {
replaceSubrange(endIndex..<endIndex, with: $0)
Expand All @@ -199,12 +184,10 @@ extension SecureBytes: RangeReplaceableCollection {
// MARK: - ContiguousBytes conformance
@available(macOS 10.15, iOS 13, watchOS 6, tvOS 13, macCatalyst 13, visionOS 1.0, *)
extension SecureBytes: ContiguousBytes {
@inlinable
func withUnsafeBytes<T>(_ body: (UnsafeRawBufferPointer) throws -> T) rethrows -> T {
return try self.backing.withUnsafeBytes(body)
}

@inlinable
mutating func withUnsafeMutableBytes<T>(_ body: (UnsafeMutableRawBufferPointer) throws -> T) rethrows -> T {
if !isKnownUniquelyReferenced(&self.backing) {
self.backing = Backing.create(copying: self.backing)
Expand All @@ -213,7 +196,6 @@ extension SecureBytes: ContiguousBytes {
return try self.backing.withUnsafeMutableBytes(body)
}

@inlinable
func withContiguousStorageIfAvailable<R>(_ body: (UnsafeBufferPointer<UInt8>) throws -> R) rethrows -> R? {
return try self.backing.withContiguousStorageIfAvailable(body)
}
Expand All @@ -222,7 +204,6 @@ extension SecureBytes: ContiguousBytes {
// MARK: - DataProtocol conformance
@available(macOS 10.15, iOS 13, watchOS 6, tvOS 13, macCatalyst 13, visionOS 1.0, *)
extension SecureBytes: DataProtocol {
@inlinable
var regions: CollectionOfOne<SecureBytes> {
return CollectionOfOne(self)
}
Expand Down Expand Up @@ -257,37 +238,29 @@ extension SecureBytes.Index: Strideable {
// MARK: - Heap allocated backing storage.
@available(macOS 10.15, iOS 13, watchOS 6, tvOS 13, macCatalyst 13, visionOS 1.0, *)
extension SecureBytes {
@usableFromInline
@available(macOS 10.15, iOS 13, watchOS 6, tvOS 13, macCatalyst 13, visionOS 1.0, *)
internal struct BackingHeader {
@usableFromInline
internal var count: Int

@usableFromInline
internal var capacity: Int
}

@usableFromInline
@available(macOS 10.15, iOS 13, watchOS 6, tvOS 13, macCatalyst 13, visionOS 1.0, *)
internal class Backing: ManagedBuffer<BackingHeader, UInt8> {

@usableFromInline
class func createEmpty() -> Backing {
return Backing.create(minimumCapacity: 0, makingHeaderWith: { _ in BackingHeader(count: 0, capacity: 0) }) as! Backing
}

@usableFromInline
class func create(capacity: Int) -> Backing {
let capacity = Int(UInt32(capacity).nextPowerOf2ClampedToMax())
return Backing.create(minimumCapacity: capacity, makingHeaderWith: { _ in BackingHeader(count: 0, capacity: capacity) }) as! Backing
}

@usableFromInline
class func create(copying original: Backing) -> Backing {
return Backing.create(bytes: original)
}

@inlinable
class func create<D: ContiguousBytes>(bytes: D) -> Backing {
return bytes.withUnsafeBytes { bytesPtr in
let backing = Backing.create(capacity: bytesPtr.count)
Expand All @@ -300,7 +273,6 @@ extension SecureBytes {
}
}

@usableFromInline
class func create(randomBytes: Int) -> Backing {
let backing = Backing.create(capacity: randomBytes)
backing._withVeryUnsafeMutableBytes { targetPtr in
Expand All @@ -320,7 +292,6 @@ extension SecureBytes {
}
}

@usableFromInline
var count: Int {
get {
return self.header.count
Expand All @@ -330,7 +301,6 @@ extension SecureBytes {
}
}

@usableFromInline
subscript(offset offset: Int) -> UInt8 {
get {
// precondition(offset >= 0 && offset < self.count)
Expand All @@ -346,7 +316,6 @@ extension SecureBytes {

@available(macOS 10.15, iOS 13, watchOS 6, tvOS 13, macCatalyst 13, visionOS 1.0, *)
extension SecureBytes.Backing {
@usableFromInline
var allocatedCapacity: Int {
#if os(OpenBSD)
return self.header.capacity
Expand Down Expand Up @@ -419,7 +388,6 @@ extension SecureBytes.Backing {
/// Moves the range of bytes identified by the slice by the delta, crashing if the move would
/// place the bytes out of the storage. Note that this does not update the count: external code
/// must ensure that that happens.
@usableFromInline
/* private but usableFromInline */ func _moveBytes(range: Range<Int>, by delta: Int) {
// We have to check that the range is within the delta, as is the new location.
precondition(range.lowerBound >= 0)
Expand All @@ -437,7 +405,6 @@ extension SecureBytes.Backing {
}

// Copies some bytes into the buffer at the appropriate place. Does not update count: external code must do so.
@inlinable
/* private but inlinable */ func _copyBytes<C: Collection>(_ bytes: C, at offset: Int) where C.Element == UInt8 {
precondition(offset >= 0)
precondition(offset + bytes.count <= self.allocatedCapacity)
Expand Down Expand Up @@ -470,7 +437,6 @@ extension SecureBytes.Backing: ContiguousBytes {
}

/// Very unsafe in the sense that this points to uninitialized memory. Used only for implementations within this file.
@inlinable
/* private but inlinable */ func _withVeryUnsafeMutableBytes<T>(_ body: (UnsafeMutableRawBufferPointer) throws -> T) rethrows -> T {
let capacity = self.allocatedCapacity

Expand Down