3 /* Copyright (c) 2008-2013. 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. */
9 #include "msg_mailbox.h"
10 #include "msg_private.h"
12 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(msg_mailbox, msg,
13 "Logging specific to MSG (mailbox)");
15 msg_mailbox_t MSG_mailbox_new(const char *alias)
17 return simcall_rdv_create(alias);
20 void MSG_mailbox_free(void *mailbox)
22 simcall_rdv_destroy((msg_mailbox_t)mailbox);
25 int MSG_mailbox_is_empty(msg_mailbox_t mailbox)
27 return (NULL == simcall_rdv_get_head(mailbox));
30 msg_task_t MSG_mailbox_get_head(msg_mailbox_t mailbox)
32 smx_action_t comm = simcall_rdv_get_head(mailbox);
37 return (msg_task_t) simcall_comm_get_src_data(comm);
41 MSG_mailbox_get_count_host_waiting_tasks(msg_mailbox_t mailbox,
44 return simcall_rdv_comm_count_by_host(mailbox, host);
47 msg_mailbox_t MSG_mailbox_get_by_alias(const char *alias)
50 msg_mailbox_t mailbox = simcall_rdv_get_by_name(alias);
53 mailbox = MSG_mailbox_new(alias);
58 /** \ingroup msg_mailbox_management
59 * \brief Set the mailbox to receive in asynchronous mode
61 * All messages sent to this mailbox will be transferred to
62 * the receiver without waiting for the receive call.
63 * The receive call will still be necessary to use the received data.
64 * If there is a need to receive some messages asynchronously, and some not,
65 * two different mailboxes should be used.
67 * \param alias The name of the mailbox
69 void MSG_mailbox_set_async(const char *alias){
70 msg_mailbox_t mailbox = MSG_mailbox_get_by_alias(alias);
72 simcall_rdv_set_receiver(mailbox, SIMIX_process_self());
73 XBT_VERB("%s mailbox set to receive eagerly for process %p\n",alias, SIMIX_process_self());
77 /** \ingroup msg_mailbox_management
78 * \brief Get a task from a mailbox on a given host
80 * \param mailbox The mailbox where the task was sent
81 * \param task a memory location for storing a #msg_task_t.
82 * \param host a #msg_host_t host from where the task was sent
83 * \param timeout a timeout
86 * #MSG_OK if the task was successfully received,
87 * #MSG_HOST_FAILURE, or #MSG_TRANSFER_FAILURE otherwise.
90 MSG_mailbox_get_task_ext(msg_mailbox_t mailbox, msg_task_t * task,
91 msg_host_t host, double timeout)
94 msg_error_t ret = MSG_OK;
95 /* We no longer support getting a task from a specific host */
100 TRACE_msg_task_get_start();
101 double start_time = MSG_get_clock();
105 xbt_assert(task, "Null pointer for the task storage");
109 ("Asked to write the received task in a non empty struct -- proceeding.");
111 /* Try to receive it by calling SIMIX network layer */
113 simcall_comm_recv(mailbox, task, NULL, NULL, NULL, timeout);
114 XBT_DEBUG("Got task %s from %p",(*task)->name,mailbox);
115 (*task)->simdata->isused=0;
118 switch (e.category) {
120 ret = MSG_HOST_FAILURE;
123 ret = MSG_TRANSFER_FAILURE;
135 if (ret != MSG_HOST_FAILURE &&
136 ret != MSG_TRANSFER_FAILURE &&
137 ret != MSG_TIMEOUT) {
138 TRACE_msg_task_get_end(start_time, *task);
144 /** \ingroup msg_mailbox_management
145 * \brief Get a task from a mailbox on a given host at a given rate
147 * \param mailbox The mailbox where the task was sent
148 * \param task a memory location for storing a #msg_task_t.
149 * \param host a #msg_host_t host from where the task was sent
150 * \param timeout a timeout
154 * #MSG_OK if the task was successfully received,
155 * #MSG_HOST_FAILURE, or #MSG_TRANSFER_FAILURE otherwise.
158 MSG_mailbox_get_task_ext_bounded(msg_mailbox_t mailbox, msg_task_t * task,
159 msg_host_t host, double timeout, double rate)
162 msg_error_t ret = MSG_OK;
163 /* We no longer support getting a task from a specific host */
168 TRACE_msg_task_get_start();
169 double start_time = MSG_get_clock();
173 xbt_assert(task, "Null pointer for the task storage");
177 ("Asked to write the received task in a non empty struct -- proceeding.");
179 /* Try to receive it by calling SIMIX network layer */
181 simcall_comm_recv_bounded(mailbox, task, NULL, NULL, NULL, timeout, rate);
182 XBT_DEBUG("Got task %s from %p",(*task)->name,mailbox);
183 (*task)->simdata->isused=0;
186 switch (e.category) {
188 ret = MSG_HOST_FAILURE;
191 ret = MSG_TRANSFER_FAILURE;
203 if (ret != MSG_HOST_FAILURE &&
204 ret != MSG_TRANSFER_FAILURE &&
205 ret != MSG_TIMEOUT) {
206 TRACE_msg_task_get_end(start_time, *task);
213 MSG_mailbox_put_with_timeout(msg_mailbox_t mailbox, msg_task_t task,
217 msg_error_t ret = MSG_OK;
218 simdata_task_t t_simdata = NULL;
219 msg_process_t process = MSG_process_self();
220 simdata_process_t p_simdata = SIMIX_process_self_get_data(process);
223 int call_end = TRACE_msg_task_put_start(task); //must be after CHECK_HOST()
226 /* Prepare the task to send */
227 t_simdata = task->simdata;
228 t_simdata->sender = process;
229 t_simdata->source = ((simdata_process_t) SIMIX_process_self_get_data(process))->m_host;
231 xbt_assert(t_simdata->isused == 0,
232 "This task is still being used somewhere else. You cannot send it now. Go fix your code!");
235 t_simdata->comm = NULL;
236 msg_global->sent_msg++;
239 p_simdata->waiting_task = task;
241 /* Try to send it by calling SIMIX network layer */
243 smx_action_t comm = NULL; /* MC needs the comm to be set to NULL during the simix call */
244 comm = simcall_comm_isend(mailbox, t_simdata->message_size,
245 t_simdata->rate, task, sizeof(void *),
246 NULL, NULL, task, 0);
248 if (TRACE_is_enabled()) {
249 simcall_set_category(comm, task->category);
252 t_simdata->comm = comm;
253 simcall_comm_wait(comm, timeout);
257 switch (e.category) {
259 ret = MSG_HOST_FAILURE;
262 ret = MSG_TRANSFER_FAILURE;
272 /* If the send failed, it is not used anymore */
273 t_simdata->isused = 0;
277 p_simdata->waiting_task = NULL;
280 TRACE_msg_task_put_end();
285 #ifdef MSG_USE_DEPRECATED
286 msg_mailbox_t MSG_mailbox_get_by_channel(msg_host_t host,
289 XBT_WARN("DEPRECATED! Now use MSG_mailbox_get_by_alias");
290 xbt_assert((host != NULL), "Invalid host");
291 xbt_assert((channel >= 0)
292 && (channel < msg_global->max_channel), "Invalid channel %d",
295 return host->mailboxes[(size_t) channel];