File: Stack.swift

package info (click to toggle)
swiftlang 6.0.3-2
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 2,519,992 kB
  • sloc: cpp: 9,107,863; ansic: 2,040,022; asm: 1,135,751; python: 296,500; objc: 82,456; f90: 60,502; lisp: 34,951; pascal: 19,946; sh: 18,133; perl: 7,482; ml: 4,937; javascript: 4,117; makefile: 3,840; awk: 3,535; xml: 914; fortran: 619; cs: 573; ruby: 573
file content (378 lines) | stat: -rw-r--r-- 11,472 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
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
/// > Note:
/// <https://webassembly.github.io/spec/core/exec/runtime.html#stack>

public struct Stack {
    public enum Element: Equatable {
        case value(Value)
        case label(Label)
        case frame(Frame)
    }

    private var limit: UInt16 { UInt16.max }
    private var valueStack: ValueStack
    private var numberOfValues: Int { valueStack.count }
    private var labels: FixedSizeStack<Label> {
        didSet {
            self.currentLabel = self.labels.peek()
        }
    }
    private var frames: FixedSizeStack<Frame>
    var currentFrame: Frame!
    var currentLabel: Label!

    var isEmpty: Bool {
        self.frames.isEmpty && self.labels.isEmpty && self.numberOfValues == 0
    }

    init() {
        let limit = UInt16.max
        self.valueStack = ValueStack(capacity: Int(limit))
        self.frames = FixedSizeStack(capacity: Int(limit))
        self.labels = FixedSizeStack(capacity: Int(limit))
    }

    @inline(__always)
    mutating func pushLabel(arity: Int, continuation: ProgramCounter, popPushValues: Int = 0) {
        let label = Label(
            arity: arity,
            continuation: continuation,
            baseValueIndex: self.numberOfValues - popPushValues
        )
        labels.push(label)
    }

    mutating func pushFrame(
        iseq: InstructionSequence,
        arity: Int,
        module: ModuleAddress,
        argc: Int,
        defaultLocals: UnsafeBufferPointer<Value>?,
        returnPC: ProgramCounter,
        address: FunctionAddress? = nil
    ) throws {
        // TODO: Stack overflow check can be done at the entry of expression
        guard (frames.count + labels.count + numberOfValues) < limit else {
            throw Trap.callStackExhausted
        }
        let valueFrameIndex = self.numberOfValues - argc
        if let defaultLocals {
            valueStack.push(values: defaultLocals)
        }
        let baseStackAddress = BaseStackAddress(
            valueFrameIndex: valueFrameIndex,
            // Consume argment values from value stack
            valueIndex: self.numberOfValues,
            labelIndex: self.labels.count
        )
        let frame = Frame(arity: arity, module: module, baseStackAddress: baseStackAddress, iseq: iseq, returnPC: returnPC, address: address)
        frames.push(frame)
        self.currentFrame = frame
    }

    func numberOfLabelsInCurrentFrame() -> Int {
        self.labels.count - currentFrame.baseStackAddress.labelIndex
    }

    func numberOfValuesInCurrentLabel() -> Int {
        self.numberOfValues - currentLabel.baseValueIndex
    }

    mutating func exit(label: Label) {
        // labelIndex = 0 means jumping to the current head label
        self.labels.pop()
    }

    mutating func exit(frame: Frame) -> Label? {
        let results = valueStack.popValues(count: frame.arity)
        self.valueStack.truncate(length: frame.baseStackAddress.valueFrameIndex)
        valueStack.push(values: results)
        let labelToRemove = self.labels[frame.baseStackAddress.labelIndex]
        self.labels.pop(self.labels.count - frame.baseStackAddress.labelIndex)
        return labelToRemove
    }

    @discardableResult
    mutating func unwindLabels(upto labelIndex: Int) -> Label? {
        // labelIndex = 0 means jumping to the current head label
        let labelToRemove = self.labels[self.labels.count - labelIndex - 1]
        self.labels.pop(labelIndex + 1)
        if self.numberOfValues > labelToRemove.baseValueIndex {
            self.valueStack.truncate(length: labelToRemove.baseValueIndex)
        }
        return labelToRemove
    }

