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     finish();
  29   } else {
  30     // Already in the queue
  31   }
  32 }
  33
  34 void MutexAcquisitionImpl::finish()
  35 {
  36   xbt_assert(simcalls_.size() == 1, "Unexpected number of simcalls waiting: %zu", simcalls_.size());
  37   actor::Simcall* simcall = simcalls_.front();
  38   simcalls_.pop_front();
  39
  40   simcall->issuer_->waiting_synchro_ = nullptr;
  41   simcall->issuer_->simcall_answer();
  42 }
  43
  44 /* -------- Mutex -------- */
  45
  46 unsigned MutexImpl::next_id_ = 0;
  47
  48 MutexAcquisitionImplPtr MutexImpl::lock_async(actor::ActorImpl* issuer)
  49 {
  50   auto res = MutexAcquisitionImplPtr(new kernel::activity::MutexAcquisitionImpl(issuer, this), true);
  51
  52   if (owner_ != nullptr) {
  53     /* Somebody is using the mutex; register the acquisition */
  54     ongoing_acquisitions_.push_back(res);
  55   } else {
  56     owner_  = issuer;
  57   }
  58   return res;
  59 }
  60
  61 /** Tries to lock the mutex for a actor
  62  *
  63  * @param  issuer  the actor that tries to acquire the mutex
  64  * @return whether we managed to lock the mutex
  65  */
  66 bool MutexImpl::try_lock(actor::ActorImpl* issuer)
  67 {
  68   XBT_IN("(%p, %p)", this, issuer);
  69   if (owner_ != nullptr) {
  70     XBT_OUT();
  71     return false;
  72   }
  73
  74   owner_  = issuer;
  75   XBT_OUT();
  76   return true;
  77 }
  78
  79 /** Unlock a mutex for a actor
  80  *
  81  * Unlocks the mutex and gives it to a actor waiting for it.
  82  * If the unlocker is not the owner of the mutex nothing happens.
  83  * If there are no actor waiting, it sets the mutex as free.
  84  */
  85 void MutexImpl::unlock(actor::ActorImpl* issuer)
  86 {
  87   XBT_IN("(%p, %p)", this, issuer);
  88   xbt_assert(issuer == owner_, "Cannot release that mutex: you're not the owner. %s is (pid:%ld).",
  89              owner_ != nullptr ? owner_->get_cname() : "(nobody)", owner_ != nullptr ? owner_->get_pid() : -1);
  90
  91   if (not ongoing_acquisitions_.empty()) {
  92     /* Give the ownership to the first waiting actor */
  93     auto acq = ongoing_acquisitions_.front();
  94     ongoing_acquisitions_.pop_front();
  95
  96     owner_ = acq->get_issuer();
  97     if (acq == owner_->waiting_synchro_)
  98       acq->finish();
  99     // else, the issuer is not blocked on this acquisition so no need to release it
 100
 101   } else {
 102     /* nobody to wake up */
 103     owner_  = nullptr;
 104   }
 105   XBT_OUT();
 106 }
 107
 108 } // namespace simgrid::kernel::activity