include/babeltrace/ctf-ir/field-types-internal.h

   1 #ifndef BABELTRACE_CTF_IR_FIELD_TYPES_INTERNAL_H
   2 #define BABELTRACE_CTF_IR_FIELD_TYPES_INTERNAL_H
   3
   4 /*
   5  * BabelTrace - CTF IR: Event field types internal
   6  *
   7  * Copyright 2013, 2014 Jérémie Galarneau <jeremie.galarneau@efficios.com>
   8  *
   9  * Author: Jérémie Galarneau <jeremie.galarneau@efficios.com>
  10  *
  11  * Permission is hereby granted, free of charge, to any person obtaining a copy
  12  * of this software and associated documentation files (the "Software"), to deal
  13  * in the Software without restriction, including without limitation the rights
  14  * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
  15  * copies of the Software, and to permit persons to whom the Software is
  16  * furnished to do so, subject to the following conditions:
  17  *
  18  * The above copyright notice and this permission notice shall be included in
  19  * all copies or substantial portions of the Software.
  20  *
  21  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  22  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  23  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
  24  * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  25  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
  26  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
  27  * SOFTWARE.
  28  */
  29
  30 #include <babeltrace/assert-pre-internal.h>
  31 #include <babeltrace/ctf-ir/clock-class.h>
  32 #include <babeltrace/ctf-ir/field-types.h>
  33 #include <babeltrace/babeltrace-internal.h>
  34 #include <babeltrace/object-internal.h>
  35 #include <babeltrace/types.h>
  36 #include <stdint.h>
  37 #include <glib.h>
  38
  39 #define BT_ASSERT_PRE_FT_COMMON_HAS_ID(_ft, _type_id, _name)            \
  40         BT_ASSERT_PRE(((struct bt_field_type_common *) (_ft))->id == (_type_id), \
  41                 _name " has the wrong type ID: expected-type-id=%s, "   \
  42                 "%![ft-]+_F", bt_common_field_type_id_string(_type_id), (_ft))
  43
  44 #define BT_ASSERT_PRE_FT_HOT(_ft, _name)                                \
  45         BT_ASSERT_PRE_HOT((_ft), (_name), ": +%!+_F", (_ft))
  46
  47 #define BT_FIELD_TYPE_COMMON_STRUCTURE_FIELD_AT_INDEX(_ft, _index)      \
  48         (&g_array_index(((struct bt_field_type_common_structure *) (_ft))->fields, \
  49                 struct bt_field_type_common_structure_field, (_index)))
  50
  51 #define BT_FIELD_TYPE_COMMON_VARIANT_CHOICE_AT_INDEX(_ft, _index)       \
  52         (&g_array_index(((struct bt_field_type_common_variant *) (_ft))->choices, \
  53                 struct bt_field_type_common_variant_choice, (_index)))
  54
  55 struct bt_field_common;
  56 struct bt_field_type_common;
  57 struct bt_field_type;
  58
  59 typedef void (*bt_field_type_common_method_freeze)(
  60                 struct bt_field_type_common *);
  61 typedef int (*bt_field_type_common_method_validate)(
  62                 struct bt_field_type_common *);
  63 typedef void (*bt_field_type_common_method_set_byte_order)(
  64                 struct bt_field_type_common *, enum bt_byte_order);
  65 typedef struct bt_field_type_common *(*bt_field_type_common_method_copy)(
  66                 struct bt_field_type_common *);
  67 typedef int (*bt_field_type_common_method_compare)(
  68                 struct bt_field_type_common *,
  69                 struct bt_field_type_common *);
  70
  71 struct bt_field_type_common_methods {
  72         bt_field_type_common_method_freeze freeze;
  73         bt_field_type_common_method_validate validate;
  74         bt_field_type_common_method_set_byte_order set_byte_order;
  75         bt_field_type_common_method_copy copy;
  76         bt_field_type_common_method_compare compare;
  77 };
  78
  79 struct bt_field_type_common {
  80         struct bt_object base;
  81         enum bt_field_type_id id;
  82         unsigned int alignment;
  83
  84         /* Virtual table */
  85         struct bt_field_type_common_methods *methods;
  86
  87         /*
  88          * A type can't be modified once it is added to an event or after a
  89          * a field has been instanciated from it.
  90          */
  91         int frozen;
  92
  93         /*
  94          * This flag indicates if the field type is valid. A valid
  95          * field type is _always_ frozen. All the nested field types of
  96          * a valid field type are also valid (and thus frozen).
  97          */
  98         int valid;
  99
 100         /*
 101          * Specialized data for either CTF IR or CTF writer APIs.
 102          * Having this here ensures that:
 103          *
 104          * * The type-specific common data is always found at the same
 105          *   offset when the common API has a `struct
 106          *   bt_field_type_common *` so that you can cast it to `struct
 107          *   bt_field_type_common_integer *` for example and access the
 108          *   common integer field type fields.
 109          *
 110          * * The specific CTF IR and CTF writer APIs can access their
 111          *   specific field type fields in this union at an offset known
 112          *   at build time. This avoids a pointer to specific data so
 113          *   that all the fields, common or specific, of a CTF IR
 114          *   integer field type or of a CTF writer integer field type,
 115          *   for example, are contained within the same contiguous block
 116          *   of memory.
 117          */
 118         union {
 119                 struct {
 120                 } ir;
 121                 struct {
 122                         void *serialize_func;
 123                 } writer;
 124         } spec;
 125 };
 126
 127 struct bt_field_type_common_integer {
 128         struct bt_field_type_common common;
 129
 130         /* Owned by this */
 131         struct bt_clock_class *mapped_clock_class;
 132
 133         enum bt_byte_order user_byte_order;
 134         bt_bool is_signed;
 135         unsigned int size;
 136         enum bt_integer_base base;
 137         enum bt_string_encoding encoding;
 138 };
 139
 140 struct enumeration_mapping {
 141         union {
 142                 uint64_t _unsigned;
 143                 int64_t _signed;
 144         } range_start;
 145         union {
 146                 uint64_t _unsigned;
 147                 int64_t _signed;
 148         } range_end;
 149         GQuark string;
 150 };
 151
 152 struct bt_field_type_common_enumeration {
 153         struct bt_field_type_common common;
 154
 155         /* Owned by this */
 156         struct bt_field_type_common_integer *container_ft;
 157
 158         /* Array of `struct enumeration_mapping *`, owned by this */
 159         GPtrArray *entries;
 160
 161         /* Only set during validation */
 162         bt_bool has_overlapping_ranges;
 163 };
 164
 165 enum bt_field_type_enumeration_mapping_iterator_type {
 166         ITERATOR_BY_NAME,
 167         ITERATOR_BY_SIGNED_VALUE,
 168         ITERATOR_BY_UNSIGNED_VALUE,
 169 };
 170
 171 struct bt_field_type_enumeration_mapping_iterator {
 172         struct bt_object base;
 173
 174         /* Owned by this */
 175         struct bt_field_type_common_enumeration *enumeration_ft;
 176
 177         enum bt_field_type_enumeration_mapping_iterator_type type;
 178         int index;
 179         union {
 180                 GQuark name_quark;
 181                 int64_t signed_value;
 182                 uint64_t unsigned_value;
 183         } u;
 184 };
 185
 186 struct bt_field_type_common_floating_point {
 187         struct bt_field_type_common common;
 188         enum bt_byte_order user_byte_order;
 189         unsigned int exp_dig;
 190         unsigned int mant_dig;
 191 };
 192
 193 struct bt_field_type_common_structure_field {
 194         GQuark name;
 195
 196         /* Owned by this */
 197         struct bt_field_type_common *type;
 198 };
 199
 200 struct bt_field_type_common_structure {
 201         struct bt_field_type_common common;
 202         GHashTable *field_name_to_index;
 203
 204         /*
 205          * Array of `struct bt_field_type_common_structure_field`,
 206          * owned by this
 207          */
 208         GArray *fields;
 209 };
 210
 211 struct bt_field_type_common_variant_choice_range {
 212         union {
 213                 int64_t i;
 214                 uint64_t u;
 215         } lower;
 216         union {
 217                 int64_t i;
 218                 uint64_t u;
 219         } upper;
 220 };
 221
 222 struct bt_field_type_common_variant_choice {
 223         GQuark name;
 224
 225         /* Owned by this */
 226         struct bt_field_type_common *type;
 227
 228         /* Array of `struct bt_field_type_common_variant_choice_range` */
 229         GArray *ranges;
 230 };
 231
 232 struct bt_field_type_common_variant {
 233         struct bt_field_type_common common;
 234         GString *tag_name;
 235         bool choices_up_to_date;
 236
 237         /* Owned by this */
 238         struct bt_field_type_common_enumeration *tag_ft;
 239
 240         /* Owned by this */
 241         struct bt_field_path *tag_field_path;
 242
 243         GHashTable *choice_name_to_index;
 244
 245         /*
 246          * Array of `struct bt_field_type_common_variant_choice`,
 247          * owned by this */
 248         GArray *choices;
 249 };
 250
 251 struct bt_field_type_common_array {
 252         struct bt_field_type_common common;
 253
 254         /* Owned by this */
 255         struct bt_field_type_common *element_ft;
 256
 257         unsigned int length;
 258 };
 259
 260 struct bt_field_type_common_sequence {
 261         struct bt_field_type_common common;
 262
 263         /* Owned by this */
 264         struct bt_field_type_common *element_ft;
 265
 266         GString *length_field_name;
 267
 268         /* Owned by this */
 269         struct bt_field_path *length_field_path;
 270 };
 271
 272 struct bt_field_type_common_string {
 273         struct bt_field_type_common common;
 274         enum bt_string_encoding encoding;
 275 };
 276
 277 #ifdef BT_DEV_MODE
 278 # define bt_field_type_freeze           _bt_field_type_freeze
 279 # define bt_field_type_common_freeze    _bt_field_type_common_freeze
 280 #else
 281 # define bt_field_type_freeze(_ft)
 282 # define bt_field_type_common_freeze(_ft)
 283 #endif
 284
 285 typedef struct bt_field_common *(* bt_field_common_create_func)(
 286                 struct bt_field_type_common *);
 287
 288 BT_HIDDEN
 289 void bt_field_type_common_initialize(struct bt_field_type_common *ft,
 290                 bool init_bo, bt_object_release_func release_func,
 291                 struct bt_field_type_common_methods *methods);
 292
 293 BT_HIDDEN
 294 void bt_field_type_common_integer_initialize(
 295                 struct bt_field_type_common *ft,
 296                 unsigned int size, bt_object_release_func release_func,
 297                 struct bt_field_type_common_methods *methods);
 298
 299 BT_HIDDEN
 300 void bt_field_type_common_floating_point_initialize(
 301                 struct bt_field_type_common *ft,
 302                 bt_object_release_func release_func,
 303                 struct bt_field_type_common_methods *methods);
 304
 305 BT_HIDDEN
 306 void bt_field_type_common_enumeration_initialize(
 307                 struct bt_field_type_common *ft,
 308                 struct bt_field_type_common *container_ft,
 309                 bt_object_release_func release_func,
 310                 struct bt_field_type_common_methods *methods);
 311
 312 BT_HIDDEN
 313 void bt_field_type_common_string_initialize(
 314                 struct bt_field_type_common *ft,
 315                 bt_object_release_func release_func,
 316                 struct bt_field_type_common_methods *methods);
 317
 318 BT_HIDDEN
 319 void bt_field_type_common_structure_initialize(
 320                 struct bt_field_type_common *ft,
 321                 bt_object_release_func release_func,
 322                 struct bt_field_type_common_methods *methods);
 323
 324 BT_HIDDEN
 325 void bt_field_type_common_array_initialize(
 326                 struct bt_field_type_common *ft,
 327                 struct bt_field_type_common *element_ft,
 328                 unsigned int length, bt_object_release_func release_func,
 329                 struct bt_field_type_common_methods *methods);
 330
 331 BT_HIDDEN
 332 void bt_field_type_common_sequence_initialize(
 333                 struct bt_field_type_common *ft,
 334                 struct bt_field_type_common *element_ft,
 335                 const char *length_field_name,
 336                 bt_object_release_func release_func,
 337                 struct bt_field_type_common_methods *methods);
 338
 339 BT_HIDDEN
 340 void bt_field_type_common_variant_initialize(
 341                 struct bt_field_type_common *ft,
 342                 struct bt_field_type_common *tag_ft,
 343                 const char *tag_name,
 344                 bt_object_release_func release_func,
 345                 struct bt_field_type_common_methods *methods);
 346
 347 BT_HIDDEN
 348 void bt_field_type_common_integer_destroy(struct bt_object *obj);
 349
 350 BT_HIDDEN
 351 void bt_field_type_common_floating_point_destroy(struct bt_object *obj);
 352
 353 BT_HIDDEN
 354 void bt_field_type_common_enumeration_destroy_recursive(struct bt_object *obj);
 355
 356 BT_HIDDEN
 357 void bt_field_type_common_string_destroy(struct bt_object *obj);
 358
 359 BT_HIDDEN
 360 void bt_field_type_common_structure_destroy_recursive(struct bt_object *obj);
 361
 362 BT_HIDDEN
 363 void bt_field_type_common_array_destroy_recursive(struct bt_object *obj);
 364
 365 BT_HIDDEN
 366 void bt_field_type_common_sequence_destroy_recursive(struct bt_object *obj);
 367
 368 BT_HIDDEN
 369 void bt_field_type_common_variant_destroy_recursive(struct bt_object *obj);
 370
 371 BT_HIDDEN
 372 int bt_field_type_common_integer_validate(struct bt_field_type_common *ft);
 373
 374 BT_HIDDEN
 375 int bt_field_type_common_enumeration_validate_recursive(
 376                 struct bt_field_type_common *ft);
 377
 378 BT_HIDDEN
 379 int bt_field_type_common_sequence_validate_recursive(
 380                 struct bt_field_type_common *ft);
 381
 382 BT_HIDDEN
 383 int bt_field_type_common_array_validate_recursive(
 384                 struct bt_field_type_common *ft);
 385
 386 BT_HIDDEN
 387 int bt_field_type_common_structure_validate_recursive(
 388                 struct bt_field_type_common *ft);
 389
 390 BT_HIDDEN
 391 int bt_field_type_common_variant_validate_recursive(
 392                 struct bt_field_type_common *type);
 393
 394 BT_HIDDEN
 395 int bt_field_type_common_validate(struct bt_field_type_common *ft);
 396
 397 BT_HIDDEN
 398 int bt_field_type_common_integer_get_size(struct bt_field_type_common *ft);
 399
 400 BT_HIDDEN
 401 bt_bool bt_field_type_common_integer_is_signed(struct bt_field_type_common *ft);
 402
 403 BT_HIDDEN
 404 int bt_field_type_common_integer_set_is_signed(struct bt_field_type_common *ft,
 405                 bt_bool is_signed);
 406
 407 BT_HIDDEN
 408 int bt_field_type_common_integer_set_size(struct bt_field_type_common *ft,
 409                 unsigned int size);
 410
 411 BT_HIDDEN
 412 enum bt_integer_base bt_field_type_common_integer_get_base(
 413                 struct bt_field_type_common *ft);
 414
 415 BT_HIDDEN
 416 int bt_field_type_common_integer_set_base(struct bt_field_type_common *ft,
 417                 enum bt_integer_base base);
 418
 419 BT_HIDDEN
 420 enum bt_string_encoding bt_field_type_common_integer_get_encoding(
 421                 struct bt_field_type_common *ft);
 422
 423 BT_HIDDEN
 424 int bt_field_type_common_integer_set_encoding(struct bt_field_type_common *ft,
 425                 enum bt_string_encoding encoding);
 426
 427 BT_HIDDEN
 428 struct bt_clock_class *bt_field_type_common_integer_borrow_mapped_clock_class(
 429                 struct bt_field_type_common *ft);
 430
 431 BT_HIDDEN
 432 int bt_field_type_common_integer_set_mapped_clock_class_no_check_frozen(
 433                 struct bt_field_type_common *ft,
 434                 struct bt_clock_class *clock_class);
 435
 436 BT_HIDDEN
 437 int bt_field_type_common_integer_set_mapped_clock_class(
 438                 struct bt_field_type_common *ft,
 439                 struct bt_clock_class *clock_class);
 440
 441 BT_HIDDEN
 442 struct bt_field_type_enumeration_mapping_iterator *
 443 bt_field_type_common_enumeration_find_mappings_by_name(
 444                 struct bt_field_type_common *ft, const char *name);
 445
 446 BT_HIDDEN
 447 struct bt_field_type_enumeration_mapping_iterator *
 448 bt_field_type_common_enumeration_signed_find_mappings_by_value(
 449                 struct bt_field_type_common *ft, int64_t value);
 450
 451 BT_HIDDEN
 452 struct bt_field_type_enumeration_mapping_iterator *
 453 bt_field_type_common_enumeration_unsigned_find_mappings_by_value(
 454                 struct bt_field_type_common *ft, uint64_t value);
 455
 456 BT_HIDDEN
 457 int bt_field_type_common_enumeration_signed_get_mapping_by_index(
 458                 struct bt_field_type_common *ft, uint64_t index,
 459                 const char **mapping_name, int64_t *range_begin,
 460                 int64_t *range_end);
 461
 462 BT_HIDDEN
 463 int bt_field_type_common_enumeration_unsigned_get_mapping_by_index(
 464                 struct bt_field_type_common *ft, uint64_t index,
 465                 const char **mapping_name, uint64_t *range_begin,
 466                 uint64_t *range_end);
 467
 468 BT_HIDDEN
 469 struct bt_field_type_common *
 470 bt_field_type_common_enumeration_borrow_container_field_type(
 471                 struct bt_field_type_common *ft);
 472
 473 BT_HIDDEN
 474 int bt_field_type_common_enumeration_signed_add_mapping(
 475                 struct bt_field_type_common *ft, const char *string,
 476                 int64_t range_start, int64_t range_end);
 477
 478 BT_HIDDEN
 479 int bt_field_type_common_enumeration_unsigned_add_mapping(
 480                 struct bt_field_type_common *ft, const char *string,
 481                 uint64_t range_start, uint64_t range_end);
 482
 483 BT_HIDDEN
 484 int64_t bt_field_type_common_enumeration_get_mapping_count(
 485                 struct bt_field_type_common *ft);
 486
 487 BT_HIDDEN
 488 int bt_field_type_common_floating_point_get_exponent_digits(
 489                 struct bt_field_type_common *ft);
 490
 491 BT_HIDDEN
 492 int bt_field_type_common_floating_point_set_exponent_digits(
 493                 struct bt_field_type_common *ft,
 494                 unsigned int exponent_digits);
 495
 496 BT_HIDDEN
 497 int bt_field_type_common_floating_point_get_mantissa_digits(
 498                 struct bt_field_type_common *type);
 499
 500 BT_HIDDEN
 501 int bt_field_type_common_floating_point_set_mantissa_digits(
 502                 struct bt_field_type_common *ft, unsigned int mantissa_digits);
 503
 504 BT_HIDDEN
 505 int bt_field_type_common_structure_replace_field(
 506                 struct bt_field_type_common *ft,
 507                 const char *field_name,
 508                 struct bt_field_type_common *field_type);
 509
 510 BT_HIDDEN
 511 int bt_field_type_common_structure_add_field(struct bt_field_type_common *ft,
 512                 struct bt_field_type_common *field_type,
 513                 const char *field_name);
 514
 515 BT_HIDDEN
 516 int64_t bt_field_type_common_structure_get_field_count(
 517                 struct bt_field_type_common *ft);
 518
 519 BT_HIDDEN
 520 int bt_field_type_common_structure_borrow_field_by_index(
 521                 struct bt_field_type_common *ft,
 522                 const char **field_name,
 523                 struct bt_field_type_common **field_type, uint64_t index);
 524
 525 BT_HIDDEN
 526 struct bt_field_type_common *
 527 bt_field_type_common_structure_borrow_field_type_by_name(
 528                 struct bt_field_type_common *ft, const char *name);
 529
 530 BT_HIDDEN
 531 struct bt_field_type_common *
 532 bt_field_type_common_variant_borrow_tag_field_type(
 533                 struct bt_field_type_common *ft);
 534
 535 BT_HIDDEN
 536 const char *bt_field_type_common_variant_get_tag_name(
 537                 struct bt_field_type_common *ft);
 538
 539 BT_HIDDEN
 540 int bt_field_type_common_variant_set_tag_name(
 541                 struct bt_field_type_common *ft, const char *name);
 542
 543 BT_HIDDEN
 544 int bt_field_type_common_variant_add_field(struct bt_field_type_common *ft,
 545                 struct bt_field_type_common *field_type,
 546                 const char *field_name);
 547
 548 BT_HIDDEN
 549 int bt_field_type_common_variant_update_choices(
 550                 struct bt_field_type_common *ft);
 551
 552 BT_HIDDEN
 553 struct bt_field_type_common *
 554 bt_field_type_common_variant_borrow_field_type_by_name(
 555                 struct bt_field_type_common *ft,
 556                 const char *field_name);
 557
 558 BT_HIDDEN
 559 int64_t bt_field_type_common_variant_get_field_count(
 560                 struct bt_field_type_common *ft);
 561
 562 BT_HIDDEN
 563 int bt_field_type_common_variant_borrow_field_by_index(
 564                 struct bt_field_type_common *ft,
 565                 const char **field_name,
 566                 struct bt_field_type_common **field_type, uint64_t index);
 567
 568 BT_HIDDEN
 569 struct bt_field_type_common *
 570 bt_field_type_common_array_borrow_element_field_type(
 571                 struct bt_field_type_common *ft);
 572
 573 BT_HIDDEN
 574 int bt_field_type_common_array_set_element_field_type(
 575                 struct bt_field_type_common *ft,
 576                 struct bt_field_type_common *element_ft);
 577
 578 BT_HIDDEN
 579 int64_t bt_field_type_common_array_get_length(struct bt_field_type_common *ft);
 580
 581 BT_HIDDEN
 582 struct bt_field_type_common *
 583 bt_field_type_common_sequence_borrow_element_field_type(
 584                 struct bt_field_type_common *ft);
 585
 586 BT_HIDDEN
 587 int bt_field_type_common_sequence_set_element_field_type(
 588                 struct bt_field_type_common *ft,
 589                 struct bt_field_type_common *element_ft);
 590
 591 BT_HIDDEN
 592 const char *bt_field_type_common_sequence_get_length_field_name(
 593                 struct bt_field_type_common *ft);
 594
 595 BT_HIDDEN
 596 enum bt_string_encoding bt_field_type_common_string_get_encoding(
 597                 struct bt_field_type_common *ft);
 598
 599 BT_HIDDEN
 600 int bt_field_type_common_string_set_encoding(struct bt_field_type_common *ft,
 601                 enum bt_string_encoding encoding);
 602
 603 BT_HIDDEN
 604 int bt_field_type_common_get_alignment(struct bt_field_type_common *type);
 605
 606 BT_HIDDEN
 607 int bt_field_type_common_set_alignment(struct bt_field_type_common *ft,
 608                 unsigned int alignment);
 609
 610 BT_HIDDEN
 611 enum bt_byte_order bt_field_type_common_get_byte_order(
 612                 struct bt_field_type_common *ft);
 613
 614 BT_HIDDEN
 615 int bt_field_type_common_set_byte_order(struct bt_field_type_common *ft,
 616                 enum bt_byte_order byte_order);
 617
 618 BT_HIDDEN
 619 enum bt_field_type_id bt_field_type_common_get_type_id(
 620                 struct bt_field_type_common *ft);
 621
 622 BT_HIDDEN
 623 void _bt_field_type_common_freeze(struct bt_field_type_common *ft);
 624
 625 BT_HIDDEN
 626 void _bt_field_type_freeze(struct bt_field_type *ft);
 627
 628 BT_HIDDEN
 629 struct bt_field_type_common *
 630 bt_field_type_common_variant_borrow_field_type_signed(
 631                 struct bt_field_type_common_variant *var_ft,
 632                 int64_t tag_value);
 633
 634 BT_HIDDEN
 635 struct bt_field_type_common *
 636 bt_field_type_common_variant_borrow_field_type_unsigned(
 637                 struct bt_field_type_common_variant *var_ft,
 638                 uint64_t tag_value);
 639
 640 BT_HIDDEN
 641 struct bt_field_type_common *bt_field_type_common_copy(
 642                 struct bt_field_type_common *ft);
 643
 644 BT_HIDDEN
 645 int bt_field_type_common_structure_get_field_name_index(
 646                 struct bt_field_type_common *ft, const char *name);
 647
 648 BT_HIDDEN
 649 int bt_field_type_common_variant_get_field_name_index(
 650                 struct bt_field_type_common *ft, const char *name);
 651
 652 BT_HIDDEN
 653 int bt_field_type_common_sequence_set_length_field_path(
 654                 struct bt_field_type_common *ft, struct bt_field_path *path);
 655
 656 BT_HIDDEN
 657 int bt_field_type_common_variant_set_tag_field_path(
 658                 struct bt_field_type_common *ft,
 659                 struct bt_field_path *path);
 660
 661 BT_HIDDEN
 662 int bt_field_type_common_variant_set_tag_field_type(
 663                 struct bt_field_type_common *ft,
 664                 struct bt_field_type_common *tag_ft);
 665
 666 BT_HIDDEN
 667 void bt_field_type_common_generic_freeze(struct bt_field_type_common *ft);
 668
 669 BT_HIDDEN
 670 void bt_field_type_common_enumeration_freeze_recursive(
 671                 struct bt_field_type_common *ft);
 672
 673 BT_HIDDEN
 674 void bt_field_type_common_structure_freeze_recursive(
 675                 struct bt_field_type_common *ft);
 676
 677 BT_HIDDEN
 678 void bt_field_type_common_variant_freeze_recursive(
 679                 struct bt_field_type_common *ft);
 680
 681 BT_HIDDEN
 682 void bt_field_type_common_array_freeze_recursive(
 683                 struct bt_field_type_common *ft);
 684
 685 BT_HIDDEN
 686 void bt_field_type_common_sequence_freeze_recursive(
 687                 struct bt_field_type_common *type);
 688
 689 BT_HIDDEN
 690 void bt_field_type_common_integer_set_byte_order(
 691                 struct bt_field_type_common *ft, enum bt_byte_order byte_order);
 692
 693 BT_HIDDEN
 694 void bt_field_type_common_enumeration_set_byte_order_recursive(
 695                 struct bt_field_type_common *ft, enum bt_byte_order byte_order);
 696
 697 BT_HIDDEN
 698 void bt_field_type_common_floating_point_set_byte_order(
 699                 struct bt_field_type_common *ft, enum bt_byte_order byte_order);
 700
 701 BT_HIDDEN
 702 void bt_field_type_common_structure_set_byte_order_recursive(
 703                 struct bt_field_type_common *ft,
 704                 enum bt_byte_order byte_order);
 705
 706 BT_HIDDEN
 707 void bt_field_type_common_variant_set_byte_order_recursive(
 708                 struct bt_field_type_common *ft,
 709                 enum bt_byte_order byte_order);
 710
 711 BT_HIDDEN
 712 void bt_field_type_common_array_set_byte_order_recursive(
 713                 struct bt_field_type_common *ft,
 714                 enum bt_byte_order byte_order);
 715
 716 BT_HIDDEN
 717 void bt_field_type_common_sequence_set_byte_order_recursive(
 718                 struct bt_field_type_common *ft,
 719                 enum bt_byte_order byte_order);
 720
 721 BT_HIDDEN
 722 int bt_field_type_common_integer_compare(struct bt_field_type_common *ft_a,
 723                 struct bt_field_type_common *ft_b);
 724
 725 BT_HIDDEN
 726 int bt_field_type_common_floating_point_compare(
 727                 struct bt_field_type_common *ft_a,
 728                 struct bt_field_type_common *ft_b);
 729
 730 BT_HIDDEN
 731 int bt_field_type_common_enumeration_compare_recursive(
 732                 struct bt_field_type_common *ft_a,
 733                 struct bt_field_type_common *ft_b);
 734
 735 BT_HIDDEN
 736 int bt_field_type_common_string_compare(struct bt_field_type_common *ft_a,
 737                 struct bt_field_type_common *ft_b);
 738
 739 BT_HIDDEN
 740 int bt_field_type_common_structure_compare_recursive(
 741                 struct bt_field_type_common *ft_a,
 742                 struct bt_field_type_common *ft_b);
 743
 744 BT_HIDDEN
 745 int bt_field_type_common_variant_compare_recursive(
 746                 struct bt_field_type_common *ft_a,
 747                 struct bt_field_type_common *ft_b);
 748
 749 BT_HIDDEN
 750 int bt_field_type_common_array_compare_recursive(
 751                 struct bt_field_type_common *ft_a,
 752                 struct bt_field_type_common *ft_b);
 753
 754 BT_HIDDEN
 755 int bt_field_type_common_sequence_compare_recursive(
 756                 struct bt_field_type_common *ft_a,
 757                 struct bt_field_type_common *ft_b);
 758
 759 BT_HIDDEN
 760 int bt_field_type_common_compare(struct bt_field_type_common *ft_a,
 761                 struct bt_field_type_common *ft_b);
 762
 763 BT_HIDDEN
 764 int64_t bt_field_type_common_get_field_count(struct bt_field_type_common *ft);
 765
 766 BT_HIDDEN
 767 struct bt_field_type_common *bt_field_type_common_borrow_field_at_index(
 768                 struct bt_field_type_common *ft, int index);
 769
 770 BT_HIDDEN
 771 int bt_field_type_common_get_field_index(struct bt_field_type_common *ft,
 772                 const char *name);
 773
 774 BT_HIDDEN
 775 struct bt_field_path *bt_field_type_common_variant_borrow_tag_field_path(
 776                 struct bt_field_type_common *ft);
 777
 778 BT_HIDDEN
 779 struct bt_field_path *bt_field_type_common_sequence_borrow_length_field_path(
 780                 struct bt_field_type_common *ft);
 781
 782 BT_HIDDEN
 783 int bt_field_type_common_validate_single_clock_class(
 784                 struct bt_field_type_common *ft,
 785                 struct bt_clock_class **expected_clock_class);
 786
 787 BT_HIDDEN
 788 int64_t bt_field_type_common_variant_find_choice_index(
 789                 struct bt_field_type_common *ft, uint64_t uval,
 790                 bool is_signed);
 791
 792 #endif /* BABELTRACE_CTF_IR_FIELD_TYPES_INTERNAL_H */