hiko-vm 0.5.1

hiko-vm: part of the hiko ML-family scripting language
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
//! Runtime: single-threaded scheduler loop for running multiple hiko processes.

use std::collections::HashMap;
use std::sync::atomic::{AtomicU64, Ordering};

use crate::process::{BlockReason, Pid, Process, ProcessStatus};
use crate::scheduler::{FifoScheduler, Scheduler};
use crate::sendable::{SendableValue, deserialize, serialize};
use crate::value::Value;
use crate::vm::{RunResult, VM};
use hiko_compile::chunk::CompiledProgram;

/// The hiko runtime — manages processes and scheduling.
pub struct Runtime {
    next_pid: AtomicU64,
    processes: HashMap<Pid, Process>,
    scheduler: Box<dyn Scheduler>,
    /// Processes waiting for another process to finish: child_pid → [waiter_pids]
    waiters: HashMap<Pid, Vec<Pid>>,
}

impl Default for Runtime {
    fn default() -> Self {
        Self {
            next_pid: AtomicU64::new(1),
            processes: HashMap::new(),
            scheduler: Box::new(FifoScheduler::new(1000)),
            waiters: HashMap::new(),
        }
    }
}

impl Runtime {
    /// Create a new runtime with the default FIFO scheduler.
    pub fn new() -> Self {
        Self::default()
    }

    /// Create a runtime with a custom scheduler.
    pub fn with_scheduler(scheduler: Box<dyn Scheduler>) -> Self {
        Self {
            next_pid: AtomicU64::new(1),
            processes: HashMap::new(),
            scheduler,
            waiters: HashMap::new(),
        }
    }

    /// Allocate a new process ID.
    fn new_pid(&self) -> Pid {
        Pid(self.next_pid.fetch_add(1, Ordering::Relaxed))
    }

    /// Spawn a root process from a compiled program.
    /// Returns the Pid.
    pub fn spawn_root(&mut self, program: CompiledProgram) -> Pid {
        let pid = self.new_pid();
        let mut vm = VM::new(program);
        vm.enable_output_capture();
        let process = Process::new(pid, vm, None);
        self.processes.insert(pid, process);
        self.scheduler.enqueue(pid);
        pid
    }

    /// Run all processes to completion (single-threaded).
    /// Returns the root process's output lines.
    pub fn run_to_completion(&mut self) -> Result<Vec<String>, String> {
        while let Some(pid) = self.try_dequeue() {
            let reductions = self.scheduler.reductions(pid);

            let result = {
                let process = self.processes.get_mut(&pid).expect("process not in table");
                process.vm.run_slice(reductions)
            };

            match result {
                RunResult::Done => {
                    let process = self.processes.get_mut(&pid).unwrap();
                    // Serialize result once on completion
                    let val = process.vm.stack.last().copied().unwrap_or(Value::Unit);
                    match serialize(val, &process.vm.heap) {
                        Ok(sv) => process.result = Some(sv),
                        Err(e) => {
                            process.status =
                                ProcessStatus::Failed(format!("child result not sendable: {e}"));
                            self.scheduler.remove(pid);
                            self.wake_and_deliver_results(pid);
                            continue;
                        }
                    }
                    process.status = ProcessStatus::Done;
                    self.scheduler.remove(pid);
                    self.wake_and_deliver_results(pid);
                }
                RunResult::Yielded => {
                    self.scheduler.enqueue(pid);
                }
                RunResult::Failed(msg) => {
                    let process = self.processes.get_mut(&pid).unwrap();
                    process.status = ProcessStatus::Failed(msg);
                    self.scheduler.remove(pid);
                    self.wake_and_deliver_results(pid);
                }
                RunResult::Spawn {
                    proto_idx,
                    captures,
                } => {
                    let child_pid = self.handle_spawn(pid, proto_idx, captures);
                    // Resume parent with child pid
                    let process = self.processes.get_mut(&pid).unwrap();
                    // Replace the Unit placeholder with the actual Pid
                    process.vm.stack.pop();
                    process.vm.push_value(Value::Int(child_pid.0 as i64));
                    self.scheduler.enqueue(pid);
                }
                RunResult::Await(child_pid_val) => {
                    let child_pid = Pid(child_pid_val);
                    self.handle_await(pid, child_pid);
                }
                RunResult::Send { target_pid, value } => {
                    self.handle_send(pid, Pid(target_pid), value);
                }
                RunResult::Receive => {
                    self.handle_receive(pid);
                }
                RunResult::Io(_req) => {
                    let process = self.processes.get_mut(&pid).unwrap();
                    process.status =
                        ProcessStatus::Failed("async I/O requires ThreadedRuntime".into());
                }
                RunResult::Cancelled => {
                    let process = self.processes.get_mut(&pid).unwrap();
                    process.status = ProcessStatus::Failed("cancelled".into());
                    self.scheduler.remove(pid);
                    self.wake_and_deliver_results(pid);
                }
            }
        }

        // Collect output from all processes (root first)
        let mut all_output = Vec::new();
        for process in self.processes.values() {
            all_output.extend(process.vm.get_output().iter().cloned());
        }
        Ok(all_output)
    }

