lib, bt2: rename "signed/unsigned sel." -> "integer signed/unsigned sel."
[babeltrace.git] / src / lib / trace-ir / field.h
CommitLineData
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
467673c1
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
02b61fe0
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 || \
0822832b
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, \
02b61fe0
PP
80 _name " is not a variant field: %![field-]+f", (_field))
81
fa6cfec3
PP
82#define BT_ASSERT_PRE_DEV_FIELD_IS_SET(_field, _name) \
83 BT_ASSERT_PRE_DEV(bt_field_is_set(_field), \
18acc6f8 84 _name " is not set: %!+f", (_field))
8deee039 85
fa6cfec3
PP
86#define BT_ASSERT_PRE_DEV_FIELD_HOT(_field, _name) \
87 BT_ASSERT_PRE_DEV_HOT((const struct bt_field *) (_field), (_name), \
7b33a0e0 88 ": %!+f", (_field))
8deee039
PP
89
90struct bt_field;
8deee039 91
939190b3 92typedef struct bt_field *(* bt_field_create_func)(struct bt_field_class *);
7b33a0e0 93typedef void (*bt_field_method_set_is_frozen)(struct bt_field *, bool);
78cf9df6 94typedef bool (*bt_field_method_is_set)(const struct bt_field *);
18acc6f8
PP
95typedef void (*bt_field_method_reset)(struct bt_field *);
96
97struct bt_field_methods {
98 bt_field_method_set_is_frozen set_is_frozen;
18acc6f8
PP
99 bt_field_method_is_set is_set;
100 bt_field_method_reset reset;
8deee039
PP
101};
102
18acc6f8 103struct bt_field {
83509119 104 struct bt_object base;
7b33a0e0
PP
105
106 /* Owned by this */
939190b3 107 struct bt_field_class *class;
7b33a0e0
PP
108
109 /* Virtual table for slow path (dev mode) operations */
18acc6f8 110 struct bt_field_methods *methods;
7b33a0e0
PP
111
112 bool is_set;
a745c331 113 bool frozen;
273b65be
JG
114};
115
9414b439
PP
116struct bt_field_bool {
117 struct bt_field common;
118 bool value;
119};
120
6943da6a
PP
121struct bt_field_bit_array {
122 struct bt_field common;
123 uint64_t value_as_int;
124};
125
18acc6f8
PP
126struct bt_field_integer {
127 struct bt_field common;
273b65be 128
7b33a0e0
PP
129 union {
130 uint64_t u;
131 int64_t i;
132 } value;
18acc6f8
PP
133};
134
7b33a0e0 135struct bt_field_real {
18acc6f8 136 struct bt_field common;
7b33a0e0 137 double value;
273b65be
JG
138};
139
18acc6f8
PP
140struct bt_field_structure {
141 struct bt_field common;
a6918753 142
18acc6f8 143 /* Array of `struct bt_field *`, owned by this */
a6918753 144 GPtrArray *fields;
273b65be
JG
145};
146
247fa9e3
PP
147struct 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
18acc6f8
PP
157struct bt_field_variant {
158 struct bt_field common;
a6918753 159
7b33a0e0
PP
160 /* Weak: belongs to `fields` below */
161 struct bt_field *selected_field;
a6918753 162
7b33a0e0
PP
163 /* Index of currently selected field */
164 uint64_t selected_index;
a6918753 165
18acc6f8 166 /* Array of `struct bt_field *`, owned by this */
a6918753 167 GPtrArray *fields;
273b65be
JG
168};
169
18acc6f8
PP
170struct bt_field_array {
171 struct bt_field common;
a6918753 172
18acc6f8 173 /* Array of `struct bt_field *`, owned by this */
7b33a0e0 174 GPtrArray *fields;
a6918753 175
7b33a0e0 176 /* Current effective length */
a6918753 177 uint64_t length;
273b65be
JG
178};
179
18acc6f8
PP
180struct bt_field_string {
181 struct bt_field common;
e42dd763 182 GArray *buf;
7b33a0e0 183 uint64_t length;
273b65be
JG
184};
185
8b45963b 186#ifdef BT_DEV_MODE
7b33a0e0
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
8b45963b 191#else
7b33a0e0
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)
8b45963b 196#endif
918be005 197
18acc6f8 198BT_HIDDEN
78cf9df6 199void _bt_field_set_is_frozen(const struct bt_field *field, bool is_frozen);
8deee039
PP
200
201static inline
78cf9df6 202void _bt_field_reset(const struct bt_field *field)
8deee039
PP
203{
204 BT_ASSERT(field);
205 BT_ASSERT(field->methods->reset);
78cf9df6 206 field->methods->reset((void *) field);
8deee039
PP
207}
208
209static inline
7b33a0e0 210void _bt_field_set_single(struct bt_field *field, bool value)
8deee039
PP
211{
212 BT_ASSERT(field);
7b33a0e0 213 field->is_set = value;
8deee039
PP
214}
215
216static inline
78cf9df6 217bt_bool _bt_field_is_set(const struct bt_field *field)
8deee039
PP
218{
219 bt_bool is_set = BT_FALSE;
220
221 if (!field) {
222 goto end;
223 }
224
8deee039
PP
225 BT_ASSERT(field->methods->is_set);
226 is_set = field->methods->is_set(field);
227
228end:
229 return is_set;
230}
231
a6918753 232BT_HIDDEN
939190b3 233struct bt_field *bt_field_create(struct bt_field_class *class);
a6918753
PP
234
235BT_HIDDEN
7b33a0e0 236void bt_field_destroy(struct bt_field *field);
a6918753 237
108b91d0 238#endif /* BABELTRACE_TRACE_IR_FIELDS_INTERNAL_H */
This page took 0.079464 seconds and 4 git commands to generate.