1 #ifndef BABELTRACE_TRACE_IR_FIELDS_INTERNAL_H
2 #define BABELTRACE_TRACE_IR_FIELDS_INTERNAL_H
5 * Copyright 2013, 2014 Jérémie Galarneau <jeremie.galarneau@efficios.com>
7 * Author: Jérémie Galarneau <jeremie.galarneau@efficios.com>
9 * Permission is hereby granted, free of charge, to any person obtaining a copy
10 * of this software and associated documentation files (the "Software"), to deal
11 * in the Software without restriction, including without limitation the rights
12 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
13 * copies of the Software, and to permit persons to whom the Software is
14 * furnished to do so, subject to the following conditions:
16 * The above copyright notice and this permission notice shall be included in
17 * all copies or substantial portions of the Software.
19 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
20 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
21 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
22 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
23 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
24 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
28 #include <babeltrace/assert-pre-internal.h>
29 #include <babeltrace/common-internal.h>
30 #include <babeltrace/trace-ir/field-classes-internal.h>
31 #include <babeltrace/trace-ir/utils-internal.h>
32 #include <babeltrace/object-internal.h>
33 #include <babeltrace/babeltrace-internal.h>
34 #include <babeltrace/types.h>
41 #define BT_ASSERT_PRE_FIELD_HAS_CLASS_TYPE(_field, _cls_type, _name) \
42 BT_ASSERT_PRE(((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_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_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_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, \
65 _name " is not an array field: %![field-]+f", (_field))
67 #define BT_ASSERT_PRE_FIELD_IS_SET(_field, _name) \
68 BT_ASSERT_PRE(bt_field_is_set(_field), \
69 _name " is not set: %!+f", (_field))
71 #define BT_ASSERT_PRE_FIELD_HOT(_field, _name) \
72 BT_ASSERT_PRE_HOT((const struct bt_field *) (_field), (_name), \
77 typedef struct bt_field
*(* bt_field_create_func
)(struct bt_field_class
*);
78 typedef void (*bt_field_method_set_is_frozen
)(struct bt_field
*, bool);
79 typedef bool (*bt_field_method_is_set
)(const struct bt_field
*);
80 typedef void (*bt_field_method_reset
)(struct bt_field
*);
82 struct bt_field_methods
{
83 bt_field_method_set_is_frozen set_is_frozen
;
84 bt_field_method_is_set is_set
;
85 bt_field_method_reset reset
;
89 struct bt_object base
;
92 struct bt_field_class
*class;
94 /* Virtual table for slow path (dev mode) operations */
95 struct bt_field_methods
*methods
;
101 struct bt_field_integer
{
102 struct bt_field common
;
110 struct bt_field_real
{
111 struct bt_field common
;
115 struct bt_field_structure
{
116 struct bt_field common
;
118 /* Array of `struct bt_field *`, owned by this */
122 struct bt_field_variant
{
123 struct bt_field common
;
125 /* Weak: belongs to `fields` below */
126 struct bt_field
*selected_field
;
128 /* Index of currently selected field */
129 uint64_t selected_index
;
131 /* Array of `struct bt_field *`, owned by this */
135 struct bt_field_array
{
136 struct bt_field common
;
138 /* Array of `struct bt_field *`, owned by this */
141 /* Current effective length */
145 struct bt_field_string
{
146 struct bt_field common
;
152 # define bt_field_set_is_frozen _bt_field_set_is_frozen
153 # define bt_field_is_set _bt_field_is_set
154 # define bt_field_reset _bt_field_reset
155 # define bt_field_set_single _bt_field_set_single
157 # define bt_field_set_is_frozen(_field, _is_frozen)
158 # define bt_field_is_set(_field) (BT_FALSE)
159 # define bt_field_reset(_field)
160 # define bt_field_set_single(_field, _val)
164 void _bt_field_set_is_frozen(const struct bt_field
*field
, bool is_frozen
);
167 void _bt_field_reset(const struct bt_field
*field
)
170 BT_ASSERT(field
->methods
->reset
);
171 field
->methods
->reset((void *) field
);
175 void _bt_field_set_single(struct bt_field
*field
, bool value
)
178 field
->is_set
= value
;
182 bt_bool
_bt_field_is_set(const struct bt_field
*field
)
184 bt_bool is_set
= BT_FALSE
;
190 BT_ASSERT(bt_field_class_has_known_type(field
->class));
191 BT_ASSERT(field
->methods
->is_set
);
192 is_set
= field
->methods
->is_set(field
);
199 struct bt_field
*bt_field_create(struct bt_field_class
*class);
202 void bt_field_destroy(struct bt_field
*field
);
204 #endif /* BABELTRACE_TRACE_IR_FIELDS_INTERNAL_H */