heap_trace_start() function

Start heap tracing. All heap allocations & frees will be traced, until heap_trace_stop() is called.

Syntax

Show:

Summary

Declaration

Definition

from esp_heap_trace.h:107

esp_err_t heap_trace_start(heap_trace_mode_t mode);

Implemented in heap_trace_tohost.c:35

Arguments

Argument

Description

mode

Mode for tracing. - HEAP_TRACE_ALL means all heap allocations and frees are traced. - HEAP_TRACE_LEAKS means only suspected memory leaks are traced. (When memory is freed, the record is removed from the trace buffer.)

Return value

- ESP_ERR_NOT_SUPPORTED Project was compiled without heap tracing enabled in menuconfig. - ESP_ERR_INVALID_STATE A non-zero-length buffer has not been set via heap_trace_init_standalone(). - ESP_OK Tracing is started.

Notes

heap_trace_init_standalone() must be called to provide a valid buffer, before this function is called. Calling this function while heap tracing is running will reset the heap trace state and continue tracing.

Examples

heap_trace_start() is referenced by 1 libraries and example projects:

References

from examples

heap_trace_start() function

Syntax

Arguments

Return value

Notes

Examples

References

Call Tree

Data Use

Class Tree

Override Tree

Implementations

Instances

Lifecycle