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. */
8 #include "xbt/sysdep.h"
14 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(msg_gos, msg,
15 "Logging specific to MSG (gos)");
17 /** \ingroup msg_gos_functions
19 * \brief Return the last value returned by a MSG function (except
22 MSG_error_t MSG_get_errno(void)
24 return PROCESS_GET_ERRNO();
27 /** \ingroup msg_gos_functions
28 * \brief Executes a task and waits for its termination.
30 * This function is used for describing the behavior of an agent. It
31 * takes only one parameter.
32 * \param task a #m_task_t to execute on the location on which the
34 * \return #MSG_FATAL if \a task is not properly initialized and
37 MSG_error_t MSG_task_execute(m_task_t task)
39 simdata_task_t simdata = NULL;
40 m_process_t self = MSG_process_self();
41 e_smx_state_t comp_state;
44 simdata = task->simdata;
46 xbt_assert0(simdata->host_nb == 0,
47 "This is a parallel task. Go to hell.");
50 TRACE_msg_task_execute_start(task);
53 xbt_assert1((!simdata->compute) && (task->simdata->isused == 0),
54 "This task is executed somewhere else. Go fix your code! %d",
55 task->simdata->isused);
57 DEBUG1("Computing on %s", MSG_process_self()->simdata->m_host->name);
59 if (simdata->computation_amount == 0) {
61 TRACE_msg_task_execute_end(task);
67 SIMIX_req_host_execute(task->name, SIMIX_host_self(),
68 simdata->computation_amount,
71 SIMIX_req_set_category(simdata->compute, task->category);
74 self->simdata->waiting_action = simdata->compute;
75 comp_state = SIMIX_req_host_execution_wait(simdata->compute);
76 self->simdata->waiting_action = NULL;
80 DEBUG2("Execution task '%s' finished in state %d", task->name, comp_state);
81 if (comp_state == SIMIX_DONE) {
82 /* action ended, set comm and compute = NULL, the actions is already destroyed in the main function */
83 simdata->computation_amount = 0.0;
85 simdata->compute = NULL;
87 TRACE_msg_task_execute_end(task);
90 } else if (SIMIX_req_host_get_state(SIMIX_host_self()) == 0) {
91 /* action ended, set comm and compute = NULL, the actions is already destroyed in the main function */
93 simdata->compute = NULL;
95 TRACE_msg_task_execute_end(task);
97 MSG_RETURN(MSG_HOST_FAILURE);
99 /* action ended, set comm and compute = NULL, the actions is already destroyed in the main function */
100 simdata->comm = NULL;
101 simdata->compute = NULL;
103 TRACE_msg_task_execute_end(task);
105 MSG_RETURN(MSG_TASK_CANCELLED);
109 /** \ingroup m_task_management
110 * \brief Creates a new #m_task_t (a parallel one....).
112 * A constructor for #m_task_t taking six arguments and returning the
113 corresponding object.
114 * \param name a name for the object. It is for user-level information
116 * \param host_nb the number of hosts implied in the parallel task.
117 * \param host_list an array of \p host_nb m_host_t.
118 * \param computation_amount an array of \p host_nb
119 doubles. computation_amount[i] is the total number of operations
120 that have to be performed on host_list[i].
121 * \param communication_amount an array of \p host_nb* \p host_nb doubles.
122 * \param data a pointer to any data may want to attach to the new
123 object. It is for user-level information and can be NULL. It can
124 be retrieved with the function \ref MSG_task_get_data.
126 * \return The new corresponding object.
129 MSG_parallel_task_create(const char *name, int host_nb,
130 const m_host_t * host_list,
131 double *computation_amount,
132 double *communication_amount, void *data)
135 simdata_task_t simdata = xbt_new0(s_simdata_task_t, 1);
136 m_task_t task = xbt_new0(s_m_task_t, 1);
137 task->simdata = simdata;
140 task->name = xbt_strdup(name);
144 simdata->computation_amount = 0;
145 simdata->message_size = 0;
146 simdata->compute = NULL;
147 simdata->comm = NULL;
148 simdata->rate = -1.0;
150 simdata->sender = NULL;
151 simdata->receiver = NULL;
152 simdata->source = NULL;
154 simdata->host_nb = host_nb;
155 simdata->host_list = xbt_new0(smx_host_t, host_nb);
156 simdata->comp_amount = computation_amount;
157 simdata->comm_amount = communication_amount;
159 for (i = 0; i < host_nb; i++)
160 simdata->host_list[i] = host_list[i]->simdata->smx_host;
165 MSG_error_t MSG_parallel_task_execute(m_task_t task)
167 simdata_task_t simdata = NULL;
168 e_smx_state_t comp_state;
169 m_process_t self = MSG_process_self();
172 simdata = task->simdata;
174 xbt_assert0((!simdata->compute)
175 && (task->simdata->isused == 0),
176 "This task is executed somewhere else. Go fix your code!");
178 xbt_assert0(simdata->host_nb,
179 "This is not a parallel task. Go to hell.");
181 DEBUG1("Parallel computing on %s", MSG_process_self()->simdata->m_host->name);
186 SIMIX_req_host_parallel_execute(task->name, simdata->host_nb,
188 simdata->comp_amount,
189 simdata->comm_amount, 1.0, -1.0);
190 DEBUG1("Parallel execution action created: %p", simdata->compute);
192 self->simdata->waiting_action = simdata->compute;
193 comp_state = SIMIX_req_host_execution_wait(simdata->compute);
194 self->simdata->waiting_action = NULL;
196 DEBUG2("Finished waiting for execution of action %p, state = %d", simdata->compute, comp_state);
200 if (comp_state == SIMIX_DONE) {
201 /* action ended, set comm and compute = NULL, the actions is already destroyed in the main function */
202 simdata->computation_amount = 0.0;
203 simdata->comm = NULL;
204 simdata->compute = NULL;
206 } else if (SIMIX_req_host_get_state(SIMIX_host_self()) == 0) {
207 /* action ended, set comm and compute = NULL, the actions is already destroyed in the main function */
208 simdata->comm = NULL;
209 simdata->compute = NULL;
210 MSG_RETURN(MSG_HOST_FAILURE);
212 /* action ended, set comm and compute = NULL, the actions is already destroyed in the main function */
213 simdata->comm = NULL;
214 simdata->compute = NULL;
215 MSG_RETURN(MSG_TASK_CANCELLED);
220 /** \ingroup msg_gos_functions
221 * \brief Sleep for the specified number of seconds
223 * Makes the current process sleep until \a time seconds have elapsed.
225 * \param nb_sec a number of second
227 MSG_error_t MSG_process_sleep(double nb_sec)
230 /*m_process_t proc = MSG_process_self();*/
233 TRACE_msg_process_sleep_in(MSG_process_self());
236 /* create action to sleep */
237 state = SIMIX_req_process_sleep(nb_sec);
239 /*proc->simdata->waiting_action = act_sleep;
241 FIXME: check if not setting the waiting_action breaks something on msg
243 proc->simdata->waiting_action = NULL;*/
245 if (state == SIMIX_DONE) {
247 TRACE_msg_process_sleep_out(MSG_process_self());
252 TRACE_msg_process_sleep_out(MSG_process_self());
254 MSG_RETURN(MSG_HOST_FAILURE);
258 /** \ingroup msg_gos_functions
259 * \brief Listen on \a channel and waits for receiving a task from \a host.
261 * It takes three parameters.
262 * \param task a memory location for storing a #m_task_t. It will
263 hold a task when this function will return. Thus \a task should not
264 be equal to \c NULL and \a *task should be equal to \c NULL. If one of
265 those two condition does not hold, there will be a warning message.
266 * \param channel the channel on which the agent should be
267 listening. This value has to be >=0 and < than the maximal
268 number of channels fixed with MSG_set_channel_number().
269 * \param host the host that is to be watched.
270 * \return #MSG_FATAL if \a task is equal to \c NULL, #MSG_WARNING
271 if \a *task is not equal to \c NULL, and #MSG_OK otherwise.
274 MSG_task_get_from_host(m_task_t * task, m_channel_t channel, m_host_t host)
276 return MSG_task_get_ext(task, channel, -1, host);
279 /** \ingroup msg_gos_functions
280 * \brief Listen on a channel and wait for receiving a task.
282 * It takes two parameters.
283 * \param task a memory location for storing a #m_task_t. It will
284 hold a task when this function will return. Thus \a task should not
285 be equal to \c NULL and \a *task should be equal to \c NULL. If one of
286 those two condition does not hold, there will be a warning message.
287 * \param channel the channel on which the agent should be
288 listening. This value has to be >=0 and < than the maximal
289 number of channels fixed with MSG_set_channel_number().
290 * \return #MSG_FATAL if \a task is equal to \c NULL, #MSG_WARNING
291 * if \a *task is not equal to \c NULL, and #MSG_OK otherwise.
293 MSG_error_t MSG_task_get(m_task_t * task, m_channel_t channel)
295 return MSG_task_get_with_timeout(task, channel, -1);
298 /** \ingroup msg_gos_functions
299 * \brief Listen on a channel and wait for receiving a task with a timeout.
301 * It takes three parameters.
302 * \param task a memory location for storing a #m_task_t. It will
303 hold a task when this function will return. Thus \a task should not
304 be equal to \c NULL and \a *task should be equal to \c NULL. If one of
305 those two condition does not hold, there will be a warning message.
306 * \param channel the channel on which the agent should be
307 listening. This value has to be >=0 and < than the maximal
308 number of channels fixed with MSG_set_channel_number().
309 * \param max_duration the maximum time to wait for a task before giving
310 up. In such a case, #MSG_TRANSFER_FAILURE will be returned, \a task
311 will not be modified and will still be
312 equal to \c NULL when returning.
313 * \return #MSG_FATAL if \a task is equal to \c NULL, #MSG_WARNING
314 if \a *task is not equal to \c NULL, and #MSG_OK otherwise.
317 MSG_task_get_with_timeout(m_task_t * task, m_channel_t channel,
320 return MSG_task_get_ext(task, channel, max_duration, NULL);
323 /** \defgroup msg_gos_functions MSG Operating System Functions
324 * \brief This section describes the functions that can be used
325 * by an agent for handling some task.
329 MSG_task_get_ext(m_task_t * task, m_channel_t channel, double timeout,
332 xbt_assert1((channel >= 0)
333 && (channel < msg_global->max_channel), "Invalid channel %d",
337 MSG_mailbox_get_task_ext(MSG_mailbox_get_by_channel
338 (MSG_host_self(), channel), task, host,
343 MSG_task_receive_from_host(m_task_t * task, const char *alias,
346 return MSG_task_receive_ext(task, alias, -1, host);
349 MSG_error_t MSG_task_receive(m_task_t * task, const char *alias)
351 return MSG_task_receive_with_timeout(task, alias, -1);
355 MSG_task_receive_with_timeout(m_task_t * task, const char *alias,
358 return MSG_task_receive_ext(task, alias, timeout, NULL);
362 MSG_task_receive_ext(m_task_t * task, const char *alias, double timeout,
366 ("MSG_task_receive_ext: Trying to receive a message on mailbox '%s'",
368 return MSG_mailbox_get_task_ext(MSG_mailbox_get_by_alias(alias), task,
372 /** \ingroup msg_gos_functions
373 * \brief Sends a task on a mailbox.
375 * This is a non blocking function: use MSG_comm_wait() or MSG_comm_test()
376 * to end the communication.
378 * \param task a #m_task_t to send on another location.
379 * \param alias name of the mailbox to sent the task to
380 * \return the msg_comm_t communication created
382 msg_comm_t MSG_task_isend(m_task_t task, const char *alias)
384 simdata_task_t t_simdata = NULL;
385 m_process_t process = MSG_process_self();
386 msg_mailbox_t mailbox = MSG_mailbox_get_by_alias(alias);
390 /* FIXME: these functions are not traceable */
392 /* Prepare the task to send */
393 t_simdata = task->simdata;
394 t_simdata->sender = process;
395 t_simdata->source = MSG_host_self();
397 xbt_assert0(t_simdata->isused == 0,
398 "This task is still being used somewhere else. You cannot send it now. Go fix your code!");
400 t_simdata->isused = 1;
401 msg_global->sent_msg++;
403 /* Send it by calling SIMIX network layer */
404 msg_comm_t comm = xbt_new0(s_msg_comm_t, 1);
405 comm->task_sent = task;
406 comm->task_received = NULL;
407 comm->status = MSG_OK;
409 SIMIX_req_comm_isend(mailbox, t_simdata->message_size,
410 t_simdata->rate, task, sizeof(void *), NULL, NULL, 0);
411 t_simdata->comm = comm->s_comm; /* FIXME: is the field t_simdata->comm still useful? */
416 /** \ingroup msg_gos_functions
417 * \brief Sends a task on a mailbox.
419 * This is a non blocking detached send function.
420 * Think of it as a best effort send. The communication
421 * object will be destroyed by the receiver (if any).
423 * \param task a #m_task_t to send on another location.
424 * \param alias name of the mailbox to sent the task to
426 void MSG_task_dsend(m_task_t task, const char *alias, void_f_pvoid_t cleanup)
428 simdata_task_t t_simdata = NULL;
429 m_process_t process = MSG_process_self();
430 msg_mailbox_t mailbox = MSG_mailbox_get_by_alias(alias);
434 /* FIXME: these functions are not traceable */
436 /* Prepare the task to send */
437 t_simdata = task->simdata;
438 t_simdata->sender = process;
439 t_simdata->source = MSG_host_self();
441 xbt_assert0(t_simdata->isused == 0,
442 "This task is still being used somewhere else. You cannot send it now. Go fix your code!");
444 t_simdata->isused = 1;
445 msg_global->sent_msg++;
447 /* Send it by calling SIMIX network layer */
448 SIMIX_req_comm_isend(mailbox, t_simdata->message_size,
449 t_simdata->rate, task, sizeof(void *), NULL, cleanup, 1);
452 /** \ingroup msg_gos_functions
453 * \brief Starts listening for receiving a task from an asynchronous communication.
455 * This is a non blocking function: use MSG_comm_wait() or MSG_comm_test()
456 * to end the communication.
458 * \param task a memory location for storing a #m_task_t.
459 * \param name of the mailbox to receive the task on
460 * \return the msg_comm_t communication created
462 msg_comm_t MSG_task_irecv(m_task_t *task, const char *alias)
464 smx_rdv_t rdv = MSG_mailbox_get_by_alias(alias);
468 /* FIXME: these functions are not tracable */
471 xbt_assert0(task, "Null pointer for the task storage");
475 ("MSG_task_get() was asked to write in a non empty task struct.");
477 /* Try to receive it by calling SIMIX network layer */
478 msg_comm_t comm = xbt_new0(s_msg_comm_t, 1);
479 comm->task_sent = NULL;
480 comm->task_received = task;
481 comm->status = MSG_OK;
482 comm->s_comm = SIMIX_req_comm_irecv(rdv, task, NULL, NULL, NULL);
487 /** \ingroup msg_gos_functions
488 * \brief Checks whether a communication is done, and if yes, finalizes it.
489 * \param comm the communication to test
490 * \return TRUE if the communication is finished
491 * (but it may have failed, use MSG_comm_get_status() to know its status)
492 * or FALSE if the communication is not finished yet
493 * If the status is FALSE, don't forget to use MSG_process_sleep() after the test.
495 int MSG_comm_test(msg_comm_t comm)
500 finished = SIMIX_req_comm_test(comm->s_comm);
503 switch (e.category) {
506 comm->status = MSG_HOST_FAILURE;
511 comm->status = MSG_TRANSFER_FAILURE;
516 comm->status = MSG_TIMEOUT;
529 /** \ingroup msg_gos_functions
530 * \brief This function checks if a communication is finished.
531 * \param comms a vector of communications
532 * \return the position of the finished communication if any
533 * (but it may have failed, use MSG_comm_get_status() to know its status),
534 * or -1 if none is finished
536 int MSG_comm_testany(xbt_dynar_t comms)
539 int finished_index = -1;
541 /* create the equivalent dynar with SIMIX objects */
542 xbt_dynar_t s_comms = xbt_dynar_new(sizeof(smx_action_t), NULL);
545 xbt_dynar_foreach(comms, cursor, comm) {
546 xbt_dynar_push(s_comms, &comm->s_comm);
549 MSG_error_t status = MSG_OK;
551 finished_index = SIMIX_req_comm_testany(s_comms);
554 switch (e.category) {
557 finished_index = e.value;
558 status = MSG_HOST_FAILURE;
562 finished_index = e.value;
563 status = MSG_TRANSFER_FAILURE;
567 finished_index = e.value;
568 status = MSG_TIMEOUT;
576 xbt_dynar_free(&s_comms);
578 if (finished_index != -1) {
579 comm = xbt_dynar_get_as(comms, finished_index, msg_comm_t);
580 /* the communication is finished */
581 comm->status = status;
584 return finished_index;
587 /** \ingroup msg_gos_functions
588 * \brief Destroys a communication.
589 * \param comm the communication to destroy.
591 void MSG_comm_destroy(msg_comm_t comm)
593 if (comm->task_received != NULL
594 && *comm->task_received != NULL
595 && MSG_comm_get_status(comm) == MSG_OK) {
596 (*comm->task_received)->simdata->isused = 0;
599 /* FIXME auto-destroy comms from SIMIX to avoid this request */
600 SIMIX_req_comm_destroy(comm->s_comm);
604 /** \ingroup msg_gos_functions
605 * \brief Wait for the completion of a communication.
607 * It takes two parameters.
608 * \param comm the communication to wait.
609 * \param timeout Wait until the communication terminates or the timeout occurs
610 * \return MSG_error_t
612 MSG_error_t MSG_comm_wait(msg_comm_t comm, double timeout)
616 SIMIX_req_comm_wait(comm->s_comm, timeout);
618 if (comm->task_received != NULL) {
619 /* I am the receiver */
620 (*comm->task_received)->simdata->isused = 0;
623 /* FIXME: these functions are not traceable */
626 switch (e.category) {
628 comm->status = MSG_HOST_FAILURE;
631 comm->status = MSG_TRANSFER_FAILURE;
634 comm->status = MSG_TIMEOUT;
645 /** \ingroup msg_gos_functions
646 * \brief This function is called by a sender and permit to wait for each communication
648 * \param comm a vector of communication
649 * \param nb_elem is the size of the comm vector
650 * \param timeout for each call of MSG_comm_wait
652 void MSG_comm_waitall(msg_comm_t * comm, int nb_elem, double timeout)
655 for (i = 0; i < nb_elem; i++) {
656 MSG_comm_wait(comm[i], timeout);
660 /** \ingroup msg_gos_functions
661 * \brief This function waits for the first communication finished in a list.
662 * \param comms a vector of communications
663 * \return the position of the first finished communication
664 * (but it may have failed, use MSG_comm_get_status() to know its status)
666 int MSG_comm_waitany(xbt_dynar_t comms)
669 int finished_index = -1;
671 /* create the equivalent dynar with SIMIX objects */
672 xbt_dynar_t s_comms = xbt_dynar_new(sizeof(smx_action_t), NULL);
675 xbt_dynar_foreach(comms, cursor, comm) {
676 xbt_dynar_push(s_comms, &comm->s_comm);
679 MSG_error_t status = MSG_OK;
681 finished_index = SIMIX_req_comm_waitany(s_comms);
684 switch (e.category) {
687 finished_index = e.value;
688 status = MSG_HOST_FAILURE;
692 finished_index = e.value;
693 status = MSG_TRANSFER_FAILURE;
697 finished_index = e.value;
698 status = MSG_TIMEOUT;
707 xbt_assert0(finished_index != -1, "WaitAny returned -1");
708 xbt_dynar_free(&s_comms);
710 comm = xbt_dynar_get_as(comms, finished_index, msg_comm_t);
711 /* the communication is finished */
712 comm->status = status;
714 return finished_index;
718 * \ingroup msg_gos_functions
719 * \brief Returns the error (if any) that occured during a finished communication.
720 * \param comm a finished communication
721 * \return the status of the communication, or MSG_OK if no error occured
722 * during the communication
724 MSG_error_t MSG_comm_get_status(msg_comm_t comm) {
729 m_task_t MSG_comm_get_task(msg_comm_t comm)
731 xbt_assert0(comm, "Invalid parameter");
733 return comm->task_received ? *comm->task_received : comm->task_sent;
736 /** \ingroup msg_gos_functions
737 * \brief Put a task on a channel of an host and waits for the end of the
740 * This function is used for describing the behavior of an agent. It
741 * takes three parameter.
742 * \param task a #m_task_t to send on another location. This task
743 will not be usable anymore when the function will return. There is
744 no automatic task duplication and you have to save your parameters
745 before calling this function. Tasks are unique and once it has been
746 sent to another location, you should not access it anymore. You do
747 not need to call MSG_task_destroy() but to avoid using, as an
748 effect of inattention, this task anymore, you definitely should
749 renitialize it with #MSG_TASK_UNINITIALIZED. Note that this task
750 can be transfered iff it has been correctly created with
752 * \param dest the destination of the message
753 * \param channel the channel on which the agent should put this
754 task. This value has to be >=0 and < than the maximal number of
755 channels fixed with MSG_set_channel_number().
756 * \return #MSG_FATAL if \a task is not properly initialized and
757 * #MSG_OK otherwise. Returns #MSG_HOST_FAILURE if the host on which
758 * this function was called was shut down. Returns
759 * #MSG_TRANSFER_FAILURE if the transfer could not be properly done
760 * (network failure, dest failure)
762 MSG_error_t MSG_task_put(m_task_t task, m_host_t dest, m_channel_t channel)
764 return MSG_task_put_with_timeout(task, dest, channel, -1.0);
767 /** \ingroup msg_gos_functions
768 * \brief Does exactly the same as MSG_task_put but with a bounded transmition
774 MSG_task_put_bounded(m_task_t task, m_host_t dest, m_channel_t channel,
777 task->simdata->rate = maxrate;
778 return MSG_task_put(task, dest, channel);
781 /** \ingroup msg_gos_functions \brief Put a task on a channel of an
782 * host (with a timeout on the waiting of the destination host) and
783 * waits for the end of the transmission.
785 * This function is used for describing the behavior of an agent. It
786 * takes four parameter.
787 * \param task a #m_task_t to send on another location. This task
788 will not be usable anymore when the function will return. There is
789 no automatic task duplication and you have to save your parameters
790 before calling this function. Tasks are unique and once it has been
791 sent to another location, you should not access it anymore. You do
792 not need to call MSG_task_destroy() but to avoid using, as an
793 effect of inattention, this task anymore, you definitely should
794 renitialize it with #MSG_TASK_UNINITIALIZED. Note that this task
795 can be transfered iff it has been correctly created with
797 * \param dest the destination of the message
798 * \param channel the channel on which the agent should put this
799 task. This value has to be >=0 and < than the maximal number of
800 channels fixed with MSG_set_channel_number().
801 * \param timeout the maximum time to wait for a task before giving
802 up. In such a case, #MSG_TRANSFER_FAILURE will be returned, \a task
804 * \return #MSG_FATAL if \a task is not properly initialized and
805 #MSG_OK otherwise. Returns #MSG_HOST_FAILURE if the host on which
806 this function was called was shut down. Returns
807 #MSG_TRANSFER_FAILURE if the transfer could not be properly done
808 (network failure, dest failure, timeout...)
811 MSG_task_put_with_timeout(m_task_t task, m_host_t dest,
812 m_channel_t channel, double timeout)
814 xbt_assert1((channel >= 0)
815 && (channel < msg_global->max_channel), "Invalid channel %d",
818 DEBUG1("MSG_task_put_with_timout: Trying to send a task to '%s'", dest->name);
820 MSG_mailbox_put_with_timeout(MSG_mailbox_get_by_channel
821 (dest, channel), task, timeout);
824 MSG_error_t MSG_task_send(m_task_t task, const char *alias)
826 DEBUG1("MSG_task_send: Trying to send a message on mailbox '%s'", alias);
827 return MSG_task_send_with_timeout(task, alias, -1);
832 MSG_task_send_bounded(m_task_t task, const char *alias, double maxrate)
834 task->simdata->rate = maxrate;
835 return MSG_task_send(task, alias);
840 MSG_task_send_with_timeout(m_task_t task, const char *alias,
843 return MSG_mailbox_put_with_timeout(MSG_mailbox_get_by_alias(alias),
847 int MSG_task_listen(const char *alias)
851 return !MSG_mailbox_is_empty(MSG_mailbox_get_by_alias(alias));
854 /** \ingroup msg_gos_functions
855 * \brief Test whether there is a pending communication on a channel.
857 * It takes one parameter.
858 * \param channel the channel on which the agent should be
859 listening. This value has to be >=0 and < than the maximal
860 number of channels fixed with MSG_set_channel_number().
861 * \return 1 if there is a pending communication and 0 otherwise
863 int MSG_task_Iprobe(m_channel_t channel)
865 xbt_assert1((channel >= 0)
866 && (channel < msg_global->max_channel), "Invalid channel %d",
872 !MSG_mailbox_is_empty(MSG_mailbox_get_by_channel
873 (MSG_host_self(), channel));
876 /** \ingroup msg_gos_functions
878 * \brief Return the number of tasks waiting to be received on a \a
879 channel and sent by \a host.
881 * It takes two parameters.
882 * \param channel the channel on which the agent should be
883 listening. This value has to be >=0 and < than the maximal
884 number of channels fixed with MSG_set_channel_number().
885 * \param host the host that is to be watched.
886 * \return the number of tasks waiting to be received on \a channel
889 int MSG_task_probe_from_host(int channel, m_host_t host)
891 xbt_assert1((channel >= 0)
892 && (channel < msg_global->max_channel), "Invalid channel %d",
898 MSG_mailbox_get_count_host_waiting_tasks(MSG_mailbox_get_by_channel
899 (MSG_host_self(), channel),
904 int MSG_task_listen_from_host(const char *alias, m_host_t host)
909 MSG_mailbox_get_count_host_waiting_tasks(MSG_mailbox_get_by_alias
913 /** \ingroup msg_gos_functions
914 * \brief Test whether there is a pending communication on a channel, and who sent it.
916 * It takes one parameter.
917 * \param channel the channel on which the agent should be
918 listening. This value has to be >=0 and < than the maximal
919 number of channels fixed with MSG_set_channel_number().
920 * \return -1 if there is no pending communication and the PID of the process who sent it otherwise
922 int MSG_task_probe_from(m_channel_t channel)
928 xbt_assert1((channel >= 0)
929 && (channel < msg_global->max_channel), "Invalid channel %d",
934 MSG_mailbox_get_head(MSG_mailbox_get_by_channel
935 (MSG_host_self(), channel))))
938 return MSG_process_get_PID(task->simdata->sender);
941 int MSG_task_listen_from(const char *alias)
948 (task = MSG_mailbox_get_head(MSG_mailbox_get_by_alias(alias))))
951 return MSG_process_get_PID(task->simdata->sender);