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 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538
|
//===--------------- DarwinToolchain.swift - Swift Darwin Toolchain -------===//
//
// This source file is part of the Swift.org open source project
//
// Copyright (c) 2014 - 2019 Apple Inc. and the Swift project authors
// Licensed under Apache License v2.0 with Runtime Library Exception
//
// See https://swift.org/LICENSE.txt for license information
// See https://swift.org/CONTRIBUTORS.txt for the list of Swift project authors
//
//===----------------------------------------------------------------------===//
import SwiftOptions
import struct Foundation.Data
import class Foundation.JSONDecoder
import protocol TSCBasic.FileSystem
import protocol TSCBasic.DiagnosticData
import class TSCBasic.DiagnosticsEngine
import struct TSCBasic.AbsolutePath
import struct TSCBasic.Diagnostic
import var TSCBasic.localFileSystem
/// Toolchain for Darwin-based platforms, such as macOS and iOS.
///
/// FIXME: This class is not thread-safe.
public final class DarwinToolchain: Toolchain {
public let env: [String: String]
/// Doubles as path cache and point for overriding normal lookup
private var toolPaths = [Tool: AbsolutePath]()
/// The executor used to run processes used to find tools and retrieve target info.
public let executor: DriverExecutor
/// The file system to use for any file operations.
public let fileSystem: FileSystem
// An externally provided path from where we should find compiler
public let compilerExecutableDir: AbsolutePath?
// An externally provided path from where we should find tools like ld
public let toolDirectory: AbsolutePath?
public let dummyForTestingObjectFormat = Triple.ObjectFormat.macho
public init(env: [String: String], executor: DriverExecutor, fileSystem: FileSystem = localFileSystem,
compilerExecutableDir: AbsolutePath? = nil, toolDirectory: AbsolutePath? = nil) {
self.env = env
self.executor = executor
self.fileSystem = fileSystem
self.compilerExecutableDir = compilerExecutableDir
self.toolDirectory = toolDirectory
}
/// Retrieve the absolute path for a given tool.
public func getToolPath(_ tool: Tool) throws -> AbsolutePath {
// Check the cache
if let toolPath = toolPaths[tool] {
return toolPath
}
let path = try lookupToolPath(tool)
// Cache the path
toolPaths[tool] = path
return path
}
private func lookupToolPath(_ tool: Tool) throws -> AbsolutePath {
switch tool {
case .swiftCompiler:
return try lookup(executable: "swift-frontend")
case .dynamicLinker:
return try lookup(executable: "clang")
case .staticLinker:
return try lookup(executable: "libtool")
case .dsymutil:
return try lookup(executable: "dsymutil")
case .clang:
return try lookup(executable: "clang")
case .clangxx:
return try lookup(executable: "clang++")
case .swiftAutolinkExtract:
return try lookup(executable: "swift-autolink-extract")
case .lldb:
return try lookup(executable: "lldb")
case .dwarfdump:
return try lookup(executable: "dwarfdump")
case .swiftHelp:
return try lookup(executable: "swift-help")
case .swiftAPIDigester:
return try lookup(executable: "swift-api-digester")
}
}
public func overrideToolPath(_ tool: Tool, path: AbsolutePath) {
toolPaths[tool] = path
}
public func clearKnownToolPath(_ tool: Tool) {
toolPaths.removeValue(forKey: tool)
}
/// Path to the StdLib inside the SDK.
public func sdkStdlib(sdk: AbsolutePath) throws -> AbsolutePath {
try AbsolutePath(validating: "usr/lib/swift", relativeTo: sdk)
}
public func makeLinkerOutputFilename(moduleName: String, type: LinkOutputType) -> String {
switch type {
case .executable: return moduleName
case .dynamicLibrary: return "lib\(moduleName).dylib"
case .staticLibrary: return "lib\(moduleName).a"
}
}
public func defaultSDKPath(_ target: Triple?) throws -> AbsolutePath? {
let hostIsMacOS: Bool
#if os(macOS)
hostIsMacOS = true
#else
hostIsMacOS = false
#endif
if target?.isMacOSX == true || hostIsMacOS {
let result = try executor.checkNonZeroExit(
args: "xcrun", "-sdk", "macosx", "--show-sdk-path",
environment: env
).trimmingCharacters(in: .whitespacesAndNewlines)
return try AbsolutePath(validating: result)
}
return nil
}
public var shouldStoreInvocationInDebugInfo: Bool {
// This matches the behavior in Clang.
!(env["RC_DEBUG_OPTIONS"]?.isEmpty ?? true)
}
public var globalDebugPathRemapping: String? {
// This matches the behavior in Clang.
if let map = env["RC_DEBUG_PREFIX_MAP"] {
if map.contains("=") {
return map
}
}
return nil
}
public func runtimeLibraryName(
for sanitizer: Sanitizer,
targetTriple: Triple,
isShared: Bool
) throws -> String {
return """
libclang_rt.\(sanitizer.libraryName)_\
\(targetTriple.darwinPlatform!.libraryNameSuffix)\
\(isShared ? "_dynamic.dylib" : ".a")
"""
}
public enum ToolchainValidationError: Error, DiagnosticData {
case osVersionBelowMinimumDeploymentTarget(platform: DarwinPlatform, version: Triple.Version)
case argumentNotSupported(String)
case invalidDeploymentTargetForIR(platform: DarwinPlatform, version: Triple.Version, archName: String)
case unsupportedTargetVariant(variant: Triple)
case darwinOnlySupportsLibCxx
public var description: String {
switch self {
case .osVersionBelowMinimumDeploymentTarget(let platform, let version):
return "Swift requires a minimum deployment target of \(platform.platformDisplayName) \(version.description)"
case .invalidDeploymentTargetForIR(let platform, let version, let archName):
return "\(platform.platformDisplayName) \(version.description) and above does not support emitting binaries or IR for \(archName)"
case .unsupportedTargetVariant(variant: let variant):
return "unsupported '\(variant.isiOS ? "-target-variant" : "-target")' value '\(variant.triple)'; use 'ios-macabi' instead"
case .argumentNotSupported(let argument):
return "\(argument) is no longer supported for Apple platforms"
case .darwinOnlySupportsLibCxx:
return "The only C++ standard library supported on Apple platforms is libc++"
}
}
}
public func validateArgs(_ parsedOptions: inout ParsedOptions,
targetTriple: Triple,
targetVariantTriple: Triple?,
compilerOutputType: FileType?,
diagnosticsEngine: DiagnosticsEngine) throws {
// On non-darwin hosts, libArcLite won't be found and a warning will be emitted
// Guard for the sake of tests running on all platforms
#if canImport(Darwin)
// Validating arclite library path when link-objc-runtime.
validateLinkObjcRuntimeARCLiteLib(&parsedOptions,
targetTriple: targetTriple,
diagnosticsEngine: diagnosticsEngine)
#endif
// Validating apple platforms deployment targets.
try validateDeploymentTarget(&parsedOptions, targetTriple: targetTriple,
compilerOutputType: compilerOutputType)
if let targetVariantTriple = targetVariantTriple,
!targetTriple.isValidForZipperingWithTriple(targetVariantTriple) {
throw ToolchainValidationError.unsupportedTargetVariant(variant: targetVariantTriple)
}
// Validating darwin unsupported -static-stdlib argument.
if parsedOptions.hasArgument(.staticStdlib) {
throw ToolchainValidationError.argumentNotSupported("-static-stdlib")
}
// Validating darwin unsupported -static-executable argument.
if parsedOptions.hasArgument(.staticExecutable) {
throw ToolchainValidationError.argumentNotSupported("-static-executable")
}
// If a C++ standard library is specified, it has to be libc++.
if let cxxLib = parsedOptions.getLastArgument(.experimentalCxxStdlib) {
if cxxLib.asSingle != "libc++" {
throw ToolchainValidationError.darwinOnlySupportsLibCxx
}
}
}
public func getDefaultDwarfVersion(targetTriple: Triple) -> UInt8 {
// Default to DWARF 2 on OS X 10.10 / iOS 8 and lower.
// Default to DWARF 4 on OS X 10.11 - macOS 14 / iOS - iOS 17.
if (targetTriple.isMacOSX && targetTriple.version(for: .macOS) < Triple.Version(10, 11, 0)) ||
(targetTriple.isiOS && targetTriple.version(
for: .iOS(targetTriple._isSimulatorEnvironment ? .simulator : .device)) < Triple.Version(9, 0, 0)) {
return 2;
}
if (targetTriple.isMacOSX && targetTriple.version(for: .macOS) < Triple.Version(15, 0, 0)) ||
(targetTriple.isiOS && targetTriple.version(
for: .iOS(targetTriple._isSimulatorEnvironment ? .simulator : .device)) < Triple.Version(18, 0, 0)) ||
(targetTriple.isTvOS && targetTriple.version(
for: .tvOS(targetTriple._isSimulatorEnvironment ? .simulator : .device)) < Triple.Version(18, 0, 0)) ||
(targetTriple.isWatchOS && targetTriple.version(
for: .watchOS(targetTriple._isSimulatorEnvironment ? .simulator : .device)) < Triple.Version(11, 0, 0)) ||
(targetTriple.isVisionOS && targetTriple.version(
for: .visionOS(targetTriple._isSimulatorEnvironment ? .simulator : .device)) < Triple.Version(2, 0, 0)){
return 4
}
return 5
}
func validateDeploymentTarget(_ parsedOptions: inout ParsedOptions,
targetTriple: Triple, compilerOutputType: FileType?) throws {
guard let os = targetTriple.os else {
return
}
// Check minimum supported OS versions. Note that Mac Catalyst falls into the iOS device case. The driver automatically uplevels the deployment target to iOS >= 13.1.
let minVersions: [Triple.OS: (DarwinPlatform, Triple.Version)] = [
.macosx: (.macOS, Triple.Version(10, 9, 0)),
.ios: (.iOS(targetTriple._isSimulatorEnvironment ? .simulator : .device), Triple.Version(7, 0, 0)),
.tvos: (.tvOS(targetTriple._isSimulatorEnvironment ? .simulator : .device), Triple.Version(9, 0, 0)),
.watchos: (.watchOS(targetTriple._isSimulatorEnvironment ? .simulator : .device), Triple.Version(2, 0, 0)),
.visionos: (.visionOS(targetTriple._isSimulatorEnvironment ? .simulator : .device), Triple.Version(1, 0, 0))
]
if let (platform, minVersion) = minVersions[os], targetTriple.version(for: platform) < minVersion {
throw ToolchainValidationError.osVersionBelowMinimumDeploymentTarget(platform: platform, version: minVersion)
}
// Check 32-bit deprecation. Exclude watchOS's arm64_32, which is 32-bit but not deprecated.
if targetTriple.arch?.is32Bit == true && compilerOutputType != .swiftModule && targetTriple.arch != .aarch64_32 {
let minVersions: [Triple.OS: (DarwinPlatform, Triple.Version)] = [
.ios: (.iOS(targetTriple._isSimulatorEnvironment ? .simulator : .device), Triple.Version(11, 0, 0)),
.watchos: (.watchOS(targetTriple._isSimulatorEnvironment ? .simulator : .device), targetTriple._isSimulatorEnvironment ? Triple.Version(7, 0, 0) : Triple.Version(9, 0, 0)),
]
if let (platform, minVersion) = minVersions[os], targetTriple.version(for: platform) >= minVersion {
throw ToolchainValidationError.invalidDeploymentTargetForIR(platform: platform, version: minVersion, archName: targetTriple.archName)
}
}
}
func validateLinkObjcRuntimeARCLiteLib(_ parsedOptions: inout ParsedOptions,
targetTriple: Triple,
diagnosticsEngine: DiagnosticsEngine) {
guard parsedOptions.hasFlag(positive: .linkObjcRuntime,
negative: .noLinkObjcRuntime,
default: !targetTriple.supports(.nativeARC))
else {
return
}
guard let _ = try? findARCLiteLibPath() else {
diagnosticsEngine.emit(.warn_arclite_not_found_when_link_objc_runtime)
return
}
}
struct DarwinSDKInfo: Decodable {
private enum CodingKeys: String, CodingKey {
case version = "Version"
case versionMap = "VersionMap"
case canonicalName = "CanonicalName"
}
public enum SDKPlatformKind: String, CaseIterable {
case macosx
case iphoneos
case iphonesimulator
case watchos
case watchsimulator
case appletvos
case appletvsimulator
case visionos = "xros"
case visionsimulator = "xrsimulator"
case unknown
}
struct VersionMap: Decodable {
private enum CodingKeys: String, CodingKey {
case macOSToCatalystMapping = "macOS_iOSMac"
}
var macOSToCatalystMapping: [Version: Version] = [:]
init() {}
init(from decoder: Decoder) throws {
let keyedContainer = try decoder.container(keyedBy: CodingKeys.self)
let mappingDict = try keyedContainer.decode([String: String].self, forKey: .macOSToCatalystMapping)
self.macOSToCatalystMapping = [:]
try mappingDict.forEach { key, value in
guard let newKey = try? Version(string: key, lenient: true) else {
throw DecodingError.dataCorruptedError(forKey: .macOSToCatalystMapping,
in: keyedContainer,
debugDescription: "Malformed version string")
}
guard let newValue = try? Version(string: value, lenient: true) else {
throw DecodingError.dataCorruptedError(forKey: .macOSToCatalystMapping,
in: keyedContainer,
debugDescription: "Malformed version string")
}
self.macOSToCatalystMapping[newKey] = newValue
}
}
}
public let versionString: String
public let platformKind: SDKPlatformKind
private var version: Version
private var versionMap: VersionMap
let canonicalName: String
init(from decoder: Decoder) throws {
let keyedContainer = try decoder.container(keyedBy: CodingKeys.self)
self.versionString = try keyedContainer.decode(String.self, forKey: .version)
let canonicalName = try keyedContainer.decode(String.self, forKey: .canonicalName)
self.platformKind = SDKPlatformKind.allCases.first { canonicalName.hasPrefix($0.rawValue) } ?? SDKPlatformKind.unknown
self.canonicalName = canonicalName
guard let version = try? Version(string: versionString, lenient: true) else {
throw DecodingError.dataCorruptedError(forKey: .version,
in: keyedContainer,
debugDescription: "Malformed version string")
}
self.version = version
if self.canonicalName.hasPrefix("macosx") {
self.versionMap = try keyedContainer.decode(VersionMap.self, forKey: .versionMap)
} else {
self.versionMap = VersionMap()
}
}
func sdkVersion(for triple: Triple) -> Version {
if triple.isMacCatalyst {
// For the Mac Catalyst environment, we have a macOS SDK with a macOS
// SDK version. Map that to the corresponding iOS version number to pass
// down to the linker.
return versionMap.macOSToCatalystMapping[version] ?? Version(0, 0, 0)
}
return version
}
}
// SDK info is computed lazily. This should not generally be accessed directly.
private var _sdkInfo: DarwinSDKInfo? = nil
static func readSDKInfo(_ fileSystem: FileSystem, _ sdkPath: VirtualPath.Handle) -> DarwinSDKInfo? {
let sdkSettingsPath = VirtualPath.lookup(sdkPath).appending(component: "SDKSettings.json")
guard let contents = try? fileSystem.readFileContents(sdkSettingsPath) else { return nil }
guard let sdkInfo = try? JSONDecoder().decode(DarwinSDKInfo.self,
from: Data(contents.contents)) else { return nil }
return sdkInfo
}
func getTargetSDKInfo(sdkPath: VirtualPath.Handle) -> DarwinSDKInfo? {
if let info = _sdkInfo {
return info
} else {
self._sdkInfo = DarwinToolchain.readSDKInfo(fileSystem, sdkPath)
return self._sdkInfo
}
}
public func addPlatformSpecificCommonFrontendOptions(
commandLine: inout [Job.ArgTemplate],
inputs: inout [TypedVirtualPath],
frontendTargetInfo: FrontendTargetInfo,
driver: inout Driver
) throws {
guard let sdkPath = frontendTargetInfo.sdkPath?.path,
let sdkInfo = getTargetSDKInfo(sdkPath: sdkPath) else { return }
commandLine.append(.flag("-target-sdk-version"))
commandLine.append(.flag(sdkInfo.sdkVersion(for: frontendTargetInfo.target.triple).sdkVersionString))
if let targetVariantTriple = frontendTargetInfo.targetVariant?.triple {
commandLine.append(.flag("-target-variant-sdk-version"))
commandLine.append(.flag(sdkInfo.sdkVersion(for: targetVariantTriple).sdkVersionString))
}
if driver.isFrontendArgSupported(.targetSdkName) {
commandLine.append(.flag(Option.targetSdkName.spelling))
commandLine.append(.flag(sdkInfo.canonicalName))
}
// We should be able to pass down prebuilt module dir for all other SDKs.
// For macCatalyst, doing so is specifically necessary because -target-sdk-version
// doesn't always match the macosx sdk version so the compiler may fail to find
// the prebuilt module in the versioned sub-dir.
if frontendTargetInfo.target.triple.isMacCatalyst {
let resourceDirPath = VirtualPath.lookup(frontendTargetInfo.runtimeResourcePath.path)
let basePrebuiltModulesPath = resourceDirPath.appending(components: "macosx", "prebuilt-modules")
// Ensure we pass a path that exists. This matches logic used in the Swift frontend.
let prebuiltModulesPath: VirtualPath = try {
var versionString = sdkInfo.versionString
repeat {
let versionedPrebuiltModulesPath =
basePrebuiltModulesPath.appending(component: versionString)
if try fileSystem.exists(versionedPrebuiltModulesPath) {
return versionedPrebuiltModulesPath
} else if versionString.hasSuffix(".0") {
versionString.removeLast(2)
} else {
return basePrebuiltModulesPath
}
} while true
}()
commandLine.appendFlag(.prebuiltModuleCachePath)
commandLine.appendPath(prebuiltModulesPath)
}
// Pass down -clang-target.
// If not specified otherwise, we should use the same triple as -target
if !driver.parsedOptions.hasArgument(.disableClangTarget) &&
driver.isFrontendArgSupported(.clangTarget) &&
driver.parsedOptions.contains(.driverExplicitModuleBuild) {
// The common target triple for all Clang dependencies of this compilation,
// both direct and transitive is computed as:
// 1. An explicitly-specified `-clang-target` argument to this driver invocation
// 2. (On Darwin) The target triple of the selected SDK
let clangTargetTriple: String
if let explicitClangTripleArg = driver.parsedOptions.getLastArgument(.clangTarget)?.asSingle {
clangTargetTriple = explicitClangTripleArg
} else {
let currentTriple = frontendTargetInfo.target.triple
let sdkVersionedOSString = currentTriple.osNameUnversioned + sdkInfo.sdkVersion(for: currentTriple).sdkVersionString
clangTargetTriple = currentTriple.triple.replacingOccurrences(of: currentTriple.osName, with: sdkVersionedOSString)
}
commandLine.appendFlag(.clangTarget)
commandLine.appendFlag(clangTargetTriple)
}
if driver.isFrontendArgSupported(.externalPluginPath) {
// Determine the platform path. For simulator platforms, look into the
// corresponding device platform instance.
let origPlatformPath = VirtualPath.lookup(sdkPath)
.parentDirectory
.parentDirectory
.parentDirectory
let platformPath: VirtualPath
if let simulatorRange = origPlatformPath.basename.range(of: "Simulator.platform") {
let devicePlatform = origPlatformPath.basename.replacingCharacters(in: simulatorRange, with: "OS.platform")
platformPath = origPlatformPath.parentDirectory.appending(component: devicePlatform)
} else {
platformPath = origPlatformPath
}
// Default paths for compiler plugins within the platform (accessed via that
// platform's plugin server).
let platformPathRoot = platformPath.appending(components: "Developer", "usr")
commandLine.appendFlag(.externalPluginPath)
commandLine.appendFlag("\(platformPathRoot.pluginPath.name)#\(platformPathRoot.pluginServerPath.name)")
commandLine.appendFlag(.externalPluginPath)
commandLine.appendFlag("\(platformPathRoot.localPluginPath.name)#\(platformPathRoot.pluginServerPath.name)")
}
}
}
extension Diagnostic.Message {
static var warn_arclite_not_found_when_link_objc_runtime: Diagnostic.Message {
.warning(
"unable to find Objective-C runtime support library 'arclite'; " +
"pass '-no-link-objc-runtime' to silence this warning"
)
}
}
private extension Version {
var sdkVersionString: String {
if patch == 0 && prerelease.isEmpty && metadata.isEmpty {
return "\(major).\(minor)"
}
return self.description
}
}
extension VirtualPath {
// Given a virtual path pointing into a toolchain/SDK/platform, produce the
// path to `swift-plugin-server`.
fileprivate var pluginServerPath: VirtualPath {
#if os(Windows)
self.appending(components: "bin", "swift-plugin-server.exe")
#else
self.appending(components: "bin", "swift-plugin-server")
#endif
}
// Given a virtual path pointing into a toolchain/SDK/platform, produce the
// path to the plugins.
var pluginPath: VirtualPath {
#if os(Windows)
self.appending(components: "bin")
#else
self.appending(components: "lib", "swift", "host", "plugins")
#endif
}
// Given a virtual path pointing into a toolchain/SDK/platform, produce the
// path to the plugins.
var localPluginPath: VirtualPath {
self.appending(component: "local").pluginPath
}
}
|