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 =
  86         (gras_msgtype_t) xbt_set_get_by_name(_gras_msgtype_set, namev);
  87     found = 1;
  88   } CATCH(e) {
  89     if (e.category != not_found_error) {
  90       xbt_free(namev);
  91       RETHROW;
  92     }
  93     xbt_ex_free(e);
  94   }
  95
  96   if (found) {
  97     VERB2
  98         ("Re-register version %d of message '%s' (same kind & payload, ignored).",
  99          version, name);
 100     xbt_assert3(msgtype->kind == kind,
 101                 "Message %s re-registered as a %s (it was known as a %s)",
 102                 namev, e_gras_msg_kind_names[kind],
 103                 e_gras_msg_kind_names[msgtype->kind]);
 104     xbt_assert3(!gras_datadesc_type_cmp
 105                 (msgtype->ctn_type, payload_request),
 106                 "Message %s re-registred with another payload (%s was %s)",
 107                 namev, gras_datadesc_get_name(payload_request),
 108                 gras_datadesc_get_name(msgtype->ctn_type));
 109
 110     xbt_assert3(!gras_datadesc_type_cmp
 111                 (msgtype->answer_type, payload_answer),
 112                 "Message %s re-registred with another answer payload (%s was %s)",
 113                 namev, gras_datadesc_get_name(payload_answer),
 114                 gras_datadesc_get_name(msgtype->answer_type));
 115
 116     xbt_free(namev);
 117     return;                     /* do really ignore it */
 118   }
 119
 120   VERB4("Register version %d of message '%s' "
 121         "(payload: %s; answer payload: %s).",
 122         version, name, gras_datadesc_get_name(payload_request),
 123         gras_datadesc_get_name(payload_answer));
 124
 125   msgtype = xbt_new(s_gras_msgtype_t, 1);
 126   msgtype->name = namev;
 127   msgtype->name_len = strlen(namev);
 128   msgtype->version = version;
 129   msgtype->kind = kind;
 130   msgtype->ctn_type = payload_request;
 131   msgtype->answer_type = payload_answer;
 132
 133   xbt_set_add(_gras_msgtype_set, (xbt_set_elm_t) msgtype,
 134               &gras_msgtype_free);
 135 }
 136
 137
 138 /** @brief declare a new message type of the given name. It only accepts the given datadesc as payload
 139  *
 140  * @param name: name as it should be used for logging messages (must be uniq)
 141  * @param payload: datadescription of the payload
 142  */
 143 void gras_msgtype_declare(const char *name, gras_datadesc_type_t payload)
 144 {
 145   gras_msgtype_declare_ext(name, 0, e_gras_msg_kind_oneway, payload, NULL);
 146 }
 147
 148
 149
 150 /** @brief declare a new versionned message type of the given name and payload
 151  *
 152  * @param name: name as it should be used for logging messages (must be uniq)
 153  * @param version: something like versionning symbol
 154  * @param payload: datadescription of the payload
 155  *
 156  * Registers a message to the GRAS mechanism. Use this version instead of
 157  * gras_msgtype_declare when you change the semantic or syntax of a message and
 158  * want your programs to be able to deal with both versions. Internally, each
 159  * will be handled as an independent message type, so you can register
 160  * differents for each of them.
 161  */
 162 void
 163 gras_msgtype_declare_v(const char *name,
 164                        short int version, gras_datadesc_type_t payload)
 165 {
 166
 167   gras_msgtype_declare_ext(name, version,
 168                            e_gras_msg_kind_oneway, payload, NULL);
 169 }
 170
 171 /** @brief retrieve an existing message type from its name (raises an exception if it does not exist). */
 172 gras_msgtype_t gras_msgtype_by_name(const char *name)
 173 {
 174   return gras_msgtype_by_namev(name, 0);
 175 }
 176
 177 /** @brief retrieve an existing message type from its name (or NULL if it does not exist). */
 178 gras_msgtype_t gras_msgtype_by_name_or_null(const char *name)
 179 {
 180   xbt_ex_t e;
 181   gras_msgtype_t res = NULL;
 182
 183   TRY {
 184     res = gras_msgtype_by_namev(name, 0);
 185   } CATCH(e) {
 186     res = NULL;
 187     xbt_ex_free(e);
 188   }
 189   return res;
 190 }
 191
 192 /** @brief retrieve an existing message type from its name and version. */
 193 gras_msgtype_t gras_msgtype_by_namev(const char *name, short int version)
 194 {
 195   gras_msgtype_t res = NULL;
 196   char *namev = make_namev(name, version);
 197   volatile int found = 0;
 198   xbt_ex_t e;
 199
 200   TRY {
 201     res = (gras_msgtype_t) xbt_set_get_by_name(_gras_msgtype_set, namev);
 202     found = 1;
 203   } CATCH(e) {
 204     xbt_ex_free(e);
 205   }
 206   if (!found)
 207     THROW1(not_found_error, 0, "No registred message of that name: %s",
 208            name);
 209
 210   free(namev);
 211
 212   return res;
 213 }
 214
 215 /** @brief retrieve an existing message type from its name and version. */
 216 gras_msgtype_t gras_msgtype_by_id(int id)
 217 {
 218   return (gras_msgtype_t) xbt_set_get_by_id(_gras_msgtype_set, id);
 219 }
 220
 221 /* ******************************************************************** */
 222 /*                         GETTERS                                      */
 223 /* ******************************************************************** */
 224
 225 XBT_INLINE const char *gras_msgtype_get_name(gras_msgtype_t type)
 226 {
 227   return type->name;
 228 }
 229
 230
 231 /* ******************************************************************** */
 232 /*                        CALLBACKS                                     */
 233 /* ******************************************************************** */
 234 void gras_cbl_free(void *data)
 235 {
 236   gras_cblist_t *list = *(void **) data;
 237   if (list) {
 238     xbt_dynar_free(&(list->cbs));
 239     free(list);
 240   }
 241 }
 242
 243 /** \brief Bind the given callback to the given message type
 244  *
 245  * Several callbacks can be attached to a given message type.
 246  * The lastly added one will get the message first, and
 247  * if it returns a non-null value, the message will be passed to the
 248  * second one. And so on until one of the callbacks accepts the message.
 249  */
 250 void gras_cb_register_(gras_msgtype_t msgtype, gras_msg_cb_t cb)
 251 {
 252   gras_msg_procdata_t pd =
 253       (gras_msg_procdata_t) gras_libdata_by_id(gras_msg_libdata_id);
 254   gras_cblist_t *list = NULL;
 255   unsigned int cpt;
 256
 257   DEBUG2("Register %p as callback to '%s'", cb, msgtype->name);
 258
 259   /* search the list of cb for this message on this host (creating if NULL) */
 260   xbt_dynar_foreach(pd->cbl_list, cpt, list) {
 261     if (list->id == msgtype->code) {
 262       break;
 263     } else {
 264       list = NULL;
 265     }
 266   }
 267   if (!list) {
 268     /* First cb? Create room */
 269     list = xbt_new(gras_cblist_t, 1);
 270     list->id = msgtype->code;
 271     list->cbs = xbt_dynar_new(sizeof(gras_msg_cb_t), NULL);
 272     xbt_dynar_push(pd->cbl_list, &list);
 273   }
 274
 275   /* Insert the new one into the set */
 276   xbt_dynar_insert_at(list->cbs, 0, &cb);
 277 }
 278
 279 /** \brief Unbind the given callback from the given message type */
 280 void gras_cb_unregister_(gras_msgtype_t msgtype, gras_msg_cb_t cb)
 281 {
 282
 283   gras_msg_procdata_t pd =
 284       (gras_msg_procdata_t) gras_libdata_by_id(gras_msg_libdata_id);
 285   gras_cblist_t *list;
 286   gras_msg_cb_t cb_cpt;
 287   unsigned int cpt;
 288   int found = 0;
 289
 290   /* search the list of cb for this message on this host */
 291   xbt_dynar_foreach(pd->cbl_list, cpt, list) {
 292     if (list->id == msgtype->code) {
 293       break;
 294     } else {
 295       list = NULL;
 296     }
 297   }
 298
 299   /* Remove it from the set */
 300   if (list) {
 301     xbt_dynar_foreach(list->cbs, cpt, cb_cpt) {
 302       if (cb == cb_cpt) {
 303         xbt_dynar_cursor_rm(list->cbs, &cpt);
 304         found = 1;
 305       }
 306     }
 307   }
 308   if (!found)
 309     VERB1("Ignoring removal of unexisting callback to msg id %d",
 310           msgtype->code);
 311 }
 312
 313 /** \brief Retrieve the expeditor of the message */
 314 gras_socket_t gras_msg_cb_ctx_from(gras_msg_cb_ctx_t ctx)
 315 {
 316   return ctx->expeditor;
 317 }
 318
 319 /* \brief Creates a new message exchange context (user should never have to) */
 320 gras_msg_cb_ctx_t gras_msg_cb_ctx_new(gras_socket_t expe,
 321                                       gras_msgtype_t msgtype,
 322                                       unsigned long int ID,
 323                                       int answer_due, double timeout)
 324 {
 325   gras_msg_cb_ctx_t res = xbt_new(s_gras_msg_cb_ctx_t, 1);
 326   res->expeditor = expe;
 327   res->msgtype = msgtype;
 328   res->ID = ID;
 329   res->timeout = timeout;
 330   res->answer_due = answer_due;
 331
 332   return res;
 333 }
 334
 335 /* \brief Frees a message exchange context
 336  *
 337  * This function is mainly useful with \ref gras_msg_wait_or, ie seldom.
 338  */
 339 void gras_msg_cb_ctx_free(gras_msg_cb_ctx_t ctx)
 340 {
 341   free(ctx);
 342 }