Merge pull request #82597 from glessard/rdar145487409-inlinearray-plus-mutablespan-62

glessard · web-flow · commit fbe73da41d4e · 2025-07-01T14:10:04.000-07:00
[6.2, stdlib] Remove _withUnsafeBufferPointer APIs on InlineArray
diff --git a/stdlib/public/core/Array.swift b/stdlib/public/core/Array.swift
@@ -1744,9 +1744,9 @@ extension Array {
   }
 
   @available(SwiftStdlib 6.2, *)
+  @_alwaysEmitIntoClient
   public var mutableSpan: MutableSpan<Element> {
     @lifetime(&self)
-    @_alwaysEmitIntoClient
     mutating get {
       // _makeMutableAndUnique*() inserts begin_cow_mutation.
       // LifetimeDependence analysis inserts call to end_cow_mutation_addr since we cannot schedule it in the stdlib for mutableSpan property.
diff --git a/stdlib/public/core/ArraySlice.swift b/stdlib/public/core/ArraySlice.swift
@@ -1301,9 +1301,9 @@ extension ArraySlice {
   }
 
   @available(SwiftStdlib 6.2, *)
+  @_alwaysEmitIntoClient
   public var mutableSpan: MutableSpan<Element> {
-    @lifetime(/*inout*/&self)
-    @_alwaysEmitIntoClient
+    @lifetime(&self)
     mutating get {
       // _makeMutableAndUnique*() inserts begin_cow_mutation.
       // LifetimeDependence analysis inserts call to end_cow_mutation_addr since we cannot schedule it in the stdlib for mutableSpan property.
diff --git a/stdlib/public/core/CollectionOfOne.swift b/stdlib/public/core/CollectionOfOne.swift
@@ -173,9 +173,9 @@ extension CollectionOfOne {
   }
 
   @available(SwiftStdlib 6.2, *)
+  @_alwaysEmitIntoClient
   public var mutableSpan: MutableSpan<Element> {
     @lifetime(&self)
-    @_alwaysEmitIntoClient
     mutating get {
       let pointer = unsafe UnsafeMutablePointer<Element>(
         Builtin.addressOfBorrow(self)
diff --git a/stdlib/public/core/ContiguousArray.swift b/stdlib/public/core/ContiguousArray.swift
@@ -1243,9 +1243,9 @@ extension ContiguousArray {
   }
 
   @available(SwiftStdlib 6.2, *)
+  @_alwaysEmitIntoClient
   public var mutableSpan: MutableSpan<Element> {
     @lifetime(&self)
-    @_alwaysEmitIntoClient
     mutating get {
       // _makeMutableAndUnique*() inserts begin_cow_mutation.
       // LifetimeDependence analysis inserts call to end_cow_mutation_addr since we cannot schedule it in the stdlib for mutableSpan property.
diff --git a/stdlib/public/core/InlineArray.swift b/stdlib/public/core/InlineArray.swift
@@ -80,6 +80,34 @@ extension InlineArray where Element: ~Copyable {
     unsafe UnsafeBufferPointer<Element>(start: _address, count: count)
   }
 
+  /// Returns a pointer to the first element in the array while performing stack
+  /// checking.
+  ///
+  /// Use this when the value of the pointer could potentially be directly used
+  /// by users (e.g. through the use of span or the unchecked subscript).
+  @available(SwiftStdlib 6.2, *)
+  @_alwaysEmitIntoClient
+  @_transparent
+  internal var _protectedAddress: UnsafePointer<Element> {
+#if $AddressOfProperty
+    unsafe UnsafePointer<Element>(Builtin.addressOfBorrow(_storage))
+#else
+    unsafe UnsafePointer<Element>(Builtin.addressOfBorrow(self))
+#endif
+  }
+
+  /// Returns a buffer pointer over the entire array while performing stack
+  /// checking.
+  ///
+  /// Use this when the value of the pointer could potentially be directly used
+  /// by users (e.g. through the use of span or the unchecked subscript).
+  @available(SwiftStdlib 6.2, *)
+  @_alwaysEmitIntoClient
+  @_transparent
+  internal var _protectedBuffer: UnsafeBufferPointer<Element> {
+    unsafe UnsafeBufferPointer<Element>(start: _protectedAddress, count: count)
+  }
+
   /// Returns a mutable pointer to the first element in the array.
   @available(SwiftStdlib 6.2, *)
   @_alwaysEmitIntoClient
@@ -103,6 +131,41 @@ extension InlineArray where Element: ~Copyable {
     }
   }
 
+  /// Returns a mutable pointer to the first element in the array while
+  /// performing stack checking.
+  ///
+  /// Use this when the value of the pointer could potentially be directly used
+  /// by users (e.g. through the use of span or the unchecked subscript).
+  @available(SwiftStdlib 6.2, *)
+  @_alwaysEmitIntoClient
+  @_transparent
+  internal var _protectedMutableAddress: UnsafeMutablePointer<Element> {
+    mutating get {
+#if $AddressOfProperty
+      unsafe UnsafeMutablePointer<Element>(Builtin.addressof(&_storage))
+#else
+      unsafe UnsafeMutablePointer<Element>(Builtin.addressof(&self))
+#endif
+    }
+  }
+
+  /// Returns a mutable buffer pointer over the entire array while performing
+  /// stack checking.
+  ///
+  /// Use this when the value of the pointer could potentially be directly used
+  /// by users (e.g. through the use of span or the unchecked subscript).
+  @available(SwiftStdlib 6.2, *)
+  @_alwaysEmitIntoClient
+  @_transparent
+  internal var _protectedMutableBuffer: UnsafeMutableBufferPointer<Element> {
+    mutating get {
+      unsafe UnsafeMutableBufferPointer<Element>(
+        start: _protectedMutableAddress,
+        count: count
+      )
+    }
+  }
+
   /// Converts the given raw pointer, which points at an uninitialized array
   /// instance, to a mutable buffer suitable for initialization.
   @available(SwiftStdlib 6.2, *)
@@ -407,12 +470,12 @@ extension InlineArray where Element: ~Copyable {
   public subscript(unchecked i: Index) -> Element {
     @_transparent
     unsafeAddress {
-      unsafe _address + i
+      unsafe _protectedAddress + i
     }
 
     @_transparent
     unsafeMutableAddress {
-      unsafe _mutableAddress + i
+      unsafe _protectedMutableAddress + i
     }
   }
 }
@@ -459,53 +522,28 @@ extension InlineArray where Element: ~Copyable {
 
 @available(SwiftStdlib 6.2, *)
 extension InlineArray where Element: ~Copyable {
-
   @available(SwiftStdlib 6.2, *)
+  @_alwaysEmitIntoClient
   public var span: Span<Element> {
     @lifetime(borrow self)
-    @_alwaysEmitIntoClient
+    @_transparent
     borrowing get {
-      let pointer = unsafe _address
-      let span = unsafe Span(_unsafeStart: pointer, count: count)
+      let span = unsafe Span(_unsafeStart: _protectedAddress, count: count)
       return unsafe _overrideLifetime(span, borrowing: self)
     }
   }
 
   @available(SwiftStdlib 6.2, *)
+  @_alwaysEmitIntoClient
   public var mutableSpan: MutableSpan<Element> {
     @lifetime(&self)
-    @_alwaysEmitIntoClient
+    @_transparent
     mutating get {
-      let pointer = unsafe _mutableAddress
-      let span = unsafe MutableSpan(_unsafeStart: pointer, count: count)
+      let span = unsafe MutableSpan(
+        _unsafeStart: _protectedMutableAddress,
+        count: count
+      )
       return unsafe _overrideLifetime(span, mutating: &self)
     }
   }
 }
-
-//===----------------------------------------------------------------------===//
-// MARK: - Unsafe APIs
-//===----------------------------------------------------------------------===//
-
-@available(SwiftStdlib 6.2, *)
-extension InlineArray where Element: ~Copyable {
-  // FIXME: @available(*, deprecated, renamed: "span.withUnsafeBufferPointer(_:)")
-  @available(SwiftStdlib 6.2, *)
-  @_alwaysEmitIntoClient
-  @_transparent
-  public borrowing func _withUnsafeBufferPointer<Result: ~Copyable, E: Error>(
-    _ body: (UnsafeBufferPointer<Element>) throws(E) -> Result
-  ) throws(E) -> Result {
-    try unsafe body(_buffer)
-  }
-
-  // FIXME: @available(*, deprecated, renamed: "mutableSpan.withUnsafeMutableBufferPointer(_:)")
-  @available(SwiftStdlib 6.2, *)
-  @_alwaysEmitIntoClient
-  @_transparent
-  public mutating func _withUnsafeMutableBufferPointer<Result: ~Copyable, E: Error>(
-    _ body: (UnsafeMutableBufferPointer<Element>) throws(E) -> Result
-  ) throws(E) -> Result {
-    try unsafe body(_mutableBuffer)
-  }
-}
diff --git a/stdlib/public/core/UnsafeBufferPointer.swift.gyb b/stdlib/public/core/UnsafeBufferPointer.swift.gyb
@@ -575,21 +575,22 @@ extension Unsafe${Mutable}BufferPointer where Element: ~Copyable {
 
   @unsafe
   @available(SwiftStdlib 6.2, *)
+  @_alwaysEmitIntoClient
   public var span: Span<Element> {
     @lifetime(borrow self)
-    @_alwaysEmitIntoClient
+    @_transparent
     get {
-      let span = unsafe Span(_unsafeElements: self)
-      return unsafe _overrideLifetime(span, borrowing: self)
+      unsafe Span(_unsafeElements: self)
     }
   }
 %if Mutable:
 
   @unsafe
   @available(SwiftStdlib 6.2, *)
+  @_alwaysEmitIntoClient
   public var mutableSpan: MutableSpan<Element> {
     @lifetime(borrow self)
-    @_alwaysEmitIntoClient
+    @_transparent
     get {
       unsafe MutableSpan(_unsafeElements: self)
     }
diff --git a/stdlib/public/core/UnsafeRawBufferPointer.swift.gyb b/stdlib/public/core/UnsafeRawBufferPointer.swift.gyb
@@ -1164,9 +1164,10 @@ extension Unsafe${Mutable}RawBufferPointer {
 
   @unsafe
   @available(SwiftStdlib 6.2, *)
+  @_alwaysEmitIntoClient
   public var mutableBytes: MutableRawSpan {
     @lifetime(borrow self)
-    @_alwaysEmitIntoClient
+    @_transparent
     get {
       unsafe MutableRawSpan(_unsafeBytes: self)
     }
@@ -1184,12 +1185,12 @@ extension Unsafe${Mutable}RawBufferPointer {
 
   @unsafe
   @available(SwiftStdlib 6.2, *)
+  @_alwaysEmitIntoClient
   public var bytes: RawSpan {
     @lifetime(borrow self)
-    @_alwaysEmitIntoClient
+    @_transparent
     get {
-      let span = unsafe RawSpan(_unsafeBytes: self)
-      return unsafe _overrideLifetime(span, borrowing: self)
+      unsafe RawSpan(_unsafeBytes: self)
     }
   }
 }
diff --git a/test/abi/macOS/arm64/stdlib.swift b/test/abi/macOS/arm64/stdlib.swift
@@ -927,15 +927,6 @@ Added: _$ss14MutableRawSpanVN
 Added: _$sSS8UTF8ViewV4spans4SpanVys5UInt8VGvg
 Added: _$sSs8UTF8ViewV4spans4SpanVys5UInt8VGvg
 
-// SE-0467 mutableSpan properties
-Added: _$sSa11mutableSpans07MutableB0VyxGvr
-Added: _$ss10ArraySliceV11mutableSpans07MutableD0VyxGvr
-Added: _$ss15ContiguousArrayV11mutableSpans07MutableD0VyxGvr
-Added: _$ss11InlineArrayVsRi__rlE11mutableSpans07MutableD0Vyq_Gvr
-Added: _$ss15CollectionOfOneV11mutableSpans07MutableE0VyxGvr
-Added: _$sSrsRi_zrlE11mutableSpans07MutableB0VyxGvr
-Added: _$sSw12mutableBytess14MutableRawSpanVvr
-
 // _SwiftifyInfo enum for _SwiftifyImports macro
 Added: _$ss13_SwiftifyExprO5paramyABSicABmFWC
 Added: _$ss13_SwiftifyExprO6returnyA2BmFWC
@@ -1085,3 +1076,8 @@ Added: _$ss8UTF8SpanV9_asciiBits6UInt64VvpZMV
 
 // printing foreign reference types requires a new displayStyle: .foreign
 Added: _$ss6MirrorV12DisplayStyleO16foreignReferenceyA2DmFWC
+
+// var InlineArray._protectedBuffer
+// var InlineArray._protectedAddress
+Added: _$ss11InlineArrayVsRi__rlE16_protectedBufferSRyq_GvpMV
+Added: _$ss11InlineArrayVsRi__rlE17_protectedAddressSPyq_GvpMV
diff --git a/test/abi/macOS/x86_64/stdlib.swift b/test/abi/macOS/x86_64/stdlib.swift
@@ -928,15 +928,6 @@ Added: _$ss14MutableRawSpanVN
 Added: _$sSS8UTF8ViewV4spans4SpanVys5UInt8VGvg
 Added: _$sSs8UTF8ViewV4spans4SpanVys5UInt8VGvg
 
-// SE-0467 mutableSpan properties
-Added: _$sSa11mutableSpans07MutableB0VyxGvr
-Added: _$ss10ArraySliceV11mutableSpans07MutableD0VyxGvr
-Added: _$ss15ContiguousArrayV11mutableSpans07MutableD0VyxGvr
-Added: _$ss11InlineArrayVsRi__rlE11mutableSpans07MutableD0Vyq_Gvr
-Added: _$ss15CollectionOfOneV11mutableSpans07MutableE0VyxGvr
-Added: _$sSrsRi_zrlE11mutableSpans07MutableB0VyxGvr
-Added: _$sSw12mutableBytess14MutableRawSpanVvr
-
 // _SwiftifyInfo enum for _SwiftifyImports macro
 Added: _$ss13_SwiftifyExprO5paramyABSicABmFWC
 Added: _$ss13_SwiftifyExprO6returnyA2BmFWC
@@ -1085,3 +1076,8 @@ Added: _$ss8UTF8SpanV9_asciiBits6UInt64VvpZMV
 
 // printing foreign reference types requires a new displayStyle: .foreign
 Added: _$ss6MirrorV12DisplayStyleO16foreignReferenceyA2DmFWC
+
+// var InlineArray._protectedBuffer
+// var InlineArray._protectedAddress
+Added: _$ss11InlineArrayVsRi__rlE16_protectedBufferSRyq_GvpMV
+Added: _$ss11InlineArrayVsRi__rlE17_protectedAddressSPyq_GvpMV
