Fix a compilation problem with dsend and Chord

[simgrid.git] / src / msg / gos.c

diff --git a/src/msg/gos.c b/src/msg/gos.c
index bb22ab2..8093c97 100644 (file)
--- a/src/msg/gos.c
+++ b/src/msg/gos.c
@@ -38,6 +38,7 @@ MSG_error_t MSG_task_execute(m_task_t task)
 {
   simdata_task_t simdata = NULL;
   m_process_t self = MSG_process_self();
+  e_smx_state_t comp_state;
   CHECK_HOST();
 
   simdata = task->simdata;
@@ -49,9 +50,9 @@ MSG_error_t MSG_task_execute(m_task_t task)
   TRACE_msg_task_execute_start(task);
 #endif
 
-  xbt_assert1((!simdata->compute) && (task->simdata->refcount == 1),
+  xbt_assert1((!simdata->compute) && (task->simdata->isused == 0),
               "This task is executed somewhere else. Go fix your code! %d",
-              task->simdata->refcount);
+              task->simdata->isused);
 
   DEBUG1("Computing on %s", MSG_process_self()->simdata->m_host->name);
 
@@ -61,22 +62,24 @@ MSG_error_t MSG_task_execute(m_task_t task)
 #endif
     return MSG_OK;
   }
-  simdata->refcount++;
+  simdata->isused=1;
   simdata->compute =
       SIMIX_req_host_execute(task->name, SIMIX_host_self(),
-                           simdata->computation_amount);
-  SIMIX_req_host_execution_set_priority(simdata->compute, simdata->priority);
+                           simdata->computation_amount,
+                           simdata->priority);
+#ifdef HAVE_TRACING
+  SIMIX_req_set_category(simdata->compute, task->category);
+#endif
 
   self->simdata->waiting_action = simdata->compute;
-  SIMIX_req_host_execution_wait(simdata->compute);
+  comp_state = SIMIX_req_host_execution_wait(simdata->compute);
   self->simdata->waiting_action = NULL;
 
-  simdata->refcount--;
+  simdata->isused=0;
 
