Adopt Swift 6 and audit for Sendable (#5000) (#5026)

* Adopt Sendable, fix Sendable related warnings, and fix other warnings in both Swift and C code

* Upgrade to Swift 6 - Fix associated warnings

* Remove Sendable annotation from NSAffineTransform

* Cleanup some unused types in Utilities and use a Mutex instead of NSLock

* Remove some warnings for Windows builds

* Add version 6 and warning flags to CMake file

* Adapt to some changes in how unchecked Sendable conformance is declared

* Update swift-foundation dependency

* Update locking strategy for DateFormatter and NumberFormatter - keep the CF type inside the lock

* Add annotations for Core and CFSocketRef

* Resolve a warning in TestDecimal

* Use noncopyable State type for DateFormatter and NumberFormatter

* Mark DirectoryEnumerator as non-Sendable

* Work around compiler crashes when using ~Copyable types

* Clarify comment of _nonSendable with a message explaining the remaining warning

Author: parkera

CMakeLists.txt

@@ -112,6 +112,7 @@ list(APPEND _Foundation_common_build_flags
     "-Wno-unused-function"
     "-Wno-microsoft-enum-forward-reference"
     "-Wno-int-conversion"
+    "-Wno-switch"
     "-fblocks")
 
 if(NOT "${CMAKE_C_SIMULATE_ID}" STREQUAL "MSVC")
@@ -139,8 +140,11 @@ endif()
 # Swift build flags (Foundation, FoundationNetworking, FoundationXML)
 set(_Foundation_swift_build_flags)
 list(APPEND _Foundation_swift_build_flags
+    "-swift-version 6"
     "-DDEPLOYMENT_RUNTIME_SWIFT"
-    "-DSWIFT_CORELIBS_FOUNDATION_HAS_THREADS")
+    "-DSWIFT_CORELIBS_FOUNDATION_HAS_THREADS"
+    "-Xfrontend"
+    "-require-explicit-sendable")
 
 if(CMAKE_SYSTEM_NAME STREQUAL "Linux" OR CMAKE_SYSTEM_NAME STREQUAL "Android")
     list(APPEND _Foundation_common_build_flags

Package.swift

@@ -1,4 +1,4 @@
-// swift-tools-version: 5.9
+// swift-tools-version: 6.0
 // The swift-tools-version declares the minimum version of Swift required to build this package.
 
 import PackageDescription
@@ -21,6 +21,7 @@ let coreFoundationBuildSettings: [CSetting] = [
         "-Wno-unused-function",
         "-Wno-microsoft-enum-forward-reference",
         "-Wno-int-conversion",
+        "-Wno-switch",
         "-fconstant-cfstrings",
         "-fexceptions", // TODO: not on OpenBSD
         "-fdollars-in-identifiers",
@@ -66,6 +67,11 @@ let interfaceBuildSettings: [CSetting] = [
 let swiftBuildSettings: [SwiftSetting] = [
     .define("DEPLOYMENT_RUNTIME_SWIFT"),
     .define("SWIFT_CORELIBS_FOUNDATION_HAS_THREADS"),
+    .swiftLanguageVersion(.v6),
+    .unsafeFlags([
+        "-Xfrontend",
+        "-require-explicit-sendable",
+    ])
 ]
 
 var dependencies: [Package.Dependency] {
@@ -85,7 +91,7 @@ var dependencies: [Package.Dependency] {
                 from: "0.0.9"),
             .package(
                 url: "https://github.com/apple/swift-foundation",
-                revision: "35d896ab47ab5e487cfce822fbe40d2b278c51d6")
+                revision: "d59046871c6b69a13595f18d334afa1553e0ba50")
         ]
     }
 }
@@ -110,6 +116,9 @@ let package = Package(
                 "CoreFoundation"
             ],
             path: "Sources/Foundation",
