Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
retrive -> retrieve
[simgrid.git] / src / gras / Msg / msg.c
1 /* $Id$ */
2
3 /* messaging - Function related to messaging (code shared between RL and SG)*/
4
5 /* Copyright (c) 2003, 2004 Martin Quinson. All rights reserved.            */
6
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. */
9
10 #include "xbt/ex.h"
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 */
17
18 #ifndef MIN
19 #define MIN(a,b) ((a) < (b) ? (a) : (b))
20 #endif
21
22 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(gras_msg,gras,"High level messaging");
23
24 xbt_set_t _gras_msgtype_set = NULL;
25 static char *make_namev(const char *name, short int ver);
26 char _GRAS_header[6];
27 const char *e_gras_msg_kind_names[e_gras_msg_kind_count]=
28   {"UNKNOWN","ONEWAY","RPC call","RPC answer","RPC error"};
29
30 /*
31  * Creating procdata for this module
32  */
33 static void *gras_msg_procdata_new() {
34    gras_msg_procdata_t res = xbt_new(s_gras_msg_procdata_t,1);
35    
36    res->name = xbt_strdup("gras_msg");
37    res->name_len = 0;
38    res->msg_queue = xbt_dynar_new(sizeof(s_gras_msg_t),   NULL);
39    res->cbl_list  = xbt_dynar_new(sizeof(gras_cblist_t *),gras_cbl_free);
40    res->timers    = xbt_dynar_new(sizeof(s_gras_timer_t), NULL);
41    
42    return (void*)res;
43 }
44
45 /*
46  * Freeing procdata for this module
47  */
48 static void gras_msg_procdata_free(void *data) {
49    gras_msg_procdata_t res = (gras_msg_procdata_t)data;
50    
51    xbt_dynar_free(&( res->msg_queue ));
52    xbt_dynar_free(&( res->cbl_list ));
53    xbt_dynar_free(&( res->timers ));
54
55    free(res->name);
56    free(res);
57 }
58
59 /*
60  * Module registration
61  */
62 int gras_msg_libdata_id;
63 void gras_msg_register() {
64    gras_msg_libdata_id = gras_procdata_add("gras_msg",gras_msg_procdata_new, gras_msg_procdata_free);
65 }
66
67 /*
68  * Initialize this submodule.
69  */
70 void gras_msg_init(void) {
71   /* only initialize once */
72   if (_gras_msgtype_set != NULL)
73     return;
74
75   VERB0("Initializing Msg");
76   
77   _gras_msgtype_set = xbt_set_new();
78
79   memcpy(_GRAS_header,"GRAS", 4);
80   _GRAS_header[4]=GRAS_PROTOCOL_VERSION;
81   _GRAS_header[5]=(char)GRAS_THISARCH;
82 }
83
84 /*
85  * Finalize the msg module
86  */
87 void
88 gras_msg_exit(void) {
89   VERB0("Exiting Msg");
90   xbt_set_free(&_gras_msgtype_set);
91 }
92
93 /*
94  * Reclamed memory
95  */
96 void gras_msgtype_free(void *t) {
97   gras_msgtype_t msgtype=(gras_msgtype_t)t;
98   if (msgtype) {
99     free(msgtype->name);
100     free(msgtype);
101   }
102 }
103
104 /**
105  * make_namev:
106  *
107  * Returns the versionned name of the message. If the version is 0, that's 
108  * the name unchanged. Pay attention to this before free'ing the result.
109  */
110 static char *make_namev(const char *name, short int ver) {
111   char *namev;
112
113   if (!ver)
114     return (char *)name;
115
116   namev = (char*)xbt_malloc(strlen(name)+2+3+1);
117
118   if (namev)
119       sprintf(namev,"%s_v%d",name,ver);
120
121   return namev;
122 }
123
124 /* Internal function doing the crude work of registering messages */
125 void 
126 gras_msgtype_declare_ext(const char           *name,
127                          short int             version,
128                          e_gras_msg_kind_t     kind, 
129                          gras_datadesc_type_t  payload_request,
130                          gras_datadesc_type_t  payload_answer) {
131
132   gras_msgtype_t msgtype=NULL;
133   char *namev=make_namev(name,version);
134   volatile int found = 0;
135   xbt_ex_t e;    
136   
137   TRY {
138     msgtype = (gras_msgtype_t)xbt_set_get_by_name(_gras_msgtype_set,namev);
139     found = 1;
140   } CATCH(e) {
141     if (e.category != not_found_error)
142       RETHROW;
143     xbt_ex_free(e);
144   }
145
146   if (found) {
147     VERB2("Re-register version %d of message '%s' (same kind & payload, ignored).",
148           version, name);
149     xbt_assert3(msgtype->kind == kind,
150                 "Message %s re-registered as a %s (it was known as a %s)",
151                 namev,e_gras_msg_kind_names[kind],e_gras_msg_kind_names[msgtype->kind]);
152     xbt_assert3(!gras_datadesc_type_cmp(msgtype->ctn_type, payload_request),
153                  "Message %s re-registred with another payload (%s was %s)",
154                  namev,gras_datadesc_get_name(payload_request),
155                  gras_datadesc_get_name(msgtype->ctn_type));
156
157     xbt_assert3(!gras_datadesc_type_cmp(msgtype->answer_type, payload_answer),
158              "Message %s re-registred with another answer payload (%s was %s)",
159                  namev,gras_datadesc_get_name(payload_answer),
160                  gras_datadesc_get_name(msgtype->answer_type));
161
162     return ; /* do really ignore it */
163
164   }
165
166   VERB4("Register version %d of message '%s' "
167         "(payload: %s; answer payload: %s).", 
168         version, name, gras_datadesc_get_name(payload_request),
169         gras_datadesc_get_name(payload_answer));    
170
171   msgtype = xbt_new(s_gras_msgtype_t,1);
172   msgtype->name = (namev == name ? strdup(name) : namev);
173   msgtype->name_len = strlen(namev);
174   msgtype->version = version;
175   msgtype->kind = kind;
176   msgtype->ctn_type = payload_request;
177   msgtype->answer_type = payload_answer;
178
179   xbt_set_add(_gras_msgtype_set, (xbt_set_elm_t)msgtype,
180                &gras_msgtype_free);
181 }
182
183
184 /** @brief declare a new message type of the given name. It only accepts the given datadesc as payload
185  *
186  * @param name: name as it should be used for logging messages (must be uniq)
187  * @param payload: datadescription of the payload
188  */
189 void gras_msgtype_declare(const char           *name,
190                           gras_datadesc_type_t  payload) {
191    gras_msgtype_declare_ext(name, 0, e_gras_msg_kind_oneway, payload, NULL);
192 }
193
194
195
196 /** @brief declare a new versionned message type of the given name and payload
197  *
198  * @param name: name as it should be used for logging messages (must be uniq)
199  * @param version: something like versionning symbol
200  * @param payload: datadescription of the payload
201  *
202  * Registers a message to the GRAS mechanism. Use this version instead of 
203  * gras_msgtype_declare when you change the semantic or syntax of a message and
204  * want your programs to be able to deal with both versions. Internally, each
205  * will be handled as an independent message type, so you can register 
206  * differents for each of them.
207  */
208 void
209 gras_msgtype_declare_v(const char           *name,
210                        short int             version,
211                        gras_datadesc_type_t  payload) {
212  
213    gras_msgtype_declare_ext(name, version, 
214                             e_gras_msg_kind_oneway, payload, NULL);
215 }
216
217 /** @brief retrieve an existing message type from its name. */
218 gras_msgtype_t gras_msgtype_by_name (const char *name) {
219   return gras_msgtype_by_namev(name,0);
220 }
221
222 /** @brief retrieve an existing message type from its name and version. */
223 gras_msgtype_t gras_msgtype_by_namev(const char      *name,
224                                      short int        version) {
225   gras_msgtype_t res = NULL;
226   char *namev = make_namev(name,version); 
227   xbt_ex_t e;
228
229   TRY {
230     res = (gras_msgtype_t)xbt_set_get_by_name(_gras_msgtype_set, namev);
231   } CATCH(e) {
232     xbt_ex_free(e);
233     THROW1(not_found_error,0,"No registred message of that name: %s",name);
234   }
235   if (name != namev) 
236     free(namev);
237   
238   return res;
239 }
240 /** @brief retrieve an existing message type from its name and version. */
241 gras_msgtype_t gras_msgtype_by_id(int id) {
242   return (gras_msgtype_t)xbt_set_get_by_id(_gras_msgtype_set, id);
243 }
244
245 /** \brief Waits for a message to come in over a given socket. 
246  *
247  * @param timeout: How long should we wait for this message.
248  * @param msgt_want: type of awaited msg (or NULL if I'm enclined to accept any message)
249  * @param expe_want: awaited expeditot (match on hostname, not port; NULL if not relevant)
250  * @param filter: function returning true or false when passed a payload. Messages for which it returns false are not selected. (NULL if not relevant)
251  * @param filter_ctx: context passed as second argument of the filter (a pattern to match?)
252  * @param[out] msg_got: where to write the message we got
253  *
254  * Every message of another type received before the one waited will be queued
255  * and used by subsequent call to this function or gras_msg_handle().
256  */
257
258 void
259 gras_msg_wait_ext(double           timeout,    
260
261                   gras_msgtype_t   msgt_want,
262                   gras_socket_t    expe_want,
263                   gras_msg_filter_t filter,
264                   void             *filter_ctx, 
265
266                   gras_msg_t       msg_got) {
267
268   s_gras_msg_t msg;
269   double start, now;
270   gras_msg_procdata_t pd=(gras_msg_procdata_t)gras_libdata_by_id(gras_msg_libdata_id);
271   int cpt;
272
273   xbt_assert0(msgt_want,"Cannot wait for the NULL message");
274   xbt_assert0(msg_got,"msg_got is an output parameter");
275
276   VERB1("Waiting for message '%s'",msgt_want->name);
277
278   start = now = gras_os_time();
279
280   xbt_dynar_foreach(pd->msg_queue,cpt,msg){
281     if ( (   !msgt_want || (msg.type->code == msgt_want->code)) 
282          && (!expe_want || (!strcmp( gras_socket_peer_name(msg.expe),
283                                      gras_socket_peer_name(expe_want))))
284          && (!filter || filter(&msg,filter_ctx))) {
285
286       memcpy(msg_got,&msg,sizeof(s_gras_msg_t));
287       xbt_dynar_cursor_rm(pd->msg_queue, &cpt);
288       VERB0("The waited message was queued");
289       return;
290     }
291   }
292
293   while (1) {
294     memset(&msg,sizeof(msg),0);
295
296     msg.expe = gras_trp_select(timeout ? timeout - now + start : 0);
297     gras_msg_recv(msg.expe, &msg);
298     DEBUG0("Got a message from the socket");
299
300     if ( (   !msgt_want || (msg.type->code == msgt_want->code)) 
301          && (!expe_want || (!strcmp( gras_socket_peer_name(msg.expe),
302                                      gras_socket_peer_name(expe_want))))
303          && (!filter || filter(&msg,filter_ctx))) {
304
305       memcpy(msg_got,&msg,sizeof(s_gras_msg_t));
306       DEBUG0("Message matches expectations. Use it.");
307       return;
308     }
309     DEBUG0("Message does not match expectations. Queue it.");
310
311     /* not expected msg type. Queue it for later */
312     xbt_dynar_push(pd->msg_queue,&msg);
313     
314     now=gras_os_time();
315     if (now - start + 0.001 > timeout) {
316       THROW1(timeout_error,  now-start+0.001-timeout,
317              "Timeout while waiting for msg %s",msgt_want->name);
318     }
319   }
320
321   THROW_IMPOSSIBLE;
322 }
323 /** \brief Waits for a message to come in over a given socket. 
324  *
325  * @param timeout: How long should we wait for this message.
326  * @param msgt_want: type of awaited msg
327  * @param[out] expeditor: where to create a socket to answer the incomming message
328  * @param[out] payload: where to write the payload of the incomming message
329  * @return the error code (or no_error).
330  *
331  * Every message of another type received before the one waited will be queued
332  * and used by subsequent call to this function or gras_msg_handle().
333  */
334 void
335 gras_msg_wait(double           timeout,    
336               gras_msgtype_t   msgt_want,
337               gras_socket_t   *expeditor,
338               void            *payload) {
339   s_gras_msg_t msg;
340
341   gras_msg_wait_ext(timeout,
342                     msgt_want, NULL,      NULL, NULL,
343                     &msg);
344
345   if (msgt_want->ctn_type) {
346     xbt_assert1(payload,
347                 "Message type '%s' convey a payload you must accept",
348                 msgt_want->name);
349   } else {
350     xbt_assert1(!payload,
351                 "No payload was declared for message type '%s'",
352                 msgt_want->name);
353   }
354
355   if (payload) {
356     memcpy(payload,msg.payl,msg.payl_size);
357     free(msg.payl);
358   }
359
360   if (expeditor)
361     *expeditor = msg.expe;
362 }
363
364
365 /** \brief Send the data pointed by \a payload as a message of type
366  * \a msgtype to the peer \a sock */
367 void
368 gras_msg_send(gras_socket_t   sock,
369               gras_msgtype_t  msgtype,
370               void           *payload) {
371
372   if (msgtype->ctn_type) {
373     xbt_assert1(payload,
374                 "Message type '%s' convey a payload you must provide",
375                 msgtype->name);
376   } else {
377     xbt_assert1(!payload,
378                 "No payload was declared for message type '%s'",
379                 msgtype->name);
380   }
381
382   gras_msg_send_ext(sock, e_gras_msg_kind_oneway,0, msgtype, payload);
383 }
384
385 /** @brief Handle all messages arriving within the given period
386  *
387  * @param timeOut: How long to wait for incoming messages (in seconds)
388  * @return the error code (or no_error).
389  *
390  * Messages are dealed with just like gras_msg_handle() would do. The
391  * difference is that gras_msg_handle() handles at most one message (or wait up
392  * to timeout second when no message arrives) while this function handles any
393  * amount of messages, and lasts the given period in any case.
394  */
395 void 
396 gras_msg_handleall(double period) {
397   xbt_ex_t e;
398   double begin=gras_os_time();
399   double now;
400
401   do {
402     now=gras_os_time();
403     TRY{
404       gras_msg_handle(period - now + begin);
405     } CATCH(e) {
406       if (e.category != timeout_error) 
407         RETHROW0("Error while waiting for messages: %s");
408       xbt_ex_free(e);
409     }
410   } while (now - begin < period);
411 }
412 /** @brief Handle an incomming message or timer (or wait up to \a timeOut seconds)
413  *
414  * @param timeOut: How long to wait for incoming messages (in seconds)
415  * @return the error code (or no_error).
416  *
417  * Messages are passed to the callbacks. See also gras_msg_handleall().
418  */
419 void
420 gras_msg_handle(double timeOut) {
421   
422   double          untiltimer;
423    
424   int             cpt, ran_ok;
425
426   s_gras_msg_t    msg;
427
428   gras_msg_procdata_t pd=(gras_msg_procdata_t)gras_libdata_by_id(gras_msg_libdata_id);
429   gras_cblist_t  *list=NULL;
430   gras_msg_cb_t       cb;
431   s_gras_msg_cb_ctx_t ctx;
432    
433   int timerexpected, timeouted;
434   xbt_ex_t e;
435
436   VERB1("Handling message within the next %.2fs",timeOut);
437   
438   untiltimer = gras_msg_timer_handle();
439   DEBUG1("Next timer in %f sec", untiltimer);
440   if (untiltimer == 0.0) {
441      /* A timer was already elapsed and handled */
442      return;
443   }
444   if (untiltimer != -1.0) {
445      timerexpected = 1;
446      timeOut = MIN(timeOut, untiltimer);
447   } else {
448      timerexpected = 0;
449   }
450    
451   /* get a message (from the queue or from the net) */
452   timeouted = 0;
453   if (xbt_dynar_length(pd->msg_queue)) {
454     DEBUG0("Get a message from the queue");
455     xbt_dynar_shift(pd->msg_queue,&msg);
456   } else {
457     TRY {
458       msg.expe = gras_trp_select(timeOut);
459     } CATCH(e) {
460       if (e.category != timeout_error)
461         RETHROW;
462       xbt_ex_free(e);
463       timeouted = 1;
464     }
465
466     if (!timeouted) {
467       TRY {
468         /* FIXME: if not the right kind, queue it and recall ourself or goto >:-) */
469         gras_msg_recv(msg.expe, &msg);
470         DEBUG1("Received a msg from the socket kind:%s",
471                e_gras_msg_kind_names[msg.kind]);
472     
473       } CATCH(e) {
474         RETHROW4("Error while receiving a message on select()ed socket %p to [%s]%s:%d: %s",
475                  msg.expe,
476                  gras_socket_peer_proc(msg.expe),gras_socket_peer_name(msg.expe),
477                  gras_socket_peer_port(msg.expe));
478       }
479     }
480   }
481
482   if (timeouted) {
483      if (timerexpected) {
484           
485         /* A timer elapsed before the arrival of any message even if we select()ed a bit */
486         untiltimer = gras_msg_timer_handle();
487         if (untiltimer == 0.0) {
488           /* we served a timer, we're done */
489           return;
490         } else {
491            xbt_assert1(untiltimer>0, "Negative timer (%f). I'm 'puzzeled'", untiltimer);
492            WARN1("No timer elapsed, in contrary to expectations (next in %f sec)",
493                   untiltimer);
494            THROW1(timeout_error,0,
495                   "No timer elapsed, in contrary to expectations (next in %f sec)",
496                   untiltimer);
497         }
498         
499      } else {
500         /* select timeouted, and no timer elapsed. Nothing to do */
501        THROW1(timeout_error, 0, "No new message or timer (delay was %f)",
502               timeOut);
503      }
504      
505   }
506    
507   /* A message was already there or arrived in the meanwhile. handle it */
508   xbt_dynar_foreach(pd->cbl_list,cpt,list) {
509     if (list->id == msg.type->code) {
510       break;
511     } else {
512       list=NULL;
513     }
514   }
515   if (!list) {
516     INFO3("No callback for the incomming '%s' message (from %s:%d). Discarded.", 
517           msg.type->name,
518           gras_socket_peer_name(msg.expe),gras_socket_peer_port(msg.expe));
519     WARN0("FIXME: gras_datadesc_free not implemented => leaking the payload");
520     return;
521   }
522   
523   ctx.expeditor = msg.expe;
524   ctx.ID = msg.ID;
525   ctx.msgtype = msg.type;
526
527   switch (msg.kind) {
528   case e_gras_msg_kind_oneway:
529   case e_gras_msg_kind_rpccall:
530     ran_ok=0;
531     TRY {
532       xbt_dynar_foreach(list->cbs,cpt,cb) { 
533         if (!ran_ok) {
534           VERB3("Use the callback #%d (@%p) for incomming msg %s",
535                 cpt+1,cb,msg.type->name);
536           if ((*cb)(&ctx,msg.payl)) {
537             /* cb handled the message */
538             free(msg.payl);
539             ran_ok = 1;
540           }
541         }
542       }
543     } CATCH(e) {
544       free(msg.payl);
545       if (msg.type->kind == e_gras_msg_kind_rpccall) {
546         /* The callback raised an exception, propagate it on the network */
547         if (!e.remote) { /* the exception is born on this machine */
548           e.host = (char*)gras_os_myname();
549           xbt_ex_setup_backtrace(&e);
550         } 
551         VERB4("Propagate %s exception from '%s' RPC cb back to %s:%d",
552               (e.remote ? "remote" : "local"),
553               msg.type->name,
554               gras_socket_peer_name(msg.expe),
555               gras_socket_peer_port(msg.expe));
556         gras_msg_send_ext(msg.expe, e_gras_msg_kind_rpcerror,
557                           msg.ID, msg.type, &e);
558         xbt_ex_free(e);
559         ran_ok=1;
560       } else {
561         RETHROW0("Callback raised an exception: %s");
562       }
563     }
564     if (!ran_ok)
565       THROW1(mismatch_error,0,
566              "Message '%s' refused by all registered callbacks", msg.type->name);
567     /* FIXME: gras_datadesc_free not implemented => leaking the payload */
568     break;
569
570
571   case e_gras_msg_kind_rpcanswer:
572     INFO1("Unexpected RPC answer discarded (type: %s)", msg.type->name);
573     WARN0("FIXME: gras_datadesc_free not implemented => leaking the payload");
574     return;
575
576   case e_gras_msg_kind_rpcerror:
577     INFO1("Unexpected RPC error discarded (type: %s)", msg.type->name);
578     WARN0("FIXME: gras_datadesc_free not implemented => leaking the payload");
579     return;
580
581   default:
582     THROW1(unknown_error,0,
583            "Cannot handle messages of kind %d yet",msg.type->kind);
584   }
585
586 }
587
588 void
589 gras_cbl_free(void *data){
590   gras_cblist_t *list=*(void**)data;
591   if (list) {
592     xbt_dynar_free(&( list->cbs ));
593     free(list);
594   }
595 }
596
597 /** \brief Bind the given callback to the given message type 
598  *
599  * Several callbacks can be attached to a given message type. The lastly added one will get the message first, and 
600  * if it returns false, the message will be passed to the second one. 
601  * And so on until one of the callbacks accepts the message.
602  */
603 void
604 gras_cb_register(gras_msgtype_t msgtype,
605                  gras_msg_cb_t cb) {
606   gras_msg_procdata_t pd=(gras_msg_procdata_t)gras_libdata_by_id(gras_msg_libdata_id);
607   gras_cblist_t *list=NULL;
608   int cpt;
609
610   DEBUG2("Register %p as callback to '%s'",cb,msgtype->name);
611
612   /* search the list of cb for this message on this host (creating if NULL) */
613   xbt_dynar_foreach(pd->cbl_list,cpt,list) {
614     if (list->id == msgtype->code) {
615       break;
616     } else {
617       list=NULL;
618     }
619   }
620   if (!list) {
621     /* First cb? Create room */
622     list = xbt_new(gras_cblist_t,1);
623     list->id = msgtype->code;
624     list->cbs = xbt_dynar_new(sizeof(gras_msg_cb_t), NULL);
625     xbt_dynar_push(pd->cbl_list,&list);
626   }
627
628   /* Insert the new one into the set */
629   xbt_dynar_insert_at(list->cbs,0,&cb);
630 }
631
632 /** \brief Unbind the given callback from the given message type */
633 void
634 gras_cb_unregister(gras_msgtype_t msgtype,
635                    gras_msg_cb_t cb) {
636
637   gras_msg_procdata_t pd=(gras_msg_procdata_t)gras_libdata_by_id(gras_msg_libdata_id);
638   gras_cblist_t *list;
639   gras_msg_cb_t cb_cpt;
640   int cpt;
641   int found = 0;
642
643   /* search the list of cb for this message on this host */
644   xbt_dynar_foreach(pd->cbl_list,cpt,list) {
645     if (list->id == msgtype->code) {
646       break;
647     } else {
648       list=NULL;
649     }
650   }
651
652   /* Remove it from the set */
653   if (list) {
654     xbt_dynar_foreach(list->cbs,cpt,cb_cpt) {
655       if (cb == cb_cpt) {
656         xbt_dynar_cursor_rm(list->cbs, &cpt);
657         found = 1;
658       }
659     }
660   }
661   if (!found)
662     VERB1("Ignoring removal of unexisting callback to msg id %d",
663           msgtype->code);
664 }
665
666 /** \brief Retrieve the expeditor of the message */
667 gras_socket_t gras_msg_cb_ctx_from(gras_msg_cb_ctx_t ctx) {
668   return ctx->expeditor;
669 }