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