Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
Make ActorImpl::context_ a std::unique_ptr.
[simgrid.git] / src / simix / ActorImpl.cpp
index e31c9c5..984e0ec 100644 (file)
@@ -15,7 +15,6 @@
 #include "src/kernel/activity/SynchroRaw.hpp"
 #include "src/mc/mc_replay.hpp"
 #include "src/mc/remote/Client.hpp"
-#include "src/simix/smx_host_private.hpp"
 #include "src/surf/HostImpl.hpp"
 #include "src/surf/cpu_interface.hpp"
 
@@ -42,6 +41,7 @@ smx_actor_t SIMIX_process_self()
 /**
  * @brief Returns whether a process has pending asynchronous communications.
  * @return true if there are asynchronous communications in this process
+ * @deprecated
  */
 int SIMIX_process_has_pending_comms(smx_actor_t process) {
 
@@ -58,9 +58,76 @@ ActorImpl::ActorImpl(simgrid::xbt::string name, s4u::Host* host) : host_(host),
   simcall.issuer = this;
 }
 
-ActorImpl::~ActorImpl()
+ActorImpl::~ActorImpl() = default;
+
+/* Become an actor in the simulation
+ *
+ * Currently this can only be called by the main thread (once) and only work with some thread factories
+ * (currently ThreadContextFactory).
+ *
+ * In the future, it might be extended in order to attach other threads created by a third party library.
+ */
+
+ActorImplPtr ActorImpl::attach(std::string name, void* data, s4u::Host* host,
+                               std::unordered_map<std::string, std::string>* properties)
+{
+  // This is mostly a copy/paste from create(), it'd be nice to share some code between those two functions.
+
+  XBT_DEBUG("Attach process %s on host '%s'", name.c_str(), host->get_cname());
+
+  if (not host->is_on()) {
+    XBT_WARN("Cannot launch process '%s' on failed host '%s'", name.c_str(), host->get_cname());
+    std::rethrow_exception(
+        std::make_exception_ptr(simgrid::HostFailureException(XBT_THROW_POINT, "Cannot attach actor on failed host.")));
+  }
+
+  ActorImpl* actor = new ActorImpl(xbt::string(name), host);
+  /* Actor data */
+  actor->set_user_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)
+    for (auto const& kv : *properties)
+      actor->set_property(kv.first, kv.second);
+
+  /* Add the process to it's host process list */
+  host->pimpl_->process_list_.push_back(*actor);
+
+  /* Now insert it in the global process list and in the process 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);
+  intrusive_ptr_add_ref(actor);
+
+  auto* context = dynamic_cast<simgrid::kernel::context::AttachContext*>(actor->context_.get());
+  xbt_assert(nullptr != context, "Not a suitable context");
+  context->attach_start();
+
+  /* The on_creation() signal must be delayed until there, where the pid and everything is set */
+  simgrid::s4u::ActorPtr tmp = actor->iface(); // Passing this directly to on_creation will lead to crashes
+  simgrid::s4u::Actor::on_creation(tmp);
+
+  return ActorImplPtr(actor);
+}
+/** @brief Detach an actor attached with `attach()`
+ *
+ *  This is called when the current actor has finished its job.
+ *  Used in the main thread, it waits for the simulation to finish before returning. When it returns, the other
+ *  simulated actors and the maestro are destroyed.
+ */
+void ActorImpl::detach()
 {
-  delete this->context_;
+  auto* context = dynamic_cast<context::AttachContext*>(context::Context::self());
+  if (context == nullptr)
+    xbt_die("Not a suitable context");
+
+  context->get_actor()->cleanup();
+  context->attach_stop();
 }
 
 void ActorImpl::cleanup()
@@ -95,7 +162,7 @@ void ActorImpl::exit()
 
   // Forcefully kill the actor if its host is turned off. Not a HostFailureException because you should not survive that
   if (not host_->is_on())
-    this->throw_exception(std::make_exception_ptr(simgrid::kernel::context::StopRequest("host failed")));
+    this->throw_exception(std::make_exception_ptr(ForcefulKillException("host failed")));
 
   /* destroy the blocking synchro if any */
   if (waiting_synchro != nullptr) {
@@ -204,14 +271,15 @@ void ActorImpl::yield()
   if (context_->iwannadie) {
 
     XBT_DEBUG("Actor %s@%s is dead", get_cname(), host_->get_cname());
-    // throw simgrid::kernel::context::StopRequest(); Does not seem to properly kill the actor
+    // throw simgrid::kernel::context::ForcefulKillException(); Does not seem to properly kill the actor
     context_->stop();
     THROW_IMPOSSIBLE;
   }
 
   if (suspended_) {
     XBT_DEBUG("Hey! I'm suspended.");
-    xbt_assert(exception_ != nullptr, "Gasp! This exception may be lost by subsequent calls.");
+
+    xbt_assert(exception_ == nullptr, "Gasp! This exception may be lost by subsequent calls.");
     suspended_ = false;
     suspend(this);
   }
@@ -274,7 +342,7 @@ activity::ActivityImplPtr ActorImpl::suspend(ActorImpl* issuer)
 
     return nullptr;
   } else {
-    return activity::ExecImplPtr(new activity::ExecImpl("suspend", "", nullptr, this->host_))->start(0.0, 1.0, 0.0);
+    return activity::ExecImplPtr(new activity::ExecImpl("suspend", ""))->set_host(host_)->start(0.0, 1.0, 0.0);
   }
 }
 
