myriad-rs 0.2.0

VM runtime for Polka bytecode, computation core.
Documentation
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
#![no_std]

#[macro_use]
extern crate alloc;

use alloc::{boxed::Box, string::{String, ToString}, vec::Vec};

pub mod value;
pub mod frame;
pub mod memory;
pub mod devices;
pub mod interpreter;
pub mod loader;
pub mod region;
pub mod builtins;
pub mod debug;
pub mod host;
pub mod snapshot;
pub mod aot;

pub use polka::{Value, HANDLE_NONE};
pub use polka::cartridge::read_pk;
pub use value::{alloc_string, read_string};
pub use devices::{Device, DeviceTable};
pub use memory::Heap;
pub use region::RegionTable;
pub use builtins::{NativeCtx, NativeFn, NativeRegistry};
pub use debug::{render_fn_label, DebugEvent, DebugSink};
pub use host::Host;
pub use aot::{AotHost, AotNatives, reachable_live_count};

use frame::Frame;

pub type AotFn = alloc::rc::Rc<dyn for<'a> Fn(&mut NativeCtx<'a>, &[Value], &[bool]) -> Result<(Value, bool), String>>;

pub fn run(module: polka::Module, host: Host) -> Result<i64, String> {
    let loaded = loader::load(module)?;
    let mut vm = VirtualMachine::new();
    host.install_into(&mut vm);
    let v = vm.run_module(&loaded.module)?;
    Ok(v.as_int())
}

pub struct VirtualMachine {
    pub(crate) registers: Vec<u64>,
    // Bit i (LSB of word i/64) = 1 iff registers[i] is a handle.
    pub(crate) register_mask: Vec<u64>,
    pub(crate) frames: Vec<Frame>,
    pub(crate) pc: usize,
    pub(crate) base_reg: usize,
    pub(crate) current_func: usize,
    pub(crate) heap: Heap,
    pub(crate) handlers: Vec<HandlerFrame>,
    pub(crate) halted: bool,
    pub(crate) exit_code: Option<i64>,
    pub(crate) dispatch_last_result: Option<u16>,
    pub(crate) dispatch_last_env: Option<(u64, bool)>,
    pub(crate) devices: DeviceTable,
    // Constants resolved per-fn at module load. Value bits + parallel mask.
    pub(crate) resolved_constants: Vec<Vec<u64>>,
    pub(crate) resolved_const_mask: Vec<Vec<u64>>,
    // Permanent heap handles for string constants; rc=1 module-lifetime.
    pub(crate) string_const_handles: Vec<(u32, u32)>,
    pub(crate) resolved_natives: Vec<Option<NativeFn>>,
    pub(crate) aot_fns: alloc::collections::BTreeMap<alloc::string::String, AotFn>,
    pub(crate) resolved_aot: Vec<Option<AotFn>>,
    pub(crate) region_table: RegionTable,
    pub(crate) natives: NativeRegistry,
    pub(crate) debug_sink: Option<DebugSink>,
    pub(crate) trace_filter: Option<Vec<bool>>,
    pub(crate) trace_frames: bool,
    pub(crate) fn_names: Vec<String>,
    pub(crate) failing_pc: usize,
    pub(crate) last_result_is_handle: bool,
    pub(crate) int32_safe: bool,
    pub(crate) module_table_raw: u64,
    pub(crate) module_table_is_handle: bool,
    pub(crate) steps: u64,
    pub(crate) step_cap: u64,
    pub(crate) static_names: Vec<String>,
    pub(crate) trace_static_filter: Option<String>,
    pub(crate) heap_check: bool,
    pub(crate) profile: bool,
    pub(crate) prof_ops: hashbrown::HashMap<&'static str, u64>,
    pub(crate) prof_fns: hashbrown::HashMap<usize, u64>,
    pub(crate) prof_fn_ops: hashbrown::HashMap<usize, hashbrown::HashMap<&'static str, u64>>,
    pub(crate) yielded: bool,
    pub(crate) yield_dest_abs: usize,
    // Text-diagnostic sink for frame/static traces. None = silent (no_std default).
    pub(crate) trace_out: Option<fn(&str)>,
}

