src/simix/smx_synchro.cpp

   1
   2 /* Copyright (c) 2007-2015. The SimGrid Team.
   3  * 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 "src/surf/surf_interface.hpp"
   9 #include "smx_private.h"
  10 #include "xbt/log.h"
  11
  12 #include "src/simix/SynchroRaw.hpp"
  13
  14 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(simix_synchro, simix,
  15                                 "SIMIX Synchronization (mutex, semaphores and conditions)");
  16
  17 static smx_synchro_t SIMIX_synchro_wait(sg_host_t smx_host, double timeout);
  18 static void _SIMIX_cond_wait(smx_cond_t cond, smx_mutex_t mutex, double timeout,
  19                              smx_process_t issuer, smx_simcall_t simcall);
  20 static void _SIMIX_sem_wait(smx_sem_t sem, double timeout, smx_process_t issuer,
  21                             smx_simcall_t simcall);
  22
  23 /***************************** Raw synchronization *********************************/
  24
  25 static smx_synchro_t SIMIX_synchro_wait(sg_host_t smx_host, double timeout)
  26 {
  27   XBT_IN("(%p, %f)",smx_host,timeout);
  28
  29   simgrid::simix::Raw *sync = new simgrid::simix::Raw();
  30   sync->sleep = surf_host_sleep(smx_host, timeout);
  31   sync->sleep->setData(sync);
  32   XBT_OUT();
  33   return sync;
  34 }
  35
  36 void SIMIX_synchro_stop_waiting(smx_process_t process, smx_simcall_t simcall)
  37 {
  38   XBT_IN("(%p, %p)",process,simcall);
  39   switch (simcall->call) {
  40
  41     case SIMCALL_MUTEX_LOCK:
  42       xbt_swag_remove(process, simcall_mutex_lock__get__mutex(simcall)->sleeping);
  43       break;
  44
  45     case SIMCALL_COND_WAIT:
  46       xbt_swag_remove(process, simcall_cond_wait__get__cond(simcall)->sleeping);
  47       break;
  48
  49     case SIMCALL_COND_WAIT_TIMEOUT:
  50       xbt_swag_remove(process, simcall_cond_wait_timeout__get__cond(simcall)->sleeping);
  51       break;
  52
  53     case SIMCALL_SEM_ACQUIRE:
  54       xbt_swag_remove(process, simcall_sem_acquire__get__sem(simcall)->sleeping);
  55       break;
  56
  57     case SIMCALL_SEM_ACQUIRE_TIMEOUT:
  58       xbt_swag_remove(process, simcall_sem_acquire_timeout__get__sem(simcall)->sleeping);
  59       break;
  60
  61     default:
  62       THROW_IMPOSSIBLE;
  63   }
  64   XBT_OUT();
  65 }
  66
  67 void SIMIX_synchro_finish(smx_synchro_t synchro)
  68 {
  69   XBT_IN("(%p)",synchro);
  70   smx_simcall_t simcall = synchro->simcalls.front();
  71   synchro->simcalls.pop_front();
  72
  73   switch (synchro->state) {
  74
  75     case SIMIX_SRC_TIMEOUT:
  76       SMX_EXCEPTION(simcall->issuer, timeout_error, 0, "Synchro's wait timeout");
  77       break;
  78
  79     case SIMIX_FAILED:
  80         simcall->issuer->context->iwannadie = 1;
  81 //      SMX_EXCEPTION(simcall->issuer, host_error, 0, "Host failed");
  82       break;
  83
  84     default:
  85       THROW_IMPOSSIBLE;
  86       break;
  87   }
  88
  89   SIMIX_synchro_stop_waiting(simcall->issuer, simcall);
  90   simcall->issuer->waiting_synchro = nullptr;
  91   delete synchro;
  92   SIMIX_simcall_answer(simcall);
  93   XBT_OUT();
  94 }
  95 /*********************************** Mutex ************************************/
  96
  97 namespace simgrid {
  98 namespace simix {
  99
 100 Mutex::Mutex()
 101 {
 102   XBT_IN("(%p)", this);
 103   // Useful to initialize sleeping swag:
 104   simgrid::simix::Process p;
 105   this->sleeping = xbt_swag_new(xbt_swag_offset(p, synchro_hookup));
 106   XBT_OUT();
 107 }
 108
 109 Mutex::~Mutex()
 110 {
 111   XBT_IN("(%p)", this);
 112   xbt_swag_free(this->sleeping);
 113   XBT_OUT();
 114 }
 115
 116 void Mutex::lock(smx_process_t issuer)
 117 {
 118   XBT_IN("(%p; %p)", this, issuer);
 119   /* FIXME: check where to validate the arguments */
 120   smx_synchro_t synchro = nullptr;
 121
 122   if (this->locked) {
 123     /* FIXME: check if the host is active ? */
 124     /* Somebody using the mutex, use a synchronization to get host failures */
 125     synchro = SIMIX_synchro_wait(issuer->host, -1);
 126     synchro->simcalls.push_back(&issuer->simcall);
 127     issuer->waiting_synchro = synchro;
 128     xbt_swag_insert(issuer, this->sleeping);
 129   } else {
 130     /* mutex free */
 131     this->locked = true;
 132     this->owner = issuer;
 133     SIMIX_simcall_answer(&issuer->simcall);
 134   }
 135   XBT_OUT();
 136 }
 137
 138 /** Tries to lock the mutex for a process
 139  *
 140  * \param  issuer  the process that tries to acquire the mutex
 141  * \return whether we managed to lock the mutex
 142  */
 143 bool Mutex::try_lock(smx_process_t issuer)
 144 {
 145   XBT_IN("(%p, %p)", this, issuer);
 146   if (this->locked) {
 147     XBT_OUT();
 148     return false;
 149   }
 150
 151   this->locked = true;
 152   this->owner = issuer;
 153   XBT_OUT();
 154   return true;
 155 }
 156
 157 /** Unlock a mutex for a process
 158  *
 159  * Unlocks the mutex and gives it to a process waiting for it.
 160  * If the unlocker is not the owner of the mutex nothing happens.
 161  * If there are no process waiting, it sets the mutex as free.
 162  */
 163 void Mutex::unlock(smx_process_t issuer)
 164 {
 165   XBT_IN("(%p, %p)", this, issuer);
 166
 167   /* If the mutex is not owned by the issuer, that's not good */
 168   if (issuer != this->owner)
 169     THROWF(mismatch_error, 0, "Cannot release that mutex: it was locked by %s (pid:%d), not by you.",
 170         SIMIX_process_get_name(this->owner),SIMIX_process_get_PID(this->owner));
 171
 172   if (xbt_swag_size(this->sleeping) > 0) {
 173     /*process to wake up */
 174     smx_process_t p = (smx_process_t) xbt_swag_extract(this->sleeping);
 175     delete p->waiting_synchro;
 176     p->waiting_synchro = nullptr;
 177     this->owner = p;
 178     SIMIX_simcall_answer(&p->simcall);
 179   } else {
 180     /* nobody to wake up */
 181     this->locked = false;
 182     this->owner = nullptr;
 183   }
 184   XBT_OUT();
 185 }
 186
 187 }
 188 }
 189
 190 void SIMIX_mutex_destroy(smx_mutex_t mutex)
 191 {
 192   delete mutex;
 193 }
 194
 195 smx_mutex_t simcall_HANDLER_mutex_init(smx_simcall_t simcall)
 196 {
 197   return new simgrid::simix::Mutex();
 198 }
 199
 200 // Simcall handlers:
 201
 202 void simcall_HANDLER_mutex_lock(smx_simcall_t simcall, smx_mutex_t mutex)
 203 {
 204   mutex->lock(simcall->issuer);
 205 }
 206
 207 int simcall_HANDLER_mutex_trylock(smx_simcall_t simcall, smx_mutex_t mutex)
 208 {
 209   return mutex->try_lock(simcall->issuer);
 210 }
 211
 212 void simcall_HANDLER_mutex_unlock(smx_simcall_t simcall, smx_mutex_t mutex)
 213 {
 214   mutex->unlock(simcall->issuer);
 215 }
 216
 217 /********************************* Condition **********************************/
 218
 219 /**
 220  * \brief Initialize a condition.
 221  *
 222  * Allocates and creates the data for the condition.
 223  * It have to be called before the use of the condition.
 224  * \return A condition
 225  */
 226 smx_cond_t SIMIX_cond_init(void)
 227 {
 228   XBT_IN("()");
 229   simgrid::simix::Process p;
 230   smx_cond_t cond = xbt_new0(s_smx_cond_t, 1);
 231   cond->sleeping = xbt_swag_new(xbt_swag_offset(p, synchro_hookup));
 232   cond->mutex = nullptr;
 233   XBT_OUT();
 234   return cond;
 235 }
 236
 237 /**
 238  * \brief Handle a condition waiting simcall without timeouts
 239  * \param simcall the simcall
 240  */
 241 void simcall_HANDLER_cond_wait(smx_simcall_t simcall, smx_cond_t cond, smx_mutex_t mutex)
 242 {
 243   XBT_IN("(%p)",simcall);
 244   smx_process_t issuer = simcall->issuer;
 245
 246   _SIMIX_cond_wait(cond, mutex, -1, issuer, simcall);
 247   XBT_OUT();
 248 }
 249
 250 /**
 251  * \brief Handle a condition waiting simcall with timeouts
 252  * \param simcall the simcall
 253  */
 254 void simcall_HANDLER_cond_wait_timeout(smx_simcall_t simcall, smx_cond_t cond,
 255                      smx_mutex_t mutex, double timeout)
 256 {
 257   XBT_IN("(%p)",simcall);
 258   smx_process_t issuer = simcall->issuer;
 259
 260   _SIMIX_cond_wait(cond, mutex, timeout, issuer, simcall);
 261   XBT_OUT();
 262 }
 263
 264
 265 static void _SIMIX_cond_wait(smx_cond_t cond, smx_mutex_t mutex, double timeout,
 266                              smx_process_t issuer, smx_simcall_t simcall)
 267 {
 268   XBT_IN("(%p, %p, %f, %p,%p)",cond,mutex,timeout,issuer,simcall);
 269   smx_synchro_t synchro = nullptr;
 270
 271   XBT_DEBUG("Wait condition %p", cond);
 272
 273   /* If there is a mutex unlock it */
 274   /* FIXME: what happens if the issuer is not the owner of the mutex? */
 275   if (mutex != nullptr) {
 276     cond->mutex = mutex;
 277     mutex->unlock(issuer);
 278   }
 279
 280   synchro = SIMIX_synchro_wait(issuer->host, timeout);
 281   synchro->simcalls.push_front(simcall);
 282   issuer->waiting_synchro = synchro;
 283   xbt_swag_insert(simcall->issuer, cond->sleeping);
 284   XBT_OUT();
 285 }
 286
 287 /**
 288  * \brief Signalizes a condition.
 289  *
 290  * Signalizes a condition and wakes up a sleeping process.
 291  * If there are no process sleeping, no action is done.
 292  * \param cond A condition
 293  */
 294 void SIMIX_cond_signal(smx_cond_t cond)
 295 {
 296   XBT_IN("(%p)",cond);
 297   smx_process_t proc = nullptr;
 298   smx_mutex_t mutex = nullptr;
 299   smx_simcall_t simcall = nullptr;
 300
 301   XBT_DEBUG("Signal condition %p", cond);
 302
 303   /* If there are processes waiting for the condition choose one and try
 304      to make it acquire the mutex */
 305   if ((proc = (smx_process_t) xbt_swag_extract(cond->sleeping))) {
 306
 307     /* Destroy waiter's synchronization */
 308     delete proc->waiting_synchro;
 309     proc->waiting_synchro = nullptr;
 310
 311     /* Now transform the cond wait simcall into a mutex lock one */
 312     simcall = &proc->simcall;
 313     if(simcall->call == SIMCALL_COND_WAIT)
 314       mutex = simcall_cond_wait__get__mutex(simcall);
 315     else
 316       mutex = simcall_cond_wait_timeout__get__mutex(simcall);
 317     simcall->call = SIMCALL_MUTEX_LOCK;
 318
 319     simcall_HANDLER_mutex_lock(simcall, mutex);
 320   }
 321   XBT_OUT();
 322 }
 323
 324 /**
 325  * \brief Broadcasts a condition.
 326  *
 327  * Signal ALL processes waiting on a condition.
 328  * If there are no process waiting, no action is done.
 329  * \param cond A condition
 330  */
 331 void SIMIX_cond_broadcast(smx_cond_t cond)
 332 {
 333   XBT_IN("(%p)",cond);
 334   XBT_DEBUG("Broadcast condition %p", cond);
 335
 336   /* Signal the condition until nobody is waiting on it */
 337   while (xbt_swag_size(cond->sleeping)) {
 338     SIMIX_cond_signal(cond);
 339   }
 340   XBT_OUT();
 341 }
 342
 343 /**
 344  * \brief Destroys a condition.
 345  *
 346  * Destroys and frees the condition's memory.
 347  * \param cond A condition
 348  */
 349 void SIMIX_cond_destroy(smx_cond_t cond)
 350 {
 351   XBT_IN("(%p)",cond);
 352   XBT_DEBUG("Destroy condition %p", cond);
 353
 354   if (cond != nullptr) {
 355     xbt_assert(xbt_swag_size(cond->sleeping) == 0,
 356                 "Cannot destroy conditional since someone is still using it");
 357
 358     xbt_swag_free(cond->sleeping);
 359     xbt_free(cond);
 360   }
 361   XBT_OUT();
 362 }
 363
 364 /******************************** Semaphores **********************************/
 365 #define SMX_SEM_NOLIMIT 99999
 366 /** @brief Initialize a semaphore */
 367 smx_sem_t SIMIX_sem_init(unsigned int value)
 368 {
 369   XBT_IN("(%u)",value);
 370   simgrid::simix::Process p;
 371
 372   smx_sem_t sem = xbt_new0(s_smx_sem_t, 1);
 373   sem->sleeping = xbt_swag_new(xbt_swag_offset(p, synchro_hookup));
 374   sem->value = value;
 375   XBT_OUT();
 376   return sem;
 377 }
 378
 379 /** @brief Destroys a semaphore */
 380 void SIMIX_sem_destroy(smx_sem_t sem)
 381 {
 382   XBT_IN("(%p)",sem);
 383   XBT_DEBUG("Destroy semaphore %p", sem);
 384   if (sem != nullptr) {
 385     xbt_assert(xbt_swag_size(sem->sleeping) == 0,
 386                 "Cannot destroy semaphore since someone is still using it");
 387     xbt_swag_free(sem->sleeping);
 388     xbt_free(sem);
 389   }
 390   XBT_OUT();
 391 }
 392
 393 void simcall_HANDLER_sem_release(smx_simcall_t simcall, smx_sem_t sem){
 394   SIMIX_sem_release(sem);
 395 }
 396 /** @brief release the semaphore
 397  *
 398  * Unlock a process waiting on the semaphore.
 399  * If no one was blocked, the semaphore capacity is increased by 1.
 400  */
 401 void SIMIX_sem_release(smx_sem_t sem)
 402 {
 403   XBT_IN("(%p)",sem);
 404   smx_process_t proc;
 405
 406   XBT_DEBUG("Sem release semaphore %p", sem);
 407   if ((proc = (smx_process_t) xbt_swag_extract(sem->sleeping))) {
 408     delete proc->waiting_synchro;
 409     proc->waiting_synchro = nullptr;
 410     SIMIX_simcall_answer(&proc->simcall);
 411   } else if (sem->value < SMX_SEM_NOLIMIT) {
 412     sem->value++;
 413   }
 414   XBT_OUT();
 415 }
 416
 417 /** @brief Returns true if acquiring this semaphore would block */
 418 int SIMIX_sem_would_block(smx_sem_t sem)
 419 {
 420   XBT_IN("(%p)",sem);
 421   XBT_OUT();
 422   return (sem->value <= 0);
 423 }
 424
 425 int simcall_HANDLER_sem_get_capacity(smx_simcall_t simcall, smx_sem_t sem){
 426   return SIMIX_sem_get_capacity(sem);
 427 }
 428 /** @brief Returns the current capacity of the semaphore */
 429 int SIMIX_sem_get_capacity(smx_sem_t sem)
 430 {
 431   XBT_IN("(%p)",sem);
 432   XBT_OUT();
 433   return sem->value;
 434 }
 435
 436 static void _SIMIX_sem_wait(smx_sem_t sem, double timeout, smx_process_t issuer,
 437                             smx_simcall_t simcall)
 438 {
 439   XBT_IN("(%p, %f, %p, %p)",sem,timeout,issuer,simcall);
 440   smx_synchro_t synchro = nullptr;
 441
 442   XBT_DEBUG("Wait semaphore %p (timeout:%f)", sem, timeout);
 443   if (sem->value <= 0) {
 444     synchro = SIMIX_synchro_wait(issuer->host, timeout);
 445     synchro->simcalls.push_front(simcall);
 446     issuer->waiting_synchro = synchro;
 447     xbt_swag_insert(issuer, sem->sleeping);
 448   } else {
 449     sem->value--;
 450     SIMIX_simcall_answer(simcall);
 451   }
 452   XBT_OUT();
 453 }
 454
 455 /**
 456  * \brief Handles a sem acquire simcall without timeout.
 457  * \param simcall the simcall
 458  */
 459 void simcall_HANDLER_sem_acquire(smx_simcall_t simcall, smx_sem_t sem)
 460 {
 461   XBT_IN("(%p)",simcall);
 462   _SIMIX_sem_wait(sem, -1, simcall->issuer, simcall);
 463   XBT_OUT();
 464 }
 465
 466 /**
 467  * \brief Handles a sem acquire simcall with timeout.
 468  * \param simcall the simcall
 469  */
 470 void simcall_HANDLER_sem_acquire_timeout(smx_simcall_t simcall, smx_sem_t sem, double timeout)
 471 {
 472   XBT_IN("(%p)",simcall);
 473   _SIMIX_sem_wait(sem, timeout, simcall->issuer, simcall);
 474   XBT_OUT();
 475 }
 476 int simcall_HANDLER_sem_would_block(smx_simcall_t simcall, smx_sem_t sem) {
 477   return SIMIX_sem_would_block(sem);
 478 }