Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
Corrections to the code that handles the errors in the comms in SMX network [Cristian]
[simgrid.git] / src / simix / smx_network.c
index 5f40e44..400e8d0 100644 (file)
@@ -9,6 +9,9 @@
 #include "private.h"
 #include "xbt/log.h"
 
+XBT_LOG_NEW_DEFAULT_SUBCATEGORY(simix_network, simix,
+                                "Logging specific to SIMIX (network)");
+
 /******************************************************************************/
 /*                           Rendez-Vous Points                               */
 /******************************************************************************/ 
  *  \param name The name of the rendez-vous point
  *  \return The created rendez-vous point
  */
-smx_rdv_t SIMIX_rdv_create(char *name)
+smx_rdv_t SIMIX_rdv_create(const char *name)
 {
-  smx_rdv_t rvp = xbt_new0(s_smx_rvpoint_t, 1);
-  rvp->name = xbt_strdup(name);
-  rvp->read = SIMIX_mutex_init();
-  rvp->write = SIMIX_mutex_init();
-  rvp->comm_mutex = SIMIX_mutex_init();
-  rvp->comm_fifo = xbt_fifo_new();
-
-  return rvp;
+  smx_rdv_t rdv = xbt_new0(s_smx_rvpoint_t, 1);
+  rdv->name = name ? xbt_strdup(name) : NULL;
+  rdv->read = SIMIX_mutex_init();
+  rdv->write = SIMIX_mutex_init();
+  rdv->comm_fifo = xbt_fifo_new();
+
+  return rdv;
 }
 
 /**
  *  \brief Destroy a rendez-vous point
  *  \param name The rendez-vous point to destroy
  */
-void SIMIX_rdv_destroy(smx_rdv_t rvp)
+void SIMIX_rdv_destroy(smx_rdv_t rdv)
 {
-  xbt_free(rvp->name);
-  SIMIX_mutex_destroy(rvp->read);
-  SIMIX_mutex_destroy(rvp->write);
-  SIMIX_mutex_destroy(rvp->comm_mutex);
-  xbt_fifo_free(rvp->comm_fifo);
-  xbt_free(rvp);
+  if(rdv->name)
+    xbt_free(rdv->name);
+  SIMIX_mutex_destroy(rdv->read);
+  SIMIX_mutex_destroy(rdv->write);
+  xbt_fifo_free(rdv->comm_fifo);
+  xbt_free(rdv);
 }
 
 /**
  *  \brief Push a communication request into a rendez-vous point
- *  The communications request are dequeued by the two functions below
- *  \param rvp The rendez-vous point
+ *  \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)
+{
+  xbt_fifo_push(rdv->comm_fifo, comm);
+}
+
+/**
+ *  \brief Remove a communication request from a rendez-vous point
+ *  \param rdv The rendez-vous point
  *  \param comm The communication request
  */
-static inline void SIMIX_rdv_push(smx_rdv_t rvp, smx_comm_t comm)
+static inline void SIMIX_rdv_remove(smx_rdv_t rdv, smx_comm_t comm)
 {
-  xbt_fifo_push(rvp->comm_fifo, comm);
+  xbt_fifo_remove(rdv->comm_fifo, comm);
 }
+  
 
 /**
  *  \brief Checks if there is a communication request queued in a rendez-vous matching our needs
- *  \param rvp The rendez-vous with the queue
+ *  \param rdv The rendez-vous with the queue
  *  \param look_for_src boolean. True: we are receiver looking for sender; False: other way round
- *  \return The communication request if found, a newly created one otherwise.
+ *  \return The communication request if found, or a newly created one otherwise.
  */
