Commit | Line | Data |
---|---|---|
56e18c4c PP |
1 | #ifndef BABELTRACE_TRACE_IR_FIELDS_INTERNAL_H |
2 | #define BABELTRACE_TRACE_IR_FIELDS_INTERNAL_H | |
273b65be JG |
3 | |
4 | /* | |
e2f7325d | 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 | ||
578e048b MJ |
27 | #include "lib/assert-pre.h" |
28 | #include "common/common.h" | |
29 | #include "lib/object.h" | |
91d81473 | 30 | #include "common/macros.h" |
3fadfbc0 | 31 | #include <babeltrace2/types.h> |
dc3fffef | 32 | #include <stdint.h> |
4d4b475d | 33 | #include <string.h> |
3dca2276 | 34 | #include <inttypes.h> |
d990a4fb | 35 | #include <stdbool.h> |
273b65be JG |
36 | #include <glib.h> |
37 | ||
578e048b MJ |
38 | #include "field-class.h" |
39 | #include "utils.h" | |
40 | ||
bdb288b3 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), \ | |
864cad70 | 43 | _name " has the wrong class type: expected-class-type=%s, " \ |
44c440bc | 44 | "%![field-]+f", \ |
864cad70 | 45 | bt_common_field_class_type_string(_cls_type), (_field)) |
44c440bc | 46 | |
bdb288b3 PP |
47 | #define BT_ASSERT_PRE_DEV_FIELD_IS_UNSIGNED_INT(_field, _name) \ |
48 | BT_ASSERT_PRE_DEV( \ | |
40f4ba76 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, \ | |
44c440bc PP |
51 | _name " is not an unsigned integer field: %![field-]+f", \ |
52 | (_field)) | |
53 | ||
bdb288b3 PP |
54 | #define BT_ASSERT_PRE_DEV_FIELD_IS_SIGNED_INT(_field, _name) \ |
55 | BT_ASSERT_PRE_DEV( \ | |
40f4ba76 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, \ | |
bdb288b3 | 58 | _name " is not a signed integer field: %![field-]+f", \ |
44c440bc PP |
59 | (_field)) |
60 | ||
bdb288b3 PP |
61 | #define BT_ASSERT_PRE_DEV_FIELD_IS_ARRAY(_field, _name) \ |
62 | BT_ASSERT_PRE_DEV( \ | |
40f4ba76 PP |
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, \ | |
44c440bc PP |
65 | _name " is not an array field: %![field-]+f", (_field)) |
66 | ||
0aa006b7 PP |
67 | #define BT_ASSERT_PRE_DEV_FIELD_IS_OPTION(_field, _name) \ |
68 | BT_ASSERT_PRE_DEV( \ | |
69 | ((const struct bt_field *) (_field))->class->type == BT_FIELD_CLASS_TYPE_OPTION_WITHOUT_SELECTOR || \ | |
70 | ((const struct bt_field *) (_field))->class->type == BT_FIELD_CLASS_TYPE_OPTION_WITH_BOOL_SELECTOR || \ | |
71 | ((const struct bt_field *) (_field))->class->type == BT_FIELD_CLASS_TYPE_OPTION_WITH_UNSIGNED_INTEGER_SELECTOR || \ | |
72 | ((const struct bt_field *) (_field))->class->type == BT_FIELD_CLASS_TYPE_OPTION_WITH_SIGNED_INTEGER_SELECTOR, \ | |
73 | _name " is not an option field: %![field-]+f", (_field)) | |
74 | ||
45c51519 PP |
75 | #define BT_ASSERT_PRE_DEV_FIELD_IS_VARIANT(_field, _name) \ |
76 | BT_ASSERT_PRE_DEV( \ | |
77 | ((const struct bt_field *) (_field))->class->type == BT_FIELD_CLASS_TYPE_VARIANT_WITHOUT_SELECTOR || \ | |
fabfe034 PP |
78 | ((const struct bt_field *) (_field))->class->type == BT_FIELD_CLASS_TYPE_VARIANT_WITH_UNSIGNED_INTEGER_SELECTOR || \ |
79 | ((const struct bt_field *) (_field))->class->type == BT_FIELD_CLASS_TYPE_VARIANT_WITH_SIGNED_INTEGER_SELECTOR, \ | |
45c51519 PP |
80 | _name " is not a variant field: %![field-]+f", (_field)) |
81 | ||
bdb288b3 PP |
82 | #define BT_ASSERT_PRE_DEV_FIELD_IS_SET(_field, _name) \ |
83 | BT_ASSERT_PRE_DEV(bt_field_is_set(_field), \ | |
cb6f1f7d | 84 | _name " is not set: %!+f", (_field)) |
3dca2276 | 85 | |
bdb288b3 PP |
86 | #define BT_ASSERT_PRE_DEV_FIELD_HOT(_field, _name) \ |
87 | BT_ASSERT_PRE_DEV_HOT((const struct bt_field *) (_field), (_name), \ | |
44c440bc | 88 | ": %!+f", (_field)) |
3dca2276 PP |
89 | |
90 | struct bt_field; | |
3dca2276 | 91 | |
5cd6d0e5 | 92 | typedef struct bt_field *(* bt_field_create_func)(struct bt_field_class *); |
44c440bc | 93 | typedef void (*bt_field_method_set_is_frozen)(struct bt_field *, bool); |
40f4ba76 | 94 | typedef bool (*bt_field_method_is_set)(const struct bt_field *); |
cb6f1f7d PP |
95 | typedef void (*bt_field_method_reset)(struct bt_field *); |
96 | ||
97 | struct bt_field_methods { | |
98 | bt_field_method_set_is_frozen set_is_frozen; | |
cb6f1f7d PP |
99 | bt_field_method_is_set is_set; |
100 | bt_field_method_reset reset; | |
3dca2276 PP |
101 | }; |
102 | ||
cb6f1f7d | 103 | struct bt_field { |
83509119 | 104 | struct bt_object base; |
44c440bc PP |
105 | |
106 | /* Owned by this */ | |
5cd6d0e5 | 107 | struct bt_field_class *class; |
44c440bc PP |
108 | |
109 | /* Virtual table for slow path (dev mode) operations */ | |
cb6f1f7d | 110 | struct bt_field_methods *methods; |
44c440bc PP |
111 | |
112 | bool is_set; | |
d990a4fb | 113 | bool frozen; |
273b65be JG |
114 | }; |
115 | ||
5cebbe7f PP |
116 | struct bt_field_bool { |
117 | struct bt_field common; | |
118 | bool value; | |
119 | }; | |
120 | ||
1094efa4 PP |
121 | struct bt_field_bit_array { |
122 | struct bt_field common; | |
123 | uint64_t value_as_int; | |
124 | }; | |
125 | ||
cb6f1f7d PP |
126 | struct bt_field_integer { |
127 | struct bt_field common; | |
273b65be | 128 | |
44c440bc PP |
129 | union { |
130 | uint64_t u; | |
131 | int64_t i; | |
132 | } value; | |
cb6f1f7d PP |
133 | }; |
134 | ||
44c440bc | 135 | struct bt_field_real { |
cb6f1f7d | 136 | struct bt_field common; |
44c440bc | 137 | double value; |
273b65be JG |
138 | }; |
139 | ||
cb6f1f7d PP |
140 | struct bt_field_structure { |
141 | struct bt_field common; | |
312c056a | 142 | |
cb6f1f7d | 143 | /* Array of `struct bt_field *`, owned by this */ |
312c056a | 144 | GPtrArray *fields; |
273b65be JG |
145 | }; |
146 | ||
b38aea74 PP |
147 | struct bt_field_option { |
148 | struct bt_field common; | |
149 | ||
150 | /* Owned by this */ | |
151 | struct bt_field *content_field; | |
152 | ||
153 | /* Weak: equal to `content_field` above or `NULL` */ | |
154 | struct bt_field *selected_field; | |
155 | }; | |
156 | ||
cb6f1f7d PP |
157 | struct bt_field_variant { |
158 | struct bt_field common; | |
312c056a | 159 | |
44c440bc PP |
160 | /* Weak: belongs to `fields` below */ |
161 | struct bt_field *selected_field; | |
312c056a | 162 | |
44c440bc PP |
163 | /* Index of currently selected field */ |
164 | uint64_t selected_index; | |
312c056a | 165 | |
cb6f1f7d | 166 | /* Array of `struct bt_field *`, owned by this */ |
312c056a | 167 | GPtrArray *fields; |
273b65be JG |
168 | }; |
169 | ||
cb6f1f7d PP |
170 | struct bt_field_array { |
171 | struct bt_field common; | |
312c056a | 172 | |
cb6f1f7d | 173 | /* Array of `struct bt_field *`, owned by this */ |
44c440bc | 174 | GPtrArray *fields; |
312c056a | 175 | |
44c440bc | 176 | /* Current effective length */ |
312c056a | 177 | uint64_t length; |
273b65be JG |
178 | }; |
179 | ||
cb6f1f7d PP |
180 | struct bt_field_string { |
181 | struct bt_field common; | |
4d4b475d | 182 | GArray *buf; |
44c440bc | 183 | uint64_t length; |
273b65be JG |
184 | }; |
185 | ||
f6ccaed9 | 186 | #ifdef BT_DEV_MODE |
44c440bc PP |
187 | # define bt_field_set_is_frozen _bt_field_set_is_frozen |
188 | # define bt_field_is_set _bt_field_is_set | |
189 | # define bt_field_reset _bt_field_reset | |
190 | # define bt_field_set_single _bt_field_set_single | |
f6ccaed9 | 191 | #else |
44c440bc PP |
192 | # define bt_field_set_is_frozen(_field, _is_frozen) |
193 | # define bt_field_is_set(_field) (BT_FALSE) | |
194 | # define bt_field_reset(_field) | |
195 | # define bt_field_set_single(_field, _val) | |
f6ccaed9 | 196 | #endif |
918be005 | 197 | |
cb6f1f7d | 198 | BT_HIDDEN |
40f4ba76 | 199 | void _bt_field_set_is_frozen(const struct bt_field *field, bool is_frozen); |
3dca2276 PP |
200 | |
201 | static inline | |
40f4ba76 | 202 | void _bt_field_reset(const struct bt_field *field) |
3dca2276 PP |
203 | { |
204 | BT_ASSERT(field); | |
205 | BT_ASSERT(field->methods->reset); | |
40f4ba76 | 206 | field->methods->reset((void *) field); |
3dca2276 PP |
207 | } |
208 | ||
209 | static inline | |
44c440bc | 210 | void _bt_field_set_single(struct bt_field *field, bool value) |
3dca2276 PP |
211 | { |
212 | BT_ASSERT(field); | |
44c440bc | 213 | field->is_set = value; |
3dca2276 PP |
214 | } |
215 | ||
216 | static inline | |
40f4ba76 | 217 | bt_bool _bt_field_is_set(const struct bt_field *field) |
3dca2276 PP |
218 | { |
219 | bt_bool is_set = BT_FALSE; | |
220 | ||
221 | if (!field) { | |
222 | goto end; | |
223 | } | |
224 | ||
3dca2276 PP |
225 | BT_ASSERT(field->methods->is_set); |
226 | is_set = field->methods->is_set(field); | |
227 | ||
228 | end: | |
229 | return is_set; | |
230 | } | |
231 | ||
312c056a | 232 | BT_HIDDEN |
5cd6d0e5 | 233 | struct bt_field *bt_field_create(struct bt_field_class *class); |
312c056a PP |
234 | |
235 | BT_HIDDEN | |
44c440bc | 236 | void bt_field_destroy(struct bt_field *field); |
312c056a | 237 | |
56e18c4c | 238 | #endif /* BABELTRACE_TRACE_IR_FIELDS_INTERNAL_H */ |