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/babeltrace.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_FIELD_HAS_CLASS_TYPE(_field, _cls_type, _name)    \
  42         BT_ASSERT_PRE(((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_FIELD_IS_UNSIGNED_INT(_field, _name)              \
  48         BT_ASSERT_PRE(                                                  \
  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_FIELD_IS_SIGNED_INT(_field, _name)                \
  55         BT_ASSERT_PRE(                                                  \
  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_FIELD_IS_ARRAY(_field, _name)                     \
  62         BT_ASSERT_PRE(                                                  \
  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_FIELD_IS_SET(_field, _name)                       \
  68         BT_ASSERT_PRE(bt_field_is_set(_field),                          \
  69                 _name " is not set: %!+f", (_field))
  70
  71 #define BT_ASSERT_PRE_FIELD_HOT(_field, _name)                          \
  72         BT_ASSERT_PRE_HOT((const struct bt_field *) (_field), (_name),  \
  73                 ": %!+f", (_field))
  74
  75 struct bt_field;
  76
  77 typedef struct bt_field *(* bt_field_create_func)(struct bt_field_class *);
  78 typedef void (*bt_field_method_set_is_frozen)(struct bt_field *, bool);
  79 typedef bool (*bt_field_method_is_set)(const struct bt_field *);
  80 typedef void (*bt_field_method_reset)(struct bt_field *);
  81
  82 struct bt_field_methods {
  83         bt_field_method_set_is_frozen set_is_frozen;
  84         bt_field_method_is_set is_set;
  85         bt_field_method_reset reset;
  86 };
  87
  88 struct bt_field {
  89         struct bt_object base;
  90
  91         /* Owned by this */
  92         struct bt_field_class *class;
  93
  94         /* Virtual table for slow path (dev mode) operations */
  95         struct bt_field_methods *methods;
  96
  97         bool is_set;
  98         bool frozen;
  99 };
 100
 101 struct bt_field_integer {
 102         struct bt_field common;
 103
 104         union {
 105                 uint64_t u;
 106                 int64_t i;
 107         } value;
 108 };
 109
 110 struct bt_field_real {
 111         struct bt_field common;
 112         double value;
 113 };
 114
 115 struct bt_field_structure {
 116         struct bt_field common;
 117
 118         /* Array of `struct bt_field *`, owned by this */
 119         GPtrArray *fields;
 120 };
 121
 122 struct bt_field_variant {
 123         struct bt_field common;
 124
 125         /* Weak: belongs to `fields` below */
 126         struct bt_field *selected_field;
 127
 128         /* Index of currently selected field */
 129         uint64_t selected_index;
 130
 131         /* Array of `struct bt_field *`, owned by this */
 132         GPtrArray *fields;
 133 };
 134
 135 struct bt_field_array {
 136         struct bt_field common;
 137
 138         /* Array of `struct bt_field *`, owned by this */
 139         GPtrArray *fields;
 140
 141         /* Current effective length */
 142         uint64_t length;
 143 };
 144
 145 struct bt_field_string {
 146         struct bt_field common;
 147         GArray *buf;
 148         uint64_t length;
 149 };
 150
 151 #ifdef BT_DEV_MODE
 152 # define bt_field_set_is_frozen         _bt_field_set_is_frozen
 153 # define bt_field_is_set                _bt_field_is_set
 154 # define bt_field_reset                 _bt_field_reset
 155 # define bt_field_set_single            _bt_field_set_single
 156 #else
 157 # define bt_field_set_is_frozen(_field, _is_frozen)
 158 # define bt_field_is_set(_field)        (BT_FALSE)
 159 # define bt_field_reset(_field)
 160 # define bt_field_set_single(_field, _val)
 161 #endif
 162
 163 BT_HIDDEN
 164 void _bt_field_set_is_frozen(const struct bt_field *field, bool is_frozen);
 165
 166 static inline
 167 void _bt_field_reset(const struct bt_field *field)
 168 {
 169         BT_ASSERT(field);
 170         BT_ASSERT(field->methods->reset);
 171         field->methods->reset((void *) field);
 172 }
 173
 174 static inline
 175 void _bt_field_set_single(struct bt_field *field, bool value)
 176 {
 177         BT_ASSERT(field);
 178         field->is_set = value;
 179 }
 180
 181 static inline
 182 bt_bool _bt_field_is_set(const struct bt_field *field)
 183 {
 184         bt_bool is_set = BT_FALSE;
 185
 186         if (!field) {
 187                 goto end;
 188         }
 189
 190         BT_ASSERT(bt_field_class_has_known_type(field->class));
 191         BT_ASSERT(field->methods->is_set);
 192         is_set = field->methods->is_set(field);
 193
 194 end:
 195         return is_set;
 196 }
 197
 198 BT_HIDDEN
 199 struct bt_field *bt_field_create(struct bt_field_class *class);
 200
 201 BT_HIDDEN
 202 void bt_field_destroy(struct bt_field *field);
 203
 204 #endif /* BABELTRACE_TRACE_IR_FIELDS_INTERNAL_H */