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