File: Store.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 (395 lines) | stat: -rw-r--r-- 14,360 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
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
/// > Note:
/// <https://webassembly.github.io/spec/core/exec/runtime.html#addresses>
public typealias FunctionAddress = Int
public typealias TableAddress = Int
public typealias MemoryAddress = Int
public typealias GlobalAddress = Int
public typealias ElementAddress = Int
public typealias DataAddress = Int
public typealias ExternAddress = Int
internal typealias ModuleAddress = Int

/// A collection of globals and functions that are exported from a host module.
public struct HostModule {
    public init(
        globals: [String: GlobalInstance] = [:],
        memories: [String: MemoryAddress] = [:],
        functions: [String: HostFunction] = [:]
    ) {
        self.globals = globals
        self.memories = memories
        self.functions = functions
    }

    /// Names of globals exported by this module mapped to corresponding global instances.
    public let globals: [String: GlobalInstance]

    /// Names of memories exported by this module mapped to corresponding addresses of memory instances.
    public let memories: [String: MemoryAddress]

    /// Names of functions exported by this module mapped to corresponding host functions.
    public let functions: [String: HostFunction]
}

/// A container to manage WebAssembly object space.
/// > Note:
/// <https://webassembly.github.io/spec/core/exec/runtime.html#store>
public final class Store {
    var hostFunctions: [HostFunction] = []
    private var hostGlobals: [GlobalInstance] = []
    var nameRegistry = NameRegistry()

    private var modules: [ModuleInstance] = []
    public internal(set) var namedModuleInstances: [String: ModuleInstance] = [:]

    /// This property is separate from `registeredModuleInstances`, as host exports
    /// won't have a corresponding module instance.
    fileprivate var availableExports: [String: ModuleInstance.Exports] = [:]

    var functions: [FunctionInstance] = []
    var tables: [TableInstance] = []
    var memories: [MemoryInstance] = []
    var globals: [GlobalInstance] = []
    var elements: [ElementInstance] = []
    var datas: [DataInstance] = []

    init(_ hostModules: [String: HostModule]) {
        for (moduleName, hostModule) in hostModules {
            registerUniqueHostModule(hostModule, as: moduleName)
        }
    }

    internal func module(address: ModuleAddress) -> ModuleInstance {
        return self.modules[address]
    }

    internal func withTemporaryModuleInstance<T>(_ body: (ModuleInstance) throws -> T) rethrows -> T {
        let tempAddress = self.modules.count
        let module = ModuleInstance(selfAddress: tempAddress)
        self.modules.append(module)
        let result = try body(module)
        self.modules.removeLast()
        return result
    }
}

/// A caller context passed to host functions
public struct Caller {
    public let runtime: Runtime
    public let instance: ModuleInstance
    public var store: Store {
        runtime.store
    }
}

/// A host-defined function which can be imported by a WebAssembly module instance.
///
/// ## Examples
///
/// This example section shows how to interact with WebAssembly process with ``HostFunction``.
///
/// ### Print Int32 given by WebAssembly process
///
/// ```swift
/// HostFunction(type: FunctionType(parameters: [.i32])) { _, args in
///     print(args[0])
///     return []
/// }
/// ```
///
/// ### Print a UTF-8 string passed by a WebAssembly module instance
///
/// ```swift
/// HostFunction(type: FunctionType(parameters: [.i32, .i32])) { caller, args in
///     let (stringPtr, stringLength) = (Int(args[0].i32), Int(args[1].i32))
///     guard case let .memory(memoryAddr) = caller.instance.exports["memory"] else {
///         fatalError("Missing \"memory\" export")
///     }
///     let bytesRange = stringPtr..<(stringPtr + stringLength)
///     let bytes = caller.store.memory(at: memoryAddr).data[bytesRange]
///     print(String(decoding: bytes, as: UTF8.self))
///     return []
/// }
/// ```
public struct HostFunction {
    public init(type: FunctionType, implementation: @escaping (Caller, [Value]) throws -> [Value]) {
        self.type = type
        self.implementation = implementation
    }

    public let type: FunctionType
    public let implementation: (Caller, [Value]) throws -> [Value]
}

