trcTaskMonitor.h

Go to the documentation of this file.

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

 
#ifndef TRC_TASK_MONITOR_H
#define TRC_TASK_MONITOR_H
 
#ifndef TRC_CFG_ENABLE_TASK_MONITOR
#define TRC_CFG_ENABLE_TASK_MONITOR 0
#endif
 
#ifndef TRC_KERNEL_PORT_SUPPORTS_TLS
#define TRC_KERNEL_PORT_SUPPORTS_TLS 0
#endif
 
typedef struct TraceTaskMonitorCallbackData
{
    void* pvTaskAddress;
    char acName[TRC_ENTRY_TABLE_SLOT_SYMBOL_SIZE];
    TraceUnsignedBaseType_t uxCPULoad;
    TraceUnsignedBaseType_t uxLowLimit;
    TraceUnsignedBaseType_t uxHighLimit;
    TraceUnsignedBaseType_t uxNumberOfFailedTasks;
} TraceTaskMonitorCallbackData_t;
 
typedef void (*TraceTaskMonitorCallback_t)(TraceTaskMonitorCallbackData_t *pxData);
 
#if (TRC_USE_TRACEALYZER_RECORDER == 1) && (TRC_CFG_ENABLE_TASK_MONITOR == 1) && (TRC_KERNEL_PORT_SUPPORTS_TLS == 1)
 
#include <trcTypes.h>
 
#ifdef __cplusplus
extern "C" {
#endif


typedef struct TraceTaskMonitorTaskData
{
    TraceTaskHandle_t xTaskHandle;
    TraceUnsignedBaseType_t uxTotal;
    TraceUnsignedBaseType_t uxLow;
    TraceUnsignedBaseType_t uxHigh;
    TraceUnsignedBaseType_t uxWatermarkLow;
    TraceUnsignedBaseType_t uxWatermarkHigh;
} TraceTaskMonitorTaskData_t;

typedef struct TraceTaskMonitorData /* Aligned */
{
    uint32_t uiPollTimestamp;
    uint32_t uiLastTimestamp[TRC_ALIGN_FLOOR(TRC_CFG_CORE_COUNT, 2) + 1];   /* Will FLOOR the core count to a multiple of 2, then add 1 to ensure aligned struct with uiPollTimestamp */
    TraceTaskMonitorCallback_t xCallback;
    TraceTaskMonitorTaskData_t xMonitoredTasks[TRC_CFG_TASK_MONITOR_MAX_TASKS];
    TraceTaskMonitorCallbackData_t xCallbackData; /* Data that will be used for callback */
} TraceTaskMonitorData_t;

traceResult xTraceTaskMonitorInitialize(TraceTaskMonitorData_t* pxBuffer);

traceResult xTraceTaskMonitorSetCallback(TraceTaskMonitorCallback_t xCallback);

traceResult xTraceTaskMonitorRegister(void* pvTask, TraceUnsignedBaseType_t uxLow, TraceUnsignedBaseType_t uxHigh);

traceResult xTraceTaskMonitorUnregister(void* pvTask);

traceResult xTraceTaskMonitorGetEmptySlot(TraceTaskMonitorTaskData_t** ppxData);

traceResult xTraceTaskMonitorSwitchOut(void* pvTask);

traceResult xTraceTaskMonitorPoll(void);

traceResult xTraceTaskMonitorPollReset(void);

traceResult xTraceTaskMonitorPrint(void);

 
#ifdef __cplusplus
}
#endif
 
#else
 
typedef struct TraceTaskMonitorData /* Aligned */
{
    TraceUnsignedBaseType_t dummy;
} TraceTaskMonitorData_t;
 
/* Empty defines */
#define xTraceTaskMonitorInitialize(_pxBuffer) TRC_COMMA_EXPR_TO_STATEMENT_EXPR_2((void)(_pxBuffer), TRC_SUCCESS)
#define xTraceTaskMonitorSetCallback(_xCallback) (TRC_FAIL)
#define xTraceTaskMonitorRegister(_pvTask, _uxLow, _uxHigh) TRC_COMMA_EXPR_TO_STATEMENT_EXPR_4((void)(_pvTask), (void)(_uxLow), (void)(_uxHigh), TRC_FAIL)
#define xTraceTaskMonitorUnregister(_pvTask) TRC_COMMA_EXPR_TO_STATEMENT_EXPR_2((void)(_pvTask), TRC_FAIL)
#define xTraceTaskMonitorGetData(_pvTask, _ppxData) TRC_COMMA_EXPR_TO_STATEMENT_EXPR_3((void)(_pvTask), (void)(_ppxData), TRC_FAIL)
#define xTraceTaskMonitorSwitchOut(_pvTask) TRC_COMMA_EXPR_TO_STATEMENT_EXPR_2((void)(_pvTask), TRC_FAIL)
#define xTraceTaskMonitorPoll() (TRC_FAIL)
#define xTraceTaskMonitorPrint() (TRC_FAIL)
 
#endif
 
#endif