Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
Update copyright lines.
[simgrid.git] / src / msg / msg_process.cpp
index da46838..368cd63 100644 (file)
@@ -1,29 +1,20 @@
-/* Copyright (c) 2004-2019. The SimGrid Team. All rights reserved.          */
+/* Copyright (c) 2004-2021. 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 "msg_private.hpp"
+#include "simgrid/Exception.hpp"
 #include "simgrid/s4u/Host.hpp"
-#include "src/instr/instr_private.hpp"
-#include "src/simix/ActorImpl.hpp"
 #include "src/simix/smx_private.hpp"
 
-XBT_LOG_NEW_DEFAULT_SUBCATEGORY(msg_process, msg, "Logging specific to MSG (process)");
-
-std::string instr_pid(msg_process_t proc)
-{
-  return std::string(proc->get_name()) + "-" + std::to_string(proc->get_pid());
-}
-
 /******************************** Process ************************************/
-
 /** @brief Creates and runs a new #msg_process_t.
  *
  * Does exactly the same as #MSG_process_create_with_arguments but without providing standard arguments
  * (@a argc, @a argv, @a start_time, @a kill_time).
  */
-msg_process_t MSG_process_create(const char *name, xbt_main_func_t code, void *data, msg_host_t host)
+msg_process_t MSG_process_create(const char* name, int (*code)(int, char**), void* data, msg_host_t host)
 {
   return MSG_process_create_with_environment(name == nullptr ? "" : name, code, data, host, 0, nullptr, nullptr);
 }
@@ -35,14 +26,14 @@ msg_process_t MSG_process_create(const char *name, xbt_main_func_t code, void *d
  * @param name a name for the object. It is for user-level information and can be nullptr.
  * @param code is a function describing the behavior 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 MSG_process_get_data.
+ *        can be nullptr. It can be retrieved with the function MSG_process_get_data().
  * @param host the location where the new process is executed.
  * @param argc first argument passed to @a code
  * @param argv second argument passed to @a code
  */
 
-msg_process_t MSG_process_create_with_arguments(const char *name, xbt_main_func_t code, void *data, msg_host_t host,
-                                              int argc, char **argv)
+msg_process_t MSG_process_create_with_arguments(const char* name, int (*code)(int, char**), void* data, msg_host_t host,
+                                                int argc, char** argv)
 {
   return MSG_process_create_with_environment(name, code, data, host, argc, argv, nullptr);
 }
@@ -55,7 +46,7 @@ msg_process_t MSG_process_create_with_arguments(const char *name, xbt_main_func_
  * @param name a name for the object. It is for user-level information and can be nullptr.
  * @param code is a function describing the behavior 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 MSG_process_get_data.
+ *        can be nullptr. It can be retrieved with the function MSG_process_get_data().
  * @param host the location where the new process is executed.
  * @param argc first argument passed to @a code
  * @param argv second argument passed to @a code. WARNING, these strings are freed by the SimGrid kernel when the
@@ -64,100 +55,33 @@ msg_process_t MSG_process_create_with_arguments(const char *name, xbt_main_func_
  * @see msg_process_t
  * @return The new corresponding object.
  */
-msg_process_t MSG_process_create_with_environment(const char *name, xbt_main_func_t code, void *data, msg_host_t host,
-                                                  int argc, char **argv, xbt_dict_t properties)
+msg_process_t MSG_process_create_with_environment(const char* name, int (*code)(int, char**), void* data,
+                                                  msg_host_t host, int argc, char** argv, xbt_dict_t properties)
 {
   xbt_assert(host != nullptr, "Invalid parameters: host param must not be nullptr");
+  sg_actor_t actor = sg_actor_init(std::move(name), host);
+
+  try {
+    if (data != nullptr) {
+      sg_actor_set_data(actor, data);
+      xbt_dict_cursor_t cursor = nullptr;
+      char* key;
+      char* value;
+      xbt_dict_foreach (properties, cursor, key, value)
+        actor->set_property(key, value);
+    }
+    actor->start(std::move(simgrid::xbt::wrap_main(code, argc, argv)));
+  } catch (simgrid::HostFailureException const&) {
+    xbt_die("Could not launch a new process on failed host %s.", host->get_cname());
+  }
 
-  simgrid::simix::ActorCode function;
-  if (code)
-    function = simgrid::xbt::wrap_main(code, argc, static_cast<const char* const*>(argv));
-
-  std::unordered_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);
-
-  smx_actor_t self    = SIMIX_process_self();
-  smx_actor_t process = simgrid::simix::simcall([name, function, data, host, &props, self] {
-    return simgrid::kernel::actor::ActorImpl::create(std::move(name), std::move(function), data, host, &props, self)
-        .get();
-  });
-
   for (int i = 0; i != argc; ++i)
     xbt_free(argv[i]);
   xbt_free(argv);
 
-  if (process == nullptr)
-    return nullptr;
-
-  MSG_process_yield();
-  return process->ciface();
-}
-
-/* Become a process in the simulation
- *
- * Currently this can only be called by the main thread (once) and only work with some thread factories
- * (currently ThreadContextFactory).
- *
- * In the future, it might be extended in order to attach other threads created by a third party library.
- */
-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");
-  std::unordered_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 */
-  smx_actor_t process = SIMIX_process_attach(name, data, host->get_cname(), &props, nullptr);
-  if (not process)
-    xbt_die("Could not attach");
-  MSG_process_yield();
-  return process->ciface();
-}
-
-/** @brief Detach a process attached with `MSG_process_attach()`
- *
- *  This is called when the current process has finished its job.
- *  Used in the main thread, it waits for the simulation to finish before  returning. When it returns, the other
- *  simulated processes and the maestro are destroyed.
- */
-void MSG_process_detach()
-{
-  SIMIX_process_detach();
-}
-
-/** @brief Returns the user data of a process.
- *
- * This function checks whether @a process is a valid pointer and returns the user data associated to this process.
- */
-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 */
-  return process->get_impl()->get_user_data();
-}
-
-/** @brief Sets the user data of a process.
- *
- * This function checks whether @a process is a valid pointer and sets the user data associated to this process.
- */
-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!");
-
-  process->get_impl()->set_user_data(data);
-
-  return MSG_OK;
+  simgrid::s4u::this_actor::yield();
+  return actor;
 }
 
 /** @brief Sets a cleanup function to be called to free the userdata of a process when a process is destroyed.
@@ -169,7 +93,8 @@ XBT_PUBLIC void MSG_process_set_data_cleanup(void_f_pvoid_t data_cleanup)
 }
 
 /** @brief returns a list of all currently existing processes */
