include/simgrid/s4u/Mutex.hpp

   1 /* Copyright (c) 2006-2023. 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 <simgrid/forward.h>
  10 #include <xbt/asserts.h>
  11
  12 namespace simgrid::s4u {
  13
  14 /** @brief A classical mutex, but blocking in the simulation world.
  15  *
  16  * S4U mutexes are not recursive. If an actor tries to lock the same object twice, it deadlocks with itself.
  17  *
  18  * @beginrst
  19  * It is strictly impossible to use a real mutex, such as
  20  * `std::mutex <http://en.cppreference.com/w/cpp/thread/mutex>`_
  21  * or `pthread_mutex_t <http://pubs.opengroup.org/onlinepubs/007908775/xsh/pthread_mutex_lock.html>`_,
  22  * because it would block the whole simulation.
  23  * Instead, you should use the present class, that is a drop-in replacement of these mechanisms.
  24  *
  25  * An example is available in Section :ref:`s4u_ex_IPC`.
  26  *
  27  * As for any S4U object, you can use the :ref:`RAII idiom <s4u_raii>` for memory management of Mutexes.
  28  * Use :cpp:func:`create() <simgrid::s4u::Mutex::create()>` to get a :cpp:type:`simgrid::s4u::MutexPtr` to a newly
  29  * created mutex, and only manipulate :cpp:type:`simgrid::s4u::MutexPtr`.
  30  * @endrst
  31  */
  32 class XBT_PUBLIC Mutex {
  33 #ifndef DOXYGEN
  34   friend ConditionVariable;
  35   friend kernel::activity::MutexImpl;
  36   friend XBT_PUBLIC void kernel::activity::intrusive_ptr_release(kernel::activity::MutexImpl* mutex);
  37 #endif
  38
  39   kernel::activity::MutexImpl* const pimpl_;
  40   /* refcounting */
  41   friend XBT_PUBLIC void intrusive_ptr_add_ref(const Mutex* mutex);
  42   friend XBT_PUBLIC void intrusive_ptr_release(const Mutex* mutex);
  43
  44   explicit Mutex(kernel::activity::MutexImpl* mutex) : pimpl_(mutex) {}
  45   ~Mutex() = default;
  46 #ifndef DOXYGEN
  47   Mutex(Mutex const&) = delete;            // No copy constructor; Use MutexPtr instead
  48   Mutex& operator=(Mutex const&) = delete; // No direct assignment either. Use MutexPtr instead
  49 #endif
  50
  51 public:
  52   /** \static Constructs a new mutex */
  53   static MutexPtr create(bool recursive = false);
  54
  55   void lock();
  56   void unlock();
  57   bool try_lock();
  58 };
  59
  60 } // namespace simgrid::s4u
  61
  62 #endif /* SIMGRID_S4U_MUTEX_HPP */