Skip to content

Commit acd9334

Browse files
author
Deepika
committed
Add overhead info
1 parent 25352cb commit acd9334

File tree

2 files changed

+4
-0
lines changed

2 files changed

+4
-0
lines changed

docs/reference/api/platform/MbedStats.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,8 @@ You can use memory statistics functions to capture heap usage, cumulative stack
99
- `MBED_HEAP_STATS_ENABLED`.
1010
- `MBED_STACK_STATS_ENABLED`.
1111

12+
@Note: Overhead of 8 bytes is added with each memory allocation call `malloc` or `calloc` when heap memory statistics are enabled.
13+
1214
### Thread statistics
1315

1416
You can use the thread statistics function `mbed_stats_thread_get_each` to capture the thread ID, state, priority, name and stack information for all active threads at runtime. To enable thread monitoring, you must build Mbed OS with the `MBED_THREAD_STATS_ENABLED` macro.

docs/reference/api/platform/MemTrace.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,8 @@ You must enable the `memory-tracing-enabled` setting in the Mbed OS platform con
1616

1717
You can use the `mbed_mem_trace_set_callback` API to set the callback for memory tracing. The callback is invoked every time you call standard allocation functions, such as `malloc`, `realloc`, `calloc` and `free`.
1818

19+
@Note: Overhead of 8 bytes is added with each memory allocation call `malloc` or `calloc` when memory tracing is enabled.
20+
1921
For a step-by-step guide about how to use optimize memory using runtime memory tracing, please see our [runtime memory tracing tutorial](/docs/development/tutorials/optimizing.html#runtime-memory-tracing).
2022

2123
### Memory tracing functions reference

0 commit comments

Comments
 (0)