Merge remote-tracking branch 'origin/main' into swiftlang#65-support-for-armhf

Author: xtremekforever

Sources/GeneratorCLI/GeneratorCLI.swift

@@ -109,9 +109,14 @@ extension GeneratorCLI {
     var hostSwiftPackagePath: String? = nil
 
     @Flag(
-      help: "Don't include host toolchain in generated SDK, making it similar to the Static SDKs for Linux."
+      inversion: .prefixedNo,
+      help: """
+      Whether or not to include the host toolchain in the Swift SDK.
+      If the host toolchain is not included, this makes the Swift SDK compatible with any host, \
+      but requires exactly the same version of the swift.org toolchain to be installed for it to work.
+      """
     )
-    var noHostToolchain: Bool = false
+    var hostToolchain: Bool = true
 
     @Option(
       help: """
@@ -232,7 +237,7 @@ extension GeneratorCLI {
         fromContainerImage: self.fromContainerImage,
         hostSwiftPackagePath: self.generatorOptions.hostSwiftPackagePath,
         targetSwiftPackagePath: self.generatorOptions.targetSwiftPackagePath,
-        noHostToolchain: self.generatorOptions.noHostToolchain
+        includeHostToolchain: self.generatorOptions.hostToolchain
       )
       try await GeneratorCLI.run(recipe: recipe, targetTriple: targetTriple, options: self.generatorOptions)
     }

Sources/Helpers/Vendor/Triple.swift

@@ -32,7 +32,7 @@
 ///
 /// This is a port of https://github.com/apple/swift-llvm/blob/stable/include/llvm/ADT/Triple.h
 @dynamicMemberLookup
-public struct Triple: Sendable {
+public struct Triple: Sendable, Equatable {
   /// `Triple` proxies predicates from `Triple.OS`, returning `false` for an unknown OS.
   public subscript(dynamicMember predicate: KeyPath<OS, Bool>) -> Bool {
     os?[keyPath: predicate] ?? false

Sources/SwiftSDKGenerator/Generator/SwiftSDKGenerator+Download.swift

@@ -109,8 +109,6 @@ extension SwiftSDKGenerator {
     }
 
     print("Downloading \(urls.count) Ubuntu packages...")
-    let pathsConfiguration = self.pathsConfiguration
-
     try await inTemporaryDirectory { fs, tmpDir in
       let downloadedFiles = try await self.downloadFiles(from: urls, to: tmpDir, client, engine)
       report(downloadedFiles: downloadedFiles)
@@ -119,10 +117,6 @@ extension SwiftSDKGenerator {
         try await fs.unpack(file: tmpDir.appending(fileName), into: sdkDirPath)
       }
     }
-
-    if self.includeHostToolchain {
-      try createDirectoryIfNeeded(at: pathsConfiguration.toolchainBinDirPath)
-    }
   }
 
   func downloadFiles(

Sources/SwiftSDKGenerator/Generator/SwiftSDKGenerator+Unpack.swift

@@ -46,6 +46,8 @@ extension SwiftSDKGenerator {
     logGenerationStep("Unpacking and copying Swift binaries for the host triple...")
     let pathsConfiguration = self.pathsConfiguration
 
+    try self.createDirectoryIfNeeded(at: pathsConfiguration.toolchainDirPath)
+
     let excludes =
       unusedDarwinPlatforms.map { "--exclude usr/lib/swift/\($0)" } +
       unusedDarwinPlatforms.map { "--exclude usr/lib/swift_static/\($0)" } +

Sources/SwiftSDKGenerator/Serialization/Toolset.swift

@@ -26,7 +26,7 @@ public struct Toolset: Encodable {
 
   /// Root path of the toolset, if present. When filling in ``Toolset.ToolProperties/path``, if a raw path string in
   /// ``DecodedToolset`` is inferred to be relative, it's resolved as absolute path relatively to `rootPath`.
-  let rootPath: String?
+  var rootPath: String?
 
   // MARK: Tools currently known and used by SwiftPM.
 

Sources/SwiftSDKGenerator/SwiftSDKRecipes/LinuxRecipe.swift

@@ -24,7 +24,7 @@ public struct LinuxRecipe: SwiftSDKRecipe {
   public enum HostSwiftSource: Sendable, Equatable {
     case localPackage(FilePath)
     case remoteTarball
-    case skip
+    case preinstalled
   }
 
   let mainTargetTriple: Triple
@@ -52,7 +52,7 @@ public struct LinuxRecipe: SwiftSDKRecipe {
     fromContainerImage: String?,
     hostSwiftPackagePath: String?,
     targetSwiftPackagePath: String?,
-    noHostToolchain: Bool = false
+    includeHostToolchain: Bool = false
   ) throws {
     let versionsConfiguration = try VersionsConfiguration(
       swiftVersion: swiftVersion,
@@ -74,8 +74,8 @@ public struct LinuxRecipe: SwiftSDKRecipe {
       }
     }
     let hostSwiftSource: HostSwiftSource
-    if noHostToolchain {
-      hostSwiftSource = .skip
+    if includeHostToolchain == false {
+      hostSwiftSource = .preinstalled
     } else if let hostSwiftPackagePath {
       hostSwiftSource = .localPackage(FilePath(hostSwiftPackagePath))
     } else {
@@ -109,6 +109,10 @@ public struct LinuxRecipe: SwiftSDKRecipe {
   }
 
   public func applyPlatformOptions(toolset: inout Toolset, targetTriple: Triple) {
+    if self.hostSwiftSource == .preinstalled {
+      toolset.rootPath = nil
+    }
+
     var swiftCompilerOptions = ["-Xlinker", "-R/usr/lib/swift/linux/"]
 
     // Swift 5.9 does not handle the `-use-ld` option properly:
@@ -118,7 +122,7 @@ public struct LinuxRecipe: SwiftSDKRecipe {
     } else {
       swiftCompilerOptions.append("-use-ld=lld")
 
-      if self.hostSwiftSource != .skip {
+      if self.hostSwiftSource != .preinstalled {
         toolset.linker = Toolset.ToolProperties(path: "ld.lld")
       }
     }
@@ -158,6 +162,48 @@ public struct LinuxRecipe: SwiftSDKRecipe {
       .appending("\(self.linuxDistribution.name.rawValue)-\(self.linuxDistribution.release).sdk")
   }
 
+  func itemsToDownload(from artifacts: DownloadableArtifacts) -> [DownloadableArtifacts.Item] {
+    var items: [DownloadableArtifacts.Item] = []
+    if self.hostSwiftSource != .preinstalled && !self.versionsConfiguration.swiftVersion.hasPrefix("6.0") {
+      items.append(artifacts.hostLLVM)
+    }
+
+    switch self.targetSwiftSource {
+    case .remoteTarball:
+      items.append(artifacts.targetSwift)
+    case .docker, .localPackage: break
+    }
+
+    switch self.hostSwiftSource {
+    case .remoteTarball:
+      items.append(artifacts.hostSwift)
+    case .localPackage: break
+    case .preinstalled: break
+    }
+    return items
+  }
+
+  var hostTriples: [Triple]? {
+    if self.hostSwiftSource == .preinstalled {
+      // Swift 5.9 and 5.10 require `supportedTriples` to be set in info.json.
+      // FIXME: This can be removed once the SDK generator does not support 5.9/5.10 any more.
+      if self.versionsConfiguration.swiftVersion.hasPrefix("5.9")
+          || self.versionsConfiguration.swiftVersion.hasPrefix("5.10") {
+        return [
+          Triple("x86_64-unknown-linux-gnu"),
+          Triple("aarch64-unknown-linux-gnu"),
+          Triple("x86_64-apple-macos"),
+          Triple("arm64-apple-macos"),
+        ]
+      }
+
+      // Swift 6.0 and later can set `supportedTriples` to nil
+      return nil
+    }
+
+    return [self.mainHostTriple]
+  }
+
   public func makeSwiftSDK(
     generator: SwiftSDKGenerator,
     engine: QueryEngine,
@@ -180,27 +226,7 @@ public struct LinuxRecipe: SwiftSDKRecipe {
       client,
       engine,
       downloadableArtifacts: &downloadableArtifacts,
-      itemsToDownload: { artifacts in
-        var items: [DownloadableArtifacts.Item] = []
-
-        if self.hostSwiftSource != .skip && !self.versionsConfiguration.swiftVersion.hasPrefix("6.0") {
-          items.append(artifacts.hostLLVM)
-        }
-
-        switch self.targetSwiftSource {
-        case .remoteTarball:
-          items.append(artifacts.targetSwift)
-        case .docker, .localPackage: break
-        }
-
-        switch self.hostSwiftSource {
-        case .remoteTarball:
-          items.append(artifacts.hostSwift)
-        case .localPackage: break
-        case .skip: break
-        }
-        return items
-      }
+      itemsToDownload: { artifacts in itemsToDownload(from: artifacts) }
     )
 
     if !self.shouldUseDocker {
@@ -227,7 +253,7 @@ public struct LinuxRecipe: SwiftSDKRecipe {
       try await generator.unpackHostSwift(
         hostSwiftPackagePath: downloadableArtifacts.hostSwift.localPath
       )
-    case .skip:
+    case .preinstalled:
       break
     }
 
@@ -252,8 +278,7 @@ public struct LinuxRecipe: SwiftSDKRecipe {
 
     try await generator.fixAbsoluteSymlinks(sdkDirPath: sdkDirPath)
 
-    var hostTriples: [Triple]? = [self.mainHostTriple]
-    if self.hostSwiftSource != .skip {
+    if self.hostSwiftSource != .preinstalled {
       if !self.versionsConfiguration.swiftVersion.hasPrefix("6.0") {
         try await generator.prepareLLDLinker(engine, llvmArtifact: downloadableArtifacts.hostLLVM)
       }
@@ -269,11 +294,8 @@ public struct LinuxRecipe: SwiftSDKRecipe {
         logGenerationStep("Fixing `swift-autolink-extract` symlink...")
         try await generator.createSymlink(at: autolinkExtractPath, pointingTo: "swift")
       }
-    } else if self.versionsConfiguration.swiftVersion.hasPrefix("6.0") {
-      // We can exclude the host triples starting in Swift 6.0
-      hostTriples = nil
     }
 
-    return SwiftSDKProduct(sdkDirPath: sdkDirPath, hostTriples: hostTriples)
+    return SwiftSDKProduct(sdkDirPath: sdkDirPath, hostTriples: self.hostTriples)
   }
 }