3 /* ddt_new - creation/deletion of datatypes structs (private to this module)*/
5 /* Copyright (c) 2003 Olivier Aumage. */
6 /* Copyright (c) 2003, 2004 Martin Quinson. */
7 /* All rights reserved. */
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. */
12 #include "xbt/misc.h" /* min()/max() */
13 #include "gras/DataDesc/datadesc_private.h"
15 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(ddt_create,datadesc,"Creating new datadescriptions");
20 * gime that memory back, dude. I mean it.
22 void gras_ddt_freev(void *ddt) {
23 gras_datadesc_type_t type= (gras_datadesc_type_t)ddt;
26 gras_datadesc_free(&type);
30 static gras_datadesc_type_t gras_ddt_new(const char *name) {
31 gras_datadesc_type_t res;
34 res=xbt_new0(s_gras_datadesc_type_t,1);
36 res->name = (char*)strdup(name);
37 res->name_len = strlen(name);
40 xbt_set_add(gras_datadesc_set_local,
41 (xbt_set_elm_t)res,&gras_ddt_freev);
47 * gras_datadesc_by_name:
49 * Retrieve a type from its name
51 gras_datadesc_type_t gras_datadesc_by_name(const char *name) {
53 gras_datadesc_type_t type;
56 if (xbt_set_get_by_name(gras_datadesc_set_local,
57 name,(xbt_set_elm_t*)&type) == no_error) {
67 * gras_datadesc_by_id:
69 * Retrieve a type from its code
71 xbt_error_t gras_datadesc_by_id(long int code,
72 gras_datadesc_type_t *type) {
74 return xbt_set_get_by_id(gras_datadesc_set_local,
75 code,(xbt_set_elm_t*)type);
79 * gras_datadesc_scalar:
81 * Create a new scalar and give a pointer to it
84 gras_datadesc_scalar(const char *name,
85 gras_ddt_scalar_type_t type,
86 enum e_gras_dd_scalar_encoding encoding) {
88 gras_datadesc_type_t res;
92 res = gras_datadesc_by_name(name);
94 xbt_assert1(res->category_code == e_gras_datadesc_type_cat_scalar,
95 "Redefinition of type %s does not match", name);
96 xbt_assert1(res->category.scalar_data.encoding == encoding,
97 "Redefinition of type %s does not match", name);
98 xbt_assert1(res->category.scalar_data.type == type,
99 "Redefinition of type %s does not match", name);
100 VERB1("Discarding redefinition of %s",name);
103 res = gras_ddt_new(name);
105 for (arch = 0; arch < gras_arch_count; arch ++) {
110 res->size[arch] = gras_arches[arch].sizeofs[type];
111 res->alignment[arch] = gras_arches[arch].boundaries[type];
112 res->aligned_size[arch] = aligned(res->size[arch], res->alignment[arch]);
113 /* FIXME: kill the following after discution with Oli */
115 sz = res->size[arch];
118 /* just in case you wonder, x>>1 == x/2 on all architectures when x>=0
119 and a size is always>=0 */
121 /* make sure mask have all the bits under the biggest one of size set to 1
122 Example: size=000100101 => mask=0000111111 */
127 if (res->size[arch] & (mask >> 1)) { /* if size have bits to one beside its biggest */
128 /* size is not a power of 2 */
129 /* alignment= next power of 2 after size */
130 res->alignment[arch] = (res->size[arch] & ~(mask >> 1)) << 1;
131 xbt_assert0(res->alignment[arch] != 0,
132 "scalar type too large");
134 res->aligned_size[arch] = aligned(res->size[arch], res->alignment[arch]);
135 xbt_assert0 (res->aligned_size[arch] >= 0,
136 "scalar type too large");
139 /* size is a power of 2, life is great */
140 res->alignment[arch] = res->size[arch];
141 res->aligned_size[arch] = res->size[arch];
146 res->category_code = e_gras_datadesc_type_cat_scalar;
147 res->category.scalar_data.encoding = encoding;
148 res->category.scalar_data.type = type;
156 * gras_dd_cat_field_free:
158 * Frees one struct or union field
160 void gras_dd_cat_field_free(void *f) {
161 gras_dd_cat_field_t field = *(gras_dd_cat_field_t *)f;
165 xbt_free(field->name);
172 * gras_datadesc_struct:
174 * Create a new struct and give a pointer to it
177 gras_datadesc_struct(const char *name) {
179 gras_datadesc_type_t res;
182 XBT_IN1("(%s)",name);
183 res = gras_datadesc_by_name(name);
185 /* FIXME: Check that field redefinition matches */
186 xbt_assert1(res->category_code == e_gras_datadesc_type_cat_struct,
187 "Redefinition of type %s does not match", name);
188 VERB1("Discarding redefinition of %s",name);
191 res = gras_ddt_new(name);
193 for (arch=0; arch<gras_arch_count; arch ++) {
195 res->alignment[arch] = 0;
196 res->aligned_size[arch] = 0;
198 res->category_code = e_gras_datadesc_type_cat_struct;
199 res->category.struct_data.fields =
200 xbt_dynar_new(sizeof(gras_dd_cat_field_t),
201 &gras_dd_cat_field_free);
208 * gras_datadesc_struct_append:
210 * Append a field to the struct
213 gras_datadesc_struct_append(gras_datadesc_type_t struct_type,
215 gras_datadesc_type_t field_type) {
217 gras_dd_cat_field_t field;
220 xbt_assert2(field_type,
221 "Cannot add the field '%s' into struct '%s': its type is NULL. Typo in get_by_name?",
222 name,struct_type->name);
223 XBT_IN3("(%s %s.%s;)",field_type->name,struct_type->name,name);
224 if (struct_type->category.struct_data.closed) {
225 VERB1("Ignoring request to add field to struct %s (closed. Redefinition?)",
230 xbt_assert1(field_type->size != 0,
231 "Cannot add a dynamically sized field in structure %s",
234 field=xbt_new(s_gras_dd_cat_field_t,1);
235 field->name = (char*)strdup(name);
237 DEBUG0("----------------");
238 DEBUG3("PRE s={size=%ld,align=%ld,asize=%ld}",
239 struct_type->size[GRAS_THISARCH],
240 struct_type->alignment[GRAS_THISARCH],
241 struct_type->aligned_size[GRAS_THISARCH]);
244 for (arch=0; arch<gras_arch_count; arch ++) {
245 field->offset[arch] = aligned(struct_type->size[arch],
246 field_type->alignment[arch]);
248 struct_type->size[arch] = field->offset[arch] + field_type->size[arch];
249 struct_type->alignment[arch] = max(struct_type->alignment[arch],
250 field_type->alignment[arch]);
251 struct_type->aligned_size[arch] = aligned(struct_type->size[arch],
252 struct_type->alignment[arch]);
254 field->type = field_type;
258 xbt_dynar_push(struct_type->category.struct_data.fields, &field);
260 DEBUG3("Push a %s into %s at offset %ld.",
261 field_type->name, struct_type->name,field->offset[GRAS_THISARCH]);
262 DEBUG3(" f={size=%ld,align=%ld,asize=%ld}",
263 field_type->size[GRAS_THISARCH],
264 field_type->alignment[GRAS_THISARCH],
265 field_type->aligned_size[GRAS_THISARCH]);
266 DEBUG3(" s={size=%ld,align=%ld,asize=%ld}",
267 struct_type->size[GRAS_THISARCH],
268 struct_type->alignment[GRAS_THISARCH],
269 struct_type->aligned_size[GRAS_THISARCH]);
274 gras_datadesc_struct_close(gras_datadesc_type_t struct_type) {
276 struct_type->category.struct_data.closed = 1;
277 DEBUG4("structure %s closed. size=%ld,align=%ld,asize=%ld",
279 struct_type->size[GRAS_THISARCH],
280 struct_type->alignment[GRAS_THISARCH],
281 struct_type->aligned_size[GRAS_THISARCH]);
285 * gras_datadesc_cycle_set:
287 * Tell GRAS that the pointers of the type described by @ddt may present
288 * some loop, and that the cycle detection mecanism is needed.
290 * Note that setting this option when not needed have a rather bad effect
291 * on the performance (several times slower on big data).
294 gras_datadesc_cycle_set(gras_datadesc_type_t ddt) {
298 * gras_datadesc_cycle_unset:
300 * Tell GRAS that the pointers of the type described by @ddt do not present
301 * any loop and that cycle detection mecanism are not needed.
305 gras_datadesc_cycle_unset(gras_datadesc_type_t ddt) {
310 * gras_datadesc_union:
312 * Create a new union and give a pointer to it
315 gras_datadesc_union(const char *name,
316 gras_datadesc_type_cb_int_t selector) {
318 gras_datadesc_type_t res;
321 XBT_IN1("(%s)",name);
322 xbt_assert0(selector,
323 "Attempt to creat an union without field_count function");
325 res = gras_datadesc_by_name(name);
327 /* FIXME: Check that field redefinition matches */
328 xbt_assert1(res->category_code == e_gras_datadesc_type_cat_union,
329 "Redefinition of type %s does not match", name);
330 xbt_assert1(res->category.union_data.selector == selector,
331 "Redefinition of type %s does not match", name);
332 VERB1("Discarding redefinition of %s",name);
336 res = gras_ddt_new(name);
338 for (arch=0; arch<gras_arch_count; arch ++) {
340 res->alignment[arch] = 0;
341 res->aligned_size[arch] = 0;
344 res->category_code = e_gras_datadesc_type_cat_union;
345 res->category.union_data.fields =
346 xbt_dynar_new(sizeof(gras_dd_cat_field_t*),
347 &gras_dd_cat_field_free);
348 res->category.union_data.selector = selector;
354 * gras_datadesc_union_append:
356 * Append a field to the union
359 gras_datadesc_union_append(gras_datadesc_type_t union_type,
361 gras_datadesc_type_t field_type) {
363 gras_dd_cat_field_t field;
366 XBT_IN3("(%s %s.%s;)",field_type->name,union_type->name,name);
367 xbt_assert1(field_type->size != 0,
368 "Cannot add a dynamically sized field in union %s",
371 if (union_type->category.union_data.closed) {
372 VERB1("Ignoring request to add field to union %s (closed)",
377 field=xbt_new0(s_gras_dd_cat_field_t,1);
379 field->name = (char*)strdup(name);
380 field->type = field_type;
381 /* All offset are left to 0 in an union */
383 xbt_dynar_push(union_type->category.union_data.fields, &field);
385 for (arch=0; arch<gras_arch_count; arch ++) {
386 union_type->size[arch] = max(union_type->size[arch],
387 field_type->size[arch]);
388 union_type->alignment[arch] = max(union_type->alignment[arch],
389 field_type->alignment[arch]);
390 union_type->aligned_size[arch] = aligned(union_type->size[arch],
391 union_type->alignment[arch]);
396 gras_datadesc_union_close(gras_datadesc_type_t union_type) {
397 union_type->category.union_data.closed = 1;
402 * Create a new ref to a fixed type and give a pointer to it
405 gras_datadesc_ref(const char *name,
406 gras_datadesc_type_t referenced_type) {
408 gras_datadesc_type_t res;
409 gras_datadesc_type_t pointer_type = gras_datadesc_by_name("data pointer");
412 XBT_IN1("(%s)",name);
413 res = gras_datadesc_by_name(name);
415 xbt_assert1(res->category_code == e_gras_datadesc_type_cat_ref,
416 "Redefinition of %s does not match",name);
417 xbt_assert1(res->category.ref_data.type == referenced_type,
418 "Redefinition of %s does not match",name);
419 xbt_assert1(res->category.ref_data.selector == NULL,
420 "Redefinition of %s does not match",name);
421 VERB1("Discarding redefinition of %s",name);
425 res = gras_ddt_new(name);
427 xbt_assert0(pointer_type, "Cannot get the description of data pointer");
429 for (arch=0; arch<gras_arch_count; arch ++){
430 res->size[arch] = pointer_type->size[arch];
431 res->alignment[arch] = pointer_type->alignment[arch];
432 res->aligned_size[arch] = pointer_type->aligned_size[arch];
435 res->category_code = e_gras_datadesc_type_cat_ref;
436 res->category.ref_data.type = referenced_type;
437 res->category.ref_data.selector = NULL;
442 * gras_datadesc_ref_generic:
444 * Create a new ref to a type given at use time, and give a pointer to it
447 gras_datadesc_ref_generic(const char *name,
448 gras_datadesc_selector_t selector) {
450 gras_datadesc_type_t res;
451 gras_datadesc_type_t pointer_type = gras_datadesc_by_name("data pointer");
454 XBT_IN1("(%s)",name);
455 res = gras_datadesc_by_name(name);
457 xbt_assert1(res->category_code == e_gras_datadesc_type_cat_ref,
458 "Redefinition of type %s does not match", name);
459 xbt_assert1(res->category.ref_data.type == NULL,
460 "Redefinition of type %s does not match", name);
461 xbt_assert1(res->category.ref_data.selector == selector,
462 "Redefinition of type %s does not match", name);
463 VERB1("Discarding redefinition of %s",name);
466 res = gras_ddt_new(name);
468 xbt_assert0(pointer_type, "Cannot get the description of data pointer");
470 for (arch=0; arch<gras_arch_count; arch ++) {
471 res->size[arch] = pointer_type->size[arch];
472 res->alignment[arch] = pointer_type->alignment[arch];
473 res->aligned_size[arch] = pointer_type->aligned_size[arch];
476 res->category_code = e_gras_datadesc_type_cat_ref;
478 res->category.ref_data.type = NULL;
479 res->category.ref_data.selector = selector;
485 * gras_datadesc_array_fixed:
487 * Create a new array and give a pointer to it
490 gras_datadesc_array_fixed(const char *name,
491 gras_datadesc_type_t element_type,
492 long int fixed_size) {
494 gras_datadesc_type_t res;
497 XBT_IN1("(%s)",name);
498 res = gras_datadesc_by_name(name);
500 xbt_assert1(res->category_code == e_gras_datadesc_type_cat_array,
501 "Redefinition of type %s does not match", name);
502 xbt_assert1(res->category.array_data.type == element_type,
503 "Redefinition of type %s does not match", name);
504 xbt_assert1(res->category.array_data.fixed_size == fixed_size,
505 "Redefinition of type %s does not match", name);
506 xbt_assert1(res->category.array_data.dynamic_size == NULL,
507 "Redefinition of type %s does not match", name);
508 VERB1("Discarding redefinition of %s",name);
512 res = gras_ddt_new(name);
514 xbt_assert1(fixed_size > 0, "'%s' is a array of null fixed size",name);
515 for (arch=0; arch<gras_arch_count; arch ++) {
516 res->size[arch] = fixed_size * element_type->aligned_size[arch];
517 res->alignment[arch] = element_type->alignment[arch];
518 res->aligned_size[arch] = res->size[arch];
521 res->category_code = e_gras_datadesc_type_cat_array;
523 res->category.array_data.type = element_type;
524 res->category.array_data.fixed_size = fixed_size;
525 res->category.array_data.dynamic_size = NULL;
530 * gras_datadesc_array_dyn:
532 * Create a new array and give a pointer to it
535 gras_datadesc_array_dyn(const char *name,
536 gras_datadesc_type_t element_type,
537 gras_datadesc_type_cb_int_t dynamic_size) {
539 gras_datadesc_type_t res;
542 XBT_IN1("(%s)",name);
543 xbt_assert1(dynamic_size,
544 "'%s' is a dynamic array without size discriminant",
547 res = gras_datadesc_by_name(name);
549 xbt_assert1(res->category_code == e_gras_datadesc_type_cat_array,
550 "Redefinition of type %s does not match", name);
551 xbt_assert1(res->category.array_data.type == element_type,
552 "Redefinition of type %s does not match", name);
553 xbt_assert1(res->category.array_data.fixed_size == 0,
554 "Redefinition of type %s does not match", name);
555 xbt_assert1(res->category.array_data.dynamic_size == dynamic_size,
556 "Redefinition of type %s does not match", name);
557 VERB1("Discarding redefinition of %s",name);
562 res = gras_ddt_new(name);
564 for (arch=0; arch<gras_arch_count; arch ++) {
565 res->size[arch] = 0; /* make sure it indicates "dynamic" */
566 res->alignment[arch] = element_type->alignment[arch];
567 res->aligned_size[arch] = 0; /*FIXME: That was so in GS, but looks stupid*/
570 res->category_code = e_gras_datadesc_type_cat_array;
572 res->category.array_data.type = element_type;
573 res->category.array_data.fixed_size = 0;
574 res->category.array_data.dynamic_size = dynamic_size;
580 * gras_datadesc_ref_pop_arr:
582 * Most of the time, you want to include a reference in your structure which
583 * is a pointer to a dynamic array whose size is fixed by another field of
586 * This case pops up so often that this function was created to take care of
587 * this case. It creates a dynamic array type whose size is poped from the
588 * current cbps, and then create a reference to it.
590 * The name of the created datatype will be the name of the element type, with
591 * '[]*' appended to it.
593 * Then to use it, you just have to make sure that your structure pre-callback
594 * does push the size of the array in the cbps (using #gras_cbps_i_push), and
597 * But be remember that this is a stack. If you have two different pop_arr, you
598 * should push the second one first, so that the first one is on the top of the
599 * list when the first field gets transfered.
603 gras_datadesc_ref_pop_arr(gras_datadesc_type_t element_type) {
605 gras_datadesc_type_t res;
606 char *name=(char*)xbt_malloc(strlen(element_type->name) + 4);
608 sprintf(name,"%s[]",element_type->name);
610 res = gras_datadesc_array_dyn(name,element_type,
611 gras_datadesc_cb_pop);
613 sprintf(name,"%s[]*",element_type->name);
614 res = gras_datadesc_ref(name,res);
621 gras_datadesc_import_nws(const char *name,
622 const DataDescriptor *desc,
623 unsigned long howmany,
624 /* OUT */ gras_datadesc_type_t *dst) {
629 * gras_datadesc_cb_send:
631 * Add a pre-send callback to this datadesc.
632 * (useful to push the sizes of the upcoming arrays, for example)
634 void gras_datadesc_cb_send (gras_datadesc_type_t type,
635 gras_datadesc_type_cb_void_t send) {
639 * gras_datadesc_cb_recv:
641 * Add a post-receive callback to this datadesc.
642 * (useful to put the function pointers to the rigth value, for example)
644 void gras_datadesc_cb_recv(gras_datadesc_type_t type,
645 gras_datadesc_type_cb_void_t recv) {
649 * gras_dd_find_field:
651 * Returns the type descriptor of the given field. Abort on error.
653 static gras_datadesc_type_t
654 gras_dd_find_field(gras_datadesc_type_t type,
655 const char *field_name) {
656 xbt_dynar_t field_array;
658 gras_dd_cat_field_t field=NULL;
661 if (type->category_code == e_gras_datadesc_type_cat_union) {
662 field_array = type->category.union_data.fields;
663 } else if (type->category_code == e_gras_datadesc_type_cat_struct) {
664 field_array = type->category.struct_data.fields;
666 ERROR2("%s (%p) is not a struct nor an union. There is no field.", type->name,(void*)type);
669 xbt_dynar_foreach(field_array,field_num,field) {
670 if (!strcmp(field_name,field->name)) {
674 ERROR2("No field nammed %s in %s",field_name,type->name);
680 * gras_datadesc_cb_field_send:
682 * Add a pre-send callback to the given field of the datadesc (which must be a struct or union).
683 * (useful to push the sizes of the upcoming arrays, for example)
685 void gras_datadesc_cb_field_send (gras_datadesc_type_t type,
686 const char *field_name,
687 gras_datadesc_type_cb_void_t send) {
689 gras_datadesc_type_t sub_type=gras_dd_find_field(type,field_name);
690 sub_type->send = send;
694 * gras_datadesc_cb_field_push:
696 * Add a pre-send callback to the given field resulting in its value to be pushed to
697 * the stack of sizes. It must be a int, unsigned int, long int or unsigned long int.
699 void gras_datadesc_cb_field_push (gras_datadesc_type_t type,
700 const char *field_name) {
702 gras_datadesc_type_t sub_type=gras_dd_find_field(type,field_name);
703 if (!strcmp("int",sub_type->name)) {
704 sub_type->send = gras_datadesc_cb_push_int;
705 } else if (!strcmp("unsigned int",sub_type->name)) {
706 sub_type->send = gras_datadesc_cb_push_uint;
707 } else if (!strcmp("long int",sub_type->name)) {
708 sub_type->send = gras_datadesc_cb_push_lint;
709 } else if (!strcmp("unsigned long int",sub_type->name)) {
710 sub_type->send = gras_datadesc_cb_push_ulint;
712 ERROR1("Field %s is not an int, unsigned int, long int neither unsigned long int",
718 * gras_datadesc_cb_field_recv:
720 * Add a post-receive callback to the given field of the datadesc (which must be a struct or union).
721 * (useful to put the function pointers to the right value, for example)
723 void gras_datadesc_cb_field_recv(gras_datadesc_type_t type,
724 const char *field_name,
725 gras_datadesc_type_cb_void_t recv) {
727 gras_datadesc_type_t sub_type=gras_dd_find_field(type,field_name);
728 sub_type->recv = recv;
732 * gras_datadesc_free:
734 * Free a datadesc. Should only be called at xbt_exit.
736 void gras_datadesc_free(gras_datadesc_type_t *type) {
738 DEBUG1("Let's free ddt %s",(*type)->name);
740 switch ((*type)->category_code) {
741 case e_gras_datadesc_type_cat_scalar:
742 case e_gras_datadesc_type_cat_ref:
743 case e_gras_datadesc_type_cat_array:
744 /* nothing to free in there */
747 case e_gras_datadesc_type_cat_ignored:
748 if ((*type)->category.ignored_data.free_func) {
749 (*type)->category.ignored_data.free_func
750 ((*type)->category.ignored_data.default_value);
754 case e_gras_datadesc_type_cat_struct:
755 xbt_dynar_free(&( (*type)->category.struct_data.fields ));
758 case e_gras_datadesc_type_cat_union:
759 xbt_dynar_free(&( (*type)->category.union_data.fields ));
763 /* datadesc was invalid. Killing it is like euthanasy, I guess */
766 xbt_free((*type)->name);