View source for Unit HeapManager

Return to [[Unit_Reference|Unit Reference]]


=== Description ===
----

'''Ultibo Heap Manager Interface unit'''

=== Constants ===
----


<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 20px; padding-bottom: 15px;">
<div style="font-size: 14px; padding-left: 12px;">'''Heap specific constants''' <code> HEAP_MIN_* </code></div>
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
{| class="wikitable" style="font-size: 14px; background: white;"
|-
| <code>HEAP_MIN_BLOCK = 33;</code>
| SizeOf(THeapBlock) + 1
|-
| <code>HEAP_MIN_ALIGN = 64;</code>
| SizeOf(THeapBlock) * 2 Must be greater than or equal to HEAP_MIN_BLOCK, must be a power of 2
|-
|}
</div></div>
<br />
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 20px; padding-bottom: 15px;">
<div style="font-size: 14px; padding-left: 12px;">'''Heap signature''' <code> HEAP_SIGNATURE_* </code></div>
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
{| class="wikitable" style="font-size: 14px; background: white;"
|-
| <code>HEAP_SIGNATURE = $E84DF600;</code>
| style="width: 50%;"|&nbsp;
|-
| <code>HEAP_SIGNATURE_MASK = $FFFFFF00;</code>
| &nbsp;
|-
|}
</div></div>
<br />
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 20px; padding-bottom: 15px;">
<div style="font-size: 14px; padding-left: 12px;">'''Heap block state''' <code> HEAP_STATE_* </code></div>
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
{| class="wikitable" style="font-size: 14px; background: white;"
|-
| <code>HEAP_STATE_FREE = 0;</code>
| &nbsp;
|-
| <code>HEAP_STATE_USED = 1;</code>
| &nbsp;
|-
|colspan="2"|&nbsp;
|-
| <code>HEAP_STATE_MASK = $000000FF;</code>
| &nbsp;
|-
| <code>HEAP_STATE_ALL  = 2;</code>
| Only for use by GetHeapBlockCount/GetHeapBlockMin/GetHeapBlockMax
|-
|}
</div></div>
<br /> 
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 20px; padding-bottom: 15px;">
<div style="font-size: 14px; padding-left: 12px;">'''Heap block flag''' <code> HEAP_FLAG_* </code></div>
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
{| class="wikitable" style="font-size: 14px; background: white;"
|-
| <code>HEAP_FLAG_NORMAL = $00000000;</code>
| A normal memory block
|-
| <code>HEAP_FLAG_SHARED = $00000001;</code>
| A sharable memory block, usually marked as sharable in the page tables of the memory management unit
|-
| <code>HEAP_FLAG_LOCAL = $00000002;</code>
| A local memory block with an affinity to a specific processor, usually marked as non global in the page tables of the memory management unit
|-
| <code>HEAP_FLAG_CODE = $00000004;</code>
| A code memory block (with an optional affinity to a specific processor), usually marked as executable in the page tables of the memory management unit
|-
| <code>HEAP_FLAG_DEVICE = $00000008;</code>
| A device memory block, usually marked as device memory in the page tables of the memory management unit
|-
| <code>HEAP_FLAG_NOCACHE = $00000010;</code>
| A non cached memory block, usually marked as not cacheable in the page tables of the memory management unit
|-
| <code>HEAP_FLAG_NONSHARED = $00000020;</code>
| A non shared memory block, usually marked as not shareable in the page tables of the memory management unit
|-
| <code>HEAP_FLAG_LOCKED = $00000040;</code>
| A locked memory block (Not currently implemented in Ultibo)
|-
| <code>HEAP_FLAG_IRQ = $00000080;</code>
| An IRQ allocatable memory block
|-
| <code>HEAP_FLAG_FIQ = $00000100;</code>
| An FIQ allocatable memory block
|-
| <code>HEAP_FLAG_RECLAIM = $00000200;</code>
| A reclaimable memory block (eg Disk Cache)(with a registered callback to reclaim as required for normal memory)
|-
|colspan="2"|&nbsp;
|-
| <code>HEAP_FLAG_CUSTOM = $08000000;</code>
| A custom flag reserved for non standard uses
|-
|colspan="2"|&nbsp;
|-
| <code>HEAP_FLAG_ALL = $FFFFFFFF;</code>
| Only for use by GetHeapBlockCount/GetHeapBlockMin/GetHeapBlockMax
|-
| <code>HEAP_FLAG_INVALID = $FFFFFFFF;</code>
| Return value from MemFlags/IRQ/FIQ on invalid
|-
|}
</div></div>
<br />
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 20px; padding-bottom: 15px;">
<div style="font-size: 14px; padding-left: 12px;">'''Heap small block''' <code> HEAP_SMALL_* </code></div>
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
{| class="wikitable" style="font-size: 14px; background: white;"
|-
| <code>HEAP_SMALL_MIN = 32;</code>
| SizeOf(THeapBlock) Minimum size of a small heap block
|-
| <code>HEAP_SMALL_MAX = SIZE_4K;</code>
| Maximum size of a small heap block
|-
| <code>HEAP_SMALL_ALIGN = 4;</code>
| SizeOf(LongWord); Alignment for small heap blocks
|-
| <code>HEAP_SMALL_SHIFT = 2;</code>
| Size to Index conversion (Divide by 4)
|-
|colspan="2"|&nbsp;
|-
| <code>HEAP_SMALL_LOW = (HEAP_SMALL_MIN div HEAP_SMALL_ALIGN);</code>
| 8
|-
| <code>HEAP_SMALL_HIGH = (HEAP_SMALL_MAX div HEAP_SMALL_ALIGN);</code>
| 1024
|-
|}
</div></div>
<br />

=== Type definitions ===
----


'''Heap callback'''

{| class="wikitable" style="font-size: 14px; text-align: left; width: 100%; height: 50px;"
|-
| <code>THeapCallback = function(Size:PtrUInt):LongWord;</code>
| style="width: 40%;"|
|-
|}

'''Heap block'''

<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial;">
<code>PHeapBlock = ^THeapBlock;</code>

<code>THeapBlock = record</code>
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
{| class="wikitable" style="font-size: 14px; background: white;"
|-
| <code>Size:PtrUInt;</code>
| Size of the Heap Block (including the size of this structure)
|-
| <code>State:LongWord;</code>
| State of the Heap Block (eg HEAP_STATE_FREE)
|-
| <code>Flags:LongWord;</code>
| Flags of the Heap Block (eg HEAP_FLAG_SHARED)
|-
| <code>Affinity:LongWord;</code>
| CPU Affinity of the Heap Block (eg CPU_AFFINITY_0)
|-
| <code>Prev:PHeapBlock;</code>
| Previous Heap Block in list
|-
| <code>Next:PHeapBlock;</code>
| Next Heap Block in list
|-
| <code>PrevLink:PHeapBlock;</code>
| Previous Free/Used Block in list
|-
| <code>NextLink:PHeapBlock;</code>
| Next Free/Used Block in list
|-
|}
</div></div> 

'''Heap small blocks''' 

<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial;">
<code>PSmallBlocks = ^TSmallBlocks;</code>

<code>TSmallBlocks = array[HEAP_SMALL_LOW..HEAP_SMALL_HIGH] of PHeapBlock;</code>
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
{| class="wikitable" style="font-size: 14px; background: white;"
|-
| &nbsp;
| style="width: 50%;"|&nbsp;
|-
|}
</div></div> 

'''Heap lock'''
 
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial;">
<code>PHeapLock = ^THeapLock;</code>

<code>THeapLock = record</code>
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
{| class="wikitable" style="font-size: 14px; background: white;"
|-
| <code>Lock:THandle;</code>
| style="width: 50%;"|&nbsp;
|-
| <code>IRQLock:THandle;</code>
| &nbsp;
|-
| <code>FIQLock:THandle;</code>
| &nbsp;
|-
| <code>AcquireLock:function(Handle:THandle):LongWord;</code>
| &nbsp;
|-
| <code>ReleaseLock:function(Handle:THandle):LongWord;</code>
| &nbsp;
|-
| <code>AcquireIRQLock:function(Handle:THandle):LongWord;</code>
| &nbsp;
|-
| <code>ReleaseIRQLock:function(Handle:THandle):LongWord;</code>
| &nbsp;
|-
| <code>AcquireFIQLock:function(Handle:THandle):LongWord;</code>
| &nbsp;
|-
| <code>ReleaseFIQLock:function(Handle:THandle):LongWord;</code>
| &nbsp;
|-
|}
</div></div> 

'''Heap statistics'''

<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial;">
<code>PHeapStatistics = ^THeapStatistics;</code>

