AM263Px MCU+ SDK: HeapP_MemStats Struct Reference

| AM263Px MCU+ SDK 26.00.00 |

Data Fields
HeapP_MemStats Struct Reference
APIs for Driver Porting Layer » APIs for Heap management

## Detailed Description

Structure used to pass information about the heap out of HeapP_getHeapStats().

## Data Fields
size_t | availableHeapSpaceInBytes
size_t | sizeOfLargestFreeBlockInBytes
size_t | sizeOfSmallestFreeBlockInBytes
size_t | numberOfFreeBlocks
size_t | minimumEverFreeBytesRemaining
size_t | numberOfSuccessfulAllocations
size_t | numberOfSuccessfulFrees

## Field Documentation

## ◆ availableHeapSpaceInBytes

size_t HeapP_MemStats::availableHeapSpaceInBytes

The total heap size, in bytes, currently available - this is the sum of all the free blocks, not the largest block that can be allocated.

## ◆ sizeOfLargestFreeBlockInBytes

size_t HeapP_MemStats::sizeOfLargestFreeBlockInBytes

The maximum size, in bytes, of all the free blocks within the heap at the time vPortGetHeapStats() is called.

## ◆ sizeOfSmallestFreeBlockInBytes

size_t HeapP_MemStats::sizeOfSmallestFreeBlockInBytes

The minimum size, in bytes, of all the free blocks within the heap at the time vPortGetHeapStats() is called.

## ◆ numberOfFreeBlocks

size_t HeapP_MemStats::numberOfFreeBlocks

The number of free memory blocks within the heap at the time vPortGetHeapStats() is called.

## ◆ minimumEverFreeBytesRemaining

size_t HeapP_MemStats::minimumEverFreeBytesRemaining

The minimum amount of total free memory, in bytes, (sum of all free blocks) there has been in the heap since the system booted.

## ◆ numberOfSuccessfulAllocations

size_t HeapP_MemStats::numberOfSuccessfulAllocations

The number of calls to HeapP_alloc() that have returned a valid memory block.

## ◆ numberOfSuccessfulFrees

size_t HeapP_MemStats::numberOfSuccessfulFrees

The number of calls to HeapP_free() that has successfully freed a block of memory.