trcStackMonitor.h

Go to the documentation of this file.

/*
* Percepio Trace Recorder SDK for Tracealyzer v4.11.0
* Copyright 2025 Percepio AB
* www.percepio.com
*
* SPDX-License-Identifier: Apache-2.0
*/

 
#ifndef TRC_STACK_MONITOR_H
#define TRC_STACK_MONITOR_H
 
#if (TRC_USE_TRACEALYZER_RECORDER == 1) && ((TRC_CFG_ENABLE_STACK_MONITOR) == 1) && ((TRC_CFG_SCHEDULING_ONLY) == 0)
 
#include <stdint.h>
#include <trcRecorder.h>
 
#ifdef __cplusplus
extern "C" {
#endif

 
typedef struct TraceStackMonitorEntry   /* Aligned */
{
    void *pvTask;
    TraceUnsignedBaseType_t uxPreviousLowWaterMark;
} TraceStackMonitorEntry_t;
 
typedef struct TraceStackMonitorData    /* Aligned */
{
    TraceStackMonitorEntry_t xEntries[TRC_CFG_STACK_MONITOR_MAX_TASKS];
 
    TraceUnsignedBaseType_t uxEntryCount;
} TraceStackMonitorData_t;

traceResult xTraceStackMonitorInitialize(TraceStackMonitorData_t* pxBuffer);

traceResult xTraceStackMonitorAdd(void* pvTask);

traceResult xTraceStackMonitorRemove(void* pvTask);

traceResult xTraceStackMonitorGetAtIndex(uint32_t uiIndex, void** ppvTask, TraceUnsignedBaseType_t* puxLowWaterMark);

traceResult xTraceStackMonitorReport(void);

 
#ifdef __cplusplus
}
#endif
 
#else
 
typedef struct TraceStackMonitorData
{
    uint32_t buffer[1];
} TraceStackMonitorData_t;
 
#define xTraceStackMonitorInitialize(__pxBuffer) ((void)(__pxBuffer), TRC_SUCCESS)
 
#define xTraceStackMonitorDiagnosticsGet(__xType, __puiValue) ((void)(__xType), (__puiValue) != 0 ? *(__puiValue) = 0 : 0, (__puiValue) != 0 ? TRC_SUCCESS : TRC_FAIL)
 
#define xTraceStackMonitorDiagnosticsSet(__xType, __uiValue) TRC_COMMA_EXPR_TO_STATEMENT_EXPR_3((void)(__xType), (void)(__uiValue), TRC_SUCCESS)
 
#define xTraceStackMonitorAdd(__pvTask) TRC_COMMA_EXPR_TO_STATEMENT_EXPR_2((void)(__pvTask), TRC_SUCCESS)
 
#define xTraceStackMonitorRemove(__pvTask) TRC_COMMA_EXPR_TO_STATEMENT_EXPR_2((void)(__pvTask), TRC_SUCCESS)
 
#define xTraceStackMonitorGetAtIndex(__uiIndex, __ppvTask, __puxLowWaterMark) TRC_COMMA_EXPR_TO_STATEMENT_EXPR_4((void)(__uiIndex), (void)_(ppvTask), (void)(__puxLowWaterMark), TRC_SUCCESS)
 
#define xTraceStackMonitorReport() TRC_COMMA_EXPR_TO_STATEMENT_EXPR_1(TRC_SUCCESS)
 
#endif
 
#endif