Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
Don't use pass-by-value for large parameters.
[simgrid.git] / src / msg / msg_task.cpp
index 54afd3e..8068a8d 100644 (file)
@@ -4,9 +4,11 @@
  * under the terms of the license (GNU LGPL) which comes with this package. */
 
 #include "msg_private.hpp"
-#include "src/simix/smx_private.hpp"
+#include "src/instr/instr_private.hpp"
 #include <simgrid/s4u/Comm.hpp>
+#include <simgrid/s4u/Exec.hpp>
 #include <simgrid/s4u/Host.hpp>
+#include <simgrid/s4u/Mailbox.hpp>
 
 #include <algorithm>
 #include <vector>
@@ -25,8 +27,8 @@ Task::Task(std::string name, double flops_amount, double bytes_amount, void* dat
     MC_ignore_heap(&(id_), sizeof(id_));
 }
 
-Task::Task(std::string name, std::vector<s4u::Host*> hosts, std::vector<double> flops_amount,
-           std::vector<double> bytes_amount, void* data)
+Task::Task(std::string name, std::vector<s4u::Host*>&& hosts, std::vector<double>&& flops_amount,
+           std::vector<double>&& bytes_amount, void* data)
     : Task(std::move(name), 1.0, 0, data)
 {
   parallel_             = true;
@@ -65,20 +67,25 @@ msg_error_t Task::execute()
   xbt_assert(std::isfinite(flops_amount), "flops_amount is not finite!");
 
   msg_error_t status = MSG_OK;
-  s4u::Host* host    = SIMIX_process_self()->get_host();
-
-  set_used();
-
-  compute = simix::simcall([this, host] {
-    return kernel::activity::ExecImplPtr(new kernel::activity::ExecImpl(name_, tracing_category_, host));
-  });
+  if (flops_amount <= 0.0)
+    return MSG_OK;
 
   try {
-    compute->start(flops_amount, priority_, bound_);
-    e_smx_state_t comp_state = simcall_execution_wait(compute);
+    set_used();
+    if (parallel_)
+      compute = s4u::this_actor::exec_init(hosts_, flops_parallel_amount, bytes_parallel_amount);
+    else
+      compute = s4u::this_actor::exec_init(flops_amount);
+
+    compute->set_name(name_)
+        ->set_tracing_category(tracing_category_)
+        ->set_timeout(timeout_)
+        ->set_priority(1 / priority_)
+        ->set_bound(bound_)
+        ->wait();
 
     set_not_used();
-    XBT_DEBUG("Execution task '%s' finished in state %d", get_cname(), (int)comp_state);
+    XBT_DEBUG("Execution task '%s' finished", get_cname());
   } catch (HostFailureException& e) {
     status = MSG_HOST_FAILURE;
   } catch (TimeoutError& e) {
@@ -95,10 +102,62 @@ msg_error_t Task::execute()
   return status;
 }
 
+s4u::CommPtr Task::send_async(std::string alias, void_f_pvoid_t cleanup, bool detached)
+{
+  if (TRACE_actor_is_enabled()) {
+    container_t process_container = simgrid::instr::Container::by_name(instr_pid(MSG_process_self()));
+    std::string key               = std::string("p") + std::to_string(get_id());
+    simgrid::instr::Container::get_root()->get_link("ACTOR_TASK_LINK")->start_event(process_container, "SR", key);
+  }
+
+  /* Prepare the task to send */
+  set_used();
+  this->comm = nullptr;
+  msg_global->sent_msg++;
+
+  s4u::CommPtr s4u_comm = s4u::Mailbox::by_name(alias)->put_init(this, bytes_amount)->set_rate(get_rate());
+  comm                  = s4u_comm;
+
+  if (detached)
+    comm->detach(cleanup);
+  else
+    comm->start();
+
+  if (TRACE_is_enabled() && has_tracing_category())
+    simgrid::simix::simcall([this] { comm->get_impl()->set_category(std::move(tracing_category_)); });
+
+  return comm;
+}
+
+msg_error_t Task::send(std::string alias, double timeout)
+{
+  msg_error_t ret = MSG_OK;
+  /* Try to send it */
+  try {
+    comm = nullptr; // needed, otherwise MC gets confused.
+    s4u::CommPtr s4u_comm = send_async(alias, nullptr, false);
+    comm                  = s4u_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 */
+    set_not_used();
+  }
+
+  return ret;
+}
 void Task::cancel()
 {
   if (compute) {
-    simgrid::simix::simcall([this] { compute->cancel(); });
+    compute->cancel();
   } else if (comm) {
     comm->cancel();
   }
@@ -252,6 +311,181 @@ msg_error_t MSG_task_execute(msg_task_t task)
   return task->execute();
 }
 
+/**
+ * @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 task->execute();
+}
+
+msg_error_t MSG_parallel_task_execute_with_timeout(msg_task_t task, double timeout)
+{
+  task->set_timeout(timeout);
+  return task->execute();
+}
+
+/**
+ * @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.
+ *
+ * @param task a #msg_task_t to send on another location.
+ * @param alias name of the mailbox to sent the task to
+ * @return the msg_comm_t communication created
+ */
+msg_comm_t MSG_task_isend(msg_task_t task, const char* alias)
+{
+  return new simgrid::msg::Comm(task, nullptr, task->send_async(alias, nullptr, false));
+}
+
+/**
+ * @brief Sends a task on a mailbox with a maximum rate
+ *
+ * This is a non blocking function: use MSG_comm_wait() or MSG_comm_test() to end the communication. The maxrate
+ * parameter allows the application to limit the bandwidth utilization of network links when sending the task.
+ *
+ * @param task a #msg_task_t to send on another location.
+ * @param alias name of the mailbox to sent the task to
+ * @param maxrate the maximum communication rate for sending this task (byte/sec).
+ * @return the msg_comm_t communication created
+ */
+msg_comm_t MSG_task_isend_bounded(msg_task_t task, const char* alias, double maxrate)
+{
+  task->set_rate(maxrate);
+  return new simgrid::msg::Comm(task, nullptr, task->send_async(alias, nullptr, false));
+}
+
+/**
+ * @brief Sends a task on a mailbox.
+ *
+ * This is a non blocking detached send function.
+ * Think of it as a best effort send. Keep in mind that the third parameter is only called if the communication fails.
+ * If the communication does work, it is responsibility of the receiver code to free anything related to the task, as
+ * usual. More details on this can be obtained on
+ * <a href="http://lists.gforge.inria.fr/pipermail/simgrid-user/2011-November/002649.html">this thread</a>
+ * in the SimGrid-user mailing list archive.
+ *
+ * @param task a #msg_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, e.g. MSG_task_destroy
+ * (if nullptr, no function will be called)
+ */
+void MSG_task_dsend(msg_task_t task, const char* alias, void_f_pvoid_t cleanup)
+{
+  task->send_async(alias, cleanup, true);
+}
+
+/**
+ * @brief Sends a task on a mailbox with a maximal rate.
+ *
+ * This is a non blocking detached send function.
+ * Think of it as a best effort send. Keep in mind that the third parameter is only called if the communication fails.
+ * If the communication does work, it is responsibility of the receiver code to free anything related to the task, as
+ * usual. More details on this can be obtained on
+ * <a href="http://lists.gforge.inria.fr/pipermail/simgrid-user/2011-November/002649.html">this thread</a>
+ * in the SimGrid-user mailing list archive.
+ *
+ * The rate parameter can be used to send a task with a limited bandwidth (smaller than the physical available value).
+ * Use MSG_task_dsend() if you don't limit the rate (or pass -1 as a rate value do disable this feature).
+ *
+ * @param task a #msg_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, e.g. MSG_task_destroy (if nullptr, no
+ *        function will be called)
+ * @param maxrate the maximum communication rate for sending this task (byte/sec)
+ *
+ */
+void MSG_task_dsend_bounded(msg_task_t task, const char* alias, void_f_pvoid_t cleanup, double maxrate)
+{
+  task->set_rate(maxrate);
+  task->send_async(alias, cleanup, true);
+}
+/**
+ * @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 task->send(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 task->send(alias, -1);
+}
+
+/**
+ * @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)
+{
+  return task->send(alias, timeout);
+}
+
+/**
+ * @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 task->send(alias, timeout);
+}
+
 /** @brief Destroys the given task.
  *
  * You should free user data, if any, @b before calling this destructor.