Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
Make Simcall a real class.
[simgrid.git] / src / kernel / actor / ActorImpl.cpp
index 4a59ebd..862475e 100644 (file)
@@ -1,32 +1,26 @@
-/* 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. */
 
-#include "simgrid/s4u/Actor.hpp"
-#include "mc/mc.h"
-#include "simgrid/Exception.hpp"
-#include "simgrid/s4u/Exec.hpp"
+#include <simgrid/Exception.hpp>
+#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"
-#include "src/kernel/activity/CommImpl.hpp"
-#include "src/kernel/activity/ExecImpl.hpp"
-#include "src/kernel/activity/IoImpl.hpp"
-#include "src/kernel/activity/SleepImpl.hpp"
-#include "src/kernel/activity/SynchroRaw.hpp"
-#include "src/mc/mc_replay.hpp"
-#include "src/mc/remote/AppSide.hpp"
-#include "src/simix/smx_private.hpp"
 #if HAVE_SMPI
 #include "src/smpi/include/private.hpp"
 #endif
 #include "src/surf/HostImpl.hpp"
-#include "src/surf/cpu_interface.hpp"
 
 #include <boost/core/demangle.hpp>
 #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.
@@ -35,7 +29,7 @@ XBT_LOG_NEW_DEFAULT_SUBCATEGORY(simix_process, simix, "Logging specific to SIMIX
  *
  * @return The SIMIX process
  */
-smx_actor_t SIMIX_process_self()
+smx_actor_t SIMIX_process_self() // XBT_ATTRIB_DEPRECATED_v333
 {
   return simgrid::kernel::actor::ActorImpl::self();
 }
@@ -69,12 +63,12 @@ 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()
 {
-  if (simix_global != nullptr && not EngineImpl::get_instance()->is_maestro(this))
+  if (EngineImpl::has_instance() && not EngineImpl::get_instance()->is_maestro(this))
     s4u::Actor::on_destruction(*get_ciface());
 }
 
@@ -103,8 +97,7 @@ ActorImplPtr ActorImpl::attach(const std::string& name, void* data, s4u::Host* h
   actor->code_ = nullptr;
 
   XBT_VERB("Create context %s", actor->get_cname());
-  xbt_assert(simix_global != nullptr, "simix is not initialized, please call MSG_init first");
-  actor->context_.reset(simix_global->get_context_factory()->attach(actor));
+  actor->context_.reset(engine->get_context_factory()->attach(actor));
 
   /* Add the actor to it's host actor list */
   host->get_impl()->add_actor(actor);
@@ -138,6 +131,12 @@ void ActorImpl::detach()
   context->attach_stop();
 }
 
+/** Whether this actor is actually maestro */
+bool ActorImpl::is_maestro() const
+{
+  return context_->is_maestro();
+}
+
 void ActorImpl::cleanup_from_simix()
 {
   auto* engine = EngineImpl::get_instance();
@@ -145,12 +144,8 @@ void ActorImpl::cleanup_from_simix()
   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()
@@ -177,6 +172,9 @@ void ActorImpl::cleanup()
     activity->cancel();
   activities_.clear();
 
+  while (not mailboxes.empty())
+    mailboxes.back()->set_receiver(nullptr);
+
   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 */
@@ -197,7 +195,7 @@ void ActorImpl::cleanup()
   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()); });
+  actor::simcall_answered([this] { s4u::Actor::on_termination(*get_ciface()); });
   context_->set_wannadie();
 }
 
@@ -208,35 +206,28 @@ void ActorImpl::exit()
   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();
-    }
-
+  if (auto activity = waiting_synchro_) {
     activities_.remove(waiting_synchro_);
     waiting_synchro_ = nullptr;
+
+    activity->cancel();
+    activity->set_state(activity::State::FAILED);
+    activity->post();
   }
   for (auto const& activity : activities_)
     activity->cancel();
   activities_.clear();
 
+  while (not mailboxes.empty())
+    mailboxes.back()->set_receiver(nullptr);
+
   // Forcefully kill the actor if its host is turned off. Not a HostFailureException because you should not survive that
   this->throw_exception(std::make_exception_ptr(ForcefulKillException(host_->is_on() ? "exited" : "host failed")));
 }
 
 void ActorImpl::kill(ActorImpl* actor) const
 {
-  xbt_assert(not EngineImpl::get_instance()->is_maestro(actor), "Killing maestro is a rather bad idea");
+  xbt_assert(not actor->is_maestro(), "Killing maestro is a rather bad idea.");
   if (actor->finished_) {
     XBT_DEBUG("Ignoring request to kill actor %s@%s that is already dead", actor->get_cname(),
               actor->host_->get_cname());
@@ -283,7 +274,6 @@ 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());
 
@@ -309,7 +299,6 @@ 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_)
     smpi_switch_data_segment(get_iface());
@@ -335,7 +324,7 @@ 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());
 
@@ -430,12 +419,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_ != simix::Simcall::Type::NONE);
+    simcall_.call_            = simix::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);
@@ -474,7 +463,7 @@ ActorImpl* ActorImpl::start(const ActorCode& code)
 
   this->code_ = code;
   XBT_VERB("Create context %s", get_cname());
-  context_.reset(simix_global->get_context_factory()->create_context(ActorCode(code), this));
+  context_.reset(engine->get_context_factory()->create_context(ActorCode(code), this));
 
   XBT_DEBUG("Start context '%s'", get_cname());
 
@@ -499,8 +488,7 @@ 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);
 
@@ -509,32 +497,32 @@ ActorImplPtr ActorImpl::create(const std::string& name, const ActorCode& code, v
 
 void create_maestro(const std::function<void()>& code)
 {
+  auto* engine = EngineImpl::get_instance();
   /* Create maestro actor and initialize it */
   auto* maestro = new ActorImpl(xbt::string(""), /*host*/ nullptr);
 
   if (not code) {
-    maestro->context_.reset(simix_global->get_context_factory()->create_context(ActorCode(), maestro));
+    maestro->context_.reset(engine->get_context_factory()->create_context(ActorCode(), maestro));
   } else {
-    maestro->context_.reset(simix_global->get_context_factory()->create_maestro(ActorCode(code), maestro));
+    maestro->context_.reset(engine->get_context_factory()->create_maestro(ActorCode(code), maestro));
   }
 
   maestro->simcall_.issuer_ = maestro;
-  EngineImpl::get_instance()->set_maestro(maestro);
+  engine->set_maestro(maestro);
 }
 
 } // namespace actor
 } // namespace kernel
 } // namespace simgrid
 
-/* needs to be public and without simcall because it is called
-   by exceptions and logging events */
-const char* SIMIX_process_self_get_name()
+/* 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();
+  return simgrid::s4u::Actor::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
+int SIMIX_is_maestro() // XBT_ATTRIB_DEPRECATED_v333
 {
-  return simgrid::kernel::actor::ActorImpl::by_pid(pid);
+  const auto* self = simgrid::kernel::actor::ActorImpl::self();
+  return self != nullptr && self->is_maestro();
 }