@threadedstack/wmd-web 0.1.16 → 0.1.18

package/src/boot.js

@@ -51,9 +51,11 @@ import {
 } from './host/ckpt.js'
 import { captureJit, jitSnapStats, modulesOf, ownersNeedingHub, restoreStore } from './host/jit-snap.js'
 export { CheckpointError, memoryStore, opfsStore } from './host/ckpt.js'
+export { DiskError, deleteDisk, openDisk, sweepDisks } from './host/disk.js'
 export { NetSwitch } from './net/switch.js'
 export { ImageFiles, openImage, parseGroup, parsePasswd, resolveUser } from './image-files.js'
 export { P9_CACHE_DEFAULT, p9InitCmdline, p9MountOptions } from './host/p9mount.js'
+export { loadImageTar } from './registry/load-tar.js'
 
 const PAGE = 65536
 /** A trap with the memory this close to its maximum is reported as out of memory. */
@@ -414,12 +416,30 @@ function toShared(bytes) {
   return sab
 }
 
+/** vm.wasm's arguments for a machine with `disk`: --swap <MiB> and wmd.disk=data appended to --append. */
+export function diskArgs(args, disk) {
+  if (args.includes('--swap')) throw new TypeError('--swap and a disk: give one')
+  const mib = disk.bytes / 2 ** 20
+  if (!Number.isInteger(mib) || mib < 1) throw new TypeError(`disk size ${disk.bytes} is not whole MiB`)
+  const out = [...args, '--swap', String(mib)]
+  const i = out.indexOf('--append')
+  if (i < 0 || i + 1 >= out.length) throw new TypeError('a disk needs --append (the kernel line gets wmd.disk=data)')
+  // the disk holds data: a wmd.disk= of any other value would let the guest init write a swap header over it
+  const given = out[i + 1].match(/(?:^| )wmd\.disk(?:=(\S*))?(?= |$)/g)
+  if (given && given.some(g => g.trim() !== 'wmd.disk=data')) throw new TypeError(`a disk needs wmd.disk=data on the kernel line, not ${given.map(g => g.trim()).join(' ')}`)
+  if (!given) out[i + 1] = `${out[i + 1]} wmd.disk=data`
+  return out
+}
+
 /**
  * @param {object} o
  * @param {string|Uint8Array|ArrayBuffer} o.vmUrl  URL of vm.wasm, or its bytes
  * @param {Record<string,string|Uint8Array>} o.files  preopen contents: path → URL or bytes
  * @param {string[]} o.args                     vm.wasm arguments (after argv[0])
  * @param {string[]} [o.env]                    "K=V" (the runner passes only WMD_*)
+ * @param {object} [o.disk]                     a disk from openDisk (host/disk.js): the guest gets it as virtio-blk
+ *        /dev/vda (vm.wasm's --swap MiB sizes the device) with wmd.disk=data on the kernel line, so guest init leaves
+ *        it alone. A machine with a disk takes no checkpoints: guest memory and the disk would not match
  * @param {boolean} [o.heapReserve]             W21 (default true, false in mobile WebKit: heapReserveDefault, D-516): vm.wasm grows its memory to the maximum
  *        before any thread starts (WMD_HEAP_RESERVE=1), so memory never grows under running
  *        vCPUs. Chromium checks memory.fill/copy against a per-Worker size that lags another
@@ -520,6 +540,10 @@ export async function bootWmd(o) {
     o.onStderr?.(text)
   }
   const preopen = o.preopen || '/g'
+  if (o.disk) {
+    if (o.checkpoint || o.restore || o.restoreLazy) throw new TypeError('a machine with a disk takes no checkpoints')
+    o = { ...o, args: diskArgs(o.args, o.disk) }
+  }
   const argv = ['vm.wasm', ...o.args]
   const env = vmEnv(o.env, o.heapReserve ?? heapReserveDefault())
   // the default Worker is started from a literal new URL(..., import.meta.url) so bundlers (Vite, webpack)
@@ -531,14 +555,12 @@ export async function bootWmd(o) {
   const flatRam = wantsFlatRam(o.args, o)
   if (!flatRam) ramMiB(o.args, o.allowLargeRam) // a bad or too big --ram is a clear error before anything is downloaded
   const maximum = o.maxPages || (flatRam ? flatMaxPages(o.args) : memoryMaxPages(o.args, 1024, o.allowLargeRam))
-  if (flatRam) {
-    if (o.restore || o.restoreLazy) throw new Error(`--ram ${ramMiB(o.args, true)}: a guest with more than ${MAX_BROWSER_RAM_MIB} MiB cannot start from a checkpoint yet`)
-    env.push('WMD_RAM_FLAT=1')
-  }
+  if (flatRam) env.push('WMD_RAM_FLAT=1')
   const ramMem = flatRam ? createRamMemory(ramMiB(o.args, true)) : null
+  /** The RAM memory's pages (0: the RAM is in memory 0). A checkpoint of a flat guest also holds its RAM memory's pages (sections ram-index, ram). */
+  const ramPages = ramMem ? ramMem.buffer.byteLength / CKPT_PAGE : 0
   // P-B9: checkpoints. restoreIn: the checkpoint's parts (parseCheckpoint refuses a malformed one).
