objectify a few msg::Comm functions

[simgrid.git] / src / msg / msg_gos.cpp

diff --git a/src/msg/msg_gos.cpp b/src/msg/msg_gos.cpp
index 1eba2f6..a72a2eb 100644 (file)
--- a/src/msg/msg_gos.cpp
+++ b/src/msg/msg_gos.cpp
@@ -15,6 +15,63 @@
 
 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(msg_gos, msg, "Logging specific to MSG (gos)");
 
 
 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(msg_gos, msg, "Logging specific to MSG (gos)");
 

+namespace simgrid {
+namespace msg {
+
+bool Comm::test()
+{
+  bool finished = false;
+
+  try {
+    finished = s_comm->test();
+    if (finished && task_received != nullptr) {
+      /* I am the receiver */
+      (*task_received)->set_not_used();
+    }
+  } catch (simgrid::TimeoutError& e) {
+    status_  = MSG_TIMEOUT;
+    finished = true;
+  } catch (simgrid::CancelException& e) {
+    status_  = MSG_TASK_CANCELED;
+    finished = true;
+  } catch (xbt_ex& e) {
+    if (e.category == network_error) {
+      status_  = MSG_TRANSFER_FAILURE;
+      finished = true;
+    } else {
+      throw;
+    }
+  }
+
+  return finished;
+}
+msg_error_t Comm::wait_for(double timeout)
+{
+  try {
+    s_comm->wait_for(timeout);
+
+    if (task_received != nullptr) {
+      /* I am the receiver */
+      (*task_received)->set_not_used();
+    }
+
+    /* FIXME: these functions are not traceable */
+  } catch (simgrid::TimeoutError& e) {
+    status_ = MSG_TIMEOUT;
+  } catch (simgrid::CancelException& e) {
+    status_ = MSG_TASK_CANCELED;
+  } catch (xbt_ex& e) {
+    if (e.category == network_error)
+      status_ = MSG_TRANSFER_FAILURE;
+    else
+      throw;
+  }
+
+  return status_;
+}
+} // namespace msg
+} // namespace simgrid
+

 /**
  * @brief Receives a task from a mailbox.
  *
 /**
  * @brief Receives a task from a mailbox.
  *


@@ -69,7 +126,7 @@ msg_error_t MSG_task_receive_bounded(msg_task_t * task, const char *alias, doubl
  */
 msg_error_t MSG_task_receive_with_timeout(msg_task_t * task, const char *alias, double timeout)
 {
  */
 msg_error_t MSG_task_receive_with_timeout(msg_task_t * task, const char *alias, double timeout)
 {

-  return MSG_task_receive_ext(task, alias, timeout, nullptr);
+  return MSG_task_receive_ext_bounded(task, alias, timeout, nullptr, -1);

 }
 
 /**
 }
 
 /**


@@ -239,31 +296,7 @@ msg_comm_t MSG_task_irecv_bounded(msg_task_t *task, const char *name, double rat
  */
 int MSG_comm_test(msg_comm_t comm)
 {
  */
 int MSG_comm_test(msg_comm_t comm)
 {

-  bool finished = false;
-
-  try {
-    finished = comm->s_comm->test();
-    if (finished && comm->task_received != nullptr) {
-      /* I am the receiver */
-      (*comm->task_received)->set_not_used();
-    }
-  } catch (simgrid::TimeoutError& e) {
-    comm->status = MSG_TIMEOUT;
-    finished     = true;
-  } catch (simgrid::CancelException& e) {
-    comm->status = MSG_TASK_CANCELED;
-    finished     = true;
-  }
-  catch (xbt_ex& e) {
-    if (e.category == network_error) {
-      comm->status = MSG_TRANSFER_FAILURE;
-      finished     = true;
-    } else {
-      throw;
-    }
-  }
-
-  return finished;
+  return comm->test();

 }
 
 /**
 }
 
 /**


@@ -305,7 +338,7 @@ int MSG_comm_testany(xbt_dynar_t comms)
   if (finished_index != -1) {
     comm = xbt_dynar_get_as(comms, finished_index, msg_comm_t);
     /* the communication is finished */
   if (finished_index != -1) {
     comm = xbt_dynar_get_as(comms, finished_index, msg_comm_t);
     /* the communication is finished */

-    comm->status = status;
+    comm->set_status(status);

 
     if (status == MSG_OK && comm->task_received != nullptr) {
       /* I am the receiver */
 
     if (status == MSG_OK && comm->task_received != nullptr) {
       /* I am the receiver */


@@ -332,28 +365,7 @@ void MSG_comm_destroy(msg_comm_t comm)
  */
 msg_error_t MSG_comm_wait(msg_comm_t comm, double timeout)
 {
  */
 msg_error_t MSG_comm_wait(msg_comm_t comm, double timeout)
 {

-  try {
-    comm->s_comm->wait_for(timeout);
-
-    if (comm->task_received != nullptr) {
-      /* I am the receiver */
-      (*comm->task_received)->set_not_used();
-    }
-
-    /* FIXME: these functions are not traceable */
-  } catch (simgrid::TimeoutError& e) {
-    comm->status = MSG_TIMEOUT;
-  } catch (simgrid::CancelException& e) {
-    comm->status = MSG_TASK_CANCELED;
-  }
-  catch (xbt_ex& e) {
-    if (e.category == network_error)
-      comm->status = MSG_TRANSFER_FAILURE;
-    else
-      throw;
-  }
-
-  return comm->status;
+  return comm->wait_for(timeout);

 }
 
 /** @brief This function is called by a sender and permit to wait for each communication
 }
 
 /** @brief This function is called by a sender and permit to wait for each communication


@@ -365,7 +377,7 @@ msg_error_t MSG_comm_wait(msg_comm_t comm, double timeout)
 void MSG_comm_waitall(msg_comm_t * comm, int nb_elem, double timeout)
 {
   for (int i = 0; i < nb_elem; i++)
 void MSG_comm_waitall(msg_comm_t * comm, int nb_elem, double timeout)
 {
   for (int i = 0; i < nb_elem; i++)

-    MSG_comm_wait(comm[i], timeout);
+    comm[i]->wait_for(timeout);

 }
 
 /** @brief This function waits for the first communication finished in a list.
 }
 
 /** @brief This function waits for the first communication finished in a list.


@@ -409,7 +421,7 @@ int MSG_comm_waitany(xbt_dynar_t comms)
 
   comm = xbt_dynar_get_as(comms, finished_index, msg_comm_t);
   /* the communication is finished */
 
   comm = xbt_dynar_get_as(comms, finished_index, msg_comm_t);
   /* the communication is finished */

-  comm->status = status;
+  comm->set_status(status);

 
   if (comm->task_received != nullptr) {
     /* I am the receiver */
 
   if (comm->task_received != nullptr) {
     /* I am the receiver */


@@ -426,7 +438,7 @@ int MSG_comm_waitany(xbt_dynar_t comms)
  */
 msg_error_t MSG_comm_get_status(msg_comm_t comm) {
 
  */
 msg_error_t MSG_comm_get_status(msg_comm_t comm) {
 

-  return comm->status;
+  return comm->get_status();

 }
 
 /** @brief Get a task (#msg_task_t) from a communication
 }
 
 /** @brief Get a task (#msg_task_t) from a communication


@@ -447,6 +459,7 @@ msg_task_t MSG_comm_get_task(msg_comm_t comm)
  * @param buff the data copied
  * @param buff_size size of the buffer
  */
  * @param buff the data copied
  * @param buff_size size of the buffer
  */

+// deprecated but used by MSG_set_copy_callback. Should be removed in v325

 void MSG_comm_copy_data_from_SIMIX(simgrid::kernel::activity::CommImpl* comm, void* buff, size_t buff_size)
 {
   SIMIX_comm_copy_pointer_callback(comm, buff, buff_size);
 void MSG_comm_copy_data_from_SIMIX(simgrid::kernel::activity::CommImpl* comm, void* buff, size_t buff_size)
 {
   SIMIX_comm_copy_pointer_callback(comm, buff, buff_size);


@@ -458,107 +471,6 @@ void MSG_comm_copy_data_from_SIMIX(simgrid::kernel::activity::CommImpl* comm, vo
   }
 }
 
   }
 }
 

-/**
- * @brief Sends a task to a mailbox
- *
- * This is a blocking function, the execution flow will be blocked until the task is sent (and received on the other
- * side if #MSG_task_receive is used).
- * See #MSG_task_isend for sending tasks asynchronously.
- *
- * @param task the task to be sent
- * @param alias the mailbox name to where the task is sent
- *
- * @return Returns #MSG_OK if the task was successfully sent,
- * #MSG_HOST_FAILURE, or #MSG_TRANSFER_FAILURE otherwise.
- */
-msg_error_t MSG_task_send(msg_task_t task, const char *alias)
-{
-  XBT_DEBUG("MSG_task_send: Trying to send a message on mailbox '%s'", alias);
-  return MSG_task_send_with_timeout(task, alias, -1);
-}
-
-/**
- * @brief Sends a task to a mailbox with a maximum rate
- *
- * This is a blocking function, the execution flow will be blocked until the task is sent. The maxrate parameter allows
- * the application to limit the bandwidth utilization of network links when sending the task.
- *
- * The maxrate parameter can be used to send a task with a limited bandwidth (smaller than the physical available
- * value). Use MSG_task_send() if you don't limit the rate (or pass -1 as a rate value do disable this feature).
- *
- * @param task the task to be sent
- * @param alias the mailbox name to where the task is sent
- * @param maxrate the maximum communication rate for sending this task (byte/sec)
- *
- * @return Returns #MSG_OK if the task was successfully sent,
- * #MSG_HOST_FAILURE, or #MSG_TRANSFER_FAILURE otherwise.
- */
-msg_error_t MSG_task_send_bounded(msg_task_t task, const char *alias, double maxrate)
-{
-  task->set_rate(maxrate);
-  return MSG_task_send(task, alias);
-}
-
-/**
- * @brief Sends a task to a mailbox with a timeout
- *
- * This is a blocking function, the execution flow will be blocked until the task is sent or the timeout is achieved.
- *
- * @param task the task to be sent
- * @param alias the mailbox name to where the task is sent
- * @param timeout is the maximum wait time for completion (if -1, this call is the same as #MSG_task_send)
- *
- * @return Returns #MSG_OK if the task was successfully sent,
- * #MSG_HOST_FAILURE, or #MSG_TRANSFER_FAILURE, or #MSG_TIMEOUT otherwise.
- */
-msg_error_t MSG_task_send_with_timeout(msg_task_t task, const char *alias, double timeout)
-{
-  msg_error_t ret = MSG_OK;
-  /* Try to send it */
-  try {
-    simgrid::s4u::CommPtr comm = task->send_async(alias, nullptr, false);
-    task->comm = comm;
-    comm->wait_for(timeout);
-  } catch (simgrid::TimeoutError& e) {
-    ret = MSG_TIMEOUT;
-  } catch (simgrid::CancelException& e) {
-    ret = MSG_HOST_FAILURE;
-  } catch (xbt_ex& e) {
-    if (e.category == network_error)
-      ret = MSG_TRANSFER_FAILURE;
-    else
-      throw;
-
-    /* If the send failed, it is not used anymore */
-    task->set_not_used();
-  }
-
-  return ret;
-}
-
-/**
- * @brief Sends a task to a mailbox with a timeout and with a maximum rate
- *
- * This is a blocking function, the execution flow will be blocked until the task is sent or the timeout is achieved.
- *
- * The maxrate parameter can be used to send a task with a limited bandwidth (smaller than the physical available
- * value). Use MSG_task_send_with_timeout() if you don't limit the rate (or pass -1 as a rate value do disable this
- * feature).
- *
- * @param task the task to be sent
- * @param alias the mailbox name to where the task is sent
- * @param timeout is the maximum wait time for completion (if -1, this call is the same as #MSG_task_send)
- * @param maxrate the maximum communication rate for sending this task (byte/sec)
- *
- * @return Returns #MSG_OK if the task was successfully sent,
- * #MSG_HOST_FAILURE, or #MSG_TRANSFER_FAILURE, or #MSG_TIMEOUT otherwise.
- */
-msg_error_t MSG_task_send_with_timeout_bounded(msg_task_t task, const char *alias, double timeout, double maxrate)
-{
-  task->set_rate(maxrate);
-  return MSG_task_send_with_timeout(task, alias, timeout);
-}
-

 /**
  * @brief Look if there is a communication on a mailbox and return the PID of the sender process.
  *
 /**
  * @brief Look if there is a communication on a mailbox and return the PID of the sender process.
  *