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_ctf_field_type_destroy(struct bt_object
*);
64 void bt_ctf_field_type_integer_destroy(struct bt_ctf_field_type
*);
66 void bt_ctf_field_type_enumeration_destroy(struct bt_ctf_field_type
*);
68 void bt_ctf_field_type_floating_point_destroy(struct bt_ctf_field_type
*);
70 void bt_ctf_field_type_structure_destroy(struct bt_ctf_field_type
*);
72 void bt_ctf_field_type_variant_destroy(struct bt_ctf_field_type
*);
74 void bt_ctf_field_type_array_destroy(struct bt_ctf_field_type
*);
76 void bt_ctf_field_type_sequence_destroy(struct bt_ctf_field_type
*);
78 void bt_ctf_field_type_string_destroy(struct bt_ctf_field_type
*);
81 void (* const type_destroy_funcs
[])(struct bt_ctf_field_type
*) = {
82 [BT_CTF_FIELD_TYPE_ID_INTEGER
] = bt_ctf_field_type_integer_destroy
,
83 [BT_CTF_FIELD_TYPE_ID_ENUM
] =
84 bt_ctf_field_type_enumeration_destroy
,
85 [BT_CTF_FIELD_TYPE_ID_FLOAT
] =
86 bt_ctf_field_type_floating_point_destroy
,
87 [BT_CTF_FIELD_TYPE_ID_STRUCT
] = bt_ctf_field_type_structure_destroy
,
88 [BT_CTF_FIELD_TYPE_ID_VARIANT
] = bt_ctf_field_type_variant_destroy
,
89 [BT_CTF_FIELD_TYPE_ID_ARRAY
] = bt_ctf_field_type_array_destroy
,
90 [BT_CTF_FIELD_TYPE_ID_SEQUENCE
] = bt_ctf_field_type_sequence_destroy
,
91 [BT_CTF_FIELD_TYPE_ID_STRING
] = bt_ctf_field_type_string_destroy
,
95 void generic_field_type_freeze(struct bt_ctf_field_type
*);
97 void bt_ctf_field_type_integer_freeze(struct bt_ctf_field_type
*);
99 void bt_ctf_field_type_enumeration_freeze(struct bt_ctf_field_type
*);
101 void bt_ctf_field_type_structure_freeze(struct bt_ctf_field_type
*);
103 void bt_ctf_field_type_variant_freeze(struct bt_ctf_field_type
*);
105 void bt_ctf_field_type_array_freeze(struct bt_ctf_field_type
*);
107 void bt_ctf_field_type_sequence_freeze(struct bt_ctf_field_type
*);
110 type_freeze_func
const type_freeze_funcs
[] = {
111 [BT_CTF_FIELD_TYPE_ID_INTEGER
] = bt_ctf_field_type_integer_freeze
,
112 [BT_CTF_FIELD_TYPE_ID_ENUM
] = bt_ctf_field_type_enumeration_freeze
,
113 [BT_CTF_FIELD_TYPE_ID_FLOAT
] = generic_field_type_freeze
,
114 [BT_CTF_FIELD_TYPE_ID_STRUCT
] = bt_ctf_field_type_structure_freeze
,
115 [BT_CTF_FIELD_TYPE_ID_VARIANT
] = bt_ctf_field_type_variant_freeze
,
116 [BT_CTF_FIELD_TYPE_ID_ARRAY
] = bt_ctf_field_type_array_freeze
,
117 [BT_CTF_FIELD_TYPE_ID_SEQUENCE
] = bt_ctf_field_type_sequence_freeze
,
118 [BT_CTF_FIELD_TYPE_ID_STRING
] = generic_field_type_freeze
,
122 int bt_ctf_field_type_integer_serialize(struct bt_ctf_field_type
*,
123 struct metadata_context
*);
125 int bt_ctf_field_type_enumeration_serialize(struct bt_ctf_field_type
*,
126 struct metadata_context
*);
128 int bt_ctf_field_type_floating_point_serialize(
129 struct bt_ctf_field_type
*, struct metadata_context
*);
131 int bt_ctf_field_type_structure_serialize(struct bt_ctf_field_type
*,
132 struct metadata_context
*);
134 int bt_ctf_field_type_variant_serialize(struct bt_ctf_field_type
*,
135 struct metadata_context
*);
137 int bt_ctf_field_type_array_serialize(struct bt_ctf_field_type
*,
138 struct metadata_context
*);
140 int bt_ctf_field_type_sequence_serialize(struct bt_ctf_field_type
*,
141 struct metadata_context
*);
143 int bt_ctf_field_type_string_serialize(struct bt_ctf_field_type
*,
144 struct metadata_context
*);
147 type_serialize_func
const type_serialize_funcs
[] = {
148 [BT_CTF_FIELD_TYPE_ID_INTEGER
] = bt_ctf_field_type_integer_serialize
,
149 [BT_CTF_FIELD_TYPE_ID_ENUM
] =
150 bt_ctf_field_type_enumeration_serialize
,
151 [BT_CTF_FIELD_TYPE_ID_FLOAT
] =
152 bt_ctf_field_type_floating_point_serialize
,
153 [BT_CTF_FIELD_TYPE_ID_STRUCT
] =
154 bt_ctf_field_type_structure_serialize
,
155 [BT_CTF_FIELD_TYPE_ID_VARIANT
] = bt_ctf_field_type_variant_serialize
,
156 [BT_CTF_FIELD_TYPE_ID_ARRAY
] = bt_ctf_field_type_array_serialize
,
157 [BT_CTF_FIELD_TYPE_ID_SEQUENCE
] = bt_ctf_field_type_sequence_serialize
,
158 [BT_CTF_FIELD_TYPE_ID_STRING
] = bt_ctf_field_type_string_serialize
,
162 void bt_ctf_field_type_integer_set_byte_order(struct bt_ctf_field_type
*,
163 enum bt_ctf_byte_order byte_order
);
165 void bt_ctf_field_type_enumeration_set_byte_order(struct bt_ctf_field_type
*,
166 enum bt_ctf_byte_order byte_order
);
168 void bt_ctf_field_type_floating_point_set_byte_order(
169 struct bt_ctf_field_type
*, enum bt_ctf_byte_order byte_order
);
171 void bt_ctf_field_type_structure_set_byte_order(struct bt_ctf_field_type
*,
172 enum bt_ctf_byte_order byte_order
);
174 void bt_ctf_field_type_variant_set_byte_order(struct bt_ctf_field_type
*,
175 enum bt_ctf_byte_order byte_order
);
177 void bt_ctf_field_type_array_set_byte_order(struct bt_ctf_field_type
*,
178 enum bt_ctf_byte_order byte_order
);
180 void bt_ctf_field_type_sequence_set_byte_order(struct bt_ctf_field_type
*,
181 enum bt_ctf_byte_order byte_order
);
184 void (* const set_byte_order_funcs
[])(struct bt_ctf_field_type
*,
185 enum bt_ctf_byte_order
) = {
186 [BT_CTF_FIELD_TYPE_ID_INTEGER
] = bt_ctf_field_type_integer_set_byte_order
,
187 [BT_CTF_FIELD_TYPE_ID_ENUM
] =
188 bt_ctf_field_type_enumeration_set_byte_order
,
189 [BT_CTF_FIELD_TYPE_ID_FLOAT
] =
190 bt_ctf_field_type_floating_point_set_byte_order
,
191 [BT_CTF_FIELD_TYPE_ID_STRUCT
] =
192 bt_ctf_field_type_structure_set_byte_order
,
193 [BT_CTF_FIELD_TYPE_ID_VARIANT
] = bt_ctf_field_type_variant_set_byte_order
,
194 [BT_CTF_FIELD_TYPE_ID_ARRAY
] = bt_ctf_field_type_array_set_byte_order
,
195 [BT_CTF_FIELD_TYPE_ID_SEQUENCE
] = bt_ctf_field_type_sequence_set_byte_order
,
196 [BT_CTF_FIELD_TYPE_ID_STRING
] = NULL
,
200 struct bt_ctf_field_type
*bt_ctf_field_type_integer_copy(
201 struct bt_ctf_field_type
*);
203 struct bt_ctf_field_type
*bt_ctf_field_type_enumeration_copy(
204 struct bt_ctf_field_type
*);
206 struct bt_ctf_field_type
*bt_ctf_field_type_floating_point_copy(
207 struct bt_ctf_field_type
*);
209 struct bt_ctf_field_type
*bt_ctf_field_type_structure_copy(
210 struct bt_ctf_field_type
*);
212 struct bt_ctf_field_type
*bt_ctf_field_type_variant_copy(
213 struct bt_ctf_field_type
*);
215 struct bt_ctf_field_type
*bt_ctf_field_type_array_copy(
216 struct bt_ctf_field_type
*);
218 struct bt_ctf_field_type
*bt_ctf_field_type_sequence_copy(
219 struct bt_ctf_field_type
*);
221 struct bt_ctf_field_type
*bt_ctf_field_type_string_copy(
222 struct bt_ctf_field_type
*);
225 struct bt_ctf_field_type
*(* const type_copy_funcs
[])(
226 struct bt_ctf_field_type
*) = {
227 [BT_CTF_FIELD_TYPE_ID_INTEGER
] = bt_ctf_field_type_integer_copy
,
228 [BT_CTF_FIELD_TYPE_ID_ENUM
] = bt_ctf_field_type_enumeration_copy
,
229 [BT_CTF_FIELD_TYPE_ID_FLOAT
] = bt_ctf_field_type_floating_point_copy
,
230 [BT_CTF_FIELD_TYPE_ID_STRUCT
] = bt_ctf_field_type_structure_copy
,
231 [BT_CTF_FIELD_TYPE_ID_VARIANT
] = bt_ctf_field_type_variant_copy
,
232 [BT_CTF_FIELD_TYPE_ID_ARRAY
] = bt_ctf_field_type_array_copy
,
233 [BT_CTF_FIELD_TYPE_ID_SEQUENCE
] = bt_ctf_field_type_sequence_copy
,
234 [BT_CTF_FIELD_TYPE_ID_STRING
] = bt_ctf_field_type_string_copy
,
238 int bt_ctf_field_type_integer_compare(struct bt_ctf_field_type
*,
239 struct bt_ctf_field_type
*);
241 int bt_ctf_field_type_floating_point_compare(struct bt_ctf_field_type
*,
242 struct bt_ctf_field_type
*);
244 int bt_ctf_field_type_enumeration_compare(struct bt_ctf_field_type
*,
245 struct bt_ctf_field_type
*);
247 int bt_ctf_field_type_string_compare(struct bt_ctf_field_type
*,
248 struct bt_ctf_field_type
*);
250 int bt_ctf_field_type_structure_compare(struct bt_ctf_field_type
*,
251 struct bt_ctf_field_type
*);
253 int bt_ctf_field_type_variant_compare(struct bt_ctf_field_type
*,
254 struct bt_ctf_field_type
*);
256 int bt_ctf_field_type_array_compare(struct bt_ctf_field_type
*,
257 struct bt_ctf_field_type
*);
259 int bt_ctf_field_type_sequence_compare(struct bt_ctf_field_type
*,
260 struct bt_ctf_field_type
*);
263 int (* const type_compare_funcs
[])(struct bt_ctf_field_type
*,
264 struct bt_ctf_field_type
*) = {
265 [BT_CTF_FIELD_TYPE_ID_INTEGER
] = bt_ctf_field_type_integer_compare
,
266 [BT_CTF_FIELD_TYPE_ID_ENUM
] = bt_ctf_field_type_enumeration_compare
,
267 [BT_CTF_FIELD_TYPE_ID_FLOAT
] = bt_ctf_field_type_floating_point_compare
,
268 [BT_CTF_FIELD_TYPE_ID_STRUCT
] = bt_ctf_field_type_structure_compare
,
269 [BT_CTF_FIELD_TYPE_ID_VARIANT
] = bt_ctf_field_type_variant_compare
,
270 [BT_CTF_FIELD_TYPE_ID_ARRAY
] = bt_ctf_field_type_array_compare
,
271 [BT_CTF_FIELD_TYPE_ID_SEQUENCE
] = bt_ctf_field_type_sequence_compare
,
272 [BT_CTF_FIELD_TYPE_ID_STRING
] = bt_ctf_field_type_string_compare
,
276 int bt_ctf_field_type_integer_validate(struct bt_ctf_field_type
*);
278 int bt_ctf_field_type_enumeration_validate(struct bt_ctf_field_type
*);
280 int bt_ctf_field_type_structure_validate(struct bt_ctf_field_type
*);
282 int bt_ctf_field_type_variant_validate(struct bt_ctf_field_type
*);
284 int bt_ctf_field_type_array_validate(struct bt_ctf_field_type
*);
286 int bt_ctf_field_type_sequence_validate(struct bt_ctf_field_type
*);
289 int (* const type_validate_funcs
[])(struct bt_ctf_field_type
*) = {
290 [BT_CTF_FIELD_TYPE_ID_INTEGER
] = bt_ctf_field_type_integer_validate
,
291 [BT_CTF_FIELD_TYPE_ID_FLOAT
] = NULL
,
292 [BT_CTF_FIELD_TYPE_ID_STRING
] = NULL
,
293 [BT_CTF_FIELD_TYPE_ID_ENUM
] = bt_ctf_field_type_enumeration_validate
,
294 [BT_CTF_FIELD_TYPE_ID_STRUCT
] = bt_ctf_field_type_structure_validate
,
295 [BT_CTF_FIELD_TYPE_ID_VARIANT
] = bt_ctf_field_type_variant_validate
,
296 [BT_CTF_FIELD_TYPE_ID_ARRAY
] = bt_ctf_field_type_array_validate
,
297 [BT_CTF_FIELD_TYPE_ID_SEQUENCE
] = bt_ctf_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_ctf_field_type_init(struct bt_ctf_field_type
*type
, bt_bool init_bo
)
400 assert(type
&& (type
->id
> BT_CTF_FIELD_TYPE_ID_UNKNOWN
) &&
401 (type
->id
< BT_CTF_NR_TYPE_IDS
));
403 bt_object_init(type
, bt_ctf_field_type_destroy
);
404 type
->freeze
= type_freeze_funcs
[type
->id
];
405 type
->serialize
= type_serialize_funcs
[type
->id
];
409 const enum bt_ctf_byte_order bo
= BT_CTF_BYTE_ORDER_NATIVE
;
411 BT_LOGD("Setting initial field type's byte order: bo=%s",
412 bt_ctf_byte_order_string(bo
));
413 ret
= bt_ctf_field_type_set_byte_order(type
, bo
);
421 int add_structure_field(GPtrArray
*fields
,
422 GHashTable
*field_name_to_index
,
423 struct bt_ctf_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_ctf_field_type_destroy(struct bt_object
*obj
)
462 struct bt_ctf_field_type
*type
;
463 enum bt_ctf_field_type_id type_id
;
465 type
= container_of(obj
, struct bt_ctf_field_type
, base
);
467 assert(type_id
> BT_CTF_FIELD_TYPE_ID_UNKNOWN
&&
468 type_id
< BT_CTF_NR_TYPE_IDS
);
469 type_destroy_funcs
[type_id
](type
);
473 int bt_ctf_field_type_integer_validate(struct bt_ctf_field_type
*type
)
477 struct bt_ctf_field_type_integer
*integer
=
478 container_of(type
, struct bt_ctf_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_ctf_clock_class_get_name(integer
->mapped_clock
));
495 struct enumeration_mapping
*get_enumeration_mapping(
496 struct bt_ctf_field_type
*type
, uint64_t index
)
498 struct enumeration_mapping
*mapping
= NULL
;
499 struct bt_ctf_field_type_enumeration
*enumeration
;
501 enumeration
= container_of(type
, struct bt_ctf_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_ctf_field_type
*type
)
524 struct bt_ctf_field_type
*container_type
;
525 struct bt_ctf_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_ctf_field_type_enumeration
, parent
);
533 len
= enumeration_type
->entries
->len
;
534 container_type
= enumeration_type
->container
;
535 is_signed
= bt_ctf_field_type_integer_get_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_ctf_field_type_enumeration_validate(struct bt_ctf_field_type
*type
)
576 struct bt_ctf_field_type_enumeration
*enumeration
=
577 container_of(type
, struct bt_ctf_field_type_enumeration
,
579 struct bt_ctf_field_type
*container_type
=
580 bt_ctf_field_type_enumeration_get_container_type(type
);
582 assert(container_type
);
583 ret
= bt_ctf_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_ctf_field_type_sequence_validate(struct bt_ctf_field_type
*type
)
608 struct bt_ctf_field_type
*element_type
= NULL
;
609 struct bt_ctf_field_type_sequence
*sequence
=
610 container_of(type
, struct bt_ctf_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_ctf_field_type_sequence_get_element_type(type
);
622 assert(element_type
);
623 ret
= bt_ctf_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_ctf_field_type_array_validate(struct bt_ctf_field_type
*type
)
640 struct bt_ctf_field_type
*element_type
= NULL
;
642 element_type
= bt_ctf_field_type_array_get_element_type(type
);
643 assert(element_type
);
644 ret
= bt_ctf_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_ctf_field_type_structure_validate(struct bt_ctf_field_type
*type
)
659 struct bt_ctf_field_type
*child_type
= NULL
;
660 int64_t field_count
= bt_ctf_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_ctf_field_type_structure_get_field_by_index(type
,
669 &field_name
, &child_type
, i
);
671 ret
= bt_ctf_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_ctf_field_type_enumeration_has_overlapping_ranges(
692 struct bt_ctf_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_ctf_field_type_enumeration_get_mapping_name(
702 struct bt_ctf_field_type
*enum_field_type
,
704 const char **mapping_name
)
707 struct enumeration_mapping
*mapping
;
709 assert(enum_field_type
);
710 mapping
= get_enumeration_mapping(enum_field_type
, index
);
713 *mapping_name
= g_quark_to_string(mapping
->string
);
720 int bt_ctf_field_type_variant_validate(struct bt_ctf_field_type
*type
)
724 struct bt_ctf_field_type
*child_type
= NULL
;
725 struct bt_ctf_field_type_variant
*variant
=
726 container_of(type
, struct bt_ctf_field_type_variant
,
729 int64_t tag_mappings_count
;
731 if (variant
->tag_name
->len
== 0) {
732 BT_LOGW("Invalid variant field type: no tag field name: "
739 BT_LOGW("Invalid variant field type: no tag field type: "
740 "addr=%p, tag-field-name=\"%s\"", type
,
741 variant
->tag_name
->str
);
746 if (bt_ctf_field_type_enumeration_has_overlapping_ranges(
748 BT_LOGW("Invalid variant field type: enumeration tag field type has overlapping ranges: "
749 "variant-ft-addr=%p, tag-field-name=\"%s\", "
750 "enum-ft-addr=%p", type
, variant
->tag_name
->str
,
757 bt_ctf_field_type_enumeration_get_mapping_count(
758 (struct bt_ctf_field_type
*) variant
->tag
);
759 assert(tag_mappings_count
>= 0);
762 * Validate that each mapping found in the tag has a name which
763 * is also the name of a field in this variant field type.
765 * The opposite is accepted: variant FT fields which cannot be
766 * selected because the variant FT tag has no mapping named as
767 * such. This scenario, while not ideal, cannot cause any error.
769 for (i
= 0; i
< tag_mappings_count
; ++i
) {
771 struct bt_ctf_field_type
*ft
;
773 ret
= bt_ctf_field_type_enumeration_get_mapping_name(
774 (struct bt_ctf_field_type
*) variant
->tag
,
778 ft
= bt_ctf_field_type_variant_get_field_type_by_name(
781 BT_LOGW("Invalid variant field type: "
782 "enumeration tag field type contains a mapping which does not name a variant field type field: "
783 "variant-ft-addr=%p, tag-field-name=\"%s\", "
784 "enum-ft-addr=%p, mapping-name=\"%s\"",
785 type
, variant
->tag_name
->str
, variant
->tag
,
794 field_count
= bt_ctf_field_type_variant_get_field_count(type
);
795 if (field_count
< 0) {
796 BT_LOGW("Invalid variant field type: no fields: "
797 "addr=%p, tag-field-name=\"%s\"",
798 type
, variant
->tag_name
->str
);
803 for (i
= 0; i
< field_count
; ++i
) {
804 const char *field_name
;
806 ret
= bt_ctf_field_type_variant_get_field_by_index(type
,
807 &field_name
, &child_type
, i
);
809 ret
= bt_ctf_field_type_validate(child_type
);
811 BT_LOGW("Invalid variant field type: "
812 "a contained field type is invalid: "
813 "variant-ft-addr=%p, tag-field-name=\"%s\", "
814 "field-ft-addr=%p, field-name=\"%s\", "
815 "field-index=%" PRId64
,
816 type
, variant
->tag_name
->str
, child_type
,
831 * This function validates a given field type without considering
832 * where this field type is located. It only validates the properties
833 * of the given field type and the properties of its children if
837 int bt_ctf_field_type_validate(struct bt_ctf_field_type
*type
)
840 enum bt_ctf_field_type_id id
= bt_ctf_field_type_get_type_id(type
);
845 /* Already marked as valid */
849 if (type_validate_funcs
[id
]) {
850 ret
= type_validate_funcs
[id
](type
);
853 if (!ret
&& type
->frozen
) {
854 /* Field type is valid */
855 BT_LOGV("Marking field type as valid: addr=%p", type
);
863 struct bt_ctf_field_type
*bt_ctf_field_type_integer_create(unsigned int size
)
865 struct bt_ctf_field_type_integer
*integer
=
866 g_new0(struct bt_ctf_field_type_integer
, 1);
868 BT_LOGD("Creating integer field type object: size=%u", size
);
871 BT_LOGE_STR("Failed to allocate one integer field type.");
875 if (size
== 0 || size
> 64) {
876 BT_LOGW("Invalid parameter: size must be between 1 and 64: "
881 integer
->parent
.id
= BT_CTF_FIELD_TYPE_ID_INTEGER
;
882 integer
->size
= size
;
883 integer
->base
= BT_CTF_INTEGER_BASE_DECIMAL
;
884 integer
->encoding
= BT_CTF_STRING_ENCODING_NONE
;
885 bt_ctf_field_type_init(&integer
->parent
, TRUE
);
886 BT_LOGD("Created integer field type object: addr=%p, size=%u",
887 &integer
->parent
, size
);
888 return &integer
->parent
;
891 int bt_ctf_field_type_integer_get_size(struct bt_ctf_field_type
*type
)
894 struct bt_ctf_field_type_integer
*integer
;
897 BT_LOGW_STR("Invalid parameter: field type is NULL.");
902 if (type
->id
!= BT_CTF_FIELD_TYPE_ID_INTEGER
) {
903 BT_LOGW("Invalid parameter: field type is not an integer field type: "
904 "addr=%p, ft-id=%s", type
,
905 bt_ctf_field_type_id_string(type
->id
));
910 integer
= container_of(type
, struct bt_ctf_field_type_integer
, parent
);
911 ret
= (int) integer
->size
;
916 int bt_ctf_field_type_integer_get_signed(struct bt_ctf_field_type
*type
)
919 struct bt_ctf_field_type_integer
*integer
;
922 BT_LOGW_STR("Invalid parameter: field type is NULL.");
927 if (type
->id
!= BT_CTF_FIELD_TYPE_ID_INTEGER
) {
928 BT_LOGW("Invalid parameter: field type is not an integer field type: "
929 "addr=%p, ft-id=%s", type
,
930 bt_ctf_field_type_id_string(type
->id
));
935 integer
= container_of(type
, struct bt_ctf_field_type_integer
, parent
);
936 ret
= integer
->is_signed
;
941 bt_bool
bt_ctf_field_type_integer_is_signed(
942 struct bt_ctf_field_type
*int_field_type
)
944 return bt_ctf_field_type_integer_get_signed(int_field_type
) ?
948 int bt_ctf_field_type_integer_set_signed(struct bt_ctf_field_type
*type
,
952 struct bt_ctf_field_type_integer
*integer
;
955 BT_LOGW_STR("Invalid parameter: field type is NULL.");
961 BT_LOGW("Invalid parameter: field type is frozen: addr=%p",
967 if (type
->id
!= BT_CTF_FIELD_TYPE_ID_INTEGER
) {
968 BT_LOGW("Invalid parameter: field type is not an integer field type: "
969 "addr=%p, ft-id=%s", type
,
970 bt_ctf_field_type_id_string(type
->id
));
975 integer
= container_of(type
, struct bt_ctf_field_type_integer
, parent
);
976 integer
->is_signed
= !!is_signed
;
977 BT_LOGV("Set integer field type's signedness: addr=%p, is-signed=%d",
983 int bt_ctf_field_type_integer_set_size(struct bt_ctf_field_type
*type
,
987 struct bt_ctf_field_type_integer
*integer
;
990 BT_LOGW_STR("Invalid parameter: field type is NULL.");
996 BT_LOGW("Invalid parameter: field type is frozen: addr=%p",
1002 if (type
->id
!= BT_CTF_FIELD_TYPE_ID_INTEGER
) {
1003 BT_LOGW("Invalid parameter: field type is not an integer field type: "
1004 "addr=%p, ft-id=%s", type
,
1005 bt_ctf_field_type_id_string(type
->id
));
1010 if (size
== 0 || size
> 64) {
1011 BT_LOGW("Invalid parameter: size must be between 1 and 64: "
1012 "addr=%p, size=%u", type
, size
);
1017 integer
= container_of(type
, struct bt_ctf_field_type_integer
, parent
);
1018 integer
->size
= size
;
1019 BT_LOGV("Set integer field type's size: addr=%p, size=%u",
1025 enum bt_ctf_integer_base
bt_ctf_field_type_integer_get_base(
1026 struct bt_ctf_field_type
*type
)
1028 enum bt_ctf_integer_base ret
= BT_CTF_INTEGER_BASE_UNKNOWN
;
1029 struct bt_ctf_field_type_integer
*integer
;
1032 BT_LOGW_STR("Invalid parameter: field type is NULL.");
1036 if (type
->id
!= BT_CTF_FIELD_TYPE_ID_INTEGER
) {
1037 BT_LOGW("Invalid parameter: field type is not an integer field type: "
1038 "addr=%p, ft-id=%s", type
,
1039 bt_ctf_field_type_id_string(type
->id
));
1043 integer
= container_of(type
, struct bt_ctf_field_type_integer
, parent
);
1044 ret
= integer
->base
;
1049 int bt_ctf_field_type_integer_set_base(struct bt_ctf_field_type
*type
,
1050 enum bt_ctf_integer_base base
)
1055 BT_LOGW_STR("Invalid parameter: field type is NULL.");
1061 BT_LOGW("Invalid parameter: field type is frozen: addr=%p",
1067 if (type
->id
!= BT_CTF_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_ctf_field_type_id_string(type
->id
));
1076 case BT_CTF_INTEGER_BASE_BINARY
:
1077 case BT_CTF_INTEGER_BASE_OCTAL
:
1078 case BT_CTF_INTEGER_BASE_DECIMAL
:
1079 case BT_CTF_INTEGER_BASE_HEXADECIMAL
:
1081 struct bt_ctf_field_type_integer
*integer
= container_of(type
,
1082 struct bt_ctf_field_type_integer
, parent
);
1083 integer
->base
= base
;
1087 BT_LOGW("Invalid parameter: unknown integer field type base: "
1088 "addr=%p, base=%d", type
, base
);
1092 BT_LOGV("Set integer field type's base: addr=%p, base=%s",
1093 type
, bt_ctf_integer_base_string(base
));
1099 enum bt_ctf_string_encoding
bt_ctf_field_type_integer_get_encoding(
1100 struct bt_ctf_field_type
*type
)
1102 enum bt_ctf_string_encoding ret
= BT_CTF_STRING_ENCODING_UNKNOWN
;
1103 struct bt_ctf_field_type_integer
*integer
;
1106 BT_LOGW_STR("Invalid parameter: field type is NULL.");
1110 if (type
->id
!= BT_CTF_FIELD_TYPE_ID_INTEGER
) {
1111 BT_LOGW("Invalid parameter: field type is not an integer field type: "
1112 "addr=%p, ft-id=%s", type
,
1113 bt_ctf_field_type_id_string(type
->id
));
1117 integer
= container_of(type
, struct bt_ctf_field_type_integer
, parent
);
1118 ret
= integer
->encoding
;
1123 int bt_ctf_field_type_integer_set_encoding(struct bt_ctf_field_type
*type
,
1124 enum bt_ctf_string_encoding encoding
)
1127 struct bt_ctf_field_type_integer
*integer
;
1130 BT_LOGW_STR("Invalid parameter: field type is NULL.");
1136 BT_LOGW("Invalid parameter: field type is frozen: addr=%p",
1142 if (type
->id
!= BT_CTF_FIELD_TYPE_ID_INTEGER
) {
1143 BT_LOGW("Invalid parameter: field type is not an integer field type: "
1144 "addr=%p, ft-id=%s", type
,
1145 bt_ctf_field_type_id_string(type
->id
));
1150 if (encoding
< BT_CTF_STRING_ENCODING_NONE
||
1151 encoding
>= BT_CTF_STRING_ENCODING_UNKNOWN
) {
1152 BT_LOGW("Invalid parameter: unknown string encoding: "
1153 "addr=%p, encoding=%d", type
, encoding
);
1158 integer
= container_of(type
, struct bt_ctf_field_type_integer
, parent
);
1159 integer
->encoding
= encoding
;
1160 BT_LOGV("Set integer field type's encoding: addr=%p, encoding=%s",
1161 type
, bt_ctf_string_encoding_string(encoding
));
1166 struct bt_ctf_clock_class
*bt_ctf_field_type_integer_get_mapped_clock_class(
1167 struct bt_ctf_field_type
*type
)
1169 struct bt_ctf_field_type_integer
*integer
;
1170 struct bt_ctf_clock_class
*clock_class
= NULL
;
1173 BT_LOGW_STR("Invalid parameter: field type is NULL.");
1177 integer
= container_of(type
, struct bt_ctf_field_type_integer
, parent
);
1178 clock_class
= integer
->mapped_clock
;
1179 bt_get(clock_class
);
1184 int bt_ctf_field_type_integer_set_mapped_clock_class(
1185 struct bt_ctf_field_type
*type
,
1186 struct bt_ctf_clock_class
*clock_class
)
1188 struct bt_ctf_field_type_integer
*integer
;
1192 BT_LOGW_STR("Invalid parameter: field type is NULL.");
1198 BT_LOGW_STR("Invalid parameter: clock class is NULL.");
1204 BT_LOGW("Invalid parameter: field type is frozen: addr=%p",
1210 if (!bt_ctf_clock_class_is_valid(clock_class
)) {
1211 BT_LOGW("Invalid parameter: clock class is invalid: ft-addr=%p"
1212 "clock-class-addr=%p, clock-class-name=\"%s\"",
1214 bt_ctf_clock_class_get_name(clock_class
));
1219 integer
= container_of(type
, struct bt_ctf_field_type_integer
, parent
);
1220 bt_put(integer
->mapped_clock
);
1221 integer
->mapped_clock
= bt_get(clock_class
);
1222 BT_LOGV("Set integer field type's mapped clock class: ft-addr=%p, "
1223 "clock-class-addr=%p, clock-class-name=\"%s\"",
1224 type
, clock_class
, bt_ctf_clock_class_get_name(clock_class
));
1230 void bt_ctf_field_type_enum_iter_destroy(struct bt_object
*obj
)
1232 struct bt_ctf_field_type_enumeration_mapping_iterator
*iter
=
1234 struct bt_ctf_field_type_enumeration_mapping_iterator
,
1237 BT_LOGD("Destroying enumeration field type mapping iterator: addr=%p",
1239 BT_LOGD_STR("Putting parent enumeration field type.");
1240 bt_put(&iter
->enumeration_type
->parent
);
1245 struct bt_ctf_field_type_enumeration_mapping_iterator
*
1246 bt_ctf_field_type_enumeration_find_mappings_type(
1247 struct bt_ctf_field_type
*type
,
1248 enum bt_ctf_field_type_enumeration_mapping_iterator_type iterator_type
)
1250 struct bt_ctf_field_type_enumeration
*enumeration_type
;
1251 struct bt_ctf_field_type_enumeration_mapping_iterator
*iter
= NULL
;
1254 BT_LOGW_STR("Invalid parameter: field type is NULL.");
1258 if (type
->id
!= BT_CTF_FIELD_TYPE_ID_ENUM
) {
1259 BT_LOGW("Invalid parameter: field type is not an enumeration field type: "
1260 "addr=%p, ft-id=%s", type
,
1261 bt_ctf_field_type_id_string(type
->id
));
1265 enumeration_type
= container_of(type
,
1266 struct bt_ctf_field_type_enumeration
, parent
);
1267 iter
= g_new0(struct bt_ctf_field_type_enumeration_mapping_iterator
, 1);
1269 BT_LOGE_STR("Failed to allocate one enumeration field type mapping.");
1273 bt_object_init(&iter
->base
, bt_ctf_field_type_enum_iter_destroy
);
1275 iter
->enumeration_type
= enumeration_type
;
1277 iter
->type
= iterator_type
;
1282 struct bt_ctf_field_type_enumeration_mapping_iterator
*
1283 bt_ctf_field_type_enumeration_find_mappings_by_name(
1284 struct bt_ctf_field_type
*type
, const char *name
)
1286 struct bt_ctf_field_type_enumeration_mapping_iterator
*iter
;
1288 iter
= bt_ctf_field_type_enumeration_find_mappings_type(
1289 type
, ITERATOR_BY_NAME
);
1291 BT_LOGE("Cannot create enumeration field type mapping iterator: "
1292 "ft-addr=%p, mapping-name=\"%s\"", type
, name
);
1296 iter
->u
.name_quark
= g_quark_try_string(name
);
1297 if (!iter
->u
.name_quark
) {
1298 BT_LOGV("No such enumeration field type mapping name: "
1299 "ft-addr=%p, mapping-name=\"%s\"",
1304 /* Advance iterator to first entry, or leave index at -1. */
1305 if (bt_ctf_field_type_enumeration_mapping_iterator_next(iter
)) {
1306 /* No entry found. */
1307 BT_LOGV("No such enumeration field type mapping name: "
1308 "ft-addr=%p, mapping-name=\"%s\"",
1319 int bt_ctf_field_type_enumeration_mapping_iterator_next(
1320 struct bt_ctf_field_type_enumeration_mapping_iterator
*iter
)
1322 struct bt_ctf_field_type_enumeration
*enumeration
;
1323 struct bt_ctf_field_type
*type
;
1324 int i
, ret
= 0, len
;
1327 BT_LOGW_STR("Invalid parameter: enumeration field type mapping iterator is NULL.");
1332 enumeration
= iter
->enumeration_type
;
1333 type
= &enumeration
->parent
;
1334 len
= enumeration
->entries
->len
;
1335 for (i
= iter
->index
+ 1; i
< len
; i
++) {
1336 struct enumeration_mapping
*mapping
=
1337 get_enumeration_mapping(type
, i
);
1339 switch (iter
->type
) {
1340 case ITERATOR_BY_NAME
:
1341 if (mapping
->string
== iter
->u
.name_quark
) {
1346 case ITERATOR_BY_SIGNED_VALUE
:
1348 int64_t value
= iter
->u
.signed_value
;
1350 if (value
>= mapping
->range_start
._signed
&&
1351 value
<= mapping
->range_end
._signed
) {
1357 case ITERATOR_BY_UNSIGNED_VALUE
:
1359 uint64_t value
= iter
->u
.unsigned_value
;
1361 if (value
>= mapping
->range_start
._unsigned
&&
1362 value
<= mapping
->range_end
._unsigned
) {
1369 BT_LOGF("Invalid enumeration field type mapping iterator type: "
1370 "type=%d", iter
->type
);
1380 struct bt_ctf_field_type_enumeration_mapping_iterator
*
1381 bt_ctf_field_type_enumeration_find_mappings_by_signed_value(
1382 struct bt_ctf_field_type
*type
, int64_t value
)
1384 struct bt_ctf_field_type_enumeration_mapping_iterator
*iter
;
1386 iter
= bt_ctf_field_type_enumeration_find_mappings_type(
1387 type
, ITERATOR_BY_SIGNED_VALUE
);
1389 BT_LOGE("Cannot create enumeration field type mapping iterator: "
1390 "ft-addr=%p, value=%" PRId64
, type
, value
);
1394 if (bt_ctf_field_type_integer_get_signed(
1395 iter
->enumeration_type
->container
) != 1) {
1396 BT_LOGW("Invalid parameter: enumeration field type is unsigned: "
1397 "enum-ft-addr=%p, int-ft-addr=%p",
1398 type
, iter
->enumeration_type
->container
);
1402 iter
->u
.signed_value
= value
;
1404 /* Advance iterator to first entry, or leave index at -1. */
1405 if (bt_ctf_field_type_enumeration_mapping_iterator_next(iter
)) {
1406 /* No entry found. */
1416 struct bt_ctf_field_type_enumeration_mapping_iterator
*
1417 bt_ctf_field_type_enumeration_find_mappings_by_unsigned_value(
1418 struct bt_ctf_field_type
*type
, uint64_t value
)
1420 struct bt_ctf_field_type_enumeration_mapping_iterator
*iter
= NULL
;
1423 BT_LOGW_STR("Invalid parameter: field type is NULL.");
1427 iter
= bt_ctf_field_type_enumeration_find_mappings_type(
1428 type
, ITERATOR_BY_UNSIGNED_VALUE
);
1430 BT_LOGE("Cannot create enumeration field type mapping iterator: "
1431 "ft-addr=%p, value=%" PRIu64
, type
, value
);
1435 if (bt_ctf_field_type_integer_get_signed(
1436 iter
->enumeration_type
->container
) != 0) {
1437 BT_LOGW("Invalid parameter: enumeration field type is signed: "
1438 "enum-ft-addr=%p, int-ft-addr=%p",
1439 type
, iter
->enumeration_type
->container
);
1442 iter
->u
.unsigned_value
= value
;
1444 /* Advance iterator to first entry, or leave index at -1. */
1445 if (bt_ctf_field_type_enumeration_mapping_iterator_next(iter
)) {
1446 /* No entry found. */
1456 int bt_ctf_field_type_enumeration_mapping_iterator_get_signed(
1457 struct bt_ctf_field_type_enumeration_mapping_iterator
*iter
,
1458 const char **mapping_name
, int64_t *range_begin
,
1464 BT_LOGW_STR("Invalid parameter: enumeration field type mapping iterator is NULL.");
1469 ret
= bt_ctf_field_type_enumeration_get_mapping_signed(
1470 &iter
->enumeration_type
->parent
, iter
->index
,
1471 mapping_name
, range_begin
, range_end
);
1476 int bt_ctf_field_type_enumeration_mapping_iterator_get_unsigned(
1477 struct bt_ctf_field_type_enumeration_mapping_iterator
*iter
,
1478 const char **mapping_name
, uint64_t *range_begin
,
1479 uint64_t *range_end
)
1484 BT_LOGW_STR("Invalid parameter: enumeration field type mapping iterator is NULL.");
1489 ret
= bt_ctf_field_type_enumeration_get_mapping_unsigned(
1490 &iter
->enumeration_type
->parent
, iter
->index
,
1491 mapping_name
, range_begin
, range_end
);
1496 int bt_ctf_field_type_enumeration_get_mapping_signed(
1497 struct bt_ctf_field_type
*enum_field_type
,
1498 uint64_t index
, const char **mapping_name
, int64_t *range_begin
,
1502 struct enumeration_mapping
*mapping
;
1504 if (!enum_field_type
) {
1505 BT_LOGW_STR("Invalid parameter: field type is NULL.");
1510 mapping
= get_enumeration_mapping(enum_field_type
, index
);
1512 /* get_enumeration_mapping() reports any error */
1518 *mapping_name
= g_quark_to_string(mapping
->string
);
1519 assert(*mapping_name
);
1523 *range_begin
= mapping
->range_start
._signed
;
1527 *range_end
= mapping
->range_end
._signed
;
1533 int bt_ctf_field_type_enumeration_get_mapping_unsigned(
1534 struct bt_ctf_field_type
*enum_field_type
,
1536 const char **mapping_name
, uint64_t *range_begin
,
1537 uint64_t *range_end
)
1540 struct enumeration_mapping
*mapping
;
1542 if (!enum_field_type
) {
1543 BT_LOGW_STR("Invalid parameter: field type is NULL.");
1548 mapping
= get_enumeration_mapping(enum_field_type
, index
);
1550 /* get_enumeration_mapping() reports any error */
1556 *mapping_name
= g_quark_to_string(mapping
->string
);
1557 assert(*mapping_name
);
1561 *range_begin
= mapping
->range_start
._unsigned
;
1565 *range_end
= mapping
->range_end
._unsigned
;
1571 struct bt_ctf_field_type
*bt_ctf_field_type_enumeration_create(
1572 struct bt_ctf_field_type
*integer_container_type
)
1574 struct bt_ctf_field_type_enumeration
*enumeration
= NULL
;
1576 BT_LOGD("Creating enumeration field type object: int-ft-addr=%p",
1577 integer_container_type
);
1579 if (!integer_container_type
) {
1580 BT_LOGW_STR("Invalid parameter: field type is NULL.");
1584 if (integer_container_type
->id
!= BT_CTF_FIELD_TYPE_ID_INTEGER
) {
1585 BT_LOGW("Invalid parameter: container field type is not an integer field type: "
1586 "container-ft-addr=%p, container-ft-id=%s",
1587 integer_container_type
,
1588 bt_ctf_field_type_id_string(integer_container_type
->id
));
1592 enumeration
= g_new0(struct bt_ctf_field_type_enumeration
, 1);
1594 BT_LOGE_STR("Failed to allocate one enumeration field type.");
1598 enumeration
->parent
.id
= BT_CTF_FIELD_TYPE_ID_ENUM
;
1599 bt_get(integer_container_type
);
1600 enumeration
->container
= integer_container_type
;
1601 enumeration
->entries
= g_ptr_array_new_with_free_func(
1602 (GDestroyNotify
)destroy_enumeration_mapping
);
1603 bt_ctf_field_type_init(&enumeration
->parent
, FALSE
);
1604 BT_LOGD("Created enumeration field type object: addr=%p, "
1605 "int-ft-addr=%p, int-ft-size=%u",
1606 &enumeration
->parent
, integer_container_type
,
1607 bt_ctf_field_type_integer_get_size(integer_container_type
));
1608 return &enumeration
->parent
;
1610 g_free(enumeration
);
1614 struct bt_ctf_field_type
*bt_ctf_field_type_enumeration_get_container_type(
1615 struct bt_ctf_field_type
*type
)
1617 struct bt_ctf_field_type
*container_type
= NULL
;
1618 struct bt_ctf_field_type_enumeration
*enumeration_type
;
1621 BT_LOGW_STR("Invalid parameter: field type is NULL.");
1625 if (type
->id
!= BT_CTF_FIELD_TYPE_ID_ENUM
) {
1626 BT_LOGW("Invalid parameter: field type is not an enumeration field type: "
1627 "addr=%p, ft-id=%s", type
,
1628 bt_ctf_field_type_id_string(type
->id
));
1632 enumeration_type
= container_of(type
,
1633 struct bt_ctf_field_type_enumeration
, parent
);
1634 container_type
= enumeration_type
->container
;
1635 bt_get(container_type
);
1637 return container_type
;
1640 int bt_ctf_field_type_enumeration_add_mapping_signed(
1641 struct bt_ctf_field_type
*type
, const char *string
,
1642 int64_t range_start
, int64_t range_end
)
1645 GQuark mapping_name
;
1646 struct enumeration_mapping
*mapping
;
1647 struct bt_ctf_field_type_enumeration
*enumeration
;
1648 char *escaped_string
;
1651 BT_LOGW_STR("Invalid parameter: field type is NULL.");
1657 BT_LOGW_STR("Invalid parameter: string is NULL.");
1663 BT_LOGW("Invalid parameter: field type is frozen: addr=%p",
1669 if (type
->id
!= BT_CTF_FIELD_TYPE_ID_ENUM
) {
1670 BT_LOGW("Invalid parameter: field type is not an enumeration field type: "
1671 "addr=%p, ft-id=%s", type
,
1672 bt_ctf_field_type_id_string(type
->id
));
1677 if (range_end
< range_start
) {
1678 BT_LOGW("Invalid parameter: range's end is lesser than range's start: "
1679 "addr=%p, range-start=%" PRId64
", range-end=%" PRId64
,
1680 type
, range_start
, range_end
);
1685 if (strlen(string
) == 0) {
1686 BT_LOGW("Invalid parameter: mapping name is an empty string: "
1687 "enum-ft-addr=%p, mapping-name-addr=%p", type
,
1693 escaped_string
= g_strescape(string
, NULL
);
1694 if (!escaped_string
) {
1695 BT_LOGE("Cannot escape mapping name: enum-ft-addr=%p, "
1696 "mapping-name-addr=%p, mapping-name=\"%s\"",
1697 type
, string
, string
);
1702 mapping
= g_new(struct enumeration_mapping
, 1);
1704 BT_LOGE_STR("Failed to allocate one enumeration mapping.");
1708 mapping_name
= g_quark_from_string(escaped_string
);
1709 *mapping
= (struct enumeration_mapping
) {
1710 .range_start
._signed
= range_start
,
1711 .range_end
._signed
= range_end
,
1712 .string
= mapping_name
,
1714 enumeration
= container_of(type
, struct bt_ctf_field_type_enumeration
,
1716 g_ptr_array_add(enumeration
->entries
, mapping
);
1717 g_ptr_array_sort(enumeration
->entries
,
1718 (GCompareFunc
)compare_enumeration_mappings_signed
);
1719 BT_LOGV("Added mapping to signed enumeration field type: addr=%p, "
1720 "name=\"%s\", range-start=%" PRId64
", "
1721 "range-end=%" PRId64
,
1722 type
, string
, range_start
, range_end
);
1724 free(escaped_string
);
1729 int bt_ctf_field_type_enumeration_add_mapping_unsigned(
1730 struct bt_ctf_field_type
*type
, const char *string
,
1731 uint64_t range_start
, uint64_t range_end
)
1734 GQuark mapping_name
;
1735 struct enumeration_mapping
*mapping
;
1736 struct bt_ctf_field_type_enumeration
*enumeration
;
1737 char *escaped_string
;
1740 BT_LOGW_STR("Invalid parameter: field type is NULL.");
1746 BT_LOGW_STR("Invalid parameter: string is NULL.");
1752 BT_LOGW("Invalid parameter: field type is frozen: addr=%p",
1758 if (type
->id
!= BT_CTF_FIELD_TYPE_ID_ENUM
) {
1759 BT_LOGW("Invalid parameter: field type is not an enumeration field type: "
1760 "addr=%p, ft-id=%s", type
,
1761 bt_ctf_field_type_id_string(type
->id
));
1766 if (range_end
< range_start
) {
1767 BT_LOGW("Invalid parameter: range's end is lesser than range's start: "
1768 "addr=%p, range-start=%" PRIu64
", range-end=%" PRIu64
,
1769 type
, range_start
, range_end
);
1774 if (strlen(string
) == 0) {
1775 BT_LOGW("Invalid parameter: mapping name is an empty string: "
1776 "enum-ft-addr=%p, mapping-name-addr=%p", type
,
1782 escaped_string
= g_strescape(string
, NULL
);
1783 if (!escaped_string
) {
1784 BT_LOGE("Cannot escape mapping name: enum-ft-addr=%p, "
1785 "mapping-name-addr=%p, mapping-name=\"%s\"",
1786 type
, string
, string
);
1791 mapping
= g_new(struct enumeration_mapping
, 1);
1793 BT_LOGE_STR("Failed to allocate one enumeration mapping.");
1797 mapping_name
= g_quark_from_string(escaped_string
);
1798 *mapping
= (struct enumeration_mapping
) {
1799 .range_start
._unsigned
= range_start
,
1800 .range_end
._unsigned
= range_end
,
1801 .string
= mapping_name
,
1803 enumeration
= container_of(type
, struct bt_ctf_field_type_enumeration
,
1805 g_ptr_array_add(enumeration
->entries
, mapping
);
1806 g_ptr_array_sort(enumeration
->entries
,
1807 (GCompareFunc
)compare_enumeration_mappings_unsigned
);
1808 BT_LOGV("Added mapping to unsigned enumeration field type: addr=%p, "
1809 "name=\"%s\", range-start=%" PRIu64
", "
1810 "range-end=%" PRIu64
,
1811 type
, string
, range_start
, range_end
);
1813 free(escaped_string
);
1818 int64_t bt_ctf_field_type_enumeration_get_mapping_count(
1819 struct bt_ctf_field_type
*type
)
1822 struct bt_ctf_field_type_enumeration
*enumeration
;
1825 BT_LOGW_STR("Invalid parameter: field type is NULL.");
1830 if (type
->id
!= BT_CTF_FIELD_TYPE_ID_ENUM
) {
1831 BT_LOGW("Invalid parameter: field type is not an enumeration field type: "
1832 "addr=%p, ft-id=%s", type
,
1833 bt_ctf_field_type_id_string(type
->id
));
1838 enumeration
= container_of(type
, struct bt_ctf_field_type_enumeration
,
1840 ret
= (int64_t) enumeration
->entries
->len
;
1845 struct bt_ctf_field_type
*bt_ctf_field_type_floating_point_create(void)
1847 struct bt_ctf_field_type_floating_point
*floating_point
=
1848 g_new0(struct bt_ctf_field_type_floating_point
, 1);
1850 BT_LOGD_STR("Creating floating point number field type object.");
1852 if (!floating_point
) {
1853 BT_LOGE_STR("Failed to allocate one floating point number field type.");
1857 floating_point
->parent
.id
= BT_CTF_FIELD_TYPE_ID_FLOAT
;
1858 floating_point
->exp_dig
= sizeof(float) * CHAR_BIT
- FLT_MANT_DIG
;
1859 floating_point
->mant_dig
= FLT_MANT_DIG
;
1860 bt_ctf_field_type_init(&floating_point
->parent
, TRUE
);
1861 BT_LOGD("Created floating point number field type object: addr=%p, "
1862 "exp-size=%u, mant-size=%u", &floating_point
->parent
,
1863 floating_point
->exp_dig
, floating_point
->mant_dig
);
1865 return floating_point
? &floating_point
->parent
: NULL
;
1868 int bt_ctf_field_type_floating_point_get_exponent_digits(
1869 struct bt_ctf_field_type
*type
)
1872 struct bt_ctf_field_type_floating_point
*floating_point
;
1875 BT_LOGW_STR("Invalid parameter: field type is NULL.");
1880 if (type
->id
!= BT_CTF_FIELD_TYPE_ID_FLOAT
) {
1881 BT_LOGW("Invalid parameter: field type is not a floating point number field type: "
1882 "addr=%p, ft-id=%s", type
,
1883 bt_ctf_field_type_id_string(type
->id
));
1888 floating_point
= container_of(type
,
1889 struct bt_ctf_field_type_floating_point
, parent
);
1890 ret
= (int) floating_point
->exp_dig
;
1895 int bt_ctf_field_type_floating_point_set_exponent_digits(
1896 struct bt_ctf_field_type
*type
,
1897 unsigned int exponent_digits
)
1900 struct bt_ctf_field_type_floating_point
*floating_point
;
1903 BT_LOGW_STR("Invalid parameter: field type is NULL.");
1909 BT_LOGW("Invalid parameter: field type is frozen: addr=%p",
1915 if (type
->id
!= BT_CTF_FIELD_TYPE_ID_FLOAT
) {
1916 BT_LOGW("Invalid parameter: field type is not a floating point number field type: "
1917 "addr=%p, ft-id=%s", type
,
1918 bt_ctf_field_type_id_string(type
->id
));
1923 floating_point
= container_of(type
,
1924 struct bt_ctf_field_type_floating_point
, parent
);
1925 if ((exponent_digits
!= sizeof(float) * CHAR_BIT
- FLT_MANT_DIG
) &&
1926 (exponent_digits
!= sizeof(double) * CHAR_BIT
- DBL_MANT_DIG
) &&
1928 sizeof(long double) * CHAR_BIT
- LDBL_MANT_DIG
)) {
1929 BT_LOGW("Invalid parameter: invalid exponent size: "
1930 "addr=%p, exp-size=%u", type
, exponent_digits
);
1935 floating_point
->exp_dig
= exponent_digits
;
1936 BT_LOGV("Set floating point number field type's exponent size: addr=%p, "
1937 "exp-size=%u", type
, exponent_digits
);
1942 int bt_ctf_field_type_floating_point_get_mantissa_digits(
1943 struct bt_ctf_field_type
*type
)
1946 struct bt_ctf_field_type_floating_point
*floating_point
;
1949 BT_LOGW_STR("Invalid parameter: field type is NULL.");
1954 if (type
->id
!= BT_CTF_FIELD_TYPE_ID_FLOAT
) {
1955 BT_LOGW("Invalid parameter: field type is not a floating point number field type: "
1956 "addr=%p, ft-id=%s", type
,
1957 bt_ctf_field_type_id_string(type
->id
));
1962 floating_point
= container_of(type
,
1963 struct bt_ctf_field_type_floating_point
, parent
);
1964 ret
= (int) floating_point
->mant_dig
;
1969 int bt_ctf_field_type_floating_point_set_mantissa_digits(
1970 struct bt_ctf_field_type
*type
,
1971 unsigned int mantissa_digits
)
1974 struct bt_ctf_field_type_floating_point
*floating_point
;
1977 BT_LOGW_STR("Invalid parameter: field type is NULL.");
1983 BT_LOGW("Invalid parameter: field type is frozen: addr=%p",
1989 if (type
->id
!= BT_CTF_FIELD_TYPE_ID_FLOAT
) {
1990 BT_LOGW("Invalid parameter: field type is not a floating point number field type: "
1991 "addr=%p, ft-id=%s", type
,
1992 bt_ctf_field_type_id_string(type
->id
));
1997 floating_point
= container_of(type
,
1998 struct bt_ctf_field_type_floating_point
, parent
);
2000 if ((mantissa_digits
!= FLT_MANT_DIG
) &&
2001 (mantissa_digits
!= DBL_MANT_DIG
) &&
2002 (mantissa_digits
!= LDBL_MANT_DIG
)) {
2003 BT_LOGW("Invalid parameter: invalid mantissa size: "
2004 "addr=%p, mant-size=%u", type
, mantissa_digits
);
2009 floating_point
->mant_dig
= mantissa_digits
;
2010 BT_LOGV("Set floating point number field type's mantissa size: addr=%p, "
2011 "mant-size=%u", type
, mantissa_digits
);
2016 struct bt_ctf_field_type
*bt_ctf_field_type_structure_create(void)
2018 struct bt_ctf_field_type_structure
*structure
=
2019 g_new0(struct bt_ctf_field_type_structure
, 1);
2021 BT_LOGD_STR("Creating structure field type object.");
2024 BT_LOGE_STR("Failed to allocate one structure field type.");
2028 structure
->parent
.id
= BT_CTF_FIELD_TYPE_ID_STRUCT
;
2029 structure
->fields
= g_ptr_array_new_with_free_func(
2030 (GDestroyNotify
)destroy_structure_field
);
2031 structure
->field_name_to_index
= g_hash_table_new(NULL
, NULL
);
2032 bt_ctf_field_type_init(&structure
->parent
, TRUE
);
2033 BT_LOGD("Created structure field type object: addr=%p",
2034 &structure
->parent
);
2035 return &structure
->parent
;
2040 int bt_ctf_field_type_structure_add_field(struct bt_ctf_field_type
*type
,
2041 struct bt_ctf_field_type
*field_type
,
2042 const char *field_name
)
2045 struct bt_ctf_field_type_structure
*structure
;
2048 * TODO: check that `field_type` does not contain `type`,
2052 BT_LOGW_STR("Invalid parameter: field type is NULL.");
2058 BT_LOGW_STR("Invalid parameter: field name is NULL.");
2064 BT_LOGW("Invalid parameter: field type is frozen: addr=%p",
2070 if (bt_ctf_validate_identifier(field_name
)) {
2071 BT_LOGW("Invalid parameter: field name is not a valid CTF identifier: "
2072 "struct-ft-addr=%p, field-name=\"%s\"",
2078 if (type
->id
!= BT_CTF_FIELD_TYPE_ID_STRUCT
) {
2079 BT_LOGW("Invalid parameter: field type is not a structure field type: "
2080 "addr=%p, ft-id=%s", type
,
2081 bt_ctf_field_type_id_string(type
->id
));
2086 if (type
== field_type
) {
2087 BT_LOGW("Invalid parameter: structure field type and field type to add are the same: "
2093 structure
= container_of(type
,
2094 struct bt_ctf_field_type_structure
, parent
);
2095 if (add_structure_field(structure
->fields
,
2096 structure
->field_name_to_index
, field_type
, field_name
)) {
2097 BT_LOGW("Cannot add field to structure field type: "
2098 "struct-ft-addr=%p, field-ft-addr=%p, field-name=\"%s\"",
2099 type
, field_type
, field_name
);
2104 BT_LOGV("Added structure field type field: struct-ft-addr=%p, "
2105 "field-ft-addr=%p, field-name=\"%s\"", type
,
2106 field_type
, field_name
);
2111 int64_t bt_ctf_field_type_structure_get_field_count(
2112 struct bt_ctf_field_type
*type
)
2115 struct bt_ctf_field_type_structure
*structure
;
2118 BT_LOGW_STR("Invalid parameter: field type is NULL.");
2123 if (type
->id
!= BT_CTF_FIELD_TYPE_ID_STRUCT
) {
2124 BT_LOGW("Invalid parameter: field type is not a structure field type: "
2125 "addr=%p, ft-id=%s", type
,
2126 bt_ctf_field_type_id_string(type
->id
));
2131 structure
= container_of(type
, struct bt_ctf_field_type_structure
,
2133 ret
= (int64_t) structure
->fields
->len
;
2138 int bt_ctf_field_type_structure_get_field_by_index(
2139 struct bt_ctf_field_type
*type
,
2140 const char **field_name
, struct bt_ctf_field_type
**field_type
,
2143 struct bt_ctf_field_type_structure
*structure
;
2144 struct structure_field
*field
;
2148 BT_LOGW_STR("Invalid parameter: field type is NULL.");
2153 if (type
->id
!= BT_CTF_FIELD_TYPE_ID_STRUCT
) {
2154 BT_LOGW("Invalid parameter: field type is not a structure field type: "
2155 "addr=%p, ft-id=%s", type
,
2156 bt_ctf_field_type_id_string(type
->id
));
2161 structure
= container_of(type
, struct bt_ctf_field_type_structure
,
2163 if (index
>= structure
->fields
->len
) {
2164 BT_LOGW("Invalid parameter: index is out of bounds: "
2165 "addr=%p, index=%" PRIu64
", count=%u",
2166 type
, index
, structure
->fields
->len
);
2171 field
= g_ptr_array_index(structure
->fields
, index
);
2173 *field_type
= field
->type
;
2174 bt_get(field
->type
);
2177 *field_name
= g_quark_to_string(field
->name
);
2178 assert(*field_name
);
2184 struct bt_ctf_field_type
*bt_ctf_field_type_structure_get_field_type_by_name(
2185 struct bt_ctf_field_type
*type
,
2190 struct structure_field
*field
;
2191 struct bt_ctf_field_type_structure
*structure
;
2192 struct bt_ctf_field_type
*field_type
= NULL
;
2195 BT_LOGW_STR("Invalid parameter: field type is NULL.");
2200 BT_LOGW_STR("Invalid parameter: name is NULL.");
2204 name_quark
= g_quark_try_string(name
);
2206 BT_LOGV("No such structure field type field name: "
2207 "ft-addr=%p, field-name=\"%s\"",
2212 structure
= container_of(type
, struct bt_ctf_field_type_structure
,
2214 if (!g_hash_table_lookup_extended(structure
->field_name_to_index
,
2215 GUINT_TO_POINTER(name_quark
), NULL
, (gpointer
*)&index
)) {
2216 BT_LOGV("No such structure field type field name: "
2217 "ft-addr=%p, field-name=\"%s\"",
2222 field
= structure
->fields
->pdata
[index
];
2223 field_type
= field
->type
;
2229 struct bt_ctf_field_type
*bt_ctf_field_type_variant_create(
2230 struct bt_ctf_field_type
*enum_tag
, const char *tag_name
)
2232 struct bt_ctf_field_type_variant
*variant
= NULL
;
2234 BT_LOGD("Creating variant field type object: "
2235 "tag-ft-addr=%p, tag-field-name=\"%s\"",
2236 enum_tag
, tag_name
);
2238 if (tag_name
&& bt_ctf_validate_identifier(tag_name
)) {
2239 BT_LOGW("Invalid parameter: tag field name is not a valid CTF identifier: "
2240 "tag-ft-addr=%p, tag-field-name=\"%s\"",
2241 enum_tag
, tag_name
);
2245 variant
= g_new0(struct bt_ctf_field_type_variant
, 1);
2247 BT_LOGE_STR("Failed to allocate one variant field type.");
2251 variant
->parent
.id
= BT_CTF_FIELD_TYPE_ID_VARIANT
;
2252 variant
->tag_name
= g_string_new(tag_name
);
2253 variant
->field_name_to_index
= g_hash_table_new(NULL
, NULL
);
2254 variant
->fields
= g_ptr_array_new_with_free_func(
2255 (GDestroyNotify
) destroy_structure_field
);
2258 variant
->tag
= container_of(enum_tag
,
2259 struct bt_ctf_field_type_enumeration
, parent
);
2262 bt_ctf_field_type_init(&variant
->parent
, TRUE
);
2263 /* A variant's alignment is undefined */
2264 variant
->parent
.alignment
= 0;
2265 BT_LOGD("Created variant field type object: addr=%p, "
2266 "tag-ft-addr=%p, tag-field-name=\"%s\"",
2267 &variant
->parent
, enum_tag
, tag_name
);
2268 return &variant
->parent
;
2273 struct bt_ctf_field_type
*bt_ctf_field_type_variant_get_tag_type(
2274 struct bt_ctf_field_type
*type
)
2276 struct bt_ctf_field_type_variant
*variant
;
2277 struct bt_ctf_field_type
*tag_type
= NULL
;
2280 BT_LOGW_STR("Invalid parameter: field type is NULL.");
2284 if (type
->id
!= BT_CTF_FIELD_TYPE_ID_VARIANT
) {
2285 BT_LOGW("Invalid parameter: field type is not a variant field type: "
2286 "addr=%p, ft-id=%s", type
,
2287 bt_ctf_field_type_id_string(type
->id
));
2291 variant
= container_of(type
, struct bt_ctf_field_type_variant
, parent
);
2292 if (!variant
->tag
) {
2293 BT_LOGV("Variant field type has no tag field type: "
2298 tag_type
= &variant
->tag
->parent
;
2304 const char *bt_ctf_field_type_variant_get_tag_name(
2305 struct bt_ctf_field_type
*type
)
2307 struct bt_ctf_field_type_variant
*variant
;
2308 const char *tag_name
= NULL
;
2311 BT_LOGW_STR("Invalid parameter: field type is NULL.");
2315 if (type
->id
!= BT_CTF_FIELD_TYPE_ID_VARIANT
) {
2316 BT_LOGW("Invalid parameter: field type is not a variant field type: "
2317 "addr=%p, ft-id=%s", type
,
2318 bt_ctf_field_type_id_string(type
->id
));
2322 variant
= container_of(type
, struct bt_ctf_field_type_variant
, parent
);
2323 if (variant
->tag_name
->len
== 0) {
2324 BT_LOGV("Variant field type has no tag field name: "
2329 tag_name
= variant
->tag_name
->str
;
2334 int bt_ctf_field_type_variant_set_tag_name(
2335 struct bt_ctf_field_type
*type
, const char *name
)
2338 struct bt_ctf_field_type_variant
*variant
;
2341 BT_LOGW_STR("Invalid parameter: field type is NULL.");
2347 BT_LOGW("Invalid parameter: field type is frozen: addr=%p",
2353 if (type
->id
!= BT_CTF_FIELD_TYPE_ID_VARIANT
) {
2354 BT_LOGW("Invalid parameter: field type is not a variant field type: "
2355 "addr=%p, ft-id=%s", type
,
2356 bt_ctf_field_type_id_string(type
->id
));
2361 if (bt_ctf_validate_identifier(name
)) {
2362 BT_LOGW("Invalid parameter: tag field name is not a valid CTF identifier: "
2363 "variant-ft-addr=%p, tag-field-name=\"%s\"",
2369 variant
= container_of(type
, struct bt_ctf_field_type_variant
, parent
);
2370 g_string_assign(variant
->tag_name
, name
);
2371 BT_LOGV("Set variant field type's tag field name: addr=%p, "
2372 "tag-field-name=\"%s\"", type
, name
);
2377 int bt_ctf_field_type_variant_add_field(struct bt_ctf_field_type
*type
,
2378 struct bt_ctf_field_type
*field_type
,
2379 const char *field_name
)
2383 struct bt_ctf_field_type_variant
*variant
;
2384 GQuark field_name_quark
= g_quark_from_string(field_name
);
2387 * TODO: check that `field_type` does not contain `type`,
2391 BT_LOGW_STR("Invalid parameter: field type is NULL.");
2397 BT_LOGW("Invalid parameter: field type is frozen: addr=%p",
2403 if (bt_ctf_validate_identifier(field_name
)) {
2404 BT_LOGW("Invalid parameter: field name is not a valid CTF identifier: "
2405 "variant-ft-addr=%p, field-name=\"%s\"",
2411 if (type
->id
!= BT_CTF_FIELD_TYPE_ID_VARIANT
) {
2412 BT_LOGW("Invalid parameter: field type is not a variant field type: "
2413 "addr=%p, ft-id=%s", type
,
2414 bt_ctf_field_type_id_string(type
->id
));
2419 if (type
== field_type
) {
2420 BT_LOGW("Invalid parameter: variant field type and field type to add are the same: "
2426 variant
= container_of(type
, struct bt_ctf_field_type_variant
, parent
);
2428 /* The user has explicitly provided a tag; validate against it. */
2432 /* Make sure this name is present in the enum tag */
2433 for (i
= 0; i
< variant
->tag
->entries
->len
; i
++) {
2434 struct enumeration_mapping
*mapping
=
2435 g_ptr_array_index(variant
->tag
->entries
, i
);
2437 if (mapping
->string
== field_name_quark
) {
2444 /* Validation failed */
2445 BT_LOGW("Invalid parameter: field name does not name a tag field type's mapping: "
2446 "variant-ft-addr=%p, tag-ft-addr=%p, "
2447 "tag-field-name=\"%s\""
2448 "field-ft-addr=%p, field-name=\"%s\"",
2449 type
, variant
->tag
, variant
->tag_name
->str
,
2450 field_type
, field_name
);
2456 if (add_structure_field(variant
->fields
, variant
->field_name_to_index
,
2457 field_type
, field_name
)) {
2458 BT_LOGW("Cannot add field to variant field type: "
2459 "variant-ft-addr=%p, field-ft-addr=%p, field-name=\"%s\"",
2460 type
, field_type
, field_name
);
2465 BT_LOGV("Added variant field type field: variant-ft-addr=%p, "
2466 "field-ft-addr=%p, field-name=\"%s\"", type
,
2467 field_type
, field_name
);
2473 struct bt_ctf_field_type
*bt_ctf_field_type_variant_get_field_type_by_name(
2474 struct bt_ctf_field_type
*type
,
2475 const char *field_name
)
2479 struct structure_field
*field
;
2480 struct bt_ctf_field_type_variant
*variant
;
2481 struct bt_ctf_field_type
*field_type
= NULL
;
2484 BT_LOGW_STR("Invalid parameter: field type is NULL.");
2489 BT_LOGW_STR("Invalid parameter: field name is NULL.");
2493 name_quark
= g_quark_try_string(field_name
);
2495 BT_LOGV("No such variant field type field name: "
2496 "ft-addr=%p, field-name=\"%s\"",
2501 variant
= container_of(type
, struct bt_ctf_field_type_variant
, parent
);
2502 if (!g_hash_table_lookup_extended(variant
->field_name_to_index
,
2503 GUINT_TO_POINTER(name_quark
), NULL
, (gpointer
*)&index
)) {
2504 BT_LOGV("No such variant field type field name: "
2505 "ft-addr=%p, field-name=\"%s\"",
2510 field
= g_ptr_array_index(variant
->fields
, index
);
2511 field_type
= field
->type
;
2517 struct bt_ctf_field_type
*bt_ctf_field_type_variant_get_field_type_from_tag(
2518 struct bt_ctf_field_type
*type
,
2519 struct bt_ctf_field
*tag
)
2522 const char *enum_value
;
2523 struct bt_ctf_field_type
*field_type
= NULL
;
2524 struct bt_ctf_field_type_enumeration_mapping_iterator
*iter
= NULL
;
2527 BT_LOGW_STR("Invalid parameter: variant field type is NULL.");
2532 BT_LOGW_STR("Invalid parameter: tag field is NULL.");
2536 if (type
->id
!= BT_CTF_FIELD_TYPE_ID_VARIANT
) {
2537 BT_LOGW("Invalid parameter: field type is not a variant field type: "
2538 "addr=%p, ft-id=%s", type
,
2539 bt_ctf_field_type_id_string(type
->id
));
2543 iter
= bt_ctf_field_enumeration_get_mappings(tag
);
2545 BT_LOGE("Cannot get enumeration field type mapping iterator from enumeration field: "
2546 "enum-field-addr=%p", tag
);
2550 ret
= bt_ctf_field_type_enumeration_mapping_iterator_get_signed(iter
,
2551 &enum_value
, NULL
, NULL
);
2553 BT_LOGW("Cannot get enumeration field type mapping iterator's current mapping: "
2554 "iter-addr=%p", iter
);
2558 field_type
= bt_ctf_field_type_variant_get_field_type_by_name(
2565 int64_t bt_ctf_field_type_variant_get_field_count(struct bt_ctf_field_type
*type
)
2568 struct bt_ctf_field_type_variant
*variant
;
2571 BT_LOGW_STR("Invalid parameter: field type is NULL.");
2576 if (type
->id
!= BT_CTF_FIELD_TYPE_ID_VARIANT
) {
2577 BT_LOGW("Invalid parameter: field type is not a variant field type: "
2578 "addr=%p, ft-id=%s", type
,
2579 bt_ctf_field_type_id_string(type
->id
));
2584 variant
= container_of(type
, struct bt_ctf_field_type_variant
,
2586 ret
= (int64_t) variant
->fields
->len
;
2592 int bt_ctf_field_type_variant_get_field_by_index(struct bt_ctf_field_type
*type
,
2593 const char **field_name
, struct bt_ctf_field_type
**field_type
,
2596 struct bt_ctf_field_type_variant
*variant
;
2597 struct structure_field
*field
;
2601 BT_LOGW_STR("Invalid parameter: field type is NULL.");
2606 if (type
->id
!= BT_CTF_FIELD_TYPE_ID_VARIANT
) {
2607 BT_LOGW("Invalid parameter: field type is not a variant field type: "
2608 "addr=%p, ft-id=%s", type
,
2609 bt_ctf_field_type_id_string(type
->id
));
2614 variant
= container_of(type
, struct bt_ctf_field_type_variant
,
2616 if (index
>= variant
->fields
->len
) {
2617 BT_LOGW("Invalid parameter: index is out of bounds: "
2618 "addr=%p, index=%" PRIu64
", count=%u",
2619 type
, index
, variant
->fields
->len
);
2624 field
= g_ptr_array_index(variant
->fields
, index
);
2626 *field_type
= field
->type
;
2627 bt_get(field
->type
);
2630 *field_name
= g_quark_to_string(field
->name
);
2631 assert(*field_name
);
2637 struct bt_ctf_field_type
*bt_ctf_field_type_array_create(
2638 struct bt_ctf_field_type
*element_type
,
2639 unsigned int length
)
2641 struct bt_ctf_field_type_array
*array
= NULL
;
2643 BT_LOGD("Creating array field type object: element-ft-addr=%p, "
2644 "length=%u", element_type
, length
);
2646 if (!element_type
) {
2647 BT_LOGW_STR("Invalid parameter: element field type is NULL.");
2652 BT_LOGW_STR("Invalid parameter: length is zero.");
2656 array
= g_new0(struct bt_ctf_field_type_array
, 1);
2658 BT_LOGE_STR("Failed to allocate one array field type.");
2662 array
->parent
.id
= BT_CTF_FIELD_TYPE_ID_ARRAY
;
2663 bt_get(element_type
);
2664 array
->element_type
= element_type
;
2665 array
->length
= length
;
2666 bt_ctf_field_type_init(&array
->parent
, FALSE
);
2667 BT_LOGD("Created array field type object: addr=%p, "
2668 "element-ft-addr=%p, length=%u",
2669 &array
->parent
, element_type
, length
);
2670 return &array
->parent
;
2675 struct bt_ctf_field_type
*bt_ctf_field_type_array_get_element_type(
2676 struct bt_ctf_field_type
*type
)
2678 struct bt_ctf_field_type
*ret
= NULL
;
2679 struct bt_ctf_field_type_array
*array
;
2682 BT_LOGW_STR("Invalid parameter: field type is NULL.");
2686 if (type
->id
!= BT_CTF_FIELD_TYPE_ID_ARRAY
) {
2687 BT_LOGW("Invalid parameter: field type is not an array field type: "
2688 "addr=%p, ft-id=%s", type
,
2689 bt_ctf_field_type_id_string(type
->id
));
2693 array
= container_of(type
, struct bt_ctf_field_type_array
, parent
);
2694 ret
= array
->element_type
;
2701 int bt_ctf_field_type_array_set_element_type(struct bt_ctf_field_type
*type
,
2702 struct bt_ctf_field_type
*element_type
)
2705 struct bt_ctf_field_type_array
*array
;
2708 BT_LOGW_STR("Invalid parameter: array field type is NULL.");
2713 if (!element_type
) {
2714 BT_LOGW_STR("Invalid parameter: element field type is NULL.");
2719 if (type
->id
!= BT_CTF_FIELD_TYPE_ID_ARRAY
) {
2720 BT_LOGW("Invalid parameter: field type is not an array field type: "
2721 "addr=%p, ft-id=%s", type
,
2722 bt_ctf_field_type_id_string(type
->id
));
2727 array
= container_of(type
, struct bt_ctf_field_type_array
, parent
);
2729 if (array
->element_type
) {
2730 BT_PUT(array
->element_type
);
2733 array
->element_type
= element_type
;
2734 bt_get(array
->element_type
);
2735 BT_LOGV("Set array field type's element field type: array-ft-addr=%p, "
2736 "element-ft-addr=%p", type
, element_type
);
2742 int64_t bt_ctf_field_type_array_get_length(struct bt_ctf_field_type
*type
)
2745 struct bt_ctf_field_type_array
*array
;
2748 BT_LOGW_STR("Invalid parameter: field type is NULL.");
2753 if (type
->id
!= BT_CTF_FIELD_TYPE_ID_ARRAY
) {
2754 BT_LOGW("Invalid parameter: field type is not an array field type: "
2755 "addr=%p, ft-id=%s", type
,
2756 bt_ctf_field_type_id_string(type
->id
));
2761 array
= container_of(type
, struct bt_ctf_field_type_array
, parent
);
2762 ret
= (int64_t) array
->length
;
2767 struct bt_ctf_field_type
*bt_ctf_field_type_sequence_create(
2768 struct bt_ctf_field_type
*element_type
,
2769 const char *length_field_name
)
2771 struct bt_ctf_field_type_sequence
*sequence
= NULL
;
2773 BT_LOGD("Creating sequence field type object: element-ft-addr=%p, "
2774 "length-field-name=\"%s\"", element_type
, length_field_name
);
2776 if (!element_type
) {
2777 BT_LOGW_STR("Invalid parameter: element field type is NULL.");
2781 if (bt_ctf_validate_identifier(length_field_name
)) {
2782 BT_LOGW("Invalid parameter: length field name is not a valid CTF identifier: "
2783 "length-field-name=\"%s\"", length_field_name
);
2787 sequence
= g_new0(struct bt_ctf_field_type_sequence
, 1);
2789 BT_LOGE_STR("Failed to allocate one sequence field type.");
2793 sequence
->parent
.id
= BT_CTF_FIELD_TYPE_ID_SEQUENCE
;
2794 bt_get(element_type
);
2795 sequence
->element_type
= element_type
;
2796 sequence
->length_field_name
= g_string_new(length_field_name
);
2797 bt_ctf_field_type_init(&sequence
->parent
, FALSE
);
2798 BT_LOGD("Created sequence field type object: addr=%p, "
2799 "element-ft-addr=%p, length-field-name=\"%s\"",
2800 &sequence
->parent
, element_type
, length_field_name
);
2801 return &sequence
->parent
;
2806 struct bt_ctf_field_type
*bt_ctf_field_type_sequence_get_element_type(
2807 struct bt_ctf_field_type
*type
)
2809 struct bt_ctf_field_type
*ret
= NULL
;
2810 struct bt_ctf_field_type_sequence
*sequence
;
2813 BT_LOGW_STR("Invalid parameter: field type is NULL.");
2817 if (type
->id
!= BT_CTF_FIELD_TYPE_ID_SEQUENCE
) {
2818 BT_LOGW("Invalid parameter: field type is not a sequence field type: "
2819 "addr=%p, ft-id=%s", type
,
2820 bt_ctf_field_type_id_string(type
->id
));
2824 sequence
= container_of(type
, struct bt_ctf_field_type_sequence
,
2826 ret
= sequence
->element_type
;
2833 int bt_ctf_field_type_sequence_set_element_type(struct bt_ctf_field_type
*type
,
2834 struct bt_ctf_field_type
*element_type
)
2837 struct bt_ctf_field_type_sequence
*sequence
;
2840 BT_LOGW_STR("Invalid parameter: sequence field type is NULL.");
2845 if (!element_type
) {
2846 BT_LOGW_STR("Invalid parameter: element field type is NULL.");
2851 if (type
->id
!= BT_CTF_FIELD_TYPE_ID_SEQUENCE
) {
2852 BT_LOGW("Invalid parameter: field type is not a sequence field type: "
2853 "addr=%p, ft-id=%s", type
,
2854 bt_ctf_field_type_id_string(type
->id
));
2859 sequence
= container_of(type
, struct bt_ctf_field_type_sequence
, parent
);
2860 if (sequence
->element_type
) {
2861 BT_PUT(sequence
->element_type
);
2864 sequence
->element_type
= element_type
;
2865 bt_get(sequence
->element_type
);
2866 BT_LOGV("Set sequence field type's element field type: sequence-ft-addr=%p, "
2867 "element-ft-addr=%p", type
, element_type
);
2873 const char *bt_ctf_field_type_sequence_get_length_field_name(
2874 struct bt_ctf_field_type
*type
)
2876 const char *ret
= NULL
;
2877 struct bt_ctf_field_type_sequence
*sequence
;
2880 BT_LOGW_STR("Invalid parameter: field type is NULL.");
2884 if (type
->id
!= BT_CTF_FIELD_TYPE_ID_SEQUENCE
) {
2885 BT_LOGW("Invalid parameter: field type is not a sequence field type: "
2886 "addr=%p, ft-id=%s", type
,
2887 bt_ctf_field_type_id_string(type
->id
));
2891 sequence
= container_of(type
, struct bt_ctf_field_type_sequence
,
2893 ret
= sequence
->length_field_name
->str
;
2898 struct bt_ctf_field_type
*bt_ctf_field_type_string_create(void)
2900 struct bt_ctf_field_type_string
*string
=
2901 g_new0(struct bt_ctf_field_type_string
, 1);
2903 BT_LOGD_STR("Creating string field type object.");
2906 BT_LOGE_STR("Failed to allocate one string field type.");
2910 string
->parent
.id
= BT_CTF_FIELD_TYPE_ID_STRING
;
2911 bt_ctf_field_type_init(&string
->parent
, TRUE
);
2912 string
->encoding
= BT_CTF_STRING_ENCODING_UTF8
;
2913 string
->parent
.alignment
= CHAR_BIT
;
2914 BT_LOGD("Created string field type object: addr=%p", &string
->parent
);
2915 return &string
->parent
;
2918 enum bt_ctf_string_encoding
bt_ctf_field_type_string_get_encoding(
2919 struct bt_ctf_field_type
*type
)
2921 struct bt_ctf_field_type_string
*string
;
2922 enum bt_ctf_string_encoding ret
= BT_CTF_STRING_ENCODING_UNKNOWN
;
2925 BT_LOGW_STR("Invalid parameter: field type is NULL.");
2929 if (type
->id
!= BT_CTF_FIELD_TYPE_ID_STRING
) {
2930 BT_LOGW("Invalid parameter: field type is not a string field type: "
2931 "addr=%p, ft-id=%s", type
,
2932 bt_ctf_field_type_id_string(type
->id
));
2936 string
= container_of(type
, struct bt_ctf_field_type_string
,
2938 ret
= string
->encoding
;
2943 int bt_ctf_field_type_string_set_encoding(struct bt_ctf_field_type
*type
,
2944 enum bt_ctf_string_encoding encoding
)
2947 struct bt_ctf_field_type_string
*string
;
2950 BT_LOGW_STR("Invalid parameter: field type is NULL.");
2955 if (type
->id
!= BT_CTF_FIELD_TYPE_ID_STRING
) {
2956 BT_LOGW("Invalid parameter: field type is not a string field type: "
2957 "addr=%p, ft-id=%s", type
,
2958 bt_ctf_field_type_id_string(type
->id
));
2963 if ((encoding
!= BT_CTF_STRING_ENCODING_UTF8
&&
2964 encoding
!= BT_CTF_STRING_ENCODING_ASCII
)) {
2965 BT_LOGW("Invalid parameter: unknown string encoding: "
2966 "addr=%p, encoding=%d", type
, encoding
);
2971 string
= container_of(type
, struct bt_ctf_field_type_string
, parent
);
2972 string
->encoding
= encoding
;
2973 BT_LOGV("Set string field type's encoding: addr=%p, encoding=%s",
2974 type
, bt_ctf_string_encoding_string(encoding
));
2979 int bt_ctf_field_type_get_alignment(struct bt_ctf_field_type
*type
)
2982 enum bt_ctf_field_type_id type_id
;
2985 BT_LOGW_STR("Invalid parameter: field type is NULL.");
2991 ret
= (int) type
->alignment
;
2995 type_id
= bt_ctf_field_type_get_type_id(type
);
2997 case BT_CTF_FIELD_TYPE_ID_SEQUENCE
:
2999 struct bt_ctf_field_type
*element
=
3000 bt_ctf_field_type_sequence_get_element_type(type
);
3003 ret
= bt_ctf_field_type_get_alignment(element
);
3007 case BT_CTF_FIELD_TYPE_ID_ARRAY
:
3009 struct bt_ctf_field_type
*element
=
3010 bt_ctf_field_type_array_get_element_type(type
);
3013 ret
= bt_ctf_field_type_get_alignment(element
);
3017 case BT_CTF_FIELD_TYPE_ID_STRUCT
:
3019 int64_t i
, element_count
;
3021 element_count
= bt_ctf_field_type_structure_get_field_count(
3023 assert(element_count
>= 0);
3025 for (i
= 0; i
< element_count
; i
++) {
3026 struct bt_ctf_field_type
*field
;
3027 int field_alignment
;
3029 ret
= bt_ctf_field_type_structure_get_field_by_index(
3030 type
, NULL
, &field
, i
);
3033 field_alignment
= bt_ctf_field_type_get_alignment(
3036 if (field_alignment
< 0) {
3037 ret
= field_alignment
;
3041 type
->alignment
= MAX(field_alignment
, type
->alignment
);
3043 ret
= (int) type
->alignment
;
3046 case BT_CTF_FIELD_TYPE_ID_UNKNOWN
:
3047 BT_LOGW("Invalid parameter: unknown field type ID: "
3048 "addr=%p, ft-id=%d", type
, type_id
);
3052 ret
= (int) type
->alignment
;
3060 int is_power_of_two(unsigned int value
)
3062 return ((value
& (value
- 1)) == 0) && value
> 0;
3065 int bt_ctf_field_type_set_alignment(struct bt_ctf_field_type
*type
,
3066 unsigned int alignment
)
3069 enum bt_ctf_field_type_id type_id
;
3071 /* Alignment must be a power of two */
3073 BT_LOGW_STR("Invalid parameter: field type is NULL.");
3079 BT_LOGW("Invalid parameter: field type is frozen: addr=%p",
3085 if (!is_power_of_two(alignment
)) {
3086 BT_LOGW("Invalid parameter: alignment is not a power of two: "
3087 "addr=%p, align=%u", type
, alignment
);
3092 type_id
= bt_ctf_field_type_get_type_id(type
);
3093 if (type_id
== BT_CTF_FIELD_TYPE_ID_UNKNOWN
) {
3094 BT_LOGW("Invalid parameter: unknown field type ID: "
3095 "addr=%p, ft-id=%d", type
, type_id
);
3100 if (type
->id
== BT_CTF_FIELD_TYPE_ID_STRING
&&
3101 alignment
!= CHAR_BIT
) {
3102 BT_LOGW("Invalid parameter: alignment must be %u for a string field type: "
3103 "addr=%p, align=%u", CHAR_BIT
, type
, alignment
);
3108 if (type_id
== BT_CTF_FIELD_TYPE_ID_VARIANT
||
3109 type_id
== BT_CTF_FIELD_TYPE_ID_SEQUENCE
||
3110 type_id
== BT_CTF_FIELD_TYPE_ID_ARRAY
) {
3111 /* Setting an alignment on these types makes no sense */
3112 BT_LOGW("Invalid parameter: cannot set the alignment of this field type: "
3113 "addr=%p, ft-id=%s", type
,
3114 bt_ctf_field_type_id_string(type
->id
));
3119 type
->alignment
= alignment
;
3121 BT_LOGV("Set field type's alignment: addr=%p, align=%u",
3127 enum bt_ctf_byte_order
bt_ctf_field_type_get_byte_order(
3128 struct bt_ctf_field_type
*type
)
3130 enum bt_ctf_byte_order ret
= BT_CTF_BYTE_ORDER_UNKNOWN
;
3133 BT_LOGW_STR("Invalid parameter: field type is NULL.");
3138 case BT_CTF_FIELD_TYPE_ID_INTEGER
:
3140 struct bt_ctf_field_type_integer
*integer
= container_of(
3141 type
, struct bt_ctf_field_type_integer
, parent
);
3142 ret
= integer
->user_byte_order
;
3145 case BT_CTF_FIELD_TYPE_ID_ENUM
:
3147 struct bt_ctf_field_type_enumeration
*enum_ft
= container_of(
3148 type
, struct bt_ctf_field_type_enumeration
, parent
);
3149 ret
= bt_ctf_field_type_get_byte_order(enum_ft
->container
);
3152 case BT_CTF_FIELD_TYPE_ID_FLOAT
:
3154 struct bt_ctf_field_type_floating_point
*floating_point
=
3156 struct bt_ctf_field_type_floating_point
,
3158 ret
= floating_point
->user_byte_order
;
3162 BT_LOGW("Invalid parameter: cannot get the byte order of this field type: "
3163 "addr=%p, ft-id=%s", type
,
3164 bt_ctf_field_type_id_string(type
->id
));
3168 assert(ret
== BT_CTF_BYTE_ORDER_NATIVE
||
3169 ret
== BT_CTF_BYTE_ORDER_LITTLE_ENDIAN
||
3170 ret
== BT_CTF_BYTE_ORDER_BIG_ENDIAN
||
3171 ret
== BT_CTF_BYTE_ORDER_NETWORK
);
3177 int bt_ctf_field_type_set_byte_order(struct bt_ctf_field_type
*type
,
3178 enum bt_ctf_byte_order byte_order
)
3183 BT_LOGW_STR("Invalid parameter: field type is NULL.");
3189 BT_LOGW("Invalid parameter: field type is frozen: addr=%p",
3195 if (byte_order
!= BT_CTF_BYTE_ORDER_NATIVE
&&
3196 byte_order
!= BT_CTF_BYTE_ORDER_LITTLE_ENDIAN
&&
3197 byte_order
!= BT_CTF_BYTE_ORDER_BIG_ENDIAN
&&
3198 byte_order
!= BT_CTF_BYTE_ORDER_NETWORK
) {
3199 BT_LOGW("Invalid parameter: unknown byte order: "
3200 "addr=%p, bo=%s", type
,
3201 bt_ctf_byte_order_string(byte_order
));
3206 if (set_byte_order_funcs
[type
->id
]) {
3207 set_byte_order_funcs
[type
->id
](type
, byte_order
);
3210 BT_LOGV("Set field type's byte order: addr=%p, bo=%s",
3211 type
, bt_ctf_byte_order_string(byte_order
));
3217 enum bt_ctf_field_type_id
bt_ctf_field_type_get_type_id(
3218 struct bt_ctf_field_type
*type
)
3221 BT_LOGW_STR("Invalid parameter: field type is NULL.");
3222 return BT_CTF_FIELD_TYPE_ID_UNKNOWN
;
3228 int bt_ctf_field_type_is_integer(struct bt_ctf_field_type
*type
)
3230 return bt_ctf_field_type_get_type_id(type
) == BT_CTF_FIELD_TYPE_ID_INTEGER
;
3233 int bt_ctf_field_type_is_floating_point(struct bt_ctf_field_type
*type
)
3235 return bt_ctf_field_type_get_type_id(type
) == BT_CTF_FIELD_TYPE_ID_FLOAT
;
3238 int bt_ctf_field_type_is_enumeration(struct bt_ctf_field_type
*type
)
3240 return bt_ctf_field_type_get_type_id(type
) == BT_CTF_FIELD_TYPE_ID_ENUM
;
3243 int bt_ctf_field_type_is_string(struct bt_ctf_field_type
*type
)
3245 return bt_ctf_field_type_get_type_id(type
) == BT_CTF_FIELD_TYPE_ID_STRING
;
3248 int bt_ctf_field_type_is_structure(struct bt_ctf_field_type
*type
)
3250 return bt_ctf_field_type_get_type_id(type
) == BT_CTF_FIELD_TYPE_ID_STRUCT
;
3253 int bt_ctf_field_type_is_array(struct bt_ctf_field_type
*type
)
3255 return bt_ctf_field_type_get_type_id(type
) == BT_CTF_FIELD_TYPE_ID_ARRAY
;
3258 int bt_ctf_field_type_is_sequence(struct bt_ctf_field_type
*type
)
3260 return bt_ctf_field_type_get_type_id(type
) == BT_CTF_FIELD_TYPE_ID_SEQUENCE
;
3263 int bt_ctf_field_type_is_variant(struct bt_ctf_field_type
*type
)
3265 return bt_ctf_field_type_get_type_id(type
) == BT_CTF_FIELD_TYPE_ID_VARIANT
;
3268 /* Pre-2.0 CTF writer backward compatibility */
3269 void bt_ctf_field_type_get(struct bt_ctf_field_type
*type
)
3274 /* Pre-2.0 CTF writer backward compatibility */
3275 void bt_ctf_field_type_put(struct bt_ctf_field_type
*type
)
3281 void bt_ctf_field_type_freeze(struct bt_ctf_field_type
*type
)
3283 if (!type
|| type
->frozen
) {
3291 struct bt_ctf_field_type
*bt_ctf_field_type_variant_get_field_type_signed(
3292 struct bt_ctf_field_type_variant
*variant
,
3295 struct bt_ctf_field_type
*type
= NULL
;
3296 GQuark field_name_quark
;
3298 struct structure_field
*field_entry
;
3299 struct range_overlap_query query
= {
3300 .range_start
._signed
= tag_value
,
3301 .range_end
._signed
= tag_value
,
3306 g_ptr_array_foreach(variant
->tag
->entries
, check_ranges_overlap
,
3308 if (!query
.overlaps
) {
3312 field_name_quark
= query
.mapping_name
;
3313 if (!g_hash_table_lookup_extended(variant
->field_name_to_index
,
3314 GUINT_TO_POINTER(field_name_quark
), NULL
, &index
)) {
3318 field_entry
= g_ptr_array_index(variant
->fields
, (size_t) index
);
3319 type
= field_entry
->type
;
3325 struct bt_ctf_field_type
*bt_ctf_field_type_variant_get_field_type_unsigned(
3326 struct bt_ctf_field_type_variant
*variant
,
3329 struct bt_ctf_field_type
*type
= NULL
;
3330 GQuark field_name_quark
;
3332 struct structure_field
*field_entry
;
3333 struct range_overlap_query query
= {
3334 .range_start
._unsigned
= tag_value
,
3335 .range_end
._unsigned
= tag_value
,
3340 g_ptr_array_foreach(variant
->tag
->entries
,
3341 check_ranges_overlap_unsigned
,
3343 if (!query
.overlaps
) {
3347 field_name_quark
= query
.mapping_name
;
3348 if (!g_hash_table_lookup_extended(variant
->field_name_to_index
,
3349 GUINT_TO_POINTER(field_name_quark
), NULL
, &index
)) {
3353 field_entry
= g_ptr_array_index(variant
->fields
, (size_t)index
);
3354 type
= field_entry
->type
;
3360 int bt_ctf_field_type_serialize(struct bt_ctf_field_type
*type
,
3361 struct metadata_context
*context
)
3368 /* Make sure field type is valid before serializing it */
3369 ret
= bt_ctf_field_type_validate(type
);
3371 BT_LOGW("Cannot serialize field type's metadata: field type is invalid: "
3376 ret
= type
->serialize(type
, context
);
3381 struct bt_ctf_field_type
*bt_ctf_field_type_copy(struct bt_ctf_field_type
*type
)
3383 struct bt_ctf_field_type
*copy
= NULL
;
3386 BT_LOGW_STR("Invalid parameter: field type is NULL.");
3390 copy
= type_copy_funcs
[type
->id
](type
);
3392 BT_LOGE_STR("Cannot copy field type.");
3396 copy
->alignment
= type
->alignment
;
3402 int bt_ctf_field_type_structure_get_field_name_index(
3403 struct bt_ctf_field_type
*type
, const char *name
)
3408 struct bt_ctf_field_type_structure
*structure
;
3411 BT_LOGW_STR("Invalid parameter: field type is NULL.");
3417 BT_LOGW_STR("Invalid parameter: field name is NULL.");
3422 if (bt_ctf_field_type_get_type_id(type
) != BT_CTF_FIELD_TYPE_ID_STRUCT
) {
3423 BT_LOGW("Invalid parameter: field type is not a structure field type: "
3424 "addr=%p, ft-id=%s", type
,
3425 bt_ctf_field_type_id_string(type
->id
));
3430 name_quark
= g_quark_try_string(name
);
3432 BT_LOGV("No such structure field type field name: "
3433 "ft-addr=%p, field-name=\"%s\"",
3439 structure
= container_of(type
, struct bt_ctf_field_type_structure
,
3441 if (!g_hash_table_lookup_extended(structure
->field_name_to_index
,
3442 GUINT_TO_POINTER(name_quark
),
3443 NULL
, (gpointer
*)&index
)) {
3444 BT_LOGV("No such structure field type field name: "
3445 "ft-addr=%p, field-name=\"%s\"",
3456 int bt_ctf_field_type_variant_get_field_name_index(
3457 struct bt_ctf_field_type
*type
, const char *name
)
3462 struct bt_ctf_field_type_variant
*variant
;
3465 BT_LOGW_STR("Invalid parameter: variant field type is NULL.");
3471 BT_LOGW_STR("Invalid parameter: field name is NULL.");
3476 if (bt_ctf_field_type_get_type_id(type
) != BT_CTF_FIELD_TYPE_ID_VARIANT
) {
3477 BT_LOGW("Invalid parameter: field type is not a variant field type: "
3478 "addr=%p, ft-id=%s", type
,
3479 bt_ctf_field_type_id_string(type
->id
));
3484 name_quark
= g_quark_try_string(name
);
3486 BT_LOGV("No such variant field type field name: "
3487 "ft-addr=%p, field-name=\"%s\"",
3493 variant
= container_of(type
, struct bt_ctf_field_type_variant
,
3495 if (!g_hash_table_lookup_extended(variant
->field_name_to_index
,
3496 GUINT_TO_POINTER(name_quark
),
3497 NULL
, (gpointer
*)&index
)) {
3498 BT_LOGV("No such variant field type field name: "
3499 "ft-addr=%p, field-name=\"%s\"",
3510 int bt_ctf_field_type_sequence_set_length_field_path(
3511 struct bt_ctf_field_type
*type
,
3512 struct bt_ctf_field_path
*path
)
3515 struct bt_ctf_field_type_sequence
*sequence
;
3518 BT_LOGW_STR("Invalid parameter: field type is NULL.");
3523 if (bt_ctf_field_type_get_type_id(type
) != BT_CTF_FIELD_TYPE_ID_SEQUENCE
) {
3524 BT_LOGW("Invalid parameter: field type is not a sequence field type: "
3525 "addr=%p, ft-id=%s", type
,
3526 bt_ctf_field_type_id_string(type
->id
));
3531 sequence
= container_of(type
, struct bt_ctf_field_type_sequence
,
3534 BT_MOVE(sequence
->length_field_path
, path
);
3535 BT_LOGV("Set sequence field type's length field path: ft-addr=%p, "
3536 "field-path-addr=%p", type
, path
);
3542 int bt_ctf_field_type_variant_set_tag_field_path(struct bt_ctf_field_type
*type
,
3543 struct bt_ctf_field_path
*path
)
3546 struct bt_ctf_field_type_variant
*variant
;
3549 BT_LOGW_STR("Invalid parameter: field type is NULL.");
3554 if (bt_ctf_field_type_get_type_id(type
) != BT_CTF_FIELD_TYPE_ID_VARIANT
) {
3555 BT_LOGW("Invalid parameter: field type is not a variant field type: "
3556 "addr=%p, ft-id=%s", type
,
3557 bt_ctf_field_type_id_string(type
->id
));
3562 variant
= container_of(type
, struct bt_ctf_field_type_variant
,
3565 BT_MOVE(variant
->tag_field_path
, path
);
3566 BT_LOGV("Set variant field type's tag field path: ft-addr=%p, "
3567 "field-path-addr=%p", type
, path
);
3573 int bt_ctf_field_type_variant_set_tag_field_type(struct bt_ctf_field_type
*type
,
3574 struct bt_ctf_field_type
*tag
)
3577 struct bt_ctf_field_type_variant
*variant
;
3580 BT_LOGW_STR("Invalid parameter: variant field type is NULL.");
3586 BT_LOGW_STR("Invalid parameter: tag field type is NULL.");
3591 if (bt_ctf_field_type_get_type_id(tag
) != BT_CTF_FIELD_TYPE_ID_ENUM
) {
3592 BT_LOGW("Invalid parameter: field type is not an enumeration field type: "
3593 "addr=%p, ft-id=%s", type
,
3594 bt_ctf_field_type_id_string(type
->id
));
3599 variant
= container_of(type
, struct bt_ctf_field_type_variant
,
3603 bt_put(&variant
->tag
->parent
);
3605 variant
->tag
= container_of(tag
, struct bt_ctf_field_type_enumeration
,
3607 BT_LOGV("Set variant field type's tag field type: variant-ft-addr=%p, "
3608 "tag-ft-addr=%p", type
, tag
);
3614 void bt_ctf_field_type_integer_destroy(struct bt_ctf_field_type
*type
)
3616 struct bt_ctf_field_type_integer
*integer
=
3617 (struct bt_ctf_field_type_integer
*) type
;
3623 BT_LOGD("Destroying integer field type object: addr=%p", type
);
3624 BT_LOGD_STR("Putting mapped clock class.");
3625 bt_put(integer
->mapped_clock
);
3630 void bt_ctf_field_type_enumeration_destroy(struct bt_ctf_field_type
*type
)
3632 struct bt_ctf_field_type_enumeration
*enumeration
=
3633 (struct bt_ctf_field_type_enumeration
*) type
;
3639 BT_LOGD("Destroying enumeration field type object: addr=%p", type
);
3640 g_ptr_array_free(enumeration
->entries
, TRUE
);
3641 BT_LOGD_STR("Putting container field type.");
3642 bt_put(enumeration
->container
);
3643 g_free(enumeration
);
3647 void bt_ctf_field_type_floating_point_destroy(struct bt_ctf_field_type
*type
)
3649 struct bt_ctf_field_type_floating_point
*floating_point
=
3650 (struct bt_ctf_field_type_floating_point
*) type
;
3656 BT_LOGD("Destroying floating point number field type object: addr=%p", type
);
3657 g_free(floating_point
);
3661 void bt_ctf_field_type_structure_destroy(struct bt_ctf_field_type
*type
)
3663 struct bt_ctf_field_type_structure
*structure
=
3664 (struct bt_ctf_field_type_structure
*) type
;
3670 BT_LOGD("Destroying structure field type object: addr=%p", type
);
3671 g_ptr_array_free(structure
->fields
, TRUE
);
3672 g_hash_table_destroy(structure
->field_name_to_index
);
3677 void bt_ctf_field_type_variant_destroy(struct bt_ctf_field_type
*type
)
3679 struct bt_ctf_field_type_variant
*variant
=
3680 (struct bt_ctf_field_type_variant
*) type
;
3686 BT_LOGD("Destroying variant field type object: addr=%p", type
);
3687 g_ptr_array_free(variant
->fields
, TRUE
);
3688 g_hash_table_destroy(variant
->field_name_to_index
);
3689 g_string_free(variant
->tag_name
, TRUE
);
3690 BT_LOGD_STR("Putting tag field type.");
3691 bt_put(&variant
->tag
->parent
);
3692 BT_PUT(variant
->tag_field_path
);
3697 void bt_ctf_field_type_array_destroy(struct bt_ctf_field_type
*type
)
3699 struct bt_ctf_field_type_array
*array
=
3700 (struct bt_ctf_field_type_array
*) type
;
3706 BT_LOGD("Destroying array field type object: addr=%p", type
);
3707 BT_LOGD_STR("Putting element field type.");
3708 bt_put(array
->element_type
);
3713 void bt_ctf_field_type_sequence_destroy(struct bt_ctf_field_type
*type
)
3715 struct bt_ctf_field_type_sequence
*sequence
=
3716 (struct bt_ctf_field_type_sequence
*) type
;
3722 BT_LOGD("Destroying sequence field type object: addr=%p", type
);
3723 BT_LOGD_STR("Putting element field type.");
3724 bt_put(sequence
->element_type
);
3725 g_string_free(sequence
->length_field_name
, TRUE
);
3726 BT_LOGD_STR("Putting length field path.");
3727 BT_PUT(sequence
->length_field_path
);
3732 void bt_ctf_field_type_string_destroy(struct bt_ctf_field_type
*type
)
3734 struct bt_ctf_field_type_string
*string
=
3735 (struct bt_ctf_field_type_string
*) type
;
3741 BT_LOGD("Destroying string field type object: addr=%p", type
);
3746 void generic_field_type_freeze(struct bt_ctf_field_type
*type
)
3752 void bt_ctf_field_type_integer_freeze(struct bt_ctf_field_type
*type
)
3754 struct bt_ctf_field_type_integer
*integer_type
= container_of(
3755 type
, struct bt_ctf_field_type_integer
, parent
);
3757 BT_LOGD("Freezing integer field type object: addr=%p", type
);
3759 if (integer_type
->mapped_clock
) {
3760 BT_LOGD_STR("Freezing integer field type's mapped clock class.");
3761 bt_ctf_clock_class_freeze(integer_type
->mapped_clock
);
3764 generic_field_type_freeze(type
);
3768 void bt_ctf_field_type_enumeration_freeze(struct bt_ctf_field_type
*type
)
3770 struct bt_ctf_field_type_enumeration
*enumeration_type
= container_of(
3771 type
, struct bt_ctf_field_type_enumeration
, parent
);
3773 BT_LOGD("Freezing enumeration field type object: addr=%p", type
);
3774 set_enumeration_range_overlap(type
);
3775 generic_field_type_freeze(type
);
3776 BT_LOGD("Freezing enumeration field type object's container field type: int-ft-addr=%p",
3777 enumeration_type
->container
);
3778 bt_ctf_field_type_freeze(enumeration_type
->container
);
3782 void freeze_structure_field(struct structure_field
*field
)
3784 BT_LOGD("Freezing structure/variant field type field: field-addr=%p, "
3785 "field-ft-addr=%p, field-name=\"%s\"", field
,
3786 field
->type
, g_quark_to_string(field
->name
));
3787 bt_ctf_field_type_freeze(field
->type
);
3791 void bt_ctf_field_type_structure_freeze(struct bt_ctf_field_type
*type
)
3793 struct bt_ctf_field_type_structure
*structure_type
= container_of(
3794 type
, struct bt_ctf_field_type_structure
, parent
);
3796 /* Cache the alignment */
3797 BT_LOGD("Freezing structure field type object: addr=%p", type
);
3798 type
->alignment
= bt_ctf_field_type_get_alignment(type
);
3799 generic_field_type_freeze(type
);
3800 g_ptr_array_foreach(structure_type
->fields
,
3801 (GFunc
) freeze_structure_field
, NULL
);
3805 void bt_ctf_field_type_variant_freeze(struct bt_ctf_field_type
*type
)
3807 struct bt_ctf_field_type_variant
*variant_type
= container_of(
3808 type
, struct bt_ctf_field_type_variant
, parent
);
3810 BT_LOGD("Freezing variant field type object: addr=%p", type
);
3811 generic_field_type_freeze(type
);
3812 g_ptr_array_foreach(variant_type
->fields
,
3813 (GFunc
) freeze_structure_field
, NULL
);
3817 void bt_ctf_field_type_array_freeze(struct bt_ctf_field_type
*type
)
3819 struct bt_ctf_field_type_array
*array_type
= container_of(
3820 type
, struct bt_ctf_field_type_array
, parent
);
3822 /* Cache the alignment */
3823 BT_LOGD("Freezing array field type object: addr=%p", type
);
3824 type
->alignment
= bt_ctf_field_type_get_alignment(type
);
3825 generic_field_type_freeze(type
);
3826 BT_LOGD("Freezing array field type object's element field type: element-ft-addr=%p",
3827 array_type
->element_type
);
3828 bt_ctf_field_type_freeze(array_type
->element_type
);
3832 void bt_ctf_field_type_sequence_freeze(struct bt_ctf_field_type
*type
)
3834 struct bt_ctf_field_type_sequence
*sequence_type
= container_of(
3835 type
, struct bt_ctf_field_type_sequence
, parent
);
3837 /* Cache the alignment */
3838 BT_LOGD("Freezing sequence field type object: addr=%p", type
);
3839 type
->alignment
= bt_ctf_field_type_get_alignment(type
);
3840 generic_field_type_freeze(type
);
3841 BT_LOGD("Freezing sequence field type object's element field type: element-ft-addr=%p",
3842 sequence_type
->element_type
);
3843 bt_ctf_field_type_freeze(sequence_type
->element_type
);
3847 const char *get_encoding_string(enum bt_ctf_string_encoding encoding
)
3849 const char *encoding_string
;
3852 case BT_CTF_STRING_ENCODING_NONE
:
3853 encoding_string
= "none";
3855 case BT_CTF_STRING_ENCODING_ASCII
:
3856 encoding_string
= "ASCII";
3858 case BT_CTF_STRING_ENCODING_UTF8
:
3859 encoding_string
= "UTF8";
3862 encoding_string
= "unknown";
3866 return encoding_string
;
3870 const char *get_integer_base_string(enum bt_ctf_integer_base base
)
3872 const char *base_string
;
3875 case BT_CTF_INTEGER_BASE_DECIMAL
:
3876 base_string
= "decimal";
3878 case BT_CTF_INTEGER_BASE_HEXADECIMAL
:
3879 base_string
= "hexadecimal";
3881 case BT_CTF_INTEGER_BASE_OCTAL
:
3882 base_string
= "octal";
3884 case BT_CTF_INTEGER_BASE_BINARY
:
3885 base_string
= "binary";
3888 base_string
= "unknown";
3896 int bt_ctf_field_type_integer_serialize(struct bt_ctf_field_type
*type
,
3897 struct metadata_context
*context
)
3899 struct bt_ctf_field_type_integer
*integer
= container_of(type
,
3900 struct bt_ctf_field_type_integer
, parent
);
3903 BT_LOGD("Serializing integer field type's metadata: "
3904 "ft-addr=%p, metadata-context-addr=%p", type
, context
);
3905 g_string_append_printf(context
->string
,
3906 "integer { size = %u; align = %u; signed = %s; encoding = %s; base = %s; byte_order = %s",
3907 integer
->size
, type
->alignment
,
3908 (integer
->is_signed
? "true" : "false"),
3909 get_encoding_string(integer
->encoding
),
3910 get_integer_base_string(integer
->base
),
3911 get_byte_order_string(integer
->user_byte_order
));
3912 if (integer
->mapped_clock
) {
3913 const char *clock_name
= bt_ctf_clock_class_get_name(
3914 integer
->mapped_clock
);
3917 g_string_append_printf(context
->string
,
3918 "; map = clock.%s.value", clock_name
);
3921 g_string_append(context
->string
, "; }");
3926 int bt_ctf_field_type_enumeration_serialize(struct bt_ctf_field_type
*type
,
3927 struct metadata_context
*context
)
3931 struct bt_ctf_field_type_enumeration
*enumeration
= container_of(type
,
3932 struct bt_ctf_field_type_enumeration
, parent
);
3933 struct bt_ctf_field_type
*container_type
;
3934 int container_signed
;
3936 BT_LOGD("Serializing enumeration field type's metadata: "
3937 "ft-addr=%p, metadata-context-addr=%p", type
, context
);
3938 container_type
= bt_ctf_field_type_enumeration_get_container_type(type
);
3939 assert(container_type
);
3940 container_signed
= bt_ctf_field_type_integer_get_signed(container_type
);
3941 assert(container_signed
>= 0);
3942 g_string_append(context
->string
, "enum : ");
3943 BT_LOGD_STR("Serializing enumeration field type's container field type's metadata.");
3944 ret
= bt_ctf_field_type_serialize(enumeration
->container
, context
);
3946 BT_LOGW("Cannot serialize enumeration field type's container field type's metadata: "
3947 "container-ft-addr=%p", enumeration
->container
);
3951 g_string_append(context
->string
, " { ");
3952 for (entry
= 0; entry
< enumeration
->entries
->len
; entry
++) {
3953 struct enumeration_mapping
*mapping
=
3954 enumeration
->entries
->pdata
[entry
];
3956 if (container_signed
) {
3957 if (mapping
->range_start
._signed
==
3958 mapping
->range_end
._signed
) {
3959 g_string_append_printf(context
->string
,
3960 "\"%s\" = %" PRId64
,
3961 g_quark_to_string(mapping
->string
),
3962 mapping
->range_start
._signed
);
3964 g_string_append_printf(context
->string
,
3965 "\"%s\" = %" PRId64
" ... %" PRId64
,
3966 g_quark_to_string(mapping
->string
),
3967 mapping
->range_start
._signed
,
3968 mapping
->range_end
._signed
);
3971 if (mapping
->range_start
._unsigned
==
3972 mapping
->range_end
._unsigned
) {
3973 g_string_append_printf(context
->string
,
3974 "\"%s\" = %" PRIu64
,
3975 g_quark_to_string(mapping
->string
),
3976 mapping
->range_start
._unsigned
);
3978 g_string_append_printf(context
->string
,
3979 "\"%s\" = %" PRIu64
" ... %" PRIu64
,
3980 g_quark_to_string(mapping
->string
),
3981 mapping
->range_start
._unsigned
,
3982 mapping
->range_end
._unsigned
);
3986 g_string_append(context
->string
,
3987 ((entry
!= (enumeration
->entries
->len
- 1)) ?
3991 if (context
->field_name
->len
) {
3992 g_string_append_printf(context
->string
, " %s",
3993 context
->field_name
->str
);
3994 g_string_assign(context
->field_name
, "");
3997 bt_put(container_type
);
4002 int bt_ctf_field_type_floating_point_serialize(struct bt_ctf_field_type
*type
,
4003 struct metadata_context
*context
)
4005 struct bt_ctf_field_type_floating_point
*floating_point
= container_of(
4006 type
, struct bt_ctf_field_type_floating_point
, parent
);
4008 BT_LOGD("Serializing floating point number field type's metadata: "
4009 "ft-addr=%p, metadata-context-addr=%p", type
, context
);
4010 g_string_append_printf(context
->string
,
4011 "floating_point { exp_dig = %u; mant_dig = %u; byte_order = %s; align = %u; }",
4012 floating_point
->exp_dig
,
4013 floating_point
->mant_dig
,
4014 get_byte_order_string(floating_point
->user_byte_order
),
4020 int bt_ctf_field_type_structure_serialize(struct bt_ctf_field_type
*type
,
4021 struct metadata_context
*context
)
4024 unsigned int indent
;
4026 struct bt_ctf_field_type_structure
*structure
= container_of(type
,
4027 struct bt_ctf_field_type_structure
, parent
);
4028 GString
*structure_field_name
= context
->field_name
;
4030 BT_LOGD("Serializing structure field type's metadata: "
4031 "ft-addr=%p, metadata-context-addr=%p", type
, context
);
4032 context
->field_name
= g_string_new("");
4034 context
->current_indentation_level
++;
4035 g_string_append(context
->string
, "struct {\n");
4037 for (i
= 0; i
< structure
->fields
->len
; i
++) {
4038 struct structure_field
*field
= structure
->fields
->pdata
[i
];
4040 BT_LOGD("Serializing structure field type's field metadata: "
4041 "index=%" PRId64
", "
4042 "field-ft-addr=%p, field-name=\"%s\"",
4043 i
, field
, g_quark_to_string(field
->name
));
4045 for (indent
= 0; indent
< context
->current_indentation_level
;
4047 g_string_append_c(context
->string
, '\t');
4050 g_string_assign(context
->field_name
,
4051 g_quark_to_string(field
->name
));
4052 ret
= bt_ctf_field_type_serialize(field
->type
, context
);
4054 BT_LOGW("Cannot serialize structure field type's field's metadata: "
4055 "index=%" PRId64
", "
4056 "field-ft-addr=%p, field-name=\"%s\"",
4058 g_quark_to_string(field
->name
));
4062 if (context
->field_name
->len
) {
4063 g_string_append_printf(context
->string
, " %s",
4064 context
->field_name
->str
);
4066 g_string_append(context
->string
, ";\n");
4069 context
->current_indentation_level
--;
4070 for (indent
= 0; indent
< context
->current_indentation_level
;
4072 g_string_append_c(context
->string
, '\t');
4075 g_string_append_printf(context
->string
, "} align(%u)",
4078 g_string_free(context
->field_name
, TRUE
);
4079 context
->field_name
= structure_field_name
;
4084 int bt_ctf_field_type_variant_serialize(struct bt_ctf_field_type
*type
,
4085 struct metadata_context
*context
)
4088 unsigned int indent
;
4090 struct bt_ctf_field_type_variant
*variant
= container_of(
4091 type
, struct bt_ctf_field_type_variant
, parent
);
4092 GString
*variant_field_name
= context
->field_name
;
4094 BT_LOGD("Serializing variant field type's metadata: "
4095 "ft-addr=%p, metadata-context-addr=%p", type
, context
);
4096 context
->field_name
= g_string_new("");
4097 if (variant
->tag_name
->len
> 0) {
4098 g_string_append_printf(context
->string
,
4099 "variant <%s> {\n", variant
->tag_name
->str
);
4101 g_string_append(context
->string
, "variant {\n");
4104 context
->current_indentation_level
++;
4105 for (i
= 0; i
< variant
->fields
->len
; i
++) {
4106 struct structure_field
*field
= variant
->fields
->pdata
[i
];
4108 BT_LOGD("Serializing variant field type's field metadata: "
4109 "index=%" PRId64
", "
4110 "field-ft-addr=%p, field-name=\"%s\"",
4111 i
, field
, g_quark_to_string(field
->name
));
4113 g_string_assign(context
->field_name
,
4114 g_quark_to_string(field
->name
));
4115 for (indent
= 0; indent
< context
->current_indentation_level
;
4117 g_string_append_c(context
->string
, '\t');
4120 g_string_assign(context
->field_name
,
4121 g_quark_to_string(field
->name
));
4122 ret
= bt_ctf_field_type_serialize(field
->type
, context
);
4124 BT_LOGW("Cannot serialize variant field type's field's metadata: "
4125 "index=%" PRId64
", "
4126 "field-ft-addr=%p, field-name=\"%s\"",
4128 g_quark_to_string(field
->name
));
4132 if (context
->field_name
->len
) {
4133 g_string_append_printf(context
->string
, " %s;",
4134 context
->field_name
->str
);
4137 g_string_append_c(context
->string
, '\n');
4140 context
->current_indentation_level
--;
4141 for (indent
= 0; indent
< context
->current_indentation_level
;
4143 g_string_append_c(context
->string
, '\t');
4146 g_string_append(context
->string
, "}");
4148 g_string_free(context
->field_name
, TRUE
);
4149 context
->field_name
= variant_field_name
;
4154 int bt_ctf_field_type_array_serialize(struct bt_ctf_field_type
*type
,
4155 struct metadata_context
*context
)
4158 struct bt_ctf_field_type_array
*array
= container_of(type
,
4159 struct bt_ctf_field_type_array
, parent
);
4161 BT_LOGD("Serializing array field type's metadata: "
4162 "ft-addr=%p, metadata-context-addr=%p", type
, context
);
4163 BT_LOGD_STR("Serializing array field type's element field type's metadata.");
4164 ret
= bt_ctf_field_type_serialize(array
->element_type
, context
);
4166 BT_LOGW("Cannot serialize array field type's element field type's metadata: "
4167 "element-ft-addr=%p", array
->element_type
);
4171 if (context
->field_name
->len
) {
4172 g_string_append_printf(context
->string
, " %s[%u]",
4173 context
->field_name
->str
, array
->length
);
4174 g_string_assign(context
->field_name
, "");
4176 g_string_append_printf(context
->string
, "[%u]", array
->length
);
4183 int bt_ctf_field_type_sequence_serialize(struct bt_ctf_field_type
*type
,
4184 struct metadata_context
*context
)
4187 struct bt_ctf_field_type_sequence
*sequence
= container_of(
4188 type
, struct bt_ctf_field_type_sequence
, parent
);
4190 BT_LOGD("Serializing sequence field type's metadata: "
4191 "ft-addr=%p, metadata-context-addr=%p", type
, context
);
4192 BT_LOGD_STR("Serializing sequence field type's element field type's metadata.");
4193 ret
= bt_ctf_field_type_serialize(sequence
->element_type
, context
);
4195 BT_LOGW("Cannot serialize sequence field type's element field type's metadata: "
4196 "element-ft-addr=%p", sequence
->element_type
);
4200 if (context
->field_name
->len
) {
4201 g_string_append_printf(context
->string
, " %s[%s]",
4202 context
->field_name
->str
,
4203 sequence
->length_field_name
->str
);
4204 g_string_assign(context
->field_name
, "");
4206 g_string_append_printf(context
->string
, "[%s]",
4207 sequence
->length_field_name
->str
);
4214 int bt_ctf_field_type_string_serialize(struct bt_ctf_field_type
*type
,
4215 struct metadata_context
*context
)
4217 struct bt_ctf_field_type_string
*string
= container_of(
4218 type
, struct bt_ctf_field_type_string
, parent
);
4220 BT_LOGD("Serializing string field type's metadata: "
4221 "ft-addr=%p, metadata-context-addr=%p", type
, context
);
4222 g_string_append_printf(context
->string
,
4223 "string { encoding = %s; }",
4224 get_encoding_string(string
->encoding
));
4229 void bt_ctf_field_type_integer_set_byte_order(struct bt_ctf_field_type
*type
,
4230 enum bt_ctf_byte_order byte_order
)
4232 struct bt_ctf_field_type_integer
*integer_type
= container_of(type
,
4233 struct bt_ctf_field_type_integer
, parent
);
4235 integer_type
->user_byte_order
= byte_order
;
4239 void bt_ctf_field_type_enumeration_set_byte_order(
4240 struct bt_ctf_field_type
*type
, enum bt_ctf_byte_order byte_order
)
4242 struct bt_ctf_field_type_enumeration
*enum_type
= container_of(type
,
4243 struct bt_ctf_field_type_enumeration
, parent
);
4245 /* Safe to assume that container is an integer */
4246 bt_ctf_field_type_integer_set_byte_order(enum_type
->container
,
4251 void bt_ctf_field_type_floating_point_set_byte_order(
4252 struct bt_ctf_field_type
*type
, enum bt_ctf_byte_order byte_order
)
4254 struct bt_ctf_field_type_floating_point
*floating_point_type
=
4255 container_of(type
, struct bt_ctf_field_type_floating_point
,
4258 floating_point_type
->user_byte_order
= byte_order
;
4262 void bt_ctf_field_type_structure_set_byte_order(struct bt_ctf_field_type
*type
,
4263 enum bt_ctf_byte_order byte_order
)
4266 struct bt_ctf_field_type_structure
*structure_type
=
4267 container_of(type
, struct bt_ctf_field_type_structure
,
4270 for (i
= 0; i
< structure_type
->fields
->len
; i
++) {
4271 struct structure_field
*field
= g_ptr_array_index(
4272 structure_type
->fields
, i
);
4273 struct bt_ctf_field_type
*field_type
= field
->type
;
4275 if (set_byte_order_funcs
[field_type
->id
]) {
4276 set_byte_order_funcs
[field_type
->id
](
4277 field_type
, byte_order
);
4283 void bt_ctf_field_type_variant_set_byte_order(struct bt_ctf_field_type
*type
,
4284 enum bt_ctf_byte_order byte_order
)
4287 struct bt_ctf_field_type_variant
*variant_type
=
4288 container_of(type
, struct bt_ctf_field_type_variant
,
4291 for (i
= 0; i
< variant_type
->fields
->len
; i
++) {
4292 struct structure_field
*field
= g_ptr_array_index(
4293 variant_type
->fields
, i
);
4294 struct bt_ctf_field_type
*field_type
= field
->type
;
4296 if (set_byte_order_funcs
[field_type
->id
]) {
4297 set_byte_order_funcs
[field_type
->id
](
4298 field_type
, byte_order
);
4304 void bt_ctf_field_type_array_set_byte_order(struct bt_ctf_field_type
*type
,
4305 enum bt_ctf_byte_order byte_order
)
4307 struct bt_ctf_field_type_array
*array_type
=
4308 container_of(type
, struct bt_ctf_field_type_array
,
4311 if (set_byte_order_funcs
[array_type
->element_type
->id
]) {
4312 set_byte_order_funcs
[array_type
->element_type
->id
](
4313 array_type
->element_type
, byte_order
);
4318 void bt_ctf_field_type_sequence_set_byte_order(struct bt_ctf_field_type
*type
,
4319 enum bt_ctf_byte_order byte_order
)
4321 struct bt_ctf_field_type_sequence
*sequence_type
=
4322 container_of(type
, struct bt_ctf_field_type_sequence
,
4325 if (set_byte_order_funcs
[
4326 sequence_type
->element_type
->id
]) {
4327 set_byte_order_funcs
[
4328 sequence_type
->element_type
->id
](
4329 sequence_type
->element_type
, byte_order
);
4334 struct bt_ctf_field_type
*bt_ctf_field_type_integer_copy(
4335 struct bt_ctf_field_type
*type
)
4337 struct bt_ctf_field_type
*copy
;
4338 struct bt_ctf_field_type_integer
*integer
, *copy_integer
;
4340 BT_LOGD("Copying integer field type's: addr=%p", type
);
4341 integer
= container_of(type
, struct bt_ctf_field_type_integer
, parent
);
4342 copy
= bt_ctf_field_type_integer_create(integer
->size
);
4344 BT_LOGE_STR("Cannot create integer field type.");
4348 copy_integer
= container_of(copy
, struct bt_ctf_field_type_integer
,
4350 copy_integer
->mapped_clock
= bt_get(integer
->mapped_clock
);
4351 copy_integer
->user_byte_order
= integer
->user_byte_order
;
4352 copy_integer
->is_signed
= integer
->is_signed
;
4353 copy_integer
->size
= integer
->size
;
4354 copy_integer
->base
= integer
->base
;
4355 copy_integer
->encoding
= integer
->encoding
;
4356 BT_LOGD("Copied integer field type: original-ft-addr=%p, copy-ft-addr=%p",
4364 struct bt_ctf_field_type
*bt_ctf_field_type_enumeration_copy(
4365 struct bt_ctf_field_type
*type
)
4368 struct bt_ctf_field_type
*copy
= NULL
, *copy_container
;
4369 struct bt_ctf_field_type_enumeration
*enumeration
, *copy_enumeration
;
4371 BT_LOGD("Copying enumeration field type's: addr=%p", type
);
4372 enumeration
= container_of(type
, struct bt_ctf_field_type_enumeration
,
4375 /* Copy the source enumeration's container */
4376 BT_LOGD_STR("Copying enumeration field type's container field type.");
4377 copy_container
= bt_ctf_field_type_copy(enumeration
->container
);
4378 if (!copy_container
) {
4379 BT_LOGE_STR("Cannot copy enumeration field type's container field type.");
4383 copy
= bt_ctf_field_type_enumeration_create(copy_container
);
4385 BT_LOGE_STR("Cannot create enumeration field type.");
4388 copy_enumeration
= container_of(copy
,
4389 struct bt_ctf_field_type_enumeration
, parent
);
4391 /* Copy all enumaration entries */
4392 for (i
= 0; i
< enumeration
->entries
->len
; i
++) {
4393 struct enumeration_mapping
*mapping
= g_ptr_array_index(
4394 enumeration
->entries
, i
);
4395 struct enumeration_mapping
*copy_mapping
= g_new0(
4396 struct enumeration_mapping
, 1);
4398 if (!copy_mapping
) {
4399 BT_LOGE_STR("Failed to allocate one enumeration mapping.");
4403 *copy_mapping
= *mapping
;
4404 g_ptr_array_add(copy_enumeration
->entries
, copy_mapping
);
4407 BT_LOGD("Copied enumeration field type: original-ft-addr=%p, copy-ft-addr=%p",
4411 bt_put(copy_container
);
4414 bt_put(copy_container
);
4420 struct bt_ctf_field_type
*bt_ctf_field_type_floating_point_copy(
4421 struct bt_ctf_field_type
*type
)
4423 struct bt_ctf_field_type
*copy
;
4424 struct bt_ctf_field_type_floating_point
*floating_point
, *copy_float
;
4426 BT_LOGD("Copying floating point number field type's: addr=%p", type
);
4427 floating_point
= container_of(type
,
4428 struct bt_ctf_field_type_floating_point
, parent
);
4429 copy
= bt_ctf_field_type_floating_point_create();
4431 BT_LOGE_STR("Cannot create floating point number field type.");
4435 copy_float
= container_of(copy
,
4436 struct bt_ctf_field_type_floating_point
, parent
);
4437 copy_float
->user_byte_order
= floating_point
->user_byte_order
;
4438 copy_float
->exp_dig
= floating_point
->exp_dig
;
4439 copy_float
->mant_dig
= floating_point
->mant_dig
;
4440 BT_LOGD("Copied floating point number field type: original-ft-addr=%p, copy-ft-addr=%p",
4447 struct bt_ctf_field_type
*bt_ctf_field_type_structure_copy(
4448 struct bt_ctf_field_type
*type
)
4451 GHashTableIter iter
;
4452 gpointer key
, value
;
4453 struct bt_ctf_field_type
*copy
;
4454 struct bt_ctf_field_type_structure
*structure
, *copy_structure
;
4456 BT_LOGD("Copying structure field type's: addr=%p", type
);
4457 structure
= container_of(type
, struct bt_ctf_field_type_structure
,
4459 copy
= bt_ctf_field_type_structure_create();
4461 BT_LOGE_STR("Cannot create structure field type.");
4465 copy_structure
= container_of(copy
,
4466 struct bt_ctf_field_type_structure
, parent
);
4468 /* Copy field_name_to_index */
4469 g_hash_table_iter_init(&iter
, structure
->field_name_to_index
);
4470 while (g_hash_table_iter_next (&iter
, &key
, &value
)) {
4471 g_hash_table_insert(copy_structure
->field_name_to_index
,
4475 for (i
= 0; i
< structure
->fields
->len
; i
++) {
4476 struct structure_field
*entry
, *copy_entry
;
4477 struct bt_ctf_field_type
*copy_field
;
4479 entry
= g_ptr_array_index(structure
->fields
, i
);
4480 BT_LOGD("Copying structure field type's field: "
4481 "index=%" PRId64
", "
4482 "field-ft-addr=%p, field-name=\"%s\"",
4483 i
, entry
, g_quark_to_string(entry
->name
));
4484 copy_entry
= g_new0(struct structure_field
, 1);
4486 BT_LOGE_STR("Failed to allocate one structure field type field.");
4490 copy_field
= bt_ctf_field_type_copy(entry
->type
);
4492 BT_LOGE("Cannot copy structure field type's field: "
4493 "index=%" PRId64
", "
4494 "field-ft-addr=%p, field-name=\"%s\"",
4495 i
, entry
, g_quark_to_string(entry
->name
));
4500 copy_entry
->name
= entry
->name
;
4501 copy_entry
->type
= copy_field
;
4502 g_ptr_array_add(copy_structure
->fields
, copy_entry
);
4505 BT_LOGD("Copied structure field type: original-ft-addr=%p, copy-ft-addr=%p",
4516 struct bt_ctf_field_type
*bt_ctf_field_type_variant_copy(
4517 struct bt_ctf_field_type
*type
)
4520 GHashTableIter iter
;
4521 gpointer key
, value
;
4522 struct bt_ctf_field_type
*copy
= NULL
, *copy_tag
= NULL
;
4523 struct bt_ctf_field_type_variant
*variant
, *copy_variant
;
4525 BT_LOGD("Copying variant field type's: addr=%p", type
);
4526 variant
= container_of(type
, struct bt_ctf_field_type_variant
,
4529 BT_LOGD_STR("Copying variant field type's tag field type.");
4530 copy_tag
= bt_ctf_field_type_copy(&variant
->tag
->parent
);
4532 BT_LOGE_STR("Cannot copy variant field type's tag field type.");
4537 copy
= bt_ctf_field_type_variant_create(copy_tag
,
4538 variant
->tag_name
->len
? variant
->tag_name
->str
: NULL
);
4540 BT_LOGE_STR("Cannot create variant field type.");
4544 copy_variant
= container_of(copy
, struct bt_ctf_field_type_variant
,
4547 /* Copy field_name_to_index */
4548 g_hash_table_iter_init(&iter
, variant
->field_name_to_index
);
4549 while (g_hash_table_iter_next (&iter
, &key
, &value
)) {
4550 g_hash_table_insert(copy_variant
->field_name_to_index
,
4554 for (i
= 0; i
< variant
->fields
->len
; i
++) {
4555 struct structure_field
*entry
, *copy_entry
;
4556 struct bt_ctf_field_type
*copy_field
;
4558 entry
= g_ptr_array_index(variant
->fields
, i
);
4559 BT_LOGD("Copying variant field type's field: "
4560 "index=%" PRId64
", "
4561 "field-ft-addr=%p, field-name=\"%s\"",
4562 i
, entry
, g_quark_to_string(entry
->name
));
4563 copy_entry
= g_new0(struct structure_field
, 1);
4565 BT_LOGE_STR("Failed to allocate one variant field type field.");
4569 copy_field
= bt_ctf_field_type_copy(entry
->type
);
4571 BT_LOGE("Cannot copy variant field type's field: "
4572 "index=%" PRId64
", "
4573 "field-ft-addr=%p, field-name=\"%s\"",
4574 i
, entry
, g_quark_to_string(entry
->name
));
4579 copy_entry
->name
= entry
->name
;
4580 copy_entry
->type
= copy_field
;
4581 g_ptr_array_add(copy_variant
->fields
, copy_entry
);
4584 if (variant
->tag_field_path
) {
4585 BT_LOGD_STR("Copying variant field type's tag field path.");
4586 copy_variant
->tag_field_path
= bt_ctf_field_path_copy(
4587 variant
->tag_field_path
);
4588 if (!copy_variant
->tag_field_path
) {
4589 BT_LOGE_STR("Cannot copy variant field type's tag field path.");
4594 BT_LOGD("Copied variant field type: original-ft-addr=%p, copy-ft-addr=%p",
4607 struct bt_ctf_field_type
*bt_ctf_field_type_array_copy(
4608 struct bt_ctf_field_type
*type
)
4610 struct bt_ctf_field_type
*copy
= NULL
, *copy_element
;
4611 struct bt_ctf_field_type_array
*array
;
4613 BT_LOGD("Copying array field type's: addr=%p", type
);
4614 array
= container_of(type
, struct bt_ctf_field_type_array
,
4616 BT_LOGD_STR("Copying array field type's element field type.");
4617 copy_element
= bt_ctf_field_type_copy(array
->element_type
);
4618 if (!copy_element
) {
4619 BT_LOGE_STR("Cannot copy array field type's element field type.");
4623 copy
= bt_ctf_field_type_array_create(copy_element
, array
->length
);
4625 BT_LOGE_STR("Cannot create array field type.");
4629 BT_LOGD("Copied array field type: original-ft-addr=%p, copy-ft-addr=%p",
4633 bt_put(copy_element
);
4638 struct bt_ctf_field_type
*bt_ctf_field_type_sequence_copy(
4639 struct bt_ctf_field_type
*type
)
4641 struct bt_ctf_field_type
*copy
= NULL
, *copy_element
;
4642 struct bt_ctf_field_type_sequence
*sequence
, *copy_sequence
;
4644 BT_LOGD("Copying sequence field type's: addr=%p", type
);
4645 sequence
= container_of(type
, struct bt_ctf_field_type_sequence
,
4647 BT_LOGD_STR("Copying sequence field type's element field type.");
4648 copy_element
= bt_ctf_field_type_copy(sequence
->element_type
);
4649 if (!copy_element
) {
4650 BT_LOGE_STR("Cannot copy sequence field type's element field type.");
4654 copy
= bt_ctf_field_type_sequence_create(copy_element
,
4655 sequence
->length_field_name
->len
?
4656 sequence
->length_field_name
->str
: NULL
);
4658 BT_LOGE_STR("Cannot create sequence field type.");
4662 copy_sequence
= container_of(copy
, struct bt_ctf_field_type_sequence
,
4664 if (sequence
->length_field_path
) {
4665 BT_LOGD_STR("Copying sequence field type's length field path.");
4666 copy_sequence
->length_field_path
= bt_ctf_field_path_copy(
4667 sequence
->length_field_path
);
4668 if (!copy_sequence
->length_field_path
) {
4669 BT_LOGE_STR("Cannot copy sequence field type's length field path.");
4674 BT_LOGD("Copied sequence field type: original-ft-addr=%p, copy-ft-addr=%p",
4678 bt_put(copy_element
);
4686 struct bt_ctf_field_type
*bt_ctf_field_type_string_copy(
4687 struct bt_ctf_field_type
*type
)
4689 struct bt_ctf_field_type
*copy
;
4690 struct bt_ctf_field_type_string
*string
;
4692 BT_LOGD("Copying string field type's: addr=%p", type
);
4693 copy
= bt_ctf_field_type_string_create();
4695 BT_LOGE_STR("Cannot create string field type.");
4699 string
= container_of(type
, struct bt_ctf_field_type_string
,
4701 BT_LOGD("Copied string field type: original-ft-addr=%p, copy-ft-addr=%p",
4708 int bt_ctf_field_type_integer_compare(struct bt_ctf_field_type
*type_a
,
4709 struct bt_ctf_field_type
*type_b
)
4712 struct bt_ctf_field_type_integer
*int_type_a
;
4713 struct bt_ctf_field_type_integer
*int_type_b
;
4715 int_type_a
= container_of(type_a
, struct bt_ctf_field_type_integer
,
4717 int_type_b
= container_of(type_b
, struct bt_ctf_field_type_integer
,
4721 if (int_type_a
->size
!= int_type_b
->size
) {
4722 BT_LOGV("Integer field types differ: different sizes: "
4723 "ft-a-size=%u, ft-b-size=%u",
4724 int_type_a
->size
, int_type_b
->size
);
4729 if (int_type_a
->user_byte_order
!= int_type_b
->user_byte_order
) {
4730 BT_LOGV("Integer field types differ: different byte orders: "
4731 "ft-a-bo=%s, ft-b-bo=%s",
4732 bt_ctf_byte_order_string(int_type_a
->user_byte_order
),
4733 bt_ctf_byte_order_string(int_type_b
->user_byte_order
));
4738 if (int_type_a
->is_signed
!= int_type_b
->is_signed
) {
4739 BT_LOGV("Integer field types differ: different signedness: "
4740 "ft-a-is-signed=%d, ft-b-is-signed=%d",
4741 int_type_a
->is_signed
,
4742 int_type_b
->is_signed
);
4747 if (int_type_a
->base
!= int_type_b
->base
) {
4748 BT_LOGV("Integer field types differ: different bases: "
4749 "ft-a-base=%s, ft-b-base=%s",
4750 bt_ctf_integer_base_string(int_type_a
->base
),
4751 bt_ctf_integer_base_string(int_type_b
->base
));
4756 if (int_type_a
->encoding
!= int_type_b
->encoding
) {
4757 BT_LOGV("Integer field types differ: different encodings: "
4758 "ft-a-encoding=%s, ft-b-encoding=%s",
4759 bt_ctf_string_encoding_string(int_type_a
->encoding
),
4760 bt_ctf_string_encoding_string(int_type_b
->encoding
));
4765 if (int_type_a
->mapped_clock
!= int_type_b
->mapped_clock
) {
4766 BT_LOGV("Integer field types differ: different mapped clock classes: "
4767 "ft-a-mapped-clock-class-addr=%p, "
4768 "ft-b-mapped-clock-class-addr=%p, ",
4769 "ft-a-mapped-clock-class-name=\"%s\", ",
4770 "ft-b-mapped-clock-class-name=\"%s\"",
4771 int_type_a
->mapped_clock
, int_type_b
->mapped_clock
,
4772 int_type_a
->mapped_clock
? bt_ctf_clock_class_get_name(int_type_a
->mapped_clock
) : "",
4773 int_type_b
->mapped_clock
? bt_ctf_clock_class_get_name(int_type_b
->mapped_clock
) : "");
4785 int bt_ctf_field_type_floating_point_compare(struct bt_ctf_field_type
*type_a
,
4786 struct bt_ctf_field_type
*type_b
)
4789 struct bt_ctf_field_type_floating_point
*float_a
;
4790 struct bt_ctf_field_type_floating_point
*float_b
;
4792 float_a
= container_of(type_a
,
4793 struct bt_ctf_field_type_floating_point
, parent
);
4794 float_b
= container_of(type_b
,
4795 struct bt_ctf_field_type_floating_point
, parent
);
4798 if (float_a
->user_byte_order
!= float_b
->user_byte_order
) {
4799 BT_LOGV("Floating point number field types differ: different byte orders: "
4800 "ft-a-bo=%s, ft-b-bo=%s",
4801 bt_ctf_byte_order_string(float_a
->user_byte_order
),
4802 bt_ctf_byte_order_string(float_b
->user_byte_order
));
4806 /* Exponent length */
4807 if (float_a
->exp_dig
!= float_b
->exp_dig
) {
4808 BT_LOGV("Floating point number field types differ: different exponent sizes: "
4809 "ft-a-exp-size=%s, ft-b-exp-size=%s",
4810 float_a
->exp_dig
, float_b
->exp_dig
);
4814 /* Mantissa length */
4815 if (float_a
->mant_dig
!= float_b
->mant_dig
) {
4816 BT_LOGV("Floating point number field types differ: different mantissa sizes: "
4817 "ft-a-mant-size=%s, ft-b-mant-size=%s",
4818 float_a
->mant_dig
, float_b
->mant_dig
);
4830 int compare_enumeration_mappings(struct enumeration_mapping
*mapping_a
,
4831 struct enumeration_mapping
*mapping_b
)
4836 if (mapping_a
->string
!= mapping_b
->string
) {
4837 BT_LOGV("Enumeration field type mappings differ: different names: "
4838 "mapping-a-name=\"%s\", mapping-b-name=\"%s\"",
4839 g_quark_to_string(mapping_a
->string
),
4840 g_quark_to_string(mapping_b
->string
));
4845 if (mapping_a
->range_start
._unsigned
!=
4846 mapping_b
->range_start
._unsigned
) {
4847 BT_LOGV("Enumeration field type mappings differ: different starts of range: "
4848 "mapping-a-range-start-unsigned=%" PRIu64
", "
4849 "mapping-b-range-start-unsigned=%" PRIu64
,
4850 mapping_a
->range_start
._unsigned
,
4851 mapping_b
->range_start
._unsigned
);
4856 if (mapping_a
->range_end
._unsigned
!=
4857 mapping_b
->range_end
._unsigned
) {
4858 BT_LOGV("Enumeration field type mappings differ: different ends of range: "
4859 "mapping-a-range-end-unsigned=%" PRIu64
", "
4860 "mapping-b-range-end-unsigned=%" PRIu64
,
4861 mapping_a
->range_end
._unsigned
,
4862 mapping_b
->range_end
._unsigned
);
4874 int bt_ctf_field_type_enumeration_compare(struct bt_ctf_field_type
*type_a
,
4875 struct bt_ctf_field_type
*type_b
)
4879 struct bt_ctf_field_type_enumeration
*enum_a
;
4880 struct bt_ctf_field_type_enumeration
*enum_b
;
4882 enum_a
= container_of(type_a
,
4883 struct bt_ctf_field_type_enumeration
, parent
);
4884 enum_b
= container_of(type_b
,
4885 struct bt_ctf_field_type_enumeration
, parent
);
4887 /* Container field type */
4888 ret
= bt_ctf_field_type_compare(enum_a
->container
, enum_b
->container
);
4890 BT_LOGV("Enumeration field types differ: different container field types: "
4891 "ft-a-container-ft-addr=%p, ft-b-container-ft-addr=%p",
4892 enum_a
->container
, enum_b
->container
);
4899 if (enum_a
->entries
->len
!= enum_b
->entries
->len
) {
4903 for (i
= 0; i
< enum_a
->entries
->len
; ++i
) {
4904 struct enumeration_mapping
*mapping_a
=
4905 g_ptr_array_index(enum_a
->entries
, i
);
4906 struct enumeration_mapping
*mapping_b
=
4907 g_ptr_array_index(enum_b
->entries
, i
);
4909 if (compare_enumeration_mappings(mapping_a
, mapping_b
)) {
4910 BT_LOGV("Enumeration field types differ: different mappings: "
4911 "ft-a-mapping-addr=%p, ft-b-mapping-addr=%p, "
4912 "ft-a-mapping-name=\"%s\", ft-b-mapping-name=\"%s\"",
4913 mapping_a
, mapping_b
,
4914 g_quark_to_string(mapping_a
->string
),
4915 g_quark_to_string(mapping_b
->string
));
4928 int bt_ctf_field_type_string_compare(struct bt_ctf_field_type
*type_a
,
4929 struct bt_ctf_field_type
*type_b
)
4932 struct bt_ctf_field_type_string
*string_a
;
4933 struct bt_ctf_field_type_string
*string_b
;
4935 string_a
= container_of(type_a
,
4936 struct bt_ctf_field_type_string
, parent
);
4937 string_b
= container_of(type_b
,
4938 struct bt_ctf_field_type_string
, parent
);
4941 if (string_a
->encoding
!= string_b
->encoding
) {
4942 BT_LOGV("String field types differ: different encodings: "
4943 "ft-a-encoding=%s, ft-b-encoding=%s",
4944 bt_ctf_string_encoding_string(string_a
->encoding
),
4945 bt_ctf_string_encoding_string(string_b
->encoding
));
4957 int compare_structure_fields(struct structure_field
*field_a
,
4958 struct structure_field
*field_b
)
4963 if (field_a
->name
!= field_b
->name
) {
4964 BT_LOGV("Structure/variant field type fields differ: different names: "
4965 "field-a-name=%s, field-b-name=%s",
4966 g_quark_to_string(field_a
->name
),
4967 g_quark_to_string(field_b
->name
));
4972 ret
= bt_ctf_field_type_compare(field_a
->type
, field_b
->type
);
4974 BT_LOGV("Structure/variant field type fields differ: different field types: "
4975 "field-name=\"%s\", field-a-ft-addr=%s, field-b-ft-addr=%s",
4976 g_quark_to_string(field_a
->name
),
4977 field_a
->type
, field_b
->type
);
4985 int bt_ctf_field_type_structure_compare(struct bt_ctf_field_type
*type_a
,
4986 struct bt_ctf_field_type
*type_b
)
4990 struct bt_ctf_field_type_structure
*struct_a
;
4991 struct bt_ctf_field_type_structure
*struct_b
;
4993 struct_a
= container_of(type_a
,
4994 struct bt_ctf_field_type_structure
, parent
);
4995 struct_b
= container_of(type_b
,
4996 struct bt_ctf_field_type_structure
, parent
);
4999 if (bt_ctf_field_type_get_alignment(type_a
) !=
5000 bt_ctf_field_type_get_alignment(type_b
)) {
5001 BT_LOGV("Structure field types differ: different alignments: "
5002 "ft-a-align=%u, ft-b-align=%u",
5003 bt_ctf_field_type_get_alignment(type_a
),
5004 bt_ctf_field_type_get_alignment(type_b
));
5009 if (struct_a
->fields
->len
!= struct_b
->fields
->len
) {
5010 BT_LOGV("Structure field types differ: different field counts: "
5011 "ft-a-field-count=%u, ft-b-field-count=%u",
5012 struct_a
->fields
->len
, struct_b
->fields
->len
);
5016 for (i
= 0; i
< struct_a
->fields
->len
; ++i
) {
5017 struct structure_field
*field_a
=
5018 g_ptr_array_index(struct_a
->fields
, i
);
5019 struct structure_field
*field_b
=
5020 g_ptr_array_index(struct_b
->fields
, i
);
5022 ret
= compare_structure_fields(field_a
, field_b
);
5024 /* compare_structure_fields() logs what differs */
5025 BT_LOGV_STR("Structure field types differ: different fields.");
5038 int bt_ctf_field_type_variant_compare(struct bt_ctf_field_type
*type_a
,
5039 struct bt_ctf_field_type
*type_b
)
5043 struct bt_ctf_field_type_variant
*variant_a
;
5044 struct bt_ctf_field_type_variant
*variant_b
;
5046 variant_a
= container_of(type_a
,
5047 struct bt_ctf_field_type_variant
, parent
);
5048 variant_b
= container_of(type_b
,
5049 struct bt_ctf_field_type_variant
, parent
);
5052 if (strcmp(variant_a
->tag_name
->str
, variant_b
->tag_name
->str
)) {
5053 BT_LOGV("Variant field types differ: different tag field names: "
5054 "ft-a-tag-field-name=%u, ft-b-tag-field-name=%u",
5055 variant_a
->tag_name
->str
, variant_b
->tag_name
->str
);
5060 ret
= bt_ctf_field_type_compare(
5061 (struct bt_ctf_field_type
*) variant_a
->tag
,
5062 (struct bt_ctf_field_type
*) variant_b
->tag
);
5064 BT_LOGV("Variant field types differ: different tag field types: "
5065 "ft-a-tag-ft-addr=%p, ft-b-tag-ft-addr=%p",
5066 variant_a
->tag
, variant_b
->tag
);
5073 if (variant_a
->fields
->len
!= variant_b
->fields
->len
) {
5074 BT_LOGV("Structure field types differ: different field counts: "
5075 "ft-a-field-count=%u, ft-b-field-count=%u",
5076 variant_a
->fields
->len
, variant_b
->fields
->len
);
5080 for (i
= 0; i
< variant_a
->fields
->len
; ++i
) {
5081 struct structure_field
*field_a
=
5082 g_ptr_array_index(variant_a
->fields
, i
);
5083 struct structure_field
*field_b
=
5084 g_ptr_array_index(variant_b
->fields
, i
);
5086 ret
= compare_structure_fields(field_a
, field_b
);
5088 /* compare_structure_fields() logs what differs */
5089 BT_LOGV_STR("Variant field types differ: different fields.");
5102 int bt_ctf_field_type_array_compare(struct bt_ctf_field_type
*type_a
,
5103 struct bt_ctf_field_type
*type_b
)
5106 struct bt_ctf_field_type_array
*array_a
;
5107 struct bt_ctf_field_type_array
*array_b
;
5109 array_a
= container_of(type_a
,
5110 struct bt_ctf_field_type_array
, parent
);
5111 array_b
= container_of(type_b
,
5112 struct bt_ctf_field_type_array
, parent
);
5115 if (array_a
->length
!= array_b
->length
) {
5116 BT_LOGV("Structure field types differ: different lengths: "
5117 "ft-a-length=%u, ft-b-length=%u",
5118 array_a
->length
, array_b
->length
);
5123 ret
= bt_ctf_field_type_compare(array_a
->element_type
,
5124 array_b
->element_type
);
5126 BT_LOGV("Array field types differ: different element field types: "
5127 "ft-a-element-ft-addr=%p, ft-b-element-ft-addr=%p",
5128 array_a
->element_type
, array_b
->element_type
);
5136 int bt_ctf_field_type_sequence_compare(struct bt_ctf_field_type
*type_a
,
5137 struct bt_ctf_field_type
*type_b
)
5140 struct bt_ctf_field_type_sequence
*sequence_a
;
5141 struct bt_ctf_field_type_sequence
*sequence_b
;
5143 sequence_a
= container_of(type_a
,
5144 struct bt_ctf_field_type_sequence
, parent
);
5145 sequence_b
= container_of(type_b
,
5146 struct bt_ctf_field_type_sequence
, parent
);
5149 if (strcmp(sequence_a
->length_field_name
->str
,
5150 sequence_b
->length_field_name
->str
)) {
5151 BT_LOGV("Sequence field types differ: different length field names: "
5152 "ft-a-length-field-name=%u, ft-b-length-field-name=%u",
5153 sequence_a
->length_field_name
->str
,
5154 sequence_b
->length_field_name
->str
);
5159 ret
= bt_ctf_field_type_compare(sequence_a
->element_type
,
5160 sequence_b
->element_type
);
5162 BT_LOGV("Sequence field types differ: different element field types: "
5163 "ft-a-element-ft-addr=%p, ft-b-element-ft-addr=%p",
5164 sequence_a
->element_type
, sequence_b
->element_type
);
5171 int bt_ctf_field_type_compare(struct bt_ctf_field_type
*type_a
,
5172 struct bt_ctf_field_type
*type_b
)
5176 if (type_a
== type_b
) {
5177 /* Same reference: equal (even if both are NULL) */
5183 BT_LOGW_STR("Invalid parameter: field type A is NULL.");
5189 BT_LOGW_STR("Invalid parameter: field type B is NULL.");
5194 if (type_a
->id
!= type_b
->id
) {
5195 /* Different type IDs */
5196 BT_LOGV("Field types differ: different IDs: "
5197 "ft-a-addr=%p, ft-b-addr=%p, "
5198 "ft-a-id=%s, ft-b-id=%s",
5200 bt_ctf_field_type_id_string(type_a
->id
),
5201 bt_ctf_field_type_id_string(type_b
->id
));
5205 if (type_a
->id
== BT_CTF_FIELD_TYPE_ID_UNKNOWN
) {
5206 /* Both have unknown type IDs */
5207 BT_LOGW_STR("Invalid parameter: field type IDs are unknown.");
5211 ret
= type_compare_funcs
[type_a
->id
](type_a
, type_b
);
5213 BT_LOGV("Field types differ: ft-a-addr=%p, ft-b-addr=%p",
5222 int64_t bt_ctf_field_type_get_field_count(struct bt_ctf_field_type
*field_type
)
5224 int64_t field_count
= -1;
5225 enum bt_ctf_field_type_id type_id
= bt_ctf_field_type_get_type_id(field_type
);
5228 case CTF_TYPE_STRUCT
:
5230 bt_ctf_field_type_structure_get_field_count(field_type
);
5232 case CTF_TYPE_VARIANT
:
5234 bt_ctf_field_type_variant_get_field_count(field_type
);
5236 case CTF_TYPE_ARRAY
:
5237 case CTF_TYPE_SEQUENCE
:
5239 * Array and sequence types always contain a single member
5240 * (the element type).
5252 struct bt_ctf_field_type
*bt_ctf_field_type_get_field_at_index(
5253 struct bt_ctf_field_type
*field_type
, int index
)
5255 struct bt_ctf_field_type
*field
= NULL
;
5256 enum bt_ctf_field_type_id type_id
= bt_ctf_field_type_get_type_id(field_type
);
5259 case CTF_TYPE_STRUCT
:
5260 bt_ctf_field_type_structure_get_field_by_index(field_type
,
5261 NULL
, &field
, index
);
5263 case CTF_TYPE_VARIANT
:
5265 int ret
= bt_ctf_field_type_variant_get_field_by_index(
5266 field_type
, NULL
, &field
, index
);
5273 case CTF_TYPE_ARRAY
:
5274 field
= bt_ctf_field_type_array_get_element_type(field_type
);
5276 case CTF_TYPE_SEQUENCE
:
5277 field
= bt_ctf_field_type_sequence_get_element_type(field_type
);
5287 int bt_ctf_field_type_get_field_index(struct bt_ctf_field_type
*field_type
,
5290 int field_index
= -1;
5291 enum bt_ctf_field_type_id type_id
= bt_ctf_field_type_get_type_id(field_type
);
5294 case CTF_TYPE_STRUCT
:
5295 field_index
= bt_ctf_field_type_structure_get_field_name_index(
5298 case CTF_TYPE_VARIANT
:
5299 field_index
= bt_ctf_field_type_variant_get_field_name_index(
5309 struct bt_ctf_field_path
*bt_ctf_field_type_variant_get_tag_field_path(
5310 struct bt_ctf_field_type
*type
)
5312 struct bt_ctf_field_path
*field_path
= NULL
;
5313 struct bt_ctf_field_type_variant
*variant
;
5316 BT_LOGW_STR("Invalid parameter: field type is NULL.");
5320 if (!bt_ctf_field_type_is_variant(type
)) {
5321 BT_LOGW("Invalid parameter: field type is not a variant field type: "
5322 "addr=%p, ft-id=%s", type
,
5323 bt_ctf_field_type_id_string(type
->id
));
5327 variant
= container_of(type
, struct bt_ctf_field_type_variant
,
5329 field_path
= bt_get(variant
->tag_field_path
);
5334 struct bt_ctf_field_path
*bt_ctf_field_type_sequence_get_length_field_path(
5335 struct bt_ctf_field_type
*type
)
5337 struct bt_ctf_field_path
*field_path
= NULL
;
5338 struct bt_ctf_field_type_sequence
*sequence
;
5341 BT_LOGW_STR("Invalid parameter: field type is NULL.");
5345 if (!bt_ctf_field_type_is_sequence(type
)) {
5346 BT_LOGW("Invalid parameter: field type is not a sequence field type: "
5347 "addr=%p, ft-id=%s", type
,
5348 bt_ctf_field_type_id_string(type
->id
));
5352 sequence
= container_of(type
, struct bt_ctf_field_type_sequence
,
5354 field_path
= bt_get(sequence
->length_field_path
);