Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
[sonar] Constify pointer and reference parameters in src/kernel/.
[simgrid.git] / src / kernel / actor / ActorImpl.cpp
index 4c83228..fdf73a3 100644 (file)
@@ -32,20 +32,7 @@ XBT_LOG_NEW_DEFAULT_SUBCATEGORY(simix_process, simix, "Logging specific to SIMIX
  */
 smx_actor_t SIMIX_process_self()
 {
-  simgrid::kernel::context::Context* self_context = simgrid::kernel::context::Context::self();
-
-  return (self_context != nullptr) ? self_context->get_actor() : nullptr;
-}
-
-/**
- * @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)
-{
-
-  return process->comms.size() > 0;
+  return simgrid::kernel::actor::ActorImpl::self();
 }
 
 namespace simgrid {
@@ -58,7 +45,14 @@ int get_maxpid()
   return maxpid;
 }
 
-ActorImpl::ActorImpl(simgrid::xbt::string name, s4u::Host* host) : host_(host), name_(std::move(name)), piface_(this)
+ActorImpl* ActorImpl::self()
+{
+  context::Context* self_context = context::Context::self();
+
+  return (self_context != nullptr) ? self_context->get_actor() : nullptr;
+}
+
+ActorImpl::ActorImpl(xbt::string name, s4u::Host* host) : host_(host), name_(std::move(name)), piface_(this)
 {
   pid_           = maxpid++;
   simcall.issuer_ = this;
@@ -66,10 +60,10 @@ ActorImpl::ActorImpl(simgrid::xbt::string name, s4u::Host* host) : host_(host),
 
 ActorImpl::~ActorImpl()
 {
-  if (simix_global != nullptr && this != simix_global->maestro_process) {
+  if (simix_global != nullptr && this != simix_global->maestro_) {
     if (context_.get() != nullptr) /* the actor was not start()ed yet. This happens if its host was initially off */
       context_->iwannadie = false; // don't let the simcall's yield() do a Context::stop(), to avoid infinite loops
-    simgrid::kernel::actor::simcall([this] { simgrid::s4u::Actor::on_destruction(*ciface()); });
+    actor::simcall([this] { s4u::Actor::on_destruction(*ciface()); });
     if (context_.get() != nullptr)
       context_->iwannadie = true;
   }
