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