enum StoreFunction {
    case wasm(FunctionInstance, body: InstructionSequence)
    case host(HostFunction)
}

extension Store {
    public func register(_ moduleInstance: ModuleInstance, as name: String) throws {
        guard availableExports[name] == nil else {
            throw ImportError.moduleInstanceAlreadyRegistered(name)
        }

        availableExports[name] = moduleInstance.exports
    }

    /// Register the given host module in this store with the given name.
    ///
    /// - Parameters:
    ///   - hostModule: A host module to register.
    ///   - name: A name to register the given host module.
    public func register(_ hostModule: HostModule, as name: String) throws {
        guard availableExports[name] == nil else {
            throw ImportError.moduleInstanceAlreadyRegistered(name)
        }

        registerUniqueHostModule(hostModule, as: name)
    }

    /// Register the given host module assuming that the given name is not registered yet.
    func registerUniqueHostModule(_ hostModule: HostModule, as name: String) {
        var moduleExports = ModuleInstance.Exports()

        for (globalName, global) in hostModule.globals {
            moduleExports[globalName] = .global(-hostGlobals.count - 1)
            hostGlobals.append(global)
        }

        for (functionName, function) in hostModule.functions {
            moduleExports[functionName] = .function(Function(address: -hostFunctions.count - 1))
            hostFunctions.append(function)
        }

        for (memoryName, memoryAddr) in hostModule.memories {
            moduleExports[memoryName] = .memory(memoryAddr)
        }

        availableExports[name] = moduleExports
    }

    public func memory(at address: MemoryAddress) -> MemoryInstance {
        return self.memories[address]
    }

    public func withMemory<T>(at address: MemoryAddress, _ body: (inout MemoryInstance) throws -> T) rethrows -> T {
        try body(&self.memories[address])
    }

    @_transparent
    func function(at address: FunctionAddress) throws -> StoreFunction {
        if address < 0 {
            return .host(hostFunctions[-address - 1])
        } else {
            let body = try functions[address].code.body
            return .wasm(functions[address], body: body)
        }
    }

    func getExternalValues(_ module: Module) throws -> [ExternalValue] {
        var result = [ExternalValue]()

        for i in module.imports {
            guard let moduleExports = availableExports[i.module], let external = moduleExports[i.name] else {
                throw ImportError.unknownImport(moduleName: i.module, externalName: i.name)
            }

            switch (i.descriptor, external) {
            case let (.function(typeIndex), .function(externalFunc)):
                let type: FunctionType
                switch try function(at: externalFunc.address) {
                case let .host(function):
                    type = function.type

                case let .wasm(function, _):
                    type = function.type
                }

                guard module.types[Int(typeIndex)] == type else {
                    throw ImportError.incompatibleImportType
                }
                result.append(external)

            case let (.table(tableType), .table(tableAddress)):
                if let max = tables[Int(tableAddress)].max, max < tableType.limits.min {
                    throw ImportError.incompatibleImportType
                }
                result.append(external)

            case let (.memory(memoryType), .memory(memoryAddress)):
                if let max = memories[Int(memoryAddress)].limit.max, max < memoryType.min {
                    throw ImportError.incompatibleImportType
                }
                result.append(external)

            case let (.global(globalType), .global(globalAddress))
            where globalType == globals[globalAddress].globalType:
                result.append(external)

            default:
                throw ImportError.incompatibleImportType
            }
        }

        return result
    }