    /// Handle a spawn request: create child process from closure prototype.
    fn handle_spawn(
        &mut self,
        parent_pid: Pid,
        proto_idx: usize,
        captures: Vec<SendableValue>,
    ) -> Pid {
        let child_pid = self.new_pid();
        let parent = self.processes.get(&parent_pid).unwrap();
        let child_vm =
            crate::runtime_ops::create_child_vm_from_parent(&parent.vm, proto_idx, captures);
        let child = Process::new(child_pid, child_vm, Some(parent_pid));
        self.processes.insert(child_pid, child);
        self.scheduler.enqueue(child_pid);
        child_pid
    }

    /// Handle an await request: block parent or resume with result.
    fn handle_await(&mut self, parent_pid: Pid, child_pid: Pid) {
        // Extract child state as an owned value to avoid borrow conflicts
        enum ChildState {
            Done,
            Failed(String),
            Running,
            NotFound,
            NotChild,
        }

        let child_state = match self.processes.get(&child_pid) {
            None => ChildState::NotFound,
            Some(child) => {
                // Parent-only await: only the spawning parent may await
                if child.parent != Some(parent_pid) {
                    ChildState::NotChild
                } else {
                    match &child.status {
                        ProcessStatus::Done => ChildState::Done,
                        ProcessStatus::Failed(msg) => ChildState::Failed(msg.clone()),
                        _ => ChildState::Running,
                    }
                }
            }
        };

        match child_state {
            ChildState::Done => {
                // Take result (consume once — second await will fail)
                let sendable = match self
                    .processes
                    .get_mut(&child_pid)
                    .and_then(|c| c.result.take())
                {
                    Some(sv) => sv,
                    None => {
                        let parent = self.processes.get_mut(&parent_pid).unwrap();
                        parent.status =
                            ProcessStatus::Failed("await: child result already consumed".into());
                        return;
                    }
                };
                let parent = self.processes.get_mut(&parent_pid).unwrap();
                parent.vm.stack.pop();
                let val = deserialize(sendable, &mut parent.vm.heap);
                parent.vm.push_value(val);
                self.scheduler.enqueue(parent_pid);
            }
            ChildState::Failed(msg) => {
                let parent = self.processes.get_mut(&parent_pid).unwrap();
                parent.status = ProcessStatus::Failed(format!("child process failed: {msg}"));
                self.scheduler.remove(parent_pid);
            }
            ChildState::Running => {
                let parent = self.processes.get_mut(&parent_pid).unwrap();
                parent.status = ProcessStatus::Blocked(BlockReason::Await(child_pid));
                self.waiters.entry(child_pid).or_default().push(parent_pid);
            }
            ChildState::NotFound => {
                let parent = self.processes.get_mut(&parent_pid).unwrap();
                parent.status =
                    ProcessStatus::Failed(format!("await: unknown process {:?}", child_pid));
                self.scheduler.remove(parent_pid);
            }
            ChildState::NotChild => {
                let parent = self.processes.get_mut(&parent_pid).unwrap();
                parent.status = ProcessStatus::Failed(format!(
                    "await: process {:?} is not a child of {:?}",
                    child_pid, parent_pid
                ));
                self.scheduler.remove(parent_pid);
            }
        }
    }

    /// Handle a send request: push message to target's mailbox.
    fn handle_send(
        &mut self,
        sender_pid: Pid,
        target_pid: Pid,
        value: crate::sendable::SendableValue,
    ) {
        match self.processes.get_mut(&target_pid) {
            Some(target) => {
                if matches!(target.status, ProcessStatus::Blocked(BlockReason::Receive)) {
                    // Target is waiting — deliver directly, skip mailbox round-trip
                    target.status = ProcessStatus::Runnable;
                    target.vm.stack.pop();
                    let val = deserialize(value, &mut target.vm.heap);
                    target.vm.push_value(val);
                    self.scheduler.enqueue(target_pid);
                } else {
                    // Target is running — queue in mailbox
                    target.mailbox.push_back(value);
                }
                // Resume sender
                self.scheduler.enqueue(sender_pid);
            }
            None => {
                let sender = self.processes.get_mut(&sender_pid).unwrap();
                sender.status = ProcessStatus::Failed(format!(
                    "send_message: unknown process {:?}",
                    target_pid
                ));
                self.scheduler.remove(sender_pid);
            }
        }
    }

