Common Memory Heap

Data Structures
struct	MEMHeapHeader

Typedefs
typedef struct MEMHeapHeader	MEMHeapHeader
typedef enum MEMHeapFillType	MEMHeapFillType
typedef enum MEMHeapTag	MEMHeapTag
typedef enum MEMHeapFlags	MEMHeapFlags

Enumerations
enum	MEMHeapFillType
enum	MEMHeapTag
enum	MEMHeapFlags

Functions
void	MEMDumpHeap (MEMHeapHeader *heap)
MEMHeapHeader *	MEMFindContainHeap (void *block)
uint32_t	MEMGetFillValForHeap (MEMHeapFillType type)
void	MEMSetFillValForHeap (MEMHeapFillType type, uint32_t value)

Detailed Description

Common memory heap fucntions.

Typedef Documentation

typedef struct MEMHeapHeader MEMHeapHeader

Definition at line 18 of file memheap.h.

typedef enum MEMHeapFillType MEMHeapFillType

typedef enum MEMHeapTag MEMHeapTag

typedef enum MEMHeapFlags MEMHeapFlags

Enumeration Type Documentation

enum MEMHeapFillType

Enumerator
MEM_HEAP_FILL_TYPE_UNUSED
MEM_HEAP_FILL_TYPE_ALLOCATED
MEM_HEAP_FILL_TYPE_FREED

Definition at line 20 of file memheap.h.

enum MEMHeapTag

Enumerator
MEM_BLOCK_HEAP_TAG
MEM_EXPANDED_HEAP_TAG
MEM_FRAME_HEAP_TAG
MEM_UNIT_HEAP_TAG
MEM_USER_HEAP_TAG

Definition at line 27 of file memheap.h.

enum MEMHeapFlags

Enumerator
MEM_HEAP_FLAG_ZERO_ALLOCATED
MEM_HEAP_FLAG_DEBUG_MODE
MEM_HEAP_FLAG_USE_LOCK

Definition at line 36 of file memheap.h.

Function Documentation

void MEMDumpHeap

(

MEMHeapHeader *

heap

)

Print details about heap to COSWarn

MEMHeapHeader* MEMFindContainHeap

(

void *

block

)

Find heap which contains a memory block.

uint32_t MEMGetFillValForHeap

(

MEMHeapFillType

type

)

Get the data fill value used when MEM_HEAP_FLAG_DEBUG_MODE is set.

void MEMSetFillValForHeap	(	MEMHeapFillType	type,
		uint32_t	value
	)

Set the data fill value used when MEM_HEAP_FLAG_DEBUG_MODE is set.