Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
objectify simdata_task_t
[simgrid.git] / src / msg / msg_task.cpp
index 07e6db9..7eb541a 100644 (file)
@@ -1,4 +1,4 @@
-/* Copyright (c) 2004-2018. The SimGrid Team. All rights reserved.          */
+/* Copyright (c) 2004-2019. The SimGrid Team. All rights reserved.          */
 
 /* 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. */
@@ -6,10 +6,30 @@
 #include "msg_private.hpp"
 #include "src/simix/smx_private.hpp"
 #include <algorithm>
+#include <cmath>
+#include <simgrid/modelchecker.h>
+#include <simgrid/s4u/Comm.hpp>
 
 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(msg_task, msg, "Logging specific to MSG (task)");
 
-void s_simdata_task_t::reportMultipleUse() const
+namespace simgrid {
+namespace msg {
+Task::~Task()
+{
+  /* parallel tasks only */
+  delete[] host_list;
+  delete[] flops_parallel_amount;
+  delete[] bytes_parallel_amount;
+}
+
+void Task::set_used()
+{
+  if (this->is_used)
+    this->report_multiple_use();
+  this->is_used = true;
+}
+
+void Task::report_multiple_use() const
 {
   if (msg_global->debug_multiple_use){
     XBT_ERROR("This task is already used in there:");
@@ -22,11 +42,14 @@ void s_simdata_task_t::reportMultipleUse() const
              "(use --cfg=msg/debug-multiple-use:on to get the backtrace of the other process)");
   }
 }
+} // namespace msg
+} // namespace simgrid
 
 /********************************* Task **************************************/
-/** @brief Creates a new #msg_task_t.
+/** @brief Creates a new task
+ *
+ * A constructor for msg_task_t taking four arguments.
  *
- * A constructor for #msg_task_t taking four arguments and returning the corresponding object.
  * @param name a name for the object. It is for user-level information and can be nullptr.
  * @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.
@@ -34,34 +57,35 @@ void s_simdata_task_t::reportMultipleUse() const
  * be transfered 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.
- * @see msg_task_t
  * @return The new corresponding object.
  */
 msg_task_t MSG_task_create(const char *name, double flop_amount, double message_size, void *data)
 {
+  static std::atomic_ullong counter{0};
+
   msg_task_t task        = new s_msg_task_t;
-  simdata_task_t simdata = new s_simdata_task_t();
-  task->simdata = simdata;
+  /* Simulator Data */
+  task->simdata = new simgrid::msg::Task(flop_amount, message_size);
 
   /* Task structure */
   task->name = xbt_strdup(name);
   task->data = data;
 
-  /* Simulator Data */
-  simdata->bytes_amount = message_size;
-  simdata->flops_amount = flop_amount;
+  task->counter  = counter++;
+  task->category = nullptr;
 
-  TRACE_msg_task_create(task);
+  if (MC_is_active())
+    MC_ignore_heap(&(task->counter), sizeof(task->counter));
 
   return task;
 }
 
-/** @brief Creates a new #msg_task_t (a parallel one....).
+/** @brief Creates a new parallel task
  *
- * A constructor for #msg_task_t taking six arguments and returning the corresponding object.
+ * A constructor for #msg_task_t taking six arguments.
  *
  * \rst
- * See :cpp:func:`void simgrid::s4u::this_actor::parallel_execute(int, s4u::Host*, double*, double*)` for
+ * See :cpp:func:`void simgrid::s4u::this_actor::parallel_execute(int, s4u::Host**, double*, double*)` for
  * the exact semantic of the parameters.
  * \endrst
  *
@@ -99,20 +123,13 @@ msg_task_t MSG_parallel_task_create(const char *name, int host_nb, const msg_hos
   return task;
 }
 
-/** @brief Return the user data of a #msg_task_t.
- *
- * This function checks whether @a task is a valid pointer and return the user data associated to @a task if possible.
- */
+/** @brief Return the user data of the given task */
 void *MSG_task_get_data(msg_task_t task)
 {
   return (task->data);
 }
 
