X-Git-Url: http://info.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/blobdiff_plain/710e2ad7303dce00b7a72feebdc2cec6823806b6..b893d47aef7fcd5e09374f7620f262ad3d9857a7:/src/gras/Msg/msg.c diff --git a/src/gras/Msg/msg.c b/src/gras/Msg/msg.c index 91c9937a9f..8ed2aefb1f 100644 --- a/src/gras/Msg/msg.c +++ b/src/gras/Msg/msg.c @@ -8,18 +8,24 @@ * under the terms of the license (GNU LGPL) which comes with this package. */ #include "xbt/ex.h" +#include "xbt/ex_interface.h" #include "gras/Msg/msg_private.h" #include "gras/Virtu/virtu_interface.h" #include "gras/DataDesc/datadesc_interface.h" #include "gras/Transport/transport_interface.h" /* gras_select */ +#include "portable.h" /* execinfo when available to propagate exceptions */ +#ifndef MIN #define MIN(a,b) ((a) < (b) ? (a) : (b)) +#endif XBT_LOG_NEW_DEFAULT_SUBCATEGORY(gras_msg,gras,"High level messaging"); xbt_set_t _gras_msgtype_set = NULL; static char *make_namev(const char *name, short int ver); char _GRAS_header[6]; +const char *e_gras_msg_kind_names[e_gras_msg_kind_count]= + {"UNKNOWN","ONEWAY","RPC call","RPC answer","RPC error"}; /* * Creating procdata for this module @@ -27,6 +33,8 @@ char _GRAS_header[6]; static void *gras_msg_procdata_new() { gras_msg_procdata_t res = xbt_new(s_gras_msg_procdata_t,1); + res->name = xbt_strdup("gras_msg"); + res->name_len = 0; res->msg_queue = xbt_dynar_new(sizeof(s_gras_msg_t), NULL); res->cbl_list = xbt_dynar_new(sizeof(gras_cblist_t *),gras_cbl_free); res->timers = xbt_dynar_new(sizeof(s_gras_timer_t), NULL); @@ -43,15 +51,17 @@ static void gras_msg_procdata_free(void *data) { xbt_dynar_free(&( res->msg_queue )); xbt_dynar_free(&( res->cbl_list )); xbt_dynar_free(&( res->timers )); - + + free(res->name); free(res); } /* * Module registration */ +int gras_msg_libdata_id; void gras_msg_register() { - gras_procdata_add("gras_msg",gras_msg_procdata_new, gras_msg_procdata_free); + gras_msg_libdata_id = gras_procdata_add("gras_msg",gras_msg_procdata_new, gras_msg_procdata_free); } /* @@ -111,36 +121,17 @@ static char *make_namev(const char *name, short int ver) { return namev; } -/** @brief declare a new message type of the given name. It only accepts the given datadesc as payload - * - * @param name: name as it should be used for logging messages (must be uniq) - * @param payload: datadescription of the payload - */ -void gras_msgtype_declare(const char *name, - gras_datadesc_type_t payload) { - gras_msgtype_declare_v(name, 0, payload); -} +/* Internal function doing the crude work of registering messages */ +void +gras_msgtype_declare_ext(const char *name, + short int version, + e_gras_msg_kind_t kind, + gras_datadesc_type_t payload_request, + gras_datadesc_type_t payload_answer) { -/** @brief declare a new versionned message type of the given name and payload - * - * @param name: name as it should be used for logging messages (must be uniq) - * @param version: something like versionning symbol - * @param payload: datadescription of the payload - * - * Registers a message to the GRAS mechanism. Use this version instead of - * gras_msgtype_declare when you change the semantic or syntax of a message and - * want your programs to be able to deal with both versions. Internally, each - * will be handled as an independent message type, so you can register - * differents for each of them. - */ -void -gras_msgtype_declare_v(const char *name, - short int version, - gras_datadesc_type_t payload) { - - gras_msgtype_t msgtype; + gras_msgtype_t msgtype=NULL; char *namev=make_namev(name,version); - int found = 0; + volatile int found = 0; xbt_ex_t e; TRY { @@ -153,30 +144,76 @@ gras_msgtype_declare_v(const char *name, } if (found) { - VERB2("Re-register version %d of message '%s' (same payload, ignored).", + VERB2("Re-register version %d of message '%s' (same kind & payload, ignored).", version, name); - xbt_assert3(!gras_datadesc_type_cmp(msgtype->ctn_type, payload), + xbt_assert3(msgtype->kind == kind, + "Message %s re-registered as a %s (it was known as a %s)", + namev,e_gras_msg_kind_names[kind],e_gras_msg_kind_names[msgtype->kind]); + xbt_assert3(!gras_datadesc_type_cmp(msgtype->ctn_type, payload_request), "Message %s re-registred with another payload (%s was %s)", - namev,gras_datadesc_get_name(payload), + namev,gras_datadesc_get_name(payload_request), gras_datadesc_get_name(msgtype->ctn_type)); + xbt_assert3(!gras_datadesc_type_cmp(msgtype->answer_type, payload_answer), + "Message %s re-registred with another answer payload (%s was %s)", + namev,gras_datadesc_get_name(payload_answer), + gras_datadesc_get_name(msgtype->answer_type)); + return ; /* do really ignore it */ } - VERB3("Register version %d of message '%s' (payload: %s).", - version, name, gras_datadesc_get_name(payload)); + VERB4("Register version %d of message '%s' " + "(payload: %s; answer payload: %s).", + version, name, gras_datadesc_get_name(payload_request), + gras_datadesc_get_name(payload_answer)); msgtype = xbt_new(s_gras_msgtype_t,1); msgtype->name = (namev == name ? strdup(name) : namev); msgtype->name_len = strlen(namev); msgtype->version = version; - msgtype->ctn_type = payload; + msgtype->kind = kind; + msgtype->ctn_type = payload_request; + msgtype->answer_type = payload_answer; xbt_set_add(_gras_msgtype_set, (xbt_set_elm_t)msgtype, &gras_msgtype_free); } + +/** @brief declare a new message type of the given name. It only accepts the given datadesc as payload + * + * @param name: name as it should be used for logging messages (must be uniq) + * @param payload: datadescription of the payload + */ +void gras_msgtype_declare(const char *name, + gras_datadesc_type_t payload) { + gras_msgtype_declare_ext(name, 0, e_gras_msg_kind_oneway, payload, NULL); +} + + + +/** @brief declare a new versionned message type of the given name and payload + * + * @param name: name as it should be used for logging messages (must be uniq) + * @param version: something like versionning symbol + * @param payload: datadescription of the payload + * + * Registers a message to the GRAS mechanism. Use this version instead of + * gras_msgtype_declare when you change the semantic or syntax of a message and + * want your programs to be able to deal with both versions. Internally, each + * will be handled as an independent message type, so you can register + * differents for each of them. + */ +void +gras_msgtype_declare_v(const char *name, + short int version, + gras_datadesc_type_t payload) { + + gras_msgtype_declare_ext(name, version, + e_gras_msg_kind_oneway, payload, NULL); +} + /** @brief retrive an existing message type from its name. */ gras_msgtype_t gras_msgtype_by_name (const char *name) { return gras_msgtype_by_namev(name,0); @@ -185,10 +222,16 @@ gras_msgtype_t gras_msgtype_by_name (const char *name) { /** @brief retrive an existing message type from its name and version. */ gras_msgtype_t gras_msgtype_by_namev(const char *name, short int version) { - gras_msgtype_t res; + gras_msgtype_t res = NULL; char *namev = make_namev(name,version); + xbt_ex_t e; - res = (gras_msgtype_t)xbt_set_get_by_name(_gras_msgtype_set, namev); + TRY { + res = (gras_msgtype_t)xbt_set_get_by_name(_gras_msgtype_set, namev); + } CATCH(e) { + xbt_ex_free(e); + THROW1(not_found_error,0,"No registred message of that name: %s",name); + } if (name != namev) free(namev); @@ -202,43 +245,45 @@ gras_msgtype_t gras_msgtype_by_id(int id) { /** \brief Waits for a message to come in over a given socket. * * @param timeout: How long should we wait for this message. - * @param msgt_want: type of awaited msg - * @param[out] expeditor: where to create a socket to answer the incomming message - * @param[out] payload: where to write the payload of the incomming message - * @return the error code (or no_error). + * @param msgt_want: type of awaited msg (or NULL if I'm enclined to accept any message) + * @param expe_want: awaited expeditot (match on hostname, not port; NULL if not relevant) + * @param filter: function returning true or false when passed a payload. Messages for which it returns false are not selected. (NULL if not relevant) + * @param filter_ctx: context passed as second argument of the filter (a pattern to match?) + * @param[out] msg_got: where to write the message we got * * Every message of another type received before the one waited will be queued * and used by subsequent call to this function or gras_msg_handle(). */ + void -gras_msg_wait(double timeout, - gras_msgtype_t msgt_want, - gras_socket_t *expeditor, - void *payload) { +gras_msg_wait_ext(double timeout, + + gras_msgtype_t msgt_want, + gras_socket_t expe_want, + gras_msg_filter_t filter, + void *filter_ctx, - gras_msgtype_t msgt_got; - void *payload_got; - int payload_size_got; + gras_msg_t msg_got) { + + s_gras_msg_t msg; double start, now; - gras_msg_procdata_t pd=(gras_msg_procdata_t)gras_libdata_get("gras_msg"); + gras_msg_procdata_t pd=(gras_msg_procdata_t)gras_libdata_by_id(gras_msg_libdata_id); int cpt; - s_gras_msg_t msg; - gras_socket_t expeditor_res = NULL; - - payload_got = NULL; xbt_assert0(msgt_want,"Cannot wait for the NULL message"); + xbt_assert0(msg_got,"msg_got is an output parameter"); VERB1("Waiting for message '%s'",msgt_want->name); start = now = gras_os_time(); xbt_dynar_foreach(pd->msg_queue,cpt,msg){ - if (msg.type->code == msgt_want->code) { - if (expeditor) - *expeditor = msg.expeditor; - memcpy(payload, msg.payload, msg.payload_size); - free(msg.payload); + if ( ( !msgt_want || (msg.type->code == msgt_want->code)) + && (!expe_want || (!strcmp( gras_socket_peer_name(msg.expe), + gras_socket_peer_name(expe_want)))) + && (!filter || filter(&msg,filter_ctx))) { + + memcpy(msg_got,&msg,sizeof(s_gras_msg_t)); xbt_dynar_cursor_rm(pd->msg_queue, &cpt); VERB0("The waited message was queued"); return; @@ -246,26 +291,28 @@ gras_msg_wait(double timeout, } while (1) { - expeditor_res = gras_trp_select(timeout - now + start); - gras_msg_recv(expeditor_res, &msgt_got, &payload_got, &payload_size_got); - if (msgt_got->code == msgt_want->code) { - if (expeditor) - *expeditor=expeditor_res; - memcpy(payload, payload_got, payload_size_got); - free(payload_got); - VERB0("Got waited message"); + memset(&msg,sizeof(msg),0); + + msg.expe = gras_trp_select(timeout ? timeout - now + start : 0); + gras_msg_recv(msg.expe, &msg); + DEBUG0("Got a message from the socket"); + + if ( ( !msgt_want || (msg.type->code == msgt_want->code)) + && (!expe_want || (!strcmp( gras_socket_peer_name(msg.expe), + gras_socket_peer_name(expe_want)))) + && (!filter || filter(&msg,filter_ctx))) { + + memcpy(msg_got,&msg,sizeof(s_gras_msg_t)); + DEBUG0("Message matches expectations. Use it."); return; } + DEBUG0("Message does not match expectations. Queue it."); /* not expected msg type. Queue it for later */ - msg.expeditor = expeditor_res; - msg.type = msgt_got; - msg.payload = payload; - msg.payload_size = payload_size_got; xbt_dynar_push(pd->msg_queue,&msg); now=gras_os_time(); - if (now - start + 0.001 < timeout) { + if (now - start + 0.001 > timeout) { THROW1(timeout_error, now-start+0.001-timeout, "Timeout while waiting for msg %s",msgt_want->name); } @@ -273,30 +320,95 @@ gras_msg_wait(double timeout, THROW_IMPOSSIBLE; } +/** \brief Waits for a message to come in over a given socket. + * + * @param timeout: How long should we wait for this message. + * @param msgt_want: type of awaited msg + * @param[out] expeditor: where to create a socket to answer the incomming message + * @param[out] payload: where to write the payload of the incomming message + * @return the error code (or no_error). + * + * Every message of another type received before the one waited will be queued + * and used by subsequent call to this function or gras_msg_handle(). + */ +void +gras_msg_wait(double timeout, + gras_msgtype_t msgt_want, + gras_socket_t *expeditor, + void *payload) { + s_gras_msg_t msg; + + gras_msg_wait_ext(timeout, + msgt_want, NULL, NULL, NULL, + &msg); + + if (payload) { + memcpy(payload,msg.payl,msg.payl_size); + free(msg.payl); + } + + if (expeditor) + *expeditor = msg.expe; +} + +/** \brief Send the data pointed by \a payload as a message of type + * \a msgtype to the peer \a sock */ +void +gras_msg_send(gras_socket_t sock, + gras_msgtype_t msgtype, + void *payload) { + + gras_msg_send_ext(sock, e_gras_msg_kind_oneway,0, msgtype, payload); +} + +/** @brief Handle all messages arriving within the given period + * + * @param timeOut: How long to wait for incoming messages (in seconds) + * @return the error code (or no_error). + * + * Messages are dealed with just like gras_msg_handle() would do. The + * difference is that gras_msg_handle() handles at most one message (or wait up + * to timeout second when no message arrives) while this function handles any + * amount of messages, and lasts the given period in any case. + */ +void +gras_msg_handleall(double period) { + xbt_ex_t e; + double begin=gras_os_time(); + double now; + + do { + now=gras_os_time(); + TRY{ + gras_msg_handle(period - now + begin); + } CATCH(e) { + if (e.category != timeout_error) + RETHROW0("Error while waiting for messages: %s"); + xbt_ex_free(e); + } + } while (now - begin < period); +} /** @brief Handle an incomming message or timer (or wait up to \a timeOut seconds) * * @param timeOut: How long to wait for incoming messages (in seconds) * @return the error code (or no_error). * - * Messages are passed to the callbacks. + * Messages are passed to the callbacks. See also gras_msg_handleall(). */ void gras_msg_handle(double timeOut) { double untiltimer; - int cpt; + int cpt, ran_ok; s_gras_msg_t msg; - gras_socket_t expeditor; - void *payload=NULL; - int payload_size; - gras_msgtype_t msgtype; - gras_msg_procdata_t pd=(gras_msg_procdata_t)gras_libdata_get("gras_msg"); + gras_msg_procdata_t pd=(gras_msg_procdata_t)gras_libdata_by_id(gras_msg_libdata_id); gras_cblist_t *list=NULL; gras_msg_cb_t cb; + s_gras_msg_cb_ctx_t ctx; int timerexpected, timeouted; xbt_ex_t e; @@ -304,7 +416,7 @@ gras_msg_handle(double timeOut) { VERB1("Handling message within the next %.2fs",timeOut); untiltimer = gras_msg_timer_handle(); - DEBUG2("[%.0f] Next timer in %f sec", gras_os_time(), untiltimer); + DEBUG1("Next timer in %f sec", untiltimer); if (untiltimer == 0.0) { /* A timer was already elapsed and handled */ return; @@ -321,12 +433,9 @@ gras_msg_handle(double timeOut) { if (xbt_dynar_length(pd->msg_queue)) { DEBUG0("Get a message from the queue"); xbt_dynar_shift(pd->msg_queue,&msg); - expeditor = msg.expeditor; - msgtype = msg.type; - payload = msg.payload; } else { TRY { - expeditor = gras_trp_select(timeOut); + msg.expe = gras_trp_select(timeOut); } CATCH(e) { if (e.category != timeout_error) RETHROW; @@ -336,10 +445,16 @@ gras_msg_handle(double timeOut) { if (!timeouted) { TRY { - gras_msg_recv(expeditor, &msgtype, &payload, &payload_size); + /* FIXME: if not the right kind, queue it and recall ourself or goto >:-) */ + gras_msg_recv(msg.expe, &msg); + DEBUG1("Received a msg from the socket kind:%s", + e_gras_msg_kind_names[msg.kind]); + } CATCH(e) { - RETHROW1("Error caught while receiving a message on select()ed socket %p: %s", - expeditor); + RETHROW4("Error while receiving a message on select()ed socket %p to [%s]%s:%d: %s", + msg.expe, + gras_socket_peer_proc(msg.expe),gras_socket_peer_name(msg.expe), + gras_socket_peer_port(msg.expe)); } } } @@ -363,14 +478,15 @@ gras_msg_handle(double timeOut) { } else { /* select timeouted, and no timer elapsed. Nothing to do */ - THROW0(timeout_error, 0, "No new message or timer"); + THROW1(timeout_error, 0, "No new message or timer (delay was %f)", + timeOut); } } /* A message was already there or arrived in the meanwhile. handle it */ xbt_dynar_foreach(pd->cbl_list,cpt,list) { - if (list->id == msgtype->code) { + if (list->id == msg.type->code) { break; } else { list=NULL; @@ -378,24 +494,74 @@ gras_msg_handle(double timeOut) { } if (!list) { INFO1("No callback for the incomming '%s' message. Discarded.", - msgtype->name); + msg.type->name); WARN0("FIXME: gras_datadesc_free not implemented => leaking the payload"); return; } - xbt_dynar_foreach(list->cbs,cpt,cb) { - VERB3("Use the callback #%d (@%p) for incomming msg %s", - cpt+1,cb,msgtype->name); - if ((*cb)(expeditor,payload)) { - /* cb handled the message */ - free(payload); - return; + ctx.expeditor = msg.expe; + ctx.ID = msg.ID; + ctx.msgtype = msg.type; + + switch (msg.kind) { + case e_gras_msg_kind_oneway: + case e_gras_msg_kind_rpccall: + ran_ok=0; + TRY { + xbt_dynar_foreach(list->cbs,cpt,cb) { + if (!ran_ok) { + VERB3("Use the callback #%d (@%p) for incomming msg %s", + cpt+1,cb,msg.type->name); + if ((*cb)(&ctx,msg.payl)) { + /* cb handled the message */ + free(msg.payl); + ran_ok = 1; + } + } + } + } CATCH(e) { + free(msg.payl); + if (msg.type->kind == e_gras_msg_kind_rpccall) { + /* The callback raised an exception, propagate it on the network */ + if (!e.remote) { /* the exception is born on this machine */ + e.host = (char*)gras_os_myname(); + xbt_ex_setup_backtrace(&e); + } + VERB4("Propagate %s exception from '%s' RPC cb back to %s:%d", + (e.remote ? "remote" : "local"), + msg.type->name, + gras_socket_peer_name(msg.expe), + gras_socket_peer_port(msg.expe)); + gras_msg_send_ext(msg.expe, e_gras_msg_kind_rpcerror, + msg.ID, msg.type, &e); + xbt_ex_free(e); + ran_ok=1; + } else { + RETHROW0("Callback raised an exception: %s"); + } } + if (!ran_ok) + THROW1(mismatch_error,0, + "Message '%s' refused by all registered callbacks", msg.type->name); + /* FIXME: gras_datadesc_free not implemented => leaking the payload */ + break; + + + case e_gras_msg_kind_rpcanswer: + INFO1("Unexpected RPC answer discarded (type: %s)", msg.type->name); + WARN0("FIXME: gras_datadesc_free not implemented => leaking the payload"); + return; + + case e_gras_msg_kind_rpcerror: + INFO1("Unexpected RPC error discarded (type: %s)", msg.type->name); + WARN0("FIXME: gras_datadesc_free not implemented => leaking the payload"); + return; + + default: + THROW1(unknown_error,0, + "Cannot handle messages of kind %d yet",msg.type->kind); } - /* FIXME: gras_datadesc_free not implemented => leaking the payload */ - THROW1(mismatch_error,0, - "Message '%s' refused by all registered callbacks", msgtype->name); } void @@ -416,7 +582,7 @@ gras_cbl_free(void *data){ void gras_cb_register(gras_msgtype_t msgtype, gras_msg_cb_t cb) { - gras_msg_procdata_t pd=(gras_msg_procdata_t)gras_libdata_get("gras_msg"); + gras_msg_procdata_t pd=(gras_msg_procdata_t)gras_libdata_by_id(gras_msg_libdata_id); gras_cblist_t *list=NULL; int cpt; @@ -447,7 +613,7 @@ void gras_cb_unregister(gras_msgtype_t msgtype, gras_msg_cb_t cb) { - gras_msg_procdata_t pd=(gras_msg_procdata_t)gras_libdata_get("gras_msg"); + gras_msg_procdata_t pd=(gras_msg_procdata_t)gras_libdata_by_id(gras_msg_libdata_id); gras_cblist_t *list; gras_msg_cb_t cb_cpt; int cpt; @@ -475,3 +641,8 @@ gras_cb_unregister(gras_msgtype_t msgtype, VERB1("Ignoring removal of unexisting callback to msg id %d", msgtype->code); } + +/** \brief Retrieve the expeditor of the message */ +gras_socket_t gras_msg_cb_ctx_from(gras_msg_cb_ctx_t ctx) { + return ctx->expeditor; +}