Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
release_forever is supposed to open the latch. Let's do so
[simgrid.git] / src / simix / smx_synchro.c
index 8dd790c..e80c9cf 100644 (file)
@@ -74,7 +74,7 @@ void SIMIX_mutex_lock(smx_mutex_t mutex)
  * \param mutex The mutex
  * \return 1 - mutex free, 0 - mutex used
  */
-int SIMIX_mutex_trylock(smx_mutex_t mutex)
+XBT_INLINE int SIMIX_mutex_trylock(smx_mutex_t mutex)
 {
   xbt_assert0((mutex != NULL), "Invalid parameters");
 
@@ -115,7 +115,7 @@ void SIMIX_mutex_unlock(smx_mutex_t mutex)
  * Destroys and frees the mutex's memory. 
  * \param mutex A mutex
  */
-void SIMIX_mutex_destroy(smx_mutex_t mutex)
+XBT_INLINE void SIMIX_mutex_destroy(smx_mutex_t mutex)
 {
   if (mutex == NULL)
     return;
@@ -131,7 +131,8 @@ void SIMIX_mutex_destroy(smx_mutex_t mutex)
 /**
  * \brief Initialize a condition.
  *
- * Allocs and creates the data for the condition. It have to be called before the utilisation of the 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()
@@ -202,7 +203,7 @@ void SIMIX_cond_wait(smx_cond_t cond, smx_mutex_t mutex)
   return;
 }
 
-xbt_fifo_t SIMIX_cond_get_actions(smx_cond_t cond)
+XBT_INLINE xbt_fifo_t SIMIX_cond_get_actions(smx_cond_t cond)
 {
   xbt_assert0((cond != NULL), "Invalid parameters");
   return cond->actions;
@@ -262,13 +263,11 @@ void SIMIX_cond_wait_timeout(smx_cond_t cond, smx_mutex_t mutex,
     }
 
   } else
-    __SIMIX_cond_wait(cond);
+    SIMIX_cond_wait(cond,NULL);
 
   /* get the mutex again if necessary */
   if(mutex != NULL)
     SIMIX_mutex_lock(cond->mutex);
-
-  return;
 }
 
 /**
@@ -289,8 +288,6 @@ void SIMIX_cond_broadcast(smx_cond_t cond)
     xbt_swag_remove(proc, cond->sleeping);
     xbt_swag_insert(proc, simix_global->process_to_run);
   }
-
-  return;
 }
 
 /**
@@ -339,3 +336,240 @@ void SIMIX_cond_display_info(smx_cond_t cond)
     }
   }
 }
+
+/* ************************** Semaphores ************************************** */
+#define SMX_SEM_NOLIMIT 99999
+/** @brief Initialize a semaphore */
+smx_sem_t SIMIX_sem_init(int capacity) {
+  smx_sem_t sem = xbt_new0(s_smx_sem_t, 1);
+  s_smx_process_t p;
+
+  sem->sleeping = xbt_swag_new(xbt_swag_offset(p, synchro_hookup));
+  sem->actions = xbt_fifo_new();
+  sem->capacity = capacity;
+  return sem;
+}
+/** @brief Destroys a semaphore */
+void SIMIX_sem_destroy(smx_sem_t sem) {
+  DEBUG1("Destroy semaphore %p", sem);
+  if (sem == NULL)
+    return;
+
+  smx_action_t action = NULL;
+
+  xbt_assert0(xbt_swag_size(sem->sleeping) == 0,
+      "Cannot destroy semaphore since someone is still using it");
+  xbt_swag_free(sem->sleeping);
+
+  DEBUG1("%d actions registered", xbt_fifo_size(sem->actions));
+  while((action=xbt_fifo_pop(sem->actions)))
+    SIMIX_unregister_action_to_semaphore(action, sem);
+
+  xbt_fifo_free(sem->actions);
+  xbt_free(sem);
+}
+
+/** @brief release the semaphore
+ *
+ * The first locked process on this semaphore is unlocked.
+ * If no one was blocked, the semaphore capacity is increased by 1.
+ * */
+void SIMIX_sem_release(smx_sem_t sem) {
+       DEBUG1("Sem release semaphore %p", sem);
+  if (xbt_swag_size(sem->sleeping) >= 1) {
+    smx_process_t proc = xbt_swag_extract(sem->sleeping);
+    xbt_swag_insert(proc, simix_global->process_to_run);
+  } else if (sem->capacity != SMX_SEM_NOLIMIT) {
+    sem->capacity++;
+  }
+}
+/** @brief make sure the semaphore will never be blocking again
+ *
+ * This function is not really in the semaphore spirit. It makes
+ * sure that the semaphore will never be blocking anymore.
+ *
+ * Releasing and acquiring the semaphore after calling this
+ * function is a noop. Such "broken" semaphores are useful to
+ * implement something between condition variables (with broadcast)
+ * and semaphore (with memory). It's like a semaphore signaled for ever.
+ *
+ * There is no way to reset the semaphore to a more regular state afterward.
+ * */
+void SIMIX_sem_release_forever(smx_sem_t sem) {
+  smx_process_t proc = NULL;
+  smx_process_t proc_next = NULL;
+
+  DEBUG1("Broadcast semaphore %p", sem);
+  xbt_swag_foreach_safe(proc, proc_next, sem->sleeping) {
+    xbt_swag_remove(proc, sem->sleeping);
+    xbt_swag_insert(proc, simix_global->process_to_run);
+  }
+  sem->capacity == SMX_SEM_NOLIMIT;
+}
+
+/**
+ * \brief Low level wait on a semaphore
+ *
+ * This function does not test the capacity of the semaphore and direcly locks
+ * the calling process on the semaphore (until someone call SIMIX_sem_release()
+ * on this semaphore). Do not call this function if you did not attach any action
+ * to this semaphore to be awaken. Note also that you may miss host failure if you
+ * do not attach a dummy action beforehand. SIMIX_sem_acquire does all these
+ * things for you so you it may be preferable to use.
+ */
+void SIMIX_sem_block_onto(smx_sem_t sem) {
+  smx_process_t self = SIMIX_process_self();
+
+  /* process status */
+  self->sem = sem;
+  xbt_swag_insert(self, sem->sleeping);
+  SIMIX_process_yield();
+  self->sem = NULL;
+  while (self->suspended)
+    SIMIX_process_yield();
+}
+
+/** @brief Returns true if acquiring this semaphore would block */
+XBT_INLINE int SIMIX_sem_would_block(smx_sem_t sem) {
+  return (sem->capacity>0);
+}
+
+/** @brief Returns the current capacity of the semaphore
+ *
+ * If it's negative, that's the amount of processes locked on the semaphore
+ */
+int SIMIX_sem_get_capacity(smx_sem_t sem){
+  return sem->capacity;
+}
+
+/**
+ * \brief Waits on a semaphore
+ *
+ * If the capacity>0, decrease the capacity.
+ *
+ * If capacity==0, locks the current process
+ * until someone call SIMIX_sem_release() on this semaphore
+ */
+void SIMIX_sem_acquire(smx_sem_t sem) {
+  smx_action_t act_sleep;
+
+  DEBUG1("Wait semaphore %p", sem);
+
+  if (sem->capacity == SMX_SEM_NOLIMIT)
+    return; /* don't even decrease it if wide open */
+
+  /* If capacity sufficient, decrease it */
+  if (sem->capacity>0) {
+    sem->capacity--;
+    return;
+  }
+
+  sem->capacity--;
+  /* Always create an action null in case there is a host failure */
+  act_sleep = SIMIX_action_sleep(SIMIX_host_self(), -1);
+  SIMIX_action_set_name(act_sleep,bprintf("Locked in semaphore %p", sem));
+  SIMIX_process_self()->waiting_action = act_sleep;
+  SIMIX_register_action_to_semaphore(act_sleep, sem);
+  SIMIX_sem_block_onto(sem);
+  SIMIX_process_self()->waiting_action = NULL;
+  SIMIX_unregister_action_to_semaphore(act_sleep, sem);
+  SIMIX_action_destroy(act_sleep);
+  DEBUG1("End of Wait on semaphore %p", sem);
+  sem->capacity++;
+}
+/**
+ * \brief Tries to acquire a semaphore before a timeout
+ *
+ * Same behavior of #SIMIX_sem_acquire, but waits a maximum time and throws an timeout_error if it happens.
+ */
+void SIMIX_sem_acquire_timeout(smx_sem_t sem, double max_duration) {
+  smx_action_t act_sleep;
+
+  DEBUG2("Timed wait semaphore %p (timeout:%f)", sem,max_duration);
+
+  if (sem->capacity == SMX_SEM_NOLIMIT)
+    return; /* don't even decrease it if wide open */
+
+  /* If capacity sufficient, decrease it */
+  if (sem->capacity>0) {
+    sem->capacity--;
+    return;
+  }
+
+  if (max_duration >= 0) {
+    sem->capacity--;
+    act_sleep = SIMIX_action_sleep(SIMIX_host_self(), max_duration);
+    SIMIX_action_set_name(act_sleep,bprintf("Timed wait semaphore %p (max_duration:%f)", sem,max_duration));
+    SIMIX_register_action_to_semaphore(act_sleep, sem);
+    SIMIX_process_self()->waiting_action = act_sleep;
+    SIMIX_sem_block_onto(sem);
+    SIMIX_process_self()->waiting_action = NULL;
+    SIMIX_unregister_action_to_semaphore(act_sleep, sem);
+    if (SIMIX_action_get_state(act_sleep) == SURF_ACTION_DONE) {
+      SIMIX_action_destroy(act_sleep);
+      THROW1(timeout_error, 0, "Semaphore acquire timeouted after %f",max_duration);
+    } else {
+      SIMIX_action_destroy(act_sleep);
+    }
+    sem->capacity++;
+
+  } else
+    SIMIX_sem_acquire(sem);
+}
+/**
+ * \brief Blocks on a set of semaphore
+ *
+ * If any of the semaphores has some more capacity, it gets decreased.
+ * If not, blocks until the capacity of one of the semaphores becomes more friendly.
+ *
+ * \return the rank in the dynar of the semaphore which just got locked from the set
+ */
+unsigned int SIMIX_sem_acquire_any(xbt_dynar_t sems) {
+  smx_sem_t sem;
+  unsigned int counter,result=-1;
+  smx_action_t act_sleep;
+  smx_process_t self = SIMIX_process_self();
+
+  xbt_assert0(xbt_dynar_length(sems),
+      "I refuse to commit sucide by locking on an **empty** set of semaphores!!");
+  DEBUG1("Wait on semaphore set %p", sems);
+
+  xbt_dynar_foreach(sems,counter,sem) {
+    if (!SIMIX_sem_would_block(sem))
+      SIMIX_sem_acquire(sem);
+    return counter;
+  }
+
+  /* Always create an action null in case there is a host failure */
+  act_sleep = SIMIX_action_sleep(SIMIX_host_self(), -1);
+  SIMIX_action_set_name(act_sleep,bprintf("Locked in semaphore %p", sem));
+  self->waiting_action = act_sleep;
+  SIMIX_register_action_to_semaphore(act_sleep, xbt_dynar_get_as(sems,0,smx_sem_t));
+
+  /* Get listed as member of all the provided semaphores */
+  self->sem = (smx_sem_t)sems; /* FIXME: we pass a pointer to dynar where a pointer to sem is expected...*/
+  xbt_dynar_foreach(sems,counter,sem) {
+    xbt_swag_insert(self, sem->sleeping);
+  }
+  SIMIX_process_yield();
+  while (self->suspended)
+    SIMIX_process_yield();
+
+  /* one of the semaphore unsuspended us -- great, let's search which one (and get out of the others) */
+  self->sem = NULL;
+  xbt_dynar_foreach(sems,counter,sem) {
+    if (xbt_swag_belongs(self,sem->sleeping))
+      xbt_swag_remove(self,sem->sleeping);
+    else {
+      xbt_assert0(result==-1,"More than one semaphore unlocked us. Dunno what to do");
+      result = counter;
+    }
+  }
+  xbt_assert0(counter!=-1,"Cannot find which semaphore unlocked me!");
+
+  /* Destroy the waiting action */
+  self->waiting_action = NULL;
+  SIMIX_unregister_action_to_semaphore(act_sleep, xbt_dynar_get_as(sems,0,smx_sem_t));
+  SIMIX_action_destroy(act_sleep);
+  return result;
+}