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
use alloc::{string::String, vec::Vec};
use polka::{BytecodeChunk, Chunk, Register, Module, FRAME_REGS, HANDLE_NONE};
use crate::frame::Frame;
use crate::builtins::NativeCtx;
use super::super::{VirtualMachine, Value};
use super::{MAX_REGISTERS, MAX_RECURSION_DEPTH, STAGE_SLACK};


impl VirtualMachine {
    pub(super) fn do_call(&mut self, module: &Module, caller_bc: &BytecodeChunk, dest: Register, fn_id: usize) -> Result<(), String> {
        if fn_id >= module.functions.len() {
            return Err(format!("call: unknown fn_id {}", fn_id));
        }
        let caller_reg_count = caller_bc.reg_count;
        if dest.to_usize() >= caller_reg_count {
            return Err(format!(
                "call: dest r{} out of caller window (reg_count {})",
                dest.0, caller_reg_count
            ));
        }
        let dest_abs = self.base_reg + dest.to_usize();
        let new_base = self.base_reg + caller_reg_count;
        let needed = new_base + FRAME_REGS + STAGE_SLACK;
        if needed > MAX_REGISTERS {
            return Err(format!(
                "Stack overflow: register window {} exceeds limit {}",
                needed, MAX_REGISTERS
            ));
        }
        self.ensure_registers(needed);

        let chunk = unsafe { module.functions.get_unchecked(fn_id) };
        if let Chunk::Native(n) = chunk {
            if n.name == "__frame_present" {
                self.yielded = true;
                self.yield_dest_abs = dest_abs;
                return Ok(());
            }
            let param_count = n.param_count;
            const MAX_NATIVE_ARGS: usize = 8;
            if param_count > MAX_NATIVE_ARGS {
                return Err(format!("native call: param_count {} exceeds buffer size {}", param_count, MAX_NATIVE_ARGS));
            }
            if let Some(aot) = self.resolved_aot[fn_id].clone() {
                let mut buf: [Value; MAX_NATIVE_ARGS] = [Value::ZERO; MAX_NATIVE_ARGS];
                let mut tags: [bool; MAX_NATIVE_ARGS] = [false; MAX_NATIVE_ARGS];
                for i in 0..param_count {
                    buf[i] = Value::from_raw(self.read_abs_raw(new_base + i));
                    tags[i] = self.reg_mask_bit(new_base + i);
                }
                let mut ctx = NativeCtx {
                    heap: &mut self.heap, devices: &mut self.devices,
                    halted: &mut self.halted, exit_code: &mut self.exit_code,
                };
                let (result, result_is_handle) = aot(&mut ctx, &buf[..param_count], &tags[..param_count])?;
                for i in 0..param_count {
                    self.set_reg_mask_bit(new_base + i, false);
                    self.write_abs_raw(new_base + i, HANDLE_NONE);
                }
                self.write_abs(dest_abs, result.raw(), result_is_handle);
                return Ok(());
            }
            let func = self.resolved_natives[fn_id].as_ref()
                .ok_or_else(|| format!("native call: fn_id {} not resolved", fn_id))?
                .clone();
            let mut buf: [Value; MAX_NATIVE_ARGS] = [Value::ZERO; MAX_NATIVE_ARGS];
            for i in 0..param_count {
                let raw = self.read_abs_raw(new_base + i);
                buf[i] = Value::from_raw(raw);
            }
            let mut ctx = NativeCtx {
                heap: &mut self.heap,
                devices: &mut self.devices,
                halted: &mut self.halted,
                exit_code: &mut self.exit_code,
            };
            let (result, result_is_handle) = func(&mut ctx, &buf[..param_count])?;
            for i in 0..param_count {
                let abs = new_base + i;
                if self.reg_mask_bit(abs) {
                    let raw = self.read_abs_raw(abs);
                    self.rc_dec_handle(raw)?;
                    self.set_reg_mask_bit(abs, false);
                }
                self.write_abs_raw(abs, HANDLE_NONE);
            }
            self.write_abs(dest_abs, result.raw(), result_is_handle);
            return Ok(());
        }

        if self.frames.len() >= MAX_RECURSION_DEPTH {
            return Err(format!(
                "Stack overflow: recursion depth {} exceeds limit {}",
                self.frames.len(),
                MAX_RECURSION_DEPTH
            ));
        }
        self.frames.push(Frame::normal(self.current_func, self.pc, self.base_reg, dest_abs));
        if !self.handlers.is_empty() {
            self.maybe_mark_body_frame();
        }
        self.base_reg = new_base;
        self.current_func = fn_id;
        self.pc = 0;
        self.trace_frame_event("CALL push", format_args!("func={} dest=r{}", fn_id, dest.0));
        Ok(())
    }

