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