summaryrefslogtreecommitdiff
path: root/src/collection
diff options
context:
space:
mode:
authorBotahamec <botahamec@outlook.com>2024-05-23 20:44:02 -0400
committerBotahamec <botahamec@outlook.com>2024-05-23 20:44:02 -0400
commitfd4ee65a78ecbf376d99377a367137b0b8cdad41 (patch)
tree663b211b0da02431b2d100a270d60d48eebbefb0 /src/collection
parent0926201a52f860b1f75dda2e9bd6d2e536cc5f68 (diff)
parent8ecf29cfe2a74d02b2c4bcb7f7ad1a811dc38dfe (diff)
Merge branch '0.2'
Diffstat (limited to 'src/collection')
-rw-r--r--src/collection/boxed.rs510
-rw-r--r--src/collection/collection.rs291
-rw-r--r--src/collection/guard.rs33
-rw-r--r--src/collection/owned.rs347
-rw-r--r--src/collection/ref.rs399
-rw-r--r--src/collection/retry.rs619
-rw-r--r--src/collection/utils.rs44
7 files changed, 1948 insertions, 295 deletions
diff --git a/src/collection/boxed.rs b/src/collection/boxed.rs
new file mode 100644
index 0000000..5ced6d1
--- /dev/null
+++ b/src/collection/boxed.rs
@@ -0,0 +1,510 @@
+use std::fmt::Debug;
+use std::marker::PhantomData;
+
+use crate::lockable::{Lockable, OwnedLockable, RawLock, Sharable};
+use crate::Keyable;
+
+use super::{utils, BoxedLockCollection, LockGuard};
+
+/// returns `true` if the sorted list contains a duplicate
+#[must_use]
+fn contains_duplicates(l: &[&dyn RawLock]) -> bool {
+ l.windows(2)
+ .any(|window| std::ptr::eq(window[0], window[1]))
+}
+
+unsafe impl<L: Lockable> Lockable for BoxedLockCollection<L> {
+ type Guard<'g> = L::Guard<'g> where Self: 'g;
+
+ type ReadGuard<'g> = L::ReadGuard<'g> where Self: 'g;
+
+ fn get_ptrs<'a>(&'a self, ptrs: &mut Vec<&'a dyn RawLock>) {
+ self.data.get_ptrs(ptrs)
+ }
+
+ unsafe fn guard(&self) -> Self::Guard<'_> {
+ self.data.guard()
+ }
+
+ unsafe fn read_guard(&self) -> Self::ReadGuard<'_> {
+ self.data.read_guard()
+ }
+}
+
+unsafe impl<L: Sharable> Sharable for BoxedLockCollection<L> {}
+
+unsafe impl<L: OwnedLockable> OwnedLockable for BoxedLockCollection<L> {}
+
+impl<L> IntoIterator for BoxedLockCollection<L>
+where
+ L: IntoIterator,
+{
+ type Item = <L as IntoIterator>::Item;
+ type IntoIter = <L as IntoIterator>::IntoIter;
+
+ fn into_iter(self) -> Self::IntoIter {
+ self.data.into_iter()
+ }
+}
+
+impl<'a, L> IntoIterator for &'a BoxedLockCollection<L>
+where
+ &'a L: IntoIterator,
+{
+ type Item = <&'a L as IntoIterator>::Item;
+ type IntoIter = <&'a L as IntoIterator>::IntoIter;
+
+ fn into_iter(self) -> Self::IntoIter {
+ self.data.into_iter()
+ }
+}
+
+impl<'a, L> IntoIterator for &'a mut BoxedLockCollection<L>
+where
+ &'a mut L: IntoIterator,
+{
+ type Item = <&'a mut L as IntoIterator>::Item;
+ type IntoIter = <&'a mut L as IntoIterator>::IntoIter;
+
+ fn into_iter(self) -> Self::IntoIter {
+ self.data.into_iter()
+ }
+}
+
+impl<L: OwnedLockable, I: FromIterator<L> + OwnedLockable> FromIterator<L>
+ for BoxedLockCollection<I>
+{
+ fn from_iter<T: IntoIterator<Item = L>>(iter: T) -> Self {
+ let iter: I = iter.into_iter().collect();
+ Self::new(iter)
+ }
+}
+
+impl<E: OwnedLockable + Extend<L>, L: OwnedLockable> Extend<L> for BoxedLockCollection<E> {
+ fn extend<T: IntoIterator<Item = L>>(&mut self, iter: T) {
+ self.data.extend(iter)
+ }
+}
+
+impl<L> AsRef<L> for BoxedLockCollection<L> {
+ fn as_ref(&self) -> &L {
+ &self.data
+ }
+}
+
+impl<L> AsMut<L> for BoxedLockCollection<L> {
+ fn as_mut(&mut self) -> &mut L {
+ &mut self.data
+ }
+}
+
+impl<L: Debug> Debug for BoxedLockCollection<L> {
+ fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
+ f.debug_struct(stringify!(BoxedLockCollection))
+ .field("data", &self.data)
+ .finish_non_exhaustive()
+ }
+}
+
+impl<L: OwnedLockable + Default> Default for BoxedLockCollection<L> {
+ fn default() -> Self {
+ Self::new(L::default())
+ }
+}
+
+impl<L: OwnedLockable + Default> From<L> for BoxedLockCollection<L> {
+ fn from(value: L) -> Self {
+ Self::new(value)
+ }
+}
+
+impl<L: OwnedLockable> BoxedLockCollection<L> {
+ /// Creates a new collection of owned locks.
+ ///
+ /// Because the locks are owned, there's no need to do any checks for
+ /// duplicate values.
+ ///
+ /// # Examples
+ ///
+ /// ```
+ /// use happylock::{Mutex, LockCollection};
+ ///
+ /// let data = (Mutex::new(0), Mutex::new(""));
+ /// let lock = LockCollection::new(data);
+ /// ```
+ #[must_use]
+ pub fn new(data: L) -> Self {
+ // safety: owned lockable types cannot contain duplicates
+ unsafe { Self::new_unchecked(data) }
+ }
+}
+
+impl<'a, L: OwnedLockable> BoxedLockCollection<&'a L> {
+ /// Creates a new collection of owned locks.
+ ///
+ /// Because the locks are owned, there's no need to do any checks for
+ /// duplicate values.
+ ///
+ /// # Examples
+ ///
+ /// ```
+ /// use happylock::{Mutex, LockCollection};
+ ///
+ /// let data = (Mutex::new(0), Mutex::new(""));
+ /// let lock = LockCollection::new_ref(&data);
+ /// ```
+ #[must_use]
+ pub fn new_ref(data: &'a L) -> Self {
+ // safety: owned lockable types cannot contain duplicates
+ unsafe { Self::new_unchecked(data) }
+ }
+}
+
+impl<L: Lockable> BoxedLockCollection<L> {
+ /// Creates a new collections of locks.
+ ///
+ /// # Safety
+ ///
+ /// This results in undefined behavior if any locks are presented twice
+ /// within this collection.
+ ///
+ /// # Examples
+ ///
+ /// ```
+ /// use happylock::{Mutex, LockCollection};
+ ///
+ /// let data1 = Mutex::new(0);
+ /// let data2 = Mutex::new("");
+ ///
+ /// // safety: data1 and data2 refer to distinct mutexes
+ /// let data = (&data1, &data2);
+ /// let lock = unsafe { LockCollection::new_unchecked(&data) };
+ /// ```
+ #[must_use]
+ pub unsafe fn new_unchecked(data: L) -> Self {
+ let data = Box::new(data);
+ let mut locks = Vec::new();
+ data.get_ptrs(&mut locks);
+
+ // cast to *const () because fat pointers can't be converted to usize
+ locks.sort_by_key(|lock| std::ptr::from_ref(*lock).cast::<()>() as usize);
+
+ // safety: the box will be dropped after the lock references, so it's
+ // safe to just pretend they're static
+ let locks = std::mem::transmute(locks);
+ Self { data, locks }
+ }
+
+ /// Creates a new collection of locks.
+ ///
+ /// This returns `None` if any locks are found twice in the given
+ /// collection.
+ ///
+ /// # Examples
+ ///
+ /// ```
+ /// use happylock::{Mutex, LockCollection};
+ ///
+ /// let data1 = Mutex::new(0);
+ /// let data2 = Mutex::new("");
+ ///
+ /// // data1 and data2 refer to distinct mutexes, so this won't panic
+ /// let data = (&data1, &data2);
+ /// let lock = LockCollection::try_new(&data).unwrap();
+ /// ```
+ #[must_use]
+ pub fn try_new(data: L) -> Option<Self> {
+ // safety: we are checking for duplicates before returning
+ unsafe {
+ let this = Self::new_unchecked(data);
+ if contains_duplicates(&this.locks) {
+ return None;
+ }
+ Some(this)
+ }
+ }
+
+ /// Gets the underlying collection, consuming this collection.
+ ///
+ /// # Examples
+ ///
+ /// ```
+ /// use happylock::{Mutex, ThreadKey, LockCollection};
+ ///
+ /// let data1 = Mutex::new(42);
+ /// let data2 = Mutex::new("");
+ ///
+ /// // data1 and data2 refer to distinct mutexes, so this won't panic
+ /// let data = (&data1, &data2);
+ /// let lock = LockCollection::try_new(&data).unwrap();
+ ///
+ /// let key = ThreadKey::get().unwrap();
+ /// let guard = lock.into_inner().0.lock(key);
+ /// assert_eq!(*guard, 42);
+ /// ```
+ #[must_use]
+ pub fn into_inner(self) -> Box<L> {
+ self.data
+ }
+
+ /// Locks the collection
+ ///
+ /// This function returns a guard that can be used to access the underlying
+ /// data. When the guard is dropped, the locks in the collection are also
+ /// dropped.
+ ///
+ /// # Examples
+ ///
+ /// ```
+ /// use happylock::{Mutex, ThreadKey, LockCollection};
+ ///
+ /// let key = ThreadKey::get().unwrap();
+ /// let data = (Mutex::new(0), Mutex::new(""));
+ /// let lock = LockCollection::new(data);
+ ///
+ /// let mut guard = lock.lock(key);
+ /// *guard.0 += 1;
+ /// *guard.1 = "1";
+ /// ```
+ pub fn lock<'g, 'key: 'g, Key: Keyable + 'key>(
+ &'g self,
+ key: Key,
+ ) -> LockGuard<'key, L::Guard<'g>, Key> {
+ for lock in &self.locks {
+ // safety: we have the thread key
+ unsafe { lock.lock() };
+ }
+
+ LockGuard {
+ // safety: we've already acquired the lock
+ guard: unsafe { self.data.guard() },
+ key,
+ _phantom: PhantomData,
+ }
+ }
+
+ /// Attempts to lock the without blocking.
+ ///
+ /// If successful, this method returns a guard that can be used to access
+ /// the data, and unlocks the data when it is dropped. Otherwise, `None` is
+ /// returned.
+ ///
+ /// # Examples
+ ///
+ /// ```
+ /// use happylock::{Mutex, ThreadKey, LockCollection};
+ ///
+ /// let key = ThreadKey::get().unwrap();
+ /// let data = (Mutex::new(0), Mutex::new(""));
+ /// let lock = LockCollection::new(data);
+ ///
+ /// match lock.try_lock(key) {
+ /// Some(mut guard) => {
+ /// *guard.0 += 1;
+ /// *guard.1 = "1";
+ /// },
+ /// None => unreachable!(),
+ /// };
+ ///
+ /// ```
+ pub fn try_lock<'g, 'key: 'g, Key: Keyable + 'key>(
+ &'g self,
+ key: Key,
+ ) -> Option<LockGuard<'key, L::Guard<'g>, Key>> {
+ let guard = unsafe {
+ if !utils::ordered_try_lock(&self.locks) {
+ return None;
+ }
+
+ // safety: we've acquired the locks
+ self.data.guard()
+ };
+
+ Some(LockGuard {
+ guard,
+ key,
+ _phantom: PhantomData,
+ })
+ }
+
+ /// Unlocks the underlying lockable data type, returning the key that's
+ /// associated with it.
+ ///
+ /// # Examples
+ ///
+ /// ```
+ /// use happylock::{Mutex, ThreadKey, LockCollection};
+ ///
+ /// let key = ThreadKey::get().unwrap();
+ /// let data = (Mutex::new(0), Mutex::new(""));
+ /// let lock = LockCollection::new(data);
+ ///
+ /// let mut guard = lock.lock(key);
+ /// *guard.0 += 1;
+ /// *guard.1 = "1";
+ /// let key = LockCollection::<(Mutex<i32>, Mutex<&str>)>::unlock(guard);
+ /// ```
+ pub fn unlock<'key, Key: Keyable + 'key>(guard: LockGuard<'key, L::Guard<'_>, Key>) -> Key {
+ drop(guard.guard);
+ guard.key
+ }
+}
+
+impl<L: Sharable> BoxedLockCollection<L> {
+ /// Locks the collection, so that other threads can still read from it
+ ///
+ /// This function returns a guard that can be used to access the underlying
+ /// data immutably. When the guard is dropped, the locks in the collection
+ /// are also dropped.
+ ///
+ /// # Examples
+ ///
+ /// ```
+ /// use happylock::{RwLock, ThreadKey, LockCollection};
+ ///
+ /// let key = ThreadKey::get().unwrap();
+ /// let data = (RwLock::new(0), RwLock::new(""));
+ /// let lock = LockCollection::new(data);
+ ///
+ /// let mut guard = lock.read(key);
+ /// assert_eq!(*guard.0, 0);
+ /// assert_eq!(*guard.1, "");
+ /// ```
+ pub fn read<'g, 'key: 'g, Key: Keyable + 'key>(
+ &'g self,
+ key: Key,
+ ) -> LockGuard<'key, L::ReadGuard<'g>, Key> {
+ for lock in &self.locks {
+ // safety: we have the thread key
+ unsafe { lock.read() };
+ }
+
+ LockGuard {
+ // safety: we've already acquired the lock
+ guard: unsafe { self.data.read_guard() },
+ key,
+ _phantom: PhantomData,
+ }
+ }
+
+ /// Attempts to lock the without blocking, in such a way that other threads
+ /// can still read from the collection.
+ ///
+ /// If successful, this method returns a guard that can be used to access
+ /// the data immutably, and unlocks the data when it is dropped. Otherwise,
+ /// `None` is returned.
+ ///
+ /// # Examples
+ ///
+ /// ```
+ /// use happylock::{RwLock, ThreadKey, LockCollection};
+ ///
+ /// let key = ThreadKey::get().unwrap();
+ /// let data = (RwLock::new(5), RwLock::new("6"));
+ /// let lock = LockCollection::new(data);
+ ///
+ /// match lock.try_read(key) {
+ /// Some(mut guard) => {
+ /// assert_eq!(*guard.0, 5);
+ /// assert_eq!(*guard.1, "6");
+ /// },
+ /// None => unreachable!(),
+ /// };
+ ///
+ /// ```
+ pub fn try_read<'g, 'key: 'g, Key: Keyable + 'key>(
+ &'g self,
+ key: Key,
+ ) -> Option<LockGuard<'key, L::ReadGuard<'g>, Key>> {
+ let guard = unsafe {
+ if !utils::ordered_try_read(&self.locks) {
+ return None;
+ }
+
+ // safety: we've acquired the locks
+ self.data.read_guard()
+ };
+
+ Some(LockGuard {
+ guard,
+ key,
+ _phantom: PhantomData,
+ })
+ }
+
+ /// Unlocks the underlying lockable data type, returning the key that's
+ /// associated with it.
+ ///
+ /// # Examples
+ ///
+ /// ```
+ /// use happylock::{RwLock, ThreadKey, LockCollection};
+ ///
+ /// let key = ThreadKey::get().unwrap();
+ /// let data = (RwLock::new(0), RwLock::new(""));
+ /// let lock = LockCollection::new(data);
+ ///
+ /// let mut guard = lock.read(key);
+ /// let key = LockCollection::<(RwLock<i32>, RwLock<&str>)>::unlock_read(guard);
+ /// ```
+ pub fn unlock_read<'key, Key: Keyable + 'key>(
+ guard: LockGuard<'key, L::ReadGuard<'_>, Key>,
+ ) -> Key {
+ drop(guard.guard);
+ guard.key
+ }
+}
+
+impl<'a, L: 'a> BoxedLockCollection<L>
+where
+ &'a L: IntoIterator,
+{
+ /// Returns an iterator over references to each value in the collection.
+ ///
+ /// # Examples
+ ///
+ /// ```
+ /// use happylock::{Mutex, ThreadKey, LockCollection};
+ ///
+ /// let key = ThreadKey::get().unwrap();
+ /// let data = [Mutex::new(26), Mutex::new(1)];
+ /// let lock = LockCollection::new(data);
+ ///
+ /// let mut iter = lock.iter();
+ /// let mutex = iter.next().unwrap();
+ /// let guard = mutex.lock(key);
+ ///
+ /// assert_eq!(*guard, 26);
+ /// ```
+ #[must_use]
+ pub fn iter(&'a self) -> <&'a L as IntoIterator>::IntoIter {
+ self.into_iter()
+ }
+}
+
+impl<'a, L: 'a> BoxedLockCollection<L>
+where
+ &'a mut L: IntoIterator,
+{
+ /// Returns an iterator over mutable references to each value in the
+ /// collection.
+ ///
+ /// # Examples
+ ///
+ /// ```
+ /// use happylock::{Mutex, ThreadKey, LockCollection};
+ ///
+ /// let key = ThreadKey::get().unwrap();
+ /// let data = [Mutex::new(26), Mutex::new(1)];
+ /// let mut lock = LockCollection::new(data);
+ ///
+ /// let mut iter = lock.iter_mut();
+ /// let mutex = iter.next().unwrap();
+ ///
+ /// assert_eq!(*mutex.as_mut(), 26);
+ /// ```
+ #[must_use]
+ pub fn iter_mut(&'a mut self) -> <&'a mut L as IntoIterator>::IntoIter {
+ self.into_iter()
+ }
+}
diff --git a/src/collection/collection.rs b/src/collection/collection.rs
deleted file mode 100644
index 22a2d11..0000000
--- a/src/collection/collection.rs
+++ /dev/null
@@ -1,291 +0,0 @@
-use std::marker::PhantomData;
-
-use crate::{key::Keyable, Lockable, OwnedLockable};
-
-use super::{LockCollection, LockGuard};
-
-/// returns `true` if the list contains a duplicate
-#[must_use]
-fn contains_duplicates(l: &mut [usize]) -> bool {
- l.sort_unstable();
- l.windows(2).any(|w| w[0] == w[1])
-}
-
-impl<'a, L: OwnedLockable<'a>> From<L> for LockCollection<L> {
- fn from(value: L) -> Self {
- Self::new(value)
- }
-}
-
-impl<'a, L: Lockable<'a>> AsRef<L> for LockCollection<L> {
- fn as_ref(&self) -> &L {
- &self.data
- }
-}
-
-impl<'a, L: Lockable<'a>> AsMut<L> for LockCollection<L> {
- fn as_mut(&mut self) -> &mut L {
- &mut self.data
- }
-}
-
-impl<'a, L: Lockable<'a>> AsRef<Self> for LockCollection<L> {
- fn as_ref(&self) -> &Self {
- self
- }
-}
-
-impl<'a, L: Lockable<'a>> AsMut<Self> for LockCollection<L> {
- fn as_mut(&mut self) -> &mut Self {
- self
- }
-}
-
-impl<L: IntoIterator> IntoIterator for LockCollection<L> {
- type Item = L::Item;
- type IntoIter = L::IntoIter;
-
- fn into_iter(self) -> Self::IntoIter {
- self.data.into_iter()
- }
-}
-
-impl<'a, L> IntoIterator for &'a LockCollection<L>
-where
- &'a L: IntoIterator,
-{
- type Item = <&'a L as IntoIterator>::Item;
- type IntoIter = <&'a L as IntoIterator>::IntoIter;
-
- fn into_iter(self) -> Self::IntoIter {
- self.data.into_iter()
- }
-}
-
-impl<'a, L> IntoIterator for &'a mut LockCollection<L>
-where
- &'a mut L: IntoIterator,
-{
- type Item = <&'a mut L as IntoIterator>::Item;
- type IntoIter = <&'a mut L as IntoIterator>::IntoIter;
-
- fn into_iter(self) -> Self::IntoIter {
- self.data.into_iter()
- }
-}
-
-impl<'a, L: OwnedLockable<'a>, I: FromIterator<L> + OwnedLockable<'a>> FromIterator<L>
- for LockCollection<I>
-{
- fn from_iter<T: IntoIterator<Item = L>>(iter: T) -> Self {
- let iter: I = iter.into_iter().collect();
- Self::new(iter)
- }
-}
-
-impl<'a, E: OwnedLockable<'a> + Extend<L>, L: OwnedLockable<'a>> Extend<L> for LockCollection<E> {
- fn extend<T: IntoIterator<Item = L>>(&mut self, iter: T) {
- self.data.extend(iter)
- }
-}
-
-impl<'a, L: OwnedLockable<'a>> LockCollection<L> {
- /// Creates a new collection of owned locks.
- ///
- /// Because the locks are owned, there's no need to do any checks for
- /// duplicate values.
- ///
- /// # Examples
- ///
- /// ```
- /// use happylock::{LockCollection, Mutex};
- ///
- /// let lock = LockCollection::new((Mutex::new(0), Mutex::new("")));
- /// ```
- #[must_use]
- pub const fn new(data: L) -> Self {
- Self { data }
- }
-
- /// Creates a new collection of owned locks.
- ///
- /// Because the locks are owned, there's no need to do any checks for
- /// duplicate values.
- ///
- /// # Examples
- ///
- /// ```
- /// use happylock::{LockCollection, Mutex};
- ///
- /// let data = (Mutex::new(0), Mutex::new(""));
- /// let lock = LockCollection::new_ref(&data);
- /// ```
- #[must_use]
- pub const fn new_ref(data: &L) -> LockCollection<&L> {
- LockCollection { data }
- }
-}
-
-impl<L> LockCollection<L> {
- /// Creates a new collections of locks.
- ///
- /// # Safety
- ///
- /// This results in undefined behavior if any locks are presented twice
- /// within this collection.
- ///
- /// # Examples
- ///
- /// ```
- /// use happylock::{LockCollection, Mutex};
- ///
- /// let data1 = Mutex::new(0);
- /// let data2 = Mutex::new("");
- ///
- /// // safety: data1 and data2 refer to distinct mutexes
- /// let lock = unsafe { LockCollection::new_unchecked((&data1, &data2)) };
- /// ```
- #[must_use]
- pub const unsafe fn new_unchecked(data: L) -> Self {
- Self { data }
- }
-}
-
-impl<'a, L: Lockable<'a>> LockCollection<L> {
- /// Creates a new collection of locks.
- ///
- /// This returns `None` if any locks are found twice in the given
- /// collection.
- ///
- /// # Performance
- ///
- /// This does a check at runtime to make sure that the collection contains
- /// no two copies of the same lock. This is an `O(n^2)` operation. Prefer
- /// [`LockCollection::new`] or [`LockCollection::new_ref`] instead.
- ///
- /// # Examples
- ///
- /// ```
- /// use happylock::{LockCollection, Mutex};
- ///
- /// let data1 = Mutex::new(0);
- /// let data2 = Mutex::new("");
- ///
- /// // data1 and data2 refer to distinct mutexes, so this won't panic
- /// let lock = LockCollection::try_new((&data1, &data2)).unwrap();
- /// ```
- #[must_use]
- pub fn try_new(data: L) -> Option<Self> {
- let mut ptrs = data.get_ptrs();
- if contains_duplicates(&mut ptrs) {
- return None;
- }
-
- Some(Self { data })
- }
-
- /// Locks the collection
- ///
- /// This function returns a guard that can be used to access the underlying
- /// data. When the guard is dropped, the locks in the collection are also
- /// dropped.
- ///
- /// # Examples
- ///
- /// ```
- /// use happylock::{LockCollection, Mutex, ThreadKey};
- ///
- /// let key = ThreadKey::get().unwrap();
- /// let lock = LockCollection::new((Mutex::new(0), Mutex::new("")));
- ///
- /// let mut guard = lock.lock(key);
- /// *guard.0 += 1;
- /// *guard.1 = "1";
- /// ```
- pub fn lock<'key: 'a, Key: Keyable + 'key>(&'a self, key: Key) -> LockGuard<'a, 'key, L, Key> {
- LockGuard {
- // safety: we have the thread's key
- guard: unsafe { self.data.lock() },
- key,
- _phantom: PhantomData,
- }
- }
-
- /// Attempts to lock the without blocking.
- ///
- /// If successful, this method returns a guard that can be used to access
- /// the data, and unlocks the data when it is dropped. Otherwise, `None` is
- /// returned.
- ///
- /// # Examples
- ///
- /// ```
- /// use happylock::{LockCollection, Mutex, ThreadKey};
- ///
- /// let key = ThreadKey::get().unwrap();
- /// let lock = LockCollection::new((Mutex::new(0), Mutex::new("")));
- ///
- /// match lock.try_lock(key) {
- /// Some(mut guard) => {
- /// *guard.0 += 1;
- /// *guard.1 = "1";
- /// },
- /// None => unreachable!(),
- /// };
- ///
- /// ```
- pub fn try_lock<'key: 'a, Key: Keyable + 'key>(
- &'a self,
- key: Key,
- ) -> Option<LockGuard<'a, 'key, L, Key>> {
- // safety: we have the thread's key
- unsafe { self.data.try_lock() }.map(|guard| LockGuard {
- guard,
- key,
- _phantom: PhantomData,
- })
- }
-
- /// Unlocks the underlying lockable data type, returning the key that's
- /// associated with it.
- ///
- /// # Examples
- ///
- /// ```
- /// use happylock::{LockCollection, Mutex, ThreadKey};
- ///
- /// let key = ThreadKey::get().unwrap();
- /// let lock = LockCollection::new((Mutex::new(0), Mutex::new("")));
- ///
- /// let mut guard = lock.lock(key);
- /// *guard.0 += 1;
- /// *guard.1 = "1";
- /// let key = LockCollection::unlock(guard);
- /// ```
- #[allow(clippy::missing_const_for_fn)]
- pub fn unlock<'key: 'a, Key: Keyable + 'key>(guard: LockGuard<'a, 'key, L, Key>) -> Key {
- drop(guard.guard);
- guard.key
- }
-}
-
-impl<'a, L: 'a> LockCollection<L>
-where
- &'a L: IntoIterator,
-{
- /// Returns an iterator over references to each value in the collection.
- pub fn iter(&'a self) -> <&'a L as IntoIterator>::IntoIter {
- self.into_iter()
- }
-}
-
-impl<'a, L: 'a> LockCollection<L>
-where
- &'a mut L: IntoIterator,
-{
- /// Returns an iterator over mutable references to each value in the
- /// collection.
- pub fn iter_mut(&'a mut self) -> <&'a mut L as IntoIterator>::IntoIter {
- self.into_iter()
- }
-}
diff --git a/src/collection/guard.rs b/src/collection/guard.rs
index 110a935..8857c5f 100644
--- a/src/collection/guard.rs
+++ b/src/collection/guard.rs
@@ -1,19 +1,44 @@
+use std::fmt::{Debug, Display};
use std::ops::{Deref, DerefMut};
-use crate::{key::Keyable, Lockable};
+use crate::key::Keyable;
use super::LockGuard;
-impl<'a, 'key: 'a, L: Lockable<'a>, Key: Keyable> Deref for LockGuard<'a, 'key, L, Key> {
- type Target = L::Output;
+impl<'key, Guard: Debug, Key: Keyable> Debug for LockGuard<'key, Guard, Key> {
+ fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
+ Debug::fmt(&**self, f)
+ }
+}
+
+impl<'key, Guard: Display, Key: Keyable> Display for LockGuard<'key, Guard, Key> {
+ fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
+ Display::fmt(&**self, f)
+ }
+}
+
+impl<'key, Guard, Key: Keyable> Deref for LockGuard<'key, Guard, Key> {
+ type Target = Guard;
fn deref(&self) -> &Self::Target {
&self.guard
}
}
-impl<'a, 'key: 'a, L: Lockable<'a>, Key: Keyable> DerefMut for LockGuard<'a, 'key, L, Key> {
+impl<'key, Guard, Key: Keyable> DerefMut for LockGuard<'key, Guard, Key> {
fn deref_mut(&mut self) -> &mut Self::Target {
&mut self.guard
}
}
+
+impl<'key, Guard, Key: Keyable> AsRef<Guard> for LockGuard<'key, Guard, Key> {
+ fn as_ref(&self) -> &Guard {
+ &self.guard
+ }
+}
+
+impl<'key, Guard, Key: Keyable> AsMut<Guard> for LockGuard<'key, Guard, Key> {
+ fn as_mut(&mut self) -> &mut Guard {
+ &mut self.guard
+ }
+}
diff --git a/src/collection/owned.rs b/src/collection/owned.rs
new file mode 100644
index 0000000..919c403
--- /dev/null
+++ b/src/collection/owned.rs
@@ -0,0 +1,347 @@
+use std::marker::PhantomData;
+
+use crate::lockable::{Lockable, OwnedLockable, RawLock, Sharable};
+use crate::Keyable;
+
+use super::{utils, LockGuard, OwnedLockCollection};
+
+fn get_locks<L: Lockable>(data: &L) -> Vec<&dyn RawLock> {
+ let mut locks = Vec::new();
+ data.get_ptrs(&mut locks);
+ locks
+}
+
+unsafe impl<L: Lockable> Lockable for OwnedLockCollection<L> {
+ type Guard<'g> = L::Guard<'g> where Self: 'g;
+
+ type ReadGuard<'g> = L::ReadGuard<'g> where Self: 'g;
+
+ fn get_ptrs<'a>(&'a self, ptrs: &mut Vec<&'a dyn RawLock>) {
+ self.data.get_ptrs(ptrs)
+ }
+
+ unsafe fn guard(&self) -> Self::Guard<'_> {
+ self.data.guard()
+ }
+
+ unsafe fn read_guard(&self) -> Self::ReadGuard<'_> {
+ self.data.read_guard()
+ }
+}
+
+unsafe impl<L: Sharable> Sharable for OwnedLockCollection<L> {}
+
+unsafe impl<L: OwnedLockable> OwnedLockable for OwnedLockCollection<L> {}
+
+impl<L> IntoIterator for OwnedLockCollection<L>
+where
+ L: IntoIterator,
+{
+ type Item = <L as IntoIterator>::Item;
+ type IntoIter = <L as IntoIterator>::IntoIter;
+
+ fn into_iter(self) -> Self::IntoIter {
+ self.data.into_iter()
+ }
+}
+
+impl<L: OwnedLockable, I: FromIterator<L> + OwnedLockable> FromIterator<L>
+ for OwnedLockCollection<I>
+{
+ fn from_iter<T: IntoIterator<Item = L>>(iter: T) -> Self {
+ let iter: I = iter.into_iter().collect();
+ Self::new(iter)
+ }
+}
+
+impl<E: OwnedLockable + Extend<L>, L: OwnedLockable> Extend<L> for OwnedLockCollection<E> {
+ fn extend<T: IntoIterator<Item = L>>(&mut self, iter: T) {
+ self.data.extend(iter)
+ }
+}
+
+impl<L: OwnedLockable> AsMut<L> for OwnedLockCollection<L> {
+ fn as_mut(&mut self) -> &mut L {
+ &mut self.data
+ }
+}
+
+impl<L: OwnedLockable + Default> Default for OwnedLockCollection<L> {
+ fn default() -> Self {
+ Self::new(L::default())
+ }
+}
+
+impl<L: OwnedLockable + Default> From<L> for OwnedLockCollection<L> {
+ fn from(value: L) -> Self {
+ Self::new(value)
+ }
+}
+
+impl<L: OwnedLockable> OwnedLockCollection<L> {
+ /// Creates a new collection of owned locks.
+ ///
+ /// Because the locks are owned, there's no need to do any checks for
+ /// duplicate values. The locks also don't need to be sorted by memory
+ /// address because they aren't used anywhere else.
+ ///
+ /// # Examples
+ ///
+ /// ```
+ /// use happylock::Mutex;
+ /// use happylock::collection::OwnedLockCollection;
+ ///
+ /// let data = (Mutex::new(0), Mutex::new(""));
+ /// let lock = OwnedLockCollection::new(data);
+ /// ```
+ #[must_use]
+ pub const fn new(data: L) -> Self {
+ Self { data }
+ }
+
+ /// Gets the underlying collection, consuming this collection.
+ ///
+ /// # Examples
+ ///
+ /// ```
+ /// use happylock::{Mutex, ThreadKey};
+ /// use happylock::collection::OwnedLockCollection;
+ ///
+ /// let data = (Mutex::new(42), Mutex::new(""));
+ /// let lock = OwnedLockCollection::new(data);
+ ///
+ /// let key = ThreadKey::get().unwrap();
+ /// let inner = lock.into_inner();
+ /// let guard = inner.0.lock(key);
+ /// assert_eq!(*guard, 42);
+ /// ```
+ #[must_use]
+ pub fn into_inner(self) -> L {
+ self.data
+ }
+
+ /// Locks the collection
+ ///
+ /// This function returns a guard that can be used to access the underlying
+ /// data. When the guard is dropped, the locks in the collection are also
+ /// dropped.
+ ///
+ /// # Examples
+ ///
+ /// ```
+ /// use happylock::{Mutex, ThreadKey};
+ /// use happylock::collection::OwnedLockCollection;
+ ///
+ /// let key = ThreadKey::get().unwrap();
+ /// let data = (Mutex::new(0), Mutex::new(""));
+ /// let lock = OwnedLockCollection::new(data);
+ ///
+ /// let mut guard = lock.lock(key);
+ /// *guard.0 += 1;
+ /// *guard.1 = "1";
+ /// ```
+ pub fn lock<'g, 'key, Key: Keyable + 'key>(
+ &'g self,
+ key: Key,
+ ) -> LockGuard<'key, L::Guard<'g>, Key> {
+ let locks = get_locks(&self.data);
+ for lock in locks {
+ // safety: we have the thread key, and these locks happen in a
+ // predetermined order
+ unsafe { lock.lock() };
+ }
+
+ // safety: we've locked all of this already
+ let guard = unsafe { self.data.guard() };
+ LockGuard {
+ guard,
+ key,
+ _phantom: PhantomData,
+ }
+ }
+
+ /// Attempts to lock the without blocking.
+ ///
+ /// If successful, this method returns a guard that can be used to access
+ /// the data, and unlocks the data when it is dropped. Otherwise, `None` is
+ /// returned.
+ ///
+ /// # Examples
+ ///
+ /// ```
+ /// use happylock::{Mutex, ThreadKey};
+ /// use happylock::collection::OwnedLockCollection;
+ ///
+ /// let key = ThreadKey::get().unwrap();
+ /// let data = (Mutex::new(0), Mutex::new(""));
+ /// let lock = OwnedLockCollection::new(data);
+ ///
+ /// match lock.try_lock(key) {
+ /// Some(mut guard) => {
+ /// *guard.0 += 1;
+ /// *guard.1 = "1";
+ /// },
+ /// None => unreachable!(),
+ /// };
+ ///
+ /// ```
+ pub fn try_lock<'g, 'key: 'g, Key: Keyable + 'key>(
+ &'g self,
+ key: Key,
+ ) -> Option<LockGuard<'key, L::Guard<'g>, Key>> {
+ let locks = get_locks(&self.data);
+ let guard = unsafe {
+ if !utils::ordered_try_lock(&locks) {
+ return None;
+ }
+
+ // safety: we've acquired the locks
+ self.data.guard()
+ };
+
+ Some(LockGuard {
+ guard,
+ key,
+ _phantom: PhantomData,
+ })
+ }
+
+ /// Unlocks the underlying lockable data type, returning the key that's
+ /// associated with it.
+ ///
+ /// # Examples
+ ///
+ /// ```
+ /// use happylock::{Mutex, ThreadKey};
+ /// use happylock::collection::OwnedLockCollection;
+ ///
+ /// let key = ThreadKey::get().unwrap();
+ /// let data = (Mutex::new(0), Mutex::new(""));
+ /// let lock = OwnedLockCollection::new(data);
+ ///
+ /// let mut guard = lock.lock(key);
+ /// *guard.0 += 1;
+ /// *guard.1 = "1";
+ /// let key = OwnedLockCollection::<(Mutex<i32>, Mutex<&str>)>::unlock(guard);
+ /// ```
+ #[allow(clippy::missing_const_for_fn)]
+ pub fn unlock<'g, 'key: 'g, Key: Keyable + 'key>(
+ guard: LockGuard<'key, L::Guard<'g>, Key>,
+ ) -> Key {
+ drop(guard.guard);
+ guard.key
+ }
+}
+
+impl<L: Sharable> OwnedLockCollection<L> {
+ /// Locks the collection, so that other threads can still read from it
+ ///
+ /// This function returns a guard that can be used to access the underlying
+ /// data immutably. When the guard is dropped, the locks in the collection
+ /// are also dropped.
+ ///
+ /// # Examples
+ ///
+ /// ```
+ /// use happylock::{RwLock, ThreadKey};
+ /// use happylock::collection::OwnedLockCollection;
+ ///
+ /// let key = ThreadKey::get().unwrap();
+ /// let data = (RwLock::new(0), RwLock::new(""));
+ /// let lock = OwnedLockCollection::new(data);
+ ///
+ /// let mut guard = lock.read(key);
+ /// assert_eq!(*guard.0, 0);
+ /// assert_eq!(*guard.1, "");
+ /// ```
+ pub fn read<'g, 'key, Key: Keyable + 'key>(
+ &'g self,
+ key: Key,
+ ) -> LockGuard<'key, L::ReadGuard<'g>, Key> {
+ let locks = get_locks(&self.data);
+ for lock in locks {
+ // safety: we have the thread key, and these locks happen in a
+ // predetermined order
+ unsafe { lock.read() };
+ }
+
+ // safety: we've locked all of this already
+ let guard = unsafe { self.data.read_guard() };
+ LockGuard {
+ guard,
+ key,
+ _phantom: PhantomData,
+ }
+ }
+
+ /// Attempts to lock the without blocking, in such a way that other threads
+ /// can still read from the collection.
+ ///
+ /// If successful, this method returns a guard that can be used to access
+ /// the data immutably, and unlocks the data when it is dropped. Otherwise,
+ /// `None` is returned.
+ ///
+ /// # Examples
+ ///
+ /// ```
+ /// use happylock::{RwLock, ThreadKey};
+ /// use happylock::collection::OwnedLockCollection;
+ ///
+ /// let key = ThreadKey::get().unwrap();
+ /// let data = (RwLock::new(5), RwLock::new("6"));
+ /// let lock = OwnedLockCollection::new(data);
+ ///
+ /// match lock.try_read(key) {
+ /// Some(mut guard) => {
+ /// assert_eq!(*guard.0, 5);
+ /// assert_eq!(*guard.1, "6");
+ /// },
+ /// None => unreachable!(),
+ /// };
+ ///
+ /// ```
+ pub fn try_read<'g, 'key: 'g, Key: Keyable + 'key>(
+ &'g self,
+ key: Key,
+ ) -> Option<LockGuard<'key, L::ReadGuard<'g>, Key>> {
+ let locks = get_locks(&self.data);
+ let guard = unsafe {
+ if !utils::ordered_try_read(&locks) {
+ return None;
+ }
+
+ // safety: we've acquired the locks
+ self.data.read_guard()
+ };
+
+ Some(LockGuard {
+ guard,
+ key,
+ _phantom: PhantomData,
+ })
+ }
+
+ /// Unlocks the underlying lockable data type, returning the key that's
+ /// associated with it.
+ ///
+ /// # Examples
+ ///
+ /// ```
+ /// use happylock::{RwLock, ThreadKey};
+ /// use happylock::collection::OwnedLockCollection;
+ ///
+ /// let key = ThreadKey::get().unwrap();
+ /// let data = (RwLock::new(0), RwLock::new(""));
+ /// let lock = OwnedLockCollection::new(data);
+ ///
+ /// let mut guard = lock.read(key);
+ /// let key = OwnedLockCollection::<(RwLock<i32>, RwLock<&str>)>::unlock_read(guard);
+ /// ```
+ #[allow(clippy::missing_const_for_fn)]
+ pub fn unlock_read<'g, 'key: 'g, Key: Keyable + 'key>(
+ guard: LockGuard<'key, L::ReadGuard<'g>, Key>,
+ ) -> Key {
+ drop(guard.guard);
+ guard.key
+ }
+}
diff --git a/src/collection/ref.rs b/src/collection/ref.rs
new file mode 100644
index 0000000..d8c7f2e
--- /dev/null
+++ b/src/collection/ref.rs
@@ -0,0 +1,399 @@
+use std::fmt::Debug;
+use std::marker::PhantomData;
+
+use crate::lockable::{Lockable, OwnedLockable, RawLock, Sharable};
+use crate::Keyable;
+
+use super::{utils, LockGuard, RefLockCollection};
+
+#[must_use]
+pub fn get_locks<L: Lockable>(data: &L) -> Vec<&dyn RawLock> {
+ let mut locks = Vec::new();
+ data.get_ptrs(&mut locks);
+ locks.sort_by_key(|lock| std::ptr::from_ref(*lock));
+ locks
+}
+
+/// returns `true` if the sorted list contains a duplicate
+#[must_use]
+fn contains_duplicates(l: &[&dyn RawLock]) -> bool {
+ l.windows(2)
+ .any(|window| std::ptr::eq(window[0], window[1]))
+}
+
+impl<'a, L> AsRef<L> for RefLockCollection<'a, L> {
+ fn as_ref(&self) -> &L {
+ self.data
+ }
+}
+
+impl<'a, L> IntoIterator for &'a RefLockCollection<'a, L>
+where
+ &'a L: IntoIterator,
+{
+ type Item = <&'a L as IntoIterator>::Item;
+ type IntoIter = <&'a L as IntoIterator>::IntoIter;
+
+ fn into_iter(self) -> Self::IntoIter {
+ self.data.into_iter()
+ }
+}
+
+unsafe impl<'c, L: Lockable> Lockable for RefLockCollection<'c, L> {
+ type Guard<'g> = L::Guard<'g> where Self: 'g;
+
+ type ReadGuard<'g> = L::ReadGuard<'g> where Self: 'g;
+
+ fn get_ptrs<'a>(&'a self, ptrs: &mut Vec<&'a dyn RawLock>) {
+ ptrs.extend_from_slice(&self.locks);
+ }
+
+ unsafe fn guard(&self) -> Self::Guard<'_> {
+ self.data.guard()
+ }
+
+ unsafe fn read_guard(&self) -> Self::ReadGuard<'_> {
+ self.data.read_guard()
+ }
+}
+
+unsafe impl<'c, L: Sharable> Sharable for RefLockCollection<'c, L> {}
+
+impl<'a, L: Debug> Debug for RefLockCollection<'a, L> {
+ fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
+ f.debug_struct(stringify!(RefLockCollection))
+ .field("data", self.data)
+ .finish_non_exhaustive()
+ }
+}
+
+impl<'a, L: OwnedLockable + Default> From<&'a L> for RefLockCollection<'a, L> {
+ fn from(value: &'a L) -> Self {
+ Self::new(value)
+ }
+}
+
+impl<'a, L: OwnedLockable> RefLockCollection<'a, L> {
+ /// Creates a new collection of owned locks.
+ ///
+ /// Because the locks are owned, there's no need to do any checks for
+ /// duplicate values.
+ ///
+ /// # Examples
+ ///
+ /// ```
+ /// use happylock::Mutex;
+ /// use happylock::collection::RefLockCollection;
+ ///
+ /// let data = (Mutex::new(0), Mutex::new(""));
+ /// let lock = RefLockCollection::new(&data);
+ /// ```
+ #[must_use]
+ pub fn new(data: &'a L) -> RefLockCollection<L> {
+ RefLockCollection {
+ locks: get_locks(data),
+ data,
+ }
+ }
+}
+
+impl<'a, L: Lockable> RefLockCollection<'a, L> {
+ /// Creates a new collections of locks.
+ ///
+ /// # Safety
+ ///
+ /// This results in undefined behavior if any locks are presented twice
+ /// within this collection.
+ ///
+ /// # Examples
+ ///
+ /// ```
+ /// use happylock::Mutex;
+ /// use happylock::collection::RefLockCollection;
+ ///
+ /// let data1 = Mutex::new(0);
+ /// let data2 = Mutex::new("");
+ ///
+ /// // safety: data1 and data2 refer to distinct mutexes
+ /// let data = (&data1, &data2);
+ /// let lock = unsafe { RefLockCollection::new_unchecked(&data) };
+ /// ```
+ #[must_use]
+ pub unsafe fn new_unchecked(data: &'a L) -> Self {
+ Self {
+ data,
+ locks: get_locks(data),
+ }
+ }
+
+ /// Creates a new collection of locks.
+ ///
+ /// This returns `None` if any locks are found twice in the given
+ /// collection.
+ ///
+ /// # Examples
+ ///
+ /// ```
+ /// use happylock::Mutex;
+ /// use happylock::collection::RefLockCollection;
+ ///
+ /// let data1 = Mutex::new(0);
+ /// let data2 = Mutex::new("");
+ ///
+ /// // data1 and data2 refer to distinct mutexes, so this won't panic
+ /// let data = (&data1, &data2);
+ /// let lock = RefLockCollection::try_new(&data).unwrap();
+ /// ```
+ #[must_use]
+ pub fn try_new(data: &'a L) -> Option<Self> {
+ let locks = get_locks(data);
+ if contains_duplicates(&locks) {
+ return None;
+ }
+
+ Some(Self { data, locks })
+ }
+
+ /// Locks the collection
+ ///
+ /// This function returns a guard that can be used to access the underlying
+ /// data. When the guard is dropped, the locks in the collection are also
+ /// dropped.
+ ///
+ /// # Examples
+ ///
+ /// ```
+ /// use happylock::{Mutex, ThreadKey};
+ /// use happylock::collection::RefLockCollection;
+ ///
+ /// let key = ThreadKey::get().unwrap();
+ /// let data = (Mutex::new(0), Mutex::new(""));
+ /// let lock = RefLockCollection::new(&data);
+ ///
+ /// let mut guard = lock.lock(key);
+ /// *guard.0 += 1;
+ /// *guard.1 = "1";
+ /// ```
+ pub fn lock<'key: 'a, Key: Keyable + 'key>(
+ &'a self,
+ key: Key,
+ ) -> LockGuard<'key, L::Guard<'a>, Key> {
+ for lock in &self.locks {
+ // safety: we have the thread key
+ unsafe { lock.lock() };
+ }
+
+ LockGuard {
+ // safety: we've already acquired the lock
+ guard: unsafe { self.data.guard() },
+ key,
+ _phantom: PhantomData,
+ }
+ }
+
+ /// Attempts to lock the without blocking.
+ ///
+ /// If successful, this method returns a guard that can be used to access
+ /// the data, and unlocks the data when it is dropped. Otherwise, `None` is
+ /// returned.
+ ///
+ /// # Examples
+ ///
+ /// ```
+ /// use happylock::{Mutex, ThreadKey};
+ /// use happylock::collection::RefLockCollection;
+ ///
+ /// let key = ThreadKey::get().unwrap();
+ /// let data = (Mutex::new(0), Mutex::new(""));
+ /// let lock = RefLockCollection::new(&data);
+ ///
+ /// match lock.try_lock(key) {
+ /// Some(mut guard) => {
+ /// *guard.0 += 1;
+ /// *guard.1 = "1";
+ /// },
+ /// None => unreachable!(),
+ /// };
+ ///
+ /// ```
+ pub fn try_lock<'key: 'a, Key: Keyable + 'key>(
+ &'a self,
+ key: Key,
+ ) -> Option<LockGuard<'key, L::Guard<'a>, Key>> {
+ let guard = unsafe {
+ if !utils::ordered_try_lock(&self.locks) {
+ return None;
+ }
+
+ // safety: we've acquired the locks
+ self.data.guard()
+ };
+
+ Some(LockGuard {
+ guard,
+ key,
+ _phantom: PhantomData,
+ })
+ }
+
+ /// Unlocks the underlying lockable data type, returning the key that's
+ /// associated with it.
+ ///
+ /// # Examples
+ ///
+ /// ```
+ /// use happylock::{Mutex, ThreadKey};
+ /// use happylock::collection::RefLockCollection;
+ ///
+ /// let key = ThreadKey::get().unwrap();
+ /// let data = (Mutex::new(0), Mutex::new(""));
+ /// let lock = RefLockCollection::new(&data);
+ ///
+ /// let mut guard = lock.lock(key);
+ /// *guard.0 += 1;
+ /// *guard.1 = "1";
+ /// let key = RefLockCollection::<(Mutex<i32>, Mutex<&str>)>::unlock(guard);
+ /// ```
+ #[allow(clippy::missing_const_for_fn)]
+ pub fn unlock<'key: 'a, Key: Keyable + 'key>(guard: LockGuard<'key, L::Guard<'a>, Key>) -> Key {
+ drop(guard.guard);
+ guard.key
+ }
+}
+
+impl<'a, L: Sharable> RefLockCollection<'a, L> {
+ /// Locks the collection, so that other threads can still read from it
+ ///
+ /// This function returns a guard that can be used to access the underlying
+ /// data immutably. When the guard is dropped, the locks in the collection
+ /// are also dropped.
+ ///
+ /// # Examples
+ ///
+ /// ```
+ /// use happylock::{RwLock, ThreadKey};
+ /// use happylock::collection::RefLockCollection;
+ ///
+ /// let key = ThreadKey::get().unwrap();
+ /// let data = (RwLock::new(0), RwLock::new(""));
+ /// let lock = RefLockCollection::new(&data);
+ ///
+ /// let mut guard = lock.read(key);
+ /// assert_eq!(*guard.0, 0);
+ /// assert_eq!(*guard.1, "");
+ /// ```
+ pub fn read<'key: 'a, Key: Keyable + 'key>(
+ &'a self,
+ key: Key,
+ ) -> LockGuard<'key, L::ReadGuard<'a>, Key> {
+ for lock in &self.locks {
+ // safety: we have the thread key
+ unsafe { lock.read() };
+ }
+
+ LockGuard {
+ // safety: we've already acquired the lock
+ guard: unsafe { self.data.read_guard() },
+ key,
+ _phantom: PhantomData,
+ }
+ }
+
+ /// Attempts to lock the without blocking, in such a way that other threads
+ /// can still read from the collection.
+ ///
+ /// If successful, this method returns a guard that can be used to access
+ /// the data immutably, and unlocks the data when it is dropped. Otherwise,
+ /// `None` is returned.
+ ///
+ /// # Examples
+ ///
+ /// ```
+ /// use happylock::{RwLock, ThreadKey};
+ /// use happylock::collection::RefLockCollection;
+ ///
+ /// let key = ThreadKey::get().unwrap();
+ /// let data = (RwLock::new(5), RwLock::new("6"));
+ /// let lock = RefLockCollection::new(&data);
+ ///
+ /// match lock.try_read(key) {
+ /// Some(mut guard) => {
+ /// assert_eq!(*guard.0, 5);
+ /// assert_eq!(*guard.1, "6");
+ /// },
+ /// None => unreachable!(),
+ /// };
+ ///
+ /// ```
+ pub fn try_read<'key: 'a, Key: Keyable + 'key>(
+ &'a self,
+ key: Key,
+ ) -> Option<LockGuard<'key, L::ReadGuard<'a>, Key>> {
+ let guard = unsafe {
+ if !utils::ordered_try_read(&self.locks) {
+ return None;
+ }
+
+ // safety: we've acquired the locks
+ self.data.read_guard()
+ };
+
+ Some(LockGuard {
+ guard,
+ key,
+ _phantom: PhantomData,
+ })
+ }
+
+ /// Unlocks the underlying lockable data type, returning the key that's
+ /// associated with it.
+ ///
+ /// # Examples
+ ///
+ /// ```
+ /// use happylock::{RwLock, ThreadKey};
+ /// use happylock::collection::RefLockCollection;
+ ///
+ /// let key = ThreadKey::get().unwrap();
+ /// let data = (RwLock::new(0), RwLock::new(""));
+ /// let lock = RefLockCollection::new(&data);
+ ///
+ /// let mut guard = lock.read(key);
+ /// let key = RefLockCollection::<(RwLock<i32>, RwLock<&str>)>::unlock_read(guard);
+ /// ```
+ #[allow(clippy::missing_const_for_fn)]
+ pub fn unlock_read<'key: 'a, Key: Keyable + 'key>(
+ guard: LockGuard<'key, L::ReadGuard<'a>, Key>,
+ ) -> Key {
+ drop(guard.guard);
+ guard.key
+ }
+}
+
+impl<'a, L: 'a> RefLockCollection<'a, L>
+where
+ &'a L: IntoIterator,
+{
+ /// Returns an iterator over references to each value in the collection.
+ ///
+ /// # Examples
+ ///
+ /// ```
+ /// use happylock::{Mutex, ThreadKey};
+ /// use happylock::collection::RefLockCollection;
+ ///
+ /// let key = ThreadKey::get().unwrap();
+ /// let data = [Mutex::new(26), Mutex::new(1)];
+ /// let lock = RefLockCollection::new(&data);
+ ///
+ /// let mut iter = lock.iter();
+ /// let mutex = iter.next().unwrap();
+ /// let guard = mutex.lock(key);
+ ///
+ /// assert_eq!(*guard, 26);
+ /// ```
+ #[must_use]
+ pub fn iter(&'a self) -> <&'a L as IntoIterator>::IntoIter {
+ self.into_iter()
+ }
+}
diff --git a/src/collection/retry.rs b/src/collection/retry.rs
new file mode 100644
index 0000000..2b9b0a0
--- /dev/null
+++ b/src/collection/retry.rs
@@ -0,0 +1,619 @@
+use crate::lockable::{Lockable, OwnedLockable, RawLock, Sharable};
+use crate::Keyable;
+
+use std::collections::HashSet;
+use std::marker::PhantomData;
+
+use super::{LockGuard, RetryingLockCollection};
+
+/// Checks that a collection contains no duplicate references to a lock.
+fn contains_duplicates<L: Lockable>(data: L) -> bool {
+ let mut locks = Vec::new();
+ data.get_ptrs(&mut locks);
+ let locks = locks.into_iter().map(|l| l as *const dyn RawLock);
+
+ let mut locks_set = HashSet::with_capacity(locks.len());
+ for lock in locks {
+ if !locks_set.insert(lock) {
+ return true;
+ }
+ }
+
+ false
+}
+
+unsafe impl<L: Lockable> Lockable for RetryingLockCollection<L> {
+ type Guard<'g> = L::Guard<'g> where Self: 'g;
+
+ type ReadGuard<'g> = L::ReadGuard<'g> where Self: 'g;
+
+ fn get_ptrs<'a>(&'a self, ptrs: &mut Vec<&'a dyn RawLock>) {
+ self.data.get_ptrs(ptrs)
+ }
+
+ unsafe fn guard(&self) -> Self::Guard<'_> {
+ self.data.guard()
+ }
+
+ unsafe fn read_guard(&self) -> Self::ReadGuard<'_> {
+ self.data.read_guard()
+ }
+}
+
+unsafe impl<L: Sharable> Sharable for RetryingLockCollection<L> {}
+
+unsafe impl<L: OwnedLockable> OwnedLockable for RetryingLockCollection<L> {}
+
+impl<L> IntoIterator for RetryingLockCollection<L>
+where
+ L: IntoIterator,
+{
+ type Item = <L as IntoIterator>::Item;
+ type IntoIter = <L as IntoIterator>::IntoIter;
+
+ fn into_iter(self) -> Self::IntoIter {
+ self.data.into_iter()
+ }
+}
+
+impl<'a, L> IntoIterator for &'a RetryingLockCollection<L>
+where
+ &'a L: IntoIterator,
+{
+ type Item = <&'a L as IntoIterator>::Item;
+ type IntoIter = <&'a L as IntoIterator>::IntoIter;
+
+ fn into_iter(self) -> Self::IntoIter {
+ self.data.into_iter()
+ }
+}
+
+impl<'a, L> IntoIterator for &'a mut RetryingLockCollection<L>
+where
+ &'a mut L: IntoIterator,
+{
+ type Item = <&'a mut L as IntoIterator>::Item;
+ type IntoIter = <&'a mut L as IntoIterator>::IntoIter;
+
+ fn into_iter(self) -> Self::IntoIter {
+ self.data.into_iter()
+ }
+}
+
+impl<L: OwnedLockable, I: FromIterator<L> + OwnedLockable> FromIterator<L>
+ for RetryingLockCollection<I>
+{
+ fn from_iter<T: IntoIterator<Item = L>>(iter: T) -> Self {
+ let iter: I = iter.into_iter().collect();
+ Self::new(iter)
+ }
+}
+
+impl<E: OwnedLockable + Extend<L>, L: OwnedLockable> Extend<L> for RetryingLockCollection<E> {
+ fn extend<T: IntoIterator<Item = L>>(&mut self, iter: T) {
+ self.data.extend(iter)
+ }
+}
+
+impl<L> AsRef<L> for RetryingLockCollection<L> {
+ fn as_ref(&self) -> &L {
+ &self.data
+ }
+}
+
+impl<L> AsMut<L> for RetryingLockCollection<L> {
+ fn as_mut(&mut self) -> &mut L {
+ &mut self.data
+ }
+}
+
+impl<L: OwnedLockable + Default> Default for RetryingLockCollection<L> {
+ fn default() -> Self {
+ Self::new(L::default())
+ }
+}
+
+impl<L: OwnedLockable> From<L> for RetryingLockCollection<L> {
+ fn from(value: L) -> Self {
+ Self::new(value)
+ }
+}
+
+impl<L: OwnedLockable> RetryingLockCollection<L> {
+ /// Creates a new collection of owned locks.
+ ///
+ /// Because the locks are owned, there's no need to do any checks for
+ /// duplicate values. The locks also don't need to be sorted by memory
+ /// address because they aren't used anywhere else.
+ ///
+ /// # Examples
+ ///
+ /// ```
+ /// use happylock::Mutex;
+ /// use happylock::collection::RetryingLockCollection;
+ ///
+ /// let data = (Mutex::new(0), Mutex::new(""));
+ /// let lock = RetryingLockCollection::new(data);
+ /// ```
+ #[must_use]
+ pub const fn new(data: L) -> Self {
+ Self { data }
+ }
+}
+
+impl<'a, L: OwnedLockable> RetryingLockCollection<&'a L> {
+ /// Creates a new collection of owned locks.
+ ///
+ /// Because the locks are owned, there's no need to do any checks for
+ /// duplicate values.
+ ///
+ /// # Examples
+ ///
+ /// ```
+ /// use happylock::Mutex;
+ /// use happylock::collection::RetryingLockCollection;
+ ///
+ /// let data = (Mutex::new(0), Mutex::new(""));
+ /// let lock = RetryingLockCollection::new_ref(&data);
+ /// ```
+ #[must_use]
+ pub const fn new_ref(data: &'a L) -> Self {
+ Self { data }
+ }
+}
+
+impl<L: Lockable> RetryingLockCollection<L> {
+ /// Creates a new collections of locks.
+ ///
+ /// # Safety
+ ///
+ /// This results in undefined behavior if any locks are presented twice
+ /// within this collection.
+ ///
+ /// # Examples
+ ///
+ /// ```
+ /// use happylock::Mutex;
+ /// use happylock::collection::RetryingLockCollection;
+ ///
+ /// let data1 = Mutex::new(0);
+ /// let data2 = Mutex::new("");
+ ///
+ /// // safety: data1 and data2 refer to distinct mutexes
+ /// let data = (&data1, &data2);
+ /// let lock = unsafe { RetryingLockCollection::new_unchecked(&data) };
+ /// ```
+ #[must_use]
+ pub const unsafe fn new_unchecked(data: L) -> Self {
+ Self { data }
+ }
+
+ /// Creates a new collection of locks.
+ ///
+ /// This returns `None` if any locks are found twice in the given
+ /// collection.
+ ///
+ /// # Examples
+ ///
+ /// ```
+ /// use happylock::Mutex;
+ /// use happylock::collection::RetryingLockCollection;
+ ///
+ /// let data1 = Mutex::new(0);
+ /// let data2 = Mutex::new("");
+ ///
+ /// // data1 and data2 refer to distinct mutexes, so this won't panic
+ /// let data = (&data1, &data2);
+ /// let lock = RetryingLockCollection::try_new(&data).unwrap();
+ /// ```
+ #[must_use]
+ pub fn try_new(data: L) -> Option<Self> {
+ (!contains_duplicates(&data)).then_some(Self { data })
+ }
+
+ /// Gets the underlying collection, consuming this collection.
+ ///
+ /// # Examples
+ ///
+ /// ```
+ /// use happylock::{Mutex, ThreadKey};
+ /// use happylock::collection::RetryingLockCollection;
+ ///
+ /// let data = (Mutex::new(42), Mutex::new(""));
+ /// let lock = RetryingLockCollection::new(data);
+ ///
+ /// let key = ThreadKey::get().unwrap();
+ /// let inner = lock.into_inner();
+ /// let guard = inner.0.lock(key);
+ /// assert_eq!(*guard, 42);
+ /// ```
+ #[must_use]
+ pub fn into_inner(self) -> L {
+ self.data
+ }
+
+ /// Locks the collection
+ ///
+ /// This function returns a guard that can be used to access the underlying
+ /// data. When the guard is dropped, the locks in the collection are also
+ /// dropped.
+ ///
+ /// # Examples
+ ///
+ /// ```
+ /// use happylock::{Mutex, ThreadKey};
+ /// use happylock::collection::RetryingLockCollection;
+ ///
+ /// let key = ThreadKey::get().unwrap();
+ /// let data = (Mutex::new(0), Mutex::new(""));
+ /// let lock = RetryingLockCollection::new(data);
+ ///
+ /// let mut guard = lock.lock(key);
+ /// *guard.0 += 1;
+ /// *guard.1 = "1";
+ /// ```
+ pub fn lock<'g, 'key: 'g, Key: Keyable + 'key>(
+ &'g self,
+ key: Key,
+ ) -> LockGuard<'key, L::Guard<'g>, Key> {
+ let mut first_index = 0;
+ let mut locks = Vec::new();
+ self.data.get_ptrs(&mut locks);
+
+ if locks.is_empty() {
+ return LockGuard {
+ // safety: there's no data being returned
+ guard: unsafe { self.data.guard() },
+ key,
+ _phantom: PhantomData,
+ };
+ }
+
+ let guard = unsafe {
+ 'outer: loop {
+ // safety: we have the thread key
+ locks[first_index].lock();
+ for (i, lock) in locks.iter().enumerate() {
+ if i == first_index {
+ continue;
+ }
+
+ // safety: we have the thread key
+ if !lock.try_lock() {
+ for lock in locks.iter().take(i) {
+ // safety: we already locked all of these
+ lock.unlock();
+ }
+
+ if first_index >= i {
+ // safety: this is already locked and can't be unlocked
+ // by the previous loop
+ locks[first_index].unlock();
+ }
+
+ first_index = i;
+ continue 'outer;
+ }
+ }
+
+ // safety: we locked all the data
+ break self.data.guard();
+ }
+ };
+
+ LockGuard {
+ guard,
+ key,
+ _phantom: PhantomData,
+ }
+ }
+
+ /// Attempts to lock the without blocking.
+ ///
+ /// If successful, this method returns a guard that can be used to access
+ /// the data, and unlocks the data when it is dropped. Otherwise, `None` is
+ /// returned.
+ ///
+ /// # Examples
+ ///
+ /// ```
+ /// use happylock::{Mutex, ThreadKey};
+ /// use happylock::collection::RetryingLockCollection;
+ ///
+ /// let key = ThreadKey::get().unwrap();
+ /// let data = (Mutex::new(0), Mutex::new(""));
+ /// let lock = RetryingLockCollection::new(data);
+ ///
+ /// match lock.try_lock(key) {
+ /// Some(mut guard) => {
+ /// *guard.0 += 1;
+ /// *guard.1 = "1";
+ /// },
+ /// None => unreachable!(),
+ /// };
+ ///
+ /// ```
+ pub fn try_lock<'g, 'key: 'g, Key: Keyable + 'key>(
+ &'g self,
+ key: Key,
+ ) -> Option<LockGuard<'key, L::Guard<'g>, Key>> {
+ let mut locks = Vec::new();
+ self.data.get_ptrs(&mut locks);
+
+ if locks.is_empty() {
+ return Some(LockGuard {
+ // safety: there's no data being returned
+ guard: unsafe { self.data.guard() },
+ key,
+ _phantom: PhantomData,
+ });
+ }
+
+ let guard = unsafe {
+ for (i, lock) in locks.iter().enumerate() {
+ // safety: we have the thread key
+ if !lock.try_lock() {
+ for lock in locks.iter().take(i) {
+ // safety: we already locked all of these
+ lock.unlock();
+ }
+ return None;
+ }
+ }
+
+ // safety: we locked all the data
+ self.data.guard()
+ };
+
+ Some(LockGuard {
+ guard,
+ key,
+ _phantom: PhantomData,
+ })
+ }
+
+ /// Unlocks the underlying lockable data type, returning the key that's
+ /// associated with it.
+ ///
+ /// # Examples
+ ///
+ /// ```
+ /// use happylock::{Mutex, ThreadKey};
+ /// use happylock::collection::RetryingLockCollection;
+ ///
+ /// let key = ThreadKey::get().unwrap();
+ /// let data = (Mutex::new(0), Mutex::new(""));
+ /// let lock = RetryingLockCollection::new(data);
+ ///
+ /// let mut guard = lock.lock(key);
+ /// *guard.0 += 1;
+ /// *guard.1 = "1";
+ /// let key = RetryingLockCollection::<(Mutex<i32>, Mutex<&str>)>::unlock(guard);
+ /// ```
+ pub fn unlock<'key, Key: Keyable + 'key>(guard: LockGuard<'key, L::Guard<'_>, Key>) -> Key {
+ drop(guard.guard);
+ guard.key
+ }
+}
+
+impl<L: Sharable> RetryingLockCollection<L> {
+ /// Locks the collection, so that other threads can still read from it
+ ///
+ /// This function returns a guard that can be used to access the underlying
+ /// data immutably. When the guard is dropped, the locks in the collection
+ /// are also dropped.
+ ///
+ /// # Examples
+ ///
+ /// ```
+ /// use happylock::{RwLock, ThreadKey};
+ /// use happylock::collection::RetryingLockCollection;
+ ///
+ /// let key = ThreadKey::get().unwrap();
+ /// let data = (RwLock::new(0), RwLock::new(""));
+ /// let lock = RetryingLockCollection::new(data);
+ ///
+ /// let mut guard = lock.read(key);
+ /// assert_eq!(*guard.0, 0);
+ /// assert_eq!(*guard.1, "");
+ /// ```
+ pub fn read<'g, 'key: 'g, Key: Keyable + 'key>(
+ &'g self,
+ key: Key,
+ ) -> LockGuard<'key, L::ReadGuard<'g>, Key> {
+ let mut first_index = 0;
+ let mut locks = Vec::new();
+ self.data.get_ptrs(&mut locks);
+
+ if locks.is_empty() {
+ return LockGuard {
+ // safety: there's no data being returned
+ guard: unsafe { self.data.read_guard() },
+ key,
+ _phantom: PhantomData,
+ };
+ }
+
+ let guard = unsafe {
+ 'outer: loop {
+ // safety: we have the thread key
+ locks[first_index].read();
+ for (i, lock) in locks.iter().enumerate() {
+ if i == first_index {
+ continue;
+ }
+
+ // safety: we have the thread key
+ if !lock.try_read() {
+ for lock in locks.iter().take(i) {
+ // safety: we already locked all of these
+ lock.unlock_read();
+ }
+
+ if first_index >= i {
+ // safety: this is already locked and can't be unlocked
+ // by the previous loop
+ locks[first_index].unlock_read();
+ }
+
+ first_index = i;
+ continue 'outer;
+ }
+ }
+
+ // safety: we locked all the data
+ break self.data.read_guard();
+ }
+ };
+
+ LockGuard {
+ guard,
+ key,
+ _phantom: PhantomData,
+ }
+ }
+
+ /// Attempts to lock the without blocking, in such a way that other threads
+ /// can still read from the collection.
+ ///
+ /// If successful, this method returns a guard that can be used to access
+ /// the data immutably, and unlocks the data when it is dropped. Otherwise,
+ /// `None` is returned.
+ ///
+ /// # Examples
+ ///
+ /// ```
+ /// use happylock::{RwLock, ThreadKey};
+ /// use happylock::collection::RetryingLockCollection;
+ ///
+ /// let key = ThreadKey::get().unwrap();
+ /// let data = (RwLock::new(5), RwLock::new("6"));
+ /// let lock = RetryingLockCollection::new(data);
+ ///
+ /// match lock.try_read(key) {
+ /// Some(mut guard) => {
+ /// assert_eq!(*guard.0, 5);
+ /// assert_eq!(*guard.1, "6");
+ /// },
+ /// None => unreachable!(),
+ /// };
+ ///
+ /// ```
+ pub fn try_read<'g, 'key: 'g, Key: Keyable + 'key>(
+ &'g self,
+ key: Key,
+ ) -> Option<LockGuard<'key, L::ReadGuard<'g>, Key>> {
+ let mut locks = Vec::new();
+ self.data.get_ptrs(&mut locks);
+
+ if locks.is_empty() {
+ return Some(LockGuard {
+ // safety: there's no data being returned
+ guard: unsafe { self.data.read_guard() },
+ key,
+ _phantom: PhantomData,
+ });
+ }
+
+ let guard = unsafe {
+ for (i, lock) in locks.iter().enumerate() {
+ // safety: we have the thread key
+ if !lock.try_read() {
+ for lock in locks.iter().take(i) {
+ // safety: we already locked all of these
+ lock.unlock_read();
+ }
+ return None;
+ }
+ }
+
+ // safety: we locked all the data
+ self.data.read_guard()
+ };
+
+ Some(LockGuard {
+ guard,
+ key,
+ _phantom: PhantomData,
+ })
+ }
+
+ /// Unlocks the underlying lockable data type, returning the key that's
+ /// associated with it.
+ ///
+ /// # Examples
+ ///
+ /// ```
+ /// use happylock::{RwLock, ThreadKey};
+ /// use happylock::collection::RetryingLockCollection;
+ ///
+ /// let key = ThreadKey::get().unwrap();
+ /// let data = (RwLock::new(0), RwLock::new(""));
+ /// let lock = RetryingLockCollection::new(data);
+ ///
+ /// let mut guard = lock.read(key);
+ /// let key = RetryingLockCollection::<(RwLock<i32>, RwLock<&str>)>::unlock_read(guard);
+ /// ```
+ pub fn unlock_read<'key, Key: Keyable + 'key>(
+ guard: LockGuard<'key, L::ReadGuard<'_>, Key>,
+ ) -> Key {
+ drop(guard.guard);
+ guard.key
+ }
+}
+
+impl<'a, L: 'a> RetryingLockCollection<L>
+where
+ &'a L: IntoIterator,
+{
+ /// Returns an iterator over references to each value in the collection.
+ ///
+ /// # Examples
+ ///
+ /// ```
+ /// use happylock::{Mutex, ThreadKey};
+ /// use happylock::collection::RetryingLockCollection;
+ ///
+ /// let key = ThreadKey::get().unwrap();
+ /// let data = [Mutex::new(26), Mutex::new(1)];
+ /// let lock = RetryingLockCollection::new(data);
+ ///
+ /// let mut iter = lock.iter();
+ /// let mutex = iter.next().unwrap();
+ /// let guard = mutex.lock(key);
+ ///
+ /// assert_eq!(*guard, 26);
+ /// ```
+ #[must_use]
+ pub fn iter(&'a self) -> <&'a L as IntoIterator>::IntoIter {
+ self.into_iter()
+ }
+}
+
+impl<'a, L: 'a> RetryingLockCollection<L>
+where
+ &'a mut L: IntoIterator,
+{
+ /// Returns an iterator over mutable references to each value in the
+ /// collection.
+ ///
+ /// # Examples
+ ///
+ /// ```
+ /// use happylock::{Mutex, ThreadKey};
+ /// use happylock::collection::RetryingLockCollection;
+ ///
+ /// let key = ThreadKey::get().unwrap();
+ /// let data = [Mutex::new(26), Mutex::new(1)];
+ /// let mut lock = RetryingLockCollection::new(data);
+ ///
+ /// let mut iter = lock.iter_mut();
+ /// let mutex = iter.next().unwrap();
+ ///
+ /// assert_eq!(*mutex.as_mut(), 26);
+ /// ```
+ #[must_use]
+ pub fn iter_mut(&'a mut self) -> <&'a mut L as IntoIterator>::IntoIter {
+ self.into_iter()
+ }
+}
diff --git a/src/collection/utils.rs b/src/collection/utils.rs
new file mode 100644
index 0000000..dc58399
--- /dev/null
+++ b/src/collection/utils.rs
@@ -0,0 +1,44 @@
+use crate::lockable::RawLock;
+
+/// Locks the locks in the order they are given. This causes deadlock if the
+/// locks contain duplicates, or if this is called by multiple threads with the
+/// locks in different orders.
+pub unsafe fn ordered_try_lock(locks: &[&dyn RawLock]) -> bool {
+ unsafe {
+ for (i, lock) in locks.iter().enumerate() {
+ // safety: we have the thread key
+ let success = lock.try_lock();
+
+ if !success {
+ for lock in &locks[0..i] {
+ // safety: this lock was already acquired
+ lock.unlock();
+ }
+ return false;
+ }
+ }
+
+ true
+ }
+}
+
+/// Locks the locks in the order they are given. This causes deadlock f this is
+/// called by multiple threads with the locks in different orders.
+pub unsafe fn ordered_try_read(locks: &[&dyn RawLock]) -> bool {
+ unsafe {
+ for (i, lock) in locks.iter().enumerate() {
+ // safety: we have the thread key
+ let success = lock.try_read();
+
+ if !success {
+ for lock in &locks[0..i] {
+ // safety: this lock was already acquired
+ lock.unlock_read();
+ }
+ return false;
+ }
+ }
+
+ true
+ }
+}