Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
add Process.daemonize to the Java bindings
[simgrid.git] / src / msg / msg_process.cpp
index baf54c8..8af7ea5 100644 (file)
@@ -1,20 +1,17 @@
-/* Copyright (c) 2004-2015. The SimGrid Team.
- * All rights reserved.                                                     */
+/* Copyright (c) 2004-2017. 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 <functional>
-
-#include "msg_private.h"
-#include "xbt/sysdep.h"
-#include "xbt/log.h"
-#include "xbt/functional.hpp"
+#include "msg_private.hpp"
+#include "simgrid/s4u/Host.hpp"
 #include "src/simix/ActorImpl.hpp"
-#include "src/simix/smx_private.h"
+#include "src/simix/smx_private.hpp"
 
 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(msg_process, msg, "Logging specific to MSG (process)");
 
+extern "C" {
+
 /** @addtogroup m_process_management
  *
  *  Processes (#msg_process_t) are independent agents that can do stuff on their own. They are in charge of executing
@@ -26,48 +23,40 @@ XBT_LOG_NEW_DEFAULT_SUBCATEGORY(msg_process, msg, "Logging specific to MSG (proc
 
 /******************************** Process ************************************/
 /**
- * \brief Cleans the MSG data of a process.
- * \param smx_proc a SIMIX process
+ * \brief Cleans the MSG data of an actor
+ * \param smx_actor a SIMIX actor
  */
