Struct buddy_system_allocator::LockedHeap

pub struct LockedHeap(_);

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::new();
unsafe {
    heap.lock().init(begin, size);
    // or
    heap.lock().add_to_heap(begin, end);
}

Methods

impl LockedHeap

pub const fn new() -> LockedHeap

Creates an empty heap

pub const fn empty() -> LockedHeap

Creates an empty heap

Methods from Deref<Target = Mutex<Heap>>

pub fn lock(&self) -> MutexGuard<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.

let mylock = spin::Mutex::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.

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.

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

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

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

Trait Implementations

impl Deref for LockedHeap

type Target = Mutex<Heap>

The resulting type after dereferencing.

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

Dereferences the value.

impl GlobalAlloc for LockedHeap

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.