1 #ifndef BABELTRACE_TRACE_IR_FIELD_CLASSES_INTERNAL_H
2 #define BABELTRACE_TRACE_IR_FIELD_CLASSES_INTERNAL_H
5 * Copyright 2017-2018 Philippe Proulx <pproulx@efficios.com>
6 * Copyright 2013, 2014 Jérémie Galarneau <jeremie.galarneau@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.
18 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
19 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
20 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
21 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
22 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
23 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
27 #include "lib/assert-pre.h"
28 #include <babeltrace2/trace-ir/clock-class.h>
29 #include <babeltrace2/trace-ir/field-class.h>
30 #include "common/macros.h"
31 #include "common/common.h"
32 #include "lib/object.h"
33 #include <babeltrace2/types.h>
37 #define _BT_ASSERT_PRE_FC_IS_INT_COND(_fc) \
38 (((const struct bt_field_class *) (_fc))->type == BT_FIELD_CLASS_TYPE_UNSIGNED_INTEGER || \
39 ((const struct bt_field_class *) (_fc))->type == BT_FIELD_CLASS_TYPE_SIGNED_INTEGER || \
40 ((const struct bt_field_class *) (_fc))->type == BT_FIELD_CLASS_TYPE_UNSIGNED_ENUMERATION || \
41 ((const struct bt_field_class *) (_fc))->type == BT_FIELD_CLASS_TYPE_SIGNED_ENUMERATION)
43 #define _BT_ASSERT_PRE_FC_IS_INT_FMT(_name) \
44 _name " is not an integer field class: %![fc-]+F"
46 #define _BT_ASSERT_PRE_FC_IS_UNSIGNED_INT_COND(_fc) \
47 (((const struct bt_field_class *) (_fc))->type == BT_FIELD_CLASS_TYPE_UNSIGNED_INTEGER || \
48 ((const struct bt_field_class *) (_fc))->type == BT_FIELD_CLASS_TYPE_UNSIGNED_ENUMERATION)
50 #define _BT_ASSERT_PRE_FC_IS_UNSIGNED_INT_FMT(_name) \
51 _name " is not an unsigned integer field class: %![fc-]+F"
54 #define _BT_ASSERT_PRE_FC_IS_SIGNED_INT_COND(_fc) \
55 (((const struct bt_field_class *) (_fc))->type == BT_FIELD_CLASS_TYPE_SIGNED_INTEGER || \
56 ((const struct bt_field_class *) (_fc))->type == BT_FIELD_CLASS_TYPE_SIGNED_ENUMERATION)
58 #define _BT_ASSERT_PRE_FC_IS_SIGNED_INT_FMT(_name) \
59 _name " is not a signed integer field class: %![fc-]+F"
61 #define _BT_ASSERT_PRE_FC_IS_ENUM_COND(_fc) \
62 (((const struct bt_field_class *) (_fc))->type == BT_FIELD_CLASS_TYPE_UNSIGNED_ENUMERATION || \
63 ((const struct bt_field_class *) (_fc))->type == BT_FIELD_CLASS_TYPE_SIGNED_ENUMERATION)
65 #define _BT_ASSERT_PRE_FC_IS_ENUM_FMT(_name) \
66 _name " is not an enumeration field class: %![fc-]+F"
68 #define _BT_ASSERT_PRE_FC_IS_ARRAY_COND(_fc) \
69 (((const struct bt_field_class *) (_fc))->type == BT_FIELD_CLASS_TYPE_STATIC_ARRAY || \
70 ((const struct bt_field_class *) (_fc))->type == BT_FIELD_CLASS_TYPE_DYNAMIC_ARRAY)
72 #define _BT_ASSERT_PRE_FC_IS_ARRAY_FMT(_name) \
73 _name " is not an array field class: %![fc-]+F"
75 #define _BT_ASSERT_PRE_FC_IS_VARIANT_COND(_fc) \
76 (((const struct bt_field_class *) (_fc))->type == BT_FIELD_CLASS_TYPE_VARIANT_WITHOUT_SELECTOR || \
77 ((const struct bt_field_class *) (_fc))->type == BT_FIELD_CLASS_TYPE_VARIANT_WITH_UNSIGNED_SELECTOR || \
78 ((const struct bt_field_class *) (_fc))->type == BT_FIELD_CLASS_TYPE_VARIANT_WITH_SIGNED_SELECTOR)
80 #define _BT_ASSERT_PRE_FC_IS_VARIANT_FMT(_name) \
81 _name " is not a variant field class: %![fc-]+F"
83 #define _BT_ASSERT_PRE_FC_IS_VARIANT_WITH_SEL_COND(_fc) \
84 (((const struct bt_field_class *) (_fc))->type == BT_FIELD_CLASS_TYPE_VARIANT_WITH_UNSIGNED_SELECTOR || \
85 ((const struct bt_field_class *) (_fc))->type == BT_FIELD_CLASS_TYPE_VARIANT_WITH_SIGNED_SELECTOR)
87 #define _BT_ASSERT_PRE_FC_IS_VARIANT_WITH_SEL_FMT(_name) \
88 _name " is not a variant field class with a selector: %![fc-]+F"
90 #define _BT_ASSERT_PRE_FC_HAS_ID_COND(_fc, _type) \
91 (((const struct bt_field_class *) (_fc))->type == (_type))
93 #define _BT_ASSERT_PRE_FC_HAS_ID_FMT(_name) \
94 _name " has the wrong type: expected-type=%s, %![fc-]+F"
96 #define BT_ASSERT_PRE_FC_IS_INT(_fc, _name) \
97 BT_ASSERT_PRE(_BT_ASSERT_PRE_FC_IS_INT_COND(_fc), \
98 _BT_ASSERT_PRE_FC_IS_INT_FMT(_name), (_fc))
100 #define BT_ASSERT_PRE_FC_IS_UNSIGNED_INT(_fc, _name) \
101 BT_ASSERT_PRE(_BT_ASSERT_PRE_FC_IS_UNSIGNED_INT_COND(_fc), \
102 _BT_ASSERT_PRE_FC_IS_UNSIGNED_INT_FMT(_name), (_fc))
104 #define BT_ASSERT_PRE_FC_IS_SIGNED_INT(_fc, _name) \
105 BT_ASSERT_PRE(_BT_ASSERT_PRE_FC_IS_SIGNED_INT_COND(_fc), \
106 _BT_ASSERT_PRE_FC_IS_SIGNED_INT_FMT(_name), (_fc))
108 #define BT_ASSERT_PRE_FC_IS_ENUM(_fc, _name) \
109 BT_ASSERT_PRE(_BT_ASSERT_PRE_FC_IS_ENUM_COND(_fc), \
110 _BT_ASSERT_PRE_FC_IS_ENUM_FMT(_name), (_fc))
112 #define BT_ASSERT_PRE_FC_IS_ARRAY(_fc, _name) \
113 BT_ASSERT_PRE(_BT_ASSERT_PRE_FC_IS_ARRAY_COND(_fc), \
114 _BT_ASSERT_PRE_FC_IS_ARRAY_FMT(_name), (_fc))
116 #define BT_ASSERT_PRE_FC_IS_VARIANT(_fc, _name) \
117 BT_ASSERT_PRE(_BT_ASSERT_PRE_FC_IS_VARIANT_COND(_fc), \
118 _BT_ASSERT_PRE_FC_IS_VARIANT_FMT(_name), (_fc))
120 #define BT_ASSERT_PRE_FC_IS_VARIANT_WITH_SEL(_fc, _name) \
121 BT_ASSERT_PRE(_BT_ASSERT_PRE_FC_IS_VARIANT_WITH_SEL_COND(_fc), \
122 _BT_ASSERT_PRE_FC_IS_VARIANT_WITH_SEL_FMT(_name), (_fc))
124 #define BT_ASSERT_PRE_FC_HAS_ID(_fc, _type, _name) \
125 BT_ASSERT_PRE(_BT_ASSERT_PRE_FC_HAS_ID_COND((_fc), (_type)), \
126 _BT_ASSERT_PRE_FC_HAS_ID_FMT(_name), \
127 bt_common_field_class_type_string(_type), (_fc))
129 #define BT_ASSERT_PRE_DEV_FC_IS_INT(_fc, _name) \
130 BT_ASSERT_PRE_DEV(_BT_ASSERT_PRE_FC_IS_INT_COND(_fc), \
131 _BT_ASSERT_PRE_FC_IS_INT_FMT(_name), (_fc))
133 #define BT_ASSERT_PRE_DEV_FC_IS_UNSIGNED_INT(_fc, _name) \
134 BT_ASSERT_PRE_DEV(_BT_ASSERT_PRE_FC_IS_UNSIGNED_INT_COND(_fc), \
135 _BT_ASSERT_PRE_FC_IS_UNSIGNED_INT_FMT(_name), (_fc))
137 #define BT_ASSERT_PRE_DEV_FC_IS_SIGNED_INT(_fc, _name) \
138 BT_ASSERT_PRE_DEV(_BT_ASSERT_PRE_FC_IS_SIGNED_INT_COND(_fc), \
139 _BT_ASSERT_PRE_FC_IS_SIGNED_INT_FMT(_name), (_fc))
141 #define BT_ASSERT_PRE_DEV_FC_IS_ENUM(_fc, _name) \
142 BT_ASSERT_PRE_DEV(_BT_ASSERT_PRE_FC_IS_ENUM_COND(_fc), \
143 _BT_ASSERT_PRE_FC_IS_ENUM_FMT(_name), (_fc))
145 #define BT_ASSERT_PRE_DEV_FC_IS_ARRAY(_fc, _name) \
146 BT_ASSERT_PRE_DEV(_BT_ASSERT_PRE_FC_IS_ARRAY_COND(_fc), \
147 _BT_ASSERT_PRE_FC_IS_ARRAY_FMT(_name), (_fc))
149 #define BT_ASSERT_PRE_DEV_FC_IS_VARIANT(_fc, _name) \
150 BT_ASSERT_PRE_DEV(_BT_ASSERT_PRE_FC_IS_VARIANT_COND(_fc), \
151 _BT_ASSERT_PRE_FC_IS_VARIANT_FMT(_name), (_fc))
153 #define BT_ASSERT_PRE_DEV_FC_IS_VARIANT_WITH_SEL(_fc, _name) \
154 BT_ASSERT_PRE_DEV(_BT_ASSERT_PRE_FC_IS_VARIANT_WITH_SEL_COND(_fc), \
155 _BT_ASSERT_PRE_FC_IS_VARIANT_WITH_SEL_FMT(_name), (_fc))
157 #define BT_ASSERT_PRE_DEV_FC_HAS_ID(_fc, _type, _name) \
158 BT_ASSERT_PRE_DEV(_BT_ASSERT_PRE_FC_HAS_ID_COND((_fc), (_type)), \
159 _BT_ASSERT_PRE_FC_HAS_ID_FMT(_name), \
160 bt_common_field_class_type_string(_type), (_fc))
162 #define BT_ASSERT_PRE_DEV_FC_HOT(_fc, _name) \
163 BT_ASSERT_PRE_DEV_HOT((const struct bt_field_class *) (_fc), \
164 (_name), ": %!+F", (_fc))
166 #define BT_FIELD_CLASS_ENUM_MAPPING_AT_INDEX(_fc, _index) \
167 (&g_array_index(((struct bt_field_class_enumeration *) (_fc))->mappings, \
168 struct bt_field_class_enumeration_mapping, (_index)))
170 #define BT_FIELD_CLASS_ENUM_MAPPING_RANGE_AT_INDEX(_mapping, _index) \
171 (&g_array_index((_mapping)->ranges, \
172 struct bt_field_class_enumeration_mapping_range, (_index)))
175 struct bt_field_class
;
177 struct bt_field_class
{
178 struct bt_object base
;
179 enum bt_field_class_type type
;
183 * This flag indicates whether or not this field class is part
186 bool part_of_trace_class
;
189 struct bt_field_class_bool
{
190 struct bt_field_class common
;
193 struct bt_field_class_integer
{
194 struct bt_field_class common
;
197 * Value range of fields built from this integer field class:
198 * this is an equivalent integer size in bits. More formally,
201 * Unsigned range: [0, 2^n - 1]
202 * Signed range: [-2^(n - 1), 2^(n - 1) - 1]
206 enum bt_field_class_integer_preferred_display_base base
;
209 struct bt_field_class_enumeration_mapping
{
213 const struct bt_integer_range_set
*range_set
;
216 struct bt_field_class_enumeration_unsigned_mapping
;
217 struct bt_field_class_enumeration_signed_mapping
;
219 struct bt_field_class_enumeration
{
220 struct bt_field_class_integer common
;
222 /* Array of `struct bt_field_class_enumeration_mapping *` */
226 * This is an array of `const char *` which acts as a temporary
227 * (potentially growing) buffer for
228 * bt_field_class_enumeration_unsigned_get_mapping_labels_for_value()
230 * bt_field_class_enumeration_signed_get_mapping_labels_for_value().
232 * The actual strings are owned by the mappings above.
234 GPtrArray
*label_buf
;
237 struct bt_field_class_real
{
238 struct bt_field_class common
;
239 bool is_single_precision
;
242 struct bt_field_class_string
{
243 struct bt_field_class common
;
246 /* A named field class is a (name, field class) pair */
247 struct bt_named_field_class
{
251 struct bt_field_class
*fc
;
256 struct bt_field_class_structure_member
;
257 struct bt_field_class_variant_option
;
258 struct bt_field_class_variant_with_selector_unsigned_option
;
259 struct bt_field_class_variant_with_selector_signed_option
;
261 struct bt_field_class_named_field_class_container
{
262 struct bt_field_class common
;
265 * Key: `const char *`, not owned by this (owned by named field
266 * class objects contained in `named_fcs` below).
268 GHashTable
*name_to_index
;
270 /* Array of `struct bt_named_field_class *` */
271 GPtrArray
*named_fcs
;
274 struct bt_field_class_structure
{
275 struct bt_field_class_named_field_class_container common
;
278 struct bt_field_class_array
{
279 struct bt_field_class common
;
282 struct bt_field_class
*element_fc
;
285 struct bt_field_class_array_static
{
286 struct bt_field_class_array common
;
290 struct bt_field_class_array_dynamic
{
291 struct bt_field_class_array common
;
293 /* Weak: never dereferenced, only use to find it elsewhere */
294 struct bt_field_class
*length_fc
;
297 struct bt_field_path
*length_field_path
;
300 /* Variant FC (with selector) option: named field class + range set */
301 struct bt_field_class_variant_with_selector_option
{
302 struct bt_named_field_class common
;
305 const struct bt_integer_range_set
*range_set
;
308 struct bt_field_class_variant
{
310 * Depending on the variant field class type, the contained
311 * named field classes are of type
312 * `struct bt_named_field_class *` if the variant field class
313 * doesn't have a selector, or
314 * `struct bt_field_class_variant_with_selector_option *`
317 struct bt_field_class_named_field_class_container common
;
320 struct bt_field_class_variant_with_selector
{
321 struct bt_field_class_variant common
;
324 * Owned by this, but never dereferenced: only use to find it
327 const struct bt_field_class
*selector_fc
;
330 struct bt_field_path
*selector_field_path
;
334 void _bt_field_class_freeze(const struct bt_field_class
*field_class
);
337 # define bt_field_class_freeze _bt_field_class_freeze
339 # define bt_field_class_freeze(_fc) ((void) _fc)
343 void _bt_named_field_class_freeze(const struct bt_named_field_class
*named_fc
);
346 # define bt_named_field_class_freeze _bt_named_field_class_freeze
348 # define bt_named_field_class_freeze(_named_fc) ((void) _named_fc)
352 * This function recursively marks `field_class` and its children as
353 * being part of a trace. This is used to validate that all field classes
354 * are used at a single location within trace objects even if they are
355 * shared objects for other purposes.
358 void bt_field_class_make_part_of_trace_class(
359 const struct bt_field_class
*field_class
);
361 #endif /* BABELTRACE_TRACE_IR_FIELD_CLASSES_INTERNAL_H */