X-Git-Url: http://info.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/blobdiff_plain/2d876f901f44194d3e67936fd054b192a6b7f097..1bf033cc925aa31693ef5163ea056fde5b75ff1e:/src/msg/msg_task.cpp

diff --git a/src/msg/msg_task.cpp b/src/msg/msg_task.cpp
index bb76800766..57b1636953 100644
--- a/src/msg/msg_task.cpp
+++ b/src/msg/msg_task.cpp
@@ -1,13 +1,11 @@
-/* Copyright (c) 2004-2015. The SimGrid Team.
- * All rights reserved.                                                     */
+/* Copyright (c) 2004-2018. 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. */
 
-#include "msg_private.h"
-#include "src/simix/smx_private.h"
-#include "xbt/sysdep.h"
-#include "xbt/log.h"
+#include "msg_private.hpp"
+#include "src/simix/smx_private.hpp"
+#include <algorithm>
 
 /** @addtogroup m_task_management
  *
@@ -19,6 +17,20 @@
 
 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(msg_task, msg, "Logging specific to MSG (task)");
 
+void s_simdata_task_t::reportMultipleUse() const
+{
+  if (msg_global->debug_multiple_use){
+    XBT_ERROR("This task is already used in there:");
+    // TODO, backtrace
+    XBT_ERROR("<missing backtrace>");
+    XBT_ERROR("And you try to reuse it from here:");
+    xbt_backtrace_display_current();
+  } else {
+    xbt_die("This task is still being used somewhere else. You cannot send it now. Go fix your code!"
+             "(use --cfg=msg/debug-multiple-use:on to get the backtrace of the other process)");
+  }
+}
+
 /********************************* Task **************************************/
 /** \ingroup m_task_management
  * \brief Creates a new #msg_task_t.
@@ -36,8 +48,8 @@ XBT_LOG_NEW_DEFAULT_SUBCATEGORY(msg_task, msg, "Logging specific to MSG (task)")
  */
 msg_task_t MSG_task_create(const char *name, double flop_amount, double message_size, void *data)
 {
-  msg_task_t task = xbt_new(s_msg_task_t, 1);
-  simdata_task_t simdata = xbt_new(s_simdata_task_t, 1);
+  msg_task_t task        = new s_msg_task_t;
+  simdata_task_t simdata = new s_simdata_task_t();
   task->simdata = simdata;
 
   /* Task structure */
@@ -45,23 +57,9 @@ msg_task_t MSG_task_create(const char *name, double flop_amount, double message_
   task->data = data;
 
   /* Simulator Data */
-  simdata->compute = nullptr;
-  simdata->comm = nullptr;
   simdata->bytes_amount = message_size;
   simdata->flops_amount = flop_amount;
-  simdata->sender = nullptr;
-  simdata->receiver = nullptr;
-  simdata->source = nullptr;
-  simdata->priority = 1.0;
-  simdata->bound = 0;
-  simdata->affinity_mask_db = xbt_dict_new_homogeneous(nullptr);
-  simdata->rate = -1.0;
-  simdata->isused = 0;
-
-  simdata->host_nb = 0;
-  simdata->host_list = nullptr;
-  simdata->flops_parallel_amount = nullptr;
-  simdata->bytes_parallel_amount = nullptr;
+
   TRACE_msg_task_create(task);
 
   return task;
@@ -86,18 +84,23 @@ msg_task_t MSG_task_create(const char *name, double flop_amount, double message_
 msg_task_t MSG_parallel_task_create(const char *name, int host_nb, const msg_host_t * host_list,
                                     double *flops_amount, double *bytes_amount, void *data)
 {
-  msg_task_t task = MSG_task_create(name, 0, 0, data);
+  // Task's flops amount is set to an arbitrary value > 0.0 to be able to distinguish, in
+  // MSG_task_get_remaining_work_ratio(), a finished task and a task that has not started yet.
+  msg_task_t task        = MSG_task_create(name, 1.0, 0, data);
   simdata_task_t simdata = task->simdata;
-  int i;
 
   /* Simulator Data specific to parallel tasks */
   simdata->host_nb = host_nb;
-  simdata->host_list = xbt_new0(sg_host_t, host_nb);
-  simdata->flops_parallel_amount = flops_amount;
-  simdata->bytes_parallel_amount = bytes_amount;
-
-  for (i = 0; i < host_nb; i++)
-    simdata->host_list[i] = host_list[i];
+  simdata->host_list             = new sg_host_t[host_nb];
+  std::copy_n(host_list, host_nb, simdata->host_list);
+  if (flops_amount != nullptr) {
+    simdata->flops_parallel_amount = new double[host_nb];
+    std::copy_n(flops_amount, host_nb, simdata->flops_parallel_amount);
+  }
+  if (bytes_amount != nullptr) {
+    simdata->bytes_parallel_amount = new double[host_nb * host_nb];
+    std::copy_n(bytes_amount, host_nb * host_nb, simdata->bytes_parallel_amount);
+  }
 
   return task;
 }
@@ -109,7 +112,6 @@ msg_task_t MSG_parallel_task_create(const char *name, int host_nb, const msg_hos
  */
 void *MSG_task_get_data(msg_task_t task)
 {
-  xbt_assert((task != nullptr), "Invalid parameter");
   return (task->data);
 }
 
@@ -120,7 +122,6 @@ void *MSG_task_get_data(msg_task_t task)
  */
 void MSG_task_set_data(msg_task_t task, void *data)
 {
-  xbt_assert((task != nullptr), "Invalid parameter");
   task->data = data;
 }
 
@@ -146,8 +147,7 @@ void MSG_task_set_copy_callback(void (*callback) (msg_task_t task, msg_process_t
  */
 msg_process_t MSG_task_get_sender(msg_task_t task)
 {
-  xbt_assert(task, "Invalid parameters");
-  return ((simdata_task_t) task->simdata)->sender;
+  return task->simdata->sender;
 }
 
 /** \ingroup m_task_management
@@ -157,8 +157,7 @@ msg_process_t MSG_task_get_sender(msg_task_t task)
  */
 msg_host_t MSG_task_get_source(msg_task_t task)
 {
-  xbt_assert(task, "Invalid parameters");
-  return ((simdata_task_t) task->simdata)->source;
+  return task->simdata->source;
 }
 
 /** \ingroup m_task_management
@@ -168,7 +167,6 @@ msg_host_t MSG_task_get_source(msg_task_t task)
  */
 const char *MSG_task_get_name(msg_task_t task)
 {
-  xbt_assert(task, "Invalid parameters");
   return task->name;
 }
 
@@ -179,7 +177,6 @@ const char *MSG_task_get_name(msg_task_t task)
  */
 void MSG_task_set_name(msg_task_t task, const char *name)
 {
-  xbt_assert(task, "Invalid parameters");
   task->name = xbt_strdup(name);
 }
 
@@ -196,8 +193,6 @@ void MSG_task_set_name(msg_task_t task, const char *name)
  */
 msg_error_t MSG_task_destroy(msg_task_t task)
 {
-  xbt_assert((task != nullptr), "Invalid parameter");
-
   if (task->simdata->isused) {
     /* the task is being sent or executed: cancel it first */
     MSG_task_cancel(task);
@@ -206,17 +201,9 @@ msg_error_t MSG_task_destroy(msg_task_t task)
 
   xbt_free(task->name);
 
-  if (task->simdata->compute)
-    task->simdata->compute->unref();
-
-  /* parallel tasks only */
-  xbt_free(task->simdata->host_list);
-
-  xbt_dict_free(&task->simdata->affinity_mask_db);
-
   /* free main structures */
-  xbt_free(task->simdata);
-  xbt_free(task);
+  delete task->simdata;
+  delete task;
 
   return MSG_OK;
 }
@@ -229,29 +216,49 @@ msg_error_t MSG_task_cancel(msg_task_t task)
 {
   xbt_assert((task != nullptr), "Cannot cancel a nullptr task");
 
-  if (task->simdata->compute) {
-    simcall_execution_cancel(task->simdata->compute);
-  }
-  else if (task->simdata->comm) {
-    simdata_task_t simdata = task->simdata;
+  simdata_task_t simdata = task->simdata;
+  if (simdata->compute) {
+    simcall_execution_cancel(simdata->compute);
+  } else if (simdata->comm) {
     simcall_comm_cancel(simdata->comm);
-    if (msg_global->debug_multiple_use && simdata->isused!=0)
-      xbt_ex_free(*(xbt_ex_t*)simdata->isused);
-    simdata->isused = 0;
   }
+  simdata->setNotUsed();
   return MSG_OK;
 }
 
 /** \ingroup m_task_management
- * \brief Returns the remaining amount of flops needed to execute a task #msg_task_t.
+ * \brief Returns a value in ]0,1[ that represent the task remaining work
+ *    to do: starts at 1 and goes to 0. Returns 0 if not started or finished.
  *
- * Once a task has been processed, this amount is set to 0. If you want, you can reset this value with
- * #MSG_task_set_flops_amount before restarting the task.
+ * It works for either parallel or sequential tasks.
  */
-double MSG_task_get_flops_amount(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->simdata->compute) {
-    return task->simdata->compute->remains();
+    // Task in progress
+    return task->simdata->compute->get_remaining_ratio();
   } else {
+    // Task not started (flops_amount is > 0.0) or finished (flops_amount is set to 0.0)
+    return task->simdata->flops_amount > 0.0 ? 1.0 : 0.0;
+  }
+}
+
+/** \ingroup m_task_management
+ * \brief Returns the amount of flops that remain to be computed
+ *
+ * The returned value is initially the cost that you defined for the task, then it decreases until it reaches 0
+ *
+ * It works for sequential tasks, but the remaining amount of work is not a scalar value for parallel tasks.
+ * So you will get an exception if you call this function on parallel tasks. Just don't do it.
+ */
+double MSG_task_get_flops_amount(msg_task_t task) {
+  if (task->simdata->compute != nullptr) {
+    return task->simdata->compute->get_remaining();
+  } else {
+    // Not started or already done.
+    // - Before starting, flops_amount is initially the task cost
+    // - After execution, flops_amount is set to 0 (until someone uses MSG_task_set_flops_amount, if any)
     return task->simdata->flops_amount;
   }
 }
@@ -285,7 +292,7 @@ void MSG_task_set_bytes_amount(msg_task_t task, double data_size)
  */
 double MSG_task_get_remaining_communication(msg_task_t task)
 {
-  XBT_DEBUG("calling simcall_communication_get_remains(%p)", task->simdata->comm);
+  XBT_DEBUG("calling simcall_communication_get_remains(%p)", task->simdata->comm.get());
   return task->simdata->comm->remains();
 }
 
@@ -304,11 +311,9 @@ double MSG_task_get_bytes_amount(msg_task_t task)
  */
 void MSG_task_set_priority(msg_task_t task, double priority)
 {
-  xbt_assert((task != nullptr) && (task->simdata != nullptr), "Invalid parameter");
   task->simdata->priority = 1 / priority;
   if (task->simdata->compute)
-    simcall_execution_set_priority(task->simdata->compute,
-        task->simdata->priority);
+    simcall_execution_set_priority(task->simdata->compute, task->simdata->priority);
 }
 
 /** \ingroup m_task_management
@@ -319,91 +324,10 @@ void MSG_task_set_priority(msg_task_t task, double priority)
  */
 void MSG_task_set_bound(msg_task_t task, double bound)
 {
-  xbt_assert(task, "Invalid parameter");
-  xbt_assert(task->simdata, "Invalid parameter");
-
-  if (bound == 0)
+  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);
 }
-
-/** \ingroup m_task_management
- * \brief Changes the CPU affinity of a computation task.
- *
- * When pinning the given task to the first CPU core of the given host, use 0x01 for the mask value. Each bit of the
- * mask value corresponds to each CPU core. See taskset(1) on Linux.
- *
- * \param task a target task
- * \param host the host having a multi-core CPU
- * \param mask the bit mask of a new CPU affinity setting for the task
- *
- * Usage:
- * 0. Define a host with multiple cores.
- *    \<host id="PM0" power="1E8" core="2"/\>
- *
- * 1. Pin a given task to the first CPU core of a host.
- *   MSG_task_set_affinity(task, pm0, 0x01);
- *
- * 2. Pin a given task to the third CPU core of a host. Turn on the third bit of the mask.
- *   MSG_task_set_affinity(task, pm0, 0x04); // 0x04 == 100B
- *
- * 3. Pin a given VM to the first CPU core of a host.
- *   MSG_vm_set_affinity(vm, pm0, 0x01);
- *
- * See examples/msg/cloud/multicore.c for more information.
- *
- * Note:
- * 1. The current code does not allow an affinity of a task to multiple cores.
- *    The mask value 0x03 (i.e., a given task will be executed on the first core or the second core) is not allowed.
- *    The mask value 0x01 or 0x02 works. See cpu_cas01.c for details.
- *
- * 2. It is recommended to first compare simulation results in both the Lazy and Full calculation modes
- *    (using --cfg=cpu/optim:Full or not). Fix cpu_cas01.c if you find wrong results in the Lazy mode.
- */
-void MSG_task_set_affinity(msg_task_t task, msg_host_t host, unsigned long mask)
-{
-  xbt_assert(task, "Invalid parameter");
-  xbt_assert(task->simdata, "Invalid parameter");
-
-  if (mask == 0) {
-    /* 0 means clear */
-      /* We need remove_ext() not throwing exception. */
-      void *ret = xbt_dict_get_or_null_ext(task->simdata->affinity_mask_db, (char *) host, sizeof(msg_host_t));
-      if (ret != nullptr)
-        xbt_dict_remove_ext(task->simdata->affinity_mask_db, (char *) host, sizeof(host));
-  } else
-    xbt_dict_set_ext(task->simdata->affinity_mask_db, (char *) host, sizeof(host), (void *)(uintptr_t) mask, nullptr);
-
-  /* We set affinity data of this task. If the task is being executed, we actually change the affinity setting of the
-   * task. Otherwise, this change will be applied when the task is executed. */
-  if (!task->simdata->compute) {
-    /* task is not yet executed */
-    XBT_INFO("set affinity(0x%04lx@%s) for %s (not active now)", mask, MSG_host_get_name(host),
-             MSG_task_get_name(task));
-    return;
-  }
-
-  {
-    simgrid::simix::Exec *compute = task->simdata->compute;
-    msg_host_t host_now = compute->host;  // simix_private.h is necessary
-    if (host_now != host) {
-      /* task is not yet executed on this host */
-      XBT_INFO("set affinity(0x%04lx@%s) for %s (not active now)", mask, MSG_host_get_name(host),
-               MSG_task_get_name(task));
-      return;
-    }
-
-    /* task is being executed on this host. so change the affinity now */
-    {
-      /* check it works. remove me if it works. */
-      xbt_assert((unsigned long)(uintptr_t) xbt_dict_get_or_null_ext(task->simdata->affinity_mask_db,
-                 (char *) host, sizeof(msg_host_t)) == mask);
-    }
-
-    XBT_INFO("set affinity(0x%04lx@%s) for %s", mask, MSG_host_get_name(host), MSG_task_get_name(task));
-    simcall_execution_set_affinity(task->simdata->compute, host, mask);
-  }
-}