include/gras/datadesc.h

   1 /* $Id$ */
   2
   3 /* gras/datadesc.h - Describing the data you want to exchange               */
   4
   5 /* Copyright (c) 2003, 2004 Martin Quinson. All rights reserved.            */
   6
   7 /* This program is free software; you can redistribute it and/or modify it
   8  * under the terms of the license (GNU LGPL) which comes with this package. */
   9
  10 #ifndef GRAS_DATADESC_H
  11 #define GRAS_DATADESC_H
  12
  13 #include "xbt/misc.h" /* SG_BEGIN_DECL */
  14 #include "xbt/dynar.h" /* void_f_pvoid_t */
  15
  16 SG_BEGIN_DECL()
  17
  18 /** @addtogroup GRAS_dd Data description
  19  *  @brief Describing data to be exchanged
  20  *
  21  * Since GRAS takes care of potential representation conversion when the platform is heterogeneous,
  22  * any data which transits on the network must be described beforehand.
  23  *
  24  * There is several possible interfaces for this, ranging from the really completely automatic parsing to
  25  * completely manual. Let's study each of them from the simplest to the more advanced:
  26  *
  27  *   - Section \ref GRAS_dd_basic presents how to retrieve and use an already described type.
  28  *   - Section \ref GRAS_dd_auto shows how to get GRAS parsing your type description automagically. This
  29  *     is unfortunately not always possible (only works for some structures), but if it is for your data,
  30  *     this is definitly the way to go.
  31  *   - Section \ref GRAS_dd_manual presents how to build a description manually. This is useful when you want
  32  *     to describe an array or a pointer of pre-defined structures.
  33  *   - You sometimes need to exchange informations between descriptions at send or receive time. This is
  34  *     for example useful when your structure contains an array which size is given by another field of the
  35  *     structure.
  36  *     - Section \ref GRAS_dd_cb_simple provides a simple interface to do so, allowing to share integers stored on a stack.
  37  *     - Section \ref GRAS_dd_cb_full provides a full featured interface to do so, but it may reveal somehow difficult to use.
  38  **/
  39
  40 /** @defgroup GRAS_dd_basic Basic operations on data descriptions
  41  *  @ingroup GRAS_dd
  42  * \htmlonly <!-- DOXYGEN_NAVBAR_LABEL="Basics" --> \endhtmlonly
  43  *
  44  * If you only want to send pre-existing types, simply retrieve the pre-defined description with
  45  * the \ref gras_datadesc_by_name function. Existing types entail:
  46  *  - char (both signed and unsigned)
  47  *  - int (short, regular, long and long long, both signed and unsigned)
  48  *  - float and double
  49  *  - string (which is indeed a reference to a dynamically sized array of char, strlen being used to retrieve the size)
  50  *
  51  * Example:\verbatim gras_datadesc_type_t i = gras_datadesc_by_name("int");
  52  gras_datadesc_type_t uc = gras_datadesc_by_name("unsigned char");
  53  gras_datadesc_type_t str = gras_datadesc_by_name("string");\endverbatim
  54  *
  55  */
  56 /* @{ */
  57
  58 /** @brief Opaque type describing a type description. */
  59 typedef struct s_gras_datadesc_type *gras_datadesc_type_t;
  60
  61 /** \brief Search a type description from its name */
  62 gras_datadesc_type_t gras_datadesc_by_name(const char *name);
  63
  64 /* @} */
  65
  66 /** @defgroup GRAS_dd_auto Automatic parsing of data descriptions
  67  *  @ingroup GRAS_dd
  68  * \htmlonly <!-- DOXYGEN_NAVBAR_LABEL="Automatic parsing" --> \endhtmlonly
  69  *
  70  *  If you need to declare a new datatype, this is the simplest way to describe it to GRAS. Simply
  71  *  enclose its type definition  into a \ref GRAS_DEFINE_TYPE macro call, and you're set. Here is
  72  *  an type declaration  example: \verbatim GRAS_DEFINE_TYPE(mytype,struct mytype {
  73    int myfirstfield;
  74    char mysecondfield;
  75  });\endverbatim
  76  *  The type is then both copied verbatim into your source file and stored for further parsing. This allows
  77  *  you to let GRAS parse the exact version you are actually using in your program.
  78  *  You can then retrieve the corresponding type description with \ref gras_datadesc_by_symbol.
  79  *  Don't worry too much for the performances, the type is only parsed once and a binary representation
  80  *  is stored and used in any subsequent calls.
  81  *
  82  *  If your structure contains any pointer, you have to explain GRAS the size of the pointed array. This
  83  *  can be 1 in the case of simple references, or more in the case of regular arrays. For that, use the
  84  *  \ref GRAS_ANNOTE macro within the type declaration you are passing to \ref GRAS_DEFINE_TYPE. This macro
  85  *  rewrites itself to nothing in the declaration (so they won't pollute the type definition copied verbatim
  86  *  into your code), and give some information to GRAS about your pointer.
  87
  88  *  GRAS_ANNOTE takes two arguments being the key name and the key value. For now, the only accepted key name
  89  *  is "size", to specify the length of the pointed array. It can either be:
  90  *    - the string "1" (without the quote),
  91  *    - the name of another field of the structure
  92  *    - a sort of computed expression for multidimensional arrays (see below -- pay attention to the warnings below).
  93  *
  94  *  Here is an example:\verbatim GRAS_DEFINE_TYPE(s_clause,
  95   struct s_array {
  96     struct s_array *father GRAS_ANNOTE(size,1);
  97     int length;
  98     int *data GRAS_ANNOTE(size,length);
  99     int rows;
 100     int cols;
 101     int *matrix GRAS_ANNOTE(size,rows*cols);
 102  }
 103 ;)\endverbatim
 104  * It specifies that the structure s_array contains five fields, that the \a father field is a simple reference,
 105  * that the size of the array pointed by \a data is the \a length field, and that the \a matrix field is an array
 106  * which size is the result of \a rows times \a cols.
 107  *
 108  *  \warning Since GRAS_DEFINE_TYPE is a macro, you shouldn't put any comma in your type definition
 109  *  (comma separates macro args). For example, change \verbatim int a, b;\endverbatim to \verbatim int a;
 110 int b;\endverbatim
 111  *
 112  * \section gras_dd_define \#define and fixed size array
 113  *
 114  * If you want to exchange arrays which size is given at compilation time by a
 115  * \#defined constant, you need to keep GRAS informed. It would be done the
 116  * following way:
 117
 118 \verbatim #define BLOCK_SIZE 32
 119 GRAS_DEFINE_TYPE(s_toto,
 120 struct {
 121   double data[BLOCK_SIZE];
 122 } s_toto;)
 123
 124 void register_messages() {
 125   gras_datadesc_type_t toto_type;
 126
 127   gras_datadesc_set_const("BLOCK_SIZE",BLOCK_SIZE);
 128   toto_type = gras_datadesc_by_symbol(s_toto);
 129 }\endverbatim
 130  *
 131  * The form <tt>gras_datadesc_set_const("BLOCK_SIZE",BLOCK_SIZE);</tt> ensures
 132  * that when you change the definition of the constant, GRAS keeps informed of
 133  * the right value. Passing the numerical value of the constant as second
 134  * argument would be a bad idea to that regard. Of course, the call to
 135  * gras_datadesc_set_const() should come before any gras_datadesc_by_symbol()
 136  * containing references to it.
 137  *
 138  * \section GRAS_dd_multidim Defining multidimentional arrays
 139  *
 140  *  The mecanism for multidimensional arrays is known to be fragile and cumbersome. If you want to use it,
 141  *  you have to understand how it is implemented: the multiplication is performed using the sizes stack. In previous example,
 142  *  a \ref gras_datadesc_cb_push_int callback is added to the \a rows field and a \ref gras_datadesc_cb_push_int_mult one is
 143  *  added to \a cols. So, when the structure is sent, the \a rows field push its value onto the stack, then the \a cols field
 144  *  retrieve this value from the stack, compute (and push) the multiplication value. The \a matrix field can then retrieve this
 145  *  value by poping the array. There is several ways for this to go wrong:
 146  *   - if the matrix field is placed before the sizes, the right value won't get pushed into the stack soon enough.
 147  *     Reorder your structure fields if needed.
 148  *   - if you write GRAS_ANNOTE(size,cols*rows); in previous example (inverting rows and cols in annotation),
 149  *     \a rows will be given a \ref gras_datadesc_cb_push_int_mult. This cannot work since it will try to
 150  *     pop the value which will be pushed by \a cols <i>afterward</i>.
 151  *   - if you have more than one matrix in your structure, don't interleave the size. They are pushed/poped in the structure order.
 152  *   - if some of the sizes are used in more than one matrix, you cannot use this mecanism -- sorry.
 153  *
 154  * If you cannot express your datadescs with this mechanism, you'll have to use the more advanced
 155  * (and somehow complex) one described in the \ref GRAS_dd_cb_full.
 156  *
 157  * \section GRAS_dd_multifile Projects spanning over multiple files
 158  *
 159  * GRAS_DEFINE_TYPE declares some symbols to work, it needs some special
 160  * care when used in several files. In such case, you want the regular type
 161  * definition in all files, but the gras specific symbol defined in only
 162  * one file. For example, consider the following gras project sketch.
 163  *
 164 \verbatim #include <gras.h>
 165
 166 GRAS_DEFINE_TYPE(my_type,struct my_type {
 167   int a;
 168   int b;
 169   double c;
 170 });
 171
 172 int client(int argc, char *argv[]) {
 173  ...
 174 }
 175
 176 int server(int argc, char *argv[]) {
 177  ...
 178 }\endverbatim
 179  *
 180  * If you want to split this in two files (one for each kind of processes),
 181  * you need to put the GRAS_DEFINE_TYPE block in a separate header. But
 182  * then you cannot include this right away in all files because the extra
 183  * symbols would be defined in dupplicate.
 184  *
 185  * You thus have to decide in which file the symbols will live. In that
 186  * file, include the header without restriction:
 187  *
 188 \verbatim #include "my_header.h"
 189
 190 int client(int argc, char *argv[]) {
 191   ...
 192 }\endverbatim
 193
 194  * And in the other files needing the C definitions without the extra GRAS
 195  * symbols, declare the symbol GRAS_DEFINE_TYPE_EXTERN before:
 196  *
 197 \verbatim #define GRAS_DEFINE_TYPE_EXTERN
 198 #include "my_header.h"
 199
 200 int server(int argc, char *argv[]) {
 201   ...
 202 }\endverbatim
 203
 204  *
 205  */
 206 /** @{ */
 207
 208
 209 /**   @brief Automatically parse C code
 210  *    @hideinitializer
 211  */
 212 #define GRAS_DEFINE_TYPE(name,def) \
 213   const char * _gras_this_type_symbol_does_not_exist__##name=#def; def
 214
 215 #ifndef DOXYGEN_SKIP /* doxygen don't like macro fun too much */
 216 #  ifdef GRAS_DEFINE_TYPE_EXTERN
 217 #    undef  GRAS_DEFINE_TYPE
 218 #    define GRAS_DEFINE_TYPE(name,def)  def
 219 #    undef GRAS_DEFINE_TYPE_EXTERN
 220 #  endif
 221 #endif
 222
 223 /**   @brief if this symbol is defined, the \a GRAS_DEFINE_TYPE symbols live in another file.
 224  *    @hideinitializer
 225  */
 226 #define GRAS_DEFINE_TYPE_EXTERN 1
 227
 228
 229
 230 /** @brief Retrieve a datadesc which was previously parsed
 231  *  @hideinitializer
 232  */
 233 #define gras_datadesc_by_symbol(name)  \
 234   (gras_datadesc_by_name(#name) ?      \
 235    gras_datadesc_by_name(#name) :      \
 236      gras_datadesc_parse(#name,        \
 237                          _gras_this_type_symbol_does_not_exist__##name) \
 238   )
 239
 240 /** @def GRAS_ANNOTE
 241  *  @brief Add an annotation to a type to be automatically parsed
 242  */
 243 #define GRAS_ANNOTE(key,val)
 244
 245 /** @brief Defines the value of a define to the datatype parsing infrastructure
 246  */
 247 void gras_datadesc_set_const(const char*name, int value);
 248
 249 /* @} */
 250
 251 gras_datadesc_type_t
 252 gras_datadesc_parse(const char *name, const char *C_statement);
 253
 254 /** @defgroup GRAS_dd_manual Simple manual data description
 255  *  @ingroup GRAS_dd
 256  *
 257  * Here are the functions to use if you want to declare your description manually.
 258  * The function names should be self-explanatory in most cases.
 259  *
 260  * You can add callbacks to the datatypes doing any kind of action you may want. Usually,
 261  * pre-send callbacks are used to prepare the type expedition while post-receive callbacks
 262  * are used to fix any issue after the receive.
 263  *
 264  * If your types are dynamic, you'll need to add some extra callback. For example, there is a
 265  * specific callback for the string type which is in charge of computing the length of the char
 266  * array. This is done with the cbps mechanism, explained in next section.
 267  *
 268  * If your types may contain pointer cycle, you must specify it to GRAS using the @ref gras_datadesc_cycle_set.
 269  *
 270  * Example:\verbatim
 271  typedef struct {
 272    unsigned char c1;
 273    unsigned long int l1;
 274    unsigned char c2;
 275    unsigned long int l2;
 276  } mystruct;
 277  [...]
 278   my_type=gras_datadesc_struct("mystruct");
 279   gras_datadesc_struct_append(my_type,"c1", gras_datadesc_by_name("unsigned char"));
 280   gras_datadesc_struct_append(my_type,"l1", gras_datadesc_by_name("unsigned long"));
 281   gras_datadesc_struct_append(my_type,"c2", gras_datadesc_by_name("unsigned char"));
 282   gras_datadesc_struct_append(my_type,"l2", gras_datadesc_by_name("unsigned long int"));
 283   gras_datadesc_struct_close(my_type);
 284
 285   my_type=gras_datadesc_ref("mystruct*", gras_datadesc_by_name("mystruct"));
 286
 287   [Use my_type to send pointers to mystruct data]\endverbatim
 288  */
 289 /* @{ */
 290
 291
 292 /** \brief Opaque type describing a type description callback persistant state. */
 293 typedef struct s_gras_cbps *gras_cbps_t;
 294
 295 /* callbacks prototypes */
 296 /** \brief Prototype of type callbacks returning nothing. */
 297 typedef void (*gras_datadesc_type_cb_void_t)(gras_datadesc_type_t typedesc, gras_cbps_t vars, void *data);
 298 /** \brief Prototype of type callbacks returning an int. */
 299 typedef int (*gras_datadesc_type_cb_int_t)(gras_datadesc_type_t typedesc, gras_cbps_t vars, void *data);
 300 /** \brief Prototype of type callbacks selecting a type. */
 301 typedef gras_datadesc_type_t (*gras_datadesc_selector_t)(gras_datadesc_type_t typedesc, gras_cbps_t vars, void *data);
 302
 303
 304 /******************************************
 305  **** Declare datadescription yourself ****
 306  ******************************************/
 307
 308 gras_datadesc_type_t gras_datadesc_struct(const char *name);
 309 void gras_datadesc_struct_append(gras_datadesc_type_t  struct_type,
 310                                  const char           *name,
 311                                  gras_datadesc_type_t  field_type);
 312 void gras_datadesc_struct_close(gras_datadesc_type_t   struct_type);
 313
 314
 315 gras_datadesc_type_t gras_datadesc_union(const char                 *name,
 316                                          gras_datadesc_type_cb_int_t selector);
 317 void gras_datadesc_union_append(gras_datadesc_type_t   union_type,
 318                                 const char            *name,
 319                                 gras_datadesc_type_t   field_type);
 320 void gras_datadesc_union_close(gras_datadesc_type_t    union_type);
 321
 322
 323 gras_datadesc_type_t
 324   gras_datadesc_ref(const char          *name,
 325                     gras_datadesc_type_t referenced_type);
 326 gras_datadesc_type_t
 327   gras_datadesc_ref_generic(const char              *name,
 328                             gras_datadesc_selector_t selector);
 329
 330 gras_datadesc_type_t
 331   gras_datadesc_array_fixed(const char          *name,
 332                             gras_datadesc_type_t element_type,
 333                             long int             fixed_size);
 334 gras_datadesc_type_t
 335   gras_datadesc_array_dyn(const char                 *name,
 336                           gras_datadesc_type_t        element_type,
 337                           gras_datadesc_type_cb_int_t dynamic_size);
 338 gras_datadesc_type_t
 339   gras_datadesc_ref_pop_arr(gras_datadesc_type_t  element_type);
 340
 341 gras_datadesc_type_t
 342   gras_datadesc_dynar(gras_datadesc_type_t elm_t,
 343                       void_f_pvoid_t *free_func);
 344 gras_datadesc_type_t
 345   gras_datadesc_matrix(gras_datadesc_type_t elm_t,
 346                        void_f_pvoid_t * const free_f);
 347
 348 /*********************************
 349  * Change stuff within datadescs *
 350  *********************************/
 351
 352 /** \brief Specify that this type may contain cycles */
 353 void gras_datadesc_cycle_set(gras_datadesc_type_t type);
 354 /** \brief Specify that this type do not contain any cycles (default) */
 355 void gras_datadesc_cycle_unset(gras_datadesc_type_t type);
 356 /** \brief Add a pre-send callback to this datadesc. */
 357 void gras_datadesc_cb_send (gras_datadesc_type_t         type,
 358                             gras_datadesc_type_cb_void_t pre);
 359 /** \brief Add a post-receive callback to this datadesc.*/
 360 void gras_datadesc_cb_recv(gras_datadesc_type_t          type,
 361                            gras_datadesc_type_cb_void_t  post);
 362 /** \brief Add a pre-send callback to the given field of the datadesc */
 363 void gras_datadesc_cb_field_send (gras_datadesc_type_t   type,
 364                                   const char            *field_name,
 365                                   gras_datadesc_type_cb_void_t  pre);
 366 /** \brief Add a post-receive callback to the given field of the datadesc */
 367 void gras_datadesc_cb_field_recv(gras_datadesc_type_t    type,
 368                                  const char             *field_name,
 369                                  gras_datadesc_type_cb_void_t  post);
 370 /** \brief Add a pre-send callback to the given field resulting in its value to be pushed */
 371 void gras_datadesc_cb_field_push (gras_datadesc_type_t   type,
 372                                   const char            *field_name);
 373 /** \brief Add a pre-send callback to the given field resulting in its value multiplied to any previously pushed value and then pushed back */
 374 void gras_datadesc_cb_field_push_multiplier (gras_datadesc_type_t type,
 375                                              const char          *field_name);
 376
 377 /******************************
 378  * Get stuff within datadescs *
 379  ******************************/
 380 /** \brief Returns the name of a datadescription */
 381 const char * gras_datadesc_get_name(gras_datadesc_type_t ddt);
 382 /** \brief Returns the identifier of a datadescription */
 383 int gras_datadesc_get_id(gras_datadesc_type_t ddt);
 384
 385 /* @} */
 386
 387 /** @defgroup GRAS_dd_cb_simple Data description with Callback Persistant State: Simple push/pop mechanism
 388  *  @ingroup GRAS_dd
 389  *
 390  * Sometimes, one of the callbacks need to leave information for the next ones. If this is a simple integer (such as
 391  * an array size), you can use the functions described here. If not, you'll have to play with the complete cbps interface.
 392  *
 393  * \htmlonly <!--  DOXYGEN_NAVBAR_LABEL="Simple push/pop Callback State" -->\endhtmlonly
 394  *
 395  * Here is an example:\verbatim
 396 struct s_array {
 397   int length;
 398   int *data;
 399 }
 400 [...]
 401 my_type=gras_datadesc_struct("s_array");
 402 gras_datadesc_struct_append(my_type,"length", gras_datadesc_by_name("int"));
 403 gras_datadesc_cb_field_send (my_type, "length", gras_datadesc_cb_push_int);
 404
 405 gras_datadesc_struct_append(my_type,"data",
 406                             gras_datadesc_array_dyn ("s_array::data",gras_datadesc_by_name("int"), gras_datadesc_cb_pop));
 407 gras_datadesc_struct_close(my_type);
 408 \endverbatim
 409
 410  *
 411  * The *_mult versions are intended for multi-dimensional arrays: They multiply their value to the previously pushed one
 412  * (by another field callback) and push the result of the multiplication back. An example of use follows. Please note
 413  * that the first field needs a regular push callback, not a multiplier one. Think of it as a stacked calculator (man dc(1)).\verbatim
 414 struct s_matrix {
 415   int row;
 416   int col;
 417   int *data;
 418 }
 419 [...]
 420 my_type=gras_datadesc_struct("s_matrix");
 421 gras_datadesc_struct_append(my_type,"row", gras_datadesc_by_name("int"));
 422 gras_datadesc_cb_field_send (my_type, "length", gras_datadesc_cb_push_int);
 423 gras_datadesc_struct_append(my_type,"col", gras_datadesc_by_name("int"));
 424 gras_datadesc_cb_field_send (my_type, "length", gras_datadesc_cb_push_int_mult);
 425
 426 gras_datadesc_struct_append(my_type,"data",
 427                             gras_datadesc_array_dyn ("s_matrix::data",gras_datadesc_by_name("int"), gras_datadesc_cb_pop));
 428 gras_datadesc_struct_close(my_type);
 429 \endverbatim
 430
 431  */
 432 /* @{ */
 433
 434 void
 435 gras_cbps_i_push(gras_cbps_t ps, int val);
 436 int
 437 gras_cbps_i_pop(gras_cbps_t ps);
 438
 439 int gras_datadesc_cb_pop(gras_datadesc_type_t typedesc, gras_cbps_t vars, void *data);
 440
 441 void gras_datadesc_cb_push_int(gras_datadesc_type_t typedesc, gras_cbps_t vars, void *data);
 442 void gras_datadesc_cb_push_uint(gras_datadesc_type_t typedesc, gras_cbps_t vars, void *data);
 443 void gras_datadesc_cb_push_lint(gras_datadesc_type_t typedesc, gras_cbps_t vars, void *data);
 444 void gras_datadesc_cb_push_ulint(gras_datadesc_type_t typedesc, gras_cbps_t vars, void *data);
 445
 446 void gras_datadesc_cb_push_int_mult(gras_datadesc_type_t typedesc, gras_cbps_t vars, void *data);
 447 void gras_datadesc_cb_push_uint_mult(gras_datadesc_type_t typedesc, gras_cbps_t vars, void *data);
 448 void gras_datadesc_cb_push_lint_mult(gras_datadesc_type_t typedesc, gras_cbps_t vars, void *data);
 449 void gras_datadesc_cb_push_ulint_mult(gras_datadesc_type_t typedesc, gras_cbps_t vars, void *data);
 450
 451
 452 /* @} */
 453
 454 /** @defgroup GRAS_dd_cb_full Data description with Callback Persistant State: Full featured interface
 455  *  @ingroup GRAS_dd
 456  *
 457  * Sometimes, one of the callbacks need to leave information for the next
 458  * ones. If the simple push/pop mechanism introduced in previous section
 459  * isn't enough, you can always use this full featured one. The bad point is
 460  * that it is quite badly documented...
 461  *
 462  * \htmlonly <!--  DOXYGEN_NAVBAR_LABEL="Full featured Callback State" -->\endhtmlonly
 463  *
 464  */
 465
 466 /* @{ */
 467
 468 void   gras_cbps_v_pop (gras_cbps_t            ps,
 469                         const char            *name,
 470               /* OUT */ gras_datadesc_type_t  *ddt,
 471               /* OUT */ void                 **res);
 472 void   gras_cbps_v_push(gras_cbps_t            ps,
 473                         const char            *name,
 474                         void                  *data,
 475                         gras_datadesc_type_t   ddt);
 476 void   gras_cbps_v_set (gras_cbps_t            ps,
 477                         const char            *name,
 478                         void                  *data,
 479                         gras_datadesc_type_t   ddt);
 480
 481 void * gras_cbps_v_get (gras_cbps_t            ps,
 482                         const char            *name,
 483               /* OUT */ gras_datadesc_type_t  *ddt);
 484
 485 void gras_cbps_block_begin(gras_cbps_t ps);
 486 void gras_cbps_block_end(gras_cbps_t ps);
 487
 488 /* @} */
 489 /* @} */
 490
 491
 492 /*******************************
 493  **** About data convertion ****
 494  *******************************/
 495 int gras_arch_selfid(void); /* ID of this arch */
 496
 497
 498 /*****************************
 499  **** NWS datadescription * FIXME: obsolete?
 500  *****************************/
 501
 502 /**
 503  * Basic types we can embeed in DataDescriptors.
 504  */
 505 typedef enum
 506   {CHAR_TYPE, DOUBLE_TYPE, FLOAT_TYPE, INT_TYPE, LONG_TYPE, SHORT_TYPE,
 507    UNSIGNED_INT_TYPE, UNSIGNED_LONG_TYPE, UNSIGNED_SHORT_TYPE, STRUCT_TYPE}
 508   DataTypes;
 509 #define SIMPLE_TYPE_COUNT 9
 510
 511 /**  \brief Describe a collection of data.
 512  *
 513 ** A description of a collection of \a type data.  \a repetitions is used only
 514 ** for arrays; it contains the number of elements.  \a offset is used only for
 515 ** struct members in host format; it contains the offset of the member from the
 516 ** beginning of the struct, taking into account internal padding added by the
 517 ** compiler for alignment purposes.  \a members, \a length, and \a tailPadding are
 518 ** used only for STRUCT_TYPE data; the \a length -long array \a members describes
 519 ** the members of the nested struct, and \a tailPadding indicates how many
 520 ** padding bytes the compiler adds to the end of the structure.
 521 */
 522
 523 typedef struct DataDescriptorStruct {
 524   DataTypes type;
 525   size_t repetitions;
 526   size_t offset;
 527   /*@null@*/ struct DataDescriptorStruct *members;
 528   size_t length;
 529   size_t tailPadding;
 530 } DataDescriptor;
 531 /** DataDescriptor for an array */
 532 #define SIMPLE_DATA(type,repetitions) \
 533   {type, repetitions, 0, NULL, 0, 0}
 534 /** DataDescriptor for an structure member */
 535 #define SIMPLE_MEMBER(type,repetitions,offset) \
 536   {type, repetitions, offset, NULL, 0, 0}
 537 /** DataDescriptor for padding bytes */
 538 #define PAD_BYTES(structType,lastMember,memberType,repetitions) \
 539   sizeof(structType) - offsetof(structType, lastMember) - \
 540   sizeof(memberType) * repetitions
 541
 542 gras_datadesc_type_t
 543 gras_datadesc_import_nws(const char           *name,
 544                          const DataDescriptor *desc,
 545                          unsigned long         howmany);
 546
 547
 548 SG_END_DECL()
 549
 550 #endif /* GRAS_DATADESC_H */