Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
72eb74e9818dc0445f1718a335598ad427336d6f
[simgrid.git] / src / msg / msg_gos.c
1 /* Copyright (c) 2004-2012. 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 "msg_private.h"
7 #include "msg_mailbox.h"
8 #include "mc/mc.h"
9 #include "xbt/log.h"
10 #include "xbt/sysdep.h"
11
12 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(msg_gos, msg,
13                                 "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
19  * takes only one parameter.
20  * \param task a #msg_task_t to execute on the location on which the process is running.
21  * \return #MSG_OK if the task was successfully completed, #MSG_TASK_CANCELED
22  * or #MSG_HOST_FAILURE otherwise
23  */
24 MSG_error_t MSG_task_execute(msg_task_t task)
25 {
26   return MSG_parallel_task_execute(task);
27 }
28
29 /** \ingroup msg_task_usage
30  * \brief Executes a parallel task and waits for its termination.
31  *
32  * \param task a #msg_task_t to execute on the location on which the process is running.
33  *
34  * \return #MSG_OK if the task was successfully completed, #MSG_TASK_CANCELED
35  * or #MSG_HOST_FAILURE otherwise
36  */
37 MSG_error_t MSG_parallel_task_execute(msg_task_t task)
38 {
39   xbt_ex_t e;
40   simdata_task_t simdata = task->simdata;
41   msg_process_t self = SIMIX_process_self();
42   simdata_process_t p_simdata = SIMIX_process_self_get_data(self);
43   e_smx_state_t comp_state;
44   MSG_error_t status = MSG_OK;
45
46 #ifdef HAVE_TRACING
47   TRACE_msg_task_execute_start(task);
48 #endif
49
50   xbt_assert((!simdata->compute) && (task->simdata->isused == 0),
51              "This task is executed somewhere else. Go fix your code! %d",
52              task->simdata->isused);
53
54   XBT_DEBUG("Computing on %s", MSG_process_get_name(MSG_process_self()));
55
56   if (simdata->computation_amount == 0 && !simdata->host_nb) {
57 #ifdef HAVE_TRACING
58     TRACE_msg_task_execute_end(task);
59 #endif
60     return MSG_OK;
61   }
62
63
64   TRY {
65
66     simdata->isused=1;
67
68     if (simdata->host_nb > 0) {
69       simdata->compute = simcall_host_parallel_execute(task->name,
70                                                        simdata->host_nb,
71                                                        simdata->host_list,
72                                                        simdata->comp_amount,
73                                                        simdata->comm_amount,
74                                                        1.0, -1.0);
75       XBT_DEBUG("Parallel execution action created: %p", simdata->compute);
76     } else {
77       simdata->compute = simcall_host_execute(task->name,
78                                               p_simdata->m_host->smx_host,
79                                               simdata->computation_amount,
80                                               simdata->priority);
81
82     }
83 #ifdef HAVE_TRACING
84     simcall_set_category(simdata->compute, task->category);
85 #endif
86     p_simdata->waiting_action = simdata->compute;
87     comp_state = simcall_host_execution_wait(simdata->compute);
88
89     p_simdata->waiting_action = NULL;
90
91     simdata->isused=0;
92
93     XBT_DEBUG("Execution task '%s' finished in state %d",
94               task->name, (int)comp_state);
95   }
96   CATCH(e) {
97     switch (e.category) {
98     case cancel_error:
99       status = MSG_TASK_CANCELED;
100       break;
101     default:
102       RETHROW;
103     }
104     xbt_ex_free(e);
105   }
106   /* action ended, set comm and compute = NULL, the actions is already destroyed
107    * in the main function */
108   simdata->computation_amount = 0.0;
109   simdata->comm = NULL;
110   simdata->compute = NULL;
111 #ifdef HAVE_TRACING
112   TRACE_msg_task_execute_end(task);
113 #endif
114
115   MSG_RETURN(status);
116 }
117
118
119 /** \ingroup msg_task_usage
120  * \brief Sleep for the specified number of seconds
121  *
122  * Makes the current process sleep until \a time seconds have elapsed.
123  *
124  * \param nb_sec a number of second
125  */
126 MSG_error_t MSG_process_sleep(double nb_sec)
127 {
128   MSG_error_t status = MSG_OK;
129   /*msg_process_t proc = MSG_process_self();*/
130
131 #ifdef HAVE_TRACING
132   TRACE_msg_process_sleep_in(MSG_process_self());
133 #endif
134
135   /* create action to sleep */
136
137   /*proc->simdata->waiting_action = act_sleep;
138
139   FIXME: check if not setting the waiting_action breaks something on msg
140   
141   proc->simdata->waiting_action = NULL;*/
142
143   simcall_process_sleep(nb_sec);
144
145   #ifdef HAVE_TRACING
146     TRACE_msg_process_sleep_out(MSG_process_self());
147   #endif
148   MSG_RETURN(status);
149 }
150
151 /** \ingroup msg_task_usage
152  * \brief Deprecated function that used to receive a task from a mailbox from a specific host.
153  *
154  * Sorry, this function is not supported anymore. That wouldn't be
155  * impossible to reimplement it, but we are lacking the time to do so ourselves.
156  * If you need this functionality, you can either:
157  *
158  *  - implement the buffering mechanism on the user-level by queuing all messages
159  *    received in the mailbox that do not match your expectation
160  *  - change your application logic to leverage the mailboxes features. For example,
161  *    if you have A receiving messages from B and C, you could have A waiting on
162  *    mailbox "A" most of the time, but on "A#B" when it's waiting for specific
163  *    messages from B and "A#C" when waiting for messages from C. You could even get A
164  *    sometime waiting on all these mailboxes using @ref MSG_comm_waitany. You can find
165  *    an example of use of this function in the @ref MSG_examples section.
166  *  - Provide a proper patch to implement this functionality back in MSG. That wouldn't be
167  *    very difficult actually. Check the function @ref MSG_mailbox_get_task_ext. During its call to
168  *    simcall_comm_recv(), the 5th argument, match_fun, is NULL. Create a function that filters
169  *    messages according to the host (that you will pass as sixth argument to simcall_comm_recv()
170  *    and that your filtering function will receive as first parameter, and then, the filter could
171  *    simply compare the host names, for example. After sufficient testing, provide an example that
172  *    we could add to the distribution, and your first contribution to SimGrid is ready. Thanks in advance.
173  *
174  * \param task a memory location for storing a #msg_task_t.
175  * \param alias name of the mailbox to receive the task from
176  * \param host a #msg_host_t host from where the task was sent
177  *
178  * \return Returns
179  * #MSG_OK if the task was successfully received,
180  * #MSG_HOST_FAILURE, or #MSG_TRANSFER_FAILURE otherwise.
181  */
182 MSG_error_t
183 MSG_task_receive_from_host(msg_task_t * task, const char *alias,
184                            msg_host_t host)
185 {
186   return MSG_task_receive_ext(task, alias, -1, host);
187 }
188
189 /** \ingroup msg_task_usage
190  * \brief Receives a task from a mailbox.
191  *
192  * This is a blocking function, the execution flow will be blocked
193  * until the task is received. See #MSG_task_irecv
194  * for receiving tasks asynchronously.
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  *
199  * \return Returns
200  * #MSG_OK if the task was successfully received,
201  * #MSG_HOST_FAILURE, or #MSG_TRANSFER_FAILURE otherwise.
202  */
203 MSG_error_t MSG_task_receive(msg_task_t * task, const char *alias)
204 {
205   return MSG_task_receive_with_timeout(task, alias, -1);
206 }
207
208 /** \ingroup msg_task_usage
209  * \brief Receives a task from a mailbox with a given timeout.
210  *
211  * This is a blocking function with a timeout, the execution flow will be blocked
212  * until the task is received or the timeout is achieved. See #MSG_task_irecv
213  * for receiving tasks asynchronously.  You can provide a -1 timeout
214  * to obtain an infinite timeout.
215  *
216  * \param task a memory location for storing a #msg_task_t.
217  * \param alias name of the mailbox to receive the task from
218  * \param timeout is the maximum wait time for completion (if -1, this call is the same as #MSG_task_receive)
219  *
220  * \return Returns
221  * #MSG_OK if the task was successfully received,
222  * #MSG_HOST_FAILURE, or #MSG_TRANSFER_FAILURE, or #MSG_TIMEOUT otherwise.
223  */
224 MSG_error_t
225 MSG_task_receive_with_timeout(msg_task_t * task, const char *alias,
226                               double timeout)
227 {
228   return MSG_task_receive_ext(task, alias, timeout, NULL);
229 }
230
231 /** \ingroup msg_task_usage
232  * \brief Receives a task from a mailbox from a specific host with a given timeout.
233  *
234  * This is a blocking function with a timeout, the execution flow will be blocked
235  * until the task is received or the timeout is achieved. See #MSG_task_irecv
236  * for receiving tasks asynchronously. You can provide a -1 timeout
237  * to obtain an infinite timeout.
238  *
239  * \param task a memory location for storing a #msg_task_t.
240  * \param alias name of the mailbox to receive the task from
241  * \param timeout is the maximum wait time for completion (provide -1 for no timeout)
242  * \param host a #msg_host_t host from where the task was sent
243  *
244  * \return Returns
245  * #MSG_OK if the task was successfully received,
246 * #MSG_HOST_FAILURE, or #MSG_TRANSFER_FAILURE, or #MSG_TIMEOUT otherwise.
247  */
248 MSG_error_t
249 MSG_task_receive_ext(msg_task_t * task, const char *alias, double timeout,
250                      msg_host_t host)
251 {
252   XBT_DEBUG
253       ("MSG_task_receive_ext: Trying to receive a message on mailbox '%s'",
254        alias);
255   return MSG_mailbox_get_task_ext(MSG_mailbox_get_by_alias(alias), task,
256                                   host, timeout);
257 }
258
259 /** \ingroup msg_task_usage
260  * \brief Sends a task on a mailbox.
261  *
262  * This is a non blocking function: use MSG_comm_wait() or MSG_comm_test()
263  * to end the communication.
264  *
265  * \param task a #msg_task_t to send on another location.
266  * \param alias name of the mailbox to sent the task to
267  * \return the msg_comm_t communication created
268  */
269 msg_comm_t MSG_task_isend(msg_task_t task, const char *alias)
270 {
271   return MSG_task_isend_with_matching(task,alias,NULL,NULL);
272 }
273
274 /** \ingroup msg_task_usage
275  * \brief Sends a task on a mailbox, with support for matching requests
276  *
277  * This is a non blocking function: use MSG_comm_wait() or MSG_comm_test()
278  * to end the communication.
279  *
280  * \param task a #msg_task_t to send on another location.
281  * \param alias name of the mailbox to sent the task to
282  * \param match_fun boolean function which parameters are:
283  *        - match_data_provided_here
284  *        - match_data_provided_by_other_side_if_any
285  *        - the_smx_action_describing_the_other_side
286  * \param match_data user provided data passed to match_fun
287  * \return the msg_comm_t communication created
288  */
289 XBT_INLINE msg_comm_t MSG_task_isend_with_matching(msg_task_t task, const char *alias,
290     int (*match_fun)(void*,void*, smx_action_t),
291     void *match_data)
292 {
293   simdata_task_t t_simdata = NULL;
294   msg_process_t process = MSG_process_self();
295   msg_mailbox_t mailbox = MSG_mailbox_get_by_alias(alias);
296
297   /* FIXME: these functions are not traceable */
298
299   /* Prepare the task to send */
300   t_simdata = task->simdata;
301   t_simdata->sender = process;
302   t_simdata->source = ((simdata_process_t) SIMIX_process_self_get_data(process))->m_host;
303
304   xbt_assert(t_simdata->isused == 0,
305               "This task is still being used somewhere else. You cannot send it now. Go fix your code!");
306
307   t_simdata->isused = 1;
308   t_simdata->comm = NULL;
309   msg_global->sent_msg++;
310
311   /* Send it by calling SIMIX network layer */
312   msg_comm_t comm = xbt_new0(s_msg_comm_t, 1);
313   comm->task_sent = task;
314   comm->task_received = NULL;
315   comm->status = MSG_OK;
316   comm->s_comm =
317     simcall_comm_isend(mailbox, t_simdata->message_size,
318                          t_simdata->rate, task, sizeof(void *), match_fun, NULL, match_data, 0);
319   t_simdata->comm = comm->s_comm; /* FIXME: is the field t_simdata->comm still useful? */
320
321   return comm;
322 }
323
324 /** \ingroup msg_task_usage
325  * \brief Sends a task on a mailbox.
326  *
327  * This is a non blocking detached send function.
328  * Think of it as a best effort send. Keep in mind that the third parameter
329  * is only called if the communication fails. If the communication does work,
330  * it is responsibility of the receiver code to free anything related to
331  * the task, as usual. More details on this can be obtained on
332  * <a href="http://lists.gforge.inria.fr/pipermail/simgrid-user/2011-November/002649.html">this thread</a>
333  * in the SimGrid-user mailing list archive.
334  *
335  * \param task a #msg_task_t to send on another location.
336  * \param alias name of the mailbox to sent the task to
337  * \param cleanup a function to destroy the task if the
338  * communication fails, e.g. MSG_task_destroy
339  * (if NULL, no function will be called)
340  */
341 void MSG_task_dsend(msg_task_t task, const char *alias, void_f_pvoid_t cleanup)
342 {
343   simdata_task_t t_simdata = NULL;
344   msg_process_t process = MSG_process_self();
345   msg_mailbox_t mailbox = MSG_mailbox_get_by_alias(alias);
346
347   /* FIXME: these functions are not traceable */
348
349   /* Prepare the task to send */
350   t_simdata = task->simdata;
351   t_simdata->sender = process;
352   t_simdata->source = ((simdata_process_t) SIMIX_process_self_get_data(process))->m_host;
353
354   xbt_assert(t_simdata->isused == 0,
355               "This task is still being used somewhere else. You cannot send it now. Go fix your code!");
356
357   t_simdata->isused = 1;
358   t_simdata->comm = NULL;
359   msg_global->sent_msg++;
360
361   /* Send it by calling SIMIX network layer */
362   smx_action_t comm = simcall_comm_isend(mailbox, t_simdata->message_size,
363                        t_simdata->rate, task, sizeof(void *), NULL, cleanup, NULL, 1);
364   t_simdata->comm = comm;
365 }
366
367 /** \ingroup msg_task_usage
368  * \brief Starts listening for receiving a task from an asynchronous communication.
369  *
370  * This is a non blocking function: use MSG_comm_wait() or MSG_comm_test()
371  * to end the communication.
372  * 
373  * \param task a memory location for storing a #msg_task_t. has to be valid until the end of the communication.
374  * \param name of the mailbox to receive the task on
375  * \return the msg_comm_t communication created
376  */
377 msg_comm_t MSG_task_irecv(msg_task_t *task, const char *name)
378 {
379   smx_rdv_t rdv = MSG_mailbox_get_by_alias(name);
380
381   /* FIXME: these functions are not traceable */
382
383   /* Sanity check */
384   xbt_assert(task, "Null pointer for the task storage");
385
386   if (*task)
387     XBT_CRITICAL
388         ("MSG_task_irecv() was asked to write in a non empty task struct.");
389
390   /* Try to receive it by calling SIMIX network layer */
391   msg_comm_t comm = xbt_new0(s_msg_comm_t, 1);
392   comm->task_sent = NULL;
393   comm->task_received = task;
394   comm->status = MSG_OK;
395   comm->s_comm = simcall_comm_irecv(rdv, task, NULL, NULL, NULL);
396
397   return comm;
398 }
399
400 /** \ingroup msg_task_usage
401  * \brief Checks whether a communication is done, and if yes, finalizes it.
402  * \param comm the communication to test
403  * \return TRUE if the communication is finished
404  * (but it may have failed, use MSG_comm_get_status() to know its status)
405  * or FALSE if the communication is not finished yet
406  * If the status is FALSE, don't forget to use MSG_process_sleep() after the test.
407  */
408 int MSG_comm_test(msg_comm_t comm)
409 {
410   xbt_ex_t e;
411   int finished = 0;
412   TRY {
413     finished = simcall_comm_test(comm->s_comm);
414
415     if (finished && comm->task_received != NULL) {
416       /* I am the receiver */
417       (*comm->task_received)->simdata->isused = 0;
418     }
419   }
420   CATCH(e) {
421     switch (e.category) {
422       case network_error:
423         comm->status = MSG_TRANSFER_FAILURE;
424         finished = 1;
425         break;
426
427       case timeout_error:
428         comm->status = MSG_TIMEOUT;
429         finished = 1;
430         break;
431
432       default:
433         RETHROW;
434     }
435     xbt_ex_free(e);
436   }
437
438   return finished;
439 }
440
441 /** \ingroup msg_task_usage
442  * \brief This function checks if a communication is finished.
443  * \param comms a vector of communications
444  * \return the position of the finished communication if any
445  * (but it may have failed, use MSG_comm_get_status() to know its status),
446  * or -1 if none is finished
447  */
448 int MSG_comm_testany(xbt_dynar_t comms)
449 {
450   xbt_ex_t e;
451   int finished_index = -1;
452
453   /* create the equivalent dynar with SIMIX objects */
454   xbt_dynar_t s_comms = xbt_dynar_new(sizeof(smx_action_t), NULL);
455   msg_comm_t comm;
456   unsigned int cursor;
457   xbt_dynar_foreach(comms, cursor, comm) {
458     xbt_dynar_push(s_comms, &comm->s_comm);
459   }
460
461   MSG_error_t status = MSG_OK;
462   TRY {
463     finished_index = simcall_comm_testany(s_comms);
464   }
465   CATCH(e) {
466     switch (e.category) {
467       case network_error:
468         finished_index = e.value;
469         status = MSG_TRANSFER_FAILURE;
470         break;
471
472       case timeout_error:
473         finished_index = e.value;
474         status = MSG_TIMEOUT;
475         break;
476
477       default:
478         RETHROW;
479     }
480     xbt_ex_free(e);
481   }
482   xbt_dynar_free(&s_comms);
483
484   if (finished_index != -1) {
485     comm = xbt_dynar_get_as(comms, finished_index, msg_comm_t);
486     /* the communication is finished */
487     comm->status = status;
488
489     if (status == MSG_OK && comm->task_received != NULL) {
490       /* I am the receiver */
491       (*comm->task_received)->simdata->isused = 0;
492     }
493   }
494
495   return finished_index;
496 }
497
498 /** \ingroup msg_task_usage
499  * \brief Destroys a communication.
500  * \param comm the communication to destroy.
501  */
502 void MSG_comm_destroy(msg_comm_t comm)
503 {
504   xbt_free(comm);
505 }
506
507 /** \ingroup msg_task_usage
508  * \brief Wait for the completion of a communication.
509  *
510  * It takes two parameters.
511  * \param comm the communication to wait.
512  * \param timeout Wait until the communication terminates or the timeout 
513  * occurs. You can provide a -1 timeout to obtain an infinite timeout.
514  * \return MSG_error_t
515  */
516 MSG_error_t MSG_comm_wait(msg_comm_t comm, double timeout)
517 {
518   xbt_ex_t e;
519   TRY {
520     simcall_comm_wait(comm->s_comm, timeout);
521
522     if (comm->task_received != NULL) {
523       /* I am the receiver */
524       (*comm->task_received)->simdata->isused = 0;
525     }
526
527     /* FIXME: these functions are not traceable */
528   }
529   CATCH(e) {
530     switch (e.category) {
531     case network_error:
532       comm->status = MSG_TRANSFER_FAILURE;
533       break;
534     case timeout_error:
535       comm->status = MSG_TIMEOUT;
536       break;
537     default:
538       RETHROW;
539     }
540     xbt_ex_free(e);
541   }
542
543   return comm->status;
544 }
545
546 /** \ingroup msg_task_usage
547 * \brief This function is called by a sender and permit to wait for each communication
548 *
549 * \param comm a vector of communication
550 * \param nb_elem is the size of the comm vector
551 * \param timeout for each call of MSG_comm_wait
552 */
553 void MSG_comm_waitall(msg_comm_t * comm, int nb_elem, double timeout)
554 {
555   int i = 0;
556   for (i = 0; i < nb_elem; i++) {
557     MSG_comm_wait(comm[i], timeout);
558   }
559 }
560
561 /** \ingroup msg_task_usage
562  * \brief This function waits for the first communication finished in a list.
563  * \param comms a vector of communications
564  * \return the position of the first finished communication
565  * (but it may have failed, use MSG_comm_get_status() to know its status)
566  */
567 int MSG_comm_waitany(xbt_dynar_t comms)
568 {
569   xbt_ex_t e;
570   int finished_index = -1;
571
572   /* create the equivalent dynar with SIMIX objects */
573   xbt_dynar_t s_comms = xbt_dynar_new(sizeof(smx_action_t), NULL);
574   msg_comm_t comm;
575   unsigned int cursor;
576   xbt_dynar_foreach(comms, cursor, comm) {
577     xbt_dynar_push(s_comms, &comm->s_comm);
578   }
579
580   MSG_error_t status = MSG_OK;
581   TRY {
582     finished_index = simcall_comm_waitany(s_comms);
583   }
584   CATCH(e) {
585     switch (e.category) {
586       case network_error:
587         finished_index = e.value;
588         status = MSG_TRANSFER_FAILURE;
589         break;
590
591       case timeout_error:
592         finished_index = e.value;
593         status = MSG_TIMEOUT;
594         break;
595
596       default:
597         RETHROW;
598     }
599     xbt_ex_free(e);
600   }
601
602   xbt_assert(finished_index != -1, "WaitAny returned -1");
603   xbt_dynar_free(&s_comms);
604
605   comm = xbt_dynar_get_as(comms, finished_index, msg_comm_t);
606   /* the communication is finished */
607   comm->status = status;
608
609   if (comm->task_received != NULL) {
610     /* I am the receiver */
611     (*comm->task_received)->simdata->isused = 0;
612   }
613
614   return finished_index;
615 }
616
617 /**
618  * \ingroup msg_task_usage
619  * \brief Returns the error (if any) that occured during a finished communication.
620  * \param comm a finished communication
621  * \return the status of the communication, or #MSG_OK if no error occured
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 /** \ingroup msg_task_usage
630  * \brief Get a task (#msg_task_t) from a communication
631  *
632  * \param comm the communication where to get the task
633  * \return the task from the communication
634  */
635 msg_task_t MSG_comm_get_task(msg_comm_t comm)
636 {
637   xbt_assert(comm, "Invalid parameter");
638
639   return comm->task_received ? *comm->task_received : comm->task_sent;
640 }
641
642 /**
643  * \brief This function is called by SIMIX to copy the data of a comm.
644  * \param comm the comm
645  * \param buff the data copied
646  * \param buff_size size of the buffer
647  */
648 void MSG_comm_copy_data_from_SIMIX(smx_action_t comm, void* buff, size_t buff_size) {
649
650   // copy the task
651   SIMIX_comm_copy_pointer_callback(comm, buff, buff_size);
652
653   // notify the user callback if any
654   if (msg_global->task_copy_callback) {
655     msg_task_t task = buff;
656     msg_global->task_copy_callback(task,
657         simcall_comm_get_src_proc(comm), simcall_comm_get_dst_proc(comm));
658   }
659 }
660
661 /** \ingroup msg_task_usage
662  * \brief Sends a task to a mailbox
663  *
664  * This is a blocking function, the execution flow will be blocked
665  * until the task is sent (and received in the other side if #MSG_task_receive is used).
666  * See #MSG_task_isend for sending tasks asynchronously.
667  *
668  * \param task the task to be sent
669  * \param alias the mailbox name to where the task is sent
670  *
671  * \return Returns #MSG_OK if the task was successfully sent,
672  * #MSG_HOST_FAILURE, or #MSG_TRANSFER_FAILURE otherwise.
673  */
674 MSG_error_t MSG_task_send(msg_task_t task, const char *alias)
675 {
676   XBT_DEBUG("MSG_task_send: Trying to send a message on mailbox '%s'", alias);
677   return MSG_task_send_with_timeout(task, alias, -1);
678 }
679
680 /** \ingroup msg_task_usage
681  * \brief Sends a task to a mailbox with a maximum rate
682  *
683  * This is a blocking function, the execution flow will be blocked
684  * until the task is sent. The maxrate parameter allows the application
685  * to limit the bandwidth utilization of network links when sending the task.
686  *
687  * \param task the task to be sent
688  * \param alias the mailbox name to where the task is sent
689  * \param maxrate the maximum communication rate for sending this task
690  *
691  * \return Returns #MSG_OK if the task was successfully sent,
692  * #MSG_HOST_FAILURE, or #MSG_TRANSFER_FAILURE otherwise.
693  */
694 MSG_error_t
695 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 /** \ingroup msg_task_usage
702  * \brief Sends a task to a mailbox with a timeout
703  *
704  * This is a blocking function, the execution flow will be blocked
705  * until the task is sent or the timeout is achieved.
706  *
707  * \param task the task to be sent
708  * \param alias the mailbox name to where the task is sent
709  * \param timeout is the maximum wait time for completion (if -1, this call is the same as #MSG_task_send)
710  *
711  * \return Returns #MSG_OK if the task was successfully sent,
712  * #MSG_HOST_FAILURE, or #MSG_TRANSFER_FAILURE, or #MSG_TIMEOUT otherwise.
713  */
714 MSG_error_t
715 MSG_task_send_with_timeout(msg_task_t task, const char *alias,
716                            double timeout)
717 {
718   return MSG_mailbox_put_with_timeout(MSG_mailbox_get_by_alias(alias),
719                                       task, timeout);
720 }
721
722 /** \ingroup msg_task_usage
723  * \brief Check if there is a communication going on in a mailbox.
724  *
725  * \param alias the name of the mailbox to be considered
726  *
727  * \return Returns 1 if there is a communication, 0 otherwise
728  */
729 int MSG_task_listen(const char *alias)
730 {
731   return !MSG_mailbox_is_empty(MSG_mailbox_get_by_alias(alias));
732 }
733
734 /** \ingroup msg_task_usage
735  * \brief Check the number of communication actions of a given host pending in a mailbox.
736  *
737  * \param alias the name of the mailbox to be considered
738  * \param host the host to check for communication
739  *
740  * \return Returns the number of pending communication actions of the host in the
741  * given mailbox, 0 if there is no pending communication actions.
742  *
743  */
744 int MSG_task_listen_from_host(const char *alias, msg_host_t host)
745 {
746   return
747       MSG_mailbox_get_count_host_waiting_tasks(MSG_mailbox_get_by_alias
748                                                (alias), host);
749 }
750
751 /** \ingroup msg_task_usage
752  * \brief Look if there is a communication on a mailbox and return the
753  * PID of the sender process.
754  *
755  * \param alias the name of the mailbox to be considered
756  *
757  * \return Returns the PID of sender process,
758  * -1 if there is no communication in the mailbox.
759  */
760 int MSG_task_listen_from(const char *alias)
761 {
762   msg_task_t task;
763
764   if (NULL ==
765       (task = MSG_mailbox_get_head(MSG_mailbox_get_by_alias(alias))))
766     return -1;
767
768   return MSG_process_get_PID(task->simdata->sender);
769 }
770
771 /** \ingroup msg_task_usage
772  * \brief Sets the tracing category of a task.
773  *
774  * This function should be called after the creation of
775  * a MSG task, to define the category of that task. The
776  * first parameter task must contain a task that was
777  * created with the function #MSG_task_create. The second
778  * parameter category must contain a category that was
779  * previously declared with the function #TRACE_category
780  * (or with #TRACE_category_with_color).
781  *
782  * See \ref tracing_tracing for details on how to trace
783  * the (categorized) resource utilization.
784  *
785  * \param task the task that is going to be categorized
786  * \param category the name of the category to be associated to the task
787  *
788  * \see MSG_task_get_category, TRACE_category, TRACE_category_with_color
789  */
790 void MSG_task_set_category (msg_task_t task, const char *category)
791 {
792 #ifdef HAVE_TRACING
793   TRACE_msg_set_task_category (task, category);
794 #endif
795 }
796
797 /** \ingroup msg_task_usage
798  *
799  * \brief Gets the current tracing category of a task.
800  *
801  * \param task the task to be considered
802  *
803  * \see MSG_task_set_category
804  *
805  * \return Returns the name of the tracing category of the given task, NULL otherwise
806  */
807 const char *MSG_task_get_category (msg_task_t task)
808 {
809 #ifdef HAVE_TRACING
810   return task->category;
811 #else
812   return NULL;
813 #endif
814 }
815
816 #ifdef MSG_USE_DEPRECATED
817 /** \ingroup msg_deprecated_functions
818  *
819  * \brief Return the last value returned by a MSG function (except
820  * MSG_get_errno...).
821  */
822 MSG_error_t MSG_get_errno(void)
823 {
824   return PROCESS_GET_ERRNO();
825 }
826
827 /** \ingroup msg_deprecated_functions
828  * \brief Put a task on a channel of an host and waits for the end of the
829  * transmission.
830  *
831  * This function is used for describing the behavior of a process. It
832  * takes three parameter.
833  * \param task a #msg_task_t to send on another location. This task
834  will not be usable anymore when the function will return. There is
835  no automatic task duplication and you have to save your parameters
836  before calling this function. Tasks are unique and once it has been
837  sent to another location, you should not access it anymore. You do
838  not need to call MSG_task_destroy() but to avoid using, as an
839  effect of inattention, this task anymore, you definitely should
840  renitialize it with #MSG_TASK_UNINITIALIZED. Note that this task
841  can be transfered iff it has been correctly created with
842  MSG_task_create().
843  * \param dest the destination of the message
844  * \param channel the channel on which the process should put this
845  task. This value has to be >=0 and < than the maximal number of
846  channels fixed with MSG_set_channel_number().
847  * \return #MSG_HOST_FAILURE if the host on which
848  * this function was called was shut down,
849  * #MSG_TRANSFER_FAILURE if the transfer could not be properly done
850  * (network failure, dest failure) or #MSG_OK if it succeeded.
851  */
852 MSG_error_t MSG_task_put(msg_task_t task, msg_host_t dest, m_channel_t channel)
853 {
854   XBT_WARN("DEPRECATED! Now use MSG_task_send");
855   return MSG_task_put_with_timeout(task, dest, channel, -1.0);
856 }
857
858 /** \ingroup msg_deprecated_functions
859  * \brief Does exactly the same as MSG_task_put but with a bounded transmition
860  * rate.
861  *
862  * \sa MSG_task_put
863  */
864 MSG_error_t
865 MSG_task_put_bounded(msg_task_t task, msg_host_t dest, m_channel_t channel,
866                      double maxrate)
867 {
868   XBT_WARN("DEPRECATED! Now use MSG_task_send_bounded");
869   task->simdata->rate = maxrate;
870   return MSG_task_put(task, dest, channel);
871 }
872
873 /** \ingroup msg_deprecated_functions
874  *
875  * \brief Put a task on a channel of an
876  * host (with a timeout on the waiting of the destination host) and
877  * waits for the end of the transmission.
878  *
879  * This function is used for describing the behavior of a process. It
880  * takes four parameter.
881  * \param task a #msg_task_t to send on another location. This task
882  will not be usable anymore when the function will return. There is
883  no automatic task duplication and you have to save your parameters
884  before calling this function. Tasks are unique and once it has been
885  sent to another location, you should not access it anymore. You do
886  not need to call MSG_task_destroy() but to avoid using, as an
887  effect of inattention, this task anymore, you definitely should
888  renitialize it with #MSG_TASK_UNINITIALIZED. Note that this task
889  can be transfered iff it has been correctly created with
890  MSG_task_create().
891  * \param dest the destination of the message
892  * \param channel the channel on which the process should put this
893  task. This value has to be >=0 and < than the maximal number of
894  channels fixed with MSG_set_channel_number().
895  * \param timeout the maximum time to wait for a task before giving
896  up. In such a case, #MSG_TRANSFER_FAILURE will be returned, \a task
897  will not be modified
898  * \return #MSG_HOST_FAILURE if the host on which
899 this function was called was shut down,
900 #MSG_TRANSFER_FAILURE if the transfer could not be properly done
901 (network failure, dest failure, timeout...) or #MSG_OK if the communication succeeded.
902  */
903 MSG_error_t
904 MSG_task_put_with_timeout(msg_task_t task, msg_host_t dest,
905                           m_channel_t channel, double timeout)
906 {
907   XBT_WARN("DEPRECATED! Now use MSG_task_send_with_timeout");
908   xbt_assert((channel >= 0)
909               && (channel < msg_global->max_channel), "Invalid channel %d",
910               channel);
911
912   XBT_DEBUG("MSG_task_put_with_timout: Trying to send a task to '%s'", SIMIX_host_get_name(dest->smx_host));
913   return
914       MSG_mailbox_put_with_timeout(MSG_mailbox_get_by_channel
915                                    (dest, channel), task, timeout);
916 }
917
918 /** \ingroup msg_deprecated_functions
919  * \brief Test whether there is a pending communication on a channel, and who sent it.
920  *
921  * It takes one parameter.
922  * \param channel the channel on which the process should be
923  listening. This value has to be >=0 and < than the maximal
924  number of channels fixed with MSG_set_channel_number().
925  * \return -1 if there is no pending communication and the PID of the process who sent it otherwise
926  */
927 int MSG_task_probe_from(m_channel_t channel)
928 {
929   XBT_WARN("DEPRECATED! Now use MSG_task_listen_from");
930   msg_task_t task;
931
932   xbt_assert((channel >= 0)
933               && (channel < msg_global->max_channel), "Invalid channel %d",
934               channel);
935
936   if (NULL ==
937       (task =
938        MSG_mailbox_get_head(MSG_mailbox_get_by_channel
939                             (MSG_host_self(), channel))))
940     return -1;
941
942   return MSG_process_get_PID(task->simdata->sender);
943 }
944
945 /** \ingroup msg_deprecated_functions
946  * \brief Test whether there is a pending communication on a channel.
947  *
948  * It takes one parameter.
949  * \param channel the channel on which the process should be
950  listening. This value has to be >=0 and < than the maximal
951  number of channels fixed with MSG_set_channel_number().
952  * \return 1 if there is a pending communication and 0 otherwise
953  */
954 int MSG_task_Iprobe(m_channel_t channel)
955 {
956   XBT_WARN("DEPRECATED!");
957   xbt_assert((channel >= 0)
958               && (channel < msg_global->max_channel), "Invalid channel %d",
959               channel);
960
961   return
962       !MSG_mailbox_is_empty(MSG_mailbox_get_by_channel
963                             (MSG_host_self(), channel));
964 }
965
966 /** \ingroup msg_deprecated_functions
967
968  * \brief Return the number of tasks waiting to be received on a \a
969  channel and sent by \a host.
970  *
971  * It takes two parameters.
972  * \param channel the channel on which the process should be
973  listening. This value has to be >=0 and < than the maximal
974  number of channels fixed with MSG_set_channel_number().
975  * \param host the host that is to be watched.
976  * \return the number of tasks waiting to be received on \a channel
977  and sent by \a host.
978  */
979 int MSG_task_probe_from_host(int channel, msg_host_t host)
980 {
981   XBT_WARN("DEPRECATED! Now use MSG_task_listen_from_host");
982   xbt_assert((channel >= 0)
983               && (channel < msg_global->max_channel), "Invalid channel %d",
984               channel);
985
986   return
987       MSG_mailbox_get_count_host_waiting_tasks(MSG_mailbox_get_by_channel
988                                                (MSG_host_self(), channel),
989                                                host);
990
991 }
992
993 /** \ingroup msg_deprecated_functions
994  * \brief Listen on \a channel and waits for receiving a task from \a host.
995  *
996  * It takes three parameters.
997  * \param task a memory location for storing a #msg_task_t. It will
998  hold a task when this function will return. Thus \a task should not
999  be equal to \c NULL and \a *task should be equal to \c NULL. If one of
1000  those two condition does not hold, there will be a warning message.
1001  * \param channel the channel on which the process should be
1002  listening. This value has to be >=0 and < than the maximal
1003  number of channels fixed with MSG_set_channel_number().
1004  * \param host the host that is to be watched.
1005  * \return a #MSG_error_t indicating whether the operation was successful (#MSG_OK), or why it failed otherwise.
1006  */
1007 MSG_error_t
1008 MSG_task_get_from_host(msg_task_t * task, m_channel_t channel, msg_host_t host)
1009 {
1010   XBT_WARN("DEPRECATED! Now use MSG_task_receive_from_host");
1011   return MSG_task_get_ext(task, channel, -1, host);
1012 }
1013
1014 /** \ingroup msg_deprecated_functions
1015  * \brief Listen on a channel and wait for receiving a task.
1016  *
1017  * It takes two parameters.
1018  * \param task a memory location for storing a #msg_task_t. It will
1019  hold a task when this function will return. Thus \a task should not
1020  be equal to \c NULL and \a *task should be equal to \c NULL. If one of
1021  those two condition does not hold, there will be a warning message.
1022  * \param channel the channel on which the process should be
1023  listening. This value has to be >=0 and < than the maximal
1024  number of channels fixed with MSG_set_channel_number().
1025  * \return a #MSG_error_t indicating whether the operation was successful (#MSG_OK), or why it failed otherwise.
1026  */
1027 MSG_error_t MSG_task_get(msg_task_t * task, m_channel_t channel)
1028 {
1029   XBT_WARN("DEPRECATED! Now use MSG_task_receive");
1030   return MSG_task_get_with_timeout(task, channel, -1);
1031 }
1032
1033 /** \ingroup msg_deprecated_functions
1034  * \brief Listen on a channel and wait for receiving a task with a timeout.
1035  *
1036  * It takes three parameters.
1037  * \param task a memory location for storing a #msg_task_t. It will
1038  hold a task when this function will return. Thus \a task should not
1039  be equal to \c NULL and \a *task should be equal to \c NULL. If one of
1040  those two condition does not hold, there will be a warning message.
1041  * \param channel the channel on which the process should be
1042  listening. This value has to be >=0 and < than the maximal
1043  number of channels fixed with MSG_set_channel_number().
1044  * \param max_duration the maximum time to wait for a task before giving
1045  up. In such a case, #MSG_TRANSFER_FAILURE will be returned, \a task
1046  will not be modified and will still be
1047  equal to \c NULL when returning.
1048  * \return a #MSG_error_t indicating whether the operation was successful (#MSG_OK), or why it failed otherwise.
1049  */
1050 MSG_error_t
1051 MSG_task_get_with_timeout(msg_task_t * task, m_channel_t channel,
1052                           double max_duration)
1053 {
1054   XBT_WARN("DEPRECATED! Now use MSG_task_receive_with_timeout");
1055   return MSG_task_get_ext(task, channel, max_duration, NULL);
1056 }
1057
1058 MSG_error_t
1059 MSG_task_get_ext(msg_task_t * task, m_channel_t channel, double timeout,
1060                  msg_host_t host)
1061 {
1062   XBT_WARN("DEPRECATED! Now use MSG_task_receive_ext");
1063   xbt_assert((channel >= 0)
1064               && (channel < msg_global->max_channel), "Invalid channel %d",
1065               channel);
1066
1067   return
1068       MSG_mailbox_get_task_ext(MSG_mailbox_get_by_channel
1069                                (MSG_host_self(), channel), task, host,
1070                                timeout);
1071 }
1072
1073 #endif