Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
Objectify MSG task send
[simgrid.git] / src / msg / msg_gos.cpp
index a965bea..88a6c3a 100644 (file)
 /* This program is free software; you can redistribute it and/or modify it
  * under the terms of the license (GNU LGPL) which comes with this package. */
 
-#include "simgrid/Exception.hpp"
 #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"
-#include "src/simix/smx_private.hpp" /* MSG_task_listen looks inside the rdv directly. Not clean. */
 
 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(msg_gos, msg, "Logging specific to MSG (gos)");
 
-/**
- * @brief Executes a task and waits for its termination.
- *
- * This function is used for describing the behavior of a process. It takes only one parameter.
- * @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_task_execute(msg_task_t task)
-{
-  return MSG_parallel_task_execute(task);
-}
-
-/**
- * @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);
-}
-
-msg_error_t MSG_parallel_task_execute_with_timeout(msg_task_t task, double timeout)
-{
-  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()));
-
-  if (task->flops_amount <= 0.0 && not task->host_nb) {
-    return MSG_OK;
-  }
-
-  if (TRACE_actor_is_enabled())
-    simgrid::instr::Container::by_name(instr_pid(MSG_process_self()))->get_state("ACTOR_STATE")->push_event("execute");
-
-  try {
-    task->set_used();
-
-    if (task->host_nb > 0) {
-      task->compute = boost::static_pointer_cast<simgrid::kernel::activity::ExecImpl>(
-          simcall_execution_parallel_start(std::move(task->get_name()), task->host_nb, task->host_list,
-                                           task->flops_parallel_amount, task->bytes_parallel_amount, -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())); });
-    } else {
-      sg_host_t host   = MSG_process_get_host(MSG_process_self());
-      task->compute    = simgrid::simix::simcall([task, host] {
-        return simgrid::kernel::activity::ExecImplPtr(new simgrid::kernel::activity::ExecImpl(
-            std::move(task->get_name()), std::move(task->get_tracing_category()), host));
-      });
-      /* checking for infinite values */
-      xbt_assert(std::isfinite(task->flops_amount), "flops_amount is not finite!");
-      xbt_assert(std::isfinite(task->priority), "priority is not finite!");
-
-      task->compute->start(task->flops_amount, task->priority, task->bound);
-    }
-
-    comp_state = simcall_execution_wait(task->compute);
-
-    task->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;
-  } catch (simgrid::TimeoutError& e) {
-    status = MSG_TIMEOUT;
-  } catch (simgrid::CancelException& e) {
-    status = MSG_TASK_CANCELED;
-  }
-
-  /* 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;
-}
-
 /**
  * @brief Receives a task from a mailbox.
  *
@@ -128,10 +40,8 @@ msg_error_t MSG_task_receive(msg_task_t * task, const char *alias)
  * @param alias name of the mailbox to receive the task from
  * @param rate limit the reception to rate bandwidth (byte/sec)
  *
- * The rate parameter can be used to receive a task with a limited
- * bandwidth (smaller than the physical available value). Use
- * MSG_task_receive() if you don't limit the rate (or pass -1 as a
- * rate value do disable this feature).
+ * The rate parameter can be used to receive a task with a limited bandwidth (smaller than the physical available
+ * value). Use MSG_task_receive() if you don't limit the rate (or pass -1 as a rate value do disable this feature).
  *
  * @return Returns
  * #MSG_OK if the task was successfully received,
@@ -179,7 +89,7 @@ msg_error_t MSG_task_receive_with_timeout(msg_task_t * task, const char *alias,
  * #MSG_OK if the task was successfully received,
  * #MSG_HOST_FAILURE, or #MSG_TRANSFER_FAILURE, or #MSG_TIMEOUT otherwise.
  */
-msg_error_t MSG_task_receive_with_timeout_bounded(msg_task_t * task, const char *alias, double timeout,double rate)
+msg_error_t MSG_task_receive_with_timeout_bounded(msg_task_t* task, const char* alias, double timeout, double rate)
 {
   return MSG_task_receive_ext_bounded(task, alias, timeout, nullptr, rate);
 }
@@ -215,10 +125,8 @@ msg_error_t MSG_task_receive_ext(msg_task_t * task, const char *alias, double ti
  * @param host a #msg_host_t host from where the task was sent
  * @param rate limit the reception to rate bandwidth (byte/sec)
  *
- * The rate parameter can be used to receive a task with a limited
- * bandwidth (smaller than the physical available value). Use
- * MSG_task_receive_ext() if you don't limit the rate (or pass -1 as a
- * rate value do disable this feature).
+ * The rate parameter can be used to receive a task with a limited bandwidth (smaller than the physical available
+ * value). Use MSG_task_receive_ext() if you don't limit the rate (or pass -1 as a rate value do disable this feature).
  *
  * @return Returns
  * #MSG_OK if the task was successfully received,
@@ -272,118 +180,6 @@ msg_error_t MSG_task_receive_ext_bounded(msg_task_t * task, const char *alias, d
   return ret;
 }
 
