include/simgrid/s4u/Mutex.hpp

   1 /* Copyright (c) 2006-2015. The SimGrid Team. All rights reserved.          */
   2
   3 /* This program is free software; you can redistribute it and/or modify it
   4  * under the terms of the license (GNU LGPL) which comes with this package. */
   5
   6 #ifndef SIMGRID_S4U_MUTEX_HPP
   7 #define SIMGRID_S4U_MUTEX_HPP
   8
   9 #include <mutex>
  10 #include <utility>
  11
  12 #include <boost/intrusive_ptr.hpp>
  13
  14 #include <xbt/base.h>
  15 #include "simgrid/simix.h"
  16
  17 namespace simgrid {
  18 namespace s4u {
  19
  20 class ConditionVariable;
  21
  22 /** @brief A classical mutex, but blocking in the simulation world
  23  *
  24  * It is strictly impossible to use a real mutex (such as
  25  * [std::mutex](http://en.cppreference.com/w/cpp/thread/mutex)
  26  * or [pthread_mutex_t](http://pubs.opengroup.org/onlinepubs/007908775/xsh/pthread_mutex_lock.html)),
  27  * because it would block the whole simulation.
  28  * Instead, you should use the present class, that is a drop-in replacement of
  29  * [std::mutex](http://en.cppreference.com/w/cpp/thread/mutex).
  30  *
  31  * As for any S4U object, Mutexes are using the @ref "RAII idiom" s4u_raii for memory management.
  32  * Use createMutex() to get a ::MutexPtr to a newly created mutex and only manipulate ::MutexPtr.
  33  *
  34  */
  35 XBT_PUBLIC_CLASS Mutex {
  36   friend ConditionVariable;
  37   friend simgrid::simix::Mutex;
  38   simgrid::simix::Mutex* mutex_;
  39   Mutex(simgrid::simix::Mutex* mutex) : mutex_(mutex) {}
  40
  41   /* refcounting of the intrusive_ptr is delegated to the implementation object */
  42   friend void intrusive_ptr_add_ref(Mutex* mutex)
  43   {
  44     xbt_assert(mutex);
  45     SIMIX_mutex_ref(mutex->mutex_);
  46   }
  47   friend void intrusive_ptr_release(Mutex* mutex)
  48   {
  49     xbt_assert(mutex);
  50     SIMIX_mutex_unref(mutex->mutex_);
  51   }
  52 public:
  53   using Ptr = boost::intrusive_ptr<Mutex>;
  54
  55   // No copy:
  56   /** You cannot create a new mutex by copying an existing one. Use MutexPtr instead */
  57   Mutex(Mutex const&) = delete;
  58   /** You cannot create a new mutex by value assignment either. Use MutexPtr instead */
  59   Mutex& operator=(Mutex const&) = delete;
  60
  61   /** Constructs a new mutex */
  62   static Ptr createMutex();
  63
  64   void lock();
  65   void unlock();
  66   bool try_lock();
  67 };
  68
  69 using MutexPtr = Mutex::Ptr;
  70
  71 }} // namespace simgrid::s4u
  72
  73 #endif /* SIMGRID_S4U_MUTEX_HPP */