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