src/lib/trace-ir/field-class.h

   1 #ifndef BABELTRACE_TRACE_IR_FIELD_CLASSES_INTERNAL_H
   2 #define BABELTRACE_TRACE_IR_FIELD_CLASSES_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 <babeltrace2/trace-ir/clock-class.h>
  29 #include <babeltrace2/trace-ir/field-class.h>
  30 #include "common/macros.h"
  31 #include "common/common.h"
  32 #include "lib/object.h"
  33 #include <babeltrace2/types.h>
  34 #include <stdint.h>
  35 #include <glib.h>
  36
  37 #define _BT_ASSERT_PRE_FC_IS_INT_COND(_fc)                              \
  38         (((const struct bt_field_class *) (_fc))->type == BT_FIELD_CLASS_TYPE_UNSIGNED_INTEGER || \
  39         ((const struct bt_field_class *) (_fc))->type == BT_FIELD_CLASS_TYPE_SIGNED_INTEGER || \
  40         ((const struct bt_field_class *) (_fc))->type == BT_FIELD_CLASS_TYPE_UNSIGNED_ENUMERATION || \
  41         ((const struct bt_field_class *) (_fc))->type == BT_FIELD_CLASS_TYPE_SIGNED_ENUMERATION)
  42
  43 #define _BT_ASSERT_PRE_FC_IS_INT_FMT(_name)                             \
  44         _name " is not an integer field class: %![fc-]+F"
  45
  46 #define _BT_ASSERT_PRE_FC_IS_UNSIGNED_INT_COND(_fc)                     \
  47         (((const struct bt_field_class *) (_fc))->type == BT_FIELD_CLASS_TYPE_UNSIGNED_INTEGER || \
  48         ((const struct bt_field_class *) (_fc))->type == BT_FIELD_CLASS_TYPE_UNSIGNED_ENUMERATION)
  49
  50 #define _BT_ASSERT_PRE_FC_IS_UNSIGNED_INT_FMT(_name)                    \
  51         _name " is not an unsigned integer field class: %![fc-]+F"
  52
  53
  54 #define _BT_ASSERT_PRE_FC_IS_SIGNED_INT_COND(_fc)                       \
  55         (((const struct bt_field_class *) (_fc))->type == BT_FIELD_CLASS_TYPE_SIGNED_INTEGER || \
  56         ((const struct bt_field_class *) (_fc))->type == BT_FIELD_CLASS_TYPE_SIGNED_ENUMERATION)
  57
  58 #define _BT_ASSERT_PRE_FC_IS_SIGNED_INT_FMT(_name)                      \
  59         _name " is not a signed integer field class: %![fc-]+F"
  60
  61 #define _BT_ASSERT_PRE_FC_IS_ENUM_COND(_fc)                             \
  62         (((const struct bt_field_class *) (_fc))->type == BT_FIELD_CLASS_TYPE_UNSIGNED_ENUMERATION || \
  63         ((const struct bt_field_class *) (_fc))->type == BT_FIELD_CLASS_TYPE_SIGNED_ENUMERATION)
  64
  65 #define _BT_ASSERT_PRE_FC_IS_ENUM_FMT(_name)                            \
  66         _name " is not an enumeration field class: %![fc-]+F"
  67
  68 #define _BT_ASSERT_PRE_FC_IS_ARRAY_COND(_fc)                            \
  69         (((const struct bt_field_class *) (_fc))->type == BT_FIELD_CLASS_TYPE_STATIC_ARRAY || \
  70         ((const struct bt_field_class *) (_fc))->type == BT_FIELD_CLASS_TYPE_DYNAMIC_ARRAY)
  71
  72 #define _BT_ASSERT_PRE_FC_IS_ARRAY_FMT(_name)                           \
  73         _name " is not an array field class: %![fc-]+F"
  74
  75 #define _BT_ASSERT_PRE_FC_IS_VARIANT_COND(_fc)                          \
  76         (((const struct bt_field_class *) (_fc))->type == BT_FIELD_CLASS_TYPE_VARIANT_WITHOUT_SELECTOR || \
  77         ((const struct bt_field_class *) (_fc))->type == BT_FIELD_CLASS_TYPE_VARIANT_WITH_UNSIGNED_SELECTOR || \
  78         ((const struct bt_field_class *) (_fc))->type == BT_FIELD_CLASS_TYPE_VARIANT_WITH_SIGNED_SELECTOR)
  79
  80 #define _BT_ASSERT_PRE_FC_IS_VARIANT_FMT(_name)                         \
  81         _name " is not a variant field class: %![fc-]+F"
  82
  83 #define _BT_ASSERT_PRE_FC_IS_VARIANT_WITH_SEL_COND(_fc)                 \
  84         (((const struct bt_field_class *) (_fc))->type == BT_FIELD_CLASS_TYPE_VARIANT_WITH_UNSIGNED_SELECTOR || \
  85         ((const struct bt_field_class *) (_fc))->type == BT_FIELD_CLASS_TYPE_VARIANT_WITH_SIGNED_SELECTOR)
  86
  87 #define _BT_ASSERT_PRE_FC_IS_VARIANT_WITH_SEL_FMT(_name)                \
  88         _name " is not a variant field class with a selector: %![fc-]+F"
  89
  90 #define _BT_ASSERT_PRE_FC_HAS_ID_COND(_fc, _type)                       \
  91         (((const struct bt_field_class *) (_fc))->type == (_type))
  92
  93 #define _BT_ASSERT_PRE_FC_HAS_ID_FMT(_name)                             \
  94         _name " has the wrong type: expected-type=%s, %![fc-]+F"
  95
  96 #define BT_ASSERT_PRE_FC_IS_INT(_fc, _name)                             \
  97         BT_ASSERT_PRE(_BT_ASSERT_PRE_FC_IS_INT_COND(_fc),               \
  98                 _BT_ASSERT_PRE_FC_IS_INT_FMT(_name), (_fc))
  99
 100 #define BT_ASSERT_PRE_FC_IS_UNSIGNED_INT(_fc, _name)                    \
 101         BT_ASSERT_PRE(_BT_ASSERT_PRE_FC_IS_UNSIGNED_INT_COND(_fc),      \
 102                 _BT_ASSERT_PRE_FC_IS_UNSIGNED_INT_FMT(_name), (_fc))
 103
 104 #define BT_ASSERT_PRE_FC_IS_SIGNED_INT(_fc, _name)                      \
 105         BT_ASSERT_PRE(_BT_ASSERT_PRE_FC_IS_SIGNED_INT_COND(_fc),        \
 106                 _BT_ASSERT_PRE_FC_IS_SIGNED_INT_FMT(_name), (_fc))
 107
 108 #define BT_ASSERT_PRE_FC_IS_ENUM(_fc, _name)                            \
 109         BT_ASSERT_PRE(_BT_ASSERT_PRE_FC_IS_ENUM_COND(_fc),              \
 110                 _BT_ASSERT_PRE_FC_IS_ENUM_FMT(_name), (_fc))
 111
 112 #define BT_ASSERT_PRE_FC_IS_ARRAY(_fc, _name)                           \
 113         BT_ASSERT_PRE(_BT_ASSERT_PRE_FC_IS_ARRAY_COND(_fc),             \
 114                 _BT_ASSERT_PRE_FC_IS_ARRAY_FMT(_name), (_fc))
 115
 116 #define BT_ASSERT_PRE_FC_IS_VARIANT(_fc, _name)                         \
 117         BT_ASSERT_PRE(_BT_ASSERT_PRE_FC_IS_VARIANT_COND(_fc),           \
 118                 _BT_ASSERT_PRE_FC_IS_VARIANT_FMT(_name), (_fc))
 119
 120 #define BT_ASSERT_PRE_FC_IS_VARIANT_WITH_SEL(_fc, _name)                \
 121         BT_ASSERT_PRE(_BT_ASSERT_PRE_FC_IS_VARIANT_WITH_SEL_COND(_fc),  \
 122                 _BT_ASSERT_PRE_FC_IS_VARIANT_WITH_SEL_FMT(_name), (_fc))
 123
 124 #define BT_ASSERT_PRE_FC_HAS_ID(_fc, _type, _name)                      \
 125         BT_ASSERT_PRE(_BT_ASSERT_PRE_FC_HAS_ID_COND((_fc), (_type)),    \
 126                 _BT_ASSERT_PRE_FC_HAS_ID_FMT(_name),                    \
 127                 bt_common_field_class_type_string(_type), (_fc))
 128
 129 #define BT_ASSERT_PRE_DEV_FC_IS_INT(_fc, _name)                         \
 130         BT_ASSERT_PRE_DEV(_BT_ASSERT_PRE_FC_IS_INT_COND(_fc),           \
 131                 _BT_ASSERT_PRE_FC_IS_INT_FMT(_name), (_fc))
 132
 133 #define BT_ASSERT_PRE_DEV_FC_IS_UNSIGNED_INT(_fc, _name)                \
 134         BT_ASSERT_PRE_DEV(_BT_ASSERT_PRE_FC_IS_UNSIGNED_INT_COND(_fc),  \
 135                 _BT_ASSERT_PRE_FC_IS_UNSIGNED_INT_FMT(_name), (_fc))
 136
 137 #define BT_ASSERT_PRE_DEV_FC_IS_SIGNED_INT(_fc, _name)                  \
 138         BT_ASSERT_PRE_DEV(_BT_ASSERT_PRE_FC_IS_SIGNED_INT_COND(_fc),    \
 139                 _BT_ASSERT_PRE_FC_IS_SIGNED_INT_FMT(_name), (_fc))
 140
 141 #define BT_ASSERT_PRE_DEV_FC_IS_ENUM(_fc, _name)                        \
 142         BT_ASSERT_PRE_DEV(_BT_ASSERT_PRE_FC_IS_ENUM_COND(_fc),          \
 143                 _BT_ASSERT_PRE_FC_IS_ENUM_FMT(_name), (_fc))
 144
 145 #define BT_ASSERT_PRE_DEV_FC_IS_ARRAY(_fc, _name)                       \
 146         BT_ASSERT_PRE_DEV(_BT_ASSERT_PRE_FC_IS_ARRAY_COND(_fc),         \
 147                 _BT_ASSERT_PRE_FC_IS_ARRAY_FMT(_name), (_fc))
 148
 149 #define BT_ASSERT_PRE_DEV_FC_IS_VARIANT(_fc, _name)                     \
 150         BT_ASSERT_PRE_DEV(_BT_ASSERT_PRE_FC_IS_VARIANT_COND(_fc),       \
 151                 _BT_ASSERT_PRE_FC_IS_VARIANT_FMT(_name), (_fc))
 152
 153 #define BT_ASSERT_PRE_DEV_FC_IS_VARIANT_WITH_SEL(_fc, _name)            \
 154         BT_ASSERT_PRE_DEV(_BT_ASSERT_PRE_FC_IS_VARIANT_WITH_SEL_COND(_fc), \
 155                 _BT_ASSERT_PRE_FC_IS_VARIANT_WITH_SEL_FMT(_name), (_fc))
 156
 157 #define BT_ASSERT_PRE_DEV_FC_HAS_ID(_fc, _type, _name)                  \
 158         BT_ASSERT_PRE_DEV(_BT_ASSERT_PRE_FC_HAS_ID_COND((_fc), (_type)), \
 159                 _BT_ASSERT_PRE_FC_HAS_ID_FMT(_name),                    \
 160                 bt_common_field_class_type_string(_type), (_fc))
 161
 162 #define BT_ASSERT_PRE_DEV_FC_HOT(_fc, _name)                            \
 163         BT_ASSERT_PRE_DEV_HOT((const struct bt_field_class *) (_fc),    \
 164                 (_name), ": %!+F", (_fc))
 165
 166 #define BT_FIELD_CLASS_ENUM_MAPPING_AT_INDEX(_fc, _index)               \
 167         (&g_array_index(((struct bt_field_class_enumeration *) (_fc))->mappings, \
 168                 struct bt_field_class_enumeration_mapping, (_index)))
 169
 170 #define BT_FIELD_CLASS_ENUM_MAPPING_RANGE_AT_INDEX(_mapping, _index)    \
 171         (&g_array_index((_mapping)->ranges,                             \
 172                 struct bt_field_class_enumeration_mapping_range, (_index)))
 173
 174 struct bt_field;
 175 struct bt_field_class;
 176
 177 struct bt_field_class {
 178         struct bt_object base;
 179         enum bt_field_class_type type;
 180         bool frozen;
 181
 182         /* Owned by this */
 183         struct bt_value *user_attributes;
 184
 185         /*
 186          * This flag indicates whether or not this field class is part
 187          * of a trace class.
 188          */
 189         bool part_of_trace_class;
 190 };
 191
 192 struct bt_field_class_bool {
 193         struct bt_field_class common;
 194 };
 195
 196 struct bt_field_class_bit_array {
 197         struct bt_field_class common;
 198         uint64_t length;
 199 };
 200
 201 struct bt_field_class_integer {
 202         struct bt_field_class common;
 203
 204         /*
 205          * Value range of fields built from this integer field class:
 206          * this is an equivalent integer size in bits. More formally,
 207          * `range` is `n` in:
 208          *
 209          * Unsigned range: [0, 2^n - 1]
 210          * Signed range: [-2^(n - 1), 2^(n - 1) - 1]
 211          */
 212         uint64_t range;
 213
 214         enum bt_field_class_integer_preferred_display_base base;
 215 };
 216
 217 struct bt_field_class_enumeration_mapping {
 218         GString *label;
 219
 220         /* Owner by this */
 221         const struct bt_integer_range_set *range_set;
 222 };
 223
 224 struct bt_field_class_enumeration_unsigned_mapping;
 225 struct bt_field_class_enumeration_signed_mapping;
 226
 227 struct bt_field_class_enumeration {
 228         struct bt_field_class_integer common;
 229
 230         /* Array of `struct bt_field_class_enumeration_mapping *` */
 231         GArray *mappings;
 232
 233         /*
 234          * This is an array of `const char *` which acts as a temporary
 235          * (potentially growing) buffer for
 236          * bt_field_class_enumeration_unsigned_get_mapping_labels_for_value()
 237          * and
 238          * bt_field_class_enumeration_signed_get_mapping_labels_for_value().
 239          *
 240          * The actual strings are owned by the mappings above.
 241          */
 242         GPtrArray *label_buf;
 243 };
 244
 245 struct bt_field_class_real {
 246         struct bt_field_class common;
 247 };
 248
 249 struct bt_field_class_string {
 250         struct bt_field_class common;
 251 };
 252
 253 /* A named field class is a (name, field class) pair */
 254 struct bt_named_field_class {
 255         GString *name;
 256
 257         /* Owned by this */
 258         struct bt_value *user_attributes;
 259
 260         /* Owned by this */
 261         struct bt_field_class *fc;
 262
 263         bool frozen;
 264 };
 265
 266 struct bt_field_class_structure_member;
 267 struct bt_field_class_variant_option;
 268 struct bt_field_class_variant_with_selector_unsigned_option;
 269 struct bt_field_class_variant_with_selector_signed_option;
 270
 271 struct bt_field_class_named_field_class_container {
 272         struct bt_field_class common;
 273
 274         /*
 275          * Key: `const char *`, not owned by this (owned by named field
 276          * class objects contained in `named_fcs` below).
 277          */
 278         GHashTable *name_to_index;
 279
 280         /* Array of `struct bt_named_field_class *` */
 281         GPtrArray *named_fcs;
 282 };
 283
 284 struct bt_field_class_structure {
 285         struct bt_field_class_named_field_class_container common;
 286 };
 287
 288 struct bt_field_class_array {
 289         struct bt_field_class common;
 290
 291         /* Owned by this */
 292         struct bt_field_class *element_fc;
 293 };
 294
 295 struct bt_field_class_array_static {
 296         struct bt_field_class_array common;
 297         uint64_t length;
 298 };
 299
 300 struct bt_field_class_array_dynamic {
 301         struct bt_field_class_array common;
 302
 303         /* Owned by this */
 304         struct bt_field_class *length_fc;
 305
 306         /* Owned by this */
 307         struct bt_field_path *length_field_path;
 308 };
 309
 310 struct bt_field_class_option {
 311         struct bt_field_class common;
 312
 313         /* Owned by this */
 314         struct bt_field_class *content_fc;
 315
 316         /* Owned by this */
 317         struct bt_field_class *selector_fc;
 318
 319         /* Owned by this */
 320         struct bt_field_path *selector_field_path;
 321 };
 322
 323 /* Variant FC (with selector) option: named field class + range set */
 324 struct bt_field_class_variant_with_selector_option {
 325         struct bt_named_field_class common;
 326
 327         /* Owned by this */
 328         const struct bt_integer_range_set *range_set;
 329 };
 330
 331 struct bt_field_class_variant {
 332         /*
 333          * Depending on the variant field class type, the contained
 334          * named field classes are of type
 335          * `struct bt_named_field_class *` if the variant field class
 336          * doesn't have a selector, or
 337          * `struct bt_field_class_variant_with_selector_option *`
 338          * if it has.
 339          */
 340         struct bt_field_class_named_field_class_container common;
 341 };
 342
 343 struct bt_field_class_variant_with_selector {
 344         struct bt_field_class_variant common;
 345
 346         /*
 347          * Owned by this, but never dereferenced: only use to find it
 348          * elsewhere.
 349          */
 350         const struct bt_field_class *selector_fc;
 351
 352         /* Owned by this */
 353         struct bt_field_path *selector_field_path;
 354 };
 355
 356 BT_HIDDEN
 357 void _bt_field_class_freeze(const struct bt_field_class *field_class);
 358
 359 #ifdef BT_DEV_MODE
 360 # define bt_field_class_freeze          _bt_field_class_freeze
 361 #else
 362 # define bt_field_class_freeze(_fc)     ((void) _fc)
 363 #endif
 364
 365 BT_HIDDEN
 366 void _bt_named_field_class_freeze(const struct bt_named_field_class *named_fc);
 367
 368 #ifdef BT_DEV_MODE
 369 # define bt_named_field_class_freeze            _bt_named_field_class_freeze
 370 #else
 371 # define bt_named_field_class_freeze(_named_fc) ((void) _named_fc)
 372 #endif
 373
 374 /*
 375  * This function recursively marks `field_class` and its children as
 376  * being part of a trace. This is used to validate that all field classes
 377  * are used at a single location within trace objects even if they are
 378  * shared objects for other purposes.
 379  */
 380 BT_HIDDEN
 381 void bt_field_class_make_part_of_trace_class(
 382                 const struct bt_field_class *field_class);
 383
 384 #endif /* BABELTRACE_TRACE_IR_FIELD_CLASSES_INTERNAL_H */