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(const std::string& name, double flops_amount, double bytes_amount, void* data)
22 : name_(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(const std::string& name, std::vector<s4u::Host*>&& hosts, std::vector<double>&& flops_amount,
31 std::vector<double>&& bytes_amount, void* data)
32 : Task(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(const std::string& name, double flops_amount, double bytes_amount, void* data)
42 return new Task(name, flops_amount, bytes_amount, data);
45 Task* Task::create_parallel(const std::string& name, int host_nb, const msg_host_t* host_list, double* flops_amount,
46 double* bytes_amount, void* data)
48 std::vector<simgrid::s4u::Host*> hosts(host_list, host_list + host_nb);
49 std::vector<double> flops;
50 std::vector<double> bytes;
51 if (flops_amount != nullptr)
52 flops = std::vector<double>(flops_amount, flops_amount + host_nb);
53 if (bytes_amount != nullptr)
54 bytes = std::vector<double>(bytes_amount, bytes_amount + host_nb * host_nb);
56 return new Task(name, std::move(hosts), std::move(flops), std::move(bytes), data);
59 msg_error_t Task::execute()
61 /* checking for infinite values */
62 xbt_assert(std::isfinite(flops_amount), "flops_amount is not finite!");
64 msg_error_t status = MSG_OK;
65 if (flops_amount <= 0.0)
71 compute = s4u::this_actor::exec_init(hosts_, flops_parallel_amount, bytes_parallel_amount);
73 compute = s4u::this_actor::exec_init(flops_amount);
75 compute->set_name(name_)
76 ->set_tracing_category(tracing_category_)
77 ->set_timeout(timeout_)
78 ->set_priority(1 / priority_)
83 XBT_DEBUG("Execution task '%s' finished", get_cname());
84 } catch (const HostFailureException&) {
85 status = MSG_HOST_FAILURE;
86 } catch (const TimeoutError&) {
88 } catch (const CancelException&) {
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(const 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 s4u_comm = s4u::Mailbox::by_name(alias)->put_init(this, bytes_amount)->set_rate(get_rate());
114 if (TRACE_is_enabled() && has_tracing_category())
115 s4u_comm->set_tracing_category(tracing_category_);
120 comm->detach(cleanup);
127 msg_error_t Task::send(const std::string& alias, double timeout)
129 msg_error_t ret = MSG_OK;
132 comm = nullptr; // needed, otherwise MC gets confused.
133 s4u::CommPtr s4u_comm = send_async(alias, nullptr, false);
135 comm->wait_for(timeout);
136 } catch (const simgrid::TimeoutError&) {
138 } catch (const simgrid::CancelException&) {
139 ret = MSG_HOST_FAILURE;
140 } catch (const simgrid::NetworkFailureException&) {
141 ret = MSG_TRANSFER_FAILURE;
142 /* If the send failed, it is not used anymore */
158 void Task::set_priority(double priority)
160 xbt_assert(std::isfinite(1.0 / priority), "priority is not finite!");
161 priority_ = 1.0 / priority;
164 s4u::Actor* Task::get_sender()
166 return comm ? comm->get_sender() : nullptr;
169 s4u::Host* Task::get_source()
171 return comm ? comm->get_sender()->get_host() : nullptr;
174 void Task::set_used()
177 report_multiple_use();
181 void Task::report_multiple_use() const
183 if (MSG_Global_t::debug_multiple_use) {
184 XBT_ERROR("This task is already used in there:");
186 XBT_ERROR("<missing backtrace>");
187 XBT_ERROR("And you try to reuse it from here:");
188 xbt_backtrace_display_current();
190 xbt_die("This task is still being used somewhere else. You cannot send it now. Go fix your code!"
191 "(use --cfg=msg/debug-multiple-use:on to get the backtrace of the other process)");
195 } // namespace simgrid
197 /********************************* Task **************************************/
198 /** @brief Creates a new task
200 * A constructor for msg_task_t taking four arguments.
202 * @param name a name for the object. It is for user-level information and can be nullptr.
203 * @param flop_amount a value of the processing amount (in flop) needed to process this new task.
204 * If 0, then it cannot be executed with MSG_task_execute(). This value has to be >=0.
205 * @param message_size a value of the amount of data (in bytes) needed to transfer this new task. If 0, then it cannot
206 * be transfered with MSG_task_send() and MSG_task_recv(). This value has to be >=0.
207 * @param data a pointer to any data may want to attach to the new object. It is for user-level information and can
208 * be nullptr. It can be retrieved with the function @ref MSG_task_get_data.
209 * @return The new corresponding object.
211 msg_task_t MSG_task_create(const char *name, double flop_amount, double message_size, void *data)
213 return simgrid::msg::Task::create(name ? std::string(name) : "", flop_amount, message_size, data);
216 /** @brief Creates a new parallel task
218 * A constructor for #msg_task_t taking six arguments.
221 * See :cpp:func:`void simgrid::s4u::this_actor::parallel_execute(int, s4u::Host**, double*, double*)` for
222 * the exact semantic of the parameters.
225 * @param name a name for the object. It is for user-level information and can be nullptr.
226 * @param host_nb the number of hosts implied in the parallel task.
227 * @param host_list an array of @p host_nb msg_host_t.
228 * @param flops_amount an array of @p host_nb doubles.
229 * flops_amount[i] is the total number of operations that have to be performed on host_list[i].
230 * @param bytes_amount an array of @p host_nb* @p host_nb doubles.
231 * @param data a pointer to any data may want to attach to the new object.
232 * It is for user-level information and can be nullptr.
233 * It can be retrieved with the function @ref MSG_task_get_data().
235 msg_task_t MSG_parallel_task_create(const char *name, int host_nb, const msg_host_t * host_list,
236 double *flops_amount, double *bytes_amount, void *data)
238 // Task's flops amount is set to an arbitrary value > 0.0 to be able to distinguish, in
239 // MSG_task_get_remaining_work_ratio(), a finished task and a task that has not started yet.
240 return simgrid::msg::Task::create_parallel(name ? name : "", host_nb, host_list, flops_amount, bytes_amount, data);
243 /** @brief Return the user data of the given task */
244 void* MSG_task_get_data(msg_task_t task)
246 return task->get_user_data();
249 /** @brief Sets the user data of a given task */
250 void MSG_task_set_data(msg_task_t task, void *data)
252 task->set_user_data(data);
255 /** @brief Sets a function to be called when a task has just been copied.
256 * @param callback a callback function
259 void MSG_task_set_copy_callback(void (*callback) (msg_task_t task, msg_process_t sender, msg_process_t receiver)) {
261 msg_global->task_copy_callback = callback;
264 SIMIX_comm_set_copy_data_callback(MSG_comm_copy_data_from_SIMIX);
266 SIMIX_comm_set_copy_data_callback(SIMIX_comm_copy_pointer_callback);
270 /** @brief Returns the sender of the given task */
271 msg_process_t MSG_task_get_sender(msg_task_t task)
273 return task->get_sender();
276 /** @brief Returns the source (the sender's host) of the given task */
277 msg_host_t MSG_task_get_source(msg_task_t task)
279 return task->get_source();
282 /** @brief Returns the name of the given task. */
283 const char *MSG_task_get_name(msg_task_t task)
285 return task->get_cname();
288 /** @brief Sets the name of the given task. */
289 void MSG_task_set_name(msg_task_t task, const char *name)
291 task->set_name(name);
295 * @brief Executes a task and waits for its termination.
297 * This function is used for describing the behavior of a process. It takes only one parameter.
298 * @param task a #msg_task_t to execute on the location on which the process is running.
299 * @return #MSG_OK if the task was successfully completed, #MSG_TASK_CANCELED or #MSG_HOST_FAILURE otherwise
301 msg_error_t MSG_task_execute(msg_task_t task)
303 return task->execute();
307 * @brief Executes a parallel task and waits for its termination.
309 * @param task a #msg_task_t to execute on the location on which the process is running.
311 * @return #MSG_OK if the task was successfully completed, #MSG_TASK_CANCELED or #MSG_HOST_FAILURE otherwise
313 msg_error_t MSG_parallel_task_execute(msg_task_t task)
315 return task->execute();
318 msg_error_t MSG_parallel_task_execute_with_timeout(msg_task_t task, double timeout)
320 task->set_timeout(timeout);
321 return task->execute();
325 * @brief Sends a task on a mailbox.
327 * This is a non blocking function: use MSG_comm_wait() or MSG_comm_test() to end the communication.
329 * @param task a #msg_task_t to send on another location.
330 * @param alias name of the mailbox to sent the task to
331 * @return the msg_comm_t communication created
333 msg_comm_t MSG_task_isend(msg_task_t task, const char* alias)
335 return new simgrid::msg::Comm(task, nullptr, task->send_async(alias, nullptr, false));
339 * @brief Sends a task on a mailbox with a maximum rate
341 * This is a non blocking function: use MSG_comm_wait() or MSG_comm_test() to end the communication. The maxrate
342 * parameter allows the application to limit the bandwidth utilization of network links when sending the task.
344 * @param task a #msg_task_t to send on another location.
345 * @param alias name of the mailbox to sent the task to
346 * @param maxrate the maximum communication rate for sending this task (byte/sec).
347 * @return the msg_comm_t communication created
349 msg_comm_t MSG_task_isend_bounded(msg_task_t task, const char* alias, double maxrate)
351 task->set_rate(maxrate);
352 return new simgrid::msg::Comm(task, nullptr, task->send_async(alias, nullptr, false));
356 * @brief Sends a task on a mailbox.
358 * This is a non blocking detached send function.
359 * Think of it as a best effort send. Keep in mind that the third parameter is only called if the communication fails.
360 * If the communication does work, it is responsibility of the receiver code to free anything related to the task, as
361 * usual. More details on this can be obtained on
362 * <a href="http://lists.gforge.inria.fr/pipermail/simgrid-user/2011-November/002649.html">this thread</a>
363 * in the SimGrid-user mailing list archive.
365 * @param task a #msg_task_t to send on another location.
366 * @param alias name of the mailbox to sent the task to
367 * @param cleanup a function to destroy the task if the communication fails, e.g. MSG_task_destroy
368 * (if nullptr, no function will be called)
370 void MSG_task_dsend(msg_task_t task, const char* alias, void_f_pvoid_t cleanup)
372 task->send_async(alias, cleanup, true);
376 * @brief Sends a task on a mailbox with a maximal rate.
378 * This is a non blocking detached send function.
379 * Think of it as a best effort send. Keep in mind that the third parameter is only called if the communication fails.
380 * If the communication does work, it is responsibility of the receiver code to free anything related to the task, as
381 * usual. More details on this can be obtained on
382 * <a href="http://lists.gforge.inria.fr/pipermail/simgrid-user/2011-November/002649.html">this thread</a>
383 * in the SimGrid-user mailing list archive.
385 * The rate parameter can be used to send a task with a limited bandwidth (smaller than the physical available value).
386 * Use MSG_task_dsend() if you don't limit the rate (or pass -1 as a rate value do disable this feature).
388 * @param task a #msg_task_t to send on another location.
389 * @param alias name of the mailbox to sent the task to
390 * @param cleanup a function to destroy the task if the communication fails, e.g. MSG_task_destroy (if nullptr, no
391 * function will be called)
392 * @param maxrate the maximum communication rate for sending this task (byte/sec)
395 void MSG_task_dsend_bounded(msg_task_t task, const char* alias, void_f_pvoid_t cleanup, double maxrate)
397 task->set_rate(maxrate);
398 task->send_async(alias, cleanup, true);
401 * @brief Sends a task to a mailbox
403 * This is a blocking function, the execution flow will be blocked until the task is sent (and received on the other
404 * side if #MSG_task_receive is used).
405 * See #MSG_task_isend for sending tasks asynchronously.
407 * @param task the task to be sent
408 * @param alias the mailbox name to where the task is sent
410 * @return Returns #MSG_OK if the task was successfully sent,
411 * #MSG_HOST_FAILURE, or #MSG_TRANSFER_FAILURE otherwise.
413 msg_error_t MSG_task_send(msg_task_t task, const char* alias)
415 XBT_DEBUG("MSG_task_send: Trying to send a message on mailbox '%s'", alias);
416 return task->send(alias, -1);
420 * @brief Sends a task to a mailbox with a maximum rate
422 * This is a blocking function, the execution flow will be blocked until the task is sent. The maxrate parameter allows
423 * the application to limit the bandwidth utilization of network links when sending the task.
425 * The maxrate parameter can be used to send a task with a limited bandwidth (smaller than the physical available
426 * value). Use MSG_task_send() if you don't limit the rate (or pass -1 as a rate value do disable this feature).
428 * @param task the task to be sent
429 * @param alias the mailbox name to where the task is sent
430 * @param maxrate the maximum communication rate for sending this task (byte/sec)
432 * @return Returns #MSG_OK if the task was successfully sent,
433 * #MSG_HOST_FAILURE, or #MSG_TRANSFER_FAILURE otherwise.
435 msg_error_t MSG_task_send_bounded(msg_task_t task, const char* alias, double maxrate)
437 task->set_rate(maxrate);
438 return task->send(alias, -1);
442 * @brief Sends a task to a mailbox with a timeout
444 * This is a blocking function, the execution flow will be blocked until the task is sent or the timeout is achieved.
446 * @param task the task to be sent
447 * @param alias the mailbox name to where the task is sent
448 * @param timeout is the maximum wait time for completion (if -1, this call is the same as #MSG_task_send)
450 * @return Returns #MSG_OK if the task was successfully sent,
451 * #MSG_HOST_FAILURE, or #MSG_TRANSFER_FAILURE, or #MSG_TIMEOUT otherwise.
453 msg_error_t MSG_task_send_with_timeout(msg_task_t task, const char* alias, double timeout)
455 return task->send(alias, timeout);
459 * @brief Sends a task to a mailbox with a timeout and with a maximum rate
461 * This is a blocking function, the execution flow will be blocked until the task is sent or the timeout is achieved.
463 * The maxrate parameter can be used to send a task with a limited bandwidth (smaller than the physical available
464 * value). Use MSG_task_send_with_timeout() if you don't limit the rate (or pass -1 as a rate value do disable this
467 * @param task the task to be sent
468 * @param alias the mailbox name to where the task is sent
469 * @param timeout is the maximum wait time for completion (if -1, this call is the same as #MSG_task_send)
470 * @param maxrate the maximum communication rate for sending this task (byte/sec)
472 * @return Returns #MSG_OK if the task was successfully sent,
473 * #MSG_HOST_FAILURE, or #MSG_TRANSFER_FAILURE, or #MSG_TIMEOUT otherwise.
475 msg_error_t MSG_task_send_with_timeout_bounded(msg_task_t task, const char* alias, double timeout, double maxrate)
477 task->set_rate(maxrate);
478 return task->send(alias, timeout);
482 * @brief Receives a task from a mailbox.
484 * This is a blocking function, the execution flow will be blocked until the task is received. See #MSG_task_irecv
485 * for receiving tasks asynchronously.
487 * @param task a memory location for storing a #msg_task_t.
488 * @param alias name of the mailbox to receive the task from
491 * #MSG_OK if the task was successfully received,
492 * #MSG_HOST_FAILURE, or #MSG_TRANSFER_FAILURE otherwise.
494 msg_error_t MSG_task_receive(msg_task_t * task, const char *alias)
496 return MSG_task_receive_with_timeout(task, alias, -1);
500 * @brief Receives a task from a mailbox at a given rate.
502 * @param task a memory location for storing a #msg_task_t.
503 * @param alias name of the mailbox to receive the task from
504 * @param rate limit the reception to rate bandwidth (byte/sec)
506 * The rate parameter can be used to receive a task with a limited bandwidth (smaller than the physical available
507 * value). Use MSG_task_receive() if you don't limit the rate (or pass -1 as a rate value do disable this feature).
510 * #MSG_OK if the task was successfully received,
511 * #MSG_HOST_FAILURE, or #MSG_TRANSFER_FAILURE otherwise.
513 msg_error_t MSG_task_receive_bounded(msg_task_t* task, const char* alias, double rate)
515 return MSG_task_receive_with_timeout_bounded(task, alias, -1, rate);
519 * @brief Receives a task from a mailbox with a given timeout.
521 * This is a blocking function with a timeout, the execution flow will be blocked until the task is received or the
522 * timeout is achieved. See #MSG_task_irecv for receiving tasks asynchronously. You can provide a -1 timeout
523 * to obtain an infinite timeout.
525 * @param task a memory location for storing a #msg_task_t.
526 * @param alias name of the mailbox to receive the task from
527 * @param timeout is the maximum wait time for completion (if -1, this call is the same as #MSG_task_receive)
530 * #MSG_OK if the task was successfully received,
531 * #MSG_HOST_FAILURE, or #MSG_TRANSFER_FAILURE, or #MSG_TIMEOUT otherwise.
533 msg_error_t MSG_task_receive_with_timeout(msg_task_t* task, const char* alias, double timeout)
535 return MSG_task_receive_ext_bounded(task, alias, timeout, nullptr, -1);
539 * @brief Receives a task from a mailbox with a given timeout and at a given rate.
541 * @param task a memory location for storing a #msg_task_t.
542 * @param alias name of the mailbox to receive the task from
543 * @param timeout is the maximum wait time for completion (if -1, this call is the same as #MSG_task_receive)
544 * @param rate limit the reception to rate bandwidth (byte/sec)
546 * The rate parameter can be used to send a task with a limited
547 * bandwidth (smaller than the physical available value). Use
548 * MSG_task_receive() if you don't limit the rate (or pass -1 as a
549 * rate value do disable this feature).
552 * #MSG_OK if the task was successfully received,
553 * #MSG_HOST_FAILURE, or #MSG_TRANSFER_FAILURE, or #MSG_TIMEOUT otherwise.
555 msg_error_t MSG_task_receive_with_timeout_bounded(msg_task_t* task, const char* alias, double timeout, double rate)
557 return MSG_task_receive_ext_bounded(task, alias, timeout, nullptr, rate);
561 * @brief Receives a task from a mailbox from a specific host with a given timeout.
563 * This is a blocking function with a timeout, the execution flow will be blocked until the task is received or the
564 * timeout is achieved. See #MSG_task_irecv for receiving tasks asynchronously. You can provide a -1 timeout
565 * to obtain an infinite timeout.
567 * @param task a memory location for storing a #msg_task_t.
568 * @param alias name of the mailbox to receive the task from
569 * @param timeout is the maximum wait time for completion (provide -1 for no timeout)
570 * @param host a #msg_host_t host from where the task was sent
573 * #MSG_OK if the task was successfully received,
574 * #MSG_HOST_FAILURE, or #MSG_TRANSFER_FAILURE, or #MSG_TIMEOUT otherwise.
576 msg_error_t MSG_task_receive_ext(msg_task_t* task, const char* alias, double timeout, msg_host_t host)
578 XBT_DEBUG("MSG_task_receive_ext: Trying to receive a message on mailbox '%s'", alias);
579 return MSG_task_receive_ext_bounded(task, alias, timeout, host, -1.0);
583 * @brief Receives a task from a mailbox from a specific host with a given timeout and at a given rate.
585 * @param task a memory location for storing a #msg_task_t.
586 * @param alias name of the mailbox to receive the task from
587 * @param timeout is the maximum wait time for completion (provide -1 for no timeout)
588 * @param host a #msg_host_t host from where the task was sent
589 * @param rate limit the reception to rate bandwidth (byte/sec)
591 * The rate parameter can be used to receive a task with a limited bandwidth (smaller than the physical available
592 * value). Use MSG_task_receive_ext() if you don't limit the rate (or pass -1 as a rate value do disable this feature).
595 * #MSG_OK if the task was successfully received,
596 * #MSG_HOST_FAILURE, or #MSG_TRANSFER_FAILURE, or #MSG_TIMEOUT otherwise.
598 msg_error_t MSG_task_receive_ext_bounded(msg_task_t* task, const char* alias, double timeout, msg_host_t host,
601 XBT_DEBUG("MSG_task_receive_ext: Trying to receive a message on mailbox '%s'", alias);
602 msg_error_t ret = MSG_OK;
603 /* We no longer support getting a task from a specific host */
608 xbt_assert(task, "Null pointer for the task storage");
611 XBT_WARN("Asked to write the received task in a non empty struct -- proceeding.");
613 /* Try to receive it by calling SIMIX network layer */
616 simgrid::s4u::Mailbox::by_name(alias)
618 ->set_dst_data(&payload, sizeof(msg_task_t*))
621 *task = static_cast<msg_task_t>(payload);
622 XBT_DEBUG("Got task %s from %s", (*task)->get_cname(), alias);
623 (*task)->set_not_used();
624 } catch (const simgrid::HostFailureException&) {
625 ret = MSG_HOST_FAILURE;
626 } catch (const simgrid::TimeoutError&) {
628 } catch (const simgrid::CancelException&) {
629 ret = MSG_TASK_CANCELED;
630 } catch (const simgrid::NetworkFailureException&) {
631 ret = MSG_TRANSFER_FAILURE;
634 if (TRACE_actor_is_enabled() && ret != MSG_HOST_FAILURE && ret != MSG_TRANSFER_FAILURE && ret != MSG_TIMEOUT) {
635 container_t process_container = simgrid::instr::Container::by_name(instr_pid(*MSG_process_self()));
637 std::string key = std::string("p") + std::to_string((*task)->get_id());
638 simgrid::instr::Container::get_root()->get_link("ACTOR_TASK_LINK")->end_event(process_container, "SR", key);
644 * @brief Starts listening for receiving a task from an asynchronous communication.
646 * This is a non blocking function: use MSG_comm_wait() or MSG_comm_test() to end the communication.
648 * @param task a memory location for storing a #msg_task_t. has to be valid until the end of the communication.
649 * @param name of the mailbox to receive the task on
650 * @return the msg_comm_t communication created
652 msg_comm_t MSG_task_irecv(msg_task_t* task, const char* name)
654 return MSG_task_irecv_bounded(task, name, -1.0);
658 * @brief Starts listening for receiving a task from an asynchronous communication at a given rate.
660 * The rate parameter can be used to receive a task with a limited
661 * bandwidth (smaller than the physical available value). Use
662 * MSG_task_irecv() if you don't limit the rate (or pass -1 as a rate
663 * value do disable this feature).
665 * @param task a memory location for storing a #msg_task_t. has to be valid until the end of the communication.
666 * @param name of the mailbox to receive the task on
667 * @param rate limit the bandwidth to the given rate (byte/sec)
668 * @return the msg_comm_t communication created
670 msg_comm_t MSG_task_irecv_bounded(msg_task_t* task, const char* name, double rate)
672 /* FIXME: these functions are not traceable */
674 xbt_assert(task, "Null pointer for the task storage");
677 XBT_CRITICAL("MSG_task_irecv() was asked to write in a non empty task struct.");
679 /* Try to receive it by calling SIMIX network layer */
680 simgrid::s4u::CommPtr comm = simgrid::s4u::Mailbox::by_name(name)
682 ->set_dst_data((void**)task, sizeof(msg_task_t*))
686 return new simgrid::msg::Comm(nullptr, task, comm);
690 * @brief Look if there is a communication on a mailbox and return the PID of the sender process.
692 * @param alias the name of the mailbox to be considered
694 * @return Returns the PID of sender process,
695 * -1 if there is no communication in the mailbox.#include <cmath>
698 int MSG_task_listen_from(const char* alias)
700 /* looks inside the rdv directly. Not clean. */
701 simgrid::kernel::activity::CommImplPtr comm = simgrid::s4u::Mailbox::by_name(alias)->front();
703 if (comm && comm->src_actor_)
704 return comm->src_actor_->get_pid();
709 /** @brief Destroys the given task.
711 * You should free user data, if any, @b before calling this destructor.
713 * Only the process that owns the task can destroy it.
714 * The owner changes after a successful send.
715 * If a task is successfully sent, the receiver becomes the owner and is supposed to destroy it. The sender should not
717 * If the task failed to be sent, the sender remains the owner of the task.
719 msg_error_t MSG_task_destroy(msg_task_t task)
721 if (task->is_used()) {
722 /* the task is being sent or executed: cancel it first */
726 /* free main structures */
732 /** @brief Cancel the given task
734 * If it was currently executed or transfered, the working process is stopped.
736 msg_error_t MSG_task_cancel(msg_task_t task)
738 xbt_assert((task != nullptr), "Cannot cancel a nullptr task");
743 /** @brief Returns a value in ]0,1[ that represent the task remaining work
744 * to do: starts at 1 and goes to 0. Returns 0 if not started or finished.
746 * It works for either parallel or sequential tasks.
748 double MSG_task_get_remaining_work_ratio(msg_task_t task) {
750 xbt_assert((task != nullptr), "Cannot get information from a nullptr task");
753 return task->compute->get_remaining_ratio();
755 // Task not started (flops_amount is > 0.0) or finished (flops_amount is set to 0.0)
756 return task->flops_amount > 0.0 ? 1.0 : 0.0;
760 /** @brief Returns the amount of flops that remain to be computed
762 * The returned value is initially the cost that you defined for the task, then it decreases until it reaches 0
764 * It works for sequential tasks, but the remaining amount of work is not a scalar value for parallel tasks.
765 * So you will get an exception if you call this function on parallel tasks. Just don't do it.
767 double MSG_task_get_flops_amount(msg_task_t task) {
768 if (task->compute != nullptr) {
769 return task->compute->get_remaining();
771 // Not started or already done.
772 // - Before starting, flops_amount is initially the task cost
773 // - After execution, flops_amount is set to 0 (until someone uses MSG_task_set_flops_amount, if any)
774 return task->flops_amount;
778 /** @brief set the computation amount needed to process the given task.
780 * @warning If the computation is ongoing (already started and not finished),
781 * it is not modified by this call. Moreover, after its completion, the ongoing execution with set the flops_amount to
782 * zero, overriding any value set during the execution.
784 void MSG_task_set_flops_amount(msg_task_t task, double flops_amount)
786 task->flops_amount = flops_amount;
789 /** @brief set the amount data attached with the given task.
791 * @warning If the transfer is ongoing (already started and not finished), it is not modified by this call.
793 void MSG_task_set_bytes_amount(msg_task_t task, double data_size)
795 task->bytes_amount = data_size;
798 /** @brief Returns the total amount received by the given task
800 * If the communication does not exist it will return 0.
801 * So, if the communication has FINISHED or FAILED it returns zero.
803 double MSG_task_get_remaining_communication(msg_task_t task)
805 XBT_DEBUG("calling simcall_communication_get_remains(%p)", task->comm.get());
806 return task->comm->get_remaining();
809 /** @brief Returns the size of the data attached to the given task. */
810 double MSG_task_get_bytes_amount(msg_task_t task)
812 xbt_assert(task != nullptr, "Invalid parameter");
813 return task->bytes_amount;
816 /** @brief Changes the priority of a computation task.
818 * This priority doesn't affect the transfer rate. A priority of 2
819 * will make a task receive two times more cpu power than regular tasks.
821 void MSG_task_set_priority(msg_task_t task, double priority)
823 task->set_priority(priority);
826 /** @brief Changes the maximum CPU utilization of a computation task (in flops/s).
828 * For VMs, there is a pitfall. Please see MSG_vm_set_bound().
830 void MSG_task_set_bound(msg_task_t task, double bound)
832 if (bound < 1e-12) /* close enough to 0 without any floating precision surprise */
833 XBT_INFO("bound == 0 means no capping (i.e., unlimited).");
834 task->set_bound(bound);
838 * @brief Sets the tracing category of a task.
840 * This function should be called after the creation of a MSG task, to define the category of that task. The
841 * first parameter task must contain a task that was =created with the function #MSG_task_create. The second
842 * parameter category must contain a category that was previously declared with the function #TRACE_category
843 * (or with #TRACE_category_with_color).
845 * See @ref outcomes_vizu for details on how to trace the (categorized) resource utilization.
847 * @param task the task that is going to be categorized
848 * @param category the name of the category to be associated to the task
850 * @see MSG_task_get_category, TRACE_category, TRACE_category_with_color
852 void MSG_task_set_category(msg_task_t task, const char* category)
854 xbt_assert(not task->has_tracing_category(), "Task %p(%s) already has a category (%s).", task, task->get_cname(),
855 task->get_tracing_category().c_str());
857 // if user provides a nullptr category, task is no longer traced
858 if (category == nullptr) {
859 task->set_tracing_category("");
860 XBT_DEBUG("MSG task %p(%s), category removed", task, task->get_cname());
863 task->set_tracing_category(category);
864 XBT_DEBUG("MSG task %p(%s), category %s", task, task->get_cname(), task->get_tracing_category().c_str());
869 * @brief Gets the current tracing category of a task. (@see MSG_task_set_category)
870 * @param task the task to be considered
871 * @return Returns the name of the tracing category of the given task, "" otherwise
873 const char* MSG_task_get_category(msg_task_t task)
875 return task->get_tracing_category().c_str();