pub struct HandlerFrame {
    pub effect_id: u16,
    pub dispatch_table_slot: Option<u32>,
    pub dispatch_table_gen: u32,
    pub cell_slot: u32,
    pub cell_gen: u32,
    pub cells_allocated: Vec<(u32, u32)>,
    pub body_frame_index: Option<usize>,
    pub pending_return_arm_fn: Option<usize>,
    pub pending_return_arm_env: u64,
    pub pending_return_arm_env_is_handle: bool,
}

impl HandlerFrame {
    pub fn release_cells(
        &self,
        heap: &mut crate::memory::Heap,
        regions: &mut crate::region::RegionTable,
    ) -> Result<(), String> {
        for (slot, generation) in &self.cells_allocated {
            regions.forget(*slot, *generation);
            if heap.is_live(*slot, *generation) {
                heap.rc_dec(*slot, *generation)?;
            }
        }
        Ok(())
    }
}

pub mod cont_slot {
    pub const SUSPEND_PC: usize = 0;
    pub const SUSPEND_BASE: usize = 1;
    pub const DEST_REG: usize = 2;
    pub const ALIVE: usize = 3;
    pub const SUSPEND_FUNC: usize = 4;
    pub const DISPATCH_FN_ID: usize = 5;
    pub const DISPATCH_ENV: usize = 6;
    pub const REGS_SNAPSHOT_SLOT: usize = 7;
    pub const REGS_COUNT: usize = 8;
    pub const SIZE: usize = 9;

    // Bits set = the slot holds a handle when written by do_yield.
    pub const INIT_MASK_WORD0: u64 =
        (1u64 << DISPATCH_ENV) | (1u64 << REGS_SNAPSHOT_SLOT);
}

impl VirtualMachine {
    pub fn new() -> Self {
        let mut natives = NativeRegistry::new();
        builtins::register_default_builtins(&mut natives);
        Self {
            registers: Vec::new(),
            register_mask: Vec::new(),
            frames: Vec::new(),
            pc: 0,
            base_reg: 0,
            current_func: 0,
            heap: Heap::new(),
            handlers: Vec::new(),
            halted: false,
            exit_code: None,
            dispatch_last_result: None,
            dispatch_last_env: None,
            devices: DeviceTable::new(),
            resolved_constants: Vec::new(),
            resolved_const_mask: Vec::new(),
            string_const_handles: Vec::new(),
            resolved_natives: Vec::new(),
            aot_fns: alloc::collections::BTreeMap::new(),
            resolved_aot: Vec::new(),
            region_table: RegionTable::new(),
            natives,
            debug_sink: None,
            trace_filter: None,
            trace_frames: false,
            fn_names: Vec::new(),
            failing_pc: 0,
            last_result_is_handle: false,
            int32_safe: false,
            module_table_raw: polka::HANDLE_NONE,
            module_table_is_handle: false,
            steps: 0,
            step_cap: u64::MAX,
            static_names: Vec::new(),
            trace_static_filter: None,
            heap_check: false,
            profile: false,
            trace_out: None,
            prof_ops: hashbrown::HashMap::new(),
            prof_fns: hashbrown::HashMap::new(),
            prof_fn_ops: hashbrown::HashMap::new(),
            yielded: false,
            yield_dest_abs: 0,
        }
    }

    pub fn with_static_names(mut self, names: Vec<String>) -> Self {
        self.static_names = names;
        self
    }

    pub fn with_step_cap(mut self, cap: u64) -> Self {
        self.step_cap = cap;
        self
    }

    pub fn with_heap_check(mut self, on: bool) -> Self {
        self.heap_check = on;
        self
    }

    // N of instructions executed. Monotonic; a profiler reads the per-frame delta.
    pub fn steps(&self) -> u64 { self.steps }

    pub fn halted(&self) -> bool { self.exit_code.is_some() }

    pub fn exit_code(&self) -> Option<i64> { self.exit_code }

    // Configure heap RC tracing (TRACE_SLOT). slot=None+all=true traces every
    // cell; out is the text sink the host provides (e.g. an eprintln wrapper).
    pub fn with_heap_trace(mut self, slot: Option<u32>, all: bool, out: fn(&str)) -> Self {
        self.heap.set_trace(slot, all, out);
        self
    }

    // Text sink for frame/static diagnostics (TRACE_STATIC, trace_frames).
    pub fn with_trace_out(mut self, out: fn(&str)) -> Self {
        self.trace_out = Some(out);
        self
    }

    pub fn with_profile(mut self, on: bool) -> Self {
        self.profile = on;
        self
    }