-  DEBUG2("Execution task '%s' finished in state %d", task->name, SIMIX_req_host_execution_get_state(task->simdata->compute));
-  if (SIMIX_req_host_execution_get_state(task->simdata->compute) == SIMIX_DONE) {
+  DEBUG2("Execution task '%s' finished in state %d", task->name, comp_state);
+  if (comp_state == SIMIX_DONE) {
     /* action ended, set comm and compute = NULL, the actions is already destroyed in the main function */
-    SIMIX_req_host_execution_destroy(task->simdata->compute);
     simdata->computation_amount = 0.0;
     simdata->comm = NULL;
     simdata->compute = NULL;
@@ -86,7 +89,6 @@ MSG_error_t MSG_task_execute(m_task_t task)
     MSG_RETURN(MSG_OK);
   } else if (SIMIX_req_host_get_state(SIMIX_host_self()) == 0) {
     /* action ended, set comm and compute = NULL, the actions is already destroyed in the main function */
-    SIMIX_req_host_execution_destroy(task->simdata->compute);
     simdata->comm = NULL;
     simdata->compute = NULL;
 #ifdef HAVE_TRACING
@@ -95,7 +97,6 @@ MSG_error_t MSG_task_execute(m_task_t task)
     MSG_RETURN(MSG_HOST_FAILURE);
   } else {
     /* action ended, set comm and compute = NULL, the actions is already destroyed in the main function */
-    SIMIX_req_host_execution_destroy(task->simdata->compute);
     simdata->comm = NULL;
     simdata->compute = NULL;
 #ifdef HAVE_TRACING
@@ -145,7 +146,7 @@ MSG_parallel_task_create(const char *name, int host_nb,
   simdata->compute = NULL;
   simdata->comm = NULL;
   simdata->rate = -1.0;
-  simdata->refcount = 1;
+  simdata->isused = 0;
   simdata->sender = NULL;
   simdata->receiver = NULL;
   simdata->source = NULL;
@@ -164,13 +165,14 @@ MSG_parallel_task_create(const char *name, int host_nb,
 MSG_error_t MSG_parallel_task_execute(m_task_t task)
 {
   simdata_task_t simdata = NULL;
+  e_smx_state_t comp_state;
   m_process_t self = MSG_process_self();
   CHECK_HOST();
 
   simdata = task->simdata;
 
   xbt_assert0((!simdata->compute)
-              && (task->simdata->refcount == 1),
+              && (task->simdata->isused == 0),
               "This task is executed somewhere else. Go fix your code!");
 
   xbt_assert0(simdata->host_nb,
@@ -178,7 +180,7 @@ MSG_error_t MSG_parallel_task_execute(m_task_t task)
 
   DEBUG1("Parallel computing on %s", MSG_process_self()->simdata->m_host->name);
 
-  simdata->refcount++;
+  simdata->isused=1;
 
   simdata->compute =
       SIMIX_req_host_parallel_execute(task->name, simdata->host_nb,
@@ -188,29 +190,26 @@ MSG_error_t MSG_parallel_task_execute(m_task_t task)
   DEBUG1("Parallel execution action created: %p", simdata->compute);
 
   self->simdata->waiting_action = simdata->compute;
-  SIMIX_req_host_execution_wait(simdata->compute);
+  comp_state = SIMIX_req_host_execution_wait(simdata->compute);
   self->simdata->waiting_action = NULL;
 
-  DEBUG2("Finished waiting for execution of action %p, state = %d", simdata->compute, SIMIX_req_host_execution_get_state(task->simdata->compute));
+  DEBUG2("Finished waiting for execution of action %p, state = %d", simdata->compute, comp_state);
 
-  simdata->refcount--;
+  simdata->isused=0;
 
-  if (SIMIX_req_host_execution_get_state(task->simdata->compute) == SIMIX_DONE) {
+  if (comp_state == SIMIX_DONE) {
     /* action ended, set comm and compute = NULL, the actions is already destroyed in the main function */
-    SIMIX_req_host_execution_destroy(task->simdata->compute);
     simdata->computation_amount = 0.0;
     simdata->comm = NULL;
     simdata->compute = NULL;
     MSG_RETURN(MSG_OK);
   } else if (SIMIX_req_host_get_state(SIMIX_host_self()) == 0) {
     /* action ended, set comm and compute = NULL, the actions is already destroyed in the main function */
-    SIMIX_req_host_execution_destroy(task->simdata->compute);
     simdata->comm = NULL;
     simdata->compute = NULL;
     MSG_RETURN(MSG_HOST_FAILURE);
   } else {
     /* action ended, set comm and compute = NULL, the actions is already destroyed in the main function */
-    SIMIX_req_host_execution_destroy(task->simdata->compute);
     simdata->comm = NULL;
     simdata->compute = NULL;
     MSG_RETURN(MSG_TASK_CANCELLED);
@@ -244,22 +243,16 @@ MSG_error_t MSG_process_sleep(double nb_sec)
   proc->simdata->waiting_action = NULL;*/
   
   if (state == SIMIX_DONE) {
-    if (SIMIX_req_host_get_state(SIMIX_host_self()) == SURF_RESOURCE_OFF) {
 #ifdef HAVE_TRACING
-      TRACE_msg_process_sleep_out(MSG_process_self());
+  TRACE_msg_process_sleep_out(MSG_process_self());
 #endif
-      MSG_RETURN(MSG_HOST_FAILURE);
-    }
+    MSG_RETURN(MSG_OK);
   } else {
 #ifdef HAVE_TRACING
     TRACE_msg_process_sleep_out(MSG_process_self());
 #endif
     MSG_RETURN(MSG_HOST_FAILURE);
   }
-#ifdef HAVE_TRACING
-  TRACE_msg_process_sleep_out(MSG_process_self());
-#endif
-  MSG_RETURN(MSG_OK);
 }
 
 /** \ingroup msg_gos_functions
@@ -377,14 +370,14 @@ MSG_task_receive_ext(m_task_t * task, const char *alias, double timeout,
 }
 
 /** \ingroup msg_gos_functions
- * \brief Send a task on a channel.
+ * \brief Sends a task on a mailbox.
+ *
+ * This is a non blocking function: use MSG_comm_wait() or MSG_comm_test()
+ * to end the communication.
  *
- * This function takes two parameter.
  * \param task a #m_task_t to send on another location.
- * \param alias the channel on which the agent should put this
- task. This value has to be >=0 and < than the maximal number of
- channels fixed with MSG_set_channel_number().
- * \return the msg_comm_t communication.
+ * \param alias name of the mailbox to sent the task to
+ * \return the msg_comm_t communication created
  */
 msg_comm_t MSG_task_isend(m_task_t task, const char *alias)
 {
@@ -394,38 +387,86 @@ msg_comm_t MSG_task_isend(m_task_t task, const char *alias)
 
   CHECK_HOST();
 
-  /* FIXME: these functions are not tracable */
+  /* FIXME: these functions are not traceable */
 
   /* Prepare the task to send */
   t_simdata = task->simdata;
   t_simdata->sender = process;
   t_simdata->source = MSG_host_self();
 
-  xbt_assert0(t_simdata->refcount == 1,
+  xbt_assert0(t_simdata->isused == 0,
               "This task is still being used somewhere else. You cannot send it now. Go fix your code!");
 
-  t_simdata->refcount++;
+  t_simdata->isused = 1;
   msg_global->sent_msg++;
-  process->simdata->waiting_task = task;
 
   /* Send it by calling SIMIX network layer */
+  msg_comm_t comm = xbt_new0(s_msg_comm_t, 1);
+  comm->task_sent = task;
+  comm->task_received = NULL;
+  comm->status = MSG_OK;
+  comm->s_comm =
+    SIMIX_req_comm_isend(mailbox, t_simdata->message_size,
+                         t_simdata->rate, task, sizeof(void *), NULL, NULL, 0);
+  t_simdata->comm = comm->s_comm; /* FIXME: is the field t_simdata->comm still useful? */
 
-  return SIMIX_req_comm_isend(mailbox, t_simdata->message_size,
-                             t_simdata->rate, task, sizeof(void *),
-                             &t_simdata->comm);
+  return comm;
 }
 
 /** \ingroup msg_gos_functions
- * \brief Listen on a channel for receiving a task from an asynchronous communication.
+ * \brief Sends a task on a mailbox.
+ *
+ * This is a non blocking detached send function.
+ * Think of it as a best effort send. The communication
+ * object will be destroyed by the receiver (if any).
+ *
+ * \param task a #m_task_t to send on another location.
+ * \param alias name of the mailbox to sent the task to
+ * \param cleanup a function to destroy the task if the
+ * communication fails (if NULL, MSG_task_destroy() will
+ * be used by default)
+ */
+void MSG_task_dsend(m_task_t task, const char *alias, void_f_pvoid_t cleanup)
+{
+  simdata_task_t t_simdata = NULL;
+  m_process_t process = MSG_process_self();
+  msg_mailbox_t mailbox = MSG_mailbox_get_by_alias(alias);
+
+  CHECK_HOST();
+
+  if (cleanup == NULL) {
+    cleanup = (void_f_pvoid_t) MSG_task_destroy;
+  }
+
+  /* FIXME: these functions are not traceable */
+
+  /* Prepare the task to send */
+  t_simdata = task->simdata;
+  t_simdata->sender = process;
+  t_simdata->source = MSG_host_self();
+
+  xbt_assert0(t_simdata->isused == 0,
+              "This task is still being used somewhere else. You cannot send it now. Go fix your code!");
+
+  t_simdata->isused = 1;
+  msg_global->sent_msg++;
+
+  /* Send it by calling SIMIX network layer */
+  SIMIX_req_comm_isend(mailbox, t_simdata->message_size,
+                       t_simdata->rate, task, sizeof(void *), NULL, cleanup, 1);
+}
+
+/** \ingroup msg_gos_functions
+ * \brief Starts listening for receiving a task from an asynchronous communication.
+ *
+ * This is a non blocking function: use MSG_comm_wait() or MSG_comm_test()
+ * to end the communication.
  *
- * It takes two parameters.
  * \param task a memory location for storing a #m_task_t.
- * \param alias the channel on which the agent should be
- listening. This value has to be >=0 and < than the maximal
- number of channels fixed with MSG_set_channel_number().
- * \return the msg_comm_t communication.
+ * \param name of the mailbox to receive the task on
+ * \return the msg_comm_t communication created
  */
-msg_comm_t MSG_task_irecv(m_task_t * task, const char *alias)
+msg_comm_t MSG_task_irecv(m_task_t *task, const char *alias)
 {
   smx_rdv_t rdv = MSG_mailbox_get_by_alias(alias);
 
@@ -441,38 +482,130 @@ msg_comm_t MSG_task_irecv(m_task_t * task, const char *alias)
         ("MSG_task_get() was asked to write in a non empty task struct.");
 
   /* Try to receive it by calling SIMIX network layer */
-  return SIMIX_req_comm_irecv(rdv, task, NULL);
+  msg_comm_t comm = xbt_new0(s_msg_comm_t, 1);
+  comm->task_sent = NULL;
+  comm->task_received = task;
+  comm->status = MSG_OK;
+  comm->s_comm = SIMIX_req_comm_irecv(rdv, task, NULL, NULL, NULL);
+
+  return comm;
 }
 
 /** \ingroup msg_gos_functions
- * \brief Test the status of a communication.
- *
- * It takes one parameter.
- * \param comm the communication to test.
- * \return the status of the communication:
- *             TRUE : the communication is completed
- *             FALSE: the communication is incompleted
+ * \brief Checks whether a communication is done, and if yes, finalizes it.
+ * \param comm the communication to test
+ * \return TRUE if the communication is finished
+ * (but it may have failed, use MSG_comm_get_status() to know its status)
+ * or FALSE if the communication is not finished yet
  * If the status is FALSE, don't forget to use MSG_process_sleep() after the test.
  */
 int MSG_comm_test(msg_comm_t comm)
 {
-  return SIMIX_req_comm_test(comm);
+  xbt_ex_t e;
+  int finished = 0;
+  TRY {
+    finished = SIMIX_req_comm_test(comm->s_comm);
+  }
+  CATCH(e) {
+    switch (e.category) {
+
+      case host_error:
+        comm->status = MSG_HOST_FAILURE;
+        finished = 1;
+        break;
+
+      case network_error:
+        comm->status = MSG_TRANSFER_FAILURE;
+        finished = 1;
+        break;
+
+      case timeout_error:
+        comm->status = MSG_TIMEOUT;
+        finished = 1;
+        break;
+
+      default:
+        RETHROW;
+    }
+    xbt_ex_free(e);
+  }
+
+  return finished;
+}
+
+/** \ingroup msg_gos_functions
+ * \brief This function checks if a communication is finished.
+ * \param comms a vector of communications
+ * \return the position of the finished communication if any
+ * (but it may have failed, use MSG_comm_get_status() to know its status),
+ * or -1 if none is finished
+ */
+int MSG_comm_testany(xbt_dynar_t comms)
+{
+  xbt_ex_t e;
+  int finished_index = -1;
+
+  /* create the equivalent dynar with SIMIX objects */
+  xbt_dynar_t s_comms = xbt_dynar_new(sizeof(smx_action_t), NULL);
+  msg_comm_t comm;
+  unsigned int cursor;
+  xbt_dynar_foreach(comms, cursor, comm) {
+    xbt_dynar_push(s_comms, &comm->s_comm);
+  }
+
+  MSG_error_t status = MSG_OK;
+  TRY {
+    finished_index = SIMIX_req_comm_testany(s_comms);
+  }
+  CATCH(e) {
+    switch (e.category) {
+
+      case host_error:
+        finished_index = e.value;
+        status = MSG_HOST_FAILURE;
+        break;
+
+      case network_error:
+        finished_index = e.value;
+        status = MSG_TRANSFER_FAILURE;
+        break;
+
+      case timeout_error:
+        finished_index = e.value;
+        status = MSG_TIMEOUT;
+        break;
+
+      default:
+        RETHROW;
+    }
+    xbt_ex_free(e);
+  }
+  xbt_dynar_free(&s_comms);
+
+  if (finished_index != -1) {
+    comm = xbt_dynar_get_as(comms, finished_index, msg_comm_t);
+    /* the communication is finished */
+    comm->status = status;
+  }
+
+  return finished_index;
 }
 
 /** \ingroup msg_gos_functions
- * \brief After received TRUE to MSG_comm_test(), the communication must be destroyed.
- *
- * It takes one parameter.
+ * \brief Destroys a communication.
  * \param comm the communication to destroy.
  */
 void MSG_comm_destroy(msg_comm_t comm)
 {
-  if (SIMIX_req_comm_get_src_proc(comm) != SIMIX_process_self()) {
-    m_task_t task;
-    task = (m_task_t) SIMIX_req_comm_get_src_buff(comm);
-    task->simdata->refcount--;
+  if (comm->task_received != NULL
+      && *comm->task_received != NULL
+      && MSG_comm_get_status(comm) == MSG_OK) {
+    (*comm->task_received)->simdata->isused = 0;
   }
-  SIMIX_req_comm_destroy(comm);
+
+  /* FIXME auto-destroy comms from SIMIX to avoid this request */
+  SIMIX_req_comm_destroy(comm->s_comm);
+  free(comm);
 }
 
 /** \ingroup msg_gos_functions
@@ -486,45 +619,42 @@ void MSG_comm_destroy(msg_comm_t comm)
 MSG_error_t MSG_comm_wait(msg_comm_t comm, double timeout)
 {
   xbt_ex_t e;
-  MSG_error_t res = MSG_OK;
   TRY {
-    SIMIX_req_comm_wait(comm, timeout);
+    SIMIX_req_comm_wait(comm->s_comm, timeout);
 
-    if (SIMIX_req_comm_get_src_proc(comm) != SIMIX_process_self()) {
-      m_task_t task;
-      task = (m_task_t) SIMIX_req_comm_get_src_buff(comm);
-      task->simdata->refcount--;
+    if (comm->task_received != NULL) {
+      /* I am the receiver */
+      (*comm->task_received)->simdata->isused = 0;
     }
-    SIMIX_req_comm_destroy(comm);
 
-    /* FIXME: these functions are not tracable */
+    /* FIXME: these functions are not traceable */
   }
   CATCH(e) {
     switch (e.category) {
     case host_error:
-      res = MSG_HOST_FAILURE;
+      comm->status = MSG_HOST_FAILURE;
       break;
     case network_error:
-      res = MSG_TRANSFER_FAILURE;
+      comm->status = MSG_TRANSFER_FAILURE;
       break;
     case timeout_error:
-      res = MSG_TIMEOUT;
+      comm->status = MSG_TIMEOUT;
       break;
     default:
-      xbt_die(bprintf("Unhandled SIMIX network exception: %s", e.msg));
+      RETHROW;
     }
     xbt_ex_free(e);
   }
-  return res;
+
+  return comm->status;
 }
 
 /** \ingroup msg_gos_functions
 * \brief This function is called by a sender and permit to wait for each communication
 *
-* It takes three parameters.
 * \param comm a vector of communication
 * \param nb_elem is the size of the comm vector
-* \param timeout for each call of  MSG_comm_wait
+* \param timeout for each call of MSG_comm_wait
 */
 void MSG_comm_waitall(msg_comm_t * comm, int nb_elem, double timeout)
 {
@@ -535,21 +665,79 @@ void MSG_comm_waitall(msg_comm_t * comm, int nb_elem, double timeout)
 }
 
 /** \ingroup msg_gos_functions
-* \brief This function wait for the first completed communication
-*
-* It takes on parameter.
-* \param comms a vector of communication
-* \return the position of the completed communication from the xbt_dynar_t.
-*/
+ * \brief This function waits for the first communication finished in a list.
+ * \param comms a vector of communications
+ * \return the position of the first finished communication
+ * (but it may have failed, use MSG_comm_get_status() to know its status)
+ */
 int MSG_comm_waitany(xbt_dynar_t comms)
 {
-  return SIMIX_req_comm_waitany(comms);
+  xbt_ex_t e;
+  int finished_index = -1;
+
+  /* create the equivalent dynar with SIMIX objects */
+  xbt_dynar_t s_comms = xbt_dynar_new(sizeof(smx_action_t), NULL);
+  msg_comm_t comm;
+  unsigned int cursor;
+  xbt_dynar_foreach(comms, cursor, comm) {
+    xbt_dynar_push(s_comms, &comm->s_comm);
+  }
+
+  MSG_error_t status = MSG_OK;
+  TRY {
+    finished_index = SIMIX_req_comm_waitany(s_comms);
+  }
+  CATCH(e) {
+    switch (e.category) {
+
+      case host_error:
+        finished_index = e.value;
+        status = MSG_HOST_FAILURE;
+        break;
+
+      case network_error:
+        finished_index = e.value;
+        status = MSG_TRANSFER_FAILURE;
+        break;
+
+      case timeout_error:
+        finished_index = e.value;
+        status = MSG_TIMEOUT;
+        break;
+
+      default:
+        RETHROW;
+    }
+    xbt_ex_free(e);
+  }
+
+  xbt_assert0(finished_index != -1, "WaitAny returned -1");
+  xbt_dynar_free(&s_comms);
+
+  comm = xbt_dynar_get_as(comms, finished_index, msg_comm_t);
+  /* the communication is finished */
+  comm->status = status;
+
+  return finished_index;
+}
+
+/**
+ * \ingroup msg_gos_functions
+ * \brief Returns the error (if any) that occured during a finished communication.
+ * \param comm a finished communication
+ * \return the status of the communication, or MSG_OK if no error occured
+ * during the communication
+ */
+MSG_error_t MSG_comm_get_status(msg_comm_t comm) {
+
+  return comm->status;
 }
 
 m_task_t MSG_comm_get_task(msg_comm_t comm)
 {
-  xbt_assert0(comm, "Invalid parameters");
-  return (m_task_t) SIMIX_req_comm_get_src_buff(comm);
+  xbt_assert0(comm, "Invalid parameter");
+
+  return comm->task_received ? *comm->task_received : comm->task_sent;
 }
 
 /** \ingroup msg_gos_functions