Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
[trace] add missing tesh to test user variables tracing
[simgrid.git] / src / gras / DataDesc / datadesc_private.h
index 0e79380..1a7052d 100644 (file)
@@ -1,12 +1,9 @@
-/* $Id$ */
-
 /* datadesc - describing the data to exchange                               */
 
 /* module's private interface masked even to other parts of GRAS.           */
 
-/* Copyright (c) 2003 Olivier Aumage.                                       */
-/* Copyright (c) 2003, 2004 Martin Quinson.                                 */
-/* All rights reserved.                                                     */
+/* Copyright (c) 2004, 2005, 2006, 2007, 2009, 2010. The SimGrid Team.
+ * 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. */
 #include "xbt/dict.h"
 #include "xbt/set.h"
 
-#include "portable.h" /* GRAS_THISARCH */
+#include "portable.h"           /* GRAS_THISARCH */
 
-#include "gras/transport.h"  /* socket handling */
+#include "gras/transport.h"     /* socket handling */
 
-#include "gras_modinter.h"   /* module init/exit */
-#include "gras/datadesc.h"   /* rest of module public interface */
+#include "gras_modinter.h"      /* module init/exit */
+#include "gras/datadesc.h"      /* rest of module public interface */
 
-#include "gras/DataDesc/datadesc_interface.h" /* semi-public API */
+#include "gras/DataDesc/datadesc_interface.h"   /* semi-public API */
 
 /**
  * ddt_aligned:
- * 
+ *
  * Align the data v on the boundary a.
  */
 #define ddt_aligned(v, a) (((v) + (a - 1)) & ~(a - 1))
 
-/*@null@*/extern xbt_set_t gras_datadesc_set_local;
+/*@null@*/ extern xbt_set_t gras_datadesc_set_local;
 void gras_ddt_freev(void *ddt);
 /*******************************************
  * Descriptions of all known architectures *
  *******************************************/
 
