Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
mv the internal isend function to the class
[simgrid.git] / src / msg / msg_gos.cpp
index 81b3e33..36d0b0f 100644 (file)
@@ -3,37 +3,23 @@
 /* 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/Comm.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
+ * @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)
 {
@@ -42,17 +28,14 @@ msg_error_t MSG_parallel_task_execute(msg_task_t task)
 
 msg_error_t MSG_parallel_task_execute_with_timeout(msg_task_t task, double timeout)
 {
-  simdata_task_t simdata = task->simdata;
   e_smx_state_t comp_state;
   msg_error_t status = MSG_OK;
 
-
-  xbt_assert((not simdata->compute) && not task->simdata->isused,
-             "This task is executed somewhere else. Go fix your code!");
+  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 (simdata->flops_amount <= 0.0 && not simdata->host_nb) {
+  if (task->flops_amount <= 0.0 && not task->hosts_.empty()) {
     return MSG_OK;
   }
 
@@ -60,35 +43,21 @@ msg_error_t MSG_parallel_task_execute_with_timeout(msg_task_t task, double timeo
     simgrid::instr::Container::by_name(instr_pid(MSG_process_self()))->get_state("ACTOR_STATE")->push_event("execute");
 
   try {
-    simdata->setUsed();
-
-    if (simdata->host_nb > 0) {
-      simdata->compute =
-          boost::static_pointer_cast<simgrid::kernel::activity::ExecImpl>(simcall_execution_parallel_start(
-              task->name ?: "", simdata->host_nb, simdata->host_list, simdata->flops_parallel_amount,
-              simdata->bytes_parallel_amount, -1.0, timeout));
-      XBT_DEBUG("Parallel execution action created: %p", simdata->compute.get());
-      if (task->category != nullptr)
-        simgrid::simix::simcall([task] { task->simdata->compute->set_category(task->category); });
-    } else {
-      sg_host_t host   = MSG_process_get_host(MSG_process_self());
-      simdata->compute = simgrid::simix::simcall([task, host] {
-        return simgrid::kernel::activity::ExecImplPtr(
-            new simgrid::kernel::activity::ExecImpl(task->name ?: "", task->category ?: "",
-                                                    /*timeout_detector*/ nullptr, host));
-      });
-      /* checking for infinite values */
-      xbt_assert(std::isfinite(simdata->flops_amount), "flops_amount is not finite!");
-      xbt_assert(std::isfinite(simdata->priority), "priority is not finite!");
-
-      simdata->compute->start(simdata->flops_amount, simdata->priority, simdata->bound);
-    }
+    task->set_used();
+
+    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(simdata->compute);
+    comp_state = simcall_execution_wait(task->compute);
 
-    simdata->setNotUsed();
+    task->set_not_used();
 
-    XBT_DEBUG("Execution task '%s' finished in state %d", task->name, (int)comp_state);
+    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) {
@@ -98,9 +67,9 @@ msg_error_t MSG_parallel_task_execute_with_timeout(msg_task_t task, double timeo
   }
 
   /* action ended, set comm and compute = nullptr, the actions is already destroyed in the main function */
-  simdata->flops_amount = 0.0;
-  simdata->comm = nullptr;
-  simdata->compute = nullptr;
+  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();
@@ -133,10 +102,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,
@@ -184,7 +151,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);
 }
@@ -220,10 +187,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,
@@ -253,14 +218,14 @@ msg_error_t MSG_task_receive_ext_bounded(msg_task_t * task, const char *alias, d
         ->set_rate(rate)
         ->wait_for(timeout);
     *task = static_cast<msg_task_t>(payload);
-    XBT_DEBUG("Got task %s from %s", (*task)->name, alias);
-    (*task)->simdata->setNotUsed();
+    XBT_DEBUG("Got task %s from %s", (*task)->get_cname(), alias);
+    (*task)->set_not_used();
   } catch (simgrid::HostFailureException& e) {
     ret = MSG_HOST_FAILURE;
   } catch (simgrid::TimeoutError& e) {
     ret = MSG_TIMEOUT;
   } catch (simgrid::CancelException& e) {
-    ret = MSG_HOST_FAILURE;
+    ret = MSG_TASK_CANCELED;
   } catch (xbt_ex& e) {
     if (e.category == network_error)
       ret = MSG_TRANSFER_FAILURE;
@@ -268,129 +233,15 @@ msg_error_t MSG_task_receive_ext_bounded(msg_task_t * task, const char *alias, d
       throw;
   }
 
-  if (ret != MSG_HOST_FAILURE && ret != MSG_TRANSFER_FAILURE && ret != MSG_TIMEOUT) {
-    TRACE_msg_task_get_end(*task);
-  }
-  return ret;
-}
+  if (TRACE_actor_is_enabled() && ret != MSG_HOST_FAILURE && ret != MSG_TRANSFER_FAILURE && ret != MSG_TIMEOUT) {
+    container_t process_container = simgrid::instr::Container::by_name(instr_pid(MSG_process_self()));
 
-/* 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, int detached)
-{
-  simdata_task_t t_simdata = nullptr;
-  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 */
-  t_simdata = task->simdata;
-  t_simdata->sender = myself;
-  t_simdata->source = MSG_host_self();
-  t_simdata->setUsed();
-  t_simdata->comm = nullptr;
-  msg_global->sent_msg++;
-
-  simgrid::s4u::CommPtr comm = mailbox->put_init(task, t_simdata->bytes_amount)->set_rate(t_simdata->rate);
-  t_simdata->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);
+    std::string key = std::string("p") + std::to_string((*task)->get_id());
+    simgrid::instr::Container::get_root()->get_link("ACTOR_TASK_LINK")->end_event(process_container, "SR", key);
   }
