X-Git-Url: http://info.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/blobdiff_plain/c95af2aa8d7618ca682fd1dadee72afd4847c0f5..a30eb8d63c2291f6b50b935cecf16139b372f9f2:/src/gras/DataDesc/ddt_create.c

diff --git a/src/gras/DataDesc/ddt_create.c b/src/gras/DataDesc/ddt_create.c
index 408ef38a5d..0bbc088f2b 100644
--- a/src/gras/DataDesc/ddt_create.c
+++ b/src/gras/DataDesc/ddt_create.c
@@ -10,10 +10,15 @@
  * under the terms of the license (GNU LGPL) which comes with this package. */
 
 #include "xbt/misc.h" /* min()/max() */
+#include "xbt/ex.h"
 #include "gras/DataDesc/datadesc_private.h"
 
 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(ddt_create,datadesc,"Creating new datadescriptions");
 
+/*** prototypes ***/
+static gras_dd_cat_field_t
+  gras_dd_find_field(gras_datadesc_type_t  type,
+		     const char           *field_name);
 /**
  * gras_ddt_freev:
  *
@@ -44,40 +49,40 @@ static gras_datadesc_type_t gras_ddt_new(const char *name) {
 }
 
 /**
- * gras_datadesc_by_name:
- *
- * Retrieve a type from its name
+ * This returns NULL no type of this name can be found instead of throwing exceptions which would complicate the GRAS_DEFINE_TYPE macro
  */
 gras_datadesc_type_t gras_datadesc_by_name(const char *name) {
-
-  gras_datadesc_type_t type;
-
-  XBT_IN1("(%s)",name);
-  if (xbt_set_get_by_name(gras_datadesc_set_local,
-			   name,(xbt_set_elm_t*)&type) == no_error) {
-    XBT_OUT;
-    return type;
-  } else { 
-    XBT_OUT;
-    return NULL;
+  xbt_ex_t e;
+  gras_datadesc_type_t res = NULL;
+  TRY {
+    res = (gras_datadesc_type_t)xbt_set_get_by_name(gras_datadesc_set_local,name);
+  } CATCH(e) {
+    if (e.category != not_found_error)
+      RETHROW;
+    xbt_ex_free(&e);
+    res = NULL;
   }
+  return res;
 }
 
 /**
- * gras_datadesc_by_id:
- *
- * Retrieve a type from its code
+ * Retrieve a type from its code (or NULL if not found)
  */
-xbt_error_t gras_datadesc_by_id(long int              code,
-				 gras_datadesc_type_t *type) {
-  XBT_IN;
-  return xbt_set_get_by_id(gras_datadesc_set_local,
-			    code,(xbt_set_elm_t*)type);
+gras_datadesc_type_t gras_datadesc_by_id(long int code) {
+  xbt_ex_t e;
+  gras_datadesc_type_t res=NULL;
+  TRY {
+    res = (gras_datadesc_type_t)xbt_set_get_by_id(gras_datadesc_set_local,code);
+  } CATCH(e) {
+    if (e.category != not_found_error)
+      RETHROW;
+    xbt_ex_free(&e);
+    res = NULL;
+  }
+  return res;
 }
 
 /**
- * gras_datadesc_scalar:
- *
  * Create a new scalar and give a pointer to it 
  */
 gras_datadesc_type_t 
@@ -99,7 +104,7 @@ gras_datadesc_type_t
 		 "Redefinition of type %s does not match", name);
     VERB1("Discarding redefinition of %s",name);
     return res;
-  }
+  } 
   res = gras_ddt_new(name);
 
   for (arch = 0; arch < gras_arch_count; arch ++) {
@@ -117,27 +122,19 @@ gras_datadesc_type_t
 }
 
 
-/**
- * gras_dd_cat_field_free:
- *
- * Frees one struct or union field
- */
+/** Frees one struct or union field */
 void gras_dd_cat_field_free(void *f) {
   gras_dd_cat_field_t field = *(gras_dd_cat_field_t *)f;
   XBT_IN;
   if (field) {
     if (field->name) 
-      xbt_free(field->name);
-    xbt_free(field);
+      free(field->name);
+    free(field);
   }
   XBT_OUT;
 }
 
-/**
- * gras_datadesc_struct:
- *
- * Create a new struct and give a pointer to it 
- */
+/** \brief Declare a new structure description */
 gras_datadesc_type_t 
   gras_datadesc_struct(const char            *name) {
 
@@ -169,11 +166,7 @@ gras_datadesc_type_t
   return res;
 }
 
