Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
Update copyright lines for 2023.
[simgrid.git] / src / kernel / activity / ConditionVariableImpl.cpp
index 18d1197..2315ebe 100644 (file)
@@ -1,73 +1,43 @@
-/* Copyright (c) 2007-2019. 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 "simgrid/Exception.hpp"
 #include "src/kernel/activity/MutexImpl.hpp"
-#include "src/kernel/activity/SynchroRaw.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 **********************************/
 
-/** @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;
-
-  cond->wait(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;
-  simcall_cond_wait_timeout__set__result(simcall, 0); // default result, will be set to 1 on timeout
-  cond->wait(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.
  *
- * 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 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;
-    MutexImpl* 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_mutex->lock(simcall->issuer);
+    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();
 }
@@ -75,8 +45,8 @@ void ConditionVariableImpl::signal()
 /**
  * @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()
 {
@@ -87,35 +57,38 @@ void ConditionVariableImpl::broadcast()
     signal();
 }
 
-void ConditionVariableImpl::wait(smx_mutex_t mutex, double timeout, actor::ActorImpl* issuer, smx_simcall_t simcall)
+void ConditionVariableImpl::wait(MutexImpl* mutex, double timeout, actor::ActorImpl* issuer)
 {
-  XBT_IN("(%p, %p, %f, %p,%p)", this, mutex, timeout, issuer, simcall);
-  RawImplPtr synchro = nullptr;
-
   XBT_DEBUG("Wait condition %p", this);
+  xbt_assert(std::isfinite(timeout), "timeout is not finite!");
 
   /* If there is a mutex unlock it */
-  /* FIXME: what happens if the issuer is not the owner of the mutex? */
   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);
   }
 
-  synchro = RawImplPtr(new RawImpl());
-  (*synchro).set_host(issuer->get_host()).set_timeout(timeout).start();
-  synchro->simcalls_.push_front(simcall);
-  issuer->waiting_synchro = synchro;
-  sleeping_.push_back(*simcall->issuer);
-  XBT_OUT();
+  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);
@@ -123,6 +96,4 @@ void intrusive_ptr_release(simgrid::kernel::activity::ConditionVariableImpl* con
     delete cond;
   }
 }
-} // namespace activity
-} // namespace kernel
-} // namespace simgrid
+} // namespace simgrid::kernel::activity