-#define gras_arch_count 11
+#define gras_arch_count 12
 typedef enum {
-  gras_ddt_scalar_char      = 0,
-  gras_ddt_scalar_short     = 1,
-  gras_ddt_scalar_int       = 2,
-  gras_ddt_scalar_long      = 3,
+  gras_ddt_scalar_char = 0,
+  gras_ddt_scalar_short = 1,
+  gras_ddt_scalar_int = 2,
+  gras_ddt_scalar_long = 3,
   gras_ddt_scalar_long_long = 4,
 
-  gras_ddt_scalar_pdata     = 5,
-  gras_ddt_scalar_pfunc     = 6,
+  gras_ddt_scalar_pdata = 5,
+  gras_ddt_scalar_pfunc = 6,
 
-  gras_ddt_scalar_float     = 7,
-  gras_ddt_scalar_double    = 8
+  gras_ddt_scalar_float = 7,
+  gras_ddt_scalar_double = 8
 } gras_ddt_scalar_type_t;
 
 typedef struct {
@@ -62,8 +59,8 @@ typedef struct {
 
   int endian;
 
-  int sizeofs[9]; /* char,short,int,long,long_long,pdata,pfunc,float,double */
-  int boundaries[9]; /* idem */
+  int sizeofs[9];               /* char,short,int,long,long_long,pdata,pfunc,float,double */
+  int boundaries[9];            /* idem */
 } gras_arch_desc_t;
 
 extern const gras_arch_desc_t gras_arches[gras_arch_count];
@@ -76,20 +73,20 @@ extern const char *gras_datadesc_cat_names[9];
 /**
  * e_gras_datadesc_type_category:
  *
- * Defines all possible type categories. 
+ * Defines all possible type categories.
  */
 typedef enum e_gras_datadesc_type_category {
-  
+
   /* if you edit this, also fix gras_datadesc_cat_names in ddt_exchange.c */
 
   e_gras_datadesc_type_cat_undefined = 0,
-  
+
   e_gras_datadesc_type_cat_scalar = 1,
   e_gras_datadesc_type_cat_struct = 2,
   e_gras_datadesc_type_cat_union = 3,
-  e_gras_datadesc_type_cat_ref = 4,       /* ref to an uniq element */
+  e_gras_datadesc_type_cat_ref = 4,     /* ref to an uniq element */
   e_gras_datadesc_type_cat_array = 5,
-  
+
   e_gras_datadesc_type_cat_invalid = 6
 } gras_datadesc_type_category_t;
 
@@ -103,14 +100,14 @@ typedef enum e_gras_datadesc_type_category {
  */
 typedef struct s_gras_dd_cat_field {
 
-  char            *name;
-  long int  offset[gras_arch_count];
+  char *name;
+  long int offset[gras_arch_count];
   gras_datadesc_type_t type;
-  
+
   gras_datadesc_type_cb_void_t send;
   gras_datadesc_type_cb_void_t recv;
 
-} s_gras_dd_cat_field_t,*gras_dd_cat_field_t;
+} s_gras_dd_cat_field_t, *gras_dd_cat_field_t;
 
 void gras_dd_cat_field_free(void *f);
 
@@ -121,16 +118,16 @@ void gras_dd_cat_field_free(void *f);
  */
 enum e_gras_dd_scalar_encoding {
   e_gras_dd_scalar_encoding_undefined = 0,
-  
+
   e_gras_dd_scalar_encoding_uint,
   e_gras_dd_scalar_encoding_sint,
   e_gras_dd_scalar_encoding_float,
-  
-  e_gras_dd_scalar_encoding_invalid 
+
+  e_gras_dd_scalar_encoding_invalid
 };
 typedef struct s_gras_dd_cat_scalar {
   enum e_gras_dd_scalar_encoding encoding;
-  gras_ddt_scalar_type_t type; /* to check easily that redefinition matches */
+  gras_ddt_scalar_type_t type;  /* to check easily that redefinition matches */
 } gras_dd_cat_scalar_t;
 
 /**
@@ -139,8 +136,8 @@ typedef struct s_gras_dd_cat_scalar {
  * Specific fields of a struct
  */
 typedef struct s_gras_dd_cat_struct {
-  xbt_dynar_t fields; /* elm type = gras_dd_cat_field_t */
-  int closed; /* gras_datadesc_declare_struct_close() was called */
+  xbt_dynar_t fields;           /* elm type = gras_dd_cat_field_t */
+  int closed;                   /* gras_datadesc_declare_struct_close() was called */
 } gras_dd_cat_struct_t;
 
 /**
@@ -150,8 +147,8 @@ typedef struct s_gras_dd_cat_struct {
  */
 typedef struct s_gras_dd_cat_union {
   gras_datadesc_type_cb_int_t selector;
-  xbt_dynar_t fields; /* elm type = gras_dd_cat_field_t */
-  int closed; /* gras_datadesc_declare_union_close() was called */
+  xbt_dynar_t fields;           /* elm type = gras_dd_cat_field_t */
+  int closed;                   /* gras_datadesc_declare_union_close() was called */
 } gras_dd_cat_union_t;
 
 /**
@@ -160,10 +157,10 @@ typedef struct s_gras_dd_cat_union {
  * Specific fields of a reference
  */
 typedef struct s_gras_dd_cat_ref {
-  gras_datadesc_type_t      type;
+  gras_datadesc_type_t type;
 
   /* callback used to return the referenced type number  */
-  gras_datadesc_selector_t  selector;
+  gras_datadesc_selector_t selector;
 } gras_dd_cat_ref_t;
 
 
@@ -173,10 +170,10 @@ typedef struct s_gras_dd_cat_ref {
  * Specific fields of an array
  */
 typedef struct s_gras_dd_cat_array {
-  gras_datadesc_type_t  type;
+  gras_datadesc_type_t type;
 
-  /* element_count == 0 means dynamically defined */
-  unsigned long int           fixed_size;
+  /* element_count == -1 means dynamically defined */
+  long int fixed_size;
 
   /* callback used to return the dynamic length */
   gras_datadesc_type_cb_int_t dynamic_size;
@@ -189,12 +186,12 @@ typedef struct s_gras_dd_cat_array {
  * Specific data to each possible category
  */
 union u_gras_datadesc_category {
-        void                  *undefined_data;
-        gras_dd_cat_scalar_t   scalar_data;
-        gras_dd_cat_struct_t   struct_data;
-        gras_dd_cat_union_t    union_data;
-        gras_dd_cat_ref_t      ref_data;
-        gras_dd_cat_array_t    array_data;
+  void *undefined_data;
+  gras_dd_cat_scalar_t scalar_data;
+  gras_dd_cat_struct_t struct_data;
+  gras_dd_cat_union_t union_data;
+  gras_dd_cat_ref_t ref_data;
+  gras_dd_cat_array_t array_data;
 };
 
 /****************************************/
@@ -207,45 +204,45 @@ union u_gras_datadesc_category {
  */
 typedef struct s_gras_datadesc_type {
   /* headers for the data set */
-  unsigned int                         code;
-  char                                *name;
-  unsigned int                         name_len;
-        
+  int code;
+  char *name;
+  unsigned int name_len;
+
   /* payload */
-  unsigned long int                    size[gras_arch_count];
-  
-  unsigned long int                    alignment[gras_arch_count];  
-  unsigned long int                    aligned_size[gras_arch_count];
-  
-  enum  e_gras_datadesc_type_category  category_code;
-  union u_gras_datadesc_category       category;
-  
-  gras_datadesc_type_cb_void_t         send;
-  gras_datadesc_type_cb_void_t         recv;
-   
+  long int size[gras_arch_count];       /* Cannot be unsigned: -1 means dynamic */
+
+  unsigned long int alignment[gras_arch_count];
+  unsigned long int aligned_size[gras_arch_count];
+
+  enum e_gras_datadesc_type_category category_code;
+  union u_gras_datadesc_category category;
+
+  gras_datadesc_type_cb_void_t send;
+  gras_datadesc_type_cb_void_t recv;
+
   /* flags */
-  int                                  cycle :1;
-   
+  int cycle:1;
+
   /* random value for users (like default value or whatever) */
-  char                                 extra[SIZEOF_MAX]; 
+  char extra[SIZEOF_MAX];
 
 } s_gras_datadesc_type_t;
 
 /***************************
  * constructor/desctructor *
  ***************************/
-void gras_datadesc_free(gras_datadesc_type_t *type);
+void gras_datadesc_free(gras_datadesc_type_t * type);
 
-  gras_datadesc_type_t
-  gras_datadesc_scalar(const char                       *name,
-                      gras_ddt_scalar_type_t           type,
-                      enum e_gras_dd_scalar_encoding   encoding);
+gras_datadesc_type_t
+gras_datadesc_scalar(const char *name,
+                     gras_ddt_scalar_type_t type,
+                     enum e_gras_dd_scalar_encoding encoding);
 
 /****************************************************
  * Callback persistant state constructor/destructor *
  ****************************************************/
 gras_cbps_t gras_cbps_new(void);
-void gras_cbps_free(gras_cbps_t *state);
+void gras_cbps_free(gras_cbps_t * state);
 void gras_cbps_reset(gras_cbps_t state);
 
 /***************
@@ -253,13 +250,11 @@ void gras_cbps_reset(gras_cbps_t state);
  ***************/
 void
 gras_dd_convert_elm(gras_datadesc_type_t type, int count,
-                   int r_arch, 
-                   void *src, void *dst);
+                    int r_arch, void *src, void *dst);
 
 /********************************************************************
  * Dictionnary containing the constant values for the parsing macro *
  ********************************************************************/
-extern xbt_dict_t gras_dd_constants; /* lives in ddt_parse.c of course */
-
-#endif /* GRAS_DATADESC_PRIVATE_H */
+extern xbt_dict_t gras_dd_constants;    /* lives in ddt_parse.c of course */
 
+#endif                          /* GRAS_DATADESC_PRIVATE_H */