src/kernel/activity/MutexImpl.cpp

   1 /* Copyright (c) 2007-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 #include "src/kernel/activity/MutexImpl.hpp"
   7 #include "src/kernel/activity/Synchro.hpp"
   8
   9 #if SIMGRID_HAVE_MC
  10 #include "simgrid/modelchecker.h"
  11 #include "src/mc/mc_safety.hpp"
  12 #define MC_CHECK_NO_DPOR()                                                                                             \
  13   xbt_assert(not MC_is_active() || mc::reduction_mode != mc::ReductionMode::dpor,                                      \
  14              "Mutex is currently not supported with DPOR,  use --cfg=model-check/reduction:none")
  15 #else
  16 #define MC_CHECK_NO_DPOR() (void)0
  17 #endif
  18
  19 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(ker_mutex, ker_synchro, "Mutex kernel-space implementation");
  20
  21 namespace simgrid {
  22 namespace kernel {
  23 namespace activity {
  24
  25 /* -------- Acquisition -------- */
  26
  27 bool MutexAcquisitionImpl::test(actor::ActorImpl*)
  28 {
  29   return mutex_->owner_ == issuer_;
  30 }
  31 void MutexAcquisitionImpl::wait_for(actor::ActorImpl* issuer, double timeout)
  32 {
  33   xbt_assert(mutex_->owner_ != nullptr); // it was locked either by someone else or by me during the lock_async
  34   xbt_assert(issuer == issuer_, "Cannot wait on acquisitions created by another actor (id %ld)", issuer_->get_pid());
  35   xbt_assert(timeout < 0, "Timeouts on mutex acquisitions are not implemented yet.");
  36
  37   this->register_simcall(&issuer_->simcall_); // Block on that acquisition
  38
  39   if (mutex_->get_owner() == issuer_) { // I'm the owner
  40     finish();
  41   } else {
  42     // Already in the queue
  43   }
  44 }
  45 void MutexAcquisitionImpl::finish()
  46 {
  47   xbt_assert(simcalls_.size() == 1, "Unexpected number of simcalls waiting: %zu", simcalls_.size());
  48   smx_simcall_t simcall = simcalls_.front();
  49   simcalls_.pop_front();
  50
  51   simcall->issuer_->waiting_synchro_ = nullptr;
  52   simcall->issuer_->simcall_answer();
  53 }
  54
  55 /* -------- Mutex -------- */
  56
  57 unsigned MutexImpl::next_id_ = 0;
  58
  59 MutexAcquisitionImplPtr MutexImpl::lock_async(actor::ActorImpl* issuer)
  60 {
  61   auto res = MutexAcquisitionImplPtr(new kernel::activity::MutexAcquisitionImpl(issuer, this), true);
  62
  63   if (owner_ != nullptr) {
  64     /* Somebody is using the mutex; register the acquisition */
  65     ongoing_acquisitions_.push_back(res);
  66   } else {
  67     owner_  = issuer;
  68   }
  69   return res;
  70 }
  71
  72 /** Tries to lock the mutex for a actor
  73  *
  74  * @param  issuer  the actor that tries to acquire the mutex
  75  * @return whether we managed to lock the mutex
  76  */
  77 bool MutexImpl::try_lock(actor::ActorImpl* issuer)
  78 {
  79   XBT_IN("(%p, %p)", this, issuer);
  80   MC_CHECK_NO_DPOR();
  81   if (owner_ != nullptr) {
  82     XBT_OUT();
  83     return false;
  84   }
  85
  86   owner_  = issuer;
  87   XBT_OUT();
  88   return true;
  89 }
  90
  91 /** Unlock a mutex for a actor
  92  *
  93  * Unlocks the mutex and gives it to a actor waiting for it.
  94  * If the unlocker is not the owner of the mutex nothing happens.
  95  * If there are no actor waiting, it sets the mutex as free.
  96  */
  97 void MutexImpl::unlock(actor::ActorImpl* issuer)
  98 {
  99   XBT_IN("(%p, %p)", this, issuer);
 100   xbt_assert(issuer == owner_, "Cannot release that mutex: you're not the owner. %s is (pid:%ld).",
 101              owner_ != nullptr ? owner_->get_cname() : "(nobody)", owner_ != nullptr ? owner_->get_pid() : -1);
 102
 103   if (not ongoing_acquisitions_.empty()) {
 104     /* Give the ownership to the first waiting actor */
 105     auto acq = ongoing_acquisitions_.front();
 106     ongoing_acquisitions_.pop_front();
 107
 108     owner_ = acq->get_issuer();
 109     if (acq == owner_->waiting_synchro_)
 110       acq->finish();
 111     // else, the issuer is not blocked on this acquisition so no need to release it
 112
 113   } else {
 114     /* nobody to wake up */
 115     owner_  = nullptr;
 116   }
 117   XBT_OUT();
 118 }
 119
 120 } // namespace activity
 121 } // namespace kernel
 122 } // namespace simgrid