Unit HeapManager

Return to Unit Reference

Description

---

To be documented

Constants

---

To be documented

Type definitions

---

To be documented

Public variables

---

To be documented

Function declarations

---

Initialization functions

[Expand]

procedure RegisterMemoryManager;

Description: To be documented

Note	To be documented

[Expand]

procedure RegisterHeapBlock(Address:Pointer; Size:PtrUInt);

Description: To be documented

Note	To be documented

[Expand]

function RequestHeapBlock(Hint:Pointer; Size:PtrUInt; Flags,Affinity:LongWord):Pointer;

Description: Request registration a Heap Block with specified flags and affinity within an existing block

Hint	The hint provides the requested base address of the heap block but may be overridden by the memory manager if the block is already partially or fully allocated, pass nil if any heap block is suitable
Size	The size provides the requested size of the heap block. Size must be a power of 2 and both Hint and the returned pointer must be aligned on a multiple of HEAP_REQUEST_ALIGNMENT. Flags provides the heap block flags such as shared, local, code, device, nocache etc.
Affinity	The affinity provides the processor affinity mask, a mask of 0 indicates no specific processor
Return	The return is the heap block that has been registered or nil if the request failed
Note	To allocate this memory use GetMemEx / AllocMemEx etc. The return value points directly to the heap block, to access the memory referenced by the heap block you must add SizeOf(THeapBlock) to this value.

[Expand]

function RequestSharedHeapBlock(Hint:Pointer; Size:PtrUInt):Pointer;

Description: Request registration of a Shared Heap Block within an existing block

Hint	The hint provides the requested base address of the shared heap block but may be overridden by the memory manager if the block is already partially or fully allocated, pass nil if any heap block is suitable
Size	The size provides the requested size of the heap block. Size must be a power of 2 and both Hint and the returned pointer must be aligned on a multiple of HEAP_REQUEST_ALIGNMENT.
Return	The return is the heap block that has been marked as shared or nil if the request failed (the memory management unit should mark this region of memory as sharable)
Note	To allocate shared memory use GetSharedMem / AllocSharedMem etc. The return value points directly to the heap block, to access the memory referenced by the heap block you must add SizeOf(THeapBlock) to this value.

[Expand]

function RequestLocalHeapBlock(Hint:Pointer; Size:PtrUInt; Affinity:LongWord):Pointer;

Description: Request registration of a Local Heap Block within an existing block

Hint	The hint provides a requested base address of the local heap block but may be overridden by the memory manager if the block is already partially or fully allocated, pass nil if any heap block is suitable
Size	The size provides the requested size of the heap block. Size must be a power of 2 and both Hint and the returned pointer must be aligned on a multiple of HEAP_REQUEST_ALIGNMENT.
Affinity	The affinity provides the processor affinity mask, a mask of 0 indicates no specific processor
Return	The return is the heap block that has been marked as local or nil if the request failed (The memory management unit should mark this region of memory as local or non global)
Note	To allocate local memory use GetLocalMem / AllocLocalMem etc. The return value points directly to the heap block, to access the memory referenced by the heap block you must add SizeOf(THeapBlock) to this value.

[Expand]

function RequestCodeHeapBlock(Hint:Pointer; Size:PtrUInt; Affinity:LongWord):Pointer;

Description: Request registration of a Code Heap Block within an existing block

Hint	The hint provides a requested base address of the code heap block but may be overridden by the memory manager if the block is already partially or fully allocated, pass nil if any heap block is suitable
Size	The size provides the requested size of the heap block. Size must be a power of 2 and both Hint and the returned pointer must be aligned on a multiple of HEAP_REQUEST_ALIGNMENT.
Affinity	The affinity provides the processor affinity mask, a mask of 0 indicates no specific processor
Return	The return is the heap block that has been marked as code or nil if the request failed (The memory management unit should mark this region of memory as executable)
Note	To allocate code memory use GetCodeMem / AllocCodeMem etc. The return value points directly to the heap block, to access the memory referenced by the heap block you must add SizeOf(THeapBlock) to this value.