    /// Handle a receive request: pop from mailbox or block.
    fn handle_receive(&mut self, pid: Pid) {
        let process = self.processes.get_mut(&pid).unwrap();
        if let Some(msg) = process.mailbox.pop_front() {
            // Message available — deliver immediately
            process.vm.stack.pop(); // remove placeholder
            let val = deserialize(msg, &mut process.vm.heap);
            process.vm.push_value(val);
            self.scheduler.enqueue(pid);
        } else {
            // No messages — block until one arrives
            process.status = ProcessStatus::Blocked(BlockReason::Receive);
        }
    }

    /// When a child finishes, wake blocked parents and give them the result.
    fn wake_and_deliver_results(&mut self, finished_pid: Pid) {
        let waiter_pids = match self.waiters.remove(&finished_pid) {
            Some(w) => w,
            None => return,
        };

        // Serialize the finished process's result once, before borrowing waiters
        let child = &self.processes[&finished_pid];
        let delivery = match &child.status {
            ProcessStatus::Done => {
                let val = child.vm.stack.last().copied().unwrap_or(Value::Unit);
                let sendable =
                    serialize(val, &child.vm.heap).unwrap_or(crate::sendable::SendableValue::Unit);
                Ok(sendable)
            }
            ProcessStatus::Failed(msg) => Err(msg.clone()),
            _ => Err("child not finished".into()),
        };

        for waiter in waiter_pids {
            if let Some(process) = self.processes.get_mut(&waiter) {
                match &delivery {
                    Ok(sendable) => {
                        process.vm.stack.pop();
                        let val = deserialize(sendable.clone(), &mut process.vm.heap);
                        process.vm.push_value(val);
                        process.status = ProcessStatus::Runnable;
                        self.scheduler.enqueue(waiter);
                    }
                    Err(msg) => {
                        process.status =
                            ProcessStatus::Failed(format!("child process failed: {msg}"));
                    }
                }
            }
        }
    }

    /// Try to dequeue a runnable process without blocking.
    /// Returns None when no runnable processes remain.
    fn try_dequeue(&self) -> Option<Pid> {
        self.scheduler.try_dequeue()
    }

    /// Get a process's output.
    pub fn get_output(&self, pid: Pid) -> Vec<String> {
        self.processes
            .get(&pid)
            .map(|p| p.vm.get_output().to_vec())
            .unwrap_or_default()
    }

    /// Get the number of processes.
    pub fn process_count(&self) -> usize {
        self.processes.len()
    }
}

#[cfg(test)]
mod tests {
    use super::*;
    use hiko_compile::compiler::Compiler;
    use hiko_syntax::lexer::Lexer;
    use hiko_syntax::parser::Parser;

    fn compile(source: &str) -> CompiledProgram {
        let tokens = Lexer::new(source, 0).tokenize().unwrap();
        let program = Parser::new(tokens).parse_program().unwrap();
        let (compiled, _) = Compiler::compile(program).unwrap();
        compiled
    }

    #[test]
    fn test_single_process_runs_to_completion() {
        let program = compile("val x = 42");
        let mut runtime = Runtime::new();
        let pid = runtime.spawn_root(program);
        let result = runtime.run_to_completion();
        assert!(result.is_ok());
        assert!(runtime.processes[&pid].is_done());
    }

    #[test]
    fn test_single_process_output() {
        let program = compile("val _ = println \"hello from process\"");
        let mut runtime = Runtime::new();
        let pid = runtime.spawn_root(program);
        runtime.run_to_completion().unwrap();
        let output = runtime.get_output(pid);
        assert_eq!(output, vec!["hello from process\n"]);
    }

    #[test]
    fn test_process_failure() {
        let program = compile("val _ = panic \"boom\"");
        let mut runtime = Runtime::new();
        let pid = runtime.spawn_root(program);
        runtime.run_to_completion().unwrap();
        match &runtime.processes[&pid].status {
            ProcessStatus::Failed(msg) => assert!(msg.contains("boom")),
            other => panic!("expected Failed, got {:?}", other),
        }
    }

    #[test]
    fn test_run_slice_yields() {
        let program = compile(
            "fun loop n = if n = 0 then () else loop (n - 1)\n\
             val _ = loop 10000",
        );
        let mut vm = VM::new(program);
        // Run with very few reductions — should yield
        let result = vm.run_slice(100);
        assert!(matches!(result, RunResult::Yielded));

        // Continue running with more fuel — should complete
        let result = vm.run_slice(1_000_000);
        assert!(matches!(result, RunResult::Done));
    }

    #[test]
    fn test_run_slice_completes() {
        let program = compile("val x = 1 + 1");
        let mut vm = VM::new(program);
        let result = vm.run_slice(1000);
        assert!(matches!(result, RunResult::Done));
    }

