src/simix/smx_process.c

   1 /*      $Id$     */
   2
   3 /* Copyright (c) 2002,2003,2004 Arnaud Legrand. All rights reserved.        */
   4
   5 /* This program is free software; you can redistribute it and/or modify it
   6  * under the terms of the license (GNU LGPL) which comes with this package. */
   7
   8 #include "private.h"
   9 #include "xbt/sysdep.h"
  10 #include "xbt/log.h"
  11 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(simix_process, simix,
  12                                 "Logging specific to SIMIX (process)");
  13 /** \defgroup m_process_management Management Functions of Agents
  14  *  \brief This section describes the agent structure of MSG
  15  *  (#m_process_t) and the functions for managing it.
  16  *    \htmlonly <!-- DOXYGEN_NAVBAR_LABEL="Agents" --> \endhtmlonly
  17  *
  18  *  We need to simulate many independent scheduling decisions, so
  19  *  the concept of <em>process</em> is at the heart of the
  20  *  simulator. A process may be defined as a <em>code</em>, with
  21  *  some <em>private data</em>, executing in a <em>location</em>.
  22  *  \see m_process_t
  23  */
  24
  25 /******************************** Process ************************************/
  26 /** \ingroup m_process_management
  27  * \brief Creates and runs a new #m_process_t.
  28  *
  29  * Does exactly the same as #MSG_process_create_with_arguments but without
  30    providing standard arguments (\a argc, \a argv, \a start_time, \a kill_time).
  31  * \sa MSG_process_create_with_arguments
  32  */
  33 smx_process_t SIMIX_process_create(const char *name,
  34                                smx_process_code_t code, void *data,
  35                                smx_host_t host)
  36 {
  37   return SIMIX_process_create_with_arguments(name, code, data, host, -1, NULL);
  38 }
  39
  40 static void SIMIX_process_cleanup(void *arg)
  41 {
  42   xbt_swag_remove(arg, simix_global->process_list);
  43   xbt_swag_remove(arg, simix_global->process_to_run);
  44   xbt_swag_remove(arg, ((smx_process_t) arg)->simdata->host->simdata->process_list);
  45   free(((smx_process_t) arg)->name);
  46   ((smx_process_t) arg)->name = NULL;
  47   free(((smx_process_t) arg)->simdata);
  48   ((smx_process_t) arg)->simdata = NULL;
  49   free(arg);
  50 }
  51
  52 /** \ingroup m_process_management
  53  * \brief Creates and runs a new #m_process_t.
  54
  55  * A constructor for #m_process_t taking four arguments and returning the
  56  * corresponding object. The structure (and the corresponding thread) is
  57  * created, and put in the list of ready process.
  58  * \param name a name for the object. It is for user-level information
  59    and can be NULL.
  60  * \param code is a function describing the behavior of the agent. It
  61    should then only use functions described in \ref
  62    m_process_management (to create a new #m_process_t for example),
  63    in \ref m_host_management (only the read-only functions i.e. whose
  64    name contains the word get), in \ref m_task_management (to create
  65    or destroy some #m_task_t for example) and in \ref
  66    msg_gos_functions (to handle file transfers and task processing).
  67  * \param data a pointer to any data one may want to attach to the new
  68    object.  It is for user-level information and can be NULL. It can
  69    be retrieved with the function \ref MSG_process_get_data.
  70  * \param host the location where the new agent is executed.
  71  * \param argc first argument passed to \a code
  72  * \param argv second argument passed to \a code
  73  * \see m_process_t
  74  * \return The new corresponding object.
  75  */
  76 smx_process_t SIMIX_process_create_with_arguments(const char *name,
  77                                               smx_process_code_t code, void *data,
  78                                               smx_host_t host, int argc, char **argv)
  79 {
  80   smx_simdata_process_t simdata = xbt_new0(s_smx_simdata_process_t,1);
  81   smx_process_t process = xbt_new0(s_smx_process_t,1);
  82   smx_process_t self = NULL;
  83
  84   xbt_assert0(((code != NULL) && (host != NULL)), "Invalid parameters");
  85   /* Simulator Data */
  86
  87   simdata->host = host;
  88   simdata->argc = argc;
  89   simdata->argv = argv;
  90   simdata->context = xbt_context_new(code, NULL, NULL,
  91                                      SIMIX_process_cleanup, process,
  92                                      simdata->argc, simdata->argv);
  93
  94   //simdata->last_errno=SIMIX_OK;
  95
  96
  97   /* Process structure */
  98   process->name = xbt_strdup(name);
  99   process->simdata = simdata;
 100   process->data = data;
 101
 102   xbt_swag_insert(process, host->simdata->process_list);
 103
 104   /* *************** FIX du current_process !!! *************** */
 105   self = simix_global->current_process;
 106   xbt_context_start(process->simdata->context);
 107   simix_global->current_process = self;
 108
 109   xbt_swag_insert(process,simix_global->process_list);
 110   DEBUG2("Inserting %s(%s) in the to_run list",process->name,
 111          host->name);
 112   xbt_swag_insert(process,simix_global->process_to_run);
 113
 114   return process;
 115 }
 116
 117 /** \ingroup m_process_management
 118  * \param process poor victim
 119  *
 120  * This function simply kills a \a process... scarry isn't it ? :)
 121  */
 122 void SIMIX_process_kill(smx_process_t process)
 123 {
 124   //int i;
 125   smx_simdata_process_t p_simdata = process->simdata;
 126   //simdata_host_t h_simdata= p_simdata->host->simdata;
 127   //int _cursor;
 128   //smx_process_t proc = NULL;
 129
 130   DEBUG2("Killing %s on %s",process->name, p_simdata->host->name);
 131
 132         if (p_simdata->mutex) {
 133                 xbt_swag_remove(process,p_simdata->mutex->sleeping);
 134         }
 135         if (p_simdata->cond) {
 136                 xbt_swag_remove(process,p_simdata->cond->sleeping);
 137         }
 138   /*
 139
 140   if(p_simdata->waiting_task) {
 141     xbt_dynar_foreach(p_simdata->waiting_task->simdata->sleeping,_cursor,proc) {
 142       if(proc==process)
 143         xbt_dynar_remove_at(p_simdata->waiting_task->simdata->sleeping,_cursor,&proc);
 144     }
 145     if(p_simdata->waiting_task->simdata->compute)
 146       surf_workstation_resource->common_public->
 147         action_free(p_simdata->waiting_task->simdata->compute);
 148     else if (p_simdata->waiting_task->simdata->comm) {
 149       surf_workstation_resource->common_public->
 150         action_change_state(p_simdata->waiting_task->simdata->comm,SURF_ACTION_FAILED);
 151       surf_workstation_resource->common_public->
 152         action_free(p_simdata->waiting_task->simdata->comm);
 153     } else {
 154       xbt_die("UNKNOWN STATUS. Please report this bug.");
 155     }
 156   }
 157
 158   if ((i==msg_global->max_channel) && (process!=MSG_process_self()) &&
 159       (!p_simdata->waiting_task)) {
 160     xbt_die("UNKNOWN STATUS. Please report this bug.");
 161   }
 162 */
 163   xbt_swag_remove(process,simix_global->process_to_run);
 164   xbt_swag_remove(process,simix_global->process_list);
 165   xbt_context_kill(process->simdata->context);
 166
 167   if(process==SIMIX_process_self()) {
 168     /* I just killed myself */
 169     xbt_context_yield();
 170   }
 171 }
 172
 173 /** \ingroup m_process_management
 174  * \brief Return the user data of a #m_process_t.
 175  *
 176  * This functions checks whether \a process is a valid pointer or not
 177    and return the user data associated to \a process if it is possible.
 178  */
 179 void *SIMIX_process_get_data(smx_process_t process)
 180 {
 181   xbt_assert0((process != NULL), "Invalid parameters");
 182
 183   return (process->data);
 184 }
 185
 186 /** \ingroup m_process_management
 187  * \brief Set the user data of a #m_process_t.
 188  *
 189  * This functions checks whether \a process is a valid pointer or not
 190    and set the user data associated to \a process if it is possible.
 191  */
 192 void SIMIX_process_set_data(smx_process_t process,void *data)
 193 {
 194   xbt_assert0((process != NULL), "Invalid parameters");
 195   xbt_assert0((process->data == NULL), "Data already set");
 196
 197   process->data = data;
 198
 199   return ;
 200 }
 201
 202 /** \ingroup m_process_management
 203  * \brief Return the location on which an agent is running.
 204  *
 205  * This functions checks whether \a process is a valid pointer or not
 206    and return the m_host_t corresponding to the location on which \a
 207    process is running.
 208  */
 209 smx_host_t SIMIX_process_get_host(smx_process_t process)
 210 {
 211   xbt_assert0(((process != NULL) && (process->simdata)), "Invalid parameters");
 212
 213   return (process->simdata->host);
 214 }
 215
 216 /** \ingroup m_process_management
 217  * \brief Return the name of an agent.
 218  *
 219  * This functions checks whether \a process is a valid pointer or not
 220    and return its name.
 221  */
 222 const char *SIMIX_process_get_name(smx_process_t process)
 223 {
 224   xbt_assert0(((process != NULL) && (process->simdata)), "Invalid parameters");
 225
 226   return (process->name);
 227 }
 228
 229 /** \ingroup m_process_management
 230  * \brief Return the current agent.
 231  *
 232  * This functions returns the currently running #m_process_t.
 233  */
 234 smx_process_t SIMIX_process_self(void)
 235 {
 236   return simix_global ? simix_global->current_process : NULL;
 237 }
 238
 239 /** \ingroup m_process_management
 240  * \brief Suspend the process.
 241  *
 242  * This functions suspend the process by suspending the task on which
 243  * it was waiting for the completion.
 244  */
 245 void SIMIX_process_suspend(smx_process_t process)
 246 {
 247   smx_simdata_process_t simdata = NULL;
 248
 249   xbt_assert0(((process) && (process->simdata)), "Invalid parameters");
 250
 251   if(process!=SIMIX_process_self()) {
 252     simdata = process->simdata;
 253
 254                 if (simdata->mutex) {
 255                         /* process blocked on a mutex, only set suspend=1 */
 256                         simdata->suspended = 1;
 257                 }
 258                 else if (simdata->cond){
 259                         /* process blocked cond, suspend all actions */
 260
 261                         /* temporaries variables */
 262                         smx_cond_t c;
 263                         xbt_fifo_item_t i;
 264                         smx_action_t act;
 265
 266                         simdata->suspended = 1;
 267                         c = simdata->cond;
 268                         xbt_fifo_foreach(c->actions,i,act, smx_action_t) {
 269                                 surf_workstation_resource->common_public->suspend(act->simdata->surf_action);
 270                         }
 271                 }
 272                 else {
 273                         simdata->suspended = 1;
 274                 }
 275   }
 276         else {
 277                 /* process executing, I can create an action and suspend it */
 278                 process->simdata->suspended = 1;
 279                 smx_action_t dummy;
 280                 smx_cond_t cond;
 281                 char name[] = "dummy";
 282
 283                 cond = SIMIX_cond_init();
 284                 dummy = SIMIX_action_execute(SIMIX_process_get_host(process), name, 0);
 285                 surf_workstation_resource->common_public->set_priority(dummy->simdata->surf_action,0.0);
 286                 SIMIX_register_condition_to_action(dummy,cond);
 287                 SIMIX_register_action_to_condition(dummy,cond);
 288                 __SIMIX_cond_wait(cond);
 289                 //SIMIX_action_destroy(dummy);
 290                 //SIMIX_cond_destroy(cond);
 291         }
 292   return ;
 293 }
 294
 295 /** \ingroup m_process_management
 296  * \brief Resume a suspended process.
 297  *
 298  * This functions resume a suspended process by resuming the task on
 299  * which it was waiting for the completion.
 300  */
 301 void SIMIX_process_resume(smx_process_t process)
 302 {
 303   smx_simdata_process_t simdata = NULL;
 304
 305   xbt_assert0(((process != NULL) && (process->simdata)), "Invalid parameters");
 306   CHECK_HOST();
 307
 308   if(process == SIMIX_process_self()) {
 309                 return;
 310   }
 311
 312   simdata = process->simdata;
 313   if(simdata->mutex) {
 314                 DEBUG0("Resume process blocked on a mutex");
 315     simdata->suspended = 0; /* He'll wake up by itself */
 316                 return;
 317   }
 318         else if (simdata->cond) {
 319                 DEBUG0("Resume process blocked on a conditional");
 320                 /* temporaries variables */
 321                 smx_cond_t c;
 322                 xbt_fifo_item_t i;
 323                 smx_action_t act;
 324                 simdata->suspended = 0;
 325                 c = simdata->cond;
 326                 xbt_fifo_foreach(c->actions,i,act, smx_action_t) {
 327                         surf_workstation_resource->common_public->resume(act->simdata->surf_action);
 328                 }
 329                 return;
 330         }
 331         else {
 332                 simdata->suspended = 0;
 333                 xbt_swag_insert(process,simix_global->process_to_run);
 334         }
 335
 336 }
 337
 338 /** \ingroup m_process_management
 339  * \brief Returns true if the process is suspended .
 340  *
 341  * This checks whether a process is suspended or not by inspecting the
 342  * task on which it was waiting for the completion.
 343  */
 344 int SIMIX_process_is_suspended(smx_process_t process)
 345 {
 346   xbt_assert0(((process != NULL) && (process->simdata)), "Invalid parameters");
 347
 348   return (process->simdata->suspended);
 349 }
 350
 351
 352