Merge pull request #77836 from michael-yuji/mchiu/freebsd

[FreeBSD] Adding FreeBSD support

Author: michael-yuji

CMakeLists.txt

@@ -1071,6 +1071,8 @@ elseif(CMAKE_SYSTEM_NAME STREQUAL "Darwin")
   set(SWIFT_USE_LINKER_default "")
 elseif(DISTRO_NAME STREQUAL "Amazon Linux 2023")
   set(SWIFT_USE_LINKER_default "lld")
+elseif(CMAKE_SYSTEM_NAME STREQUAL "FreeBSD")
+	set(SWIFT_USE_LINKER_default "lld")
 else()
   get_gold_version(gold_version)
   if(NOT gold_version)

include/swift/AST/AutoDiff.h

@@ -422,7 +422,14 @@ class DerivativeFunctionTypeError
   Kind kind;
 
   /// The type and index of a differentiability parameter or result.
-  using TypeAndIndex = std::pair<Type, unsigned>;
+  /// std::pair does not have a trivial copy constructor on FreeBSD for
+  /// ABI reasons, so we have to define our own type here instead
+  struct TypeAndIndex {
+    Type first;
+    unsigned second;
+
+    TypeAndIndex(Type type, unsigned index) : first(type), second(index) {}
+  };
 
 private:
   union Value {

include/swift/AST/PlatformKinds.def

@@ -34,6 +34,7 @@ AVAILABILITY_PLATFORM(visionOSApplicationExtension, "application extensions for
 AVAILABILITY_PLATFORM(macOSApplicationExtension, "application extensions for macOS")
 AVAILABILITY_PLATFORM(macCatalyst, "Mac Catalyst")
 AVAILABILITY_PLATFORM(macCatalystApplicationExtension, "application extensions for Mac Catalyst")
+AVAILABILITY_PLATFORM(FreeBSD, "FreeBSD")
 AVAILABILITY_PLATFORM(OpenBSD, "OpenBSD")
 AVAILABILITY_PLATFORM(Windows, "Windows")
 

include/swift/SILOptimizer/Differentiation/DifferentiationInvoker.h

@@ -71,10 +71,17 @@ struct DifferentiationInvoker {
 
     /// The parent `apply` instruction and the witness associated with the
     /// `IndirectDifferentiation` case.
-    std::pair<ApplyInst *, SILDifferentiabilityWitness *>
-        indirectDifferentiation;
+    /// Note: This used to be a std::pair, but on FreeBSD, libc++ is
+    /// configured with _LIBCPP_DEPRECATED_ABI_DISABLE_PAIR_TRIVIAL_COPY_CTOR
+    /// and hence does not have a trivial copy constructor
+    struct IndirectDifferentiation {
+      ApplyInst *applyInst;
+      SILDifferentiabilityWitness *witness;
+    };
+    IndirectDifferentiation indirectDifferentiation;
+
     Value(ApplyInst *applyInst, SILDifferentiabilityWitness *witness)
-        : indirectDifferentiation({applyInst, witness}) {}
+      : indirectDifferentiation({applyInst, witness}) {}
 
     /// The witness associated with the `SILDifferentiabilityWitnessInvoker`
     /// case.
@@ -111,7 +118,8 @@ struct DifferentiationInvoker {
   std::pair<ApplyInst *, SILDifferentiabilityWitness *>
   getIndirectDifferentiation() const {
     assert(kind == Kind::IndirectDifferentiation);
-    return value.indirectDifferentiation;
+    return std::make_pair(value.indirectDifferentiation.applyInst,
+                          value.indirectDifferentiation.witness);
   }
 
   SILDifferentiabilityWitness *getSILDifferentiabilityWitnessInvoker() const {

lib/AST/PlatformKind.cpp

@@ -116,6 +116,7 @@ swift::basePlatformForExtensionPlatform(PlatformKind Platform) {
   case PlatformKind::tvOS:
   case PlatformKind::watchOS:
   case PlatformKind::visionOS:
+  case PlatformKind::FreeBSD:
   case PlatformKind::OpenBSD:
   case PlatformKind::Windows:
   case PlatformKind::none:
@@ -160,6 +161,8 @@ static bool isPlatformActiveForTarget(PlatformKind Platform,
       return Target.isXROS();
     case PlatformKind::OpenBSD:
       return Target.isOSOpenBSD();
+    case PlatformKind::FreeBSD:
+      return Target.isOSFreeBSD();
     case PlatformKind::Windows:
       return Target.isOSWindows();
     case PlatformKind::none:
@@ -283,6 +286,8 @@ swift::tripleOSTypeForPlatform(PlatformKind platform) {
   case PlatformKind::visionOS:
   case PlatformKind::visionOSApplicationExtension:
     return llvm::Triple::XROS;
+  case PlatformKind::FreeBSD:
+    return llvm::Triple::FreeBSD;
   case PlatformKind::OpenBSD:
     return llvm::Triple::OpenBSD;
   case PlatformKind::Windows:
@@ -320,6 +325,7 @@ bool swift::isPlatformSPI(PlatformKind Platform) {
   case PlatformKind::visionOS:
   case PlatformKind::visionOSApplicationExtension:
   case PlatformKind::OpenBSD:
+  case PlatformKind::FreeBSD:
   case PlatformKind::Windows:
   case PlatformKind::none:
     return false;

lib/AST/Type.cpp

@@ -4843,7 +4843,8 @@ AnyFunctionType::getAutoDiffDerivativeFunctionLinearMapType(
     if (!resultTan)
       return llvm::make_error<DerivativeFunctionTypeError>(
         this, DerivativeFunctionTypeError::Kind::NonDifferentiableResult,
-        std::make_pair(originalResultType, unsigned(originalResult.index)));
+        DerivativeFunctionTypeError::TypeAndIndex(
+          originalResultType, unsigned(originalResult.index)));
 
     if (!originalResult.isSemanticResultParameter)
       resultTanTypes.push_back(resultTan->getType());
@@ -4873,7 +4874,7 @@ AnyFunctionType::getAutoDiffDerivativeFunctionLinearMapType(
             this,
             DerivativeFunctionTypeError::Kind::
                 NonDifferentiableDifferentiabilityParameter,
-            std::make_pair(paramType, i));
+            DerivativeFunctionTypeError::TypeAndIndex(paramType, i));
 
       differentialParams.push_back(AnyFunctionType::Param(
           paramTan->getType(), Identifier(), diffParam.getParameterFlags()));
@@ -4921,7 +4922,7 @@ AnyFunctionType::getAutoDiffDerivativeFunctionLinearMapType(
             this,
             DerivativeFunctionTypeError::Kind::
                 NonDifferentiableDifferentiabilityParameter,
-            std::make_pair(paramType, i));
+            DerivativeFunctionTypeError::TypeAndIndex(paramType, i));
 
       if (diffParam.isAutoDiffSemanticResult()) {
         if (paramType->isVoid())

lib/ClangImporter/ClangImporter.cpp

@@ -2557,6 +2557,10 @@ PlatformAvailability::PlatformAvailability(const LangOptions &langOpts)
   case PlatformKind::visionOSApplicationExtension:
     break;
 
+  case PlatformKind::FreeBSD:
+    deprecatedAsUnavailableMessage = "";
+    break;
+
   case PlatformKind::OpenBSD:
     deprecatedAsUnavailableMessage = "";
     break;
@@ -2604,6 +2608,9 @@ bool PlatformAvailability::isPlatformRelevant(StringRef name) const {
     return name == "xros" || name == "xros_app_extension" ||
            name == "visionos" || name == "visionos_app_extension";
 
+  case PlatformKind::FreeBSD:
+    return name == "freebsd";
+
   case PlatformKind::OpenBSD:
     return name == "openbsd";
 
@@ -2675,6 +2682,10 @@ bool PlatformAvailability::treatDeprecatedAsUnavailable(
     // No deprecation filter on xrOS
     return false;
 
+  case PlatformKind::FreeBSD:
+    // No deprecation filter on FreeBSD
+    return false;
+
   case PlatformKind::OpenBSD:
     // No deprecation filter on OpenBSD
     return false;

lib/IRGen/TBDGen.cpp

@@ -245,6 +245,8 @@ getLinkerPlatformId(OriginallyDefinedInAttr::ActiveVersion Ver,
   switch(Ver.Platform) {
   case swift::PlatformKind::none:
     llvm_unreachable("cannot find platform kind");
+  case swift::PlatformKind::FreeBSD:
+    llvm_unreachable("not used for this platform");
   case swift::PlatformKind::OpenBSD:
     llvm_unreachable("not used for this platform");
   case swift::PlatformKind::Windows:

lib/Option/SanitizerOptions.cpp

@@ -168,7 +168,7 @@ OptionSet<SanitizerKind> swift::parseSanitizerArgValues(
   }
 
   // Check that we're one of the known supported targets for sanitizers.
-  if (!(Triple.isOSDarwin() || Triple.isOSLinux() || Triple.isOSWindows() || Triple.isOSWASI())) {
+  if (!(Triple.isOSDarwin() || Triple.isOSLinux() || Triple.isOSWindows() || Triple.isOSWASI() || Triple.isOSFreeBSD())) {
     SmallString<128> b;
     Diags.diagnose(SourceLoc(), diag::error_unsupported_opt_for_target,
       (A->getOption().getPrefixedName() +

lib/PrintAsClang/DeclAndTypePrinter.cpp

@@ -1795,6 +1795,9 @@ class DeclAndTypePrinter::Implementation
       case PlatformKind::visionOSApplicationExtension:
         plat = "visionos_app_extension";
         break;
+      case PlatformKind::FreeBSD:
+        plat = "freebsd";
+        break;
       case PlatformKind::OpenBSD:
         plat = "openbsd";
         break;

lib/SymbolGraphGen/AvailabilityMixin.cpp

@@ -54,6 +54,8 @@ StringRef getDomain(const SemanticAvailableAttr &AvAttr) {
       return { "watchOSAppExtension" };
     case swift::PlatformKind::visionOSApplicationExtension:
       return { "visionOSAppExtension" };
+    case swift::PlatformKind::FreeBSD:
+      return { "FreeBSD" };
     case swift::PlatformKind::OpenBSD:
       return { "OpenBSD" };
     case swift::PlatformKind::Windows:

stdlib/public/Cxx/std/CMakeLists.txt

@@ -63,7 +63,7 @@ add_swift_target_library(swiftCxxStdlib STATIC NO_LINK_NAME IS_STDLIB IS_SWIFT_O
     DEPLOYMENT_VERSION_XROS ${COMPATIBILITY_MINIMUM_DEPLOYMENT_VERSION_XROS}
 
     LINK_FLAGS "${SWIFT_RUNTIME_SWIFT_LINK_FLAGS}"
-    TARGET_SDKS ALL_APPLE_PLATFORMS LINUX LINUX_STATIC WINDOWS ANDROID
+    TARGET_SDKS ALL_APPLE_PLATFORMS LINUX LINUX_STATIC WINDOWS ANDROID FREEBSD
     MACCATALYST_BUILD_FLAVOR zippered
     INSTALL_IN_COMPONENT compiler
     INSTALL_BINARY_SWIFTMODULE NON_DARWIN_ONLY

stdlib/public/Platform/Platform.swift

@@ -236,12 +236,12 @@ public func ioctl(
 // signal.h
 //===----------------------------------------------------------------------===//
 
-#if os(OpenBSD)
+#if os(OpenBSD) || os(FreeBSD)
 public var SIG_DFL: sig_t? { return nil }
 public var SIG_IGN: sig_t { return unsafeBitCast(1, to: sig_t.self) }
 public var SIG_ERR: sig_t { return unsafeBitCast(-1, to: sig_t.self) }
 public var SIG_HOLD: sig_t { return unsafeBitCast(3, to: sig_t.self) }
-#elseif os(Linux) || os(FreeBSD) || os(PS4) || os(Android) || os(Haiku)
+#elseif os(Linux) || os(PS4) || os(Android) || os(Haiku)
 #if !canImport(SwiftMusl)
 public typealias sighandler_t = __sighandler_t
 #endif
@@ -384,3 +384,9 @@ public var environ: UnsafeMutablePointer<UnsafeMutablePointer<CChar>?> {
 }
 #endif
 #endif // SWIFT_STDLIB_HAS_ENVIRON
+
+#if os(FreeBSD)
+@inlinable public func inet_pton(_ af: CInt, _ src: UnsafePointer<CChar>!, _ dst: UnsafeMutableRawPointer!) -> CInt {
+  __inet_pton(af, src, dst)
+}
+#endif

stdlib/public/Platform/SwiftGlibc.h.gyb

@@ -57,6 +57,7 @@ headers = [
   'nl_types.h',
   'poll.h',
   'pthread.h',
+  'pthread_np.h',
   'pwd.h',
   'regex.h',
   'sched.h',
@@ -65,6 +66,7 @@ headers = [
   'spawn.h',
   'strings.h',
   'sys/event.h',
+  'sys/extattr.h',
   'sys/file.h',
   'sys/inotify.h',
   'sys/ioctl.h',
@@ -84,6 +86,7 @@ headers = [
   'sys/times.h',
   'sys/types.h',
   'sys/uio.h',
+  'sys/umtx.h',
   'sys/un.h',
   'sys/user.h',
   'sys/utsname.h',

stdlib/public/Platform/glibc.modulemap.gyb

@@ -19,7 +19,7 @@
 /// It's not named just Glibc so that it doesn't conflict in the event of a
 /// future official glibc modulemap.
 module SwiftGlibc [system] {
-% if CMAKE_SDK in ["LINUX", "OPENBSD"]:
+% if CMAKE_SDK in ["LINUX", "FREEBSD", "OPENBSD"]:
       link "m"
 % end
 % if CMAKE_SDK in ["LINUX", "FREEBSD", "OPENBSD", "CYGWIN"]:

stdlib/public/SwiftShims/swift/shims/SwiftStdint.h

@@ -24,7 +24,7 @@
 
 // Clang has been defining __INTxx_TYPE__ macros for a long time.
 // __UINTxx_TYPE__ are defined only since Clang 3.5.
-#if !defined(__APPLE__) && !defined(__linux__) && !defined(__OpenBSD__) && !defined(__wasi__) && !defined(__swift_embedded__)
+#if !defined(__APPLE__) && !defined(__linux__) && !defined(__OpenBSD__) && !defined(__FreeBSD__) && !defined(__wasi__) && !defined(__swift_embedded__)
 #include <stdint.h>
 typedef int64_t __swift_int64_t;
 typedef uint64_t __swift_uint64_t;

stdlib/public/SwiftShims/swift/shims/_SynchronizationShims.h

@@ -66,4 +66,9 @@ static inline __swift_uint32_t _swift_stdlib_futex_unlock(__swift_uint32_t *lock
 
 #endif // defined(__linux__)
 
+#if defined(__FreeBSD__)
+#include <sys/types.h>
+#include <sys/umtx.h>
+#endif
+
 #endif // SWIFT_STDLIB_SYNCHRONIZATION_SHIMS_H

stdlib/public/Synchronization/CMakeLists.txt

@@ -59,6 +59,13 @@ set(SWIFT_SYNCHRONIZATION_LINUX_SOURCES
   Mutex/SpinLoopHint.swift
 )
 
+# FreeBSD sources
+
+set(SWIFT_SYNCHRONIZATION_FREEBSD_SOURCES
+  Mutex/FreeBSDImpl.swift
+  Mutex/Mutex.swift
+)
+
 # Wasm sources
 
 set(SWIFT_SYNCHRONIZATION_WASM_SOURCES
@@ -106,6 +113,8 @@ add_swift_target_library(swiftSynchronization ${SWIFT_STDLIB_LIBRARY_BUILD_TYPES
     ${SWIFT_SYNCHRONIZATION_WASM_SOURCES}
   SWIFT_SOURCES_DEPENDS_WINDOWS
     ${SWIFT_SYNCHRONIZATION_WINDOWS_SOURCES}
+  SWIFT_SOURCES_DEPENDS_FREEBSD
+    ${SWIFT_SYNCHRONIZATION_FREEBSD_SOURCES}
   SWIFT_SOURCES_DEPENDS_FREESTANDING
     Mutex/MutexUnavailable.swift
 
@@ -129,6 +138,8 @@ add_swift_target_library(swiftSynchronization ${SWIFT_STDLIB_LIBRARY_BUILD_TYPES
     Android
   SWIFT_MODULE_DEPENDS_WINDOWS
     WinSDK
+  SWIFT_MODULE_DEPENDS_FREEBSD
+    Glibc
 
   SWIFT_COMPILE_FLAGS
     ${SWIFT_SYNCHRNOIZATION_SWIFT_FLAGS}

stdlib/public/Synchronization/Mutex/FreeBSDImpl.swift

@@ -0,0 +1,49 @@
+//===----------------------------------------------------------------------===//
+//
+// This source file is part of the Swift Atomics open source project
+//
+// Copyright (c) 2024 Apple Inc. and the Swift project authors
+// Licensed under Apache License v2.0 with Runtime Library Exception
+//
+// See https://swift.org/LICENSE.txt for license information
+// See https://swift.org/CONTRIBUTORS.txt for the list of Swift project authors
+//
+//===----------------------------------------------------------------------===//
+
+import Glibc
+
+@available(SwiftStdlib 6.0, *)
+@frozen
+@_staticExclusiveOnly
+public struct _MutexHandle: ~Copyable {
+  @usableFromInline
+  let value: _Cell<umutex>
+
+  @available(SwiftStdlib 6.0, *)
+  @_alwaysEmitIntoClient
+  @_transparent
+  public init() {
+    value = _Cell(umutex())
+  }
+
+  @available(SwiftStdlib 6.0, *)
+  @_alwaysEmitIntoClient
+  @_transparent
+  internal borrowing func _lock() {
+    _umtx_op(value._address, UMTX_OP_MUTEX_LOCK, 0, nil, nil)
+  }
+
+  @available(SwiftStdlib 6.0, *)
+  @_alwaysEmitIntoClient
+  @_transparent
+  internal borrowing func _tryLock() -> Bool {
+    _umtx_op(value._address, UMTX_OP_MUTEX_TRYLOCK, 0, nil, nil) != -1
+  }
+
+  @available(SwiftStdlib 6.0, *)
+  @_alwaysEmitIntoClient
+  @_transparent
+  internal borrowing func _unlock() {
+    _umtx_op(value._address, UMTX_OP_MUTEX_UNLOCK, 0, nil, nil)
+  }
+}

stdlib/public/core/CTypes.swift

@@ -114,10 +114,10 @@ public typealias CLongDouble = Double
 #error("CLongDouble needs to be defined for this OpenBSD architecture")
 #endif
 #elseif os(FreeBSD)
+// On FreeBSD, long double is Float128 for arm64, which we don't have yet in
+// Swift
 #if arch(x86_64) || arch(i386)
 public typealias CLongDouble = Float80
-#else
-#error("CLongDouble needs to be defined for this FreeBSD architecture")
 #endif
 #elseif $Embedded
 #if arch(x86_64) || arch(i386)

test/Concurrency/Runtime/async_task_executor_and_serial_executor_both_executor.swift

@@ -8,11 +8,12 @@
 
 // TODO: Need to find out how to combine %env- and %target-run and %import-libdispatch reliably.
 // UNSUPPORTED: OS=linux-gnu
+// UNSUPPORTED: OS=freebsd
 
 // REQUIRES: concurrency
 // REQUIRES: executable_test
 // REQUIRES: libdispatch
-// 
+//
 // REQUIRES: concurrency_runtime
 // UNSUPPORTED: back_deployment_runtime
 

test/Concurrency/Runtime/custom_executors_complex_equality_crash.swift

@@ -8,6 +8,7 @@
 
 // TODO: Need to find out how to combine %env- and %target-run and %import-libdispatch reliably.
 // UNSUPPORTED: OS=linux-gnu
+// UNSUPPORTED: OS=freebsd
 
 // REQUIRES: concurrency
 // REQUIRES: executable_test