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