Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
Fail loudly when someone tries to unlock a mutex owned by someone else
[simgrid.git] / src / simix / smx_synchro.c
index 587e852..59ea411 100644 (file)
@@ -1,4 +1,4 @@
-/* Copyright (c) 2007, 2008, 2009, 2010. The SimGrid Team.
+/* Copyright (c) 2007-2015. The SimGrid Team.
  * All rights reserved.                                                     */
 
 /* This program is free software; you can redistribute it and/or modify it
@@ -9,30 +9,30 @@
 
 
 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(simix_synchro, simix,
-                                "Logging specific to SIMIX (synchronization)");
+                                "SIMIX Synchronization (mutex, semaphores and conditions)");
 
-static smx_action_t SIMIX_synchro_wait(smx_host_t smx_host, double timeout);
-static void SIMIX_synchro_finish(smx_action_t action);
+static smx_synchro_t SIMIX_synchro_wait(sg_host_t smx_host, double timeout);
+static void SIMIX_synchro_finish(smx_synchro_t synchro);
 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);
 
-/***************************** Synchro action *********************************/
+/***************************** Raw synchronization *********************************/
 
-static smx_action_t SIMIX_synchro_wait(smx_host_t smx_host, double timeout)
+static smx_synchro_t SIMIX_synchro_wait(sg_host_t smx_host, double timeout)
 {
   XBT_IN("(%p, %f)",smx_host,timeout);
-  smx_action_t action;
-  action = xbt_mallocator_get(simix_global->action_mallocator);
-  action->type = SIMIX_ACTION_SYNCHRO;
-  action->name = xbt_strdup("synchro");
-  action->synchro.sleep = 
-    surf_workstation_model->extension.workstation.sleep(smx_host->host, timeout);
-
-  surf_workstation_model->action_data_set(action->synchro.sleep, action);
+
+  smx_synchro_t sync;
+  sync = xbt_mallocator_get(simix_global->synchro_mallocator);
+  sync->type = SIMIX_SYNC_SYNCHRO;
+  sync->name = xbt_strdup("synchro");
+  sync->synchro.sleep = surf_host_sleep(smx_host, timeout);
+
+  surf_action_set_data(sync->synchro.sleep, sync);
   XBT_OUT();
-  return action;
+  return sync;
 }
 
 void SIMIX_synchro_stop_waiting(smx_process_t process, smx_simcall_t simcall)
@@ -66,34 +66,36 @@ void SIMIX_synchro_stop_waiting(smx_process_t process, smx_simcall_t simcall)
   XBT_OUT();
 }
 
-void SIMIX_synchro_destroy(smx_action_t action)
+void SIMIX_synchro_destroy(smx_synchro_t synchro)
 {
-  XBT_IN("(%p)",action);
-  XBT_DEBUG("Destroying synchro %p", action);
-  action->synchro.sleep->model_type->action_unref(action->synchro.sleep);
-  xbt_free(action->name);
-  xbt_mallocator_release(simix_global->action_mallocator, action);
+  XBT_IN("(%p)",synchro);
+  XBT_DEBUG("Destroying synchro %p", synchro);
+  xbt_assert(synchro->type == SIMIX_SYNC_SYNCHRO);
+  surf_action_unref(synchro->synchro.sleep);
+  xbt_free(synchro->name);
+  xbt_mallocator_release(simix_global->synchro_mallocator, synchro);
   XBT_OUT();
 }
 
-void SIMIX_post_synchro(smx_action_t action)
+void SIMIX_post_synchro(smx_synchro_t synchro)
 {
-  XBT_IN("(%p)",action);
-  if (surf_workstation_model->action_state_get(action->synchro.sleep) == SURF_ACTION_FAILED)
-    action->state = SIMIX_FAILED;
-  else if(surf_workstation_model->action_state_get(action->synchro.sleep) == SURF_ACTION_DONE)
-    action->state = SIMIX_SRC_TIMEOUT;
-
-  SIMIX_synchro_finish(action);  
+  XBT_IN("(%p)",synchro);
+  xbt_assert(synchro->type == SIMIX_SYNC_SYNCHRO);
+  if (surf_action_get_state(synchro->synchro.sleep) == SURF_ACTION_FAILED)
+    synchro->state = SIMIX_FAILED;
+  else if(surf_action_get_state(synchro->synchro.sleep) == SURF_ACTION_DONE)
+    synchro->state = SIMIX_SRC_TIMEOUT;
+
+  SIMIX_synchro_finish(synchro);  
   XBT_OUT();
 }
 
