src/lib/trace-ir/field-class.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-CLASS"
  25 #include "lib/logging.h"
  26
  27 #include "lib/assert-pre.h"
  28 #include <babeltrace2/trace-ir/field-class.h>
  29 #include <babeltrace2/trace-ir/field-class-const.h>
  30 #include <babeltrace2/trace-ir/field-const.h>
  31 #include <babeltrace2/trace-ir/field.h>
  32 #include <babeltrace2/trace-ir/clock-class.h>
  33 #include "lib/object.h"
  34 #include "compat/compiler.h"
  35 #include "compat/endian.h"
  36 #include "common/assert.h"
  37 #include "compat/glib.h"
  38 #include <float.h>
  39 #include <inttypes.h>
  40 #include <stdlib.h>
  41
  42 #include "clock-class.h"
  43 #include "field-class.h"
  44 #include "field.h"
  45 #include "field-path.h"
  46 #include "utils.h"
  47 #include "lib/func-status.h"
  48 #include "lib/integer-range-set.h"
  49 #include "lib/value.h"
  50
  51 enum bt_field_class_type bt_field_class_get_type(
  52                 const struct bt_field_class *fc)
  53 {
  54         BT_ASSERT_PRE_DEV_NON_NULL(fc, "Field class");
  55         return fc->type;
  56 }
  57
  58 static
  59 int init_field_class(struct bt_field_class *fc, enum bt_field_class_type type,
  60                 bt_object_release_func release_func)
  61 {
  62         int ret = 0;
  63
  64         BT_ASSERT(fc);
  65         BT_ASSERT(release_func);
  66         bt_object_init_shared(&fc->base, release_func);
  67         fc->type = type;
  68         fc->user_attributes = bt_value_map_create();
  69         if (!fc->user_attributes) {
  70                 BT_LIB_LOGE_APPEND_CAUSE(
  71                         "Failed to create a map value object.");
  72                 ret = -1;
  73                 goto end;
  74         }
  75
  76 end:
  77         return ret;
  78 }
  79
  80 static
  81 void finalize_field_class(struct bt_field_class *fc)
  82 {
  83         BT_OBJECT_PUT_REF_AND_RESET(fc->user_attributes);
  84 }
  85
  86 static
  87 void destroy_bit_array_field_class(struct bt_object *obj)
  88 {
  89         BT_ASSERT(obj);
  90         BT_LIB_LOGD("Destroying bit array field class object: %!+F", obj);
  91         finalize_field_class((void *) obj);
  92         g_free(obj);
  93 }
  94
  95 struct bt_field_class *bt_field_class_bit_array_create(
  96                 struct bt_trace_class *trace_class, uint64_t length)
  97 {
  98         struct bt_field_class_bit_array *ba_fc = NULL;
  99
 100         BT_ASSERT_PRE_NON_NULL(trace_class, "Trace class");
 101         BT_ASSERT_PRE(length > 0 && length <= 64,
 102                 "Unsupported length for bit array field class "
 103                 "(minimum is 1, maximum is 64): length=%" PRIu64, length);
 104         BT_LOGD("Creating default bit array field class object.");
 105         ba_fc = g_new0(struct bt_field_class_bit_array, 1);
 106         if (!ba_fc) {
 107                 BT_LIB_LOGE_APPEND_CAUSE(
 108                         "Failed to allocate one bit array field class.");
 109                 goto error;
 110         }
 111
 112         if (init_field_class((void *) ba_fc, BT_FIELD_CLASS_TYPE_BIT_ARRAY,
 113                         destroy_bit_array_field_class)) {
 114                 goto error;
 115         }
 116
 117         ba_fc->length = length;
 118         BT_LIB_LOGD("Created bit array field class object: %!+F", ba_fc);
 119         goto end;
 120
 121 error:
 122         BT_OBJECT_PUT_REF_AND_RESET(ba_fc);
 123
 124 end:
 125         return (void *) ba_fc;
 126 }
 127
 128 uint64_t bt_field_class_bit_array_get_length(const struct bt_field_class *fc)
 129 {
 130         const struct bt_field_class_bit_array *ba_fc = (const void *) fc;
 131
 132         BT_ASSERT_PRE_DEV_NON_NULL(fc, "Field class");
 133         BT_ASSERT_PRE_DEV_FC_HAS_ID(fc, BT_FIELD_CLASS_TYPE_BIT_ARRAY,
 134                 "Field class");
 135         return ba_fc->length;
 136 }
 137
 138 static
 139 void destroy_bool_field_class(struct bt_object *obj)
 140 {
 141         BT_ASSERT(obj);
 142         BT_LIB_LOGD("Destroying boolean field class object: %!+F", obj);
 143         finalize_field_class((void *) obj);
 144         g_free(obj);
 145 }
 146
 147 struct bt_field_class *bt_field_class_bool_create(
 148                 bt_trace_class *trace_class)
 149 {
 150         struct bt_field_class_bool *bool_fc = NULL;
 151
 152         BT_ASSERT_PRE_NON_NULL(trace_class, "Trace class");
 153         BT_LOGD("Creating default boolean field class object.");
 154         bool_fc = g_new0(struct bt_field_class_bool, 1);
 155         if (!bool_fc) {
 156                 BT_LIB_LOGE_APPEND_CAUSE(
 157                         "Failed to allocate one boolean field class.");
 158                 goto error;
 159         }
 160
 161         if (init_field_class((void *) bool_fc, BT_FIELD_CLASS_TYPE_BOOL,
 162                         destroy_bool_field_class)) {
 163                 goto error;
 164         }
 165
 166         BT_LIB_LOGD("Created boolean field class object: %!+F", bool_fc);
 167         goto end;
 168
 169 error:
 170         BT_OBJECT_PUT_REF_AND_RESET(bool_fc);
 171
 172 end:
 173         return (void *) bool_fc;
 174 }
 175
 176 static
 177 int init_integer_field_class(struct bt_field_class_integer *fc,
 178                 enum bt_field_class_type type,
 179                 bt_object_release_func release_func)
 180 {
 181         int ret;
 182
 183         ret = init_field_class((void *) fc, type, release_func);
 184         if (ret) {
 185                 goto end;
 186         }
 187
 188         fc->range = 64;
 189         fc->base = BT_FIELD_CLASS_INTEGER_PREFERRED_DISPLAY_BASE_DECIMAL;
 190
 191 end:
 192         return ret;
 193 }
 194
 195 static
 196 void destroy_integer_field_class(struct bt_object *obj)
 197 {
 198         BT_ASSERT(obj);
 199         BT_LIB_LOGD("Destroying integer field class object: %!+F", obj);
 200         finalize_field_class((void *) obj);
 201         g_free(obj);
 202 }
 203
 204 static inline
 205 struct bt_field_class *create_integer_field_class(bt_trace_class *trace_class,
 206                 enum bt_field_class_type type)
 207 {
 208         struct bt_field_class_integer *int_fc = NULL;
 209
 210         BT_ASSERT_PRE_NON_NULL(trace_class, "Trace class");
 211         BT_LOGD("Creating default integer field class object: type=%s",
 212                 bt_common_field_class_type_string(type));
 213         int_fc = g_new0(struct bt_field_class_integer, 1);
 214         if (!int_fc) {
 215                 BT_LIB_LOGE_APPEND_CAUSE(
 216                         "Failed to allocate one integer field class.");
 217                 goto error;
 218         }
 219
 220         if (init_integer_field_class(int_fc, type,
 221                         destroy_integer_field_class)) {
 222                 goto error;
 223         }
 224
 225         BT_LIB_LOGD("Created integer field class object: %!+F", int_fc);
 226         goto end;
 227
 228 error:
 229         BT_OBJECT_PUT_REF_AND_RESET(int_fc);
 230
 231 end:
 232         return (void *) int_fc;
 233 }
 234
 235 struct bt_field_class *bt_field_class_integer_unsigned_create(
 236                 bt_trace_class *trace_class)
 237 {
 238         return create_integer_field_class(trace_class,
 239                 BT_FIELD_CLASS_TYPE_UNSIGNED_INTEGER);
 240 }
 241
 242 struct bt_field_class *bt_field_class_integer_signed_create(
 243                 bt_trace_class *trace_class)
 244 {
 245         return create_integer_field_class(trace_class,
 246                 BT_FIELD_CLASS_TYPE_SIGNED_INTEGER);
 247 }
 248
 249 uint64_t bt_field_class_integer_get_field_value_range(
 250                 const struct bt_field_class *fc)
 251 {
 252         const struct bt_field_class_integer *int_fc = (const void *) fc;
 253
 254         BT_ASSERT_PRE_DEV_NON_NULL(fc, "Field class");
 255         BT_ASSERT_PRE_DEV_FC_IS_INT(fc, "Field class");
 256         return int_fc->range;
 257 }
 258
 259 static
 260 bool size_is_valid_for_enumeration_field_class(struct bt_field_class *fc,
 261                 uint64_t size)
 262 {
 263         // TODO
 264         return true;
 265 }
 266
 267 void bt_field_class_integer_set_field_value_range(
 268                 struct bt_field_class *fc, uint64_t size)
 269 {
 270         struct bt_field_class_integer *int_fc = (void *) fc;
 271
 272         BT_ASSERT_PRE_NON_NULL(fc, "Field class");
 273         BT_ASSERT_PRE_FC_IS_INT(fc, "Field class");
 274         BT_ASSERT_PRE_DEV_FC_HOT(fc, "Field class");
 275         BT_ASSERT_PRE(size <= 64,
 276                 "Unsupported size for integer field class's field value range "
 277                 "(maximum is 64): size=%" PRIu64, size);
 278         BT_ASSERT_PRE(
 279                 int_fc->common.type == BT_FIELD_CLASS_TYPE_UNSIGNED_INTEGER ||
 280                 int_fc->common.type == BT_FIELD_CLASS_TYPE_SIGNED_INTEGER ||
 281                 size_is_valid_for_enumeration_field_class(fc, size),
 282                 "Invalid field value range for enumeration field class: "
 283                 "at least one of the current mapping ranges contains values "
 284                 "which are outside this range: %!+F, size=%" PRIu64, fc, size);
 285         int_fc->range = size;
 286         BT_LIB_LOGD("Set integer field class's field value range: %!+F", fc);
 287 }
 288
 289 enum bt_field_class_integer_preferred_display_base
 290 bt_field_class_integer_get_preferred_display_base(const struct bt_field_class *fc)
 291 {
 292         const struct bt_field_class_integer *int_fc = (const void *) fc;
 293
 294         BT_ASSERT_PRE_DEV_NON_NULL(fc, "Field class");
 295         BT_ASSERT_PRE_DEV_FC_IS_INT(fc, "Field class");
 296         return int_fc->base;
 297 }
 298
 299 void bt_field_class_integer_set_preferred_display_base(
 300                 struct bt_field_class *fc,
 301                 enum bt_field_class_integer_preferred_display_base base)
 302 {
 303         struct bt_field_class_integer *int_fc = (void *) fc;
 304
 305         BT_ASSERT_PRE_NON_NULL(fc, "Field class");
 306         BT_ASSERT_PRE_FC_IS_INT(fc, "Field class");
 307         BT_ASSERT_PRE_DEV_FC_HOT(fc, "Field class");
 308         int_fc->base = base;
 309         BT_LIB_LOGD("Set integer field class's preferred display base: %!+F", fc);
 310 }
 311
 312 static
 313 void finalize_enumeration_field_class_mapping(
 314                 struct bt_field_class_enumeration_mapping *mapping)
 315 {
 316         BT_ASSERT(mapping);
 317
 318         if (mapping->label) {
 319                 g_string_free(mapping->label, TRUE);
 320                 mapping->label = NULL;
 321         }
 322
 323         BT_OBJECT_PUT_REF_AND_RESET(mapping->range_set);
 324 }
 325
 326 static
 327 void destroy_enumeration_field_class(struct bt_object *obj)
 328 {
 329         struct bt_field_class_enumeration *fc = (void *) obj;
 330
 331         BT_ASSERT(fc);
 332         BT_LIB_LOGD("Destroying enumeration field class object: %!+F", fc);
 333         finalize_field_class((void *) obj);
 334
 335         if (fc->mappings) {
 336                 uint64_t i;
 337
 338                 for (i = 0; i < fc->mappings->len; i++) {
 339                         finalize_enumeration_field_class_mapping(
 340                                 BT_FIELD_CLASS_ENUM_MAPPING_AT_INDEX(fc, i));
 341                 }
 342
 343                 g_array_free(fc->mappings, TRUE);
 344                 fc->mappings = NULL;
 345         }
 346
 347         if (fc->label_buf) {
 348                 g_ptr_array_free(fc->label_buf, TRUE);
 349                 fc->label_buf = NULL;
 350         }
 351
 352         g_free(fc);
 353 }
 354
 355 static
 356 struct bt_field_class *create_enumeration_field_class(
 357                 bt_trace_class *trace_class, enum bt_field_class_type type)
 358 {
 359         struct bt_field_class_enumeration *enum_fc = NULL;
 360
 361         BT_ASSERT_PRE_NON_NULL(trace_class, "Trace class");
 362         BT_LOGD("Creating default enumeration field class object: type=%s",
 363                 bt_common_field_class_type_string(type));
 364         enum_fc = g_new0(struct bt_field_class_enumeration, 1);
 365         if (!enum_fc) {
 366                 BT_LIB_LOGE_APPEND_CAUSE(
 367                         "Failed to allocate one enumeration field class.");
 368                 goto error;
 369         }
 370
 371         if (init_integer_field_class((void *) enum_fc, type,
 372                         destroy_enumeration_field_class)) {
 373                 goto error;
 374         }
 375
 376         enum_fc->mappings = g_array_new(FALSE, TRUE,
 377                 sizeof(struct bt_field_class_enumeration_mapping));
 378         if (!enum_fc->mappings) {
 379                 BT_LIB_LOGE_APPEND_CAUSE("Failed to allocate a GArray.");
 380                 goto error;
 381         }
 382
 383         enum_fc->label_buf = g_ptr_array_new();
 384         if (!enum_fc->label_buf) {
 385                 BT_LIB_LOGE_APPEND_CAUSE("Failed to allocate a GArray.");
 386                 goto error;
 387         }
 388
 389         BT_LIB_LOGD("Created enumeration field class object: %!+F", enum_fc);
 390         goto end;
 391
 392 error:
 393         BT_OBJECT_PUT_REF_AND_RESET(enum_fc);
 394
 395 end:
 396         return (void *) enum_fc;
 397 }
 398
 399 struct bt_field_class *bt_field_class_enumeration_unsigned_create(
 400                 bt_trace_class *trace_class)
 401 {
 402         return create_enumeration_field_class(trace_class,
 403                 BT_FIELD_CLASS_TYPE_UNSIGNED_ENUMERATION);
 404 }
 405
 406 struct bt_field_class *bt_field_class_enumeration_signed_create(
 407                 bt_trace_class *trace_class)
 408 {
 409         return create_enumeration_field_class(trace_class,
 410                 BT_FIELD_CLASS_TYPE_SIGNED_ENUMERATION);
 411 }
 412
 413 uint64_t bt_field_class_enumeration_get_mapping_count(
 414                 const struct bt_field_class *fc)
 415 {
 416         const struct bt_field_class_enumeration *enum_fc = (const void *) fc;
 417
 418         BT_ASSERT_PRE_DEV_NON_NULL(fc, "Field class");
 419         BT_ASSERT_PRE_DEV_FC_IS_ENUM(fc, "Field class");
 420         return (uint64_t) enum_fc->mappings->len;
 421 }
 422
 423 const struct bt_field_class_enumeration_unsigned_mapping *
 424 bt_field_class_enumeration_unsigned_borrow_mapping_by_index_const(
 425                 const struct bt_field_class *fc, uint64_t index)
 426 {
 427         const struct bt_field_class_enumeration *enum_fc = (const void *) fc;
 428
 429         BT_ASSERT_PRE_DEV_NON_NULL(fc, "Field class");
 430         BT_ASSERT_PRE_DEV_VALID_INDEX(index, enum_fc->mappings->len);
 431         BT_ASSERT_PRE_DEV_FC_HAS_ID(fc, BT_FIELD_CLASS_TYPE_UNSIGNED_ENUMERATION,
 432                 "Field class");
 433         return (const void *) BT_FIELD_CLASS_ENUM_MAPPING_AT_INDEX(fc, index);
 434 }
 435
 436 const struct bt_field_class_enumeration_signed_mapping *
 437 bt_field_class_enumeration_signed_borrow_mapping_by_index_const(
 438                 const struct bt_field_class *fc, uint64_t index)
 439 {
 440         const struct bt_field_class_enumeration *enum_fc = (const void *) fc;
 441
 442         BT_ASSERT_PRE_DEV_NON_NULL(fc, "Field class");
 443         BT_ASSERT_PRE_DEV_VALID_INDEX(index, enum_fc->mappings->len);
 444         BT_ASSERT_PRE_DEV_FC_HAS_ID(fc, BT_FIELD_CLASS_TYPE_SIGNED_ENUMERATION,
 445                 "Field class");
 446         return (const void *) BT_FIELD_CLASS_ENUM_MAPPING_AT_INDEX(fc, index);
 447 }
 448
 449 static
 450 const struct bt_field_class_enumeration_mapping *
 451 borrow_enumeration_field_class_mapping_by_label(
 452                 const struct bt_field_class_enumeration *fc, const char *label)
 453 {
 454         struct bt_field_class_enumeration_mapping *mapping = NULL;
 455         uint64_t i;
 456
 457         BT_ASSERT(fc);
 458         BT_ASSERT_PRE_DEV_NON_NULL(label, "Label");
 459
 460         for (i = 0; i < fc->mappings->len; i++) {
 461                 struct bt_field_class_enumeration_mapping *this_mapping =
 462                         BT_FIELD_CLASS_ENUM_MAPPING_AT_INDEX(fc, i);
 463
 464                 if (strcmp(this_mapping->label->str, label) == 0) {
 465                         mapping = this_mapping;
 466                         goto end;
 467                 }
 468         }
 469
 470 end:
 471         return mapping;
 472 }
 473
 474 const struct bt_field_class_enumeration_signed_mapping *
 475 bt_field_class_enumeration_signed_borrow_mapping_by_label_const(
 476                 const struct bt_field_class *fc, const char *label)
 477 {
 478         BT_ASSERT_PRE_DEV_NON_NULL(fc, "Field class");
 479         BT_ASSERT_PRE_DEV_FC_HAS_ID(fc, BT_FIELD_CLASS_TYPE_SIGNED_ENUMERATION,
 480                 "Field class");
 481         return (const void *) borrow_enumeration_field_class_mapping_by_label(
 482                 (const void *) fc, label);
 483 }
 484
 485 const struct bt_field_class_enumeration_unsigned_mapping *
 486 bt_field_class_enumeration_unsigned_borrow_mapping_by_label_const(
 487                 const struct bt_field_class *fc, const char *label)
 488 {
 489         BT_ASSERT_PRE_DEV_NON_NULL(fc, "Field class");
 490         BT_ASSERT_PRE_DEV_FC_HAS_ID(fc,
 491                 BT_FIELD_CLASS_TYPE_UNSIGNED_ENUMERATION, "Field class");
 492         return (const void *) borrow_enumeration_field_class_mapping_by_label(
 493                 (const void *) fc, label);
 494 }
 495
 496 const char *bt_field_class_enumeration_mapping_get_label(
 497                 const struct bt_field_class_enumeration_mapping *mapping)
 498 {
 499         BT_ASSERT_PRE_DEV_NON_NULL(mapping, "Enumeration field class mapping");
 500         return mapping->label->str;
 501 }
 502
 503 const struct bt_integer_range_set_unsigned *
 504 bt_field_class_enumeration_unsigned_mapping_borrow_ranges_const(
 505                 const struct bt_field_class_enumeration_unsigned_mapping *u_mapping)
 506 {
 507         const struct bt_field_class_enumeration_mapping *mapping =
 508                 (const void *) u_mapping;
 509
 510         BT_ASSERT_PRE_DEV_NON_NULL(mapping, "Enumeration field class mapping");
 511         return (const void *) mapping->range_set;
 512 }
 513
 514 const struct bt_integer_range_set_signed *
 515 bt_field_class_enumeration_signed_mapping_borrow_ranges_const(
 516                 const struct bt_field_class_enumeration_signed_mapping *s_mapping)
 517 {
 518         const struct bt_field_class_enumeration_mapping *mapping =
 519                 (const void *) s_mapping;
 520
 521         BT_ASSERT_PRE_DEV_NON_NULL(mapping, "Enumeration field class mapping");
 522         return (const void *) mapping->range_set;
 523 }
 524
 525 enum bt_field_class_enumeration_get_mapping_labels_for_value_status
 526 bt_field_class_enumeration_unsigned_get_mapping_labels_for_value(
 527                 const struct bt_field_class *fc, uint64_t value,
 528                 bt_field_class_enumeration_mapping_label_array *label_array,
 529                 uint64_t *count)
 530 {
 531         const struct bt_field_class_enumeration *enum_fc = (const void *) fc;
 532         uint64_t i;
 533
 534         BT_ASSERT_PRE_DEV_NON_NULL(fc, "Field class");
 535         BT_ASSERT_PRE_DEV_NON_NULL(label_array, "Label array (output)");
 536         BT_ASSERT_PRE_DEV_NON_NULL(count, "Count (output)");
 537         BT_ASSERT_PRE_DEV_FC_HAS_ID(fc, BT_FIELD_CLASS_TYPE_UNSIGNED_ENUMERATION,
 538                 "Field class");
 539         g_ptr_array_set_size(enum_fc->label_buf, 0);
 540
 541         for (i = 0; i < enum_fc->mappings->len; i++) {
 542                 uint64_t j;
 543                 const struct bt_field_class_enumeration_mapping *mapping =
 544                         BT_FIELD_CLASS_ENUM_MAPPING_AT_INDEX(enum_fc, i);
 545
 546                 for (j = 0; j < mapping->range_set->ranges->len; j++) {
 547                         const struct bt_integer_range *range = (const void *)
 548                                 BT_INTEGER_RANGE_SET_RANGE_AT_INDEX(
 549                                         mapping->range_set, j);
 550
 551                         if (value >= range->lower.u &&
 552                                         value <= range->upper.u) {
 553                                 g_ptr_array_add(enum_fc->label_buf,
 554                                         mapping->label->str);
 555                                 break;
 556                         }
 557                 }
 558         }
 559
 560         *label_array = (void *) enum_fc->label_buf->pdata;
 561         *count = (uint64_t) enum_fc->label_buf->len;
 562         return BT_FUNC_STATUS_OK;
 563 }
 564
 565 enum bt_field_class_enumeration_get_mapping_labels_for_value_status
 566 bt_field_class_enumeration_signed_get_mapping_labels_for_value(
 567                 const struct bt_field_class *fc, int64_t value,
 568                 bt_field_class_enumeration_mapping_label_array *label_array,
 569                 uint64_t *count)
 570 {
 571         const struct bt_field_class_enumeration *enum_fc = (const void *) fc;
 572         uint64_t i;
 573
 574         BT_ASSERT_PRE_DEV_NON_NULL(fc, "Field class");
 575         BT_ASSERT_PRE_DEV_NON_NULL(label_array, "Label array (output)");
 576         BT_ASSERT_PRE_DEV_NON_NULL(count, "Count (output)");
 577         BT_ASSERT_PRE_DEV_FC_HAS_ID(fc, BT_FIELD_CLASS_TYPE_SIGNED_ENUMERATION,
 578                 "Field class");
 579         g_ptr_array_set_size(enum_fc->label_buf, 0);
 580
 581         for (i = 0; i < enum_fc->mappings->len; i++) {
 582                 uint64_t j;
 583                 const struct bt_field_class_enumeration_mapping *mapping =
 584                         BT_FIELD_CLASS_ENUM_MAPPING_AT_INDEX(enum_fc, i);
 585
 586                 for (j = 0; j < mapping->range_set->ranges->len; j++) {
 587                         const struct bt_integer_range *range = (const void *)
 588                                 BT_INTEGER_RANGE_SET_RANGE_AT_INDEX(
 589                                         mapping->range_set, j);
 590
 591                         if (value >= range->lower.i &&
 592                                         value <= range->upper.i) {
 593                                 g_ptr_array_add(enum_fc->label_buf,
 594                                         mapping->label->str);
 595                                 break;
 596                         }
 597                 }
 598         }
 599
 600         *label_array = (void *) enum_fc->label_buf->pdata;
 601         *count = (uint64_t) enum_fc->label_buf->len;
 602         return BT_FUNC_STATUS_OK;
 603 }
 604
 605 static
 606 bool enumeration_field_class_has_mapping_with_label(
 607                 const struct bt_field_class_enumeration *enum_fc,
 608                 const char *label)
 609 {
 610         uint64_t i;
 611         bool exists = false;
 612
 613         BT_ASSERT(enum_fc);
 614         BT_ASSERT(label);
 615
 616         for (i = 0; i < enum_fc->mappings->len; i++) {
 617                 struct bt_field_class_enumeration_mapping *mapping_candidate =
 618                         BT_FIELD_CLASS_ENUM_MAPPING_AT_INDEX(enum_fc, i);
 619
 620                 if (strcmp(mapping_candidate->label->str, label) == 0) {
 621                         exists = true;
 622                         goto end;
 623                 }
 624         }
 625
 626 end:
 627         return exists;
 628 }
 629
 630 static inline
 631 enum bt_field_class_enumeration_add_mapping_status
 632 add_mapping_to_enumeration_field_class(struct bt_field_class *fc,
 633                 const char *label, const struct bt_integer_range_set *range_set)
 634 {
 635         enum bt_field_class_enumeration_add_mapping_status status =
 636                 BT_FUNC_STATUS_OK;
 637         struct bt_field_class_enumeration *enum_fc = (void *) fc;
 638         struct bt_field_class_enumeration_mapping mapping = { 0 };
 639
 640         BT_ASSERT(fc);
 641         BT_ASSERT_PRE_NON_NULL(label, "Label");
 642         BT_ASSERT_PRE_NON_NULL(range_set, "Integer range set");
 643         BT_ASSERT_PRE(!enumeration_field_class_has_mapping_with_label(
 644                 enum_fc, label),
 645                 "Duplicate mapping name in enumeration field class: "
 646                 "%![enum-fc-]+F, label=\"%s\"", fc, label);
 647         mapping.range_set = range_set;
 648         bt_object_get_ref(mapping.range_set);
 649         mapping.label = g_string_new(label);
 650         if (!mapping.label) {
 651                 finalize_enumeration_field_class_mapping(&mapping);
 652                 status = BT_FUNC_STATUS_MEMORY_ERROR;
 653                 goto end;
 654         }
 655
 656         g_array_append_val(enum_fc->mappings, mapping);
 657         BT_LIB_LOGD("Added mapping to enumeration field class: "
 658                 "%![fc-]+F, label=\"%s\"", fc, label);
 659
 660 end:
 661         return status;
 662 }
 663
 664 enum bt_field_class_enumeration_add_mapping_status
 665 bt_field_class_enumeration_unsigned_add_mapping(
 666                 struct bt_field_class *fc, const char *label,
 667                 const struct bt_integer_range_set_unsigned *range_set)
 668 {
 669         BT_ASSERT_PRE_NON_NULL(fc, "Field class");
 670         BT_ASSERT_PRE_FC_HAS_ID(fc, BT_FIELD_CLASS_TYPE_UNSIGNED_ENUMERATION,
 671                 "Field class");
 672         return add_mapping_to_enumeration_field_class(fc, label,
 673                 (const void *) range_set);
 674 }
 675
 676 enum bt_field_class_enumeration_add_mapping_status
 677 bt_field_class_enumeration_signed_add_mapping(
 678                 struct bt_field_class *fc, const char *label,
 679                 const struct bt_integer_range_set_signed *range_set)
 680 {
 681         BT_ASSERT_PRE_NON_NULL(fc, "Field class");
 682         BT_ASSERT_PRE_FC_HAS_ID(fc, BT_FIELD_CLASS_TYPE_SIGNED_ENUMERATION,
 683                 "Field class");
 684         return add_mapping_to_enumeration_field_class(fc, label,
 685                 (const void *) range_set);
 686 }
 687
 688 static
 689 void destroy_real_field_class(struct bt_object *obj)
 690 {
 691         BT_ASSERT(obj);
 692         BT_LIB_LOGD("Destroying real field class object: %!+F", obj);
 693         finalize_field_class((void *) obj);
 694         g_free(obj);
 695 }
 696
 697 static
 698 struct bt_field_class *create_real_field_class(bt_trace_class *trace_class,
 699                 enum bt_field_class_type type)
 700 {
 701         struct bt_field_class_real *real_fc = NULL;
 702
 703         BT_ASSERT_PRE_NON_NULL(trace_class, "Trace class");
 704         BT_LOGD("Creating default real field class object: type=%s",
 705                 bt_common_field_class_type_string(type));
 706         real_fc = g_new0(struct bt_field_class_real, 1);
 707         if (!real_fc) {
 708                 BT_LIB_LOGE_APPEND_CAUSE("Failed to allocate one real field class.");
 709                 goto error;
 710         }
 711
 712         if (init_field_class((void *) real_fc, type, destroy_real_field_class)) {
 713                 goto error;
 714         }
 715
 716         BT_LIB_LOGD("Created real field class object: %!+F", real_fc);
 717         goto end;
 718
 719 error:
 720         BT_OBJECT_PUT_REF_AND_RESET(real_fc);
 721
 722 end:
 723         return (void *) real_fc;
 724 }
 725
 726 struct bt_field_class *bt_field_class_real_single_precision_create(
 727         bt_trace_class *trace_class)
 728 {
 729         return create_real_field_class(trace_class,
 730                 BT_FIELD_CLASS_TYPE_SINGLE_PRECISION_REAL);
 731 }
 732
 733 struct bt_field_class *bt_field_class_real_double_precision_create(
 734         bt_trace_class *trace_class)
 735 {
 736         return create_real_field_class(trace_class,
 737                 BT_FIELD_CLASS_TYPE_DOUBLE_PRECISION_REAL);
 738 }
 739
 740 static
 741 int init_named_field_classes_container(
 742                 struct bt_field_class_named_field_class_container *fc,
 743                 enum bt_field_class_type type,
 744                 bt_object_release_func fc_release_func,
 745                 GDestroyNotify named_fc_destroy_func)
 746 {
 747         int ret = 0;
 748
 749         ret = init_field_class((void *) fc, type, fc_release_func);
 750         if (ret) {
 751                 goto end;
 752         }
 753
 754         fc->named_fcs = g_ptr_array_new_with_free_func(named_fc_destroy_func);
 755         if (!fc->named_fcs) {
 756                 BT_LIB_LOGE_APPEND_CAUSE("Failed to allocate a GPtrArray.");
 757                 ret = -1;
 758                 goto end;
 759         }
 760
 761         fc->name_to_index = g_hash_table_new(g_str_hash, g_str_equal);
 762         if (!fc->name_to_index) {
 763                 BT_LIB_LOGE_APPEND_CAUSE("Failed to allocate a GHashTable.");
 764                 ret = -1;
 765                 goto end;
 766         }
 767
 768 end:
 769         return ret;
 770 }
 771
 772 static
 773 void finalize_named_field_class(struct bt_named_field_class *named_fc)
 774 {
 775         BT_ASSERT(named_fc);
 776         BT_LIB_LOGD("Finalizing named field class: "
 777                 "addr=%p, name=\"%s\", %![fc-]+F",
 778                 named_fc, named_fc->name ? named_fc->name->str : NULL,
 779                 named_fc->fc);
 780         BT_OBJECT_PUT_REF_AND_RESET(named_fc->user_attributes);
 781
 782         if (named_fc->name) {
 783                 g_string_free(named_fc->name, TRUE);
 784                 named_fc->name = NULL;
 785         }
 786
 787         BT_LOGD_STR("Putting named field class's field class.");
 788         BT_OBJECT_PUT_REF_AND_RESET(named_fc->fc);
 789 }
 790
 791 static
 792 void destroy_named_field_class(gpointer ptr)
 793 {
 794         struct bt_named_field_class *named_fc = ptr;
 795
 796         if (ptr) {
 797                 BT_OBJECT_PUT_REF_AND_RESET(named_fc->user_attributes);
 798                 finalize_named_field_class(ptr);
 799                 g_free(ptr);
 800         }
 801 }
 802
 803 static
 804 void destroy_variant_with_selector_option(gpointer ptr)
 805 {
 806         struct bt_field_class_variant_with_selector_option *opt = ptr;
 807
 808         if (ptr) {
 809                 finalize_named_field_class(&opt->common);
 810                 BT_OBJECT_PUT_REF_AND_RESET(opt->range_set);
 811                 g_free(ptr);
 812         }
 813 }
 814
 815 static
 816 void finalize_named_field_classes_container(
 817                 struct bt_field_class_named_field_class_container *fc)
 818 {
 819         BT_ASSERT(fc);
 820
 821         if (fc->named_fcs) {
 822                 g_ptr_array_free(fc->named_fcs, TRUE);
 823                 fc->named_fcs = NULL;
 824
 825         }
 826
 827         if (fc->name_to_index) {
 828                 g_hash_table_destroy(fc->name_to_index);
 829                 fc->name_to_index = NULL;
 830         }
 831 }
 832
 833 static
 834 void destroy_structure_field_class(struct bt_object *obj)
 835 {
 836         BT_ASSERT(obj);
 837         BT_LIB_LOGD("Destroying structure field class object: %!+F", obj);
 838         finalize_field_class((void *) obj);
 839         finalize_named_field_classes_container((void *) obj);
 840         g_free(obj);
 841 }
 842
 843 struct bt_field_class *bt_field_class_structure_create(
 844                 bt_trace_class *trace_class)
 845 {
 846         int ret;
 847         struct bt_field_class_structure *struct_fc = NULL;
 848
 849         BT_ASSERT_PRE_NON_NULL(trace_class, "Trace class");
 850         BT_LOGD_STR("Creating default structure field class object.");
 851         struct_fc = g_new0(struct bt_field_class_structure, 1);
 852         if (!struct_fc) {
 853                 BT_LIB_LOGE_APPEND_CAUSE(
 854                         "Failed to allocate one structure field class.");
 855                 goto error;
 856         }
 857
 858         ret = init_named_field_classes_container((void *) struct_fc,
 859                 BT_FIELD_CLASS_TYPE_STRUCTURE, destroy_structure_field_class,
 860                 destroy_named_field_class);
 861         if (ret) {
 862                 /* init_named_field_classes_container() logs errors */
 863                 goto error;
 864         }
 865
 866         BT_LIB_LOGD("Created structure field class object: %!+F", struct_fc);
 867         goto end;
 868
 869 error:
 870         BT_OBJECT_PUT_REF_AND_RESET(struct_fc);
 871
 872 end:
 873         return (void *) struct_fc;
 874 }
 875
 876 static
 877 int init_named_field_class(struct bt_named_field_class *named_fc,
 878                 const char *name, struct bt_field_class *fc)
 879 {
 880         int status = BT_FUNC_STATUS_OK;
 881
 882         BT_ASSERT(named_fc);
 883         BT_ASSERT(name);
 884         BT_ASSERT(fc);
 885         named_fc->name = g_string_new(name);
 886         if (!named_fc->name) {
 887                 BT_LIB_LOGE_APPEND_CAUSE("Failed to allocate a GString.");
 888                 status = BT_FUNC_STATUS_MEMORY_ERROR;
 889                 goto end;
 890         }
 891
 892         named_fc->user_attributes = bt_value_map_create();
 893         if (!named_fc->user_attributes) {
 894                 BT_LIB_LOGE_APPEND_CAUSE(
 895                         "Failed to create a map value object.");
 896                 status = BT_FUNC_STATUS_MEMORY_ERROR;
 897                 goto end;
 898         }
 899
 900         named_fc->fc = fc;
 901         bt_object_get_ref_no_null_check(named_fc->fc);
 902
 903 end:
 904         return status;
 905 }
 906
 907 static
 908 struct bt_named_field_class *create_named_field_class(const char *name,
 909                 struct bt_field_class *fc)
 910 {
 911         struct bt_named_field_class *named_fc = g_new0(
 912                 struct bt_named_field_class, 1);
 913
 914         if (!named_fc) {
 915                 BT_LIB_LOGE_APPEND_CAUSE(
 916                         "Failed to allocate a named field class.");
 917                 goto error;
 918         }
 919
 920         if (init_named_field_class(named_fc, name, fc)) {
 921                 /* init_named_field_class() logs errors */
 922                 goto error;
 923         }
 924
 925         goto end;
 926
 927 error:
 928         destroy_named_field_class(named_fc);
 929         named_fc = NULL;
 930
 931 end:
 932         return named_fc;
 933 }
 934
 935 static
 936 struct bt_field_class_variant_with_selector_option *
 937 create_variant_with_selector_option(
 938                 const char *name, struct bt_field_class *fc,
 939                 const struct bt_integer_range_set *range_set)
 940 {
 941         struct bt_field_class_variant_with_selector_option *opt = g_new0(
 942                 struct bt_field_class_variant_with_selector_option, 1);
 943
 944         BT_ASSERT(range_set);
 945
 946         if (!opt) {
 947                 BT_LIB_LOGE_APPEND_CAUSE(
 948                         "Failed to allocate a named field class.");
 949                 goto error;
 950         }
 951
 952         if (init_named_field_class(&opt->common, name, fc)) {
 953                 goto error;
 954         }
 955
 956         opt->range_set = range_set;
 957         bt_object_get_ref_no_null_check(opt->range_set);
 958         bt_integer_range_set_freeze(range_set);
 959         goto end;
 960
 961 error:
 962         destroy_variant_with_selector_option(opt);
 963         opt = NULL;
 964
 965 end:
 966         return opt;
 967 }
 968
 969 static
 970 int append_named_field_class_to_container_field_class(
 971                 struct bt_field_class_named_field_class_container *container_fc,
 972                 struct bt_named_field_class *named_fc)
 973 {
 974         BT_ASSERT(container_fc);
 975         BT_ASSERT(named_fc);
 976         BT_ASSERT_PRE_DEV_FC_HOT(container_fc, "Field class");
 977         BT_ASSERT_PRE(!bt_g_hash_table_contains(container_fc->name_to_index,
 978                 named_fc->name->str),
 979                 "Duplicate member/option name in structure/variant field class: "
 980                 "%![container-fc-]+F, name=\"%s\"", container_fc,
 981                 named_fc->name->str);
 982
 983         /*
 984          * Freeze the contained field class, but not the named field
 985          * class itself, as it's still possible afterwards to modify
 986          * properties of the member/option object.
 987          */
 988         bt_field_class_freeze(named_fc->fc);
 989         g_ptr_array_add(container_fc->named_fcs, named_fc);
 990         g_hash_table_insert(container_fc->name_to_index, named_fc->name->str,
 991                 GUINT_TO_POINTER(container_fc->named_fcs->len - 1));
 992         return BT_FUNC_STATUS_OK;
 993 }
 994
 995 enum bt_field_class_structure_append_member_status
 996 bt_field_class_structure_append_member(
 997                 struct bt_field_class *fc, const char *name,
 998                 struct bt_field_class *member_fc)
 999 {
1000         enum bt_field_class_structure_append_member_status status;
1001         struct bt_named_field_class *named_fc = NULL;
1002
1003         BT_ASSERT_PRE_NON_NULL(fc, "Field class");
1004         BT_ASSERT_PRE_FC_HAS_ID(fc, BT_FIELD_CLASS_TYPE_STRUCTURE,
1005                 "Field class");
1006         named_fc = create_named_field_class(name, member_fc);
1007         if (!named_fc) {
1008                 /* create_named_field_class() logs errors */
1009                 status = BT_FUNC_STATUS_MEMORY_ERROR;
1010                 goto end;
1011         }
1012
1013         status = append_named_field_class_to_container_field_class((void *) fc,
1014                 named_fc);
1015         if (status == BT_FUNC_STATUS_OK) {
1016                 /* Moved to the container */
1017                 named_fc = NULL;
1018         }
1019
1020 end:
1021         return status;
1022 }
1023
1024 uint64_t bt_field_class_structure_get_member_count(
1025                 const struct bt_field_class *fc)
1026 {
1027         struct bt_field_class_structure *struct_fc = (void *) fc;
1028
1029         BT_ASSERT_PRE_DEV_NON_NULL(fc, "Field class");
1030         BT_ASSERT_PRE_DEV_FC_HAS_ID(fc, BT_FIELD_CLASS_TYPE_STRUCTURE,
1031                 "Field class");
1032         return (uint64_t) struct_fc->common.named_fcs->len;
1033 }
1034
1035 static
1036 struct bt_named_field_class *
1037 borrow_named_field_class_from_container_field_class_at_index(
1038                 struct bt_field_class_named_field_class_container *fc,
1039                 uint64_t index)
1040 {
1041         BT_ASSERT(fc);
1042         BT_ASSERT_PRE_DEV_VALID_INDEX(index, fc->named_fcs->len);
1043         return fc->named_fcs->pdata[index];
1044 }
1045
1046 const struct bt_field_class_structure_member *
1047 bt_field_class_structure_borrow_member_by_index_const(
1048                 const struct bt_field_class *fc, uint64_t index)
1049 {
1050         BT_ASSERT_PRE_DEV_NON_NULL(fc, "Field class");
1051         BT_ASSERT_PRE_DEV_FC_HAS_ID(fc, BT_FIELD_CLASS_TYPE_STRUCTURE,
1052                 "Field class");
1053         return (const void *)
1054                 borrow_named_field_class_from_container_field_class_at_index(
1055                         (void *) fc, index);
1056 }
1057
1058 struct bt_field_class_structure_member *
1059 bt_field_class_structure_borrow_member_by_index(
1060                 struct bt_field_class *fc, uint64_t index)
1061 {
1062         BT_ASSERT_PRE_DEV_NON_NULL(fc, "Field class");
1063         BT_ASSERT_PRE_DEV_FC_HAS_ID(fc, BT_FIELD_CLASS_TYPE_STRUCTURE,
1064                 "Field class");
1065         return (void *)
1066                 borrow_named_field_class_from_container_field_class_at_index(
1067                         (void *) fc, index);
1068 }
1069
1070 static
1071 struct bt_named_field_class *
1072 borrow_named_field_class_from_container_field_class_by_name(
1073                 struct bt_field_class_named_field_class_container *fc,
1074                 const char *name)
1075 {
1076         struct bt_named_field_class *named_fc = NULL;
1077         gpointer orig_key;
1078         gpointer value;
1079
1080         BT_ASSERT(fc);
1081         BT_ASSERT_PRE_DEV_NON_NULL(name, "Name");
1082         if (!g_hash_table_lookup_extended(fc->name_to_index, name, &orig_key,
1083                         &value)) {
1084                 goto end;
1085         }
1086
1087         named_fc = fc->named_fcs->pdata[GPOINTER_TO_UINT(value)];
1088
1089 end:
1090         return named_fc;
1091 }
1092
1093 const struct bt_field_class_structure_member *
1094 bt_field_class_structure_borrow_member_by_name_const(
1095                 const struct bt_field_class *fc, const char *name)
1096 {
1097         BT_ASSERT_PRE_DEV_NON_NULL(fc, "Field class");
1098         BT_ASSERT_PRE_DEV_FC_HAS_ID(fc, BT_FIELD_CLASS_TYPE_STRUCTURE,
1099                 "Field class");
1100         return (const void *)
1101                 borrow_named_field_class_from_container_field_class_by_name(
1102                         (void *) fc, name);
1103 }
1104
1105 struct bt_field_class_structure_member *
1106 bt_field_class_structure_borrow_member_by_name(
1107                 struct bt_field_class *fc, const char *name)
1108 {
1109         BT_ASSERT_PRE_DEV_NON_NULL(fc, "Field class");
1110         BT_ASSERT_PRE_DEV_FC_HAS_ID(fc, BT_FIELD_CLASS_TYPE_STRUCTURE,
1111                 "Field class");
1112         return (void *)
1113                 borrow_named_field_class_from_container_field_class_by_name(
1114                         (void *) fc, name);
1115 }
1116
1117 const char *bt_field_class_structure_member_get_name(
1118                 const struct bt_field_class_structure_member *member)
1119 {
1120         const struct bt_named_field_class *named_fc = (const void *) member;
1121
1122         BT_ASSERT_PRE_DEV_NON_NULL(member, "Structure field class member");
1123         return named_fc->name->str;
1124 }
1125
1126 const struct bt_field_class *
1127 bt_field_class_structure_member_borrow_field_class_const(
1128                 const struct bt_field_class_structure_member *member)
1129 {
1130         const struct bt_named_field_class *named_fc = (const void *) member;
1131
1132         BT_ASSERT_PRE_DEV_NON_NULL(member, "Structure field class member");
1133         return named_fc->fc;
1134 }
1135
1136 struct bt_field_class *
1137 bt_field_class_structure_member_borrow_field_class(
1138                 struct bt_field_class_structure_member *member)
1139 {
1140         struct bt_named_field_class *named_fc = (void *) member;
1141
1142         BT_ASSERT_PRE_DEV_NON_NULL(member, "Structure field class member");
1143         return named_fc->fc;
1144 }
1145
1146 static
1147 void destroy_option_field_class(struct bt_object *obj)
1148 {
1149         struct bt_field_class_option *fc = (void *) obj;
1150
1151         BT_ASSERT(fc);
1152         BT_LIB_LOGD("Destroying option field class object: %!+F", fc);
1153         finalize_field_class((void *) obj);
1154         BT_LOGD_STR("Putting content field class.");
1155         BT_OBJECT_PUT_REF_AND_RESET(fc->content_fc);
1156
1157         if (fc->common.type != BT_FIELD_CLASS_TYPE_OPTION_WITHOUT_SELECTOR) {
1158                 struct bt_field_class_option_with_selector *with_sel_fc =
1159                         (void *) obj;
1160
1161                 BT_LOGD_STR("Putting selector field path.");
1162                 BT_OBJECT_PUT_REF_AND_RESET(with_sel_fc->selector_field_path);
1163                 BT_LOGD_STR("Putting selector field class.");
1164                 BT_OBJECT_PUT_REF_AND_RESET(with_sel_fc->selector_fc);
1165
1166                 if (fc->common.type != BT_FIELD_CLASS_TYPE_OPTION_WITH_BOOL_SELECTOR) {
1167                         struct bt_field_class_option_with_selector_integer *with_int_sel_fc =
1168                                 (void *) obj;
1169
1170                         BT_LOGD_STR("Putting integer range set.");
1171                         BT_OBJECT_PUT_REF_AND_RESET(with_int_sel_fc->range_set);
1172                 }
1173         }
1174
1175         g_free(fc);
1176 }
1177
1178 static
1179 struct bt_field_class *create_option_field_class(
1180                 struct bt_trace_class *trace_class,
1181                 enum bt_field_class_type fc_type,
1182                 struct bt_field_class *content_fc,
1183                 struct bt_field_class *selector_fc)
1184 {
1185         struct bt_field_class_option *opt_fc = NULL;
1186
1187         BT_ASSERT_PRE_NON_NULL(trace_class, "Trace class");
1188         BT_ASSERT_PRE_NON_NULL(content_fc, "Content field class");
1189         BT_LIB_LOGD("Creating option field class: "
1190                 "type=%s, %![content-fc-]+F, %![sel-fc-]+F",
1191                 bt_common_field_class_type_string(fc_type),
1192                 content_fc, selector_fc);
1193
1194         if (fc_type != BT_FIELD_CLASS_TYPE_OPTION_WITHOUT_SELECTOR) {
1195                 struct bt_field_class_option_with_selector *opt_with_sel_fc = NULL;
1196
1197                 BT_ASSERT_PRE_NON_NULL(selector_fc, "Selector field class");
1198
1199                 if (fc_type == BT_FIELD_CLASS_TYPE_OPTION_WITH_BOOL_SELECTOR) {
1200                         BT_ASSERT_PRE_FC_HAS_ID(selector_fc,
1201                                 BT_FIELD_CLASS_TYPE_BOOL,
1202                                 "Selector field class");
1203                         opt_with_sel_fc = (void *) g_new0(
1204                                 struct bt_field_class_option_with_selector_bool, 1);
1205                 } else {
1206                         BT_ASSERT_PRE_FC_IS_INT(selector_fc,
1207                                 "Selector field class");
1208                         opt_with_sel_fc = (void *) g_new0(
1209                                 struct bt_field_class_option_with_selector_integer, 1);
1210                 }
1211
1212                 if (!opt_with_sel_fc) {
1213                         BT_LIB_LOGE_APPEND_CAUSE(
1214                                 "Failed to allocate one option with selector field class.");
1215                         goto error;
1216                 }
1217
1218                 opt_with_sel_fc->selector_fc = selector_fc;
1219                 bt_object_get_ref_no_null_check(opt_with_sel_fc->selector_fc);
1220                 opt_fc = (void *) opt_with_sel_fc;
1221         } else {
1222                 opt_fc = g_new0(struct bt_field_class_option, 1);
1223                 if (!opt_fc) {
1224                         BT_LIB_LOGE_APPEND_CAUSE(
1225                                 "Failed to allocate one option field class.");
1226                         goto error;
1227                 }
1228         }
1229
1230         BT_ASSERT(opt_fc);
1231
1232         if (init_field_class((void *) opt_fc, fc_type,
1233                         destroy_option_field_class)) {
1234                 goto error;
1235         }
1236
1237         opt_fc->content_fc = content_fc;
1238         bt_object_get_ref_no_null_check(opt_fc->content_fc);
1239         bt_field_class_freeze(opt_fc->content_fc);
1240
1241         if (selector_fc) {
1242                 bt_field_class_freeze(selector_fc);
1243         }
1244
1245         BT_LIB_LOGD("Created option field class object: "
1246                 "%![opt-fc-]+F, %![sel-fc-]+F", opt_fc, selector_fc);
1247         goto end;
1248
1249 error:
1250         BT_OBJECT_PUT_REF_AND_RESET(opt_fc);
1251
1252 end:
1253         return (void *) opt_fc;
1254 }
1255
1256 struct bt_field_class *bt_field_class_option_without_selector_create(
1257                 struct bt_trace_class *trace_class,
1258                 struct bt_field_class *content_fc)
1259 {
1260         return create_option_field_class(trace_class,
1261                 BT_FIELD_CLASS_TYPE_OPTION_WITHOUT_SELECTOR,
1262                 content_fc, NULL);
1263 }
1264
1265 struct bt_field_class *bt_field_class_option_with_selector_bool_create(
1266                 struct bt_trace_class *trace_class,
1267                 struct bt_field_class *content_fc,
1268                 struct bt_field_class *selector_fc)
1269 {
1270         struct bt_field_class_option_with_selector_bool *fc =
1271                 (void *) create_option_field_class(trace_class,
1272                         BT_FIELD_CLASS_TYPE_OPTION_WITH_BOOL_SELECTOR,
1273                         content_fc, selector_fc);
1274
1275         if (!fc) {
1276                 goto end;
1277         }
1278
1279 end:
1280         return (void *) fc;
1281 }
1282
1283 struct bt_field_class *
1284 bt_field_class_option_with_selector_integer_unsigned_create(
1285                 struct bt_trace_class *trace_class,
1286                 struct bt_field_class *content_fc,
1287                 struct bt_field_class *selector_fc,
1288                 const struct bt_integer_range_set_unsigned *u_range_set)
1289 {
1290         struct bt_field_class_option_with_selector_integer *fc;
1291         const struct bt_integer_range_set *range_set =
1292                 (const void *) u_range_set;
1293
1294         BT_ASSERT_PRE_NON_NULL(range_set, "Integer range set");
1295         BT_ASSERT_PRE(range_set->ranges->len > 0,
1296                 "Integer range set is empty: %!+R", range_set);
1297         fc = (void *) create_option_field_class(trace_class,
1298                 BT_FIELD_CLASS_TYPE_OPTION_WITH_UNSIGNED_INTEGER_SELECTOR,
1299                 content_fc, selector_fc);
1300
1301         if (!fc) {
1302                 goto end;
1303         }
1304
1305         fc->range_set = range_set;
1306         bt_object_get_ref_no_null_check(fc->range_set);
1307         bt_integer_range_set_freeze(range_set);
1308
1309 end:
1310         return (void *) fc;
1311 }
1312
1313 struct bt_field_class *
1314 bt_field_class_option_with_selector_integer_signed_create(
1315                 struct bt_trace_class *trace_class,
1316                 struct bt_field_class *content_fc,
1317                 struct bt_field_class *selector_fc,
1318                 const struct bt_integer_range_set_signed *i_range_set)
1319 {
1320         struct bt_field_class_option_with_selector_integer *fc;
1321         const struct bt_integer_range_set *range_set =
1322                 (const void *) i_range_set;
1323
1324         BT_ASSERT_PRE_NON_NULL(range_set, "Integer range set");
1325         BT_ASSERT_PRE(range_set->ranges->len > 0,
1326                 "Integer range set is empty: %!+R", range_set);
1327         fc = (void *) create_option_field_class(trace_class,
1328                 BT_FIELD_CLASS_TYPE_OPTION_WITH_SIGNED_INTEGER_SELECTOR,
1329                 content_fc, selector_fc);
1330
1331         if (!fc) {
1332                 goto end;
1333         }
1334
1335         fc->range_set = range_set;
1336         bt_object_get_ref_no_null_check(fc->range_set);
1337         bt_integer_range_set_freeze(range_set);
1338
1339 end:
1340         return (void *) fc;
1341 }
1342
1343 const struct bt_field_class *bt_field_class_option_borrow_field_class_const(
1344                         const struct bt_field_class *fc)
1345 {
1346         struct bt_field_class_option *opt_fc = (void *) fc;
1347
1348         BT_ASSERT_PRE_NON_NULL(fc, "Field class");
1349         BT_ASSERT_PRE_FC_IS_OPTION(fc, "Field class");
1350         return opt_fc->content_fc;
1351 }
1352
1353 struct bt_field_class *bt_field_class_option_borrow_field_class(
1354                         struct bt_field_class *fc)
1355 {
1356         struct bt_field_class_option *opt_fc = (void *) fc;
1357
1358         BT_ASSERT_PRE_NON_NULL(fc, "Field class");
1359         BT_ASSERT_PRE_FC_IS_OPTION(fc, "Field class");
1360         return opt_fc->content_fc;
1361 }
1362
1363 const struct bt_field_path *
1364 bt_field_class_option_with_selector_borrow_selector_field_path_const(
1365                 const struct bt_field_class *fc)
1366 {
1367         const struct bt_field_class_option_with_selector *opt_fc =
1368                 (const void *) fc;
1369
1370         BT_ASSERT_PRE_NON_NULL(fc, "Field class");
1371         BT_ASSERT_PRE_FC_IS_OPTION_WITH_SEL(fc, "Field class");
1372         return opt_fc->selector_field_path;
1373 }
1374
1375 void bt_field_class_option_with_selector_bool_set_selector_is_reversed(
1376                 struct bt_field_class *fc, bt_bool sel_is_reversed)
1377 {
1378         struct bt_field_class_option_with_selector_bool *opt_fc = (void *) fc;
1379
1380         BT_ASSERT_PRE_NON_NULL(fc, "Field class");
1381         BT_ASSERT_PRE_FC_HAS_ID(fc,
1382                 BT_FIELD_CLASS_TYPE_OPTION_WITH_BOOL_SELECTOR, "Field class");
1383         BT_ASSERT_PRE_DEV_FC_HOT(fc, "Field class");
1384         opt_fc->sel_is_reversed = sel_is_reversed;
1385 }
1386
1387 bt_bool bt_field_class_option_with_selector_bool_selector_is_reversed(
1388                 const struct bt_field_class *fc)
1389 {
1390         struct bt_field_class_option_with_selector_bool *opt_fc = (void *) fc;
1391
1392         BT_ASSERT_PRE_NON_NULL(fc, "Field class");
1393         BT_ASSERT_PRE_FC_HAS_ID(fc,
1394                 BT_FIELD_CLASS_TYPE_OPTION_WITH_BOOL_SELECTOR, "Field class");
1395         return opt_fc->sel_is_reversed;
1396 }
1397
1398 const struct bt_integer_range_set_unsigned *
1399 bt_field_class_option_with_selector_integer_unsigned_borrow_selector_ranges_const(
1400                 const struct bt_field_class *fc)
1401 {
1402         struct bt_field_class_option_with_selector_integer *opt_fc =
1403                 (void *) fc;
1404
1405         BT_ASSERT_PRE_NON_NULL(fc, "Field class");
1406         BT_ASSERT_PRE_FC_IS_OPTION_WITH_INT_SEL(fc, "Field class");
1407         return (const void *) opt_fc->range_set;
1408 }
1409
1410 const struct bt_integer_range_set_signed *
1411 bt_field_class_option_with_selector_integer_signed_borrow_selector_ranges_const(
1412                 const struct bt_field_class *fc)
1413 {
1414         struct bt_field_class_option_with_selector_integer *opt_fc =
1415                 (void *) fc;
1416
1417         BT_ASSERT_PRE_NON_NULL(fc, "Field class");
1418         BT_ASSERT_PRE_FC_IS_OPTION_WITH_INT_SEL(fc, "Field class");
1419         return (const void *) opt_fc->range_set;
1420 }
1421
1422 static
1423 void finalize_variant_field_class(struct bt_field_class_variant *var_fc)
1424 {
1425         BT_ASSERT(var_fc);
1426         BT_LIB_LOGD("Finalizing variant field class object: %!+F", var_fc);
1427         finalize_field_class((void *) var_fc);
1428         finalize_named_field_classes_container((void *) var_fc);
1429 }
1430
1431 static
1432 void destroy_variant_field_class(struct bt_object *obj)
1433 {
1434         struct bt_field_class_variant *fc = (void *) obj;
1435
1436         BT_ASSERT(fc);
1437         finalize_variant_field_class(fc);
1438         g_free(fc);
1439 }
1440
1441 static
1442 void destroy_variant_with_selector_field_class(struct bt_object *obj)
1443 {
1444         struct bt_field_class_variant_with_selector *fc = (void *) obj;
1445
1446         BT_ASSERT(fc);
1447         finalize_variant_field_class(&fc->common);
1448         BT_LOGD_STR("Putting selector field path.");
1449         BT_OBJECT_PUT_REF_AND_RESET(fc->selector_field_path);
1450         BT_LOGD_STR("Putting selector field class.");
1451         BT_OBJECT_PUT_REF_AND_RESET(fc->selector_fc);
1452         g_free(fc);
1453 }
1454
1455 struct bt_field_class *bt_field_class_variant_create(
1456                 bt_trace_class *trace_class, bt_field_class *selector_fc)
1457 {
1458         int ret;
1459         struct bt_field_class_variant *var_fc = NULL;
1460         struct bt_field_class_variant_with_selector *var_with_sel_fc = NULL;
1461         enum bt_field_class_type fc_type;
1462
1463         BT_ASSERT_PRE_NON_NULL(trace_class, "Trace class");
1464
1465         if (selector_fc) {
1466                 BT_ASSERT_PRE_FC_IS_INT(selector_fc, "Selector field class");
1467         }
1468
1469         BT_LIB_LOGD("Creating default variant field class: %![sel-fc-]+F",
1470                 selector_fc);
1471
1472         if (selector_fc) {
1473                 var_with_sel_fc = g_new0(
1474                         struct bt_field_class_variant_with_selector, 1);
1475                 if (!var_with_sel_fc) {
1476                         BT_LIB_LOGE_APPEND_CAUSE(
1477                                 "Failed to allocate one variant field class with selector.");
1478                         goto error;
1479                 }
1480
1481                 if (selector_fc->type == BT_FIELD_CLASS_TYPE_UNSIGNED_INTEGER ||
1482                                 selector_fc->type == BT_FIELD_CLASS_TYPE_UNSIGNED_ENUMERATION) {
1483                         fc_type = BT_FIELD_CLASS_TYPE_VARIANT_WITH_UNSIGNED_INTEGER_SELECTOR;
1484                 } else {
1485                         fc_type = BT_FIELD_CLASS_TYPE_VARIANT_WITH_SIGNED_INTEGER_SELECTOR;
1486                 }
1487
1488                 ret = init_named_field_classes_container(
1489                         (void *) var_with_sel_fc, fc_type,
1490                         destroy_variant_with_selector_field_class,
1491                         destroy_variant_with_selector_option);
1492                 if (ret) {
1493                         /* init_named_field_classes_container() logs errors */
1494                         goto error;
1495                 }
1496
1497                 var_with_sel_fc->selector_fc = selector_fc;
1498                 bt_object_get_ref_no_null_check(var_with_sel_fc->selector_fc);
1499                 bt_field_class_freeze(selector_fc);
1500                 var_fc = (void *) var_with_sel_fc;
1501         } else {
1502                 var_fc = g_new0(struct bt_field_class_variant, 1);
1503                 if (!var_fc) {
1504                         BT_LIB_LOGE_APPEND_CAUSE(
1505                                 "Failed to allocate one variant field class without selector.");
1506                         goto error;
1507                 }
1508
1509                 ret = init_named_field_classes_container((void *) var_fc,
1510                         BT_FIELD_CLASS_TYPE_VARIANT_WITHOUT_SELECTOR,
1511                         destroy_variant_field_class, destroy_named_field_class);
1512                 if (ret) {
1513                         /* init_named_field_classes_container() logs errors */
1514                         goto error;
1515                 }
1516         }
1517
1518         BT_ASSERT(var_fc);
1519         BT_LIB_LOGD("Created default variant field class with selector object: "
1520                 "%![var-fc-]+F, %![sel-fc-]+F", var_fc, selector_fc);
1521         goto end;
1522
1523 error:
1524         BT_OBJECT_PUT_REF_AND_RESET(var_fc);
1525
1526 end:
1527         return (void *) var_fc;
1528 }
1529
1530 enum bt_field_class_variant_without_selector_append_option_status
1531 bt_field_class_variant_without_selector_append_option(struct bt_field_class *fc,
1532                 const char *name, struct bt_field_class *option_fc)
1533 {
1534         enum bt_field_class_variant_without_selector_append_option_status status;
1535         struct bt_named_field_class *named_fc = NULL;
1536
1537         BT_ASSERT_PRE_NON_NULL(fc, "Field class");
1538         BT_ASSERT_PRE_NON_NULL(name, "Name");
1539         BT_ASSERT_PRE_NON_NULL(option_fc, "Option field class");
1540         BT_ASSERT_PRE_FC_HAS_ID(fc,
1541                 BT_FIELD_CLASS_TYPE_VARIANT_WITHOUT_SELECTOR, "Field class");
1542         named_fc = create_named_field_class(name, option_fc);
1543         if (!named_fc) {
1544                 /* create_named_field_class() logs errors */
1545                 status = BT_FUNC_STATUS_MEMORY_ERROR;
1546                 goto end;
1547         }
1548
1549         status = append_named_field_class_to_container_field_class((void *) fc,
1550                 named_fc);
1551         if (status == BT_FUNC_STATUS_OK) {
1552                 /* Moved to the container */
1553                 named_fc = NULL;
1554         }
1555
1556 end:
1557         if (named_fc) {
1558                 destroy_named_field_class(named_fc);
1559         }
1560
1561         return status;
1562 }
1563
1564 static
1565 int ranges_overlap(GPtrArray *var_fc_opts, const struct bt_integer_range_set *range_set,
1566                 bool is_signed, bool *has_overlap)
1567 {
1568         int status = BT_FUNC_STATUS_OK;
1569         struct bt_integer_range_set *full_range_set;
1570         uint64_t i;
1571
1572         *has_overlap = false;
1573
1574         /*
1575          * Build a single range set with all the ranges and test for
1576          * overlaps.
1577          */
1578         if (is_signed) {
1579                 full_range_set = (void *) bt_integer_range_set_signed_create();
1580         } else {
1581                 full_range_set = (void *) bt_integer_range_set_unsigned_create();
1582         }
1583
1584         if (!full_range_set) {
1585                 BT_LOGE_STR("Failed to create a range set.");
1586                 status = BT_FUNC_STATUS_MEMORY_ERROR;
1587                 goto end;
1588         }
1589
1590         /* Add existing option ranges */
1591         for (i = 0; i < var_fc_opts->len; i++) {
1592                 struct bt_field_class_variant_with_selector_option *opt =
1593                         var_fc_opts->pdata[i];
1594                 uint64_t j;
1595
1596                 for (j = 0; j < opt->range_set->ranges->len; j++) {
1597                         struct bt_integer_range *range = BT_INTEGER_RANGE_SET_RANGE_AT_INDEX(
1598                                 opt->range_set, j);
1599
1600                         if (is_signed) {
1601                                 status = bt_integer_range_set_signed_add_range(
1602                                         (void *) full_range_set, range->lower.i,
1603                                         range->upper.i);
1604                         } else {
1605                                 status = bt_integer_range_set_unsigned_add_range(
1606                                         (void *) full_range_set, range->lower.u,
1607                                         range->upper.u);
1608                         }
1609
1610                         if (status) {
1611                                 goto end;
1612                         }
1613                 }
1614         }
1615
1616         /* Add new ranges */
1617         for (i = 0; i < range_set->ranges->len; i++) {
1618                 struct bt_integer_range *range = BT_INTEGER_RANGE_SET_RANGE_AT_INDEX(
1619                         range_set, i);
1620
1621                 if (is_signed) {
1622                         status = bt_integer_range_set_signed_add_range(
1623                                 (void *) full_range_set, range->lower.i,
1624                                 range->upper.i);
1625                 } else {
1626                         status = bt_integer_range_set_unsigned_add_range(
1627                                 (void *) full_range_set, range->lower.u,
1628                                 range->upper.u);
1629                 }
1630
1631                 if (status) {
1632                         goto end;
1633                 }
1634         }
1635
1636         /* Check overlaps */
1637         if (is_signed) {
1638                 *has_overlap = bt_integer_range_set_signed_has_overlaps(full_range_set);
1639         } else {
1640                 *has_overlap = bt_integer_range_set_unsigned_has_overlaps(
1641                         full_range_set);
1642         }
1643
1644 end:
1645         bt_object_put_ref(full_range_set);
1646         return status;
1647 }
1648
1649 static
1650 int append_option_to_variant_with_selector_field_class(
1651                 struct bt_field_class *fc, const char *name,
1652                 struct bt_field_class *option_fc,
1653                 const struct bt_integer_range_set *range_set,
1654                 enum bt_field_class_type expected_type)
1655 {
1656         int status;
1657         struct bt_field_class_variant_with_selector *var_fc = (void *) fc;
1658         struct bt_field_class_variant_with_selector_option *opt = NULL;
1659         bool has_overlap;
1660
1661         BT_ASSERT_PRE_NON_NULL(fc, "Field class");
1662         BT_ASSERT_PRE_NON_NULL(name, "Name");
1663         BT_ASSERT_PRE_NON_NULL(option_fc, "Option field class");
1664         BT_ASSERT_PRE_NON_NULL(range_set, "Integer range set");
1665         BT_ASSERT_PRE_FC_HAS_ID(fc, expected_type, "Field class");
1666         BT_ASSERT_PRE(range_set->ranges->len > 0,
1667                 "Integer range set is empty: %!+R", range_set);
1668         status = ranges_overlap(var_fc->common.common.named_fcs, range_set,
1669                 expected_type == BT_FIELD_CLASS_TYPE_VARIANT_WITH_SIGNED_INTEGER_SELECTOR,
1670                 &has_overlap);
1671         if (status) {
1672                 /* ranges_overlap() logs errors */
1673                 goto end;
1674         }
1675
1676         BT_ASSERT_PRE(!has_overlap,
1677                 "Integer range set's ranges and existing ranges have an overlap: "
1678                 "%!+R", range_set);
1679         opt = create_variant_with_selector_option(name, option_fc, range_set);
1680         if (!opt) {
1681                 /* create_variant_with_selector_option() logs errors */
1682                 status = BT_FUNC_STATUS_MEMORY_ERROR;
1683                 goto end;
1684         }
1685
1686         status = append_named_field_class_to_container_field_class((void *) fc,
1687                 &opt->common);
1688         if (status == BT_FUNC_STATUS_OK) {
1689                 /* Moved to the container */
1690                 opt = NULL;
1691         }
1692
1693 end:
1694         if (opt) {
1695                 destroy_variant_with_selector_option(opt);
1696         }
1697
1698         return status;
1699 }
1700
1701 enum bt_field_class_variant_with_selector_integer_append_option_status
1702 bt_field_class_variant_with_selector_integer_unsigned_append_option(
1703                 struct bt_field_class *fc, const char *name,
1704                 struct bt_field_class *option_fc,
1705                 const struct bt_integer_range_set_unsigned *range_set)
1706 {
1707         return append_option_to_variant_with_selector_field_class(fc,
1708                 name, option_fc, (const void *) range_set,
1709                 BT_FIELD_CLASS_TYPE_VARIANT_WITH_UNSIGNED_INTEGER_SELECTOR);
1710 }
1711
1712 enum bt_field_class_variant_with_selector_integer_append_option_status
1713 bt_field_class_variant_with_selector_integer_signed_append_option(
1714                 struct bt_field_class *fc, const char *name,
1715                 struct bt_field_class *option_fc,
1716                 const struct bt_integer_range_set_signed *range_set)
1717 {
1718         return append_option_to_variant_with_selector_field_class(fc,
1719                 name, option_fc, (const void *) range_set,
1720                 BT_FIELD_CLASS_TYPE_VARIANT_WITH_SIGNED_INTEGER_SELECTOR);
1721 }
1722
1723 uint64_t bt_field_class_variant_get_option_count(const struct bt_field_class *fc)
1724 {
1725         const struct bt_field_class_variant *var_fc = (const void *) fc;
1726
1727         BT_ASSERT_PRE_DEV_NON_NULL(fc, "Field class");
1728         BT_ASSERT_PRE_DEV_FC_IS_VARIANT(fc, "Field class");
1729         return (uint64_t) var_fc->common.named_fcs->len;
1730 }
1731
1732 const struct bt_field_class_variant_option *
1733 bt_field_class_variant_borrow_option_by_name_const(
1734                 const struct bt_field_class *fc, const char *name)
1735 {
1736         BT_ASSERT_PRE_DEV_NON_NULL(fc, "Field class");
1737         BT_ASSERT_PRE_DEV_FC_IS_VARIANT(fc, "Field class");
1738         return (const void *)
1739                 borrow_named_field_class_from_container_field_class_by_name(
1740                         (void *) fc, name);
1741 }
1742
1743 const struct bt_field_class_variant_option *
1744 bt_field_class_variant_borrow_option_by_index_const(
1745                 const struct bt_field_class *fc, uint64_t index)
1746 {
1747         BT_ASSERT_PRE_DEV_NON_NULL(fc, "Field class");
1748         BT_ASSERT_PRE_DEV_FC_IS_VARIANT(fc, "Field class");
1749         return (const void *)
1750                 borrow_named_field_class_from_container_field_class_at_index(
1751                         (void *) fc, index);
1752 }
1753
1754 struct bt_field_class_variant_option *
1755 bt_field_class_variant_borrow_option_by_name(
1756                 struct bt_field_class *fc, const char *name)
1757 {
1758         BT_ASSERT_PRE_DEV_NON_NULL(fc, "Field class");
1759         BT_ASSERT_PRE_DEV_FC_IS_VARIANT(fc, "Field class");
1760         return (void *)
1761                 borrow_named_field_class_from_container_field_class_by_name(
1762                         (void *) fc, name);
1763 }
1764
1765 struct bt_field_class_variant_option *
1766 bt_field_class_variant_borrow_option_by_index(
1767                 struct bt_field_class *fc, uint64_t index)
1768 {
1769         BT_ASSERT_PRE_DEV_NON_NULL(fc, "Field class");
1770         BT_ASSERT_PRE_DEV_FC_IS_VARIANT(fc, "Field class");
1771         return (void *)
1772                 borrow_named_field_class_from_container_field_class_at_index(
1773                         (void *) fc, index);
1774 }
1775
1776 const struct bt_field_class_variant_with_selector_integer_unsigned_option *
1777 bt_field_class_variant_with_selector_integer_unsigned_borrow_option_by_name_const(
1778                 const struct bt_field_class *fc, const char *name)
1779 {
1780         BT_ASSERT_PRE_DEV_NON_NULL(fc, "Field class");
1781         BT_ASSERT_PRE_DEV_FC_HAS_ID(fc,
1782                 BT_FIELD_CLASS_TYPE_VARIANT_WITH_UNSIGNED_INTEGER_SELECTOR,
1783                 "Field class");
1784         return (const void *)
1785                 borrow_named_field_class_from_container_field_class_by_name(
1786                         (void *) fc, name);
1787 }
1788
1789 const struct bt_field_class_variant_with_selector_integer_unsigned_option *
1790 bt_field_class_variant_with_selector_integer_unsigned_borrow_option_by_index_const(
1791                 const struct bt_field_class *fc, uint64_t index)
1792 {
1793         BT_ASSERT_PRE_DEV_NON_NULL(fc, "Field class");
1794         BT_ASSERT_PRE_DEV_FC_HAS_ID(fc,
1795                 BT_FIELD_CLASS_TYPE_VARIANT_WITH_UNSIGNED_INTEGER_SELECTOR,
1796                 "Field class");
1797         return (const void *)
1798                 borrow_named_field_class_from_container_field_class_at_index(
1799                         (void *) fc, index);
1800 }
1801
1802 const struct bt_field_class_variant_with_selector_integer_signed_option *
1803 bt_field_class_variant_with_selector_integer_signed_borrow_option_by_name_const(
1804                 const struct bt_field_class *fc, const char *name)
1805 {
1806         BT_ASSERT_PRE_DEV_NON_NULL(fc, "Field class");
1807         BT_ASSERT_PRE_DEV_FC_HAS_ID(fc,
1808                 BT_FIELD_CLASS_TYPE_VARIANT_WITH_SIGNED_INTEGER_SELECTOR,
1809                 "Field class");
1810         return (const void *)
1811                 borrow_named_field_class_from_container_field_class_by_name(
1812                         (void *) fc, name);
1813 }
1814
1815 const struct bt_field_class_variant_with_selector_integer_signed_option *
1816 bt_field_class_variant_with_selector_integer_signed_borrow_option_by_index_const(
1817                 const struct bt_field_class *fc, uint64_t index)
1818 {
1819         BT_ASSERT_PRE_DEV_NON_NULL(fc, "Field class");
1820         BT_ASSERT_PRE_DEV_FC_HAS_ID(fc,
1821                 BT_FIELD_CLASS_TYPE_VARIANT_WITH_SIGNED_INTEGER_SELECTOR,
1822                 "Field class");
1823         return (const void *)
1824                 borrow_named_field_class_from_container_field_class_at_index(
1825                         (void *) fc, index);
1826 }
1827
1828 const char *bt_field_class_variant_option_get_name(
1829                 const struct bt_field_class_variant_option *option)
1830 {
1831         const struct bt_named_field_class *named_fc = (const void *) option;
1832
1833         BT_ASSERT_PRE_DEV_NON_NULL(option, "Variant field class option");
1834         return named_fc->name->str;
1835 }
1836
1837 const struct bt_field_class *
1838 bt_field_class_variant_option_borrow_field_class_const(
1839                 const struct bt_field_class_variant_option *option)
1840 {
1841         const struct bt_named_field_class *named_fc = (const void *) option;
1842
1843         BT_ASSERT_PRE_DEV_NON_NULL(option, "Variant field class option");
1844         return named_fc->fc;
1845 }
1846
1847 struct bt_field_class *
1848 bt_field_class_variant_option_borrow_field_class(
1849                 struct bt_field_class_variant_option *option)
1850 {
1851         struct bt_named_field_class *named_fc = (void *) option;
1852
1853         BT_ASSERT_PRE_DEV_NON_NULL(option, "Variant field class option");
1854         return named_fc->fc;
1855 }
1856
1857 const struct bt_integer_range_set_unsigned *
1858 bt_field_class_variant_with_selector_integer_unsigned_option_borrow_ranges_const(
1859                 const struct bt_field_class_variant_with_selector_integer_unsigned_option *option)
1860 {
1861         const struct bt_field_class_variant_with_selector_option *opt =
1862                 (const void *) option;
1863
1864         BT_ASSERT_PRE_DEV_NON_NULL(option, "Variant field class option");
1865         return (const void *) opt->range_set;
1866 }
1867
1868 const struct bt_integer_range_set_signed *
1869 bt_field_class_variant_with_selector_integer_signed_option_borrow_ranges_const(
1870                 const struct bt_field_class_variant_with_selector_integer_signed_option *option)
1871 {
1872         const struct bt_field_class_variant_with_selector_option *opt =
1873                 (const void *) option;
1874
1875         BT_ASSERT_PRE_DEV_NON_NULL(option, "Variant field class option");
1876         return (const void *) opt->range_set;
1877 }
1878
1879 const struct bt_field_path *
1880 bt_field_class_variant_with_selector_borrow_selector_field_path_const(
1881                 const struct bt_field_class *fc)
1882 {
1883         const struct bt_field_class_variant_with_selector *var_fc =
1884                 (const void *) fc;
1885
1886         BT_ASSERT_PRE_DEV_NON_NULL(fc, "Field class");
1887         BT_ASSERT_PRE_DEV_FC_IS_VARIANT_WITH_SEL(fc, "Field class");
1888         return var_fc->selector_field_path;
1889 }
1890
1891 static
1892 int init_array_field_class(struct bt_field_class_array *fc,
1893                 enum bt_field_class_type type, bt_object_release_func release_func,
1894                 struct bt_field_class *element_fc)
1895 {
1896         int ret;
1897
1898         BT_ASSERT(element_fc);
1899         ret = init_field_class((void *) fc, type, release_func);
1900         if (ret) {
1901                 goto end;
1902         }
1903
1904         fc->element_fc = element_fc;
1905         bt_object_get_ref_no_null_check(fc->element_fc);
1906         bt_field_class_freeze(element_fc);
1907
1908 end:
1909         return ret;
1910 }
1911
1912 static
1913 void finalize_array_field_class(struct bt_field_class_array *array_fc)
1914 {
1915         BT_ASSERT(array_fc);
1916         BT_LOGD_STR("Putting element field class.");
1917         finalize_field_class((void *) array_fc);
1918         BT_OBJECT_PUT_REF_AND_RESET(array_fc->element_fc);
1919 }
1920
1921 static
1922 void destroy_static_array_field_class(struct bt_object *obj)
1923 {
1924         BT_ASSERT(obj);
1925         BT_LIB_LOGD("Destroying static array field class object: %!+F", obj);
1926         finalize_array_field_class((void *) obj);
1927         g_free(obj);
1928 }
1929
1930 struct bt_field_class *
1931 bt_field_class_array_static_create(bt_trace_class *trace_class,
1932                 struct bt_field_class *element_fc, uint64_t length)
1933 {
1934         struct bt_field_class_array_static *array_fc = NULL;
1935
1936         BT_ASSERT_PRE_NON_NULL(trace_class, "Trace class");
1937         BT_ASSERT_PRE_NON_NULL(element_fc, "Element field class");
1938         BT_LOGD_STR("Creating default static array field class object.");
1939         array_fc = g_new0(struct bt_field_class_array_static, 1);
1940         if (!array_fc) {
1941                 BT_LIB_LOGE_APPEND_CAUSE(
1942                         "Failed to allocate one static array field class.");
1943                 goto error;
1944         }
1945
1946         if (init_array_field_class((void *) array_fc,
1947                         BT_FIELD_CLASS_TYPE_STATIC_ARRAY,
1948                         destroy_static_array_field_class, element_fc)) {
1949                 goto error;
1950         }
1951
1952         array_fc->length = length;
1953         BT_LIB_LOGD("Created static array field class object: %!+F", array_fc);
1954         goto end;
1955
1956 error:
1957         BT_OBJECT_PUT_REF_AND_RESET(array_fc);
1958
1959 end:
1960         return (void *) array_fc;
1961 }
1962
1963 const struct bt_field_class *
1964 bt_field_class_array_borrow_element_field_class_const(
1965                 const struct bt_field_class *fc)
1966 {
1967         const struct bt_field_class_array *array_fc = (const void *) fc;
1968
1969         BT_ASSERT_PRE_DEV_NON_NULL(fc, "Field class");
1970         BT_ASSERT_PRE_DEV_FC_IS_ARRAY(fc, "Field class");
1971         return array_fc->element_fc;
1972 }
1973
1974 struct bt_field_class *
1975 bt_field_class_array_borrow_element_field_class(struct bt_field_class *fc)
1976 {
1977         struct bt_field_class_array *array_fc = (void *) fc;
1978
1979         BT_ASSERT_PRE_DEV_NON_NULL(fc, "Field class");
1980         BT_ASSERT_PRE_DEV_FC_IS_ARRAY(fc, "Field class");
1981         return array_fc->element_fc;
1982 }
1983
1984 uint64_t bt_field_class_array_static_get_length(const struct bt_field_class *fc)
1985 {
1986         const struct bt_field_class_array_static *array_fc = (const void *) fc;
1987
1988         BT_ASSERT_PRE_DEV_NON_NULL(fc, "Field class");
1989         BT_ASSERT_PRE_DEV_FC_HAS_ID(fc, BT_FIELD_CLASS_TYPE_STATIC_ARRAY,
1990                 "Field class");
1991         return (uint64_t) array_fc->length;
1992 }
1993
1994 static
1995 void destroy_dynamic_array_field_class(struct bt_object *obj)
1996 {
1997         struct bt_field_class_array_dynamic *fc = (void *) obj;
1998
1999         BT_ASSERT(fc);
2000         BT_LIB_LOGD("Destroying dynamic array field class object: %!+F", fc);
2001         finalize_array_field_class((void *) fc);
2002         BT_LOGD_STR("Putting length field path.");
2003         BT_OBJECT_PUT_REF_AND_RESET(fc->length_field_path);
2004         BT_LOGD_STR("Putting length field class.");
2005         BT_OBJECT_PUT_REF_AND_RESET(fc->length_fc);
2006         g_free(fc);
2007 }
2008
2009 struct bt_field_class *bt_field_class_array_dynamic_create(
2010                 struct bt_trace_class *trace_class,
2011                 struct bt_field_class *element_fc,
2012                 struct bt_field_class *length_fc)
2013 {
2014         struct bt_field_class_array_dynamic *array_fc = NULL;
2015
2016         BT_ASSERT_PRE_NON_NULL(trace_class, "Trace class");
2017         BT_ASSERT_PRE_NON_NULL(element_fc, "Element field class");
2018         BT_LOGD_STR("Creating default dynamic array field class object.");
2019         array_fc = g_new0(struct bt_field_class_array_dynamic, 1);
2020         if (!array_fc) {
2021                 BT_LIB_LOGE_APPEND_CAUSE(
2022                         "Failed to allocate one dynamic array field class.");
2023                 goto error;
2024         }
2025
2026         if (init_array_field_class((void *) array_fc,
2027                         BT_FIELD_CLASS_TYPE_DYNAMIC_ARRAY,
2028                         destroy_dynamic_array_field_class, element_fc)) {
2029                 goto error;
2030         }
2031
2032         if (length_fc) {
2033                 BT_ASSERT_PRE_FC_IS_UNSIGNED_INT(length_fc,
2034                         "Length field class");
2035                 array_fc->length_fc = length_fc;
2036                 bt_object_get_ref_no_null_check(array_fc->length_fc);
2037                 bt_field_class_freeze(length_fc);
2038         }
2039
2040         BT_LIB_LOGD("Created dynamic array field class object: %!+F", array_fc);
2041         goto end;
2042
2043 error:
2044         BT_OBJECT_PUT_REF_AND_RESET(array_fc);
2045
2046 end:
2047         return (void *) array_fc;
2048 }
2049
2050 const struct bt_field_path *
2051 bt_field_class_array_dynamic_borrow_length_field_path_const(
2052                 const struct bt_field_class *fc)
2053 {
2054         const struct bt_field_class_array_dynamic *seq_fc = (const void *) fc;
2055
2056         BT_ASSERT_PRE_DEV_NON_NULL(fc, "Field class");
2057         BT_ASSERT_PRE_DEV_FC_HAS_ID(fc, BT_FIELD_CLASS_TYPE_DYNAMIC_ARRAY,
2058                 "Field class");
2059         return seq_fc->length_field_path;
2060 }
2061
2062 static
2063 void destroy_string_field_class(struct bt_object *obj)
2064 {
2065         BT_ASSERT(obj);
2066         BT_LIB_LOGD("Destroying string field class object: %!+F", obj);
2067         finalize_field_class((void *) obj);
2068         g_free(obj);
2069 }
2070
2071 struct bt_field_class *bt_field_class_string_create(bt_trace_class *trace_class)
2072 {
2073         struct bt_field_class_string *string_fc = NULL;
2074
2075         BT_ASSERT_PRE_NON_NULL(trace_class, "Trace class");
2076         BT_LOGD_STR("Creating default string field class object.");
2077         string_fc = g_new0(struct bt_field_class_string, 1);
2078         if (!string_fc) {
2079                 BT_LIB_LOGE_APPEND_CAUSE(
2080                         "Failed to allocate one string field class.");
2081                 goto error;
2082         }
2083
2084         if (init_field_class((void *) string_fc, BT_FIELD_CLASS_TYPE_STRING,
2085                         destroy_string_field_class)) {
2086                 goto error;
2087         }
2088
2089         BT_LIB_LOGD("Created string field class object: %!+F", string_fc);
2090         goto end;
2091
2092 error:
2093         BT_OBJECT_PUT_REF_AND_RESET(string_fc);
2094
2095 end:
2096         return (void *) string_fc;
2097 }
2098
2099 BT_HIDDEN
2100 void _bt_field_class_freeze(const struct bt_field_class *c_fc)
2101 {
2102         struct bt_field_class *fc = (void *) c_fc;
2103
2104         /*
2105          * Element/member/option field classes are frozen when added to
2106          * their owner.
2107          */
2108         BT_ASSERT(fc);
2109         bt_value_freeze(fc->user_attributes);
2110         fc->frozen = true;
2111
2112         switch (fc->type) {
2113         case BT_FIELD_CLASS_TYPE_STRUCTURE:
2114         case BT_FIELD_CLASS_TYPE_VARIANT_WITHOUT_SELECTOR:
2115         case BT_FIELD_CLASS_TYPE_VARIANT_WITH_UNSIGNED_INTEGER_SELECTOR:
2116         case BT_FIELD_CLASS_TYPE_VARIANT_WITH_SIGNED_INTEGER_SELECTOR:
2117         {
2118                 struct bt_field_class_named_field_class_container *container_fc =
2119                         (void *) fc;
2120                 uint64_t i;
2121
2122                 for (i = 0; i < container_fc->named_fcs->len; i++) {
2123                         bt_named_field_class_freeze(
2124                                 container_fc->named_fcs->pdata[i]);
2125                 }
2126
2127                 break;
2128         }
2129         default:
2130                 break;
2131         }
2132 }
2133
2134 BT_HIDDEN
2135 void _bt_named_field_class_freeze(const struct bt_named_field_class *named_fc)
2136 {
2137         BT_ASSERT(named_fc);
2138         BT_ASSERT(named_fc->fc->frozen);
2139         BT_LIB_LOGD("Freezing named field class's user attributes: %!+v",
2140                 named_fc->user_attributes);
2141         bt_value_freeze(named_fc->user_attributes);
2142         ((struct bt_named_field_class *) named_fc)->frozen = true;
2143 }
2144
2145 BT_HIDDEN
2146 void bt_field_class_make_part_of_trace_class(const struct bt_field_class *c_fc)
2147 {
2148         struct bt_field_class *fc = (void *) c_fc;
2149
2150         BT_ASSERT(fc);
2151         BT_ASSERT_PRE(!fc->part_of_trace_class,
2152                 "Field class is already part of a trace: %!+F", fc);
2153         fc->part_of_trace_class = true;
2154
2155         switch (fc->type) {
2156         case BT_FIELD_CLASS_TYPE_STRUCTURE:
2157         case BT_FIELD_CLASS_TYPE_VARIANT_WITHOUT_SELECTOR:
2158         case BT_FIELD_CLASS_TYPE_VARIANT_WITH_UNSIGNED_INTEGER_SELECTOR:
2159         case BT_FIELD_CLASS_TYPE_VARIANT_WITH_SIGNED_INTEGER_SELECTOR:
2160         {
2161                 struct bt_field_class_named_field_class_container *container_fc =
2162                         (void *) fc;
2163                 uint64_t i;
2164
2165                 for (i = 0; i < container_fc->named_fcs->len; i++) {
2166                         struct bt_named_field_class *named_fc =
2167                                 container_fc->named_fcs->pdata[i];
2168
2169                         bt_field_class_make_part_of_trace_class(named_fc->fc);
2170                 }
2171
2172                 break;
2173         }
2174         case BT_FIELD_CLASS_TYPE_STATIC_ARRAY:
2175         case BT_FIELD_CLASS_TYPE_DYNAMIC_ARRAY:
2176         {
2177                 struct bt_field_class_array *array_fc = (void *) fc;
2178
2179                 bt_field_class_make_part_of_trace_class(array_fc->element_fc);
2180                 break;
2181         }
2182         default:
2183                 break;
2184         }
2185 }
2186
2187 const struct bt_value *bt_field_class_borrow_user_attributes_const(
2188                 const struct bt_field_class *fc)
2189 {
2190         BT_ASSERT_PRE_DEV_NON_NULL(fc, "Field class");
2191         return fc->user_attributes;
2192 }
2193
2194 struct bt_value *bt_field_class_borrow_user_attributes(
2195                 struct bt_field_class *field_class)
2196 {
2197         return (void *) bt_field_class_borrow_user_attributes_const(
2198                 (void *) field_class);
2199 }
2200
2201
2202 void bt_field_class_set_user_attributes(
2203                 struct bt_field_class *fc,
2204                 const struct bt_value *user_attributes)
2205 {
2206         BT_ASSERT_PRE_NON_NULL(fc, "Field class");
2207         BT_ASSERT_PRE_NON_NULL(user_attributes, "User attributes");
2208         BT_ASSERT_PRE(user_attributes->type == BT_VALUE_TYPE_MAP,
2209                 "User attributes object is not a map value object.");
2210         BT_ASSERT_PRE_DEV_FC_HOT(fc, "Field class");
2211         bt_object_put_ref_no_null_check(fc->user_attributes);
2212         fc->user_attributes = (void *) user_attributes;
2213         bt_object_get_ref_no_null_check(fc->user_attributes);
2214 }
2215
2216 static
2217 const struct bt_value *bt_named_field_class_borrow_user_attributes_const(
2218                 const struct bt_named_field_class *named_fc)
2219 {
2220         return named_fc->user_attributes;
2221 }
2222
2223 static
2224 void bt_named_field_class_set_user_attributes(
2225                 struct bt_named_field_class *named_fc,
2226                 const struct bt_value *user_attributes)
2227 {
2228         BT_ASSERT_PRE_NON_NULL(user_attributes, "User attributes");
2229         BT_ASSERT_PRE(user_attributes->type == BT_VALUE_TYPE_MAP,
2230                 "User attributes object is not a map value object.");
2231         BT_ASSERT_PRE_DEV_HOT(named_fc,
2232                 "Structure field class member or variant field class option",
2233                 ".");
2234         bt_object_put_ref_no_null_check(named_fc->user_attributes);
2235         named_fc->user_attributes = (void *) user_attributes;
2236         bt_object_get_ref_no_null_check(named_fc->user_attributes);
2237 }
2238
2239 const struct bt_value *
2240 bt_field_class_structure_member_borrow_user_attributes_const(
2241                 const struct bt_field_class_structure_member *member)
2242 {
2243         BT_ASSERT_PRE_NON_NULL(member, "Structure field class member");
2244         return bt_named_field_class_borrow_user_attributes_const(
2245                 (const void *) member);
2246 }
2247
2248 struct bt_value *
2249 bt_field_class_structure_member_borrow_user_attributes(
2250                 struct bt_field_class_structure_member *member)
2251 {
2252         BT_ASSERT_PRE_NON_NULL(member, "Structure field class member");
2253         return (void *) bt_named_field_class_borrow_user_attributes_const(
2254                 (void *) member);
2255 }
2256
2257 void bt_field_class_structure_member_set_user_attributes(
2258                 struct bt_field_class_structure_member *member,
2259                 const struct bt_value *user_attributes)
2260 {
2261         BT_ASSERT_PRE_NON_NULL(member, "Structure field class member");
2262         bt_named_field_class_set_user_attributes((void *) member,
2263                 user_attributes);
2264 }
2265
2266 const struct bt_value *bt_field_class_variant_option_borrow_user_attributes_const(
2267                 const struct bt_field_class_variant_option *option)
2268 {
2269         BT_ASSERT_PRE_NON_NULL(option, "Variant field class option");
2270         return bt_named_field_class_borrow_user_attributes_const(
2271                 (const void *) option);
2272 }
2273
2274 struct bt_value *bt_field_class_variant_option_borrow_user_attributes(
2275                 struct bt_field_class_variant_option *option)
2276 {
2277         BT_ASSERT_PRE_NON_NULL(option, "Variant field class option");
2278         return (void *) bt_named_field_class_borrow_user_attributes_const(
2279                 (void *) option);
2280 }
2281
2282 void bt_field_class_variant_option_set_user_attributes(
2283                 struct bt_field_class_variant_option *option,
2284                 const struct bt_value *user_attributes)
2285 {
2286         BT_ASSERT_PRE_NON_NULL(option, "Variant field class option");
2287         bt_named_field_class_set_user_attributes((void *) option,
2288                 user_attributes);
2289 }
2290
2291 void bt_field_class_get_ref(const struct bt_field_class *field_class)
2292 {
2293         bt_object_get_ref(field_class);
2294 }
2295
2296 void bt_field_class_put_ref(const struct bt_field_class *field_class)
2297 {
2298         bt_object_put_ref(field_class);
2299 }