    pub fn with_trace_static(mut self, filter: Option<String>) -> Self {
        self.trace_static_filter = filter;
        self
    }

    pub fn with_trace_frames(mut self, on: bool) -> Self {
        self.trace_frames = on;
        self
    }

    // fn_id-indexed bitset; out-of-range fn ids are silenced. None = trace all.
    pub fn with_trace_filter(mut self, bits: Vec<bool>) -> Self {
        self.trace_filter = Some(bits);
        self
    }

    pub fn with_debug_sink(mut self, sink: DebugSink) -> Self {
        self.debug_sink = Some(sink);
        self
    }

    pub fn with_fn_names(mut self, names: Vec<String>) -> Self {
        self.fn_names = names;
        self
    }

    pub(crate) fn emit_debug(&mut self, event: &DebugEvent) {
        if let Some(sink) = &mut self.debug_sink {
            sink(event, &self.fn_names);
        }
    }

    // Opcode + per-fn execution histogram (PROFILE=1). Op counts are
    // pacing-independent: work per run, not wall time. Returns "" when profiling
    // is off; the host prints the report. Kept here so the VM owns the format.
    pub fn profile_report(&self) -> String {
        use core::fmt::Write;
        let mut s = String::new();
        if !self.profile { return s; }
        let mut ops: Vec<_> = self.prof_ops.iter().collect();
        ops.sort_by(|a, b| b.1.cmp(a.1));
        let total: u64 = self.prof_ops.values().sum();
        let _ = writeln!(s, "[profile] {} ops executed", total);
        for (name, n) in ops {
            let _ = writeln!(s, "  {:>12} {:>6.1}%  {}", n, *n as f64 * 100.0 / total.max(1) as f64, name);
        }
        let mut fns: Vec<_> = self.prof_fns.iter().collect();
        fns.sort_by(|a, b| b.1.cmp(a.1));
        let _ = writeln!(s, "[profile] per-fn opcode breakdown (top 15 fns):");
        for (fid, n) in fns.into_iter().take(15) {
            let _ = writeln!(s, "  {:>12} {} ({:.1}%)", n,
                debug::render_fn_label(*fid, &self.fn_names),
                *n as f64 * 100.0 / total.max(1) as f64);
            if let Some(ops) = self.prof_fn_ops.get(fid) {
                let mut fo: Vec<_> = ops.iter().collect();
                fo.sort_by(|a, b| b.1.cmp(a.1));
                let line: Vec<String> = fo.into_iter().take(8)
                    .map(|(name, c)| format!("{} {:.0}%", name, *c as f64 * 100.0 / (*n).max(1) as f64))
                    .collect();
                let _ = writeln!(s, "               {}", line.join("  "));
            }
        }
        s
    }

