4 * BabelTrace - Variant Type Converter
6 * Copyright 2011 - Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
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:
15 * The above copyright notice and this permission notice shall be included in
16 * all copies or substantial portions of the Software.
19 #include <babeltrace/compiler.h>
20 #include <babeltrace/format.h>
24 struct declaration
*_variant_declaration_new(struct type
*type
,
25 struct declaration_scope
*parent_scope
);
27 void _variant_declaration_free(struct declaration
*declaration
);
29 void variant_copy(struct stream_pos
*dest
, const struct format
*fdest
,
30 struct stream_pos
*src
, const struct format
*fsrc
,
31 struct declaration
*declaration
)
33 struct declaration_variant
*variant
=
34 container_of(declaration
, struct declaration_variant
, p
);
35 struct type_variant
*variant_type
= variant
->type
;
37 struct type
*field_type
;
39 fsrc
->variant_begin(src
, variant_type
);
40 fdest
->variant_begin(dest
, variant_type
);
42 field
= variant_get_current_field(variant
);
43 field_type
= field
->declaration
->type
;
44 field_type
->copy(dest
, fdest
, src
, fsrc
, field
->declaration
);
46 fsrc
->variant_end(src
, variant_type
);
47 fdest
->variant_end(dest
, variant_type
);
51 void _variant_type_free(struct type
*type
)
53 struct type_variant
*variant_type
=
54 container_of(type
, struct type_variant
, p
);
57 free_type_scope(variant_type
->scope
);
58 g_hash_table_destroy(variant_type
->fields_by_tag
);
60 for (i
= 0; i
< variant_type
->fields
->len
; i
++) {
61 struct type_field
*type_field
=
62 &g_array_index(variant_type
->fields
,
63 struct type_field
, i
);
64 type_unref(type_field
->type
);
66 g_array_free(variant_type
->fields
, true);
70 struct type_variant
*variant_type_new(const char *name
,
71 struct type_scope
*parent_scope
)
73 struct type_variant
*variant_type
;
76 variant_type
= g_new(struct type_variant
, 1);
77 type
= &variant_type
->p
;
78 variant_type
->fields_by_tag
= g_hash_table_new(g_direct_hash
,
80 variant_type
->fields
= g_array_sized_new(FALSE
, TRUE
,
81 sizeof(struct type_field
),
82 DEFAULT_NR_STRUCT_FIELDS
);
83 variant_type
->scope
= new_type_scope(parent_scope
);
84 type
->name
= g_quark_from_string(name
);
86 type
->copy
= variant_copy
;
87 type
->type_free
= _variant_type_free
;
88 type
->declaration_new
= _variant_declaration_new
;
89 type
->declaration_free
= _variant_declaration_free
;
96 _variant_declaration_new(struct type
*type
,
97 struct declaration_scope
*parent_scope
)
99 struct type_variant
*variant_type
=
100 container_of(type
, struct type_variant
, p
);
101 struct declaration_variant
*variant
;
104 variant
= g_new(struct declaration_variant
, 1);
105 type_ref(&variant_type
->p
);
106 variant
->p
.type
= type
;
107 variant
->type
= variant_type
;
109 variant
->scope
= new_declaration_scope(parent_scope
);
110 variant
->fields
= g_array_sized_new(FALSE
, TRUE
,
111 sizeof(struct field
),
112 DEFAULT_NR_STRUCT_FIELDS
);
113 g_array_set_size(variant
->fields
, variant_type
->fields
->len
);
114 for (i
= 0; i
< variant_type
->fields
->len
; i
++) {
115 struct type_field
*type_field
=
116 &g_array_index(variant_type
->fields
,
117 struct type_field
, i
);
118 struct field
*field
= &g_array_index(variant
->fields
,
121 field
->name
= type_field
->name
;
123 type_field
->type
->declaration_new(type_field
->type
,
126 variant
->current_field
= NULL
;
131 void _variant_declaration_free(struct declaration
*declaration
)
133 struct declaration_variant
*variant
=
134 container_of(declaration
, struct declaration_variant
, p
);
137 assert(variant
->fields
->len
== variant
->type
->fields
->len
);
138 for (i
= 0; i
< variant
->fields
->len
; i
++) {
139 struct field
*field
= &g_array_index(variant
->fields
,
141 declaration_unref(field
->declaration
);
143 free_declaration_scope(variant
->scope
);
144 type_unref(variant
->p
.type
);
148 void variant_type_add_field(struct type_variant
*variant_type
,
149 const char *tag_name
,
150 struct type
*tag_type
)
152 struct type_field
*field
;
155 g_array_set_size(variant_type
->fields
, variant_type
->fields
->len
+ 1);
156 index
= variant_type
->fields
->len
- 1; /* last field (new) */
157 field
= &g_array_index(variant_type
->fields
, struct type_field
, index
);
158 field
->name
= g_quark_from_string(tag_name
);
160 field
->type
= tag_type
;
161 /* Keep index in hash rather than pointer, because array can relocate */
162 g_hash_table_insert(variant_type
->fields_by_tag
,
163 (gpointer
) (unsigned long) field
->name
,
166 * Alignment of variant is based on the alignment of its currently
167 * selected choice, so we leave variant alignment as-is (statically
173 struct_type_get_field_from_tag(struct type_variant
*variant_type
, GQuark tag
)
177 index
= (unsigned long) g_hash_table_lookup(variant_type
->fields_by_tag
,
178 (gconstpointer
) (unsigned long) tag
);
179 return &g_array_index(variant_type
->fields
, struct type_field
, index
);
183 * tag_instance is assumed to be an enumeration.
185 int variant_declaration_set_tag(struct declaration_variant
*variant
,
186 struct declaration
*enum_tag
)
188 struct declaration_enum
*_enum
=
189 container_of(variant
->enum_tag
, struct declaration_enum
, p
);
190 struct type_enum
*enum_type
= _enum
->type
;
191 int missing_field
= 0;
195 * Strictly speaking, each enumerator must map to a field of the
196 * variant. However, we are even stricter here by requiring that each
197 * variant choice map to an enumerator too. We then validate that the
198 * number of enumerators equals the number of variant choices.
200 if (variant
->type
->fields
->len
!= enum_get_nr_enumerators(enum_type
))
203 for (i
= 0; i
< variant
->type
->fields
->len
; i
++) {
204 struct type_field
*field_type
=
205 &g_array_index(variant
->type
->fields
,
206 struct type_field
, i
);
207 if (!enum_quark_to_range_set(enum_type
, field_type
->name
)) {
216 * Check the enumeration: it must map each value to one and only one
218 * TODO: we should also check that each range map to one and only one
219 * tag. For the moment, we will simply check this dynamically in
220 * variant_type_get_current_field().
223 /* Set the enum tag field */
224 variant
->enum_tag
= enum_tag
;
229 * field returned only valid as long as the field structure is not appended to.
231 struct field
*variant_get_current_field(struct declaration_variant
*variant
)
233 struct declaration_enum
*_enum
=
234 container_of(variant
->enum_tag
, struct declaration_enum
, p
);
235 struct type_variant
*variant_type
= variant
->type
;
240 tag_array
= _enum
->value
;
242 * The 1 to 1 mapping from enumeration to value should have been already
243 * checked. (see TODO above)
245 assert(tag_array
->len
== 1);
246 tag
= g_array_index(tag_array
, GQuark
, 0);
247 index
= (unsigned long) g_hash_table_lookup(variant_type
->fields_by_tag
,
248 (gconstpointer
) (unsigned long) tag
);
249 variant
->current_field
= &g_array_index(variant
->fields
, struct field
, index
);
250 return variant
->current_field
;