Repository navigation
Expand file tree
/
Copy pathframe.rs
More file actions
2942 lines (2722 loc) · 119 KB
/
Copy pathframe.rs
File metadata and controls
2942 lines (2722 loc) · 119 KB
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
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
#[cfg(feature = "flame")]
use crate::bytecode::InstructionMetadata;
use crate::{
AsObject, Py, PyObject, PyObjectRef, PyPayload, PyRef, PyResult, TryFromObject, VirtualMachine,
builtins::{
PyBaseException, PyBaseExceptionRef, PyCode, PyCoroutine, PyDict, PyDictRef, PyGenerator,
PyInterpolation, PyList, PySet, PySlice, PyStr, PyStrInterned, PyStrRef, PyTemplate,
PyTraceback, PyType,
asyncgenerator::PyAsyncGenWrappedValue,
function::{PyCell, PyCellRef, PyFunction},
tuple::{PyTuple, PyTupleRef},
},
bytecode::{self, Instruction},
convert::{IntoObject, ToPyResult},
coroutine::Coro,
exceptions::ExceptionCtor,
function::{ArgMapping, Either, FuncArgs},
object::{Traverse, TraverseFn},
protocol::{PyIter, PyIterReturn},
scope::Scope,
stdlib::{builtins, typing},
types::PyTypeFlags,
vm::{Context, PyMethod},
};
use alloc::fmt;
use core::iter::zip;
#[cfg(feature = "threading")]
use core::sync::atomic;
use indexmap::IndexMap;
use itertools::Itertools;
use rustpython_common::{boxvec::BoxVec, lock::PyMutex, wtf8::Wtf8Buf};
use rustpython_compiler_core::SourceLocation;
pub type FrameRef = PyRef<Frame>;
/// The reason why we might be unwinding a block.
/// This could be return of function, exception being
/// raised, a break or continue being hit, etc..
#[derive(Clone, Debug)]
enum UnwindReason {
/// We are returning a value from a return statement.
Returning { value: PyObjectRef },
/// We hit an exception, so unwind any try-except and finally blocks. The exception should be
/// on top of the vm exception stack.
Raising { exception: PyBaseExceptionRef },
// NoWorries,
/// We are unwinding blocks, since we hit break
Break { target: bytecode::Label },
/// We are unwinding blocks since we hit a continue statements.
Continue { target: bytecode::Label },
}
#[derive(Debug)]
struct FrameState {
// We need 1 stack per frame
/// The main data frame of the stack machine
stack: BoxVec<Option<PyObjectRef>>,
/// index of last instruction ran
#[cfg(feature = "threading")]
lasti: u32,
}
#[cfg(feature = "threading")]
type Lasti = atomic::AtomicU32;
#[cfg(not(feature = "threading"))]
type Lasti = core::cell::Cell<u32>;
#[pyclass(module = false, name = "frame", traverse = "manual")]
pub struct Frame {
pub code: PyRef<PyCode>,
pub func_obj: Option<PyObjectRef>,
pub fastlocals: PyMutex<Box<[Option<PyObjectRef>]>>,
pub(crate) cells_frees: Box<[PyCellRef]>,
pub locals: ArgMapping,
pub globals: PyDictRef,
pub builtins: PyDictRef,
// on feature=threading, this is a duplicate of FrameState.lasti, but it's faster to do an
// atomic store than it is to do a fetch_add, for every instruction executed
/// index of last instruction ran
pub lasti: Lasti,
/// tracer function for this frame (usually is None)
pub trace: PyMutex<PyObjectRef>,
state: PyMutex<FrameState>,
// member
pub trace_lines: PyMutex<bool>,
pub temporary_refs: PyMutex<Vec<PyObjectRef>>,
}
impl PyPayload for Frame {
#[inline]
fn class(ctx: &Context) -> &'static Py<PyType> {
ctx.types.frame_type
}
}
unsafe impl Traverse for FrameState {
fn traverse(&self, tracer_fn: &mut TraverseFn<'_>) {
self.stack.traverse(tracer_fn);
}
}
unsafe impl Traverse for Frame {
fn traverse(&self, tracer_fn: &mut TraverseFn<'_>) {
self.code.traverse(tracer_fn);
self.func_obj.traverse(tracer_fn);
self.fastlocals.traverse(tracer_fn);
self.cells_frees.traverse(tracer_fn);
self.locals.traverse(tracer_fn);
self.globals.traverse(tracer_fn);
self.builtins.traverse(tracer_fn);
self.trace.traverse(tracer_fn);
self.state.traverse(tracer_fn);
self.temporary_refs.traverse(tracer_fn);
}
}
// Running a frame can result in one of the below:
pub enum ExecutionResult {
Return(PyObjectRef),
Yield(PyObjectRef),
}
/// A valid execution result, or an exception
type FrameResult = PyResult<Option<ExecutionResult>>;
impl Frame {
pub(crate) fn new(
code: PyRef<PyCode>,
scope: Scope,
builtins: PyDictRef,
closure: &[PyCellRef],
func_obj: Option<PyObjectRef>,
vm: &VirtualMachine,
) -> Self {
let nlocals = code.varnames.len();
let num_cells = code.cellvars.len();
let nfrees = closure.len();
let cells_frees: Box<[PyCellRef]> =
core::iter::repeat_with(|| PyCell::default().into_ref(&vm.ctx))
.take(num_cells)
.chain(closure.iter().cloned())
.collect();
// Extend fastlocals to include varnames + cellvars + freevars (localsplus)
let total_locals = nlocals + num_cells + nfrees;
let mut fastlocals_vec: Vec<Option<PyObjectRef>> = vec![None; total_locals];
// Store cell objects at cellvars and freevars positions
for (i, cell) in cells_frees.iter().enumerate() {
fastlocals_vec[nlocals + i] = Some(cell.clone().into());
}
let state = FrameState {
stack: BoxVec::new(code.max_stackdepth as usize),
#[cfg(feature = "threading")]
lasti: 0,
};
Self {
fastlocals: PyMutex::new(fastlocals_vec.into_boxed_slice()),
cells_frees,
locals: scope.locals,
globals: scope.globals,
builtins,
code,
func_obj,
lasti: Lasti::new(0),
state: PyMutex::new(state),
trace: PyMutex::new(vm.ctx.none()),
trace_lines: PyMutex::new(true),
temporary_refs: PyMutex::new(vec![]),
}
}
pub fn current_location(&self) -> SourceLocation {
self.code.locations[self.lasti() as usize - 1].0
}
pub fn lasti(&self) -> u32 {
#[cfg(feature = "threading")]
{
self.lasti.load(atomic::Ordering::Relaxed)
}
#[cfg(not(feature = "threading"))]
{
self.lasti.get()
}
}
pub fn locals(&self, vm: &VirtualMachine) -> PyResult<ArgMapping> {
let locals = &self.locals;
let code = &**self.code;
let map = &code.varnames;
let j = core::cmp::min(map.len(), code.varnames.len());
if !code.varnames.is_empty() {
let fastlocals = self.fastlocals.lock();
for (&k, v) in zip(&map[..j], &**fastlocals) {
match locals.mapping().ass_subscript(k, v.clone(), vm) {
Ok(()) => {}
Err(e) if e.fast_isinstance(vm.ctx.exceptions.key_error) => {}
Err(e) => return Err(e),
}
}
}
if !code.cellvars.is_empty() || !code.freevars.is_empty() {
let map_to_dict = |keys: &[&PyStrInterned], values: &[PyCellRef]| {
for (&k, v) in zip(keys, values) {
if let Some(value) = v.get() {
locals.mapping().ass_subscript(k, Some(value), vm)?;
} else {
match locals.mapping().ass_subscript(k, None, vm) {
Ok(()) => {}
Err(e) if e.fast_isinstance(vm.ctx.exceptions.key_error) => {}
Err(e) => return Err(e),
}
}
}
Ok(())
};
map_to_dict(&code.cellvars, &self.cells_frees)?;
if code.flags.contains(bytecode::CodeFlags::OPTIMIZED) {
map_to_dict(&code.freevars, &self.cells_frees[code.cellvars.len()..])?;
}
}
Ok(locals.clone())
}
}
impl Py<Frame> {
#[inline(always)]
fn with_exec<R>(&self, f: impl FnOnce(ExecutingFrame<'_>) -> R) -> R {
let mut state = self.state.lock();
let exec = ExecutingFrame {
code: &self.code,
fastlocals: &self.fastlocals,
cells_frees: &self.cells_frees,
locals: &self.locals,
globals: &self.globals,
builtins: &self.builtins,
lasti: &self.lasti,
object: self,
state: &mut state,
};
f(exec)
}
// #[cfg_attr(feature = "flame-it", flame("Frame"))]
pub fn run(&self, vm: &VirtualMachine) -> PyResult<ExecutionResult> {
self.with_exec(|mut exec| exec.run(vm))
}
pub(crate) fn resume(
&self,
value: Option<PyObjectRef>,
vm: &VirtualMachine,
) -> PyResult<ExecutionResult> {
self.with_exec(|mut exec| {
if let Some(value) = value {
exec.push_value(value)
}
exec.run(vm)
})
}
pub(crate) fn gen_throw(
&self,
vm: &VirtualMachine,
exc_type: PyObjectRef,
exc_val: PyObjectRef,
exc_tb: PyObjectRef,
) -> PyResult<ExecutionResult> {
self.with_exec(|mut exec| exec.gen_throw(vm, exc_type, exc_val, exc_tb))
}
pub fn yield_from_target(&self) -> Option<PyObjectRef> {
self.with_exec(|exec| exec.yield_from_target().map(PyObject::to_owned))
}
pub fn is_internal_frame(&self) -> bool {
let code = self.f_code();
let filename = code.co_filename();
let filename_s = filename.as_str();
filename_s.contains("importlib") && filename_s.contains("_bootstrap")
}
pub fn next_external_frame(&self, vm: &VirtualMachine) -> Option<FrameRef> {
self.f_back(vm).map(|mut back| {
loop {
back = if let Some(back) = back.to_owned().f_back(vm) {
back
} else {
break back;
};
if !back.is_internal_frame() {
break back;
}
}
})
}
}
/// An executing frame; essentially just a struct to combine the immutable data outside the mutex
/// with the mutable data inside
struct ExecutingFrame<'a> {
code: &'a PyRef<PyCode>,
fastlocals: &'a PyMutex<Box<[Option<PyObjectRef>]>>,
cells_frees: &'a [PyCellRef],
locals: &'a ArgMapping,
globals: &'a PyDictRef,
builtins: &'a PyDictRef,
object: &'a Py<Frame>,
lasti: &'a Lasti,
state: &'a mut FrameState,
}
impl fmt::Debug for ExecutingFrame<'_> {
fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
f.debug_struct("ExecutingFrame")
.field("code", self.code)
// .field("scope", self.scope)
.field("state", self.state)
.finish()
}
}
impl ExecutingFrame<'_> {
#[inline(always)]
fn update_lasti(&mut self, f: impl FnOnce(&mut u32)) {
#[cfg(feature = "threading")]
{
f(&mut self.state.lasti);
self.lasti
.store(self.state.lasti, atomic::Ordering::Relaxed);
}
#[cfg(not(feature = "threading"))]
{
let mut lasti = self.lasti.get();
f(&mut lasti);
self.lasti.set(lasti);
}
}
#[inline(always)]
const fn lasti(&self) -> u32 {
#[cfg(feature = "threading")]
{
self.state.lasti
}
#[cfg(not(feature = "threading"))]
{
self.lasti.get()
}
}
fn run(&mut self, vm: &VirtualMachine) -> PyResult<ExecutionResult> {
flame_guard!(format!(
"Frame::run({obj_name})",
obj_name = self.code.obj_name
));
// Execute until return or exception:
let instructions = &self.code.instructions;
let mut arg_state = bytecode::OpArgState::default();
loop {
let idx = self.lasti() as usize;
self.update_lasti(|i| *i += 1);
let bytecode::CodeUnit { op, arg } = instructions[idx];
let arg = arg_state.extend(arg);
let mut do_extend_arg = false;
let result = self.execute_instruction(op, arg, &mut do_extend_arg, vm);
match result {
Ok(None) => {}
Ok(Some(value)) => {
break Ok(value);
}
// Instruction raised an exception
Err(exception) => {
#[cold]
fn handle_exception(
frame: &mut ExecutingFrame<'_>,
exception: PyBaseExceptionRef,
idx: usize,
is_reraise: bool,
vm: &VirtualMachine,
) -> FrameResult {
// 1. Extract traceback from exception's '__traceback__' attr.
// 2. Add new entry with current execution position (filename, lineno, code_object) to traceback.
// 3. First, try to find handler in exception table
// RERAISE instructions should not add traceback entries - they're just
// re-raising an already-processed exception
if !is_reraise {
// PyTraceBack_Here always adds a new entry without
// checking for duplicates. Each time an exception passes through
// a frame (e.g., in a loop with repeated raise statements),
// a new traceback entry is added.
let (loc, _end_loc) = frame.code.locations[idx];
let next = exception.__traceback__();
let new_traceback = PyTraceback::new(
next,
frame.object.to_owned(),
idx as u32 * 2,
loc.line,
);
vm_trace!("Adding to traceback: {:?} {:?}", new_traceback, loc.line);
exception.set_traceback_typed(Some(new_traceback.into_ref(&vm.ctx)));
}
// Only contextualize exception for new raises, not re-raises
// CPython only calls _PyErr_SetObject (which does chaining) on initial raise
// RERAISE just propagates the exception without modifying __context__
if !is_reraise {
vm.contextualize_exception(&exception);
}
// Use exception table for zero-cost exception handling
frame.unwind_blocks(vm, UnwindReason::Raising { exception })
}
// Check if this is a RERAISE instruction
// Both AnyInstruction::Raise { kind: Reraise/ReraiseFromStack } and
// AnyInstruction::Reraise are reraise operations that should not add
// new traceback entries
let is_reraise = match op {
Instruction::RaiseVarargs { kind } => matches!(
kind.get(arg),
bytecode::RaiseKind::BareRaise | bytecode::RaiseKind::ReraiseFromStack
),
Instruction::Reraise { .. } => true,
_ => false,
};
match handle_exception(self, exception, idx, is_reraise, vm) {
Ok(None) => {}
Ok(Some(result)) => break Ok(result),
Err(exception) => {
// Restore lasti from traceback so frame.f_lineno matches tb_lineno
// The traceback was created with the correct lasti when exception
// was first raised, but frame.lasti may have changed during cleanup
if let Some(tb) = exception.__traceback__()
&& core::ptr::eq::<Py<Frame>>(&*tb.frame, self.object)
{
// This traceback entry is for this frame - restore its lasti
// tb.lasti is in bytes (idx * 2), convert back to instruction index
self.update_lasti(|i| *i = tb.lasti / 2);
}
break Err(exception);
}
}
}
}
if !do_extend_arg {
arg_state.reset()
}
}
}
fn yield_from_target(&self) -> Option<&PyObject> {
// checks gi_frame_state == FRAME_SUSPENDED_YIELD_FROM
// which is set when YIELD_VALUE with oparg >= 1 is executed.
// In RustPython, we check:
// 1. lasti points to RESUME (after YIELD_VALUE)
// 2. The previous instruction was YIELD_VALUE with arg >= 1
// 3. Stack top is the delegate (receiver)
//
// First check if stack is empty - if so, we can't be in yield-from
if self.state.stack.is_empty() {
return None;
}
let lasti = self.lasti() as usize;
if let Some(unit) = self.code.instructions.get(lasti) {
match &unit.op {
Instruction::Send { .. } => return Some(self.top_value()),
Instruction::Resume { .. } => {
// Check if previous instruction was YIELD_VALUE with arg >= 1
// This indicates yield-from/await context
if lasti > 0
&& let Some(prev_unit) = self.code.instructions.get(lasti - 1)
&& let Instruction::YieldValue { .. } = &prev_unit.op
{
// YIELD_VALUE arg: 0 = direct yield, >= 1 = yield-from/await
// OpArgByte.0 is the raw byte value
if prev_unit.arg.0 >= 1 {
// In yield-from/await context, delegate is on top of stack
return Some(self.top_value());
}
}
}
_ => {}
}
}
None
}
/// Handle throw() on a generator/coroutine.
fn gen_throw(
&mut self,
vm: &VirtualMachine,
exc_type: PyObjectRef,
exc_val: PyObjectRef,
exc_tb: PyObjectRef,
) -> PyResult<ExecutionResult> {
if let Some(jen) = self.yield_from_target() {
// borrow checker shenanigans - we only need to use exc_type/val/tb if the following
// variable is Some
let thrower = if let Some(coro) = self.builtin_coro(jen) {
Some(Either::A(coro))
} else {
vm.get_attribute_opt(jen.to_owned(), "throw")?
.map(Either::B)
};
if let Some(thrower) = thrower {
let ret = match thrower {
Either::A(coro) => coro
.throw(jen, exc_type, exc_val, exc_tb, vm)
.to_pyresult(vm),
Either::B(meth) => meth.call((exc_type, exc_val, exc_tb), vm),
};
return ret.map(ExecutionResult::Yield).or_else(|err| {
// This pushes Py_None to stack and restarts evalloop in exception mode.
// Stack before throw: [receiver] (YIELD_VALUE already popped yielded value)
// After pushing None: [receiver, None]
// Exception handler will push exc: [receiver, None, exc]
// CLEANUP_THROW expects: [sub_iter, last_sent_val, exc]
self.push_value(vm.ctx.none());
// Use unwind_blocks to let exception table route to CLEANUP_THROW
match self.unwind_blocks(vm, UnwindReason::Raising { exception: err }) {
Ok(None) => self.run(vm),
Ok(Some(result)) => Ok(result),
Err(exception) => Err(exception),
}
});
}
}
// throw_here: no delegate has throw method, or not in yield-from
// gen_send_ex pushes Py_None to stack and restarts evalloop in exception mode
let exception = vm.normalize_exception(exc_type, exc_val, exc_tb)?;
// Add traceback entry for the generator frame at the yield site
let idx = self.lasti().saturating_sub(1) as usize;
if idx < self.code.locations.len() {
let (loc, _end_loc) = self.code.locations[idx];
let next = exception.__traceback__();
let new_traceback =
PyTraceback::new(next, self.object.to_owned(), idx as u32 * 2, loc.line);
exception.set_traceback_typed(Some(new_traceback.into_ref(&vm.ctx)));
}
// when raising an exception, set __context__ to the current exception
// This is done in _PyErr_SetObject
vm.contextualize_exception(&exception);
// always pushes Py_None before calling gen_send_ex with exc=1
// This is needed for exception handler to have correct stack state
self.push_value(vm.ctx.none());
match self.unwind_blocks(vm, UnwindReason::Raising { exception }) {
Ok(None) => self.run(vm),
Ok(Some(result)) => Ok(result),
Err(exception) => Err(exception),
}
}
fn unbound_cell_exception(&self, i: usize, vm: &VirtualMachine) -> PyBaseExceptionRef {
if let Some(&name) = self.code.cellvars.get(i) {
vm.new_exception_msg(
vm.ctx.exceptions.unbound_local_error.to_owned(),
format!("local variable '{name}' referenced before assignment"),
)
} else {
let name = self.code.freevars[i - self.code.cellvars.len()];
vm.new_name_error(
format!("free variable '{name}' referenced before assignment in enclosing scope"),
name.to_owned(),
)
}
}
/// Execute a single instruction.
#[inline(always)]
fn execute_instruction(
&mut self,
instruction: Instruction,
arg: bytecode::OpArg,
extend_arg: &mut bool,
vm: &VirtualMachine,
) -> FrameResult {
vm.check_signals()?;
flame_guard!(format!(
"Frame::execute_instruction({})",
instruction.display(arg, &self.code.code).to_string()
));
#[cfg(feature = "vm-tracing-logging")]
{
trace!("=======");
/* TODO:
for frame in self.frames.iter() {
trace!(" {:?}", frame);
}
*/
trace!(" {:#?}", self);
trace!(
" Executing op code: {}",
instruction.display(arg, &self.code.code)
);
trace!("=======");
}
#[cold]
fn name_error(name: &'static PyStrInterned, vm: &VirtualMachine) -> PyBaseExceptionRef {
vm.new_name_error(format!("name '{name}' is not defined"), name.to_owned())
}
match instruction {
Instruction::BeforeAsyncWith => {
let mgr = self.pop_value();
let error_string = || -> String {
format!(
"'{:.200}' object does not support the asynchronous context manager protocol",
mgr.class().name(),
)
};
let aenter_res = vm
.get_special_method(&mgr, identifier!(vm, __aenter__))?
.ok_or_else(|| vm.new_type_error(error_string()))?
.invoke((), vm)?;
let aexit = mgr
.get_attr(identifier!(vm, __aexit__), vm)
.map_err(|_exc| {
vm.new_type_error({
format!("{} (missed __aexit__ method)", error_string())
})
})?;
self.push_value(aexit);
self.push_value(aenter_res);
Ok(None)
}
Instruction::BinaryOp { op } => self.execute_bin_op(vm, op.get(arg)),
Instruction::BinarySubscr => {
let key = self.pop_value();
let container = self.pop_value();
let result = container.get_item(key.as_object(), vm)?;
self.push_value(result);
Ok(None)
}
Instruction::Break { target } => self.unwind_blocks(
vm,
UnwindReason::Break {
target: target.get(arg),
},
),
Instruction::BuildListFromTuples { size } => {
// SAFETY: compiler guarantees `size` tuples are on the stack
let elements = unsafe { self.flatten_tuples(size.get(arg) as usize) };
let list_obj = vm.ctx.new_list(elements);
self.push_value(list_obj.into());
Ok(None)
}
Instruction::BuildList { size } => {
let elements = self.pop_multiple(size.get(arg) as usize).collect();
let list_obj = vm.ctx.new_list(elements);
self.push_value(list_obj.into());
Ok(None)
}
Instruction::BuildMapForCall { size } => {
self.execute_build_map_for_call(vm, size.get(arg))
}
Instruction::BuildMap { size } => self.execute_build_map(vm, size.get(arg)),
Instruction::BuildSetFromTuples { size } => {
let set = PySet::default().into_ref(&vm.ctx);
for element in self.pop_multiple(size.get(arg) as usize) {
// SAFETY: trust compiler
let tup = unsafe { element.downcast_unchecked::<PyTuple>() };
for item in tup.iter() {
set.add(item.clone(), vm)?;
}
}
self.push_value(set.into());
Ok(None)
}
Instruction::BuildSet { size } => {
let set = PySet::default().into_ref(&vm.ctx);
for element in self.pop_multiple(size.get(arg) as usize) {
set.add(element, vm)?;
}
self.push_value(set.into());
Ok(None)
}
Instruction::BuildSlice { argc } => self.execute_build_slice(vm, argc.get(arg)),
/*
Instruction::ToBool => {
dbg!("Shouldn't be called outside of match statements for now")
let value = self.pop_value();
// call __bool__
let result = value.try_to_bool(vm)?;
self.push_value(vm.ctx.new_bool(result).into());
Ok(None)
}
*/
Instruction::BuildString { size } => {
let s: Wtf8Buf = self
.pop_multiple(size.get(arg) as usize)
.map(|pyobj| pyobj.downcast::<PyStr>().unwrap())
.collect();
self.push_value(vm.ctx.new_str(s).into());
Ok(None)
}
Instruction::BuildTupleFromIter => {
if !self.top_value().class().is(vm.ctx.types.tuple_type) {
let elements: Vec<_> = self.pop_value().try_to_value(vm)?;
let list_obj = vm.ctx.new_tuple(elements);
self.push_value(list_obj.into());
}
Ok(None)
}
Instruction::BuildTupleFromTuples { size } => {
// SAFETY: compiler guarantees `size` tuples are on the stack
let elements = unsafe { self.flatten_tuples(size.get(arg) as usize) };
let list_obj = vm.ctx.new_tuple(elements);
self.push_value(list_obj.into());
Ok(None)
}
Instruction::BuildTuple { size } => {
let elements = self.pop_multiple(size.get(arg) as usize).collect();
let list_obj = vm.ctx.new_tuple(elements);
self.push_value(list_obj.into());
Ok(None)
}
Instruction::BuildTemplate => {
// Stack: [strings_tuple, interpolations_tuple] -> [template]
let interpolations = self.pop_value();
let strings = self.pop_value();
let strings = strings
.downcast::<PyTuple>()
.map_err(|_| vm.new_type_error("BUILD_TEMPLATE expected tuple for strings"))?;
let interpolations = interpolations.downcast::<PyTuple>().map_err(|_| {
vm.new_type_error("BUILD_TEMPLATE expected tuple for interpolations")
})?;
let template = PyTemplate::new(strings, interpolations);
self.push_value(template.into_pyobject(vm));
Ok(None)
}
Instruction::BuildInterpolation { oparg } => {
// oparg encoding: (conversion << 2) | has_format_spec
// Stack: [value, expression_str, (format_spec)?] -> [interpolation]
let oparg_val = oparg.get(arg);
let has_format_spec = (oparg_val & 1) != 0;
let conversion_code = oparg_val >> 2;
let format_spec = if has_format_spec {
self.pop_value().downcast::<PyStr>().map_err(|_| {
vm.new_type_error("BUILD_INTERPOLATION expected str for format_spec")
})?
} else {
vm.ctx.empty_str.to_owned()
};
let expression = self.pop_value().downcast::<PyStr>().map_err(|_| {
vm.new_type_error("BUILD_INTERPOLATION expected str for expression")
})?;
let value = self.pop_value();
// conversion: 0=None, 1=Str, 2=Repr, 3=Ascii
let conversion: PyObjectRef = match conversion_code {
0 => vm.ctx.none(),
1 => vm.ctx.new_str("s").into(),
2 => vm.ctx.new_str("r").into(),
3 => vm.ctx.new_str("a").into(),
_ => vm.ctx.none(), // should not happen
};
let interpolation =
PyInterpolation::new(value, expression, conversion, format_spec, vm)?;
self.push_value(interpolation.into_pyobject(vm));
Ok(None)
}
Instruction::Call { nargs } => {
// Stack: [callable, self_or_null, arg1, ..., argN]
let args = self.collect_positional_args(nargs.get(arg));
self.execute_call(args, vm)
}
Instruction::CallKw { nargs } => {
// Stack: [callable, self_or_null, arg1, ..., argN, kwarg_names]
let args = self.collect_keyword_args(nargs.get(arg));
self.execute_call(args, vm)
}
Instruction::CallFunctionEx => {
// Stack: [callable, self_or_null, args_tuple, kwargs_or_null]
let args = self.collect_ex_args(vm)?;
self.execute_call(args, vm)
}
Instruction::CallIntrinsic1 { func } => {
let value = self.pop_value();
let result = self.call_intrinsic_1(func.get(arg), value, vm)?;
self.push_value(result);
Ok(None)
}
Instruction::CallIntrinsic2 { func } => {
let value2 = self.pop_value();
let value1 = self.pop_value();
let result = self.call_intrinsic_2(func.get(arg), value1, value2, vm)?;
self.push_value(result);
Ok(None)
}
Instruction::CheckEgMatch => {
let match_type = self.pop_value();
let exc_value = self.pop_value();
let (rest, matched) =
crate::exceptions::exception_group_match(&exc_value, &match_type, vm)?;
self.push_value(rest);
self.push_value(matched);
Ok(None)
}
Instruction::CompareOp { op } => self.execute_compare(vm, op.get(arg)),
Instruction::ContainsOp(invert) => {
let b = self.pop_value();
let a = self.pop_value();
let value = match invert.get(arg) {
bytecode::Invert::No => self._in(vm, &a, &b)?,
bytecode::Invert::Yes => self._not_in(vm, &a, &b)?,
};
self.push_value(vm.ctx.new_bool(value).into());
Ok(None)
}
Instruction::Continue { target } => self.unwind_blocks(
vm,
UnwindReason::Continue {
target: target.get(arg),
},
),
Instruction::ConvertValue { oparg: conversion } => {
self.convert_value(conversion.get(arg), vm)
}
Instruction::Copy { index } => {
// CopyItem { index: 1 } copies TOS
// CopyItem { index: 2 } copies second from top
// This is 1-indexed to match CPython
let idx = index.get(arg) as usize;
let stack_len = self.state.stack.len();
if stack_len < idx {
eprintln!("CopyItem ERROR: stack_len={}, idx={}", stack_len, idx);
eprintln!(" code: {}", self.code.obj_name);
eprintln!(" lasti: {}", self.lasti());
panic!("CopyItem: stack underflow");
}
let value = self.state.stack[stack_len - idx].clone();
self.push_value_opt(value);
Ok(None)
}
Instruction::DeleteAttr { idx } => self.delete_attr(vm, idx.get(arg)),
Instruction::DeleteDeref(i) => {
self.cells_frees[i.get(arg) as usize].set(None);
Ok(None)
}
Instruction::DeleteFast(idx) => {
let mut fastlocals = self.fastlocals.lock();
let idx = idx.get(arg) as usize;
if fastlocals[idx].is_none() {
return Err(vm.new_exception_msg(
vm.ctx.exceptions.unbound_local_error.to_owned(),
format!(
"local variable '{}' referenced before assignment",
self.code.varnames[idx]
),
));
}
fastlocals[idx] = None;
Ok(None)
}
Instruction::DeleteGlobal(idx) => {
let name = self.code.names[idx.get(arg) as usize];
match self.globals.del_item(name, vm) {
Ok(()) => {}
Err(e) if e.fast_isinstance(vm.ctx.exceptions.key_error) => {
return Err(name_error(name, vm));
}
Err(e) => return Err(e),
}
Ok(None)
}
Instruction::DeleteName(idx) => {
let name = self.code.names[idx.get(arg) as usize];
let res = self.locals.mapping().ass_subscript(name, None, vm);
match res {
Ok(()) => {}
Err(e) if e.fast_isinstance(vm.ctx.exceptions.key_error) => {
return Err(name_error(name, vm));
}
Err(e) => return Err(e),
}
Ok(None)
}
Instruction::DeleteSubscr => self.execute_delete_subscript(vm),
Instruction::DictUpdate { index } => {
// Stack before: [..., dict, ..., source] (source at TOS)
// Stack after: [..., dict, ...] (source consumed)
// The dict to update is at position TOS-i (before popping source)
let idx = index.get(arg);
// Pop the source from TOS
let source = self.pop_value();
// Get the dict to update (it's now at TOS-(i-1) after popping source)
let dict = if idx <= 1 {
// DICT_UPDATE 0 or 1: dict is at TOS (after popping source)
self.top_value()
} else {
// DICT_UPDATE n: dict is at TOS-(n-1)
self.nth_value(idx - 1)
};
let dict = dict.downcast_ref::<PyDict>().expect("exact dict expected");
// For dictionary unpacking {**x}, x must be a mapping
// Check if the object has the mapping protocol (keys method)
if vm
.get_method(source.clone(), vm.ctx.intern_str("keys"))
.is_none()
{
return Err(vm.new_type_error(format!(
"'{}' object is not a mapping",
source.class().name()
)));
}
dict.merge_object(source, vm)?;
Ok(None)
}
Instruction::EndAsyncFor => {
// END_ASYNC_FOR pops (awaitable, exc) from stack
// Stack: [awaitable, exc] -> []
// exception_unwind pushes exception to stack before jumping to handler
let exc = self.pop_value();
let _awaitable = self.pop_value();
let exc = exc
.downcast::<PyBaseException>()
.expect("EndAsyncFor expects exception on stack");
if exc.fast_isinstance(vm.ctx.exceptions.stop_async_iteration) {
// StopAsyncIteration - normal end of async for loop
vm.set_exception(None);
Ok(None)
} else {
// Other exception - re-raise
Err(exc)
}
}
Instruction::ExtendedArg => {
*extend_arg = true;
Ok(None)
}
Instruction::ForIter { target } => self.execute_for_iter(vm, target.get(arg)),
Instruction::FormatSimple => {
let value = self.pop_value();
let formatted = vm.format(&value, vm.ctx.new_str(""))?;
self.push_value(formatted.into());
Ok(None)
}
Instruction::FormatWithSpec => {
let spec = self.pop_value();
let value = self.pop_value();
let formatted = vm.format(&value, spec.downcast::<PyStr>().unwrap())?;
self.push_value(formatted.into());
Ok(None)
}
Instruction::GetAIter => {
let aiterable = self.pop_value();
let aiter = vm.call_special_method(&aiterable, identifier!(vm, __aiter__), ())?;
self.push_value(aiter);
Ok(None)
}
Instruction::GetANext => {
#[cfg(debug_assertions)] // remove when GetANext is fully implemented
let orig_stack_len = self.state.stack.len();
let aiter = self.top_value();