lib: create_packet_message(): make assertion message less convoluted
[babeltrace.git] / include / babeltrace / trace-ir / field-internal.h
CommitLineData
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
3dca2276
PP
27#include <babeltrace/assert-pre-internal.h>
28#include <babeltrace/common-internal.h>
c6bd8523 29#include <babeltrace/trace-ir/field-class-internal.h>
56e18c4c 30#include <babeltrace/trace-ir/utils-internal.h>
83509119 31#include <babeltrace/object-internal.h>
273b65be 32#include <babeltrace/babeltrace-internal.h>
c55a9f58 33#include <babeltrace/types.h>
dc3fffef 34#include <stdint.h>
4d4b475d 35#include <string.h>
3dca2276 36#include <inttypes.h>
d990a4fb 37#include <stdbool.h>
273b65be
JG
38#include <glib.h>
39
864cad70 40#define BT_ASSERT_PRE_FIELD_HAS_CLASS_TYPE(_field, _cls_type, _name) \
40f4ba76 41 BT_ASSERT_PRE(((const struct bt_field *) (_field))->class->type == (_cls_type), \
864cad70 42 _name " has the wrong class type: expected-class-type=%s, " \
44c440bc 43 "%![field-]+f", \
864cad70 44 bt_common_field_class_type_string(_cls_type), (_field))
44c440bc
PP
45
46#define BT_ASSERT_PRE_FIELD_IS_UNSIGNED_INT(_field, _name) \
47 BT_ASSERT_PRE( \
40f4ba76
PP
48 ((const struct bt_field *) (_field))->class->type == BT_FIELD_CLASS_TYPE_UNSIGNED_INTEGER || \
49 ((const struct bt_field *) (_field))->class->type == BT_FIELD_CLASS_TYPE_UNSIGNED_ENUMERATION, \
44c440bc
PP
50 _name " is not an unsigned integer field: %![field-]+f", \
51 (_field))
52
53#define BT_ASSERT_PRE_FIELD_IS_SIGNED_INT(_field, _name) \
54 BT_ASSERT_PRE( \
40f4ba76
PP
55 ((const struct bt_field *) (_field))->class->type == BT_FIELD_CLASS_TYPE_SIGNED_INTEGER || \
56 ((const struct bt_field *) (_field))->class->type == BT_FIELD_CLASS_TYPE_SIGNED_ENUMERATION, \
44c440bc
PP
57 _name " is not a signed integer field: %![field-]+f", \
58 (_field))
59
60#define BT_ASSERT_PRE_FIELD_IS_ARRAY(_field, _name) \
61 BT_ASSERT_PRE( \
40f4ba76
PP
62 ((const struct bt_field *) (_field))->class->type == BT_FIELD_CLASS_TYPE_STATIC_ARRAY || \
63 ((const struct bt_field *) (_field))->class->type == BT_FIELD_CLASS_TYPE_DYNAMIC_ARRAY, \
44c440bc
PP
64 _name " is not an array field: %![field-]+f", (_field))
65
66#define BT_ASSERT_PRE_FIELD_IS_SET(_field, _name) \
67 BT_ASSERT_PRE(bt_field_is_set(_field), \
cb6f1f7d 68 _name " is not set: %!+f", (_field))
3dca2276 69
44c440bc 70#define BT_ASSERT_PRE_FIELD_HOT(_field, _name) \
40f4ba76 71 BT_ASSERT_PRE_HOT((const struct bt_field *) (_field), (_name), \
44c440bc 72 ": %!+f", (_field))
3dca2276
PP
73
74struct bt_field;
3dca2276 75
5cd6d0e5 76typedef struct bt_field *(* bt_field_create_func)(struct bt_field_class *);
44c440bc 77typedef void (*bt_field_method_set_is_frozen)(struct bt_field *, bool);
40f4ba76 78typedef bool (*bt_field_method_is_set)(const struct bt_field *);
cb6f1f7d
PP
79typedef void (*bt_field_method_reset)(struct bt_field *);
80
81struct bt_field_methods {
82 bt_field_method_set_is_frozen set_is_frozen;
cb6f1f7d
PP
83 bt_field_method_is_set is_set;
84 bt_field_method_reset reset;
3dca2276
PP
85};
86
cb6f1f7d 87struct bt_field {
83509119 88 struct bt_object base;
44c440bc
PP
89
90 /* Owned by this */
5cd6d0e5 91 struct bt_field_class *class;
44c440bc
PP
92
93 /* Virtual table for slow path (dev mode) operations */
cb6f1f7d 94 struct bt_field_methods *methods;
44c440bc
PP
95
96 bool is_set;
d990a4fb 97 bool frozen;
273b65be
JG
98};
99
cb6f1f7d
PP
100struct bt_field_integer {
101 struct bt_field common;
273b65be 102
44c440bc
PP
103 union {
104 uint64_t u;
105 int64_t i;
106 } value;
cb6f1f7d
PP
107};
108
44c440bc 109struct bt_field_real {
cb6f1f7d 110 struct bt_field common;
44c440bc 111 double value;
273b65be
JG
112};
113
cb6f1f7d
PP
114struct bt_field_structure {
115 struct bt_field common;
312c056a 116
cb6f1f7d 117 /* Array of `struct bt_field *`, owned by this */
312c056a 118 GPtrArray *fields;
273b65be
JG
119};
120
cb6f1f7d
PP
121struct bt_field_variant {
122 struct bt_field common;
312c056a 123
44c440bc
PP
124 /* Weak: belongs to `fields` below */
125 struct bt_field *selected_field;
312c056a 126
44c440bc
PP
127 /* Index of currently selected field */
128 uint64_t selected_index;
312c056a 129
cb6f1f7d 130 /* Array of `struct bt_field *`, owned by this */
312c056a 131 GPtrArray *fields;
273b65be
JG
132};
133
cb6f1f7d
PP
134struct bt_field_array {
135 struct bt_field common;
312c056a 136
cb6f1f7d 137 /* Array of `struct bt_field *`, owned by this */
44c440bc 138 GPtrArray *fields;
312c056a 139
44c440bc 140 /* Current effective length */
312c056a 141 uint64_t length;
273b65be
JG
142};
143
cb6f1f7d
PP
144struct bt_field_string {
145 struct bt_field common;
4d4b475d 146 GArray *buf;
44c440bc 147 uint64_t length;
273b65be
JG
148};
149
f6ccaed9 150#ifdef BT_DEV_MODE
44c440bc
PP
151# define bt_field_set_is_frozen _bt_field_set_is_frozen
152# define bt_field_is_set _bt_field_is_set
153# define bt_field_reset _bt_field_reset
154# define bt_field_set_single _bt_field_set_single
f6ccaed9 155#else
44c440bc
PP
156# define bt_field_set_is_frozen(_field, _is_frozen)
157# define bt_field_is_set(_field) (BT_FALSE)
158# define bt_field_reset(_field)
159# define bt_field_set_single(_field, _val)
f6ccaed9 160#endif
918be005 161
cb6f1f7d 162BT_HIDDEN
40f4ba76 163void _bt_field_set_is_frozen(const struct bt_field *field, bool is_frozen);
3dca2276
PP
164
165static inline
40f4ba76 166void _bt_field_reset(const struct bt_field *field)
3dca2276
PP
167{
168 BT_ASSERT(field);
169 BT_ASSERT(field->methods->reset);
40f4ba76 170 field->methods->reset((void *) field);
3dca2276
PP
171}
172
173static inline
44c440bc 174void _bt_field_set_single(struct bt_field *field, bool value)
3dca2276
PP
175{
176 BT_ASSERT(field);
44c440bc 177 field->is_set = value;
3dca2276
PP
178}
179
180static inline
40f4ba76 181bt_bool _bt_field_is_set(const struct bt_field *field)
3dca2276
PP
182{
183 bt_bool is_set = BT_FALSE;
184
185 if (!field) {
186 goto end;
187 }
188
864cad70 189 BT_ASSERT(bt_field_class_has_known_type(field->class));
3dca2276
PP
190 BT_ASSERT(field->methods->is_set);
191 is_set = field->methods->is_set(field);
192
193end:
194 return is_set;
195}
196
312c056a 197BT_HIDDEN
5cd6d0e5 198struct bt_field *bt_field_create(struct bt_field_class *class);
312c056a
PP
199
200BT_HIDDEN
44c440bc 201void bt_field_destroy(struct bt_field *field);
312c056a 202
56e18c4c 203#endif /* BABELTRACE_TRACE_IR_FIELDS_INTERNAL_H */
This page took 0.061879 seconds and 4 git commands to generate.