src/libstd/sync/poison.rs

   1 // Copyright 2014 The Rust Project Developers. See the COPYRIGHT
   2 // file at the top-level directory of this distribution and at
   3 // http://rust-lang.org/COPYRIGHT.
   4 //
   5 // Licensed under the Apache License, Version 2.0 <LICENSE-APACHE or
   6 // http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
   7 // <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your
   8 // option. This file may not be copied, modified, or distributed
   9 // except according to those terms.
  10
  11 use prelude::v1::*;
  12
  13 use cell::UnsafeCell;
  14 use error::{Error, FromError};
  15 use fmt;
  16 use thread::Thread;
  17
  18 pub struct Flag { failed: UnsafeCell<bool> }
  19 pub const FLAG_INIT: Flag = Flag { failed: UnsafeCell { value: false } };
  20
  21 impl Flag {
  22     #[inline]
  23     pub fn borrow(&self) -> LockResult<Guard> {
  24         let ret = Guard { panicking: Thread::panicking() };
  25         if unsafe { *self.failed.get() } {
  26             Err(new_poison_error(ret))
  27         } else {
  28             Ok(ret)
  29         }
  30     }
  31
  32     #[inline]
  33     pub fn done(&self, guard: &Guard) {
  34         if !guard.panicking && Thread::panicking() {
  35             unsafe { *self.failed.get() = true; }
  36         }
  37     }
  38
  39     #[inline]
  40     pub fn get(&self) -> bool {
  41         unsafe { *self.failed.get() }
  42     }
  43 }
  44
  45 #[allow(missing_copy_implementations)]
  46 pub struct Guard {
  47     panicking: bool,
  48 }
  49
  50 /// A type of error which can be returned whenever a lock is acquired.
  51 ///
  52 /// Both Mutexes and RwLocks are poisoned whenever a task fails while the lock
  53 /// is held. The precise semantics for when a lock is poisoned is documented on
  54 /// each lock, but once a lock is poisoned then all future acquisitions will
  55 /// return this error.
  56 #[derive(Show)]
  57 #[stable]
  58 pub struct PoisonError<T> {
  59     guard: T,
  60 }
  61
  62 /// An enumeration of possible errors which can occur while calling the
  63 /// `try_lock` method.
  64 #[derive(Show)]
  65 #[stable]
  66 pub enum TryLockError<T> {
  67     /// The lock could not be acquired because another task failed while holding
  68     /// the lock.
  69     #[stable]
  70     Poisoned(PoisonError<T>),
  71     /// The lock could not be acquired at this time because the operation would
  72     /// otherwise block.
  73     #[stable]
  74     WouldBlock,
  75 }
  76
  77 /// A type alias for the result of a lock method which can be poisoned.
  78 ///
  79 /// The `Ok` variant of this result indicates that the primitive was not
  80 /// poisoned, and the `Guard` is contained within. The `Err` variant indicates
  81 /// that the primitive was poisoned. Note that the `Err` variant *also* carries
  82 /// the associated guard, and it can be acquired through the `into_inner`
  83 /// method.
  84 #[stable]
  85 pub type LockResult<Guard> = Result<Guard, PoisonError<Guard>>;
  86
  87 /// A type alias for the result of a nonblocking locking method.
  88 ///
  89 /// For more information, see `LockResult`. A `TryLockResult` doesn't
  90 /// necessarily hold the associated guard in the `Err` type as the lock may not
  91 /// have been acquired for other reasons.
  92 #[stable]
  93 pub type TryLockResult<Guard> = Result<Guard, TryLockError<Guard>>;
  94
  95 #[stable]
  96 impl<T> fmt::Display for PoisonError<T> {
  97     fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
  98         self.description().fmt(f)
  99     }
 100 }
 101
 102 impl<T> Error for PoisonError<T> {
 103     fn description(&self) -> &str {
 104         "poisoned lock: another task failed inside"
 105     }
 106 }
 107
 108 impl<T> PoisonError<T> {
 109     /// Consumes this error indicating that a lock is poisoned, returning the
 110     /// underlying guard to allow access regardless.
 111     #[deprecated="renamed to into_inner"]
 112     pub fn into_guard(self) -> T { self.guard }
 113
 114     /// Consumes this error indicating that a lock is poisoned, returning the
 115     /// underlying guard to allow access regardless.
 116     #[unstable]
 117     pub fn into_inner(self) -> T { self.guard }
 118
 119     /// Reaches into this error indicating that a lock is poisoned, returning a
 120     /// reference to the underlying guard to allow access regardless.
 121     #[unstable]
 122     pub fn get_ref(&self) -> &T { &self.guard }
 123
 124     /// Reaches into this error indicating that a lock is poisoned, returning a
 125     /// mutable reference to the underlying guard to allow access regardless.
 126     #[unstable]
 127     pub fn get_mut(&mut self) -> &mut T { &mut self.guard }
 128 }
 129
 130 impl<T> FromError<PoisonError<T>> for TryLockError<T> {
 131     fn from_error(err: PoisonError<T>) -> TryLockError<T> {
 132         TryLockError::Poisoned(err)
 133     }
 134 }
 135
 136 #[stable]
 137 impl<T> fmt::Display for TryLockError<T> {
 138     fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
 139         self.description().fmt(f)
 140     }
 141 }
 142
 143 impl<T> Error for TryLockError<T> {
 144     fn description(&self) -> &str {
 145         match *self {
 146             TryLockError::Poisoned(ref p) => p.description(),
 147             TryLockError::WouldBlock => "try_lock failed because the operation would block"
 148         }
 149     }
 150
 151     fn cause(&self) -> Option<&Error> {
 152         match *self {
 153             TryLockError::Poisoned(ref p) => Some(p),
 154             _ => None
 155         }
 156     }
 157 }
 158
 159 pub fn new_poison_error<T>(guard: T) -> PoisonError<T> {
 160     PoisonError { guard: guard }
 161 }
 162
 163 pub fn map_result<T, U, F>(result: LockResult<T>, f: F)
 164                            -> LockResult<U>
 165                            where F: FnOnce(T) -> U {
 166     match result {
 167         Ok(t) => Ok(f(t)),
 168         Err(PoisonError { guard }) => Err(new_poison_error(f(guard)))
 169     }
 170 }