harn-vm 0.8.30

Async bytecode virtual machine for the Harn programming 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
use std::collections::BTreeMap;
use std::rc::Rc;

use crate::value::{VmError, VmValue};

fn range_initial_done(start: i64, end: i64, inclusive: bool) -> bool {
    if inclusive {
        start > end
    } else {
        start >= end
    }
}

fn range_next(next: &mut i64, end: i64, inclusive: bool, done: &mut bool) -> Option<i64> {
    if *done {
        return None;
    }
    let value = *next;
    let at_end = if inclusive {
        value >= end
    } else {
        value
            .checked_add(1)
            .is_none_or(|candidate| candidate >= end)
    };
    if at_end {
        *done = true;
    } else {
        *next += 1;
    }
    Some(value)
}

impl super::super::Vm {
    pub(super) fn execute_iter_init(&mut self) -> Result<(), VmError> {
        let iterable = self.pop()?;
        match iterable {
            VmValue::List(items) => {
                self.iterators
                    .push(super::super::IterState::Vec { items, idx: 0 });
            }
            VmValue::Dict(map) => {
                let keys = map.keys().cloned().collect();
                self.iterators.push(super::super::IterState::Dict {
                    entries: map,
                    keys,
                    idx: 0,
                });
            }
            VmValue::Set(items) => {
                self.iterators
                    .push(super::super::IterState::Vec { items, idx: 0 });
            }
            VmValue::Channel(ch) => {
                self.iterators.push(super::super::IterState::Channel {
                    receiver: ch.receiver.clone(),
                    closed: ch.closed.clone(),
                });
            }
            VmValue::Generator(gen) => {
                self.iterators
                    .push(super::super::IterState::Generator { gen });
            }
            VmValue::Stream(stream) => {
                self.iterators
                    .push(super::super::IterState::Stream { stream });
            }
            VmValue::Range(r) => {
                self.iterators.push(super::super::IterState::Range {
                    next: r.start,
                    end: r.end,
                    inclusive: r.inclusive,
                    done: range_initial_done(r.start, r.end, r.inclusive),
                });
            }
            VmValue::Iter(handle) => {
                self.iterators
                    .push(super::super::IterState::VmIter { handle });
            }
            _ => {
                self.iterators.push(super::super::IterState::Vec {
                    items: Rc::new(Vec::new()),
                    idx: 0,
                });
            }
        }
        Ok(())
    }

    /// Sync fast path for the `for-in` step opcode. Handles the Vec / Dict /
    /// Range / no-iterator-active arms inline (the >99% case in real Harn
    /// programs), returning `Some(Ok(()))` on a normal step or
    /// `Some(Err(_))` on a runtime error.
    ///
    /// Returns `None` without touching `ip` when the active iterator
    /// requires `.await` (Channel / Generator / Stream / VmIter); the
    /// caller must fall through to [`execute_iter_next_async`]. Keeping
    /// `ip` untouched on the async hand-off lets the async path read the
    /// same operand the sync path would have, with no rewinding gymnastics.
    pub(super) fn execute_iter_next_sync(&mut self) -> Option<Result<(), VmError>> {
        // Classify the iterator variant before reading the bytecode operand.
        // Channel/Generator/Stream/VmIter all suspend on a receiver lock or
        // a host-side iterator, so they belong on the async path. Leaving
        // `ip` untouched on hand-off means `execute_iter_next_async` reads
        // the operand exactly once.
        match self.iterators.last() {
            None
            | Some(super::super::IterState::Vec { .. })
            | Some(super::super::IterState::Dict { .. })
            | Some(super::super::IterState::Range { .. }) => {}
            Some(_) => return None,
        }

        let frame = self.frames.last_mut().unwrap();
        let target = frame.chunk.read_u16(frame.ip) as usize;
        frame.ip += 2;

        match self.iterators.last_mut() {
            Some(super::super::IterState::Vec { items, idx }) => {
                if *idx < items.len() {
                    let item = items[*idx].clone();
                    *idx += 1;
                    self.stack.push(item);
                } else {
                    self.iterators.pop();
                    let frame = self.frames.last_mut().unwrap();
                    frame.ip = target;
                }
            }
            Some(super::super::IterState::Dict { entries, keys, idx }) => {
                if *idx < keys.len() {
                    let key = &keys[*idx];
                    let value = entries.get(key).cloned().unwrap_or(VmValue::Nil);
                    let entry_key = VmValue::String(Rc::from(key.as_str()));
                    *idx += 1;
                    self.stack.push(VmValue::Dict(Rc::new(BTreeMap::from([
                        ("key".to_string(), entry_key),
                        ("value".to_string(), value),
                    ]))));
                } else {
                    self.iterators.pop();
                    let frame = self.frames.last_mut().unwrap();
                    frame.ip = target;
                }
            }
            Some(super::super::IterState::Range {
                next,
                end,
                inclusive,
                done,
            }) => {
                if let Some(v) = range_next(next, *end, *inclusive, done) {
                    self.stack.push(VmValue::Int(v));
                } else {
                    self.iterators.pop();
                    let frame = self.frames.last_mut().unwrap();
                    frame.ip = target;
                }
            }
            None => {
                let frame = self.frames.last_mut().unwrap();
                frame.ip = target;
            }
            // The variant guard above already routed Channel/Generator/
            // Stream/VmIter to the async path before we touched `ip`.
            Some(_) => unreachable!("async iterator variant reached sync path"),
        }
        Some(Ok(()))
    }

