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