Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
[doc] Add todo about user .then()
[simgrid.git] / src / simix / smx_process.cpp
index a5f5496..5f28c68 100644 (file)
@@ -4,18 +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"
@@ -28,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.
  *
@@ -59,6 +84,7 @@ 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 */
@@ -126,24 +152,24 @@ void SIMIX_process_empty_trash(void)
 
   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 = nullptr;
@@ -153,8 +179,6 @@ void create_maestro(std::function<void()> code)
   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()>(), nullptr, maestro);
@@ -188,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 */
@@ -273,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;
 
@@ -363,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;
 
@@ -450,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) {
@@ -750,6 +761,12 @@ 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);
   sync->simcalls.push_back(simcall);
   simcall->issuer->waiting_synchro = sync;
@@ -777,13 +794,14 @@ static int SIMIX_process_join_finish(smx_process_exit_status_t status, smx_synch
     sleep->surf_sleep->unref();
     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;
 }
@@ -826,6 +844,7 @@ void SIMIX_process_sleep_destroy(smx_synchro_t synchro)
   if (sleep->surf_sleep) {
     sleep->surf_sleep->unref();
     sleep->surf_sleep = nullptr;
+    sleep->unref();
   }
 }
 
@@ -859,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){
@@ -875,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)
 {
@@ -1003,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,
@@ -1011,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
+}