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