Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
Bounded receive
[simgrid.git] / src / msg / msg_mailbox.c
1 /* Mailboxes in MSG */
2
3 /* Copyright (c) 2008, 2009, 2010. 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_action_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 double MSG_set_rate_before_read(msg_mailbox_t mailbox, double newrate) {
48         return simcall_comm_change_rate_first_action(mailbox,newrate);
49 }
50
51 msg_mailbox_t MSG_mailbox_get_by_alias(const char *alias)
52 {
53
54   msg_mailbox_t mailbox = simcall_rdv_get_by_name(alias);
55
56   if (!mailbox)
57     mailbox = MSG_mailbox_new(alias);
58
59   return mailbox;
60 }
61
62 /** \ingroup msg_mailbox_management
63  * \brief Set the mailbox to receive in asynchronous mode
64  *
65  * All messages sent to this mailbox will be transferred to 
66  * the receiver without waiting for the receive call. 
67  * The receive call will still be necessary to use the received data.
68  * If there is a need to receive some messages asynchronously, and some not, 
69  * two different mailboxes should be used.
70  *
71  * \param alias The name of the mailbox 
72  */
73 void MSG_mailbox_set_async(const char *alias){
74   msg_mailbox_t mailbox = MSG_mailbox_get_by_alias(alias);
75
76   simcall_rdv_set_receiver(mailbox, SIMIX_process_self());
77   XBT_VERB("%s mailbox set to receive eagerly for process %p\n",alias, SIMIX_process_self());
78
79 }
80
81 /** \ingroup msg_mailbox_management
82  * \brief Get a task from a mailbox on a given host
83  *
84  * \param mailbox The mailbox where the task was sent
85  * \param task a memory location for storing a #msg_task_t.
86  * \param host a #msg_host_t host from where the task was sent
87  * \param timeout a timeout
88
89  * \return Returns
90  * #MSG_OK if the task was successfully received,
91  * #MSG_HOST_FAILURE, or #MSG_TRANSFER_FAILURE otherwise.
92  */
93 msg_error_t
94 MSG_mailbox_get_task_ext(msg_mailbox_t mailbox, msg_task_t * task,
95                          msg_host_t host, double timeout)
96 {
97   xbt_ex_t e;
98   msg_error_t ret = MSG_OK;
99   /* We no longer support getting a task from a specific host */
100   if (host)
101     THROW_UNIMPLEMENTED;
102
103 #ifdef HAVE_TRACING
104   TRACE_msg_task_get_start();
105   double start_time = MSG_get_clock();
106 #endif
107
108   /* Sanity check */
109   xbt_assert(task, "Null pointer for the task storage");
110
111   if (*task)
112     XBT_WARN
113         ("Asked to write the received task in a non empty struct -- proceeding.");
114
115   /* Try to receive it by calling SIMIX network layer */
116   TRY {
117     simcall_comm_recv(mailbox, task, NULL, NULL, NULL, timeout);
118     XBT_DEBUG("Got task %s from %p",(*task)->name,mailbox);
119     (*task)->simdata->isused=0;
120   }
121   CATCH(e) {
122     switch (e.category) {
123     case network_error:
124       ret = MSG_TRANSFER_FAILURE;
125       break;
126     case timeout_error:
127       ret = MSG_TIMEOUT;
128       break;
129     default:
130       RETHROW;
131     }
132     xbt_ex_free(e);
133   }
134
135 #ifdef HAVE_TRACING
136   if (ret != MSG_HOST_FAILURE &&
137       ret != MSG_TRANSFER_FAILURE &&
138       ret != MSG_TIMEOUT) {
139     TRACE_msg_task_get_end(start_time, *task);
140   }
141 #endif
142   MSG_RETURN(ret);
143 }
144
145
146
147 /** \ingroup msg_mailbox_management
148  * \brief Get a task from a mailbox on a given host at a given rate
149  *
150  * \param mailbox The mailbox where the task was sent
151  * \param task a memory location for storing a #msg_task_t.
152  * \param host a #msg_host_t host from where the task was sent
153  * \param timeout a timeout
154  * \param rate a bandwidth rate
155
156  * \return Returns
157  * #MSG_OK if the task was successfully received,
158  * #MSG_HOST_FAILURE, or #MSG_TRANSFER_FAILURE otherwise.
159  */
160 msg_error_t
161 MSG_mailbox_get_task_ext_bounded(msg_mailbox_t mailbox, msg_task_t * task,
162                          msg_host_t host, double timeout, double rate)
163 {
164         MSG_set_rate_before_read(mailbox,rate);
165         MSG_RETURN(MSG_mailbox_get_task_ext(mailbox,task,host,timeout));
166 }
167
168
169 msg_error_t
170 MSG_mailbox_put_with_timeout(msg_mailbox_t mailbox, msg_task_t task,
171                              double timeout)
172 {
173   xbt_ex_t e;
174   msg_error_t ret = MSG_OK;
175   simdata_task_t t_simdata = NULL;
176   msg_process_t process = MSG_process_self();
177   simdata_process_t p_simdata = SIMIX_process_self_get_data(process);
178
179 #ifdef HAVE_TRACING
180   int call_end = TRACE_msg_task_put_start(task);    //must be after CHECK_HOST()
181 #endif
182
183   /* Prepare the task to send */
184   t_simdata = task->simdata;
185   t_simdata->sender = process;
186   t_simdata->source = ((simdata_process_t) SIMIX_process_self_get_data(process))->m_host;
187
188   xbt_assert(t_simdata->isused == 0,
189               "This task is still being used somewhere else. You cannot send it now. Go fix your code!");
190
191   t_simdata->isused=1;
192   t_simdata->comm = NULL;
193   msg_global->sent_msg++;
194
195
196   p_simdata->waiting_task = task;
197
198   /* Try to send it by calling SIMIX network layer */
199   TRY {
200       smx_action_t comm = simcall_comm_isend(mailbox, t_simdata->message_size,
201                                   t_simdata->rate, task, sizeof(void *),
202                                   NULL, NULL, task, 0);
203 #ifdef HAVE_TRACING
204     if (TRACE_is_enabled()) {
205       simcall_set_category(comm, task->category);
206     }
207 #endif
208      t_simdata->comm = comm;
209      simcall_comm_wait(comm, timeout);
210   }
211
212   CATCH(e) {
213     switch (e.category) {
214     case network_error:
215       ret = MSG_TRANSFER_FAILURE;
216       break;
217     case timeout_error:
218       ret = MSG_TIMEOUT;
219       break;
220     default:
221       RETHROW;
222     }
223     xbt_ex_free(e);
224
225     /* If the send failed, it is not used anymore */
226     t_simdata->isused = 0;
227   }
228
229
230   p_simdata->waiting_task = NULL;
231 #ifdef HAVE_TRACING
232   if (call_end)
233     TRACE_msg_task_put_end();
234 #endif
235   MSG_RETURN(ret);
236 }
237
238 #ifdef MSG_USE_DEPRECATED
239 msg_mailbox_t MSG_mailbox_get_by_channel(msg_host_t host,
240                                          m_channel_t channel)
241 {
242   XBT_WARN("DEPRECATED! Now use MSG_mailbox_get_by_alias");
243   xbt_assert((host != NULL), "Invalid host");
244   xbt_assert((channel >= 0)
245               && (channel < msg_global->max_channel), "Invalid channel %d",
246               channel);
247
248   return host->mailboxes[(size_t) channel];
249 }
250 #endif