Percepio Trace Recorder  v4.6.6
Trace Heap APIs

Macros

#define xTraceHeapGetCurrent(xHeapHandle, puxCurrent)   xTraceEntryGetState(xHeapHandle, TRC_HEAP_STATE_INDEX_CURRENT, puxCurrent)
 Gets trace heap current allocation size. More...
 
#define xTraceHeapSetCurrent(xHeapHandle, uxCurrent)   xTraceEntrySetState(xHeapHandle, TRC_HEAP_STATE_INDEX_CURRENT, uxCurrent)
 Sets trace heap current allocation size. More...
 
#define xTraceHeapGetHighWaterMark(xHeapHandle, puxHighWaterMark)   xTraceEntryGetState(xHeapHandle, TRC_HEAP_STATE_INDEX_HIGHWATERMARK, puxHighWaterMark)
 Gets trace heap high water mark. More...
 
#define xTraceHeapSetHighWaterMark(xHeapHandle, uxHighWaterMark)   xTraceEntrySetState(xHeapHandle, TRC_HEAP_STATE_INDEX_HIGHWATERMARK, uxHighWaterMark)
 Sets trace heap high water mark. More...
 
#define xTraceHeapGetMax(xHeapHandle, puxMax)   xTraceEntryGetState(xHeapHandle, TRC_HEAP_STATE_INDEX_MAX, puxMax)
 Gets trace heap max size. More...
 
#define xTraceHeapSetMax(xHeapHandle, uxMax)   xTraceEntrySetState(xHeapHandle, TRC_HEAP_STATE_INDEX_MAX, uxMax)
 Sets trace heap max size. More...
 

Functions

traceResult xTraceHeapCreate (const char *szName, TraceUnsignedBaseType_t uxCurrent, TraceUnsignedBaseType_t uxHighWaterMark, TraceUnsignedBaseType_t uxMax, TraceHeapHandle_t *pxHeapHandle)
 Creates trace heap. More...
 
traceResult xTraceHeapAlloc (TraceHeapHandle_t xHeapHandle, void *pvAddress, TraceUnsignedBaseType_t uxSize)
 Signals trace heap alloc. More...
 
traceResult xTraceHeapFree (TraceHeapHandle_t xHeapHandle, void *pvAddress, TraceUnsignedBaseType_t uxSize)
 Signals trace heap free. More...
 

Detailed Description

Macro Definition Documentation

◆ xTraceHeapGetCurrent

#define xTraceHeapGetCurrent (   xHeapHandle,
  puxCurrent 
)    xTraceEntryGetState(xHeapHandle, TRC_HEAP_STATE_INDEX_CURRENT, puxCurrent)

Gets trace heap current allocation size.

Parameters
[in]xHeapHandleTrace heap handle.
[out]puxCurrentCurrent.
Return values
TRC_FAILFailure
TRC_SUCCESSSuccess

◆ xTraceHeapGetHighWaterMark

#define xTraceHeapGetHighWaterMark (   xHeapHandle,
  puxHighWaterMark 
)    xTraceEntryGetState(xHeapHandle, TRC_HEAP_STATE_INDEX_HIGHWATERMARK, puxHighWaterMark)

Gets trace heap high water mark.

Parameters
[in]xHeapHandleTrace heap handle.
[out]puxHighWaterMarkHigh water mark.
Return values
TRC_FAILFailure
TRC_SUCCESSSuccess

◆ xTraceHeapGetMax

#define xTraceHeapGetMax (   xHeapHandle,
  puxMax 
)    xTraceEntryGetState(xHeapHandle, TRC_HEAP_STATE_INDEX_MAX, puxMax)

Gets trace heap max size.

Parameters
[in]xHeapHandleTrace heap handle.
[out]puxMaxMax.
Return values
TRC_FAILFailure
TRC_SUCCESSSuccess

◆ xTraceHeapSetCurrent

#define xTraceHeapSetCurrent (   xHeapHandle,
  uxCurrent 
)    xTraceEntrySetState(xHeapHandle, TRC_HEAP_STATE_INDEX_CURRENT, uxCurrent)

Sets trace heap current allocation size.

Parameters
[in]xHeapHandleTrace heap handle.
[in]uxCurrentCurrent.
Return values
TRC_FAILFailure
TRC_SUCCESSSuccess

◆ xTraceHeapSetHighWaterMark

#define xTraceHeapSetHighWaterMark (   xHeapHandle,
  uxHighWaterMark 
)    xTraceEntrySetState(xHeapHandle, TRC_HEAP_STATE_INDEX_HIGHWATERMARK, uxHighWaterMark)

Sets trace heap high water mark.

Parameters
[in]xHeapHandleTrace heap handle.
[in]uxHighWaterMarkHigh water mark.
Return values
TRC_FAILFailure
TRC_SUCCESSSuccess

◆ xTraceHeapSetMax

#define xTraceHeapSetMax (   xHeapHandle,
  uxMax 
)    xTraceEntrySetState(xHeapHandle, TRC_HEAP_STATE_INDEX_MAX, uxMax)

Sets trace heap max size.

Parameters
[in]xHeapHandleTrace heap handle.
[in]uxMaxMax heap size.
Return values
TRC_FAILFailure
TRC_SUCCESSSuccess

Function Documentation

◆ xTraceHeapAlloc()

traceResult xTraceHeapAlloc ( TraceHeapHandle_t  xHeapHandle,
void *  pvAddress,
TraceUnsignedBaseType_t  uxSize 
)

Signals trace heap alloc.

Parameters
[in]xHeapHandleTrace heap handle.
[in]pvAddressAddress.
[in]uxSizeSize.
Return values
TRC_FAILFailure
TRC_SUCCESSSuccess

◆ xTraceHeapCreate()

traceResult xTraceHeapCreate ( const char *  szName,
TraceUnsignedBaseType_t  uxCurrent,
TraceUnsignedBaseType_t  uxHighWaterMark,
TraceUnsignedBaseType_t  uxMax,
TraceHeapHandle_t *  pxHeapHandle 
)

Creates trace heap.

Parameters
[in]szNameName.
[in]uxCurrentCurrent level.
[in]uxHighWaterMarkHigh water mark
[in]uxMaxMaximum level.
[out]pxHeapHandlePointer to uninitialized trace heap handle.
Returns
traceResult

◆ xTraceHeapFree()

traceResult xTraceHeapFree ( TraceHeapHandle_t  xHeapHandle,
void *  pvAddress,
TraceUnsignedBaseType_t  uxSize 
)

Signals trace heap free.

Parameters
[in]xHeapHandleTrace heap handle.
[in]pvAddressAddress.
[in]uxSizeSize.
Return values
TRC_FAILFailure
TRC_SUCCESSSuccess