@@ -374,61 +442,79 @@ void ActorImpl::set_host(s4u::Host* dest)
   dest->pimpl_->process_list_.push_back(*this);
 }
 
-ActorImplPtr ActorImpl::create(std::string name, simix::ActorCode code, void* data, s4u::Host* host,
-                               std::unordered_map<std::string, std::string>* properties, ActorImpl* parent_actor)
+ActorImplPtr ActorImpl::init(std::string name, s4u::Host* host)
 {
+  ActorImpl* actor = new ActorImpl(simgrid::xbt::string(name), host);
+  actor->set_ppid(this->pid_);
 
-  XBT_DEBUG("Start actor %s@'%s'", name.c_str(), host->get_cname());
+  intrusive_ptr_add_ref(actor);
+  /* The on_creation() signal must be delayed until there, where the pid and everything is set */
+  s4u::Actor::on_creation(actor->iface());
 
-  if (not host->is_on()) {
-    XBT_WARN("Cannot launch actor '%s' on failed host '%s'", name.c_str(), host->get_cname());
-    return nullptr;
+  return ActorImplPtr(actor);
+}
+
+ActorImpl* ActorImpl::start(const simix::ActorCode& code)
+{
+  xbt_assert(code && host_ != nullptr, "Invalid parameters");
+
+  if (not host_->is_on()) {
+    XBT_WARN("Cannot launch actor '%s' on failed host '%s'", name_.c_str(), host_->get_cname());
+    intrusive_ptr_release(this);
+    std::rethrow_exception(
+        std::make_exception_ptr(simgrid::HostFailureException(XBT_THROW_POINT, "Cannot start actor on failed host.")));
   }
 
-  ActorImpl* actor = new ActorImpl(simgrid::xbt::string(name), host);
+  this->code = code;
+  XBT_VERB("Create context %s", get_cname());
+  context_.reset(simix_global->context_factory->create_context(simix::ActorCode(code), this));
 
-  xbt_assert(code && host != nullptr, "Invalid parameters");
-  /* actor data */
-  actor->set_user_data(data);
-  actor->code = code;
+  XBT_DEBUG("Start context '%s'", get_cname());
+
+  /* Add the actor to its host's actor list */
+  host_->pimpl_->process_list_.push_back(*this);
+  simix_global->process_list[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);
 
+  return this;
+}
+
+ActorImplPtr ActorImpl::create(std::string name, const simix::ActorCode& code, void* data, s4u::Host* host,
+                               std::unordered_map<std::string, std::string>* properties, ActorImpl* parent_actor)
+{
+  XBT_DEBUG("Start actor %s@'%s'", name.c_str(), host->get_cname());
+
+  ActorImplPtr actor;
   if (parent_actor != nullptr)
-    actor->set_ppid(parent_actor->get_pid());
+    actor = parent_actor->init(simgrid::xbt::string(name), host);
+  else
+    actor = SIMIX_process_self()->init(simgrid::xbt::string(name), host);
 
-  XBT_VERB("Create context %s", actor->get_cname());
-  actor->context_ = simix_global->context_factory->create_context(std::move(code), actor);
+  /* actor data */
+  actor->set_user_data(data);
 
   /* Add properties */
   if (properties != nullptr)
     for (auto const& kv : *properties)
       actor->set_property(kv.first, kv.second);
 
-  /* Add the actor to its host's actor list */
-  host->pimpl_->process_list_.push_back(*actor);
-
-  XBT_DEBUG("Start context '%s'", actor->get_cname());
-
-  /* Now insert it in the global actor list and in the actor 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);
-  intrusive_ptr_add_ref(actor);
+  actor->start(code);
 
-  /* The on_creation() signal must be delayed until there, where the pid and everything is set */
-  s4u::Actor::on_creation(actor->iface());
-
-  return ActorImplPtr(actor);
+  return actor;
 }
 
-void create_maestro(simix::ActorCode code)
+void create_maestro(const std::function<void()>& code)
 {
   /* Create maestro actor and initialize it */
   ActorImpl* maestro = new ActorImpl(xbt::string(""), /*host*/ nullptr);
 
   if (not code) {
-    maestro->context_ = simix_global->context_factory->create_context(simix::ActorCode(), maestro);
+    maestro->context_.reset(simix_global->context_factory->create_context(simix::ActorCode(), maestro));
   } else {
-    maestro->context_ = simix_global->context_factory->create_maestro(code, maestro);
+    maestro->context_.reset(simix_global->context_factory->create_maestro(simix::ActorCode(code), maestro));
   }
 
   maestro->simcall.issuer       = maestro;
@@ -439,68 +525,18 @@ void create_maestro(simix::ActorCode code)
 } // namespace kernel
 }
 