    mutating func popTopValues() throws -> Array<Value> {
        guard let currentLabel = self.currentLabel else {
            return self.valueStack.popValues(count: self.valueStack.count)
        }
        guard currentLabel.baseValueIndex < self.numberOfValues else {
            return []
        }
        let values = self.valueStack.popValues(count: self.numberOfValues - currentLabel.baseValueIndex)
        return values
    }

    mutating func popFrame() {
        let popped = self.frames.pop()
        self.currentFrame = self.frames.peek()
        self.valueStack.truncate(length: popped.baseStackAddress.valueFrameIndex)
    }

    func getLabel(index: Int) -> Label {
        return self.labels[self.labels.count - index - 1]
    }

    mutating func popValues(count: Int) -> Array<Value> {
        self.valueStack.popValues(count: count)
    }
    mutating func popValue() -> Value {
        self.valueStack.popValue()
    }
    mutating func push(values: [Value]) {
        self.valueStack.push(values: values)
    }
    mutating func push(value: Value) {
        self.valueStack.push(value: value)
    }

    var topValue: Value {
        self.valueStack.topValue
    }

    var currentLocalsPointer: UnsafeMutablePointer<Value> {
        self.valueStack.baseAddress.advanced(by: currentFrame?.baseStackAddress.valueFrameIndex ?? 0)
    }
}

struct ValueStack {
    private let values: UnsafeMutableBufferPointer<Value>
    private var nextPointer: UnsafeMutablePointer<Value>
    private let capacity: Int
    var baseAddress: UnsafeMutablePointer<Value> {
        values.baseAddress!
    }

    init(capacity: Int) {
        self.values = .allocate(capacity: capacity)
        self.nextPointer = self.values.baseAddress!
        self.capacity = capacity
    }

    func deallocate() {
        self.values.deallocate()
    }

    var count: Int { nextPointer - values.baseAddress! }

    var topValue: Value {
        nextPointer.advanced(by: -1).pointee
    }

    subscript(_ index: Int) -> Value {
        get { values[index] }
        set {
            values[index] = newValue
        }
    }

    mutating func push(value: Value) {
        self.nextPointer.pointee = value
        self.nextPointer = self.nextPointer.advanced(by: 1)
    }

    mutating func push(values: [Value]) {
        values.withUnsafeBufferPointer { copyingBuffer in
            self.push(values: copyingBuffer)
        }
    }

    mutating func push(values copyingBuffer: UnsafeBufferPointer<Value>) {
        let rawBuffer = UnsafeMutableRawBufferPointer(
            start: self.nextPointer,
            count: MemoryLayout<Value>.stride * copyingBuffer.count
        )
        rawBuffer.copyMemory(from: UnsafeRawBufferPointer(copyingBuffer))
        self.nextPointer = nextPointer.advanced(by: copyingBuffer.count)
    }

    mutating func popValue() -> Value {
        // TODO: Check too many pop
        self.nextPointer = nextPointer.advanced(by: -1)
        let value = self.nextPointer.pointee
        return value
    }

    mutating func truncate(length: Int) {
        self.nextPointer = self.values.baseAddress!.advanced(by: length)
    }
    mutating func popValues(count: Int) -> Array<Value> {
        guard count > 0 else { return [] }
        var values = [Value]()
        values.reserveCapacity(count)
        for idx in self.count-count..<self.count {
            values.append(self.values[idx])
        }
        self.nextPointer = self.nextPointer.advanced(by: -count)
        return values
    }
}

extension ValueStack: Sequence {
    func makeIterator() -> some IteratorProtocol {
        self.values[..<count].makeIterator()
    }
}

struct FixedSizeStack<Element> {
    private let buffer: UnsafeMutableBufferPointer<Element>
    private var numberOfElements: Int = 0

