src/msg/msg_process.cpp

   1 /* Copyright (c) 2004-2019. The SimGrid Team. All rights reserved.          */
   2
   3 /* This program is free software; you can redistribute it and/or modify it
   4  * under the terms of the license (GNU LGPL) which comes with this package. */
   5
   6 #include "msg_private.hpp"
   7 #include "simgrid/Exception.hpp"
   8 #include "simgrid/s4u/Host.hpp"
   9 #include "src/instr/instr_private.hpp"
  10 #include "src/simix/smx_private.hpp"
  11
  12 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(msg_process, msg, "Logging specific to MSG (process)");
  13
  14 std::string instr_pid(simgrid::s4u::Actor const& proc)
  15 {
  16   return std::string(proc.get_name()) + "-" + std::to_string(proc.get_pid());
  17 }
  18
  19 void MSG_process_userdata_init()
  20 {
  21   if (not msg_global)
  22     msg_global = new MSG_Global_t();
  23
  24   if (not simgrid::msg::ActorUserData::EXTENSION_ID.valid())
  25     simgrid::msg::ActorUserData::EXTENSION_ID = simgrid::s4u::Actor::extension_create<simgrid::msg::ActorUserData>();
  26   simgrid::s4u::Actor::on_creation.connect([](simgrid::s4u::Actor& actor) {
  27     XBT_DEBUG("creating the extension to store user data");
  28     actor.extension_set(new simgrid::msg::ActorUserData());
  29   });
  30
  31   simgrid::s4u::Actor::on_destruction.connect([](simgrid::s4u::Actor const& actor) {
  32     // free the data if a function was provided
  33     void* userdata = actor.extension<simgrid::msg::ActorUserData>()->get_user_data();
  34     if (userdata && msg_global->process_data_cleanup) {
  35       msg_global->process_data_cleanup(userdata);
  36     }
  37   });
  38 }
  39
  40 /******************************** Process ************************************/
  41 /** @brief Creates and runs a new #msg_process_t.
  42  *
  43  * Does exactly the same as #MSG_process_create_with_arguments but without providing standard arguments
  44  * (@a argc, @a argv, @a start_time, @a kill_time).
  45  */
  46 msg_process_t MSG_process_create(const char *name, xbt_main_func_t code, void *data, msg_host_t host)
  47 {
  48   return MSG_process_create_with_environment(name == nullptr ? "" : name, code, data, host, 0, nullptr, nullptr);
  49 }
  50
  51 /** @brief Creates and runs a new process.
  52
  53  * A constructor for #msg_process_t taking four arguments and returning the corresponding object. The structure (and
  54  * the corresponding thread) is created, and put in the list of ready process.
  55  * @param name a name for the object. It is for user-level information and can be nullptr.
  56  * @param code is a function describing the behavior of the process.
  57  * @param data a pointer to any data one may want to attach to the new object.  It is for user-level information and
  58  *        can be nullptr. It can be retrieved with the function @ref MSG_process_get_data.
  59  * @param host the location where the new process is executed.
  60  * @param argc first argument passed to @a code
  61  * @param argv second argument passed to @a code
  62  */
  63
  64 msg_process_t MSG_process_create_with_arguments(const char *name, xbt_main_func_t code, void *data, msg_host_t host,
  65                                               int argc, char **argv)
  66 {
  67   return MSG_process_create_with_environment(name, code, data, host, argc, argv, nullptr);
  68 }
  69
  70 /**
  71  * @brief Creates and runs a new #msg_process_t.
  72
  73  * A constructor for #msg_process_t taking four arguments and returning the corresponding object. The structure (and
  74  * the corresponding thread) is created, and put in the list of ready process.
  75  * @param name a name for the object. It is for user-level information and can be nullptr.
  76  * @param code is a function describing the behavior of the process.
  77  * @param data a pointer to any data one may want to attach to the new object.  It is for user-level information and
  78  *        can be nullptr. It can be retrieved with the function @ref MSG_process_get_data.
  79  * @param host the location where the new process is executed.
  80  * @param argc first argument passed to @a code
  81  * @param argv second argument passed to @a code. WARNING, these strings are freed by the SimGrid kernel when the
  82  *             process exits, so they cannot be static nor shared between several processes.
  83  * @param properties list a properties defined for this process
  84  * @see msg_process_t
  85  * @return The new corresponding object.
  86  */
  87 msg_process_t MSG_process_create_with_environment(const char *name, xbt_main_func_t code, void *data, msg_host_t host,
  88                                                   int argc, char **argv, xbt_dict_t properties)
  89 {
  90   xbt_assert(host != nullptr, "Invalid parameters: host param must not be nullptr");
  91   simgrid::simix::ActorCode function;
  92   if (code)
  93     function = simgrid::xbt::wrap_main(code, argc, static_cast<const char* const*>(argv));
  94
  95   simgrid::s4u::ActorPtr actor;
  96
  97   try {
  98     if (data != nullptr) {
  99       actor = simgrid::s4u::Actor::init(std::move(name), host);
 100       actor->extension<simgrid::msg::ActorUserData>()->set_user_data(data);
 101       xbt_dict_cursor_t cursor = nullptr;
 102       char* key;
 103       char* value;
 104       xbt_dict_foreach (properties, cursor, key, value)
 105         actor->set_property(key, value);
 106       actor->start(std::move(function));
 107     } else
 108       actor = simgrid::s4u::Actor::create(std::move(name), host, std::move(function));
 109   } catch (simgrid::HostFailureException const&) {
 110     xbt_die("Could not launch a new process on failed host %s.", host->get_cname());
 111   }
 112
 113   xbt_dict_free(&properties);
 114   for (int i = 0; i != argc; ++i)
 115     xbt_free(argv[i]);
 116   xbt_free(argv);
 117
 118   simgrid::s4u::this_actor::yield();
 119   return actor.get();
 120 }
 121
 122 /** @brief Returns the user data of a process.
 123  *
 124  * This function checks whether @a process is a valid pointer and returns the user data associated to this process.
 125  */
 126 void* MSG_process_get_data(msg_process_t process)
 127 {
 128   xbt_assert(process != nullptr, "Invalid parameter: first parameter must not be nullptr!");
 129
 130   /* get from SIMIX the MSG process data, and then the user data */
 131   return process->extension<simgrid::msg::ActorUserData>()->get_user_data();
 132 }
 133
 134 /** @brief Sets the user data of a process.
 135  *
 136  * This function checks whether @a process is a valid pointer and sets the user data associated to this process.
 137  */
 138 msg_error_t MSG_process_set_data(msg_process_t process, void *data)
 139 {
 140   xbt_assert(process != nullptr, "Invalid parameter: first parameter must not be nullptr!");
 141   process->extension<simgrid::msg::ActorUserData>()->set_user_data(data);
 142
 143   return MSG_OK;
 144 }
 145
 146 /** @brief Sets a cleanup function to be called to free the userdata of a process when a process is destroyed.
 147  * @param data_cleanup a cleanup function for the userdata of a process, or nullptr to call no function
 148  */
 149 XBT_PUBLIC void MSG_process_set_data_cleanup(void_f_pvoid_t data_cleanup)
 150 {
 151   msg_global->process_data_cleanup = data_cleanup;
 152 }
 153
 154 /** @brief returns a list of all currently existing processes */
 155 xbt_dynar_t MSG_processes_as_dynar() {
 156   xbt_dynar_t res = xbt_dynar_new(sizeof(smx_actor_t), nullptr);
 157   for (auto const& kv : simix_global->process_list) {
 158     smx_actor_t actor = kv.second;
 159     xbt_dynar_push(res, &actor);
 160   }
 161   return res;
 162 }
 163
 164 /** @brief Return the current number MSG processes. */
 165 int MSG_process_get_number()
 166 {
 167   return SIMIX_process_count();
 168 }
 169
 170 /** @brief Return the PID of the current process.
 171  *
 172  * This function returns the PID of the currently running #msg_process_t.
 173  */
 174 int MSG_process_self_PID()
 175 {
 176   smx_actor_t self = SIMIX_process_self();
 177   return self == nullptr ? 0 : self->get_pid();
 178 }
 179
 180 /** @brief Return the PPID of the current process.
 181  *
 182  * This function returns the PID of the parent of the currently running #msg_process_t.
 183  */
 184 int MSG_process_self_PPID()
 185 {
 186   return MSG_process_get_PPID(MSG_process_self());
 187 }
 188
 189 /** @brief Return the name of the current process. */
 190 const char* MSG_process_self_name()
 191 {
 192   return SIMIX_process_self_get_name();
 193 }
 194
 195 /** @brief Return the current process.
 196  *
 197  * This function returns the currently running #msg_process_t.
 198  */
 199 msg_process_t MSG_process_self()
 200 {
 201   return SIMIX_process_self()->ciface();
 202 }
 203
 204 /** @brief Add a function to the list of "on_exit" functions for the current process.
 205  *  The on_exit functions are the functions executed when your process is killed.
 206  *  You should use them to free the data used by your process.
 207  */
 208 void MSG_process_on_exit(int_f_int_pvoid_t fun, void* data)
 209 {
 210   simgrid::s4u::this_actor::on_exit(
 211       [fun, data](bool failed) { fun(failed ? SMX_EXIT_FAILURE : SMX_EXIT_SUCCESS, data); });
 212 }
 213
 214 /** @brief Take an extra reference on that process to prevent it to be garbage-collected */
 215 XBT_PUBLIC void MSG_process_ref(msg_process_t process)
 216 {
 217   intrusive_ptr_add_ref(process);
 218 }
 219 /** @brief Release a reference on that process so that it can get be garbage-collected */
 220 XBT_PUBLIC void MSG_process_unref(msg_process_t process)
 221 {
 222   intrusive_ptr_release(process);
 223 }