src/kernel/activity/SemaphoreImpl.cpp

   1 /* Copyright (c) 2019-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 <simgrid/Exception.hpp>
   7 #include <simgrid/s4u/Host.hpp>
   8
   9 #include "src/kernel/activity/SemaphoreImpl.hpp"
  10 #include "src/kernel/activity/Synchro.hpp"
  11 #include "src/kernel/actor/SynchroObserver.hpp"
  12 #include "src/kernel/resource/CpuImpl.hpp"
  13
  14 #include <cmath> // std::isfinite
  15
  16 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(ker_semaphore, ker_synchro, "Semaphore kernel-space implementation");
  17
  18 namespace simgrid::kernel::activity {
  19
  20 /* -------- Acquisition -------- */
  21
  22 void SemAcquisitionImpl::wait_for(actor::ActorImpl* issuer, double timeout)
  23 {
  24   xbt_assert(std::isfinite(timeout), "timeout is not finite!");
  25   xbt_assert(issuer == issuer_, "Cannot wait on acquisitions created by another actor (id %ld)", issuer_->get_pid());
  26
  27   XBT_DEBUG("Wait semaphore %p (timeout:%f)", this, timeout);
  28
  29   this->register_simcall(&issuer_->simcall_); // Block on that acquisition
  30
  31   if (granted_) {
  32     post();
  33   } else if (timeout > 0) {
  34     model_action_ = get_issuer()->get_host()->get_cpu()->sleep(timeout);
  35     model_action_->set_activity(this);
  36
  37   } else {
  38     // Already in the queue
  39   }
  40 }
  41 void SemAcquisitionImpl::post()
  42 {
  43   finish();
  44 }
  45 void SemAcquisitionImpl::finish()
  46 {
  47   xbt_assert(simcalls_.size() == 1, "Unexpected number of simcalls waiting: %zu", simcalls_.size());
  48   actor::Simcall* simcall = simcalls_.front();
  49   simcalls_.pop_front();
  50
  51   if (model_action_ != nullptr) {                                          // A timeout was declared
  52     if (model_action_->get_state() == resource::Action::State::FINISHED) { // The timeout elapsed
  53       if (granted_) { // but we got the semaphore, just in time!
  54         set_state(State::DONE);
  55
  56       } else { // we have to report that timeout
  57         cancel(); // Unregister the acquisition from the semaphore
  58
  59         /* Return to the englobing simcall that the wait_for timeouted */
  60         auto* observer = dynamic_cast<kernel::actor::SemaphoreAcquisitionObserver*>(get_issuer()->simcall_.observer_);
  61         xbt_assert(observer != nullptr);
  62         observer->set_result(true);
  63       }
  64     }
  65     model_action_->unref();
  66     model_action_ = nullptr;
  67   }
  68
  69   simcall->issuer_->waiting_synchro_ = nullptr;
  70   simcall->issuer_->simcall_answer();
  71 }
  72 void SemAcquisitionImpl::cancel()
  73 {
  74   /* Remove myself from the list of interested parties */
  75   auto issuer = get_issuer();
  76   auto it     = std::find_if(semaphore_->ongoing_acquisitions_.begin(), semaphore_->ongoing_acquisitions_.end(),
  77                              [issuer](SemAcquisitionImplPtr acqui) { return acqui->get_issuer() == issuer; });
  78   xbt_assert(it != semaphore_->ongoing_acquisitions_.end(),
  79              "Cannot find myself in the waiting queue that I have to leave");
  80   semaphore_->ongoing_acquisitions_.erase(it);
  81 }
  82
  83 /* -------- Semaphore -------- */
  84 unsigned SemaphoreImpl::next_id_ = 0;
  85
  86 SemAcquisitionImplPtr SemaphoreImpl::acquire_async(actor::ActorImpl* issuer)
  87 {
  88   auto res = SemAcquisitionImplPtr(new kernel::activity::SemAcquisitionImpl(issuer, this), true);
  89
  90   if (value_ > 0) {
  91     value_--;
  92     res->granted_ = true;
  93   } else {
  94     /* No free token in the semaphore; register the acquisition */
  95     ongoing_acquisitions_.push_back(res);
  96   }
  97   return res;
  98 }
  99 void SemaphoreImpl::release()
 100 {
 101   XBT_DEBUG("Sem release semaphore %p", this);
 102
 103   if (not ongoing_acquisitions_.empty()) {
 104     /* Release the first waiting actor */
 105
 106     auto acqui = ongoing_acquisitions_.front();
 107     ongoing_acquisitions_.pop_front();
 108
 109     acqui->granted_ = true;
 110     if (acqui == acqui->get_issuer()->waiting_synchro_)
 111       acqui->post();
 112     // else, the issuer is not blocked on this acquisition so no need to release it
 113
 114   } else {
 115     // nobody's waiting here
 116     value_++;
 117   }
 118 }
 119
 120 } // namespace simgrid::kernel::activity