Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
cleanups after introduction of Exec::wait_for(timeout)
[simgrid.git] / src / msg / msg_task.cpp
index 7284a20..24cbd4b 100644 (file)
@@ -19,10 +19,11 @@ namespace simgrid {
 namespace msg {
 
 Task::Task(const std::string& name, double flops_amount, double bytes_amount, void* data)
-    : name_(name), userdata_(data), flops_amount(flops_amount), bytes_amount(bytes_amount)
+    : name_(name), flops_amount(flops_amount), bytes_amount(bytes_amount)
 {
   static std::atomic_ullong counter{0};
   id_ = counter++;
+  set_data(data);
   if (MC_is_active())
     MC_ignore_heap(&(id_), sizeof(id_));
 }
@@ -45,7 +46,7 @@ Task* Task::create(const std::string& name, double flops_amount, double bytes_am
 Task* Task::create_parallel(const std::string& name, int host_nb, const msg_host_t* host_list, double* flops_amount,
                             double* bytes_amount, void* data)
 {
-  std::vector<simgrid::s4u::Host*> hosts(host_list, host_list + host_nb);
+  std::vector<s4u::Host*> hosts(host_list, host_list + host_nb);
   std::vector<double> flops;
   std::vector<double> bytes;
   if (flops_amount != nullptr)
@@ -74,16 +75,15 @@ msg_error_t Task::execute()
 
     compute->set_name(name_)
         ->set_tracing_category(tracing_category_)
-        ->set_timeout(timeout_)
         ->set_priority(1 / priority_)
         ->set_bound(bound_)
-        ->wait();
+        ->wait_for(timeout_);
 
     set_not_used();
     XBT_DEBUG("Execution task '%s' finished", get_cname());
   } catch (const HostFailureException&) {
     status = MSG_HOST_FAILURE;
-  } catch (const TimeoutError&) {
+  } catch (const TimeoutException&) {
     status = MSG_TIMEOUT;
   } catch (const CancelException&) {
     status = MSG_TASK_CANCELED;
@@ -100,9 +100,9 @@ msg_error_t Task::execute()
 s4u::CommPtr Task::send_async(const 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()));
+    container_t process_container = 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);
+    instr::Container::get_root()->get_link("ACTOR_TASK_LINK")->start_event(process_container, "SR", key);
   }
 
   /* Prepare the task to send */
@@ -133,11 +133,11 @@ msg_error_t Task::send(const std::string& alias, double timeout)
     s4u::CommPtr s4u_comm = send_async(alias, nullptr, false);
     comm                  = s4u_comm;
     comm->wait_for(timeout);
-  } catch (const simgrid::TimeoutError&) {
+  } catch (const TimeoutException&) {
     ret = MSG_TIMEOUT;
-  } catch (const simgrid::CancelException&) {
+  } catch (const CancelException&) {
     ret = MSG_HOST_FAILURE;
-  } catch (const simgrid::NetworkFailureException&) {
+  } catch (const NetworkFailureException&) {
     ret = MSG_TRANSFER_FAILURE;
     /* If the send failed, it is not used anymore */
     set_not_used();
@@ -203,7 +203,7 @@ void Task::report_multiple_use() const
  * @param flop_amount a value of the processing amount (in flop) needed to process this new task.
  * If 0, then it cannot be executed with MSG_task_execute(). This value has to be >=0.
  * @param message_size a value of the amount of data (in bytes) needed to transfer this new task. If 0, then it cannot
- * be transfered with MSG_task_send() and MSG_task_recv(). This value has to be >=0.
+ * be transferred with MSG_task_send() and MSG_task_recv(). This value has to be >=0.
  * @param data a pointer to any data may want to attach to the new object.  It is for user-level information and can
  * be nullptr. It can be retrieved with the function @ref MSG_task_get_data.
  * @return The new corresponding object.
@@ -243,28 +243,13 @@ msg_task_t MSG_parallel_task_create(const char *name, int host_nb, const msg_hos
 /** @brief Return the user data of the given task */
 void* MSG_task_get_data(msg_task_t task)
 {
-  return task->get_user_data();
+  return task->get_data();
 }
 
 /** @brief Sets the user data of a given task */
 void MSG_task_set_data(msg_task_t task, void *data)
 {
-  task->set_user_data(data);
-}
-
-/** @brief Sets a function to be called when a task has just been copied.
- * @param callback a callback function
- */
-// deprecated
-void MSG_task_set_copy_callback(void (*callback) (msg_task_t task, msg_process_t sender, msg_process_t receiver)) {
-
-  msg_global->task_copy_callback = callback;
-
-  if (callback) {
-    SIMIX_comm_set_copy_data_callback(MSG_comm_copy_data_from_SIMIX);
-  } else {
-    SIMIX_comm_set_copy_data_callback(SIMIX_comm_copy_pointer_callback);
-  }
+  task->set_data(data);
 }
 
 /** @brief Returns the sender of the given task */
@@ -532,7 +517,7 @@ msg_error_t MSG_task_receive_bounded(msg_task_t* task, const char* alias, double
  */
 msg_error_t MSG_task_receive_with_timeout(msg_task_t* task, const char* alias, double timeout)
 {
-  return MSG_task_receive_ext_bounded(task, alias, timeout, nullptr, -1);
+  return MSG_task_receive_with_timeout_bounded(task, alias, timeout, -1);
 }
 
 /**
@@ -554,55 +539,8 @@ msg_error_t MSG_task_receive_with_timeout(msg_task_t* task, const char* alias, d
  */
 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);
-}
-
-/**
- * @brief Receives a task from a mailbox from a specific host with a given timeout.
- *
- * This is a blocking function with a timeout, the execution flow will be blocked until the task is received or the
- * timeout is achieved. See #MSG_task_irecv for receiving tasks asynchronously. You can provide a -1 timeout
- * to obtain an infinite timeout.
- *
- * @param task a memory location for storing a #msg_task_t.
- * @param alias name of the mailbox to receive the task from
- * @param timeout is the maximum wait time for completion (provide -1 for no timeout)
- * @param host a #msg_host_t host from where the task was sent
- *
- * @return Returns
- * #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_ext(msg_task_t* task, const char* alias, double timeout, msg_host_t host)
-{
-  XBT_DEBUG("MSG_task_receive_ext: Trying to receive a message on mailbox '%s'", alias);
-  return MSG_task_receive_ext_bounded(task, alias, timeout, host, -1.0);
-}
-
-/**
- * @brief Receives a task from a mailbox from a specific host with a given timeout  and at a given rate.
- *
- * @param task a memory location for storing a #msg_task_t.
- * @param alias name of the mailbox to receive the task from
- * @param timeout is the maximum wait time for completion (provide -1 for no timeout)
- * @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).
- *
- * @return Returns
- * #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_ext_bounded(msg_task_t* task, const char* alias, double timeout, msg_host_t host,
-                                         double rate)
-{
-  XBT_DEBUG("MSG_task_receive_ext: Trying to receive a message on mailbox '%s'", alias);
+  XBT_DEBUG("MSG_task_receive_with_timeout_bounded: Trying to receive a message on mailbox '%s'", alias);
   msg_error_t ret = MSG_OK;
-  /* We no longer support getting a task from a specific host */
-  if (host)
-    THROW_UNIMPLEMENTED;
 
   /* Sanity check */
   xbt_assert(task, "Null pointer for the task storage");
@@ -623,7 +561,7 @@ msg_error_t MSG_task_receive_ext_bounded(msg_task_t* task, const char* alias, do
     (*task)->set_not_used();
   } catch (const simgrid::HostFailureException&) {
     ret = MSG_HOST_FAILURE;
-  } catch (const simgrid::TimeoutError&) {
+  } catch (const simgrid::TimeoutException&) {
     ret = MSG_TIMEOUT;
   } catch (const simgrid::CancelException&) {
     ret = MSG_TASK_CANCELED;
@@ -691,8 +629,7 @@ msg_comm_t MSG_task_irecv_bounded(msg_task_t* task, const char* name, double rat
  *
  * @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.#include <cmath>
+ * @return Returns the PID of sender process (or -1 if there is no communication in the mailbox)
  *
  */
 int MSG_task_listen_from(const char* alias)
@@ -731,7 +668,7 @@ msg_error_t MSG_task_destroy(msg_task_t task)
 
 /** @brief Cancel the given task
  *
- * If it was currently executed or transfered, the working process is stopped.
+ * If it was currently executed or transferred, the working process is stopped.
  */
 msg_error_t MSG_task_cancel(msg_task_t task)
 {
@@ -745,8 +682,8 @@ msg_error_t MSG_task_cancel(msg_task_t task)
  *
  * It works for either parallel or sequential tasks.
  */
-double MSG_task_get_remaining_work_ratio(msg_task_t task) {
-
+double MSG_task_get_remaining_work_ratio(msg_task_t task)
+{
   xbt_assert((task != nullptr), "Cannot get information from a nullptr task");
   if (task->compute) {
     // Task in progress