<code>THeapStatistics = record</code>
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
{| class="wikitable" style="font-size: 14px; background: white;"
|-
|colspan="2"|''Get/Alloc/Realloc''
|-
| <code>GetCount:LongWord;</code>
| style="width: 50%;"|&nbsp;
|-
| <code>AllocCount:LongWord;</code>
| &nbsp;
|-
| <code>ReallocCount:LongWord;</code>
| &nbsp;
|-
| <code>GetAlignedCount:LongWord;</code>
| &nbsp;
|-
| <code>AllocAlignedCount:LongWord;</code>
| &nbsp;
|-
| <code>ReallocAlignedCount:LongWord;</code>
| &nbsp;
|-
| <code>GetSharedCount:LongWord;</code>
| &nbsp;
|-
| <code>AllocSharedCount:LongWord;</code>
| &nbsp;
|-
| <code>ReallocSharedCount:LongWord;</code>
| &nbsp;
|-
| <code>GetLocalCount:LongWord;</code>
| &nbsp;
|-
| <code>AllocLocalCount:LongWord;</code>
| &nbsp;
|-
| <code>ReallocLocalCount:LongWord;</code>
| &nbsp;
|-
| <code>GetCodeCount:LongWord;</code>
| &nbsp;
|-
| <code>AllocCodeCount:LongWord;</code>
| &nbsp;
|-
| <code>ReallocCodeCount:LongWord;</code>
| &nbsp;
|-
| <code>GetDeviceCount:LongWord;</code>
| &nbsp;
|-
| <code>AllocDeviceCount:LongWord;</code>
| &nbsp;
|-
| <code>ReallocDeviceCount:LongWord;</code>
| &nbsp;
|-
| <code>GetNoCacheCount:LongWord;</code>
| &nbsp;
|-
| <code>AllocNoCacheCount:LongWord;</code>
| &nbsp;
|-
| <code>ReallocNoCacheCount:LongWord;</code>
| &nbsp;
|-
| <code>GetNonSharedCount:LongWord;</code>
| &nbsp;
|-
| <code>AllocNonSharedCount:LongWord;</code>
| &nbsp;
|-
| <code>ReallocNonSharedCount:LongWord;</code>
| &nbsp;
|-
| <code>GetIRQCount:LongWord;</code>
| &nbsp;
|-
| <code>AllocIRQCount:LongWord;</code>
| &nbsp;
|-
| <code>ReallocIRQCount:LongWord;</code>
| &nbsp;
|-
| <code>GetFIQCount:LongWord;</code>
| &nbsp;
|-
| <code>AllocFIQCount:LongWord;</code>
| &nbsp;
|-
| <code>ReallocFIQCount:LongWord;</code>
| &nbsp;
|-
|colspan="2"|''Free''
|-
| <code>FreeCount:LongWord;</code>
| &nbsp;
|-
| <code>FreeIRQCount:LongWord;</code>
| &nbsp;
|-
| <code>FreeFIQCount:LongWord;</code>
| &nbsp;
|-
| <code>FreeSizeCount:LongWord;</code>
| &nbsp;
|-
|colspan="2"|''Size''
|-
| <code>SizeCount:LongWord;</code>
| &nbsp;
|-
| <code>SizeIRQCount:LongWord;</code>
| &nbsp;
|-
| <code>SizeFIQCount:LongWord;</code>
| &nbsp;
|-
|colspan="2"|''Flags''
|-
| <code>FlagsCount:LongWord;</code>
| &nbsp;
|-
| <code>FlagsIRQCount:LongWord;</code>
| &nbsp;
|-
| <code>FlagsFIQCount:LongWord;</code>
| &nbsp;
|-
|colspan="2"|''Register''
|-
| <code>RegisterCount:LongWord;</code>
| &nbsp;
|-
|colspan="2"|''Reserve''
|-
| <code>ReserveCount:LongWord;</code>
| &nbsp;
|-
|colspan="2"|''Request''
|-
| <code>RequestCount:LongWord;</code>
| &nbsp;
|-
| <code>RequestSharedCount:LongWord;</code>
| &nbsp;
|-
| <code>RequestLocalCount:LongWord;</code>
| &nbsp;
|-
| <code>RequestCodeCount:LongWord;</code>
| &nbsp;
|-
| <code>RequestDeviceCount:LongWord;</code>
| &nbsp;
|-
| <code>RequestNoCacheCount:LongWord;</code>
| &nbsp;
|-
| <code>RequestNonSharedCount:LongWord;</code>
| &nbsp;
|-
| <code>RequestIRQCount:LongWord;</code>
| &nbsp;
|-
| <code>RequestFIQCount:LongWord;</code>
| &nbsp;
|-
|colspan="2"|''Get Internal''
|-
| <code>GetZeroCount:LongWord;</code>
| &nbsp;
|-
| <code>GetRemainCount:LongWord;</code>
| &nbsp;
|-
| <code>GetInvalidCount:LongWord;</code>
| &nbsp;
|-
| <code>GetUnavailableCount:LongWord;</code>
| &nbsp;
|-
| <code>GetAddFailCount:LongWord;</code>
| &nbsp;
|-
| <code>GetSplitFailCount:LongWord;</code>
| &nbsp;
|-
| <code>GetRemoveFailCount:LongWord;</code>
| &nbsp;
|-
|colspan="2"|''Realloc Internal''
|-
| <code>ReallocZeroCount:LongWord;</code>
| &nbsp;
|-
| <code>ReallocSmallerCount:LongWord;</code>
| &nbsp;
|-
| <code>ReallocLargerCount:LongWord;</code>
| &nbsp;
|-
| <code>ReallocReleaseCount:LongWord;</code>
| &nbsp;
|-
| <code>ReallocReleaseBytes:LongWord;</code>
| &nbsp;
|-
| <code>ReallocAddFailCount:LongWord;</code>
| &nbsp;
|-
| <code>ReallocSplitFailCount:LongWord;</code>
| &nbsp;
|-
| <code>ReallocRemoveFailCount:LongWord;</code>
| &nbsp;
|-
|colspan="2"|''GetAligned Internal''
|-
| <code>GetAlignedRemainCount:LongWord;</code>
| &nbsp;
|-
| <code>GetAlignedInvalidCount:LongWord;</code>
| &nbsp;
|-
| <code>GetAlignedUndersizeCount:LongWord;</code>
| &nbsp;
|-
| <code>GetAlignedUnavailableCount:LongWord;</code>
| &nbsp;
|-
| <code>GetAlignedAddFailCount:LongWord;</code>
| &nbsp;
|-
| <code>GetAlignedSplitFailCount:LongWord;</code>
| &nbsp;
|-
| <code>GetAlignedRemoveFailCount:LongWord;</code>
| &nbsp;
|-
| <code>GetAlignedOrphanCount:LongWord;</code>
| &nbsp;
|-
| <code>GetAlignedOrphanBytes:LongWord;</code>
| &nbsp;
|-
| <code>GetAlignedReleaseCount:LongWord;</code>
| &nbsp;
|-
| <code>GetAlignedReleaseBytes:LongWord;</code>
| &nbsp;
|-
|colspan="2"|''Free Internal''
|-
| <code>FreeInvalidCount:LongWord;</code>
| &nbsp;
|-
| <code>FreeAddFailCount:LongWord;</code>
| &nbsp;
|-
| <code>FreeMergeFailCount:LongWord;</code>
| &nbsp;
|-
| <code>FreeRemoveFailCount:LongWord;</code>
| &nbsp;
|-
|colspan="2"|''Size Internal''
|-
| <code>SizeInvalidCount:LongWord;</code>
| &nbsp;
|-
|colspan="2"|''Flags Internal''
|-
| <code>FlagsInvalidCount:LongWord;</code>
| &nbsp;
|-
|colspan="2"|''Register Internal''
|-
| <code>RegisterInvalidCount:LongWord;</code>
| &nbsp;
|-
| <code>RegisterAddFailCount:LongWord;</code>
| &nbsp;
|-
|colspan="2"|''Reserve Internal''
|-
| <code>ReserveInvalidCount:LongWord;</code>
| &nbsp;
|-
| <code>ReserveAddFailCount:LongWord;</code>
| &nbsp;
|-
| <code>ReserveSplitFailCount:LongWord;</code>
| &nbsp;
|-
| <code>ReserveRemoveFailCount:LongWord;</code>
| &nbsp;
|-
| <code>ReserveUnavailableCount:LongWord;</code>
| &nbsp;
|-
|colspan="2"|''Request Internal''
|-
| <code>RequestInvalidCount:LongWord;</code>
| &nbsp;
|-
| <code>RequestAddFailCount:LongWord;</code>
| &nbsp;
|-
| <code>RequestSplitFailCount:LongWord;</code>
| &nbsp;
|-
| <code>RequestRemoveFailCount:LongWord;</code>
| &nbsp;
|-
| <code>RequestUnavailableCount:LongWord;</code>
| &nbsp;
|-
|colspan="2"|''Split Internal''
|-
| <code>SplitCount:LongWord;</code>
| &nbsp;
|-
|colspan="2"|''Merge Internal''
|-
| <code>MergePrevCount:LongWord;</code>
| &nbsp;
|-
| <code>MergeNextCount:LongWord;</code>
| &nbsp;
|-
|colspan="2"|''Block Internal''
|-
| <code>GetSmallCount:LongWord;</code>
| &nbsp;
|-
| <code>GetLargeCount:LongWord;</code>
| &nbsp;
|-
| <code>AddSmallCount:LongWord;</code>
| &nbsp;
|-
| <code>AddLargeCount:LongWord;</code>
| &nbsp;
|-
| <code>RemoveSmallCount:LongWord;</code>
| &nbsp;
|-
| <code>RemoveLargeCount:LongWord;</code>
| &nbsp;
|-
| <code>SmallUnavailableCount:LongWord;</code>
| &nbsp;
|-
|}
</div></div>
 
