Commit eb5ccb03 authored by Lyude Paul's avatar Lyude Paul Committed by Boqun Feng
Browse files

rust: sync: Add SpinLockGuard type alias 



A simple helper alias for code that needs to deal with Guard types returned
from SpinLocks.

Signed-off-by: default avatarLyude Paul <lyude@redhat.com>
Reviewed-by: default avatarAlice Ryhl <aliceryhl@google.com>
Signed-off-by: default avatarBoqun Feng <boqun.feng@gmail.com>
Link: https://lore.kernel.org/r/20241120222742.2490495-3-lyude@redhat.com
parent 37624dde

rust/kernel/sync.rs

+1 −1
Original line number Diff line number Diff line
@@ -17,7 +17,7 @@ 
pub use condvar::{new_condvar, CondVar, CondVarTimeoutResult};

pub use lock::global::{global_lock, GlobalGuard, GlobalLock, GlobalLockBackend, GlobalLockedBy};

pub use lock::mutex::{new_mutex, Mutex, MutexGuard};

pub use lock::spinlock::{new_spinlock, SpinLock};

pub use lock::spinlock::{new_spinlock, SpinLock, SpinLockGuard};

pub use locked_by::LockedBy;



/// Represents a lockdep class. It's a wrapper around C's `lock_class_key`.

rust/kernel/sync/lock/spinlock.rs

+8 −0
Original line number Diff line number Diff line
@@ -87,6 +87,14 @@ macro_rules! new_spinlock { 
/// A kernel `spinlock_t` lock backend.

pub struct SpinLockBackend;



/// A [`Guard`] acquired from locking a [`SpinLock`].

///

/// This is simply a type alias for a [`Guard`] returned from locking a [`SpinLock`]. It will unlock

/// the [`SpinLock`] upon being dropped.

///

/// [`Guard`]: super::Guard

pub type SpinLockGuard<'a, T> = super::Guard<'a, T, SpinLockBackend>;



// SAFETY: The underlying kernel `spinlock_t` object ensures mutual exclusion. `relock` uses the

// default implementation that always calls the same locking method.

unsafe impl super::Backend for SpinLockBackend {