VMGen: Overhaul the instruction generation system

Author: kateinoigakukun

Sources/WasmKit/CMakeLists.txt

@@ -18,20 +18,20 @@ add_wasmkit_library(WasmKit
   Execution/Instructions/InstructionSupport.swift
   Execution/Instructions/Numeric.swift
   Execution/Instructions/Variable.swift
-  Execution/Types/Instances.swift
-  Execution/Types/Errors.swift
-  Execution/Types/Value.swift
-  Execution/Types/UntypedValue.swift
-  Execution/Runtime/InstDispatch.swift
-  Execution/Runtime/Runtime.swift
-  Execution/Runtime/RuntimeInterceptor.swift
-  Execution/Runtime/ExecutionState.swift
-  Execution/Runtime/Profiler.swift
-  Execution/Runtime/NameRegistry.swift
-  Execution/Runtime/Store.swift
-  Execution/Runtime/StoreAllocator.swift
-  Execution/Runtime/SignpostTracer.swift
-  Execution/Runtime/Function.swift
+  Execution/DispatchInstruction.swift
+  Execution/Errors.swift
+  Execution/Execution.swift
+  Execution/Function.swift
+  Execution/Instances.swift
+  Execution/NameRegistry.swift
+  Execution/Profiler.swift
+  Execution/Runtime.swift
+  Execution/RuntimeInterceptor.swift
+  Execution/SignpostTracer.swift
+  Execution/Store.swift
+  Execution/StoreAllocator.swift
+  Execution/UntypedValue.swift
+  Execution/Value.swift
 )
 
 target_link_wasmkit_libraries(WasmKit PUBLIC

Sources/WasmKit/Execution/Runtime/InstDispatch.swift renamed to Sources/WasmKit/Execution/DispatchInstruction.swift

@@ -1,5 +1,6 @@
-// This file is generated by Utilities/generate_inst_dispatch.swift
-extension ExecutionState {
+//// Automatically generated by Utilities/Sources/VMGen.swift
+//// DO NOT EDIT DIRECTLY
+extension Execution {
     @inline(__always)
     mutating func doExecute(_ instruction: UInt64, sp: inout Sp, pc: inout Pc, md: inout Md, ms: inout Ms) throws {
         switch instruction {
@@ -409,7 +410,7 @@ extension Instruction {
 }
 
 
-extension ExecutionState {
+extension Execution {
     @inline(__always) mutating func i32Add(sp: Sp, binaryOperand: Instruction.BinaryOperand) {
         sp[i32: binaryOperand.result] = sp[i32: binaryOperand.lhs].add(sp[i32: binaryOperand.rhs])
     }
@@ -890,7 +891,7 @@ extension ExecutionState {
 }
 
 
-extension ExecutionState {
+extension Execution {
     @_silgen_name("wasmkit_execute_copyStack") @inline(__always)
     mutating func execute_copyStack(sp: UnsafeMutablePointer<Sp>, pc: UnsafeMutablePointer<Pc>, md: UnsafeMutablePointer<Md>, ms: UnsafeMutablePointer<Ms>) {
         let copyStackOperand = Instruction.CopyStackOperand.load(from: &pc.pointee)

Sources/WasmKit/Execution/Types/Errors.swift renamed to Sources/WasmKit/Execution/Errors.swift

@@ -2,9 +2,9 @@ import _CWasmKit
 
 /// An execution state of an invocation of exported function.
 ///
-/// Each new invocation through exported function has a separate ``ExecutionState``
+/// Each new invocation through exported function has a separate ``Execution``
 /// even though the invocation happens during another invocation.
-struct ExecutionState {
+struct Execution {
     /// The reference to the ``Runtime`` associated with the execution.
     let runtime: RuntimeRef
     /// The end of the VM stack space.
@@ -17,14 +17,14 @@ struct ExecutionState {
     /// the given ``Runtime`` instance.
     static func with<T>(
         runtime: RuntimeRef,
-        body: (inout ExecutionState, Sp) throws -> T
+        body: (inout Execution, Sp) throws -> T
     ) rethrows -> T {
         let limit = Int(UInt16.max)
         let valueStack = UnsafeMutablePointer<StackSlot>.allocate(capacity: limit)
         defer {
             valueStack.deallocate()
         }
-        var context = ExecutionState(runtime: runtime, stackEnd: valueStack.advanced(by: limit))
+        var context = Execution(runtime: runtime, stackEnd: valueStack.advanced(by: limit))
         return try body(&context, valueStack)
     }
 
@@ -136,7 +136,7 @@ func executeWasm(
 ) throws -> [Value] {
     // NOTE: `runtime` variable must not outlive this function
     let runtime = RuntimeRef(runtime)
-    return try ExecutionState.with(runtime: runtime) { (stack, sp) in
+    return try Execution.with(runtime: runtime) { (stack, sp) in
         // Advance the stack pointer to be able to reference negative indices
         // for saving slots.
         let sp = sp.advanced(by: FrameHeaderLayout.numberOfSavingSlots)
@@ -164,7 +164,7 @@ func executeWasm(
     }
 }
 
-extension ExecutionState {
+extension Execution {
     /// A namespace for the "current memory" (Md and Ms) management.
     enum CurrentMemory {
         /// Assigns the current memory to the given internal memory.
@@ -309,7 +309,7 @@ extension ExecutionState {
                 returnPC: pc,
                 spAddend: callLike.spAddend
             )
-            ExecutionState.CurrentMemory.mayUpdateCurrentInstance(
+            Execution.CurrentMemory.mayUpdateCurrentInstance(
                 instance: function.instance,
                 from: callerInstance, md: &md, ms: &ms
             )

Sources/WasmKit/Execution/Runtime/ExecutionState.swift renamed to Sources/WasmKit/Execution/Execution.swift

@@ -165,7 +165,7 @@ struct WasmFunctionEntity {
         self.index = index
     }
 
-    mutating func ensureCompiled(context: inout ExecutionState) throws -> InstructionSequence {
+    mutating func ensureCompiled(context: inout Execution) throws -> InstructionSequence {
         try ensureCompiled(runtime: context.runtime)
     }
 

Sources/WasmKit/Execution/Runtime/Function.swift renamed to Sources/WasmKit/Execution/Function.swift

@@ -1,6 +1,6 @@
 /// > Note:
 /// <https://webassembly.github.io/spec/core/exec/instructions.html#control-instructions>
-extension ExecutionState {
+extension Execution {
     func unreachable(sp: Sp, pc: Pc) throws -> Pc {
         throw Trap.unreachable
     }

Sources/WasmKit/Execution/Types/Instances.swift renamed to Sources/WasmKit/Execution/Instances.swift

@@ -1,3 +1,5 @@
+//// Automatically generated by Utilities/Sources/VMGen.swift
+//// DO NOT EDIT DIRECTLY
 enum Instruction: Equatable {
     case copyStack(Instruction.CopyStackOperand)
     case globalGet(Instruction.GlobalGetOperand)

Sources/WasmKit/Execution/Instructions/Control.swift

@@ -81,7 +81,6 @@ extension Int32: InstructionImmediate {
 }
 
 extension Instruction {
-    /// size = 6, alignment = 2
     struct BinaryOperand: Equatable, InstructionImmediate {
         let result: LVReg
         let lhs: VReg
@@ -94,7 +93,6 @@ extension Instruction {
         }
     }
 
-    /// size = 4, alignment = 2
     struct UnaryOperand: Equatable, InstructionImmediate {
         let result: LVReg
         let input: LVReg
@@ -125,7 +123,6 @@ extension Instruction {
         }
     }
 
-    /// size = 4, alignment = 8
     struct LoadOperand: Equatable, InstructionImmediate {
         let offset: UInt64
         let pointer: VReg

Sources/WasmKit/Execution/Instructions/Instruction.swift

@@ -1,6 +1,6 @@
 /// > Note:
 /// <https://webassembly.github.io/spec/core/exec/instructions.html#memory-instructions>
-extension ExecutionState {
+extension Execution {
     @inline(never) func throwOutOfBoundsMemoryAccess() throws -> Never {
         throw Trap.outOfBoundsMemoryAccess
     }