SuperTinyKernel™ RTOS 1.06.x
Lightweight, high-performance, deterministic, bare-metal C++ RTOS for resource-constrained embedded systems. MIT Open Source License.
Loading...
Searching...
No Matches
HeapStats_t Struct Reference
STK FreeRTOS API

#include <FreeRTOS.h>

Public Attributes

size_t xAvailableHeapSpaceInBytes
size_t xSizeOfLargestFreeBlockInBytes
size_t xSizeOfSmallestFreeBlockInBytes
size_t xNumberOfFreeBlocks
size_t xMinimumEverFreeBytesRemaining
size_t xNumberOfSuccessfulAllocations
size_t xNumberOfSuccessfulFrees

Detailed Description

Heap statistics snapshot filled by vPortGetHeapStats().

Note
Fields xNumberOfSuccessfulAllocations and xNumberOfSuccessfulFrees are reported as 0 in this implementation because the underlying allocator delegates to the system malloc and does not maintain per-call counters. All other fields are derived from s_MemStats.

Definition at line 1975 of file FreeRTOS.h.

Member Data Documentation

◆ xAvailableHeapSpaceInBytes

size_t HeapStats_t::xAvailableHeapSpaceInBytes

Current free bytes remaining.

Definition at line 1977 of file FreeRTOS.h.

Referenced by vPortGetHeapStats().

◆ xMinimumEverFreeBytesRemaining

size_t HeapStats_t::xMinimumEverFreeBytesRemaining

Lowest free byte count recorded since system start.

Definition at line 1981 of file FreeRTOS.h.

Referenced by vPortGetHeapStats().

◆ xNumberOfFreeBlocks

size_t HeapStats_t::xNumberOfFreeBlocks

Number of free blocks (1 if any free bytes exist).

Definition at line 1980 of file FreeRTOS.h.

Referenced by vPortGetHeapStats().

◆ xNumberOfSuccessfulAllocations

size_t HeapStats_t::xNumberOfSuccessfulAllocations

Allocation call count (not tracked; always 0).

Definition at line 1982 of file FreeRTOS.h.

Referenced by vPortGetHeapStats().

◆ xNumberOfSuccessfulFrees

size_t HeapStats_t::xNumberOfSuccessfulFrees

Free call count (not tracked; always 0).

Definition at line 1983 of file FreeRTOS.h.

Referenced by vPortGetHeapStats().

◆ xSizeOfLargestFreeBlockInBytes

size_t HeapStats_t::xSizeOfLargestFreeBlockInBytes

Largest single free block (reported as free total).

Definition at line 1978 of file FreeRTOS.h.

Referenced by vPortGetHeapStats().

◆ xSizeOfSmallestFreeBlockInBytes

size_t HeapStats_t::xSizeOfSmallestFreeBlockInBytes

Smallest free block (1 if any free bytes exist).

Definition at line 1979 of file FreeRTOS.h.

Referenced by vPortGetHeapStats().

The documentation for this struct was generated from the following file: