src/simix/smx_synchro.c

   1 /*      $Id$     */
   2
   3 /* Copyright (c) 2007 Arnaud Legrand, Bruno Donnassolo.
   4    All rights reserved.                                          */
   5
   6 /* This program is free software; you can redistribute it and/or modify it
   7  * under the terms of the license (GNU LGPL) which comes with this package. */
   8
   9 #include "private.h"
  10 #include "xbt/log.h"
  11
  12
  13 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(simix_synchro, simix,
  14                                 "Logging specific to SIMIX (synchronization)");
  15
  16
  17 /****************************** Synchronization *******************************/
  18
  19 /*********************************** Mutex ************************************/
  20
  21 /**
  22  * \brief Initialize a mutex.
  23  *
  24  * Allocs and creates the data for the mutex. It have to be called before the utilisation of the mutex.
  25  * \return A mutex
  26  */
  27 smx_mutex_t SIMIX_mutex_init()
  28 {
  29   smx_mutex_t m = xbt_new0(s_smx_mutex_t, 1);
  30   s_smx_process_t p;            /* useful to initialize sleeping swag */
  31   /* structures initialization */
  32   m->refcount = 0;
  33   m->sleeping = xbt_swag_new(xbt_swag_offset(p, synchro_hookup));
  34   return m;
  35 }
  36
  37 /**
  38  * \brief Locks a mutex.
  39  *
  40  * Tries to lock a mutex, if the mutex isn't used yet, the process can continue its execution, else it'll be blocked here. You have to call #SIMIX_mutex_unlock to free the mutex.
  41  * \param mutex The mutex
  42  */
  43 void SIMIX_mutex_lock(smx_mutex_t mutex)
  44 {
  45   smx_process_t self = SIMIX_process_self();
  46   xbt_assert0((mutex != NULL), "Invalid parameters");
  47
  48
  49   if (mutex->refcount) {
  50     /* somebody using the mutex, block */
  51     xbt_swag_insert(self, mutex->sleeping);
  52     self->mutex = mutex;
  53     /* wait for some process make the unlock and wake up me from mutex->sleeping */
  54     SIMIX_process_yield();
  55     self->mutex = NULL;
  56
  57     /* verify if the process was suspended */
  58     while (self->suspended) {
  59       SIMIX_process_yield();
  60     }
  61
  62     mutex->refcount = 1;
  63   } else {
  64     /* mutex free */
  65     mutex->refcount = 1;
  66   }
  67   return;
  68 }
  69
  70 /**
  71  * \brief Tries to lock a mutex.
  72  *
  73  * Tries to lock a mutex, return 1 if the mutex is free, 0 else. This function does not block the process if the mutex is used.
  74  * \param mutex The mutex
  75  * \return 1 - mutex free, 0 - mutex used
  76  */
  77 int SIMIX_mutex_trylock(smx_mutex_t mutex)
  78 {
  79   xbt_assert0((mutex != NULL), "Invalid parameters");
  80
  81   if (mutex->refcount)
  82     return 0;
  83   else {
  84     mutex->refcount = 1;
  85     return 1;
  86   }
  87 }
  88
  89 /**
  90  * \brief Unlocks a mutex.
  91  *
  92  * Unlocks the mutex and wakes up a process blocked on it. If there are no process sleeping, only sets the mutex as free.
  93  * \param mutex The mutex
  94  */
  95 void SIMIX_mutex_unlock(smx_mutex_t mutex)
  96 {
  97   smx_process_t p;              /*process to wake up */
  98
  99   xbt_assert0((mutex != NULL), "Invalid parameters");
 100
 101   if (xbt_swag_size(mutex->sleeping) > 0) {
 102     p = xbt_swag_extract(mutex->sleeping);
 103     mutex->refcount = 0;
 104     xbt_swag_insert(p, simix_global->process_to_run);
 105   } else {
 106     /* nobody to wake up */
 107     mutex->refcount = 0;
 108   }
 109   return;
 110 }
 111
 112 /**
 113  * \brief Destroys a mutex.
 114  *
 115  * Destroys and frees the mutex's memory.
 116  * \param mutex A mutex
 117  */
 118 void SIMIX_mutex_destroy(smx_mutex_t mutex)
 119 {
 120   if (mutex == NULL)
 121     return;
 122   else {
 123     xbt_swag_free(mutex->sleeping);
 124     xbt_free(mutex);
 125     return;
 126   }
 127 }
 128
 129 /******************************** Conditional *********************************/
 130
 131 /**
 132  * \brief Initialize a condition.
 133  *
 134  * Allocs and creates the data for the condition. It have to be called before the utilisation of the condition.
 135  * \return A condition
 136  */
 137 smx_cond_t SIMIX_cond_init()
 138 {
 139   smx_cond_t cond = xbt_new0(s_smx_cond_t, 1);
 140   s_smx_process_t p;
 141
 142   cond->sleeping = xbt_swag_new(xbt_swag_offset(p, synchro_hookup));
 143   cond->actions = xbt_fifo_new();
 144   cond->mutex = NULL;
 145   return cond;
 146 }
 147
 148 /**
 149  * \brief Signalizes a condition.
 150  *
 151  * Signalizes a condition and wakes up a sleeping process. If there are no process sleeping, no action is done.
 152  * \param cond A condition
 153  */
 154 void SIMIX_cond_signal(smx_cond_t cond)
 155 {
 156   smx_process_t proc = NULL;
 157   DEBUG1("Signal condition %p", cond);
 158   xbt_assert0((cond != NULL), "Invalid parameters");
 159
 160
 161   if (xbt_swag_size(cond->sleeping) >= 1) {
 162     proc = xbt_swag_extract(cond->sleeping);
 163     xbt_swag_insert(proc, simix_global->process_to_run);
 164   }
 165
 166   return;
 167 }
 168
 169 /**
 170  * \brief Waits on a condition.
 171  *
 172  * Blocks a process until the signal is called. This functions frees the mutex associated and locks it after its execution.
 173  * \param cond A condition
 174  * \param mutex A mutex
 175  */
 176 void SIMIX_cond_wait(smx_cond_t cond, smx_mutex_t mutex)
 177 {
 178   smx_action_t act_sleep;
 179
 180   DEBUG1("Wait condition %p", cond);
 181
 182   /* If there is a mutex unlock it */
 183   if(mutex != NULL){
 184     cond->mutex = mutex;
 185     SIMIX_mutex_unlock(mutex);
 186   }
 187
 188   /* Always create an action null in case there is a host failure */
 189   act_sleep = SIMIX_action_sleep(SIMIX_host_self(), -1);
 190   SIMIX_process_self()->waiting_action = act_sleep;
 191   SIMIX_register_action_to_condition(act_sleep, cond);
 192   __SIMIX_cond_wait(cond);
 193   SIMIX_process_self()->waiting_action = NULL;
 194   SIMIX_unregister_action_to_condition(act_sleep, cond);
 195   SIMIX_action_destroy(act_sleep);
 196
 197   /* get the mutex again if necessary */
 198   if(mutex != NULL)
 199     SIMIX_mutex_lock(cond->mutex);
 200
 201   return;
 202 }
 203
 204 xbt_fifo_t SIMIX_cond_get_actions(smx_cond_t cond)
 205 {
 206   xbt_assert0((cond != NULL), "Invalid parameters");
 207   return cond->actions;
 208 }
 209
 210 void __SIMIX_cond_wait(smx_cond_t cond)
 211 {
 212   smx_process_t self = SIMIX_process_self();
 213   xbt_assert0((cond != NULL), "Invalid parameters");
 214
 215   /* process status */
 216
 217   self->cond = cond;
 218   xbt_swag_insert(self, cond->sleeping);
 219   SIMIX_process_yield();
 220   self->cond = NULL;
 221   while (self->suspended) {
 222     SIMIX_process_yield();
 223   }
 224   return;
 225 }
 226
 227 /**
 228  * \brief Waits on a condition with timeout.
 229  *
 230  * Same behavior of #SIMIX_cond_wait, but waits a maximum time and throws an timeout_error if it happens.
 231  * \param cond A condition
 232  * \param mutex A mutex
 233  * \param max_duration Timeout time
 234  */
 235 void SIMIX_cond_wait_timeout(smx_cond_t cond, smx_mutex_t mutex,
 236                              double max_duration)
 237 {
 238   smx_action_t act_sleep;
 239
 240   DEBUG1("Timed wait condition %p", cond);
 241
 242   /* If there is a mutex unlock it */
 243   if(mutex != NULL){
 244     cond->mutex = mutex;
 245     SIMIX_mutex_unlock(mutex);
 246   }
 247
 248   if (max_duration >= 0) {
 249     act_sleep = SIMIX_action_sleep(SIMIX_host_self(), max_duration);
 250     SIMIX_register_action_to_condition(act_sleep, cond);
 251     SIMIX_process_self()->waiting_action = act_sleep;
 252     __SIMIX_cond_wait(cond);
 253     SIMIX_process_self()->waiting_action = NULL;
 254     SIMIX_unregister_action_to_condition(act_sleep, cond);
 255     if (SIMIX_action_get_state(act_sleep) == SURF_ACTION_DONE) {
 256       SIMIX_action_destroy(act_sleep);
 257       THROW1(timeout_error, 0, "Condition timeout after %f",max_duration);
 258     } else {
 259       SIMIX_action_destroy(act_sleep);
 260     }
 261
 262   } else
 263     __SIMIX_cond_wait(cond);
 264
 265   /* get the mutex again if necessary */
 266   if(mutex != NULL)
 267     SIMIX_mutex_lock(cond->mutex);
 268
 269   return;
 270 }
 271
 272 /**
 273  * \brief Broadcasts a condition.
 274  *
 275  * Signalizes a condition and wakes up ALL sleping process. If there are no process sleeping, no action is done.
 276  * \param cond A condition
 277  */
 278 void SIMIX_cond_broadcast(smx_cond_t cond)
 279 {
 280   smx_process_t proc = NULL;
 281   smx_process_t proc_next = NULL;
 282
 283   xbt_assert0((cond != NULL), "Invalid parameters");
 284
 285   DEBUG1("Broadcast condition %p", cond);
 286   xbt_swag_foreach_safe(proc, proc_next, cond->sleeping) {
 287     xbt_swag_remove(proc, cond->sleeping);
 288     xbt_swag_insert(proc, simix_global->process_to_run);
 289   }
 290
 291   return;
 292 }
 293
 294 /**
 295  * \brief Destroys a contidion.
 296  *
 297  * Destroys and frees the condition's memory.
 298  * \param cond A condition
 299  */
 300 void SIMIX_cond_destroy(smx_cond_t cond)
 301 {
 302   DEBUG1("Destroy condition %p", cond);
 303   if (cond == NULL)
 304     return;
 305   else {
 306     xbt_fifo_item_t item = NULL;
 307     smx_action_t action = NULL;
 308
 309     xbt_assert0(xbt_swag_size(cond->sleeping) == 0,
 310                 "Cannot destroy conditional since someone is still using it");
 311     xbt_swag_free(cond->sleeping);
 312
 313     DEBUG1("%d actions registered", xbt_fifo_size(cond->actions));
 314     __SIMIX_cond_display_actions(cond);
 315     xbt_fifo_foreach(cond->actions, item, action, smx_action_t) {
 316       SIMIX_unregister_action_to_condition(action, cond);
 317     }
 318     __SIMIX_cond_display_actions(cond);
 319
 320     xbt_fifo_free(cond->actions);
 321     xbt_free(cond);
 322     return;
 323   }
 324 }
 325
 326 void SIMIX_cond_display_info(smx_cond_t cond)
 327 {
 328   if (cond == NULL)
 329     return;
 330   else {
 331     smx_process_t process = NULL;
 332
 333     INFO0("Blocked process on this condition:");
 334     xbt_swag_foreach(process, cond->sleeping) {
 335       INFO2("\t %s running on host %s", process->name,
 336             process->smx_host->name);
 337     }
 338   }
 339 }