src/libstd/sys_common/mutex.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 sys::mutex as imp;
  12
  13 /// An OS-based mutual exclusion lock.
  14 ///
  15 /// This is the thinnest cross-platform wrapper around OS mutexes. All usage of
  16 /// this mutex is unsafe and it is recommended to instead use the safe wrapper
  17 /// at the top level of the crate instead of this type.
  18 pub struct Mutex(imp::Mutex);
  19
  20 unsafe impl Sync for Mutex {}
  21
  22 impl Mutex {
  23     /// Creates a new mutex for use.
  24     ///
  25     /// Behavior is undefined if the mutex is moved after it is
  26     /// first used with any of the functions below.
  27     /// Also, until `init` is called, behavior is undefined if this
  28     /// mutex is ever used reentrantly, i.e., `raw_lock` or `try_lock`
  29     /// are called by the thread currently holding the lock.
  30     pub const fn new() -> Mutex { Mutex(imp::Mutex::new()) }
  31
  32     /// Prepare the mutex for use.
  33     ///
  34     /// This should be called once the mutex is at a stable memory address.
  35     /// If called, this must be the very first thing that happens to the mutex.
  36     /// Calling it in parallel with or after any operation (including another
  37     /// `init()`) is undefined behavior.
  38     #[inline]
  39     pub unsafe fn init(&mut self) { self.0.init() }
  40
  41     /// Locks the mutex blocking the current thread until it is available.
  42     ///
  43     /// Behavior is undefined if the mutex has been moved between this and any
  44     /// previous function call.
  45     #[inline]
  46     pub unsafe fn raw_lock(&self) { self.0.lock() }
  47
  48     /// Calls raw_lock() and then returns an RAII guard to guarantee the mutex
  49     /// will be unlocked.
  50     #[inline]
  51     pub unsafe fn lock(&self) -> MutexGuard {
  52         self.raw_lock();
  53         MutexGuard(&self.0)
  54     }
  55
  56     /// Attempts to lock the mutex without blocking, returning whether it was
  57     /// successfully acquired or not.
  58     ///
  59     /// Behavior is undefined if the mutex has been moved between this and any
  60     /// previous function call.
  61     #[inline]
  62     pub unsafe fn try_lock(&self) -> bool { self.0.try_lock() }
  63
  64     /// Unlocks the mutex.
  65     ///
  66     /// Behavior is undefined if the current thread does not actually hold the
  67     /// mutex.
  68     ///
  69     /// Consider switching from the pair of raw_lock() and raw_unlock() to
  70     /// lock() whenever possible.
  71     #[inline]
  72     pub unsafe fn raw_unlock(&self) { self.0.unlock() }
  73
  74     /// Deallocates all resources associated with this mutex.
  75     ///
  76     /// Behavior is undefined if there are current or will be future users of
  77     /// this mutex.
  78     #[inline]
  79     pub unsafe fn destroy(&self) { self.0.destroy() }
  80 }
  81
  82 // not meant to be exported to the outside world, just the containing module
  83 pub fn raw(mutex: &Mutex) -> &imp::Mutex { &mutex.0 }
  84
  85 #[must_use]
  86 /// A simple RAII utility for the above Mutex without the poisoning semantics.
  87 pub struct MutexGuard<'a>(&'a imp::Mutex);
  88
  89 impl<'a> Drop for MutexGuard<'a> {
  90     #[inline]
  91     fn drop(&mut self) {
  92         unsafe { self.0.unlock(); }
  93     }
  94 }