src/kernel/activity/MutexImpl.cpp

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