src/msg/msg_process.cpp

   1 /* Copyright (c) 2004-2018. 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/s4u/Host.hpp"
   8 #include "src/instr/instr_private.hpp"
   9 #include "src/simix/ActorImpl.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(msg_process_t proc)
  15 {
  16   return std::string(proc->get_cname()) + "-" + std::to_string(proc->get_pid());
  17 }
  18
  19 /** @addtogroup m_process_management
  20  *
  21  *  Processes (#msg_process_t) are independent agents that can do stuff on their own. They are in charge of executing
  22  *  your code interacting with the simulated world.
  23  *  A process may be defined as a <em>code</em> with some <em>private data</em>.
  24  *  Processes must be located on <em>hosts</em> (#msg_host_t), and they exchange data by sending tasks (#msg_task_t)
  25  *  that are similar to envelops containing data.
  26  */
  27
  28 /******************************** Process ************************************/
  29 /**
  30  * @brief Cleans the MSG data of an actor
  31  * @param smx_actor a SIMIX actor
  32  */
  33 void MSG_process_cleanup_from_SIMIX(smx_actor_t smx_actor)
  34 {
  35   // free the data if a function was provided
  36   void* userdata = smx_actor->get_user_data();
  37   if (userdata && msg_global->process_data_cleanup) {
  38     msg_global->process_data_cleanup(userdata);
  39   }
  40
  41   SIMIX_process_cleanup(smx_actor);
  42 }
  43
  44 /* This function creates a MSG process. It has the prototype enforced by SIMIX_function_register_process_create */
  45 smx_actor_t MSG_process_create_from_SIMIX(std::string name, simgrid::simix::ActorCode code, void* data, sg_host_t host,
  46                                           std::unordered_map<std::string, std::string>* properties,
  47                                           smx_actor_t /*parent_process*/)
  48 {
  49   msg_process_t p = MSG_process_create_from_stdfunc(name, std::move(code), data, host, properties);
  50   return p == nullptr ? nullptr : p->get_impl();
  51 }
  52
  53 /** @ingroup m_process_management
  54  * @brief Creates and runs a new #msg_process_t.
  55  *
  56  * Does exactly the same as #MSG_process_create_with_arguments but without providing standard arguments
  57  * (@a argc, @a argv, @a start_time, @a kill_time).
  58  * @sa MSG_process_create_with_arguments
  59  */
  60 msg_process_t MSG_process_create(const char *name, xbt_main_func_t code, void *data, msg_host_t host)
  61 {
  62   return MSG_process_create_with_environment(name == nullptr ? "" : name, code, data, host, 0, nullptr, nullptr);
  63 }
  64
  65 /** @ingroup m_process_management
  66  * @brief Creates and runs a new #msg_process_t.
  67
  68  * A constructor for #msg_process_t taking four arguments and returning the corresponding object. The structure (and
  69  * the corresponding thread) is created, and put in the list of ready process.
  70  * @param name a name for the object. It is for user-level information and can be nullptr.
  71  * @param code is a function describing the behavior of the process. It should then only use functions described
  72  * in @ref m_process_management (to create a new #msg_process_t for example),
  73    in @ref m_host_management (only the read-only functions i.e. whose name contains the word get),
  74    in @ref m_task_management (to create or destroy some #msg_task_t for example) and
  75    in @ref msg_task_usage (to handle file transfers and task processing).
  76  * @param data a pointer to any data one may want to attach to the new object.  It is for user-level information and
  77  *        can be nullptr. It can be retrieved with the function @ref MSG_process_get_data.
  78  * @param host the location where the new process is executed.
  79  * @param argc first argument passed to @a code
  80  * @param argv second argument passed to @a code
  81  * @see msg_process_t
  82  * @return The new corresponding object.
  83  */
  84
  85 msg_process_t MSG_process_create_with_arguments(const char *name, xbt_main_func_t code, void *data, msg_host_t host,
  86                                               int argc, char **argv)
  87 {
  88   return MSG_process_create_with_environment(name, code, data, host, argc, argv, nullptr);
  89 }
  90
  91 /** @ingroup m_process_management
  92  * @brief Creates and runs a new #msg_process_t.
  93
  94  * A constructor for #msg_process_t taking four arguments and returning the corresponding object. The structure (and
  95  * the corresponding thread) is created, and put in the list of ready process.
  96  * @param name a name for the object. It is for user-level information and can be nullptr.
  97  * @param code is a function describing the behavior of the process. It should then only use functions described
  98  * in @ref m_process_management (to create a new #msg_process_t for example),
  99    in @ref m_host_management (only the read-only functions i.e. whose name contains the word get),
 100    in @ref m_task_management (to create or destroy some #msg_task_t for example) and
 101    in @ref msg_task_usage (to handle file transfers and task processing).
 102  * @param data a pointer to any data one may want to attach to the new object.  It is for user-level information and
 103  *        can be nullptr. It can be retrieved with the function @ref MSG_process_get_data.
 104  * @param host the location where the new process is executed.
 105  * @param argc first argument passed to @a code
 106  * @param argv second argument passed to @a code. WARNING, these strings are freed by the SimGrid kernel when the
 107  *             process exits, so they cannot be static nor shared between several processes.
 108  * @param properties list a properties defined for this process
 109  * @see msg_process_t
 110  * @return The new corresponding object.
 111  */
 112 msg_process_t MSG_process_create_with_environment(const char *name, xbt_main_func_t code, void *data, msg_host_t host,
 113                                                   int argc, char **argv, xbt_dict_t properties)
 114 {
 115   simgrid::simix::ActorCode function;
 116   if (code)
 117     function = simgrid::xbt::wrap_main(code, argc, static_cast<const char* const*>(argv));
 118
 119   std::unordered_map<std::string, std::string> props;
 120   xbt_dict_cursor_t cursor = nullptr;
 121   char* key;
 122   char* value;
 123   xbt_dict_foreach (properties, cursor, key, value)
 124     props[key] = value;
 125   xbt_dict_free(&properties);
 126
 127   msg_process_t res = MSG_process_create_from_stdfunc(name, std::move(function), data, host, &props);
 128   for (int i = 0; i != argc; ++i)
 129     xbt_free(argv[i]);
 130   xbt_free(argv);
 131   return res;
 132 }
 133
 134 msg_process_t MSG_process_create_from_stdfunc(std::string name, simgrid::simix::ActorCode code, void* data,
 135                                               msg_host_t host, std::unordered_map<std::string, std::string>* properties)
 136 {
 137   xbt_assert(code != nullptr && host != nullptr, "Invalid parameters: host and code params must not be nullptr");
 138
 139   smx_actor_t process = simcall_process_create(name, std::move(code), data, host, properties);
 140
 141   if (process == nullptr)
 142     return nullptr;
 143
 144   MSG_process_yield();
 145   return process->ciface();
 146 }
 147
 148 /* Become a process in the simulation
 149  *
 150  * Currently this can only be called by the main thread (once) and only work with some thread factories
 151  * (currently ThreadContextFactory).
 152  *
 153  * In the future, it might be extended in order to attach other threads created by a third party library.
 154  */
 155 msg_process_t MSG_process_attach(const char *name, void *data, msg_host_t host, xbt_dict_t properties)
 156 {
 157   xbt_assert(host != nullptr, "Invalid parameters: host and code params must not be nullptr");
 158   std::unordered_map<std::string, std::string> props;
 159   xbt_dict_cursor_t cursor = nullptr;
 160   char* key;
 161   char* value;
 162   xbt_dict_foreach (properties, cursor, key, value)
 163     props[key] = value;
 164   xbt_dict_free(&properties);
 165
 166   /* Let's create the process: SIMIX may decide to start it right now, even before returning the flow control to us */
 167   smx_actor_t process = SIMIX_process_attach(name, data, host->get_cname(), &props, nullptr);
 168   if (not process)
 169     xbt_die("Could not attach");
 170   MSG_process_yield();
 171   return process->ciface();
 172 }
 173
 174 /** Detach a process attached with `MSG_process_attach()`
 175  *
 176  *  This is called when the current process has finished its job.
 177  *  Used in the main thread, it waits for the simulation to finish before  returning. When it returns, the other
 178  *  simulated processes and the maestro are destroyed.
 179  */
 180 void MSG_process_detach()
 181 {
 182   SIMIX_process_detach();
 183 }
 184
 185 /** @ingroup m_process_management
 186  * @brief Returns the user data of a process.
 187  *
 188  * This function checks whether @a process is a valid pointer and returns the user data associated to this process.
 189  */
 190 void* MSG_process_get_data(msg_process_t process)
 191 {
 192   xbt_assert(process != nullptr, "Invalid parameter: first parameter must not be nullptr!");
 193
 194   /* get from SIMIX the MSG process data, and then the user data */
 195   return process->get_impl()->get_user_data();
 196 }
 197
 198 /** @ingroup m_process_management
 199  * @brief Sets the user data of a process.
 200  *
 201  * This function checks whether @a process is a valid pointer and sets the user data associated to this process.
 202  */
 203 msg_error_t MSG_process_set_data(msg_process_t process, void *data)
 204 {
 205   xbt_assert(process != nullptr, "Invalid parameter: first parameter must not be nullptr!");
 206
 207   process->get_impl()->set_user_data(data);
 208
 209   return MSG_OK;
 210 }
 211
 212 /** @ingroup m_process_management
 213  * @brief Sets a cleanup function to be called to free the userdata of a process when a process is destroyed.
 214  * @param data_cleanup a cleanup function for the userdata of a process, or nullptr to call no function
 215  */
 216 XBT_PUBLIC void MSG_process_set_data_cleanup(void_f_pvoid_t data_cleanup)
 217 {
 218   msg_global->process_data_cleanup = data_cleanup;
 219 }
 220
 221 /** @brief returns a list of all currently existing processes */
 222 xbt_dynar_t MSG_processes_as_dynar() {
 223   xbt_dynar_t res = xbt_dynar_new(sizeof(smx_actor_t), nullptr);
 224   for (auto const& kv : simix_global->process_list) {
 225     smx_actor_t actor = kv.second;
 226     xbt_dynar_push(res, &actor);
 227   }
 228   return res;
 229 }
 230
 231 /** @brief Return the current number MSG processes. */
 232 int MSG_process_get_number()
 233 {
 234   return SIMIX_process_count();
 235 }
 236
 237 /** @ingroup m_process_management
 238  * @brief Return the PID of the current process.
 239  *
 240  * This function returns the PID of the currently running #msg_process_t.
 241  */
 242 int MSG_process_self_PID()
 243 {
 244   smx_actor_t self = SIMIX_process_self();
 245   return self == nullptr ? 0 : self->pid_;
 246 }
 247
 248 /** @ingroup m_process_management
 249  * @brief Return the PPID of the current process.
 250  *
 251  * This function returns the PID of the parent of the currently running #msg_process_t.
 252  */
 253 int MSG_process_self_PPID()
 254 {
 255   return MSG_process_get_PPID(MSG_process_self());
 256 }
 257
 258 /** @ingroup m_process_management
 259  * @brief Return the name of the current process.
 260  */
 261 const char* MSG_process_self_name()
 262 {
 263   return SIMIX_process_self_get_name();
 264 }
 265
 266 /** @ingroup m_process_management
 267  * @brief Return the current process.
 268  *
 269  * This function returns the currently running #msg_process_t.
 270  */
 271 msg_process_t MSG_process_self()
 272 {
 273   return SIMIX_process_self()->ciface();
 274 }
 275
 276 smx_context_t MSG_process_get_smx_ctx(msg_process_t process) { // deprecated -- smx_context_t should die afterward
 277   return process->get_impl()->context_;
 278 }
 279 /**
 280  * @ingroup m_process_management
 281  * @brief Add a function to the list of "on_exit" functions for the current process.
 282  * The on_exit functions are the functions executed when your process is killed.
 283  * You should use them to free the data used by your process.
 284  */
 285 void MSG_process_on_exit(int_f_pvoid_pvoid_t fun, void *data) {
 286   simgrid::s4u::this_actor::on_exit([fun](int a, void* b) { fun((void*)(intptr_t)a, b); }, data);
 287 }
 288
 289 /** @ingroup m_process_management
 290  * @brief Take an extra reference on that process to prevent it to be garbage-collected
 291  */
 292 XBT_PUBLIC void MSG_process_ref(msg_process_t process)
 293 {
 294   intrusive_ptr_add_ref(process);
 295 }
 296 /** @ingroup m_process_management
 297  * @brief Release a reference on that process so that it can get be garbage-collected
 298  */
 299 XBT_PUBLIC void MSG_process_unref(msg_process_t process)
 300 {
 301   intrusive_ptr_release(process);
 302 }