Struct LockedHeap

pub struct LockedHeap(/* private fields */);

Implementations

impl LockedHeap

pub const fn empty() -> LockedHeap

pub unsafe fn new(heap_bottom: *mut u8, heap_size: usize) -> LockedHeap

Creates a new heap with the given bottom and size.

The heap_bottom pointer is automatically aligned, so the bottom() method might return a pointer that is larger than heap_bottom after construction.

The given heap_size must be large enough to store the required metadata, otherwise this function will panic. Depending on the alignment of the hole_addr pointer, the minimum size is between 2 * size_of::<usize> and 3 * size_of::<usize>.

Safety

The bottom address must be valid and the memory in the [heap_bottom, heap_bottom + heap_size) range must not be used for anything else. This function is unsafe because it can cause undefined behavior if the given address is invalid.

The provided memory range must be valid for the 'static lifetime.

Trait Implementations

impl Deref for LockedHeap

type Target = Mutex<RawSpinlock, Heap>

The resulting type after dereferencing.

fn deref(&self) -> &Spinlock<Heap>

Dereferences the value.

impl GlobalAlloc for LockedHeap

unsafe fn alloc(&self, layout: Layout) -> *mut u8

Allocates memory as described by the given layout.

unsafe fn dealloc(&self, ptr: *mut u8, layout: Layout)

Deallocates the block of memory at the given ptr pointer with the given layout.

unsafe fn alloc_zeroed(&self, layout: Layout) -> *mut u8

Behaves like alloc, but also ensures that the contents are set to zero before being returned.

unsafe fn realloc( &self, ptr: *mut u8, layout: Layout, new_size: usize, ) -> *mut u8

Shrinks or grows a block of memory to the given new_size in bytes. The block is described by the given ptr pointer and layout.