Pass linker working directory information back in preview info (rdar://147957256) (#350)

Author: jonathanpenn

Sources/SWBBuildService/Messages.swift

@@ -1078,6 +1078,7 @@ private extension PreviewInfoOutput {
                 PreviewInfoTargetDependencyInfo(
                     objectFileInputMap: info.objectFileInputMap,
                     linkCommandLine: info.linkCommandLine,
+                    linkerWorkingDirectory: info.linkerWorkingDirectory,
                     swiftEnableOpaqueTypeErasure: info.swiftEnableOpaqueTypeErasure,
                     swiftUseIntegratedDriver: info.swiftUseIntegratedDriver,
                     enableJITPreviews: info.enableJITPreviews,

Sources/SWBBuildService/PreviewInfo.swift

@@ -51,6 +51,7 @@ package struct PreviewInfoOutput: Sendable {
     package struct TargetDependencyInfo: Sendable {
         package let objectFileInputMap: [String: Set<String>]
         package let linkCommandLine: [String]
+        package let linkerWorkingDirectory: String?
 
         package let swiftEnableOpaqueTypeErasure: Bool
         package let swiftUseIntegratedDriver: Bool
@@ -264,6 +265,7 @@ extension BuildDescription {
                         let targetInfo = PreviewInfoOutput.TargetDependencyInfo(
                             objectFileInputMap: swiftInfos,
                             linkCommandLine: linkInfo?.commandLine ?? [],
+                            linkerWorkingDirectory: linkInfo?.workingDirectory.str,
                             swiftEnableOpaqueTypeErasure: settings.globalScope.evaluate(BuiltinMacros.SWIFT_ENABLE_OPAQUE_TYPE_ERASURE),
                             swiftUseIntegratedDriver: settings.globalScope.evaluate(BuiltinMacros.SWIFT_USE_INTEGRATED_DRIVER),
                             enableJITPreviews: settings.globalScope.evaluate(BuiltinMacros.ENABLE_XOJIT_PREVIEWS),

Sources/SWBCore/SpecImplementations/Tools/LinkerTools.swift

@@ -1027,7 +1027,15 @@ public final class LdLinkerSpec : GenericLinkerSpec, SpecIdentifierType, @unchec
             outputPath.str,
             ])
 
-        let output = TaskGeneratePreviewInfoOutput(architecture: previewPayload.architecture, buildVariant: previewPayload.buildVariant, commandLine: commandLine, input: inputPath, output: outputPath, type: .Ld)
+        let output = TaskGeneratePreviewInfoOutput(
+            architecture: previewPayload.architecture,
+            buildVariant: previewPayload.buildVariant,
+            commandLine: commandLine,
+            workingDirectory: task.workingDirectory,
+            input: inputPath,
+            output: outputPath,
+            type: .Ld
+        )
 
         return [output]
     }
@@ -1072,6 +1080,7 @@ public final class LdLinkerSpec : GenericLinkerSpec, SpecIdentifierType, @unchec
                 architecture: previewPayload.architecture,
                 buildVariant: previewPayload.buildVariant,
                 commandLine: commandLine,
+                workingDirectory: task.workingDirectory,
                 input: Path(""),
                 output: payload.outputPath,
                 type: .Ld
@@ -1640,6 +1649,7 @@ public final class LibtoolLinkerSpec : GenericLinkerSpec, SpecIdentifierType, @u
                 architecture: previewPayload.architecture,
                 buildVariant: previewPayload.buildVariant,
                 commandLine: Array(task.commandLineAsStrings),
+                workingDirectory: task.workingDirectory,
                 input: Path(""),
                 output: Path(""),
                 type: .Ld

Sources/SWBCore/SpecImplementations/Tools/SwiftCompiler.swift

@@ -3199,7 +3199,15 @@ public final class SwiftCompilerSpec : CompilerSpec, SpecIdentifierType, SwiftDi
             let outputs = task.outputPaths.filter({ $0.fileSuffix == ".o" })
             guard inputs.count == outputs.count else { return [] }
             return zip(inputs, outputs).map { input, output in
-                TaskGeneratePreviewInfoOutput(architecture: previewPayload.architecture, buildVariant: previewPayload.buildVariant, commandLine: commandLine, input: input, output: output, type: .Swift)
+                TaskGeneratePreviewInfoOutput(
+                    architecture: previewPayload.architecture,
+                    buildVariant: previewPayload.buildVariant,
+                    commandLine: commandLine,
+                    workingDirectory: task.workingDirectory,
+                    input: input,
+                    output: output,
+                    type: .Swift
+                )
             }
         }
 
@@ -3478,7 +3486,15 @@ public final class SwiftCompilerSpec : CompilerSpec, SpecIdentifierType, SwiftDi
             }
         }
 
-        let output = TaskGeneratePreviewInfoOutput(architecture: previewPayload.architecture, buildVariant: previewPayload.buildVariant, commandLine: commandLine, input: inputPath, output: outputPath, type: .Swift)
+        let output = TaskGeneratePreviewInfoOutput(
+            architecture: previewPayload.architecture,
+            buildVariant: previewPayload.buildVariant,
+            commandLine: commandLine,
+            workingDirectory: task.workingDirectory,
+            input: inputPath,
+            output: outputPath,
+            type: .Swift
+        )
 
         return [output]
     }

Sources/SWBCore/TaskGeneration.swift