'''Heap snapshot'''
 
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial;">
<code>PHeapSnapshot = ^THeapSnapshot;</code>

<code>THeapSnapshot = record</code>
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
{| class="wikitable" style="font-size: 14px; background: white;"
|-
|colspan="2"|''Snapshot Properties''
|-
| <code>Adddress:PtrUInt;</code>
| Address of the Heap Block
|-
| <code>Size:PtrUInt;</code>
| Size of the Heap Block (including the size of the THeapBlock structure)
|-
| <code>State:LongWord;</code>
| State of the Heap Block (eg HEAP_STATE_FREE)
|-
| <code>Flags:LongWord;</code>
| Flags of the Heap Block (eg HEAP_FLAG_SHARED)
|-
| <code>Affinity:LongWord;</code>
| CPU Affinity of the Heap Block (eg CPU_AFFINITY_0)
|-
|colspan="2"|''Internal Properties''
|-
| <code>Next:PHeapSnapshot;</code>
| Next entry in Heap snapshot
|-
|}
</div></div> 
<br />

=== Public variables ===
----

''None defined''

=== Function declarations ===
----


'''Initialization functions'''

<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;">
<pre style="border: 0; padding-bottom:0px;">procedure RegisterMemoryManager;</pre>
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' To be documented</div>
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
{| class="wikitable" style="font-size: 14px; background: white;"
|-
! Note
| None documented
|-
|}
</div></div>
<br />
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;">
<pre style="border: 0; padding-bottom:0px;">procedure RegisterHeapBlock(Address:Pointer; Size:PtrUInt);</pre>
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' To be documented</div>
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
{| class="wikitable" style="font-size: 14px; background: white;"
|-
! Note
| None documented
|-
|}
</div></div>
<br />
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;">
<pre style="border: 0; padding-bottom:0px;">function ReserveHeapBlock(Address:Pointer; Size:PtrUInt):Pointer;</pre>
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' Request the Heap Block specified by address and size be reserved from allocation</div>
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
{| class="wikitable" style="font-size: 14px; background: white;"
|-
! Address
| The starting address for the reservation. The memory manager may reserve a block that starts prior to the supplied address for alignment purposes.
|-
! Size
| The total size in byte to be reserved, the memory manager may increase the amount reserved to cater for alignment or to prevent orphan blocks.
Size must be greater than 0.
|-
! Return
| A pointer to the actual reserved memory which may differ from the supplied starting address due to alignment. The reservation can be cancelled by passing the returned pointer to FreeMem.
|-
|}
</div></div>
<br />
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;">
<pre style="border: 0; padding-bottom:0px;">function RequestHeapBlock(Hint:Pointer; Size:PtrUInt; Flags,Affinity:LongWord):Pointer;</pre>
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' Request registration a Heap Block with specified flags and affinity within an existing block</div>
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
{| class="wikitable" style="font-size: 14px; background: white;"
|-
! 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.
|-
|}
</div></div>
<br />
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;">
<pre style="border: 0; padding-bottom:0px;">function RequestSharedHeapBlock(Hint:Pointer; Size:PtrUInt):Pointer;</pre>
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' Request registration of a Shared Heap Block within an existing block</div>
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
{| class="wikitable" style="font-size: 14px; background: white;"
|-
! 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.
|-
|}
</div></div>
<br />
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;">
<pre style="border: 0; padding-bottom:0px;">function RequestLocalHeapBlock(Hint:Pointer; Size:PtrUInt; Affinity:LongWord):Pointer;</pre>
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' Request registration of a Local Heap Block within an existing block</div>
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
{| class="wikitable" style="font-size: 14px; background: white;"
|-
! 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.
|-
|}
</div></div>
<br />
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;">
<pre style="border: 0; padding-bottom:0px;">function RequestCodeHeapBlock(Hint:Pointer; Size:PtrUInt; Affinity:LongWord):Pointer;</pre>
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' Request registration of a Code Heap Block within an existing block</div>
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
{| class="wikitable" style="font-size: 14px; background: white;"
|-
! 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.
|-
|}
</div></div>
<br />
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;">
<pre style="border: 0; padding-bottom:0px;">function RequestDeviceHeapBlock(Hint:Pointer; Size:PtrUInt):Pointer;</pre>
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' Request registration of a Device Heap Block within an existing block</div>
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
{| class="wikitable" style="font-size: 14px; background: white;"
|-
! 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.
|-
|}
</div></div>
<br />
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;">
<pre style="border: 0; padding-bottom:0px;">function RequestNoCacheHeapBlock(Hint:Pointer; Size:PtrUInt):Pointer;</pre>
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' Request registration of a Non Cached Heap Block within an existing block</div>
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
{| class="wikitable" style="font-size: 14px; background: white;"
|-
! 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.
|-
|}
</div></div>
<br />
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;">
<pre style="border: 0; padding-bottom:0px;">function RequestNonSharedHeapBlock(Hint:Pointer; Size:PtrUInt):Pointer;</pre>
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' Request registration of a Non Shared Heap Block within an existing block</div>
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
{| class="wikitable" style="font-size: 14px; background: white;"
|-
! 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.
|-
|}
</div></div>
<br />
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;">
<pre style="border: 0; padding-bottom:0px;">function RequestIRQHeapBlock(Hint:Pointer; Size:PtrUInt; Affinity:LongWord):Pointer;</pre>
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' Request registration of an IRQ Heap Block within an existing block</div>
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
{| class="wikitable" style="font-size: 14px; background: white;"
|-
! 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.
|-
|}
</div></div>
<br />
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;">
<pre style="border: 0; padding-bottom:0px;">function RequestFIQHeapBlock(Hint:Pointer; Size:PtrUInt; Affinity:LongWord):Pointer;</pre>
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' Request registration of an FIQ Heap Block within an existing block</div>
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
{| class="wikitable" style="font-size: 14px; background: white;"
|-
! 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.
|-
|}
</div></div>
<br />

'''Heap functions'''

