3 /* gras message types and callback registering and retrieving */
5 /* Copyright (c) 2003, 2004, 2005, 2006, 2007 Martin Quinson. */
6 /* All rights reserved. */
8 /* This program is free software; you can redistribute it and/or modify it
9 * under the terms of the license (GNU LGPL) which comes with this package. */
12 #include "gras/Msg/msg_private.h"
13 #include "gras/Virtu/virtu_interface.h"
14 #include "gras/DataDesc/datadesc_interface.h"
16 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(gras_msg,gras,"High level messaging");
18 xbt_set_t _gras_msgtype_set = NULL;
21 /* ******************************************************************** */
23 /* ******************************************************************** */
27 void gras_msgtype_free(void *t) {
28 gras_msgtype_t msgtype=(gras_msgtype_t)t;
35 * Dump all declared message types (debugging purpose)
37 void gras_msgtype_dumpall(void) {
38 xbt_set_cursor_t cursor;
39 gras_msgtype_t msgtype=NULL;
41 INFO0("Dump of all registered messages:");
42 xbt_set_foreach(_gras_msgtype_set, cursor, msgtype) {
43 INFO6(" Message name: %s (v%d) %s; %s%s%s",
44 msgtype->name, msgtype->version, e_gras_msg_kind_names[msgtype->kind],
45 gras_datadesc_get_name(msgtype->ctn_type),
46 (msgtype->kind==e_gras_msg_kind_rpccall ? " -> ":""),
47 (msgtype->kind==e_gras_msg_kind_rpccall ? gras_datadesc_get_name(msgtype->answer_type) : ""));
55 * Returns the versionned name of the message.
56 * It's a newly allocated string, make sure to free it.
58 static char *make_namev(const char *name, short int ver) {
60 return xbt_strdup(name);
62 return bprintf("%s_v%d",name,ver);
65 /* Internal function doing the crude work of registering messages */
67 gras_msgtype_declare_ext(const char *name,
69 e_gras_msg_kind_t kind,
70 gras_datadesc_type_t payload_request,
71 gras_datadesc_type_t payload_answer) {
73 gras_msgtype_t msgtype=NULL;
74 char *namev=make_namev(name,version);
75 volatile int found = 0;
79 msgtype = (gras_msgtype_t)xbt_set_get_by_name(_gras_msgtype_set,namev);
82 if (e.category != not_found_error) {
90 VERB2("Re-register version %d of message '%s' (same kind & payload, ignored).",
92 xbt_assert3(msgtype->kind == kind,
93 "Message %s re-registered as a %s (it was known as a %s)",
94 namev,e_gras_msg_kind_names[kind],e_gras_msg_kind_names[msgtype->kind]);
95 xbt_assert3(!gras_datadesc_type_cmp(msgtype->ctn_type, payload_request),
96 "Message %s re-registred with another payload (%s was %s)",
97 namev,gras_datadesc_get_name(payload_request),
98 gras_datadesc_get_name(msgtype->ctn_type));
100 xbt_assert3(!gras_datadesc_type_cmp(msgtype->answer_type, payload_answer),
101 "Message %s re-registred 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 VERB4("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,
133 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,
154 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) {
162 return gras_msgtype_by_namev(name,0);
164 /** @brief retrieve an existing message type from its name (or NULL if it does not exist). */
165 gras_msgtype_t gras_msgtype_by_name_or_null (const char *name) {
167 gras_msgtype_t res = NULL;
170 res = gras_msgtype_by_namev(name,0);
178 /** @brief retrieve an existing message type from its name and version. */
179 gras_msgtype_t gras_msgtype_by_namev(const char *name,
181 gras_msgtype_t res = NULL;
182 char *namev = make_namev(name,version);
183 volatile int found=0;
187 res = (gras_msgtype_t)xbt_set_get_by_name(_gras_msgtype_set, namev);
193 THROW1(not_found_error,0,"No registred message of that name: %s",name);
199 /** @brief retrieve an existing message type from its name and version. */
200 gras_msgtype_t gras_msgtype_by_id(int id) {
201 return (gras_msgtype_t)xbt_set_get_by_id(_gras_msgtype_set, id);
206 /* ******************************************************************** */
208 /* ******************************************************************** */
210 gras_cbl_free(void *data){
211 gras_cblist_t *list=*(void**)data;
213 xbt_dynar_free(&( list->cbs ));
218 /** \brief Bind the given callback to the given message type
220 * Several callbacks can be attached to a given message type.
221 * The lastly added one will get the message first, and
222 * if it returns a non-null value, the message will be passed to the
223 * second one. And so on until one of the callbacks accepts the message.
226 gras_cb_register_(gras_msgtype_t msgtype,
228 gras_msg_procdata_t pd=
229 (gras_msg_procdata_t)gras_libdata_by_id(gras_msg_libdata_id);
230 gras_cblist_t *list=NULL;
233 DEBUG2("Register %p as callback to '%s'",cb,msgtype->name);
235 /* search the list of cb for this message on this host (creating if NULL) */
236 xbt_dynar_foreach(pd->cbl_list,cpt,list) {
237 if (list->id == msgtype->code) {
244 /* First cb? Create room */
245 list = xbt_new(gras_cblist_t,1);
246 list->id = msgtype->code;
247 list->cbs = xbt_dynar_new(sizeof(gras_msg_cb_t), NULL);
248 xbt_dynar_push(pd->cbl_list,&list);
251 /* Insert the new one into the set */
252 xbt_dynar_insert_at(list->cbs,0,&cb);
255 /** \brief Unbind the given callback from the given message type */
257 gras_cb_unregister_(gras_msgtype_t msgtype,
260 gras_msg_procdata_t pd=
261 (gras_msg_procdata_t)gras_libdata_by_id(gras_msg_libdata_id);
263 gras_msg_cb_t cb_cpt;
267 /* search the list of cb for this message on this host */
268 xbt_dynar_foreach(pd->cbl_list,cpt,list) {
269 if (list->id == msgtype->code) {
276 /* Remove it from the set */
278 xbt_dynar_foreach(list->cbs,cpt,cb_cpt) {
280 xbt_dynar_cursor_rm(list->cbs, &cpt);
286 VERB1("Ignoring removal of unexisting callback to msg id %d",
290 /** \brief Retrieve the expeditor of the message */
291 gras_socket_t gras_msg_cb_ctx_from(gras_msg_cb_ctx_t ctx) {
292 return ctx->expeditor;
294 /* \brief Creates a new message exchange context (user should never have to) */
295 gras_msg_cb_ctx_t gras_msg_cb_ctx_new(gras_socket_t expe,
296 gras_msgtype_t msgtype,
297 unsigned long int ID,
300 gras_msg_cb_ctx_t res=xbt_new(s_gras_msg_cb_ctx_t,1);
301 res->expeditor = expe;
302 res->msgtype = msgtype;
304 res->timeout = timeout;
305 res->answer_due = answer_due;
309 /* \brief Frees a message exchange context
311 * This function is mainly useful with \ref gras_msg_wait_or, ie seldom.
313 void gras_msg_cb_ctx_free(gras_msg_cb_ctx_t ctx) {