src/kernel/activity/ConditionVariableImpl.cpp

   1 /* Copyright (c) 2007-2020. 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/ConditionVariableImpl.hpp"
   7 #include "simgrid/Exception.hpp"
   8 #include "src/kernel/activity/MutexImpl.hpp"
   9 #include "src/kernel/activity/SynchroRaw.hpp"
  10
  11 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(simix_condition, simix_synchro, "Condition variables");
  12
  13 /********************************* Condition **********************************/
  14
  15 /** @brief Handle a condition waiting simcall without timeouts */
  16 void simcall_HANDLER_cond_wait(smx_simcall_t simcall, smx_cond_t cond, smx_mutex_t mutex)
  17 {
  18   cond->wait(mutex, -1, simcall->issuer_);
  19 }
  20
  21 /** @brief Handle a condition waiting simcall with timeouts */
  22 void simcall_HANDLER_cond_wait_timeout(smx_simcall_t simcall, smx_cond_t cond, smx_mutex_t mutex, double timeout)
  23 {
  24   cond->wait(mutex, timeout, simcall->issuer_);
  25 }
  26
  27 namespace simgrid {
  28 namespace kernel {
  29 namespace activity {
  30
  31 /**
  32  * @brief Signalizes a condition.
  33  *
  34  * Signalizes a condition and wakes up a sleeping process.
  35  * If there are no process sleeping, no action is done.
  36  */
  37 void ConditionVariableImpl::signal()
  38 {
  39   XBT_DEBUG("Signal condition %p", this);
  40
  41   /* If there are processes waiting for the condition choose one and try
  42      to make it acquire the mutex */
  43   if (not sleeping_.empty()) {
  44     auto& proc = sleeping_.front();
  45     sleeping_.pop_front();
  46
  47     /* Destroy waiter's synchronization */
  48     proc.waiting_synchro = nullptr;
  49
  50     /* Now transform the cond wait simcall into a mutex lock one */
  51     smx_simcall_t simcall = &proc.simcall;
  52     MutexImpl* simcall_mutex;
  53     if (simcall->call_ == SIMCALL_COND_WAIT)
  54       simcall_mutex = simcall_cond_wait__get__mutex(simcall);
  55     else
  56       simcall_mutex = simcall_cond_wait_timeout__get__mutex(simcall);
  57     simcall->call_ = SIMCALL_MUTEX_LOCK;
  58
  59     simcall_mutex->lock(simcall->issuer_);
  60   }
  61   XBT_OUT();
  62 }
  63
  64 /**
  65  * @brief Broadcasts a condition.
  66  *
  67  * Signal ALL processes waiting on a condition.
  68  * If there are no process waiting, no action is done.
  69  */
  70 void ConditionVariableImpl::broadcast()
  71 {
  72   XBT_DEBUG("Broadcast condition %p", this);
  73
  74   /* Signal the condition until nobody is waiting on it */
  75   while (not sleeping_.empty())
  76     signal();
  77 }
  78
  79 void ConditionVariableImpl::wait(smx_mutex_t mutex, double timeout, actor::ActorImpl* issuer)
  80 {
  81   XBT_DEBUG("Wait condition %p", this);
  82
  83   /* If there is a mutex unlock it */
  84   if (mutex != nullptr) {
  85     xbt_assert(mutex->get_owner() == issuer,
  86                "Actor %s cannot wait on ConditionVariable %p since it does not own the provided mutex %p",
  87                issuer->get_cname(), this, mutex);
  88     mutex_ = mutex;
  89     mutex->unlock(issuer);
  90   }
  91
  92   RawImplPtr synchro(new RawImpl());
  93   synchro->set_host(issuer->get_host()).set_timeout(timeout).start();
  94   synchro->register_simcall(&issuer->simcall);
  95   sleeping_.push_back(*issuer);
  96 }
  97
  98 // boost::intrusive_ptr<ConditionVariableImpl> support:
  99 void intrusive_ptr_add_ref(simgrid::kernel::activity::ConditionVariableImpl* cond)
 100 {
 101   cond->refcount_.fetch_add(1, std::memory_order_relaxed);
 102 }
 103
 104 void intrusive_ptr_release(simgrid::kernel::activity::ConditionVariableImpl* cond)
 105 {
 106   if (cond->refcount_.fetch_sub(1, std::memory_order_release) == 1) {
 107     std::atomic_thread_fence(std::memory_order_acquire);
 108     xbt_assert(cond->sleeping_.empty(), "Cannot destroy conditional since someone is still using it");
 109     delete cond;
 110   }
 111 }
 112 } // namespace activity
 113 } // namespace kernel
 114 } // namespace simgrid