-
-  if (TRACE_is_enabled() && task->category != nullptr)
-    simgrid::simix::simcall([comm, task] { comm->get_impl()->set_category(task->category); });
-
-  TRACE_msg_task_put_end();
-
-  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, 0);
-}
-
-/**
- * @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->simdata->rate = maxrate;
-  return MSG_task_isend_internal(task, alias, nullptr, 0);
-}
-
-/**
- * @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, 1);
-  xbt_assert(comm == nullptr);
+  return ret;
 }
 
-/**
- * @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->simdata->rate = maxrate;
-  MSG_task_dsend(task, alias, cleanup);
-}
 
 /**
  * @brief Starts listening for receiving a task from an asynchronous communication.
@@ -453,11 +304,14 @@ int MSG_comm_test(msg_comm_t comm)
     finished = comm->s_comm->test();
     if (finished && comm->task_received != nullptr) {
       /* I am the receiver */
-      (*comm->task_received)->simdata->setNotUsed();
+      (*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) {
@@ -475,8 +329,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)
 {
@@ -497,6 +350,9 @@ int MSG_comm_testany(xbt_dynar_t comms)
   } catch (simgrid::TimeoutError& e) {
     finished_index = e.value;
     status         = MSG_TIMEOUT;
+  } catch (simgrid::CancelException& e) {
+    finished_index = e.value;
+    status         = MSG_TASK_CANCELED;
   }
   catch (xbt_ex& e) {
     if (e.category != network_error)
@@ -512,7 +368,7 @@ int MSG_comm_testany(xbt_dynar_t comms)
 
     if (status == MSG_OK && comm->task_received != nullptr) {
       /* I am the receiver */
-      (*comm->task_received)->simdata->setNotUsed();
+      (*comm->task_received)->set_not_used();
     }
   }
 
@@ -540,12 +396,14 @@ msg_error_t MSG_comm_wait(msg_comm_t comm, double timeout)
 
     if (comm->task_received != nullptr) {
       /* I am the receiver */
-      (*comm->task_received)->simdata->setNotUsed();
+      (*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)
@@ -593,6 +451,9 @@ int MSG_comm_waitany(xbt_dynar_t comms)
   } catch (simgrid::TimeoutError& e) {
     finished_index = e.value;
     status         = MSG_TIMEOUT;
+  } catch (simgrid::CancelException& e) {
+    finished_index = e.value;
+    status         = MSG_TASK_CANCELED;
   }
   catch(xbt_ex& e) {
     if (e.category == network_error) {
@@ -611,7 +472,7 @@ int MSG_comm_waitany(xbt_dynar_t comms)
 
   if (comm->task_received != nullptr) {
     /* I am the receiver */
-    (*comm->task_received)->simdata->setNotUsed();
+    (*comm->task_received)->set_not_used();
   }
 
   return finished_index;
@@ -620,8 +481,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) {
 
@@ -682,10 +542,8 @@ msg_error_t MSG_task_send(msg_task_t task, const char *alias)
  * 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).
+ * 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
@@ -696,7 +554,7 @@ msg_error_t MSG_task_send(msg_task_t task, const char *alias)
  */
 msg_error_t MSG_task_send_bounded(msg_task_t task, const char *alias, double maxrate)
 {
-  task->simdata->rate = maxrate;
+  task->set_rate(maxrate);
   return MSG_task_send(task, alias);
 }
 
@@ -719,21 +577,19 @@ msg_error_t MSG_task_send_with_timeout(msg_task_t task, const char *alias, doubl
   TRACE_msg_task_put_start(task);
 
   /* Prepare the task to send */
-  simdata_task_t t_simdata = task->simdata;
-  t_simdata->sender        = MSG_process_self();
-  t_simdata->source = MSG_host_self();
-  t_simdata->setUsed();
+  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, t_simdata->bytes_amount)->set_rate(t_simdata->rate);
-    t_simdata->comm = 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->category != nullptr)
-      simgrid::simix::simcall([comm, task] { comm->get_impl()->set_category(task->category); });
+    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;
@@ -746,7 +602,7 @@ msg_error_t MSG_task_send_with_timeout(msg_task_t task, const char *alias, doubl
       throw;
 
     /* If the send failed, it is not used anymore */
-    t_simdata->setNotUsed();
+    task->set_not_used();
   }
 
   return ret;
@@ -757,10 +613,9 @@ msg_error_t MSG_task_send_with_timeout(msg_task_t task, const char *alias, doubl
  *
  * 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).
+ * 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
@@ -772,7 +627,7 @@ msg_error_t MSG_task_send_with_timeout(msg_task_t task, const char *alias, doubl
  */
 msg_error_t MSG_task_send_with_timeout_bounded(msg_task_t task, const char *alias, double timeout, double maxrate)
 {
-  task->simdata->rate = maxrate;
+  task->set_rate(maxrate);
   return MSG_task_send_with_timeout(task, alias, timeout);
 }
 
@@ -782,45 +637,17 @@ msg_error_t MSG_task_send_with_timeout_bounded(msg_task_t task, const char *alia
  * @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_)->simdata->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)
-{
-  TRACE_msg_set_task_category (task, category);
+  if (comm && comm->src_actor_)
+    return comm->src_actor_->get_pid();
+  else
+    return -1;
 }
 
-/**
- * @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->category;
-}