4 * BabelTrace - Variant Type Converter
6 * Copyright 2010-2011 EfficiOS Inc. and Linux Foundation
8 * Author: Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
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:
17 * The above copyright notice and this permission notice shall be included in
18 * all copies or substantial portions of the Software.
20 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
21 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
22 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
23 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
24 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
25 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
29 #include <babeltrace/compiler.h>
30 #include <babeltrace/format.h>
31 #include <babeltrace/types.h>
35 struct bt_definition
*_variant_definition_new(struct bt_declaration
*declaration
,
36 struct definition_scope
*parent_scope
,
37 GQuark field_name
, int index
,
38 const char *root_name
);
40 void _variant_definition_free(struct bt_definition
*definition
);
42 int bt_variant_rw(struct bt_stream_pos
*ppos
, struct bt_definition
*definition
)
44 struct definition_variant
*variant_definition
=
45 container_of(definition
, struct definition_variant
, p
);
46 struct bt_definition
*field
;
48 field
= bt_variant_get_current_field(variant_definition
);
49 return generic_rw(ppos
, field
);
53 void _untagged_variant_declaration_free(struct bt_declaration
*declaration
)
55 struct declaration_untagged_variant
*untagged_variant_declaration
=
56 container_of(declaration
, struct declaration_untagged_variant
, p
);
59 bt_free_declaration_scope(untagged_variant_declaration
->scope
);
60 g_hash_table_destroy(untagged_variant_declaration
->fields_by_tag
);
62 for (i
= 0; i
< untagged_variant_declaration
->fields
->len
; i
++) {
63 struct declaration_field
*declaration_field
=
64 &g_array_index(untagged_variant_declaration
->fields
,
65 struct declaration_field
, i
);
66 bt_declaration_unref(declaration_field
->declaration
);
68 g_array_free(untagged_variant_declaration
->fields
, true);
69 g_free(untagged_variant_declaration
);
72 struct declaration_untagged_variant
*bt_untagged_bt_variant_declaration_new(
73 struct declaration_scope
*parent_scope
)
75 struct declaration_untagged_variant
*untagged_variant_declaration
;
76 struct bt_declaration
*declaration
;
78 untagged_variant_declaration
= g_new(struct declaration_untagged_variant
, 1);
79 declaration
= &untagged_variant_declaration
->p
;
80 untagged_variant_declaration
->fields_by_tag
= g_hash_table_new(g_direct_hash
,
82 untagged_variant_declaration
->fields
= g_array_sized_new(FALSE
, TRUE
,
83 sizeof(struct declaration_field
),
84 DEFAULT_NR_STRUCT_FIELDS
);
85 untagged_variant_declaration
->scope
= bt_new_declaration_scope(parent_scope
);
86 declaration
->id
= CTF_TYPE_UNTAGGED_VARIANT
;
87 declaration
->alignment
= 1;
88 declaration
->declaration_free
= _untagged_variant_declaration_free
;
89 declaration
->definition_new
= NULL
;
90 declaration
->definition_free
= NULL
;
92 return untagged_variant_declaration
;
96 void _variant_declaration_free(struct bt_declaration
*declaration
)
98 struct declaration_variant
*variant_declaration
=
99 container_of(declaration
, struct declaration_variant
, p
);
101 bt_declaration_unref(&variant_declaration
->untagged_variant
->p
);
102 g_array_free(variant_declaration
->tag_name
, TRUE
);
103 g_free(variant_declaration
);
106 struct declaration_variant
*
107 bt_variant_declaration_new(struct declaration_untagged_variant
*untagged_variant
, const char *tag
)
109 struct declaration_variant
*variant_declaration
;
110 struct bt_declaration
*declaration
;
112 variant_declaration
= g_new(struct declaration_variant
, 1);
113 declaration
= &variant_declaration
->p
;
114 variant_declaration
->untagged_variant
= untagged_variant
;
115 bt_declaration_ref(&untagged_variant
->p
);
116 variant_declaration
->tag_name
= g_array_new(FALSE
, TRUE
, sizeof(GQuark
));
117 bt_append_scope_path(tag
, variant_declaration
->tag_name
);
118 declaration
->id
= CTF_TYPE_VARIANT
;
119 declaration
->alignment
= 1;
120 declaration
->declaration_free
= _variant_declaration_free
;
121 declaration
->definition_new
= _variant_definition_new
;
122 declaration
->definition_free
= _variant_definition_free
;
123 declaration
->ref
= 1;
124 return variant_declaration
;
128 * tag_instance is assumed to be an enumeration.
129 * Returns 0 if OK, < 0 if error.
132 int check_enum_tag(struct definition_variant
*variant
,
133 struct bt_definition
*enum_tag
)
135 struct definition_enum
*_enum
=
136 container_of(enum_tag
, struct definition_enum
, p
);
137 struct declaration_enum
*enum_declaration
= _enum
->declaration
;
138 int missing_field
= 0;
142 * Strictly speaking, each enumerator must map to a field of the
143 * variant. However, we are even stricter here by requiring that each
144 * variant choice map to an enumerator too. We then validate that the
145 * number of enumerators equals the number of variant choices.
147 if (variant
->declaration
->untagged_variant
->fields
->len
!= bt_enum_get_nr_enumerators(enum_declaration
))
150 for (i
= 0; i
< variant
->declaration
->untagged_variant
->fields
->len
; i
++) {
151 struct declaration_field
*field_declaration
=
152 &g_array_index(variant
->declaration
->untagged_variant
->fields
,
153 struct declaration_field
, i
);
154 if (!bt_enum_quark_to_range_set(enum_declaration
, field_declaration
->name
)) {
163 * Check the enumeration: it must map each value to one and only one
165 * TODO: we should also check that each range map to one and only one
166 * tag. For the moment, we will simply check this dynamically in
167 * variant_declaration_get_current_field().
175 struct bt_definition
*
176 _variant_definition_new(struct bt_declaration
*declaration
,
177 struct definition_scope
*parent_scope
,
178 GQuark field_name
, int index
,
179 const char *root_name
)
181 struct declaration_variant
*variant_declaration
=
182 container_of(declaration
, struct declaration_variant
, p
);
183 struct definition_variant
*variant
;
187 variant
= g_new(struct definition_variant
, 1);
188 bt_declaration_ref(&variant_declaration
->p
);
189 variant
->p
.declaration
= declaration
;
190 variant
->declaration
= variant_declaration
;
193 * Use INT_MAX order to ensure that all fields of the parent
194 * scope are seen as being prior to this scope.
196 variant
->p
.index
= root_name
? INT_MAX
: index
;
197 variant
->p
.name
= field_name
;
198 variant
->p
.path
= bt_new_definition_path(parent_scope
, field_name
, root_name
);
199 variant
->p
.scope
= bt_new_definition_scope(parent_scope
, field_name
, root_name
);
201 ret
= bt_register_field_definition(field_name
, &variant
->p
,
205 variant
->enum_tag
= bt_lookup_path_definition(variant
->p
.scope
->scope_path
,
206 variant_declaration
->tag_name
,
209 if (!variant
->enum_tag
210 || check_enum_tag(variant
, variant
->enum_tag
) < 0)
212 bt_definition_ref(variant
->enum_tag
);
213 variant
->fields
= g_ptr_array_sized_new(variant_declaration
->untagged_variant
->fields
->len
);
214 g_ptr_array_set_size(variant
->fields
, variant_declaration
->untagged_variant
->fields
->len
);
215 for (i
= 0; i
< variant_declaration
->untagged_variant
->fields
->len
; i
++) {
216 struct declaration_field
*declaration_field
=
217 &g_array_index(variant_declaration
->untagged_variant
->fields
,
218 struct declaration_field
, i
);
219 struct bt_definition
**field
=
220 (struct bt_definition
**) &g_ptr_array_index(variant
->fields
, i
);
223 * All child definition are at index 0, because they are
224 * various choices of the same field.
226 *field
= declaration_field
->declaration
->definition_new(declaration_field
->declaration
,
228 declaration_field
->name
, 0, NULL
);
232 variant
->current_field
= NULL
;
235 bt_free_definition_scope(variant
->p
.scope
);
236 bt_declaration_unref(&variant_declaration
->p
);
242 void _variant_definition_free(struct bt_definition
*definition
)
244 struct definition_variant
*variant
=
245 container_of(definition
, struct definition_variant
, p
);
248 assert(variant
->fields
->len
== variant
->declaration
->untagged_variant
->fields
->len
);
249 for (i
= 0; i
< variant
->fields
->len
; i
++) {
250 struct bt_definition
*field
= g_ptr_array_index(variant
->fields
, i
);
251 bt_definition_unref(field
);
253 bt_definition_unref(variant
->enum_tag
);
254 bt_free_definition_scope(variant
->p
.scope
);
255 bt_declaration_unref(variant
->p
.declaration
);
256 g_ptr_array_free(variant
->fields
, TRUE
);
260 void bt_untagged_variant_declaration_add_field(struct declaration_untagged_variant
*untagged_variant_declaration
,
261 const char *field_name
,
262 struct bt_declaration
*field_declaration
)
264 struct declaration_field
*field
;
267 g_array_set_size(untagged_variant_declaration
->fields
, untagged_variant_declaration
->fields
->len
+ 1);
268 index
= untagged_variant_declaration
->fields
->len
- 1; /* last field (new) */
269 field
= &g_array_index(untagged_variant_declaration
->fields
, struct declaration_field
, index
);
270 field
->name
= g_quark_from_string(field_name
);
271 bt_declaration_ref(field_declaration
);
272 field
->declaration
= field_declaration
;
273 /* Keep index in hash rather than pointer, because array can relocate */
274 g_hash_table_insert(untagged_variant_declaration
->fields_by_tag
,
275 (gpointer
) (unsigned long) field
->name
,
278 * Alignment of variant is based on the alignment of its currently
279 * selected choice, so we leave variant alignment as-is (statically
284 struct declaration_field
*
285 bt_untagged_variant_declaration_get_field_from_tag(struct declaration_untagged_variant
*untagged_variant_declaration
, GQuark tag
)
290 found
= g_hash_table_lookup_extended(
291 untagged_variant_declaration
->fields_by_tag
,
292 (gconstpointer
) (unsigned long) tag
, NULL
, &index
);
298 return &g_array_index(untagged_variant_declaration
->fields
, struct declaration_field
, (unsigned long)index
);
302 * field returned only valid as long as the field structure is not appended to.
304 struct bt_definition
*bt_variant_get_current_field(struct definition_variant
*variant
)
306 struct definition_enum
*_enum
=
307 container_of(variant
->enum_tag
, struct definition_enum
, p
);
308 struct declaration_variant
*variant_declaration
= variant
->declaration
;
313 tag_array
= _enum
->value
;
315 * The 1 to 1 mapping from enumeration to value should have been already
316 * checked. (see TODO above)
318 assert(tag_array
->len
== 1);
319 tag
= g_array_index(tag_array
, GQuark
, 0);
320 index
= (unsigned long) g_hash_table_lookup(variant_declaration
->untagged_variant
->fields_by_tag
,
321 (gconstpointer
) (unsigned long) tag
);
322 variant
->current_field
= g_ptr_array_index(variant
->fields
, index
);
323 return variant
->current_field
;