<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;">
<pre style="border: 0; padding-bottom:0px;">function GetMemEx(Size:PtrUInt; Flags,Affinity:LongWord):Pointer;</pre>
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' Allocate a block of memory with the flags and affinity requested</div>
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
{| class="wikitable" style="font-size: 14px; background: white;"
|-
! Note
| None documented
|-
|}
</div></div>
<br />
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;">
<pre style="border: 0; padding-bottom:0px;">function GetAlignedMem(Size,Alignment:PtrUInt):Pointer;</pre>
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' Allocate a block of normal memory aligned on a multiple of the alignment value</div>
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
{| class="wikitable" style="font-size: 14px; background: white;"
|-
! Alignment
| The alignment must be a multiple of the minimum alignment configuration
|-
|}
</div></div>
<br />
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;">
<pre style="border: 0; padding-bottom:0px;">function GetAlignedMemEx(Size,Alignment:PtrUInt; Flags,Affinity:LongWord):Pointer;</pre>
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' Allocate a block of memory aligned on a multiple of the alignment value with the flags and affinity requested</div>
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
{| class="wikitable" style="font-size: 14px; background: white;"
|-
! Alignment
| The alignment must be a multiple of the minimum alignment configuration
|-
|}
</div></div>
<br />
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;">
<pre style="border: 0; padding-bottom:0px;">function GetSharedMem(Size:PtrUInt):Pointer;</pre>
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' Allocate a block of shared memory</div>
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
{| class="wikitable" style="font-size: 14px; background: white;"
|-
! Note
| None documented
|-
|}
</div></div>
<br />
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;">
<pre style="border: 0; padding-bottom:0px;">function GetSharedAlignedMem(Size,Alignment:PtrUInt):Pointer;</pre>
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' Allocate a block of shared memory aligned on a multiple of the alignment value</div>
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
{| class="wikitable" style="font-size: 14px; background: white;"
|-
! Alignment
| The alignment must be a multiple of the minimum alignment configuration
|-
|}
</div></div>
<br />
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;">
<pre style="border: 0; padding-bottom:0px;">function GetLocalMem(Size:PtrUInt; Affinity:LongWord):Pointer;</pre>
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' Allocate a block of local memory</div>
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
{| class="wikitable" style="font-size: 14px; background: white;"
|-
! Note
| None documented
|-
|}
</div></div>
<br />
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;">
<pre style="border: 0; padding-bottom:0px;">function GetLocalAlignedMem(Size,Alignment:PtrUInt; Affinity:LongWord):Pointer;</pre>
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' Allocate a block of local memory aligned on a multiple of the alignment value</div>
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
{| class="wikitable" style="font-size: 14px; background: white;"
|-
! Alignment
| The alignment must be a multiple of the minimum alignment configuration
|-
|}
</div></div>
<br />
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;">
<pre style="border: 0; padding-bottom:0px;">function GetCodeMem(Size:PtrUInt; Affinity:LongWord):Pointer;</pre>
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' Allocate a block of code memory</div>
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
{| class="wikitable" style="font-size: 14px; background: white;"
|-
! Note
| None documented
|-
|}
</div></div>
<br />
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;">
<pre style="border: 0; padding-bottom:0px;">function GetCodeAlignedMem(Size,Alignment:PtrUInt; Affinity:LongWord):Pointer;</pre>
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' Allocate a block of code memory aligned on a multiple of the alignment value</div>
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
{| class="wikitable" style="font-size: 14px; background: white;"
|-
! Alignment
| The alignment must be a multiple of the minimum alignment configuration
|-
|}
</div></div>
<br />
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;">
<pre style="border: 0; padding-bottom:0px;">function GetDeviceMem(Size:PtrUInt):Pointer;</pre>
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' Allocate a block of device memory</div>
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
{| class="wikitable" style="font-size: 14px; background: white;"
|-
! Note
| None documented
|-
|}
</div></div>
<br />
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;">
<pre style="border: 0; padding-bottom:0px;">function GetDeviceAlignedMem(Size,Alignment:PtrUInt):Pointer;</pre>
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' Allocate a block of device memory aligned on a multiple of the alignment value</div>
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
{| class="wikitable" style="font-size: 14px; background: white;"
|-
! Alignment
| The alignment must be a multiple of the minimum alignment configuration
|-
|}
</div></div>
<br />
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;">
<pre style="border: 0; padding-bottom:0px;">function GetNoCacheMem(Size:PtrUInt):Pointer;</pre>
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' Allocate a block of non cached memory</div>
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
{| class="wikitable" style="font-size: 14px; background: white;"
|-
! Note
| None documented
|-
|}
</div></div>
<br />
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;">
<pre style="border: 0; padding-bottom:0px;">function GetNoCacheAlignedMem(Size,Alignment:PtrUInt):Pointer;</pre>
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' Allocate a block of non cached memory aligned on a multiple of the alignment value</div>
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
{| class="wikitable" style="font-size: 14px; background: white;"
|-
! Alignment
| The alignment must be a multiple of the minimum alignment configuration
|-
|}
</div></div>
<br />
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;">
<pre style="border: 0; padding-bottom:0px;">function GetNonSharedMem(Size:PtrUInt):Pointer;</pre>
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' Allocate a block of non shared memory</div>
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
{| class="wikitable" style="font-size: 14px; background: white;"
|-
! Note
| None documented
|-
|}
</div></div>
<br />
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;">
<pre style="border: 0; padding-bottom:0px;">function GetNonSharedAlignedMem(Size,Alignment:PtrUInt):Pointer;</pre>
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' Allocate a block of non shared memory aligned on a multiple of the alignment value</div>
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
{| class="wikitable" style="font-size: 14px; background: white;"
|-
! Alignment
| The alignment must be a multiple of the minimum alignment configuration
|-
|}
</div></div>
<br />
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;">
<pre style="border: 0; padding-bottom:0px;">function GetIRQMem(Size:PtrUInt; Affinity:LongWord):Pointer;</pre>
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' Allocate a block of IRQ memory</div>
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
{| class="wikitable" style="font-size: 14px; background: white;"
|-
! Note
| None documented
|-
|}
</div></div>
<br />
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;">
<pre style="border: 0; padding-bottom:0px;">function GetIRQAlignedMem(Size,Alignment:PtrUInt; Affinity:LongWord):Pointer;</pre>
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' Allocate a block of IRQ memory aligned on a multiple of the alignment value</div>
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
{| class="wikitable" style="font-size: 14px; background: white;"
|-
! Alignment
| The alignment must be a multiple of the minimum alignment configuration
|-
|}
</div></div>
<br />
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;">
<pre style="border: 0; padding-bottom:0px;">function GetFIQMem(Size:PtrUInt; Affinity:LongWord):Pointer;</pre>
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' Allocate a block of FIQ memory</div>
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
{| class="wikitable" style="font-size: 14px; background: white;"
|-
! Note
| None documented
|-
|}
</div></div>
<br />
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;">
<pre style="border: 0; padding-bottom:0px;">function GetFIQAlignedMem(Size,Alignment:PtrUInt; Affinity:LongWord):Pointer;</pre>
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' Allocate a block of FIQ memory aligned on a multiple of the alignment value</div>
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
{| class="wikitable" style="font-size: 14px; background: white;"
|-
! Alignment
| The alignment must be a multiple of the minimum alignment configuration
|-
|}
</div></div>
<br />
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;">
<pre style="border: 0; padding-bottom:0px;">function FreeIRQMem(Addr:Pointer):PtrUInt;</pre>
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' Free a block of IRQ memory</div>
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
{| class="wikitable" style="font-size: 14px; background: white;"
|-
! Note
| None documented
|-
|}
</div></div>
<br />
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;">
<pre style="border: 0; padding-bottom:0px;">function FreeFIQMem(Addr:Pointer):PtrUInt;</pre>
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' Free a block of FIQ memory</div>
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
{| class="wikitable" style="font-size: 14px; background: white;"
|-
! Note
| None documented
|-
|}
</div></div>
<br />
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;">
<pre style="border: 0; padding-bottom:0px;">function AllocMemEx(Size:PtrUInt; Flags,Affinity:LongWord):Pointer;</pre>
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' Allocate and clear a block of memory with the flags and affinity requested</div>
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
{| class="wikitable" style="font-size: 14px; background: white;"
|-
! Note
| None documented
|-
|}
</div></div>
<br />
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;">
<pre style="border: 0; padding-bottom:0px;">function ReAllocMemEx(var Addr:Pointer; Size:PtrUInt; Flags,Affinity:LongWord):Pointer;</pre>
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' Reallocate a block of memory with the flags and affinity requested</div>
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
{| class="wikitable" style="font-size: 14px; background: white;"
|-
! Note
| None documented
|-
|}
</div></div>
<br />
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;">
<pre style="border: 0; padding-bottom:0px;">function AllocAlignedMem(Size,Alignment:PtrUInt):Pointer;</pre>
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' Allocate and clear a block of normal memory aligned on a multiple of the alignment value</div>
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
{| class="wikitable" style="font-size: 14px; background: white;"
|-
! Alignment
| The alignment must be a multiple of the minimum alignment configuration
|-
|}
</div></div>
<br />
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;">
<pre style="border: 0; padding-bottom:0px;">function AllocAlignedMemEx(Size,Alignment:PtrUInt; Flags,Affinity:LongWord):Pointer;</pre>
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' Allocate and clear a block of normal memory aligned on a multiple of the alignment value with the flags and affinity requested</div>
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
{| class="wikitable" style="font-size: 14px; background: white;"
|-
! Alignment
| The alignment must be a multiple of the minimum alignment configuration
|-
|}
</div></div>
<br />
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;">
<pre style="border: 0; padding-bottom:0px;">function ReAllocAlignedMem(var Addr:Pointer; Size,Alignment:PtrUInt):Pointer;</pre>
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' Reallocate a block of normal memory aligned on a multiple of the alignment value</div>
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
{| class="wikitable" style="font-size: 14px; background: white;"
|-
! Alignment
| The alignment must be a multiple of the minimum alignment configuration
|-
|}
</div></div>
<br />
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;">
<pre style="border: 0; padding-bottom:0px;">function ReAllocAlignedMemEx(var Addr:Pointer; Size,Alignment:PtrUInt; Flags,Affinity:LongWord):Pointer;</pre>
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' Reallocate a block of memory aligned on a multiple of the alignment value with the flags and affinity requested</div>
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
{| class="wikitable" style="font-size: 14px; background: white;"
|-
! Alignment
| The alignment must be a multiple of the minimum alignment configuration
|-
|}
</div></div>
<br />
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;">
<pre style="border: 0; padding-bottom:0px;">function AllocSharedMem(Size:PtrUInt):Pointer;</pre>
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' Allocate and clear a block of shared memory</div>
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
{| class="wikitable" style="font-size: 14px; background: white;"
|-
! Note
| None documented
|-
|}
</div></div>
<br />
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;">
<pre style="border: 0; padding-bottom:0px;">function AllocSharedAlignedMem(Size,Alignment:PtrUInt):Pointer;</pre>
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' Allocate and clear a block of shared memory aligned on a multiple of the alignment value</div>
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
{| class="wikitable" style="font-size: 14px; background: white;"
|-
! Alignment
| The alignment must be a multiple of the minimum alignment configuration
|-
|}
</div></div>
<br />
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;">
<pre style="border: 0; padding-bottom:0px;">function ReAllocSharedMem(var Addr:Pointer; Size:PtrUInt):Pointer;</pre>
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' Reallocate a block of shared memory</div>
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
{| class="wikitable" style="font-size: 14px; background: white;"
|-
! Note
| None documented
|-
|}
</div></div>
<br />
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;">
<pre style="border: 0; padding-bottom:0px;">function ReAllocSharedAlignedMem(var Addr:Pointer; Size,Alignment:PtrUInt):Pointer;</pre>
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' Reallocate a block of shared memory aligned on a multiple of the alignment value</div>
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
{| class="wikitable" style="font-size: 14px; background: white;"
|-
! Alignment
| The alignment must be a multiple of the minimum alignment configuration
|-
|}
</div></div>
<br />
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;">
<pre style="border: 0; padding-bottom:0px;">function AllocLocalMem(Size:PtrUInt; Affinity:LongWord):Pointer;</pre>
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' Allocate and clear a block of local memory</div>
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
{| class="wikitable" style="font-size: 14px; background: white;"
|-
! Note
| None documented
|-
|}
</div></div>
<br />
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;">
<pre style="border: 0; padding-bottom:0px;">function AllocLocalAlignedMem(Size,Alignment:PtrUInt; Affinity:LongWord):Pointer;</pre>
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' Allocate and clear a block of local memory aligned on a multiple of the alignment value</div>
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
{| class="wikitable" style="font-size: 14px; background: white;"
|-
! Alignment
| The alignment must be a multiple of the minimum alignment configuration
|-
|}
</div></div>
<br />
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;">
<pre style="border: 0; padding-bottom:0px;">function ReAllocLocalMem(var Addr:Pointer; Size:PtrUInt; Affinity:LongWord):Pointer;</pre>
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' Reallocate a block of local memory</div>
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
{| class="wikitable" style="font-size: 14px; background: white;"
|-
! Note
| None documented
|-
|}
</div></div>
<br />
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;">
<pre style="border: 0; padding-bottom:0px;">function ReAllocLocalAlignedMem(var Addr:Pointer; Size,Alignment:PtrUInt; Affinity:LongWord):Pointer;</pre>
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' Reallocate a block of local memory aligned on a multiple of the alignment value</div>
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
{| class="wikitable" style="font-size: 14px; background: white;"
|-
! Alignment
| The alignment must be a multiple of the minimum alignment configuration
|-
|}
</div></div>
<br />
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;">
<pre style="border: 0; padding-bottom:0px;">function AllocCodeMem(Size:PtrUInt; Affinity:LongWord):Pointer;</pre>
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' Allocate and clear a block of code memory</div>
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
{| class="wikitable" style="font-size: 14px; background: white;"
|-
! Note
| None documented
|-
|}
</div></div>
<br />
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;">
<pre style="border: 0; padding-bottom:0px;">function AllocCodeAlignedMem(Size,Alignment:PtrUInt; Affinity:LongWord):Pointer;</pre>
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' Allocate and clear a block of code memory aligned on a multiple of the alignment value</div>
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
{| class="wikitable" style="font-size: 14px; background: white;"
|-
! Alignment
| The alignment must be a multiple of the minimum alignment configuration
|-
|}
</div></div>
<br />
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;">
<pre style="border: 0; padding-bottom:0px;">function ReAllocCodeMem(var Addr:Pointer; Size:PtrUInt; Affinity:LongWord):Pointer;</pre>
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' Reallocate a block of code memory</div>
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
{| class="wikitable" style="font-size: 14px; background: white;"
|-
! Note
| None documented
|-
|}
</div></div>
<br />
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;">
<pre style="border: 0; padding-bottom:0px;">function ReAllocCodeAlignedMem(var Addr:Pointer; Size,Alignment:PtrUInt; Affinity:LongWord):Pointer;</pre>
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' Reallocate a block of code memory aligned on a multiple of the alignment value</div>
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
{| class="wikitable" style="font-size: 14px; background: white;"
|-
! Alignment
| The alignment must be a multiple of the minimum alignment configuration
|-
|}
</div></div>
<br />
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;">
<pre style="border: 0; padding-bottom:0px;">function AllocDeviceMem(Size:PtrUInt):Pointer;</pre>
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' Allocate and clear a block of device memory</div>
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
{| class="wikitable" style="font-size: 14px; background: white;"
|-
! Note
| None documented
|-
|}
</div></div>
<br />
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;">
<pre style="border: 0; padding-bottom:0px;">function AllocDeviceAlignedMem(Size,Alignment:PtrUInt):Pointer;</pre>
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' Allocate and clear a block of device memory aligned on a multiple of the alignment value</div>
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
{| class="wikitable" style="font-size: 14px; background: white;"
|-
! Alignment
| The alignment must be a multiple of the minimum alignment configuration
|-
|}
</div></div>
<br />
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;">
<pre style="border: 0; padding-bottom:0px;">function ReAllocDeviceMem(var Addr:Pointer; Size:PtrUInt):Pointer;</pre>
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' Reallocate a block of device memory</div>
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
{| class="wikitable" style="font-size: 14px; background: white;"
|-
! Note
| None documented
|-
|}
</div></div>
<br />
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;">
<pre style="border: 0; padding-bottom:0px;">function ReAllocDeviceAlignedMem(var Addr:Pointer; Size,Alignment:PtrUInt):Pointer;</pre>
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' Reallocate a block of device memory aligned on a multiple of the alignment value</div>
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
{| class="wikitable" style="font-size: 14px; background: white;"
|-
! Alignment
| The alignment must be a multiple of the minimum alignment configuration
|-
|}
</div></div>
<br />
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;">
<pre style="border: 0; padding-bottom:0px;">function AllocNoCacheMem(Size:PtrUInt):Pointer;</pre>
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' Allocate and clear a block of non cached memory</div>
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
{| class="wikitable" style="font-size: 14px; background: white;"
|-
! Note
| None documented
|-
|}
</div></div>
<br />
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;">
<pre style="border: 0; padding-bottom:0px;">function AllocNoCacheAlignedMem(Size,Alignment:PtrUInt):Pointer;</pre>
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' Allocate and clear a block of non cached memory aligned on a multiple of the alignment value</div>
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
{| class="wikitable" style="font-size: 14px; background: white;"
|-
! Alignment
| The alignment must be a multiple of the minimum alignment configuration
|-
|}
</div></div>
<br />
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;">
<pre style="border: 0; padding-bottom:0px;">function ReAllocNoCacheMem(var Addr:Pointer; Size:PtrUInt):Pointer;</pre>
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' Reallocate a block of non cached memory</div>
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
{| class="wikitable" style="font-size: 14px; background: white;"
|-
! Note
| None documented
|-
|}
</div></div>
<br />
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;">
<pre style="border: 0; padding-bottom:0px;">function ReAllocNoCacheAlignedMem(var Addr:Pointer; Size,Alignment:PtrUInt):Pointer;</pre>
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' Reallocate a block of non cached memory aligned on a multiple of the alignment value</div>
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
{| class="wikitable" style="font-size: 14px; background: white;"
|-
! Alignment
| The alignment must be a multiple of the minimum alignment configuration
|-
|}
</div></div>
<br />
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;">
<pre style="border: 0; padding-bottom:0px;">function AllocNonSharedMem(Size:PtrUInt):Pointer;</pre>
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' Allocate and clear a block of non shared memory</div>
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
{| class="wikitable" style="font-size: 14px; background: white;"
|-
! Note
| None documented
|-
|}
</div></div>
<br />
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;">
<pre style="border: 0; padding-bottom:0px;">function AllocNonSharedAlignedMem(Size,Alignment:PtrUInt):Pointer;</pre>
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' Allocate and clear a block of non shared memory aligned on a multiple of the alignment value</div>
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
{| class="wikitable" style="font-size: 14px; background: white;"
|-
! Alignment
| The alignment must be a multiple of the minimum alignment configuration
|-
|}
</div></div>
<br />
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;">
<pre style="border: 0; padding-bottom:0px;">function ReAllocNonSharedMem(var Addr:Pointer; Size:PtrUInt):Pointer;</pre>
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' Reallocate a block of non shared memory</div>
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
{| class="wikitable" style="font-size: 14px; background: white;"
|-
! Note
| None documented
|-
|}
</div></div>
<br />
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;">
<pre style="border: 0; padding-bottom:0px;">function ReAllocNonSharedAlignedMem(var Addr:Pointer; Size,Alignment:PtrUInt):Pointer;</pre>
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' Reallocate a block of non shared memory aligned on a multiple of the alignment value</div>
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
{| class="wikitable" style="font-size: 14px; background: white;"
|-
! Alignment
| The alignment must be a multiple of the minimum alignment configuration
|-
|}
</div></div>
<br />
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;">
<pre style="border: 0; padding-bottom:0px;">function AllocIRQMem(Size:PtrUInt; Affinity:LongWord):Pointer;</pre>
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' Allocate and clear a block of IRQ memory</div>
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
{| class="wikitable" style="font-size: 14px; background: white;"
|-
! Note
| The memory must be freed using FreeIRQMem
|-
|}
</div></div>
<br />
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;">
<pre style="border: 0; padding-bottom:0px;">function AllocIRQAlignedMem(Size,Alignment:PtrUInt; Affinity:LongWord):Pointer;</pre>
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' Allocate and clear a block of IRQ memory aligned on a multiple of the alignment value</div>
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
{| class="wikitable" style="font-size: 14px; background: white;"
|-
! Alignment
| The alignment must be a multiple of the minimum alignment configuration
|-
! Note
| The memory must be freed using FreeIRQMem
|-
|}
</div></div>
<br />
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;">
<pre style="border: 0; padding-bottom:0px;">function ReAllocIRQMem(var Addr:Pointer; Size:PtrUInt; Affinity:LongWord):Pointer;</pre>
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' Reallocate a block of IRQ memory</div>
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
{| class="wikitable" style="font-size: 14px; background: white;"
|-
! Note
| None documented
|-
|}
</div></div>
<br />
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;">
<pre style="border: 0; padding-bottom:0px;">function ReAllocIRQAlignedMem(var Addr:Pointer; Size,Alignment:PtrUInt; Affinity:LongWord):Pointer;</pre>
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' Reallocate a block of IRQ memory aligned on a multiple of the alignment value</div>
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
{| class="wikitable" style="font-size: 14px; background: white;"
|-
! Alignment
| The alignment must be a multiple of the minimum alignment configuration
|-
|}
</div></div>
<br />
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;">
<pre style="border: 0; padding-bottom:0px;">function AllocFIQMem(Size:PtrUInt; Affinity:LongWord):Pointer;</pre>
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' Allocate and clear a block of FIQ memory</div>
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
{| class="wikitable" style="font-size: 14px; background: white;"
|-
! Note
| The memory must be freed using FreeFIQMem
|-
|}
</div></div>
<br />
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;">
<pre style="border: 0; padding-bottom:0px;">function AllocFIQAlignedMem(Size,Alignment:PtrUInt; Affinity:LongWord):Pointer;</pre>
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' Allocate and clear a block of FIQ memory aligned on a multiple of the alignment value</div>
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
{| class="wikitable" style="font-size: 14px; background: white;"
|-
! Alignment
| The alignment must be a multiple of the minimum alignment configuration
|-
! Note
| The memory must be freed using FreeFIQMem
|-
|}
</div></div>
<br />
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;">
<pre style="border: 0; padding-bottom:0px;">function ReAllocFIQMem(var Addr:Pointer; Size:PtrUInt; Affinity:LongWord):Pointer;</pre>
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' Reallocate a block of FIQ memory</div>
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
{| class="wikitable" style="font-size: 14px; background: white;"
|-
! Note
| None documented
|-
|}
</div></div>
<br />
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;">
<pre style="border: 0; padding-bottom:0px;">function ReAllocFIQAlignedMem(var Addr:Pointer; Size,Alignment:PtrUInt; Affinity:LongWord):Pointer;</pre>
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' Reallocate a block of FIQ memory aligned on a multiple of the alignment value</div>
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
{| class="wikitable" style="font-size: 14px; background: white;"
|-
! Alignment
| The alignment must be a multiple of the minimum alignment configuration
|-
|}
</div></div>
<br />
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;">
<pre style="border: 0; padding-bottom:0px;">function SizeIRQMem(Addr:Pointer):PtrUInt;</pre>
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' Return the size of an allocated block of IRQ memory</div>
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
{| class="wikitable" style="font-size: 14px; background: white;"
|-
! Note
| None documented
|-
|}
</div></div>
<br />
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;">
<pre style="border: 0; padding-bottom:0px;">function SizeFIQMem(Addr:Pointer):PtrUInt;</pre>
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' Return the size of an allocated block of FIQ memory</div>
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
{| class="wikitable" style="font-size: 14px; background: white;"
|-
! Note
| None documented
|-
|}
</div></div>
<br />
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;">
<pre style="border: 0; padding-bottom:0px;">function MemFlags(Addr:Pointer):LongWord;</pre>
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' Return the flags of an allocated block of memory</div>
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
{| class="wikitable" style="font-size: 14px; background: white;"
|-
! Note
| None documented
|-
|}
</div></div>
<br />
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;">
<pre style="border: 0; padding-bottom:0px;">function MemFlagsIRQ(Addr:Pointer):LongWord;</pre>
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' Return the flags of an allocated block of IRQ memory</div>
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
{| class="wikitable" style="font-size: 14px; background: white;"
|-
! Note
| None documented
|-
|}
</div></div>
<br />
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;">
<pre style="border: 0; padding-bottom:0px;">function MemFlagsFIQ(Addr:Pointer):LongWord;</pre>
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' Return the flags of an allocated block of FIQ memory</div>
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
{| class="wikitable" style="font-size: 14px; background: white;"
|-
! Note
| None documented
|-
|}
</div></div>
<br />
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;">
<pre style="border: 0; padding-bottom:0px;">function GetHeapStatistics:THeapStatistics;</pre>
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' Return detailed statistics for the heap manager</div>
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
{| class="wikitable" style="font-size: 14px; background: white;"
|-
! Note
| None documented
|-
|}
</div></div>
<br />
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;">
<pre style="border: 0; padding-bottom:0px;">function GetHeapBlockCount(State:LongWord):LongWord;</pre>
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' Get the total number of current heap blocks based on state</div>
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
{| class="wikitable" style="font-size: 14px; background: white;"
|-
! Note
| None documented
|-
|}
</div></div>
<br />
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;">
<pre style="border: 0; padding-bottom:0px;">function GetHeapBlockCountEx(State,Flags,Affinity:LongWord):LongWord;</pre>
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' Get the number of current heap blocks based on state, flags and affinity</div>
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
{| class="wikitable" style="font-size: 14px; background: white;"
|-
! Note
| This uses the block list (not the Free/Used/Small lists) in order to account for all blocks
|-
|}
</div></div>
<br />
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;">
<pre style="border: 0; padding-bottom:0px;">function GetHeapBlockMin(State:LongWord):LongWord;</pre>
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' Get the minimum size of current heap blocks based on state</div>
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
{| class="wikitable" style="font-size: 14px; background: white;"
|-
! Note
| None documented
|-
|}
</div></div>
<br />
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;">
<pre style="border: 0; padding-bottom:0px;">function GetHeapBlockMinEx(State,Flags,Affinity:LongWord):LongWord;</pre>
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' Get the minimum size of current heap blocks based on state, flags and affinity</div>
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
{| class="wikitable" style="font-size: 14px; background: white;"
|-
! Note
| This uses the block list (not the Free/Used/Small lists) in order to account for all blocks
|-
|}
</div></div>
<br />
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;">
<pre style="border: 0; padding-bottom:0px;">function GetHeapBlockMax(State:LongWord):LongWord;</pre>
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' Get the maximum size of current heap blocks based on state</div>
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
{| class="wikitable" style="font-size: 14px; background: white;"
|-
! Note
| None documented
|-
|}
</div></div>
<br />
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;">
<pre style="border: 0; padding-bottom:0px;">function GetHeapBlockMaxEx(State,Flags,Affinity:LongWord):LongWord;</pre>
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' Get the maximum size of current heap blocks based on state, flags and affinity</div>
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
{| class="wikitable" style="font-size: 14px; background: white;"
|-
! Note
| This uses the block list (not the Free/Used/Small lists) in order to account for all blocks
|-
|}
</div></div>
<br />
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;">
<pre style="border: 0; padding-bottom:0px;">function CreateHeapSnapshot(State:LongWord):PHeapSnapshot;</pre>
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' To be documented</div>
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
{| class="wikitable" style="font-size: 14px; background: white;"
|-
! Note
| None documented
|-
|}
</div></div>
<br />
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;">
<pre style="border: 0; padding-bottom:0px;">function CreateHeapSnapshotEx(State,Flags,Affinity:LongWord):PHeapSnapshot;</pre>
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' To be documented</div>
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
{| class="wikitable" style="font-size: 14px; background: white;"
|-
! Note
| None documented
|-
|}
</div></div>
<br />
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;">
<pre style="border: 0; padding-bottom:0px;">function DestroyHeapSnapshot(Snapshot:PHeapSnapshot):LongWord;</pre>
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' To be documented</div>
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
{| class="wikitable" style="font-size: 14px; background: white;"
|-
! Note
| None documented
|-
|}
</div></div>
<br />

