2 * Copyright 2017-2018 Philippe Proulx <pproulx@efficios.com>
3 * Copyright 2013, 2014 Jérémie Galarneau <jeremie.galarneau@efficios.com>
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:
12 * The above copyright notice and this permission notice shall be included in
13 * all copies or substantial portions of the Software.
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
24 #define BT_LOG_TAG "LIB/FIELD-CLASS"
25 #include "lib/logging.h"
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"
42 #include "clock-class.h"
43 #include "field-class.h"
45 #include "field-path.h"
47 #include "lib/func-status.h"
48 #include "lib/integer-range-set.h"
49 #include "lib/value.h"
51 enum bt_field_class_type
bt_field_class_get_type(
52 const struct bt_field_class
*fc
)
54 BT_ASSERT_PRE_DEV_NON_NULL(fc
, "Field class");
59 int init_field_class(struct bt_field_class
*fc
, enum bt_field_class_type type
,
60 bt_object_release_func release_func
)
65 BT_ASSERT(release_func
);
66 bt_object_init_shared(&fc
->base
, release_func
);
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.");
81 void finalize_field_class(struct bt_field_class
*fc
)
83 BT_OBJECT_PUT_REF_AND_RESET(fc
->user_attributes
);
87 void destroy_bit_array_field_class(struct bt_object
*obj
)
90 BT_LIB_LOGD("Destroying bit array field class object: %!+F", obj
);
91 finalize_field_class((void *) obj
);
95 struct bt_field_class
*bt_field_class_bit_array_create(
96 struct bt_trace_class
*trace_class
, uint64_t length
)
98 struct bt_field_class_bit_array
*ba_fc
= NULL
;
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);
107 BT_LIB_LOGE_APPEND_CAUSE(
108 "Failed to allocate one bit array field class.");
112 if (init_field_class((void *) ba_fc
, BT_FIELD_CLASS_TYPE_BIT_ARRAY
,
113 destroy_bit_array_field_class
)) {
117 ba_fc
->length
= length
;
118 BT_LIB_LOGD("Created bit array field class object: %!+F", ba_fc
);
122 BT_OBJECT_PUT_REF_AND_RESET(ba_fc
);
125 return (void *) ba_fc
;
128 uint64_t bt_field_class_bit_array_get_length(const struct bt_field_class
*fc
)
130 const struct bt_field_class_bit_array
*ba_fc
= (const void *) fc
;
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
,
135 return ba_fc
->length
;
139 void destroy_bool_field_class(struct bt_object
*obj
)
142 BT_LIB_LOGD("Destroying boolean field class object: %!+F", obj
);
143 finalize_field_class((void *) obj
);
147 struct bt_field_class
*bt_field_class_bool_create(
148 bt_trace_class
*trace_class
)
150 struct bt_field_class_bool
*bool_fc
= NULL
;
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);
156 BT_LIB_LOGE_APPEND_CAUSE(
157 "Failed to allocate one boolean field class.");
161 if (init_field_class((void *) bool_fc
, BT_FIELD_CLASS_TYPE_BOOL
,
162 destroy_bool_field_class
)) {
166 BT_LIB_LOGD("Created boolean field class object: %!+F", bool_fc
);
170 BT_OBJECT_PUT_REF_AND_RESET(bool_fc
);
173 return (void *) bool_fc
;
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
)
183 ret
= init_field_class((void *) fc
, type
, release_func
);
189 fc
->base
= BT_FIELD_CLASS_INTEGER_PREFERRED_DISPLAY_BASE_DECIMAL
;
196 void destroy_integer_field_class(struct bt_object
*obj
)
199 BT_LIB_LOGD("Destroying integer field class object: %!+F", obj
);
200 finalize_field_class((void *) obj
);
205 struct bt_field_class
*create_integer_field_class(bt_trace_class
*trace_class
,
206 enum bt_field_class_type type
)
208 struct bt_field_class_integer
*int_fc
= NULL
;
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);
215 BT_LIB_LOGE_APPEND_CAUSE(
216 "Failed to allocate one integer field class.");
220 if (init_integer_field_class(int_fc
, type
,
221 destroy_integer_field_class
)) {
225 BT_LIB_LOGD("Created integer field class object: %!+F", int_fc
);
229 BT_OBJECT_PUT_REF_AND_RESET(int_fc
);
232 return (void *) int_fc
;
235 struct bt_field_class
*bt_field_class_integer_unsigned_create(
236 bt_trace_class
*trace_class
)
238 return create_integer_field_class(trace_class
,
239 BT_FIELD_CLASS_TYPE_UNSIGNED_INTEGER
);
242 struct bt_field_class
*bt_field_class_integer_signed_create(
243 bt_trace_class
*trace_class
)
245 return create_integer_field_class(trace_class
,
246 BT_FIELD_CLASS_TYPE_SIGNED_INTEGER
);
249 uint64_t bt_field_class_integer_get_field_value_range(
250 const struct bt_field_class
*fc
)
252 const struct bt_field_class_integer
*int_fc
= (const void *) fc
;
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
;
260 bool size_is_valid_for_enumeration_field_class(struct bt_field_class
*fc
,
267 void bt_field_class_integer_set_field_value_range(
268 struct bt_field_class
*fc
, uint64_t size
)
270 struct bt_field_class_integer
*int_fc
= (void *) fc
;
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
);
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
);
289 enum bt_field_class_integer_preferred_display_base
290 bt_field_class_integer_get_preferred_display_base(const struct bt_field_class
*fc
)
292 const struct bt_field_class_integer
*int_fc
= (const void *) fc
;
294 BT_ASSERT_PRE_DEV_NON_NULL(fc
, "Field class");
295 BT_ASSERT_PRE_DEV_FC_IS_INT(fc
, "Field class");
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
)
303 struct bt_field_class_integer
*int_fc
= (void *) fc
;
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");
309 BT_LIB_LOGD("Set integer field class's preferred display base: %!+F", fc
);
313 void finalize_enumeration_field_class_mapping(
314 struct bt_field_class_enumeration_mapping
*mapping
)
318 if (mapping
->label
) {
319 g_string_free(mapping
->label
, TRUE
);
320 mapping
->label
= NULL
;
323 BT_OBJECT_PUT_REF_AND_RESET(mapping
->range_set
);
327 void destroy_enumeration_field_class(struct bt_object
*obj
)
329 struct bt_field_class_enumeration
*fc
= (void *) obj
;
332 BT_LIB_LOGD("Destroying enumeration field class object: %!+F", fc
);
333 finalize_field_class((void *) obj
);
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
));
343 g_array_free(fc
->mappings
, TRUE
);
348 g_ptr_array_free(fc
->label_buf
, TRUE
);
349 fc
->label_buf
= NULL
;
356 struct bt_field_class
*create_enumeration_field_class(
357 bt_trace_class
*trace_class
, enum bt_field_class_type type
)
359 struct bt_field_class_enumeration
*enum_fc
= NULL
;
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);
366 BT_LIB_LOGE_APPEND_CAUSE(
367 "Failed to allocate one enumeration field class.");
371 if (init_integer_field_class((void *) enum_fc
, type
,
372 destroy_enumeration_field_class
)) {
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.");
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.");
389 BT_LIB_LOGD("Created enumeration field class object: %!+F", enum_fc
);
393 BT_OBJECT_PUT_REF_AND_RESET(enum_fc
);
396 return (void *) enum_fc
;
399 struct bt_field_class
*bt_field_class_enumeration_unsigned_create(
400 bt_trace_class
*trace_class
)
402 return create_enumeration_field_class(trace_class
,
403 BT_FIELD_CLASS_TYPE_UNSIGNED_ENUMERATION
);
406 struct bt_field_class
*bt_field_class_enumeration_signed_create(
407 bt_trace_class
*trace_class
)
409 return create_enumeration_field_class(trace_class
,
410 BT_FIELD_CLASS_TYPE_SIGNED_ENUMERATION
);
413 uint64_t bt_field_class_enumeration_get_mapping_count(
414 const struct bt_field_class
*fc
)
416 const struct bt_field_class_enumeration
*enum_fc
= (const void *) fc
;
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
;
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
)
427 const struct bt_field_class_enumeration
*enum_fc
= (const void *) fc
;
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
,
433 return (const void *) BT_FIELD_CLASS_ENUM_MAPPING_AT_INDEX(fc
, index
);
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
)
440 const struct bt_field_class_enumeration
*enum_fc
= (const void *) fc
;
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
,
446 return (const void *) BT_FIELD_CLASS_ENUM_MAPPING_AT_INDEX(fc
, index
);
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
)
454 struct bt_field_class_enumeration_mapping
*mapping
= NULL
;
458 BT_ASSERT_PRE_DEV_NON_NULL(label
, "Label");
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
);
464 if (strcmp(this_mapping
->label
->str
, label
) == 0) {
465 mapping
= this_mapping
;
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
)
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
,
481 return (const void *) borrow_enumeration_field_class_mapping_by_label(
482 (const void *) fc
, label
);
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
)
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
);
496 const char *bt_field_class_enumeration_mapping_get_label(
497 const struct bt_field_class_enumeration_mapping
*mapping
)
499 BT_ASSERT_PRE_DEV_NON_NULL(mapping
, "Enumeration field class mapping");
500 return mapping
->label
->str
;
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
)
507 const struct bt_field_class_enumeration_mapping
*mapping
=
508 (const void *) u_mapping
;
510 BT_ASSERT_PRE_DEV_NON_NULL(mapping
, "Enumeration field class mapping");
511 return (const void *) mapping
->range_set
;
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
)
518 const struct bt_field_class_enumeration_mapping
*mapping
=
519 (const void *) s_mapping
;
521 BT_ASSERT_PRE_DEV_NON_NULL(mapping
, "Enumeration field class mapping");
522 return (const void *) mapping
->range_set
;
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
,
531 const struct bt_field_class_enumeration
*enum_fc
= (const void *) fc
;
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
,
539 g_ptr_array_set_size(enum_fc
->label_buf
, 0);
541 for (i
= 0; i
< enum_fc
->mappings
->len
; i
++) {
543 const struct bt_field_class_enumeration_mapping
*mapping
=
544 BT_FIELD_CLASS_ENUM_MAPPING_AT_INDEX(enum_fc
, i
);
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
);
551 if (value
>= range
->lower
.u
&&
552 value
<= range
->upper
.u
) {
553 g_ptr_array_add(enum_fc
->label_buf
,
554 mapping
->label
->str
);
560 *label_array
= (void *) enum_fc
->label_buf
->pdata
;
561 *count
= (uint64_t) enum_fc
->label_buf
->len
;
562 return BT_FUNC_STATUS_OK
;
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
,
571 const struct bt_field_class_enumeration
*enum_fc
= (const void *) fc
;
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
,
579 g_ptr_array_set_size(enum_fc
->label_buf
, 0);
581 for (i
= 0; i
< enum_fc
->mappings
->len
; i
++) {
583 const struct bt_field_class_enumeration_mapping
*mapping
=
584 BT_FIELD_CLASS_ENUM_MAPPING_AT_INDEX(enum_fc
, i
);
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
);
591 if (value
>= range
->lower
.i
&&
592 value
<= range
->upper
.i
) {
593 g_ptr_array_add(enum_fc
->label_buf
,
594 mapping
->label
->str
);
600 *label_array
= (void *) enum_fc
->label_buf
->pdata
;
601 *count
= (uint64_t) enum_fc
->label_buf
->len
;
602 return BT_FUNC_STATUS_OK
;
606 bool enumeration_field_class_has_mapping_with_label(
607 const struct bt_field_class_enumeration
*enum_fc
,
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
);
620 if (strcmp(mapping_candidate
->label
->str
, label
) == 0) {
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
)
635 enum bt_field_class_enumeration_add_mapping_status status
=
637 struct bt_field_class_enumeration
*enum_fc
= (void *) fc
;
638 struct bt_field_class_enumeration_mapping mapping
= { 0 };
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(
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
;
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
);
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
)
669 BT_ASSERT_PRE_NON_NULL(fc
, "Field class");
670 BT_ASSERT_PRE_FC_HAS_ID(fc
, BT_FIELD_CLASS_TYPE_UNSIGNED_ENUMERATION
,
672 return add_mapping_to_enumeration_field_class(fc
, label
,
673 (const void *) range_set
);
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
)
681 BT_ASSERT_PRE_NON_NULL(fc
, "Field class");
682 BT_ASSERT_PRE_FC_HAS_ID(fc
, BT_FIELD_CLASS_TYPE_SIGNED_ENUMERATION
,
684 return add_mapping_to_enumeration_field_class(fc
, label
,
685 (const void *) range_set
);
689 void destroy_real_field_class(struct bt_object
*obj
)
692 BT_LIB_LOGD("Destroying real field class object: %!+F", obj
);
693 finalize_field_class((void *) obj
);
697 struct bt_field_class
*bt_field_class_real_create(bt_trace_class
*trace_class
)
699 struct bt_field_class_real
*real_fc
= NULL
;
701 BT_ASSERT_PRE_NON_NULL(trace_class
, "Trace class");
702 BT_LOGD_STR("Creating default real field class object.");
703 real_fc
= g_new0(struct bt_field_class_real
, 1);
705 BT_LIB_LOGE_APPEND_CAUSE("Failed to allocate one real field class.");
709 if (init_field_class((void *) real_fc
, BT_FIELD_CLASS_TYPE_REAL
,
710 destroy_real_field_class
)) {
714 BT_LIB_LOGD("Created real field class object: %!+F", real_fc
);
718 BT_OBJECT_PUT_REF_AND_RESET(real_fc
);
721 return (void *) real_fc
;
724 bt_bool
bt_field_class_real_is_single_precision(const struct bt_field_class
*fc
)
726 const struct bt_field_class_real
*real_fc
= (const void *) fc
;
728 BT_ASSERT_PRE_DEV_NON_NULL(fc
, "Field class");
729 BT_ASSERT_PRE_DEV_FC_HAS_ID(fc
, BT_FIELD_CLASS_TYPE_REAL
, "Field class");
730 return real_fc
->is_single_precision
;
733 void bt_field_class_real_set_is_single_precision(struct bt_field_class
*fc
,
734 bt_bool is_single_precision
)
736 struct bt_field_class_real
*real_fc
= (void *) fc
;
738 BT_ASSERT_PRE_NON_NULL(fc
, "Field class");
739 BT_ASSERT_PRE_FC_HAS_ID(fc
, BT_FIELD_CLASS_TYPE_REAL
, "Field class");
740 BT_ASSERT_PRE_DEV_FC_HOT(fc
, "Field class");
741 real_fc
->is_single_precision
= (bool) is_single_precision
;
742 BT_LIB_LOGD("Set real field class's \"is single precision\" property: "
747 int init_named_field_classes_container(
748 struct bt_field_class_named_field_class_container
*fc
,
749 enum bt_field_class_type type
,
750 bt_object_release_func fc_release_func
,
751 GDestroyNotify named_fc_destroy_func
)
755 ret
= init_field_class((void *) fc
, type
, fc_release_func
);
760 fc
->named_fcs
= g_ptr_array_new_with_free_func(named_fc_destroy_func
);
761 if (!fc
->named_fcs
) {
762 BT_LIB_LOGE_APPEND_CAUSE("Failed to allocate a GPtrArray.");
767 fc
->name_to_index
= g_hash_table_new(g_str_hash
, g_str_equal
);
768 if (!fc
->name_to_index
) {
769 BT_LIB_LOGE_APPEND_CAUSE("Failed to allocate a GHashTable.");
779 void finalize_named_field_class(struct bt_named_field_class
*named_fc
)
782 BT_LIB_LOGD("Finalizing named field class: "
783 "addr=%p, name=\"%s\", %![fc-]+F",
784 named_fc
, named_fc
->name
? named_fc
->name
->str
: NULL
,
786 BT_OBJECT_PUT_REF_AND_RESET(named_fc
->user_attributes
);
788 if (named_fc
->name
) {
789 g_string_free(named_fc
->name
, TRUE
);
790 named_fc
->name
= NULL
;
793 BT_LOGD_STR("Putting named field class's field class.");
794 BT_OBJECT_PUT_REF_AND_RESET(named_fc
->fc
);
798 void destroy_named_field_class(gpointer ptr
)
800 struct bt_named_field_class
*named_fc
= ptr
;
803 BT_OBJECT_PUT_REF_AND_RESET(named_fc
->user_attributes
);
804 finalize_named_field_class(ptr
);
810 void destroy_variant_with_selector_option(gpointer ptr
)
812 struct bt_field_class_variant_with_selector_option
*opt
= ptr
;
815 finalize_named_field_class(&opt
->common
);
816 BT_OBJECT_PUT_REF_AND_RESET(opt
->range_set
);
822 void finalize_named_field_classes_container(
823 struct bt_field_class_named_field_class_container
*fc
)
828 g_ptr_array_free(fc
->named_fcs
, TRUE
);
829 fc
->named_fcs
= NULL
;
833 if (fc
->name_to_index
) {
834 g_hash_table_destroy(fc
->name_to_index
);
835 fc
->name_to_index
= NULL
;
840 void destroy_structure_field_class(struct bt_object
*obj
)
843 BT_LIB_LOGD("Destroying structure field class object: %!+F", obj
);
844 finalize_field_class((void *) obj
);
845 finalize_named_field_classes_container((void *) obj
);
849 struct bt_field_class
*bt_field_class_structure_create(
850 bt_trace_class
*trace_class
)
853 struct bt_field_class_structure
*struct_fc
= NULL
;
855 BT_ASSERT_PRE_NON_NULL(trace_class
, "Trace class");
856 BT_LOGD_STR("Creating default structure field class object.");
857 struct_fc
= g_new0(struct bt_field_class_structure
, 1);
859 BT_LIB_LOGE_APPEND_CAUSE(
860 "Failed to allocate one structure field class.");
864 ret
= init_named_field_classes_container((void *) struct_fc
,
865 BT_FIELD_CLASS_TYPE_STRUCTURE
, destroy_structure_field_class
,
866 destroy_named_field_class
);
868 /* init_named_field_classes_container() logs errors */
872 BT_LIB_LOGD("Created structure field class object: %!+F", struct_fc
);
876 BT_OBJECT_PUT_REF_AND_RESET(struct_fc
);
879 return (void *) struct_fc
;
883 int init_named_field_class(struct bt_named_field_class
*named_fc
,
884 const char *name
, struct bt_field_class
*fc
)
886 int status
= BT_FUNC_STATUS_OK
;
891 named_fc
->name
= g_string_new(name
);
892 if (!named_fc
->name
) {
893 BT_LIB_LOGE_APPEND_CAUSE("Failed to allocate a GString.");
894 status
= BT_FUNC_STATUS_MEMORY_ERROR
;
898 named_fc
->user_attributes
= bt_value_map_create();
899 if (!named_fc
->user_attributes
) {
900 BT_LIB_LOGE_APPEND_CAUSE(
901 "Failed to create a map value object.");
902 status
= BT_FUNC_STATUS_MEMORY_ERROR
;
907 bt_object_get_no_null_check(named_fc
->fc
);
914 struct bt_named_field_class
*create_named_field_class(const char *name
,
915 struct bt_field_class
*fc
)
917 struct bt_named_field_class
*named_fc
= g_new0(
918 struct bt_named_field_class
, 1);
921 BT_LIB_LOGE_APPEND_CAUSE(
922 "Failed to allocate a named field class.");
926 if (init_named_field_class(named_fc
, name
, fc
)) {
927 /* init_named_field_class() logs errors */
934 destroy_named_field_class(named_fc
);
942 struct bt_field_class_variant_with_selector_option
*
943 create_variant_with_selector_option(
944 const char *name
, struct bt_field_class
*fc
,
945 const struct bt_integer_range_set
*range_set
)
947 struct bt_field_class_variant_with_selector_option
*opt
= g_new0(
948 struct bt_field_class_variant_with_selector_option
, 1);
950 BT_ASSERT(range_set
);
953 BT_LIB_LOGE_APPEND_CAUSE(
954 "Failed to allocate a named field class.");
958 if (init_named_field_class(&opt
->common
, name
, fc
)) {
962 opt
->range_set
= range_set
;
963 bt_object_get_no_null_check(opt
->range_set
);
964 bt_integer_range_set_freeze(range_set
);
968 destroy_variant_with_selector_option(opt
);
976 int append_named_field_class_to_container_field_class(
977 struct bt_field_class_named_field_class_container
*container_fc
,
978 struct bt_named_field_class
*named_fc
)
980 BT_ASSERT(container_fc
);
982 BT_ASSERT_PRE_DEV_FC_HOT(container_fc
, "Field class");
983 BT_ASSERT_PRE(!bt_g_hash_table_contains(container_fc
->name_to_index
,
984 named_fc
->name
->str
),
985 "Duplicate member/option name in structure/variant field class: "
986 "%![container-fc-]+F, name=\"%s\"", container_fc
,
987 named_fc
->name
->str
);
990 * Freeze the contained field class, but not the named field
991 * class itself, as it's still possible afterwards to modify
992 * properties of the member/option object.
994 bt_field_class_freeze(named_fc
->fc
);
995 g_ptr_array_add(container_fc
->named_fcs
, named_fc
);
996 g_hash_table_insert(container_fc
->name_to_index
, named_fc
->name
->str
,
997 GUINT_TO_POINTER(container_fc
->named_fcs
->len
- 1));
998 return BT_FUNC_STATUS_OK
;
1001 enum bt_field_class_structure_append_member_status
1002 bt_field_class_structure_append_member(
1003 struct bt_field_class
*fc
, const char *name
,
1004 struct bt_field_class
*member_fc
)
1006 enum bt_field_class_structure_append_member_status status
;
1007 struct bt_named_field_class
*named_fc
= NULL
;
1009 BT_ASSERT_PRE_NON_NULL(fc
, "Field class");
1010 BT_ASSERT_PRE_FC_HAS_ID(fc
, BT_FIELD_CLASS_TYPE_STRUCTURE
,
1012 named_fc
= create_named_field_class(name
, member_fc
);
1014 /* create_named_field_class() logs errors */
1015 status
= BT_FUNC_STATUS_MEMORY_ERROR
;
1019 status
= append_named_field_class_to_container_field_class((void *) fc
,
1021 if (status
== BT_FUNC_STATUS_OK
) {
1022 /* Moved to the container */
1030 uint64_t bt_field_class_structure_get_member_count(
1031 const struct bt_field_class
*fc
)
1033 struct bt_field_class_structure
*struct_fc
= (void *) fc
;
1035 BT_ASSERT_PRE_DEV_NON_NULL(fc
, "Field class");
1036 BT_ASSERT_PRE_DEV_FC_HAS_ID(fc
, BT_FIELD_CLASS_TYPE_STRUCTURE
,
1038 return (uint64_t) struct_fc
->common
.named_fcs
->len
;
1042 struct bt_named_field_class
*
1043 borrow_named_field_class_from_container_field_class_at_index(
1044 struct bt_field_class_named_field_class_container
*fc
,
1048 BT_ASSERT_PRE_DEV_VALID_INDEX(index
, fc
->named_fcs
->len
);
1049 return fc
->named_fcs
->pdata
[index
];
1052 const struct bt_field_class_structure_member
*
1053 bt_field_class_structure_borrow_member_by_index_const(
1054 const struct bt_field_class
*fc
, uint64_t index
)
1056 BT_ASSERT_PRE_DEV_NON_NULL(fc
, "Field class");
1057 BT_ASSERT_PRE_DEV_FC_HAS_ID(fc
, BT_FIELD_CLASS_TYPE_STRUCTURE
,
1059 return (const void *)
1060 borrow_named_field_class_from_container_field_class_at_index(
1061 (void *) fc
, index
);
1064 struct bt_field_class_structure_member
*
1065 bt_field_class_structure_borrow_member_by_index(
1066 struct bt_field_class
*fc
, uint64_t index
)
1068 BT_ASSERT_PRE_DEV_NON_NULL(fc
, "Field class");
1069 BT_ASSERT_PRE_DEV_FC_HAS_ID(fc
, BT_FIELD_CLASS_TYPE_STRUCTURE
,
1072 borrow_named_field_class_from_container_field_class_at_index(
1073 (void *) fc
, index
);
1077 struct bt_named_field_class
*
1078 borrow_named_field_class_from_container_field_class_by_name(
1079 struct bt_field_class_named_field_class_container
*fc
,
1082 struct bt_named_field_class
*named_fc
= NULL
;
1087 BT_ASSERT_PRE_DEV_NON_NULL(name
, "Name");
1088 if (!g_hash_table_lookup_extended(fc
->name_to_index
, name
, &orig_key
,
1093 named_fc
= fc
->named_fcs
->pdata
[GPOINTER_TO_UINT(value
)];
1099 const struct bt_field_class_structure_member
*
1100 bt_field_class_structure_borrow_member_by_name_const(
1101 const struct bt_field_class
*fc
, const char *name
)
1103 BT_ASSERT_PRE_DEV_NON_NULL(fc
, "Field class");
1104 BT_ASSERT_PRE_DEV_FC_HAS_ID(fc
, BT_FIELD_CLASS_TYPE_STRUCTURE
,
1106 return (const void *)
1107 borrow_named_field_class_from_container_field_class_by_name(
1111 struct bt_field_class_structure_member
*
1112 bt_field_class_structure_borrow_member_by_name(
1113 struct bt_field_class
*fc
, const char *name
)
1115 BT_ASSERT_PRE_DEV_NON_NULL(fc
, "Field class");
1116 BT_ASSERT_PRE_DEV_FC_HAS_ID(fc
, BT_FIELD_CLASS_TYPE_STRUCTURE
,
1119 borrow_named_field_class_from_container_field_class_by_name(
1123 const char *bt_field_class_structure_member_get_name(
1124 const struct bt_field_class_structure_member
*member
)
1126 const struct bt_named_field_class
*named_fc
= (const void *) member
;
1128 BT_ASSERT_PRE_DEV_NON_NULL(member
, "Structure field class member");
1129 return named_fc
->name
->str
;
1132 const struct bt_field_class
*
1133 bt_field_class_structure_member_borrow_field_class_const(
1134 const struct bt_field_class_structure_member
*member
)
1136 const struct bt_named_field_class
*named_fc
= (const void *) member
;
1138 BT_ASSERT_PRE_DEV_NON_NULL(member
, "Structure field class member");
1139 return named_fc
->fc
;
1143 void destroy_option_field_class(struct bt_object
*obj
)
1145 struct bt_field_class_option
*fc
= (void *) obj
;
1148 BT_LIB_LOGD("Destroying option field class object: %!+F", fc
);
1149 finalize_field_class((void *) obj
);
1150 BT_LOGD_STR("Putting content field class.");
1151 BT_OBJECT_PUT_REF_AND_RESET(fc
->content_fc
);
1152 BT_LOGD_STR("Putting selector field path.");
1153 BT_OBJECT_PUT_REF_AND_RESET(fc
->selector_field_path
);
1154 BT_LOGD_STR("Putting selector field class.");
1155 BT_OBJECT_PUT_REF_AND_RESET(fc
->selector_fc
);
1159 struct bt_field_class
*bt_field_class_option_create(bt_trace_class
*trace_class
,
1160 bt_field_class
*content_fc
, bt_field_class
*selector_fc
)
1162 struct bt_field_class_option
*opt_fc
= NULL
;
1164 BT_ASSERT_PRE_NON_NULL(trace_class
, "Trace class");
1165 BT_ASSERT_PRE_NON_NULL(content_fc
, "Content field class");
1166 BT_LIB_LOGD("Creating option field class: "
1167 "%![content-fc-]+F, %![sel-fc-]+F", content_fc
, selector_fc
);
1168 opt_fc
= g_new0(struct bt_field_class_option
, 1);
1170 BT_LIB_LOGE_APPEND_CAUSE(
1171 "Failed to allocate one option field class.");
1175 if (init_field_class((void *) opt_fc
, BT_FIELD_CLASS_TYPE_OPTION
,
1176 destroy_option_field_class
)) {
1180 opt_fc
->content_fc
= content_fc
;
1181 bt_object_get_no_null_check(opt_fc
->content_fc
);
1182 bt_field_class_freeze(opt_fc
->content_fc
);
1185 BT_ASSERT_PRE_FC_HAS_ID(selector_fc
, BT_FIELD_CLASS_TYPE_BOOL
,
1186 "Selector field class");
1187 opt_fc
->selector_fc
= selector_fc
;
1188 bt_object_get_no_null_check(opt_fc
->selector_fc
);
1189 bt_field_class_freeze(selector_fc
);
1192 BT_LIB_LOGD("Created option field class object: "
1193 "%![opt-fc-]+F, %![sel-fc-]+F", opt_fc
, selector_fc
);
1197 BT_OBJECT_PUT_REF_AND_RESET(opt_fc
);
1200 return (void *) opt_fc
;
1203 const struct bt_field_class
*bt_field_class_option_borrow_field_class_const(
1204 const struct bt_field_class
*fc
)
1206 struct bt_field_class_option
*opt_fc
= (void *) fc
;
1208 BT_ASSERT_PRE_NON_NULL(fc
, "Field class");
1209 BT_ASSERT_PRE_DEV_FC_HAS_ID(fc
, BT_FIELD_CLASS_TYPE_OPTION
,
1211 return opt_fc
->content_fc
;
1214 const struct bt_field_path
*
1215 bt_field_class_option_borrow_selector_field_path_const(
1216 const struct bt_field_class
*fc
)
1218 struct bt_field_class_option
*opt_fc
= (void *) fc
;
1220 BT_ASSERT_PRE_NON_NULL(fc
, "Field class");
1221 BT_ASSERT_PRE_DEV_FC_HAS_ID(fc
, BT_FIELD_CLASS_TYPE_OPTION
,
1223 return opt_fc
->selector_field_path
;
1227 void finalize_variant_field_class(struct bt_field_class_variant
*var_fc
)
1230 BT_LIB_LOGD("Finalizing variant field class object: %!+F", var_fc
);
1231 finalize_field_class((void *) var_fc
);
1232 finalize_named_field_classes_container((void *) var_fc
);
1236 void destroy_variant_field_class(struct bt_object
*obj
)
1238 struct bt_field_class_variant
*fc
= (void *) obj
;
1241 finalize_variant_field_class(fc
);
1246 void destroy_variant_with_selector_field_class(struct bt_object
*obj
)
1248 struct bt_field_class_variant_with_selector
*fc
= (void *) obj
;
1251 finalize_variant_field_class(&fc
->common
);
1252 BT_LOGD_STR("Putting selector field path.");
1253 BT_OBJECT_PUT_REF_AND_RESET(fc
->selector_field_path
);
1254 BT_LOGD_STR("Putting selector field class.");
1255 BT_OBJECT_PUT_REF_AND_RESET(fc
->selector_fc
);
1259 struct bt_field_class
*bt_field_class_variant_create(
1260 bt_trace_class
*trace_class
, bt_field_class
*selector_fc
)
1263 struct bt_field_class_variant
*var_fc
= NULL
;
1264 struct bt_field_class_variant_with_selector
*var_with_sel_fc
= NULL
;
1265 enum bt_field_class_type fc_type
;
1267 BT_ASSERT_PRE_NON_NULL(trace_class
, "Trace class");
1270 BT_ASSERT_PRE_FC_IS_INT(selector_fc
, "Selector field class");
1273 BT_LIB_LOGD("Creating default variant field class: %![sel-fc-]+F",
1277 var_with_sel_fc
= g_new0(
1278 struct bt_field_class_variant_with_selector
, 1);
1279 if (!var_with_sel_fc
) {
1280 BT_LIB_LOGE_APPEND_CAUSE(
1281 "Failed to allocate one variant field class with selector.");
1285 if (selector_fc
->type
== BT_FIELD_CLASS_TYPE_UNSIGNED_INTEGER
||
1286 selector_fc
->type
== BT_FIELD_CLASS_TYPE_UNSIGNED_ENUMERATION
) {
1287 fc_type
= BT_FIELD_CLASS_TYPE_VARIANT_WITH_UNSIGNED_SELECTOR
;
1289 fc_type
= BT_FIELD_CLASS_TYPE_VARIANT_WITH_SIGNED_SELECTOR
;
1292 ret
= init_named_field_classes_container(
1293 (void *) var_with_sel_fc
, fc_type
,
1294 destroy_variant_with_selector_field_class
,
1295 destroy_variant_with_selector_option
);
1297 /* init_named_field_classes_container() logs errors */
1301 var_with_sel_fc
->selector_fc
= selector_fc
;
1302 bt_object_get_no_null_check(var_with_sel_fc
->selector_fc
);
1303 bt_field_class_freeze(selector_fc
);
1304 var_fc
= (void *) var_with_sel_fc
;
1306 var_fc
= g_new0(struct bt_field_class_variant
, 1);
1308 BT_LIB_LOGE_APPEND_CAUSE(
1309 "Failed to allocate one variant field class without selector.");
1313 ret
= init_named_field_classes_container((void *) var_fc
,
1314 BT_FIELD_CLASS_TYPE_VARIANT_WITHOUT_SELECTOR
,
1315 destroy_variant_field_class
, destroy_named_field_class
);
1317 /* init_named_field_classes_container() logs errors */
1323 BT_LIB_LOGD("Created default variant field class with selector object: "
1324 "%![var-fc-]+F, %![sel-fc-]+F", var_fc
, selector_fc
);
1328 BT_OBJECT_PUT_REF_AND_RESET(var_fc
);
1331 return (void *) var_fc
;
1334 enum bt_field_class_variant_without_selector_append_option_status
1335 bt_field_class_variant_without_selector_append_option(struct bt_field_class
*fc
,
1336 const char *name
, struct bt_field_class
*option_fc
)
1338 enum bt_field_class_variant_without_selector_append_option_status status
;
1339 struct bt_named_field_class
*named_fc
= NULL
;
1341 BT_ASSERT_PRE_NON_NULL(fc
, "Field class");
1342 BT_ASSERT_PRE_NON_NULL(name
, "Name");
1343 BT_ASSERT_PRE_NON_NULL(option_fc
, "Option field class");
1344 BT_ASSERT_PRE_FC_HAS_ID(fc
,
1345 BT_FIELD_CLASS_TYPE_VARIANT_WITHOUT_SELECTOR
, "Field class");
1346 named_fc
= create_named_field_class(name
, option_fc
);
1348 /* create_named_field_class() logs errors */
1349 status
= BT_FUNC_STATUS_MEMORY_ERROR
;
1353 status
= append_named_field_class_to_container_field_class((void *) fc
,
1355 if (status
== BT_FUNC_STATUS_OK
) {
1356 /* Moved to the container */
1362 destroy_named_field_class(named_fc
);
1369 int ranges_overlap(GPtrArray
*var_fc_opts
, const struct bt_integer_range_set
*range_set
,
1370 bool is_signed
, bool *has_overlap
)
1372 int status
= BT_FUNC_STATUS_OK
;
1373 struct bt_integer_range_set
*full_range_set
;
1376 *has_overlap
= false;
1379 * Build a single range set with all the ranges and test for
1383 full_range_set
= (void *) bt_integer_range_set_signed_create();
1385 full_range_set
= (void *) bt_integer_range_set_unsigned_create();
1388 if (!full_range_set
) {
1389 BT_LOGE_STR("Failed to create a range set.");
1390 status
= BT_FUNC_STATUS_MEMORY_ERROR
;
1394 /* Add existing option ranges */
1395 for (i
= 0; i
< var_fc_opts
->len
; i
++) {
1396 struct bt_field_class_variant_with_selector_option
*opt
=
1397 var_fc_opts
->pdata
[i
];
1400 for (j
= 0; j
< opt
->range_set
->ranges
->len
; j
++) {
1401 struct bt_integer_range
*range
= BT_INTEGER_RANGE_SET_RANGE_AT_INDEX(
1405 status
= bt_integer_range_set_signed_add_range(
1406 (void *) full_range_set
, range
->lower
.i
,
1409 status
= bt_integer_range_set_unsigned_add_range(
1410 (void *) full_range_set
, range
->lower
.u
,
1420 /* Add new ranges */
1421 for (i
= 0; i
< range_set
->ranges
->len
; i
++) {
1422 struct bt_integer_range
*range
= BT_INTEGER_RANGE_SET_RANGE_AT_INDEX(
1426 status
= bt_integer_range_set_signed_add_range(
1427 (void *) full_range_set
, range
->lower
.i
,
1430 status
= bt_integer_range_set_unsigned_add_range(
1431 (void *) full_range_set
, range
->lower
.u
,
1440 /* Check overlaps */
1442 *has_overlap
= bt_integer_range_set_signed_has_overlaps(full_range_set
);
1444 *has_overlap
= bt_integer_range_set_unsigned_has_overlaps(
1449 bt_object_put_ref(full_range_set
);
1454 int append_option_to_variant_with_selector_field_class(
1455 struct bt_field_class
*fc
, const char *name
,
1456 struct bt_field_class
*option_fc
,
1457 const struct bt_integer_range_set
*range_set
,
1458 enum bt_field_class_type expected_type
)
1461 struct bt_field_class_variant_with_selector
*var_fc
= (void *) fc
;
1462 struct bt_field_class_variant_with_selector_option
*opt
= NULL
;
1465 BT_ASSERT_PRE_NON_NULL(fc
, "Field class");
1466 BT_ASSERT_PRE_NON_NULL(name
, "Name");
1467 BT_ASSERT_PRE_NON_NULL(option_fc
, "Option field class");
1468 BT_ASSERT_PRE_NON_NULL(range_set
, "Integer range set");
1469 BT_ASSERT_PRE_FC_HAS_ID(fc
, expected_type
, "Field class");
1470 BT_ASSERT_PRE(range_set
->ranges
->len
> 0,
1471 "Integer range set is empty: %!+R", range_set
);
1472 status
= ranges_overlap(var_fc
->common
.common
.named_fcs
, range_set
,
1473 expected_type
== BT_FIELD_CLASS_TYPE_VARIANT_WITH_SIGNED_SELECTOR
,
1476 /* ranges_overlap() logs errors */
1480 BT_ASSERT_PRE(!has_overlap
,
1481 "Integer range set's ranges and existing ranges have an overlap: "
1483 opt
= create_variant_with_selector_option(name
, option_fc
, range_set
);
1485 /* create_variant_with_selector_option() logs errors */
1486 status
= BT_FUNC_STATUS_MEMORY_ERROR
;
1490 status
= append_named_field_class_to_container_field_class((void *) fc
,
1492 if (status
== BT_FUNC_STATUS_OK
) {
1493 /* Moved to the container */
1499 destroy_variant_with_selector_option(opt
);
1505 enum bt_field_class_variant_with_selector_append_option_status
1506 bt_field_class_variant_with_selector_unsigned_append_option(
1507 struct bt_field_class
*fc
, const char *name
,
1508 struct bt_field_class
*option_fc
,
1509 const struct bt_integer_range_set_unsigned
*range_set
)
1511 return append_option_to_variant_with_selector_field_class(fc
,
1512 name
, option_fc
, (const void *) range_set
,
1513 BT_FIELD_CLASS_TYPE_VARIANT_WITH_UNSIGNED_SELECTOR
);
1516 enum bt_field_class_variant_with_selector_append_option_status
1517 bt_field_class_variant_with_selector_signed_append_option(
1518 struct bt_field_class
*fc
, const char *name
,
1519 struct bt_field_class
*option_fc
,
1520 const struct bt_integer_range_set_signed
*range_set
)
1522 return append_option_to_variant_with_selector_field_class(fc
,
1523 name
, option_fc
, (const void *) range_set
,
1524 BT_FIELD_CLASS_TYPE_VARIANT_WITH_SIGNED_SELECTOR
);
1527 uint64_t bt_field_class_variant_get_option_count(const struct bt_field_class
*fc
)
1529 const struct bt_field_class_variant
*var_fc
= (const void *) fc
;
1531 BT_ASSERT_PRE_DEV_NON_NULL(fc
, "Field class");
1532 BT_ASSERT_PRE_DEV_FC_IS_VARIANT(fc
, "Field class");
1533 return (uint64_t) var_fc
->common
.named_fcs
->len
;
1536 const struct bt_field_class_variant_option
*
1537 bt_field_class_variant_borrow_option_by_name_const(
1538 const struct bt_field_class
*fc
, const char *name
)
1540 BT_ASSERT_PRE_DEV_NON_NULL(fc
, "Field class");
1541 BT_ASSERT_PRE_DEV_FC_IS_VARIANT(fc
, "Field class");
1542 return (const void *)
1543 borrow_named_field_class_from_container_field_class_by_name(
1547 const struct bt_field_class_variant_option
*
1548 bt_field_class_variant_borrow_option_by_index_const(
1549 const struct bt_field_class
*fc
, uint64_t index
)
1551 BT_ASSERT_PRE_DEV_NON_NULL(fc
, "Field class");
1552 BT_ASSERT_PRE_DEV_FC_IS_VARIANT(fc
, "Field class");
1553 return (const void *)
1554 borrow_named_field_class_from_container_field_class_at_index(
1555 (void *) fc
, index
);
1558 struct bt_field_class_variant_option
*
1559 bt_field_class_variant_borrow_option_by_name(
1560 struct bt_field_class
*fc
, const char *name
)
1562 BT_ASSERT_PRE_DEV_NON_NULL(fc
, "Field class");
1563 BT_ASSERT_PRE_DEV_FC_IS_VARIANT(fc
, "Field class");
1565 borrow_named_field_class_from_container_field_class_by_name(
1569 struct bt_field_class_variant_option
*
1570 bt_field_class_variant_borrow_option_by_index(
1571 struct bt_field_class
*fc
, uint64_t index
)
1573 BT_ASSERT_PRE_DEV_NON_NULL(fc
, "Field class");
1574 BT_ASSERT_PRE_DEV_FC_IS_VARIANT(fc
, "Field class");
1576 borrow_named_field_class_from_container_field_class_at_index(
1577 (void *) fc
, index
);
1580 const struct bt_field_class_variant_with_selector_unsigned_option
*
1581 bt_field_class_variant_with_selector_unsigned_borrow_option_by_name_const(
1582 const struct bt_field_class
*fc
, const char *name
)
1584 BT_ASSERT_PRE_DEV_NON_NULL(fc
, "Field class");
1585 BT_ASSERT_PRE_DEV_FC_HAS_ID(fc
,
1586 BT_FIELD_CLASS_TYPE_VARIANT_WITH_UNSIGNED_SELECTOR
,
1588 return (const void *)
1589 borrow_named_field_class_from_container_field_class_by_name(
1593 const struct bt_field_class_variant_with_selector_unsigned_option
*
1594 bt_field_class_variant_with_selector_unsigned_borrow_option_by_index_const(
1595 const struct bt_field_class
*fc
, uint64_t index
)
1597 BT_ASSERT_PRE_DEV_NON_NULL(fc
, "Field class");
1598 BT_ASSERT_PRE_DEV_FC_HAS_ID(fc
,
1599 BT_FIELD_CLASS_TYPE_VARIANT_WITH_UNSIGNED_SELECTOR
,
1601 return (const void *)
1602 borrow_named_field_class_from_container_field_class_at_index(
1603 (void *) fc
, index
);
1606 const struct bt_field_class_variant_with_selector_signed_option
*
1607 bt_field_class_variant_with_selector_signed_borrow_option_by_name_const(
1608 const struct bt_field_class
*fc
, const char *name
)
1610 BT_ASSERT_PRE_DEV_NON_NULL(fc
, "Field class");
1611 BT_ASSERT_PRE_DEV_FC_HAS_ID(fc
,
1612 BT_FIELD_CLASS_TYPE_VARIANT_WITH_SIGNED_SELECTOR
,
1614 return (const void *)
1615 borrow_named_field_class_from_container_field_class_by_name(
1619 const struct bt_field_class_variant_with_selector_signed_option
*
1620 bt_field_class_variant_with_selector_signed_borrow_option_by_index_const(
1621 const struct bt_field_class
*fc
, uint64_t index
)
1623 BT_ASSERT_PRE_DEV_NON_NULL(fc
, "Field class");
1624 BT_ASSERT_PRE_DEV_FC_HAS_ID(fc
,
1625 BT_FIELD_CLASS_TYPE_VARIANT_WITH_SIGNED_SELECTOR
,
1627 return (const void *)
1628 borrow_named_field_class_from_container_field_class_at_index(
1629 (void *) fc
, index
);
1632 const char *bt_field_class_variant_option_get_name(
1633 const struct bt_field_class_variant_option
*option
)
1635 const struct bt_named_field_class
*named_fc
= (const void *) option
;
1637 BT_ASSERT_PRE_DEV_NON_NULL(option
, "Variant field class option");
1638 return named_fc
->name
->str
;
1641 const struct bt_field_class
*
1642 bt_field_class_variant_option_borrow_field_class_const(
1643 const struct bt_field_class_variant_option
*option
)
1645 const struct bt_named_field_class
*named_fc
= (const void *) option
;
1647 BT_ASSERT_PRE_DEV_NON_NULL(option
, "Variant field class option");
1648 return named_fc
->fc
;
1651 const struct bt_integer_range_set_unsigned
*
1652 bt_field_class_variant_with_selector_unsigned_option_borrow_ranges_const(
1653 const struct bt_field_class_variant_with_selector_unsigned_option
*option
)
1655 const struct bt_field_class_variant_with_selector_option
*opt
=
1656 (const void *) option
;
1658 BT_ASSERT_PRE_DEV_NON_NULL(option
, "Variant field class option");
1659 return (const void *) opt
->range_set
;
1662 const struct bt_integer_range_set_signed
*
1663 bt_field_class_variant_with_selector_signed_option_borrow_ranges_const(
1664 const struct bt_field_class_variant_with_selector_signed_option
*option
)
1666 const struct bt_field_class_variant_with_selector_option
*opt
=
1667 (const void *) option
;
1669 BT_ASSERT_PRE_DEV_NON_NULL(option
, "Variant field class option");
1670 return (const void *) opt
->range_set
;
1673 const struct bt_field_path
*
1674 bt_field_class_variant_with_selector_borrow_selector_field_path_const(
1675 const struct bt_field_class
*fc
)
1677 const struct bt_field_class_variant_with_selector
*var_fc
=
1680 BT_ASSERT_PRE_DEV_NON_NULL(fc
, "Field class");
1681 BT_ASSERT_PRE_DEV_FC_IS_VARIANT_WITH_SEL(fc
, "Field class");
1682 return var_fc
->selector_field_path
;
1686 int init_array_field_class(struct bt_field_class_array
*fc
,
1687 enum bt_field_class_type type
, bt_object_release_func release_func
,
1688 struct bt_field_class
*element_fc
)
1692 BT_ASSERT(element_fc
);
1693 ret
= init_field_class((void *) fc
, type
, release_func
);
1698 fc
->element_fc
= element_fc
;
1699 bt_object_get_no_null_check(fc
->element_fc
);
1700 bt_field_class_freeze(element_fc
);
1707 void finalize_array_field_class(struct bt_field_class_array
*array_fc
)
1709 BT_ASSERT(array_fc
);
1710 BT_LOGD_STR("Putting element field class.");
1711 finalize_field_class((void *) array_fc
);
1712 BT_OBJECT_PUT_REF_AND_RESET(array_fc
->element_fc
);
1716 void destroy_static_array_field_class(struct bt_object
*obj
)
1719 BT_LIB_LOGD("Destroying static array field class object: %!+F", obj
);
1720 finalize_array_field_class((void *) obj
);
1724 struct bt_field_class
*
1725 bt_field_class_array_static_create(bt_trace_class
*trace_class
,
1726 struct bt_field_class
*element_fc
, uint64_t length
)
1728 struct bt_field_class_array_static
*array_fc
= NULL
;
1730 BT_ASSERT_PRE_NON_NULL(trace_class
, "Trace class");
1731 BT_ASSERT_PRE_NON_NULL(element_fc
, "Element field class");
1732 BT_LOGD_STR("Creating default static array field class object.");
1733 array_fc
= g_new0(struct bt_field_class_array_static
, 1);
1735 BT_LIB_LOGE_APPEND_CAUSE(
1736 "Failed to allocate one static array field class.");
1740 if (init_array_field_class((void *) array_fc
,
1741 BT_FIELD_CLASS_TYPE_STATIC_ARRAY
,
1742 destroy_static_array_field_class
, element_fc
)) {
1746 array_fc
->length
= length
;
1747 BT_LIB_LOGD("Created static array field class object: %!+F", array_fc
);
1751 BT_OBJECT_PUT_REF_AND_RESET(array_fc
);
1754 return (void *) array_fc
;
1757 const struct bt_field_class
*
1758 bt_field_class_array_borrow_element_field_class_const(
1759 const struct bt_field_class
*fc
)
1761 const struct bt_field_class_array
*array_fc
= (const void *) fc
;
1763 BT_ASSERT_PRE_DEV_NON_NULL(fc
, "Field class");
1764 BT_ASSERT_PRE_DEV_FC_IS_ARRAY(fc
, "Field class");
1765 return array_fc
->element_fc
;
1768 struct bt_field_class
*
1769 bt_field_class_array_borrow_element_field_class(struct bt_field_class
*fc
)
1771 struct bt_field_class_array
*array_fc
= (void *) fc
;
1773 BT_ASSERT_PRE_DEV_NON_NULL(fc
, "Field class");
1774 BT_ASSERT_PRE_DEV_FC_IS_ARRAY(fc
, "Field class");
1775 return array_fc
->element_fc
;
1778 uint64_t bt_field_class_array_static_get_length(const struct bt_field_class
*fc
)
1780 const struct bt_field_class_array_static
*array_fc
= (const void *) fc
;
1782 BT_ASSERT_PRE_DEV_NON_NULL(fc
, "Field class");
1783 BT_ASSERT_PRE_DEV_FC_HAS_ID(fc
, BT_FIELD_CLASS_TYPE_STATIC_ARRAY
,
1785 return (uint64_t) array_fc
->length
;
1789 void destroy_dynamic_array_field_class(struct bt_object
*obj
)
1791 struct bt_field_class_array_dynamic
*fc
= (void *) obj
;
1794 BT_LIB_LOGD("Destroying dynamic array field class object: %!+F", fc
);
1795 finalize_array_field_class((void *) fc
);
1796 BT_LOGD_STR("Putting length field path.");
1797 BT_OBJECT_PUT_REF_AND_RESET(fc
->length_field_path
);
1798 BT_LOGD_STR("Putting length field class.");
1799 BT_OBJECT_PUT_REF_AND_RESET(fc
->length_fc
);
1803 struct bt_field_class
*bt_field_class_array_dynamic_create(
1804 struct bt_trace_class
*trace_class
,
1805 struct bt_field_class
*element_fc
,
1806 struct bt_field_class
*length_fc
)
1808 struct bt_field_class_array_dynamic
*array_fc
= NULL
;
1810 BT_ASSERT_PRE_NON_NULL(trace_class
, "Trace class");
1811 BT_ASSERT_PRE_NON_NULL(element_fc
, "Element field class");
1812 BT_LOGD_STR("Creating default dynamic array field class object.");
1813 array_fc
= g_new0(struct bt_field_class_array_dynamic
, 1);
1815 BT_LIB_LOGE_APPEND_CAUSE(
1816 "Failed to allocate one dynamic array field class.");
1820 if (init_array_field_class((void *) array_fc
,
1821 BT_FIELD_CLASS_TYPE_DYNAMIC_ARRAY
,
1822 destroy_dynamic_array_field_class
, element_fc
)) {
1827 BT_ASSERT_PRE_FC_IS_UNSIGNED_INT(length_fc
,
1828 "Length field class");
1829 array_fc
->length_fc
= length_fc
;
1830 bt_object_get_no_null_check(array_fc
->length_fc
);
1831 bt_field_class_freeze(length_fc
);
1834 BT_LIB_LOGD("Created dynamic array field class object: %!+F", array_fc
);
1838 BT_OBJECT_PUT_REF_AND_RESET(array_fc
);
1841 return (void *) array_fc
;
1844 const struct bt_field_path
*
1845 bt_field_class_array_dynamic_borrow_length_field_path_const(
1846 const struct bt_field_class
*fc
)
1848 const struct bt_field_class_array_dynamic
*seq_fc
= (const void *) fc
;
1850 BT_ASSERT_PRE_DEV_NON_NULL(fc
, "Field class");
1851 BT_ASSERT_PRE_DEV_FC_HAS_ID(fc
, BT_FIELD_CLASS_TYPE_DYNAMIC_ARRAY
,
1853 return seq_fc
->length_field_path
;
1857 void destroy_string_field_class(struct bt_object
*obj
)
1860 BT_LIB_LOGD("Destroying string field class object: %!+F", obj
);
1861 finalize_field_class((void *) obj
);
1865 struct bt_field_class
*bt_field_class_string_create(bt_trace_class
*trace_class
)
1867 struct bt_field_class_string
*string_fc
= NULL
;
1869 BT_ASSERT_PRE_NON_NULL(trace_class
, "Trace class");
1870 BT_LOGD_STR("Creating default string field class object.");
1871 string_fc
= g_new0(struct bt_field_class_string
, 1);
1873 BT_LIB_LOGE_APPEND_CAUSE(
1874 "Failed to allocate one string field class.");
1878 if (init_field_class((void *) string_fc
, BT_FIELD_CLASS_TYPE_STRING
,
1879 destroy_string_field_class
)) {
1883 BT_LIB_LOGD("Created string field class object: %!+F", string_fc
);
1887 BT_OBJECT_PUT_REF_AND_RESET(string_fc
);
1890 return (void *) string_fc
;
1894 void _bt_field_class_freeze(const struct bt_field_class
*c_fc
)
1896 struct bt_field_class
*fc
= (void *) c_fc
;
1899 * Element/member/option field classes are frozen when added to
1903 bt_value_freeze(fc
->user_attributes
);
1907 case BT_FIELD_CLASS_TYPE_STRUCTURE
:
1908 case BT_FIELD_CLASS_TYPE_VARIANT_WITHOUT_SELECTOR
:
1909 case BT_FIELD_CLASS_TYPE_VARIANT_WITH_UNSIGNED_SELECTOR
:
1910 case BT_FIELD_CLASS_TYPE_VARIANT_WITH_SIGNED_SELECTOR
:
1912 struct bt_field_class_named_field_class_container
*container_fc
=
1916 for (i
= 0; i
< container_fc
->named_fcs
->len
; i
++) {
1917 bt_named_field_class_freeze(
1918 container_fc
->named_fcs
->pdata
[i
]);
1929 void _bt_named_field_class_freeze(const struct bt_named_field_class
*named_fc
)
1931 BT_ASSERT(named_fc
);
1932 BT_ASSERT(named_fc
->fc
->frozen
);
1933 BT_LIB_LOGD("Freezing named field class's user attributes: %!+v",
1934 named_fc
->user_attributes
);
1935 bt_value_freeze(named_fc
->user_attributes
);
1936 ((struct bt_named_field_class
*) named_fc
)->frozen
= true;
1940 void bt_field_class_make_part_of_trace_class(const struct bt_field_class
*c_fc
)
1942 struct bt_field_class
*fc
= (void *) c_fc
;
1945 BT_ASSERT_PRE(!fc
->part_of_trace_class
,
1946 "Field class is already part of a trace: %!+F", fc
);
1947 fc
->part_of_trace_class
= true;
1950 case BT_FIELD_CLASS_TYPE_STRUCTURE
:
1951 case BT_FIELD_CLASS_TYPE_VARIANT_WITHOUT_SELECTOR
:
1952 case BT_FIELD_CLASS_TYPE_VARIANT_WITH_UNSIGNED_SELECTOR
:
1953 case BT_FIELD_CLASS_TYPE_VARIANT_WITH_SIGNED_SELECTOR
:
1955 struct bt_field_class_named_field_class_container
*container_fc
=
1959 for (i
= 0; i
< container_fc
->named_fcs
->len
; i
++) {
1960 struct bt_named_field_class
*named_fc
=
1961 container_fc
->named_fcs
->pdata
[i
];
1963 bt_field_class_make_part_of_trace_class(named_fc
->fc
);
1968 case BT_FIELD_CLASS_TYPE_STATIC_ARRAY
:
1969 case BT_FIELD_CLASS_TYPE_DYNAMIC_ARRAY
:
1971 struct bt_field_class_array
*array_fc
= (void *) fc
;
1973 bt_field_class_make_part_of_trace_class(array_fc
->element_fc
);
1981 const struct bt_value
*bt_field_class_borrow_user_attributes_const(
1982 const struct bt_field_class
*fc
)
1984 BT_ASSERT_PRE_DEV_NON_NULL(fc
, "Field class");
1985 return fc
->user_attributes
;
1988 struct bt_value
*bt_field_class_borrow_user_attributes(
1989 struct bt_field_class
*field_class
)
1991 return (void *) bt_field_class_borrow_user_attributes_const(
1992 (void *) field_class
);
1996 void bt_field_class_set_user_attributes(
1997 struct bt_field_class
*fc
,
1998 const struct bt_value
*user_attributes
)
2000 BT_ASSERT_PRE_NON_NULL(fc
, "Field class");
2001 BT_ASSERT_PRE_NON_NULL(user_attributes
, "User attributes");
2002 BT_ASSERT_PRE(user_attributes
->type
== BT_VALUE_TYPE_MAP
,
2003 "User attributes object is not a map value object.");
2004 BT_ASSERT_PRE_DEV_FC_HOT(fc
, "Field class");
2005 bt_object_put_no_null_check(fc
->user_attributes
);
2006 fc
->user_attributes
= (void *) user_attributes
;
2007 bt_object_get_no_null_check(fc
->user_attributes
);
2011 const struct bt_value
*bt_named_field_class_borrow_user_attributes_const(
2012 const struct bt_named_field_class
*named_fc
)
2014 return named_fc
->user_attributes
;
2018 void bt_named_field_class_set_user_attributes(
2019 struct bt_named_field_class
*named_fc
,
2020 const struct bt_value
*user_attributes
)
2022 BT_ASSERT_PRE_NON_NULL(user_attributes
, "User attributes");
2023 BT_ASSERT_PRE(user_attributes
->type
== BT_VALUE_TYPE_MAP
,
2024 "User attributes object is not a map value object.");
2025 BT_ASSERT_PRE_DEV_HOT(named_fc
,
2026 "Structure field class member or variant field class option",
2028 bt_object_put_no_null_check(named_fc
->user_attributes
);
2029 named_fc
->user_attributes
= (void *) user_attributes
;
2030 bt_object_get_no_null_check(named_fc
->user_attributes
);
2033 const struct bt_value
*
2034 bt_field_class_structure_member_borrow_user_attributes_const(
2035 const struct bt_field_class_structure_member
*member
)
2037 BT_ASSERT_PRE_NON_NULL(member
, "Structure field class member");
2038 return bt_named_field_class_borrow_user_attributes_const(
2039 (const void *) member
);
2043 bt_field_class_structure_member_borrow_user_attributes(
2044 struct bt_field_class_structure_member
*member
)
2046 BT_ASSERT_PRE_NON_NULL(member
, "Structure field class member");
2047 return (void *) bt_named_field_class_borrow_user_attributes_const(
2051 void bt_field_class_structure_member_set_user_attributes(
2052 struct bt_field_class_structure_member
*member
,
2053 const struct bt_value
*user_attributes
)
2055 BT_ASSERT_PRE_NON_NULL(member
, "Structure field class member");
2056 bt_named_field_class_set_user_attributes((void *) member
,
2060 const struct bt_value
*bt_field_class_variant_option_borrow_user_attributes_const(
2061 const struct bt_field_class_variant_option
*option
)
2063 BT_ASSERT_PRE_NON_NULL(option
, "Variant field class option");
2064 return bt_named_field_class_borrow_user_attributes_const(
2065 (const void *) option
);
2068 struct bt_value
*bt_field_class_variant_option_borrow_user_attributes(
2069 struct bt_field_class_variant_option
*option
)
2071 BT_ASSERT_PRE_NON_NULL(option
, "Variant field class option");
2072 return (void *) bt_named_field_class_borrow_user_attributes_const(
2076 void bt_field_class_variant_option_set_user_attributes(
2077 struct bt_field_class_variant_option
*option
,
2078 const struct bt_value
*user_attributes
)
2080 BT_ASSERT_PRE_NON_NULL(option
, "Variant field class option");
2081 bt_named_field_class_set_user_attributes((void *) option
,
2085 void bt_field_class_get_ref(const struct bt_field_class
*field_class
)
2087 bt_object_get_ref(field_class
);
2090 void bt_field_class_put_ref(const struct bt_field_class
*field_class
)
2092 bt_object_put_ref(field_class
);