Crate kspin

kspin

Spinlocks used for kernel space that can disable preemption or IRQs in the critical section.

Cargo Features

• smp: Use in the multi-core environment. For single-core environment (without this feature), the lock state is unnecessary and optimized out. CPU can always get the lock if we follow the proper guard in use. By default, this feature is disabled.

Examples

use kspin::{SpinNoIrq, SpinNoPreempt, SpinRaw};

let data = SpinRaw::new(());
let mut guard = data.lock();
/* critical section, does nothing while trying to lock. */
drop(guard);

let data = SpinNoPreempt::new(());
let mut guard = data.lock();
/* critical section, preemption are disabled. */
drop(guard);

let data = SpinNoIrq::new(());
let mut guard = data.lock();
/* critical section, both preemption and IRQs are disabled. */
drop(guard);

Structs

• BaseSpinLock
  A spin lock providing mutually exclusive access to data.
• BaseSpinLockGuard
  A guard that provides mutable data access.

Type Aliases

• SpinNoIrq
  A spin lock that disables kernel preemption and local IRQs while trying to lock, and re-enables it after unlocking.
• SpinNoIrqGuard
  A guard that provides mutable data access for SpinNoIrq.
• SpinNoPreempt
  A spin lock that disables kernel preemption while trying to lock, and re-enables it after unlocking.
• SpinNoPreemptGuard
  A guard that provides mutable data access for SpinNoPreempt.
• SpinRaw
  A raw spin lock that does nothing while trying to lock.
• SpinRawGuard
  A guard that provides mutable data access for SpinRaw.