library/std/src/sync/rwlock.rs

   1 use crate::cell::UnsafeCell;
   2 use crate::fmt;
   3 use crate::mem;
   4 use crate::ops::{Deref, DerefMut};
   5 use crate::ptr;
   6 use crate::sys_common::poison::{self, LockResult, TryLockError, TryLockResult};
   7 use crate::sys_common::rwlock as sys;
   8
   9 /// A reader-writer lock
  10 ///
  11 /// This type of lock allows a number of readers or at most one writer at any
  12 /// point in time. The write portion of this lock typically allows modification
  13 /// of the underlying data (exclusive access) and the read portion of this lock
  14 /// typically allows for read-only access (shared access).
  15 ///
  16 /// In comparison, a [`Mutex`] does not distinguish between readers or writers
  17 /// that acquire the lock, therefore blocking any threads waiting for the lock to
  18 /// become available. An `RwLock` will allow any number of readers to acquire the
  19 /// lock as long as a writer is not holding the lock.
  20 ///
  21 /// The priority policy of the lock is dependent on the underlying operating
  22 /// system's implementation, and this type does not guarantee that any
  23 /// particular policy will be used.
  24 ///
  25 /// The type parameter `T` represents the data that this lock protects. It is
  26 /// required that `T` satisfies [`Send`] to be shared across threads and
  27 /// [`Sync`] to allow concurrent access through readers. The RAII guards
  28 /// returned from the locking methods implement [`Deref`] (and [`DerefMut`]
  29 /// for the `write` methods) to allow access to the content of the lock.
  30 ///
  31 /// # Poisoning
  32 ///
  33 /// An `RwLock`, like [`Mutex`], will become poisoned on a panic. Note, however,
  34 /// that an `RwLock` may only be poisoned if a panic occurs while it is locked
  35 /// exclusively (write mode). If a panic occurs in any reader, then the lock
  36 /// will not be poisoned.
  37 ///
  38 /// # Examples
  39 ///
  40 /// ```
  41 /// use std::sync::RwLock;
  42 ///
  43 /// let lock = RwLock::new(5);
  44 ///
  45 /// // many reader locks can be held at once
  46 /// {
  47 ///     let r1 = lock.read().unwrap();
  48 ///     let r2 = lock.read().unwrap();
  49 ///     assert_eq!(*r1, 5);
  50 ///     assert_eq!(*r2, 5);
  51 /// } // read locks are dropped at this point
  52 ///
  53 /// // only one write lock may be held, however
  54 /// {
  55 ///     let mut w = lock.write().unwrap();
  56 ///     *w += 1;
  57 ///     assert_eq!(*w, 6);
  58 /// } // write lock is dropped here
  59 /// ```
  60 ///
  61 /// [`Deref`]: ../../std/ops/trait.Deref.html
  62 /// [`DerefMut`]: ../../std/ops/trait.DerefMut.html
  63 /// [`Send`]: ../../std/marker/trait.Send.html
  64 /// [`Sync`]: ../../std/marker/trait.Sync.html
  65 /// [`Mutex`]: struct.Mutex.html
  66 #[stable(feature = "rust1", since = "1.0.0")]
  67 pub struct RwLock<T: ?Sized> {
  68     inner: Box<sys::RWLock>,
  69     poison: poison::Flag,
  70     data: UnsafeCell<T>,
  71 }
  72
  73 #[stable(feature = "rust1", since = "1.0.0")]
  74 unsafe impl<T: ?Sized + Send> Send for RwLock<T> {}
  75 #[stable(feature = "rust1", since = "1.0.0")]
  76 unsafe impl<T: ?Sized + Send + Sync> Sync for RwLock<T> {}
  77
  78 /// RAII structure used to release the shared read access of a lock when
  79 /// dropped.
  80 ///
  81 /// This structure is created by the [`read`] and [`try_read`] methods on
  82 /// [`RwLock`].
  83 ///
  84 /// [`read`]: struct.RwLock.html#method.read
  85 /// [`try_read`]: struct.RwLock.html#method.try_read
  86 /// [`RwLock`]: struct.RwLock.html
  87 #[must_use = "if unused the RwLock will immediately unlock"]
  88 #[stable(feature = "rust1", since = "1.0.0")]
  89 pub struct RwLockReadGuard<'a, T: ?Sized + 'a> {
  90     lock: &'a RwLock<T>,
  91 }
  92
  93 #[stable(feature = "rust1", since = "1.0.0")]
  94 impl<T: ?Sized> !Send for RwLockReadGuard<'_, T> {}
  95
  96 #[stable(feature = "rwlock_guard_sync", since = "1.23.0")]
  97 unsafe impl<T: ?Sized + Sync> Sync for RwLockReadGuard<'_, T> {}
  98
  99 /// RAII structure used to release the exclusive write access of a lock when
 100 /// dropped.
 101 ///
 102 /// This structure is created by the [`write`] and [`try_write`] methods
 103 /// on [`RwLock`].
 104 ///
 105 /// [`write`]: struct.RwLock.html#method.write
 106 /// [`try_write`]: struct.RwLock.html#method.try_write
 107 /// [`RwLock`]: struct.RwLock.html
 108 #[must_use = "if unused the RwLock will immediately unlock"]
 109 #[stable(feature = "rust1", since = "1.0.0")]
 110 pub struct RwLockWriteGuard<'a, T: ?Sized + 'a> {
 111     lock: &'a RwLock<T>,
 112     poison: poison::Guard,
 113 }
 114
 115 #[stable(feature = "rust1", since = "1.0.0")]
 116 impl<T: ?Sized> !Send for RwLockWriteGuard<'_, T> {}
 117
 118 #[stable(feature = "rwlock_guard_sync", since = "1.23.0")]
 119 unsafe impl<T: ?Sized + Sync> Sync for RwLockWriteGuard<'_, T> {}
 120
 121 impl<T> RwLock<T> {
 122     /// Creates a new instance of an `RwLock<T>` which is unlocked.
 123     ///
 124     /// # Examples
 125     ///
 126     /// ```
 127     /// use std::sync::RwLock;
 128     ///
 129     /// let lock = RwLock::new(5);
 130     /// ```
 131     #[stable(feature = "rust1", since = "1.0.0")]
 132     pub fn new(t: T) -> RwLock<T> {
 133         RwLock {
 134             inner: box sys::RWLock::new(),
 135             poison: poison::Flag::new(),
 136             data: UnsafeCell::new(t),
 137         }
 138     }
 139 }
 140
 141 impl<T: ?Sized> RwLock<T> {
 142     /// Locks this rwlock with shared read access, blocking the current thread
 143     /// until it can be acquired.
 144     ///
 145     /// The calling thread will be blocked until there are no more writers which
 146     /// hold the lock. There may be other readers currently inside the lock when
 147     /// this method returns. This method does not provide any guarantees with
 148     /// respect to the ordering of whether contentious readers or writers will
 149     /// acquire the lock first.
 150     ///
 151     /// Returns an RAII guard which will release this thread's shared access
 152     /// once it is dropped.
 153     ///
 154     /// # Errors
 155     ///
 156     /// This function will return an error if the RwLock is poisoned. An RwLock
 157     /// is poisoned whenever a writer panics while holding an exclusive lock.
 158     /// The failure will occur immediately after the lock has been acquired.
 159     ///
 160     /// # Panics
 161     ///
 162     /// This function might panic when called if the lock is already held by the current thread.
 163     ///
 164     /// # Examples
 165     ///
 166     /// ```
 167     /// use std::sync::{Arc, RwLock};
 168     /// use std::thread;
 169     ///
 170     /// let lock = Arc::new(RwLock::new(1));
 171     /// let c_lock = lock.clone();
 172     ///
 173     /// let n = lock.read().unwrap();
 174     /// assert_eq!(*n, 1);
 175     ///
 176     /// thread::spawn(move || {
 177     ///     let r = c_lock.read();
 178     ///     assert!(r.is_ok());
 179     /// }).join().unwrap();
 180     /// ```
 181     #[inline]
 182     #[stable(feature = "rust1", since = "1.0.0")]
 183     pub fn read(&self) -> LockResult<RwLockReadGuard<'_, T>> {
 184         unsafe {
 185             self.inner.read();
 186             RwLockReadGuard::new(self)
 187         }
 188     }
 189
 190     /// Attempts to acquire this rwlock with shared read access.
 191     ///
 192     /// If the access could not be granted at this time, then `Err` is returned.
 193     /// Otherwise, an RAII guard is returned which will release the shared access
 194     /// when it is dropped.
 195     ///
 196     /// This function does not block.
 197     ///
 198     /// This function does not provide any guarantees with respect to the ordering
 199     /// of whether contentious readers or writers will acquire the lock first.
 200     ///
 201     /// # Errors
 202     ///
 203     /// This function will return an error if the RwLock is poisoned. An RwLock
 204     /// is poisoned whenever a writer panics while holding an exclusive lock. An
 205     /// error will only be returned if the lock would have otherwise been
 206     /// acquired.
 207     ///
 208     /// # Examples
 209     ///
 210     /// ```
 211     /// use std::sync::RwLock;
 212     ///
 213     /// let lock = RwLock::new(1);
 214     ///
 215     /// match lock.try_read() {
 216     ///     Ok(n) => assert_eq!(*n, 1),
 217     ///     Err(_) => unreachable!(),
 218     /// };
 219     /// ```
 220     #[inline]
 221     #[stable(feature = "rust1", since = "1.0.0")]
 222     pub fn try_read(&self) -> TryLockResult<RwLockReadGuard<'_, T>> {
 223         unsafe {
 224             if self.inner.try_read() {
 225                 Ok(RwLockReadGuard::new(self)?)
 226             } else {
 227                 Err(TryLockError::WouldBlock)
 228             }
 229         }
 230     }
 231
 232     /// Locks this rwlock with exclusive write access, blocking the current
 233     /// thread until it can be acquired.
 234     ///
 235     /// This function will not return while other writers or other readers
 236     /// currently have access to the lock.
 237     ///
 238     /// Returns an RAII guard which will drop the write access of this rwlock
 239     /// when dropped.
 240     ///
 241     /// # Errors
 242     ///
 243     /// This function will return an error if the RwLock is poisoned. An RwLock
 244     /// is poisoned whenever a writer panics while holding an exclusive lock.
 245     /// An error will be returned when the lock is acquired.
 246     ///
 247     /// # Panics
 248     ///
 249     /// This function might panic when called if the lock is already held by the current thread.
 250     ///
 251     /// # Examples
 252     ///
 253     /// ```
 254     /// use std::sync::RwLock;
 255     ///
 256     /// let lock = RwLock::new(1);
 257     ///
 258     /// let mut n = lock.write().unwrap();
 259     /// *n = 2;
 260     ///
 261     /// assert!(lock.try_read().is_err());
 262     /// ```
 263     #[inline]
 264     #[stable(feature = "rust1", since = "1.0.0")]
 265     pub fn write(&self) -> LockResult<RwLockWriteGuard<'_, T>> {
 266         unsafe {
 267             self.inner.write();
 268             RwLockWriteGuard::new(self)
 269         }
 270     }
 271
 272     /// Attempts to lock this rwlock with exclusive write access.
 273     ///
 274     /// If the lock could not be acquired at this time, then `Err` is returned.
 275     /// Otherwise, an RAII guard is returned which will release the lock when
 276     /// it is dropped.
 277     ///
 278     /// This function does not block.
 279     ///
 280     /// This function does not provide any guarantees with respect to the ordering
 281     /// of whether contentious readers or writers will acquire the lock first.
 282     ///
 283     /// # Errors
 284     ///
 285     /// This function will return an error if the RwLock is poisoned. An RwLock
 286     /// is poisoned whenever a writer panics while holding an exclusive lock. An
 287     /// error will only be returned if the lock would have otherwise been
 288     /// acquired.
 289     ///
 290     /// # Examples
 291     ///
 292     /// ```
 293     /// use std::sync::RwLock;
 294     ///
 295     /// let lock = RwLock::new(1);
 296     ///
 297     /// let n = lock.read().unwrap();
 298     /// assert_eq!(*n, 1);
 299     ///
 300     /// assert!(lock.try_write().is_err());
 301     /// ```
 302     #[inline]
 303     #[stable(feature = "rust1", since = "1.0.0")]
 304     pub fn try_write(&self) -> TryLockResult<RwLockWriteGuard<'_, T>> {
 305         unsafe {
 306             if self.inner.try_write() {
 307                 Ok(RwLockWriteGuard::new(self)?)
 308             } else {
 309                 Err(TryLockError::WouldBlock)
 310             }
 311         }
 312     }
 313
 314     /// Determines whether the lock is poisoned.
 315     ///
 316     /// If another thread is active, the lock can still become poisoned at any
 317     /// time. You should not trust a `false` value for program correctness
 318     /// without additional synchronization.
 319     ///
 320     /// # Examples
 321     ///
 322     /// ```
 323     /// use std::sync::{Arc, RwLock};
 324     /// use std::thread;
 325     ///
 326     /// let lock = Arc::new(RwLock::new(0));
 327     /// let c_lock = lock.clone();
 328     ///
 329     /// let _ = thread::spawn(move || {
 330     ///     let _lock = c_lock.write().unwrap();
 331     ///     panic!(); // the lock gets poisoned
 332     /// }).join();
 333     /// assert_eq!(lock.is_poisoned(), true);
 334     /// ```
 335     #[inline]
 336     #[stable(feature = "sync_poison", since = "1.2.0")]
 337     pub fn is_poisoned(&self) -> bool {
 338         self.poison.get()
 339     }
 340
 341     /// Consumes this `RwLock`, returning the underlying data.
 342     ///
 343     /// # Errors
 344     ///
 345     /// This function will return an error if the RwLock is poisoned. An RwLock
 346     /// is poisoned whenever a writer panics while holding an exclusive lock. An
 347     /// error will only be returned if the lock would have otherwise been
 348     /// acquired.
 349     ///
 350     /// # Examples
 351     ///
 352     /// ```
 353     /// use std::sync::RwLock;
 354     ///
 355     /// let lock = RwLock::new(String::new());
 356     /// {
 357     ///     let mut s = lock.write().unwrap();
 358     ///     *s = "modified".to_owned();
 359     /// }
 360     /// assert_eq!(lock.into_inner().unwrap(), "modified");
 361     /// ```
 362     #[stable(feature = "rwlock_into_inner", since = "1.6.0")]
 363     pub fn into_inner(self) -> LockResult<T>
 364     where
 365         T: Sized,
 366     {
 367         // We know statically that there are no outstanding references to
 368         // `self` so there's no need to lock the inner lock.
 369         //
 370         // To get the inner value, we'd like to call `data.into_inner()`,
 371         // but because `RwLock` impl-s `Drop`, we can't move out of it, so
 372         // we'll have to destructure it manually instead.
 373         unsafe {
 374             // Like `let RwLock { inner, poison, data } = self`.
 375             let (inner, poison, data) = {
 376                 let RwLock { ref inner, ref poison, ref data } = self;
 377                 (ptr::read(inner), ptr::read(poison), ptr::read(data))
 378             };
 379             mem::forget(self);
 380             inner.destroy(); // Keep in sync with the `Drop` impl.
 381             drop(inner);
 382
 383             poison::map_result(poison.borrow(), |_| data.into_inner())
 384         }
 385     }
 386
 387     /// Returns a mutable reference to the underlying data.
 388     ///
 389     /// Since this call borrows the `RwLock` mutably, no actual locking needs to
 390     /// take place -- the mutable borrow statically guarantees no locks exist.
 391     ///
 392     /// # Errors
 393     ///
 394     /// This function will return an error if the RwLock is poisoned. An RwLock
 395     /// is poisoned whenever a writer panics while holding an exclusive lock. An
 396     /// error will only be returned if the lock would have otherwise been
 397     /// acquired.
 398     ///
 399     /// # Examples
 400     ///
 401     /// ```
 402     /// use std::sync::RwLock;
 403     ///
 404     /// let mut lock = RwLock::new(0);
 405     /// *lock.get_mut().unwrap() = 10;
 406     /// assert_eq!(*lock.read().unwrap(), 10);
 407     /// ```
 408     #[stable(feature = "rwlock_get_mut", since = "1.6.0")]
 409     pub fn get_mut(&mut self) -> LockResult<&mut T> {
 410         // We know statically that there are no other references to `self`, so
 411         // there's no need to lock the inner lock.
 412         let data = unsafe { &mut *self.data.get() };
 413         poison::map_result(self.poison.borrow(), |_| data)
 414     }
 415 }
 416
 417 #[stable(feature = "rust1", since = "1.0.0")]
 418 unsafe impl<#[may_dangle] T: ?Sized> Drop for RwLock<T> {
 419     fn drop(&mut self) {
 420         // IMPORTANT: This code needs to be kept in sync with `RwLock::into_inner`.
 421         unsafe { self.inner.destroy() }
 422     }
 423 }
 424
 425 #[stable(feature = "rust1", since = "1.0.0")]
 426 impl<T: ?Sized + fmt::Debug> fmt::Debug for RwLock<T> {
 427     fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
 428         match self.try_read() {
 429             Ok(guard) => f.debug_struct("RwLock").field("data", &&*guard).finish(),
 430             Err(TryLockError::Poisoned(err)) => {
 431                 f.debug_struct("RwLock").field("data", &&**err.get_ref()).finish()
 432             }
 433             Err(TryLockError::WouldBlock) => {
 434                 struct LockedPlaceholder;
 435                 impl fmt::Debug for LockedPlaceholder {
 436                     fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
 437                         f.write_str("<locked>")
 438                     }
 439                 }
 440
 441                 f.debug_struct("RwLock").field("data", &LockedPlaceholder).finish()
 442             }
 443         }
 444     }
 445 }
 446
 447 #[stable(feature = "rw_lock_default", since = "1.10.0")]
 448 impl<T: Default> Default for RwLock<T> {
 449     /// Creates a new `RwLock<T>`, with the `Default` value for T.
 450     fn default() -> RwLock<T> {
 451         RwLock::new(Default::default())
 452     }
 453 }
 454
 455 #[stable(feature = "rw_lock_from", since = "1.24.0")]
 456 impl<T> From<T> for RwLock<T> {
 457     /// Creates a new instance of an `RwLock<T>` which is unlocked.
 458     /// This is equivalent to [`RwLock::new`].
 459     ///
 460     /// [`RwLock::new`]: ../../std/sync/struct.RwLock.html#method.new
 461     fn from(t: T) -> Self {
 462         RwLock::new(t)
 463     }
 464 }
 465
 466 impl<'rwlock, T: ?Sized> RwLockReadGuard<'rwlock, T> {
 467     unsafe fn new(lock: &'rwlock RwLock<T>) -> LockResult<RwLockReadGuard<'rwlock, T>> {
 468         poison::map_result(lock.poison.borrow(), |_| RwLockReadGuard { lock })
 469     }
 470 }
 471
 472 impl<'rwlock, T: ?Sized> RwLockWriteGuard<'rwlock, T> {
 473     unsafe fn new(lock: &'rwlock RwLock<T>) -> LockResult<RwLockWriteGuard<'rwlock, T>> {
 474         poison::map_result(lock.poison.borrow(), |guard| RwLockWriteGuard { lock, poison: guard })
 475     }
 476 }
 477
 478 #[stable(feature = "std_debug", since = "1.16.0")]
 479 impl<T: fmt::Debug> fmt::Debug for RwLockReadGuard<'_, T> {
 480     fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
 481         f.debug_struct("RwLockReadGuard").field("lock", &self.lock).finish()
 482     }
 483 }
 484
 485 #[stable(feature = "std_guard_impls", since = "1.20.0")]
 486 impl<T: ?Sized + fmt::Display> fmt::Display for RwLockReadGuard<'_, T> {
 487     fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
 488         (**self).fmt(f)
 489     }
 490 }
 491
 492 #[stable(feature = "std_debug", since = "1.16.0")]
 493 impl<T: fmt::Debug> fmt::Debug for RwLockWriteGuard<'_, T> {
 494     fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
 495         f.debug_struct("RwLockWriteGuard").field("lock", &self.lock).finish()
 496     }
 497 }
 498
 499 #[stable(feature = "std_guard_impls", since = "1.20.0")]
 500 impl<T: ?Sized + fmt::Display> fmt::Display for RwLockWriteGuard<'_, T> {
 501     fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
 502         (**self).fmt(f)
 503     }
 504 }
 505
 506 #[stable(feature = "rust1", since = "1.0.0")]
 507 impl<T: ?Sized> Deref for RwLockReadGuard<'_, T> {
 508     type Target = T;
 509
 510     fn deref(&self) -> &T {
 511         unsafe { &*self.lock.data.get() }
 512     }
 513 }
 514
 515 #[stable(feature = "rust1", since = "1.0.0")]
 516 impl<T: ?Sized> Deref for RwLockWriteGuard<'_, T> {
 517     type Target = T;
 518
 519     fn deref(&self) -> &T {
 520         unsafe { &*self.lock.data.get() }
 521     }
 522 }
 523
 524 #[stable(feature = "rust1", since = "1.0.0")]
 525 impl<T: ?Sized> DerefMut for RwLockWriteGuard<'_, T> {
 526     fn deref_mut(&mut self) -> &mut T {
 527         unsafe { &mut *self.lock.data.get() }
 528     }
 529 }
 530
 531 #[stable(feature = "rust1", since = "1.0.0")]
 532 impl<T: ?Sized> Drop for RwLockReadGuard<'_, T> {
 533     fn drop(&mut self) {
 534         unsafe {
 535             self.lock.inner.read_unlock();
 536         }
 537     }
 538 }
 539
 540 #[stable(feature = "rust1", since = "1.0.0")]
 541 impl<T: ?Sized> Drop for RwLockWriteGuard<'_, T> {
 542     fn drop(&mut self) {
 543         self.lock.poison.done(&self.poison);
 544         unsafe {
 545             self.lock.inner.write_unlock();
 546         }
 547     }
 548 }
 549
 550 #[cfg(all(test, not(target_os = "emscripten")))]
 551 mod tests {
 552     use crate::sync::atomic::{AtomicUsize, Ordering};
 553     use crate::sync::mpsc::channel;
 554     use crate::sync::{Arc, RwLock, TryLockError};
 555     use crate::thread;
 556     use rand::{self, Rng};
 557
 558     #[derive(Eq, PartialEq, Debug)]
 559     struct NonCopy(i32);
 560
 561     #[test]
 562     fn smoke() {
 563         let l = RwLock::new(());
 564         drop(l.read().unwrap());
 565         drop(l.write().unwrap());
 566         drop((l.read().unwrap(), l.read().unwrap()));
 567         drop(l.write().unwrap());
 568     }
 569
 570     #[test]
 571     fn frob() {
 572         const N: u32 = 10;
 573         const M: usize = 1000;
 574
 575         let r = Arc::new(RwLock::new(()));
 576
 577         let (tx, rx) = channel::<()>();
 578         for _ in 0..N {
 579             let tx = tx.clone();
 580             let r = r.clone();
 581             thread::spawn(move || {
 582                 let mut rng = rand::thread_rng();
 583                 for _ in 0..M {
 584                     if rng.gen_bool(1.0 / (N as f64)) {
 585                         drop(r.write().unwrap());
 586                     } else {
 587                         drop(r.read().unwrap());
 588                     }
 589                 }
 590                 drop(tx);
 591             });
 592         }
 593         drop(tx);
 594         let _ = rx.recv();
 595     }
 596
 597     #[test]
 598     fn test_rw_arc_poison_wr() {
 599         let arc = Arc::new(RwLock::new(1));
 600         let arc2 = arc.clone();
 601         let _: Result<(), _> = thread::spawn(move || {
 602             let _lock = arc2.write().unwrap();
 603             panic!();
 604         })
 605         .join();
 606         assert!(arc.read().is_err());
 607     }
 608
 609     #[test]
 610     fn test_rw_arc_poison_ww() {
 611         let arc = Arc::new(RwLock::new(1));
 612         assert!(!arc.is_poisoned());
 613         let arc2 = arc.clone();
 614         let _: Result<(), _> = thread::spawn(move || {
 615             let _lock = arc2.write().unwrap();
 616             panic!();
 617         })
 618         .join();
 619         assert!(arc.write().is_err());
 620         assert!(arc.is_poisoned());
 621     }
 622
 623     #[test]
 624     fn test_rw_arc_no_poison_rr() {
 625         let arc = Arc::new(RwLock::new(1));
 626         let arc2 = arc.clone();
 627         let _: Result<(), _> = thread::spawn(move || {
 628             let _lock = arc2.read().unwrap();
 629             panic!();
 630         })
 631         .join();
 632         let lock = arc.read().unwrap();
 633         assert_eq!(*lock, 1);
 634     }
 635     #[test]
 636     fn test_rw_arc_no_poison_rw() {
 637         let arc = Arc::new(RwLock::new(1));
 638         let arc2 = arc.clone();
 639         let _: Result<(), _> = thread::spawn(move || {
 640             let _lock = arc2.read().unwrap();
 641             panic!()
 642         })
 643         .join();
 644         let lock = arc.write().unwrap();
 645         assert_eq!(*lock, 1);
 646     }
 647
 648     #[test]
 649     fn test_rw_arc() {
 650         let arc = Arc::new(RwLock::new(0));
 651         let arc2 = arc.clone();
 652         let (tx, rx) = channel();
 653
 654         thread::spawn(move || {
 655             let mut lock = arc2.write().unwrap();
 656             for _ in 0..10 {
 657                 let tmp = *lock;
 658                 *lock = -1;
 659                 thread::yield_now();
 660                 *lock = tmp + 1;
 661             }
 662             tx.send(()).unwrap();
 663         });
 664
 665         // Readers try to catch the writer in the act
 666         let mut children = Vec::new();
 667         for _ in 0..5 {
 668             let arc3 = arc.clone();
 669             children.push(thread::spawn(move || {
 670                 let lock = arc3.read().unwrap();
 671                 assert!(*lock >= 0);
 672             }));
 673         }
 674
 675         // Wait for children to pass their asserts
 676         for r in children {
 677             assert!(r.join().is_ok());
 678         }
 679
 680         // Wait for writer to finish
 681         rx.recv().unwrap();
 682         let lock = arc.read().unwrap();
 683         assert_eq!(*lock, 10);
 684     }
 685
 686     #[test]
 687     fn test_rw_arc_access_in_unwind() {
 688         let arc = Arc::new(RwLock::new(1));
 689         let arc2 = arc.clone();
 690         let _ = thread::spawn(move || -> () {
 691             struct Unwinder {
 692                 i: Arc<RwLock<isize>>,
 693             }
 694             impl Drop for Unwinder {
 695                 fn drop(&mut self) {
 696                     let mut lock = self.i.write().unwrap();
 697                     *lock += 1;
 698                 }
 699             }
 700             let _u = Unwinder { i: arc2 };
 701             panic!();
 702         })
 703         .join();
 704         let lock = arc.read().unwrap();
 705         assert_eq!(*lock, 2);
 706     }
 707
 708     #[test]
 709     fn test_rwlock_unsized() {
 710         let rw: &RwLock<[i32]> = &RwLock::new([1, 2, 3]);
 711         {
 712             let b = &mut *rw.write().unwrap();
 713             b[0] = 4;
 714             b[2] = 5;
 715         }
 716         let comp: &[i32] = &[4, 2, 5];
 717         assert_eq!(&*rw.read().unwrap(), comp);
 718     }
 719
 720     #[test]
 721     fn test_rwlock_try_write() {
 722         let lock = RwLock::new(0isize);
 723         let read_guard = lock.read().unwrap();
 724
 725         let write_result = lock.try_write();
 726         match write_result {
 727             Err(TryLockError::WouldBlock) => (),
 728             Ok(_) => assert!(false, "try_write should not succeed while read_guard is in scope"),
 729             Err(_) => assert!(false, "unexpected error"),
 730         }
 731
 732         drop(read_guard);
 733     }
 734
 735     #[test]
 736     fn test_into_inner() {
 737         let m = RwLock::new(NonCopy(10));
 738         assert_eq!(m.into_inner().unwrap(), NonCopy(10));
 739     }
 740
 741     #[test]
 742     fn test_into_inner_drop() {
 743         struct Foo(Arc<AtomicUsize>);
 744         impl Drop for Foo {
 745             fn drop(&mut self) {
 746                 self.0.fetch_add(1, Ordering::SeqCst);
 747             }
 748         }
 749         let num_drops = Arc::new(AtomicUsize::new(0));
 750         let m = RwLock::new(Foo(num_drops.clone()));
 751         assert_eq!(num_drops.load(Ordering::SeqCst), 0);
 752         {
 753             let _inner = m.into_inner().unwrap();
 754             assert_eq!(num_drops.load(Ordering::SeqCst), 0);
 755         }
 756         assert_eq!(num_drops.load(Ordering::SeqCst), 1);
 757     }
 758
 759     #[test]
 760     fn test_into_inner_poison() {
 761         let m = Arc::new(RwLock::new(NonCopy(10)));
 762         let m2 = m.clone();
 763         let _ = thread::spawn(move || {
 764             let _lock = m2.write().unwrap();
 765             panic!("test panic in inner thread to poison RwLock");
 766         })
 767         .join();
 768
 769         assert!(m.is_poisoned());
 770         match Arc::try_unwrap(m).unwrap().into_inner() {
 771             Err(e) => assert_eq!(e.into_inner(), NonCopy(10)),
 772             Ok(x) => panic!("into_inner of poisoned RwLock is Ok: {:?}", x),
 773         }
 774     }
 775
 776     #[test]
 777     fn test_get_mut() {
 778         let mut m = RwLock::new(NonCopy(10));
 779         *m.get_mut().unwrap() = NonCopy(20);
 780         assert_eq!(m.into_inner().unwrap(), NonCopy(20));
 781     }
 782
 783     #[test]
 784     fn test_get_mut_poison() {
 785         let m = Arc::new(RwLock::new(NonCopy(10)));
 786         let m2 = m.clone();
 787         let _ = thread::spawn(move || {
 788             let _lock = m2.write().unwrap();
 789             panic!("test panic in inner thread to poison RwLock");
 790         })
 791         .join();
 792
 793         assert!(m.is_poisoned());
 794         match Arc::try_unwrap(m).unwrap().get_mut() {
 795             Err(e) => assert_eq!(*e.into_inner(), NonCopy(10)),
 796             Ok(x) => panic!("get_mut of poisoned RwLock is Ok: {:?}", x),
 797         }
 798     }
 799 }