Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
Improved and tested docummentation.
[simgrid.git] / src / msg / msg_mailbox.c
1 #include "mailbox.h"
2 #include "msg/private.h"
3
4 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(msg_mailbox, msg,
5                                 "Logging specific to MSG (mailbox)");
6
7 static xbt_dict_t msg_mailboxes = NULL;
8
9 void MSG_mailbox_mod_init(void)
10 {
11   msg_mailboxes = xbt_dict_new();
12 }
13
14 void MSG_mailbox_mod_exit(void)
15 {
16   xbt_dict_free(&msg_mailboxes);
17 }
18
19 msg_mailbox_t MSG_mailbox_create(const char *alias)
20 {
21   msg_mailbox_t mailbox = xbt_new0(s_msg_mailbox_t, 1);
22
23   mailbox->cond = NULL;
24   mailbox->alias = alias ? xbt_strdup(alias) : NULL;
25   mailbox->rdv = SIMIX_rdv_create(alias);
26   
27   return mailbox;
28 }
29
30 msg_mailbox_t MSG_mailbox_new(const char *alias)
31 {
32   msg_mailbox_t mailbox = MSG_mailbox_create(alias);
33
34   /* add the mbox in the dictionary */
35   xbt_dict_set(msg_mailboxes, alias, mailbox, MSG_mailbox_free);
36
37   return mailbox;
38 }
39
40 void MSG_mailbox_free(void *mailbox)
41 {
42   msg_mailbox_t _mailbox = (msg_mailbox_t) mailbox;
43
44   free(_mailbox->alias);
45   SIMIX_rdv_destroy(_mailbox->rdv);
46   
47   free(_mailbox);
48 }
49
50 smx_cond_t MSG_mailbox_get_cond(msg_mailbox_t mailbox)
51 {
52   return mailbox->cond;
53 }
54
55 int MSG_mailbox_is_empty(msg_mailbox_t mailbox)
56 {
57   return (NULL == SIMIX_rdv_get_head(mailbox->rdv));
58 }
59
60 m_task_t MSG_mailbox_get_head(msg_mailbox_t mailbox)
61 {
62   smx_comm_t comm = SIMIX_rdv_get_head(mailbox->rdv);
63
64   if(!comm)
65     return NULL; 
66   
67   return (m_task_t)SIMIX_communication_get_data(comm);
68 }
69
70 int
71 MSG_mailbox_get_count_host_waiting_tasks(msg_mailbox_t mailbox, m_host_t host)
72 {
73   return SIMIX_rdv_get_count_waiting_comm (mailbox->rdv, host->simdata->smx_host);
74 }
75
76 void MSG_mailbox_set_cond(msg_mailbox_t mailbox, smx_cond_t cond)
77 {
78   mailbox->cond = cond;
79 }
80
81 const char *MSG_mailbox_get_alias(msg_mailbox_t mailbox)
82 {
83   return mailbox->alias;
84 }
85
86 msg_mailbox_t MSG_mailbox_get_by_alias(const char *alias)
87 {
88
89   msg_mailbox_t mailbox = xbt_dict_get_or_null(msg_mailboxes, alias);
90
91   if (!mailbox)
92     mailbox = MSG_mailbox_new(alias);
93
94   return mailbox;
95 }
96
97 msg_mailbox_t MSG_mailbox_get_by_channel(m_host_t host, m_channel_t channel)
98 {
99   xbt_assert0((host != NULL), "Invalid host");
100   xbt_assert1((channel >= 0)
101               && (channel < msg_global->max_channel), "Invalid channel %d",
102               channel);
103
104   return host->simdata->mailboxes[(size_t) channel];
105 }
106
107 MSG_error_t
108 MSG_mailbox_get_task_ext(msg_mailbox_t mailbox, m_task_t *task, m_host_t host,
109                          double timeout)
110 {
111   xbt_ex_t e;
112   MSG_error_t ret = MSG_OK;
113   smx_comm_t comm;
114   CHECK_HOST();
115
116   /* Kept for compatibility with older implementation */
117   xbt_assert1(!MSG_mailbox_get_cond(mailbox),
118               "A process is already blocked on this channel %s", 
119               MSG_mailbox_get_alias(mailbox));
120
121   /* Sanity check */
122   xbt_assert0(task, "Null pointer for the task storage");
123
124   if (*task)
125     CRITICAL0
126       ("MSG_task_get() was asked to write in a non empty task struct.");
127
128   /* We no loger support getting a task from a specific host */
129   if(host)
130     THROW_UNIMPLEMENTED;
131
132   /* Try to receive it by calling SIMIX network layer */
133   TRY{
134     SIMIX_network_recv(mailbox->rdv, timeout, NULL, NULL, &comm);
135   }
136   CATCH(e){
137     switch(e.category){
138       case host_error:
139         ret = MSG_HOST_FAILURE;
140         break;
141       case network_error:
142         ret = MSG_TRANSFER_FAILURE;
143         break;
144       case timeout_error:
145         ret = MSG_TRANSFER_FAILURE;
146         break;      
147       default:
148         xbt_die("Unhandled SIMIX network exception");
149     }
150     xbt_ex_free(e);        
151   }
152
153   *task = SIMIX_communication_get_data(comm);
154   
155   /* If the sender didn't decremented the refcount so far then do it */
156   if (*task && (*task)->simdata->refcount > 1)
157     (*task)->simdata->refcount--;
158   
159   MSG_RETURN(ret);        
160 }
161
162 MSG_error_t
163 MSG_mailbox_put_with_timeout(msg_mailbox_t mailbox, m_task_t task,
164                              double timeout)
165 {
166   xbt_ex_t e;
167   MSG_error_t ret = MSG_OK;
168   simdata_task_t t_simdata = NULL;
169   m_process_t process = MSG_process_self();
170   
171   CHECK_HOST();
172
173   /* Prepare the task to send */
174   t_simdata = task->simdata;
175   t_simdata->sender = process;
176   t_simdata->source = MSG_host_self();
177
178   xbt_assert0(t_simdata->refcount == 1,
179               "This task is still being used somewhere else. You cannot send it now. Go fix your code!");
180
181   t_simdata->refcount++;
182   msg_global->sent_msg++;
183
184   process->simdata->waiting_task = task;
185   
186   /* Try to send it by calling SIMIX network layer */
187   TRY{
188     /* Kept for semantical compatibility with older implementation */
189     if(mailbox->cond)
190       SIMIX_cond_signal(mailbox->cond);
191
192     SIMIX_network_send(mailbox->rdv, t_simdata->message_size, t_simdata->rate,
193                        timeout, NULL, 0, &t_simdata->comm, task);
194   }
195
196   CATCH(e){
197     switch(e.category){
198       case host_error:
199         ret = MSG_HOST_FAILURE;
200         break;
201       case network_error:
202         ret = MSG_TRANSFER_FAILURE;
203         break;
204       case timeout_error:
205         ret = MSG_TRANSFER_FAILURE;
206         break;      
207       default:
208         xbt_die("Unhandled SIMIX network exception");
209     }
210     xbt_ex_free(e);
211   }
212
213   process->simdata->waiting_task = NULL;
214   
215   /* If the receiver end didn't decremented the refcount so far then do it */
216   if (t_simdata->refcount > 1)
217     t_simdata->refcount--;
218   
219   MSG_RETURN(ret);        
220 }