+            exclude: [
+                "CMakeLists.txt"
+            ],
             swiftSettings: swiftBuildSettings
         ),
         .target(
@@ -121,6 +130,9 @@ let package = Package(
                 "_CFXMLInterface"
             ],
             path: "Sources/FoundationXML",
+            exclude: [
+                "CMakeLists.txt"
+            ],
             swiftSettings: swiftBuildSettings
         ),
         .target(
@@ -132,15 +144,21 @@ let package = Package(
                 "_CFURLSessionInterface"
             ],
             path: "Sources/FoundationNetworking",
-            swiftSettings:swiftBuildSettings
+            exclude: [
+                "CMakeLists.txt"
+            ],
+            swiftSettings: swiftBuildSettings
         ),
         .target(
             name: "CoreFoundation",
             dependencies: [
                 .product(name: "_FoundationICU", package: "swift-foundation-icu"),
             ],
             path: "Sources/CoreFoundation",
-            exclude: ["BlockRuntime"],
+            exclude: [
+                "BlockRuntime",
+                "CMakeLists.txt"
+            ],
             cSettings: coreFoundationBuildSettings
         ),
         .target(
@@ -150,6 +168,9 @@ let package = Package(
                 "Clibxml2",
             ],
             path: "Sources/_CFXMLInterface",
+            exclude: [
+                "CMakeLists.txt"
+            ],
             cSettings: interfaceBuildSettings
         ),
         .target(
@@ -159,6 +180,9 @@ let package = Package(
                 "Clibcurl",
             ],
             path: "Sources/_CFURLSessionInterface",
+            exclude: [
+                "CMakeLists.txt"
+            ],
             cSettings: interfaceBuildSettings
         ),
         .systemLibrary(
@@ -181,6 +205,12 @@ let package = Package(
             name: "plutil",
             dependencies: [
                 "Foundation"
+            ],
+            exclude: [
+                "CMakeLists.txt"
+            ],
+            swiftSettings: [
+                .swiftLanguageVersion(.v6)
             ]
         ),
         .executableTarget(
@@ -189,6 +219,9 @@ let package = Package(
                 "Foundation",
                 "FoundationXML",
                 "FoundationNetworking"
+            ],
+            swiftSettings: [
+                .swiftLanguageVersion(.v6)
             ]
         ),
         .target(
@@ -215,7 +248,8 @@ let package = Package(
                 .copy("Foundation/Resources")
             ],
             swiftSettings: [
-                .define("NS_FOUNDATION_ALLOWS_TESTABLE_IMPORT")
+                .define("NS_FOUNDATION_ALLOWS_TESTABLE_IMPORT"),
+                .swiftLanguageVersion(.v6)
             ]
         ),
     ]

Sources/CoreFoundation/CFBundle_Resources.c

