use crate::lockable::{
Lockable, LockableGetMut, LockableIntoInner, OwnedLockable, RawLock, Sharable,
};
use crate::{Keyable, ThreadKey};
use super::utils::{scoped_read, scoped_try_read, scoped_try_write, scoped_write};
use super::{utils, LockGuard, OwnedLockCollection};
unsafe impl<L: Lockable> RawLock for OwnedLockCollection<L> {
#[mutants::skip] // this should never run
#[cfg(not(tarpaulin_include))]
fn poison(&self) {
let locks = utils::get_locks_unsorted(&self.data);
for lock in locks {
lock.poison();
}
}
unsafe fn raw_write(&self) {
utils::ordered_write(&utils::get_locks_unsorted(&self.data))
}
unsafe fn raw_try_write(&self) -> bool {
let locks = utils::get_locks_unsorted(&self.data);
utils::ordered_try_write(&locks)
}
unsafe fn raw_unlock_write(&self) {
let locks = utils::get_locks_unsorted(&self.data);
for lock in locks {
lock.raw_unlock_write();
}
}
unsafe fn raw_read(&self) {
utils::ordered_read(&utils::get_locks_unsorted(&self.data))
}
unsafe fn raw_try_read(&self) -> bool {
let locks = utils::get_locks_unsorted(&self.data);
utils::ordered_try_read(&locks)
}
unsafe fn raw_unlock_read(&self) {
let locks = utils::get_locks_unsorted(&self.data);
for lock in locks {
lock.raw_unlock_read();
}
}
}
unsafe impl<L: Lockable> Lockable for OwnedLockCollection<L> {
type Guard<'g>
= L::Guard<'g>
where
Self: 'g;
type DataMut<'a>
= L::DataMut<'a>
where
Self: 'a;
#[mutants::skip] // It's hard to test lkocks in an OwnedLockCollection, because they're owned
#[cfg(not(tarpaulin_include))]
fn get_ptrs<'a>(&'a self, ptrs: &mut Vec<&'a dyn RawLock>) {
// It's ok to use self here, because the values in the collection already
// cannot be referenced anywhere else. It's necessary to use self as the lock
// because otherwise we will be handing out shared references to the child
ptrs.push(self)
}
unsafe fn guard(&self) -> Self::Guard<'_> {
self.data.guard()
}
unsafe fn data_mut(&self) -> Self::DataMut<'_> {
self.data.data_mut()
}
}
impl<L: LockableGetMut> LockableGetMut for OwnedLockCollection<L> {
type Inner<'a>
= L::Inner<'a>
where
Self: 'a;
fn get_mut(&mut self) -> Self::Inner<'_> {
self.data.get_mut()
}
}
impl<L: LockableIntoInner> LockableIntoInner for OwnedLockCollection<L> {
type Inner = L::Inner;
fn into_inner(self) -> Self::Inner {
self.data.into_inner()
}
}
unsafe impl<L: Sharable> Sharable for OwnedLockCollection<L> {
type ReadGuard<'g>
= L::ReadGuard<'g>
where
Self: 'g;
type DataRef<'a>
= L::DataRef<'a>
where
Self: 'a;
unsafe fn read_guard(&self) -> Self::ReadGuard<'_> {
self.data.read_guard()
}
unsafe fn data_ref(&self) -> Self::DataRef<'_> {
self.data.data_ref()
}
}
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)
}
}
// AsRef can't be implemented because an impl of AsRef<L> for L could break the
// invariant that there is only one way to lock the collection. AsMut is fine,
// because the collection can't be locked as long as the reference is valid.
impl<T: ?Sized, L: AsMut<T>> AsMut<T> for OwnedLockCollection<L> {
fn as_mut(&mut self) -> &mut T {
self.data.as_mut()
}
}
impl<L: OwnedLockable + Default> Default for OwnedLockCollection<L> {
fn default() -> Self {
Self::new(L::default())
}
}
impl<L: OwnedLockable> 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 }
}
pub fn scoped_lock<'a, R>(
&'a self,
key: impl Keyable,
f: impl FnOnce(L::DataMut<'a>) -> R,
) -> R {
scoped_write(self, key, f)
}
pub fn scoped_try_lock<'a, Key: Keyable, R>(
&'a self,
key: Key,
f: impl FnOnce(L::DataMut<'a>) -> R,
) -> Result<R, Key> {
scoped_try_write(self, key, f)
}
/// 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(&self, key: ThreadKey) -> LockGuard<L::Guard<'_>> {
let guard = unsafe {
// safety: we have the thread key, and these locks happen in a
// predetermined order
self.raw_write();
// safety: we've locked all of this already
self.data.guard()
};
LockGuard { guard, key }
}
/// Attempts to lock the without blocking.
///
/// If the access could not be granted at this time, then `Err` is
/// returned. Otherwise, an RAII guard is returned which will release the
/// locks when it is dropped.
///
/// # Errors
///
/// If any of the locks in this collection are already locked, this returns
/// an error containing the given key.
///
/// # 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) {
/// Ok(mut guard) => {
/// *guard.0 += 1;
/// *guard.1 = "1";
/// },
/// Err(_) => unreachable!(),
/// };
///
/// ```
pub fn try_lock(&self, key: ThreadKey) -> Result<LockGuard<L::Guard<'_>>, ThreadKey> {
let guard = unsafe {
// safety: we've acquired the key
if !self.raw_try_write() {
return Err(key);
}
// safety: we've acquired the locks
self.data.guard()
};
Ok(LockGuard { guard, key })
}
/// 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(guard: LockGuard<L::Guard<'_>>) -> ThreadKey {
drop(guard.guard);
guard.key
}
}
impl<L: Sharable> OwnedLockCollection<L> {
pub fn scoped_read<'a, R>(
&'a self,
key: impl Keyable,
f: impl FnOnce(L::DataRef<'a>) -> R,
) -> R {
scoped_read(self, key, f)
}
pub fn scoped_try_read<'a, Key: Keyable, R>(
&'a self,
key: Key,
f: impl FnOnce(L::DataRef<'a>) -> R,
) -> Result<R, Key> {
scoped_try_read(self, key, f)
}
/// 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(&self, key: ThreadKey) -> LockGuard<L::ReadGuard<'_>> {
unsafe {
// safety: we have the thread key
self.raw_read();
LockGuard {
// safety: we've already acquired the lock
guard: self.data.read_guard(),
key,
}
}
}
/// Attempts to lock the without blocking, in such a way that other threads
/// can still read from the collection.
///
/// If the access could not be granted at this time, then `Err` is
/// returned. Otherwise, an RAII guard is returned which will release the
/// shared access when it is dropped.
///
/// # Errors
///
/// If any of the locks in this collection can't be acquired, then an error
/// is returned containing the given key.
///
/// # 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) {
/// Ok(mut guard) => {
/// assert_eq!(*guard.0, 5);
/// assert_eq!(*guard.1, "6");
/// },
/// Err(_) => unreachable!(),
/// };
///
/// ```
pub fn try_read(&self, key: ThreadKey) -> Result<LockGuard<L::ReadGuard<'_>>, ThreadKey> {
let guard = unsafe {
// safety: we have the thread key
if !self.raw_try_read() {
return Err(key);
}
// safety: we've acquired the locks
self.data.read_guard()
};
Ok(LockGuard { guard, key })
}
/// 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(guard: LockGuard<L::ReadGuard<'_>>) -> ThreadKey {
drop(guard.guard);
guard.key
}
}
impl<L> OwnedLockCollection<L> {
/// 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_child();
/// let guard = inner.0.lock(key);
/// assert_eq!(*guard, 42);
/// ```
#[must_use]
pub fn into_child(self) -> L {
self.data
}
/// Gets a mutable reference to the underlying collection.
///
/// # Examples
///
/// ```
/// use happylock::{Mutex, ThreadKey};
/// use happylock::collection::OwnedLockCollection;
///
/// let data = (Mutex::new(42), Mutex::new(""));
/// let mut lock = OwnedLockCollection::new(data);
///
/// let key = ThreadKey::get().unwrap();
/// let mut inner = lock.child_mut();
/// let guard = inner.0.get_mut();
/// assert_eq!(*guard, 42);
/// ```
#[must_use]
pub fn child_mut(&mut self) -> &mut L {
&mut self.data
}
}
impl<L: LockableGetMut> OwnedLockCollection<L> {
/// Gets a mutable reference to the data behind this `OwnedLockCollection`.
///
/// Since this call borrows the `OwnedLockCollection` mutably, no actual
/// locking needs to take place - the mutable borrow statically guarantees
/// no locks exist.
///
/// # Examples
///
/// ```
/// use happylock::{Mutex, LockCollection};
/// use happylock::collection::OwnedLockCollection;
///
/// let mut mutex = OwnedLockCollection::new([Mutex::new(0), Mutex::new(0)]);
/// assert_eq!(mutex.get_mut(), [&mut 0, &mut 0]);
/// ```
pub fn get_mut(&mut self) -> L::Inner<'_> {
LockableGetMut::get_mut(self)
}
}
impl<L: LockableIntoInner> OwnedLockCollection<L> {
/// Consumes this `OwnedLockCollection`, returning the underlying data.
///
/// # Examples
///
/// ```
/// use happylock::{Mutex, LockCollection};
/// use happylock::collection::OwnedLockCollection;
///
/// let mutex = OwnedLockCollection::new([Mutex::new(0), Mutex::new(0)]);
/// assert_eq!(mutex.into_inner(), [0, 0]);
/// ```
#[must_use]
pub fn into_inner(self) -> L::Inner {
LockableIntoInner::into_inner(self)
}
}
#[cfg(test)]
mod tests {
use super::*;
use crate::{LockCollection, Mutex, RwLock, ThreadKey};
#[test]
fn get_mut_applies_changes() {
let key = ThreadKey::get().unwrap();
let mut collection = OwnedLockCollection::new([Mutex::new("foo"), Mutex::new("bar")]);
assert_eq!(*collection.get_mut()[0], "foo");
assert_eq!(*collection.get_mut()[1], "bar");
*collection.get_mut()[0] = "baz";
let guard = collection.lock(key);
assert_eq!(*guard[0], "baz");
assert_eq!(*guard[1], "bar");
}
#[test]
fn into_inner_works() {
let key = ThreadKey::get().unwrap();
let collection = OwnedLockCollection::from([Mutex::new("foo")]);
let mut guard = collection.lock(key);
*guard[0] = "bar";
drop(guard);
let array = collection.into_inner();
assert_eq!(array.len(), 1);
assert_eq!(array[0], "bar");
}
#[test]
fn from_into_iter_is_correct() {
let array = [Mutex::new(0), Mutex::new(1), Mutex::new(2), Mutex::new(3)];
let mut collection: OwnedLockCollection<Vec<Mutex<usize>>> = array.into_iter().collect();
assert_eq!(collection.get_mut().len(), 4);
for (i, lock) in collection.into_iter().enumerate() {
assert_eq!(lock.into_inner(), i);
}
}
#[test]
fn from_iter_is_correct() {
let array = [Mutex::new(0), Mutex::new(1), Mutex::new(2), Mutex::new(3)];
let mut collection: OwnedLockCollection<Vec<Mutex<usize>>> = array.into_iter().collect();
let collection: &mut Vec<_> = collection.as_mut();
assert_eq!(collection.len(), 4);
for (i, lock) in collection.iter_mut().enumerate() {
assert_eq!(*lock.get_mut(), i);
}
}
#[test]
fn scoped_read_works() {
let mut key = ThreadKey::get().unwrap();
let collection = OwnedLockCollection::new([RwLock::new(24), RwLock::new(42)]);
let sum = collection.scoped_read(&mut key, |guard| guard[0] + guard[1]);
assert_eq!(sum, 24 + 42);
}
#[test]
fn scoped_lock_works() {
let mut key = ThreadKey::get().unwrap();
let collection = OwnedLockCollection::new([RwLock::new(24), RwLock::new(42)]);
collection.scoped_lock(&mut key, |guard| *guard[0] += *guard[1]);
let sum = collection.scoped_lock(&mut key, |guard| {
assert_eq!(*guard[0], 24 + 42);
assert_eq!(*guard[1], 42);
*guard[0] + *guard[1]
});
assert_eq!(sum, 24 + 42 + 42);
}
#[test]
fn scoped_try_lock_can_fail() {
let key = ThreadKey::get().unwrap();
let collection = OwnedLockCollection::new([Mutex::new(1), Mutex::new(2)]);
let guard = collection.lock(key);
std::thread::scope(|s| {
s.spawn(|| {
let key = ThreadKey::get().unwrap();
let r = collection.scoped_try_lock(key, |_| {});
assert!(r.is_err());
});
});
drop(guard);
}
#[test]
fn scoped_try_read_can_fail() {
let key = ThreadKey::get().unwrap();
let collection = OwnedLockCollection::new([RwLock::new(1), RwLock::new(2)]);
let guard = collection.lock(key);
std::thread::scope(|s| {
s.spawn(|| {
let key = ThreadKey::get().unwrap();
let r = collection.scoped_try_read(key, |_| {});
assert!(r.is_err());
});
});
drop(guard);
}
#[test]
fn try_lock_works_on_unlocked() {
let key = ThreadKey::get().unwrap();
let collection = OwnedLockCollection::new((Mutex::new(0), Mutex::new(1)));
let guard = collection.try_lock(key).unwrap();
assert_eq!(*guard.0, 0);
assert_eq!(*guard.1, 1);
}
#[test]
fn try_lock_fails_on_locked() {
let key = ThreadKey::get().unwrap();
let collection = OwnedLockCollection::new((Mutex::new(0), Mutex::new(1)));
std::thread::scope(|s| {
s.spawn(|| {
let key = ThreadKey::get().unwrap();
#[allow(unused)]
let guard = collection.lock(key);
std::mem::forget(guard);
});
});
assert!(collection.try_lock(key).is_err());
}
#[test]
fn try_read_succeeds_for_unlocked_collection() {
let key = ThreadKey::get().unwrap();
let mutexes = [RwLock::new(24), RwLock::new(42)];
let collection = OwnedLockCollection::new(mutexes);
let guard = collection.try_read(key).unwrap();
assert_eq!(*guard[0], 24);
assert_eq!(*guard[1], 42);
}
#[test]
fn try_read_fails_on_locked() {
let key = ThreadKey::get().unwrap();
let collection = OwnedLockCollection::new((RwLock::new(0), RwLock::new(1)));
std::thread::scope(|s| {
s.spawn(|| {
let key = ThreadKey::get().unwrap();
#[allow(unused)]
let guard = collection.lock(key);
std::mem::forget(guard);
});
});
assert!(collection.try_read(key).is_err());
}
#[test]
fn can_read_twice_on_different_threads() {
let key = ThreadKey::get().unwrap();
let mutexes = [RwLock::new(24), RwLock::new(42)];
let collection = OwnedLockCollection::new(mutexes);
std::thread::scope(|s| {
s.spawn(|| {
let key = ThreadKey::get().unwrap();
let guard = collection.read(key);
assert_eq!(*guard[0], 24);
assert_eq!(*guard[1], 42);
std::mem::forget(guard);
});
});
let guard = collection.try_read(key).unwrap();
assert_eq!(*guard[0], 24);
assert_eq!(*guard[1], 42);
}
#[test]
fn unlock_collection_works() {
let key = ThreadKey::get().unwrap();
let collection = OwnedLockCollection::new((Mutex::new("foo"), Mutex::new("bar")));
let guard = collection.lock(key);
let key = OwnedLockCollection::<(Mutex<_>, Mutex<_>)>::unlock(guard);
assert!(collection.try_lock(key).is_ok())
}
#[test]
fn read_unlock_collection_works() {
let key = ThreadKey::get().unwrap();
let collection = OwnedLockCollection::new((RwLock::new("foo"), RwLock::new("bar")));
let guard = collection.read(key);
let key = OwnedLockCollection::<(&RwLock<_>, &RwLock<_>)>::unlock_read(guard);
assert!(collection.try_lock(key).is_ok())
}
#[test]
fn default_works() {
type MyCollection = OwnedLockCollection<(Mutex<i32>, Mutex<Option<i32>>, Mutex<String>)>;
let collection = MyCollection::default();
let inner = collection.into_inner();
assert_eq!(inner.0, 0);
assert_eq!(inner.1, None);
assert_eq!(inner.2, String::new());
}
#[test]
fn can_be_extended() {
let mutex1 = Mutex::new(0);
let mutex2 = Mutex::new(1);
let mut collection = OwnedLockCollection::new(vec![mutex1, mutex2]);
collection.extend([Mutex::new(2)]);
assert_eq!(collection.data.len(), 3);
}
#[test]
fn works_in_collection() {
let key = ThreadKey::get().unwrap();
let collection =
OwnedLockCollection::new(OwnedLockCollection::new([RwLock::new(0), RwLock::new(1)]));
let mut guard = collection.lock(key);
assert_eq!(*guard[0], 0);
assert_eq!(*guard[1], 1);
*guard[1] = 2;
let key = OwnedLockCollection::<OwnedLockCollection<[RwLock<_>; 2]>>::unlock(guard);
let guard = collection.read(key);
assert_eq!(*guard[0], 0);
assert_eq!(*guard[1], 2);
}
#[test]
fn as_mut_works() {
let mut mutexes = [Mutex::new(0), Mutex::new(1)];
let mut collection = OwnedLockCollection::new(&mut mutexes);
collection.as_mut()[0] = Mutex::new(42);
assert_eq!(*collection.as_mut()[0].get_mut(), 42);
}
#[test]
fn child_mut_works() {
let mut mutexes = [Mutex::new(0), Mutex::new(1)];
let mut collection = OwnedLockCollection::new(&mut mutexes);
collection.child_mut()[0] = Mutex::new(42);
assert_eq!(*collection.child_mut()[0].get_mut(), 42);
}
#[test]
fn into_child_works() {
let mutexes = [Mutex::new(0), Mutex::new(1)];
let mut collection = OwnedLockCollection::new(mutexes);
collection.child_mut()[0] = Mutex::new(42);
assert_eq!(
*collection
.into_child()
.as_mut()
.get_mut(0)
.unwrap()
.get_mut(),
42
);
}
#[test]
fn duplicates_detected() {
let collection1 = OwnedLockCollection::new([Mutex::new(5), Mutex::new(10)]);
let collection2 = LockCollection::try_new((&collection1, &collection1));
assert!(collection2.is_none());
}
}
|
