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
|
//===--------------- Toolchain.swift - Swift Toolchain Abstraction --------===//
//
// 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 class Foundation.Bundle
import func TSCBasic.getEnvSearchPaths
import func TSCBasic.lookupExecutablePath
import class TSCBasic.DiagnosticsEngine
import protocol TSCBasic.FileSystem
import struct TSCBasic.AbsolutePath
public enum Tool: Hashable {
case swiftCompiler
case staticLinker(LTOKind?)
case dynamicLinker
case clang
case clangxx
case swiftAutolinkExtract
case dsymutil
case lldb
case dwarfdump
case swiftHelp
case swiftAPIDigester
/// Returns a value indicating whether or not the tool supports passing arguments via response
/// files.
public func supportsResponseFiles(in toolchain: Toolchain) -> Bool {
switch self {
case .swiftCompiler, .clang, .clangxx, .swiftAutolinkExtract, .swiftAPIDigester:
return true
case .dsymutil, .lldb, .dwarfdump, .swiftHelp:
// NOTE: Consider *very carefully* whether a tool actually belongs here when adding a new
// entry. Incorrectly marking a tool as not supporting response files when it does may cause
// large builds to fail that would have otherwise succeeded.
return false
case .staticLinker, .dynamicLinker:
// FIXME: newer ld64 supports response files as well, though really,
// Darwin should use clang as the linker driver like the other targets
return !(toolchain is DarwinToolchain)
}
}
}
/// Encapsulates the path to a tool and the knowledge of whether or not it supports taking long
/// command lines as response files.
public struct ResolvedTool {
/// The absolute path to the tool's executable.
public var path: AbsolutePath
/// Indicates whether the tool can accept long command lines in a response file.
public var supportsResponseFiles: Bool
/// Creates a new resolved tool with the given path and response file nature.
///
/// - Note: In most cases, you should **not** call this initializer directly. Instead, use the
/// `Toolchain.resolvedTool(_:pathOverride:)` method, which computes these values based on the
/// requested tool and toolchain.
@_spi(Testing) public init(path: AbsolutePath, supportsResponseFiles: Bool) {
self.path = path
self.supportsResponseFiles = supportsResponseFiles
}
}
/// Describes a toolchain, which includes information about compilers, linkers
/// and other tools required to build Swift code.
public protocol Toolchain {
init(env: [String: String], executor: DriverExecutor, fileSystem: FileSystem, compilerExecutableDir: AbsolutePath?, toolDirectory: AbsolutePath?)
var env: [String: String] { get }
var fileSystem: FileSystem { get }
var searchPaths: [AbsolutePath] { get }
var executor: DriverExecutor { get }
/// Where we should find compiler executables, e.g. XcodeDefault.xctoolchain/usr/bin
var compilerExecutableDir: AbsolutePath? { get }
var toolDirectory: AbsolutePath? { get }
/// Retrieve the absolute path to a particular tool.
func getToolPath(_ tool: Tool) throws -> AbsolutePath
/// Set an absolute path to be used for a particular tool.
func overrideToolPath(_ tool: Tool, path: AbsolutePath)
/// Remove the absolute path used for a particular tool, in case it was overridden or cached.
func clearKnownToolPath(_ tool: Tool)
/// Returns path of the default SDK, if there is one.
func defaultSDKPath(_ target: Triple?) throws -> AbsolutePath?
/// When the compiler invocation should be stored in debug information.
var shouldStoreInvocationInDebugInfo: Bool { get }
/// Specific toolchains should override this to provide additional
/// -debug-prefix-map entries. For example, Darwin has an
/// RC_DEBUG_PREFIX_MAP environment variable that is also understood
/// by Clang.
var globalDebugPathRemapping: String? { get }
/// Constructs a proper output file name for a linker product.
func makeLinkerOutputFilename(moduleName: String, type: LinkOutputType) -> String
/// Perform platform-specific argument validation.
func validateArgs(_ parsedOptions: inout ParsedOptions,
targetTriple: Triple,
targetVariantTriple: Triple?,
compilerOutputType: FileType?,
diagnosticsEngine: DiagnosticsEngine) throws
/// Return the DWARF version to emit, in the absence of arguments to the contrary.
func getDefaultDwarfVersion(targetTriple: Triple) -> UInt8
/// Adds platform-specific linker flags to the provided command line
func addPlatformSpecificLinkerArgs(
to commandLine: inout [Job.ArgTemplate],
parsedOptions: inout ParsedOptions,
linkerOutputType: LinkOutputType,
inputs: [TypedVirtualPath],
outputFile: VirtualPath,
shouldUseInputFileList: Bool,
lto: LTOKind?,
sanitizers: Set<Sanitizer>,
targetInfo: FrontendTargetInfo
) throws -> ResolvedTool
func runtimeLibraryName(
for sanitizer: Sanitizer,
targetTriple: Triple,
isShared: Bool
) throws -> String
func platformSpecificInterpreterEnvironmentVariables(
env: [String: String],
parsedOptions: inout ParsedOptions,
sdkPath: VirtualPath.Handle?,
targetInfo: FrontendTargetInfo) throws -> [String: String]
func addPlatformSpecificCommonFrontendOptions(
commandLine: inout [Job.ArgTemplate],
inputs: inout [TypedVirtualPath],
frontendTargetInfo: FrontendTargetInfo,
driver: inout Driver
) throws
var dummyForTestingObjectFormat: Triple.ObjectFormat {get}
}
extension Toolchain {
public var searchPaths: [AbsolutePath] {
// Conditionalize this on the build time host because cross-compiling from
// a non-Windows host, we would use a Windows toolchain, but would want to
// use the platform variable for the path.
#if os(Windows)
return getEnvSearchPaths(pathString: env["Path"], currentWorkingDirectory: fileSystem.currentWorkingDirectory)
#else
return getEnvSearchPaths(pathString: env["PATH"], currentWorkingDirectory: fileSystem.currentWorkingDirectory)
#endif
}
/// Returns the `executablePath`'s directory.
public var executableDir: AbsolutePath {
get throws {
// If the path is given via the initializer, use that.
if let givenDir = compilerExecutableDir {
return givenDir
}
// If the path isn't given, we are running the driver as an executable,
// so assuming the compiler is adjacent to the driver.
guard let path = Bundle.main.executablePath else {
fatalError("Could not find executable path.")
}
return try AbsolutePath(validating: path).parentDirectory
}
}
/// Looks for `SWIFT_DRIVER_TOOLNAME_EXEC` in the `env` property.
/// - Returns: Environment variable value, if any.
func envVar(forExecutable toolName: String) -> String? {
return env[envVarName(for: toolName)]
}
/// - Returns: String in the form of: `SWIFT_DRIVER_TOOLNAME_EXEC`
private func envVarName(for toolName: String) -> String {
let lookupName = toolName
.replacingOccurrences(of: "-", with: "_")
.replacingOccurrences(of: "+", with: "X")
.uppercased()
return "SWIFT_DRIVER_\(lookupName)_EXEC"
}
/// Use this property only for testing purposes, for example,
/// to enable cross-compiling tests that depends on macOS tooling such as `dsymutil`.
///
/// Returns true if `SWIFT_DRIVER_TESTS_ENABLE_EXEC_PATH_FALLBACK` is set to `1`.
private var fallbackToExecutableDefaultPath: Bool {
env["SWIFT_DRIVER_TESTS_ENABLE_EXEC_PATH_FALLBACK"] == "1"
}
/// Looks for the executable in the `SWIFT_DRIVER_TOOLNAME_EXEC` environment variable, if found nothing,
/// looks in the `executableDir`, `xcrunFind` or in the `searchPaths`.
/// - Parameter executable: executable to look for [i.e. `swift`]. Executable suffix (eg. `.exe`) should be omitted.
func lookup(executable: String) throws -> AbsolutePath {
if let overrideString = envVar(forExecutable: executable),
let path = try? AbsolutePath(validating: overrideString) {
return path
} else if let toolDir = toolDirectory,
let path = lookupExecutablePath(filename: executableName(executable), currentWorkingDirectory: nil, searchPaths: [toolDir]) {
// Looking for tools from the tools directory.
return path
} else if let path = lookupExecutablePath(filename: executableName(executable), currentWorkingDirectory: nil, searchPaths: [try executableDir]) {
return path
} else if let path = try? xcrunFind(executable: executableName(executable)) {
return path
} else if !["swift-frontend", "swift"].contains(executable),
let parentDirectory = try? getToolPath(.swiftCompiler).parentDirectory,
try parentDirectory != executableDir,
let path = lookupExecutablePath(filename: executableName(executable), searchPaths: [parentDirectory]) {
// If the driver library's client and the frontend are in different directories,
// try looking for tools next to the frontend.
return path
} else if let path = lookupExecutablePath(filename: executableName(executable), searchPaths: searchPaths) {
return path
} else if executable == "swift-frontend" {
// Temporary shim: fall back to looking for "swift" before failing.
return try lookup(executable: "swift")
} else if fallbackToExecutableDefaultPath {
if self is WindowsToolchain {
return try getToolPath(.swiftCompiler)
.parentDirectory
.appending(component: executableName(executable))
} else {
return try AbsolutePath(validating: "/usr/bin/" + executable)
}
} else {
throw ToolchainError.unableToFind(tool: executable)
}
}
/// Looks for the executable in the `SWIFT_DRIVER_SWIFTSCAN_LIB` environment variable, if found nothing,
/// looks in the `lib` relative to the compiler executable.
/// TODO: If the driver needs to lookup other shared libraries, this is simple to generalize
@_spi(Testing) public func lookupSwiftScanLib() throws -> AbsolutePath? {
#if os(Windows)
// no matter if we are in a build tree or an installed tree, the layout is
// always: `bin/_InternalSwiftScan.dll`
return try getToolPath(.swiftCompiler).parentDirectory // bin
.appending(component: "_InternalSwiftScan.dll")
#else
let libraryName = sharedLibraryName("lib_InternalSwiftScan")
if let overrideString = env["SWIFT_DRIVER_SWIFTSCAN_LIB"],
let path = try? AbsolutePath(validating: overrideString) {
return path
} else {
let compilerPath = try getToolPath(.swiftCompiler)
let toolchainRootPath = compilerPath.parentDirectory // bin
.parentDirectory // toolchain root
let searchPaths = [toolchainRootPath.appending(component: "lib")
.appending(component: "swift")
.appending(component: compilerHostSupportLibraryOSComponent),
toolchainRootPath.appending(component: "lib")
.appending(component: "swift")
.appending(component: "host"),
// In case we are using a compiler from the build dir, we should also try
// this path.
toolchainRootPath.appending(component: "lib")]
for libraryPath in searchPaths.map({ $0.appending(component: libraryName) }) {
if fileSystem.isFile(libraryPath) {
return libraryPath
}
}
}
return nil
#endif
}
/// Looks for the executable in the `SWIFT_DRIVER_TOOLCHAIN_CASPLUGIN_LIB` environment variable.
@_spi(Testing) public func lookupToolchainCASPluginLib() throws -> AbsolutePath? {
if let overrideString = env["SWIFT_DRIVER_TOOLCHAIN_CASPLUGIN_LIB"],
let path = try? AbsolutePath(validating: overrideString) {
return path
}
return nil
}
private func xcrunFind(executable: String) throws -> AbsolutePath {
let xcrun = "xcrun"
guard lookupExecutablePath(filename: xcrun, searchPaths: searchPaths) != nil else {
throw ToolchainError.unableToFind(tool: xcrun)
}
let path = try executor.checkNonZeroExit(
args: xcrun, "--find", executable,
environment: env
).trimmingCharacters(in: .whitespacesAndNewlines)
return try AbsolutePath(validating: path)
}
public func validateArgs(_ parsedOptions: inout ParsedOptions,
targetTriple: Triple, targetVariantTriple: Triple?,
compilerOutputType: FileType?,
diagnosticsEngine: DiagnosticsEngine) {}
public func getDefaultDwarfVersion(targetTriple: Triple) -> UInt8 { return 4 }
public func addPlatformSpecificCommonFrontendOptions(
commandLine: inout [Job.ArgTemplate],
inputs: inout [TypedVirtualPath],
frontendTargetInfo: FrontendTargetInfo,
driver: inout Driver
) throws {}
/// Resolves the path to the given tool and whether or not it supports response files so that it
/// can be passed to a job.
///
/// - Parameters:
/// - tool: The `Tool` to resolve. Whether or not the invocation supports response files is
/// determined based on how this value responds to the `supportsResponseFiles(in:)` method.
/// - pathOverride: If provided, this path will be used as the path to the tool's executable
/// instead of the default path determined by the toolchain.
/// - Returns: A `ResolvedTool` value that provides the path and response file information about
/// the tool when creating a `Job`.
public func resolvedTool(_ tool: Tool, pathOverride: AbsolutePath? = nil) throws -> ResolvedTool {
return ResolvedTool(
path: try pathOverride ?? getToolPath(tool),
supportsResponseFiles: tool.supportsResponseFiles(in: self)
)
}
/// Maps an optimization level swiftc arg to a corresponding flag for the Clang linker driver invocation
internal func mapOptimizationLevelToClangArg(from parsedOptions: inout ParsedOptions) -> String? {
guard let opt = parsedOptions.getLast(in: .O) else {
return nil
}
let clangArg: String?
switch opt.option {
case .Oplayground:
fallthrough
case .Onone:
clangArg = "-O0"
case .O:
fallthrough
case .Ounchecked:
clangArg = "-O3"
case .Osize:
clangArg = "-Os"
default:
clangArg = nil
assert(false, "Unhandled Optimization Mode: \(opt.description)")
}
return clangArg
}
}
@_spi(Testing) public enum ToolchainError: Swift.Error {
case unableToFind(tool: String)
}
|