Logo AND Algorithmique Numérique Distribuée

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