    /// Async slow path for `for-in` step. Handles Channel / Generator /
    /// Stream / VmIter — the four iterator variants that actually suspend.
    /// Reading the jump-on-exhaustion `target` (and advancing `ip`) happens
    /// here so the sync fast path can return early without consuming
    /// bytecode when it sees an async-only iterator state.
    pub(super) async fn execute_iter_next_async(&mut self) -> Result<(), VmError> {
        let frame = self.frames.last_mut().unwrap();
        let target = frame.chunk.read_u16(frame.ip) as usize;
        frame.ip += 2;
        // Clone the handle so we don't hold a borrow on self.iterators across
        // the async next() call.
        let vm_iter_handle = match self.iterators.last() {
            Some(super::super::IterState::VmIter { handle }) => Some(handle.clone()),
            _ => None,
        };
        if let Some(handle) = vm_iter_handle {
            // Safe for recursive VM reentry via closures as long as they don't
            // re-enter the same iter handle.
            let next_val = crate::vm::iter::next_handle(&handle, self).await?;
            match next_val {
                Some(v) => self.stack.push(v),
                None => {
                    self.iterators.pop();
                    let frame = self.frames.last_mut().unwrap();
                    frame.ip = target;
                }
            }
            return Ok(());
        }

        match self.iterators.last_mut() {
            Some(super::super::IterState::Channel { receiver, closed }) => {
                let rx = receiver.clone();
                let is_closed = closed.load(std::sync::atomic::Ordering::Relaxed);
                let mut guard = rx.lock().await;
                // Closed sender: drain without blocking.
                let item = if is_closed {
                    guard.try_recv().ok()
                } else {
                    guard.recv().await
                };
                match item {
                    Some(val) => {
                        self.stack.push(val);
                    }
                    None => {
                        drop(guard);
                        self.iterators.pop();
                        let frame = self.frames.last_mut().unwrap();
                        frame.ip = target;
                    }
                }
            }
            Some(super::super::IterState::Generator { gen }) => {
                if gen.done.get() {
                    self.iterators.pop();
                    let frame = self.frames.last_mut().unwrap();
                    frame.ip = target;
                } else {
                    let rx = gen.receiver.clone();
                    let mut guard = rx.lock().await;
                    match guard.recv().await {
                        Some(Ok(val)) => {
                            self.stack.push(val);
                        }
                        Some(Err(error)) => {
                            gen.done.set(true);
                            drop(guard);
                            self.iterators.pop();
                            return Err(error);
                        }
                        None => {
                            gen.done.set(true);
                            drop(guard);
                            self.iterators.pop();
                            let frame = self.frames.last_mut().unwrap();
                            frame.ip = target;
                        }
                    }
                }
            }
            Some(super::super::IterState::Stream { stream }) => {
                if stream.done.get() {
                    self.iterators.pop();
                    let frame = self.frames.last_mut().unwrap();
                    frame.ip = target;
                } else {
                    let rx = stream.receiver.clone();
                    let mut guard = rx.lock().await;
                    match guard.recv().await {
                        Some(Ok(val)) => {
                            self.stack.push(val);
                        }
                        Some(Err(error)) => {
                            stream.done.set(true);
                            drop(guard);
                            self.iterators.pop();
                            return Err(error);
                        }
                        None => {
                            stream.done.set(true);
                            drop(guard);
                            self.iterators.pop();
                            let frame = self.frames.last_mut().unwrap();
                            frame.ip = target;
                        }
                    }
                }
            }
            // VmIter was handled above; sync variants belong on the sync
            // path; an empty iterator stack would have been routed to the
            // sync path too. Reaching this branch means the sync/async
            // classification in `execute_iter_next_sync` drifted from the
            // arms above.
            _ => {
                debug_assert!(
                    false,
                    "execute_iter_next_async reached non-async iterator state — \
                     dispatch tables in execute_iter_next_sync / execute_iter_next_async \
                     are out of sync"
                );
                return Err(VmError::Runtime(
                    "internal VM dispatch error: iter_next async slow path \
                     reached a non-async iterator state"
                        .into(),
                ));
            }
        }
        Ok(())
    }