    pub(crate) fn op_name(op: &polka::OpCode) -> &'static str {
        use polka::OpCode::*;
        match op {
            Add(..) => "Add", Sub(..) => "Sub", Mul(..) => "Mul", Div(..) => "Div", Mod(..) => "Mod",
            Neg(..) => "Neg", FAdd(..) => "FAdd", FSub(..) => "FSub", FMul(..) => "FMul", FDiv(..) => "FDiv",
            FNeg(..) => "FNeg", FLt(..) => "FLt", FEq(..) => "FEq",
            Eq(..) => "Eq", Neq(..) => "Neq", Lt(..) => "Lt", Gt(..) => "Gt", Lte(..) => "Lte", Gte(..) => "Gte",
            And(..) => "And", Or(..) => "Or", Xor(..) => "Xor", Shl(..) => "Shl", Shr(..) => "Shr",
            Jmp(..) => "Jmp", Jz(..) => "Jz", Jnz(..) => "Jnz", Call(..) => "Call", CallReg(..) => "CallReg",
            Ret(..) => "Ret", PushConst(..) => "PushConst", Copy(..) => "Copy", Move(..) => "Move",
            Ld(..) => "Ld", St(..) => "St", LdIdx(..) => "LdIdx", StIdx(..) => "StIdx",
            AddImm(..) => "AddImm", SubImm(..) => "SubImm", Alloc(..) => "Alloc", Drop(..) => "Drop",
            Dei(..) => "Dei", Deo(..) => "Deo", Handle(..) => "Handle", Resume(..) => "Resume", Raise(..) => "Raise",
        }
    }

    #[inline]
    pub(crate) fn trace_frame_event(&self, kind: &str, detail: core::fmt::Arguments<'_>) {
        if !self.trace_frames { return; }
        if let Some(f) = self.trace_out {
            let bfi = self.handlers.last().and_then(|h| h.body_frame_index);
            f(&format!("[{}] {} | frames={} handlers={} bfi={:?}",
                kind, detail, self.frames.len(), self.handlers.len(), bfi));
        }
    }

    pub fn region_push(&mut self) {
        self.region_table.push();
    }

    pub fn region_pop(&mut self) -> Result<(), String> {
        self.region_table.pop_and_release(&mut self.heap)
    }

    pub fn region_depth(&self) -> usize {
        self.region_table.depth()
    }

    #[inline]
    pub fn region_record_alloc(&mut self, slot: u32, generation: u32) {
        if self.region_table.is_active() {
            self.region_table.record_alloc(slot, generation);
        }
    }

    // Refcount of the module static-table root. heap_live_count() hides table
    // leaks (the cell is module-reachable, so always subtracted); this exposes
    // the raw rc so tests can assert per-call Dei/Drop balance on it.
    pub fn module_table_rc(&self) -> Option<u32> {
        if self.module_table_is_handle && self.module_table_raw != polka::HANDLE_NONE {
            let (s, g) = crate::memory::handle_parts(self.module_table_raw);
            self.heap.rc(s, g)
        } else {
            None
        }
    }

    // User-visible live count. Excludes module-lifetime cells owned by the
    // loader/runtime (not by user code): string constants and the module table.
    pub fn heap_live_count(&self) -> usize {
        let total = self.heap.live_count();
        let const_live = self.string_const_handles.iter()
            .filter(|(s, g)| self.heap.is_live(*s, *g))
            .count();
        let mut rt_owned: hashbrown::HashSet<(u32, u32)> = hashbrown::HashSet::new();
        if self.module_table_is_handle && self.module_table_raw != polka::HANDLE_NONE {
            let root = crate::memory::handle_parts(self.module_table_raw);
            self.collect_reachable(root.0, root.1, &mut rt_owned);
        }
        let module_live = rt_owned.iter().filter(|(s, g)| self.heap.is_live(*s, *g)).count();
        total.saturating_sub(const_live).saturating_sub(module_live)
    }

    fn collect_reachable(&self, slot: u32, generation: u32, visited: &mut hashbrown::HashSet<(u32, u32)>) {
        if !visited.insert((slot, generation)) { return; }
        if !self.heap.is_live(slot, generation) { return; }
        let Ok(data) = self.heap.cell_data(slot, generation) else { return; };
        let Ok(mask) = self.heap.cell_mask(slot, generation) else { return; };
        let n = data.len();
        let data: Vec<u64> = data.to_vec();
        for i in 0..n {
            if crate::memory::mask_bit(mask, i) {
                let child_raw = data[i];
                if child_raw != polka::HANDLE_NONE {
                    let (cs, cg) = crate::memory::handle_parts(child_raw);
                    self.collect_reachable(cs, cg, visited);
                }
            }
        }
    }


    // Debug: render every live heap cell. Host prints the returned report.
    pub fn live_slots_report(&self) -> String {
        use core::fmt::Write;
        let owned: hashbrown::HashSet<(u32, u32)> = {
            let mut s: hashbrown::HashSet<(u32, u32)> =
                self.string_const_handles.iter().copied().collect();
            if self.module_table_is_handle && self.module_table_raw != polka::HANDLE_NONE {
                s.insert(crate::memory::handle_parts(self.module_table_raw));
            }
            s
        };
        let cells = self.heap.live_cells();
        let mut out = String::new();
        let _ = writeln!(out, "[heap] {} live cell(s), {} user:", cells.len(), self.heap_live_count());
        for (slot, gen_, rc, data, handles) in &cells {
            let tag = if owned.contains(&(*slot, *gen_)) { "rt  " } else { "USER" };
            let slots: Vec<String> = data.iter().zip(handles.iter()).map(|(v, h)| {
                if *h { format!("h:{:#x}", v) } else { format!("{}", *v as i64) }
            }).collect();
            let note = self.closure_cell_label(data, handles);
            let _ = writeln!(out, "  [{}] slot={} gen={} rc={} [{}]{}", tag, slot, gen_, rc, slots.join(", "), note);
        }
        out
    }

    fn closure_cell_label(&self, data: &[u64], handles: &[bool]) -> String {
        if data.len() != 2 || handles.first() != Some(&false) { return String::new(); }
        let fid = data[0] as usize;
        match self.fn_names.get(fid) {
            Some(n) if n.starts_with("__closure_") || n.starts_with("__fnval_") =>
                format!("  ; closure({})", n),
            _ => String::new(),
        }
    }

    pub fn heap_ref(&self) -> &Heap { &self.heap }
    pub fn heap_mut(&mut self) -> &mut Heap { &mut self.heap }

    pub fn last_result_is_handle(&self) -> bool { self.last_result_is_handle }

    pub fn install_device(&mut self, id: u8, dev: Box<dyn Device>) {
        self.devices.install(id, dev);
    }

    pub fn register_native<S: Into<String>>(&mut self, name: S, func: NativeFn) {
        self.natives.register(name, func);
    }

    pub fn register_aot_fn<S: Into<String>>(&mut self, name: S, func: AotFn) {
        self.aot_fns.insert(name.into(), func);
    }

    pub fn take_device(&mut self, id: u8) -> Option<Box<dyn Device>> {
        self.devices.take(id)
    }

    pub fn heap_alloc(&mut self, size: usize) -> (u32, u32) {
        self.heap.alloc(size)
    }

    pub fn heap_st(
        &mut self, slot: u32, gen_: u32, offset: usize, val: u64, is_handle: bool,
    ) -> Result<(u64, bool), String> {
        self.heap.st(slot, gen_, offset, val, is_handle)
    }

    pub fn push_handler(&mut self, h: HandlerFrame) {
        self.handlers.push(h);
    }
}