-smx_comm_t SIMIX_rdv_get_request_or_create(smx_rdv_t rvp, int look_for_src) {
-  /* Get a communication request from the rendez-vous queue. If it is a receive
-     request then return it, otherwise put it again in the queue and return NULL
-   */
-  smx_comm_t comm_head = xbt_fifo_shift(rvp->comm_fifo);
-
-  if(comm_head != NULL) {
-    if (( look_for_src && comm_head->src_host != NULL) ||
-        (!look_for_src && comm_head->dst_host != NULL)) {
-
-      SIMIX_communication_use(comm_head);
-      return comm_head;
+smx_comm_t SIMIX_rdv_get_request(smx_rdv_t rdv, int (filter)(smx_comm_t, void*), void *arg) {
+  smx_comm_t comm;
+  xbt_fifo_item_t item;
+
+  /* Traverse the rendez-vous queue looking for a comm request matching the
+     filter conditions. If found return it and remove it from the list. */
+  xbt_fifo_foreach(rdv->comm_fifo, item, comm, smx_comm_t) {
+    if(filter(comm, arg)){
+      SIMIX_communication_use(comm);
+      xbt_fifo_remove_item(rdv->comm_fifo, item);
+      DEBUG1("Communication request found! %p", comm);
+      return comm;
     }
   }
-  xbt_fifo_unshift(rvp->comm_fifo, comm_head);
 
-  /* no relevant peer found. Create a new comm action and set it up */
-  comm_head = SIMIX_communication_new(rvp);
-  SIMIX_rdv_push(rvp, comm_head);
-  SIMIX_communication_use(comm_head);
-
-  return comm_head;
+  /* no relevant request found. Return NULL */
+  DEBUG0("Communication request not found");
+  return NULL;
 }
 
 /******************************************************************************/
@@ -95,14 +103,15 @@ smx_comm_t SIMIX_rdv_get_request_or_create(smx_rdv_t rvp, int look_for_src) {
  *  \param receiver The process receiving the communication (by recv)
  *  \return the communication request
  */  
-smx_comm_t SIMIX_communication_new(smx_rdv_t rdv)
+smx_comm_t SIMIX_communication_new(smx_comm_type_t type, smx_rdv_t rdv)
 {
   /* alloc structures */
   smx_comm_t comm = xbt_new0(s_smx_comm_t, 1);
+  comm->type = type;
   comm->cond = SIMIX_cond_init();
-
   comm->rdv = rdv;
-
+  comm->refcount = 1;
+  
   return comm;
 }
 
@@ -117,9 +126,6 @@ void SIMIX_communication_destroy(smx_comm_t comm)
     if(comm->act != NULL)
       SIMIX_action_destroy(comm->act);
 
-    if(comm->data != NULL)
-      xbt_free(comm->data);
-
     xbt_free(comm->cond);
     xbt_free(comm);
   }
@@ -140,94 +146,183 @@ static inline void SIMIX_communication_use(smx_comm_t comm)
 
 /**
  *  \brief Start the simulation of a communication request
- *  \param comm The communicatino request
+ *  \param comm The communication request
  */
 static inline void SIMIX_communication_start(smx_comm_t comm)
 {
-  comm->act = SIMIX_action_communicate(comm->src_host, comm->dst_host, NULL, 
-      comm->data_size, comm->rate);
-
-  SIMIX_register_action_to_condition(comm->act, comm->cond);
+  /* If both the sender and the receiver are already there, start the communication */
+  if(comm->src_host != NULL && comm->dst_host != NULL){
+    DEBUG1("Starting communication %p", comm);
+    comm->act = SIMIX_action_communicate(comm->src_host, comm->dst_host, NULL, 
+                                         comm->task_size, comm->rate);
+
+    /* Add the communication as user data of the action */
+    comm->act->data = comm;
+    
+    SIMIX_register_action_to_condition(comm->act, comm->cond);
+  }else{
+    DEBUG1("Communication %p cannot be started, peer missing", comm);
+  }
 }
 
-static inline void SIMIX_communication_wait_for_completion(smx_comm_t comm)
+/**
+ *  \brief Waits for communication completion and performs error checking
+ *  \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
+ */
+static inline void SIMIX_communication_wait_for_completion(smx_comm_t comm, double timeout)
 {
-  __SIMIX_cond_wait(comm->cond);
-  if (comm->act) {
-    SIMIX_unregister_action_to_condition(comm->act, comm->cond);
-    SIMIX_action_destroy(comm->act);
-    comm->act=NULL;
+  xbt_ex_t e;
+
+  DEBUG1("Waiting for the completion of communication %p", comm);
+  
+  if(timeout > 0){
+    TRY{
+      SIMIX_cond_wait_timeout(comm->cond, NULL, timeout);
+    }
+    CATCH(e){
+      /* If it's a timeout then cancel the communication and signal the other peer */
+      if(e.category == timeout_error){
+        DEBUG1("Communication timeout! %p", comm);
+        if(comm->act && SIMIX_action_get_state(comm->act) == SURF_ACTION_RUNNING)
+          SIMIX_action_cancel(comm->act);
+        else
+          SIMIX_rdv_remove(comm->rdv, comm);
+          
+        SIMIX_cond_signal(comm->cond);
+        SIMIX_communication_destroy(comm);
+      }
+      RETHROW;
+    }
+  }else{
+    SIMIX_cond_wait(comm->cond, NULL);
   }
+
+  DEBUG1("Communication %p complete! Let's check for errors", comm);
+  
   /* Check for errors */
-  if (SIMIX_host_get_state(comm->dst_host) == 0){
-    THROW1(host_error, 0, "Destination host %s failed", comm->dst_host->name);
-  } else if (SIMIX_host_get_state(comm->src_host) == 0){
-    THROW1(host_error, 0, "Source host %s failed", comm->src_host->name);
-  } else if (SIMIX_action_get_state(comm->act) == SURF_ACTION_FAILED) {
+  if(!SIMIX_host_get_state(SIMIX_host_self())){
+    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");
   }
 
+  SIMIX_unregister_action_to_condition(comm->act, comm->cond);
+}
+
+/**
+ *  \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 src_buff_size = comm->src_buff_size;
+  size_t dst_buff_size = *comm->dst_buff_size;
+
+  /* Copy at most dst_buff_size bytes of the message to receiver's buffer */
+  dst_buff_size = MIN(dst_buff_size, src_buff_size);
+
+  /* Update the receiver's buffer size to the copied amount */
+  *comm->dst_buff_size = dst_buff_size;
+
+  memcpy(comm->dst_buff, comm->src_buff, dst_buff_size);
+
+  DEBUG4("Copying comm %p data from %s -> %s (%zu bytes)", 
+         comm, comm->src_host->name, comm->dst_host->name, dst_buff_size);
+}
+
+/* FIXME: move to some other place */
+int comm_filter_get(smx_comm_t comm, void *arg)
+{
+  if(comm->type == comm_send){
+    if(arg && comm->src_host != (smx_host_t)arg)
+     return FALSE;
+    else
+     return TRUE;
+  }else{
+    return FALSE;
+  }
+}
+
+int comm_filter_put(smx_comm_t comm, void *arg)
+{
+  return comm->type == comm_recv ? TRUE : FALSE;
 }
 /******************************************************************************/
 /*                        Synchronous Communication                           */
 /******************************************************************************/
-/* Throws:
- *  - host_error if peer failed
- *  - network_error if network failed */
-
-void SIMIX_network_send(smx_rdv_t rdv, void *data, size_t size, double timeout, double rate)
+/*  Throws:
+ *   - host_error if peer failed
+ *   - timeout_error if communication reached the timeout specified
+ *   - network_error if network failed or peer issued a timeout
+ */
+void SIMIX_network_send(smx_rdv_t rdv, double task_size, double rate, 
+                        double timeout, void *data, size_t data_size,
+                        int (filter)(smx_comm_t, void *), void *arg)
 {
-  /*double start_time = SIMIX_get_clock();*/
-  void *smx_net_data;
   smx_comm_t comm;
+  
+  /* 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, filter, arg);
+
+  if(comm == NULL){
+    comm = SIMIX_communication_new(comm_send, rdv);
+    SIMIX_rdv_push(rdv, comm);
+  }
 
-  /* Copy the message to the network */
-  /*FIXME here the MC should allocate the space from the network storage area */
-  smx_net_data = xbt_malloc(size);
-  memcpy(smx_net_data, data, size);
-
-  comm = SIMIX_rdv_get_request_or_create(rdv,0);
+  /* Setup the communication request */
   comm->src_host = SIMIX_host_self();
-  comm->data = smx_net_data;
-  comm->data_size = size;
+  comm->task_size = task_size;
   comm->rate = rate;
+  comm->src_buff = data;
+  comm->src_buff_size = data_size;
 
-  /* If the receiver is already there, start the communication */
-  /* If it's not here already, it will start that communication itself later on */
-  if(comm->dst_host != NULL)
-    SIMIX_communication_start(comm);
+  SIMIX_communication_start(comm);
 
   /* Wait for communication completion */
   /* FIXME: if the semantic is non blocking, it shouldn't wait on the condition here */
-  /* FIXME: add timeout checking stuff */
-  SIMIX_communication_wait_for_completion(comm);
+  SIMIX_communication_wait_for_completion(comm, timeout);
 
   SIMIX_communication_destroy(comm);
 }
 
-void SIMIX_network_recv(smx_rdv_t rdv, void **data, size_t *size, double timeout)
+/*  Throws:
+ *   - host_error if peer failed
+ *   - timeout_error if communication reached the timeout specified
+ *   - network_error if network failed or peer issued a timeout
+ */
+void SIMIX_network_recv(smx_rdv_t rdv, double timeout, void *data, 
+                        size_t *data_size, int (filter)(smx_comm_t, void *), void *arg)
 {
-  /*double start_time = SIMIX_get_clock();*/
   smx_comm_t comm;
-  smx_host_t my_host = SIMIX_host_self();
 
-  comm = SIMIX_rdv_get_request_or_create(rdv,1);
+  /* 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, filter, arg);
+
+  if(comm == NULL){
+    comm = SIMIX_communication_new(comm_recv, rdv);
+    SIMIX_rdv_push(rdv, comm);
+  }
+
+  /* Setup communication request */
   comm->dst_host = SIMIX_host_self();
-  comm->dest_buff = data;
+  comm->dst_buff = data;
+  comm->dst_buff_size = data_size;
 
-  /* If the sender is already there, start the communication */
-  /* If it's not here already, it will start that communication itself later on */
-  if (comm->src_host != NULL)
-    SIMIX_communication_start(comm);
+  SIMIX_communication_start(comm);
 
   /* Wait for communication completion */
   /* FIXME: if the semantic is non blocking, it shouldn't wait on the condition here */
-  /* FIXME: add timeout checking stuff */
-  SIMIX_communication_wait_for_completion(comm);
-
-  /* We are OK, let's copy the message to receiver's buffer */
-  *size = *size < comm->data_size ? *size : comm->data_size;
-  memcpy(*data, comm->data, *size);
+  SIMIX_communication_wait_for_completion(comm, timeout);
 
   SIMIX_communication_destroy(comm);
 }
@@ -240,9 +335,9 @@ void SIMIX_network_recv(smx_rdv_t rdv, void **data, size_t *size, double timeout
 void SIMIX_network_wait(smx_action_t comm, double timeout)
 {
     if (timeout > 0)
-      SIMIX_cond_wait_timeout(rvp_cond, rvp_comm_mutex, timeout - start_time);
+      SIMIX_cond_wait_timeout(rdv_cond, rdv_comm_mutex, timeout - start_time);
     else
-      SIMIX_cond_wait(rvp_cond, rvp_comm_mutex);    
+      SIMIX_cond_wait(rdv_cond, rdv_comm_mutex);    
 
 }