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
use crate::{
TulispObject,
object::wrappers::{DefunFn, TulispFn, generic::Shared},
};
use super::bytecode::CompiledDefun;
use super::lambda_template::LambdaTemplate;
#[derive(Clone)]
pub(crate) enum Pos {
Abs(usize),
Rel(isize),
Label(TulispObject),
}
impl std::fmt::Display for Pos {
fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
match self {
Pos::Abs(p) => write!(f, "{}", p),
Pos::Rel(p) => write!(f, ". {}", p),
Pos::Label(p) => write!(f, "{}", p),
}
}
}
#[derive(Clone, Copy)]
pub(crate) enum Cxr {
Car,
Cdr,
Caar,
Cadr,
Cdar,
Cddr,
Caaar,
Caadr,
Cadar,
Caddr,
Cdaar,
Cdadr,
Cddar,
Cdddr,
Caaaar,
Caaadr,
Caadar,
Caaddr,
Cadaar,
Cadadr,
Caddar,
Cadddr,
Cdaaar,
Cdaadr,
Cdadar,
Cdaddr,
Cddaar,
Cddadr,
Cdddar,
Cddddr,
}
#[derive(Clone, Copy)]
pub(crate) enum BinaryOp {
Add,
Sub,
Mul,
Div,
}
/// A single instruction in the VM.
#[derive(Clone)]
pub(crate) enum Instruction {
// stack
Push(TulispObject),
Pop,
// variables
Set,
SetPop,
StorePop(TulispObject),
Store(TulispObject),
Load(TulispObject),
BeginScope(TulispObject),
EndScope(TulispObject),
// arithmetic
BinaryOp(BinaryOp),
// io
LoadFile,
PrintPop,
Print,
// comparison
Equal,
Eq,
Lt,
LtEq,
Gt,
GtEq,
// predicates
Null,
// control flow
JumpIfNil(Pos),
JumpIfNotNil(Pos),
JumpIfNilElsePop(Pos),
JumpIfNotNilElsePop(Pos),
JumpIfNeq(Pos),
JumpIfLt(Pos),
JumpIfLtEq(Pos),
JumpIfGt(Pos),
JumpIfGtEq(Pos),
Jump(Pos),
// functions
Label(TulispObject),
RustCall {
name: TulispObject,
/// Source AST of the full call form (`(name argsā¦)`),
/// recorded so an error from `func` carries the same outer
/// `at (form)` trace line that `eval_basic`'s `with_trace`
/// adds in the TW path.
form: TulispObject,
func: Shared<dyn TulispFn>,
keep_result: bool,
},
/// Like `RustCall` but for `ctx.defun`-registered fns. Args have
/// already been pushed on the stack (compiled with
/// `keep_result=true`); the handler pops `args_count` of them in
/// source order, hands them to `call(ctx, &args)`, and pushes the
/// result if `keep_result`. Avoids the `RustCall` re-entry path
/// because the closure never calls `ctx.eval`.
RustCallTyped {
name: TulispObject,
/// See `RustCall::form`.
form: TulispObject,
call: Shared<dyn DefunFn>,
args_count: usize,
keep_result: bool,
},
Call {
name: TulispObject,
/// See `RustCall::form`.
form: TulispObject,
args_count: usize,
function: Option<CompiledDefun>,
optional_count: usize,
rest_count: usize,
},
TailCall {
name: TulispObject,
/// See `RustCall::form`.
form: TulispObject,
args_count: usize,
function: Option<CompiledDefun>,
optional_count: usize,
rest_count: usize,
},
/// Instantiate an anonymous `(lambda ā¦)` at runtime: capture the
/// enclosing scope's slots for each free var, bind fresh slots for
/// params, rewrite the template's instruction vector with those
/// bindings, and push the resulting closure (as a
/// `TulispValue::CompiledDefun`) on the stack.
MakeLambda(Shared<LambdaTemplate>),
/// Inline `(funcall fn arg1 ā¦)` dispatch. The function value is
/// pushed first, then each arg, in source order (so at execution
/// the top of stack is the last arg, `args_count + 1` below it is
/// the function). Used to keep nested calls inside a VM run from
/// re-entering `eval::funcall` (which would re-borrow `ctx.vm`).
Funcall {
args_count: usize,
},
/// Inline `(apply fn arg1 ā¦ final-list)` dispatch. The function is
/// pushed first, then each intermediate arg, then the final list
/// (which must evaluate to a list at runtime; its elements are
/// spliced after the intermediate args). `args_count` is the
/// number of intermediate args ā the final list is on top of the
/// stack with `args_count + 1` items below it (the function and
/// the intermediate args). Same anti-reborrow rationale as
/// [`Funcall`](Self::Funcall).
Apply {
args_count: usize,
},
Ret,
/// Push `form` onto the machine's `trace_stack`. Errors that
/// propagate out of any subsequent instruction (until a matching
/// `PopTrace`) get `form` appended to their backtrace by the
/// `run_impl` wrapper. Mirrors how TW's `eval_basic` wraps every
/// list-form evaluation with `with_trace(expr)`. Emitted by
/// `compile_expr` around every list-form's compiled bytecode.
PushTrace(TulispObject),
PopTrace,
// lists
Cons,
List(usize),
Append(usize),
Cxr(Cxr),
PlistGet,
// values
Quote,
/// Pop one value and push it wrapped in a `TulispValue::Backquote`.
/// Emitted for nested backquotes ā the inner `\`X` becomes
/// `WrapBackquote` after compiling `X` at the bumped quasi-quote
/// depth.
WrapBackquote,
/// Pop one value and push it wrapped in `TulispValue::Unquote`.
/// Emitted at quasi-quote depth ā„ 2 for `,X` ā the inner is
/// compiled at `depth - 1` and the wrap re-emits the comma at
/// the outer level.
WrapUnquote,
/// Pop one value and push it wrapped in `TulispValue::Splice`.
/// Same as `WrapUnquote` but for `,@X` at quasi-quote depth ā„ 2.
WrapSplice,
}
impl std::fmt::Display for Instruction {
fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
match self {
Instruction::Push(obj) => write!(f, " push {}", obj),
Instruction::Pop => write!(f, " pop"),
Instruction::Set => write!(f, " set"),
Instruction::SetPop => write!(f, " set_pop"),
Instruction::StorePop(obj) => write!(f, " store_pop {}", obj),
Instruction::Store(obj) => write!(f, " store {}", obj),
Instruction::Load(obj) => write!(f, " load {}", obj),
Instruction::BeginScope(obj) => write!(f, " begin_scope {}", obj),
Instruction::EndScope(obj) => write!(f, " end_scope {}", obj),
Instruction::BinaryOp(op) => match op {
BinaryOp::Add => write!(f, " add"),
BinaryOp::Sub => write!(f, " sub"),
BinaryOp::Mul => write!(f, " mul"),
BinaryOp::Div => write!(f, " div"),
},
Instruction::LoadFile => write!(f, " load_file"),
Instruction::PrintPop => write!(f, " print_pop"),
Instruction::Print => write!(f, " print"),
Instruction::Null => write!(f, " null"),
Instruction::JumpIfNil(pos) => write!(f, " jnil {}", pos),
Instruction::JumpIfNotNil(pos) => write!(f, " jnnil {}", pos),
Instruction::JumpIfNilElsePop(pos) => write!(f, " jnil_else_pop {}", pos),
Instruction::JumpIfNotNilElsePop(pos) => write!(f, " jnnil_else_pop {}", pos),
Instruction::JumpIfNeq(pos) => write!(f, " jne {}", pos),
Instruction::JumpIfLt(pos) => write!(f, " jlt {}", pos),
Instruction::JumpIfLtEq(pos) => write!(f, " jle {}", pos),
Instruction::JumpIfGt(pos) => write!(f, " jgt {}", pos),
Instruction::JumpIfGtEq(pos) => write!(f, " jge {}", pos),
Instruction::Equal => write!(f, " equal"),
Instruction::Eq => write!(f, " ceq"),
Instruction::Lt => write!(f, " clt"),
Instruction::LtEq => write!(f, " cle"),
Instruction::Gt => write!(f, " cgt"),
Instruction::GtEq => write!(f, " cge"),
Instruction::Jump(pos) => write!(f, " jmp {}", pos),
Instruction::Call { name, .. } => write!(f, " call {}", name),
Instruction::TailCall { name, .. } => write!(f, " tcall {}", name),
Instruction::MakeLambda(_) => write!(f, " make_lambda"),
Instruction::Funcall { args_count } => write!(f, " funcall {}", args_count),
Instruction::Apply { args_count } => write!(f, " apply {}", args_count),
Instruction::Ret => write!(f, " ret"),
Instruction::PushTrace(obj) => write!(f, " push_trace {}", obj),
Instruction::PopTrace => write!(f, " pop_trace"),
Instruction::RustCall { name, .. } => write!(f, " rustcall {}", name),
Instruction::RustCallTyped {
name, args_count, ..
} => write!(f, " rustcall_typed {} {}", name, args_count),
Instruction::Label(name) => write!(f, "{}", name),
Instruction::Cons => write!(f, " cons"),
Instruction::List(len) => write!(f, " list {}", len),
Instruction::Append(len) => write!(f, " append {}", len),
Instruction::Cxr(cxr) => match cxr {
Cxr::Car => write!(f, " car"),
Cxr::Cdr => write!(f, " cdr"),
Cxr::Caar => write!(f, " caar"),
Cxr::Cadr => write!(f, " cadr"),
Cxr::Cdar => write!(f, " cdar"),
Cxr::Cddr => write!(f, " cddr"),
Cxr::Caaar => write!(f, " caaar"),
Cxr::Caadr => write!(f, " caadr"),
Cxr::Cadar => write!(f, " cadar"),
Cxr::Caddr => write!(f, " caddr"),
Cxr::Cdaar => write!(f, " cdaar"),
Cxr::Cdadr => write!(f, " cdadr"),
Cxr::Cddar => write!(f, " cddar"),
Cxr::Cdddr => write!(f, " cdddr"),
Cxr::Caaaar => write!(f, " caaaar"),
Cxr::Caaadr => write!(f, " caaadr"),
Cxr::Caadar => write!(f, " caadar"),
Cxr::Caaddr => write!(f, " caaddr"),
Cxr::Cadaar => write!(f, " cadaar"),
Cxr::Cadadr => write!(f, " cadadr"),
Cxr::Caddar => write!(f, " caddar"),
Cxr::Cadddr => write!(f, " cadddr"),
Cxr::Cdaaar => write!(f, " cdaaar"),
Cxr::Cdaadr => write!(f, " cdaadr"),
Cxr::Cdadar => write!(f, " cdadar"),
Cxr::Cdaddr => write!(f, " cdaddr"),
Cxr::Cddaar => write!(f, " cddaar"),
Cxr::Cddadr => write!(f, " cddadr"),
Cxr::Cdddar => write!(f, " cdddar"),
Cxr::Cddddr => write!(f, " cddddr"),
},
Instruction::PlistGet => write!(f, " plist_get"),
Instruction::Quote => write!(f, " quote"),
Instruction::WrapBackquote => write!(f, " wrap_backquote"),
Instruction::WrapUnquote => write!(f, " wrap_unquote"),
Instruction::WrapSplice => write!(f, " wrap_splice"),
}
}
}