Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
Update copyright lines for 2022.
[simgrid.git] / src / kernel / actor / ActorImpl.cpp
index 0db05cc..ef714f9 100644 (file)
@@ -1,27 +1,23 @@
-/* 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 "mc/mc.h"
-#include "simgrid/Exception.hpp"
-#include "simgrid/s4u/Actor.hpp"
-#include "simgrid/s4u/Exec.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"
+#include <simgrid/Exception.hpp>
+#include <simgrid/s4u/Actor.hpp>
+#include <simgrid/s4u/Host.hpp>
+
+#include "src/kernel/EngineImpl.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.
@@ -30,7 +26,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();
 }
@@ -44,21 +40,13 @@ unsigned long get_maxpid()
 {
   return maxpid;
 }
-void* get_maxpid_addr()
+unsigned long* get_maxpid_addr()
 {
   return &maxpid;
 }
 ActorImpl* ActorImpl::by_pid(aid_t pid)
 {
-  auto item = simix_global->process_list.find(pid);
-  if (item != simix_global->process_list.end())
-    return item->second;
-
-  // Search the trash
-  for (auto& a : simix_global->actors_to_destroy)
-    if (a.get_pid() == pid)
-      return &a;
-  return nullptr; // Not found, even in the trash
+  return EngineImpl::get_instance()->get_actor_by_pid(pid);
 }
 
 ActorImpl* ActorImpl::self()
@@ -72,12 +60,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 && this != simix_global->maestro_)
+  if (EngineImpl::has_instance() && not EngineImpl::get_instance()->is_maestro(this))
     s4u::Actor::on_destruction(*get_ciface());
 }
 
@@ -89,11 +77,10 @@ ActorImpl::~ActorImpl()
  * In the future, it might be extended in order to attach other threads created by a third party library.
  */
 