-smx_actor_t SIMIX_process_attach(const char* name, void* data, const char* hostname,
-                                 std::unordered_map<std::string, std::string>* properties, smx_actor_t parent_process)
+void SIMIX_process_detach()
 {
-  // This is mostly a copy/paste from SIMIX_process_new(),
-  // it'd be nice to share some code between those two functions.
-
-  sg_host_t host = sg_host_by_name(hostname);
-  XBT_DEBUG("Attach process %s on host '%s'", name, hostname);
-
-  if (not host->is_on()) {
-    XBT_WARN("Cannot launch process '%s' on failed host '%s'", name, hostname);
-    return nullptr;
-  }
-
-  smx_actor_t actor = new simgrid::kernel::actor::ActorImpl(simgrid::xbt::string(name), host);
-  /* Actor data */
-  actor->set_user_data(data);
-  actor->code = nullptr;
-
-  if (parent_process != nullptr)
-    actor->set_ppid(parent_process->get_pid());
-
-  XBT_VERB("Create context %s", actor->get_cname());
-  xbt_assert(simix_global != nullptr, "simix is not initialized, please call MSG_init first");
-  actor->context_ = simix_global->context_factory->attach(actor);
-
-  /* Add properties */
-  if (properties != nullptr)
-    for (auto const& kv : *properties)
-      actor->set_property(kv.first, kv.second);
-
-  /* Add the process to it's host process list */
-  host->pimpl_->process_list_.push_back(*actor);
-
-  /* Now insert it in the global process list and in the process 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);
-  intrusive_ptr_add_ref(actor);
-
-  auto* context = dynamic_cast<simgrid::kernel::context::AttachContext*>(actor->context_);
-  xbt_assert(nullptr != context, "Not a suitable context");
-  context->attach_start();
-
-  /* The on_creation() signal must be delayed until there, where the pid and everything is set */
-  simgrid::s4u::ActorPtr tmp = actor->iface(); // Passing this directly to on_creation will lead to crashes
-  simgrid::s4u::Actor::on_creation(tmp);
-
-  return actor;
+  simgrid::kernel::actor::ActorImpl::detach();
 }
 
-void SIMIX_process_detach()
+smx_actor_t SIMIX_process_attach(const char* name, void* data, const char* hostname,
+                                 std::unordered_map<std::string, std::string>* properties,
+                                 smx_actor_t /*parent_process*/)
 {
-  auto* context = dynamic_cast<simgrid::kernel::context::AttachContext*>(simgrid::kernel::context::Context::self());
-  if (context == nullptr)
-    xbt_die("Not a suitable context");
-
-  context->get_actor()->cleanup();
-  context->attach_stop();
+  return simgrid::kernel::actor::ActorImpl::attach(name, data, sg_host_by_name(hostname), properties).get();
 }
 
-
 /** @deprecated When this function gets removed, also remove the xbt_ex class, that is only there to help users to
  * transition */
 void SIMIX_process_throw(smx_actor_t actor, xbt_errcat_t cat, int value, const char* msg)
@@ -575,7 +611,7 @@ int SIMIX_process_count()
   return simix_global->process_list.size();
 }
 
-void* SIMIX_process_self_get_data()
+void* SIMIX_process_self_get_data() // deprecated
 {
   smx_actor_t self = SIMIX_process_self();
 
@@ -585,7 +621,7 @@ void* SIMIX_process_self_get_data()
   return self->get_user_data();
 }
 
-void SIMIX_process_self_set_data(void *data)
+void SIMIX_process_self_set_data(void* data) // deprecated
 {
   SIMIX_process_self()->set_user_data(data);
 }
@@ -668,7 +704,7 @@ void SIMIX_process_on_exit(smx_actor_t actor, int_f_pvoid_pvoid_t fun, void* dat
   SIMIX_process_on_exit(actor, [fun](int a, void* b) { fun((void*)(intptr_t)a, b); }, data);
 }
 
-void SIMIX_process_on_exit(smx_actor_t actor, std::function<void(int, void*)> fun, void* data)
+void SIMIX_process_on_exit(smx_actor_t actor, const std::function<void(bool, void*)>& fun, void* data)
 {
   xbt_assert(actor, "current process not found: are you in maestro context ?");