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