'''Internal functions'''

<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;">
<pre style="border: 0; padding-bottom:0px;">function GetHeapBlock(Address:Pointer):PHeapBlock;</pre>
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' Get the Heap Block referenced by Address</div>
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
{| class="wikitable" style="font-size: 14px; background: white;"
|-
! Note
| Address has already been normalized to include the Heap Block
Caller must hold the heap lock
|-
|}
</div></div>
<br />
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;">
<pre style="border: 0; padding-bottom:0px;">function FindHeapBlock(Address:Pointer; Size:PtrUInt):PHeapBlock;</pre>
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' Find the Heap Block containing Address up to the Size specified</div>
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
{| class="wikitable" style="font-size: 14px; background: white;"
|-
! Note
| Address has already been normalized to include the Heap Block
Caller must hold the heap lock
|-
|}
</div></div>
<br />
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;">
<pre style="border: 0; padding-bottom:0px;">function AddHeapBlock(Block:PHeapBlock):Boolean;</pre>
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' Add a heap block, sorted by ascending Address order</div>
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
{| class="wikitable" style="font-size: 14px; background: white;"
|-
! Note
| Caller must hold the heap lock
|-
|}
</div></div>
<br />
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;">
<pre style="border: 0; padding-bottom:0px;">function SplitHeapBlock(Block:PHeapBlock; Size:PtrUInt):PHeapBlock;</pre>
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' Split a heap block at the size indicated</div>
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
{| class="wikitable" style="font-size: 14px; background: white;"
|-
! Return
| Return The return is the split portion of the block
|-
! Note
| Caller must remove block from the free list. Caller must add split block to the free list. 
Caller must hold the heap lock
|-
|}
</div></div>
<br />
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;">
<pre style="border: 0; padding-bottom:0px;">function MergeHeapBlock(Block:PHeapBlock):PHeapBlock;</pre>
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' Merge a heap block with Prev or Next blocks if free</div>
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
{| class="wikitable" style="font-size: 14px; background: white;"
|-
! Return
| The return is the merged result of the blocks
|-
! Note
| Caller must remove block from the free list. Caller must add merged block to the free list.
Caller must hold the heap lock
|-
|}
</div></div>
<br />
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;">
<pre style="border: 0; padding-bottom:0px;">function GetFreeBlock(Size:PtrUInt):PHeapBlock;</pre>
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' Get a free block of at least the size indicated</div>
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
{| class="wikitable" style="font-size: 14px; background: white;"
|-
! Size
| The size has already been normalized to alignment and includes the size of the Heap Block
|-
! Note
| Caller must hold the heap lock
|-
|}
</div></div>
<br />
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;">
<pre style="border: 0; padding-bottom:0px;">function GetFreeBlockEx(Size:PtrUInt; Flags,Affinity:LongWord):PHeapBlock;</pre>
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' Get a free block of at least the size indicated with the flags and affinity requested</div>
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
{| class="wikitable" style="font-size: 14px; background: white;"
|-
! Size
| The size has already been normalized to alignment and includes the size of the Heap Block
|-
! Note
| Caller must hold the heap lock
|-
|}
</div></div>
<br />
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;">
<pre style="border: 0; padding-bottom:0px;">function FindFreeBlock(Size:PtrUInt):PHeapBlock;</pre>
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' Find a free block of at least the size indicated with no flags or affinity which is alignable to the HEAP_REQUEST_ALIGNMENT value</div>
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
{| class="wikitable" style="font-size: 14px; background: white;"
|-
! Size
| The size is the exact size and has not been normalized
|-
! Note
| Caller must hold the heap lock
|-
|}
</div></div>
<br />
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;">
<pre style="border: 0; padding-bottom:0px;">function AddFreeBlock(Block:PHeapBlock):Boolean;</pre>
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' Add a free block, sorted by ascending Size order</div>
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
{| class="wikitable" style="font-size: 14px; background: white;"
|-
! Note
| Caller must hold the heap lock
|-
|}
</div></div>
<br />
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;">
<pre style="border: 0; padding-bottom:0px;">function RemoveFreeBlock(Block:PHeapBlock):Boolean;</pre>
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' Remove a free block</div>
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
{| class="wikitable" style="font-size: 14px; background: white;"
|-
! Note
| Caller must hold the heap lock
|-
|}
</div></div>
<br />
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;">
<pre style="border: 0; padding-bottom:0px;">function GetUsedBlock(Address:Pointer):PHeapBlock;</pre>
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' Get a used block by address</div>
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
{| class="wikitable" style="font-size: 14px; background: white;"
|-
! Address
| The address has already been normalized to include the Heap Block
|-
! Note
| Caller must hold the heap lock
|-
|}
</div></div>
<br />
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;">
<pre style="border: 0; padding-bottom:0px;">function CheckUsedBlock(Address:Pointer):Boolean; inline;</pre>
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' Check a used block by address</div>
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
{| class="wikitable" style="font-size: 14px; background: white;"
|-
! Address
| The address has already been normalized to include the Heap Block
|-
! Note
| Caller must hold the heap lock
|-
|}
</div></div>
<br />
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;">
<pre style="border: 0; padding-bottom:0px;">function AddUsedBlock(Block:PHeapBlock):Boolean;</pre>
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' Add a used block</div>
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
{| class="wikitable" style="font-size: 14px; background: white;"
|-
! Note
| Caller must hold the heap lock
|-
|}
</div></div>
<br />
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;">
<pre style="border: 0; padding-bottom:0px;">function RemoveUsedBlock(Block:PHeapBlock):Boolean;</pre>
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' Remove a used block</div>
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
{| class="wikitable" style="font-size: 14px; background: white;"
|-
! Note
| Caller must hold the heap lock
|-
|}
</div></div>
<br />
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;">
<pre style="border: 0; padding-bottom:0px;">function GetIRQBlock(Address:Pointer):PHeapBlock;</pre>
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' Get the IRQ Heap Block referenced by Address</div>
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
{| class="wikitable" style="font-size: 14px; background: white;"
|-
! Address
| The address has already been normalized to include the IRQ Heap Block
|-
! Note
| Caller must hold the IRQ heap lock
|-
|}
</div></div>
<br />
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;">
<pre style="border: 0; padding-bottom:0px;">function CheckIRQBlock(Address:Pointer):Boolean;</pre>
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' Check the IRQ Heap Block referenced by Address</div>
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
{| class="wikitable" style="font-size: 14px; background: white;"
|-
! Address
| The address has already been normalized to include the IRQ Heap Block
|-
! Note
| Caller must hold the IRQ heap lock
|-
|}
</div></div>
<br />
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;">
<pre style="border: 0; padding-bottom:0px;">function AddIRQBlock(Block:PHeapBlock):Boolean;</pre>
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' Add an IRQ heap block, sorted by ascending Address order</div>
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
{| class="wikitable" style="font-size: 14px; background: white;"
|-
! Note
| Caller must hold the IRQ heap lock
|-
|}
</div></div>
<br />
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;">
<pre style="border: 0; padding-bottom:0px;">function SplitIRQBlock(Block:PHeapBlock; Size:PtrUInt):PHeapBlock;</pre>
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' Split an IRQ heap block at the size indicated</div>
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
{| class="wikitable" style="font-size: 14px; background: white;"
|-
! Return
| The return is the split portion of the block
|-
! Note
| Caller must remove block from the IRQ free list. Caller must add split block to the IRQ free list.
Caller must hold the IRQ heap lock
|-
|}
</div></div>
<br />
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;">
<pre style="border: 0; padding-bottom:0px;">function MergeIRQBlock(Block:PHeapBlock):PHeapBlock;</pre>
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' Merge an IRQ heap block with Prev or Next blocks if free</div>
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
{| class="wikitable" style="font-size: 14px; background: white;"
|-
! Return
| The return is the merged result of the blocks
|-
! Note
| Caller must remove block from the IRQ free list. Caller must add merged block to the IRQ free list.
Caller must hold the IRQ heap lock
|-
|}
</div></div>
<br />
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;">
<pre style="border: 0; padding-bottom:0px;">function GetFreeIRQBlock(Size:PtrUInt; Affinity:LongWord):PHeapBlock;</pre>
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' Get a free IRQ block of at least the size indicated</div>
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
{| class="wikitable" style="font-size: 14px; background: white;"
|-
! Size
| The size has already been normalized to alignment and includes the size of the IRQ Heap Block
|-
! Note
| Caller must hold the IRQ heap lock
|-
|}
</div></div>
<br />
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;">
<pre style="border: 0; padding-bottom:0px;">function AddFreeIRQBlock(Block:PHeapBlock):Boolean;</pre>
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' Add a free IRQ block, sorted by ascending Size order</div>
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
{| class="wikitable" style="font-size: 14px; background: white;"
|-
! Note
| Caller must hold the IRQ heap lock
|-
|}
</div></div>
<br />
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;">
<pre style="border: 0; padding-bottom:0px;">function RemoveFreeIRQBlock(Block:PHeapBlock):Boolean;</pre>
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' Remove a free IRQ block</div>
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
{| class="wikitable" style="font-size: 14px; background: white;"
|-
! Note
| Caller must hold the IRQ heap lock
|-
|}
</div></div>
<br />
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;">
<pre style="border: 0; padding-bottom:0px;">function GetFIQBlock(Address:Pointer):PHeapBlock;</pre>
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' Get the FIQ Heap Block referenced by Address</div>
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
{| class="wikitable" style="font-size: 14px; background: white;"
|-
! Address
| The address has already been normalized to include the FIQ Heap Block
|-
! Note
| Caller must hold the FIQ heap lock
|-
|}
</div></div>
<br />
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;">
<pre style="border: 0; padding-bottom:0px;">function CheckFIQBlock(Address:Pointer):Boolean;</pre>
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' Check the FIQ Heap Block referenced by Address</div>
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
{| class="wikitable" style="font-size: 14px; background: white;"
|-
! Address
| The address has already been normalized to include the FIQ Heap Block
|-
! Note
| Caller must hold the FIQ heap lock
|-
|}
</div></div>
<br />
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;">
<pre style="border: 0; padding-bottom:0px;">function AddFIQBlock(Block:PHeapBlock):Boolean;</pre>
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' Add an FIQ heap block, sorted by ascending Address order</div>
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
{| class="wikitable" style="font-size: 14px; background: white;"
|-
! Note
| Caller must hold the FIQ heap lock
|-
|}
</div></div>
<br />
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;">
<pre style="border: 0; padding-bottom:0px;">function SplitFIQBlock(Block:PHeapBlock; Size:PtrUInt):PHeapBlock;</pre>
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' Split an FIQ heap block at the size indicated</div>
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
{| class="wikitable" style="font-size: 14px; background: white;"
|-
! Return
| The return is the split portion of the block
|-
! Note
| Caller must remove block from the FIQ free list. Caller must add split block to the FIQ free list.
Caller must hold the FIQ heap lock
|-
|}
</div></div>
<br />
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;">
<pre style="border: 0; padding-bottom:0px;">function MergeFIQBlock(Block:PHeapBlock):PHeapBlock;</pre>
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' Merge an FIQ heap block with Prev or Next blocks if free</div>
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
{| class="wikitable" style="font-size: 14px; background: white;"
|-
! Return
| The return is the merged result of the blocks
|-
! Note
| Caller must remove block from the FIQ free list. Caller must add merged block to the FIQ free list.
Caller must hold the FIQ heap lock
|-
|}
</div></div>
<br />
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;">
<pre style="border: 0; padding-bottom:0px;">function GetFreeFIQBlock(Size:PtrUInt; Affinity:LongWord):PHeapBlock;</pre>
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' Get a free FIQ block of at least the size indicated</div>
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
{| class="wikitable" style="font-size: 14px; background: white;"
|-
! Size
| The size has already been normalized to alignment and includes the size of the FIQ Heap Block
|-
! Note
| Caller must hold the FIQ heap lock
|-
|}
</div></div>
<br />
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;">
<pre style="border: 0; padding-bottom:0px;">function AddFreeFIQBlock(Block:PHeapBlock):Boolean;</pre>
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' Add a free FIQ block, sorted by ascending Size order</div>
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
{| class="wikitable" style="font-size: 14px; background: white;"
|-
! Note
| Caller must hold the FIQ heap lock
|-
|}
</div></div>
<br />
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;">
<pre style="border: 0; padding-bottom:0px;">function RemoveFreeFIQBlock(Block:PHeapBlock):Boolean;</pre>
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' Remove a free FIQ block</div>
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
{| class="wikitable" style="font-size: 14px; background: white;"
|-
! Note
| Caller must hold the FIQ heap lock
|-
|}
</div></div>
<br />

