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;
50 xbt_assert((not simdata->compute) && not task->simdata->isused,
51 "This task is executed somewhere else. Go fix your code!");
53 XBT_DEBUG("Computing on %s", MSG_process_get_name(MSG_process_self()));
55 if (simdata->flops_amount <= 0.0 && not simdata->host_nb) {
59 if (TRACE_actor_is_enabled())
60 simgrid::instr::Container::by_name(instr_pid(MSG_process_self()))->get_state("ACTOR_STATE")->push_event("execute");
65 if (simdata->host_nb > 0) {
67 boost::static_pointer_cast<simgrid::kernel::activity::ExecImpl>(simcall_execution_parallel_start(
68 task->name ?: "", simdata->host_nb, simdata->host_list, simdata->flops_parallel_amount,
69 simdata->bytes_parallel_amount, -1.0, timeout));
70 XBT_DEBUG("Parallel execution action created: %p", simdata->compute.get());
71 if (task->category != nullptr)
72 simgrid::simix::simcall([task] { task->simdata->compute->set_category(task->category); });
74 sg_host_t host = MSG_process_get_host(MSG_process_self());
75 simdata->compute = simgrid::simix::simcall([task, host] {
76 return simgrid::kernel::activity::ExecImplPtr(
77 new simgrid::kernel::activity::ExecImpl(task->name ?: "", task->category ?: "",
78 /*timeout_detector*/ nullptr, host));
80 /* checking for infinite values */
81 xbt_assert(std::isfinite(simdata->flops_amount), "flops_amount is not finite!");
82 xbt_assert(std::isfinite(simdata->priority), "priority is not finite!");
84 simdata->compute->start(simdata->flops_amount, simdata->priority, simdata->bound);
87 comp_state = simcall_execution_wait(simdata->compute);
89 simdata->setNotUsed();
91 XBT_DEBUG("Execution task '%s' finished in state %d", task->name, (int)comp_state);
92 } catch (simgrid::HostFailureException& e) {
93 status = MSG_HOST_FAILURE;
94 } catch (simgrid::TimeoutError& e) {
96 } catch (simgrid::CancelException& e) {
97 status = MSG_TASK_CANCELED;
100 /* action ended, set comm and compute = nullptr, the actions is already destroyed in the main function */
101 simdata->flops_amount = 0.0;
102 simdata->comm = nullptr;
103 simdata->compute = nullptr;
105 if (TRACE_actor_is_enabled())
106 simgrid::instr::Container::by_name(instr_pid(MSG_process_self()))->get_state("ACTOR_STATE")->pop_event();
112 * @brief Receives a task from a mailbox.
114 * This is a blocking function, the execution flow will be blocked until the task is received. See #MSG_task_irecv
115 * for receiving tasks asynchronously.
117 * @param task a memory location for storing a #msg_task_t.
118 * @param alias name of the mailbox to receive the task from
121 * #MSG_OK if the task was successfully received,
122 * #MSG_HOST_FAILURE, or #MSG_TRANSFER_FAILURE otherwise.
124 msg_error_t MSG_task_receive(msg_task_t * task, const char *alias)
126 return MSG_task_receive_with_timeout(task, alias, -1);
130 * @brief Receives a task from a mailbox at a given rate.
132 * @param task a memory location for storing a #msg_task_t.
133 * @param alias name of the mailbox to receive the task from
134 * @param rate limit the reception to rate bandwidth (byte/sec)
136 * The rate parameter can be used to receive a task with a limited
137 * bandwidth (smaller than the physical available value). Use
138 * MSG_task_receive() if you don't limit the rate (or pass -1 as a
139 * rate value do disable this feature).
142 * #MSG_OK if the task was successfully received,
143 * #MSG_HOST_FAILURE, or #MSG_TRANSFER_FAILURE otherwise.
145 msg_error_t MSG_task_receive_bounded(msg_task_t * task, const char *alias, double rate)
147 return MSG_task_receive_with_timeout_bounded(task, alias, -1, rate);
151 * @brief Receives a task from a mailbox with a given timeout.
153 * This is a blocking function with a timeout, the execution flow will be blocked until the task is received or the
154 * timeout is achieved. See #MSG_task_irecv for receiving tasks asynchronously. You can provide a -1 timeout
155 * to obtain an infinite timeout.
157 * @param task a memory location for storing a #msg_task_t.
158 * @param alias name of the mailbox to receive the task from
159 * @param timeout is the maximum wait time for completion (if -1, this call is the same as #MSG_task_receive)
162 * #MSG_OK if the task was successfully received,
163 * #MSG_HOST_FAILURE, or #MSG_TRANSFER_FAILURE, or #MSG_TIMEOUT otherwise.
165 msg_error_t MSG_task_receive_with_timeout(msg_task_t * task, const char *alias, double timeout)
167 return MSG_task_receive_ext(task, alias, timeout, nullptr);
171 * @brief Receives a task from a mailbox with a given timeout and at a given rate.
173 * @param task a memory location for storing a #msg_task_t.
174 * @param alias name of the mailbox to receive the task from
175 * @param timeout is the maximum wait time for completion (if -1, this call is the same as #MSG_task_receive)
176 * @param rate limit the reception to rate bandwidth (byte/sec)
178 * The rate parameter can be used to send a task with a limited
179 * bandwidth (smaller than the physical available value). Use
180 * MSG_task_receive() if you don't limit the rate (or pass -1 as a
181 * rate value do disable this feature).
184 * #MSG_OK if the task was successfully received,
185 * #MSG_HOST_FAILURE, or #MSG_TRANSFER_FAILURE, or #MSG_TIMEOUT otherwise.
187 msg_error_t MSG_task_receive_with_timeout_bounded(msg_task_t * task, const char *alias, double timeout,double rate)
189 return MSG_task_receive_ext_bounded(task, alias, timeout, nullptr, rate);
193 * @brief Receives a task from a mailbox from a specific host with a given timeout.
195 * This is a blocking function with a timeout, the execution flow will be blocked until the task is received or the
196 * timeout is achieved. See #MSG_task_irecv for receiving tasks asynchronously. You can provide a -1 timeout
197 * to obtain an infinite timeout.
199 * @param task a memory location for storing a #msg_task_t.
200 * @param alias name of the mailbox to receive the task from
201 * @param timeout is the maximum wait time for completion (provide -1 for no timeout)
202 * @param host a #msg_host_t host from where the task was sent
205 * #MSG_OK if the task was successfully received,
206 * #MSG_HOST_FAILURE, or #MSG_TRANSFER_FAILURE, or #MSG_TIMEOUT otherwise.
208 msg_error_t MSG_task_receive_ext(msg_task_t * task, const char *alias, double timeout, msg_host_t host)
210 XBT_DEBUG("MSG_task_receive_ext: Trying to receive a message on mailbox '%s'", alias);
211 return MSG_task_receive_ext_bounded(task, alias, timeout, host, -1.0);
215 * @brief Receives a task from a mailbox from a specific host with a given timeout and at a given rate.
217 * @param task a memory location for storing a #msg_task_t.
218 * @param alias name of the mailbox to receive the task from
219 * @param timeout is the maximum wait time for completion (provide -1 for no timeout)
220 * @param host a #msg_host_t host from where the task was sent
221 * @param rate limit the reception to rate bandwidth (byte/sec)
223 * The rate parameter can be used to receive a task with a limited
224 * bandwidth (smaller than the physical available value). Use
225 * MSG_task_receive_ext() if you don't limit the rate (or pass -1 as a
226 * rate value do disable this feature).
229 * #MSG_OK if the task was successfully received,
230 * #MSG_HOST_FAILURE, or #MSG_TRANSFER_FAILURE, or #MSG_TIMEOUT otherwise.
232 msg_error_t MSG_task_receive_ext_bounded(msg_task_t * task, const char *alias, double timeout, msg_host_t host,
235 XBT_DEBUG("MSG_task_receive_ext: Trying to receive a message on mailbox '%s'", alias);
236 msg_error_t ret = MSG_OK;
237 /* We no longer support getting a task from a specific host */
242 xbt_assert(task, "Null pointer for the task storage");
245 XBT_WARN("Asked to write the received task in a non empty struct -- proceeding.");
247 /* Try to receive it by calling SIMIX network layer */
250 simgrid::s4u::Mailbox::by_name(alias)
252 ->set_dst_data(&payload, sizeof(msg_task_t*))
255 *task = static_cast<msg_task_t>(payload);
256 XBT_DEBUG("Got task %s from %s", (*task)->name, alias);
257 (*task)->simdata->setNotUsed();
258 } catch (simgrid::HostFailureException& e) {
259 ret = MSG_HOST_FAILURE;
260 } catch (simgrid::TimeoutError& e) {
262 } catch (simgrid::CancelException& e) {
263 ret = MSG_HOST_FAILURE;
264 } catch (xbt_ex& e) {
265 if (e.category == network_error)
266 ret = MSG_TRANSFER_FAILURE;
271 if (ret != MSG_HOST_FAILURE && ret != MSG_TRANSFER_FAILURE && ret != MSG_TIMEOUT) {
272 TRACE_msg_task_get_end(*task);
277 /* Internal function used to factorize code between MSG_task_isend(), MSG_task_isend_bounded(), and MSG_task_dsend(). */
278 static inline msg_comm_t MSG_task_isend_internal(msg_task_t task, const char* alias, void_f_pvoid_t cleanup,
281 simdata_task_t t_simdata = nullptr;
282 msg_process_t myself = MSG_process_self();
283 simgrid::s4u::MailboxPtr mailbox = simgrid::s4u::Mailbox::by_name(alias);
284 TRACE_msg_task_put_start(task);
286 /* Prepare the task to send */
287 t_simdata = task->simdata;
288 t_simdata->sender = myself;
289 t_simdata->source = MSG_host_self();
290 t_simdata->setUsed();
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->setNotUsed();
456 } catch (simgrid::TimeoutError& e) {
457 comm->status = MSG_TIMEOUT;
461 if (e.category == network_error) {
462 comm->status = MSG_TRANSFER_FAILURE;
473 * @brief This function checks if a communication is finished.
474 * @param comms a vector of communications
475 * @return the position of the finished communication if any
476 * (but it may have failed, use MSG_comm_get_status() to know its status),
477 * or -1 if none is finished
479 int MSG_comm_testany(xbt_dynar_t comms)
481 int finished_index = -1;
483 /* Create the equivalent array with SIMIX objects: */
484 std::vector<simgrid::kernel::activity::CommImpl*> s_comms;
485 s_comms.reserve(xbt_dynar_length(comms));
488 xbt_dynar_foreach(comms, cursor, comm) {
489 s_comms.push_back(static_cast<simgrid::kernel::activity::CommImpl*>(comm->s_comm->get_impl().get()));
492 msg_error_t status = MSG_OK;
494 finished_index = simcall_comm_testany(s_comms.data(), s_comms.size());
495 } catch (simgrid::TimeoutError& e) {
496 finished_index = e.value;
497 status = MSG_TIMEOUT;
500 if (e.category != network_error)
502 finished_index = e.value;
503 status = MSG_TRANSFER_FAILURE;
506 if (finished_index != -1) {
507 comm = xbt_dynar_get_as(comms, finished_index, msg_comm_t);
508 /* the communication is finished */
509 comm->status = status;
511 if (status == MSG_OK && comm->task_received != nullptr) {
512 /* I am the receiver */
513 (*comm->task_received)->simdata->setNotUsed();
517 return finished_index;
520 /** @brief Destroys the provided communication. */
521 void MSG_comm_destroy(msg_comm_t comm)
526 /** @brief Wait for the completion of a communication.
528 * It takes two parameters.
529 * @param comm the communication to wait.
530 * @param timeout Wait until the communication terminates or the timeout occurs.
531 * You can provide a -1 timeout to obtain an infinite timeout.
532 * @return msg_error_t
534 msg_error_t MSG_comm_wait(msg_comm_t comm, double timeout)
537 comm->s_comm->wait_for(timeout);
539 if (comm->task_received != nullptr) {
540 /* I am the receiver */
541 (*comm->task_received)->simdata->setNotUsed();
544 /* FIXME: these functions are not traceable */
545 } catch (simgrid::TimeoutError& e) {
546 comm->status = MSG_TIMEOUT;
549 if (e.category == network_error)
550 comm->status = MSG_TRANSFER_FAILURE;
558 /** @brief This function is called by a sender and permit to wait for each communication
560 * @param comm a vector of communication
561 * @param nb_elem is the size of the comm vector
562 * @param timeout for each call of MSG_comm_wait
564 void MSG_comm_waitall(msg_comm_t * comm, int nb_elem, double timeout)
566 for (int i = 0; i < nb_elem; i++)
567 MSG_comm_wait(comm[i], timeout);
570 /** @brief This function waits for the first communication finished in a list.
571 * @param comms a vector of communications
572 * @return the position of the first finished communication
573 * (but it may have failed, use MSG_comm_get_status() to know its status)
575 int MSG_comm_waitany(xbt_dynar_t comms)
577 int finished_index = -1;
579 /* Create the equivalent array with SIMIX objects: */
580 std::vector<simgrid::kernel::activity::CommImpl*> s_comms;
581 s_comms.reserve(xbt_dynar_length(comms));
584 xbt_dynar_foreach(comms, cursor, comm) {
585 s_comms.push_back(static_cast<simgrid::kernel::activity::CommImpl*>(comm->s_comm->get_impl().get()));
588 msg_error_t status = MSG_OK;
590 finished_index = simcall_comm_waitany(s_comms.data(), s_comms.size(), -1);
591 } catch (simgrid::TimeoutError& e) {
592 finished_index = e.value;
593 status = MSG_TIMEOUT;
596 if (e.category == network_error) {
597 finished_index = e.value;
598 status = MSG_TRANSFER_FAILURE;
604 xbt_assert(finished_index != -1, "WaitAny returned -1");
606 comm = xbt_dynar_get_as(comms, finished_index, msg_comm_t);
607 /* the communication is finished */
608 comm->status = status;
610 if (comm->task_received != nullptr) {
611 /* I am the receiver */
612 (*comm->task_received)->simdata->setNotUsed();
615 return finished_index;
619 * @brief Returns the error (if any) that occurred during a finished communication.
620 * @param comm a finished communication
621 * @return the status of the communication, or #MSG_OK if no error occurred
622 * during the communication
624 msg_error_t MSG_comm_get_status(msg_comm_t comm) {
629 /** @brief Get a task (#msg_task_t) from a communication
631 * @param comm the communication where to get the task
632 * @return the task from the communication
634 msg_task_t MSG_comm_get_task(msg_comm_t comm)
636 xbt_assert(comm, "Invalid parameter");
638 return comm->task_received ? *comm->task_received : comm->task_sent;
642 * @brief This function is called by SIMIX in kernel mode to copy the data of a comm.
643 * @param comm the comm
644 * @param buff the data copied
645 * @param buff_size size of the buffer
647 void MSG_comm_copy_data_from_SIMIX(simgrid::kernel::activity::CommImpl* comm, void* buff, size_t buff_size)
649 SIMIX_comm_copy_pointer_callback(comm, buff, buff_size);
651 // notify the user callback if any
652 if (msg_global->task_copy_callback) {
653 msg_task_t task = static_cast<msg_task_t>(buff);
654 msg_global->task_copy_callback(task, comm->src_actor_->ciface(), comm->dst_actor_->ciface());
659 * @brief Sends a task to a mailbox
661 * This is a blocking function, the execution flow will be blocked until the task is sent (and received on the other
662 * side if #MSG_task_receive is used).
663 * See #MSG_task_isend for sending tasks asynchronously.
665 * @param task the task to be sent
666 * @param alias the mailbox name to where the task is sent
668 * @return Returns #MSG_OK if the task was successfully sent,
669 * #MSG_HOST_FAILURE, or #MSG_TRANSFER_FAILURE otherwise.
671 msg_error_t MSG_task_send(msg_task_t task, const char *alias)
673 XBT_DEBUG("MSG_task_send: Trying to send a message on mailbox '%s'", alias);
674 return MSG_task_send_with_timeout(task, alias, -1);
678 * @brief Sends a task to a mailbox with a maximum rate
680 * This is a blocking function, the execution flow will be blocked until the task is sent. The maxrate parameter allows
681 * the application to limit the bandwidth utilization of network links when sending the task.
683 * The maxrate parameter can be used to send a task with a limited
684 * bandwidth (smaller than the physical available value). Use
685 * MSG_task_send() if you don't limit the rate (or pass -1 as a rate
686 * value do disable this feature).
688 * @param task the task to be sent
689 * @param alias the mailbox name to where the task is sent
690 * @param maxrate the maximum communication rate for sending this task (byte/sec)
692 * @return Returns #MSG_OK if the task was successfully sent,
693 * #MSG_HOST_FAILURE, or #MSG_TRANSFER_FAILURE otherwise.
695 msg_error_t MSG_task_send_bounded(msg_task_t task, const char *alias, double maxrate)
697 task->simdata->rate = maxrate;
698 return MSG_task_send(task, alias);
702 * @brief Sends a task to a mailbox with a timeout
704 * This is a blocking function, the execution flow will be blocked until the task is sent or the timeout is achieved.
706 * @param task the task to be sent
707 * @param alias the mailbox name to where the task is sent
708 * @param timeout is the maximum wait time for completion (if -1, this call is the same as #MSG_task_send)
710 * @return Returns #MSG_OK if the task was successfully sent,
711 * #MSG_HOST_FAILURE, or #MSG_TRANSFER_FAILURE, or #MSG_TIMEOUT otherwise.
713 msg_error_t MSG_task_send_with_timeout(msg_task_t task, const char *alias, double timeout)
715 msg_error_t ret = MSG_OK;
717 TRACE_msg_task_put_start(task);
719 /* Prepare the task to send */
720 simdata_task_t t_simdata = task->simdata;
721 t_simdata->sender = MSG_process_self();
722 t_simdata->source = MSG_host_self();
723 t_simdata->setUsed();
725 msg_global->sent_msg++;
729 simgrid::s4u::CommPtr comm =
730 simgrid::s4u::Mailbox::by_name(alias)->put_init(task, t_simdata->bytes_amount)->set_rate(t_simdata->rate);
731 t_simdata->comm = comm;
733 if (TRACE_is_enabled() && task->category != nullptr)
734 simgrid::simix::simcall([comm, task] { comm->get_impl()->set_category(task->category); });
735 comm->wait_for(timeout);
736 } catch (simgrid::TimeoutError& e) {
738 } catch (simgrid::CancelException& e) {
739 ret = MSG_HOST_FAILURE;
740 } catch (xbt_ex& e) {
741 if (e.category == network_error)
742 ret = MSG_TRANSFER_FAILURE;
746 /* If the send failed, it is not used anymore */
747 t_simdata->setNotUsed();
754 * @brief Sends a task to a mailbox with a timeout and with a maximum rate
756 * This is a blocking function, the execution flow will be blocked until the task is sent or the timeout is achieved.
758 * The maxrate parameter can be used to send a task with a limited
759 * bandwidth (smaller than the physical available value). Use
760 * MSG_task_send_with_timeout() if you don't limit the rate (or pass -1 as a rate
761 * value do disable this feature).
763 * @param task the task to be sent
764 * @param alias the mailbox name to where the task is sent
765 * @param timeout is the maximum wait time for completion (if -1, this call is the same as #MSG_task_send)
766 * @param maxrate the maximum communication rate for sending this task (byte/sec)
768 * @return Returns #MSG_OK if the task was successfully sent,
769 * #MSG_HOST_FAILURE, or #MSG_TRANSFER_FAILURE, or #MSG_TIMEOUT otherwise.
771 msg_error_t MSG_task_send_with_timeout_bounded(msg_task_t task, const char *alias, double timeout, double maxrate)
773 task->simdata->rate = maxrate;
774 return MSG_task_send_with_timeout(task, alias, timeout);
778 * @brief Look if there is a communication on a mailbox and return the PID of the sender process.
780 * @param alias the name of the mailbox to be considered
782 * @return Returns the PID of sender process,
783 * -1 if there is no communication in the mailbox.
785 int MSG_task_listen_from(const char *alias)
787 simgrid::kernel::activity::CommImplPtr comm = simgrid::s4u::Mailbox::by_name(alias)->front();
789 return comm ? MSG_process_get_PID(static_cast<msg_task_t>(comm->src_buff_)->simdata->sender) : -1;
793 * @brief Sets the tracing category of a task.
795 * This function should be called after the creation of a MSG task, to define the category of that task. The
796 * first parameter task must contain a task that was created with the function #MSG_task_create. The second
797 * parameter category must contain a category that was previously declared with the function #TRACE_category
798 * (or with #TRACE_category_with_color).
800 * See @ref outcomes_vizu for details on how to trace the (categorized) resource utilization.
802 * @param task the task that is going to be categorized
803 * @param category the name of the category to be associated to the task
805 * @see MSG_task_get_category, TRACE_category, TRACE_category_with_color
807 void MSG_task_set_category (msg_task_t task, const char *category)
809 TRACE_msg_set_task_category (task, category);
813 * @brief Gets the current tracing category of a task.
815 * @param task the task to be considered
817 * @see MSG_task_set_category
819 * @return Returns the name of the tracing category of the given task, nullptr otherwise
821 const char *MSG_task_get_category (msg_task_t task)
823 return task->category;