Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
ea94cefd220b9f5473ef79c7e63f59d22f4608b0
[simgrid.git] / src / msg / msg_mailbox.c
1 /* Mailboxes in MSG */
2
3 /* Copyright (c) 2008-2014. The SimGrid Team.
4  * All rights reserved.                                                     */
5
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. */
8
9 #include "msg_mailbox.h"
10 #include "msg_private.h"
11
12 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(msg_mailbox, msg,
13                                 "Logging specific to MSG (mailbox)");
14
15 msg_mailbox_t MSG_mailbox_new(const char *alias)
16 {
17   return simcall_rdv_create(alias);
18 }
19
20 void MSG_mailbox_free(void *mailbox)
21 {
22   simcall_rdv_destroy((msg_mailbox_t)mailbox);
23 }
24
25 int MSG_mailbox_is_empty(msg_mailbox_t mailbox)
26 {
27   return (NULL == simcall_rdv_get_head(mailbox));
28 }
29
30 msg_task_t MSG_mailbox_get_head(msg_mailbox_t mailbox)
31 {
32   smx_synchro_t comm = simcall_rdv_get_head(mailbox);
33
34   if (!comm)
35     return NULL;
36
37   return (msg_task_t) simcall_comm_get_src_data(comm);
38 }
39
40 int
41 MSG_mailbox_get_count_host_waiting_tasks(msg_mailbox_t mailbox,
42                                          msg_host_t host)
43 {
44   return simcall_rdv_comm_count_by_host(mailbox, host);
45 }
46
47 msg_mailbox_t MSG_mailbox_get_by_alias(const char *alias)
48 {
49
50   msg_mailbox_t mailbox = simcall_rdv_get_by_name(alias);
51
52   if (!mailbox)
53     mailbox = MSG_mailbox_new(alias);
54
55   return mailbox;
56 }
57
58 /** \ingroup msg_mailbox_management
59  * \brief Set the mailbox to receive in asynchronous mode
60  *
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.
66  *
67  * \param alias The name of the mailbox
68  */
69 void MSG_mailbox_set_async(const char *alias){
70   msg_mailbox_t mailbox = MSG_mailbox_get_by_alias(alias);
71
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());
74
75 }
76
77 /** \ingroup msg_mailbox_management
78  * \brief Get a task from a mailbox on a given host
79  *
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
84
85  * \return Returns
86  * #MSG_OK if the task was successfully received,
87  * #MSG_HOST_FAILURE, or #MSG_TRANSFER_FAILURE otherwise.
88  */
89 msg_error_t
90 MSG_mailbox_get_task_ext(msg_mailbox_t mailbox, msg_task_t *task,
91                          msg_host_t host, double timeout)
92 {
93   return MSG_mailbox_get_task_ext_bounded(mailbox, task, host, timeout, -1.0);
94 }
95
96 /** \ingroup msg_mailbox_management
97  * \brief Get a task from a mailbox on a given host at a given rate
98  *
99  * \param mailbox The mailbox where the task was sent
100  * \param task a memory location for storing a #msg_task_t.
101  * \param host a #msg_host_t host from where the task was sent
102  * \param timeout a timeout
103  * \param rate a rate
104
105  * \return Returns
106  * #MSG_OK if the task was successfully received,
107  * #MSG_HOST_FAILURE, or #MSG_TRANSFER_FAILURE otherwise.
108  */
109 msg_error_t
110 MSG_mailbox_get_task_ext_bounded(msg_mailbox_t mailbox, msg_task_t * task,
111                                  msg_host_t host, double timeout, double rate)
112 {
113   xbt_ex_t e;
114   msg_error_t ret = MSG_OK;
115   /* We no longer support getting a task from a specific host */
116   if (host)
117     THROW_UNIMPLEMENTED;
118
119   TRACE_msg_task_get_start();
120   double start_time = MSG_get_clock();
121
122   /* Sanity check */
123   xbt_assert(task, "Null pointer for the task storage");
124
125   if (*task)
126     XBT_WARN
127         ("Asked to write the received task in a non empty struct -- proceeding.");
128
129   /* Try to receive it by calling SIMIX network layer */
130   TRY {
131     simcall_comm_recv(mailbox, task, NULL, NULL, NULL, NULL, timeout, rate);
132     XBT_DEBUG("Got task %s from %p",(*task)->name,mailbox);
133     if (msg_global->debug_multiple_use && (*task)->simdata->isused!=0)
134       xbt_ex_free(*(xbt_ex_t*)(*task)->simdata->isused);
135     (*task)->simdata->isused = 0;
136   }
137   CATCH(e) {
138     switch (e.category) {
139     case cancel_error:
140       ret = MSG_HOST_FAILURE;
141       break;
142     case network_error:
143       ret = MSG_TRANSFER_FAILURE;
144       break;
145     case timeout_error:
146       ret = MSG_TIMEOUT;
147       break;
148     case host_error:
149       ret = MSG_HOST_FAILURE;
150     default:
151       RETHROW;
152     }
153     xbt_ex_free(e);
154   }
155
156   if (ret != MSG_HOST_FAILURE &&
157       ret != MSG_TRANSFER_FAILURE &&
158       ret != MSG_TIMEOUT) {
159     TRACE_msg_task_get_end(start_time, *task);
160   }
161   MSG_RETURN(ret);
162 }
163
164 msg_error_t
165 MSG_mailbox_put_with_timeout(msg_mailbox_t mailbox, msg_task_t task,
166                              double timeout)
167 {
168   msg_error_t ret = MSG_OK;
169   simdata_task_t t_simdata = NULL;
170   msg_process_t process = MSG_process_self();
171   simdata_process_t p_simdata = SIMIX_process_self_get_data(process);
172
173   int call_end = TRACE_msg_task_put_start(task);    //must be after CHECK_HOST()
174
175   /* Prepare the task to send */
176   t_simdata = task->simdata;
177   t_simdata->sender = process;
178   t_simdata->source = ((simdata_process_t) SIMIX_process_self_get_data(process))->m_host;
179
180   if (t_simdata->isused != 0) {
181     if (msg_global->debug_multiple_use){
182       XBT_ERROR("This task is already used in there:");
183       xbt_backtrace_display(t_simdata->isused);
184       XBT_ERROR("And you try to reuse it from here:");
185       xbt_backtrace_display_current();
186     } else {
187       xbt_assert(t_simdata->isused == 0,
188                  "This task is still being used somewhere else. You cannot send it now. Go fix your code! (use --cfg=msg/debug_multiple_use:on to get the backtrace of the other process)");
189     }
190   }
191
192   if (msg_global->debug_multiple_use)
193     MSG_BT(t_simdata->isused, "Using Backtrace");
194   else
195     t_simdata->isused = (void*)1;
196   t_simdata->comm = NULL;
197   msg_global->sent_msg++;
198
199
200   p_simdata->waiting_task = task;
201
202   xbt_ex_t e;
203   /* Try to send it by calling SIMIX network layer */
204   TRY {
205     smx_synchro_t comm = NULL; /* MC needs the comm to be set to NULL during the simix call  */
206     comm = simcall_comm_isend(SIMIX_process_self(), mailbox,t_simdata->bytes_amount,
207                                   t_simdata->rate, task, sizeof(void *),
208                                   NULL, NULL, NULL, task, 0);
209     if (TRACE_is_enabled())
210       simcall_set_category(comm, task->category);
211      t_simdata->comm = comm;
212      simcall_comm_wait(comm, timeout);
213   }
214
215   CATCH(e) {
216     switch (e.category) {
217     case cancel_error:
218       ret = MSG_HOST_FAILURE;
219       break;
220     case network_error:
221       ret = MSG_TRANSFER_FAILURE;
222       break;
223     case timeout_error:
224       ret = MSG_TIMEOUT;
225       break;
226     default:
227       RETHROW;
228     }
229     xbt_ex_free(e);
230
231     /* If the send failed, it is not used anymore */
232     if (msg_global->debug_multiple_use && t_simdata->isused!=0)
233       xbt_ex_free(*(xbt_ex_t*)t_simdata->isused);
234     t_simdata->isused = 0;
235   }
236
237
238   p_simdata->waiting_task = NULL;
239   if (call_end)
240     TRACE_msg_task_put_end();
241   MSG_RETURN(ret);
242 }
243
244 #ifdef MSG_USE_DEPRECATED
245 msg_mailbox_t MSG_mailbox_get_by_channel(msg_host_t host,
246                                          m_channel_t channel)
247 {
248   XBT_WARN("DEPRECATED! Now use MSG_mailbox_get_by_alias");
249   xbt_assert((host != NULL), "Invalid host");
250   xbt_assert((channel >= 0)
251               && (channel < msg_global->max_channel), "Invalid channel %d",
252               channel);
253
254   return MSG_host_priv(host)->mailboxes[(size_t) channel];
255 }
256 #endif