Skip to content

Conversation

@Josverl
Copy link

@Josverl Josverl commented Jun 17, 2025

local variable access

This document describes the enhanced debugging functionality added to MicroPython through two key commits that implement comprehensive local variable introspection for the sys.settrace() functionality.

Overview

The enhancements enable debuggers and profiling tools to access local variable names and values in function frames, which is essential for interactive debugging, breakpoint inspection, and runtime analysis. The implementation includes both basic local variable access and advanced variable name preservation with correct slot mapping.

Key Features Added

1. Basic Frame Local Variables Access (frame.f_locals)

The initial implementation provides access to local variables in stack frames through the frame.f_locals property. This foundational feature enables debuggers to inspect variable values at runtime.

Key Components:

  • frame_f_locals() function - Core implementation in py/profile.c
  • Memory-safe access - Includes GC lock checking and state validation
  • Generic fallback names - Uses local_01, local_02, etc. when variable names unavailable
  • Robust error handling - Graceful handling of invalid state or memory allocation failures

Implementation Features:

  • Pre-allocates dictionary size based on frame state count for efficiency
  • Validates code state and state array before access
  • Skips NULL values in the state array
  • Safe qstr creation with error checking

2. Advanced Variable Name Storage (MICROPY_PY_SYS_SETTRACE_SAVE_NAMES)

An enhanced compile-time feature that preserves actual local variable names in compiled bytecode for professional debugging capabilities.

pi-anl and others added 12 commits June 11, 2025 22:09
Only if MICROPY_PY_SYS_SETTRACE is enabled.
This is used to provide introspection of attributes
such as function name or source file & line.

Signed-off-by: Andrew Leech <andrew.leech@planetinnovation.com.au>
Signed-off-by: Andrew Leech <andrew.leech@planetinnovation.com.au>
Refer to https://docs.python.org/3/library/sys.html#sys._getframe
Signed-off-by: Andrew Leech <andrew.leech@planetinnovation.com.au>
Refer to https://docs.python.org/3/library/sys.html#sys.gettrace
Signed-off-by: Andrew Leech <andrew.leech@planetinnovation.com.au>
Updates micropython-lib submodule to include the new debugpy implementation
that enables VS Code debugging support for MicroPython applications.

The debugpy port provides:
- Debug Adapter Protocol (DAP) compatibility with VS Code
- Line breakpoints, stepping, and variable inspection
- Integration with MicroPython's sys.settrace functionality
- Network-based debugging via TCP socket connection

This enables developers to debug MicroPython code using the familiar
VS Code debugging interface, improving the development experience.

🤖 Generated with [Claude Code](https://claude.ai/code)

Co-Authored-By: Claude <noreply@anthropic.com>
Signed-off-by: Jos Verlinde <jos_verlinde@hotmail.com>
Signed-off-by: Jos Verlinde <jos_verlinde@hotmail.com>
Signed-off-by: Jos Verlinde <jos_verlinde@hotmail.com>
Signed-off-by: Jos Verlinde <jos_verlinde@hotmail.com>
Signed-off-by: Jos Verlinde <jos_verlinde@hotmail.com>
Signed-off-by: Jos Verlinde <jos_verlinde@hotmail.com>
@Josverl Josverl marked this pull request as ready for review June 17, 2025 13:12
Josverl added 6 commits June 17, 2025 16:58
Signed-off-by: Jos Verlinde <jos_verlinde@hotmail.com>
Signed-off-by: Jos Verlinde <jos_verlinde@hotmail.com>
Signed-off-by: Jos Verlinde <jos_verlinde@hotmail.com>
Signed-off-by: Jos Verlinde <jos_verlinde@hotmail.com>
Signed-off-by: Jos Verlinde <jos_verlinde@hotmail.com>
Signed-off-by: Jos Verlinde <jos_verlinde@hotmail.com>
andrewleech pushed a commit that referenced this pull request Oct 19, 2025
Update CLAUDE.local.md with Issue #3 resolution and current status.
BLE connections now working on STM32WB55 with both peripheral and
central roles successfully delivering IRQ events.

Signed-off-by: Andrew Leech <andrew.leech@planetinnovation.com.au>
andrewleech pushed a commit that referenced this pull request Nov 18, 2025
Test Results Summary:
- 24/34 tests passed (70.6%)
- 10/34 tests failed (29.4%)
- Firmware: v1.26.0-preview.323.g57456a5acc

Comparison to Baselines:
- Sprint 1 only (without two-phase): 6/33 passed (18.2%)
- Current (Sprint 1 + two-phase): 24/34 passed (70.6%)
- Improvement: +18 tests (+52.4 percentage points)

Sprint 1 Fixes Applied (commits 2032aa2, 724f018, 57456a5):
1. PRIMASK interrupt masking: arch_irq_lock() now masks ALL interrupts
2. Removed GC test instrumentation: Eliminated gc_recently_run causing MemoryErrors
3. PendSV delegation: Proper context switching via z_arm_pendsv

Two-Phase Initialization:
- Phase 1 (early): mp_thread_set_state() before gc_init() for MP_STATE_THREAD access
- Phase 2 (after GC): Allocate thread structures on GC heap with canary protection
- Required due to circular dependency: gc_init() needs thread state,
  mp_thread_init() needs GC heap

Tests Now Passing (vs Sprint 1 baseline):
- disable_irq, mutate_dict, mutate_instance, mutate_list, mutate_set
- stress_aes, thread_create_basic, thread_exc1, thread_exc2
- thread_exit1, thread_exit2, thread_gc1, thread_heap_lock
- thread_ident1, thread_lock1, thread_lock2, thread_lock5
- thread_shared1, thread_shared2, thread_sleep2, thread_stacksize1
- thread_start1, thread_start2, thread_stdin

Remaining Failures (10 tests):
- mutate_bytearray: Memory corruption during bytearray mutation
- stress_create, stress_heap, stress_recurse, stress_schedule:
  Resource exhaustion under heavy load
- thread_coop: Cooperative scheduling issues
- thread_lock3, thread_lock4: Advanced lock timeout/context manager scenarios
- thread_qstr1: QSTR allocation in threads
- thread_sleep1: Sleep precision/behavior

Known Issues from Code Review (ZEPHYR_THREADING_CODE_REVIEW.md):
1. Thread initialization race (Phase 2, Finding #1): Thread started with K_NO_WAIT
   before all fields initialized. If GC runs between k_thread_create() and field
   initialization, it scans garbage pointers.
   FIX: Initialize all fields before k_thread_create() or use K_FOREVER then
   k_thread_start().

2. Static name buffer race (Phase 2, Finding #2): Single static char name[16]
   shared across all threads causes corruption under concurrent creation.
   FIX: Allocate per-thread or embed in mp_thread_t structure.

3. Stack scanning fallback bug (Phase 2, Finding #3): On PSP corruption,
   falls back to scanning entire stack including garbage.
   FIX: Skip thread or halt, don't scan garbage.

Next Steps:
- Address thread initialization race (highest impact)
- Fix static name buffer race
- Investigate remaining 10 test failures
- Consider simplification to reduce maintenance burden (667 lines vs 308 in ports/zephyr)

Test Command:
  cd ~/micropython/tests && \
  env RESET='pyocd reset --probe 066CFF495177514867213407' \
  ./run-tests.py -t port:/dev/serial/by-id/usb-STMicroelectronics_STM32_STLink_066CFF495177514867213407-if02 \
  ~/micropython/tests/thread/*.py

Signed-off-by: Andrew Leech <andrew@alelec.net>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants