Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
prevents from adding invalid pointer to the dict
[simgrid.git] / src / simix / smx_network.c
index 465fba7..8c8b16d 100644 (file)
@@ -11,6 +11,7 @@
 
 /* Pimple to get an histogram of message sizes in the simulation */
 xbt_dict_t msg_sizes = NULL;
+xbt_dict_t latency_limited_dict = NULL;
 
 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(simix_network, simix,
                                 "Logging specific to SIMIX (network)");
@@ -54,7 +55,7 @@ void SIMIX_rdv_destroy(smx_rdv_t rdv)
  *  \param rdv The rendez-vous point
  *  \param comm The communication request
  */
-static inline void SIMIX_rdv_push(smx_rdv_t rdv, smx_comm_t comm)
+static XBT_INLINE void SIMIX_rdv_push(smx_rdv_t rdv, smx_comm_t comm)
 {
   xbt_fifo_push(rdv->comm_fifo, comm);
   comm->rdv = rdv;
@@ -65,7 +66,7 @@ static inline void SIMIX_rdv_push(smx_rdv_t rdv, smx_comm_t comm)
  *  \param rdv The rendez-vous point
  *  \param comm The communication request
  */
-static inline void SIMIX_rdv_remove(smx_rdv_t rdv, smx_comm_t comm)
+static XBT_INLINE void SIMIX_rdv_remove(smx_rdv_t rdv, smx_comm_t comm)
 {
   xbt_fifo_remove(rdv->comm_fifo, comm);
   comm->rdv = NULL;
@@ -159,6 +160,17 @@ smx_comm_t SIMIX_communication_new(smx_comm_type_t type)
  */
 void SIMIX_communication_destroy(smx_comm_t comm)
 {
+  VERB2("Destroy communication %p; refcount initially %d",comm,comm->refcount);
+
+  //save is latency limited flag to use afterwards
+  if (latency_limited_dict == NULL) {
+         latency_limited_dict = xbt_dict_new();
+  }
+  if (comm->act){
+    DEBUG2("adding key %p with latency limited value %d to the dict", comm, SIMIX_action_is_latency_bounded(comm->act));
+    xbt_dicti_set(latency_limited_dict, (uintptr_t)comm, SIMIX_action_is_latency_bounded(comm->act));
+  }
+
   comm->refcount--;
   if(comm->refcount > 0)
     return;
@@ -183,6 +195,8 @@ void SIMIX_communication_destroy(smx_comm_t comm)
       comm->dst_timeout = NULL;
     }
 
+
+
   xbt_free(comm);
 }
 
@@ -194,7 +208,7 @@ void SIMIX_communication_destroy(smx_comm_t comm)
  *  maybe is in use by others.
  *  \
  */
-static inline void SIMIX_communication_use(smx_comm_t comm)
+static XBT_INLINE void SIMIX_communication_use(smx_comm_t comm)
 {
   comm->refcount++;
 }
@@ -203,7 +217,7 @@ static inline void SIMIX_communication_use(smx_comm_t comm)
  *  \brief Start the simulation of a communication request
  *  \param comm The communication request
  */
-static inline void SIMIX_communication_start(smx_comm_t comm)
+static XBT_INLINE void SIMIX_communication_start(smx_comm_t comm)
 {
   /* If both the sender and the receiver are already there, start the communication */
   if(comm->src_proc && comm->dst_proc){
@@ -233,7 +247,44 @@ static inline void SIMIX_communication_start(smx_comm_t comm)
 }
 
 /**
- *  \brief Waits for communication completion and performs error checking
+ * \brief Performs error checking and cleanup
+ * \param comm The communication
+ */
+static XBT_INLINE void SIMIX_communication_cleanup(smx_comm_t comm)
+{
+  DEBUG1("Checking errors and cleaning communication %p", comm);
+
+  /* Make sure that everyone sleeping on that semaphore is awake, and that nobody will ever block on it */
+  SIMIX_sem_release_forever(comm->sem);
+  
+  /* Check for errors other than timeouts */
+  if (!SIMIX_host_get_state(SIMIX_host_self())){
+    if(comm->rdv)
+      SIMIX_rdv_remove(comm->rdv, comm);
+         SIMIX_communication_destroy(comm);
+    THROW0(host_error, 0, "Host failed");
+  } else if (SIMIX_action_get_state(comm->act) == SURF_ACTION_FAILED){
+    SIMIX_communication_destroy(comm);
+    THROW0(network_error, 0, "Link failure");
+  } else if (!SIMIX_host_get_state(SIMIX_process_get_host(comm->dst_proc)) ||
+      !SIMIX_host_get_state(SIMIX_process_get_host(comm->src_proc))) {
+    /* We test both src&dst because we dunno who we are today, and we already tested myself above.
+     *    So, at the end, we test the remote peer only
+     * Moreover, we have to test it because if the remote peer fails, the action comm->act is not done nor failed.
+     *    In that case, we got awaken by the little endless actions created in the SIMIX_sem_acquire(comm->sem)
+     *    at the beginning of this function. */
+    SIMIX_communication_destroy(comm);
+    THROW0(network_error, 0, "Remote peer failed");
+
+  }
+  /* Copy network data */
+  SIMIX_network_copy_data(comm);  
+
+  SIMIX_communication_destroy(comm);
+}
+
+/**
+ *  \brief Waits for communication completion
  *  \param comm The communication
  *  \param timeout The max amount of time to wait for the communication to finish
  *
@@ -242,7 +293,7 @@ static inline void SIMIX_communication_start(smx_comm_t comm)
  *   - timeout_error if communication reached the timeout specified (either because of local peer or remote peer)
  *   - network_error if network failed or remote peer failed
  */
-static inline void SIMIX_communication_wait_for_completion(smx_comm_t comm, double timeout)
+static XBT_INLINE void SIMIX_communication_wait_for_completion(smx_comm_t comm, double timeout)
 {
   smx_action_t act_sleep = NULL;
   int src_timeout = 0;
@@ -285,32 +336,8 @@ static inline void SIMIX_communication_wait_for_completion(smx_comm_t comm, doub
     THROW1(timeout_error, 0, "Communication timeouted because of %s",src_timeout?"the source":"the destination");
   }
 
-  DEBUG1("Communication %p complete! Let's check for errors", comm);
-
-  /* Make sure that everyone sleeping on that semaphore is awake, and that nobody will ever block on it */
-  SIMIX_sem_release_forever(comm->sem);
-  
-  /* Check for errors other than timeouts (they are catched above) */
-  if (!SIMIX_host_get_state(SIMIX_host_self())){
-    if(comm->rdv)
-      SIMIX_rdv_remove(comm->rdv, comm);
-    SIMIX_communication_destroy(comm);
-    THROW0(host_error, 0, "Host failed");
-  } else if (SIMIX_action_get_state(comm->act) == SURF_ACTION_FAILED){
-    SIMIX_communication_destroy(comm);
-    THROW0(network_error, 0, "Link failure");
-  } else if (!SIMIX_host_get_state(SIMIX_process_get_host(comm->dst_proc)) ||
-      !SIMIX_host_get_state(SIMIX_process_get_host(comm->src_proc))) {
-    /* We test both src&dst because we dunno who we are today, and we already tested myself above.
-     *    So, at the end, we test the remote peer only
-     * Moreover, we have to test it because if the remote peer fails, the action comm->act is not done nor failed.
-     *    In that case, we got awaken by the little endless actions created in the SIMIX_sem_acquire(comm->sem)
-     *    at the beginning of this function. */
-    SIMIX_communication_destroy(comm);
-    THROW0(network_error, 0, "Remote peer failed");
-
-  }
-  SIMIX_communication_destroy(comm);
+  DEBUG1("Communication %p complete!", comm);
+  SIMIX_communication_cleanup(comm);
 }
 
 /**
@@ -329,9 +356,32 @@ XBT_INLINE void SIMIX_communication_cancel(smx_comm_t comm)
  */
 XBT_INLINE double SIMIX_communication_get_remains(smx_comm_t comm)
 {
+  DEBUG1("calling SIMIX_action_get_remains(%p)", comm->act);
   return SIMIX_action_get_remains(comm->act);
 }  
 
+/**
+ *  \brief verify if communication is latency bounded
+ *  \param comm The communication
+ */
+XBT_INLINE int SIMIX_communication_is_latency_bounded(smx_comm_t comm)
+{
+  //try to find comm on the list of finished flows
+  uintptr_t key = 0;
+  uintptr_t data = 0;
+  xbt_dict_cursor_t cursor;
+  xbt_dict_foreach(latency_limited_dict,cursor,key,data) {
+    DEBUG2("comparing key=%p with comm=%p", (void*)key, (void*)comm);
+       if((void*)comm == (void*)key){
+               DEBUG2("key %p found, return value latency limited value %d", (void*)key, (int)data);
+               return (int)data;
+       }
+  }
+
+  DEBUG1("calling SIMIX_action_is_latency_bounded(%p)", comm->act);
+  return SIMIX_action_is_latency_bounded(comm->act);
+}
+
 /******************************************************************************/
 /*                    SIMIX_network_copy_data callbacks                       */
 /******************************************************************************/
@@ -357,6 +407,11 @@ void SIMIX_network_copy_buffer_callback(smx_comm_t comm, size_t buff_size) {
 void SIMIX_network_copy_data(smx_comm_t comm)
 {
   size_t buff_size = comm->src_buff_size;
+  uintptr_t casted_size = 0;
+  uintptr_t amount = 0;
+  /* If there is no data to be copy then return */
+  if(!comm->src_buff || !comm->dst_buff || comm->copied == 1)
+    return;
 
   DEBUG6("Copying comm %p data from %s (%p) -> %s (%p) (%zu bytes)",
       comm,
@@ -364,10 +419,6 @@ void SIMIX_network_copy_data(smx_comm_t comm)
       comm->dst_proc->smx_host->name, comm->dst_buff,
       buff_size);
 
-  /* If there is no data to be copy then return */
-  if(!comm->src_buff || !comm->dst_buff)
-    return;
-  
   /* Copy at most dst_buff_size bytes of the message to receiver's buffer */
   if (comm->dst_buff_size)
     buff_size = MIN(buff_size,*(comm->dst_buff_size));
@@ -380,12 +431,16 @@ void SIMIX_network_copy_data(smx_comm_t comm)
     return;
   (*SIMIX_network_copy_data_callback)(comm, buff_size);
 
+  /* Set the copied flag so we copy data only once */
+  /* (this function might be called from both communication ends)*/
+  comm->copied = 1;
+  
   /* pimple to display the message sizes */
   {
     if (msg_sizes == NULL)
       msg_sizes = xbt_dict_new();
-    uintptr_t casted_size = comm->task_size;
-    uintptr_t amount = xbt_dicti_get(msg_sizes, casted_size);
+    casted_size = comm->task_size;
+    amount = xbt_dicti_get(msg_sizes, casted_size);
     amount++;
 
     xbt_dicti_set(msg_sizes,casted_size, amount);
@@ -394,10 +449,13 @@ void SIMIX_network_copy_data(smx_comm_t comm)
 #include "xbt.h"
 /* pimple to display the message sizes */
 void SIMIX_message_sizes_output(const char *filename) {
-  FILE * out = fopen(filename,"w");
-  xbt_assert1(out,"Cannot open file %s",filename);
-  uintptr_t key,data;
+  uintptr_t key = 0;
+  uintptr_t data = 0;
   xbt_dict_cursor_t cursor;
+  FILE * out = NULL;
+  out = fopen(filename,"w");
+  xbt_assert1(out,"Cannot open file %s",filename);
+
   xbt_dict_foreach(msg_sizes,cursor,key,data) {
     fprintf(out,"%zu %zu\n",key,data);
   }
@@ -414,6 +472,23 @@ XBT_INLINE void *SIMIX_communication_get_data(smx_comm_t comm)
   return comm->data;
 }
 
+XBT_PUBLIC(void *) SIMIX_communication_get_src_buf(smx_comm_t comm)
+{
+  return comm->src_buff;
+}
+XBT_PUBLIC(void *) SIMIX_communication_get_dst_buf(smx_comm_t comm)
+{
+  return comm->dst_buff;
+}
+XBT_PUBLIC(size_t) SIMIX_communication_get_src_buf_size(smx_comm_t comm)
+{
+  return comm->src_buff_size;
+}
+XBT_PUBLIC(size_t) SIMIX_communication_get_dst_buf_size(smx_comm_t comm)
+{
+  return *(comm->dst_buff_size);
+}
+
 /******************************************************************************/
 /*                        Synchronous Communication                           */
 /******************************************************************************/
@@ -457,7 +532,7 @@ XBT_INLINE void SIMIX_network_send(smx_rdv_t rdv, double task_size, double rate,
 XBT_INLINE void SIMIX_network_recv(smx_rdv_t rdv, double timeout, void *dst_buff,
                         size_t *dst_buff_size, smx_comm_t *comm_ref)
 {
-  *comm_ref = SIMIX_network_irecv(rdv,dst_buff,dst_buff_size);
+  *comm_ref = (smx_comm_t) SIMIX_network_irecv(rdv,dst_buff,dst_buff_size);
   SIMIX_network_wait(*comm_ref,timeout);
 }
 
@@ -468,14 +543,12 @@ smx_comm_t SIMIX_network_isend(smx_rdv_t rdv, double task_size, double rate,
     void *src_buff, size_t src_buff_size, void *data)
 {
   smx_comm_t comm;
-  mc_transition_t trans=NULL;
 
-  if (_surf_do_model_check) {
-    /* Let's intercept the communication and control it from the model-checker */
-    trans = MC_create_transition(mc_isend, SIMIX_process_self(), rdv, NULL);
-    SIMIX_process_yield();
-  }
-  
+  /*If running in model-checking mode then intercept the communication action*/
+       #ifdef HAVE_MC
+         if (_surf_do_model_check)
+               MC_trans_intercept_isend(rdv);
+       #endif
   /* Look for communication request matching our needs.
      If it is not found then create it and push it into the rendez-vous point */
   comm = SIMIX_rdv_get_request(rdv, comm_recv);
@@ -492,27 +565,23 @@ smx_comm_t SIMIX_network_isend(smx_rdv_t rdv, double task_size, double rate,
   comm->src_buff = src_buff;
   comm->src_buff_size = src_buff_size;
   comm->data = data;
-
-  /* Associate the simix communication to the mc transition */
-  if (_surf_do_model_check)
-    MC_transition_set_comm(trans, comm);
   
   SIMIX_communication_start(comm);
   return comm;
 }
 
-smx_comm_t SIMIX_network_irecv(smx_rdv_t rdv, void *dst_buff, size_t *dst_buff_size) {
+smx_comm_t SIMIX_network_irecv(smx_rdv_t rdv, void *dst_buff, size_t *dst_buff_size)
+{
   smx_comm_t comm;
-  mc_transition_t trans=NULL;
-  
-  if (_surf_do_model_check) {
-    /* Let's intercept the communication and control it from the model-checker */
-    trans = MC_create_transition(mc_irecv, SIMIX_process_self(), rdv, NULL);
-    SIMIX_process_yield();
-  }
-  
+
+  /*If running in model-checking mode then intercept the communication action*/
+#ifdef HAVE_MC
+  if (_surf_do_model_check)
+    MC_trans_intercept_irecv(rdv);
+#endif
   /* Look for communication request matching our needs.
-     If it is not found then create it and push it into the rendez-vous point */
+   * If it is not found then create it and push it into the rendez-vous point
+   */
   comm = SIMIX_rdv_get_request(rdv, comm_send);
 
   if(!comm){
@@ -524,78 +593,71 @@ smx_comm_t SIMIX_network_irecv(smx_rdv_t rdv, void *dst_buff, size_t *dst_buff_s
   comm->dst_proc = SIMIX_process_self();
   comm->dst_buff = dst_buff;
   comm->dst_buff_size = dst_buff_size;
-
-  /* Associate the simix communication to the mc transition */
-  if (_surf_do_model_check)
-    MC_transition_set_comm(trans, comm);
  
   SIMIX_communication_start(comm);
   return comm;
 }
 
 /** @brief blocks until the communication terminates or the timeout occurs */
-XBT_INLINE void SIMIX_network_wait(smx_comm_t comm, double timeout) {
-  if (_surf_do_model_check) {
-    /* Let's intercept the communication and control it from the model-checker */
-    MC_create_transition(mc_wait, SIMIX_process_self(), comm->rdv, comm);
-    SIMIX_process_yield();
-  }
+XBT_INLINE void SIMIX_network_wait(smx_comm_t comm, double timeout)
+{
+  /*If running in model-checking mode then intercept the communication action*/
+#ifdef HAVE_MC
+  if (_surf_do_model_check)
+    MC_trans_intercept_wait(comm);
+#endif
   /* Wait for communication completion */
   SIMIX_communication_wait_for_completion(comm, timeout);
 }
 
 /** @Returns whether the (asynchronous) communication is done yet or not */
-XBT_INLINE int SIMIX_network_test(smx_comm_t comm) {
-  if (_surf_do_model_check) {
-    /* Let's intercept the communication and control it from the model-checker */
-    MC_create_transition(mc_test, SIMIX_process_self(), comm->rdv, comm);
-    SIMIX_process_yield();
+XBT_INLINE int SIMIX_network_test(smx_comm_t comm)
+{
+  /*If running in model-checking mode then intercept the communication action*/
+#ifdef HAVE_MC
+  if (_surf_do_model_check)
+    MC_trans_intercept_test(comm);
+#endif
+
+  /* Copy data if the communication is done */
+  if(comm->sem && !SIMIX_sem_would_block(comm->sem)){
+    /* Copy network data */
+    SIMIX_network_copy_data(comm);
+    return TRUE;
   }
-  return comm->sem?SIMIX_sem_would_block(comm->sem):0;
+  return FALSE;
 }
 
 /** @brief wait for the completion of any communication of a set
  *
  *  @Returns the rank in the dynar of communication which finished; destroy it after identifying which one it is
  */
-unsigned int SIMIX_network_waitany(xbt_dynar_t comms) {
+unsigned int SIMIX_network_waitany(xbt_dynar_t comms)
+{
   xbt_dynar_t sems = xbt_dynar_new(sizeof(smx_sem_t),NULL);
   unsigned int cursor, found_comm=-1;
   smx_comm_t comm,comm_finished=NULL;
 
-  if (_surf_do_model_check) {
-    /* Let's intercept the communication and control it from the model-checker */
-    MC_create_transition(mc_waitany, SIMIX_process_self(), NULL, NULL);
-    SIMIX_process_yield();
-  }
-  
-  xbt_dynar_foreach(comms,cursor,comm){
+  /*If running in model-checking mode then intercept the communication action*/
+#ifdef HAVE_MC
+  if (_surf_do_model_check)
+    MC_trans_intercept_waitany(comms);
+#endif
+  xbt_dynar_foreach(comms,cursor,comm)
     xbt_dynar_push(sems,&(comm->sem));
-  }
 
   DEBUG1("Waiting for the completion of communication set %p", comms);
 
   found_comm = SIMIX_sem_acquire_any(sems);
+  xbt_dynar_free_container(&sems);
   xbt_assert0(found_comm!=-1,"Cannot find which communication finished");
   xbt_dynar_get_cpy(comms,found_comm,&comm_finished);
 
-  DEBUG1("Communication %p complete! Let's check for errors", comm_finished);
+  DEBUG2("Communication %p of communication set %p finished", comm_finished, comms);
 
-  /* Make sure that everyone sleeping on that semaphore is awake,
-   * and that nobody will ever block on it */
+  /* let the regular code deal with the communication end (errors checking and cleanup).
+   * A bit of useless work will be done, but that's good for source factorization */
   SIMIX_sem_release_forever(comm_finished->sem);
-
-  /* Check for errors */
-  if(!SIMIX_host_get_state(SIMIX_host_self())){
-    if(comm_finished->rdv)
-      SIMIX_rdv_remove(comm_finished->rdv, comm_finished);
-    SIMIX_communication_destroy(comm_finished);
-    THROW0(host_error, 0, "Host failed");
-  } else if (SIMIX_action_get_state(comm_finished->act) == SURF_ACTION_FAILED){
-    SIMIX_communication_destroy(comm_finished);
-    THROW0(network_error, 0, "Link failure");
-  }
-  SIMIX_communication_destroy(comm_finished);
-
+  SIMIX_communication_wait_for_completion(comm_finished, -1);
   return found_comm;
 }