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 /** \ingroup m_process_management
 185  * \param process poor victim
 186  *
 187  * This function simply kills a \a process... scary isn't it ? :)
 188  */
 189 void MSG_process_kill(msg_process_t process)
 190 {
 191 //  /* FIXME: why do we only cancel communication actions? is this useful? */
 192 //  simdata_process_t p_simdata = simcall_process_get_data(process);
 193 //  if (p_simdata->waiting_task && p_simdata->waiting_task->simdata->comm) {
 194 //    simcall_comm_cancel(p_simdata->waiting_task->simdata->comm);
 195 //  }
 196
 197   simcall_process_kill(process);
 198
 199   return;
 200 }
 201
 202 /**
 203 * \brief Wait for the completion of a #msg_process_t.
 204 *
 205 * \param process the process to wait for
 206 * \param timeout wait until the process is over, or the timeout occurs
 207 */
 208 msg_error_t MSG_process_join(msg_process_t process, double timeout){
 209   simcall_process_join(process, timeout);
 210   return MSG_OK;
 211 }
 212
 213 /** \ingroup m_process_management
 214  * \brief Migrates a process to another location.
 215  *
 216  * This function checks whether \a process and \a host are valid pointers
 217    and change the value of the #msg_host_t on which \a process is running.
 218  */
 219 msg_error_t MSG_process_migrate(msg_process_t process, msg_host_t host)
 220 {
 221   simdata_process_t simdata = (simdata_process_t) simcall_process_get_data(process);
 222   simdata->m_host = host;
 223   msg_host_t now = simdata->m_host;
 224   TRACE_msg_process_change_host(process, now, host);
 225   simcall_process_set_host(process, host);
 226   return MSG_OK;
 227 }
 228
 229 /** \ingroup m_process_management
 230  * \brief Returns the user data of a process.
 231  *
 232  * This function checks whether \a process is a valid pointer or not
 233    and returns the user data associated to this process.
 234  */
 235 void* MSG_process_get_data(msg_process_t process)
 236 {
 237   xbt_assert(process != NULL, "Invalid parameter: first parameter must not be NULL!");
 238
 239   /* get from SIMIX the MSG process data, and then the user data */
 240   simdata_process_t simdata = (simdata_process_t) simcall_process_get_data(process);
 241   if (simdata)
 242     return simdata->data;
 243   else
 244     return NULL;
 245 }
 246
 247 /** \ingroup m_process_management
 248  * \brief Sets the user data of a process.
 249  *
 250  * This function checks whether \a process is a valid pointer or not
 251    and sets the user data associated to this process.
 252  */
 253 msg_error_t MSG_process_set_data(msg_process_t process, void *data)
 254 {
 255   xbt_assert(process != NULL, "Invalid parameter: first parameter must not be NULL!");
 256
 257   simdata_process_t simdata =
 258     (simdata_process_t) simcall_process_get_data(process);
 259   simdata->data = data;
 260
 261   return MSG_OK;
 262 }
 263
 264 /** \ingroup m_process_management
 265  * \brief Sets a cleanup function to be called to free the userdata of a
 266  * process when a process is destroyed.
 267  * \param data_cleanup a cleanup function for the userdata of a process,
 268  * or NULL to call no function
 269  */
 270 XBT_PUBLIC(void) MSG_process_set_data_cleanup(void_f_pvoid_t data_cleanup) {
 271
 272   msg_global->process_data_cleanup = data_cleanup;
 273 }
 274
 275 /** \ingroup m_process_management
 276  * \brief Return the location on which a process is running.
 277  * \param process a process (NULL means the current one)
 278  * \return the msg_host_t corresponding to the location on which \a
 279  * process is running.
 280  */
 281 msg_host_t MSG_process_get_host(msg_process_t process)
 282 {
 283   simdata_process_t simdata;
 284   if (process == NULL) {
 285     simdata = (simdata_process_t) SIMIX_process_self_get_data(SIMIX_process_self());
 286   }
 287   else {
 288     simdata = (simdata_process_t) simcall_process_get_data(process);
 289   }
 290   return simdata ? simdata->m_host : NULL;
 291 }
 292
 293 /** \ingroup m_process_management
 294  *
 295  * \brief Return a #msg_process_t given its PID.
 296  *
 297  * This function search in the list of all the created msg_process_t for a msg_process_t
 298    whose PID is equal to \a PID. If no host is found, \c NULL is returned.
 299    Note that the PID are uniq in the whole simulation, not only on a given host.
 300  */
 301 msg_process_t MSG_process_from_PID(int PID)
 302 {
 303   return SIMIX_process_from_PID(PID);
 304 }
 305
 306 /** @brief returns a list of all currently existing processes */
 307 xbt_dynar_t MSG_processes_as_dynar(void) {
 308   return SIMIX_processes_as_dynar();
 309 }
 310 /** @brief Return the current number MSG processes.
 311  */
 312 int MSG_process_get_number(void)
 313 {
 314   return SIMIX_process_count();
 315 }
 316
 317 /** \ingroup m_process_management
 318  * \brief Set the kill time of a process.
 319  *
 320  * \param process a process
 321  * \param kill_time the time when the process is killed.
 322  */
 323 msg_error_t MSG_process_set_kill_time(msg_process_t process, double kill_time)
 324 {
 325   simcall_process_set_kill_time(process,kill_time);
 326   return MSG_OK;
 327 }
 328
 329 /** \ingroup m_process_management
 330  * \brief Returns the process ID of \a process.
 331  *
 332  * This function checks whether \a process is a valid pointer or not
 333    and return its PID (or 0 in case of problem).
 334  */
 335 int MSG_process_get_PID(msg_process_t process)
 336 {
 337   /* Do not raise an exception here: this function is called by the logs
 338    * and the exceptions, so it would be called back again and again */
 339   if (process == NULL) {
 340     return 0;
 341   }
 342   return simcall_process_get_PID(process);
 343 }
 344
 345 /** \ingroup m_process_management
 346  * \brief Returns the process ID of the parent of \a process.
 347  *
 348  * This function checks whether \a process is a valid pointer or not
 349    and return its PID. Returns -1 if the process has not been created by
 350    any other process.
 351  */
 352 int MSG_process_get_PPID(msg_process_t process)
 353 {
 354   xbt_assert(process != NULL, "Invalid parameter: First argument must not be NULL");
 355
 356   return simcall_process_get_PPID(process);
 357 }
 358
 359 /** \ingroup m_process_management
 360  * \brief Return the name of a process.
 361  *
 362  * This function checks whether \a process is a valid pointer or not
 363    and return its name.
 364  */
 365 const char *MSG_process_get_name(msg_process_t process)
 366 {
 367   xbt_assert(process != NULL, "Invalid parameter: First argument must not be NULL");
 368
 369   return simcall_process_get_name(process);
 370 }
 371
 372 /** \ingroup m_process_management
 373  * \brief Returns the value of a given process property
 374  *
 375  * \param process a process
 376  * \param name a property name
 377  * \return value of a property (or NULL if the property is not set)
 378  */
 379 const char *MSG_process_get_property_value(msg_process_t process,
 380                                            const char *name)
 381 {
 382   return (char*) xbt_dict_get_or_null(MSG_process_get_properties(process), name);
 383 }
 384
 385 /** \ingroup m_process_management
 386  * \brief Return the list of properties
 387  *
 388  * This function returns all the parameters associated with a process
 389  */
 390 xbt_dict_t MSG_process_get_properties(msg_process_t process)
 391 {
 392   xbt_assert(process != NULL, "Invalid parameter: First argument must not be NULL");
 393
 394   return simcall_process_get_properties(process);
 395
 396 }
 397
 398 /** \ingroup m_process_management
 399  * \brief Return the PID of the current process.
 400  *
 401  * This function returns the PID of the currently running #msg_process_t.
 402  */
 403 int MSG_process_self_PID(void)
 404 {
 405   return MSG_process_get_PID(MSG_process_self());
 406 }
 407
 408 /** \ingroup m_process_management
 409  * \brief Return the PPID of the current process.
 410  *
 411  * This function returns the PID of the parent of the currently
 412  * running #msg_process_t.
 413  */
 414 int MSG_process_self_PPID(void)
 415 {
 416   return MSG_process_get_PPID(MSG_process_self());
 417 }
 418
 419 /** \ingroup m_process_management
 420  * \brief Return the current process.
 421  *
 422  * This function returns the currently running #msg_process_t.
 423  */
 424 msg_process_t MSG_process_self(void)
 425 {
 426   return SIMIX_process_self();
 427 }
 428
 429 /** \ingroup m_process_management
 430  * \brief Suspend the process.
 431  *
 432  * This function suspends the process by suspending the task on which
 433  * it was waiting for the completion.
 434  */
 435 msg_error_t MSG_process_suspend(msg_process_t process)
 436 {
 437   xbt_assert(process != NULL, "Invalid parameter: First argument must not be NULL");
 438
 439   TRACE_msg_process_suspend(process);
 440   simcall_process_suspend(process);
 441   MSG_RETURN(MSG_OK);
 442 }
 443
 444 /** \ingroup m_process_management
 445  * \brief Resume a suspended process.
 446  *
 447  * This function resumes a suspended process by resuming the task on
 448  * which it was waiting for the completion.
 449  */
 450 msg_error_t MSG_process_resume(msg_process_t process)
 451 {
 452   xbt_assert(process != NULL, "Invalid parameter: First argument must not be NULL");
 453
 454   TRACE_msg_process_resume(process);
 455   simcall_process_resume(process);
 456   MSG_RETURN(MSG_OK);
 457 }
 458
 459 /** \ingroup m_process_management
 460  * \brief Returns true if the process is suspended .
 461  *
 462  * This checks whether a process is suspended or not by inspecting the
 463  * 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
 487  * its host comes back up.
 488  */
 489 XBT_PUBLIC(void) MSG_process_auto_restart_set(msg_process_t process, int auto_restart) {
 490   simcall_process_auto_restart_set(process,auto_restart);
 491 }
 492 /*
 493  * \ingroup m_process_management
 494  * \brief Restarts a process from the beginning.
 495  */
 496 XBT_PUBLIC(msg_process_t) MSG_process_restart(msg_process_t process) {
 497   return simcall_process_restart(process);
 498 }