@aptre/v86 0.6.0 → 0.6.1

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@aptre/v86",
-    "version": "0.6.0",
+    "version": "0.6.1",
     "license": "BSD-2-Clause",
     "description": "x86 PC emulator and x86-to-wasm JIT, running in the browser",
     "homepage": "https://github.com/aperturerobotics/v86",

package/src/browser/starter.ts

@@ -105,7 +105,23 @@ export class V86 {
 
         let cpu: any
 
-        let wasm_memory: any
+        // Reserve VA upfront so memory.grow() is fast (no realloc+copy).
+        // Without maximum, engines must reallocate on every grow which
+        // is expensive and can OOM for large guest memories.
+        const memory_size = options.memory_size || 64 * 1024 * 1024
+        const vga_memory_size = options.vga_memory_size || 8 * 1024 * 1024
+        const memory_max =
+            options.memory_max || (memory_size + vga_memory_size) * 4
+        const WASM_PAGE_SIZE = 65536
+        const wasm_initial_pages = 256
+        const wasm_max_pages = Math.max(
+            wasm_initial_pages,
+            Math.min(Math.ceil(memory_max / WASM_PAGE_SIZE), 65536),
+        )
+        const wasm_memory = new WebAssembly.Memory({
+            initial: wasm_initial_pages,
+            maximum: wasm_max_pages,
+        })
 
         const wasm_table = new WebAssembly.Table({
             element: 'anyfunc',
@@ -113,6 +129,7 @@ export class V86 {
         })
 
         const wasm_shared_funcs: Record<string, any> = {
+            memory: wasm_memory,
             cpu_exception_hook: (n: number) => this.cpu_exception_hook(n),
 
             run_hardware_timers: function (a: any, t: any) {
@@ -280,7 +297,6 @@ export class V86 {
         }
 
         wasm_fn({ env: wasm_shared_funcs }).then((exports: WasmExports) => {
-            wasm_memory = exports.memory
             exports['rust_init']()
 
             const emulator = (this.v86 = new v86(this.emulator_bus, {
@@ -957,6 +973,30 @@ export class V86 {
         this.v86.run()
     }
 
+    /**
+     * Grow guest memory to the specified size in bytes. Stops the VM,
+     * grows WASM linear memory, updates memory_size, clears the TLB,
+     * and resumes execution.
+     */
+    async growMemory(newSizeBytes: number): Promise<void> {
+        const cpu = this.v86.cpu
+        if (newSizeBytes <= cpu.memory_size[0]) {
+            return
+        }
+
+        const wasRunning = this.cpu_is_running
+        if (wasRunning) {
+            await this.stop()
+        }
+
+        cpu.resize_memory(newSizeBytes)
+        cpu.full_clear_tlb()
+
+        if (wasRunning) {
+            await this.run()
+        }
+    }
+
     /**
      * Stop emulation. Do nothing if emulator is not running. Can be asynchronous.
      */

package/src/cpu.ts

@@ -155,6 +155,7 @@ export class CPU {
     memory_size!: Int32Array
 
     mem8: Uint8Array
+    mem8_offset: number = 0
     mem32s: Int32Array
 
     segment_is_null!: Uint8Array
@@ -347,148 +348,111 @@ export class CPU {
         this.wasm_patch()
         this.create_jit_imports()
 
-        const memory = this.wasm_memory
-
-        this.memory_size = view(Uint32Array, memory, 812, 1)
-
         this.mem8 = new Uint8Array(0)
         this.mem32s = new Int32Array(this.mem8.buffer)
 
+        this.rebuild_wasm_views()
+
+        // @ts-expect-error Devices are populated during init()
+        this.devices = {}
+
+        // managed in io.js
+        this.memory_map_read8 = []
+        this.memory_map_write8 = []
+        this.memory_map_read32 = []
+        this.memory_map_write32 = []
+
+        this.bios = {
+            main: null,
+            vga: null,
+        }
+
+        this.fpu_stack_empty[0] = 0xff
+        this.fpu_stack_ptr[0] = 0
+
+        this.fpu_control_word[0] = 0x37f
+        this.fpu_status_word[0] = 0
+        this.fpu_ip[0] = 0
+        this.fpu_ip_selector[0] = 0
+        this.fpu_opcode[0] = 0
+        this.fpu_dp[0] = 0
+        this.fpu_dp_selector[0] = 0
+
+        this.fw_value = []
+        this.fw_pointer = 0
+        this.option_roms = []
+
+        this.io = undefined!
+
+        this.bus = bus
+
+        this.set_tsc(0, 0)
+
+        if (DEBUG) {
+            this.seen_code = {}
+            this.seen_code_uncompiled = {}
+        }
+    }
+
+    /**
+     * Rebuild all TypedArray views into WASM linear memory.
+     * Must be called after any wasm_memory.grow() since growth
+     * detaches the old ArrayBuffer, invalidating all views.
+     */
+    rebuild_wasm_views(): void {
+        const memory = this.wasm_memory
+        this.memory_size = view(Uint32Array, memory, 812, 1)
         this.segment_is_null = view(Uint8Array, memory, 724, 8)
         this.segment_offsets = view(Int32Array, memory, 736, 8)
         this.segment_limits = view(Uint32Array, memory, 768, 8)
         this.segment_access_bytes = view(Uint8Array, memory, 512, 8)
-
-        // Whether or not in protected mode
         this.protected_mode = view(Int32Array, memory, 800, 1)
-
         this.idtr_size = view(Int32Array, memory, 564, 1)
         this.idtr_offset = view(Int32Array, memory, 568, 1)
-
-        // global descriptor table register
         this.gdtr_size = view(Int32Array, memory, 572, 1)
         this.gdtr_offset = view(Int32Array, memory, 576, 1)
-
         this.tss_size_32 = view(Int32Array, memory, 1128, 1)
-
-        // whether or not a page fault occured
         this.page_fault = view(Uint32Array, memory, 540, 8)
-
         this.cr = view(Int32Array, memory, 580, 8)
-
-        // current privilege level
         this.cpl = view(Uint8Array, memory, 612, 1)
-
-        // current operand/address size
         this.is_32 = view(Int32Array, memory, 804, 1)
-
         this.stack_size_32 = view(Int32Array, memory, 808, 1)
-
-        // Was the last instruction a hlt?
         this.in_hlt = view(Uint8Array, memory, 616, 1)
-
         this.last_virt_eip = view(Int32Array, memory, 620, 1)
         this.eip_phys = view(Int32Array, memory, 624, 1)
-
         this.sysenter_cs = view(Int32Array, memory, 636, 1)
-
         this.sysenter_esp = view(Int32Array, memory, 640, 1)
-
         this.sysenter_eip = view(Int32Array, memory, 644, 1)
-
         this.prefixes = view(Int32Array, memory, 648, 1)
-
         this.flags = view(Int32Array, memory, 120, 1)
-
-        // bitmap of flags which are not updated in the flags variable
-        // changed by arithmetic instructions, so only relevant to arithmetic flags
         this.flags_changed = view(Int32Array, memory, 100, 1)
-
-        // enough infos about the last arithmetic operation to compute eflags
         this.last_op_size = view(Int32Array, memory, 96, 1)
         this.last_op1 = view(Int32Array, memory, 104, 1)
         this.last_result = view(Int32Array, memory, 112, 1)
-
-        this.current_tsc = view(Uint32Array, memory, 960, 2) // 64 bit
-
-        // @ts-expect-error Devices are populated during init()
-        this.devices = {}
-
+        this.current_tsc = view(Uint32Array, memory, 960, 2)
         this.instruction_pointer = view(Int32Array, memory, 556, 1)
         this.previous_ip = view(Int32Array, memory, 560, 1)
-
-        // configured by guest
         this.apic_enabled = view(Uint8Array, memory, 548, 1)
-        // configured when the emulator starts (changes bios initialisation)
         this.acpi_enabled = view(Uint8Array, memory, 552, 1)
-
-        // managed in io.js
-        this.memory_map_read8 = []
-        this.memory_map_write8 = []
-        this.memory_map_read32 = []
-        this.memory_map_write32 = []
-
-        this.bios = {
-            main: null,
-            vga: null,
-        }
-
         this.instruction_counter = view(Uint32Array, memory, 664, 1)
-
-        // registers
         this.reg32 = view(Int32Array, memory, 64, 8)
-
         this.fpu_st = view(Int32Array, memory, 1152, 4 * 8)
-
         this.fpu_stack_empty = view(Uint8Array, memory, 816, 1)
-        this.fpu_stack_empty[0] = 0xff
         this.fpu_stack_ptr = view(Uint8Array, memory, 1032, 1)
-        this.fpu_stack_ptr[0] = 0
-
         this.fpu_control_word = view(Uint16Array, memory, 1036, 1)
-        this.fpu_control_word[0] = 0x37f
         this.fpu_status_word = view(Uint16Array, memory, 1040, 1)
-        this.fpu_status_word[0] = 0
         this.fpu_ip = view(Int32Array, memory, 1048, 1)
-        this.fpu_ip[0] = 0
         this.fpu_ip_selector = view(Int32Array, memory, 1052, 1)
-        this.fpu_ip_selector[0] = 0
         this.fpu_opcode = view(Int32Array, memory, 1044, 1)
-        this.fpu_opcode[0] = 0
         this.fpu_dp = view(Int32Array, memory, 1056, 1)
-        this.fpu_dp[0] = 0
         this.fpu_dp_selector = view(Int32Array, memory, 1060, 1)
-        this.fpu_dp_selector[0] = 0
-
         this.reg_xmm32s = view(Int32Array, memory, 832, 8 * 4)
-
         this.mxcsr = view(Int32Array, memory, 824, 1)
-
-        // segment registers, tr and ldtr
         this.sreg = view(Uint16Array, memory, 668, 8)
-
-        // debug registers
         this.dreg = view(Int32Array, memory, 684, 8)
-
         this.reg_pdpte = view(Int32Array, memory, 968, 8)
-
         this.svga_dirty_bitmap_min_offset = view(Uint32Array, memory, 716, 1)
         this.svga_dirty_bitmap_max_offset = view(Uint32Array, memory, 720, 1)
-
-        this.fw_value = []
-        this.fw_pointer = 0
-        this.option_roms = []
-
-        this.io = undefined!
-
-        this.bus = bus
-
-        this.set_tsc(0, 0)
-
-        if (DEBUG) {
-            this.seen_code = {}
-            this.seen_code_uncompiled = {}
-        }
     }
 
     mmap_read8(addr: number): number {
@@ -887,7 +851,7 @@ export class CPU {
     }
 
     resize_memory(new_size: number): void {
-        const mem8_offset = this.mem8.byteOffset
+        const mem8_offset = this.mem8_offset
         const needed_total = mem8_offset + new_size
         const current_buffer = this.wasm_memory.buffer.byteLength
         if (needed_total > current_buffer) {
@@ -895,6 +859,7 @@ export class CPU {
                 (needed_total - current_buffer) / WASM_PAGE_SIZE,
             )
             this.wasm_memory.grow(grow_pages)
+            this.rebuild_wasm_views()
         }
         this.mem8 = view(Uint8Array, this.wasm_memory, mem8_offset, new_size)
         this.mem32s = view(
@@ -907,7 +872,12 @@ export class CPU {
     }
 
     set_state(state: any[]): void {
-        this.memory_size[0] = state[0]
+        const saved_memory_size = state[0]
+        if (saved_memory_size > this.memory_size[0]) {
+            this.resize_memory(saved_memory_size)
+        } else {
+            this.memory_size[0] = saved_memory_size
+        }
 
         if (this.mem8.length !== this.memory_size[0]) {
             console.warn(
@@ -1275,9 +1245,10 @@ export class CPU {
             'Expected uninitialised memory',
         )
 
-        this.memory_size[0] = size
-
         const memory_offset = this.allocate_memory(size)
+        this.rebuild_wasm_views()
+        this.memory_size[0] = size
+        this.mem8_offset = memory_offset
 
         this.mem8 = view(Uint8Array, this.wasm_memory, memory_offset, size)
         this.mem32s = view(
@@ -1586,6 +1557,25 @@ export class CPU {
         }
 
         this.debug_init()
+
+        // Rebuild all WASM memory views. During init, allocate_memory
+        // and svga_allocate_memory may trigger memory.grow (from Rust),
+        // which detaches the old ArrayBuffer and invalidates all views.
+        this.rebuild_wasm_views()
+        if (this.mem8_offset > 0) {
+            this.mem8 = view(
+                Uint8Array,
+                this.wasm_memory,
+                this.mem8_offset,
+                this.memory_size[0],
+            )
+            this.mem32s = view(
+                Uint32Array,
+                this.wasm_memory,
+                this.mem8_offset,
+                this.memory_size[0] >> 2,
+            )
+        }
     }
 
     load_multiboot(buffer: ArrayBuffer): void {