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 #include "xbt/ex.h"
  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   gras_msgtype_t msgtype;
 142   char *namev=make_namev(name,version);
 143   int found = 0;
 144   xbt_ex_t e;
 145
 146   TRY {
 147     msgtype = (gras_msgtype_t)xbt_set_get_by_name(_gras_msgtype_set,namev);
 148     found = 1;
 149   } CATCH(e) {
 150     if (e.category != not_found_error)
 151       RETHROW;
 152     xbt_ex_free(e);
 153   }
 154
 155   if (found) {
 156     VERB2("Re-register version %d of message '%s' (same payload, ignored).",
 157           version, name);
 158     xbt_assert3(!gras_datadesc_type_cmp(msgtype->ctn_type, payload),
 159                  "Message %s re-registred with another payload (%s was %s)",
 160                  namev,gras_datadesc_get_name(payload),
 161                  gras_datadesc_get_name(msgtype->ctn_type));
 162
 163     return ; /* do really ignore it */
 164
 165   }
 166
 167   VERB3("Register version %d of message '%s' (payload: %s).",
 168         version, name, gras_datadesc_get_name(payload));
 169
 170   msgtype = xbt_new(s_gras_msgtype_t,1);
 171   msgtype->name = (namev == name ? strdup(name) : namev);
 172   msgtype->name_len = strlen(namev);
 173   msgtype->version = version;
 174   msgtype->ctn_type = payload;
 175
 176   xbt_set_add(_gras_msgtype_set, (xbt_set_elm_t)msgtype,
 177                &gras_msgtype_free);
 178 }
 179
 180 /** @brief retrive an existing message type from its name. */
 181 gras_msgtype_t gras_msgtype_by_name (const char *name) {
 182   return gras_msgtype_by_namev(name,0);
 183 }
 184
 185 /** @brief retrive an existing message type from its name and version. */
 186 gras_msgtype_t gras_msgtype_by_namev(const char      *name,
 187                                      short int        version) {
 188   gras_msgtype_t res;
 189   char *namev = make_namev(name,version);
 190
 191   res = (gras_msgtype_t)xbt_set_get_by_name(_gras_msgtype_set, 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 void
 201 gras_msg_send(gras_socket_t   sock,
 202               gras_msgtype_t  msgtype,
 203               void           *payload) {
 204
 205   static gras_datadesc_type_t string_type=NULL;
 206
 207   if (!msgtype)
 208     THROW0(arg_error,0,
 209            "Cannot send the NULL message (did msgtype_by_name fail?)");
 210
 211   if (!string_type) {
 212     string_type = gras_datadesc_by_name("string");
 213     xbt_assert(string_type);
 214   }
 215
 216   DEBUG3("send '%s' to %s:%d", msgtype->name,
 217          gras_socket_peer_name(sock),gras_socket_peer_port(sock));
 218   gras_trp_chunk_send(sock, GRAS_header, 6);
 219
 220   gras_datadesc_send(sock, string_type,   &msgtype->name);
 221   if (msgtype->ctn_type)
 222     gras_datadesc_send(sock, msgtype->ctn_type, payload);
 223   gras_trp_flush(sock);
 224 }
 225 /*
 226  * receive the next message on the given socket.
 227  */
 228 void
 229 gras_msg_recv(gras_socket_t    sock,
 230               gras_msgtype_t  *msgtype,
 231               void           **payload,
 232               int             *payload_size) {
 233
 234   xbt_ex_t e;
 235   static gras_datadesc_type_t string_type=NULL;
 236   char header[6];
 237   int cpt;
 238   int r_arch;
 239   char *msg_name=NULL;
 240
 241   xbt_assert1(!gras_socket_is_meas(sock),
 242               "Asked to receive a message on the measurement socket %p", sock);
 243   if (!string_type) {
 244     string_type=gras_datadesc_by_name("string");
 245     xbt_assert(string_type);
 246   }
 247
 248   TRY {
 249     gras_trp_chunk_recv(sock, header, 6);
 250   } CATCH(e) {
 251     RETHROW1("Exception caught while trying to get the mesage header on socket %p : %s",
 252              sock);
 253   }
 254
 255   for (cpt=0; cpt<4; cpt++)
 256     if (header[cpt] != GRAS_header[cpt])
 257       THROW2(mismatch_error,0,
 258              "Incoming bytes do not look like a GRAS message (header='%.4s' not '%.4s')",header,GRAS_header);
 259   if (header[4] != GRAS_header[4])
 260     THROW2(mismatch_error,0,"GRAS protocol mismatch (got %d, use %d)",
 261            (int)header[4], (int)GRAS_header[4]);
 262   r_arch = (int)header[5];
 263   DEBUG2("Handle an incoming message using protocol %d (remote is %s)",
 264          (int)header[4],gras_datadesc_arch_name(r_arch));
 265
 266   gras_datadesc_recv(sock, string_type, r_arch, &msg_name);
 267   TRY {
 268     *msgtype = (gras_msgtype_t)xbt_set_get_by_name(_gras_msgtype_set,msg_name);
 269   } CATCH(e) {
 270     /* FIXME: Survive unknown messages */
 271     RETHROW1("Exception caught while retrieving the type associated to messages '%s' : %s",
 272              msg_name);
 273   }
 274   free(msg_name);
 275
 276   if ((*msgtype)->ctn_type) {
 277     *payload_size=gras_datadesc_size((*msgtype)->ctn_type);
 278     xbt_assert2(*payload_size > 0,
 279                 "%s %s",
 280                 "Dynamic array as payload is forbided for now (FIXME?).",
 281                 "Reference to dynamic array is allowed.");
 282     *payload = xbt_malloc(*payload_size);
 283     gras_datadesc_recv(sock, (*msgtype)->ctn_type, r_arch, *payload);
 284   } else {
 285     *payload = NULL;
 286     *payload_size = 0;
 287   }
 288 }
 289
 290 /** \brief Waits for a message to come in over a given socket.
 291  *
 292  * @param timeout: How long should we wait for this message.
 293  * @param msgt_want: type of awaited msg
 294  * @param[out] expeditor: where to create a socket to answer the incomming message
 295  * @param[out] payload: where to write the payload of the incomming message
 296  * @return the error code (or no_error).
 297  *
 298  * Every message of another type received before the one waited will be queued
 299  * and used by subsequent call to this function or gras_msg_handle().
 300  */
 301 void
 302 gras_msg_wait(double           timeout,
 303               gras_msgtype_t   msgt_want,
 304               gras_socket_t   *expeditor,
 305               void            *payload) {
 306
 307   gras_msgtype_t msgt_got;
 308   void *payload_got;
 309   int payload_size_got;
 310   double start, now;
 311   gras_msg_procdata_t pd=(gras_msg_procdata_t)gras_libdata_get("gras_msg");
 312   int cpt;
 313   s_gras_msg_t msg;
 314   gras_socket_t expeditor_res = NULL;
 315
 316   payload_got = NULL;
 317
 318   xbt_assert0(msgt_want,"Cannot wait for the NULL message");
 319
 320   VERB1("Waiting for message '%s'",msgt_want->name);
 321
 322   start = now = gras_os_time();
 323
 324   xbt_dynar_foreach(pd->msg_queue,cpt,msg){
 325     if (msg.type->code == msgt_want->code) {
 326       if (expeditor)
 327         *expeditor = msg.expeditor;
 328       memcpy(payload, msg.payload, msg.payload_size);
 329       free(msg.payload);
 330       xbt_dynar_cursor_rm(pd->msg_queue, &cpt);
 331       VERB0("The waited message was queued");
 332       return;
 333     }
 334   }
 335
 336   while (1) {
 337     expeditor_res = gras_trp_select(timeout - now + start);
 338     gras_msg_recv(expeditor_res, &msgt_got, &payload_got, &payload_size_got);
 339     if (msgt_got->code == msgt_want->code) {
 340       if (expeditor)
 341         *expeditor=expeditor_res;
 342       memcpy(payload, payload_got, payload_size_got);
 343       free(payload_got);
 344       VERB0("Got waited message");
 345       return;
 346     }
 347
 348     /* not expected msg type. Queue it for later */
 349     msg.expeditor = expeditor_res;
 350     msg.type      = msgt_got;
 351     msg.payload   = payload;
 352     msg.payload_size = payload_size_got;
 353     xbt_dynar_push(pd->msg_queue,&msg);
 354
 355     now=gras_os_time();
 356     if (now - start + 0.001 < timeout) {
 357       THROW1(timeout_error,  now-start+0.001-timeout,
 358              "Timeout while waiting for msg %s",msgt_want->name);
 359     }
 360   }
 361
 362   THROW_IMPOSSIBLE;
 363 }
 364
 365 /** @brief Handle an incomming message or timer (or wait up to \a timeOut seconds)
 366  *
 367  * @param timeOut: How long to wait for incoming messages (in seconds)
 368  * @return the error code (or no_error).
 369  *
 370  * Messages are passed to the callbacks.
 371  */
 372 void
 373 gras_msg_handle(double timeOut) {
 374
 375   double          untiltimer;
 376
 377   int             cpt;
 378
 379   s_gras_msg_t    msg;
 380   gras_socket_t   expeditor;
 381   void           *payload=NULL;
 382   int             payload_size;
 383   gras_msgtype_t  msgtype;
 384
 385   gras_msg_procdata_t pd=(gras_msg_procdata_t)gras_libdata_get("gras_msg");
 386   gras_cblist_t  *list=NULL;
 387   gras_msg_cb_t       cb;
 388
 389   int timerexpected, timeouted;
 390   xbt_ex_t e;
 391
 392   VERB1("Handling message within the next %.2fs",timeOut);
 393
 394   untiltimer = gras_msg_timer_handle();
 395   DEBUG2("[%.0f] Next timer in %f sec", gras_os_time(), untiltimer);
 396   if (untiltimer == 0.0) {
 397      /* A timer was already elapsed and handled */
 398      return;
 399   }
 400   if (untiltimer != -1.0) {
 401      timerexpected = 1;
 402      timeOut = MIN(timeOut, untiltimer);
 403   } else {
 404      timerexpected = 0;
 405   }
 406
 407   /* get a message (from the queue or from the net) */
 408   timeouted = 0;
 409   if (xbt_dynar_length(pd->msg_queue)) {
 410     DEBUG0("Get a message from the queue");
 411     xbt_dynar_shift(pd->msg_queue,&msg);
 412     expeditor = msg.expeditor;
 413     msgtype   = msg.type;
 414     payload   = msg.payload;
 415   } else {
 416     TRY {
 417       expeditor = gras_trp_select(timeOut);
 418     } CATCH(e) {
 419       if (e.category != timeout_error)
 420         RETHROW;
 421       xbt_ex_free(e);
 422       timeouted = 1;
 423     }
 424
 425     if (!timeouted) {
 426       TRY {
 427         gras_msg_recv(expeditor, &msgtype, &payload, &payload_size);
 428       } CATCH(e) {
 429         RETHROW1("Error caught  while receiving a message on select()ed socket %p: %s",
 430                  expeditor);
 431       }
 432     }
 433   }
 434
 435   if (timeouted) {
 436      if (timerexpected) {
 437
 438         /* A timer elapsed before the arrival of any message even if we select()ed a bit */
 439         untiltimer = gras_msg_timer_handle();
 440         if (untiltimer == 0.0) {
 441           /* we served a timer, we're done */
 442           return;
 443         } else {
 444            xbt_assert1(untiltimer>0, "Negative timer (%f). I'm 'puzzeled'", untiltimer);
 445            WARN1("No timer elapsed, in contrary to expectations (next in %f sec)",
 446                   untiltimer);
 447            THROW1(timeout_error,0,
 448                   "No timer elapsed, in contrary to expectations (next in %f sec)",
 449                   untiltimer);
 450         }
 451
 452      } else {
 453         /* select timeouted, and no timer elapsed. Nothing to do */
 454        THROW0(timeout_error, 0, "No new message or timer");
 455      }
 456
 457   }
 458
 459   /* A message was already there or arrived in the meanwhile. handle it */
 460   xbt_dynar_foreach(pd->cbl_list,cpt,list) {
 461     if (list->id == msgtype->code) {
 462       break;
 463     } else {
 464       list=NULL;
 465     }
 466   }
 467   if (!list) {
 468     INFO1("No callback for the incomming '%s' message. Discarded.",
 469           msgtype->name);
 470     WARN0("FIXME: gras_datadesc_free not implemented => leaking the payload");
 471     return;
 472   }
 473
 474   xbt_dynar_foreach(list->cbs,cpt,cb) {
 475     VERB3("Use the callback #%d (@%p) for incomming msg %s",
 476           cpt+1,cb,msgtype->name);
 477     if ((*cb)(expeditor,payload)) {
 478       /* cb handled the message */
 479       free(payload);
 480       return;
 481     }
 482   }
 483
 484   /* FIXME: gras_datadesc_free not implemented => leaking the payload */
 485   THROW1(mismatch_error,0,
 486          "Message '%s' refused by all registered callbacks", msgtype->name);
 487 }
 488
 489 void
 490 gras_cbl_free(void *data){
 491   gras_cblist_t *list=*(void**)data;
 492   if (list) {
 493     xbt_dynar_free(&( list->cbs ));
 494     free(list);
 495   }
 496 }
 497
 498 /** \brief Bind the given callback to the given message type
 499  *
 500  * Several callbacks can be attached to a given message type. The lastly added one will get the message first, and
 501  * if it returns false, the message will be passed to the second one.
 502  * And so on until one of the callbacks accepts the message.
 503  */
 504 void
 505 gras_cb_register(gras_msgtype_t msgtype,
 506                  gras_msg_cb_t cb) {
 507   gras_msg_procdata_t pd=(gras_msg_procdata_t)gras_libdata_get("gras_msg");
 508   gras_cblist_t *list=NULL;
 509   int cpt;
 510
 511   DEBUG2("Register %p as callback to '%s'",cb,msgtype->name);
 512
 513   /* search the list of cb for this message on this host (creating if NULL) */
 514   xbt_dynar_foreach(pd->cbl_list,cpt,list) {
 515     if (list->id == msgtype->code) {
 516       break;
 517     } else {
 518       list=NULL;
 519     }
 520   }
 521   if (!list) {
 522     /* First cb? Create room */
 523     list = xbt_new(gras_cblist_t,1);
 524     list->id = msgtype->code;
 525     list->cbs = xbt_dynar_new(sizeof(gras_msg_cb_t), NULL);
 526     xbt_dynar_push(pd->cbl_list,&list);
 527   }
 528
 529   /* Insert the new one into the set */
 530   xbt_dynar_insert_at(list->cbs,0,&cb);
 531 }
 532
 533 /** \brief Unbind the given callback from the given message type */
 534 void
 535 gras_cb_unregister(gras_msgtype_t msgtype,
 536                    gras_msg_cb_t cb) {
 537
 538   gras_msg_procdata_t pd=(gras_msg_procdata_t)gras_libdata_get("gras_msg");
 539   gras_cblist_t *list;
 540   gras_msg_cb_t cb_cpt;
 541   int cpt;
 542   int found = 0;
 543
 544   /* search the list of cb for this message on this host */
 545   xbt_dynar_foreach(pd->cbl_list,cpt,list) {
 546     if (list->id == msgtype->code) {
 547       break;
 548     } else {
 549       list=NULL;
 550     }
 551   }
 552
 553   /* Remove it from the set */
 554   if (list) {
 555     xbt_dynar_foreach(list->cbs,cpt,cb_cpt) {
 556       if (cb == cb_cpt) {
 557         xbt_dynar_cursor_rm(list->cbs, &cpt);
 558         found = 1;
 559       }
 560     }
 561   }
 562   if (!found)
 563     VERB1("Ignoring removal of unexisting callback to msg id %d",
 564           msgtype->code);
 565 }