Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
kill a useless function
[simgrid.git] / src / msg / msg_task.cpp
index b7e6a6d..a8b0c6b 100644 (file)
@@ -1,5 +1,4 @@
-/* Copyright (c) 2004-2015. The SimGrid Team.
- * All rights reserved.                                                     */
+/* Copyright (c) 2004-2016. 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. */
 
 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(msg_task, msg, "Logging specific to MSG (task)");
 
+void simdata_task::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.
  *
  * 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 NULL.
+ * \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.
  * \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.
  * \param data a pointer to any data may want to attach to the new object.  It is for user-level information and can
- * be NULL. It can be retrieved with the function \ref MSG_task_get_data.
+ * 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)
 {
   msg_task_t task = xbt_new(s_msg_task_t, 1);
-  simdata_task_t simdata = xbt_new(s_simdata_task_t, 1);
+  simdata_task_t simdata = new s_simdata_task_t();
   task->simdata = simdata;
 
   /* Task structure */
@@ -45,23 +58,22 @@ msg_task_t MSG_task_create(const char *name, double flop_amount, double message_
   task->data = data;
 
   /* Simulator Data */
-  simdata->compute = NULL;
-  simdata->comm = NULL;
+  simdata->compute = nullptr;
+  simdata->comm = nullptr;
   simdata->bytes_amount = message_size;
   simdata->flops_amount = flop_amount;
-  simdata->sender = NULL;
-  simdata->receiver = NULL;
-  simdata->source = NULL;
+  simdata->sender = nullptr;
+  simdata->receiver = nullptr;
+  simdata->source = nullptr;
   simdata->priority = 1.0;
   simdata->bound = 0;
-  simdata->affinity_mask_db = xbt_dict_new_homogeneous(NULL);
   simdata->rate = -1.0;
   simdata->isused = 0;
 
   simdata->host_nb = 0;
-  simdata->host_list = NULL;
-  simdata->flops_parallel_amount = NULL;
-  simdata->bytes_parallel_amount = NULL;
+  simdata->host_list = nullptr;
+  simdata->flops_parallel_amount = nullptr;
+  simdata->bytes_parallel_amount = nullptr;
   TRACE_msg_task_create(task);
 
   return task;
@@ -71,14 +83,14 @@ msg_task_t MSG_task_create(const char *name, double flop_amount, double message_
  * \brief Creates a new #msg_task_t (a parallel one....).
  *
  * A constructor for #msg_task_t taking six arguments and returning the corresponding object.
- * \param name a name for the object. It is for user-level information and can be NULL.
+ * \param name a name for the object. It is for user-level information and can be nullptr.
  * \param host_nb the number of hosts implied in the parallel task.
  * \param host_list an array of \p host_nb msg_host_t.
  * \param flops_amount an array of \p host_nb doubles.
  *        flops_amount[i] is the total number of operations that have to be performed on host_list[i].
  * \param bytes_amount an array of \p host_nb* \p host_nb doubles.
  * \param data a pointer to any data may want to attach to the new object.
- *             It is for user-level information and can be NULL.
+ *             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.
@@ -88,7 +100,6 @@ msg_task_t MSG_parallel_task_create(const char *name, int host_nb, const msg_hos
 {
   msg_task_t task = MSG_task_create(name, 0, 0, data);
   simdata_task_t simdata = task->simdata;
-  int i;
 
   /* Simulator Data specific to parallel tasks */
   simdata->host_nb = host_nb;
@@ -96,46 +107,12 @@ msg_task_t MSG_parallel_task_create(const char *name, int host_nb, const msg_hos
   simdata->flops_parallel_amount = flops_amount;
   simdata->bytes_parallel_amount = bytes_amount;
 
-  for (i = 0; i < host_nb; i++)
+  for (int i = 0; i < host_nb; i++)
     simdata->host_list[i] = host_list[i];
 
   return task;
 }
 
-/*************** Begin GPU ***************/
-/** \ingroup m_task_management
- * \brief Creates a new #msg_gpu_task_t.
-
- * A constructor for #msg_gpu_task_t taking four arguments and returning a pointer to the new created GPU task.
-
- * \param name a name for the object. It is for user-level information and can be NULL.
- * \param flops_amount a value of the processing amount (in flop)needed to process this new task. If 0, then it cannot
- * be executed with MSG_gpu_task_execute(). This value has to be >=0.
- * \param dispatch_latency time in seconds to load this task on the GPU
- * \param collect_latency time in seconds to transfer result from the GPU back to the CPU (host) when done
-
- * \see msg_gpu_task_t
- * \return The new corresponding object.
- */
-msg_gpu_task_t MSG_gpu_task_create(const char *name, double flops_amount, double dispatch_latency,
-                                   double collect_latency)
-{
-  msg_gpu_task_t task = xbt_new(s_msg_gpu_task_t, 1);
-  simdata_gpu_task_t simdata = xbt_new(s_simdata_gpu_task_t, 1);
-  task->simdata = simdata;
-  /* Task structure */
-  task->name = xbt_strdup(name);
-
-  /* Simulator Data */
-  simdata->flops_amount = flops_amount;
-  simdata->dispatch_latency   = dispatch_latency;
-  simdata->collect_latency    = collect_latency;
-
-  /* TRACE_msg_gpu_task_create(task); FIXME*/
-  return task;
-}
-/*************** End GPU ***************/
-
 /** \ingroup m_task_management
  * \brief Return the user data of a #msg_task_t.
  *
@@ -143,7 +120,6 @@ msg_gpu_task_t MSG_gpu_task_create(const char *name, double flops_amount, double
  */
 void *MSG_task_get_data(msg_task_t task)
 {
-  xbt_assert((task != NULL), "Invalid parameter");
   return (task->data);
 }
 
@@ -154,7 +130,6 @@ void *MSG_task_get_data(msg_task_t task)
  */
 void MSG_task_set_data(msg_task_t task, void *data)
 {
-  xbt_assert((task != NULL), "Invalid parameter");
   task->data = data;
 }
 
@@ -180,8 +155,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
@@ -191,8 +165,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
@@ -202,7 +175,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;
 }
 
@@ -213,7 +185,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);
 }
 
@@ -230,9 +201,6 @@ void MSG_task_set_name(msg_task_t task, const char *name)
  */
 msg_error_t MSG_task_destroy(msg_task_t task)
 {
-  smx_synchro_t action = NULL;
-  xbt_assert((task != NULL), "Invalid parameter");
-
   if (task->simdata->isused) {
     /* the task is being sent or executed: cancel it first */
     MSG_task_cancel(task);
@@ -241,17 +209,8 @@ msg_error_t MSG_task_destroy(msg_task_t task)
 
   xbt_free(task->name);
 
-  action = task->simdata->compute;
-  if (action)
-    simcall_execution_destroy(action);
-
-  /* parallel tasks only */
-  xbt_free(task->simdata->host_list);
-
-  xbt_dict_free(&task->simdata->affinity_mask_db);
-
   /* free main structures */
-  xbt_free(task->simdata);
+  delete task->simdata;
   xbt_free(task);
 
   return MSG_OK;
@@ -263,7 +222,7 @@ msg_error_t MSG_task_destroy(msg_task_t task)
  */
 msg_error_t MSG_task_cancel(msg_task_t task)
 {
-  xbt_assert((task != NULL), "Cannot cancel a NULL task");
+  xbt_assert((task != nullptr), "Cannot cancel a nullptr task");
 
   if (task->simdata->compute) {
     simcall_execution_cancel(task->simdata->compute);
@@ -271,9 +230,7 @@ msg_error_t MSG_task_cancel(msg_task_t task)
   else if (task->simdata->comm) {
     simdata_task_t simdata = task->simdata;
     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;
 }
@@ -286,7 +243,7 @@ msg_error_t MSG_task_cancel(msg_task_t task)
  */
 double MSG_task_get_flops_amount(msg_task_t task) {
   if (task->simdata->compute) {
-    return simcall_execution_get_remains(task->simdata->compute);
+    return task->simdata->compute->remains();
   } else {
     return task->simdata->flops_amount;
   }
@@ -321,9 +278,8 @@ void MSG_task_set_bytes_amount(msg_task_t task, double data_size)
  */
 double MSG_task_get_remaining_communication(msg_task_t task)
 {
-  xbt_assert((task != NULL) && (task->simdata != NULL), "Invalid parameter");
   XBT_DEBUG("calling simcall_communication_get_remains(%p)", task->simdata->comm);
-  return simcall_comm_get_remains(task->simdata->comm);
+  return task->simdata->comm->remains();
 }
 
 /** \ingroup m_task_management
@@ -331,7 +287,7 @@ double MSG_task_get_remaining_communication(msg_task_t task)
  */
 double MSG_task_get_bytes_amount(msg_task_t task)
 {
-  xbt_assert((task != NULL) && (task->simdata != NULL), "Invalid parameter");
+  xbt_assert((task != nullptr) && (task->simdata != nullptr), "Invalid parameter");
   return task->simdata->bytes_amount;
 }
 
@@ -341,11 +297,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 != NULL) && (task->simdata != NULL), "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
@@ -356,91 +310,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 != NULL)
-        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, NULL);
-
-  /* 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;
-  }
-
-  {
-    smx_synchro_t compute = task->simdata->compute;
-    msg_host_t host_now = compute->execution.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);
-  }
-}