Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
Fix some doxygen warnings.
[simgrid.git] / src / simix / ActorImpl.cpp
index 63bef05..c6fa17a 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/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;
@@ -146,10 +133,8 @@ void SIMIX_process_empty_trash()
 
 namespace simgrid {
 
-namespace s4u {
-simgrid::xbt::signal<void(simgrid::s4u::ActorPtr)> s4u::Actor::onCreation; // TODO cheinrich is this the right location here?
-}
-namespace simix {
+namespace kernel {
+namespace actor {
 
 ActorImpl::~ActorImpl()
 {
@@ -181,11 +166,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;
@@ -252,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;
@@ -267,7 +252,7 @@ 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;
@@ -284,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));
 }
 
 /**
@@ -306,14 +292,14 @@ 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 */
@@ -348,18 +334,15 @@ 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);
-  /* Note by cheinrich: If you move this directly after the "new ActorImpl", the pid
-   * will not yet be set and you will cause issues when other code relies on that.
-   * This is of course also true for the other properties, so I moved this here.
-   */
+  if (TRACE_actor_is_enabled())
+    simgrid::instr::Container::byName(process->host->get_name())->createChild(instr_pid(process->ciface()), "ACTOR");
+  /* 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;
 }
@@ -378,7 +361,7 @@ 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);
@@ -408,13 +391,15 @@ smx_actor_t SIMIX_process_attach(const char* name, void* data, const char* hostn
 
   /* 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);
+  if (TRACE_actor_is_enabled())
+    simgrid::instr::Container::byName(process->host->get_name())->createChild(instr_pid(process->ciface()), "ACTOR");
 
-  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");
 
@@ -424,14 +409,13 @@ smx_actor_t SIMIX_process_attach(const char* name, void* data, const char* hostn
 
 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;
 }
 
 /**
@@ -463,12 +447,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;
   }
 
-  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;
@@ -580,21 +565,19 @@ 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);
+void simcall_HANDLER_process_killall(smx_simcall_t simcall)
+{
+  SIMIX_process_killall(simcall->issuer);
 }
 /**
  * \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)
@@ -655,14 +638,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) {
@@ -684,7 +659,7 @@ smx_activity_t SIMIX_process_join(smx_actor_t issuer, smx_actor_t process, doubl
                         [](void*, 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::done);
                           intrusive_ptr_release(sleep);
                           return 0;
                         },
@@ -726,7 +701,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();
@@ -741,11 +716,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->getCname(), self->code, self->userdata,
+      SIMIX_host_add_auto_restart_process(self->host, self->get_cname(), self->code, self->userdata,
                                           SIMIX_timer_get_date(self->kill_timer), self->getProperties(),
                                           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();
   }
 
@@ -763,18 +738,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()
 {
@@ -789,6 +757,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();
@@ -826,14 +795,12 @@ void SIMIX_process_auto_restart_set(smx_actor_t process, int auto_restart) {
  * be nullptr.
  * It can be retrieved with the function \ref simcall_process_get_data.
  * \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 = "";