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