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/instr/instr_private.hpp"
8 #include <simgrid/s4u/Comm.hpp>
9 #include <simgrid/s4u/Exec.hpp>
10 #include <simgrid/s4u/Host.hpp>
11 #include <simgrid/s4u/Mailbox.hpp>
16 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(msg_task, msg, "Logging specific to MSG (task)");
21 Task::Task(std::string name, double flops_amount, double bytes_amount, void* data)
22 : name_(std::move(name)), userdata_(data), flops_amount(flops_amount), bytes_amount(bytes_amount)
24 static std::atomic_ullong counter{0};
27 MC_ignore_heap(&(id_), sizeof(id_));
30 Task::Task(std::string name, std::vector<s4u::Host*> hosts, std::vector<double> flops_amount,
31 std::vector<double> bytes_amount, void* data)
32 : Task(std::move(name), 1.0, 0, data)
35 hosts_ = std::move(hosts);
36 flops_parallel_amount = std::move(flops_amount);
37 bytes_parallel_amount = std::move(bytes_amount);
40 Task* Task::create(std::string name, double flops_amount, double bytes_amount, void* data)
42 return new Task(std::move(name), flops_amount, bytes_amount, data);
45 Task* Task::create_parallel(std::string name, int host_nb, const msg_host_t* host_list, double* flops_amount,
46 double* bytes_amount, void* data)
48 std::vector<s4u::Host*> hosts;
49 std::vector<double> flops;
50 std::vector<double> bytes;
52 for (int i = 0; i < host_nb; i++) {
53 hosts.push_back(host_list[i]);
54 if (flops_amount != nullptr)
55 flops.push_back(flops_amount[i]);
56 if (bytes_amount != nullptr) {
57 for (int j = 0; j < host_nb; j++)
58 bytes.push_back(bytes_amount[host_nb * i + j]);
61 return new Task(std::move(name), std::move(hosts), std::move(flops), std::move(bytes), data);
64 msg_error_t Task::execute()
66 /* checking for infinite values */
67 xbt_assert(std::isfinite(flops_amount), "flops_amount is not finite!");
69 msg_error_t status = MSG_OK;
73 s4u::ExecPtr e = s4u::this_actor::exec_init(flops_amount)
74 ->set_priority(1 / priority_)
76 ->set_tracing_category(tracing_category_)
78 compute = boost::static_pointer_cast<kernel::activity::ExecImpl>(e->get_impl());
83 XBT_DEBUG("Execution task '%s' finished", get_cname());
84 } catch (HostFailureException& e) {
85 status = MSG_HOST_FAILURE;
86 } catch (TimeoutError& e) {
88 } catch (CancelException& e) {
89 status = MSG_TASK_CANCELED;
92 /* action ended, set comm and compute = nullptr, the actions is already destroyed in the main function */
100 s4u::CommPtr Task::send_async(std::string alias, void_f_pvoid_t cleanup, bool detached)
102 if (TRACE_actor_is_enabled()) {
103 container_t process_container = simgrid::instr::Container::by_name(instr_pid(MSG_process_self()));
104 std::string key = std::string("p") + std::to_string(get_id());
105 simgrid::instr::Container::get_root()->get_link("ACTOR_TASK_LINK")->start_event(process_container, "SR", key);
108 /* Prepare the task to send */
110 this->comm = nullptr;
111 msg_global->sent_msg++;
113 s4u::CommPtr comm = s4u::Mailbox::by_name(alias)->put_init(this, bytes_amount)->set_rate(get_rate());
117 comm->detach(cleanup);
121 if (TRACE_is_enabled() && has_tracing_category())
122 simgrid::simix::simcall([comm, this] { comm->get_impl()->set_category(std::move(tracing_category_)); });
130 simgrid::simix::simcall([this] { compute->cancel(); });
137 void Task::set_priority(double priority)
139 xbt_assert(std::isfinite(1.0 / priority), "priority is not finite!");
140 priority_ = 1.0 / priority;
143 s4u::Actor* Task::get_sender()
145 return comm ? comm->get_sender().get() : nullptr;
148 s4u::Host* Task::get_source()
150 return comm ? comm->get_sender()->get_host() : nullptr;
153 void Task::set_used()
156 report_multiple_use();
160 void Task::report_multiple_use() const
162 if (msg_global->debug_multiple_use){
163 XBT_ERROR("This task is already used in there:");
165 XBT_ERROR("<missing backtrace>");
166 XBT_ERROR("And you try to reuse it from here:");
167 xbt_backtrace_display_current();
169 xbt_die("This task is still being used somewhere else. You cannot send it now. Go fix your code!"
170 "(use --cfg=msg/debug-multiple-use:on to get the backtrace of the other process)");
174 } // namespace simgrid
176 /********************************* Task **************************************/
177 /** @brief Creates a new task
179 * A constructor for msg_task_t taking four arguments.
181 * @param name a name for the object. It is for user-level information and can be nullptr.
182 * @param flop_amount a value of the processing amount (in flop) needed to process this new task.
183 * If 0, then it cannot be executed with MSG_task_execute(). This value has to be >=0.
184 * @param message_size a value of the amount of data (in bytes) needed to transfer this new task. If 0, then it cannot
185 * be transfered with MSG_task_send() and MSG_task_recv(). This value has to be >=0.
186 * @param data a pointer to any data may want to attach to the new object. It is for user-level information and can
187 * be nullptr. It can be retrieved with the function @ref MSG_task_get_data.
188 * @return The new corresponding object.
190 msg_task_t MSG_task_create(const char *name, double flop_amount, double message_size, void *data)
192 return simgrid::msg::Task::create(name ? std::string(name) : "", flop_amount, message_size, data);
195 /** @brief Creates a new parallel task
197 * A constructor for #msg_task_t taking six arguments.
200 * See :cpp:func:`void simgrid::s4u::this_actor::parallel_execute(int, s4u::Host**, double*, double*)` for
201 * the exact semantic of the parameters.
204 * @param name a name for the object. It is for user-level information and can be nullptr.
205 * @param host_nb the number of hosts implied in the parallel task.
206 * @param host_list an array of @p host_nb msg_host_t.
207 * @param flops_amount an array of @p host_nb doubles.
208 * flops_amount[i] is the total number of operations that have to be performed on host_list[i].
209 * @param bytes_amount an array of @p host_nb* @p host_nb doubles.
210 * @param data a pointer to any data may want to attach to the new object.
211 * It is for user-level information and can be nullptr.
212 * It can be retrieved with the function @ref MSG_task_get_data().
214 msg_task_t MSG_parallel_task_create(const char *name, int host_nb, const msg_host_t * host_list,
215 double *flops_amount, double *bytes_amount, void *data)
217 // Task's flops amount is set to an arbitrary value > 0.0 to be able to distinguish, in
218 // MSG_task_get_remaining_work_ratio(), a finished task and a task that has not started yet.
219 return simgrid::msg::Task::create_parallel(name ? name : "", host_nb, host_list, flops_amount, bytes_amount, data);
222 /** @brief Return the user data of the given task */
223 void* MSG_task_get_data(msg_task_t task)
225 return task->get_user_data();
228 /** @brief Sets the user data of a given task */
229 void MSG_task_set_data(msg_task_t task, void *data)
231 task->set_user_data(data);
234 /** @brief Sets a function to be called when a task has just been copied.
235 * @param callback a callback function
237 void MSG_task_set_copy_callback(void (*callback) (msg_task_t task, msg_process_t sender, msg_process_t receiver)) {
239 msg_global->task_copy_callback = callback;
242 SIMIX_comm_set_copy_data_callback(MSG_comm_copy_data_from_SIMIX);
244 SIMIX_comm_set_copy_data_callback(SIMIX_comm_copy_pointer_callback);
248 /** @brief Returns the sender of the given task */
249 msg_process_t MSG_task_get_sender(msg_task_t task)
251 return task->get_sender();
254 /** @brief Returns the source (the sender's host) of the given task */
255 msg_host_t MSG_task_get_source(msg_task_t task)
257 return task->get_source();
260 /** @brief Returns the name of the given task. */
261 const char *MSG_task_get_name(msg_task_t task)
263 return task->get_cname();
266 /** @brief Sets the name of the given task. */
267 void MSG_task_set_name(msg_task_t task, const char *name)
269 task->set_name(name);
273 * @brief Executes a task and waits for its termination.
275 * This function is used for describing the behavior of a process. It takes only one parameter.
276 * @param task a #msg_task_t to execute on the location on which the process is running.
277 * @return #MSG_OK if the task was successfully completed, #MSG_TASK_CANCELED or #MSG_HOST_FAILURE otherwise
279 msg_error_t MSG_task_execute(msg_task_t task)
281 return task->execute();
284 * @brief Sends a task on a mailbox.
286 * This is a non blocking function: use MSG_comm_wait() or MSG_comm_test() to end the communication.
288 * @param task a #msg_task_t to send on another location.
289 * @param alias name of the mailbox to sent the task to
290 * @return the msg_comm_t communication created
292 msg_comm_t MSG_task_isend(msg_task_t task, const char* alias)
294 return new simgrid::msg::Comm(task, nullptr, task->send_async(alias, nullptr, false));
298 * @brief Sends a task on a mailbox with a maximum rate
300 * This is a non blocking function: use MSG_comm_wait() or MSG_comm_test() to end the communication. The maxrate
301 * parameter allows the application to limit the bandwidth utilization of network links when sending the task.
303 * @param task a #msg_task_t to send on another location.
304 * @param alias name of the mailbox to sent the task to
305 * @param maxrate the maximum communication rate for sending this task (byte/sec).
306 * @return the msg_comm_t communication created
308 msg_comm_t MSG_task_isend_bounded(msg_task_t task, const char* alias, double maxrate)
310 task->set_rate(maxrate);
311 return new simgrid::msg::Comm(task, nullptr, task->send_async(alias, nullptr, false));
315 * @brief Sends a task on a mailbox.
317 * This is a non blocking detached send function.
318 * Think of it as a best effort send. Keep in mind that the third parameter is only called if the communication fails.
319 * If the communication does work, it is responsibility of the receiver code to free anything related to the task, as
320 * usual. More details on this can be obtained on
321 * <a href="http://lists.gforge.inria.fr/pipermail/simgrid-user/2011-November/002649.html">this thread</a>
322 * in the SimGrid-user mailing list archive.
324 * @param task a #msg_task_t to send on another location.
325 * @param alias name of the mailbox to sent the task to
326 * @param cleanup a function to destroy the task if the communication fails, e.g. MSG_task_destroy
327 * (if nullptr, no function will be called)
329 void MSG_task_dsend(msg_task_t task, const char* alias, void_f_pvoid_t cleanup)
331 task->send_async(alias, cleanup, true);
335 * @brief Sends a task on a mailbox with a maximal rate.
337 * This is a non blocking detached send function.
338 * Think of it as a best effort send. Keep in mind that the third parameter is only called if the communication fails.
339 * If the communication does work, it is responsibility of the receiver code to free anything related to the task, as
340 * usual. More details on this can be obtained on
341 * <a href="http://lists.gforge.inria.fr/pipermail/simgrid-user/2011-November/002649.html">this thread</a>
342 * in the SimGrid-user mailing list archive.
344 * The rate parameter can be used to send a task with a limited bandwidth (smaller than the physical available value).
345 * Use MSG_task_dsend() if you don't limit the rate (or pass -1 as a rate value do disable this feature).
347 * @param task a #msg_task_t to send on another location.
348 * @param alias name of the mailbox to sent the task to
349 * @param cleanup a function to destroy the task if the communication fails, e.g. MSG_task_destroy (if nullptr, no
350 * function will be called)
351 * @param maxrate the maximum communication rate for sending this task (byte/sec)
354 void MSG_task_dsend_bounded(msg_task_t task, const char* alias, void_f_pvoid_t cleanup, double maxrate)
356 task->set_rate(maxrate);
357 task->send_async(alias, cleanup, true);
360 /** @brief Destroys the given task.
362 * You should free user data, if any, @b before calling this destructor.
364 * Only the process that owns the task can destroy it.
365 * The owner changes after a successful send.
366 * If a task is successfully sent, the receiver becomes the owner and is supposed to destroy it. The sender should not
368 * If the task failed to be sent, the sender remains the owner of the task.
370 msg_error_t MSG_task_destroy(msg_task_t task)
372 if (task->is_used()) {
373 /* the task is being sent or executed: cancel it first */
377 /* free main structures */
383 /** @brief Cancel the given task
385 * If it was currently executed or transfered, the working process is stopped.
387 msg_error_t MSG_task_cancel(msg_task_t task)
389 xbt_assert((task != nullptr), "Cannot cancel a nullptr task");
394 /** @brief Returns a value in ]0,1[ that represent the task remaining work
395 * to do: starts at 1 and goes to 0. Returns 0 if not started or finished.
397 * It works for either parallel or sequential tasks.
399 double MSG_task_get_remaining_work_ratio(msg_task_t task) {
401 xbt_assert((task != nullptr), "Cannot get information from a nullptr task");
404 return task->compute->get_remaining_ratio();
406 // Task not started (flops_amount is > 0.0) or finished (flops_amount is set to 0.0)
407 return task->flops_amount > 0.0 ? 1.0 : 0.0;
411 /** @brief Returns the amount of flops that remain to be computed
413 * The returned value is initially the cost that you defined for the task, then it decreases until it reaches 0
415 * It works for sequential tasks, but the remaining amount of work is not a scalar value for parallel tasks.
416 * So you will get an exception if you call this function on parallel tasks. Just don't do it.
418 double MSG_task_get_flops_amount(msg_task_t task) {
419 if (task->compute != nullptr) {
420 return task->compute->get_remaining();
422 // Not started or already done.
423 // - Before starting, flops_amount is initially the task cost
424 // - After execution, flops_amount is set to 0 (until someone uses MSG_task_set_flops_amount, if any)
425 return task->flops_amount;
429 /** @brief set the computation amount needed to process the given task.
431 * @warning If the computation is ongoing (already started and not finished),
432 * it is not modified by this call. Moreover, after its completion, the ongoing execution with set the flops_amount to
433 * zero, overriding any value set during the execution.
435 void MSG_task_set_flops_amount(msg_task_t task, double flops_amount)
437 task->flops_amount = flops_amount;
440 /** @brief set the amount data attached with the given task.
442 * @warning If the transfer is ongoing (already started and not finished), it is not modified by this call.
444 void MSG_task_set_bytes_amount(msg_task_t task, double data_size)
446 task->bytes_amount = data_size;
449 /** @brief Returns the total amount received by the given task
451 * If the communication does not exist it will return 0.
452 * So, if the communication has FINISHED or FAILED it returns zero.
454 double MSG_task_get_remaining_communication(msg_task_t task)
456 XBT_DEBUG("calling simcall_communication_get_remains(%p)", task->comm.get());
457 return task->comm->get_remaining();
460 /** @brief Returns the size of the data attached to the given task. */
461 double MSG_task_get_bytes_amount(msg_task_t task)
463 xbt_assert(task != nullptr, "Invalid parameter");
464 return task->bytes_amount;
467 /** @brief Changes the priority of a computation task.
469 * This priority doesn't affect the transfer rate. A priority of 2
470 * will make a task receive two times more cpu power than regular tasks.
472 void MSG_task_set_priority(msg_task_t task, double priority)
474 task->set_priority(priority);
477 /** @brief Changes the maximum CPU utilization of a computation task (in flops/s).
479 * For VMs, there is a pitfall. Please see MSG_vm_set_bound().
481 void MSG_task_set_bound(msg_task_t task, double bound)
483 if (bound < 1e-12) /* close enough to 0 without any floating precision surprise */
484 XBT_INFO("bound == 0 means no capping (i.e., unlimited).");
485 task->set_bound(bound);
489 * @brief Sets the tracing category of a task.
491 * This function should be called after the creation of a MSG task, to define the category of that task. The
492 * first parameter task must contain a task that was =created with the function #MSG_task_create. The second
493 * parameter category must contain a category that was previously declared with the function #TRACE_category
494 * (or with #TRACE_category_with_color).
496 * See @ref outcomes_vizu for details on how to trace the (categorized) resource utilization.
498 * @param task the task that is going to be categorized
499 * @param category the name of the category to be associated to the task
501 * @see MSG_task_get_category, TRACE_category, TRACE_category_with_color
503 void MSG_task_set_category(msg_task_t task, const char* category)
505 xbt_assert(not task->has_tracing_category(), "Task %p(%s) already has a category (%s).", task, task->get_cname(),
506 task->get_tracing_category().c_str());
508 // if user provides a nullptr category, task is no longer traced
509 if (category == nullptr) {
510 task->set_tracing_category("");
511 XBT_DEBUG("MSG task %p(%s), category removed", task, task->get_cname());
514 task->set_tracing_category(category);
515 XBT_DEBUG("MSG task %p(%s), category %s", task, task->get_cname(), task->get_tracing_category().c_str());
520 * @brief Gets the current tracing category of a task. (@see MSG_task_set_category)
521 * @param task the task to be considered
522 * @return Returns the name of the tracing category of the given task, "" otherwise
524 const char* MSG_task_get_category(msg_task_t task)
526 return task->get_tracing_category().c_str();