Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
Split up a too long file, taking the oportunity to sanitize the file naming spacec
[simgrid.git] / src / gras / Msg / msg.c
index 3d1293a..b24b4c5 100644 (file)
@@ -35,9 +35,12 @@ static void *gras_msg_procdata_new() {
    
    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);
+   res->msg_queue     = xbt_dynar_new(sizeof(s_gras_msg_t),   NULL);
+   res->msg_waitqueue = 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);
+   res->msg_to_receive_queue = xbt_fifo_new();
+   res->msg_to_receive_queue_meas = xbt_fifo_new();
    
    return (void*)res;
 }
@@ -49,8 +52,11 @@ 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->msg_waitqueue ));
    xbt_dynar_free(&( res->cbl_list ));
    xbt_dynar_free(&( res->timers ));
+   xbt_fifo_free( res->msg_to_receive_queue );
+   xbt_fifo_free( res->msg_to_receive_queue_meas );
 
    free(res->name);
    free(res);
@@ -79,6 +85,12 @@ void gras_msg_init(void) {
   memcpy(_GRAS_header,"GRAS", 4);
   _GRAS_header[4]=GRAS_PROTOCOL_VERSION;
   _GRAS_header[5]=(char)GRAS_THISARCH;
+   
+  gras_msg_ctx_mallocator = 
+     xbt_mallocator_new(1000,
+                       gras_msg_ctx_mallocator_new_f,
+                       gras_msg_ctx_mallocator_free_f,
+                       gras_msg_ctx_mallocator_reset_f);
 }
 
 /*
@@ -88,6 +100,8 @@ void
 gras_msg_exit(void) {
   VERB0("Exiting Msg");
   xbt_set_free(&_gras_msgtype_set);
+
+  xbt_mallocator_free(gras_msg_ctx_mallocator);
 }
 
 /*
@@ -100,6 +114,23 @@ void gras_msgtype_free(void *t) {
     free(msgtype);
   }
 }
+/**
+ * Dump all declared message types (debugging purpose)
+ */
+void gras_msgtype_dumpall(void) {   
+  xbt_set_cursor_t cursor;
+  gras_msgtype_t msgtype=NULL;
+   
+  INFO0("Dump of all registered messages:");
+  xbt_set_foreach(_gras_msgtype_set, cursor, msgtype) {
+    INFO6("  Message name: %s (v%d) %s; %s%s%s", 
+         msgtype->name, msgtype->version, e_gras_msg_kind_names[msgtype->kind],
+         gras_datadesc_get_name(msgtype->ctn_type),
+         (msgtype->kind==e_gras_msg_kind_rpccall ? " -> ":""),
+         (msgtype->kind==e_gras_msg_kind_rpccall ? gras_datadesc_get_name(msgtype->answer_type) : ""));
+  }   
+}
+
 
 /**
  * make_namev:
@@ -214,24 +245,41 @@ gras_msgtype_declare_v(const char           *name,
                            e_gras_msg_kind_oneway, payload, NULL);
 }
 
-/** @brief retrieve an existing message type from its name. */
+/** @brief retrieve an existing message type from its name (raises an exception if it does not exist). */
 gras_msgtype_t gras_msgtype_by_name (const char *name) {
   return gras_msgtype_by_namev(name,0);
 }
+/** @brief retrieve an existing message type from its name (or NULL if it does not exist). */
+gras_msgtype_t gras_msgtype_by_name_or_null (const char *name) {
+  xbt_ex_t e;
+  gras_msgtype_t res = NULL;
+   
+  TRY {
+     res = gras_msgtype_by_namev(name,0);
+  } CATCH(e) {
+     res = NULL;
+     xbt_ex_free(e);
+  }
+  return res;
+}
 
 /** @brief retrieve 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 = NULL;
-  char *namev = make_namev(name,version); 
+  char *namev = make_namev(name,version);
+  volatile int found=0;
   xbt_ex_t e;
 
   TRY {
     res = (gras_msgtype_t)xbt_set_get_by_name(_gras_msgtype_set, namev);
+    found=1;
   } CATCH(e) {
     xbt_ex_free(e);
-    THROW1(not_found_error,0,"No registred message of that name: %s",name);
   }
+  if (!found)
+    THROW1(not_found_error,0,"No registred message of that name: %s",name);
+
   if (name != namev) 
     free(namev);
   
@@ -256,7 +304,7 @@ gras_msgtype_t gras_msgtype_by_id(int id) {
  */
 
 void
