3 /* gras message exchanges */
5 /* Copyright (c) 2003, 2004, 2005, 2006, 2007 Martin Quinson. */
6 /* All rights reserved. */
8 /* This program is free software; you can redistribute it and/or modify it
9 * under the terms of the license (GNU LGPL) which comes with this package. */
12 #include "xbt/ex_interface.h"
13 #include "gras/Msg/msg_private.h"
14 #include "gras/Virtu/virtu_interface.h"
15 #include "gras/Transport/transport_interface.h" /* gras_select */
17 XBT_LOG_EXTERNAL_DEFAULT_CATEGORY(gras_msg);
21 const char *e_gras_msg_kind_names[e_gras_msg_kind_count]=
22 {"UNKNOWN","ONEWAY","RPC call","RPC answer","RPC error"};
25 /** \brief Waits for a message to come in over a given socket.
27 * @param timeout: How long should we wait for this message.
28 * @param msgt_want: type of awaited msg (or NULL if I'm enclined to accept any message)
29 * @param expe_want: awaited expeditot (match on hostname, not port; NULL if not relevant)
30 * @param filter: function returning true or false when passed a payload. Messages for which it returns false are not selected. (NULL if not relevant)
31 * @param filter_ctx: context passed as second argument of the filter (a pattern to match?)
32 * @param[out] msg_got: where to write the message we got
34 * Every message of another type received before the one waited will be queued
35 * and used by subsequent call to this function or gras_msg_handle().
39 gras_msg_wait_ext_(double timeout,
41 gras_msgtype_t msgt_want,
42 gras_socket_t expe_want,
43 gras_msg_filter_t filter,
50 gras_msg_procdata_t pd=
51 (gras_msg_procdata_t)gras_libdata_by_id(gras_msg_libdata_id);
54 xbt_assert0(msg_got,"msg_got is an output parameter");
56 start = gras_os_time();
57 VERB1("Waiting for message '%s'",msgt_want?msgt_want->name:"(any)");
59 xbt_dynar_foreach(pd->msg_waitqueue,cpt,msg){
60 if ( ( !msgt_want || (msg.type->code == msgt_want->code))
61 && (!expe_want || (!strcmp( gras_socket_peer_name(msg.expe),
62 gras_socket_peer_name(expe_want))))
63 && (!filter || filter(&msg,filter_ctx))) {
65 memcpy(msg_got,&msg,sizeof(s_gras_msg_t));
66 xbt_dynar_cursor_rm(pd->msg_waitqueue, &cpt);
67 VERB0("The waited message was queued");
72 xbt_dynar_foreach(pd->msg_queue,cpt,msg){
73 if ( ( !msgt_want || (msg.type->code == msgt_want->code))
74 && (!expe_want || (!strcmp( gras_socket_peer_name(msg.expe),
75 gras_socket_peer_name(expe_want))))
76 && (!filter || filter(&msg,filter_ctx))) {
78 memcpy(msg_got,&msg,sizeof(s_gras_msg_t));
79 xbt_dynar_cursor_rm(pd->msg_queue, &cpt);
80 VERB0("The waited message was queued");
89 restart_receive: /* Goto here when the receive of a message failed */
92 memset(&msg,sizeof(msg),0);
95 msg.expe = gras_trp_select(timeout ? timeout - now + start : 0);
96 gras_msg_recv(msg.expe, &msg);
98 if (e.category == system_error &&
99 !strncmp("Socket closed by remote side",e.msg,
100 strlen("Socket closed by remote side"))) {
108 goto restart_receive;
110 DEBUG0("Got a message from the socket");
112 if ( ( !msgt_want || (msg.type->code == msgt_want->code))
113 && (!expe_want || (!strcmp( gras_socket_peer_name(msg.expe),
114 gras_socket_peer_name(expe_want))))
115 && (!filter || filter(&msg,filter_ctx))) {
117 memcpy(msg_got,&msg,sizeof(s_gras_msg_t));
118 DEBUG0("Message matches expectations. Use it.");
121 DEBUG0("Message does not match expectations. Queue it.");
123 /* not expected msg type. Queue it for later */
124 xbt_dynar_push(pd->msg_queue,&msg);
127 if (now - start + 0.001 > timeout) {
128 THROW1(timeout_error, now-start+0.001-timeout,
129 "Timeout while waiting for msg '%s'",
130 msgt_want?msgt_want->name:"(any)");
136 /** \brief Waits for a message to come in over a given socket.
138 * @param timeout: How long should we wait for this message.
139 * @param msgt_want: type of awaited msg
140 * @param[out] expeditor: where to create a socket to answer the incomming message
141 * @param[out] payload: where to write the payload of the incomming message
142 * @return the error code (or no_error).
144 * Every message of another type received before the one waited will be queued
145 * and used by subsequent call to this function or gras_msg_handle().
148 gras_msg_wait_(double timeout,
149 gras_msgtype_t msgt_want,
150 gras_socket_t *expeditor,
154 gras_msg_wait_ext_(timeout,
155 msgt_want, NULL, NULL, NULL,
158 if (msgt_want->ctn_type) {
160 "Message type '%s' convey a payload you must accept",
163 xbt_assert1(!payload,
164 "No payload was declared for message type '%s'",
169 memcpy(payload,msg.payl,msg.payl_size);
174 *expeditor = msg.expe;
177 static int gras_msg_wait_or_filter(gras_msg_t msg, void *ctx) {
178 xbt_dynar_t dyn=(xbt_dynar_t)ctx;
179 int res = xbt_dynar_member(dyn,msg->type);
181 VERB1("Got matching message (type=%s)",msg->type->name);
183 VERB0("Got message not matching our expectations");
186 /** \brief Waits for a message to come in over a given socket.
188 * @param timeout: How long should we wait for this message.
189 * @param msgt_want: a dynar containing all accepted message type
190 * @param[out] ctx: the context of received message (in case it's a RPC call we want to answer to)
191 * @param[out] msgt_got: indice in the dynar of the type of the received message
192 * @param[out] payload: where to write the payload of the incomming message
193 * @return the error code (or no_error).
195 * Every message of a type not in the accepted list received before the one
196 * waited will be queued and used by subsequent call to this function or
199 * If you are interested in the context, pass the address of a s_gras_msg_cb_ctx_t variable.
201 void gras_msg_wait_or(double timeout,
202 xbt_dynar_t msgt_want,
203 gras_msg_cb_ctx_t *ctx,
208 VERB1("Wait %f seconds for several message types",timeout);
209 gras_msg_wait_ext_(timeout,
211 &gras_msg_wait_or_filter, (void*)msgt_want,
214 if (msg.type->ctn_type) {
216 "Message type '%s' convey a payload you must accept",
218 } /* don't check the other side since some of the types may have a payload */
220 if (payload && msg.type->ctn_type) {
221 memcpy(payload,msg.payl,msg.payl_size);
226 *ctx=gras_msg_cb_ctx_new(msg.expe, msg.type, msg.ID,
227 (msg.kind == e_gras_msg_kind_rpccall), 60);
230 *msgt_got = xbt_dynar_search(msgt_want,msg.type);
234 /** \brief Send the data pointed by \a payload as a message of type
235 * \a msgtype to the peer \a sock */
237 gras_msg_send_(gras_socket_t sock,
238 gras_msgtype_t msgtype,
241 if (msgtype->ctn_type) {
243 "Message type '%s' convey a payload you must provide",
246 xbt_assert1(!payload,
247 "No payload was declared for message type '%s'",
251 DEBUG2("Send a oneway message of type '%s'. Payload=%p",
252 msgtype->name,payload);
253 gras_msg_send_ext(sock, e_gras_msg_kind_oneway,0, msgtype, payload);
254 VERB2("Sent a oneway message of type '%s'. Payload=%p",
255 msgtype->name,payload);
258 /** @brief Handle all messages arriving within the given period
260 * @param period: How long to wait for incoming messages (in seconds)
262 * Messages are dealed with just like gras_msg_handle() would do. The
263 * difference is that gras_msg_handle() handles at most one message (or wait up
264 * to timeout second when no message arrives) while this function handles any
265 * amount of messages, and lasts the given period in any case.
268 gras_msg_handleall(double period) {
270 double begin=gras_os_time();
276 if (period - now + begin > 0)
277 gras_msg_handle(period - now + begin);
279 if (e.category != timeout_error)
280 RETHROW0("Error while waiting for messages: %s");
283 } while (now - begin < period);
286 /** @brief Handle an incomming message or timer (or wait up to \a timeOut seconds)
288 * @param timeOut: How long to wait for incoming messages (in seconds)
289 * @return the error code (or no_error).
291 * Messages are passed to the callbacks. See also gras_msg_handleall().
294 gras_msg_handle(double timeOut) {
303 gras_msg_procdata_t pd=(gras_msg_procdata_t)gras_libdata_by_id(gras_msg_libdata_id);
304 gras_cblist_t *list=NULL;
306 s_gras_msg_cb_ctx_t ctx;
308 int timerexpected, timeouted;
311 VERB1("Handling message within the next %.2fs",timeOut);
313 untiltimer = gras_msg_timer_handle();
314 DEBUG1("Next timer in %f sec", untiltimer);
315 if (untiltimer == 0.0) {
316 /* A timer was already elapsed and handled */
319 if (untiltimer != -1.0) {
321 timeOut = MIN(timeOut, untiltimer);
326 /* get a message (from the queue or from the net) */
328 if (xbt_dynar_length(pd->msg_queue)) {
329 DEBUG0("Get a message from the queue");
330 xbt_dynar_shift(pd->msg_queue,&msg);
333 msg.expe = gras_trp_select(timeOut);
335 if (e.category != timeout_error)
343 /* FIXME: if not the right kind, queue it and recall ourself or goto >:-) */
344 gras_msg_recv(msg.expe, &msg);
345 DEBUG1("Received a msg from the socket kind:%s",
346 e_gras_msg_kind_names[msg.kind]);
349 RETHROW4("Error while receiving a message on select()ed socket %p to [%s]%s:%d: %s",
351 gras_socket_peer_proc(msg.expe),gras_socket_peer_name(msg.expe),
352 gras_socket_peer_port(msg.expe));
360 /* A timer elapsed before the arrival of any message even if we select()ed a bit */
361 untiltimer = gras_msg_timer_handle();
362 if (untiltimer == 0.0) {
363 /* we served a timer, we're done */
366 xbt_assert1(untiltimer>0, "Negative timer (%f). I'm 'puzzeled'", untiltimer);
367 WARN1("No timer elapsed, in contrary to expectations (next in %f sec)",
369 THROW1(timeout_error,0,
370 "No timer elapsed, in contrary to expectations (next in %f sec)",
375 /* select timeouted, and no timer elapsed. Nothing to do */
376 THROW1(timeout_error, 0, "No new message or timer (delay was %f)",
382 /* A message was already there or arrived in the meanwhile. handle it */
383 xbt_dynar_foreach(pd->cbl_list,cpt,list) {
384 if (list->id == msg.type->code) {
391 INFO3("No callback for message '%s' from %s:%d. Queue it for later gras_msg_wait() use.",
393 gras_socket_peer_name(msg.expe),gras_socket_peer_port(msg.expe));
394 xbt_dynar_push(pd->msg_waitqueue,&msg);
395 return; /* FIXME: maybe we should call ourselves again until the end of the timer or a proper msg is got */
398 ctx.expeditor = msg.expe;
400 ctx.msgtype = msg.type;
401 ctx.answer_due = (msg.kind == e_gras_msg_kind_rpccall);
404 case e_gras_msg_kind_oneway:
405 case e_gras_msg_kind_rpccall:
408 xbt_dynar_foreach(list->cbs,cpt,cb) {
410 DEBUG4("Use the callback #%d (@%p) for incomming msg %s (payload_size=%d)",
411 cpt+1,cb,msg.type->name,msg.payl_size);
412 if (!(*cb)(&ctx,msg.payl)) {
413 /* cb handled the message */
421 if (msg.type->kind == e_gras_msg_kind_rpccall) {
422 char *old_file=e.file;
423 /* The callback raised an exception, propagate it on the network */
425 /* Make sure we reduce the file name to its basename to avoid issues in tests */
426 char *new_file=strrchr(e.file,'/');
429 /* the exception is born on this machine */
430 e.host = (char*)gras_os_myname();
431 xbt_ex_setup_backtrace(&e);
433 VERB5("Propagate %s exception ('%s') from '%s' RPC cb back to %s:%d",
434 (e.remote ? "remote" : "local"),
437 gras_socket_peer_name(msg.expe),
438 gras_socket_peer_port(msg.expe));
439 gras_msg_send_ext(msg.expe, e_gras_msg_kind_rpcerror,
440 msg.ID, msg.type, &e);
446 RETHROW0("Callback raised an exception: %s");
449 xbt_assert0(!(ctx.answer_due),
450 "RPC callback didn't call gras_msg_rpcreturn");
453 THROW1(mismatch_error,0,
454 "Message '%s' refused by all registered callbacks", msg.type->name);
455 /* FIXME: gras_datadesc_free not implemented => leaking the payload */
459 case e_gras_msg_kind_rpcanswer:
460 INFO1("Unexpected RPC answer discarded (type: %s)", msg.type->name);
461 WARN0("FIXME: gras_datadesc_free not implemented => leaking the payload");
464 case e_gras_msg_kind_rpcerror:
465 INFO1("Unexpected RPC error discarded (type: %s)", msg.type->name);
466 WARN0("FIXME: gras_datadesc_free not implemented => leaking the payload");
470 THROW1(unknown_error,0,
471 "Cannot handle messages of kind %d yet",msg.type->kind);