1 /* gras message types and callback registering and retrieving */
3 /* Copyright (c) 2007, 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. */
10 #include "gras/Msg/msg_private.h"
11 #include "gras/Virtu/virtu_interface.h"
12 #include "gras/DataDesc/datadesc_interface.h"
14 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(gras_msg, gras, "High level messaging");
16 xbt_set_t _gras_msgtype_set = NULL;
19 /* ******************************************************************** */
21 /* ******************************************************************** */
25 void gras_msgtype_free(void *t)
27 gras_msgtype_t msgtype = (gras_msgtype_t) t;
35 * Dump all declared message types (debugging purpose)
37 void gras_msgtype_dumpall(void)
39 xbt_set_cursor_t cursor;
40 gras_msgtype_t msgtype = NULL;
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 ? " -> " : ""),
50 e_gras_msg_kind_rpccall ?
51 gras_datadesc_get_name(msgtype->answer_type) : ""));
59 * Returns the versionned name of the message.
60 * It's a newly allocated string, make sure to free it.
62 static char *make_namev(const char *name, short int ver)
65 return xbt_strdup(name);
67 return bprintf("%s_v%d", name, ver);
70 /* Internal function doing the crude work of registering messages */
72 gras_msgtype_declare_ext(const char *name,
74 e_gras_msg_kind_t kind,
75 gras_datadesc_type_t payload_request,
76 gras_datadesc_type_t payload_answer)
79 gras_msgtype_t msgtype = NULL;
80 char *namev = make_namev(name, version);
81 volatile int found = 0;
85 msgtype = (gras_msgtype_t) xbt_set_get_by_name(_gras_msgtype_set, namev);
88 if (e.category != not_found_error) {
97 ("Re-register version %d of message '%s' (same kind & payload, ignored).",
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));
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));
114 return; /* do really ignore it */
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));
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;
130 xbt_set_add(_gras_msgtype_set, (xbt_set_elm_t) msgtype, &gras_msgtype_free);
134 /** @brief declare a new message type of the given name. It only accepts the given datadesc as payload
136 * @param name: name as it should be used for logging messages (must be uniq)
137 * @param payload: datadescription of the payload
139 void gras_msgtype_declare(const char *name, gras_datadesc_type_t payload)
141 gras_msgtype_declare_ext(name, 0, e_gras_msg_kind_oneway, payload, NULL);
146 /** @brief declare a new versionned message type of the given name and payload
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
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.
159 gras_msgtype_declare_v(const char *name,
160 short int version, gras_datadesc_type_t payload)
163 gras_msgtype_declare_ext(name, version,
164 e_gras_msg_kind_oneway, payload, NULL);
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)
170 return gras_msgtype_by_namev(name, 0);
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)
177 gras_msgtype_t res = NULL;
180 res = gras_msgtype_by_namev(name, 0);
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)
191 gras_msgtype_t res = NULL;
192 char *namev = make_namev(name, version);
193 volatile int found = 0;
197 res = (gras_msgtype_t) xbt_set_get_by_name(_gras_msgtype_set, namev);
203 THROW1(not_found_error, 0, "No registred message of that name: %s", name);
210 /** @brief retrieve an existing message type from its name and version. */
211 gras_msgtype_t gras_msgtype_by_id(int id)
213 return (gras_msgtype_t) xbt_set_get_by_id(_gras_msgtype_set, id);
216 /* ******************************************************************** */
218 /* ******************************************************************** */
220 XBT_INLINE const char* gras_msgtype_get_name(gras_msgtype_t type) {
225 /* ******************************************************************** */
227 /* ******************************************************************** */
228 void gras_cbl_free(void *data)
230 gras_cblist_t *list = *(void **) data;
232 xbt_dynar_free(&(list->cbs));
237 /** \brief Bind the given callback to the given message type
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.
244 void gras_cb_register_(gras_msgtype_t msgtype, gras_msg_cb_t cb)
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;
251 DEBUG2("Register %p as callback to '%s'", cb, msgtype->name);
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) {
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);
269 /* Insert the new one into the set */
270 xbt_dynar_insert_at(list->cbs, 0, &cb);
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)
277 gras_msg_procdata_t pd =
278 (gras_msg_procdata_t) gras_libdata_by_id(gras_msg_libdata_id);
280 gras_msg_cb_t cb_cpt;
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) {
293 /* Remove it from the set */
295 xbt_dynar_foreach(list->cbs, cpt, cb_cpt) {
297 xbt_dynar_cursor_rm(list->cbs, &cpt);
303 VERB1("Ignoring removal of unexisting callback to msg id %d",
307 /** \brief Retrieve the expeditor of the message */
308 gras_socket_t gras_msg_cb_ctx_from(gras_msg_cb_ctx_t ctx)
310 return ctx->expeditor;
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)
319 gras_msg_cb_ctx_t res = xbt_new(s_gras_msg_cb_ctx_t, 1);
320 res->expeditor = expe;
321 res->msgtype = msgtype;
323 res->timeout = timeout;
324 res->answer_due = answer_due;
329 /* \brief Frees a message exchange context
331 * This function is mainly useful with \ref gras_msg_wait_or, ie seldom.
333 void gras_msg_cb_ctx_free(gras_msg_cb_ctx_t ctx)