Add FreeBSD support

jakepetroules · jakepetroules · commit 4ad91c992634 · 2025-01-29T16:46:57.000-08:00
This allows building Swift Build for FreeBSD hosts, as well as building for a FreeBSD target from a FreeBSD host.
diff --git a/Package.swift b/Package.swift
@@ -20,6 +20,17 @@ let appleOS = true
 let appleOS = false
 #endif
 
+// Workaround until FreeBSD platform condition lands
+#if os(FreeBSD)
+let nonApplePlatformsCondition: TargetDependencyCondition? = nil
+let nonAppleUnixPlatformsCondition: TargetDependencyCondition? = nil
+let noCustomExecutionTraitCondition: BuildSettingCondition? = nil
+#else
+let nonApplePlatformsCondition: TargetDependencyCondition? = .when(platforms: [.linux, .openbsd, .android, .windows])
+let nonAppleUnixPlatformsCondition: TargetDependencyCondition? = .when(platforms: [.linux, .openbsd, .android])
+let noCustomExecutionTraitCondition: BuildSettingCondition? = .when(platforms: [.macOS, .macCatalyst, .iOS, .tvOS, .watchOS, .visionOS, .windows])
+#endif
+
 let useLocalDependencies = Context.environment["SWIFTCI_USE_LOCAL_DEPS"] != nil
 let useLLBuildFramework = Context.environment["SWIFTBUILD_LLBUILD_FWK"] != nil
 let readlinePackage = !appleOS ? "readline" : nil
