Merge pull request #10052 from owenv/owenv/productsdir

[6.4] Query the underlying build system when determining the build products dir

Author: owenv

Sources/Build/BuildDescription/ClangModuleBuildDescription.swift

@@ -335,7 +335,7 @@ public final class ClangModuleBuildDescription {
 
         // Only add the build path to the framework search path if there are binary frameworks to link against.
         if !libraryBinaryPaths.isEmpty {
-            args += ["-F", buildParameters.buildPath.pathString]
+            args += ["-F", BuildOperation.buildProductsPath(for: buildParameters).pathString]
         }
 
         args += ["-I", clangTarget.includeDir.pathString]

Sources/Build/BuildDescription/ProductBuildDescription.swift

@@ -67,10 +67,15 @@ public final class ProductBuildDescription: SPMBuildCore.ProductBuildDescription
     /// Paths to tools shipped in binary dependencies
     var availableTools: [String: AbsolutePath] = [:]
 
+    /// Path to the build products directory.
+    public var productsPath: AbsolutePath {
+        BuildOperation.buildProductsPath(for: self.buildParameters)
+    }
+
     /// Path to the temporary directory for this product.
     var tempsPath: AbsolutePath {
         let suffix = buildParameters.suffix
-        return self.buildParameters.buildPath.appending(component: "\(self.product.name)\(suffix).product")
+        return self.productsPath.appending(component: "\(self.product.name)\(suffix).product")
     }
 
     /// Path to the link filelist file.
@@ -161,10 +166,10 @@ public final class ProductBuildDescription: SPMBuildCore.ProductBuildDescription
 
         // Only add the build path to the framework search path if there are binary frameworks to link against.
         if !self.libraryBinaryPaths.isEmpty {
-            args += ["-F", self.buildParameters.buildPath.pathString]
+            args += ["-F", BuildOperation.buildProductsPath(for: self.buildParameters).pathString]
         }
 
-        args += ["-L", self.buildParameters.buildPath.pathString]
+        args += ["-L", BuildOperation.buildProductsPath(for: self.buildParameters).pathString]
         args += try ["-o", binaryPath.pathString]
         args += ["-module-name", self.product.name.spm_mangledToC99ExtendedIdentifier()]
         args += self.dylibs.map { "-l" + $0.product.name + $0.buildParameters.suffix }

Sources/Build/BuildDescription/ResolvedModule+BuildDescription.swift

@@ -18,6 +18,6 @@ import SPMBuildCore
 extension ResolvedModule {
     func tempsPath(_ buildParameters: BuildParameters) -> AbsolutePath {
         let suffix = buildParameters.suffix
-        return buildParameters.buildPath.appending(component: "\(self.c99name)\(suffix).build")
+        return BuildOperation.buildProductsPath(for: buildParameters).appending(component: "\(self.c99name)\(suffix).build")
     }
 }

Sources/Build/BuildDescription/SwiftModuleBuildDescription.swift

@@ -138,7 +138,7 @@ public final class SwiftModuleBuildDescription {
 
     var modulesPath: AbsolutePath {
         let suffix = self.buildParameters.suffix
-        return self.buildParameters.buildPath.appending(component: "Modules\(suffix)")
+        return BuildOperation.buildProductsPath(for: self.buildParameters).appending(component: "Modules\(suffix)")
     }
 
     /// The path to the swiftmodule file after compilation.
@@ -459,13 +459,13 @@ public final class SwiftModuleBuildDescription {
         try self.requiredMacros.forEach { macro in
             args += [
                 "-Xfrontend", "-load-plugin-library",
-                "-Xfrontend", macroBuildParameters.macroBinaryPath(macro).pathString
+                "-Xfrontend", BuildOperation.macroBinaryPath(for: macro, parameters: macroBuildParameters).pathString
             ]
         }
         #else
         let macroModules = try self.requiredMacros
         try macroModules.forEach { macro in
-            let executablePath = try macroBuildParameters.macroBinaryPath(macro).pathString
+            let executablePath = try BuildOperation.macroBinaryPath(for: macro, parameters: macroBuildParameters).pathString
             args += ["-Xfrontend", "-load-plugin-executable", "-Xfrontend", "\(executablePath)#\(macro.c99name)"]
         }
         #endif
@@ -563,7 +563,7 @@ public final class SwiftModuleBuildDescription {
 
         // Only add the build path to the framework search path if there are binary frameworks to link against.
         if !self.libraryBinaryPaths.isEmpty {
-            args += ["-F", self.buildParameters.buildPath.pathString]
+            args += ["-F", BuildOperation.buildProductsPath(for: self.buildParameters).pathString]
         }
 
         // Emit the ObjC compatibility header if enabled.

Sources/Build/BuildManifest/LLBuildManifestBuilder+Swift.swift

@@ -381,7 +381,7 @@ extension LLBuildManifestBuilder {
 
         // Otherwise, come up with a path for the new file and generate a command to populate it.
         let swiftCompilerPathHash = String(swiftCompilerPath.pathString.hash, radix: 16, uppercase: true)
-        let swiftVersionFilePath = buildParameters.buildPath.appending(component: "swift-version-\(swiftCompilerPathHash).txt")
+        let swiftVersionFilePath = BuildOperation.buildProductsPath(for: buildParameters).appending(component: "swift-version-\(swiftCompilerPathHash).txt")
         self.manifest.addSwiftGetVersionCommand(swiftCompilerPath: swiftCompilerPath, swiftVersionFilePath: swiftVersionFilePath)
         swiftGetVersionFiles[swiftCompilerPath] = swiftVersionFilePath
         return swiftVersionFilePath

Sources/Build/BuildManifest/LLBuildManifestBuilder.swift

@@ -342,7 +342,7 @@ extension LLBuildManifestBuilder {
 
 extension BuildParameters {
     func destinationPath(forBinaryAt path: AbsolutePath) -> AbsolutePath {
-        self.buildPath.appending(component: path.basename)
+        BuildOperation.buildProductsPath(for: self).appending(component: path.basename)
     }
 
     var buildConfig: String { self.configuration.dirname }

Sources/Build/BuildOperation.swift

@@ -74,7 +74,7 @@ package struct LLBuildSystemConfiguration {
         self.traitConfiguration = traitConfiguration
         self.manifestPath = manifestPath ?? destinationBuildParameters.llbuildManifest
         self.databasePath = databasePath ?? scratchDirectory.appending("build.db")
-        self.buildDescriptionPath = buildDescriptionPath ?? destinationBuildParameters.buildDescriptionPath
+        self.buildDescriptionPath = buildDescriptionPath ?? BuildOperation.buildDescriptionPath(for: destinationBuildParameters)
         self.fileSystem = fileSystem
         self.logLevel = logLevel
         self.outputStream = outputStream
@@ -109,13 +109,6 @@ package struct LLBuildSystemConfiguration {
         }
     }
 
-    func buildPath(for description: BuildParameters.Destination) -> AbsolutePath {
-        switch description {
-        case .host: self.toolsBuildParameters.buildPath
-        case .target: self.destinationBuildParameters.buildPath
-        }
-    }
-
     func dataPath(for description: BuildParameters.Destination) -> AbsolutePath {
         switch description {
         case .host: self.toolsBuildParameters.dataPath
@@ -125,8 +118,8 @@ package struct LLBuildSystemConfiguration {
 
     func buildDescriptionPath(for description: BuildParameters.Destination) -> AbsolutePath {
         switch description {
-        case .host: self.toolsBuildParameters.buildDescriptionPath
-        case .target: self.destinationBuildParameters.buildDescriptionPath
+        case .host: BuildOperation.buildDescriptionPath(for: self.toolsBuildParameters)
+        case .target: BuildOperation.buildDescriptionPath(for: self.destinationBuildParameters)
         }
     }
 
@@ -200,6 +193,44 @@ public final class BuildOperation: PackageStructureDelegate, SPMBuildCore.BuildS
 
     public var hasIntegratedAPIDigesterSupport: Bool { false }
 
+    public func buildProductsPath(for parameters: BuildParameters) async throws -> AbsolutePath {
+        Self.buildProductsPath(for: parameters)
+    }
+
+    public static func buildProductsPath(for parameters: BuildParameters) -> AbsolutePath {
+        parameters.dataPath.appending(component: parameters.configuration.dirname)
+    }
+
+    /// The path to the index store directory for the given build parameters under the native build system.
+    public static func indexStore(for parameters: BuildParameters) -> AbsolutePath {
+        buildProductsPath(for: parameters).appending(components: "index", "store")
+    }
+
+    /// The path to the build description for the given build parameters under the native build system.
+    public static func buildDescriptionPath(for parameters: BuildParameters) -> AbsolutePath {
+        buildProductsPath(for: parameters).appending(components: "description.json")
+    }
+
+    /// The path to the test output file for the given build parameters under the native build system.
+    public static func testOutputPath(for parameters: BuildParameters) -> AbsolutePath {
+        buildProductsPath(for: parameters).appending(component: "testOutput.txt")
+    }
+
+    /// Returns the path to the binary of a product for the given build parameters under the native build system.
+    public static func binaryPath(for product: ResolvedProduct, parameters: BuildParameters) throws -> AbsolutePath {
+        try buildProductsPath(for: parameters).appending(parameters.binaryRelativePath(for: product))
+    }
+
+    /// Returns the path to the built binary for a macro module under the native build system.
+    public static func macroBinaryPath(for module: ResolvedModule, parameters: BuildParameters) throws -> AbsolutePath {
+        assert(module.type == .macro)
+        #if BUILD_MACROS_AS_DYLIBS
+        return try buildProductsPath(for: parameters).appending(parameters.dynamicLibraryPath(for: module.name))
+        #else
+        return try buildProductsPath(for: parameters).appending(parameters.executablePath(for: module.name))
+        #endif
+    }
+
     public convenience init(
         productsBuildParameters: BuildParameters,
         toolsBuildParameters: BuildParameters,
@@ -524,7 +555,7 @@ public final class BuildOperation: PackageStructureDelegate, SPMBuildCore.BuildS
         do {
             try self.fileSystem.createSymbolicLink(
                 oldBuildPath,
-                pointingAt: self.config.buildPath(for: .target),
+                pointingAt: Self.buildProductsPath(for: self.config.destinationBuildParameters),
                 relative: true
             )
         } catch {
@@ -984,7 +1015,7 @@ extension BuildOperation {
         // `buildPackageStructure` to recognize the split.
         config.databasePath = config.scratchDirectory.appending("plugin-tools.db")
 
-        config.buildDescriptionPath = config.buildPath(for: .host).appending(
+        config.buildDescriptionPath = Self.buildProductsPath(for: self.config.toolsBuildParameters).appending(
             component: "plugin-tools-description.json"
         )
 
@@ -1034,7 +1065,7 @@ extension BuildOperation {
                     if let result = try await buildToolBuilder(name, path) {
                         return result
                     } else {
-                        return config.buildPath(for: .host).appending(path)
+                        return Self.buildProductsPath(for: config.toolsBuildParameters).appending(path)
                     }
                 }
 

Sources/Build/BuildPlan/BuildPlan+Test.swift

@@ -77,7 +77,7 @@ extension BuildPlan {
             /// Generates test discovery modules, which contain derived sources listing the discovered tests.
             func generateDiscoveryTargets() throws -> (target: SwiftModule, resolved: ResolvedModule, buildDescription: SwiftModuleBuildDescription) {
                 let discoveryTargetName = "\(package.manifest.displayName)PackageDiscoveredTests"
-                let discoveryDerivedDir = destinationBuildParameters.buildPath.appending(components: "\(discoveryTargetName).derived")
+                let discoveryDerivedDir = BuildOperation.buildProductsPath(for: destinationBuildParameters).appending(components: "\(discoveryTargetName).derived")
                 let discoveryMainFile = discoveryDerivedDir.appending(component: TestDiscoveryTool.mainFileName)
 
                 var discoveryPaths: [AbsolutePath] = []
@@ -136,7 +136,7 @@ extension BuildPlan {
                 swiftTargetDependencies: [Module.Dependency],
                 resolvedTargetDependencies: [ResolvedModule.Dependency]
             ) throws -> SwiftModuleBuildDescription {
-                let entryPointDerivedDir = destinationBuildParameters.buildPath.appending(components: "\(testProduct.name).derived")
+                let entryPointDerivedDir = BuildOperation.buildProductsPath(for: destinationBuildParameters).appending(components: "\(testProduct.name).derived")
                 let entryPointMainFileName = TestEntryPointTool.mainFileName
                 let entryPointMainFile = entryPointDerivedDir.appending(component: entryPointMainFileName)
                 let entryPointSources = Sources(paths: [entryPointMainFile], root: entryPointDerivedDir)

Sources/Build/BuildPlan/BuildPlan.swift

@@ -45,7 +45,7 @@ extension BuildParameters {
             if let path = Environment.current["SWIFTPM_TESTS_MODULECACHE"] {
                 return try AbsolutePath(validating: path)
             }
-            return buildPath.appending("ModuleCache")
+            return BuildOperation.buildProductsPath(for: self).appending("ModuleCache")
         }
     }
 
@@ -69,7 +69,7 @@ extension BuildParameters {
         }
 
         if addIndexStoreArguments {
-            return ["-index-store-path", indexStore.pathString]
+            return ["-index-store-path", BuildOperation.indexStore(for: self).pathString]
         }
         return []
     }
@@ -588,7 +588,7 @@ public class BuildPlan: SPMBuildCore.BuildPlan {
     /// Creates arguments required to launch the Swift REPL that will allow
     /// importing the modules in the package graph.
     public func createREPLArguments() throws -> CLIArguments {
-        let buildPath = self.toolsBuildParameters.buildPath.pathString
+        let buildPath = BuildOperation.buildProductsPath(for: self.toolsBuildParameters).pathString
         var arguments = ["repl", "-I" + buildPath, "-L" + buildPath]
 
         // Link the special REPL product that contains all of the library targets.
@@ -1336,7 +1336,7 @@ extension Basics.Diagnostic {
 extension BuildParameters {
     /// Returns a named bundle's path inside the build directory.
     func bundlePath(named name: String) -> Basics.AbsolutePath {
-        self.buildPath.appending(component: name + self.triple.nsbundleExtension)
+        BuildOperation.buildProductsPath(for: self).appending(component: name + self.triple.nsbundleExtension)
     }
 }
 

Sources/Build/LLBuildCommands.swift

@@ -121,7 +121,7 @@ final class TestDiscoveryCommand: CustomLLBuildCommand, TestBuildCommand {
             return
         }
 
-        let index = self.context.productsBuildParameters.indexStore
+        let index = BuildOperation.indexStore(for: self.context.productsBuildParameters)
         let api = try self.context.indexStoreAPI.get()
         let store = try IndexStore.open(store: TSCAbsolutePath(index), api: api)