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   simdata_process_t simdata = xbt_new0(s_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   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   /*
 133
 134   if(p_simdata->waiting_task) {
 135     xbt_dynar_foreach(p_simdata->waiting_task->simdata->sleeping,_cursor,proc) {
 136       if(proc==process)
 137         xbt_dynar_remove_at(p_simdata->waiting_task->simdata->sleeping,_cursor,&proc);
 138     }
 139     if(p_simdata->waiting_task->simdata->compute)
 140       surf_workstation_resource->common_public->
 141         action_free(p_simdata->waiting_task->simdata->compute);
 142     else if (p_simdata->waiting_task->simdata->comm) {
 143       surf_workstation_resource->common_public->
 144         action_change_state(p_simdata->waiting_task->simdata->comm,SURF_ACTION_FAILED);
 145       surf_workstation_resource->common_public->
 146         action_free(p_simdata->waiting_task->simdata->comm);
 147     } else {
 148       xbt_die("UNKNOWN STATUS. Please report this bug.");
 149     }
 150   }
 151
 152   if ((i==msg_global->max_channel) && (process!=MSG_process_self()) &&
 153       (!p_simdata->waiting_task)) {
 154     xbt_die("UNKNOWN STATUS. Please report this bug.");
 155   }
 156 */
 157   xbt_swag_remove(process,simix_global->process_to_run);
 158   xbt_swag_remove(process,simix_global->process_list);
 159   xbt_context_free(process->simdata->context);
 160
 161   if(process==SIMIX_process_self()) {
 162     /* I just killed myself */
 163     xbt_context_yield();
 164   }
 165 }
 166
 167 /** \ingroup m_process_management
 168  * \brief Migrates an agent to another location.
 169  *
 170  * This functions checks whether \a process and \a host are valid pointers
 171    and change the value of the #m_host_t on which \a process is running.
 172  */
 173 void SIMIX_process_change_host(smx_process_t process, smx_host_t host)
 174 {
 175   simdata_process_t simdata = NULL;
 176
 177   /* Sanity check */
 178
 179   xbt_assert0(((process) && (process->simdata)
 180           && (host)), "Invalid parameters");
 181   simdata = process->simdata;
 182
 183   xbt_swag_remove(process,simdata->host->simdata->process_list);
 184   simdata->host = host;
 185   xbt_swag_insert(process,host->simdata->process_list);
 186
 187   return ;
 188 }
 189
 190 /** \ingroup m_process_management
 191  * \brief Return the user data of a #m_process_t.
 192  *
 193  * This functions checks whether \a process is a valid pointer or not
 194    and return the user data associated to \a process if it is possible.
 195  */
 196 void *SIMIX_process_get_data(smx_process_t process)
 197 {
 198   xbt_assert0((process != NULL), "Invalid parameters");
 199
 200   return (process->data);
 201 }
 202
 203 /** \ingroup m_process_management
 204  * \brief Set the user data of a #m_process_t.
 205  *
 206  * This functions checks whether \a process is a valid pointer or not
 207    and set the user data associated to \a process if it is possible.
 208  */
 209 void SIMIX_process_set_data(smx_process_t process,void *data)
 210 {
 211   xbt_assert0((process != NULL), "Invalid parameters");
 212   xbt_assert0((process->data == NULL), "Data already set");
 213
 214   process->data = data;
 215
 216   return ;
 217 }
 218
 219 /** \ingroup m_process_management
 220  * \brief Return the location on which an agent is running.
 221  *
 222  * This functions checks whether \a process is a valid pointer or not
 223    and return the m_host_t corresponding to the location on which \a
 224    process is running.
 225  */
 226 smx_host_t SIMIX_process_get_host(smx_process_t process)
 227 {
 228   xbt_assert0(((process != NULL) && (process->simdata)), "Invalid parameters");
 229
 230   return (process->simdata->host);
 231 }
 232
 233 /** \ingroup m_process_management
 234  * \brief Return the name of an agent.
 235  *
 236  * This functions checks whether \a process is a valid pointer or not
 237    and return its name.
 238  */
 239 const char *SIMIX_process_get_name(smx_process_t process)
 240 {
 241   xbt_assert0(((process != NULL) && (process->simdata)), "Invalid parameters");
 242
 243   return (process->name);
 244 }
 245
 246 /** \ingroup m_process_management
 247  * \brief Return the current agent.
 248  *
 249  * This functions returns the currently running #m_process_t.
 250  */
 251 smx_process_t SIMIX_process_self(void)
 252 {
 253   return simix_global ? simix_global->current_process : NULL;
 254 }
 255
 256 /** \ingroup m_process_management
 257  * \brief Suspend the process.
 258  *
 259  * This functions suspend the process by suspending the task on which
 260  * it was waiting for the completion.
 261  */
 262 void SIMIX_process_suspend(smx_process_t process)
 263 {
 264   simdata_process_t simdata = NULL;
 265
 266   xbt_assert0(((process) && (process->simdata)), "Invalid parameters");
 267
 268   if(process!=SIMIX_process_self()) {
 269     simdata = process->simdata;
 270
 271                 if (simdata->mutex) {
 272                         /* process blocked on a mutex, only set suspend=1 */
 273                         simdata->suspended = 1;
 274                 }
 275                 else if (simdata->cond){
 276                         /* process blocked cond, suspend all actions */
 277
 278                         /* temporaries variables */
 279                         smx_cond_t c;
 280                         xbt_fifo_item_t i;
 281                         smx_action_t act;
 282
 283                         simdata->suspended = 1;
 284                         c = simdata->cond;
 285                         xbt_fifo_foreach(c->actions,i,act, smx_action_t) {
 286                                 surf_workstation_resource->common_public->suspend(act->simdata->surf_action);
 287                         }
 288                 }
 289                 else if (simdata->block_action) {
 290                         simdata->suspended = 1;
 291                 }
 292                 else xbt_assert0(0, "Unknown process status");
 293
 294   }
 295         else {
 296                 /* process executing, I can create an action and suspend it */
 297                 process->simdata->suspended = 1;
 298                 __SIMIX_process_block(-1);
 299                 process->simdata->suspended = 0;
 300
 301         }
 302   return ;
 303 }
 304
 305 /** \ingroup m_process_management
 306  * \brief Resume a suspended process.
 307  *
 308  * This functions resume a suspended process by resuming the task on
 309  * which it was waiting for the completion.
 310  */
 311 void SIMIX_process_resume(smx_process_t process)
 312 {
 313   simdata_process_t simdata = NULL;
 314
 315   xbt_assert0(((process != NULL) && (process->simdata)), "Invalid parameters");
 316   CHECK_HOST();
 317
 318   if(process == SIMIX_process_self()) {
 319                 return;
 320   }
 321
 322   simdata = process->simdata;
 323   if(simdata->mutex) {
 324                 DEBUG0("Resume process blocked on a mutex");
 325     simdata->suspended = 0; /* He'll wake up by itself */
 326                 return;
 327   }
 328         else if (simdata->cond) {
 329                 DEBUG0("Resume process blocked on a conditional");
 330                 /* temporaries variables */
 331                 smx_cond_t c;
 332                 xbt_fifo_item_t i;
 333                 smx_action_t act;
 334                 simdata->suspended = 0;
 335                 c = simdata->cond;
 336                 xbt_fifo_foreach(c->actions,i,act, smx_action_t) {
 337                         surf_workstation_resource->common_public->resume(act->simdata->surf_action);
 338                 }
 339                 return;
 340         }
 341         else if (simdata->block_action){
 342                 simdata->suspended = 0;
 343                 surf_workstation_resource->common_public->resume(simdata->block_action->simdata->surf_action);
 344                 return;
 345         }
 346         else xbt_assert0(0, "Unknown status");
 347
 348 }
 349
 350 /** \ingroup m_process_management
 351  * \brief Returns true if the process is suspended .
 352  *
 353  * This checks whether a process is suspended or not by inspecting the
 354  * task on which it was waiting for the completion.
 355  */
 356 int SIMIX_process_is_suspended(smx_process_t process)
 357 {
 358   xbt_assert0(((process != NULL) && (process->simdata)), "Invalid parameters");
 359
 360   return (process->simdata->suspended);
 361 }
 362
 363 int __SIMIX_process_block(double max_duration)
 364 {
 365
 366   smx_process_t process = SIMIX_process_self();
 367   smx_action_t dummy = NULL;
 368   char name[] = "dummy";
 369
 370   dummy = SIMIX_execute(SIMIX_process_get_host(process), name, 0);
 371         dummy->simdata->action_block=1;
 372
 373   /* process which will wake up when this system action finish */
 374         dummy->simdata->cond_process = process;
 375
 376   process->simdata->block_action = dummy;
 377
 378   process->simdata->blocked=1;
 379
 380   surf_workstation_resource->common_public->suspend(dummy->simdata->surf_action);
 381
 382   if(max_duration>=0) {
 383     surf_workstation_resource->common_public->set_max_duration(dummy->simdata->surf_action,
 384                                                                max_duration);
 385                 dummy->simdata->timeout_cond = process->simdata->cond;
 386         }
 387         __SIMIX_wait_for_action(process,dummy);
 388         SIMIX_action_destroy(dummy);
 389         process->simdata->blocked=0;
 390
 391   if(process->simdata->suspended) {
 392     DEBUG0("I've been suspended in the meantime");
 393     SIMIX_process_suspend(process);
 394     DEBUG0("I've been resumed, let's keep going");
 395   }
 396
 397   return 1;
 398 }
 399
 400 void __SIMIX_process_unblock(smx_process_t process)
 401 {
 402   simdata_process_t simdata = NULL;
 403   simdata_action_t simdata_action = NULL;
 404
 405   xbt_assert0(((process != NULL) && (process->simdata)), "Invalid parameters");
 406
 407   simdata = process->simdata;
 408
 409   if(!(simdata->block_action)) {
 410     xbt_assert0(0,"Process is not blocked !");
 411     return;
 412   }
 413
 414   simdata_action = simdata->block_action->simdata;
 415   xbt_assert0(simdata->blocked,"Process not blocked");
 416   surf_workstation_resource->common_public->resume(simdata_action->surf_action);
 417   return ;
 418
 419 /*
 420   simdata_process_t simdata = NULL;
 421   simdata_task_t simdata_task = NULL;
 422
 423   xbt_assert0(((process != NULL) && (process->simdata)), "Invalid parameters");
 424   CHECK_HOST();
 425
 426   XBT_IN2(": %s unblocking %s", SIMIX_process_self()->name,process->name);
 427
 428   simdata = process->simdata;
 429   if(!(simdata->waiting_task)) {
 430     xbt_assert0(0,"Process not waiting for anything else. Weird !");
 431     XBT_OUT;
 432     return SIMIX_WARNING;
 433   }
 434   simdata_task = simdata->waiting_task->simdata;
 435
 436   xbt_assert0(simdata->blocked,"Process not blocked");
 437
 438   surf_workstation_resource->common_public->resume(simdata_task->compute);
 439
 440   XBT_OUT;
 441 */
 442 }
 443
 444 int __SIMIX_process_isBlocked(smx_process_t process)
 445 {
 446   xbt_assert0(((process != NULL) && (process->simdata)), "Invalid parameters");
 447
 448   return (process->simdata->blocked);
 449 }