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