3 /* Copyright (c) 2008, 2009, 2010. 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,
48 msg_mailbox_t MSG_mailbox_get_by_alias(const char *alias)
51 msg_mailbox_t mailbox = simcall_rdv_get_by_name(alias);
54 mailbox = MSG_mailbox_new(alias);
59 /** \ingroup msg_mailbox_management
60 * \brief Set the mailbox to receive in asynchronous mode
62 * All messages sent to this mailbox will be transferred to
63 * the receiver without waiting for the receive call.
64 * The receive call will still be necessary to use the received data.
65 * If there is a need to receive some messages asynchronously, and some not,
66 * two different mailboxes should be used.
68 * \param alias The name of the mailbox
70 void MSG_mailbox_set_async(const char *alias){
71 msg_mailbox_t mailbox = MSG_mailbox_get_by_alias(alias);
73 simcall_rdv_set_receiver(mailbox, SIMIX_process_self());
74 XBT_VERB("%s mailbox set to receive eagerly for process %p\n",alias, SIMIX_process_self());
78 /** \ingroup msg_mailbox_management
79 * \brief Get a task from a mailbox on a given host
81 * \param mailbox The mailbox where the task was sent
82 * \param task a memory location for storing a #msg_task_t.
83 * \param host a #msg_host_t host from where the task was sent
84 * \param timeout a timeout
87 * #MSG_OK if the task was successfully received,
88 * #MSG_HOST_FAILURE, or #MSG_TRANSFER_FAILURE otherwise.
91 MSG_mailbox_get_task_ext(msg_mailbox_t mailbox, msg_task_t * task,
92 msg_host_t host, double timeout)
95 msg_error_t ret = MSG_OK;
96 /* We no longer support getting a task from a specific host */
101 TRACE_msg_task_get_start();
102 double start_time = MSG_get_clock();
106 xbt_assert(task, "Null pointer for the task storage");
110 ("Asked to write the received task in a non empty struct -- proceeding.");
112 /* Try to receive it by calling SIMIX network layer */
114 simcall_comm_recv(mailbox, task, NULL, NULL, NULL, timeout);
115 XBT_DEBUG("Got task %s from %p",(*task)->name,mailbox);
116 (*task)->simdata->isused=0;
119 switch (e.category) {
121 ret = MSG_TRANSFER_FAILURE;
133 if (ret != MSG_HOST_FAILURE &&
134 ret != MSG_TRANSFER_FAILURE &&
135 ret != MSG_TIMEOUT) {
136 TRACE_msg_task_get_end(start_time, *task);
143 MSG_mailbox_put_with_timeout(msg_mailbox_t mailbox, msg_task_t task,
147 msg_error_t ret = MSG_OK;
148 simdata_task_t t_simdata = NULL;
149 msg_process_t process = MSG_process_self();
150 simdata_process_t p_simdata = SIMIX_process_self_get_data(process);
153 int call_end = TRACE_msg_task_put_start(task); //must be after CHECK_HOST()
156 /* Prepare the task to send */
157 t_simdata = task->simdata;
158 t_simdata->sender = process;
159 t_simdata->source = ((simdata_process_t) SIMIX_process_self_get_data(process))->m_host;
161 xbt_assert(t_simdata->isused == 0,
162 "This task is still being used somewhere else. You cannot send it now. Go fix your code!");
165 t_simdata->comm = NULL;
166 msg_global->sent_msg++;
169 p_simdata->waiting_task = task;
171 /* Try to send it by calling SIMIX network layer */
173 smx_action_t comm = simcall_comm_isend(mailbox, t_simdata->message_size,
174 t_simdata->rate, task, sizeof(void *),
175 NULL, NULL, task, 0);
177 if (TRACE_is_enabled()) {
178 simcall_set_category(comm, task->category);
181 t_simdata->comm = comm;
182 simcall_comm_wait(comm, timeout);
186 switch (e.category) {
188 ret = MSG_TRANSFER_FAILURE;
198 /* If the send failed, it is not used anymore */
199 t_simdata->isused = 0;
203 p_simdata->waiting_task = NULL;
206 TRACE_msg_task_put_end();
211 #ifdef MSG_USE_DEPRECATED
212 msg_mailbox_t MSG_mailbox_get_by_channel(msg_host_t host,
215 XBT_WARN("DEPRECATED! Now use MSG_mailbox_get_by_alias");
216 xbt_assert((host != NULL), "Invalid host");
217 xbt_assert((channel >= 0)
218 && (channel < msg_global->max_channel), "Invalid channel %d",
221 return host->mailboxes[(size_t) channel];