1 /* Copyright (c) 2004-2014. The SimGrid Team.
2 * All rights reserved. */
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. */
7 #include "msg_private.h"
8 #include "simix/smx_private.h"
9 #include "xbt/sysdep.h"
12 /** @addtogroup m_task_management
15 * Since most scheduling algorithms rely on a concept of task
16 * that can be either <em>computed</em> locally or
17 * <em>transferred</em> on another processor, it seems to be the
18 * right level of abstraction for our purposes. A <em>task</em>
19 * may then be defined by a <em>computing amount</em>, a
20 * <em>message size</em> and some <em>private data</em>.
23 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(msg_task, msg,
24 "Logging specific to MSG (task)");
26 /********************************* Task **************************************/
27 /** \ingroup m_task_management
28 * \brief Creates a new #msg_task_t.
30 * A constructor for #msg_task_t taking four arguments and returning the
32 * \param name a name for the object. It is for user-level information
34 * \param flop_amount a value of the processing amount (in flop)
35 needed to process this new task. If 0, then it cannot be executed with
36 MSG_task_execute(). This value has to be >=0.
37 * \param message_size a value of the amount of data (in bytes) needed to
38 transfer this new task. If 0, then it cannot be transfered with
39 MSG_task_send() and MSG_task_recv(). This value has to be >=0.
40 * \param data a pointer to any data may want to attach to the new
41 object. It is for user-level information and can be NULL. It can
42 be retrieved with the function \ref MSG_task_get_data.
44 * \return The new corresponding object.
46 msg_task_t MSG_task_create(const char *name, double flop_amount,
47 double message_size, void *data)
49 msg_task_t task = xbt_new(s_msg_task_t, 1);
50 simdata_task_t simdata = xbt_new(s_simdata_task_t, 1);
51 task->simdata = simdata;
54 task->name = xbt_strdup(name);
58 simdata->compute = NULL;
60 simdata->bytes_amount = message_size;
61 simdata->flops_amount = flop_amount;
62 simdata->sender = NULL;
63 simdata->receiver = NULL;
64 simdata->source = NULL;
65 simdata->priority = 1.0;
67 simdata->affinity_mask_db = xbt_dict_new_homogeneous(NULL);
72 simdata->host_list = NULL;
73 simdata->flops_parallel_amount = NULL;
74 simdata->bytes_parallel_amount = NULL;
75 TRACE_msg_task_create(task);
80 /** \ingroup m_task_management
81 * \brief Creates a new #msg_task_t (a parallel one....).
83 * A constructor for #msg_task_t taking six arguments and returning the
85 * \param name a name for the object. It is for user-level information
87 * \param host_nb the number of hosts implied in the parallel task.
88 * \param host_list an array of \p host_nb msg_host_t.
89 * \param flops_amount an array of \p host_nb doubles.
90 * flops_amount[i] is the total number of operations that have to be performed on host_list[i].
91 * \param bytes_amount an array of \p host_nb* \p host_nb doubles.
92 * \param data a pointer to any data may want to attach to the new object.
93 * It is for user-level information and can be NULL.
94 * It can be retrieved with the function \ref MSG_task_get_data.
96 * \return The new corresponding object.
99 MSG_parallel_task_create(const char *name, int host_nb,
100 const msg_host_t * host_list,
101 double *flops_amount,
102 double *bytes_amount, void *data)
104 msg_task_t task = MSG_task_create(name, 0, 0, data);
105 simdata_task_t simdata = task->simdata;
108 /* Simulator Data specific to parallel tasks */
109 simdata->host_nb = host_nb;
110 simdata->host_list = xbt_new0(smx_host_t, host_nb);
111 simdata->flops_parallel_amount = flops_amount;
112 simdata->bytes_parallel_amount = bytes_amount;
114 for (i = 0; i < host_nb; i++)
115 simdata->host_list[i] = host_list[i];
120 /*************** Begin GPU ***************/
121 /** \ingroup m_task_management
122 * \brief Creates a new #msg_gpu_task_t.
124 * A constructor for #msg_gpu_task_t taking four arguments and returning
125 a pointer to the new created GPU task.
127 * \param name a name for the object. It is for user-level information
130 * \param flops_amount a value of the processing amount (in flop)
131 needed to process this new task. If 0, then it cannot be executed with
132 MSG_gpu_task_execute(). This value has to be >=0.
134 * \param dispatch_latency time in seconds to load this task on the GPU
136 * \param collect_latency time in seconds to transfer result from the GPU
137 back to the CPU (host) when done
139 * \see msg_gpu_task_t
140 * \return The new corresponding object.
142 msg_gpu_task_t MSG_gpu_task_create(const char *name, double flops_amount,
143 double dispatch_latency, double collect_latency)
145 msg_gpu_task_t task = xbt_new(s_msg_gpu_task_t, 1);
146 simdata_gpu_task_t simdata = xbt_new(s_simdata_gpu_task_t, 1);
147 task->simdata = simdata;
149 task->name = xbt_strdup(name);
152 simdata->flops_amount = flops_amount;
153 simdata->dispatch_latency = dispatch_latency;
154 simdata->collect_latency = collect_latency;
156 /* TRACE_msg_gpu_task_create(task); FIXME*/
160 /*************** End GPU ***************/
162 /** \ingroup m_task_management
163 * \brief Return the user data of a #msg_task_t.
165 * This function checks whether \a task is a valid pointer or not and return
166 the user data associated to \a task if it is possible.
168 void *MSG_task_get_data(msg_task_t task)
170 xbt_assert((task != NULL), "Invalid parameter");
175 /** \ingroup m_task_management
176 * \brief Sets the user data of a #msg_task_t.
178 * This function allows to associate a new pointer to
179 the user data associated of \a task.
181 void MSG_task_set_data(msg_task_t task, void *data)
183 xbt_assert((task != NULL), "Invalid parameter");
188 /** \ingroup m_task_management
189 * \brief Sets a function to be called when a task has just been copied.
190 * \param callback a callback function
192 void MSG_task_set_copy_callback(void (*callback)
193 (msg_task_t task, msg_process_t sender, msg_process_t receiver)) {
195 msg_global->task_copy_callback = callback;
198 SIMIX_comm_set_copy_data_callback(MSG_comm_copy_data_from_SIMIX);
201 SIMIX_comm_set_copy_data_callback(SIMIX_comm_copy_pointer_callback);
205 /** \ingroup m_task_management
206 * \brief Return the sender of a #msg_task_t.
208 * This functions returns the #msg_process_t which sent this task
210 msg_process_t MSG_task_get_sender(msg_task_t task)
212 xbt_assert(task, "Invalid parameters");
213 return ((simdata_task_t) task->simdata)->sender;
216 /** \ingroup m_task_management
217 * \brief Return the source of a #msg_task_t.
219 * This functions returns the #msg_host_t from which this task was sent
221 msg_host_t MSG_task_get_source(msg_task_t task)
223 xbt_assert(task, "Invalid parameters");
224 return ((simdata_task_t) task->simdata)->source;
227 /** \ingroup m_task_management
228 * \brief Return the name of a #msg_task_t.
230 * This functions returns the name of a #msg_task_t as specified on creation
232 const char *MSG_task_get_name(msg_task_t task)
234 xbt_assert(task, "Invalid parameters");
238 /** \ingroup m_task_management
239 * \brief Sets the name of a #msg_task_t.
241 * This functions allows to associate a name to a task
243 void MSG_task_set_name(msg_task_t task, const char *name)
245 xbt_assert(task, "Invalid parameters");
246 task->name = xbt_strdup(name);
249 /** \ingroup m_task_management
250 * \brief Destroy a #msg_task_t.
252 * Destructor for #msg_task_t. Note that you should free user data, if any, \b
253 * before calling this function.
255 * Only the process that owns the task can destroy it.
256 * The owner changes after a successful send.
257 * If a task is successfully sent, the receiver becomes the owner and is
258 * supposed to destroy it. The sender should not use it anymore.
259 * If the task failed to be sent, the sender remains the owner of the task.
261 msg_error_t MSG_task_destroy(msg_task_t task)
263 smx_synchro_t action = NULL;
264 xbt_assert((task != NULL), "Invalid parameter");
266 if (task->simdata->isused) {
267 /* the task is being sent or executed: cancel it first */
268 MSG_task_cancel(task);
270 TRACE_msg_task_destroy(task);
272 xbt_free(task->name);
274 action = task->simdata->compute;
276 simcall_host_execution_destroy(action);
278 /* parallel tasks only */
279 xbt_free(task->simdata->host_list);
281 xbt_dict_free(&task->simdata->affinity_mask_db);
283 /* free main structures */
284 xbt_free(task->simdata);
291 /** \ingroup m_task_usage
292 * \brief Cancel a #msg_task_t.
293 * \param task the task to cancel. If it was executed or transfered, it
294 stops the process that were working on it.
296 msg_error_t MSG_task_cancel(msg_task_t task)
298 xbt_assert((task != NULL), "Cannot cancel a NULL task");
300 if (task->simdata->compute) {
301 simcall_host_execution_cancel(task->simdata->compute);
303 else if (task->simdata->comm) {
304 simdata_task_t simdata = task->simdata;
305 simcall_comm_cancel(simdata->comm);
306 if (msg_global->debug_multiple_use && simdata->isused!=0)
307 xbt_ex_free(*(xbt_ex_t*)simdata->isused);
313 /** \ingroup m_task_management
314 * \brief Returns the computation amount needed to process a task #msg_task_t.
316 * Once a task has been processed, this amount is set to 0. If you want, you
317 * can reset this value with #MSG_task_set_flops_amount before restarting the task.
319 double MSG_task_get_compute_duration(msg_task_t task)
321 xbt_assert((task != NULL)
322 && (task->simdata != NULL), "Invalid parameter");
324 return task->simdata->flops_amount;
328 /** \ingroup m_task_management
329 * \brief set the computation amount needed to process a task #msg_task_t.
331 * \warning If the computation is ongoing (already started and not finished),
332 * it is not modified by this call. Moreover, after its completion, the ongoing
333 * execution with set the flops_amount to zero, overriding any value set during
337 void MSG_task_set_flops_amount(msg_task_t task, double flops_amount)
339 task->simdata->flops_amount = flops_amount;
342 /** \ingroup m_task_management
343 * \brief set the amount data attached with a task #msg_task_t.
345 * \warning If the transfer is ongoing (already started and not finished),
346 * it is not modified by this call.
349 void MSG_task_set_bytes_amount(msg_task_t task, double data_size)
351 task->simdata->bytes_amount = data_size;
356 /** \ingroup m_task_management
357 * \brief Returns the remaining computation amount of a task #msg_task_t.
359 * If the task is ongoing, this call retrieves the remaining amount of work.
360 * If it is not ongoing, it returns the total amount of work that will be
361 * executed when the task starts.
363 double MSG_task_get_remaining_computation(msg_task_t task)
365 xbt_assert((task != NULL)
366 && (task->simdata != NULL), "Invalid parameter");
368 if (task->simdata->compute) {
369 return simcall_host_execution_get_remains(task->simdata->compute);
371 return task->simdata->flops_amount;
375 /** \ingroup m_task_management
376 * \brief Returns the total amount received by a task #msg_task_t.
377 * If the communication does not exist it will return 0.
378 * So, if the communication has FINISHED or FAILED it returns
381 double MSG_task_get_remaining_communication(msg_task_t task)
383 xbt_assert((task != NULL)
384 && (task->simdata != NULL), "Invalid parameter");
385 XBT_DEBUG("calling simcall_communication_get_remains(%p)",
386 task->simdata->comm);
387 return simcall_comm_get_remains(task->simdata->comm);
390 #ifdef HAVE_LATENCY_BOUND_TRACKING
391 /** \ingroup m_task_management
392 * \brief Return 1 if communication task is limited by latency, 0 otherwise
395 int MSG_task_is_latency_bounded(msg_task_t task)
397 xbt_assert((task != NULL)
398 && (task->simdata != NULL), "Invalid parameter");
399 XBT_DEBUG("calling simcall_communication_is_latency_bounded(%p)",
400 task->simdata->comm);
401 return simcall_comm_is_latency_bounded(task->simdata->comm);
405 /** \ingroup m_task_management
406 * \brief Returns the size of the data attached to a task #msg_task_t.
409 double MSG_task_get_bytes_amount(msg_task_t task)
411 xbt_assert((task != NULL)
412 && (task->simdata != NULL), "Invalid parameter");
414 return task->simdata->bytes_amount;
419 /** \ingroup m_task_management
420 * \brief Changes the priority of a computation task. This priority doesn't affect
421 * the transfer rate. A priority of 2 will make a task receive two times more
422 * cpu power than the other ones.
425 void MSG_task_set_priority(msg_task_t task, double priority)
427 xbt_assert((task != NULL)
428 && (task->simdata != NULL), "Invalid parameter");
430 task->simdata->priority = 1 / priority;
431 if (task->simdata->compute)
432 simcall_host_execution_set_priority(task->simdata->compute,
433 task->simdata->priority);
437 /** \ingroup m_task_management
438 * \brief Changes the maximum CPU utilization of a computation task.
441 * For VMs, there is a pitfall. Please see MSG_vm_set_bound().
443 void MSG_task_set_bound(msg_task_t task, double bound)
445 xbt_assert(task, "Invalid parameter");
446 xbt_assert(task->simdata, "Invalid parameter");
449 XBT_INFO("bound == 0 means no capping (i.e., unlimited).");
451 task->simdata->bound = bound;
452 if (task->simdata->compute)
453 simcall_host_execution_set_bound(task->simdata->compute,
454 task->simdata->bound);
458 /** \ingroup m_task_management
459 * \brief Changes the CPU affinity of a computation task.
461 * When pinning the given task to the first CPU core of the given host, use
462 * 0x01 for the mask value. Each bit of the mask value corresponds to each CPU
463 * core. See taskset(1) on Linux.
465 * \param task a target task
466 * \param host the host having a multi-core CPU
467 * \param mask the bit mask of a new CPU affinity setting for the task
471 * 0. Define a host with multiple cores.
472 * \<host id="PM0" power="1E8" core="2"/\>
474 * 1. Pin a given task to the first CPU core of a host.
475 * MSG_task_set_affinity(task, pm0, 0x01);
477 * 2. Pin a given task to the third CPU core of a host. Turn on the third bit of the mask.
478 * MSG_task_set_affinity(task, pm0, 0x04); // 0x04 == 100B
480 * 3. Pin a given VM to the first CPU core of a host.
481 * MSG_vm_set_affinity(vm, pm0, 0x01);
483 * See examples/msg/cloud/multicore.c for more information.
487 * 1. The current code does not allow an affinity of a task to multiple cores.
488 * The mask value 0x03 (i.e., a given task will be executed on the first core
489 * or the second core) is not allowed. The mask value 0x01 or 0x02 works. See
490 * cpu_cas01.c for details.
492 * 2. It is recommended to first compare simulation results in both the Lazy
493 * and Full calculation modes (using --cfg=cpu/optim:Full or not). Fix
494 * cpu_cas01.c if you find wrong results in the Lazy mode.
497 void MSG_task_set_affinity(msg_task_t task, msg_host_t host, unsigned long mask)
499 xbt_assert(task, "Invalid parameter");
500 xbt_assert(task->simdata, "Invalid parameter");
505 /* We need remove_ext() not throwing exception. */
506 void *ret = xbt_dict_get_or_null_ext(task->simdata->affinity_mask_db, (char *) host, sizeof(msg_host_t));
508 xbt_dict_remove_ext(task->simdata->affinity_mask_db, (char *) host, sizeof(host));
511 xbt_dict_set_ext(task->simdata->affinity_mask_db, (char *) host, sizeof(host), (void *) mask, NULL);
513 /* We set affinity data of this task. If the task is being executed, we
514 * actually change the affinity setting of the task. Otherwise, this change
515 * will be applied when the task is executed. */
517 if (!task->simdata->compute) {
518 /* task is not yet executed */
519 XBT_INFO("set affinity(0x%04lx@%s) for %s (not active now)", mask, MSG_host_get_name(host), MSG_task_get_name(task));
524 smx_synchro_t compute = task->simdata->compute;
525 msg_host_t host_now = compute->execution.host; // simix_private.h is necessary
526 if (host_now != host) {
527 /* task is not yet executed on this host */
528 XBT_INFO("set affinity(0x%04lx@%s) for %s (not active now)", mask, MSG_host_get_name(host), MSG_task_get_name(task));
532 /* task is being executed on this host. so change the affinity now */
534 /* check it works. remove me if it works. */
535 xbt_assert((unsigned long) xbt_dict_get_or_null_ext(task->simdata->affinity_mask_db, (char *) host, sizeof(msg_host_t)) == mask);
538 XBT_INFO("set affinity(0x%04lx@%s) for %s", mask, MSG_host_get_name(host), MSG_task_get_name(task));
539 simcall_host_execution_set_affinity(task->simdata->compute, host, mask);