Auto merge of #82624 - ojeda:rwlock-example-deadlock, r=JohnTitor
RWLock: Add deadlock example Suggested in https://github.com/rust-lang/rust/pull/82596 but it was a bit too late. `@matklad` `@azdavis` `@sfackler`
This commit is contained in:
commit
17ea490310
1 changed files with 13 additions and 1 deletions
|
@ -23,7 +23,19 @@ use crate::sys_common::rwlock as sys;
|
||||||
/// system's implementation, and this type does not guarantee that any
|
/// system's implementation, and this type does not guarantee that any
|
||||||
/// particular policy will be used. In particular, a writer which is waiting to
|
/// particular policy will be used. In particular, a writer which is waiting to
|
||||||
/// acquire the lock in `write` might or might not block concurrent calls to
|
/// acquire the lock in `write` might or might not block concurrent calls to
|
||||||
/// `read`.
|
/// `read`, e.g.:
|
||||||
|
///
|
||||||
|
/// <details><summary>Potential deadlock example</summary>
|
||||||
|
///
|
||||||
|
/// ```text
|
||||||
|
/// // Thread 1 | // Thread 2
|
||||||
|
/// let _rg = lock.read(); |
|
||||||
|
/// | // will block
|
||||||
|
/// | let _wg = lock.write();
|
||||||
|
/// // may deadlock |
|
||||||
|
/// let _rg = lock.read(); |
|
||||||
|
/// ```
|
||||||
|
/// </details>
|
||||||
///
|
///
|
||||||
/// The type parameter `T` represents the data that this lock protects. It is
|
/// The type parameter `T` represents the data that this lock protects. It is
|
||||||
/// required that `T` satisfies [`Send`] to be shared across threads and
|
/// required that `T` satisfies [`Send`] to be shared across threads and
|
||||||
|
|
Loading…
Add table
Add a link
Reference in a new issue