Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
Stop using costly exceptions on timeout for simix synchros.
[simgrid.git] / src / simix / smx_synchro.cpp
index cb9212a..24f8636 100644 (file)
@@ -1,61 +1,57 @@
-/* Copyright (c) 2007-2015. The SimGrid Team.
- * All rights reserved.                                                     */
+/* Copyright (c) 2007-2018. The SimGrid Team. All rights reserved.          */
 
 /* This program is free software; you can redistribute it and/or modify it
  * under the terms of the license (GNU LGPL) which comes with this package. */
 
-#include "src/surf/surf_interface.hpp"
-#include "smx_private.h"
-#include "xbt/log.h"
+#include "smx_private.hpp"
+#include "src/kernel/activity/ConditionVariableImpl.hpp"
+#include "src/kernel/activity/MutexImpl.hpp"
+#include "src/kernel/activity/SynchroRaw.hpp"
+#include "src/simix/smx_synchro_private.hpp"
+#include "src/surf/cpu_interface.hpp"
+#include <xbt/ex.hpp>
 
-#include "src/simix/SynchroRaw.hpp"
-
-XBT_LOG_NEW_DEFAULT_SUBCATEGORY(simix_synchro, simix,
-                                "SIMIX Synchronization (mutex, semaphores and conditions)");
-
-static smx_synchro_t SIMIX_synchro_wait(sg_host_t smx_host, double timeout);
-static void _SIMIX_cond_wait(smx_cond_t cond, smx_mutex_t mutex, double timeout,
-                             smx_process_t issuer, smx_simcall_t simcall);
-static void _SIMIX_sem_wait(smx_sem_t sem, double timeout, smx_process_t issuer,
-                            smx_simcall_t simcall);
+XBT_LOG_NEW_DEFAULT_SUBCATEGORY(simix_synchro, simix, "SIMIX Synchronization (mutex, semaphores and conditions)");
 
 /***************************** Raw synchronization *********************************/
 
-static smx_synchro_t SIMIX_synchro_wait(sg_host_t smx_host, double timeout)
+smx_activity_t SIMIX_synchro_wait(sg_host_t smx_host, double timeout)
 {
   XBT_IN("(%p, %f)",smx_host,timeout);
 
-  simgrid::simix::Raw *sync = new simgrid::simix::Raw();
-  sync->name = nullptr;
-  sync->sleep = surf_host_sleep(smx_host, timeout);
-  sync->sleep->setData(sync);
+  simgrid::kernel::activity::RawImplPtr sync =
+      simgrid::kernel::activity::RawImplPtr(new simgrid::kernel::activity::RawImpl());
+  sync->sleep                          = smx_host->pimpl_cpu->sleep(timeout);
+  sync->sleep->set_data(sync.get());
   XBT_OUT();
   return sync;
 }
 
