Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
Move the actor lifecycle markers from Context to ActorImpl
[simgrid.git] / src / kernel / actor / ActorImpl.cpp
index 801eb53..8acb38f 100644 (file)
@@ -1,4 +1,4 @@
-/* Copyright (c) 2007-2021. The SimGrid Team. All rights reserved.          */
+/* Copyright (c) 2007-2022. 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. */
@@ -7,6 +7,9 @@
 #include <simgrid/s4u/Actor.hpp>
 #include <simgrid/s4u/Host.hpp>
 
+#define SIMIX_H_NO_DEPRECATED_WARNING // avoid deprecation warning on include (remove with XBT_ATTRIB_DEPRECATED_v333)
+#include <simgrid/simix.h>
+
 #include "src/kernel/EngineImpl.hpp"
 #if HAVE_SMPI
 #include "src/smpi/include/private.hpp"
@@ -17,7 +20,7 @@
 #include <typeinfo>
 #include <utility>
 
-XBT_LOG_NEW_DEFAULT_SUBCATEGORY(simix_process, simix, "Logging specific to SIMIX (process)");
+XBT_LOG_NEW_DEFAULT_SUBCATEGORY(ker_actor, kernel, "Logging specific to Actor's kernel side");
 
 /**
  * @brief Returns the current agent.
@@ -60,7 +63,7 @@ ActorImpl::ActorImpl(xbt::string name, s4u::Host* host) : host_(host), name_(std
 {
   pid_            = maxpid++;
   simcall_.issuer_ = this;
-  stacksize_      = smx_context_stack_size;
+  stacksize_       = context::stack_size;
 }
 
 ActorImpl::~ActorImpl()
@@ -124,28 +127,27 @@ void ActorImpl::detach()
   auto* context = dynamic_cast<context::AttachContext*>(context::Context::self());
   xbt_assert(context != nullptr, "Not a suitable context");
 
-  context->get_actor()->cleanup();
+  context->get_actor()->cleanup_from_self();
   context->attach_stop();
 }
 
-void ActorImpl::cleanup_from_simix()
+/** Whether this actor is actually maestro */
+bool ActorImpl::is_maestro() const
+{
+  return context_->is_maestro();
+}
+
+void ActorImpl::cleanup_from_kernel()
 {
+  xbt_assert(s4u::Actor::is_maestro(), "Cleanup_from_kernel called from '%s' on '%s'", ActorImpl::self()->get_cname(),
+             get_cname());
+
   auto* engine = EngineImpl::get_instance();
-  const std::lock_guard<std::mutex> lock(engine->get_mutex());
   engine->remove_actor(pid_);
   if (host_ && host_actor_list_hook.is_linked())
     host_->get_impl()->remove_actor(this);
-  if (not kernel_destroy_list_hook.is_linked()) {
-#if SIMGRID_HAVE_MC
-    engine->add_dead_actor_to_dynar(this);
-#endif
+  if (not kernel_destroy_list_hook.is_linked())
     engine->add_actor_to_destroy_list(*this);
-  }
-}
-
-void ActorImpl::cleanup()
-{
-  finished_ = true;
 
   if (has_to_auto_restart() && not get_host()->is_on()) {
     XBT_DEBUG("Insert host %s to watched_hosts because it's off and %s needs to restart", get_host()->get_cname(),
@@ -153,14 +155,26 @@ void ActorImpl::cleanup()
     watched_hosts().insert(get_host()->get_name());
   }
 
+  undaemonize();
+
+  while (not mailboxes_.empty())
+    mailboxes_.back()->set_receiver(nullptr);
+}
+
+/* Do all the cleanups from the actor context. Warning, the simcall mechanism was not reignited so doing simcalls in
+ * this context is dangerous */
+void ActorImpl::cleanup_from_self()
+{
+  xbt_assert(not ActorImpl::is_maestro(), "Cleanup_from_self called from maestro on '%s'", get_cname());
+  set_to_be_freed();
+
   if (on_exit) {
     // Execute the termination callbacks
-    bool failed = context_->wannadie();
+    bool failed = wannadie();
     for (auto exit_fun = on_exit->crbegin(); exit_fun != on_exit->crend(); ++exit_fun)
       (*exit_fun)(failed);
     on_exit.reset();
   }
-  undaemonize();
 
   /* cancel non-blocking activities */
   for (auto activity : activities_)
@@ -169,11 +183,6 @@ void ActorImpl::cleanup()
 
   XBT_DEBUG("%s@%s(%ld) should not run anymore", get_cname(), get_host()->get_cname(), get_pid());
 
-  if (EngineImpl::get_instance()->is_maestro(this)) /* Do not cleanup maestro */
-    return;
-
-  XBT_DEBUG("Cleanup actor %s (%p), waiting synchro %p", get_cname(), this, waiting_synchro_.get());
-
   /* Unregister associated timers if any */
   if (kill_timer_ != nullptr) {
     kill_timer_->remove();
@@ -184,34 +193,23 @@ void ActorImpl::cleanup()
     simcall_.timeout_cb_ = nullptr;
   }
 
-  cleanup_from_simix();
-
-  context_->set_wannadie(false); // don't let the simcall's yield() do a Context::stop(), to avoid infinite loops
-  actor::simcall([this] { s4u::Actor::on_termination(*get_ciface()); });
-  context_->set_wannadie();
+  set_wannadie(false); // don't let the simcall's yield() do a Context::stop(), to avoid infinite loops
+  actor::simcall_answered([this] { s4u::Actor::on_termination(*get_ciface()); });
+  set_wannadie();
 }
 
 void ActorImpl::exit()
 {
-  context_->set_wannadie();
-  suspended_          = false;
-  exception_          = nullptr;
+  set_wannadie();
+  suspended_ = false;
+  exception_ = nullptr;
 
-  /* destroy the blocking synchro if any */
   if (waiting_synchro_ != nullptr) {
-    waiting_synchro_->cancel();
-    waiting_synchro_->state_ = activity::State::FAILED;
-
-    activity::ExecImplPtr exec = boost::dynamic_pointer_cast<activity::ExecImpl>(waiting_synchro_);
-    activity::CommImplPtr comm = boost::dynamic_pointer_cast<activity::CommImpl>(waiting_synchro_);
-
-    if (exec != nullptr) {
-      exec->clean_action();
-    } else if (comm != nullptr) {
-      comm->unregister_simcall(&simcall_);
-    } else {
-      activity::ActivityImplPtr(waiting_synchro_)->finish();
-    }
+    /* Take an extra reference on the activity object that may be unref by Comm::finish() or friends */
+    activity::ActivityImplPtr activity = waiting_synchro_;
+    activity->cancel();
+    activity->set_state(activity::State::FAILED);
+    activity->post();
 
     activities_.remove(waiting_synchro_);
     waiting_synchro_ = nullptr;
@@ -226,9 +224,8 @@ void ActorImpl::exit()
 
 void ActorImpl::kill(ActorImpl* actor) const
 {
-  auto* engine = EngineImpl::get_instance();
-  xbt_assert(not engine->is_maestro(actor), "Killing maestro is a rather bad idea");
-  if (actor->finished_) {
+  xbt_assert(not actor->is_maestro(), "Killing maestro is a rather bad idea.");
+  if (actor->wannadie()) {
     XBT_DEBUG("Ignoring request to kill actor %s@%s that is already dead", actor->get_cname(),
               actor->host_->get_cname());
     return;
@@ -242,7 +239,7 @@ void ActorImpl::kill(ActorImpl* actor) const
   if (actor == this) {
     XBT_DEBUG("Go on, this is a suicide,");
   } else
-    engine->add_actor_to_run_list(actor);
+    EngineImpl::get_instance()->add_actor_to_run_list(actor);
 }
 
 void ActorImpl::kill_all() const
@@ -260,6 +257,7 @@ void ActorImpl::set_kill_time(double kill_time)
   kill_timer_ = timer::Timer::set(kill_time, [this] {
     this->exit();
     kill_timer_ = nullptr;
+    EngineImpl::get_instance()->add_actor_to_run_list(this);
   });
 }
 
@@ -274,11 +272,10 @@ void ActorImpl::yield()
 
   /* Go into sleep and return control to maestro */
   context_->suspend();
-
   /* Ok, maestro returned control to us */
   XBT_DEBUG("Control returned to me: '%s'", get_cname());
 
-  if (context_->wannadie()) {
+  if (wannadie()) {
     XBT_DEBUG("Actor %s@%s is dead", get_cname(), host_->get_cname());
     context_->stop();
     THROW_IMPOSSIBLE;
@@ -300,9 +297,8 @@ void ActorImpl::yield()
       e.rethrow_nested(XBT_THROW_POINT, boost::core::demangle(typeid(e).name()) + " raised in kernel mode.");
     }
   }
-
 #if HAVE_SMPI
-  if (not finished_)
+  if (not wannadie())
     smpi_switch_data_segment(get_iface());
 #endif
 }
@@ -326,24 +322,18 @@ void ActorImpl::undaemonize()
 
 s4u::Actor* ActorImpl::restart()
 {
-  xbt_assert(not EngineImpl::get_instance()->is_maestro(this), "Restarting maestro is not supported");
+  xbt_assert(not this->is_maestro(), "Restarting maestro is not supported");
 
   XBT_DEBUG("Restarting actor %s on %s", get_cname(), host_->get_cname());
 
   // retrieve the arguments of the old actor
-  ProcessArg arg(host_, this);
+  ProcessArg args(host_, this);
 
   // kill the old actor
   context::Context::self()->get_actor()->kill(this);
 
   // start the new actor
-  ActorImplPtr actor = ActorImpl::create(arg.name, arg.code, arg.data, arg.host, nullptr);
-  actor->set_properties(arg.properties);
-  *actor->on_exit = std::move(*arg.on_exit);
-  actor->set_kill_time(arg.kill_time);
-  actor->set_auto_restart(arg.auto_restart);
-
-  return actor->get_ciface();
+  return create(&args)->get_ciface();
 }
 
 void ActorImpl::suspend()
@@ -364,8 +354,8 @@ void ActorImpl::resume()
 {
   XBT_IN("actor = %p", this);
 
-  if (context_->wannadie()) {
-    XBT_VERB("Ignoring request to suspend an actor that is currently dying.");
+  if (wannadie()) {
+    XBT_VERB("Ignoring request to resume an actor that is currently dying.");
     return;
   }
 
@@ -385,10 +375,15 @@ void ActorImpl::resume()
 activity::ActivityImplPtr ActorImpl::join(const ActorImpl* actor, double timeout)
 {
   activity::ActivityImplPtr sleep = this->sleep(timeout);
-  actor->on_exit->emplace_back([sleep](bool) {
+  if (actor->wannadie() || actor->to_be_freed()) {
     if (sleep->surf_action_)
       sleep->surf_action_->finish(resource::Action::State::FINISHED);
-  });
+  } else {
+    actor->on_exit->emplace_back([sleep](bool) {
+      if (sleep->surf_action_)
+        sleep->surf_action_->finish(resource::Action::State::FINISHED);
+    });
+  }
   return sleep;
 }
 
@@ -421,12 +416,12 @@ void ActorImpl::throw_exception(std::exception_ptr e)
 void ActorImpl::simcall_answer()
 {
   auto* engine = EngineImpl::get_instance();
-  if (not engine->is_maestro(this)) {
-    XBT_DEBUG("Answer simcall %s issued by %s (%p)", SIMIX_simcall_name(simcall_), get_cname(), this);
-    xbt_assert(simcall_.call_ != simix::Simcall::NONE);
-    simcall_.call_ = simix::Simcall::NONE;
+  if (not this->is_maestro()) {
+    XBT_DEBUG("Answer simcall %s issued by %s (%p)", simcall_.get_cname(), get_cname(), this);
+    xbt_assert(simcall_.call_ != Simcall::Type::NONE);
+    simcall_.call_            = Simcall::Type::NONE;
     const auto& actors_to_run = engine->get_actors_to_run();
-    xbt_assert(not XBT_LOG_ISENABLED(simix_process, xbt_log_priority_debug) ||
+    xbt_assert(not XBT_LOG_ISENABLED(ker_actor, xbt_log_priority_debug) ||
                    std::find(begin(actors_to_run), end(actors_to_run), this) == end(actors_to_run),
                "Actor %p should not exist in actors_to_run!", this);
     engine->add_actor_to_run_list_no_check(this);
@@ -490,13 +485,32 @@ ActorImplPtr ActorImpl::create(const std::string& name, const ActorCode& code, v
   else
     actor = self()->init(xbt::string(name), host);
 
-  /* actor data */
-  actor->piface_.set_data(data);
+  actor->piface_.set_data(data); /* actor data */
 
   actor->start(code);
 
   return actor;
 }
+ActorImplPtr ActorImpl::create(ProcessArg* args)
+{
+  ActorImplPtr actor    = ActorImpl::create(args->name, args->code, nullptr, args->host, nullptr);
+  actor->restart_count_ = args->restart_count_;
+  actor->set_properties(args->properties);
+  if (args->on_exit)
+    *actor->on_exit = *args->on_exit;
+  if (args->kill_time >= 0)
+    actor->set_kill_time(args->kill_time);
+  if (args->auto_restart)
+    actor->set_auto_restart(args->auto_restart);
+  if (args->daemon_)
+    actor->daemonize();
+  return actor;
+}
+void ActorImpl::set_wannadie(bool value)
+{
+  XBT_DEBUG("Actor %s gonna die.", get_cname());
+  iwannadie_ = value;
+}
 
 void create_maestro(const std::function<void()>& code)
 {
@@ -521,17 +535,11 @@ void create_maestro(const std::function<void()>& code)
 /* needs to be public and without simcall because it is called by exceptions and logging events */
 const char* SIMIX_process_self_get_name() // XBT_ATTRIB_DEPRECATED_v333
 {
-  return SIMIX_is_maestro() ? "maestro" : simgrid::kernel::actor::ActorImpl::self()->get_cname();
-}
-
-/** @brief Returns the process from PID. */
-smx_actor_t SIMIX_process_from_PID(aid_t pid) // XBT_ATTRIB_DEPRECATD_v331
-{
-  return simgrid::kernel::actor::ActorImpl::by_pid(pid);
+  return simgrid::s4u::Actor::is_maestro() ? "maestro" : simgrid::kernel::actor::ActorImpl::self()->get_cname();
 }
 
-int SIMIX_is_maestro()
+int SIMIX_is_maestro() // XBT_ATTRIB_DEPRECATED_v333
 {
   const auto* self = simgrid::kernel::actor::ActorImpl::self();
-  return self == nullptr || simgrid::kernel::EngineImpl::get_instance()->is_maestro(self);
+  return self != nullptr && self->is_maestro();
 }