-  // A flat guest takes none yet: a checkpoint holds memory 0 only.
-  const ckptOn = !flatRam && (!!o.checkpoint || !!o.restore || !!o.restoreLazy)
+  const ckptOn = !!o.checkpoint || !!o.restore || !!o.restoreLazy
   let restoreIn = o.restore ? parseCheckpoint(o.restore) : null
   // P-B6: a base snapshot that is still downloading ({header: Promise, ckpt: Promise, abort()}, src/base.js openBase()). The
   // boot downloads its own files meanwhile; the snapshot's header is checked against this boot's vm.wasm and boot key as soon
@@ -740,7 +762,7 @@ export async function bootWmd(o) {
           const got = typeof box.take === 'function' ? box.take() : box // a box hands the snapshot over once: the opener keeps no reference to its 0.5 GB
           ckptT.baseWaitMs = absMs() - tw // the time the boot waited for the snapshot after everything else was in
           const parsed = parseCheckpoint(got)
-          checkCheckpointFits(parsed.header, { vmKey, bootKey, bootDesc, maxPages: maximum, hasJit: o.jit !== false, fmaFused: fmaFuses() })
+          checkCheckpointFits(parsed.header, { vmKey, bootKey, bootDesc, maxPages: maximum, ramPages, hasJit: o.jit !== false, fmaFused: fmaFuses() })
           checkPacksFit(parsed.header.packs, packDigests)
           restoreIn = parsed
           lazyIn = null // baseLazy stays: accept() when the restore has succeeded, reject() if it fails
@@ -749,7 +771,7 @@ export async function bootWmd(o) {
           baseRefused(err)
         }
       }
-      if (restoreIn) checkCheckpointFits(restoreIn.header, { vmKey, bootKey, bootDesc, maxPages: maximum, hasJit: o.jit !== false, fmaFused: fmaFuses() })
+      if (restoreIn) checkCheckpointFits(restoreIn.header, { vmKey, bootKey, bootDesc, maxPages: maximum, ramPages, hasJit: o.jit !== false, fmaFused: fmaFuses() })
     }
     if (signal?.aborted) throw abortError()
   } catch (err) {
@@ -812,6 +834,26 @@ export async function bootWmd(o) {
         kept[p] = 1
       }
     }
+    // the flat layout: the guest's RAM, into its own memory (a fresh one: all zero but for these pages)
+    if (restoreIn.ram) {
+      const ram = ramMem.buffer
+      const win = 16384 // pages per view: a RAM memory can be past the length of one typed array view
+      let at = -1
+      let v = null
+      let r = 0
+      for (const c of restoreIn.ram.chunks) {
+        for (let off = 0; off < c.length; off += CKPT_PAGE) {
+          const p = restoreIn.ram.index[r++]
+          const lo = p - (p % win)
+          if (lo !== at) {
+            at = lo
+            v = new Uint8Array(ram, lo * CKPT_PAGE, Math.min(win, ramPages - lo) * CKPT_PAGE)
+          }
+          v.set(c.subarray(off, off + CKPT_PAGE), (p - lo) * CKPT_PAGE)
+        }
+      }
+      ckptT.ramPagesRestored = r
+    }
     // pages the instance's start function wrote that were zero at the checkpoint (the runner's zero_absent): the static region
     let zeroed = 0
     const w = new Int32Array(memory.buffer, 0, Math.min(restoreIn.header.memPages, VM_MIN_PAGES) * (CKPT_PAGE / 4))
@@ -845,6 +887,7 @@ export async function bootWmd(o) {
     be.now('restore', { t: 'boot', stage: 'restore', state: 'done', used: true, bytes: baseBytes, total: baseTotal, source: baseSource, tookMs: Math.round(ckptT.pagesWrittenAt) })
     restoreIn.memChunks = null
     restoreIn.index = null
+    restoreIn.ram = null
     restoreIn.jit = null
     restoreIn.svc = null
     restoreIn.ctl = null
@@ -1531,6 +1574,7 @@ export async function bootWmd(o) {
       tableMin,
       memory,
       ram: ramMem,
+      blk: o.disk?.mailbox || null,
       ctlSab,
       files,
       preopen,
@@ -1854,7 +1898,7 @@ export async function bootWmd(o) {
     try {
       // everything that can fail without harming the running machine comes first: the checkpoint parses and is this boot's
       const parsed = parseCheckpoint(ckpt)
-      checkCheckpointFits(parsed.header, { vmKey, bootKey, bootDesc, maxPages: maximum, hasJit: o.jit !== false, fmaFused: fmaFuses() })
+      checkCheckpointFits(parsed.header, { vmKey, bootKey, bootDesc, maxPages: maximum, ramPages, hasJit: o.jit !== false, fmaFused: fmaFuses() })
       if (!heldAssets) throw new CheckpointError('not-ready', 'this machine was booted without checkpoint support: it has no kept boot files to restore with')
       validateFdTable(parsed.ctl, heldAssets.files.length) // the fd table is checked against this boot's files now, not after the old machine is gone
       // the boot's own bytes (vm.wasm and its compiled Module, the kernel, the packs, the keys) are reused: nothing is