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 = NULL;
 140   m_process_t process = xbt_new0(s_m_process_t, 1);
 141   smx_process_t smx_process = NULL;
 142   xbt_assert0(((code != NULL) && (host != NULL)), "Invalid parameters");
 143
 144   smx_process = SIMIX_process_create(name, code,
 145                                      (void *) process, host->name,
 146                                      argc, argv, properties);
 147   if (!smx_process) {
 148     xbt_free(process);
 149     return NULL;
 150   }
 151
 152   simdata = xbt_new0(s_simdata_process_t, 1);
 153
 154   /* Simulator Data */
 155   simdata->PID = msg_global->PID++;
 156   simdata->waiting_action = NULL;
 157   simdata->m_host = host;
 158   simdata->argc = argc;
 159   simdata->argv = argv;
 160   simdata->s_process = smx_process;
 161
 162   if (SIMIX_process_self()) {
 163     simdata->PPID = MSG_process_get_PID(SIMIX_process_self()->data);
 164   } else {
 165     simdata->PPID = -1;
 166   }
 167   simdata->last_errno = MSG_OK;
 168
 169
 170   /* Process structure */
 171   process->name = xbt_strdup(name);
 172   process->simdata = simdata;
 173   process->data = data;
 174
 175   xbt_fifo_unshift(msg_global->process_list, process);
 176
 177   return process;
 178
 179 }
 180
 181 void _MSG_process_kill_from_SIMIX(void *p)
 182 {
 183   MSG_process_kill((m_process_t) p);
 184 }
 185
 186 /** \ingroup m_process_management
 187  * \param process poor victim
 188  *
 189  * This function simply kills a \a process... scarry isn't it ? :)
 190  */
 191 void MSG_process_kill(m_process_t process)
 192 {
 193   simdata_process_t p_simdata = process->simdata;
 194
 195   DEBUG3("Killing %s(%d) on %s",
 196          process->name, p_simdata->PID, p_simdata->m_host->name);
 197
 198   if (p_simdata->waiting_action) {
 199     DEBUG1("Canceling waiting task %s",
 200            SIMIX_action_get_name(p_simdata->waiting_action));
 201     SIMIX_action_cancel(p_simdata->waiting_action);
 202   }
 203
 204   xbt_fifo_remove(msg_global->process_list, process);
 205   SIMIX_process_kill(process->simdata->s_process);
 206
 207   return;
 208 }
 209
 210 /** \ingroup m_process_management
 211  * \brief Migrates an agent to another location.
 212  *
 213  * This function checks whether \a process and \a host are valid pointers
 214    and change the value of the #m_host_t on which \a process is running.
 215  */
 216 MSG_error_t MSG_process_change_host(m_host_t host)
 217 {
 218   m_process_t process = MSG_process_self();
 219   m_host_t now = process->simdata->m_host;
 220   process->simdata->m_host = host;
 221   SIMIX_process_change_host(process->simdata->s_process, now->name,
 222                             host->name);
 223   return MSG_OK;
 224 }
 225
 226 /** \ingroup m_process_management
 227  * \brief Return the user data of a #m_process_t.
 228  *
 229  * This function checks whether \a process is a valid pointer or not
 230    and return the user data associated to \a process if it is possible.
 231  */
 232 void *MSG_process_get_data(m_process_t process)
 233 {
 234   xbt_assert0((process != NULL), "Invalid parameters");
 235
 236   return (process->data);
 237 }
 238
 239 /** \ingroup m_process_management
 240  * \brief Set the user data of a #m_process_t.
 241  *
 242  * This function checks whether \a process is a valid pointer or not
 243    and set the user data associated to \a process if it is possible.
 244  */
 245 MSG_error_t MSG_process_set_data(m_process_t process, void *data)
 246 {
 247   xbt_assert0((process != NULL), "Invalid parameters");
 248   xbt_assert0((process->data == NULL), "Data already set");
 249
 250   process->data = data;
 251
 252   return MSG_OK;
 253 }
 254
 255 /** \ingroup m_process_management
 256  * \brief Return the location on which an agent is running.
 257  *
 258  * This function checks whether \a process is a valid pointer or not
 259    and return the m_host_t corresponding to the location on which \a
 260    process is running.
 261  */
 262 m_host_t MSG_process_get_host(m_process_t process)
 263 {
 264   xbt_assert0(((process != NULL)
 265                && (process->simdata)), "Invalid parameters");
 266
 267   return (((simdata_process_t) process->simdata)->m_host);
 268 }
 269
 270 /** \ingroup m_process_management
 271  *
 272  * \brief Return a #m_process_t given its PID.
 273  *
 274  * This function search in the list of all the created m_process_t for a m_process_t
 275    whose PID is equal to \a PID. If no host is found, \c NULL is returned.
 276    Note that the PID are uniq in the whole simulation, not only on a given host.
 277  */
 278 m_process_t MSG_process_from_PID(int PID)
 279 {
 280   xbt_fifo_item_t i = NULL;
 281   m_process_t process = NULL;
 282
 283   xbt_fifo_foreach(msg_global->process_list, i, process, m_process_t) {
 284     if (MSG_process_get_PID(process) == PID)
 285       return process;
 286   }
 287   return NULL;
 288 }
 289
 290 /** \ingroup m_process_management
 291  * \brief Returns the process ID of \a process.
 292  *
 293  * This function checks whether \a process is a valid pointer or not
 294    and return its PID (or 0 in case of problem).
 295  */
 296 int MSG_process_get_PID(m_process_t process)
 297 {
 298   /* Do not raise an exception here: this function is used in the logs,
 299      and it will be called back by the exception handling stuff */
 300   if (process == NULL || process->simdata == NULL)
 301     return 0;
 302
 303   return (((simdata_process_t) process->simdata)->PID);
 304 }
 305
 306 /** \ingroup m_process_management
 307  * \brief Returns the process ID of the parent of \a process.
 308  *
 309  * This function checks whether \a process is a valid pointer or not
 310    and return its PID. Returns -1 if the agent has not been created by
 311    another agent.
 312  */
 313 int MSG_process_get_PPID(m_process_t process)
 314 {
 315   xbt_assert0(((process != NULL)
 316                && (process->simdata)), "Invalid parameters");
 317
 318   return (((simdata_process_t) process->simdata)->PPID);
 319 }
 320
 321 /** \ingroup m_process_management
 322  * \brief Return the name of an agent.
 323  *
 324  * This function checks whether \a process is a valid pointer or not
 325    and return its name.
 326  */
 327 const char *MSG_process_get_name(m_process_t process)
 328 {
 329   xbt_assert0(process, "Invalid parameter: process is NULL");
 330   xbt_assert0(process->simdata,
 331               "Invalid parameter: process->simdata is NULL");
 332
 333   return (process->name);
 334 }
 335
 336 /** \ingroup m_process_management
 337  * \brief Returns the value of a given process property
 338  *
 339  * \param process a process
 340  * \param name a property name
 341  * \return value of a property (or NULL if the property is not set)
 342  */
 343 const char *MSG_process_get_property_value(m_process_t process,
 344                                            const char *name)
 345 {
 346   return xbt_dict_get_or_null(MSG_process_get_properties(process), name);
 347 }
 348
 349 /** \ingroup m_process_management
 350  * \brief Return the list of properties
 351  *
 352  * This function returns all the parameters associated with a process
 353  */
 354 xbt_dict_t MSG_process_get_properties(m_process_t process)
 355 {
 356   xbt_assert0((process != NULL), "Invalid parameters");
 357
 358   return (SIMIX_process_get_properties
 359           (((simdata_process_t) process->simdata)->s_process));
 360
 361 }
 362
 363 /** \ingroup m_process_management
 364  * \brief Return the PID of the current agent.
 365  *
 366  * This function returns the PID of the currently running #m_process_t.
 367  */
 368 int MSG_process_self_PID(void)
 369 {
 370   return (MSG_process_get_PID(MSG_process_self()));
 371 }
 372
 373 /** \ingroup m_process_management
 374  * \brief Return the PPID of the current agent.
 375  *
 376  * This function returns the PID of the parent of the currently
 377  * running #m_process_t.
 378  */
 379 int MSG_process_self_PPID(void)
 380 {
 381   return (MSG_process_get_PPID(MSG_process_self()));
 382 }
 383
 384 /** \ingroup m_process_management
 385  * \brief Return the current agent.
 386  *
 387  * This function returns the currently running #m_process_t.
 388  */
 389 m_process_t MSG_process_self(void)
 390 {
 391   smx_process_t proc = SIMIX_process_self();
 392   if (proc != NULL) {
 393     return (m_process_t) proc->data;
 394   } else {
 395     return NULL;
 396   }
 397
 398 }
 399
 400 /** \ingroup m_process_management
 401  * \brief Suspend the process.
 402  *
 403  * This function suspends the process by suspending the task on which
 404  * it was waiting for the completion.
 405  */
 406 MSG_error_t MSG_process_suspend(m_process_t process)
 407 {
 408   xbt_assert0(((process != NULL)
 409                && (process->simdata)), "Invalid parameters");
 410   CHECK_HOST();
 411
 412   SIMIX_process_suspend(process->simdata->s_process);
 413   MSG_RETURN(MSG_OK);
 414 }
 415
 416 /** \ingroup m_process_management
 417  * \brief Resume a suspended process.
 418  *
 419  * This function resumes a suspended process by resuming the task on
 420  * which it was waiting for the completion.
 421  */
 422 MSG_error_t MSG_process_resume(m_process_t process)
 423 {
 424
 425   xbt_assert0(((process != NULL)
 426                && (process->simdata)), "Invalid parameters");
 427   CHECK_HOST();
 428
 429   SIMIX_process_resume(process->simdata->s_process);
 430   MSG_RETURN(MSG_OK);
 431 }
 432
 433 /** \ingroup m_process_management
 434  * \brief Returns true if the process is suspended .
 435  *
 436  * This checks whether a process is suspended or not by inspecting the
 437  * task on which it was waiting for the completion.
 438  */
 439 int MSG_process_is_suspended(m_process_t process)
 440 {
 441   xbt_assert0(((process != NULL)
 442                && (process->simdata)), "Invalid parameters");
 443   return SIMIX_process_is_suspended(process->simdata->s_process);
 444 }