    #[test]
    fn test_runtime_with_yielding_process() {
        // A process that needs many reductions
        let program = compile(
            "fun loop n = if n = 0 then () else loop (n - 1)\n\
             val _ = loop 5000\n\
             val _ = println \"done\"",
        );
        let mut runtime = Runtime::new();
        let pid = runtime.spawn_root(program);
        runtime.run_to_completion().unwrap();
        assert!(runtime.processes[&pid].is_done());
        let output = runtime.get_output(pid);
        assert_eq!(output, vec!["done\n"]);
    }

    #[test]
    fn test_spawn_and_await_basic() {
        let program = compile(
            "val child = spawn (fn () => 42)\n\
             val result = await_process child\n\
             val _ = println (int_to_string result)",
        );
        let mut runtime = Runtime::new();
        let pid = runtime.spawn_root(program);
        runtime.run_to_completion().unwrap();
        assert!(runtime.processes[&pid].is_done());
        let output = runtime.get_output(pid);
        assert_eq!(output, vec!["42\n"]);
    }

    #[test]
    fn test_spawn_with_captured_value() {
        // Use let-binding to force closure capture (top-level vals are globals,
        // not captured by closures in the child VM)
        let program = compile(
            "fun make_spawner x = spawn (fn () => x + 32)\n\
             val child = make_spawner 10\n\
             val result = await_process child\n\
             val _ = println (int_to_string result)",
        );
        let mut runtime = Runtime::new();
        let pid = runtime.spawn_root(program);
        runtime.run_to_completion().unwrap();
        let output = runtime.get_output(pid);
        assert_eq!(output, vec!["42\n"]);
    }

    #[test]
    fn test_spawn_two_children() {
        let program = compile(
            "val c1 = spawn (fn () => 10)\n\
             val c2 = spawn (fn () => 20)\n\
             val r1 = await_process c1\n\
             val r2 = await_process c2\n\
             val _ = println (int_to_string (r1 + r2))",
        );
        let mut runtime = Runtime::new();
        let pid = runtime.spawn_root(program);
        runtime.run_to_completion().unwrap();
        let output = runtime.get_output(pid);
        assert_eq!(output, vec!["30\n"]);
    }

    #[test]
    fn test_send_receive_basic() {
        // Child receives a message and returns it
        let program = compile(
            "val child = spawn (fn () =>\n\
               let val (msg : Int) = receive_message ()\n\
               in msg end)\n\
             val _ = send_message (child, 99)\n\
             val result = await_process child\n\
             val _ = println (int_to_string result)",
        );
        let mut runtime = Runtime::new();
        let pid = runtime.spawn_root(program);
        runtime.run_to_completion().unwrap();
        let output = runtime.get_output(pid);
        assert_eq!(output, vec!["99\n"]);
    }

    #[test]
    fn test_send_receive_fifo_order() {
        // Child receives 3 messages, returns their sum
        let program = compile(
            "val child = spawn (fn () =>\n\
               let val (a : Int) = receive_message ()\n\
                   val (b : Int) = receive_message ()\n\
                   val (c : Int) = receive_message ()\n\
               in a + b + c end)\n\
             val _ = send_message (child, 10)\n\
             val _ = send_message (child, 20)\n\
             val _ = send_message (child, 30)\n\
             val result = await_process child\n\
             val _ = println (int_to_string result)",
        );
        let mut runtime = Runtime::new();
        let pid = runtime.spawn_root(program);
        runtime.run_to_completion().unwrap();
        let output = runtime.get_output(pid);
        assert_eq!(output, vec!["60\n"]);
    }

    #[test]
    fn test_receive_blocks_until_message() {
        // Child calls receive before parent sends
        let program = compile(
            "val child = spawn (fn () =>\n\
               let val (msg : Int) = receive_message ()\n\
               in msg end)\n\
             val _ = send_message (child, 42)\n\
             val result = await_process child\n\
             val _ = println (int_to_string result)",
        );
        let mut runtime = Runtime::new();
        let pid = runtime.spawn_root(program);
        runtime.run_to_completion().unwrap();
        let output = runtime.get_output(pid);
        assert_eq!(output, vec!["42\n"]);
    }

    #[test]
    fn test_send_to_dead_process() {
        let program = compile("val _ = send_message (999, 42)");
        let mut runtime = Runtime::new();
        let pid = runtime.spawn_root(program);
        runtime.run_to_completion().unwrap();
        match &runtime.processes[&pid].status {
            ProcessStatus::Failed(msg) => assert!(msg.contains("unknown process")),
            other => panic!("expected Failed, got {:?}", other),
        }
    }
}