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