src/gras/Msg/msg.c

   1 /* $Id$ */
   2
   3 /* messaging - Function related to messaging (code shared between RL and SG)*/
   4
   5 /* Authors: Martin Quinson                                                  */
   6 /* Copyright (C) 2003 the OURAGAN project.                                  */
   7
   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. */
  10
  11 #include "Msg/msg_private.h"
  12
  13 GRAS_LOG_NEW_DEFAULT_SUBCATEGORY(msg,GRAS);
  14
  15 gras_set_t *_gras_msgtype_set = NULL;
  16 static char GRAS_header[6];
  17 static char *make_namev(const char *name, short int ver);
  18
  19 /**
  20  * gras_msg_init:
  21  *
  22  * Initialize this submodule.
  23  */
  24 void gras_msg_init(void) {
  25   gras_error_t errcode;
  26
  27   /* only initialize once */
  28   if (_gras_msgtype_set != NULL)
  29     return;
  30
  31   VERB0("Initializing Msg");
  32
  33   TRYFAIL(gras_set_new(&_gras_msgtype_set));
  34
  35   memcpy(GRAS_header,"GRAS", 4);
  36   GRAS_header[4]=GRAS_PROTOCOL_VERSION;
  37   GRAS_header[5]=(char)GRAS_THISARCH;
  38 }
  39
  40 /**
  41  * gras_msg_exit:
  42  *
  43  * Finalize the msg module
  44  **/
  45 void
  46 gras_msg_exit(void) {
  47   VERB0("Exiting Msg");
  48   gras_set_free(&_gras_msgtype_set);
  49   _gras_msgtype_set = NULL;
  50 }
  51
  52 /**
  53  * gras_msgtype_free:
  54  *
  55  * Reclamed memory
  56  */
  57 void gras_msgtype_free(void *t) {
  58   gras_msgtype_t *msgtype=(gras_msgtype_t *)t;
  59   if (msgtype) {
  60     free(msgtype->name);
  61     free(msgtype);
  62   }
  63 }
  64
  65 /**
  66  * make_namev:
  67  *
  68  * Returns the versionned name of the message. If the version is 0, that's
  69  * the name unchanged. Pay attention to this before free'ing the result.
  70  */
  71 static char *make_namev(const char *name, short int ver) {
  72   char *namev;
  73
  74   if (!ver)
  75     return (char *)name;
  76
  77   namev = malloc(strlen(name)+2+3+1);
  78
  79   if (namev) {
  80       sprintf(namev,"%s_v%d",name,ver);
  81   }
  82   return namev;
  83 }
  84
  85 /**
  86  * gras_msgtype_declare:
  87  * @name: name as it should be used for logging messages (must be uniq)
  88  * @payload: datadescription of the payload
  89  *
  90  * Registers a message to the GRAS mecanism.
  91  */
  92 gras_error_t
  93 gras_msgtype_declare(const char            *name,
  94                      gras_datadesc_type_t  *payload,
  95                      gras_msgtype_t       **dst) {
  96   return gras_msgtype_declare_v(name, 0, payload, dst);
  97 }
  98
  99 /**
 100  * gras_msgtype_declare_v:
 101  * @name: name as it should be used for logging messages (must be uniq)
 102  * @version: something like versionning symbol
 103  * @payload: datadescription of the payload
 104  *
 105  * Registers a message to the GRAS mecanism. Use this version instead of
 106  * gras_msgtype_declare when you change the semantic or syntax of a message and
 107  * want your programs to be able to deal with both versions. Internally, each
 108  * will be handled as an independent message type, so you can register
 109  * differents for each of them.
 110  */
 111 gras_error_t
 112 gras_msgtype_declare_v(const char            *name,
 113                        short int              version,
 114                        gras_datadesc_type_t  *payload,
 115                        gras_msgtype_t       **dst) {
 116
 117   gras_error_t    errcode;
 118   gras_msgtype_t *msgtype;
 119   char *namev=make_namev(name,version);
 120
 121   if (!namev)
 122     RAISE_MALLOC;
 123
 124   errcode = gras_set_get_by_name(_gras_msgtype_set,
 125                                  namev,(gras_set_elm_t**)&msgtype);
 126
 127   if (errcode == no_error) {
 128     VERB2("Re-register version %d of message '%s' (same payload, ignored).",
 129           version, name);
 130     gras_assert3(!gras_datadesc_type_cmp(msgtype->ctn_type, payload),
 131                  "Message %s re-registred with another payload (%s was %s)",
 132                  namev,gras_datadesc_get_name(payload),
 133                  gras_datadesc_get_name(msgtype->ctn_type));
 134   } else if (errcode == mismatch_error) {
 135     INFO3("Register version %d of message '%s' (payload: %s).",
 136            version, name, gras_datadesc_get_name(payload));
 137   } else {
 138     return errcode; /* Was expecting for mismatch_error */
 139   }
 140
 141   /* create type anyway so that the old type gets removed from here, and
 142      hopefully free'd when ref counter gets 0 */
 143   if (! (msgtype = malloc(sizeof(gras_msgtype_t))) )
 144     RAISE_MALLOC;
 145
 146   msgtype->name = (namev == name ? strdup(name) : namev);
 147   msgtype->name_len = strlen(namev);
 148   msgtype->version = version;
 149   msgtype->ctn_type = payload;
 150   gras_datadesc_ref(payload);
 151
 152   TRY(gras_set_add(_gras_msgtype_set, (gras_set_elm_t*)msgtype,
 153                    &gras_msgtype_free));
 154
 155   return no_error;
 156 }
 157
 158 /**
 159  * gras_msgtype_by_name:
 160  *
 161  * Retrieve a datatype description from its name
 162  */
 163 gras_error_t
 164 gras_msgtype_by_name (const char     *name,
 165                       gras_msgtype_t **dst) {
 166   return gras_msgtype_by_namev(name,0,dst);
 167 }
 168 /**
 169  * gras_msgtype_by_namev:
 170  *
 171  * Retrieve a datatype description from its name and version
 172  */
 173 gras_error_t
 174 gras_msgtype_by_namev(const char      *name,
 175                       short int        version,
 176                       gras_msgtype_t **dst) {
 177
 178   gras_error_t errcode;
 179   char *namev = make_namev(name,version);
 180
 181   errcode = gras_set_get_by_name(_gras_msgtype_set, namev,
 182                                  (gras_set_elm_t**)dst);
 183   if (name != namev)
 184     free(namev);
 185
 186   return errcode;
 187 }
 188
 189 /**
 190  * gras_msg_send:
 191  *
 192  * Send the given message on the given socket
 193  */
 194 gras_error_t
 195 gras_msg_send(gras_socket_t  *sock,
 196               gras_msgtype_t *msgtype,
 197               void           *payload) {
 198
 199   gras_error_t errcode;
 200   static gras_datadesc_type_t *string_type=NULL;
 201   if (!string_type) {
 202     string_type = gras_datadesc_by_name("string");
 203     gras_assert(string_type);
 204   }
 205
 206   DEBUG3("send %s to %s:%d", msgtype->name,
 207          gras_socket_peer_name(sock),gras_socket_peer_port(sock));
 208   TRY(gras_trp_chunk_send(sock, GRAS_header, 6));
 209
 210   TRY(gras_datadesc_send(sock, string_type,   &msgtype->name));
 211   TRY(gras_datadesc_send(sock, msgtype->ctn_type, payload));
 212
 213   return no_error;
 214 }
 215 /**
 216  * gras_msg_recv:
 217  *
 218  * receive the next message on the given socket.
 219  */
 220 gras_error_t
 221 gras_msg_recv(gras_socket_t   *sock,
 222               gras_msgtype_t **msgtype,
 223               void           **payload,
 224               int             *payload_size) {
 225
 226   gras_error_t errcode;
 227   static gras_datadesc_type_t *string_type=NULL;
 228   char header[6];
 229   int cpt;
 230   int r_arch;
 231   char *msg_name=NULL;
 232
 233   if (!string_type) {
 234     string_type=gras_datadesc_by_name("string");
 235     gras_assert(string_type);
 236   }
 237
 238   TRY(gras_trp_chunk_recv(sock, header, 6));
 239   for (cpt=0; cpt<4; cpt++)
 240     if (header[cpt] != GRAS_header[cpt])
 241       RAISE0(mismatch_error,"Incoming bytes do not look like a GRAS message");
 242   if (header[4] != GRAS_header[4])
 243     RAISE2(mismatch_error,"GRAS protocol mismatch (got %d, use %d)",
 244            (int)header[4], (int)GRAS_header[4]);
 245   r_arch = (int)header[5];
 246   DEBUG2("Handle an incoming message using protocol %d (remote is %s)",
 247          (int)header[4],gras_datadesc_arch_name(r_arch));
 248
 249   TRY(gras_datadesc_recv(sock, string_type, r_arch, &msg_name));
 250   TRY(gras_set_get_by_name(_gras_msgtype_set,
 251                            msg_name,(gras_set_elm_t**)msgtype));
 252   free(msg_name);
 253
 254   *payload_size=gras_datadesc_size((*msgtype)->ctn_type);
 255   gras_assert2(*payload_size > 0,
 256                "%s %s",
 257                "Dynamic array as payload is forbided for now (FIXME?).",
 258                "Reference to dynamic array is allowed.");
 259   *payload = malloc(*payload_size);
 260   TRY(gras_datadesc_recv(sock, (*msgtype)->ctn_type, r_arch, *payload));
 261
 262   return no_error;
 263 }
 264
 265 /**
 266  * gras_msg_wait:
 267  * @timeout: How long should we wait for this message.
 268  * @id: id of awaited msg
 269  * @Returns: the error code (or no_error).
 270  *
 271  * Waits for a message to come in over a given socket.
 272  *
 273  * Every message of another type received before the one waited will be queued
 274  * and used by subsequent call to this function or MsgHandle().
 275  */
 276 gras_error_t
 277 gras_msg_wait(double                 timeout,
 278               gras_msgtype_t        *msgt_want,
 279               gras_socket_t        **expeditor,
 280               void                  *payload) {
 281
 282   gras_msgtype_t *msgt_got;
 283   void *payload_got;
 284   int payload_size_got;
 285   gras_error_t errcode;
 286   double start, now;
 287   gras_procdata_t *pd=gras_procdata_get();
 288   int cpt;
 289   gras_msg_t msg;
 290
 291   *expeditor = NULL;
 292   payload_got = NULL;
 293
 294   VERB1("Waiting for message %s",msgt_want->name);
 295
 296   start = now = gras_time();
 297
 298   gras_dynar_foreach(pd->msg_queue,cpt,msg){
 299     if (msg.type->code == msgt_want->code) {
 300       *expeditor = msg.expeditor;
 301       memcpy(payload, msg.payload, msg.payload_size);
 302       free(msg.payload);
 303       gras_dynar_cursor_rm(pd->msg_queue, &cpt);
 304       VERB0("The waited message was queued");
 305       return no_error;
 306     }
 307   }
 308
 309   while (1) {
 310     TRY(gras_trp_select(timeout - now + start, expeditor));
 311     TRY(gras_msg_recv(*expeditor, &msgt_got, &payload_got, &payload_size_got));
 312     if (msgt_got->code == msgt_want->code) {
 313       memcpy(payload, payload_got, payload_size_got);
 314       free(payload_got);
 315       VERB0("Got waited message");
 316       return no_error;
 317     }
 318
 319     /* not expected msg type. Queue it for later */
 320     msg.expeditor = *expeditor;
 321     msg.type      =  msgt_got;
 322     msg.payload   =  payload;
 323     msg.payload_size = payload_size_got;
 324     TRY(gras_dynar_push(pd->msg_queue,&msg));
 325
 326     now=gras_time();
 327     if (now - start + 0.001 < timeout) {
 328       RAISE1(timeout_error,"Timeout while waiting for msg %s",msgt_want->name);
 329     }
 330   }
 331
 332   RAISE_IMPOSSIBLE;
 333 }
 334
 335 /**
 336  * gras_msg_handle:
 337  * @timeOut: How long to wait for incoming messages
 338  * @Returns: the error code (or no_error).
 339  *
 340  * Waits up to #timeOut# seconds to see if a message comes in; if so, calls the
 341  * registered listener for that message (see RegisterCallback()).
 342  */
 343 gras_error_t
 344 gras_msg_handle(double timeOut) {
 345
 346   gras_error_t    errcode;
 347   int             cpt;
 348
 349   gras_msg_t      msg;
 350   gras_socket_t  *expeditor;
 351   void           *payload=NULL;
 352   int             payload_size;
 353   gras_msgtype_t *msgtype;
 354
 355   gras_procdata_t*pd=gras_procdata_get();
 356   gras_cblist_t  *list;
 357   gras_cb_t       cb;
 358
 359
 360
 361   VERB1("Handling message within the next %.2fs",timeOut);
 362
 363   /* get a message (from the queue or from the net) */
 364   if (gras_dynar_length(pd->msg_queue)) {
 365     gras_dynar_shift(pd->msg_queue,&msg);
 366     expeditor = msg.expeditor;
 367     msgtype   = msg.type;
 368     payload   = msg.payload;
 369
 370   } else {
 371     TRY(gras_trp_select(timeOut, &expeditor));
 372     TRY(gras_msg_recv(expeditor, &msgtype, &payload, &payload_size));
 373   }
 374
 375   /* handle it */
 376   gras_dynar_foreach(pd->cbl_list,cpt,list) {
 377     if (list->id == msgtype->code) {
 378       break;
 379     } else {
 380       list=NULL;
 381     }
 382   }
 383   if (!list) {
 384     INFO1("No callback for the incomming '%s' message. Discarded.",
 385           msgtype->name);
 386     WARN0("FIXME: gras_datadesc_free not implemented => leaking the payload");
 387     return no_error;
 388   }
 389
 390   gras_dynar_foreach(list->cbs,cpt,cb) {
 391     INFO3("Invoque the callback #%d (@%p) for incomming msg %s",
 392           cpt+1,cb,msgtype->name);
 393     if ((*cb)(expeditor,payload)) {
 394       /* cb handled the message */
 395       free(payload);
 396       return no_error;
 397     }
 398   }
 399
 400   INFO1("Message '%s' refused by all registered callbacks", msgtype->name);
 401   WARN0("FIXME: gras_datadesc_free not implemented => leaking the payload");
 402   return mismatch_error;
 403 }
 404
 405 void
 406 gras_cbl_free(void *data){
 407   gras_cblist_t *list=*(void**)data;
 408   if (list) {
 409     gras_dynar_free(list->cbs);
 410     free(list);
 411   }
 412 }
 413
 414 gras_error_t
 415 gras_cb_register(gras_msgtype_t *msgtype,
 416                  gras_cb_t cb) {
 417   gras_error_t errcode;
 418   gras_procdata_t *pd=gras_procdata_get();
 419   gras_cblist_t *list=NULL;
 420   int cpt;
 421
 422   DEBUG2("Register %p as callback to %s",cb,msgtype->name);
 423
 424   /* search the list of cb for this message on this host (creating if NULL) */
 425   gras_dynar_foreach(pd->cbl_list,cpt,list) {
 426     if (list->id == msgtype->code) {
 427       break;
 428     } else {
 429       list=NULL;
 430     }
 431   }
 432   if (!list) {
 433     /* First cb? Create room */
 434     list = malloc(sizeof(gras_cblist_t));
 435     if (!list)
 436       RAISE_MALLOC;
 437
 438     list->id = msgtype->code;
 439     TRY(gras_dynar_new(&(list->cbs), sizeof(gras_cb_t), NULL));
 440     TRY(gras_dynar_push(pd->cbl_list,&list));
 441   }
 442
 443   /* Insert the new one into the set */
 444   TRY(gras_dynar_insert_at(list->cbs,0,&cb));
 445
 446   return no_error;
 447 }
 448
 449 void
 450 gras_cb_unregister(gras_msgtype_t *msgtype,
 451                    gras_cb_t cb) {
 452
 453   gras_procdata_t *pd=gras_procdata_get();
 454   gras_cblist_t *list;
 455   gras_cb_t cb_cpt;
 456   int cpt;
 457   int found = 0;
 458
 459   /* search the list of cb for this message on this host */
 460   gras_dynar_foreach(pd->cbl_list,cpt,list) {
 461     if (list->id == msgtype->code) {
 462       break;
 463     } else {
 464       list=NULL;
 465     }
 466   }
 467
 468   /* Remove it from the set */
 469   if (list) {
 470     gras_dynar_foreach(list->cbs,cpt,cb_cpt) {
 471       if (cb == cb_cpt) {
 472         gras_dynar_cursor_rm(list->cbs, &cpt);
 473         found = 1;
 474       }
 475     }
 476   }
 477   if (!found)
 478     VERB1("Ignoring removal of unexisting callback to msg id %d",
 479           msgtype->code);
 480 }