Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
cosmetics
[simgrid.git] / src / simix / smx_synchro.cpp
index e82964e..6f53958 100644 (file)
@@ -1,39 +1,41 @@
+
 /* Copyright (c) 2007-2015. 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 "src/surf/cpu_interface.hpp"
+#include "src/surf/surf_interface.hpp"
+#include <xbt/ex.hpp>
+#include <xbt/log.h>
 
-#include "src/simix/SynchroRaw.hpp"
+#include "src/kernel/activity/SynchroRaw.hpp"
 
-XBT_LOG_NEW_DEFAULT_SUBCATEGORY(simix_synchro, simix,
-                                "SIMIX Synchronization (mutex, semaphores and conditions)");
+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 smx_activity_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_actor_t issuer, smx_simcall_t simcall);
+static void _SIMIX_sem_wait(smx_sem_t sem, double timeout, smx_actor_t issuer,
                             smx_simcall_t simcall);
 
 /***************************** Raw synchronization *********************************/
 
-static smx_synchro_t SIMIX_synchro_wait(sg_host_t smx_host, double timeout)
+static 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->setData(&*sync);
   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) {
@@ -64,10 +66,11 @@ void SIMIX_synchro_stop_waiting(smx_process_t process, smx_simcall_t simcall)
   XBT_OUT();
 }
 
-void SIMIX_synchro_finish(smx_synchro_t synchro)
+void SIMIX_synchro_finish(smx_activity_t synchro)
 {
-  XBT_IN("(%p)",synchro);
-  smx_simcall_t simcall = (smx_simcall_t) xbt_fifo_shift(synchro->simcalls);
+  XBT_IN("(%p)", synchro.get());
+  smx_simcall_t simcall = synchro->simcalls.front();
+  synchro->simcalls.pop_front();
 
   switch (synchro->state) {
 
@@ -86,137 +89,141 @@ void SIMIX_synchro_finish(smx_synchro_t synchro)
   }
 
   SIMIX_synchro_stop_waiting(simcall->issuer, simcall);
-  simcall->issuer->waiting_synchro = NULL;
-  delete 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)
+namespace simgrid {
+namespace simix {
+
+MutexImpl::MutexImpl() : mutex_(this)
 {
-  XBT_IN("()");
-  simgrid::simix::Process p;            /* useful to initialize sleeping swag */
+  XBT_IN("(%p)", this);
+  // Useful to initialize sleeping swag:
+  simgrid::simix::ActorImpl p;
+  this->sleeping = xbt_swag_new(xbt_swag_offset(p, synchro_hookup));
+  XBT_OUT();
+}
 
-  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));
+MutexImpl::~MutexImpl()
+{
+  XBT_IN("(%p)", this);
+  xbt_swag_free(this->sleeping);
   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)
