Struct sunrise_kernel::heap_allocator::Allocator

pub struct Allocator(Once<SpinLock<Heap>>);

Simple wrapper around linked_list_allocator, growing heap by allocating pages with the frame allocator as necessary.

Implementations

impl Allocator

fn expand(&self, by: usize)

Safely expands the heap if possible.

fn init() -> SpinLock<Heap>

Create a new Heap of RESERVED_HEAP_SIZE bytes.

pub const fn new() -> Allocator

Creates a new heap based off of loader settings.

Methods from Deref<Target = SpinLock<Heap>>

pub fn lock(&self) -> SpinLockGuard<T>

Locks the spinlock and returns a guard.

The returned value may be dereferenced for data access and the lock will be dropped when the guard falls out of scope.

Panics if called in an interrupt context.

let mylock = crate::sync::SpinLock::new(0);
{
    let mut data = mylock.lock();
    // The lock is now locked and the data can be accessed
    *data += 1;
    // The lock is implicitly dropped
}

pub unsafe fn force_unlock(&self)

Force unlock the spinlock. If the lock isn't held, this is a no-op.

Safety

This is extremely unsafe if the lock is not held by the current thread. However, this can be useful in some instances for exposing the lock to FFI that doesn't know how to deal with RAII.

pub fn try_lock(&self) -> Option<SpinLockGuard<T>>

Tries to lock the spinlock. If it is already locked, it will return None. Otherwise it returns a guard within Some.

Trait Implementations

impl Deref for Allocator

type Target = SpinLock<Heap>

The resulting type after dereferencing.

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

Dereferences the value.

impl<'a> GlobalAlloc for Allocator

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.