src/msg/msg_process.cpp

   1 /* Copyright (c) 2004-2015. The SimGrid Team.
   2  * All rights reserved.                                                     */
   3
   4 /* This program is free software; you can redistribute it and/or modify it
   5  * under the terms of the license (GNU LGPL) which comes with this package. */
   6
   7 #include "msg_private.h"
   8 #include "simgrid/s4u/host.hpp"
   9 #include "src/simix/ActorImpl.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 a process.
  25  * \param smx_proc a SIMIX process
  26  */
  27 void MSG_process_cleanup_from_SIMIX(smx_actor_t smx_actor)
  28 {
  29   MsgActorExt* 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 = (MsgActorExt*)SIMIX_process_self_get_data();
  35     SIMIX_process_self_set_data(nullptr);
  36   } else {
  37     msg_actor = (MsgActorExt*)smx_actor->data;
  38     simcall_process_set_data(smx_actor, nullptr);
  39   }
  40
  41   TRACE_msg_process_destroy(smx_actor->name.c_str(), smx_actor->pid);
  42   // free the data if a function was provided
  43   if (msg_actor && msg_actor->data && msg_global->process_data_cleanup) {
  44     msg_global->process_data_cleanup(msg_actor->data);
  45   }
  46
  47   // free the MSG process
  48   xbt_free(msg_actor);
  49   SIMIX_process_cleanup(smx_actor);
  50 }
  51
  52 /* This function creates a MSG process. It has the prototype enforced by SIMIX_function_register_process_create */
  53 smx_actor_t MSG_process_create_from_SIMIX(
  54   const char *name, std::function<void()> code, void *data, sg_host_t host,
  55   double kill_time, xbt_dict_t properties,
  56   int auto_restart, smx_actor_t parent_process)
  57 {
  58   msg_process_t p = MSG_process_create_with_environment(name, std::move(code), data, host, properties);
  59   if (p) {
  60     MSG_process_set_kill_time(p,kill_time);
  61     MSG_process_auto_restart_set(p,auto_restart);
  62   }
  63   return p;
  64 }
  65
  66 /** \ingroup m_process_management
  67  * \brief Creates and runs a new #msg_process_t.
  68  *
  69  * Does exactly the same as #MSG_process_create_with_arguments but without providing standard arguments
  70  * (\a argc, \a argv, \a start_time, \a kill_time).
  71  * \sa MSG_process_create_with_arguments
  72  */
  73 msg_process_t MSG_process_create(const char *name, xbt_main_func_t code, void *data, msg_host_t host)
  74 {
  75   return MSG_process_create_with_environment(name, code, data, host, 0, nullptr, nullptr);
  76 }
  77
  78 /** \ingroup m_process_management
  79  * \brief Creates and runs a new #msg_process_t.
  80
  81  * A constructor for #msg_process_t taking four arguments and returning the corresponding object. The structure (and
  82  * the corresponding thread) is created, and put in the list of ready process.
  83  * \param name a name for the object. It is for user-level information and can be nullptr.
  84  * \param code is a function describing the behavior of the process. It should then only use functions described
  85  * in \ref m_process_management (to create a new #msg_process_t for example),
  86    in \ref m_host_management (only the read-only functions i.e. whose name contains the word get),
  87    in \ref m_task_management (to create or destroy some #msg_task_t for example) and
  88    in \ref msg_task_usage (to handle file transfers and task processing).
  89  * \param data a pointer to any data one may want to attach to the new object.  It is for user-level information and
  90  *        can be nullptr. It can be retrieved with the function \ref MSG_process_get_data.
  91  * \param host the location where the new process is executed.
  92  * \param argc first argument passed to \a code
  93  * \param argv second argument passed to \a code
  94  * \see msg_process_t
  95  * \return The new corresponding object.
  96  */
  97
  98 msg_process_t MSG_process_create_with_arguments(const char *name, xbt_main_func_t code, void *data, msg_host_t host,
  99                                               int argc, char **argv)
 100 {
 101   return MSG_process_create_with_environment(name, code, data, host, argc, argv, nullptr);
 102 }
 103
 104 /** \ingroup m_process_management
 105  * \brief Creates and runs a new #msg_process_t.
 106
 107  * A constructor for #msg_process_t taking four arguments and returning the corresponding object. The structure (and
 108  * the corresponding thread) is created, and put in the list of ready process.
 109  * \param name a name for the object. It is for user-level information and can be nullptr.
 110  * \param code is a function describing the behavior of the process. It should then only use functions described
 111  * in \ref m_process_management (to create a new #msg_process_t for example),
 112    in \ref m_host_management (only the read-only functions i.e. whose name contains the word get),
 113    in \ref m_task_management (to create or destroy some #msg_task_t for example) and
 114    in \ref msg_task_usage (to handle file transfers and task processing).
 115  * \param data a pointer to any data one may want to attach to the new object.  It is for user-level information and
 116  *        can be nullptr. It can be retrieved with the function \ref MSG_process_get_data.
 117  * \param host the location where the new process is executed.
 118  * \param argc first argument passed to \a code
 119  * \param argv second argument passed to \a code. WARNING, these strings are freed by the SimGrid kernel when the
 120  *             process exits, so they cannot be static nor shared between several processes.
 121  * \param properties list a properties defined for this process
 122  * \see msg_process_t
 123  * \return The new corresponding object.
 124  */
 125 msg_process_t MSG_process_create_with_environment(const char *name, xbt_main_func_t code, void *data, msg_host_t host,
 126                                                   int argc, char **argv, xbt_dict_t properties)
 127 {
 128   std::function<void()> function;
 129   if (code)
 130     function = simgrid::xbt::wrapMain(code, argc, const_cast<const char*const*>(argv));
 131   msg_process_t res = MSG_process_create_with_environment(name,
 132     std::move(function), data, host, properties);
 133   for (int i = 0; i != argc; ++i)
 134     xbt_free(argv[i]);
 135   xbt_free(argv);
 136   return res;
 137 }
 138
 139 msg_process_t MSG_process_create_with_environment(
 140   const char *name, std::function<void()> code, void *data,
 141   msg_host_t host, xbt_dict_t properties)
 142 {
 143   xbt_assert(code != nullptr && host != nullptr, "Invalid parameters: host and code params must not be nullptr");
 144   MsgActorExt* simdata = new MsgActorExt();
 145
 146   /* Simulator data for MSG */
 147   simdata->m_host = host;
 148   simdata->data = data;
 149   simdata->last_errno = MSG_OK;
 150
 151   /* Let's create the process: SIMIX may decide to start it right now,
 152    * even before returning the flow control to us */
 153   msg_process_t process = simcall_process_create(name, std::move(code), simdata, host, -1, properties, 0);
 154
 155   if (!process) {
 156     /* Undo everything we have just changed */
 157     xbt_free(simdata);
 158     return nullptr;
 159   }
 160   else {
 161     simcall_process_on_exit(process,(int_f_pvoid_pvoid_t)TRACE_msg_process_kill,process);
 162   }
 163   return process;
 164 }
 165
 166 static int MSG_maestro(int argc, char** argv)
 167 {
 168   int res = MSG_main();
 169   return res;
 170 }
 171
 172 /* Become a process in the simulation
 173  *
 174  * Currently this can only be called by the main thread (once) and only work with some thread factories
 175  * (currently ThreadContextFactory).
 176  *
 177  * In the future, it might be extended in order to attach other threads created by a third party library.
 178  */
 179 msg_process_t MSG_process_attach(const char *name, void *data, msg_host_t host, xbt_dict_t properties)
 180 {
 181   xbt_assert(host != nullptr, "Invalid parameters: host and code params must not be nullptr");
 182   MsgActorExt* msgExt = new MsgActorExt();
 183
 184   /* Simulator data for MSG */
 185   msgExt->m_host = host;
 186   msgExt->data   = data;
 187
 188   /* Let's create the process: SIMIX may decide to start it right now, even before returning the flow control to us */
 189   msg_process_t process = SIMIX_process_attach(name, msgExt, host->cname(), properties, nullptr);
 190   if (!process)
 191     xbt_die("Could not attach");
 192   simcall_process_on_exit(process,(int_f_pvoid_pvoid_t)TRACE_msg_process_kill,process);
 193   return process;
 194 }
 195
 196 /** Detach a process attached with `MSG_process_attach()`
 197  *
 198  *  This is called when the current process has finished its job.
 199  *  Used in the main thread, it waits for the simulation to finish before  returning. When it returns, the other
 200  *  simulated processes and the maestro are destroyed.
 201  */
 202 void MSG_process_detach()
 203 {
 204   SIMIX_process_detach();
 205 }
 206
 207 /** \ingroup m_process_management
 208  * \param process poor victim
 209  *
 210  * This function simply kills a \a process... scary isn't it ? :)
 211  */
 212 void MSG_process_kill(msg_process_t process)
 213 {
 214   simcall_process_kill(process);
 215 }
 216
 217 /**
 218 * \brief Wait for the completion of a #msg_process_t.
 219 *
 220 * \param process the process to wait for
 221 * \param timeout wait until the process is over, or the timeout occurs
 222 */
 223 msg_error_t MSG_process_join(msg_process_t process, double timeout){
 224   simcall_process_join(process, timeout);
 225   return MSG_OK;
 226 }
 227
 228 /** \ingroup m_process_management
 229  * \brief Migrates a process to another location.
 230  *
 231  * This function checks whether \a process and \a host are valid pointers and change the value of the #msg_host_t on
 232  * which \a process is running.
 233  */
 234 msg_error_t MSG_process_migrate(msg_process_t process, msg_host_t host)
 235 {
 236   MsgActorExt* msgExt = (MsgActorExt*)process->data;
 237   msgExt->m_host      = host;
 238   msg_host_t now      = msgExt->m_host;
 239   TRACE_msg_process_change_host(process, now, host);
 240   simcall_process_set_host(process, host);
 241   return MSG_OK;
 242 }
 243
 244 /** Yield the current actor; let the other actors execute first */
 245 void MSG_process_yield()
 246 {
 247   simgrid::simix::kernelImmediate([] { /* do nothing*/ });
 248 }
 249
 250 /** \ingroup m_process_management
 251  * \brief Returns the user data of a process.
 252  *
 253  * This function checks whether \a process is a valid pointer and returns the user data associated to this process.
 254  */
 255 void* MSG_process_get_data(msg_process_t process)
 256 {
 257   xbt_assert(process != nullptr, "Invalid parameter: first parameter must not be nullptr!");
 258
 259   /* get from SIMIX the MSG process data, and then the user data */
 260   MsgActorExt* msgExt = (MsgActorExt*)process->data;
 261   if (msgExt)
 262     return msgExt->data;
 263   else
 264     return nullptr;
 265 }
 266
 267 /** \ingroup m_process_management
 268  * \brief Sets the user data of a process.
 269  *
 270  * This function checks whether \a process is a valid pointer and sets the user data associated to this process.
 271  */
 272 msg_error_t MSG_process_set_data(msg_process_t process, void *data)
 273 {
 274   xbt_assert(process != nullptr, "Invalid parameter: first parameter must not be nullptr!");
 275
 276   MsgActorExt* msgExt = (MsgActorExt*)process->data;
 277   msgExt->data        = data;
 278
 279   return MSG_OK;
 280 }
 281
 282 /** \ingroup m_process_management
 283  * \brief Sets a cleanup function to be called to free the userdata of a process when a process is destroyed.
 284  * \param data_cleanup a cleanup function for the userdata of a process, or nullptr to call no function
 285  */
 286 XBT_PUBLIC(void) MSG_process_set_data_cleanup(void_f_pvoid_t data_cleanup) {
 287   msg_global->process_data_cleanup = data_cleanup;
 288 }
 289
 290 /** \ingroup m_process_management
 291  * \brief Return the location on which a process is running.
 292  * \param process a process (nullptr means the current one)
 293  * \return the msg_host_t corresponding to the location on which \a process is running.
 294  */
 295 msg_host_t MSG_process_get_host(msg_process_t process)
 296 {
 297   MsgActorExt* msgExt;
 298   if (process == nullptr) {
 299     msgExt = (MsgActorExt*)SIMIX_process_self_get_data();
 300   }
 301   else {
 302     msgExt = (MsgActorExt*)process->data;
 303   }
 304   return msgExt ? msgExt->m_host : nullptr;
 305 }
 306
 307 /** \ingroup m_process_management
 308  *
 309  * \brief Return a #msg_process_t given its PID.
 310  *
 311  * 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.
 312  * If no host is found, \c nullptr is returned.
 313    Note that the PID are uniq in the whole simulation, not only on a given host.
 314  */
 315 msg_process_t MSG_process_from_PID(int PID)
 316 {
 317   return SIMIX_process_from_PID(PID);
 318 }
 319
 320 /** @brief returns a list of all currently existing processes */
 321 xbt_dynar_t MSG_processes_as_dynar() {
 322   return SIMIX_processes_as_dynar();
 323 }
 324
 325 /** @brief Return the current number MSG processes. */
 326 int MSG_process_get_number()
 327 {
 328   return SIMIX_process_count();
 329 }
 330
 331 /** \ingroup m_process_management
 332  * \brief Set the kill time of a process.
 333  *
 334  * \param process a process
 335  * \param kill_time the time when the process is killed.
 336  */
 337 msg_error_t MSG_process_set_kill_time(msg_process_t process, double kill_time)
 338 {
 339   simcall_process_set_kill_time(process,kill_time);
 340   return MSG_OK;
 341 }
 342
 343 /** \ingroup m_process_management
 344  * \brief Returns the process ID of \a process.
 345  *
 346  * This function checks whether \a process is a valid pointer and return its PID (or 0 in case of problem).
 347  */
 348 int MSG_process_get_PID(msg_process_t process)
 349 {
 350   /* Do not raise an exception here: this function is called by the logs
 351    * and the exceptions, so it would be called back again and again */
 352   if (process == nullptr)
 353     return 0;
 354   return process->pid;
 355 }
 356
 357 /** \ingroup m_process_management
 358  * \brief Returns the process ID of the parent of \a process.
 359  *
 360  * This function checks whether \a process is a valid pointer and return its PID.
 361  * Returns -1 if the process has not been created by any other process.
 362  */
 363 int MSG_process_get_PPID(msg_process_t process)
 364 {
 365   return process->ppid;
 366 }
 367
 368 /** \ingroup m_process_management
 369  * \brief Return the name of a process.
 370  *
 371  * This function checks whether \a process is a valid pointer and return its name.
 372  */
 373 const char *MSG_process_get_name(msg_process_t process)
 374 {
 375   return process->name.c_str();
 376 }
 377
 378 /** \ingroup m_process_management
 379  * \brief Returns the value of a given process property
 380  *
 381  * \param process a process
 382  * \param name a property name
 383  * \return value of a property (or nullptr if the property is not set)
 384  */
 385 const char *MSG_process_get_property_value(msg_process_t process, const char *name)
 386 {
 387   return (char*) xbt_dict_get_or_null(MSG_process_get_properties(process), name);
 388 }
 389
 390 /** \ingroup m_process_management
 391  * \brief Return the list of properties
 392  *
 393  * This function returns all the parameters associated with a process
 394  */
 395 xbt_dict_t MSG_process_get_properties(msg_process_t process)
 396 {
 397   xbt_assert(process != nullptr, "Invalid parameter: First argument must not be nullptr");
 398   return simcall_process_get_properties(process);
 399 }
 400
 401 /** \ingroup m_process_management
 402  * \brief Return the PID of the current process.
 403  *
 404  * This function returns the PID of the currently running #msg_process_t.
 405  */
 406 int MSG_process_self_PID()
 407 {
 408   return MSG_process_get_PID(MSG_process_self());
 409 }
 410
 411 /** \ingroup m_process_management
 412  * \brief Return the PPID of the current process.
 413  *
 414  * This function returns the PID of the parent of the currently running #msg_process_t.
 415  */
 416 int MSG_process_self_PPID()
 417 {
 418   return MSG_process_get_PPID(MSG_process_self());
 419 }
 420
 421 /** \ingroup m_process_management
 422  * \brief Return the current process.
 423  *
 424  * This function returns the currently running #msg_process_t.
 425  */
 426 msg_process_t MSG_process_self()
 427 {
 428   return SIMIX_process_self();
 429 }
 430
 431 /** \ingroup m_process_management
 432  * \brief Suspend the process.
 433  *
 434  * This function suspends the process by suspending the task on which it was waiting for the completion.
 435  */
 436 msg_error_t MSG_process_suspend(msg_process_t process)
 437 {
 438   xbt_assert(process != nullptr, "Invalid parameter: First argument must not be nullptr");
 439
 440   TRACE_msg_process_suspend(process);
 441   simcall_process_suspend(process);
 442   return MSG_OK;
 443 }
 444
 445 /** \ingroup m_process_management
 446  * \brief Resume a suspended process.
 447  *
 448  * This function resumes a suspended process by resuming the task on which it was waiting for the completion.
 449  */
 450 msg_error_t MSG_process_resume(msg_process_t process)
 451 {
 452   xbt_assert(process != nullptr, "Invalid parameter: First argument must not be nullptr");
 453
 454   TRACE_msg_process_resume(process);
 455   simcall_process_resume(process);
 456   return MSG_OK;
 457 }
 458
 459 /** \ingroup m_process_management
 460  * \brief Returns true if the process is suspended .
 461  *
 462  * This checks whether a process is suspended or not by inspecting the task on which it was waiting for the completion.
 463  */
 464 int MSG_process_is_suspended(msg_process_t process)
 465 {
 466   xbt_assert(process != nullptr, "Invalid parameter: First argument must not be nullptr");
 467   return simcall_process_is_suspended(process);
 468 }
 469
 470 smx_context_t MSG_process_get_smx_ctx(msg_process_t process) {
 471   return SIMIX_process_get_context(process);
 472 }
 473 /**
 474  * \ingroup m_process_management
 475  * \brief Add a function to the list of "on_exit" functions for the current process.
 476  * The on_exit functions are the functions executed when your process is killed.
 477  * You should use them to free the data used by your process.
 478  */
 479 void MSG_process_on_exit(int_f_pvoid_pvoid_t fun, void *data) {
 480   simcall_process_on_exit(MSG_process_self(),fun,data);
 481 }
 482 /**
 483  * \ingroup m_process_management
 484  * \brief Sets the "auto-restart" flag of the process.
 485  * If the flag is set to 1, the process will be automatically restarted when its host comes back up.
 486  */
 487 XBT_PUBLIC(void) MSG_process_auto_restart_set(msg_process_t process, int auto_restart) {
 488   simcall_process_auto_restart_set(process,auto_restart);
 489 }
 490 /*
 491  * \ingroup m_process_management
 492  * \brief Restarts a process from the beginning.
 493  */
 494 XBT_PUBLIC(msg_process_t) MSG_process_restart(msg_process_t process) {
 495   return simcall_process_restart(process);
 496 }