Logo AND Algorithmique Numérique Distribuée

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