Logo AND Algorithmique Numérique Distribuée

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