    pub(super) fn do_raise(
        &mut self,
        module: &Module,
        caller_bc: &BytecodeChunk,
        dest: Register,
        key_reg: Register,
        args_base: Register,
    ) -> Result<(), String> {
        let key_raw = self.read_i64(key_reg)?;
        if !(0..=0xFFFFFF).contains(&key_raw) {
            return Err(format!("raise: bad key {}", key_raw));
        }
        let effect_id = ((key_raw >> 8) & 0xFFFF) as u16;
        let op_id = (key_raw & 0xFF) as usize;

        let (arm_fn_id, tail_arm, env) = self.resolve_dispatch_for(effect_id, op_id);
        if arm_fn_id == polka::DISPATCH_NO_MATCH {
            return Err(format!("raise: unhandled effect {:#04x} op {}", effect_id, op_id));
        }
        let arm_fn_id = arm_fn_id as usize;

        let caller_reg_count = caller_bc.reg_count;
        if dest.to_usize() >= caller_reg_count {
            return Err(format!(
                "raise: dest r{} out of caller window (reg_count {})",
                dest.0, caller_reg_count
            ));
        }
        let dest_abs = self.base_reg + dest.to_usize();

        let arm_chunk = module.functions.get(arm_fn_id)
            .ok_or_else(|| format!("raise: bad arm fn_id {}", arm_fn_id))?;
        let (arm_reg_count, arm_param_count) = match arm_chunk {
            Chunk::Bytecode(b) => (b.reg_count, b.param_count),
            Chunk::Native(_) => return Err(format!("raise: arm fn_id {} is native", arm_fn_id)),
        };
        if arm_param_count < 2 {
            return Err(format!("raise: arm fn_id {} param_count {} < 2", arm_fn_id, arm_param_count));
        }
        let nargs = arm_param_count - 2;

        // Op args are MOVED into the operation: take them out of the caller
        // window (before snapshotting, in the suspension path).
        let args_base_abs = self.base_reg + args_base.to_usize();
        let mut moved_args: Vec<(u64, bool)> = Vec::with_capacity(nargs);
        for i in 0..nargs {
            let src_abs = args_base_abs + i;
            let raw = self.read_abs_raw(src_abs);
            let is_handle = self.reg_mask_bit(src_abs);
            moved_args.push((raw, is_handle));
            if is_handle { self.write_abs(src_abs, HANDLE_NONE, false); }
        }

        let (env_raw, env_is_handle) = env.unwrap_or((HANDLE_NONE, false));
        // Tail-resumptive arm (compiled to end in Ret): plain call, the cont
        // cell and register snapshot would never be read — skip them entirely.
        if !tail_arm {
            let mut init_mask = vec![0u64; (crate::cont_slot::SIZE + 63) / 64];
            init_mask[0] = crate::cont_slot::INIT_MASK_WORD0;
            let (cell_slot, cell_gen) = self.checked_heap_alloc_with_mask(crate::cont_slot::SIZE, &init_mask)?;
            self.region_record_alloc(cell_slot, cell_gen);
            self.heap.st(cell_slot, cell_gen, crate::cont_slot::SUSPEND_PC, (self.pc - 1) as u64, false)?;
            self.heap.st(cell_slot, cell_gen, crate::cont_slot::SUSPEND_BASE, self.base_reg as u64, false)?;
            self.heap.st(cell_slot, cell_gen, crate::cont_slot::SUSPEND_FUNC, self.current_func as u64, false)?;
            self.heap.st(cell_slot, cell_gen, crate::cont_slot::ALIVE, 1, false)?;

            let snapshot = self.snapshot_registers(self.base_reg, caller_reg_count)?;
            self.write_snapshot_into_cell(cell_slot, cell_gen, snapshot)?;

            if let Some(handler_frame) = self.handlers.last_mut() {
                handler_frame.cells_allocated.push((cell_slot, cell_gen));
                handler_frame.cell_slot = cell_slot;
                handler_frame.cell_gen = cell_gen;
            }
            self.heap.st(cell_slot, cell_gen, crate::cont_slot::DISPATCH_FN_ID, arm_fn_id as u64, false)?;
            if env_is_handle { self.rc_inc_handle(env_raw)?; }
            self.heap.st(cell_slot, cell_gen, crate::cont_slot::DISPATCH_ENV, env_raw, env_is_handle)?;
        }

        let new_base = self.base_reg + caller_reg_count;
        let window = arm_reg_count.max(polka::FRAME_REGS);
        let needed = new_base + window + STAGE_SLACK;
        if needed > MAX_REGISTERS {
            return Err(format!(
                "Stack overflow: register window {} exceeds limit {}",
                needed, MAX_REGISTERS
            ));
        }
        self.ensure_registers(needed);

        if env_is_handle { self.rc_inc_handle(env_raw)?; }
        self.write_abs(new_base, env_raw, env_is_handle);
        self.write_abs(new_base + 1, 0, false);

        for (i, (raw, is_handle)) in moved_args.into_iter().enumerate() {
            self.write_abs(new_base + 2 + i, raw, is_handle);
        }

        if self.frames.len() >= MAX_RECURSION_DEPTH {
            return Err(format!(
                "Stack overflow: recursion depth {} exceeds limit {}",
                self.frames.len(),
                MAX_RECURSION_DEPTH
            ));
        }
        self.frames.push(Frame::normal(self.current_func, self.pc, self.base_reg, dest_abs));
        self.maybe_mark_body_frame();
        self.base_reg = new_base;
        self.current_func = arm_fn_id;
        self.pc = 0;
        self.trace_frame_event("RAISE", format_args!("eff={:#04x} op={} arm_fn={}", effect_id, op_id, arm_fn_id));
        Ok(())
    }

