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"
16 XBT_LOG_EXTERNAL_DEFAULT_CATEGORY(gras_msg);
20 const char *e_gras_msg_kind_names[e_gras_msg_kind_count]=
21 {"UNKNOWN","ONEWAY","RPC call","RPC answer","RPC error"};
24 /** \brief Waits for a message to come in over a given socket.
26 * @param timeout: How long should we wait for this message.
27 * @param msgt_want: type of awaited msg (or NULL if I'm enclined to accept any message)
28 * @param expe_want: awaited expeditot (match on hostname, not port; NULL if not relevant)
29 * @param filter: function returning true or false when passed a payload. Messages for which it returns false are not selected. (NULL if not relevant)
30 * @param filter_ctx: context passed as second argument of the filter (a pattern to match?)
31 * @param[out] msg_got: where to write the message we got
33 * Every message of another type received before the one waited will be queued
34 * and used by subsequent call to this function or gras_msg_handle().
38 gras_msg_wait_ext_(double timeout,
40 gras_msgtype_t msgt_want,
41 gras_socket_t expe_want,
42 gras_msg_filter_t filter,
49 gras_msg_procdata_t pd=
50 (gras_msg_procdata_t)gras_libdata_by_id(gras_msg_libdata_id);
53 xbt_assert0(msg_got,"msg_got is an output parameter");
55 start = gras_os_time();
56 VERB1("Waiting for message '%s'",msgt_want?msgt_want->name:"(any)");
58 xbt_dynar_foreach(pd->msg_waitqueue,cpt,msg){
59 if ( ( !msgt_want || (msg.type->code == msgt_want->code))
60 && (!expe_want || (!strcmp( gras_socket_peer_name(msg.expe),
61 gras_socket_peer_name(expe_want))))
62 && (!filter || filter(&msg,filter_ctx))) {
64 memcpy(msg_got,&msg,sizeof(s_gras_msg_t));
65 xbt_dynar_cursor_rm(pd->msg_waitqueue, &cpt);
66 VERB0("The waited message was queued");
71 xbt_dynar_foreach(pd->msg_queue,cpt,msg){
72 if ( ( !msgt_want || (msg.type->code == msgt_want->code))
73 && (!expe_want || (!strcmp( gras_socket_peer_name(msg.expe),
74 gras_socket_peer_name(expe_want))))
75 && (!filter || filter(&msg,filter_ctx))) {
77 memcpy(msg_got,&msg,sizeof(s_gras_msg_t));
78 xbt_dynar_cursor_rm(pd->msg_queue, &cpt);
79 VERB0("The waited message was queued");
88 restart_receive: /* Goto here when the receive of a message failed */
91 memset(&msg,sizeof(msg),0);
94 xbt_queue_shift_timed(pd->msg_received,&msg,timeout ? timeout - now + start : 0);
96 msg.expe = gras_trp_select(timeout ? timeout - now + start : 0);
97 gras_msg_recv(msg.expe, &msg);
100 if (e.category == system_error &&
101 !strncmp("Socket closed by remote side",e.msg,
102 strlen("Socket closed by remote side"))) {
110 goto restart_receive;
112 DEBUG0("Got a message from the socket");
114 if ( ( !msgt_want || (msg.type->code == msgt_want->code))
115 && (!expe_want || (!strcmp( gras_socket_peer_name(msg.expe),
116 gras_socket_peer_name(expe_want))))
117 && (!filter || filter(&msg,filter_ctx))) {
119 memcpy(msg_got,&msg,sizeof(s_gras_msg_t));
120 DEBUG0("Message matches expectations. Use it.");
123 DEBUG0("Message does not match expectations. Queue it.");
125 /* not expected msg type. Queue it for later */
126 xbt_dynar_push(pd->msg_queue,&msg);
129 if (now - start + 0.001 > timeout) {
130 THROW1(timeout_error, now-start+0.001-timeout,
131 "Timeout while waiting for msg '%s'",
132 msgt_want?msgt_want->name:"(any)");
138 /** \brief Waits for a message to come in over a given socket.
140 * @param timeout: How long should we wait for this message.
141 * @param msgt_want: type of awaited msg
142 * @param[out] expeditor: where to create a socket to answer the incomming message
143 * @param[out] payload: where to write the payload of the incomming message
144 * @return the error code (or no_error).
146 * Every message of another type received before the one waited will be queued
147 * and used by subsequent call to this function or gras_msg_handle().
150 gras_msg_wait_(double timeout,
151 gras_msgtype_t msgt_want,
152 gras_socket_t *expeditor,
156 gras_msg_wait_ext_(timeout,
157 msgt_want, NULL, NULL, NULL,
160 if (msgt_want->ctn_type) {
162 "Message type '%s' convey a payload you must accept",
165 xbt_assert1(!payload,
166 "No payload was declared for message type '%s'",
171 memcpy(payload,msg.payl,msg.payl_size);
176 *expeditor = msg.expe;
179 static int gras_msg_wait_or_filter(gras_msg_t msg, void *ctx) {
180 xbt_dynar_t dyn=(xbt_dynar_t)ctx;
181 int res = xbt_dynar_member(dyn,msg->type);
183 VERB1("Got matching message (type=%s)",msg->type->name);
185 VERB0("Got message not matching our expectations");
188 /** \brief Waits for a message to come in over a given socket.
190 * @param timeout: How long should we wait for this message.
191 * @param msgt_want: a dynar containing all accepted message type
192 * @param[out] ctx: the context of received message (in case it's a RPC call we want to answer to)
193 * @param[out] msgt_got: indice in the dynar of the type of the received message
194 * @param[out] payload: where to write the payload of the incomming message
195 * @return the error code (or no_error).
197 * Every message of a type not in the accepted list received before the one
198 * waited will be queued and used by subsequent call to this function or
201 * If you are interested in the context, pass the address of a s_gras_msg_cb_ctx_t variable.
203 void gras_msg_wait_or(double timeout,
204 xbt_dynar_t msgt_want,
205 gras_msg_cb_ctx_t *ctx,
210 VERB1("Wait %f seconds for several message types",timeout);
211 gras_msg_wait_ext_(timeout,
213 &gras_msg_wait_or_filter, (void*)msgt_want,
216 if (msg.type->ctn_type) {
218 "Message type '%s' convey a payload you must accept",
220 } /* don't check the other side since some of the types may have a payload */
222 if (payload && msg.type->ctn_type) {
223 memcpy(payload,msg.payl,msg.payl_size);
228 *ctx=gras_msg_cb_ctx_new(msg.expe, msg.type, msg.ID,
229 (msg.kind == e_gras_msg_kind_rpccall), 60);
232 *msgt_got = xbt_dynar_search(msgt_want,msg.type);
236 /** \brief Send the data pointed by \a payload as a message of type
237 * \a msgtype to the peer \a sock */
239 gras_msg_send_(gras_socket_t sock,
240 gras_msgtype_t msgtype,
243 if (msgtype->ctn_type) {
245 "Message type '%s' convey a payload you must provide",
248 xbt_assert1(!payload,
249 "No payload was declared for message type '%s'",
253 DEBUG2("Send a oneway message of type '%s'. Payload=%p",
254 msgtype->name,payload);
255 gras_msg_send_ext(sock, e_gras_msg_kind_oneway,0, msgtype, payload);
256 VERB2("Sent a oneway message of type '%s'. Payload=%p",
257 msgtype->name,payload);
260 /** @brief Handle all messages arriving within the given period
262 * @param period: How long to wait for incoming messages (in seconds)
264 * Messages are dealed with just like gras_msg_handle() would do. The
265 * difference is that gras_msg_handle() handles at most one message (or wait up
266 * to timeout second when no message arrives) while this function handles any
267 * amount of messages, and lasts the given period in any case.
270 gras_msg_handleall(double period) {
272 double begin=gras_os_time();
278 if (period - now + begin > 0)
279 gras_msg_handle(period - now + begin);
281 if (e.category != timeout_error)
282 RETHROW0("Error while waiting for messages: %s");
285 } while (now - begin < period);
288 /** @brief Handle an incomming message or timer (or wait up to \a timeOut seconds)
290 * @param timeOut: How long to wait for incoming messages (in seconds)
291 * @return the error code (or no_error).
293 * Any message arriving in the given interval is passed to the callbacks.
295 * @sa gras_msg_handleall().
298 gras_msg_handle(double timeOut) {
307 gras_msg_procdata_t pd=(gras_msg_procdata_t)gras_libdata_by_id(gras_msg_libdata_id);
308 gras_cblist_t *list=NULL;
310 s_gras_msg_cb_ctx_t ctx;
312 int timerexpected, timeouted;
315 VERB1("Handling message within the next %.2fs",timeOut);
317 untiltimer = gras_msg_timer_handle();
318 DEBUG1("Next timer in %f sec", untiltimer);
319 if (untiltimer == 0.0) {
320 /* A timer was already elapsed and handled */
323 if (untiltimer != -1.0) {
325 timeOut = MIN(timeOut, untiltimer);
330 /* get a message (from the queue or from the net) */
332 if (xbt_dynar_length(pd->msg_queue)) {
333 DEBUG0("Get a message from the queue");
334 xbt_dynar_shift(pd->msg_queue,&msg);
337 xbt_queue_shift_timed(pd->msg_received,&msg,timeOut);
338 // msg.expe = gras_trp_select(timeOut);
340 if (e.category != timeout_error)
342 DEBUG0("Damn. Timeout while getting a message from the queue");
351 /* A timer elapsed before the arrival of any message even if we select()ed a bit */
352 untiltimer = gras_msg_timer_handle();
353 if (untiltimer == 0.0) {
354 /* we served a timer, we're done */
357 xbt_assert1(untiltimer>0, "Negative timer (%f). I'm 'puzzeled'", untiltimer);
358 WARN1("No timer elapsed, in contrary to expectations (next in %f sec)",
360 THROW1(timeout_error,0,
361 "No timer elapsed, in contrary to expectations (next in %f sec)",
366 /* select timeouted, and no timer elapsed. Nothing to do */
367 THROW1(timeout_error, 0, "No new message or timer (delay was %f)",
373 /* A message was already there or arrived in the meanwhile. handle it */
374 xbt_dynar_foreach(pd->cbl_list,cpt,list) {
375 if (list->id == msg.type->code) {
382 INFO3("No callback for message '%s' from %s:%d. Queue it for later gras_msg_wait() use.",
384 gras_socket_peer_name(msg.expe),gras_socket_peer_port(msg.expe));
385 xbt_dynar_push(pd->msg_waitqueue,&msg);
386 return; /* FIXME: maybe we should call ourselves again until the end of the timer or a proper msg is got */
389 ctx.expeditor = msg.expe;
391 ctx.msgtype = msg.type;
392 ctx.answer_due = (msg.kind == e_gras_msg_kind_rpccall);
395 case e_gras_msg_kind_oneway:
396 case e_gras_msg_kind_rpccall:
399 xbt_dynar_foreach(list->cbs,cpt,cb) {
401 DEBUG4("Use the callback #%d (@%p) for incomming msg %s (payload_size=%d)",
402 cpt+1,cb,msg.type->name,msg.payl_size);
403 if (!(*cb)(&ctx,msg.payl)) {
404 /* cb handled the message */
412 if (msg.type->kind == e_gras_msg_kind_rpccall) {
413 char *old_file=e.file;
414 /* The callback raised an exception, propagate it on the network */
416 /* Make sure we reduce the file name to its basename to avoid issues in tests */
417 char *new_file=strrchr(e.file,'/');
420 /* the exception is born on this machine */
421 e.host = (char*)gras_os_myname();
422 xbt_ex_setup_backtrace(&e);
424 VERB5("Propagate %s exception ('%s') from '%s' RPC cb back to %s:%d",
425 (e.remote ? "remote" : "local"),
428 gras_socket_peer_name(msg.expe),
429 gras_socket_peer_port(msg.expe));
430 gras_msg_send_ext(msg.expe, e_gras_msg_kind_rpcerror,
431 msg.ID, msg.type, &e);
437 RETHROW0("Callback raised an exception: %s");
441 xbt_assert1(! ctx.answer_due,
442 "Bug in user code: RPC callback to message '%s' didn't call gras_msg_rpcreturn",msg.type->name);
444 CRITICAL1("BUGS BOTH IN USER CODE (RPC callback to message '%s' didn't call gras_msg_rpcreturn) "
445 "AND IN SIMGRID (process wasn't killed by an assert)",msg.type->name);
447 THROW1(mismatch_error,0,
448 "Message '%s' refused by all registered callbacks", msg.type->name);
449 /* FIXME: gras_datadesc_free not implemented => leaking the payload */
453 case e_gras_msg_kind_rpcanswer:
454 INFO1("Unexpected RPC answer discarded (type: %s)", msg.type->name);
455 WARN0("FIXME: gras_datadesc_free not implemented => leaking the payload");
458 case e_gras_msg_kind_rpcerror:
459 INFO1("Unexpected RPC error discarded (type: %s)", msg.type->name);
460 WARN0("FIXME: gras_datadesc_free not implemented => leaking the payload");
464 THROW1(unknown_error,0,
465 "Cannot handle messages of kind %d yet",msg.type->kind);