Merge pull request #9967 from owenv/owenv/sdk

[Swift Build] Forward --sdk overrides to the underlying run destination

Author: owenv

Sources/CoreCommands/SwiftCommandState.swift

@@ -1006,6 +1006,7 @@ public final class SwiftCommandState {
             configuration: self.options.build.configuration ?? self.preferredBuildConfiguration,
             toolchain: toolchain,
             triple: triple,
+            sdkRootOverride: self.options.build.customCompileSDK ?? self.environment["SDKROOT"].flatMap({ try? AbsolutePath(validating: $0) }),
             flags: options.build.buildFlags,
             buildSystemKind: options.build.buildSystem,
             pkgConfigDirectories: options.locations.pkgConfigDirectories,

Sources/SPMBuildCore/BuildParameters/BuildParameters.swift

@@ -66,6 +66,9 @@ public struct BuildParameters: Encodable {
     /// The triple for which the code is built using these build parameters.
     public var triple: Triple
 
+    /// If set, overrides the SDK root path.
+    public var sdkRootOverride: Basics.AbsolutePath?
+
     /// Extra build flags.
     public var flags: BuildFlags
 
@@ -166,6 +169,7 @@ public struct BuildParameters: Encodable {
         configuration: BuildConfiguration,
         toolchain: Toolchain,
         triple: Triple? = nil,
+        sdkRootOverride: Basics.AbsolutePath? = nil,
         flags: BuildFlags,
         buildSystemKind: BuildSystemProvider.Kind,
         pkgConfigDirectories: [Basics.AbsolutePath] = [],
@@ -203,6 +207,7 @@ public struct BuildParameters: Encodable {
         self.configuration = configuration
         self._toolchain = _Toolchain(toolchain: toolchain)
         self.triple = triple
+        self.sdkRootOverride = sdkRootOverride
         self.buildSystemKind = buildSystemKind
         switch self.debuggingParameters.debugInfoFormat {
         case .dwarf, nil:

Sources/SwiftBuildSupport/SwiftBuildSystem.swift

@@ -773,7 +773,7 @@ public final class SwiftBuildSystem: SPMBuildCore.BuildSystem {
             return SwiftBuild.SWBRunDestinationInfo(
                 buildTarget: .toolchainSDK(
                     platform: buildTargetInfo.platformName,
-                    sdk: buildTargetInfo.sdkName,
+                    sdk: buildParameters.sdkRootOverride?.pathString ?? buildTargetInfo.sdkName,
                     sdkVariant: buildTargetInfo.sdkVariant
                 ),
                 targetArchitecture: buildParameters.triple.archName,

Sources/_InternalTestSupport/MockBuildTestHelper.swift

@@ -98,6 +98,7 @@ public func mockBuildParameters(
     shouldDisableLocalRpath: Bool = false,
     canRenameEntrypointFunctionName: Bool = false,
     triple: Basics.Triple = hostTriple,
+    sdkRootOverride: AbsolutePath? = nil,
     indexStoreMode: BuildParameters.IndexStoreMode = .auto,
     linkerDeadStrip: Bool = true,
     linkTimeOptimizationMode: BuildParameters.LinkTimeOptimizationMode? = nil,
@@ -115,6 +116,7 @@ public func mockBuildParameters(
         configuration: config,
         toolchain: toolchain,
         triple: triple,
+        sdkRootOverride: sdkRootOverride,
         flags: flags,
         buildSystemKind: buildSystemKind,
         pkgConfigDirectories: [],

Tests/SwiftBuildSupportTests/SwiftBuildSystemTests.swift

@@ -751,4 +751,27 @@ struct SwiftBuildSystemTests {
             #expect(otherLDFlags.contains("$(OTHER_LDFLAGS_SWIFTC_LINKER_DRIVER_$(LINKER_DRIVER))"))
         }
     }
+
+    @Test
+    func sdkRootOverrideIsSetInRunDestination() async throws {
+        let sdkRoot = AbsolutePath("/fake/sdk/root")
+        try await withInstantiatedSwiftBuildSystem(
+            fromFixture: "PIFBuilder/Simple",
+            buildParameters: mockBuildParameters(
+                destination: .host,
+                buildSystemKind: .swiftbuild,
+                sdkRootOverride: sdkRoot,
+            ),
+        ) { swiftBuild, service, session, observabilityScope, buildParameters in
+            let buildSettings = try await swiftBuild.makeBuildParameters(
+                service: service,
+                session: session,
+                symbolGraphOptions: nil,
+                setToolchainSetting: false,
+            )
+
+            let runDestination = try #require(buildSettings.activeRunDestination)
+            #expect(runDestination.sdk == sdkRoot.pathString)
+        }
+    }
 }