-/** @ingroup m_task_management
- * @brief Sets the user data of a #msg_task_t.
- *
- * This function allows to associate a new pointer to the user data associated of @a task.
- */
+/** @brief Sets the user data of a given task */
 void MSG_task_set_data(msg_task_t task, void *data)
 {
   task->data = data;
@@ -132,45 +149,33 @@ void MSG_task_set_copy_callback(void (*callback) (msg_task_t task, msg_process_t
   }
 }
 
-/** @brief Return the sender of a #msg_task_t.
- *
- * This functions returns the #msg_process_t which sent this task
- */
+/** @brief Returns the sender of the given task */
 msg_process_t MSG_task_get_sender(msg_task_t task)
 {
   return task->simdata->sender;
 }
 
-/** @brief Return the source of a #msg_task_t.
- *
- * This functions returns the #msg_host_t from which this task was sent
- */
+/** @brief Returns the source (the sender's host) of the given task */
 msg_host_t MSG_task_get_source(msg_task_t task)
 {
-  return task->simdata->source;
+  return task->simdata->sender->get_host();
 }
 
-/** @brief Return the name of a #msg_task_t.
- *
- * This functions returns the name of a #msg_task_t as specified on creation
- */
+/** @brief Returns the name of the given task. */
 const char *MSG_task_get_name(msg_task_t task)
 {
   return task->name;
 }
 
-/** @brief Sets the name of a #msg_task_t.
- *
- * This functions allows to associate a name to a task
- */
+/** @brief Sets the name of the given task. */
 void MSG_task_set_name(msg_task_t task, const char *name)
 {
   task->name = xbt_strdup(name);
 }
 
-/** @brief Destroy a #msg_task_t.
+/** @brief Destroys the given task.
  *
- * Destructor for #msg_task_t. Note that you should free user data, if any, @b before calling this function.
+ * You should free user data, if any, @b before calling this destructor.
  *
  * Only the process that owns the task can destroy it.
  * The owner changes after a successful send.
@@ -180,12 +185,12 @@ void MSG_task_set_name(msg_task_t task, const char *name)
  */
 msg_error_t MSG_task_destroy(msg_task_t task)
 {
-  if (task->simdata->isused) {
+  if (task->simdata->is_used) {
     /* the task is being sent or executed: cancel it first */
     MSG_task_cancel(task);
   }
-  TRACE_msg_task_destroy(task);
 
+  xbt_free(task->category);
   xbt_free(task->name);
 
   /* free main structures */
@@ -195,8 +200,9 @@ msg_error_t MSG_task_destroy(msg_task_t task)
   return MSG_OK;
 }
 
-/** @brief Cancel a #msg_task_t.
- * @param task the task to cancel. If it was executed or transfered, it stops the process that were working on it.
+/** @brief Cancel the given task
+ *
+ * If it was currently executed or transfered, the working process is stopped.
  */
 msg_error_t MSG_task_cancel(msg_task_t task)
 {
@@ -204,11 +210,11 @@ msg_error_t MSG_task_cancel(msg_task_t task)
 
   simdata_task_t simdata = task->simdata;
   if (simdata->compute) {
-    simcall_execution_cancel(simdata->compute);
+    simgrid::simix::simcall([simdata] { simdata->compute->cancel(); });
   } else if (simdata->comm) {
-    simcall_comm_cancel(simdata->comm);
+    simdata->comm->cancel();
   }
-  simdata->setNotUsed();
+  simdata->set_not_used();
   return MSG_OK;
 }
 
@@ -247,7 +253,7 @@ double MSG_task_get_flops_amount(msg_task_t task) {
   }
 }
 
-/** @brief set the computation amount needed to process a task #msg_task_t.
+/** @brief set the computation amount needed to process the given task.
  *
  * @warning If the computation is ongoing (already started and not finished),
  * it is not modified by this call. Moreover, after its completion, the ongoing execution with set the flops_amount to
@@ -258,7 +264,7 @@ void MSG_task_set_flops_amount(msg_task_t task, double flops_amount)
   task->simdata->flops_amount = flops_amount;
 }
 
-/** @brief set the amount data attached with a task #msg_task_t.
+/** @brief set the amount data attached with the given task.
  *
  * @warning If the transfer is ongoing (already started and not finished), it is not modified by this call.
  */
@@ -267,36 +273,36 @@ void MSG_task_set_bytes_amount(msg_task_t task, double data_size)
   task->simdata->bytes_amount = data_size;
 }
 
-/** @brief Returns the total amount received by a task #msg_task_t.
- *        If the communication does not exist it will return 0.
- *        So, if the communication has FINISHED or FAILED it returns zero.
+/** @brief Returns the total amount received by the given task
+ *
+ *  If the communication does not exist it will return 0.
+ *  So, if the communication has FINISHED or FAILED it returns zero.
  */
 double MSG_task_get_remaining_communication(msg_task_t task)
 {
   XBT_DEBUG("calling simcall_communication_get_remains(%p)", task->simdata->comm.get());
-  return task->simdata->comm->remains();
+  return task->simdata->comm->get_remaining();
 }
 
-/** @brief Returns the size of the data attached to a task #msg_task_t.
- */
+/** @brief Returns the size of the data attached to the given task. */
 double MSG_task_get_bytes_amount(msg_task_t task)
 {
   xbt_assert((task != nullptr) && (task->simdata != nullptr), "Invalid parameter");
   return task->simdata->bytes_amount;
 }
 
-/** @brief Changes the priority of a computation task. This priority doesn't affect the transfer rate. A priority of 2
- *        will make a task receive two times more cpu power than the other ones.
+/** @brief Changes the priority of a computation task.
+ *
+ * This priority doesn't affect the transfer rate. A priority of 2
+ * will make a task receive two times more cpu power than regular tasks.
  */
 void MSG_task_set_priority(msg_task_t task, double priority)
 {
   task->simdata->priority = 1 / priority;
-  if (task->simdata->compute)
-    simcall_execution_set_priority(task->simdata->compute, task->simdata->priority);
+  xbt_assert(std::isfinite(task->simdata->priority), "priority is not finite!");
 }
 
-/** @brief Changes the maximum CPU utilization of a computation task.
- *        Unit is flops/s.
+/** @brief Changes the maximum CPU utilization of a computation task (in flops/s).
  *
  * For VMs, there is a pitfall. Please see MSG_vm_set_bound().
  */
@@ -304,8 +310,5 @@ void MSG_task_set_bound(msg_task_t task, double bound)
 {
   if (bound < 1e-12) /* close enough to 0 without any floating precision surprise */
     XBT_INFO("bound == 0 means no capping (i.e., unlimited).");
-
   task->simdata->bound = bound;
-  if (task->simdata->compute)
-    simcall_execution_set_bound(task->simdata->compute, task->simdata->bound);
 }