3 /* datadesc - describing the data to exchange */
5 /* module's private interface masked even to other parts of GRAS. */
7 /* Authors: Olivier Aumage, Martin Quinson */
8 /* Copyright (C) 2003, 2004 the GRAS posse. */
10 /* This program is free software; you can redistribute it and/or modify it
11 under the terms of the license (GNU LGPL) which comes with this package. */
13 #ifndef GRAS_DATADESC_PRIVATE_H
14 #define GRAS_DATADESC_PRIVATE_H
16 #include "gras_private.h"
17 #include "DataDesc/datadesc_interface.h"
22 * Align the data v on the boundary a.
24 #define aligned(v, a) (((v) + (a - 1)) & ~(a - 1))
26 extern gras_set_t *gras_datadesc_set_local;
28 /*******************************************
29 * Descriptions of all known architectures *
30 *******************************************/
32 #define gras_arch_count 1
34 gras_ddt_scalar_char = 0,
35 gras_ddt_scalar_short = 1,
36 gras_ddt_scalar_int = 2,
37 gras_ddt_scalar_long = 3,
38 gras_ddt_scalar_long_long = 4,
40 gras_ddt_scalar_pdata = 5,
41 gras_ddt_scalar_pfunc = 6,
43 gras_ddt_scalar_float = 7,
44 gras_ddt_scalar_double = 8
45 } gras_ddt_scalar_type_t;
52 int sizeof_scalars[9]; /* char,short,int,long,long_long,
57 extern const gras_arch_desc_t gras_arches[gras_arch_count];
58 extern const char *gras_datadesc_cat_names[9];
60 /**********************************************************/
61 /* Actual definitions of the stuff in the type descriptor */
62 /**********************************************************/
65 * e_gras_datadesc_type_category:
67 * Defines all possible type categories.
69 typedef enum e_gras_datadesc_type_category {
71 /* if you edit this, also fix gras_datadesc_cat_names in ddt_exchange.c */
73 e_gras_datadesc_type_cat_undefined = 0,
75 e_gras_datadesc_type_cat_scalar = 1,
76 e_gras_datadesc_type_cat_struct = 2,
77 e_gras_datadesc_type_cat_union = 3,
78 e_gras_datadesc_type_cat_ref = 4, /* ref to an uniq element */
79 e_gras_datadesc_type_cat_array = 5,
80 e_gras_datadesc_type_cat_ignored = 6,
82 e_gras_datadesc_type_cat_invalid = 7
83 } gras_datadesc_type_category_t;
85 /*------------------------------------------------*/
86 /* definitions of specific data for each category */
87 /*------------------------------------------------*/
89 * s_gras_dd_cat_field:
91 * Fields of struct and union
93 typedef struct s_gras_dd_cat_field {
96 long int offset[gras_arch_count]; /* only for struct */
99 gras_datadesc_type_cb_void_t pre;
100 gras_datadesc_type_cb_void_t post;
102 } gras_dd_cat_field_t;
104 void gras_dd_cat_field_free(void *f);
107 * gras_dd_cat_scalar_t:
109 * Specific fields of a scalar
111 enum e_gras_dd_scalar_encoding {
112 e_gras_dd_scalar_encoding_undefined = 0,
114 e_gras_dd_scalar_encoding_uint,
115 e_gras_dd_scalar_encoding_sint,
116 e_gras_dd_scalar_encoding_float,
118 e_gras_dd_scalar_encoding_invalid
120 typedef struct s_gras_dd_cat_scalar {
121 enum e_gras_dd_scalar_encoding encoding;
122 } gras_dd_cat_scalar_t;
125 * gras_dd_cat_struct_t:
127 * Specific fields of a struct
129 typedef struct s_gras_dd_cat_struct {
130 gras_dynar_t *fields; /* elm type = gras_dd_cat_field_t */
131 } gras_dd_cat_struct_t;
134 * gras_dd_cat_union_t:
136 * Specific fields of a union
138 typedef struct s_gras_dd_cat_union {
139 gras_datadesc_type_cb_int_t selector;
140 gras_dynar_t *fields; /* elm type = gras_dd_cat_field_t */
141 } gras_dd_cat_union_t;
146 * Specific fields of a reference
148 typedef struct s_gras_dd_cat_ref {
151 /* callback used to return the referenced type number */
152 gras_datadesc_type_cb_int_t selector;
157 * gras_dd_cat_array_t:
159 * Specific fields of an array
161 typedef struct s_gras_dd_cat_array {
164 /* element_count < 0 means dynamically defined */
167 /* callback used to return the dynamic length */
168 gras_datadesc_type_cb_int_t dynamic_size;
169 } gras_dd_cat_array_t;
172 * gras_dd_cat_ignored_t:
174 * Specific fields of an ignored field
176 typedef struct s_gras_dd_cat_ignored {
178 void_f_pvoid_t *free_func;
179 } gras_dd_cat_ignored_t;
183 * u_gras_datadesc_category:
185 * Specific data to each possible category
187 union u_gras_datadesc_category {
188 void *undefined_data;
189 gras_dd_cat_scalar_t scalar_data;
190 gras_dd_cat_struct_t struct_data;
191 gras_dd_cat_union_t union_data;
192 gras_dd_cat_ref_t ref_data;
193 gras_dd_cat_array_t array_data;
194 gras_dd_cat_ignored_t ignored_data;
198 /****************************************/
199 /* The holy grail: type descriptor type */
200 /****************************************/
202 * s_gras_datadesc_type:
206 struct s_gras_datadesc_type {
207 /* headers for the data set */
210 unsigned int name_len;
212 unsigned int refcounter;
215 long int size[gras_arch_count];
217 long int alignment[gras_arch_count];
218 long int aligned_size[gras_arch_count];
220 enum e_gras_datadesc_type_category category_code;
221 union u_gras_datadesc_category category;
223 gras_datadesc_type_cb_void_t pre;
224 gras_datadesc_type_cb_void_t post;
227 /***************************
228 * Type creation functions *
229 ***************************/
231 gras_datadesc_declare_scalar(const char *name,
232 gras_ddt_scalar_type_t type,
233 enum e_gras_dd_scalar_encoding encoding,
234 gras_datadesc_type_cb_void_t cb,
235 gras_datadesc_type_t **dst);
237 /****************************************************
238 * Callback persistant state constructor/destructor *
239 ****************************************************/
241 gras_dd_cbps_new(gras_dd_cbps_t **dst);
243 gras_dd_cbps_free(gras_dd_cbps_t **state);
249 gras_dd_convert_elm(gras_datadesc_type_t *type,
251 void *src, void *dst);
253 #endif /* GRAS_DATADESC_PRIVATE_H */