@@ -82,7 +93,7 @@ let package = Package(
                 "SWBBuildSystem",
                 "SWBServiceCore",
                 "SWBTaskExecution",
-                .product(name: "SystemPackage", package: "swift-system", condition: .when(platforms: [.linux, .android, .windows])),
+                .product(name: "SystemPackage", package: "swift-system", condition: nonApplePlatformsCondition),
             ],
             swiftSettings: swiftSettings),
         .target(
@@ -164,8 +175,8 @@ let package = Package(
                 "SWBLibc",
                 .target(name: "readline", condition: .when(platforms: [.linux])),
                 .product(name: "ArgumentParser", package: "swift-argument-parser"),
-                .product(name: "Crypto", package: "swift-crypto", condition: .when(platforms: [.linux, .android])),
-                .product(name: "SystemPackage", package: "swift-system", condition: .when(platforms: [.linux, .android, .windows])),
+                .product(name: "Crypto", package: "swift-crypto", condition: nonAppleUnixPlatformsCondition),
+                .product(name: "SystemPackage", package: "swift-system", condition: nonApplePlatformsCondition),
             ],
             swiftSettings: swiftSettings),
         .target(
@@ -210,20 +221,20 @@ let package = Package(
         // Test support
         .target(
             name: "SwiftBuildTestSupport",
-            dependencies: ["SwiftBuild", "SWBTestSupport", "SWBUtil"],
+            dependencies: ["SwiftBuild", "SWBTestSupport", "SWBUtil", .product(name: "Testing", package: "swift-testing")],
             swiftSettings: swiftSettings,
             linkerSettings: [
                 .linkedFramework("Testing", .when(platforms: [.macOS]))
             ]),
         .target(
             name: "SWBTestSupport",
-            dependencies: ["SwiftBuild", "SWBBuildSystem", "SWBCore", "SWBTaskConstruction", "SWBTaskExecution", "SWBUtil", "SWBLLBuild", "SWBMacro"],
+            dependencies: ["SwiftBuild", "SWBBuildSystem", "SWBCore", "SWBTaskConstruction", "SWBTaskExecution", "SWBUtil", "SWBLLBuild", "SWBMacro", .product(name: "Testing", package: "swift-testing")],
             swiftSettings: swiftSettings + [
                 // Temporary until swift-testing introduces replacement for this SPI
-                .define("DONT_HAVE_CUSTOM_EXECUTION_TRAIT", .when(platforms: [.macOS, .macCatalyst, .iOS, .tvOS, .watchOS, .visionOS, .windows]))
+                .define("DONT_HAVE_CUSTOM_EXECUTION_TRAIT", noCustomExecutionTraitCondition)
             ],
             linkerSettings: [
-                .linkedFramework("Testing", .when(platforms: [.macOS]))
+                .linkedFramework("Testing", .when(platforms: [.macOS])),
             ]),
 
         // Tests
@@ -260,11 +271,11 @@ let package = Package(
             swiftSettings: swiftSettings),
         .testTarget(
             name: "SWBProjectModelTests",
-            dependencies: ["SWBProjectModel"],
+            dependencies: ["SWBProjectModel", .product(name: "Testing", package: "swift-testing")],
             swiftSettings: swiftSettings),
         .testTarget(
             name: "SWBProtocolTests",
-            dependencies: ["SWBProtocol", "SWBUtil"],
+            dependencies: ["SWBProtocol", "SWBUtil", .product(name: "Testing", package: "swift-testing")],
             swiftSettings: swiftSettings),
         .testTarget(
             name: "SWBUtilTests",
@@ -280,7 +291,7 @@ let package = Package(
             swiftSettings: swiftSettings),
         .testTarget(
             name: "SWBServiceCoreTests",
-            dependencies: ["SWBServiceCore"],
+            dependencies: ["SWBServiceCore", .product(name: "Testing", package: "swift-testing")],
             swiftSettings: swiftSettings),
         .testTarget(
             name: "SWBCoreTests",
@@ -401,15 +412,32 @@ if useLocalDependencies {
         package.dependencies +=  [.package(path: "../llbuild"),]
     }
 } else {
+    #if os(FreeBSD)
+    package.dependencies += [
+        // https://github.com/apple/swift-crypto/commit/bce1725222a0547c061fb71eab460aff1aa1e28b is not yet in a tag
+        .package(url: "https://github.com/apple/swift-crypto.git", branch: "main"),
+
+        // https://github.com/apple/swift-system/commit/4fa2a719c5d225fc763f21f2d341c0c8d825d65e is not yet in a tag
+        .package(url: "https://github.com/apple/swift-system.git", branch: "main"),
+    ]
+    #else    
     package.dependencies += [
         // https://github.com/apple/swift-crypto/issues/262
         // 3.7.1 introduced a regression which fails to link on aarch64-windows; revert to <4.0.0 for the upper bound when this is fixed
         .package(url: "https://github.com/apple/swift-crypto.git", "2.0.0"..<"3.7.1"),
-        .package(url: "https://github.com/apple/swift-driver.git", branch: "main"),
+
         .package(url: "https://github.com/apple/swift-system.git", .upToNextMajor(from: "1.4.0")),
+    ]
+    #endif
+
+    package.dependencies += [
+        .package(url: "https://github.com/apple/swift-driver.git", branch: "main"),
         .package(url: "https://github.com/apple/swift-argument-parser.git", from: "1.0.3"),
     ]
     if !useLLBuildFramework {
         package.dependencies += [.package(url: "https://github.com/apple/swift-llbuild.git", branch: "main"),]
     }
 }
+
+
+package.dependencies += [.package(url: "https://github.com/swiftlang/swift-testing", branch: "main")]
diff --git a/Sources/SWBCore/Core.swift b/Sources/SWBCore/Core.swift
@@ -670,6 +670,6 @@ struct CoreRegistryDelegate : PlatformRegistryDelegate, SDKRegistryDelegate, Spe
 extension OperatingSystem {
     /// Whether the Core is allowed to create a fallback toolchain, SDK, and platform for this operating system in cases where no others have been provided.
     internal var createFallbackSystemToolchain: Bool {
-        return self == .linux
+        return self == .linux || self == .freebsd
     }
 }
diff --git a/Sources/SWBCore/SDKRegistry.swift b/Sources/SWBCore/SDKRegistry.swift
@@ -747,8 +747,10 @@ public final class SDKRegistry: SDKRegistryLookup, CustomStringConvertible {
     private func fallbackSystemSDKSettings(operatingSystem: OperatingSystem) throws -> [String: PropertyListItem] {
         let defaultProperties: [String: PropertyListItem]
         switch operatingSystem {
-        case .linux:
+        case .linux, .freebsd:
             defaultProperties = [
+                "LIBTOOL_USE_RESPONSE_FILE": .plString("NO"), // TODO: Need to make this specific to FreeBSD
+
                 // Workaround to avoid `-add_ast_path` on Linux, apparently this needs to perform some "swift modulewrap" step instead.
                 "GCC_GENERATE_DEBUGGING_SYMBOLS": .plString("NO"),
 
@@ -800,7 +802,7 @@ public final class SDKRegistry: SDKRegistryLookup, CustomStringConvertible {
                 operatingSystem.xcodePlatformName: .plDict([
                     "Archs": .plArray([.plString(Architecture.hostStringValue ?? "unknown")]),
                     "LLVMTargetTripleEnvironment": .plString(tripleEnvironment),
-                    "LLVMTargetTripleSys": .plString(operatingSystem.xcodePlatformName),
+                    "LLVMTargetTripleSys": .plString(operatingSystem.xcodePlatformName + "14.1"), // TODO: Need to get the FreeBSD version and plumb it through somehow
                     "LLVMTargetTripleVendor": .plString("unknown"),
                 ])
             ]),
diff --git a/Sources/SWBCore/Settings/BuiltinMacros.swift b/Sources/SWBCore/Settings/BuiltinMacros.swift
@@ -806,6 +806,7 @@ public final class BuiltinMacros {
     public static let LIBRARY_SEARCH_PATHS = BuiltinMacros.declarePathListMacro("LIBRARY_SEARCH_PATHS")
     public static let LIBTOOL = BuiltinMacros.declarePathMacro("LIBTOOL")
     public static let LIBTOOL_DEPENDENCY_INFO_FILE = BuiltinMacros.declarePathMacro("LIBTOOL_DEPENDENCY_INFO_FILE")
+    public static let LIBTOOL_USE_RESPONSE_FILE = BuiltinMacros.declareBooleanMacro("LIBTOOL_USE_RESPONSE_FILE")
     public static let LINKER = BuiltinMacros.declareStringMacro("LINKER")
     public static let ALTERNATE_LINKER = BuiltinMacros.declareStringMacro("ALTERNATE_LINKER")
     public static let LINK_OBJC_RUNTIME = BuiltinMacros.declareBooleanMacro("LINK_OBJC_RUNTIME")
@@ -1852,6 +1853,7 @@ public final class BuiltinMacros {
         LIBRARY_SEARCH_PATHS,
         LIBTOOL,
         LIBTOOL_DEPENDENCY_INFO_FILE,
+        LIBTOOL_USE_RESPONSE_FILE,
         LINKER,
         LINK_OBJC_RUNTIME,
         LINK_WITH_STANDARD_LIBRARIES,
diff --git a/Sources/SWBCore/Settings/Settings.swift b/Sources/SWBCore/Settings/Settings.swift
@@ -5262,6 +5262,8 @@ extension OperatingSystem {
                 return "windows"
             case .linux:
                 return "linux"
+            case .freebsd:
+                return "freebsd"
             case .android:
                 return "android"
             case .unknown:
diff --git a/Sources/SWBCore/Specs/Tools/LinkerTools.swift b/Sources/SWBCore/Specs/Tools/LinkerTools.swift
@@ -1419,17 +1419,22 @@ public final class LibtoolLinkerSpec : GenericLinkerSpec, SpecIdentifierType {
 
     override public func constructLinkerTasks(_ cbc: CommandBuildContext, _ delegate: any TaskGenerationDelegate, libraries: [LibrarySpecifier], usedTools: [CommandLineToolSpec: Set<FileTypeSpec>]) async {
         var inputPaths = cbc.inputs.map({ $0.absolutePath })
+        var specialArgs = [String]()
 
-        // Define the linker file list.
-        let fileListPath = cbc.scope.evaluate(BuiltinMacros.__INPUT_FILE_LIST_PATH__)
-        if !fileListPath.isEmpty {
-            let contents = cbc.inputs.map({ return $0.absolutePath.strWithPosixSlashes + "\n" }).joined(separator: "")
-            cbc.producer.writeFileSpec.constructFileTasks(CommandBuildContext(producer: cbc.producer, scope: cbc.scope, inputs: [], output: fileListPath), delegate, contents: ByteString(encodingAsUTF8: contents), permissions: nil, preparesForIndexing: false, additionalTaskOrderingOptions: [.immediate, .ignorePhaseOrdering])
-            inputPaths.append(fileListPath)
+        if cbc.scope.evaluate(BuiltinMacros.LIBTOOL_USE_RESPONSE_FILE) {
+            // Define the linker file list.
+            let fileListPath = cbc.scope.evaluate(BuiltinMacros.__INPUT_FILE_LIST_PATH__)
+            if !fileListPath.isEmpty {
+                let contents = cbc.inputs.map({ return $0.absolutePath.strWithPosixSlashes + "\n" }).joined(separator: "")
+                cbc.producer.writeFileSpec.constructFileTasks(CommandBuildContext(producer: cbc.producer, scope: cbc.scope, inputs: [], output: fileListPath), delegate, contents: ByteString(encodingAsUTF8: contents), permissions: nil, preparesForIndexing: false, additionalTaskOrderingOptions: [.immediate, .ignorePhaseOrdering])
+                inputPaths.append(fileListPath)
+            }
+        } else {
+            specialArgs.append(contentsOf: cbc.inputs.map { $0.absolutePath.str })
+            inputPaths.append(contentsOf: cbc.inputs.map { $0.absolutePath })
         }
 
         // Add arguments for the contents of the Link Binaries build phase.
-        var specialArgs = [String]()
         specialArgs.append(contentsOf: libraries.flatMap { specifier -> [String] in
             let basename = specifier.path.basename
 
diff --git a/Sources/SWBCore/ToolchainRegistry.swift b/Sources/SWBCore/ToolchainRegistry.swift
@@ -440,10 +440,23 @@ public final class ToolchainRegistry: @unchecked Sendable {
             return
         }
 
-        if let swift = StackedSearchPath(environment: ProcessInfo.processInfo.cleanEnvironment, fs: fs).lookup(Path("swift")), fs.exists(swift) && swift.normalize().str.hasSuffix("/usr/bin/swift") {
-            let path = swift.dirname.dirname.dirname
-            let llvmDirectories = try fs.listdir(Path("/usr/lib")).filter { $0.hasPrefix("llvm-") }.sorted().reversed()
-            try register(Toolchain(Self.defaultToolchainIdentifier, "Default", Version(), [], path, [], llvmDirectories.map { "/usr/lib/\($0)/lib" } + ["/usr/lib64"], [:], [:], [:], executableSearchPaths: [path.join("usr").join("bin"), path.join("usr").join("local").join("bin"),  path.join("usr").join("libexec")], fs: fs))
+        if let swift = StackedSearchPath(environment: ProcessInfo.processInfo.cleanEnvironment, fs: fs).lookup(Path("swift")), fs.exists(swift) {
+            let hasUsrBin = swift.normalize().str.hasSuffix("/usr/bin/swift")
+            let hasUsrLocalBin = swift.normalize().str.hasSuffix("/usr/local/bin/swift")
+            let path: Path
+            switch (hasUsrBin, hasUsrLocalBin) {
+            case (true, false):
+                path = swift.dirname.dirname.dirname
+            case (false, true):
+                path = swift.dirname.dirname.dirname.dirname
+            case (false, false):
+                return
+            case (true, true):
+                preconditionFailure()
+            }
+            let llvmDirectories = try Array(fs.listdir(Path("/usr/lib")).filter { $0.hasPrefix("llvm-") }.sorted().reversed())
+            let llvmDirectoriesLocal = try Array(fs.listdir(Path("/usr/local")).filter { $0.hasPrefix("llvm") }.sorted().reversed())
+            try register(Toolchain(Self.defaultToolchainIdentifier, "Default", Version(), [], path, [], (llvmDirectories + llvmDirectoriesLocal).map { "/usr/lib/\($0)/lib" } + ["/usr/lib64"], [:], [:], [:], executableSearchPaths: [path.join("usr").join("bin"), path.join("usr").join("local").join("bin"),  path.join("usr").join("libexec")], fs: fs))
         }
     }
 
diff --git a/Sources/SWBGenericUnixPlatform/Plugin.swift b/Sources/SWBGenericUnixPlatform/Plugin.swift
@@ -24,6 +24,9 @@ struct GenericUnixPlatformSpecsExtension: SpecificationsExtension {
     }
 
     func specificationDomains() -> [String: [String]] {
-        ["linux": ["generic-unix"]]
+        [
+            "linux": ["generic-unix"],
+            "freebsd": ["generic-unix"],
+        ]
     }
 }
diff --git a/Sources/SWBGenericUnixPlatform/UnixLibtool.xcspec b/Sources/SWBGenericUnixPlatform/UnixLibtool.xcspec
@@ -51,6 +51,7 @@
                 Name = __INPUT_FILE_LIST_PATH__;
                 Type = Path;
                 // this is set up for us as a read-only property
+                Condition = "$(LIBTOOL_USE_RESPONSE_FILE) != NO";
                 DefaultValue = "$(LINK_FILE_LIST_$(variant)_$(arch))";
                 CommandLineArgs = (
                     "@$(value)",
diff --git a/Sources/SWBTestSupport/RunDestinationTestSupport.swift b/Sources/SWBTestSupport/RunDestinationTestSupport.swift
@@ -98,6 +98,8 @@ extension _RunDestinationInfo {
             windows
         case .linux:
             linux
+        case .freebsd:
+            freebsd
         case .android:
             android
         case .unknown:
@@ -259,6 +261,14 @@ extension _RunDestinationInfo {
         return .init(platform: "linux", sdk: "linux", sdkVariant: "linux", targetArchitecture: arch, supportedArchitectures: ["x86_64", "aarch64"], disableOnlyActiveArch: false)
     }
 
+    /// A run destination targeting FreeBSD generic device, using the public SDK.
+    package static var freebsd: Self {
+        guard let arch = Architecture.hostStringValue  else {
+            preconditionFailure("Unknown architecture \(Architecture.host.stringValue ?? "<nil>")")
+        }
+        return .init(platform: "freebsd", sdk: "freebsd", sdkVariant: "freebsd", targetArchitecture: arch, supportedArchitectures: ["x86_64", "aarch64"], disableOnlyActiveArch: false)
+    }
+
     /// A run destination targeting Android generic device, using the public SDK.
     package static var android: Self {
         return .init(platform: "android", sdk: "android", sdkVariant: "android", targetArchitecture: "undefined_arch", supportedArchitectures: ["armv7", "aarch64", "riscv64", "i686", "x86_64"], disableOnlyActiveArch: true)
diff --git a/Sources/SWBTestSupport/SkippedTestSupport.swift b/Sources/SWBTestSupport/SkippedTestSupport.swift
@@ -48,6 +48,8 @@ extension KnownSDK {
             return windows
         case .success(.linux):
             return linux
+        case .success(.freebsd):
+            return freebsd
         case .success(.android):
             return android
         case .success(.unknown), .failure:
@@ -68,6 +70,7 @@ extension KnownSDK {
 extension KnownSDK {
     package static let windows: Self = "windows"
     package static let linux: Self = "linux"
+    package static let freebsd: Self = "freebsd"
     package static let android: Self = "android"
     package static let qnx: Self = "qnx"
 }
diff --git a/Sources/SWBUniversalPlatform/Specs/Libtool.xcspec b/Sources/SWBUniversalPlatform/Specs/Libtool.xcspec
@@ -61,6 +61,7 @@
             // Input file lists
             {   Name = __INPUT_FILE_LIST_PATH__;
                 Type = Path;
+                Condition = "$(LIBTOOL_USE_RESPONSE_FILE) != NO";
                 DefaultValue = "$(LINK_FILE_LIST_$(variant)_$(arch))";      // this is set up for us as a read-only property
                 CommandLineFlag = "-filelist";
                 IsInputDependency = Yes;
@@ -104,6 +105,11 @@
                 DefaultValue = "$(OBJECT_FILE_DIR_$(CURRENT_VARIANT))/$(CURRENT_ARCH)/$(PRODUCT_NAME)_libtool_dependency_info.dat";
             },
 
+            {
+                Name = "LIBTOOL_USE_RESPONSE_FILE";
+                Type = Boolean;
+                DefaultValue = YES;
+            },
         );
     }
 )
diff --git a/Sources/SWBUtil/Architecture.swift b/Sources/SWBUtil/Architecture.swift
@@ -98,7 +98,13 @@ public struct Architecture: Sendable {
             if uname(&buf) == 0 {
                 return withUnsafeBytes(of: &buf.machine) { buf in
                     let data = Data(buf)
-                    return String(decoding: data[0...(data.lastIndex(where: { $0 != 0 }) ?? 0)], as: UTF8.self)
+                    let value = String(decoding: data[0...(data.lastIndex(where: { $0 != 0 }) ?? 0)], as: UTF8.self)
+                    switch value {
+                    case "amd64":
+                        return "x86_64"
+                    default:
+                        return value
+                    }
                 }
             }
             #endif
diff --git a/Sources/SWBUtil/FSProxy.swift b/Sources/SWBUtil/FSProxy.swift
@@ -758,7 +758,7 @@ class LocalFS: FSProxy, @unchecked Sendable {
     }
 
     func listExtendedAttributes(_ path: Path) throws -> [String] {
-        #if os(Windows)
+        #if os(Windows) || os(FreeBSD) // FreeBSD blocked on https://github.com/swiftlang/swift/pull/77836
         // no xattrs on Windows
         return []
         #else
@@ -796,7 +796,7 @@ class LocalFS: FSProxy, @unchecked Sendable {
     }
 
     func setExtendedAttribute(_ path: Path, key: String, value: ByteString) throws {
-        #if os(Windows)
+        #if os(Windows) || os(FreeBSD) // FreeBSD blocked on https://github.com/swiftlang/swift/pull/77836
         // no xattrs on Windows
         #else
         try value.bytes.withUnsafeBufferPointer { buf throws -> Void in
@@ -813,7 +813,7 @@ class LocalFS: FSProxy, @unchecked Sendable {
     }
 
     func getExtendedAttribute(_ path: Path, key: String) throws -> ByteString? {
-        #if os(Windows)
+        #if os(Windows) || os(FreeBSD) // FreeBSD blocked on https://github.com/swiftlang/swift/pull/77836
         return nil // no xattrs on Windows
         #else
         var bufferSize = 4096
diff --git a/Sources/SWBUtil/GNUReadLine.swift b/Sources/SWBUtil/GNUReadLine.swift
diff --git a/Sources/SWBUtil/Library.swift b/Sources/SWBUtil/Library.swift
diff --git a/Sources/SWBUtil/Lock.swift b/Sources/SWBUtil/Lock.swift
diff --git a/Sources/SWBUtil/ProcessInfo.swift b/Sources/SWBUtil/ProcessInfo.swift
diff --git a/Tests/SWBBuildSystemTests/BuildOperationTests.swift b/Tests/SWBBuildSystemTests/BuildOperationTests.swift
diff --git a/Tests/SWBUtilTests/FSProxyTests.swift b/Tests/SWBUtilTests/FSProxyTests.swift
diff --git a/Tests/SWBUtilTests/MiscTests.swift b/Tests/SWBUtilTests/MiscTests.swift

Original file line number	Diff line number	Diff line change
`@@ -670,6 +670,6 @@ struct CoreRegistryDelegate : PlatformRegistryDelegate, SDKRegistryDelegate, Spe`
`670`	`670`	`extension OperatingSystem {`
`671`	`671`	`/// Whether the Core is allowed to create a fallback toolchain, SDK, and platform for this operating system in cases where no others have been provided.`
`672`	`672`	`internal var createFallbackSystemToolchain: Bool {`
`673`		`- return self == .linux`
	`673`	`+ return self == .linux \|\| self == .freebsd`
`674`	`674`	`}`
`675`	`675`	`}`
Original file line number	Diff line number	Diff line change
`@@ -24,6 +24,9 @@ struct GenericUnixPlatformSpecsExtension: SpecificationsExtension {`
`24`	`24`	`}`
`25`	`25`
`26`	`26`	`func specificationDomains() -> [String: [String]] {`
`27`		`- ["linux": ["generic-unix"]]`
	`27`	`+ [`
	`28`	`+ "linux": ["generic-unix"],`
	`29`	`+ "freebsd": ["generic-unix"],`
	`30`	`+ ]`
`28`	`31`	`}`
`29`	`32`	`}`