Merge pull request #84841 from hnrklssn/swiftify-return-opaque

[Swiftify] Cast OpaquePointer to UnsafeRawPointer before RawSpan

Author: hnrklssn

lib/Macros/Sources/SwiftMacros/SwiftifyImportMacro.swift

@@ -349,6 +349,16 @@ func transformType(
   return mainType
 }
 
+func peelOptionalType(_ type: TypeSyntax) -> TypeSyntax {
+  if let optType = type.as(OptionalTypeSyntax.self) {
+    return optType.wrappedType
+  }
+  if let impOptType = type.as(ImplicitlyUnwrappedOptionalTypeSyntax.self) {
+    return impOptType.wrappedType
+  }
+  return type
+}
+
 func isMutablePointerType(_ type: TypeSyntax) -> Bool {
   if let optType = type.as(OptionalTypeSyntax.self) {
     return isMutablePointerType(optType.wrappedType)
@@ -757,21 +767,30 @@ struct CountedOrSizedReturnPointerThunkBuilder: PointerBoundsThunkBuilder {
           if unsafe _resultValue == nil {
             return nil
           } else {
-            return unsafe _swiftifyOverrideLifetime(\(raw: cast)(\(raw: startLabel): _resultValue!, \(raw: countLabel): Int(\(countExpr))), copying: ())
+            return unsafe _swiftifyOverrideLifetime(\(raw: cast)(\(raw: startLabel): \(raw: castOpaquePointerToRawPointer("_resultValue!")), \(raw: countLabel): Int(\(countExpr))), copying: ())
           }
         }()
         """
     } else {
       expr =
         """
-        \(raw: cast)(\(raw: startLabel): \(call), \(raw: countLabel): Int(\(countExpr)))
+        \(raw: cast)(\(raw: startLabel): \(castOpaquePointerToRawPointer(call)), \(raw: countLabel): Int(\(countExpr)))
         """
     }
     if generateSpan {
       expr = "_swiftifyOverrideLifetime(\(expr), copying: ())"
     }
     return "unsafe \(expr)"
   }
+
+  func castOpaquePointerToRawPointer(_ expr: ExprSyntax) -> ExprSyntax {
+    let type = peelOptionalType(oldType)
+    if type.canRepresentBasicType(type: OpaquePointer.self) {
+      return ExprSyntax("unsafe UnsafeRawPointer(\(expr))")
+    }
+    return expr
+  }
+
 }
 
 struct CountedOrSizedPointerThunkBuilder: ParamBoundsThunkBuilder, PointerBoundsThunkBuilder {
@@ -897,16 +916,6 @@ struct CountedOrSizedPointerThunkBuilder: ParamBoundsThunkBuilder, PointerBounds
     return "_\(raw: name)Count"
   }
 
-  func peelOptionalType(_ type: TypeSyntax) -> TypeSyntax {
-    if let optType = type.as(OptionalTypeSyntax.self) {
-      return optType.wrappedType
-    }
-    if let impOptType = type.as(ImplicitlyUnwrappedOptionalTypeSyntax.self) {
-      return impOptType.wrappedType
-    }
-    return type
-  }
-
   func castPointerToTargetType(_ baseAddress: ExprSyntax) throws -> ExprSyntax {
     let type = peelOptionalType(getParam(signature, index).type)
     if type.canRepresentBasicType(type: OpaquePointer.self) {

test/Macros/SwiftifyImport/SizedBy/OpaqueReturn.swift

@@ -0,0 +1,107 @@
+// REQUIRES: swift_swift_parser
+
+// RUN: %empty-directory(%t)
+// RUN: split-file %s %t
+// RUN: %target-swift-frontend %t/test.swift -typecheck -plugin-path %swift-plugin-dir -strict-memory-safety -verify
+// RUN: %target-swift-frontend %t/test.swift -typecheck -plugin-path %swift-plugin-dir -strict-memory-safety -dump-macro-expansions 2> %t/tmp.txt
+// RUN: %FileCheck --dry-run --ignore-runtime-warnings > %t/expansions.txt < %t/tmp.txt
+// RUN: diff --strip-trailing-cr %t/expansions.txt %t/expansions.txt.expected
+
+//--- test.swift
+@_SwiftifyImport(.sizedBy(pointer: .return, size: "size"))
+public func nonnullUnsafeRawBufferPointer(_ size: CInt) -> OpaquePointer {}
+
+@_SwiftifyImport(.sizedBy(pointer: .return, size: "size"))
+public func nullableUnsafeRawBufferPointer(_ size: CInt) -> OpaquePointer? {}
+
+@_SwiftifyImport(.sizedBy(pointer: .return, size: "size"))
+public func impNullableUnsafeRawBufferPointer(_ size: CInt) -> OpaquePointer! {}
+
+@_SwiftifyImport(.sizedBy(pointer: .return, size: "size"), .sizedBy(pointer: .param(1), size: "size"), .lifetimeDependence(dependsOn: .param(1), pointer: .return, type: .copy))
+public func nonnullSpan(p: OpaquePointer, size: CInt) -> OpaquePointer {}
+
+@_SwiftifyImport(.sizedBy(pointer: .return, size: "size"), .sizedBy(pointer: .param(1), size: "size"), .lifetimeDependence(dependsOn: .param(1), pointer: .return, type: .copy))
+public func nullableSpan(p: OpaquePointer?, _ size: CInt) -> OpaquePointer? {}
+
+@_SwiftifyImport(.sizedBy(pointer: .return, size: "size"), .sizedBy(pointer: .param(1), size: "size"), .lifetimeDependence(dependsOn: .param(1), pointer: .return, type: .copy))
+public func impNullableSpan(p: OpaquePointer!, _ size: CInt) -> OpaquePointer! {}
+
+//--- expansions.txt.expected
+@__swiftmacro_4test29nonnullUnsafeRawBufferPointer15_SwiftifyImportfMp_.swift
+------------------------------
+/// This is an auto-generated wrapper for safer interop
+@_alwaysEmitIntoClient @_disfavoredOverload
+public func nonnullUnsafeRawBufferPointer(_ size: CInt) -> UnsafeRawBufferPointer {
+    return unsafe UnsafeRawBufferPointer(start: unsafe UnsafeRawPointer(unsafe nonnullUnsafeRawBufferPointer(size)), count: Int(size))
+}
+------------------------------
+@__swiftmacro_4test30nullableUnsafeRawBufferPointer15_SwiftifyImportfMp_.swift
+------------------------------
+/// This is an auto-generated wrapper for safer interop
+@_alwaysEmitIntoClient @_disfavoredOverload
+public func nullableUnsafeRawBufferPointer(_ size: CInt) -> UnsafeRawBufferPointer? {
+    return unsafe { () in
+      let _resultValue = unsafe nullableUnsafeRawBufferPointer(size)
+      if unsafe _resultValue == nil {
+        return nil
+      } else {
+        return unsafe _swiftifyOverrideLifetime(UnsafeRawBufferPointer(start: unsafe UnsafeRawPointer(_resultValue!), count: Int(size)), copying: ())
+      }
+    }()
+}
+------------------------------
+@__swiftmacro_4test33impNullableUnsafeRawBufferPointer15_SwiftifyImportfMp_.swift
+------------------------------
+/// This is an auto-generated wrapper for safer interop
+@_alwaysEmitIntoClient @_disfavoredOverload
+public func impNullableUnsafeRawBufferPointer(_ size: CInt) -> UnsafeRawBufferPointer {
+    return unsafe UnsafeRawBufferPointer(start: unsafe UnsafeRawPointer(unsafe impNullableUnsafeRawBufferPointer(size)), count: Int(size))
+}
+------------------------------
+@__swiftmacro_4test11nonnullSpan15_SwiftifyImportfMp_.swift
+------------------------------
+/// This is an auto-generated wrapper for safer interop
+@_alwaysEmitIntoClient @_lifetime(copy p) @_disfavoredOverload
+public func nonnullSpan(p: RawSpan) -> RawSpan {
+    let size = CInt(exactly: p.byteCount)!
+    return unsafe _swiftifyOverrideLifetime(RawSpan(_unsafeStart: unsafe UnsafeRawPointer(unsafe p.withUnsafeBytes { _pPtr in
+      return unsafe nonnullSpan(p: OpaquePointer(_pPtr.baseAddress!), size: size)
+                }), byteCount: Int(size)), copying: ())
+}
+------------------------------
+@__swiftmacro_4test12nullableSpan15_SwiftifyImportfMp_.swift
+------------------------------
+/// This is an auto-generated wrapper for safer interop
+@_alwaysEmitIntoClient @_lifetime(copy p) @_disfavoredOverload
+public func nullableSpan(p: RawSpan?) -> RawSpan? {
+    let size = CInt(exactly: p?.byteCount ?? 0)!
+    return unsafe _swiftifyOverrideLifetime({ () in
+      let _resultValue = { () in
+              return if p == nil {
+                  unsafe nullableSpan(p: nil, size)
+                } else {
+                  unsafe p!.withUnsafeBytes { _pPtr in
+                    return unsafe nullableSpan(p: OpaquePointer(_pPtr.baseAddress), size)
+                  }
+                }
+          }()
+      if unsafe _resultValue == nil {
+        return nil
+      } else {
+        return unsafe _swiftifyOverrideLifetime(RawSpan(_unsafeStart: unsafe UnsafeRawPointer(_resultValue!), byteCount: Int(size)), copying: ())
+      }
+        }(), copying: ())
+}
+------------------------------
+@__swiftmacro_4test15impNullableSpan15_SwiftifyImportfMp_.swift
+------------------------------
+/// This is an auto-generated wrapper for safer interop
+@_alwaysEmitIntoClient @_lifetime(copy p) @_disfavoredOverload
+public func impNullableSpan(p: RawSpan) -> RawSpan {
+    let size = CInt(exactly: p.byteCount)!
+    return unsafe _swiftifyOverrideLifetime(RawSpan(_unsafeStart: unsafe UnsafeRawPointer(unsafe p.withUnsafeBytes { _pPtr in
+      return unsafe impNullableSpan(p: OpaquePointer(_pPtr.baseAddress!), size)
+                }), byteCount: Int(size)), copying: ())
+}
+------------------------------
+