src/lib/trace-ir/field.c

   1 /*
   2  * Copyright 2017-2018 Philippe Proulx <pproulx@efficios.com>
   3  * Copyright 2013, 2014 Jérémie Galarneau <jeremie.galarneau@efficios.com>
   4  *
   5  * Permission is hereby granted, free of charge, to any person obtaining a copy
   6  * of this software and associated documentation files (the "Software"), to deal
   7  * in the Software without restriction, including without limitation the rights
   8  * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
   9  * copies of the Software, and to permit persons to whom the Software is
  10  * furnished to do so, subject to the following conditions:
  11  *
  12  * The above copyright notice and this permission notice shall be included in
  13  * all copies or substantial portions of the Software.
  14  *
  15  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  16  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  17  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
  18  * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  19  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
  20  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
  21  * SOFTWARE.
  22  */
  23
  24 #define BT_LOG_TAG "LIB/FIELD"
  25 #include "lib/logging.h"
  26
  27 #include "lib/assert-pre.h"
  28 #include <babeltrace2/trace-ir/field.h>
  29 #include <babeltrace2/trace-ir/field-const.h>
  30 #include "lib/object.h"
  31 #include "compat/compiler.h"
  32 #include "compat/fcntl.h"
  33 #include "common/align.h"
  34 #include "common/assert.h"
  35 #include <inttypes.h>
  36 #include <stdbool.h>
  37
  38 #include "field.h"
  39 #include "field-class.h"
  40 #include "lib/func-status.h"
  41
  42 static
  43 void reset_single_field(struct bt_field *field);
  44
  45 static
  46 void reset_array_field(struct bt_field *field);
  47
  48 static
  49 void reset_structure_field(struct bt_field *field);
  50
  51 static
  52 void reset_option_field(struct bt_field *field);
  53
  54 static
  55 void reset_variant_field(struct bt_field *field);
  56
  57 static
  58 void set_single_field_is_frozen(struct bt_field *field, bool is_frozen);
  59
  60 static
  61 void set_array_field_is_frozen(struct bt_field *field, bool is_frozen);
  62
  63 static
  64 void set_structure_field_is_frozen(struct bt_field *field, bool is_frozen);
  65
  66 static
  67 void set_option_field_is_frozen(struct bt_field *field, bool is_frozen);
  68
  69 static
  70 void set_variant_field_is_frozen(struct bt_field *field, bool is_frozen);
  71
  72 static
  73 bool single_field_is_set(const struct bt_field *field);
  74
  75 static
  76 bool array_field_is_set(const struct bt_field *field);
  77
  78 static
  79 bool structure_field_is_set(const struct bt_field *field);
  80
  81 static
  82 bool option_field_is_set(const struct bt_field *field);
  83
  84 static
  85 bool variant_field_is_set(const struct bt_field *field);
  86
  87 static
  88 struct bt_field_methods bool_field_methods = {
  89         .set_is_frozen = set_single_field_is_frozen,
  90         .is_set = single_field_is_set,
  91         .reset = reset_single_field,
  92 };
  93
  94 static
  95 struct bt_field_methods bit_array_field_methods = {
  96         .set_is_frozen = set_single_field_is_frozen,
  97         .is_set = single_field_is_set,
  98         .reset = reset_single_field,
  99 };
 100
 101 static
 102 struct bt_field_methods integer_field_methods = {
 103         .set_is_frozen = set_single_field_is_frozen,
 104         .is_set = single_field_is_set,
 105         .reset = reset_single_field,
 106 };
 107
 108 static
 109 struct bt_field_methods real_field_methods = {
 110         .set_is_frozen = set_single_field_is_frozen,
 111         .is_set = single_field_is_set,
 112         .reset = reset_single_field,
 113 };
 114
 115 static
 116 struct bt_field_methods string_field_methods = {
 117         .set_is_frozen = set_single_field_is_frozen,
 118         .is_set = single_field_is_set,
 119         .reset = reset_single_field,
 120 };
 121
 122 static
 123 struct bt_field_methods structure_field_methods = {
 124         .set_is_frozen = set_structure_field_is_frozen,
 125         .is_set = structure_field_is_set,
 126         .reset = reset_structure_field,
 127 };
 128
 129 static
 130 struct bt_field_methods array_field_methods = {
 131         .set_is_frozen = set_array_field_is_frozen,
 132         .is_set = array_field_is_set,
 133         .reset = reset_array_field,
 134 };
 135
 136 static
 137 struct bt_field_methods option_field_methods = {
 138         .set_is_frozen = set_option_field_is_frozen,
 139         .is_set = option_field_is_set,
 140         .reset = reset_option_field,
 141 };
 142
 143 static
 144 struct bt_field_methods variant_field_methods = {
 145         .set_is_frozen = set_variant_field_is_frozen,
 146         .is_set = variant_field_is_set,
 147         .reset = reset_variant_field,
 148 };
 149
 150 static
 151 struct bt_field *create_bool_field(struct bt_field_class *);
 152
 153 static
 154 struct bt_field *create_bit_array_field(struct bt_field_class *);
 155
 156 static
 157 struct bt_field *create_integer_field(struct bt_field_class *);
 158
 159 static
 160 struct bt_field *create_real_field(struct bt_field_class *);
 161
 162 static
 163 struct bt_field *create_string_field(struct bt_field_class *);
 164
 165 static
 166 struct bt_field *create_structure_field(struct bt_field_class *);
 167
 168 static
 169 struct bt_field *create_static_array_field(struct bt_field_class *);
 170
 171 static
 172 struct bt_field *create_dynamic_array_field(struct bt_field_class *);
 173
 174 static
 175 struct bt_field *create_option_field(struct bt_field_class *);
 176
 177 static
 178 struct bt_field *create_variant_field(struct bt_field_class *);
 179
 180 static
 181 void destroy_bool_field(struct bt_field *field);
 182
 183 static
 184 void destroy_bit_array_field(struct bt_field *field);
 185
 186 static
 187 void destroy_integer_field(struct bt_field *field);
 188
 189 static
 190 void destroy_real_field(struct bt_field *field);
 191
 192 static
 193 void destroy_string_field(struct bt_field *field);
 194
 195 static
 196 void destroy_structure_field(struct bt_field *field);
 197
 198 static
 199 void destroy_array_field(struct bt_field *field);
 200
 201 static
 202 void destroy_option_field(struct bt_field *field);
 203
 204 static
 205 void destroy_variant_field(struct bt_field *field);
 206
 207 struct bt_field_class *bt_field_borrow_class(struct bt_field *field)
 208 {
 209         BT_ASSERT_PRE_DEV_NON_NULL(field, "Field");
 210         return field->class;
 211 }
 212
 213 const struct bt_field_class *bt_field_borrow_class_const(
 214                 const struct bt_field *field)
 215 {
 216         BT_ASSERT_PRE_DEV_NON_NULL(field, "Field");
 217         return field->class;
 218 }
 219
 220 enum bt_field_class_type bt_field_get_class_type(const struct bt_field *field)
 221 {
 222         BT_ASSERT_PRE_DEV_NON_NULL(field, "Field");
 223         return field->class->type;
 224 }
 225
 226 BT_HIDDEN
 227 struct bt_field *bt_field_create(struct bt_field_class *fc)
 228 {
 229         struct bt_field *field = NULL;
 230
 231         BT_ASSERT(fc);
 232
 233         switch (fc->type) {
 234         case BT_FIELD_CLASS_TYPE_BOOL:
 235                 field = create_bool_field(fc);
 236                 break;
 237         case BT_FIELD_CLASS_TYPE_BIT_ARRAY:
 238                 field = create_bit_array_field(fc);
 239                 break;
 240         case BT_FIELD_CLASS_TYPE_UNSIGNED_INTEGER:
 241         case BT_FIELD_CLASS_TYPE_SIGNED_INTEGER:
 242         case BT_FIELD_CLASS_TYPE_UNSIGNED_ENUMERATION:
 243         case BT_FIELD_CLASS_TYPE_SIGNED_ENUMERATION:
 244                 field = create_integer_field(fc);
 245                 break;
 246         case BT_FIELD_CLASS_TYPE_SINGLE_PRECISION_REAL:
 247         case BT_FIELD_CLASS_TYPE_DOUBLE_PRECISION_REAL:
 248                 field = create_real_field(fc);
 249                 break;
 250         case BT_FIELD_CLASS_TYPE_STRING:
 251                 field = create_string_field(fc);
 252                 break;
 253         case BT_FIELD_CLASS_TYPE_STRUCTURE:
 254                 field = create_structure_field(fc);
 255                 break;
 256         case BT_FIELD_CLASS_TYPE_STATIC_ARRAY:
 257                 field = create_static_array_field(fc);
 258                 break;
 259         case BT_FIELD_CLASS_TYPE_DYNAMIC_ARRAY_WITHOUT_LENGTH_FIELD:
 260         case BT_FIELD_CLASS_TYPE_DYNAMIC_ARRAY_WITH_LENGTH_FIELD:
 261                 field = create_dynamic_array_field(fc);
 262                 break;
 263         case BT_FIELD_CLASS_TYPE_OPTION_WITHOUT_SELECTOR_FIELD:
 264         case BT_FIELD_CLASS_TYPE_OPTION_WITH_BOOL_SELECTOR_FIELD:
 265         case BT_FIELD_CLASS_TYPE_OPTION_WITH_UNSIGNED_INTEGER_SELECTOR_FIELD:
 266         case BT_FIELD_CLASS_TYPE_OPTION_WITH_SIGNED_INTEGER_SELECTOR_FIELD:
 267                 field = create_option_field(fc);
 268                 break;
 269         case BT_FIELD_CLASS_TYPE_VARIANT_WITHOUT_SELECTOR_FIELD:
 270         case BT_FIELD_CLASS_TYPE_VARIANT_WITH_UNSIGNED_INTEGER_SELECTOR_FIELD:
 271         case BT_FIELD_CLASS_TYPE_VARIANT_WITH_SIGNED_INTEGER_SELECTOR_FIELD:
 272                 field = create_variant_field(fc);
 273                 break;
 274         default:
 275                 bt_common_abort();
 276         }
 277
 278         if (!field) {
 279                 BT_LIB_LOGE_APPEND_CAUSE("Cannot create field object from field class: "
 280                         "%![fc-]+F", fc);
 281                 goto end;
 282         }
 283
 284 end:
 285         return field;
 286 }
 287
 288 static inline
 289 void init_field(struct bt_field *field, struct bt_field_class *fc,
 290                 struct bt_field_methods *methods)
 291 {
 292         BT_ASSERT(field);
 293         BT_ASSERT(fc);
 294         bt_object_init_unique(&field->base);
 295         field->methods = methods;
 296         field->class = fc;
 297         bt_object_get_ref_no_null_check(fc);
 298 }
 299
 300 static
 301 struct bt_field *create_bool_field(struct bt_field_class *fc)
 302 {
 303         struct bt_field_bool *bool_field;
 304
 305         BT_LIB_LOGD("Creating boolean field object: %![fc-]+F", fc);
 306         bool_field = g_new0(struct bt_field_bool, 1);
 307         if (!bool_field) {
 308                 BT_LIB_LOGE_APPEND_CAUSE(
 309                         "Failed to allocate one boolean field.");
 310                 goto end;
 311         }
 312
 313         init_field((void *) bool_field, fc, &bool_field_methods);
 314         BT_LIB_LOGD("Created boolean field object: %!+f", bool_field);
 315
 316 end:
 317         return (void *) bool_field;
 318 }
 319
 320 static
 321 struct bt_field *create_bit_array_field(struct bt_field_class *fc)
 322 {
 323         struct bt_field_bit_array *ba_field;
 324
 325         BT_LIB_LOGD("Creating bit array field object: %![fc-]+F", fc);
 326         ba_field = g_new0(struct bt_field_bit_array, 1);
 327         if (!ba_field) {
 328                 BT_LIB_LOGE_APPEND_CAUSE(
 329                         "Failed to allocate one bit array field.");
 330                 goto end;
 331         }
 332
 333         init_field((void *) ba_field, fc, &bit_array_field_methods);
 334         BT_LIB_LOGD("Created bit array field object: %!+f", ba_field);
 335
 336 end:
 337         return (void *) ba_field;
 338 }
 339
 340 static
 341 struct bt_field *create_integer_field(struct bt_field_class *fc)
 342 {
 343         struct bt_field_integer *int_field;
 344
 345         BT_LIB_LOGD("Creating integer field object: %![fc-]+F", fc);
 346         int_field = g_new0(struct bt_field_integer, 1);
 347         if (!int_field) {
 348                 BT_LIB_LOGE_APPEND_CAUSE(
 349                         "Failed to allocate one integer field.");
 350                 goto end;
 351         }
 352
 353         init_field((void *) int_field, fc, &integer_field_methods);
 354         BT_LIB_LOGD("Created integer field object: %!+f", int_field);
 355
 356 end:
 357         return (void *) int_field;
 358 }
 359
 360 static
 361 struct bt_field *create_real_field(struct bt_field_class *fc)
 362 {
 363         struct bt_field_real *real_field;
 364
 365         BT_LIB_LOGD("Creating real field object: %![fc-]+F", fc);
 366         real_field = g_new0(struct bt_field_real, 1);
 367         if (!real_field) {
 368                 BT_LIB_LOGE_APPEND_CAUSE("Failed to allocate one real field.");
 369                 goto end;
 370         }
 371
 372         init_field((void *) real_field, fc, &real_field_methods);
 373         BT_LIB_LOGD("Created real field object: %!+f", real_field);
 374
 375 end:
 376         return (void *) real_field;
 377 }
 378
 379 static
 380 struct bt_field *create_string_field(struct bt_field_class *fc)
 381 {
 382         struct bt_field_string *string_field;
 383
 384         BT_LIB_LOGD("Creating string field object: %![fc-]+F", fc);
 385         string_field = g_new0(struct bt_field_string, 1);
 386         if (!string_field) {
 387                 BT_LIB_LOGE_APPEND_CAUSE(
 388                         "Failed to allocate one string field.");
 389                 goto end;
 390         }
 391
 392         init_field((void *) string_field, fc, &string_field_methods);
 393         string_field->buf = g_array_sized_new(FALSE, FALSE,
 394                 sizeof(char), 1);
 395         if (!string_field->buf) {
 396                 BT_LIB_LOGE_APPEND_CAUSE("Failed to allocate a GArray.");
 397                 bt_field_destroy((void *) string_field);
 398                 string_field = NULL;
 399                 goto end;
 400         }
 401
 402         g_array_index(string_field->buf, char, 0) = '\0';
 403         BT_LIB_LOGD("Created string field object: %!+f", string_field);
 404
 405 end:
 406         return (void *) string_field;
 407 }
 408
 409 static inline
 410 int create_fields_from_named_field_classes(
 411                 struct bt_field_class_named_field_class_container *fc,
 412                 GPtrArray **fields)
 413 {
 414         int ret = 0;
 415         uint64_t i;
 416
 417         *fields = g_ptr_array_new_with_free_func(
 418                 (GDestroyNotify) bt_field_destroy);
 419         if (!*fields) {
 420                 BT_LIB_LOGE_APPEND_CAUSE("Failed to allocate a GPtrArray.");
 421                 ret = -1;
 422                 goto end;
 423         }
 424
 425         g_ptr_array_set_size(*fields, fc->named_fcs->len);
 426
 427         for (i = 0; i < fc->named_fcs->len; i++) {
 428                 struct bt_field *field;
 429                 struct bt_named_field_class *named_fc = fc->named_fcs->pdata[i];
 430
 431                 field = bt_field_create(named_fc->fc);
 432                 if (!field) {
 433                         BT_LIB_LOGE_APPEND_CAUSE(
 434                                 "Failed to create structure member or variant option field: "
 435                                 "name=\"%s\", %![fc-]+F",
 436                                 named_fc->name->str, named_fc->fc);
 437                         ret = -1;
 438                         goto end;
 439                 }
 440
 441                 g_ptr_array_index(*fields, i) = field;
 442         }
 443
 444 end:
 445         return ret;
 446 }
 447
 448 static
 449 struct bt_field *create_structure_field(struct bt_field_class *fc)
 450 {
 451         struct bt_field_structure *struct_field;
 452
 453         BT_LIB_LOGD("Creating structure field object: %![fc-]+F", fc);
 454         struct_field = g_new0(struct bt_field_structure, 1);
 455         if (!struct_field) {
 456                 BT_LIB_LOGE_APPEND_CAUSE(
 457                         "Failed to allocate one structure field.");
 458                 goto end;
 459         }
 460
 461         init_field((void *) struct_field, fc, &structure_field_methods);
 462
 463         if (create_fields_from_named_field_classes((void *) fc,
 464                         &struct_field->fields)) {
 465                 BT_LIB_LOGE_APPEND_CAUSE(
 466                         "Cannot create structure member fields: %![fc-]+F", fc);
 467                 bt_field_destroy((void *) struct_field);
 468                 struct_field = NULL;
 469                 goto end;
 470         }
 471
 472         BT_LIB_LOGD("Created structure field object: %!+f", struct_field);
 473
 474 end:
 475         return (void *) struct_field;
 476 }
 477
 478 static
 479 struct bt_field *create_option_field(struct bt_field_class *fc)
 480 {
 481         struct bt_field_option *opt_field;
 482         struct bt_field_class_option *opt_fc = (void *) fc;
 483
 484         BT_LIB_LOGD("Creating option field object: %![fc-]+F", fc);
 485         opt_field = g_new0(struct bt_field_option, 1);
 486         if (!opt_field) {
 487                 BT_LIB_LOGE_APPEND_CAUSE(
 488                         "Failed to allocate one option field.");
 489                 goto end;
 490         }
 491
 492         init_field((void *) opt_field, fc, &option_field_methods);
 493         opt_field->content_field = bt_field_create(opt_fc->content_fc);
 494         if (!opt_field->content_field) {
 495                 BT_LIB_LOGE_APPEND_CAUSE(
 496                         "Failed to create option field's content field: "
 497                         "%![opt-fc-]+F, %![content-fc-]+F",
 498                         opt_fc, opt_fc->content_fc);
 499                 bt_field_destroy((void *) opt_field);
 500                 opt_field = NULL;
 501                 goto end;
 502         }
 503
 504         BT_LIB_LOGD("Created option field object: %!+f", opt_field);
 505
 506 end:
 507         return (void *) opt_field;
 508 }
 509
 510 static
 511 struct bt_field *create_variant_field(struct bt_field_class *fc)
 512 {
 513         struct bt_field_variant *var_field;
 514
 515         BT_LIB_LOGD("Creating variant field object: %![fc-]+F", fc);
 516         var_field = g_new0(struct bt_field_variant, 1);
 517         if (!var_field) {
 518                 BT_LIB_LOGE_APPEND_CAUSE(
 519                         "Failed to allocate one variant field.");
 520                 goto end;
 521         }
 522
 523         init_field((void *) var_field, fc, &variant_field_methods);
 524
 525         if (create_fields_from_named_field_classes((void *) fc,
 526                         &var_field->fields)) {
 527                 BT_LIB_LOGE_APPEND_CAUSE("Cannot create variant member fields: "
 528                         "%![fc-]+F", fc);
 529                 bt_field_destroy((void *) var_field);
 530                 var_field = NULL;
 531                 goto end;
 532         }
 533
 534         BT_LIB_LOGD("Created variant field object: %!+f", var_field);
 535
 536 end:
 537         return (void *) var_field;
 538 }
 539
 540 static inline
 541 int init_array_field_fields(struct bt_field_array *array_field)
 542 {
 543         int ret = 0;
 544         uint64_t i;
 545         struct bt_field_class_array *array_fc;
 546
 547         BT_ASSERT(array_field);
 548         array_fc = (void *) array_field->common.class;
 549         array_field->fields = g_ptr_array_sized_new(array_field->length);
 550         if (!array_field->fields) {
 551                 BT_LIB_LOGE_APPEND_CAUSE("Failed to allocate a GPtrArray.");
 552                 ret = -1;
 553                 goto end;
 554         }
 555
 556         g_ptr_array_set_free_func(array_field->fields,
 557                 (GDestroyNotify) bt_field_destroy);
 558         g_ptr_array_set_size(array_field->fields, array_field->length);
 559
 560         for (i = 0; i < array_field->length; i++) {
 561                 array_field->fields->pdata[i] = bt_field_create(
 562                         array_fc->element_fc);
 563                 if (!array_field->fields->pdata[i]) {
 564                         BT_LIB_LOGE_APPEND_CAUSE(
 565                                 "Cannot create array field's element field: "
 566                                 "index=%" PRIu64 ", %![fc-]+F", i, array_fc);
 567                         ret = -1;
 568                         goto end;
 569                 }
 570         }
 571
 572 end:
 573         return ret;
 574 }
 575
 576 static
 577 struct bt_field *create_static_array_field(struct bt_field_class *fc)
 578 {
 579         struct bt_field_class_array_static *array_fc = (void *) fc;
 580         struct bt_field_array *array_field;
 581
 582         BT_LIB_LOGD("Creating static array field object: %![fc-]+F", fc);
 583         array_field = g_new0(struct bt_field_array, 1);
 584         if (!array_field) {
 585                 BT_LIB_LOGE_APPEND_CAUSE(
 586                         "Failed to allocate one static array field.");
 587                 goto end;
 588         }
 589
 590         init_field((void *) array_field, fc, &array_field_methods);
 591         array_field->length = array_fc->length;
 592
 593         if (init_array_field_fields(array_field)) {
 594                 BT_LIB_LOGE_APPEND_CAUSE("Cannot create static array fields: "
 595                         "%![fc-]+F", fc);
 596                 bt_field_destroy((void *) array_field);
 597                 array_field = NULL;
 598                 goto end;
 599         }
 600
 601         BT_LIB_LOGD("Created static array field object: %!+f", array_field);
 602
 603 end:
 604         return (void *) array_field;
 605 }
 606
 607 static
 608 struct bt_field *create_dynamic_array_field(struct bt_field_class *fc)
 609 {
 610         struct bt_field_array *array_field;
 611
 612         BT_LIB_LOGD("Creating dynamic array field object: %![fc-]+F", fc);
 613         array_field = g_new0(struct bt_field_array, 1);
 614         if (!array_field) {
 615                 BT_LIB_LOGE_APPEND_CAUSE(
 616                         "Failed to allocate one dynamic array field.");
 617                 goto end;
 618         }
 619
 620         init_field((void *) array_field, fc, &array_field_methods);
 621
 622         if (init_array_field_fields(array_field)) {
 623                 BT_LIB_LOGE_APPEND_CAUSE("Cannot create dynamic array fields: "
 624                         "%![fc-]+F", fc);
 625                 bt_field_destroy((void *) array_field);
 626                 array_field = NULL;
 627                 goto end;
 628         }
 629
 630         BT_LIB_LOGD("Created dynamic array field object: %!+f", array_field);
 631
 632 end:
 633         return (void *) array_field;
 634 }
 635
 636 bt_bool bt_field_bool_get_value(const struct bt_field *field)
 637 {
 638         const struct bt_field_bool *bool_field = (const void *) field;
 639
 640         BT_ASSERT_PRE_DEV_NON_NULL(field, "Field");
 641         BT_ASSERT_PRE_DEV_FIELD_IS_SET(field, "Field");
 642         BT_ASSERT_PRE_DEV_FIELD_HAS_CLASS_TYPE(field, BT_FIELD_CLASS_TYPE_BOOL,
 643                 "Field");
 644         return (bt_bool) bool_field->value;
 645 }
 646
 647 void bt_field_bool_set_value(struct bt_field *field, bt_bool value)
 648 {
 649         struct bt_field_bool *bool_field = (void *) field;
 650
 651         BT_ASSERT_PRE_DEV_NON_NULL(field, "Field");
 652         BT_ASSERT_PRE_DEV_FIELD_HAS_CLASS_TYPE(field, BT_FIELD_CLASS_TYPE_BOOL,
 653                 "Field");
 654         BT_ASSERT_PRE_DEV_FIELD_HOT(field, "Field");
 655         bool_field->value = (bool) value;
 656         bt_field_set_single(field, true);
 657 }
 658
 659 uint64_t bt_field_bit_array_get_value_as_integer(const struct bt_field *field)
 660 {
 661         const struct bt_field_bit_array *ba_field = (const void *) field;
 662
 663         BT_ASSERT_PRE_DEV_NON_NULL(field, "Field");
 664         BT_ASSERT_PRE_DEV_FIELD_IS_SET(field, "Field");
 665         BT_ASSERT_PRE_DEV_FIELD_HAS_CLASS_TYPE(field,
 666                 BT_FIELD_CLASS_TYPE_BIT_ARRAY, "Field");
 667         return ba_field->value_as_int;
 668 }
 669
 670 void bt_field_bit_array_set_value_as_integer(struct bt_field *field,
 671                 uint64_t value)
 672 {
 673         struct bt_field_bit_array *ba_field = (void *) field;
 674         struct bt_field_class_bit_array *ba_fc;
 675
 676         BT_ASSERT_PRE_DEV_NON_NULL(field, "Field");
 677         BT_ASSERT_PRE_DEV_FIELD_HAS_CLASS_TYPE(field,
 678                 BT_FIELD_CLASS_TYPE_BIT_ARRAY, "Field");
 679         BT_ASSERT_PRE_DEV_FIELD_HOT(field, "Field");
 680         ba_fc = (void *) field->class;
 681         ba_field->value_as_int = value;
 682
 683         if (ba_fc->length < 64) {
 684                 /* Apply mask */
 685                 ba_field->value_as_int &= ((UINT64_C(1) << ba_fc->length) - 1);
 686         }
 687
 688         bt_field_set_single(field, true);
 689 }
 690
 691 int64_t bt_field_integer_signed_get_value(const struct bt_field *field)
 692 {
 693         const struct bt_field_integer *int_field = (const void *) field;
 694
 695         BT_ASSERT_PRE_DEV_NON_NULL(field, "Field");
 696         BT_ASSERT_PRE_DEV_FIELD_IS_SET(field, "Field");
 697         BT_ASSERT_PRE_DEV_FIELD_IS_SIGNED_INT(field, "Field");
 698         return int_field->value.i;
 699 }
 700
 701 void bt_field_integer_signed_set_value(struct bt_field *field, int64_t value)
 702 {
 703         struct bt_field_integer *int_field = (void *) field;
 704
 705         BT_ASSERT_PRE_DEV_NON_NULL(field, "Field");
 706         BT_ASSERT_PRE_DEV_FIELD_IS_SIGNED_INT(field, "Field");
 707         BT_ASSERT_PRE_DEV_FIELD_HOT(field, "Field");
 708         BT_ASSERT_PRE_DEV(bt_util_value_is_in_range_signed(
 709                 ((struct bt_field_class_integer *) field->class)->range, value),
 710                 "Value is out of bounds: value=%" PRId64 ", %![field-]+f, "
 711                 "%![fc-]+F", value, field, field->class);
 712         int_field->value.i = value;
 713         bt_field_set_single(field, true);
 714 }
 715
 716 uint64_t bt_field_integer_unsigned_get_value(const struct bt_field *field)
 717 {
 718         const struct bt_field_integer *int_field = (const void *) field;
 719
 720         BT_ASSERT_PRE_DEV_NON_NULL(field, "Field");
 721         BT_ASSERT_PRE_DEV_FIELD_IS_SET(field, "Field");
 722         BT_ASSERT_PRE_DEV_FIELD_IS_UNSIGNED_INT(field, "Field");
 723         return int_field->value.u;
 724 }
 725
 726 void bt_field_integer_unsigned_set_value(struct bt_field *field, uint64_t value)
 727 {
 728         struct bt_field_integer *int_field = (void *) field;
 729
 730         BT_ASSERT_PRE_DEV_NON_NULL(field, "Field");
 731         BT_ASSERT_PRE_DEV_FIELD_IS_UNSIGNED_INT(field, "Field");
 732         BT_ASSERT_PRE_DEV_FIELD_HOT(field, "Field");
 733         BT_ASSERT_PRE_DEV(bt_util_value_is_in_range_unsigned(
 734                 ((struct bt_field_class_integer *) field->class)->range, value),
 735                 "Value is out of bounds: value=%" PRIu64 ", %![field-]+f, "
 736                 "%![fc-]+F", value, field, field->class);
 737         int_field->value.u = value;
 738         bt_field_set_single(field, true);
 739 }
 740
 741 float bt_field_real_single_precision_get_value(const struct bt_field *field)
 742 {
 743         const struct bt_field_real *real_field = (const void *) field;
 744
 745         BT_ASSERT_PRE_DEV_NON_NULL(field, "Field");
 746         BT_ASSERT_PRE_DEV_FIELD_IS_SET(field, "Field");
 747         BT_ASSERT_PRE_DEV_FIELD_HAS_CLASS_TYPE(field,
 748                 BT_FIELD_CLASS_TYPE_SINGLE_PRECISION_REAL, "Field");
 749         return (float) real_field->value;
 750 }
 751
 752 double bt_field_real_double_precision_get_value(const struct bt_field *field)
 753 {
 754         const struct bt_field_real *real_field = (const void *) field;
 755
 756         BT_ASSERT_PRE_DEV_NON_NULL(field, "Field");
 757         BT_ASSERT_PRE_DEV_FIELD_IS_SET(field, "Field");
 758         BT_ASSERT_PRE_DEV_FIELD_HAS_CLASS_TYPE(field,
 759                 BT_FIELD_CLASS_TYPE_DOUBLE_PRECISION_REAL, "Field");
 760
 761         return real_field->value;
 762 }
 763
 764 void bt_field_real_single_precision_set_value(struct bt_field *field,
 765                 float value)
 766 {
 767         struct bt_field_real *real_field = (void *) field;
 768
 769         BT_ASSERT_PRE_DEV_NON_NULL(field, "Field");
 770         BT_ASSERT_PRE_DEV_FIELD_HAS_CLASS_TYPE(field,
 771                 BT_FIELD_CLASS_TYPE_SINGLE_PRECISION_REAL, "Field");
 772         BT_ASSERT_PRE_DEV_FIELD_HOT(field, "Field");
 773
 774         real_field->value = (double) value;
 775         bt_field_set_single(field, true);
 776 }
 777
 778 void bt_field_real_double_precision_set_value(struct bt_field *field,
 779                 double value)
 780 {
 781         struct bt_field_real *real_field = (void *) field;
 782
 783         BT_ASSERT_PRE_DEV_NON_NULL(field, "Field");
 784         BT_ASSERT_PRE_DEV_FIELD_HAS_CLASS_TYPE(field,
 785                 BT_FIELD_CLASS_TYPE_DOUBLE_PRECISION_REAL, "Field");
 786         BT_ASSERT_PRE_DEV_FIELD_HOT(field, "Field");
 787
 788         real_field->value = value;
 789         bt_field_set_single(field, true);
 790 }
 791
 792 enum bt_field_enumeration_get_mapping_labels_status
 793 bt_field_enumeration_unsigned_get_mapping_labels(
 794                 const struct bt_field *field,
 795                 bt_field_class_enumeration_mapping_label_array *label_array,
 796                 uint64_t *count)
 797 {
 798         const struct bt_field_integer *int_field = (const void *) field;
 799
 800         BT_ASSERT_PRE_DEV_NO_ERROR();
 801         BT_ASSERT_PRE_DEV_NON_NULL(field, "Field");
 802         BT_ASSERT_PRE_DEV_NON_NULL(label_array, "Label array (output)");
 803         BT_ASSERT_PRE_DEV_NON_NULL(label_array, "Count (output)");
 804         BT_ASSERT_PRE_DEV_FIELD_IS_SET(field, "Field");
 805         BT_ASSERT_PRE_DEV_FIELD_HAS_CLASS_TYPE(field,
 806                 BT_FIELD_CLASS_TYPE_UNSIGNED_ENUMERATION, "Field");
 807         return (int)
 808                 bt_field_class_enumeration_unsigned_get_mapping_labels_for_value(
 809                         field->class, int_field->value.u, label_array, count);
 810 }
 811
 812 enum bt_field_enumeration_get_mapping_labels_status
 813 bt_field_enumeration_signed_get_mapping_labels(
 814                 const struct bt_field *field,
 815                 bt_field_class_enumeration_mapping_label_array *label_array,
 816                 uint64_t *count)
 817 {
 818         const struct bt_field_integer *int_field = (const void *) field;
 819
 820         BT_ASSERT_PRE_DEV_NO_ERROR();
 821         BT_ASSERT_PRE_DEV_NON_NULL(field, "Field");
 822         BT_ASSERT_PRE_DEV_NON_NULL(label_array, "Label array (output)");
 823         BT_ASSERT_PRE_DEV_NON_NULL(label_array, "Count (output)");
 824         BT_ASSERT_PRE_DEV_FIELD_IS_SET(field, "Field");
 825         BT_ASSERT_PRE_DEV_FIELD_HAS_CLASS_TYPE(field,
 826                 BT_FIELD_CLASS_TYPE_SIGNED_ENUMERATION, "Field");
 827         return (int)
 828                 bt_field_class_enumeration_signed_get_mapping_labels_for_value(
 829                         field->class, int_field->value.i, label_array, count);
 830 }
 831
 832 const char *bt_field_string_get_value(const struct bt_field *field)
 833 {
 834         const struct bt_field_string *string_field = (const void *) field;
 835
 836         BT_ASSERT_PRE_DEV_NON_NULL(field, "Field");
 837         BT_ASSERT_PRE_DEV_FIELD_IS_SET(field, "Field");
 838         BT_ASSERT_PRE_DEV_FIELD_HAS_CLASS_TYPE(field, BT_FIELD_CLASS_TYPE_STRING,
 839                 "Field");
 840         return (const char *) string_field->buf->data;
 841 }
 842
 843 uint64_t bt_field_string_get_length(const struct bt_field *field)
 844 {
 845         const struct bt_field_string *string_field = (const void *) field;
 846
 847         BT_ASSERT_PRE_DEV_NON_NULL(field, "Field");
 848         BT_ASSERT_PRE_DEV_FIELD_IS_SET(field, "Field");
 849         BT_ASSERT_PRE_DEV_FIELD_HAS_CLASS_TYPE(field, BT_FIELD_CLASS_TYPE_STRING,
 850                 "Field");
 851         return string_field->length;
 852 }
 853
 854 static inline
 855 void clear_string_field(struct bt_field *field)
 856 {
 857         struct bt_field_string *string_field = (void *) field;
 858
 859         BT_ASSERT_DBG(field);
 860         string_field->length = 0;
 861         bt_field_set_single(field, true);
 862 }
 863
 864 enum bt_field_string_set_value_status bt_field_string_set_value(
 865                 struct bt_field *field, const char *value)
 866 {
 867         BT_ASSERT_PRE_DEV_NO_ERROR();
 868         BT_ASSERT_PRE_DEV_NON_NULL(field, "Field");
 869         BT_ASSERT_PRE_DEV_NON_NULL(value, "Value");
 870         BT_ASSERT_PRE_DEV_FIELD_HOT(field, "Field");
 871         BT_ASSERT_PRE_DEV_FIELD_HAS_CLASS_TYPE(field, BT_FIELD_CLASS_TYPE_STRING,
 872                 "Field");
 873         clear_string_field(field);
 874         return (int) bt_field_string_append_with_length(field, value,
 875                 (uint64_t) strlen(value));
 876 }
 877
 878 enum bt_field_string_append_status bt_field_string_append(
 879                 struct bt_field *field, const char *value)
 880 {
 881         BT_ASSERT_PRE_DEV_NO_ERROR();
 882
 883         return bt_field_string_append_with_length(field,
 884                 value, (uint64_t) strlen(value));
 885 }
 886
 887 enum bt_field_string_append_status bt_field_string_append_with_length(
 888                 struct bt_field *field, const char *value, uint64_t length)
 889 {
 890         struct bt_field_string *string_field = (void *) field;
 891         char *data;
 892         uint64_t new_length;
 893
 894         BT_ASSERT_PRE_DEV_NO_ERROR();
 895         BT_ASSERT_PRE_DEV_NON_NULL(field, "Field");
 896         BT_ASSERT_PRE_DEV_NON_NULL(value, "Value");
 897         BT_ASSERT_PRE_DEV_FIELD_HOT(field, "Field");
 898         BT_ASSERT_PRE_DEV_FIELD_HAS_CLASS_TYPE(field,
 899                 BT_FIELD_CLASS_TYPE_STRING, "Field");
 900
 901         /* Make sure no null bytes are appended */
 902         BT_ASSERT_PRE_DEV(!memchr(value, '\0', length),
 903                 "String value to append contains a null character: "
 904                 "partial-value=\"%.32s\", length=%" PRIu64, value, length);
 905
 906         new_length = length + string_field->length;
 907
 908         if (G_UNLIKELY(new_length + 1 > string_field->buf->len)) {
 909                 g_array_set_size(string_field->buf, new_length + 1);
 910         }
 911
 912         data = string_field->buf->data;
 913         memcpy(data + string_field->length, value, length);
 914         ((char *) string_field->buf->data)[new_length] = '\0';
 915         string_field->length = new_length;
 916         bt_field_set_single(field, true);
 917         return BT_FUNC_STATUS_OK;
 918 }
 919
 920 void bt_field_string_clear(struct bt_field *field)
 921 {
 922         BT_ASSERT_PRE_DEV_NON_NULL(field, "Field");
 923         BT_ASSERT_PRE_DEV_FIELD_HOT(field, "Field");
 924         BT_ASSERT_PRE_DEV_FIELD_HAS_CLASS_TYPE(field,
 925                 BT_FIELD_CLASS_TYPE_STRING, "Field");
 926         clear_string_field(field);
 927 }
 928
 929 uint64_t bt_field_array_get_length(const struct bt_field *field)
 930 {
 931         const struct bt_field_array *array_field = (const void *) field;
 932
 933         BT_ASSERT_PRE_DEV_NON_NULL(field, "Field");
 934         BT_ASSERT_PRE_DEV_FIELD_IS_ARRAY(field, "Field");
 935         return array_field->length;
 936 }
 937
 938 enum bt_field_array_dynamic_set_length_status bt_field_array_dynamic_set_length(
 939                 struct bt_field *field, uint64_t length)
 940 {
 941         int ret = BT_FUNC_STATUS_OK;
 942         struct bt_field_array *array_field = (void *) field;
 943
 944         BT_ASSERT_PRE_DEV_NO_ERROR();
 945         BT_ASSERT_PRE_DEV_NON_NULL(field, "Field");
 946         BT_ASSERT_PRE_DEV_FIELD_IS_DYNAMIC_ARRAY(field, "Field");
 947         BT_ASSERT_PRE_DEV_FIELD_HOT(field, "Field");
 948
 949         if (G_UNLIKELY(length > array_field->fields->len)) {
 950                 /* Make more room */
 951                 struct bt_field_class_array *array_fc;
 952                 uint64_t cur_len = array_field->fields->len;
 953                 uint64_t i;
 954
 955                 g_ptr_array_set_size(array_field->fields, length);
 956                 array_fc = (void *) field->class;
 957
 958                 for (i = cur_len; i < array_field->fields->len; i++) {
 959                         struct bt_field *elem_field = bt_field_create(
 960                                 array_fc->element_fc);
 961
 962                         if (!elem_field) {
 963                                 BT_LIB_LOGE_APPEND_CAUSE(
 964                                         "Cannot create element field for "
 965                                         "dynamic array field: "
 966                                         "index=%" PRIu64 ", "
 967                                         "%![array-field-]+f", i, field);
 968                                 ret = BT_FUNC_STATUS_MEMORY_ERROR;
 969                                 goto end;
 970                         }
 971
 972                         BT_ASSERT_DBG(!array_field->fields->pdata[i]);
 973                         array_field->fields->pdata[i] = elem_field;
 974                 }
 975         }
 976
 977         array_field->length = length;
 978
 979 end:
 980         return ret;
 981 }
 982
 983 static inline
 984 struct bt_field *borrow_array_field_element_field_by_index(
 985                 struct bt_field *field, uint64_t index)
 986 {
 987         struct bt_field_array *array_field = (void *) field;
 988
 989         BT_ASSERT_PRE_DEV_NON_NULL(field, "Field");
 990         BT_ASSERT_PRE_DEV_FIELD_IS_ARRAY(field, "Field");
 991         BT_ASSERT_PRE_DEV_VALID_INDEX(index, array_field->length);
 992         return array_field->fields->pdata[index];
 993 }
 994
 995 struct bt_field *bt_field_array_borrow_element_field_by_index(
 996                 struct bt_field *field, uint64_t index)
 997 {
 998         return borrow_array_field_element_field_by_index(field, index);
 999 }