-gras_msg_wait_ext(double           timeout,    
+gras_msg_wait_ext_(double           timeout,    
 
                  gras_msgtype_t   msgt_want,
                  gras_socket_t    expe_want,
@@ -272,9 +320,21 @@ gras_msg_wait_ext(double           timeout,
 
   xbt_assert0(msg_got,"msg_got is an output parameter");
 
+  start = gras_os_time();
   VERB1("Waiting for message '%s'",msgt_want?msgt_want->name:"(any)");
 
-  start = now = gras_os_time();
+  xbt_dynar_foreach(pd->msg_waitqueue,cpt,msg){
+    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_waitqueue, &cpt);
+      VERB0("The waited message was queued");
+      return;
+    }
+  }
 
   xbt_dynar_foreach(pd->msg_queue,cpt,msg){
     if ( (   !msgt_want || (msg.type->code == msgt_want->code)) 
@@ -290,10 +350,30 @@ gras_msg_wait_ext(double           timeout,
   }
 
   while (1) {
+    int need_restart;
+    xbt_ex_t e;
+
+  restart_receive: /* Goto here when the receive of a message failed */
+    need_restart=0;
+    now=gras_os_time();
     memset(&msg,sizeof(msg),0);
 
-    msg.expe = gras_trp_select(timeout ? timeout - now + start : 0);
-    gras_msg_recv(msg.expe, &msg);
+    TRY {
+      msg.expe = gras_trp_select(timeout ? timeout - now + start : 0);
+      gras_msg_recv(msg.expe, &msg);
+    } CATCH(e) {
+      if (e.category == system_error &&
+         !strncmp("Socket closed by remote side",e.msg,
+                 strlen("Socket closed by remote side"))) {
+       xbt_ex_free(e);
+       need_restart=1;
+      }        else {
+       RETHROW;
+      }
+    }
+    if (need_restart)
+      goto restart_receive;
+
     DEBUG0("Got a message from the socket");
 
     if ( (   !msgt_want || (msg.type->code == msgt_want->code)) 
@@ -332,15 +412,15 @@ gras_msg_wait_ext(double           timeout,
  * 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_(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);
+  gras_msg_wait_ext_(timeout,
+                    msgt_want, NULL,      NULL, NULL,
+                    &msg);
 
   if (msgt_want->ctn_type) {
     xbt_assert1(payload,
@@ -393,10 +473,10 @@ void gras_msg_wait_or(double         timeout,
   s_gras_msg_t msg;
 
   VERB1("Wait %f seconds for several message types",timeout);
-  gras_msg_wait_ext(timeout,
-                   NULL, NULL,      
-                   &gras_msg_wait_or_filter, (void*)msgt_want,
-                   &msg);
+  gras_msg_wait_ext_(timeout,
+                    NULL, NULL,      
+                    &gras_msg_wait_or_filter, (void*)msgt_want,
+                    &msg);
 
   if (msg.type->ctn_type) {
     xbt_assert1(payload,
@@ -410,7 +490,8 @@ void gras_msg_wait_or(double         timeout,
   }
 
   if (ctx) 
-    *ctx=gras_msg_cb_ctx_new(msg.expe,msg.type,msg.ID,60);
+    *ctx=gras_msg_cb_ctx_new(msg.expe, msg.type, msg.ID,
+                            (msg.kind == e_gras_msg_kind_rpccall), 60);
 
   if (msgt_got)
     *msgt_got = xbt_dynar_search(msgt_want,msg.type);
@@ -420,7 +501,7 @@ void gras_msg_wait_or(double         timeout,
 /** \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_msg_send_(gras_socket_t   sock,
              gras_msgtype_t  msgtype,
              void           *payload) {
 
@@ -443,8 +524,7 @@ gras_msg_send(gras_socket_t   sock,
 
 /** @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).
+ * @param period: How long to wait for incoming messages (in seconds)
  *
  * 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
@@ -460,7 +540,8 @@ gras_msg_handleall(double period) {
   do {
     now=gras_os_time();
     TRY{
-      gras_msg_handle(period - now + begin);
+      if (period - now + begin > 0)
+       gras_msg_handle(period - now + begin);
     } CATCH(e) {
       if (e.category != timeout_error) 
        RETHROW0("Error while waiting for messages: %s");
@@ -468,6 +549,7 @@ gras_msg_handleall(double period) {
     }
   } 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)
@@ -480,7 +562,8 @@ gras_msg_handle(double timeOut) {
   
   double          untiltimer;
    
-  int             cpt, ran_ok;
+  int             cpt;
+  int volatile ran_ok;
 
   s_gras_msg_t    msg;
 
@@ -572,16 +655,17 @@ gras_msg_handle(double timeOut) {
     }
   }
   if (!list) {
-    INFO3("No callback for the incomming '%s' message (from %s:%d). Discarded.", 
+    INFO3("No callback for message '%s' from %s:%d. Queue it for later gras_msg_wait() use.",
          msg.type->name,
          gras_socket_peer_name(msg.expe),gras_socket_peer_port(msg.expe));
-    WARN0("FIXME: gras_datadesc_free not implemented => leaking the payload");
-    return;
+    xbt_dynar_push(pd->msg_waitqueue,&msg);
+    return; /* FIXME: maybe we should call ourselves again until the end of the timer or a proper msg is got */
   }
   
   ctx.expeditor = msg.expe;
   ctx.ID = msg.ID;
   ctx.msgtype = msg.type;
+  ctx.answer_due = (msg.kind == e_gras_msg_kind_rpccall);
 
   switch (msg.kind) {
   case e_gras_msg_kind_oneway:
@@ -590,9 +674,9 @@ gras_msg_handle(double timeOut) {
     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)) {
+         DEBUG4("Use the callback #%d (@%p) for incomming msg %s (payload_size=%d)",
+               cpt+1,cb,msg.type->name,msg.payl_size);
+         if (!(*cb)(&ctx,msg.payl)) {
            /* cb handled the message */
            free(msg.payl);
            ran_ok = 1;
@@ -602,8 +686,14 @@ gras_msg_handle(double timeOut) {
     } CATCH(e) {
       free(msg.payl);
       if (msg.type->kind == e_gras_msg_kind_rpccall) {
+       char *old_file=e.file;
        /* The callback raised an exception, propagate it on the network */
-       if (!e.remote) { /* the exception is born on this machine */
+       if (!e.remote) { 
+         /* Make sure we reduce the file name to its basename to avoid issues in tests */
+         char *new_file=strrchr(e.file,'/');
+         if (new_file)
+            e.file = new_file;
+         /* the exception is born on this machine */
          e.host = (char*)gras_os_myname();
          xbt_ex_setup_backtrace(&e);
        } 
@@ -615,12 +705,17 @@ gras_msg_handle(double timeOut) {
              gras_socket_peer_port(msg.expe));
        gras_msg_send_ext(msg.expe, e_gras_msg_kind_rpcerror,
                          msg.ID, msg.type, &e);
+       e.file=old_file;
        xbt_ex_free(e);
+       ctx.answer_due = 0;
        ran_ok=1;
       } else {
        RETHROW0("Callback raised an exception: %s");
       }
     }
+    xbt_assert0(!(ctx.answer_due),
+               "RPC callback didn't call gras_msg_rpcreturn");
+
     if (!ran_ok)
       THROW1(mismatch_error,0,
             "Message '%s' refused by all registered callbacks", msg.type->name);
@@ -657,12 +752,12 @@ gras_cbl_free(void *data){
 /** \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. 
+ * if it returns a non-null value, 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_msg_cb_t cb) {
+gras_cb_register_(gras_msgtype_t msgtype,
+                 gras_msg_cb_t cb) {
   gras_msg_procdata_t pd=(gras_msg_procdata_t)gras_libdata_by_id(gras_msg_libdata_id);
   gras_cblist_t *list=NULL;
   int cpt;
@@ -691,8 +786,8 @@ gras_cb_register(gras_msgtype_t msgtype,
 
 /** \brief Unbind the given callback from the given message type */
 void
-gras_cb_unregister(gras_msgtype_t msgtype,
-                  gras_msg_cb_t cb) {
+gras_cb_unregister_(gras_msgtype_t msgtype,
+                   gras_msg_cb_t cb) {
 
   gras_msg_procdata_t pd=(gras_msg_procdata_t)gras_libdata_by_id(gras_msg_libdata_id);
   gras_cblist_t *list;
@@ -731,12 +826,15 @@ gras_socket_t gras_msg_cb_ctx_from(gras_msg_cb_ctx_t ctx) {
 gras_msg_cb_ctx_t gras_msg_cb_ctx_new(gras_socket_t expe, 
                                      gras_msgtype_t msgtype,
                                      unsigned long int ID,
+                                     int answer_due,
                                      double timeout) {
   gras_msg_cb_ctx_t res=xbt_new(s_gras_msg_cb_ctx_t,1);
   res->expeditor = expe;
   res->msgtype = msgtype;
   res->ID = ID;
   res->timeout = timeout;
+  res->answer_due = answer_due;
+
   return res;
 }
 /* \brief Frees a message exchange context