Struct buddy_system_allocator::LockedHeap

pub struct LockedHeap<const ORDER: usize>(_);

A locked version of Heap

Usage

Create a locked heap and add a memory region to it:

use buddy_system_allocator::*;
let mut heap = LockedHeap::<32>::new();
unsafe {
    heap.lock().init(begin, size);
    // or
    heap.lock().add_to_heap(begin, end);
}

Implementations

impl<const ORDER: usize> LockedHeap<ORDER>

pub const fn new() -> Self

Creates an empty heap

pub const fn empty() -> Self

Creates an empty heap

Trait Implementations

impl<const ORDER: usize> Deref for LockedHeap<ORDER>

type Target = Mutex<Heap<ORDER>, Spin>

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl<const ORDER: usize> GlobalAlloc for LockedHeap<ORDER>

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

Allocate memory as described by the given layout.

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

Deallocate 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

Shrink or grow a block of memory to the given new_size. The block is described by the given ptr pointer and layout.