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 XBT_INFO("Dump of all registered messages:");
43 xbt_set_foreach(_gras_msgtype_set, cursor, msgtype) {
44 XBT_INFO(" 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);
82 msgtype = (gras_msgtype_t) xbt_set_get_by_name_or_null(
83 _gras_msgtype_set, (const char*) namev);
85 if (msgtype != NULL) {
87 ("Re-register version %d of message '%s' (same kind & payload, ignored).",
89 xbt_assert(msgtype->kind == kind,
90 "Message %s re-registered as a %s (it was known as a %s)",
91 namev, e_gras_msg_kind_names[kind],
92 e_gras_msg_kind_names[msgtype->kind]);
93 xbt_assert(!gras_datadesc_type_cmp
94 (msgtype->ctn_type, payload_request),
95 "Message %s re-registered with another payload (%s was %s)",
96 namev, gras_datadesc_get_name(payload_request),
97 gras_datadesc_get_name(msgtype->ctn_type));
99 xbt_assert(!gras_datadesc_type_cmp
100 (msgtype->answer_type, payload_answer),
101 "Message %s re-registered with another answer payload (%s was %s)",
102 namev, gras_datadesc_get_name(payload_answer),
103 gras_datadesc_get_name(msgtype->answer_type));
106 return; /* do really ignore it */
109 XBT_VERB("Register version %d of message '%s' "
110 "(payload: %s; answer payload: %s).",
111 version, name, gras_datadesc_get_name(payload_request),
112 gras_datadesc_get_name(payload_answer));
114 msgtype = xbt_new(s_gras_msgtype_t, 1);
115 msgtype->name = namev;
116 msgtype->name_len = strlen(namev);
117 msgtype->version = version;
118 msgtype->kind = kind;
119 msgtype->ctn_type = payload_request;
120 msgtype->answer_type = payload_answer;
122 xbt_set_add(_gras_msgtype_set, (xbt_set_elm_t) msgtype,
127 /** @brief declare a new message type of the given name. It only accepts the given datadesc as payload
129 * @param name: name as it should be used for logging messages (must be uniq)
130 * @param payload: datadescription of the payload
132 void gras_msgtype_declare(const char *name, gras_datadesc_type_t payload)
134 gras_msgtype_declare_ext(name, 0, e_gras_msg_kind_oneway, payload, NULL);
139 /** @brief declare a new versionned message type of the given name and payload
141 * @param name: name as it should be used for logging messages (must be uniq)
142 * @param version: something like versionning symbol
143 * @param payload: datadescription of the payload
145 * Registers a message to the GRAS mechanism. Use this version instead of
146 * gras_msgtype_declare when you change the semantic or syntax of a message and
147 * want your programs to be able to deal with both versions. Internally, each
148 * will be handled as an independent message type, so you can register
149 * differents for each of them.
152 gras_msgtype_declare_v(const char *name,
153 short int version, gras_datadesc_type_t payload)
156 gras_msgtype_declare_ext(name, version,
157 e_gras_msg_kind_oneway, payload, NULL);
160 /** @brief retrieve an existing message type from its name (raises an exception if it does not exist). */
161 gras_msgtype_t gras_msgtype_by_name(const char *name)
163 return gras_msgtype_by_namev(name, 0);
166 /** @brief retrieve an existing message type from its name (or NULL if it does not exist). */
167 gras_msgtype_t gras_msgtype_by_name_or_null(const char *name)
170 gras_msgtype_t res = NULL;
173 res = gras_msgtype_by_namev(name, 0);
182 /** @brief retrieve an existing message type from its name and version. */
183 gras_msgtype_t gras_msgtype_by_namev(const char *name, short int version)
185 gras_msgtype_t res = NULL;
186 char *namev = make_namev(name, version);
188 res = (gras_msgtype_t) xbt_set_get_by_name_or_null(_gras_msgtype_set, namev);
192 THROWF(not_found_error, 0, "No registered message of that name: %s",
198 /** @brief retrieve an existing message type from its name and version. */
199 gras_msgtype_t gras_msgtype_by_id(int id)
201 return (gras_msgtype_t) xbt_set_get_by_id(_gras_msgtype_set, id);
204 /* ******************************************************************** */
206 /* ******************************************************************** */
208 XBT_INLINE const char *gras_msgtype_get_name(gras_msgtype_t type)
214 /* ******************************************************************** */
216 /* ******************************************************************** */
217 void gras_cbl_free(void *data)
219 gras_cblist_t *list = *(void **) data;
221 xbt_dynar_free(&(list->cbs));
226 /** \brief Bind the given callback to the given message type
228 * Several callbacks can be attached to a given message type.
229 * The lastly added one will get the message first, and
230 * if it returns a non-null value, the message will be passed to the
231 * second one. And so on until one of the callbacks accepts the message.
233 void gras_cb_register_(gras_msgtype_t msgtype, gras_msg_cb_t cb)
235 gras_msg_procdata_t pd =
236 (gras_msg_procdata_t) gras_libdata_by_id(gras_msg_libdata_id);
237 gras_cblist_t *list = NULL;
240 XBT_DEBUG("Register %p as callback to '%s'", cb, msgtype->name);
242 /* search the list of cb for this message on this host (creating if NULL) */
243 xbt_dynar_foreach(pd->cbl_list, cpt, list) {
244 if (list->id == msgtype->code) {
251 /* First cb? Create room */
252 list = xbt_new(gras_cblist_t, 1);
253 list->id = msgtype->code;
254 list->cbs = xbt_dynar_new(sizeof(gras_msg_cb_t), NULL);
255 xbt_dynar_push(pd->cbl_list, &list);
258 /* Insert the new one into the set */
259 xbt_dynar_insert_at(list->cbs, 0, &cb);
262 /** \brief Unbind the given callback from the given message type */
263 void gras_cb_unregister_(gras_msgtype_t msgtype, gras_msg_cb_t cb)
266 gras_msg_procdata_t pd =
267 (gras_msg_procdata_t) gras_libdata_by_id(gras_msg_libdata_id);
269 gras_msg_cb_t cb_cpt;
273 /* search the list of cb for this message on this host */
274 xbt_dynar_foreach(pd->cbl_list, cpt, list) {
275 if (list->id == msgtype->code) {
282 /* Remove it from the set */
284 xbt_dynar_foreach(list->cbs, cpt, cb_cpt) {
286 xbt_dynar_cursor_rm(list->cbs, &cpt);
292 XBT_VERB("Ignoring removal of unexisting callback to msg id %d",
296 /** \brief Retrieve the expeditor of the message */
297 gras_socket_t gras_msg_cb_ctx_from(gras_msg_cb_ctx_t ctx)
299 return ctx->expeditor;
302 /* \brief Creates a new message exchange context (user should never have to) */
303 gras_msg_cb_ctx_t gras_msg_cb_ctx_new(gras_socket_t expe,
304 gras_msgtype_t msgtype,
305 unsigned long int ID,
306 int answer_due, double timeout)
308 gras_msg_cb_ctx_t res = xbt_new(s_gras_msg_cb_ctx_t, 1);
309 res->expeditor = expe;
310 res->msgtype = msgtype;
312 res->timeout = timeout;
313 res->answer_due = answer_due;
318 /* \brief Frees a message exchange context
320 * This function is mainly useful with \ref gras_msg_wait_or, ie seldom.
322 void gras_msg_cb_ctx_free(gras_msg_cb_ctx_t ctx)