src/lib/trace-ir/field.h

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