Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
add and use callback instr_actor_on_creation
[simgrid.git] / src / simix / ActorImpl.cpp
index 71f32ef..07e515a 100644 (file)
@@ -1,39 +1,27 @@
-/* Copyright (c) 2007-2017. The SimGrid Team. All rights reserved.          */
+/* Copyright (c) 2007-2018. 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 <exception>
-#include <functional>
-#include <map>
-#include <string>
-#include <utility>
-
-#include <boost/range/algorithm.hpp>
-
-#include "xbt/ex.hpp"
-#include "xbt/functional.hpp"
-#include "xbt/log.h"
-#include "xbt/sysdep.h"
-
-#include "simgrid/s4u/Host.hpp"
-
 #include "mc/mc.h"
-
-#include "smx_private.h"
+#include "smx_private.hpp"
 #include "src/kernel/activity/SleepImpl.hpp"
 #include "src/kernel/activity/SynchroIo.hpp"
 #include "src/kernel/activity/SynchroRaw.hpp"
-#include "src/mc/mc_replay.h"
+#include "src/mc/mc_replay.hpp"
 #include "src/mc/remote/Client.hpp"
-#include "src/msg/msg_private.h"
+#include "src/simix/smx_host_private.hpp"
+#include "src/simix/smx_io_private.hpp"
+#include "src/simix/smx_synchro_private.hpp"
 #include "src/surf/cpu_interface.hpp"
-#include "src/surf/surf_interface.hpp"
+#include "xbt/ex.hpp"
 
 #ifdef HAVE_SMPI
 #include "src/smpi/include/private.hpp"
 #endif
 
+#include <boost/range/algorithm.hpp>
+
 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(simix_process, simix, "Logging specific to SIMIX (process)");
 
 unsigned long simix_process_maxpid = 0;
@@ -112,9 +100,14 @@ void SIMIX_process_cleanup(smx_actor_t process)
 
   XBT_DEBUG("%p should not be run anymore",process);
   simix_global->process_list.erase(process->pid);
-  if (process->host)
-    xbt_swag_remove(process, process->host->extension<simgrid::simix::Host>()->process_list);
-  xbt_swag_insert(process, simix_global->process_to_destroy);
+  if (process->host && process->host_process_list_hook.is_linked())
+    simgrid::xbt::intrusive_erase(process->host->extension<simgrid::simix::Host>()->process_list, *process);
+  if (not process->smx_destroy_list_hook.is_linked()) {
+#if SIMGRID_HAVE_MC
+    xbt_dynar_push_as(simix_global->dead_actors_vector, smx_actor_t, process);
+#endif
+    simix_global->process_to_destroy.push_back(*process);
+  }
   process->context->iwannadie = 0;
 
   xbt_os_mutex_release(simix_global->mutex);
@@ -127,17 +120,21 @@ void SIMIX_process_cleanup(smx_actor_t process)
  */
 void SIMIX_process_empty_trash()
 {
-  smx_actor_t process = static_cast<smx_actor_t>(xbt_swag_extract(simix_global->process_to_destroy));
-
-  while (process) {
+  while (not simix_global->process_to_destroy.empty()) {
+    smx_actor_t process = &simix_global->process_to_destroy.front();
+    simix_global->process_to_destroy.pop_front();
     XBT_DEBUG("Getting rid of %p",process);
     intrusive_ptr_release(process);
-    process = static_cast<smx_actor_t>(xbt_swag_extract(simix_global->process_to_destroy));
   }
+#if SIMGRID_HAVE_MC
+  xbt_dynar_reset(simix_global->dead_actors_vector);
+#endif
 }
 
 namespace simgrid {
-namespace simix {
+
+namespace kernel {
+namespace actor {
 
 ActorImpl::~ActorImpl()
 {
@@ -169,11 +166,11 @@ void ActorImpl::daemonize()
 
 simgrid::s4u::Actor* ActorImpl::restart()
 {
-  XBT_DEBUG("Restarting process %s on %s", cname(), host->getCname());
+  XBT_DEBUG("Restarting process %s on %s", get_cname(), host->get_cname());
 
   // retrieve the arguments of the old process
   // FIXME: Factorize this with SIMIX_host_add_auto_restart_process ?
-  simgrid::simix::ProcessArg arg;
+  simgrid::kernel::actor::ProcessArg arg;
   arg.name         = name;
   arg.code         = code;
   arg.host         = host;
@@ -213,7 +210,7 @@ smx_activity_t ActorImpl::suspend(ActorImpl* issuer)
 
     return nullptr;
   } else {
-    return SIMIX_execution_start(this, "suspend", 0.0, 1.0, 0.0);
+    return SIMIX_execution_start("suspend", 0.0, 1.0, 0.0, this->host);
   }
 }
 
@@ -240,12 +237,12 @@ void ActorImpl::resume()
 smx_activity_t ActorImpl::sleep(double duration)
 {
   if (host->isOff())
-    THROWF(host_error, 0, "Host %s failed, you cannot sleep there.", host->getCname());
+    THROWF(host_error, 0, "Host %s failed, you cannot sleep there.", host->get_cname());
 
   simgrid::kernel::activity::SleepImpl* synchro = new simgrid::kernel::activity::SleepImpl();
   synchro->host                                 = host;
   synchro->surf_sleep                           = host->pimpl_cpu->sleep(duration);
-  synchro->surf_sleep->setData(synchro);
+  synchro->surf_sleep->set_data(synchro);
   XBT_DEBUG("Create sleep synchronization %p", synchro);
 
   return synchro;
@@ -255,10 +252,10 @@ void create_maestro(std::function<void()> code)
 {
   smx_actor_t maestro = nullptr;
   /* Create maestro process and initialize it */
-  maestro = new simgrid::simix::ActorImpl();
+  maestro           = new simgrid::kernel::actor::ActorImpl();
   maestro->pid = simix_process_maxpid++;
   maestro->name = "";
-  maestro->userdata = nullptr;
+  maestro->setUserData(nullptr);
 
   if (not code) {
     maestro->context = SIMIX_context_new(std::function<void()>(), nullptr, maestro);
@@ -272,13 +269,14 @@ void create_maestro(std::function<void()> code)
   simix_global->maestro_process = maestro;
 }
 
+} // namespace actor
 }
 }
 
 /** @brief Creates and runs the maestro process */
 void SIMIX_maestro_create(void (*code)(void*), void* data)
 {
-  simgrid::simix::create_maestro(std::bind(code, data));
+  simgrid::kernel::actor::create_maestro(std::bind(code, data));
 }
 
 /**
@@ -294,35 +292,25 @@ smx_actor_t SIMIX_process_create(const char* name, std::function<void()> code, v
                                  std::map<std::string, std::string>* properties, smx_actor_t parent_process)
 {
 
-  XBT_DEBUG("Start process %s on host '%s'", name, host->getCname());
+  XBT_DEBUG("Start process %s on host '%s'", name, host->get_cname());
 
   if (host->isOff()) {
-    XBT_WARN("Cannot launch process '%s' on failed host '%s'", name, host->getCname());
+    XBT_WARN("Cannot launch process '%s' on failed host '%s'", name, host->get_cname());
     return nullptr;
   }
 
-  smx_actor_t process = new simgrid::simix::ActorImpl();
+  smx_actor_t process = new simgrid::kernel::actor::ActorImpl();
 
   xbt_assert(code && host != nullptr, "Invalid parameters");
   /* Process data */
   process->pid            = simix_process_maxpid++;
   process->name           = simgrid::xbt::string(name);
   process->host           = host;
-  process->userdata       = data;
+  process->setUserData(data);
   process->simcall.issuer = process;
 
   if (parent_process != nullptr) {
     process->ppid = parent_process->pid;
-/* SMPI process have their own data segment and each other inherit from their father */
-#if HAVE_SMPI
-    if (smpi_privatize_global_variables == SMPI_PRIVATIZE_MMAP) {
-      if (parent_process->pid != 0) {
-        process->segment_index = parent_process->segment_index;
-      } else {
-        process->segment_index = process->pid - 1;
-      }
-    }
-#endif
   }
 
   process->code         = code;
@@ -339,19 +327,20 @@ smx_actor_t SIMIX_process_create(const char* name, std::function<void()> code, v
   if (host->extension<simgrid::simix::Host>() == nullptr)
     host->extension_set<simgrid::simix::Host>(new simgrid::simix::Host());
 
-  /* Add the process to its host process list */
-  xbt_swag_insert(process, host->extension<simgrid::simix::Host>()->process_list);
+  /* Add the process to its host's process list */
+  host->extension<simgrid::simix::Host>()->process_list.push_back(*process);
 
   XBT_DEBUG("Start context '%s'", process->name.c_str());
 
   /* Now insert it in the global process list and in the process to run list */
   simix_global->process_list[process->pid] = process;
-  XBT_DEBUG("Inserting %s(%s) in the to_run list", process->cname(), host->getCname());
+  XBT_DEBUG("Inserting %s(%s) in the to_run list", process->get_cname(), host->get_cname());
   simix_global->process_to_run.push_back(process);
   intrusive_ptr_add_ref(process);
 
-  /* Tracing the process creation */
-  TRACE_msg_process_create(process->cname(), process->pid, process->host);
+  /* The onCreation() signal must be delayed until there, where the pid and everything is set */
+  simgrid::s4u::ActorPtr tmp = process->iface(); // Passing this directly to onCreation will lead to crashes
+  simgrid::s4u::Actor::on_creation(tmp);
 
   return process;
 }
@@ -370,26 +359,16 @@ smx_actor_t SIMIX_process_attach(const char* name, void* data, const char* hostn
     return nullptr;
   }
 
-  smx_actor_t process = new simgrid::simix::ActorImpl();
+  smx_actor_t process = new simgrid::kernel::actor::ActorImpl();
   /* Process data */
   process->pid = simix_process_maxpid++;
   process->name = std::string(name);
   process->host = host;
-  process->userdata       = data;
+  process->setUserData(data);
   process->simcall.issuer = process;
 
   if (parent_process != nullptr) {
     process->ppid = parent_process->pid;
-    /* SMPI process have their own data segment and each other inherit from their father */
-#if HAVE_SMPI
-    if (smpi_privatize_global_variables == SMPI_PRIVATIZE_MMAP) {
-      if (parent_process->pid != 0) {
-        process->segment_index = parent_process->segment_index;
-      } else {
-        process->segment_index = process->pid - 1;
-      }
-    }
-#endif
   }
 
   /* Process data for auto-restart */
@@ -406,34 +385,37 @@ smx_actor_t SIMIX_process_attach(const char* name, void* data, const char* hostn
       process->setProperty(kv.first, kv.second);
 
   /* Add the process to it's host process list */
-  xbt_swag_insert(process, host->extension<simgrid::simix::Host>()->process_list);
+  host->extension<simgrid::simix::Host>()->process_list.push_back(*process);
 
   /* Now insert it in the global process list and in the process to run list */
   simix_global->process_list[process->pid] = process;
-  XBT_DEBUG("Inserting %s(%s) in the to_run list", process->cname(), host->getCname());
+  XBT_DEBUG("Inserting %s(%s) in the to_run list", process->get_cname(), host->get_cname());
   simix_global->process_to_run.push_back(process);
+  intrusive_ptr_add_ref(process);
 
-  /* Tracing the process creation */
-  TRACE_msg_process_create(process->cname(), process->pid, process->host);
 
-  auto context = dynamic_cast<simgrid::kernel::context::AttachContext*>(process->context);
+  auto* context = dynamic_cast<simgrid::kernel::context::AttachContext*>(process->context);
   if (not context)
     xbt_die("Not a suitable context");
 
   context->attach_start();
+
+  /* The onCreation() signal must be delayed until there, where the pid and everything is set */
+  simgrid::s4u::ActorPtr tmp = process->iface(); // Passing this directly to onCreation will lead to crashes
+  simgrid::s4u::Actor::on_creation(tmp);
+
   return process;
 }
 
 void SIMIX_process_detach()
 {
-  auto context = dynamic_cast<simgrid::kernel::context::AttachContext*>(SIMIX_context_self());
+  auto* context = dynamic_cast<simgrid::kernel::context::AttachContext*>(SIMIX_context_self());
   if (not context)
     xbt_die("Not a suitable context");
 
   auto process = context->process();
   simix_global->cleanup_process_function(process);
   context->attach_stop();
-  delete process;
 }
 
 /**
@@ -464,7 +446,14 @@ void SIMIX_process_runall()
  */
 void SIMIX_process_kill(smx_actor_t process, smx_actor_t issuer) {
 
-  XBT_DEBUG("Killing process %s@%s", process->cname(), process->host->getCname());
+  if (process->finished) {
+    XBT_DEBUG("Ignoring request to kill process %s@%s that is already dead", process->get_cname(),
+              process->host->get_cname());
+    return;
+  }
+
+  XBT_DEBUG("Actor '%s'@%s is killing actor '%s'@%s", issuer->get_cname(), issuer->host->get_cname(),
+            process->get_cname(), process->host->get_cname());
 
   process->context->iwannadie = 1;
   process->blocked = 0;
@@ -486,7 +475,11 @@ void SIMIX_process_kill(smx_actor_t process, smx_actor_t issuer) {
         boost::dynamic_pointer_cast<simgrid::kernel::activity::IoImpl>(process->waiting_synchro);
 
     if (exec != nullptr) {
-      /* Nothing to do */
+      if (exec->surfAction_) {
+        exec->surfAction_->cancel();
+        exec->surfAction_->unref();
+        exec->surfAction_ = nullptr;
+      }
     } else if (comm != nullptr) {
       process->comms.remove(process->waiting_synchro);
       comm->cancel();
@@ -534,8 +527,8 @@ void SIMIX_process_throw(smx_actor_t process, xbt_errcat_t cat, int value, const
 
     simgrid::kernel::activity::ExecImplPtr exec =
         boost::dynamic_pointer_cast<simgrid::kernel::activity::ExecImpl>(process->waiting_synchro);
-    if (exec != nullptr && exec->surf_exec)
-      exec->surf_exec->cancel();
+    if (exec != nullptr && exec->surfAction_)
+      exec->surfAction_->cancel();
 
     simgrid::kernel::activity::CommImplPtr comm =
         boost::dynamic_pointer_cast<simgrid::kernel::activity::CommImpl>(process->waiting_synchro);
@@ -572,33 +565,23 @@ void SIMIX_process_throw(smx_actor_t process, xbt_errcat_t cat, int value, const
 
 }
 
-void simcall_HANDLER_process_killall(smx_simcall_t simcall, int reset_pid) {
-  SIMIX_process_killall(simcall->issuer, reset_pid);
-}
 /**
  * \brief Kills all running processes.
  * \param issuer this one will not be killed
  */
-void SIMIX_process_killall(smx_actor_t issuer, int reset_pid)
+void SIMIX_process_killall(smx_actor_t issuer)
 {
   for (auto const& kv : simix_global->process_list)
     if (kv.second != issuer)
       SIMIX_process_kill(kv.second, issuer);
-
-  if (reset_pid > 0)
-    simix_process_maxpid = reset_pid;
-
-  SIMIX_context_runall();
-
-  SIMIX_process_empty_trash();
 }
 
-void SIMIX_process_change_host(smx_actor_t process, sg_host_t dest)
+void SIMIX_process_change_host(smx_actor_t actor, sg_host_t dest)
 {
-  xbt_assert((process != nullptr), "Invalid parameters");
-  xbt_swag_remove(process, process->host->extension<simgrid::simix::Host>()->process_list);
-  process->host = dest;
-  xbt_swag_insert(process, dest->extension<simgrid::simix::Host>()->process_list);
+  xbt_assert((actor != nullptr), "Invalid parameters");
+  simgrid::xbt::intrusive_erase(actor->host->extension<simgrid::simix::Host>()->process_list, *actor);
+  actor->host = dest;
+  dest->extension<simgrid::simix::Host>()->process_list.push_back(*actor);
 }
 
 void simcall_HANDLER_process_suspend(smx_simcall_t simcall, smx_actor_t process)
@@ -651,14 +634,6 @@ const char* SIMIX_process_self_get_name() {
   return process->name.c_str();
 }
 
-smx_actor_t SIMIX_process_get_by_name(const char* name)
-{
-  for (auto const& kv : simix_global->process_list)
-    if (kv.second->name == name)
-      return kv.second;
-  return nullptr;
-}
-
 void simcall_HANDLER_process_join(smx_simcall_t simcall, smx_actor_t process, double timeout)
 {
   if (process->finished) {
@@ -672,47 +647,19 @@ void simcall_HANDLER_process_join(smx_simcall_t simcall, smx_actor_t process, do
   simcall->issuer->waiting_synchro = sync;
 }
 
-static int SIMIX_process_join_finish(smx_process_exit_status_t status, smx_actor_t process, smx_activity_t sleep_act)
-{
-  simgrid::kernel::activity::SleepImpl* sleep = static_cast<simgrid::kernel::activity::SleepImpl*>(sleep_act.get());
-  if (sleep->surf_sleep) {
-    sleep->surf_sleep->cancel();
-
-    while (not sleep->simcalls.empty()) {
-      smx_simcall_t simcall = sleep->simcalls.front();
-      sleep->simcalls.pop_front();
-      simcall_process_sleep__set__result(simcall, SIMIX_DONE);
-      simcall->issuer->waiting_synchro = nullptr;
-      if (simcall->issuer->suspended) {
-        XBT_DEBUG("Wait! This process is suspended and can't wake up now.");
-        simcall->issuer->suspended = 0;
-        simcall_HANDLER_process_suspend(simcall, simcall->issuer);
-      } else {
-        SIMIX_simcall_answer(simcall);
-      }
-    }
-    sleep->surf_sleep->unref();
-    sleep->surf_sleep = nullptr;
-  }
-  intrusive_ptr_release(process);
-  intrusive_ptr_release(sleep_act.get());
-  return 0;
-}
-
 smx_activity_t SIMIX_process_join(smx_actor_t issuer, smx_actor_t process, double timeout)
 {
   smx_activity_t res = issuer->sleep(timeout);
   intrusive_ptr_add_ref(res.get());
-  intrusive_ptr_add_ref(process);
   SIMIX_process_on_exit(process,
                         [](void*, void* arg) {
-                          auto argp = static_cast<std::pair<smx_actor_t, smx_activity_t>*>(arg);
-                          int res   = simgrid::simix::kernelImmediate(
-                              [&] { return SIMIX_process_join_finish(SMX_EXIT_SUCCESS, argp->first, argp->second); });
-                          delete argp;
-                          return res;
+                          auto sleep = static_cast<simgrid::kernel::activity::SleepImpl*>(arg);
+                          if (sleep->surf_sleep)
+                            sleep->surf_sleep->finish(simgrid::kernel::resource::Action::State::done);
+                          intrusive_ptr_release(sleep);
+                          return 0;
                         },
-                        new std::pair<smx_actor_t, smx_activity_t>(process, res));
+                        res.get());
   return res;
 }
 
@@ -750,7 +697,7 @@ void SIMIX_process_sleep_destroy(smx_activity_t synchro)
  */
 void SIMIX_process_yield(smx_actor_t self)
 {
-  XBT_DEBUG("Yield actor '%s'", self->cname());
+  XBT_DEBUG("Yield actor '%s'", self->get_cname());
 
   /* Go into sleep and return control to maestro */
   self->context->suspend();
@@ -758,11 +705,6 @@ void SIMIX_process_yield(smx_actor_t self)
   /* Ok, maestro returned control to us */
   XBT_DEBUG("Control returned to me: '%s'", self->name.c_str());
 
-  if (self->new_host) {
-    SIMIX_process_change_host(self, self->new_host);
-    self->new_host = nullptr;
-  }
-
   if (self->context->iwannadie){
     XBT_DEBUG("I wanna die!");
     self->finished = true;
@@ -770,11 +712,11 @@ void SIMIX_process_yield(smx_actor_t self)
     SIMIX_process_on_exit_runall(self);
     /* Add the process to the list of process to restart, only if the host is down */
     if (self->auto_restart && self->host->isOff()) {
-      SIMIX_host_add_auto_restart_process(self->host, self->cname(), self->code, self->userdata,
+      SIMIX_host_add_auto_restart_process(self->host, self->get_cname(), self->code, self->getUserData(),
                                           SIMIX_timer_get_date(self->kill_timer), self->getProperties(),
                                           self->auto_restart);
     }
-    XBT_DEBUG("Process %s@%s is dead", self->cname(), self->host->getCname());
+    XBT_DEBUG("Process %s@%s is dead", self->get_cname(), self->host->get_cname());
     self->context->stop();
   }
 
@@ -792,18 +734,11 @@ void SIMIX_process_yield(smx_actor_t self)
     std::rethrow_exception(std::move(exception));
   }
 
-  if(SMPI_switch_data_segment && self->segment_index != -1){
-    SMPI_switch_data_segment(self->segment_index);
+  if (SMPI_switch_data_segment && not self->finished) {
+    SMPI_switch_data_segment(self->iface());
   }
 }
 
-/* callback: termination */
-void SIMIX_process_exception_terminate(xbt_ex_t * e)
-{
-  xbt_ex_display(e);
-  xbt_abort();
-}
-
 /** @brief Returns the list of processes to run. */
 const std::vector<smx_actor_t>& simgrid::simix::process_get_runnable()
 {
@@ -818,6 +753,7 @@ smx_actor_t SIMIX_process_from_PID(aid_t PID)
 }
 
 void SIMIX_process_on_exit_runall(smx_actor_t process) {
+  simgrid::s4u::Actor::on_destruction(process->iface());
   smx_process_exit_status_t exit_status = (process->context->iwannadie) ? SMX_EXIT_FAILURE : SMX_EXIT_SUCCESS;
   while (not process->on_exit.empty()) {
     s_smx_process_exit_fun_t exit_fun = process->on_exit.back();
@@ -853,16 +789,14 @@ void SIMIX_process_auto_restart_set(smx_actor_t process, int auto_restart) {
  * \param code the main function of the process
  * \param data a pointer to any data one may want to attach to the new object. It is for user-level information and can
  * be nullptr.
- * It can be retrieved with the function \ref simcall_process_get_data.
+ * It can be retrieved with the method ActorImpl::getUserData().
  * \param host where the new agent is executed.
- * \param kill_time time when the process is killed
  * \param argc first argument passed to \a code
  * \param argv second argument passed to \a code
  * \param properties the properties of the process
- * \param auto_restart either it is autorestarting or not.
  */
-extern "C" smx_actor_t simcall_process_create(const char* name, xbt_main_func_t code, void* data, sg_host_t host,
-                                              int argc, char** argv, std::map<std::string, std::string>* properties)
+smx_actor_t simcall_process_create(const char* name, xbt_main_func_t code, void* data, sg_host_t host, int argc,
+                                   char** argv, std::map<std::string, std::string>* properties)
 {
   if (name == nullptr)
     name = "";