Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
Use new style SIMIX_process_on_exit().
[simgrid.git] / src / simix / ActorImpl.cpp
index 5d347f1..b83645a 100644 (file)
@@ -1,40 +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 "xbt/utility.hpp"
-
-#include "simgrid/s4u/Host.hpp"
-
 #include "mc/mc.h"
-
 #include "smx_private.hpp"
+#include "src/kernel/activity/IoImpl.hpp"
 #include "src/kernel/activity/SleepImpl.hpp"
-#include "src/kernel/activity/SynchroIo.hpp"
 #include "src/kernel/activity/SynchroRaw.hpp"
 #include "src/mc/mc_replay.hpp"
 #include "src/mc/remote/Client.hpp"
-#include "src/msg/msg_private.hpp"
+#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;
@@ -93,11 +80,11 @@ void SIMIX_process_cleanup(smx_actor_t process)
 
     if (comm->src_proc == process) {
       XBT_DEBUG("Found an unfinished send comm %p (detached = %d), state %d, src = %p, dst = %p", comm.get(),
-                comm->detached, (int)comm->state, comm->src_proc, comm->dst_proc);
+                comm->detached, (int)comm->state_, comm->src_proc, comm->dst_proc);
       comm->src_proc = nullptr;
 
     } else if (comm->dst_proc == process) {
-      XBT_DEBUG("Found an unfinished recv comm %p, state %d, src = %p, dst = %p", comm.get(), (int)comm->state,
+      XBT_DEBUG("Found an unfinished recv comm %p, state %d, src = %p, dst = %p", comm.get(), (int)comm->state_,
                 comm->src_proc, comm->dst_proc);
       comm->dst_proc = nullptr;
 
@@ -146,14 +133,15 @@ void SIMIX_process_empty_trash()
 
 namespace simgrid {
 
-namespace simix {
+namespace kernel {
+namespace actor {
 
 ActorImpl::~ActorImpl()
 {
   delete this->context;
 }
 
-static int dying_daemon(void* exit_status, void* data)
+static void dying_daemon(int /*exit_status*/, void* data)
 {
   std::vector<ActorImpl*>* vect = &simix_global->daemons;
 
@@ -163,9 +151,8 @@ static int dying_daemon(void* exit_status, void* data)
   /* Don't move the whole content since we don't really care about the order */
   std::swap(*it, vect->back());
   vect->pop_back();
-
-  return 0;
 }
+
 /** This process will be terminated automatically when the last non-daemon process finishes */
 void ActorImpl::daemonize()
 {
@@ -178,11 +165,11 @@ void ActorImpl::daemonize()
 
 simgrid::s4u::Actor* ActorImpl::restart()
 {
-  XBT_DEBUG("Restarting process %s on %s", getCname(), 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;
@@ -248,13 +235,13 @@ 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());
+  if (host->is_off())
+    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;
@@ -264,10 +251,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);
@@ -281,13 +268,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));
 }
 
 /**
@@ -303,21 +291,21 @@ 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());
+  if (host->is_off()) {
+    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) {
@@ -332,7 +320,7 @@ smx_actor_t SIMIX_process_create(const char* name, std::function<void()> code, v
   /* Add properties */
   if (properties != nullptr)
     for (auto const& kv : *properties)
-      process->setProperty(kv.first, kv.second);
+      process->set_property(kv.first, kv.second);
 
   /* Make sure that the process is initialized for simix, in case we are called from the Host::onCreation signal */
   if (host->extension<simgrid::simix::Host>() == nullptr)
@@ -345,15 +333,13 @@ smx_actor_t SIMIX_process_create(const char* name, std::function<void()> code, v
 
   /* 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->getCname(), 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->getName(), 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::onCreation(tmp);
+  simgrid::s4u::Actor::on_creation(tmp);
 
   return process;
 }
@@ -367,17 +353,17 @@ smx_actor_t SIMIX_process_attach(const char* name, void* data, const char* hostn
   sg_host_t host = sg_host_by_name(hostname);
   XBT_DEBUG("Attach process %s on host '%s'", name, hostname);
 
-  if (host->isOff()) {
+  if (host->is_off()) {
     XBT_WARN("Cannot launch process '%s' on failed host '%s'", name, hostname);
     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) {
@@ -395,37 +381,40 @@ smx_actor_t SIMIX_process_attach(const char* name, void* data, const char* hostn
   /* Add properties */
   if (properties != nullptr)
     for (auto const& kv : *properties)
-      process->setProperty(kv.first, kv.second);
+      process->set_property(kv.first, kv.second);
 
   /* Add the process to it's 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->getCname(), 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->getName(), 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;
 }
 
 /**
@@ -457,13 +446,13 @@ void SIMIX_process_runall()
 void SIMIX_process_kill(smx_actor_t process, smx_actor_t issuer) {
 
   if (process->finished) {
-    XBT_DEBUG("Ignoring request to kill process %s@%s that is already dead", process->getCname(),
-              process->host->getCname());
+    XBT_DEBUG("Ignoring request to kill process %s@%s that is already dead", process->get_cname(),
+              process->host->get_cname());
     return;
   }
 
-  simgrid::s4u::Actor::onDestruction(process->iface());
-  XBT_DEBUG("Killing process %s@%s", process->getCname(), process->host->getCname());
+  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;
@@ -485,18 +474,18 @@ 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) {
-      if (exec->surfAction_) {
-        exec->surfAction_->cancel();
-        exec->surfAction_->unref();
-        exec->surfAction_ = nullptr;
+      if (exec->surf_action_) {
+        exec->surf_action_->cancel();
+        exec->surf_action_->unref();
+        exec->surf_action_ = nullptr;
       }
     } else if (comm != nullptr) {
       process->comms.remove(process->waiting_synchro);
       comm->cancel();
       // Remove first occurrence of &process->simcall:
-      auto i = boost::range::find(process->waiting_synchro->simcalls, &process->simcall);
-      if (i != process->waiting_synchro->simcalls.end())
-        process->waiting_synchro->simcalls.remove(&process->simcall);
+      auto i = boost::range::find(process->waiting_synchro->simcalls_, &process->simcall);
+      if (i != process->waiting_synchro->simcalls_.end())
+        process->waiting_synchro->simcalls_.remove(&process->simcall);
     } else if (sleep != nullptr) {
       SIMIX_process_sleep_destroy(process->waiting_synchro);
 
@@ -537,8 +526,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->surfAction_)
-      exec->surfAction_->cancel();
+    if (exec != nullptr && exec->surf_action_)
+      exec->surf_action_->cancel();
 
     simgrid::kernel::activity::CommImplPtr comm =
         boost::dynamic_pointer_cast<simgrid::kernel::activity::CommImpl>(process->waiting_synchro);
@@ -575,21 +564,15 @@ 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;
 }
 
 void SIMIX_process_change_host(smx_actor_t actor, sg_host_t dest)
@@ -607,7 +590,7 @@ void simcall_HANDLER_process_suspend(smx_simcall_t simcall, smx_actor_t process)
   if (process != simcall->issuer) {
     SIMIX_simcall_answer(simcall);
   } else {
-    sync_suspend->simcalls.push_back(simcall);
+    sync_suspend->simcalls_.push_back(simcall);
     process->waiting_synchro = sync_suspend;
     process->waiting_synchro->suspend();
   }
@@ -650,14 +633,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) {
@@ -667,7 +642,7 @@ void simcall_HANDLER_process_join(smx_simcall_t simcall, smx_actor_t process, do
     return;
   }
   smx_activity_t sync = SIMIX_process_join(simcall->issuer, process, timeout);
-  sync->simcalls.push_back(simcall);
+  sync->simcalls_.push_back(simcall);
   simcall->issuer->waiting_synchro = sync;
 }
 
@@ -676,12 +651,11 @@ smx_activity_t SIMIX_process_join(smx_actor_t issuer, smx_actor_t process, doubl
   smx_activity_t res = issuer->sleep(timeout);
   intrusive_ptr_add_ref(res.get());
   SIMIX_process_on_exit(process,
-                        [](void*, void* arg) {
+                        [](int, void* arg) {
                           auto sleep = static_cast<simgrid::kernel::activity::SleepImpl*>(arg);
                           if (sleep->surf_sleep)
-                            sleep->surf_sleep->finish(simgrid::surf::Action::State::done);
+                            sleep->surf_sleep->finish(simgrid::kernel::resource::Action::State::FINISHED);
                           intrusive_ptr_release(sleep);
-                          return 0;
                         },
                         res.get());
   return res;
@@ -696,7 +670,7 @@ void simcall_HANDLER_process_sleep(smx_simcall_t simcall, double duration)
     return;
   }
   smx_activity_t sync = simcall->issuer->sleep(duration);
-  sync->simcalls.push_back(simcall);
+  sync->simcalls_.push_back(simcall);
   simcall->issuer->waiting_synchro = sync;
 }
 
@@ -721,7 +695,7 @@ void SIMIX_process_sleep_destroy(smx_activity_t synchro)
  */
 void SIMIX_process_yield(smx_actor_t self)
 {
-  XBT_DEBUG("Yield actor '%s'", self->getCname());
+  XBT_DEBUG("Yield actor '%s'", self->get_cname());
 
   /* Go into sleep and return control to maestro */
   self->context->suspend();
@@ -735,12 +709,12 @@ void SIMIX_process_yield(smx_actor_t self)
     /* execute the on_exit functions */
     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->getCname(), self->code, self->userdata,
-                                          SIMIX_timer_get_date(self->kill_timer), self->getProperties(),
+    if (self->auto_restart && self->host->is_off()) {
+      SIMIX_host_add_auto_restart_process(self->host, self->get_cname(), self->code, self->getUserData(),
+                                          SIMIX_timer_get_date(self->kill_timer), self->get_properties(),
                                           self->auto_restart);
     }
-    XBT_DEBUG("Process %s@%s is dead", self->getCname(), self->host->getCname());
+    XBT_DEBUG("Process %s@%s is dead", self->get_cname(), self->host->get_cname());
     self->context->stop();
   }
 
@@ -758,18 +732,11 @@ void SIMIX_process_yield(smx_actor_t self)
     std::rethrow_exception(std::move(exception));
   }
 
-  if(SMPI_switch_data_segment){
-    SMPI_switch_data_segment(self->pid);
+  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()
 {
@@ -784,20 +751,25 @@ 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();
     process->on_exit.pop_back();
-    (exit_fun.fun)((void*)exit_status, exit_fun.arg);
+    (exit_fun.fun)(exit_status, exit_fun.arg);
   }
 }
 
-void SIMIX_process_on_exit(smx_actor_t process, int_f_pvoid_pvoid_t fun, void *data) {
-  xbt_assert(process, "current process not found: are you in maestro context ?");
+void SIMIX_process_on_exit(smx_actor_t process, int_f_pvoid_pvoid_t fun, void* data)
+{
+  SIMIX_process_on_exit(process, [fun](int a, void* b) { fun((void*)(intptr_t)a, b); }, data);
+}
 
-  s_smx_process_exit_fun_t exit_fun = {fun, data};
+void SIMIX_process_on_exit(smx_actor_t process, std::function<void(int, void*)> fun, void* data)
+{
+  xbt_assert(process, "current process not found: are you in maestro context ?");
 
-  process->on_exit.push_back(exit_fun);
+  process->on_exit.emplace_back(s_smx_process_exit_fun_t{fun, data});
 }
 
 /**
@@ -819,16 +791,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 = "";
@@ -846,7 +816,7 @@ smx_actor_t simcall_process_create(const char* name, std::function<void()> code,
   if (name == nullptr)
     name = "";
   smx_actor_t self = SIMIX_process_self();
-  return simgrid::simix::kernelImmediate([name, code, data, host, properties, self] {
+  return simgrid::simix::simcall([name, code, data, host, properties, self] {
     return SIMIX_process_create(name, std::move(code), data, host, properties, self);
   });
 }