-void SIMIX_synchro_stop_waiting(smx_process_t process, smx_simcall_t simcall)
+void SIMIX_synchro_stop_waiting(smx_actor_t process, smx_simcall_t simcall)
 {
   XBT_IN("(%p, %p)",process,simcall);
   switch (simcall->call) {
 
     case SIMCALL_MUTEX_LOCK:
-      xbt_swag_remove(process, simcall_mutex_lock__get__mutex(simcall)->sleeping);
+      simgrid::xbt::intrusive_erase(simcall_mutex_lock__get__mutex(simcall)->sleeping, *process);
       break;
 
     case SIMCALL_COND_WAIT:
-      xbt_swag_remove(process, simcall_cond_wait__get__cond(simcall)->sleeping);
+      simgrid::xbt::intrusive_erase(simcall_cond_wait__get__cond(simcall)->sleeping, *process);
       break;
 
     case SIMCALL_COND_WAIT_TIMEOUT:
-      xbt_swag_remove(process, simcall_cond_wait_timeout__get__cond(simcall)->sleeping);
+      simgrid::xbt::intrusive_erase(simcall_cond_wait_timeout__get__cond(simcall)->sleeping, *process);
+      simcall_cond_wait_timeout__set__result(simcall, 1); // signal a timeout
       break;
 
     case SIMCALL_SEM_ACQUIRE:
-      xbt_swag_remove(process, simcall_sem_acquire__get__sem(simcall)->sleeping);
+      simgrid::xbt::intrusive_erase(simcall_sem_acquire__get__sem(simcall)->sleeping, *process);
       break;
 
     case SIMCALL_SEM_ACQUIRE_TIMEOUT:
-      xbt_swag_remove(process, simcall_sem_acquire_timeout__get__sem(simcall)->sleeping);
+      simgrid::xbt::intrusive_erase(simcall_sem_acquire_timeout__get__sem(simcall)->sleeping, *process);
+      simcall_sem_acquire_timeout__set__result(simcall, 1); // signal a timeout
       break;
 
     default:
@@ -64,326 +60,31 @@ void SIMIX_synchro_stop_waiting(smx_process_t process, smx_simcall_t simcall)
   XBT_OUT();
 }
 
-void SIMIX_synchro_destroy(smx_synchro_t synchro)
+void SIMIX_synchro_finish(smx_activity_t synchro)
 {
-  XBT_DEBUG("Destroying synchro %p", synchro);
-  simgrid::simix::Raw *raw = static_cast<simgrid::simix::Raw*>(synchro);
-
-  delete raw;
-}
-
-void SIMIX_synchro_finish(smx_synchro_t synchro)
-{
-  XBT_IN("(%p)",synchro);
-  smx_simcall_t simcall = (smx_simcall_t) xbt_fifo_shift(synchro->simcalls);
-
-  switch (synchro->state) {
-
-    case SIMIX_SRC_TIMEOUT:
-      SMX_EXCEPTION(simcall->issuer, timeout_error, 0, "Synchro's wait timeout");
-      break;
+  XBT_IN("(%p)", synchro.get());
+  smx_simcall_t simcall = synchro->simcalls.front();
+  synchro->simcalls.pop_front();
 
-    case SIMIX_FAILED:
-        simcall->issuer->context->iwannadie = 1;
-//      SMX_EXCEPTION(simcall->issuer, host_error, 0, "Host failed");
-      break;
-
-    default:
+  if (synchro->state != SIMIX_SRC_TIMEOUT) {
+    if (synchro->state == SIMIX_FAILED)
+      simcall->issuer->context->iwannadie = 1;
+    else
       THROW_IMPOSSIBLE;
-      break;
   }
 
   SIMIX_synchro_stop_waiting(simcall->issuer, simcall);
-  simcall->issuer->waiting_synchro = NULL;
-  SIMIX_synchro_destroy(synchro);
+  simcall->issuer->waiting_synchro = nullptr;
   SIMIX_simcall_answer(simcall);
   XBT_OUT();
 }
-/*********************************** Mutex ************************************/
-
-smx_mutex_t simcall_HANDLER_mutex_init(smx_simcall_t simcall){
-  return SIMIX_mutex_init();
-}
-/**
- * \brief Initialize a mutex.
- *
- * Allocs and creates the data for the mutex.
- * \return A mutex
- */
-smx_mutex_t SIMIX_mutex_init(void)
-{
-  XBT_IN("()");
-  s_smx_process_t p;            /* useful to initialize sleeping swag */
-
-  smx_mutex_t mutex = xbt_new0(s_smx_mutex_t, 1);
-  mutex->locked = 0;
-  mutex->sleeping = xbt_swag_new(xbt_swag_offset(p, synchro_hookup));
-  XBT_OUT();
-  return mutex;
-}
-
-/**
- * \brief Handles a mutex lock simcall.
- * \param simcall the simcall
- */
-void simcall_HANDLER_mutex_lock(smx_simcall_t simcall, smx_mutex_t mutex)
-{
-  XBT_IN("(%p)",simcall);
-  /* FIXME: check where to validate the arguments */
-  smx_synchro_t synchro = NULL;
-  smx_process_t process = simcall->issuer;
-
-  if (mutex->locked) {
-    /* FIXME: check if the host is active ? */
-    /* Somebody using the mutex, use a synchronization to get host failures */
-    synchro = SIMIX_synchro_wait(process->host, -1);
-    xbt_fifo_push(synchro->simcalls, simcall);
-    simcall->issuer->waiting_synchro = synchro;
-    xbt_swag_insert(simcall->issuer, mutex->sleeping);   
-  } else {
-    /* mutex free */
-    mutex->locked = 1;
-    mutex->owner = simcall->issuer;
-    SIMIX_simcall_answer(simcall);
-  }
-  XBT_OUT();
-}
-
-int simcall_HANDLER_mutex_trylock(smx_simcall_t simcall, smx_mutex_t mutex){
-  return SIMIX_mutex_trylock(mutex, simcall->issuer);
-}
-/**
- * \brief Tries to lock a mutex.
- *
- * Tries to lock a mutex, return 1 if the mutex is unlocked, else 0.
- * This function does not block and wait for the mutex to be unlocked.
- * \param mutex The mutex
- * \param issuer The process that tries to acquire the mutex
- * \return 1 - mutex free, 0 - mutex used
- */
-int SIMIX_mutex_trylock(smx_mutex_t mutex, smx_process_t issuer)
-{
-  XBT_IN("(%p, %p)",mutex,issuer);
-  if (mutex->locked){
-    XBT_OUT();
-    return 0;
-  }
-
-  mutex->locked = 1;
-  mutex->owner = issuer;
-  XBT_OUT();
-  return 1;
-}
-
-void simcall_HANDLER_mutex_unlock(smx_simcall_t simcall, smx_mutex_t mutex){
-   SIMIX_mutex_unlock(mutex, simcall->issuer);
-}
-/**
- * \brief Unlocks a mutex.
- *
- * Unlocks the mutex and gives it to a process waiting for it. 
- * If the unlocker is not the owner of the mutex nothing happens.
- * If there are no process waiting, it sets the mutex as free.
- * \param mutex The mutex
- * \param issuer The process trying to unlock the mutex
- */
-void SIMIX_mutex_unlock(smx_mutex_t mutex, smx_process_t issuer)
-{
-  XBT_IN("(%p, %p)",mutex,issuer);
-
-  /* If the mutex is not owned by the issuer, that's not good */
-  if (issuer != mutex->owner)
-    THROWF(mismatch_error, 0, "Cannot release that mutex: it was locked by %s (pid:%d), not by you.",
-        SIMIX_process_get_name(mutex->owner),SIMIX_process_get_PID(mutex->owner));
-
-  if (xbt_swag_size(mutex->sleeping) > 0) {
-    /*process to wake up */
-    smx_process_t p = (smx_process_t) xbt_swag_extract(mutex->sleeping);
-    SIMIX_synchro_destroy(p->waiting_synchro);
-    p->waiting_synchro = NULL;
-    mutex->owner = p;
-    SIMIX_simcall_answer(&p->simcall);
-  } else {
-    /* nobody to wake up */
-    mutex->locked = 0;
-    mutex->owner = NULL;
-  }
-  XBT_OUT();
-}
-
-/**
- * \brief Destroys a mutex.
- *
- * Destroys and frees the mutex's memory. 
- * \param mutex A mutex
- */
-void SIMIX_mutex_destroy(smx_mutex_t mutex)
-{
-  XBT_IN("(%p)",mutex);
-  if (mutex){
-    xbt_swag_free(mutex->sleeping);
-    xbt_free(mutex);
-  }
-  XBT_OUT();
-}
-
-/********************************* Condition **********************************/
-
-/**
- * \brief Initialize a condition.
- *
- * Allocates and creates the data for the condition.
- * It have to be called before the use of the condition.
- * \return A condition
- */
-smx_cond_t SIMIX_cond_init(void)
-{
-  XBT_IN("()");
-  s_smx_process_t p;
-  smx_cond_t cond = xbt_new0(s_smx_cond_t, 1);
-  cond->sleeping = xbt_swag_new(xbt_swag_offset(p, synchro_hookup));
-  cond->mutex = NULL;
-  XBT_OUT();
-  return cond;
-}
-
-/**
- * \brief Handle a condition waiting simcall without timeouts
- * \param simcall the simcall
- */
-void simcall_HANDLER_cond_wait(smx_simcall_t simcall, smx_cond_t cond, smx_mutex_t mutex)
-{
-  XBT_IN("(%p)",simcall);
-  smx_process_t issuer = simcall->issuer;
-
-  _SIMIX_cond_wait(cond, mutex, -1, issuer, simcall);
-  XBT_OUT();
-}
-
-/**
- * \brief Handle a condition waiting simcall with timeouts
- * \param simcall the simcall
- */
-void simcall_HANDLER_cond_wait_timeout(smx_simcall_t simcall, smx_cond_t cond,
-                     smx_mutex_t mutex, double timeout)
-{
-  XBT_IN("(%p)",simcall);
-  smx_process_t issuer = simcall->issuer;
-
-  _SIMIX_cond_wait(cond, mutex, timeout, issuer, simcall);
-  XBT_OUT();
-}
-
-
-static void _SIMIX_cond_wait(smx_cond_t cond, smx_mutex_t mutex, double timeout,
-                             smx_process_t issuer, smx_simcall_t simcall)
-{
-  XBT_IN("(%p, %p, %f, %p,%p)",cond,mutex,timeout,issuer,simcall);
-  smx_synchro_t synchro = NULL;
-
-  XBT_DEBUG("Wait condition %p", cond);
-
-  /* If there is a mutex unlock it */
-  /* FIXME: what happens if the issuer is not the owner of the mutex? */
-  if (mutex != NULL) {
-    cond->mutex = mutex;
-    SIMIX_mutex_unlock(mutex, issuer);
-  }
-
-  synchro = SIMIX_synchro_wait(issuer->host, timeout);
-  xbt_fifo_unshift(synchro->simcalls, simcall);
-  issuer->waiting_synchro = synchro;
-  xbt_swag_insert(simcall->issuer, cond->sleeping);   
-  XBT_OUT();
-}
-
-/**
- * \brief Signalizes a condition.
- *
- * Signalizes a condition and wakes up a sleeping process. 
- * If there are no process sleeping, no action is done.
- * \param cond A condition
- */
-void SIMIX_cond_signal(smx_cond_t cond)
-{
-  XBT_IN("(%p)",cond);
-  smx_process_t proc = NULL;
-  smx_mutex_t mutex = NULL;
-  smx_simcall_t simcall = NULL;
-
-  XBT_DEBUG("Signal condition %p", cond);
-
-  /* If there are processes waiting for the condition choose one and try 
-     to make it acquire the mutex */
-  if ((proc = (smx_process_t) xbt_swag_extract(cond->sleeping))) {
-
-    /* Destroy waiter's synchronization */
-    SIMIX_synchro_destroy(proc->waiting_synchro);
-    proc->waiting_synchro = NULL;
-
-    /* Now transform the cond wait simcall into a mutex lock one */
-    simcall = &proc->simcall;
-    if(simcall->call == SIMCALL_COND_WAIT)
-      mutex = simcall_cond_wait__get__mutex(simcall);
-    else
-      mutex = simcall_cond_wait_timeout__get__mutex(simcall);
-    simcall->call = SIMCALL_MUTEX_LOCK;
-
-    simcall_HANDLER_mutex_lock(simcall, mutex);
-  }
-  XBT_OUT();
-}
-
-/**
- * \brief Broadcasts a condition.
- *
- * Signal ALL processes waiting on a condition.
- * If there are no process waiting, no action is done.
- * \param cond A condition
- */
-void SIMIX_cond_broadcast(smx_cond_t cond)
-{
-  XBT_IN("(%p)",cond);
-  XBT_DEBUG("Broadcast condition %p", cond);
-
-  /* Signal the condition until nobody is waiting on it */
-  while (xbt_swag_size(cond->sleeping)) {
-    SIMIX_cond_signal(cond);
-  }
-  XBT_OUT();
-}
-
-/**
- * \brief Destroys a condition.
- *
- * Destroys and frees the condition's memory. 
- * \param cond A condition
- */
-void SIMIX_cond_destroy(smx_cond_t cond)
-{
-  XBT_IN("(%p)",cond);
-  XBT_DEBUG("Destroy condition %p", cond);
-
-  if (cond != NULL) {
-    xbt_assert(xbt_swag_size(cond->sleeping) == 0,
-                "Cannot destroy conditional since someone is still using it");
-
-    xbt_swag_free(cond->sleeping);
-    xbt_free(cond);
-  }
-  XBT_OUT();
-}
 
 /******************************** Semaphores **********************************/
-#define SMX_SEM_NOLIMIT 99999
 /** @brief Initialize a semaphore */
 smx_sem_t SIMIX_sem_init(unsigned int value)
 {
   XBT_IN("(%u)",value);
-  s_smx_process_t p;
-
-  smx_sem_t sem = xbt_new0(s_smx_sem_t, 1);
-  sem->sleeping = xbt_swag_new(xbt_swag_offset(p, synchro_hookup));
+  smx_sem_t sem = new s_smx_sem_t;
   sem->value = value;
   XBT_OUT();
   return sem;
@@ -394,18 +95,13 @@ void SIMIX_sem_destroy(smx_sem_t sem)
 {
   XBT_IN("(%p)",sem);
   XBT_DEBUG("Destroy semaphore %p", sem);
-  if (sem != NULL) {
-    xbt_assert(xbt_swag_size(sem->sleeping) == 0,
-                "Cannot destroy semaphore since someone is still using it");
-    xbt_swag_free(sem->sleeping);
-    xbt_free(sem);
+  if (sem != nullptr) {
+    xbt_assert(sem->sleeping.empty(), "Cannot destroy semaphore since someone is still using it");
+    delete sem;
   }
   XBT_OUT();
 }
 
-void simcall_HANDLER_sem_release(smx_simcall_t simcall, smx_sem_t sem){
-  SIMIX_sem_release(sem);
-}
 /** @brief release the semaphore
  *
  * Unlock a process waiting on the semaphore.
@@ -414,14 +110,13 @@ void simcall_HANDLER_sem_release(smx_simcall_t simcall, smx_sem_t sem){
 void SIMIX_sem_release(smx_sem_t sem)
 {
   XBT_IN("(%p)",sem);
-  smx_process_t proc;
-
   XBT_DEBUG("Sem release semaphore %p", sem);
-  if ((proc = (smx_process_t) xbt_swag_extract(sem->sleeping))) {
-    SIMIX_synchro_destroy(proc->waiting_synchro);
-    proc->waiting_synchro = NULL;
-    SIMIX_simcall_answer(&proc->simcall);
-  } else if (sem->value < SMX_SEM_NOLIMIT) {
+  if (not sem->sleeping.empty()) {
+    auto& proc = sem->sleeping.front();
+    sem->sleeping.pop_front();
+    proc.waiting_synchro = nullptr;
+    SIMIX_simcall_answer(&proc.simcall);
+  } else {
     sem->value++;
   }
   XBT_OUT();
@@ -435,9 +130,6 @@ int SIMIX_sem_would_block(smx_sem_t sem)
   return (sem->value <= 0);
 }
 
-int simcall_HANDLER_sem_get_capacity(smx_simcall_t simcall, smx_sem_t sem){
-  return SIMIX_sem_get_capacity(sem);
-}
 /** @brief Returns the current capacity of the semaphore */
 int SIMIX_sem_get_capacity(smx_sem_t sem)
 {
@@ -446,18 +138,18 @@ int SIMIX_sem_get_capacity(smx_sem_t sem)
   return sem->value;
 }
 
-static void _SIMIX_sem_wait(smx_sem_t sem, double timeout, smx_process_t issuer,
+static void _SIMIX_sem_wait(smx_sem_t sem, double timeout, smx_actor_t issuer,
                             smx_simcall_t simcall)
 {
   XBT_IN("(%p, %f, %p, %p)",sem,timeout,issuer,simcall);
-  smx_synchro_t synchro = NULL;
+  smx_activity_t synchro = nullptr;
 
   XBT_DEBUG("Wait semaphore %p (timeout:%f)", sem, timeout);
   if (sem->value <= 0) {
     synchro = SIMIX_synchro_wait(issuer->host, timeout);
-    xbt_fifo_unshift(synchro->simcalls, simcall);
+    synchro->simcalls.push_front(simcall);
     issuer->waiting_synchro = synchro;
-    xbt_swag_insert(issuer, sem->sleeping);
+    sem->sleeping.push_back(*issuer);
   } else {
     sem->value--;
     SIMIX_simcall_answer(simcall);
@@ -467,7 +159,6 @@ static void _SIMIX_sem_wait(smx_sem_t sem, double timeout, smx_process_t issuer,
 
 /**
  * \brief Handles a sem acquire simcall without timeout.
- * \param simcall the simcall
  */
 void simcall_HANDLER_sem_acquire(smx_simcall_t simcall, smx_sem_t sem)
 {
@@ -478,14 +169,11 @@ void simcall_HANDLER_sem_acquire(smx_simcall_t simcall, smx_sem_t sem)
 
 /**
  * \brief Handles a sem acquire simcall with timeout.
- * \param simcall the simcall
  */
 void simcall_HANDLER_sem_acquire_timeout(smx_simcall_t simcall, smx_sem_t sem, double timeout)
 {
   XBT_IN("(%p)",simcall);
-  _SIMIX_sem_wait(sem, timeout, simcall->issuer, simcall);  
+  simcall_sem_acquire_timeout__set__result(simcall, 0); // default result, will be set to 1 on timeout
+  _SIMIX_sem_wait(sem, timeout, simcall->issuer, simcall);
   XBT_OUT();
 }
-int simcall_HANDLER_sem_would_block(smx_simcall_t simcall, smx_sem_t sem) {
-  return SIMIX_sem_would_block(sem);
-}