0545e9dc6d
commit d1edce71135cc6d98c0a4b5729774542b676e769 Author: sophgo-forum-service <forum_service@sophgo.com> Date: Fri Mar 15 16:07:33 2024 +0800 [fix] recommend using ssh method to clone repo. [fix] fix sensor driver repo branch name.
173 lines
4.8 KiB
C
Executable File
173 lines
4.8 KiB
C
Executable File
/*
|
|
* Percepio Trace Recorder for Tracealyzer v4.6.4
|
|
* Copyright 2021 Percepio AB
|
|
* www.percepio.com
|
|
*
|
|
* SPDX-License-Identifier: Apache-2.0
|
|
*/
|
|
|
|
/**
|
|
* @file
|
|
*
|
|
* @brief Public trace heap APIs.
|
|
*/
|
|
|
|
#ifndef TRC_HEAP_H
|
|
#define TRC_HEAP_H
|
|
|
|
#if (TRC_USE_TRACEALYZER_RECORDER == 1)
|
|
|
|
#if (TRC_CFG_RECORDER_MODE == TRC_RECORDER_MODE_STREAMING)
|
|
|
|
#ifndef TRC_USE_HEAPS
|
|
#define TRC_USE_HEAPS 1
|
|
#endif
|
|
|
|
#if (TRC_USE_HEAPS == 1)
|
|
|
|
#include <trcTypes.h>
|
|
|
|
#ifdef __cplusplus
|
|
extern "C" {
|
|
#endif
|
|
|
|
#define TRC_HEAP_STATE_INDEX_CURRENT 0
|
|
#define TRC_HEAP_STATE_INDEX_HIGHWATERMARK 1
|
|
#define TRC_HEAP_STATE_INDEX_MAX 2
|
|
|
|
/**
|
|
* @defgroup trace_heap_apis Trace Heap APIs
|
|
* @ingroup trace_recorder_apis
|
|
* @{
|
|
*/
|
|
|
|
/**
|
|
* @brief Creates trace heap.
|
|
*
|
|
* @param[in] szName Name.
|
|
* @param[in] uxCurrent Current level.
|
|
* @param[in] uxHighWaterMark High water mark
|
|
* @param[in] uxMax Maximum level.
|
|
* @param[out] pxHeapHandle Pointer to uninitialized trace heap handle.
|
|
* @return traceResult
|
|
*/
|
|
traceResult xTraceHeapCreate(const char *szName, TraceUnsignedBaseType_t uxCurrent, TraceUnsignedBaseType_t uxHighWaterMark, TraceUnsignedBaseType_t uxMax, TraceHeapHandle_t *pxHeapHandle);
|
|
|
|
/**
|
|
* @brief Signals trace heap alloc.
|
|
*
|
|
* @param[in] xHeapHandle Trace heap handle.
|
|
* @param[in] pvAddress Address.
|
|
* @param[in] uxSize Size.
|
|
*
|
|
* @retval TRC_FAIL Failure
|
|
* @retval TRC_SUCCESS Success
|
|
*/
|
|
traceResult xTraceHeapAlloc(TraceHeapHandle_t xHeapHandle, void *pvAddress, TraceUnsignedBaseType_t uxSize);
|
|
|
|
/**
|
|
* @brief Signals trace heap free.
|
|
*
|
|
* @param[in] xHeapHandle Trace heap handle.
|
|
* @param[in] pvAddress Address.
|
|
* @param[in] uxSize Size.
|
|
*
|
|
* @retval TRC_FAIL Failure
|
|
* @retval TRC_SUCCESS Success
|
|
*/
|
|
traceResult xTraceHeapFree(TraceHeapHandle_t xHeapHandle, void* pvAddress, TraceUnsignedBaseType_t uxSize);
|
|
|
|
/**
|
|
* @brief Gets trace heap current allocation size.
|
|
*
|
|
* @param[in] xHeapHandle Trace heap handle.
|
|
* @param[out] puxCurrent Current.
|
|
*
|
|
* @retval TRC_FAIL Failure
|
|
* @retval TRC_SUCCESS Success
|
|
*/
|
|
#define xTraceHeapGetCurrent(xHeapHandle, puxCurrent) xTraceEntryGetState(xHeapHandle, TRC_HEAP_STATE_INDEX_CURRENT, puxCurrent)
|
|
|
|
/**
|
|
* @brief Sets trace heap current allocation size.
|
|
*
|
|
* @param[in] xHeapHandle Trace heap handle.
|
|
* @param[in] uxCurrent Current.
|
|
*
|
|
* @retval TRC_FAIL Failure
|
|
* @retval TRC_SUCCESS Success
|
|
*/
|
|
#define xTraceHeapSetCurrent(xHeapHandle, uxCurrent) xTraceEntrySetState(xHeapHandle, TRC_HEAP_STATE_INDEX_CURRENT, uxCurrent)
|
|
|
|
/**
|
|
* @brief Gets trace heap high water mark.
|
|
*
|
|
* @param[in] xHeapHandle Trace heap handle.
|
|
* @param[out] puxHighWaterMark High water mark.
|
|
*
|
|
* @retval TRC_FAIL Failure
|
|
* @retval TRC_SUCCESS Success
|
|
*/
|
|
#define xTraceHeapGetHighWaterMark(xHeapHandle, puxHighWaterMark) xTraceEntryGetState(xHeapHandle, TRC_HEAP_STATE_INDEX_HIGHWATERMARK, puxHighWaterMark)
|
|
|
|
/**
|
|
* @brief Sets trace heap high water mark.
|
|
*
|
|
* @param[in] xHeapHandle Trace heap handle.
|
|
* @param[in] uxHighWaterMark High water mark.
|
|
*
|
|
* @retval TRC_FAIL Failure
|
|
* @retval TRC_SUCCESS Success
|
|
*/
|
|
#define xTraceHeapSetHighWaterMark(xHeapHandle, uxHighWaterMark) xTraceEntrySetState(xHeapHandle, TRC_HEAP_STATE_INDEX_HIGHWATERMARK, uxHighWaterMark)
|
|
|
|
/**
|
|
* @brief Gets trace heap max size.
|
|
*
|
|
* @param[in] xHeapHandle Trace heap handle.
|
|
* @param[out] puxMax Max.
|
|
*
|
|
* @retval TRC_FAIL Failure
|
|
* @retval TRC_SUCCESS Success
|
|
*/
|
|
#define xTraceHeapGetMax(xHeapHandle, puxMax) xTraceEntryGetState(xHeapHandle, TRC_HEAP_STATE_INDEX_MAX, puxMax)
|
|
|
|
/**
|
|
* @brief Sets trace heap max size.
|
|
*
|
|
* @param[in] xHeapHandle Trace heap handle.
|
|
* @param[in] uxMax Max heap size.
|
|
*
|
|
* @retval TRC_FAIL Failure
|
|
* @retval TRC_SUCCESS Success
|
|
*/
|
|
#define xTraceHeapSetMax(xHeapHandle, uxMax) xTraceEntrySetState(xHeapHandle, TRC_HEAP_STATE_INDEX_MAX, uxMax)
|
|
|
|
/** @} */
|
|
|
|
#ifdef __cplusplus
|
|
}
|
|
#endif
|
|
|
|
#else
|
|
|
|
#define xTraceHeapCreate(szName, uxCurrent, uxHighWaterMark, uxMax, pxHeapHandle) ((void)szName, (void)uxCurrent, (void)uxHighWaterMark, (void)uxMax, pxHeapHandle != 0 ? TRC_SUCCESS : TRC_FAIL)
|
|
|
|
#define xTraceHeapAlloc(xHeapHandle, pvAddress, uxSize) ((void)xHeapHandle, (void)pvAddress, (void)uxSize, TRC_SUCCESS)
|
|
|
|
#define xTraceHeapFree(xHeapHandle, pvAddress, uxSize) ((void)xHeapHandle, (void)pvAddress, (void)uxSize, TRC_SUCCESS)
|
|
|
|
#define xTraceHeapGetCurrent(xHeapHandle, puxCurrent) ((void)xHeapHandle, puxCurrent != 0 ? *puxCurrent = 0 : 0, puxCurrent != 0 ? TRC_SUCCESS : TRC_FAIL)
|
|
|
|
#define xTraceHeapGetHighWaterMark(xHeapHandle, puxHighWaterMark) ((void)xHeapHandle, puxHighWaterMark != 0 ? *puxHighWaterMark = 0 : 0, puxHighWaterMark != 0 ? TRC_SUCCESS : TRC_FAIL)
|
|
|
|
#define xTraceHeapGetMax(xHeapHandle, puxMax) ((void)xHeapHandle, puxMax != 0 ? *puxMax = 0 : 0, puxMax != 0 ? TRC_SUCCESS : TRC_FAIL)
|
|
|
|
#endif /* (TRC_USE_HEAPS == 1) */
|
|
|
|
#endif /* (TRC_CFG_RECORDER_MODE == TRC_RECORDER_MODE_STREAMING) */
|
|
|
|
#endif /* (TRC_USE_TRACEALYZER_RECORDER == 1) */
|
|
|
|
#endif /* TRC_HEAP_H */
|