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