Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 98.43%. Comparing base (288a036) to head (1342367).
Report is 3 commits behind head on master.

@@            Coverage Diff             @@
##           master   #15605      +/-   ##
==========================================
- Coverage   98.43%   98.43%   -0.01%     
==========================================
  Files         161      163       +2     
  Lines       21281    21293      +12     
==========================================
+ Hits        20948    20959      +11     
- Misses        333      334       +1     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

Code size report:

   bare-arm:    +0 +0.000% 
minimal x86:    +0 +0.000% 
   unix x64:  -104 -0.012% standard
      stm32:    +0 +0.000% PYBV10
     mimxrt:    +0 +0.000% TEENSY40
        rp2:   -48 -0.005% RPI_PICO_W
       samd:    +0 +0.000% ADAFRUIT_ITSYBITSY_M4_EXPRESS

An alternative to this would be to still have the MICROPY_STACK_CHECK_MARGIN macro but use it explicitly at the call site for mp_stack_set_limit(). Eg in mp_thread_init_state() it would do:

    mp_stack_set_limit(stack_size - MICROPY_STACK_CHECK_MARGIN);

That makes it more obvious that the limit is the stack size minus an explicit margin. Otherwise the margin is kind of hidden in the stackctrl.h implementation.

But, this alternative approach is more verbose (more duplicated code with the subtraction of the margin everywhere) so probably not any better than what this PR does.

@dpgeorge Have updated according to our discussion earlier, and updated the PR description.

The project coverage check is failing because stackctrl.c is no longer covered. What's the best way to deal with that?

The project coverage check is failing because stackctrl.c is no longer covered. What's the best way to deal with that?

Hmmmm... three options I can think of:

1. Add code to ports/unix/coverage.c to call the old functions to get coverage.
2. Add a #if MICROPY_STACK_CHECK_LEGACY around everything in py/stackctrl.c and disable this on unix coverage builds, to exclude that code from coverage checks.
3. Implement the new functions in terms of the old ones.

Option 3 makes it harder to easily remove the old functions when the time comes. Probably option 1 is the best.

Option 3 makes it harder to easily remove the old functions when the time comes. Probably option 1 is the best.

Thanks, have pushed a commit to try that approach (and coverage seems happy, at least.)

This is looking really good now! Just a few minor comments.

Thanks for updating, now merged.

@projectgus looks like this may have broken multi_bluetooth/ble_irq_calls.py on ESP32-C3. That test tests for recursion within a BLE IRQ handler, and now it seems that ESP32-C3 has less stack for Python calls because of the increased margin, so the test fails.

The BLE IRQ handler on esp32 has CONFIG_BT_NIMBLE_TASK_STACK_SIZE=6144 minus 2048 minus MICROPY_STACK_CHECK_MARGIN bytes. So that's very small on ESP32-C3/RISC-V.

To fix it I suggest decreasing MICROPY_STACK_CHECK_MARGIN on RISC-V to a less conservative value. If that still doesn't fix multi_bluetooth/ble_irq_calls.py then we should probably increase CONFIG_BT_NIMBLE_TASK_STACK_SIZE on RISC-V.