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->msg_waitqueue = xbt_dynar_new(sizeof(s_gras_msg_t), NULL);
40 res->cbl_list = xbt_dynar_new(sizeof(gras_cblist_t *),gras_cbl_free);
41 res->timers = xbt_dynar_new(sizeof(s_gras_timer_t), NULL);
42 res->msg_to_receive_queue = xbt_fifo_new();
48 * Freeing procdata for this module
50 static void gras_msg_procdata_free(void *data) {
51 gras_msg_procdata_t res = (gras_msg_procdata_t)data;
53 xbt_dynar_free(&( res->msg_queue ));
54 xbt_dynar_free(&( res->msg_waitqueue ));
55 xbt_dynar_free(&( res->cbl_list ));
56 xbt_dynar_free(&( res->timers ));
57 xbt_fifo_free( res->msg_to_receive_queue );
66 int gras_msg_libdata_id;
67 void gras_msg_register() {
68 gras_msg_libdata_id = gras_procdata_add("gras_msg",gras_msg_procdata_new, gras_msg_procdata_free);
72 * Initialize this submodule.
74 void gras_msg_init(void) {
75 /* only initialize once */
76 if (_gras_msgtype_set != NULL)
79 VERB0("Initializing Msg");
81 _gras_msgtype_set = xbt_set_new();
83 memcpy(_GRAS_header,"GRAS", 4);
84 _GRAS_header[4]=GRAS_PROTOCOL_VERSION;
85 _GRAS_header[5]=(char)GRAS_THISARCH;
87 gras_msg_ctx_mallocator =
88 xbt_mallocator_new(1000,
89 gras_msg_ctx_mallocator_new_f,
90 gras_msg_ctx_mallocator_free_f,
91 gras_msg_ctx_mallocator_reset_f);
95 * Finalize the msg module
100 xbt_set_free(&_gras_msgtype_set);
102 xbt_mallocator_free(gras_msg_ctx_mallocator);
108 void gras_msgtype_free(void *t) {
109 gras_msgtype_t msgtype=(gras_msgtype_t)t;
116 * Dump all declared message types (debugging purpose)
118 void gras_msgtype_dumpall(void) {
119 xbt_set_cursor_t cursor;
120 gras_msgtype_t msgtype=NULL;
122 INFO0("Dump of all registered messages:");
123 xbt_set_foreach(_gras_msgtype_set, cursor, msgtype) {
124 INFO6(" Message name: %s (v%d) %s; %s%s%s",
125 msgtype->name, msgtype->version, e_gras_msg_kind_names[msgtype->kind],
126 gras_datadesc_get_name(msgtype->ctn_type),
127 (msgtype->kind==e_gras_msg_kind_rpccall ? " -> ":""),
128 (msgtype->kind==e_gras_msg_kind_rpccall ? gras_datadesc_get_name(msgtype->answer_type) : ""));
136 * Returns the versionned name of the message. If the version is 0, that's
137 * the name unchanged. Pay attention to this before free'ing the result.
139 static char *make_namev(const char *name, short int ver) {
145 namev = (char*)xbt_malloc(strlen(name)+2+3+1);
148 sprintf(namev,"%s_v%d",name,ver);
153 /* Internal function doing the crude work of registering messages */
155 gras_msgtype_declare_ext(const char *name,
157 e_gras_msg_kind_t kind,
158 gras_datadesc_type_t payload_request,
159 gras_datadesc_type_t payload_answer) {
161 gras_msgtype_t msgtype=NULL;
162 char *namev=make_namev(name,version);
163 volatile int found = 0;
167 msgtype = (gras_msgtype_t)xbt_set_get_by_name(_gras_msgtype_set,namev);
170 if (e.category != not_found_error)
176 VERB2("Re-register version %d of message '%s' (same kind & payload, ignored).",
178 xbt_assert3(msgtype->kind == kind,
179 "Message %s re-registered as a %s (it was known as a %s)",
180 namev,e_gras_msg_kind_names[kind],e_gras_msg_kind_names[msgtype->kind]);
181 xbt_assert3(!gras_datadesc_type_cmp(msgtype->ctn_type, payload_request),
182 "Message %s re-registred with another payload (%s was %s)",
183 namev,gras_datadesc_get_name(payload_request),
184 gras_datadesc_get_name(msgtype->ctn_type));
186 xbt_assert3(!gras_datadesc_type_cmp(msgtype->answer_type, payload_answer),
187 "Message %s re-registred with another answer payload (%s was %s)",
188 namev,gras_datadesc_get_name(payload_answer),
189 gras_datadesc_get_name(msgtype->answer_type));
191 return ; /* do really ignore it */
195 VERB4("Register version %d of message '%s' "
196 "(payload: %s; answer payload: %s).",
197 version, name, gras_datadesc_get_name(payload_request),
198 gras_datadesc_get_name(payload_answer));
200 msgtype = xbt_new(s_gras_msgtype_t,1);
201 msgtype->name = (namev == name ? strdup(name) : namev);
202 msgtype->name_len = strlen(namev);
203 msgtype->version = version;
204 msgtype->kind = kind;
205 msgtype->ctn_type = payload_request;
206 msgtype->answer_type = payload_answer;
208 xbt_set_add(_gras_msgtype_set, (xbt_set_elm_t)msgtype,
213 /** @brief declare a new message type of the given name. It only accepts the given datadesc as payload
215 * @param name: name as it should be used for logging messages (must be uniq)
216 * @param payload: datadescription of the payload
218 void gras_msgtype_declare(const char *name,
219 gras_datadesc_type_t payload) {
220 gras_msgtype_declare_ext(name, 0, e_gras_msg_kind_oneway, payload, NULL);
225 /** @brief declare a new versionned message type of the given name and payload
227 * @param name: name as it should be used for logging messages (must be uniq)
228 * @param version: something like versionning symbol
229 * @param payload: datadescription of the payload
231 * Registers a message to the GRAS mechanism. Use this version instead of
232 * gras_msgtype_declare when you change the semantic or syntax of a message and
233 * want your programs to be able to deal with both versions. Internally, each
234 * will be handled as an independent message type, so you can register
235 * differents for each of them.
238 gras_msgtype_declare_v(const char *name,
240 gras_datadesc_type_t payload) {
242 gras_msgtype_declare_ext(name, version,
243 e_gras_msg_kind_oneway, payload, NULL);
246 /** @brief retrieve an existing message type from its name (raises an exception if it does not exist). */
247 gras_msgtype_t gras_msgtype_by_name (const char *name) {
248 return gras_msgtype_by_namev(name,0);
250 /** @brief retrieve an existing message type from its name (or NULL if it does not exist). */
251 gras_msgtype_t gras_msgtype_by_name_or_null (const char *name) {
253 gras_msgtype_t res = NULL;
256 res = gras_msgtype_by_namev(name,0);
264 /** @brief retrieve an existing message type from its name and version. */
265 gras_msgtype_t gras_msgtype_by_namev(const char *name,
267 gras_msgtype_t res = NULL;
268 char *namev = make_namev(name,version);
269 volatile int found=0;
273 res = (gras_msgtype_t)xbt_set_get_by_name(_gras_msgtype_set, namev);
279 THROW1(not_found_error,0,"No registred message of that name: %s",name);
286 /** @brief retrieve an existing message type from its name and version. */
287 gras_msgtype_t gras_msgtype_by_id(int id) {
288 return (gras_msgtype_t)xbt_set_get_by_id(_gras_msgtype_set, id);
291 /** \brief Waits for a message to come in over a given socket.
293 * @param timeout: How long should we wait for this message.
294 * @param msgt_want: type of awaited msg (or NULL if I'm enclined to accept any message)
295 * @param expe_want: awaited expeditot (match on hostname, not port; NULL if not relevant)
296 * @param filter: function returning true or false when passed a payload. Messages for which it returns false are not selected. (NULL if not relevant)
297 * @param filter_ctx: context passed as second argument of the filter (a pattern to match?)
298 * @param[out] msg_got: where to write the message we got
300 * Every message of another type received before the one waited will be queued
301 * and used by subsequent call to this function or gras_msg_handle().
305 gras_msg_wait_ext_(double timeout,
307 gras_msgtype_t msgt_want,
308 gras_socket_t expe_want,
309 gras_msg_filter_t filter,
312 gras_msg_t msg_got) {
316 gras_msg_procdata_t pd=(gras_msg_procdata_t)gras_libdata_by_id(gras_msg_libdata_id);
319 xbt_assert0(msg_got,"msg_got is an output parameter");
321 start = gras_os_time();
322 VERB1("Waiting for message '%s'",msgt_want?msgt_want->name:"(any)");
324 xbt_dynar_foreach(pd->msg_waitqueue,cpt,msg){
325 if ( ( !msgt_want || (msg.type->code == msgt_want->code))
326 && (!expe_want || (!strcmp( gras_socket_peer_name(msg.expe),
327 gras_socket_peer_name(expe_want))))
328 && (!filter || filter(&msg,filter_ctx))) {
330 memcpy(msg_got,&msg,sizeof(s_gras_msg_t));
331 xbt_dynar_cursor_rm(pd->msg_waitqueue, &cpt);
332 VERB0("The waited message was queued");
337 xbt_dynar_foreach(pd->msg_queue,cpt,msg){
338 if ( ( !msgt_want || (msg.type->code == msgt_want->code))
339 && (!expe_want || (!strcmp( gras_socket_peer_name(msg.expe),
340 gras_socket_peer_name(expe_want))))
341 && (!filter || filter(&msg,filter_ctx))) {
343 memcpy(msg_got,&msg,sizeof(s_gras_msg_t));
344 xbt_dynar_cursor_rm(pd->msg_queue, &cpt);
345 VERB0("The waited message was queued");
354 restart_receive: /* Goto here when the receive of a message failed */
357 memset(&msg,sizeof(msg),0);
360 msg.expe = gras_trp_select(timeout ? timeout - now + start : 0);
361 gras_msg_recv(msg.expe, &msg);
363 if (e.category == system_error &&
364 !strncmp("Socket closed by remote side",e.msg,
365 strlen("Socket closed by remote side"))) {
373 goto restart_receive;
375 DEBUG0("Got a message from the socket");
377 if ( ( !msgt_want || (msg.type->code == msgt_want->code))
378 && (!expe_want || (!strcmp( gras_socket_peer_name(msg.expe),
379 gras_socket_peer_name(expe_want))))
380 && (!filter || filter(&msg,filter_ctx))) {
382 memcpy(msg_got,&msg,sizeof(s_gras_msg_t));
383 DEBUG0("Message matches expectations. Use it.");
386 DEBUG0("Message does not match expectations. Queue it.");
388 /* not expected msg type. Queue it for later */
389 xbt_dynar_push(pd->msg_queue,&msg);
392 if (now - start + 0.001 > timeout) {
393 THROW1(timeout_error, now-start+0.001-timeout,
394 "Timeout while waiting for msg '%s'",
395 msgt_want?msgt_want->name:"(any)");
401 /** \brief Waits for a message to come in over a given socket.
403 * @param timeout: How long should we wait for this message.
404 * @param msgt_want: type of awaited msg
405 * @param[out] expeditor: where to create a socket to answer the incomming message
406 * @param[out] payload: where to write the payload of the incomming message
407 * @return the error code (or no_error).
409 * Every message of another type received before the one waited will be queued
410 * and used by subsequent call to this function or gras_msg_handle().
413 gras_msg_wait_(double timeout,
414 gras_msgtype_t msgt_want,
415 gras_socket_t *expeditor,
419 gras_msg_wait_ext_(timeout,
420 msgt_want, NULL, NULL, NULL,
423 if (msgt_want->ctn_type) {
425 "Message type '%s' convey a payload you must accept",
428 xbt_assert1(!payload,
429 "No payload was declared for message type '%s'",
434 memcpy(payload,msg.payl,msg.payl_size);
439 *expeditor = msg.expe;
442 static int gras_msg_wait_or_filter(gras_msg_t msg, void *ctx) {
443 xbt_dynar_t dyn=(xbt_dynar_t)ctx;
444 int res = xbt_dynar_member(dyn,msg->type);
446 VERB1("Got matching message (type=%s)",msg->type->name);
448 VERB0("Got message not matching our expectations");
451 /** \brief Waits for a message to come in over a given socket.
453 * @param timeout: How long should we wait for this message.
454 * @param msgt_want: a dynar containing all accepted message type
455 * @param[out] ctx: the context of received message (in case it's a RPC call we want to answer to)
456 * @param[out] msgt_got: indice in the dynar of the type of the received message
457 * @param[out] payload: where to write the payload of the incomming message
458 * @return the error code (or no_error).
460 * Every message of a type not in the accepted list received before the one
461 * waited will be queued and used by subsequent call to this function or
464 * If you are interested in the context, pass the address of a s_gras_msg_cb_ctx_t variable.
466 void gras_msg_wait_or(double timeout,
467 xbt_dynar_t msgt_want,
468 gras_msg_cb_ctx_t *ctx,
473 VERB1("Wait %f seconds for several message types",timeout);
474 gras_msg_wait_ext_(timeout,
476 &gras_msg_wait_or_filter, (void*)msgt_want,
479 if (msg.type->ctn_type) {
481 "Message type '%s' convey a payload you must accept",
483 } /* don't check the other side since some of the types may have a payload */
485 if (payload && msg.type->ctn_type) {
486 memcpy(payload,msg.payl,msg.payl_size);
491 *ctx=gras_msg_cb_ctx_new(msg.expe, msg.type, msg.ID,
492 (msg.kind == e_gras_msg_kind_rpccall), 60);
495 *msgt_got = xbt_dynar_search(msgt_want,msg.type);
499 /** \brief Send the data pointed by \a payload as a message of type
500 * \a msgtype to the peer \a sock */
502 gras_msg_send_(gras_socket_t sock,
503 gras_msgtype_t msgtype,
506 if (msgtype->ctn_type) {
508 "Message type '%s' convey a payload you must provide",
511 xbt_assert1(!payload,
512 "No payload was declared for message type '%s'",
516 DEBUG2("Send a oneway message of type '%s'. Payload=%p",
517 msgtype->name,payload);
518 gras_msg_send_ext(sock, e_gras_msg_kind_oneway,0, msgtype, payload);
519 VERB2("Sent a oneway message of type '%s'. Payload=%p",
520 msgtype->name,payload);
523 /** @brief Handle all messages arriving within the given period
525 * @param period: How long to wait for incoming messages (in seconds)
527 * Messages are dealed with just like gras_msg_handle() would do. The
528 * difference is that gras_msg_handle() handles at most one message (or wait up
529 * to timeout second when no message arrives) while this function handles any
530 * amount of messages, and lasts the given period in any case.
533 gras_msg_handleall(double period) {
535 double begin=gras_os_time();
541 if (period - now + begin > 0)
542 gras_msg_handle(period - now + begin);
544 if (e.category != timeout_error)
545 RETHROW0("Error while waiting for messages: %s");
548 } while (now - begin < period);
551 /** @brief Handle an incomming message or timer (or wait up to \a timeOut seconds)
553 * @param timeOut: How long to wait for incoming messages (in seconds)
554 * @return the error code (or no_error).
556 * Messages are passed to the callbacks. See also gras_msg_handleall().
559 gras_msg_handle(double timeOut) {
568 gras_msg_procdata_t pd=(gras_msg_procdata_t)gras_libdata_by_id(gras_msg_libdata_id);
569 gras_cblist_t *list=NULL;
571 s_gras_msg_cb_ctx_t ctx;
573 int timerexpected, timeouted;
576 VERB1("Handling message within the next %.2fs",timeOut);
578 untiltimer = gras_msg_timer_handle();
579 DEBUG1("Next timer in %f sec", untiltimer);
580 if (untiltimer == 0.0) {
581 /* A timer was already elapsed and handled */
584 if (untiltimer != -1.0) {
586 timeOut = MIN(timeOut, untiltimer);
591 /* get a message (from the queue or from the net) */
593 if (xbt_dynar_length(pd->msg_queue)) {
594 DEBUG0("Get a message from the queue");
595 xbt_dynar_shift(pd->msg_queue,&msg);
598 msg.expe = gras_trp_select(timeOut);
600 if (e.category != timeout_error)
608 /* FIXME: if not the right kind, queue it and recall ourself or goto >:-) */
609 gras_msg_recv(msg.expe, &msg);
610 DEBUG1("Received a msg from the socket kind:%s",
611 e_gras_msg_kind_names[msg.kind]);
614 RETHROW4("Error while receiving a message on select()ed socket %p to [%s]%s:%d: %s",
616 gras_socket_peer_proc(msg.expe),gras_socket_peer_name(msg.expe),
617 gras_socket_peer_port(msg.expe));
625 /* A timer elapsed before the arrival of any message even if we select()ed a bit */
626 untiltimer = gras_msg_timer_handle();
627 if (untiltimer == 0.0) {
628 /* we served a timer, we're done */
631 xbt_assert1(untiltimer>0, "Negative timer (%f). I'm 'puzzeled'", untiltimer);
632 WARN1("No timer elapsed, in contrary to expectations (next in %f sec)",
634 THROW1(timeout_error,0,
635 "No timer elapsed, in contrary to expectations (next in %f sec)",
640 /* select timeouted, and no timer elapsed. Nothing to do */
641 THROW1(timeout_error, 0, "No new message or timer (delay was %f)",
647 /* A message was already there or arrived in the meanwhile. handle it */
648 xbt_dynar_foreach(pd->cbl_list,cpt,list) {
649 if (list->id == msg.type->code) {
656 INFO3("No callback for message '%s' from %s:%d. Queue it for later gras_msg_wait() use.",
658 gras_socket_peer_name(msg.expe),gras_socket_peer_port(msg.expe));
659 xbt_dynar_push(pd->msg_waitqueue,&msg);
660 return; /* FIXME: maybe we should call ourselves again until the end of the timer or a proper msg is got */
663 ctx.expeditor = msg.expe;
665 ctx.msgtype = msg.type;
666 ctx.answer_due = (msg.kind == e_gras_msg_kind_rpccall);
669 case e_gras_msg_kind_oneway:
670 case e_gras_msg_kind_rpccall:
673 xbt_dynar_foreach(list->cbs,cpt,cb) {
675 DEBUG4("Use the callback #%d (@%p) for incomming msg %s (payload_size=%d)",
676 cpt+1,cb,msg.type->name,msg.payl_size);
677 if (!(*cb)(&ctx,msg.payl)) {
678 /* cb handled the message */
686 if (msg.type->kind == e_gras_msg_kind_rpccall) {
687 char *old_file=e.file;
688 /* The callback raised an exception, propagate it on the network */
690 /* Make sure we reduce the file name to its basename to avoid issues in tests */
691 char *new_file=strrchr(e.file,'/');
694 /* the exception is born on this machine */
695 e.host = (char*)gras_os_myname();
696 xbt_ex_setup_backtrace(&e);
698 VERB5("Propagate %s exception ('%s') from '%s' RPC cb back to %s:%d",
699 (e.remote ? "remote" : "local"),
702 gras_socket_peer_name(msg.expe),
703 gras_socket_peer_port(msg.expe));
704 gras_msg_send_ext(msg.expe, e_gras_msg_kind_rpcerror,
705 msg.ID, msg.type, &e);
711 RETHROW0("Callback raised an exception: %s");
714 xbt_assert0(!(ctx.answer_due),
715 "RPC callback didn't call gras_msg_rpcreturn");
718 THROW1(mismatch_error,0,
719 "Message '%s' refused by all registered callbacks", msg.type->name);
720 /* FIXME: gras_datadesc_free not implemented => leaking the payload */
724 case e_gras_msg_kind_rpcanswer:
725 INFO1("Unexpected RPC answer discarded (type: %s)", msg.type->name);
726 WARN0("FIXME: gras_datadesc_free not implemented => leaking the payload");
729 case e_gras_msg_kind_rpcerror:
730 INFO1("Unexpected RPC error discarded (type: %s)", msg.type->name);
731 WARN0("FIXME: gras_datadesc_free not implemented => leaking the payload");
735 THROW1(unknown_error,0,
736 "Cannot handle messages of kind %d yet",msg.type->kind);
742 gras_cbl_free(void *data){
743 gras_cblist_t *list=*(void**)data;
745 xbt_dynar_free(&( list->cbs ));
750 /** \brief Bind the given callback to the given message type
752 * Several callbacks can be attached to a given message type. The lastly added one will get the message first, and
753 * if it returns a non-null value, the message will be passed to the second one.
754 * And so on until one of the callbacks accepts the message.
757 gras_cb_register_(gras_msgtype_t msgtype,
759 gras_msg_procdata_t pd=(gras_msg_procdata_t)gras_libdata_by_id(gras_msg_libdata_id);
760 gras_cblist_t *list=NULL;
763 DEBUG2("Register %p as callback to '%s'",cb,msgtype->name);
765 /* search the list of cb for this message on this host (creating if NULL) */
766 xbt_dynar_foreach(pd->cbl_list,cpt,list) {
767 if (list->id == msgtype->code) {
774 /* First cb? Create room */
775 list = xbt_new(gras_cblist_t,1);
776 list->id = msgtype->code;
777 list->cbs = xbt_dynar_new(sizeof(gras_msg_cb_t), NULL);
778 xbt_dynar_push(pd->cbl_list,&list);
781 /* Insert the new one into the set */
782 xbt_dynar_insert_at(list->cbs,0,&cb);
785 /** \brief Unbind the given callback from the given message type */
787 gras_cb_unregister_(gras_msgtype_t msgtype,
790 gras_msg_procdata_t pd=(gras_msg_procdata_t)gras_libdata_by_id(gras_msg_libdata_id);
792 gras_msg_cb_t cb_cpt;
796 /* search the list of cb for this message on this host */
797 xbt_dynar_foreach(pd->cbl_list,cpt,list) {
798 if (list->id == msgtype->code) {
805 /* Remove it from the set */
807 xbt_dynar_foreach(list->cbs,cpt,cb_cpt) {
809 xbt_dynar_cursor_rm(list->cbs, &cpt);
815 VERB1("Ignoring removal of unexisting callback to msg id %d",
819 /** \brief Retrieve the expeditor of the message */
820 gras_socket_t gras_msg_cb_ctx_from(gras_msg_cb_ctx_t ctx) {
821 return ctx->expeditor;
823 /* \brief Creates a new message exchange context (user should never have to) */
824 gras_msg_cb_ctx_t gras_msg_cb_ctx_new(gras_socket_t expe,
825 gras_msgtype_t msgtype,
826 unsigned long int ID,
829 gras_msg_cb_ctx_t res=xbt_new(s_gras_msg_cb_ctx_t,1);
830 res->expeditor = expe;
831 res->msgtype = msgtype;
833 res->timeout = timeout;
834 res->answer_due = answer_due;
838 /* \brief Frees a message exchange context
840 * This function is mainly useful with \ref gras_msg_wait_or, ie seldom.
842 void gras_msg_cb_ctx_free(gras_msg_cb_ctx_t ctx) {