4 * Babeltrace CTF IR - Event Types
6 * Copyright 2013, 2014 Jérémie Galarneau <jeremie.galarneau@efficios.com>
8 * Author: Jérémie Galarneau <jeremie.galarneau@efficios.com>
10 * Permission is hereby granted, free of charge, to any person obtaining a copy
11 * of this software and associated documentation files (the "Software"), to deal
12 * in the Software without restriction, including without limitation the rights
13 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
14 * copies of the Software, and to permit persons to whom the Software is
15 * furnished to do so, subject to the following conditions:
17 * The above copyright notice and this permission notice shall be included in
18 * all copies or substantial portions of the Software.
20 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
21 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
22 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
23 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
24 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
25 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
29 #define BT_LOG_TAG "FIELD-TYPES"
30 #include <babeltrace/lib-logging-internal.h>
32 #include <babeltrace/ctf-ir/field-types-internal.h>
33 #include <babeltrace/ctf-ir/field-path-internal.h>
34 #include <babeltrace/ctf-ir/utils.h>
35 #include <babeltrace/ref.h>
36 #include <babeltrace/ctf-ir/clock-class.h>
37 #include <babeltrace/ctf-ir/clock-class-internal.h>
38 #include <babeltrace/ctf-writer/writer-internal.h>
39 #include <babeltrace/object-internal.h>
40 #include <babeltrace/ref.h>
41 #include <babeltrace/compiler-internal.h>
42 #include <babeltrace/endian-internal.h>
47 struct range_overlap_query
{
62 void bt_field_type_destroy(struct bt_object
*);
64 void bt_field_type_integer_destroy(struct bt_field_type
*);
66 void bt_field_type_enumeration_destroy(struct bt_field_type
*);
68 void bt_field_type_floating_point_destroy(struct bt_field_type
*);
70 void bt_field_type_structure_destroy(struct bt_field_type
*);
72 void bt_field_type_variant_destroy(struct bt_field_type
*);
74 void bt_field_type_array_destroy(struct bt_field_type
*);
76 void bt_field_type_sequence_destroy(struct bt_field_type
*);
78 void bt_field_type_string_destroy(struct bt_field_type
*);
81 void (* const type_destroy_funcs
[])(struct bt_field_type
*) = {
82 [BT_FIELD_TYPE_ID_INTEGER
] = bt_field_type_integer_destroy
,
83 [BT_FIELD_TYPE_ID_ENUM
] =
84 bt_field_type_enumeration_destroy
,
85 [BT_FIELD_TYPE_ID_FLOAT
] =
86 bt_field_type_floating_point_destroy
,
87 [BT_FIELD_TYPE_ID_STRUCT
] = bt_field_type_structure_destroy
,
88 [BT_FIELD_TYPE_ID_VARIANT
] = bt_field_type_variant_destroy
,
89 [BT_FIELD_TYPE_ID_ARRAY
] = bt_field_type_array_destroy
,
90 [BT_FIELD_TYPE_ID_SEQUENCE
] = bt_field_type_sequence_destroy
,
91 [BT_FIELD_TYPE_ID_STRING
] = bt_field_type_string_destroy
,
95 void generic_field_type_freeze(struct bt_field_type
*);
97 void bt_field_type_integer_freeze(struct bt_field_type
*);
99 void bt_field_type_enumeration_freeze(struct bt_field_type
*);
101 void bt_field_type_structure_freeze(struct bt_field_type
*);
103 void bt_field_type_variant_freeze(struct bt_field_type
*);
105 void bt_field_type_array_freeze(struct bt_field_type
*);
107 void bt_field_type_sequence_freeze(struct bt_field_type
*);
110 type_freeze_func
const type_freeze_funcs
[] = {
111 [BT_FIELD_TYPE_ID_INTEGER
] = bt_field_type_integer_freeze
,
112 [BT_FIELD_TYPE_ID_ENUM
] = bt_field_type_enumeration_freeze
,
113 [BT_FIELD_TYPE_ID_FLOAT
] = generic_field_type_freeze
,
114 [BT_FIELD_TYPE_ID_STRUCT
] = bt_field_type_structure_freeze
,
115 [BT_FIELD_TYPE_ID_VARIANT
] = bt_field_type_variant_freeze
,
116 [BT_FIELD_TYPE_ID_ARRAY
] = bt_field_type_array_freeze
,
117 [BT_FIELD_TYPE_ID_SEQUENCE
] = bt_field_type_sequence_freeze
,
118 [BT_FIELD_TYPE_ID_STRING
] = generic_field_type_freeze
,
122 int bt_field_type_integer_serialize(struct bt_field_type
*,
123 struct metadata_context
*);
125 int bt_field_type_enumeration_serialize(struct bt_field_type
*,
126 struct metadata_context
*);
128 int bt_field_type_floating_point_serialize(
129 struct bt_field_type
*, struct metadata_context
*);
131 int bt_field_type_structure_serialize(struct bt_field_type
*,
132 struct metadata_context
*);
134 int bt_field_type_variant_serialize(struct bt_field_type
*,
135 struct metadata_context
*);
137 int bt_field_type_array_serialize(struct bt_field_type
*,
138 struct metadata_context
*);
140 int bt_field_type_sequence_serialize(struct bt_field_type
*,
141 struct metadata_context
*);
143 int bt_field_type_string_serialize(struct bt_field_type
*,
144 struct metadata_context
*);
147 type_serialize_func
const type_serialize_funcs
[] = {
148 [BT_FIELD_TYPE_ID_INTEGER
] = bt_field_type_integer_serialize
,
149 [BT_FIELD_TYPE_ID_ENUM
] =
150 bt_field_type_enumeration_serialize
,
151 [BT_FIELD_TYPE_ID_FLOAT
] =
152 bt_field_type_floating_point_serialize
,
153 [BT_FIELD_TYPE_ID_STRUCT
] =
154 bt_field_type_structure_serialize
,
155 [BT_FIELD_TYPE_ID_VARIANT
] = bt_field_type_variant_serialize
,
156 [BT_FIELD_TYPE_ID_ARRAY
] = bt_field_type_array_serialize
,
157 [BT_FIELD_TYPE_ID_SEQUENCE
] = bt_field_type_sequence_serialize
,
158 [BT_FIELD_TYPE_ID_STRING
] = bt_field_type_string_serialize
,
162 void bt_field_type_integer_set_byte_order(struct bt_field_type
*,
163 enum bt_byte_order byte_order
);
165 void bt_field_type_enumeration_set_byte_order(struct bt_field_type
*,
166 enum bt_byte_order byte_order
);
168 void bt_field_type_floating_point_set_byte_order(
169 struct bt_field_type
*, enum bt_byte_order byte_order
);
171 void bt_field_type_structure_set_byte_order(struct bt_field_type
*,
172 enum bt_byte_order byte_order
);
174 void bt_field_type_variant_set_byte_order(struct bt_field_type
*,
175 enum bt_byte_order byte_order
);
177 void bt_field_type_array_set_byte_order(struct bt_field_type
*,
178 enum bt_byte_order byte_order
);
180 void bt_field_type_sequence_set_byte_order(struct bt_field_type
*,
181 enum bt_byte_order byte_order
);
184 void (* const set_byte_order_funcs
[])(struct bt_field_type
*,
185 enum bt_byte_order
) = {
186 [BT_FIELD_TYPE_ID_INTEGER
] = bt_field_type_integer_set_byte_order
,
187 [BT_FIELD_TYPE_ID_ENUM
] =
188 bt_field_type_enumeration_set_byte_order
,
189 [BT_FIELD_TYPE_ID_FLOAT
] =
190 bt_field_type_floating_point_set_byte_order
,
191 [BT_FIELD_TYPE_ID_STRUCT
] =
192 bt_field_type_structure_set_byte_order
,
193 [BT_FIELD_TYPE_ID_VARIANT
] = bt_field_type_variant_set_byte_order
,
194 [BT_FIELD_TYPE_ID_ARRAY
] = bt_field_type_array_set_byte_order
,
195 [BT_FIELD_TYPE_ID_SEQUENCE
] = bt_field_type_sequence_set_byte_order
,
196 [BT_FIELD_TYPE_ID_STRING
] = NULL
,
200 struct bt_field_type
*bt_field_type_integer_copy(
201 struct bt_field_type
*);
203 struct bt_field_type
*bt_field_type_enumeration_copy(
204 struct bt_field_type
*);
206 struct bt_field_type
*bt_field_type_floating_point_copy(
207 struct bt_field_type
*);
209 struct bt_field_type
*bt_field_type_structure_copy(
210 struct bt_field_type
*);
212 struct bt_field_type
*bt_field_type_variant_copy(
213 struct bt_field_type
*);
215 struct bt_field_type
*bt_field_type_array_copy(
216 struct bt_field_type
*);
218 struct bt_field_type
*bt_field_type_sequence_copy(
219 struct bt_field_type
*);
221 struct bt_field_type
*bt_field_type_string_copy(
222 struct bt_field_type
*);
225 struct bt_field_type
*(* const type_copy_funcs
[])(
226 struct bt_field_type
*) = {
227 [BT_FIELD_TYPE_ID_INTEGER
] = bt_field_type_integer_copy
,
228 [BT_FIELD_TYPE_ID_ENUM
] = bt_field_type_enumeration_copy
,
229 [BT_FIELD_TYPE_ID_FLOAT
] = bt_field_type_floating_point_copy
,
230 [BT_FIELD_TYPE_ID_STRUCT
] = bt_field_type_structure_copy
,
231 [BT_FIELD_TYPE_ID_VARIANT
] = bt_field_type_variant_copy
,
232 [BT_FIELD_TYPE_ID_ARRAY
] = bt_field_type_array_copy
,
233 [BT_FIELD_TYPE_ID_SEQUENCE
] = bt_field_type_sequence_copy
,
234 [BT_FIELD_TYPE_ID_STRING
] = bt_field_type_string_copy
,
238 int bt_field_type_integer_compare(struct bt_field_type
*,
239 struct bt_field_type
*);
241 int bt_field_type_floating_point_compare(struct bt_field_type
*,
242 struct bt_field_type
*);
244 int bt_field_type_enumeration_compare(struct bt_field_type
*,
245 struct bt_field_type
*);
247 int bt_field_type_string_compare(struct bt_field_type
*,
248 struct bt_field_type
*);
250 int bt_field_type_structure_compare(struct bt_field_type
*,
251 struct bt_field_type
*);
253 int bt_field_type_variant_compare(struct bt_field_type
*,
254 struct bt_field_type
*);
256 int bt_field_type_array_compare(struct bt_field_type
*,
257 struct bt_field_type
*);
259 int bt_field_type_sequence_compare(struct bt_field_type
*,
260 struct bt_field_type
*);
263 int (* const type_compare_funcs
[])(struct bt_field_type
*,
264 struct bt_field_type
*) = {
265 [BT_FIELD_TYPE_ID_INTEGER
] = bt_field_type_integer_compare
,
266 [BT_FIELD_TYPE_ID_ENUM
] = bt_field_type_enumeration_compare
,
267 [BT_FIELD_TYPE_ID_FLOAT
] = bt_field_type_floating_point_compare
,
268 [BT_FIELD_TYPE_ID_STRUCT
] = bt_field_type_structure_compare
,
269 [BT_FIELD_TYPE_ID_VARIANT
] = bt_field_type_variant_compare
,
270 [BT_FIELD_TYPE_ID_ARRAY
] = bt_field_type_array_compare
,
271 [BT_FIELD_TYPE_ID_SEQUENCE
] = bt_field_type_sequence_compare
,
272 [BT_FIELD_TYPE_ID_STRING
] = bt_field_type_string_compare
,
276 int bt_field_type_integer_validate(struct bt_field_type
*);
278 int bt_field_type_enumeration_validate(struct bt_field_type
*);
280 int bt_field_type_structure_validate(struct bt_field_type
*);
282 int bt_field_type_variant_validate(struct bt_field_type
*);
284 int bt_field_type_array_validate(struct bt_field_type
*);
286 int bt_field_type_sequence_validate(struct bt_field_type
*);
289 int (* const type_validate_funcs
[])(struct bt_field_type
*) = {
290 [BT_FIELD_TYPE_ID_INTEGER
] = bt_field_type_integer_validate
,
291 [BT_FIELD_TYPE_ID_FLOAT
] = NULL
,
292 [BT_FIELD_TYPE_ID_STRING
] = NULL
,
293 [BT_FIELD_TYPE_ID_ENUM
] = bt_field_type_enumeration_validate
,
294 [BT_FIELD_TYPE_ID_STRUCT
] = bt_field_type_structure_validate
,
295 [BT_FIELD_TYPE_ID_VARIANT
] = bt_field_type_variant_validate
,
296 [BT_FIELD_TYPE_ID_ARRAY
] = bt_field_type_array_validate
,
297 [BT_FIELD_TYPE_ID_SEQUENCE
] = bt_field_type_sequence_validate
,
301 void destroy_enumeration_mapping(struct enumeration_mapping
*mapping
)
307 void destroy_structure_field(struct structure_field
*field
)
313 BT_LOGD("Destroying structure/variant field type's field object: "
314 "addr=%p, field-ft-addr=%p, field-name=\"%s\"",
315 field
, field
->type
, g_quark_to_string(field
->name
));
316 BT_LOGD_STR("Putting field type.");
322 void check_ranges_overlap(gpointer element
, gpointer query
)
324 struct enumeration_mapping
*mapping
= element
;
325 struct range_overlap_query
*overlap_query
= query
;
327 if (mapping
->range_start
._signed
<= overlap_query
->range_end
._signed
328 && overlap_query
->range_start
._signed
<=
329 mapping
->range_end
._signed
) {
330 overlap_query
->overlaps
= 1;
331 overlap_query
->mapping_name
= mapping
->string
;
334 overlap_query
->overlaps
|=
335 mapping
->string
== overlap_query
->mapping_name
;
337 if (overlap_query
->overlaps
) {
338 BT_LOGV("Overlapping enumeration field type mappings: "
339 "mapping-name=\"%s\", "
340 "mapping-a-range-start=%" PRId64
", "
341 "mapping-a-range-end=%" PRId64
", "
342 "mapping-b-range-start=%" PRId64
", "
343 "mapping-b-range-end=%" PRId64
,
344 g_quark_to_string(mapping
->string
),
345 mapping
->range_start
._signed
,
346 mapping
->range_end
._signed
,
347 overlap_query
->range_start
._signed
,
348 overlap_query
->range_end
._signed
);
353 void check_ranges_overlap_unsigned(gpointer element
, gpointer query
)
355 struct enumeration_mapping
*mapping
= element
;
356 struct range_overlap_query
*overlap_query
= query
;
358 if (mapping
->range_start
._unsigned
<= overlap_query
->range_end
._unsigned
359 && overlap_query
->range_start
._unsigned
<=
360 mapping
->range_end
._unsigned
) {
361 overlap_query
->overlaps
= 1;
362 overlap_query
->mapping_name
= mapping
->string
;
365 overlap_query
->overlaps
|=
366 mapping
->string
== overlap_query
->mapping_name
;
368 if (overlap_query
->overlaps
) {
369 BT_LOGW("Overlapping enumeration field type mappings: "
370 "mapping-name=\"%s\", "
371 "mapping-a-range-start=%" PRIu64
", "
372 "mapping-a-range-end=%" PRIu64
", "
373 "mapping-b-range-start=%" PRIu64
", "
374 "mapping-b-range-end=%" PRIu64
,
375 g_quark_to_string(mapping
->string
),
376 mapping
->range_start
._unsigned
,
377 mapping
->range_end
._unsigned
,
378 overlap_query
->range_start
._unsigned
,
379 overlap_query
->range_end
._unsigned
);
384 gint
compare_enumeration_mappings_signed(struct enumeration_mapping
**a
,
385 struct enumeration_mapping
**b
)
387 return ((*a
)->range_start
._signed
< (*b
)->range_start
._signed
) ? -1 : 1;
391 gint
compare_enumeration_mappings_unsigned(struct enumeration_mapping
**a
,
392 struct enumeration_mapping
**b
)
394 return ((*a
)->range_start
._unsigned
< (*b
)->range_start
._unsigned
) ? -1 : 1;
398 void bt_field_type_init(struct bt_field_type
*type
, bt_bool init_bo
)
400 assert(type
&& (type
->id
> BT_FIELD_TYPE_ID_UNKNOWN
) &&
401 (type
->id
< BT_FIELD_TYPE_ID_NR
));
403 bt_object_init(type
, bt_field_type_destroy
);
404 type
->freeze
= type_freeze_funcs
[type
->id
];
405 type
->serialize
= type_serialize_funcs
[type
->id
];
409 const enum bt_byte_order bo
= BT_BYTE_ORDER_NATIVE
;
411 BT_LOGD("Setting initial field type's byte order: bo=%s",
412 bt_byte_order_string(bo
));
413 ret
= bt_field_type_set_byte_order(type
, bo
);
421 int add_structure_field(GPtrArray
*fields
,
422 GHashTable
*field_name_to_index
,
423 struct bt_field_type
*field_type
,
424 const char *field_name
)
427 GQuark name_quark
= g_quark_from_string(field_name
);
428 struct structure_field
*field
;
430 /* Make sure structure does not contain a field of the same name */
431 if (g_hash_table_lookup_extended(field_name_to_index
,
432 GUINT_TO_POINTER(name_quark
), NULL
, NULL
)) {
433 BT_LOGW("Structure or variant field type already contains a field type with this name: "
434 "field-name=\"%s\"", field_name
);
439 field
= g_new0(struct structure_field
, 1);
441 BT_LOGE_STR("Failed to allocate one structure/variant field type field.");
447 field
->name
= name_quark
;
448 field
->type
= field_type
;
449 g_hash_table_insert(field_name_to_index
,
450 GUINT_TO_POINTER(name_quark
),
451 GUINT_TO_POINTER(fields
->len
));
452 g_ptr_array_add(fields
, field
);
453 BT_LOGV("Added structure/variant field type field: field-ft-addr=%p, "
454 "field-name=\"%s\"", field_type
, field_name
);
460 void bt_field_type_destroy(struct bt_object
*obj
)
462 struct bt_field_type
*type
;
463 enum bt_field_type_id type_id
;
465 type
= container_of(obj
, struct bt_field_type
, base
);
467 assert(type_id
> BT_FIELD_TYPE_ID_UNKNOWN
&&
468 type_id
< BT_FIELD_TYPE_ID_NR
);
469 type_destroy_funcs
[type_id
](type
);
473 int bt_field_type_integer_validate(struct bt_field_type
*type
)
477 struct bt_field_type_integer
*integer
=
478 container_of(type
, struct bt_field_type_integer
,
481 if (integer
->mapped_clock
&& integer
->is_signed
) {
482 BT_LOGW("Invalid integer field type: cannot be signed and have a mapped clock class: "
483 "ft-addr=%p, clock-class-addr=%p, clock-class-name=\"%s\"",
484 type
, integer
->mapped_clock
,
485 bt_clock_class_get_name(integer
->mapped_clock
));
495 struct enumeration_mapping
*get_enumeration_mapping(
496 struct bt_field_type
*type
, uint64_t index
)
498 struct enumeration_mapping
*mapping
= NULL
;
499 struct bt_field_type_enumeration
*enumeration
;
501 enumeration
= container_of(type
, struct bt_field_type_enumeration
,
503 if (index
>= enumeration
->entries
->len
) {
504 BT_LOGW("Invalid parameter: index is out of bounds: "
505 "addr=%p, index=%" PRIu64
", count=%u",
506 type
, index
, enumeration
->entries
->len
);
510 mapping
= g_ptr_array_index(enumeration
->entries
, index
);
516 * Note: This algorithm is O(n^2) vs number of enumeration mappings.
517 * Only used when freezing an enumeration.
520 void set_enumeration_range_overlap(
521 struct bt_field_type
*type
)
524 struct bt_field_type
*container_type
;
525 struct bt_field_type_enumeration
*enumeration_type
;
528 BT_LOGV("Setting enumeration field type's overlap flag: addr=%p",
530 enumeration_type
= container_of(type
,
531 struct bt_field_type_enumeration
, parent
);
533 len
= enumeration_type
->entries
->len
;
534 container_type
= enumeration_type
->container
;
535 is_signed
= bt_field_type_integer_is_signed(container_type
);
537 for (i
= 0; i
< len
; i
++) {
538 for (j
= i
+ 1; j
< len
; j
++) {
539 struct enumeration_mapping
*mapping
[2];
541 mapping
[0] = get_enumeration_mapping(type
, i
);
542 mapping
[1] = get_enumeration_mapping(type
, j
);
544 if (mapping
[0]->range_start
._signed
545 <= mapping
[1]->range_end
._signed
546 && mapping
[0]->range_end
._signed
547 >= mapping
[1]->range_start
._signed
) {
548 enumeration_type
->has_overlapping_ranges
= BT_TRUE
;
552 if (mapping
[0]->range_start
._unsigned
553 <= mapping
[1]->range_end
._unsigned
554 && mapping
[0]->range_end
._unsigned
555 >= mapping
[1]->range_start
._unsigned
) {
556 enumeration_type
->has_overlapping_ranges
= BT_TRUE
;
564 if (enumeration_type
->has_overlapping_ranges
) {
565 BT_LOGV_STR("Enumeration field type has overlapping ranges.");
567 BT_LOGV_STR("Enumeration field type has no overlapping ranges.");
572 int bt_field_type_enumeration_validate(struct bt_field_type
*type
)
576 struct bt_field_type_enumeration
*enumeration
=
577 container_of(type
, struct bt_field_type_enumeration
,
579 struct bt_field_type
*container_type
=
580 bt_field_type_enumeration_get_container_type(type
);
582 assert(container_type
);
583 ret
= bt_field_type_validate(container_type
);
585 BT_LOGW("Invalid enumeration field type: container type is invalid: "
586 "enum-ft-addr=%p, int-ft-addr=%p",
587 type
, container_type
);
591 /* Ensure enum has entries */
592 if (enumeration
->entries
->len
== 0) {
593 BT_LOGW("Invalid enumeration field type: no entries: "
600 BT_PUT(container_type
);
605 int bt_field_type_sequence_validate(struct bt_field_type
*type
)
608 struct bt_field_type
*element_type
= NULL
;
609 struct bt_field_type_sequence
*sequence
=
610 container_of(type
, struct bt_field_type_sequence
,
613 /* Length field name should be set at this point */
614 if (sequence
->length_field_name
->len
== 0) {
615 BT_LOGW("Invalid sequence field type: no length field name: "
621 element_type
= bt_field_type_sequence_get_element_type(type
);
622 assert(element_type
);
623 ret
= bt_field_type_validate(element_type
);
625 BT_LOGW("Invalid sequence field type: invalid element field type: "
626 "seq-ft-addr=%p, element-ft-add=%p",
631 BT_PUT(element_type
);
637 int bt_field_type_array_validate(struct bt_field_type
*type
)
640 struct bt_field_type
*element_type
= NULL
;
642 element_type
= bt_field_type_array_get_element_type(type
);
643 assert(element_type
);
644 ret
= bt_field_type_validate(element_type
);
646 BT_LOGW("Invalid array field type: invalid element field type: "
647 "array-ft-addr=%p, element-ft-add=%p",
651 BT_PUT(element_type
);
656 int bt_field_type_structure_validate(struct bt_field_type
*type
)
659 struct bt_field_type
*child_type
= NULL
;
660 int64_t field_count
= bt_field_type_structure_get_field_count(type
);
663 assert(field_count
>= 0);
665 for (i
= 0; i
< field_count
; ++i
) {
666 const char *field_name
;
668 ret
= bt_field_type_structure_get_field_by_index(type
,
669 &field_name
, &child_type
, i
);
671 ret
= bt_field_type_validate(child_type
);
673 BT_LOGW("Invalid structure field type: "
674 "a contained field type is invalid: "
675 "struct-ft-addr=%p, field-ft-addr=%p, "
676 "field-name=\"%s\", field-index=%" PRId64
,
677 type
, child_type
, field_name
, i
);
691 bt_bool
bt_field_type_enumeration_has_overlapping_ranges(
692 struct bt_field_type_enumeration
*enumeration_type
)
694 if (!enumeration_type
->parent
.frozen
) {
695 set_enumeration_range_overlap(&enumeration_type
->parent
);
697 return enumeration_type
->has_overlapping_ranges
;
701 int bt_field_type_variant_validate(struct bt_field_type
*type
)
705 struct bt_field_type
*child_type
= NULL
;
706 struct bt_field_type_variant
*variant
=
707 container_of(type
, struct bt_field_type_variant
,
711 if (variant
->tag_name
->len
== 0) {
712 BT_LOGW("Invalid variant field type: no tag field name: "
719 BT_LOGW("Invalid variant field type: no tag field type: "
720 "addr=%p, tag-field-name=\"%s\"", type
,
721 variant
->tag_name
->str
);
726 if (bt_field_type_enumeration_has_overlapping_ranges(
728 BT_LOGW("Invalid variant field type: enumeration tag field type has overlapping ranges: "
729 "variant-ft-addr=%p, tag-field-name=\"%s\", "
730 "enum-ft-addr=%p", type
, variant
->tag_name
->str
,
737 * It is valid to have a variant field type which does not have
738 * the fields corresponding to each label in the associated
741 * It is also valid to have variant field type fields which
742 * cannot be selected because the variant field type tag has no
743 * mapping named as such. This scenario, while not ideal, cannot
746 * If a non-existing field happens to be selected by an
747 * enumeration while reading a variant field, an error will be
748 * generated at that point (while reading the stream).
750 field_count
= bt_field_type_variant_get_field_count(type
);
751 if (field_count
< 0) {
752 BT_LOGW("Invalid variant field type: no fields: "
753 "addr=%p, tag-field-name=\"%s\"",
754 type
, variant
->tag_name
->str
);
759 for (i
= 0; i
< field_count
; ++i
) {
760 const char *field_name
;
762 ret
= bt_field_type_variant_get_field_by_index(type
,
763 &field_name
, &child_type
, i
);
765 ret
= bt_field_type_validate(child_type
);
767 BT_LOGW("Invalid variant field type: "
768 "a contained field type is invalid: "
769 "variant-ft-addr=%p, tag-field-name=\"%s\", "
770 "field-ft-addr=%p, field-name=\"%s\", "
771 "field-index=%" PRId64
,
772 type
, variant
->tag_name
->str
, child_type
,
787 * This function validates a given field type without considering
788 * where this field type is located. It only validates the properties
789 * of the given field type and the properties of its children if
793 int bt_field_type_validate(struct bt_field_type
*type
)
796 enum bt_field_type_id id
= bt_field_type_get_type_id(type
);
801 /* Already marked as valid */
805 if (type_validate_funcs
[id
]) {
806 ret
= type_validate_funcs
[id
](type
);
809 if (!ret
&& type
->frozen
) {
810 /* Field type is valid */
811 BT_LOGV("Marking field type as valid: addr=%p", type
);
819 struct bt_field_type
*bt_field_type_integer_create(unsigned int size
)
821 struct bt_field_type_integer
*integer
=
822 g_new0(struct bt_field_type_integer
, 1);
824 BT_LOGD("Creating integer field type object: size=%u", size
);
827 BT_LOGE_STR("Failed to allocate one integer field type.");
831 if (size
== 0 || size
> 64) {
832 BT_LOGW("Invalid parameter: size must be between 1 and 64: "
837 integer
->parent
.id
= BT_FIELD_TYPE_ID_INTEGER
;
838 integer
->size
= size
;
839 integer
->base
= BT_INTEGER_BASE_DECIMAL
;
840 integer
->encoding
= BT_STRING_ENCODING_NONE
;
841 bt_field_type_init(&integer
->parent
, TRUE
);
842 BT_LOGD("Created integer field type object: addr=%p, size=%u",
843 &integer
->parent
, size
);
844 return &integer
->parent
;
847 int bt_field_type_integer_get_size(struct bt_field_type
*type
)
850 struct bt_field_type_integer
*integer
;
853 BT_LOGW_STR("Invalid parameter: field type is NULL.");
858 if (type
->id
!= BT_FIELD_TYPE_ID_INTEGER
) {
859 BT_LOGW("Invalid parameter: field type is not an integer field type: "
860 "addr=%p, ft-id=%s", type
,
861 bt_field_type_id_string(type
->id
));
866 integer
= container_of(type
, struct bt_field_type_integer
, parent
);
867 ret
= (int) integer
->size
;
872 int bt_ctf_field_type_integer_get_signed(struct bt_field_type
*type
)
875 struct bt_field_type_integer
*integer
;
878 BT_LOGW_STR("Invalid parameter: field type is NULL.");
883 if (type
->id
!= BT_FIELD_TYPE_ID_INTEGER
) {
884 BT_LOGW("Invalid parameter: field type is not an integer field type: "
885 "addr=%p, ft-id=%s", type
,
886 bt_field_type_id_string(type
->id
));
891 integer
= container_of(type
, struct bt_field_type_integer
, parent
);
892 ret
= integer
->is_signed
;
897 bt_bool
bt_field_type_integer_is_signed(
898 struct bt_field_type
*int_field_type
)
900 return bt_ctf_field_type_integer_get_signed(int_field_type
) ?
904 int bt_field_type_integer_set_is_signed(struct bt_field_type
*type
,
908 struct bt_field_type_integer
*integer
;
911 BT_LOGW_STR("Invalid parameter: field type is NULL.");
917 BT_LOGW("Invalid parameter: field type is frozen: addr=%p",
923 if (type
->id
!= BT_FIELD_TYPE_ID_INTEGER
) {
924 BT_LOGW("Invalid parameter: field type is not an integer field type: "
925 "addr=%p, ft-id=%s", type
,
926 bt_field_type_id_string(type
->id
));
931 integer
= container_of(type
, struct bt_field_type_integer
, parent
);
932 integer
->is_signed
= !!is_signed
;
933 BT_LOGV("Set integer field type's signedness: addr=%p, is-signed=%d",
939 int bt_field_type_integer_set_size(struct bt_field_type
*type
,
943 struct bt_field_type_integer
*integer
;
946 BT_LOGW_STR("Invalid parameter: field type is NULL.");
952 BT_LOGW("Invalid parameter: field type is frozen: addr=%p",
958 if (type
->id
!= BT_FIELD_TYPE_ID_INTEGER
) {
959 BT_LOGW("Invalid parameter: field type is not an integer field type: "
960 "addr=%p, ft-id=%s", type
,
961 bt_field_type_id_string(type
->id
));
966 if (size
== 0 || size
> 64) {
967 BT_LOGW("Invalid parameter: size must be between 1 and 64: "
968 "addr=%p, size=%u", type
, size
);
973 integer
= container_of(type
, struct bt_field_type_integer
, parent
);
974 integer
->size
= size
;
975 BT_LOGV("Set integer field type's size: addr=%p, size=%u",
981 enum bt_integer_base
bt_field_type_integer_get_base(
982 struct bt_field_type
*type
)
984 enum bt_integer_base ret
= BT_INTEGER_BASE_UNKNOWN
;
985 struct bt_field_type_integer
*integer
;
988 BT_LOGW_STR("Invalid parameter: field type is NULL.");
992 if (type
->id
!= BT_FIELD_TYPE_ID_INTEGER
) {
993 BT_LOGW("Invalid parameter: field type is not an integer field type: "
994 "addr=%p, ft-id=%s", type
,
995 bt_field_type_id_string(type
->id
));
999 integer
= container_of(type
, struct bt_field_type_integer
, parent
);
1000 ret
= integer
->base
;
1005 int bt_field_type_integer_set_base(struct bt_field_type
*type
,
1006 enum bt_integer_base base
)
1011 BT_LOGW_STR("Invalid parameter: field type is NULL.");
1017 BT_LOGW("Invalid parameter: field type is frozen: addr=%p",
1023 if (type
->id
!= BT_FIELD_TYPE_ID_INTEGER
) {
1024 BT_LOGW("Invalid parameter: field type is not an integer field type: "
1025 "addr=%p, ft-id=%s", type
,
1026 bt_field_type_id_string(type
->id
));
1032 case BT_INTEGER_BASE_UNSPECIFIED
:
1033 case BT_INTEGER_BASE_BINARY
:
1034 case BT_INTEGER_BASE_OCTAL
:
1035 case BT_INTEGER_BASE_DECIMAL
:
1036 case BT_INTEGER_BASE_HEXADECIMAL
:
1038 struct bt_field_type_integer
*integer
= container_of(type
,
1039 struct bt_field_type_integer
, parent
);
1040 integer
->base
= base
;
1044 BT_LOGW("Invalid parameter: unknown integer field type base: "
1045 "addr=%p, base=%d", type
, base
);
1049 BT_LOGV("Set integer field type's base: addr=%p, base=%s",
1050 type
, bt_integer_base_string(base
));
1056 enum bt_string_encoding
bt_field_type_integer_get_encoding(
1057 struct bt_field_type
*type
)
1059 enum bt_string_encoding ret
= BT_STRING_ENCODING_UNKNOWN
;
1060 struct bt_field_type_integer
*integer
;
1063 BT_LOGW_STR("Invalid parameter: field type is NULL.");
1067 if (type
->id
!= BT_FIELD_TYPE_ID_INTEGER
) {
1068 BT_LOGW("Invalid parameter: field type is not an integer field type: "
1069 "addr=%p, ft-id=%s", type
,
1070 bt_field_type_id_string(type
->id
));
1074 integer
= container_of(type
, struct bt_field_type_integer
, parent
);
1075 ret
= integer
->encoding
;
1080 int bt_field_type_integer_set_encoding(struct bt_field_type
*type
,
1081 enum bt_string_encoding encoding
)
1084 struct bt_field_type_integer
*integer
;
1087 BT_LOGW_STR("Invalid parameter: field type is NULL.");
1093 BT_LOGW("Invalid parameter: field type is frozen: addr=%p",
1099 if (type
->id
!= BT_FIELD_TYPE_ID_INTEGER
) {
1100 BT_LOGW("Invalid parameter: field type is not an integer field type: "
1101 "addr=%p, ft-id=%s", type
,
1102 bt_field_type_id_string(type
->id
));
1107 if (encoding
!= BT_STRING_ENCODING_UTF8
&&
1108 encoding
!= BT_STRING_ENCODING_ASCII
&&
1109 encoding
!= BT_STRING_ENCODING_NONE
) {
1110 BT_LOGW("Invalid parameter: unknown string encoding: "
1111 "addr=%p, encoding=%d", type
, encoding
);
1116 integer
= container_of(type
, struct bt_field_type_integer
, parent
);
1117 integer
->encoding
= encoding
;
1118 BT_LOGV("Set integer field type's encoding: addr=%p, encoding=%s",
1119 type
, bt_string_encoding_string(encoding
));
1124 struct bt_clock_class
*bt_field_type_integer_get_mapped_clock_class(
1125 struct bt_field_type
*type
)
1127 struct bt_field_type_integer
*integer
;
1128 struct bt_clock_class
*clock_class
= NULL
;
1131 BT_LOGW_STR("Invalid parameter: field type is NULL.");
1135 integer
= container_of(type
, struct bt_field_type_integer
, parent
);
1136 clock_class
= integer
->mapped_clock
;
1137 bt_get(clock_class
);
1143 int bt_field_type_integer_set_mapped_clock_class_no_check(
1144 struct bt_field_type
*type
,
1145 struct bt_clock_class
*clock_class
)
1147 struct bt_field_type_integer
*integer
;
1151 BT_LOGW_STR("Invalid parameter: field type is NULL.");
1157 BT_LOGW_STR("Invalid parameter: clock class is NULL.");
1162 if (type
->id
!= BT_FIELD_TYPE_ID_INTEGER
) {
1163 BT_LOGW("Invalid parameter: field type is not an integer field type: "
1164 "addr=%p, ft-id=%s", type
,
1165 bt_field_type_id_string(type
->id
));
1169 if (!bt_clock_class_is_valid(clock_class
)) {
1170 BT_LOGW("Invalid parameter: clock class is invalid: ft-addr=%p"
1171 "clock-class-addr=%p, clock-class-name=\"%s\"",
1173 bt_clock_class_get_name(clock_class
));
1178 integer
= container_of(type
, struct bt_field_type_integer
, parent
);
1179 bt_put(integer
->mapped_clock
);
1180 integer
->mapped_clock
= bt_get(clock_class
);
1181 BT_LOGV("Set integer field type's mapped clock class: ft-addr=%p, "
1182 "clock-class-addr=%p, clock-class-name=\"%s\"",
1183 type
, clock_class
, bt_clock_class_get_name(clock_class
));
1188 int bt_field_type_integer_set_mapped_clock_class(
1189 struct bt_field_type
*type
,
1190 struct bt_clock_class
*clock_class
)
1195 BT_LOGW_STR("Invalid parameter: field type is NULL.");
1201 BT_LOGW("Invalid parameter: field type is frozen: addr=%p",
1207 ret
= bt_field_type_integer_set_mapped_clock_class_no_check(
1215 void bt_field_type_enum_iter_destroy(struct bt_object
*obj
)
1217 struct bt_field_type_enumeration_mapping_iterator
*iter
=
1219 struct bt_field_type_enumeration_mapping_iterator
,
1222 BT_LOGD("Destroying enumeration field type mapping iterator: addr=%p",
1224 BT_LOGD_STR("Putting parent enumeration field type.");
1225 bt_put(&iter
->enumeration_type
->parent
);
1230 struct bt_field_type_enumeration_mapping_iterator
*
1231 bt_field_type_enumeration_find_mappings_type(
1232 struct bt_field_type
*type
,
1233 enum bt_field_type_enumeration_mapping_iterator_type iterator_type
)
1235 struct bt_field_type_enumeration
*enumeration_type
;
1236 struct bt_field_type_enumeration_mapping_iterator
*iter
= NULL
;
1239 BT_LOGW_STR("Invalid parameter: field type is NULL.");
1243 if (type
->id
!= BT_FIELD_TYPE_ID_ENUM
) {
1244 BT_LOGW("Invalid parameter: field type is not an enumeration field type: "
1245 "addr=%p, ft-id=%s", type
,
1246 bt_field_type_id_string(type
->id
));
1250 enumeration_type
= container_of(type
,
1251 struct bt_field_type_enumeration
, parent
);
1252 iter
= g_new0(struct bt_field_type_enumeration_mapping_iterator
, 1);
1254 BT_LOGE_STR("Failed to allocate one enumeration field type mapping.");
1258 bt_object_init(&iter
->base
, bt_field_type_enum_iter_destroy
);
1260 iter
->enumeration_type
= enumeration_type
;
1262 iter
->type
= iterator_type
;
1267 struct bt_field_type_enumeration_mapping_iterator
*
1268 bt_field_type_enumeration_find_mappings_by_name(
1269 struct bt_field_type
*type
, const char *name
)
1271 struct bt_field_type_enumeration_mapping_iterator
*iter
;
1273 iter
= bt_field_type_enumeration_find_mappings_type(
1274 type
, ITERATOR_BY_NAME
);
1276 BT_LOGW("Cannot create enumeration field type mapping iterator: "
1277 "ft-addr=%p, mapping-name=\"%s\"", type
, name
);
1281 iter
->u
.name_quark
= g_quark_try_string(name
);
1282 if (!iter
->u
.name_quark
) {
1284 * No results are possible, set the iterator's position at the
1287 iter
->index
= iter
->enumeration_type
->entries
->len
;
1295 int bt_field_type_enumeration_mapping_iterator_next(
1296 struct bt_field_type_enumeration_mapping_iterator
*iter
)
1298 struct bt_field_type_enumeration
*enumeration
;
1299 struct bt_field_type
*type
;
1300 int i
, ret
= 0, len
;
1303 BT_LOGW_STR("Invalid parameter: enumeration field type mapping iterator is NULL.");
1308 enumeration
= iter
->enumeration_type
;
1309 type
= &enumeration
->parent
;
1310 len
= enumeration
->entries
->len
;
1311 for (i
= iter
->index
+ 1; i
< len
; i
++) {
1312 struct enumeration_mapping
*mapping
=
1313 get_enumeration_mapping(type
, i
);
1315 switch (iter
->type
) {
1316 case ITERATOR_BY_NAME
:
1317 if (mapping
->string
== iter
->u
.name_quark
) {
1322 case ITERATOR_BY_SIGNED_VALUE
:
1324 int64_t value
= iter
->u
.signed_value
;
1326 if (value
>= mapping
->range_start
._signed
&&
1327 value
<= mapping
->range_end
._signed
) {
1333 case ITERATOR_BY_UNSIGNED_VALUE
:
1335 uint64_t value
= iter
->u
.unsigned_value
;
1337 if (value
>= mapping
->range_start
._unsigned
&&
1338 value
<= mapping
->range_end
._unsigned
) {
1345 BT_LOGF("Invalid enumeration field type mapping iterator type: "
1346 "type=%d", iter
->type
);
1356 struct bt_field_type_enumeration_mapping_iterator
*
1357 bt_field_type_enumeration_find_mappings_by_signed_value(
1358 struct bt_field_type
*type
, int64_t value
)
1360 struct bt_field_type_enumeration_mapping_iterator
*iter
;
1362 iter
= bt_field_type_enumeration_find_mappings_type(
1363 type
, ITERATOR_BY_SIGNED_VALUE
);
1365 BT_LOGW("Cannot create enumeration field type mapping iterator: "
1366 "ft-addr=%p, value=%" PRId64
, type
, value
);
1370 if (bt_ctf_field_type_integer_get_signed(
1371 iter
->enumeration_type
->container
) != 1) {
1372 BT_LOGW("Invalid parameter: enumeration field type is unsigned: "
1373 "enum-ft-addr=%p, int-ft-addr=%p",
1374 type
, iter
->enumeration_type
->container
);
1378 iter
->u
.signed_value
= value
;
1385 struct bt_field_type_enumeration_mapping_iterator
*
1386 bt_field_type_enumeration_find_mappings_by_unsigned_value(
1387 struct bt_field_type
*type
, uint64_t value
)
1389 struct bt_field_type_enumeration_mapping_iterator
*iter
;
1391 iter
= bt_field_type_enumeration_find_mappings_type(
1392 type
, ITERATOR_BY_UNSIGNED_VALUE
);
1394 BT_LOGW("Cannot create enumeration field type mapping iterator: "
1395 "ft-addr=%p, value=%" PRIu64
, type
, value
);
1399 if (bt_ctf_field_type_integer_get_signed(
1400 iter
->enumeration_type
->container
) != 0) {
1401 BT_LOGW("Invalid parameter: enumeration field type is signed: "
1402 "enum-ft-addr=%p, int-ft-addr=%p",
1403 type
, iter
->enumeration_type
->container
);
1406 iter
->u
.unsigned_value
= value
;
1413 int bt_field_type_enumeration_mapping_iterator_get_signed(
1414 struct bt_field_type_enumeration_mapping_iterator
*iter
,
1415 const char **mapping_name
, int64_t *range_begin
,
1421 BT_LOGW_STR("Invalid parameter: enumeration field type mapping iterator is NULL.");
1426 if (iter
->index
== -1) {
1427 BT_LOGW_STR("Invalid enumeration field type mapping iterator access: position=-1");
1432 ret
= bt_field_type_enumeration_get_mapping_signed(
1433 &iter
->enumeration_type
->parent
, iter
->index
,
1434 mapping_name
, range_begin
, range_end
);
1439 int bt_field_type_enumeration_mapping_iterator_get_unsigned(
1440 struct bt_field_type_enumeration_mapping_iterator
*iter
,
1441 const char **mapping_name
, uint64_t *range_begin
,
1442 uint64_t *range_end
)
1447 BT_LOGW_STR("Invalid parameter: enumeration field type mapping iterator is NULL.");
1452 if (iter
->index
== -1) {
1453 BT_LOGW_STR("Invalid enumeration field type mapping iterator access: position=-1");
1458 ret
= bt_field_type_enumeration_get_mapping_unsigned(
1459 &iter
->enumeration_type
->parent
, iter
->index
,
1460 mapping_name
, range_begin
, range_end
);
1465 int bt_field_type_enumeration_get_mapping_signed(
1466 struct bt_field_type
*enum_field_type
,
1467 uint64_t index
, const char **mapping_name
, int64_t *range_begin
,
1471 struct enumeration_mapping
*mapping
;
1473 if (!enum_field_type
) {
1474 BT_LOGW_STR("Invalid parameter: field type is NULL.");
1479 mapping
= get_enumeration_mapping(enum_field_type
, index
);
1481 /* get_enumeration_mapping() reports any error */
1487 *mapping_name
= g_quark_to_string(mapping
->string
);
1488 assert(*mapping_name
);
1492 *range_begin
= mapping
->range_start
._signed
;
1496 *range_end
= mapping
->range_end
._signed
;
1502 int bt_field_type_enumeration_get_mapping_unsigned(
1503 struct bt_field_type
*enum_field_type
,
1505 const char **mapping_name
, uint64_t *range_begin
,
1506 uint64_t *range_end
)
1509 struct enumeration_mapping
*mapping
;
1511 if (!enum_field_type
) {
1512 BT_LOGW_STR("Invalid parameter: field type is NULL.");
1517 mapping
= get_enumeration_mapping(enum_field_type
, index
);
1519 /* get_enumeration_mapping() reports any error */
1525 *mapping_name
= g_quark_to_string(mapping
->string
);
1526 assert(*mapping_name
);
1530 *range_begin
= mapping
->range_start
._unsigned
;
1534 *range_end
= mapping
->range_end
._unsigned
;
1540 struct bt_field_type
*bt_field_type_enumeration_create(
1541 struct bt_field_type
*integer_container_type
)
1543 struct bt_field_type_enumeration
*enumeration
= NULL
;
1545 BT_LOGD("Creating enumeration field type object: int-ft-addr=%p",
1546 integer_container_type
);
1548 if (!integer_container_type
) {
1549 BT_LOGW_STR("Invalid parameter: field type is NULL.");
1553 if (integer_container_type
->id
!= BT_FIELD_TYPE_ID_INTEGER
) {
1554 BT_LOGW("Invalid parameter: container field type is not an integer field type: "
1555 "container-ft-addr=%p, container-ft-id=%s",
1556 integer_container_type
,
1557 bt_field_type_id_string(integer_container_type
->id
));
1561 enumeration
= g_new0(struct bt_field_type_enumeration
, 1);
1563 BT_LOGE_STR("Failed to allocate one enumeration field type.");
1567 enumeration
->parent
.id
= BT_FIELD_TYPE_ID_ENUM
;
1568 bt_get(integer_container_type
);
1569 enumeration
->container
= integer_container_type
;
1570 enumeration
->entries
= g_ptr_array_new_with_free_func(
1571 (GDestroyNotify
)destroy_enumeration_mapping
);
1572 bt_field_type_init(&enumeration
->parent
, FALSE
);
1573 BT_LOGD("Created enumeration field type object: addr=%p, "
1574 "int-ft-addr=%p, int-ft-size=%u",
1575 &enumeration
->parent
, integer_container_type
,
1576 bt_field_type_integer_get_size(integer_container_type
));
1577 return &enumeration
->parent
;
1579 g_free(enumeration
);
1583 struct bt_field_type
*bt_field_type_enumeration_get_container_type(
1584 struct bt_field_type
*type
)
1586 struct bt_field_type
*container_type
= NULL
;
1587 struct bt_field_type_enumeration
*enumeration_type
;
1590 BT_LOGW_STR("Invalid parameter: field type is NULL.");
1594 if (type
->id
!= BT_FIELD_TYPE_ID_ENUM
) {
1595 BT_LOGW("Invalid parameter: field type is not an enumeration field type: "
1596 "addr=%p, ft-id=%s", type
,
1597 bt_field_type_id_string(type
->id
));
1601 enumeration_type
= container_of(type
,
1602 struct bt_field_type_enumeration
, parent
);
1603 container_type
= enumeration_type
->container
;
1604 bt_get(container_type
);
1606 return container_type
;
1609 int bt_field_type_enumeration_add_mapping_signed(
1610 struct bt_field_type
*type
, const char *string
,
1611 int64_t range_start
, int64_t range_end
)
1614 GQuark mapping_name
;
1615 struct enumeration_mapping
*mapping
;
1616 struct bt_field_type_enumeration
*enumeration
;
1617 char *escaped_string
;
1620 BT_LOGW_STR("Invalid parameter: field type is NULL.");
1626 BT_LOGW_STR("Invalid parameter: string is NULL.");
1632 BT_LOGW("Invalid parameter: field type is frozen: addr=%p",
1638 if (type
->id
!= BT_FIELD_TYPE_ID_ENUM
) {
1639 BT_LOGW("Invalid parameter: field type is not an enumeration field type: "
1640 "addr=%p, ft-id=%s", type
,
1641 bt_field_type_id_string(type
->id
));
1646 if (range_end
< range_start
) {
1647 BT_LOGW("Invalid parameter: range's end is lesser than range's start: "
1648 "addr=%p, range-start=%" PRId64
", range-end=%" PRId64
,
1649 type
, range_start
, range_end
);
1654 if (strlen(string
) == 0) {
1655 BT_LOGW("Invalid parameter: mapping name is an empty string: "
1656 "enum-ft-addr=%p, mapping-name-addr=%p", type
,
1662 escaped_string
= g_strescape(string
, NULL
);
1663 if (!escaped_string
) {
1664 BT_LOGE("Cannot escape mapping name: enum-ft-addr=%p, "
1665 "mapping-name-addr=%p, mapping-name=\"%s\"",
1666 type
, string
, string
);
1671 mapping
= g_new(struct enumeration_mapping
, 1);
1673 BT_LOGE_STR("Failed to allocate one enumeration mapping.");
1677 mapping_name
= g_quark_from_string(escaped_string
);
1678 *mapping
= (struct enumeration_mapping
) {
1679 .range_start
._signed
= range_start
,
1680 .range_end
._signed
= range_end
,
1681 .string
= mapping_name
,
1683 enumeration
= container_of(type
, struct bt_field_type_enumeration
,
1685 g_ptr_array_add(enumeration
->entries
, mapping
);
1686 g_ptr_array_sort(enumeration
->entries
,
1687 (GCompareFunc
)compare_enumeration_mappings_signed
);
1688 BT_LOGV("Added mapping to signed enumeration field type: addr=%p, "
1689 "name=\"%s\", range-start=%" PRId64
", "
1690 "range-end=%" PRId64
,
1691 type
, string
, range_start
, range_end
);
1693 free(escaped_string
);
1698 int bt_field_type_enumeration_add_mapping_unsigned(
1699 struct bt_field_type
*type
, const char *string
,
1700 uint64_t range_start
, uint64_t range_end
)
1703 GQuark mapping_name
;
1704 struct enumeration_mapping
*mapping
;
1705 struct bt_field_type_enumeration
*enumeration
;
1706 char *escaped_string
;
1709 BT_LOGW_STR("Invalid parameter: field type is NULL.");
1715 BT_LOGW_STR("Invalid parameter: string is NULL.");
1721 BT_LOGW("Invalid parameter: field type is frozen: addr=%p",
1727 if (type
->id
!= BT_FIELD_TYPE_ID_ENUM
) {
1728 BT_LOGW("Invalid parameter: field type is not an enumeration field type: "
1729 "addr=%p, ft-id=%s", type
,
1730 bt_field_type_id_string(type
->id
));
1735 if (range_end
< range_start
) {
1736 BT_LOGW("Invalid parameter: range's end is lesser than range's start: "
1737 "addr=%p, range-start=%" PRIu64
", range-end=%" PRIu64
,
1738 type
, range_start
, range_end
);
1743 if (strlen(string
) == 0) {
1744 BT_LOGW("Invalid parameter: mapping name is an empty string: "
1745 "enum-ft-addr=%p, mapping-name-addr=%p", type
,
1751 escaped_string
= g_strescape(string
, NULL
);
1752 if (!escaped_string
) {
1753 BT_LOGE("Cannot escape mapping name: enum-ft-addr=%p, "
1754 "mapping-name-addr=%p, mapping-name=\"%s\"",
1755 type
, string
, string
);
1760 mapping
= g_new(struct enumeration_mapping
, 1);
1762 BT_LOGE_STR("Failed to allocate one enumeration mapping.");
1766 mapping_name
= g_quark_from_string(escaped_string
);
1767 *mapping
= (struct enumeration_mapping
) {
1768 .range_start
._unsigned
= range_start
,
1769 .range_end
._unsigned
= range_end
,
1770 .string
= mapping_name
,
1772 enumeration
= container_of(type
, struct bt_field_type_enumeration
,
1774 g_ptr_array_add(enumeration
->entries
, mapping
);
1775 g_ptr_array_sort(enumeration
->entries
,
1776 (GCompareFunc
)compare_enumeration_mappings_unsigned
);
1777 BT_LOGV("Added mapping to unsigned enumeration field type: addr=%p, "
1778 "name=\"%s\", range-start=%" PRIu64
", "
1779 "range-end=%" PRIu64
,
1780 type
, string
, range_start
, range_end
);
1782 free(escaped_string
);
1787 int64_t bt_field_type_enumeration_get_mapping_count(
1788 struct bt_field_type
*type
)
1791 struct bt_field_type_enumeration
*enumeration
;
1794 BT_LOGW_STR("Invalid parameter: field type is NULL.");
1799 if (type
->id
!= BT_FIELD_TYPE_ID_ENUM
) {
1800 BT_LOGW("Invalid parameter: field type is not an enumeration field type: "
1801 "addr=%p, ft-id=%s", type
,
1802 bt_field_type_id_string(type
->id
));
1807 enumeration
= container_of(type
, struct bt_field_type_enumeration
,
1809 ret
= (int64_t) enumeration
->entries
->len
;
1814 struct bt_field_type
*bt_field_type_floating_point_create(void)
1816 struct bt_field_type_floating_point
*floating_point
=
1817 g_new0(struct bt_field_type_floating_point
, 1);
1819 BT_LOGD_STR("Creating floating point number field type object.");
1821 if (!floating_point
) {
1822 BT_LOGE_STR("Failed to allocate one floating point number field type.");
1826 floating_point
->parent
.id
= BT_FIELD_TYPE_ID_FLOAT
;
1827 floating_point
->exp_dig
= sizeof(float) * CHAR_BIT
- FLT_MANT_DIG
;
1828 floating_point
->mant_dig
= FLT_MANT_DIG
;
1829 bt_field_type_init(&floating_point
->parent
, TRUE
);
1830 BT_LOGD("Created floating point number field type object: addr=%p, "
1831 "exp-size=%u, mant-size=%u", &floating_point
->parent
,
1832 floating_point
->exp_dig
, floating_point
->mant_dig
);
1834 return floating_point
? &floating_point
->parent
: NULL
;
1837 int bt_field_type_floating_point_get_exponent_digits(
1838 struct bt_field_type
*type
)
1841 struct bt_field_type_floating_point
*floating_point
;
1844 BT_LOGW_STR("Invalid parameter: field type is NULL.");
1849 if (type
->id
!= BT_FIELD_TYPE_ID_FLOAT
) {
1850 BT_LOGW("Invalid parameter: field type is not a floating point number field type: "
1851 "addr=%p, ft-id=%s", type
,
1852 bt_field_type_id_string(type
->id
));
1857 floating_point
= container_of(type
,
1858 struct bt_field_type_floating_point
, parent
);
1859 ret
= (int) floating_point
->exp_dig
;
1864 int bt_field_type_floating_point_set_exponent_digits(
1865 struct bt_field_type
*type
,
1866 unsigned int exponent_digits
)
1869 struct bt_field_type_floating_point
*floating_point
;
1872 BT_LOGW_STR("Invalid parameter: field type is NULL.");
1878 BT_LOGW("Invalid parameter: field type is frozen: addr=%p",
1884 if (type
->id
!= BT_FIELD_TYPE_ID_FLOAT
) {
1885 BT_LOGW("Invalid parameter: field type is not a floating point number field type: "
1886 "addr=%p, ft-id=%s", type
,
1887 bt_field_type_id_string(type
->id
));
1892 floating_point
= container_of(type
,
1893 struct bt_field_type_floating_point
, parent
);
1894 if ((exponent_digits
!= sizeof(float) * CHAR_BIT
- FLT_MANT_DIG
) &&
1895 (exponent_digits
!= sizeof(double) * CHAR_BIT
- DBL_MANT_DIG
) &&
1897 sizeof(long double) * CHAR_BIT
- LDBL_MANT_DIG
)) {
1898 BT_LOGW("Invalid parameter: invalid exponent size: "
1899 "addr=%p, exp-size=%u", type
, exponent_digits
);
1904 floating_point
->exp_dig
= exponent_digits
;
1905 BT_LOGV("Set floating point number field type's exponent size: addr=%p, "
1906 "exp-size=%u", type
, exponent_digits
);
1911 int bt_field_type_floating_point_get_mantissa_digits(
1912 struct bt_field_type
*type
)
1915 struct bt_field_type_floating_point
*floating_point
;
1918 BT_LOGW_STR("Invalid parameter: field type is NULL.");
1923 if (type
->id
!= BT_FIELD_TYPE_ID_FLOAT
) {
1924 BT_LOGW("Invalid parameter: field type is not a floating point number field type: "
1925 "addr=%p, ft-id=%s", type
,
1926 bt_field_type_id_string(type
->id
));
1931 floating_point
= container_of(type
,
1932 struct bt_field_type_floating_point
, parent
);
1933 ret
= (int) floating_point
->mant_dig
;
1938 int bt_field_type_floating_point_set_mantissa_digits(
1939 struct bt_field_type
*type
,
1940 unsigned int mantissa_digits
)
1943 struct bt_field_type_floating_point
*floating_point
;
1946 BT_LOGW_STR("Invalid parameter: field type is NULL.");
1952 BT_LOGW("Invalid parameter: field type is frozen: addr=%p",
1958 if (type
->id
!= BT_FIELD_TYPE_ID_FLOAT
) {
1959 BT_LOGW("Invalid parameter: field type is not a floating point number field type: "
1960 "addr=%p, ft-id=%s", type
,
1961 bt_field_type_id_string(type
->id
));
1966 floating_point
= container_of(type
,
1967 struct bt_field_type_floating_point
, parent
);
1969 if ((mantissa_digits
!= FLT_MANT_DIG
) &&
1970 (mantissa_digits
!= DBL_MANT_DIG
) &&
1971 (mantissa_digits
!= LDBL_MANT_DIG
)) {
1972 BT_LOGW("Invalid parameter: invalid mantissa size: "
1973 "addr=%p, mant-size=%u", type
, mantissa_digits
);
1978 floating_point
->mant_dig
= mantissa_digits
;
1979 BT_LOGV("Set floating point number field type's mantissa size: addr=%p, "
1980 "mant-size=%u", type
, mantissa_digits
);
1985 struct bt_field_type
*bt_field_type_structure_create(void)
1987 struct bt_field_type_structure
*structure
=
1988 g_new0(struct bt_field_type_structure
, 1);
1990 BT_LOGD_STR("Creating structure field type object.");
1993 BT_LOGE_STR("Failed to allocate one structure field type.");
1997 structure
->parent
.id
= BT_FIELD_TYPE_ID_STRUCT
;
1998 structure
->fields
= g_ptr_array_new_with_free_func(
1999 (GDestroyNotify
)destroy_structure_field
);
2000 structure
->field_name_to_index
= g_hash_table_new(NULL
, NULL
);
2001 bt_field_type_init(&structure
->parent
, TRUE
);
2002 BT_LOGD("Created structure field type object: addr=%p",
2003 &structure
->parent
);
2004 return &structure
->parent
;
2010 int bt_field_type_structure_replace_field(struct bt_field_type
*type
,
2011 const char *field_name
, struct bt_field_type
*field_type
)
2014 struct bt_field_type_structure
*structure
;
2021 assert(type
->id
== BT_FIELD_TYPE_ID_STRUCT
);
2022 structure
= container_of(type
, struct bt_field_type_structure
, parent
);
2023 name_quark
= g_quark_from_string(field_name
);
2025 for (i
= 0; i
< structure
->fields
->len
; i
++) {
2026 struct structure_field
*field
= g_ptr_array_index(
2027 structure
->fields
, i
);
2029 if (field
->name
== name_quark
) {
2030 bt_put(field
->type
);
2031 field
->type
= bt_get(field_type
);
2038 int bt_field_type_structure_add_field(struct bt_field_type
*type
,
2039 struct bt_field_type
*field_type
,
2040 const char *field_name
)
2043 struct bt_field_type_structure
*structure
;
2046 * TODO: check that `field_type` does not contain `type`,
2050 BT_LOGW_STR("Invalid parameter: field type is NULL.");
2056 BT_LOGW_STR("Invalid parameter: field name is NULL.");
2062 BT_LOGW("Invalid parameter: field type is frozen: addr=%p",
2068 if (type
->id
!= BT_FIELD_TYPE_ID_STRUCT
) {
2069 BT_LOGW("Invalid parameter: field type is not a structure field type: "
2070 "addr=%p, ft-id=%s", type
,
2071 bt_field_type_id_string(type
->id
));
2076 if (type
== field_type
) {
2077 BT_LOGW("Invalid parameter: structure field type and field type to add are the same: "
2083 structure
= container_of(type
,
2084 struct bt_field_type_structure
, parent
);
2085 if (add_structure_field(structure
->fields
,
2086 structure
->field_name_to_index
, field_type
, field_name
)) {
2087 BT_LOGW("Cannot add field to structure field type: "
2088 "struct-ft-addr=%p, field-ft-addr=%p, field-name=\"%s\"",
2089 type
, field_type
, field_name
);
2094 BT_LOGV("Added structure field type field: struct-ft-addr=%p, "
2095 "field-ft-addr=%p, field-name=\"%s\"", type
,
2096 field_type
, field_name
);
2101 int64_t bt_field_type_structure_get_field_count(
2102 struct bt_field_type
*type
)
2105 struct bt_field_type_structure
*structure
;
2108 BT_LOGW_STR("Invalid parameter: field type is NULL.");
2113 if (type
->id
!= BT_FIELD_TYPE_ID_STRUCT
) {
2114 BT_LOGW("Invalid parameter: field type is not a structure field type: "
2115 "addr=%p, ft-id=%s", type
,
2116 bt_field_type_id_string(type
->id
));
2121 structure
= container_of(type
, struct bt_field_type_structure
,
2123 ret
= (int64_t) structure
->fields
->len
;
2128 int bt_field_type_structure_get_field_by_index(
2129 struct bt_field_type
*type
,
2130 const char **field_name
, struct bt_field_type
**field_type
,
2133 struct bt_field_type_structure
*structure
;
2134 struct structure_field
*field
;
2138 BT_LOGW_STR("Invalid parameter: field type is NULL.");
2143 if (type
->id
!= BT_FIELD_TYPE_ID_STRUCT
) {
2144 BT_LOGW("Invalid parameter: field type is not a structure field type: "
2145 "addr=%p, ft-id=%s", type
,
2146 bt_field_type_id_string(type
->id
));
2151 structure
= container_of(type
, struct bt_field_type_structure
,
2153 if (index
>= structure
->fields
->len
) {
2154 BT_LOGW("Invalid parameter: index is out of bounds: "
2155 "addr=%p, index=%" PRIu64
", count=%u",
2156 type
, index
, structure
->fields
->len
);
2161 field
= g_ptr_array_index(structure
->fields
, index
);
2163 *field_type
= field
->type
;
2164 bt_get(field
->type
);
2167 *field_name
= g_quark_to_string(field
->name
);
2168 assert(*field_name
);
2174 struct bt_field_type
*bt_field_type_structure_get_field_type_by_name(
2175 struct bt_field_type
*type
,
2180 struct structure_field
*field
;
2181 struct bt_field_type_structure
*structure
;
2182 struct bt_field_type
*field_type
= NULL
;
2185 BT_LOGW_STR("Invalid parameter: field type is NULL.");
2190 BT_LOGW_STR("Invalid parameter: name is NULL.");
2194 name_quark
= g_quark_try_string(name
);
2196 BT_LOGV("No such structure field type field name: "
2197 "ft-addr=%p, field-name=\"%s\"",
2202 structure
= container_of(type
, struct bt_field_type_structure
,
2204 if (!g_hash_table_lookup_extended(structure
->field_name_to_index
,
2205 GUINT_TO_POINTER(name_quark
), NULL
, (gpointer
*)&index
)) {
2206 BT_LOGV("No such structure field type field name: "
2207 "ft-addr=%p, field-name=\"%s\"",
2212 field
= structure
->fields
->pdata
[index
];
2213 field_type
= field
->type
;
2219 struct bt_field_type
*bt_field_type_variant_create(
2220 struct bt_field_type
*enum_tag
, const char *tag_name
)
2222 struct bt_field_type_variant
*variant
= NULL
;
2224 BT_LOGD("Creating variant field type object: "
2225 "tag-ft-addr=%p, tag-field-name=\"%s\"",
2226 enum_tag
, tag_name
);
2228 if (tag_name
&& !bt_identifier_is_valid(tag_name
)) {
2229 BT_LOGW("Invalid parameter: tag field name is not a valid CTF identifier: "
2230 "tag-ft-addr=%p, tag-field-name=\"%s\"",
2231 enum_tag
, tag_name
);
2235 variant
= g_new0(struct bt_field_type_variant
, 1);
2237 BT_LOGE_STR("Failed to allocate one variant field type.");
2241 variant
->parent
.id
= BT_FIELD_TYPE_ID_VARIANT
;
2242 variant
->tag_name
= g_string_new(tag_name
);
2243 variant
->field_name_to_index
= g_hash_table_new(NULL
, NULL
);
2244 variant
->fields
= g_ptr_array_new_with_free_func(
2245 (GDestroyNotify
) destroy_structure_field
);
2248 variant
->tag
= container_of(enum_tag
,
2249 struct bt_field_type_enumeration
, parent
);
2252 bt_field_type_init(&variant
->parent
, TRUE
);
2253 /* A variant's alignment is undefined */
2254 variant
->parent
.alignment
= 0;
2255 BT_LOGD("Created variant field type object: addr=%p, "
2256 "tag-ft-addr=%p, tag-field-name=\"%s\"",
2257 &variant
->parent
, enum_tag
, tag_name
);
2258 return &variant
->parent
;
2263 struct bt_field_type
*bt_field_type_variant_get_tag_type(
2264 struct bt_field_type
*type
)
2266 struct bt_field_type_variant
*variant
;
2267 struct bt_field_type
*tag_type
= NULL
;
2270 BT_LOGW_STR("Invalid parameter: field type is NULL.");
2274 if (type
->id
!= BT_FIELD_TYPE_ID_VARIANT
) {
2275 BT_LOGW("Invalid parameter: field type is not a variant field type: "
2276 "addr=%p, ft-id=%s", type
,
2277 bt_field_type_id_string(type
->id
));
2281 variant
= container_of(type
, struct bt_field_type_variant
, parent
);
2282 if (!variant
->tag
) {
2283 BT_LOGV("Variant field type has no tag field type: "
2288 tag_type
= &variant
->tag
->parent
;
2294 const char *bt_field_type_variant_get_tag_name(
2295 struct bt_field_type
*type
)
2297 struct bt_field_type_variant
*variant
;
2298 const char *tag_name
= NULL
;
2301 BT_LOGW_STR("Invalid parameter: field type is NULL.");
2305 if (type
->id
!= BT_FIELD_TYPE_ID_VARIANT
) {
2306 BT_LOGW("Invalid parameter: field type is not a variant field type: "
2307 "addr=%p, ft-id=%s", type
,
2308 bt_field_type_id_string(type
->id
));
2312 variant
= container_of(type
, struct bt_field_type_variant
, parent
);
2313 if (variant
->tag_name
->len
== 0) {
2314 BT_LOGV("Variant field type has no tag field name: "
2319 tag_name
= variant
->tag_name
->str
;
2324 int bt_field_type_variant_set_tag_name(
2325 struct bt_field_type
*type
, const char *name
)
2328 struct bt_field_type_variant
*variant
;
2331 BT_LOGW_STR("Invalid parameter: field type is NULL.");
2337 BT_LOGW("Invalid parameter: field type is frozen: addr=%p",
2343 if (type
->id
!= BT_FIELD_TYPE_ID_VARIANT
) {
2344 BT_LOGW("Invalid parameter: field type is not a variant field type: "
2345 "addr=%p, ft-id=%s", type
,
2346 bt_field_type_id_string(type
->id
));
2351 if (!bt_identifier_is_valid(name
)) {
2352 BT_LOGW("Invalid parameter: tag field name is not a valid CTF identifier: "
2353 "variant-ft-addr=%p, tag-field-name=\"%s\"",
2359 variant
= container_of(type
, struct bt_field_type_variant
, parent
);
2360 g_string_assign(variant
->tag_name
, name
);
2361 BT_LOGV("Set variant field type's tag field name: addr=%p, "
2362 "tag-field-name=\"%s\"", type
, name
);
2367 int bt_field_type_variant_add_field(struct bt_field_type
*type
,
2368 struct bt_field_type
*field_type
,
2369 const char *field_name
)
2373 struct bt_field_type_variant
*variant
;
2374 GQuark field_name_quark
= g_quark_from_string(field_name
);
2377 * TODO: check that `field_type` does not contain `type`,
2381 BT_LOGW_STR("Invalid parameter: field type is NULL.");
2387 BT_LOGW("Invalid parameter: field type is frozen: addr=%p",
2393 if (type
->id
!= BT_FIELD_TYPE_ID_VARIANT
) {
2394 BT_LOGW("Invalid parameter: field type is not a variant field type: "
2395 "addr=%p, ft-id=%s", type
,
2396 bt_field_type_id_string(type
->id
));
2401 if (type
== field_type
) {
2402 BT_LOGW("Invalid parameter: variant field type and field type to add are the same: "
2408 variant
= container_of(type
, struct bt_field_type_variant
, parent
);
2410 /* The user has explicitly provided a tag; validate against it. */
2414 /* Make sure this name is present in the enum tag */
2415 for (i
= 0; i
< variant
->tag
->entries
->len
; i
++) {
2416 struct enumeration_mapping
*mapping
=
2417 g_ptr_array_index(variant
->tag
->entries
, i
);
2419 if (mapping
->string
== field_name_quark
) {
2426 /* Validation failed */
2427 BT_LOGW("Invalid parameter: field name does not name a tag field type's mapping: "
2428 "variant-ft-addr=%p, tag-ft-addr=%p, "
2429 "tag-field-name=\"%s\""
2430 "field-ft-addr=%p, field-name=\"%s\"",
2431 type
, variant
->tag
, variant
->tag_name
->str
,
2432 field_type
, field_name
);
2438 if (add_structure_field(variant
->fields
, variant
->field_name_to_index
,
2439 field_type
, field_name
)) {
2440 BT_LOGW("Cannot add field to variant field type: "
2441 "variant-ft-addr=%p, field-ft-addr=%p, field-name=\"%s\"",
2442 type
, field_type
, field_name
);
2447 BT_LOGV("Added variant field type field: variant-ft-addr=%p, "
2448 "field-ft-addr=%p, field-name=\"%s\"", type
,
2449 field_type
, field_name
);
2455 struct bt_field_type
*bt_field_type_variant_get_field_type_by_name(
2456 struct bt_field_type
*type
,
2457 const char *field_name
)
2461 struct structure_field
*field
;
2462 struct bt_field_type_variant
*variant
;
2463 struct bt_field_type
*field_type
= NULL
;
2466 BT_LOGW_STR("Invalid parameter: field type is NULL.");
2471 BT_LOGW_STR("Invalid parameter: field name is NULL.");
2475 name_quark
= g_quark_try_string(field_name
);
2477 BT_LOGV("No such variant field type field name: "
2478 "ft-addr=%p, field-name=\"%s\"",
2483 variant
= container_of(type
, struct bt_field_type_variant
, parent
);
2484 if (!g_hash_table_lookup_extended(variant
->field_name_to_index
,
2485 GUINT_TO_POINTER(name_quark
), NULL
, (gpointer
*)&index
)) {
2486 BT_LOGV("No such variant field type field name: "
2487 "ft-addr=%p, field-name=\"%s\"",
2492 field
= g_ptr_array_index(variant
->fields
, index
);
2493 field_type
= field
->type
;
2499 struct bt_field_type
*bt_field_type_variant_get_field_type_from_tag(
2500 struct bt_field_type
*type
,
2501 struct bt_field
*tag
)
2504 const char *enum_value
;
2505 struct bt_field_type
*field_type
= NULL
;
2506 struct bt_field_type_enumeration_mapping_iterator
*iter
= NULL
;
2509 BT_LOGW_STR("Invalid parameter: variant field type is NULL.");
2514 BT_LOGW_STR("Invalid parameter: tag field is NULL.");
2518 if (type
->id
!= BT_FIELD_TYPE_ID_VARIANT
) {
2519 BT_LOGW("Invalid parameter: field type is not a variant field type: "
2520 "addr=%p, ft-id=%s", type
,
2521 bt_field_type_id_string(type
->id
));
2525 iter
= bt_field_enumeration_get_mappings(tag
);
2526 ret
= bt_field_type_enumeration_mapping_iterator_next(iter
);
2528 BT_LOGW("Cannot get enumeration field type mapping iterator from enumeration field: "
2529 "enum-field-addr=%p", tag
);
2533 ret
= bt_field_type_enumeration_mapping_iterator_get_signed(iter
,
2534 &enum_value
, NULL
, NULL
);
2536 BT_LOGW("Cannot get enumeration field type mapping iterator's current mapping: "
2537 "iter-addr=%p", iter
);
2541 field_type
= bt_field_type_variant_get_field_type_by_name(
2548 int64_t bt_field_type_variant_get_field_count(struct bt_field_type
*type
)
2551 struct bt_field_type_variant
*variant
;
2554 BT_LOGW_STR("Invalid parameter: field type is NULL.");
2559 if (type
->id
!= BT_FIELD_TYPE_ID_VARIANT
) {
2560 BT_LOGW("Invalid parameter: field type is not a variant field type: "
2561 "addr=%p, ft-id=%s", type
,
2562 bt_field_type_id_string(type
->id
));
2567 variant
= container_of(type
, struct bt_field_type_variant
,
2569 ret
= (int64_t) variant
->fields
->len
;
2575 int bt_field_type_variant_get_field_by_index(struct bt_field_type
*type
,
2576 const char **field_name
, struct bt_field_type
**field_type
,
2579 struct bt_field_type_variant
*variant
;
2580 struct structure_field
*field
;
2584 BT_LOGW_STR("Invalid parameter: field type is NULL.");
2589 if (type
->id
!= BT_FIELD_TYPE_ID_VARIANT
) {
2590 BT_LOGW("Invalid parameter: field type is not a variant field type: "
2591 "addr=%p, ft-id=%s", type
,
2592 bt_field_type_id_string(type
->id
));
2597 variant
= container_of(type
, struct bt_field_type_variant
,
2599 if (index
>= variant
->fields
->len
) {
2600 BT_LOGW("Invalid parameter: index is out of bounds: "
2601 "addr=%p, index=%" PRIu64
", count=%u",
2602 type
, index
, variant
->fields
->len
);
2607 field
= g_ptr_array_index(variant
->fields
, index
);
2609 *field_type
= field
->type
;
2610 bt_get(field
->type
);
2613 *field_name
= g_quark_to_string(field
->name
);
2614 assert(*field_name
);
2620 struct bt_field_type
*bt_field_type_array_create(
2621 struct bt_field_type
*element_type
,
2622 unsigned int length
)
2624 struct bt_field_type_array
*array
= NULL
;
2626 BT_LOGD("Creating array field type object: element-ft-addr=%p, "
2627 "length=%u", element_type
, length
);
2629 if (!element_type
) {
2630 BT_LOGW_STR("Invalid parameter: element field type is NULL.");
2635 BT_LOGW_STR("Invalid parameter: length is zero.");
2639 array
= g_new0(struct bt_field_type_array
, 1);
2641 BT_LOGE_STR("Failed to allocate one array field type.");
2645 array
->parent
.id
= BT_FIELD_TYPE_ID_ARRAY
;
2646 bt_get(element_type
);
2647 array
->element_type
= element_type
;
2648 array
->length
= length
;
2649 bt_field_type_init(&array
->parent
, FALSE
);
2650 BT_LOGD("Created array field type object: addr=%p, "
2651 "element-ft-addr=%p, length=%u",
2652 &array
->parent
, element_type
, length
);
2653 return &array
->parent
;
2658 struct bt_field_type
*bt_field_type_array_get_element_type(
2659 struct bt_field_type
*type
)
2661 struct bt_field_type
*ret
= NULL
;
2662 struct bt_field_type_array
*array
;
2665 BT_LOGW_STR("Invalid parameter: field type is NULL.");
2669 if (type
->id
!= BT_FIELD_TYPE_ID_ARRAY
) {
2670 BT_LOGW("Invalid parameter: field type is not an array field type: "
2671 "addr=%p, ft-id=%s", type
,
2672 bt_field_type_id_string(type
->id
));
2676 array
= container_of(type
, struct bt_field_type_array
, parent
);
2677 ret
= array
->element_type
;
2684 int bt_field_type_array_set_element_type(struct bt_field_type
*type
,
2685 struct bt_field_type
*element_type
)
2688 struct bt_field_type_array
*array
;
2691 BT_LOGW_STR("Invalid parameter: array field type is NULL.");
2696 if (!element_type
) {
2697 BT_LOGW_STR("Invalid parameter: element field type is NULL.");
2702 if (type
->id
!= BT_FIELD_TYPE_ID_ARRAY
) {
2703 BT_LOGW("Invalid parameter: field type is not an array field type: "
2704 "addr=%p, ft-id=%s", type
,
2705 bt_field_type_id_string(type
->id
));
2710 array
= container_of(type
, struct bt_field_type_array
, parent
);
2712 if (array
->element_type
) {
2713 BT_PUT(array
->element_type
);
2716 array
->element_type
= element_type
;
2717 bt_get(array
->element_type
);
2718 BT_LOGV("Set array field type's element field type: array-ft-addr=%p, "
2719 "element-ft-addr=%p", type
, element_type
);
2725 int64_t bt_field_type_array_get_length(struct bt_field_type
*type
)
2728 struct bt_field_type_array
*array
;
2731 BT_LOGW_STR("Invalid parameter: field type is NULL.");
2736 if (type
->id
!= BT_FIELD_TYPE_ID_ARRAY
) {
2737 BT_LOGW("Invalid parameter: field type is not an array field type: "
2738 "addr=%p, ft-id=%s", type
,
2739 bt_field_type_id_string(type
->id
));
2744 array
= container_of(type
, struct bt_field_type_array
, parent
);
2745 ret
= (int64_t) array
->length
;
2750 struct bt_field_type
*bt_field_type_sequence_create(
2751 struct bt_field_type
*element_type
,
2752 const char *length_field_name
)
2754 struct bt_field_type_sequence
*sequence
= NULL
;
2756 BT_LOGD("Creating sequence field type object: element-ft-addr=%p, "
2757 "length-field-name=\"%s\"", element_type
, length_field_name
);
2759 if (!element_type
) {
2760 BT_LOGW_STR("Invalid parameter: element field type is NULL.");
2764 if (!bt_identifier_is_valid(length_field_name
)) {
2765 BT_LOGW("Invalid parameter: length field name is not a valid CTF identifier: "
2766 "length-field-name=\"%s\"", length_field_name
);
2770 sequence
= g_new0(struct bt_field_type_sequence
, 1);
2772 BT_LOGE_STR("Failed to allocate one sequence field type.");
2776 sequence
->parent
.id
= BT_FIELD_TYPE_ID_SEQUENCE
;
2777 bt_get(element_type
);
2778 sequence
->element_type
= element_type
;
2779 sequence
->length_field_name
= g_string_new(length_field_name
);
2780 bt_field_type_init(&sequence
->parent
, FALSE
);
2781 BT_LOGD("Created sequence field type object: addr=%p, "
2782 "element-ft-addr=%p, length-field-name=\"%s\"",
2783 &sequence
->parent
, element_type
, length_field_name
);
2784 return &sequence
->parent
;
2789 struct bt_field_type
*bt_field_type_sequence_get_element_type(
2790 struct bt_field_type
*type
)
2792 struct bt_field_type
*ret
= NULL
;
2793 struct bt_field_type_sequence
*sequence
;
2796 BT_LOGW_STR("Invalid parameter: field type is NULL.");
2800 if (type
->id
!= BT_FIELD_TYPE_ID_SEQUENCE
) {
2801 BT_LOGW("Invalid parameter: field type is not a sequence field type: "
2802 "addr=%p, ft-id=%s", type
,
2803 bt_field_type_id_string(type
->id
));
2807 sequence
= container_of(type
, struct bt_field_type_sequence
,
2809 ret
= sequence
->element_type
;
2816 int bt_field_type_sequence_set_element_type(struct bt_field_type
*type
,
2817 struct bt_field_type
*element_type
)
2820 struct bt_field_type_sequence
*sequence
;
2823 BT_LOGW_STR("Invalid parameter: sequence field type is NULL.");
2828 if (!element_type
) {
2829 BT_LOGW_STR("Invalid parameter: element field type is NULL.");
2834 if (type
->id
!= BT_FIELD_TYPE_ID_SEQUENCE
) {
2835 BT_LOGW("Invalid parameter: field type is not a sequence field type: "
2836 "addr=%p, ft-id=%s", type
,
2837 bt_field_type_id_string(type
->id
));
2842 sequence
= container_of(type
, struct bt_field_type_sequence
, parent
);
2843 if (sequence
->element_type
) {
2844 BT_PUT(sequence
->element_type
);
2847 sequence
->element_type
= element_type
;
2848 bt_get(sequence
->element_type
);
2849 BT_LOGV("Set sequence field type's element field type: sequence-ft-addr=%p, "
2850 "element-ft-addr=%p", type
, element_type
);
2856 const char *bt_field_type_sequence_get_length_field_name(
2857 struct bt_field_type
*type
)
2859 const char *ret
= NULL
;
2860 struct bt_field_type_sequence
*sequence
;
2863 BT_LOGW_STR("Invalid parameter: field type is NULL.");
2867 if (type
->id
!= BT_FIELD_TYPE_ID_SEQUENCE
) {
2868 BT_LOGW("Invalid parameter: field type is not a sequence field type: "
2869 "addr=%p, ft-id=%s", type
,
2870 bt_field_type_id_string(type
->id
));
2874 sequence
= container_of(type
, struct bt_field_type_sequence
,
2876 ret
= sequence
->length_field_name
->str
;
2881 struct bt_field_type
*bt_field_type_string_create(void)
2883 struct bt_field_type_string
*string
=
2884 g_new0(struct bt_field_type_string
, 1);
2886 BT_LOGD_STR("Creating string field type object.");
2889 BT_LOGE_STR("Failed to allocate one string field type.");
2893 string
->parent
.id
= BT_FIELD_TYPE_ID_STRING
;
2894 bt_field_type_init(&string
->parent
, TRUE
);
2895 string
->encoding
= BT_STRING_ENCODING_UTF8
;
2896 string
->parent
.alignment
= CHAR_BIT
;
2897 BT_LOGD("Created string field type object: addr=%p", &string
->parent
);
2898 return &string
->parent
;
2901 enum bt_string_encoding
bt_field_type_string_get_encoding(
2902 struct bt_field_type
*type
)
2904 struct bt_field_type_string
*string
;
2905 enum bt_string_encoding ret
= BT_STRING_ENCODING_UNKNOWN
;
2908 BT_LOGW_STR("Invalid parameter: field type is NULL.");
2912 if (type
->id
!= BT_FIELD_TYPE_ID_STRING
) {
2913 BT_LOGW("Invalid parameter: field type is not a string field type: "
2914 "addr=%p, ft-id=%s", type
,
2915 bt_field_type_id_string(type
->id
));
2919 string
= container_of(type
, struct bt_field_type_string
,
2921 ret
= string
->encoding
;
2926 int bt_field_type_string_set_encoding(struct bt_field_type
*type
,
2927 enum bt_string_encoding encoding
)
2930 struct bt_field_type_string
*string
;
2933 BT_LOGW_STR("Invalid parameter: field type is NULL.");
2938 if (type
->id
!= BT_FIELD_TYPE_ID_STRING
) {
2939 BT_LOGW("Invalid parameter: field type is not a string field type: "
2940 "addr=%p, ft-id=%s", type
,
2941 bt_field_type_id_string(type
->id
));
2946 if (encoding
!= BT_STRING_ENCODING_UTF8
&&
2947 encoding
!= BT_STRING_ENCODING_ASCII
) {
2948 BT_LOGW("Invalid parameter: unknown string encoding: "
2949 "addr=%p, encoding=%d", type
, encoding
);
2954 string
= container_of(type
, struct bt_field_type_string
, parent
);
2955 string
->encoding
= encoding
;
2956 BT_LOGV("Set string field type's encoding: addr=%p, encoding=%s",
2957 type
, bt_string_encoding_string(encoding
));
2962 int bt_field_type_get_alignment(struct bt_field_type
*type
)
2965 enum bt_field_type_id type_id
;
2968 BT_LOGW_STR("Invalid parameter: field type is NULL.");
2974 ret
= (int) type
->alignment
;
2978 type_id
= bt_field_type_get_type_id(type
);
2980 case BT_FIELD_TYPE_ID_SEQUENCE
:
2982 struct bt_field_type
*element
=
2983 bt_field_type_sequence_get_element_type(type
);
2986 ret
= bt_field_type_get_alignment(element
);
2990 case BT_FIELD_TYPE_ID_ARRAY
:
2992 struct bt_field_type
*element
=
2993 bt_field_type_array_get_element_type(type
);
2996 ret
= bt_field_type_get_alignment(element
);
3000 case BT_FIELD_TYPE_ID_STRUCT
:
3002 int64_t i
, element_count
;
3004 element_count
= bt_field_type_structure_get_field_count(
3006 assert(element_count
>= 0);
3008 for (i
= 0; i
< element_count
; i
++) {
3009 struct bt_field_type
*field
= NULL
;
3010 int field_alignment
;
3012 ret
= bt_field_type_structure_get_field_by_index(
3013 type
, NULL
, &field
, i
);
3016 field_alignment
= bt_field_type_get_alignment(
3019 if (field_alignment
< 0) {
3020 ret
= field_alignment
;
3024 type
->alignment
= MAX(field_alignment
, type
->alignment
);
3026 ret
= (int) type
->alignment
;
3029 case BT_FIELD_TYPE_ID_ENUM
:
3031 struct bt_field_type
*container
=
3032 bt_field_type_enumeration_get_container_type(type
);
3034 ret
= bt_field_type_get_alignment(container
);
3038 case BT_FIELD_TYPE_ID_UNKNOWN
:
3039 BT_LOGW("Invalid parameter: unknown field type ID: "
3040 "addr=%p, ft-id=%d", type
, type_id
);
3044 ret
= (int) type
->alignment
;
3052 int is_power_of_two(unsigned int value
)
3054 return ((value
& (value
- 1)) == 0) && value
> 0;
3057 int bt_field_type_set_alignment(struct bt_field_type
*type
,
3058 unsigned int alignment
)
3061 enum bt_field_type_id type_id
;
3063 /* Alignment must be a power of two */
3065 BT_LOGW_STR("Invalid parameter: field type is NULL.");
3071 BT_LOGW("Invalid parameter: field type is frozen: addr=%p",
3077 if (!is_power_of_two(alignment
)) {
3078 BT_LOGW("Invalid parameter: alignment is not a power of two: "
3079 "addr=%p, align=%u", type
, alignment
);
3084 type_id
= bt_field_type_get_type_id(type
);
3085 if (type_id
== BT_FIELD_TYPE_ID_UNKNOWN
) {
3086 BT_LOGW("Invalid parameter: unknown field type ID: "
3087 "addr=%p, ft-id=%d", type
, type_id
);
3092 if (type
->id
== BT_FIELD_TYPE_ID_STRING
&&
3093 alignment
!= CHAR_BIT
) {
3094 BT_LOGW("Invalid parameter: alignment must be %u for a string field type: "
3095 "addr=%p, align=%u", CHAR_BIT
, type
, alignment
);
3100 if (type_id
== BT_FIELD_TYPE_ID_VARIANT
||
3101 type_id
== BT_FIELD_TYPE_ID_SEQUENCE
||
3102 type_id
== BT_FIELD_TYPE_ID_ARRAY
) {
3103 /* Setting an alignment on these types makes no sense */
3104 BT_LOGW("Invalid parameter: cannot set the alignment of this field type: "
3105 "addr=%p, ft-id=%s", type
,
3106 bt_field_type_id_string(type
->id
));
3111 type
->alignment
= alignment
;
3113 BT_LOGV("Set field type's alignment: addr=%p, align=%u",
3119 enum bt_byte_order
bt_field_type_get_byte_order(
3120 struct bt_field_type
*type
)
3122 enum bt_byte_order ret
= BT_BYTE_ORDER_UNKNOWN
;
3125 BT_LOGW_STR("Invalid parameter: field type is NULL.");
3130 case BT_FIELD_TYPE_ID_INTEGER
:
3132 struct bt_field_type_integer
*integer
= container_of(
3133 type
, struct bt_field_type_integer
, parent
);
3134 ret
= integer
->user_byte_order
;
3137 case BT_FIELD_TYPE_ID_ENUM
:
3139 struct bt_field_type_enumeration
*enum_ft
= container_of(
3140 type
, struct bt_field_type_enumeration
, parent
);
3141 ret
= bt_field_type_get_byte_order(enum_ft
->container
);
3144 case BT_FIELD_TYPE_ID_FLOAT
:
3146 struct bt_field_type_floating_point
*floating_point
=
3148 struct bt_field_type_floating_point
,
3150 ret
= floating_point
->user_byte_order
;
3154 BT_LOGW("Invalid parameter: cannot get the byte order of this field type: "
3155 "addr=%p, ft-id=%s", type
,
3156 bt_field_type_id_string(type
->id
));
3160 assert(ret
== BT_BYTE_ORDER_NATIVE
||
3161 ret
== BT_BYTE_ORDER_LITTLE_ENDIAN
||
3162 ret
== BT_BYTE_ORDER_BIG_ENDIAN
||
3163 ret
== BT_BYTE_ORDER_NETWORK
);
3169 int bt_field_type_set_byte_order(struct bt_field_type
*type
,
3170 enum bt_byte_order byte_order
)
3175 BT_LOGW_STR("Invalid parameter: field type is NULL.");
3181 BT_LOGW("Invalid parameter: field type is frozen: addr=%p",
3187 if (byte_order
!= BT_BYTE_ORDER_NATIVE
&&
3188 byte_order
!= BT_BYTE_ORDER_LITTLE_ENDIAN
&&
3189 byte_order
!= BT_BYTE_ORDER_BIG_ENDIAN
&&
3190 byte_order
!= BT_BYTE_ORDER_NETWORK
) {
3191 BT_LOGW("Invalid parameter: invalid byte order: "
3192 "addr=%p, bo=%s", type
,
3193 bt_byte_order_string(byte_order
));
3198 if (set_byte_order_funcs
[type
->id
]) {
3199 set_byte_order_funcs
[type
->id
](type
, byte_order
);
3202 BT_LOGV("Set field type's byte order: addr=%p, bo=%s",
3203 type
, bt_byte_order_string(byte_order
));
3209 enum bt_field_type_id
bt_field_type_get_type_id(
3210 struct bt_field_type
*type
)
3213 BT_LOGW_STR("Invalid parameter: field type is NULL.");
3214 return BT_FIELD_TYPE_ID_UNKNOWN
;
3220 int bt_field_type_is_integer(struct bt_field_type
*type
)
3222 return bt_field_type_get_type_id(type
) == BT_FIELD_TYPE_ID_INTEGER
;
3225 int bt_field_type_is_floating_point(struct bt_field_type
*type
)
3227 return bt_field_type_get_type_id(type
) == BT_FIELD_TYPE_ID_FLOAT
;
3230 int bt_field_type_is_enumeration(struct bt_field_type
*type
)
3232 return bt_field_type_get_type_id(type
) == BT_FIELD_TYPE_ID_ENUM
;
3235 int bt_field_type_is_string(struct bt_field_type
*type
)
3237 return bt_field_type_get_type_id(type
) == BT_FIELD_TYPE_ID_STRING
;
3240 int bt_field_type_is_structure(struct bt_field_type
*type
)
3242 return bt_field_type_get_type_id(type
) == BT_FIELD_TYPE_ID_STRUCT
;
3245 int bt_field_type_is_array(struct bt_field_type
*type
)
3247 return bt_field_type_get_type_id(type
) == BT_FIELD_TYPE_ID_ARRAY
;
3250 int bt_field_type_is_sequence(struct bt_field_type
*type
)
3252 return bt_field_type_get_type_id(type
) == BT_FIELD_TYPE_ID_SEQUENCE
;
3255 int bt_field_type_is_variant(struct bt_field_type
*type
)
3257 return bt_field_type_get_type_id(type
) == BT_FIELD_TYPE_ID_VARIANT
;
3260 /* Pre-2.0 CTF writer backward compatibility */
3261 void bt_ctf_field_type_get(struct bt_field_type
*type
)
3266 /* Pre-2.0 CTF writer backward compatibility */
3267 void bt_ctf_field_type_put(struct bt_field_type
*type
)
3273 void bt_field_type_freeze(struct bt_field_type
*type
)
3275 if (!type
|| type
->frozen
) {
3283 struct bt_field_type
*bt_field_type_variant_get_field_type_signed(
3284 struct bt_field_type_variant
*variant
,
3287 struct bt_field_type
*type
= NULL
;
3288 GQuark field_name_quark
;
3290 struct structure_field
*field_entry
;
3291 struct range_overlap_query query
= {
3292 .range_start
._signed
= tag_value
,
3293 .range_end
._signed
= tag_value
,
3298 g_ptr_array_foreach(variant
->tag
->entries
, check_ranges_overlap
,
3300 if (!query
.overlaps
) {
3304 field_name_quark
= query
.mapping_name
;
3305 if (!g_hash_table_lookup_extended(variant
->field_name_to_index
,
3306 GUINT_TO_POINTER(field_name_quark
), NULL
, &index
)) {
3310 field_entry
= g_ptr_array_index(variant
->fields
, (size_t) index
);
3311 type
= field_entry
->type
;
3317 struct bt_field_type
*bt_field_type_variant_get_field_type_unsigned(
3318 struct bt_field_type_variant
*variant
,
3321 struct bt_field_type
*type
= NULL
;
3322 GQuark field_name_quark
;
3324 struct structure_field
*field_entry
;
3325 struct range_overlap_query query
= {
3326 .range_start
._unsigned
= tag_value
,
3327 .range_end
._unsigned
= tag_value
,
3332 g_ptr_array_foreach(variant
->tag
->entries
,
3333 check_ranges_overlap_unsigned
,
3335 if (!query
.overlaps
) {
3339 field_name_quark
= query
.mapping_name
;
3340 if (!g_hash_table_lookup_extended(variant
->field_name_to_index
,
3341 GUINT_TO_POINTER(field_name_quark
), NULL
, &index
)) {
3345 field_entry
= g_ptr_array_index(variant
->fields
, (size_t)index
);
3346 type
= field_entry
->type
;
3352 int bt_field_type_serialize(struct bt_field_type
*type
,
3353 struct metadata_context
*context
)
3360 /* Make sure field type is valid before serializing it */
3361 ret
= bt_field_type_validate(type
);
3363 BT_LOGW("Cannot serialize field type's metadata: field type is invalid: "
3368 ret
= type
->serialize(type
, context
);
3373 struct bt_field_type
*bt_field_type_copy(struct bt_field_type
*type
)
3375 struct bt_field_type
*copy
= NULL
;
3378 BT_LOGW_STR("Invalid parameter: field type is NULL.");
3382 copy
= type_copy_funcs
[type
->id
](type
);
3384 BT_LOGE_STR("Cannot copy field type.");
3388 copy
->alignment
= type
->alignment
;
3394 int bt_field_type_structure_get_field_name_index(
3395 struct bt_field_type
*type
, const char *name
)
3400 struct bt_field_type_structure
*structure
;
3403 BT_LOGW_STR("Invalid parameter: field type is NULL.");
3409 BT_LOGW_STR("Invalid parameter: field name is NULL.");
3414 if (bt_field_type_get_type_id(type
) != BT_FIELD_TYPE_ID_STRUCT
) {
3415 BT_LOGW("Invalid parameter: field type is not a structure field type: "
3416 "addr=%p, ft-id=%s", type
,
3417 bt_field_type_id_string(type
->id
));
3422 name_quark
= g_quark_try_string(name
);
3424 BT_LOGV("No such structure field type field name: "
3425 "ft-addr=%p, field-name=\"%s\"",
3431 structure
= container_of(type
, struct bt_field_type_structure
,
3433 if (!g_hash_table_lookup_extended(structure
->field_name_to_index
,
3434 GUINT_TO_POINTER(name_quark
),
3435 NULL
, (gpointer
*)&index
)) {
3436 BT_LOGV("No such structure field type field name: "
3437 "ft-addr=%p, field-name=\"%s\"",
3448 int bt_field_type_variant_get_field_name_index(
3449 struct bt_field_type
*type
, const char *name
)
3454 struct bt_field_type_variant
*variant
;
3457 BT_LOGW_STR("Invalid parameter: variant field type is NULL.");
3463 BT_LOGW_STR("Invalid parameter: field name is NULL.");
3468 if (bt_field_type_get_type_id(type
) != BT_FIELD_TYPE_ID_VARIANT
) {
3469 BT_LOGW("Invalid parameter: field type is not a variant field type: "
3470 "addr=%p, ft-id=%s", type
,
3471 bt_field_type_id_string(type
->id
));
3476 name_quark
= g_quark_try_string(name
);
3478 BT_LOGV("No such variant field type field name: "
3479 "ft-addr=%p, field-name=\"%s\"",
3485 variant
= container_of(type
, struct bt_field_type_variant
,
3487 if (!g_hash_table_lookup_extended(variant
->field_name_to_index
,
3488 GUINT_TO_POINTER(name_quark
),
3489 NULL
, (gpointer
*)&index
)) {
3490 BT_LOGV("No such variant field type field name: "
3491 "ft-addr=%p, field-name=\"%s\"",
3502 int bt_field_type_sequence_set_length_field_path(
3503 struct bt_field_type
*type
,
3504 struct bt_field_path
*path
)
3507 struct bt_field_type_sequence
*sequence
;
3510 BT_LOGW_STR("Invalid parameter: field type is NULL.");
3515 if (bt_field_type_get_type_id(type
) != BT_FIELD_TYPE_ID_SEQUENCE
) {
3516 BT_LOGW("Invalid parameter: field type is not a sequence field type: "
3517 "addr=%p, ft-id=%s", type
,
3518 bt_field_type_id_string(type
->id
));
3523 sequence
= container_of(type
, struct bt_field_type_sequence
,
3526 BT_MOVE(sequence
->length_field_path
, path
);
3527 BT_LOGV("Set sequence field type's length field path: ft-addr=%p, "
3528 "field-path-addr=%p", type
, path
);
3534 int bt_field_type_variant_set_tag_field_path(struct bt_field_type
*type
,
3535 struct bt_field_path
*path
)
3538 struct bt_field_type_variant
*variant
;
3541 BT_LOGW_STR("Invalid parameter: field type is NULL.");
3546 if (bt_field_type_get_type_id(type
) != BT_FIELD_TYPE_ID_VARIANT
) {
3547 BT_LOGW("Invalid parameter: field type is not a variant field type: "
3548 "addr=%p, ft-id=%s", type
,
3549 bt_field_type_id_string(type
->id
));
3554 variant
= container_of(type
, struct bt_field_type_variant
,
3557 BT_MOVE(variant
->tag_field_path
, path
);
3558 BT_LOGV("Set variant field type's tag field path: ft-addr=%p, "
3559 "field-path-addr=%p", type
, path
);
3565 int bt_field_type_variant_set_tag_field_type(struct bt_field_type
*type
,
3566 struct bt_field_type
*tag
)
3569 struct bt_field_type_variant
*variant
;
3572 BT_LOGW_STR("Invalid parameter: variant field type is NULL.");
3578 BT_LOGW_STR("Invalid parameter: tag field type is NULL.");
3583 if (bt_field_type_get_type_id(tag
) != BT_FIELD_TYPE_ID_ENUM
) {
3584 BT_LOGW("Invalid parameter: field type is not an enumeration field type: "
3585 "addr=%p, ft-id=%s", type
,
3586 bt_field_type_id_string(type
->id
));
3591 variant
= container_of(type
, struct bt_field_type_variant
,
3595 bt_put(&variant
->tag
->parent
);
3597 variant
->tag
= container_of(tag
, struct bt_field_type_enumeration
,
3599 BT_LOGV("Set variant field type's tag field type: variant-ft-addr=%p, "
3600 "tag-ft-addr=%p", type
, tag
);
3606 void bt_field_type_integer_destroy(struct bt_field_type
*type
)
3608 struct bt_field_type_integer
*integer
=
3609 (struct bt_field_type_integer
*) type
;
3615 BT_LOGD("Destroying integer field type object: addr=%p", type
);
3616 BT_LOGD_STR("Putting mapped clock class.");
3617 bt_put(integer
->mapped_clock
);
3622 void bt_field_type_enumeration_destroy(struct bt_field_type
*type
)
3624 struct bt_field_type_enumeration
*enumeration
=
3625 (struct bt_field_type_enumeration
*) type
;
3631 BT_LOGD("Destroying enumeration field type object: addr=%p", type
);
3632 g_ptr_array_free(enumeration
->entries
, TRUE
);
3633 BT_LOGD_STR("Putting container field type.");
3634 bt_put(enumeration
->container
);
3635 g_free(enumeration
);
3639 void bt_field_type_floating_point_destroy(struct bt_field_type
*type
)
3641 struct bt_field_type_floating_point
*floating_point
=
3642 (struct bt_field_type_floating_point
*) type
;
3648 BT_LOGD("Destroying floating point number field type object: addr=%p", type
);
3649 g_free(floating_point
);
3653 void bt_field_type_structure_destroy(struct bt_field_type
*type
)
3655 struct bt_field_type_structure
*structure
=
3656 (struct bt_field_type_structure
*) type
;
3662 BT_LOGD("Destroying structure field type object: addr=%p", type
);
3663 g_ptr_array_free(structure
->fields
, TRUE
);
3664 g_hash_table_destroy(structure
->field_name_to_index
);
3669 void bt_field_type_variant_destroy(struct bt_field_type
*type
)
3671 struct bt_field_type_variant
*variant
=
3672 (struct bt_field_type_variant
*) type
;
3678 BT_LOGD("Destroying variant field type object: addr=%p", type
);
3679 g_ptr_array_free(variant
->fields
, TRUE
);
3680 g_hash_table_destroy(variant
->field_name_to_index
);
3681 g_string_free(variant
->tag_name
, TRUE
);
3682 BT_LOGD_STR("Putting tag field type.");
3683 bt_put(&variant
->tag
->parent
);
3684 BT_PUT(variant
->tag_field_path
);
3689 void bt_field_type_array_destroy(struct bt_field_type
*type
)
3691 struct bt_field_type_array
*array
=
3692 (struct bt_field_type_array
*) type
;
3698 BT_LOGD("Destroying array field type object: addr=%p", type
);
3699 BT_LOGD_STR("Putting element field type.");
3700 bt_put(array
->element_type
);
3705 void bt_field_type_sequence_destroy(struct bt_field_type
*type
)
3707 struct bt_field_type_sequence
*sequence
=
3708 (struct bt_field_type_sequence
*) type
;
3714 BT_LOGD("Destroying sequence field type object: addr=%p", type
);
3715 BT_LOGD_STR("Putting element field type.");
3716 bt_put(sequence
->element_type
);
3717 g_string_free(sequence
->length_field_name
, TRUE
);
3718 BT_LOGD_STR("Putting length field path.");
3719 BT_PUT(sequence
->length_field_path
);
3724 void bt_field_type_string_destroy(struct bt_field_type
*type
)
3726 struct bt_field_type_string
*string
=
3727 (struct bt_field_type_string
*) type
;
3733 BT_LOGD("Destroying string field type object: addr=%p", type
);
3738 void generic_field_type_freeze(struct bt_field_type
*type
)
3744 void bt_field_type_integer_freeze(struct bt_field_type
*type
)
3746 struct bt_field_type_integer
*integer_type
= container_of(
3747 type
, struct bt_field_type_integer
, parent
);
3749 BT_LOGD("Freezing integer field type object: addr=%p", type
);
3751 if (integer_type
->mapped_clock
) {
3752 BT_LOGD_STR("Freezing integer field type's mapped clock class.");
3753 bt_clock_class_freeze(integer_type
->mapped_clock
);
3756 generic_field_type_freeze(type
);
3760 void bt_field_type_enumeration_freeze(struct bt_field_type
*type
)
3762 struct bt_field_type_enumeration
*enumeration_type
= container_of(
3763 type
, struct bt_field_type_enumeration
, parent
);
3765 BT_LOGD("Freezing enumeration field type object: addr=%p", type
);
3766 type
->alignment
= bt_field_type_get_alignment(type
);
3767 set_enumeration_range_overlap(type
);
3768 generic_field_type_freeze(type
);
3769 BT_LOGD("Freezing enumeration field type object's container field type: int-ft-addr=%p",
3770 enumeration_type
->container
);
3771 bt_field_type_freeze(enumeration_type
->container
);
3775 void freeze_structure_field(struct structure_field
*field
)
3777 BT_LOGD("Freezing structure/variant field type field: field-addr=%p, "
3778 "field-ft-addr=%p, field-name=\"%s\"", field
,
3779 field
->type
, g_quark_to_string(field
->name
));
3780 bt_field_type_freeze(field
->type
);
3784 void bt_field_type_structure_freeze(struct bt_field_type
*type
)
3786 struct bt_field_type_structure
*structure_type
= container_of(
3787 type
, struct bt_field_type_structure
, parent
);
3789 /* Cache the alignment */
3790 BT_LOGD("Freezing structure field type object: addr=%p", type
);
3791 type
->alignment
= bt_field_type_get_alignment(type
);
3792 generic_field_type_freeze(type
);
3793 g_ptr_array_foreach(structure_type
->fields
,
3794 (GFunc
) freeze_structure_field
, NULL
);
3798 void bt_field_type_variant_freeze(struct bt_field_type
*type
)
3800 struct bt_field_type_variant
*variant_type
= container_of(
3801 type
, struct bt_field_type_variant
, parent
);
3803 BT_LOGD("Freezing variant field type object: addr=%p", type
);
3804 generic_field_type_freeze(type
);
3805 g_ptr_array_foreach(variant_type
->fields
,
3806 (GFunc
) freeze_structure_field
, NULL
);
3810 void bt_field_type_array_freeze(struct bt_field_type
*type
)
3812 struct bt_field_type_array
*array_type
= container_of(
3813 type
, struct bt_field_type_array
, parent
);
3815 /* Cache the alignment */
3816 BT_LOGD("Freezing array field type object: addr=%p", type
);
3817 type
->alignment
= bt_field_type_get_alignment(type
);
3818 generic_field_type_freeze(type
);
3819 BT_LOGD("Freezing array field type object's element field type: element-ft-addr=%p",
3820 array_type
->element_type
);
3821 bt_field_type_freeze(array_type
->element_type
);
3825 void bt_field_type_sequence_freeze(struct bt_field_type
*type
)
3827 struct bt_field_type_sequence
*sequence_type
= container_of(
3828 type
, struct bt_field_type_sequence
, parent
);
3830 /* Cache the alignment */
3831 BT_LOGD("Freezing sequence field type object: addr=%p", type
);
3832 type
->alignment
= bt_field_type_get_alignment(type
);
3833 generic_field_type_freeze(type
);
3834 BT_LOGD("Freezing sequence field type object's element field type: element-ft-addr=%p",
3835 sequence_type
->element_type
);
3836 bt_field_type_freeze(sequence_type
->element_type
);
3840 const char *get_encoding_string(enum bt_string_encoding encoding
)
3842 const char *encoding_string
;
3845 case BT_STRING_ENCODING_NONE
:
3846 encoding_string
= "none";
3848 case BT_STRING_ENCODING_ASCII
:
3849 encoding_string
= "ASCII";
3851 case BT_STRING_ENCODING_UTF8
:
3852 encoding_string
= "UTF8";
3855 encoding_string
= "unknown";
3859 return encoding_string
;
3863 const char *get_integer_base_string(enum bt_integer_base base
)
3865 const char *base_string
;
3868 case BT_INTEGER_BASE_DECIMAL
:
3869 case BT_INTEGER_BASE_UNSPECIFIED
:
3870 base_string
= "decimal";
3872 case BT_INTEGER_BASE_HEXADECIMAL
:
3873 base_string
= "hexadecimal";
3875 case BT_INTEGER_BASE_OCTAL
:
3876 base_string
= "octal";
3878 case BT_INTEGER_BASE_BINARY
:
3879 base_string
= "binary";
3882 base_string
= "unknown";
3890 void append_field_name(struct metadata_context
*context
,
3893 g_string_append_c(context
->string
, ' ');
3895 if (!bt_identifier_is_valid(name
) || *name
== '_') {
3896 g_string_append_c(context
->string
, '_');
3899 g_string_append(context
->string
, name
);
3903 int bt_field_type_integer_serialize(struct bt_field_type
*type
,
3904 struct metadata_context
*context
)
3906 struct bt_field_type_integer
*integer
= container_of(type
,
3907 struct bt_field_type_integer
, parent
);
3910 BT_LOGD("Serializing integer field type's metadata: "
3911 "ft-addr=%p, metadata-context-addr=%p", type
, context
);
3912 g_string_append_printf(context
->string
,
3913 "integer { size = %u; align = %u; signed = %s; encoding = %s; base = %s; byte_order = %s",
3914 integer
->size
, type
->alignment
,
3915 (integer
->is_signed
? "true" : "false"),
3916 get_encoding_string(integer
->encoding
),
3917 get_integer_base_string(integer
->base
),
3918 get_byte_order_string(integer
->user_byte_order
));
3919 if (integer
->mapped_clock
) {
3920 const char *clock_name
= bt_clock_class_get_name(
3921 integer
->mapped_clock
);
3924 g_string_append_printf(context
->string
,
3925 "; map = clock.%s.value", clock_name
);
3928 g_string_append(context
->string
, "; }");
3933 int bt_field_type_enumeration_serialize(struct bt_field_type
*type
,
3934 struct metadata_context
*context
)
3938 struct bt_field_type_enumeration
*enumeration
= container_of(type
,
3939 struct bt_field_type_enumeration
, parent
);
3940 struct bt_field_type
*container_type
;
3941 int container_signed
;
3943 BT_LOGD("Serializing enumeration field type's metadata: "
3944 "ft-addr=%p, metadata-context-addr=%p", type
, context
);
3945 container_type
= bt_field_type_enumeration_get_container_type(type
);
3946 assert(container_type
);
3947 container_signed
= bt_ctf_field_type_integer_get_signed(container_type
);
3948 assert(container_signed
>= 0);
3949 g_string_append(context
->string
, "enum : ");
3950 BT_LOGD_STR("Serializing enumeration field type's container field type's metadata.");
3951 ret
= bt_field_type_serialize(enumeration
->container
, context
);
3953 BT_LOGW("Cannot serialize enumeration field type's container field type's metadata: "
3954 "container-ft-addr=%p", enumeration
->container
);
3958 g_string_append(context
->string
, " { ");
3959 for (entry
= 0; entry
< enumeration
->entries
->len
; entry
++) {
3960 struct enumeration_mapping
*mapping
=
3961 enumeration
->entries
->pdata
[entry
];
3962 const char *label
= g_quark_to_string(mapping
->string
);
3964 g_string_append(context
->string
, "\"");
3966 if (!bt_identifier_is_valid(label
) || label
[0] == '_') {
3967 g_string_append(context
->string
, "_");
3970 g_string_append_printf(context
->string
, "%s\" = ", label
);
3972 if (container_signed
) {
3973 if (mapping
->range_start
._signed
==
3974 mapping
->range_end
._signed
) {
3975 g_string_append_printf(context
->string
,
3977 mapping
->range_start
._signed
);
3979 g_string_append_printf(context
->string
,
3980 "%" PRId64
" ... %" PRId64
,
3981 mapping
->range_start
._signed
,
3982 mapping
->range_end
._signed
);
3985 if (mapping
->range_start
._unsigned
==
3986 mapping
->range_end
._unsigned
) {
3987 g_string_append_printf(context
->string
,
3989 mapping
->range_start
._unsigned
);
3991 g_string_append_printf(context
->string
,
3992 "%" PRIu64
" ... %" PRIu64
,
3993 mapping
->range_start
._unsigned
,
3994 mapping
->range_end
._unsigned
);
3998 g_string_append(context
->string
,
3999 ((entry
!= (enumeration
->entries
->len
- 1)) ?
4003 if (context
->field_name
->len
) {
4004 append_field_name(context
,
4005 context
->field_name
->str
);
4006 g_string_assign(context
->field_name
, "");
4009 bt_put(container_type
);
4014 int bt_field_type_floating_point_serialize(struct bt_field_type
*type
,
4015 struct metadata_context
*context
)
4017 struct bt_field_type_floating_point
*floating_point
= container_of(
4018 type
, struct bt_field_type_floating_point
, parent
);
4020 BT_LOGD("Serializing floating point number field type's metadata: "
4021 "ft-addr=%p, metadata-context-addr=%p", type
, context
);
4022 g_string_append_printf(context
->string
,
4023 "floating_point { exp_dig = %u; mant_dig = %u; byte_order = %s; align = %u; }",
4024 floating_point
->exp_dig
,
4025 floating_point
->mant_dig
,
4026 get_byte_order_string(floating_point
->user_byte_order
),
4032 int bt_field_type_structure_serialize(struct bt_field_type
*type
,
4033 struct metadata_context
*context
)
4036 unsigned int indent
;
4038 struct bt_field_type_structure
*structure
= container_of(type
,
4039 struct bt_field_type_structure
, parent
);
4040 GString
*structure_field_name
= context
->field_name
;
4042 BT_LOGD("Serializing structure field type's metadata: "
4043 "ft-addr=%p, metadata-context-addr=%p", type
, context
);
4044 context
->field_name
= g_string_new("");
4046 context
->current_indentation_level
++;
4047 g_string_append(context
->string
, "struct {\n");
4049 for (i
= 0; i
< structure
->fields
->len
; i
++) {
4050 struct structure_field
*field
= structure
->fields
->pdata
[i
];
4052 BT_LOGD("Serializing structure field type's field metadata: "
4054 "field-ft-addr=%p, field-name=\"%s\"",
4055 i
, field
, g_quark_to_string(field
->name
));
4057 for (indent
= 0; indent
< context
->current_indentation_level
;
4059 g_string_append_c(context
->string
, '\t');
4062 g_string_assign(context
->field_name
,
4063 g_quark_to_string(field
->name
));
4064 ret
= bt_field_type_serialize(field
->type
, context
);
4066 BT_LOGW("Cannot serialize structure field type's field's metadata: "
4068 "field-ft-addr=%p, field-name=\"%s\"",
4070 g_quark_to_string(field
->name
));
4074 if (context
->field_name
->len
) {
4075 append_field_name(context
,
4076 context
->field_name
->str
);
4078 g_string_append(context
->string
, ";\n");
4081 context
->current_indentation_level
--;
4082 for (indent
= 0; indent
< context
->current_indentation_level
;
4084 g_string_append_c(context
->string
, '\t');
4087 g_string_append_printf(context
->string
, "} align(%u)",
4090 g_string_free(context
->field_name
, TRUE
);
4091 context
->field_name
= structure_field_name
;
4096 int bt_field_type_variant_serialize(struct bt_field_type
*type
,
4097 struct metadata_context
*context
)
4100 unsigned int indent
;
4102 struct bt_field_type_variant
*variant
= container_of(
4103 type
, struct bt_field_type_variant
, parent
);
4104 GString
*variant_field_name
= context
->field_name
;
4106 BT_LOGD("Serializing variant field type's metadata: "
4107 "ft-addr=%p, metadata-context-addr=%p", type
, context
);
4108 context
->field_name
= g_string_new("");
4109 if (variant
->tag_name
->len
> 0) {
4110 g_string_append(context
->string
, "variant <");
4111 append_field_name(context
, variant
->tag_name
->str
);
4112 g_string_append(context
->string
, "> {\n");
4114 g_string_append(context
->string
, "variant {\n");
4117 context
->current_indentation_level
++;
4118 for (i
= 0; i
< variant
->fields
->len
; i
++) {
4119 struct structure_field
*field
= variant
->fields
->pdata
[i
];
4121 BT_LOGD("Serializing variant field type's field metadata: "
4123 "field-ft-addr=%p, field-name=\"%s\"",
4124 i
, field
, g_quark_to_string(field
->name
));
4126 g_string_assign(context
->field_name
,
4127 g_quark_to_string(field
->name
));
4128 for (indent
= 0; indent
< context
->current_indentation_level
;
4130 g_string_append_c(context
->string
, '\t');
4133 g_string_assign(context
->field_name
,
4134 g_quark_to_string(field
->name
));
4135 ret
= bt_field_type_serialize(field
->type
, context
);
4137 BT_LOGW("Cannot serialize variant field type's field's metadata: "
4139 "field-ft-addr=%p, field-name=\"%s\"",
4141 g_quark_to_string(field
->name
));
4145 if (context
->field_name
->len
) {
4146 append_field_name(context
,
4147 context
->field_name
->str
);
4148 g_string_append_c(context
->string
, ';');
4151 g_string_append_c(context
->string
, '\n');
4154 context
->current_indentation_level
--;
4155 for (indent
= 0; indent
< context
->current_indentation_level
;
4157 g_string_append_c(context
->string
, '\t');
4160 g_string_append(context
->string
, "}");
4162 g_string_free(context
->field_name
, TRUE
);
4163 context
->field_name
= variant_field_name
;
4168 int bt_field_type_array_serialize(struct bt_field_type
*type
,
4169 struct metadata_context
*context
)
4172 struct bt_field_type_array
*array
= container_of(type
,
4173 struct bt_field_type_array
, parent
);
4175 BT_LOGD("Serializing array field type's metadata: "
4176 "ft-addr=%p, metadata-context-addr=%p", type
, context
);
4177 BT_LOGD_STR("Serializing array field type's element field type's metadata.");
4178 ret
= bt_field_type_serialize(array
->element_type
, context
);
4180 BT_LOGW("Cannot serialize array field type's element field type's metadata: "
4181 "element-ft-addr=%p", array
->element_type
);
4185 if (context
->field_name
->len
) {
4186 append_field_name(context
,
4187 context
->field_name
->str
);
4189 g_string_append_printf(context
->string
, "[%u]", array
->length
);
4190 g_string_assign(context
->field_name
, "");
4192 g_string_append_printf(context
->string
, "[%u]", array
->length
);
4199 int bt_field_type_sequence_serialize(struct bt_field_type
*type
,
4200 struct metadata_context
*context
)
4203 struct bt_field_type_sequence
*sequence
= container_of(
4204 type
, struct bt_field_type_sequence
, parent
);
4206 BT_LOGD("Serializing sequence field type's metadata: "
4207 "ft-addr=%p, metadata-context-addr=%p", type
, context
);
4208 BT_LOGD_STR("Serializing sequence field type's element field type's metadata.");
4209 ret
= bt_field_type_serialize(sequence
->element_type
, context
);
4211 BT_LOGW("Cannot serialize sequence field type's element field type's metadata: "
4212 "element-ft-addr=%p", sequence
->element_type
);
4216 if (context
->field_name
->len
) {
4217 append_field_name(context
, context
->field_name
->str
);
4218 g_string_assign(context
->field_name
, "");
4220 g_string_append(context
->string
, "[");
4221 append_field_name(context
, sequence
->length_field_name
->str
);
4222 g_string_append(context
->string
, "]");
4228 int bt_field_type_string_serialize(struct bt_field_type
*type
,
4229 struct metadata_context
*context
)
4231 struct bt_field_type_string
*string
= container_of(
4232 type
, struct bt_field_type_string
, parent
);
4234 BT_LOGD("Serializing string field type's metadata: "
4235 "ft-addr=%p, metadata-context-addr=%p", type
, context
);
4236 g_string_append_printf(context
->string
,
4237 "string { encoding = %s; }",
4238 get_encoding_string(string
->encoding
));
4243 void bt_field_type_integer_set_byte_order(struct bt_field_type
*type
,
4244 enum bt_byte_order byte_order
)
4246 struct bt_field_type_integer
*integer_type
= container_of(type
,
4247 struct bt_field_type_integer
, parent
);
4249 integer_type
->user_byte_order
= byte_order
;
4253 void bt_field_type_enumeration_set_byte_order(
4254 struct bt_field_type
*type
, enum bt_byte_order byte_order
)
4256 struct bt_field_type_enumeration
*enum_type
= container_of(type
,
4257 struct bt_field_type_enumeration
, parent
);
4259 /* Safe to assume that container is an integer */
4260 bt_field_type_integer_set_byte_order(enum_type
->container
,
4265 void bt_field_type_floating_point_set_byte_order(
4266 struct bt_field_type
*type
, enum bt_byte_order byte_order
)
4268 struct bt_field_type_floating_point
*floating_point_type
=
4269 container_of(type
, struct bt_field_type_floating_point
,
4272 floating_point_type
->user_byte_order
= byte_order
;
4276 void bt_field_type_structure_set_byte_order(struct bt_field_type
*type
,
4277 enum bt_byte_order byte_order
)
4280 struct bt_field_type_structure
*structure_type
=
4281 container_of(type
, struct bt_field_type_structure
,
4284 for (i
= 0; i
< structure_type
->fields
->len
; i
++) {
4285 struct structure_field
*field
= g_ptr_array_index(
4286 structure_type
->fields
, i
);
4287 struct bt_field_type
*field_type
= field
->type
;
4289 if (set_byte_order_funcs
[field_type
->id
]) {
4290 set_byte_order_funcs
[field_type
->id
](
4291 field_type
, byte_order
);
4297 void bt_field_type_variant_set_byte_order(struct bt_field_type
*type
,
4298 enum bt_byte_order byte_order
)
4301 struct bt_field_type_variant
*variant_type
=
4302 container_of(type
, struct bt_field_type_variant
,
4305 for (i
= 0; i
< variant_type
->fields
->len
; i
++) {
4306 struct structure_field
*field
= g_ptr_array_index(
4307 variant_type
->fields
, i
);
4308 struct bt_field_type
*field_type
= field
->type
;
4310 if (set_byte_order_funcs
[field_type
->id
]) {
4311 set_byte_order_funcs
[field_type
->id
](
4312 field_type
, byte_order
);
4318 void bt_field_type_array_set_byte_order(struct bt_field_type
*type
,
4319 enum bt_byte_order byte_order
)
4321 struct bt_field_type_array
*array_type
=
4322 container_of(type
, struct bt_field_type_array
,
4325 if (set_byte_order_funcs
[array_type
->element_type
->id
]) {
4326 set_byte_order_funcs
[array_type
->element_type
->id
](
4327 array_type
->element_type
, byte_order
);
4332 void bt_field_type_sequence_set_byte_order(struct bt_field_type
*type
,
4333 enum bt_byte_order byte_order
)
4335 struct bt_field_type_sequence
*sequence_type
=
4336 container_of(type
, struct bt_field_type_sequence
,
4339 if (set_byte_order_funcs
[
4340 sequence_type
->element_type
->id
]) {
4341 set_byte_order_funcs
[
4342 sequence_type
->element_type
->id
](
4343 sequence_type
->element_type
, byte_order
);
4348 struct bt_field_type
*bt_field_type_integer_copy(
4349 struct bt_field_type
*type
)
4351 struct bt_field_type
*copy
;
4352 struct bt_field_type_integer
*integer
, *copy_integer
;
4354 BT_LOGD("Copying integer field type's: addr=%p", type
);
4355 integer
= container_of(type
, struct bt_field_type_integer
, parent
);
4356 copy
= bt_field_type_integer_create(integer
->size
);
4358 BT_LOGE_STR("Cannot create integer field type.");
4362 copy_integer
= container_of(copy
, struct bt_field_type_integer
,
4364 copy_integer
->mapped_clock
= bt_get(integer
->mapped_clock
);
4365 copy_integer
->user_byte_order
= integer
->user_byte_order
;
4366 copy_integer
->is_signed
= integer
->is_signed
;
4367 copy_integer
->size
= integer
->size
;
4368 copy_integer
->base
= integer
->base
;
4369 copy_integer
->encoding
= integer
->encoding
;
4370 BT_LOGD("Copied integer field type: original-ft-addr=%p, copy-ft-addr=%p",
4378 struct bt_field_type
*bt_field_type_enumeration_copy(
4379 struct bt_field_type
*type
)
4382 struct bt_field_type
*copy
= NULL
, *copy_container
;
4383 struct bt_field_type_enumeration
*enumeration
, *copy_enumeration
;
4385 BT_LOGD("Copying enumeration field type's: addr=%p", type
);
4386 enumeration
= container_of(type
, struct bt_field_type_enumeration
,
4389 /* Copy the source enumeration's container */
4390 BT_LOGD_STR("Copying enumeration field type's container field type.");
4391 copy_container
= bt_field_type_copy(enumeration
->container
);
4392 if (!copy_container
) {
4393 BT_LOGE_STR("Cannot copy enumeration field type's container field type.");
4397 copy
= bt_field_type_enumeration_create(copy_container
);
4399 BT_LOGE_STR("Cannot create enumeration field type.");
4402 copy_enumeration
= container_of(copy
,
4403 struct bt_field_type_enumeration
, parent
);
4405 /* Copy all enumaration entries */
4406 for (i
= 0; i
< enumeration
->entries
->len
; i
++) {
4407 struct enumeration_mapping
*mapping
= g_ptr_array_index(
4408 enumeration
->entries
, i
);
4409 struct enumeration_mapping
*copy_mapping
= g_new0(
4410 struct enumeration_mapping
, 1);
4412 if (!copy_mapping
) {
4413 BT_LOGE_STR("Failed to allocate one enumeration mapping.");
4417 *copy_mapping
= *mapping
;
4418 g_ptr_array_add(copy_enumeration
->entries
, copy_mapping
);
4421 BT_LOGD("Copied enumeration field type: original-ft-addr=%p, copy-ft-addr=%p",
4425 bt_put(copy_container
);
4428 bt_put(copy_container
);
4434 struct bt_field_type
*bt_field_type_floating_point_copy(
4435 struct bt_field_type
*type
)
4437 struct bt_field_type
*copy
;
4438 struct bt_field_type_floating_point
*floating_point
, *copy_float
;
4440 BT_LOGD("Copying floating point number field type's: addr=%p", type
);
4441 floating_point
= container_of(type
,
4442 struct bt_field_type_floating_point
, parent
);
4443 copy
= bt_field_type_floating_point_create();
4445 BT_LOGE_STR("Cannot create floating point number field type.");
4449 copy_float
= container_of(copy
,
4450 struct bt_field_type_floating_point
, parent
);
4451 copy_float
->user_byte_order
= floating_point
->user_byte_order
;
4452 copy_float
->exp_dig
= floating_point
->exp_dig
;
4453 copy_float
->mant_dig
= floating_point
->mant_dig
;
4454 BT_LOGD("Copied floating point number field type: original-ft-addr=%p, copy-ft-addr=%p",
4461 struct bt_field_type
*bt_field_type_structure_copy(
4462 struct bt_field_type
*type
)
4465 GHashTableIter iter
;
4466 gpointer key
, value
;
4467 struct bt_field_type
*copy
;
4468 struct bt_field_type_structure
*structure
, *copy_structure
;
4470 BT_LOGD("Copying structure field type's: addr=%p", type
);
4471 structure
= container_of(type
, struct bt_field_type_structure
,
4473 copy
= bt_field_type_structure_create();
4475 BT_LOGE_STR("Cannot create structure field type.");
4479 copy_structure
= container_of(copy
,
4480 struct bt_field_type_structure
, parent
);
4482 /* Copy field_name_to_index */
4483 g_hash_table_iter_init(&iter
, structure
->field_name_to_index
);
4484 while (g_hash_table_iter_next (&iter
, &key
, &value
)) {
4485 g_hash_table_insert(copy_structure
->field_name_to_index
,
4489 for (i
= 0; i
< structure
->fields
->len
; i
++) {
4490 struct structure_field
*entry
, *copy_entry
;
4491 struct bt_field_type
*copy_field
;
4493 entry
= g_ptr_array_index(structure
->fields
, i
);
4494 BT_LOGD("Copying structure field type's field: "
4495 "index=%" PRId64
", "
4496 "field-ft-addr=%p, field-name=\"%s\"",
4497 i
, entry
, g_quark_to_string(entry
->name
));
4498 copy_entry
= g_new0(struct structure_field
, 1);
4500 BT_LOGE_STR("Failed to allocate one structure field type field.");
4504 copy_field
= bt_field_type_copy(entry
->type
);
4506 BT_LOGE("Cannot copy structure field type's field: "
4507 "index=%" PRId64
", "
4508 "field-ft-addr=%p, field-name=\"%s\"",
4509 i
, entry
, g_quark_to_string(entry
->name
));
4514 copy_entry
->name
= entry
->name
;
4515 copy_entry
->type
= copy_field
;
4516 g_ptr_array_add(copy_structure
->fields
, copy_entry
);
4519 BT_LOGD("Copied structure field type: original-ft-addr=%p, copy-ft-addr=%p",
4530 struct bt_field_type
*bt_field_type_variant_copy(
4531 struct bt_field_type
*type
)
4534 GHashTableIter iter
;
4535 gpointer key
, value
;
4536 struct bt_field_type
*copy
= NULL
, *copy_tag
= NULL
;
4537 struct bt_field_type_variant
*variant
, *copy_variant
;
4539 BT_LOGD("Copying variant field type's: addr=%p", type
);
4540 variant
= container_of(type
, struct bt_field_type_variant
,
4543 BT_LOGD_STR("Copying variant field type's tag field type.");
4544 copy_tag
= bt_field_type_copy(&variant
->tag
->parent
);
4546 BT_LOGE_STR("Cannot copy variant field type's tag field type.");
4551 copy
= bt_field_type_variant_create(copy_tag
,
4552 variant
->tag_name
->len
? variant
->tag_name
->str
: NULL
);
4554 BT_LOGE_STR("Cannot create variant field type.");
4558 copy_variant
= container_of(copy
, struct bt_field_type_variant
,
4561 /* Copy field_name_to_index */
4562 g_hash_table_iter_init(&iter
, variant
->field_name_to_index
);
4563 while (g_hash_table_iter_next (&iter
, &key
, &value
)) {
4564 g_hash_table_insert(copy_variant
->field_name_to_index
,
4568 for (i
= 0; i
< variant
->fields
->len
; i
++) {
4569 struct structure_field
*entry
, *copy_entry
;
4570 struct bt_field_type
*copy_field
;
4572 entry
= g_ptr_array_index(variant
->fields
, i
);
4573 BT_LOGD("Copying variant field type's field: "
4574 "index=%" PRId64
", "
4575 "field-ft-addr=%p, field-name=\"%s\"",
4576 i
, entry
, g_quark_to_string(entry
->name
));
4577 copy_entry
= g_new0(struct structure_field
, 1);
4579 BT_LOGE_STR("Failed to allocate one variant field type field.");
4583 copy_field
= bt_field_type_copy(entry
->type
);
4585 BT_LOGE("Cannot copy variant field type's field: "
4586 "index=%" PRId64
", "
4587 "field-ft-addr=%p, field-name=\"%s\"",
4588 i
, entry
, g_quark_to_string(entry
->name
));
4593 copy_entry
->name
= entry
->name
;
4594 copy_entry
->type
= copy_field
;
4595 g_ptr_array_add(copy_variant
->fields
, copy_entry
);
4598 if (variant
->tag_field_path
) {
4599 BT_LOGD_STR("Copying variant field type's tag field path.");
4600 copy_variant
->tag_field_path
= bt_field_path_copy(
4601 variant
->tag_field_path
);
4602 if (!copy_variant
->tag_field_path
) {
4603 BT_LOGE_STR("Cannot copy variant field type's tag field path.");
4608 BT_LOGD("Copied variant field type: original-ft-addr=%p, copy-ft-addr=%p",
4621 struct bt_field_type
*bt_field_type_array_copy(
4622 struct bt_field_type
*type
)
4624 struct bt_field_type
*copy
= NULL
, *copy_element
;
4625 struct bt_field_type_array
*array
;
4627 BT_LOGD("Copying array field type's: addr=%p", type
);
4628 array
= container_of(type
, struct bt_field_type_array
,
4630 BT_LOGD_STR("Copying array field type's element field type.");
4631 copy_element
= bt_field_type_copy(array
->element_type
);
4632 if (!copy_element
) {
4633 BT_LOGE_STR("Cannot copy array field type's element field type.");
4637 copy
= bt_field_type_array_create(copy_element
, array
->length
);
4639 BT_LOGE_STR("Cannot create array field type.");
4643 BT_LOGD("Copied array field type: original-ft-addr=%p, copy-ft-addr=%p",
4647 bt_put(copy_element
);
4652 struct bt_field_type
*bt_field_type_sequence_copy(
4653 struct bt_field_type
*type
)
4655 struct bt_field_type
*copy
= NULL
, *copy_element
;
4656 struct bt_field_type_sequence
*sequence
, *copy_sequence
;
4658 BT_LOGD("Copying sequence field type's: addr=%p", type
);
4659 sequence
= container_of(type
, struct bt_field_type_sequence
,
4661 BT_LOGD_STR("Copying sequence field type's element field type.");
4662 copy_element
= bt_field_type_copy(sequence
->element_type
);
4663 if (!copy_element
) {
4664 BT_LOGE_STR("Cannot copy sequence field type's element field type.");
4668 copy
= bt_field_type_sequence_create(copy_element
,
4669 sequence
->length_field_name
->len
?
4670 sequence
->length_field_name
->str
: NULL
);
4672 BT_LOGE_STR("Cannot create sequence field type.");
4676 copy_sequence
= container_of(copy
, struct bt_field_type_sequence
,
4678 if (sequence
->length_field_path
) {
4679 BT_LOGD_STR("Copying sequence field type's length field path.");
4680 copy_sequence
->length_field_path
= bt_field_path_copy(
4681 sequence
->length_field_path
);
4682 if (!copy_sequence
->length_field_path
) {
4683 BT_LOGE_STR("Cannot copy sequence field type's length field path.");
4688 BT_LOGD("Copied sequence field type: original-ft-addr=%p, copy-ft-addr=%p",
4692 bt_put(copy_element
);
4700 struct bt_field_type
*bt_field_type_string_copy(
4701 struct bt_field_type
*type
)
4703 struct bt_field_type
*copy
;
4705 BT_LOGD("Copying string field type's: addr=%p", type
);
4706 copy
= bt_field_type_string_create();
4708 BT_LOGE_STR("Cannot create string field type.");
4712 BT_LOGD("Copied string field type: original-ft-addr=%p, copy-ft-addr=%p",
4719 int bt_field_type_integer_compare(struct bt_field_type
*type_a
,
4720 struct bt_field_type
*type_b
)
4723 struct bt_field_type_integer
*int_type_a
;
4724 struct bt_field_type_integer
*int_type_b
;
4726 int_type_a
= container_of(type_a
, struct bt_field_type_integer
,
4728 int_type_b
= container_of(type_b
, struct bt_field_type_integer
,
4732 if (int_type_a
->size
!= int_type_b
->size
) {
4733 BT_LOGV("Integer field types differ: different sizes: "
4734 "ft-a-size=%u, ft-b-size=%u",
4735 int_type_a
->size
, int_type_b
->size
);
4740 if (int_type_a
->user_byte_order
!= int_type_b
->user_byte_order
) {
4741 BT_LOGV("Integer field types differ: different byte orders: "
4742 "ft-a-bo=%s, ft-b-bo=%s",
4743 bt_byte_order_string(int_type_a
->user_byte_order
),
4744 bt_byte_order_string(int_type_b
->user_byte_order
));
4749 if (int_type_a
->is_signed
!= int_type_b
->is_signed
) {
4750 BT_LOGV("Integer field types differ: different signedness: "
4751 "ft-a-is-signed=%d, ft-b-is-signed=%d",
4752 int_type_a
->is_signed
,
4753 int_type_b
->is_signed
);
4758 if (int_type_a
->base
!= int_type_b
->base
) {
4759 BT_LOGV("Integer field types differ: different bases: "
4760 "ft-a-base=%s, ft-b-base=%s",
4761 bt_integer_base_string(int_type_a
->base
),
4762 bt_integer_base_string(int_type_b
->base
));
4767 if (int_type_a
->encoding
!= int_type_b
->encoding
) {
4768 BT_LOGV("Integer field types differ: different encodings: "
4769 "ft-a-encoding=%s, ft-b-encoding=%s",
4770 bt_string_encoding_string(int_type_a
->encoding
),
4771 bt_string_encoding_string(int_type_b
->encoding
));
4775 /* Mapped clock class */
4776 if (int_type_a
->mapped_clock
) {
4777 if (!int_type_b
->mapped_clock
) {
4778 BT_LOGV_STR("Integer field types differ: field type A "
4779 "has a mapped clock class, but field type B "
4784 if (bt_clock_class_compare(int_type_a
->mapped_clock
,
4785 int_type_b
->mapped_clock
) != 0) {
4786 BT_LOGV_STR("Integer field types differ: different "
4787 "mapped clock classes.");
4790 if (int_type_b
->mapped_clock
) {
4791 BT_LOGV_STR("Integer field types differ: field type A "
4792 "has no description, but field type B has one.");
4805 int bt_field_type_floating_point_compare(struct bt_field_type
*type_a
,
4806 struct bt_field_type
*type_b
)
4809 struct bt_field_type_floating_point
*float_a
;
4810 struct bt_field_type_floating_point
*float_b
;
4812 float_a
= container_of(type_a
,
4813 struct bt_field_type_floating_point
, parent
);
4814 float_b
= container_of(type_b
,
4815 struct bt_field_type_floating_point
, parent
);
4818 if (float_a
->user_byte_order
!= float_b
->user_byte_order
) {
4819 BT_LOGV("Floating point number field types differ: different byte orders: "
4820 "ft-a-bo=%s, ft-b-bo=%s",
4821 bt_byte_order_string(float_a
->user_byte_order
),
4822 bt_byte_order_string(float_b
->user_byte_order
));
4826 /* Exponent length */
4827 if (float_a
->exp_dig
!= float_b
->exp_dig
) {
4828 BT_LOGV("Floating point number field types differ: different exponent sizes: "
4829 "ft-a-exp-size=%u, ft-b-exp-size=%u",
4830 float_a
->exp_dig
, float_b
->exp_dig
);
4834 /* Mantissa length */
4835 if (float_a
->mant_dig
!= float_b
->mant_dig
) {
4836 BT_LOGV("Floating point number field types differ: different mantissa sizes: "
4837 "ft-a-mant-size=%u, ft-b-mant-size=%u",
4838 float_a
->mant_dig
, float_b
->mant_dig
);
4850 int compare_enumeration_mappings(struct enumeration_mapping
*mapping_a
,
4851 struct enumeration_mapping
*mapping_b
)
4856 if (mapping_a
->string
!= mapping_b
->string
) {
4857 BT_LOGV("Enumeration field type mappings differ: different names: "
4858 "mapping-a-name=\"%s\", mapping-b-name=\"%s\"",
4859 g_quark_to_string(mapping_a
->string
),
4860 g_quark_to_string(mapping_b
->string
));
4865 if (mapping_a
->range_start
._unsigned
!=
4866 mapping_b
->range_start
._unsigned
) {
4867 BT_LOGV("Enumeration field type mappings differ: different starts of range: "
4868 "mapping-a-range-start-unsigned=%" PRIu64
", "
4869 "mapping-b-range-start-unsigned=%" PRIu64
,
4870 mapping_a
->range_start
._unsigned
,
4871 mapping_b
->range_start
._unsigned
);
4876 if (mapping_a
->range_end
._unsigned
!=
4877 mapping_b
->range_end
._unsigned
) {
4878 BT_LOGV("Enumeration field type mappings differ: different ends of range: "
4879 "mapping-a-range-end-unsigned=%" PRIu64
", "
4880 "mapping-b-range-end-unsigned=%" PRIu64
,
4881 mapping_a
->range_end
._unsigned
,
4882 mapping_b
->range_end
._unsigned
);
4894 int bt_field_type_enumeration_compare(struct bt_field_type
*type_a
,
4895 struct bt_field_type
*type_b
)
4899 struct bt_field_type_enumeration
*enum_a
;
4900 struct bt_field_type_enumeration
*enum_b
;
4902 enum_a
= container_of(type_a
,
4903 struct bt_field_type_enumeration
, parent
);
4904 enum_b
= container_of(type_b
,
4905 struct bt_field_type_enumeration
, parent
);
4907 /* Container field type */
4908 ret
= bt_field_type_compare(enum_a
->container
, enum_b
->container
);
4910 BT_LOGV("Enumeration field types differ: different container field types: "
4911 "ft-a-container-ft-addr=%p, ft-b-container-ft-addr=%p",
4912 enum_a
->container
, enum_b
->container
);
4919 if (enum_a
->entries
->len
!= enum_b
->entries
->len
) {
4923 for (i
= 0; i
< enum_a
->entries
->len
; ++i
) {
4924 struct enumeration_mapping
*mapping_a
=
4925 g_ptr_array_index(enum_a
->entries
, i
);
4926 struct enumeration_mapping
*mapping_b
=
4927 g_ptr_array_index(enum_b
->entries
, i
);
4929 if (compare_enumeration_mappings(mapping_a
, mapping_b
)) {
4930 BT_LOGV("Enumeration field types differ: different mappings: "
4931 "ft-a-mapping-addr=%p, ft-b-mapping-addr=%p, "
4932 "ft-a-mapping-name=\"%s\", ft-b-mapping-name=\"%s\"",
4933 mapping_a
, mapping_b
,
4934 g_quark_to_string(mapping_a
->string
),
4935 g_quark_to_string(mapping_b
->string
));
4948 int bt_field_type_string_compare(struct bt_field_type
*type_a
,
4949 struct bt_field_type
*type_b
)
4952 struct bt_field_type_string
*string_a
;
4953 struct bt_field_type_string
*string_b
;
4955 string_a
= container_of(type_a
,
4956 struct bt_field_type_string
, parent
);
4957 string_b
= container_of(type_b
,
4958 struct bt_field_type_string
, parent
);
4961 if (string_a
->encoding
!= string_b
->encoding
) {
4962 BT_LOGV("String field types differ: different encodings: "
4963 "ft-a-encoding=%s, ft-b-encoding=%s",
4964 bt_string_encoding_string(string_a
->encoding
),
4965 bt_string_encoding_string(string_b
->encoding
));
4977 int compare_structure_fields(struct structure_field
*field_a
,
4978 struct structure_field
*field_b
)
4983 if (field_a
->name
!= field_b
->name
) {
4984 BT_LOGV("Structure/variant field type fields differ: different names: "
4985 "field-a-name=%s, field-b-name=%s",
4986 g_quark_to_string(field_a
->name
),
4987 g_quark_to_string(field_b
->name
));
4992 ret
= bt_field_type_compare(field_a
->type
, field_b
->type
);
4994 BT_LOGV("Structure/variant field type fields differ: different field types: "
4995 "field-name=\"%s\", field-a-ft-addr=%p, field-b-ft-addr=%p",
4996 g_quark_to_string(field_a
->name
),
4997 field_a
->type
, field_b
->type
);
5005 int bt_field_type_structure_compare(struct bt_field_type
*type_a
,
5006 struct bt_field_type
*type_b
)
5010 struct bt_field_type_structure
*struct_a
;
5011 struct bt_field_type_structure
*struct_b
;
5013 struct_a
= container_of(type_a
,
5014 struct bt_field_type_structure
, parent
);
5015 struct_b
= container_of(type_b
,
5016 struct bt_field_type_structure
, parent
);
5019 if (bt_field_type_get_alignment(type_a
) !=
5020 bt_field_type_get_alignment(type_b
)) {
5021 BT_LOGV("Structure field types differ: different alignments: "
5022 "ft-a-align=%u, ft-b-align=%u",
5023 bt_field_type_get_alignment(type_a
),
5024 bt_field_type_get_alignment(type_b
));
5029 if (struct_a
->fields
->len
!= struct_b
->fields
->len
) {
5030 BT_LOGV("Structure field types differ: different field counts: "
5031 "ft-a-field-count=%u, ft-b-field-count=%u",
5032 struct_a
->fields
->len
, struct_b
->fields
->len
);
5036 for (i
= 0; i
< struct_a
->fields
->len
; ++i
) {
5037 struct structure_field
*field_a
=
5038 g_ptr_array_index(struct_a
->fields
, i
);
5039 struct structure_field
*field_b
=
5040 g_ptr_array_index(struct_b
->fields
, i
);
5042 ret
= compare_structure_fields(field_a
, field_b
);
5044 /* compare_structure_fields() logs what differs */
5045 BT_LOGV_STR("Structure field types differ: different fields.");
5058 int bt_field_type_variant_compare(struct bt_field_type
*type_a
,
5059 struct bt_field_type
*type_b
)
5063 struct bt_field_type_variant
*variant_a
;
5064 struct bt_field_type_variant
*variant_b
;
5066 variant_a
= container_of(type_a
,
5067 struct bt_field_type_variant
, parent
);
5068 variant_b
= container_of(type_b
,
5069 struct bt_field_type_variant
, parent
);
5072 if (strcmp(variant_a
->tag_name
->str
, variant_b
->tag_name
->str
)) {
5073 BT_LOGV("Variant field types differ: different tag field names: "
5074 "ft-a-tag-field-name=\"%s\", ft-b-tag-field-name=\"%s\"",
5075 variant_a
->tag_name
->str
, variant_b
->tag_name
->str
);
5080 ret
= bt_field_type_compare(
5081 (struct bt_field_type
*) variant_a
->tag
,
5082 (struct bt_field_type
*) variant_b
->tag
);
5084 BT_LOGV("Variant field types differ: different tag field types: "
5085 "ft-a-tag-ft-addr=%p, ft-b-tag-ft-addr=%p",
5086 variant_a
->tag
, variant_b
->tag
);
5093 if (variant_a
->fields
->len
!= variant_b
->fields
->len
) {
5094 BT_LOGV("Structure field types differ: different field counts: "
5095 "ft-a-field-count=%u, ft-b-field-count=%u",
5096 variant_a
->fields
->len
, variant_b
->fields
->len
);
5100 for (i
= 0; i
< variant_a
->fields
->len
; ++i
) {
5101 struct structure_field
*field_a
=
5102 g_ptr_array_index(variant_a
->fields
, i
);
5103 struct structure_field
*field_b
=
5104 g_ptr_array_index(variant_b
->fields
, i
);
5106 ret
= compare_structure_fields(field_a
, field_b
);
5108 /* compare_structure_fields() logs what differs */
5109 BT_LOGV_STR("Variant field types differ: different fields.");
5122 int bt_field_type_array_compare(struct bt_field_type
*type_a
,
5123 struct bt_field_type
*type_b
)
5126 struct bt_field_type_array
*array_a
;
5127 struct bt_field_type_array
*array_b
;
5129 array_a
= container_of(type_a
,
5130 struct bt_field_type_array
, parent
);
5131 array_b
= container_of(type_b
,
5132 struct bt_field_type_array
, parent
);
5135 if (array_a
->length
!= array_b
->length
) {
5136 BT_LOGV("Structure field types differ: different lengths: "
5137 "ft-a-length=%u, ft-b-length=%u",
5138 array_a
->length
, array_b
->length
);
5143 ret
= bt_field_type_compare(array_a
->element_type
,
5144 array_b
->element_type
);
5146 BT_LOGV("Array field types differ: different element field types: "
5147 "ft-a-element-ft-addr=%p, ft-b-element-ft-addr=%p",
5148 array_a
->element_type
, array_b
->element_type
);
5156 int bt_field_type_sequence_compare(struct bt_field_type
*type_a
,
5157 struct bt_field_type
*type_b
)
5160 struct bt_field_type_sequence
*sequence_a
;
5161 struct bt_field_type_sequence
*sequence_b
;
5163 sequence_a
= container_of(type_a
,
5164 struct bt_field_type_sequence
, parent
);
5165 sequence_b
= container_of(type_b
,
5166 struct bt_field_type_sequence
, parent
);
5169 if (strcmp(sequence_a
->length_field_name
->str
,
5170 sequence_b
->length_field_name
->str
)) {
5171 BT_LOGV("Sequence field types differ: different length field names: "
5172 "ft-a-length-field-name=\"%s\", "
5173 "ft-b-length-field-name=\"%s\"",
5174 sequence_a
->length_field_name
->str
,
5175 sequence_b
->length_field_name
->str
);
5180 ret
= bt_field_type_compare(sequence_a
->element_type
,
5181 sequence_b
->element_type
);
5183 BT_LOGV("Sequence field types differ: different element field types: "
5184 "ft-a-element-ft-addr=%p, ft-b-element-ft-addr=%p",
5185 sequence_a
->element_type
, sequence_b
->element_type
);
5192 int bt_field_type_compare(struct bt_field_type
*type_a
,
5193 struct bt_field_type
*type_b
)
5197 if (type_a
== type_b
) {
5198 /* Same reference: equal (even if both are NULL) */
5204 BT_LOGW_STR("Invalid parameter: field type A is NULL.");
5210 BT_LOGW_STR("Invalid parameter: field type B is NULL.");
5215 if (type_a
->id
!= type_b
->id
) {
5216 /* Different type IDs */
5217 BT_LOGV("Field types differ: different IDs: "
5218 "ft-a-addr=%p, ft-b-addr=%p, "
5219 "ft-a-id=%s, ft-b-id=%s",
5221 bt_field_type_id_string(type_a
->id
),
5222 bt_field_type_id_string(type_b
->id
));
5226 if (type_a
->id
== BT_FIELD_TYPE_ID_UNKNOWN
) {
5227 /* Both have unknown type IDs */
5228 BT_LOGW_STR("Invalid parameter: field type IDs are unknown.");
5232 ret
= type_compare_funcs
[type_a
->id
](type_a
, type_b
);
5234 BT_LOGV("Field types differ: ft-a-addr=%p, ft-b-addr=%p",
5243 int64_t bt_field_type_get_field_count(struct bt_field_type
*field_type
)
5245 int64_t field_count
= -1;
5246 enum bt_field_type_id type_id
= bt_field_type_get_type_id(field_type
);
5249 case CTF_TYPE_STRUCT
:
5251 bt_field_type_structure_get_field_count(field_type
);
5253 case CTF_TYPE_VARIANT
:
5255 bt_field_type_variant_get_field_count(field_type
);
5257 case CTF_TYPE_ARRAY
:
5258 case CTF_TYPE_SEQUENCE
:
5260 * Array and sequence types always contain a single member
5261 * (the element type).
5273 struct bt_field_type
*bt_field_type_get_field_at_index(
5274 struct bt_field_type
*field_type
, int index
)
5276 struct bt_field_type
*field
= NULL
;
5277 enum bt_field_type_id type_id
= bt_field_type_get_type_id(field_type
);
5280 case CTF_TYPE_STRUCT
:
5282 int ret
= bt_field_type_structure_get_field_by_index(
5283 field_type
, NULL
, &field
, index
);
5290 case CTF_TYPE_VARIANT
:
5292 int ret
= bt_field_type_variant_get_field_by_index(
5293 field_type
, NULL
, &field
, index
);
5300 case CTF_TYPE_ARRAY
:
5301 field
= bt_field_type_array_get_element_type(field_type
);
5303 case CTF_TYPE_SEQUENCE
:
5304 field
= bt_field_type_sequence_get_element_type(field_type
);
5314 int bt_field_type_get_field_index(struct bt_field_type
*field_type
,
5317 int field_index
= -1;
5318 enum bt_field_type_id type_id
= bt_field_type_get_type_id(field_type
);
5321 case CTF_TYPE_STRUCT
:
5322 field_index
= bt_field_type_structure_get_field_name_index(
5325 case CTF_TYPE_VARIANT
:
5326 field_index
= bt_field_type_variant_get_field_name_index(
5336 struct bt_field_path
*bt_field_type_variant_get_tag_field_path(
5337 struct bt_field_type
*type
)
5339 struct bt_field_path
*field_path
= NULL
;
5340 struct bt_field_type_variant
*variant
;
5343 BT_LOGW_STR("Invalid parameter: field type is NULL.");
5347 if (!bt_field_type_is_variant(type
)) {
5348 BT_LOGW("Invalid parameter: field type is not a variant field type: "
5349 "addr=%p, ft-id=%s", type
,
5350 bt_field_type_id_string(type
->id
));
5354 variant
= container_of(type
, struct bt_field_type_variant
,
5356 field_path
= bt_get(variant
->tag_field_path
);
5361 struct bt_field_path
*bt_field_type_sequence_get_length_field_path(
5362 struct bt_field_type
*type
)
5364 struct bt_field_path
*field_path
= NULL
;
5365 struct bt_field_type_sequence
*sequence
;
5368 BT_LOGW_STR("Invalid parameter: field type is NULL.");
5372 if (!bt_field_type_is_sequence(type
)) {
5373 BT_LOGW("Invalid parameter: field type is not a sequence field type: "
5374 "addr=%p, ft-id=%s", type
,
5375 bt_field_type_id_string(type
->id
));
5379 sequence
= container_of(type
, struct bt_field_type_sequence
,
5381 field_path
= bt_get(sequence
->length_field_path
);