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 83d32c1..1a7052d 100644 (file)
@@ -1,27 +1,70 @@
-/* $Id$ */
+/* datadesc - describing the data to exchange                               */
 
-/* datadesc_private - declarations visible only from within datadesc        */
+/* module's private interface masked even to other parts of GRAS.           */
 
-/* Authors: Olivier Aumage, Martin Quinson                                  */
-/* Copyright (C) 2003, 2004 the GRAS posse.                                 */
+/* 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. */
* under the terms of the license (GNU LGPL) which comes with this package. */
 
 #ifndef GRAS_DATADESC_PRIVATE_H
 #define GRAS_DATADESC_PRIVATE_H
 
-#include "gras_private.h"
-#include "DataDesc/datadesc_interface.h"
+#include "xbt/sysdep.h"
+#include "xbt/log.h"
+#include "xbt/dynar.h"
+#include "xbt/dict.h"
+#include "xbt/set.h"
+
+#include "portable.h"           /* GRAS_THISARCH */
+
+#include "gras/transport.h"     /* socket handling */
+
+#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 */
 
 /**
- * aligned:
- * 
+ * ddt_aligned:
+ *
  * Align the data v on the boundary a.
  */
-#define aligned(v, a) (((v) + (a - 1)) & ~(a - 1))
+#define ddt_aligned(v, a) (((v) + (a - 1)) & ~(a - 1))
+
+/*@null@*/ extern xbt_set_t gras_datadesc_set_local;
+void gras_ddt_freev(void *ddt);
+/*******************************************
+ * Descriptions of all known architectures *
+ *******************************************/
+
+#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_long_long = 4,
+
+  gras_ddt_scalar_pdata = 5,
+  gras_ddt_scalar_pfunc = 6,
+
+  gras_ddt_scalar_float = 7,
+  gras_ddt_scalar_double = 8
+} gras_ddt_scalar_type_t;
 
-extern gras_set_t *gras_datadesc_set_local;
+typedef struct {
+  const char *name;
+
+  int endian;
+
+  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];
+extern const char *gras_datadesc_cat_names[9];
 
 /**********************************************************/
 /* Actual definitions of the stuff in the type descriptor */
@@ -30,21 +73,22 @@ extern gras_set_t *gras_datadesc_set_local;
 /**
  * e_gras_datadesc_type_category:
  *
- * Defines all possible type categories
+ * Defines all possible type categories.
  */
 typedef enum e_gras_datadesc_type_category {
-        e_gras_datadesc_type_cat_undefined = 0,
 
-        e_gras_datadesc_type_cat_scalar,
-        e_gras_datadesc_type_cat_struct,
-        e_gras_datadesc_type_cat_union,
-        e_gras_datadesc_type_cat_ref,       /* ref to an uniq element */
-        e_gras_datadesc_type_cat_array,
-        e_gras_datadesc_type_cat_ignored,
+  /* if you edit this, also fix gras_datadesc_cat_names in ddt_exchange.c */
 
-        e_gras_datadesc_type_cat_invalid
-} gras_datadesc_type_category_t;
+  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_array = 5,
+
+  e_gras_datadesc_type_cat_invalid = 6
+} gras_datadesc_type_category_t;
 
 /*------------------------------------------------*/
 /* definitions of specific data for each category */
