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 /** @addtogroup m_mailbox_management
13 * \brief functions to manage mailbox
16 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(msg_mailbox, msg,
17 "Logging specific to MSG (mailbox)");
19 msg_mailbox_t MSG_mailbox_new(const char *alias)
21 return simcall_rdv_create(alias);
24 void MSG_mailbox_free(void *mailbox)
26 simcall_rdv_destroy((msg_mailbox_t)mailbox);
29 int MSG_mailbox_is_empty(msg_mailbox_t mailbox)
31 return (NULL == simcall_rdv_get_head(mailbox));
34 msg_task_t MSG_mailbox_get_head(msg_mailbox_t mailbox)
36 smx_action_t comm = simcall_rdv_get_head(mailbox);
41 return (msg_task_t) simcall_comm_get_src_data(comm);
45 MSG_mailbox_get_count_host_waiting_tasks(msg_mailbox_t mailbox,
48 return simcall_rdv_comm_count_by_host(mailbox,
52 msg_mailbox_t MSG_mailbox_get_by_alias(const char *alias)
55 msg_mailbox_t mailbox = simcall_rdv_get_by_name(alias);
58 mailbox = MSG_mailbox_new(alias);
63 void MSG_mailbox_set_async(const char *alias){
64 msg_mailbox_t mailbox = MSG_mailbox_get_by_alias(alias);
66 simcall_rdv_set_receiver(mailbox, SIMIX_process_self());
67 XBT_VERB("%s mailbox set to receive eagerly for process %p\n",alias, SIMIX_process_self());
71 /* \ingroup m_mailbox_management
72 * \brief Get a task from a mailbox on a given host
74 * \param mailbox The mailbox where the task was sent
75 * \param task a memory location for storing a #msg_task_t.
76 * \param host a #msg_host_t host from where the task was sent
77 * \param timeout a timeout
80 * #MSG_OK if the task was successfully received,
81 * #MSG_HOST_FAILURE, or #MSG_TRANSFER_FAILURE otherwise.
84 MSG_mailbox_get_task_ext(msg_mailbox_t mailbox, msg_task_t * task,
85 msg_host_t host, double timeout)
88 msg_error_t ret = MSG_OK;
89 /* We no longer support getting a task from a specific host */
94 TRACE_msg_task_get_start();
95 volatile double start_time = MSG_get_clock();
99 xbt_assert(task, "Null pointer for the task storage");
103 ("Asked to write the received task in a non empty struct -- proceeding.");
105 /* Try to receive it by calling SIMIX network layer */
107 simcall_comm_recv(mailbox, task, NULL, NULL, NULL, timeout);
108 XBT_DEBUG("Got task %s from %p",(*task)->name,mailbox);
109 (*task)->simdata->isused=0;
112 switch (e.category) {
114 ret = MSG_TRANSFER_FAILURE;
126 if (ret != MSG_HOST_FAILURE &&
127 ret != MSG_TRANSFER_FAILURE &&
128 ret != MSG_TIMEOUT) {
129 TRACE_msg_task_get_end(start_time, *task);
136 MSG_mailbox_put_with_timeout(msg_mailbox_t mailbox, msg_task_t task,
140 msg_error_t ret = MSG_OK;
141 simdata_task_t t_simdata = NULL;
142 msg_process_t process = MSG_process_self();
143 simdata_process_t p_simdata = SIMIX_process_self_get_data(process);
146 int call_end = TRACE_msg_task_put_start(task); //must be after CHECK_HOST()
149 /* Prepare the task to send */
150 t_simdata = task->simdata;
151 t_simdata->sender = process;
152 t_simdata->source = ((simdata_process_t) SIMIX_process_self_get_data(process))->m_host;
154 xbt_assert(t_simdata->isused == 0,
155 "This task is still being used somewhere else. You cannot send it now. Go fix your code!");
158 t_simdata->comm = NULL;
159 msg_global->sent_msg++;
162 p_simdata->waiting_task = task;
164 /* Try to send it by calling SIMIX network layer */
166 smx_action_t comm = simcall_comm_isend(mailbox, t_simdata->message_size,
167 t_simdata->rate, task, sizeof(void *),
168 NULL, NULL, task, 0);
170 if (TRACE_is_enabled()) {
171 simcall_set_category(comm, task->category);
174 t_simdata->comm = comm;
175 simcall_comm_wait(comm, timeout);
179 switch (e.category) {
181 ret = MSG_TRANSFER_FAILURE;
191 /* If the send failed, it is not used anymore */
192 t_simdata->isused = 0;
196 p_simdata->waiting_task = NULL;
199 TRACE_msg_task_put_end();
204 #ifdef MSG_USE_DEPRECATED
205 msg_mailbox_t MSG_mailbox_get_by_channel(msg_host_t host,
208 XBT_WARN("DEPRECATED! Now use MSG_mailbox_get_by_alias");
209 xbt_assert((host != NULL), "Invalid host");
210 xbt_assert((channel >= 0)
211 && (channel < msg_global->max_channel), "Invalid channel %d",
214 return host->mailboxes[(size_t) channel];