-/* Internal function used to factorize code between MSG_task_isend(), MSG_task_isend_bounded(), and MSG_task_dsend(). */
-static inline msg_comm_t MSG_task_isend_internal(msg_task_t task, const char* alias, void_f_pvoid_t cleanup,
-                                                 bool detached)
-{
-  msg_process_t myself = MSG_process_self();
-  simgrid::s4u::MailboxPtr mailbox = simgrid::s4u::Mailbox::by_name(alias);
-  TRACE_msg_task_put_start(task);
-
-  /* Prepare the task to send */
-  task->sender = myself;
-  task->set_used();
-  task->comm = nullptr;
-  msg_global->sent_msg++;
-
-  simgrid::s4u::CommPtr comm = mailbox->put_init(task, task->bytes_amount)->set_rate(task->rate);
-  task->comm                 = comm;
-  if (detached)
-    comm->detach(cleanup);
-  else
-    comm->start();
-
-  msg_comm_t msg_comm = nullptr;
-  if (not detached) {
-    msg_comm = new simgrid::msg::Comm(task, nullptr, comm);
-  }
-
-  if (TRACE_is_enabled() && task->has_tracing_category())
-    simgrid::simix::simcall([comm, task] { comm->get_impl()->set_category(std::move(task->get_tracing_category())); });
-
-  return msg_comm;
-}
-
-/**
- * @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 MSG_task_isend_internal(task, 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->rate = maxrate;
-  return MSG_task_isend_internal(task, 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)
-{
-  msg_comm_t XBT_ATTRIB_UNUSED comm = MSG_task_isend_internal(task, alias, cleanup, true);
-  xbt_assert(comm == nullptr);
-}
-
-/**
- * @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->rate = maxrate;
-  MSG_task_dsend(task, alias, cleanup);
-}
 
 /**
  * @brief Starts listening for receiving a task from an asynchronous communication.
@@ -424,10 +220,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);
 }
 
 /**
@@ -471,8 +270,7 @@ int MSG_comm_test(msg_comm_t comm)
  * @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
+ * (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)
 {
@@ -624,8 +422,7 @@ int MSG_comm_waitany(xbt_dynar_t comms)
 /**
  * @brief Returns the error (if any) that occurred during a finished communication.
  * @param comm a finished communication
- * @return the status of the communication, or #MSG_OK if no error occurred
- * during the communication
+ * @return the status of the communication, or #MSG_OK if no error occurred during the communication
  */
 msg_error_t MSG_comm_get_status(msg_comm_t comm) {
 
@@ -661,180 +458,22 @@ 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->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->sender = MSG_process_self();
-  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->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->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.
  *
  * @param alias the name of the mailbox to be considered
  *
  * @return Returns the PID of sender process,
- * -1 if there is no communication in the mailbox.
+ * -1 if there is no communication in the mailbox.#include <cmath>
+ *
  */
 int MSG_task_listen_from(const char *alias)
 {
+  /* looks inside the rdv directly. Not clean. */
   simgrid::kernel::activity::CommImplPtr comm = simgrid::s4u::Mailbox::by_name(alias)->front();
 
-  return comm ? MSG_process_get_PID(static_cast<msg_task_t>(comm->src_buff_)->sender) : -1;
-}
-
-/**
- * @brief Sets the tracing category of a task.
- *
- * This function should be called after the creation of a MSG task, to define the category of that task. The
- * first parameter task must contain a task that was  created with the function #MSG_task_create. The second
- * parameter category must contain a category that was previously declared with the function #TRACE_category
- * (or with #TRACE_category_with_color).
- *
- * See @ref outcomes_vizu for details on how to trace the (categorized) resource utilization.
- *
- * @param task the task that is going to be categorized
- * @param category the name of the category to be associated to the task
- *
- * @see MSG_task_get_category, TRACE_category, TRACE_category_with_color
- */
-void MSG_task_set_category (msg_task_t task, const char *category)
-{
-  xbt_assert(not task->has_tracing_category(), "Task %p(%s) already has a category (%s).", task, task->get_cname(),
-             task->get_tracing_category().c_str());
-
-  // if user provides a nullptr category, task is no longer traced
-  if (category == nullptr) {
-    task->set_tracing_category("");
-    XBT_DEBUG("MSG task %p(%s), category removed", task, task->get_cname());
-  } else {
-    // set task category
-    task->set_tracing_category(category);
-    XBT_DEBUG("MSG task %p(%s), category %s", task, task->get_cname(), task->get_tracing_category().c_str());
-  }
-}
-
-/**
- * @brief Gets the current tracing category of a task.
- *
- * @param task the task to be considered
- *
- * @see MSG_task_set_category
- *
- * @return Returns the name of the tracing category of the given task, nullptr otherwise
- */
-const char *MSG_task_get_category (msg_task_t task)
-{
-  return task->get_tracing_category().c_str();
+  if (comm && comm->src_actor_)
+    return comm->src_actor_->get_pid();
+  else
+    return -1;
 }