Commit | Line | Data |
---|---|---|
c054553d | 1 | /* |
ab4cf058 | 2 | * variant.c |
c054553d MD |
3 | * |
4 | * BabelTrace - Variant Type Converter | |
5 | * | |
64fa3fec MD |
6 | * Copyright 2010-2011 EfficiOS Inc. and Linux Foundation |
7 | * | |
8 | * Author: Mathieu Desnoyers <mathieu.desnoyers@efficios.com> | |
c054553d MD |
9 | * |
10 | * Permission is hereby granted, free of charge, to any person obtaining a copy | |
11 | * of this software and associated documentation files (the "Software"), to deal | |
12 | * in the Software without restriction, including without limitation the rights | |
13 | * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell | |
14 | * copies of the Software, and to permit persons to whom the Software is | |
15 | * furnished to do so, subject to the following conditions: | |
16 | * | |
17 | * The above copyright notice and this permission notice shall be included in | |
18 | * all copies or substantial portions of the Software. | |
19 | */ | |
20 | ||
21 | #include <babeltrace/compiler.h> | |
22 | #include <babeltrace/format.h> | |
6ee5115e | 23 | #include <errno.h> |
c054553d MD |
24 | |
25 | static | |
f6625916 | 26 | struct definition *_variant_definition_new(struct declaration *declaration, |
05c749e5 | 27 | struct definition_scope *parent_scope, |
98df1c9f MD |
28 | GQuark field_name, int index, |
29 | const char *root_name); | |
c054553d | 30 | static |
e1151715 | 31 | void _variant_definition_free(struct definition *definition); |
c054553d | 32 | |
c5e74408 | 33 | int variant_rw(struct stream_pos *ppos, struct definition *definition) |
c054553d | 34 | { |
d11e9c49 | 35 | struct definition_variant *variant_definition = |
e1151715 | 36 | container_of(definition, struct definition_variant, p); |
b1a2f580 | 37 | struct definition *field; |
c054553d | 38 | |
d11e9c49 | 39 | field = variant_get_current_field(variant_definition); |
b1a2f580 | 40 | return generic_rw(ppos, field); |
c054553d MD |
41 | } |
42 | ||
43 | static | |
d60cb676 | 44 | void _untagged_variant_declaration_free(struct declaration *declaration) |
c054553d | 45 | { |
d60cb676 MD |
46 | struct declaration_untagged_variant *untagged_variant_declaration = |
47 | container_of(declaration, struct declaration_untagged_variant, p); | |
c054553d MD |
48 | unsigned long i; |
49 | ||
d60cb676 MD |
50 | free_declaration_scope(untagged_variant_declaration->scope); |
51 | g_hash_table_destroy(untagged_variant_declaration->fields_by_tag); | |
c054553d | 52 | |
d60cb676 | 53 | for (i = 0; i < untagged_variant_declaration->fields->len; i++) { |
f6625916 | 54 | struct declaration_field *declaration_field = |
d60cb676 | 55 | &g_array_index(untagged_variant_declaration->fields, |
f6625916 MD |
56 | struct declaration_field, i); |
57 | declaration_unref(declaration_field->declaration); | |
c054553d | 58 | } |
d60cb676 MD |
59 | g_array_free(untagged_variant_declaration->fields, true); |
60 | g_free(untagged_variant_declaration); | |
c054553d MD |
61 | } |
62 | ||
ab4cf058 | 63 | struct declaration_untagged_variant *untagged_variant_declaration_new( |
f6625916 | 64 | struct declaration_scope *parent_scope) |
c054553d | 65 | { |
d60cb676 | 66 | struct declaration_untagged_variant *untagged_variant_declaration; |
f6625916 | 67 | struct declaration *declaration; |
c054553d | 68 | |
d60cb676 MD |
69 | untagged_variant_declaration = g_new(struct declaration_untagged_variant, 1); |
70 | declaration = &untagged_variant_declaration->p; | |
71 | untagged_variant_declaration->fields_by_tag = g_hash_table_new(g_direct_hash, | |
e19c3d69 | 72 | g_direct_equal); |
d60cb676 | 73 | untagged_variant_declaration->fields = g_array_sized_new(FALSE, TRUE, |
f6625916 | 74 | sizeof(struct declaration_field), |
e19c3d69 | 75 | DEFAULT_NR_STRUCT_FIELDS); |
d60cb676 MD |
76 | untagged_variant_declaration->scope = new_declaration_scope(parent_scope); |
77 | declaration->id = CTF_TYPE_UNTAGGED_VARIANT; | |
f6625916 | 78 | declaration->alignment = 1; |
d60cb676 MD |
79 | declaration->declaration_free = _untagged_variant_declaration_free; |
80 | declaration->definition_new = NULL; | |
81 | declaration->definition_free = NULL; | |
82 | declaration->ref = 1; | |
83 | return untagged_variant_declaration; | |
84 | } | |
85 | ||
86 | static | |
87 | void _variant_declaration_free(struct declaration *declaration) | |
88 | { | |
89 | struct declaration_variant *variant_declaration = | |
90 | container_of(declaration, struct declaration_variant, p); | |
91 | ||
92 | _untagged_variant_declaration_free(&variant_declaration->untagged_variant->p); | |
93 | g_array_free(variant_declaration->tag_name, TRUE); | |
94 | } | |
95 | ||
96 | struct declaration_variant * | |
97 | variant_declaration_new(struct declaration_untagged_variant *untagged_variant, const char *tag) | |
98 | { | |
99 | struct declaration_variant *variant_declaration; | |
100 | struct declaration *declaration; | |
101 | ||
102 | variant_declaration = g_new(struct declaration_variant, 1); | |
103 | declaration = &variant_declaration->p; | |
104 | variant_declaration->untagged_variant = untagged_variant; | |
07fdca67 | 105 | declaration_ref(&untagged_variant->p); |
d60cb676 MD |
106 | variant_declaration->tag_name = g_array_new(FALSE, TRUE, sizeof(GQuark)); |
107 | append_scope_path(tag, variant_declaration->tag_name); | |
108 | declaration->id = CTF_TYPE_VARIANT; | |
109 | declaration->alignment = 1; | |
f6625916 MD |
110 | declaration->declaration_free = _variant_declaration_free; |
111 | declaration->definition_new = _variant_definition_new; | |
112 | declaration->definition_free = _variant_definition_free; | |
113 | declaration->ref = 1; | |
114 | return variant_declaration; | |
c054553d MD |
115 | } |
116 | ||
d60cb676 MD |
117 | /* |
118 | * tag_instance is assumed to be an enumeration. | |
119 | * Returns 0 if OK, < 0 if error. | |
120 | */ | |
121 | static | |
122 | int check_enum_tag(struct definition_variant *variant, | |
123 | struct definition *enum_tag) | |
124 | { | |
125 | struct definition_enum *_enum = | |
126 | container_of(enum_tag, struct definition_enum, p); | |
127 | struct declaration_enum *enum_declaration = _enum->declaration; | |
128 | int missing_field = 0; | |
129 | unsigned long i; | |
130 | ||
131 | /* | |
132 | * Strictly speaking, each enumerator must map to a field of the | |
133 | * variant. However, we are even stricter here by requiring that each | |
134 | * variant choice map to an enumerator too. We then validate that the | |
135 | * number of enumerators equals the number of variant choices. | |
136 | */ | |
137 | if (variant->declaration->untagged_variant->fields->len != enum_get_nr_enumerators(enum_declaration)) | |
138 | return -EPERM; | |
139 | ||
140 | for (i = 0; i < variant->declaration->untagged_variant->fields->len; i++) { | |
141 | struct declaration_field *field_declaration = | |
142 | &g_array_index(variant->declaration->untagged_variant->fields, | |
143 | struct declaration_field, i); | |
144 | if (!enum_quark_to_range_set(enum_declaration, field_declaration->name)) { | |
145 | missing_field = 1; | |
146 | break; | |
147 | } | |
148 | } | |
149 | if (missing_field) | |
150 | return -EPERM; | |
151 | ||
152 | /* | |
153 | * Check the enumeration: it must map each value to one and only one | |
154 | * enumerator tag. | |
155 | * TODO: we should also check that each range map to one and only one | |
156 | * tag. For the moment, we will simply check this dynamically in | |
157 | * variant_declaration_get_current_field(). | |
158 | */ | |
159 | return 0; | |
160 | } | |
161 | ||
162 | ||
163 | ||
c054553d | 164 | static |
e1151715 | 165 | struct definition * |
f6625916 | 166 | _variant_definition_new(struct declaration *declaration, |
05c749e5 | 167 | struct definition_scope *parent_scope, |
98df1c9f MD |
168 | GQuark field_name, int index, |
169 | const char *root_name) | |
c054553d | 170 | { |
f6625916 MD |
171 | struct declaration_variant *variant_declaration = |
172 | container_of(declaration, struct declaration_variant, p); | |
e1151715 | 173 | struct definition_variant *variant; |
ac88af75 | 174 | unsigned long i; |
98df1c9f | 175 | int ret; |
c054553d | 176 | |
e1151715 | 177 | variant = g_new(struct definition_variant, 1); |
f6625916 MD |
178 | declaration_ref(&variant_declaration->p); |
179 | variant->p.declaration = declaration; | |
180 | variant->declaration = variant_declaration; | |
c054553d | 181 | variant->p.ref = 1; |
98df1c9f MD |
182 | /* |
183 | * Use INT_MAX order to ensure that all fields of the parent | |
184 | * scope are seen as being prior to this scope. | |
185 | */ | |
186 | variant->p.index = root_name ? INT_MAX : index; | |
b1a2f580 | 187 | variant->p.name = field_name; |
98df1c9f | 188 | variant->p.path = new_definition_path(parent_scope, field_name, root_name); |
a35173fe | 189 | variant->p.scope = new_definition_scope(parent_scope, field_name, root_name); |
98df1c9f MD |
190 | |
191 | ret = register_field_definition(field_name, &variant->p, | |
192 | parent_scope); | |
193 | assert(!ret); | |
194 | ||
a35173fe MD |
195 | variant->enum_tag = lookup_path_definition(variant->p.scope->scope_path, |
196 | variant_declaration->tag_name, | |
197 | parent_scope); | |
d60cb676 MD |
198 | |
199 | if (!variant->enum_tag | |
200 | || check_enum_tag(variant, variant->enum_tag) < 0) | |
201 | goto error; | |
202 | definition_ref(variant->enum_tag); | |
b1a2f580 MD |
203 | variant->fields = g_ptr_array_sized_new(variant_declaration->untagged_variant->fields->len); |
204 | g_ptr_array_set_size(variant->fields, variant_declaration->untagged_variant->fields->len); | |
d60cb676 | 205 | for (i = 0; i < variant_declaration->untagged_variant->fields->len; i++) { |
f6625916 | 206 | struct declaration_field *declaration_field = |
d60cb676 | 207 | &g_array_index(variant_declaration->untagged_variant->fields, |
f6625916 | 208 | struct declaration_field, i); |
b1a2f580 MD |
209 | struct definition **field = |
210 | (struct definition **) &g_ptr_array_index(variant->fields, i); | |
ac88af75 | 211 | |
05c749e5 MD |
212 | /* |
213 | * All child definition are at index 0, because they are | |
214 | * various choices of the same field. | |
215 | */ | |
b1a2f580 | 216 | *field = declaration_field->declaration->definition_new(declaration_field->declaration, |
a35173fe | 217 | variant->p.scope, |
98df1c9f MD |
218 | declaration_field->name, 0, NULL); |
219 | if (!*field) | |
220 | goto error; | |
ac88af75 | 221 | } |
c054553d MD |
222 | variant->current_field = NULL; |
223 | return &variant->p; | |
d60cb676 | 224 | error: |
a35173fe | 225 | free_definition_scope(variant->p.scope); |
d60cb676 MD |
226 | declaration_unref(&variant_declaration->p); |
227 | g_free(variant); | |
228 | return NULL; | |
c054553d MD |
229 | } |
230 | ||
231 | static | |
e1151715 | 232 | void _variant_definition_free(struct definition *definition) |
c054553d | 233 | { |
e1151715 MD |
234 | struct definition_variant *variant = |
235 | container_of(definition, struct definition_variant, p); | |
c054553d MD |
236 | unsigned long i; |
237 | ||
d60cb676 | 238 | assert(variant->fields->len == variant->declaration->untagged_variant->fields->len); |
c054553d | 239 | for (i = 0; i < variant->fields->len; i++) { |
b1a2f580 MD |
240 | struct definition *field = g_ptr_array_index(variant->fields, i); |
241 | definition_unref(field); | |
c054553d | 242 | } |
d60cb676 | 243 | definition_unref(variant->enum_tag); |
a35173fe | 244 | free_definition_scope(variant->p.scope); |
f6625916 | 245 | declaration_unref(variant->p.declaration); |
c054553d MD |
246 | g_free(variant); |
247 | } | |
248 | ||
d60cb676 MD |
249 | void untagged_variant_declaration_add_field(struct declaration_untagged_variant *untagged_variant_declaration, |
250 | const char *field_name, | |
251 | struct declaration *field_declaration) | |
c054553d | 252 | { |
f6625916 | 253 | struct declaration_field *field; |
c054553d MD |
254 | unsigned long index; |
255 | ||
d60cb676 MD |
256 | g_array_set_size(untagged_variant_declaration->fields, untagged_variant_declaration->fields->len + 1); |
257 | index = untagged_variant_declaration->fields->len - 1; /* last field (new) */ | |
258 | field = &g_array_index(untagged_variant_declaration->fields, struct declaration_field, index); | |
259 | field->name = g_quark_from_string(field_name); | |
260 | declaration_ref(field_declaration); | |
261 | field->declaration = field_declaration; | |
c054553d | 262 | /* Keep index in hash rather than pointer, because array can relocate */ |
d60cb676 | 263 | g_hash_table_insert(untagged_variant_declaration->fields_by_tag, |
c054553d MD |
264 | (gpointer) (unsigned long) field->name, |
265 | (gpointer) index); | |
266 | /* | |
267 | * Alignment of variant is based on the alignment of its currently | |
268 | * selected choice, so we leave variant alignment as-is (statically | |
269 | * speaking). | |
270 | */ | |
271 | } | |
272 | ||
f6625916 | 273 | struct declaration_field * |
d60cb676 | 274 | untagged_variant_declaration_get_field_from_tag(struct declaration_untagged_variant *untagged_variant_declaration, GQuark tag) |
c054553d | 275 | { |
43f9090c SM |
276 | gpointer index; |
277 | gboolean found; | |
c054553d | 278 | |
43f9090c SM |
279 | found = g_hash_table_lookup_extended( |
280 | untagged_variant_declaration->fields_by_tag, | |
281 | (gconstpointer) (unsigned long) tag, NULL, &index); | |
282 | ||
283 | if (!found) { | |
284 | return NULL; | |
285 | } | |
286 | ||
287 | return &g_array_index(untagged_variant_declaration->fields, struct declaration_field, (unsigned long)index); | |
c054553d MD |
288 | } |
289 | ||
290 | /* | |
291 | * field returned only valid as long as the field structure is not appended to. | |
292 | */ | |
b1a2f580 | 293 | struct definition *variant_get_current_field(struct definition_variant *variant) |
c054553d | 294 | { |
e1151715 MD |
295 | struct definition_enum *_enum = |
296 | container_of(variant->enum_tag, struct definition_enum, p); | |
f6625916 | 297 | struct declaration_variant *variant_declaration = variant->declaration; |
c054553d MD |
298 | unsigned long index; |
299 | GArray *tag_array; | |
300 | GQuark tag; | |
301 | ||
302 | tag_array = _enum->value; | |
303 | /* | |
304 | * The 1 to 1 mapping from enumeration to value should have been already | |
305 | * checked. (see TODO above) | |
306 | */ | |
307 | assert(tag_array->len == 1); | |
308 | tag = g_array_index(tag_array, GQuark, 0); | |
d60cb676 | 309 | index = (unsigned long) g_hash_table_lookup(variant_declaration->untagged_variant->fields_by_tag, |
c054553d | 310 | (gconstpointer) (unsigned long) tag); |
b1a2f580 | 311 | variant->current_field = g_ptr_array_index(variant->fields, index); |
96354dac | 312 | return variant->current_field; |
c054553d | 313 | } |