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 retrive 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 The mecanism for multidimensional arrays is known to be fragile and cumbersome. If you want to use it,
 109  *  you have to understand how it is implemented: the multiplication is performed using the sizes stack. In previous example,
 110  *  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
 111  *  added to \a cols. So, when the structure is sent, the rows field push its value onto the stack, then the \a cols field
 112  *  retrieve this value from the stack, compute (and push) the multiplication value. The \a matrix field can then retrive this
 113  *  value by poping the array. There is several ways for this to go wrong:
 114  *   - if the matrix field is placed before the sizes, the right value won't get pushed into the stack soon enough. Reorder your structure fields if needed.
 115  *   - if you write GRAS_ANNOTE(size,cols*rows); in previous example (inverting rows and cols in annotation),
 116  *     \a rows will be given a \ref gras_datadesc_cb_push_int_mult. This cannot work since it will try to
 117  *     pop the value which will be pushed by \a cols <i>afterward</i>.
 118  *   - if you have more than one matrix in your structure, don't interleave the size. They are pushed/poped in the structure order.
 119  *   - if some of the sizes are used in more than one matrix, you cannot use this mecanism -- sorry.
 120  *
 121  * If you cannot express your datadescs with this mechanism, you'll have to use the more advanced
 122  * (and somehow complex) one described below.
 123  *
 124  *  \warning Since GRAS_DEFINE_TYPE is a macro, you shouldn't put any comma in your type definition
 125  *  (comma separates macro args). For example, change \verbatim int a, b;\endverbatim to \verbatim int a;
 126  int b;\endverbatim
 127  */
 128 /** @{ */
 129
 130
 131 /**   @brief Automatically parse C code
 132  *    @hideinitializer
 133  */
 134 #define GRAS_DEFINE_TYPE(name,def) \
 135   static const char * _gras_this_type_symbol_does_not_exist__##name=#def; def
 136
 137 /** @brief Retrieve a datadesc which was previously parsed
 138  *  @hideinitializer
 139  */
 140 #define gras_datadesc_by_symbol(name)  \
 141   (gras_datadesc_by_name(#name) ?      \
 142    gras_datadesc_by_name(#name) :      \
 143      gras_datadesc_parse(#name,        \
 144                          _gras_this_type_symbol_does_not_exist__##name) \
 145   )
 146
 147 /** @def GRAS_ANNOTE
 148  *  @brief Add an annotation to a type to be automatically parsed
 149  */
 150 #define GRAS_ANNOTE(key,val)
 151
 152 /* @} */
 153
 154 gras_datadesc_type_t
 155 gras_datadesc_parse(const char *name, const char *C_statement);
 156
 157 /** @defgroup GRAS_dd_manual Simple manual data description
 158  *  @ingroup GRAS_dd
 159  *
 160  * Here are the functions to use if you want to declare your description manually.
 161  * The function names should be self-explanatory in most cases.
 162  *
 163  * You can add callbacks to the datatypes doing any kind of action you may want. Usually,
 164  * pre-send callbacks are used to prepare the type expedition while post-receive callbacks
 165  * are used to fix any issue after the receive.
 166  *
 167  * If your types are dynamic, you'll need to add some extra callback. For example, there is a
 168  * specific callback for the string type which is in charge of computing the length of the char
 169  * array. This is done with the cbps mechanism, explained in next section.
 170  *
 171  * If your types may contain pointer cycle, you must specify it to GRAS using the @ref gras_datadesc_cycle_set.
 172  *
 173  * Example:\verbatim
 174  typedef struct {
 175    unsigned char c1;
 176    unsigned long int l1;
 177    unsigned char c2;
 178    unsigned long int l2;
 179  } mystruct;
 180  [...]
 181   my_type=gras_datadesc_struct("mystruct");
 182   gras_datadesc_struct_append(my_type,"c1", gras_datadesc_by_name("unsigned char"));
 183   gras_datadesc_struct_append(my_type,"l1", gras_datadesc_by_name("unsigned long"));
 184   gras_datadesc_struct_append(my_type,"c2", gras_datadesc_by_name("unsigned char"));
 185   gras_datadesc_struct_append(my_type,"l2", gras_datadesc_by_name("unsigned long int"));
 186   gras_datadesc_struct_close(my_type);
 187
 188   my_type=gras_datadesc_ref("mystruct*", gras_datadesc_by_name("mystruct"));
 189
 190   [Use my_type to send pointers to mystruct data]\endverbatim
 191  */
 192 /* @{ */
 193
 194
 195 /** \brief Opaque type describing a type description callback persistant state. */
 196 typedef struct s_gras_cbps *gras_cbps_t;
 197
 198 /* callbacks prototypes */
 199 /** \brief Prototype of type callbacks returning nothing. */
 200 typedef void (*gras_datadesc_type_cb_void_t)(gras_datadesc_type_t typedesc, gras_cbps_t vars, void *data);
 201 /** \brief Prototype of type callbacks returning an int. */
 202 typedef int (*gras_datadesc_type_cb_int_t)(gras_datadesc_type_t typedesc, gras_cbps_t vars, void *data);
 203 /** \brief Prototype of type callbacks selecting a type. */
 204 typedef gras_datadesc_type_t (*gras_datadesc_selector_t)(gras_datadesc_type_t typedesc, gras_cbps_t vars, void *data);
 205
 206
 207 /******************************************
 208  **** Declare datadescription yourself ****
 209  ******************************************/
 210
 211 gras_datadesc_type_t gras_datadesc_struct(const char *name);
 212 void gras_datadesc_struct_append(gras_datadesc_type_t  struct_type,
 213                                  const char           *name,
 214                                  gras_datadesc_type_t  field_type);
 215 void gras_datadesc_struct_close(gras_datadesc_type_t   struct_type);
 216
 217
 218 gras_datadesc_type_t gras_datadesc_union(const char                 *name,
 219                                          gras_datadesc_type_cb_int_t selector);
 220 void gras_datadesc_union_append(gras_datadesc_type_t   union_type,
 221                                 const char            *name,
 222                                 gras_datadesc_type_t   field_type);
 223 void gras_datadesc_union_close(gras_datadesc_type_t    union_type);
 224
 225
 226 gras_datadesc_type_t
 227   gras_datadesc_ref(const char          *name,
 228                     gras_datadesc_type_t referenced_type);
 229 gras_datadesc_type_t
 230   gras_datadesc_ref_generic(const char              *name,
 231                             gras_datadesc_selector_t selector);
 232
 233 gras_datadesc_type_t
 234   gras_datadesc_array_fixed(const char          *name,
 235                             gras_datadesc_type_t element_type,
 236                             long int             fixed_size);
 237 gras_datadesc_type_t
 238   gras_datadesc_array_dyn(const char                 *name,
 239                           gras_datadesc_type_t        element_type,
 240                           gras_datadesc_type_cb_int_t dynamic_size);
 241 gras_datadesc_type_t
 242   gras_datadesc_ref_pop_arr(gras_datadesc_type_t  element_type);
 243
 244 gras_datadesc_type_t
 245   gras_datadesc_dynar(gras_datadesc_type_t elm_t,
 246                       void_f_pvoid_t *free_func);
 247
 248 /*********************************
 249  * Change stuff within datadescs *
 250  *********************************/
 251
 252 /** \brief Specify that this type may contain cycles */
 253 void gras_datadesc_cycle_set(gras_datadesc_type_t type);
 254 /** \brief Specify that this type do not contain any cycles (default) */
 255 void gras_datadesc_cycle_unset(gras_datadesc_type_t type);
 256 /** \brief Add a pre-send callback to this datadesc. */
 257 void gras_datadesc_cb_send (gras_datadesc_type_t         type,
 258                             gras_datadesc_type_cb_void_t pre);
 259 /** \brief Add a post-receive callback to this datadesc.*/
 260 void gras_datadesc_cb_recv(gras_datadesc_type_t          type,
 261                            gras_datadesc_type_cb_void_t  post);
 262 /** \brief Add a pre-send callback to the given field of the datadesc */
 263 void gras_datadesc_cb_field_send (gras_datadesc_type_t   type,
 264                                   const char            *field_name,
 265                                   gras_datadesc_type_cb_void_t  pre);
 266 /** \brief Add a post-receive callback to the given field of the datadesc */
 267 void gras_datadesc_cb_field_recv(gras_datadesc_type_t    type,
 268                                  const char             *field_name,
 269                                  gras_datadesc_type_cb_void_t  post);
 270 /** \brief Add a pre-send callback to the given field resulting in its value to be pushed */
 271 void gras_datadesc_cb_field_push (gras_datadesc_type_t   type,
 272                                   const char            *field_name);
 273 /** \brief Add a pre-send callback to the given field resulting in its value multiplied to any previously pushed value and then pushed back */
 274 void gras_datadesc_cb_field_push_multiplier (gras_datadesc_type_t type,
 275                                              const char          *field_name);
 276
 277 /******************************
 278  * Get stuff within datadescs *
 279  ******************************/
 280 /** \brief Returns the name of a datadescription */
 281 const char * gras_datadesc_get_name(gras_datadesc_type_t ddt);
 282 /** \brief Returns the identifier of a datadescription */
 283 int gras_datadesc_get_id(gras_datadesc_type_t ddt);
 284
 285 /* @} */
 286
 287 /** @defgroup GRAS_dd_cb_simple Data description with Callback Persistant State: Simple push/pop mechanism
 288  *  @ingroup GRAS_dd
 289  *
 290  * Sometimes, one of the callbacks need to leave information for the next ones. If this is a simple integer (such as
 291  * an array size), you can use the functions described here. If not, you'll have to play with the complete cbps interface.
 292  *
 293  * \htmlonly <!--  DOXYGEN_NAVBAR_LABEL="Simple push/pop Callback State" -->\endhtmlonly
 294  *
 295  * Here is an example:\verbatim
 296 struct s_array {
 297   int length;
 298   int *data;
 299 }
 300 [...]
 301 my_type=gras_datadesc_struct("s_array");
 302 gras_datadesc_struct_append(my_type,"length", gras_datadesc_by_name("int"));
 303 gras_datadesc_cb_field_send (my_type, "length", gras_datadesc_cb_push_int);
 304
 305 gras_datadesc_struct_append(my_type,"data",
 306                             gras_datadesc_array_dyn ("s_array::data",gras_datadesc_by_name("int"), gras_datadesc_cb_pop));
 307 gras_datadesc_struct_close(my_type);
 308 \endverbatim
 309
 310  *
 311  * The *_mult versions are intended for multi-dimensional arrays: They multiply their value to the previously pushed one
 312  * (by another field callback) and push the result of the multiplication back. An example of use follows. Please note
 313  * that the first field needs a regular push callback, not a multiplier one. Think of it as a stacked calculator (man dc(1)).\verbatim
 314 struct s_matrix {
 315   int row;
 316   int col;
 317   int *data;
 318 }
 319 [...]
 320 my_type=gras_datadesc_struct("s_matrix");
 321 gras_datadesc_struct_append(my_type,"row", gras_datadesc_by_name("int"));
 322 gras_datadesc_cb_field_send (my_type, "length", gras_datadesc_cb_push_int);
 323 gras_datadesc_struct_append(my_type,"col", gras_datadesc_by_name("int"));
 324 gras_datadesc_cb_field_send (my_type, "length", gras_datadesc_cb_push_int_mult);
 325
 326 gras_datadesc_struct_append(my_type,"data",
 327                             gras_datadesc_array_dyn ("s_matrix::data",gras_datadesc_by_name("int"), gras_datadesc_cb_pop));
 328 gras_datadesc_struct_close(my_type);
 329 \endverbatim
 330
 331  */
 332 /* @{ */
 333
 334 void
 335 gras_cbps_i_push(gras_cbps_t ps, int val);
 336 int
 337 gras_cbps_i_pop(gras_cbps_t ps);
 338
 339 int gras_datadesc_cb_pop(gras_datadesc_type_t typedesc, gras_cbps_t vars, void *data);
 340
 341 void gras_datadesc_cb_push_int(gras_datadesc_type_t typedesc, gras_cbps_t vars, void *data);
 342 void gras_datadesc_cb_push_uint(gras_datadesc_type_t typedesc, gras_cbps_t vars, void *data);
 343 void gras_datadesc_cb_push_lint(gras_datadesc_type_t typedesc, gras_cbps_t vars, void *data);
 344 void gras_datadesc_cb_push_ulint(gras_datadesc_type_t typedesc, gras_cbps_t vars, void *data);
 345
 346 void gras_datadesc_cb_push_int_mult(gras_datadesc_type_t typedesc, gras_cbps_t vars, void *data);
 347 void gras_datadesc_cb_push_uint_mult(gras_datadesc_type_t typedesc, gras_cbps_t vars, void *data);
 348 void gras_datadesc_cb_push_lint_mult(gras_datadesc_type_t typedesc, gras_cbps_t vars, void *data);
 349 void gras_datadesc_cb_push_ulint_mult(gras_datadesc_type_t typedesc, gras_cbps_t vars, void *data);
 350
 351
 352 /* @} */
 353
 354 /** @defgroup GRAS_dd_cb_full Data description with Callback Persistant State: Full featured interface
 355  *  @ingroup GRAS_dd
 356  *
 357  * Sometimes, one of the callbacks need to leave information for the next
 358  * ones. If the simple push/pop mechanism introduced in previous section
 359  * isn't enough, you can always use this full featured one. The bad point is
 360  * that it is quite badly documented...
 361  *
 362  * \htmlonly <!--  DOXYGEN_NAVBAR_LABEL="Full featured Callback State" -->\endhtmlonly
 363  *
 364  */
 365
 366 /* @{ */
 367
 368 void   gras_cbps_v_pop (gras_cbps_t            ps,
 369                         const char            *name,
 370               /* OUT */ gras_datadesc_type_t  *ddt,
 371               /* OUT */ void                 **res);
 372 void   gras_cbps_v_push(gras_cbps_t            ps,
 373                         const char            *name,
 374                         void                  *data,
 375                         gras_datadesc_type_t   ddt);
 376 void   gras_cbps_v_set (gras_cbps_t            ps,
 377                         const char            *name,
 378                         void                  *data,
 379                         gras_datadesc_type_t   ddt);
 380
 381 void * gras_cbps_v_get (gras_cbps_t            ps,
 382                         const char            *name,
 383               /* OUT */ gras_datadesc_type_t  *ddt);
 384
 385 void gras_cbps_block_begin(gras_cbps_t ps);
 386 void gras_cbps_block_end(gras_cbps_t ps);
 387
 388 /* @} */
 389 /* @} */
 390
 391
 392 /*******************************
 393  **** About data convertion ****
 394  *******************************/
 395 int gras_arch_selfid(void); /* ID of this arch */
 396
 397
 398 /*****************************
 399  **** NWS datadescription * FIXME: obsolete?
 400  *****************************/
 401
 402 /**
 403  * Basic types we can embeed in DataDescriptors.
 404  */
 405 typedef enum
 406   {CHAR_TYPE, DOUBLE_TYPE, FLOAT_TYPE, INT_TYPE, LONG_TYPE, SHORT_TYPE,
 407    UNSIGNED_INT_TYPE, UNSIGNED_LONG_TYPE, UNSIGNED_SHORT_TYPE, STRUCT_TYPE}
 408   DataTypes;
 409 #define SIMPLE_TYPE_COUNT 9
 410
 411 /**  \brief Describe a collection of data.
 412  *
 413 ** A description of a collection of \a type data.  \a repetitions is used only
 414 ** for arrays; it contains the number of elements.  \a offset is used only for
 415 ** struct members in host format; it contains the offset of the member from the
 416 ** beginning of the struct, taking into account internal padding added by the
 417 ** compiler for alignment purposes.  \a members, \a length, and \a tailPadding are
 418 ** used only for STRUCT_TYPE data; the \a length -long array \a members describes
 419 ** the members of the nested struct, and \a tailPadding indicates how many
 420 ** padding bytes the compiler adds to the end of the structure.
 421 */
 422
 423 typedef struct DataDescriptorStruct {
 424   DataTypes type;
 425   size_t repetitions;
 426   size_t offset;
 427   /*@null@*/ struct DataDescriptorStruct *members;
 428   size_t length;
 429   size_t tailPadding;
 430 } DataDescriptor;
 431 /** DataDescriptor for an array */
 432 #define SIMPLE_DATA(type,repetitions) \
 433   {type, repetitions, 0, NULL, 0, 0}
 434 /** DataDescriptor for an structure member */
 435 #define SIMPLE_MEMBER(type,repetitions,offset) \
 436   {type, repetitions, offset, NULL, 0, 0}
 437 /** DataDescriptor for padding bytes */
 438 #define PAD_BYTES(structType,lastMember,memberType,repetitions) \
 439   sizeof(structType) - offsetof(structType, lastMember) - \
 440   sizeof(memberType) * repetitions
 441
 442 gras_datadesc_type_t
 443 gras_datadesc_import_nws(const char           *name,
 444                          const DataDescriptor *desc,
 445                          unsigned long         howmany);
 446
 447
 448 SG_END_DECL()
 449
 450 #endif /* GRAS_DATADESC_H */