1 /* Copyright (c) 2004, 2005, 2006, 2007, 2008, 2009, 2010. The SimGrid Team.
2 * All rights reserved. */
4 /* This program is free software; you can redistribute it and/or modify it
5 * under the terms of the license (GNU LGPL) which comes with this package. */
7 #include "msg_private.h"
8 #include "msg_mailbox.h"
11 #include "xbt/sysdep.h"
14 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(msg_gos, msg,
15 "Logging specific to MSG (gos)");
17 /** \ingroup msg_gos_functions
18 * \brief Executes a task and waits for its termination.
20 * This function is used for describing the behavior of an agent. It
21 * takes only one parameter.
22 * \param task a #m_task_t to execute on the location on which the
24 * \return #MSG_OK if the task was successfully completed, #MSG_TASK_CANCELED
25 * or #MSG_HOST_FAILURE otherwise
27 MSG_error_t MSG_task_execute(m_task_t task)
29 simdata_task_t simdata = NULL;
30 simdata_process_t p_simdata;
31 e_smx_state_t comp_state;
34 simdata = task->simdata;
36 xbt_assert(simdata->host_nb == 0,
37 "This is a parallel task. Go to hell.");
40 TRACE_msg_task_execute_start(task);
43 xbt_assert((!simdata->compute) && (task->simdata->isused == 0),
44 "This task is executed somewhere else. Go fix your code! %d",
45 task->simdata->isused);
47 XBT_DEBUG("Computing on %s", MSG_process_get_name(MSG_process_self()));
49 if (simdata->computation_amount == 0) {
51 TRACE_msg_task_execute_end(task);
56 m_process_t self = SIMIX_process_self();
57 p_simdata = SIMIX_process_self_get_data(self);
60 SIMIX_req_host_execute(task->name, p_simdata->m_host->simdata->smx_host,
61 simdata->computation_amount,
64 SIMIX_req_set_category(simdata->compute, task->category);
67 p_simdata->waiting_action = simdata->compute;
68 comp_state = SIMIX_req_host_execution_wait(simdata->compute);
69 p_simdata->waiting_action = NULL;
73 XBT_DEBUG("Execution task '%s' finished in state %d", task->name, comp_state);
74 if (comp_state == SIMIX_DONE) {
75 /* action ended, set comm and compute = NULL, the actions is already destroyed in the main function */
76 simdata->computation_amount = 0.0;
78 simdata->compute = NULL;
80 TRACE_msg_task_execute_end(task);
83 } else if (SIMIX_req_host_get_state(SIMIX_host_self()) == 0) {
84 /* action ended, set comm and compute = NULL, the actions is already destroyed in the main function */
86 simdata->compute = NULL;
88 TRACE_msg_task_execute_end(task);
90 MSG_RETURN(MSG_HOST_FAILURE);
92 /* action ended, set comm and compute = NULL, the actions is already destroyed in the main function */
94 simdata->compute = NULL;
96 TRACE_msg_task_execute_end(task);
98 MSG_RETURN(MSG_TASK_CANCELED);
102 /** \ingroup m_task_management
103 * \brief Creates a new #m_task_t (a parallel one....).
105 * A constructor for #m_task_t taking six arguments and returning the
106 corresponding object.
107 * \param name a name for the object. It is for user-level information
109 * \param host_nb the number of hosts implied in the parallel task.
110 * \param host_list an array of \p host_nb m_host_t.
111 * \param computation_amount an array of \p host_nb
112 doubles. computation_amount[i] is the total number of operations
113 that have to be performed on host_list[i].
114 * \param communication_amount an array of \p host_nb* \p host_nb doubles.
115 * \param data a pointer to any data may want to attach to the new
116 object. It is for user-level information and can be NULL. It can
117 be retrieved with the function \ref MSG_task_get_data.
119 * \return The new corresponding object.
122 MSG_parallel_task_create(const char *name, int host_nb,
123 const m_host_t * host_list,
124 double *computation_amount,
125 double *communication_amount, void *data)
128 simdata_task_t simdata = xbt_new0(s_simdata_task_t, 1);
129 m_task_t task = xbt_new0(s_m_task_t, 1);
130 task->simdata = simdata;
133 task->name = xbt_strdup(name);
137 simdata->computation_amount = 0;
138 simdata->message_size = 0;
139 simdata->compute = NULL;
140 simdata->comm = NULL;
141 simdata->rate = -1.0;
143 simdata->sender = NULL;
144 simdata->receiver = NULL;
145 simdata->source = NULL;
147 simdata->host_nb = host_nb;
148 simdata->host_list = xbt_new0(smx_host_t, host_nb);
149 simdata->comp_amount = computation_amount;
150 simdata->comm_amount = communication_amount;
152 for (i = 0; i < host_nb; i++)
153 simdata->host_list[i] = host_list[i]->simdata->smx_host;
158 MSG_error_t MSG_parallel_task_execute(m_task_t task)
160 simdata_task_t simdata = NULL;
161 e_smx_state_t comp_state;
162 simdata_process_t p_simdata;
165 simdata = task->simdata;
166 p_simdata = SIMIX_process_self_get_data(SIMIX_process_self());
168 xbt_assert((!simdata->compute)
169 && (task->simdata->isused == 0),
170 "This task is executed somewhere else. Go fix your code!");
172 xbt_assert(simdata->host_nb,
173 "This is not a parallel task. Go to hell.");
175 XBT_DEBUG("Parallel computing on %s", p_simdata->m_host->name);
180 SIMIX_req_host_parallel_execute(task->name, simdata->host_nb,
182 simdata->comp_amount,
183 simdata->comm_amount, 1.0, -1.0);
184 XBT_DEBUG("Parallel execution action created: %p", simdata->compute);
186 p_simdata->waiting_action = simdata->compute;
187 comp_state = SIMIX_req_host_execution_wait(simdata->compute);
188 p_simdata->waiting_action = NULL;
190 XBT_DEBUG("Finished waiting for execution of action %p, state = %d", simdata->compute, comp_state);
194 if (comp_state == SIMIX_DONE) {
195 /* action ended, set comm and compute = NULL, the actions is already destroyed in the main function */
196 simdata->computation_amount = 0.0;
197 simdata->comm = NULL;
198 simdata->compute = NULL;
200 } else if (SIMIX_req_host_get_state(SIMIX_host_self()) == 0) {
201 /* action ended, set comm and compute = NULL, the actions is already destroyed in the main function */
202 simdata->comm = NULL;
203 simdata->compute = NULL;
204 MSG_RETURN(MSG_HOST_FAILURE);
206 /* action ended, set comm and compute = NULL, the actions is already destroyed in the main function */
207 simdata->comm = NULL;
208 simdata->compute = NULL;
209 MSG_RETURN(MSG_TASK_CANCELED);
214 /** \ingroup msg_gos_functions
215 * \brief Sleep for the specified number of seconds
217 * Makes the current process sleep until \a time seconds have elapsed.
219 * \param nb_sec a number of second
221 MSG_error_t MSG_process_sleep(double nb_sec)
224 /*m_process_t proc = MSG_process_self();*/
227 TRACE_msg_process_sleep_in(MSG_process_self());
230 /* create action to sleep */
231 state = SIMIX_req_process_sleep(nb_sec);
233 /*proc->simdata->waiting_action = act_sleep;
235 FIXME: check if not setting the waiting_action breaks something on msg
237 proc->simdata->waiting_action = NULL;*/
239 if (state == SIMIX_DONE) {
241 TRACE_msg_process_sleep_out(MSG_process_self());
246 TRACE_msg_process_sleep_out(MSG_process_self());
248 MSG_RETURN(MSG_HOST_FAILURE);
252 /** \ingroup msg_gos_functions
253 * \brief Listen on \a channel and waits for receiving a task from \a host.
255 * It takes three parameters.
256 * \param task a memory location for storing a #m_task_t. It will
257 hold a task when this function will return. Thus \a task should not
258 be equal to \c NULL and \a *task should be equal to \c NULL. If one of
259 those two condition does not hold, there will be a warning message.
260 * \param channel the channel on which the agent should be
261 listening. This value has to be >=0 and < than the maximal
262 number of channels fixed with MSG_set_channel_number().
263 * \param host the host that is to be watched.
264 * \return #MSG_FATAL if \a task is equal to \c NULL, #MSG_WARNING
265 if \a *task is not equal to \c NULL, and #MSG_OK otherwise.
268 MSG_task_get_from_host(m_task_t * task, m_channel_t channel, m_host_t host)
270 return MSG_task_get_ext(task, channel, -1, host);
273 /** \ingroup msg_gos_functions
274 * \brief Listen on a channel and wait for receiving a task.
276 * It takes two parameters.
277 * \param task a memory location for storing a #m_task_t. It will
278 hold a task when this function will return. Thus \a task should not
279 be equal to \c NULL and \a *task should be equal to \c NULL. If one of
280 those two condition does not hold, there will be a warning message.
281 * \param channel the channel on which the agent should be
282 listening. This value has to be >=0 and < than the maximal
283 number of channels fixed with MSG_set_channel_number().
284 * \return #MSG_FATAL if \a task is equal to \c NULL, #MSG_WARNING
285 * if \a *task is not equal to \c NULL, and #MSG_OK otherwise.
287 MSG_error_t MSG_task_get(m_task_t * task, m_channel_t channel)
289 return MSG_task_get_with_timeout(task, channel, -1);
292 /** \ingroup msg_gos_functions
293 * \brief Listen on a channel and wait for receiving a task with a timeout.
295 * It takes three parameters.
296 * \param task a memory location for storing a #m_task_t. It will
297 hold a task when this function will return. Thus \a task should not
298 be equal to \c NULL and \a *task should be equal to \c NULL. If one of
299 those two condition does not hold, there will be a warning message.
300 * \param channel the channel on which the agent should be
301 listening. This value has to be >=0 and < than the maximal
302 number of channels fixed with MSG_set_channel_number().
303 * \param max_duration the maximum time to wait for a task before giving
304 up. In such a case, #MSG_TRANSFER_FAILURE will be returned, \a task
305 will not be modified and will still be
306 equal to \c NULL when returning.
307 * \return #MSG_FATAL if \a task is equal to \c NULL, #MSG_WARNING
308 if \a *task is not equal to \c NULL, and #MSG_OK otherwise.
311 MSG_task_get_with_timeout(m_task_t * task, m_channel_t channel,
314 return MSG_task_get_ext(task, channel, max_duration, NULL);
317 /** \defgroup msg_gos_functions MSG Operating System Functions
318 * \brief This section describes the functions that can be used
319 * by an agent for handling some task.
323 MSG_task_get_ext(m_task_t * task, m_channel_t channel, double timeout,
326 xbt_assert((channel >= 0)
327 && (channel < msg_global->max_channel), "Invalid channel %d",
331 MSG_mailbox_get_task_ext(MSG_mailbox_get_by_channel
332 (MSG_host_self(), channel), task, host,
337 MSG_task_receive_from_host(m_task_t * task, const char *alias,
340 return MSG_task_receive_ext(task, alias, -1, host);
343 MSG_error_t MSG_task_receive(m_task_t * task, const char *alias)
345 return MSG_task_receive_with_timeout(task, alias, -1);
349 MSG_task_receive_with_timeout(m_task_t * task, const char *alias,
352 return MSG_task_receive_ext(task, alias, timeout, NULL);
356 MSG_task_receive_ext(m_task_t * task, const char *alias, double timeout,
360 ("MSG_task_receive_ext: Trying to receive a message on mailbox '%s'",
362 return MSG_mailbox_get_task_ext(MSG_mailbox_get_by_alias(alias), task,
366 /** \ingroup msg_gos_functions
367 * \brief Sends a task on a mailbox.
369 * This is a non blocking function: use MSG_comm_wait() or MSG_comm_test()
370 * to end the communication.
372 * \param task a #m_task_t to send on another location.
373 * \param alias name of the mailbox to sent the task to
374 * \return the msg_comm_t communication created
376 msg_comm_t MSG_task_isend(m_task_t task, const char *alias)
378 return MSG_task_isend_with_matching(task,alias,NULL,NULL);
381 /** \ingroup msg_gos_functions
382 * \brief Sends a task on a mailbox, with support for matching requests
384 * This is a non blocking function: use MSG_comm_wait() or MSG_comm_test()
385 * to end the communication.
387 * \param task a #m_task_t to send on another location.
388 * \param alias name of the mailbox to sent the task to
389 * \param match_fun boolean function taking the #match_data provided by sender (here), and the one of the receiver (if any) and returning whether they match
390 * \param match_data user provided data passed to match_fun
391 * \return the msg_comm_t communication created
393 XBT_INLINE msg_comm_t MSG_task_isend_with_matching(m_task_t task, const char *alias,
394 int (*match_fun)(void*,void*),
397 simdata_task_t t_simdata = NULL;
398 m_process_t process = MSG_process_self();
399 msg_mailbox_t mailbox = MSG_mailbox_get_by_alias(alias);
403 /* FIXME: these functions are not traceable */
405 /* Prepare the task to send */
406 t_simdata = task->simdata;
407 t_simdata->sender = process;
408 t_simdata->source = ((simdata_process_t) SIMIX_process_self_get_data(process))->m_host;
410 xbt_assert(t_simdata->isused == 0,
411 "This task is still being used somewhere else. You cannot send it now. Go fix your code!");
413 t_simdata->isused = 1;
414 msg_global->sent_msg++;
416 /* Send it by calling SIMIX network layer */
417 msg_comm_t comm = xbt_new0(s_msg_comm_t, 1);
418 comm->task_sent = task;
419 comm->task_received = NULL;
420 comm->status = MSG_OK;
422 SIMIX_req_comm_isend(mailbox, t_simdata->message_size,
423 t_simdata->rate, task, sizeof(void *), match_fun, match_data, 0);
424 t_simdata->comm = comm->s_comm; /* FIXME: is the field t_simdata->comm still useful? */
429 /** \ingroup msg_gos_functions
430 * \brief Sends a task on a mailbox.
432 * This is a non blocking detached send function.
433 * Think of it as a best effort send. Keep in mind that the third parameter
434 * is only called if the communication fails. If the communication does work,
435 * it is responsibility of the receiver code to free anything related to
436 * the task, as usual. More details on this can be obtained on
437 * <a href="http://lists.gforge.inria.fr/pipermail/simgrid-user/2011-November/002649.html">this thread</a>
438 * in the SimGrid-user mailing list archive.
440 * \param task a #m_task_t to send on another location.
441 * \param alias name of the mailbox to sent the task to
442 * \param cleanup a function to destroy the task if the
443 * communication fails (if NULL, MSG_task_destroy() will
444 * be used by default)
446 void MSG_task_dsend(m_task_t task, const char *alias, void_f_pvoid_t cleanup)
448 simdata_task_t t_simdata = NULL;
449 m_process_t process = MSG_process_self();
450 msg_mailbox_t mailbox = MSG_mailbox_get_by_alias(alias);
454 if (cleanup == NULL) {
455 cleanup = (void_f_pvoid_t) MSG_task_destroy;
458 /* FIXME: these functions are not traceable */
460 /* Prepare the task to send */
461 t_simdata = task->simdata;
462 t_simdata->sender = process;
463 t_simdata->source = ((simdata_process_t) SIMIX_process_self_get_data(process))->m_host;
465 xbt_assert(t_simdata->isused == 0,
466 "This task is still being used somewhere else. You cannot send it now. Go fix your code!");
468 t_simdata->isused = 1;
469 msg_global->sent_msg++;
471 /* Send it by calling SIMIX network layer */
472 SIMIX_req_comm_isend(mailbox, t_simdata->message_size,
473 t_simdata->rate, task, sizeof(void *), NULL, cleanup, 1);
476 /** \ingroup msg_gos_functions
477 * \brief Starts listening for receiving a task from an asynchronous communication.
479 * This is a non blocking function: use MSG_comm_wait() or MSG_comm_test()
480 * to end the communication.
482 * \param task a memory location for storing a #m_task_t.
483 * \param name of the mailbox to receive the task on
484 * \return the msg_comm_t communication created
486 msg_comm_t MSG_task_irecv(m_task_t *task, const char *name)
488 smx_rdv_t rdv = MSG_mailbox_get_by_alias(name);
492 /* FIXME: these functions are not tracable */
495 xbt_assert(task, "Null pointer for the task storage");
499 ("MSG_task_get() was asked to write in a non empty task struct.");
501 /* Try to receive it by calling SIMIX network layer */
502 msg_comm_t comm = xbt_new0(s_msg_comm_t, 1);
503 comm->task_sent = NULL;
504 comm->task_received = task;
505 comm->status = MSG_OK;
506 comm->s_comm = SIMIX_req_comm_irecv(rdv, task, NULL, NULL, NULL);
511 /** \ingroup msg_gos_functions
512 * \brief Checks whether a communication is done, and if yes, finalizes it.
513 * \param comm the communication to test
514 * \return TRUE if the communication is finished
515 * (but it may have failed, use MSG_comm_get_status() to know its status)
516 * or FALSE if the communication is not finished yet
517 * If the status is FALSE, don't forget to use MSG_process_sleep() after the test.
519 int MSG_comm_test(msg_comm_t comm)
524 finished = SIMIX_req_comm_test(comm->s_comm);
527 switch (e.category) {
530 comm->status = MSG_HOST_FAILURE;
535 comm->status = MSG_TRANSFER_FAILURE;
540 comm->status = MSG_TIMEOUT;
553 /** \ingroup msg_gos_functions
554 * \brief This function checks if a communication is finished.
555 * \param comms a vector of communications
556 * \return the position of the finished communication if any
557 * (but it may have failed, use MSG_comm_get_status() to know its status),
558 * or -1 if none is finished
560 int MSG_comm_testany(xbt_dynar_t comms)
563 int finished_index = -1;
565 /* create the equivalent dynar with SIMIX objects */
566 xbt_dynar_t s_comms = xbt_dynar_new(sizeof(smx_action_t), NULL);
569 xbt_dynar_foreach(comms, cursor, comm) {
570 xbt_dynar_push(s_comms, &comm->s_comm);
573 MSG_error_t status = MSG_OK;
575 finished_index = SIMIX_req_comm_testany(s_comms);
578 switch (e.category) {
581 finished_index = e.value;
582 status = MSG_HOST_FAILURE;
586 finished_index = e.value;
587 status = MSG_TRANSFER_FAILURE;
591 finished_index = e.value;
592 status = MSG_TIMEOUT;
600 xbt_dynar_free(&s_comms);
602 if (finished_index != -1) {
603 comm = xbt_dynar_get_as(comms, finished_index, msg_comm_t);
604 /* the communication is finished */
605 comm->status = status;
608 return finished_index;
611 /** \ingroup msg_gos_functions
612 * \brief Destroys a communication.
613 * \param comm the communication to destroy.
615 void MSG_comm_destroy(msg_comm_t comm)
617 if (comm->task_received != NULL
618 && *comm->task_received != NULL
619 && MSG_comm_get_status(comm) == MSG_OK) {
620 (*comm->task_received)->simdata->isused = 0;
626 /** \ingroup msg_gos_functions
627 * \brief Wait for the completion of a communication.
629 * It takes two parameters.
630 * \param comm the communication to wait.
631 * \param timeout Wait until the communication terminates or the timeout occurs
632 * \return MSG_error_t
634 MSG_error_t MSG_comm_wait(msg_comm_t comm, double timeout)
638 SIMIX_req_comm_wait(comm->s_comm, timeout);
640 if (comm->task_received != NULL) {
641 /* I am the receiver */
642 (*comm->task_received)->simdata->isused = 0;
645 /* FIXME: these functions are not traceable */
648 switch (e.category) {
650 comm->status = MSG_HOST_FAILURE;
653 comm->status = MSG_TRANSFER_FAILURE;
656 comm->status = MSG_TIMEOUT;
667 /** \ingroup msg_gos_functions
668 * \brief This function is called by a sender and permit to wait for each communication
670 * \param comm a vector of communication
671 * \param nb_elem is the size of the comm vector
672 * \param timeout for each call of MSG_comm_wait
674 void MSG_comm_waitall(msg_comm_t * comm, int nb_elem, double timeout)
677 for (i = 0; i < nb_elem; i++) {
678 MSG_comm_wait(comm[i], timeout);
682 /** \ingroup msg_gos_functions
683 * \brief This function waits for the first communication finished in a list.
684 * \param comms a vector of communications
685 * \return the position of the first finished communication
686 * (but it may have failed, use MSG_comm_get_status() to know its status)
688 int MSG_comm_waitany(xbt_dynar_t comms)
691 int finished_index = -1;
693 /* create the equivalent dynar with SIMIX objects */
694 xbt_dynar_t s_comms = xbt_dynar_new(sizeof(smx_action_t), NULL);
697 xbt_dynar_foreach(comms, cursor, comm) {
698 xbt_dynar_push(s_comms, &comm->s_comm);
701 MSG_error_t status = MSG_OK;
703 finished_index = SIMIX_req_comm_waitany(s_comms);
706 switch (e.category) {
709 finished_index = e.value;
710 status = MSG_HOST_FAILURE;
714 finished_index = e.value;
715 status = MSG_TRANSFER_FAILURE;
719 finished_index = e.value;
720 status = MSG_TIMEOUT;
729 xbt_assert(finished_index != -1, "WaitAny returned -1");
730 xbt_dynar_free(&s_comms);
732 comm = xbt_dynar_get_as(comms, finished_index, msg_comm_t);
733 /* the communication is finished */
734 comm->status = status;
736 return finished_index;
740 * \ingroup msg_gos_functions
741 * \brief Returns the error (if any) that occured during a finished communication.
742 * \param comm a finished communication
743 * \return the status of the communication, or MSG_OK if no error occured
744 * during the communication
746 MSG_error_t MSG_comm_get_status(msg_comm_t comm) {
751 m_task_t MSG_comm_get_task(msg_comm_t comm)
753 xbt_assert(comm, "Invalid parameter");
755 return comm->task_received ? *comm->task_received : comm->task_sent;
758 /** \ingroup msg_gos_functions
759 * \brief Put a task on a channel of an host and waits for the end of the
762 * This function is used for describing the behavior of an agent. It
763 * takes three parameter.
764 * \param task a #m_task_t to send on another location. This task
765 will not be usable anymore when the function will return. There is
766 no automatic task duplication and you have to save your parameters
767 before calling this function. Tasks are unique and once it has been
768 sent to another location, you should not access it anymore. You do
769 not need to call MSG_task_destroy() but to avoid using, as an
770 effect of inattention, this task anymore, you definitely should
771 renitialize it with #MSG_TASK_UNINITIALIZED. Note that this task
772 can be transfered iff it has been correctly created with
774 * \param dest the destination of the message
775 * \param channel the channel on which the agent should put this
776 task. This value has to be >=0 and < than the maximal number of
777 channels fixed with MSG_set_channel_number().
778 * \return #MSG_FATAL if \a task is not properly initialized and
779 * #MSG_OK otherwise. Returns #MSG_HOST_FAILURE if the host on which
780 * this function was called was shut down. Returns
781 * #MSG_TRANSFER_FAILURE if the transfer could not be properly done
782 * (network failure, dest failure)
784 MSG_error_t MSG_task_put(m_task_t task, m_host_t dest, m_channel_t channel)
786 return MSG_task_put_with_timeout(task, dest, channel, -1.0);
789 /** \ingroup msg_gos_functions
790 * \brief Does exactly the same as MSG_task_put but with a bounded transmition
796 MSG_task_put_bounded(m_task_t task, m_host_t dest, m_channel_t channel,
799 task->simdata->rate = maxrate;
800 return MSG_task_put(task, dest, channel);
803 /** \ingroup msg_gos_functions \brief Put a task on a channel of an
804 * host (with a timeout on the waiting of the destination host) and
805 * waits for the end of the transmission.
807 * This function is used for describing the behavior of an agent. It
808 * takes four parameter.
809 * \param task a #m_task_t to send on another location. This task
810 will not be usable anymore when the function will return. There is
811 no automatic task duplication and you have to save your parameters
812 before calling this function. Tasks are unique and once it has been
813 sent to another location, you should not access it anymore. You do
814 not need to call MSG_task_destroy() but to avoid using, as an
815 effect of inattention, this task anymore, you definitely should
816 renitialize it with #MSG_TASK_UNINITIALIZED. Note that this task
817 can be transfered iff it has been correctly created with
819 * \param dest the destination of the message
820 * \param channel the channel on which the agent should put this
821 task. This value has to be >=0 and < than the maximal number of
822 channels fixed with MSG_set_channel_number().
823 * \param timeout the maximum time to wait for a task before giving
824 up. In such a case, #MSG_TRANSFER_FAILURE will be returned, \a task
826 * \return #MSG_FATAL if \a task is not properly initialized and
827 #MSG_OK otherwise. Returns #MSG_HOST_FAILURE if the host on which
828 this function was called was shut down. Returns
829 #MSG_TRANSFER_FAILURE if the transfer could not be properly done
830 (network failure, dest failure, timeout...)
833 MSG_task_put_with_timeout(m_task_t task, m_host_t dest,
834 m_channel_t channel, double timeout)
836 xbt_assert((channel >= 0)
837 && (channel < msg_global->max_channel), "Invalid channel %d",
840 XBT_DEBUG("MSG_task_put_with_timout: Trying to send a task to '%s'", dest->name);
842 MSG_mailbox_put_with_timeout(MSG_mailbox_get_by_channel
843 (dest, channel), task, timeout);
846 MSG_error_t MSG_task_send(m_task_t task, const char *alias)
848 XBT_DEBUG("MSG_task_send: Trying to send a message on mailbox '%s'", alias);
849 return MSG_task_send_with_timeout(task, alias, -1);
854 MSG_task_send_bounded(m_task_t task, const char *alias, double maxrate)
856 task->simdata->rate = maxrate;
857 return MSG_task_send(task, alias);
862 MSG_task_send_with_timeout(m_task_t task, const char *alias,
865 return MSG_mailbox_put_with_timeout(MSG_mailbox_get_by_alias(alias),
869 int MSG_task_listen(const char *alias)
873 return !MSG_mailbox_is_empty(MSG_mailbox_get_by_alias(alias));
876 /** \ingroup msg_gos_functions
877 * \brief Test whether there is a pending communication on a channel.
879 * It takes one parameter.
880 * \param channel the channel on which the agent should be
881 listening. This value has to be >=0 and < than the maximal
882 number of channels fixed with MSG_set_channel_number().
883 * \return 1 if there is a pending communication and 0 otherwise
885 int MSG_task_Iprobe(m_channel_t channel)
887 xbt_assert((channel >= 0)
888 && (channel < msg_global->max_channel), "Invalid channel %d",
894 !MSG_mailbox_is_empty(MSG_mailbox_get_by_channel
895 (MSG_host_self(), channel));
898 /** \ingroup msg_gos_functions
900 * \brief Return the number of tasks waiting to be received on a \a
901 channel and sent by \a host.
903 * It takes two parameters.
904 * \param channel the channel on which the agent should be
905 listening. This value has to be >=0 and < than the maximal
906 number of channels fixed with MSG_set_channel_number().
907 * \param host the host that is to be watched.
908 * \return the number of tasks waiting to be received on \a channel
911 int MSG_task_probe_from_host(int channel, m_host_t host)
913 xbt_assert((channel >= 0)
914 && (channel < msg_global->max_channel), "Invalid channel %d",
920 MSG_mailbox_get_count_host_waiting_tasks(MSG_mailbox_get_by_channel
921 (MSG_host_self(), channel),
926 int MSG_task_listen_from_host(const char *alias, m_host_t host)
931 MSG_mailbox_get_count_host_waiting_tasks(MSG_mailbox_get_by_alias
935 /** \ingroup msg_gos_functions
936 * \brief Test whether there is a pending communication on a channel, and who sent it.
938 * It takes one parameter.
939 * \param channel the channel on which the agent should be
940 listening. This value has to be >=0 and < than the maximal
941 number of channels fixed with MSG_set_channel_number().
942 * \return -1 if there is no pending communication and the PID of the process who sent it otherwise
944 int MSG_task_probe_from(m_channel_t channel)
950 xbt_assert((channel >= 0)
951 && (channel < msg_global->max_channel), "Invalid channel %d",
956 MSG_mailbox_get_head(MSG_mailbox_get_by_channel
957 (MSG_host_self(), channel))))
960 return MSG_process_get_PID(task->simdata->sender);
963 int MSG_task_listen_from(const char *alias)
970 (task = MSG_mailbox_get_head(MSG_mailbox_get_by_alias(alias))))
973 return MSG_process_get_PID(task->simdata->sender);
976 #ifdef MSG_USE_DEPRECATED
977 /** \ingroup msg_gos_functions
979 * \brief Return the last value returned by a MSG function (except
982 MSG_error_t MSG_get_errno(void)
984 return PROCESS_GET_ERRNO();