    /// > Note:
    /// <https://webassembly.github.io/spec/core/exec/modules.html#alloc-module>
    func allocate(
        module: Module,
        externalValues: [ExternalValue],
        initialGlobals: [Value]
    ) -> ModuleInstance {
        // Step 1 of module allocation algorithm, according to Wasm 2.0 spec.
        let moduleInstance = ModuleInstance(selfAddress: modules.count)

        moduleInstance.types = module.types

        // External values imported in this module should be included in corresponding index spaces before definitions
        // local to to the module are added.
        for external in externalValues {
            switch external {
            case let .function(address):
                // Step 14.
                moduleInstance.functionAddresses.append(address.address)
            case let .table(address):
                // Step 15.
                moduleInstance.tableAddresses.append(address)
            case let .memory(address):
                // Step 16.
                moduleInstance.memoryAddresses.append(address)
            case let .global(address):
                // Step 17.
                moduleInstance.globalAddresses.append(address)
            }
        }

        // Step 2.
        for function in module.functions {
            let address = allocate(function: function, module: moduleInstance)
            moduleInstance.functionAddresses.append(address)
        }

        // Step 3.
        for table in module.tables {
            let address = allocate(tableType: table.type)
            moduleInstance.tableAddresses.append(address)
        }

        // Step 4.
        for memory in module.memories {
            let address = allocate(memoryType: memory.type)
            moduleInstance.memoryAddresses.append(address)
        }

        // Step 5.
        assert(module.globals.count == initialGlobals.count)
        for (global, initialValue) in zip(module.globals, initialGlobals) {
            let address = allocate(globalType: global.type, initialValue: initialValue)
            moduleInstance.globalAddresses.append(address)
        }

        // Step 6.
        for element in module.elements {
            let references = element.initializer.map { expression -> Reference in
                switch expression[0] {
                case let .refFunc(index):
                    let addr = moduleInstance.functionAddresses[Int(index)]
                    return .function(addr)
                case .refNull(.funcRef):
                    return .function(nil)
                case .refNull(.externRef):
                    return .extern(nil)
                default:
                    fatalError("Unexpected element initializer expression: \(expression)")
                }
            }
            let address = allocate(elementType: element.type, references: references)
            moduleInstance.elementAddresses.append(address)
        }

        // Step 13.
        for datum in module.data {
            let address: DataAddress
            switch datum {
            case let .passive(bytes):
                address = allocate(bytes: bytes)
            case let .active(datum):
                address = allocate(bytes: Array(datum.initializer))
            }
            moduleInstance.dataAddresses.append(address)
        }

        // Step 19.
        for export in module.exports {
            let exportInstance = ExportInstance(export, moduleInstance: moduleInstance)
            moduleInstance.exportInstances.append(exportInstance)
        }

        if let nameSection = module.customSections.first(where: { $0.name == "name" }) {
            // FIXME?: Just ignore parsing error of name section for now.
            // Should emit warning instead of just discarding it?
            try? nameRegistry.register(instance: moduleInstance, nameSection: nameSection)
        }

        self.modules.append(moduleInstance)
        // Steps 20-21.
        return moduleInstance
    }

    /// > Note:
    /// <https://webassembly.github.io/spec/core/exec/modules.html#alloc-func>
    func allocate(function: GuestFunction, module: ModuleInstance) -> FunctionAddress {
        let address = functions.count
        let instance = FunctionInstance(function, module: module)
        functions.append(instance)
        return address
    }

    /// > Note:
    /// <https://webassembly.github.io/spec/core/exec/modules.html#alloc-table>
    func allocate(tableType: TableType) -> TableAddress {
        let address = tables.count
        let instance = TableInstance(tableType)
        tables.append(instance)
        return address
    }

    /// > Note:
    /// <https://webassembly.github.io/spec/core/exec/modules.html#alloc-mem>
    public func allocate(memoryType: MemoryType) -> MemoryAddress {
        let address = memories.count
        let instance = MemoryInstance(memoryType)
        memories.append(instance)
        return address
    }

    /// > Note:
    /// <https://webassembly.github.io/spec/core/exec/modules.html#alloc-global>
    func allocate(globalType: GlobalType, initialValue: Value) -> GlobalAddress {
        let address = globals.count
        let instance = GlobalInstance(globalType: globalType, initialValue: initialValue)
        globals.append(instance)
        return address
    }

    /// > Note:
    /// <https://webassembly.github.io/spec/core/exec/modules.html#element-segments>
    func allocate(elementType: ReferenceType, references: [Reference]) -> ElementAddress {
        let address = elements.count
        let instance = ElementInstance(type: elementType, references: references)
        elements.append(instance)
        return address
    }

    /// > Note:
    /// <https://webassembly.github.io/spec/core/exec/modules.html#data-segments>
    func allocate(bytes: [UInt8]) -> DataAddress {
        let address = datas.count
        let instance = DataInstance(data: bytes)
        datas.append(instance)
        return address
    }
}