diff options
| author | Angus Gratton <angus@redyak.com.au> | 2024-08-06 15:51:22 +1000 |
|---|---|---|
| committer | Damien George <damien@micropython.org> | 2024-08-14 12:55:45 +1000 |
| commit | 86f2c285eb222f30c24df187ac66d3e0c80caf61 (patch) | |
| tree | 98649096d2baa4a7058a761730d738f41c0f5e72 /py/stackctrl.h | |
| parent | 6c870dc5ecc048309f7fcb21324b1aed165afdb0 (diff) | |
py: Add new cstack API for stack checking, with limit margin macro.
Currently the stack limit margin is hard-coded in each port's call to
`mp_stack_set_limit()`, but on threaded ports it's fiddlier and can lead to
bugs (such as incorrect thread stack margin on esp32).
This commit provides a new API to initialise the C Stack in one function
call, with a config macro to set the margin. Where possible the new call
is inlined to reduce code size in thread-free ports.
Intended replacement for `MP_TASK_STACK_LIMIT_MARGIN` on esp32.
The previous `stackctrl.h` API is still present and unmodified apart from a
deprecation comment. However it's not available when the
`MICROPY_PREVIEW_VERSION_2` macro is set.
This work was funded through GitHub Sponsors.
Signed-off-by: Angus Gratton <angus@redyak.com.au>
Diffstat (limited to 'py/stackctrl.h')
| -rw-r--r-- | py/stackctrl.h | 8 |
1 files changed, 7 insertions, 1 deletions
diff --git a/py/stackctrl.h b/py/stackctrl.h index c21288b2b..9bf7330cc 100644 --- a/py/stackctrl.h +++ b/py/stackctrl.h @@ -26,8 +26,12 @@ #ifndef MICROPY_INCLUDED_PY_STACKCTRL_H #define MICROPY_INCLUDED_PY_STACKCTRL_H +// This API is deprecated, please use py/cstack.h instead + #include "py/mpconfig.h" +#if !MICROPY_PREVIEW_VERSION_2 + void mp_stack_ctrl_init(void); void mp_stack_set_top(void *top); mp_uint_t mp_stack_usage(void); @@ -43,6 +47,8 @@ void mp_stack_check(void); #define mp_stack_set_limit(limit) (void)(limit) #define MP_STACK_CHECK() -#endif +#endif // MICROPY_STACK_CHECK + +#endif // !MICROPY_PREVIEW_VERSION_2 #endif // MICROPY_INCLUDED_PY_STACKCTRL_H |