FreeRTOS-Kernel/FreeRTOS-Plus/Source/FreeRTOS-Plus-Trace/trcHeap.c
Soren Ptak 3a2f6646f0
Use CI-CD-Github-Actions for spelling and formatting, add in the bot formatting action, update the CI-CD workflow files. Fix incorrect spelling and formatting on files. (#1083)
* Use new version of CI-CD Actions,  checkout@v3 instead of checkout@v2 on all jobs
* Use cSpell spell check, and use ubuntu-20.04 for formatting check
* Add in bot formatting action
* Update freertos_demo.yml and freertos_plus_demo.yml files to increase github log readability
* Add in a Qemu demo onto the workflows.
2023-09-06 12:35:37 -07:00

172 lines
7 KiB
C

/*
* Percepio Trace Recorder for Tracealyzer v4.6.0
* Copyright 2021 Percepio AB
* www.percepio.com
*
* SPDX-License-Identifier: Apache-2.0
*
* The implementation for heaps.
*/
#include <trcRecorder.h>
#if ( TRC_USE_TRACEALYZER_RECORDER == 1 )
#if ( TRC_CFG_RECORDER_MODE == TRC_RECORDER_MODE_STREAMING )
#if ( TRC_USE_HEAPS == 1 )
#define TRC_HEAP_STATE_INDEX_CURRENT 0
#define TRC_HEAP_STATE_INDEX_HIGHWATERMARK 1
#define TRC_HEAP_STATE_INDEX_MAX 2
traceResult xTraceHeapCreate( const char * szName,
TraceUnsignedBaseType_t uxCurrent,
TraceUnsignedBaseType_t uxHighWaterMark,
TraceUnsignedBaseType_t uxMax,
TraceHeapHandle_t * pxHeapHandle )
{
TraceObjectHandle_t xObjectHandle;
TraceUnsignedBaseType_t uxStates[ 3 ];
/* This should never fail */
TRC_ASSERT( pxHeapHandle != 0 );
uxStates[ TRC_HEAP_STATE_INDEX_CURRENT ] = uxCurrent;
uxStates[ TRC_HEAP_STATE_INDEX_HIGHWATERMARK ] = uxHighWaterMark;
uxStates[ TRC_HEAP_STATE_INDEX_MAX ] = uxMax;
/* We need to check this */
if( xTraceObjectRegisterInternal( PSF_EVENT_HEAP_CREATE, 0, szName, 3, uxStates, TRC_ENTRY_OPTION_HEAP, &xObjectHandle ) == TRC_FAIL )
{
return TRC_FAIL;
}
*pxHeapHandle = ( TraceHeapHandle_t ) xObjectHandle;
return TRC_SUCCESS;
}
traceResult xTraceHeapAlloc( TraceHeapHandle_t xHeapHandle,
void * pvAddress,
TraceUnsignedBaseType_t uxSize )
{
TraceUnsignedBaseType_t uxCurrent, uxHighWaterMark;
TraceEventHandle_t xEventHandle = 0;
if( xHeapHandle == 0 )
{
/* This can happen */
return TRC_FAIL;
}
/* If the address is null we assume this was a failed alloc attempt */
if( pvAddress != 0 )
{
/* This should never fail */
TRC_ASSERT_ALWAYS_EVALUATE( xTraceEntryGetState( xHeapHandle, TRC_HEAP_STATE_INDEX_CURRENT, &uxCurrent ) == TRC_SUCCESS );
/* This should never fail */
TRC_ASSERT_ALWAYS_EVALUATE( xTraceEntryGetState( xHeapHandle, TRC_HEAP_STATE_INDEX_HIGHWATERMARK, &uxHighWaterMark ) == TRC_SUCCESS );
uxCurrent += uxSize;
if( uxCurrent > uxHighWaterMark )
{
uxHighWaterMark = uxCurrent;
/* This should never fail */
TRC_ASSERT_ALWAYS_EVALUATE( xTraceEntrySetState( xHeapHandle, TRC_HEAP_STATE_INDEX_HIGHWATERMARK, uxHighWaterMark ) == TRC_SUCCESS );
}
/* This should never fail */
TRC_ASSERT_ALWAYS_EVALUATE( xTraceEntrySetState( xHeapHandle, TRC_HEAP_STATE_INDEX_CURRENT, uxCurrent ) == TRC_SUCCESS );
}
/* We need to check this */
if( xTraceEventBegin( ( pvAddress != 0 ) ? PSF_EVENT_MALLOC : PSF_EVENT_MALLOC_FAILED, sizeof( void * ) + sizeof( TraceUnsignedBaseType_t ), &xEventHandle ) == TRC_SUCCESS )
{
xTraceEventAddPointer( xEventHandle, pvAddress );
xTraceEventAddUnsignedBaseType( xEventHandle, uxSize );
xTraceEventEnd( xEventHandle );
}
return TRC_SUCCESS;
}
traceResult xTraceHeapFree( TraceHeapHandle_t xHeapHandle,
void * pvAddress,
TraceUnsignedBaseType_t uxSize )
{
TraceUnsignedBaseType_t uxCurrent;
TraceEventHandle_t xEventHandle = 0;
if( xHeapHandle == 0 )
{
/* This can happen */
return TRC_FAIL;
}
/* If the address is null we assume this was a failed alloc attempt */
if( pvAddress != 0 )
{
/* This should never fail */
TRC_ASSERT_ALWAYS_EVALUATE( xTraceEntryGetState( xHeapHandle, TRC_HEAP_STATE_INDEX_CURRENT, &uxCurrent ) == TRC_SUCCESS );
uxCurrent -= uxSize;
/* This should never fail */
TRC_ASSERT_ALWAYS_EVALUATE( xTraceEntrySetState( xHeapHandle, TRC_HEAP_STATE_INDEX_CURRENT, uxCurrent ) == TRC_SUCCESS );
}
/* We need to check this */
if( xTraceEventBegin( ( pvAddress != 0 ) ? PSF_EVENT_FREE : PSF_EVENT_FREE_FAILED, sizeof( void * ) + sizeof( TraceUnsignedBaseType_t ), &xEventHandle ) == TRC_SUCCESS )
{
xTraceEventAddPointer( xEventHandle, pvAddress );
xTraceEventAddUnsignedBaseType( xEventHandle, uxSize );
xTraceEventEnd( xEventHandle );
}
return TRC_SUCCESS;
}
traceResult xTraceHeapGetCurrent( TraceHeapHandle_t xHeapHandle,
TraceUnsignedBaseType_t * puxCurrent )
{
/* This should never fail */
TRC_ASSERT( xHeapHandle != 0 );
/* This should never fail */
TRC_ASSERT_ALWAYS_EVALUATE( xTraceEntryGetState( xHeapHandle, TRC_HEAP_STATE_INDEX_CURRENT, puxCurrent ) == TRC_SUCCESS );
return TRC_SUCCESS;
}
traceResult xTraceHeapGetHighWaterMark( TraceHeapHandle_t xHeapHandle,
TraceUnsignedBaseType_t * puxHighWaterMark )
{
/* This should never fail */
TRC_ASSERT( xHeapHandle != 0 );
/* This should never fail */
TRC_ASSERT_ALWAYS_EVALUATE( xTraceEntryGetState( xHeapHandle, TRC_HEAP_STATE_INDEX_HIGHWATERMARK, puxHighWaterMark ) == TRC_SUCCESS );
return TRC_SUCCESS;
}
traceResult xTraceHeapGetMax( TraceHeapHandle_t xHeapHandle,
TraceUnsignedBaseType_t * puxMax )
{
/* This should never fail */
TRC_ASSERT( xHeapHandle != 0 );
/* This should never fail */
TRC_ASSERT_ALWAYS_EVALUATE( xTraceEntryGetState( xHeapHandle, TRC_HEAP_STATE_INDEX_MAX, puxMax ) == TRC_SUCCESS );
return TRC_SUCCESS;
}
#endif /* (TRC_USE_HEAPS == 1) */
#endif /* (TRC_CFG_RECORDER_MODE == TRC_RECORDER_MODE_STREAMING) */
#endif /* (TRC_USE_TRACEALYZER_RECORDER == 1) */