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_proc)
  28 {
  29   simdata_process_t msg_proc;
  30
  31   // get the MSG process from the SIMIX process
  32   if (smx_proc == SIMIX_process_self()) {
  33     /* avoid a SIMIX request if this function is called by the process itself */
  34     msg_proc = (simdata_process_t) SIMIX_process_self_get_data();
  35     SIMIX_process_self_set_data(nullptr);
  36   } else {
  37     msg_proc = (simdata_process_t) simcall_process_get_data(smx_proc);
  38     simcall_process_set_data(smx_proc, nullptr);
  39   }
  40
  41   TRACE_msg_process_destroy(smx_proc->name.c_str(), smx_proc->pid);
  42   // free the data if a function was provided
  43   if (msg_proc && msg_proc->data && msg_global->process_data_cleanup) {
  44     msg_global->process_data_cleanup(msg_proc->data);
  45   }
  46
  47   // free the MSG process
  48   xbt_free(msg_proc);
  49   SIMIX_process_cleanup(smx_proc);
  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   simdata_process_t simdata = xbt_new0(s_simdata_process_t, 1);
 145   msg_process_t process;
 146
 147   /* Simulator data for MSG */
 148   simdata->waiting_action = nullptr;
 149   simdata->waiting_task = nullptr;
 150   simdata->m_host = host;
 151   simdata->data = data;
 152   simdata->last_errno = MSG_OK;
 153
 154   /* Let's create the process: SIMIX may decide to start it right now,
 155    * even before returning the flow control to us */
 156   process = simcall_process_create(
 157     name, std::move(code), simdata, host, -1,  properties, 0);
 158
 159   if (!process) {
 160     /* Undo everything we have just changed */
 161     xbt_free(simdata);
 162     return nullptr;
 163   }
 164   else {
 165     simcall_process_on_exit(process,(int_f_pvoid_pvoid_t)TRACE_msg_process_kill,process);
 166   }
 167   return process;
 168 }
 169
 170 static int MSG_maestro(int argc, char** argv)
 171 {
 172   int res = MSG_main();
 173   return res;
 174 }
 175
 176 /* Become a process in the simulation
 177  *
 178  * Currently this can only be called by the main thread (once) and only work with some thread factories
 179  * (currently ThreadContextFactory).
 180  *
 181  * In the future, it might be extended in order to attach other threads created by a third party library.
 182  */
 183 msg_process_t MSG_process_attach(const char *name, void *data, msg_host_t host, xbt_dict_t properties)
 184 {
 185   xbt_assert(host != nullptr, "Invalid parameters: host and code params must not be nullptr");
 186   simdata_process_t simdata = xbt_new0(s_simdata_process_t, 1);
 187   msg_process_t process;
 188
 189   /* Simulator data for MSG */
 190   simdata->waiting_action = nullptr;
 191   simdata->waiting_task = nullptr;
 192   simdata->m_host = host;
 193   simdata->data = data;
 194   simdata->last_errno = MSG_OK;
 195
 196   /* Let's create the process: SIMIX may decide to start it right now, even before returning the flow control to us */
 197   process = SIMIX_process_attach(name, simdata, host->cname(), properties, nullptr);
 198   if (!process)
 199     xbt_die("Could not attach");
 200   simcall_process_on_exit(process,(int_f_pvoid_pvoid_t)TRACE_msg_process_kill,process);
 201   return process;
 202 }
 203
 204 /** Detach a process attached with `MSG_process_attach()`
 205  *
 206  *  This is called when the current process has finished its job.
 207  *  Used in the main thread, it waits for the simulation to finish before  returning. When it returns, the other
 208  *  simulated processes and the maestro are destroyed.
 209  */
 210 void MSG_process_detach()
 211 {
 212   SIMIX_process_detach();
 213 }
 214
 215 /** \ingroup m_process_management
 216  * \param process poor victim
 217  *
 218  * This function simply kills a \a process... scary isn't it ? :)
 219  */
 220 void MSG_process_kill(msg_process_t process)
 221 {
 222   simcall_process_kill(process);
 223 }
 224
 225 /**
 226 * \brief Wait for the completion of a #msg_process_t.
 227 *
 228 * \param process the process to wait for
 229 * \param timeout wait until the process is over, or the timeout occurs
 230 */
 231 msg_error_t MSG_process_join(msg_process_t process, double timeout){
 232   simcall_process_join(process, timeout);
 233   return MSG_OK;
 234 }
 235
 236 /** \ingroup m_process_management
 237  * \brief Migrates a process to another location.
 238  *
 239  * This function checks whether \a process and \a host are valid pointers and change the value of the #msg_host_t on
 240  * which \a process is running.
 241  */
 242 msg_error_t MSG_process_migrate(msg_process_t process, msg_host_t host)
 243 {
 244   simdata_process_t simdata = (simdata_process_t) simcall_process_get_data(process);
 245   simdata->m_host = host;
 246   msg_host_t now = simdata->m_host;
 247   TRACE_msg_process_change_host(process, now, host);
 248   simcall_process_set_host(process, host);
 249   return MSG_OK;
 250 }
 251
 252 /** Yield the current actor; let the other actors execute first */
 253 void MSG_process_yield()
 254 {
 255   simgrid::simix::kernelImmediate([] { /* do nothing*/ });
 256 }
 257
 258 /** \ingroup m_process_management
 259  * \brief Returns the user data of a process.
 260  *
 261  * This function checks whether \a process is a valid pointer and returns the user data associated to this process.
 262  */
 263 void* MSG_process_get_data(msg_process_t process)
 264 {
 265   xbt_assert(process != nullptr, "Invalid parameter: first parameter must not be nullptr!");
 266
 267   /* get from SIMIX the MSG process data, and then the user data */
 268   simdata_process_t simdata = (simdata_process_t) simcall_process_get_data(process);
 269   if (simdata)
 270     return simdata->data;
 271   else
 272     return nullptr;
 273 }
 274
 275 /** \ingroup m_process_management
 276  * \brief Sets the user data of a process.
 277  *
 278  * This function checks whether \a process is a valid pointer and sets the user data associated to this process.
 279  */
 280 msg_error_t MSG_process_set_data(msg_process_t process, void *data)
 281 {
 282   xbt_assert(process != nullptr, "Invalid parameter: first parameter must not be nullptr!");
 283
 284   simdata_process_t simdata = (simdata_process_t) simcall_process_get_data(process);
 285   simdata->data = data;
 286
 287   return MSG_OK;
 288 }
 289
 290 /** \ingroup m_process_management
 291  * \brief Sets a cleanup function to be called to free the userdata of a process when a process is destroyed.
 292  * \param data_cleanup a cleanup function for the userdata of a process, or nullptr to call no function
 293  */
 294 XBT_PUBLIC(void) MSG_process_set_data_cleanup(void_f_pvoid_t data_cleanup) {
 295   msg_global->process_data_cleanup = data_cleanup;
 296 }
 297
 298 /** \ingroup m_process_management
 299  * \brief Return the location on which a process is running.
 300  * \param process a process (nullptr means the current one)
 301  * \return the msg_host_t corresponding to the location on which \a process is running.
 302  */
 303 msg_host_t MSG_process_get_host(msg_process_t process)
 304 {
 305   simdata_process_t simdata;
 306   if (process == nullptr) {
 307     simdata = (simdata_process_t) SIMIX_process_self_get_data();
 308   }
 309   else {
 310     simdata = (simdata_process_t) simcall_process_get_data(process);
 311   }
 312   return simdata ? simdata->m_host : nullptr;
 313 }
 314
 315 /** \ingroup m_process_management
 316  *
 317  * \brief Return a #msg_process_t given its PID.
 318  *
 319  * 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.
 320  * If no host is found, \c nullptr is returned.
 321    Note that the PID are uniq in the whole simulation, not only on a given host.
 322  */
 323 msg_process_t MSG_process_from_PID(int PID)
 324 {
 325   return SIMIX_process_from_PID(PID);
 326 }
 327
 328 /** @brief returns a list of all currently existing processes */
 329 xbt_dynar_t MSG_processes_as_dynar() {
 330   return SIMIX_processes_as_dynar();
 331 }
 332
 333 /** @brief Return the current number MSG processes. */
 334 int MSG_process_get_number()
 335 {
 336   return SIMIX_process_count();
 337 }
 338
 339 /** \ingroup m_process_management
 340  * \brief Set the kill time of a process.
 341  *
 342  * \param process a process
 343  * \param kill_time the time when the process is killed.
 344  */
 345 msg_error_t MSG_process_set_kill_time(msg_process_t process, double kill_time)
 346 {
 347   simcall_process_set_kill_time(process,kill_time);
 348   return MSG_OK;
 349 }
 350
 351 /** \ingroup m_process_management
 352  * \brief Returns the process ID of \a process.
 353  *
 354  * This function checks whether \a process is a valid pointer and return its PID (or 0 in case of problem).
 355  */
 356 int MSG_process_get_PID(msg_process_t process)
 357 {
 358   /* Do not raise an exception here: this function is called by the logs
 359    * and the exceptions, so it would be called back again and again */
 360   if (process == nullptr)
 361     return 0;
 362   return process->pid;
 363 }
 364
 365 /** \ingroup m_process_management
 366  * \brief Returns the process ID of the parent of \a process.
 367  *
 368  * This function checks whether \a process is a valid pointer and return its PID.
 369  * Returns -1 if the process has not been created by any other process.
 370  */
 371 int MSG_process_get_PPID(msg_process_t process)
 372 {
 373   return process->ppid;
 374 }
 375
 376 /** \ingroup m_process_management
 377  * \brief Return the name of a process.
 378  *
 379  * This function checks whether \a process is a valid pointer and return its name.
 380  */
 381 const char *MSG_process_get_name(msg_process_t process)
 382 {
 383   return process->name.c_str();
 384 }
 385
 386 /** \ingroup m_process_management
 387  * \brief Returns the value of a given process property
 388  *
 389  * \param process a process
 390  * \param name a property name
 391  * \return value of a property (or nullptr if the property is not set)
 392  */
 393 const char *MSG_process_get_property_value(msg_process_t process, const char *name)
 394 {
 395   return (char*) xbt_dict_get_or_null(MSG_process_get_properties(process), name);
 396 }
 397
 398 /** \ingroup m_process_management
 399  * \brief Return the list of properties
 400  *
 401  * This function returns all the parameters associated with a process
 402  */
 403 xbt_dict_t MSG_process_get_properties(msg_process_t process)
 404 {
 405   xbt_assert(process != nullptr, "Invalid parameter: First argument must not be nullptr");
 406   return simcall_process_get_properties(process);
 407 }
 408
 409 /** \ingroup m_process_management
 410  * \brief Return the PID of the current process.
 411  *
 412  * This function returns the PID of the currently running #msg_process_t.
 413  */
 414 int MSG_process_self_PID()
 415 {
 416   return MSG_process_get_PID(MSG_process_self());
 417 }
 418
 419 /** \ingroup m_process_management
 420  * \brief Return the PPID of the current process.
 421  *
 422  * This function returns the PID of the parent of the currently running #msg_process_t.
 423  */
 424 int MSG_process_self_PPID()
 425 {
 426   return MSG_process_get_PPID(MSG_process_self());
 427 }
 428
 429 /** \ingroup m_process_management
 430  * \brief Return the current process.
 431  *
 432  * This function returns the currently running #msg_process_t.
 433  */
 434 msg_process_t MSG_process_self()
 435 {
 436   return SIMIX_process_self();
 437 }
 438
 439 /** \ingroup m_process_management
 440  * \brief Suspend the process.
 441  *
 442  * This function suspends the process by suspending the task on which it was waiting for the completion.
 443  */
 444 msg_error_t MSG_process_suspend(msg_process_t process)
 445 {
 446   xbt_assert(process != nullptr, "Invalid parameter: First argument must not be nullptr");
 447
 448   TRACE_msg_process_suspend(process);
 449   simcall_process_suspend(process);
 450   return MSG_OK;
 451 }
 452
 453 /** \ingroup m_process_management
 454  * \brief Resume a suspended process.
 455  *
 456  * This function resumes a suspended process by resuming the task on which it was waiting for the completion.
 457  */
 458 msg_error_t MSG_process_resume(msg_process_t process)
 459 {
 460   xbt_assert(process != nullptr, "Invalid parameter: First argument must not be nullptr");
 461
 462   TRACE_msg_process_resume(process);
 463   simcall_process_resume(process);
 464   return MSG_OK;
 465 }
 466
 467 /** \ingroup m_process_management
 468  * \brief Returns true if the process is suspended .
 469  *
 470  * This checks whether a process is suspended or not by inspecting the task on which it was waiting for the completion.
 471  */
 472 int MSG_process_is_suspended(msg_process_t process)
 473 {
 474   xbt_assert(process != nullptr, "Invalid parameter: First argument must not be nullptr");
 475   return simcall_process_is_suspended(process);
 476 }
 477
 478 smx_context_t MSG_process_get_smx_ctx(msg_process_t process) {
 479   return SIMIX_process_get_context(process);
 480 }
 481 /**
 482  * \ingroup m_process_management
 483  * \brief Add a function to the list of "on_exit" functions for the current process.
 484  * The on_exit functions are the functions executed when your process is killed.
 485  * You should use them to free the data used by your process.
 486  */
 487 void MSG_process_on_exit(int_f_pvoid_pvoid_t fun, void *data) {
 488   simcall_process_on_exit(MSG_process_self(),fun,data);
 489 }
 490 /**
 491  * \ingroup m_process_management
 492  * \brief Sets the "auto-restart" flag of the process.
 493  * If the flag is set to 1, the process will be automatically restarted when its host comes back up.
 494  */
 495 XBT_PUBLIC(void) MSG_process_auto_restart_set(msg_process_t process, int auto_restart) {
 496   simcall_process_auto_restart_set(process,auto_restart);
 497 }
 498 /*
 499  * \ingroup m_process_management
 500  * \brief Restarts a process from the beginning.
 501  */
 502 XBT_PUBLIC(msg_process_t) MSG_process_restart(msg_process_t process) {
 503   return simcall_process_restart(process);
 504 }