[Expand]

function RequestDeviceHeapBlock(Hint:Pointer; Size:PtrUInt):Pointer;

Description: Request registration of a Device Heap Block within an existing block

Hint	The hint provides the requested base address of the device heap block but may be overridden by the memory manager if the block is already partially or fully allocated, pass nil if any heap block is suitable
Size	The size provides the requested size of the heap block. Size must be a power of 2 and both Hint and the returned pointer must be aligned on a multiple of HEAP_REQUEST_ALIGNMENT.
Return	The return is the heap block that has been marked as device or nil if the request failed (The memory management unit should mark this region of memory as sharable)
Note	To allocate device memory use GetDeviceMem / AllocDeviceMem etc. The return value points directly to the heap block, to access the memory referenced by the heap block you must add SizeOf(THeapBlock) to this value.

[Expand]

function RequestNoCacheHeapBlock(Hint:Pointer; Size:PtrUInt):Pointer;

Description: Request registration of a Non Cached Heap Block within an existing block

Hint	The hint provides the requested base address of the non cached heap block but may be overridden by the memory manager if the block is already partially or fully allocated, pass nil if any heap block is suitable
Size	The size provides the requested size of the heap block. Size must be a power of 2 and both Hint and the returned pointer must be aligned on a multiple of HEAP_REQUEST_ALIGNMENT.
Return	The return is the heap block that has been marked as non cached or nil if the request failed (The memory management unit should mark this region of memory as sharable)
Note	To allocate non cached memory use GetNoCacheMem / AllocNoCacheMem etc. The return value points directly to the heap block, to access the memory referenced by the heap block you must add SizeOf(THeapBlock) to this value.

[Expand]

function RequestNonSharedHeapBlock(Hint:Pointer; Size:PtrUInt):Pointer;

Description: Request registration of a Non Shared Heap Block within an existing block

Hint	The hint provides the requested base address of the non shared heap block but may be overridden by the memory manager if the block is already partially or fully allocated, pass nil if any heap block is suitable
Size	The size provides the requested size of the heap block. Size must be a power of 2 and both Hint and the returned pointer must be aligned on a multiple of HEAP_REQUEST_ALIGNMENT.
Return	The return is the heap block that has been marked as non shared or nil if the request failed (The memory management unit should mark this region of memory as sharable)
Note	To allocate non shared memory use GetNonSharedMem / AllocNonSharedMem etc. The return value points directly to the heap block, to access the memory referenced by the heap block you must add SizeOf(THeapBlock) to this value.

[Expand]

function RequestIRQHeapBlock(Hint:Pointer; Size:PtrUInt; Affinity:LongWord):Pointer;

Description: Request registration of an IRQ Heap Block within an existing block

Hint	The hint provides a requested base address of the IRQ heap block but may be overridden by the memory manager if the block is already partially or fully allocated, pass nil if any heap block is suitable
Size	The size provides the requested size of the heap block. Size must be a power of 2 and both Hint and the returned pointer must be aligned on a multiple of HEAP_REQUEST_ALIGNMENT.
Affinity	The affinity provides the processor affinity mask, a mask of 0 indicates no specific processor
Return	The return is the heap block that has been marked as IRQ or nil if the request failed
Note	To allocate IRQ memory use GetIRQMem / AllocIRQMem etc. The return value points directly to the heap block, to access the memory referenced by the heap block you must add SizeOf(THeapBlock) to this value.

[Expand]

function RequestFIQHeapBlock(Hint:Pointer; Size:PtrUInt; Affinity:LongWord):Pointer;

Description: Request registration of an FIQ Heap Block within an existing block

Hint	The hint provides a requested base address of the FIQ heap block but may be overridden by the memory manager if the block is already partially or fully allocated, pass nil if any heap block is suitable
Size	The size provides the requested size of the heap block. Size must be a power of 2 and both Hint and the returned pointer must be aligned on a multiple of HEAP_REQUEST_ALIGNMENT.
Affinity	The affinity provides the processor affinity mask, a mask of 0 indicates no specific processor
Return	The return is the heap block that has been marked as FIQ or nil if the request failed
Note	To allocate FIQ memory use GetFIQMem / AllocFIQMem etc. The return value points directly to the heap block, to access the memory referenced by the heap block you must add SizeOf(THeapBlock) to this value.