-/**
- * gras_datadesc_struct_append:
- *
- * Append a field to the struct
- */
+/** \brief Append a new field to a structure description */
 void
 gras_datadesc_struct_append(gras_datadesc_type_t struct_type,
 			    const char          *name,
@@ -217,8 +210,8 @@ gras_datadesc_struct_append(gras_datadesc_type_t struct_type,
 					      struct_type->alignment[arch]);
   }
   field->type   = field_type;
-  field->pre    = NULL;
-  field->post   = NULL;
+  field->send   = NULL;
+  field->recv   = NULL;
   
   xbt_dynar_push(struct_type->category.struct_data.fields, &field);
 
@@ -235,6 +228,10 @@ gras_datadesc_struct_append(gras_datadesc_type_t struct_type,
   XBT_OUT;
 }
 
+/** \brief Close a structure description
+ * 
+ * No new field can be added afterward, and it is mandatory to close the structure before using it.
+ */
 void
 gras_datadesc_struct_close(gras_datadesc_type_t struct_type) {
   XBT_IN;
@@ -249,8 +246,8 @@ gras_datadesc_struct_close(gras_datadesc_type_t struct_type) {
 /**
  * gras_datadesc_cycle_set:
  * 
- * Tell GRAS that the pointers of the type described by @ddt may present
- * some loop, and that the cycle detection mecanism is needed.
+ * Tell GRAS that the pointers of the type described by ddt may present
+ * some loop, and that the cycle detection mechanism is needed.
  *
  * Note that setting this option when not needed have a rather bad effect 
  * on the performance (several times slower on big data).
@@ -259,11 +256,12 @@ void
 gras_datadesc_cycle_set(gras_datadesc_type_t ddt) {
   ddt->cycle = 1;
 }
+
 /**
  * gras_datadesc_cycle_unset:
  * 
- * Tell GRAS that the pointers of the type described by @ddt do not present
- * any loop and that cycle detection mecanism are not needed.
+ * Tell GRAS that the pointers of the type described by ddt do not present
+ * any loop and that cycle detection mechanism are not needed.
  * (default)
  */
 void
@@ -271,14 +269,10 @@ gras_datadesc_cycle_unset(gras_datadesc_type_t ddt) {
   ddt->cycle = 0;
 }
 
-/**
- * gras_datadesc_union:
- *
- * Create a new union and give a pointer to it 
- */
+/** \brief Declare a new union description */
 gras_datadesc_type_t 
-gras_datadesc_union(const char                   *name,
-		    gras_datadesc_type_cb_int_t   selector) {
+  gras_datadesc_union(const char                   *name,
+		      gras_datadesc_type_cb_int_t   selector) {
 
   gras_datadesc_type_t res;
   int arch;
@@ -315,15 +309,10 @@ gras_datadesc_union(const char                   *name,
   return res;
 }
 
-/**
- * gras_datadesc_union_append:
- *
- * Append a field to the union
- */
-void
-gras_datadesc_union_append(gras_datadesc_type_t  union_type,
-			   const char           *name,
-			   gras_datadesc_type_t  field_type) {
+/** \brief Append a new field to an union description */
+void gras_datadesc_union_append(gras_datadesc_type_t  union_type,
+				const char           *name,
+				gras_datadesc_type_t  field_type) {
 
   gras_dd_cat_field_t field;
   int arch;
@@ -357,15 +346,17 @@ gras_datadesc_union_append(gras_datadesc_type_t  union_type,
   }
 }
 
+
+/** \brief Close an union description 
+ *
+ * No new field can be added afterward, and it is mandatory to close the union before using it.
+ */
 void
 gras_datadesc_union_close(gras_datadesc_type_t union_type) {
    union_type->category.union_data.closed = 1;
 }
-/**
- * gras_datadesc_ref:
- *
- * Create a new ref to a fixed type and give a pointer to it 
- */
+
+/** \brief Declare a new type being a reference to the one passed in arg */
 gras_datadesc_type_t 
   gras_datadesc_ref(const char           *name,
 		    gras_datadesc_type_t  referenced_type) {
@@ -403,10 +394,11 @@ gras_datadesc_type_t
 
   return res;
 }
-/**
- * gras_datadesc_ref_generic:
- *
- * Create a new ref to a type given at use time, and give a pointer to it 
+/** \brief Declare a new type being a generic reference.
+ * 
+ * The callback passed in argument is to be used to select which type is currently used.
+ * So, when GRAS wants to send a generic reference, it passes the current data to the selector 
+ * callback and expects it to return the type description to use. 
  */
 gras_datadesc_type_t 
   gras_datadesc_ref_generic(const char                *name,
@@ -418,6 +410,7 @@ gras_datadesc_type_t
 
   XBT_IN1("(%s)",name);
   res = gras_datadesc_by_name(name);
+
   if (res) {
     xbt_assert1(res->category_code == e_gras_datadesc_type_cat_ref,
 		 "Redefinition of type %s does not match", name);
@@ -446,11 +439,7 @@ gras_datadesc_type_t
   return res;
 }
 
-/**
- * gras_datadesc_array_fixed:
- *
- * Create a new array and give a pointer to it 
- */
+/** \brief Declare a new type being an array of fixed size and content */
 gras_datadesc_type_t 
   gras_datadesc_array_fixed(const char           *name,
 			    gras_datadesc_type_t  element_type,
@@ -464,8 +453,13 @@ gras_datadesc_type_t
   if (res) {
     xbt_assert1(res->category_code == e_gras_datadesc_type_cat_array,
 		 "Redefinition of type %s does not match", name);
-    xbt_assert1(res->category.array_data.type == element_type,
-		 "Redefinition of type %s does not match", name);
+     
+    if (res->category.array_data.type != element_type) {
+       ERROR1("Redefinition of type %s does not match: array elements differ", name);
+       gras_datadesc_type_dump(res->category.array_data.type);
+       gras_datadesc_type_dump(element_type);
+    }
+     
     xbt_assert1(res->category.array_data.fixed_size == fixed_size,
 		 "Redefinition of type %s does not match", name);
     xbt_assert1(res->category.array_data.dynamic_size == NULL,
@@ -491,15 +485,11 @@ gras_datadesc_type_t
 
   return res;
 }
-/**
- * gras_datadesc_array_dyn:
- *
- * Create a new array and give a pointer to it 
- */
-gras_datadesc_type_t 
-  gras_datadesc_array_dyn(const char                  *name,
-			  gras_datadesc_type_t         element_type,
-			  gras_datadesc_type_cb_int_t  dynamic_size) {
+
+/** \brief Declare a new type being an array of fixed size, but accepting several content types. */
+gras_datadesc_type_t gras_datadesc_array_dyn(const char                 *name,
+					     gras_datadesc_type_t        element_type,
+					     gras_datadesc_type_cb_int_t dynamic_size) {
 
   gras_datadesc_type_t res;
   int arch;
@@ -541,9 +531,8 @@ gras_datadesc_type_t
   return res;
 }
 
-/**
- * gras_datadesc_ref_pop_arr:
- *
+/** \brief Declare a new type being an array which size can be found with \ref gras_cbps_i_pop 
+ * 
  * Most of the time, you want to include a reference in your structure which
  * is a pointer to a dynamic array whose size is fixed by another field of 
  * your structure.
@@ -578,22 +567,75 @@ gras_datadesc_type_t
   sprintf(name,"%s[]*",element_type->name);
   res = gras_datadesc_ref(name,res);
 
-  xbt_free(name);
+  free(name);
+
+  return res;
+}
+
+#include "xbt/dynar_private.h"
+static void gras_datadesc_dynar_cb(gras_datadesc_type_t typedesc, gras_cbps_t vars, void *data) {
+  gras_datadesc_type_t subtype;
+  xbt_dynar_t dynar=(xbt_dynar_t)data;
+   
+  memcpy(&dynar->free_f, &typedesc->extra, sizeof(dynar->free_f));
+
+  /* search for the elemsize in what we have. If elements are "int", typedesc got is "int[]*" */
+  subtype = gras_dd_find_field(typedesc,"data")->type;
+  
+  /* this is now a ref to array of what we're looking for */
+  subtype = subtype->category.ref_data.type;
+  subtype = subtype->category.array_data.type;
+   
+  DEBUG1("subtype is %s",subtype->name);
+
+  dynar->elmsize = subtype->size[GRAS_THISARCH];
+  dynar->size = dynar->used;
+}
+
+gras_datadesc_type_t
+gras_datadesc_dynar(gras_datadesc_type_t elm_t,
+		    void_f_pvoid_t *free_func) {
+   
+  char *buffname;
+  gras_datadesc_type_t res;
+  
+  buffname=xbt_new0(char, strlen(elm_t->name)+10);
+  sprintf(buffname,"dynar(%s)_s",elm_t->name);
+   
+  res = gras_datadesc_struct(buffname);
+  
+  gras_datadesc_struct_append(res, "size",    gras_datadesc_by_name("unsigned long int"));
+   
+  gras_datadesc_struct_append(res, "used",    gras_datadesc_by_name("unsigned long int"));
+  gras_datadesc_cb_field_push(res, "used");
+   
+  gras_datadesc_struct_append(res, "elmsize", gras_datadesc_by_name("unsigned long int"));
+   
+  gras_datadesc_struct_append(res, "data",    gras_datadesc_ref_pop_arr (elm_t));
+
+  gras_datadesc_struct_append(res, "free_f",  gras_datadesc_by_name("function pointer"));
+  memcpy(res->extra,&free_func,sizeof(free_func));
+      
+  gras_datadesc_struct_close(res);
+   
+  gras_datadesc_cb_recv(res,  &gras_datadesc_dynar_cb);
 
+  /* build a ref to it */
+  sprintf(buffname,"dynar(%s)",elm_t->name);
+  res=gras_datadesc_ref(buffname,res);
+  free(buffname);
   return res;
 }
-xbt_error_t
+
+
+gras_datadesc_type_t
 gras_datadesc_import_nws(const char           *name,
 			 const DataDescriptor *desc,
-			 unsigned long         howmany,
-	       /* OUT */ gras_datadesc_type_t *dst) {
-  RAISE_UNIMPLEMENTED;
+			 unsigned long         howmany) {
+  THROW_UNIMPLEMENTED;
 }
 
 /**
- * gras_datadesc_cb_send:
- *
- * Add a pre-send callback to this datadesc.
  * (useful to push the sizes of the upcoming arrays, for example)
  */
 void gras_datadesc_cb_send (gras_datadesc_type_t          type,
@@ -601,21 +643,18 @@ void gras_datadesc_cb_send (gras_datadesc_type_t          type,
   type->send = send;
 }
 /**
- * gras_datadesc_cb_recv:
- *
- * Add a post-receive callback to this datadesc.
  * (useful to put the function pointers to the rigth value, for example)
  */
 void gras_datadesc_cb_recv(gras_datadesc_type_t          type,
 			   gras_datadesc_type_cb_void_t  recv) {
   type->recv = recv;
 }
-/**
+/*
  * gras_dd_find_field:
  * 
  * Returns the type descriptor of the given field. Abort on error.
  */
-static gras_datadesc_type_t 
+static gras_dd_cat_field_t
   gras_dd_find_field(gras_datadesc_type_t  type,
 		     const char           *field_name) {
    xbt_dynar_t         field_array;
@@ -633,7 +672,7 @@ static gras_datadesc_type_t
    }
    xbt_dynar_foreach(field_array,field_num,field) {
       if (!strcmp(field_name,field->name)) {
-	 return field->type;
+	 return field;
       }
    }
    ERROR2("No field nammed %s in %s",field_name,type->name);
@@ -642,60 +681,90 @@ static gras_datadesc_type_t
 }
 				  
 /**
- * gras_datadesc_cb_field_send:
- *
- * Add a pre-send callback to the given field of the datadesc (which must be a struct or union).
+ * The given datadesc must be a struct or union (abort if not).
  * (useful to push the sizes of the upcoming arrays, for example)
  */
 void gras_datadesc_cb_field_send (gras_datadesc_type_t          type,
 				  const char                   *field_name,
 				  gras_datadesc_type_cb_void_t  send) {
    
-   gras_datadesc_type_t sub_type=gras_dd_find_field(type,field_name);   
-   sub_type->send = send;
+   gras_dd_cat_field_t field=gras_dd_find_field(type,field_name);   
+   field->send = send;
 }
 
+
 /**
- * gras_datadesc_cb_field_push:
- *
- * Add a pre-send callback to the given field resulting in its value to be pushed to
- * the stack of sizes. It must be a int, unsigned int, long int or unsigned long int.
+ * The value, which must be an int, unsigned int, long int or unsigned long int
+ * is pushed to the stacks of sizes and can then be retrieved with 
+ * \ref gras_datadesc_ref_pop_arr or directly with \ref gras_cbps_i_pop.
  */
 void gras_datadesc_cb_field_push (gras_datadesc_type_t  type,
 				  const char           *field_name) {
    
-   gras_datadesc_type_t sub_type=gras_dd_find_field(type,field_name);
+   gras_dd_cat_field_t  field=gras_dd_find_field(type,field_name);
+   gras_datadesc_type_t sub_type=field->type;
+   
+   DEBUG3("add a PUSHy cb to '%s' field (type '%s') of '%s'",
+	  field_name,sub_type->name,type->name);
    if (!strcmp("int",sub_type->name)) {
-      sub_type->send = gras_datadesc_cb_push_int;
+      field->send = gras_datadesc_cb_push_int;
    } else if (!strcmp("unsigned int",sub_type->name)) {
-      sub_type->send = gras_datadesc_cb_push_uint;
+      field->send = gras_datadesc_cb_push_uint;
    } else if (!strcmp("long int",sub_type->name)) {
-      sub_type->send = gras_datadesc_cb_push_lint;
+      field->send = gras_datadesc_cb_push_lint;
    } else if (!strcmp("unsigned long int",sub_type->name)) {
-      sub_type->send = gras_datadesc_cb_push_ulint;
+      field->send = gras_datadesc_cb_push_ulint;
    } else {
       ERROR1("Field %s is not an int, unsigned int, long int neither unsigned long int",
 	     sub_type->name);
       xbt_abort();
    }
 }
+
 /**
- * gras_datadesc_cb_field_recv:
+ * Any previously pushed value is poped and the field value is multiplied to
+ * it. The result is then pushed back into the stack of sizes. It can then be
+ * retrieved with \ref gras_datadesc_ref_pop_arr or directly with \ref
+ * gras_cbps_i_pop.
  *
- * Add a post-receive callback to the given field of the datadesc (which must be a struct or union).
+ * The field must be an int, unsigned int, long int or unsigned long int.
+ */
+void gras_datadesc_cb_field_push_multiplier (gras_datadesc_type_t  type,
+					     const char         *field_name) {
+   
+   gras_dd_cat_field_t  field=gras_dd_find_field(type,field_name);
+   gras_datadesc_type_t sub_type=field->type;
+   
+   DEBUG3("add a MPUSHy cb to '%s' field (type '%s') of '%s'",
+	  field_name,sub_type->name,type->name);
+   if (!strcmp("int",sub_type->name)) {
+      field->send = gras_datadesc_cb_push_int_mult;
+   } else if (!strcmp("unsigned int",sub_type->name)) {
+      field->send = gras_datadesc_cb_push_uint_mult;
+   } else if (!strcmp("long int",sub_type->name)) {
+      field->send = gras_datadesc_cb_push_lint_mult;
+   } else if (!strcmp("unsigned long int",sub_type->name)) {
+      field->send = gras_datadesc_cb_push_ulint_mult;
+   } else {
+      ERROR1("Field %s is not an int, unsigned int, long int neither unsigned long int",
+	     sub_type->name);
+      xbt_abort();
+   }
+}
+
+/**
+ * The given datadesc must be a struct or union (abort if not).
  * (useful to put the function pointers to the right value, for example)
  */
 void gras_datadesc_cb_field_recv(gras_datadesc_type_t          type,
 				 const char                   *field_name,
 				 gras_datadesc_type_cb_void_t  recv) {
    
-   gras_datadesc_type_t sub_type=gras_dd_find_field(type,field_name);   
-   sub_type->recv = recv;
+   gras_dd_cat_field_t field=gras_dd_find_field(type,field_name);   
+   field->recv = recv;
 }
 
-/**
- * gras_datadesc_free:
- *
+/*
  * Free a datadesc. Should only be called at xbt_exit. 
  */
 void gras_datadesc_free(gras_datadesc_type_t *type) {
@@ -709,13 +778,6 @@ void gras_datadesc_free(gras_datadesc_type_t *type) {
     /* nothing to free in there */
     break;
     
-  case e_gras_datadesc_type_cat_ignored:
-    if ((*type)->category.ignored_data.free_func) {
-      (*type)->category.ignored_data.free_func
-	((*type)->category.ignored_data.default_value);
-    }
-    break;
-    
   case e_gras_datadesc_type_cat_struct:
     xbt_dynar_free(&( (*type)->category.struct_data.fields ));
     break;
@@ -728,8 +790,8 @@ void gras_datadesc_free(gras_datadesc_type_t *type) {
     /* datadesc was invalid. Killing it is like euthanasy, I guess */
     break;
   }
-  xbt_free((*type)->name);
-  xbt_free(*type);
+  free((*type)->name);
+  free(*type);
   type=NULL;
 }
 
@@ -880,8 +942,6 @@ int gras_datadesc_type_cmp(const gras_datadesc_type_t d1,
     
     break;
     
-  case e_gras_datadesc_type_cat_ignored:
-    /* That's ignored... */
   default:
     /* two stupidly created ddt are equally stupid ;) */
     break;