Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
correction to compile with warning and th indentation in my files
[simgrid.git] / src / simix / smx_network.c
index a1bb927..5e3bf6f 100644 (file)
@@ -1,13 +1,16 @@
-/*     $Id$     */
-
-/* Copyright (c) 2009 Cristian Rosa.
-   All rights reserved.                                          */
+/* Copyright (c) 2009, 2010. 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 "private.h"
 #include "xbt/log.h"
+#include "mc/mc.h"
+#include "xbt/dict.h"
+
+/* Pimple to get an histogram of message sizes in the simulation */
+xbt_dict_t msg_sizes = NULL;
 
 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(simix_network, simix,
                                 "Logging specific to SIMIX (network)");
@@ -51,7 +54,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;
@@ -62,7 +65,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;
@@ -81,7 +84,7 @@ smx_comm_t SIMIX_rdv_get_request(smx_rdv_t rdv, smx_comm_type_t type) {
     DEBUG0("Communication request found!");
     xbt_fifo_shift(rdv->comm_fifo);
     SIMIX_communication_use(comm);
-    comm->rdv = NULL;    
+    comm->rdv = NULL;
     return comm;
   }
 
@@ -156,6 +159,7 @@ 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);
   comm->refcount--;
   if(comm->refcount > 0)
     return;
@@ -191,16 +195,16 @@ 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++;
 }
 
 /**
  *  \brief Start the simulation of a communication request
- *  \param comm The   comm->rdv = NULL;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){
@@ -208,12 +212,15 @@ static inline void SIMIX_communication_start(smx_comm_t comm)
     comm->act = SIMIX_action_communicate(comm->src_proc->smx_host, 
                                          comm->dst_proc->smx_host, NULL, 
                                          comm->task_size, comm->rate);
+#ifdef HAVE_TRACING
+    TRACE_smx_action_communicate (comm->act, comm->src_proc);
+#endif
 
     /* If any of the process is suspend, create the action but stop its execution,
        it will be restarted when the sender process resume */
     if(SIMIX_process_is_suspended(comm->src_proc) || 
        SIMIX_process_is_suspended(comm->dst_proc)) {
-      SIMIX_action_set_priority(comm->act, 0);
+      SIMIX_action_suspend(comm->act);
     }
     
     /* Add the communication as user data of the action */
@@ -227,16 +234,53 @@ 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
  *
  *  Throws:
- *   - host_error if peer failed
- *   - timeout_error if communication reached the timeout specified
- *   - network_error if network failed or peer issued a timeout
+ *   - host_error if local peer failed
+ *   - 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;
@@ -279,21 +323,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");
-  }
+  DEBUG1("Communication %p complete!", comm);
+  SIMIX_communication_cleanup(comm);
 }
 
 /**
@@ -315,18 +346,44 @@ XBT_INLINE double SIMIX_communication_get_remains(smx_comm_t comm)
   return SIMIX_action_get_remains(comm->act);
 }  
 
+/******************************************************************************/
+/*                    SIMIX_network_copy_data callbacks                       */
+/******************************************************************************/
+static void (*SIMIX_network_copy_data_callback)(smx_comm_t, size_t) = &SIMIX_network_copy_pointer_callback;
+
+void SIMIX_network_set_copy_data_callback(void (*callback)(smx_comm_t, size_t)) {
+  SIMIX_network_copy_data_callback = callback;
+}
+
+void SIMIX_network_copy_pointer_callback(smx_comm_t comm, size_t buff_size) {
+  xbt_assert1((buff_size == sizeof(void*)), "Cannot copy %zu bytes: must be sizeof(void*)",buff_size);
+  *(void**)(comm->dst_buff) = comm->src_buff;
+}
+
+void SIMIX_network_copy_buffer_callback(smx_comm_t comm, size_t buff_size) {
+  memcpy(comm->dst_buff, comm->src_buff, buff_size);
+}
+
 /**
  *  \brief Copy the communication data from the sender's buffer to the receiver's one
  *  \param comm The communication
  */
 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)
+  if(!comm->src_buff || !comm->dst_buff || comm->copied == 1)
     return;
-  
+
+  DEBUG6("Copying comm %p data from %s (%p) -> %s (%p) (%zu bytes)",
+      comm,
+      comm->src_proc->smx_host->name, comm->src_buff,
+      comm->dst_proc->smx_host->name, comm->dst_buff,
+      buff_size);
+
   /* Copy at most dst_buff_size bytes of the message to receiver's buffer */
-  size_t buff_size = comm->src_buff_size;
   if (comm->dst_buff_size)
     buff_size = MIN(buff_size,*(comm->dst_buff_size));
   
@@ -336,28 +393,37 @@ void SIMIX_network_copy_data(smx_comm_t comm)
 
   if(buff_size == 0)
     return;
+  (*SIMIX_network_copy_data_callback)(comm, buff_size);
 
-#ifdef HAVE_RUBY /* FIXME: KILLME */
-  INFO6("Copying comm %p data from %s (%p) -> %s (%p) (%zu bytes)",
-      comm,
-      comm->src_proc->smx_host->name, comm->src_buff,
-      comm->dst_proc->smx_host->name, comm->dst_buff,
-      buff_size);
-#else
-  DEBUG6("Copying comm %p data from %s (%p) -> %s (%p) (%zu bytes)",
-      comm,
-      comm->src_proc->smx_host->name, comm->src_buff,
-      comm->dst_proc->smx_host->name, comm->dst_buff,
-      buff_size);
-#endif
-
-  xbt_assert1((buff_size == sizeof(void*)), "Cannot copy %d bytes: must be sizeof(void*)",buff_size);
-  //FIXME: cleanup
-//  if  {
-    *(void**)(comm->dst_buff) = (comm->src_buff);
-/*  } else {
-    memcpy(comm->dst_buff, comm->src_buff, 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();
+    casted_size = comm->task_size;
+    amount = xbt_dicti_get(msg_sizes, casted_size);
+    amount++;
+
+    xbt_dicti_set(msg_sizes,casted_size, amount);
+  }
+}
+#include "xbt.h"
+/* pimple to display the message sizes */
+void SIMIX_message_sizes_output(const char *filename) {
+  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);
+  }
+  fclose(out);
 }
 
 /**
@@ -370,6 +436,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 (void *)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                           */
 /******************************************************************************/
@@ -413,7 +496,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);
 }
 
@@ -425,6 +508,11 @@ smx_comm_t SIMIX_network_isend(smx_rdv_t rdv, double task_size, double rate,
 {
   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_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);
@@ -441,16 +529,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;
-
+  
   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;
 
+  /*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){
@@ -462,59 +557,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;
-
   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) {
+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);
-
-  SIMIX_communication_destroy(comm);
 }
 
 /** @Returns whether the (asynchronous) communication is done yet or not */
-XBT_INLINE int SIMIX_network_test(smx_comm_t comm) {
-  return comm->sem?SIMIX_sem_would_block(comm->sem):0;
+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 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;
 
-  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_wait_for_completion(comm_finished, -1);
   return found_comm;
 }