Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
Avoid (conditionnaly) including C++ headers files in C headers
[simgrid.git] / src / simix / smx_process.cpp
index 7243535..5f28c68 100644 (file)
@@ -4,16 +4,28 @@
 /* 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 <string>
+#include <utility>
+
+#include <boost/range/algorithm.hpp>
+
+#include <xbt/functional.hpp>
+#include <xbt/ex.hpp>
+#include <xbt/sysdep.h>
+#include <xbt/log.h>
+#include <xbt/dict.h>
+
+#include <simgrid/s4u/host.hpp>
+
+#include <mc/mc.h>
+
 #include "src/surf/surf_interface.hpp"
 #include "smx_private.h"
-#include "xbt/sysdep.h"
-#include "xbt/log.h"
-#include "xbt/dict.h"
-#include "mc/mc.h"
 #include "src/mc/mc_replay.h"
 #include "src/mc/Client.hpp"
 #include "src/msg/msg_private.h"
-
 #include "src/simix/SynchroSleep.hpp"
 #include "src/simix/SynchroRaw.hpp"
 #include "src/simix/SynchroIo.hpp"
@@ -26,6 +38,21 @@ XBT_LOG_NEW_DEFAULT_SUBCATEGORY(simix_process, simix, "Logging specific to SIMIX
 
 unsigned long simix_process_maxpid = 0;
 
+/** Increase the refcount for this process */
+smx_process_t SIMIX_process_ref(smx_process_t process)
+{
+  if (process != nullptr)
+    intrusive_ptr_add_ref(process);
+  return process;
+}
+
+/** Decrease the refcount for this process */
+void SIMIX_process_unref(smx_process_t process)
+{
+  if (process != nullptr)
+    intrusive_ptr_release(process);
+}
+
 /**
  * \brief Returns the current agent.
  *
@@ -37,7 +64,7 @@ smx_process_t SIMIX_process_self(void)
 {
   smx_context_t self_context = SIMIX_context_self();
 
-  return self_context ? self_context->process() : NULL;
+  return self_context ? self_context->process() : nullptr;
 }
 
 /**
@@ -57,10 +84,11 @@ void SIMIX_process_cleanup(smx_process_t process)
   XBT_DEBUG("Cleanup process %s (%p), waiting synchro %p",
       process->name.c_str(), process, process->waiting_synchro);
 
+  process->finished = true;
   SIMIX_process_on_exit_runall(process);
 
   /* Unregister from the kill timer if any */
-  if (process->kill_timer != NULL)
+  if (process->kill_timer != nullptr)
       SIMIX_timer_remove(process->kill_timer);
 
   xbt_os_mutex_acquire(simix_global->mutex);
