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