-ActorImplPtr ActorImpl::attach(const std::string& name, void* data, s4u::Host* host,
-                               const std::unordered_map<std::string, std::string>* properties)
+ActorImplPtr ActorImpl::attach(const std::string& name, void* data, s4u::Host* host)
 {
   // This is mostly a copy/paste from create(), it'd be nice to share some code between those two functions.
-
+  auto* engine = EngineImpl::get_instance();
   XBT_DEBUG("Attach actor %s on host '%s'", name.c_str(), host->get_cname());
 
   if (not host->is_on()) {
@@ -103,24 +90,18 @@ ActorImplPtr ActorImpl::attach(const std::string& name, void* data, s4u::Host* h
 
   auto* actor = new ActorImpl(xbt::string(name), host);
   /* Actor data */
-  actor->set_user_data(data);
+  actor->piface_.set_data(data);
   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->context_factory->attach(actor));
-
-  /* Add properties */
-  if (properties != nullptr)
-    actor->set_properties(*properties);
+  actor->context_.reset(engine->get_context_factory()->attach(actor));
 
   /* Add the actor to it's host actor list */
-  host->pimpl_->add_actor(actor);
+  host->get_impl()->add_actor(actor);
 
   /* Now insert it in the global actor list and in the actors to run list */
-  simix_global->process_list[actor->get_pid()] = actor;
-  XBT_DEBUG("Inserting [%p] %s(%s) in the to_run list", actor, actor->get_cname(), host->get_cname());
-  simix_global->actors_to_run.push_back(actor);
+  engine->add_actor(actor->get_pid(), actor);
+  engine->add_actor_to_run_list_no_check(actor);
   intrusive_ptr_add_ref(actor);
 
   auto* context = dynamic_cast<context::AttachContext*>(actor->context_.get());
@@ -147,17 +128,24 @@ 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()
 {
-  const std::lock_guard<std::mutex> lock(simix_global->mutex);
-  simix_global->process_list.erase(pid_);
+  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_->pimpl_->remove_actor(this);
-  if (not smx_destroy_list_hook.is_linked()) {
+    host_->get_impl()->remove_actor(this);
+  if (not kernel_destroy_list_hook.is_linked()) {
 #if SIMGRID_HAVE_MC
-    xbt_dynar_push_as(simix_global->dead_actors_vector, ActorImpl*, this);
+    engine->add_dead_actor_to_dynar(this);
 #endif
-    simix_global->actors_to_destroy.push_back(*this);
+    engine->add_actor_to_destroy_list(*this);
   }
 }
 
@@ -187,7 +175,7 @@ void ActorImpl::cleanup()
 
   XBT_DEBUG("%s@%s(%ld) should not run anymore", get_cname(), get_host()->get_cname(), get_pid());
 
-  if (this == simix_global->maestro_) /* Do not cleanup maestro */
+  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());
@@ -234,6 +222,9 @@ void ActorImpl::exit()
     activities_.remove(waiting_synchro_);
     waiting_synchro_ = nullptr;
   }
+  for (auto const& activity : activities_)
+    activity->cancel();
+  activities_.clear();
 
   // 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")));
@@ -241,7 +232,7 @@ void ActorImpl::exit()
 
 void ActorImpl::kill(ActorImpl* actor) const
 {
-  xbt_assert(actor != simix_global->maestro_, "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());
@@ -255,28 +246,23 @@ void ActorImpl::kill(ActorImpl* actor) const
 
   if (actor == this) {
     XBT_DEBUG("Go on, this is a suicide,");
-  } else if (std::find(begin(simix_global->actors_to_run), end(simix_global->actors_to_run), actor) !=
-             end(simix_global->actors_to_run)) {
-    XBT_DEBUG("Actor %s is already in the to_run list", actor->get_cname());
-  } else {
-    XBT_DEBUG("Inserting %s in the to_run list", actor->get_cname());
-    simix_global->actors_to_run.push_back(actor);
-  }
+  } else
+    EngineImpl::get_instance()->add_actor_to_run_list(actor);
 }
 
 void ActorImpl::kill_all() const
 {
-  for (auto const& kv : simix_global->process_list)
+  for (auto const& kv : EngineImpl::get_instance()->get_actor_list())
     if (kv.second != this)
       this->kill(kv.second);
 }
 
 void ActorImpl::set_kill_time(double kill_time)
 {
-  if (kill_time <= SIMIX_get_clock())
+  if (kill_time <= s4u::Engine::get_clock())
     return;
   XBT_DEBUG("Set kill time %f for actor %s@%s", kill_time, get_cname(), host_->get_cname());
-  kill_timer_ = simix::Timer::set(kill_time, [this] {
+  kill_timer_ = timer::Timer::set(kill_time, [this] {
     this->exit();
     kill_timer_ = nullptr;
   });
@@ -284,7 +270,7 @@ void ActorImpl::set_kill_time(double kill_time)
 
 double ActorImpl::get_kill_time() const
 {
-  return kill_timer_ ? kill_timer_->date : 0.0;
+  return kill_timer_ ? kill_timer_->get_date() : 0.0;
 }
 
 void ActorImpl::yield()
@@ -305,12 +291,7 @@ void ActorImpl::yield()
 
   if (suspended_) {
     XBT_DEBUG("Hey! I'm suspended.");
-
     xbt_assert(exception_ == nullptr, "Gasp! This exception may be lost by subsequent calls.");
-
-    if (waiting_synchro_ != nullptr) // Not sure of when this will happen. Maybe when suspending early in the SR when a
-      waiting_synchro_->suspend();   // waiting_synchro was terminated
-
     yield(); // Yield back to maestro without proceeding with my execution. I'll get rescheduled by resume()
   }
 
@@ -325,9 +306,10 @@ void ActorImpl::yield()
     }
   }
 
-  if (SMPI_switch_data_segment && not finished_) {
-    SMPI_switch_data_segment(get_iface());
-  }
+#if HAVE_SMPI
+  if (not finished_)
+    smpi_switch_data_segment(get_iface());
+#endif
 }
 
 /** This actor will be terminated automatically when the last non-daemon actor finishes */
@@ -335,38 +317,33 @@ void ActorImpl::daemonize()
 {
   if (not daemon_) {
     daemon_ = true;
-    simix_global->daemons.push_back(this);
+    EngineImpl::get_instance()->add_daemon(this);
   }
 }
 
 void ActorImpl::undaemonize()
 {
   if (daemon_) {
-    auto& vect = simix_global->daemons;
-    auto it    = std::find(vect.begin(), vect.end(), this);
-    xbt_assert(it != vect.end(), "The dying daemon is not a daemon after all. Please report that bug.");
-    /* Don't move the whole content since we don't really care about the order */
-
-    std::swap(*it, vect.back());
-    vect.pop_back();
     daemon_ = false;
+    EngineImpl::get_instance()->remove_daemon(this);
   }
 }
 
 s4u::Actor* ActorImpl::restart()
 {
-  xbt_assert(this != simix_global->maestro_, "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 = ProcessArg(host_, this);
+  ProcessArg arg(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, arg.properties.get(), nullptr);
+  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);
@@ -383,10 +360,9 @@ void ActorImpl::suspend()
 
   suspended_ = true;
 
-  /* If the suspended actor is waiting on a sync, suspend its synchronization.
-   * Otherwise, it will suspend itself when scheduled, ie, very soon. */
-  if (waiting_synchro_ != nullptr)
-    waiting_synchro_->suspend();
+  /* Suspend the activities associated with this actor. */
+  for (auto const& activity : activities_)
+    activity->suspend();
 }
 
 void ActorImpl::resume()
@@ -402,11 +378,11 @@ void ActorImpl::resume()
     return;
   suspended_ = false;
 
-  /* resume the activity that was blocking the resumed actor. */
-  if (waiting_synchro_)
-    waiting_synchro_->resume();
-  else // Reschedule the actor if it was forcefully unscheduled in yield()
-    simix_global->actors_to_run.push_back(this);
+  /* resume the activities that were blocked when suspending the actor. */
+  for (auto const& activity : activities_)
+    activity->resume();
+  if (not waiting_synchro_) // Reschedule the actor if it was forcefully unscheduled in yield()
+    EngineImpl::get_instance()->add_actor_to_run_list_no_check(this);
 
   XBT_OUT();
 }
