Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
Update copyright lines for 2023.
[simgrid.git] / src / kernel / activity / ActivityImpl.cpp
index f7f719c..b16a24b 100644 (file)
-/* 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 <simgrid/modelchecker.h>
+#include <simgrid/s4u/Activity.hpp>
+#include <simgrid/s4u/Engine.hpp>
+
 #include "src/kernel/activity/ActivityImpl.hpp"
+#include "src/kernel/activity/CommImpl.hpp"
+#include "src/kernel/activity/Synchro.hpp"
+#include "src/kernel/actor/ActorImpl.hpp"
+#include "src/kernel/actor/SimcallObserver.hpp"
+#include "src/kernel/resource/CpuImpl.hpp"
+#include "src/mc/mc_replay.hpp"
+
+#include <boost/range/algorithm.hpp>
+#include <cmath> // isfinite()
 
-XBT_LOG_EXTERNAL_DEFAULT_CATEGORY(simix_process);
+XBT_LOG_NEW_DEFAULT_SUBCATEGORY(ker_activity, kernel, "Kernel activity-related synchronization");
 
-namespace simgrid {
-namespace kernel {
-namespace activity {
+namespace simgrid::kernel::activity {
 
 ActivityImpl::~ActivityImpl()
+{
+  clean_action();
+  XBT_DEBUG("Destroy activity %p", this);
+}
+
+void ActivityImpl::register_simcall(actor::Simcall* simcall)
+{
+  simcalls_.push_back(simcall);
+  simcall->issuer_->waiting_synchro_ = this;
+}
+
+void ActivityImpl::unregister_simcall(actor::Simcall* simcall)
+{
+  // Remove the first occurrence of simcall:
+  auto j = boost::range::find(simcalls_, simcall);
+  if (j != simcalls_.end())
+    simcalls_.erase(j);
+}
+
+void ActivityImpl::clean_action()
 {
   if (surf_action_) {
     surf_action_->unref();
-    XBT_DEBUG("Destroy activity %p", this);
     surf_action_ = nullptr;
   }
 }
 
+double ActivityImpl::get_remaining() const
+{
+  return surf_action_ ? surf_action_->get_remains() : 0;
+}
+
+const char* ActivityImpl::get_state_str() const
+{
+  return to_c_str(state_);
+}
+
+bool ActivityImpl::test(actor::ActorImpl* issuer)
+{
+  if (state_ != State::WAITING && state_ != State::RUNNING) {
+    finish();
+    issuer->exception_ = nullptr; // Do not propagate exception in that case
+    return true;
+  }
+
+  if (auto* observer = dynamic_cast<kernel::actor::ActivityTestSimcall*>(issuer->simcall_.observer_))
+    observer->set_result(false);
+
+  return false;
+}
+
+ssize_t ActivityImpl::test_any(actor::ActorImpl* issuer, const std::vector<ActivityImpl*>& activities)
+{
+  auto* observer = dynamic_cast<kernel::actor::ActivityTestanySimcall*>(issuer->simcall_.observer_);
+  xbt_assert(observer != nullptr);
+
+  if (MC_is_active() || MC_record_replay_is_active()) {
+    int idx = observer->get_value();
+    xbt_assert(idx == -1 || activities[idx]->test(issuer));
+    return idx;
+  }
+
+  for (std::size_t i = 0; i < activities.size(); ++i) {
+    if (activities[i]->test(issuer)) {
+      observer->set_result(i);
+      return i;
+    }
+  }
+  return -1;
+}
+
+void ActivityImpl::wait_for(actor::ActorImpl* issuer, double timeout)
+{
+  XBT_DEBUG("Wait for execution of synchro %p, state %s", this, get_state_str());
+  xbt_assert(std::isfinite(timeout), "timeout is not finite!");
+
+  /* Associate this simcall to the synchro */
+  register_simcall(&issuer->simcall_);
+
+  xbt_assert(not MC_is_active() && not MC_record_replay_is_active(), "MC is currently not supported here.");
+
+  /* If the synchro is already finished then perform the error handling */
+  if (state_ != State::WAITING && state_ != State::RUNNING) {
+    finish();
+  } else {
+    /* we need a sleep action (even when the timeout is infinite) to be notified of host failures */
+    /* Comms handle that a bit differently of the other activities */
+    if (auto* comm = dynamic_cast<CommImpl*>(this)) {
+      resource::Action* sleep_action = issuer->get_host()->get_cpu()->sleep(timeout);
+      sleep_action->set_activity(comm);
+
+      if (issuer == comm->src_actor_)
+        comm->src_timeout_ = sleep_action;
+      else
+        comm->dst_timeout_ = sleep_action;
+    } else {
+      SynchroImplPtr synchro(new SynchroImpl([this, issuer]() {
+        this->unregister_simcall(&issuer->simcall_);
+        issuer->waiting_synchro_ = nullptr;
+        issuer->exception_       = nullptr;
+        auto* observer           = dynamic_cast<kernel::actor::ActivityWaitSimcall*>(issuer->simcall_.observer_);
+        xbt_assert(observer != nullptr);
+        observer->set_result(true); // Returns that the wait_for timeouted
+      }));
+      synchro->set_host(issuer->get_host()).set_timeout(timeout).start();
+      synchro->register_simcall(&issuer->simcall_);
+    }
+  }
+}
+
+void ActivityImpl::wait_any_for(actor::ActorImpl* issuer, const std::vector<ActivityImpl*>& activities, double timeout)
+{
+  XBT_DEBUG("Wait for execution of any synchro");
+  if (MC_is_active() || MC_record_replay_is_active()) {
+    auto* observer = dynamic_cast<kernel::actor::ActivityWaitanySimcall*>(issuer->simcall_.observer_);
+    xbt_assert(observer != nullptr);
+    xbt_assert(timeout <= 0.0, "Timeout not implemented for waitany in the model-checker");
+    if (int idx = observer->get_value(); idx != -1) {
+      auto* act = activities.at(idx);
+      act->simcalls_.push_back(&issuer->simcall_);
+      observer->set_result(idx);
+      act->set_state(State::DONE);
+      act->finish();
+    }
+    return;
+  }
+
+  if (timeout < 0.0) {
+    issuer->simcall_.timeout_cb_ = nullptr;
+  } else {
+    issuer->simcall_.timeout_cb_ = timer::Timer::set(s4u::Engine::get_clock() + timeout, [issuer, &activities]() {
+      issuer->simcall_.timeout_cb_ = nullptr;
+      for (auto* act : activities)
+        act->unregister_simcall(&issuer->simcall_);
+      // default result (-1) is set in actor::ActivityWaitanySimcall
+      issuer->simcall_answer();
+    });
+  }
+
+  for (auto* act : activities) {
+    /* associate this simcall to the the synchro */
+    act->simcalls_.push_back(&issuer->simcall_);
+    /* see if the synchro is already finished */
+    if (act->get_state() != State::WAITING && act->get_state() != State::RUNNING) {
+      act->finish();
+      break;
+    }
+  }
+  XBT_DEBUG("Exit from ActivityImlp::wait_any_for");
+}
+
 void ActivityImpl::suspend()
 {
   if (surf_action_ == nullptr)
     return;
   XBT_VERB("This activity is suspended (remain: %f)", surf_action_->get_remains());
   surf_action_->suspend();
-  on_suspended(*this);
+  s4u::Activity::on_suspended(*get_iface());
 }
 
 void ActivityImpl::resume()