'''RTL heap manager functions'''

<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;">
<pre style="border: 0; padding-bottom:0px;">function SysGetMem(Size:PtrUInt):Pointer;</pre>
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' Allocate a block of normal memory</div>
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
{| class="wikitable" style="font-size: 14px; background: white;"
|-
! Note
| None documented
|-
|}
</div></div>
<br />
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;">
<pre style="border: 0; padding-bottom:0px;">function SysFreeMem(Addr:Pointer):PtrUInt;</pre>
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' Free a block of memory</div>
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
{| class="wikitable" style="font-size: 14px; background: white;"
|-
! Note
| None documented
|-
|}
</div></div>
<br />
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;">
<pre style="border: 0; padding-bottom:0px;">function SysFreeMemSize(Addr:Pointer; Size:PtrUInt):PtrUInt;</pre>
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' Free a block of memory</div>
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
{| class="wikitable" style="font-size: 14px; background: white;"
|-
! Note
| Size is not currently used
|-
|}
</div></div>
<br />
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;">
<pre style="border: 0; padding-bottom:0px;">function SysAllocMem(Size:PtrUInt):Pointer;</pre>
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' Allocate and clear a block of normal memory</div>
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
{| class="wikitable" style="font-size: 14px; background: white;"
|-
! Note
| None documented
|-
|}
</div></div>
<br />
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;">
<pre style="border: 0; padding-bottom:0px;">function SysReAllocMem(var Addr:Pointer; Size:PtrUInt):Pointer;</pre>
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' Reallocate a block of normal memory</div>
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
{| class="wikitable" style="font-size: 14px; background: white;"
|-
! Note
| None documented
|-
|}
</div></div>
<br />
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;">
<pre style="border: 0; padding-bottom:0px;">function SysSizeMem(Addr:Pointer):PtrUInt;</pre>
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' Return the size of an allocated block of memory</div>
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
{| class="wikitable" style="font-size: 14px; background: white;"
|-
! Note
| None documented
|-
|}
</div></div>
<br />
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;">
<pre style="border: 0; padding-bottom:0px;">procedure SysInitThread;</pre>
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' Initialize thread specific heap information</div>
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
{| class="wikitable" style="font-size: 14px; background: white;"
|-
! Note
| None documented
|-
|}
</div></div>
<br />
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;">
<pre style="border: 0; padding-bottom:0px;">procedure SysDoneThread;</pre>
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' Finalize thread specific heap information</div>
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
{| class="wikitable" style="font-size: 14px; background: white;"
|-
! Note
| None documented
|-
|}
</div></div>
<br />
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;">
<pre style="border: 0; padding-bottom:0px;">procedure SysRelocateHeap;</pre>
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' Relocate heap data</div>
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
{| class="wikitable" style="font-size: 14px; background: white;"
|-
! Note
| None documented
|-
|}
</div></div>
<br />
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;">
<pre style="border: 0; padding-bottom:0px;">function SysGetHeapStatus:THeapStatus;</pre>
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' Return status information for the heap manager</div>
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
{| class="wikitable" style="font-size: 14px; background: white;"
|-
! Note
| None documented
|-
|}
</div></div>
<br />
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;">
<pre style="border: 0; padding-bottom:0px;">function SysGetFPCHeapStatus:TFPCHeapStatus;</pre>
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' Return status information for the heap manager</div>
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
{| class="wikitable" style="font-size: 14px; background: white;"
|-
! Note
| None documented
|-
|}
</div></div>
<br />