-void MSG_process_cleanup_from_SIMIX(smx_process_t smx_proc)
+void MSG_process_cleanup_from_SIMIX(smx_actor_t smx_actor)
 {
-  simdata_process_t msg_proc;
+  simgrid::msg::ActorExt* msg_actor;
 
   // get the MSG process from the SIMIX process
-  if (smx_proc == SIMIX_process_self()) {
+  if (smx_actor == SIMIX_process_self()) {
     /* avoid a SIMIX request if this function is called by the process itself */
-    msg_proc = (simdata_process_t) SIMIX_process_self_get_data();
+    msg_actor = (simgrid::msg::ActorExt*)SIMIX_process_self_get_data();
     SIMIX_process_self_set_data(nullptr);
   } else {
-    msg_proc = (simdata_process_t) simcall_process_get_data(smx_proc);
-    simcall_process_set_data(smx_proc, nullptr);
+    msg_actor = (simgrid::msg::ActorExt*)smx_actor->userdata;
+    simcall_process_set_data(smx_actor, nullptr);
   }
 
-  TRACE_msg_process_destroy(smx_proc->name.c_str(), smx_proc->pid);
+  TRACE_msg_process_destroy(smx_actor->name, smx_actor->pid);
   // free the data if a function was provided
-  if (msg_proc && msg_proc->data && msg_global->process_data_cleanup) {
-    msg_global->process_data_cleanup(msg_proc->data);
+  if (msg_actor && msg_actor->data && msg_global->process_data_cleanup) {
+    msg_global->process_data_cleanup(msg_actor->data);
   }
 
-  // free the MSG process
-  xbt_free(msg_proc);
-  SIMIX_process_cleanup(smx_proc);
+  delete msg_actor;
+  SIMIX_process_cleanup(smx_actor);
 }
 
 /* This function creates a MSG process. It has the prototype enforced by SIMIX_function_register_process_create */
-smx_process_t MSG_process_create_from_SIMIX(
-  const char *name, std::function<void()> code, void *data, const char *hostname,
-  double kill_time, xbt_dict_t properties,
-  int auto_restart, smx_process_t parent_process)
-{
-  msg_host_t host = MSG_host_by_name(hostname);
-  msg_process_t p = MSG_process_create_with_environment(
-    name, std::move(code), data, host, properties);
-  if (p) {
-    MSG_process_set_kill_time(p,kill_time);
-    MSG_process_auto_restart_set(p,auto_restart);
-  }
-  return p;
+smx_actor_t MSG_process_create_from_SIMIX(const char* name, std::function<void()> code, void* data, sg_host_t host,
+                                          std::map<std::string, std::string>* properties,
+                                          smx_actor_t /*parent_process*/)
+{
+  msg_process_t p = MSG_process_create_from_stdfunc(name, std::move(code), data, host, properties);
+  return p == nullptr ? nullptr : p->getImpl();
 }
 
 /** \ingroup m_process_management
@@ -134,52 +123,43 @@ msg_process_t MSG_process_create_with_environment(const char *name, xbt_main_fun
 {
   std::function<void()> function;
   if (code)
-    function = simgrid::xbt::wrapMain(code, argc, const_cast<const char*const*>(argv));
-  msg_process_t res = MSG_process_create_with_environment(name,
-    std::move(function), data, host, properties);
+    function = simgrid::xbt::wrapMain(code, argc, static_cast<const char* const*>(argv));
+
+  std::map<std::string, std::string> props;
+  xbt_dict_cursor_t cursor = nullptr;
+  char* key;
+  char* value;
+  xbt_dict_foreach (properties, cursor, key, value)
+    props[key] = value;
+  xbt_dict_free(&properties);
+
+  msg_process_t res = MSG_process_create_from_stdfunc(name, std::move(function), data, host, &props);
   for (int i = 0; i != argc; ++i)
     xbt_free(argv[i]);
   xbt_free(argv);
   return res;
 }
+}
 
-msg_process_t MSG_process_create_with_environment(
-  const char *name, std::function<void()> code, void *data,
-  msg_host_t host, xbt_dict_t properties)
+msg_process_t MSG_process_create_from_stdfunc(const char* name, std::function<void()> code, void* data, msg_host_t host,
+                                              std::map<std::string, std::string>* properties)
 {
   xbt_assert(code != nullptr && host != nullptr, "Invalid parameters: host and code params must not be nullptr");
-  simdata_process_t simdata = xbt_new0(s_simdata_process_t, 1);
-  msg_process_t process;
-
-  /* Simulator data for MSG */
-  simdata->waiting_action = nullptr;
-  simdata->waiting_task = nullptr;
-  simdata->m_host = host;
-  simdata->data = data;
-  simdata->last_errno = MSG_OK;
-
-  /* Let's create the process: SIMIX may decide to start it right now,
-   * even before returning the flow control to us */
-  process = simcall_process_create(
-    name, std::move(code), simdata, sg_host_get_name(host), -1,  properties, 0);
-
-  if (!process) {
-    /* Undo everything we have just changed */
-    xbt_free(simdata);
+  simgrid::msg::ActorExt* msgExt = new simgrid::msg::ActorExt(data);
+
+  smx_actor_t process = simcall_process_create(name, std::move(code), msgExt, host, properties);
+
+  if (not process) { /* Undo everything */
+    delete msgExt;
     return nullptr;
   }
-  else {
-    simcall_process_on_exit(process,(int_f_pvoid_pvoid_t)TRACE_msg_process_kill,process);
-  }
-  return process;
-}
 
-static int MSG_maestro(int argc, char** argv)
-{
-  int res = MSG_main();
-  return res;
+  simcall_process_on_exit(process, (int_f_pvoid_pvoid_t)TRACE_msg_process_kill, process);
+  return process->ciface();
 }
 
+extern "C" {
+
 /* Become a process in the simulation
  *
  * Currently this can only be called by the main thread (once) and only work with some thread factories
@@ -190,22 +170,20 @@ static int MSG_maestro(int argc, char** argv)
 msg_process_t MSG_process_attach(const char *name, void *data, msg_host_t host, xbt_dict_t properties)
 {
   xbt_assert(host != nullptr, "Invalid parameters: host and code params must not be nullptr");
-  simdata_process_t simdata = xbt_new0(s_simdata_process_t, 1);
-  msg_process_t process;
-
-  /* Simulator data for MSG */
-  simdata->waiting_action = nullptr;
-  simdata->waiting_task = nullptr;
-  simdata->m_host = host;
-  simdata->data = data;
-  simdata->last_errno = MSG_OK;
+  std::map<std::string, std::string> props;
+  xbt_dict_cursor_t cursor = nullptr;
+  char* key;
+  char* value;
+  xbt_dict_foreach (properties, cursor, key, value)
+    props[key] = value;
+  xbt_dict_free(&properties);
 
   /* Let's create the process: SIMIX may decide to start it right now, even before returning the flow control to us */
-  process = SIMIX_process_attach(name, simdata, sg_host_get_name(host), properties, nullptr);
-  if (!process)
+  smx_actor_t process = SIMIX_process_attach(name, new simgrid::msg::ActorExt(data), host->getCname(), &props, nullptr);
+  if (not process)
     xbt_die("Could not attach");
   simcall_process_on_exit(process,(int_f_pvoid_pvoid_t)TRACE_msg_process_kill,process);
-  return process;
+  return process->ciface();
 }
 
 /** Detach a process attached with `MSG_process_attach()`
@@ -226,12 +204,7 @@ void MSG_process_detach()
  */
 void MSG_process_kill(msg_process_t process)
 {
-//  /* FIXME: why do we only cancel communication actions? is this useful? */
-//  simdata_process_t p_simdata = simcall_process_get_data(process);
-//  if (p_simdata->waiting_task && p_simdata->waiting_task->simdata->comm) {
-//    simcall_comm_cancel(p_simdata->waiting_task->simdata->comm);
-//  }
-  simcall_process_kill(process);
+  process->kill();
 }
 
 /**
@@ -241,7 +214,7 @@ void MSG_process_kill(msg_process_t process)
 * \param timeout wait until the process is over, or the timeout occurs
 */
 msg_error_t MSG_process_join(msg_process_t process, double timeout){
-  simcall_process_join(process, timeout);
+  simcall_process_join(process->getImpl(), timeout);
   return MSG_OK;
 }
 
@@ -253,14 +226,17 @@ msg_error_t MSG_process_join(msg_process_t process, double timeout){
  */
 msg_error_t MSG_process_migrate(msg_process_t process, msg_host_t host)
 {
-  simdata_process_t simdata = (simdata_process_t) simcall_process_get_data(process);
-  simdata->m_host = host;
-  msg_host_t now = simdata->m_host;
-  TRACE_msg_process_change_host(process, now, host);
-  simcall_process_set_host(process, host);
+  TRACE_msg_process_change_host(process, host);
+  process->migrate(host);
   return MSG_OK;
 }
 
+/** Yield the current actor; let the other actors execute first */
+void MSG_process_yield()
+{
+  simgrid::simix::kernelImmediate([] { /* do nothing*/ });
+}
+
 /** \ingroup m_process_management
  * \brief Returns the user data of a process.
  *
@@ -271,9 +247,9 @@ void* MSG_process_get_data(msg_process_t process)
   xbt_assert(process != nullptr, "Invalid parameter: first parameter must not be nullptr!");
 
   /* get from SIMIX the MSG process data, and then the user data */
-  simdata_process_t simdata = (simdata_process_t) simcall_process_get_data(process);
-  if (simdata)
-    return simdata->data;
+  simgrid::msg::ActorExt* msgExt = (simgrid::msg::ActorExt*)process->getImpl()->userdata;
+  if (msgExt)
+    return msgExt->data;
   else
     return nullptr;
 }
@@ -287,8 +263,7 @@ msg_error_t MSG_process_set_data(msg_process_t process, void *data)
 {
   xbt_assert(process != nullptr, "Invalid parameter: first parameter must not be nullptr!");
 
-  simdata_process_t simdata = (simdata_process_t) simcall_process_get_data(process);
-  simdata->data = data;
+  static_cast<simgrid::msg::ActorExt*>(process->getImpl()->userdata)->data = data;
 
   return MSG_OK;
 }
@@ -308,14 +283,11 @@ XBT_PUBLIC(void) MSG_process_set_data_cleanup(void_f_pvoid_t data_cleanup) {
  */
 msg_host_t MSG_process_get_host(msg_process_t process)
 {
-  simdata_process_t simdata;
   if (process == nullptr) {
-    simdata = (simdata_process_t) SIMIX_process_self_get_data();
-  }
-  else {
-    simdata = (simdata_process_t) simcall_process_get_data(process);
+    return SIMIX_process_self()->host;
+  } else {
+    return process->getImpl()->host;
   }
-  return simdata ? simdata->m_host : nullptr;
 }
 
 /** \ingroup m_process_management
@@ -328,12 +300,17 @@ msg_host_t MSG_process_get_host(msg_process_t process)
  */
 msg_process_t MSG_process_from_PID(int PID)
 {
-  return SIMIX_process_from_PID(PID);
+  return SIMIX_process_from_PID(PID)->ciface();
 }
 
 /** @brief returns a list of all currently existing processes */
 xbt_dynar_t MSG_processes_as_dynar() {
-  return SIMIX_processes_as_dynar();
+  xbt_dynar_t res = xbt_dynar_new(sizeof(smx_actor_t), nullptr);
+  for (auto const& kv : simix_global->process_list) {
+    smx_actor_t actor = kv.second;
+    xbt_dynar_push(res, &actor);
+  }
+  return res;
 }
 
 /** @brief Return the current number MSG processes. */
@@ -350,7 +327,7 @@ int MSG_process_get_number()
  */
 msg_error_t MSG_process_set_kill_time(msg_process_t process, double kill_time)
 {
-  simcall_process_set_kill_time(process,kill_time);
+  simcall_process_set_kill_time(process->getImpl(), kill_time);
   return MSG_OK;
 }
 
@@ -363,9 +340,9 @@ int MSG_process_get_PID(msg_process_t process)
 {
   /* Do not raise an exception here: this function is called by the logs
    * and the exceptions, so it would be called back again and again */
-  if (process == nullptr)
+  if (process == nullptr || process->getImpl() == nullptr)
     return 0;
-  return process->pid;
+  return process->getImpl()->pid;
 }
 
 /** \ingroup m_process_management
@@ -376,7 +353,7 @@ int MSG_process_get_PID(msg_process_t process)
  */
 int MSG_process_get_PPID(msg_process_t process)
 {
-  return process->ppid;
+  return process->getImpl()->ppid;
 }
 
 /** \ingroup m_process_management
@@ -386,7 +363,7 @@ int MSG_process_get_PPID(msg_process_t process)
  */
 const char *MSG_process_get_name(msg_process_t process)
 {
-  return process->name.c_str();
+  return process->getCname();
 }
 
 /** \ingroup m_process_management
@@ -398,7 +375,7 @@ const char *MSG_process_get_name(msg_process_t process)
  */
 const char *MSG_process_get_property_value(msg_process_t process, const char *name)
 {
-  return (char*) xbt_dict_get_or_null(MSG_process_get_properties(process), name);
+  return process->getProperty(name);
 }
 
 /** \ingroup m_process_management
@@ -409,7 +386,15 @@ const char *MSG_process_get_property_value(msg_process_t process, const char *na
 xbt_dict_t MSG_process_get_properties(msg_process_t process)
 {
   xbt_assert(process != nullptr, "Invalid parameter: First argument must not be nullptr");
-  return simcall_process_get_properties(process);
+  xbt_dict_t as_dict = xbt_dict_new_homogeneous(xbt_free_f);
+  std::map<std::string, std::string>* props =
+      simgrid::simix::kernelImmediate([process] { return process->getImpl()->getProperties(); });
+  if (props == nullptr)
+    return nullptr;
+  for (auto const& elm : *props) {
+    xbt_dict_set(as_dict, elm.first.c_str(), xbt_strdup(elm.second.c_str()), nullptr);
+  }
+  return as_dict;
 }
 
 /** \ingroup m_process_management
@@ -419,7 +404,8 @@ xbt_dict_t MSG_process_get_properties(msg_process_t process)
  */
 int MSG_process_self_PID()
 {
-  return MSG_process_get_PID(MSG_process_self());
+  smx_actor_t self = SIMIX_process_self();
+  return self == nullptr ? 0 : self->pid;
 }
 
 /** \ingroup m_process_management
@@ -432,6 +418,14 @@ int MSG_process_self_PPID()
   return MSG_process_get_PPID(MSG_process_self());
 }
 
+/** \ingroup m_process_management
+ * \brief Return the name of the current process.
+ */
+const char* MSG_process_self_name()
+{
+  return SIMIX_process_self_get_name();
+}
+
 /** \ingroup m_process_management
  * \brief Return the current process.
  *
@@ -439,7 +433,7 @@ int MSG_process_self_PPID()
  */
 msg_process_t MSG_process_self()
 {
-  return SIMIX_process_self();
+  return SIMIX_process_self()->ciface();
 }
 
 /** \ingroup m_process_management
@@ -452,7 +446,7 @@ msg_error_t MSG_process_suspend(msg_process_t process)
   xbt_assert(process != nullptr, "Invalid parameter: First argument must not be nullptr");
 
   TRACE_msg_process_suspend(process);
-  simcall_process_suspend(process);
+  simcall_process_suspend(process->getImpl());
   return MSG_OK;
 }
 
@@ -466,7 +460,7 @@ msg_error_t MSG_process_resume(msg_process_t process)
   xbt_assert(process != nullptr, "Invalid parameter: First argument must not be nullptr");
 
   TRACE_msg_process_resume(process);
-  simcall_process_resume(process);
+  process->resume();
   return MSG_OK;
 }
 
@@ -477,12 +471,11 @@ msg_error_t MSG_process_resume(msg_process_t process)
  */
 int MSG_process_is_suspended(msg_process_t process)
 {
-  xbt_assert(process != nullptr, "Invalid parameter: First argument must not be nullptr");
-  return simcall_process_is_suspended(process);
+  return process->isSuspended();
 }
 
 smx_context_t MSG_process_get_smx_ctx(msg_process_t process) {
-  return SIMIX_process_get_context(process);
+  return process->getImpl()->context;
 }
 /**
  * \ingroup m_process_management
@@ -491,7 +484,7 @@ smx_context_t MSG_process_get_smx_ctx(msg_process_t process) {
  * You should use them to free the data used by your process.
  */
 void MSG_process_on_exit(int_f_pvoid_pvoid_t fun, void *data) {
-  simcall_process_on_exit(MSG_process_self(),fun,data);
+  simcall_process_on_exit(SIMIX_process_self(), fun, data);
 }
 /**
  * \ingroup m_process_management
@@ -499,12 +492,36 @@ void MSG_process_on_exit(int_f_pvoid_pvoid_t fun, void *data) {
  * If the flag is set to 1, the process will be automatically restarted when its host comes back up.
  */
 XBT_PUBLIC(void) MSG_process_auto_restart_set(msg_process_t process, int auto_restart) {
-  simcall_process_auto_restart_set(process,auto_restart);
+  process->setAutoRestart(auto_restart);
 }
-/*
+/**
  * \ingroup m_process_management
  * \brief Restarts a process from the beginning.
  */
 XBT_PUBLIC(msg_process_t) MSG_process_restart(msg_process_t process) {
-  return simcall_process_restart(process);
+  return process->restart();
+}
+
+/** @ingroup m_process_management
+ * @brief This process will be terminated automatically when the last non-daemon process finishes
+ */
+XBT_PUBLIC(void) MSG_process_daemonize(msg_process_t process)
+{
+  process->daemonize();
+}
+
+/** @ingroup m_process_management
+ * @brief Take an extra reference on that process to prevent it to be garbage-collected
+ */
+XBT_PUBLIC(void) MSG_process_ref(msg_process_t process)
+{
+  intrusive_ptr_add_ref(process);
+}
+/** @ingroup m_process_management
+ * @brief Release a reference on that process so that it can get be garbage-collected
+ */
+XBT_PUBLIC(void) MSG_process_unref(msg_process_t process)
+{
+  intrusive_ptr_release(process);
+}
 }