src/kernel/activity/MutexImpl.hpp

   1 /* Copyright (c) 2012-2022. 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_KERNEL_ACTIVITY_MUTEX_HPP
   7 #define SIMGRID_KERNEL_ACTIVITY_MUTEX_HPP
   8
   9 #include "simgrid/s4u/Mutex.hpp"
  10 #include "src/kernel/activity/ActivityImpl.hpp"
  11 #include "src/kernel/actor/ActorImpl.hpp"
  12 #include <boost/intrusive/list.hpp>
  13
  14 namespace simgrid {
  15 namespace kernel {
  16 namespace activity {
  17
  18 /** Mutex Acquisition: the act / process of acquiring the mutex.
  19  *
  20  * You can declare some interest on a mutex without being blocked waiting if it's already occupied.
  21  * If it gets freed by its current owned, you become the new owner, even if you're still not blocked on it.
  22  * Nobody can lock it behind your back or overpass you in the queue in any way, even if you're still not blocked on it.
  23  *
  24  * Afterward, when you do consider the lock, the test() or wait() operations are both non-blocking since you're the
  25  * owner. People who declared interest in the mutex after you get stuck in the queue behind you.
  26  *
  27  *
  28  * Splitting the locking process this way is interesting for symmetry with the other activities such as exec or
  29  * communication that do have an async variant and could be mildly interesting to the users once exposed in S4U, but
  30  * that's not the only reason. It's also very important to the MC world: the Mutex::lock_async() is always enabled
  31  * (nothing can prevent you from adding yourself to the queue of potential owners) while Acquisition::wait() is
  32  * persistent: it's not always enabled but once it gets enabled (because you're the owner), it remains enabled for ever.
  33  *
  34  * Mutex::lock() is not persistent: sometimes it's enabled if the mutex is free, and then it gets disabled if
  35  * someone else locks the mutex, and then it becomes enabled again once the mutex is freed. This is why Mutex::lock()
  36  * is not used in our MC computational model: we ban non-persistent transitions because they would make some
  37  * computations much more complex.
  38  *
  39  * In particular, computing the extension of an unfolding's configuration is polynomial when you only have persistent
  40  * transitions while it's O(2^n) when some of the transitions are non-persistent (you have to consider again all subsets
  41  * of a set if some transitions may become disabled in between, while you don't have to reconsider them if you can reuse
  42  * your previous computations).
  43  */
  44 class XBT_PUBLIC MutexAcquisitionImpl
  45     : public ActivityImpl_T<MutexAcquisitionImpl> { // Acquisition: n. The act or process of acquiring.
  46   actor::ActorImpl* issuer_ = nullptr;
  47   MutexImpl* mutex_         = nullptr;
  48
  49 public:
  50   MutexAcquisitionImpl(actor::ActorImpl* issuer, MutexImpl* mutex) : issuer_(issuer), mutex_(mutex) {}
  51   MutexImplPtr get_mutex() { return mutex_; }
  52   actor::ActorImpl* get_issuer() { return issuer_; }
  53
  54   bool test(actor::ActorImpl* issuer = nullptr) override;
  55   void wait_for(actor::ActorImpl* issuer, double timeout) override;
  56   void post() override
  57   { /*no surf action*/
  58   }
  59   void finish() override;
  60   void set_exception(actor::ActorImpl* issuer) override
  61   { /* nothing to do */
  62   }
  63 };
  64
  65 class XBT_PUBLIC MutexImpl {
  66   std::atomic_int_fast32_t refcount_{1};
  67   s4u::Mutex piface_;
  68   actor::ActorImpl* owner_ = nullptr;
  69   // List of sleeping actors:
  70   std::deque<MutexAcquisitionImplPtr> sleeping_;
  71   static unsigned next_id_;
  72   unsigned id_;
  73
  74   friend MutexAcquisitionImpl;
  75
  76 public:
  77   MutexImpl() : piface_(this), id_(next_id_++) {}
  78   MutexImpl(MutexImpl const&) = delete;
  79   MutexImpl& operator=(MutexImpl const&) = delete;
  80
  81   MutexAcquisitionImplPtr lock_async(actor::ActorImpl* issuer);
  82   bool try_lock(actor::ActorImpl* issuer);
  83   void unlock(actor::ActorImpl* issuer);
  84   unsigned get_id() const { return id_; }
  85
  86   actor::ActorImpl* get_owner() const { return owner_; }
  87
  88   // boost::intrusive_ptr<Mutex> support:
  89   friend void intrusive_ptr_add_ref(MutexImpl* mutex)
  90   {
  91     XBT_ATTRIB_UNUSED auto previous = mutex->refcount_.fetch_add(1);
  92     xbt_assert(previous != 0);
  93   }
  94
  95   friend void intrusive_ptr_release(MutexImpl* mutex)
  96   {
  97     if (mutex->refcount_.fetch_sub(1) == 1)
  98       delete mutex;
  99   }
 100
 101   s4u::Mutex& mutex() { return piface_; }
 102 };
 103 } // namespace activity
 104 } // namespace kernel
 105 } // namespace simgrid
 106 #endif