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 "simgrid/Exception.hpp"
9 #include "simgrid/s4u/Comm.hpp"
10 #include "simgrid/s4u/Mailbox.hpp"
11 #include "src/instr/instr_private.hpp"
12 #include "src/kernel/activity/ExecImpl.hpp"
13 #include "src/msg/msg_private.hpp"
14 #include "src/simix/smx_private.hpp" /* MSG_task_listen looks inside the rdv directly. Not clean. */
16 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(msg_gos, msg, "Logging specific to MSG (gos)");
19 * @brief Executes a task and waits for its termination.
21 * This function is used for describing the behavior of a process. It takes only one parameter.
22 * @param task a #msg_task_t to execute on the location on which the process is running.
23 * @return #MSG_OK if the task was successfully completed, #MSG_TASK_CANCELED or #MSG_HOST_FAILURE otherwise
25 msg_error_t MSG_task_execute(msg_task_t task)
27 return MSG_parallel_task_execute(task);
31 * @brief Executes a parallel task and waits for its termination.
33 * @param task a #msg_task_t to execute on the location on which the process is running.
35 * @return #MSG_OK if the task was successfully completed, #MSG_TASK_CANCELED
36 * or #MSG_HOST_FAILURE otherwise
38 msg_error_t MSG_parallel_task_execute(msg_task_t task)
40 return MSG_parallel_task_execute_with_timeout(task, -1);
43 msg_error_t MSG_parallel_task_execute_with_timeout(msg_task_t task, double timeout)
45 simdata_task_t simdata = task->simdata;
46 e_smx_state_t comp_state;
47 msg_error_t status = MSG_OK;
49 xbt_assert((not simdata->compute) && not task->simdata->is_used,
50 "This task is executed somewhere else. Go fix your code!");
52 XBT_DEBUG("Computing on %s", MSG_process_get_name(MSG_process_self()));
54 if (simdata->flops_amount <= 0.0 && not simdata->host_nb) {
58 if (TRACE_actor_is_enabled())
59 simgrid::instr::Container::by_name(instr_pid(MSG_process_self()))->get_state("ACTOR_STATE")->push_event("execute");
64 if (simdata->host_nb > 0) {
66 boost::static_pointer_cast<simgrid::kernel::activity::ExecImpl>(simcall_execution_parallel_start(
67 std::move(task->simdata->get_name()), simdata->host_nb, simdata->host_list,
68 simdata->flops_parallel_amount, simdata->bytes_parallel_amount, -1.0, timeout));
69 XBT_DEBUG("Parallel execution action created: %p", simdata->compute.get());
70 if (task->category != nullptr)
71 simgrid::simix::simcall([task] { task->simdata->compute->set_category(task->category); });
73 sg_host_t host = MSG_process_get_host(MSG_process_self());
74 simdata->compute = simgrid::simix::simcall([task, host] {
75 return simgrid::kernel::activity::ExecImplPtr(
76 new simgrid::kernel::activity::ExecImpl(std::move(task->simdata->get_name()), task->category ?: "", host));
78 /* checking for infinite values */
79 xbt_assert(std::isfinite(simdata->flops_amount), "flops_amount is not finite!");
80 xbt_assert(std::isfinite(simdata->priority), "priority is not finite!");
82 simdata->compute->start(simdata->flops_amount, simdata->priority, simdata->bound);
85 comp_state = simcall_execution_wait(simdata->compute);
87 simdata->set_not_used();
89 XBT_DEBUG("Execution task '%s' finished in state %d", task->simdata->get_cname(), (int)comp_state);
90 } catch (simgrid::HostFailureException& e) {
91 status = MSG_HOST_FAILURE;
92 } catch (simgrid::TimeoutError& e) {
94 } catch (simgrid::CancelException& e) {
95 status = MSG_TASK_CANCELED;
98 /* action ended, set comm and compute = nullptr, the actions is already destroyed in the main function */
99 simdata->flops_amount = 0.0;
100 simdata->comm = nullptr;
101 simdata->compute = nullptr;
103 if (TRACE_actor_is_enabled())
104 simgrid::instr::Container::by_name(instr_pid(MSG_process_self()))->get_state("ACTOR_STATE")->pop_event();
110 * @brief Receives a task from a mailbox.
112 * This is a blocking function, the execution flow will be blocked until the task is received. See #MSG_task_irecv
113 * for receiving tasks asynchronously.
115 * @param task a memory location for storing a #msg_task_t.
116 * @param alias name of the mailbox to receive the task from
119 * #MSG_OK if the task was successfully received,
120 * #MSG_HOST_FAILURE, or #MSG_TRANSFER_FAILURE otherwise.
122 msg_error_t MSG_task_receive(msg_task_t * task, const char *alias)
124 return MSG_task_receive_with_timeout(task, alias, -1);
128 * @brief Receives a task from a mailbox at a given rate.
130 * @param task a memory location for storing a #msg_task_t.
131 * @param alias name of the mailbox to receive the task from
132 * @param rate limit the reception to rate bandwidth (byte/sec)
134 * The rate parameter can be used to receive a task with a limited
135 * bandwidth (smaller than the physical available value). Use
136 * MSG_task_receive() if you don't limit the rate (or pass -1 as a
137 * rate value do disable this feature).
140 * #MSG_OK if the task was successfully received,
141 * #MSG_HOST_FAILURE, or #MSG_TRANSFER_FAILURE otherwise.
143 msg_error_t MSG_task_receive_bounded(msg_task_t * task, const char *alias, double rate)
145 return MSG_task_receive_with_timeout_bounded(task, alias, -1, rate);
149 * @brief Receives a task from a mailbox with a given timeout.
151 * This is a blocking function with a timeout, the execution flow will be blocked until the task is received or the
152 * timeout is achieved. See #MSG_task_irecv for receiving tasks asynchronously. You can provide a -1 timeout
153 * to obtain an infinite timeout.
155 * @param task a memory location for storing a #msg_task_t.
156 * @param alias name of the mailbox to receive the task from
157 * @param timeout is the maximum wait time for completion (if -1, this call is the same as #MSG_task_receive)
160 * #MSG_OK if the task was successfully received,
161 * #MSG_HOST_FAILURE, or #MSG_TRANSFER_FAILURE, or #MSG_TIMEOUT otherwise.
163 msg_error_t MSG_task_receive_with_timeout(msg_task_t * task, const char *alias, double timeout)
165 return MSG_task_receive_ext(task, alias, timeout, nullptr);
169 * @brief Receives a task from a mailbox with a given timeout and at a given rate.
171 * @param task a memory location for storing a #msg_task_t.
172 * @param alias name of the mailbox to receive the task from
173 * @param timeout is the maximum wait time for completion (if -1, this call is the same as #MSG_task_receive)
174 * @param rate limit the reception to rate bandwidth (byte/sec)
176 * The rate parameter can be used to send a task with a limited
177 * bandwidth (smaller than the physical available value). Use
178 * MSG_task_receive() if you don't limit the rate (or pass -1 as a
179 * rate value do disable this feature).
182 * #MSG_OK if the task was successfully received,
183 * #MSG_HOST_FAILURE, or #MSG_TRANSFER_FAILURE, or #MSG_TIMEOUT otherwise.
185 msg_error_t MSG_task_receive_with_timeout_bounded(msg_task_t * task, const char *alias, double timeout,double rate)
187 return MSG_task_receive_ext_bounded(task, alias, timeout, nullptr, rate);
191 * @brief Receives a task from a mailbox from a specific host with a given timeout.
193 * This is a blocking function with a timeout, the execution flow will be blocked until the task is received or the
194 * timeout is achieved. See #MSG_task_irecv for receiving tasks asynchronously. You can provide a -1 timeout
195 * to obtain an infinite timeout.
197 * @param task a memory location for storing a #msg_task_t.
198 * @param alias name of the mailbox to receive the task from
199 * @param timeout is the maximum wait time for completion (provide -1 for no timeout)
200 * @param host a #msg_host_t host from where the task was sent
203 * #MSG_OK if the task was successfully received,
204 * #MSG_HOST_FAILURE, or #MSG_TRANSFER_FAILURE, or #MSG_TIMEOUT otherwise.
206 msg_error_t MSG_task_receive_ext(msg_task_t * task, const char *alias, double timeout, msg_host_t host)
208 XBT_DEBUG("MSG_task_receive_ext: Trying to receive a message on mailbox '%s'", alias);
209 return MSG_task_receive_ext_bounded(task, alias, timeout, host, -1.0);
213 * @brief Receives a task from a mailbox from a specific host with a given timeout and at a given rate.
215 * @param task a memory location for storing a #msg_task_t.
216 * @param alias name of the mailbox to receive the task from
217 * @param timeout is the maximum wait time for completion (provide -1 for no timeout)
218 * @param host a #msg_host_t host from where the task was sent
219 * @param rate limit the reception to rate bandwidth (byte/sec)
221 * The rate parameter can be used to receive a task with a limited
222 * bandwidth (smaller than the physical available value). Use
223 * MSG_task_receive_ext() if you don't limit the rate (or pass -1 as a
224 * rate value do disable this feature).
227 * #MSG_OK if the task was successfully received,
228 * #MSG_HOST_FAILURE, or #MSG_TRANSFER_FAILURE, or #MSG_TIMEOUT otherwise.
230 msg_error_t MSG_task_receive_ext_bounded(msg_task_t * task, const char *alias, double timeout, msg_host_t host,
233 XBT_DEBUG("MSG_task_receive_ext: Trying to receive a message on mailbox '%s'", alias);
234 msg_error_t ret = MSG_OK;
235 /* We no longer support getting a task from a specific host */
240 xbt_assert(task, "Null pointer for the task storage");
243 XBT_WARN("Asked to write the received task in a non empty struct -- proceeding.");
245 /* Try to receive it by calling SIMIX network layer */
248 simgrid::s4u::Mailbox::by_name(alias)
250 ->set_dst_data(&payload, sizeof(msg_task_t*))
253 *task = static_cast<msg_task_t>(payload);
254 XBT_DEBUG("Got task %s from %s", (*task)->simdata->get_cname(), alias);
255 (*task)->simdata->set_not_used();
256 } catch (simgrid::HostFailureException& e) {
257 ret = MSG_HOST_FAILURE;
258 } catch (simgrid::TimeoutError& e) {
260 } catch (simgrid::CancelException& e) {
261 ret = MSG_TASK_CANCELED;
262 } catch (xbt_ex& e) {
263 if (e.category == network_error)
264 ret = MSG_TRANSFER_FAILURE;
269 if (TRACE_actor_is_enabled() && ret != MSG_HOST_FAILURE && ret != MSG_TRANSFER_FAILURE && ret != MSG_TIMEOUT) {
270 container_t process_container = simgrid::instr::Container::by_name(instr_pid(MSG_process_self()));
272 std::string key = std::string("p") + std::to_string((*task)->counter);
273 simgrid::instr::Container::get_root()->get_link("ACTOR_TASK_LINK")->end_event(process_container, "SR", key);
278 /* Internal function used to factorize code between MSG_task_isend(), MSG_task_isend_bounded(), and MSG_task_dsend(). */
279 static inline msg_comm_t MSG_task_isend_internal(msg_task_t task, const char* alias, void_f_pvoid_t cleanup,
282 simdata_task_t t_simdata = nullptr;
283 msg_process_t myself = MSG_process_self();
284 simgrid::s4u::MailboxPtr mailbox = simgrid::s4u::Mailbox::by_name(alias);
285 TRACE_msg_task_put_start(task);
287 /* Prepare the task to send */
288 t_simdata = task->simdata;
289 t_simdata->sender = myself;
290 t_simdata->set_used();
291 t_simdata->comm = nullptr;
292 msg_global->sent_msg++;
294 simgrid::s4u::CommPtr comm = mailbox->put_init(task, t_simdata->bytes_amount)->set_rate(t_simdata->rate);
295 t_simdata->comm = comm;
297 comm->detach(cleanup);
301 msg_comm_t msg_comm = nullptr;
303 msg_comm = new simgrid::msg::Comm(task, nullptr, comm);
306 if (TRACE_is_enabled() && task->category != nullptr)
307 simgrid::simix::simcall([comm, task] { comm->get_impl()->set_category(task->category); });
313 * @brief Sends a task on a mailbox.
315 * This is a non blocking function: use MSG_comm_wait() or MSG_comm_test() to end the communication.
317 * @param task a #msg_task_t to send on another location.
318 * @param alias name of the mailbox to sent the task to
319 * @return the msg_comm_t communication created
321 msg_comm_t MSG_task_isend(msg_task_t task, const char *alias)
323 return MSG_task_isend_internal(task, alias, nullptr, false);
327 * @brief Sends a task on a mailbox with a maximum rate
329 * This is a non blocking function: use MSG_comm_wait() or MSG_comm_test() to end the communication. The maxrate
330 * parameter allows the application to limit the bandwidth utilization of network links when sending the task.
332 * @param task a #msg_task_t to send on another location.
333 * @param alias name of the mailbox to sent the task to
334 * @param maxrate the maximum communication rate for sending this task (byte/sec).
335 * @return the msg_comm_t communication created
337 msg_comm_t MSG_task_isend_bounded(msg_task_t task, const char *alias, double maxrate)
339 task->simdata->rate = maxrate;
340 return MSG_task_isend_internal(task, alias, nullptr, false);
344 * @brief Sends a task on a mailbox.
346 * This is a non blocking detached send function.
347 * Think of it as a best effort send. Keep in mind that the third parameter is only called if the communication fails.
348 * If the communication does work, it is responsibility of the receiver code to free anything related to the task, as
349 * usual. More details on this can be obtained on
350 * <a href="http://lists.gforge.inria.fr/pipermail/simgrid-user/2011-November/002649.html">this thread</a>
351 * in the SimGrid-user mailing list archive.
353 * @param task a #msg_task_t to send on another location.
354 * @param alias name of the mailbox to sent the task to
355 * @param cleanup a function to destroy the task if the communication fails, e.g. MSG_task_destroy
356 * (if nullptr, no function will be called)
358 void MSG_task_dsend(msg_task_t task, const char *alias, void_f_pvoid_t cleanup)
360 msg_comm_t XBT_ATTRIB_UNUSED comm = MSG_task_isend_internal(task, alias, cleanup, true);
361 xbt_assert(comm == nullptr);
365 * @brief Sends a task on a mailbox with a maximal rate.
367 * This is a non blocking detached send function.
368 * Think of it as a best effort send. Keep in mind that the third parameter is only called if the communication fails.
369 * If the communication does work, it is responsibility of the receiver code to free anything related to the task, as
370 * usual. More details on this can be obtained on
371 * <a href="http://lists.gforge.inria.fr/pipermail/simgrid-user/2011-November/002649.html">this thread</a>
372 * in the SimGrid-user mailing list archive.
374 * The rate parameter can be used to send a task with a limited
375 * bandwidth (smaller than the physical available value). Use
376 * MSG_task_dsend() if you don't limit the rate (or pass -1 as a rate
377 * value do disable this feature).
379 * @param task a #msg_task_t to send on another location.
380 * @param alias name of the mailbox to sent the task to
381 * @param cleanup a function to destroy the task if the
382 * communication fails, e.g. MSG_task_destroy
383 * (if nullptr, no function will be called)
384 * @param maxrate the maximum communication rate for sending this task (byte/sec)
387 void MSG_task_dsend_bounded(msg_task_t task, const char *alias, void_f_pvoid_t cleanup, double maxrate)
389 task->simdata->rate = maxrate;
390 MSG_task_dsend(task, alias, cleanup);
394 * @brief Starts listening for receiving a task from an asynchronous communication.
396 * This is a non blocking function: use MSG_comm_wait() or MSG_comm_test() to end the communication.
398 * @param task a memory location for storing a #msg_task_t. has to be valid until the end of the communication.
399 * @param name of the mailbox to receive the task on
400 * @return the msg_comm_t communication created
402 msg_comm_t MSG_task_irecv(msg_task_t *task, const char *name)
404 return MSG_task_irecv_bounded(task, name, -1.0);
408 * @brief Starts listening for receiving a task from an asynchronous communication at a given rate.
410 * The rate parameter can be used to receive a task with a limited
411 * bandwidth (smaller than the physical available value). Use
412 * MSG_task_irecv() if you don't limit the rate (or pass -1 as a rate
413 * value do disable this feature).
415 * @param task a memory location for storing a #msg_task_t. has to be valid until the end of the communication.
416 * @param name of the mailbox to receive the task on
417 * @param rate limit the bandwidth to the given rate (byte/sec)
418 * @return the msg_comm_t communication created
420 msg_comm_t MSG_task_irecv_bounded(msg_task_t *task, const char *name, double rate)
422 simgrid::s4u::MailboxPtr mbox = simgrid::s4u::Mailbox::by_name(name);
424 /* FIXME: these functions are not traceable */
426 xbt_assert(task, "Null pointer for the task storage");
429 XBT_CRITICAL("MSG_task_irecv() was asked to write in a non empty task struct.");
431 /* Try to receive it by calling SIMIX network layer */
432 msg_comm_t comm = new simgrid::msg::Comm(
433 nullptr, task, mbox->get_init()->set_dst_data((void**)task, sizeof(msg_task_t*))->set_rate(rate)->start());
439 * @brief Checks whether a communication is done, and if yes, finalizes it.
440 * @param comm the communication to test
441 * @return 'true' if the communication is finished
442 * (but it may have failed, use MSG_comm_get_status() to know its status)
443 * or 'false' if the communication is not finished yet
444 * If the status is 'false', don't forget to use MSG_process_sleep() after the test.
446 int MSG_comm_test(msg_comm_t comm)
448 bool finished = false;
451 finished = comm->s_comm->test();
452 if (finished && comm->task_received != nullptr) {
453 /* I am the receiver */
454 (*comm->task_received)->simdata->set_not_used();
456 } catch (simgrid::TimeoutError& e) {
457 comm->status = MSG_TIMEOUT;
459 } catch (simgrid::CancelException& e) {
460 comm->status = MSG_TASK_CANCELED;
464 if (e.category == network_error) {
465 comm->status = MSG_TRANSFER_FAILURE;
476 * @brief This function checks if a communication is finished.
477 * @param comms a vector of communications
478 * @return the position of the finished communication if any
479 * (but it may have failed, use MSG_comm_get_status() to know its status),
480 * or -1 if none is finished
482 int MSG_comm_testany(xbt_dynar_t comms)
484 int finished_index = -1;
486 /* Create the equivalent array with SIMIX objects: */
487 std::vector<simgrid::kernel::activity::CommImpl*> s_comms;
488 s_comms.reserve(xbt_dynar_length(comms));
491 xbt_dynar_foreach(comms, cursor, comm) {
492 s_comms.push_back(static_cast<simgrid::kernel::activity::CommImpl*>(comm->s_comm->get_impl().get()));
495 msg_error_t status = MSG_OK;
497 finished_index = simcall_comm_testany(s_comms.data(), s_comms.size());
498 } catch (simgrid::TimeoutError& e) {
499 finished_index = e.value;
500 status = MSG_TIMEOUT;
501 } catch (simgrid::CancelException& e) {
502 finished_index = e.value;
503 status = MSG_TASK_CANCELED;
506 if (e.category != network_error)
508 finished_index = e.value;
509 status = MSG_TRANSFER_FAILURE;
512 if (finished_index != -1) {
513 comm = xbt_dynar_get_as(comms, finished_index, msg_comm_t);
514 /* the communication is finished */
515 comm->status = status;
517 if (status == MSG_OK && comm->task_received != nullptr) {
518 /* I am the receiver */
519 (*comm->task_received)->simdata->set_not_used();
523 return finished_index;
526 /** @brief Destroys the provided communication. */
527 void MSG_comm_destroy(msg_comm_t comm)
532 /** @brief Wait for the completion of a communication.
534 * It takes two parameters.
535 * @param comm the communication to wait.
536 * @param timeout Wait until the communication terminates or the timeout occurs.
537 * You can provide a -1 timeout to obtain an infinite timeout.
538 * @return msg_error_t
540 msg_error_t MSG_comm_wait(msg_comm_t comm, double timeout)
543 comm->s_comm->wait_for(timeout);
545 if (comm->task_received != nullptr) {
546 /* I am the receiver */
547 (*comm->task_received)->simdata->set_not_used();
550 /* FIXME: these functions are not traceable */
551 } catch (simgrid::TimeoutError& e) {
552 comm->status = MSG_TIMEOUT;
553 } catch (simgrid::CancelException& e) {
554 comm->status = MSG_TASK_CANCELED;
557 if (e.category == network_error)
558 comm->status = MSG_TRANSFER_FAILURE;
566 /** @brief This function is called by a sender and permit to wait for each communication
568 * @param comm a vector of communication
569 * @param nb_elem is the size of the comm vector
570 * @param timeout for each call of MSG_comm_wait
572 void MSG_comm_waitall(msg_comm_t * comm, int nb_elem, double timeout)
574 for (int i = 0; i < nb_elem; i++)
575 MSG_comm_wait(comm[i], timeout);
578 /** @brief This function waits for the first communication finished in a list.
579 * @param comms a vector of communications
580 * @return the position of the first finished communication
581 * (but it may have failed, use MSG_comm_get_status() to know its status)
583 int MSG_comm_waitany(xbt_dynar_t comms)
585 int finished_index = -1;
587 /* Create the equivalent array with SIMIX objects: */
588 std::vector<simgrid::kernel::activity::CommImpl*> s_comms;
589 s_comms.reserve(xbt_dynar_length(comms));
592 xbt_dynar_foreach(comms, cursor, comm) {
593 s_comms.push_back(static_cast<simgrid::kernel::activity::CommImpl*>(comm->s_comm->get_impl().get()));
596 msg_error_t status = MSG_OK;
598 finished_index = simcall_comm_waitany(s_comms.data(), s_comms.size(), -1);
599 } catch (simgrid::TimeoutError& e) {
600 finished_index = e.value;
601 status = MSG_TIMEOUT;
602 } catch (simgrid::CancelException& e) {
603 finished_index = e.value;
604 status = MSG_TASK_CANCELED;
607 if (e.category == network_error) {
608 finished_index = e.value;
609 status = MSG_TRANSFER_FAILURE;
615 xbt_assert(finished_index != -1, "WaitAny returned -1");
617 comm = xbt_dynar_get_as(comms, finished_index, msg_comm_t);
618 /* the communication is finished */
619 comm->status = status;
621 if (comm->task_received != nullptr) {
622 /* I am the receiver */
623 (*comm->task_received)->simdata->set_not_used();
626 return finished_index;
630 * @brief Returns the error (if any) that occurred during a finished communication.
631 * @param comm a finished communication
632 * @return the status of the communication, or #MSG_OK if no error occurred
633 * during the communication
635 msg_error_t MSG_comm_get_status(msg_comm_t comm) {
640 /** @brief Get a task (#msg_task_t) from a communication
642 * @param comm the communication where to get the task
643 * @return the task from the communication
645 msg_task_t MSG_comm_get_task(msg_comm_t comm)
647 xbt_assert(comm, "Invalid parameter");
649 return comm->task_received ? *comm->task_received : comm->task_sent;
653 * @brief This function is called by SIMIX in kernel mode to copy the data of a comm.
654 * @param comm the comm
655 * @param buff the data copied
656 * @param buff_size size of the buffer
658 void MSG_comm_copy_data_from_SIMIX(simgrid::kernel::activity::CommImpl* comm, void* buff, size_t buff_size)
660 SIMIX_comm_copy_pointer_callback(comm, buff, buff_size);
662 // notify the user callback if any
663 if (msg_global->task_copy_callback) {
664 msg_task_t task = static_cast<msg_task_t>(buff);
665 msg_global->task_copy_callback(task, comm->src_actor_->ciface(), comm->dst_actor_->ciface());
670 * @brief Sends a task to a mailbox
672 * This is a blocking function, the execution flow will be blocked until the task is sent (and received on the other
673 * side if #MSG_task_receive is used).
674 * See #MSG_task_isend for sending tasks asynchronously.
676 * @param task the task to be sent
677 * @param alias the mailbox name to where the task is sent
679 * @return Returns #MSG_OK if the task was successfully sent,
680 * #MSG_HOST_FAILURE, or #MSG_TRANSFER_FAILURE otherwise.
682 msg_error_t MSG_task_send(msg_task_t task, const char *alias)
684 XBT_DEBUG("MSG_task_send: Trying to send a message on mailbox '%s'", alias);
685 return MSG_task_send_with_timeout(task, alias, -1);
689 * @brief Sends a task to a mailbox with a maximum rate
691 * This is a blocking function, the execution flow will be blocked until the task is sent. The maxrate parameter allows
692 * the application to limit the bandwidth utilization of network links when sending the task.
694 * The maxrate parameter can be used to send a task with a limited
695 * bandwidth (smaller than the physical available value). Use
696 * MSG_task_send() if you don't limit the rate (or pass -1 as a rate
697 * value do disable this feature).
699 * @param task the task to be sent
700 * @param alias the mailbox name to where the task is sent
701 * @param maxrate the maximum communication rate for sending this task (byte/sec)
703 * @return Returns #MSG_OK if the task was successfully sent,
704 * #MSG_HOST_FAILURE, or #MSG_TRANSFER_FAILURE otherwise.
706 msg_error_t MSG_task_send_bounded(msg_task_t task, const char *alias, double maxrate)
708 task->simdata->rate = maxrate;
709 return MSG_task_send(task, alias);
713 * @brief Sends a task to a mailbox with a timeout
715 * This is a blocking function, the execution flow will be blocked until the task is sent or the timeout is achieved.
717 * @param task the task to be sent
718 * @param alias the mailbox name to where the task is sent
719 * @param timeout is the maximum wait time for completion (if -1, this call is the same as #MSG_task_send)
721 * @return Returns #MSG_OK if the task was successfully sent,
722 * #MSG_HOST_FAILURE, or #MSG_TRANSFER_FAILURE, or #MSG_TIMEOUT otherwise.
724 msg_error_t MSG_task_send_with_timeout(msg_task_t task, const char *alias, double timeout)
726 msg_error_t ret = MSG_OK;
728 TRACE_msg_task_put_start(task);
730 /* Prepare the task to send */
731 simdata_task_t t_simdata = task->simdata;
732 t_simdata->sender = MSG_process_self();
733 t_simdata->set_used();
735 msg_global->sent_msg++;
739 simgrid::s4u::CommPtr comm =
740 simgrid::s4u::Mailbox::by_name(alias)->put_init(task, t_simdata->bytes_amount)->set_rate(t_simdata->rate);
741 t_simdata->comm = comm;
743 if (TRACE_is_enabled() && task->category != nullptr)
744 simgrid::simix::simcall([comm, task] { comm->get_impl()->set_category(task->category); });
745 comm->wait_for(timeout);
746 } catch (simgrid::TimeoutError& e) {
748 } catch (simgrid::CancelException& e) {
749 ret = MSG_HOST_FAILURE;
750 } catch (xbt_ex& e) {
751 if (e.category == network_error)
752 ret = MSG_TRANSFER_FAILURE;
756 /* If the send failed, it is not used anymore */
757 t_simdata->set_not_used();
764 * @brief Sends a task to a mailbox with a timeout and with a maximum rate
766 * This is a blocking function, the execution flow will be blocked until the task is sent or the timeout is achieved.
768 * The maxrate parameter can be used to send a task with a limited
769 * bandwidth (smaller than the physical available value). Use
770 * MSG_task_send_with_timeout() if you don't limit the rate (or pass -1 as a rate
771 * value do disable this feature).
773 * @param task the task to be sent
774 * @param alias the mailbox name to where the task is sent
775 * @param timeout is the maximum wait time for completion (if -1, this call is the same as #MSG_task_send)
776 * @param maxrate the maximum communication rate for sending this task (byte/sec)
778 * @return Returns #MSG_OK if the task was successfully sent,
779 * #MSG_HOST_FAILURE, or #MSG_TRANSFER_FAILURE, or #MSG_TIMEOUT otherwise.
781 msg_error_t MSG_task_send_with_timeout_bounded(msg_task_t task, const char *alias, double timeout, double maxrate)
783 task->simdata->rate = maxrate;
784 return MSG_task_send_with_timeout(task, alias, timeout);
788 * @brief Look if there is a communication on a mailbox and return the PID of the sender process.
790 * @param alias the name of the mailbox to be considered
792 * @return Returns the PID of sender process,
793 * -1 if there is no communication in the mailbox.
795 int MSG_task_listen_from(const char *alias)
797 simgrid::kernel::activity::CommImplPtr comm = simgrid::s4u::Mailbox::by_name(alias)->front();
799 return comm ? MSG_process_get_PID(static_cast<msg_task_t>(comm->src_buff_)->simdata->sender) : -1;
803 * @brief Sets the tracing category of a task.
805 * This function should be called after the creation of a MSG task, to define the category of that task. The
806 * first parameter task must contain a task that was created with the function #MSG_task_create. The second
807 * parameter category must contain a category that was previously declared with the function #TRACE_category
808 * (or with #TRACE_category_with_color).
810 * See @ref outcomes_vizu for details on how to trace the (categorized) resource utilization.
812 * @param task the task that is going to be categorized
813 * @param category the name of the category to be associated to the task
815 * @see MSG_task_get_category, TRACE_category, TRACE_category_with_color
817 void MSG_task_set_category (msg_task_t task, const char *category)
819 xbt_assert(task->category == nullptr, "Task %p(%s) already has a category (%s).", task, task->simdata->get_cname(),
822 // if user provides a nullptr category, task is no longer traced
823 if (category == nullptr) {
824 xbt_free(task->category);
825 task->category = nullptr;
826 XBT_DEBUG("MSG task %p(%s), category removed", task, task->simdata->get_cname());
829 task->category = xbt_strdup(category);
830 XBT_DEBUG("MSG task %p(%s), category %s", task, task->simdata->get_cname(), task->category);
835 * @brief Gets the current tracing category of a task.
837 * @param task the task to be considered
839 * @see MSG_task_set_category
841 * @return Returns the name of the tracing category of the given task, nullptr otherwise
843 const char *MSG_task_get_category (msg_task_t task)
845 return task->category;