1 /* Copyright (c) 2004-2019. The SimGrid Team. All rights reserved. */
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. */
6 #include "msg_private.hpp"
7 #include "src/simix/smx_private.hpp"
10 #include <simgrid/modelchecker.h>
11 #include <simgrid/s4u/Comm.hpp>
13 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(msg_task, msg, "Logging specific to MSG (task)");
15 void s_simdata_task_t::report_multiple_use() const
17 if (msg_global->debug_multiple_use){
18 XBT_ERROR("This task is already used in there:");
20 XBT_ERROR("<missing backtrace>");
21 XBT_ERROR("And you try to reuse it from here:");
22 xbt_backtrace_display_current();
24 xbt_die("This task is still being used somewhere else. You cannot send it now. Go fix your code!"
25 "(use --cfg=msg/debug-multiple-use:on to get the backtrace of the other process)");
29 /********************************* Task **************************************/
30 /** @brief Creates a new task
32 * A constructor for msg_task_t taking four arguments.
34 * @param name a name for the object. It is for user-level information and can be nullptr.
35 * @param flop_amount a value of the processing amount (in flop) needed to process this new task.
36 * If 0, then it cannot be executed with MSG_task_execute(). This value has to be >=0.
37 * @param message_size a value of the amount of data (in bytes) needed to transfer this new task. If 0, then it cannot
38 * be transfered with MSG_task_send() and MSG_task_recv(). This value has to be >=0.
39 * @param data a pointer to any data may want to attach to the new object. It is for user-level information and can
40 * be nullptr. It can be retrieved with the function @ref MSG_task_get_data.
41 * @return The new corresponding object.
43 msg_task_t MSG_task_create(const char *name, double flop_amount, double message_size, void *data)
45 static std::atomic_ullong counter{0};
47 msg_task_t task = new s_msg_task_t;
48 simdata_task_t simdata = new s_simdata_task_t();
49 task->simdata = simdata;
52 task->name = xbt_strdup(name);
56 simdata->bytes_amount = message_size;
57 simdata->flops_amount = flop_amount;
59 task->counter = counter++;
60 task->category = nullptr;
63 MC_ignore_heap(&(task->counter), sizeof(task->counter));
68 /** @brief Creates a new parallel task
70 * A constructor for #msg_task_t taking six arguments.
73 * See :cpp:func:`void simgrid::s4u::this_actor::parallel_execute(int, s4u::Host**, double*, double*)` for
74 * the exact semantic of the parameters.
77 * @param name a name for the object. It is for user-level information and can be nullptr.
78 * @param host_nb the number of hosts implied in the parallel task.
79 * @param host_list an array of @p host_nb msg_host_t.
80 * @param flops_amount an array of @p host_nb doubles.
81 * flops_amount[i] is the total number of operations that have to be performed on host_list[i].
82 * @param bytes_amount an array of @p host_nb* @p host_nb doubles.
83 * @param data a pointer to any data may want to attach to the new object.
84 * It is for user-level information and can be nullptr.
85 * It can be retrieved with the function @ref MSG_task_get_data().
87 msg_task_t MSG_parallel_task_create(const char *name, int host_nb, const msg_host_t * host_list,
88 double *flops_amount, double *bytes_amount, void *data)
90 // Task's flops amount is set to an arbitrary value > 0.0 to be able to distinguish, in
91 // MSG_task_get_remaining_work_ratio(), a finished task and a task that has not started yet.
92 msg_task_t task = MSG_task_create(name, 1.0, 0, data);
93 simdata_task_t simdata = task->simdata;
95 /* Simulator Data specific to parallel tasks */
96 simdata->host_nb = host_nb;
97 simdata->host_list = new sg_host_t[host_nb];
98 std::copy_n(host_list, host_nb, simdata->host_list);
99 if (flops_amount != nullptr) {
100 simdata->flops_parallel_amount = new double[host_nb];
101 std::copy_n(flops_amount, host_nb, simdata->flops_parallel_amount);
103 if (bytes_amount != nullptr) {
104 simdata->bytes_parallel_amount = new double[host_nb * host_nb];
105 std::copy_n(bytes_amount, host_nb * host_nb, simdata->bytes_parallel_amount);
111 /** @brief Return the user data of the given task */
112 void *MSG_task_get_data(msg_task_t task)
117 /** @brief Sets the user data of a given task */
118 void MSG_task_set_data(msg_task_t task, void *data)
123 /** @brief Sets a function to be called when a task has just been copied.
124 * @param callback a callback function
126 void MSG_task_set_copy_callback(void (*callback) (msg_task_t task, msg_process_t sender, msg_process_t receiver)) {
128 msg_global->task_copy_callback = callback;
131 SIMIX_comm_set_copy_data_callback(MSG_comm_copy_data_from_SIMIX);
133 SIMIX_comm_set_copy_data_callback(SIMIX_comm_copy_pointer_callback);
137 /** @brief Returns the sender of the given task */
138 msg_process_t MSG_task_get_sender(msg_task_t task)
140 return task->simdata->sender;
143 /** @brief Returns the source (the sender's host) of the given task */
144 msg_host_t MSG_task_get_source(msg_task_t task)
146 return task->simdata->sender->get_host();
149 /** @brief Returns the name of the given task. */
150 const char *MSG_task_get_name(msg_task_t task)
155 /** @brief Sets the name of the given task. */
156 void MSG_task_set_name(msg_task_t task, const char *name)
158 task->name = xbt_strdup(name);
161 /** @brief Destroys the given task.
163 * You should free user data, if any, @b before calling this destructor.
165 * Only the process that owns the task can destroy it.
166 * The owner changes after a successful send.
167 * If a task is successfully sent, the receiver becomes the owner and is supposed to destroy it. The sender should not
169 * If the task failed to be sent, the sender remains the owner of the task.
171 msg_error_t MSG_task_destroy(msg_task_t task)
173 if (task->simdata->is_used) {
174 /* the task is being sent or executed: cancel it first */
175 MSG_task_cancel(task);
178 xbt_free(task->category);
179 xbt_free(task->name);
181 /* free main structures */
182 delete task->simdata;
188 /** @brief Cancel the given task
190 * If it was currently executed or transfered, the working process is stopped.
192 msg_error_t MSG_task_cancel(msg_task_t task)
194 xbt_assert((task != nullptr), "Cannot cancel a nullptr task");
196 simdata_task_t simdata = task->simdata;
197 if (simdata->compute) {
198 simgrid::simix::simcall([simdata] { simdata->compute->cancel(); });
199 } else if (simdata->comm) {
200 simdata->comm->cancel();
202 simdata->set_not_used();
206 /** @brief Returns a value in ]0,1[ that represent the task remaining work
207 * to do: starts at 1 and goes to 0. Returns 0 if not started or finished.
209 * It works for either parallel or sequential tasks.
211 double MSG_task_get_remaining_work_ratio(msg_task_t task) {
213 xbt_assert((task != nullptr), "Cannot get information from a nullptr task");
214 if (task->simdata->compute) {
216 return task->simdata->compute->get_remaining_ratio();
218 // Task not started (flops_amount is > 0.0) or finished (flops_amount is set to 0.0)
219 return task->simdata->flops_amount > 0.0 ? 1.0 : 0.0;
223 /** @brief Returns the amount of flops that remain to be computed
225 * The returned value is initially the cost that you defined for the task, then it decreases until it reaches 0
227 * It works for sequential tasks, but the remaining amount of work is not a scalar value for parallel tasks.
228 * So you will get an exception if you call this function on parallel tasks. Just don't do it.
230 double MSG_task_get_flops_amount(msg_task_t task) {
231 if (task->simdata->compute != nullptr) {
232 return task->simdata->compute->get_remaining();
234 // Not started or already done.
235 // - Before starting, flops_amount is initially the task cost
236 // - After execution, flops_amount is set to 0 (until someone uses MSG_task_set_flops_amount, if any)
237 return task->simdata->flops_amount;
241 /** @brief set the computation amount needed to process the given task.
243 * @warning If the computation is ongoing (already started and not finished),
244 * it is not modified by this call. Moreover, after its completion, the ongoing execution with set the flops_amount to
245 * zero, overriding any value set during the execution.
247 void MSG_task_set_flops_amount(msg_task_t task, double flops_amount)
249 task->simdata->flops_amount = flops_amount;
252 /** @brief set the amount data attached with the given task.
254 * @warning If the transfer is ongoing (already started and not finished), it is not modified by this call.
256 void MSG_task_set_bytes_amount(msg_task_t task, double data_size)
258 task->simdata->bytes_amount = data_size;
261 /** @brief Returns the total amount received by the given task
263 * If the communication does not exist it will return 0.
264 * So, if the communication has FINISHED or FAILED it returns zero.
266 double MSG_task_get_remaining_communication(msg_task_t task)
268 XBT_DEBUG("calling simcall_communication_get_remains(%p)", task->simdata->comm.get());
269 return task->simdata->comm->get_remaining();
272 /** @brief Returns the size of the data attached to the given task. */
273 double MSG_task_get_bytes_amount(msg_task_t task)
275 xbt_assert((task != nullptr) && (task->simdata != nullptr), "Invalid parameter");
276 return task->simdata->bytes_amount;
279 /** @brief Changes the priority of a computation task.
281 * This priority doesn't affect the transfer rate. A priority of 2
282 * will make a task receive two times more cpu power than regular tasks.
284 void MSG_task_set_priority(msg_task_t task, double priority)
286 task->simdata->priority = 1 / priority;
287 xbt_assert(std::isfinite(task->simdata->priority), "priority is not finite!");
288 if (task->simdata->compute)
289 simgrid::simix::simcall([task] { task->simdata->compute->set_priority(task->simdata->priority); });
292 /** @brief Changes the maximum CPU utilization of a computation task (in flops/s).
294 * For VMs, there is a pitfall. Please see MSG_vm_set_bound().
296 void MSG_task_set_bound(msg_task_t task, double bound)
298 if (bound < 1e-12) /* close enough to 0 without any floating precision surprise */
299 XBT_INFO("bound == 0 means no capping (i.e., unlimited).");
301 task->simdata->bound = bound;
302 if (task->simdata->compute)
303 simgrid::simix::simcall([task, bound] { task->simdata->compute->set_bound(bound); });