    pub(super) fn resolve_dispatch_for(&self, effect_id: u16, op_id: usize) -> (u16, bool, Option<(u64, bool)>) {
        for h in self.handlers.iter().rev() {
            if h.effect_id != effect_id { continue; }
            if let Some(slot) = h.dispatch_table_slot {
                if let Ok((raw, _)) = self.heap.ld(slot, h.dispatch_table_gen, op_id * 2) {
                    let tail = (raw & polka::DISPATCH_TAIL_FLAG) != 0;
                    let n = raw & 0xFFFF;
                    if raw & !(polka::DISPATCH_TAIL_FLAG | 0xFFFF) == 0 && (n as u16) != polka::DISPATCH_NO_MATCH {
                        let env = self.heap.ld(slot, h.dispatch_table_gen, op_id * 2 + 1).ok();
                        return (n as u16, tail, env);
                    }
                }
            }
        }
        (polka::DISPATCH_NO_MATCH, false, None)
    }

    #[cold]
    #[inline(never)]
    pub(super) fn maybe_mark_body_frame(&mut self) {
        let new_frame_index = self.frames.len() - 1;
        let handler = self.handlers.last_mut().unwrap();
        if handler.body_frame_index.is_none() {
            handler.body_frame_index = Some(new_frame_index);
        }
    }

    #[inline]
    pub(super) fn do_ret(&mut self, module: &Module, reg: Register) -> Result<(), String> {
        let abs = self.abs(reg);
        let (return_raw, return_is_handle) = self.take_abs(abs);
        let frame = match self.frames.pop() {
            Some(f) => f,
            None => {
                self.write_abs(self.base_reg, return_raw, return_is_handle);
                self.halted = true;
                return Ok(());
            }
        };
        self.trace_frame_event("RET pop",
            format_args!("func={} ret({})={:#x}", frame.func_id,
                if return_is_handle {"handle"} else {"scalar"}, return_raw));

        if self.handlers.is_empty() && frame.cont.is_none() {
            self.pc = frame.ip;
            self.base_reg = frame.base_reg;
            self.current_func = frame.func_id;
            self.write_abs(frame.dest_reg, return_raw, return_is_handle);
            return Ok(());
        }

        self.do_ret_slow(module, frame, return_raw, return_is_handle)
    }

