Struct sunrise_kernel::sync::mutex::MutexInner

struct MutexInner {
    spin_lock: SpinLock<MutexInnerInner>,
}

The type responsible of actually performing the locking of the mutex.

Just a SpinLock<MutexInnerInner>>.

This might seem a bit weird to have an intermediate a struct just for that, but it is to stay as close as possible to std's Mutex design, so we can copy-paste it with ease.

Fields

spin_lock: SpinLock<MutexInnerInner>

A spin lock arbitrating accesses to the mutex's state.

Implementations

impl MutexInner

unsafe fn try_lock(&self) -> bool

Try to obtain the mutex, without preempting.

Returns false if the mutex was not immediately available.

unsafe fn raw_lock(&self)

Locks the mutex blocking the current thread until it is available.

Panics

Panics if we're already the owner of the mutex, as this is a deadlock otherwise.

unsafe fn raw_unlock(&self)

Unlocks the mutex.

Consider switching from the pair of raw_lock() and raw_unlock() to lock() whenever possible.

Panics

Panics if the mutex wasn't held, or if our thread was not the owner of this mutex, as this definitely is a bug and we shouldn't have created a MutexGuard for it.