-static void SIMIX_synchro_finish(smx_action_t action)
+static void SIMIX_synchro_finish(smx_synchro_t synchro)
 {
-  XBT_IN("(%p)",action);
-  smx_simcall_t simcall = xbt_fifo_shift(action->simcalls);
+  XBT_IN("(%p)",synchro);
+  smx_simcall_t simcall = xbt_fifo_shift(synchro->simcalls);
 
-  switch (action->state) {
+  switch (synchro->state) {
 
     case SIMIX_SRC_TIMEOUT:
       SMX_EXCEPTION(simcall->issuer, timeout_error, 0, "Synchro's wait timeout");
@@ -110,14 +112,14 @@ static void SIMIX_synchro_finish(smx_action_t action)
   }
 
   SIMIX_synchro_stop_waiting(simcall->issuer, simcall);
-  simcall->issuer->waiting_action = NULL;
-  SIMIX_synchro_destroy(action);
+  simcall->issuer->waiting_synchro = NULL;
+  SIMIX_synchro_destroy(synchro);
   SIMIX_simcall_answer(simcall);
   XBT_OUT();
 }
 /*********************************** Mutex ************************************/
 
-smx_mutex_t SIMIX_pre_mutex_init(smx_simcall_t simcall){
+smx_mutex_t simcall_HANDLER_mutex_init(smx_simcall_t simcall){
   return SIMIX_mutex_init();
 }
 /**
@@ -142,19 +144,19 @@ smx_mutex_t SIMIX_mutex_init(void)
  * \brief Handles a mutex lock simcall.
  * \param simcall the simcall
  */
-void SIMIX_pre_mutex_lock(smx_simcall_t simcall, smx_mutex_t mutex)
+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_action_t sync_act = NULL;
+  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 synchro action to get host failures */
-    sync_act = SIMIX_synchro_wait(process->smx_host, -1);
-    xbt_fifo_push(sync_act->simcalls, simcall);
-    simcall->issuer->waiting_action = sync_act;
+    /* 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 */
@@ -165,9 +167,9 @@ void SIMIX_pre_mutex_lock(smx_simcall_t simcall, smx_mutex_t mutex)
   XBT_OUT();
 }
 
-int SIMIX_pre_mutex_trylock(smx_simcall_t simcall, smx_mutex_t mutex){
+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.
  *
@@ -191,7 +193,7 @@ int SIMIX_mutex_trylock(smx_mutex_t mutex, smx_process_t issuer)
   return 1;
 }
 
-void SIMIX_pre_mutex_unlock(smx_simcall_t simcall, smx_mutex_t mutex){
+void simcall_HANDLER_mutex_unlock(smx_simcall_t simcall, smx_mutex_t mutex){
    SIMIX_mutex_unlock(mutex, simcall->issuer);
 }
 /**
@@ -208,16 +210,15 @@ void SIMIX_mutex_unlock(smx_mutex_t mutex, smx_process_t issuer)
   XBT_IN("(%p, %p)",mutex,issuer);
   smx_process_t p;              /*process to wake up */
 
-  /* If the mutex is not owned by the issuer do nothing */
-  if (issuer != mutex->owner){
-    XBT_OUT();
-    return;
-  }
+  /* 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) {
     p = xbt_swag_extract(mutex->sleeping);
-    SIMIX_synchro_destroy(p->waiting_action);
-    p->waiting_action = NULL;
+    SIMIX_synchro_destroy(p->waiting_synchro);
+    p->waiting_synchro = NULL;
     mutex->owner = p;
     SIMIX_simcall_answer(&p->simcall);
   } else {
@@ -228,9 +229,6 @@ void SIMIX_mutex_unlock(smx_mutex_t mutex, smx_process_t issuer)
   XBT_OUT();
 }
 
-void SIMIX_pre_mutex_destroy(smx_simcall_t simcall, smx_mutex_t mutex){
-  SIMIX_mutex_destroy(mutex);
-}
 /**
  * \brief Destroys a mutex.
  *
@@ -249,9 +247,6 @@ void SIMIX_mutex_destroy(smx_mutex_t mutex)
 
 /********************************* Condition **********************************/
 
-smx_cond_t SIMIX_pre_cond_init(smx_simcall_t simcall){
-  return SIMIX_cond_init();
-}
 /**
  * \brief Initialize a condition.
  *
@@ -274,7 +269,7 @@ smx_cond_t SIMIX_cond_init(void)
  * \brief Handle a condition waiting simcall without timeouts
  * \param simcall the simcall
  */
-void SIMIX_pre_cond_wait(smx_simcall_t simcall, smx_cond_t cond, smx_mutex_t mutex)
+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;
@@ -287,7 +282,7 @@ void SIMIX_pre_cond_wait(smx_simcall_t simcall, smx_cond_t cond, smx_mutex_t mut
  * \brief Handle a condition waiting simcall with timeouts
  * \param simcall the simcall
  */
-void SIMIX_pre_cond_wait_timeout(smx_simcall_t simcall, smx_cond_t cond,
+void simcall_HANDLER_cond_wait_timeout(smx_simcall_t simcall, smx_cond_t cond,
                                 smx_mutex_t mutex, double timeout)
 {
   XBT_IN("(%p)",simcall);
@@ -302,7 +297,7 @@ 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_action_t sync_act = NULL;
+  smx_synchro_t synchro = NULL;
 
   XBT_DEBUG("Wait condition %p", cond);
 
@@ -313,16 +308,13 @@ static void _SIMIX_cond_wait(smx_cond_t cond, smx_mutex_t mutex, double timeout,
     SIMIX_mutex_unlock(mutex, issuer);
   }
 
-  sync_act = SIMIX_synchro_wait(issuer->smx_host, timeout);
-  xbt_fifo_unshift(sync_act->simcalls, simcall);
-  issuer->waiting_action = sync_act;
+  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();
 }
 
-void SIMIX_pre_cond_signal(smx_simcall_t simcall, smx_cond_t cond){
-  SIMIX_cond_signal(cond);
-}
 /**
  * \brief Signalizes a condition.
  *
@@ -343,9 +335,9 @@ void SIMIX_cond_signal(smx_cond_t cond)
      to make it acquire the mutex */
   if ((proc = xbt_swag_extract(cond->sleeping))) {
 
-    /* Destroy waiter's synchro action */
-    SIMIX_synchro_destroy(proc->waiting_action);
-    proc->waiting_action = NULL;
+    /* 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;
@@ -355,14 +347,11 @@ void SIMIX_cond_signal(smx_cond_t cond)
       mutex = simcall_cond_wait_timeout__get__mutex(simcall);
     simcall->call = SIMCALL_MUTEX_LOCK;
 
-    SIMIX_pre_mutex_lock(simcall, mutex);
+    simcall_HANDLER_mutex_lock(simcall, mutex);
   }
   XBT_OUT();
 }
 
-void SIMIX_pre_cond_broadcast(smx_simcall_t simcall, smx_cond_t cond){
-  SIMIX_cond_broadcast(cond);
-}
 /**
  * \brief Broadcasts a condition.
  *
@@ -382,11 +371,8 @@ void SIMIX_cond_broadcast(smx_cond_t cond)
   XBT_OUT();
 }
 
-void SIMIX_pre_cond_destroy(smx_simcall_t simcall, smx_cond_t cond){
-  SIMIX_cond_destroy(cond);
-}
 /**
- * \brief Destroys a contidion.
+ * \brief Destroys a condition.
  *
  * Destroys and frees the condition's memory. 
  * \param cond A condition
@@ -408,9 +394,6 @@ void SIMIX_cond_destroy(smx_cond_t cond)
 
 /******************************** Semaphores **********************************/
 #define SMX_SEM_NOLIMIT 99999
-smx_sem_t SIMIX_pre_sem_init(smx_simcall_t simcall, unsigned int value){
-  return SIMIX_sem_init(value);
-}
 /** @brief Initialize a semaphore */
 smx_sem_t SIMIX_sem_init(unsigned int value)
 {
@@ -424,9 +407,6 @@ smx_sem_t SIMIX_sem_init(unsigned int value)
   return sem;
 }
 
-void SIMIX_pre_sem_destroy(smx_simcall_t simcall, smx_sem_t sem){
-  SIMIX_sem_destroy(sem);
-}
 /** @brief Destroys a semaphore */
 void SIMIX_sem_destroy(smx_sem_t sem)
 {
@@ -441,7 +421,7 @@ void SIMIX_sem_destroy(smx_sem_t sem)
   XBT_OUT();
 }
 
-void SIMIX_pre_sem_release(smx_simcall_t simcall, smx_sem_t sem){
+void simcall_HANDLER_sem_release(smx_simcall_t simcall, smx_sem_t sem){
   SIMIX_sem_release(sem);
 }
 /** @brief release the semaphore
@@ -456,9 +436,8 @@ void SIMIX_sem_release(smx_sem_t sem)
 
   XBT_DEBUG("Sem release semaphore %p", sem);
   if ((proc = xbt_swag_extract(sem->sleeping))) {
-    proc = xbt_swag_extract(sem->sleeping);
-    SIMIX_synchro_destroy(proc->waiting_action);
-    proc->waiting_action = NULL;
+    SIMIX_synchro_destroy(proc->waiting_synchro);
+    proc->waiting_synchro = NULL;
     SIMIX_simcall_answer(&proc->simcall);
   } else if (sem->value < SMX_SEM_NOLIMIT) {
     sem->value++;
@@ -466,18 +445,15 @@ void SIMIX_sem_release(smx_sem_t sem)
   XBT_OUT();
 }
 
-XBT_INLINE int SIMIX_pre_sem_would_block(smx_simcall_t simcall, smx_sem_t sem){
-  return SIMIX_sem_would_block(sem);
-}
 /** @brief Returns true if acquiring this semaphore would block */
-XBT_INLINE int SIMIX_sem_would_block(smx_sem_t sem)
+int SIMIX_sem_would_block(smx_sem_t sem)
 {
   XBT_IN("(%p)",sem);
   XBT_OUT();
   return (sem->value <= 0);
 }
 
-int SIMIX_pre_sem_get_capacity(smx_simcall_t simcall, smx_sem_t sem){
+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 */
@@ -492,13 +468,13 @@ static void _SIMIX_sem_wait(smx_sem_t sem, double timeout, smx_process_t issuer,
                             smx_simcall_t simcall)
 {
   XBT_IN("(%p, %f, %p, %p)",sem,timeout,issuer,simcall);
-  smx_action_t sync_act = NULL;
+  smx_synchro_t synchro = NULL;
 
   XBT_DEBUG("Wait semaphore %p (timeout:%f)", sem, timeout);
   if (sem->value <= 0) {
-    sync_act = SIMIX_synchro_wait(issuer->smx_host, timeout);
-    xbt_fifo_unshift(sync_act->simcalls, simcall);
-    issuer->waiting_action = sync_act;
+    synchro = SIMIX_synchro_wait(issuer->host, timeout);
+    xbt_fifo_unshift(synchro->simcalls, simcall);
+    issuer->waiting_synchro = synchro;
     xbt_swag_insert(issuer, sem->sleeping);
   } else {
     sem->value--;
@@ -511,7 +487,7 @@ 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 SIMIX_pre_sem_acquire(smx_simcall_t simcall, smx_sem_t sem)
+void simcall_HANDLER_sem_acquire(smx_simcall_t simcall, smx_sem_t sem)
 {
   XBT_IN("(%p)",simcall);
   _SIMIX_sem_wait(sem, -1, simcall->issuer, simcall);
@@ -522,9 +498,12 @@ void SIMIX_pre_sem_acquire(smx_simcall_t simcall, smx_sem_t sem)
  * \brief Handles a sem acquire simcall with timeout.
  * \param simcall the simcall
  */
-void SIMIX_pre_sem_acquire_timeout(smx_simcall_t simcall, smx_sem_t sem, double timeout)
+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);  
   XBT_OUT();
 }
+int simcall_HANDLER_sem_would_block(smx_simcall_t simcall, smx_sem_t sem) {
+  return SIMIX_sem_would_block(sem);
+}