1 /* Copyright (c) 2004-2013. 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"
13 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(msg_gos, msg,
14 "Logging specific to MSG (gos)");
16 /** \ingroup msg_task_usage
17 * \brief Executes a task and waits for its termination.
19 * This function is used for describing the behavior of a process. It
20 * takes only one parameter.
21 * \param task a #msg_task_t to execute on the location on which the process is running.
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(msg_task_t task)
27 /* TODO: add this to other locations */
28 msg_host_t host = MSG_process_get_host(MSG_process_self());
29 MSG_host_add_task(host, task);
31 msg_error_t ret = MSG_parallel_task_execute(task);
33 MSG_host_del_task(host, task);
38 /** \ingroup msg_task_usage
39 * \brief Executes a parallel task and waits for its termination.
41 * \param task a #msg_task_t to execute on the location on which the process is running.
43 * \return #MSG_OK if the task was successfully completed, #MSG_TASK_CANCELED
44 * or #MSG_HOST_FAILURE otherwise
46 msg_error_t MSG_parallel_task_execute(msg_task_t task)
49 simdata_task_t simdata = task->simdata;
50 msg_process_t self = SIMIX_process_self();
51 simdata_process_t p_simdata = SIMIX_process_self_get_data(self);
52 e_smx_state_t comp_state;
53 msg_error_t status = MSG_OK;
56 TRACE_msg_task_execute_start(task);
59 xbt_assert((!simdata->compute) && (task->simdata->isused == 0),
60 "This task is executed somewhere else. Go fix your code! %d",
61 task->simdata->isused);
63 XBT_DEBUG("Computing on %s", MSG_process_get_name(MSG_process_self()));
65 if (simdata->computation_amount == 0 && !simdata->host_nb) {
67 TRACE_msg_task_execute_end(task);
77 if (simdata->host_nb > 0) {
78 simdata->compute = simcall_host_parallel_execute(task->name,
84 XBT_DEBUG("Parallel execution action created: %p", simdata->compute);
86 unsigned long affinity_mask = (unsigned long) xbt_dict_get_or_null_ext(simdata->affinity_mask_db, (char *) p_simdata->m_host, sizeof(msg_host_t));
87 XBT_DEBUG("execute %s@%s with affinity(0x%04lx)", MSG_task_get_name(task), MSG_host_get_name(p_simdata->m_host), affinity_mask);
89 simdata->compute = simcall_host_execute(task->name,
91 simdata->computation_amount,
99 simcall_set_category(simdata->compute, task->category);
101 p_simdata->waiting_action = simdata->compute;
102 comp_state = simcall_host_execution_wait(simdata->compute);
104 p_simdata->waiting_action = NULL;
108 XBT_DEBUG("Execution task '%s' finished in state %d",
109 task->name, (int)comp_state);
112 switch (e.category) {
114 status = MSG_TASK_CANCELED;
117 status = MSG_HOST_FAILURE;
124 /* action ended, set comm and compute = NULL, the actions is already destroyed
125 * in the main function */
126 simdata->computation_amount = 0.0;
127 simdata->comm = NULL;
128 simdata->compute = NULL;
130 TRACE_msg_task_execute_end(task);
137 /** \ingroup msg_task_usage
138 * \brief Sleep for the specified number of seconds
140 * Makes the current process sleep until \a time seconds have elapsed.
142 * \param nb_sec a number of second
144 msg_error_t MSG_process_sleep(double nb_sec)
147 msg_error_t status = MSG_OK;
148 /*msg_process_t proc = MSG_process_self();*/
151 TRACE_msg_process_sleep_in(MSG_process_self());
154 /* create action to sleep */
156 /*proc->simdata->waiting_action = act_sleep;
158 FIXME: check if not setting the waiting_action breaks something on msg
160 proc->simdata->waiting_action = NULL;*/
163 simcall_process_sleep(nb_sec);
166 switch (e.category) {
168 status = MSG_TASK_CANCELED;
177 TRACE_msg_process_sleep_out(MSG_process_self());
182 /** \ingroup msg_task_usage
183 * \brief Deprecated function that used to receive a task from a mailbox from a specific host.
185 * Sorry, this function is not supported anymore. That wouldn't be
186 * impossible to reimplement it, but we are lacking the time to do so ourselves.
187 * If you need this functionality, you can either:
189 * - implement the buffering mechanism on the user-level by queuing all messages
190 * received in the mailbox that do not match your expectation
191 * - change your application logic to leverage the mailboxes features. For example,
192 * if you have A receiving messages from B and C, you could have A waiting on
193 * mailbox "A" most of the time, but on "A#B" when it's waiting for specific
194 * messages from B and "A#C" when waiting for messages from C. You could even get A
195 * sometime waiting on all these mailboxes using @ref MSG_comm_waitany. You can find
196 * an example of use of this function in the @ref MSG_examples section.
197 * - Provide a proper patch to implement this functionality back in MSG. That wouldn't be
198 * very difficult actually. Check the function @ref MSG_mailbox_get_task_ext. During its call to
199 * simcall_comm_recv(), the 5th argument, match_fun, is NULL. Create a function that filters
200 * messages according to the host (that you will pass as sixth argument to simcall_comm_recv()
201 * and that your filtering function will receive as first parameter, and then, the filter could
202 * simply compare the host names, for example. After sufficient testing, provide an example that
203 * we could add to the distribution, and your first contribution to SimGrid is ready. Thanks in advance.
205 * \param task a memory location for storing a #msg_task_t.
206 * \param alias name of the mailbox to receive the task from
207 * \param host a #msg_host_t host from where the task was sent
210 * #MSG_OK if the task was successfully received,
211 * #MSG_HOST_FAILURE, or #MSG_TRANSFER_FAILURE otherwise.
214 MSG_task_receive_from_host(msg_task_t * task, const char *alias,
217 return MSG_task_receive_ext(task, alias, -1, host);
221 *\brief Deprecated function that used to receive a task from a mailbox from a specific host
222 *\brief at a given rate
224 * \param task a memory location for storing a #msg_task_t.
225 * \param alias name of the mailbox to receive the task from
226 * \param host a #msg_host_t host from where the task was sent
227 * \param rate limit the reception to rate bandwidth
230 * #MSG_OK if the task was successfully received,
231 * #MSG_HOST_FAILURE, or #MSG_TRANSFER_FAILURE otherwise.
234 MSG_task_receive_from_host_bounded(msg_task_t * task, const char *alias,
235 msg_host_t host, double rate)
237 return MSG_task_receive_ext_bounded(task, alias, -1, host, rate);
240 /** \ingroup msg_task_usage
241 * \brief Receives a task from a mailbox.
243 * This is a blocking function, the execution flow will be blocked
244 * until the task is received. See #MSG_task_irecv
245 * for receiving tasks asynchronously.
247 * \param task a memory location for storing a #msg_task_t.
248 * \param alias name of the mailbox to receive the task from
251 * #MSG_OK if the task was successfully received,
252 * #MSG_HOST_FAILURE, or #MSG_TRANSFER_FAILURE otherwise.
254 msg_error_t MSG_task_receive(msg_task_t * task, const char *alias)
256 return MSG_task_receive_with_timeout(task, alias, -1);
259 /** \ingroup msg_task_usage
260 * \brief Receives a task from a mailbox at a given rate.
262 * \param task a memory location for storing a #msg_task_t.
263 * \param alias name of the mailbox to receive the task from
264 * \param rate limit the reception to rate bandwidth
267 * #MSG_OK if the task was successfully received,
268 * #MSG_HOST_FAILURE, or #MSG_TRANSFER_FAILURE otherwise.
270 msg_error_t MSG_task_receive_bounded(msg_task_t * task, const char *alias, double rate)
272 return MSG_task_receive_with_timeout_bounded(task, alias, -1, rate);
275 /** \ingroup msg_task_usage
276 * \brief Receives a task from a mailbox with a given timeout.
278 * This is a blocking function with a timeout, the execution flow will be blocked
279 * until the task is received or the timeout is achieved. See #MSG_task_irecv
280 * for receiving tasks asynchronously. You can provide a -1 timeout
281 * to obtain an infinite timeout.
283 * \param task a memory location for storing a #msg_task_t.
284 * \param alias name of the mailbox to receive the task from
285 * \param timeout is the maximum wait time for completion (if -1, this call is the same as #MSG_task_receive)
288 * #MSG_OK if the task was successfully received,
289 * #MSG_HOST_FAILURE, or #MSG_TRANSFER_FAILURE, or #MSG_TIMEOUT otherwise.
292 MSG_task_receive_with_timeout(msg_task_t * task, const char *alias,
295 return MSG_task_receive_ext(task, alias, timeout, NULL);
298 /** \ingroup msg_task_usage
299 * \brief Receives a task from a mailbox with a given timeout and at a given rate.
301 * \param task a memory location for storing a #msg_task_t.
302 * \param alias name of the mailbox to receive the task from
303 * \param timeout is the maximum wait time for completion (if -1, this call is the same as #MSG_task_receive)
304 * \param rate limit the reception to rate bandwidth
307 * #MSG_OK if the task was successfully received,
308 * #MSG_HOST_FAILURE, or #MSG_TRANSFER_FAILURE, or #MSG_TIMEOUT otherwise.
311 MSG_task_receive_with_timeout_bounded(msg_task_t * task, const char *alias,
312 double timeout,double rate)
314 return MSG_task_receive_ext_bounded(task, alias, timeout, NULL,rate);
317 /** \ingroup msg_task_usage
318 * \brief Receives a task from a mailbox from a specific host with a given timeout.
320 * This is a blocking function with a timeout, the execution flow will be blocked
321 * until the task is received or the timeout is achieved. See #MSG_task_irecv
322 * for receiving tasks asynchronously. You can provide a -1 timeout
323 * to obtain an infinite timeout.
325 * \param task a memory location for storing a #msg_task_t.
326 * \param alias name of the mailbox to receive the task from
327 * \param timeout is the maximum wait time for completion (provide -1 for no timeout)
328 * \param host a #msg_host_t host from where the task was sent
331 * #MSG_OK if the task was successfully received,
332 * #MSG_HOST_FAILURE, or #MSG_TRANSFER_FAILURE, or #MSG_TIMEOUT otherwise.
335 MSG_task_receive_ext(msg_task_t * task, const char *alias, double timeout,
339 msg_error_t ret = MSG_OK;
341 ("MSG_task_receive_ext: Trying to receive a message on mailbox '%s'",
344 ret = MSG_mailbox_get_task_ext(MSG_mailbox_get_by_alias(alias), task,
348 switch (e.category) {
349 case cancel_error: /* may be thrown by MSG_mailbox_get_by_alias */
350 ret = MSG_HOST_FAILURE;
360 /** \ingroup msg_task_usage
361 * \brief Receives a task from a mailbox from a specific host with a given timeout
362 * and at a given rate.
364 * \param task a memory location for storing a #msg_task_t.
365 * \param alias name of the mailbox to receive the task from
366 * \param timeout is the maximum wait time for completion (provide -1 for no timeout)
367 * \param host a #msg_host_t host from where the task was sent
368 * \param rate limit the reception to rate bandwidth
371 * #MSG_OK if the task was successfully received,
372 * #MSG_HOST_FAILURE, or #MSG_TRANSFER_FAILURE, or #MSG_TIMEOUT otherwise.
375 MSG_task_receive_ext_bounded(msg_task_t * task, const char *alias, double timeout,
376 msg_host_t host, double rate)
379 ("MSG_task_receive_ext: Trying to receive a message on mailbox '%s'",
381 return MSG_mailbox_get_task_ext_bounded(MSG_mailbox_get_by_alias(alias), task,
382 host, timeout, rate);
385 /** \ingroup msg_task_usage
386 * \brief Sends a task on a mailbox.
388 * This is a non blocking function: use MSG_comm_wait() or MSG_comm_test()
389 * to end the communication.
391 * \param task a #msg_task_t to send on another location.
392 * \param alias name of the mailbox to sent the task to
393 * \return the msg_comm_t communication created
395 msg_comm_t MSG_task_isend(msg_task_t task, const char *alias)
397 return MSG_task_isend_with_matching(task,alias,NULL,NULL);
400 /** \ingroup msg_task_usage
401 * \brief Sends a task on a mailbox with a maximum rate
403 * This is a non blocking function: use MSG_comm_wait() or MSG_comm_test()
404 * to end the communication. The maxrate parameter allows the application
405 * to limit the bandwidth utilization of network links when sending the task.
407 * \param task a #msg_task_t to send on another location.
408 * \param alias name of the mailbox to sent the task to
409 * \param maxrate the maximum communication rate for sending this task .
410 * \return the msg_comm_t communication created
412 msg_comm_t MSG_task_isend_bounded(msg_task_t task, const char *alias, double maxrate)
414 task->simdata->rate = maxrate;
415 return MSG_task_isend_with_matching(task,alias,NULL,NULL);
419 /** \ingroup msg_task_usage
420 * \brief Sends a task on a mailbox, with support for matching requests
422 * This is a non blocking function: use MSG_comm_wait() or MSG_comm_test()
423 * to end the communication.
425 * \param task a #msg_task_t to send on another location.
426 * \param alias name of the mailbox to sent the task to
427 * \param match_fun boolean function which parameters are:
428 * - match_data_provided_here
429 * - match_data_provided_by_other_side_if_any
430 * - the_smx_action_describing_the_other_side
431 * \param match_data user provided data passed to match_fun
432 * \return the msg_comm_t communication created
434 XBT_INLINE msg_comm_t MSG_task_isend_with_matching(msg_task_t task, const char *alias,
435 int (*match_fun)(void*,void*, smx_action_t),
438 simdata_task_t t_simdata = NULL;
439 msg_process_t process = MSG_process_self();
440 msg_mailbox_t mailbox = MSG_mailbox_get_by_alias(alias);
443 int call_end = TRACE_msg_task_put_start(task);
446 /* Prepare the task to send */
447 t_simdata = task->simdata;
448 t_simdata->sender = process;
449 t_simdata->source = ((simdata_process_t) SIMIX_process_self_get_data(process))->m_host;
451 xbt_assert(t_simdata->isused == 0,
452 "This task is still being used somewhere else. You cannot send it now. Go fix your code!");
454 t_simdata->isused = 1;
455 t_simdata->comm = NULL;
456 msg_global->sent_msg++;
458 /* Send it by calling SIMIX network layer */
459 msg_comm_t comm = xbt_new0(s_msg_comm_t, 1);
460 comm->task_sent = task;
461 comm->task_received = NULL;
462 comm->status = MSG_OK;
464 simcall_comm_isend(mailbox, t_simdata->message_size,
465 t_simdata->rate, task, sizeof(void *), match_fun, NULL, match_data, 0);
466 t_simdata->comm = comm->s_comm; /* FIXME: is the field t_simdata->comm still useful? */
468 if (TRACE_is_enabled()) {
469 simcall_set_category(comm->s_comm, task->category);
475 TRACE_msg_task_put_end();
481 /** \ingroup msg_task_usage
482 * \brief Sends a task on a mailbox.
484 * This is a non blocking detached send function.
485 * Think of it as a best effort send. Keep in mind that the third parameter
486 * is only called if the communication fails. If the communication does work,
487 * it is responsibility of the receiver code to free anything related to
488 * the task, as usual. More details on this can be obtained on
489 * <a href="http://lists.gforge.inria.fr/pipermail/simgrid-user/2011-November/002649.html">this thread</a>
490 * in the SimGrid-user mailing list archive.
492 * \param task a #msg_task_t to send on another location.
493 * \param alias name of the mailbox to sent the task to
494 * \param cleanup a function to destroy the task if the
495 * communication fails, e.g. MSG_task_destroy
496 * (if NULL, no function will be called)
498 void MSG_task_dsend(msg_task_t task, const char *alias, void_f_pvoid_t cleanup)
500 simdata_task_t t_simdata = NULL;
501 msg_process_t process = MSG_process_self();
502 msg_mailbox_t mailbox = MSG_mailbox_get_by_alias(alias);
504 /* Prepare the task to send */
505 t_simdata = task->simdata;
506 t_simdata->sender = process;
507 t_simdata->source = ((simdata_process_t) SIMIX_process_self_get_data(process))->m_host;
509 xbt_assert(t_simdata->isused == 0,
510 "This task is still being used somewhere else. You cannot send it now. Go fix your code!");
512 t_simdata->isused = 1;
513 t_simdata->comm = NULL;
514 msg_global->sent_msg++;
517 int call_end = TRACE_msg_task_put_start(task);
520 /* Send it by calling SIMIX network layer */
521 smx_action_t comm = simcall_comm_isend(mailbox, t_simdata->message_size,
522 t_simdata->rate, task, sizeof(void *), NULL, cleanup, NULL, 1);
523 t_simdata->comm = comm;
525 if (TRACE_is_enabled()) {
526 simcall_set_category(comm, task->category);
532 TRACE_msg_task_put_end();
537 /** \ingroup msg_task_usage
538 * \brief Sends a task on a mailbox with a maximal rate.
540 * This is a non blocking detached send function.
541 * Think of it as a best effort send. Keep in mind that the third parameter
542 * is only called if the communication fails. If the communication does work,
543 * it is responsibility of the receiver code to free anything related to
544 * the task, as usual. More details on this can be obtained on
545 * <a href="http://lists.gforge.inria.fr/pipermail/simgrid-user/2011-November/002649.html">this thread</a>
546 * in the SimGrid-user mailing list archive.
548 * \param task a #msg_task_t to send on another location.
549 * \param alias name of the mailbox to sent the task to
550 * \param cleanup a function to destroy the task if the
551 * communication fails, e.g. MSG_task_destroy
552 * (if NULL, no function will be called)
553 * \param maxrate the maximum communication rate for sending this task
556 void MSG_task_dsend_bounded(msg_task_t task, const char *alias, void_f_pvoid_t cleanup, double maxrate)
558 task->simdata->rate = maxrate;
560 simdata_task_t t_simdata = NULL;
561 msg_process_t process = MSG_process_self();
562 msg_mailbox_t mailbox = MSG_mailbox_get_by_alias(alias);
564 /* Prepare the task to send */
565 t_simdata = task->simdata;
566 t_simdata->sender = process;
567 t_simdata->source = ((simdata_process_t) SIMIX_process_self_get_data(process))->m_host;
569 xbt_assert(t_simdata->isused == 0,
570 "This task is still being used somewhere else. You cannot send it now. Go fix your code!");
572 t_simdata->isused = 1;
573 t_simdata->comm = NULL;
574 msg_global->sent_msg++;
577 int call_end = TRACE_msg_task_put_start(task);
580 /* Send it by calling SIMIX network layer */
581 smx_action_t comm = simcall_comm_isend(mailbox, t_simdata->message_size,
582 t_simdata->rate, task, sizeof(void *), NULL, cleanup, NULL, 1);
583 t_simdata->comm = comm;
585 if (TRACE_is_enabled()) {
586 simcall_set_category(comm, task->category);
592 TRACE_msg_task_put_end();
596 /** \ingroup msg_task_usage
597 * \brief Starts listening for receiving a task from an asynchronous communication.
599 * This is a non blocking function: use MSG_comm_wait() or MSG_comm_test()
600 * to end the communication.
602 * \param task a memory location for storing a #msg_task_t. has to be valid until the end of the communication.
603 * \param name of the mailbox to receive the task on
604 * \return the msg_comm_t communication created
606 msg_comm_t MSG_task_irecv(msg_task_t *task, const char *name)
608 smx_rdv_t rdv = MSG_mailbox_get_by_alias(name);
610 /* FIXME: these functions are not traceable */
613 xbt_assert(task, "Null pointer for the task storage");
617 ("MSG_task_irecv() was asked to write in a non empty task struct.");
619 /* Try to receive it by calling SIMIX network layer */
620 msg_comm_t comm = xbt_new0(s_msg_comm_t, 1);
621 comm->task_sent = NULL;
622 comm->task_received = task;
623 comm->status = MSG_OK;
624 comm->s_comm = simcall_comm_irecv(rdv, task, NULL, NULL, NULL);
629 /** \ingroup msg_task_usage
630 * \brief Starts listening for receiving a task from an asynchronous communication
633 * \param task a memory location for storing a #msg_task_t. has to be valid until the end of the communication.
634 * \param name of the mailbox to receive the task on
635 * \param rate limit the bandwidth to the given rate
636 * \return the msg_comm_t communication created
638 msg_comm_t MSG_task_irecv_bounded(msg_task_t *task, const char *name, double rate)
642 smx_rdv_t rdv = MSG_mailbox_get_by_alias(name);
644 /* FIXME: these functions are not traceable */
647 xbt_assert(task, "Null pointer for the task storage");
651 ("MSG_task_irecv() was asked to write in a non empty task struct.");
653 /* Try to receive it by calling SIMIX network layer */
654 msg_comm_t comm = xbt_new0(s_msg_comm_t, 1);
655 comm->task_sent = NULL;
656 comm->task_received = task;
657 comm->status = MSG_OK;
658 comm->s_comm = simcall_comm_irecv_bounded(rdv, task, NULL, NULL, NULL, rate);
663 /** \ingroup msg_task_usage
664 * \brief Checks whether a communication is done, and if yes, finalizes it.
665 * \param comm the communication to test
666 * \return TRUE if the communication is finished
667 * (but it may have failed, use MSG_comm_get_status() to know its status)
668 * or FALSE if the communication is not finished yet
669 * If the status is FALSE, don't forget to use MSG_process_sleep() after the test.
671 int MSG_comm_test(msg_comm_t comm)
677 finished = simcall_comm_test(comm->s_comm);
679 if (finished && comm->task_received != NULL) {
680 /* I am the receiver */
681 (*comm->task_received)->simdata->isused = 0;
685 switch (e.category) {
687 comm->status = MSG_TRANSFER_FAILURE;
692 comm->status = MSG_TIMEOUT;
705 /** \ingroup msg_task_usage
706 * \brief This function checks if a communication is finished.
707 * \param comms a vector of communications
708 * \return the position of the finished communication if any
709 * (but it may have failed, use MSG_comm_get_status() to know its status),
710 * or -1 if none is finished
712 int MSG_comm_testany(xbt_dynar_t comms)
715 int finished_index = -1;
717 /* create the equivalent dynar with SIMIX objects */
718 xbt_dynar_t s_comms = xbt_dynar_new(sizeof(smx_action_t), NULL);
721 xbt_dynar_foreach(comms, cursor, comm) {
722 xbt_dynar_push(s_comms, &comm->s_comm);
725 msg_error_t status = MSG_OK;
727 finished_index = simcall_comm_testany(s_comms);
730 switch (e.category) {
732 finished_index = e.value;
733 status = MSG_TRANSFER_FAILURE;
737 finished_index = e.value;
738 status = MSG_TIMEOUT;
746 xbt_dynar_free(&s_comms);
748 if (finished_index != -1) {
749 comm = xbt_dynar_get_as(comms, finished_index, msg_comm_t);
750 /* the communication is finished */
751 comm->status = status;
753 if (status == MSG_OK && comm->task_received != NULL) {
754 /* I am the receiver */
755 (*comm->task_received)->simdata->isused = 0;
759 return finished_index;
762 /** \ingroup msg_task_usage
763 * \brief Destroys a communication.
764 * \param comm the communication to destroy.
766 void MSG_comm_destroy(msg_comm_t comm)
771 /** \ingroup msg_task_usage
772 * \brief Wait for the completion of a communication.
774 * It takes two parameters.
775 * \param comm the communication to wait.
776 * \param timeout Wait until the communication terminates or the timeout
777 * occurs. You can provide a -1 timeout to obtain an infinite timeout.
778 * \return msg_error_t
780 msg_error_t MSG_comm_wait(msg_comm_t comm, double timeout)
784 simcall_comm_wait(comm->s_comm, timeout);
786 if (comm->task_received != NULL) {
787 /* I am the receiver */
788 (*comm->task_received)->simdata->isused = 0;
791 /* FIXME: these functions are not traceable */
794 switch (e.category) {
796 comm->status = MSG_TRANSFER_FAILURE;
799 comm->status = MSG_TIMEOUT;
810 /** \ingroup msg_task_usage
811 * \brief This function is called by a sender and permit to wait for each communication
813 * \param comm a vector of communication
814 * \param nb_elem is the size of the comm vector
815 * \param timeout for each call of MSG_comm_wait
817 void MSG_comm_waitall(msg_comm_t * comm, int nb_elem, double timeout)
820 for (i = 0; i < nb_elem; i++) {
821 MSG_comm_wait(comm[i], timeout);
825 /** \ingroup msg_task_usage
826 * \brief This function waits for the first communication finished in a list.
827 * \param comms a vector of communications
828 * \return the position of the first finished communication
829 * (but it may have failed, use MSG_comm_get_status() to know its status)
831 int MSG_comm_waitany(xbt_dynar_t comms)
834 int finished_index = -1;
836 /* create the equivalent dynar with SIMIX objects */
837 xbt_dynar_t s_comms = xbt_dynar_new(sizeof(smx_action_t), NULL);
840 xbt_dynar_foreach(comms, cursor, comm) {
841 xbt_dynar_push(s_comms, &comm->s_comm);
844 msg_error_t status = MSG_OK;
846 finished_index = simcall_comm_waitany(s_comms);
849 switch (e.category) {
851 finished_index = e.value;
852 status = MSG_TRANSFER_FAILURE;
856 finished_index = e.value;
857 status = MSG_TIMEOUT;
866 xbt_assert(finished_index != -1, "WaitAny returned -1");
867 xbt_dynar_free(&s_comms);
869 comm = xbt_dynar_get_as(comms, finished_index, msg_comm_t);
870 /* the communication is finished */
871 comm->status = status;
873 if (comm->task_received != NULL) {
874 /* I am the receiver */
875 (*comm->task_received)->simdata->isused = 0;
878 return finished_index;
882 * \ingroup msg_task_usage
883 * \brief Returns the error (if any) that occured during a finished communication.
884 * \param comm a finished communication
885 * \return the status of the communication, or #MSG_OK if no error occured
886 * during the communication
888 msg_error_t MSG_comm_get_status(msg_comm_t comm) {
893 /** \ingroup msg_task_usage
894 * \brief Get a task (#msg_task_t) from a communication
896 * \param comm the communication where to get the task
897 * \return the task from the communication
899 msg_task_t MSG_comm_get_task(msg_comm_t comm)
901 xbt_assert(comm, "Invalid parameter");
903 return comm->task_received ? *comm->task_received : comm->task_sent;
907 * \brief This function is called by SIMIX in kernel mode to copy the data of a comm.
908 * \param comm the comm
909 * \param buff the data copied
910 * \param buff_size size of the buffer
912 void MSG_comm_copy_data_from_SIMIX(smx_action_t comm, void* buff, size_t buff_size) {
915 SIMIX_comm_copy_pointer_callback(comm, buff, buff_size);
917 // notify the user callback if any
918 if (msg_global->task_copy_callback) {
919 msg_task_t task = buff;
920 msg_global->task_copy_callback(task,
921 simcall_comm_get_src_proc(comm), simcall_comm_get_dst_proc(comm));
925 /** \ingroup msg_task_usage
926 * \brief Sends a task to a mailbox
928 * This is a blocking function, the execution flow will be blocked
929 * until the task is sent (and received in the other side if #MSG_task_receive is used).
930 * See #MSG_task_isend for sending tasks asynchronously.
932 * \param task the task to be sent
933 * \param alias the mailbox name to where the task is sent
935 * \return Returns #MSG_OK if the task was successfully sent,
936 * #MSG_HOST_FAILURE, or #MSG_TRANSFER_FAILURE otherwise.
938 msg_error_t MSG_task_send(msg_task_t task, const char *alias)
940 XBT_DEBUG("MSG_task_send: Trying to send a message on mailbox '%s'", alias);
941 return MSG_task_send_with_timeout(task, alias, -1);
944 /** \ingroup msg_task_usage
945 * \brief Sends a task to a mailbox with a maximum rate
947 * This is a blocking function, the execution flow will be blocked
948 * until the task is sent. The maxrate parameter allows the application
949 * to limit the bandwidth utilization of network links when sending the task.
951 * \param task the task to be sent
952 * \param alias the mailbox name to where the task is sent
953 * \param maxrate the maximum communication rate for sending this task
955 * \return Returns #MSG_OK if the task was successfully sent,
956 * #MSG_HOST_FAILURE, or #MSG_TRANSFER_FAILURE otherwise.
959 MSG_task_send_bounded(msg_task_t task, const char *alias, double maxrate)
961 task->simdata->rate = maxrate;
962 return MSG_task_send(task, alias);
965 /** \ingroup msg_task_usage
966 * \brief Sends a task to a mailbox with a timeout
968 * This is a blocking function, the execution flow will be blocked
969 * until the task is sent or the timeout is achieved.
971 * \param task the task to be sent
972 * \param alias the mailbox name to where the task is sent
973 * \param timeout is the maximum wait time for completion (if -1, this call is the same as #MSG_task_send)
975 * \return Returns #MSG_OK if the task was successfully sent,
976 * #MSG_HOST_FAILURE, or #MSG_TRANSFER_FAILURE, or #MSG_TIMEOUT otherwise.
979 MSG_task_send_with_timeout(msg_task_t task, const char *alias,
982 return MSG_mailbox_put_with_timeout(MSG_mailbox_get_by_alias(alias),
986 /** \ingroup msg_task_usage
987 * \brief Sends a task to a mailbox with a timeout and with a maximum rate
989 * This is a blocking function, the execution flow will be blocked
990 * until the task is sent or the timeout is achieved.
992 * \param task the task to be sent
993 * \param alias the mailbox name to where the task is sent
994 * \param timeout is the maximum wait time for completion (if -1, this call is the same as #MSG_task_send)
995 * \param maxrate the maximum communication rate for sending this task
997 * \return Returns #MSG_OK if the task was successfully sent,
998 * #MSG_HOST_FAILURE, or #MSG_TRANSFER_FAILURE, or #MSG_TIMEOUT otherwise.
1001 MSG_task_send_with_timeout_bounded(msg_task_t task, const char *alias,
1002 double timeout, double maxrate)
1004 task->simdata->rate = maxrate;
1005 return MSG_mailbox_put_with_timeout(MSG_mailbox_get_by_alias(alias),
1009 /** \ingroup msg_task_usage
1010 * \brief Check if there is a communication going on in a mailbox.
1012 * \param alias the name of the mailbox to be considered
1014 * \return Returns 1 if there is a communication, 0 otherwise
1016 int MSG_task_listen(const char *alias)
1018 return !MSG_mailbox_is_empty(MSG_mailbox_get_by_alias(alias));
1021 /** \ingroup msg_task_usage
1022 * \brief Check the number of communication actions of a given host pending in a mailbox.
1024 * \param alias the name of the mailbox to be considered
1025 * \param host the host to check for communication
1027 * \return Returns the number of pending communication actions of the host in the
1028 * given mailbox, 0 if there is no pending communication actions.
1031 int MSG_task_listen_from_host(const char *alias, msg_host_t host)
1034 MSG_mailbox_get_count_host_waiting_tasks(MSG_mailbox_get_by_alias
1038 /** \ingroup msg_task_usage
1039 * \brief Look if there is a communication on a mailbox and return the
1040 * PID of the sender process.
1042 * \param alias the name of the mailbox to be considered
1044 * \return Returns the PID of sender process,
1045 * -1 if there is no communication in the mailbox.
1047 int MSG_task_listen_from(const char *alias)
1052 (task = MSG_mailbox_get_head(MSG_mailbox_get_by_alias(alias))))
1055 return MSG_process_get_PID(task->simdata->sender);
1058 /** \ingroup msg_task_usage
1059 * \brief Sets the tracing category of a task.
1061 * This function should be called after the creation of
1062 * a MSG task, to define the category of that task. The
1063 * first parameter task must contain a task that was
1064 * created with the function #MSG_task_create. The second
1065 * parameter category must contain a category that was
1066 * previously declared with the function #TRACE_category
1067 * (or with #TRACE_category_with_color).
1069 * See \ref tracing for details on how to trace
1070 * the (categorized) resource utilization.
1072 * \param task the task that is going to be categorized
1073 * \param category the name of the category to be associated to the task
1075 * \see MSG_task_get_category, TRACE_category, TRACE_category_with_color
1077 void MSG_task_set_category (msg_task_t task, const char *category)
1080 TRACE_msg_set_task_category (task, category);
1084 /** \ingroup msg_task_usage
1086 * \brief Gets the current tracing category of a task.
1088 * \param task the task to be considered
1090 * \see MSG_task_set_category
1092 * \return Returns the name of the tracing category of the given task, NULL otherwise
1094 const char *MSG_task_get_category (msg_task_t task)
1097 return task->category;
1104 * \brief Returns the value of a given AS or router property
1106 * \param asr the name of a router or AS
1107 * \param name a property name
1108 * \return value of a property (or NULL if property not set)
1110 const char *MSG_as_router_get_property_value(const char* asr, const char *name)
1112 return xbt_dict_get_or_null(MSG_as_router_get_properties(asr), name);
1116 * \brief Returns a xbt_dict_t consisting of the list of properties assigned to
1117 * a the AS or router
1119 * \param asr the name of a router or AS
1120 * \return a dict containing the properties
1122 xbt_dict_t MSG_as_router_get_properties(const char* asr)
1124 return (simcall_asr_get_properties(asr));
1128 * \brief Change the value of a given AS or router
1130 * \param asr the name of a router or AS
1131 * \param name a property name
1132 * \param value what to change the property to
1133 * \param free_ctn the freeing function to use to kill the value on need
1135 void MSG_as_router_set_property_value(const char* asr, const char *name, char *value,void_f_pvoid_t free_ctn) {
1136 xbt_dict_set(MSG_as_router_get_properties(asr), name, value,free_ctn);
1139 #ifdef MSG_USE_DEPRECATED
1140 /** \ingroup msg_deprecated_functions
1142 * \brief Return the last value returned by a MSG function (except
1143 * MSG_get_errno...).
1145 msg_error_t MSG_get_errno(void)
1147 return PROCESS_GET_ERRNO();
1150 /** \ingroup msg_deprecated_functions
1151 * \brief Put a task on a channel of an host and waits for the end of the
1154 * This function is used for describing the behavior of a process. It
1155 * takes three parameter.
1156 * \param task a #msg_task_t to send on another location. This task
1157 will not be usable anymore when the function will return. There is
1158 no automatic task duplication and you have to save your parameters
1159 before calling this function. Tasks are unique and once it has been
1160 sent to another location, you should not access it anymore. You do
1161 not need to call MSG_task_destroy() but to avoid using, as an
1162 effect of inattention, this task anymore, you definitely should
1163 renitialize it with #MSG_TASK_UNINITIALIZED. Note that this task
1164 can be transfered iff it has been correctly created with
1166 * \param dest the destination of the message
1167 * \param channel the channel on which the process should put this
1168 task. This value has to be >=0 and < than the maximal number of
1169 channels fixed with MSG_set_channel_number().
1170 * \return #MSG_HOST_FAILURE if the host on which
1171 * this function was called was shut down,
1172 * #MSG_TRANSFER_FAILURE if the transfer could not be properly done
1173 * (network failure, dest failure) or #MSG_OK if it succeeded.
1175 msg_error_t MSG_task_put(msg_task_t task, msg_host_t dest, m_channel_t channel)
1177 XBT_WARN("DEPRECATED! Now use MSG_task_send");
1178 return MSG_task_put_with_timeout(task, dest, channel, -1.0);
1181 /** \ingroup msg_deprecated_functions
1182 * \brief Does exactly the same as MSG_task_put but with a bounded transmition
1188 MSG_task_put_bounded(msg_task_t task, msg_host_t dest, m_channel_t channel,
1191 XBT_WARN("DEPRECATED! Now use MSG_task_send_bounded");
1192 task->simdata->rate = maxrate;
1193 return MSG_task_put(task, dest, channel);
1196 /** \ingroup msg_deprecated_functions
1198 * \brief Put a task on a channel of an
1199 * host (with a timeout on the waiting of the destination host) and
1200 * waits for the end of the transmission.
1202 * This function is used for describing the behavior of a process. It
1203 * takes four parameter.
1204 * \param task a #msg_task_t to send on another location. This task
1205 will not be usable anymore when the function will return. There is
1206 no automatic task duplication and you have to save your parameters
1207 before calling this function. Tasks are unique and once it has been
1208 sent to another location, you should not access it anymore. You do
1209 not need to call MSG_task_destroy() but to avoid using, as an
1210 effect of inattention, this task anymore, you definitely should
1211 renitialize it with #MSG_TASK_UNINITIALIZED. Note that this task
1212 can be transfered iff it has been correctly created with
1214 * \param dest the destination of the message
1215 * \param channel the channel on which the process should put this
1216 task. This value has to be >=0 and < than the maximal number of
1217 channels fixed with MSG_set_channel_number().
1218 * \param timeout the maximum time to wait for a task before giving
1219 up. In such a case, #MSG_TRANSFER_FAILURE will be returned, \a task
1220 will not be modified
1221 * \return #MSG_HOST_FAILURE if the host on which
1222 this function was called was shut down,
1223 #MSG_TRANSFER_FAILURE if the transfer could not be properly done
1224 (network failure, dest failure, timeout...) or #MSG_OK if the communication succeeded.
1227 MSG_task_put_with_timeout(msg_task_t task, msg_host_t dest,
1228 m_channel_t channel, double timeout)
1230 XBT_WARN("DEPRECATED! Now use MSG_task_send_with_timeout");
1231 xbt_assert((channel >= 0)
1232 && (channel < msg_global->max_channel), "Invalid channel %d",
1235 XBT_DEBUG("MSG_task_put_with_timout: Trying to send a task to '%s'", MSG_host_get_name(dest));
1237 MSG_mailbox_put_with_timeout(MSG_mailbox_get_by_channel
1238 (dest, channel), task, timeout);
1241 /** \ingroup msg_deprecated_functions
1242 * \brief Test whether there is a pending communication on a channel, and who sent it.
1244 * It takes one parameter.
1245 * \param channel the channel on which the process should be
1246 listening. This value has to be >=0 and < than the maximal
1247 number of channels fixed with MSG_set_channel_number().
1248 * \return -1 if there is no pending communication and the PID of the process who sent it otherwise
1250 int MSG_task_probe_from(m_channel_t channel)
1252 XBT_WARN("DEPRECATED! Now use MSG_task_listen_from");
1255 xbt_assert((channel >= 0)
1256 && (channel < msg_global->max_channel), "Invalid channel %d",
1261 MSG_mailbox_get_head(MSG_mailbox_get_by_channel
1262 (MSG_host_self(), channel))))
1265 return MSG_process_get_PID(task->simdata->sender);
1268 /** \ingroup msg_deprecated_functions
1269 * \brief Test whether there is a pending communication on a channel.
1271 * It takes one parameter.
1272 * \param channel the channel on which the process should be
1273 listening. This value has to be >=0 and < than the maximal
1274 number of channels fixed with MSG_set_channel_number().
1275 * \return 1 if there is a pending communication and 0 otherwise
1277 int MSG_task_Iprobe(m_channel_t channel)
1279 XBT_WARN("DEPRECATED!");
1280 xbt_assert((channel >= 0)
1281 && (channel < msg_global->max_channel), "Invalid channel %d",
1285 !MSG_mailbox_is_empty(MSG_mailbox_get_by_channel
1286 (MSG_host_self(), channel));
1289 /** \ingroup msg_deprecated_functions
1291 * \brief Return the number of tasks waiting to be received on a \a
1292 channel and sent by \a host.
1294 * It takes two parameters.
1295 * \param channel the channel on which the process should be
1296 listening. This value has to be >=0 and < than the maximal
1297 number of channels fixed with MSG_set_channel_number().
1298 * \param host the host that is to be watched.
1299 * \return the number of tasks waiting to be received on \a channel
1300 and sent by \a host.
1302 int MSG_task_probe_from_host(int channel, msg_host_t host)
1304 XBT_WARN("DEPRECATED! Now use MSG_task_listen_from_host");
1305 xbt_assert((channel >= 0)
1306 && (channel < msg_global->max_channel), "Invalid channel %d",
1310 MSG_mailbox_get_count_host_waiting_tasks(MSG_mailbox_get_by_channel
1311 (MSG_host_self(), channel),
1316 /** \ingroup msg_deprecated_functions
1317 * \brief Listen on \a channel and waits for receiving a task from \a host.
1319 * It takes three parameters.
1320 * \param task a memory location for storing a #msg_task_t. It will
1321 hold a task when this function will return. Thus \a task should not
1322 be equal to \c NULL and \a *task should be equal to \c NULL. If one of
1323 those two condition does not hold, there will be a warning message.
1324 * \param channel the channel on which the process should be
1325 listening. This value has to be >=0 and < than the maximal
1326 number of channels fixed with MSG_set_channel_number().
1327 * \param host the host that is to be watched.
1328 * \return a #msg_error_t indicating whether the operation was successful (#MSG_OK), or why it failed otherwise.
1331 MSG_task_get_from_host(msg_task_t * task, m_channel_t channel, msg_host_t host)
1333 XBT_WARN("DEPRECATED! Now use MSG_task_receive_from_host");
1334 return MSG_task_get_ext(task, channel, -1, host);
1337 /** \ingroup msg_deprecated_functions
1338 * \brief Listen on a channel and wait for receiving a task.
1340 * It takes two parameters.
1341 * \param task a memory location for storing a #msg_task_t. It will
1342 hold a task when this function will return. Thus \a task should not
1343 be equal to \c NULL and \a *task should be equal to \c NULL. If one of
1344 those two condition does not hold, there will be a warning message.
1345 * \param channel the channel on which the process should be
1346 listening. This value has to be >=0 and < than the maximal
1347 number of channels fixed with MSG_set_channel_number().
1348 * \return a #msg_error_t indicating whether the operation was successful (#MSG_OK), or why it failed otherwise.
1350 msg_error_t MSG_task_get(msg_task_t * task, m_channel_t channel)
1352 XBT_WARN("DEPRECATED! Now use MSG_task_receive");
1353 return MSG_task_get_with_timeout(task, channel, -1);
1356 /** \ingroup msg_deprecated_functions
1357 * \brief Listen on a channel and wait for receiving a task with a timeout.
1359 * It takes three parameters.
1360 * \param task a memory location for storing a #msg_task_t. It will
1361 hold a task when this function will return. Thus \a task should not
1362 be equal to \c NULL and \a *task should be equal to \c NULL. If one of
1363 those two condition does not hold, there will be a warning message.
1364 * \param channel the channel on which the process should be
1365 listening. This value has to be >=0 and < than the maximal
1366 number of channels fixed with MSG_set_channel_number().
1367 * \param max_duration the maximum time to wait for a task before giving
1368 up. In such a case, #MSG_TRANSFER_FAILURE will be returned, \a task
1369 will not be modified and will still be
1370 equal to \c NULL when returning.
1371 * \return a #msg_error_t indicating whether the operation was successful (#MSG_OK), or why it failed otherwise.
1374 MSG_task_get_with_timeout(msg_task_t * task, m_channel_t channel,
1375 double max_duration)
1377 XBT_WARN("DEPRECATED! Now use MSG_task_receive_with_timeout");
1378 return MSG_task_get_ext(task, channel, max_duration, NULL);
1382 MSG_task_get_ext(msg_task_t * task, m_channel_t channel, double timeout,
1385 XBT_WARN("DEPRECATED! Now use MSG_task_receive_ext");
1386 xbt_assert((channel >= 0)
1387 && (channel < msg_global->max_channel), "Invalid channel %d",
1391 MSG_mailbox_get_task_ext(MSG_mailbox_get_by_channel
1392 (MSG_host_self(), channel), task, host,