1 #ifndef BABELTRACE_TRACE_IR_FIELDS_INTERNAL_H
2 #define BABELTRACE_TRACE_IR_FIELDS_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 "common/common.h"
29 #include "lib/object.h"
30 #include "common/macros.h"
31 #include <babeltrace2/types.h>
38 #include "field-class.h"
41 #define BT_ASSERT_PRE_DEV_FIELD_HAS_CLASS_TYPE(_field, _cls_type, _name) \
42 BT_ASSERT_PRE_DEV(((const struct bt_field *) (_field))->class->type == (_cls_type), \
43 _name " has the wrong class type: expected-class-type=%s, " \
45 bt_common_field_class_type_string(_cls_type), (_field))
47 #define BT_ASSERT_PRE_DEV_FIELD_IS_UNSIGNED_INT(_field, _name) \
49 ((const struct bt_field *) (_field))->class->type == BT_FIELD_CLASS_TYPE_UNSIGNED_INTEGER || \
50 ((const struct bt_field *) (_field))->class->type == BT_FIELD_CLASS_TYPE_UNSIGNED_ENUMERATION, \
51 _name " is not an unsigned integer field: %![field-]+f", \
54 #define BT_ASSERT_PRE_DEV_FIELD_IS_SIGNED_INT(_field, _name) \
56 ((const struct bt_field *) (_field))->class->type == BT_FIELD_CLASS_TYPE_SIGNED_INTEGER || \
57 ((const struct bt_field *) (_field))->class->type == BT_FIELD_CLASS_TYPE_SIGNED_ENUMERATION, \
58 _name " is not a signed integer field: %![field-]+f", \
61 #define BT_ASSERT_PRE_DEV_FIELD_IS_ARRAY(_field, _name) \
63 ((const struct bt_field *) (_field))->class->type == BT_FIELD_CLASS_TYPE_STATIC_ARRAY || \
64 ((const struct bt_field *) (_field))->class->type == BT_FIELD_CLASS_TYPE_DYNAMIC_ARRAY_WITHOUT_LENGTH_FIELD || \
65 ((const struct bt_field *) (_field))->class->type == BT_FIELD_CLASS_TYPE_DYNAMIC_ARRAY_WITH_LENGTH_FIELD, \
66 _name " is not an array field: %![field-]+f", (_field))
68 #define BT_ASSERT_PRE_DEV_FIELD_IS_DYNAMIC_ARRAY(_field, _name) \
70 ((const struct bt_field *) (_field))->class->type == BT_FIELD_CLASS_TYPE_DYNAMIC_ARRAY_WITHOUT_LENGTH_FIELD || \
71 ((const struct bt_field *) (_field))->class->type == BT_FIELD_CLASS_TYPE_DYNAMIC_ARRAY_WITH_LENGTH_FIELD, \
72 _name " is not a dynamic array field: %![field-]+f", (_field))
74 #define BT_ASSERT_PRE_DEV_FIELD_IS_OPTION(_field, _name) \
76 ((const struct bt_field *) (_field))->class->type == BT_FIELD_CLASS_TYPE_OPTION_WITHOUT_SELECTOR_FIELD || \
77 ((const struct bt_field *) (_field))->class->type == BT_FIELD_CLASS_TYPE_OPTION_WITH_BOOL_SELECTOR_FIELD || \
78 ((const struct bt_field *) (_field))->class->type == BT_FIELD_CLASS_TYPE_OPTION_WITH_UNSIGNED_INTEGER_SELECTOR_FIELD || \
79 ((const struct bt_field *) (_field))->class->type == BT_FIELD_CLASS_TYPE_OPTION_WITH_SIGNED_INTEGER_SELECTOR_FIELD, \
80 _name " is not an option field: %![field-]+f", (_field))
82 #define BT_ASSERT_PRE_DEV_FIELD_IS_VARIANT(_field, _name) \
84 ((const struct bt_field *) (_field))->class->type == BT_FIELD_CLASS_TYPE_VARIANT_WITHOUT_SELECTOR_FIELD || \
85 ((const struct bt_field *) (_field))->class->type == BT_FIELD_CLASS_TYPE_VARIANT_WITH_UNSIGNED_INTEGER_SELECTOR_FIELD || \
86 ((const struct bt_field *) (_field))->class->type == BT_FIELD_CLASS_TYPE_VARIANT_WITH_SIGNED_INTEGER_SELECTOR_FIELD, \
87 _name " is not a variant field: %![field-]+f", (_field))
89 #define BT_ASSERT_PRE_DEV_FIELD_IS_SET(_field, _name) \
90 BT_ASSERT_PRE_DEV(bt_field_is_set(_field), \
91 _name " is not set: %!+f", (_field))
93 #define BT_ASSERT_PRE_DEV_FIELD_HOT(_field, _name) \
94 BT_ASSERT_PRE_DEV_HOT((const struct bt_field *) (_field), (_name), \
99 typedef struct bt_field
*(* bt_field_create_func
)(struct bt_field_class
*);
100 typedef void (*bt_field_method_set_is_frozen
)(struct bt_field
*, bool);
101 typedef bool (*bt_field_method_is_set
)(const struct bt_field
*);
102 typedef void (*bt_field_method_reset
)(struct bt_field
*);
104 struct bt_field_methods
{
105 bt_field_method_set_is_frozen set_is_frozen
;
106 bt_field_method_is_set is_set
;
107 bt_field_method_reset reset
;
111 struct bt_object base
;
114 struct bt_field_class
*class;
116 /* Virtual table for slow path (dev mode) operations */
117 struct bt_field_methods
*methods
;
123 struct bt_field_bool
{
124 struct bt_field common
;
128 struct bt_field_bit_array
{
129 struct bt_field common
;
130 uint64_t value_as_int
;
133 struct bt_field_integer
{
134 struct bt_field common
;
142 struct bt_field_real
{
143 struct bt_field common
;
147 struct bt_field_structure
{
148 struct bt_field common
;
150 /* Array of `struct bt_field *`, owned by this */
154 struct bt_field_option
{
155 struct bt_field common
;
158 struct bt_field
*content_field
;
160 /* Weak: equal to `content_field` above or `NULL` */
161 struct bt_field
*selected_field
;
164 struct bt_field_variant
{
165 struct bt_field common
;
167 /* Weak: belongs to `fields` below */
168 struct bt_field
*selected_field
;
170 /* Index of currently selected field */
171 uint64_t selected_index
;
173 /* Array of `struct bt_field *`, owned by this */
177 struct bt_field_array
{
178 struct bt_field common
;
180 /* Array of `struct bt_field *`, owned by this */
183 /* Current effective length */
187 struct bt_field_string
{
188 struct bt_field common
;
194 # define bt_field_set_is_frozen _bt_field_set_is_frozen
195 # define bt_field_is_set _bt_field_is_set
196 # define bt_field_reset _bt_field_reset
197 # define bt_field_set_single _bt_field_set_single
199 # define bt_field_set_is_frozen(_field, _is_frozen)
200 # define bt_field_is_set(_field) (BT_FALSE)
201 # define bt_field_reset(_field)
202 # define bt_field_set_single(_field, _val)
206 void _bt_field_set_is_frozen(const struct bt_field
*field
, bool is_frozen
);
209 void _bt_field_reset(const struct bt_field
*field
)
212 BT_ASSERT(field
->methods
->reset
);
213 field
->methods
->reset((void *) field
);
217 void _bt_field_set_single(struct bt_field
*field
, bool value
)
220 field
->is_set
= value
;
224 bt_bool
_bt_field_is_set(const struct bt_field
*field
)
226 bt_bool is_set
= BT_FALSE
;
232 BT_ASSERT(field
->methods
->is_set
);
233 is_set
= field
->methods
->is_set(field
);
240 struct bt_field
*bt_field_create(struct bt_field_class
*class);
243 void bt_field_destroy(struct bt_field
*field
);
245 #endif /* BABELTRACE_TRACE_IR_FIELDS_INTERNAL_H */