Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
1d871ce88c84bf41c87bbd01ad7ffd98ffbefd6f
[simgrid.git] / src / gras / DataDesc / ddt_create.c
1 /* $Id$ */
2
3 /* ddt_new - creation/deletion of datatypes structs (private to this module)*/
4
5 /* Authors: Olivier Aumage, Martin Quinson                                  */
6 /* Copyright (C) 2003, 2004 the GRAS posse.                                 */
7
8 /* This program is free software; you can redistribute it and/or modify it
9    under the terms of the license (GNU LGPL) which comes with this package. */
10
11 #include "DataDesc/datadesc_private.h"
12
13 GRAS_LOG_NEW_DEFAULT_SUBCATEGORY(new,DataDesc);
14
15 static gras_error_t
16 gras_ddt_new(const char            *name,
17              gras_datadesc_type_t **dst) {
18
19   gras_datadesc_type_t *res=malloc(sizeof(gras_datadesc_type_t));
20   if (!res) 
21     RAISE_MALLOC;
22
23   memset(res, 0, sizeof(res));
24   res->name = strdup(name);
25   res->name_len = strlen(name);
26   res->pre = NULL;
27   res->post = NULL;
28   
29   *dst=res;
30   return no_error;
31 }
32
33 /**
34  * gras_ddt_new_scalar:
35  *
36  * Create a new scalar and give a pointer to it 
37  */
38 gras_error_t 
39 gras_ddt_new_scalar(const char                      *name,
40                     gras_ddt_scalar_type_t           type,
41                     enum e_gras_dd_scalar_encoding   encoding,
42                     gras_datadesc_type_cb_void_t     cb,
43                     gras_datadesc_type_t           **dst) {
44
45   gras_error_t errcode;
46   gras_datadesc_type_t *res;
47   long int arch;
48
49   TRY(gras_ddt_new(name,dst));
50   res=*dst;
51
52   for (arch = 0; arch < gras_arch_count; arch ++) {
53     long int sz;
54     long int mask;
55
56     res->size[arch] = gras_arch_sizes[arch].sizeof_scalars[type];
57     
58     sz = res->size[arch];
59     mask = sz;
60     
61     /* just in case you wonder, x>>1 == x/2 on all architectures when x>=0 and a size is always>=0 */
62
63     /* make sure mask have all the bits under the biggest one of size set to 1
64        Example: size=000100101 => mask=0000111111 */
65     while ((sz >>= 1)) {
66       mask |= sz;
67     }
68     
69     if (res->size[arch] & (mask >> 1)) { /* if size have bits to one beside its biggest */
70       /* size is not a power of 2 */
71       /* alignment= next power of 2 after size */
72       res->alignment[arch] = (res->size[arch] & ~(mask >> 1)) << 1;
73       gras_assert0(res->alignment[arch] != 0,
74                    "scalar type too large");
75       
76       res->aligned_size[arch]    = aligned(res->size[arch], res->alignment[arch]);
77       gras_assert0 (res->aligned_size[arch] >= 0,
78                     "scalar type too large");
79       
80     } else {
81       /* size is a power of 2, life is great */
82       res->alignment[arch]       = res->size[arch];
83       res->aligned_size[arch]    = res->size[arch];
84     }
85
86     /* FIXME size < 0 sometimes? 
87        } else {
88        res->alignment    = 0;
89        res->aligned_size = 0;
90        }
91     */
92   }
93
94   res->category_code                 = e_gras_datadesc_type_cat_scalar;
95   res->category.scalar_data.encoding = encoding;
96
97   res->pre = cb;
98   return no_error;
99 }
100
101
102 /**
103  * gras_dd_cat_field_free:
104  *
105  * Frees one struct or union field
106  */
107 void gras_dd_cat_field_free(void *f) {
108   gras_dd_cat_field_t *field = (gras_dd_cat_field_t *)f;
109   if (field) {
110     if (field->name) 
111       free(field->name);
112     free(field);
113   }
114 }
115
116 /**
117  * gras_ddt_new_struct:
118  *
119  * Create a new struct and give a pointer to it 
120  */
121 gras_error_t 
122 gras_ddt_new_struct(const char                      *name,
123                     gras_datadesc_type_cb_void_t     pre,
124                     gras_datadesc_type_cb_void_t     post,
125                     gras_datadesc_type_t           **dst) {
126
127   gras_error_t errcode;
128   gras_datadesc_type_t *res;
129   long int arch;
130
131   TRY(gras_ddt_new(name,dst));
132   res=*dst;
133
134   for (arch=0; arch<gras_arch_count; arch ++) {
135     res->size[arch]                     = 0;
136     res->alignment[arch]                = 0;
137     res->aligned_size[arch]             = 0;
138   }
139   res->category_code            = e_gras_datadesc_type_cat_struct;
140   TRY(gras_dynar_new(&(res->category.struct_data.fields),
141                      sizeof(gras_dd_cat_field_t*),
142                      &gras_dd_cat_field_free));
143   res->pre                      = pre;
144   res->post                     = post;
145
146   return no_error;
147 }
148
149 /**
150  * gras_ddt_new_struct_append:
151  *
152  * Append a field to the struct
153  */
154 gras_error_t 
155 gras_ddt_new_struct_append(gras_datadesc_type_t            *struct_type,
156                            const char                      *name,
157                            gras_datadesc_type_t            *field_type,
158                            gras_datadesc_type_cb_void_t     pre,
159                            gras_datadesc_type_cb_void_t     post) {
160
161   gras_error_t errcode;
162   gras_dd_cat_field_t *field;
163   int arch;
164
165   gras_assert0(field_type->size >= 0,
166                "Cannot add a dynamically sized field in a structure");
167     
168   field=malloc(sizeof(gras_dd_cat_field_t));
169   if (!field)
170     RAISE_MALLOC;
171
172   field->name   = strdup(name);
173
174   for (arch=0; arch<gras_arch_count; arch ++) {
175     field->offset[arch] = aligned(struct_type->size[arch], field_type->alignment[arch]);
176   }
177   field->code   = field_type->code;
178   field->pre    = pre;
179   field->post   = post;
180   
181   TRY(gras_dynar_push(struct_type->category.struct_data.fields, &field));
182
183   for (arch=0; arch<gras_arch_count; arch ++) {
184     struct_type->size[arch]             = field->offset[arch] + field_type->size[arch];
185     struct_type->alignment[arch]        = max(struct_type->alignment[arch], field_type->alignment[arch]);
186     struct_type->aligned_size[arch]     = aligned(struct_type->size[arch], struct_type->alignment[arch]);
187   }
188
189   return no_error;
190 }
191
192 /**
193  * gras_ddt_new_union:
194  *
195  * Create a new union and give a pointer to it 
196  */
197 gras_error_t 
198 gras_ddt_new_union(const char                      *name,
199                    gras_datadesc_type_cb_int_t      selector,
200                    gras_datadesc_type_cb_void_t     post,
201                    gras_datadesc_type_t           **dst) {
202
203   gras_error_t errcode;
204   gras_datadesc_type_t *res;
205   int arch;
206
207   gras_assert0(selector,
208                "Attempt to creat an union without field_count function");
209
210   TRY(gras_ddt_new(name,dst));
211   res=*dst;
212
213   for (arch=0; arch<gras_arch_count; arch ++) {
214     res->size[arch]                     = 0;
215     res->alignment[arch]                = 0;
216     res->aligned_size[arch]             = 0;
217   }
218   res->category_code            = e_gras_datadesc_type_cat_union;
219   TRY(gras_dynar_new(&(res->category.union_data.fields),
220                      sizeof(gras_dd_cat_field_t*),
221                      &gras_dd_cat_field_free));
222   res->category.union_data.selector = selector;
223   res->pre                      = NULL;
224   res->post                     = post;
225
226   return no_error;
227 }
228
229 /**
230  * gras_ddt_new_union_append:
231  *
232  * Append a field to the union
233  */
234 gras_error_t 
235 gras_ddt_new_union_append(gras_datadesc_type_t            *union_type,
236                           const char                      *name,
237                           gras_datadesc_type_t            *field_type,
238                           gras_datadesc_type_cb_void_t     pre,
239                           gras_datadesc_type_cb_void_t     post) {
240
241   gras_error_t errcode;
242   gras_dd_cat_field_t *field;
243   int arch;
244
245   gras_assert0(field_type->size >= 0,
246                "Cannot add a dynamically sized field in an union");
247     
248   field=malloc(sizeof(gras_dd_cat_field_t));
249   if (!field)
250     RAISE_MALLOC;
251
252   field->name   = strdup(name);
253   for (arch=0; arch<gras_arch_count; arch ++) {
254     field->offset[arch] = 0; /* that's the purpose of union ;) */
255   }
256   field->code   = field_type->code;
257   field->pre    = pre;
258   field->post   = post;
259   
260   TRY(gras_dynar_push(union_type->category.union_data.fields, &field));
261
262   for (arch=0; arch<gras_arch_count; arch ++) {
263     union_type->size[arch]         = max(union_type->size[arch], field_type->size[arch]);
264     union_type->alignment[arch]    = max(union_type->alignment[arch], field_type->alignment[arch]);
265     union_type->aligned_size[arch] = aligned(union_type->size[arch], union_type->alignment[arch]);
266   }
267
268   return no_error;
269 }
270
271 /**
272  * gras_ddt_new_ref:
273  *
274  * Create a new ref and give a pointer to it 
275  */
276 gras_error_t 
277 gras_ddt_new_ref(const char                      *name,
278                  gras_datadesc_type_t            *referenced_type,
279                  gras_datadesc_type_cb_int_t      selector,
280                  gras_datadesc_type_cb_void_t     post,
281                  gras_datadesc_type_t           **dst) {
282
283   gras_error_t errcode;
284   gras_datadesc_type_t *res;
285   gras_datadesc_type_t *pointer_type;
286   int arch;
287
288   gras_assert0(selector || referenced_type,
289                "Attempt to create a generic reference without selector");
290
291   TRY(gras_ddt_new(name,dst));
292   res=*dst;
293
294   TRY(gras_datadesc_by_name("data pointer", &pointer_type));
295       
296   for (arch=0; arch<gras_arch_count; arch ++) {
297     res->size[arch]                     = pointer_type->size[arch];
298     res->alignment[arch]                = pointer_type->alignment[arch];
299     res->aligned_size[arch]             = pointer_type->aligned_size[arch];
300   }
301
302   res->category_code            = e_gras_datadesc_type_cat_ref;
303
304   res->category.ref_data.code         = referenced_type ? referenced_type->code : -1;
305   res->category.ref_data.selector = selector;
306   res->pre                      = NULL;
307   res->post                     = post;
308
309   return no_error;
310 }
311
312 /**
313  * gras_ddt_new_array:
314  *
315  * Create a new array and give a pointer to it 
316  */
317 gras_error_t 
318 gras_ddt_new_array(const char                      *name,
319                    gras_datadesc_type_t            *element_type,
320                    long int                         fixed_size,
321                    gras_datadesc_type_cb_int_t      dynamic_size,
322                    gras_datadesc_type_cb_void_t     post,
323                    gras_datadesc_type_t           **dst) {
324
325   gras_error_t errcode;
326   gras_datadesc_type_t *res;
327   int arch;
328
329   gras_assert0(dynamic_size || fixed_size>0,
330                "Attempt to create a dynamic array without size discriminant");
331
332   TRY(gras_ddt_new(name,dst));
333   res=*dst;
334
335   for (arch=0; arch<gras_arch_count; arch ++) {
336     if (fixed_size <= 0) {
337       res->size[arch] = fixed_size; /* make sure it indicates "dynamic" */
338     } else {
339       res->size[arch] = fixed_size * element_type->aligned_size[arch];
340     }
341     res->alignment[arch]        = element_type->alignment[arch];
342     res->aligned_size[arch]     = fixed_size; /*FIXME: That was so in GS, but looks stupid*/
343   }
344   res->category_code            = e_gras_datadesc_type_cat_array;
345
346   res->category.array_data.code         = element_type->code;
347   res->category.array_data.fixed_size   = fixed_size;
348   res->category.array_data.dynamic_size = dynamic_size;
349
350   res->pre                      = NULL;
351   res->post                     = post;
352
353   return no_error;
354 }
355
356 /**
357  * gras_ddt_new_ignored:
358  *
359  * Create a new ignored field and give a pointer to it. 
360  *
361  * If you give a default value, it will be copied away so that you can free your copy.
362  */
363 gras_error_t 
364 gras_ddt_new_ignored(const char *name,
365                      void *default_value,
366                      void_f_pvoid_t   *free_func,
367                      long int                       size,
368                      long int                       alignment,
369                      gras_datadesc_type_cb_void_t     post,
370                      gras_datadesc_type_t           **dst) {
371   RAISE_UNIMPLEMENTED;
372   /*
373   gras_error_t errcode;
374   gras_datadesc_type_t *res;
375
376   TRY(gras_ddt_new(name,dst));
377   res=*dst;
378
379   res->size             = size > 0?size:0;
380   res->alignment        = alignment;
381
382   if (size > 0) {
383     res->aligned_size   = aligned(size, alignment);
384   } else {
385     res->aligned_size   = 0;
386   }
387
388   if (default_value && res->size) {
389     res->category.ignored_data.default_value = malloc((size_t)size);
390     if (! (res->category.ignored_data.default_value) ) 
391       RAISE_MALLOC;
392     memcpy(res->category.ignored_data.default_value,
393            default_value, (size_t)size);
394   }
395
396   res->category_code = e_gras_datadesc_type_cat_ignored;
397   res->category.ignored_data.free_func = free_func;
398
399   res->post = post;
400
401
402   res->size = size;
403
404   return no_error;
405   */
406 }
407
408 /**
409  * gras_ddt_new_parse:
410  *
411  * Create a datadescription from the result of parsing the C type description
412  */
413 gras_error_t
414 gras_ddt_new_parse(const char            *name,
415                    const char            *C_statement,
416                    gras_datadesc_type_t **dst) {
417   RAISE_UNIMPLEMENTED;
418 }
419
420
421 gras_error_t
422 gras_ddt_new_from_nws(const char           *name,
423                       const DataDescriptor *desc,
424                       size_t                howmany,
425                       gras_datadesc_type_t **dst) {
426   RAISE_UNIMPLEMENTED;
427 }
428
429 /**
430  * gras_ddt_free:
431  *
432  * Frees a datadescription.
433  */
434 void gras_ddt_free(gras_datadesc_type_t **type) {
435   gras_datadesc_type_t *t;
436
437   if (type && *type) {
438     t=*type;
439
440     free(t->name);
441     switch (t->category_code) {
442     case e_gras_datadesc_type_cat_scalar:
443     case e_gras_datadesc_type_cat_ref:
444     case e_gras_datadesc_type_cat_array:
445       /* nothing to free in there */
446       break;
447
448     case e_gras_datadesc_type_cat_ignored:
449       if (t->category.ignored_data.free_func) {
450         t->category.ignored_data.free_func(t->category.ignored_data.default_value);
451       }
452       break;
453
454     case e_gras_datadesc_type_cat_struct:
455       gras_dynar_free(t->category.struct_data.fields);
456       break;
457
458     case e_gras_datadesc_type_cat_union:
459       gras_dynar_free(t->category.union_data.fields);
460       break;
461       
462     default:
463       /* datadesc was invalid. Killing it is like euthanasy, I guess */
464       break;
465     }
466   }
467 }