alex/esp-idf
alex/esp-idf
1
0
Fork 0
mirror of https://github.com/espressif/esp-idf.git synced 2024-10-05 20:47:46 -04:00
Code Issues Actions 2 Packages Projects Releases Wiki Activity

Merge branch 'doc/heap_thread_safety' into 'master'

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

Closes IDFGH-1502

See merge request espressif/esp-idf!5516
This commit is contained in:
Jiang Jiang Jian 2019-07-14 14:48:14 +08:00
commit 3d95b63686
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
------------------------ ------------------------