@@ -449,24 +425,24 @@ void ActorImpl::throw_exception(std::exception_ptr e)
 
 void ActorImpl::simcall_answer()
 {
-  if (this != simix_global->maestro_) {
-    XBT_DEBUG("Answer simcall %s (%d) issued by %s (%p)", SIMIX_simcall_name(simcall_.call_), (int)simcall_.call_,
-              get_cname(), this);
+  auto* engine = EngineImpl::get_instance();
+  if (not this->is_maestro()) {
+    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;
-    xbt_assert(not XBT_LOG_ISENABLED(simix_process, xbt_log_priority_debug) ||
-                   std::find(begin(simix_global->actors_to_run), end(simix_global->actors_to_run), this) ==
-                       end(simix_global->actors_to_run),
+    const auto& actors_to_run = engine->get_actors_to_run();
+    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);
-    simix_global->actors_to_run.push_back(this);
+    engine->add_actor_to_run_list_no_check(this);
   }
 }
 
 void ActorImpl::set_host(s4u::Host* dest)
 {
-  host_->pimpl_->remove_actor(this);
+  host_->get_impl()->remove_actor(this);
   host_ = dest;
-  dest->pimpl_->add_actor(this);
+  dest->get_impl()->add_actor(this);
 }
 
 ActorImplPtr ActorImpl::init(const std::string& name, s4u::Host* host) const
@@ -484,6 +460,7 @@ ActorImplPtr ActorImpl::init(const std::string& name, s4u::Host* host) const
 ActorImpl* ActorImpl::start(const ActorCode& code)
 {
   xbt_assert(code && host_ != nullptr, "Invalid parameters");
+  auto* engine = EngineImpl::get_instance();
 
   if (not host_->is_on()) {
     XBT_WARN("Cannot launch actor '%s' on failed host '%s'", name_.c_str(), host_->get_cname());
@@ -493,23 +470,21 @@ ActorImpl* ActorImpl::start(const ActorCode& code)
 
   this->code_ = code;
   XBT_VERB("Create context %s", get_cname());
-  context_.reset(simix_global->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());
 
   /* Add the actor to its host's actor list */
-  host_->pimpl_->add_actor(this);
-  simix_global->process_list[pid_] = this;
+  host_->get_impl()->add_actor(this);
+  engine->add_actor(pid_, this);
 
   /* Now insert it in the global actor list and in the actor to run list */
-  XBT_DEBUG("Inserting [%p] %s(%s) in the to_run list", this, get_cname(), host_->get_cname());
-  simix_global->actors_to_run.push_back(this);
+  engine->add_actor_to_run_list_no_check(this);
 
   return this;
 }
 
 ActorImplPtr ActorImpl::create(const std::string& name, const ActorCode& code, void* data, s4u::Host* host,
-                               const std::unordered_map<std::string, std::string>* properties,
                                const ActorImpl* parent_actor)
 {
   XBT_DEBUG("Start actor %s@'%s'", name.c_str(), host->get_cname());
@@ -520,12 +495,7 @@ ActorImplPtr ActorImpl::create(const std::string& name, const ActorCode& code, v
   else
     actor = self()->init(xbt::string(name), host);
 
-  /* actor data */
-  actor->set_user_data(data);
-
-  /* Add properties */
-  if (properties != nullptr)
-    actor->set_properties(*properties);
+  actor->piface_.set_data(data); /* actor data */
 
   actor->start(code);
 
@@ -534,64 +504,38 @@ 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->context_factory->create_context(ActorCode(), maestro));
+    maestro->context_.reset(engine->get_context_factory()->create_context(ActorCode(), maestro));
   } else {
-    maestro->context_.reset(simix_global->context_factory->create_maestro(ActorCode(code), maestro));
+    maestro->context_.reset(engine->get_context_factory()->create_maestro(ActorCode(code), maestro));
   }
 
-  maestro->simcall_.issuer_     = maestro;
-  simix_global->maestro_        = maestro;
+  maestro->simcall_.issuer_ = maestro;
+  engine->set_maestro(maestro);
 }
 
 } // namespace actor
 } // namespace kernel
 } // namespace simgrid
 