#[cfg(test)]
mod region_tests {
    use super::*;

    fn vm() -> VirtualMachine { VirtualMachine::new() }

    #[test]
    fn region_force_frees_even_with_rc_greater_than_one() {
        let mut v = vm();
        v.region_push();
        let (slot, gen_) = v.heap_alloc(1);
        v.region_record_alloc(slot, gen_);
        v.heap.rc_inc(slot, gen_).unwrap();
        v.heap.rc_inc(slot, gen_).unwrap();
        v.region_pop().expect("pop ok");
        assert_eq!(v.heap_live_count(), 0, "force_free ignores rc");
    }

    #[test]
    fn region_cascade_frees_handles_inside_cell() {
        let mut v = vm();
        let (child_slot, child_gen) = v.heap_alloc(1);
        v.region_push();
        let (parent_slot, parent_gen) = v.heap_alloc(1);
        v.region_record_alloc(parent_slot, parent_gen);
        v.heap.rc_inc(child_slot, child_gen).unwrap();
        let child_handle = Value::from_handle(child_slot, child_gen).raw();
        v.heap_st(parent_slot, parent_gen, 0, child_handle, true).unwrap();
        assert_eq!(v.heap_live_count(), 2);
        v.region_pop().expect("pop ok");
        assert_eq!(v.heap_live_count(), 1, "child survives at rc=1; parent freed");
    }

    #[test]
    fn region_pop_force_frees_recorded_alloc() {
        let mut v = vm();
        v.region_push();
        let (slot, gen_) = v.heap_alloc(4);
        v.region_record_alloc(slot, gen_);
        assert_eq!(v.heap_live_count(), 1);
        v.region_pop().expect("pop ok");
        assert_eq!(v.heap_live_count(), 0, "alloc recorded in region must be force-freed");
    }

    #[test]
    fn nested_region_pop_frees_only_inner() {
        let mut v = vm();
        v.region_push();
        let (outer_slot, outer_gen) = v.heap_alloc(1);
        v.region_record_alloc(outer_slot, outer_gen);

        v.region_push();
        let (inner_slot, inner_gen) = v.heap_alloc(1);
        v.region_record_alloc(inner_slot, inner_gen);
        assert_eq!(v.heap_live_count(), 2);

        v.region_pop().expect("inner pop");
        assert_eq!(v.region_depth(), 1, "outer region still active");
        assert_eq!(v.heap_live_count(), 1, "outer alloc survives inner pop");

        v.region_pop().expect("outer pop");
        assert_eq!(v.region_depth(), 0);
        assert_eq!(v.heap_live_count(), 0);
    }

