use std::mem::MaybeUninit; use crate::{ mutex::{Mutex, MutexRef}, rwlock::{ReadLock, RwLock, RwLockReadRef, RwLockWriteRef, WriteLock}, }; use lock_api::{RawMutex, RawRwLock}; mod sealed { use super::Lockable as L; #[allow(clippy::wildcard_imports)] use super::*; pub trait Sealed {} impl<'a, T, R: RawMutex + 'a> Sealed for Mutex {} impl<'a, T, R: RawRwLock + 'a> Sealed for RwLock {} impl<'a, T, R: RawRwLock + 'a> Sealed for ReadLock<'a, T, R> {} impl<'a, T, R: RawRwLock + 'a> Sealed for WriteLock<'a, T, R> {} impl Sealed for &T {} impl Sealed for &mut T {} impl<'a, A: L<'a>> Sealed for (A,) {} impl<'a, A: L<'a>, B: L<'a>> Sealed for (A, B) {} impl<'a, A: L<'a>, B: L<'a>, C: L<'a>> Sealed for (A, B, C) {} impl<'a, A: L<'a>, B: L<'a>, C: L<'a>, D: L<'a>> Sealed for (A, B, C, D) {} impl<'a, A: L<'a>, B: L<'a>, C: L<'a>, D: L<'a>, E: L<'a>> Sealed for (A, B, C, D, E) {} impl<'a, A: L<'a>, B: L<'a>, C: L<'a>, D: L<'a>, E: L<'a>, F: L<'a>> Sealed for (A, B, C, D, E, F) {} impl<'a, T: Lockable<'a>, const N: usize> Sealed for [T; N] {} impl<'a, T: Lockable<'a>> Sealed for Vec {} } /// A type that may be locked and unlocked /// /// # Safety /// /// A deadlock must never occur. The `unlock` method must correctly unlock the /// data. pub unsafe trait Lockable<'a>: sealed::Sealed { /// The output of the lock type Output; /// Blocks until the lock is acquired /// /// # Safety /// /// It is undefined behavior to: /// * Use this without ownership or mutable access to the [`ThreadKey`], /// which should last as long as the return value is alive. /// * Call this on multiple locks without unlocking first. /// /// [`ThreadKey`]: `crate::key::ThreadKey` unsafe fn lock(&'a self) -> Self::Output; /// Attempt to lock without blocking. /// /// Returns `Some` if successful, `None` otherwise. /// /// # Safety /// /// It is undefined behavior to use this without ownership or mutable /// access to the [`ThreadKey`], which should last as long as the return /// value is alive. /// /// [`ThreadKey`]: `crate::key::ThreadKey` unsafe fn try_lock(&'a self) -> Option; /// Release the lock fn unlock(guard: Self::Output); } unsafe impl<'a, T: Lockable<'a>> Lockable<'a> for &T { type Output = T::Output; unsafe fn lock(&'a self) -> Self::Output { (*self).lock() } unsafe fn try_lock(&'a self) -> Option { (*self).try_lock() } #[allow(clippy::semicolon_if_nothing_returned)] fn unlock(guard: Self::Output) { T::unlock(guard) } } unsafe impl<'a, T: Lockable<'a>> Lockable<'a> for &mut T { type Output = T::Output; unsafe fn lock(&'a self) -> Self::Output { (**self).lock() } unsafe fn try_lock(&'a self) -> Option { (**self).try_lock() } #[allow(clippy::semicolon_if_nothing_returned)] fn unlock(guard: Self::Output) { T::unlock(guard) } } unsafe impl<'a, T: 'a, R: RawMutex + 'a> Lockable<'a> for Mutex { type Output = MutexRef<'a, T, R>; unsafe fn lock(&'a self) -> Self::Output { self.lock_no_key() } unsafe fn try_lock(&'a self) -> Option { self.try_lock_no_key() } fn unlock(guard: Self::Output) { drop(guard); } } unsafe impl<'a, T: 'a, R: RawRwLock + 'a> Lockable<'a> for RwLock { type Output = RwLockWriteRef<'a, T, R>; unsafe fn lock(&'a self) -> Self::Output { self.write_no_key() } unsafe fn try_lock(&'a self) -> Option { self.try_write_no_key() } fn unlock(guard: Self::Output) { drop(guard); } } unsafe impl<'a, T: 'a, R: RawRwLock + 'a> Lockable<'a> for ReadLock<'a, T, R> { type Output = RwLockReadRef<'a, T, R>; unsafe fn lock(&'a self) -> Self::Output { self.lock_no_key() } unsafe fn try_lock(&'a self) -> Option { self.try_lock_no_key() } fn unlock(guard: Self::Output) { drop(guard); } } unsafe impl<'a, T: 'a, R: RawRwLock + 'a> Lockable<'a> for WriteLock<'a, T, R> { type Output = RwLockWriteRef<'a, T, R>; unsafe fn lock(&'a self) -> Self::Output { self.lock_no_key() } unsafe fn try_lock(&'a self) -> Option { self.try_lock_no_key() } fn unlock(guard: Self::Output) { drop(guard); } } unsafe impl<'a, A: Lockable<'a>> Lockable<'a> for (A,) { type Output = (A::Output,); unsafe fn lock(&'a self) -> Self::Output { (self.0.lock(),) } unsafe fn try_lock(&'a self) -> Option { self.0.try_lock().map(|a| (a,)) } fn unlock(guard: Self::Output) { A::unlock(guard.0); } } unsafe impl<'a, A: Lockable<'a>, B: Lockable<'a>> Lockable<'a> for (A, B) { type Output = (A::Output, B::Output); unsafe fn lock(&'a self) -> Self::Output { loop { let lock0 = self.0.lock(); let Some(lock1) = self.1.try_lock() else { A::unlock(lock0); continue; }; return (lock0, lock1); } } unsafe fn try_lock(&'a self) -> Option { let Some(lock0) = self.0.try_lock() else { return None; }; let Some(lock1) = self.1.try_lock() else { A::unlock(lock0); return None; }; Some((lock0, lock1)) } fn unlock(guard: Self::Output) { A::unlock(guard.0); B::unlock(guard.1); } } unsafe impl<'a, A: Lockable<'a>, B: Lockable<'a>, C: Lockable<'a>> Lockable<'a> for (A, B, C) { type Output = (A::Output, B::Output, C::Output); unsafe fn lock(&'a self) -> Self::Output { loop { let lock0 = self.0.lock(); let Some(lock1) = self.1.try_lock() else { A::unlock(lock0); continue; }; let Some(lock2) = self.2.try_lock() else { A::unlock(lock0); B::unlock(lock1); continue; }; return (lock0, lock1, lock2); } } unsafe fn try_lock(&'a self) -> Option { let Some(lock0) = self.0.try_lock() else { return None; }; let Some(lock1) = self.1.try_lock() else { A::unlock(lock0); return None; }; let Some(lock2) = self.2.try_lock() else { A::unlock(lock0); B::unlock(lock1); return None; }; Some((lock0, lock1, lock2)) } fn unlock(guard: Self::Output) { A::unlock(guard.0); B::unlock(guard.1); C::unlock(guard.2); } } unsafe impl<'a, A: Lockable<'a>, B: Lockable<'a>, C: Lockable<'a>, D: Lockable<'a>> Lockable<'a> for (A, B, C, D) { type Output = (A::Output, B::Output, C::Output, D::Output); unsafe fn lock(&'a self) -> Self::Output { loop { let lock0 = self.0.lock(); let Some(lock1) = self.1.try_lock() else { A::unlock(lock0); continue; }; let Some(lock2) = self.2.try_lock() else { A::unlock(lock0); B::unlock(lock1); continue; }; let Some(lock3) = self.3.try_lock() else { A::unlock(lock0); B::unlock(lock1); C::unlock(lock2); continue; }; return (lock0, lock1, lock2, lock3); } } unsafe fn try_lock(&'a self) -> Option { let Some(lock0) = self.0.try_lock() else { return None; }; let Some(lock1) = self.1.try_lock() else { A::unlock(lock0); return None; }; let Some(lock2) = self.2.try_lock() else { A::unlock(lock0); B::unlock(lock1); return None; }; let Some(lock3) = self.3.try_lock() else { A::unlock(lock0); B::unlock(lock1); C::unlock(lock2); return None; }; Some((lock0, lock1, lock2, lock3)) } fn unlock(guard: Self::Output) { A::unlock(guard.0); B::unlock(guard.1); C::unlock(guard.2); D::unlock(guard.3); } } unsafe impl<'a, A: Lockable<'a>, B: Lockable<'a>, C: Lockable<'a>, D: Lockable<'a>, E: Lockable<'a>> Lockable<'a> for (A, B, C, D, E) { type Output = (A::Output, B::Output, C::Output, D::Output, E::Output); unsafe fn lock(&'a self) -> Self::Output { loop { let lock0 = self.0.lock(); let Some(lock1) = self.1.try_lock() else { A::unlock(lock0); continue; }; let Some(lock2) = self.2.try_lock() else { A::unlock(lock0); B::unlock(lock1); continue; }; let Some(lock3) = self.3.try_lock() else { A::unlock(lock0); B::unlock(lock1); C::unlock(lock2); continue; }; let Some(lock4) = self.4.try_lock() else { A::unlock(lock0); B::unlock(lock1); C::unlock(lock2); D::unlock(lock3); continue; }; return (lock0, lock1, lock2, lock3, lock4); } } unsafe fn try_lock(&'a self) -> Option { let Some(lock0) = self.0.try_lock() else { return None; }; let Some(lock1) = self.1.try_lock() else { A::unlock(lock0); return None; }; let Some(lock2) = self.2.try_lock() else { A::unlock(lock0); B::unlock(lock1); return None; }; let Some(lock3) = self.3.try_lock() else { A::unlock(lock0); B::unlock(lock1); C::unlock(lock2); return None; }; let Some(lock4) = self.4.try_lock() else { A::unlock(lock0); B::unlock(lock1); C::unlock(lock2); D::unlock(lock3); return None; }; Some((lock0, lock1, lock2, lock3, lock4)) } fn unlock(guard: Self::Output) { A::unlock(guard.0); B::unlock(guard.1); C::unlock(guard.2); D::unlock(guard.3); E::unlock(guard.4); } } unsafe impl< 'a, A: Lockable<'a>, B: Lockable<'a>, C: Lockable<'a>, D: Lockable<'a>, E: Lockable<'a>, F: Lockable<'a>, > Lockable<'a> for (A, B, C, D, E, F) { type Output = ( A::Output, B::Output, C::Output, D::Output, E::Output, F::Output, ); unsafe fn lock(&'a self) -> Self::Output { loop { let lock0 = self.0.lock(); let Some(lock1) = self.1.try_lock() else { A::unlock(lock0); continue; }; let Some(lock2) = self.2.try_lock() else { A::unlock(lock0); B::unlock(lock1); continue; }; let Some(lock3) = self.3.try_lock() else { A::unlock(lock0); B::unlock(lock1); C::unlock(lock2); continue; }; let Some(lock4) = self.4.try_lock() else { A::unlock(lock0); B::unlock(lock1); C::unlock(lock2); D::unlock(lock3); continue; }; let Some(lock5) = self.5.try_lock() else { A::unlock(lock0); B::unlock(lock1); C::unlock(lock2); D::unlock(lock3); E::unlock(lock4); continue; }; return (lock0, lock1, lock2, lock3, lock4, lock5); } } unsafe fn try_lock(&'a self) -> Option { let Some(lock0) = self.0.try_lock() else { return None; }; let Some(lock1) = self.1.try_lock() else { A::unlock(lock0); return None; }; let Some(lock2) = self.2.try_lock() else { A::unlock(lock0); B::unlock(lock1); return None; }; let Some(lock3) = self.3.try_lock() else { A::unlock(lock0); B::unlock(lock1); C::unlock(lock2); return None; }; let Some(lock4) = self.4.try_lock() else { A::unlock(lock0); B::unlock(lock1); C::unlock(lock2); D::unlock(lock3); return None; }; let Some(lock5) = self.5.try_lock() else { A::unlock(lock0); B::unlock(lock1); C::unlock(lock2); D::unlock(lock3); E::unlock(lock4); return None; }; Some((lock0, lock1, lock2, lock3, lock4, lock5)) } fn unlock(guard: Self::Output) { A::unlock(guard.0); B::unlock(guard.1); C::unlock(guard.2); D::unlock(guard.3); E::unlock(guard.4); F::unlock(guard.5); } } unsafe impl<'a, T: Lockable<'a>, const N: usize> Lockable<'a> for [T; N] { type Output = [T::Output; N]; unsafe fn lock(&'a self) -> Self::Output { unsafe fn unlock_partial<'a, T: Lockable<'a>, const N: usize>( guards: [MaybeUninit; N], upto: usize, ) { for (i, guard) in guards.into_iter().enumerate() { if i == upto { break; } T::unlock(guard.assume_init()); } } 'outer: loop { let mut outputs = MaybeUninit::<[MaybeUninit; N]>::uninit().assume_init(); if N == 0 { return outputs.map(|mu| mu.assume_init()); } outputs[0].write(self[0].lock()); for i in 1..N { if let Some(guard) = self[i].try_lock() { outputs[i].write(guard) } else { unlock_partial::(outputs, i); continue 'outer; }; } return outputs.map(|mu| mu.assume_init()); } } unsafe fn try_lock(&'a self) -> Option { unsafe fn unlock_partial<'a, T: Lockable<'a>, const N: usize>( guards: [MaybeUninit; N], upto: usize, ) { for (i, guard) in guards.into_iter().enumerate() { if i == upto { break; } T::unlock(guard.assume_init()); } } let mut outputs = MaybeUninit::<[MaybeUninit; N]>::uninit().assume_init(); for i in 0..N { if let Some(guard) = self[i].try_lock() { outputs[i].write(guard) } else { unlock_partial::(outputs, i); return None; }; } Some(outputs.map(|mu| mu.assume_init())) } fn unlock(guard: Self::Output) { guard.map(T::unlock); } } unsafe impl<'a, T: Lockable<'a>> Lockable<'a> for Vec { type Output = Vec; unsafe fn lock(&'a self) -> Self::Output { 'outer: loop { let mut outputs = Vec::with_capacity(self.len()); if self.is_empty() { return outputs; } outputs.push(self[0].lock()); for lock in self.iter().skip(1) { if let Some(guard) = lock.try_lock() { outputs.push(guard); } else { Self::unlock(outputs); continue 'outer; }; } return outputs; } } unsafe fn try_lock(&'a self) -> Option { let mut outputs = Vec::with_capacity(self.len()); for lock in self { if let Some(guard) = lock.try_lock() { outputs.push(guard); } else { Self::unlock(outputs); return None; }; } Some(outputs) } fn unlock(guard: Self::Output) { for guard in guard { T::unlock(guard); } } }