RT_HEAP_INFO Struct Reference

Heap status descriptor. More...

Data Fields
int	nwaiters
	Number of tasks waiting for available memory in rt_heap_alloc().
int	mode
	Creation mode flags as given to rt_heap_create().
size_t	heapsize
	Size of heap (in bytes) as given to rt_heap_create(). More...
size_t	usablemem
	Maximum amount of memory available from the heap. More...
size_t	usedmem
	Amount of heap memory currently consumed. More...
char	name [XNOBJECT_NAME_LEN]
	Name of heap.

Detailed Description

Heap status descriptor.

This structure reports various static and runtime information about a real-time heap, returned by a call to rt_heap_inquire().

Field Documentation

heapsize

size_t RT_HEAP_INFO::heapsize

Size of heap (in bytes) as given to rt_heap_create().

The maximum amount of memory available from this heap may be larger, due to internal padding.

usablemem

size_t RT_HEAP_INFO::usablemem

Maximum amount of memory available from the heap.

This value accounts for the overhead of internal data structures required to maintain the heap.

usedmem

size_t RT_HEAP_INFO::usedmem

Amount of heap memory currently consumed.

info.usablemem - info.usedmem computes the current amount of free memory in the relevant heap.

---

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

• include/alchemy/heap.h