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