X-Git-Url: http://bilbo.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/blobdiff_plain/4e0b0a957106c8c55b7aa24f118ed5862e98064d..3c79423e7376662ff7bcfa809c4803564cf82acb:/src/gras/Msg/msg.c

diff --git a/src/gras/Msg/msg.c b/src/gras/Msg/msg.c
index c197ddd637..50c529f1db 100644
--- a/src/gras/Msg/msg.c
+++ b/src/gras/Msg/msg.c
@@ -2,26 +2,53 @@
 
 /* messaging - Function related to messaging (code shared between RL and SG)*/
 
-/* Authors: Martin Quinson                                                  */
-/* Copyright (C) 2003 the OURAGAN project.                                  */
+/* Copyright (c) 2003, 2004 Martin Quinson. All rights reserved.            */
 
 /* This program is free software; you can redistribute it and/or modify it
-   under the terms of the license (GNU LGPL) which comes with this package. */
+ * under the terms of the license (GNU LGPL) which comes with this package. */
+
 
 #include "gras/Msg/msg_private.h"
 #include "gras/DataDesc/datadesc_interface.h"
 #include "gras/Transport/transport_interface.h" /* gras_trp_chunk_send/recv */
 #include "gras/Virtu/virtu_interface.h"
 
-XBT_LOG_NEW_DEFAULT_SUBCATEGORY(msg,gras,"High level messaging");
+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);
 
-/**
- * gras_msg_init:
- *
+/*
+ * 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(gras_msg_t),     NULL);
+   res->cbl_list  = xbt_dynar_new(sizeof(gras_cblist_t *),gras_cbl_free);
+   
+   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 ));
+}
+
+/*
+ * Module registration
+ */
+void gras_msg_register() {
+   gras_procdata_add("gras_msg",gras_msg_procdata_new, gras_msg_procdata_free);
+}
+
+/*
  * Initialize this submodule.
  */
 void gras_msg_init(void) {
@@ -38,20 +65,16 @@ void gras_msg_init(void) {
   GRAS_header[5]=(char)GRAS_THISARCH;
 }
 
-/**
- * gras_msg_exit:
- *
+/*
  * Finalize the msg module
- **/
+ */
 void
 gras_msg_exit(void) {
   VERB0("Exiting Msg");
   xbt_set_free(&_gras_msgtype_set);
 }
 
-/**
- * gras_msgtype_free:
- *
+/*
  * Reclamed memory
  */
 void gras_msgtype_free(void *t) {
@@ -82,23 +105,21 @@ static char *make_namev(const char *name, short int ver) {
   return namev;
 }
 
-/**
- * gras_msgtype_declare:
- * @name: name as it should be used for logging messages (must be uniq)
- * @payload: datadescription of the payload
+/** @brief declare a new message type of the given name. It only accepts the given datadesc as payload
  *
- * Registers a message to the GRAS mecanism.
+ * @param name: name as it should be used for logging messages (must be uniq)
+ * @param payload: datadescription of the payload
  */
 void gras_msgtype_declare(const char           *name,
 			  gras_datadesc_type_t  payload) {
    gras_msgtype_declare_v(name, 0, payload);
 }
 
-/**
- * gras_msgtype_declare_v:
- * @name: name as it should be used for logging messages (must be uniq)
- * @version: something like versionning symbol
- * @payload: datadescription of the 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 
  * gras_msgtype_declare when you change the semantic or syntax of a message and
@@ -143,19 +164,12 @@ gras_msgtype_declare_v(const char           *name,
 	       &gras_msgtype_free);
 }
 
-/**
- * gras_msgtype_by_name:
- *
- * Retrieve a datatype 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);
 }
-/**
- * gras_msgtype_by_namev:
- *
- * Retrieve a datatype 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;
@@ -175,11 +189,8 @@ gras_msgtype_t gras_msgtype_by_namev(const char      *name,
   return res;
 }
 
-/**
- * gras_msg_send:
- *
- * 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,
@@ -207,9 +218,7 @@ gras_msg_send(gras_socket_t   sock,
 
   return no_error;
 }
-/**
- * gras_msg_recv:
- *
+/*
  * receive the next message on the given socket.  
  */
 xbt_error_t
@@ -262,16 +271,16 @@ gras_msg_recv(gras_socket_t    sock,
   return no_error;
 }
 
-/**
- * gras_msg_wait:
- * @timeout: How long should we wait for this message.
- * @id: id of awaited msg
- * @Returns: the error code (or no_error).
+/** \brief Waits for a message to come in over a given socket. 
  *
- * 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
+ * @param[out] payload: where to write the payload of 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,    
@@ -284,7 +293,7 @@ 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;
   
@@ -336,13 +345,12 @@ gras_msg_wait(double           timeout,
   RAISE_IMPOSSIBLE;
 }
 
-/**
- * gras_msg_handle:
- * @timeOut: How long to wait for incoming messages
- * @Returns: the error code (or no_error).
+/** @brief Handle an incomming message or timer (or wait up to \a timeOut seconds)
+ *
+ * @param timeOut: How long to wait for incoming messages
+ * @return the error code (or no_error).
  *
- * Waits up to #timeOut# seconds to see if a message comes in; if so, calls the
- * registered listener for that message (see RegisterCallback()).
+ * Messages are passed to the callbacks.
  */
 xbt_error_t 
 gras_msg_handle(double timeOut) {
@@ -356,11 +364,9 @@ gras_msg_handle(double timeOut) {
   int             payload_size;
   gras_msgtype_t  msgtype;
 
-  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;
-
-
+  gras_msg_cb_t       cb;
 
   VERB1("Handling message within the next %.2fs",timeOut);
   
@@ -392,8 +398,8 @@ gras_msg_handle(double timeOut) {
   }
   
   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);
@@ -415,10 +421,16 @@ 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. 
+ * 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;
 
@@ -436,7 +448,7 @@ gras_cb_register(gras_msgtype_t msgtype,
     /* 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);
   }
 
@@ -444,13 +456,14 @@ gras_cb_register(gras_msgtype_t msgtype,
   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;