@@ -294,9 +294,9 @@ CF_PRIVATE _CFBundleVersion _CFBundleGetBundleVersionForURL(CFURLRef url) {
                 foundSupportFiles2 = true;
             } else if (fileNameLen == supportFilesDirectoryLength && CFStringCompareWithOptions(fileName, _CFBundleSupportFilesDirectoryName1, CFRangeMake(0, supportFilesDirectoryLength), kCFCompareCaseInsensitive) == kCFCompareEqualTo) {
                 foundSupportFiles1 = true;
-            } else if (fileNameLen == wrapperDirLength && CFStringCompareWithOptions(fileName, _CFBundleWrapperDirectoryName, CFRangeMake(0, wrapperDirLength), kCFCompareEqualTo) == kCFCompareEqualTo) {
+            } else if (fileNameLen == wrapperDirLength && CFStringCompareWithOptions(fileName, _CFBundleWrapperDirectoryName, CFRangeMake(0, wrapperDirLength), 0) == kCFCompareEqualTo) {
                 foundAppWrapperDirectory = true;
-            } else if (fileType == DT_LNK && fileNameLen == wrapperLinkLength && CFStringCompareWithOptions(fileName, _CFBundleWrapperLinkName, CFRangeMake(0, wrapperLinkLength), kCFCompareEqualTo) == kCFCompareEqualTo) {
+            } else if (fileType == DT_LNK && fileNameLen == wrapperLinkLength && CFStringCompareWithOptions(fileName, _CFBundleWrapperLinkName, CFRangeMake(0, wrapperLinkLength), 0) == kCFCompareEqualTo) {
                 foundAppWrapperLink = true;
             }
         } else if (fileType == DT_UNKNOWN) {

Sources/CoreFoundation/CFDate.c

@@ -48,8 +48,11 @@ double __CFTSRRate = 0.0;
 static double __CF1_TSRRate = 0.0;
 
 CF_PRIVATE uint64_t __CFTimeIntervalToTSR(CFTimeInterval ti) {
+#pragma GCC diagnostic push
+#pragma GCC diagnostic ignored "-Wimplicit-const-int-float-conversion"
     if ((ti * __CFTSRRate) > INT64_MAX / 2) return (INT64_MAX / 2);
     return (uint64_t)(ti * __CFTSRRate);
+#pragma GCC diagnostic pop
 }
 
 CF_PRIVATE CFTimeInterval __CFTSRToTimeInterval(uint64_t tsr) {

Sources/CoreFoundation/CFNumber.c

@@ -534,6 +534,8 @@ static Boolean __CFNumberGetValue(CFNumberRef number, CFNumberType type, void *v
 	    }
 	}
 	return true;
+#pragma GCC diagnostic push
+#pragma GCC diagnostic ignored "-Wimplicit-const-int-float-conversion"
     case kCFNumberSInt32Type:
 	if (floatBit) {
 	    if (!storageBit) {
@@ -564,6 +566,7 @@ static Boolean __CFNumberGetValue(CFNumberRef number, CFNumberType type, void *v
 	    }
 	}
 	return true;
+#pragma GCC diagnostic pop
     case kCFNumberSInt128Type:
 	if (floatBit) {
 	    if (!storageBit) {

Sources/CoreFoundation/CFPlatform.c

@@ -1814,6 +1814,7 @@ CF_CROSS_PLATFORM_EXPORT int _CFThreadSetName(_CFThreadRef thread, const char *_
 #endif
 }
 
+// `buf` must be null-terminated
 CF_CROSS_PLATFORM_EXPORT int _CFThreadGetName(char *buf, int length) {
 #if SWIFT_CORELIBS_FOUNDATION_HAS_THREADS
 #if TARGET_OS_MAC

Sources/CoreFoundation/CFPreferences.c

@@ -234,14 +234,20 @@ CFDictionaryRef CFPreferencesCopyMultiple(CFArrayRef keysToFetch, CFStringRef ap
     __CFGenericValidateType(host, CFStringGetTypeID());
 
     domain = _CFPreferencesStandardDomain(appName, user, host);
+#pragma GCC diagnostic push
+#pragma GCC diagnostic ignored "-Wnonnull"
     if (!domain) return NULL;
+#pragma GCC diagnostic pop
     if (!keysToFetch) {
         return _CFPreferencesDomainDeepCopyDictionary(domain);
     } else {
         __CFGenericValidateType(keysToFetch, CFArrayGetTypeID());
         count = CFArrayGetCount(keysToFetch);
         result = CFDictionaryCreateMutable(CFGetAllocator(domain), count, &kCFTypeDictionaryKeyCallBacks, &kCFTypeDictionaryValueCallBacks);
+#pragma GCC diagnostic push
+#pragma GCC diagnostic ignored "-Wnonnull"
         if (!result) return NULL;
+#pragma GCC diagnostic pop
         for (idx = 0; idx < count; idx ++) {
             CFStringRef key = (CFStringRef)CFArrayGetValueAtIndex(keysToFetch, idx);
             CFPropertyListRef value;

Sources/CoreFoundation/CFPropertyList.c

@@ -1587,6 +1587,8 @@ static Boolean parseDictTag(_CFXMLPlistParseInfo * _Nonnull pInfo, CFTypeRef * _
 
 static Boolean parseDataTag(_CFXMLPlistParseInfo *pInfo, CFTypeRef *out) {
     const char *base = pInfo->curr;
+#pragma GCC diagnostic push
+#pragma GCC diagnostic ignored "-Wgnu-folding-constant"
     static const unsigned char dataDecodeTableSize = 128;
     static const signed char dataDecodeTable[dataDecodeTableSize] = {
         /* 000 */ -1, -1, -1, -1, -1, -1, -1, -1,
@@ -1606,7 +1608,7 @@ static Boolean parseDataTag(_CFXMLPlistParseInfo *pInfo, CFTypeRef *out) {
         /* 'p' */ 41, 42, 43, 44, 45, 46, 47, 48,
         /* 'x' */ 49, 50, 51, -1, -1, -1, -1, -1
     };
-    
+#pragma GCC diagnostic pop
     int tmpbufpos = 0;
     int tmpbuflen = 256;
     uint8_t *tmpbuf = pInfo->skip ? NULL : (uint8_t *)CFAllocatorAllocate(pInfo->allocator, tmpbuflen, 0);

Sources/CoreFoundation/CFRelativeDateTimeFormatter.c

@@ -23,7 +23,7 @@ struct __CFRelativeDateTimeFormatter {
     CFRelativeDateTimeFormattingContext _formattingContext;
 };
 
-static UDateRelativeDateTimeFormatterStyle icuRelativeDateTimeStyleFromUnitsStyle(CFRelativeDateTimeFormatterStyle style) {
+static UDateRelativeDateTimeFormatterStyle icuRelativeDateTimeStyleFromUnitsStyle(CFRelativeDateTimeFormatterUnitsStyle style) {
     switch (style) {
         case CFRelativeDateTimeFormatterUnitsStyleSpellOut:
         case CFRelativeDateTimeFormatterUnitsStyleFull:

Sources/CoreFoundation/CFRuntime.c

@@ -1774,11 +1774,15 @@ struct _NSCFXMLBridgeUntyped __NSCFXMLBridgeUntyped = {
   CFDataGetBytePtr,
   CFDictionaryCreateMutable,
   CFDictionarySetValue,
+    // We cannot use the real types here because eventually it winds up exposed as API using CF types in Swift, which we do not want
+#pragma GCC diagnostic push
+#pragma GCC diagnostic ignored "-Wincompatible-pointer-types-discards-qualifiers"
   &kCFAllocatorSystemDefault,
   &kCFAllocatorNull,
   &kCFCopyStringDictionaryKeyCallBacks,
   &kCFTypeDictionaryValueCallBacks,
   &kCFErrorLocalizedDescriptionKey,
+#pragma GCC diagnostic pop
 };
 
 // Call out to the CF-level finalizer, because the object is going to go away.

Sources/CoreFoundation/include/ForSwiftFoundationOnly.h

@@ -35,6 +35,7 @@
 #define NOMINMAX
 #define VC_EXTRALEAN
 #define WIN32_LEAN_AND_MEAN
+#define _CRT_NONSTDC_NO_DEPRECATE
 #include <Windows.h>
 #elif !TARGET_OS_WASI
 #include <fts.h>
@@ -59,6 +60,8 @@
 
 #if TARGET_OS_LINUX
 #include <sys/sysmacros.h>
+#include <fcntl.h>
+#include <sys/stat.h>
 #endif
 
 #if TARGET_OS_ANDROID
@@ -335,10 +338,10 @@ struct _NSCFXMLBridgeUntyped {
     void *kCFErrorLocalizedDescriptionKey;
 };
 
-CF_EXPORT struct _NSCFXMLBridgeStrong __NSCFXMLBridgeStrong;
-CF_EXPORT struct _NSCFXMLBridgeUntyped __NSCFXMLBridgeUntyped;
+CF_EXPORT struct _NSCFXMLBridgeStrong __NSCFXMLBridgeStrong __attribute__((swift_attr("nonisolated(unsafe)")));
+CF_EXPORT struct _NSCFXMLBridgeUntyped __NSCFXMLBridgeUntyped __attribute__((swift_attr("nonisolated(unsafe)")));
 
-CF_EXPORT struct _CFSwiftBridge __CFSwiftBridge;
+CF_EXPORT struct _CFSwiftBridge __CFSwiftBridge __attribute__((swift_attr("nonisolated(unsafe)")));
 
 CF_EXPORT void *_Nullable _CFSwiftRetain(void *_Nullable t);
 CF_EXPORT void _CFSwiftRelease(void *_Nullable t);
@@ -407,7 +410,7 @@ typedef void *_CFThreadSpecificKey;
 #endif
 
 CF_CROSS_PLATFORM_EXPORT Boolean _CFIsMainThread(void);
-CF_EXPORT _CFThreadRef _CFMainPThread;
+CF_EXPORT _CFThreadRef _CFMainPThread __attribute__((swift_attr("nonisolated(unsafe)")));
 
 CF_EXPORT CFHashCode __CFHashDouble(double d);