Heap functions

[Expand]

function GetMemEx(Size:PtrUInt; Flags,Affinity:LongWord):Pointer;

Description: Allocate a block of memory with the flags and affinity requested

Note	To be documented

[Expand]

function GetAlignedMem(Size,Alignment:PtrUInt):Pointer;

Description: Allocate a block of normal memory aligned on a multiple of the alignment value

Alignment	The alignment must be a multiple of the minimum alignment configuration

[Expand]

function GetAlignedMemEx(Size,Alignment:PtrUInt; Flags,Affinity:LongWord):Pointer;

Description: Allocate a block of memory aligned on a multiple of the alignment value with the flags and affinity requested

Alignment	The alignment must be a multiple of the minimum alignment configuration

[Expand]

function GetSharedMem(Size:PtrUInt):Pointer;

Description: Allocate a block of shared memory

Note	To be documented

[Expand]

function GetSharedAlignedMem(Size,Alignment:PtrUInt):Pointer;

Description: Allocate a block of shared memory aligned on a multiple of the alignment value

Alignment	The alignment must be a multiple of the minimum alignment configuration

[Expand]

function GetLocalMem(Size:PtrUInt; Affinity:LongWord):Pointer;

Description: Allocate a block of local memory

Note	To be documented

[Expand]

function GetLocalAlignedMem(Size,Alignment:PtrUInt; Affinity:LongWord):Pointer;

Description: Allocate a block of local memory aligned on a multiple of the alignment value

Alignment	The alignment must be a multiple of the minimum alignment configuration

[Expand]

function GetCodeMem(Size:PtrUInt; Affinity:LongWord):Pointer;

Description: Allocate a block of code memory

Note	To be documented

[Expand]

function GetCodeAlignedMem(Size,Alignment:PtrUInt; Affinity:LongWord):Pointer;

Description: Allocate a block of code memory aligned on a multiple of the alignment value

Alignment	The alignment must be a multiple of the minimum alignment configuration

[Expand]

function GetDeviceMem(Size:PtrUInt):Pointer;

Description: Allocate a block of device memory

Note	To be documented

[Expand]

function GetDeviceAlignedMem(Size,Alignment:PtrUInt):Pointer;

Description: Allocate a block of device memory aligned on a multiple of the alignment value

Alignment	The alignment must be a multiple of the minimum alignment configuration

[Expand]

function GetNoCacheMem(Size:PtrUInt):Pointer;

Description: Allocate a block of non cached memory

Note	To be documented

[Expand]

function GetNoCacheAlignedMem(Size,Alignment:PtrUInt):Pointer;

Description: Allocate a block of non cached memory aligned on a multiple of the alignment value

Alignment	The alignment must be a multiple of the minimum alignment configuration

[Expand]

function GetNonSharedMem(Size:PtrUInt):Pointer;

Description: Allocate a block of non shared memory

Note	To be documented

[Expand]

function GetNonSharedAlignedMem(Size,Alignment:PtrUInt):Pointer;

Description: Allocate a block of non shared memory aligned on a multiple of the alignment value

Alignment	The alignment must be a multiple of the minimum alignment configuration

[Expand]

function GetIRQMem(Size:PtrUInt; Affinity:LongWord):Pointer;

Description: Allocate a block of IRQ memory

Note	To be documented

[Expand]

function GetIRQAlignedMem(Size,Alignment:PtrUInt; Affinity:LongWord):Pointer;

Description: Allocate a block of IRQ memory aligned on a multiple of the alignment value

Alignment	The alignment must be a multiple of the minimum alignment configuration

[Expand]

function GetFIQMem(Size:PtrUInt; Affinity:LongWord):Pointer;

Description: Allocate a block of FIQ memory

Note	To be documented

[Expand]

