Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
objectify a few msg::Comm functions
[simgrid.git] / src / msg / msg_gos.cpp
index 36d0b0f..a72a2eb 100644 (file)
@@ -6,76 +6,71 @@
 #include <cmath>
 
 #include "simgrid/Exception.hpp"
+#include "simgrid/s4u/Actor.hpp"
 #include "simgrid/s4u/Comm.hpp"
+#include "simgrid/s4u/Exec.hpp"
 #include "simgrid/s4u/Mailbox.hpp"
 #include "src/instr/instr_private.hpp"
-#include "src/kernel/activity/ExecImpl.hpp"
 #include "src/msg/msg_private.hpp"
 
 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(msg_gos, msg, "Logging specific to MSG (gos)");
 
-/**
- * @brief Executes a parallel task and waits for its termination.
- *
- * @param task a #msg_task_t to execute on the location on which the process is running.
- *
- * @return #MSG_OK if the task was successfully completed, #MSG_TASK_CANCELED or #MSG_HOST_FAILURE otherwise
- */
-msg_error_t MSG_parallel_task_execute(msg_task_t task)
-{
-  return MSG_parallel_task_execute_with_timeout(task, -1);
-}
+namespace simgrid {
+namespace msg {
 
-msg_error_t MSG_parallel_task_execute_with_timeout(msg_task_t task, double timeout)
+bool Comm::test()
 {
-  e_smx_state_t comp_state;
-  msg_error_t status = MSG_OK;
-
-  xbt_assert((not task->compute) && not task->is_used(), "This task is executed somewhere else. Go fix your code!");
-
-  XBT_DEBUG("Computing on %s", MSG_process_get_name(MSG_process_self()));
+  bool finished = false;
 
-  if (task->flops_amount <= 0.0 && not task->hosts_.empty()) {
-    return MSG_OK;
+  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;
+    }
   }
 
-  if (TRACE_actor_is_enabled())
-    simgrid::instr::Container::by_name(instr_pid(MSG_process_self()))->get_state("ACTOR_STATE")->push_event("execute");
-
+  return finished;
+}
+msg_error_t Comm::wait_for(double timeout)
+{
   try {
-    task->set_used();
+    s_comm->wait_for(timeout);
 
-    task->compute = boost::static_pointer_cast<simgrid::kernel::activity::ExecImpl>(simcall_execution_parallel_start(
-        std::move(task->get_name()), task->hosts_.size(), task->hosts_.data(),
-        (task->flops_parallel_amount.empty() ? nullptr : task->flops_parallel_amount.data()),
-        (task->bytes_parallel_amount.empty() ? nullptr : task->bytes_parallel_amount.data()), -1.0, timeout));
-    XBT_DEBUG("Parallel execution action created: %p", task->compute.get());
-    if (task->has_tracing_category())
-      simgrid::simix::simcall([task] { task->compute->set_category(std::move(task->get_tracing_category())); });
-
-    comp_state = simcall_execution_wait(task->compute);
-
-    task->set_not_used();
+    if (task_received != nullptr) {
+      /* I am the receiver */
+      (*task_received)->set_not_used();
+    }
 
-    XBT_DEBUG("Execution task '%s' finished in state %d", task->get_cname(), (int)comp_state);
-  } catch (simgrid::HostFailureException& e) {
-    status = MSG_HOST_FAILURE;
+    /* FIXME: these functions are not traceable */
   } catch (simgrid::TimeoutError& e) {
-    status = MSG_TIMEOUT;
+    status_ = MSG_TIMEOUT;
   } catch (simgrid::CancelException& e) {
-    status = MSG_TASK_CANCELED;
+    status_ = MSG_TASK_CANCELED;
+  } catch (xbt_ex& e) {
+    if (e.category == network_error)
+      status_ = MSG_TRANSFER_FAILURE;
+    else
+      throw;
   }
 
-  /* action ended, set comm and compute = nullptr, the actions is already destroyed in the main function */
-  task->flops_amount = 0.0;
-  task->comm         = nullptr;
-  task->compute      = nullptr;
-
-  if (TRACE_actor_is_enabled())
-    simgrid::instr::Container::by_name(instr_pid(MSG_process_self()))->get_state("ACTOR_STATE")->pop_event();
-
-  return status;
+  return status_;
 }
+} // namespace msg
+} // namespace simgrid
 
 /**
  * @brief Receives a task from a mailbox.
@@ -131,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)
 {
-  return MSG_task_receive_ext(task, alias, timeout, nullptr);
+  return MSG_task_receive_ext_bounded(task, alias, timeout, nullptr, -1);
 }
 
 /**
@@ -282,10 +277,13 @@ msg_comm_t MSG_task_irecv_bounded(msg_task_t *task, const char *name, double rat
     XBT_CRITICAL("MSG_task_irecv() was asked to write in a non empty task struct.");
 
   /* Try to receive it by calling SIMIX network layer */
-  msg_comm_t comm = new simgrid::msg::Comm(
-      nullptr, task, mbox->get_init()->set_dst_data((void**)task, sizeof(msg_task_t*))->set_rate(rate)->start());
+  simgrid::s4u::CommPtr comm = simgrid::s4u::Mailbox::by_name(name)
+                                   ->get_init()
+                                   ->set_dst_data((void**)task, sizeof(msg_task_t*))
+                                   ->set_rate(rate)
+                                   ->start();
 
-  return comm;
+  return new simgrid::msg::Comm(nullptr, task, comm);
 }
 
 /**
@@ -298,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)
 {
-  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();
 }
 
 /**
@@ -364,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 */
-    comm->status = status;
+    comm->set_status(status);
 
     if (status == MSG_OK && comm->task_received != nullptr) {
       /* I am the receiver */
@@ -391,28 +365,7 @@ void MSG_comm_destroy(msg_comm_t comm)
  */
 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
@@ -424,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++)
-    MSG_comm_wait(comm[i], timeout);
+    comm[i]->wait_for(timeout);
 }
 
 /** @brief This function waits for the first communication finished in a list.
@@ -468,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->status = status;
+  comm->set_status(status);
 
   if (comm->task_received != nullptr) {
     /* I am the receiver */
@@ -485,7 +438,7 @@ int MSG_comm_waitany(xbt_dynar_t comms)
  */
 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
@@ -506,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
  */
+// 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);
@@ -517,120 +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;
-
-  TRACE_msg_task_put_start(task);
-
-  /* Prepare the task to send */
-  task->set_used();
-
-  msg_global->sent_msg++;
-
-  /* Try to send it */
-  try {
-    simgrid::s4u::CommPtr comm =
-        simgrid::s4u::Mailbox::by_name(alias)->put_init(task, task->bytes_amount)->set_rate(task->get_rate());
-    task->comm = comm;
-    comm->start();
-    if (TRACE_is_enabled() && task->has_tracing_category())
-      simgrid::simix::simcall(
-          [comm, task] { comm->get_impl()->set_category(std::move(task->get_tracing_category())); });
-    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.
  *
@@ -650,4 +490,3 @@ int MSG_task_listen_from(const char *alias)
   else
     return -1;
 }
-