1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498
|
//===----------------------------------------------------------------------===//
//
// This source file is part of the Swift open source project
//
// Copyright (c) 2022-2024 Apple Inc. and the Swift project authors
// Licensed under Apache License v2.0 with Runtime Library Exception
//
// See http://swift.org/LICENSE.txt for license information
// See http://swift.org/CONTRIBUTORS.txt for the list of Swift project authors
//
//===----------------------------------------------------------------------===//
import ArgumentParser
import Basics
import Build
import Dispatch
@_spi(SwiftPMInternal)
import DriverSupport
import Foundation
import OrderedCollections
import PackageGraph
import PackageLoading
import PackageModel
import SPMBuildCore
import XCBuildSupport
import struct TSCBasic.KeyedPair
import func TSCBasic.topologicalSort
import var TSCBasic.stdoutStream
import enum TSCUtility.Diagnostics
import struct TSCUtility.Version
SwiftBootstrapBuildTool.main()
struct SwiftBootstrapBuildTool: ParsableCommand {
static let configuration = CommandConfiguration(
commandName: "swift-bootstrap",
abstract: "Bootstrapping build tool, only use in the context of bootstrapping SwiftPM itself",
shouldDisplay: false
)
@Option(name: .customLong("package-path"),
help: "Specify the package path to operate on (default current directory). This changes the working directory before any other operation",
completion: .directory)
public var packageDirectory: AbsolutePath?
/// The custom .build directory, if provided.
@Option(name: .customLong("scratch-path"), help: "Specify a custom scratch directory path (default .build)", completion: .directory)
var _scratchDirectory: AbsolutePath?
@Option(name: .customLong("build-path"), help: .hidden)
var _deprecated_buildPath: AbsolutePath?
var scratchDirectory: AbsolutePath? {
self._scratchDirectory ?? self._deprecated_buildPath
}
@Option(name: .shortAndLong, help: "Build with configuration")
public var configuration: BuildConfiguration = .debug
@Option(name: .customLong("Xcc", withSingleDash: true),
parsing: .unconditionalSingleValue,
help: "Pass flag through to all C compiler invocations")
var cCompilerFlags: [String] = []
@Option(name: .customLong("Xswiftc", withSingleDash: true),
parsing: .unconditionalSingleValue,
help: "Pass flag through to all Swift compiler invocations")
var swiftCompilerFlags: [String] = []
@Option(name: .customLong("Xlinker", withSingleDash: true),
parsing: .unconditionalSingleValue,
help: "Pass flag through to all linker invocations")
var linkerFlags: [String] = []
@Option(name: .customLong("Xcxx", withSingleDash: true),
parsing: .unconditionalSingleValue,
help: "Pass flag through to all C++ compiler invocations")
var cxxCompilerFlags: [String] = []
@Option(name: .customLong("Xxcbuild", withSingleDash: true),
parsing: .unconditionalSingleValue,
help: ArgumentHelp(
"Pass flag through to the Xcode build system invocations",
visibility: .hidden))
public var xcbuildFlags: [String] = []
@Option(name: .customLong("Xbuild-tools-swiftc", withSingleDash: true),
parsing: .unconditionalSingleValue,
help: ArgumentHelp("Pass flag to the manifest build invocation",
visibility: .hidden))
public var manifestFlags: [String] = []
@Option(
name: .customLong("arch"),
help: ArgumentHelp("Build the package for the these architectures", visibility: .hidden))
public var architectures: [String] = []
/// The verbosity of informational output.
@Flag(name: .shortAndLong, help: "Increase verbosity to include informational output")
public var verbose: Bool = false
/// The verbosity of informational output.
@Flag(name: [.long, .customLong("vv")], help: "Increase verbosity to include debug output")
public var veryVerbose: Bool = false
/// Whether to use the integrated Swift driver rather than shelling out
/// to a separate process.
@Flag()
public var useIntegratedSwiftDriver: Bool = false
/// A flag that indicates this build should check whether targets only import
/// their explicitly-declared dependencies
@Option()
public var explicitTargetDependencyImportCheck: TargetDependencyImportCheckingMode = .none
enum TargetDependencyImportCheckingMode: String, Codable, ExpressibleByArgument {
case none
case error
}
/// Disables adding $ORIGIN/@loader_path to the rpath, useful when deploying
@Flag(name: .customLong("disable-local-rpath"), help: "Disable adding $ORIGIN/@loader_path to the rpath by default")
public var shouldDisableLocalRpath: Bool = false
private var buildSystem: BuildSystemProvider.Kind {
#if os(macOS)
// Force the Xcode build system if we want to build more than one arch.
return self.architectures.count > 1 ? .xcode : .native
#else
// Force building with the native build system on other platforms than macOS.
return .native
#endif
}
public var buildFlags: BuildFlags {
BuildFlags(
cCompilerFlags: self.cCompilerFlags,
cxxCompilerFlags: self.cxxCompilerFlags,
swiftCompilerFlags: self.swiftCompilerFlags,
linkerFlags: self.linkerFlags,
xcbuildFlags: self.xcbuildFlags
)
}
private var logLevel: Basics.Diagnostic.Severity {
if self.verbose {
return .info
} else if self.veryVerbose {
return .debug
} else {
return .warning
}
}
public init() {}
public func run() throws {
do {
let fileSystem = localFileSystem
let observabilityScope = ObservabilitySystem { _, diagnostics in
if diagnostics.severity >= logLevel {
print(diagnostics)
}
}.topScope
guard let cwd: AbsolutePath = fileSystem.currentWorkingDirectory else {
observabilityScope.emit(error: "couldn't determine the current working directory")
throw ExitCode.failure
}
guard let packagePath = packageDirectory ?? localFileSystem.currentWorkingDirectory else {
throw StringError("unknown package path")
}
let scratchDirectory =
try BuildSystemUtilities.getEnvBuildPath(workingDir: cwd) ??
self.scratchDirectory ??
packagePath.appending(".build")
let builder = try Builder(
fileSystem: localFileSystem,
observabilityScope: observabilityScope,
logLevel: self.logLevel
)
try builder.build(
packagePath: packagePath,
scratchDirectory: scratchDirectory,
buildSystem: self.buildSystem,
configuration: self.configuration,
architectures: self.architectures,
buildFlags: self.buildFlags,
manifestBuildFlags: self.manifestFlags,
useIntegratedSwiftDriver: self.useIntegratedSwiftDriver,
explicitTargetDependencyImportCheck: self.explicitTargetDependencyImportCheck,
shouldDisableLocalRpath: self.shouldDisableLocalRpath
)
} catch _ as Diagnostics {
throw ExitCode.failure
}
}
struct Builder {
let identityResolver: IdentityResolver
let dependencyMapper: DependencyMapper
let hostToolchain: UserToolchain
let targetToolchain: UserToolchain
let fileSystem: FileSystem
let observabilityScope: ObservabilityScope
let logLevel: Basics.Diagnostic.Severity
static let additionalSwiftBuildFlags = [
"-Xfrontend", "-disable-implicit-concurrency-module-import",
"-Xfrontend", "-disable-implicit-string-processing-module-import"
]
init(fileSystem: FileSystem, observabilityScope: ObservabilityScope, logLevel: Basics.Diagnostic.Severity) throws {
self.identityResolver = DefaultIdentityResolver()
self.dependencyMapper = DefaultDependencyMapper(identityResolver: self.identityResolver)
let environment = Environment.current
self.hostToolchain = try UserToolchain(
swiftSDK: SwiftSDK.hostSwiftSDK(
environment: environment,
fileSystem: fileSystem
),
environment: environment
)
self.targetToolchain = hostToolchain // TODO: support cross-compilation?
self.fileSystem = fileSystem
self.observabilityScope = observabilityScope
self.logLevel = logLevel
}
func build(
packagePath: AbsolutePath,
scratchDirectory: AbsolutePath,
buildSystem: BuildSystemProvider.Kind,
configuration: BuildConfiguration,
architectures: [String],
buildFlags: BuildFlags,
manifestBuildFlags: [String],
useIntegratedSwiftDriver: Bool,
explicitTargetDependencyImportCheck: TargetDependencyImportCheckingMode,
shouldDisableLocalRpath: Bool
) throws {
let buildSystem = try createBuildSystem(
packagePath: packagePath,
scratchDirectory: scratchDirectory,
buildSystem: buildSystem,
configuration: configuration,
architectures: architectures,
buildFlags: buildFlags,
manifestBuildFlags: manifestBuildFlags,
useIntegratedSwiftDriver: useIntegratedSwiftDriver,
explicitTargetDependencyImportCheck: explicitTargetDependencyImportCheck,
shouldDisableLocalRpath: shouldDisableLocalRpath,
logLevel: logLevel
)
try buildSystem.build(subset: .allExcludingTests)
}
func createBuildSystem(
packagePath: AbsolutePath,
scratchDirectory: AbsolutePath,
buildSystem: BuildSystemProvider.Kind,
configuration: BuildConfiguration,
architectures: [String],
buildFlags: BuildFlags,
manifestBuildFlags: [String],
useIntegratedSwiftDriver: Bool,
explicitTargetDependencyImportCheck: TargetDependencyImportCheckingMode,
shouldDisableLocalRpath: Bool,
logLevel: Basics.Diagnostic.Severity
) throws -> BuildSystem {
var buildFlags = buildFlags
buildFlags.swiftCompilerFlags += Self.additionalSwiftBuildFlags
let dataPath = scratchDirectory.appending(
component: self.targetToolchain.targetTriple.platformBuildPathComponent(buildSystem: buildSystem)
)
let buildParameters = try BuildParameters(
destination: .target,
dataPath: dataPath,
configuration: configuration,
toolchain: self.targetToolchain,
triple: self.hostToolchain.targetTriple,
flags: buildFlags,
architectures: architectures,
isXcodeBuildSystemEnabled: buildSystem == .xcode,
driverParameters: .init(
explicitTargetDependencyImportCheckingMode: explicitTargetDependencyImportCheck == .error ? .error : .none,
useIntegratedSwiftDriver: useIntegratedSwiftDriver,
isPackageAccessModifierSupported: DriverSupport.isPackageNameSupported(
toolchain: targetToolchain,
fileSystem: self.fileSystem
)
),
linkingParameters: .init(
shouldDisableLocalRpath: shouldDisableLocalRpath
),
outputParameters: .init(
isVerbose: logLevel <= .info
)
)
let manifestLoader = createManifestLoader(manifestBuildFlags: manifestBuildFlags)
let packageGraphLoader = {
try self.loadPackageGraph(packagePath: packagePath, manifestLoader: manifestLoader)
}
switch buildSystem {
case .native:
return BuildOperation(
// when building `swift-bootstrap`, host and target build parameters are the same
productsBuildParameters: buildParameters,
toolsBuildParameters: buildParameters,
cacheBuildManifest: false,
packageGraphLoader: packageGraphLoader,
scratchDirectory: scratchDirectory,
additionalFileRules: [],
pkgConfigDirectories: [],
outputStream: TSCBasic.stdoutStream,
logLevel: logLevel,
fileSystem: self.fileSystem,
observabilityScope: self.observabilityScope
)
case .xcode:
return try XcodeBuildSystem(
buildParameters: buildParameters,
packageGraphLoader: packageGraphLoader,
outputStream: TSCBasic.stdoutStream,
logLevel: logLevel,
fileSystem: self.fileSystem,
observabilityScope: self.observabilityScope
)
}
}
func createManifestLoader(manifestBuildFlags: [String]) -> ManifestLoader {
var extraManifestFlags = manifestBuildFlags + Self.additionalSwiftBuildFlags
if self.logLevel <= .info {
extraManifestFlags.append("-v")
}
return ManifestLoader(
toolchain: self.hostToolchain,
isManifestSandboxEnabled: false,
extraManifestFlags: extraManifestFlags
)
}
func loadPackageGraph(packagePath: AbsolutePath, manifestLoader: ManifestLoader) throws -> ModulesGraph {
let rootPackageRef = PackageReference(identity: .init(path: packagePath), kind: .root(packagePath))
let rootPackageManifest = try temp_await { self.loadManifest(manifestLoader: manifestLoader, package: rootPackageRef, completion: $0) }
var loadedManifests = [PackageIdentity: Manifest]()
loadedManifests[rootPackageRef.identity] = rootPackageManifest
// Compute the transitive closure of available dependencies.
let input = loadedManifests.map { identity, manifest in KeyedPair(manifest, key: identity) }
_ = try topologicalSort(input) { pair in
let dependenciesRequired = pair.item.dependenciesRequired(for: .everything)
let dependenciesToLoad = dependenciesRequired.map{ $0.packageRef }.filter { !loadedManifests.keys.contains($0.identity) }
let dependenciesManifests = try temp_await { self.loadManifests(manifestLoader: manifestLoader, packages: dependenciesToLoad, completion: $0) }
dependenciesManifests.forEach { loadedManifests[$0.key] = $0.value }
return dependenciesRequired.compactMap { dependency in
loadedManifests[dependency.identity].flatMap {
KeyedPair($0, key: dependency.identity)
}
}
}
let packageGraphRoot = PackageGraphRoot(
input: .init(packages: [packagePath]),
manifests: [packagePath: rootPackageManifest],
observabilityScope: observabilityScope
)
return try ModulesGraph.load(
root: packageGraphRoot,
identityResolver: identityResolver,
externalManifests: loadedManifests.reduce(into: OrderedCollections.OrderedDictionary<PackageIdentity, (manifest: Manifest, fs: FileSystem)>()) { partial, item in
partial[item.key] = (manifest: item.value, fs: self.fileSystem)
},
binaryArtifacts: [:],
fileSystem: fileSystem,
observabilityScope: observabilityScope,
// Plugins can't be used in bootstrap builds, exclude those.
productsFilter: {
$0.type != .plugin
},
modulesFilter: {
$0.type != .plugin
}
)
}
func loadManifests(
manifestLoader: ManifestLoader,
packages: [PackageReference],
completion: @escaping (Result<[PackageIdentity: Manifest], Error>) -> Void
) {
let sync = DispatchGroup()
let manifestsLock = NSLock()
var manifests = [PackageIdentity: Manifest]()
Set(packages).forEach { package in
sync.enter()
self.loadManifest(manifestLoader: manifestLoader, package: package) { result in
defer { sync.leave() }
switch result {
case .success(let manifest):
manifestsLock.withLock {
manifests[package.identity] = manifest
}
case .failure(let error):
return completion(.failure(error))
}
}
}
sync.notify(queue: .sharedConcurrent) {
completion(.success(manifestsLock.withLock { manifests }))
}
}
func loadManifest(
manifestLoader: ManifestLoader,
package: PackageReference,
completion: @escaping (Result<Manifest, Error>) -> Void
) {
do {
let packagePath = try AbsolutePath(validating: package.locationString) // FIXME
let manifestPath = packagePath.appending(component: Manifest.filename)
let manifestToolsVersion = try ToolsVersionParser.parse(manifestPath: manifestPath, fileSystem: fileSystem)
manifestLoader.load(
manifestPath: manifestPath,
manifestToolsVersion: manifestToolsVersion,
packageIdentity: package.identity,
packageKind: package.kind,
packageLocation: package.locationString,
packageVersion: .none,
identityResolver: identityResolver,
dependencyMapper: dependencyMapper,
fileSystem: fileSystem,
observabilityScope: observabilityScope,
delegateQueue: .sharedConcurrent,
callbackQueue: .sharedConcurrent,
completion: completion
)
} catch {
completion(.failure(error))
}
}
}
}
// TODO: move to shared area
extension AbsolutePath {
public init?(argument: String) {
if let cwd: AbsolutePath = localFileSystem.currentWorkingDirectory {
guard let path = try? AbsolutePath(validating: argument, relativeTo: cwd) else {
return nil
}
self = path
} else {
guard let path = try? AbsolutePath(validating: argument) else {
return nil
}
self = path
}
}
public static var defaultCompletionKind: CompletionKind {
// This type is most commonly used to select a directory, not a file.
// Specify '.file()' in an argument declaration when necessary.
.directory
}
}
extension BuildConfiguration {
public init?(argument: String) {
self.init(rawValue: argument)
}
}
#if compiler(<6.0)
extension AbsolutePath: ExpressibleByArgument {}
extension BuildConfiguration: ExpressibleByArgument {}
#else
extension AbsolutePath: @retroactive ExpressibleByArgument {}
extension BuildConfiguration: @retroactive ExpressibleByArgument {}
#endif
|