src/s4u/s4u_ConditionVariable.cpp

   1 /* Copyright (c) 2006-2021. 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/cond.h"
   7 #include "simgrid/forward.h"
   8 #include "simgrid/s4u/ConditionVariable.hpp"
   9 #include "simgrid/simix.h"
  10 #include "src/kernel/activity/ConditionVariableImpl.hpp"
  11 #include "src/mc/checker/SimcallObserver.hpp"
  12 #include "xbt/log.hpp"
  13
  14 #include <exception>
  15 #include <mutex>
  16
  17 namespace simgrid {
  18 namespace s4u {
  19
  20 ConditionVariablePtr ConditionVariable::create()
  21 {
  22   kernel::activity::ConditionVariableImpl* cond =
  23       kernel::actor::simcall([] { return new kernel::activity::ConditionVariableImpl(); });
  24   return ConditionVariablePtr(cond->get_iface(), false);
  25 }
  26
  27 /**
  28  * Wait functions
  29  */
  30 void ConditionVariable::wait(MutexPtr lock)
  31 {
  32   kernel::actor::ActorImpl* issuer = kernel::actor::ActorImpl::self();
  33   mc::ConditionWaitSimcall observer{issuer, pimpl_, lock->pimpl_};
  34   kernel::actor::simcall_blocking<void>(
  35       [&observer] { observer.get_cond()->wait(observer.get_mutex(), -1.0, observer.get_issuer()); }, &observer);
  36 }
  37
  38 void ConditionVariable::wait(const std::unique_lock<Mutex>& lock)
  39 {
  40   kernel::actor::ActorImpl* issuer = kernel::actor::ActorImpl::self();
  41   mc::ConditionWaitSimcall observer{issuer, pimpl_, lock.mutex()->pimpl_};
  42   kernel::actor::simcall_blocking<void>(
  43       [&observer] { observer.get_cond()->wait(observer.get_mutex(), -1.0, observer.get_issuer()); }, &observer);
  44 }
  45
  46 std::cv_status s4u::ConditionVariable::wait_for(const std::unique_lock<Mutex>& lock, double timeout)
  47 {
  48   // The simcall uses -1 for "any timeout" but we don't want this:
  49   if (timeout < 0)
  50     timeout = 0.0;
  51
  52   if (simcall_cond_wait_timeout(pimpl_, lock.mutex()->pimpl_, timeout)) {
  53     // If we reached the timeout, we have to take the lock again:
  54     lock.mutex()->lock();
  55     return std::cv_status::timeout;
  56   } else {
  57     return std::cv_status::no_timeout;
  58   }
  59 }
  60
  61 std::cv_status ConditionVariable::wait_until(const std::unique_lock<Mutex>& lock, double timeout_time)
  62 {
  63   double now = SIMIX_get_clock();
  64   double timeout;
  65   if (timeout_time < now)
  66     timeout = 0.0;
  67   else
  68     timeout = timeout_time - now;
  69   return this->wait_for(lock, timeout);
  70 }
  71
  72 /**
  73  * Notify functions
  74  */
  75 void ConditionVariable::notify_one()
  76 {
  77   simgrid::kernel::actor::simcall([this]() { pimpl_->signal(); });
  78 }
  79
  80 void ConditionVariable::notify_all()
  81 {
  82   simgrid::kernel::actor::simcall([this]() { pimpl_->broadcast(); });
  83 }
  84
  85 void intrusive_ptr_add_ref(const ConditionVariable* cond)
  86 {
  87   intrusive_ptr_add_ref(cond->pimpl_);
  88 }
  89
  90 void intrusive_ptr_release(const ConditionVariable* cond)
  91 {
  92   intrusive_ptr_release(cond->pimpl_);
  93 }
  94
  95 } // namespace s4u
  96 } // namespace simgrid
  97
  98 /* **************************** Public C interface *************************** */
  99 sg_cond_t sg_cond_init()
 100 {
 101   return simgrid::s4u::ConditionVariable::create().detach();
 102 }
 103
 104 void sg_cond_wait(sg_cond_t cond, sg_mutex_t mutex)
 105 {
 106   cond->wait(mutex);
 107 }
 108
 109 int sg_cond_wait_for(sg_cond_t cond, sg_mutex_t mutex, double delay)
 110 {
 111   std::unique_lock<simgrid::s4u::Mutex> lock(*mutex);
 112   return cond->wait_for(lock, delay) == std::cv_status::timeout ? 1 : 0;
 113 }
 114
 115 void sg_cond_notify_one(sg_cond_t cond)
 116 {
 117   cond->notify_one();
 118 }
 119
 120 void sg_cond_notify_all(sg_cond_t cond)
 121 {
 122   cond->notify_all();
 123 }
 124
 125 void sg_cond_destroy(const_sg_cond_t cond)
 126 {
 127   intrusive_ptr_release(cond);
 128 }