    #[test]
    fn region_records_only_to_topmost_region() {
        let mut v = vm();
        v.region_push();
        v.region_push();
        let (slot, gen_) = v.heap_alloc(1);
        v.region_record_alloc(slot, gen_);

        v.region_pop().expect("inner pop");
        assert_eq!(v.heap_live_count(), 0);
        v.region_pop().expect("outer pop");
    }

    #[test]
    fn record_alloc_outside_region_is_noop() {
        let mut v = vm();
        let (slot, gen_) = v.heap_alloc(1);
        v.region_record_alloc(slot, gen_);
        assert_eq!(v.heap_live_count(), 1);
        assert!(v.region_pop().is_err());
    }
}

impl VirtualMachine {
    // Structural heap dump for debuggers/hosts. No runtime types: cells render
    // as [v0, v1, …], scalars as decimal, HANDLE_NONE as "none". Read-only;
    // stale handles render as an error string (gen check), never panic.
    pub fn render_value(&self, raw: u64, is_handle: bool, depth: usize) -> String {
        if !is_handle { return (raw as i64).to_string(); }
        if raw == polka::HANDLE_NONE { return "none".into(); }
        if depth == 0 { return "".into(); }
        let (slot, g) = Self::decode_handle(raw);
        let len = match self.heap.size(slot, g) {
            Ok(n) => n,
            Err(_) => return format!("<stale {:#x}>", raw),
        };
        let mut out = String::from("[");
        for off in 0..len {
            if off > 0 { out.push_str(", "); }
            match self.heap.ld(slot, g, off) {
                Ok((v, h)) => out.push_str(&self.render_value(v, h, depth - 1)),
                Err(_) => { out.push_str("<err>"); }
            }
        }
        out.push(']');
        out
    }

    // Test helper: release one rc on a handle (e.g. a value returned by main).
    pub fn drop_result_for_test(&mut self, raw: u64) {
        let _ = self.heap.rc_dec_handle(raw);
    }
}

#[cfg(test)]
mod vm_api_tests {
    use super::*;
    use polka::{Module, Chunk, BytecodeChunk, OpCode, Register};

    fn const_module(val: u64) -> Module {
        Module {
            functions: vec![Chunk::Bytecode(BytecodeChunk {
                code: vec![OpCode::PushConst(Register(0), 0), OpCode::Ret(Register(0))],
                constants: vec![val],
                const_mask: Vec::new(),
                string_constants: Vec::new(),
                reg_count: 1,
                param_count: 0,
                lines: Vec::new(),
                src_file: String::new(),
            })],
            entry: 0,
            flags: 0,
            exports: Vec::new(),
        }
    }

    #[test]
    fn run_returns_entry_value_as_int() {
        assert_eq!(run(const_module(42), Host::default()).unwrap(), 42);
    }

    #[test]
    fn profile_and_step_counters_populate_after_run() {
        let mut vm = VirtualMachine::new().with_profile(true);
        let loaded = loader::load(const_module(7)).unwrap();
        let v = vm.run_module(&loaded.module).unwrap();
        assert_eq!(v.as_int(), 7);
        assert!(vm.steps() > 0);
        assert!(!vm.profile_report().is_empty());
    }

    #[test]
    fn region_depth_tracks_push_pop() {
        let mut vm = VirtualMachine::new();
        assert_eq!(vm.region_depth(), 0);
        vm.region_push();
        assert_eq!(vm.region_depth(), 1);
        vm.region_pop().unwrap();
        assert_eq!(vm.region_depth(), 0);
    }

    #[test]
    fn fresh_vm_not_halted_no_exit_code() {
        let vm = VirtualMachine::new();
        assert!(!vm.halted());
        assert_eq!(vm.exit_code(), None);
        assert_eq!(vm.module_table_rc(), None);
    }

    #[test]
    fn render_value_formats_int_and_opaque_handle() {
        let vm = VirtualMachine::new();
        assert_eq!(vm.render_value(42, false, 0), "42");
        assert_eq!(vm.render_value(polka::HANDLE_NONE, true, 4), "none");
        assert_eq!(vm.render_value(0, true, 0), "");
    }

    #[test]
    fn take_device_absent_is_none() {
        let mut vm = VirtualMachine::new();
        assert!(vm.take_device(0x7e).is_none());
    }
}