Function MemHeader.deallocate
deallocate -- return memory back to the MemHeader pool
void deallocate
(
void* memoryBlock,
ulong byteSize
);
This function deallocates memory by returning it to the appropriate private free memory pool. This function can be used to free an entire block allocated with the above function, or it can be used to free a sub-block of a previously allocated block. Sub-blocks must be an even multiple of the memory chunk size (currently MEM_BLOCKSIZE bytes). But it's strongly encouraged to deallocate only blocks as a whole !
This function can even be used to add a new free region to an existing MemHeader, however the extent pointers in the MemHeader will no longer be valid. This is strongly discouraged !
If memoryBlock is not on a block boundary (MEM_BLOCKSIZE) then it will be rounded down in a manner compatible with Allocate(). Note that this will work correctly with all the memory allocation functions, but may cause surprises if one is freeing only part of a region. The size of the block will be rounded up, so the freed block will fill to an even memory block boundary.
Parameters
| Name | Description |
|---|---|
| memoryBlock | address of memory to free |
| byteSize | size of memory to free. |
Returns
The memoryBlock is freed and it's content is no longer valid.
See
initMemHeader(), addMemHeader(), remMemHeader(), allocate(), allocateAbs()