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 | ||
45c51519 PP |
67 | #define BT_ASSERT_PRE_DEV_FIELD_IS_VARIANT(_field, _name) \ |
68 | BT_ASSERT_PRE_DEV( \ | |
69 | ((const struct bt_field *) (_field))->class->type == BT_FIELD_CLASS_TYPE_VARIANT_WITHOUT_SELECTOR || \ | |
70 | ((const struct bt_field *) (_field))->class->type == BT_FIELD_CLASS_TYPE_VARIANT_WITH_UNSIGNED_SELECTOR || \ | |
71 | ((const struct bt_field *) (_field))->class->type == BT_FIELD_CLASS_TYPE_VARIANT_WITH_SIGNED_SELECTOR, \ | |
72 | _name " is not a variant field: %![field-]+f", (_field)) | |
73 | ||
bdb288b3 PP |
74 | #define BT_ASSERT_PRE_DEV_FIELD_IS_SET(_field, _name) \ |
75 | BT_ASSERT_PRE_DEV(bt_field_is_set(_field), \ | |
cb6f1f7d | 76 | _name " is not set: %!+f", (_field)) |
3dca2276 | 77 | |
bdb288b3 PP |
78 | #define BT_ASSERT_PRE_DEV_FIELD_HOT(_field, _name) \ |
79 | BT_ASSERT_PRE_DEV_HOT((const struct bt_field *) (_field), (_name), \ | |
44c440bc | 80 | ": %!+f", (_field)) |
3dca2276 PP |
81 | |
82 | struct bt_field; | |
3dca2276 | 83 | |
5cd6d0e5 | 84 | typedef struct bt_field *(* bt_field_create_func)(struct bt_field_class *); |
44c440bc | 85 | typedef void (*bt_field_method_set_is_frozen)(struct bt_field *, bool); |
40f4ba76 | 86 | typedef bool (*bt_field_method_is_set)(const struct bt_field *); |
cb6f1f7d PP |
87 | typedef void (*bt_field_method_reset)(struct bt_field *); |
88 | ||
89 | struct bt_field_methods { | |
90 | bt_field_method_set_is_frozen set_is_frozen; | |
cb6f1f7d PP |
91 | bt_field_method_is_set is_set; |
92 | bt_field_method_reset reset; | |
3dca2276 PP |
93 | }; |
94 | ||
cb6f1f7d | 95 | struct bt_field { |
83509119 | 96 | struct bt_object base; |
44c440bc PP |
97 | |
98 | /* Owned by this */ | |
5cd6d0e5 | 99 | struct bt_field_class *class; |
44c440bc PP |
100 | |
101 | /* Virtual table for slow path (dev mode) operations */ | |
cb6f1f7d | 102 | struct bt_field_methods *methods; |
44c440bc PP |
103 | |
104 | bool is_set; | |
d990a4fb | 105 | bool frozen; |
273b65be JG |
106 | }; |
107 | ||
cb6f1f7d PP |
108 | struct bt_field_integer { |
109 | struct bt_field common; | |
273b65be | 110 | |
44c440bc PP |
111 | union { |
112 | uint64_t u; | |
113 | int64_t i; | |
114 | } value; | |
cb6f1f7d PP |
115 | }; |
116 | ||
44c440bc | 117 | struct bt_field_real { |
cb6f1f7d | 118 | struct bt_field common; |
44c440bc | 119 | double value; |
273b65be JG |
120 | }; |
121 | ||
cb6f1f7d PP |
122 | struct bt_field_structure { |
123 | struct bt_field common; | |
312c056a | 124 | |
cb6f1f7d | 125 | /* Array of `struct bt_field *`, owned by this */ |
312c056a | 126 | GPtrArray *fields; |
273b65be JG |
127 | }; |
128 | ||
cb6f1f7d PP |
129 | struct bt_field_variant { |
130 | struct bt_field common; | |
312c056a | 131 | |
44c440bc PP |
132 | /* Weak: belongs to `fields` below */ |
133 | struct bt_field *selected_field; | |
312c056a | 134 | |
44c440bc PP |
135 | /* Index of currently selected field */ |
136 | uint64_t selected_index; | |
312c056a | 137 | |
cb6f1f7d | 138 | /* Array of `struct bt_field *`, owned by this */ |
312c056a | 139 | GPtrArray *fields; |
273b65be JG |
140 | }; |
141 | ||
cb6f1f7d PP |
142 | struct bt_field_array { |
143 | struct bt_field common; | |
312c056a | 144 | |
cb6f1f7d | 145 | /* Array of `struct bt_field *`, owned by this */ |
44c440bc | 146 | GPtrArray *fields; |
312c056a | 147 | |
44c440bc | 148 | /* Current effective length */ |
312c056a | 149 | uint64_t length; |
273b65be JG |
150 | }; |
151 | ||
cb6f1f7d PP |
152 | struct bt_field_string { |
153 | struct bt_field common; | |
4d4b475d | 154 | GArray *buf; |
44c440bc | 155 | uint64_t length; |
273b65be JG |
156 | }; |
157 | ||
f6ccaed9 | 158 | #ifdef BT_DEV_MODE |
44c440bc PP |
159 | # define bt_field_set_is_frozen _bt_field_set_is_frozen |
160 | # define bt_field_is_set _bt_field_is_set | |
161 | # define bt_field_reset _bt_field_reset | |
162 | # define bt_field_set_single _bt_field_set_single | |
f6ccaed9 | 163 | #else |
44c440bc PP |
164 | # define bt_field_set_is_frozen(_field, _is_frozen) |
165 | # define bt_field_is_set(_field) (BT_FALSE) | |
166 | # define bt_field_reset(_field) | |
167 | # define bt_field_set_single(_field, _val) | |
f6ccaed9 | 168 | #endif |
918be005 | 169 | |
cb6f1f7d | 170 | BT_HIDDEN |
40f4ba76 | 171 | void _bt_field_set_is_frozen(const struct bt_field *field, bool is_frozen); |
3dca2276 PP |
172 | |
173 | static inline | |
40f4ba76 | 174 | void _bt_field_reset(const struct bt_field *field) |
3dca2276 PP |
175 | { |
176 | BT_ASSERT(field); | |
177 | BT_ASSERT(field->methods->reset); | |
40f4ba76 | 178 | field->methods->reset((void *) field); |
3dca2276 PP |
179 | } |
180 | ||
181 | static inline | |
44c440bc | 182 | void _bt_field_set_single(struct bt_field *field, bool value) |
3dca2276 PP |
183 | { |
184 | BT_ASSERT(field); | |
44c440bc | 185 | field->is_set = value; |
3dca2276 PP |
186 | } |
187 | ||
188 | static inline | |
40f4ba76 | 189 | bt_bool _bt_field_is_set(const struct bt_field *field) |
3dca2276 PP |
190 | { |
191 | bt_bool is_set = BT_FALSE; | |
192 | ||
193 | if (!field) { | |
194 | goto end; | |
195 | } | |
196 | ||
3dca2276 PP |
197 | BT_ASSERT(field->methods->is_set); |
198 | is_set = field->methods->is_set(field); | |
199 | ||
200 | end: | |
201 | return is_set; | |
202 | } | |
203 | ||
312c056a | 204 | BT_HIDDEN |
5cd6d0e5 | 205 | struct bt_field *bt_field_create(struct bt_field_class *class); |
312c056a PP |
206 | |
207 | BT_HIDDEN | |
44c440bc | 208 | void bt_field_destroy(struct bt_field *field); |
312c056a | 209 | |
56e18c4c | 210 | #endif /* BABELTRACE_TRACE_IR_FIELDS_INTERNAL_H */ |