src/msg/msg_process.c

   1 /* Copyright (c) 2004, 2005, 2006, 2007, 2008, 2009, 2010. 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
  11 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(msg_process, msg,
  12                                 "Logging specific to MSG (process)");
  13
  14 /** @addtogroup m_process_management
  15  *    \htmlonly <!-- DOXYGEN_NAVBAR_LABEL="Processes" --> \endhtmlonly
  16  *
  17  *  We need to simulate many independent scheduling decisions, so
  18  *  the concept of <em>process</em> is at the heart of the
  19  *  simulator. A process may be defined as a <em>code</em>, with
  20  *  some <em>private data</em>, executing in a <em>location</em>.
  21  *  \see msg_process_t
  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 = SIMIX_process_self_get_data(smx_proc);
  38     SIMIX_process_self_set_data(smx_proc, NULL);
  39   }
  40   else {
  41     msg_proc = simcall_process_get_data(smx_proc);
  42     simcall_process_set_data(smx_proc, NULL);
  43   }
  44
  45 #ifdef HAVE_TRACING
  46   TRACE_msg_process_end(smx_proc);
  47 #endif
  48   // free the data if a function was provided
  49   if (msg_proc->data && msg_global->process_data_cleanup) {
  50     msg_global->process_data_cleanup(msg_proc->data);
  51   }
  52
  53   // free the MSG process
  54   xbt_free(msg_proc);
  55 }
  56
  57 /* This function creates a MSG process. It has the prototype enforced by SIMIX_function_register_process_create */
  58 void MSG_process_create_from_SIMIX(smx_process_t* process, const char *name,
  59                                     xbt_main_func_t code, void *data,
  60                                     const char *hostname, double kill_time, int argc, char **argv,
  61                                     xbt_dict_t properties, int auto_restart)
  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
 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");
 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->PID = msg_global->PID++;
 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   if (SIMIX_process_self()) {
 169     simdata->PPID = MSG_process_get_PID(MSG_process_self());
 170   } else {
 171     simdata->PPID = -1;
 172   }
 173
 174 #ifdef HAVE_TRACING
 175   TRACE_msg_process_create(name, simdata->PID, simdata->m_host);
 176 #endif
 177   /* Let's create the process: SIMIX may decide to start it right now,
 178    * even before returning the flow control to us */
 179  simcall_process_create(&process, name, code, simdata, sg_host_name(host), -1,
 180                            argc, argv, properties,0);
 181
 182   if (!process) {
 183     /* Undo everything we have just changed */
 184     msg_global->PID--;
 185     xbt_free(simdata);
 186     return NULL;
 187   }
 188   else {
 189     #ifdef HAVE_TRACING
 190     simcall_process_on_exit(process,(int_f_pvoid_t)TRACE_msg_process_kill,MSG_process_self());
 191     #endif
 192   }
 193   return process;
 194 }
 195
 196 /** \ingroup m_process_management
 197  * \param process poor victim
 198  *
 199  * This function simply kills a \a process... scary isn't it ? :)
 200  */
 201 void MSG_process_kill(msg_process_t process)
 202 {
 203 //  /* FIXME: why do we only cancel communication actions? is this useful? */
 204 //  simdata_process_t p_simdata = simcall_process_get_data(process);
 205 //  if (p_simdata->waiting_task && p_simdata->waiting_task->simdata->comm) {
 206 //    simcall_comm_cancel(p_simdata->waiting_task->simdata->comm);
 207 //  }
 208
 209   simcall_process_kill(process);
 210
 211   return;
 212 }
 213
 214 /** \ingroup m_process_management
 215  * \brief Migrates a process to another location.
 216  *
 217  * This function checks whether \a process and \a host are valid pointers
 218    and change the value of the #msg_host_t on which \a process is running.
 219  */
 220 msg_error_t MSG_process_migrate(msg_process_t process, msg_host_t host)
 221 {
 222   simdata_process_t simdata = simcall_process_get_data(process);
 223   simdata->m_host = host;
 224 #ifdef HAVE_TRACING
 225   msg_host_t now = simdata->m_host;
 226   TRACE_msg_process_change_host(process, now, host);
 227 #endif
 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");
 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   return simdata->data;
 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");
 256
 257   simdata_process_t simdata = simcall_process_get_data(process);
 258   simdata->data = data;
 259
 260   return MSG_OK;
 261 }
 262
 263 /** \ingroup m_process_management
 264  * \brief Sets a cleanup function to be called to free the userdata of a
 265  * process when a process is destroyed.
 266  * \param data_cleanup a cleanup function for the userdata of a process,
 267  * or NULL to call no function
 268  */
 269 XBT_PUBLIC(void) MSG_process_set_data_cleanup(void_f_pvoid_t data_cleanup) {
 270
 271   msg_global->process_data_cleanup = data_cleanup;
 272 }
 273
 274 /** \ingroup m_process_management
 275  * \brief Return the location on which a process is running.
 276  * \param process a process (NULL means the current one)
 277  * \return the msg_host_t corresponding to the location on which \a
 278  * process is running.
 279  */
 280 msg_host_t MSG_process_get_host(msg_process_t process)
 281 {
 282   simdata_process_t simdata;
 283   if (process == NULL) {
 284     simdata = SIMIX_process_self_get_data(SIMIX_process_self());
 285   }
 286   else {
 287     simdata = simcall_process_get_data(process);
 288   }
 289   return simdata->m_host;
 290 }
 291
 292 /** \ingroup m_process_management
 293  *
 294  * \brief Return a #msg_process_t given its PID.
 295  *
 296  * This function search in the list of all the created msg_process_t for a msg_process_t
 297    whose PID is equal to \a PID. If no host is found, \c NULL is returned.
 298    Note that the PID are uniq in the whole simulation, not only on a given host.
 299  */
 300 msg_process_t MSG_process_from_PID(int PID)
 301 {
 302   return SIMIX_process_from_PID(PID);
 303 }
 304
 305 /** @brief returns a list of all currently existing processes */
 306 xbt_dynar_t MSG_processes_as_dynar(void) {
 307   return SIMIX_processes_as_dynar();
 308 }
 309 /** @brief Return the current number MSG processes.
 310  */
 311 int MSG_process_get_number(void)
 312 {
 313   return SIMIX_process_count();
 314 }
 315
 316 /** \ingroup m_process_management
 317  * \brief Set the kill time of a process.
 318  *
 319  * \param process a process
 320  * \param kill_time the time when the process is killed.
 321  */
 322 msg_error_t MSG_process_set_kill_time(msg_process_t process, double kill_time)
 323 {
 324   simcall_process_set_kill_time(process,kill_time);
 325   return MSG_OK;
 326 }
 327
 328 /** \ingroup m_process_management
 329  * \brief Returns the process ID of \a process.
 330  *
 331  * This function checks whether \a process is a valid pointer or not
 332    and return its PID (or 0 in case of problem).
 333  */
 334 int MSG_process_get_PID(msg_process_t process)
 335 {
 336   /* Do not raise an exception here: this function is called by the logs
 337    * and the exceptions, so it would be called back again and again */
 338   if (process == NULL) {
 339     return 0;
 340   }
 341
 342   simdata_process_t simdata = simcall_process_get_data(process);
 343
 344   return simdata != NULL ? simdata->PID : 0;
 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");
 357
 358   simdata_process_t simdata = simcall_process_get_data(process);
 359
 360   return simdata->PPID;
 361 }
 362
 363 /** \ingroup m_process_management
 364  * \brief Return the name of a process.
 365  *
 366  * This function checks whether \a process is a valid pointer or not
 367    and return its name.
 368  */
 369 const char *MSG_process_get_name(msg_process_t process)
 370 {
 371   xbt_assert(process, "Invalid parameter");
 372
 373   return simcall_process_get_name(process);
 374 }
 375
 376 /** \ingroup m_process_management
 377  * \brief Returns the value of a given process property
 378  *
 379  * \param process a process
 380  * \param name a property name
 381  * \return value of a property (or NULL if the property is not set)
 382  */
 383 const char *MSG_process_get_property_value(msg_process_t process,
 384                                            const char *name)
 385 {
 386   return xbt_dict_get_or_null(MSG_process_get_properties(process), name);
 387 }
 388
 389 /** \ingroup m_process_management
 390  * \brief Return the list of properties
 391  *
 392  * This function returns all the parameters associated with a process
 393  */
 394 xbt_dict_t MSG_process_get_properties(msg_process_t process)
 395 {
 396   xbt_assert(process != NULL, "Invalid parameter");
 397
 398   return simcall_process_get_properties(process);
 399
 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
 416  * running #msg_process_t.
 417  */
 418 int MSG_process_self_PPID(void)
 419 {
 420   return MSG_process_get_PPID(MSG_process_self());
 421 }
 422
 423 /** \ingroup m_process_management
 424  * \brief Return the current process.
 425  *
 426  * This function returns the currently running #msg_process_t.
 427  */
 428 msg_process_t MSG_process_self(void)
 429 {
 430   return SIMIX_process_self();
 431 }
 432
 433 /** \ingroup m_process_management
 434  * \brief Suspend the process.
 435  *
 436  * This function suspends the process by suspending the task on which
 437  * it was waiting for the completion.
 438  */
 439 msg_error_t MSG_process_suspend(msg_process_t process)
 440 {
 441   xbt_assert(process != NULL, "Invalid parameter");
 442
 443 #ifdef HAVE_TRACING
 444   TRACE_msg_process_suspend(process);
 445 #endif
 446
 447   simcall_process_suspend(process);
 448   MSG_RETURN(MSG_OK);
 449 }
 450
 451 /** \ingroup m_process_management
 452  * \brief Resume a suspended process.
 453  *
 454  * This function resumes a suspended process by resuming the task on
 455  * which it was waiting for the completion.
 456  */
 457 msg_error_t MSG_process_resume(msg_process_t process)
 458 {
 459   xbt_assert(process != NULL, "Invalid parameter");
 460
 461 #ifdef HAVE_TRACING
 462   TRACE_msg_process_resume(process);
 463 #endif
 464
 465   simcall_process_resume(process);
 466   MSG_RETURN(MSG_OK);
 467 }
 468
 469 /** \ingroup m_process_management
 470  * \brief Returns true if the process is suspended .
 471  *
 472  * This checks whether a process is suspended or not by inspecting the
 473  * task on which it was waiting for the completion.
 474  */
 475 int MSG_process_is_suspended(msg_process_t process)
 476 {
 477   xbt_assert(process != NULL, "Invalid parameter");
 478   return simcall_process_is_suspended(process);
 479 }
 480
 481 smx_context_t MSG_process_get_smx_ctx(msg_process_t process) {
 482   return SIMIX_process_get_context(process);
 483 }
 484 /**
 485  * \ingroup m_process_management
 486  * \brief Add a function to the list of "on_exit" functions for the current process.
 487  * The on_exit functions are the functions executed when your process is killed.
 488  * You should use them to free the data used by your process.
 489  */
 490 void MSG_process_on_exit(int_f_pvoid_t fun, void *data) {
 491   simcall_process_on_exit(MSG_process_self(),fun,data);
 492 }
 493 /**
 494  * \ingroup m_process_management
 495  * \brief Sets the "auto-restart" flag of the process.
 496  * If the flag is set to 1, the process will be automatically restarted when
 497  * its host comes back up.
 498  */
 499 XBT_PUBLIC(void) MSG_process_auto_restart_set(msg_process_t process, int auto_restart) {
 500   simcall_process_auto_restart_set(process,auto_restart);
 501 }
 502 /*
 503  * \ingroup m_process_management
 504  * \brief Restarts a process from the beginning.
 505  */
 506 XBT_PUBLIC(msg_process_t) MSG_process_restart(msg_process_t process) {
 507   return simcall_process_restart(process);
 508 }