ceph/src/boost/boost/interprocess/sync/interprocess_recursive_mutex.hpp

   1 //////////////////////////////////////////////////////////////////////////////
   2 //
   3 // (C) Copyright Ion Gaztanaga 2005-2012. Distributed under the Boost
   4 // Software License, Version 1.0. (See accompanying file
   5 // LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt)
   6 //
   7 // See http://www.boost.org/libs/interprocess for documentation.
   8 //
   9 //////////////////////////////////////////////////////////////////////////////
  10 //
  11 // Parts of the pthread code come from Boost Threads code:
  12 //
  13 //////////////////////////////////////////////////////////////////////////////
  14 //
  15 // Copyright (C) 2001-2003
  16 // William E. Kempf
  17 //
  18 // Permission to use, copy, modify, distribute and sell this software
  19 // and its documentation for any purpose is hereby granted without fee,
  20 // provided that the above copyright notice appear in all copies and
  21 // that both that copyright notice and this permission notice appear
  22 // in supporting documentation.  William E. Kempf makes no representations
  23 // about the suitability of this software for any purpose.
  24 // It is provided "as is" without express or implied warranty.
  25 //////////////////////////////////////////////////////////////////////////////
  26
  27 #ifndef BOOST_INTERPROCESS_RECURSIVE_MUTEX_HPP
  28 #define BOOST_INTERPROCESS_RECURSIVE_MUTEX_HPP
  29
  30 #if !defined(BOOST_INTERPROCESS_DOXYGEN_INVOKED)
  31
  32 #ifndef BOOST_CONFIG_HPP
  33 #  include <boost/config.hpp>
  34 #endif
  35 #
  36 #if defined(BOOST_HAS_PRAGMA_ONCE)
  37 #  pragma once
  38 #endif
  39
  40 #include <boost/interprocess/detail/config_begin.hpp>
  41 #include <boost/interprocess/detail/workaround.hpp>
  42 #include <boost/interprocess/detail/posix_time_types_wrk.hpp>
  43 #include <boost/interprocess/sync/detail/common_algorithms.hpp>
  44 #include <boost/assert.hpp>
  45
  46 #if !defined(BOOST_INTERPROCESS_FORCE_GENERIC_EMULATION) && \
  47    (defined(BOOST_INTERPROCESS_POSIX_PROCESS_SHARED) && defined (BOOST_INTERPROCESS_POSIX_RECURSIVE_MUTEXES))
  48    #include <boost/interprocess/sync/posix/recursive_mutex.hpp>
  49    #define BOOST_INTERPROCESS_USE_POSIX
  50 //Experimental...
  51 #elif !defined(BOOST_INTERPROCESS_FORCE_GENERIC_EMULATION) && defined (BOOST_INTERPROCESS_WINDOWS)
  52    #include <boost/interprocess/sync/windows/recursive_mutex.hpp>
  53    #define BOOST_INTERPROCESS_USE_WINDOWS
  54 #elif !defined(BOOST_INTERPROCESS_DOXYGEN_INVOKED)
  55    #include <boost/interprocess/sync/spin/recursive_mutex.hpp>
  56    #define BOOST_INTERPROCESS_USE_GENERIC_EMULATION
  57 #endif
  58
  59 #if defined (BOOST_INTERPROCESS_USE_GENERIC_EMULATION)
  60 namespace boost {
  61 namespace interprocess {
  62 namespace ipcdetail{
  63 namespace robust_emulation_helpers {
  64
  65 template<class T>
  66 class mutex_traits;
  67
  68 }}}}
  69
  70 #endif
  71
  72 #endif   //#ifndef BOOST_INTERPROCESS_DOXYGEN_INVOKED
  73
  74 //!\file
  75 //!Describes interprocess_recursive_mutex and shared_recursive_try_mutex classes
  76
  77 namespace boost {
  78 namespace interprocess {
  79
  80 //!Wraps a interprocess_mutex that can be placed in shared memory and can be
  81 //!shared between processes. Allows several locking calls by the same
  82 //!process. Allows timed lock tries
  83 class interprocess_recursive_mutex
  84 {
  85    #if !defined(BOOST_INTERPROCESS_DOXYGEN_INVOKED)
  86    //Non-copyable
  87    interprocess_recursive_mutex(const interprocess_recursive_mutex &);
  88    interprocess_recursive_mutex &operator=(const interprocess_recursive_mutex &);
  89    #endif   //#ifndef BOOST_INTERPROCESS_DOXYGEN_INVOKED
  90    public:
  91    //!Constructor.
  92    //!Throws interprocess_exception on error.
  93    interprocess_recursive_mutex();
  94
  95    //!Destructor. If any process uses the mutex after the destructor is called
  96    //!the result is undefined. Does not throw.
  97   ~interprocess_recursive_mutex();
  98
  99    //!Effects: The calling thread tries to obtain ownership of the mutex, and
 100    //!   if another thread has ownership of the mutex, it waits until it can
 101    //!   obtain the ownership. If a thread takes ownership of the mutex the
 102    //!   mutex must be unlocked by the same mutex. The mutex must be unlocked
 103    //!   the same number of times it is locked.
 104    //!Throws: interprocess_exception on error.
 105    void lock();
 106
 107    //!Tries to lock the interprocess_mutex, returns false when interprocess_mutex
 108    //!is already locked, returns true when success. The mutex must be unlocked
 109    //!the same number of times it is locked.
 110    //!Throws: interprocess_exception if a severe error is found
 111    bool try_lock();
 112
 113    //!Tries to lock the interprocess_mutex, if interprocess_mutex can't be locked before
 114    //!abs_time time, returns false. The mutex must be unlocked
 115    //!   the same number of times it is locked.
 116    //!Throws: interprocess_exception if a severe error is found
 117    bool timed_lock(const boost::posix_time::ptime &abs_time);
 118
 119    //!Effects: The calling thread releases the exclusive ownership of the mutex.
 120    //!   If the mutex supports recursive locking, the mutex must be unlocked the
 121    //!   same number of times it is locked.
 122    //!Throws: interprocess_exception on error.
 123    void unlock();
 124    #if !defined(BOOST_INTERPROCESS_DOXYGEN_INVOKED)
 125    private:
 126
 127    #if defined (BOOST_INTERPROCESS_USE_GENERIC_EMULATION)
 128       #undef BOOST_INTERPROCESS_USE_GENERIC_EMULATION
 129       void take_ownership(){ mutex.take_ownership(); }
 130       friend class ipcdetail::robust_emulation_helpers::mutex_traits<interprocess_recursive_mutex>;
 131       ipcdetail::spin_recursive_mutex mutex;
 132    #elif defined(BOOST_INTERPROCESS_USE_POSIX)
 133       #undef BOOST_INTERPROCESS_USE_POSIX
 134       ipcdetail::posix_recursive_mutex mutex;
 135    #elif defined(BOOST_INTERPROCESS_USE_WINDOWS)
 136       #undef BOOST_INTERPROCESS_USE_WINDOWS
 137       ipcdetail::windows_recursive_mutex mutex;
 138    #else
 139       #error "Unknown platform for interprocess_mutex"
 140    #endif
 141    #endif   //#ifndef BOOST_INTERPROCESS_DOXYGEN_INVOKED
 142 };
 143
 144 }  //namespace interprocess {
 145 }  //namespace boost {
 146
 147 namespace boost {
 148 namespace interprocess {
 149
 150 inline interprocess_recursive_mutex::interprocess_recursive_mutex(){}
 151
 152 inline interprocess_recursive_mutex::~interprocess_recursive_mutex(){}
 153
 154 inline void interprocess_recursive_mutex::lock()
 155 {  ipcdetail::timeout_when_locking_aware_lock(mutex);  }
 156
 157 inline bool interprocess_recursive_mutex::try_lock()
 158 { return mutex.try_lock(); }
 159
 160 inline bool interprocess_recursive_mutex::timed_lock(const boost::posix_time::ptime &abs_time)
 161 { return mutex.timed_lock(abs_time); }
 162
 163 inline void interprocess_recursive_mutex::unlock()
 164 { mutex.unlock(); }
 165
 166 }  //namespace interprocess {
 167 }  //namespace boost {
 168
 169 #include <boost/interprocess/detail/config_end.hpp>
 170
 171 #endif   //BOOST_INTERPROCESS_RECURSIVE_MUTEX_HPP