function GetFIQAlignedMem(Size,Alignment:PtrUInt; Affinity:LongWord):Pointer;

Description: Allocate a block of FIQ memory aligned on a multiple of the alignment value

Alignment	The alignment must be a multiple of the minimum alignment configuration

[Expand]

function FreeIRQMem(Addr:Pointer):PtrUInt;

Description: Free a block of IRQ memory

Note	To be documented

[Expand]

function FreeFIQMem(Addr:Pointer):PtrUInt;

Description: Free a block of FIQ memory

Note	To be documented

[Expand]

function AllocMemEx(Size:PtrUInt; Flags,Affinity:LongWord):Pointer;

Description: Allocate and clear a block of memory with the flags and affinity requested

Note	To be documented

[Expand]

function ReAllocMemEx(var Addr:Pointer; Size:PtrUInt; Flags,Affinity:LongWord):Pointer;

Description: Reallocate a block of memory with the flags and affinity requested

Note	To be documented

[Expand]

function AllocAlignedMem(Size,Alignment:PtrUInt):Pointer;

Description: Allocate and clear a block of normal memory aligned on a multiple of the alignment value

Alignment	The alignment must be a multiple of the minimum alignment configuration

[Expand]

function AllocAlignedMemEx(Size,Alignment:PtrUInt; Flags,Affinity:LongWord):Pointer;

Description: Allocate and clear a block of normal memory aligned on a multiple of the alignment value with the flags and affinity requested

Alignment	The alignment must be a multiple of the minimum alignment configuration

[Expand]

function ReAllocAlignedMem(var Addr:Pointer; Size,Alignment:PtrUInt):Pointer;

Description: Reallocate a block of normal memory aligned on a multiple of the alignment value

Alignment	The alignment must be a multiple of the minimum alignment configuration

[Expand]

function ReAllocAlignedMemEx(var Addr:Pointer; Size,Alignment:PtrUInt; Flags,Affinity:LongWord):Pointer;

Description: Reallocate a block of memory aligned on a multiple of the alignment value with the flags and affinity requested

Alignment	The alignment must be a multiple of the minimum alignment configuration

[Expand]

function AllocSharedMem(Size:PtrUInt):Pointer;

Description: Allocate and clear a block of shared memory

Note	To be documented

[Expand]

function AllocSharedAlignedMem(Size,Alignment:PtrUInt):Pointer;

Description: Allocate and clear a block of shared memory aligned on a multiple of the alignment value

Alignment	The alignment must be a multiple of the minimum alignment configuration

[Expand]

function ReAllocSharedMem(var Addr:Pointer; Size:PtrUInt):Pointer;

Description: Reallocate a block of shared memory

Note	To be documented

[Expand]

function ReAllocSharedAlignedMem(var Addr:Pointer; Size,Alignment:PtrUInt):Pointer;

Description: Reallocate a block of shared memory aligned on a multiple of the alignment value

Alignment	The alignment must be a multiple of the minimum alignment configuration

[Expand]

function AllocLocalMem(Size:PtrUInt; Affinity:LongWord):Pointer;

Description: Allocate and clear a block of local memory

Note	To be documented

[Expand]

function AllocLocalAlignedMem(Size,Alignment:PtrUInt; Affinity:LongWord):Pointer;

Description: Allocate and clear a block of local memory aligned on a multiple of the alignment value

Alignment	The alignment must be a multiple of the minimum alignment configuration

[Expand]

function ReAllocLocalMem(var Addr:Pointer; Size:PtrUInt; Affinity:LongWord):Pointer;

Description: Reallocate a block of local memory

Note	To be documented

[Expand]

function ReAllocLocalAlignedMem(var Addr:Pointer; Size,Alignment:PtrUInt; Affinity:LongWord):Pointer;

Description: Reallocate a block of local memory aligned on a multiple of the alignment value

Alignment	The alignment must be a multiple of the minimum alignment configuration

[Expand]

function AllocCodeMem(Size:PtrUInt; Affinity:LongWord):Pointer;

Description: Allocate and clear a block of code memory

