X Tutup
Skip to content

Fix trace/profile events for generators and exceptions #7268

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
youknowone merged 1 commit into from
Mar 1, 2026
Merged

Fix trace/profile events for generators and exceptions #7268

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions .cspell.dict/cpython.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,7 @@ carg
cellarg
cellvar
cellvars
ceval
cfield
CLASSDEREF
classdict
Expand Down
5 changes: 0 additions & 5 deletions Lib/test/test_bdb.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -614,7 +614,6 @@ def test_step_next_on_last_statement(self):
with TracerRun(self) as tracer:
tracer.runcall(tfunc_main)

@unittest.expectedFailure # TODO: RUSTPYTHON; AssertionError: All paired tuples have not been processed, the last one was number 1 [('next',), ('quit',)]
def test_stepinstr(self):
self.expect_set = [
('line', 2, 'tfunc_main'), ('stepinstr', ),
Expand Down Expand Up @@ -1084,7 +1083,6 @@ def func():
with TracerRun(self) as tracer:
tracer.runcall(tfunc_import)

@unittest.expectedFailure # TODO: RUSTPYTHON; Error in atexit._run_exitfuncs
def test_next_until_return_in_generator(self):
# Issue #16596.
# Check that set_next(), set_until() and set_return() do not treat the
Expand Down Expand Up @@ -1126,7 +1124,6 @@ def main():
with TracerRun(self) as tracer:
tracer.runcall(tfunc_import)

@unittest.expectedFailure # TODO: RUSTPYTHON; Error in atexit._run_exitfuncs
def test_next_command_in_generator_for_loop(self):
# Issue #16596.
code = """
Expand Down Expand Up @@ -1158,7 +1155,6 @@ def main():
with TracerRun(self) as tracer:
tracer.runcall(tfunc_import)

@unittest.expectedFailure # TODO: RUSTPYTHON; Error in atexit._run_exitfuncs
def test_next_command_in_generator_with_subiterator(self):
# Issue #16596.
code = """
Expand Down Expand Up @@ -1190,7 +1186,6 @@ def main():
with TracerRun(self) as tracer:
tracer.runcall(tfunc_import)

@unittest.expectedFailure # TODO: RUSTPYTHON; Error in atexit._run_exitfuncs
def test_return_command_in_generator_with_subiterator(self):
# Issue #16596.
code = """
Expand Down
14 changes: 0 additions & 14 deletions Lib/test/test_sys_setprofile.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -108,7 +108,6 @@ def f(p):
(1, 'return', f_ident),
])

@unittest.expectedFailure # TODO: RUSTPYTHON; [(1, 'call', (112, 'f'))]
def test_exception(self):
def f(p):
1/0
Expand All @@ -135,7 +134,6 @@ def f(p):
(1, 'return', f_ident),
])

@unittest.expectedFailure # TODO: RUSTPYTHON; [(1, 'call', (138, 'f'))]
def test_nested_exception(self):
def f(p):
1/0
Expand All @@ -147,7 +145,6 @@ def f(p):
(1, 'return', f_ident),
])

@unittest.expectedFailure # TODO: RUSTPYTHON; (1, 'return', (151, 'g'))]
def test_exception_in_except_clause(self):
def f(p):
1/0
Expand All @@ -167,7 +164,6 @@ def g(p):
(1, 'return', g_ident),
])

@unittest.expectedFailure # TODO: RUSTPYTHON; (1, 'falling through', (170, 'g'))]
def test_exception_propagation(self):
def f(p):
1/0
Expand All @@ -183,7 +179,6 @@ def g(p):
(1, 'return', g_ident),
])

@unittest.expectedFailure # TODO: RUSTPYTHON; [(1, 'call', (183, 'f'))]
def test_raise_twice(self):
def f(p):
try: 1/0
Expand All @@ -193,7 +188,6 @@ def f(p):
(1, 'return', f_ident),
])

@unittest.expectedFailure # TODO: RUSTPYTHON; [(1, 'call', (192, 'f'))]
def test_raise_reraise(self):
def f(p):
try: 1/0
Expand All @@ -203,7 +197,6 @@ def f(p):
(1, 'return', f_ident),
])

@unittest.expectedFailure # TODO: RUSTPYTHON; [(1, 'call', (201, 'f'))]
def test_raise(self):
def f(p):
raise Exception()
Expand All @@ -212,7 +205,6 @@ def f(p):
(1, 'return', f_ident),
])

@unittest.expectedFailure # TODO: RUSTPYTHON; (5, 'call', (209, 'f'))]
def test_distant_exception(self):
def f():
1/0
Expand Down Expand Up @@ -297,7 +289,6 @@ def f(p):
(1, 'return', f_ident),
])

@unittest.expectedFailure # TODO: RUSTPYTHON; [(1, 'call', (293, 'f'))]
def test_basic_exception(self):
def f(p):
1/0
Expand All @@ -315,7 +306,6 @@ def f(p):
(1, 'return', f_ident),
])

@unittest.expectedFailure # TODO: RUSTPYTHON; (5, 'call', (310, 'f'))]
def test_distant_exception(self):
def f():
1/0
Expand Down Expand Up @@ -354,7 +344,6 @@ def f(p):
(1, 'return', f_ident)])

# Test an invalid call (bpo-34126)
@unittest.expectedFailure # TODO: RUSTPYTHON; [(1, 'call', (348, 'f'))]
def test_unbound_method_no_args(self):
def f(p):
dict.get()
Expand All @@ -363,7 +352,6 @@ def f(p):
(1, 'return', f_ident)])

# Test an invalid call (bpo-34126)
@unittest.expectedFailure # TODO: RUSTPYTHON; [(1, 'call', (356, 'f'))]
def test_unbound_method_invalid_args(self):
def f(p):
dict.get(print, 42)
Expand All @@ -372,7 +360,6 @@ def f(p):
(1, 'return', f_ident)])

# Test an invalid call (bpo-34125)
@unittest.expectedFailure # TODO: RUSTPYTHON; [(1, 'call', (365, 'f'))]
def test_unbound_method_no_keyword_args(self):
kwargs = {}
def f(p):
Expand All @@ -382,7 +369,6 @@ def f(p):
(1, 'return', f_ident)])

# Test an invalid call (bpo-34125)
@unittest.expectedFailure # TODO: RUSTPYTHON; [(1, 'call', (374, 'f'))]
def test_unbound_method_invalid_keyword_args(self):
kwargs = {}
def f(p):
Expand Down
89 changes: 77 additions & 12 deletions crates/vm/src/frame.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -62,6 +62,10 @@ struct FrameState {
stack: BoxVec<Option<PyObjectRef>>,
/// Cell and free variable references (cellvars + freevars).
cells_frees: Box<[PyCellRef]>,
/// Previous line number for LINE event suppression.
/// Stored here (not on ExecutingFrame) so it persists across
/// generator/coroutine suspend and resume.
prev_line: u32,
}

/// Tracks who owns a frame.
Expand Down Expand Up @@ -200,6 +204,7 @@ impl Frame {
let state = FrameState {
stack: BoxVec::new(code.max_stackdepth as usize),
cells_frees,
prev_line: 0,
};

Self {
Expand Down Expand Up @@ -383,7 +388,6 @@ impl Py<Frame> {
object: self,
state: &mut state,
monitoring_mask: 0,
prev_line: 0,
};
f(exec)
}
Expand Down Expand Up @@ -430,7 +434,6 @@ impl Py<Frame> {
object: self,
state: &mut state,
monitoring_mask: 0,
prev_line: 0,
};
exec.yield_from_target().map(PyObject::to_owned)
}
Expand Down Expand Up @@ -467,8 +470,6 @@ struct ExecutingFrame<'a> {
state: &'a mut FrameState,
/// Cached monitoring events mask. Reloaded at Resume instruction only,
monitoring_mask: u32,
/// Previous line number for LINE event suppression.
prev_line: u32,
}

impl fmt::Debug for ExecutingFrame<'_> {
Expand Down Expand Up @@ -518,6 +519,23 @@ impl ExecutingFrame<'_> {
}
}

/// Fire 'exception' trace event (sys.settrace) with (type, value, traceback) tuple.
/// Matches `_PyEval_MonitorRaise` → `PY_MONITORING_EVENT_RAISE` →
/// `sys_trace_exception_func` in legacy_tracing.c.
fn fire_exception_trace(&self, exc: &PyBaseExceptionRef, vm: &VirtualMachine) -> PyResult<()> {
if vm.use_tracing.get() && !vm.is_none(&self.object.trace.lock()) {
let exc_type: PyObjectRef = exc.class().to_owned().into();
let exc_value: PyObjectRef = exc.clone().into();
let exc_tb: PyObjectRef = exc
.__traceback__()
.map(|tb| -> PyObjectRef { tb.into() })
.unwrap_or_else(|| vm.ctx.none());
let tuple = vm.ctx.new_tuple(vec![exc_type, exc_value, exc_tb]).into();
vm.trace_event(crate::protocol::TraceEvent::Exception, Some(tuple))?;
}
Ok(())
}

fn run(&mut self, vm: &VirtualMachine) -> PyResult<ExecutionResult> {
flame_guard!(format!(
"Frame::run({obj_name})",
Expand Down Expand Up @@ -545,9 +563,9 @@ impl ExecutingFrame<'_> {
Some(Instruction::Resume { .. } | Instruction::InstrumentedResume)
)
&& let Some((loc, _)) = self.code.locations.get(idx)
&& loc.line.get() as u32 != self.prev_line
&& loc.line.get() as u32 != self.state.prev_line
{
self.prev_line = loc.line.get() as u32;
self.state.prev_line = loc.line.get() as u32;
vm.trace_event(crate::protocol::TraceEvent::Line, None)?;
// Trace callback may have changed lasti via set_f_lineno.
// Re-read and restart the loop from the new position.
Expand Down Expand Up @@ -575,7 +593,23 @@ impl ExecutingFrame<'_> {
| Instruction::InstrumentedLine
) && let Some((loc, _)) = self.code.locations.get(idx)
{
self.prev_line = loc.line.get() as u32;
self.state.prev_line = loc.line.get() as u32;
}

// Fire 'opcode' trace event for sys.settrace when f_trace_opcodes
// is set. Skip RESUME and ExtendedArg (matching CPython's exclusion
// of these in _Py_call_instrumentation_instruction).
if vm.use_tracing.get()
&& !vm.is_none(&self.object.trace.lock())
&& *self.object.trace_opcodes.lock()
&& !matches!(
op,
Instruction::Resume { .. }
| Instruction::InstrumentedResume
| Instruction::ExtendedArg
)
{
vm.trace_event(crate::protocol::TraceEvent::Opcode, None)?;
}

let result = self.execute_instruction(op, arg, &mut do_extend_arg, vm);
Expand Down Expand Up @@ -691,6 +725,13 @@ impl ExecutingFrame<'_> {
}
};

// Fire 'exception' trace event for sys.settrace.
// Only for new raises, not re-raises (matching the
// `error` label that calls _PyEval_MonitorRaise).
if !is_reraise {
self.fire_exception_trace(&exception, vm)?;
}

match handle_exception(self, exception, idx, is_reraise, is_new_raise, vm) {
Ok(None) => {}
Ok(Some(result)) => break Ok(result),
Expand Down Expand Up @@ -777,6 +818,12 @@ impl ExecutingFrame<'_> {
exc_tb: PyObjectRef,
) -> PyResult<ExecutionResult> {
self.monitoring_mask = vm.state.monitoring_events.load();
// Reset prev_line so that LINE monitoring events fire even if
// the exception handler is on the same line as the yield point.
// In CPython, _Py_call_instrumentation_line has a special case
// for RESUME: it fires LINE even when prev_line == current_line.
// Since gen_throw bypasses RESUME, we reset prev_line instead.
self.state.prev_line = 0;
if let Some(jen) = self.yield_from_target() {
// Check if the exception is GeneratorExit (type or instance).
// For GeneratorExit, close the sub-iterator instead of throwing.
Expand Down Expand Up @@ -2167,7 +2214,10 @@ impl ExecutingFrame<'_> {
.instrumentation_version
.load(atomic::Ordering::Acquire);
if code_ver != global_ver {
let events = vm.state.monitoring_events.load();
let events = {
let state = vm.state.monitoring.lock();
state.events_for_code(self.code.get_id())
};
monitoring::instrument_code(self.code, events);
self.code
.instrumentation_version
Expand Down Expand Up @@ -2424,6 +2474,12 @@ impl ExecutingFrame<'_> {
Ok(None)
}
PyIterReturn::StopIteration(value) => {
// Fire 'exception' trace event for StopIteration,
// matching SEND's exception handling.
if vm.use_tracing.get() && !vm.is_none(&self.object.trace.lock()) {
let stop_exc = vm.new_stop_iteration(value.clone());
self.fire_exception_trace(&stop_exc, vm)?;
}
let value = vm.unwrap_or_none(value);
self.push_value(value);
self.jump(exit_label);
Expand Down Expand Up @@ -2538,7 +2594,10 @@ impl ExecutingFrame<'_> {
.instrumentation_version
.load(atomic::Ordering::Acquire);
if code_ver != global_ver {
let events = vm.state.monitoring_events.load();
let events = {
let state = vm.state.monitoring.lock();
state.events_for_code(self.code.get_id())
};
monitoring::instrument_code(self.code, events);
self.code
.instrumentation_version
Expand Down Expand Up @@ -2809,8 +2868,8 @@ impl ExecutingFrame<'_> {
// Fire LINE event only if line changed
if let Some((loc, _)) = self.code.locations.get(idx) {
let line = loc.line.get() as u32;
if line != self.prev_line && line > 0 {
self.prev_line = line;
if line != self.state.prev_line && line > 0 {
self.state.prev_line = line;
monitoring::fire_line(vm, self.code, offset, line)?;
}
}
Expand Down Expand Up @@ -3529,7 +3588,13 @@ impl ExecutingFrame<'_> {
self.push_value(value);
Ok(true)
}
Ok(PyIterReturn::StopIteration(_)) => {
Ok(PyIterReturn::StopIteration(value)) => {
// Fire 'exception' trace event for StopIteration, matching
// FOR_ITER's inline call to _PyEval_MonitorRaise.
if vm.use_tracing.get() && !vm.is_none(&self.object.trace.lock()) {
let stop_exc = vm.new_stop_iteration(value);
self.fire_exception_trace(&stop_exc, vm)?;
}
// Skip END_FOR (base or instrumented) and jump to POP_ITER.
let target_idx = target.0 as usize;
let jump_target = if let Some(unit) = self.code.instructions.get(target_idx) {
Expand Down
Loading
Loading
X Tutup