1000
1001 const struct bt_field *
1002 bt_field_array_borrow_element_field_by_index_const(
1003                 const struct bt_field *field, uint64_t index)
1004 {
1005         return borrow_array_field_element_field_by_index((void *) field, index);
1006 }
1007
1008 static inline
1009 struct bt_field *borrow_structure_field_member_field_by_index(
1010                 struct bt_field *field, uint64_t index)
1011 {
1012         struct bt_field_structure *struct_field = (void *) field;
1013
1014         BT_ASSERT_PRE_DEV_NON_NULL(field, "Field");
1015         BT_ASSERT_PRE_DEV_FIELD_HAS_CLASS_TYPE(field,
1016                 BT_FIELD_CLASS_TYPE_STRUCTURE, "Field");
1017         BT_ASSERT_PRE_DEV_VALID_INDEX(index, struct_field->fields->len);
1018         return struct_field->fields->pdata[index];
1019 }
1020
1021 struct bt_field *bt_field_structure_borrow_member_field_by_index(
1022                 struct bt_field *field, uint64_t index)
1023 {
1024         return borrow_structure_field_member_field_by_index(field,
1025                 index);
1026 }
1027
1028 const struct bt_field *
1029 bt_field_structure_borrow_member_field_by_index_const(
1030                 const struct bt_field *field, uint64_t index)
1031 {
1032         return borrow_structure_field_member_field_by_index(
1033                 (void *) field, index);
1034 }
1035
1036 static inline
1037 struct bt_field *borrow_structure_field_member_field_by_name(
1038                 struct bt_field *field, const char *name)
1039 {
1040         struct bt_field *ret_field = NULL;
1041         struct bt_field_class_structure *struct_fc;
1042         struct bt_field_structure *struct_field = (void *) field;
1043         gpointer orig_key;
1044         gpointer index;
1045
1046         BT_ASSERT_PRE_DEV_NON_NULL(field, "Field");
1047         BT_ASSERT_PRE_DEV_NON_NULL(name, "Field name");
1048         BT_ASSERT_PRE_DEV_FIELD_HAS_CLASS_TYPE(field,
1049                 BT_FIELD_CLASS_TYPE_STRUCTURE, "Field");
1050         struct_fc = (void *) field->class;
1051
1052         if (!g_hash_table_lookup_extended(struct_fc->common.name_to_index, name,
1053                         &orig_key, &index)) {
1054                 goto end;
1055         }
1056
1057         ret_field = struct_field->fields->pdata[GPOINTER_TO_UINT(index)];
1058         BT_ASSERT_DBG(ret_field);
1059
1060 end:
1061         return ret_field;
1062 }
1063
1064 struct bt_field *bt_field_structure_borrow_member_field_by_name(
1065                 struct bt_field *field, const char *name)
1066 {
1067         return borrow_structure_field_member_field_by_name(field, name);
1068 }
1069
1070 const struct bt_field *bt_field_structure_borrow_member_field_by_name_const(
1071                 const struct bt_field *field, const char *name)
1072 {
1073         return borrow_structure_field_member_field_by_name(
1074                 (void *) field, name);
1075 }
1076
1077 void bt_field_option_set_has_field(struct bt_field *field, bt_bool has_field)
1078 {
1079         struct bt_field_option *opt_field = (void *) field;
1080
1081         BT_ASSERT_PRE_DEV_NON_NULL(field, "Field");
1082         BT_ASSERT_PRE_DEV_FIELD_IS_OPTION(field, "Field");
1083         BT_ASSERT_PRE_DEV_FIELD_HOT(field, "Field");
1084
1085         if (has_field) {
1086                 opt_field->selected_field = opt_field->content_field;
1087         } else {
1088                 opt_field->selected_field = NULL;
1089         }
1090 }
1091
1092 struct bt_field *bt_field_option_borrow_field(struct bt_field *field)
1093 {
1094         struct bt_field_option *opt_field = (void *) field;
1095
1096         BT_ASSERT_PRE_DEV_NON_NULL(field, "Field");
1097         BT_ASSERT_PRE_DEV_FIELD_IS_OPTION(field, "Field");
1098         return opt_field->selected_field;
1099 }
1100
1101 const struct bt_field *bt_field_option_borrow_field_const(
1102                 const struct bt_field *field)
1103 {
1104         return (const void *) bt_field_option_borrow_field((void *) field);
1105 }
1106
1107 static inline
1108 struct bt_field *borrow_variant_field_selected_option_field(
1109                 struct bt_field *field)
1110 {
1111         struct bt_field_variant *var_field = (void *) field;
1112
1113         BT_ASSERT_PRE_DEV_NON_NULL(field, "Field");
1114         BT_ASSERT_PRE_DEV_FIELD_IS_VARIANT(field, "Field");
1115         BT_ASSERT_PRE_DEV(var_field->selected_field,
1116                 "Variant field has no selected field: %!+f", field);
1117         return var_field->selected_field;
1118 }
1119
1120 struct bt_field *bt_field_variant_borrow_selected_option_field(
1121                 struct bt_field *field)
1122 {
1123         return borrow_variant_field_selected_option_field(field);
1124 }
1125
1126 const struct bt_field *bt_field_variant_borrow_selected_option_field_const(
1127                 const struct bt_field *field)
1128 {
1129         return borrow_variant_field_selected_option_field((void *) field);
1130 }
1131
1132 static
1133 const struct bt_field_class_variant_option *
1134 borrow_variant_field_selected_class_option(const struct bt_field *field)
1135 {
1136         const struct bt_field_class_named_field_class_container *container_fc;
1137         const struct bt_field_variant *var_field = (const void *) field;
1138
1139         BT_ASSERT_DBG(field);
1140         BT_ASSERT_PRE_DEV(var_field->selected_field,
1141                 "Variant field has no selected field: %!+f", field);
1142         container_fc = (const void *) field->class;
1143         return container_fc->named_fcs->pdata[var_field->selected_index];
1144 }
1145
1146 const struct bt_field_class_variant_option *
1147 bt_field_variant_borrow_selected_class_option_const(
1148                 const struct bt_field *field)
1149 {
1150         BT_ASSERT_PRE_DEV_NON_NULL(field, "Field");
1151         BT_ASSERT_PRE_DEV_FIELD_IS_VARIANT(field, "Field");
1152         return borrow_variant_field_selected_class_option(field);
1153 }
1154
1155 const struct bt_field_class_variant_with_selector_field_integer_unsigned_option *
1156 bt_field_variant_with_unsigned_integer_selector_borrow_selected_class_option_const(
1157                 const struct bt_field *field)
1158 {
1159         BT_ASSERT_PRE_DEV_NON_NULL(field, "Field");
1160         BT_ASSERT_PRE_DEV_FIELD_HAS_CLASS_TYPE(field,
1161                 BT_FIELD_CLASS_TYPE_VARIANT_WITH_UNSIGNED_INTEGER_SELECTOR_FIELD, "Field");
1162         return (const void *) borrow_variant_field_selected_class_option(field);
1163 }
1164
1165 const struct bt_field_class_variant_with_selector_field_integer_signed_option *
1166 bt_field_variant_with_signed_integer_selector_borrow_selected_class_option_const(
1167                 const struct bt_field *field)
1168 {
1169         BT_ASSERT_PRE_DEV_NON_NULL(field, "Field");
1170         BT_ASSERT_PRE_DEV_FIELD_HAS_CLASS_TYPE(field,
1171                 BT_FIELD_CLASS_TYPE_VARIANT_WITH_SIGNED_INTEGER_SELECTOR_FIELD, "Field");
1172         return (const void *) borrow_variant_field_selected_class_option(field);
1173 }
1174
1175 enum bt_field_variant_select_option_field_by_index_status
1176 bt_field_variant_select_option_field_by_index(
1177                 struct bt_field *field, uint64_t index)
1178 {
1179         struct bt_field_variant *var_field = (void *) field;
1180
1181         BT_ASSERT_PRE_DEV_NO_ERROR();
1182         BT_ASSERT_PRE_DEV_NON_NULL(field, "Field");
1183         BT_ASSERT_PRE_DEV_FIELD_IS_VARIANT(field, "Field");
1184         BT_ASSERT_PRE_DEV_FIELD_HOT(field, "Field");
1185         BT_ASSERT_PRE_DEV_VALID_INDEX(index, var_field->fields->len);
1186         var_field->selected_field = var_field->fields->pdata[index];
1187         var_field->selected_index = index;
1188         return BT_FUNC_STATUS_OK;
1189 }
1190
1191 uint64_t bt_field_variant_get_selected_option_field_index(
1192                 const struct bt_field *field)
1193 {
1194         const struct bt_field_variant *var_field = (const void *) field;
1195
1196         BT_ASSERT_PRE_DEV_NON_NULL(field, "Field");
1197         BT_ASSERT_PRE_DEV_FIELD_IS_VARIANT(field, "Field");
1198         BT_ASSERT_PRE_DEV(var_field->selected_field,
1199                 "Variant field has no selected field: %!+f", field);
1200         return var_field->selected_index;
1201 }
1202
1203 static inline
1204 void bt_field_finalize(struct bt_field *field)
1205 {
1206         BT_ASSERT(field);
1207         BT_LOGD_STR("Putting field's class.");
1208         BT_OBJECT_PUT_REF_AND_RESET(field->class);
1209 }
1210
1211 static
1212 void destroy_bool_field(struct bt_field *field)
1213 {
1214         BT_ASSERT(field);
1215         BT_LIB_LOGD("Destroying boolean field object: %!+f", field);
1216         bt_field_finalize(field);
1217         g_free(field);
1218 }
1219
1220 static
1221 void destroy_bit_array_field(struct bt_field *field)
1222 {
1223         BT_ASSERT(field);
1224         BT_LIB_LOGD("Destroying bit array field object: %!+f", field);
1225         bt_field_finalize(field);
1226         g_free(field);
1227 }
1228
1229 static
1230 void destroy_integer_field(struct bt_field *field)
1231 {
1232         BT_ASSERT(field);
1233         BT_LIB_LOGD("Destroying integer field object: %!+f", field);
1234         bt_field_finalize(field);
1235         g_free(field);
1236 }
1237
1238 static
1239 void destroy_real_field(struct bt_field *field)
1240 {
1241         BT_ASSERT(field);
1242         BT_LIB_LOGD("Destroying real field object: %!+f", field);
1243         bt_field_finalize(field);
1244         g_free(field);
1245 }
1246
1247 static
1248 void destroy_structure_field(struct bt_field *field)
1249 {
1250         struct bt_field_structure *struct_field = (void *) field;
1251
1252         BT_ASSERT(field);
1253         BT_LIB_LOGD("Destroying structure field object: %!+f", field);
1254         bt_field_finalize(field);
1255
1256         if (struct_field->fields) {
1257                 g_ptr_array_free(struct_field->fields, TRUE);
1258                 struct_field->fields = NULL;
1259         }
1260
1261         g_free(field);
1262 }
1263
1264 static
1265 void destroy_option_field(struct bt_field *field)
1266 {
1267         struct bt_field_option *opt_field = (void *) field;
1268
1269         BT_ASSERT(field);
1270         BT_LIB_LOGD("Destroying option field object: %!+f", field);
1271         bt_field_finalize(field);
1272
1273         if (opt_field->content_field) {
1274                 bt_field_destroy(opt_field->content_field);
1275         }
1276
1277         g_free(field);
1278 }
1279
1280 static
1281 void destroy_variant_field(struct bt_field *field)
1282 {
1283         struct bt_field_variant *var_field = (void *) field;
1284
1285         BT_ASSERT(field);
1286         BT_LIB_LOGD("Destroying variant field object: %!+f", field);
1287         bt_field_finalize(field);
1288
1289         if (var_field->fields) {
1290                 g_ptr_array_free(var_field->fields, TRUE);
1291                 var_field->fields = NULL;
1292         }
1293
1294         g_free(field);
1295 }
1296
1297 static
1298 void destroy_array_field(struct bt_field *field)
1299 {
1300         struct bt_field_array *array_field = (void *) field;
1301
1302         BT_ASSERT(field);
1303         BT_LIB_LOGD("Destroying array field object: %!+f", field);
1304         bt_field_finalize(field);
1305
1306         if (array_field->fields) {
1307                 g_ptr_array_free(array_field->fields, TRUE);
1308                 array_field->fields = NULL;
1309         }
1310
1311         g_free(field);
1312 }
1313
1314 static
1315 void destroy_string_field(struct bt_field *field)
1316 {
1317         struct bt_field_string *string_field = (void *) field;
1318
1319         BT_ASSERT(field);
1320         BT_LIB_LOGD("Destroying string field object: %!+f", field);
1321         bt_field_finalize(field);
1322
1323         if (string_field->buf) {
1324                 g_array_free(string_field->buf, TRUE);
1325                 string_field->buf = NULL;
1326         }
1327
1328         g_free(field);
1329 }
1330
1331 BT_HIDDEN
1332 void bt_field_destroy(struct bt_field *field)
1333 {
1334         BT_ASSERT(field);
1335
1336         switch (field->class->type) {
1337         case BT_FIELD_CLASS_TYPE_BOOL:
1338                 destroy_bool_field(field);
1339                 break;
1340         case BT_FIELD_CLASS_TYPE_BIT_ARRAY:
1341                 destroy_bit_array_field(field);
1342                 break;
1343         case BT_FIELD_CLASS_TYPE_UNSIGNED_INTEGER:
1344         case BT_FIELD_CLASS_TYPE_SIGNED_INTEGER:
1345         case BT_FIELD_CLASS_TYPE_UNSIGNED_ENUMERATION:
1346         case BT_FIELD_CLASS_TYPE_SIGNED_ENUMERATION:
1347                 destroy_integer_field(field);
1348                 break;
1349         case BT_FIELD_CLASS_TYPE_SINGLE_PRECISION_REAL:
1350         case BT_FIELD_CLASS_TYPE_DOUBLE_PRECISION_REAL:
1351                 destroy_real_field(field);
1352                 break;
1353         case BT_FIELD_CLASS_TYPE_STRING:
1354                 destroy_string_field(field);
1355                 break;
1356         case BT_FIELD_CLASS_TYPE_STRUCTURE:
1357                 destroy_structure_field(field);
1358                 break;
1359         case BT_FIELD_CLASS_TYPE_STATIC_ARRAY:
1360         case BT_FIELD_CLASS_TYPE_DYNAMIC_ARRAY_WITHOUT_LENGTH_FIELD:
1361         case BT_FIELD_CLASS_TYPE_DYNAMIC_ARRAY_WITH_LENGTH_FIELD:
1362                 destroy_array_field(field);
1363                 break;
1364         case BT_FIELD_CLASS_TYPE_OPTION_WITHOUT_SELECTOR_FIELD:
1365         case BT_FIELD_CLASS_TYPE_OPTION_WITH_BOOL_SELECTOR_FIELD:
1366         case BT_FIELD_CLASS_TYPE_OPTION_WITH_UNSIGNED_INTEGER_SELECTOR_FIELD:
1367         case BT_FIELD_CLASS_TYPE_OPTION_WITH_SIGNED_INTEGER_SELECTOR_FIELD:
1368                 destroy_option_field(field);
1369                 break;
1370         case BT_FIELD_CLASS_TYPE_VARIANT_WITHOUT_SELECTOR_FIELD:
1371         case BT_FIELD_CLASS_TYPE_VARIANT_WITH_UNSIGNED_INTEGER_SELECTOR_FIELD:
1372         case BT_FIELD_CLASS_TYPE_VARIANT_WITH_SIGNED_INTEGER_SELECTOR_FIELD:
1373                 destroy_variant_field(field);
1374                 break;
1375         default:
1376                 bt_common_abort();
1377         }
1378 }
1379
1380 static
1381 void reset_single_field(struct bt_field *field)
1382 {
1383         BT_ASSERT_DBG(field);
1384         field->is_set = false;
1385 }
1386
1387 static
1388 void reset_structure_field(struct bt_field *field)
1389 {
1390         uint64_t i;
1391         struct bt_field_structure *struct_field = (void *) field;
1392
1393         BT_ASSERT_DBG(field);
1394
1395         for (i = 0; i < struct_field->fields->len; i++) {
1396                 bt_field_reset(struct_field->fields->pdata[i]);
1397         }
1398 }
1399
1400 static
1401 void reset_option_field(struct bt_field *field)
1402 {
1403         struct bt_field_option *opt_field = (void *) field;
1404
1405         BT_ASSERT_DBG(opt_field);
1406         bt_field_reset(opt_field->content_field);
1407         opt_field->selected_field = NULL;
1408 }
1409
1410 static
1411 void reset_variant_field(struct bt_field *field)
1412 {
1413         uint64_t i;
1414         struct bt_field_variant *var_field = (void *) field;
1415
1416         BT_ASSERT_DBG(field);
1417
1418         for (i = 0; i < var_field->fields->len; i++) {
1419                 bt_field_reset(var_field->fields->pdata[i]);
1420         }
1421 }
1422
1423 static
1424 void reset_array_field(struct bt_field *field)
1425 {
1426         uint64_t i;
1427         struct bt_field_array *array_field = (void *) field;
1428
1429         BT_ASSERT_DBG(field);
1430
1431         for (i = 0; i < array_field->fields->len; i++) {
1432                 bt_field_reset(array_field->fields->pdata[i]);
1433         }
1434 }
1435
1436 static
1437 void set_single_field_is_frozen(struct bt_field *field, bool is_frozen)
1438 {
1439         field->frozen = is_frozen;
1440 }
1441
1442 static
1443 void set_structure_field_is_frozen(struct bt_field *field, bool is_frozen)
1444 {
1445         uint64_t i;
1446         struct bt_field_structure *struct_field = (void *) field;
1447
1448         BT_LIB_LOGD("Setting structure field's frozen state: "
1449                 "%![field-]+f, is-frozen=%d", field, is_frozen);
1450
1451         for (i = 0; i < struct_field->fields->len; i++) {
1452                 struct bt_field *member_field = struct_field->fields->pdata[i];
1453
1454                 BT_LIB_LOGD("Setting structure field's member field's "
1455                         "frozen state: %![field-]+f, index=%" PRIu64,
1456                         member_field, i);
1457                 _bt_field_set_is_frozen(member_field, is_frozen);
1458         }
1459
1460         set_single_field_is_frozen(field, is_frozen);
1461 }
1462
1463 static
1464 void set_option_field_is_frozen(struct bt_field *field, bool is_frozen)
1465 {
1466         struct bt_field_option *opt_field = (void *) field;
1467
1468         BT_LIB_LOGD("Setting option field's frozen state: "
1469                 "%![field-]+f, is-frozen=%d", field, is_frozen);
1470         _bt_field_set_is_frozen(opt_field->content_field, is_frozen);
1471         set_single_field_is_frozen(field, is_frozen);
1472 }
1473
1474 static
1475 void set_variant_field_is_frozen(struct bt_field *field, bool is_frozen)
1476 {
1477         uint64_t i;
1478         struct bt_field_variant *var_field = (void *) field;
1479
1480         BT_LIB_LOGD("Setting variant field's frozen state: "
1481                 "%![field-]+f, is-frozen=%d", field, is_frozen);
1482
1483         for (i = 0; i < var_field->fields->len; i++) {
1484                 struct bt_field *option_field = var_field->fields->pdata[i];
1485
1486                 BT_LIB_LOGD("Setting variant field's option field's "
1487                         "frozen state: %![field-]+f, index=%" PRIu64,
1488                         option_field, i);
1489                 _bt_field_set_is_frozen(option_field, is_frozen);
1490         }
1491
1492         set_single_field_is_frozen(field, is_frozen);
1493 }
1494
1495 static
1496 void set_array_field_is_frozen(struct bt_field *field, bool is_frozen)
1497 {
1498         uint64_t i;
1499         struct bt_field_array *array_field = (void *) field;
1500
1501         BT_LIB_LOGD("Setting array field's frozen state: "
1502                 "%![field-]+f, is-frozen=%d", field, is_frozen);
1503
1504         for (i = 0; i < array_field->fields->len; i++) {
1505                 struct bt_field *elem_field = array_field->fields->pdata[i];
1506
1507                 BT_LIB_LOGD("Setting array field's element field's "
1508                         "frozen state: %![field-]+f, index=%" PRIu64,
1509                         elem_field, i);
1510                 _bt_field_set_is_frozen(elem_field, is_frozen);
1511         }
1512
1513         set_single_field_is_frozen(field, is_frozen);
1514 }
1515
1516 BT_HIDDEN
1517 void _bt_field_set_is_frozen(const struct bt_field *field,
1518                 bool is_frozen)
1519 {
1520         BT_ASSERT_DBG(field);
1521         BT_LIB_LOGD("Setting field object's frozen state: %!+f, is-frozen=%d",
1522                 field, is_frozen);
1523         BT_ASSERT_DBG(field->methods->set_is_frozen);
1524         field->methods->set_is_frozen((void *) field, is_frozen);
1525 }
1526
1527 static
1528 bool single_field_is_set(const struct bt_field *field)
1529 {
1530         BT_ASSERT_DBG(field);
1531         return field->is_set;
1532 }
1533
1534 static
1535 bool structure_field_is_set(const struct bt_field *field)
1536 {
1537         bool is_set = true;
1538         uint64_t i;
1539         const struct bt_field_structure *struct_field = (const void *) field;
1540
1541         BT_ASSERT_DBG(field);
1542
1543         for (i = 0; i < struct_field->fields->len; i++) {
1544                 is_set = bt_field_is_set(struct_field->fields->pdata[i]);
1545                 if (!is_set) {
1546                         goto end;
1547                 }
1548         }
1549
1550 end:
1551         return is_set;
1552 }
1553
1554 static
1555 bool option_field_is_set(const struct bt_field *field)
1556 {
1557         const struct bt_field_option *opt_field = (const void *) field;
1558         bool is_set = false;
1559
1560         BT_ASSERT_DBG(field);
1561
1562         if (opt_field->selected_field) {
1563                 is_set = bt_field_is_set(opt_field->selected_field);
1564         }
1565
1566         return is_set;
1567 }
1568
1569 static
1570 bool variant_field_is_set(const struct bt_field *field)
1571 {
1572         const struct bt_field_variant *var_field = (const void *) field;
1573         bool is_set = false;
1574
1575         BT_ASSERT_DBG(field);
1576
1577         if (var_field->selected_field) {
1578                 is_set = bt_field_is_set(var_field->selected_field);
1579         }
1580
1581         return is_set;
1582 }
1583
1584 static
1585 bool array_field_is_set(const struct bt_field *field)
1586 {
1587         bool is_set = true;
1588         uint64_t i;
1589         const struct bt_field_array *array_field = (const void *) field;
1590
1591         BT_ASSERT_DBG(field);
1592
1593         for (i = 0; i < array_field->length; i++) {
1594                 is_set = bt_field_is_set(array_field->fields->pdata[i]);
1595                 if (!is_set) {
1596                         goto end;
1597                 }
1598         }
1599
1600 end:
1601         return is_set;
1602 }