virtual-machine 0.0.0-rc1

package/build/index.d.ts

@@ -0,0 +1,127 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Network connection status for the WASM VM.
+ */
+declare enum NetworkStatus {
+  Disconnected = 0,
+  Connecting = 1,
+  Connected = 2,
+  Error = 3,
+}
+/**
+ * WASM-exposed VM wrapper for running RISC-V kernels in the browser.
+ */
+declare class WasmVm {
+  free(): void;
+  [Symbol.dispose](): void;
+  /**
+   * Get a byte from the UART output buffer, if available.
+   */
+  get_output(): number | undefined;
+  /**
+   * Get the current network connection status.
+   */
+  network_status(): NetworkStatus;
+  /**
+   * Connect to a WebSocket relay server for networking.
+   * The URL should be like "ws://localhost:8765".
+   */
+  connect_network(ws_url: string): void;
+  /**
+   * Get current memory usage (DRAM size) in bytes.
+   */
+  get_memory_usage(): bigint;
+  /**
+   * Disconnect from the network.
+   */
+  disconnect_network(): void;
+  /**
+   * Connect to a WebTransport relay server.
+   */
+  connect_webtransport(url: string, cert_hash?: string | null): void;
+  /**
+   * Create a new VM instance and load a kernel (ELF or raw binary).
+   */
+  constructor(kernel: Uint8Array);
+  /**
+   * Execute a single instruction.
+   */
+  step(): void;
+  /**
+   * Push an input byte to the UART.
+   */
+  input(byte: number): void;
+  /**
+   * Load a disk image and attach it as a VirtIO block device.
+   * This should be called before starting execution if the kernel needs a filesystem.
+   */
+  load_disk(disk_image: Uint8Array): void;
+}
+
+type InitInput = RequestInfo | URL | Response | BufferSource | WebAssembly.Module;
+
+interface InitOutput {
+  readonly memory: WebAssembly.Memory;
+  readonly __wbg_wasmvm_free: (a: number, b: number) => void;
+  readonly wasmvm_connect_network: (a: number, b: number, c: number) => [number, number];
+  readonly wasmvm_connect_webtransport: (a: number, b: number, c: number, d: number, e: number) => [number, number];
+  readonly wasmvm_disconnect_network: (a: number) => void;
+  readonly wasmvm_get_memory_usage: (a: number) => bigint;
+  readonly wasmvm_get_output: (a: number) => number;
+  readonly wasmvm_input: (a: number, b: number) => void;
+  readonly wasmvm_load_disk: (a: number, b: number, c: number) => void;
+  readonly wasmvm_network_status: (a: number) => number;
+  readonly wasmvm_new: (a: number, b: number) => [number, number, number];
+  readonly wasmvm_step: (a: number) => void;
+  readonly wasm_bindgen__convert__closures_____invoke__hcf26143a2d2b8df4: (a: number, b: number) => void;
+  readonly wasm_bindgen__closure__destroy__h158587509e69fed9: (a: number, b: number) => void;
+  readonly wasm_bindgen__convert__closures_____invoke__h5116ef40c5ca7cd6: (a: number, b: number, c: any) => void;
+  readonly wasm_bindgen__convert__closures_____invoke__h6fd3101b14d9814b: (a: number, b: number, c: any) => void;
+  readonly wasm_bindgen__closure__destroy__hb2f3fe1158f30bc9: (a: number, b: number) => void;
+  readonly __wbindgen_malloc: (a: number, b: number) => number;
+  readonly __wbindgen_realloc: (a: number, b: number, c: number, d: number) => number;
+  readonly __wbindgen_exn_store: (a: number) => void;
+  readonly __externref_table_alloc: () => number;
+  readonly __wbindgen_externrefs: WebAssembly.Table;
+  readonly __wbindgen_free: (a: number, b: number, c: number) => void;
+  readonly __externref_table_dealloc: (a: number) => void;
+  readonly __wbindgen_start: () => void;
+}
+
+type SyncInitInput = BufferSource | WebAssembly.Module;
+/**
+* Instantiates the given `module`, which can either be bytes or
+* a precompiled `WebAssembly.Module`.
+*
+* @param {{ module: SyncInitInput }} module - Passing `SyncInitInput` directly is deprecated.
+*
+* @returns {InitOutput}
+*/
+declare function initSync(module: { module: SyncInitInput } | SyncInitInput): InitOutput;
+
+/**
+* If `module_or_path` is {RequestInfo} or {URL}, makes a request and
+* for everything else, calls `WebAssembly.instantiate` directly.
+*
+* @param {{ module_or_path: InitInput | Promise<InitInput> }} module_or_path - Passing `InitInput` directly is deprecated.
+*
+* @returns {Promise<InitOutput>}
+*/
+declare function __wbg_init (module_or_path?: { module_or_path: InitInput | Promise<InitInput> } | InitInput | Promise<InitInput>): Promise<InitOutput>;
+
+type __pkg_riscv_vm_InitInput = InitInput;
+type __pkg_riscv_vm_InitOutput = InitOutput;
+type __pkg_riscv_vm_NetworkStatus = NetworkStatus;
+declare const __pkg_riscv_vm_NetworkStatus: typeof NetworkStatus;
+type __pkg_riscv_vm_SyncInitInput = SyncInitInput;
+type __pkg_riscv_vm_WasmVm = WasmVm;
+declare const __pkg_riscv_vm_WasmVm: typeof WasmVm;
+declare const __pkg_riscv_vm_initSync: typeof initSync;
+declare namespace __pkg_riscv_vm {
+  export { type __pkg_riscv_vm_InitInput as InitInput, type __pkg_riscv_vm_InitOutput as InitOutput, __pkg_riscv_vm_NetworkStatus as NetworkStatus, type __pkg_riscv_vm_SyncInitInput as SyncInitInput, __pkg_riscv_vm_WasmVm as WasmVm, __wbg_init as default, __pkg_riscv_vm_initSync as initSync };
+}
+
+declare function WasmInternal(): Promise<typeof __pkg_riscv_vm>;
+
+export { WasmInternal };