Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
Simplify the API between Engine and EngineImpl when registering functions
[simgrid.git] / src / msg / msg_process.cpp
index b50cdb5..1c349b0 100644 (file)
@@ -1,4 +1,4 @@
-/* Copyright (c) 2004-2019. The SimGrid Team. All rights reserved.          */
+/* Copyright (c) 2004-2020. 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. */
@@ -6,45 +6,15 @@
 #include "msg_private.hpp"
 #include "simgrid/Exception.hpp"
 #include "simgrid/s4u/Host.hpp"
-#include "src/instr/instr_private.hpp"
 #include "src/simix/smx_private.hpp"
 
-XBT_LOG_NEW_DEFAULT_SUBCATEGORY(msg_process, msg, "Logging specific to MSG (process)");
-
-std::string instr_pid(simgrid::s4u::Actor const& proc)
-{
-  return std::string(proc.get_name()) + "-" + std::to_string(proc.get_pid());
-}
-
-void MSG_process_userdata_init()
-{
-  if (not msg_global)
-    msg_global = new MSG_Global_t();
-
-  if (not simgrid::msg::ActorUserData::EXTENSION_ID.valid())
-    simgrid::msg::ActorUserData::EXTENSION_ID = simgrid::s4u::Actor::extension_create<simgrid::msg::ActorUserData>();
-  simgrid::s4u::Actor::on_creation.connect([](simgrid::s4u::Actor& actor) {
-    XBT_DEBUG("creating the extension to store user data");
-    actor.extension_set(new simgrid::msg::ActorUserData());
-  });
-
-  simgrid::s4u::Actor::on_destruction.connect([](simgrid::s4u::Actor const& actor) {
-    // free the data if a function was provided
-    auto extension = actor.extension<simgrid::msg::ActorUserData>();
-    void* userdata = extension ? extension->get_user_data() : nullptr;
-    if (userdata && msg_global->process_data_cleanup) {
-      msg_global->process_data_cleanup(userdata);
-    }
-  });
-}
-
 /******************************** 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);
 }
@@ -56,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);
 }
@@ -76,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
@@ -85,28 +55,22 @@ 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");
-  simgrid::simix::ActorCode function;
-  if (code)
-    function = simgrid::xbt::wrap_main(code, argc, static_cast<const char* const*>(argv));
-
-  simgrid::s4u::ActorPtr actor;
+  sg_actor_t actor = sg_actor_init(std::move(name), host);
 
   try {
     if (data != nullptr) {
-      actor = simgrid::s4u::Actor::init(std::move(name), host);
-      actor->extension<simgrid::msg::ActorUserData>()->set_user_data(data);
+      sg_actor_data_set(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(function));
-    } else
-      actor = simgrid::s4u::Actor::create(std::move(name), host, std::move(function));
+    }
+    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());
   }
@@ -117,31 +81,7 @@ msg_process_t MSG_process_create_with_environment(const char *name, xbt_main_fun
   xbt_free(argv);
 
   simgrid::s4u::this_actor::yield();
-  return actor.get();
-}
-
-/** @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->extension<simgrid::msg::ActorUserData>()->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->extension<simgrid::msg::ActorUserData>()->set_user_data(data);
-
-  return MSG_OK;
+  return actor;
 }
 
 /** @brief Sets a cleanup function to be called to free the userdata of a process when a process is destroyed.
@@ -162,63 +102,11 @@ 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();
-}
-
 /** @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_int_pvoid_t fun, void* data)
 {
-  simgrid::s4u::this_actor::on_exit(
-      [fun, data](bool failed) { fun(failed ? SMX_EXIT_FAILURE : SMX_EXIT_SUCCESS, 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);
+  simgrid::s4u::this_actor::on_exit([fun, data](bool failed) { fun(failed ? 1 /*FAILURE*/ : 0 /*SUCCESS*/, data); });
 }