@@ -35,30 +189,51 @@ void ActivityImpl::resume()
     return;
   XBT_VERB("This activity is resumed (remain: %f)", surf_action_->get_remains());
   surf_action_->resume();
-  on_resumed(*this);
+  s4u::Activity::on_resumed(*get_iface());
 }
 
-void ActivityImpl::set_category(const std::string& category)
+void ActivityImpl::cancel()
 {
-  if (surf_action_)
-    surf_action_->set_category(category);
+  XBT_VERB("Activity %p is canceled", this);
+  if (surf_action_ != nullptr)
+    surf_action_->cancel();
+  state_ = State::CANCELED;
+}
+
+void ActivityImpl::handle_activity_waitany(actor::Simcall* simcall)
+{
+  /* If a waitany simcall is waiting for this synchro to finish, then remove it from the other synchros in the waitany
+   * list. Afterwards, get the position of the actual synchro in the waitany list and return it as the result of the
+   * simcall */
+  if (auto* observer = dynamic_cast<actor::ActivityWaitanySimcall*>(simcall->observer_)) {
+    if (simcall->timeout_cb_) {
+      simcall->timeout_cb_->remove();
+      simcall->timeout_cb_ = nullptr;
+    }
+
+    auto activities = observer->get_activities();
+    for (auto* act : activities)
+      act->unregister_simcall(simcall);
+
+    if (not MC_is_active() && not MC_record_replay_is_active()) {
+      auto element   = std::find(activities.begin(), activities.end(), this);
+      int rank       = element != activities.end() ? static_cast<int>(std::distance(activities.begin(), element)) : -1;
+      observer->set_result(rank);
+    }
+  }
 }
 
 // boost::intrusive_ptr<Activity> support:
-void intrusive_ptr_add_ref(simgrid::kernel::activity::ActivityImpl* activity)
+void intrusive_ptr_add_ref(ActivityImpl* activity)
 {
   activity->refcount_.fetch_add(1, std::memory_order_relaxed);
 }
 
-void intrusive_ptr_release(simgrid::kernel::activity::ActivityImpl* activity)
+void intrusive_ptr_release(ActivityImpl* activity)
 {
   if (activity->refcount_.fetch_sub(1, std::memory_order_release) == 1) {
     std::atomic_thread_fence(std::memory_order_acquire);
     delete activity;
   }
 }
-xbt::signal<void(ActivityImpl const&)> ActivityImpl::on_resumed;
-xbt::signal<void(ActivityImpl const&)> ActivityImpl::on_suspended;
-}
-}
-} // namespace simgrid::kernel::activity::
+} // namespace simgrid::kernel::activity