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_task_usage
16 * \brief Executes a task and waits for its termination.
18 * This function is used for describing the behavior of a process. It
19 * takes only one parameter.
20 * \param task a #m_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
24 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;
31 simdata = task->simdata;
33 xbt_assert(simdata->host_nb == 0,
34 "This is a parallel task. Go to hell.");
37 TRACE_msg_task_execute_start(task);
40 xbt_assert((!simdata->compute) && (task->simdata->isused == 0),
41 "This task is executed somewhere else. Go fix your code! %d",
42 task->simdata->isused);
44 XBT_DEBUG("Computing on %s", MSG_process_get_name(MSG_process_self()));
46 if (simdata->computation_amount == 0) {
48 TRACE_msg_task_execute_end(task);
53 m_process_t self = SIMIX_process_self();
54 p_simdata = SIMIX_process_self_get_data(self);
57 simcall_host_execute(task->name, p_simdata->m_host->smx_host,
58 simdata->computation_amount,
61 simcall_set_category(simdata->compute, task->category);
64 p_simdata->waiting_action = simdata->compute;
66 comp_state = simcall_host_execution_wait(simdata->compute);
67 p_simdata->waiting_action = NULL;
71 XBT_DEBUG("Execution task '%s' finished in state %d", task->name, (int)comp_state);
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);
85 /* action ended, set comm and compute = NULL, the actions is already destroyed in the main function */
87 simdata->compute = NULL;
89 TRACE_msg_task_execute_end(task);
91 MSG_RETURN(MSG_HOST_FAILURE);
94 /* action ended, set comm and compute = NULL, the actions is already destroyed in the main function */
96 simdata->compute = NULL;
98 TRACE_msg_task_execute_end(task);
100 MSG_RETURN(MSG_TASK_CANCELED);
106 /** \ingroup m_task_management
107 * \brief Creates a new #m_task_t (a parallel one....).
109 * A constructor for #m_task_t taking six arguments and returning the
110 corresponding object.
111 * \param name a name for the object. It is for user-level information
113 * \param host_nb the number of hosts implied in the parallel task.
114 * \param host_list an array of \p host_nb m_host_t.
115 * \param computation_amount an array of \p host_nb
116 doubles. computation_amount[i] is the total number of operations
117 that have to be performed on host_list[i].
118 * \param communication_amount an array of \p host_nb* \p host_nb doubles.
119 * \param data a pointer to any data may want to attach to the new
120 object. It is for user-level information and can be NULL. It can
121 be retrieved with the function \ref MSG_task_get_data.
123 * \return The new corresponding object.
126 MSG_parallel_task_create(const char *name, int host_nb,
127 const m_host_t * host_list,
128 double *computation_amount,
129 double *communication_amount, void *data)
132 simdata_task_t simdata = xbt_new0(s_simdata_task_t, 1);
133 m_task_t task = xbt_new0(s_m_task_t, 1);
134 task->simdata = simdata;
137 task->name = xbt_strdup(name);
141 simdata->computation_amount = 0;
142 simdata->message_size = 0;
143 simdata->compute = NULL;
144 simdata->comm = NULL;
145 simdata->rate = -1.0;
147 simdata->sender = NULL;
148 simdata->receiver = NULL;
149 simdata->source = NULL;
151 simdata->host_nb = host_nb;
152 simdata->host_list = xbt_new0(smx_host_t, host_nb);
153 simdata->comp_amount = computation_amount;
154 simdata->comm_amount = communication_amount;
156 for (i = 0; i < host_nb; i++)
157 simdata->host_list[i] = host_list[i]->smx_host;
162 /** \ingroup msg_task_usage
163 * \brief Executes a parallel task and waits for its termination.
165 * \param task a #m_task_t to execute on the location on which the process is running.
167 * \return #MSG_OK if the task was successfully completed, #MSG_TASK_CANCELED
168 * or #MSG_HOST_FAILURE otherwise
170 MSG_error_t MSG_parallel_task_execute(m_task_t task)
172 simdata_task_t simdata = NULL;
173 e_smx_state_t comp_state;
174 simdata_process_t p_simdata;
176 simdata = task->simdata;
177 p_simdata = SIMIX_process_self_get_data(SIMIX_process_self());
179 xbt_assert((!simdata->compute)
180 && (task->simdata->isused == 0),
181 "This task is executed somewhere else. Go fix your code!");
183 xbt_assert(simdata->host_nb,
184 "This is not a parallel task. Go to hell.");
186 XBT_DEBUG("Parallel computing on %s", SIMIX_host_get_name(p_simdata->m_host->smx_host));
191 simcall_host_parallel_execute(task->name, simdata->host_nb,
193 simdata->comp_amount,
194 simdata->comm_amount, 1.0, -1.0);
195 XBT_DEBUG("Parallel execution action created: %p", simdata->compute);
197 p_simdata->waiting_action = simdata->compute;
198 comp_state = simcall_host_execution_wait(simdata->compute);
199 p_simdata->waiting_action = NULL;
201 XBT_DEBUG("Finished waiting for execution of action %p, state = %d", simdata->compute, (int)comp_state);
205 if (comp_state == SIMIX_DONE) {
206 /* action ended, set comm and compute = NULL, the actions is already destroyed in the main function */
207 simdata->computation_amount = 0.0;
208 simdata->comm = NULL;
209 simdata->compute = NULL;
211 } else if (simcall_host_get_state(SIMIX_host_self()) == 0) {
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_HOST_FAILURE);
217 /* action ended, set comm and compute = NULL, the actions is already destroyed in the main function */
218 simdata->comm = NULL;
219 simdata->compute = NULL;
220 MSG_RETURN(MSG_TASK_CANCELED);
225 /** \ingroup msg_task_usage
226 * \brief Sleep for the specified number of seconds
228 * Makes the current process sleep until \a time seconds have elapsed.
230 * \param nb_sec a number of second
232 MSG_error_t MSG_process_sleep(double nb_sec)
235 /*m_process_t proc = MSG_process_self();*/
238 TRACE_msg_process_sleep_in(MSG_process_self());
241 /* create action to sleep */
242 state = simcall_process_sleep(nb_sec);
244 /*proc->simdata->waiting_action = act_sleep;
246 FIXME: check if not setting the waiting_action breaks something on msg
248 proc->simdata->waiting_action = NULL;*/
250 if (state == SIMIX_DONE) {
252 TRACE_msg_process_sleep_out(MSG_process_self());
257 TRACE_msg_process_sleep_out(MSG_process_self());
259 MSG_RETURN(MSG_HOST_FAILURE);
263 /** \ingroup msg_task_usage
264 * \brief Deprecated function that used to receive a task from a mailbox from a specific host.
266 * Sorry, this function is not supported anymore. That wouldn't be
267 * impossible to reimplement it, but we are lacking the time to do so ourselves.
268 * If you need this functionality, you can either:
270 * - implement the buffering mechanism on the user-level by queuing all messages
271 * received in the mailbox that do not match your expectation
272 * - change your application logic to leverage the mailboxes features. For example,
273 * if you have A receiving messages from B and C, you could have A waiting on
274 * mailbox "A" most of the time, but on "A#B" when it's waiting for specific
275 * messages from B and "A#C" when waiting for messages from C. You could even get A
276 * sometime waiting on all these mailboxes using @ref MSG_comm_waitany. You can find
277 * an example of use of this function in the @ref MSG_examples section.
278 * - Provide a proper patch to implement this functionality back in MSG. That wouldn't be
279 * very difficult actually. Check the function @ref MSG_mailbox_get_task_ext. During its call to
280 * simcall_comm_recv(), the 5th argument, match_fun, is NULL. Create a function that filters
281 * messages according to the host (that you will pass as sixth argument to simcall_comm_recv()
282 * and that your filtering function will receive as first parameter, and then, the filter could
283 * simply compare the host names, for example. After sufficient testing, provide an example that
284 * we could add to the distribution, and your first contribution to SimGrid is ready. Thanks in advance.
286 * \param task a memory location for storing a #m_task_t.
287 * \param alias name of the mailbox to receive the task from
288 * \param host a #m_host_t host from where the task was sent
291 * #MSG_OK if the task was successfully received,
292 * #MSG_HOST_FAILURE, or #MSG_TRANSFER_FAILURE otherwise.
295 MSG_task_receive_from_host(m_task_t * task, const char *alias,
298 return MSG_task_receive_ext(task, alias, -1, host);
301 /** \ingroup msg_task_usage
302 * \brief Receives a task from a mailbox.
304 * This is a blocking function, the execution flow will be blocked
305 * until the task is received. See #MSG_task_irecv
306 * for receiving tasks asynchronously.
308 * \param task a memory location for storing a #m_task_t.
309 * \param alias name of the mailbox to receive the task from
312 * #MSG_OK if the task was successfully received,
313 * #MSG_HOST_FAILURE, or #MSG_TRANSFER_FAILURE otherwise.
315 MSG_error_t MSG_task_receive(m_task_t * task, const char *alias)
317 return MSG_task_receive_with_timeout(task, alias, -1);
320 /** \ingroup msg_task_usage
321 * \brief Receives a task from a mailbox with a given timeout.
323 * This is a blocking function with a timeout, the execution flow will be blocked
324 * until the task is received or the timeout is achieved. See #MSG_task_irecv
325 * for receiving tasks asynchronously. You can provide a -1 timeout
326 * to obtain an infinite timeout.
328 * \param task a memory location for storing a #m_task_t.
329 * \param alias name of the mailbox to receive the task from
330 * \param timeout is the maximum wait time for completion (if -1, this call is the same as #MSG_task_receive)
333 * #MSG_OK if the task was successfully received,
334 * #MSG_HOST_FAILURE, or #MSG_TRANSFER_FAILURE, or #MSG_TIMEOUT otherwise.
337 MSG_task_receive_with_timeout(m_task_t * task, const char *alias,
340 return MSG_task_receive_ext(task, alias, timeout, NULL);
343 /** \ingroup msg_task_usage
344 * \brief Receives a task from a mailbox from a specific host with a given timeout.
346 * This is a blocking function with a timeout, the execution flow will be blocked
347 * until the task is received or the timeout is achieved. See #MSG_task_irecv
348 * for receiving tasks asynchronously. You can provide a -1 timeout
349 * to obtain an infinite timeout.
351 * \param task a memory location for storing a #m_task_t.
352 * \param alias name of the mailbox to receive the task from
353 * \param timeout is the maximum wait time for completion (provide -1 for no timeout)
354 * \param host a #m_host_t host from where the task was sent
357 * #MSG_OK if the task was successfully received,
358 * #MSG_HOST_FAILURE, or #MSG_TRANSFER_FAILURE, or #MSG_TIMEOUT otherwise.
361 MSG_task_receive_ext(m_task_t * task, const char *alias, double timeout,
365 ("MSG_task_receive_ext: Trying to receive a message on mailbox '%s'",
367 return MSG_mailbox_get_task_ext(MSG_mailbox_get_by_alias(alias), task,
371 /** \ingroup msg_task_usage
372 * \brief Sends a task on a mailbox.
374 * This is a non blocking function: use MSG_comm_wait() or MSG_comm_test()
375 * to end the communication.
377 * \param task a #m_task_t to send on another location.
378 * \param alias name of the mailbox to sent the task to
379 * \return the msg_comm_t communication created
381 msg_comm_t MSG_task_isend(m_task_t task, const char *alias)
383 return MSG_task_isend_with_matching(task,alias,NULL,NULL);
386 /** \ingroup msg_task_usage
387 * \brief Sends a task on a mailbox, with support for matching requests
389 * This is a non blocking function: use MSG_comm_wait() or MSG_comm_test()
390 * to end the communication.
392 * \param task a #m_task_t to send on another location.
393 * \param alias name of the mailbox to sent the task to
394 * \param match_fun boolean function which parameters are:
395 * - match_data_provided_here
396 * - match_data_provided_by_other_side_if_any
397 * - the_smx_action_describing_the_other_side
398 * \param match_data user provided data passed to match_fun
399 * \return the msg_comm_t communication created
401 XBT_INLINE msg_comm_t MSG_task_isend_with_matching(m_task_t task, const char *alias,
402 int (*match_fun)(void*,void*, smx_action_t),
405 simdata_task_t t_simdata = NULL;
406 m_process_t process = MSG_process_self();
407 msg_mailbox_t mailbox = MSG_mailbox_get_by_alias(alias);
409 /* FIXME: these functions are not traceable */
411 /* Prepare the task to send */
412 t_simdata = task->simdata;
413 t_simdata->sender = process;
414 t_simdata->source = ((simdata_process_t) SIMIX_process_self_get_data(process))->m_host;
416 xbt_assert(t_simdata->isused == 0,
417 "This task is still being used somewhere else. You cannot send it now. Go fix your code!");
419 t_simdata->isused = 1;
420 t_simdata->comm = NULL;
421 msg_global->sent_msg++;
423 /* Send it by calling SIMIX network layer */
424 msg_comm_t comm = xbt_new0(s_msg_comm_t, 1);
425 comm->task_sent = task;
426 comm->task_received = NULL;
427 comm->status = MSG_OK;
429 simcall_comm_isend(mailbox, t_simdata->message_size,
430 t_simdata->rate, task, sizeof(void *), match_fun, NULL, match_data, 0);
431 t_simdata->comm = comm->s_comm; /* FIXME: is the field t_simdata->comm still useful? */
436 /** \ingroup msg_task_usage
437 * \brief Sends a task on a mailbox.
439 * This is a non blocking detached send function.
440 * Think of it as a best effort send. Keep in mind that the third parameter
441 * is only called if the communication fails. If the communication does work,
442 * it is responsibility of the receiver code to free anything related to
443 * the task, as usual. More details on this can be obtained on
444 * <a href="http://lists.gforge.inria.fr/pipermail/simgrid-user/2011-November/002649.html">this thread</a>
445 * in the SimGrid-user mailing list archive.
447 * \param task a #m_task_t to send on another location.
448 * \param alias name of the mailbox to sent the task to
449 * \param cleanup a function to destroy the task if the
450 * communication fails, e.g. MSG_task_destroy
451 * (if NULL, no function will be called)
453 void MSG_task_dsend(m_task_t task, const char *alias, void_f_pvoid_t cleanup)
455 simdata_task_t t_simdata = NULL;
456 m_process_t process = MSG_process_self();
457 msg_mailbox_t mailbox = MSG_mailbox_get_by_alias(alias);
459 /* FIXME: these functions are not traceable */
461 /* Prepare the task to send */
462 t_simdata = task->simdata;
463 t_simdata->sender = process;
464 t_simdata->source = ((simdata_process_t) SIMIX_process_self_get_data(process))->m_host;
466 xbt_assert(t_simdata->isused == 0,
467 "This task is still being used somewhere else. You cannot send it now. Go fix your code!");
469 t_simdata->isused = 1;
470 t_simdata->comm = NULL;
471 msg_global->sent_msg++;
473 /* Send it by calling SIMIX network layer */
474 smx_action_t comm = simcall_comm_isend(mailbox, t_simdata->message_size,
475 t_simdata->rate, task, sizeof(void *), NULL, cleanup, NULL, 1);
476 t_simdata->comm = comm;
479 /** \ingroup msg_task_usage
480 * \brief Starts listening for receiving a task from an asynchronous communication.
482 * This is a non blocking function: use MSG_comm_wait() or MSG_comm_test()
483 * to end the communication.
485 * \param task a memory location for storing a #m_task_t. has to be valid until the end of the communication.
486 * \param name of the mailbox to receive the task on
487 * \return the msg_comm_t communication created
489 msg_comm_t MSG_task_irecv(m_task_t *task, const char *name)
491 smx_rdv_t rdv = MSG_mailbox_get_by_alias(name);
493 /* FIXME: these functions are not traceable */
496 xbt_assert(task, "Null pointer for the task storage");
500 ("MSG_task_irecv() was asked to write in a non empty task struct.");
502 /* Try to receive it by calling SIMIX network layer */
503 msg_comm_t comm = xbt_new0(s_msg_comm_t, 1);
504 comm->task_sent = NULL;
505 comm->task_received = task;
506 comm->status = MSG_OK;
507 comm->s_comm = simcall_comm_irecv(rdv, task, NULL, NULL, NULL);
512 /** \ingroup msg_task_usage
513 * \brief Checks whether a communication is done, and if yes, finalizes it.
514 * \param comm the communication to test
515 * \return TRUE if the communication is finished
516 * (but it may have failed, use MSG_comm_get_status() to know its status)
517 * or FALSE if the communication is not finished yet
518 * If the status is FALSE, don't forget to use MSG_process_sleep() after the test.
520 int MSG_comm_test(msg_comm_t comm)
525 finished = simcall_comm_test(comm->s_comm);
527 if (finished && comm->task_received != NULL) {
528 /* I am the receiver */
529 (*comm->task_received)->simdata->isused = 0;
533 switch (e.category) {
536 comm->status = MSG_HOST_FAILURE;
541 comm->status = MSG_TRANSFER_FAILURE;
546 comm->status = MSG_TIMEOUT;
559 /** \ingroup msg_task_usage
560 * \brief This function checks if a communication is finished.
561 * \param comms a vector of communications
562 * \return the position of the finished communication if any
563 * (but it may have failed, use MSG_comm_get_status() to know its status),
564 * or -1 if none is finished
566 int MSG_comm_testany(xbt_dynar_t comms)
569 int finished_index = -1;
571 /* create the equivalent dynar with SIMIX objects */
572 xbt_dynar_t s_comms = xbt_dynar_new(sizeof(smx_action_t), NULL);
575 xbt_dynar_foreach(comms, cursor, comm) {
576 xbt_dynar_push(s_comms, &comm->s_comm);
579 MSG_error_t status = MSG_OK;
581 finished_index = simcall_comm_testany(s_comms);
584 switch (e.category) {
587 finished_index = e.value;
588 status = MSG_HOST_FAILURE;
592 finished_index = e.value;
593 status = MSG_TRANSFER_FAILURE;
597 finished_index = e.value;
598 status = MSG_TIMEOUT;
606 xbt_dynar_free(&s_comms);
608 if (finished_index != -1) {
609 comm = xbt_dynar_get_as(comms, finished_index, msg_comm_t);
610 /* the communication is finished */
611 comm->status = status;
613 if (status == MSG_OK && comm->task_received != NULL) {
614 /* I am the receiver */
615 (*comm->task_received)->simdata->isused = 0;
619 return finished_index;
622 /** \ingroup msg_task_usage
623 * \brief Destroys a communication.
624 * \param comm the communication to destroy.
626 void MSG_comm_destroy(msg_comm_t comm)
631 /** \ingroup msg_task_usage
632 * \brief Wait for the completion of a communication.
634 * It takes two parameters.
635 * \param comm the communication to wait.
636 * \param timeout Wait until the communication terminates or the timeout
637 * occurs. You can provide a -1 timeout to obtain an infinite timeout.
638 * \return MSG_error_t
640 MSG_error_t MSG_comm_wait(msg_comm_t comm, double timeout)
644 simcall_comm_wait(comm->s_comm, timeout);
646 if (comm->task_received != NULL) {
647 /* I am the receiver */
648 (*comm->task_received)->simdata->isused = 0;
651 /* FIXME: these functions are not traceable */
654 switch (e.category) {
656 comm->status = MSG_HOST_FAILURE;
659 comm->status = MSG_TRANSFER_FAILURE;
662 comm->status = MSG_TIMEOUT;
673 /** \ingroup msg_task_usage
674 * \brief This function is called by a sender and permit to wait for each communication
676 * \param comm a vector of communication
677 * \param nb_elem is the size of the comm vector
678 * \param timeout for each call of MSG_comm_wait
680 void MSG_comm_waitall(msg_comm_t * comm, int nb_elem, double timeout)
683 for (i = 0; i < nb_elem; i++) {
684 MSG_comm_wait(comm[i], timeout);
688 /** \ingroup msg_task_usage
689 * \brief This function waits for the first communication finished in a list.
690 * \param comms a vector of communications
691 * \return the position of the first finished communication
692 * (but it may have failed, use MSG_comm_get_status() to know its status)
694 int MSG_comm_waitany(xbt_dynar_t comms)
697 int finished_index = -1;
699 /* create the equivalent dynar with SIMIX objects */
700 xbt_dynar_t s_comms = xbt_dynar_new(sizeof(smx_action_t), NULL);
703 xbt_dynar_foreach(comms, cursor, comm) {
704 xbt_dynar_push(s_comms, &comm->s_comm);
707 MSG_error_t status = MSG_OK;
709 finished_index = simcall_comm_waitany(s_comms);
712 switch (e.category) {
715 finished_index = e.value;
716 status = MSG_HOST_FAILURE;
720 finished_index = e.value;
721 status = MSG_TRANSFER_FAILURE;
725 finished_index = e.value;
726 status = MSG_TIMEOUT;
735 xbt_assert(finished_index != -1, "WaitAny returned -1");
736 xbt_dynar_free(&s_comms);
738 comm = xbt_dynar_get_as(comms, finished_index, msg_comm_t);
739 /* the communication is finished */
740 comm->status = status;
742 if (comm->task_received != NULL) {
743 /* I am the receiver */
744 (*comm->task_received)->simdata->isused = 0;
747 return finished_index;
751 * \ingroup msg_task_usage
752 * \brief Returns the error (if any) that occured during a finished communication.
753 * \param comm a finished communication
754 * \return the status of the communication, or #MSG_OK if no error occured
755 * during the communication
757 MSG_error_t MSG_comm_get_status(msg_comm_t comm) {
762 /** \ingroup msg_task_usage
763 * \brief Get a task (#m_task_t) from a communication
765 * \param comm the communication where to get the task
766 * \return the task from the communication
768 m_task_t MSG_comm_get_task(msg_comm_t comm)
770 xbt_assert(comm, "Invalid parameter");
772 return comm->task_received ? *comm->task_received : comm->task_sent;
776 * \brief This function is called by SIMIX to copy the data of a comm.
777 * \param comm the comm
778 * \param buff the data copied
779 * \param buff_size size of the buffer
781 void MSG_comm_copy_data_from_SIMIX(smx_action_t comm, void* buff, size_t buff_size) {
784 SIMIX_comm_copy_pointer_callback(comm, buff, buff_size);
786 // notify the user callback if any
787 if (msg_global->task_copy_callback) {
788 m_task_t task = buff;
789 msg_global->task_copy_callback(task,
790 simcall_comm_get_src_proc(comm), simcall_comm_get_dst_proc(comm));
794 /** \ingroup msg_task_usage
795 * \brief Sends a task to a mailbox
797 * This is a blocking function, the execution flow will be blocked
798 * until the task is sent (and received in the other side if #MSG_task_receive is used).
799 * See #MSG_task_isend for sending tasks asynchronously.
801 * \param task the task to be sent
802 * \param alias the mailbox name to where the task is sent
804 * \return Returns #MSG_OK if the task was successfully sent,
805 * #MSG_HOST_FAILURE, or #MSG_TRANSFER_FAILURE otherwise.
807 MSG_error_t MSG_task_send(m_task_t task, const char *alias)
809 XBT_DEBUG("MSG_task_send: Trying to send a message on mailbox '%s'", alias);
810 return MSG_task_send_with_timeout(task, alias, -1);
813 /** \ingroup msg_task_usage
814 * \brief Sends a task to a mailbox with a maximum rate
816 * This is a blocking function, the execution flow will be blocked
817 * until the task is sent. The maxrate parameter allows the application
818 * to limit the bandwidth utilization of network links when sending the task.
820 * \param task the task to be sent
821 * \param alias the mailbox name to where the task is sent
822 * \param maxrate the maximum communication rate for sending this task
824 * \return Returns #MSG_OK if the task was successfully sent,
825 * #MSG_HOST_FAILURE, or #MSG_TRANSFER_FAILURE otherwise.
828 MSG_task_send_bounded(m_task_t task, const char *alias, double maxrate)
830 task->simdata->rate = maxrate;
831 return MSG_task_send(task, alias);
834 /** \ingroup msg_task_usage
835 * \brief Sends a task to a mailbox with a timeout
837 * This is a blocking function, the execution flow will be blocked
838 * until the task is sent or the timeout is achieved.
840 * \param task the task to be sent
841 * \param alias the mailbox name to where the task is sent
842 * \param timeout is the maximum wait time for completion (if -1, this call is the same as #MSG_task_send)
844 * \return Returns #MSG_OK if the task was successfully sent,
845 * #MSG_HOST_FAILURE, or #MSG_TRANSFER_FAILURE, or #MSG_TIMEOUT otherwise.
848 MSG_task_send_with_timeout(m_task_t task, const char *alias,
851 return MSG_mailbox_put_with_timeout(MSG_mailbox_get_by_alias(alias),
855 /** \ingroup msg_task_usage
856 * \brief Check if there is a communication going on in a mailbox.
858 * \param alias the name of the mailbox to be considered
860 * \return Returns 1 if there is a communication, 0 otherwise
862 int MSG_task_listen(const char *alias)
864 return !MSG_mailbox_is_empty(MSG_mailbox_get_by_alias(alias));
867 /** \ingroup msg_task_usage
868 * \brief Check the number of communication actions of a given host pending in a mailbox.
870 * \param alias the name of the mailbox to be considered
871 * \param host the host to check for communication
873 * \return Returns the number of pending communication actions of the host in the
874 * given mailbox, 0 if there is no pending communication actions.
877 int MSG_task_listen_from_host(const char *alias, m_host_t host)
880 MSG_mailbox_get_count_host_waiting_tasks(MSG_mailbox_get_by_alias
884 /** \ingroup msg_task_usage
885 * \brief Look if there is a communication on a mailbox and return the
886 * PID of the sender process.
888 * \param alias the name of the mailbox to be considered
890 * \return Returns the PID of sender process,
891 * -1 if there is no communication in the mailbox.
893 int MSG_task_listen_from(const char *alias)
898 (task = MSG_mailbox_get_head(MSG_mailbox_get_by_alias(alias))))
901 return MSG_process_get_PID(task->simdata->sender);
904 /** \ingroup msg_task_usage
905 * \brief Sets the tracing category of a task.
907 * This function should be called after the creation of
908 * a MSG task, to define the category of that task. The
909 * first parameter task must contain a task that was
910 * created with the function #MSG_task_create. The second
911 * parameter category must contain a category that was
912 * previously declared with the function #TRACE_category
913 * (or with #TRACE_category_with_color).
915 * See \ref tracing_tracing for details on how to trace
916 * the (categorized) resource utilization.
918 * \param task the task that is going to be categorized
919 * \param category the name of the category to be associated to the task
921 * \see MSG_task_get_category, TRACE_category, TRACE_category_with_color
923 void MSG_task_set_category (m_task_t task, const char *category)
926 TRACE_msg_set_task_category (task, category);
930 /** \ingroup msg_task_usage
932 * \brief Gets the current tracing category of a task.
934 * \param task the task to be considered
936 * \see MSG_task_set_category
938 * \return Returns the name of the tracing category of the given task, NULL otherwise
940 const char *MSG_task_get_category (m_task_t task)
943 return task->category;
949 #ifdef MSG_USE_DEPRECATED
950 /** \ingroup msg_deprecated_functions
952 * \brief Return the last value returned by a MSG function (except
955 MSG_error_t MSG_get_errno(void)
957 return PROCESS_GET_ERRNO();
960 /** \ingroup msg_deprecated_functions
961 * \brief Put a task on a channel of an host and waits for the end of the
964 * This function is used for describing the behavior of a process. It
965 * takes three parameter.
966 * \param task a #m_task_t to send on another location. This task
967 will not be usable anymore when the function will return. There is
968 no automatic task duplication and you have to save your parameters
969 before calling this function. Tasks are unique and once it has been
970 sent to another location, you should not access it anymore. You do
971 not need to call MSG_task_destroy() but to avoid using, as an
972 effect of inattention, this task anymore, you definitely should
973 renitialize it with #MSG_TASK_UNINITIALIZED. Note that this task
974 can be transfered iff it has been correctly created with
976 * \param dest the destination of the message
977 * \param channel the channel on which the process should put this
978 task. This value has to be >=0 and < than the maximal number of
979 channels fixed with MSG_set_channel_number().
980 * \return #MSG_HOST_FAILURE if the host on which
981 * this function was called was shut down,
982 * #MSG_TRANSFER_FAILURE if the transfer could not be properly done
983 * (network failure, dest failure) or #MSG_OK if it succeeded.
985 MSG_error_t MSG_task_put(m_task_t task, m_host_t dest, m_channel_t channel)
987 XBT_WARN("DEPRECATED! Now use MSG_task_send");
988 return MSG_task_put_with_timeout(task, dest, channel, -1.0);
991 /** \ingroup msg_deprecated_functions
992 * \brief Does exactly the same as MSG_task_put but with a bounded transmition
998 MSG_task_put_bounded(m_task_t task, m_host_t dest, m_channel_t channel,
1001 XBT_WARN("DEPRECATED! Now use MSG_task_send_bounded");
1002 task->simdata->rate = maxrate;
1003 return MSG_task_put(task, dest, channel);
1006 /** \ingroup msg_deprecated_functions
1008 * \brief Put a task on a channel of an
1009 * host (with a timeout on the waiting of the destination host) and
1010 * waits for the end of the transmission.
1012 * This function is used for describing the behavior of a process. It
1013 * takes four parameter.
1014 * \param task a #m_task_t to send on another location. This task
1015 will not be usable anymore when the function will return. There is
1016 no automatic task duplication and you have to save your parameters
1017 before calling this function. Tasks are unique and once it has been
1018 sent to another location, you should not access it anymore. You do
1019 not need to call MSG_task_destroy() but to avoid using, as an
1020 effect of inattention, this task anymore, you definitely should
1021 renitialize it with #MSG_TASK_UNINITIALIZED. Note that this task
1022 can be transfered iff it has been correctly created with
1024 * \param dest the destination of the message
1025 * \param channel the channel on which the process should put this
1026 task. This value has to be >=0 and < than the maximal number of
1027 channels fixed with MSG_set_channel_number().
1028 * \param timeout the maximum time to wait for a task before giving
1029 up. In such a case, #MSG_TRANSFER_FAILURE will be returned, \a task
1030 will not be modified
1031 * \return #MSG_HOST_FAILURE if the host on which
1032 this function was called was shut down,
1033 #MSG_TRANSFER_FAILURE if the transfer could not be properly done
1034 (network failure, dest failure, timeout...) or #MSG_OK if the communication succeeded.
1037 MSG_task_put_with_timeout(m_task_t task, m_host_t dest,
1038 m_channel_t channel, double timeout)
1040 XBT_WARN("DEPRECATED! Now use MSG_task_send_with_timeout");
1041 xbt_assert((channel >= 0)
1042 && (channel < msg_global->max_channel), "Invalid channel %d",
1045 XBT_DEBUG("MSG_task_put_with_timout: Trying to send a task to '%s'", SIMIX_host_get_name(dest->smx_host));
1047 MSG_mailbox_put_with_timeout(MSG_mailbox_get_by_channel
1048 (dest, channel), task, timeout);
1051 /** \ingroup msg_deprecated_functions
1052 * \brief Test whether there is a pending communication on a channel, and who sent it.
1054 * It takes one parameter.
1055 * \param channel the channel on which the process should be
1056 listening. This value has to be >=0 and < than the maximal
1057 number of channels fixed with MSG_set_channel_number().
1058 * \return -1 if there is no pending communication and the PID of the process who sent it otherwise
1060 int MSG_task_probe_from(m_channel_t channel)
1062 XBT_WARN("DEPRECATED! Now use MSG_task_listen_from");
1065 xbt_assert((channel >= 0)
1066 && (channel < msg_global->max_channel), "Invalid channel %d",
1071 MSG_mailbox_get_head(MSG_mailbox_get_by_channel
1072 (MSG_host_self(), channel))))
1075 return MSG_process_get_PID(task->simdata->sender);
1078 /** \ingroup msg_deprecated_functions
1079 * \brief Test whether there is a pending communication on a channel.
1081 * It takes one parameter.
1082 * \param channel the channel on which the process should be
1083 listening. This value has to be >=0 and < than the maximal
1084 number of channels fixed with MSG_set_channel_number().
1085 * \return 1 if there is a pending communication and 0 otherwise
1087 int MSG_task_Iprobe(m_channel_t channel)
1089 XBT_WARN("DEPRECATED!");
1090 xbt_assert((channel >= 0)
1091 && (channel < msg_global->max_channel), "Invalid channel %d",
1095 !MSG_mailbox_is_empty(MSG_mailbox_get_by_channel
1096 (MSG_host_self(), channel));
1099 /** \ingroup msg_deprecated_functions
1101 * \brief Return the number of tasks waiting to be received on a \a
1102 channel and sent by \a host.
1104 * It takes two parameters.
1105 * \param channel the channel on which the process should be
1106 listening. This value has to be >=0 and < than the maximal
1107 number of channels fixed with MSG_set_channel_number().
1108 * \param host the host that is to be watched.
1109 * \return the number of tasks waiting to be received on \a channel
1110 and sent by \a host.
1112 int MSG_task_probe_from_host(int channel, m_host_t host)
1114 XBT_WARN("DEPRECATED! Now use MSG_task_listen_from_host");
1115 xbt_assert((channel >= 0)
1116 && (channel < msg_global->max_channel), "Invalid channel %d",
1120 MSG_mailbox_get_count_host_waiting_tasks(MSG_mailbox_get_by_channel
1121 (MSG_host_self(), channel),
1126 /** \ingroup msg_deprecated_functions
1127 * \brief Listen on \a channel and waits for receiving a task from \a host.
1129 * It takes three parameters.
1130 * \param task a memory location for storing a #m_task_t. It will
1131 hold a task when this function will return. Thus \a task should not
1132 be equal to \c NULL and \a *task should be equal to \c NULL. If one of
1133 those two condition does not hold, there will be a warning message.
1134 * \param channel the channel on which the process should be
1135 listening. This value has to be >=0 and < than the maximal
1136 number of channels fixed with MSG_set_channel_number().
1137 * \param host the host that is to be watched.
1138 * \return a #MSG_error_t indicating whether the operation was successful (#MSG_OK), or why it failed otherwise.
1141 MSG_task_get_from_host(m_task_t * task, m_channel_t channel, m_host_t host)
1143 XBT_WARN("DEPRECATED! Now use MSG_task_receive_from_host");
1144 return MSG_task_get_ext(task, channel, -1, host);
1147 /** \ingroup msg_deprecated_functions
1148 * \brief Listen on a channel and wait for receiving a task.
1150 * It takes two parameters.
1151 * \param task a memory location for storing a #m_task_t. It will
1152 hold a task when this function will return. Thus \a task should not
1153 be equal to \c NULL and \a *task should be equal to \c NULL. If one of
1154 those two condition does not hold, there will be a warning message.
1155 * \param channel the channel on which the process should be
1156 listening. This value has to be >=0 and < than the maximal
1157 number of channels fixed with MSG_set_channel_number().
1158 * \return a #MSG_error_t indicating whether the operation was successful (#MSG_OK), or why it failed otherwise.
1160 MSG_error_t MSG_task_get(m_task_t * task, m_channel_t channel)
1162 XBT_WARN("DEPRECATED! Now use MSG_task_receive");
1163 return MSG_task_get_with_timeout(task, channel, -1);
1166 /** \ingroup msg_deprecated_functions
1167 * \brief Listen on a channel and wait for receiving a task with a timeout.
1169 * It takes three parameters.
1170 * \param task a memory location for storing a #m_task_t. It will
1171 hold a task when this function will return. Thus \a task should not
1172 be equal to \c NULL and \a *task should be equal to \c NULL. If one of
1173 those two condition does not hold, there will be a warning message.
1174 * \param channel the channel on which the process should be
1175 listening. This value has to be >=0 and < than the maximal
1176 number of channels fixed with MSG_set_channel_number().
1177 * \param max_duration the maximum time to wait for a task before giving
1178 up. In such a case, #MSG_TRANSFER_FAILURE will be returned, \a task
1179 will not be modified and will still be
1180 equal to \c NULL when returning.
1181 * \return a #MSG_error_t indicating whether the operation was successful (#MSG_OK), or why it failed otherwise.
1184 MSG_task_get_with_timeout(m_task_t * task, m_channel_t channel,
1185 double max_duration)
1187 XBT_WARN("DEPRECATED! Now use MSG_task_receive_with_timeout");
1188 return MSG_task_get_ext(task, channel, max_duration, NULL);
1192 MSG_task_get_ext(m_task_t * task, m_channel_t channel, double timeout,
1195 XBT_WARN("DEPRECATED! Now use MSG_task_receive_ext");
1196 xbt_assert((channel >= 0)
1197 && (channel < msg_global->max_channel), "Invalid channel %d",
1201 MSG_mailbox_get_task_ext(MSG_mailbox_get_by_channel
1202 (MSG_host_self(), channel), task, host,