Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
6c9427a39a9004f8b110bb3aed67eff47b6b4093
[simgrid.git] / src / msg / msg_gos.c
1 /* Copyright (c) 2004-2015. The SimGrid Team.
2  * All rights reserved.                                                     */
3
4 /* This program is free software; you can redistribute it and/or modify it
5  * under the terms of the license (GNU LGPL) which comes with this package. */
6
7 #include "msg_private.h"
8 #include "msg_mailbox.h"
9 #include "mc/mc.h"
10 #include "xbt/log.h"
11 #include "xbt/sysdep.h"
12
13 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(msg_gos, msg,
14                                 "Logging specific to MSG (gos)");
15
16 /** \ingroup msg_task_usage
17  * \brief Executes a task and waits for its termination.
18  *
19  * This function is used for describing the behavior of a process. It
20  * takes only one parameter.
21  * \param task a #msg_task_t to execute on the location on which the process is running.
22  * \return #MSG_OK if the task was successfully completed, #MSG_TASK_CANCELED
23  * or #MSG_HOST_FAILURE otherwise
24  */
25 msg_error_t MSG_task_execute(msg_task_t task)
26 {
27   /* TODO: add this to other locations */
28   msg_host_t host = MSG_process_get_host(MSG_process_self());
29   MSG_host_add_task(host, task);
30
31   msg_error_t ret = MSG_parallel_task_execute(task);
32
33   MSG_host_del_task(host, task);
34
35   return ret;
36 }
37
38 /** \ingroup msg_task_usage
39  * \brief Executes a parallel task and waits for its termination.
40  *
41  * \param task a #msg_task_t to execute on the location on which the process is running.
42  *
43  * \return #MSG_OK if the task was successfully completed, #MSG_TASK_CANCELED
44  * or #MSG_HOST_FAILURE otherwise
45  */
46 msg_error_t MSG_parallel_task_execute(msg_task_t task)
47 {
48   xbt_ex_t e;
49   simdata_task_t simdata = task->simdata;
50   msg_process_t self = SIMIX_process_self();
51   simdata_process_t p_simdata = SIMIX_process_self_get_data(self);
52   e_smx_state_t comp_state;
53   msg_error_t status = MSG_OK;
54
55   TRACE_msg_task_execute_start(task);
56
57   xbt_assert((!simdata->compute) && (task->simdata->isused == 0),
58              "This task is executed somewhere else. Go fix your code! %d",
59              task->simdata->isused!=NULL);
60
61   XBT_DEBUG("Computing on %s", MSG_process_get_name(MSG_process_self()));
62
63   if (simdata->flops_amount == 0 && !simdata->host_nb) {
64     TRACE_msg_task_execute_end(task);
65     return MSG_OK;
66   }
67
68
69   TRY {
70     if (msg_global->debug_multiple_use)
71       MSG_BT(simdata->isused, "Using Backtrace");
72     else
73       simdata->isused = (void*)1;
74
75     if (simdata->host_nb > 0) {
76       simdata->compute = simcall_host_parallel_execute(task->name,
77                                                        simdata->host_nb,
78                                                        simdata->host_list,
79                                                        simdata->flops_parallel_amount,
80                                                        simdata->bytes_parallel_amount,
81                                                        1.0, -1.0);
82       XBT_DEBUG("Parallel execution action created: %p", simdata->compute);
83     } else {
84       unsigned long affinity_mask = (unsigned long) xbt_dict_get_or_null_ext(simdata->affinity_mask_db, (char *) p_simdata->m_host, sizeof(msg_host_t));
85       XBT_DEBUG("execute %s@%s with affinity(0x%04lx)", MSG_task_get_name(task), MSG_host_get_name(p_simdata->m_host), affinity_mask);
86
87       simdata->compute = simcall_host_execute(task->name,
88                                               p_simdata->m_host,
89                                               simdata->flops_amount,
90                                               simdata->priority,
91                                               simdata->bound,
92                                               affinity_mask
93                                               );
94
95     }
96     simcall_set_category(simdata->compute, task->category);
97     p_simdata->waiting_action = simdata->compute;
98     comp_state = simcall_host_execution_wait(simdata->compute);
99
100     p_simdata->waiting_action = NULL;
101
102     if (msg_global->debug_multiple_use && simdata->isused!=0)
103       xbt_ex_free(*(xbt_ex_t*)simdata->isused);
104     simdata->isused = 0;
105
106     XBT_DEBUG("Execution task '%s' finished in state %d",
107               task->name, (int)comp_state);
108   }
109   CATCH(e) {
110     switch (e.category) {
111     case cancel_error:
112       status = MSG_TASK_CANCELED;
113       break;
114     case host_error:
115       status = MSG_HOST_FAILURE;
116       break;
117     default:
118       RETHROW;
119     }
120     xbt_ex_free(e);
121   }
122   /* action ended, set comm and compute = NULL, the actions is already destroyed
123    * in the main function */
124   simdata->flops_amount = 0.0;
125   simdata->comm = NULL;
126   simdata->compute = NULL;
127   TRACE_msg_task_execute_end(task);
128
129   MSG_RETURN(status);
130 }
131
132
133 /** \ingroup msg_task_usage
134  * \brief Sleep for the specified number of seconds
135  *
136  * Makes the current process sleep until \a time seconds have elapsed.
137  *
138  * \param nb_sec a number of second
139  */
140 msg_error_t MSG_process_sleep(double nb_sec)
141 {
142   xbt_ex_t e;
143   msg_error_t status = MSG_OK;
144   /*msg_process_t proc = MSG_process_self();*/
145
146   TRACE_msg_process_sleep_in(MSG_process_self());
147
148   TRY {
149     simcall_process_sleep(nb_sec);
150   }
151   CATCH(e) {
152     switch (e.category) {
153     case cancel_error:
154       XBT_DEBUG("According to the JAVA API, a sleep call should only deal with HostFailureException, WTF here ?"); 
155       // adsein: MSG_TASK_CANCELED is assigned when someone kills the process that made the sleep, this is not
156       // correct. For instance, when the node is turned off, the error should be MSG_HOST_FAILURE, which is by the way
157       // and according to the JAVA document, the only exception that can be triggered by MSG_Process_sleep call.
158       // To avoid possible impacts in the code, I just raised a host_failure exception for the moment in the JAVA code
159       // and did not change anythings at the C level.
160       // 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) 
161       status = MSG_TASK_CANCELED;
162       break;
163     default:
164       RETHROW;
165     }
166     xbt_ex_free(e);
167   }
168
169   TRACE_msg_process_sleep_out(MSG_process_self());
170   MSG_RETURN(status);
171 }
172
173 /** \ingroup msg_task_usage
174  * \brief Deprecated function that used to receive a task from a mailbox from a specific host.
175  *
176  * Sorry, this function is not supported anymore. That wouldn't be
177  * impossible to reimplement it, but we are lacking the time to do so ourselves.
178  * If you need this functionality, you can either:
179  *
180  *  - implement the buffering mechanism on the user-level by queuing all messages
181  *    received in the mailbox that do not match your expectation
182  *  - change your application logic to leverage the mailboxes features. For example,
183  *    if you have A receiving messages from B and C, you could have A waiting on
184  *    mailbox "A" most of the time, but on "A#B" when it's waiting for specific
185  *    messages from B and "A#C" when waiting for messages from C. You could even get A
186  *    sometime waiting on all these mailboxes using @ref MSG_comm_waitany. You can find
187  *    an example of use of this function in the @ref MSG_examples section.
188  *  - Provide a proper patch to implement this functionality back in MSG. That wouldn't be
189  *    very difficult actually. Check the function @ref MSG_mailbox_get_task_ext. During its call to
190  *    simcall_comm_recv(), the 5th argument, match_fun, is NULL. Create a function that filters
191  *    messages according to the host (that you will pass as sixth argument to simcall_comm_recv()
192  *    and that your filtering function will receive as first parameter, and then, the filter could
193  *    simply compare the host names, for example. After sufficient testing, provide an example that
194  *    we could add to the distribution, and your first contribution to SimGrid is ready. Thanks in advance.
195  *
196  * \param task a memory location for storing a #msg_task_t.
197  * \param alias name of the mailbox to receive the task from
198  * \param host a #msg_host_t host from where the task was sent
199  *
200  * \return Returns
201  * #MSG_OK if the task was successfully received,
202  * #MSG_HOST_FAILURE, or #MSG_TRANSFER_FAILURE otherwise.
203  */
204 msg_error_t
205 MSG_task_receive_from_host(msg_task_t * task, const char *alias,
206                            msg_host_t host)
207 {
208   return MSG_task_receive_ext(task, alias, -1, host);
209 }
210
211 /** msg_task_usage
212  *\brief Deprecated function that used to receive a task from a mailbox from a specific host
213  *\brief at a given rate
214  *
215  * \param task a memory location for storing a #msg_task_t.
216  * \param alias name of the mailbox to receive the task from
217  * \param host a #msg_host_t host from where the task was sent
218  * \param rate limit the reception to rate bandwidth
219  *
220  * \return Returns
221  * #MSG_OK if the task was successfully received,
222  * #MSG_HOST_FAILURE, or #MSG_TRANSFER_FAILURE otherwise.
223  */
224 msg_error_t
225 MSG_task_receive_from_host_bounded(msg_task_t * task, const char *alias,
226                                    msg_host_t host, double rate)
227 {
228   return MSG_task_receive_ext_bounded(task, alias, -1, host, rate);
229 }
230
231 /** \ingroup msg_task_usage
232  * \brief Receives a task from a mailbox.
233  *
234  * This is a blocking function, the execution flow will be blocked
235  * until the task is received. See #MSG_task_irecv
236  * for receiving tasks asynchronously.
237  *
238  * \param task a memory location for storing a #msg_task_t.
239  * \param alias name of the mailbox to receive the task from
240  *
241  * \return Returns
242  * #MSG_OK if the task was successfully received,
243  * #MSG_HOST_FAILURE, or #MSG_TRANSFER_FAILURE otherwise.
244  */
245 msg_error_t MSG_task_receive(msg_task_t * task, const char *alias)
246 {
247   return MSG_task_receive_with_timeout(task, alias, -1);
248 }
249
250 /** \ingroup msg_task_usage
251  * \brief Receives a task from a mailbox at a given rate.
252  *
253  * \param task a memory location for storing a #msg_task_t.
254  * \param alias name of the mailbox to receive the task from
255  *  \param rate limit the reception to rate bandwidth
256  *
257  * \return Returns
258  * #MSG_OK if the task was successfully received,
259  * #MSG_HOST_FAILURE, or #MSG_TRANSFER_FAILURE otherwise.
260  */
261 msg_error_t MSG_task_receive_bounded(msg_task_t * task, const char *alias,
262                                      double rate)
263 {
264   return MSG_task_receive_with_timeout_bounded(task, alias, -1, rate);
265 }
266
267 /** \ingroup msg_task_usage
268  * \brief Receives a task from a mailbox with a given timeout.
269  *
270  * This is a blocking function with a timeout, the execution flow will be blocked
271  * until the task is received or the timeout is achieved. See #MSG_task_irecv
272  * for receiving tasks asynchronously.  You can provide a -1 timeout
273  * to obtain an infinite timeout.
274  *
275  * \param task a memory location for storing a #msg_task_t.
276  * \param alias name of the mailbox to receive the task from
277  * \param timeout is the maximum wait time for completion (if -1, this call is the same as #MSG_task_receive)
278  *
279  * \return Returns
280  * #MSG_OK if the task was successfully received,
281  * #MSG_HOST_FAILURE, or #MSG_TRANSFER_FAILURE, or #MSG_TIMEOUT otherwise.
282  */
283 msg_error_t
284 MSG_task_receive_with_timeout(msg_task_t * task, const char *alias,
285                               double timeout)
286 {
287   return MSG_task_receive_ext(task, alias, timeout, NULL);
288 }
289
290 /** \ingroup msg_task_usage
291  * \brief Receives a task from a mailbox with a given timeout and at a given rate.
292  *
293  * \param task a memory location for storing a #msg_task_t.
294  * \param alias name of the mailbox to receive the task from
295  * \param timeout is the maximum wait time for completion (if -1, this call is the same as #MSG_task_receive)
296  *  \param rate limit the reception to rate bandwidth
297  *
298  * \return Returns
299  * #MSG_OK if the task was successfully received,
300  * #MSG_HOST_FAILURE, or #MSG_TRANSFER_FAILURE, or #MSG_TIMEOUT otherwise.
301  */
302 msg_error_t
303 MSG_task_receive_with_timeout_bounded(msg_task_t * task, const char *alias,
304                                       double timeout,double rate)
305 {
306   return MSG_task_receive_ext_bounded(task, alias, timeout, NULL, rate);
307 }
308
309 /** \ingroup msg_task_usage
310  * \brief Receives a task from a mailbox from a specific host with a given timeout.
311  *
312  * This is a blocking function with a timeout, the execution flow will be blocked
313  * until the task is received or the timeout is achieved. See #MSG_task_irecv
314  * for receiving tasks asynchronously. You can provide a -1 timeout
315  * to obtain an infinite timeout.
316  *
317  * \param task a memory location for storing a #msg_task_t.
318  * \param alias name of the mailbox to receive the task from
319  * \param timeout is the maximum wait time for completion (provide -1 for no timeout)
320  * \param host a #msg_host_t host from where the task was sent
321  *
322  * \return Returns
323  * #MSG_OK if the task was successfully received,
324 * #MSG_HOST_FAILURE, or #MSG_TRANSFER_FAILURE, or #MSG_TIMEOUT otherwise.
325  */
326 msg_error_t
327 MSG_task_receive_ext(msg_task_t * task, const char *alias, double timeout,
328                      msg_host_t host)
329 {
330   xbt_ex_t e;
331   msg_error_t ret = MSG_OK;
332   XBT_DEBUG
333       ("MSG_task_receive_ext: Trying to receive a message on mailbox '%s'",
334        alias);
335   TRY {
336     ret = MSG_mailbox_get_task_ext(MSG_mailbox_get_by_alias(alias), task,
337                                    host, timeout);
338   }
339   CATCH(e) {
340     switch (e.category) {
341     case host_error:
342       ret = MSG_HOST_FAILURE;
343     case cancel_error:          /* may be thrown by MSG_mailbox_get_by_alias */
344       ret = MSG_HOST_FAILURE;
345       break;
346     default:
347       RETHROW;
348     }
349     xbt_ex_free(e);
350   }
351   return ret;
352 }
353
354 /** \ingroup msg_task_usage
355  * \brief Receives a task from a mailbox from a specific host with a given timeout
356  *  and at a given rate.
357  *
358  * \param task a memory location for storing a #msg_task_t.
359  * \param alias name of the mailbox to receive the task from
360  * \param timeout is the maximum wait time for completion (provide -1 for no timeout)
361  * \param host a #msg_host_t host from where the task was sent
362  * \param rate limit the reception to rate bandwidth
363  *
364  * \return Returns
365  * #MSG_OK if the task was successfully received,
366 * #MSG_HOST_FAILURE, or #MSG_TRANSFER_FAILURE, or #MSG_TIMEOUT otherwise.
367  */
368 msg_error_t
369 MSG_task_receive_ext_bounded(msg_task_t * task, const char *alias, double timeout,
370                              msg_host_t host, double rate)
371 {
372   XBT_DEBUG
373       ("MSG_task_receive_ext: Trying to receive a message on mailbox '%s'",
374        alias);
375   return MSG_mailbox_get_task_ext_bounded(MSG_mailbox_get_by_alias(alias), task,
376                                           host, timeout, rate);
377 }
378
379 /* Internal function used to factorize code between
380  * MSG_task_isend_with_matching() and MSG_task_dsend().
381  */
382 static XBT_INLINE
383 msg_comm_t MSG_task_isend_internal(msg_task_t task, const char *alias,
384                                    int (*match_fun)(void*,void*, smx_synchro_t),
385                                    void *match_data, void_f_pvoid_t cleanup,
386                                    int detached)
387 {
388   simdata_task_t t_simdata = NULL;
389   msg_process_t process = MSG_process_self();
390   msg_mailbox_t mailbox = MSG_mailbox_get_by_alias(alias);
391   int call_end = TRACE_msg_task_put_start(task);
392
393   /* Prepare the task to send */
394   t_simdata = task->simdata;
395   t_simdata->sender = process;
396   t_simdata->source = ((simdata_process_t) SIMIX_process_self_get_data(process))->m_host;
397
398   if (t_simdata->isused != 0) {
399     if (msg_global->debug_multiple_use){
400       XBT_ERROR("This task is already used in there:");
401       xbt_backtrace_display(t_simdata->isused);
402       XBT_ERROR("And you try to reuse it from here:");
403       xbt_backtrace_display_current();
404     } else {
405       xbt_assert(t_simdata->isused == 0,
406                  "This task is still being used somewhere else. You cannot send it now. Go fix your code! (use --cfg=msg/debug_multiple_use:on to get the backtrace of the other process)");
407     }
408   }
409
410   if (msg_global->debug_multiple_use)
411     MSG_BT(t_simdata->isused, "Using Backtrace");
412   else
413     t_simdata->isused = (void*)1;
414   t_simdata->comm = NULL;
415   msg_global->sent_msg++;
416
417   /* Send it by calling SIMIX network layer */
418   smx_synchro_t act = simcall_comm_isend(SIMIX_process_self(), mailbox, t_simdata->bytes_amount,
419                                         t_simdata->rate, task, sizeof(void *),
420                                         match_fun, cleanup, NULL, match_data,detached);
421   t_simdata->comm = act; /* FIXME: is the field t_simdata->comm still useful? */
422
423   msg_comm_t comm;
424   if (detached) {
425     comm = NULL;
426   } else {
427     comm = xbt_new0(s_msg_comm_t, 1);
428     comm->task_sent = task;
429     comm->task_received = NULL;
430     comm->status = MSG_OK;
431     comm->s_comm = act;
432   }
433
434   if (TRACE_is_enabled())
435     simcall_set_category(act, task->category);
436   if (call_end)
437     TRACE_msg_task_put_end();
438
439   return comm;
440 }
441
442
443 /** \ingroup msg_task_usage
444  * \brief Sends a task on a mailbox.
445  *
446  * This is a non blocking function: use MSG_comm_wait() or MSG_comm_test()
447  * to end the communication.
448  *
449  * \param task a #msg_task_t to send on another location.
450  * \param alias name of the mailbox to sent the task to
451  * \return the msg_comm_t communication created
452  */
453 msg_comm_t MSG_task_isend(msg_task_t task, const char *alias)
454 {
455   return MSG_task_isend_internal(task, alias, NULL, NULL, NULL, 0);
456 }
457
458 /** \ingroup msg_task_usage
459  * \brief Sends a task on a mailbox with a maximum rate
460  *
461  * This is a non blocking function: use MSG_comm_wait() or MSG_comm_test()
462  * to end the communication. The maxrate parameter allows the application
463  * to limit the bandwidth utilization of network links when sending the task.
464  *
465  * \param task a #msg_task_t to send on another location.
466  * \param alias name of the mailbox to sent the task to
467  * \param maxrate the maximum communication rate for sending this task .
468  * \return the msg_comm_t communication created
469  */
470 msg_comm_t MSG_task_isend_bounded(msg_task_t task, const char *alias,
471                                   double maxrate)
472 {
473   task->simdata->rate = maxrate;
474   return MSG_task_isend_internal(task, alias, NULL, NULL, NULL, 0);
475 }
476
477
478 /** \ingroup msg_task_usage
479  * \brief Sends a task on a mailbox, with support for matching requests
480  *
481  * This is a non blocking function: use MSG_comm_wait() or MSG_comm_test()
482  * to end the communication.
483  *
484  * \param task a #msg_task_t to send on another location.
485  * \param alias name of the mailbox to sent the task to
486  * \param match_fun boolean function which parameters are:
487  *        - match_data_provided_here
488  *        - match_data_provided_by_other_side_if_any
489  *        - the_smx_synchro_describing_the_other_side
490  * \param match_data user provided data passed to match_fun
491  * \return the msg_comm_t communication created
492  */
493 msg_comm_t MSG_task_isend_with_matching(msg_task_t task, const char *alias,
494                                         int (*match_fun)(void*, void*,
495                                                          smx_synchro_t),
496                                         void *match_data)
497 {
498   return MSG_task_isend_internal(task, alias, match_fun, match_data, NULL, 0);
499 }
500
501 /** \ingroup msg_task_usage
502  * \brief Sends a task on a mailbox.
503  *
504  * This is a non blocking detached send function.
505  * Think of it as a best effort send. Keep in mind that the third parameter
506  * is only called if the communication fails. If the communication does work,
507  * it is responsibility of the receiver code to free anything related to
508  * the task, as usual. More details on this can be obtained on
509  * <a href="http://lists.gforge.inria.fr/pipermail/simgrid-user/2011-November/002649.html">this thread</a>
510  * in the SimGrid-user mailing list archive.
511  *
512  * \param task a #msg_task_t to send on another location.
513  * \param alias name of the mailbox to sent the task to
514  * \param cleanup a function to destroy the task if the
515  * communication fails, e.g. MSG_task_destroy
516  * (if NULL, no function will be called)
517  */
518 void MSG_task_dsend(msg_task_t task, const char *alias, void_f_pvoid_t cleanup)
519 {
520   MSG_task_isend_internal(task, alias, NULL, NULL, cleanup, 1);
521 }
522
523 /** \ingroup msg_task_usage
524  * \brief Sends a task on a mailbox with a maximal rate.
525  *
526  * This is a non blocking detached send function.
527  * Think of it as a best effort send. Keep in mind that the third parameter
528  * is only called if the communication fails. If the communication does work,
529  * it is responsibility of the receiver code to free anything related to
530  * the task, as usual. More details on this can be obtained on
531  * <a href="http://lists.gforge.inria.fr/pipermail/simgrid-user/2011-November/002649.html">this thread</a>
532  * in the SimGrid-user mailing list archive.
533  *
534  * \param task a #msg_task_t to send on another location.
535  * \param alias name of the mailbox to sent the task to
536  * \param cleanup a function to destroy the task if the
537  * communication fails, e.g. MSG_task_destroy
538  * (if NULL, no function will be called)
539  * \param maxrate the maximum communication rate for sending this task
540  *
541  */
542 void MSG_task_dsend_bounded(msg_task_t task, const char *alias,
543                             void_f_pvoid_t cleanup, double maxrate)
544 {
545   task->simdata->rate = maxrate;
546   MSG_task_dsend(task, alias, cleanup);
547 }
548
549 /** \ingroup msg_task_usage
550  * \brief Starts listening for receiving a task from an asynchronous communication.
551  *
552  * This is a non blocking function: use MSG_comm_wait() or MSG_comm_test()
553  * to end the communication.
554  *
555  * \param task a memory location for storing a #msg_task_t. has to be valid until the end of the communication.
556  * \param name of the mailbox to receive the task on
557  * \return the msg_comm_t communication created
558  */
559 msg_comm_t MSG_task_irecv(msg_task_t *task, const char *name)
560 {
561   return MSG_task_irecv_bounded(task, name, -1.0);
562 }
563
564 /** \ingroup msg_task_usage
565  * \brief Starts listening for receiving a task from an asynchronous communication
566  * at a given rate.
567  *
568  * \param task a memory location for storing a #msg_task_t. has to be valid until the end of the communication.
569  * \param name of the mailbox to receive the task on
570  * \param rate limit the bandwidth to the given rate
571  * \return the msg_comm_t communication created
572  */
573 msg_comm_t MSG_task_irecv_bounded(msg_task_t *task, const char *name,
574                                   double rate)
575 {
576   smx_rdv_t rdv = MSG_mailbox_get_by_alias(name);
577
578   /* FIXME: these functions are not traceable */
579
580   /* Sanity check */
581   xbt_assert(task, "Null pointer for the task storage");
582
583   if (*task)
584     XBT_CRITICAL
585         ("MSG_task_irecv() was asked to write in a non empty task struct.");
586
587   /* Try to receive it by calling SIMIX network layer */
588   msg_comm_t comm = xbt_new0(s_msg_comm_t, 1);
589   comm->task_sent = NULL;
590   comm->task_received = task;
591   comm->status = MSG_OK;
592   comm->s_comm = simcall_comm_irecv(rdv, task, NULL, NULL, NULL, NULL, rate);
593
594   return comm;
595 }
596
597 /** \ingroup msg_task_usage
598  * \brief Checks whether a communication is done, and if yes, finalizes it.
599  * \param comm the communication to test
600  * \return TRUE if the communication is finished
601  * (but it may have failed, use MSG_comm_get_status() to know its status)
602  * or FALSE if the communication is not finished yet
603  * If the status is FALSE, don't forget to use MSG_process_sleep() after the test.
604  */
605 int MSG_comm_test(msg_comm_t comm)
606 {
607   xbt_ex_t e;
608   int finished = 0;
609
610   TRY {
611     finished = simcall_comm_test(comm->s_comm);
612
613     if (finished && comm->task_received != NULL) {
614       /* I am the receiver */
615       if (msg_global->debug_multiple_use && (*comm->task_received)->simdata->isused!=0)
616         xbt_ex_free(*(xbt_ex_t*)(*comm->task_received)->simdata->isused);
617       (*comm->task_received)->simdata->isused = 0;
618     }
619   }
620   CATCH(e) {
621     switch (e.category) {
622       case network_error:
623         comm->status = MSG_TRANSFER_FAILURE;
624         finished = 1;
625         break;
626
627       case timeout_error:
628         comm->status = MSG_TIMEOUT;
629         finished = 1;
630         break;
631
632       default:
633         RETHROW;
634     }
635     xbt_ex_free(e);
636   }
637
638   return finished;
639 }
640
641 /** \ingroup msg_task_usage
642  * \brief This function checks if a communication is finished.
643  * \param comms a vector of communications
644  * \return the position of the finished communication if any
645  * (but it may have failed, use MSG_comm_get_status() to know its status),
646  * or -1 if none is finished
647  */
648 int MSG_comm_testany(xbt_dynar_t comms)
649 {
650   xbt_ex_t e;
651   int finished_index = -1;
652
653   /* create the equivalent dynar with SIMIX objects */
654   xbt_dynar_t s_comms = xbt_dynar_new(sizeof(smx_synchro_t), NULL);
655   msg_comm_t comm;
656   unsigned int cursor;
657   xbt_dynar_foreach(comms, cursor, comm) {
658     xbt_dynar_push(s_comms, &comm->s_comm);
659   }
660
661   msg_error_t status = MSG_OK;
662   TRY {
663     finished_index = simcall_comm_testany(s_comms);
664   }
665   CATCH(e) {
666     switch (e.category) {
667       case network_error:
668         finished_index = e.value;
669         status = MSG_TRANSFER_FAILURE;
670         break;
671
672       case timeout_error:
673         finished_index = e.value;
674         status = MSG_TIMEOUT;
675         break;
676
677       default:
678         RETHROW;
679     }
680     xbt_ex_free(e);
681   }
682   xbt_dynar_free(&s_comms);
683
684   if (finished_index != -1) {
685     comm = xbt_dynar_get_as(comms, finished_index, msg_comm_t);
686     /* the communication is finished */
687     comm->status = status;
688
689     if (status == MSG_OK && comm->task_received != NULL) {
690       /* I am the receiver */
691       if (msg_global->debug_multiple_use && (*comm->task_received)->simdata->isused!=0)
692         xbt_ex_free(*(xbt_ex_t*)(*comm->task_received)->simdata->isused);
693       (*comm->task_received)->simdata->isused = 0;
694     }
695   }
696
697   return finished_index;
698 }
699
700 /** \ingroup msg_task_usage
701  * \brief Destroys a communication.
702  * \param comm the communication to destroy.
703  */
704 void MSG_comm_destroy(msg_comm_t comm)
705 {
706   xbt_free(comm);
707 }
708
709 /** \ingroup msg_task_usage
710  * \brief Wait for the completion of a communication.
711  *
712  * It takes two parameters.
713  * \param comm the communication to wait.
714  * \param timeout Wait until the communication terminates or the timeout
715  * occurs. You can provide a -1 timeout to obtain an infinite timeout.
716  * \return msg_error_t
717  */
718 msg_error_t MSG_comm_wait(msg_comm_t comm, double timeout)
719 {
720   xbt_ex_t e;
721   TRY {
722     simcall_comm_wait(comm->s_comm, timeout);
723
724     if (comm->task_received != NULL) {
725       /* I am the receiver */
726       if (msg_global->debug_multiple_use && (*comm->task_received)->simdata->isused!=0)
727         xbt_ex_free(*(xbt_ex_t*)(*comm->task_received)->simdata->isused);
728       (*comm->task_received)->simdata->isused = 0;
729     }
730
731     /* FIXME: these functions are not traceable */
732   }
733   CATCH(e) {
734     switch (e.category) {
735     case network_error:
736       comm->status = MSG_TRANSFER_FAILURE;
737       break;
738     case timeout_error:
739       comm->status = MSG_TIMEOUT;
740       break;
741     default:
742       RETHROW;
743     }
744     xbt_ex_free(e);
745   }
746
747   return comm->status;
748 }
749
750 /** \ingroup msg_task_usage
751 * \brief This function is called by a sender and permit to wait for each communication
752 *
753 * \param comm a vector of communication
754 * \param nb_elem is the size of the comm vector
755 * \param timeout for each call of MSG_comm_wait
756 */
757 void MSG_comm_waitall(msg_comm_t * comm, int nb_elem, double timeout)
758 {
759   int i = 0;
760   for (i = 0; i < nb_elem; i++) {
761     MSG_comm_wait(comm[i], timeout);
762   }
763 }
764
765 /** \ingroup msg_task_usage
766  * \brief This function waits for the first communication finished in a list.
767  * \param comms a vector of communications
768  * \return the position of the first finished communication
769  * (but it may have failed, use MSG_comm_get_status() to know its status)
770  */
771 int MSG_comm_waitany(xbt_dynar_t comms)
772 {
773   xbt_ex_t e;
774   int finished_index = -1;
775
776   /* create the equivalent dynar with SIMIX objects */
777   xbt_dynar_t s_comms = xbt_dynar_new(sizeof(smx_synchro_t), NULL);
778   msg_comm_t comm;
779   unsigned int cursor;
780   xbt_dynar_foreach(comms, cursor, comm) {
781     xbt_dynar_push(s_comms, &comm->s_comm);
782   }
783
784   msg_error_t status = MSG_OK;
785   TRY {
786     finished_index = simcall_comm_waitany(s_comms);
787   }
788   CATCH(e) {
789     switch (e.category) {
790       case network_error:
791         finished_index = e.value;
792         status = MSG_TRANSFER_FAILURE;
793         break;
794
795       case timeout_error:
796         finished_index = e.value;
797         status = MSG_TIMEOUT;
798         break;
799
800       default:
801         RETHROW;
802     }
803     xbt_ex_free(e);
804   }
805
806   xbt_assert(finished_index != -1, "WaitAny returned -1");
807   xbt_dynar_free(&s_comms);
808
809   comm = xbt_dynar_get_as(comms, finished_index, msg_comm_t);
810   /* the communication is finished */
811   comm->status = status;
812
813   if (comm->task_received != NULL) {
814     /* I am the receiver */
815     if (msg_global->debug_multiple_use && (*comm->task_received)->simdata->isused!=0)
816       xbt_ex_free(*(xbt_ex_t*)(*comm->task_received)->simdata->isused);
817     (*comm->task_received)->simdata->isused = 0;
818   }
819
820   return finished_index;
821 }
822
823 /**
824  * \ingroup msg_task_usage
825  * \brief Returns the error (if any) that occured during a finished communication.
826  * \param comm a finished communication
827  * \return the status of the communication, or #MSG_OK if no error occured
828  * during the communication
829  */
830 msg_error_t MSG_comm_get_status(msg_comm_t comm) {
831
832   return comm->status;
833 }
834
835 /** \ingroup msg_task_usage
836  * \brief Get a task (#msg_task_t) from a communication
837  *
838  * \param comm the communication where to get the task
839  * \return the task from the communication
840  */
841 msg_task_t MSG_comm_get_task(msg_comm_t comm)
842 {
843   xbt_assert(comm, "Invalid parameter");
844
845   return comm->task_received ? *comm->task_received : comm->task_sent;
846 }
847
848 /**
849  * \brief This function is called by SIMIX in kernel mode to copy the data of a comm.
850  * \param comm the comm
851  * \param buff the data copied
852  * \param buff_size size of the buffer
853  */
854 void MSG_comm_copy_data_from_SIMIX(smx_synchro_t comm, void* buff, size_t buff_size) {
855
856   // copy the task
857   SIMIX_comm_copy_pointer_callback(comm, buff, buff_size);
858
859   // notify the user callback if any
860   if (msg_global->task_copy_callback) {
861     msg_task_t task = buff;
862     msg_global->task_copy_callback(task,
863         simcall_comm_get_src_proc(comm), simcall_comm_get_dst_proc(comm));
864   }
865 }
866
867 /** \ingroup msg_task_usage
868  * \brief Sends a task to a mailbox
869  *
870  * This is a blocking function, the execution flow will be blocked
871  * until the task is sent (and received in the other side if #MSG_task_receive is used).
872  * See #MSG_task_isend for sending tasks asynchronously.
873  *
874  * \param task the task to be sent
875  * \param alias the mailbox name to where the task is sent
876  *
877  * \return Returns #MSG_OK if the task was successfully sent,
878  * #MSG_HOST_FAILURE, or #MSG_TRANSFER_FAILURE otherwise.
879  */
880 msg_error_t MSG_task_send(msg_task_t task, const char *alias)
881 {
882   XBT_DEBUG("MSG_task_send: Trying to send a message on mailbox '%s'", alias);
883   return MSG_task_send_with_timeout(task, alias, -1);
884 }
885
886 /** \ingroup msg_task_usage
887  * \brief Sends a task to a mailbox with a maximum rate
888  *
889  * This is a blocking function, the execution flow will be blocked
890  * until the task is sent. The maxrate parameter allows the application
891  * to limit the bandwidth utilization of network links when sending the task.
892  *
893  * \param task the task to be sent
894  * \param alias the mailbox name to where the task is sent
895  * \param maxrate the maximum communication rate for sending this task
896  *
897  * \return Returns #MSG_OK if the task was successfully sent,
898  * #MSG_HOST_FAILURE, or #MSG_TRANSFER_FAILURE otherwise.
899  */
900 msg_error_t
901 MSG_task_send_bounded(msg_task_t task, const char *alias, double maxrate)
902 {
903   task->simdata->rate = maxrate;
904   return MSG_task_send(task, alias);
905 }
906
907 /** \ingroup msg_task_usage
908  * \brief Sends a task to a mailbox with a timeout
909  *
910  * This is a blocking function, the execution flow will be blocked
911  * until the task is sent or the timeout is achieved.
912  *
913  * \param task the task to be sent
914  * \param alias the mailbox name to where the task is sent
915  * \param timeout is the maximum wait time for completion (if -1, this call is the same as #MSG_task_send)
916  *
917  * \return Returns #MSG_OK if the task was successfully sent,
918  * #MSG_HOST_FAILURE, or #MSG_TRANSFER_FAILURE, or #MSG_TIMEOUT otherwise.
919  */
920 msg_error_t
921 MSG_task_send_with_timeout(msg_task_t task, const char *alias,
922                            double timeout)
923 {
924   return MSG_mailbox_put_with_timeout(MSG_mailbox_get_by_alias(alias),
925                                       task, timeout);
926 }
927
928 /** \ingroup msg_task_usage
929  * \brief Sends a task to a mailbox with a timeout and with a maximum rate
930  *
931  * This is a blocking function, the execution flow will be blocked
932  * until the task is sent or the timeout is achieved.
933  *
934  * \param task the task to be sent
935  * \param alias the mailbox name to where the task is sent
936  * \param timeout is the maximum wait time for completion (if -1, this call is the same as #MSG_task_send)
937  * \param maxrate the maximum communication rate for sending this task
938  *
939  * \return Returns #MSG_OK if the task was successfully sent,
940  * #MSG_HOST_FAILURE, or #MSG_TRANSFER_FAILURE, or #MSG_TIMEOUT otherwise.
941  */
942 msg_error_t
943 MSG_task_send_with_timeout_bounded(msg_task_t task, const char *alias,
944                            double timeout, double maxrate)
945 {
946   task->simdata->rate = maxrate;
947   return MSG_mailbox_put_with_timeout(MSG_mailbox_get_by_alias(alias),
948                                       task, timeout);
949 }
950
951 /** \ingroup msg_task_usage
952  * \brief Check if there is a communication going on in a mailbox.
953  *
954  * \param alias the name of the mailbox to be considered
955  *
956  * \return Returns 1 if there is a communication, 0 otherwise
957  */
958 int MSG_task_listen(const char *alias)
959 {
960   return !MSG_mailbox_is_empty(MSG_mailbox_get_by_alias(alias));
961 }
962
963 /** \ingroup msg_task_usage
964  * \brief Check the number of communication actions of a given host pending in a mailbox.
965  *
966  * \param alias the name of the mailbox to be considered
967  * \param host the host to check for communication
968  *
969  * \return Returns the number of pending communication actions of the host in the
970  * given mailbox, 0 if there is no pending communication actions.
971  *
972  */
973 int MSG_task_listen_from_host(const char *alias, msg_host_t host)
974 {
975   return
976       MSG_mailbox_get_count_host_waiting_tasks(MSG_mailbox_get_by_alias
977                                                (alias), host);
978 }
979
980 /** \ingroup msg_task_usage
981  * \brief Look if there is a communication on a mailbox and return the
982  * PID of the sender process.
983  *
984  * \param alias the name of the mailbox to be considered
985  *
986  * \return Returns the PID of sender process,
987  * -1 if there is no communication in the mailbox.
988  */
989 int MSG_task_listen_from(const char *alias)
990 {
991   msg_task_t task;
992
993   if (NULL ==
994       (task = MSG_mailbox_get_head(MSG_mailbox_get_by_alias(alias))))
995     return -1;
996
997   return MSG_process_get_PID(task->simdata->sender);
998 }
999
1000 /** \ingroup msg_task_usage
1001  * \brief Sets the tracing category of a task.
1002  *
1003  * This function should be called after the creation of
1004  * a MSG task, to define the category of that task. The
1005  * first parameter task must contain a task that was
1006  * created with the function #MSG_task_create. The second
1007  * parameter category must contain a category that was
1008  * previously declared with the function #TRACE_category
1009  * (or with #TRACE_category_with_color).
1010  *
1011  * See \ref tracing for details on how to trace
1012  * the (categorized) resource utilization.
1013  *
1014  * \param task the task that is going to be categorized
1015  * \param category the name of the category to be associated to the task
1016  *
1017  * \see MSG_task_get_category, TRACE_category, TRACE_category_with_color
1018  */
1019 void MSG_task_set_category (msg_task_t task, const char *category)
1020 {
1021   TRACE_msg_set_task_category (task, category);
1022 }
1023
1024 /** \ingroup msg_task_usage
1025  *
1026  * \brief Gets the current tracing category of a task.
1027  *
1028  * \param task the task to be considered
1029  *
1030  * \see MSG_task_set_category
1031  *
1032  * \return Returns the name of the tracing category of the given task, NULL otherwise
1033  */
1034 const char *MSG_task_get_category (msg_task_t task)
1035 {
1036   return task->category;
1037 }
1038
1039 /**
1040  * \brief Returns the value of a given AS or router property
1041  *
1042  * \param asr the name of a router or AS
1043  * \param name a property name
1044  * \return value of a property (or NULL if property not set)
1045  */
1046 const char *MSG_as_router_get_property_value(const char* asr, const char *name)
1047 {
1048   return xbt_dict_get_or_null(MSG_as_router_get_properties(asr), name);
1049 }
1050
1051 /**
1052  * \brief Returns a xbt_dict_t consisting of the list of properties assigned to
1053  * a the AS or router
1054  *
1055  * \param asr the name of a router or AS
1056  * \return a dict containing the properties
1057  */
1058 xbt_dict_t MSG_as_router_get_properties(const char* asr)
1059 {
1060   return (simcall_asr_get_properties(asr));
1061 }
1062
1063 /**
1064  * \brief Change the value of a given AS or router
1065  *
1066  * \param asr the name of a router or AS
1067  * \param name a property name
1068  * \param value what to change the property to
1069  * \param free_ctn the freeing function to use to kill the value on need
1070  */
1071 void MSG_as_router_set_property_value(const char* asr, const char *name, char *value,void_f_pvoid_t free_ctn) {
1072   xbt_dict_set(MSG_as_router_get_properties(asr), name, value,free_ctn);
1073 }
1074
1075 #ifdef MSG_USE_DEPRECATED
1076 /** \ingroup msg_deprecated_functions
1077  *
1078  * \brief Return the last value returned by a MSG function (except
1079  * MSG_get_errno...).
1080  */
1081 msg_error_t MSG_get_errno(void)
1082 {
1083   return PROCESS_GET_ERRNO();
1084 }
1085
1086 /** \ingroup msg_deprecated_functions
1087  * \brief Put a task on a channel of an host and waits for the end of the
1088  * transmission.
1089  *
1090  * This function is used for describing the behavior of a process. It
1091  * takes three parameter.
1092  * \param task a #msg_task_t to send on another location. This task
1093  will not be usable anymore when the function will return. There is
1094  no automatic task duplication and you have to save your parameters
1095  before calling this function. Tasks are unique and once it has been
1096  sent to another location, you should not access it anymore. You do
1097  not need to call MSG_task_destroy() but to avoid using, as an
1098  effect of inattention, this task anymore, you definitely should
1099  renitialize it with #MSG_TASK_UNINITIALIZED. Note that this task
1100  can be transfered iff it has been correctly created with
1101  MSG_task_create().
1102  * \param dest the destination of the message
1103  * \param channel the channel on which the process should put this
1104  task. This value has to be >=0 and < than the maximal number of
1105  channels fixed with MSG_set_channel_number().
1106  * \return #MSG_HOST_FAILURE if the host on which
1107  * this function was called was shut down,
1108  * #MSG_TRANSFER_FAILURE if the transfer could not be properly done
1109  * (network failure, dest failure) or #MSG_OK if it succeeded.
1110  */
1111 msg_error_t MSG_task_put(msg_task_t task, msg_host_t dest, m_channel_t channel)
1112 {
1113   XBT_WARN("DEPRECATED! Now use MSG_task_send");
1114   return MSG_task_put_with_timeout(task, dest, channel, -1.0);
1115 }
1116
1117 /** \ingroup msg_deprecated_functions
1118  * \brief Does exactly the same as MSG_task_put but with a bounded transmition
1119  * rate.
1120  *
1121  * \sa MSG_task_put
1122  */
1123 msg_error_t
1124 MSG_task_put_bounded(msg_task_t task, msg_host_t dest, m_channel_t channel,
1125                      double maxrate)
1126 {
1127   XBT_WARN("DEPRECATED! Now use MSG_task_send_bounded");
1128   task->simdata->rate = maxrate;
1129   return MSG_task_put(task, dest, channel);
1130 }
1131
1132 /** \ingroup msg_deprecated_functions
1133  *
1134  * \brief Put a task on a channel of an
1135  * host (with a timeout on the waiting of the destination host) and
1136  * waits for the end of the transmission.
1137  *
1138  * This function is used for describing the behavior of a process. It
1139  * takes four parameter.
1140  * \param task a #msg_task_t to send on another location. This task
1141  will not be usable anymore when the function will return. There is
1142  no automatic task duplication and you have to save your parameters
1143  before calling this function. Tasks are unique and once it has been
1144  sent to another location, you should not access it anymore. You do
1145  not need to call MSG_task_destroy() but to avoid using, as an
1146  effect of inattention, this task anymore, you definitely should
1147  renitialize it with #MSG_TASK_UNINITIALIZED. Note that this task
1148  can be transfered iff it has been correctly created with
1149  MSG_task_create().
1150  * \param dest the destination of the message
1151  * \param channel the channel on which the process should put this
1152  task. This value has to be >=0 and < than the maximal number of
1153  channels fixed with MSG_set_channel_number().
1154  * \param timeout the maximum time to wait for a task before giving
1155  up. In such a case, #MSG_TRANSFER_FAILURE will be returned, \a task
1156  will not be modified
1157  * \return #MSG_HOST_FAILURE if the host on which
1158 this function was called was shut down,
1159 #MSG_TRANSFER_FAILURE if the transfer could not be properly done
1160 (network failure, dest failure, timeout...) or #MSG_OK if the communication succeeded.
1161  */
1162 msg_error_t
1163 MSG_task_put_with_timeout(msg_task_t task, msg_host_t dest,
1164                           m_channel_t channel, double timeout)
1165 {
1166   XBT_WARN("DEPRECATED! Now use MSG_task_send_with_timeout");
1167   xbt_assert((channel >= 0)
1168               && (channel < msg_global->max_channel), "Invalid channel %d",
1169               channel);
1170
1171   XBT_DEBUG("MSG_task_put_with_timout: Trying to send a task to '%s'", MSG_host_get_name(dest));
1172   return
1173       MSG_mailbox_put_with_timeout(MSG_mailbox_get_by_channel
1174                                    (dest, channel), task, timeout);
1175 }
1176
1177 /** \ingroup msg_deprecated_functions
1178  * \brief Test whether there is a pending communication on a channel, and who sent it.
1179  *
1180  * It takes one parameter.
1181  * \param channel the channel on which the process should be
1182  listening. This value has to be >=0 and < than the maximal
1183  number of channels fixed with MSG_set_channel_number().
1184  * \return -1 if there is no pending communication and the PID of the process who sent it otherwise
1185  */
1186 int MSG_task_probe_from(m_channel_t channel)
1187 {
1188   XBT_WARN("DEPRECATED! Now use MSG_task_listen_from");
1189   msg_task_t task;
1190
1191   xbt_assert((channel >= 0)
1192               && (channel < msg_global->max_channel), "Invalid channel %d",
1193               channel);
1194
1195   if (NULL ==
1196       (task =
1197        MSG_mailbox_get_head(MSG_mailbox_get_by_channel
1198                             (MSG_host_self(), channel))))
1199     return -1;
1200
1201   return MSG_process_get_PID(task->simdata->sender);
1202 }
1203
1204 /** \ingroup msg_deprecated_functions
1205  * \brief Test whether there is a pending communication on a channel.
1206  *
1207  * It takes one parameter.
1208  * \param channel the channel on which the process should be
1209  listening. This value has to be >=0 and < than the maximal
1210  number of channels fixed with MSG_set_channel_number().
1211  * \return 1 if there is a pending communication and 0 otherwise
1212  */
1213 int MSG_task_Iprobe(m_channel_t channel)
1214 {
1215   XBT_WARN("DEPRECATED!");
1216   xbt_assert((channel >= 0)
1217               && (channel < msg_global->max_channel), "Invalid channel %d",
1218               channel);
1219
1220   return
1221       !MSG_mailbox_is_empty(MSG_mailbox_get_by_channel
1222                             (MSG_host_self(), channel));
1223 }
1224
1225 /** \ingroup msg_deprecated_functions
1226
1227  * \brief Return the number of tasks waiting to be received on a \a
1228  channel and sent by \a host.
1229  *
1230  * It takes two parameters.
1231  * \param channel the channel on which the process should be
1232  listening. This value has to be >=0 and < than the maximal
1233  number of channels fixed with MSG_set_channel_number().
1234  * \param host the host that is to be watched.
1235  * \return the number of tasks waiting to be received on \a channel
1236  and sent by \a host.
1237  */
1238 int MSG_task_probe_from_host(int channel, msg_host_t host)
1239 {
1240   XBT_WARN("DEPRECATED! Now use MSG_task_listen_from_host");
1241   xbt_assert((channel >= 0)
1242               && (channel < msg_global->max_channel), "Invalid channel %d",
1243               channel);
1244
1245   return
1246       MSG_mailbox_get_count_host_waiting_tasks(MSG_mailbox_get_by_channel
1247                                                (MSG_host_self(), channel),
1248                                                host);
1249
1250 }
1251
1252 /** \ingroup msg_deprecated_functions
1253  * \brief Listen on \a channel and waits for receiving a task from \a host.
1254  *
1255  * It takes three parameters.
1256  * \param task a memory location for storing a #msg_task_t. It will
1257  hold a task when this function will return. Thus \a task should not
1258  be equal to \c NULL and \a *task should be equal to \c NULL. If one of
1259  those two condition does not hold, there will be a warning message.
1260  * \param channel the channel on which the process should be
1261  listening. This value has to be >=0 and < than the maximal
1262  number of channels fixed with MSG_set_channel_number().
1263  * \param host the host that is to be watched.
1264  * \return a #msg_error_t indicating whether the operation was successful (#MSG_OK), or why it failed otherwise.
1265  */
1266 msg_error_t
1267 MSG_task_get_from_host(msg_task_t * task, m_channel_t channel, msg_host_t host)
1268 {
1269   XBT_WARN("DEPRECATED! Now use MSG_task_receive_from_host");
1270   return MSG_task_get_ext(task, channel, -1, host);
1271 }
1272
1273 /** \ingroup msg_deprecated_functions
1274  * \brief Listen on a channel and wait for receiving a task.
1275  *
1276  * It takes two parameters.
1277  * \param task a memory location for storing a #msg_task_t. It will
1278  hold a task when this function will return. Thus \a task should not
1279  be equal to \c NULL and \a *task should be equal to \c NULL. If one of
1280  those two condition does not hold, there will be a warning message.
1281  * \param channel the channel on which the process should be
1282  listening. This value has to be >=0 and < than the maximal
1283  number of channels fixed with MSG_set_channel_number().
1284  * \return a #msg_error_t indicating whether the operation was successful (#MSG_OK), or why it failed otherwise.
1285  */
1286 msg_error_t MSG_task_get(msg_task_t * task, m_channel_t channel)
1287 {
1288   XBT_WARN("DEPRECATED! Now use MSG_task_receive");
1289   return MSG_task_get_with_timeout(task, channel, -1);
1290 }
1291
1292 /** \ingroup msg_deprecated_functions
1293  * \brief Listen on a channel and wait for receiving a task with a timeout.
1294  *
1295  * It takes three parameters.
1296  * \param task a memory location for storing a #msg_task_t. It will
1297  hold a task when this function will return. Thus \a task should not
1298  be equal to \c NULL and \a *task should be equal to \c NULL. If one of
1299  those two condition does not hold, there will be a warning message.
1300  * \param channel the channel on which the process should be
1301  listening. This value has to be >=0 and < than the maximal
1302  number of channels fixed with MSG_set_channel_number().
1303  * \param max_duration the maximum time to wait for a task before giving
1304  up. In such a case, #MSG_TRANSFER_FAILURE will be returned, \a task
1305  will not be modified and will still be
1306  equal to \c NULL when returning.
1307  * \return a #msg_error_t indicating whether the operation was successful (#MSG_OK), or why it failed otherwise.
1308  */
1309 msg_error_t
1310 MSG_task_get_with_timeout(msg_task_t * task, m_channel_t channel,
1311                           double max_duration)
1312 {
1313   XBT_WARN("DEPRECATED! Now use MSG_task_receive_with_timeout");
1314   return MSG_task_get_ext(task, channel, max_duration, NULL);
1315 }
1316
1317 msg_error_t
1318 MSG_task_get_ext(msg_task_t * task, m_channel_t channel, double timeout,
1319                  msg_host_t host)
1320 {
1321   XBT_WARN("DEPRECATED! Now use MSG_task_receive_ext");
1322   xbt_assert((channel >= 0)
1323               && (channel < msg_global->max_channel), "Invalid channel %d",
1324               channel);
1325
1326   return
1327       MSG_mailbox_get_task_ext(MSG_mailbox_get_by_channel
1328                                (MSG_host_self(), channel), task, host,
1329                                timeout);
1330 }
1331
1332 #endif