src/gras/Msg/msg.c

   1 /* $Id$ */
   2
   3 /* messaging - Function related to messaging (code shared between RL and SG)*/
   4
   5 /* Copyright (c) 2003, 2004 Martin Quinson. All rights reserved.            */
   6
   7 /* This program is free software; you can redistribute it and/or modify it
   8  * under the terms of the license (GNU LGPL) which comes with this package. */
   9
  10
  11 #include "gras/Msg/msg_private.h"
  12 #include "gras/DataDesc/datadesc_interface.h"
  13 #include "gras/Transport/transport_interface.h" /* gras_trp_chunk_send/recv */
  14 #include "gras/Virtu/virtu_interface.h"
  15
  16 #define MIN(a,b) ((a) < (b) ? (a) : (b))
  17
  18 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(gras_msg,gras,"High level messaging");
  19
  20 xbt_set_t _gras_msgtype_set = NULL;
  21 static char GRAS_header[6];
  22 static char *make_namev(const char *name, short int ver);
  23
  24 /*
  25  * Creating procdata for this module
  26  */
  27 static void *gras_msg_procdata_new() {
  28    gras_msg_procdata_t res = xbt_new(s_gras_msg_procdata_t,1);
  29
  30    res->msg_queue = xbt_dynar_new(sizeof(s_gras_msg_t),   NULL);
  31    res->cbl_list  = xbt_dynar_new(sizeof(gras_cblist_t *),gras_cbl_free);
  32    res->timers    = xbt_dynar_new(sizeof(s_gras_timer_t), NULL);
  33
  34    return (void*)res;
  35 }
  36
  37 /*
  38  * Freeing procdata for this module
  39  */
  40 static void gras_msg_procdata_free(void *data) {
  41    gras_msg_procdata_t res = (gras_msg_procdata_t)data;
  42
  43    xbt_dynar_free(&( res->msg_queue ));
  44    xbt_dynar_free(&( res->cbl_list ));
  45    xbt_dynar_free(&( res->timers ));
  46
  47    free(res);
  48 }
  49
  50 /*
  51  * Module registration
  52  */
  53 void gras_msg_register() {
  54    gras_procdata_add("gras_msg",gras_msg_procdata_new, gras_msg_procdata_free);
  55 }
  56
  57 /*
  58  * Initialize this submodule.
  59  */
  60 void gras_msg_init(void) {
  61   /* only initialize once */
  62   if (_gras_msgtype_set != NULL)
  63     return;
  64
  65   VERB0("Initializing Msg");
  66
  67   _gras_msgtype_set = xbt_set_new();
  68
  69   memcpy(GRAS_header,"GRAS", 4);
  70   GRAS_header[4]=GRAS_PROTOCOL_VERSION;
  71   GRAS_header[5]=(char)GRAS_THISARCH;
  72 }
  73
  74 /*
  75  * Finalize the msg module
  76  */
  77 void
  78 gras_msg_exit(void) {
  79   VERB0("Exiting Msg");
  80   xbt_set_free(&_gras_msgtype_set);
  81 }
  82
  83 /*
  84  * Reclamed memory
  85  */
  86 void gras_msgtype_free(void *t) {
  87   gras_msgtype_t msgtype=(gras_msgtype_t)t;
  88   if (msgtype) {
  89     free(msgtype->name);
  90     free(msgtype);
  91   }
  92 }
  93
  94 /**
  95  * make_namev:
  96  *
  97  * Returns the versionned name of the message. If the version is 0, that's
  98  * the name unchanged. Pay attention to this before free'ing the result.
  99  */
 100 static char *make_namev(const char *name, short int ver) {
 101   char *namev;
 102
 103   if (!ver)
 104     return (char *)name;
 105
 106   namev = (char*)xbt_malloc(strlen(name)+2+3+1);
 107
 108   if (namev)
 109       sprintf(namev,"%s_v%d",name,ver);
 110
 111   return namev;
 112 }
 113
 114 /** @brief declare a new message type of the given name. It only accepts the given datadesc as payload
 115  *
 116  * @param name: name as it should be used for logging messages (must be uniq)
 117  * @param payload: datadescription of the payload
 118  */
 119 void gras_msgtype_declare(const char           *name,
 120                           gras_datadesc_type_t  payload) {
 121    gras_msgtype_declare_v(name, 0, payload);
 122 }
 123
 124 /** @brief declare a new versionned message type of the given name and payload
 125  *
 126  * @param name: name as it should be used for logging messages (must be uniq)
 127  * @param version: something like versionning symbol
 128  * @param payload: datadescription of the payload
 129  *
 130  * Registers a message to the GRAS mechanism. Use this version instead of
 131  * gras_msgtype_declare when you change the semantic or syntax of a message and
 132  * want your programs to be able to deal with both versions. Internally, each
 133  * will be handled as an independent message type, so you can register
 134  * differents for each of them.
 135  */
 136 void
 137 gras_msgtype_declare_v(const char           *name,
 138                        short int             version,
 139                        gras_datadesc_type_t  payload) {
 140
 141   xbt_error_t   errcode;
 142   gras_msgtype_t msgtype;
 143   char *namev=make_namev(name,version);
 144
 145   errcode = xbt_set_get_by_name(_gras_msgtype_set,
 146                                  namev,(xbt_set_elm_t*)&msgtype);
 147
 148   if (errcode == no_error) {
 149     VERB2("Re-register version %d of message '%s' (same payload, ignored).",
 150           version, name);
 151     xbt_assert3(!gras_datadesc_type_cmp(msgtype->ctn_type, payload),
 152                  "Message %s re-registred with another payload (%s was %s)",
 153                  namev,gras_datadesc_get_name(payload),
 154                  gras_datadesc_get_name(msgtype->ctn_type));
 155
 156     return ; /* do really ignore it */
 157
 158   }
 159   xbt_assert_error(mismatch_error); /* expect this error */
 160   VERB3("Register version %d of message '%s' (payload: %s).",
 161         version, name, gras_datadesc_get_name(payload));
 162
 163   msgtype = xbt_new(s_gras_msgtype_t,1);
 164   msgtype->name = (namev == name ? strdup(name) : namev);
 165   msgtype->name_len = strlen(namev);
 166   msgtype->version = version;
 167   msgtype->ctn_type = payload;
 168
 169   xbt_set_add(_gras_msgtype_set, (xbt_set_elm_t)msgtype,
 170                &gras_msgtype_free);
 171 }
 172
 173 /** @brief retrive an existing message type from its name. */
 174 gras_msgtype_t gras_msgtype_by_name (const char *name) {
 175   return gras_msgtype_by_namev(name,0);
 176 }
 177
 178 /** @brief retrive an existing message type from its name and version. */
 179 gras_msgtype_t gras_msgtype_by_namev(const char      *name,
 180                                      short int        version) {
 181   gras_msgtype_t res;
 182
 183   xbt_error_t errcode;
 184   char *namev = make_namev(name,version);
 185
 186   errcode = xbt_set_get_by_name(_gras_msgtype_set, namev,
 187                                  (xbt_set_elm_t*)&res);
 188   if (errcode != no_error)
 189     res = NULL;
 190   if (!res)
 191      WARN1("msgtype_by_name(%s) returns NULL",namev);
 192   if (name != namev)
 193     free(namev);
 194
 195   return res;
 196 }
 197
 198 /** \brief Send the data pointed by \a payload as a message of type
 199  * \a msgtype to the peer \a sock */
 200 xbt_error_t
 201 gras_msg_send(gras_socket_t   sock,
 202               gras_msgtype_t  msgtype,
 203               void           *payload) {
 204
 205   xbt_error_t errcode;
 206   static gras_datadesc_type_t string_type=NULL;
 207
 208   if (!msgtype)
 209     RAISE0(mismatch_error,
 210            "Cannot send the NULL message (did msgtype_by_name fail?)");
 211
 212   if (!string_type) {
 213     string_type = gras_datadesc_by_name("string");
 214     xbt_assert(string_type);
 215   }
 216
 217   DEBUG3("send '%s' to %s:%d", msgtype->name,
 218          gras_socket_peer_name(sock),gras_socket_peer_port(sock));
 219   TRY(gras_trp_chunk_send(sock, GRAS_header, 6));
 220
 221   TRY(gras_datadesc_send(sock, string_type,   &msgtype->name));
 222   if (msgtype->ctn_type)
 223     TRY(gras_datadesc_send(sock, msgtype->ctn_type, payload));
 224   TRY(gras_trp_flush(sock));
 225
 226   return no_error;
 227 }
 228 /*
 229  * receive the next message on the given socket.
 230  */
 231 xbt_error_t
 232 gras_msg_recv(gras_socket_t    sock,
 233               gras_msgtype_t  *msgtype,
 234               void           **payload,
 235               int             *payload_size) {
 236
 237   xbt_error_t errcode;
 238   static gras_datadesc_type_t string_type=NULL;
 239   char header[6];
 240   int cpt;
 241   int r_arch;
 242   char *msg_name=NULL;
 243
 244   if (!string_type) {
 245     string_type=gras_datadesc_by_name("string");
 246     xbt_assert(string_type);
 247   }
 248
 249   TRY(gras_trp_chunk_recv(sock, header, 6));
 250   for (cpt=0; cpt<4; cpt++)
 251     if (header[cpt] != GRAS_header[cpt])
 252       RAISE2(mismatch_error,"Incoming bytes do not look like a GRAS message (header='%.4s' not '%.4s')",header,GRAS_header);
 253   if (header[4] != GRAS_header[4])
 254     RAISE2(mismatch_error,"GRAS protocol mismatch (got %d, use %d)",
 255            (int)header[4], (int)GRAS_header[4]);
 256   r_arch = (int)header[5];
 257   DEBUG2("Handle an incoming message using protocol %d (remote is %s)",
 258          (int)header[4],gras_datadesc_arch_name(r_arch));
 259
 260   TRY(gras_datadesc_recv(sock, string_type, r_arch, &msg_name));
 261   errcode = xbt_set_get_by_name(_gras_msgtype_set,
 262                                  msg_name,(xbt_set_elm_t*)msgtype);
 263   if (errcode != no_error)
 264     RAISE2(errcode,
 265            "Got error %s while retrieving the type associated to messages '%s'",
 266            xbt_error_name(errcode),msg_name);
 267   /* FIXME: Survive unknown messages */
 268   free(msg_name);
 269
 270   if ((*msgtype)->ctn_type) {
 271     *payload_size=gras_datadesc_size((*msgtype)->ctn_type);
 272     xbt_assert2(*payload_size > 0,
 273                 "%s %s",
 274                 "Dynamic array as payload is forbided for now (FIXME?).",
 275                 "Reference to dynamic array is allowed.");
 276     *payload = xbt_malloc(*payload_size);
 277     TRY(gras_datadesc_recv(sock, (*msgtype)->ctn_type, r_arch, *payload));
 278   } else {
 279     *payload = NULL;
 280     *payload_size = 0;
 281   }
 282   return no_error;
 283 }
 284
 285 /** \brief Waits for a message to come in over a given socket.
 286  *
 287  * @param timeout: How long should we wait for this message.
 288  * @param msgt_want: type of awaited msg
 289  * @param[out] expeditor: where to create a socket to answer the incomming message
 290  * @param[out] payload: where to write the payload of the incomming message
 291  * @return the error code (or no_error).
 292  *
 293  * Every message of another type received before the one waited will be queued
 294  * and used by subsequent call to this function or gras_msg_handle().
 295  */
 296 xbt_error_t
 297 gras_msg_wait(double           timeout,
 298               gras_msgtype_t   msgt_want,
 299               gras_socket_t   *expeditor,
 300               void            *payload) {
 301
 302   gras_msgtype_t msgt_got;
 303   void *payload_got;
 304   int payload_size_got;
 305   xbt_error_t errcode;
 306   double start, now;
 307   gras_msg_procdata_t pd=(gras_msg_procdata_t)gras_libdata_get("gras_msg");
 308   int cpt;
 309   s_gras_msg_t msg;
 310   gras_socket_t expeditor_res = NULL;
 311
 312   payload_got = NULL;
 313
 314   if (!msgt_want)
 315     RAISE0(mismatch_error,
 316            "Cannot wait for the NULL message (did msgtype_by_name fail?)");
 317
 318   VERB1("Waiting for message '%s'",msgt_want->name);
 319
 320   start = now = gras_os_time();
 321
 322   xbt_dynar_foreach(pd->msg_queue,cpt,msg){
 323     if (msg.type->code == msgt_want->code) {
 324       if (expeditor)
 325         *expeditor = msg.expeditor;
 326       memcpy(payload, msg.payload, msg.payload_size);
 327       free(msg.payload);
 328       xbt_dynar_cursor_rm(pd->msg_queue, &cpt);
 329       VERB0("The waited message was queued");
 330       return no_error;
 331     }
 332   }
 333
 334   while (1) {
 335     TRY(gras_trp_select(timeout - now + start, &expeditor_res));
 336     TRY(gras_msg_recv(expeditor_res, &msgt_got, &payload_got, &payload_size_got));
 337     if (msgt_got->code == msgt_want->code) {
 338       if (expeditor)
 339         *expeditor=expeditor_res;
 340       memcpy(payload, payload_got, payload_size_got);
 341       free(payload_got);
 342       VERB0("Got waited message");
 343       return no_error;
 344     }
 345
 346     /* not expected msg type. Queue it for later */
 347     msg.expeditor = expeditor_res;
 348     msg.type      = msgt_got;
 349     msg.payload   = payload;
 350     msg.payload_size = payload_size_got;
 351     xbt_dynar_push(pd->msg_queue,&msg);
 352
 353     now=gras_os_time();
 354     if (now - start + 0.001 < timeout) {
 355       RAISE1(timeout_error,"Timeout while waiting for msg %s",msgt_want->name);
 356     }
 357   }
 358
 359   RAISE_IMPOSSIBLE;
 360 }
 361
 362 /** @brief Handle an incomming message or timer (or wait up to \a timeOut seconds)
 363  *
 364  * @param timeOut: How long to wait for incoming messages (in seconds)
 365  * @return the error code (or no_error).
 366  *
 367  * Messages are passed to the callbacks.
 368  */
 369 xbt_error_t
 370 gras_msg_handle(double timeOut) {
 371
 372   double          untiltimer;
 373
 374   xbt_error_t    errcode;
 375   int             cpt;
 376
 377   s_gras_msg_t    msg;
 378   gras_socket_t   expeditor;
 379   void           *payload=NULL;
 380   int             payload_size;
 381   gras_msgtype_t  msgtype;
 382
 383   gras_msg_procdata_t pd=(gras_msg_procdata_t)gras_libdata_get("gras_msg");
 384   gras_cblist_t  *list=NULL;
 385   gras_msg_cb_t       cb;
 386
 387   int timerexpected;
 388
 389   VERB1("Handling message within the next %.2fs",timeOut);
 390
 391   untiltimer = gras_msg_timer_handle();
 392   DEBUG2("[%.0f] Next timer in %f sec", gras_os_time(), untiltimer);
 393   if (untiltimer == 0.0) {
 394      /* A timer was already elapsed and handled */
 395      return no_error;
 396   }
 397   if (untiltimer != -1.0) {
 398      timerexpected = 1;
 399      timeOut = MIN(timeOut, untiltimer);
 400   } else {
 401      timerexpected = 0;
 402   }
 403
 404   /* get a message (from the queue or from the net) */
 405   if (xbt_dynar_length(pd->msg_queue)) {
 406     DEBUG0("Get a message from the queue");
 407     xbt_dynar_shift(pd->msg_queue,&msg);
 408     expeditor = msg.expeditor;
 409     msgtype   = msg.type;
 410     payload   = msg.payload;
 411     errcode   = no_error;
 412   } else {
 413     errcode = gras_trp_select(timeOut, &expeditor);
 414     if (errcode != no_error && errcode != timeout_error)
 415        return errcode;
 416     if (errcode != timeout_error)
 417        TRY(gras_msg_recv(expeditor, &msgtype, &payload, &payload_size));
 418   }
 419
 420   if (errcode == timeout_error ) {
 421      if (timerexpected) {
 422
 423         /* A timer elapsed before the arrival of any message even if we select()ed a bit */
 424         untiltimer = gras_msg_timer_handle();
 425         if (untiltimer == 0.0) {
 426            return no_error;
 427         } else {
 428            xbt_assert1(untiltimer>0, "Negative timer (%f). I'm puzzeled", untiltimer);
 429            ERROR1("No timer elapsed, in contrary to expectations (next in %f sec)",
 430                   untiltimer);
 431            return timeout_error;
 432         }
 433
 434      } else {
 435         /* select timeouted, and no timer elapsed. Nothing to do */
 436         return timeout_error;
 437      }
 438
 439   }
 440
 441   /* A message was already there or arrived in the meanwhile. handle it */
 442   xbt_dynar_foreach(pd->cbl_list,cpt,list) {
 443     if (list->id == msgtype->code) {
 444       break;
 445     } else {
 446       list=NULL;
 447     }
 448   }
 449   if (!list) {
 450     INFO1("No callback for the incomming '%s' message. Discarded.",
 451           msgtype->name);
 452     WARN0("FIXME: gras_datadesc_free not implemented => leaking the payload");
 453     return no_error;
 454   }
 455
 456   xbt_dynar_foreach(list->cbs,cpt,cb) {
 457     VERB3("Use the callback #%d (@%p) for incomming msg %s",
 458           cpt+1,cb,msgtype->name);
 459     if ((*cb)(expeditor,payload)) {
 460       /* cb handled the message */
 461       free(payload);
 462       return no_error;
 463     }
 464   }
 465
 466   INFO1("Message '%s' refused by all registered callbacks", msgtype->name);
 467   WARN0("FIXME: gras_datadesc_free not implemented => leaking the payload");
 468   return mismatch_error;
 469 }
 470
 471 void
 472 gras_cbl_free(void *data){
 473   gras_cblist_t *list=*(void**)data;
 474   if (list) {
 475     xbt_dynar_free(&( list->cbs ));
 476     free(list);
 477   }
 478 }
 479
 480 /** \brief Bind the given callback to the given message type
 481  *
 482  * Several callbacks can be attached to a given message type. The lastly added one will get the message first, and
 483  * if it returns false, the message will be passed to the second one.
 484  * And so on until one of the callbacks accepts the message.
 485  */
 486 void
 487 gras_cb_register(gras_msgtype_t msgtype,
 488                  gras_msg_cb_t cb) {
 489   gras_msg_procdata_t pd=(gras_msg_procdata_t)gras_libdata_get("gras_msg");
 490   gras_cblist_t *list=NULL;
 491   int cpt;
 492
 493   DEBUG2("Register %p as callback to '%s'",cb,msgtype->name);
 494
 495   /* search the list of cb for this message on this host (creating if NULL) */
 496   xbt_dynar_foreach(pd->cbl_list,cpt,list) {
 497     if (list->id == msgtype->code) {
 498       break;
 499     } else {
 500       list=NULL;
 501     }
 502   }
 503   if (!list) {
 504     /* First cb? Create room */
 505     list = xbt_new(gras_cblist_t,1);
 506     list->id = msgtype->code;
 507     list->cbs = xbt_dynar_new(sizeof(gras_msg_cb_t), NULL);
 508     xbt_dynar_push(pd->cbl_list,&list);
 509   }
 510
 511   /* Insert the new one into the set */
 512   xbt_dynar_insert_at(list->cbs,0,&cb);
 513 }
 514
 515 /** \brief Unbind the given callback from the given message type */
 516 void
 517 gras_cb_unregister(gras_msgtype_t msgtype,
 518                    gras_msg_cb_t cb) {
 519
 520   gras_msg_procdata_t pd=(gras_msg_procdata_t)gras_libdata_get("gras_msg");
 521   gras_cblist_t *list;
 522   gras_msg_cb_t cb_cpt;
 523   int cpt;
 524   int found = 0;
 525
 526   /* search the list of cb for this message on this host */
 527   xbt_dynar_foreach(pd->cbl_list,cpt,list) {
 528     if (list->id == msgtype->code) {
 529       break;
 530     } else {
 531       list=NULL;
 532     }
 533   }
 534
 535   /* Remove it from the set */
 536   if (list) {
 537     xbt_dynar_foreach(list->cbs,cpt,cb_cpt) {
 538       if (cb == cb_cpt) {
 539         xbt_dynar_cursor_rm(list->cbs, &cpt);
 540         found = 1;
 541       }
 542     }
 543   }
 544   if (!found)
 545     VERB1("Ignoring removal of unexisting callback to msg id %d",
 546           msgtype->code);
 547 }