    pub(super) fn execute_pop_iterator(&mut self) {
        if let Some(super::super::IterState::Stream { stream }) = self.iterators.pop() {
            stream.cancel();
        }
    }
}

#[cfg(test)]
mod tests {
    use super::*;
    use crate::vm::{IterState, Vm};

    fn run_iter_init_test(test: impl std::future::Future<Output = ()>) {
        let rt = tokio::runtime::Builder::new_current_thread()
            .enable_all()
            .build()
            .unwrap();
        rt.block_on(test);
    }

    #[test]
    fn iter_init_list_keeps_shared_backing_store() {
        run_iter_init_test(async {
            let items = Rc::new(vec![VmValue::Int(1), VmValue::Int(2)]);
            let mut vm = Vm::new();
            vm.stack.push(VmValue::List(items.clone()));

            vm.execute_iter_init().unwrap();

            match vm.iterators.last().unwrap() {
                IterState::Vec {
                    items: iter_items,
                    idx,
                } => {
                    assert!(Rc::ptr_eq(&items, iter_items));
                    assert_eq!(*idx, 0);
                }
                _ => panic!("expected vec iterator state"),
            }
        });
    }

    #[test]
    fn iter_init_set_keeps_shared_backing_store() {
        run_iter_init_test(async {
            let items = Rc::new(vec![VmValue::Int(1), VmValue::Int(2)]);
            let mut vm = Vm::new();
            vm.stack.push(VmValue::Set(items.clone()));

            vm.execute_iter_init().unwrap();

            match vm.iterators.last().unwrap() {
                IterState::Vec {
                    items: iter_items,
                    idx,
                } => {
                    assert!(Rc::ptr_eq(&items, iter_items));
                    assert_eq!(*idx, 0);
                }
                _ => panic!("expected vec iterator state"),
            }
        });
    }

    #[test]
    fn iter_init_dict_keeps_shared_entries_and_snapshots_keys() {
        run_iter_init_test(async {
            let entries = Rc::new(BTreeMap::from([
                ("a".to_string(), VmValue::Int(1)),
                ("b".to_string(), VmValue::Int(2)),
            ]));
            let mut vm = Vm::new();
            vm.stack.push(VmValue::Dict(entries.clone()));

            vm.execute_iter_init().unwrap();

            match vm.iterators.last().unwrap() {
                IterState::Dict {
                    entries: iter_entries,
                    keys,
                    idx,
                } => {
                    assert!(Rc::ptr_eq(&entries, iter_entries));
                    assert_eq!(keys.as_slice(), ["a".to_string(), "b".to_string()]);
                    assert_eq!(*idx, 0);
                }
                _ => panic!("expected dict iterator state"),
            }
        });
    }

    #[test]
    fn iter_init_inclusive_range_at_i64_max_is_not_empty() {
        run_iter_init_test(async {
            let mut vm = Vm::new();
            vm.stack.push(VmValue::Range(crate::value::VmRange {
                start: i64::MAX,
                end: i64::MAX,
                inclusive: true,
            }));

            vm.execute_iter_init().unwrap();

            match vm.iterators.last().unwrap() {
                IterState::Range {
                    next,
                    end,
                    inclusive,
                    done,
                } => {
                    assert_eq!(*next, i64::MAX);
                    assert_eq!(*end, i64::MAX);
                    assert!(*inclusive);
                    assert!(!*done);
                }
                _ => panic!("expected range iterator state"),
            }
        });
    }
}