1 /* Copyright (c) 2004-2011. The SimGrid Team. All rights reserved. */
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. */
6 #include "msg_private.h"
7 #include "msg_mailbox.h"
10 #include "xbt/sysdep.h"
12 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(msg_gos, msg,
13 "Logging specific to MSG (gos)");
15 /** \ingroup msg_gos_functions
16 * \brief Executes a task and waits for its termination.
18 * This function is used for describing the behavior of an agent. It
19 * takes only one parameter.
20 * \param task a #m_task_t to execute on the location on which the
22 * \return #MSG_OK if the task was successfully completed, #MSG_TASK_CANCELED
23 * or #MSG_HOST_FAILURE otherwise
25 MSG_error_t MSG_task_execute(m_task_t task)
27 simdata_task_t simdata = NULL;
28 simdata_process_t p_simdata;
29 e_smx_state_t comp_state;
32 simdata = task->simdata;
34 xbt_assert(simdata->host_nb == 0,
35 "This is a parallel task. Go to hell.");
38 TRACE_msg_task_execute_start(task);
41 xbt_assert((!simdata->compute) && (task->simdata->isused == 0),
42 "This task is executed somewhere else. Go fix your code! %d",
43 task->simdata->isused);
45 XBT_DEBUG("Computing on %s", MSG_process_get_name(MSG_process_self()));
47 if (simdata->computation_amount == 0) {
49 TRACE_msg_task_execute_end(task);
54 m_process_t self = SIMIX_process_self();
55 p_simdata = SIMIX_process_self_get_data(self);
58 SIMIX_req_host_execute(task->name, p_simdata->m_host->simdata->smx_host,
59 simdata->computation_amount,
62 SIMIX_req_set_category(simdata->compute, task->category);
65 p_simdata->waiting_action = simdata->compute;
66 comp_state = SIMIX_req_host_execution_wait(simdata->compute);
67 p_simdata->waiting_action = NULL;
71 XBT_DEBUG("Execution task '%s' finished in state %d", task->name, comp_state);
72 if (comp_state == SIMIX_DONE) {
73 /* action ended, set comm and compute = NULL, the actions is already destroyed in the main function */
74 simdata->computation_amount = 0.0;
76 simdata->compute = NULL;
78 TRACE_msg_task_execute_end(task);
81 } else if (SIMIX_req_host_get_state(SIMIX_host_self()) == 0) {
82 /* action ended, set comm and compute = NULL, the actions is already destroyed in the main function */
84 simdata->compute = NULL;
86 TRACE_msg_task_execute_end(task);
88 MSG_RETURN(MSG_HOST_FAILURE);
90 /* action ended, set comm and compute = NULL, the actions is already destroyed in the main function */
92 simdata->compute = NULL;
94 TRACE_msg_task_execute_end(task);
96 MSG_RETURN(MSG_TASK_CANCELED);
100 /** \ingroup m_task_management
101 * \brief Creates a new #m_task_t (a parallel one....).
103 * A constructor for #m_task_t taking six arguments and returning the
104 corresponding object.
105 * \param name a name for the object. It is for user-level information
107 * \param host_nb the number of hosts implied in the parallel task.
108 * \param host_list an array of \p host_nb m_host_t.
109 * \param computation_amount an array of \p host_nb
110 doubles. computation_amount[i] is the total number of operations
111 that have to be performed on host_list[i].
112 * \param communication_amount an array of \p host_nb* \p host_nb doubles.
113 * \param data a pointer to any data may want to attach to the new
114 object. It is for user-level information and can be NULL. It can
115 be retrieved with the function \ref MSG_task_get_data.
117 * \return The new corresponding object.
120 MSG_parallel_task_create(const char *name, int host_nb,
121 const m_host_t * host_list,
122 double *computation_amount,
123 double *communication_amount, void *data)
126 simdata_task_t simdata = xbt_new0(s_simdata_task_t, 1);
127 m_task_t task = xbt_new0(s_m_task_t, 1);
128 task->simdata = simdata;
131 task->name = xbt_strdup(name);
135 simdata->computation_amount = 0;
136 simdata->message_size = 0;
137 simdata->compute = NULL;
138 simdata->comm = NULL;
139 simdata->rate = -1.0;
141 simdata->sender = NULL;
142 simdata->receiver = NULL;
143 simdata->source = NULL;
145 simdata->host_nb = host_nb;
146 simdata->host_list = xbt_new0(smx_host_t, host_nb);
147 simdata->comp_amount = computation_amount;
148 simdata->comm_amount = communication_amount;
150 for (i = 0; i < host_nb; i++)
151 simdata->host_list[i] = host_list[i]->simdata->smx_host;
156 MSG_error_t MSG_parallel_task_execute(m_task_t task)
158 simdata_task_t simdata = NULL;
159 e_smx_state_t comp_state;
160 simdata_process_t p_simdata;
163 simdata = task->simdata;
164 p_simdata = SIMIX_process_self_get_data(SIMIX_process_self());
166 xbt_assert((!simdata->compute)
167 && (task->simdata->isused == 0),
168 "This task is executed somewhere else. Go fix your code!");
170 xbt_assert(simdata->host_nb,
171 "This is not a parallel task. Go to hell.");
173 XBT_DEBUG("Parallel computing on %s", p_simdata->m_host->name);
178 SIMIX_req_host_parallel_execute(task->name, simdata->host_nb,
180 simdata->comp_amount,
181 simdata->comm_amount, 1.0, -1.0);
182 XBT_DEBUG("Parallel execution action created: %p", simdata->compute);
184 p_simdata->waiting_action = simdata->compute;
185 comp_state = SIMIX_req_host_execution_wait(simdata->compute);
186 p_simdata->waiting_action = NULL;
188 XBT_DEBUG("Finished waiting for execution of action %p, state = %d", simdata->compute, comp_state);
192 if (comp_state == SIMIX_DONE) {
193 /* action ended, set comm and compute = NULL, the actions is already destroyed in the main function */
194 simdata->computation_amount = 0.0;
195 simdata->comm = NULL;
196 simdata->compute = NULL;
198 } else if (SIMIX_req_host_get_state(SIMIX_host_self()) == 0) {
199 /* action ended, set comm and compute = NULL, the actions is already destroyed in the main function */
200 simdata->comm = NULL;
201 simdata->compute = NULL;
202 MSG_RETURN(MSG_HOST_FAILURE);
204 /* action ended, set comm and compute = NULL, the actions is already destroyed in the main function */
205 simdata->comm = NULL;
206 simdata->compute = NULL;
207 MSG_RETURN(MSG_TASK_CANCELED);
212 /** \ingroup msg_gos_functions
213 * \brief Sleep for the specified number of seconds
215 * Makes the current process sleep until \a time seconds have elapsed.
217 * \param nb_sec a number of second
219 MSG_error_t MSG_process_sleep(double nb_sec)
222 /*m_process_t proc = MSG_process_self();*/
225 TRACE_msg_process_sleep_in(MSG_process_self());
228 /* create action to sleep */
229 state = SIMIX_req_process_sleep(nb_sec);
231 /*proc->simdata->waiting_action = act_sleep;
233 FIXME: check if not setting the waiting_action breaks something on msg
235 proc->simdata->waiting_action = NULL;*/
237 if (state == SIMIX_DONE) {
239 TRACE_msg_process_sleep_out(MSG_process_self());
244 TRACE_msg_process_sleep_out(MSG_process_self());
246 MSG_RETURN(MSG_HOST_FAILURE);
250 /** \ingroup msg_gos_functions
251 * \brief Listen on \a channel and waits for receiving a task from \a host.
253 * It takes three parameters.
254 * \param task a memory location for storing a #m_task_t. It will
255 hold a task when this function will return. Thus \a task should not
256 be equal to \c NULL and \a *task should be equal to \c NULL. If one of
257 those two condition does not hold, there will be a warning message.
258 * \param channel the channel on which the agent should be
259 listening. This value has to be >=0 and < than the maximal
260 number of channels fixed with MSG_set_channel_number().
261 * \param host the host that is to be watched.
262 * \return a #MSG_error_t indicating whether the operation was successful (#MSG_OK), or why it failed otherwise.
265 MSG_task_get_from_host(m_task_t * task, m_channel_t channel, m_host_t host)
267 XBT_WARN("DEPRECATED! Now use MSG_task_receive_from_host");
268 return MSG_task_get_ext(task, channel, -1, host);
271 /** \ingroup msg_gos_functions
272 * \brief Listen on a channel and wait for receiving a task.
274 * It takes two parameters.
275 * \param task a memory location for storing a #m_task_t. It will
276 hold a task when this function will return. Thus \a task should not
277 be equal to \c NULL and \a *task should be equal to \c NULL. If one of
278 those two condition does not hold, there will be a warning message.
279 * \param channel the channel on which the agent should be
280 listening. This value has to be >=0 and < than the maximal
281 number of channels fixed with MSG_set_channel_number().
282 * \return a #MSG_error_t indicating whether the operation was successful (#MSG_OK), or why it failed otherwise.
284 MSG_error_t MSG_task_get(m_task_t * task, m_channel_t channel)
286 XBT_WARN("DEPRECATED! Now use MSG_task_receive");
287 return MSG_task_get_with_timeout(task, channel, -1);
290 /** \ingroup msg_gos_functions
291 * \brief Listen on a channel and wait for receiving a task with a timeout.
293 * It takes three parameters.
294 * \param task a memory location for storing a #m_task_t. It will
295 hold a task when this function will return. Thus \a task should not
296 be equal to \c NULL and \a *task should be equal to \c NULL. If one of
297 those two condition does not hold, there will be a warning message.
298 * \param channel the channel on which the agent should be
299 listening. This value has to be >=0 and < than the maximal
300 number of channels fixed with MSG_set_channel_number().
301 * \param max_duration the maximum time to wait for a task before giving
302 up. In such a case, #MSG_TRANSFER_FAILURE will be returned, \a task
303 will not be modified and will still be
304 equal to \c NULL when returning.
305 * \return a #MSG_error_t indicating whether the operation was successful (#MSG_OK), or why it failed otherwise.
308 MSG_task_get_with_timeout(m_task_t * task, m_channel_t channel,
311 XBT_WARN("DEPRECATED! Now use MSG_task_receive_with_timeout");
312 return MSG_task_get_ext(task, channel, max_duration, NULL);
315 /** \defgroup msg_gos_functions MSG Operating System Functions
316 * \brief This section describes the functions that can be used
317 * by an agent for handling some task.
321 MSG_task_get_ext(m_task_t * task, m_channel_t channel, double timeout,
324 XBT_WARN("DEPRECATED! Now use MSG_task_receive_ext");
325 xbt_assert((channel >= 0)
326 && (channel < msg_global->max_channel), "Invalid channel %d",
330 MSG_mailbox_get_task_ext(MSG_mailbox_get_by_channel
331 (MSG_host_self(), channel), task, host,
336 MSG_task_receive_from_host(m_task_t * task, const char *alias,
339 return MSG_task_receive_ext(task, alias, -1, host);
342 MSG_error_t MSG_task_receive(m_task_t * task, const char *alias)
344 return MSG_task_receive_with_timeout(task, alias, -1);
348 MSG_task_receive_with_timeout(m_task_t * task, const char *alias,
351 return MSG_task_receive_ext(task, alias, timeout, NULL);
355 MSG_task_receive_ext(m_task_t * task, const char *alias, double timeout,
359 ("MSG_task_receive_ext: Trying to receive a message on mailbox '%s'",
361 return MSG_mailbox_get_task_ext(MSG_mailbox_get_by_alias(alias), task,
365 /** \ingroup msg_gos_functions
366 * \brief Sends a task on a mailbox.
368 * This is a non blocking function: use MSG_comm_wait() or MSG_comm_test()
369 * to end the communication.
371 * \param task a #m_task_t to send on another location.
372 * \param alias name of the mailbox to sent the task to
373 * \return the msg_comm_t communication created
375 msg_comm_t MSG_task_isend(m_task_t task, const char *alias)
377 return MSG_task_isend_with_matching(task,alias,NULL,NULL);
380 /** \ingroup msg_gos_functions
381 * \brief Sends a task on a mailbox, with support for matching requests
383 * This is a non blocking function: use MSG_comm_wait() or MSG_comm_test()
384 * to end the communication.
386 * \param task a #m_task_t to send on another location.
387 * \param alias name of the mailbox to sent the task to
388 * \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
389 * \param match_data user provided data passed to match_fun
390 * \return the msg_comm_t communication created
392 XBT_INLINE msg_comm_t MSG_task_isend_with_matching(m_task_t task, const char *alias,
393 int (*match_fun)(void*,void*),
396 simdata_task_t t_simdata = NULL;
397 m_process_t process = MSG_process_self();
398 msg_mailbox_t mailbox = MSG_mailbox_get_by_alias(alias);
402 /* FIXME: these functions are not traceable */
404 /* Prepare the task to send */
405 t_simdata = task->simdata;
406 t_simdata->sender = process;
407 t_simdata->source = ((simdata_process_t) SIMIX_process_self_get_data(process))->m_host;
409 xbt_assert(t_simdata->isused == 0,
410 "This task is still being used somewhere else. You cannot send it now. Go fix your code!");
412 t_simdata->isused = 1;
413 msg_global->sent_msg++;
415 /* Send it by calling SIMIX network layer */
416 msg_comm_t comm = xbt_new0(s_msg_comm_t, 1);
417 comm->task_sent = task;
418 comm->task_received = NULL;
419 comm->status = MSG_OK;
421 SIMIX_req_comm_isend(mailbox, t_simdata->message_size,
422 t_simdata->rate, task, sizeof(void *), match_fun, NULL, match_data, 0);
423 t_simdata->comm = comm->s_comm; /* FIXME: is the field t_simdata->comm still useful? */
428 /** \ingroup msg_gos_functions
429 * \brief Sends a task on a mailbox.
431 * This is a non blocking detached send function.
432 * Think of it as a best effort send. Keep in mind that the third parameter
433 * is only called if the communication fails. If the communication does work,
434 * it is responsibility of the receiver code to free anything related to
435 * the task, as usual. More details on this can be obtained on
436 * <a href="http://lists.gforge.inria.fr/pipermail/simgrid-user/2011-November/002649.html">this thread</a>
437 * in the SimGrid-user mailing list archive.
439 * \param task a #m_task_t to send on another location.
440 * \param alias name of the mailbox to sent the task to
441 * \param cleanup a function to destroy the task if the
442 * communication fails, e.g. MSG_task_destroy
443 * (if NULL, no function will be called)
445 void MSG_task_dsend(m_task_t task, const char *alias, void_f_pvoid_t cleanup)
447 simdata_task_t t_simdata = NULL;
448 m_process_t process = MSG_process_self();
449 msg_mailbox_t mailbox = MSG_mailbox_get_by_alias(alias);
453 /* FIXME: these functions are not traceable */
455 /* Prepare the task to send */
456 t_simdata = task->simdata;
457 t_simdata->sender = process;
458 t_simdata->source = ((simdata_process_t) SIMIX_process_self_get_data(process))->m_host;
460 xbt_assert(t_simdata->isused == 0,
461 "This task is still being used somewhere else. You cannot send it now. Go fix your code!");
463 t_simdata->isused = 1;
464 msg_global->sent_msg++;
466 /* Send it by calling SIMIX network layer */
467 smx_action_t comm = SIMIX_req_comm_isend(mailbox, t_simdata->message_size,
468 t_simdata->rate, task, sizeof(void *), NULL, cleanup, NULL, 1);
469 t_simdata->comm = comm;
472 /** \ingroup msg_gos_functions
473 * \brief Starts listening for receiving a task from an asynchronous communication.
475 * This is a non blocking function: use MSG_comm_wait() or MSG_comm_test()
476 * to end the communication.
478 * \param task a memory location for storing a #m_task_t.
479 * \param name of the mailbox to receive the task on
480 * \return the msg_comm_t communication created
482 msg_comm_t MSG_task_irecv(m_task_t *task, const char *name)
484 smx_rdv_t rdv = MSG_mailbox_get_by_alias(name);
488 /* FIXME: these functions are not tracable */
491 xbt_assert(task, "Null pointer for the task storage");
495 ("MSG_task_irecv() was asked to write in a non empty task struct.");
497 /* Try to receive it by calling SIMIX network layer */
498 msg_comm_t comm = xbt_new0(s_msg_comm_t, 1);
499 comm->task_sent = NULL;
500 comm->task_received = task;
501 comm->status = MSG_OK;
502 comm->s_comm = SIMIX_req_comm_irecv(rdv, task, NULL, NULL, NULL);
507 /** \ingroup msg_gos_functions
508 * \brief Checks whether a communication is done, and if yes, finalizes it.
509 * \param comm the communication to test
510 * \return TRUE if the communication is finished
511 * (but it may have failed, use MSG_comm_get_status() to know its status)
512 * or FALSE if the communication is not finished yet
513 * If the status is FALSE, don't forget to use MSG_process_sleep() after the test.
515 int MSG_comm_test(msg_comm_t comm)
520 finished = SIMIX_req_comm_test(comm->s_comm);
522 if (finished && comm->task_received != NULL) {
523 /* I am the receiver */
524 (*comm->task_received)->simdata->isused = 0;
528 switch (e.category) {
531 comm->status = MSG_HOST_FAILURE;
536 comm->status = MSG_TRANSFER_FAILURE;
541 comm->status = MSG_TIMEOUT;
554 /** \ingroup msg_gos_functions
555 * \brief This function checks if a communication is finished.
556 * \param comms a vector of communications
557 * \return the position of the finished communication if any
558 * (but it may have failed, use MSG_comm_get_status() to know its status),
559 * or -1 if none is finished
561 int MSG_comm_testany(xbt_dynar_t comms)
564 int finished_index = -1;
566 /* create the equivalent dynar with SIMIX objects */
567 xbt_dynar_t s_comms = xbt_dynar_new(sizeof(smx_action_t), NULL);
570 xbt_dynar_foreach(comms, cursor, comm) {
571 xbt_dynar_push(s_comms, &comm->s_comm);
574 MSG_error_t status = MSG_OK;
576 finished_index = SIMIX_req_comm_testany(s_comms);
579 switch (e.category) {
582 finished_index = e.value;
583 status = MSG_HOST_FAILURE;
587 finished_index = e.value;
588 status = MSG_TRANSFER_FAILURE;
592 finished_index = e.value;
593 status = MSG_TIMEOUT;
601 xbt_dynar_free(&s_comms);
603 if (finished_index != -1) {
604 comm = xbt_dynar_get_as(comms, finished_index, msg_comm_t);
605 /* the communication is finished */
606 comm->status = status;
608 if (status == MSG_OK && comm->task_received != NULL) {
609 /* I am the receiver */
610 (*comm->task_received)->simdata->isused = 0;
614 return finished_index;
617 /** \ingroup msg_gos_functions
618 * \brief Destroys a communication.
619 * \param comm the communication to destroy.
621 void MSG_comm_destroy(msg_comm_t comm)
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 if (comm->task_received != NULL) {
737 /* I am the receiver */
738 (*comm->task_received)->simdata->isused = 0;
741 return finished_index;
745 * \ingroup msg_gos_functions
746 * \brief Returns the error (if any) that occured during a finished communication.
747 * \param comm a finished communication
748 * \return the status of the communication, or MSG_OK if no error occured
749 * during the communication
751 MSG_error_t MSG_comm_get_status(msg_comm_t comm) {
756 m_task_t MSG_comm_get_task(msg_comm_t comm)
758 xbt_assert(comm, "Invalid parameter");
760 return comm->task_received ? *comm->task_received : comm->task_sent;
764 * \brief This function is called by SIMIX to copy the data of a comm.
765 * \param comm the comm
766 * \param buff the data copied
767 * \param buff_size size of the buffer
769 void MSG_comm_copy_data_from_SIMIX(smx_action_t comm, void* buff, size_t buff_size) {
772 SIMIX_comm_copy_pointer_callback(comm, buff, buff_size);
774 // notify the user callback if any
775 if (msg_global->task_copy_callback) {
776 m_task_t task = buff;
777 msg_global->task_copy_callback(task,
778 SIMIX_req_comm_get_src_proc(comm), SIMIX_req_comm_get_dst_proc(comm));
782 /** \ingroup msg_gos_functions
783 * \brief Put a task on a channel of an host and waits for the end of the
786 * This function is used for describing the behavior of an agent. It
787 * takes three parameter.
788 * \param task a #m_task_t to send on another location. This task
789 will not be usable anymore when the function will return. There is
790 no automatic task duplication and you have to save your parameters
791 before calling this function. Tasks are unique and once it has been
792 sent to another location, you should not access it anymore. You do
793 not need to call MSG_task_destroy() but to avoid using, as an
794 effect of inattention, this task anymore, you definitely should
795 renitialize it with #MSG_TASK_UNINITIALIZED. Note that this task
796 can be transfered iff it has been correctly created with
798 * \param dest the destination of the message
799 * \param channel the channel on which the agent should put this
800 task. This value has to be >=0 and < than the maximal number of
801 channels fixed with MSG_set_channel_number().
802 * \return #MSG_HOST_FAILURE if the host on which
803 * this function was called was shut down,
804 * #MSG_TRANSFER_FAILURE if the transfer could not be properly done
805 * (network failure, dest failure) or #MSG_OK if it succeeded.
807 MSG_error_t MSG_task_put(m_task_t task, m_host_t dest, m_channel_t channel)
809 XBT_WARN("DEPRECATED! Now use MSG_task_send");
810 return MSG_task_put_with_timeout(task, dest, channel, -1.0);
813 /** \ingroup msg_gos_functions
814 * \brief Does exactly the same as MSG_task_put but with a bounded transmition
820 MSG_task_put_bounded(m_task_t task, m_host_t dest, m_channel_t channel,
823 XBT_WARN("DEPRECATED! Now use MSG_task_send_bounded");
824 task->simdata->rate = maxrate;
825 return MSG_task_put(task, dest, channel);
828 /** \ingroup msg_gos_functions \brief Put a task on a channel of an
829 * host (with a timeout on the waiting of the destination host) and
830 * waits for the end of the transmission.
832 * This function is used for describing the behavior of an agent. It
833 * takes four parameter.
834 * \param task a #m_task_t to send on another location. This task
835 will not be usable anymore when the function will return. There is
836 no automatic task duplication and you have to save your parameters
837 before calling this function. Tasks are unique and once it has been
838 sent to another location, you should not access it anymore. You do
839 not need to call MSG_task_destroy() but to avoid using, as an
840 effect of inattention, this task anymore, you definitely should
841 renitialize it with #MSG_TASK_UNINITIALIZED. Note that this task
842 can be transfered iff it has been correctly created with
844 * \param dest the destination of the message
845 * \param channel the channel on which the agent should put this
846 task. This value has to be >=0 and < than the maximal number of
847 channels fixed with MSG_set_channel_number().
848 * \param timeout the maximum time to wait for a task before giving
849 up. In such a case, #MSG_TRANSFER_FAILURE will be returned, \a task
851 * \return #MSG_HOST_FAILURE if the host on which
852 this function was called was shut down,
853 #MSG_TRANSFER_FAILURE if the transfer could not be properly done
854 (network failure, dest failure, timeout...) or #MSG_OK if the communication succeeded.
857 MSG_task_put_with_timeout(m_task_t task, m_host_t dest,
858 m_channel_t channel, double timeout)
860 XBT_WARN("DEPRECATED! Now use MSG_task_send_with_timeout");
861 xbt_assert((channel >= 0)
862 && (channel < msg_global->max_channel), "Invalid channel %d",
865 XBT_DEBUG("MSG_task_put_with_timout: Trying to send a task to '%s'", dest->name);
867 MSG_mailbox_put_with_timeout(MSG_mailbox_get_by_channel
868 (dest, channel), task, timeout);
871 MSG_error_t MSG_task_send(m_task_t task, const char *alias)
873 XBT_DEBUG("MSG_task_send: Trying to send a message on mailbox '%s'", alias);
874 return MSG_task_send_with_timeout(task, alias, -1);
879 MSG_task_send_bounded(m_task_t task, const char *alias, double maxrate)
881 task->simdata->rate = maxrate;
882 return MSG_task_send(task, alias);
887 MSG_task_send_with_timeout(m_task_t task, const char *alias,
890 return MSG_mailbox_put_with_timeout(MSG_mailbox_get_by_alias(alias),
894 int MSG_task_listen(const char *alias)
898 return !MSG_mailbox_is_empty(MSG_mailbox_get_by_alias(alias));
901 /** \ingroup msg_gos_functions
902 * \brief Test whether there is a pending communication on a channel.
904 * It takes one parameter.
905 * \param channel the channel on which the agent should be
906 listening. This value has to be >=0 and < than the maximal
907 number of channels fixed with MSG_set_channel_number().
908 * \return 1 if there is a pending communication and 0 otherwise
910 int MSG_task_Iprobe(m_channel_t channel)
912 XBT_WARN("DEPRECATED!");
913 xbt_assert((channel >= 0)
914 && (channel < msg_global->max_channel), "Invalid channel %d",
920 !MSG_mailbox_is_empty(MSG_mailbox_get_by_channel
921 (MSG_host_self(), channel));
924 /** \ingroup msg_gos_functions
926 * \brief Return the number of tasks waiting to be received on a \a
927 channel and sent by \a host.
929 * It takes two parameters.
930 * \param channel the channel on which the agent should be
931 listening. This value has to be >=0 and < than the maximal
932 number of channels fixed with MSG_set_channel_number().
933 * \param host the host that is to be watched.
934 * \return the number of tasks waiting to be received on \a channel
937 int MSG_task_probe_from_host(int channel, m_host_t host)
939 XBT_WARN("DEPRECATED! Now use MSG_task_listen_from_host");
940 xbt_assert((channel >= 0)
941 && (channel < msg_global->max_channel), "Invalid channel %d",
947 MSG_mailbox_get_count_host_waiting_tasks(MSG_mailbox_get_by_channel
948 (MSG_host_self(), channel),
953 int MSG_task_listen_from_host(const char *alias, m_host_t host)
958 MSG_mailbox_get_count_host_waiting_tasks(MSG_mailbox_get_by_alias
962 /** \ingroup msg_gos_functions
963 * \brief Test whether there is a pending communication on a channel, and who sent it.
965 * It takes one parameter.
966 * \param channel the channel on which the agent should be
967 listening. This value has to be >=0 and < than the maximal
968 number of channels fixed with MSG_set_channel_number().
969 * \return -1 if there is no pending communication and the PID of the process who sent it otherwise
971 int MSG_task_probe_from(m_channel_t channel)
973 XBT_WARN("DEPRECATED! Now use MSG_task_listen_from");
978 xbt_assert((channel >= 0)
979 && (channel < msg_global->max_channel), "Invalid channel %d",
984 MSG_mailbox_get_head(MSG_mailbox_get_by_channel
985 (MSG_host_self(), channel))))
988 return MSG_process_get_PID(task->simdata->sender);
991 int MSG_task_listen_from(const char *alias)
998 (task = MSG_mailbox_get_head(MSG_mailbox_get_by_alias(alias))))
1001 return MSG_process_get_PID(task->simdata->sender);
1004 #ifdef MSG_USE_DEPRECATED
1005 /** \ingroup msg_gos_functions
1007 * \brief Return the last value returned by a MSG function (except
1008 * MSG_get_errno...).
1010 MSG_error_t MSG_get_errno(void)
1012 return PROCESS_GET_ERRNO();