src/gras/DataDesc/ddt_create.c

   1 /* $Id$ */
   2
   3 /* ddt_new - creation/deletion of datatypes structs (private to this module)*/
   4
   5 /* Copyright (c) 2003 Olivier Aumage.                                       */
   6 /* Copyright (c) 2003, 2004 Martin Quinson.                                 */
   7 /* All rights reserved.                                                     */
   8
   9 /* This program is free software; you can redistribute it and/or modify it
  10  * under the terms of the license (GNU LGPL) which comes with this package. */
  11
  12 #include "xbt/misc.h" /* min()/max() */
  13 #include "xbt/ex.h"
  14 #include "gras/DataDesc/datadesc_private.h"
  15
  16 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(ddt_create,datadesc,"Creating new datadescriptions");
  17
  18 /*** prototypes ***/
  19 static gras_dd_cat_field_t
  20   gras_dd_find_field(gras_datadesc_type_t  type,
  21                      const char           *field_name);
  22 /**
  23  * gras_ddt_freev:
  24  *
  25  * gime that memory back, dude. I mean it.
  26  */
  27 void gras_ddt_freev(void *ddt) {
  28   gras_datadesc_type_t type= (gras_datadesc_type_t)ddt;
  29
  30   if (type) {
  31     gras_datadesc_free(&type);
  32   }
  33 }
  34
  35 static gras_datadesc_type_t gras_ddt_new(const char *name) {
  36   gras_datadesc_type_t res;
  37
  38   XBT_IN1("(%s)",name);
  39   res=xbt_new0(s_gras_datadesc_type_t,1);
  40
  41   res->name = (char*)strdup(name);
  42   res->name_len = strlen(name);
  43   res->cycle = 0;
  44
  45   xbt_set_add(gras_datadesc_set_local,
  46                (xbt_set_elm_t)res,&gras_ddt_freev);
  47   XBT_OUT;
  48   return res;
  49 }
  50
  51 /**
  52  * This returns NULL no type of this name can be found instead of throwing exceptions which would complicate the GRAS_DEFINE_TYPE macro
  53  */
  54 gras_datadesc_type_t gras_datadesc_by_name(const char *name) {
  55   xbt_ex_t e;
  56   gras_datadesc_type_t res;
  57   TRY {
  58     res = (gras_datadesc_type_t)xbt_set_get_by_name(gras_datadesc_set_local,name);
  59   } CATCH(e) {
  60     if (e.category != mismatch_error)
  61       RETHROW;
  62     res = NULL;
  63   }
  64   return res;
  65 }
  66
  67 /**
  68  * Retrieve a type from its code
  69  */
  70 gras_datadesc_type_t gras_datadesc_by_id(long int code) {
  71   return (gras_datadesc_type_t)xbt_set_get_by_id(gras_datadesc_set_local,code);
  72 }
  73
  74 /**
  75  * Create a new scalar and give a pointer to it
  76  */
  77 gras_datadesc_type_t
  78   gras_datadesc_scalar(const char                      *name,
  79                        gras_ddt_scalar_type_t           type,
  80                        enum e_gras_dd_scalar_encoding   encoding) {
  81
  82   gras_datadesc_type_t res;
  83   long int arch;
  84
  85   XBT_IN;
  86   res = gras_datadesc_by_name(name);
  87   if (res) {
  88     xbt_assert1(res->category_code == e_gras_datadesc_type_cat_scalar,
  89                  "Redefinition of type %s does not match", name);
  90     xbt_assert1(res->category.scalar_data.encoding == encoding,
  91                  "Redefinition of type %s does not match", name);
  92     xbt_assert1(res->category.scalar_data.type == type,
  93                  "Redefinition of type %s does not match", name);
  94     VERB1("Discarding redefinition of %s",name);
  95     return res;
  96   }
  97   res = gras_ddt_new(name);
  98
  99   for (arch = 0; arch < gras_arch_count; arch ++) {
 100     res->size[arch]         = gras_arches[arch].sizeofs[type];
 101     res->alignment[arch]    = gras_arches[arch].boundaries[type];
 102     res->aligned_size[arch] = aligned(res->size[arch], res->alignment[arch]);
 103   }
 104
 105   res->category_code                 = e_gras_datadesc_type_cat_scalar;
 106   res->category.scalar_data.encoding = encoding;
 107   res->category.scalar_data.type     = type;
 108   XBT_OUT;
 109
 110   return res;
 111 }
 112
 113
 114 /** Frees one struct or union field */
 115 void gras_dd_cat_field_free(void *f) {
 116   gras_dd_cat_field_t field = *(gras_dd_cat_field_t *)f;
 117   XBT_IN;
 118   if (field) {
 119     if (field->name)
 120       free(field->name);
 121     free(field);
 122   }
 123   XBT_OUT;
 124 }
 125
 126 /** \brief Declare a new structure description */
 127 gras_datadesc_type_t
 128   gras_datadesc_struct(const char            *name) {
 129
 130   gras_datadesc_type_t res;
 131   long int arch;
 132
 133   XBT_IN1("(%s)",name);
 134   res = gras_datadesc_by_name(name);
 135   if (res) {
 136     /* FIXME: Check that field redefinition matches */
 137     xbt_assert1(res->category_code == e_gras_datadesc_type_cat_struct,
 138                  "Redefinition of type %s does not match", name);
 139     VERB1("Discarding redefinition of %s",name);
 140     return res;
 141   }
 142   res = gras_ddt_new(name);
 143
 144   for (arch=0; arch<gras_arch_count; arch ++) {
 145     res->size[arch] = 0;
 146     res->alignment[arch] = 0;
 147     res->aligned_size[arch] = 0;
 148   }
 149   res->category_code = e_gras_datadesc_type_cat_struct;
 150   res->category.struct_data.fields =
 151        xbt_dynar_new(sizeof(gras_dd_cat_field_t),
 152                       &gras_dd_cat_field_free);
 153
 154   XBT_OUT;
 155   return res;
 156 }
 157
 158 /** \brief Append a new field to a structure description */
 159 void
 160 gras_datadesc_struct_append(gras_datadesc_type_t struct_type,
 161                             const char          *name,
 162                             gras_datadesc_type_t field_type) {
 163
 164   gras_dd_cat_field_t field;
 165   int arch;
 166
 167   xbt_assert2(field_type,
 168                "Cannot add the field '%s' into struct '%s': its type is NULL. Typo in get_by_name?",
 169                name,struct_type->name);
 170   XBT_IN3("(%s %s.%s;)",field_type->name,struct_type->name,name);
 171   if (struct_type->category.struct_data.closed) {
 172     VERB1("Ignoring request to add field to struct %s (closed. Redefinition?)",
 173           struct_type->name);
 174     return;
 175   }
 176
 177   xbt_assert1(field_type->size != 0,
 178                "Cannot add a dynamically sized field in structure %s",
 179                struct_type->name);
 180
 181   field=xbt_new(s_gras_dd_cat_field_t,1);
 182   field->name   = (char*)strdup(name);
 183
 184   DEBUG0("----------------");
 185   DEBUG3("PRE s={size=%ld,align=%ld,asize=%ld}",
 186          struct_type->size[GRAS_THISARCH],
 187          struct_type->alignment[GRAS_THISARCH],
 188          struct_type->aligned_size[GRAS_THISARCH]);
 189
 190
 191   for (arch=0; arch<gras_arch_count; arch ++) {
 192     field->offset[arch] = aligned(struct_type->size[arch],
 193                                   field_type->alignment[arch]);
 194
 195     struct_type->size[arch] = field->offset[arch] + field_type->size[arch];
 196     struct_type->alignment[arch] = max(struct_type->alignment[arch],
 197                                        field_type->alignment[arch]);
 198     struct_type->aligned_size[arch] = aligned(struct_type->size[arch],
 199                                               struct_type->alignment[arch]);
 200   }
 201   field->type   = field_type;
 202   field->send   = NULL;
 203   field->recv   = NULL;
 204
 205   xbt_dynar_push(struct_type->category.struct_data.fields, &field);
 206
 207   DEBUG3("Push a %s into %s at offset %ld.",
 208          field_type->name, struct_type->name,field->offset[GRAS_THISARCH]);
 209   DEBUG3("  f={size=%ld,align=%ld,asize=%ld}",
 210          field_type->size[GRAS_THISARCH],
 211          field_type->alignment[GRAS_THISARCH],
 212          field_type->aligned_size[GRAS_THISARCH]);
 213   DEBUG3("  s={size=%ld,align=%ld,asize=%ld}",
 214          struct_type->size[GRAS_THISARCH],
 215          struct_type->alignment[GRAS_THISARCH],
 216          struct_type->aligned_size[GRAS_THISARCH]);
 217   XBT_OUT;
 218 }
 219
 220 /** \brief Close a structure description
 221  *
 222  * No new field can be added afterward, and it is mandatory to close the structure before using it.
 223  */
 224 void
 225 gras_datadesc_struct_close(gras_datadesc_type_t struct_type) {
 226   XBT_IN;
 227   struct_type->category.struct_data.closed = 1;
 228   DEBUG4("structure %s closed. size=%ld,align=%ld,asize=%ld",
 229          struct_type->name,
 230          struct_type->size[GRAS_THISARCH],
 231          struct_type->alignment[GRAS_THISARCH],
 232          struct_type->aligned_size[GRAS_THISARCH]);
 233 }
 234
 235 /**
 236  * gras_datadesc_cycle_set:
 237  *
 238  * Tell GRAS that the pointers of the type described by ddt may present
 239  * some loop, and that the cycle detection mechanism is needed.
 240  *
 241  * Note that setting this option when not needed have a rather bad effect
 242  * on the performance (several times slower on big data).
 243  */
 244 void
 245 gras_datadesc_cycle_set(gras_datadesc_type_t ddt) {
 246   ddt->cycle = 1;
 247 }
 248
 249 /**
 250  * gras_datadesc_cycle_unset:
 251  *
 252  * Tell GRAS that the pointers of the type described by ddt do not present
 253  * any loop and that cycle detection mechanism are not needed.
 254  * (default)
 255  */
 256 void
 257 gras_datadesc_cycle_unset(gras_datadesc_type_t ddt) {
 258   ddt->cycle = 0;
 259 }
 260
 261 /** \brief Declare a new union description */
 262 gras_datadesc_type_t
 263   gras_datadesc_union(const char                   *name,
 264                       gras_datadesc_type_cb_int_t   selector) {
 265
 266   gras_datadesc_type_t res;
 267   int arch;
 268
 269   XBT_IN1("(%s)",name);
 270   xbt_assert0(selector,
 271                "Attempt to creat an union without field_count function");
 272
 273   res = gras_datadesc_by_name(name);
 274   if (res) {
 275     /* FIXME: Check that field redefinition matches */
 276     xbt_assert1(res->category_code == e_gras_datadesc_type_cat_union,
 277                  "Redefinition of type %s does not match", name);
 278     xbt_assert1(res->category.union_data.selector == selector,
 279                  "Redefinition of type %s does not match", name);
 280     VERB1("Discarding redefinition of %s",name);
 281     return res;
 282   }
 283
 284   res = gras_ddt_new(name);
 285
 286   for (arch=0; arch<gras_arch_count; arch ++) {
 287      res->size[arch] = 0;
 288      res->alignment[arch] = 0;
 289      res->aligned_size[arch] = 0;
 290   }
 291
 292   res->category_code            = e_gras_datadesc_type_cat_union;
 293   res->category.union_data.fields =
 294      xbt_dynar_new(sizeof(gras_dd_cat_field_t*),
 295                     &gras_dd_cat_field_free);
 296   res->category.union_data.selector = selector;
 297
 298   return res;
 299 }
 300
 301 /** \brief Append a new field to an union description */
 302 void gras_datadesc_union_append(gras_datadesc_type_t  union_type,
 303                                 const char           *name,
 304                                 gras_datadesc_type_t  field_type) {
 305
 306   gras_dd_cat_field_t field;
 307   int arch;
 308
 309   XBT_IN3("(%s %s.%s;)",field_type->name,union_type->name,name);
 310   xbt_assert1(field_type->size != 0,
 311                "Cannot add a dynamically sized field in union %s",
 312                union_type->name);
 313
 314   if (union_type->category.union_data.closed) {
 315     VERB1("Ignoring request to add field to union %s (closed)",
 316            union_type->name);
 317     return;
 318   }
 319
 320   field=xbt_new0(s_gras_dd_cat_field_t,1);
 321
 322   field->name   = (char*)strdup(name);
 323   field->type   = field_type;
 324   /* All offset are left to 0 in an union */
 325
 326   xbt_dynar_push(union_type->category.union_data.fields, &field);
 327
 328   for (arch=0; arch<gras_arch_count; arch ++) {
 329     union_type->size[arch] = max(union_type->size[arch],
 330                                  field_type->size[arch]);
 331     union_type->alignment[arch] = max(union_type->alignment[arch],
 332                                       field_type->alignment[arch]);
 333     union_type->aligned_size[arch] = aligned(union_type->size[arch],
 334                                              union_type->alignment[arch]);
 335   }
 336 }
 337
 338
 339 /** \brief Close an union description
 340  *
 341  * No new field can be added afterward, and it is mandatory to close the union before using it.
 342  */
 343 void
 344 gras_datadesc_union_close(gras_datadesc_type_t union_type) {
 345    union_type->category.union_data.closed = 1;
 346 }
 347
 348 /** \brief Declare a new type being a reference to the one passed in arg */
 349 gras_datadesc_type_t
 350   gras_datadesc_ref(const char           *name,
 351                     gras_datadesc_type_t  referenced_type) {
 352
 353   gras_datadesc_type_t res;
 354   gras_datadesc_type_t pointer_type = gras_datadesc_by_name("data pointer");
 355   int arch;
 356
 357   XBT_IN1("(%s)",name);
 358   res = gras_datadesc_by_name(name);
 359   if (res) {
 360     xbt_assert1(res->category_code == e_gras_datadesc_type_cat_ref,
 361                  "Redefinition of %s does not match",name);
 362     xbt_assert1(res->category.ref_data.type == referenced_type,
 363                  "Redefinition of %s does not match",name);
 364     xbt_assert1(res->category.ref_data.selector == NULL,
 365                  "Redefinition of %s does not match",name);
 366     VERB1("Discarding redefinition of %s",name);
 367     return res;
 368   }
 369
 370   res = gras_ddt_new(name);
 371
 372   xbt_assert0(pointer_type, "Cannot get the description of data pointer");
 373
 374   for (arch=0; arch<gras_arch_count; arch ++){
 375     res->size[arch] = pointer_type->size[arch];
 376     res->alignment[arch] = pointer_type->alignment[arch];
 377     res->aligned_size[arch] = pointer_type->aligned_size[arch];
 378   }
 379
 380   res->category_code              = e_gras_datadesc_type_cat_ref;
 381   res->category.ref_data.type     = referenced_type;
 382   res->category.ref_data.selector = NULL;
 383
 384   return res;
 385 }
 386 /** \brief Declare a new type being a generic reference.
 387  *
 388  * The callback passed in argument is to be used to select which type is currently used.
 389  * So, when GRAS wants to send a generic reference, it passes the current data to the selector
 390  * callback and expects it to return the type description to use.
 391  */
 392 gras_datadesc_type_t
 393   gras_datadesc_ref_generic(const char                *name,
 394                             gras_datadesc_selector_t   selector) {
 395
 396   gras_datadesc_type_t res;
 397   gras_datadesc_type_t pointer_type = gras_datadesc_by_name("data pointer");
 398   int arch;
 399
 400   XBT_IN1("(%s)",name);
 401   res = gras_datadesc_by_name(name);
 402
 403   if (res) {
 404     xbt_assert1(res->category_code == e_gras_datadesc_type_cat_ref,
 405                  "Redefinition of type %s does not match", name);
 406     xbt_assert1(res->category.ref_data.type == NULL,
 407                  "Redefinition of type %s does not match", name);
 408     xbt_assert1(res->category.ref_data.selector == selector,
 409                  "Redefinition of type %s does not match", name);
 410     VERB1("Discarding redefinition of %s",name);
 411     return res;
 412   }
 413   res = gras_ddt_new(name);
 414
 415   xbt_assert0(pointer_type, "Cannot get the description of data pointer");
 416
 417   for (arch=0; arch<gras_arch_count; arch ++) {
 418     res->size[arch] = pointer_type->size[arch];
 419     res->alignment[arch] = pointer_type->alignment[arch];
 420     res->aligned_size[arch] = pointer_type->aligned_size[arch];
 421   }
 422
 423   res->category_code            = e_gras_datadesc_type_cat_ref;
 424
 425   res->category.ref_data.type     = NULL;
 426   res->category.ref_data.selector = selector;
 427
 428   return res;
 429 }
 430
 431 /** \brief Declare a new type being an array of fixed size and content */
 432 gras_datadesc_type_t
 433   gras_datadesc_array_fixed(const char           *name,
 434                             gras_datadesc_type_t  element_type,
 435                             long int              fixed_size) {
 436
 437   gras_datadesc_type_t res;
 438   int arch;
 439
 440   XBT_IN1("(%s)",name);
 441   res = gras_datadesc_by_name(name);
 442   if (res) {
 443     xbt_assert1(res->category_code == e_gras_datadesc_type_cat_array,
 444                  "Redefinition of type %s does not match", name);
 445
 446     if (res->category.array_data.type != element_type) {
 447        ERROR1("Redefinition of type %s does not match: array elements differ", name);
 448        gras_datadesc_type_dump(res->category.array_data.type);
 449        gras_datadesc_type_dump(element_type);
 450     }
 451
 452     xbt_assert1(res->category.array_data.fixed_size == fixed_size,
 453                  "Redefinition of type %s does not match", name);
 454     xbt_assert1(res->category.array_data.dynamic_size == NULL,
 455                  "Redefinition of type %s does not match", name);
 456     VERB1("Discarding redefinition of %s",name);
 457
 458     return res;
 459   }
 460   res = gras_ddt_new(name);
 461
 462   xbt_assert1(fixed_size > 0, "'%s' is a array of null fixed size",name);
 463   for (arch=0; arch<gras_arch_count; arch ++) {
 464     res->size[arch] = fixed_size * element_type->aligned_size[arch];
 465     res->alignment[arch] = element_type->alignment[arch];
 466     res->aligned_size[arch] = res->size[arch];
 467   }
 468
 469   res->category_code            = e_gras_datadesc_type_cat_array;
 470
 471   res->category.array_data.type         = element_type;
 472   res->category.array_data.fixed_size   = fixed_size;
 473   res->category.array_data.dynamic_size = NULL;
 474
 475   return res;
 476 }
 477
 478 /** \brief Declare a new type being an array of fixed size, but accepting several content types. */
 479 gras_datadesc_type_t gras_datadesc_array_dyn(const char                 *name,
 480                                              gras_datadesc_type_t        element_type,
 481                                              gras_datadesc_type_cb_int_t dynamic_size) {
 482
 483   gras_datadesc_type_t res;
 484   int arch;
 485
 486   XBT_IN1("(%s)",name);
 487   xbt_assert1(dynamic_size,
 488                "'%s' is a dynamic array without size discriminant",
 489                name);
 490
 491   res = gras_datadesc_by_name(name);
 492   if (res) {
 493     xbt_assert1(res->category_code == e_gras_datadesc_type_cat_array,
 494                  "Redefinition of type %s does not match", name);
 495     xbt_assert1(res->category.array_data.type == element_type,
 496                  "Redefinition of type %s does not match", name);
 497     xbt_assert1(res->category.array_data.fixed_size == 0,
 498                  "Redefinition of type %s does not match", name);
 499     xbt_assert1(res->category.array_data.dynamic_size == dynamic_size,
 500                  "Redefinition of type %s does not match", name);
 501     VERB1("Discarding redefinition of %s",name);
 502
 503     return res;
 504   }
 505
 506   res = gras_ddt_new(name);
 507
 508   for (arch=0; arch<gras_arch_count; arch ++) {
 509     res->size[arch] = 0; /* make sure it indicates "dynamic" */
 510     res->alignment[arch] = element_type->alignment[arch];
 511     res->aligned_size[arch] = 0; /*FIXME: That was so in GS, but looks stupid*/
 512   }
 513
 514   res->category_code            = e_gras_datadesc_type_cat_array;
 515
 516   res->category.array_data.type         = element_type;
 517   res->category.array_data.fixed_size   = 0;
 518   res->category.array_data.dynamic_size = dynamic_size;
 519
 520   return res;
 521 }
 522
 523 /** \brief Declare a new type being an array which size can be found with \ref gras_cbps_i_pop
 524  *
 525  * Most of the time, you want to include a reference in your structure which
 526  * is a pointer to a dynamic array whose size is fixed by another field of
 527  * your structure.
 528  *
 529  * This case pops up so often that this function was created to take care of
 530  * this case. It creates a dynamic array type whose size is poped from the
 531  * current cbps, and then create a reference to it.
 532  *
 533  * The name of the created datatype will be the name of the element type, with
 534  * '[]*' appended to it.
 535  *
 536  * Then to use it, you just have to make sure that your structure pre-callback
 537  * does push the size of the array in the cbps (using #gras_cbps_i_push), and
 538  * you are set.
 539  *
 540  * But be remember that this is a stack. If you have two different pop_arr, you
 541  * should push the second one first, so that the first one is on the top of the
 542  * list when the first field gets transfered.
 543  *
 544  */
 545 gras_datadesc_type_t
 546   gras_datadesc_ref_pop_arr(gras_datadesc_type_t element_type) {
 547
 548   gras_datadesc_type_t res;
 549   char *name=(char*)xbt_malloc(strlen(element_type->name) + 4);
 550
 551   sprintf(name,"%s[]",element_type->name);
 552
 553   res = gras_datadesc_array_dyn(name,element_type,
 554                                 gras_datadesc_cb_pop);
 555
 556   sprintf(name,"%s[]*",element_type->name);
 557   res = gras_datadesc_ref(name,res);
 558
 559   free(name);
 560
 561   return res;
 562 }
 563
 564 #include "xbt/dynar_private.h"
 565 static void gras_datadesc_dynar_cb(gras_datadesc_type_t typedesc, gras_cbps_t vars, void *data) {
 566   gras_datadesc_type_t subtype;
 567   xbt_dynar_t dynar=(xbt_dynar_t)data;
 568
 569   memcpy(&dynar->free_f, &typedesc->extra, sizeof(dynar->free_f));
 570
 571   /* search for the elemsize in what we have. If elements are "int", typedesc got is "int[]*" */
 572   subtype = gras_dd_find_field(typedesc,"data")->type;
 573
 574   /* this is now a ref to array of what we're looking for */
 575   subtype = subtype->category.ref_data.type;
 576   subtype = subtype->category.array_data.type;
 577
 578   DEBUG1("subtype is %s",subtype->name);
 579
 580   dynar->elmsize = subtype->size[GRAS_THISARCH];
 581   dynar->size = dynar->used;
 582 }
 583
 584 gras_datadesc_type_t
 585 gras_datadesc_dynar(gras_datadesc_type_t elm_t,
 586                     void_f_pvoid_t *free_func) {
 587
 588   char *buffname;
 589   gras_datadesc_type_t res;
 590
 591   buffname=xbt_new0(char, strlen(elm_t->name)+10);
 592   sprintf(buffname,"dynar(%s)_s",elm_t->name);
 593
 594   res = gras_datadesc_struct(buffname);
 595
 596   gras_datadesc_struct_append(res, "size",    gras_datadesc_by_name("unsigned long int"));
 597
 598   gras_datadesc_struct_append(res, "used",    gras_datadesc_by_name("unsigned long int"));
 599   gras_datadesc_cb_field_push(res, "used");
 600
 601   gras_datadesc_struct_append(res, "elmsize", gras_datadesc_by_name("unsigned long int"));
 602
 603   gras_datadesc_struct_append(res, "data",    gras_datadesc_ref_pop_arr (elm_t));
 604
 605   gras_datadesc_struct_append(res, "free_f",  gras_datadesc_by_name("function pointer"));
 606   memcpy(res->extra,&free_func,sizeof(free_func));
 607
 608   gras_datadesc_struct_close(res);
 609
 610   gras_datadesc_cb_recv(res,  &gras_datadesc_dynar_cb);
 611
 612   /* build a ref to it */
 613   sprintf(buffname,"dynar(%s)",elm_t->name);
 614   res=gras_datadesc_ref(buffname,res);
 615   free(buffname);
 616   return res;
 617 }
 618
 619 xbt_error_t
 620 gras_datadesc_import_nws(const char           *name,
 621                          const DataDescriptor *desc,
 622                          unsigned long         howmany,
 623                /* OUT */ gras_datadesc_type_t *dst) {
 624   THROW_UNIMPLEMENTED;
 625 }
 626
 627 /**
 628  * (useful to push the sizes of the upcoming arrays, for example)
 629  */
 630 void gras_datadesc_cb_send (gras_datadesc_type_t          type,
 631                             gras_datadesc_type_cb_void_t  send) {
 632   type->send = send;
 633 }
 634 /**
 635  * (useful to put the function pointers to the rigth value, for example)
 636  */
 637 void gras_datadesc_cb_recv(gras_datadesc_type_t          type,
 638                            gras_datadesc_type_cb_void_t  recv) {
 639   type->recv = recv;
 640 }
 641 /*
 642  * gras_dd_find_field:
 643  *
 644  * Returns the type descriptor of the given field. Abort on error.
 645  */
 646 static gras_dd_cat_field_t
 647   gras_dd_find_field(gras_datadesc_type_t  type,
 648                      const char           *field_name) {
 649    xbt_dynar_t         field_array;
 650
 651    gras_dd_cat_field_t  field=NULL;
 652    int                  field_num;
 653
 654    if (type->category_code == e_gras_datadesc_type_cat_union) {
 655       field_array = type->category.union_data.fields;
 656    } else if (type->category_code == e_gras_datadesc_type_cat_struct) {
 657       field_array = type->category.struct_data.fields;
 658    } else {
 659       ERROR2("%s (%p) is not a struct nor an union. There is no field.", type->name,(void*)type);
 660       xbt_abort();
 661    }
 662    xbt_dynar_foreach(field_array,field_num,field) {
 663       if (!strcmp(field_name,field->name)) {
 664          return field;
 665       }
 666    }
 667    ERROR2("No field nammed %s in %s",field_name,type->name);
 668    xbt_abort();
 669
 670 }
 671
 672 /**
 673  * The given datadesc must be a struct or union (abort if not).
 674  * (useful to push the sizes of the upcoming arrays, for example)
 675  */
 676 void gras_datadesc_cb_field_send (gras_datadesc_type_t          type,
 677                                   const char                   *field_name,
 678                                   gras_datadesc_type_cb_void_t  send) {
 679
 680    gras_dd_cat_field_t field=gras_dd_find_field(type,field_name);
 681    field->send = send;
 682 }
 683
 684 /**
 685  * The value, which must be an int, unsigned int, long int or unsigned long int
 686  * is pushed to the stacks of sizes and can then be retrieved with
 687  * \ref gras_datadesc_ref_pop_arr or directly with \ref gras_cbps_i_pop.
 688  */
 689 void gras_datadesc_cb_field_push (gras_datadesc_type_t  type,
 690                                   const char           *field_name) {
 691
 692    gras_dd_cat_field_t  field=gras_dd_find_field(type,field_name);
 693    gras_datadesc_type_t sub_type=field->type;
 694
 695    DEBUG3("add a PUSHy cb to '%s' field (type '%s') of '%s'",
 696           field_name,sub_type->name,type->name);
 697    if (!strcmp("int",sub_type->name)) {
 698       field->send = gras_datadesc_cb_push_int;
 699    } else if (!strcmp("unsigned int",sub_type->name)) {
 700       field->send = gras_datadesc_cb_push_uint;
 701    } else if (!strcmp("long int",sub_type->name)) {
 702       field->send = gras_datadesc_cb_push_lint;
 703    } else if (!strcmp("unsigned long int",sub_type->name)) {
 704       field->send = gras_datadesc_cb_push_ulint;
 705    } else {
 706       ERROR1("Field %s is not an int, unsigned int, long int neither unsigned long int",
 707              sub_type->name);
 708       xbt_abort();
 709    }
 710 }
 711 /**
 712  * The given datadesc must be a struct or union (abort if not).
 713  * (useful to put the function pointers to the right value, for example)
 714  */
 715 void gras_datadesc_cb_field_recv(gras_datadesc_type_t          type,
 716                                  const char                   *field_name,
 717                                  gras_datadesc_type_cb_void_t  recv) {
 718
 719    gras_dd_cat_field_t field=gras_dd_find_field(type,field_name);
 720    field->recv = recv;
 721 }
 722
 723 /*
 724  * Free a datadesc. Should only be called at xbt_exit.
 725  */
 726 void gras_datadesc_free(gras_datadesc_type_t *type) {
 727
 728   DEBUG1("Let's free ddt %s",(*type)->name);
 729
 730   switch ((*type)->category_code) {
 731   case e_gras_datadesc_type_cat_scalar:
 732   case e_gras_datadesc_type_cat_ref:
 733   case e_gras_datadesc_type_cat_array:
 734     /* nothing to free in there */
 735     break;
 736
 737   case e_gras_datadesc_type_cat_struct:
 738     xbt_dynar_free(&( (*type)->category.struct_data.fields ));
 739     break;
 740
 741   case e_gras_datadesc_type_cat_union:
 742     xbt_dynar_free(&( (*type)->category.union_data.fields ));
 743     break;
 744
 745   default:
 746     /* datadesc was invalid. Killing it is like euthanasy, I guess */
 747     break;
 748   }
 749   free((*type)->name);
 750   free(*type);
 751   type=NULL;
 752 }
 753
 754 /**
 755  * gras_datadesc_type_cmp:
 756  *
 757  * Compares two datadesc types with the same semantic than strcmp.
 758  *
 759  * This comparison does not take the set headers into account (name and ID),
 760  * but only the payload (actual type description).
 761  */
 762 int gras_datadesc_type_cmp(const gras_datadesc_type_t d1,
 763                            const gras_datadesc_type_t d2) {
 764   int ret,cpt;
 765   gras_dd_cat_field_t field1,field2;
 766   gras_datadesc_type_t field_desc_1,field_desc_2;
 767
 768   if (d1 == d2) return 0; /* easy optimization */
 769
 770   if (!d1 && d2) {
 771     DEBUG0("ddt_cmp: !d1 && d2 => 1");
 772     return 1;
 773   }
 774   if (!d1 && !d2) {
 775     DEBUG0("ddt_cmp: !d1 && !d2 => 0");
 776     return 0;
 777   }
 778   if ( d1 && !d2) {
 779     DEBUG0("ddt_cmp: d1 && !d2 => -1");
 780     return -1;
 781   }
 782
 783   for (cpt=0; cpt<gras_arch_count; cpt++) {
 784     if (d1->size[cpt] != d2->size[cpt]) {
 785       DEBUG5("ddt_cmp: %s->size=%ld  !=  %s->size=%ld (on %s)",
 786              d1->name,d1->size[cpt],d2->name,d2->size[cpt],
 787              gras_arches[cpt].name);
 788       return d1->size[cpt] >  d2->size[cpt] ? 1 : -1;
 789     }
 790
 791     if (d1->alignment[cpt] != d2->alignment[cpt]) {
 792       DEBUG5("ddt_cmp: %s->alignment=%ld  !=  %s->alignment=%ld (on %s)",
 793              d1->name,d1->alignment[cpt],d2->name,d2->alignment[cpt],
 794              gras_arches[cpt].name);
 795       return d1->alignment[cpt] > d2->alignment[cpt] ? 1 : -1;
 796     }
 797
 798     if (d1->aligned_size[cpt] != d2->aligned_size[cpt]) {
 799       DEBUG5("ddt_cmp: %s->aligned_size=%ld  !=  %s->aligned_size=%ld (on %s)",
 800              d1->name,d1->aligned_size[cpt],d2->name,d2->aligned_size[cpt],
 801              gras_arches[cpt].name);
 802       return d1->aligned_size[cpt] > d2->aligned_size[cpt] ? 1 : -1;
 803     }
 804   }
 805
 806   if (d1->category_code != d2->category_code) {
 807     DEBUG4("ddt_cmp: %s->cat=%s  !=  %s->cat=%s",
 808            d1->name,gras_datadesc_cat_names[d1->category_code],
 809            d2->name,gras_datadesc_cat_names[d2->category_code]);
 810     return d1->category_code > d2->category_code ? 1 : -1;
 811   }
 812
 813   if (d1->send != d2->send) {
 814     DEBUG4("ddt_cmp: %s->send=%p  !=  %s->send=%p",
 815            d1->name,(void*)d1->send, d2->name,(void*)d2->send);
 816     return 1; /* ISO C forbids ordered comparisons of pointers to functions */
 817   }
 818
 819   if (d1->recv != d2->recv) {
 820     DEBUG4("ddt_cmp: %s->recv=%p  !=  %s->recv=%p",
 821            d1->name,(void*)d1->recv, d2->name,(void*)d2->recv);
 822     return 1; /* ISO C forbids ordered comparisons of pointers to functions */
 823   }
 824
 825   switch (d1->category_code) {
 826   case e_gras_datadesc_type_cat_scalar:
 827     if (d1->category.scalar_data.encoding != d2->category.scalar_data.encoding)
 828       return d1->category.scalar_data.encoding > d2->category.scalar_data.encoding ? 1 : -1 ;
 829     break;
 830
 831   case e_gras_datadesc_type_cat_struct:
 832     if (xbt_dynar_length(d1->category.struct_data.fields) !=
 833         xbt_dynar_length(d2->category.struct_data.fields)) {
 834       DEBUG4("ddt_cmp: %s (having %lu fields) !=  %s (having %lu fields)",
 835              d1->name, xbt_dynar_length(d1->category.struct_data.fields),
 836              d2->name, xbt_dynar_length(d2->category.struct_data.fields));
 837
 838       return xbt_dynar_length(d1->category.struct_data.fields) >
 839         xbt_dynar_length(d2->category.struct_data.fields) ?
 840         1 : -1;
 841     }
 842     xbt_dynar_foreach(d1->category.struct_data.fields, cpt, field1) {
 843
 844       field2 = xbt_dynar_get_as(d2->category.struct_data.fields, cpt, gras_dd_cat_field_t);
 845       field_desc_1 = field1->type;
 846       field_desc_2 = field2->type;
 847       ret = gras_datadesc_type_cmp(field_desc_1,field_desc_2);
 848       if (ret) {
 849         DEBUG6("%s->field[%d]=%s != %s->field[%d]=%s",
 850                d1->name,cpt,field1->name,
 851                d2->name,cpt,field2->name);
 852         return ret;
 853       }
 854
 855     }
 856     break;
 857
 858   case e_gras_datadesc_type_cat_union:
 859     if (d1->category.union_data.selector != d2->category.union_data.selector)
 860       return 1;  /* ISO C forbids ordered comparisons of pointers to functions */
 861
 862     if (xbt_dynar_length(d1->category.union_data.fields) !=
 863         xbt_dynar_length(d2->category.union_data.fields))
 864       return xbt_dynar_length(d1->category.union_data.fields) >
 865              xbt_dynar_length(d2->category.union_data.fields) ?
 866         1 : -1;
 867
 868     xbt_dynar_foreach(d1->category.union_data.fields, cpt, field1) {
 869
 870       field2 = xbt_dynar_get_as(d2->category.union_data.fields, cpt, gras_dd_cat_field_t);
 871       field_desc_1 = field1->type;
 872       field_desc_2 = field2->type;
 873       ret = gras_datadesc_type_cmp(field_desc_1,field_desc_2);
 874       if (ret)
 875         return ret;
 876
 877     }
 878     break;
 879
 880
 881   case e_gras_datadesc_type_cat_ref:
 882     if (d1->category.ref_data.selector != d2->category.ref_data.selector)
 883       return 1; /* ISO C forbids ordered comparisons of pointers to functions */
 884
 885     if (d1->category.ref_data.type != d2->category.ref_data.type)
 886       return d1->category.ref_data.type > d2->category.ref_data.type ? 1 : -1;
 887     break;
 888
 889   case e_gras_datadesc_type_cat_array:
 890     if (d1->category.array_data.type != d2->category.array_data.type)
 891       return d1->category.array_data.type > d2->category.array_data.type ? 1 : -1;
 892
 893     if (d1->category.array_data.fixed_size != d2->category.array_data.fixed_size)
 894       return d1->category.array_data.fixed_size > d2->category.array_data.fixed_size ? 1 : -1;
 895
 896     if (d1->category.array_data.dynamic_size != d2->category.array_data.dynamic_size)
 897       return 1; /* ISO C forbids ordered comparisons of pointers to functions */
 898
 899     break;
 900
 901   default:
 902     /* two stupidly created ddt are equally stupid ;) */
 903     break;
 904   }
 905   return 0;
 906
 907 }