src/msg/m_process.c

   1 /*     $Id$      */
   2
   3 /* Copyright (c) 2002-2007 Arnaud Legrand.                                  */
   4 /* Copyright (c) 2007 Bruno Donassolo.                                      */
   5 /* All rights reserved.                                                     */
   6
   7 /* This program is free software; you can redistribute it and/or modify it
   8  * under the terms of the license (GNU LGPL) which comes with this package. */
   9
  10 #include "msg/private.h"
  11 #include "xbt/sysdep.h"
  12 #include "xbt/log.h"
  13 #include "../simix/private.h"
  14
  15 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(msg_process, msg,
  16                                 "Logging specific to MSG (process)");
  17
  18 /** \defgroup m_process_management Management Functions of Agents
  19  *  \brief This section describes the agent structure of MSG
  20  *  (#m_process_t) and the functions for managing it.
  21  */
  22 /** @addtogroup m_process_management
  23  *    \htmlonly <!-- DOXYGEN_NAVBAR_LABEL="Agents" --> \endhtmlonly
  24  *
  25  *  We need to simulate many independent scheduling decisions, so
  26  *  the concept of <em>process</em> is at the heart of the
  27  *  simulator. A process may be defined as a <em>code</em>, with
  28  *  some <em>private data</em>, executing in a <em>location</em>.
  29  *  \see m_process_t
  30  */
  31
  32 /******************************** Process ************************************/
  33 void __MSG_process_cleanup(void *arg)
  34 {
  35   /* arg is a pointer to a simix process, we can get the msg process with the field data */
  36   m_process_t proc = ((smx_process_t) arg)->data;
  37   xbt_fifo_remove(msg_global->process_list, proc);
  38   SIMIX_process_cleanup(arg);
  39   free(proc->name);
  40   proc->name = NULL;
  41   free(proc->simdata);
  42   proc->simdata = NULL;
  43   free(proc);
  44
  45   return;
  46 }
  47
  48 /* This function creates a MSG process. It has the prototype enforced by SIMIX_function_register_process_create */
  49 void *_MSG_process_create_from_SIMIX(const char *name,
  50                                      xbt_main_func_t code, void *data,
  51                                      char *hostname, int argc, char **argv,
  52                                      xbt_dict_t properties)
  53 {
  54   m_host_t host = MSG_get_host_by_name(hostname);
  55   return (void *) MSG_process_create_with_environment(name, code, data, host,
  56                                                       argc, argv, properties);
  57 }
  58
  59 /** \ingroup m_process_management
  60  * \brief Creates and runs a new #m_process_t.
  61  *
  62  * Does exactly the same as #MSG_process_create_with_arguments but without
  63    providing standard arguments (\a argc, \a argv, \a start_time, \a kill_time).
  64  * \sa MSG_process_create_with_arguments
  65  */
  66 m_process_t MSG_process_create(const char *name,
  67                                xbt_main_func_t code, void *data,
  68                                m_host_t host)
  69 {
  70   return MSG_process_create_with_environment(name, code, data, host, -1,
  71                                              NULL, NULL);
  72 }
  73
  74 /** \ingroup m_process_management
  75  * \brief Creates and runs a new #m_process_t.
  76
  77  * A constructor for #m_process_t taking four arguments and returning the
  78  * corresponding object. The structure (and the corresponding thread) is
  79  * created, and put in the list of ready process.
  80  * \param name a name for the object. It is for user-level information
  81    and can be NULL.
  82  * \param code is a function describing the behavior of the agent. It
  83    should then only use functions described in \ref
  84    m_process_management (to create a new #m_process_t for example),
  85    in \ref m_host_management (only the read-only functions i.e. whose
  86    name contains the word get), in \ref m_task_management (to create
  87    or destroy some #m_task_t for example) and in \ref
  88    msg_gos_functions (to handle file transfers and task processing).
  89  * \param data a pointer to any data one may want to attach to the new
  90    object.  It is for user-level information and can be NULL. It can
  91    be retrieved with the function \ref MSG_process_get_data.
  92  * \param host the location where the new agent is executed.
  93  * \param argc first argument passed to \a code
  94  * \param argv second argument passed to \a code
  95  * \see m_process_t
  96  * \return The new corresponding object.
  97  */
  98
  99 m_process_t MSG_process_create_with_arguments(const char *name,
 100                                               xbt_main_func_t code,
 101                                               void *data, m_host_t host,
 102                                               int argc, char **argv)
 103 {
 104   return MSG_process_create_with_environment(name, code, data, host,
 105                                              argc, argv, NULL);
 106 }
 107
 108 /** \ingroup m_process_management
 109  * \brief Creates and runs a new #m_process_t.
 110
 111  * A constructor for #m_process_t taking four arguments and returning the
 112  * corresponding object. The structure (and the corresponding thread) is
 113  * created, and put in the list of ready process.
 114  * \param name a name for the object. It is for user-level information
 115    and can be NULL.
 116  * \param code is a function describing the behavior of the agent. It
 117    should then only use functions described in \ref
 118    m_process_management (to create a new #m_process_t for example),
 119    in \ref m_host_management (only the read-only functions i.e. whose
 120    name contains the word get), in \ref m_task_management (to create
 121    or destroy some #m_task_t for example) and in \ref
 122    msg_gos_functions (to handle file transfers and task processing).
 123  * \param data a pointer to any data one may want to attach to the new
 124    object.  It is for user-level information and can be NULL. It can
 125    be retrieved with the function \ref MSG_process_get_data.
 126  * \param host the location where the new agent is executed.
 127  * \param argc first argument passed to \a code
 128  * \param argv second argument passed to \a code
 129  * \param properties list a properties defined for this process
 130  * \see m_process_t
 131  * \return The new corresponding object.
 132  */
 133 m_process_t MSG_process_create_with_environment(const char *name,
 134                                                 xbt_main_func_t code,
 135                                                 void *data, m_host_t host,
 136                                                 int argc, char **argv,
 137                                                 xbt_dict_t properties)
 138 {
 139   simdata_process_t simdata = xbt_new0(s_simdata_process_t, 1);
 140   m_process_t process = xbt_new0(s_m_process_t, 1);
 141   xbt_assert0(((code != NULL) && (host != NULL)), "Invalid parameters");
 142
 143   /* Simulator Data */
 144   simdata->PID = msg_global->PID++;
 145   simdata->waiting_task = NULL;
 146   simdata->m_host = host;
 147   simdata->argc = argc;
 148   simdata->argv = argv;
 149   simdata->s_process = SIMIX_process_create(name, code,
 150                                             (void *) process, host->name,
 151                                             argc, argv, properties);
 152
 153   if (SIMIX_process_self()) {
 154     simdata->PPID = MSG_process_get_PID(SIMIX_process_self()->data);
 155   } else {
 156     simdata->PPID = -1;
 157   }
 158   simdata->last_errno = MSG_OK;
 159
 160
 161   /* Process structure */
 162   process->name = xbt_strdup(name);
 163   process->simdata = simdata;
 164   process->data = data;
 165
 166   xbt_fifo_unshift(msg_global->process_list, process);
 167
 168   return process;
 169
 170 }
 171
 172 void _MSG_process_kill_from_SIMIX(void *p)
 173 {
 174   MSG_process_kill((m_process_t) p);
 175 }
 176
 177 /** \ingroup m_process_management
 178  * \param process poor victim
 179  *
 180  * This function simply kills a \a process... scarry isn't it ? :)
 181  */
 182 void MSG_process_kill(m_process_t process)
 183 {
 184   simdata_process_t p_simdata = process->simdata;
 185
 186   DEBUG3("Killing %s(%d) on %s",
 187          process->name, p_simdata->PID, p_simdata->m_host->name);
 188
 189   if (p_simdata->waiting_task) {
 190     DEBUG1("Canceling waiting task %s", p_simdata->waiting_task->name);
 191     if (p_simdata->waiting_task->simdata->compute) {
 192       SIMIX_action_cancel(p_simdata->waiting_task->simdata->compute);
 193     } else if (p_simdata->waiting_task->simdata->comm) {
 194       SIMIX_action_cancel(p_simdata->waiting_task->simdata->comm);
 195     }
 196   }
 197
 198   xbt_fifo_remove(msg_global->process_list, process);
 199   SIMIX_process_kill(process->simdata->s_process);
 200
 201   return;
 202 }
 203
 204 /** \ingroup m_process_management
 205  * \brief Migrates an agent to another location.
 206  *
 207  * This function checks whether \a process and \a host are valid pointers
 208    and change the value of the #m_host_t on which \a process is running.
 209  */
 210 MSG_error_t MSG_process_change_host(m_host_t host)
 211 {
 212   m_process_t process = MSG_process_self();
 213   m_host_t now = process->simdata->m_host;
 214   process->simdata->m_host = host;
 215   SIMIX_process_change_host(process->simdata->s_process, now->name,
 216                             host->name);
 217   return MSG_OK;
 218 }
 219
 220 /** \ingroup m_process_management
 221  * \brief Return the user data of a #m_process_t.
 222  *
 223  * This function checks whether \a process is a valid pointer or not
 224    and return the user data associated to \a process if it is possible.
 225  */
 226 void *MSG_process_get_data(m_process_t process)
 227 {
 228   xbt_assert0((process != NULL), "Invalid parameters");
 229
 230   return (process->data);
 231 }
 232
 233 /** \ingroup m_process_management
 234  * \brief Set the user data of a #m_process_t.
 235  *
 236  * This function checks whether \a process is a valid pointer or not
 237    and set the user data associated to \a process if it is possible.
 238  */
 239 MSG_error_t MSG_process_set_data(m_process_t process, void *data)
 240 {
 241   xbt_assert0((process != NULL), "Invalid parameters");
 242   xbt_assert0((process->data == NULL), "Data already set");
 243
 244   process->data = data;
 245
 246   return MSG_OK;
 247 }
 248
 249 /** \ingroup m_process_management
 250  * \brief Return the location on which an agent is running.
 251  *
 252  * This function checks whether \a process is a valid pointer or not
 253    and return the m_host_t corresponding to the location on which \a
 254    process is running.
 255  */
 256 m_host_t MSG_process_get_host(m_process_t process)
 257 {
 258   xbt_assert0(((process != NULL)
 259                && (process->simdata)), "Invalid parameters");
 260
 261   return (((simdata_process_t) process->simdata)->m_host);
 262 }
 263
 264 /** \ingroup m_process_management
 265  *
 266  * \brief Return a #m_process_t given its PID.
 267  *
 268  * This function search in the list of all the created m_process_t for a m_process_t
 269    whose PID is equal to \a PID. If no host is found, \c NULL is returned.
 270    Note that the PID are uniq in the whole simulation, not only on a given host.
 271  */
 272 m_process_t MSG_process_from_PID(int PID)
 273 {
 274   xbt_fifo_item_t i = NULL;
 275   m_process_t process = NULL;
 276
 277   xbt_fifo_foreach(msg_global->process_list, i, process, m_process_t) {
 278     if (MSG_process_get_PID(process) == PID)
 279       return process;
 280   }
 281   return NULL;
 282 }
 283
 284 /** \ingroup m_process_management
 285  * \brief Returns the process ID of \a process.
 286  *
 287  * This function checks whether \a process is a valid pointer or not
 288    and return its PID (or 0 in case of problem).
 289  */
 290 int MSG_process_get_PID(m_process_t process)
 291 {
 292   /* Do not raise an exception here: this function is used in the logs,
 293      and it will be called back by the exception handling stuff */
 294   if (process == NULL || process->simdata == NULL)
 295     return 0;
 296
 297   return (((simdata_process_t) process->simdata)->PID);
 298 }
 299
 300 /** \ingroup m_process_management
 301  * \brief Returns the process ID of the parent of \a process.
 302  *
 303  * This function checks whether \a process is a valid pointer or not
 304    and return its PID. Returns -1 if the agent has not been created by
 305    another agent.
 306  */
 307 int MSG_process_get_PPID(m_process_t process)
 308 {
 309   xbt_assert0(((process != NULL)
 310                && (process->simdata)), "Invalid parameters");
 311
 312   return (((simdata_process_t) process->simdata)->PPID);
 313 }
 314
 315 /** \ingroup m_process_management
 316  * \brief Return the name of an agent.
 317  *
 318  * This function checks whether \a process is a valid pointer or not
 319    and return its name.
 320  */
 321 const char *MSG_process_get_name(m_process_t process)
 322 {
 323   xbt_assert0(process, "Invalid parameter: process is NULL");
 324   xbt_assert0(process->simdata,
 325               "Invalid parameter: process->simdata is NULL");
 326
 327   return (process->name);
 328 }
 329
 330 /** \ingroup m_process_management
 331  * \brief Returns the value of a given process property
 332  *
 333  * \param process a process
 334  * \param name a property name
 335  * \return value of a property (or NULL if the property is not set)
 336  */
 337 const char *MSG_process_get_property_value(m_process_t process,
 338                                            const char *name)
 339 {
 340   return xbt_dict_get_or_null(MSG_process_get_properties(process), name);
 341 }
 342
 343 /** \ingroup m_process_management
 344  * \brief Return the list of properties
 345  *
 346  * This function returns all the parameters associated with a process
 347  */
 348 xbt_dict_t MSG_process_get_properties(m_process_t process)
 349 {
 350   xbt_assert0((process != NULL), "Invalid parameters");
 351
 352   return (SIMIX_process_get_properties
 353           (((simdata_process_t) process->simdata)->s_process));
 354
 355 }
 356
 357 /** \ingroup m_process_management
 358  * \brief Return the PID of the current agent.
 359  *
 360  * This function returns the PID of the currently running #m_process_t.
 361  */
 362 int MSG_process_self_PID(void)
 363 {
 364   return (MSG_process_get_PID(MSG_process_self()));
 365 }
 366
 367 /** \ingroup m_process_management
 368  * \brief Return the PPID of the current agent.
 369  *
 370  * This function returns the PID of the parent of the currently
 371  * running #m_process_t.
 372  */
 373 int MSG_process_self_PPID(void)
 374 {
 375   return (MSG_process_get_PPID(MSG_process_self()));
 376 }
 377
 378 /** \ingroup m_process_management
 379  * \brief Return the current agent.
 380  *
 381  * This function returns the currently running #m_process_t.
 382  */
 383 m_process_t MSG_process_self(void)
 384 {
 385   smx_process_t proc = SIMIX_process_self();
 386   if (proc != NULL) {
 387     return (m_process_t) proc->data;
 388   } else {
 389     return NULL;
 390   }
 391
 392 }
 393
 394 /** \ingroup m_process_management
 395  * \brief Suspend the process.
 396  *
 397  * This function suspends the process by suspending the task on which
 398  * it was waiting for the completion.
 399  */
 400 MSG_error_t MSG_process_suspend(m_process_t process)
 401 {
 402   xbt_assert0(((process != NULL)
 403                && (process->simdata)), "Invalid parameters");
 404   CHECK_HOST();
 405
 406   SIMIX_process_suspend(process->simdata->s_process);
 407   MSG_RETURN(MSG_OK);
 408 }
 409
 410 /** \ingroup m_process_management
 411  * \brief Resume a suspended process.
 412  *
 413  * This function resumes a suspended process by resuming the task on
 414  * which it was waiting for the completion.
 415  */
 416 MSG_error_t MSG_process_resume(m_process_t process)
 417 {
 418
 419   xbt_assert0(((process != NULL)
 420                && (process->simdata)), "Invalid parameters");
 421   CHECK_HOST();
 422
 423   SIMIX_process_resume(process->simdata->s_process);
 424   MSG_RETURN(MSG_OK);
 425 }
 426
 427 /** \ingroup m_process_management
 428  * \brief Returns true if the process is suspended .
 429  *
 430  * This checks whether a process is suspended or not by inspecting the
 431  * task on which it was waiting for the completion.
 432  */
 433 int MSG_process_is_suspended(m_process_t process)
 434 {
 435   xbt_assert0(((process != NULL)
 436                && (process->simdata)), "Invalid parameters");
 437   return SIMIX_process_is_suspended(process->simdata->s_process);
 438 }