src/msg/msg_process.c

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