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