    var isEmpty: Bool {
        numberOfElements == 0
    }

    var count: Int { numberOfElements }

    init(capacity: Int) {
        self.buffer = .allocate(capacity: capacity)
    }

    mutating func push(_ element: Element) {
        self.buffer[numberOfElements] = element
        self.numberOfElements += 1
    }

    @discardableResult
    mutating func pop() -> Element {
        let element = self.buffer[self.numberOfElements - 1]
        self.numberOfElements -= 1
        return element
    }

    mutating func pop(_ n: Int) {
        self.numberOfElements -= n
    }

    mutating func popAll() {
        self.numberOfElements = 0
    }

    func peek() -> Element! {
        guard self.numberOfElements > 0 else { return nil }
        return self.buffer[self.numberOfElements - 1]
    }

    subscript(_ index: Int) -> Element {
        self.buffer[index]
    }
}

extension FixedSizeStack: Sequence {
    func makeIterator() -> some IteratorProtocol<Element> {
        self.buffer[..<numberOfElements].makeIterator()
    }
}

/// > Note:
/// <https://webassembly.github.io/spec/core/exec/runtime.html#labels>
public struct Label: Equatable {
    let arity: Int

    /// Index of an instruction to jump to when this label is popped off the stack.
    let continuation: ProgramCounter

    let baseValueIndex: Int
}

struct BaseStackAddress {
    /// Locals are placed between `valueFrameIndex..<valueIndex`
    let valueFrameIndex: Int
    /// The base index of Wasm value stack
    let valueIndex: Int
    /// The base index of Wasm label stack
    let labelIndex: Int
}

/// > Note:
/// <https://webassembly.github.io/spec/core/exec/runtime.html#frames>
public struct Frame {
    let arity: Int
    let module: ModuleAddress
    let baseStackAddress: BaseStackAddress
    let iseq: InstructionSequence
    let returnPC: ProgramCounter
    /// An optional function address for debugging/profiling purpose
    let address: FunctionAddress?

    init(
        arity: Int,
        module: ModuleAddress,
        baseStackAddress: BaseStackAddress,
        iseq: InstructionSequence,
        returnPC: ProgramCounter,
        address: FunctionAddress? = nil
    ) {
        self.arity = arity
        self.module = module
        self.baseStackAddress = baseStackAddress
        self.iseq = iseq
        self.returnPC = returnPC
        self.address = address
    }
}

extension Frame: Equatable {
    public static func == (_ lhs: Frame, _ rhs: Frame) -> Bool {
        lhs.module == rhs.module && lhs.arity == rhs.arity
    }
}

extension Stack {
    func localGet(index: UInt32) -> Value {
        let base = currentFrame.baseStackAddress.valueFrameIndex
        return valueStack[base + Int(index)]
    }

    mutating func localSet(index: UInt32, value: Value) {
        let base = currentFrame.baseStackAddress.valueFrameIndex
        valueStack[base + Int(index)] = value
    }
}

extension Frame: CustomDebugStringConvertible {
    public var debugDescription: String {
        "[A=\(arity), BA=\(baseStackAddress), F=\(address?.description ?? "nil")]"
    }
}

extension Label: CustomDebugStringConvertible {
    public var debugDescription: String {
        "[A=\(arity), C=\(continuation), BVI=\(baseValueIndex)]"
    }
}

extension Stack: CustomDebugStringConvertible {
    public var debugDescription: String {
        var result = ""

        result += "==================================================\n"
        for (index, frame) in frames.enumerated() {
            result += "FRAME[\(index)]: \(frame.debugDescription)\n"
        }
        result += "==================================================\n"

        for (index, label) in labels.enumerated() {
            result += "LABEL[\(index)]: \(label.debugDescription)\n"
        }

        result += "==================================================\n"

        for (index, value) in valueStack.enumerated() {
            result += "VALUE[\(index)]: \(value)\n"
        }
        result += "==================================================\n"

        return result
    }
}