src/msg/msg_task.cpp

   1 /* Copyright (c) 2004-2018. The SimGrid Team. All rights reserved.          */
   2
   3 /* This program is free software; you can redistribute it and/or modify it
   4  * under the terms of the license (GNU LGPL) which comes with this package. */
   5
   6 #include "msg_private.hpp"
   7 #include "src/simix/smx_private.hpp"
   8 #include <algorithm>
   9
  10 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(msg_task, msg, "Logging specific to MSG (task)");
  11
  12 void s_simdata_task_t::reportMultipleUse() const
  13 {
  14   if (msg_global->debug_multiple_use){
  15     XBT_ERROR("This task is already used in there:");
  16     // TODO, backtrace
  17     XBT_ERROR("<missing backtrace>");
  18     XBT_ERROR("And you try to reuse it from here:");
  19     xbt_backtrace_display_current();
  20   } else {
  21     xbt_die("This task is still being used somewhere else. You cannot send it now. Go fix your code!"
  22              "(use --cfg=msg/debug-multiple-use:on to get the backtrace of the other process)");
  23   }
  24 }
  25
  26 /********************************* Task **************************************/
  27 /** @brief Creates a new #msg_task_t.
  28  *
  29  * A constructor for #msg_task_t taking four arguments and returning the corresponding object.
  30  * @param name a name for the object. It is for user-level information and can be nullptr.
  31  * @param flop_amount a value of the processing amount (in flop) needed to process this new task.
  32  * If 0, then it cannot be executed with MSG_task_execute(). This value has to be >=0.
  33  * @param message_size a value of the amount of data (in bytes) needed to transfer this new task. If 0, then it cannot
  34  * be transfered with MSG_task_send() and MSG_task_recv(). This value has to be >=0.
  35  * @param data a pointer to any data may want to attach to the new object.  It is for user-level information and can
  36  * be nullptr. It can be retrieved with the function @ref MSG_task_get_data.
  37  * @see msg_task_t
  38  * @return The new corresponding object.
  39  */
  40 msg_task_t MSG_task_create(const char *name, double flop_amount, double message_size, void *data)
  41 {
  42   msg_task_t task        = new s_msg_task_t;
  43   simdata_task_t simdata = new s_simdata_task_t();
  44   task->simdata = simdata;
  45
  46   /* Task structure */
  47   task->name = xbt_strdup(name);
  48   task->data = data;
  49
  50   /* Simulator Data */
  51   simdata->bytes_amount = message_size;
  52   simdata->flops_amount = flop_amount;
  53
  54   TRACE_msg_task_create(task);
  55
  56   return task;
  57 }
  58
  59 /** @brief Creates a new #msg_task_t (a parallel one....).
  60  *
  61  * A constructor for #msg_task_t taking six arguments and returning the corresponding object.
  62  * @param name a name for the object. It is for user-level information and can be nullptr.
  63  * @param host_nb the number of hosts implied in the parallel task.
  64  * @param host_list an array of @p host_nb msg_host_t.
  65  * @param flops_amount an array of @p host_nb doubles.
  66  *        flops_amount[i] is the total number of operations that have to be performed on host_list[i].
  67  * @param bytes_amount an array of @p host_nb* @p host_nb doubles.
  68  * @param data a pointer to any data may want to attach to the new object.
  69  *             It is for user-level information and can be nullptr.
  70  *             It can be retrieved with the function @ref MSG_task_get_data.
  71  * @see msg_task_t
  72  * @return The new corresponding object.
  73  */
  74 msg_task_t MSG_parallel_task_create(const char *name, int host_nb, const msg_host_t * host_list,
  75                                     double *flops_amount, double *bytes_amount, void *data)
  76 {
  77   // Task's flops amount is set to an arbitrary value > 0.0 to be able to distinguish, in
  78   // MSG_task_get_remaining_work_ratio(), a finished task and a task that has not started yet.
  79   msg_task_t task        = MSG_task_create(name, 1.0, 0, data);
  80   simdata_task_t simdata = task->simdata;
  81
  82   /* Simulator Data specific to parallel tasks */
  83   simdata->host_nb = host_nb;
  84   simdata->host_list             = new sg_host_t[host_nb];
  85   std::copy_n(host_list, host_nb, simdata->host_list);
  86   if (flops_amount != nullptr) {
  87     simdata->flops_parallel_amount = new double[host_nb];
  88     std::copy_n(flops_amount, host_nb, simdata->flops_parallel_amount);
  89   }
  90   if (bytes_amount != nullptr) {
  91     simdata->bytes_parallel_amount = new double[host_nb * host_nb];
  92     std::copy_n(bytes_amount, host_nb * host_nb, simdata->bytes_parallel_amount);
  93   }
  94
  95   return task;
  96 }
  97
  98 /** @brief Return the user data of a #msg_task_t.
  99  *
 100  * This function checks whether @a task is a valid pointer and return the user data associated to @a task if possible.
 101  */
 102 void *MSG_task_get_data(msg_task_t task)
 103 {
 104   return (task->data);
 105 }
 106
 107 /** @ingroup m_task_management
 108  * @brief Sets the user data of a #msg_task_t.
 109  *
 110  * This function allows to associate a new pointer to the user data associated of @a task.
 111  */
 112 void MSG_task_set_data(msg_task_t task, void *data)
 113 {
 114   task->data = data;
 115 }
 116
 117 /** @brief Sets a function to be called when a task has just been copied.
 118  * @param callback a callback function
 119  */
 120 void MSG_task_set_copy_callback(void (*callback) (msg_task_t task, msg_process_t sender, msg_process_t receiver)) {
 121
 122   msg_global->task_copy_callback = callback;
 123
 124   if (callback) {
 125     SIMIX_comm_set_copy_data_callback(MSG_comm_copy_data_from_SIMIX);
 126   } else {
 127     SIMIX_comm_set_copy_data_callback(SIMIX_comm_copy_pointer_callback);
 128   }
 129 }
 130
 131 /** @brief Return the sender of a #msg_task_t.
 132  *
 133  * This functions returns the #msg_process_t which sent this task
 134  */
 135 msg_process_t MSG_task_get_sender(msg_task_t task)
 136 {
 137   return task->simdata->sender;
 138 }
 139
 140 /** @brief Return the source of a #msg_task_t.
 141  *
 142  * This functions returns the #msg_host_t from which this task was sent
 143  */
 144 msg_host_t MSG_task_get_source(msg_task_t task)
 145 {
 146   return task->simdata->source;
 147 }
 148
 149 /** @brief Return the name of a #msg_task_t.
 150  *
 151  * This functions returns the name of a #msg_task_t as specified on creation
 152  */
 153 const char *MSG_task_get_name(msg_task_t task)
 154 {
 155   return task->name;
 156 }
 157
 158 /** @brief Sets the name of a #msg_task_t.
 159  *
 160  * This functions allows to associate a name to a task
 161  */
 162 void MSG_task_set_name(msg_task_t task, const char *name)
 163 {
 164   task->name = xbt_strdup(name);
 165 }
 166
 167 /** @brief Destroy a #msg_task_t.
 168  *
 169  * Destructor for #msg_task_t. Note that you should free user data, if any, @b before calling this function.
 170  *
 171  * Only the process that owns the task can destroy it.
 172  * The owner changes after a successful send.
 173  * If a task is successfully sent, the receiver becomes the owner and is supposed to destroy it. The sender should not
 174  * use it anymore.
 175  * If the task failed to be sent, the sender remains the owner of the task.
 176  */
 177 msg_error_t MSG_task_destroy(msg_task_t task)
 178 {
 179   if (task->simdata->isused) {
 180     /* the task is being sent or executed: cancel it first */
 181     MSG_task_cancel(task);
 182   }
 183   TRACE_msg_task_destroy(task);
 184
 185   xbt_free(task->name);
 186
 187   /* free main structures */
 188   delete task->simdata;
 189   delete task;
 190
 191   return MSG_OK;
 192 }
 193
 194 /** @brief Cancel a #msg_task_t.
 195  * @param task the task to cancel. If it was executed or transfered, it stops the process that were working on it.
 196  */
 197 msg_error_t MSG_task_cancel(msg_task_t task)
 198 {
 199   xbt_assert((task != nullptr), "Cannot cancel a nullptr task");
 200
 201   simdata_task_t simdata = task->simdata;
 202   if (simdata->compute) {
 203     simcall_execution_cancel(simdata->compute);
 204   } else if (simdata->comm) {
 205     simcall_comm_cancel(simdata->comm);
 206   }
 207   simdata->setNotUsed();
 208   return MSG_OK;
 209 }
 210
 211 /** @brief Returns a value in ]0,1[ that represent the task remaining work
 212  *    to do: starts at 1 and goes to 0. Returns 0 if not started or finished.
 213  *
 214  * It works for either parallel or sequential tasks.
 215  */
 216 double MSG_task_get_remaining_work_ratio(msg_task_t task) {
 217
 218   xbt_assert((task != nullptr), "Cannot get information from a nullptr task");
 219   if (task->simdata->compute) {
 220     // Task in progress
 221     return task->simdata->compute->get_remaining_ratio();
 222   } else {
 223     // Task not started (flops_amount is > 0.0) or finished (flops_amount is set to 0.0)
 224     return task->simdata->flops_amount > 0.0 ? 1.0 : 0.0;
 225   }
 226 }
 227
 228 /** @brief Returns the amount of flops that remain to be computed
 229  *
 230  * The returned value is initially the cost that you defined for the task, then it decreases until it reaches 0
 231  *
 232  * It works for sequential tasks, but the remaining amount of work is not a scalar value for parallel tasks.
 233  * So you will get an exception if you call this function on parallel tasks. Just don't do it.
 234  */
 235 double MSG_task_get_flops_amount(msg_task_t task) {
 236   if (task->simdata->compute != nullptr) {
 237     return task->simdata->compute->get_remaining();
 238   } else {
 239     // Not started or already done.
 240     // - Before starting, flops_amount is initially the task cost
 241     // - After execution, flops_amount is set to 0 (until someone uses MSG_task_set_flops_amount, if any)
 242     return task->simdata->flops_amount;
 243   }
 244 }
 245
 246 /** @brief set the computation amount needed to process a task #msg_task_t.
 247  *
 248  * @warning If the computation is ongoing (already started and not finished),
 249  * it is not modified by this call. Moreover, after its completion, the ongoing execution with set the flops_amount to
 250  * zero, overriding any value set during the execution.
 251  */
 252 void MSG_task_set_flops_amount(msg_task_t task, double flops_amount)
 253 {
 254   task->simdata->flops_amount = flops_amount;
 255 }
 256
 257 /** @brief set the amount data attached with a task #msg_task_t.
 258  *
 259  * @warning If the transfer is ongoing (already started and not finished), it is not modified by this call.
 260  */
 261 void MSG_task_set_bytes_amount(msg_task_t task, double data_size)
 262 {
 263   task->simdata->bytes_amount = data_size;
 264 }
 265
 266 /** @brief Returns the total amount received by a task #msg_task_t.
 267  *        If the communication does not exist it will return 0.
 268  *        So, if the communication has FINISHED or FAILED it returns zero.
 269  */
 270 double MSG_task_get_remaining_communication(msg_task_t task)
 271 {
 272   XBT_DEBUG("calling simcall_communication_get_remains(%p)", task->simdata->comm.get());
 273   return task->simdata->comm->remains();
 274 }
 275
 276 /** @brief Returns the size of the data attached to a task #msg_task_t.
 277  */
 278 double MSG_task_get_bytes_amount(msg_task_t task)
 279 {
 280   xbt_assert((task != nullptr) && (task->simdata != nullptr), "Invalid parameter");
 281   return task->simdata->bytes_amount;
 282 }
 283
 284 /** @brief Changes the priority of a computation task. This priority doesn't affect the transfer rate. A priority of 2
 285  *        will make a task receive two times more cpu power than the other ones.
 286  */
 287 void MSG_task_set_priority(msg_task_t task, double priority)
 288 {
 289   task->simdata->priority = 1 / priority;
 290   if (task->simdata->compute)
 291     simcall_execution_set_priority(task->simdata->compute, task->simdata->priority);
 292 }
 293
 294 /** @brief Changes the maximum CPU utilization of a computation task.
 295  *        Unit is flops/s.
 296  *
 297  * For VMs, there is a pitfall. Please see MSG_vm_set_bound().
 298  */
 299 void MSG_task_set_bound(msg_task_t task, double bound)
 300 {
 301   if (bound < 1e-12) /* close enough to 0 without any floating precision surprise */
 302     XBT_INFO("bound == 0 means no capping (i.e., unlimited).");
 303
 304   task->simdata->bound = bound;
 305   if (task->simdata->compute)
 306     simcall_execution_set_bound(task->simdata->compute, task->simdata->bound);
 307 }