@@ -56,14 +100,15 @@ typedef enum e_gras_datadesc_type_category {
  */
 typedef struct s_gras_dd_cat_field {
 
-  char                               *name;
-  long int                    offset; /* only for struct */
-  int                          code;
-  
-  gras_datadesc_type_cb_void_t pre;
-  gras_datadesc_type_cb_void_t post;
+  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;
 
-} gras_dd_cat_field_t;
 void gras_dd_cat_field_free(void *f);
 
 /**
@@ -73,15 +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_dd_cat_scalar_t;
 
 /**
@@ -90,7 +136,8 @@ typedef struct s_gras_dd_cat_scalar {
  * Specific fields of a struct
  */
 typedef struct s_gras_dd_cat_struct {
-  gras_dynar_t *fields; /* elm type = gras_dd_cat_struct_field_t */
+  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;
 
 /**
@@ -99,8 +146,9 @@ typedef struct s_gras_dd_cat_struct {
  * Specific fields of a union
  */
 typedef struct s_gras_dd_cat_union {
-  gras_datadesc_type_cb_int_t field_count;
-  gras_dynar_t *fields; /* elm type = gras_dd_cat_union_field_t */
+  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 */
 } gras_dd_cat_union_t;
 
 /**
@@ -109,10 +157,10 @@ typedef struct s_gras_dd_cat_union {
  * Specific fields of a reference
  */
 typedef struct s_gras_dd_cat_ref {
-  int                          code;
+  gras_datadesc_type_t type;
 
   /* callback used to return the referenced type number  */
-  gras_datadesc_type_cb_int_t   discriminant;
+  gras_datadesc_selector_t selector;
 } gras_dd_cat_ref_t;
 
 
@@ -122,25 +170,15 @@ typedef struct s_gras_dd_cat_ref {
  * Specific fields of an array
  */
 typedef struct s_gras_dd_cat_array {
-  int                          code;
+  gras_datadesc_type_t type;
 
-  /* element_count < 0 means dynamically defined */
-  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;
-} gras_dd_cat_array_t;
-
-/**
- * gras_dd_cat_ignored_t:
- *
- * Specific fields of an ignored field
- */
-typedef struct s_gras_dd_cat_ignored {
-  void                         *default_value;
-  void_f_pvoid_t                *free_func;
-} gras_dd_cat_ignored_t;
 
+} gras_dd_cat_array_t;
 
 /**
  * u_gras_datadesc_category:
@@ -148,16 +186,14 @@ typedef struct s_gras_dd_cat_ignored {
  * 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;
-        gras_dd_cat_ignored_t  ignored_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;
 };
 
-
 /****************************************/
 /* The holy grail: type descriptor type */
 /****************************************/
@@ -166,78 +202,59 @@ union u_gras_datadesc_category {
  *
  * Type descriptor.
  */
-struct s_gras_datadesc_type {
+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 */
-  long int                             size;
-  
-  long int                             alignment;
-  long int                             aligned_size;
-  
-  enum  e_gras_datadesc_type_category  category_code;
-  union u_gras_datadesc_category       category;
-  
-  gras_datadesc_type_cb_void_t         pre;
-  gras_datadesc_type_cb_void_t         post;
-};
+  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;
+
+  /* random value for users (like default value or whatever) */
+  char extra[SIZEOF_MAX];
+
+} s_gras_datadesc_type_t;
 
 /***************************
- * Type creation functions *
+ * constructor/desctructor *
  ***************************/
-gras_error_t 
-gras_ddt_new_scalar(const char                       *name,
-                   long int                         size,
-                   enum e_gras_dd_scalar_encoding   encoding,
-                   gras_datadesc_type_cb_void_t     cb,
-                   gras_datadesc_type_t           **dst);
-gras_error_t 
-gras_ddt_new_struct(const char                      *name,
-                   gras_datadesc_type_cb_void_t     pre,
-                   gras_datadesc_type_cb_void_t     post,
-                   gras_datadesc_type_t           **dst);
-gras_error_t 
-gras_ddt_new_struct_append(gras_datadesc_type_t            *struct_type,
-                          const char                      *name,
-                          gras_datadesc_type_t            *field_type,
-                          gras_datadesc_type_cb_void_t     pre,
-                          gras_datadesc_type_cb_void_t     post);
-gras_error_t 
-gras_ddt_new_union(const char                      *name,
-                  gras_datadesc_type_cb_int_t      field_count,
-                  gras_datadesc_type_cb_void_t     post,
-                  gras_datadesc_type_t           **dst);
-gras_error_t 
-gras_ddt_new_union_append(gras_datadesc_type_t            *union_type,
-                         const char                      *name,
-                         gras_datadesc_type_t            *field_type,
-                         gras_datadesc_type_cb_void_t     pre,
-                         gras_datadesc_type_cb_void_t     post);
-gras_error_t 
-gras_ddt_new_ref(const char                      *name,
-                gras_datadesc_type_t            *referenced_type,
-                gras_datadesc_type_cb_int_t      discriminant,
-                gras_datadesc_type_cb_void_t     post,
-                gras_datadesc_type_t           **dst);
-gras_error_t 
-gras_ddt_new_array(const char                      *name,
-                  gras_datadesc_type_t            *element_type,
-                  long int                         fixed_size,
-                  gras_datadesc_type_cb_int_t      dynamic_size,
-                  gras_datadesc_type_cb_void_t     post,
-                  gras_datadesc_type_t           **dst);
-gras_error_t 
-gras_ddt_new_ignored(const char       *name,
-                    void             *default_value,
-                    void_f_pvoid_t   *free_func,
-                    long int                       size,
-                    long int                       alignment,
-                    gras_datadesc_type_cb_void_t     post,
-                    gras_datadesc_type_t           **dst);
-
-
-
-#endif /* GRAS_DATADESC_PRIVATE_H */
+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);
+
+/****************************************************
+ * Callback persistant state constructor/destructor *
+ ****************************************************/
+gras_cbps_t gras_cbps_new(void);
+void gras_cbps_free(gras_cbps_t * state);
+void gras_cbps_reset(gras_cbps_t state);
+
+/***************
+ * Convertions *
+ ***************/
+void
+gras_dd_convert_elm(gras_datadesc_type_t type, int count,
+                    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 */