File: SwiftHeaderToolTaskAction.swift

package info (click to toggle)
swiftlang 6.2.3-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 2,856,264 kB
  • sloc: cpp: 9,995,718; ansic: 2,234,019; asm: 1,092,167; python: 313,940; objc: 82,726; f90: 80,126; lisp: 38,373; pascal: 25,580; sh: 20,378; ml: 5,058; perl: 4,751; makefile: 4,725; awk: 3,535; javascript: 3,018; xml: 918; fortran: 664; cs: 573; ruby: 396
file content (188 lines) | stat: -rw-r--r-- 7,931 bytes parent folder | download
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
//===----------------------------------------------------------------------===//
//
// This source file is part of the Swift open source project
//
// Copyright (c) 2025 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
//
//===----------------------------------------------------------------------===//

public import SWBUtil
import SWBLibc
public import SWBCore

public final class SwiftHeaderToolTaskAction: TaskAction {
    /// The parsed command line options.
    private struct Options {
        /// Whether the current target only supports a single architecture.
        let single: Bool

        /// The input architectures and file paths.
        let inputs: [String: Path]

        /// The output file path.
        var output: Path

        init(_ task: any ExecutableTask) throws {
            let programName = "builtin-swiftHeaderTool"

            let argsIter = task.commandLineAsStrings.makeIterator()
            precondition(argsIter.next() == programName)

            var single: Bool?
            var inputs = [String: Path]()
            var output: Path?

            while true {
                guard let arg = argsIter.next() else { break }

                func absolutePath(_ path: Path) -> Path {
                    return path.isAbsolute ? path : task.workingDirectory.join(path)
                }

                func argParam() throws -> String {
                    guard let p = argsIter.next() else { throw StubError.error("Failed to parse arguments: \(arg) requires an argument") }
                    return p
                }

                func argParams(count: Int) throws -> [String] {
                    var args = [String]()
                    for _ in 0..<count {
                        guard let p = argsIter.next() else { throw StubError.error("Failed to parse arguments: \(arg) requires \(count) arguments") }
                        args.append(p)
                    }
                    return args
                }

                func setSingleOccurrence<T>(_ result: inout T?, _ getValue : @autoclosure () throws -> T) throws -> T {
                    guard result == nil else { throw StubError.error("Failed to parse arguments: expected a single \(arg) argument") }
                    let newResult = try getValue()
                    result = newResult
                    return newResult
                }

                switch arg {
                case "-single":
                    single = try setSingleOccurrence(&single, true)
                case "-arch":
                    let args = try argParams(count: 2)
                    let arch = args[0]
                    let path = args[1]
                    inputs[arch] = absolutePath(Path(path))
                case "-o":
                    output = try setSingleOccurrence(&output, absolutePath(Path(argParam())))
                default:
                    throw StubError.error("Unrecognized argument: \(arg)")
                }
            }

            guard let out = output, inputs.count > 0 else {
                throw StubError.error("usage: \(programName) [[-arch <arch> <input-file>] ...] -o <output-file>\n")
            }

            self.single = single ?? false
            self.inputs = inputs
            self.output = out
        }
    }

    public override init() {
        super.init()
    }

    override public class var toolIdentifier: String {
        return "swift-header-tool"
    }

    override public func performTaskAction(
        _ task: any ExecutableTask,
        dynamicExecutionDelegate: any DynamicTaskExecutionDelegate,
        executionDelegate: any TaskExecutionDelegate,
        clientDelegate: any TaskExecutionClientDelegate,
        outputDelegate: any TaskOutputDelegate
    ) async -> CommandResult {
        do {
            let options = try Options(task)

            // If there's only a single architecture, don't add ifdefs.
            if options.single {
                if let path = options.inputs.values.only {
                    try executionDelegate.fs.write(options.output, contents: executionDelegate.fs.read(path))
                    return .succeeded
                } else {
                    outputDelegate.emitError("Multiple architectures are not supported on this target.")
                    return .failed
                }
            }

            // List of known archs and C preprocessor macros defined to '1' that indicate said archs.
            // Order is important because some macros may be defined for multiple architectures.
            //
            // The third field describes the "baseline" architecture variant that generally works
            // on a wider variety of processors but is otherwise ABI-compatible with the
            // architecture listed, and can be linked against code built for the architecture
            // listed. For example, code compiled as the baseline (x86_64) can build and link
            // against libraries built for x86_64h.
            let knownArchs = [
                ("arm64_32", "__ARM64_ARCH_8_32__", nil),
                ("arm64e", "__arm64e__", "arm64"),
                ("arm64", "__arm64__", nil),
                ("armv7k", "__ARM_ARCH_7K__", nil),
                ("armv7s", "__ARM_ARCH_7S__", nil),
                ("armv7", "__ARM_ARCH_7A__", nil),
                ("x86_64h", "__x86_64h__", "x86_64"),
                ("x86_64", "__x86_64__", nil),
                ("i386", "__i386__", nil)
            ]

            let unknownArchs = Set(options.inputs.keys).subtracting(knownArchs.map { $0.0 })
            if !unknownArchs.isEmpty {
                throw StubError.error("Unsupported Swift architectures: \(unknownArchs.sorted().joined(separator: ", "))")
            }

            var byteString = ByteString(encodingAsUTF8: "#if 0\n")
            for (arch, archMacro, baselineArchOpt) in knownArchs {
                guard let path = options.inputs[arch] else { continue }

                // When there exists a baseline architecture but there is no
                // input for it, use the macro for the baseline architecture.
                // By convention, it is always defined along with the macro
                // for the more specialized architecture. To continue the
                // x86-64 example above: if there is only x86_64h content but
                // no x86_64 content, use the x86_64 macro (__x86_64__) to
                // catch both cases. Otherwise, use the architecture macro
                // given.
                let macro: String
                if let baseLineArch = baselineArchOpt, options.inputs[baseLineArch] == nil, let baseLineMacro = knownArchs.first(where: { $0.0 == baseLineArch })?.1 {
                    macro = baseLineMacro
                } else {
                    macro = archMacro
                }

                byteString += ByteString(encodingAsUTF8: "#elif defined(\(macro)) && \(macro)\n")
                byteString += try executionDelegate.fs.read(path) + "\n"
            }
            byteString += ByteString(encodingAsUTF8: "#else\n")
            byteString += ByteString(encodingAsUTF8: "#error unsupported Swift architecture\n")
            byteString += ByteString(encodingAsUTF8: "#endif\n")

            try executionDelegate.fs.write(options.output, contents: byteString)

            return .succeeded
        } catch {
            outputDelegate.emitError("\(error)")
            return .failed
        }
    }

    public override func serialize<T: Serializer>(to serializer: T) {
        super.serialize(to: serializer)
    }

    public required init(from deserializer: any Deserializer) throws {
        try super.init(from: deserializer)
    }
}