Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
Update copyright lines for 2023.
[simgrid.git] / src / kernel / activity / ConditionVariableImpl.cpp
index 06836e0..2315ebe 100644 (file)
-/* Copyright (c) 2007-2018. The SimGrid Team. All rights reserved.          */
+/* Copyright (c) 2007-2023. The SimGrid Team. All rights reserved.          */
 
 /* This program is free software; you can redistribute it and/or modify it
  * under the terms of the license (GNU LGPL) which comes with this package. */
 
 #include "src/kernel/activity/ConditionVariableImpl.hpp"
 #include "src/kernel/activity/MutexImpl.hpp"
-#include "src/kernel/activity/SynchroRaw.hpp"
-#include "src/simix/smx_synchro_private.hpp"
-#include "xbt/ex.hpp"
+#include "src/kernel/activity/Synchro.hpp"
+#include "src/kernel/actor/SimcallObserver.hpp"
+#include <cmath> // std::isfinite
 
-XBT_LOG_NEW_DEFAULT_SUBCATEGORY(ConditionVariable, simix_synchro, "Condition variables");
+XBT_LOG_NEW_DEFAULT_SUBCATEGORY(ker_condition, ker_synchro, "Condition variables kernel-space implementation");
 
 /********************************* Condition **********************************/
 
-static void _SIMIX_cond_wait(smx_cond_t cond, smx_mutex_t mutex, double timeout, smx_actor_t issuer,
-                             smx_simcall_t simcall)
-{
-  XBT_IN("(%p, %p, %f, %p,%p)", cond, mutex, timeout, issuer, simcall);
-  smx_activity_t synchro = nullptr;
-
-  XBT_DEBUG("Wait condition %p", cond);
-
-  /* If there is a mutex unlock it */
-  /* FIXME: what happens if the issuer is not the owner of the mutex? */
-  if (mutex != nullptr) {
-    cond->mutex = mutex;
-    mutex->unlock(issuer);
-  }
-
-  synchro = SIMIX_synchro_wait(issuer->host, timeout);
-  synchro->simcalls.push_front(simcall);
-  issuer->waiting_synchro = synchro;
-  cond->sleeping.push_back(*simcall->issuer);
-  XBT_OUT();
-}
-
-/**
- * \brief Handle a condition waiting simcall without timeouts
- */
-void simcall_HANDLER_cond_wait(smx_simcall_t simcall, smx_cond_t cond, smx_mutex_t mutex)
-{
-  XBT_IN("(%p)", simcall);
-  smx_actor_t issuer = simcall->issuer;
-
-  _SIMIX_cond_wait(cond, mutex, -1, issuer, simcall);
-  XBT_OUT();
-}
-
-/**
- * \brief Handle a condition waiting simcall with timeouts
- */
-void simcall_HANDLER_cond_wait_timeout(smx_simcall_t simcall, smx_cond_t cond, smx_mutex_t mutex, double timeout)
-{
-  XBT_IN("(%p)", simcall);
-  smx_actor_t issuer = simcall->issuer;
-
-  _SIMIX_cond_wait(cond, mutex, timeout, issuer, simcall);
-  XBT_OUT();
-}
-
-namespace simgrid {
-namespace kernel {
-namespace activity {
-
-ConditionVariableImpl::ConditionVariableImpl() : cond_(this) {}
-ConditionVariableImpl::~ConditionVariableImpl() = default;
+namespace simgrid::kernel::activity {
 
 /**
- * \brief Signalizes a condition.
+ * @brief Signalizes a condition.
  *
- * Signalizes a condition and wakes up a sleeping process.
- * If there are no process sleeping, no action is done.
+ * Signalizes a condition and wakes up a sleeping actor.
+ * If there are no actor sleeping, no action is done.
  */
 void ConditionVariableImpl::signal()
 {
   XBT_DEBUG("Signal condition %p", this);
 
-  /* If there are processes waiting for the condition choose one and try
-     to make it acquire the mutex */
-  if (not sleeping.empty()) {
-    auto& proc = sleeping.front();
-    sleeping.pop_front();
+  /* If there are actors waiting for the condition choose one and try to make it acquire the mutex */
+  if (not sleeping_.empty()) {
+    auto& proc = sleeping_.front();
+    sleeping_.pop_front();
 
     /* Destroy waiter's synchronization */
-    proc.waiting_synchro = nullptr;
+    proc.waiting_synchro_ = nullptr;
 
     /* Now transform the cond wait simcall into a mutex lock one */
-    smx_simcall_t simcall = &proc.simcall;
-    smx_mutex_t simcall_mutex;
-    if (simcall->call == SIMCALL_COND_WAIT)
-      simcall_mutex = simcall_cond_wait__get__mutex(simcall);
-    else
-      simcall_mutex = simcall_cond_wait_timeout__get__mutex(simcall);
-    simcall->call = SIMCALL_MUTEX_LOCK;
-
-    simcall_HANDLER_mutex_lock(simcall, simcall_mutex);
+    actor::Simcall* simcall = &proc.simcall_;
+    const auto* observer  = dynamic_cast<kernel::actor::ConditionWaitSimcall*>(simcall->observer_);
+    xbt_assert(observer != nullptr);
+    observer->get_mutex()->lock_async(simcall->issuer_)->wait_for(simcall->issuer_, -1);
   }
   XBT_OUT();
 }
 
 /**
- * \brief Broadcasts a condition.
+ * @brief Broadcasts a condition.
  *
- * Signal ALL processes waiting on a condition.
- * If there are no process waiting, no action is done.
+ * Signal ALL actors waiting on a condition.
+ * If there are no actor waiting, no action is done.
  */
 void ConditionVariableImpl::broadcast()
 {
   XBT_DEBUG("Broadcast condition %p", this);
 
   /* Signal the condition until nobody is waiting on it */
-  while (not sleeping.empty())
+  while (not sleeping_.empty())
     signal();
 }
 
+void ConditionVariableImpl::wait(MutexImpl* mutex, double timeout, actor::ActorImpl* issuer)
+{
+  XBT_DEBUG("Wait condition %p", this);
+  xbt_assert(std::isfinite(timeout), "timeout is not finite!");
+
+  /* If there is a mutex unlock it */
+  if (mutex != nullptr) {
+    xbt_assert(mutex->get_owner() == issuer,
+               "Actor %s cannot wait on ConditionVariable %p since it does not own the provided mutex %p",
+               issuer->get_cname(), this, mutex);
+    mutex_ = mutex;
+    mutex->unlock(issuer);
+  }
+
+  SynchroImplPtr synchro(new SynchroImpl([this, issuer]() {
+    this->remove_sleeping_actor(*issuer);
+    auto* observer = dynamic_cast<kernel::actor::ConditionWaitSimcall*>(issuer->simcall_.observer_);
+    xbt_assert(observer != nullptr);
+    observer->set_result(true);
+  }));
+  synchro->set_host(issuer->get_host()).set_timeout(timeout).start();
+  synchro->register_simcall(&issuer->simcall_);
+  sleeping_.push_back(*issuer);
+}
+
 // boost::intrusive_ptr<ConditionVariableImpl> support:
-void intrusive_ptr_add_ref(simgrid::kernel::activity::ConditionVariableImpl* cond)
+void intrusive_ptr_add_ref(ConditionVariableImpl* cond)
 {
   cond->refcount_.fetch_add(1, std::memory_order_relaxed);
 }
 
-void intrusive_ptr_release(simgrid::kernel::activity::ConditionVariableImpl* cond)
+void intrusive_ptr_release(ConditionVariableImpl* cond)
 {
   if (cond->refcount_.fetch_sub(1, std::memory_order_release) == 1) {
     std::atomic_thread_fence(std::memory_order_acquire);
-    xbt_assert(cond->sleeping.empty(), "Cannot destroy conditional since someone is still using it");
+    xbt_assert(cond->sleeping_.empty(), "Cannot destroy conditional since someone is still using it");
     delete cond;
   }
 }
-} // namespace activity
-} // namespace kernel
-}
+} // namespace simgrid::kernel::activity