Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
Merge remote-tracking branch 'upstream/master'
[simgrid.git] / src / msg / msg_gos.cpp
1 /* Copyright (c) 2004-2018. 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 <xbt/ex.hpp>
7
8 #include "src/instr/instr_private.hpp"
9 #include "src/kernel/activity/ExecImpl.hpp"
10 #include "src/msg/msg_private.hpp"
11 #include "src/simix/smx_private.hpp" /* MSG_task_listen looks inside the rdv directly. Not clean. */
12
13 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(msg_gos, msg, "Logging specific to MSG (gos)");
14
15 /** \ingroup msg_task_usage
16  * \brief Executes a task and waits for its termination.
17  *
18  * This function is used for describing the behavior of a process. It takes only one parameter.
19  * \param task a #msg_task_t to execute on the location on which the process is running.
20  * \return #MSG_OK if the task was successfully completed, #MSG_TASK_CANCELED or #MSG_HOST_FAILURE otherwise
21  */
22 msg_error_t MSG_task_execute(msg_task_t task)
23 {
24   return MSG_parallel_task_execute(task);
25 }
26
27 /** \ingroup msg_task_usage
28  * \brief Executes a parallel task and waits for its termination.
29  *
30  * \param task a #msg_task_t to execute on the location on which the process is running.
31  *
32  * \return #MSG_OK if the task was successfully completed, #MSG_TASK_CANCELED
33  * or #MSG_HOST_FAILURE otherwise
34  */
35 msg_error_t MSG_parallel_task_execute(msg_task_t task)
36 {
37   return MSG_parallel_task_execute_with_timeout(task, -1);
38 }
39
40 msg_error_t MSG_parallel_task_execute_with_timeout(msg_task_t task, double timeout)
41 {
42   simdata_task_t simdata = task->simdata;
43   e_smx_state_t comp_state;
44   msg_error_t status = MSG_OK;
45
46   TRACE_msg_task_execute_start(task);
47
48   xbt_assert((not simdata->compute) && not task->simdata->isused,
49              "This task is executed somewhere else. Go fix your code!");
50
51   XBT_DEBUG("Computing on %s", MSG_process_get_name(MSG_process_self()));
52
53   if (simdata->flops_amount <= 0.0 && not simdata->host_nb) {
54     TRACE_msg_task_execute_end(task);
55     return MSG_OK;
56   }
57
58   try {
59     simdata->setUsed();
60
61     if (simdata->host_nb > 0) {
62       simdata->compute =
63           boost::static_pointer_cast<simgrid::kernel::activity::ExecImpl>(simcall_execution_parallel_start(
64               task->name, simdata->host_nb, simdata->host_list, simdata->flops_parallel_amount,
65               simdata->bytes_parallel_amount, -1.0, timeout));
66       XBT_DEBUG("Parallel execution action created: %p", simdata->compute.get());
67     } else {
68       simdata->compute = boost::static_pointer_cast<simgrid::kernel::activity::ExecImpl>(
69           simcall_execution_start(task->name, simdata->flops_amount, simdata->priority, simdata->bound,
70                                   MSG_process_get_host(MSG_process_self())));
71     }
72     simcall_set_category(simdata->compute, task->category);
73     comp_state = simcall_execution_wait(simdata->compute);
74
75     simdata->setNotUsed();
76
77     XBT_DEBUG("Execution task '%s' finished in state %d", task->name, (int)comp_state);
78   }
79   catch (xbt_ex& e) {
80     switch (e.category) {
81     case cancel_error:
82       status = MSG_TASK_CANCELED;
83       break;
84     case host_error:
85       status = MSG_HOST_FAILURE;
86       break;
87     case timeout_error:
88       status = MSG_TIMEOUT;
89       break;
90     default:
91       throw;
92     }
93   }
94
95   /* action ended, set comm and compute = nullptr, the actions is already destroyed in the main function */
96   simdata->flops_amount = 0.0;
97   simdata->comm = nullptr;
98   simdata->compute = nullptr;
99   TRACE_msg_task_execute_end(task);
100
101   return status;
102 }
103
104 /** \ingroup msg_task_usage
105  * \brief Sleep for the specified number of seconds
106  *
107  * Makes the current process sleep until \a time seconds have elapsed.
108  *
109  * \param nb_sec a number of second
110  */
111 msg_error_t MSG_process_sleep(double nb_sec)
112 {
113   msg_error_t status = MSG_OK;
114
115   if (TRACE_actor_is_enabled())
116     simgrid::instr::Container::by_name(instr_pid(MSG_process_self()))->get_state("ACTOR_STATE")->push_event("sleep");
117
118   try {
119     simcall_process_sleep(nb_sec);
120   }
121   catch(xbt_ex& e) {
122     if (e.category == cancel_error) {
123       XBT_DEBUG("According to the JAVA API, a sleep call should only deal with HostFailureException, I'm lost.");
124       // adsein: MSG_TASK_CANCELED is assigned when someone kills the process that made the sleep, this is not
125       // correct. For instance, when the node is turned off, the error should be MSG_HOST_FAILURE, which is by the way
126       // and according to the JAVA document, the only exception that can be triggered by MSG_Process_sleep call.
127       // To avoid possible impacts in the code, I just raised a host_failure exception for the moment in the JAVA code
128       // and did not change anythings at the C level.
129       // See comment in the jmsg_process.c file, function JNIEXPORT void JNICALL Java_org_simgrid_msg_Process_sleep(JNIEnv *env, jclass cls, jlong jmillis, jint jnanos)
130       status = MSG_TASK_CANCELED;
131     } else
132       throw;
133   }
134
135   if (TRACE_actor_is_enabled())
136     simgrid::instr::Container::by_name(instr_pid(MSG_process_self()))->get_state("ACTOR_STATE")->pop_event();
137
138   return status;
139 }
140
141 /** \ingroup msg_task_usage
142  * \brief Receives a task from a mailbox.
143  *
144  * This is a blocking function, the execution flow will be blocked until the task is received. See #MSG_task_irecv
145  * for receiving tasks asynchronously.
146  *
147  * \param task a memory location for storing a #msg_task_t.
148  * \param alias name of the mailbox to receive the task from
149  *
150  * \return Returns
151  * #MSG_OK if the task was successfully received,
152  * #MSG_HOST_FAILURE, or #MSG_TRANSFER_FAILURE otherwise.
153  */
154 msg_error_t MSG_task_receive(msg_task_t * task, const char *alias)
155 {
156   return MSG_task_receive_with_timeout(task, alias, -1);
157 }
158
159 /** \ingroup msg_task_usage
160  * \brief Receives a task from a mailbox at a given rate.
161  *
162  * \param task a memory location for storing a #msg_task_t.
163  * \param alias name of the mailbox to receive the task from
164  * \param rate limit the reception to rate bandwidth (byte/sec)
165  *
166  * The rate parameter can be used to receive a task with a limited
167  * bandwidth (smaller than the physical available value). Use
168  * MSG_task_receive() if you don't limit the rate (or pass -1 as a
169  * rate value do disable this feature).
170  *
171  * \return Returns
172  * #MSG_OK if the task was successfully received,
173  * #MSG_HOST_FAILURE, or #MSG_TRANSFER_FAILURE otherwise.
174  */
175 msg_error_t MSG_task_receive_bounded(msg_task_t * task, const char *alias, double rate)
176 {
177   return MSG_task_receive_with_timeout_bounded(task, alias, -1, rate);
178 }
179
180 /** \ingroup msg_task_usage
181  * \brief Receives a task from a mailbox with a given timeout.
182  *
183  * This is a blocking function with a timeout, the execution flow will be blocked until the task is received or the
184  * timeout is achieved. See #MSG_task_irecv for receiving tasks asynchronously.  You can provide a -1 timeout
185  * to obtain an infinite timeout.
186  *
187  * \param task a memory location for storing a #msg_task_t.
188  * \param alias name of the mailbox to receive the task from
189  * \param timeout is the maximum wait time for completion (if -1, this call is the same as #MSG_task_receive)
190  *
191  * \return Returns
192  * #MSG_OK if the task was successfully received,
193  * #MSG_HOST_FAILURE, or #MSG_TRANSFER_FAILURE, or #MSG_TIMEOUT otherwise.
194  */
195 msg_error_t MSG_task_receive_with_timeout(msg_task_t * task, const char *alias, double timeout)
196 {
197   return MSG_task_receive_ext(task, alias, timeout, nullptr);
198 }
199
200 /** \ingroup msg_task_usage
201  * \brief Receives a task from a mailbox with a given timeout and at a given rate.
202  *
203  * \param task a memory location for storing a #msg_task_t.
204  * \param alias name of the mailbox to receive the task from
205  * \param timeout is the maximum wait time for completion (if -1, this call is the same as #MSG_task_receive)
206  * \param rate limit the reception to rate bandwidth (byte/sec)
207  *
208  * The rate parameter can be used to send a task with a limited
209  * bandwidth (smaller than the physical available value). Use
210  * MSG_task_receive() if you don't limit the rate (or pass -1 as a
211  * rate value do disable this feature).
212  *
213  * \return Returns
214  * #MSG_OK if the task was successfully received,
215  * #MSG_HOST_FAILURE, or #MSG_TRANSFER_FAILURE, or #MSG_TIMEOUT otherwise.
216  */
217 msg_error_t MSG_task_receive_with_timeout_bounded(msg_task_t * task, const char *alias, double timeout,double rate)
218 {
219   return MSG_task_receive_ext_bounded(task, alias, timeout, nullptr, rate);
220 }
221
222 /** \ingroup msg_task_usage
223  * \brief Receives a task from a mailbox from a specific host with a given timeout.
224  *
225  * This is a blocking function with a timeout, the execution flow will be blocked until the task is received or the
226  * timeout is achieved. See #MSG_task_irecv for receiving tasks asynchronously. You can provide a -1 timeout
227  * to obtain an infinite timeout.
228  *
229  * \param task a memory location for storing a #msg_task_t.
230  * \param alias name of the mailbox to receive the task from
231  * \param timeout is the maximum wait time for completion (provide -1 for no timeout)
232  * \param host a #msg_host_t host from where the task was sent
233  *
234  * \return Returns
235  * #MSG_OK if the task was successfully received,
236 * #MSG_HOST_FAILURE, or #MSG_TRANSFER_FAILURE, or #MSG_TIMEOUT otherwise.
237  */
238 msg_error_t MSG_task_receive_ext(msg_task_t * task, const char *alias, double timeout, msg_host_t host)
239 {
240   XBT_DEBUG("MSG_task_receive_ext: Trying to receive a message on mailbox '%s'", alias);
241   return MSG_task_receive_ext_bounded(task, alias, timeout, host, -1.0);
242 }
243
244 /** \ingroup msg_task_usage
245  * \brief Receives a task from a mailbox from a specific host with a given timeout  and at a given rate.
246  *
247  * \param task a memory location for storing a #msg_task_t.
248  * \param alias name of the mailbox to receive the task from
249  * \param timeout is the maximum wait time for completion (provide -1 for no timeout)
250  * \param host a #msg_host_t host from where the task was sent
251  * \param rate limit the reception to rate bandwidth (byte/sec)
252  *
253  * The rate parameter can be used to receive a task with a limited
254  * bandwidth (smaller than the physical available value). Use
255  * MSG_task_receive_ext() if you don't limit the rate (or pass -1 as a
256  * rate value do disable this feature).
257  *
258  * \return Returns
259  * #MSG_OK if the task was successfully received,
260  * #MSG_HOST_FAILURE, or #MSG_TRANSFER_FAILURE, or #MSG_TIMEOUT otherwise.
261  */
262 msg_error_t MSG_task_receive_ext_bounded(msg_task_t * task, const char *alias, double timeout, msg_host_t host,
263                                          double rate)
264 {
265   XBT_DEBUG("MSG_task_receive_ext: Trying to receive a message on mailbox '%s'", alias);
266   simgrid::s4u::MailboxPtr mailbox = simgrid::s4u::Mailbox::by_name(alias);
267   msg_error_t ret = MSG_OK;
268   /* We no longer support getting a task from a specific host */
269   if (host)
270     THROW_UNIMPLEMENTED;
271
272   TRACE_msg_task_get_start();
273
274   /* Sanity check */
275   xbt_assert(task, "Null pointer for the task storage");
276
277   if (*task)
278     XBT_WARN("Asked to write the received task in a non empty struct -- proceeding.");
279
280   /* Try to receive it by calling SIMIX network layer */
281   try {
282     simcall_comm_recv(MSG_process_self()->get_impl(), mailbox->get_impl(), task, nullptr, nullptr, nullptr, nullptr,
283                       timeout, rate);
284     XBT_DEBUG("Got task %s from %s", (*task)->name, mailbox->get_cname());
285     (*task)->simdata->setNotUsed();
286   }
287   catch (xbt_ex& e) {
288     switch (e.category) {
289     case host_error:
290     case cancel_error:
291       ret = MSG_HOST_FAILURE;
292       break;
293     case network_error:
294       ret = MSG_TRANSFER_FAILURE;
295       break;
296     case timeout_error:
297       ret = MSG_TIMEOUT;
298       break;
299     default:
300       throw;
301     }
302   }
303
304   if (ret != MSG_HOST_FAILURE && ret != MSG_TRANSFER_FAILURE && ret != MSG_TIMEOUT) {
305     TRACE_msg_task_get_end(*task);
306   }
307   return ret;
308 }
309
310 /* Internal function used to factorize code between MSG_task_isend(), MSG_task_isend_bounded(), and MSG_task_dsend(). */
311 static inline msg_comm_t MSG_task_isend_internal(msg_task_t task, const char* alias,
312                                                  void_f_pvoid_t cleanup, int detached)
313 {
314   simdata_task_t t_simdata = nullptr;
315   msg_process_t myself = MSG_process_self();
316   simgrid::s4u::MailboxPtr mailbox = simgrid::s4u::Mailbox::by_name(alias);
317   TRACE_msg_task_put_start(task);
318
319   /* Prepare the task to send */
320   t_simdata = task->simdata;
321   t_simdata->sender = myself;
322   t_simdata->source = MSG_host_self();
323   t_simdata->setUsed();
324   t_simdata->comm = nullptr;
325   msg_global->sent_msg++;
326
327   /* Send it by calling SIMIX network layer */
328   smx_activity_t act =
329       simcall_comm_isend(myself->get_impl(), mailbox->get_impl(), t_simdata->bytes_amount, t_simdata->rate, task,
330                          sizeof(void*), nullptr, cleanup, nullptr, nullptr, detached);
331   t_simdata->comm = boost::static_pointer_cast<simgrid::kernel::activity::CommImpl>(act);
332
333   msg_comm_t comm = nullptr;
334   if (not detached) {
335     comm = new simgrid::msg::Comm(task, nullptr, act);
336   }
337
338   if (TRACE_is_enabled())
339     simcall_set_category(act, task->category);
340   TRACE_msg_task_put_end();
341
342   return comm;
343 }
344
345 /** \ingroup msg_task_usage
346  * \brief Sends a task on a mailbox.
347  *
348  * This is a non blocking function: use MSG_comm_wait() or MSG_comm_test() to end the communication.
349  *
350  * \param task a #msg_task_t to send on another location.
351  * \param alias name of the mailbox to sent the task to
352  * \return the msg_comm_t communication created
353  */
354 msg_comm_t MSG_task_isend(msg_task_t task, const char *alias)
355 {
356   return MSG_task_isend_internal(task, alias, nullptr, 0);
357 }
358
359 /** \ingroup msg_task_usage
360  * \brief Sends a task on a mailbox with a maximum rate
361  *
362  * This is a non blocking function: use MSG_comm_wait() or MSG_comm_test() to end the communication. The maxrate
363  * parameter allows the application to limit the bandwidth utilization of network links when sending the task.
364  *
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 maxrate the maximum communication rate for sending this task (byte/sec).
368  * \return the msg_comm_t communication created
369  */
370 msg_comm_t MSG_task_isend_bounded(msg_task_t task, const char *alias, double maxrate)
371 {
372   task->simdata->rate = maxrate;
373   return MSG_task_isend_internal(task, alias, nullptr, 0);
374 }
375
376 /** \ingroup msg_task_usage
377  * \brief Sends a task on a mailbox.
378  *
379  * This is a non blocking detached send function.
380  * Think of it as a best effort send. Keep in mind that the third parameter is only called if the communication fails.
381  * If the communication does work, it is responsibility of the receiver code to free anything related to the task, as
382  * usual. More details on this can be obtained on
383  * <a href="http://lists.gforge.inria.fr/pipermail/simgrid-user/2011-November/002649.html">this thread</a>
384  * in the SimGrid-user mailing list archive.
385  *
386  * \param task a #msg_task_t to send on another location.
387  * \param alias name of the mailbox to sent the task to
388  * \param cleanup a function to destroy the task if the communication fails, e.g. MSG_task_destroy
389  * (if nullptr, no function will be called)
390  */
391 void MSG_task_dsend(msg_task_t task, const char *alias, void_f_pvoid_t cleanup)
392 {
393   msg_comm_t XBT_ATTRIB_UNUSED comm = MSG_task_isend_internal(task, alias, cleanup, 1);
394   xbt_assert(comm == nullptr);
395 }
396
397 /** \ingroup msg_task_usage
398  * \brief Sends a task on a mailbox with a maximal rate.
399  *
400  * This is a non blocking detached send function.
401  * Think of it as a best effort send. Keep in mind that the third parameter is only called if the communication fails.
402  * If the communication does work, it is responsibility of the receiver code to free anything related to the task, as
403  * usual. More details on this can be obtained on
404  * <a href="http://lists.gforge.inria.fr/pipermail/simgrid-user/2011-November/002649.html">this thread</a>
405  * in the SimGrid-user mailing list archive.
406  *
407  * The rate parameter can be used to send a task with a limited
408  * bandwidth (smaller than the physical available value). Use
409  * MSG_task_dsend() if you don't limit the rate (or pass -1 as a rate
410  * value do disable this feature).
411  *
412  * \param task a #msg_task_t to send on another location.
413  * \param alias name of the mailbox to sent the task to
414  * \param cleanup a function to destroy the task if the
415  * communication fails, e.g. MSG_task_destroy
416  * (if nullptr, no function will be called)
417  * \param maxrate the maximum communication rate for sending this task (byte/sec)
418  *
419  */
420 void MSG_task_dsend_bounded(msg_task_t task, const char *alias, void_f_pvoid_t cleanup, double maxrate)
421 {
422   task->simdata->rate = maxrate;
423   MSG_task_dsend(task, alias, cleanup);
424 }
425
426 /** \ingroup msg_task_usage
427  * \brief Starts listening for receiving a task from an asynchronous communication.
428  *
429  * This is a non blocking function: use MSG_comm_wait() or MSG_comm_test() to end the communication.
430  *
431  * \param task a memory location for storing a #msg_task_t. has to be valid until the end of the communication.
432  * \param name of the mailbox to receive the task on
433  * \return the msg_comm_t communication created
434  */
435 msg_comm_t MSG_task_irecv(msg_task_t *task, const char *name)
436 {
437   return MSG_task_irecv_bounded(task, name, -1.0);
438 }
439
440 /** \ingroup msg_task_usage
441  * \brief Starts listening for receiving a task from an asynchronous communication at a given rate.
442  *
443  * The rate parameter can be used to receive a task with a limited
444  * bandwidth (smaller than the physical available value). Use
445  * MSG_task_irecv() if you don't limit the rate (or pass -1 as a rate
446  * value do disable this feature).
447  *
448  * \param task a memory location for storing a #msg_task_t. has to be valid until the end of the communication.
449  * \param name of the mailbox to receive the task on
450  * \param rate limit the bandwidth to the given rate (byte/sec)
451  * \return the msg_comm_t communication created
452  */
453 msg_comm_t MSG_task_irecv_bounded(msg_task_t *task, const char *name, double rate)
454 {
455   simgrid::s4u::MailboxPtr mbox = simgrid::s4u::Mailbox::by_name(name);
456
457   /* FIXME: these functions are not traceable */
458   /* Sanity check */
459   xbt_assert(task, "Null pointer for the task storage");
460
461   if (*task)
462     XBT_CRITICAL("MSG_task_irecv() was asked to write in a non empty task struct.");
463
464   /* Try to receive it by calling SIMIX network layer */
465   msg_comm_t comm = new simgrid::msg::Comm(
466       nullptr, task,
467       simcall_comm_irecv(SIMIX_process_self(), mbox->get_impl(), task, nullptr, nullptr, nullptr, nullptr, rate));
468
469   return comm;
470 }
471
472 /** \ingroup msg_task_usage
473  * \brief Checks whether a communication is done, and if yes, finalizes it.
474  * \param comm the communication to test
475  * \return 'true' if the communication is finished
476  * (but it may have failed, use MSG_comm_get_status() to know its status)
477  * or 'false' if the communication is not finished yet
478  * If the status is 'false', don't forget to use MSG_process_sleep() after the test.
479  */
480 int MSG_comm_test(msg_comm_t comm)
481 {
482   bool finished = false;
483
484   try {
485     finished = simcall_comm_test(comm->s_comm);
486     if (finished && comm->task_received != nullptr) {
487       /* I am the receiver */
488       (*comm->task_received)->simdata->setNotUsed();
489     }
490   }
491   catch (xbt_ex& e) {
492     switch (e.category) {
493       case network_error:
494         comm->status = MSG_TRANSFER_FAILURE;
495         finished     = true;
496         break;
497       case timeout_error:
498         comm->status = MSG_TIMEOUT;
499         finished     = true;
500         break;
501       default:
502         throw;
503     }
504   }
505
506   return finished;
507 }
508
509 /** \ingroup msg_task_usage
510  * \brief This function checks if a communication is finished.
511  * \param comms a vector of communications
512  * \return the position of the finished communication if any
513  * (but it may have failed, use MSG_comm_get_status() to know its status),
514  * or -1 if none is finished
515  */
516 int MSG_comm_testany(xbt_dynar_t comms)
517 {
518   int finished_index = -1;
519
520   /* Create the equivalent array with SIMIX objects: */
521   std::vector<simgrid::kernel::activity::ActivityImplPtr> s_comms;
522   s_comms.reserve(xbt_dynar_length(comms));
523   msg_comm_t comm;
524   unsigned int cursor;
525   xbt_dynar_foreach(comms, cursor, comm) {
526     s_comms.push_back(comm->s_comm);
527   }
528
529   msg_error_t status = MSG_OK;
530   try {
531     finished_index = simcall_comm_testany(s_comms.data(), s_comms.size());
532   }
533   catch (xbt_ex& e) {
534     switch (e.category) {
535       case network_error:
536         finished_index = e.value;
537         status = MSG_TRANSFER_FAILURE;
538         break;
539       case timeout_error:
540         finished_index = e.value;
541         status = MSG_TIMEOUT;
542         break;
543       default:
544         throw;
545     }
546   }
547
548   if (finished_index != -1) {
549     comm = xbt_dynar_get_as(comms, finished_index, msg_comm_t);
550     /* the communication is finished */
551     comm->status = status;
552
553     if (status == MSG_OK && comm->task_received != nullptr) {
554       /* I am the receiver */
555       (*comm->task_received)->simdata->setNotUsed();
556     }
557   }
558
559   return finished_index;
560 }
561
562 /** \ingroup msg_task_usage
563  * \brief Destroys a communication.
564  * \param comm the communication to destroy.
565  */
566 void MSG_comm_destroy(msg_comm_t comm)
567 {
568   delete comm;
569 }
570
571 /** \ingroup msg_task_usage
572  * \brief Wait for the completion of a communication.
573  *
574  * It takes two parameters.
575  * \param comm the communication to wait.
576  * \param timeout Wait until the communication terminates or the timeout occurs.
577  *                You can provide a -1 timeout to obtain an infinite timeout.
578  * \return msg_error_t
579  */
580 msg_error_t MSG_comm_wait(msg_comm_t comm, double timeout)
581 {
582   try {
583     simcall_comm_wait(comm->s_comm, timeout);
584
585     if (comm->task_received != nullptr) {
586       /* I am the receiver */
587       (*comm->task_received)->simdata->setNotUsed();
588     }
589
590     /* FIXME: these functions are not traceable */
591   }
592   catch (xbt_ex& e) {
593     switch (e.category) {
594     case network_error:
595       comm->status = MSG_TRANSFER_FAILURE;
596       break;
597     case timeout_error:
598       comm->status = MSG_TIMEOUT;
599       break;
600     default:
601       throw;
602     }
603   }
604
605   return comm->status;
606 }
607
608 /** \ingroup msg_task_usage
609 * \brief This function is called by a sender and permit to wait for each communication
610 *
611 * \param comm a vector of communication
612 * \param nb_elem is the size of the comm vector
613 * \param timeout for each call of MSG_comm_wait
614 */
615 void MSG_comm_waitall(msg_comm_t * comm, int nb_elem, double timeout)
616 {
617   for (int i = 0; i < nb_elem; i++)
618     MSG_comm_wait(comm[i], timeout);
619 }
620
621 /** \ingroup msg_task_usage
622  * \brief This function waits for the first communication finished in a list.
623  * \param comms a vector of communications
624  * \return the position of the first finished communication
625  * (but it may have failed, use MSG_comm_get_status() to know its status)
626  */
627 int MSG_comm_waitany(xbt_dynar_t comms)
628 {
629   int finished_index = -1;
630
631   /* create the equivalent dynar with SIMIX objects */
632   xbt_dynar_t s_comms = xbt_dynar_new(sizeof(smx_activity_t), [](void*ptr){
633     intrusive_ptr_release(*(simgrid::kernel::activity::ActivityImpl**)ptr);
634   });
635   msg_comm_t comm;
636   unsigned int cursor;
637   xbt_dynar_foreach(comms, cursor, comm) {
638     intrusive_ptr_add_ref(comm->s_comm.get());
639     xbt_dynar_push_as(s_comms, simgrid::kernel::activity::ActivityImpl*, comm->s_comm.get());
640   }
641
642   msg_error_t status = MSG_OK;
643   try {
644     finished_index = simcall_comm_waitany(s_comms, -1);
645   }
646   catch(xbt_ex& e) {
647     switch (e.category) {
648       case network_error:
649         finished_index = e.value;
650         status = MSG_TRANSFER_FAILURE;
651         break;
652       case timeout_error:
653         finished_index = e.value;
654         status = MSG_TIMEOUT;
655         break;
656       default:
657         throw;
658     }
659   }
660
661   xbt_assert(finished_index != -1, "WaitAny returned -1");
662   xbt_dynar_free(&s_comms);
663
664   comm = xbt_dynar_get_as(comms, finished_index, msg_comm_t);
665   /* the communication is finished */
666   comm->status = status;
667
668   if (comm->task_received != nullptr) {
669     /* I am the receiver */
670     (*comm->task_received)->simdata->setNotUsed();
671   }
672
673   return finished_index;
674 }
675
676 /**
677  * \ingroup msg_task_usage
678  * \brief Returns the error (if any) that occurred during a finished communication.
679  * \param comm a finished communication
680  * \return the status of the communication, or #MSG_OK if no error occurred
681  * during the communication
682  */
683 msg_error_t MSG_comm_get_status(msg_comm_t comm) {
684
685   return comm->status;
686 }
687
688 /** \ingroup msg_task_usage
689  * \brief Get a task (#msg_task_t) from a communication
690  *
691  * \param comm the communication where to get the task
692  * \return the task from the communication
693  */
694 msg_task_t MSG_comm_get_task(msg_comm_t comm)
695 {
696   xbt_assert(comm, "Invalid parameter");
697
698   return comm->task_received ? *comm->task_received : comm->task_sent;
699 }
700
701 /**
702  * \brief This function is called by SIMIX in kernel mode to copy the data of a comm.
703  * \param synchro the comm
704  * \param buff the data copied
705  * \param buff_size size of the buffer
706  */
707 void MSG_comm_copy_data_from_SIMIX(smx_activity_t synchro, void* buff, size_t buff_size)
708 {
709   simgrid::kernel::activity::CommImplPtr comm =
710       boost::static_pointer_cast<simgrid::kernel::activity::CommImpl>(synchro);
711
712   SIMIX_comm_copy_pointer_callback(comm, buff, buff_size);
713
714   // notify the user callback if any
715   if (msg_global->task_copy_callback) {
716     msg_task_t task = static_cast<msg_task_t>(buff);
717     msg_global->task_copy_callback(task, comm->src_proc->ciface(), comm->dst_proc->ciface());
718   }
719 }
720
721 /** \ingroup msg_task_usage
722  * \brief Sends a task to a mailbox
723  *
724  * This is a blocking function, the execution flow will be blocked until the task is sent (and received on the other
725  * side if #MSG_task_receive is used).
726  * See #MSG_task_isend for sending tasks asynchronously.
727  *
728  * \param task the task to be sent
729  * \param alias the mailbox name to where the task is sent
730  *
731  * \return Returns #MSG_OK if the task was successfully sent,
732  * #MSG_HOST_FAILURE, or #MSG_TRANSFER_FAILURE otherwise.
733  */
734 msg_error_t MSG_task_send(msg_task_t task, const char *alias)
735 {
736   XBT_DEBUG("MSG_task_send: Trying to send a message on mailbox '%s'", alias);
737   return MSG_task_send_with_timeout(task, alias, -1);
738 }
739
740 /** \ingroup msg_task_usage
741  * \brief Sends a task to a mailbox with a maximum rate
742  *
743  * This is a blocking function, the execution flow will be blocked until the task is sent. The maxrate parameter allows
744  * the application to limit the bandwidth utilization of network links when sending the task.
745  *
746  * The maxrate parameter can be used to send a task with a limited
747  * bandwidth (smaller than the physical available value). Use
748  * MSG_task_send() if you don't limit the rate (or pass -1 as a rate
749  * value do disable this feature).
750  *
751  * \param task the task to be sent
752  * \param alias the mailbox name to where the task is sent
753  * \param maxrate the maximum communication rate for sending this task (byte/sec)
754  *
755  * \return Returns #MSG_OK if the task was successfully sent,
756  * #MSG_HOST_FAILURE, or #MSG_TRANSFER_FAILURE otherwise.
757  */
758 msg_error_t MSG_task_send_bounded(msg_task_t task, const char *alias, double maxrate)
759 {
760   task->simdata->rate = maxrate;
761   return MSG_task_send(task, alias);
762 }
763
764 /** \ingroup msg_task_usage
765  * \brief Sends a task to a mailbox with a timeout
766  *
767  * This is a blocking function, the execution flow will be blocked until the task is sent or the timeout is achieved.
768  *
769  * \param task the task to be sent
770  * \param alias the mailbox name to where the task is sent
771  * \param timeout is the maximum wait time for completion (if -1, this call is the same as #MSG_task_send)
772  *
773  * \return Returns #MSG_OK if the task was successfully sent,
774  * #MSG_HOST_FAILURE, or #MSG_TRANSFER_FAILURE, or #MSG_TIMEOUT otherwise.
775  */
776 msg_error_t MSG_task_send_with_timeout(msg_task_t task, const char *alias, double timeout)
777 {
778   msg_error_t ret = MSG_OK;
779   simdata_task_t t_simdata = nullptr;
780   msg_process_t process = MSG_process_self();
781   simgrid::s4u::MailboxPtr mailbox = simgrid::s4u::Mailbox::by_name(alias);
782
783   TRACE_msg_task_put_start(task);
784
785   /* Prepare the task to send */
786   t_simdata = task->simdata;
787   t_simdata->sender = process;
788   t_simdata->source = MSG_host_self();
789
790   t_simdata->setUsed();
791
792   t_simdata->comm = nullptr;
793   msg_global->sent_msg++;
794
795   /* Try to send it by calling SIMIX network layer */
796   try {
797     smx_activity_t comm = nullptr; /* MC needs the comm to be set to nullptr during the simix call  */
798     comm = simcall_comm_isend(SIMIX_process_self(), mailbox->get_impl(), t_simdata->bytes_amount, t_simdata->rate, task,
799                               sizeof(void*), nullptr, nullptr, nullptr, nullptr, 0);
800     if (TRACE_is_enabled())
801       simcall_set_category(comm, task->category);
802     t_simdata->comm = boost::static_pointer_cast<simgrid::kernel::activity::CommImpl>(comm);
803     simcall_comm_wait(comm, timeout);
804   }
805   catch (xbt_ex& e) {
806     switch (e.category) {
807     case cancel_error:
808       ret = MSG_HOST_FAILURE;
809       break;
810     case network_error:
811       ret = MSG_TRANSFER_FAILURE;
812       break;
813     case timeout_error:
814       ret = MSG_TIMEOUT;
815       break;
816     default:
817       throw;
818     }
819
820     /* If the send failed, it is not used anymore */
821     t_simdata->setNotUsed();
822   }
823
824   TRACE_msg_task_put_end();
825   return ret;
826 }
827
828 /** \ingroup msg_task_usage
829  * \brief Sends a task to a mailbox with a timeout and with a maximum rate
830  *
831  * This is a blocking function, the execution flow will be blocked until the task is sent or the timeout is achieved.
832  *
833  * The maxrate parameter can be used to send a task with a limited
834  * bandwidth (smaller than the physical available value). Use
835  * MSG_task_send_with_timeout() if you don't limit the rate (or pass -1 as a rate
836  * value do disable this feature).
837  *
838  * \param task the task to be sent
839  * \param alias the mailbox name to where the task is sent
840  * \param timeout is the maximum wait time for completion (if -1, this call is the same as #MSG_task_send)
841  * \param maxrate the maximum communication rate for sending this task (byte/sec)
842  *
843  * \return Returns #MSG_OK if the task was successfully sent,
844  * #MSG_HOST_FAILURE, or #MSG_TRANSFER_FAILURE, or #MSG_TIMEOUT otherwise.
845  */
846 msg_error_t MSG_task_send_with_timeout_bounded(msg_task_t task, const char *alias, double timeout, double maxrate)
847 {
848   task->simdata->rate = maxrate;
849   return MSG_task_send_with_timeout(task, alias, timeout);
850 }
851
852 /** \ingroup msg_task_usage
853  * \brief Look if there is a communication on a mailbox and return the PID of the sender process.
854  *
855  * \param alias the name of the mailbox to be considered
856  *
857  * \return Returns the PID of sender process,
858  * -1 if there is no communication in the mailbox.
859  */
860 int MSG_task_listen_from(const char *alias)
861 {
862   simgrid::s4u::MailboxPtr mbox = simgrid::s4u::Mailbox::by_name(alias);
863   simgrid::kernel::activity::CommImplPtr comm =
864       boost::static_pointer_cast<simgrid::kernel::activity::CommImpl>(mbox->front());
865
866   if (not comm)
867     return -1;
868
869   return MSG_process_get_PID(static_cast<msg_task_t>(comm->src_buff)->simdata->sender);
870 }
871
872 /** \ingroup msg_task_usage
873  * \brief Sets the tracing category of a task.
874  *
875  * This function should be called after the creation of a MSG task, to define the category of that task. The
876  * first parameter task must contain a task that was  created with the function #MSG_task_create. The second
877  * parameter category must contain a category that was previously declared with the function #TRACE_category
878  * (or with #TRACE_category_with_color).
879  *
880  * See \ref outcomes_vizu for details on how to trace the (categorized) resource utilization.
881  *
882  * \param task the task that is going to be categorized
883  * \param category the name of the category to be associated to the task
884  *
885  * \see MSG_task_get_category, TRACE_category, TRACE_category_with_color
886  */
887 void MSG_task_set_category (msg_task_t task, const char *category)
888 {
889   TRACE_msg_set_task_category (task, category);
890 }
891
892 /** \ingroup msg_task_usage
893  *
894  * \brief Gets the current tracing category of a task.
895  *
896  * \param task the task to be considered
897  *
898  * \see MSG_task_set_category
899  *
900  * \return Returns the name of the tracing category of the given task, nullptr otherwise
901  */
902 const char *MSG_task_get_category (msg_task_t task)
903 {
904   return task->category;
905 }