Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
New function gras_msgtype_get_name()
[simgrid.git] / src / gras / Msg / gras_msg_types.c
1 /* gras message types and callback registering and retrieving               */
2
3 /* Copyright (c) 2007, 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 "xbt/ex.h"
10 #include "gras/Msg/msg_private.h"
11 #include "gras/Virtu/virtu_interface.h"
12 #include "gras/DataDesc/datadesc_interface.h"
13
14 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(gras_msg, gras, "High level messaging");
15
16 xbt_set_t _gras_msgtype_set = NULL;
17
18
19 /* ******************************************************************** */
20 /*                      MESSAGE TYPES                                   */
21 /* ******************************************************************** */
22
23
24 /* Reclamed memory */
25 void gras_msgtype_free(void *t)
26 {
27   gras_msgtype_t msgtype = (gras_msgtype_t) t;
28   if (msgtype) {
29     free(msgtype->name);
30     free(msgtype);
31   }
32 }
33
34 /**
35  * Dump all declared message types (debugging purpose)
36  */
37 void gras_msgtype_dumpall(void)
38 {
39   xbt_set_cursor_t cursor;
40   gras_msgtype_t msgtype = NULL;
41
42   INFO0("Dump of all registered messages:");
43   xbt_set_foreach(_gras_msgtype_set, cursor, msgtype) {
44     INFO6("  Message name: %s (v%d) %s; %s%s%s",
45           msgtype->name, msgtype->version,
46           e_gras_msg_kind_names[msgtype->kind],
47           gras_datadesc_get_name(msgtype->ctn_type),
48           (msgtype->kind == e_gras_msg_kind_rpccall ? " -> " : ""),
49           (msgtype->kind ==
50            e_gras_msg_kind_rpccall ?
51            gras_datadesc_get_name(msgtype->answer_type) : ""));
52   }
53 }
54
55
56 /**
57  * make_namev:
58  *
59  * Returns the versionned name of the message.
60  *   It's a newly allocated string, make sure to free it.
61  */
62 static char *make_namev(const char *name, short int ver)
63 {
64   if (!ver)
65     return xbt_strdup(name);
66
67   return bprintf("%s_v%d", name, ver);
68 }
69
70 /* Internal function doing the crude work of registering messages */
71 void
72 gras_msgtype_declare_ext(const char *name,
73                          short int version,
74                          e_gras_msg_kind_t kind,
75                          gras_datadesc_type_t payload_request,
76                          gras_datadesc_type_t payload_answer)
77 {
78
79   gras_msgtype_t msgtype = NULL;
80   char *namev = make_namev(name, version);
81   volatile int found = 0;
82   xbt_ex_t e;
83
84   TRY {
85     msgtype = (gras_msgtype_t) xbt_set_get_by_name(_gras_msgtype_set, namev);
86     found = 1;
87   } CATCH(e) {
88     if (e.category != not_found_error) {
89       xbt_free(namev);
90       RETHROW;
91     }
92     xbt_ex_free(e);
93   }
94
95   if (found) {
96     VERB2
97       ("Re-register version %d of message '%s' (same kind & payload, ignored).",
98        version, name);
99     xbt_assert3(msgtype->kind == kind,
100                 "Message %s re-registered as a %s (it was known as a %s)",
101                 namev, e_gras_msg_kind_names[kind],
102                 e_gras_msg_kind_names[msgtype->kind]);
103     xbt_assert3(!gras_datadesc_type_cmp(msgtype->ctn_type, payload_request),
104                 "Message %s re-registred with another payload (%s was %s)",
105                 namev, gras_datadesc_get_name(payload_request),
106                 gras_datadesc_get_name(msgtype->ctn_type));
107
108     xbt_assert3(!gras_datadesc_type_cmp(msgtype->answer_type, payload_answer),
109                 "Message %s re-registred with another answer payload (%s was %s)",
110                 namev, gras_datadesc_get_name(payload_answer),
111                 gras_datadesc_get_name(msgtype->answer_type));
112
113     xbt_free(namev);
114     return;                     /* do really ignore it */
115   }
116
117   VERB4("Register version %d of message '%s' "
118         "(payload: %s; answer payload: %s).",
119         version, name, gras_datadesc_get_name(payload_request),
120         gras_datadesc_get_name(payload_answer));
121
122   msgtype = xbt_new(s_gras_msgtype_t, 1);
123   msgtype->name = namev;
124   msgtype->name_len = strlen(namev);
125   msgtype->version = version;
126   msgtype->kind = kind;
127   msgtype->ctn_type = payload_request;
128   msgtype->answer_type = payload_answer;
129
130   xbt_set_add(_gras_msgtype_set, (xbt_set_elm_t) msgtype, &gras_msgtype_free);
131 }
132
133
134 /** @brief declare a new message type of the given name. It only accepts the given datadesc as payload
135  *
136  * @param name: name as it should be used for logging messages (must be uniq)
137  * @param payload: datadescription of the payload
138  */
139 void gras_msgtype_declare(const char *name, gras_datadesc_type_t payload)
140 {
141   gras_msgtype_declare_ext(name, 0, e_gras_msg_kind_oneway, payload, NULL);
142 }
143
144
145
146 /** @brief declare a new versionned message type of the given name and payload
147  *
148  * @param name: name as it should be used for logging messages (must be uniq)
149  * @param version: something like versionning symbol
150  * @param payload: datadescription of the payload
151  *
152  * Registers a message to the GRAS mechanism. Use this version instead of
153  * gras_msgtype_declare when you change the semantic or syntax of a message and
154  * want your programs to be able to deal with both versions. Internally, each
155  * will be handled as an independent message type, so you can register
156  * differents for each of them.
157  */
158 void
159 gras_msgtype_declare_v(const char *name,
160                        short int version, gras_datadesc_type_t payload)
161 {
162
163   gras_msgtype_declare_ext(name, version,
164                            e_gras_msg_kind_oneway, payload, NULL);
165 }
166
167 /** @brief retrieve an existing message type from its name (raises an exception if it does not exist). */
168 gras_msgtype_t gras_msgtype_by_name(const char *name)
169 {
170   return gras_msgtype_by_namev(name, 0);
171 }
172
173 /** @brief retrieve an existing message type from its name (or NULL if it does not exist). */
174 gras_msgtype_t gras_msgtype_by_name_or_null(const char *name)
175 {
176   xbt_ex_t e;
177   gras_msgtype_t res = NULL;
178
179   TRY {
180     res = gras_msgtype_by_namev(name, 0);
181   } CATCH(e) {
182     res = NULL;
183     xbt_ex_free(e);
184   }
185   return res;
186 }
187
188 /** @brief retrieve an existing message type from its name and version. */
189 gras_msgtype_t gras_msgtype_by_namev(const char *name, short int version)
190 {
191   gras_msgtype_t res = NULL;
192   char *namev = make_namev(name, version);
193   volatile int found = 0;
194   xbt_ex_t e;
195
196   TRY {
197     res = (gras_msgtype_t) xbt_set_get_by_name(_gras_msgtype_set, namev);
198     found = 1;
199   } CATCH(e) {
200     xbt_ex_free(e);
201   }
202   if (!found)
203     THROW1(not_found_error, 0, "No registred message of that name: %s", name);
204
205   free(namev);
206
207   return res;
208 }
209
210 /** @brief retrieve an existing message type from its name and version. */
211 gras_msgtype_t gras_msgtype_by_id(int id)
212 {
213   return (gras_msgtype_t) xbt_set_get_by_id(_gras_msgtype_set, id);
214 }
215
216 /* ******************************************************************** */
217 /*                         GETTERS                                      */
218 /* ******************************************************************** */
219
220 XBT_INLINE const char* gras_msgtype_get_name(gras_msgtype_t type) {
221   return type->name;
222 }
223
224
225 /* ******************************************************************** */
226 /*                        CALLBACKS                                     */
227 /* ******************************************************************** */
228 void gras_cbl_free(void *data)
229 {
230   gras_cblist_t *list = *(void **) data;
231   if (list) {
232     xbt_dynar_free(&(list->cbs));
233     free(list);
234   }
235 }
236
237 /** \brief Bind the given callback to the given message type
238  *
239  * Several callbacks can be attached to a given message type.
240  * The lastly added one will get the message first, and
241  * if it returns a non-null value, the message will be passed to the
242  * second one. And so on until one of the callbacks accepts the message.
243  */
244 void gras_cb_register_(gras_msgtype_t msgtype, gras_msg_cb_t cb)
245 {
246   gras_msg_procdata_t pd =
247     (gras_msg_procdata_t) gras_libdata_by_id(gras_msg_libdata_id);
248   gras_cblist_t *list = NULL;
249   unsigned int cpt;
250
251   DEBUG2("Register %p as callback to '%s'", cb, msgtype->name);
252
253   /* search the list of cb for this message on this host (creating if NULL) */
254   xbt_dynar_foreach(pd->cbl_list, cpt, list) {
255     if (list->id == msgtype->code) {
256       break;
257     } else {
258       list = NULL;
259     }
260   }
261   if (!list) {
262     /* First cb? Create room */
263     list = xbt_new(gras_cblist_t, 1);
264     list->id = msgtype->code;
265     list->cbs = xbt_dynar_new(sizeof(gras_msg_cb_t), NULL);
266     xbt_dynar_push(pd->cbl_list, &list);
267   }
268
269   /* Insert the new one into the set */
270   xbt_dynar_insert_at(list->cbs, 0, &cb);
271 }
272
273 /** \brief Unbind the given callback from the given message type */
274 void gras_cb_unregister_(gras_msgtype_t msgtype, gras_msg_cb_t cb)
275 {
276
277   gras_msg_procdata_t pd =
278     (gras_msg_procdata_t) gras_libdata_by_id(gras_msg_libdata_id);
279   gras_cblist_t *list;
280   gras_msg_cb_t cb_cpt;
281   unsigned int cpt;
282   int found = 0;
283
284   /* search the list of cb for this message on this host */
285   xbt_dynar_foreach(pd->cbl_list, cpt, list) {
286     if (list->id == msgtype->code) {
287       break;
288     } else {
289       list = NULL;
290     }
291   }
292
293   /* Remove it from the set */
294   if (list) {
295     xbt_dynar_foreach(list->cbs, cpt, cb_cpt) {
296       if (cb == cb_cpt) {
297         xbt_dynar_cursor_rm(list->cbs, &cpt);
298         found = 1;
299       }
300     }
301   }
302   if (!found)
303     VERB1("Ignoring removal of unexisting callback to msg id %d",
304           msgtype->code);
305 }
306
307 /** \brief Retrieve the expeditor of the message */
308 gras_socket_t gras_msg_cb_ctx_from(gras_msg_cb_ctx_t ctx)
309 {
310   return ctx->expeditor;
311 }
312
313 /* \brief Creates a new message exchange context (user should never have to) */
314 gras_msg_cb_ctx_t gras_msg_cb_ctx_new(gras_socket_t expe,
315                                       gras_msgtype_t msgtype,
316                                       unsigned long int ID,
317                                       int answer_due, double timeout)
318 {
319   gras_msg_cb_ctx_t res = xbt_new(s_gras_msg_cb_ctx_t, 1);
320   res->expeditor = expe;
321   res->msgtype = msgtype;
322   res->ID = ID;
323   res->timeout = timeout;
324   res->answer_due = answer_due;
325
326   return res;
327 }
328
329 /* \brief Frees a message exchange context
330  *
331  * This function is mainly useful with \ref gras_msg_wait_or, ie seldom.
332  */
333 void gras_msg_cb_ctx_free(gras_msg_cb_ctx_t ctx)
334 {
335   free(ctx);
336 }