Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
fix a compilation warning/error in MSG_task_isend_with_matching instrumentation
[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 #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 #ifdef HAVE_TRACING
298   int call_end = TRACE_msg_task_put_start(task);
299 #endif
300
301   /* Prepare the task to send */
302   t_simdata = task->simdata;
303   t_simdata->sender = process;
304   t_simdata->source = ((simdata_process_t) SIMIX_process_self_get_data(process))->m_host;
305
306   xbt_assert(t_simdata->isused == 0,
307               "This task is still being used somewhere else. You cannot send it now. Go fix your code!");
308
309   t_simdata->isused = 1;
310   t_simdata->comm = NULL;
311   msg_global->sent_msg++;
312
313   /* Send it by calling SIMIX network layer */
314   msg_comm_t comm = xbt_new0(s_msg_comm_t, 1);
315   comm->task_sent = task;
316   comm->task_received = NULL;
317   comm->status = MSG_OK;
318   comm->s_comm =
319     simcall_comm_isend(mailbox, t_simdata->message_size,
320                          t_simdata->rate, task, sizeof(void *), match_fun, NULL, match_data, 0);
321   t_simdata->comm = comm->s_comm; /* FIXME: is the field t_simdata->comm still useful? */
322 #ifdef HAVE_TRACING
323     if (TRACE_is_enabled()) {
324       simcall_set_category(comm->s_comm, task->category);
325     }
326 #endif
327
328 #ifdef HAVE_TRACING
329   if (call_end)
330     TRACE_msg_task_put_end();
331 #endif
332
333   return comm;
334 }
335
336 /** \ingroup msg_task_usage
337  * \brief Sends a task on a mailbox.
338  *
339  * This is a non blocking detached send function.
340  * Think of it as a best effort send. Keep in mind that the third parameter
341  * is only called if the communication fails. If the communication does work,
342  * it is responsibility of the receiver code to free anything related to
343  * the task, as usual. More details on this can be obtained on
344  * <a href="http://lists.gforge.inria.fr/pipermail/simgrid-user/2011-November/002649.html">this thread</a>
345  * in the SimGrid-user mailing list archive.
346  *
347  * \param task a #msg_task_t to send on another location.
348  * \param alias name of the mailbox to sent the task to
349  * \param cleanup a function to destroy the task if the
350  * communication fails, e.g. MSG_task_destroy
351  * (if NULL, no function will be called)
352  */
353 void MSG_task_dsend(msg_task_t task, const char *alias, void_f_pvoid_t cleanup)
354 {
355   simdata_task_t t_simdata = NULL;
356   msg_process_t process = MSG_process_self();
357   msg_mailbox_t mailbox = MSG_mailbox_get_by_alias(alias);
358
359   /* Prepare the task to send */
360   t_simdata = task->simdata;
361   t_simdata->sender = process;
362   t_simdata->source = ((simdata_process_t) SIMIX_process_self_get_data(process))->m_host;
363
364   xbt_assert(t_simdata->isused == 0,
365               "This task is still being used somewhere else. You cannot send it now. Go fix your code!");
366
367   t_simdata->isused = 1;
368   t_simdata->comm = NULL;
369   msg_global->sent_msg++;
370
371 #ifdef HAVE_TRACING
372   int call_end = TRACE_msg_task_put_start(task);
373 #endif
374
375   /* Send it by calling SIMIX network layer */
376   smx_action_t comm = simcall_comm_isend(mailbox, t_simdata->message_size,
377                        t_simdata->rate, task, sizeof(void *), NULL, cleanup, NULL, 1);
378   t_simdata->comm = comm;
379 #ifdef HAVE_TRACING
380     if (TRACE_is_enabled()) {
381       simcall_set_category(comm, task->category);
382     }
383 #endif
384
385 #ifdef HAVE_TRACING
386   if (call_end)
387     TRACE_msg_task_put_end();
388 #endif
389 }
390
391 /** \ingroup msg_task_usage
392  * \brief Starts listening for receiving a task from an asynchronous communication.
393  *
394  * This is a non blocking function: use MSG_comm_wait() or MSG_comm_test()
395  * to end the communication.
396  * 
397  * \param task a memory location for storing a #msg_task_t. has to be valid until the end of the communication.
398  * \param name of the mailbox to receive the task on
399  * \return the msg_comm_t communication created
400  */
401 msg_comm_t MSG_task_irecv(msg_task_t *task, const char *name)
402 {
403   smx_rdv_t rdv = MSG_mailbox_get_by_alias(name);
404
405   /* FIXME: these functions are not traceable */
406
407   /* Sanity check */
408   xbt_assert(task, "Null pointer for the task storage");
409
410   if (*task)
411     XBT_CRITICAL
412         ("MSG_task_irecv() was asked to write in a non empty task struct.");
413
414   /* Try to receive it by calling SIMIX network layer */
415   msg_comm_t comm = xbt_new0(s_msg_comm_t, 1);
416   comm->task_sent = NULL;
417   comm->task_received = task;
418   comm->status = MSG_OK;
419   comm->s_comm = simcall_comm_irecv(rdv, task, NULL, NULL, NULL);
420
421   return comm;
422 }
423
424 /** \ingroup msg_task_usage
425  * \brief Checks whether a communication is done, and if yes, finalizes it.
426  * \param comm the communication to test
427  * \return TRUE if the communication is finished
428  * (but it may have failed, use MSG_comm_get_status() to know its status)
429  * or FALSE if the communication is not finished yet
430  * If the status is FALSE, don't forget to use MSG_process_sleep() after the test.
431  */
432 int MSG_comm_test(msg_comm_t comm)
433 {
434   xbt_ex_t e;
435   int finished = 0;
436   TRY {
437     finished = simcall_comm_test(comm->s_comm);
438
439     if (finished && comm->task_received != NULL) {
440       /* I am the receiver */
441       (*comm->task_received)->simdata->isused = 0;
442     }
443   }
444   CATCH(e) {
445     switch (e.category) {
446       case network_error:
447         comm->status = MSG_TRANSFER_FAILURE;
448         finished = 1;
449         break;
450
451       case timeout_error:
452         comm->status = MSG_TIMEOUT;
453         finished = 1;
454         break;
455
456       default:
457         RETHROW;
458     }
459     xbt_ex_free(e);
460   }
461
462   return finished;
463 }
464
465 /** \ingroup msg_task_usage
466  * \brief This function checks if a communication is finished.
467  * \param comms a vector of communications
468  * \return the position of the finished communication if any
469  * (but it may have failed, use MSG_comm_get_status() to know its status),
470  * or -1 if none is finished
471  */
472 int MSG_comm_testany(xbt_dynar_t comms)
473 {
474   xbt_ex_t e;
475   int finished_index = -1;
476
477   /* create the equivalent dynar with SIMIX objects */
478   xbt_dynar_t s_comms = xbt_dynar_new(sizeof(smx_action_t), NULL);
479   msg_comm_t comm;
480   unsigned int cursor;
481   xbt_dynar_foreach(comms, cursor, comm) {
482     xbt_dynar_push(s_comms, &comm->s_comm);
483   }
484
485   msg_error_t status = MSG_OK;
486   TRY {
487     finished_index = simcall_comm_testany(s_comms);
488   }
489   CATCH(e) {
490     switch (e.category) {
491       case network_error:
492         finished_index = e.value;
493         status = MSG_TRANSFER_FAILURE;
494         break;
495
496       case timeout_error:
497         finished_index = e.value;
498         status = MSG_TIMEOUT;
499         break;
500
501       default:
502         RETHROW;
503     }
504     xbt_ex_free(e);
505   }
506   xbt_dynar_free(&s_comms);
507
508   if (finished_index != -1) {
509     comm = xbt_dynar_get_as(comms, finished_index, msg_comm_t);
510     /* the communication is finished */
511     comm->status = status;
512
513     if (status == MSG_OK && comm->task_received != NULL) {
514       /* I am the receiver */
515       (*comm->task_received)->simdata->isused = 0;
516     }
517   }
518
519   return finished_index;
520 }
521
522 /** \ingroup msg_task_usage
523  * \brief Destroys a communication.
524  * \param comm the communication to destroy.
525  */
526 void MSG_comm_destroy(msg_comm_t comm)
527 {
528   xbt_free(comm);
529 }
530
531 /** \ingroup msg_task_usage
532  * \brief Wait for the completion of a communication.
533  *
534  * It takes two parameters.
535  * \param comm the communication to wait.
536  * \param timeout Wait until the communication terminates or the timeout 
537  * occurs. You can provide a -1 timeout to obtain an infinite timeout.
538  * \return msg_error_t
539  */
540 msg_error_t MSG_comm_wait(msg_comm_t comm, double timeout)
541 {
542   xbt_ex_t e;
543   TRY {
544     simcall_comm_wait(comm->s_comm, timeout);
545
546     if (comm->task_received != NULL) {
547       /* I am the receiver */
548       (*comm->task_received)->simdata->isused = 0;
549     }
550
551     /* FIXME: these functions are not traceable */
552   }
553   CATCH(e) {
554     switch (e.category) {
555     case network_error:
556       comm->status = MSG_TRANSFER_FAILURE;
557       break;
558     case timeout_error:
559       comm->status = MSG_TIMEOUT;
560       break;
561     default:
562       RETHROW;
563     }
564     xbt_ex_free(e);
565   }
566
567   return comm->status;
568 }
569
570 /** \ingroup msg_task_usage
571 * \brief This function is called by a sender and permit to wait for each communication
572 *
573 * \param comm a vector of communication
574 * \param nb_elem is the size of the comm vector
575 * \param timeout for each call of MSG_comm_wait
576 */
577 void MSG_comm_waitall(msg_comm_t * comm, int nb_elem, double timeout)
578 {
579   int i = 0;
580   for (i = 0; i < nb_elem; i++) {
581     MSG_comm_wait(comm[i], timeout);
582   }
583 }
584
585 /** \ingroup msg_task_usage
586  * \brief This function waits for the first communication finished in a list.
587  * \param comms a vector of communications
588  * \return the position of the first finished communication
589  * (but it may have failed, use MSG_comm_get_status() to know its status)
590  */
591 int MSG_comm_waitany(xbt_dynar_t comms)
592 {
593   xbt_ex_t e;
594   int finished_index = -1;
595
596   /* create the equivalent dynar with SIMIX objects */
597   xbt_dynar_t s_comms = xbt_dynar_new(sizeof(smx_action_t), NULL);
598   msg_comm_t comm;
599   unsigned int cursor;
600   xbt_dynar_foreach(comms, cursor, comm) {
601     xbt_dynar_push(s_comms, &comm->s_comm);
602   }
603
604   msg_error_t status = MSG_OK;
605   TRY {
606     finished_index = simcall_comm_waitany(s_comms);
607   }
608   CATCH(e) {
609     switch (e.category) {
610       case network_error:
611         finished_index = e.value;
612         status = MSG_TRANSFER_FAILURE;
613         break;
614
615       case timeout_error:
616         finished_index = e.value;
617         status = MSG_TIMEOUT;
618         break;
619
620       default:
621         RETHROW;
622     }
623     xbt_ex_free(e);
624   }
625
626   xbt_assert(finished_index != -1, "WaitAny returned -1");
627   xbt_dynar_free(&s_comms);
628
629   comm = xbt_dynar_get_as(comms, finished_index, msg_comm_t);
630   /* the communication is finished */
631   comm->status = status;
632
633   if (comm->task_received != NULL) {
634     /* I am the receiver */
635     (*comm->task_received)->simdata->isused = 0;
636   }
637
638   return finished_index;
639 }
640
641 /**
642  * \ingroup msg_task_usage
643  * \brief Returns the error (if any) that occured during a finished communication.
644  * \param comm a finished communication
645  * \return the status of the communication, or #MSG_OK if no error occured
646  * during the communication
647  */
648 msg_error_t MSG_comm_get_status(msg_comm_t comm) {
649
650   return comm->status;
651 }
652
653 /** \ingroup msg_task_usage
654  * \brief Get a task (#msg_task_t) from a communication
655  *
656  * \param comm the communication where to get the task
657  * \return the task from the communication
658  */
659 msg_task_t MSG_comm_get_task(msg_comm_t comm)
660 {
661   xbt_assert(comm, "Invalid parameter");
662
663   return comm->task_received ? *comm->task_received : comm->task_sent;
664 }
665
666 /**
667  * \brief This function is called by SIMIX to copy the data of a comm.
668  * \param comm the comm
669  * \param buff the data copied
670  * \param buff_size size of the buffer
671  */
672 void MSG_comm_copy_data_from_SIMIX(smx_action_t comm, void* buff, size_t buff_size) {
673
674   // copy the task
675   SIMIX_comm_copy_pointer_callback(comm, buff, buff_size);
676
677   // notify the user callback if any
678   if (msg_global->task_copy_callback) {
679     msg_task_t task = buff;
680     msg_global->task_copy_callback(task,
681         simcall_comm_get_src_proc(comm), simcall_comm_get_dst_proc(comm));
682   }
683 }
684
685 /** \ingroup msg_task_usage
686  * \brief Sends a task to a mailbox
687  *
688  * This is a blocking function, the execution flow will be blocked
689  * until the task is sent (and received in the other side if #MSG_task_receive is used).
690  * See #MSG_task_isend for sending tasks asynchronously.
691  *
692  * \param task the task to be sent
693  * \param alias the mailbox name to where the task is sent
694  *
695  * \return Returns #MSG_OK if the task was successfully sent,
696  * #MSG_HOST_FAILURE, or #MSG_TRANSFER_FAILURE otherwise.
697  */
698 msg_error_t MSG_task_send(msg_task_t task, const char *alias)
699 {
700   XBT_DEBUG("MSG_task_send: Trying to send a message on mailbox '%s'", alias);
701   return MSG_task_send_with_timeout(task, alias, -1);
702 }
703
704 /** \ingroup msg_task_usage
705  * \brief Sends a task to a mailbox with a maximum rate
706  *
707  * This is a blocking function, the execution flow will be blocked
708  * until the task is sent. The maxrate parameter allows the application
709  * to limit the bandwidth utilization of network links when sending the task.
710  *
711  * \param task the task to be sent
712  * \param alias the mailbox name to where the task is sent
713  * \param maxrate the maximum communication rate for sending this task
714  *
715  * \return Returns #MSG_OK if the task was successfully sent,
716  * #MSG_HOST_FAILURE, or #MSG_TRANSFER_FAILURE otherwise.
717  */
718 msg_error_t
719 MSG_task_send_bounded(msg_task_t task, const char *alias, double maxrate)
720 {
721   task->simdata->rate = maxrate;
722   return MSG_task_send(task, alias);
723 }
724
725 /** \ingroup msg_task_usage
726  * \brief Sends a task to a mailbox with a timeout
727  *
728  * This is a blocking function, the execution flow will be blocked
729  * until the task is sent or the timeout is achieved.
730  *
731  * \param task the task to be sent
732  * \param alias the mailbox name to where the task is sent
733  * \param timeout is the maximum wait time for completion (if -1, this call is the same as #MSG_task_send)
734  *
735  * \return Returns #MSG_OK if the task was successfully sent,
736  * #MSG_HOST_FAILURE, or #MSG_TRANSFER_FAILURE, or #MSG_TIMEOUT otherwise.
737  */
738 msg_error_t
739 MSG_task_send_with_timeout(msg_task_t task, const char *alias,
740                            double timeout)
741 {
742   return MSG_mailbox_put_with_timeout(MSG_mailbox_get_by_alias(alias),
743                                       task, timeout);
744 }
745
746 /** \ingroup msg_task_usage
747  * \brief Check if there is a communication going on in a mailbox.
748  *
749  * \param alias the name of the mailbox to be considered
750  *
751  * \return Returns 1 if there is a communication, 0 otherwise
752  */
753 int MSG_task_listen(const char *alias)
754 {
755   return !MSG_mailbox_is_empty(MSG_mailbox_get_by_alias(alias));
756 }
757
758 /** \ingroup msg_task_usage
759  * \brief Check the number of communication actions of a given host pending in a mailbox.
760  *
761  * \param alias the name of the mailbox to be considered
762  * \param host the host to check for communication
763  *
764  * \return Returns the number of pending communication actions of the host in the
765  * given mailbox, 0 if there is no pending communication actions.
766  *
767  */
768 int MSG_task_listen_from_host(const char *alias, msg_host_t host)
769 {
770   return
771       MSG_mailbox_get_count_host_waiting_tasks(MSG_mailbox_get_by_alias
772                                                (alias), host);
773 }
774
775 /** \ingroup msg_task_usage
776  * \brief Look if there is a communication on a mailbox and return the
777  * PID of the sender process.
778  *
779  * \param alias the name of the mailbox to be considered
780  *
781  * \return Returns the PID of sender process,
782  * -1 if there is no communication in the mailbox.
783  */
784 int MSG_task_listen_from(const char *alias)
785 {
786   msg_task_t task;
787
788   if (NULL ==
789       (task = MSG_mailbox_get_head(MSG_mailbox_get_by_alias(alias))))
790     return -1;
791
792   return MSG_process_get_PID(task->simdata->sender);
793 }
794
795 /** \ingroup msg_task_usage
796  * \brief Sets the tracing category of a task.
797  *
798  * This function should be called after the creation of
799  * a MSG task, to define the category of that task. The
800  * first parameter task must contain a task that was
801  * created with the function #MSG_task_create. The second
802  * parameter category must contain a category that was
803  * previously declared with the function #TRACE_category
804  * (or with #TRACE_category_with_color).
805  *
806  * See \ref tracing for details on how to trace
807  * the (categorized) resource utilization.
808  *
809  * \param task the task that is going to be categorized
810  * \param category the name of the category to be associated to the task
811  *
812  * \see MSG_task_get_category, TRACE_category, TRACE_category_with_color
813  */
814 void MSG_task_set_category (msg_task_t task, const char *category)
815 {
816 #ifdef HAVE_TRACING
817   TRACE_msg_set_task_category (task, category);
818 #endif
819 }
820
821 /** \ingroup msg_task_usage
822  *
823  * \brief Gets the current tracing category of a task.
824  *
825  * \param task the task to be considered
826  *
827  * \see MSG_task_set_category
828  *
829  * \return Returns the name of the tracing category of the given task, NULL otherwise
830  */
831 const char *MSG_task_get_category (msg_task_t task)
832 {
833 #ifdef HAVE_TRACING
834   return task->category;
835 #else
836   return NULL;
837 #endif
838 }
839
840 /**
841  * \brief Returns the value of a given AS or router property
842  *
843  * \param asr the name of a router or AS
844  * \param name a property name
845  * \return value of a property (or NULL if property not set)
846  */
847 const char *MSG_as_router_get_property_value(const char* asr, const char *name)
848 {
849   return xbt_dict_get_or_null(MSG_as_router_get_properties(asr), name);
850 }
851
852 /**
853  * \brief Returns a xbt_dict_t consisting of the list of properties assigned to
854  * a the AS or router
855  *
856  * \param asr the name of a router or AS
857  * \return a dict containing the properties
858  */
859 xbt_dict_t MSG_as_router_get_properties(const char* asr)
860 {
861   return (simcall_asr_get_properties(asr));
862 }
863
864 /**
865  * \brief Change the value of a given AS or router
866  *
867  * \param asr the name of a router or AS
868  * \param name a property name
869  * \param value what to change the property to
870  * \param free_ctn the freeing function to use to kill the value on need
871  */
872 void MSG_as_router_set_property_value(const char* asr, const char *name, char *value,void_f_pvoid_t free_ctn) {
873   xbt_dict_set(MSG_as_router_get_properties(asr), name, value,free_ctn);
874 }
875
876 #ifdef MSG_USE_DEPRECATED
877 /** \ingroup msg_deprecated_functions
878  *
879  * \brief Return the last value returned by a MSG function (except
880  * MSG_get_errno...).
881  */
882 msg_error_t MSG_get_errno(void)
883 {
884   return PROCESS_GET_ERRNO();
885 }
886
887 /** \ingroup msg_deprecated_functions
888  * \brief Put a task on a channel of an host and waits for the end of the
889  * transmission.
890  *
891  * This function is used for describing the behavior of a process. It
892  * takes three parameter.
893  * \param task a #msg_task_t to send on another location. This task
894  will not be usable anymore when the function will return. There is
895  no automatic task duplication and you have to save your parameters
896  before calling this function. Tasks are unique and once it has been
897  sent to another location, you should not access it anymore. You do
898  not need to call MSG_task_destroy() but to avoid using, as an
899  effect of inattention, this task anymore, you definitely should
900  renitialize it with #MSG_TASK_UNINITIALIZED. Note that this task
901  can be transfered iff it has been correctly created with
902  MSG_task_create().
903  * \param dest the destination of the message
904  * \param channel the channel on which the process should put this
905  task. This value has to be >=0 and < than the maximal number of
906  channels fixed with MSG_set_channel_number().
907  * \return #MSG_HOST_FAILURE if the host on which
908  * this function was called was shut down,
909  * #MSG_TRANSFER_FAILURE if the transfer could not be properly done
910  * (network failure, dest failure) or #MSG_OK if it succeeded.
911  */
912 msg_error_t MSG_task_put(msg_task_t task, msg_host_t dest, m_channel_t channel)
913 {
914   XBT_WARN("DEPRECATED! Now use MSG_task_send");
915   return MSG_task_put_with_timeout(task, dest, channel, -1.0);
916 }
917
918 /** \ingroup msg_deprecated_functions
919  * \brief Does exactly the same as MSG_task_put but with a bounded transmition
920  * rate.
921  *
922  * \sa MSG_task_put
923  */
924 msg_error_t
925 MSG_task_put_bounded(msg_task_t task, msg_host_t dest, m_channel_t channel,
926                      double maxrate)
927 {
928   XBT_WARN("DEPRECATED! Now use MSG_task_send_bounded");
929   task->simdata->rate = maxrate;
930   return MSG_task_put(task, dest, channel);
931 }
932
933 /** \ingroup msg_deprecated_functions
934  *
935  * \brief Put a task on a channel of an
936  * host (with a timeout on the waiting of the destination host) and
937  * waits for the end of the transmission.
938  *
939  * This function is used for describing the behavior of a process. It
940  * takes four parameter.
941  * \param task a #msg_task_t to send on another location. This task
942  will not be usable anymore when the function will return. There is
943  no automatic task duplication and you have to save your parameters
944  before calling this function. Tasks are unique and once it has been
945  sent to another location, you should not access it anymore. You do
946  not need to call MSG_task_destroy() but to avoid using, as an
947  effect of inattention, this task anymore, you definitely should
948  renitialize it with #MSG_TASK_UNINITIALIZED. Note that this task
949  can be transfered iff it has been correctly created with
950  MSG_task_create().
951  * \param dest the destination of the message
952  * \param channel the channel on which the process should put this
953  task. This value has to be >=0 and < than the maximal number of
954  channels fixed with MSG_set_channel_number().
955  * \param timeout the maximum time to wait for a task before giving
956  up. In such a case, #MSG_TRANSFER_FAILURE will be returned, \a task
957  will not be modified
958  * \return #MSG_HOST_FAILURE if the host on which
959 this function was called was shut down,
960 #MSG_TRANSFER_FAILURE if the transfer could not be properly done
961 (network failure, dest failure, timeout...) or #MSG_OK if the communication succeeded.
962  */
963 msg_error_t
964 MSG_task_put_with_timeout(msg_task_t task, msg_host_t dest,
965                           m_channel_t channel, double timeout)
966 {
967   XBT_WARN("DEPRECATED! Now use MSG_task_send_with_timeout");
968   xbt_assert((channel >= 0)
969               && (channel < msg_global->max_channel), "Invalid channel %d",
970               channel);
971
972   XBT_DEBUG("MSG_task_put_with_timout: Trying to send a task to '%s'", SIMIX_host_get_name(dest->smx_host));
973   return
974       MSG_mailbox_put_with_timeout(MSG_mailbox_get_by_channel
975                                    (dest, channel), task, timeout);
976 }
977
978 /** \ingroup msg_deprecated_functions
979  * \brief Test whether there is a pending communication on a channel, and who sent it.
980  *
981  * It takes one parameter.
982  * \param channel the channel on which the process should be
983  listening. This value has to be >=0 and < than the maximal
984  number of channels fixed with MSG_set_channel_number().
985  * \return -1 if there is no pending communication and the PID of the process who sent it otherwise
986  */
987 int MSG_task_probe_from(m_channel_t channel)
988 {
989   XBT_WARN("DEPRECATED! Now use MSG_task_listen_from");
990   msg_task_t task;
991
992   xbt_assert((channel >= 0)
993               && (channel < msg_global->max_channel), "Invalid channel %d",
994               channel);
995
996   if (NULL ==
997       (task =
998        MSG_mailbox_get_head(MSG_mailbox_get_by_channel
999                             (MSG_host_self(), channel))))
1000     return -1;
1001
1002   return MSG_process_get_PID(task->simdata->sender);
1003 }
1004
1005 /** \ingroup msg_deprecated_functions
1006  * \brief Test whether there is a pending communication on a channel.
1007  *
1008  * It takes one parameter.
1009  * \param channel the channel on which the process should be
1010  listening. This value has to be >=0 and < than the maximal
1011  number of channels fixed with MSG_set_channel_number().
1012  * \return 1 if there is a pending communication and 0 otherwise
1013  */
1014 int MSG_task_Iprobe(m_channel_t channel)
1015 {
1016   XBT_WARN("DEPRECATED!");
1017   xbt_assert((channel >= 0)
1018               && (channel < msg_global->max_channel), "Invalid channel %d",
1019               channel);
1020
1021   return
1022       !MSG_mailbox_is_empty(MSG_mailbox_get_by_channel
1023                             (MSG_host_self(), channel));
1024 }
1025
1026 /** \ingroup msg_deprecated_functions
1027
1028  * \brief Return the number of tasks waiting to be received on a \a
1029  channel and sent by \a host.
1030  *
1031  * It takes two parameters.
1032  * \param channel the channel on which the process should be
1033  listening. This value has to be >=0 and < than the maximal
1034  number of channels fixed with MSG_set_channel_number().
1035  * \param host the host that is to be watched.
1036  * \return the number of tasks waiting to be received on \a channel
1037  and sent by \a host.
1038  */
1039 int MSG_task_probe_from_host(int channel, msg_host_t host)
1040 {
1041   XBT_WARN("DEPRECATED! Now use MSG_task_listen_from_host");
1042   xbt_assert((channel >= 0)
1043               && (channel < msg_global->max_channel), "Invalid channel %d",
1044               channel);
1045
1046   return
1047       MSG_mailbox_get_count_host_waiting_tasks(MSG_mailbox_get_by_channel
1048                                                (MSG_host_self(), channel),
1049                                                host);
1050
1051 }
1052
1053 /** \ingroup msg_deprecated_functions
1054  * \brief Listen on \a channel and waits for receiving a task from \a host.
1055  *
1056  * It takes three parameters.
1057  * \param task a memory location for storing a #msg_task_t. It will
1058  hold a task when this function will return. Thus \a task should not
1059  be equal to \c NULL and \a *task should be equal to \c NULL. If one of
1060  those two condition does not hold, there will be a warning message.
1061  * \param channel the channel on which the process should be
1062  listening. This value has to be >=0 and < than the maximal
1063  number of channels fixed with MSG_set_channel_number().
1064  * \param host the host that is to be watched.
1065  * \return a #msg_error_t indicating whether the operation was successful (#MSG_OK), or why it failed otherwise.
1066  */
1067 msg_error_t
1068 MSG_task_get_from_host(msg_task_t * task, m_channel_t channel, msg_host_t host)
1069 {
1070   XBT_WARN("DEPRECATED! Now use MSG_task_receive_from_host");
1071   return MSG_task_get_ext(task, channel, -1, host);
1072 }
1073
1074 /** \ingroup msg_deprecated_functions
1075  * \brief Listen on a channel and wait for receiving a task.
1076  *
1077  * It takes two parameters.
1078  * \param task a memory location for storing a #msg_task_t. It will
1079  hold a task when this function will return. Thus \a task should not
1080  be equal to \c NULL and \a *task should be equal to \c NULL. If one of
1081  those two condition does not hold, there will be a warning message.
1082  * \param channel the channel on which the process should be
1083  listening. This value has to be >=0 and < than the maximal
1084  number of channels fixed with MSG_set_channel_number().
1085  * \return a #msg_error_t indicating whether the operation was successful (#MSG_OK), or why it failed otherwise.
1086  */
1087 msg_error_t MSG_task_get(msg_task_t * task, m_channel_t channel)
1088 {
1089   XBT_WARN("DEPRECATED! Now use MSG_task_receive");
1090   return MSG_task_get_with_timeout(task, channel, -1);
1091 }
1092
1093 /** \ingroup msg_deprecated_functions
1094  * \brief Listen on a channel and wait for receiving a task with a timeout.
1095  *
1096  * It takes three parameters.
1097  * \param task a memory location for storing a #msg_task_t. It will
1098  hold a task when this function will return. Thus \a task should not
1099  be equal to \c NULL and \a *task should be equal to \c NULL. If one of
1100  those two condition does not hold, there will be a warning message.
1101  * \param channel the channel on which the process should be
1102  listening. This value has to be >=0 and < than the maximal
1103  number of channels fixed with MSG_set_channel_number().
1104  * \param max_duration the maximum time to wait for a task before giving
1105  up. In such a case, #MSG_TRANSFER_FAILURE will be returned, \a task
1106  will not be modified and will still be
1107  equal to \c NULL when returning.
1108  * \return a #msg_error_t indicating whether the operation was successful (#MSG_OK), or why it failed otherwise.
1109  */
1110 msg_error_t
1111 MSG_task_get_with_timeout(msg_task_t * task, m_channel_t channel,
1112                           double max_duration)
1113 {
1114   XBT_WARN("DEPRECATED! Now use MSG_task_receive_with_timeout");
1115   return MSG_task_get_ext(task, channel, max_duration, NULL);
1116 }
1117
1118 msg_error_t
1119 MSG_task_get_ext(msg_task_t * task, m_channel_t channel, double timeout,
1120                  msg_host_t host)
1121 {
1122   XBT_WARN("DEPRECATED! Now use MSG_task_receive_ext");
1123   xbt_assert((channel >= 0)
1124               && (channel < msg_global->max_channel), "Invalid channel %d",
1125               channel);
1126
1127   return
1128       MSG_mailbox_get_task_ext(MSG_mailbox_get_by_channel
1129                                (MSG_host_self(), channel), task, host,
1130                                timeout);
1131 }
1132
1133 #endif