@@ -1078,6 +1078,8 @@ public struct TaskGeneratePreviewInfoOutput: Sendable {
     public let buildVariant: String
     /// The commandline to run to update the thunk.
     public let commandLine: [String]
+    /// Working directory of the task
+    public let workingDirectory: Path
     /// Input path of the task.
     public let input: Path
     /// Output path of the task.

Sources/SWBProtocol/MessageSupport.swift

@@ -437,6 +437,7 @@ public struct PreviewInfoThunkInfo: Codable, Equatable, Sendable {
 public struct PreviewInfoTargetDependencyInfo: Codable, Equatable, Sendable {
     public let objectFileInputMap: [String: Set<String>]
     public let linkCommandLine: [String]
+    public let linkerWorkingDirectory: String?
     public let swiftEnableOpaqueTypeErasure: Bool
     public let swiftUseIntegratedDriver: Bool
     public let enableJITPreviews: Bool
@@ -448,6 +449,7 @@ public struct PreviewInfoTargetDependencyInfo: Codable, Equatable, Sendable {
     public init(
         objectFileInputMap: [String : Set<String>],
         linkCommandLine: [String],
+        linkerWorkingDirectory: String?,
         swiftEnableOpaqueTypeErasure: Bool,
         swiftUseIntegratedDriver: Bool,
         enableJITPreviews: Bool,
@@ -458,6 +460,7 @@ public struct PreviewInfoTargetDependencyInfo: Codable, Equatable, Sendable {
     ) {
         self.objectFileInputMap = objectFileInputMap
         self.linkCommandLine = linkCommandLine
+        self.linkerWorkingDirectory = linkerWorkingDirectory
         self.swiftEnableOpaqueTypeErasure = swiftEnableOpaqueTypeErasure
         self.swiftUseIntegratedDriver = swiftUseIntegratedDriver
         self.enableJITPreviews = enableJITPreviews

Sources/SwiftBuild/SWBBuildServiceSession.swift

@@ -1027,6 +1027,7 @@ fileprivate extension SWBPreviewTargetDependencyInfo {
         case let .targetDependencyInfo(targetDependencyInfo):
             self.objectFileInputMap = targetDependencyInfo.objectFileInputMap
             self.linkCommandLine = targetDependencyInfo.linkCommandLine
+            self.linkerWorkingDirectory = targetDependencyInfo.linkerWorkingDirectory
             self.swiftEnableOpaqueTypeErasure = targetDependencyInfo.swiftEnableOpaqueTypeErasure
             self.swiftUseIntegratedDriver = targetDependencyInfo.swiftUseIntegratedDriver
             self.enableJITPreviews = targetDependencyInfo.enableJITPreviews

Sources/SwiftBuild/SWBPreviewSupport.swift

@@ -66,6 +66,9 @@ public struct SWBPreviewTargetDependencyInfo: SWBPreviewInfoContext, Hashable, S
     /// Full command line for Previews to extract values as needed. This is the link command line of the preview stub dylib.
     public let linkCommandLine: [String]
 
+    /// Working directory for the linker invocation.
+    public let linkerWorkingDirectory: String?
+
     // The following build settings help Previews diagnose certain situations where it
     // won't succeed or offer help if something goes wrong.
 
@@ -109,6 +112,7 @@ public struct SWBPreviewTargetDependencyInfo: SWBPreviewInfoContext, Hashable, S
         pifGUID: String,
         objectFileInputMap: [String : Set<String>],
         linkCommandLine: [String],
+        linkerWorkingDirectory: String?,
         swiftEnableOpaqueTypeErasure: Bool,
         swiftUseIntegratedDriver: Bool,
         enableJITPreviews: Bool,
@@ -124,6 +128,7 @@ public struct SWBPreviewTargetDependencyInfo: SWBPreviewInfoContext, Hashable, S
         self.pifGUID = pifGUID
         self.objectFileInputMap = objectFileInputMap
         self.linkCommandLine = linkCommandLine
+        self.linkerWorkingDirectory = linkerWorkingDirectory
         self.swiftEnableOpaqueTypeErasure = swiftEnableOpaqueTypeErasure
         self.swiftUseIntegratedDriver = swiftUseIntegratedDriver
         self.enableJITPreviews = enableJITPreviews

Tests/SwiftBuildTests/GeneratePreviewInfoTests.swift

@@ -254,6 +254,7 @@ fileprivate struct GeneratePreviewInfoTests: CoreBasedTests {
                                 "-o",
                                 "\(tmpDir.str)/Test/build/Debug-iphoneos/App.app/App.debug.dylib"
                             ],
+                            linkerWorkingDirectory: "\(tmpDir.str)/Test",
                             swiftEnableOpaqueTypeErasure: false,
                             swiftUseIntegratedDriver: true,
                             enableJITPreviews: true,
@@ -398,6 +399,7 @@ fileprivate struct GeneratePreviewInfoTests: CoreBasedTests {
                                 "-o",
                                 "\(tmpDir.str)/Test/build/Debug-iphoneos/libStaticLib.a"
                             ],
+                            linkerWorkingDirectory: "\(tmpDir.str)/Test",
                             swiftEnableOpaqueTypeErasure: false,
                             swiftUseIntegratedDriver: true,
                             enableJITPreviews: true,
@@ -523,6 +525,7 @@ fileprivate struct GeneratePreviewInfoTests: CoreBasedTests {
                                 "-o",
                                 "\(tmpDir.str)/Test/build/Debug-iphoneos/CApplication.app/CApplication"
                             ],
+                            linkerWorkingDirectory: "\(tmpDir.str)/Test",
                             swiftEnableOpaqueTypeErasure: false,
                             swiftUseIntegratedDriver: true,
                             enableJITPreviews: false,