'''Helper functions'''

<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;">
<pre style="border: 0; padding-bottom:0px;">procedure AcquireHeapLock; inline;</pre>
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' To be documented</div>
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
{| class="wikitable" style="font-size: 14px; background: white;"
|-
! Note
| None documented
|-
|}
</div></div>
<br />
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;">
<pre style="border: 0; padding-bottom:0px;">procedure ReleaseHeapLock; inline;</pre>
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' To be documented</div>
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
{| class="wikitable" style="font-size: 14px; background: white;"
|-
! Note
| None documented
|-
|}
</div></div>
<br />
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;">
<pre style="border: 0; padding-bottom:0px;">procedure AcquireHeapIRQLock; inline;</pre>
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' To be documented</div>
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
{| class="wikitable" style="font-size: 14px; background: white;"
|-
! Note
| None documented
|-
|}
</div></div>
<br />
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;">
<pre style="border: 0; padding-bottom:0px;">procedure ReleaseHeapIRQLock; inline;</pre>
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' To be documented</div>
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
{| class="wikitable" style="font-size: 14px; background: white;"
|-
! Note
| None documented
|-
|}
</div></div>
<br />
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;">
<pre style="border: 0; padding-bottom:0px;">procedure AcquireHeapFIQLock; inline;</pre>
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' To be documented</div>
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
{| class="wikitable" style="font-size: 14px; background: white;"
|-
! Note
| None documented
|-
|}
</div></div>
<br />
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;">
<pre style="border: 0; padding-bottom:0px;">procedure ReleaseHeapFIQLock; inline;</pre>
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' To be documented</div>
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
{| class="wikitable" style="font-size: 14px; background: white;"
|-
! Note
| None documented
|-
|}
</div></div>
<br />
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;">
<pre style="border: 0; padding-bottom:0px;">procedure RegisterHeapLock(const Lock:THeapLock);</pre>
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' To be documented</div>
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
{| class="wikitable" style="font-size: 14px; background: white;"
|-
! Note
| None documented
|-
|}
</div></div>
<br />
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;">
<pre style="border: 0; padding-bottom:0px;">function HeapStateToString(State:LongWord):String;</pre>
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' To be documented</div>
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
{| class="wikitable" style="font-size: 14px; background: white;"
|-
! Note
| None documented
|-
|}
</div></div>
<br />

Return to [[Unit_Reference|Unit Reference]]