+void MutexImpl::lock(smx_actor_t issuer)
 {
-  XBT_IN("(%p)",simcall);
+  XBT_IN("(%p; %p)", this, issuer);
   /* FIXME: check where to validate the arguments */
-  smx_synchro_t synchro = NULL;
-  smx_process_t process = simcall->issuer;
+  smx_activity_t synchro = nullptr;
 
-  if (mutex->locked) {
+  if (this->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);   
+    synchro = SIMIX_synchro_wait(issuer->host, -1);
+    synchro->simcalls.push_back(&issuer->simcall);
+    issuer->waiting_synchro = synchro;
+    xbt_swag_insert(issuer, this->sleeping);
   } else {
     /* mutex free */
-    mutex->locked = 1;
-    mutex->owner = simcall->issuer;
-    SIMIX_simcall_answer(simcall);
+    this->locked = true;
+    this->owner = issuer;
+    SIMIX_simcall_answer(&issuer->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 the mutex for a process
  *
- * 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
+ * \param  issuer  the process that tries to acquire the mutex
+ * \return whether we managed to lock the mutex
  */
-int SIMIX_mutex_trylock(smx_mutex_t mutex, smx_process_t issuer)
+bool MutexImpl::try_lock(smx_actor_t issuer)
 {
-  XBT_IN("(%p, %p)",mutex,issuer);
-  if (mutex->locked){
+  XBT_IN("(%p, %p)", this, issuer);
+  if (this->locked) {
     XBT_OUT();
-    return 0;
+    return false;
   }
 
-  mutex->locked = 1;
-  mutex->owner = issuer;
+  this->locked = true;
+  this->owner = issuer;
   XBT_OUT();
-  return 1;
+  return true;
 }
 
-void simcall_HANDLER_mutex_unlock(smx_simcall_t simcall, smx_mutex_t mutex){
-   SIMIX_mutex_unlock(mutex, simcall->issuer);
-}
-/**
- * \brief Unlocks a mutex.
+/** Unlock a mutex for a process
  *
- * Unlocks the mutex and gives it to a process waiting for it. 
+ * 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)
+void MutexImpl::unlock(smx_actor_t issuer)
 {
-  XBT_IN("(%p, %p)",mutex,issuer);
+  XBT_IN("(%p, %p)", this, issuer);
+  if (not this->locked)
+    THROWF(mismatch_error, 0, "Cannot release that mutex: it was not locked.");
 
   /* 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 (issuer != this->owner)
+    THROWF(mismatch_error, 0, "Cannot release that mutex: it was locked by %s (pid:%ld), not by you.",
+           this->owner->cname(), this->owner->pid);
 
-  if (xbt_swag_size(mutex->sleeping) > 0) {
+  if (xbt_swag_size(this->sleeping) > 0) {
     /*process to wake up */
-    smx_process_t p = (smx_process_t) xbt_swag_extract(mutex->sleeping);
-    delete p->waiting_synchro;
-    p->waiting_synchro = NULL;
-    mutex->owner = p;
+    smx_actor_t p = (smx_actor_t) xbt_swag_extract(this->sleeping);
+    p->waiting_synchro = nullptr;
+    this->owner = p;
     SIMIX_simcall_answer(&p->simcall);
   } else {
     /* nobody to wake up */
-    mutex->locked = 0;
-    mutex->owner = NULL;
+    this->locked = false;
+    this->owner = nullptr;
   }
   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)
+}
+}
+
+/** Increase the refcount for this mutex */
+smx_mutex_t SIMIX_mutex_ref(smx_mutex_t mutex)
 {
-  XBT_IN("(%p)",mutex);
-  if (mutex){
-    xbt_swag_free(mutex->sleeping);
-    xbt_free(mutex);
-  }
-  XBT_OUT();
+  if (mutex != nullptr)
+    intrusive_ptr_add_ref(mutex);
+  return mutex;
+}
+
+/** Decrease the refcount for this mutex */
+void SIMIX_mutex_unref(smx_mutex_t mutex)
+{
+  if (mutex != nullptr)
+    intrusive_ptr_release(mutex);
+}
+
+smx_mutex_t simcall_HANDLER_mutex_init(smx_simcall_t simcall)
+{
+  return new simgrid::simix::MutexImpl();
+}
+
+// Simcall handlers:
+
+void simcall_HANDLER_mutex_lock(smx_simcall_t simcall, smx_mutex_t mutex)
+{
+  mutex->lock(simcall->issuer);
+}
+
+int simcall_HANDLER_mutex_trylock(smx_simcall_t simcall, smx_mutex_t mutex)
+{
+  return mutex->try_lock(simcall->issuer);
+}
+
+void simcall_HANDLER_mutex_unlock(smx_simcall_t simcall, smx_mutex_t mutex)
+{
+  mutex->unlock(simcall->issuer);
 }
 
 /********************************* Condition **********************************/
@@ -228,13 +235,13 @@ void SIMIX_mutex_destroy(smx_mutex_t mutex)
  * It have to be called before the use of the condition.
  * \return A condition
  */
-smx_cond_t SIMIX_cond_init(void)
+smx_cond_t SIMIX_cond_init()
 {
   XBT_IN("()");
-  simgrid::simix::Process p;
-  smx_cond_t cond = xbt_new0(s_smx_cond_t, 1);
+  simgrid::simix::ActorImpl p;
+  smx_cond_t cond = new s_smx_cond();
   cond->sleeping = xbt_swag_new(xbt_swag_offset(p, synchro_hookup));
-  cond->mutex = NULL;
+  cond->refcount_ = 1;
   XBT_OUT();
   return cond;
 }
@@ -246,7 +253,7 @@ smx_cond_t SIMIX_cond_init(void)
 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;
+  smx_actor_t issuer = simcall->issuer;
 
   _SIMIX_cond_wait(cond, mutex, -1, issuer, simcall);
   XBT_OUT();
@@ -260,7 +267,7 @@ 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;
+  smx_actor_t issuer = simcall->issuer;
 
   _SIMIX_cond_wait(cond, mutex, timeout, issuer, simcall);
   XBT_OUT();
