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         typedef Mutex mutex_type;
  78         /*! \brief The constructor, which locks the mutex.
  79
  80             \param m The exisiting (globally accessible) mutex to lock. */
  81         explicit lock_guard(mutex_type &m) : m_(m)
  82         {
  83             m_.lock();
  84         }
  85         //lock_guard(mutex_type &m, adopt_lock_t t);
  86
  87         /*! \brief The destructor, which unlocks the mutex */
  88         ~lock_guard()
  89         {
  90             m_.unlock();
  91         }
  92     private:
  93         // forbid copy constructor & assignment
  94         lock_guard(const lock_guard &l);
  95         lock_guard &operator=(const lock_guard &l);
  96
  97         mutex_type &m_;
  98 };
  99
 100 /*! \brief A basic mutex class with C++11 compatibility.  */
 101 class TMPI_EXPORT mutex
 102 {
 103     public:
 104         typedef tMPI_Thread_mutex_t* native_handle_type;
 105
 106         /*! \brief The constructor.
 107
 108            Throws a tMPI::system_error exception upon failure. */
 109         mutex()
 110         {
 111             int ret = tMPI_Thread_mutex_init(&handle_);
 112             if (ret)
 113             {
 114                 throw system_error(ret);
 115             }
 116         }
 117
 118         /*! \brief The destructor.*/
 119         ~mutex()
 120         {
 121             tMPI_Thread_mutex_destroy(&handle_);
 122         }
 123
 124         /*! \brief The lock function.
 125
 126            Throws a tMPI::system_error exception upon failure. */
 127         void lock()
 128         {
 129             int ret = tMPI_Thread_mutex_lock(&handle_);
 130             if (ret)
 131             {
 132                 throw system_error(ret);
 133             }
 134         }
 135
 136         /*! \brief The try_lock function.
 137
 138            Throws a tMPI::system_error exception upon failure.
 139            \return true if the lock was locked successfully, false if not*/
 140         bool try_lock()
 141         {
 142             if (tMPI_Thread_mutex_trylock(&handle_))
 143             {
 144                 return false;
 145             }
 146             return true;
 147         }
 148
 149         /*! \brief The unlock function.
 150
 151            Throws a tMPI::system_error exception upon failure. */
 152         void unlock()
 153         {
 154             int ret = tMPI_Thread_mutex_unlock(&handle_);
 155             if (ret)
 156             {
 157                 throw system_error(ret);
 158             }
 159         }
 160
 161         native_handle_type native_handle() { return &handle_; }
 162     private:
 163         // forbid copy constructor & assignment
 164         mutex(const mutex &m);
 165         mutex &operator=(const mutex &m);
 166
 167         tMPI_Thread_mutex_t handle_;
 168 };
 169 }
 170
 171 #endif /* __cplusplus */
 172
 173 #endif /* TMPI_MUTEX_H_ */