Crash_Override/OVMS3-idf
1
0
Fork 0
Code Issues Pull requests Projects Releases Wiki Activity

docs: Add notes about thread safety and using heap from ISRs

Browse source 
Closes https://github.com/espressif/esp-idf/issues/3768
This commit is contained in:
Angus Gratton 2019-07-12 11:09:00 +10:00 committed by Angus Gratton
parent 1ea68e6093
commit 0f27c38855
1 changed files with 7 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

7
docs/en/api-reference/system/mem_alloc.rst
View file

@ -113,6 +113,13 @@ API Reference - Heap Allocation
.. include:: /_build/inc/esp_heap_caps.inc .. include:: /_build/inc/esp_heap_caps.inc
Thread Safety
^^^^^^^^^^^^^
Heap functions are thread safe, meaning they can be called from different tasks simultaneously without any limitations.
It is technically possible to call ``malloc``, ``free``, and related functions from interrupt handler (ISR) context. However this is not recommended, as heap function calls may delay other interrupts. It is strongly recommended to refactor applications so that any buffers used by an ISR are pre-allocated outside of the ISR. Support for calling heap functions from ISRs may be removed in a future update.
Heap Tracing & Debugging Heap Tracing & Debugging
------------------------ ------------------------