3 /* Copyright (c) 2008-2015. The SimGrid Team.
4 * All rights reserved. */
6 /* This program is free software; you can redistribute it and/or modify it
7 * under the terms of the license (GNU LGPL) which comes with this package. */
11 #include "simgrid/msg.h"
12 #include "msg_private.h"
13 #include "simgrid/s4u/mailbox.hpp"
15 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(msg_mailbox, msg, "Logging specific to MSG (mailbox)");
17 int MSG_mailbox_is_empty(msg_mailbox_t mailbox)
19 return mailbox->empty();
22 msg_task_t MSG_mailbox_front(msg_mailbox_t mailbox)
24 simgrid::kernel::activity::Comm* comm = static_cast<simgrid::kernel::activity::Comm*>(mailbox->front());
29 return (msg_task_t) comm->src_data;
32 msg_mailbox_t MSG_mailbox_get_by_alias(const char *alias)
34 return simgrid::s4u::Mailbox::byName(alias);
37 /** \ingroup msg_mailbox_management
38 * \brief Set the mailbox to receive in asynchronous mode
40 * All messages sent to this mailbox will be transferred to the receiver without waiting for the receive call.
41 * The receive call will still be necessary to use the received data.
42 * If there is a need to receive some messages asynchronously, and some not, two different mailboxes should be used.
44 * \param alias The name of the mailbox
46 void MSG_mailbox_set_async(const char *alias){
47 msg_mailbox_t mailbox = MSG_mailbox_get_by_alias(alias);
49 simcall_mbox_set_receiver(mailbox->getImpl(), SIMIX_process_self());
50 XBT_VERB("%s mailbox set to receive eagerly for myself\n",alias);
53 /** \ingroup msg_mailbox_management
54 * \brief Get a task from a mailbox on a given host
56 * \param mailbox The mailbox where the task was sent
57 * \param task a memory location for storing a #msg_task_t.
58 * \param host a #msg_host_t host from where the task was sent
59 * \param timeout a timeout
62 * #MSG_OK if the task was successfully received,
63 * #MSG_HOST_FAILURE, or #MSG_TRANSFER_FAILURE otherwise.
65 msg_error_t MSG_mailbox_get_task_ext(msg_mailbox_t mailbox, msg_task_t *task, msg_host_t host, double timeout)
67 return MSG_mailbox_get_task_ext_bounded(mailbox, task, host, timeout, -1.0);
70 /** \ingroup msg_mailbox_management
71 * \brief Get a task from a mailbox on a given host at a given rate
73 * \param mailbox The mailbox where the task was sent
74 * \param task a memory location for storing a #msg_task_t.
75 * \param host a #msg_host_t host from where the task was sent
76 * \param timeout a timeout
80 * #MSG_OK if the task was successfully received,
81 * #MSG_HOST_FAILURE, or #MSG_TRANSFER_FAILURE otherwise.
83 msg_error_t MSG_mailbox_get_task_ext_bounded(msg_mailbox_t mailbox, msg_task_t * task, msg_host_t host, double timeout,
86 msg_error_t ret = MSG_OK;
87 /* We no longer support getting a task from a specific host */
91 TRACE_msg_task_get_start();
92 double start_time = MSG_get_clock();
95 xbt_assert(task, "Null pointer for the task storage");
98 XBT_WARN("Asked to write the received task in a non empty struct -- proceeding.");
100 /* Try to receive it by calling SIMIX network layer */
102 simcall_comm_recv(MSG_process_self(), mailbox->getImpl(), task, nullptr, nullptr, nullptr, nullptr, timeout, rate);
103 XBT_DEBUG("Got task %s from %s",(*task)->name,mailbox->getName());
104 (*task)->simdata->setNotUsed();
107 switch (e.category) {
109 ret = MSG_HOST_FAILURE;
112 ret = MSG_TRANSFER_FAILURE;
118 ret = MSG_HOST_FAILURE;
125 if (ret != MSG_HOST_FAILURE && ret != MSG_TRANSFER_FAILURE && ret != MSG_TIMEOUT) {
126 TRACE_msg_task_get_end(start_time, *task);