harn_vm/vm/ops/
mod.rs

1//! VM opcode dispatch.
2//!
3//! The `Op` enum, the byte-to-variant mapping, the sync and async
4//! dispatch tables, the disassembly renderer, and the per-opcode
5//! classification helpers (`op_reads_outer_name`, `is_adaptive_binary_op`)
6//! are all emitted by `harn_opcode_macros::define_opcodes!` from the
7//! single declarative table below. Adding or renaming an opcode is now a
8//! one-line edit instead of paired edits to four hand-maintained match
9//! tables — see issue #2584 for the migration that collapsed them.
10//!
11//! Each entry follows the shape
12//!
13//! ```ignore
14//! VariantName { <kind>(<expr>...), disasm: <helper>("<LABEL>") [, flags: [...]] };
15//! ```
16//!
17//! where `<kind>` selects the dispatch shape (`sync`, `sync_void`,
18//! `sync_return`, `split`, `async_op`) and the `<helper>` resolves to a
19//! `disasm_<helper>` free fn in `crate::chunk`.
20
21mod arithmetic;
22mod call;
23mod call_named;
24mod call_support;
25mod collections;
26mod comparison;
27mod control_flow;
28mod exception;
29mod imports;
30mod iter;
31mod logical;
32mod misc;
33mod parallel;
34mod stack;
35
36use std::future::Future;
37use std::pin::Pin;
38use std::task::{Context, Poll};
39
40use pin_project_lite::pin_project;
41
42use crate::value::{VmError, VmValue};
43
44pin_project! {
45    /// Keeps the large generated async-opcode state machine out of each caller
46    /// without moving the future off the stack.
47    struct OpcodeDispatchFuture<F> {
48        #[pin]
49        inner: F,
50    }
51}
52
53impl<F> OpcodeDispatchFuture<F> {
54    fn new(inner: F) -> Self {
55        Self { inner }
56    }
57}
58
59impl<F: Future> Future for OpcodeDispatchFuture<F> {
60    type Output = F::Output;
61
62    #[inline(never)]
63    fn poll(self: Pin<&mut Self>, context: &mut Context<'_>) -> Poll<Self::Output> {
64        self.project().inner.poll(context)
65    }
66}
67
68harn_opcode_macros::define_opcodes! {
69    // === Constants & nil ===
70    Constant { sync(self.execute_constant()), disasm: const_pool_u16("CONSTANT") };
71    Nil { sync_void(self.execute_nil()), disasm: bare("NIL") };
72    True { sync_void(self.execute_true()), disasm: bare("TRUE") };
73    False { sync_void(self.execute_false()), disasm: bare("FALSE") };
74
75    // === Variables ===
76    GetVar { sync(self.execute_get_var()), disasm: const_pool_u16("GET_VAR"), flags: [reads_outer_name] };
77    DefLet { sync(self.execute_def_let()), disasm: const_pool_u16("DEF_LET") };
78    DefVar { sync(self.execute_def_var()), disasm: const_pool_u16("DEF_VAR") };
79    DefCell { sync(self.execute_def_cell()), disasm: const_pool_u16("DEF_CELL") };
80    SetVar { sync(self.execute_set_var()), disasm: const_pool_u16("SET_VAR"), flags: [reads_outer_name] };
81    PushScope { sync_void(self.execute_push_scope()), disasm: bare("PUSH_SCOPE") };
82    PopScope { sync_void(self.execute_pop_scope()), disasm: bare("POP_SCOPE") };
83
84    // === Generic arithmetic (adaptive binary IC) ===
85    Add { sync(self.execute_add()), disasm: bare("ADD"), flags: [adaptive_binary] };
86    Sub { sync(self.execute_sub()), disasm: bare("SUB"), flags: [adaptive_binary] };
87    Mul { sync(self.execute_mul()), disasm: bare("MUL"), flags: [adaptive_binary] };
88    Div { sync(self.execute_div()), disasm: bare("DIV"), flags: [adaptive_binary] };
89    Mod { sync(self.execute_mod()), disasm: bare("MOD"), flags: [adaptive_binary] };
90    Pow { sync(self.execute_pow()), disasm: bare("POW") };
91    Negate { sync(self.execute_negate()), disasm: bare("NEGATE") };
92
93    // === Generic comparison (adaptive binary IC) ===
94    Equal { sync(self.execute_equal()), disasm: bare("EQUAL"), flags: [adaptive_binary] };
95    NotEqual { sync(self.execute_not_equal()), disasm: bare("NOT_EQUAL"), flags: [adaptive_binary] };
96    Less { sync(self.execute_less()), disasm: bare("LESS"), flags: [adaptive_binary] };
97    Greater { sync(self.execute_greater()), disasm: bare("GREATER"), flags: [adaptive_binary] };
98    LessEqual { sync(self.execute_less_equal()), disasm: bare("LESS_EQUAL"), flags: [adaptive_binary] };
99    GreaterEqual { sync(self.execute_greater_equal()), disasm: bare("GREATER_EQUAL"), flags: [adaptive_binary] };
100
101    // === Logical ===
102    Not { sync(self.execute_not()), disasm: bare("NOT") };
103
104    // === Control flow ===
105    Jump { sync_void(self.execute_jump()), disasm: u16("JUMP") };
106    JumpIfFalse { sync(self.execute_jump_if_false()), disasm: u16("JUMP_IF_FALSE") };
107    JumpIfTrue { sync(self.execute_jump_if_true()), disasm: u16("JUMP_IF_TRUE") };
108    Pop { sync(self.execute_pop()), disasm: bare("POP") };
109
110    // === Functions ===
111    Call { split(self.execute_call_sync(), self.execute_call_async().await), disasm: u8("CALL"), flags: [reads_outer_name] };
112    TailCall { split(self.execute_tail_call_sync(), self.execute_tail_call_async().await), disasm: u8("TAIL_CALL"), flags: [reads_outer_name] };
113    Return { sync_return(self.execute_return()), disasm: bare("RETURN") };
114    Closure { sync_void(self.execute_closure()), disasm: u16("CLOSURE") };
115
116    // === Collections ===
117    BuildList { sync_void(self.execute_build_list()), disasm: u16("BUILD_LIST") };
118    BuildDict { sync_void(self.execute_build_dict()), disasm: u16("BUILD_DICT") };
119    Subscript { sync(self.execute_subscript(false)), disasm: bare("SUBSCRIPT") };
120    SubscriptOpt { sync(self.execute_subscript(true)), disasm: bare("SUBSCRIPT_OPT") };
121    Slice { sync(self.execute_slice()), disasm: bare("SLICE") };
122
123    // === Object operations ===
124    GetProperty { sync(self.execute_get_property(false)), disasm: const_pool_u16("GET_PROPERTY") };
125    GetPropertyOpt { sync(self.execute_get_property(true)), disasm: const_pool_u16("GET_PROPERTY_OPT") };
126    SetProperty { sync(self.execute_set_property()), disasm: const_pool_u16("SET_PROPERTY") };
127    SetSubscript { sync(self.execute_set_subscript()), disasm: const_pool_u16("SET_SUBSCRIPT") };
128    SetLocalSlotProperty { sync(self.execute_set_local_slot_property()), disasm: const_pool_local_slot("SET_LOCAL_SLOT_PROPERTY") };
129    SetLocalSlotSubscript { sync(self.execute_set_local_slot_subscript()), disasm: local_slot_u16("SET_LOCAL_SLOT_SUBSCRIPT") };
130    MethodCall { split(self.execute_method_call_sync(false), self.execute_method_call(false).await), disasm: method_call("METHOD_CALL") };
131    MethodCallOpt { split(self.execute_method_call_sync(true), self.execute_method_call(true).await), disasm: method_call("METHOD_CALL_OPT") };
132
133    // === Strings ===
134    Concat { sync_void(self.execute_concat()), disasm: u16("CONCAT") };
135
136    // === Iteration ===
137    IterInit { sync(self.execute_iter_init()), disasm: bare("ITER_INIT") };
138    IterNext { split(self.execute_iter_next_sync(), self.execute_iter_next_async().await), disasm: u16("ITER_NEXT") };
139
140    // === Pipe (async) ===
141    Pipe { async_op(self.execute_pipe().await), disasm: bare("PIPE"), flags: [reads_outer_name] };
142
143    // === Error handling ===
144    Throw { sync(self.execute_throw()), disasm: bare("THROW") };
145    TryCatchSetup { sync_void(self.execute_try_catch_setup()), disasm: try_catch_setup("TRY_CATCH_SETUP") };
146    PopHandler { sync_void(self.execute_pop_handler()), disasm: bare("POP_HANDLER") };
147
148    // === Concurrency ===
149    Parallel { async_op(self.execute_parallel().await), disasm: bare("PARALLEL") };
150    ParallelMap { async_op(self.execute_parallel_map().await), disasm: bare("PARALLEL_MAP") };
151    ParallelMapStream { async_op(self.execute_parallel_map_stream().await), disasm: bare("PARALLEL_MAP_STREAM") };
152    ParallelSettle { async_op(self.execute_parallel_settle().await), disasm: bare("PARALLEL_SETTLE") };
153    Spawn { sync(self.execute_spawn()), disasm: bare("SPAWN") };
154    SyncMutexEnter { async_op(self.execute_sync_mutex_enter().await), disasm: bare("SYNC_MUTEX_ENTER") };
155    SyncMutexEnterKeyed { async_op(self.execute_sync_mutex_enter_keyed().await), disasm: bare("SYNC_MUTEX_ENTER_KEYED") };
156    TaskScopeEnter { sync_void(self.execute_task_scope_enter()), disasm: bare("TASK_SCOPE_ENTER") };
157    TaskScopeExit { async_op(self.execute_task_scope_exit().await), disasm: bare("TASK_SCOPE_EXIT") };
158
159    // === Imports (async) ===
160    Import { async_op(self.execute_import_op().await), disasm: const_pool_u16("IMPORT") };
161    SelectiveImport { async_op(self.execute_selective_import().await), disasm: selective_import("SELECTIVE_IMPORT") };
162
163    // === Deadline ===
164    DeadlineSetup { sync(self.execute_deadline_setup()), disasm: bare("DEADLINE_SETUP") };
165    DeadlineEnd { sync_void(self.execute_deadline_end()), disasm: bare("DEADLINE_END") };
166
167    // === Enum ===
168    BuildEnum { sync(self.execute_build_enum()), disasm: build_enum("BUILD_ENUM") };
169    MatchEnum { sync(self.execute_match_enum()), disasm: match_enum("MATCH_ENUM") };
170
171    // === Loop control ===
172    PopIterator { sync_void(self.execute_pop_iterator()), disasm: bare("POP_ITERATOR") };
173
174    // === Defaults ===
175    GetArgc { sync_void(self.execute_get_argc()), disasm: bare("GET_ARGC") };
176
177    // === Type checking ===
178    CheckType { sync(self.execute_check_type()), disasm: check_type("CHECK_TYPE"), flags: [reads_outer_name] };
179
180    // === Result try operator ===
181    TryUnwrap { sync(self.execute_try_unwrap()), disasm: bare("TRY_UNWRAP") };
182    TryWrapOk { sync(self.execute_try_wrap_ok()), disasm: bare("TRY_WRAP_OK") };
183
184    // === Spread calls ===
185    CallSpread { async_op(self.execute_call_spread().await), disasm: bare("CALL_SPREAD"), flags: [reads_outer_name] };
186    CallBuiltin { split(self.execute_call_builtin_sync(), self.execute_call_builtin_async().await), disasm: call_builtin("CALL_BUILTIN"), flags: [reads_outer_name] };
187    CallBuiltinSpread { async_op(self.execute_call_builtin_spread().await), disasm: call_builtin_spread("CALL_BUILTIN_SPREAD"), flags: [reads_outer_name] };
188    MethodCallSpread { async_op(self.execute_method_call_spread().await), disasm: method_call_spread("METHOD_CALL_SPREAD") };
189
190    // === Misc ===
191    Dup { sync(self.execute_dup()), disasm: bare("DUP") };
192    Swap { sync_void(self.execute_swap()), disasm: bare("SWAP") };
193    Contains { sync(self.execute_contains()), disasm: bare("CONTAINS") };
194
195    // === Typed arithmetic fast paths ===
196    AddInt { sync(self.execute_add_int()), disasm: bare("ADD_INT") };
197    SubInt { sync(self.execute_sub_int()), disasm: bare("SUB_INT") };
198    MulInt { sync(self.execute_mul_int()), disasm: bare("MUL_INT") };
199    DivInt { sync(self.execute_div_int()), disasm: bare("DIV_INT") };
200    ModInt { sync(self.execute_mod_int()), disasm: bare("MOD_INT") };
201    AddFloat { sync(self.execute_add_float()), disasm: bare("ADD_FLOAT") };
202    SubFloat { sync(self.execute_sub_float()), disasm: bare("SUB_FLOAT") };
203    MulFloat { sync(self.execute_mul_float()), disasm: bare("MUL_FLOAT") };
204    DivFloat { sync(self.execute_div_float()), disasm: bare("DIV_FLOAT") };
205    ModFloat { sync(self.execute_mod_float()), disasm: bare("MOD_FLOAT") };
206
207    // === Typed comparison fast paths ===
208    EqualInt { sync(self.execute_equal_int()), disasm: bare("EQUAL_INT") };
209    NotEqualInt { sync(self.execute_not_equal_int()), disasm: bare("NOT_EQUAL_INT") };
210    LessInt { sync(self.execute_less_int()), disasm: bare("LESS_INT") };
211    GreaterInt { sync(self.execute_greater_int()), disasm: bare("GREATER_INT") };
212    LessEqualInt { sync(self.execute_less_equal_int()), disasm: bare("LESS_EQUAL_INT") };
213    GreaterEqualInt { sync(self.execute_greater_equal_int()), disasm: bare("GREATER_EQUAL_INT") };
214    EqualFloat { sync(self.execute_equal_float()), disasm: bare("EQUAL_FLOAT") };
215    NotEqualFloat { sync(self.execute_not_equal_float()), disasm: bare("NOT_EQUAL_FLOAT") };
216    LessFloat { sync(self.execute_less_float()), disasm: bare("LESS_FLOAT") };
217    GreaterFloat { sync(self.execute_greater_float()), disasm: bare("GREATER_FLOAT") };
218    LessEqualFloat { sync(self.execute_less_equal_float()), disasm: bare("LESS_EQUAL_FLOAT") };
219    GreaterEqualFloat { sync(self.execute_greater_equal_float()), disasm: bare("GREATER_EQUAL_FLOAT") };
220    EqualBool { sync(self.execute_equal_bool()), disasm: bare("EQUAL_BOOL") };
221    NotEqualBool { sync(self.execute_not_equal_bool()), disasm: bare("NOT_EQUAL_BOOL") };
222    EqualString { sync(self.execute_equal_string()), disasm: bare("EQUAL_STRING") };
223    NotEqualString { sync(self.execute_not_equal_string()), disasm: bare("NOT_EQUAL_STRING") };
224
225    // === Generators (async) ===
226    Yield { async_op(self.execute_yield().await), disasm: bare("YIELD") };
227
228    // === Slot-indexed locals ===
229    GetLocalSlot { sync(self.execute_get_local_slot()), disasm: local_slot_u16("GET_LOCAL_SLOT") };
230    DefLocalSlot { sync(self.execute_def_local_slot()), disasm: local_slot_u16("DEF_LOCAL_SLOT") };
231    SetLocalSlot { sync(self.execute_set_local_slot()), disasm: local_slot_u16("SET_LOCAL_SLOT") };
232    ConcatAssignLocal { sync(self.execute_concat_assign_local()), disasm: local_slot_u16("CONCAT_ASSIGN_LOCAL") };
233}
234
235impl super::Vm {
236    /// Execute a single opcode. Used by the scope-interrupt wrapper that
237    /// drives cancellable / deadlined execution; the hot interpreter loop
238    /// in `run_chunk_ref` bypasses this and calls `execute_op_sync` /
239    /// `execute_op_async` directly when no interrupt machinery is armed.
240    pub(super) async fn execute_op(&mut self, op_byte: u8) -> Result<Option<VmValue>, VmError> {
241        let op = Op::from_byte(op_byte).ok_or(VmError::InvalidInstruction(op_byte))?;
242        if let Some(result) = self.execute_op_sync(op) {
243            result?;
244            return Ok(None);
245        }
246        self.execute_op_async(op).await?;
247        Ok(None)
248    }
249}
harn_vm/vm/ops/mod.rs

harn_vm/vm/ops/
mod.rs
