1 #ifndef BABELTRACE_CTF_IR_FIELD_TYPES_INTERNAL_H
2 #define BABELTRACE_CTF_IR_FIELD_TYPES_INTERNAL_H
5 * BabelTrace - CTF IR: Event field types internal
7 * Copyright 2013, 2014 Jérémie Galarneau <jeremie.galarneau@efficios.com>
9 * Author: Jérémie Galarneau <jeremie.galarneau@efficios.com>
11 * Permission is hereby granted, free of charge, to any person obtaining a copy
12 * of this software and associated documentation files (the "Software"), to deal
13 * in the Software without restriction, including without limitation the rights
14 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
15 * copies of the Software, and to permit persons to whom the Software is
16 * furnished to do so, subject to the following conditions:
18 * The above copyright notice and this permission notice shall be included in
19 * all copies or substantial portions of the Software.
21 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
22 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
23 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
24 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
25 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
26 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
30 #include <babeltrace/ctf-writer/event-types.h>
31 #include <babeltrace/ctf-writer/event-fields.h>
32 #include <babeltrace/ctf-writer/writer.h>
33 #include <babeltrace/ctf-ir/trace-internal.h>
34 #include <babeltrace/ctf-ir/clock-class.h>
35 #include <babeltrace/babeltrace-internal.h>
36 #include <babeltrace/object-internal.h>
39 typedef void (*type_freeze_func
)(struct bt_ctf_field_type
*);
40 typedef int (*type_serialize_func
)(struct bt_ctf_field_type
*,
41 struct metadata_context
*);
43 struct bt_ctf_field_type
{
44 struct bt_object base
;
45 enum bt_ctf_type_id id
;
46 unsigned int alignment
;
47 type_freeze_func freeze
;
48 type_serialize_func serialize
;
50 * A type can't be modified once it is added to an event or after a
51 * a field has been instanciated from it.
56 * This flag indicates if the field type is valid. A valid
57 * field type is _always_ frozen. All the nested field types of
58 * a valid field type are also valid (and thus frozen).
63 struct bt_ctf_field_type_integer
{
64 struct bt_ctf_field_type parent
;
65 struct bt_ctf_clock_class
*mapped_clock
;
66 enum bt_ctf_byte_order user_byte_order
;
69 enum bt_ctf_integer_base base
;
70 enum bt_ctf_string_encoding encoding
;
73 struct enumeration_mapping
{
86 struct bt_ctf_field_type_enumeration
{
87 struct bt_ctf_field_type parent
;
88 struct bt_ctf_field_type
*container
;
89 GPtrArray
*entries
; /* Array of ptrs to struct enumeration_mapping */
90 /* Only set during validation. */
91 bool has_overlapping_ranges
;
94 enum bt_ctf_field_type_enumeration_mapping_iterator_type
{
96 ITERATOR_BY_SIGNED_VALUE
,
97 ITERATOR_BY_UNSIGNED_VALUE
,
100 struct bt_ctf_field_type_enumeration_mapping_iterator
{
101 struct bt_object base
;
102 struct bt_ctf_field_type_enumeration
*enumeration_type
;
103 enum bt_ctf_field_type_enumeration_mapping_iterator_type type
;
107 int64_t signed_value
;
108 uint64_t unsigned_value
;
112 struct bt_ctf_field_type_floating_point
{
113 struct bt_ctf_field_type parent
;
114 enum bt_ctf_byte_order user_byte_order
;
115 unsigned int exp_dig
;
116 unsigned int mant_dig
;
119 struct structure_field
{
121 struct bt_ctf_field_type
*type
;
124 struct bt_ctf_field_type_structure
{
125 struct bt_ctf_field_type parent
;
126 GHashTable
*field_name_to_index
;
127 GPtrArray
*fields
; /* Array of pointers to struct structure_field */
130 struct bt_ctf_field_type_variant
{
131 struct bt_ctf_field_type parent
;
133 struct bt_ctf_field_type_enumeration
*tag
;
134 struct bt_ctf_field_path
*tag_field_path
;
135 GHashTable
*field_name_to_index
;
136 GPtrArray
*fields
; /* Array of pointers to struct structure_field */
139 struct bt_ctf_field_type_array
{
140 struct bt_ctf_field_type parent
;
141 struct bt_ctf_field_type
*element_type
;
142 unsigned int length
; /* Number of elements */
145 struct bt_ctf_field_type_sequence
{
146 struct bt_ctf_field_type parent
;
147 struct bt_ctf_field_type
*element_type
;
148 GString
*length_field_name
;
149 struct bt_ctf_field_path
*length_field_path
;
152 struct bt_ctf_field_type_string
{
153 struct bt_ctf_field_type parent
;
154 enum bt_ctf_string_encoding encoding
;
158 void bt_ctf_field_type_freeze(struct bt_ctf_field_type
*type
);
161 struct bt_ctf_field_type
*bt_ctf_field_type_variant_get_field_type_signed(
162 struct bt_ctf_field_type_variant
*variant
, int64_t tag_value
);
165 struct bt_ctf_field_type
*bt_ctf_field_type_variant_get_field_type_unsigned(
166 struct bt_ctf_field_type_variant
*variant
, uint64_t tag_value
);
169 int bt_ctf_field_type_serialize(struct bt_ctf_field_type
*type
,
170 struct metadata_context
*context
);
173 int bt_ctf_field_type_validate(struct bt_ctf_field_type
*type
);
176 int bt_ctf_field_type_structure_get_field_name_index(
177 struct bt_ctf_field_type
*structure
, const char *name
);
179 /* Replace an existing field's type in a structure */
181 int bt_ctf_field_type_structure_set_field_index(
182 struct bt_ctf_field_type
*structure
,
183 struct bt_ctf_field_type
*field
, int index
);
186 int bt_ctf_field_type_variant_get_field_name_index(
187 struct bt_ctf_field_type
*variant
, const char *name
);
190 int bt_ctf_field_type_sequence_set_length_field_path(
191 struct bt_ctf_field_type
*type
,
192 struct bt_ctf_field_path
*path
);
195 int bt_ctf_field_type_variant_set_tag_field_path(struct bt_ctf_field_type
*type
,
196 struct bt_ctf_field_path
*path
);
199 int bt_ctf_field_type_variant_set_tag_field_type(struct bt_ctf_field_type
*type
,
200 struct bt_ctf_field_type
*tag_type
);
202 /* Replace an existing field's type in a variant */
204 int bt_ctf_field_type_variant_set_field_index(
205 struct bt_ctf_field_type
*variant
,
206 struct bt_ctf_field_type
*field
, int index
);
209 int bt_ctf_field_type_array_set_element_type(struct bt_ctf_field_type
*array
,
210 struct bt_ctf_field_type
*element_type
);
213 int bt_ctf_field_type_sequence_set_element_type(struct bt_ctf_field_type
*array
,
214 struct bt_ctf_field_type
*element_type
);
217 int bt_ctf_field_type_get_field_count(struct bt_ctf_field_type
*type
);
220 struct bt_ctf_field_type
*bt_ctf_field_type_get_field_at_index(
221 struct bt_ctf_field_type
*type
, int index
);
224 int bt_ctf_field_type_get_field_index(struct bt_ctf_field_type
*type
,
227 #endif /* BABELTRACE_CTF_IR_FIELD_TYPES_INTERNAL_H */