src/gromacs/legacyheaders/thread_mpi/mutex.h

   1 /*
   2    This source code file is part of thread_mpi.
   3    Written by Sander Pronk, Erik Lindahl, and possibly others.
   4
   5    Copyright (c) 2009, Sander Pronk, Erik Lindahl.
   6    All rights reserved.
   7
   8    Redistribution and use in source and binary forms, with or without
   9    modification, are permitted provided that the following conditions are met:
  10    1) Redistributions of source code must retain the above copyright
  11    notice, this list of conditions and the following disclaimer.
  12    2) Redistributions in binary form must reproduce the above copyright
  13    notice, this list of conditions and the following disclaimer in the
  14    documentation and/or other materials provided with the distribution.
  15    3) Neither the name of the copyright holders nor the
  16    names of its contributors may be used to endorse or promote products
  17    derived from this software without specific prior written permission.
  18
  19    THIS SOFTWARE IS PROVIDED BY US ''AS IS'' AND ANY
  20    EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
  21    WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
  22    DISCLAIMED. IN NO EVENT SHALL WE BE LIABLE FOR ANY
  23    DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
  24    (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
  25    LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
  26    ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  27    (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
  28    SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  29
  30    If you want to redistribute modifications, please consider that
  31    scientific software is very special. Version control is crucial -
  32    bugs must be traceable. We will be happy to consider code for
  33    inclusion in the official distribution, but derived work should not
  34    be called official thread_mpi. Details are found in the README & COPYING
  35    files.
  36  */
  37
  38 /** \file
  39  *
  40  * \brief mutex objects with C++11 API compatibility.
  41  *
  42  * This header contains classes mutex and lock_guard, used in C++ mutex
  43  * implementations safe for exceptions.
  44  */
  45
  46 #ifndef TMPI_MUTEX_H_
  47 #define TMPI_MUTEX_H_
  48
  49 #include "visibility.h"
  50 #include "system_error.h"
  51 #include "threads.h"
  52
  53 #ifdef __cplusplus
  54
  55
  56 namespace tMPI
  57 {
  58 /*! \brief A lock guard class that allows for the simple management of
  59            mutexes. C++11 compatible.
  60
  61     In C++, mutexes would normally have to be unlocked with explicit
  62     exception handlers and unlock statements. This class automates that
  63     by handling the mutex unlock in a destructor. The constructor locks
  64     the mutex.
  65
  66     Usage example:
  67     tMPI::mutex mtx;
  68     void do_count()
  69     {
  70         tMPI::lock_guard<tMPI::mutex> lock(mtx);
  71         count += 1;
  72     }
  73  */
  74 template <class Mutex> class TMPI_EXPORT lock_guard
  75 {
  76     public:
  77         //! Lockable type that this lock operates on.
  78         typedef Mutex mutex_type;
  79         /*! \brief The constructor, which locks the mutex.
  80
  81             \param m The exisiting (globally accessible) mutex to lock. */
  82         explicit lock_guard(mutex_type &m) : m_(m)
  83         {
  84             m_.lock();
  85         }
  86         //lock_guard(mutex_type &m, adopt_lock_t t);
  87
  88         /*! \brief The destructor, which unlocks the mutex */
  89         ~lock_guard()
  90         {
  91             m_.unlock();
  92         }
  93     private:
  94         // forbid copy constructor & assignment
  95         lock_guard(const lock_guard &l);
  96         lock_guard &operator=(const lock_guard &l);
  97
  98         mutex_type &m_;
  99 };
 100
 101 /*! \brief A basic mutex class with C++11 compatibility.  */
 102 class TMPI_EXPORT mutex
 103 {
 104     public:
 105         //! Type of the native mutex handle.
 106         typedef tMPI_Thread_mutex_t* native_handle_type;
 107
 108         /*! \brief The constructor.
 109
 110            Throws a tMPI::system_error exception upon failure. */
 111         mutex()
 112         {
 113             int ret = tMPI_Thread_mutex_init(&handle_);
 114             if (ret)
 115             {
 116                 throw system_error(ret);
 117             }
 118         }
 119
 120         /*! \brief The destructor.*/
 121         ~mutex()
 122         {
 123             tMPI_Thread_mutex_destroy(&handle_);
 124         }
 125
 126         /*! \brief The lock function.
 127
 128            Throws a tMPI::system_error exception upon failure. */
 129         void lock()
 130         {
 131             int ret = tMPI_Thread_mutex_lock(&handle_);
 132             if (ret)
 133             {
 134                 throw system_error(ret);
 135             }
 136         }
 137
 138         /*! \brief The try_lock function.
 139
 140            Throws a tMPI::system_error exception upon failure.
 141            \return true if the lock was locked successfully, false if not*/
 142         bool try_lock()
 143         {
 144             if (tMPI_Thread_mutex_trylock(&handle_))
 145             {
 146                 return false;
 147             }
 148             return true;
 149         }
 150
 151         /*! \brief The unlock function.
 152
 153            Throws a tMPI::system_error exception upon failure. */
 154         void unlock()
 155         {
 156             int ret = tMPI_Thread_mutex_unlock(&handle_);
 157             if (ret)
 158             {
 159                 throw system_error(ret);
 160             }
 161         }
 162
 163         //! Returns the native handle for this mutex.
 164         native_handle_type native_handle() { return &handle_; }
 165     private:
 166         // forbid copy constructor & assignment
 167         mutex(const mutex &m);
 168         mutex &operator=(const mutex &m);
 169
 170         tMPI_Thread_mutex_t handle_;
 171 };
 172 }
 173
 174 #endif /* __cplusplus */
 175
 176 #endif /* TMPI_MUTEX_H_ */