Zen API
 All Classes Files Functions Variables Typedefs Friends Macros Modules Pages
kHeapAlloc.h
Go to the documentation of this file.
1 
8 #ifndef K_API_HEAP_ALLOC_H
9 #define K_API_HEAP_ALLOC_H
10 
11 #include <kApi/kApiDef.h>
12 
23 typedef kStatus(kCall* kHeapAllocExhaustionFx)(kHeapAlloc heapAlloc, kPointer receiver, kSize minimumRegionSize);
24 
31 struct kHeapAllocStats
32 {
33  kSize memoryRegionsCount;
34 
35  kSize allocatedBlocksCount;
36  kSize allocatedBytesCount;
37 
38  kSize freeBlocksCount;
39  kSize freeBytesCount;
40 
41  kSize maxFreeBlockSize;
42 };
43 
66 // typedef kObject kHeapAlloc; --forward - declared in kFsDef.x.h
67 
68 
77 kFx(kStatus) kHeapAlloc_Construct(kHeapAlloc* heapAlloc, kAlloc allocator);
78 
91 kFx(kStatus) kHeapAlloc_AddMemoryRegion(kHeapAlloc heapAlloc, kPointer address, kSize size);
92 
103 kFx(kStatus) kHeapAlloc_RemoveMemoryRegions(kHeapAlloc heapAlloc);
104 
114 kFx(kStatus) kHeapAlloc_Clear(kHeapAlloc heapAlloc);
115 
126 kFx(kStatus) kHeapAlloc_Stats(kHeapAlloc heapAlloc, kHeapAllocStats* stats);
127 
140 kFx(kStatus) kHeapAlloc_AddExhaustionHandler(kHeapAlloc heapAlloc, kHeapAllocExhaustionFx callback, kPointer receiver);
141 
142 #endif
kHeapAllocStats
Structure for statistics calculated by the kHeapAlloc_Stats function.
Definition: kHeapAlloc.h:31
kPointer
Represents a void pointer.
kHeapAllocStats::freeBlocksCount
kSize freeBlocksCount
Number of free blocks available for allocations.
Definition: kHeapAlloc.h:38
kHeapAllocStats::freeBytesCount
kSize freeBytesCount
Number of bytes in all free blocks.
Definition: kHeapAlloc.h:39
kHeapAllocStats::memoryRegionsCount
kSize memoryRegionsCount
Number of memory regions added.
Definition: kHeapAlloc.h:33
kHeapAllocStats::allocatedBytesCount
kSize allocatedBytesCount
Number of bytes in all allocated memory blocks.
Definition: kHeapAlloc.h:36
kSize
Represents an unsigned integer that can store a pointer address.
kAlloc
Abstract base class for memory allocator types.
kHeapAllocStats::allocatedBlocksCount
kSize allocatedBlocksCount
Number of memory blocks allocated.
Definition: kHeapAlloc.h:35
kHeapAlloc::kHeapAlloc_AddMemoryRegion
kStatus kHeapAlloc_AddMemoryRegion(kHeapAlloc heapAlloc, kPointer address, kSize size)
Adds a pre-allocated memory region for use of the kHeapAlloc object.
kMsgQueueItemOption::kStatus
typedef kStatus(kCall *kMsgQueueDropFx)(kPointer receiver
Defines the signature of a callback function to handle dropped items.
kHeapAlloc::kHeapAllocExhaustionFx
kStatus(kCall * kHeapAllocExhaustionFx)(kHeapAlloc heapAlloc, kPointer receiver, kSize minimumRegionSize)
Signature of callback to notify about heap exhaustion.
Definition: kHeapAlloc.h:23
kHeapAllocStats::maxFreeBlockSize
kSize maxFreeBlockSize
The largest free block available for allocation.
Definition: kHeapAlloc.h:41
kApiDef.h
Core Zen type declarations.
kHeapAlloc::kHeapAlloc_RemoveMemoryRegions
kStatus kHeapAlloc_RemoveMemoryRegions(kHeapAlloc heapAlloc)
Removes all added memory regions.
kHeapAlloc::kHeapAlloc_Stats
kStatus kHeapAlloc_Stats(kHeapAlloc heapAlloc, kHeapAllocStats *stats)
Reports used and free blocks from all added memory regions.
kHeapAlloc
Allocates memory from user-defined memory regions.
kStatus
Represents an error code.
kHeapAlloc::kHeapAlloc_Construct
kStatus kHeapAlloc_Construct(kHeapAlloc *heapAlloc, kAlloc allocator)
Constructs a new kHeapAlloc instance.
kCall
#define kCall
kApi standard function calling convention.
Definition: kApiDef.h:15
kHeapAlloc::kHeapAlloc_AddExhaustionHandler
kStatus kHeapAlloc_AddExhaustionHandler(kHeapAlloc heapAlloc, kHeapAllocExhaustionFx callback, kPointer receiver)
Adds a callback that will be invoked upon memory exhaustion.
kHeapAlloc::kHeapAlloc_Clear
kStatus kHeapAlloc_Clear(kHeapAlloc heapAlloc)
Frees all memory allocations that have been made from this kHeapAlloc instance.