Note	To be documented

[Expand]

function AllocCodeAlignedMem(Size,Alignment:PtrUInt; Affinity:LongWord):Pointer;

Description: Allocate and clear a block of code memory aligned on a multiple of the alignment value

Alignment	The alignment must be a multiple of the minimum alignment configuration

[Expand]

function ReAllocCodeMem(var Addr:Pointer; Size:PtrUInt; Affinity:LongWord):Pointer;

Description: Reallocate a block of code memory

Note	To be documented

[Expand]

function ReAllocCodeAlignedMem(var Addr:Pointer; Size,Alignment:PtrUInt; Affinity:LongWord):Pointer;

Description: Reallocate a block of code memory aligned on a multiple of the alignment value

Alignment	The alignment must be a multiple of the minimum alignment configuration

[Expand]

function AllocDeviceMem(Size:PtrUInt):Pointer;

Description: Allocate and clear a block of device memory

Note	To be documented

[Expand]

function AllocDeviceAlignedMem(Size,Alignment:PtrUInt):Pointer;

Description: Allocate and clear a block of device memory aligned on a multiple of the alignment value

Alignment	The alignment must be a multiple of the minimum alignment configuration

[Expand]

function ReAllocDeviceMem(var Addr:Pointer; Size:PtrUInt):Pointer;

Description: Reallocate a block of device memory

Note	To be documented

[Expand]

function ReAllocDeviceAlignedMem(var Addr:Pointer; Size,Alignment:PtrUInt):Pointer;

Description: Reallocate a block of device memory aligned on a multiple of the alignment value

Alignment	The alignment must be a multiple of the minimum alignment configuration

[Expand]

function AllocNoCacheMem(Size:PtrUInt):Pointer;

Description: Allocate and clear a block of non cached memory

Note	To be documented

[Expand]

function AllocNoCacheAlignedMem(Size,Alignment:PtrUInt):Pointer;

Description: Allocate and clear a block of non cached memory aligned on a multiple of the alignment value

Alignment	The alignment must be a multiple of the minimum alignment configuration

[Expand]

function ReAllocNoCacheMem(var Addr:Pointer; Size:PtrUInt):Pointer;

Description: Reallocate a block of non cached memory

Note	To be documented

[Expand]

function ReAllocNoCacheAlignedMem(var Addr:Pointer; Size,Alignment:PtrUInt):Pointer;

Description: Reallocate a block of non cached memory aligned on a multiple of the alignment value

Alignment	The alignment must be a multiple of the minimum alignment configuration

[Expand]

function AllocNonSharedMem(Size:PtrUInt):Pointer;

Description: Allocate and clear a block of non shared memory

Note	To be documented

[Expand]

function AllocNonSharedAlignedMem(Size,Alignment:PtrUInt):Pointer;

Description: Allocate and clear a block of non shared memory aligned on a multiple of the alignment value

Alignment	The alignment must be a multiple of the minimum alignment configuration

[Expand]

function ReAllocNonSharedMem(var Addr:Pointer; Size:PtrUInt):Pointer;

Description: Reallocate a block of non shared memory

Note	To be documented

[Expand]

function ReAllocNonSharedAlignedMem(var Addr:Pointer; Size,Alignment:PtrUInt):Pointer;

Description: Reallocate a block of non shared memory aligned on a multiple of the alignment value

Alignment	The alignment must be a multiple of the minimum alignment configuration

[Expand]

function AllocIRQMem(Size:PtrUInt; Affinity:LongWord):Pointer;

Description: Allocate and clear a block of IRQ memory

Note	The memory must be freed using FreeIRQMem

[Expand]

function AllocIRQAlignedMem(Size,Alignment:PtrUInt; Affinity:LongWord):Pointer;

Description: Allocate and clear a block of IRQ memory aligned on a multiple of the alignment value

Alignment	The alignment must be a multiple of the minimum alignment configuration
Note	The memory must be freed using FreeIRQMem

[Expand]

function ReAllocIRQMem(var Addr:Pointer; Size:PtrUInt; Affinity:LongWord):Pointer;

