Rename pointer bounds (#78210)

* Make pointer bounds non-experimental

* Rename @PointerBounds to @_SwiftifyImport

* Rename filenames containing PointerBounds

* Add _PointerParam exception to stdlib ABI test

* Add _PointerParam to stdlib API changes

* Rename _PointerParam to _SwiftifyInfo

Author: hnrklssn

CMakeLists.txt

@@ -747,10 +747,6 @@ option(SWIFT_ENABLE_EXPERIMENTAL_PARSER_VALIDATION
   "Enable experimental SwiftParser validation by default"
   FALSE)
 
-option(SWIFT_ENABLE_EXPERIMENTAL_POINTER_BOUNDS
-  "Enable experimental safe wrappers around external functions"
-  FALSE)
-
 cmake_dependent_option(SWIFT_BUILD_SOURCEKIT
   "Build SourceKit" TRUE
   "SWIFT_ENABLE_DISPATCH" FALSE)
@@ -1397,7 +1393,6 @@ if(SWIFT_BUILD_STDLIB OR SWIFT_BUILD_SDK_OVERLAY)
   message(STATUS "Observation Support:                ${SWIFT_ENABLE_EXPERIMENTAL_OBSERVATION}")
   message(STATUS "Synchronization Support:            ${SWIFT_ENABLE_SYNCHRONIZATION}")
   message(STATUS "Volatile Support:                   ${SWIFT_ENABLE_VOLATILE}")
-  message(STATUS "Pointer Bounds Support:             ${SWIFT_ENABLE_EXPERIMENTAL_POINTER_BOUNDS}")
   message(STATUS "")
 else()
   message(STATUS "Not building Swift standard library, SDK overlays, and runtime")

Runtimes/Core/CMakeLists.txt

@@ -28,7 +28,6 @@
 # Catalyst Support
 #   -- Will need shadow invocations to generate swiftmodules for Swift parts
 # Install *.abi.json, swiftdoc, and swiftsourceinfo
-# Pointer bounds (SWIFT_ENABLE_EXPERIMENTAL_POINTER_BOUNDS)
 
 cmake_minimum_required(VERSION 3.26...3.29)
 

include/swift/Option/Options.td

@@ -792,11 +792,6 @@ def enable_experimental_concise_pound_file : Flag<["-"],
   Flags<[FrontendOption, ModuleInterfaceOption]>,
   HelpText<"Enable experimental concise '#file' identifier">;
 
-def enable_experimental_bounds_safety_interop :
-  Flag<["-"], "enable-experimental-bounds-safety-interop">,
-  Flags<[NoDriverOption, FrontendOption, HelpHidden, ModuleInterfaceOption]>,
-  HelpText<"Enable experimental C bounds safety interop code generation and config directives">;
-
 def enable_experimental_cxx_interop :
   Flag<["-"], "enable-experimental-cxx-interop">,
   Flags<[NoDriverOption, FrontendOption, HelpHidden]>,

lib/ClangImporter/ImportDecl.cpp

@@ -8673,16 +8673,16 @@ ClangImporter::Implementation::importSwiftAttrAttributes(Decl *MappedDecl) {
 }
 
 namespace {
-class PointerParamInfoPrinter {
+class SwiftifyInfoPrinter {
 public:
   clang::ASTContext &ctx;
   llvm::raw_ostream &out;
   bool firstParam = true;
-  PointerParamInfoPrinter(clang::ASTContext &ctx, llvm::raw_ostream &out)
+  SwiftifyInfoPrinter(clang::ASTContext &ctx, llvm::raw_ostream &out)
       : ctx(ctx), out(out) {
-    out << "@PointerBounds(";
+    out << "@_SwiftifyImport(";
   }
-  ~PointerParamInfoPrinter() { out << ")"; }
+  ~SwiftifyInfoPrinter() { out << ")"; }
 
   void printCountedBy(const clang::CountAttributedType *CAT,
                       size_t pointerIndex) {
@@ -8725,7 +8725,7 @@ void ClangImporter::Implementation::importBoundsAttributes(
   {
     llvm::raw_svector_ostream out(MacroString);
 
-    PointerParamInfoPrinter printer(getClangASTContext(), out);
+    SwiftifyInfoPrinter printer(getClangASTContext(), out);
     for (auto [index, param] : llvm::enumerate(ClangDecl->parameters())) {
       if (auto CAT = param->getType()->getAs<clang::CountAttributedType>()) {
         printer.printCountedBy(CAT, index);

lib/Macros/Sources/SwiftMacros/CMakeLists.txt

@@ -16,7 +16,7 @@ add_swift_macro_library(SwiftMacros
   DistributedResolvableMacro.swift
   SyntaxExtensions.swift
   TaskLocalMacro.swift
-  PointerBoundsMacro.swift
+  SwiftifyImportMacro.swift
   SWIFT_DEPENDENCIES
     SwiftDiagnostics
     SwiftSyntax

lib/Macros/Sources/SwiftMacros/PointerBoundsMacro.swift renamed to lib/Macros/Sources/SwiftMacros/SwiftifyImportMacro.swift

@@ -461,12 +461,12 @@ func getParameterIndexForDeclRef(
 /// Intended to map to C attributes like __counted_by, __ended_by and __no_escape,
 /// for automatic application by ClangImporter when the C declaration is annotated
 /// appropriately.
-public struct PointerBoundsMacro: PeerMacro {
+public struct SwiftifyImportMacro: PeerMacro {
   static func parseEnumName(_ enumConstructorExpr: FunctionCallExprSyntax) throws -> String {
     guard let calledExpr = enumConstructorExpr.calledExpression.as(MemberAccessExprSyntax.self)
     else {
       throw DiagnosticError(
-        "expected PointerParam enum literal as argument, got '\(enumConstructorExpr)'",
+        "expected _SwiftifyInfo enum literal as argument, got '\(enumConstructorExpr)'",
         node: enumConstructorExpr)
     }
     return calledExpr.declName.baseName.text
@@ -564,7 +564,7 @@ public struct PointerBoundsMacro: PeerMacro {
     let paramExpr = paramAST.expression
     guard let enumConstructorExpr = paramExpr.as(FunctionCallExprSyntax.self) else {
       throw DiagnosticError(
-        "expected PointerParam enum literal as argument, got '\(paramExpr)'", node: paramExpr)
+        "expected _SwiftifyInfo enum literal as argument, got '\(paramExpr)'", node: paramExpr)
     }
     let enumName = try parseEnumName(enumConstructorExpr)
     switch enumName {
@@ -627,7 +627,7 @@ public struct PointerBoundsMacro: PeerMacro {
       }
       if argByIndex[i] != nil {
         throw DiagnosticError(
-          "multiple PointerParams referring to parameter with index "
+          "multiple _SwiftifyInfos referring to parameter with index "
             + "\(i): \(pointerArg) and \(argByIndex[i]!)", node: pointerArg.original)
       }
       argByIndex[i] = pointerArg
@@ -647,7 +647,7 @@ public struct PointerBoundsMacro: PeerMacro {
   ) throws -> [DeclSyntax] {
     do {
       guard let funcDecl = declaration.as(FunctionDeclSyntax.self) else {
-        throw DiagnosticError("@PointerBounds only works on functions", node: declaration)
+        throw DiagnosticError("@_SwiftifyImport only works on functions", node: declaration)
       }
 
       let argumentList = node.arguments!.as(LabeledExprListSyntax.self)!
@@ -692,7 +692,7 @@ public struct PointerBoundsMacro: PeerMacro {
             case .attribute(let attr):
               // don't apply this macro recursively, and avoid dupe _alwaysEmitIntoClient
               let name = attr.attributeName.as(IdentifierTypeSyntax.self)?.name.text
-              return name == nil || (name != "PointerBounds" && name != "_alwaysEmitIntoClient")
+              return name == nil || (name != "_SwiftifyImport" && name != "_alwaysEmitIntoClient")
             default: return true
             }
           } + [

stdlib/cmake/modules/SwiftSource.cmake

@@ -326,10 +326,6 @@ function(_add_target_variant_swift_compile_flags
     list(APPEND result "-D" "SWIFT_ENABLE_EXPERIMENTAL_OBSERVATION")
   endif()
 
-  if(SWIFT_ENABLE_EXPERIMENTAL_POINTER_BOUNDS)
-    list(APPEND result "-D" "SWIFT_ENABLE_EXPERIMENTAL_POINTER_BOUNDS")
-  endif()
-
   if(SWIFT_ENABLE_SYNCHRONIZATION)
     list(APPEND result "-D" "SWIFT_ENABLE_SYNCHRONIZATION")
   endif()

stdlib/public/core/CMakeLists.txt

@@ -230,6 +230,7 @@ split_embedded_sources(
   EMBEDDED Int128.swift
   EMBEDDED Mirror.swift
     NORMAL PlaygroundDisplay.swift
+  EMBEDDED SwiftifyImport.swift
     NORMAL CommandLine.swift
   EMBEDDED SliceBuffer.swift
   EMBEDDED StaticBigInt.swift
@@ -263,11 +264,6 @@ if(SWIFT_STDLIB_ENABLE_VECTOR_TYPES)
   list(APPEND SWIFTLIB_EMBEDDED_GYB_SOURCES SIMDConcreteOperations.swift.gyb SIMDVectorTypes.swift.gyb)
 endif()
 
-if (SWIFT_ENABLE_EXPERIMENTAL_POINTER_BOUNDS)
-  list(APPEND SWIFTLIB_SOURCES PointerBounds.swift)
-  list(APPEND SWIFTLIB_EMBEDDED_SOURCES PointerBounds.swift)
-endif()
-
 # Freestanding and Linux/Android builds both have failures to resolve.
 if(NOT BOOTSTRAPPING_MODE STREQUAL "OFF" AND NOT SWIFT_FREESTANDING_FLAVOR AND NOT SWIFT_HOST_VARIANT_SDK STREQUAL "LINUX" AND NOT SWIFT_HOST_VARIANT_SDK STREQUAL "ANDROID")
   list(APPEND SWIFTLIB_SOURCES ObjectIdentifier+DebugDescription.swift)

stdlib/public/core/GroupInfo.json

@@ -190,7 +190,7 @@
   ],
   "Pointer": [
     "Pointer.swift",
-    "PointerBounds.swift",
+    "SwiftifyImport.swift",
     "TemporaryAllocation.swift",
     "UnsafePointer.swift",
     "UnsafeRawPointer.swift",

stdlib/public/core/PointerBounds.swift renamed to stdlib/public/core/SwiftifyImport.swift

@@ -1,9 +1,13 @@
-/// Different ways to annotate pointer parameters using the `@PointerBounds` macro.
+/// Different ways to annotate pointer parameters using the `@_SwiftifyImport` macro.
 /// All indices into parameter lists start at 1. Indices __must__ be integer literals, and strings
-/// __must__ be string literals, because their contents are parsed by the `@PointerBounds` macro.
+/// __must__ be string literals, because their contents are parsed by the `@_SwiftifyImport` macro.
 /// Only 1 instance of `countedBy`, `sizedBy` or `endedBy` can refer to each pointer index, however
 /// `nonescaping` is orthogonal to the rest and can (and should) overlap with other annotations.
-public enum PointerParam {
+///
+/// This is not marked @available, because _SwiftifyImport is available for any target. Instances
+/// of _SwiftifyInfo should ONLY be passed as arguments directly to _SwiftifyImport, so they should
+/// not affect linkage since there are never any instances at runtime.
+public enum _SwiftifyInfo {
     /// Corresponds to the C `__counted_by(count)` attribute.
     /// Parameter pointer: index of pointer in function parameter list. Must be of type
     /// `Unsafe[Mutable]Pointer<T>[?]`, i.e. not an `UnsafeRawPointer`.
@@ -40,5 +44,5 @@ public enum PointerParam {
 /// Parameter paramInfo: information about how the function uses the pointer passed to it. The
 /// safety of the generated wrapper function depends on this info being extensive and accurate.
 @attached(peer, names: overloaded)
-public macro PointerBounds(_ paramInfo: PointerParam...) =
-    #externalMacro(module: "SwiftMacros", type: "PointerBoundsMacro")
+public macro _SwiftifyImport(_ paramInfo: _SwiftifyInfo...) =
+    #externalMacro(module: "SwiftMacros", type: "SwiftifyImportMacro")