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
|
//===----------------------------------------------------------------------===//
//
// This source file is part of the Swift open source project
//
// Copyright (c) 2014-2023 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 Basics
import Foundation
import class Basics.AsyncProcess
public protocol AuxiliaryFileType {
static var name: String { get }
static func getFileContents(inputs: [Node]) throws -> String
}
public enum WriteAuxiliary {
public static let fileTypes: [AuxiliaryFileType.Type] = [
EntitlementPlist.self,
LinkFileList.self,
SourcesFileList.self,
SwiftGetVersion.self,
XCTestInfoPlist.self,
EmbeddedResources.self,
]
public struct EntitlementPlist: AuxiliaryFileType {
public static let name = "entitlement-plist"
public static func computeInputs(entitlement: String) -> [Node] {
[.virtual(Self.name), .virtual(entitlement)]
}
public static func getFileContents(inputs: [Node]) throws -> String {
guard let entitlementName = inputs.last?.extractedVirtualNodeName else {
throw Error.undefinedEntitlementName
}
let encoder = PropertyListEncoder()
encoder.outputFormat = .xml
let result = try encoder.encode([entitlementName: true])
let contents = String(decoding: result, as: UTF8.self)
return contents
}
private enum Error: Swift.Error {
case undefinedEntitlementName
}
}
public struct LinkFileList: AuxiliaryFileType {
public static let name = "link-file-list"
// FIXME: We should extend the `InProcessTool` support to allow us to specify these in a typed way, but today we have to flatten all the inputs into a generic `Node` array (rdar://109844243).
public static func computeInputs(objects: [AbsolutePath]) -> [Node] {
return [.virtual(Self.name)] + objects.map { Node.file($0) }
}
public static func getFileContents(inputs: [Node]) throws -> String {
let objects = inputs.compactMap {
if $0.kind == .file {
return $0.name
} else {
return nil
}
}
var content = objects
.map { $0.spm_shellEscaped() }
.joined(separator: "\n")
// not sure this is needed, added here for backward compatibility
if !content.isEmpty {
content.append("\n")
}
return content
}
}
public struct SourcesFileList: AuxiliaryFileType {
public static let name = "sources-file-list"
public static func computeInputs(sources: [AbsolutePath]) -> [Node] {
return [.virtual(Self.name)] + sources.map { Node.file($0) }
}
public static func getFileContents(inputs: [Node]) throws -> String {
let sources = inputs.compactMap {
if $0.kind == .file {
return $0.name
} else {
return nil
}
}
guard sources.count > 0 else { return "" }
var contents = sources
.map { $0.spm_shellEscaped() }
.joined(separator: "\n")
contents.append("\n")
return contents
}
}
public struct SwiftGetVersion: AuxiliaryFileType {
public static let name = "swift-get-version"
public static func computeInputs(swiftCompilerPath: AbsolutePath) -> [Node] {
return [.virtual(Self.name), .file(swiftCompilerPath)]
}
public static func getFileContents(inputs: [Node]) throws -> String {
guard let swiftCompilerPathString = inputs.first(where: { $0.kind == .file })?.name else {
throw Error.unknownSwiftCompilerPath
}
let swiftCompilerPath = try AbsolutePath(validating: swiftCompilerPathString)
return try AsyncProcess.checkNonZeroExit(args: swiftCompilerPath.pathString, "-version")
}
private enum Error: Swift.Error {
case unknownSwiftCompilerPath
}
}
public struct XCTestInfoPlist: AuxiliaryFileType {
public static let name = "xctest-info-plist"
public static func computeInputs(principalClass: String) -> [Node] {
return [.virtual(Self.name), .virtual(principalClass)]
}
public static func getFileContents(inputs: [Node]) throws -> String {
guard let principalClass = inputs.last?.extractedVirtualNodeName else {
throw Error.undefinedPrincipalClass
}
let plist = InfoPlist(NSPrincipalClass: String(principalClass))
let encoder = PropertyListEncoder()
encoder.outputFormat = .xml
let result = try encoder.encode(plist)
let contents = String(decoding: result, as: UTF8.self)
return contents
}
private struct InfoPlist: Codable {
let NSPrincipalClass: String
}
private enum Error: Swift.Error {
case undefinedPrincipalClass
}
}
public struct EmbeddedResources: AuxiliaryFileType {
public static let name = "embedded-resources"
public static func computeInputs(resources: [AbsolutePath]) -> [Node] {
return [.virtual(Self.name)] + resources.map { Node.file($0) }
}
// FIXME: This will not work well for large files, as we will store the entire contents, plus its byte array
// representation in memory.
public static func getFileContents(inputs: [Node]) throws -> String {
var content =
"""
struct PackageResources {
"""
for input in inputs where input.kind == .file {
let resourcePath = try AbsolutePath(validating: input.name)
let variableName = resourcePath.basename.spm_mangledToC99ExtendedIdentifier()
let fileContent = try Data(contentsOf: URL(fileURLWithPath: resourcePath.pathString)).map { String($0) }.joined(separator: ",")
content += "static let \(variableName): [UInt8] = [\(fileContent)]\n"
}
content += "}"
return content
}
}
}
public struct LLBuildManifest {
public typealias TargetName = String
public typealias CmdName = String
/// The targets in the manifest.
public private(set) var targets: [TargetName: Target] = [:]
/// The commands in the manifest.
public private(set) var commands: [CmdName: Command] = [:]
/// The default target to build.
public var defaultTarget: String = ""
public init() {
}
public func getCmdToolMap<T: ToolProtocol>(kind: T.Type) -> [CmdName: T] {
var result = [CmdName: T]()
for (cmdName, cmd) in commands {
if let tool = cmd.tool as? T {
result[cmdName] = tool
}
}
return result
}
public mutating func createTarget(_ name: TargetName) {
guard !targets.keys.contains(name) else { return }
targets[name] = Target(name: name, nodes: [])
}
public mutating func addNode(_ node: Node, toTarget target: TargetName) {
targets[target, default: Target(name: target, nodes: [])].nodes.append(node)
}
public mutating func addPhonyCmd(
name: String,
inputs: [Node],
outputs: [Node]
) {
assert(commands[name] == nil, "already had a command named '\(name)'")
let tool = PhonyTool(inputs: inputs, outputs: outputs)
commands[name] = Command(name: name, tool: tool)
}
public mutating func addTestDiscoveryCmd(
name: String,
inputs: [Node],
outputs: [Node]
) {
assert(commands[name] == nil, "already had a command named '\(name)'")
let tool = TestDiscoveryTool(inputs: inputs, outputs: outputs)
commands[name] = Command(name: name, tool: tool)
}
public mutating func addTestEntryPointCmd(
name: String,
inputs: [Node],
outputs: [Node]
) {
assert(commands[name] == nil, "already had a command named '\(name)'")
let tool = TestEntryPointTool(inputs: inputs, outputs: outputs)
commands[name] = Command(name: name, tool: tool)
}
public mutating func addCopyCmd(
name: String,
inputs: [Node],
outputs: [Node]
) {
assert(commands[name] == nil, "already had a command named '\(name)'")
let tool = CopyTool(inputs: inputs, outputs: outputs)
commands[name] = Command(name: name, tool: tool)
}
public mutating func addEntitlementPlistCommand(entitlement: String, outputPath: AbsolutePath) {
let inputs = WriteAuxiliary.EntitlementPlist.computeInputs(entitlement: entitlement)
let tool = WriteAuxiliaryFile(inputs: inputs, outputFilePath: outputPath)
let name = outputPath.pathString
commands[name] = Command(name: name, tool: tool)
}
public mutating func addWriteLinkFileListCommand(
objects: [AbsolutePath],
linkFileListPath: AbsolutePath
) {
let inputs = WriteAuxiliary.LinkFileList.computeInputs(objects: objects)
let tool = WriteAuxiliaryFile(inputs: inputs, outputFilePath: linkFileListPath)
let name = linkFileListPath.pathString
commands[name] = Command(name: name, tool: tool)
}
public mutating func addWriteSourcesFileListCommand(
sources: [AbsolutePath],
sourcesFileListPath: AbsolutePath
) {
let inputs = WriteAuxiliary.SourcesFileList.computeInputs(sources: sources)
let tool = WriteAuxiliaryFile(inputs: inputs, outputFilePath: sourcesFileListPath)
let name = sourcesFileListPath.pathString
commands[name] = Command(name: name, tool: tool)
}
public mutating func addSwiftGetVersionCommand(
swiftCompilerPath: AbsolutePath,
swiftVersionFilePath: AbsolutePath
) {
let inputs = WriteAuxiliary.SwiftGetVersion.computeInputs(swiftCompilerPath: swiftCompilerPath)
let tool = WriteAuxiliaryFile(inputs: inputs, outputFilePath: swiftVersionFilePath, alwaysOutOfDate: true)
let name = swiftVersionFilePath.pathString
commands[name] = Command(name: name, tool: tool)
}
public mutating func addWriteInfoPlistCommand(principalClass: String, outputPath: AbsolutePath) {
let inputs = WriteAuxiliary.XCTestInfoPlist.computeInputs(principalClass: principalClass)
let tool = WriteAuxiliaryFile(inputs: inputs, outputFilePath: outputPath)
let name = outputPath.pathString
commands[name] = Command(name: name, tool: tool)
}
public mutating func addWriteEmbeddedResourcesCommand(
resources: [AbsolutePath],
outputPath: AbsolutePath
) {
let inputs = WriteAuxiliary.EmbeddedResources.computeInputs(resources: resources)
let tool = WriteAuxiliaryFile(inputs: inputs, outputFilePath: outputPath)
let name = outputPath.pathString
commands[name] = Command(name: name, tool: tool)
}
public mutating func addPkgStructureCmd(
name: String,
inputs: [Node],
outputs: [Node]
) {
assert(commands[name] == nil, "already had a command named '\(name)'")
let tool = PackageStructureTool(inputs: inputs, outputs: outputs)
commands[name] = Command(name: name, tool: tool)
}
public mutating func addShellCmd(
name: String,
description: String,
inputs: [Node],
outputs: [Node],
arguments: [String],
environment: Environment = [:],
workingDirectory: String? = nil,
allowMissingInputs: Bool = false
) {
assert(commands[name] == nil, "already had a command named '\(name)'")
let tool = ShellTool(
description: description,
inputs: inputs,
outputs: outputs,
arguments: arguments,
environment: environment,
workingDirectory: workingDirectory,
allowMissingInputs: allowMissingInputs
)
commands[name] = Command(name: name, tool: tool)
}
public mutating func addSwiftFrontendCmd(
name: String,
moduleName: String,
packageName: String,
description: String,
inputs: [Node],
outputs: [Node],
arguments: [String]
) {
assert(commands[name] == nil, "already had a command named '\(name)'")
let tool = SwiftFrontendTool(
moduleName: moduleName,
description: description,
inputs: inputs,
outputs: outputs,
arguments: arguments
)
commands[name] = Command(name: name, tool: tool)
}
public mutating func addClangCmd(
name: String,
description: String,
inputs: [Node],
outputs: [Node],
arguments: [String],
dependencies: String? = nil
) {
assert(commands[name] == nil, "already had a command named '\(name)'")
let tool = ClangTool(
description: description,
inputs: inputs,
outputs: outputs,
arguments: arguments,
dependencies: dependencies
)
commands[name] = Command(name: name, tool: tool)
}
public mutating func addSwiftCmd(
name: String,
inputs: [Node],
outputs: [Node],
executable: AbsolutePath,
moduleName: String,
moduleAliases: [String: String]?,
moduleOutputPath: AbsolutePath,
importPath: AbsolutePath,
tempsPath: AbsolutePath,
objects: [AbsolutePath],
otherArguments: [String],
sources: [AbsolutePath],
fileList: AbsolutePath,
isLibrary: Bool,
wholeModuleOptimization: Bool,
outputFileMapPath: AbsolutePath,
prepareForIndexing: Bool
) {
assert(commands[name] == nil, "already had a command named '\(name)'")
let tool = SwiftCompilerTool(
inputs: inputs,
outputs: outputs,
executable: executable,
moduleName: moduleName,
moduleAliases: moduleAliases,
moduleOutputPath: moduleOutputPath,
importPath: importPath,
tempsPath: tempsPath,
objects: objects,
otherArguments: otherArguments,
sources: sources,
fileList: fileList,
isLibrary: isLibrary,
wholeModuleOptimization: wholeModuleOptimization,
outputFileMapPath: outputFileMapPath,
prepareForIndexing: prepareForIndexing
)
commands[name] = Command(name: name, tool: tool)
}
}
|