Commit | Line | Data |
---|---|---|
108b91d0 PP |
1 | #ifndef BABELTRACE_TRACE_IR_FIELDS_INTERNAL_H |
2 | #define BABELTRACE_TRACE_IR_FIELDS_INTERNAL_H | |
273b65be JG |
3 | |
4 | /* | |
f2b0325d | 5 | * Copyright 2017-2018 Philippe Proulx <pproulx@efficios.com> |
de9dd397 | 6 | * Copyright 2013, 2014 Jérémie Galarneau <jeremie.galarneau@efficios.com> |
273b65be | 7 | * |
273b65be JG |
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: | |
14 | * | |
15 | * The above copyright notice and this permission notice shall be included in | |
16 | * all copies or substantial portions of the Software. | |
17 | * | |
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 | |
24 | * SOFTWARE. | |
25 | */ | |
26 | ||
57952005 MJ |
27 | #include "lib/assert-pre.h" |
28 | #include "common/common.h" | |
29 | #include "lib/object.h" | |
85e7137b | 30 | #include "common/macros.h" |
71c5da58 | 31 | #include <babeltrace2/types.h> |
dc3fffef | 32 | #include <stdint.h> |
e42dd763 | 33 | #include <string.h> |
8deee039 | 34 | #include <inttypes.h> |
a745c331 | 35 | #include <stdbool.h> |
273b65be JG |
36 | #include <glib.h> |
37 | ||
57952005 MJ |
38 | #include "field-class.h" |
39 | #include "utils.h" | |
40 | ||
fa6cfec3 PP |
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), \ | |
af0c18e3 | 43 | _name " has the wrong class type: expected-class-type=%s, " \ |
7b33a0e0 | 44 | "%![field-]+f", \ |
af0c18e3 | 45 | bt_common_field_class_type_string(_cls_type), (_field)) |
7b33a0e0 | 46 | |
fa6cfec3 PP |
47 | #define BT_ASSERT_PRE_DEV_FIELD_IS_UNSIGNED_INT(_field, _name) \ |
48 | BT_ASSERT_PRE_DEV( \ | |
78cf9df6 PP |
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, \ | |
7b33a0e0 PP |
51 | _name " is not an unsigned integer field: %![field-]+f", \ |
52 | (_field)) | |
53 | ||
fa6cfec3 PP |
54 | #define BT_ASSERT_PRE_DEV_FIELD_IS_SIGNED_INT(_field, _name) \ |
55 | BT_ASSERT_PRE_DEV( \ | |
78cf9df6 PP |
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, \ | |
fa6cfec3 | 58 | _name " is not a signed integer field: %![field-]+f", \ |
7b33a0e0 PP |
59 | (_field)) |
60 | ||
fa6cfec3 PP |
61 | #define BT_ASSERT_PRE_DEV_FIELD_IS_ARRAY(_field, _name) \ |
62 | BT_ASSERT_PRE_DEV( \ | |
78cf9df6 | 63 | ((const struct bt_field *) (_field))->class->type == BT_FIELD_CLASS_TYPE_STATIC_ARRAY || \ |
b8ddb4f0 PP |
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, \ | |
7b33a0e0 PP |
66 | _name " is not an array field: %![field-]+f", (_field)) |
67 | ||
b8ddb4f0 PP |
68 | #define BT_ASSERT_PRE_DEV_FIELD_IS_DYNAMIC_ARRAY(_field, _name) \ |
69 | BT_ASSERT_PRE_DEV( \ | |
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)) | |
73 | ||
467673c1 PP |
74 | #define BT_ASSERT_PRE_DEV_FIELD_IS_OPTION(_field, _name) \ |
75 | BT_ASSERT_PRE_DEV( \ | |
8bc207af PP |
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, \ | |
467673c1 PP |
80 | _name " is not an option field: %![field-]+f", (_field)) |
81 | ||
02b61fe0 PP |
82 | #define BT_ASSERT_PRE_DEV_FIELD_IS_VARIANT(_field, _name) \ |
83 | BT_ASSERT_PRE_DEV( \ | |
8bc207af PP |
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, \ | |
02b61fe0 PP |
87 | _name " is not a variant field: %![field-]+f", (_field)) |
88 | ||
fa6cfec3 PP |
89 | #define BT_ASSERT_PRE_DEV_FIELD_IS_SET(_field, _name) \ |
90 | BT_ASSERT_PRE_DEV(bt_field_is_set(_field), \ | |
18acc6f8 | 91 | _name " is not set: %!+f", (_field)) |
8deee039 | 92 | |
fa6cfec3 PP |
93 | #define BT_ASSERT_PRE_DEV_FIELD_HOT(_field, _name) \ |
94 | BT_ASSERT_PRE_DEV_HOT((const struct bt_field *) (_field), (_name), \ | |
7b33a0e0 | 95 | ": %!+f", (_field)) |
8deee039 PP |
96 | |
97 | struct bt_field; | |
8deee039 | 98 | |
939190b3 | 99 | typedef struct bt_field *(* bt_field_create_func)(struct bt_field_class *); |
7b33a0e0 | 100 | typedef void (*bt_field_method_set_is_frozen)(struct bt_field *, bool); |
78cf9df6 | 101 | typedef bool (*bt_field_method_is_set)(const struct bt_field *); |
18acc6f8 PP |
102 | typedef void (*bt_field_method_reset)(struct bt_field *); |
103 | ||
104 | struct bt_field_methods { | |
105 | bt_field_method_set_is_frozen set_is_frozen; | |
18acc6f8 PP |
106 | bt_field_method_is_set is_set; |
107 | bt_field_method_reset reset; | |
8deee039 PP |
108 | }; |
109 | ||
18acc6f8 | 110 | struct bt_field { |
83509119 | 111 | struct bt_object base; |
7b33a0e0 PP |
112 | |
113 | /* Owned by this */ | |
939190b3 | 114 | struct bt_field_class *class; |
7b33a0e0 PP |
115 | |
116 | /* Virtual table for slow path (dev mode) operations */ | |
18acc6f8 | 117 | struct bt_field_methods *methods; |
7b33a0e0 PP |
118 | |
119 | bool is_set; | |
a745c331 | 120 | bool frozen; |
273b65be JG |
121 | }; |
122 | ||
9414b439 PP |
123 | struct bt_field_bool { |
124 | struct bt_field common; | |
125 | bool value; | |
126 | }; | |
127 | ||
6943da6a PP |
128 | struct bt_field_bit_array { |
129 | struct bt_field common; | |
130 | uint64_t value_as_int; | |
131 | }; | |
132 | ||
18acc6f8 PP |
133 | struct bt_field_integer { |
134 | struct bt_field common; | |
273b65be | 135 | |
7b33a0e0 PP |
136 | union { |
137 | uint64_t u; | |
138 | int64_t i; | |
139 | } value; | |
18acc6f8 PP |
140 | }; |
141 | ||
7b33a0e0 | 142 | struct bt_field_real { |
18acc6f8 | 143 | struct bt_field common; |
7b33a0e0 | 144 | double value; |
273b65be JG |
145 | }; |
146 | ||
18acc6f8 PP |
147 | struct bt_field_structure { |
148 | struct bt_field common; | |
a6918753 | 149 | |
18acc6f8 | 150 | /* Array of `struct bt_field *`, owned by this */ |
a6918753 | 151 | GPtrArray *fields; |
273b65be JG |
152 | }; |
153 | ||
247fa9e3 PP |
154 | struct bt_field_option { |
155 | struct bt_field common; | |
156 | ||
157 | /* Owned by this */ | |
158 | struct bt_field *content_field; | |
159 | ||
160 | /* Weak: equal to `content_field` above or `NULL` */ | |
161 | struct bt_field *selected_field; | |
162 | }; | |
163 | ||
18acc6f8 PP |
164 | struct bt_field_variant { |
165 | struct bt_field common; | |
a6918753 | 166 | |
7b33a0e0 PP |
167 | /* Weak: belongs to `fields` below */ |
168 | struct bt_field *selected_field; | |
a6918753 | 169 | |
7b33a0e0 PP |
170 | /* Index of currently selected field */ |
171 | uint64_t selected_index; | |
a6918753 | 172 | |
18acc6f8 | 173 | /* Array of `struct bt_field *`, owned by this */ |
a6918753 | 174 | GPtrArray *fields; |
273b65be JG |
175 | }; |
176 | ||
18acc6f8 PP |
177 | struct bt_field_array { |
178 | struct bt_field common; | |
a6918753 | 179 | |
18acc6f8 | 180 | /* Array of `struct bt_field *`, owned by this */ |
7b33a0e0 | 181 | GPtrArray *fields; |
a6918753 | 182 | |
7b33a0e0 | 183 | /* Current effective length */ |
a6918753 | 184 | uint64_t length; |
273b65be JG |
185 | }; |
186 | ||
18acc6f8 PP |
187 | struct bt_field_string { |
188 | struct bt_field common; | |
e42dd763 | 189 | GArray *buf; |
7b33a0e0 | 190 | uint64_t length; |
273b65be JG |
191 | }; |
192 | ||
8b45963b | 193 | #ifdef BT_DEV_MODE |
7b33a0e0 PP |
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 | |
8b45963b | 198 | #else |
7b33a0e0 PP |
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) | |
8b45963b | 203 | #endif |
918be005 | 204 | |
18acc6f8 | 205 | BT_HIDDEN |
78cf9df6 | 206 | void _bt_field_set_is_frozen(const struct bt_field *field, bool is_frozen); |
8deee039 PP |
207 | |
208 | static inline | |
78cf9df6 | 209 | void _bt_field_reset(const struct bt_field *field) |
8deee039 | 210 | { |
ec4a3354 PP |
211 | BT_ASSERT_DBG(field); |
212 | BT_ASSERT_DBG(field->methods->reset); | |
78cf9df6 | 213 | field->methods->reset((void *) field); |
8deee039 PP |
214 | } |
215 | ||
216 | static inline | |
7b33a0e0 | 217 | void _bt_field_set_single(struct bt_field *field, bool value) |
8deee039 | 218 | { |
ec4a3354 | 219 | BT_ASSERT_DBG(field); |
7b33a0e0 | 220 | field->is_set = value; |
8deee039 PP |
221 | } |
222 | ||
223 | static inline | |
78cf9df6 | 224 | bt_bool _bt_field_is_set(const struct bt_field *field) |
8deee039 PP |
225 | { |
226 | bt_bool is_set = BT_FALSE; | |
227 | ||
228 | if (!field) { | |
229 | goto end; | |
230 | } | |
231 | ||
ec4a3354 | 232 | BT_ASSERT_DBG(field->methods->is_set); |
8deee039 PP |
233 | is_set = field->methods->is_set(field); |
234 | ||
235 | end: | |
236 | return is_set; | |
237 | } | |
238 | ||
a6918753 | 239 | BT_HIDDEN |
939190b3 | 240 | struct bt_field *bt_field_create(struct bt_field_class *class); |
a6918753 PP |
241 | |
242 | BT_HIDDEN | |
7b33a0e0 | 243 | void bt_field_destroy(struct bt_field *field); |
a6918753 | 244 | |
108b91d0 | 245 | #endif /* BABELTRACE_TRACE_IR_FIELDS_INTERNAL_H */ |