Skip to main content

gasm_host/
host.rs

1//! The gasm ABI v0 host: instantiates a guest and implements the "gasm",
2//! "gasm:gfx", "gasm:net" and "gasm:storage" imports, plus the WASI subset in
3//! [`crate::wasi`].
4
5use std::collections::{HashMap, HashSet};
6use std::future::Future;
7use std::pin::Pin;
8use std::sync::{Arc, OnceLock};
9use std::task::Poll;
10use std::time::{Duration, Instant};
11
12use wasmtime::{Caller, Config, Engine, Instance, Linker, Memory, Module, Store, TypedFunc, bail, format_err};
13
14use crate::assets::Assets;
15use crate::audio::AudioOut;
16use crate::gfx::Gfx;
17use crate::net::Net;
18use crate::present::letterbox;
19use crate::storage::Storage;
20use crate::switching::{self, Cmd, Exchange, Job};
21use crate::wasi::{self, Splitmix};
22
23pub const ABI_VERSION: i32 = 0;
24
25/// FNV-1a 32-bit; mirrored in runners/web/gasm-host.js for cross-runner checks.
26#[derive(Clone, Copy)]
27pub struct Fnv(pub u32);
28
29impl Default for Fnv {
30    fn default() -> Self {
31        Fnv(0x811c_9dc5)
32    }
33}
34
35impl Fnv {
36    pub fn new() -> Self {
37        Self::default()
38    }
39    pub fn update(&mut self, bytes: &[u8]) {
40        let mut h = self.0;
41        for &b in bytes {
42            h ^= b as u32;
43            h = h.wrapping_mul(0x0100_0193);
44        }
45        self.0 = h;
46    }
47}
48
49/// Headless virtual time: derived from the frame number, monotonic when the
50/// guest changes its frame rate. Same arithmetic in gasm-host.js
51/// (`VirtualClock`) and the `gasm::native` stub.
52#[derive(Clone, Copy)]
53pub struct VirtualClock {
54    base_ms: f64,
55    base_frame: u64,
56    rate: f64,
57}
58
59impl Default for VirtualClock {
60    fn default() -> Self {
61        VirtualClock { base_ms: 0.0, base_frame: 0, rate: 60.0 }
62    }
63}
64
65impl VirtualClock {
66    /// Time at the start of `frame` (frames are counted from 0) at frame rate `rate`.
67    pub fn at(&mut self, frame: u64, rate: f64) -> f64 {
68        if rate != self.rate {
69            self.base_ms += (frame - self.base_frame) as f64 * 1000.0 / self.rate;
70            self.base_frame = frame;
71            self.rate = rate;
72        }
73        self.base_ms + (frame - self.base_frame) as f64 * 1000.0 / self.rate
74    }
75}
76
77/// Raw input for one frame, set by the runner before each `gasm_frame`.
78/// `None` fields mean the runner has no such device (the import returns -1).
79#[derive(Default, Clone)]
80pub struct RawInput {
81    /// held keys, bit k%8 of byte k/8 = GASM_KEY code k
82    pub keys: Option<[u8; KEY_STATE_BYTES]>,
83    /// (code, down) since the previous frame, in order
84    pub key_events: Vec<(u16, bool)>,
85    pub pointer: Option<Pointer>,
86    pub gamepads: Option<[Gamepad; 4]>,
87}
88
89pub const KEY_STATE_BYTES: usize = 32;
90pub const POINTER_BYTES: usize = 48;
91pub const GAMEPAD_BYTES: usize = 204;
92pub const GAMEPAD_BUTTONS: usize = 32;
93pub const GAMEPAD_AXES: usize = 16;
94
95#[derive(Default, Clone, Copy)]
96pub struct Pointer {
97    /// position in drawable pixels; the frame position is derived by the host
98    pub x: f32,
99    pub y: f32,
100    pub dx: f32,
101    pub dy: f32,
102    pub wheel_x: f32,
103    pub wheel_y: f32,
104    pub buttons: u32,
105    pub pressed: u32,
106    pub released: u32,
107    /// GASM_POINTER_INSIDE | IS_HIDDEN | IS_LOCKED
108    pub flags: u32,
109    /// drawable size the position refers to
110    pub drawable: (f32, f32),
111    /// the runner shows 2D frames at whole multiples (`--integer-scale`)
112    pub integer_scale: bool,
113}
114
115#[derive(Default, Clone)]
116pub struct Gamepad {
117    pub connected: bool,
118    pub standard: bool,
119    pub buttons: Vec<f32>,
120    pub axes: Vec<f32>,
121    pub name: String,
122}
123
124/// Map a drawable position into the last video_present frame (letterboxed as the
125/// runners display it, `present::letterbox`). Same arithmetic in runners/web/lib/input.js.
126pub fn frame_position(x: f32, y: f32, drawable: (f32, f32), frame: (usize, usize), integer_scale: bool, aspect: Option<(u32, u32)>) -> (f32, f32) {
127    if frame.0 == 0 || frame.1 == 0 || drawable.0 <= 0.0 || drawable.1 <= 0.0 {
128        return (x, y);
129    }
130    let (ox, oy, sx, sy) = letterbox((drawable.0 as f64, drawable.1 as f64), (frame.0 as f64, frame.1 as f64), integer_scale, aspect);
131    (((x as f64 - ox) / sx) as f32, ((y as f64 - oy) / sy) as f32)
132}
133
134/// Longest title `set_title` keeps, in UTF-8 bytes.
135pub const TITLE_MAX_BYTES: usize = 256;
136
137/// The system time zone's offset from UTC now, in minutes east (daylight saving included).
138#[cfg(unix)]
139fn utc_offset_minutes() -> i32 {
140    let now = unsafe { libc::time(std::ptr::null_mut()) };
141    let mut tm: libc::tm = unsafe { std::mem::zeroed() };
142    if unsafe { libc::localtime_r(&now, &mut tm) }.is_null() {
143        return 0;
144    }
145    (tm.tm_gmtoff / 60) as i32
146}
147
148#[cfg(windows)]
149fn utc_offset_minutes() -> i32 {
150    use windows_sys::Win32::System::Time::{GetTimeZoneInformation, TIME_ZONE_INFORMATION};
151    let mut tz: TIME_ZONE_INFORMATION = unsafe { std::mem::zeroed() };
152    // UTC = local + bias: the standard or daylight bias by the current state
153    let bias = match unsafe { GetTimeZoneInformation(&mut tz) } {
154        1 => tz.Bias + tz.StandardBias, // TIME_ZONE_ID_STANDARD
155        2 => tz.Bias + tz.DaylightBias, // TIME_ZONE_ID_DAYLIGHT
156        0 => tz.Bias,                   // TIME_ZONE_ID_UNKNOWN: no daylight saving
157        _ => 0,
158    };
159    -bias
160}
161
162#[cfg(not(any(unix, windows)))]
163fn utc_offset_minutes() -> i32 {
164    0
165}
166
167/// A guest's `set_title` text as runners show it: control characters (Unicode
168/// Cc) and bidi controls (U+202A–U+202E, U+2066–U+2069) removed, then cut to
169/// 256 bytes at a character boundary. None: empty, the runner's default.
170/// Same rules in runners/web/lib/host.js `cleanTitle`.
171pub fn clean_title(text: &str) -> Option<String> {
172    let mut out = String::new();
173    for c in text.chars().filter(|&c| !c.is_control() && !matches!(c, '\u{202a}'..='\u{202e}' | '\u{2066}'..='\u{2069}')) {
174        if out.len() + c.len_utf8() > TITLE_MAX_BYTES {
175            break;
176        }
177        out.push(c);
178    }
179    (!out.is_empty()).then_some(out)
180}
181
182/// The payload of custom section `name` in a wasm binary (None for a .cwasm or
183/// a malformed module: the loader reports those).
184pub fn custom_section<'a>(wasm: &'a [u8], name: &str) -> Option<&'a [u8]> {
185    fn leb(b: &[u8], at: &mut usize) -> Option<usize> {
186        let (mut v, mut shift) = (0usize, 0);
187        loop {
188            let byte = *b.get(*at)?;
189            *at += 1;
190            v |= ((byte & 0x7f) as usize).checked_shl(shift)?;
191            if byte & 0x80 == 0 {
192                return Some(v);
193            }
194            shift += 7;
195            if shift > 28 {
196                return None;
197            }
198        }
199    }
200    if wasm.get(..4)? != b"\0asm" {
201        return None;
202    }
203    let mut at = 8;
204    while at < wasm.len() {
205        let id = wasm[at];
206        at += 1;
207        let size = leb(wasm, &mut at)?;
208        let body = wasm.get(at..at.checked_add(size)?)?;
209        at += size;
210        if id == 0 {
211            let mut p = 0;
212            let n = leb(body, &mut p)?;
213            if body.get(p..p.checked_add(n)?)? == name.as_bytes() {
214                return body.get(p + n..);
215            }
216        }
217    }
218    None
219}
220
221/// The guest's built-in title (custom section `gasm.title`, UTF-8), cleaned like
222/// set_title: the default title before (or without) set_title.
223pub fn static_title(wasm: &[u8]) -> Option<String> {
224    clean_title(std::str::from_utf8(custom_section(wasm, "gasm.title")?).ok()?)
225}
226
227pub struct Host {
228    memory: Option<Memory>,
229    start: Instant,
230    /// Headless runs use frame-derived time so results are reproducible (also
231    /// the WASI clocks).
232    pub virtual_time_ms: Option<f64>,
233    /// Headless runs: a fixed `random_get` sequence; None = OS randomness.
234    pub random: Option<Splitmix>,
235    pub frame_rate: f64,
236    pub pads: [u32; 4],
237    /// UTF-8 typed since the previous frame (set by the runner before each frame);
238    /// None: no keyboard, text_input returns -1
239    pub text: Option<String>,
240    pub input: RawInput,
241    /// GASM_INPUT_* flags requested by the guest (input_mode)
242    pub input_mode: u32,
243    pub assets: Assets,
244    pub params: HashMap<String, String>,
245    pub audio: Option<Box<dyn AudioOut>>,
246    pub gfx: Gfx,
247    /// gasm:gl state (the null GL: natively, gl guests run headless)
248    pub gl: crate::gl::Gl,
249    /// frames run so far (gl queries and syncs are ready from the next frame on)
250    pub frame_index: u64,
251    pub net: Net,
252    /// gasm:fetch (denied until the runner sets a policy: `Fetch::new`)
253    pub fetch: crate::fetch::Fetch,
254    pub storage: Storage,
255    /// false during catch-up frames: gfx begin_frame returns 0
256    pub show_frame: bool,
257    audio_rate: u32,
258    audio_channels: u32,
259    /// imports this runner provides ("module" and "module.function"), for `has`
260    provided: HashSet<String>,
261    /// Last presented frame as RGBA8, tightly packed.
262    pub rgba: Vec<u8>,
263    pub width: usize,
264    pub height: usize,
265    pub frames_presented: u64,
266    /// video_set_aspect (num, den); None: square pixels
267    pub aspect: Option<(u32, u32)>,
268    /// gasm_run guests: what the runner asks of the suspended guest (yield_frame)
269    pub(crate) run: Option<Arc<Exchange>>,
270    /// set_title (cleaned); None: the runner's default
271    pub title: Option<String>,
272    /// set_title changed `title` since the runner last looked (it clears this)
273    pub title_changed: bool,
274    pub hashing: bool,
275    pub video_hash: Fnv,
276    pub audio_hash: Fnv,
277    pub audio_frames: u64,
278}
279
280impl Host {
281    pub fn new(
282        assets: impl Into<Assets>,
283        params: HashMap<String, String>,
284        audio: Option<Box<dyn AudioOut>>,
285        gfx: Gfx,
286        net: Net,
287        storage: Storage,
288    ) -> Self {
289        Host {
290            memory: None,
291            start: Instant::now(),
292            virtual_time_ms: None,
293            random: None,
294            frame_rate: 60.0,
295            pads: [0; 4],
296            text: None,
297            input: RawInput::default(),
298            input_mode: 0,
299            assets: assets.into(),
300            params,
301            audio,
302            gfx,
303            gl: Default::default(),
304            fetch: Default::default(),
305            frame_index: 0,
306            net,
307            storage,
308            show_frame: true,
309            audio_rate: 44100,
310            audio_channels: 2,
311            provided: HashSet::new(),
312            title: None,
313            title_changed: false,
314            aspect: None,
315            run: None,
316            rgba: Vec::new(),
317            width: 0,
318            height: 0,
319            frames_presented: 0,
320            hashing: true,
321            video_hash: Fnv::new(),
322            audio_hash: Fnv::new(),
323            audio_frames: 0,
324        }
325    }
326
327    /// Reproducible mode for headless runs: virtual time (starting at 0) and a
328    /// fixed random sequence.
329    pub fn set_reproducible(&mut self) {
330        self.virtual_time_ms = Some(0.0);
331        self.random = Some(Splitmix(0));
332    }
333
334    pub(crate) fn started(&self) -> Instant {
335        self.start
336    }
337}
338
339/// Whether a module imports anything from `module` (e.g. "gasm:gl"), read before
340/// loading it. A .cwasm is checked only with `allow_precompiled` (it is native code).
341pub fn imports_module(wasm: &[u8], module: &str, allow_precompiled: bool) -> bool {
342    if !wasm.starts_with(b"\0asm") {
343        if !allow_precompiled {
344            return false;
345        }
346        return unsafe { Module::deserialize(engine(), wasm) }.is_ok_and(|m| m.imports().any(|i| i.module() == module));
347    }
348    fn leb(b: &[u8], p: &mut usize) -> Option<u32> {
349        let (mut v, mut shift) = (0u32, 0);
350        loop {
351            let byte = *b.get(*p)?;
352            *p += 1;
353            v |= ((byte & 0x7f) as u32) << shift;
354            if byte & 0x80 == 0 {
355                return Some(v);
356            }
357            shift += 7;
358            if shift > 28 {
359                return None;
360            }
361        }
362    }
363    fn name<'a>(b: &'a [u8], p: &mut usize) -> Option<&'a [u8]> {
364        let n = leb(b, p)? as usize;
365        let s = b.get(*p..*p + n)?;
366        *p += n;
367        Some(s)
368    }
369    let scan = || -> Option<bool> {
370        let mut p = 8;
371        while p < wasm.len() {
372            let id = wasm[p];
373            p += 1;
374            let size = leb(wasm, &mut p)? as usize;
375            let end = p.checked_add(size)?;
376            if id == 2 {
377                let mut q = p;
378                for _ in 0..leb(wasm, &mut q)? {
379                    if name(wasm, &mut q)? == module.as_bytes() {
380                        return Some(true);
381                    }
382                    name(wasm, &mut q)?;
383                    match *wasm.get(q)? {
384                        0 => { q += 1; leb(wasm, &mut q)?; }                       // func: type index
385                        1 => { q += 2; let f = wasm[q - 1]; leb(wasm, &mut q)?; if f & 1 != 0 { leb(wasm, &mut q)?; } } // table
386                        2 => { q += 1; let f = *wasm.get(q)?; q += 1; leb(wasm, &mut q)?; if f & 1 != 0 { leb(wasm, &mut q)?; } } // memory
387                        3 => q += 3,                                                 // global: type, mutability
388                        4 => { q += 2; leb(wasm, &mut q)?; }                         // tag
389                        _ => return None,
390                    }
391                }
392                return Some(false);
393            }
394            p = end;
395        }
396        Some(false)
397    };
398    scan().unwrap_or(false)
399}
400
401/// Borrow `len` bytes at guest offset `ptr`, trapping the guest if out of bounds.
402pub(crate) fn guest_slice(mem: &[u8], ptr: u32, len: u64) -> wasmtime::Result<&[u8]> {
403    let start = ptr as u64;
404    let end = start.checked_add(len).ok_or_else(|| format_err!("guest pointer overflow"))?;
405    if end > mem.len() as u64 {
406        bail!("guest access out of bounds: {start:#x}..{end:#x} (memory is {:#x})", mem.len());
407    }
408    Ok(&mem[start as usize..end as usize])
409}
410
411/// Mutable [`guest_slice`].
412pub(crate) fn guest_slice_mut(mem: &mut [u8], ptr: u32, len: u64) -> wasmtime::Result<&mut [u8]> {
413    let start = ptr as u64;
414    let end = start.checked_add(len).ok_or_else(|| format_err!("guest pointer overflow"))?;
415    if end > mem.len() as u64 {
416        bail!("guest access out of bounds: {start:#x}..{end:#x} (memory is {:#x})", mem.len());
417    }
418    Ok(&mut mem[start as usize..end as usize])
419}
420
421/// The "copied only if it fits" convention: copy `src` to `dst` if `src.len() <= cap`;
422/// returns the full length either way.
423fn copy_if_fits(mem: &mut [u8], dst: u32, cap: u32, src: &[u8]) -> wasmtime::Result<i32> {
424    if src.len() <= cap as usize {
425        guest_slice_mut(mem, dst, src.len() as u64)?.copy_from_slice(src);
426    }
427    Ok(src.len() as i32)
428}
429
430pub(crate) fn memory(caller: &Caller<'_, Host>) -> wasmtime::Result<Memory> {
431    caller.data().memory.ok_or_else(|| format_err!("guest memory not yet available"))
432}
433
434fn guest_str(caller: &Caller<'_, Host>, ptr: u32, len: u32) -> wasmtime::Result<String> {
435    let mem = memory(caller)?;
436    let bytes = guest_slice(mem.data(caller), ptr, len as u64)?;
437    std::str::from_utf8(bytes).map(str::to_owned).map_err(|e| format_err!("string argument is not UTF-8: {e}"))
438}
439
440/// The pointer() record (GASM_POINTER_OFF_* layout).
441fn pointer_bytes(p: &Pointer, frame: (usize, usize), aspect: Option<(u32, u32)>) -> [u8; POINTER_BYTES] {
442    let (fx, fy) = frame_position(p.x, p.y, p.drawable, frame, p.integer_scale, aspect);
443    let mut b = [0u8; POINTER_BYTES];
444    for (i, v) in [p.x, p.y, fx, fy, p.dx, p.dy, p.wheel_x, p.wheel_y].into_iter().enumerate() {
445        b[i * 4..i * 4 + 4].copy_from_slice(&v.to_le_bytes());
446    }
447    for (i, v) in [p.buttons, p.pressed, p.released, p.flags].into_iter().enumerate() {
448        b[32 + i * 4..36 + i * 4].copy_from_slice(&v.to_le_bytes());
449    }
450    b
451}
452
453/// The gamepad() record (GASM_GAMEPAD_OFF_* layout).
454fn gamepad_bytes(g: &Gamepad) -> [u8; GAMEPAD_BYTES] {
455    let mut b = [0u8; GAMEPAD_BYTES];
456    let nb = g.buttons.len().min(GAMEPAD_BUTTONS);
457    let na = g.axes.len().min(GAMEPAD_AXES);
458    let flags = if g.connected { 1 | if g.standard { 2 } else { 0 } } else { 0u32 };
459    for (i, v) in [flags, nb as u32, na as u32].into_iter().enumerate() {
460        b[i * 4..i * 4 + 4].copy_from_slice(&v.to_le_bytes());
461    }
462    for (i, v) in g.buttons.iter().take(nb).enumerate() {
463        b[12 + i * 4..16 + i * 4].copy_from_slice(&v.to_le_bytes());
464    }
465    for (i, v) in g.axes.iter().take(na).enumerate() {
466        b[140 + i * 4..144 + i * 4].copy_from_slice(&v.to_le_bytes());
467    }
468    b
469}
470
471fn add_gasm_imports(linker: &mut Linker<Host>) -> wasmtime::Result<()> {
472    linker.func_wrap("gasm", "log", |caller: Caller<'_, Host>, ptr: u32, len: u32| -> wasmtime::Result<()> {
473        let mem = memory(&caller)?;
474        let msg = guest_slice(mem.data(&caller), ptr, len as u64)?;
475        eprintln!("[guest] {}", String::from_utf8_lossy(msg));
476        Ok(())
477    })?;
478
479    linker.func_wrap("gasm", "has", |caller: Caller<'_, Host>, ptr: u32, len: u32| -> wasmtime::Result<i32> {
480        let name = guest_str(&caller, ptr, len)?;
481        Ok(caller.data().provided.contains(&name) as i32)
482    })?;
483
484    linker.func_wrap("gasm", "video_set_aspect", |mut caller: Caller<'_, Host>, num: u32, den: u32| -> wasmtime::Result<()> {
485        let aspect = match (num, den) {
486            (0, 0) => None,
487            (1..=65535, 1..=65535) if num as u64 * 8 >= den as u64 && den as u64 * 8 >= num as u64 => Some((num, den)),
488            _ => bail!("video_set_aspect: invalid ratio {num}:{den}"),
489        };
490        caller.data_mut().aspect = aspect;
491        Ok(())
492    })?;
493
494    linker.func_wrap("gasm", "set_title", |mut caller: Caller<'_, Host>, ptr: u32, len: u32| -> wasmtime::Result<()> {
495        let title = clean_title(&guest_str(&caller, ptr, len)?);
496        let h = caller.data_mut();
497        if h.title != title {
498            h.title = title;
499            h.title_changed = true;
500        }
501        Ok(())
502    })?;
503
504    linker.func_wrap("gasm", "time_ms", |caller: Caller<'_, Host>| -> f64 {
505        let h = caller.data();
506        h.virtual_time_ms.unwrap_or_else(|| h.start.elapsed().as_secs_f64() * 1000.0)
507    })?;
508
509    linker.func_wrap("gasm", "utc_offset_minutes", |caller: Caller<'_, Host>| -> i32 {
510        // headless runs are reproducible: UTC, like their clocks
511        if caller.data().virtual_time_ms.is_some() { 0 } else { utc_offset_minutes() }
512    })?;
513
514    linker.func_wrap("gasm", "set_frame_rate", |mut caller: Caller<'_, Host>, hz: f64| {
515        if hz.is_finite() && (1.0..=1000.0).contains(&hz) {
516            caller.data_mut().frame_rate = hz;
517        }
518    })?;
519
520    linker.func_wrap(
521        "gasm",
522        "video_present",
523        |mut caller: Caller<'_, Host>, ptr: u32, w: u32, h: u32, stride: u32| -> wasmtime::Result<()> {
524            let (w, h, stride) = (w as usize, h as usize, stride as usize);
525            if w == 0 || h == 0 || w > 4096 || h > 4096 || stride < w * 4 {
526                bail!("video_present: bad geometry {w}x{h} stride {stride}");
527            }
528            let mem = memory(&caller)?;
529            let (data, host) = mem.data_and_store_mut(&mut caller);
530            let src = guest_slice(data, ptr, (stride * (h - 1) + w * 4) as u64)?;
531            let row = w * 4;
532            host.rgba.resize(row * h, 0);
533            if stride == row {
534                host.rgba.copy_from_slice(src);
535            } else {
536                for (y, dst) in host.rgba.chunks_exact_mut(row).enumerate() {
537                    dst.copy_from_slice(&src[y * stride..y * stride + row]);
538                }
539            }
540            if host.hashing {
541                host.video_hash.update(&host.rgba);
542            }
543            host.width = w;
544            host.height = h;
545            host.frames_presented += 1;
546            Ok(())
547        },
548    )?;
549
550    linker.func_wrap("gasm", "audio_config", |mut caller: Caller<'_, Host>, rate: u32, channels: u32| {
551        let h = caller.data_mut();
552        if (8000..=192_000).contains(&rate) && (channels == 1 || channels == 2) {
553            h.audio_rate = rate;
554            h.audio_channels = channels;
555            if let Some(a) = &mut h.audio {
556                a.configure(rate, channels);
557            }
558        }
559    })?;
560
561    linker.func_wrap(
562        "gasm",
563        "audio_push",
564        |mut caller: Caller<'_, Host>, ptr: u32, frames: u32| -> wasmtime::Result<()> {
565            let mem = memory(&caller)?;
566            let (data, host) = mem.data_and_store_mut(&mut caller);
567            let len = frames as u64 * host.audio_channels as u64 * 4;
568            let bytes = guest_slice(data, ptr, len)?;
569            if host.hashing {
570                host.audio_hash.update(bytes);
571            }
572            host.audio_frames += frames as u64;
573            if let Some(a) = &mut host.audio {
574                a.push_le_f32(bytes);
575            }
576            Ok(())
577        },
578    )?;
579
580    linker.func_wrap("gasm", "input_pad", |caller: Caller<'_, Host>, player: u32| -> u32 {
581        caller.data().pads.get(player as usize).copied().unwrap_or(0)
582    })?;
583
584    linker.func_wrap(
585        "gasm",
586        "text_input",
587        |mut caller: Caller<'_, Host>, dst: u32, cap: u32| -> wasmtime::Result<i32> {
588            let mem = memory(&caller)?;
589            let (data, host) = mem.data_and_store_mut(&mut caller);
590            let Some(t) = &host.text else { return Ok(-1) };
591            copy_if_fits(data, dst, cap, t.as_bytes())
592        },
593    )?;
594
595    linker.func_wrap("gasm", "input_mode", |mut caller: Caller<'_, Host>, flags: u32| {
596        caller.data_mut().input_mode = flags & 7;
597    })?;
598
599    linker.func_wrap(
600        "gasm",
601        "key_state",
602        |mut caller: Caller<'_, Host>, dst: u32, len: u32| -> wasmtime::Result<i32> {
603            let mem = memory(&caller)?;
604            let (data, host) = mem.data_and_store_mut(&mut caller);
605            let Some(keys) = host.input.keys else { return Ok(-1) };
606            let n = (len as usize).min(KEY_STATE_BYTES);
607            guest_slice_mut(data, dst, n as u64)?.copy_from_slice(&keys[..n]);
608            Ok(KEY_STATE_BYTES as i32)
609        },
610    )?;
611
612    linker.func_wrap(
613        "gasm",
614        "key_events",
615        |mut caller: Caller<'_, Host>, dst: u32, cap: u32| -> wasmtime::Result<i32> {
616            let mem = memory(&caller)?;
617            let (data, host) = mem.data_and_store_mut(&mut caller);
618            if host.input.keys.is_none() {
619                return Ok(-1);
620            }
621            let events = &host.input.key_events;
622            let len = events.len() * 4;
623            if len <= cap as usize {
624                let out = guest_slice_mut(data, dst, len as u64)?;
625                for (b, &(c, d)) in out.chunks_exact_mut(4).zip(events) {
626                    let c = c.to_le_bytes();
627                    b.copy_from_slice(&[c[0], c[1], d as u8, 0]);
628                }
629            }
630            Ok(len as i32)
631        },
632    )?;
633
634    linker.func_wrap(
635        "gasm",
636        "pointer",
637        |mut caller: Caller<'_, Host>, dst: u32, cap: u32| -> wasmtime::Result<i32> {
638            let mem = memory(&caller)?;
639            let (data, host) = mem.data_and_store_mut(&mut caller);
640            let Some(p) = &host.input.pointer else { return Ok(-1) };
641            if cap as usize >= POINTER_BYTES {
642                let b = pointer_bytes(p, (host.width, host.height), host.aspect);
643                guest_slice_mut(data, dst, POINTER_BYTES as u64)?.copy_from_slice(&b);
644            }
645            Ok(POINTER_BYTES as i32)
646        },
647    )?;
648
649    linker.func_wrap(
650        "gasm",
651        "gamepad",
652        |mut caller: Caller<'_, Host>, slot: u32, dst: u32, cap: u32| -> wasmtime::Result<i32> {
653            let mem = memory(&caller)?;
654            let (data, host) = mem.data_and_store_mut(&mut caller);
655            let (Some(pads), true) = (&host.input.gamepads, slot < 4) else { return Ok(-1) };
656            if cap as usize >= GAMEPAD_BYTES {
657                let b = gamepad_bytes(&pads[slot as usize]);
658                guest_slice_mut(data, dst, GAMEPAD_BYTES as u64)?.copy_from_slice(&b);
659            }
660            Ok(GAMEPAD_BYTES as i32)
661        },
662    )?;
663
664    linker.func_wrap(
665        "gasm",
666        "gamepad_name",
667        |mut caller: Caller<'_, Host>, slot: u32, dst: u32, cap: u32| -> wasmtime::Result<i32> {
668            let mem = memory(&caller)?;
669            let (data, host) = mem.data_and_store_mut(&mut caller);
670            let Some(g) = host.input.gamepads.as_ref().and_then(|p| p.get(slot as usize)).filter(|g| g.connected) else { return Ok(-1) };
671            copy_if_fits(data, dst, cap, g.name.as_bytes())
672        },
673    )?;
674
675    linker.func_wrap(
676        "gasm",
677        "param",
678        |mut caller: Caller<'_, Host>, ptr: u32, len: u32, dst: u32, cap: u32| -> wasmtime::Result<i32> {
679            let name = guest_str(&caller, ptr, len)?;
680            let mem = memory(&caller)?;
681            let (data, host) = mem.data_and_store_mut(&mut caller);
682            let Some(v) = host.params.get(&name) else { return Ok(-1) };
683            copy_if_fits(data, dst, cap, v.as_bytes())
684        },
685    )?;
686
687    // Assets: n = bytes available from offset (clamped to the request) is bounds-checked
688    // against guest memory before anything is read.
689    fn read_asset(caller: &mut Caller<'_, Host>, ptr: u32, len: u32, offset: u64, dst: u32, cap: u32) -> wasmtime::Result<i32> {
690        let name = guest_str(caller, ptr, len)?;
691        let mem = memory(caller)?;
692        let (data, host) = mem.data_and_store_mut(caller);
693        let Some(asset) = host.assets.get(&name) else { return Ok(-1) };
694        let n = asset.size().saturating_sub(offset).min(cap as u64);
695        let out = guest_slice_mut(data, dst, n)?;
696        Ok(asset.read_at(offset, out) as i32)
697    }
698
699    linker.func_wrap(
700        "gasm",
701        "asset_read_at",
702        |mut caller: Caller<'_, Host>, ptr: u32, len: u32, offset: u32, dst: u32, cap: u32| -> wasmtime::Result<i32> {
703            read_asset(&mut caller, ptr, len, offset as u64, dst, cap)
704        },
705    )?;
706
707    linker.func_wrap(
708        "gasm",
709        "asset_read_at64",
710        |mut caller: Caller<'_, Host>, ptr: u32, len: u32, offset: u64, dst: u32, cap: u32| -> wasmtime::Result<i32> {
711            read_asset(&mut caller, ptr, len, offset, dst, cap)
712        },
713    )?;
714
715    linker.func_wrap(
716        "gasm",
717        "asset_read",
718        |mut caller: Caller<'_, Host>, ptr: u32, len: u32, dst: u32, cap: u32| -> wasmtime::Result<i32> {
719            read_asset(&mut caller, ptr, len, 0, dst, cap)
720        },
721    )?;
722
723    linker.func_wrap("gasm", "asset_count", |caller: Caller<'_, Host>| -> u32 { caller.data().assets.names().len() as u32 })?;
724
725    linker.func_wrap(
726        "gasm",
727        "asset_name",
728        |mut caller: Caller<'_, Host>, index: u32, dst: u32, cap: u32| -> wasmtime::Result<i32> {
729            let mem = memory(&caller)?;
730            let (data, host) = mem.data_and_store_mut(&mut caller);
731            let Some(n) = host.assets.names().get(index as usize) else { return Ok(-1) };
732            copy_if_fits(data, dst, cap, n.as_bytes())
733        },
734    )?;
735
736    linker.func_wrap(
737        "gasm",
738        "asset_size",
739        |caller: Caller<'_, Host>, ptr: u32, len: u32| -> wasmtime::Result<i32> {
740            let name = guest_str(&caller, ptr, len)?;
741            Ok(match caller.data().assets.size(&name) {
742                None => -1,
743                Some(n) if n > i32::MAX as u64 => -2,
744                Some(n) => n as i32,
745            })
746        },
747    )?;
748
749    linker.func_wrap(
750        "gasm",
751        "asset_size64",
752        |caller: Caller<'_, Host>, ptr: u32, len: u32| -> wasmtime::Result<i64> {
753            let name = guest_str(&caller, ptr, len)?;
754            Ok(caller.data().assets.size(&name).map_or(-1, |n| n as i64))
755        },
756    )?;
757
758    linker.func_wrap(
759        "gasm",
760        "asset_version",
761        |caller: Caller<'_, Host>, ptr: u32, len: u32| -> wasmtime::Result<i32> {
762            let name = guest_str(&caller, ptr, len)?;
763            Ok(caller.data().assets.version(&name).map_or(-1, |v| v.min(i32::MAX as u32) as i32))
764        },
765    )?;
766    Ok(())
767}
768
769fn trap(e: String) -> wasmtime::Error {
770    format_err!("{e}")
771}
772
773fn add_gfx_imports(linker: &mut Linker<Host>) -> wasmtime::Result<()> {
774    const M: &str = "gasm:gfx";
775    linker.func_wrap(M, "width", |c: Caller<'_, Host>| -> u32 { c.data().gfx.size().0 })?;
776    linker.func_wrap(M, "height", |c: Caller<'_, Host>| -> u32 { c.data().gfx.size().1 })?;
777    linker.func_wrap(M, "create_shader", |mut c: Caller<'_, Host>, ptr: u32, len: u32| -> wasmtime::Result<u32> {
778        let src = guest_str(&c, ptr, len)?;
779        c.data_mut().gfx.create_shader(&src).map_err(trap)
780    })?;
781    linker.func_wrap(M, "create_buffer", |mut c: Caller<'_, Host>, size: u32, usage: u32| -> wasmtime::Result<u32> {
782        c.data_mut().gfx.create_buffer(size, usage).map_err(trap)
783    })?;
784    linker.func_wrap(M, "create_pipeline", |mut c: Caller<'_, Host>, ptr: u32, len: u32| -> wasmtime::Result<u32> {
785        let json = guest_str(&c, ptr, len)?;
786        c.data_mut().gfx.create_pipeline(&json).map_err(trap)
787    })?;
788    linker.func_wrap(M, "create_bind_group", |mut c: Caller<'_, Host>, ptr: u32, len: u32| -> wasmtime::Result<u32> {
789        let json = guest_str(&c, ptr, len)?;
790        c.data_mut().gfx.create_bind_group(&json).map_err(trap)
791    })?;
792    linker.func_wrap(
793        M,
794        "write_buffer",
795        |mut c: Caller<'_, Host>, buf: u32, offset: u32, ptr: u32, len: u32| -> wasmtime::Result<()> {
796            let mem = memory(&c)?;
797            let (data, host) = mem.data_and_store_mut(&mut c);
798            let bytes = guest_slice(data, ptr, len as u64)?;
799            host.gfx.write_buffer(buf, offset, bytes).map_err(trap)?;
800            if host.hashing {
801                host.video_hash.update(bytes);
802            }
803            Ok(())
804        },
805    )?;
806    linker.func_wrap(M, "create_bind_group_layout", |mut c: Caller<'_, Host>, ptr: u32, len: u32| -> wasmtime::Result<u32> {
807        let json = guest_str(&c, ptr, len)?;
808        c.data_mut().gfx.create_bind_group_layout(&json).map_err(trap)
809    })?;
810    linker.func_wrap(M, "create_texture", |mut c: Caller<'_, Host>, ptr: u32, len: u32| -> wasmtime::Result<u32> {
811        let json = guest_str(&c, ptr, len)?;
812        c.data_mut().gfx.create_texture(&json).map_err(trap)
813    })?;
814    linker.func_wrap(M, "create_sampler", |mut c: Caller<'_, Host>, ptr: u32, len: u32| -> wasmtime::Result<u32> {
815        let json = guest_str(&c, ptr, len)?;
816        c.data_mut().gfx.create_sampler(&json).map_err(trap)
817    })?;
818    linker.func_wrap(
819        M,
820        "write_texture",
821        |mut c: Caller<'_, Host>, tex: u32, mip: u32, x: u32, y: u32, w: u32, h: u32, ptr: u32, len: u32| -> wasmtime::Result<()> {
822            let mem = memory(&c)?;
823            let (data, host) = mem.data_and_store_mut(&mut c);
824            let bytes = guest_slice(data, ptr, len as u64)?;
825            host.gfx.write_texture(tex, mip, x, y, w, h, bytes).map_err(trap)?;
826            if host.hashing {
827                // header (little-endian u32s) + payload, so the target region counts too
828                for v in [tex, mip, x, y, w, h] {
829                    host.video_hash.update(&v.to_le_bytes());
830                }
831                host.video_hash.update(bytes);
832            }
833            Ok(())
834        },
835    )?;
836    linker.func_wrap(M, "begin_frame", |mut c: Caller<'_, Host>, r: f32, g: f32, b: f32, a: f32| -> wasmtime::Result<u32> {
837        let h = c.data_mut();
838        let show = h.show_frame;
839        h.gfx.begin_frame([r, g, b, a], show).map(u32::from).map_err(trap)
840    })?;
841    linker.func_wrap(M, "set_pipeline", |mut c: Caller<'_, Host>, p: u32| -> wasmtime::Result<()> {
842        c.data_mut().gfx.set_pipeline(p).map_err(trap)
843    })?;
844    linker.func_wrap(M, "set_bind_group", |mut c: Caller<'_, Host>, i: u32, bg: u32| -> wasmtime::Result<()> {
845        c.data_mut().gfx.set_bind_group(i, bg).map_err(trap)
846    })?;
847    linker.func_wrap(
848        M,
849        "set_bind_group_offsets",
850        |mut c: Caller<'_, Host>, i: u32, bg: u32, ptr: u32, count: u32| -> wasmtime::Result<()> {
851            let mem = memory(&c)?;
852            let (data, host) = mem.data_and_store_mut(&mut c);
853            let bytes = guest_slice(data, ptr, count as u64 * 4)?;
854            let mut offsets = [0u32; 32];
855            if count as usize > offsets.len() {
856                bail!("gfx.set_bind_group_offsets: {count} offsets (a bind group has at most {})", offsets.len());
857            }
858            for (o, b) in offsets.iter_mut().zip(bytes.chunks_exact(4)) {
859                *o = u32::from_le_bytes([b[0], b[1], b[2], b[3]]);
860            }
861            host.gfx.set_bind_group_offsets(i, bg, &offsets[..count as usize]).map_err(trap)
862        },
863    )?;
864    linker.func_wrap(
865        M,
866        "set_viewport",
867        |mut c: Caller<'_, Host>, x: f32, y: f32, w: f32, h: f32, min: f32, max: f32| -> wasmtime::Result<()> {
868            c.data_mut().gfx.set_viewport(x, y, w, h, min, max).map_err(trap)
869        },
870    )?;
871    linker.func_wrap(M, "set_scissor_rect", |mut c: Caller<'_, Host>, x: u32, y: u32, w: u32, h: u32| -> wasmtime::Result<()> {
872        c.data_mut().gfx.set_scissor_rect(x, y, w, h).map_err(trap)
873    })?;
874    linker.func_wrap(M, "set_vertex_buffer", |mut c: Caller<'_, Host>, slot: u32, b: u32, off: u32| -> wasmtime::Result<()> {
875        c.data_mut().gfx.set_vertex_buffer(slot, b, off).map_err(trap)
876    })?;
877    linker.func_wrap(M, "set_index_buffer", |mut c: Caller<'_, Host>, b: u32, fmt: u32, off: u32| -> wasmtime::Result<()> {
878        c.data_mut().gfx.set_index_buffer(b, fmt, off).map_err(trap)
879    })?;
880    linker.func_wrap(M, "draw", |mut c: Caller<'_, Host>, vc: u32, ic: u32, fv: u32, fi: u32| -> wasmtime::Result<()> {
881        c.data_mut().gfx.draw(vc, ic, fv, fi).map_err(trap)
882    })?;
883    linker.func_wrap(M, "draw_indexed", |mut c: Caller<'_, Host>, ic: u32, n: u32, first: u32, base: i32, fi: u32| -> wasmtime::Result<()> {
884        c.data_mut().gfx.draw_indexed(ic, n, first, base, fi).map_err(trap)
885    })?;
886    linker.func_wrap(M, "end_frame", |mut c: Caller<'_, Host>| -> wasmtime::Result<()> {
887        let h = c.data_mut();
888        h.frames_presented += 1;
889        h.gfx.end_frame().map_err(trap)
890    })?;
891    linker.func_wrap(M, "destroy", |mut c: Caller<'_, Host>, handle: u32| -> wasmtime::Result<()> {
892        c.data_mut().gfx.destroy(handle).map_err(trap)
893    })?;
894    Ok(())
895}
896
897fn add_net_imports(linker: &mut Linker<Host>) -> wasmtime::Result<()> {
898    const M: &str = "gasm:net";
899    linker.func_wrap(M, "open", |mut c: Caller<'_, Host>, ptr: u32, len: u32| -> wasmtime::Result<i32> {
900        let url = guest_str(&c, ptr, len)?;
901        Ok(c.data_mut().net.open(&url))
902    })?;
903    linker.func_wrap(M, "state", |c: Caller<'_, Host>, h: i32| -> wasmtime::Result<u32> { c.data().net.state(h).map_err(trap) })?;
904    linker.func_wrap(M, "send", |mut c: Caller<'_, Host>, h: i32, ptr: u32, len: u32| -> wasmtime::Result<i32> {
905        let mem = memory(&c)?;
906        let msg = guest_slice(mem.data(&c), ptr, len as u64)?.to_vec();
907        if msg.is_empty() {
908            c.data().net.state(h).map_err(trap)?; // still validates the handle
909            return Ok(-1);
910        }
911        c.data_mut().net.send(h, msg).map_err(trap)
912    })?;
913    linker.func_wrap(M, "recv", |mut c: Caller<'_, Host>, h: i32, dst: u32, cap: u32| -> wasmtime::Result<i32> {
914        let mem = memory(&c)?;
915        let (data, host) = mem.data_and_store_mut(&mut c);
916        let msg = match host.net.peek(h).map_err(trap)? {
917            Ok(m) => m,
918            Err(code) => return Ok(code),
919        };
920        let n = copy_if_fits(data, dst, cap, msg)?;
921        if n as usize <= cap as usize {
922            host.net.pop(h);
923        }
924        Ok(n)
925    })?;
926    linker.func_wrap(M, "close", |mut c: Caller<'_, Host>, h: i32| -> wasmtime::Result<()> { c.data_mut().net.close(h).map_err(trap) })?;
927    Ok(())
928}
929
930fn add_fetch_imports(linker: &mut Linker<Host>) -> wasmtime::Result<()> {
931    const M: &str = "gasm:fetch";
932    linker.func_wrap(M, "request", |mut c: Caller<'_, Host>, dp: u32, dl: u32, bp: u32, bl: u32| -> wasmtime::Result<i32> {
933        let desc = guest_str(&c, dp, dl)?;
934        let mem = memory(&c)?;
935        let body = guest_slice(mem.data(&c), bp, bl as u64)?.to_vec();
936        let h = c.data_mut();
937        let frame = h.frame_index;
938        Ok(h.fetch.request(&desc, body, frame))
939    })?;
940    linker.func_wrap(M, "state", |mut c: Caller<'_, Host>, r: i32| -> wasmtime::Result<u32> {
941        let h = c.data_mut();
942        let frame = h.frame_index;
943        h.fetch.state(r, frame).map_err(trap)
944    })?;
945    linker.func_wrap(M, "status", |mut c: Caller<'_, Host>, r: i32| -> wasmtime::Result<i32> {
946        let h = c.data_mut();
947        let frame = h.frame_index;
948        h.fetch.status(r, frame).map_err(trap)
949    })?;
950    linker.func_wrap(M, "headers", |mut c: Caller<'_, Host>, r: i32, dst: u32, cap: u32| -> wasmtime::Result<i32> {
951        let mem = memory(&c)?;
952        let (data, host) = mem.data_and_store_mut(&mut c);
953        let frame = host.frame_index;
954        match host.fetch.headers(r, frame).map_err(trap)? {
955            Some(text) => copy_if_fits(data, dst, cap, text.as_bytes()),
956            None => Ok(-1),
957        }
958    })?;
959    linker.func_wrap(M, "read", |mut c: Caller<'_, Host>, r: i32, dst: u32, cap: u32| -> wasmtime::Result<i32> {
960        let mem = memory(&c)?;
961        guest_slice(mem.data(&c), dst, cap as u64)?; // the whole destination must be guest memory
962        let (data, host) = mem.data_and_store_mut(&mut c);
963        let frame = host.frame_index;
964        match host.fetch.read(r, (cap as usize).min(i32::MAX as usize), frame).map_err(trap)? {
965            Ok(bytes) => {
966                guest_slice_mut(data, dst, bytes.len() as u64)?.copy_from_slice(&bytes);
967                Ok(bytes.len() as i32)
968            }
969            Err(()) => Ok(-1),
970        }
971    })?;
972    linker.func_wrap(M, "close", |mut c: Caller<'_, Host>, r: i32| -> wasmtime::Result<()> { c.data_mut().fetch.close(r).map_err(trap) })?;
973    Ok(())
974}
975
976fn add_storage_imports(linker: &mut Linker<Host>) -> wasmtime::Result<()> {
977    const M: &str = "gasm:storage";
978    linker.func_wrap(M, "get", |mut c: Caller<'_, Host>, kp: u32, kl: u32, dst: u32, cap: u32| -> wasmtime::Result<i32> {
979        let key = guest_str(&c, kp, kl)?;
980        let mem = memory(&c)?;
981        let (data, host) = mem.data_and_store_mut(&mut c);
982        let Some(v) = host.storage.get(&key) else { return Ok(-1) };
983        copy_if_fits(data, dst, cap, v)
984    })?;
985    linker.func_wrap(M, "set", |mut c: Caller<'_, Host>, kp: u32, kl: u32, vp: u32, vl: u32| -> wasmtime::Result<i32> {
986        let key = guest_str(&c, kp, kl)?;
987        let mem = memory(&c)?;
988        let (data, host) = mem.data_and_store_mut(&mut c);
989        let value = guest_slice(data, vp, vl as u64)?;
990        Ok(match host.storage.set(&key, value) {
991            Ok(()) => 0,
992            Err(e) => {
993                eprintln!("[gasm] storage: {key}: {e}");
994                e.code()
995            }
996        })
997    })?;
998    linker.func_wrap(M, "count", |mut c: Caller<'_, Host>| -> u32 { c.data_mut().storage.keys().len() as u32 })?;
999    linker.func_wrap(M, "key", |mut c: Caller<'_, Host>, index: u32, dst: u32, cap: u32| -> wasmtime::Result<i32> {
1000        let mem = memory(&c)?;
1001        let (data, host) = mem.data_and_store_mut(&mut c);
1002        let Some(k) = host.storage.keys().get(index as usize) else { return Ok(-1) };
1003        copy_if_fits(data, dst, cap, k.as_bytes())
1004    })?;
1005    linker.func_wrap(M, "delete", |mut c: Caller<'_, Host>, kp: u32, kl: u32| -> wasmtime::Result<i32> {
1006        let key = guest_str(&c, kp, kl)?;
1007        Ok(if c.data_mut().storage.delete(&key) { 0 } else { -1 })
1008    })?;
1009    Ok(())
1010}
1011
1012/// Why a guest call ended.
1013#[derive(Debug)]
1014pub enum Stop {
1015    /// The guest called proc_exit(code).
1016    Exit(i32),
1017    Trap(String),
1018}
1019
1020impl std::fmt::Display for Stop {
1021    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
1022        match self {
1023            Stop::Exit(code) => write!(f, "guest exited with code {code}"),
1024            Stop::Trap(msg) => write!(f, "guest trapped: {msg}"),
1025        }
1026    }
1027}
1028
1029impl std::error::Error for Stop {}
1030
1031fn classify(e: wasmtime::Error) -> Stop {
1032    if let Some(exit) = e.downcast_ref::<wasi::Exit>() {
1033        return Stop::Exit(exit.0);
1034    }
1035    if e.downcast_ref::<switching::Quit>().is_some() {
1036        return Stop::Exit(0);
1037    }
1038    if e.downcast_ref::<wasmtime::Trap>() == Some(&wasmtime::Trap::Interrupt) {
1039        return Stop::Trap(format!("a guest call ran longer than the time limit (stuck in a loop?); see --call-timeout\n{e:?}"));
1040    }
1041    Stop::Trap(format!("{e:?}"))
1042}
1043
1044/// Epoch ticks per second (the watchdog thread's rate).
1045const TICKS_PER_SEC: u64 = 10;
1046
1047/// The process-wide engine: the same configuration for compiling, precompiling
1048/// and loading (`.cwasm` files must match it). Epoch interruption lets a guest
1049/// call that never returns be stopped (`LoadOptions::call_timeout`). Calls can be
1050/// sync (`gasm_frame` guests) or async (`gasm_run` guests: stack switching).
1051pub fn engine() -> &'static Engine {
1052    static ENGINE: OnceLock<Engine> = OnceLock::new();
1053    ENGINE.get_or_init(new_engine)
1054}
1055
1056fn new_engine() -> Engine {
1057    let mut config = Config::new();
1058    config.epoch_interruption(true);
1059    // a gasm_run guest's whole run is on this stack: the default wasm stack limit plus room
1060    config.async_stack_size(4 << 20);
1061    let engine = Engine::new(&config).expect("wasmtime engine");
1062    let ticker = engine.clone();
1063    std::thread::Builder::new()
1064        .name("gasm-epoch".into())
1065        .spawn(move || {
1066            loop {
1067                std::thread::sleep(Duration::from_millis(1000 / TICKS_PER_SEC));
1068                ticker.increment_epoch();
1069            }
1070        })
1071        .expect("epoch thread");
1072    engine
1073}
1074
1075/// Ahead-of-time compile a guest to native code for this host (no JIT needed at load).
1076pub fn precompile(wasm: &[u8]) -> wasmtime::Result<Vec<u8>> {
1077    engine().precompile_module(wasm)
1078}
1079
1080/// How to load a guest.
1081#[derive(Clone, Copy)]
1082pub struct LoadOptions {
1083    /// Accept a precompiled `.cwasm` (native code: only files you made yourself
1084    /// with `gasm-run --compile`). Otherwise only `.wasm` modules load.
1085    pub allow_precompiled: bool,
1086    /// Trap a single guest call (init, a frame, exit) that runs longer than this.
1087    pub call_timeout: Option<Duration>,
1088    /// Run guests that export `gasm_run` that way (the runner switches stacks).
1089    /// Off: always `gasm_frame` (tests of the Asyncify path).
1090    pub stack_switching: bool,
1091}
1092
1093impl Default for LoadOptions {
1094    fn default() -> Self {
1095        LoadOptions { allow_precompiled: false, call_timeout: Some(Duration::from_secs(30)), stack_switching: true }
1096    }
1097}
1098
1099/// The running `gasm_run` call: owns the store until the run ends.
1100type Running = Pin<Box<dyn Future<Output = (Store<Host>, wasmtime::Result<i32>)>>>;
1101
1102/// A running guest. `gasm_frame` guests are called once per frame; `gasm_run`
1103/// guests run in one suspended call (stack switching) that each [`Game::frame`]
1104/// resumes until its next `yield_frame`.
1105pub struct Game {
1106    /// None while a `gasm_run` call is running (the call owns it): use [`Game::with_host`]
1107    store: Option<Store<Host>>,
1108    frame: TypedFunc<(), ()>,
1109    exit: Option<TypedFunc<(), ()>>,
1110    deadline: u64,
1111    /// `gasm_run` (async engine)
1112    run: Option<TypedFunc<(), i32>>,
1113    running: Option<Running>,
1114    exchange: Option<Arc<Exchange>>,
1115    /// the guest exited or trapped: it is never called again
1116    ended: bool,
1117    /// the guest imports gasm:gl (the native window has no GL backend yet)
1118    gl: bool,
1119    /// files re-read as assets when they change (`--watch-asset`), checked before each frame
1120    watches: Vec<crate::assets::AssetWatch>,
1121}
1122
1123impl Game {
1124    pub fn load(wasm: &[u8], host: Host, opts: LoadOptions) -> Result<Game, Stop> {
1125        Self::load_inner(wasm, host, opts).map_err(classify)
1126    }
1127
1128    fn load_inner(wasm: &[u8], host: Host, opts: LoadOptions) -> wasmtime::Result<Game> {
1129        let module = if wasm.starts_with(b"\0asm") {
1130            Module::new(engine(), wasm)?
1131        } else if opts.allow_precompiled {
1132            // Precompiled artifact from `gasm-run --compile`: native code, trusted
1133            // like the runner itself (unlike .wasm, which is sandboxed).
1134            unsafe { Module::deserialize(engine(), wasm)? }
1135        } else {
1136            bail!("not a wasm module (a precompiled .cwasm runs as native code: pass --allow-precompiled if you made it yourself)");
1137        };
1138        let gl = module.imports().any(|i| i.module() == "gasm:gl");
1139        if gl && module.imports().any(|i| i.module() == "gasm:gfx") {
1140            bail!("a module imports gasm:gfx or gasm:gl, not both");
1141        }
1142        // guests that export gasm_run run in one async call (stack switching)
1143        let has_run = module.get_export("gasm_run").is_some();
1144        let switching = has_run && opts.stack_switching;
1145        if has_run && !switching && module.imports().any(|i| i.module() == "asyncify") {
1146            // made without wasm-opt --asyncify: its gasm_frame can't suspend
1147            bail!("this module is a run build (no Asyncify): it needs stack switching (gasm_run); use the game's Asyncify build");
1148        }
1149        let engine = engine();
1150        let mut linker: Linker<Host> = Linker::new(engine);
1151        add_gasm_imports(&mut linker)?;
1152        if switching {
1153            switching::add_yield_async(&mut linker)?;
1154        } else {
1155            switching::add_yield_sync(&mut linker)?;
1156        }
1157        add_gfx_imports(&mut linker)?;
1158        crate::gl::add_gl_imports(&mut linker)?;
1159        add_net_imports(&mut linker)?;
1160        add_fetch_imports(&mut linker)?;
1161        add_storage_imports(&mut linker)?;
1162        let mut store = Store::new(engine, host);
1163        // what `has` reports: the gasm modules and functions above (not WASI stubs or traps)
1164        let mut provided = HashSet::new();
1165        for (m, f, _) in linker.iter(&mut store) {
1166            provided.insert(m.to_owned());
1167            provided.insert(format!("{m}.{f}"));
1168        }
1169        for f in wasi::IMPLEMENTED {
1170            provided.insert(format!("{}.{f}", wasi::MODULE));
1171        }
1172        provided.insert(wasi::MODULE.to_owned());
1173        store.data_mut().provided = provided;
1174        wasi::add_to_linker(&mut linker, &module)?;
1175        // Imports this runner doesn't know (e.g. JS glue some Rust crates pull in)
1176        // link as traps: harmless unless the guest actually calls them.
1177        linker.define_unknown_imports_as_traps(&module)?;
1178
1179        let deadline = opts.call_timeout.map_or(u64::MAX / 2, |t| (t.as_millis() as u64 * TICKS_PER_SEC).div_ceil(1000).max(1));
1180        store.epoch_deadline_trap();
1181        store.set_epoch_deadline(deadline);
1182        let exchange = switching.then(|| Exchange::new(deadline));
1183        store.data_mut().run = exchange.clone();
1184        let instance: Instance = if switching {
1185            switching::block_on(linker.instantiate_async(&mut store, &module))??
1186        } else {
1187            linker.instantiate(&mut store, &module)?
1188        };
1189        let memory = instance
1190            .get_memory(&mut store, "memory")
1191            .ok_or_else(|| format_err!("guest does not export `memory`"))?;
1192        store.data_mut().memory = Some(memory);
1193
1194        // a call that must not suspend, on either engine
1195        fn call<R: wasmtime::WasmResults + Send + Sync>(store: &mut Store<Host>, f: TypedFunc<(), R>, switching: bool) -> wasmtime::Result<R> {
1196            if switching { switching::block_on(f.call_async(store, ()))? } else { f.call(store, ()) }
1197        }
1198        if let Ok(init) = instance.get_typed_func::<(), ()>(&mut store, "_initialize") {
1199            store.set_epoch_deadline(deadline);
1200            call(&mut store, init, switching)?;
1201        }
1202        let version = instance.get_typed_func::<(), i32>(&mut store, "gasm_abi_version")?;
1203        let version = call(&mut store, version, switching)?;
1204        if version != ABI_VERSION {
1205            bail!("guest targets gasm ABI v{version}, runner implements v{ABI_VERSION}");
1206        }
1207        store.set_epoch_deadline(deadline);
1208        let init = instance.get_typed_func::<(), i32>(&mut store, "gasm_init")?;
1209        let rc = call(&mut store, init, switching)?;
1210        if rc != 0 {
1211            bail!("gasm_init failed with code {rc}");
1212        }
1213        let frame = instance.get_typed_func::<(), ()>(&mut store, "gasm_frame")?;
1214        let exit = instance.get_typed_func::<(), ()>(&mut store, "gasm_exit").ok();
1215        let run = if switching { Some(instance.get_typed_func::<(), i32>(&mut store, "gasm_run")?) } else { None };
1216        Ok(Game { store: Some(store), frame, exit, deadline, run, running: None, exchange, ended: false, gl, watches: Vec::new() })
1217    }
1218
1219    /// Add or replace an asset between frames: the guest sees it from the next
1220    /// frame on, with a new `gasm.asset_version`. Returns that version.
1221    pub fn set_asset(&mut self, name: &str, bytes: Vec<u8>) -> u32 {
1222        self.with_host(|h| h.assets.set(name, bytes))
1223    }
1224
1225    /// Remove an asset between frames. False if there was none.
1226    pub fn remove_asset(&mut self, name: &str) -> bool {
1227        self.with_host(|h| h.assets.remove(name))
1228    }
1229
1230    /// Re-read `path` as asset `name` whenever the file changes (in place or by a
1231    /// rename), checked before each frame.
1232    pub fn watch_asset(&mut self, name: &str, path: &std::path::Path) {
1233        self.add_watch(crate::assets::AssetWatch::new(name, path));
1234    }
1235
1236    /// [`Game::watch_asset`] with a watch made earlier (when the asset was first opened).
1237    pub fn add_watch(&mut self, watch: crate::assets::AssetWatch) {
1238        self.watches.push(watch);
1239    }
1240
1241    /// Whether the guest imports gasm:gl.
1242    pub fn uses_gl(&self) -> bool {
1243        self.gl
1244    }
1245
1246    /// Whether the guest runs through `gasm_run` (the runner switches stacks).
1247    pub fn switching(&self) -> bool {
1248        self.run.is_some()
1249    }
1250
1251    /// One frame: call `gasm_frame`, or resume `gasm_run` until its next `yield_frame`.
1252    pub fn frame(&mut self) -> Result<(), Stop> {
1253        if self.ended {
1254            return Err(Stop::Trap("the guest is not running".into()));
1255        }
1256        if !self.watches.is_empty() {
1257            let mut watches = std::mem::take(&mut self.watches);
1258            self.with_host(|h| watches.iter_mut().for_each(|w| _ = w.poll(&mut h.assets)));
1259            self.watches = watches;
1260        }
1261        let Some(run) = self.run.clone() else {
1262            let store = self.store.as_mut().expect("store");
1263            store.set_epoch_deadline(self.deadline);
1264            let r = self.frame.call(&mut *store, ()).map_err(classify);
1265            store.data_mut().frame_index += 1;
1266            self.ended = r.is_err();
1267            return r;
1268        };
1269        match &self.exchange {
1270            Some(ex) if self.running.is_some() => ex.set(Cmd::Resume),
1271            _ => {
1272                // frame 0 starts the run; the call owns the store from now on
1273                let mut store = self.store.take().expect("store");
1274                store.set_epoch_deadline(self.deadline);
1275                self.running = Some(Box::pin(async move {
1276                    let r = run.call_async(&mut store, ()).await;
1277                    (store, r)
1278                }));
1279            }
1280        }
1281        self.poll()
1282    }
1283
1284    /// Poll the running `gasm_run` call: Ok when it suspended again, the reason when it ended.
1285    fn poll(&mut self) -> Result<(), Stop> {
1286        let Some(running) = self.running.as_mut() else { return Ok(()) };
1287        match switching::poll_once(running.as_mut()) {
1288            Poll::Pending => Ok(()),
1289            Poll::Ready((store, r)) => {
1290                self.store = Some(store);
1291                self.running = None;
1292                self.ended = true;
1293                Err(match r {
1294                    Ok(code) => Stop::Exit(code),
1295                    Err(e) => classify(e),
1296                })
1297            }
1298        }
1299    }
1300
1301    /// Best-effort "the player is quitting" notification (optional `gasm_exit` export).
1302    /// A suspended `gasm_run` guest gets it on top of its run, which then ends.
1303    pub fn exit(&mut self) {
1304        if self.running.is_some() {
1305            if let Some(ex) = &self.exchange {
1306                ex.set(Cmd::Exit);
1307            }
1308            if let Err(Stop::Trap(t)) = self.poll() {
1309                eprintln!("[gasm] gasm_exit trapped: {t}");
1310            }
1311            if self.running.is_some() {
1312                // gasm_exit yielded: give up on the run (the store stays with it)
1313                self.running = None;
1314            }
1315            self.exit = None;
1316            return;
1317        }
1318        if let (Some(f), Some(store)) = (self.exit.take(), self.store.as_mut()) {
1319            store.set_epoch_deadline(self.deadline);
1320            let r = if self.run.is_some() { switching::block_on(f.call_async(&mut *store, ())).and_then(|r| r) } else { f.call(&mut *store, ()) };
1321            if let Err(e) = r {
1322                if let Stop::Trap(t) = classify(e) {
1323                    eprintln!("[gasm] gasm_exit trapped: {t}");
1324                }
1325            }
1326        }
1327    }
1328
1329    /// Run `f` on the host: directly, or (a suspended `gasm_run` guest) through
1330    /// the guest's `yield_frame`, which owns the store meanwhile. Runners use this
1331    /// between frames for everything they read or set.
1332    pub fn with_host<R>(&mut self, f: impl FnOnce(&mut Host) -> R) -> R {
1333        if let Some(store) = &mut self.store {
1334            return f(store.data_mut());
1335        }
1336        let (Some(running), Some(ex)) = (self.running.as_mut(), &self.exchange) else {
1337            panic!("with_host: the guest's store is gone (gasm_exit yielded)");
1338        };
1339        let mut f = Some(f);
1340        let mut out = None;
1341        let mut job = |h: &mut Host| out = Some((f.take().expect("job runs once"))(h));
1342        let ptr: *mut (dyn FnMut(&mut Host) + '_) = &mut job;
1343        // SAFETY: the pointer is only used by yield_frame during the poll below,
1344        // while `job` is alive on this stack; it is dropped before we return.
1345        let ptr: *mut (dyn FnMut(&mut Host) + 'static) = unsafe { std::mem::transmute(ptr) };
1346        ex.set(Cmd::Job(Job(ptr)));
1347        let polled = switching::poll_once(running.as_mut());
1348        ex.set(Cmd::None);
1349        match polled {
1350            Poll::Pending => {}
1351            Poll::Ready(_) => unreachable!("yield_frame stays suspended after a job"),
1352        }
1353        out.expect("yield_frame ran the job")
1354    }
1355
1356    /// The host of a guest that isn't suspended in `gasm_run` (every `gasm_frame`
1357    /// guest; a `gasm_run` guest before its first frame and after it ended).
1358    /// Otherwise use [`Game::with_host`].
1359    pub fn host(&self) -> &Host {
1360        self.store.as_ref().expect("Game::host: a gasm_run guest is running; use Game::with_host").data()
1361    }
1362
1363    pub fn host_mut(&mut self) -> &mut Host {
1364        self.store.as_mut().expect("Game::host_mut: a gasm_run guest is running; use Game::with_host").data_mut()
1365    }
1366}
1367
1368#[cfg(test)]
1369mod tests {
1370    use super::*;
1371
1372    #[test]
1373    fn titles_are_cleaned_and_cut() {
1374        assert_eq!(clean_title("A\u{7}B\u{202e}C\u{2069}").as_deref(), Some("ABC"));
1375        assert_eq!(clean_title("\n\t"), None);
1376        // 200 two-byte characters: cut at 256 bytes, on a character boundary
1377        assert_eq!(clean_title(&"é".repeat(200)).map(|t| t.len()), Some(256));
1378    }
1379
1380    const RUN_GUEST: &str = r#"(module
1381      (import "gasm" "yield_frame" (func $yield))
1382      (memory (export "memory") 1)
1383      (global $n (mut i32) (i32.const 0))
1384      (func (export "gasm_abi_version") (result i32) i32.const 0)
1385      (func (export "gasm_init") (result i32) i32.const 0)
1386      (func (export "gasm_frame") call $yield)
1387      (func (export "gasm_exit") (global.set $n (i32.const 100)))
1388      (func (export "frames") (result i32) global.get $n)
1389      (func (export "gasm_run") (result i32)
1390        (loop $l
1391          (global.set $n (i32.add (global.get $n) (i32.const 1)))
1392          call $yield
1393          (br_if $l (i32.lt_u (global.get $n) (i32.const 3))))
1394        i32.const 7))"#;
1395
1396    fn host() -> Host {
1397        Host::new(Assets::new(), HashMap::new(), None, Gfx::null(), Net::new(false), Storage::memory())
1398    }
1399
1400    #[test]
1401    fn gasm_run_guests_suspend_between_frames() {
1402        let mut g = Game::load(&wat::parse_str(RUN_GUEST).unwrap(), host(), LoadOptions::default()).unwrap();
1403        assert!(g.switching());
1404        g.with_host(|h| h.frame_rate = 30.0); // before the first frame: the store is ours
1405        assert!(g.frame().is_ok()); // n = 1, suspended in yield_frame
1406        // suspended: the host is reached through the guest's yield_frame
1407        assert_eq!(g.with_host(|h| h.frame_rate), 30.0);
1408        assert!(g.frame().is_ok()); // n = 2
1409        assert!(g.frame().is_ok()); // n = 3
1410        // the loop ends: gasm_run returns 7, the exit code
1411        assert!(matches!(g.frame(), Err(Stop::Exit(7))));
1412        assert!(g.frame().is_err(), "never called again");
1413    }
1414
1415    #[test]
1416    fn exit_runs_on_top_of_a_suspended_run() {
1417        let mut g = Game::load(&wat::parse_str(RUN_GUEST).unwrap(), host(), LoadOptions::default()).unwrap();
1418        g.frame().unwrap();
1419        g.exit();
1420        // the store is back after the run ended; gasm_exit ran (n = 100)
1421        assert!(g.store.is_some());
1422    }
1423
1424    #[test]
1425    fn yield_frame_outside_gasm_run_traps() {
1426        let opts = LoadOptions { stack_switching: false, ..LoadOptions::default() };
1427        let mut g = Game::load(&wat::parse_str(RUN_GUEST).unwrap(), host(), opts).unwrap();
1428        assert!(!g.switching());
1429        match g.frame() {
1430            Err(Stop::Trap(t)) => assert!(t.contains("only inside gasm_run"), "{t}"),
1431            other => panic!("expected a trap, got {:?}", other.err()),
1432        }
1433    }
1434
1435    #[test]
1436    fn custom_sections_are_found() {
1437        // magic + version, a type section (id 1, empty), then custom "gasm.title" = "Hi\0"
1438        let mut wasm = b"\0asm\x01\0\0\0\x01\x01\0".to_vec();
1439        wasm.extend_from_slice(&[0, 14, 10]);
1440        wasm.extend_from_slice(b"gasm.titleHi\0");
1441        assert_eq!(custom_section(&wasm, "gasm.title"), Some(&b"Hi\0"[..]));
1442        assert_eq!(static_title(&wasm).as_deref(), Some("Hi"));
1443        assert_eq!(custom_section(&wasm, "other"), None);
1444        assert_eq!(custom_section(&wasm[..wasm.len() - 2], "gasm.title"), None); // truncated
1445        assert_eq!(custom_section(b"not wasm", "gasm.title"), None);
1446    }
1447}