#include "gras/Transport/transport_interface.h" /* gras_trp_chunk_send/recv */
#include "gras/Virtu/virtu_interface.h"
+#define MIN(a,b) ((a) < (b) ? (a) : (b))
+
XBT_LOG_NEW_DEFAULT_SUBCATEGORY(gras_msg,gras,"High level messaging");
xbt_set_t _gras_msgtype_set = NULL;
static char GRAS_header[6];
static char *make_namev(const char *name, short int ver);
+/*
+ * Creating procdata for this module
+ */
+static void *gras_msg_procdata_new() {
+ gras_msg_procdata_t res = xbt_new(s_gras_msg_procdata_t,1);
+
+ 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);
+
+ return (void*)res;
+}
+
+/*
+ * Freeing procdata for this module
+ */
+static void gras_msg_procdata_free(void *data) {
+ gras_msg_procdata_t res = (gras_msg_procdata_t)data;
+
+ xbt_dynar_free(&( res->msg_queue ));
+ xbt_dynar_free(&( res->cbl_list ));
+ xbt_dynar_free(&( res->timers ));
+}
+
+/*
+ * Module registration
+ */
+void gras_msg_register() {
+ gras_procdata_add("gras_msg",gras_msg_procdata_new, gras_msg_procdata_free);
+}
+
/*
* Initialize this submodule.
*/
void gras_msgtype_free(void *t) {
gras_msgtype_t msgtype=(gras_msgtype_t)t;
if (msgtype) {
- xbt_free(msgtype->name);
- xbt_free(msgtype);
+ free(msgtype->name);
+ free(msgtype);
}
}
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
*/
gras_msgtype_declare_v(name, 0, payload);
}
-/**
+/** @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 mecanism. Use this version instead of
+ * 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
xbt_error_t errcode;
gras_msgtype_t msgtype;
char *namev=make_namev(name,version);
-
+
+ if (!payload)
+ WARN1("Message %s has NULL payload",name);
+
errcode = xbt_set_get_by_name(_gras_msgtype_set,
namev,(xbt_set_elm_t*)&msgtype);
&gras_msgtype_free);
}
-/*
- * Retrieve a msgtype description from its name
- */
+/** @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);
}
-/*
- * Retrieve a msgtype description from its name and version
- */
+
+/** @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;
if (!res)
WARN1("msgtype_by_name(%s) returns NULL",namev);
if (name != namev)
- xbt_free(namev);
+ free(namev);
return res;
}
-/*
- * Send the given message on the given socket
- */
+/** \brief Send the data pointed by \a payload as a message of type
+ * \a msgtype to the peer \a sock */
xbt_error_t
gras_msg_send(gras_socket_t sock,
gras_msgtype_t msgtype,
"Got error %s while retrieving the type associated to messages '%s'",
xbt_error_name(errcode),msg_name);
/* FIXME: Survive unknown messages */
- xbt_free(msg_name);
+ free(msg_name);
*payload_size=gras_datadesc_size((*msgtype)->ctn_type);
xbt_assert2(*payload_size > 0,
return no_error;
}
-/**
+/** \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
* @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 MsgHandle().
+ * and used by subsequent call to this function or gras_msg_handle().
*/
xbt_error_t
gras_msg_wait(double timeout,
int payload_size_got;
xbt_error_t errcode;
double start, now;
- gras_procdata_t *pd=gras_procdata_get();
+ gras_msg_procdata_t pd=(gras_msg_procdata_t)gras_libdata_get("gras_msg");
int cpt;
- gras_msg_t msg;
+ s_gras_msg_t msg;
*expeditor = NULL;
payload_got = NULL;
if (msg.type->code == msgt_want->code) {
*expeditor = msg.expeditor;
memcpy(payload, msg.payload, msg.payload_size);
- xbt_free(msg.payload);
+ free(msg.payload);
xbt_dynar_cursor_rm(pd->msg_queue, &cpt);
VERB0("The waited message was queued");
return no_error;
TRY(gras_msg_recv(*expeditor, &msgt_got, &payload_got, &payload_size_got));
if (msgt_got->code == msgt_want->code) {
memcpy(payload, payload_got, payload_size_got);
- xbt_free(payload_got);
+ free(payload_got);
VERB0("Got waited message");
return no_error;
}
RAISE_IMPOSSIBLE;
}
-/**
- * @param timeOut: How long to wait for incoming messages
+/** @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).
*
- * Waits up to \a timeOut seconds to see if a message comes in; if so, calls the
- * registered listener for that message (see \ref gras_cb_register()).
+ * Messages are passed to the callbacks.
*/
xbt_error_t
gras_msg_handle(double timeOut) {
+ double untiltimer;
+
xbt_error_t errcode;
int cpt;
- gras_msg_t msg;
+ s_gras_msg_t msg;
gras_socket_t expeditor;
void *payload=NULL;
int payload_size;
gras_msgtype_t msgtype;
- gras_procdata_t*pd=gras_procdata_get();
- gras_cblist_t *list;
- gras_cb_t cb;
-
-
+ gras_msg_procdata_t pd=(gras_msg_procdata_t)gras_libdata_get("gras_msg");
+ gras_cblist_t *list=NULL;
+ gras_msg_cb_t cb;
+
+ int timerexpected;
VERB1("Handling message within the next %.2fs",timeOut);
+ untiltimer = gras_msg_timer_handle();
+ DEBUG2("[%.0f] Next timer in %f sec", gras_os_time(), untiltimer);
+ if (untiltimer == 0.0) {
+ /* A timer was already elapsed and handled */
+ return no_error;
+ }
+ if (untiltimer != -1.0) {
+ timerexpected = 1;
+ timeOut = MIN(timeOut, untiltimer);
+ } else {
+ timerexpected = 0;
+ }
+
/* get a message (from the queue or from the net) */
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;
-
+ errcode = no_error;
} else {
- TRY(gras_trp_select(timeOut, &expeditor));
- TRY(gras_msg_recv(expeditor, &msgtype, &payload, &payload_size));
+ errcode = gras_trp_select(timeOut, &expeditor);
+ if (errcode != no_error && errcode != timeout_error)
+ return errcode;
+ if (errcode != timeout_error)
+ TRY(gras_msg_recv(expeditor, &msgtype, &payload, &payload_size));
}
-
- /* handle it */
+
+ if (errcode == timeout_error ) {
+ if (timerexpected) {
+
+ /* A timer elapsed before the arrival of any message even if we select()ed a bit */
+ untiltimer = gras_msg_timer_handle();
+ if (untiltimer == 0.0) {
+ return no_error;
+ } else {
+ xbt_assert1(untiltimer>0, "Negative timer (%f). I'm puzzeled", untiltimer);
+ ERROR1("No timer elapsed, in contrary to expectations (next in %f sec)",
+ untiltimer);
+ return timeout_error;
+ }
+
+ } else {
+ /* select timeouted, and no timer elapsed. Nothing to do */
+ return timeout_error;
+ }
+
+ }
+
+ /* 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) {
break;
}
xbt_dynar_foreach(list->cbs,cpt,cb) {
- INFO3("Use the callback #%d (@%p) for incomming msg %s",
- cpt+1,cb,msgtype->name);
+ VERB3("Use the callback #%d (@%p) for incomming msg %s",
+ cpt+1,cb,msgtype->name);
if ((*cb)(expeditor,payload)) {
/* cb handled the message */
- xbt_free(payload);
+ free(payload);
return no_error;
}
}
gras_cblist_t *list=*(void**)data;
if (list) {
xbt_dynar_free(&( list->cbs ));
- xbt_free(list);
+ free(list);
}
}
+/** \brief Bind the given callback to the given message type
+ *
+ * Several callbacks can be attached to a given message type. The lastly added one will get the message first, and
+ * if it returns false, the message will be passed to the second one.
+ * And so on until one of the callbacks accepts the message.
+ */
void
gras_cb_register(gras_msgtype_t msgtype,
- gras_cb_t cb) {
- gras_procdata_t *pd=gras_procdata_get();
+ gras_msg_cb_t cb) {
+ gras_msg_procdata_t pd=(gras_msg_procdata_t)gras_libdata_get("gras_msg");
gras_cblist_t *list=NULL;
int cpt;
/* First cb? Create room */
list = xbt_new(gras_cblist_t,1);
list->id = msgtype->code;
- list->cbs = xbt_dynar_new(sizeof(gras_cb_t), NULL);
+ list->cbs = xbt_dynar_new(sizeof(gras_msg_cb_t), NULL);
xbt_dynar_push(pd->cbl_list,&list);
}
xbt_dynar_insert_at(list->cbs,0,&cb);
}
+/** \brief Unbind the given callback from the given message type */
void
gras_cb_unregister(gras_msgtype_t msgtype,
- gras_cb_t cb) {
+ gras_msg_cb_t cb) {
- gras_procdata_t *pd=gras_procdata_get();
+ gras_msg_procdata_t pd=(gras_msg_procdata_t)gras_libdata_get("gras_msg");
gras_cblist_t *list;
- gras_cb_t cb_cpt;
+ gras_msg_cb_t cb_cpt;
int cpt;
int found = 0;
