Header file of Heap Management related APIs. More...
#include <clPoolIpi.h>#include <clMemStats.h>Go to the source code of this file.
Classes | |
| struct | ClHeapConfigT |
| ClHeapConfigT to be fetched by EO and contains the configuration of the heap library. More... | |
Enumerations | |
| enum | ClHeapModeT { CL_HEAP_PREALLOCATED_MODE, CL_HEAP_NATIVE_MODE, CL_HEAP_CUSTOM_MODE } |
| Heap Allocation modes. More... | |
Functions | |
| ClPtrT | clHeapAllocate (CL_IN ClUint32T size) |
| Allocates memory of the requested size. | |
| ClPtrT | clHeapCalloc (CL_IN ClUint32T numChunks, CL_IN ClUint32T chunkSize) |
| Allocates memory for an array and initializes it to zero. | |
| void | clHeapFree (CL_IN ClPtrT pAddress) |
| Frees a pre-allocated memory. | |
| ClRcT | clHeapHooksDeregister (void) |
| De-registers the hooks registered for CL_HEAP_CUSTOM_MODE. | |
| ClRcT | clHeapHooksRegister (CL_IN ClPtrT(*allocHook)(ClUint32T), CL_IN ClPtrT(*reallocHook)(ClPtrT, ClUint32T), CL_IN ClPtrT(*callocHook)(ClUint32T, ClUint32T), CL_IN void(*freeHook)(ClPtrT)) |
| Register functions to be used in CL_HEAP_CUSTOM_MODE. | |
| ClRcT | clHeapLibCustomFinalize (void) |
| Customizes the finalization of heap library in CL_HEAP_CUSTOM_MODE. | |
| ClRcT | clHeapLibCustomInitialize (const ClHeapConfigT *pHeapConfig) |
| Customizes the initialization of heap library in CL_HEAP_CUSTOM_MODE. | |
| ClRcT | clHeapLibFinalize (void) |
| Finalizes the heap library. | |
| ClRcT | clHeapLibInitialize (CL_IN const ClHeapConfigT *pHeapConfig) |
| Initializes the heap library. | |
| ClRcT | clHeapModeGet (CL_OUT ClHeapModeT *pMode) |
| Returns the mode set during configuration. | |
| ClRcT | clHeapPoolStatsGet (CL_IN ClUint32T numPools, CL_OUT ClUint32T *pPoolSize, CL_OUT ClPoolStatsT *pHeapPoolStats) |
| Returns the statistics collected by heap library for an individual pool. | |
| ClPtrT | clHeapRealloc (CL_IN ClPtrT pAddress, CL_IN ClUint32T size) |
| Changes the size of the memory block (chunk). | |
| ClRcT | clHeapShrink (CL_IN const ClPoolShrinkOptionsT *pShrinkOptions) |
| Shrinks the configured pools of memory. | |
| ClRcT | clHeapStatsGet (CL_OUT ClMemStatsT *pHeapStats) |
| Returns the statistics collected by heap module. | |
Header file of Heap Management related APIs.