-int SIMIX_process_count() // XBT_ATTRIB_DEPRECATED_v329
-{
-  return simix_global->process_list.size();
-}
-
-void* SIMIX_process_self_get_data() // XBT_ATTRIB_DEPRECATED_v329
-{
-  smx_actor_t self = simgrid::kernel::actor::ActorImpl::self();
-
-  if (self == nullptr) {
-    return nullptr;
-  }
-  return self->get_user_data();
-}
-
-void SIMIX_process_self_set_data(void* data) // XBT_ATTRIB_DEPRECATED_v329
-{
-  simgrid::kernel::actor::ActorImpl::self()->set_user_data(data);
-}
-
-/* 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)
+smx_actor_t SIMIX_process_from_PID(aid_t pid) // XBT_ATTRIB_DEPRECATED_v331
 {
   return simgrid::kernel::actor::ActorImpl::by_pid(pid);
 }
 
-void SIMIX_process_on_exit(smx_actor_t actor,
-                           const std::function<void(bool /*failed*/)>& fun) // XBT_ATTRIB_DEPRECATED_v329
-{
-  xbt_assert(actor, "current process not found: are you in maestro context ?");
-  actor->on_exit->emplace_back(fun);
-}
-
-void simcall_process_set_data(smx_actor_t process, void* data) // XBT_ATTRIB_DEPRECATED_v329
+int SIMIX_is_maestro() // XBT_ATTRIB_DEPRECATED_v333
 {
-  simgrid::kernel::actor::simcall([process, data] { process->set_user_data(data); });
+  const auto* self = simgrid::kernel::actor::ActorImpl::self();
+  return self != nullptr && self->is_maestro();
 }