Tracking Issue for `ReentrantLock`

[joboet]

Feature gate: #![feature(reentrant_lock)]

This is a tracking issue for ReentrantLock, a re-entrant lock useful for avoiding a common type of deadlocks.

Public API

// std::sync

pub struct ReentrantLock<T: ?Sized> {}
pub struct ReentrantLockGuard<'a, T: ?Sized + 'a> {}

impl<T> ReentrantLock<T> {
    pub const fn new(t: T) -> ReentrantLock<T>;
    pub fn into_inner(self) -> T;
}

impl<T: ?Sized> ReentrantLock<T> {
    pub fn lock(&self) -> ReentrantLockGuard<'_, T>;
    pub fn get_mut(&mut self) -> &mut T;
}

impl<T: Send + ?Sized> Send for ReentrantLock<T> {}
impl<T: Send + ?Sized> Sync for ReentrantLock<T> {}

impl<T: ?Sized> !Send for ReentrantLockGuard<'_, T> {}
impl<T: ?Sized + Sync> Sync for ReentrantLockGuard<'_, T> {}

impl<T: UnwindSafe + ?Sized> UnwindSafe for ReentrantLock<T> {}
impl<T: RefUnwindSafe + ?Sized> RefUnwindSafe for ReentrantLock<T> {}

impl<T: Default> Default for ReentrantLock<T> {}
impl<T> From<T> for ReentrantLock<T> {}

impl<T: ?Sized> Deref for ReentrantLockGuard<'_, T> {
    type Target = T;
}

impl<T: Debug + ?Sized> Debug for ReentrantLock<T> {}
impl<T: Debug + ?Sized> Debug for ReentrantLockGuard<'_, T> {}
impl<T: Display + ?Sized> Display for ReentrantLockGuard<'_, T> {}

Steps / History

• ACP: Add sync::ReentrantLock libs-team#193
• Implementation:
  • Make ReentrantLock public #110543
  • Add manual Sync impl for ReentrantLockGuard #125527
• Final comment period (FCP)¹
• Stabilization PR

Unresolved Questions

Poisoning

I would argue that ReentrantLock should not implement lock poisoning. Since it only provides shared access, breaking the invariants of the inner type is something that the lock has no control over, as it requires interior mutability. It would make sense to require that T: RefUnwindSafe, but I think that is too inconvenient for now. If RefUnwindSafe were a lint trait, it should definitely be used.

Fallible locking

Is there a need for fallible locking, even if it cannot fail because of reentrancy? How would this look like, considering that TryLockResult also has a poisoning case, which would never be used here?

Naming

New synchronization primitives like OnceLock have used the Lock suffix. IMHO the name ReentrantLock rhymes well with the other types and is more consistent, but ReentrantMutex better highlights the similarity to Mutex.

Footnotes

1. https://std-dev-guide.rust-lang.org/feature-lifecycle/stabilization.html ↩

[RalfJung]

New synchronization primitives like OnceLock have used the Lock suffix. IMHO the name ReentrantLock rhymes well with the other types and is more consistent, but ReentrantMutex better highlights the similarity to Mutex.

I'll put in my vote for ReentrantMutex.

OnceLock isn't even a lock or a mutex, it's a thread-safe version of OnceCell. I don't know why it has "lock" in its name but IMO that's not a good justification for the asymmetry between Mutex and ReentrantMutex.

[joboet]

I'm still dreaming of a future in which we have a poison-free Lock instead of Mutex. In that future, ReentrantLock is the perfect name. But I'm not convinced that it's achievable. Still, I'd like to defer the final decision until stabilization.

[RalfJung]

I don't see why "Mutex" would implicitly mean "poisoned". That's not an obvious naming scheme at all.

[botahamec]

If we have unpoisoned mutexes in the future, it'd probably be better to do something like CleanReentrantMutex. And maybe it could be aliased in a future edition, but that's obviously outside this issue's scope.

[Eclipse32767]

Alright question, why not have interior mutability on the ReentrantLock? I don't think there's a data race problem here, but I might be missing something

[RalfJung]

You mean returning an &mut when acquiring the lock?

Then I could acquire the lock twice in the same thread, have two aliasing mutable references, and proceed to break everything from there.

[Eclipse32767]

Good catch, I didn’t notice why everything blows up with this, just noticed how interior mutability was out of the question and wondered why

[radiantgurl]

Please make try_lock be public to be the same as Mutex and RwLock.
ReentrantLock would have more use cases if it can directly replace Mutex when an object is locked more than once.

[workingjubilee]

OnceLock isn't even a lock or a mutex, it's a thread-safe version of OnceCell. I don't know why it has "lock" in its name but IMO that's not a good justification for the asymmetry between Mutex and ReentrantMutex.

It is the sort of lock you throw away the key to.

Perhaps OnceDungeon sounded too grim.

[workingjubilee]

#125527 corrects the Sync impl to be something actually suitable for a publicly usable type.