Skip to content

[5.9] Build command plugin dependencies for the host, not the target #6799

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Aug 14, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 5 additions & 1 deletion Sources/Commands/PackageTools/PluginCommand.swift
Original file line number Diff line number Diff line change
Expand Up @@ -249,7 +249,11 @@ struct PluginCommand: SwiftCommand {
+ getEnvSearchPaths(pathString: ProcessEnv.path, currentWorkingDirectory: .none)

// Build or bring up-to-date any executable host-side tools on which this plugin depends. Add them and any binary dependencies to the tool-names-to-path map.
let buildSystem = try swiftTool.createBuildSystem(explicitBuildSystem: .native, cacheBuildManifest: false)
let buildSystem = try swiftTool.createBuildSystem(
explicitBuildSystem: .native,
cacheBuildManifest: false,
customBuildParameters: swiftTool.hostBuildParameters()
)
let accessibleTools = try plugin.processAccessibleTools(
packageGraph: packageGraph,
fileSystem: swiftTool.fileSystem,
Expand Down
86 changes: 49 additions & 37 deletions Sources/CoreCommands/SwiftTool.swift
Original file line number Diff line number Diff line change
Expand Up @@ -664,50 +664,62 @@ public final class SwiftTool {
return buildSystem
}

private func _buildParams(toolchain: UserToolchain) throws -> BuildParameters {
let destinationTriple = toolchain.triple

let dataPath = self.scratchDirectory.appending(
component: destinationTriple.platformBuildPathComponent(buildSystem: options.build.buildSystem)
)

return try BuildParameters(
dataPath: dataPath,
configuration: options.build.configuration,
toolchain: toolchain,
destinationTriple: destinationTriple,
flags: options.build.buildFlags,
pkgConfigDirectories: options.locations.pkgConfigDirectories,
architectures: options.build.architectures,
workers: options.build.jobs ?? UInt32(ProcessInfo.processInfo.activeProcessorCount),
shouldLinkStaticSwiftStdlib: options.linker.shouldLinkStaticSwiftStdlib,
canRenameEntrypointFunctionName: driverSupport.checkSupportedFrontendFlags(
flags: ["entry-point-function-name"],
toolchain: toolchain,
fileSystem: self.fileSystem
),
sanitizers: options.build.enabledSanitizers,
enableCodeCoverage: false, // set by test commands when appropriate
indexStoreMode: options.build.indexStoreMode.buildParameter,
enableParseableModuleInterfaces: options.build.shouldEnableParseableModuleInterfaces,
useIntegratedSwiftDriver: options.build.useIntegratedSwiftDriver,
useExplicitModuleBuild: options.build.useExplicitModuleBuild,
isXcodeBuildSystemEnabled: options.build.buildSystem == .xcode,
forceTestDiscovery: options.build.enableTestDiscovery, // backwards compatibility, remove with --enable-test-discovery
testEntryPointPath: options.build.testEntryPointPath,
explicitTargetDependencyImportCheckingMode: options.build.explicitTargetDependencyImportCheck.modeParameter,
linkerDeadStrip: options.linker.linkerDeadStrip,
verboseOutput: self.logLevel <= .info
)
}

/// Return the build parameters for the host toolchain.
public func hostBuildParameters() throws -> BuildParameters {
return try _hostBuildParameters.get()
}

private lazy var _hostBuildParameters: Result<BuildParameters, Swift.Error> = {
return Result(catching: {
try _buildParams(toolchain: self.getHostToolchain())
})
}()

/// Return the build parameters.
public func buildParameters() throws -> BuildParameters {
return try _buildParameters.get()
}

private lazy var _buildParameters: Result<BuildParameters, Swift.Error> = {
return Result(catching: {
let destinationToolchain = try self.getDestinationToolchain()
let destinationTriple = destinationToolchain.triple

// Use "apple" as the subdirectory because in theory Xcode build system
// can be used to build for any Apple platform and it has it's own
// conventions for build subpaths based on platforms.
let dataPath = self.scratchDirectory.appending(
component: destinationTriple.platformBuildPathComponent(buildSystem: options.build.buildSystem)
)

return try BuildParameters(
dataPath: dataPath,
configuration: options.build.configuration,
toolchain: destinationToolchain,
destinationTriple: destinationTriple,
flags: options.build.buildFlags,
pkgConfigDirectories: options.locations.pkgConfigDirectories,
architectures: options.build.architectures,
workers: options.build.jobs ?? UInt32(ProcessInfo.processInfo.activeProcessorCount),
shouldLinkStaticSwiftStdlib: options.linker.shouldLinkStaticSwiftStdlib,
canRenameEntrypointFunctionName: driverSupport.checkSupportedFrontendFlags(
flags: ["entry-point-function-name"], toolchain: destinationToolchain, fileSystem: self.fileSystem
),
sanitizers: options.build.enabledSanitizers,
enableCodeCoverage: false, // set by test commands when appropriate
indexStoreMode: options.build.indexStoreMode.buildParameter,
enableParseableModuleInterfaces: options.build.shouldEnableParseableModuleInterfaces,
emitSwiftModuleSeparately: options.build.emitSwiftModuleSeparately,
useIntegratedSwiftDriver: options.build.useIntegratedSwiftDriver,
useExplicitModuleBuild: options.build.useExplicitModuleBuild,
isXcodeBuildSystemEnabled: options.build.buildSystem == .xcode,
forceTestDiscovery: options.build.enableTestDiscovery, // backwards compatibility, remove with --enable-test-discovery
testEntryPointPath: options.build.testEntryPointPath,
explicitTargetDependencyImportCheckingMode: options.build.explicitTargetDependencyImportCheck.modeParameter,
linkerDeadStrip: options.linker.linkerDeadStrip,
verboseOutput: self.logLevel <= .info
)
try _buildParams(toolchain: self.getDestinationToolchain())
})
}()

Expand Down
3 changes: 3 additions & 0 deletions Sources/SPMBuildCore/Triple+Extensions.swift
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,9 @@ extension Triple {

extension Triple {
public func platformBuildPathComponent(buildSystem: BuildSystemProvider.Kind) -> String {
// Use "apple" as the subdirectory because in theory Xcode build system
// can be used to build for any Apple platform and it has its own
// conventions for build subpaths based on platforms.
buildSystem == .xcode ? "apple" : self.platformBuildPathComponent()
}
}