Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
877cfcfab276cc617fb425381aa5881053d623be
[simgrid.git] / src / msg / msg_gos.cpp
1 /* Copyright (c) 2004-2019. The SimGrid Team. All rights reserved.          */
2
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. */
5
6 #include "simgrid/Exception.hpp"
7 #include <cmath>
8
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. */
15
16 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(msg_gos, msg, "Logging specific to MSG (gos)");
17
18 /**
19  * @brief Executes a task and waits for its termination.
20  *
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
24  */
25 msg_error_t MSG_task_execute(msg_task_t task)
26 {
27   return MSG_parallel_task_execute(task);
28 }
29
30 /**
31  * @brief Executes a parallel task and waits for its termination.
32  *
33  * @param task a #msg_task_t to execute on the location on which the process is running.
34  *
35  * @return #MSG_OK if the task was successfully completed, #MSG_TASK_CANCELED
36  * or #MSG_HOST_FAILURE otherwise
37  */
38 msg_error_t MSG_parallel_task_execute(msg_task_t task)
39 {
40   return MSG_parallel_task_execute_with_timeout(task, -1);
41 }
42
43 msg_error_t MSG_parallel_task_execute_with_timeout(msg_task_t task, double timeout)
44 {
45   simdata_task_t simdata = task->simdata;
46   e_smx_state_t comp_state;
47   msg_error_t status = MSG_OK;
48
49
50   xbt_assert((not simdata->compute) && not task->simdata->isused,
51              "This task is executed somewhere else. Go fix your code!");
52
53   XBT_DEBUG("Computing on %s", MSG_process_get_name(MSG_process_self()));
54
55   if (simdata->flops_amount <= 0.0 && not simdata->host_nb) {
56     return MSG_OK;
57   }
58
59   if (TRACE_actor_is_enabled())
60     simgrid::instr::Container::by_name(instr_pid(MSG_process_self()))->get_state("ACTOR_STATE")->push_event("execute");
61
62   try {
63     simdata->setUsed();
64
65     if (simdata->host_nb > 0) {
66       simdata->compute =
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); });
73     } else {
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));
79       });
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!");
83
84       simdata->compute->start(simdata->flops_amount, simdata->priority, simdata->bound);
85     }
86
87     comp_state = simcall_execution_wait(simdata->compute);
88
89     simdata->setNotUsed();
90
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) {
95     status = MSG_TIMEOUT;
96   } catch (simgrid::CancelException& e) {
97     status = MSG_TASK_CANCELED;
98   }
99
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;
104
105   if (TRACE_actor_is_enabled())
106     simgrid::instr::Container::by_name(instr_pid(MSG_process_self()))->get_state("ACTOR_STATE")->pop_event();
107
108   return status;
109 }
110
111 /**
112  * @brief Receives a task from a mailbox.
113  *
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.
116  *
117  * @param task a memory location for storing a #msg_task_t.
118  * @param alias name of the mailbox to receive the task from
119  *
120  * @return Returns
121  * #MSG_OK if the task was successfully received,
122  * #MSG_HOST_FAILURE, or #MSG_TRANSFER_FAILURE otherwise.
123  */
124 msg_error_t MSG_task_receive(msg_task_t * task, const char *alias)
125 {
126   return MSG_task_receive_with_timeout(task, alias, -1);
127 }
128
129 /**
130  * @brief Receives a task from a mailbox at a given rate.
131  *
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)
135  *
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).
140  *
141  * @return Returns
142  * #MSG_OK if the task was successfully received,
143  * #MSG_HOST_FAILURE, or #MSG_TRANSFER_FAILURE otherwise.
144  */
145 msg_error_t MSG_task_receive_bounded(msg_task_t * task, const char *alias, double rate)
146 {
147   return MSG_task_receive_with_timeout_bounded(task, alias, -1, rate);
148 }
149
150 /**
151  * @brief Receives a task from a mailbox with a given timeout.
152  *
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.
156  *
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)
160  *
161  * @return Returns
162  * #MSG_OK if the task was successfully received,
163  * #MSG_HOST_FAILURE, or #MSG_TRANSFER_FAILURE, or #MSG_TIMEOUT otherwise.
164  */
165 msg_error_t MSG_task_receive_with_timeout(msg_task_t * task, const char *alias, double timeout)
166 {
167   return MSG_task_receive_ext(task, alias, timeout, nullptr);
168 }
169
170 /**
171  * @brief Receives a task from a mailbox with a given timeout and at a given rate.
172  *
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)
177  *
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).
182  *
183  * @return Returns
184  * #MSG_OK if the task was successfully received,
185  * #MSG_HOST_FAILURE, or #MSG_TRANSFER_FAILURE, or #MSG_TIMEOUT otherwise.
186  */
187 msg_error_t MSG_task_receive_with_timeout_bounded(msg_task_t * task, const char *alias, double timeout,double rate)
188 {
189   return MSG_task_receive_ext_bounded(task, alias, timeout, nullptr, rate);
190 }
191
192 /**
193  * @brief Receives a task from a mailbox from a specific host with a given timeout.
194  *
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.
198  *
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
203  *
204  * @return Returns
205  * #MSG_OK if the task was successfully received,
206  * #MSG_HOST_FAILURE, or #MSG_TRANSFER_FAILURE, or #MSG_TIMEOUT otherwise.
207  */
208 msg_error_t MSG_task_receive_ext(msg_task_t * task, const char *alias, double timeout, msg_host_t host)
209 {
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);
212 }
213
214 /**
215  * @brief Receives a task from a mailbox from a specific host with a given timeout  and at a given rate.
216  *
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)
222  *
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).
227  *
228  * @return Returns
229  * #MSG_OK if the task was successfully received,
230  * #MSG_HOST_FAILURE, or #MSG_TRANSFER_FAILURE, or #MSG_TIMEOUT otherwise.
231  */
232 msg_error_t MSG_task_receive_ext_bounded(msg_task_t * task, const char *alias, double timeout, msg_host_t host,
233                                          double rate)
234 {
235   XBT_DEBUG("MSG_task_receive_ext: Trying to receive a message on mailbox '%s'", alias);
236   simgrid::s4u::MailboxPtr mailbox = simgrid::s4u::Mailbox::by_name(alias);
237   msg_error_t ret = MSG_OK;
238   /* We no longer support getting a task from a specific host */
239   if (host)
240     THROW_UNIMPLEMENTED;
241
242   TRACE_msg_task_get_start();
243
244   /* Sanity check */
245   xbt_assert(task, "Null pointer for the task storage");
246
247   if (*task)
248     XBT_WARN("Asked to write the received task in a non empty struct -- proceeding.");
249
250   /* Try to receive it by calling SIMIX network layer */
251   try {
252     simcall_comm_recv(MSG_process_self()->get_impl(), mailbox->get_impl(), task, nullptr, nullptr, nullptr, nullptr,
253                       timeout, rate);
254     XBT_DEBUG("Got task %s from %s", (*task)->name, mailbox->get_cname());
255     (*task)->simdata->setNotUsed();
256   } catch (simgrid::HostFailureException& e) {
257     ret = MSG_HOST_FAILURE;
258   } catch (simgrid::TimeoutError& e) {
259     ret = MSG_TIMEOUT;
260   } catch (simgrid::CancelException& e) {
261     ret = MSG_HOST_FAILURE;
262   } catch (xbt_ex& e) {
263     if (e.category == network_error)
264       ret = MSG_TRANSFER_FAILURE;
265     else
266       throw;
267   }
268
269   if (ret != MSG_HOST_FAILURE && ret != MSG_TRANSFER_FAILURE && ret != MSG_TIMEOUT) {
270     TRACE_msg_task_get_end(*task);
271   }
272   return ret;
273 }
274
275 /* Internal function used to factorize code between MSG_task_isend(), MSG_task_isend_bounded(), and MSG_task_dsend(). */
276 static inline msg_comm_t MSG_task_isend_internal(msg_task_t task, const char* alias,
277                                                  void_f_pvoid_t cleanup, int detached)
278 {
279   simdata_task_t t_simdata = nullptr;
280   msg_process_t myself = MSG_process_self();
281   simgrid::s4u::MailboxPtr mailbox = simgrid::s4u::Mailbox::by_name(alias);
282   TRACE_msg_task_put_start(task);
283
284   /* Prepare the task to send */
285   t_simdata = task->simdata;
286   t_simdata->sender = myself;
287   t_simdata->source = MSG_host_self();
288   t_simdata->setUsed();
289   t_simdata->comm = nullptr;
290   msg_global->sent_msg++;
291
292   /* Send it by calling SIMIX network layer */
293   smx_activity_t act =
294       simcall_comm_isend(myself->get_impl(), mailbox->get_impl(), t_simdata->bytes_amount, t_simdata->rate, task,
295                          sizeof(void*), nullptr, cleanup, nullptr, nullptr, detached);
296   t_simdata->comm = boost::static_pointer_cast<simgrid::kernel::activity::CommImpl>(act);
297
298   msg_comm_t comm = nullptr;
299   if (not detached) {
300     comm = new simgrid::msg::Comm(task, nullptr, act);
301   }
302
303   if (TRACE_is_enabled() && task->category != nullptr)
304     simgrid::simix::simcall([act, task] { act->set_category(task->category); });
305
306   TRACE_msg_task_put_end();
307
308   return comm;
309 }
310
311 /**
312  * @brief Sends a task on a mailbox.
313  *
314  * This is a non blocking function: use MSG_comm_wait() or MSG_comm_test() to end the communication.
315  *
316  * @param task a #msg_task_t to send on another location.
317  * @param alias name of the mailbox to sent the task to
318  * @return the msg_comm_t communication created
319  */
320 msg_comm_t MSG_task_isend(msg_task_t task, const char *alias)
321 {
322   return MSG_task_isend_internal(task, alias, nullptr, 0);
323 }
324
325 /**
326  * @brief Sends a task on a mailbox with a maximum rate
327  *
328  * This is a non blocking function: use MSG_comm_wait() or MSG_comm_test() to end the communication. The maxrate
329  * parameter allows the application to limit the bandwidth utilization of network links when sending the task.
330  *
331  * @param task a #msg_task_t to send on another location.
332  * @param alias name of the mailbox to sent the task to
333  * @param maxrate the maximum communication rate for sending this task (byte/sec).
334  * @return the msg_comm_t communication created
335  */
336 msg_comm_t MSG_task_isend_bounded(msg_task_t task, const char *alias, double maxrate)
337 {
338   task->simdata->rate = maxrate;
339   return MSG_task_isend_internal(task, alias, nullptr, 0);
340 }
341
342 /**
343  * @brief Sends a task on a mailbox.
344  *
345  * This is a non blocking detached send function.
346  * Think of it as a best effort send. Keep in mind that the third parameter is only called if the communication fails.
347  * If the communication does work, it is responsibility of the receiver code to free anything related to the task, as
348  * usual. More details on this can be obtained on
349  * <a href="http://lists.gforge.inria.fr/pipermail/simgrid-user/2011-November/002649.html">this thread</a>
350  * in the SimGrid-user mailing list archive.
351  *
352  * @param task a #msg_task_t to send on another location.
353  * @param alias name of the mailbox to sent the task to
354  * @param cleanup a function to destroy the task if the communication fails, e.g. MSG_task_destroy
355  * (if nullptr, no function will be called)
356  */
357 void MSG_task_dsend(msg_task_t task, const char *alias, void_f_pvoid_t cleanup)
358 {
359   msg_comm_t XBT_ATTRIB_UNUSED comm = MSG_task_isend_internal(task, alias, cleanup, 1);
360   xbt_assert(comm == nullptr);
361 }
362
363 /**
364  * @brief Sends a task on a mailbox with a maximal rate.
365  *
366  * This is a non blocking detached send function.
367  * Think of it as a best effort send. Keep in mind that the third parameter is only called if the communication fails.
368  * If the communication does work, it is responsibility of the receiver code to free anything related to the task, as
369  * usual. More details on this can be obtained on
370  * <a href="http://lists.gforge.inria.fr/pipermail/simgrid-user/2011-November/002649.html">this thread</a>
371  * in the SimGrid-user mailing list archive.
372  *
373  * The rate parameter can be used to send a task with a limited
374  * bandwidth (smaller than the physical available value). Use
375  * MSG_task_dsend() if you don't limit the rate (or pass -1 as a rate
376  * value do disable this feature).
377  *
378  * @param task a #msg_task_t to send on another location.
379  * @param alias name of the mailbox to sent the task to
380  * @param cleanup a function to destroy the task if the
381  * communication fails, e.g. MSG_task_destroy
382  * (if nullptr, no function will be called)
383  * @param maxrate the maximum communication rate for sending this task (byte/sec)
384  *
385  */
386 void MSG_task_dsend_bounded(msg_task_t task, const char *alias, void_f_pvoid_t cleanup, double maxrate)
387 {
388   task->simdata->rate = maxrate;
389   MSG_task_dsend(task, alias, cleanup);
390 }
391
392 /**
393  * @brief Starts listening for receiving a task from an asynchronous communication.
394  *
395  * This is a non blocking function: use MSG_comm_wait() or MSG_comm_test() to end the communication.
396  *
397  * @param task a memory location for storing a #msg_task_t. has to be valid until the end of the communication.
398  * @param name of the mailbox to receive the task on
399  * @return the msg_comm_t communication created
400  */
401 msg_comm_t MSG_task_irecv(msg_task_t *task, const char *name)
402 {
403   return MSG_task_irecv_bounded(task, name, -1.0);
404 }
405
406 /**
407  * @brief Starts listening for receiving a task from an asynchronous communication at a given rate.
408  *
409  * The rate parameter can be used to receive a task with a limited
410  * bandwidth (smaller than the physical available value). Use
411  * MSG_task_irecv() if you don't limit the rate (or pass -1 as a rate
412  * value do disable this feature).
413  *
414  * @param task a memory location for storing a #msg_task_t. has to be valid until the end of the communication.
415  * @param name of the mailbox to receive the task on
416  * @param rate limit the bandwidth to the given rate (byte/sec)
417  * @return the msg_comm_t communication created
418  */
419 msg_comm_t MSG_task_irecv_bounded(msg_task_t *task, const char *name, double rate)
420 {
421   simgrid::s4u::MailboxPtr mbox = simgrid::s4u::Mailbox::by_name(name);
422
423   /* FIXME: these functions are not traceable */
424   /* Sanity check */
425   xbt_assert(task, "Null pointer for the task storage");
426
427   if (*task)
428     XBT_CRITICAL("MSG_task_irecv() was asked to write in a non empty task struct.");
429
430   /* Try to receive it by calling SIMIX network layer */
431   msg_comm_t comm = new simgrid::msg::Comm(
432       nullptr, task,
433       simcall_comm_irecv(SIMIX_process_self(), mbox->get_impl(), task, nullptr, nullptr, nullptr, nullptr, rate));
434
435   return comm;
436 }
437
438 /**
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.
445  */
446 int MSG_comm_test(msg_comm_t comm)
447 {
448   bool finished = false;
449
450   try {
451     finished = simcall_comm_test(comm->s_comm);
452     if (finished && comm->task_received != nullptr) {
453       /* I am the receiver */
454       (*comm->task_received)->simdata->setNotUsed();
455     }
456   } catch (simgrid::TimeoutError& e) {
457     comm->status = MSG_TIMEOUT;
458     finished     = true;
459   }
460   catch (xbt_ex& e) {
461     if (e.category == network_error) {
462       comm->status = MSG_TRANSFER_FAILURE;
463       finished     = true;
464     } else {
465       throw;
466     }
467   }
468
469   return finished;
470 }
471
472 /**
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
478  */
479 int MSG_comm_testany(xbt_dynar_t comms)
480 {
481   int finished_index = -1;
482
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));
486   msg_comm_t comm;
487   unsigned int cursor;
488   xbt_dynar_foreach(comms, cursor, comm) {
489     s_comms.push_back(static_cast<simgrid::kernel::activity::CommImpl*>(comm->s_comm.get()));
490   }
491
492   msg_error_t status = MSG_OK;
493   try {
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;
498   }
499   catch (xbt_ex& e) {
500     if (e.category != network_error)
501       throw;
502     finished_index = e.value;
503     status         = MSG_TRANSFER_FAILURE;
504   }
505
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;
510
511     if (status == MSG_OK && comm->task_received != nullptr) {
512       /* I am the receiver */
513       (*comm->task_received)->simdata->setNotUsed();
514     }
515   }
516
517   return finished_index;
518 }
519
520 /** @brief Destroys the provided communication. */
521 void MSG_comm_destroy(msg_comm_t comm)
522 {
523   delete comm;
524 }
525
526 /** @brief Wait for the completion of a communication.
527  *
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
533  */
534 msg_error_t MSG_comm_wait(msg_comm_t comm, double timeout)
535 {
536   try {
537     simcall_comm_wait(comm->s_comm, timeout);
538
539     if (comm->task_received != nullptr) {
540       /* I am the receiver */
541       (*comm->task_received)->simdata->setNotUsed();
542     }
543
544     /* FIXME: these functions are not traceable */
545   } catch (simgrid::TimeoutError& e) {
546     comm->status = MSG_TIMEOUT;
547   }
548   catch (xbt_ex& e) {
549     if (e.category == network_error)
550       comm->status = MSG_TRANSFER_FAILURE;
551     else
552       throw;
553   }
554
555   return comm->status;
556 }
557
558 /** @brief This function is called by a sender and permit to wait for each communication
559  *
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
563  */
564 void MSG_comm_waitall(msg_comm_t * comm, int nb_elem, double timeout)
565 {
566   for (int i = 0; i < nb_elem; i++)
567     MSG_comm_wait(comm[i], timeout);
568 }
569
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)
574  */
575 int MSG_comm_waitany(xbt_dynar_t comms)
576 {
577   int finished_index = -1;
578
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));
582   msg_comm_t comm;
583   unsigned int cursor;
584   xbt_dynar_foreach(comms, cursor, comm) {
585     s_comms.push_back(static_cast<simgrid::kernel::activity::CommImpl*>(comm->s_comm.get()));
586   }
587
588   msg_error_t status = MSG_OK;
589   try {
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;
594   }
595   catch(xbt_ex& e) {
596     if (e.category == network_error) {
597       finished_index = e.value;
598       status         = MSG_TRANSFER_FAILURE;
599     } else {
600       throw;
601     }
602   }
603
604   xbt_assert(finished_index != -1, "WaitAny returned -1");
605
606   comm = xbt_dynar_get_as(comms, finished_index, msg_comm_t);
607   /* the communication is finished */
608   comm->status = status;
609
610   if (comm->task_received != nullptr) {
611     /* I am the receiver */
612     (*comm->task_received)->simdata->setNotUsed();
613   }
614
615   return finished_index;
616 }
617
618 /**
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
623  */
624 msg_error_t MSG_comm_get_status(msg_comm_t comm) {
625
626   return comm->status;
627 }
628
629 /** @brief Get a task (#msg_task_t) from a communication
630  *
631  * @param comm the communication where to get the task
632  * @return the task from the communication
633  */
634 msg_task_t MSG_comm_get_task(msg_comm_t comm)
635 {
636   xbt_assert(comm, "Invalid parameter");
637
638   return comm->task_received ? *comm->task_received : comm->task_sent;
639 }
640
641 /**
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
646  */
647 void MSG_comm_copy_data_from_SIMIX(simgrid::kernel::activity::CommImpl* comm, void* buff, size_t buff_size)
648 {
649   SIMIX_comm_copy_pointer_callback(comm, buff, buff_size);
650
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());
655   }
656 }
657
658 /**
659  * @brief Sends a task to a mailbox
660  *
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.
664  *
665  * @param task the task to be sent
666  * @param alias the mailbox name to where the task is sent
667  *
668  * @return Returns #MSG_OK if the task was successfully sent,
669  * #MSG_HOST_FAILURE, or #MSG_TRANSFER_FAILURE otherwise.
670  */
671 msg_error_t MSG_task_send(msg_task_t task, const char *alias)
672 {
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);
675 }
676
677 /**
678  * @brief Sends a task to a mailbox with a maximum rate
679  *
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.
682  *
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).
687  *
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)
691  *
692  * @return Returns #MSG_OK if the task was successfully sent,
693  * #MSG_HOST_FAILURE, or #MSG_TRANSFER_FAILURE otherwise.
694  */
695 msg_error_t MSG_task_send_bounded(msg_task_t task, const char *alias, double maxrate)
696 {
697   task->simdata->rate = maxrate;
698   return MSG_task_send(task, alias);
699 }
700
701 /**
702  * @brief Sends a task to a mailbox with a timeout
703  *
704  * This is a blocking function, the execution flow will be blocked until the task is sent or the timeout is achieved.
705  *
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)
709  *
710  * @return Returns #MSG_OK if the task was successfully sent,
711  * #MSG_HOST_FAILURE, or #MSG_TRANSFER_FAILURE, or #MSG_TIMEOUT otherwise.
712  */
713 msg_error_t MSG_task_send_with_timeout(msg_task_t task, const char *alias, double timeout)
714 {
715   msg_error_t ret = MSG_OK;
716   simdata_task_t t_simdata = nullptr;
717   msg_process_t process = MSG_process_self();
718   simgrid::s4u::MailboxPtr mailbox = simgrid::s4u::Mailbox::by_name(alias);
719
720   if (TRACE_actor_is_enabled()) {
721     container_t process_container = simgrid::instr::Container::by_name(instr_pid(MSG_process_self()));
722     std::string key               = std::string("p") + std::to_string(task->counter);
723     simgrid::instr::Container::get_root()->get_link("ACTOR_TASK_LINK")->start_event(process_container, "SR", key);
724   }
725
726   /* Prepare the task to send */
727   t_simdata = task->simdata;
728   t_simdata->sender = process;
729   t_simdata->source = MSG_host_self();
730
731   t_simdata->setUsed();
732
733   t_simdata->comm = nullptr;
734   msg_global->sent_msg++;
735
736   /* Try to send it by calling SIMIX network layer */
737   try {
738     simgrid::s4u::CommPtr comm = mailbox->put_init(task, t_simdata->bytes_amount)->set_rate(t_simdata->rate);
739     t_simdata->comm            = boost::static_pointer_cast<simgrid::kernel::activity::CommImpl>(comm->get_impl());
740     comm->start();
741     if (TRACE_is_enabled() && task->category != nullptr)
742       simgrid::simix::simcall([comm, task] { comm->get_impl()->set_category(task->category); });
743     comm->wait_for(timeout);
744   } catch (simgrid::TimeoutError& e) {
745     ret = MSG_TIMEOUT;
746   } catch (simgrid::CancelException& e) {
747     ret = MSG_HOST_FAILURE;
748   } catch (xbt_ex& e) {
749     if (e.category == network_error)
750       ret = MSG_TRANSFER_FAILURE;
751     else
752       throw;
753
754     /* If the send failed, it is not used anymore */
755     t_simdata->setNotUsed();
756   }
757
758   return ret;
759 }
760
761 /**
762  * @brief Sends a task to a mailbox with a timeout and with a maximum rate
763  *
764  * This is a blocking function, the execution flow will be blocked until the task is sent or the timeout is achieved.
765  *
766  * The maxrate parameter can be used to send a task with a limited
767  * bandwidth (smaller than the physical available value). Use
768  * MSG_task_send_with_timeout() if you don't limit the rate (or pass -1 as a rate
769  * value do disable this feature).
770  *
771  * @param task the task to be sent
772  * @param alias the mailbox name to where the task is sent
773  * @param timeout is the maximum wait time for completion (if -1, this call is the same as #MSG_task_send)
774  * @param maxrate the maximum communication rate for sending this task (byte/sec)
775  *
776  * @return Returns #MSG_OK if the task was successfully sent,
777  * #MSG_HOST_FAILURE, or #MSG_TRANSFER_FAILURE, or #MSG_TIMEOUT otherwise.
778  */
779 msg_error_t MSG_task_send_with_timeout_bounded(msg_task_t task, const char *alias, double timeout, double maxrate)
780 {
781   task->simdata->rate = maxrate;
782   return MSG_task_send_with_timeout(task, alias, timeout);
783 }
784
785 /**
786  * @brief Look if there is a communication on a mailbox and return the PID of the sender process.
787  *
788  * @param alias the name of the mailbox to be considered
789  *
790  * @return Returns the PID of sender process,
791  * -1 if there is no communication in the mailbox.
792  */
793 int MSG_task_listen_from(const char *alias)
794 {
795   simgrid::kernel::activity::CommImplPtr comm = simgrid::s4u::Mailbox::by_name(alias)->front();
796
797   return comm ? MSG_process_get_PID(static_cast<msg_task_t>(comm->src_buff_)->simdata->sender) : -1;
798 }
799
800 /**
801  * @brief Sets the tracing category of a task.
802  *
803  * This function should be called after the creation of a MSG task, to define the category of that task. The
804  * first parameter task must contain a task that was  created with the function #MSG_task_create. The second
805  * parameter category must contain a category that was previously declared with the function #TRACE_category
806  * (or with #TRACE_category_with_color).
807  *
808  * See @ref outcomes_vizu for details on how to trace the (categorized) resource utilization.
809  *
810  * @param task the task that is going to be categorized
811  * @param category the name of the category to be associated to the task
812  *
813  * @see MSG_task_get_category, TRACE_category, TRACE_category_with_color
814  */
815 void MSG_task_set_category (msg_task_t task, const char *category)
816 {
817   TRACE_msg_set_task_category (task, category);
818 }
819
820 /**
821  * @brief Gets the current tracing category of a task.
822  *
823  * @param task the task to be considered
824  *
825  * @see MSG_task_set_category
826  *
827  * @return Returns the name of the tracing category of the given task, nullptr otherwise
828  */
829 const char *MSG_task_get_category (msg_task_t task)
830 {
831   return task->category;
832 }