    #[cold]
    #[inline(never)]
    pub(super) fn do_ret_slow(&mut self, module: &Module, frame: super::Frame, return_raw: u64, return_is_handle: bool) -> Result<(), String> {
        let is_body_frame = self.handlers.last()
            .and_then(|h| h.body_frame_index)
            .map_or(false, |idx| idx == self.frames.len());
        let route_through_return_arm = (frame.cont.is_some() || is_body_frame)
            && self.handlers.last().map_or(false, |h| h.pending_return_arm_fn.is_some());

        let is_arm_ret = self.handlers.last()
            .and_then(|h| h.body_frame_index)
            .map_or(false, |idx| self.frames.len() == idx + 1);
        if is_arm_ret && frame.cont.is_none() && return_is_handle && return_raw != HANDLE_NONE {
            let (s, g) = Self::decode_handle(return_raw);
            let tag_is_err = self.heap.ld(s, g, 0).ok()
                .map(|(t, _)| (t as u32) == 1)
                .unwrap_or(false);

            if tag_is_err {
                let body_call_frame = self.frames.pop()
                    .ok_or("arm-throw: missing body-call frame to unwind into")?;
                if let Some(handler) = self.handlers.pop() {
                    handler.release_cells(&mut self.heap, &mut self.region_table)?;
                }
                let inner_base = body_call_frame.base_reg;
                let inner_func = body_call_frame.func_id;
                let inner_reg_count = match module.functions.get(inner_func) {
                    Some(Chunk::Bytecode(b)) => b.reg_count,
                    _ => 0,
                };
                for i in 0..inner_reg_count {
                    let abs = inner_base + i;
                    if self.reg_mask_bit(abs) {
                        let raw = self.read_abs_raw(abs);
                        if raw != HANDLE_NONE && raw != return_raw {
                            self.rc_dec_handle(raw)?;
                        }
                        self.set_reg_mask_bit(abs, false);
                        self.write_abs_raw(abs, HANDLE_NONE);
                    }
                }
                let outer_frame = self.frames.pop()
                    .ok_or("arm-throw: missing outer (handle-expr caller) frame")?;
                self.pc = outer_frame.ip;
                self.base_reg = outer_frame.base_reg;
                self.current_func = outer_frame.func_id;
                let dest_abs = outer_frame.dest_reg;
                if self.reg_mask_bit(dest_abs) {
                    let prior = self.read_abs_raw(dest_abs);
                    if prior != HANDLE_NONE && prior != return_raw {
                        self.rc_dec_handle(prior)?;
                    }
                }
                self.write_abs(dest_abs, return_raw, true);
                return Ok(());
            }
        }

        if !route_through_return_arm {
            if let Some(cont) = frame.cont.as_ref() {
                if cont.snapshot_count > 0 {
                    let snap = crate::snapshot::SnapshotHandle {
                        slot: cont.snapshot_slot,
                        generation: cont.snapshot_gen,
                        count: cont.snapshot_count,
                    };
                    self.restore_registers(frame.base_reg, snap)?;
                    self.heap.rc_dec(snap.slot, snap.generation)?;
                }
            }
            self.pc = frame.ip;
            self.base_reg = frame.base_reg;
            self.current_func = frame.func_id;
            self.write_abs(frame.dest_reg, return_raw, return_is_handle);
            return Ok(());
        }

        if let Some(cont) = frame.cont.as_ref() {
            if cont.snapshot_count > 0 {
                let snap = crate::snapshot::SnapshotHandle {
                    slot: cont.snapshot_slot,
                    generation: cont.snapshot_gen,
                    count: cont.snapshot_count,
                };
                self.restore_registers(frame.base_reg, snap)?;
                self.heap.rc_dec(snap.slot, snap.generation)?;
            }
        }

        let (ra_fn, ra_env_raw, ra_env_is_handle) = {
            let h = self.handlers.last_mut().unwrap();
            let fn_id = h.pending_return_arm_fn.take().unwrap();
            let env = core::mem::replace(&mut h.pending_return_arm_env, HANDLE_NONE);
            let env_h = core::mem::replace(&mut h.pending_return_arm_env_is_handle, false);
            (fn_id, env, env_h)
        };

        self.frames.push(super::Frame::normal(
            frame.func_id, frame.ip, frame.base_reg, frame.dest_reg,
        ));

        let caller_reg_count = match module.functions.get(frame.func_id) {
            Some(Chunk::Bytecode(b)) => b.reg_count,
            _ => return Err(format!("return-arm: popped frame func {} is not bytecode", frame.func_id)),
        };
        let callee_reg_count = match module.functions.get(ra_fn) {
            Some(Chunk::Bytecode(b)) => b.reg_count,
            Some(Chunk::Native(_)) => return Err("return-arm: native return arm not supported".into()),
            None => return Err(format!("return-arm: unknown fn_id {}", ra_fn)),
        };
        let new_base = frame.base_reg + caller_reg_count;
        let window = callee_reg_count.max(polka::FRAME_REGS);
        let needed = new_base + window + STAGE_SLACK;
        if needed > MAX_REGISTERS {
            return Err(format!(
                "Stack overflow setting up return arm: window {} exceeds limit {}",
                needed, MAX_REGISTERS
            ));
        }
        self.ensure_registers(needed);

        if ra_env_is_handle { self.rc_inc_handle(ra_env_raw)?; }
        self.write_abs(new_base, ra_env_raw, ra_env_is_handle);
        self.write_abs(new_base + 1, 0, false);
        self.write_abs(new_base + 2, return_raw, return_is_handle);

        self.base_reg = new_base;
        self.current_func = ra_fn;
        self.pc = 0;
        Ok(())
    }
}