@@ -77,7 +105,7 @@ void SIMIX_process_cleanup(smx_process_t process)
     if (comm->src_proc == process) {
       XBT_DEBUG("Found an unfinished send comm %p (detached = %d), state %d, src = %p, dst = %p",
           comm, comm->detached, (int)comm->state, comm->src_proc, comm->dst_proc);
-      comm->src_proc = NULL;
+      comm->src_proc = nullptr;
 
       /* I'm not supposed to destroy a detached comm from the sender side, */
       if (comm->detached)
@@ -89,9 +117,9 @@ void SIMIX_process_cleanup(smx_process_t process)
     else if (comm->dst_proc == process){
       XBT_DEBUG("Found an unfinished recv comm %p, state %d, src = %p, dst = %p",
           comm, (int)comm->state, comm->src_proc, comm->dst_proc);
-      comm->dst_proc = NULL;
+      comm->dst_proc = nullptr;
 
-      if (comm->detached && comm->src_proc != NULL) {
+      if (comm->detached && comm->src_proc != nullptr) {
         /* the comm will be freed right now, remove it from the sender */
         xbt_fifo_remove(comm->src_proc->comms, comm);
       }
@@ -120,42 +148,40 @@ void SIMIX_process_cleanup(smx_process_t process)
  */
 void SIMIX_process_empty_trash(void)
 {
-  smx_process_t process = NULL;
+  smx_process_t process = nullptr;
 
   while ((process = (smx_process_t) xbt_swag_extract(simix_global->process_to_destroy))) {
     XBT_DEBUG("Getting rid of %p",process);
-
-    delete process->context;
-
-    /* Free the exception allocated at creation time */
-    free(process->running_ctx);
-    xbt_dict_free(&process->properties);
-
-    xbt_fifo_free(process->comms);
-
-    xbt_dynar_free(&process->on_exit);
-
-    delete process;
+    intrusive_ptr_release(process);
   }
 }
 
 namespace simgrid {
 namespace simix {
 
+Process::~Process()
+{
+  delete this->context;
+  if (this->properties)
+    xbt_dict_free(&this->properties);
+  if (this->comms != nullptr)
+    xbt_fifo_free(this->comms);
+  if (this->on_exit)
+    xbt_dynar_free(&this->on_exit);
+}
+
 void create_maestro(std::function<void()> code)
 {
-  smx_process_t maestro = NULL;
+  smx_process_t maestro = nullptr;
   /* Create maestro process and intilialize it */
   maestro = new simgrid::simix::Process();
   maestro->pid = simix_process_maxpid++;
   maestro->ppid = -1;
   maestro->name = "";
   maestro->data = nullptr;
-  maestro->running_ctx = (xbt_running_ctx_t*) xbt_malloc0(sizeof(xbt_running_ctx_t));
-  XBT_RUNNING_CTX_INITIALIZE(maestro->running_ctx);
 
   if (!code) {
-    maestro->context = SIMIX_context_new(std::function<void()>(), NULL, maestro);
+    maestro->context = SIMIX_context_new(std::function<void()>(), nullptr, maestro);
   } else {
     if (!simix_global)
       xbt_die("simix is not initialized, please call MSG_init first");
@@ -186,6 +212,7 @@ void SIMIX_maestro_create(void (*code)(void*), void* data)
  * and stops its context.
  */
 void SIMIX_process_stop(smx_process_t arg) {
+  arg->finished = true;
   /* execute the on_exit functions */
   SIMIX_process_on_exit_runall(arg);
   /* Add the process to the list of process to restart, only if the host is down */
@@ -221,7 +248,7 @@ smx_process_t SIMIX_process_create(
                           int auto_restart,
                           smx_process_t parent_process)
 {
-  smx_process_t process = NULL;
+  smx_process_t process = nullptr;
   sg_host_t host = sg_host_by_name(hostname);
 
   XBT_DEBUG("Start process %s on host '%s'", name, hostname);
@@ -234,7 +261,7 @@ smx_process_t SIMIX_process_create(
   else {
     process = new simgrid::simix::Process();
 
-    xbt_assert(code && host != NULL, "Invalid parameters");
+    xbt_assert(code && host != nullptr, "Invalid parameters");
     /* Process data */
     process->pid = simix_process_maxpid++;
     process->name = simgrid::xbt::string(name);
@@ -245,7 +272,7 @@ smx_process_t SIMIX_process_create(
     /* Initiliaze data segment to default value */
     SIMIX_segment_index_set(process, -1);
 
-     if (parent_process != NULL) {
+     if (parent_process != nullptr) {
        process->ppid = SIMIX_process_get_PID(parent_process);
        /* SMPI process have their own data segment and
           each other inherit from their father */
@@ -271,13 +298,6 @@ smx_process_t SIMIX_process_create(
       std::move(code),
       simix_global->cleanup_process_function, process);
 
-    process->running_ctx = (xbt_running_ctx_t*) xbt_malloc0(sizeof(xbt_running_ctx_t));
-    XBT_RUNNING_CTX_INITIALIZE(process->running_ctx);
-
-    if(MC_is_active()){
-      MC_ignore_heap(process->running_ctx, sizeof(*process->running_ctx));
-    }
-
     /* Add properties */
     process->properties = properties;
 
@@ -336,7 +356,7 @@ smx_process_t SIMIX_process_attach(
   process->ppid = -1;
   /* Initiliaze data segment to default value */
   SIMIX_segment_index_set(process, -1);
-  if (parent_process != NULL) {
+  if (parent_process != nullptr) {
     process->ppid = SIMIX_process_get_PID(parent_process);
    /* SMPI process have their own data segment and
       each other inherit from their father */
@@ -361,13 +381,6 @@ smx_process_t SIMIX_process_attach(
   process->context = simix_global->context_factory->attach(
     simix_global->cleanup_process_function, process);
 
-  process->running_ctx = (xbt_running_ctx_t*) xbt_malloc0(sizeof(xbt_running_ctx_t));
-  XBT_RUNNING_CTX_INITIALIZE(process->running_ctx);
-
-  if(MC_is_active()){
-    MC_ignore_heap(process->running_ctx, sizeof(*process->running_ctx));
-  }
-
   /* Add properties */
   process->properties = properties;
 
@@ -448,7 +461,7 @@ void SIMIX_process_kill(smx_process_t process, smx_process_t issuer) {
   process->context->iwannadie = 1;
   process->blocked = 0;
   process->suspended = 0;
-  process->doexception = 0;
+  process->exception = nullptr;
 
   /* destroy the blocking synchro if any */
   if (process->waiting_synchro) {
@@ -465,7 +478,14 @@ void SIMIX_process_kill(smx_process_t process, smx_process_t issuer) {
     } else if (comm != nullptr) {
       xbt_fifo_remove(process->comms, process->waiting_synchro);
       comm->cancel();
-      xbt_fifo_remove(process->waiting_synchro->simcalls, &process->simcall);
+
+      // Remove first occurence 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);
+
       comm->unref();
 
     } else if (sleep != nullptr) {
@@ -486,7 +506,7 @@ void SIMIX_process_kill(smx_process_t process, smx_process_t issuer) {
       break;
     } */
 
-    process->waiting_synchro = NULL;
+    process->waiting_synchro = nullptr;
   }
   if(!xbt_dynar_member(simix_global->process_to_run, &(process)) && process != issuer) {
     XBT_DEBUG("Inserting %s in the to_run list", process->name.c_str());
@@ -540,7 +560,7 @@ void SIMIX_process_throw(smx_process_t process, xbt_errcat_t cat, int value, con
       SIMIX_io_destroy(process->waiting_synchro);
     }
   }
-  process->waiting_synchro = NULL;
+  process->waiting_synchro = nullptr;
 
 }
 
@@ -553,7 +573,7 @@ void simcall_HANDLER_process_killall(smx_simcall_t simcall, int reset_pid) {
  */
 void SIMIX_process_killall(smx_process_t issuer, int reset_pid)
 {
-  smx_process_t p = NULL;
+  smx_process_t p = nullptr;
 
   while ((p = (smx_process_t) xbt_swag_extract(simix_global->process_list))) {
     if (p != issuer) {
@@ -576,7 +596,7 @@ void simcall_HANDLER_process_set_host(smx_simcall_t simcall, smx_process_t proce
 void SIMIX_process_change_host(smx_process_t process,
              sg_host_t dest)
 {
-  xbt_assert((process != NULL), "Invalid parameters");
+  xbt_assert((process != nullptr), "Invalid parameters");
   xbt_swag_remove(process, sg_host_simix(process->host)->process_list);
   process->host = dest;
   xbt_swag_insert(process, sg_host_simix(dest)->process_list);
@@ -590,7 +610,7 @@ void simcall_HANDLER_process_suspend(smx_simcall_t simcall, smx_process_t proces
   if (process != simcall->issuer) {
     SIMIX_simcall_answer(simcall);
   } else {
-    xbt_fifo_push(sync_suspend->simcalls, simcall);
+    sync_suspend->simcalls.push_back(simcall);
     process->waiting_synchro = sync_suspend;
     process->waiting_synchro->suspend();
   }
@@ -601,7 +621,7 @@ smx_synchro_t SIMIX_process_suspend(smx_process_t process, smx_process_t issuer)
 {
   if (process->suspended) {
     XBT_DEBUG("Process '%s' is already suspended", process->name.c_str());
-    return NULL;
+    return nullptr;
   }
 
   process->suspended = 1;
@@ -613,7 +633,7 @@ smx_synchro_t SIMIX_process_suspend(smx_process_t process, smx_process_t issuer)
       process->waiting_synchro->suspend();
     /* If the other process is not waiting, its suspension is delayed to when the process is rescheduled. */
 
-    return NULL;
+    return nullptr;
   } else {
     /* FIXME: computation size is zero. Is it okay that bound is zero ? */
     return SIMIX_execution_start(process, "suspend", 0.0, 1.0, 0.0, 0);
@@ -658,14 +678,14 @@ int SIMIX_process_count(void)
 }
 
 int SIMIX_process_get_PID(smx_process_t self){
-  if (self == NULL)
+  if (self == nullptr)
     return 0;
   else
     return self->pid;
 }
 
 int SIMIX_process_get_PPID(smx_process_t self){
-  if (self == NULL)
+  if (self == nullptr)
     return 0;
   else
     return self->ppid;
@@ -676,7 +696,7 @@ void* SIMIX_process_self_get_data()
   smx_process_t self = SIMIX_process_self();
 
   if (!self) {
-    return NULL;
+    return nullptr;
   }
   return SIMIX_process_get_data(self);
 }
@@ -708,7 +728,7 @@ sg_host_t SIMIX_process_get_host(smx_process_t process)
 const char* SIMIX_process_self_get_name(void) {
 
   smx_process_t process = SIMIX_process_self();
-  if (process == NULL || process == simix_global->maestro_process)
+  if (process == nullptr || process == simix_global->maestro_process)
     return "maestro";
 
   return SIMIX_process_get_name(process);
@@ -726,7 +746,7 @@ smx_process_t SIMIX_process_get_by_name(const char* name)
     if (proc->name == name)
       return proc;
   }
-  return NULL;
+  return nullptr;
 }
 
 int SIMIX_process_is_suspended(smx_process_t process)
@@ -741,8 +761,14 @@ xbt_dict_t SIMIX_process_get_properties(smx_process_t process)
 
 void simcall_HANDLER_process_join(smx_simcall_t simcall, smx_process_t process, double timeout)
 {
+  if (process->finished) {
+    // The joined process is already finished, just wake up the issuer process right away
+    simcall_process_sleep__set__result(simcall, SIMIX_DONE);
+    SIMIX_simcall_answer(simcall);
+    return;
+  }
   smx_synchro_t sync = SIMIX_process_join(simcall->issuer, process, timeout);
-  xbt_fifo_push(sync->simcalls, simcall);
+  sync->simcalls.push_back(simcall);
   simcall->issuer->waiting_synchro = sync;
 }
 
@@ -752,10 +778,11 @@ static int SIMIX_process_join_finish(smx_process_exit_status_t status, smx_synch
   if (sleep->surf_sleep) {
     sleep->surf_sleep->cancel();
 
-    smx_simcall_t simcall;
-    while ((simcall = (smx_simcall_t) xbt_fifo_shift(sleep->simcalls))) {
+    while (!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 = NULL;
+      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;
@@ -765,15 +792,16 @@ static int SIMIX_process_join_finish(smx_process_exit_status_t status, smx_synch
       }
     }
     sleep->surf_sleep->unref();
-    sleep->surf_sleep = NULL;
+    sleep->surf_sleep = nullptr;
   }
-  delete sleep;
+  sleep->unref();
   return 0;
 }
 
 smx_synchro_t SIMIX_process_join(smx_process_t issuer, smx_process_t process, double timeout)
 {
   smx_synchro_t res = SIMIX_process_sleep(issuer, timeout);
+  static_cast<simgrid::simix::Synchro*>(res)->ref();
   SIMIX_process_on_exit(process, (int_f_pvoid_pvoid_t)SIMIX_process_join_finish, res);
   return res;
 }
@@ -787,7 +815,7 @@ void simcall_HANDLER_process_sleep(smx_simcall_t simcall, double duration)
     return;
   }
   smx_synchro_t sync = SIMIX_process_sleep(simcall->issuer, duration);
-  xbt_fifo_push(sync->simcalls, simcall);
+  sync->simcalls.push_back(simcall);
   simcall->issuer->waiting_synchro = sync;
 }
 
@@ -800,8 +828,6 @@ smx_synchro_t SIMIX_process_sleep(smx_process_t process, double duration)
     THROWF(host_error, 0, "Host %s failed, you cannot call this function", sg_host_get_name(host));
 
   simgrid::simix::Sleep *synchro = new simgrid::simix::Sleep();
-  synchro->name = NULL;
-
   synchro->host = host;
   synchro->surf_sleep = surf_host_sleep(host, duration);
   synchro->surf_sleep->setData(synchro);
@@ -817,7 +843,8 @@ void SIMIX_process_sleep_destroy(smx_synchro_t synchro)
 
   if (sleep->surf_sleep) {
     sleep->surf_sleep->unref();
-    sleep->surf_sleep = NULL;
+    sleep->surf_sleep = nullptr;
+    sleep->unref();
   }
 }
 
@@ -841,7 +868,7 @@ void SIMIX_process_yield(smx_process_t self)
 
   if (self->new_host) {
     SIMIX_process_change_host(self, self->new_host);
-    self->new_host = NULL;
+    self->new_host = nullptr;
   }
 
   if (self->context->iwannadie){
@@ -851,15 +878,16 @@ void SIMIX_process_yield(smx_process_t self)
 
   if (self->suspended) {
     XBT_DEBUG("Hey! I'm suspended.");
-    xbt_assert(!self->doexception, "Gasp! This exception may be lost by subsequent calls.");
+    xbt_assert(self->exception != nullptr, "Gasp! This exception may be lost by subsequent calls.");
     self->suspended = 0;
     SIMIX_process_suspend(self, self);
   }
 
-  if (self->doexception) {
+  if (self->exception != nullptr) {
     XBT_DEBUG("Wait, maestro left me an exception");
-    self->doexception = 0;
-    RETHROW;
+    std::exception_ptr exception = std::move(self->exception);
+    self->exception = nullptr;
+    std::rethrow_exception(std::move(exception));
   }
 
   if(SMPI_switch_data_segment && self->segment_index != -1){
@@ -867,16 +895,6 @@ void SIMIX_process_yield(smx_process_t self)
   }
 }
 
-/* callback: context fetching */
-xbt_running_ctx_t *SIMIX_process_get_running_context(void)
-{
-  smx_process_t process = SIMIX_process_self();
-  if (process)
-    return process->running_ctx;
-  else
-    return nullptr;
-}
-
 /* callback: termination */
 void SIMIX_process_exception_terminate(xbt_ex_t * e)
 {
@@ -910,13 +928,13 @@ smx_process_t SIMIX_process_from_PID(int PID)
    if (proc->pid == (unsigned long) PID)
     return proc;
   }
-  return NULL;
+  return nullptr;
 }
 
 /** @brief returns a dynar containg all currently existing processes */
 xbt_dynar_t SIMIX_processes_as_dynar(void) {
   smx_process_t proc;
-  xbt_dynar_t res = xbt_dynar_new(sizeof(smx_process_t),NULL);
+  xbt_dynar_t res = xbt_dynar_new(sizeof(smx_process_t),nullptr);
   xbt_swag_foreach(proc, simix_global->process_list) {
     xbt_dynar_push(res,&proc);
   }
@@ -938,7 +956,7 @@ void SIMIX_process_on_exit(smx_process_t process, int_f_pvoid_pvoid_t fun, void
   xbt_assert(process, "current process not found: are you in maestro context ?");
 
   if (!process->on_exit) {
-    process->on_exit = xbt_dynar_new(sizeof(s_smx_process_exit_fun_t), NULL);
+    process->on_exit = xbt_dynar_new(sizeof(s_smx_process_exit_fun_t), nullptr);
   }
 
   s_smx_process_exit_fun_t exit_fun = {fun, data};
@@ -971,7 +989,7 @@ smx_process_t SIMIX_process_restart(smx_process_t process, smx_process_t issuer)
   arg.hostname = sg_host_get_name(process->host);
   arg.kill_time = SIMIX_timer_get_date(process->kill_timer);
   arg.data = process->data;
-  arg.properties = NULL;
+  arg.properties = nullptr;
   arg.auto_restart = process->auto_restart;
 
   //kill the old process
@@ -995,6 +1013,44 @@ void SIMIX_segment_index_set(smx_process_t proc, int index){
   proc->segment_index = index;
 }
 
+/**
+ * \ingroup simix_process_management
+ * \brief Creates and runs a new SIMIX process.
+ *
+ * The structure and the corresponding thread are created and put in the list of ready processes.
+ *
+ * \param name a name for the process. It is for user-level information and can be nullptr.
+ * \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.
+ * \param hostname name of the 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.
+ */
+smx_process_t simcall_process_create(const char *name,
+                              xbt_main_func_t code,
+                              void *data,
+                              const char *hostname,
+                              double kill_time,
+                              int argc, char **argv,
+                              xbt_dict_t properties,
+                              int auto_restart)
+{
+  if (name == nullptr)
+    name = "";
+  auto wrapped_code = simgrid::xbt::wrapMain(code, argc, argv);
+  for (int i = 0; i != argc; ++i)
+    xbt_free(argv[i]);
+  xbt_free(argv);
+  smx_process_t res = simcall_process_create(name,
+    std::move(wrapped_code),
+    data, hostname, kill_time, properties, auto_restart);
+  return res;
+}
+
 smx_process_t simcall_process_create(
   const char *name, std::function<void()> code, void *data,
   const char *hostname, double kill_time,
@@ -1003,10 +1059,10 @@ smx_process_t simcall_process_create(
   if (name == nullptr)
     name = "";
   smx_process_t self = SIMIX_process_self();
-  return simgrid::simix::kernel([&] {
+  return simgrid::simix::kernelImmediate([&] {
     return SIMIX_process_create(name,
           std::move(code), data, hostname,
           kill_time, properties, auto_restart,
           self);
   });
-}
\ No newline at end of file
+}