@@ -268,50 +275,49 @@ void simcall_HANDLER_cond_wait_timeout(smx_simcall_t simcall, smx_cond_t cond,
 
 
 static void _SIMIX_cond_wait(smx_cond_t cond, smx_mutex_t mutex, double timeout,
-                             smx_process_t issuer, smx_simcall_t simcall)
+                             smx_actor_t issuer, smx_simcall_t simcall)
 {
   XBT_IN("(%p, %p, %f, %p,%p)",cond,mutex,timeout,issuer,simcall);
-  smx_synchro_t synchro = NULL;
+  smx_activity_t synchro = nullptr;
 
   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) {
+  if (mutex != nullptr) {
     cond->mutex = mutex;
-    SIMIX_mutex_unlock(mutex, issuer);
+    mutex->unlock(issuer);
   }
 
   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(simcall->issuer, cond->sleeping);   
+  xbt_swag_insert(simcall->issuer, cond->sleeping);
   XBT_OUT();
 }
 
 /**
  * \brief Signalizes a condition.
  *
- * Signalizes a condition and wakes up a sleeping process. 
+ * 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;
+  smx_actor_t proc = nullptr;
+  smx_mutex_t mutex = nullptr;
+  smx_simcall_t simcall = nullptr;
 
   XBT_DEBUG("Signal condition %p", cond);
 
-  /* If there are processes waiting for the condition choose one and try 
+  /* 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))) {
+  if ((proc = (smx_actor_t) xbt_swag_extract(cond->sleeping))) {
 
     /* Destroy waiter's synchronization */
-    delete proc->waiting_synchro;
-    proc->waiting_synchro = NULL;
+    proc->waiting_synchro = nullptr;
 
     /* Now transform the cond wait simcall into a mutex lock one */
     simcall = &proc->simcall;
@@ -345,34 +351,47 @@ void SIMIX_cond_broadcast(smx_cond_t 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)
+smx_cond_t SIMIX_cond_ref(smx_cond_t cond)
+{
+  if (cond != nullptr)
+    intrusive_ptr_add_ref(cond);
+  return cond;
+}
+
+void SIMIX_cond_unref(smx_cond_t cond)
 {
   XBT_IN("(%p)",cond);
   XBT_DEBUG("Destroy condition %p", cond);
+  if (cond != nullptr) {
+    intrusive_ptr_release(cond);
+  }
+  XBT_OUT();
+}
 
-  if (cond != NULL) {
+
+void intrusive_ptr_add_ref(s_smx_cond_t *cond)
+{
+  auto previous = (cond->refcount_)++;
+  xbt_assert(previous != 0);
+}
+
+void intrusive_ptr_release(s_smx_cond_t *cond)
+{
+  auto count = --(cond->refcount_);
+  if (count == 0) {
     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);
+    delete 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);
-  simgrid::simix::Process p;
+  simgrid::simix::ActorImpl p;
 
   smx_sem_t sem = xbt_new0(s_smx_sem_t, 1);
   sem->sleeping = xbt_swag_new(xbt_swag_offset(p, synchro_hookup));
@@ -386,7 +405,7 @@ void SIMIX_sem_destroy(smx_sem_t sem)
 {
   XBT_IN("(%p)",sem);
   XBT_DEBUG("Destroy semaphore %p", sem);
-  if (sem != NULL) {
+  if (sem != nullptr) {
     xbt_assert(xbt_swag_size(sem->sleeping) == 0,
                 "Cannot destroy semaphore since someone is still using it");
     xbt_swag_free(sem->sleeping);
@@ -406,14 +425,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;
+  smx_actor_t proc;
 
   XBT_DEBUG("Sem release semaphore %p", sem);
-  if ((proc = (smx_process_t) xbt_swag_extract(sem->sleeping))) {
-    delete proc->waiting_synchro;
-    proc->waiting_synchro = NULL;
+  if ((proc = (smx_actor_t) xbt_swag_extract(sem->sleeping))) {
+    proc->waiting_synchro = nullptr;
     SIMIX_simcall_answer(&proc->simcall);
-  } else if (sem->value < SMX_SEM_NOLIMIT) {
+  } else {
     sem->value++;
   }
   XBT_OUT();
@@ -438,16 +456,16 @@ 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);
   } else {
@@ -475,7 +493,7 @@ void simcall_HANDLER_sem_acquire(smx_simcall_t simcall, smx_sem_t sem)
 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);  
+  _SIMIX_sem_wait(sem, timeout, simcall->issuer, simcall);
   XBT_OUT();
 }
 int simcall_HANDLER_sem_would_block(smx_simcall_t simcall, smx_sem_t sem) {