3 /* messaging - Function related to messaging (code shared between RL and SG)*/
5 /* Copyright (c) 2003, 2004 Martin Quinson. All rights reserved. */
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. */
11 #include "xbt/ex_interface.h"
12 #include "gras/Msg/msg_private.h"
13 #include "gras/Virtu/virtu_interface.h"
14 #include "gras/DataDesc/datadesc_interface.h"
15 #include "gras/Transport/transport_interface.h" /* gras_select */
16 #include "portable.h" /* execinfo when available to propagate exceptions */
19 #define MIN(a,b) ((a) < (b) ? (a) : (b))
22 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(gras_msg,gras,"High level messaging");
24 xbt_set_t _gras_msgtype_set = NULL;
25 static char *make_namev(const char *name, short int ver);
27 const char *e_gras_msg_kind_names[e_gras_msg_kind_count]=
28 {"UNKNOWN","ONEWAY","RPC call","RPC answer","RPC error"};
31 * Creating procdata for this module
33 static void *gras_msg_procdata_new() {
34 gras_msg_procdata_t res = xbt_new(s_gras_msg_procdata_t,1);
36 res->name = xbt_strdup("gras_msg");
38 res->msg_queue = xbt_dynar_new(sizeof(s_gras_msg_t), NULL);
39 res->cbl_list = xbt_dynar_new(sizeof(gras_cblist_t *),gras_cbl_free);
40 res->timers = xbt_dynar_new(sizeof(s_gras_timer_t), NULL);
46 * Freeing procdata for this module
48 static void gras_msg_procdata_free(void *data) {
49 gras_msg_procdata_t res = (gras_msg_procdata_t)data;
51 xbt_dynar_free(&( res->msg_queue ));
52 xbt_dynar_free(&( res->cbl_list ));
53 xbt_dynar_free(&( res->timers ));
62 int gras_msg_libdata_id;
63 void gras_msg_register() {
64 gras_msg_libdata_id = gras_procdata_add("gras_msg",gras_msg_procdata_new, gras_msg_procdata_free);
68 * Initialize this submodule.
70 void gras_msg_init(void) {
71 /* only initialize once */
72 if (_gras_msgtype_set != NULL)
75 VERB0("Initializing Msg");
77 _gras_msgtype_set = xbt_set_new();
79 memcpy(_GRAS_header,"GRAS", 4);
80 _GRAS_header[4]=GRAS_PROTOCOL_VERSION;
81 _GRAS_header[5]=(char)GRAS_THISARCH;
85 * Finalize the msg module
90 xbt_set_free(&_gras_msgtype_set);
96 void gras_msgtype_free(void *t) {
97 gras_msgtype_t msgtype=(gras_msgtype_t)t;
107 * Returns the versionned name of the message. If the version is 0, that's
108 * the name unchanged. Pay attention to this before free'ing the result.
110 static char *make_namev(const char *name, short int ver) {
116 namev = (char*)xbt_malloc(strlen(name)+2+3+1);
119 sprintf(namev,"%s_v%d",name,ver);
124 /* Internal function doing the crude work of registering messages */
126 gras_msgtype_declare_ext(const char *name,
128 e_gras_msg_kind_t kind,
129 gras_datadesc_type_t payload_request,
130 gras_datadesc_type_t payload_answer) {
132 gras_msgtype_t msgtype=NULL;
133 char *namev=make_namev(name,version);
134 volatile int found = 0;
138 msgtype = (gras_msgtype_t)xbt_set_get_by_name(_gras_msgtype_set,namev);
141 if (e.category != not_found_error)
147 VERB2("Re-register version %d of message '%s' (same kind & payload, ignored).",
149 xbt_assert3(msgtype->kind == kind,
150 "Message %s re-registered as a %s (it was known as a %s)",
151 namev,e_gras_msg_kind_names[kind],e_gras_msg_kind_names[msgtype->kind]);
152 xbt_assert3(!gras_datadesc_type_cmp(msgtype->ctn_type, payload_request),
153 "Message %s re-registred with another payload (%s was %s)",
154 namev,gras_datadesc_get_name(payload_request),
155 gras_datadesc_get_name(msgtype->ctn_type));
157 xbt_assert3(!gras_datadesc_type_cmp(msgtype->answer_type, payload_answer),
158 "Message %s re-registred with another answer payload (%s was %s)",
159 namev,gras_datadesc_get_name(payload_answer),
160 gras_datadesc_get_name(msgtype->answer_type));
162 return ; /* do really ignore it */
166 VERB4("Register version %d of message '%s' "
167 "(payload: %s; answer payload: %s).",
168 version, name, gras_datadesc_get_name(payload_request),
169 gras_datadesc_get_name(payload_answer));
171 msgtype = xbt_new(s_gras_msgtype_t,1);
172 msgtype->name = (namev == name ? strdup(name) : namev);
173 msgtype->name_len = strlen(namev);
174 msgtype->version = version;
175 msgtype->kind = kind;
176 msgtype->ctn_type = payload_request;
177 msgtype->answer_type = payload_answer;
179 xbt_set_add(_gras_msgtype_set, (xbt_set_elm_t)msgtype,
184 /** @brief declare a new message type of the given name. It only accepts the given datadesc as payload
186 * @param name: name as it should be used for logging messages (must be uniq)
187 * @param payload: datadescription of the payload
189 void gras_msgtype_declare(const char *name,
190 gras_datadesc_type_t payload) {
191 gras_msgtype_declare_ext(name, 0, e_gras_msg_kind_oneway, payload, NULL);
196 /** @brief declare a new versionned message type of the given name and payload
198 * @param name: name as it should be used for logging messages (must be uniq)
199 * @param version: something like versionning symbol
200 * @param payload: datadescription of the payload
202 * Registers a message to the GRAS mechanism. Use this version instead of
203 * gras_msgtype_declare when you change the semantic or syntax of a message and
204 * want your programs to be able to deal with both versions. Internally, each
205 * will be handled as an independent message type, so you can register
206 * differents for each of them.
209 gras_msgtype_declare_v(const char *name,
211 gras_datadesc_type_t payload) {
213 gras_msgtype_declare_ext(name, version,
214 e_gras_msg_kind_oneway, payload, NULL);
217 /** @brief retrieve an existing message type from its name. */
218 gras_msgtype_t gras_msgtype_by_name (const char *name) {
219 return gras_msgtype_by_namev(name,0);
222 /** @brief retrieve an existing message type from its name and version. */
223 gras_msgtype_t gras_msgtype_by_namev(const char *name,
225 gras_msgtype_t res = NULL;
226 char *namev = make_namev(name,version);
230 res = (gras_msgtype_t)xbt_set_get_by_name(_gras_msgtype_set, namev);
233 THROW1(not_found_error,0,"No registred message of that name: %s",name);
240 /** @brief retrieve an existing message type from its name and version. */
241 gras_msgtype_t gras_msgtype_by_id(int id) {
242 return (gras_msgtype_t)xbt_set_get_by_id(_gras_msgtype_set, id);
245 /** \brief Waits for a message to come in over a given socket.
247 * @param timeout: How long should we wait for this message.
248 * @param msgt_want: type of awaited msg (or NULL if I'm enclined to accept any message)
249 * @param expe_want: awaited expeditot (match on hostname, not port; NULL if not relevant)
250 * @param filter: function returning true or false when passed a payload. Messages for which it returns false are not selected. (NULL if not relevant)
251 * @param filter_ctx: context passed as second argument of the filter (a pattern to match?)
252 * @param[out] msg_got: where to write the message we got
254 * Every message of another type received before the one waited will be queued
255 * and used by subsequent call to this function or gras_msg_handle().
259 gras_msg_wait_ext(double timeout,
261 gras_msgtype_t msgt_want,
262 gras_socket_t expe_want,
263 gras_msg_filter_t filter,
266 gras_msg_t msg_got) {
270 gras_msg_procdata_t pd=(gras_msg_procdata_t)gras_libdata_by_id(gras_msg_libdata_id);
273 xbt_assert0(msg_got,"msg_got is an output parameter");
275 start = gras_os_time();
276 VERB1("Waiting for message '%s'",msgt_want?msgt_want->name:"(any)");
278 xbt_dynar_foreach(pd->msg_queue,cpt,msg){
279 if ( ( !msgt_want || (msg.type->code == msgt_want->code))
280 && (!expe_want || (!strcmp( gras_socket_peer_name(msg.expe),
281 gras_socket_peer_name(expe_want))))
282 && (!filter || filter(&msg,filter_ctx))) {
284 memcpy(msg_got,&msg,sizeof(s_gras_msg_t));
285 xbt_dynar_cursor_rm(pd->msg_queue, &cpt);
286 VERB0("The waited message was queued");
295 restart_receive: /* Goto here when the receive of a message failed */
298 memset(&msg,sizeof(msg),0);
301 msg.expe = gras_trp_select(timeout ? timeout - now + start : 0);
302 gras_msg_recv(msg.expe, &msg);
304 if (e.category == system_error &&
305 !strncmp("Socket closed by remote side",e.msg,
306 strlen("Socket closed by remote side"))) {
314 goto restart_receive;
316 DEBUG0("Got a message from the socket");
318 if ( ( !msgt_want || (msg.type->code == msgt_want->code))
319 && (!expe_want || (!strcmp( gras_socket_peer_name(msg.expe),
320 gras_socket_peer_name(expe_want))))
321 && (!filter || filter(&msg,filter_ctx))) {
323 memcpy(msg_got,&msg,sizeof(s_gras_msg_t));
324 DEBUG0("Message matches expectations. Use it.");
327 DEBUG0("Message does not match expectations. Queue it.");
329 /* not expected msg type. Queue it for later */
330 xbt_dynar_push(pd->msg_queue,&msg);
333 if (now - start + 0.001 > timeout) {
334 THROW1(timeout_error, now-start+0.001-timeout,
335 "Timeout while waiting for msg '%s'",
336 msgt_want?msgt_want->name:"(any)");
342 /** \brief Waits for a message to come in over a given socket.
344 * @param timeout: How long should we wait for this message.
345 * @param msgt_want: type of awaited msg
346 * @param[out] expeditor: where to create a socket to answer the incomming message
347 * @param[out] payload: where to write the payload of the incomming message
348 * @return the error code (or no_error).
350 * Every message of another type received before the one waited will be queued
351 * and used by subsequent call to this function or gras_msg_handle().
354 gras_msg_wait(double timeout,
355 gras_msgtype_t msgt_want,
356 gras_socket_t *expeditor,
360 gras_msg_wait_ext(timeout,
361 msgt_want, NULL, NULL, NULL,
364 if (msgt_want->ctn_type) {
366 "Message type '%s' convey a payload you must accept",
369 xbt_assert1(!payload,
370 "No payload was declared for message type '%s'",
375 memcpy(payload,msg.payl,msg.payl_size);
380 *expeditor = msg.expe;
383 static int gras_msg_wait_or_filter(gras_msg_t msg, void *ctx) {
384 xbt_dynar_t dyn=(xbt_dynar_t)ctx;
385 int res = xbt_dynar_member(dyn,msg->type);
387 VERB1("Got matching message (type=%s)",msg->type->name);
389 VERB0("Got message not matching our expectations");
392 /** \brief Waits for a message to come in over a given socket.
394 * @param timeout: How long should we wait for this message.
395 * @param msgt_want: a dynar containing all accepted message type
396 * @param[out] ctx: the context of received message (in case it's a RPC call we want to answer to)
397 * @param[out] msgt_got: indice in the dynar of the type of the received message
398 * @param[out] payload: where to write the payload of the incomming message
399 * @return the error code (or no_error).
401 * Every message of a type not in the accepted list received before the one
402 * waited will be queued and used by subsequent call to this function or
405 * If you are interested in the context, pass the address of a s_gras_msg_cb_ctx_t variable.
407 void gras_msg_wait_or(double timeout,
408 xbt_dynar_t msgt_want,
409 gras_msg_cb_ctx_t *ctx,
414 VERB1("Wait %f seconds for several message types",timeout);
415 gras_msg_wait_ext(timeout,
417 &gras_msg_wait_or_filter, (void*)msgt_want,
420 if (msg.type->ctn_type) {
422 "Message type '%s' convey a payload you must accept",
424 } /* don't check the other side since some of the types may have a payload */
426 if (payload && msg.type->ctn_type) {
427 memcpy(payload,msg.payl,msg.payl_size);
432 *ctx=gras_msg_cb_ctx_new(msg.expe,msg.type,msg.ID,60);
435 *msgt_got = xbt_dynar_search(msgt_want,msg.type);
439 /** \brief Send the data pointed by \a payload as a message of type
440 * \a msgtype to the peer \a sock */
442 gras_msg_send(gras_socket_t sock,
443 gras_msgtype_t msgtype,
446 if (msgtype->ctn_type) {
448 "Message type '%s' convey a payload you must provide",
451 xbt_assert1(!payload,
452 "No payload was declared for message type '%s'",
456 DEBUG2("Send a oneway message of type '%s'. Payload=%p",
457 msgtype->name,payload);
458 gras_msg_send_ext(sock, e_gras_msg_kind_oneway,0, msgtype, payload);
459 VERB2("Sent a oneway message of type '%s'. Payload=%p",
460 msgtype->name,payload);
463 /** @brief Handle all messages arriving within the given period
465 * @param period: How long to wait for incoming messages (in seconds)
467 * Messages are dealed with just like gras_msg_handle() would do. The
468 * difference is that gras_msg_handle() handles at most one message (or wait up
469 * to timeout second when no message arrives) while this function handles any
470 * amount of messages, and lasts the given period in any case.
473 gras_msg_handleall(double period) {
475 double begin=gras_os_time();
481 if (period - now + begin > 0)
482 gras_msg_handle(period - now + begin);
484 if (e.category != timeout_error)
485 RETHROW0("Error while waiting for messages: %s");
488 } while (now - begin < period);
491 /** @brief Handle an incomming message or timer (or wait up to \a timeOut seconds)
493 * @param timeOut: How long to wait for incoming messages (in seconds)
494 * @return the error code (or no_error).
496 * Messages are passed to the callbacks. See also gras_msg_handleall().
499 gras_msg_handle(double timeOut) {
508 gras_msg_procdata_t pd=(gras_msg_procdata_t)gras_libdata_by_id(gras_msg_libdata_id);
509 gras_cblist_t *list=NULL;
511 s_gras_msg_cb_ctx_t ctx;
513 int timerexpected, timeouted;
516 VERB1("Handling message within the next %.2fs",timeOut);
518 untiltimer = gras_msg_timer_handle();
519 DEBUG1("Next timer in %f sec", untiltimer);
520 if (untiltimer == 0.0) {
521 /* A timer was already elapsed and handled */
524 if (untiltimer != -1.0) {
526 timeOut = MIN(timeOut, untiltimer);
531 /* get a message (from the queue or from the net) */
533 if (xbt_dynar_length(pd->msg_queue)) {
534 DEBUG0("Get a message from the queue");
535 xbt_dynar_shift(pd->msg_queue,&msg);
538 msg.expe = gras_trp_select(timeOut);
540 if (e.category != timeout_error)
548 /* FIXME: if not the right kind, queue it and recall ourself or goto >:-) */
549 gras_msg_recv(msg.expe, &msg);
550 DEBUG1("Received a msg from the socket kind:%s",
551 e_gras_msg_kind_names[msg.kind]);
554 RETHROW4("Error while receiving a message on select()ed socket %p to [%s]%s:%d: %s",
556 gras_socket_peer_proc(msg.expe),gras_socket_peer_name(msg.expe),
557 gras_socket_peer_port(msg.expe));
565 /* A timer elapsed before the arrival of any message even if we select()ed a bit */
566 untiltimer = gras_msg_timer_handle();
567 if (untiltimer == 0.0) {
568 /* we served a timer, we're done */
571 xbt_assert1(untiltimer>0, "Negative timer (%f). I'm 'puzzeled'", untiltimer);
572 WARN1("No timer elapsed, in contrary to expectations (next in %f sec)",
574 THROW1(timeout_error,0,
575 "No timer elapsed, in contrary to expectations (next in %f sec)",
580 /* select timeouted, and no timer elapsed. Nothing to do */
581 THROW1(timeout_error, 0, "No new message or timer (delay was %f)",
587 /* A message was already there or arrived in the meanwhile. handle it */
588 xbt_dynar_foreach(pd->cbl_list,cpt,list) {
589 if (list->id == msg.type->code) {
596 INFO3("No callback for the incomming '%s' message (from %s:%d). Discarded.",
598 gras_socket_peer_name(msg.expe),gras_socket_peer_port(msg.expe));
599 WARN0("FIXME: gras_datadesc_free not implemented => leaking the payload");
603 ctx.expeditor = msg.expe;
605 ctx.msgtype = msg.type;
608 case e_gras_msg_kind_oneway:
609 case e_gras_msg_kind_rpccall:
612 xbt_dynar_foreach(list->cbs,cpt,cb) {
614 DEBUG4("Use the callback #%d (@%p) for incomming msg %s (payload_size=%d)",
615 cpt+1,cb,msg.type->name,msg.payl_size);
616 if ((*cb)(&ctx,msg.payl)) {
617 /* cb handled the message */
625 if (msg.type->kind == e_gras_msg_kind_rpccall) {
626 /* The callback raised an exception, propagate it on the network */
627 if (!e.remote) { /* the exception is born on this machine */
628 e.host = (char*)gras_os_myname();
629 xbt_ex_setup_backtrace(&e);
631 VERB5("Propagate %s exception ('%s') from '%s' RPC cb back to %s:%d",
632 (e.remote ? "remote" : "local"),
635 gras_socket_peer_name(msg.expe),
636 gras_socket_peer_port(msg.expe));
637 gras_msg_send_ext(msg.expe, e_gras_msg_kind_rpcerror,
638 msg.ID, msg.type, &e);
642 RETHROW0("Callback raised an exception: %s");
646 THROW1(mismatch_error,0,
647 "Message '%s' refused by all registered callbacks", msg.type->name);
648 /* FIXME: gras_datadesc_free not implemented => leaking the payload */
652 case e_gras_msg_kind_rpcanswer:
653 INFO1("Unexpected RPC answer discarded (type: %s)", msg.type->name);
654 WARN0("FIXME: gras_datadesc_free not implemented => leaking the payload");
657 case e_gras_msg_kind_rpcerror:
658 INFO1("Unexpected RPC error discarded (type: %s)", msg.type->name);
659 WARN0("FIXME: gras_datadesc_free not implemented => leaking the payload");
663 THROW1(unknown_error,0,
664 "Cannot handle messages of kind %d yet",msg.type->kind);
670 gras_cbl_free(void *data){
671 gras_cblist_t *list=*(void**)data;
673 xbt_dynar_free(&( list->cbs ));
678 /** \brief Bind the given callback to the given message type
680 * Several callbacks can be attached to a given message type. The lastly added one will get the message first, and
681 * if it returns false, the message will be passed to the second one.
682 * And so on until one of the callbacks accepts the message.
685 gras_cb_register(gras_msgtype_t msgtype,
687 gras_msg_procdata_t pd=(gras_msg_procdata_t)gras_libdata_by_id(gras_msg_libdata_id);
688 gras_cblist_t *list=NULL;
691 DEBUG2("Register %p as callback to '%s'",cb,msgtype->name);
693 /* search the list of cb for this message on this host (creating if NULL) */
694 xbt_dynar_foreach(pd->cbl_list,cpt,list) {
695 if (list->id == msgtype->code) {
702 /* First cb? Create room */
703 list = xbt_new(gras_cblist_t,1);
704 list->id = msgtype->code;
705 list->cbs = xbt_dynar_new(sizeof(gras_msg_cb_t), NULL);
706 xbt_dynar_push(pd->cbl_list,&list);
709 /* Insert the new one into the set */
710 xbt_dynar_insert_at(list->cbs,0,&cb);
713 /** \brief Unbind the given callback from the given message type */
715 gras_cb_unregister(gras_msgtype_t msgtype,
718 gras_msg_procdata_t pd=(gras_msg_procdata_t)gras_libdata_by_id(gras_msg_libdata_id);
720 gras_msg_cb_t cb_cpt;
724 /* search the list of cb for this message on this host */
725 xbt_dynar_foreach(pd->cbl_list,cpt,list) {
726 if (list->id == msgtype->code) {
733 /* Remove it from the set */
735 xbt_dynar_foreach(list->cbs,cpt,cb_cpt) {
737 xbt_dynar_cursor_rm(list->cbs, &cpt);
743 VERB1("Ignoring removal of unexisting callback to msg id %d",
747 /** \brief Retrieve the expeditor of the message */
748 gras_socket_t gras_msg_cb_ctx_from(gras_msg_cb_ctx_t ctx) {
749 return ctx->expeditor;
751 /* \brief Creates a new message exchange context (user should never have to) */
752 gras_msg_cb_ctx_t gras_msg_cb_ctx_new(gras_socket_t expe,
753 gras_msgtype_t msgtype,
754 unsigned long int ID,
756 gras_msg_cb_ctx_t res=xbt_new(s_gras_msg_cb_ctx_t,1);
757 res->expeditor = expe;
758 res->msgtype = msgtype;
760 res->timeout = timeout;
763 /* \brief Frees a message exchange context
765 * This function is mainly useful with \ref gras_msg_wait_or, ie seldom.
767 void gras_msg_cb_ctx_free(gras_msg_cb_ctx_t ctx) {