-xbt_dynar_t MSG_processes_as_dynar() {
+xbt_dynar_t MSG_processes_as_dynar() // XBT_ATTRIB_DEPRECATED_v330
+{
   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;
@@ -177,65 +102,3 @@ xbt_dynar_t MSG_processes_as_dynar() {
   }
   return res;
 }
-
-/** @brief Return the current number MSG processes. */
-int MSG_process_get_number()
-{
-  return SIMIX_process_count();
-}
-
-/** @brief Return the PID of the current process.
- *
- * This function returns the PID of the currently running #msg_process_t.
- */
-int MSG_process_self_PID()
-{
-  smx_actor_t self = SIMIX_process_self();
-  return self == nullptr ? 0 : self->get_pid();
-}
-
-/** @brief Return the PPID of the current process.
- *
- * This function returns the PID of the parent of the currently running #msg_process_t.
- */
-int MSG_process_self_PPID()
-{
-  return MSG_process_get_PPID(MSG_process_self());
-}
-
-/** @brief Return the name of the current process. */
-const char* MSG_process_self_name()
-{
-  return SIMIX_process_self_get_name();
-}
-
-/** @brief Return the current process.
- *
- * This function returns the currently running #msg_process_t.
- */
-msg_process_t MSG_process_self()
-{
-  return SIMIX_process_self()->ciface();
-}
-
-smx_context_t MSG_process_get_smx_ctx(msg_process_t process) { // deprecated -- smx_context_t should die afterward
-  return process->get_impl()->context_;
-}
-/** @brief Add a function to the list of "on_exit" functions for the current process.
- *  The on_exit functions are the functions executed when your process is killed.
- *  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) {
-  simgrid::s4u::this_actor::on_exit([fun](int a, void* b) { fun((void*)(intptr_t)a, b); }, data);
-}
-
-/** @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);
-}
-/** @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);
-}