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