use std::cell::UnsafeCell; use std::fmt; use std::ops::{Deref, DerefMut}; use std::sync::atomic::{AtomicBool, Ordering}; use crate::signal::Signal; /// An asynchronous mutex. /// /// This type is similar to [`std::sync::Mutex`], except locking is an asynchronous operation. /// /// [`std::sync::Mutex`]: https://doc.rust-lang.org/std/sync/struct.Mutex.html /// /// # Examples /// /// ``` /// # smol::run(async { /// # /// use piper::Mutex; /// use smol::Task; /// use std::sync::Arc; /// /// let m = Arc::new(Mutex::new(0)); /// let mut tasks = vec![]; /// /// for _ in 0..10 { /// let m = m.clone(); /// tasks.push(Task::spawn(async move { /// *m.lock().await += 1; /// })); /// } /// /// for t in tasks { /// t.await; /// } /// assert_eq!(*m.lock().await, 10); /// # /// # }) /// ``` pub struct Mutex { locked: AtomicBool, lock_ops: Signal, data: UnsafeCell, } unsafe impl Send for Mutex {} unsafe impl Sync for Mutex {} impl Mutex { /// Creates a new async mutex. /// /// # Examples /// /// ``` /// use piper::Mutex; /// /// let mutex = Mutex::new(0); /// ``` pub fn new(data: T) -> Mutex { Mutex { locked: AtomicBool::new(false), lock_ops: Signal::new(), data: UnsafeCell::new(data), } } /// Acquires the mutex. /// /// Returns a guard that releases the mutex when dropped. /// /// # Examples /// /// ``` /// # smol::block_on(async { /// # /// use piper::Mutex; /// /// let mutex = Mutex::new(10); /// let guard = mutex.lock().await; /// assert_eq!(*guard, 10); /// # /// # }) /// ``` pub async fn lock(&self) -> MutexGuard<'_, T> { loop { // Try locking the mutex. if let Some(guard) = self.try_lock() { return guard; } // Start watching for notifications and try locking again. let l = self.lock_ops.listen(); if let Some(guard) = self.try_lock() { return guard; } l.await; } } /// Attempts to acquire the mutex. /// /// If the mutex could not be acquired at this time, then [`None`] is returned. Otherwise, a /// guard is returned that releases the mutex when dropped. /// /// [`None`]: https://doc.rust-lang.org/std/option/enum.Option.html#variant.None /// /// # Examples /// /// ``` /// use piper::Mutex; /// /// let mutex = Mutex::new(10); /// if let Ok(guard) = mutex.try_lock() { /// assert_eq!(*guard, 10); /// } /// # ; /// ``` #[inline] pub fn try_lock(&self) -> Option> { if !self.locked.compare_and_swap(false, true, Ordering::Acquire) { Some(MutexGuard(self)) } else { None } } /// Consumes the mutex, returning the underlying data. /// /// # Examples /// /// ``` /// use piper::Mutex; /// /// let mutex = Mutex::new(10); /// assert_eq!(mutex.into_inner(), 10); /// ``` pub fn into_inner(self) -> T { self.data.into_inner() } /// Returns a mutable reference to the underlying data. /// /// Since this call borrows the mutex mutably, no actual locking takes place -- the mutable /// borrow statically guarantees the mutex is not already acquired. /// /// # Examples /// /// ``` /// # smol::block_on(async { /// # /// use piper::Mutex; /// /// let mut mutex = Mutex::new(0); /// *mutex.get_mut() = 10; /// assert_eq!(*mutex.lock().await, 10); /// # /// # }) /// ``` pub fn get_mut(&mut self) -> &mut T { unsafe { &mut *self.data.get() } } } impl fmt::Debug for Mutex { fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result { struct Locked; impl fmt::Debug for Locked { fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result { f.write_str("") } } match self.try_lock() { None => f.debug_struct("Mutex").field("data", &Locked).finish(), Some(guard) => f.debug_struct("Mutex").field("data", &&*guard).finish(), } } } impl From for Mutex { fn from(val: T) -> Mutex { Mutex::new(val) } } impl Default for Mutex { fn default() -> Mutex { Mutex::new(Default::default()) } } /// A guard that releases the mutex when dropped. pub struct MutexGuard<'a, T>(&'a Mutex); unsafe impl Send for MutexGuard<'_, T> {} unsafe impl Sync for MutexGuard<'_, T> {} impl Drop for MutexGuard<'_, T> { fn drop(&mut self) { self.0.locked.store(false, Ordering::Release); self.0.lock_ops.notify_one(); } } impl fmt::Debug for MutexGuard<'_, T> { fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result { fmt::Debug::fmt(&**self, f) } } impl fmt::Display for MutexGuard<'_, T> { fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result { (**self).fmt(f) } } impl Deref for MutexGuard<'_, T> { type Target = T; fn deref(&self) -> &T { unsafe { &*self.0.data.get() } } } impl DerefMut for MutexGuard<'_, T> { fn deref_mut(&mut self) -> &mut T { unsafe { &mut *self.0.data.get() } } }