@@ -88,11 +82,11 @@ ActorImplPtr ActorImpl::attach(const std::string& name, void* data, s4u::Host* h
 {
   // 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());
+  XBT_DEBUG("Attach actor %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());
-    throw simgrid::HostFailureException(XBT_THROW_POINT, "Cannot attach actor on failed host.");
+    XBT_WARN("Cannot attach actor '%s' on failed host '%s'", name.c_str(), host->get_cname());
+    throw HostFailureException(XBT_THROW_POINT, "Cannot attach actor on failed host.");
   }
 
   ActorImpl* actor = new ActorImpl(xbt::string(name), host);
@@ -108,21 +102,21 @@ ActorImplPtr ActorImpl::attach(const std::string& name, void* data, s4u::Host* h
   if (properties != nullptr)
     actor->set_properties(*properties);
 
-  /* Add the process to it's host process list */
-  host->pimpl_->process_list_.push_back(*actor);
+  /* Add the actor to it's host actor list */
+  host->pimpl_->add_actor(actor);
 
-  /* Now insert it in the global process list and in the process to run list */
+  /* 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);
   intrusive_ptr_add_ref(actor);
 
-  auto* context = dynamic_cast<simgrid::kernel::context::AttachContext*>(actor->context_.get());
+  auto* context = dynamic_cast<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::Actor::on_creation(*actor->ciface());
+  s4u::Actor::on_creation(*actor->ciface());
 
   return ActorImplPtr(actor);
 }
@@ -142,6 +136,20 @@ void ActorImpl::detach()
   context->attach_stop();
 }
 
+void ActorImpl::cleanup_from_simix()
+{
+  const std::lock_guard<std::mutex> lock(simix_global->mutex);
+  simix_global->process_list.erase(pid_);
+  if (host_ && host_actor_list_hook.is_linked())
+    host_->pimpl_->remove_actor(this);
+  if (not smx_destroy_list_hook.is_linked()) {
+#if SIMGRID_HAVE_MC
+    xbt_dynar_push_as(simix_global->dead_actors_vector, ActorImpl*, this);
+#endif
+    simix_global->actors_to_destroy.push_back(*this);
+  }
+}
+
 void ActorImpl::cleanup()
 {
   finished_ = true;
@@ -168,7 +176,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_process) /* Do not cleanup maestro */
+  if (this == simix_global->maestro_) /* Do not cleanup maestro */
     return;
 
   XBT_DEBUG("Cleanup actor %s (%p), waiting synchro %p", get_cname(), this, waiting_synchro.get());
@@ -178,23 +186,10 @@ void ActorImpl::cleanup()
     kill_timer->remove();
     kill_timer = nullptr;
   }
-
-  simix_global->mutex.lock();
-
-  simix_global->process_list.erase(pid_);
-  if (host_ && host_process_list_hook.is_linked())
-    simgrid::xbt::intrusive_erase(host_->pimpl_->process_list_, *this);
-  if (not smx_destroy_list_hook.is_linked()) {
-#if SIMGRID_HAVE_MC
-    xbt_dynar_push_as(simix_global->dead_actors_vector, ActorImpl*, this);
-#endif
-    simix_global->actors_to_destroy.push_back(*this);
-  }
-
-  simix_global->mutex.unlock();
+  cleanup_from_simix();
 
   context_->iwannadie = false; // don't let the simcall's yield() do a Context::stop(), to avoid infinite loops
-  simgrid::kernel::actor::simcall([this] { simgrid::s4u::Actor::on_termination(*ciface()); });
+  actor::simcall([this] { s4u::Actor::on_termination(*ciface()); });
   context_->iwannadie = true;
 }
 
@@ -207,7 +202,7 @@ void ActorImpl::exit()
   /* destroy the blocking synchro if any */
   if (waiting_synchro != nullptr) {
     waiting_synchro->cancel();
-    waiting_synchro->state_ = SIMIX_FAILED;
+    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);
@@ -233,6 +228,7 @@ void ActorImpl::exit()
 
 void ActorImpl::kill(ActorImpl* actor)
 {
+  xbt_assert(actor != simix_global->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());
@@ -287,7 +283,6 @@ void ActorImpl::yield()
 
   if (context_->iwannadie) {
     XBT_DEBUG("Actor %s@%s is dead", get_cname(), host_->get_cname());
-    // throw simgrid::kernel::context::ForcefulKillException(); Does not seem to properly kill the actor
     context_->stop();
     THROW_IMPOSSIBLE;
   }
@@ -337,7 +332,7 @@ void ActorImpl::undaemonize()
 
 s4u::Actor* ActorImpl::restart()
 {
-  xbt_assert(this != simix_global->maestro_process, "Restarting maestro is not supported");
+  xbt_assert(this != simix_global->maestro_, "Restarting maestro is not supported");
 
   XBT_DEBUG("Restarting actor %s on %s", get_cname(), host_->get_cname());
 
@@ -397,10 +392,10 @@ void ActorImpl::resume()
   XBT_OUT();
 }
 
-activity::ActivityImplPtr ActorImpl::join(ActorImpl* actor, double timeout)
+activity::ActivityImplPtr ActorImpl::join(const ActorImpl* actor, double timeout)
 {
   activity::ActivityImplPtr sleep = this->sleep(timeout);
-  SIMIX_process_on_exit(actor, [sleep](bool) {
+  actor->on_exit->emplace_back([sleep](bool) {
     if (sleep->surf_action_)
       sleep->surf_action_->finish(resource::Action::State::FINISHED);
   });
@@ -410,7 +405,7 @@ activity::ActivityImplPtr ActorImpl::join(ActorImpl* actor, double timeout)
 activity::ActivityImplPtr ActorImpl::sleep(double duration)
 {
   if (not host_->is_on())
-    throw_exception(std::make_exception_ptr(simgrid::HostFailureException(
+    throw_exception(std::make_exception_ptr(HostFailureException(
         XBT_THROW_POINT, std::string("Host ") + host_->get_cname() + " failed, you cannot sleep there.")));
 
   auto sleep = new activity::SleepImpl();
@@ -440,7 +435,7 @@ void ActorImpl::throw_exception(std::exception_ptr e)
 
 void ActorImpl::simcall_answer()
 {
-  if (this != simix_global->maestro_process){
+  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);
     simcall.call_ = SIMCALL_NONE;
@@ -454,9 +449,9 @@ void ActorImpl::simcall_answer()
 
 void ActorImpl::set_host(s4u::Host* dest)
 {
-  xbt::intrusive_erase(host_->pimpl_->process_list_, *this);
+  host_->pimpl_->remove_actor(this);
   host_ = dest;
-  dest->pimpl_->process_list_.push_back(*this);
+  dest->pimpl_->add_actor(this);
 }
 
 ActorImplPtr ActorImpl::init(const std::string& name, s4u::Host* host)
@@ -478,7 +473,7 @@ ActorImpl* ActorImpl::start(const simix::ActorCode& code)
   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);
-    throw simgrid::HostFailureException(XBT_THROW_POINT, "Cannot start actor on failed host.");
+    throw HostFailureException(XBT_THROW_POINT, "Cannot start actor on failed host.");
   }
 
   this->code_ = code;
@@ -488,7 +483,7 @@ ActorImpl* ActorImpl::start(const simix::ActorCode& code)
   XBT_DEBUG("Start context '%s'", get_cname());
 
   /* Add the actor to its host's actor list */
-  host_->pimpl_->process_list_.push_back(*this);
+  host_->pimpl_->add_actor(this);
   simix_global->process_list[pid_] = this;
 
   /* Now insert it in the global actor list and in the actor to run list */
@@ -507,7 +502,7 @@ ActorImplPtr ActorImpl::create(const std::string& name, const simix::ActorCode&
   if (parent_actor != nullptr)
     actor = parent_actor->init(xbt::string(name), host);
   else
-    actor = SIMIX_process_self()->init(xbt::string(name), host);
+    actor = self()->init(xbt::string(name), host);
 
   /* actor data */
   actor->set_user_data(data);
@@ -533,33 +528,22 @@ void create_maestro(const std::function<void()>& code)
   }
 
   maestro->simcall.issuer_      = maestro;
-  simix_global->maestro_process = maestro;
+  simix_global->maestro_        = maestro;
 }
 
 } // namespace actor
 } // namespace kernel
 } // namespace simgrid
 
-void SIMIX_process_detach() // deprecated v3.25
-{
-  simgrid::kernel::actor::ActorImpl::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*/) // deprecated 3.25
-{
-  return simgrid::kernel::actor::ActorImpl::attach(name, data, sg_host_by_name(hostname), properties).get();
-}
-
-int SIMIX_process_count()
+int SIMIX_process_count() // XBT_ATTRIB_DEPRECATED_v329
 {
   return simix_global->process_list.size();
 }
 
-void* SIMIX_process_self_get_data() // deprecated
+// XBT_DEPRECATED_v329
+void* SIMIX_process_self_get_data()
 {
-  smx_actor_t self = SIMIX_process_self();
+  smx_actor_t self = simgrid::kernel::actor::ActorImpl::self();
 
   if (self == nullptr) {
     return nullptr;
@@ -567,21 +551,17 @@ void* SIMIX_process_self_get_data() // deprecated
   return self->get_user_data();
 }
 
-void SIMIX_process_self_set_data(void* data) // deprecated
+// XBT_DEPRECATED_v329
+void SIMIX_process_self_set_data(void* data)
 {
-  SIMIX_process_self()->set_user_data(data);
+  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()
 {
-
-  smx_actor_t process = SIMIX_process_self();
-  if (process == nullptr || process == simix_global->maestro_process)
-    return "maestro";
-
-  return process->get_cname();
+  return SIMIX_is_maestro() ? "maestro" : simgrid::kernel::actor::ActorImpl::self()->get_cname();
 }
 
 /**
@@ -592,14 +572,6 @@ const char* SIMIX_process_self_get_name()
  * @param self the current process
  */
 
-/** @brief Returns the list of processes to run.
- * @deprecated
- */
-const std::vector<smx_actor_t>& simgrid::simix::process_get_runnable()
-{
-  return simix_global->actors_to_run;
-}
-
 /** @brief Returns the process from PID. */
 smx_actor_t SIMIX_process_from_PID(aid_t PID)
 {
@@ -613,20 +585,8 @@ smx_actor_t SIMIX_process_from_PID(aid_t PID)
   return item->second;
 }
 
-void SIMIX_process_on_exit(smx_actor_t actor, int_f_pvoid_pvoid_t fun, void* data)
-{
-  SIMIX_process_on_exit(actor, [fun, data](bool failed) {
-    intptr_t status = failed ? SMX_EXIT_FAILURE : SMX_EXIT_SUCCESS;
-    fun(reinterpret_cast<void*>(status), data);
-  });
-}
-
-void SIMIX_process_on_exit(smx_actor_t actor, const std::function<void(int, void*)>& fun, void* data)
-{
-  SIMIX_process_on_exit(actor, [fun, data](bool failed) { fun(failed ? SMX_EXIT_FAILURE : SMX_EXIT_SUCCESS, data); });
-}
-
-void SIMIX_process_on_exit(smx_actor_t actor, const std::function<void(bool /*failed*/)>& fun)
+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);
@@ -650,7 +610,7 @@ void SIMIX_process_on_exit(smx_actor_t actor, const std::function<void(bool /*fa
 smx_actor_t simcall_process_create(const std::string& name, const simgrid::simix::ActorCode& code, void* data,
                                    sg_host_t host, std::unordered_map<std::string, std::string>* properties)
 {
-  smx_actor_t self = SIMIX_process_self();
+  smx_actor_t self = simgrid::kernel::actor::ActorImpl::self();
   return simgrid::kernel::actor::simcall([&name, &code, data, host, properties, self] {
     return simgrid::kernel::actor::ActorImpl::create(name, code, data, host, properties, self).get();
   });