Struct buddy_system_allocator::LockedHeap

source · [−]

pub struct LockedHeap(_);

Expand description

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);
}

Implementations

source

impl LockedHeap

source

pub const fn new() -> LockedHeap

Creates an empty heap

source

pub const fn empty() -> LockedHeap

Creates an empty heap

Methods from Deref<Target = Mutex<Heap>>

source

pub fn is_locked(&self) -> bool

Returns true if the lock is currently held.

This function provides no synchronization guarantees and so its result should be considered ‘out of date’ the instant it is called. Do not use it for synchronization purposes. However, it may be useful as a heuristic.

source

pub fn lock(&self) -> MutexGuard<'_, T>

Locks the Mutex and returns a guard that permits access to the inner data.

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

let lock = spin::Mutex::new(0);
{
    let mut data = lock.lock();
    // The lock is now locked and the data can be accessed
    *data += 1;
    // The lock is implicitly dropped at the end of the scope
}

source

pub unsafe fn force_unlock(&self)

Force unlock this Mutex.

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.

source

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

Try to lock this Mutex, returning a lock guard if successful.

Example

let lock = spin::Mutex::new(42);

let maybe_guard = lock.try_lock();
assert!(maybe_guard.is_some());

// `maybe_guard` is still held, so the second call fails
let maybe_guard2 = lock.try_lock();
assert!(maybe_guard2.is_none());