Struct sc_allocator::FreeingBumpHeapAllocator

pub struct FreeingBumpHeapAllocator { /* private fields */ }

An implementation of freeing bump allocator.

Refer to the module-level documentation for further details.

Implementations

impl FreeingBumpHeapAllocator

pub fn new(heap_base: u32) -> Self

Creates a new allocation heap which follows a freeing-bump strategy.

Arguments

• heap_base - the offset from the beginning of the linear memory where the heap starts.

pub fn allocate( &mut self, mem: &mut impl Memory, size: WordSize ) -> Result<Pointer<u8>, Error>

Gets requested number of bytes to allocate and returns a pointer. The maximum size which can be allocated at once is 32 MiB. There is no minimum size, but whatever size is passed into this function is rounded to the next power of two. If the requested size is below 8 bytes it will be rounded up to 8 bytes.

The identity or the type of the passed memory object does not matter. However, the size of memory cannot shrink compared to the memory passed in previous invocations.

NOTE: Once the allocator has returned an error all subsequent requests will return an error.

Arguments

• mem - a slice representing the linear memory on which this allocator operates.
• size - size in bytes of the allocation request

pub fn deallocate( &mut self, mem: &mut impl Memory, ptr: Pointer<u8> ) -> Result<(), Error>

Deallocates the space which was allocated for a pointer.

The identity or the type of the passed memory object does not matter. However, the size of memory cannot shrink compared to the memory passed in previous invocations.

NOTE: Once the allocator has returned an error all subsequent requests will return an error.

Arguments

• mem - a slice representing the linear memory on which this allocator operates.
• ptr - pointer to the allocated chunk

pub fn stats(&self) -> AllocationStats

Returns the allocation stats for this allocator.

Trait Implementations

impl Drop for FreeingBumpHeapAllocator

fn drop(&mut self)

Executes the destructor for this type.