1use 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#[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#[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 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#[derive(Default, Clone)]
80pub struct RawInput {
81 pub keys: Option<[u8; KEY_STATE_BYTES]>,
83 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 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 pub flags: u32,
109 pub drawable: (f32, f32),
111 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
124pub 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
134pub const TITLE_MAX_BYTES: usize = 256;
136
137#[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 let bias = match unsafe { GetTimeZoneInformation(&mut tz) } {
154 1 => tz.Bias + tz.StandardBias, 2 => tz.Bias + tz.DaylightBias, 0 => tz.Bias, _ => 0,
158 };
159 -bias
160}
161
162#[cfg(not(any(unix, windows)))]
163fn utc_offset_minutes() -> i32 {
164 0
165}
166
167pub 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
182pub 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
221pub fn static_title(wasm: &[u8]) -> Option<String> {
224 clean_title(std::str::from_utf8(custom_section(wasm, "gasm.title")?).ok()?)
225}
226
227pub struct MemoryLimit(pub Option<usize>);
230
231impl wasmtime::ResourceLimiter for MemoryLimit {
232 fn memory_growing(&mut self, _current: usize, desired: usize, _maximum: Option<usize>) -> wasmtime::Result<bool> {
233 match self.0 {
234 Some(limit) if desired > limit => bail!("{}", memory_limit_message(limit)),
235 _ => Ok(true),
236 }
237 }
238 fn table_growing(&mut self, _current: usize, _desired: usize, _maximum: Option<usize>) -> wasmtime::Result<bool> {
239 Ok(true)
240 }
241}
242
243pub fn memory_limit_message(limit: usize) -> String {
245 format!("the game needs more memory than its limit ({} MiB; see --memory-limit)", limit >> 20)
246}
247
248pub const DEFAULT_MEMORY_LIMIT: usize = 1 << 30;
250
251pub struct Host {
252 memory: Option<Memory>,
253 start: Instant,
254 pub virtual_time_ms: Option<f64>,
257 pub random: Option<Splitmix>,
259 pub frame_rate: f64,
260 pub pads: [u32; 4],
261 pub text: Option<String>,
264 pub input: RawInput,
265 pub input_mode: u32,
267 pub assets: Assets,
268 pub params: HashMap<String, String>,
269 pub audio: Option<Box<dyn AudioOut>>,
270 pub gfx: Gfx,
271 pub gl: crate::gl::Gl,
273 pub frame_index: u64,
275 pub net: Net,
276 pub fetch: crate::fetch::Fetch,
278 pub clipboard: Clipboard,
280 pub files: crate::files::Files,
282 pub requires: Vec<String>,
284 pub storage: Storage,
285 pub show_frame: bool,
287 audio_rate: u32,
288 audio_channels: u32,
289 provided: HashSet<String>,
291 pub rgba: Vec<u8>,
293 pub width: usize,
294 pub height: usize,
295 pub frames_presented: u64,
296 pub aspect: Option<(u32, u32)>,
298 pub(crate) run: Option<Arc<Exchange>>,
300 pub title: Option<String>,
302 pub title_changed: bool,
304 pub hashing: bool,
305 pub video_hash: Fnv,
306 pub audio_hash: Fnv,
307 pub audio_frames: u64,
308 pub memory_limit: MemoryLimit,
310 pub catch_up: bool,
312}
313
314impl Host {
315 pub fn new(
316 assets: impl Into<Assets>,
317 params: HashMap<String, String>,
318 audio: Option<Box<dyn AudioOut>>,
319 gfx: Gfx,
320 net: Net,
321 storage: Storage,
322 ) -> Self {
323 Host {
324 memory: None,
325 start: Instant::now(),
326 virtual_time_ms: None,
327 random: None,
328 frame_rate: 60.0,
329 pads: [0; 4],
330 text: None,
331 input: RawInput::default(),
332 input_mode: 0,
333 assets: assets.into(),
334 params,
335 audio,
336 gfx,
337 gl: Default::default(),
338 fetch: Default::default(),
339 clipboard: Default::default(),
340 files: Default::default(),
341 requires: Vec::new(),
342 memory_limit: MemoryLimit(Some(DEFAULT_MEMORY_LIMIT)),
343 catch_up: false,
344 frame_index: 0,
345 net,
346 storage,
347 show_frame: true,
348 audio_rate: 44100,
349 audio_channels: 2,
350 provided: HashSet::new(),
351 title: None,
352 title_changed: false,
353 aspect: None,
354 run: None,
355 rgba: Vec::new(),
356 width: 0,
357 height: 0,
358 frames_presented: 0,
359 hashing: true,
360 video_hash: Fnv::new(),
361 audio_hash: Fnv::new(),
362 audio_frames: 0,
363 }
364 }
365
366 pub fn set_reproducible(&mut self) {
369 self.virtual_time_ms = Some(0.0);
370 self.random = Some(Splitmix(0));
371 }
372
373 pub(crate) fn started(&self) -> Instant {
374 self.start
375 }
376}
377
378pub fn imports_module(wasm: &[u8], module: &str, allow_precompiled: bool) -> bool {
381 if !wasm.starts_with(b"\0asm") {
382 if !allow_precompiled {
383 return false;
384 }
385 return unsafe { Module::deserialize(engine(), wasm) }.is_ok_and(|m| m.imports().any(|i| i.module() == module));
386 }
387 fn leb(b: &[u8], p: &mut usize) -> Option<u32> {
388 let (mut v, mut shift) = (0u32, 0);
389 loop {
390 let byte = *b.get(*p)?;
391 *p += 1;
392 v |= ((byte & 0x7f) as u32) << shift;
393 if byte & 0x80 == 0 {
394 return Some(v);
395 }
396 shift += 7;
397 if shift > 28 {
398 return None;
399 }
400 }
401 }
402 fn name<'a>(b: &'a [u8], p: &mut usize) -> Option<&'a [u8]> {
403 let n = leb(b, p)? as usize;
404 let s = b.get(*p..*p + n)?;
405 *p += n;
406 Some(s)
407 }
408 let scan = || -> Option<bool> {
409 let mut p = 8;
410 while p < wasm.len() {
411 let id = wasm[p];
412 p += 1;
413 let size = leb(wasm, &mut p)? as usize;
414 let end = p.checked_add(size)?;
415 if id == 2 {
416 let mut q = p;
417 for _ in 0..leb(wasm, &mut q)? {
418 if name(wasm, &mut q)? == module.as_bytes() {
419 return Some(true);
420 }
421 name(wasm, &mut q)?;
422 match *wasm.get(q)? {
423 0 => { q += 1; leb(wasm, &mut q)?; } 1 => { q += 2; let f = wasm[q - 1]; leb(wasm, &mut q)?; if f & 1 != 0 { leb(wasm, &mut q)?; } } 2 => { q += 1; let f = *wasm.get(q)?; q += 1; leb(wasm, &mut q)?; if f & 1 != 0 { leb(wasm, &mut q)?; } } 3 => q += 3, 4 => { q += 2; leb(wasm, &mut q)?; } _ => return None,
429 }
430 }
431 return Some(false);
432 }
433 p = end;
434 }
435 Some(false)
436 };
437 scan().unwrap_or(false)
438}
439
440pub(crate) fn guest_slice(mem: &[u8], ptr: u32, len: u64) -> wasmtime::Result<&[u8]> {
442 let start = ptr as u64;
443 let end = start.checked_add(len).ok_or_else(|| format_err!("guest pointer overflow"))?;
444 if end > mem.len() as u64 {
445 bail!("guest access out of bounds: {start:#x}..{end:#x} (memory is {:#x})", mem.len());
446 }
447 Ok(&mem[start as usize..end as usize])
448}
449
450pub(crate) fn guest_slice_mut(mem: &mut [u8], ptr: u32, len: u64) -> wasmtime::Result<&mut [u8]> {
452 let start = ptr as u64;
453 let end = start.checked_add(len).ok_or_else(|| format_err!("guest pointer overflow"))?;
454 if end > mem.len() as u64 {
455 bail!("guest access out of bounds: {start:#x}..{end:#x} (memory is {:#x})", mem.len());
456 }
457 Ok(&mut mem[start as usize..end as usize])
458}
459
460#[derive(Default)]
466pub struct Clipboard {
467 pub pasted: Option<String>,
468 pub copied: Option<String>,
469}
470
471pub const CLIPBOARD_MAX: usize = 1 << 20;
473
474fn copy_if_fits(mem: &mut [u8], dst: u32, cap: u32, src: &[u8]) -> wasmtime::Result<i32> {
475 if src.len() <= cap as usize {
476 guest_slice_mut(mem, dst, src.len() as u64)?.copy_from_slice(src);
477 }
478 Ok(src.len() as i32)
479}
480
481pub(crate) fn memory(caller: &Caller<'_, Host>) -> wasmtime::Result<Memory> {
482 caller.data().memory.ok_or_else(|| format_err!("guest memory not yet available"))
483}
484
485fn guest_str(caller: &Caller<'_, Host>, ptr: u32, len: u32) -> wasmtime::Result<String> {
486 let mem = memory(caller)?;
487 let bytes = guest_slice(mem.data(caller), ptr, len as u64)?;
488 std::str::from_utf8(bytes).map(str::to_owned).map_err(|e| format_err!("string argument is not UTF-8: {e}"))
489}
490
491fn pointer_bytes(p: &Pointer, frame: (usize, usize), aspect: Option<(u32, u32)>) -> [u8; POINTER_BYTES] {
493 let (fx, fy) = frame_position(p.x, p.y, p.drawable, frame, p.integer_scale, aspect);
494 let mut b = [0u8; POINTER_BYTES];
495 for (i, v) in [p.x, p.y, fx, fy, p.dx, p.dy, p.wheel_x, p.wheel_y].into_iter().enumerate() {
496 b[i * 4..i * 4 + 4].copy_from_slice(&v.to_le_bytes());
497 }
498 for (i, v) in [p.buttons, p.pressed, p.released, p.flags].into_iter().enumerate() {
499 b[32 + i * 4..36 + i * 4].copy_from_slice(&v.to_le_bytes());
500 }
501 b
502}
503
504fn gamepad_bytes(g: &Gamepad) -> [u8; GAMEPAD_BYTES] {
506 let mut b = [0u8; GAMEPAD_BYTES];
507 let nb = g.buttons.len().min(GAMEPAD_BUTTONS);
508 let na = g.axes.len().min(GAMEPAD_AXES);
509 let flags = if g.connected { 1 | if g.standard { 2 } else { 0 } } else { 0u32 };
510 for (i, v) in [flags, nb as u32, na as u32].into_iter().enumerate() {
511 b[i * 4..i * 4 + 4].copy_from_slice(&v.to_le_bytes());
512 }
513 for (i, v) in g.buttons.iter().take(nb).enumerate() {
514 b[12 + i * 4..16 + i * 4].copy_from_slice(&v.to_le_bytes());
515 }
516 for (i, v) in g.axes.iter().take(na).enumerate() {
517 b[140 + i * 4..144 + i * 4].copy_from_slice(&v.to_le_bytes());
518 }
519 b
520}
521
522fn add_gasm_imports(linker: &mut Linker<Host>) -> wasmtime::Result<()> {
523 linker.func_wrap("gasm", "log", |caller: Caller<'_, Host>, ptr: u32, len: u32| -> wasmtime::Result<()> {
524 let mem = memory(&caller)?;
525 let msg = guest_slice(mem.data(&caller), ptr, len as u64)?;
526 eprintln!("[guest] {}", String::from_utf8_lossy(msg));
527 Ok(())
528 })?;
529
530 linker.func_wrap("gasm", "has", |caller: Caller<'_, Host>, ptr: u32, len: u32| -> wasmtime::Result<i32> {
531 let name = guest_str(&caller, ptr, len)?;
532 Ok(caller.data().provided.contains(&name) as i32)
533 })?;
534
535 linker.func_wrap("gasm", "video_set_aspect", |mut caller: Caller<'_, Host>, num: u32, den: u32| -> wasmtime::Result<()> {
536 let aspect = match (num, den) {
537 (0, 0) => None,
538 (1..=65535, 1..=65535) if num as u64 * 8 >= den as u64 && den as u64 * 8 >= num as u64 => Some((num, den)),
539 _ => bail!("video_set_aspect: invalid ratio {num}:{den}"),
540 };
541 caller.data_mut().aspect = aspect;
542 Ok(())
543 })?;
544
545 linker.func_wrap("gasm", "set_title", |mut caller: Caller<'_, Host>, ptr: u32, len: u32| -> wasmtime::Result<()> {
546 let title = clean_title(&guest_str(&caller, ptr, len)?);
547 let h = caller.data_mut();
548 if h.title != title {
549 h.title = title;
550 h.title_changed = true;
551 }
552 Ok(())
553 })?;
554
555 linker.func_wrap("gasm", "time_ms", |caller: Caller<'_, Host>| -> f64 {
556 let h = caller.data();
557 h.virtual_time_ms.unwrap_or_else(|| h.start.elapsed().as_secs_f64() * 1000.0)
558 })?;
559
560 linker.func_wrap("gasm", "utc_offset_minutes", |caller: Caller<'_, Host>| -> i32 {
561 if caller.data().virtual_time_ms.is_some() { 0 } else { utc_offset_minutes() }
563 })?;
564
565 linker.func_wrap("gasm", "set_frame_rate", |mut caller: Caller<'_, Host>, hz: f64| {
566 if hz.is_finite() && (1.0..=1000.0).contains(&hz) {
567 caller.data_mut().frame_rate = hz;
568 }
569 })?;
570
571 linker.func_wrap(
572 "gasm",
573 "video_present",
574 |mut caller: Caller<'_, Host>, ptr: u32, w: u32, h: u32, stride: u32| -> wasmtime::Result<()> {
575 let (w, h, stride) = (w as usize, h as usize, stride as usize);
576 if w == 0 || h == 0 || w > 4096 || h > 4096 || stride < w * 4 {
577 bail!("video_present: bad geometry {w}x{h} stride {stride}");
578 }
579 let mem = memory(&caller)?;
580 let (data, host) = mem.data_and_store_mut(&mut caller);
581 let src = guest_slice(data, ptr, (stride * (h - 1) + w * 4) as u64)?;
582 let row = w * 4;
583 host.rgba.resize(row * h, 0);
584 if stride == row {
585 host.rgba.copy_from_slice(src);
586 } else {
587 for (y, dst) in host.rgba.chunks_exact_mut(row).enumerate() {
588 dst.copy_from_slice(&src[y * stride..y * stride + row]);
589 }
590 }
591 if host.hashing {
592 host.video_hash.update(&host.rgba);
593 }
594 host.width = w;
595 host.height = h;
596 host.frames_presented += 1;
597 Ok(())
598 },
599 )?;
600
601 linker.func_wrap("gasm", "audio_config", |mut caller: Caller<'_, Host>, rate: u32, channels: u32| {
602 let h = caller.data_mut();
603 if (8000..=192_000).contains(&rate) && (channels == 1 || channels == 2) {
604 h.audio_rate = rate;
605 h.audio_channels = channels;
606 if let Some(a) = &mut h.audio {
607 a.configure(rate, channels);
608 }
609 }
610 })?;
611
612 linker.func_wrap(
613 "gasm",
614 "audio_push",
615 |mut caller: Caller<'_, Host>, ptr: u32, frames: u32| -> wasmtime::Result<()> {
616 let mem = memory(&caller)?;
617 let (data, host) = mem.data_and_store_mut(&mut caller);
618 let len = frames as u64 * host.audio_channels as u64 * 4;
619 let bytes = guest_slice(data, ptr, len)?;
620 if host.hashing {
621 host.audio_hash.update(bytes);
622 }
623 host.audio_frames += frames as u64;
624 if let Some(a) = &mut host.audio {
625 a.push_le_f32(bytes);
626 }
627 Ok(())
628 },
629 )?;
630
631 linker.func_wrap("gasm", "input_pad", |caller: Caller<'_, Host>, player: u32| -> u32 {
632 caller.data().pads.get(player as usize).copied().unwrap_or(0)
633 })?;
634
635 linker.func_wrap(
636 "gasm",
637 "text_input",
638 |mut caller: Caller<'_, Host>, dst: u32, cap: u32| -> wasmtime::Result<i32> {
639 let mem = memory(&caller)?;
640 let (data, host) = mem.data_and_store_mut(&mut caller);
641 let Some(t) = &host.text else { return Ok(-1) };
642 copy_if_fits(data, dst, cap, t.as_bytes())
643 },
644 )?;
645
646 linker.func_wrap("gasm", "input_mode", |mut caller: Caller<'_, Host>, flags: u32| {
647 caller.data_mut().input_mode = flags & 7;
648 })?;
649
650 linker.func_wrap(
651 "gasm",
652 "key_state",
653 |mut caller: Caller<'_, Host>, dst: u32, len: u32| -> wasmtime::Result<i32> {
654 let mem = memory(&caller)?;
655 let (data, host) = mem.data_and_store_mut(&mut caller);
656 let Some(keys) = host.input.keys else { return Ok(-1) };
657 let n = (len as usize).min(KEY_STATE_BYTES);
658 guest_slice_mut(data, dst, n as u64)?.copy_from_slice(&keys[..n]);
659 Ok(KEY_STATE_BYTES as i32)
660 },
661 )?;
662
663 linker.func_wrap(
664 "gasm",
665 "key_events",
666 |mut caller: Caller<'_, Host>, dst: u32, cap: u32| -> wasmtime::Result<i32> {
667 let mem = memory(&caller)?;
668 let (data, host) = mem.data_and_store_mut(&mut caller);
669 if host.input.keys.is_none() {
670 return Ok(-1);
671 }
672 let events = &host.input.key_events;
673 let len = events.len() * 4;
674 if len <= cap as usize {
675 let out = guest_slice_mut(data, dst, len as u64)?;
676 for (b, &(c, d)) in out.chunks_exact_mut(4).zip(events) {
677 let c = c.to_le_bytes();
678 b.copy_from_slice(&[c[0], c[1], d as u8, 0]);
679 }
680 }
681 Ok(len as i32)
682 },
683 )?;
684
685 linker.func_wrap(
686 "gasm",
687 "pointer",
688 |mut caller: Caller<'_, Host>, dst: u32, cap: u32| -> wasmtime::Result<i32> {
689 let mem = memory(&caller)?;
690 let (data, host) = mem.data_and_store_mut(&mut caller);
691 let Some(p) = &host.input.pointer else { return Ok(-1) };
692 if cap as usize >= POINTER_BYTES {
693 let b = pointer_bytes(p, (host.width, host.height), host.aspect);
694 guest_slice_mut(data, dst, POINTER_BYTES as u64)?.copy_from_slice(&b);
695 }
696 Ok(POINTER_BYTES as i32)
697 },
698 )?;
699
700 linker.func_wrap(
701 "gasm",
702 "gamepad",
703 |mut caller: Caller<'_, Host>, slot: u32, dst: u32, cap: u32| -> wasmtime::Result<i32> {
704 let mem = memory(&caller)?;
705 let (data, host) = mem.data_and_store_mut(&mut caller);
706 let (Some(pads), true) = (&host.input.gamepads, slot < 4) else { return Ok(-1) };
707 if cap as usize >= GAMEPAD_BYTES {
708 let b = gamepad_bytes(&pads[slot as usize]);
709 guest_slice_mut(data, dst, GAMEPAD_BYTES as u64)?.copy_from_slice(&b);
710 }
711 Ok(GAMEPAD_BYTES as i32)
712 },
713 )?;
714
715 linker.func_wrap(
716 "gasm",
717 "gamepad_name",
718 |mut caller: Caller<'_, Host>, slot: u32, dst: u32, cap: u32| -> wasmtime::Result<i32> {
719 let mem = memory(&caller)?;
720 let (data, host) = mem.data_and_store_mut(&mut caller);
721 let Some(g) = host.input.gamepads.as_ref().and_then(|p| p.get(slot as usize)).filter(|g| g.connected) else { return Ok(-1) };
722 copy_if_fits(data, dst, cap, g.name.as_bytes())
723 },
724 )?;
725
726 linker.func_wrap(
727 "gasm",
728 "param",
729 |mut caller: Caller<'_, Host>, ptr: u32, len: u32, dst: u32, cap: u32| -> wasmtime::Result<i32> {
730 let name = guest_str(&caller, ptr, len)?;
731 let mem = memory(&caller)?;
732 let (data, host) = mem.data_and_store_mut(&mut caller);
733 let Some(v) = host.params.get(&name) else { return Ok(-1) };
734 copy_if_fits(data, dst, cap, v.as_bytes())
735 },
736 )?;
737
738 fn read_asset(caller: &mut Caller<'_, Host>, ptr: u32, len: u32, offset: u64, dst: u32, cap: u32) -> wasmtime::Result<i32> {
741 let name = guest_str(caller, ptr, len)?;
742 let mem = memory(caller)?;
743 let (data, host) = mem.data_and_store_mut(caller);
744 let Some(asset) = host.assets.get(&name) else { return Ok(-1) };
745 let n = asset.size().saturating_sub(offset).min(cap as u64);
746 let out = guest_slice_mut(data, dst, n)?;
747 Ok(asset.read_at(offset, out) as i32)
748 }
749
750 linker.func_wrap(
751 "gasm",
752 "asset_read_at",
753 |mut caller: Caller<'_, Host>, ptr: u32, len: u32, offset: u32, dst: u32, cap: u32| -> wasmtime::Result<i32> {
754 read_asset(&mut caller, ptr, len, offset as u64, dst, cap)
755 },
756 )?;
757
758 linker.func_wrap(
759 "gasm",
760 "asset_read_at64",
761 |mut caller: Caller<'_, Host>, ptr: u32, len: u32, offset: u64, dst: u32, cap: u32| -> wasmtime::Result<i32> {
762 read_asset(&mut caller, ptr, len, offset, dst, cap)
763 },
764 )?;
765
766 linker.func_wrap(
767 "gasm",
768 "asset_read",
769 |mut caller: Caller<'_, Host>, ptr: u32, len: u32, dst: u32, cap: u32| -> wasmtime::Result<i32> {
770 read_asset(&mut caller, ptr, len, 0, dst, cap)
771 },
772 )?;
773
774 linker.func_wrap("gasm", "asset_count", |caller: Caller<'_, Host>| -> u32 { caller.data().assets.names().len() as u32 })?;
775
776 linker.func_wrap(
777 "gasm",
778 "asset_name",
779 |mut caller: Caller<'_, Host>, index: u32, dst: u32, cap: u32| -> wasmtime::Result<i32> {
780 let mem = memory(&caller)?;
781 let (data, host) = mem.data_and_store_mut(&mut caller);
782 let Some(n) = host.assets.names().get(index as usize) else { return Ok(-1) };
783 copy_if_fits(data, dst, cap, n.as_bytes())
784 },
785 )?;
786
787 linker.func_wrap(
788 "gasm",
789 "asset_size",
790 |caller: Caller<'_, Host>, ptr: u32, len: u32| -> wasmtime::Result<i32> {
791 let name = guest_str(&caller, ptr, len)?;
792 Ok(match caller.data().assets.size(&name) {
793 None => -1,
794 Some(n) if n > i32::MAX as u64 => -2,
795 Some(n) => n as i32,
796 })
797 },
798 )?;
799
800 linker.func_wrap(
801 "gasm",
802 "asset_size64",
803 |caller: Caller<'_, Host>, ptr: u32, len: u32| -> wasmtime::Result<i64> {
804 let name = guest_str(&caller, ptr, len)?;
805 Ok(caller.data().assets.size(&name).map_or(-1, |n| n as i64))
806 },
807 )?;
808
809 linker.func_wrap(
810 "gasm",
811 "asset_version",
812 |caller: Caller<'_, Host>, ptr: u32, len: u32| -> wasmtime::Result<i32> {
813 let name = guest_str(&caller, ptr, len)?;
814 Ok(caller.data().assets.version(&name).map_or(-1, |v| v.min(i32::MAX as u32) as i32))
815 },
816 )?;
817 Ok(())
818}
819
820fn trap(e: String) -> wasmtime::Error {
821 format_err!("{e}")
822}
823
824fn add_gfx_imports(linker: &mut Linker<Host>) -> wasmtime::Result<()> {
825 const M: &str = "gasm:gfx";
826 linker.func_wrap(M, "width", |c: Caller<'_, Host>| -> u32 { c.data().gfx.size().0 })?;
827 linker.func_wrap(M, "height", |c: Caller<'_, Host>| -> u32 { c.data().gfx.size().1 })?;
828 linker.func_wrap(M, "create_shader", |mut c: Caller<'_, Host>, ptr: u32, len: u32| -> wasmtime::Result<u32> {
829 let src = guest_str(&c, ptr, len)?;
830 c.data_mut().gfx.create_shader(&src).map_err(trap)
831 })?;
832 linker.func_wrap(M, "create_buffer", |mut c: Caller<'_, Host>, size: u32, usage: u32| -> wasmtime::Result<u32> {
833 c.data_mut().gfx.create_buffer(size, usage).map_err(trap)
834 })?;
835 linker.func_wrap(M, "create_pipeline", |mut c: Caller<'_, Host>, ptr: u32, len: u32| -> wasmtime::Result<u32> {
836 let json = guest_str(&c, ptr, len)?;
837 c.data_mut().gfx.create_pipeline(&json).map_err(trap)
838 })?;
839 linker.func_wrap(M, "create_bind_group", |mut c: Caller<'_, Host>, ptr: u32, len: u32| -> wasmtime::Result<u32> {
840 let json = guest_str(&c, ptr, len)?;
841 c.data_mut().gfx.create_bind_group(&json).map_err(trap)
842 })?;
843 linker.func_wrap(
844 M,
845 "write_buffer",
846 |mut c: Caller<'_, Host>, buf: u32, offset: u32, ptr: u32, len: u32| -> wasmtime::Result<()> {
847 let mem = memory(&c)?;
848 let (data, host) = mem.data_and_store_mut(&mut c);
849 let bytes = guest_slice(data, ptr, len as u64)?;
850 host.gfx.write_buffer(buf, offset, bytes).map_err(trap)?;
851 if host.hashing {
852 host.video_hash.update(bytes);
853 }
854 Ok(())
855 },
856 )?;
857 linker.func_wrap(M, "create_bind_group_layout", |mut c: Caller<'_, Host>, ptr: u32, len: u32| -> wasmtime::Result<u32> {
858 let json = guest_str(&c, ptr, len)?;
859 c.data_mut().gfx.create_bind_group_layout(&json).map_err(trap)
860 })?;
861 linker.func_wrap(M, "create_texture", |mut c: Caller<'_, Host>, ptr: u32, len: u32| -> wasmtime::Result<u32> {
862 let json = guest_str(&c, ptr, len)?;
863 c.data_mut().gfx.create_texture(&json).map_err(trap)
864 })?;
865 linker.func_wrap(M, "create_sampler", |mut c: Caller<'_, Host>, ptr: u32, len: u32| -> wasmtime::Result<u32> {
866 let json = guest_str(&c, ptr, len)?;
867 c.data_mut().gfx.create_sampler(&json).map_err(trap)
868 })?;
869 linker.func_wrap(
870 M,
871 "write_texture",
872 |mut c: Caller<'_, Host>, tex: u32, mip: u32, x: u32, y: u32, w: u32, h: u32, ptr: u32, len: u32| -> wasmtime::Result<()> {
873 let mem = memory(&c)?;
874 let (data, host) = mem.data_and_store_mut(&mut c);
875 let bytes = guest_slice(data, ptr, len as u64)?;
876 host.gfx.write_texture(tex, mip, x, y, w, h, bytes).map_err(trap)?;
877 if host.hashing {
878 for v in [tex, mip, x, y, w, h] {
880 host.video_hash.update(&v.to_le_bytes());
881 }
882 host.video_hash.update(bytes);
883 }
884 Ok(())
885 },
886 )?;
887 linker.func_wrap(M, "begin_frame", |mut c: Caller<'_, Host>, r: f32, g: f32, b: f32, a: f32| -> wasmtime::Result<u32> {
888 let h = c.data_mut();
889 let show = h.show_frame;
890 h.gfx.begin_frame([r, g, b, a], show).map(u32::from).map_err(trap)
891 })?;
892 linker.func_wrap(M, "set_pipeline", |mut c: Caller<'_, Host>, p: u32| -> wasmtime::Result<()> {
893 c.data_mut().gfx.set_pipeline(p).map_err(trap)
894 })?;
895 linker.func_wrap(M, "set_bind_group", |mut c: Caller<'_, Host>, i: u32, bg: u32| -> wasmtime::Result<()> {
896 c.data_mut().gfx.set_bind_group(i, bg).map_err(trap)
897 })?;
898 linker.func_wrap(
899 M,
900 "set_bind_group_offsets",
901 |mut c: Caller<'_, Host>, i: u32, bg: u32, ptr: u32, count: u32| -> wasmtime::Result<()> {
902 let mem = memory(&c)?;
903 let (data, host) = mem.data_and_store_mut(&mut c);
904 let bytes = guest_slice(data, ptr, count as u64 * 4)?;
905 let mut offsets = [0u32; 32];
906 if count as usize > offsets.len() {
907 bail!("gfx.set_bind_group_offsets: {count} offsets (a bind group has at most {})", offsets.len());
908 }
909 for (o, b) in offsets.iter_mut().zip(bytes.chunks_exact(4)) {
910 *o = u32::from_le_bytes([b[0], b[1], b[2], b[3]]);
911 }
912 host.gfx.set_bind_group_offsets(i, bg, &offsets[..count as usize]).map_err(trap)
913 },
914 )?;
915 linker.func_wrap(
916 M,
917 "set_viewport",
918 |mut c: Caller<'_, Host>, x: f32, y: f32, w: f32, h: f32, min: f32, max: f32| -> wasmtime::Result<()> {
919 c.data_mut().gfx.set_viewport(x, y, w, h, min, max).map_err(trap)
920 },
921 )?;
922 linker.func_wrap(M, "set_scissor_rect", |mut c: Caller<'_, Host>, x: u32, y: u32, w: u32, h: u32| -> wasmtime::Result<()> {
923 c.data_mut().gfx.set_scissor_rect(x, y, w, h).map_err(trap)
924 })?;
925 linker.func_wrap(M, "set_vertex_buffer", |mut c: Caller<'_, Host>, slot: u32, b: u32, off: u32| -> wasmtime::Result<()> {
926 c.data_mut().gfx.set_vertex_buffer(slot, b, off).map_err(trap)
927 })?;
928 linker.func_wrap(M, "set_index_buffer", |mut c: Caller<'_, Host>, b: u32, fmt: u32, off: u32| -> wasmtime::Result<()> {
929 c.data_mut().gfx.set_index_buffer(b, fmt, off).map_err(trap)
930 })?;
931 linker.func_wrap(M, "draw", |mut c: Caller<'_, Host>, vc: u32, ic: u32, fv: u32, fi: u32| -> wasmtime::Result<()> {
932 c.data_mut().gfx.draw(vc, ic, fv, fi).map_err(trap)
933 })?;
934 linker.func_wrap(M, "draw_indexed", |mut c: Caller<'_, Host>, ic: u32, n: u32, first: u32, base: i32, fi: u32| -> wasmtime::Result<()> {
935 c.data_mut().gfx.draw_indexed(ic, n, first, base, fi).map_err(trap)
936 })?;
937 linker.func_wrap(M, "end_frame", |mut c: Caller<'_, Host>| -> wasmtime::Result<()> {
938 let h = c.data_mut();
939 h.frames_presented += 1;
940 h.gfx.end_frame().map_err(trap)
941 })?;
942 linker.func_wrap(M, "destroy", |mut c: Caller<'_, Host>, handle: u32| -> wasmtime::Result<()> {
943 c.data_mut().gfx.destroy(handle).map_err(trap)
944 })?;
945 Ok(())
946}
947
948fn add_net_imports(linker: &mut Linker<Host>) -> wasmtime::Result<()> {
949 const M: &str = "gasm:net";
950 linker.func_wrap(M, "open", |mut c: Caller<'_, Host>, ptr: u32, len: u32| -> wasmtime::Result<i32> {
951 let url = guest_str(&c, ptr, len)?;
952 Ok(c.data_mut().net.open(&url))
953 })?;
954 linker.func_wrap(M, "state", |c: Caller<'_, Host>, h: i32| -> wasmtime::Result<u32> { c.data().net.state(h).map_err(trap) })?;
955 linker.func_wrap(M, "send", |mut c: Caller<'_, Host>, h: i32, ptr: u32, len: u32| -> wasmtime::Result<i32> {
956 let mem = memory(&c)?;
957 let msg = guest_slice(mem.data(&c), ptr, len as u64)?.to_vec();
958 if msg.is_empty() {
959 c.data().net.state(h).map_err(trap)?; return Ok(-1);
961 }
962 c.data_mut().net.send(h, msg).map_err(trap)
963 })?;
964 linker.func_wrap(M, "recv", |mut c: Caller<'_, Host>, h: i32, dst: u32, cap: u32| -> wasmtime::Result<i32> {
965 let mem = memory(&c)?;
966 let (data, host) = mem.data_and_store_mut(&mut c);
967 let msg = match host.net.peek(h).map_err(trap)? {
968 Ok(m) => m,
969 Err(code) => return Ok(code),
970 };
971 let n = copy_if_fits(data, dst, cap, msg)?;
972 if n as usize <= cap as usize {
973 host.net.pop(h);
974 }
975 Ok(n)
976 })?;
977 linker.func_wrap(M, "close", |mut c: Caller<'_, Host>, h: i32| -> wasmtime::Result<()> { c.data_mut().net.close(h).map_err(trap) })?;
978 Ok(())
979}
980
981fn add_fetch_imports(linker: &mut Linker<Host>) -> wasmtime::Result<()> {
982 const M: &str = "gasm:fetch";
983 linker.func_wrap(M, "request", |mut c: Caller<'_, Host>, dp: u32, dl: u32, bp: u32, bl: u32| -> wasmtime::Result<i32> {
984 let desc = guest_str(&c, dp, dl)?;
985 let mem = memory(&c)?;
986 let body = guest_slice(mem.data(&c), bp, bl as u64)?.to_vec();
987 let h = c.data_mut();
988 let frame = h.frame_index;
989 Ok(h.fetch.request(&desc, body, frame))
990 })?;
991 linker.func_wrap(M, "state", |mut c: Caller<'_, Host>, r: i32| -> wasmtime::Result<u32> {
992 let h = c.data_mut();
993 let frame = h.frame_index;
994 h.fetch.state(r, frame).map_err(trap)
995 })?;
996 linker.func_wrap(M, "status", |mut c: Caller<'_, Host>, r: i32| -> wasmtime::Result<i32> {
997 let h = c.data_mut();
998 let frame = h.frame_index;
999 h.fetch.status(r, frame).map_err(trap)
1000 })?;
1001 linker.func_wrap(M, "headers", |mut c: Caller<'_, Host>, r: i32, dst: u32, cap: u32| -> wasmtime::Result<i32> {
1002 let mem = memory(&c)?;
1003 let (data, host) = mem.data_and_store_mut(&mut c);
1004 let frame = host.frame_index;
1005 match host.fetch.headers(r, frame).map_err(trap)? {
1006 Some(text) => copy_if_fits(data, dst, cap, text.as_bytes()),
1007 None => Ok(-1),
1008 }
1009 })?;
1010 linker.func_wrap(M, "read", |mut c: Caller<'_, Host>, r: i32, dst: u32, cap: u32| -> wasmtime::Result<i32> {
1011 let mem = memory(&c)?;
1012 guest_slice(mem.data(&c), dst, cap as u64)?; let (data, host) = mem.data_and_store_mut(&mut c);
1014 let frame = host.frame_index;
1015 match host.fetch.read(r, (cap as usize).min(i32::MAX as usize), frame).map_err(trap)? {
1016 Ok(bytes) => {
1017 guest_slice_mut(data, dst, bytes.len() as u64)?.copy_from_slice(&bytes);
1018 Ok(bytes.len() as i32)
1019 }
1020 Err(()) => Ok(-1),
1021 }
1022 })?;
1023 linker.func_wrap(M, "close", |mut c: Caller<'_, Host>, r: i32| -> wasmtime::Result<()> { c.data_mut().fetch.close(r).map_err(trap) })?;
1024 Ok(())
1025}
1026
1027fn add_all_imports(linker: &mut Linker<Host>, switching: bool) -> wasmtime::Result<()> {
1029 add_gasm_imports(linker)?;
1030 if switching {
1031 switching::add_yield_async(linker)?;
1032 } else {
1033 switching::add_yield_sync(linker)?;
1034 }
1035 add_gfx_imports(linker)?;
1036 crate::gl::add_gl_imports(linker)?;
1037 add_net_imports(linker)?;
1038 add_fetch_imports(linker)?;
1039 add_storage_imports(linker)?;
1040 add_clipboard_imports(linker)?;
1041 add_files_imports(linker)?;
1042 Ok(())
1043}
1044
1045fn provided_by(linker: &Linker<Host>, store: &mut Store<Host>) -> HashSet<String> {
1047 let mut provided = HashSet::new();
1048 for (m, f, _) in linker.iter(&mut *store) {
1049 provided.insert(m.to_owned());
1050 provided.insert(format!("{m}.{f}"));
1051 }
1052 for f in wasi::IMPLEMENTED {
1053 provided.insert(format!("{}.{f}", wasi::MODULE));
1054 }
1055 provided.insert(wasi::MODULE.to_owned());
1056 provided
1057}
1058
1059pub fn provided() -> HashSet<String> {
1061 let mut linker: Linker<Host> = Linker::new(engine());
1062 if add_all_imports(&mut linker, false).is_err() {
1063 return HashSet::new();
1064 }
1065 let host = Host::new(crate::assets::Assets::new(), HashMap::new(), None, crate::gfx::Gfx::null(), Net::new(false), crate::storage::Storage::memory());
1066 let mut store = Store::new(engine(), host);
1067 provided_by(&linker, &mut store)
1068}
1069
1070fn add_clipboard_imports(linker: &mut Linker<Host>) -> wasmtime::Result<()> {
1071 const M: &str = "gasm:clipboard";
1072 linker.func_wrap(M, "set_text", |mut c: Caller<'_, Host>, ptr: u32, len: u32| -> wasmtime::Result<i32> {
1073 if len as usize > CLIPBOARD_MAX {
1074 return Ok(-1);
1075 }
1076 let text = guest_str(&c, ptr, len)?;
1077 c.data_mut().clipboard.copied = Some(text);
1078 Ok(0)
1079 })?;
1080 linker.func_wrap(M, "get_text", |mut c: Caller<'_, Host>, dst: u32, cap: u32| -> wasmtime::Result<i32> {
1081 let mem = memory(&c)?;
1082 let (data, host) = mem.data_and_store_mut(&mut c);
1083 match &host.clipboard.pasted {
1084 Some(t) => copy_if_fits(data, dst, cap, t.as_bytes()),
1085 None => Ok(-1),
1086 }
1087 })?;
1088 Ok(())
1089}
1090
1091fn add_files_imports(linker: &mut Linker<Host>) -> wasmtime::Result<()> {
1092 const M: &str = "gasm:files";
1093 linker.func_wrap(M, "save", |mut c: Caller<'_, Host>, np: u32, nl: u32, mp: u32, ml: u32, ptr: u32, len: u32| -> wasmtime::Result<i32> {
1094 let (name, mime) = (guest_str(&c, np, nl)?, guest_str(&c, mp, ml)?);
1095 let mem = memory(&c)?;
1096 let (data, host) = mem.data_and_store_mut(&mut c);
1097 let bytes = guest_slice(data, ptr, len as u64)?;
1098 Ok(host.files.save(&name, &mime, bytes))
1099 })?;
1100 linker.func_wrap(M, "state", |c: Caller<'_, Host>, handle: i32| -> wasmtime::Result<i32> {
1101 c.data().files.state(handle).ok_or_else(|| format_err!("gasm:files: invalid handle {handle}"))
1102 })?;
1103 Ok(())
1104}
1105
1106fn add_storage_imports(linker: &mut Linker<Host>) -> wasmtime::Result<()> {
1107 const M: &str = "gasm:storage";
1108 linker.func_wrap(M, "get", |mut c: Caller<'_, Host>, kp: u32, kl: u32, dst: u32, cap: u32| -> wasmtime::Result<i32> {
1109 let key = guest_str(&c, kp, kl)?;
1110 let mem = memory(&c)?;
1111 let (data, host) = mem.data_and_store_mut(&mut c);
1112 let Some(v) = host.storage.get(&key) else { return Ok(-1) };
1113 copy_if_fits(data, dst, cap, v)
1114 })?;
1115 linker.func_wrap(M, "set", |mut c: Caller<'_, Host>, kp: u32, kl: u32, vp: u32, vl: u32| -> wasmtime::Result<i32> {
1116 let key = guest_str(&c, kp, kl)?;
1117 let mem = memory(&c)?;
1118 let (data, host) = mem.data_and_store_mut(&mut c);
1119 let value = guest_slice(data, vp, vl as u64)?;
1120 Ok(match host.storage.set(&key, value) {
1121 Ok(()) => 0,
1122 Err(e) => {
1123 eprintln!("[gasm] storage: {key}: {e}");
1124 e.code()
1125 }
1126 })
1127 })?;
1128 linker.func_wrap(M, "count", |mut c: Caller<'_, Host>| -> u32 { c.data_mut().storage.keys().len() as u32 })?;
1129 linker.func_wrap(M, "key", |mut c: Caller<'_, Host>, index: u32, dst: u32, cap: u32| -> wasmtime::Result<i32> {
1130 let mem = memory(&c)?;
1131 let (data, host) = mem.data_and_store_mut(&mut c);
1132 let Some(k) = host.storage.keys().get(index as usize) else { return Ok(-1) };
1133 copy_if_fits(data, dst, cap, k.as_bytes())
1134 })?;
1135 linker.func_wrap(M, "delete", |mut c: Caller<'_, Host>, kp: u32, kl: u32| -> wasmtime::Result<i32> {
1136 let key = guest_str(&c, kp, kl)?;
1137 Ok(if c.data_mut().storage.delete(&key) { 0 } else { -1 })
1138 })?;
1139 Ok(())
1140}
1141
1142#[derive(Debug)]
1144pub enum Stop {
1145 Exit(i32),
1147 Trap(String),
1148}
1149
1150impl std::fmt::Display for Stop {
1151 fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
1152 match self {
1153 Stop::Exit(code) => write!(f, "guest exited with code {code}"),
1154 Stop::Trap(msg) => write!(f, "guest trapped: {msg}"),
1155 }
1156 }
1157}
1158
1159impl std::error::Error for Stop {}
1160
1161fn classify(e: wasmtime::Error) -> Stop {
1162 if let Some(exit) = e.downcast_ref::<wasi::Exit>() {
1163 return Stop::Exit(exit.0);
1164 }
1165 if e.downcast_ref::<switching::Quit>().is_some() {
1166 return Stop::Exit(0);
1167 }
1168 if e.downcast_ref::<wasmtime::Trap>() == Some(&wasmtime::Trap::Interrupt) {
1169 return Stop::Trap(format!("a guest call ran longer than the time limit (stuck in a loop?); see --call-timeout\n{e:?}"));
1170 }
1171 Stop::Trap(format!("{e:?}"))
1172}
1173
1174const TICKS_PER_SEC: u64 = 10;
1176
1177pub fn engine() -> &'static Engine {
1182 static ENGINE: OnceLock<Engine> = OnceLock::new();
1183 ENGINE.get_or_init(new_engine)
1184}
1185
1186fn new_engine() -> Engine {
1187 let mut config = Config::new();
1188 config.epoch_interruption(true);
1189 config.async_stack_size(4 << 20);
1191 let engine = Engine::new(&config).expect("wasmtime engine");
1192 let ticker = engine.clone();
1193 std::thread::Builder::new()
1194 .name("gasm-epoch".into())
1195 .spawn(move || {
1196 loop {
1197 std::thread::sleep(Duration::from_millis(1000 / TICKS_PER_SEC));
1198 ticker.increment_epoch();
1199 }
1200 })
1201 .expect("epoch thread");
1202 engine
1203}
1204
1205pub fn precompile(wasm: &[u8]) -> wasmtime::Result<Vec<u8>> {
1207 engine().precompile_module(wasm)
1208}
1209
1210#[derive(Clone, Copy)]
1212pub struct LoadOptions {
1213 pub allow_precompiled: bool,
1216 pub call_timeout: Option<Duration>,
1218 pub stack_switching: bool,
1221 pub memory_limit: Option<usize>,
1223}
1224
1225impl Default for LoadOptions {
1226 fn default() -> Self {
1227 LoadOptions { allow_precompiled: false, call_timeout: Some(Duration::from_secs(30)), stack_switching: true, memory_limit: Some(DEFAULT_MEMORY_LIMIT) }
1228 }
1229}
1230
1231type Running = Pin<Box<dyn Future<Output = (Store<Host>, wasmtime::Result<i32>)>>>;
1233
1234pub struct Game {
1238 store: Option<Store<Host>>,
1240 frame: TypedFunc<(), ()>,
1241 exit: Option<TypedFunc<(), ()>>,
1242 deadline: u64,
1243 run: Option<TypedFunc<(), i32>>,
1245 running: Option<Running>,
1246 exchange: Option<Arc<Exchange>>,
1247 ended: bool,
1249 gl: bool,
1251 watches: Vec<crate::assets::AssetWatch>,
1253}
1254
1255impl Game {
1256 pub fn load(wasm: &[u8], host: Host, opts: LoadOptions) -> Result<Game, Stop> {
1257 let module = Self::compile(wasm, opts.allow_precompiled)?;
1258 Self::load_module(module, host, opts)
1259 }
1260
1261 pub fn compile(wasm: &[u8], allow_precompiled: bool) -> Result<Module, Stop> {
1264 let module = if wasm.starts_with(b"\0asm") {
1265 Module::new(engine(), wasm)
1266 } else if allow_precompiled {
1267 unsafe { Module::deserialize(engine(), wasm) }
1270 } else {
1271 Err(format_err!("not a wasm module (a precompiled .cwasm runs as native code: pass --allow-precompiled if you made it yourself)"))
1272 };
1273 module.map_err(classify)
1274 }
1275
1276 pub fn load_module(module: Module, host: Host, opts: LoadOptions) -> Result<Game, Stop> {
1278 Self::load_inner(module, host, opts).map_err(classify)
1279 }
1280
1281 fn load_inner(module: Module, host: Host, opts: LoadOptions) -> wasmtime::Result<Game> {
1282 let gl = module.imports().any(|i| i.module() == "gasm:gl");
1283 if gl && module.imports().any(|i| i.module() == "gasm:gfx") {
1284 bail!("a module imports gasm:gfx or gasm:gl, not both");
1285 }
1286 let has_run = module.get_export("gasm_run").is_some();
1288 let switching = has_run && opts.stack_switching;
1289 if has_run && !switching && module.imports().any(|i| i.module() == "asyncify") {
1290 bail!("this module is a run build (no Asyncify): it needs stack switching (gasm_run); use the game's Asyncify build");
1292 }
1293 let engine = engine();
1294 let mut linker: Linker<Host> = Linker::new(engine);
1295 add_all_imports(&mut linker, switching)?;
1296 let mut store = Store::new(engine, host);
1297 store.data_mut().memory_limit = MemoryLimit(opts.memory_limit);
1298 store.limiter(|h| &mut h.memory_limit);
1299 let provided = provided_by(&linker, &mut store);
1300 let missing: Vec<&String> = store.data().requires.iter().filter(|r| !provided.contains(r.as_str())).collect();
1302 if !missing.is_empty() {
1303 bail!("this game needs {}, which this runner (gasm-run {}) doesn't have", missing.iter().map(|s| s.as_str()).collect::<Vec<_>>().join(", "), env!("CARGO_PKG_VERSION"));
1304 }
1305 store.data_mut().provided = provided;
1306 wasi::add_to_linker(&mut linker, &module)?;
1307 linker.define_unknown_imports_as_traps(&module)?;
1310
1311 let deadline = opts.call_timeout.map_or(u64::MAX / 2, |t| (t.as_millis() as u64 * TICKS_PER_SEC).div_ceil(1000).max(1));
1312 store.epoch_deadline_trap();
1313 store.set_epoch_deadline(deadline);
1314 let exchange = switching.then(|| Exchange::new(deadline));
1315 store.data_mut().run = exchange.clone();
1316 let instance: Instance = if switching {
1317 switching::block_on(linker.instantiate_async(&mut store, &module))??
1318 } else {
1319 linker.instantiate(&mut store, &module)?
1320 };
1321 let memory = instance
1322 .get_memory(&mut store, "memory")
1323 .ok_or_else(|| format_err!("guest does not export `memory`"))?;
1324 store.data_mut().memory = Some(memory);
1325
1326 fn call<R: wasmtime::WasmResults + Send + Sync>(store: &mut Store<Host>, f: TypedFunc<(), R>, switching: bool) -> wasmtime::Result<R> {
1328 if switching { switching::block_on(f.call_async(store, ()))? } else { f.call(store, ()) }
1329 }
1330 if let Ok(init) = instance.get_typed_func::<(), ()>(&mut store, "_initialize") {
1331 store.set_epoch_deadline(deadline);
1332 call(&mut store, init, switching)?;
1333 }
1334 let version = instance.get_typed_func::<(), i32>(&mut store, "gasm_abi_version")?;
1335 let version = call(&mut store, version, switching)?;
1336 if version != ABI_VERSION {
1337 bail!("guest targets gasm ABI v{version}, runner implements v{ABI_VERSION}");
1338 }
1339 store.set_epoch_deadline(deadline);
1340 let init = instance.get_typed_func::<(), i32>(&mut store, "gasm_init")?;
1341 let rc = call(&mut store, init, switching)?;
1342 if rc != 0 {
1343 bail!("gasm_init failed with code {rc}");
1344 }
1345 let frame = instance.get_typed_func::<(), ()>(&mut store, "gasm_frame")?;
1346 let exit = instance.get_typed_func::<(), ()>(&mut store, "gasm_exit").ok();
1347 let run = if switching { Some(instance.get_typed_func::<(), i32>(&mut store, "gasm_run")?) } else { None };
1348 Ok(Game { store: Some(store), frame, exit, deadline, run, running: None, exchange, ended: false, gl, watches: Vec::new() })
1349 }
1350
1351 pub fn set_asset(&mut self, name: &str, bytes: Vec<u8>) -> u32 {
1354 self.with_host(|h| h.assets.set(name, bytes))
1355 }
1356
1357 pub fn remove_asset(&mut self, name: &str) -> bool {
1359 self.with_host(|h| h.assets.remove(name))
1360 }
1361
1362 pub fn watch_asset(&mut self, name: &str, path: &std::path::Path) {
1365 self.add_watch(crate::assets::AssetWatch::new(name, path));
1366 }
1367
1368 pub fn add_watch(&mut self, watch: crate::assets::AssetWatch) {
1370 self.watches.push(watch);
1371 }
1372
1373 pub fn uses_gl(&self) -> bool {
1375 self.gl
1376 }
1377
1378 pub fn switching(&self) -> bool {
1380 self.run.is_some()
1381 }
1382
1383 pub fn frame(&mut self) -> Result<(), Stop> {
1385 if self.ended {
1386 return Err(Stop::Trap("the guest is not running".into()));
1387 }
1388 self.with_host(|h| h.files.flush());
1390 if !self.watches.is_empty() {
1391 let mut watches = std::mem::take(&mut self.watches);
1392 self.with_host(|h| watches.iter_mut().for_each(|w| _ = w.poll(&mut h.assets)));
1393 self.watches = watches;
1394 }
1395 let Some(run) = self.run.clone() else {
1396 let store = self.store.as_mut().expect("store");
1397 store.set_epoch_deadline(self.deadline);
1398 let r = self.frame.call(&mut *store, ()).map_err(classify);
1399 store.data_mut().frame_index += 1;
1400 self.ended = r.is_err();
1401 return r;
1402 };
1403 match &self.exchange {
1404 Some(ex) if self.running.is_some() => ex.set(Cmd::Resume),
1405 _ => {
1406 let mut store = self.store.take().expect("store");
1408 store.set_epoch_deadline(self.deadline);
1409 self.running = Some(Box::pin(async move {
1410 let r = run.call_async(&mut store, ()).await;
1411 (store, r)
1412 }));
1413 }
1414 }
1415 self.poll()
1416 }
1417
1418 fn poll(&mut self) -> Result<(), Stop> {
1420 let Some(running) = self.running.as_mut() else { return Ok(()) };
1421 match switching::poll_once(running.as_mut()) {
1422 Poll::Pending => Ok(()),
1423 Poll::Ready((store, r)) => {
1424 self.store = Some(store);
1425 self.running = None;
1426 self.ended = true;
1427 Err(match r {
1428 Ok(code) => Stop::Exit(code),
1429 Err(e) => classify(e),
1430 })
1431 }
1432 }
1433 }
1434
1435 pub fn exit(&mut self) {
1438 if self.store.is_some() || self.running.is_some() {
1439 self.with_host(|h| h.files.flush());
1440 }
1441 if self.running.is_some() {
1442 if let Some(ex) = &self.exchange {
1443 ex.set(Cmd::Exit);
1444 }
1445 if let Err(Stop::Trap(t)) = self.poll() {
1446 eprintln!("[gasm] gasm_exit trapped: {t}");
1447 }
1448 if self.running.is_some() {
1449 self.running = None;
1451 }
1452 self.exit = None;
1453 return;
1454 }
1455 if let (Some(f), Some(store)) = (self.exit.take(), self.store.as_mut()) {
1456 store.set_epoch_deadline(self.deadline);
1457 let r = if self.run.is_some() { switching::block_on(f.call_async(&mut *store, ())).and_then(|r| r) } else { f.call(&mut *store, ()) };
1458 if let Err(e) = r {
1459 if let Stop::Trap(t) = classify(e) {
1460 eprintln!("[gasm] gasm_exit trapped: {t}");
1461 }
1462 }
1463 store.data_mut().files.flush(); }
1465 }
1466
1467 pub fn with_host<R>(&mut self, f: impl FnOnce(&mut Host) -> R) -> R {
1471 if let Some(store) = &mut self.store {
1472 return f(store.data_mut());
1473 }
1474 let (Some(running), Some(ex)) = (self.running.as_mut(), &self.exchange) else {
1475 panic!("with_host: the guest's store is gone (gasm_exit yielded)");
1476 };
1477 let mut f = Some(f);
1478 let mut out = None;
1479 let mut job = |h: &mut Host| out = Some((f.take().expect("job runs once"))(h));
1480 let ptr: *mut (dyn FnMut(&mut Host) + '_) = &mut job;
1481 let ptr: *mut (dyn FnMut(&mut Host) + 'static) = unsafe { std::mem::transmute(ptr) };
1484 ex.set(Cmd::Job(Job(ptr)));
1485 let polled = switching::poll_once(running.as_mut());
1486 ex.set(Cmd::None);
1487 match polled {
1488 Poll::Pending => {}
1489 Poll::Ready(_) => unreachable!("yield_frame stays suspended after a job"),
1490 }
1491 out.expect("yield_frame ran the job")
1492 }
1493
1494 pub fn host(&self) -> &Host {
1498 self.store.as_ref().expect("Game::host: a gasm_run guest is running; use Game::with_host").data()
1499 }
1500
1501 pub fn host_mut(&mut self) -> &mut Host {
1502 self.store.as_mut().expect("Game::host_mut: a gasm_run guest is running; use Game::with_host").data_mut()
1503 }
1504}
1505
1506#[cfg(test)]
1507mod tests {
1508 use super::*;
1509
1510 #[test]
1511 fn titles_are_cleaned_and_cut() {
1512 assert_eq!(clean_title("A\u{7}B\u{202e}C\u{2069}").as_deref(), Some("ABC"));
1513 assert_eq!(clean_title("\n\t"), None);
1514 assert_eq!(clean_title(&"é".repeat(200)).map(|t| t.len()), Some(256));
1516 }
1517
1518 const RUN_GUEST: &str = r#"(module
1519 (import "gasm" "yield_frame" (func $yield))
1520 (memory (export "memory") 1)
1521 (global $n (mut i32) (i32.const 0))
1522 (func (export "gasm_abi_version") (result i32) i32.const 0)
1523 (func (export "gasm_init") (result i32) i32.const 0)
1524 (func (export "gasm_frame") call $yield)
1525 (func (export "gasm_exit") (global.set $n (i32.const 100)))
1526 (func (export "frames") (result i32) global.get $n)
1527 (func (export "gasm_run") (result i32)
1528 (loop $l
1529 (global.set $n (i32.add (global.get $n) (i32.const 1)))
1530 call $yield
1531 (br_if $l (i32.lt_u (global.get $n) (i32.const 3))))
1532 i32.const 7))"#;
1533
1534 fn host() -> Host {
1535 Host::new(Assets::new(), HashMap::new(), None, Gfx::null(), Net::new(false), Storage::memory())
1536 }
1537
1538 #[test]
1539 fn gasm_run_guests_suspend_between_frames() {
1540 let mut g = Game::load(&wat::parse_str(RUN_GUEST).unwrap(), host(), LoadOptions::default()).unwrap();
1541 assert!(g.switching());
1542 g.with_host(|h| h.frame_rate = 30.0); assert!(g.frame().is_ok()); assert_eq!(g.with_host(|h| h.frame_rate), 30.0);
1546 assert!(g.frame().is_ok()); assert!(g.frame().is_ok()); assert!(matches!(g.frame(), Err(Stop::Exit(7))));
1550 assert!(g.frame().is_err(), "never called again");
1551 }
1552
1553 #[test]
1554 fn exit_runs_on_top_of_a_suspended_run() {
1555 let mut g = Game::load(&wat::parse_str(RUN_GUEST).unwrap(), host(), LoadOptions::default()).unwrap();
1556 g.frame().unwrap();
1557 g.exit();
1558 assert!(g.store.is_some());
1560 }
1561
1562 #[test]
1563 fn yield_frame_outside_gasm_run_traps() {
1564 let opts = LoadOptions { stack_switching: false, ..LoadOptions::default() };
1565 let mut g = Game::load(&wat::parse_str(RUN_GUEST).unwrap(), host(), opts).unwrap();
1566 assert!(!g.switching());
1567 match g.frame() {
1568 Err(Stop::Trap(t)) => assert!(t.contains("only inside gasm_run"), "{t}"),
1569 other => panic!("expected a trap, got {:?}", other.err()),
1570 }
1571 }
1572
1573 #[test]
1574 fn custom_sections_are_found() {
1575 let mut wasm = b"\0asm\x01\0\0\0\x01\x01\0".to_vec();
1577 wasm.extend_from_slice(&[0, 14, 10]);
1578 wasm.extend_from_slice(b"gasm.titleHi\0");
1579 assert_eq!(custom_section(&wasm, "gasm.title"), Some(&b"Hi\0"[..]));
1580 assert_eq!(static_title(&wasm).as_deref(), Some("Hi"));
1581 assert_eq!(custom_section(&wasm, "other"), None);
1582 assert_eq!(custom_section(&wasm[..wasm.len() - 2], "gasm.title"), None); assert_eq!(custom_section(b"not wasm", "gasm.title"), None);
1584 }
1585}