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

harn_vm/vm/ops/
mod.rs