Description: Reallocate a block of IRQ memory

Note	To be documented

[Expand]

function ReAllocIRQAlignedMem(var Addr:Pointer; Size,Alignment:PtrUInt; Affinity:LongWord):Pointer;

Description: Reallocate a block of IRQ memory aligned on a multiple of the alignment value

Alignment	The alignment must be a multiple of the minimum alignment configuration

[Expand]

function AllocFIQMem(Size:PtrUInt; Affinity:LongWord):Pointer;

Description: Allocate and clear a block of FIQ memory

Note	The memory must be freed using FreeFIQMem

[Expand]

function AllocFIQAlignedMem(Size,Alignment:PtrUInt; Affinity:LongWord):Pointer;

Description: Allocate and clear a block of FIQ memory aligned on a multiple of the alignment value

Alignment	The alignment must be a multiple of the minimum alignment configuration
Note	The memory must be freed using FreeFIQMem

[Expand]

function ReAllocFIQMem(var Addr:Pointer; Size:PtrUInt; Affinity:LongWord):Pointer;

Description: Reallocate a block of FIQ memory

Note	To be documented

[Expand]

function ReAllocFIQAlignedMem(var Addr:Pointer; Size,Alignment:PtrUInt; Affinity:LongWord):Pointer;

Description: Reallocate a block of FIQ memory aligned on a multiple of the alignment value

Alignment	The alignment must be a multiple of the minimum alignment configuration

[Expand]

function SizeIRQMem(Addr:Pointer):PtrUInt;

Description: Return the size of an allocated block of IRQ memory

Note	To be documented

[Expand]

function SizeFIQMem(Addr:Pointer):PtrUInt;

Description: Return the size of an allocated block of FIQ memory

Note	To be documented

[Expand]

function MemFlags(Addr:Pointer):LongWord;

Description: Return the flags of an allocated block of memory

Note	To be documented

[Expand]

function MemFlagsIRQ(Addr:Pointer):LongWord;

Description: Return the flags of an allocated block of IRQ memory

Note	To be documented

[Expand]

function MemFlagsFIQ(Addr:Pointer):LongWord;

Description: Return the flags of an allocated block of FIQ memory

Note	To be documented

[Expand]

function GetHeapStatistics:THeapStatistics;

Description: Return detailed statistics for the heap manager

Note	To be documented

[Expand]

function GetHeapBlockCount(State:LongWord):LongWord;

Description: Get the total number of current heap blocks based on state

Note	To be documented

[Expand]

function GetHeapBlockCountEx(State,Flags,Affinity:LongWord):LongWord;

Description: Get the number of current heap blocks based on state, flags and affinity

Note	This uses the block list (not the Free/Used/Small lists) in order to account for all blocks

[Expand]

function GetHeapBlockMin(State:LongWord):LongWord;

Description: Get the minimum size of current heap blocks based on state

Note	To be documented

[Expand]

function GetHeapBlockMinEx(State,Flags,Affinity:LongWord):LongWord;

Description: Get the minimum size of current heap blocks based on state, flags and affinity

Note	This uses the block list (not the Free/Used/Small lists) in order to account for all blocks

[Expand]

function GetHeapBlockMax(State:LongWord):LongWord;

Description: Get the maximum size of current heap blocks based on state

Note	To be documented

[Expand]

function GetHeapBlockMaxEx(State,Flags,Affinity:LongWord):LongWord;

Description: Get the maximum size of current heap blocks based on state, flags and affinity

Note	This uses the block list (not the Free/Used/Small lists) in order to account for all blocks

[Expand]

function CreateHeapSnapshot(State:LongWord):PHeapSnapshot;

Description: To be documented

Note	To be documented

[Expand]

function CreateHeapSnapshotEx(State,Flags,Affinity:LongWord):PHeapSnapshot;

Description: To be documented

Note	To be documented

[Expand]

function DestroyHeapSnapshot(Snapshot:PHeapSnapshot):LongWord;

Description: To be documented

Note	To be documented

Return to Unit Reference