src/msg/msg_task.cpp

   1 /* Copyright (c) 2004-2019. 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 task
  28  *
  29  * A constructor for msg_task_t taking four arguments.
  30  *
  31  * @param name a name for the object. It is for user-level information and can be nullptr.
  32  * @param flop_amount a value of the processing amount (in flop) needed to process this new task.
  33  * If 0, then it cannot be executed with MSG_task_execute(). This value has to be >=0.
  34  * @param message_size a value of the amount of data (in bytes) needed to transfer this new task. If 0, then it cannot
  35  * be transfered with MSG_task_send() and MSG_task_recv(). This value has to be >=0.
  36  * @param data a pointer to any data may want to attach to the new object.  It is for user-level information and can
  37  * be nullptr. It can be retrieved with the function @ref MSG_task_get_data.
  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 parallel task
  60  *
  61  * A constructor for #msg_task_t taking six arguments.
  62  *
  63  * \rst
  64  * See :cpp:func:`void simgrid::s4u::this_actor::parallel_execute(int, s4u::Host**, double*, double*)` for
  65  * the exact semantic of the parameters.
  66  * \endrst
  67  *
  68  * @param name a name for the object. It is for user-level information and can be nullptr.
  69  * @param host_nb the number of hosts implied in the parallel task.
  70  * @param host_list an array of @p host_nb msg_host_t.
  71  * @param flops_amount an array of @p host_nb doubles.
  72  *        flops_amount[i] is the total number of operations that have to be performed on host_list[i].
  73  * @param bytes_amount an array of @p host_nb* @p host_nb doubles.
  74  * @param data a pointer to any data may want to attach to the new object.
  75  *             It is for user-level information and can be nullptr.
  76  *             It can be retrieved with the function @ref MSG_task_get_data().
  77  */
  78 msg_task_t MSG_parallel_task_create(const char *name, int host_nb, const msg_host_t * host_list,
  79                                     double *flops_amount, double *bytes_amount, void *data)
  80 {
  81   // Task's flops amount is set to an arbitrary value > 0.0 to be able to distinguish, in
  82   // MSG_task_get_remaining_work_ratio(), a finished task and a task that has not started yet.
  83   msg_task_t task        = MSG_task_create(name, 1.0, 0, data);
  84   simdata_task_t simdata = task->simdata;
  85
  86   /* Simulator Data specific to parallel tasks */
  87   simdata->host_nb = host_nb;
  88   simdata->host_list             = new sg_host_t[host_nb];
  89   std::copy_n(host_list, host_nb, simdata->host_list);
  90   if (flops_amount != nullptr) {
  91     simdata->flops_parallel_amount = new double[host_nb];
  92     std::copy_n(flops_amount, host_nb, simdata->flops_parallel_amount);
  93   }
  94   if (bytes_amount != nullptr) {
  95     simdata->bytes_parallel_amount = new double[host_nb * host_nb];
  96     std::copy_n(bytes_amount, host_nb * host_nb, simdata->bytes_parallel_amount);
  97   }
  98
  99   return task;
 100 }
 101
 102 /** @brief Return the user data of the given task */
 103 void *MSG_task_get_data(msg_task_t task)
 104 {
 105   return (task->data);
 106 }
 107
 108 /** @brief Sets the user data of a given task */
 109 void MSG_task_set_data(msg_task_t task, void *data)
 110 {
 111   task->data = data;
 112 }
 113
 114 /** @brief Sets a function to be called when a task has just been copied.
 115  * @param callback a callback function
 116  */
 117 void MSG_task_set_copy_callback(void (*callback) (msg_task_t task, msg_process_t sender, msg_process_t receiver)) {
 118
 119   msg_global->task_copy_callback = callback;
 120
 121   if (callback) {
 122     SIMIX_comm_set_copy_data_callback(MSG_comm_copy_data_from_SIMIX);
 123   } else {
 124     SIMIX_comm_set_copy_data_callback(SIMIX_comm_copy_pointer_callback);
 125   }
 126 }
 127
 128 /** @brief Returns the sender of the given task */
 129 msg_process_t MSG_task_get_sender(msg_task_t task)
 130 {
 131   return task->simdata->sender;
 132 }
 133
 134 /** @brief Returns the source (the sender's host) of the given task */
 135 msg_host_t MSG_task_get_source(msg_task_t task)
 136 {
 137   return task->simdata->source;
 138 }
 139
 140 /** @brief Returns the name of the given task. */
 141 const char *MSG_task_get_name(msg_task_t task)
 142 {
 143   return task->name;
 144 }
 145
 146 /** @brief Sets the name of the given task. */
 147 void MSG_task_set_name(msg_task_t task, const char *name)
 148 {
 149   task->name = xbt_strdup(name);
 150 }
 151
 152 /** @brief Destroys the given task.
 153  *
 154  * You should free user data, if any, @b before calling this destructor.
 155  *
 156  * Only the process that owns the task can destroy it.
 157  * The owner changes after a successful send.
 158  * If a task is successfully sent, the receiver becomes the owner and is supposed to destroy it. The sender should not
 159  * use it anymore.
 160  * If the task failed to be sent, the sender remains the owner of the task.
 161  */
 162 msg_error_t MSG_task_destroy(msg_task_t task)
 163 {
 164   if (task->simdata->isused) {
 165     /* the task is being sent or executed: cancel it first */
 166     MSG_task_cancel(task);
 167   }
 168   TRACE_msg_task_destroy(task);
 169
 170   xbt_free(task->name);
 171
 172   /* free main structures */
 173   delete task->simdata;
 174   delete task;
 175
 176   return MSG_OK;
 177 }
 178
 179 /** @brief Cancel the given task
 180  *
 181  * If it was currently executed or transfered, the working process is stopped.
 182  */
 183 msg_error_t MSG_task_cancel(msg_task_t task)
 184 {
 185   xbt_assert((task != nullptr), "Cannot cancel a nullptr task");
 186
 187   simdata_task_t simdata = task->simdata;
 188   if (simdata->compute) {
 189     simcall_execution_cancel(simdata->compute);
 190   } else if (simdata->comm) {
 191     simcall_comm_cancel(simdata->comm);
 192   }
 193   simdata->setNotUsed();
 194   return MSG_OK;
 195 }
 196
 197 /** @brief Returns a value in ]0,1[ that represent the task remaining work
 198  *    to do: starts at 1 and goes to 0. Returns 0 if not started or finished.
 199  *
 200  * It works for either parallel or sequential tasks.
 201  */
 202 double MSG_task_get_remaining_work_ratio(msg_task_t task) {
 203
 204   xbt_assert((task != nullptr), "Cannot get information from a nullptr task");
 205   if (task->simdata->compute) {
 206     // Task in progress
 207     return task->simdata->compute->get_remaining_ratio();
 208   } else {
 209     // Task not started (flops_amount is > 0.0) or finished (flops_amount is set to 0.0)
 210     return task->simdata->flops_amount > 0.0 ? 1.0 : 0.0;
 211   }
 212 }
 213
 214 /** @brief Returns the amount of flops that remain to be computed
 215  *
 216  * The returned value is initially the cost that you defined for the task, then it decreases until it reaches 0
 217  *
 218  * It works for sequential tasks, but the remaining amount of work is not a scalar value for parallel tasks.
 219  * So you will get an exception if you call this function on parallel tasks. Just don't do it.
 220  */
 221 double MSG_task_get_flops_amount(msg_task_t task) {
 222   if (task->simdata->compute != nullptr) {
 223     return task->simdata->compute->get_remaining();
 224   } else {
 225     // Not started or already done.
 226     // - Before starting, flops_amount is initially the task cost
 227     // - After execution, flops_amount is set to 0 (until someone uses MSG_task_set_flops_amount, if any)
 228     return task->simdata->flops_amount;
 229   }
 230 }
 231
 232 /** @brief set the computation amount needed to process the given task.
 233  *
 234  * @warning If the computation is ongoing (already started and not finished),
 235  * it is not modified by this call. Moreover, after its completion, the ongoing execution with set the flops_amount to
 236  * zero, overriding any value set during the execution.
 237  */
 238 void MSG_task_set_flops_amount(msg_task_t task, double flops_amount)
 239 {
 240   task->simdata->flops_amount = flops_amount;
 241 }
 242
 243 /** @brief set the amount data attached with the given task.
 244  *
 245  * @warning If the transfer is ongoing (already started and not finished), it is not modified by this call.
 246  */
 247 void MSG_task_set_bytes_amount(msg_task_t task, double data_size)
 248 {
 249   task->simdata->bytes_amount = data_size;
 250 }
 251
 252 /** @brief Returns the total amount received by the given task
 253  *
 254  *  If the communication does not exist it will return 0.
 255  *  So, if the communication has FINISHED or FAILED it returns zero.
 256  */
 257 double MSG_task_get_remaining_communication(msg_task_t task)
 258 {
 259   XBT_DEBUG("calling simcall_communication_get_remains(%p)", task->simdata->comm.get());
 260   return task->simdata->comm->remains();
 261 }
 262
 263 /** @brief Returns the size of the data attached to the given task. */
 264 double MSG_task_get_bytes_amount(msg_task_t task)
 265 {
 266   xbt_assert((task != nullptr) && (task->simdata != nullptr), "Invalid parameter");
 267   return task->simdata->bytes_amount;
 268 }
 269
 270 /** @brief Changes the priority of a computation task.
 271  *
 272  * This priority doesn't affect the transfer rate. A priority of 2
 273  * will make a task receive two times more cpu power than regular tasks.
 274  */
 275 void MSG_task_set_priority(msg_task_t task, double priority)
 276 {
 277   task->simdata->priority = 1 / priority;
 278   if (task->simdata->compute)
 279     simcall_execution_set_priority(task->simdata->compute, task->simdata->priority);
 280 }
 281
 282 /** @brief Changes the maximum CPU utilization of a computation task (in flops/s).
 283  *
 284  * For VMs, there is a pitfall. Please see MSG_vm_set_bound().
 285  */
 286 void MSG_task_set_bound(msg_task_t task, double bound)
 287 {
 288   if (bound < 1e-12) /* close enough to 0 without any floating precision surprise */
 289     XBT_INFO("bound == 0 means no capping (i.e., unlimited).");
 290
 291   task->simdata->bound = bound;
 292   if (task->simdata->compute)
 293     simcall_execution_set_bound(task->simdata->compute, task->simdata->bound);
 294 }