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
);
1185 int bt_ctf_field_type_integer_set_mapped_clock_class_no_check(
1186 struct bt_ctf_field_type
*type
,
1187 struct bt_ctf_clock_class
*clock_class
)
1189 struct bt_ctf_field_type_integer
*integer
;
1193 BT_LOGW_STR("Invalid parameter: field type is NULL.");
1199 BT_LOGW_STR("Invalid parameter: clock class is NULL.");
1204 if (type
->id
!= BT_CTF_FIELD_TYPE_ID_INTEGER
) {
1205 BT_LOGW("Invalid parameter: field type is not an integer field type: "
1206 "addr=%p, ft-id=%s", type
,
1207 bt_ctf_field_type_id_string(type
->id
));
1211 if (!bt_ctf_clock_class_is_valid(clock_class
)) {
1212 BT_LOGW("Invalid parameter: clock class is invalid: ft-addr=%p"
1213 "clock-class-addr=%p, clock-class-name=\"%s\"",
1215 bt_ctf_clock_class_get_name(clock_class
));
1220 integer
= container_of(type
, struct bt_ctf_field_type_integer
, parent
);
1221 bt_put(integer
->mapped_clock
);
1222 integer
->mapped_clock
= bt_get(clock_class
);
1223 BT_LOGV("Set integer field type's mapped clock class: ft-addr=%p, "
1224 "clock-class-addr=%p, clock-class-name=\"%s\"",
1225 type
, clock_class
, bt_ctf_clock_class_get_name(clock_class
));
1230 int bt_ctf_field_type_integer_set_mapped_clock_class(
1231 struct bt_ctf_field_type
*type
,
1232 struct bt_ctf_clock_class
*clock_class
)
1237 BT_LOGW_STR("Invalid parameter: field type is NULL.");
1243 BT_LOGW("Invalid parameter: field type is frozen: addr=%p",
1249 ret
= bt_ctf_field_type_integer_set_mapped_clock_class_no_check(
1257 void bt_ctf_field_type_enum_iter_destroy(struct bt_object
*obj
)
1259 struct bt_ctf_field_type_enumeration_mapping_iterator
*iter
=
1261 struct bt_ctf_field_type_enumeration_mapping_iterator
,
1264 BT_LOGD("Destroying enumeration field type mapping iterator: addr=%p",
1266 BT_LOGD_STR("Putting parent enumeration field type.");
1267 bt_put(&iter
->enumeration_type
->parent
);
1272 struct bt_ctf_field_type_enumeration_mapping_iterator
*
1273 bt_ctf_field_type_enumeration_find_mappings_type(
1274 struct bt_ctf_field_type
*type
,
1275 enum bt_ctf_field_type_enumeration_mapping_iterator_type iterator_type
)
1277 struct bt_ctf_field_type_enumeration
*enumeration_type
;
1278 struct bt_ctf_field_type_enumeration_mapping_iterator
*iter
= NULL
;
1281 BT_LOGW_STR("Invalid parameter: field type is NULL.");
1285 if (type
->id
!= BT_CTF_FIELD_TYPE_ID_ENUM
) {
1286 BT_LOGW("Invalid parameter: field type is not an enumeration field type: "
1287 "addr=%p, ft-id=%s", type
,
1288 bt_ctf_field_type_id_string(type
->id
));
1292 enumeration_type
= container_of(type
,
1293 struct bt_ctf_field_type_enumeration
, parent
);
1294 iter
= g_new0(struct bt_ctf_field_type_enumeration_mapping_iterator
, 1);
1296 BT_LOGE_STR("Failed to allocate one enumeration field type mapping.");
1300 bt_object_init(&iter
->base
, bt_ctf_field_type_enum_iter_destroy
);
1302 iter
->enumeration_type
= enumeration_type
;
1304 iter
->type
= iterator_type
;
1309 struct bt_ctf_field_type_enumeration_mapping_iterator
*
1310 bt_ctf_field_type_enumeration_find_mappings_by_name(
1311 struct bt_ctf_field_type
*type
, const char *name
)
1313 struct bt_ctf_field_type_enumeration_mapping_iterator
*iter
;
1315 iter
= bt_ctf_field_type_enumeration_find_mappings_type(
1316 type
, ITERATOR_BY_NAME
);
1318 BT_LOGE("Cannot create enumeration field type mapping iterator: "
1319 "ft-addr=%p, mapping-name=\"%s\"", type
, name
);
1323 iter
->u
.name_quark
= g_quark_try_string(name
);
1324 if (!iter
->u
.name_quark
) {
1325 BT_LOGV("No such enumeration field type mapping name: "
1326 "ft-addr=%p, mapping-name=\"%s\"",
1331 /* Advance iterator to first entry, or leave index at -1. */
1332 if (bt_ctf_field_type_enumeration_mapping_iterator_next(iter
)) {
1333 /* No entry found. */
1334 BT_LOGV("No such enumeration field type mapping name: "
1335 "ft-addr=%p, mapping-name=\"%s\"",
1346 int bt_ctf_field_type_enumeration_mapping_iterator_next(
1347 struct bt_ctf_field_type_enumeration_mapping_iterator
*iter
)
1349 struct bt_ctf_field_type_enumeration
*enumeration
;
1350 struct bt_ctf_field_type
*type
;
1351 int i
, ret
= 0, len
;
1354 BT_LOGW_STR("Invalid parameter: enumeration field type mapping iterator is NULL.");
1359 enumeration
= iter
->enumeration_type
;
1360 type
= &enumeration
->parent
;
1361 len
= enumeration
->entries
->len
;
1362 for (i
= iter
->index
+ 1; i
< len
; i
++) {
1363 struct enumeration_mapping
*mapping
=
1364 get_enumeration_mapping(type
, i
);
1366 switch (iter
->type
) {
1367 case ITERATOR_BY_NAME
:
1368 if (mapping
->string
== iter
->u
.name_quark
) {
1373 case ITERATOR_BY_SIGNED_VALUE
:
1375 int64_t value
= iter
->u
.signed_value
;
1377 if (value
>= mapping
->range_start
._signed
&&
1378 value
<= mapping
->range_end
._signed
) {
1384 case ITERATOR_BY_UNSIGNED_VALUE
:
1386 uint64_t value
= iter
->u
.unsigned_value
;
1388 if (value
>= mapping
->range_start
._unsigned
&&
1389 value
<= mapping
->range_end
._unsigned
) {
1396 BT_LOGF("Invalid enumeration field type mapping iterator type: "
1397 "type=%d", iter
->type
);
1407 struct bt_ctf_field_type_enumeration_mapping_iterator
*
1408 bt_ctf_field_type_enumeration_find_mappings_by_signed_value(
1409 struct bt_ctf_field_type
*type
, int64_t value
)
1411 struct bt_ctf_field_type_enumeration_mapping_iterator
*iter
;
1413 iter
= bt_ctf_field_type_enumeration_find_mappings_type(
1414 type
, ITERATOR_BY_SIGNED_VALUE
);
1416 BT_LOGE("Cannot create enumeration field type mapping iterator: "
1417 "ft-addr=%p, value=%" PRId64
, type
, value
);
1421 if (bt_ctf_field_type_integer_get_signed(
1422 iter
->enumeration_type
->container
) != 1) {
1423 BT_LOGW("Invalid parameter: enumeration field type is unsigned: "
1424 "enum-ft-addr=%p, int-ft-addr=%p",
1425 type
, iter
->enumeration_type
->container
);
1429 iter
->u
.signed_value
= value
;
1431 /* Advance iterator to first entry, or leave index at -1. */
1432 if (bt_ctf_field_type_enumeration_mapping_iterator_next(iter
)) {
1433 /* No entry found. */
1443 struct bt_ctf_field_type_enumeration_mapping_iterator
*
1444 bt_ctf_field_type_enumeration_find_mappings_by_unsigned_value(
1445 struct bt_ctf_field_type
*type
, uint64_t value
)
1447 struct bt_ctf_field_type_enumeration_mapping_iterator
*iter
= NULL
;
1450 BT_LOGW_STR("Invalid parameter: field type is NULL.");
1454 iter
= bt_ctf_field_type_enumeration_find_mappings_type(
1455 type
, ITERATOR_BY_UNSIGNED_VALUE
);
1457 BT_LOGE("Cannot create enumeration field type mapping iterator: "
1458 "ft-addr=%p, value=%" PRIu64
, type
, value
);
1462 if (bt_ctf_field_type_integer_get_signed(
1463 iter
->enumeration_type
->container
) != 0) {
1464 BT_LOGW("Invalid parameter: enumeration field type is signed: "
1465 "enum-ft-addr=%p, int-ft-addr=%p",
1466 type
, iter
->enumeration_type
->container
);
1469 iter
->u
.unsigned_value
= value
;
1471 /* Advance iterator to first entry, or leave index at -1. */
1472 if (bt_ctf_field_type_enumeration_mapping_iterator_next(iter
)) {
1473 /* No entry found. */
1483 int bt_ctf_field_type_enumeration_mapping_iterator_get_signed(
1484 struct bt_ctf_field_type_enumeration_mapping_iterator
*iter
,
1485 const char **mapping_name
, int64_t *range_begin
,
1491 BT_LOGW_STR("Invalid parameter: enumeration field type mapping iterator is NULL.");
1496 ret
= bt_ctf_field_type_enumeration_get_mapping_signed(
1497 &iter
->enumeration_type
->parent
, iter
->index
,
1498 mapping_name
, range_begin
, range_end
);
1503 int bt_ctf_field_type_enumeration_mapping_iterator_get_unsigned(
1504 struct bt_ctf_field_type_enumeration_mapping_iterator
*iter
,
1505 const char **mapping_name
, uint64_t *range_begin
,
1506 uint64_t *range_end
)
1511 BT_LOGW_STR("Invalid parameter: enumeration field type mapping iterator is NULL.");
1516 ret
= bt_ctf_field_type_enumeration_get_mapping_unsigned(
1517 &iter
->enumeration_type
->parent
, iter
->index
,
1518 mapping_name
, range_begin
, range_end
);
1523 int bt_ctf_field_type_enumeration_get_mapping_signed(
1524 struct bt_ctf_field_type
*enum_field_type
,
1525 uint64_t index
, const char **mapping_name
, int64_t *range_begin
,
1529 struct enumeration_mapping
*mapping
;
1531 if (!enum_field_type
) {
1532 BT_LOGW_STR("Invalid parameter: field type is NULL.");
1537 mapping
= get_enumeration_mapping(enum_field_type
, index
);
1539 /* get_enumeration_mapping() reports any error */
1545 *mapping_name
= g_quark_to_string(mapping
->string
);
1546 assert(*mapping_name
);
1550 *range_begin
= mapping
->range_start
._signed
;
1554 *range_end
= mapping
->range_end
._signed
;
1560 int bt_ctf_field_type_enumeration_get_mapping_unsigned(
1561 struct bt_ctf_field_type
*enum_field_type
,
1563 const char **mapping_name
, uint64_t *range_begin
,
1564 uint64_t *range_end
)
1567 struct enumeration_mapping
*mapping
;
1569 if (!enum_field_type
) {
1570 BT_LOGW_STR("Invalid parameter: field type is NULL.");
1575 mapping
= get_enumeration_mapping(enum_field_type
, index
);
1577 /* get_enumeration_mapping() reports any error */
1583 *mapping_name
= g_quark_to_string(mapping
->string
);
1584 assert(*mapping_name
);
1588 *range_begin
= mapping
->range_start
._unsigned
;
1592 *range_end
= mapping
->range_end
._unsigned
;
1598 struct bt_ctf_field_type
*bt_ctf_field_type_enumeration_create(
1599 struct bt_ctf_field_type
*integer_container_type
)
1601 struct bt_ctf_field_type_enumeration
*enumeration
= NULL
;
1603 BT_LOGD("Creating enumeration field type object: int-ft-addr=%p",
1604 integer_container_type
);
1606 if (!integer_container_type
) {
1607 BT_LOGW_STR("Invalid parameter: field type is NULL.");
1611 if (integer_container_type
->id
!= BT_CTF_FIELD_TYPE_ID_INTEGER
) {
1612 BT_LOGW("Invalid parameter: container field type is not an integer field type: "
1613 "container-ft-addr=%p, container-ft-id=%s",
1614 integer_container_type
,
1615 bt_ctf_field_type_id_string(integer_container_type
->id
));
1619 enumeration
= g_new0(struct bt_ctf_field_type_enumeration
, 1);
1621 BT_LOGE_STR("Failed to allocate one enumeration field type.");
1625 enumeration
->parent
.id
= BT_CTF_FIELD_TYPE_ID_ENUM
;
1626 bt_get(integer_container_type
);
1627 enumeration
->container
= integer_container_type
;
1628 enumeration
->entries
= g_ptr_array_new_with_free_func(
1629 (GDestroyNotify
)destroy_enumeration_mapping
);
1630 bt_ctf_field_type_init(&enumeration
->parent
, FALSE
);
1631 BT_LOGD("Created enumeration field type object: addr=%p, "
1632 "int-ft-addr=%p, int-ft-size=%u",
1633 &enumeration
->parent
, integer_container_type
,
1634 bt_ctf_field_type_integer_get_size(integer_container_type
));
1635 return &enumeration
->parent
;
1637 g_free(enumeration
);
1641 struct bt_ctf_field_type
*bt_ctf_field_type_enumeration_get_container_type(
1642 struct bt_ctf_field_type
*type
)
1644 struct bt_ctf_field_type
*container_type
= NULL
;
1645 struct bt_ctf_field_type_enumeration
*enumeration_type
;
1648 BT_LOGW_STR("Invalid parameter: field type is NULL.");
1652 if (type
->id
!= BT_CTF_FIELD_TYPE_ID_ENUM
) {
1653 BT_LOGW("Invalid parameter: field type is not an enumeration field type: "
1654 "addr=%p, ft-id=%s", type
,
1655 bt_ctf_field_type_id_string(type
->id
));
1659 enumeration_type
= container_of(type
,
1660 struct bt_ctf_field_type_enumeration
, parent
);
1661 container_type
= enumeration_type
->container
;
1662 bt_get(container_type
);
1664 return container_type
;
1667 int bt_ctf_field_type_enumeration_add_mapping_signed(
1668 struct bt_ctf_field_type
*type
, const char *string
,
1669 int64_t range_start
, int64_t range_end
)
1672 GQuark mapping_name
;
1673 struct enumeration_mapping
*mapping
;
1674 struct bt_ctf_field_type_enumeration
*enumeration
;
1675 char *escaped_string
;
1678 BT_LOGW_STR("Invalid parameter: field type is NULL.");
1684 BT_LOGW_STR("Invalid parameter: string is NULL.");
1690 BT_LOGW("Invalid parameter: field type is frozen: addr=%p",
1696 if (type
->id
!= BT_CTF_FIELD_TYPE_ID_ENUM
) {
1697 BT_LOGW("Invalid parameter: field type is not an enumeration field type: "
1698 "addr=%p, ft-id=%s", type
,
1699 bt_ctf_field_type_id_string(type
->id
));
1704 if (range_end
< range_start
) {
1705 BT_LOGW("Invalid parameter: range's end is lesser than range's start: "
1706 "addr=%p, range-start=%" PRId64
", range-end=%" PRId64
,
1707 type
, range_start
, range_end
);
1712 if (strlen(string
) == 0) {
1713 BT_LOGW("Invalid parameter: mapping name is an empty string: "
1714 "enum-ft-addr=%p, mapping-name-addr=%p", type
,
1720 escaped_string
= g_strescape(string
, NULL
);
1721 if (!escaped_string
) {
1722 BT_LOGE("Cannot escape mapping name: enum-ft-addr=%p, "
1723 "mapping-name-addr=%p, mapping-name=\"%s\"",
1724 type
, string
, string
);
1729 mapping
= g_new(struct enumeration_mapping
, 1);
1731 BT_LOGE_STR("Failed to allocate one enumeration mapping.");
1735 mapping_name
= g_quark_from_string(escaped_string
);
1736 *mapping
= (struct enumeration_mapping
) {
1737 .range_start
._signed
= range_start
,
1738 .range_end
._signed
= range_end
,
1739 .string
= mapping_name
,
1741 enumeration
= container_of(type
, struct bt_ctf_field_type_enumeration
,
1743 g_ptr_array_add(enumeration
->entries
, mapping
);
1744 g_ptr_array_sort(enumeration
->entries
,
1745 (GCompareFunc
)compare_enumeration_mappings_signed
);
1746 BT_LOGV("Added mapping to signed enumeration field type: addr=%p, "
1747 "name=\"%s\", range-start=%" PRId64
", "
1748 "range-end=%" PRId64
,
1749 type
, string
, range_start
, range_end
);
1751 free(escaped_string
);
1756 int bt_ctf_field_type_enumeration_add_mapping_unsigned(
1757 struct bt_ctf_field_type
*type
, const char *string
,
1758 uint64_t range_start
, uint64_t range_end
)
1761 GQuark mapping_name
;
1762 struct enumeration_mapping
*mapping
;
1763 struct bt_ctf_field_type_enumeration
*enumeration
;
1764 char *escaped_string
;
1767 BT_LOGW_STR("Invalid parameter: field type is NULL.");
1773 BT_LOGW_STR("Invalid parameter: string is NULL.");
1779 BT_LOGW("Invalid parameter: field type is frozen: addr=%p",
1785 if (type
->id
!= BT_CTF_FIELD_TYPE_ID_ENUM
) {
1786 BT_LOGW("Invalid parameter: field type is not an enumeration field type: "
1787 "addr=%p, ft-id=%s", type
,
1788 bt_ctf_field_type_id_string(type
->id
));
1793 if (range_end
< range_start
) {
1794 BT_LOGW("Invalid parameter: range's end is lesser than range's start: "
1795 "addr=%p, range-start=%" PRIu64
", range-end=%" PRIu64
,
1796 type
, range_start
, range_end
);
1801 if (strlen(string
) == 0) {
1802 BT_LOGW("Invalid parameter: mapping name is an empty string: "
1803 "enum-ft-addr=%p, mapping-name-addr=%p", type
,
1809 escaped_string
= g_strescape(string
, NULL
);
1810 if (!escaped_string
) {
1811 BT_LOGE("Cannot escape mapping name: enum-ft-addr=%p, "
1812 "mapping-name-addr=%p, mapping-name=\"%s\"",
1813 type
, string
, string
);
1818 mapping
= g_new(struct enumeration_mapping
, 1);
1820 BT_LOGE_STR("Failed to allocate one enumeration mapping.");
1824 mapping_name
= g_quark_from_string(escaped_string
);
1825 *mapping
= (struct enumeration_mapping
) {
1826 .range_start
._unsigned
= range_start
,
1827 .range_end
._unsigned
= range_end
,
1828 .string
= mapping_name
,
1830 enumeration
= container_of(type
, struct bt_ctf_field_type_enumeration
,
1832 g_ptr_array_add(enumeration
->entries
, mapping
);
1833 g_ptr_array_sort(enumeration
->entries
,
1834 (GCompareFunc
)compare_enumeration_mappings_unsigned
);
1835 BT_LOGV("Added mapping to unsigned enumeration field type: addr=%p, "
1836 "name=\"%s\", range-start=%" PRIu64
", "
1837 "range-end=%" PRIu64
,
1838 type
, string
, range_start
, range_end
);
1840 free(escaped_string
);
1845 int64_t bt_ctf_field_type_enumeration_get_mapping_count(
1846 struct bt_ctf_field_type
*type
)
1849 struct bt_ctf_field_type_enumeration
*enumeration
;
1852 BT_LOGW_STR("Invalid parameter: field type is NULL.");
1857 if (type
->id
!= BT_CTF_FIELD_TYPE_ID_ENUM
) {
1858 BT_LOGW("Invalid parameter: field type is not an enumeration field type: "
1859 "addr=%p, ft-id=%s", type
,
1860 bt_ctf_field_type_id_string(type
->id
));
1865 enumeration
= container_of(type
, struct bt_ctf_field_type_enumeration
,
1867 ret
= (int64_t) enumeration
->entries
->len
;
1872 struct bt_ctf_field_type
*bt_ctf_field_type_floating_point_create(void)
1874 struct bt_ctf_field_type_floating_point
*floating_point
=
1875 g_new0(struct bt_ctf_field_type_floating_point
, 1);
1877 BT_LOGD_STR("Creating floating point number field type object.");
1879 if (!floating_point
) {
1880 BT_LOGE_STR("Failed to allocate one floating point number field type.");
1884 floating_point
->parent
.id
= BT_CTF_FIELD_TYPE_ID_FLOAT
;
1885 floating_point
->exp_dig
= sizeof(float) * CHAR_BIT
- FLT_MANT_DIG
;
1886 floating_point
->mant_dig
= FLT_MANT_DIG
;
1887 bt_ctf_field_type_init(&floating_point
->parent
, TRUE
);
1888 BT_LOGD("Created floating point number field type object: addr=%p, "
1889 "exp-size=%u, mant-size=%u", &floating_point
->parent
,
1890 floating_point
->exp_dig
, floating_point
->mant_dig
);
1892 return floating_point
? &floating_point
->parent
: NULL
;
1895 int bt_ctf_field_type_floating_point_get_exponent_digits(
1896 struct bt_ctf_field_type
*type
)
1899 struct bt_ctf_field_type_floating_point
*floating_point
;
1902 BT_LOGW_STR("Invalid parameter: field type is NULL.");
1907 if (type
->id
!= BT_CTF_FIELD_TYPE_ID_FLOAT
) {
1908 BT_LOGW("Invalid parameter: field type is not a floating point number field type: "
1909 "addr=%p, ft-id=%s", type
,
1910 bt_ctf_field_type_id_string(type
->id
));
1915 floating_point
= container_of(type
,
1916 struct bt_ctf_field_type_floating_point
, parent
);
1917 ret
= (int) floating_point
->exp_dig
;
1922 int bt_ctf_field_type_floating_point_set_exponent_digits(
1923 struct bt_ctf_field_type
*type
,
1924 unsigned int exponent_digits
)
1927 struct bt_ctf_field_type_floating_point
*floating_point
;
1930 BT_LOGW_STR("Invalid parameter: field type is NULL.");
1936 BT_LOGW("Invalid parameter: field type is frozen: addr=%p",
1942 if (type
->id
!= BT_CTF_FIELD_TYPE_ID_FLOAT
) {
1943 BT_LOGW("Invalid parameter: field type is not a floating point number field type: "
1944 "addr=%p, ft-id=%s", type
,
1945 bt_ctf_field_type_id_string(type
->id
));
1950 floating_point
= container_of(type
,
1951 struct bt_ctf_field_type_floating_point
, parent
);
1952 if ((exponent_digits
!= sizeof(float) * CHAR_BIT
- FLT_MANT_DIG
) &&
1953 (exponent_digits
!= sizeof(double) * CHAR_BIT
- DBL_MANT_DIG
) &&
1955 sizeof(long double) * CHAR_BIT
- LDBL_MANT_DIG
)) {
1956 BT_LOGW("Invalid parameter: invalid exponent size: "
1957 "addr=%p, exp-size=%u", type
, exponent_digits
);
1962 floating_point
->exp_dig
= exponent_digits
;
1963 BT_LOGV("Set floating point number field type's exponent size: addr=%p, "
1964 "exp-size=%u", type
, exponent_digits
);
1969 int bt_ctf_field_type_floating_point_get_mantissa_digits(
1970 struct bt_ctf_field_type
*type
)
1973 struct bt_ctf_field_type_floating_point
*floating_point
;
1976 BT_LOGW_STR("Invalid parameter: field type is NULL.");
1981 if (type
->id
!= BT_CTF_FIELD_TYPE_ID_FLOAT
) {
1982 BT_LOGW("Invalid parameter: field type is not a floating point number field type: "
1983 "addr=%p, ft-id=%s", type
,
1984 bt_ctf_field_type_id_string(type
->id
));
1989 floating_point
= container_of(type
,
1990 struct bt_ctf_field_type_floating_point
, parent
);
1991 ret
= (int) floating_point
->mant_dig
;
1996 int bt_ctf_field_type_floating_point_set_mantissa_digits(
1997 struct bt_ctf_field_type
*type
,
1998 unsigned int mantissa_digits
)
2001 struct bt_ctf_field_type_floating_point
*floating_point
;
2004 BT_LOGW_STR("Invalid parameter: field type is NULL.");
2010 BT_LOGW("Invalid parameter: field type is frozen: addr=%p",
2016 if (type
->id
!= BT_CTF_FIELD_TYPE_ID_FLOAT
) {
2017 BT_LOGW("Invalid parameter: field type is not a floating point number field type: "
2018 "addr=%p, ft-id=%s", type
,
2019 bt_ctf_field_type_id_string(type
->id
));
2024 floating_point
= container_of(type
,
2025 struct bt_ctf_field_type_floating_point
, parent
);
2027 if ((mantissa_digits
!= FLT_MANT_DIG
) &&
2028 (mantissa_digits
!= DBL_MANT_DIG
) &&
2029 (mantissa_digits
!= LDBL_MANT_DIG
)) {
2030 BT_LOGW("Invalid parameter: invalid mantissa size: "
2031 "addr=%p, mant-size=%u", type
, mantissa_digits
);
2036 floating_point
->mant_dig
= mantissa_digits
;
2037 BT_LOGV("Set floating point number field type's mantissa size: addr=%p, "
2038 "mant-size=%u", type
, mantissa_digits
);
2043 struct bt_ctf_field_type
*bt_ctf_field_type_structure_create(void)
2045 struct bt_ctf_field_type_structure
*structure
=
2046 g_new0(struct bt_ctf_field_type_structure
, 1);
2048 BT_LOGD_STR("Creating structure field type object.");
2051 BT_LOGE_STR("Failed to allocate one structure field type.");
2055 structure
->parent
.id
= BT_CTF_FIELD_TYPE_ID_STRUCT
;
2056 structure
->fields
= g_ptr_array_new_with_free_func(
2057 (GDestroyNotify
)destroy_structure_field
);
2058 structure
->field_name_to_index
= g_hash_table_new(NULL
, NULL
);
2059 bt_ctf_field_type_init(&structure
->parent
, TRUE
);
2060 BT_LOGD("Created structure field type object: addr=%p",
2061 &structure
->parent
);
2062 return &structure
->parent
;
2067 int bt_ctf_field_type_structure_add_field(struct bt_ctf_field_type
*type
,
2068 struct bt_ctf_field_type
*field_type
,
2069 const char *field_name
)
2072 struct bt_ctf_field_type_structure
*structure
;
2075 * TODO: check that `field_type` does not contain `type`,
2079 BT_LOGW_STR("Invalid parameter: field type is NULL.");
2085 BT_LOGW_STR("Invalid parameter: field name is NULL.");
2091 BT_LOGW("Invalid parameter: field type is frozen: addr=%p",
2097 if (bt_ctf_validate_identifier(field_name
)) {
2098 BT_LOGW("Invalid parameter: field name is not a valid CTF identifier: "
2099 "struct-ft-addr=%p, field-name=\"%s\"",
2105 if (type
->id
!= BT_CTF_FIELD_TYPE_ID_STRUCT
) {
2106 BT_LOGW("Invalid parameter: field type is not a structure field type: "
2107 "addr=%p, ft-id=%s", type
,
2108 bt_ctf_field_type_id_string(type
->id
));
2113 if (type
== field_type
) {
2114 BT_LOGW("Invalid parameter: structure field type and field type to add are the same: "
2120 structure
= container_of(type
,
2121 struct bt_ctf_field_type_structure
, parent
);
2122 if (add_structure_field(structure
->fields
,
2123 structure
->field_name_to_index
, field_type
, field_name
)) {
2124 BT_LOGW("Cannot add field to structure field type: "
2125 "struct-ft-addr=%p, field-ft-addr=%p, field-name=\"%s\"",
2126 type
, field_type
, field_name
);
2131 BT_LOGV("Added structure field type field: struct-ft-addr=%p, "
2132 "field-ft-addr=%p, field-name=\"%s\"", type
,
2133 field_type
, field_name
);
2138 int64_t bt_ctf_field_type_structure_get_field_count(
2139 struct bt_ctf_field_type
*type
)
2142 struct bt_ctf_field_type_structure
*structure
;
2145 BT_LOGW_STR("Invalid parameter: field type is NULL.");
2150 if (type
->id
!= BT_CTF_FIELD_TYPE_ID_STRUCT
) {
2151 BT_LOGW("Invalid parameter: field type is not a structure field type: "
2152 "addr=%p, ft-id=%s", type
,
2153 bt_ctf_field_type_id_string(type
->id
));
2158 structure
= container_of(type
, struct bt_ctf_field_type_structure
,
2160 ret
= (int64_t) structure
->fields
->len
;
2165 int bt_ctf_field_type_structure_get_field_by_index(
2166 struct bt_ctf_field_type
*type
,
2167 const char **field_name
, struct bt_ctf_field_type
**field_type
,
2170 struct bt_ctf_field_type_structure
*structure
;
2171 struct structure_field
*field
;
2175 BT_LOGW_STR("Invalid parameter: field type is NULL.");
2180 if (type
->id
!= BT_CTF_FIELD_TYPE_ID_STRUCT
) {
2181 BT_LOGW("Invalid parameter: field type is not a structure field type: "
2182 "addr=%p, ft-id=%s", type
,
2183 bt_ctf_field_type_id_string(type
->id
));
2188 structure
= container_of(type
, struct bt_ctf_field_type_structure
,
2190 if (index
>= structure
->fields
->len
) {
2191 BT_LOGW("Invalid parameter: index is out of bounds: "
2192 "addr=%p, index=%" PRIu64
", count=%u",
2193 type
, index
, structure
->fields
->len
);
2198 field
= g_ptr_array_index(structure
->fields
, index
);
2200 *field_type
= field
->type
;
2201 bt_get(field
->type
);
2204 *field_name
= g_quark_to_string(field
->name
);
2205 assert(*field_name
);
2211 struct bt_ctf_field_type
*bt_ctf_field_type_structure_get_field_type_by_name(
2212 struct bt_ctf_field_type
*type
,
2217 struct structure_field
*field
;
2218 struct bt_ctf_field_type_structure
*structure
;
2219 struct bt_ctf_field_type
*field_type
= NULL
;
2222 BT_LOGW_STR("Invalid parameter: field type is NULL.");
2227 BT_LOGW_STR("Invalid parameter: name is NULL.");
2231 name_quark
= g_quark_try_string(name
);
2233 BT_LOGV("No such structure field type field name: "
2234 "ft-addr=%p, field-name=\"%s\"",
2239 structure
= container_of(type
, struct bt_ctf_field_type_structure
,
2241 if (!g_hash_table_lookup_extended(structure
->field_name_to_index
,
2242 GUINT_TO_POINTER(name_quark
), NULL
, (gpointer
*)&index
)) {
2243 BT_LOGV("No such structure field type field name: "
2244 "ft-addr=%p, field-name=\"%s\"",
2249 field
= structure
->fields
->pdata
[index
];
2250 field_type
= field
->type
;
2256 struct bt_ctf_field_type
*bt_ctf_field_type_variant_create(
2257 struct bt_ctf_field_type
*enum_tag
, const char *tag_name
)
2259 struct bt_ctf_field_type_variant
*variant
= NULL
;
2261 BT_LOGD("Creating variant field type object: "
2262 "tag-ft-addr=%p, tag-field-name=\"%s\"",
2263 enum_tag
, tag_name
);
2265 if (tag_name
&& bt_ctf_validate_identifier(tag_name
)) {
2266 BT_LOGW("Invalid parameter: tag field name is not a valid CTF identifier: "
2267 "tag-ft-addr=%p, tag-field-name=\"%s\"",
2268 enum_tag
, tag_name
);
2272 variant
= g_new0(struct bt_ctf_field_type_variant
, 1);
2274 BT_LOGE_STR("Failed to allocate one variant field type.");
2278 variant
->parent
.id
= BT_CTF_FIELD_TYPE_ID_VARIANT
;
2279 variant
->tag_name
= g_string_new(tag_name
);
2280 variant
->field_name_to_index
= g_hash_table_new(NULL
, NULL
);
2281 variant
->fields
= g_ptr_array_new_with_free_func(
2282 (GDestroyNotify
) destroy_structure_field
);
2285 variant
->tag
= container_of(enum_tag
,
2286 struct bt_ctf_field_type_enumeration
, parent
);
2289 bt_ctf_field_type_init(&variant
->parent
, TRUE
);
2290 /* A variant's alignment is undefined */
2291 variant
->parent
.alignment
= 0;
2292 BT_LOGD("Created variant field type object: addr=%p, "
2293 "tag-ft-addr=%p, tag-field-name=\"%s\"",
2294 &variant
->parent
, enum_tag
, tag_name
);
2295 return &variant
->parent
;
2300 struct bt_ctf_field_type
*bt_ctf_field_type_variant_get_tag_type(
2301 struct bt_ctf_field_type
*type
)
2303 struct bt_ctf_field_type_variant
*variant
;
2304 struct bt_ctf_field_type
*tag_type
= NULL
;
2307 BT_LOGW_STR("Invalid parameter: field type is NULL.");
2311 if (type
->id
!= BT_CTF_FIELD_TYPE_ID_VARIANT
) {
2312 BT_LOGW("Invalid parameter: field type is not a variant field type: "
2313 "addr=%p, ft-id=%s", type
,
2314 bt_ctf_field_type_id_string(type
->id
));
2318 variant
= container_of(type
, struct bt_ctf_field_type_variant
, parent
);
2319 if (!variant
->tag
) {
2320 BT_LOGV("Variant field type has no tag field type: "
2325 tag_type
= &variant
->tag
->parent
;
2331 const char *bt_ctf_field_type_variant_get_tag_name(
2332 struct bt_ctf_field_type
*type
)
2334 struct bt_ctf_field_type_variant
*variant
;
2335 const char *tag_name
= NULL
;
2338 BT_LOGW_STR("Invalid parameter: field type is NULL.");
2342 if (type
->id
!= BT_CTF_FIELD_TYPE_ID_VARIANT
) {
2343 BT_LOGW("Invalid parameter: field type is not a variant field type: "
2344 "addr=%p, ft-id=%s", type
,
2345 bt_ctf_field_type_id_string(type
->id
));
2349 variant
= container_of(type
, struct bt_ctf_field_type_variant
, parent
);
2350 if (variant
->tag_name
->len
== 0) {
2351 BT_LOGV("Variant field type has no tag field name: "
2356 tag_name
= variant
->tag_name
->str
;
2361 int bt_ctf_field_type_variant_set_tag_name(
2362 struct bt_ctf_field_type
*type
, const char *name
)
2365 struct bt_ctf_field_type_variant
*variant
;
2368 BT_LOGW_STR("Invalid parameter: field type is NULL.");
2374 BT_LOGW("Invalid parameter: field type is frozen: addr=%p",
2380 if (type
->id
!= BT_CTF_FIELD_TYPE_ID_VARIANT
) {
2381 BT_LOGW("Invalid parameter: field type is not a variant field type: "
2382 "addr=%p, ft-id=%s", type
,
2383 bt_ctf_field_type_id_string(type
->id
));
2388 if (bt_ctf_validate_identifier(name
)) {
2389 BT_LOGW("Invalid parameter: tag field name is not a valid CTF identifier: "
2390 "variant-ft-addr=%p, tag-field-name=\"%s\"",
2396 variant
= container_of(type
, struct bt_ctf_field_type_variant
, parent
);
2397 g_string_assign(variant
->tag_name
, name
);
2398 BT_LOGV("Set variant field type's tag field name: addr=%p, "
2399 "tag-field-name=\"%s\"", type
, name
);
2404 int bt_ctf_field_type_variant_add_field(struct bt_ctf_field_type
*type
,
2405 struct bt_ctf_field_type
*field_type
,
2406 const char *field_name
)
2410 struct bt_ctf_field_type_variant
*variant
;
2411 GQuark field_name_quark
= g_quark_from_string(field_name
);
2414 * TODO: check that `field_type` does not contain `type`,
2418 BT_LOGW_STR("Invalid parameter: field type is NULL.");
2424 BT_LOGW("Invalid parameter: field type is frozen: addr=%p",
2430 if (bt_ctf_validate_identifier(field_name
)) {
2431 BT_LOGW("Invalid parameter: field name is not a valid CTF identifier: "
2432 "variant-ft-addr=%p, field-name=\"%s\"",
2438 if (type
->id
!= BT_CTF_FIELD_TYPE_ID_VARIANT
) {
2439 BT_LOGW("Invalid parameter: field type is not a variant field type: "
2440 "addr=%p, ft-id=%s", type
,
2441 bt_ctf_field_type_id_string(type
->id
));
2446 if (type
== field_type
) {
2447 BT_LOGW("Invalid parameter: variant field type and field type to add are the same: "
2453 variant
= container_of(type
, struct bt_ctf_field_type_variant
, parent
);
2455 /* The user has explicitly provided a tag; validate against it. */
2459 /* Make sure this name is present in the enum tag */
2460 for (i
= 0; i
< variant
->tag
->entries
->len
; i
++) {
2461 struct enumeration_mapping
*mapping
=
2462 g_ptr_array_index(variant
->tag
->entries
, i
);
2464 if (mapping
->string
== field_name_quark
) {
2471 /* Validation failed */
2472 BT_LOGW("Invalid parameter: field name does not name a tag field type's mapping: "
2473 "variant-ft-addr=%p, tag-ft-addr=%p, "
2474 "tag-field-name=\"%s\""
2475 "field-ft-addr=%p, field-name=\"%s\"",
2476 type
, variant
->tag
, variant
->tag_name
->str
,
2477 field_type
, field_name
);
2483 if (add_structure_field(variant
->fields
, variant
->field_name_to_index
,
2484 field_type
, field_name
)) {
2485 BT_LOGW("Cannot add field to variant field type: "
2486 "variant-ft-addr=%p, field-ft-addr=%p, field-name=\"%s\"",
2487 type
, field_type
, field_name
);
2492 BT_LOGV("Added variant field type field: variant-ft-addr=%p, "
2493 "field-ft-addr=%p, field-name=\"%s\"", type
,
2494 field_type
, field_name
);
2500 struct bt_ctf_field_type
*bt_ctf_field_type_variant_get_field_type_by_name(
2501 struct bt_ctf_field_type
*type
,
2502 const char *field_name
)
2506 struct structure_field
*field
;
2507 struct bt_ctf_field_type_variant
*variant
;
2508 struct bt_ctf_field_type
*field_type
= NULL
;
2511 BT_LOGW_STR("Invalid parameter: field type is NULL.");
2516 BT_LOGW_STR("Invalid parameter: field name is NULL.");
2520 name_quark
= g_quark_try_string(field_name
);
2522 BT_LOGV("No such variant field type field name: "
2523 "ft-addr=%p, field-name=\"%s\"",
2528 variant
= container_of(type
, struct bt_ctf_field_type_variant
, parent
);
2529 if (!g_hash_table_lookup_extended(variant
->field_name_to_index
,
2530 GUINT_TO_POINTER(name_quark
), NULL
, (gpointer
*)&index
)) {
2531 BT_LOGV("No such variant field type field name: "
2532 "ft-addr=%p, field-name=\"%s\"",
2537 field
= g_ptr_array_index(variant
->fields
, index
);
2538 field_type
= field
->type
;
2544 struct bt_ctf_field_type
*bt_ctf_field_type_variant_get_field_type_from_tag(
2545 struct bt_ctf_field_type
*type
,
2546 struct bt_ctf_field
*tag
)
2549 const char *enum_value
;
2550 struct bt_ctf_field_type
*field_type
= NULL
;
2551 struct bt_ctf_field_type_enumeration_mapping_iterator
*iter
= NULL
;
2554 BT_LOGW_STR("Invalid parameter: variant field type is NULL.");
2559 BT_LOGW_STR("Invalid parameter: tag field is NULL.");
2563 if (type
->id
!= BT_CTF_FIELD_TYPE_ID_VARIANT
) {
2564 BT_LOGW("Invalid parameter: field type is not a variant field type: "
2565 "addr=%p, ft-id=%s", type
,
2566 bt_ctf_field_type_id_string(type
->id
));
2570 iter
= bt_ctf_field_enumeration_get_mappings(tag
);
2572 BT_LOGE("Cannot get enumeration field type mapping iterator from enumeration field: "
2573 "enum-field-addr=%p", tag
);
2577 ret
= bt_ctf_field_type_enumeration_mapping_iterator_get_signed(iter
,
2578 &enum_value
, NULL
, NULL
);
2580 BT_LOGW("Cannot get enumeration field type mapping iterator's current mapping: "
2581 "iter-addr=%p", iter
);
2585 field_type
= bt_ctf_field_type_variant_get_field_type_by_name(
2592 int64_t bt_ctf_field_type_variant_get_field_count(struct bt_ctf_field_type
*type
)
2595 struct bt_ctf_field_type_variant
*variant
;
2598 BT_LOGW_STR("Invalid parameter: field type is NULL.");
2603 if (type
->id
!= BT_CTF_FIELD_TYPE_ID_VARIANT
) {
2604 BT_LOGW("Invalid parameter: field type is not a variant field type: "
2605 "addr=%p, ft-id=%s", type
,
2606 bt_ctf_field_type_id_string(type
->id
));
2611 variant
= container_of(type
, struct bt_ctf_field_type_variant
,
2613 ret
= (int64_t) variant
->fields
->len
;
2619 int bt_ctf_field_type_variant_get_field_by_index(struct bt_ctf_field_type
*type
,
2620 const char **field_name
, struct bt_ctf_field_type
**field_type
,
2623 struct bt_ctf_field_type_variant
*variant
;
2624 struct structure_field
*field
;
2628 BT_LOGW_STR("Invalid parameter: field type is NULL.");
2633 if (type
->id
!= BT_CTF_FIELD_TYPE_ID_VARIANT
) {
2634 BT_LOGW("Invalid parameter: field type is not a variant field type: "
2635 "addr=%p, ft-id=%s", type
,
2636 bt_ctf_field_type_id_string(type
->id
));
2641 variant
= container_of(type
, struct bt_ctf_field_type_variant
,
2643 if (index
>= variant
->fields
->len
) {
2644 BT_LOGW("Invalid parameter: index is out of bounds: "
2645 "addr=%p, index=%" PRIu64
", count=%u",
2646 type
, index
, variant
->fields
->len
);
2651 field
= g_ptr_array_index(variant
->fields
, index
);
2653 *field_type
= field
->type
;
2654 bt_get(field
->type
);
2657 *field_name
= g_quark_to_string(field
->name
);
2658 assert(*field_name
);
2664 struct bt_ctf_field_type
*bt_ctf_field_type_array_create(
2665 struct bt_ctf_field_type
*element_type
,
2666 unsigned int length
)
2668 struct bt_ctf_field_type_array
*array
= NULL
;
2670 BT_LOGD("Creating array field type object: element-ft-addr=%p, "
2671 "length=%u", element_type
, length
);
2673 if (!element_type
) {
2674 BT_LOGW_STR("Invalid parameter: element field type is NULL.");
2679 BT_LOGW_STR("Invalid parameter: length is zero.");
2683 array
= g_new0(struct bt_ctf_field_type_array
, 1);
2685 BT_LOGE_STR("Failed to allocate one array field type.");
2689 array
->parent
.id
= BT_CTF_FIELD_TYPE_ID_ARRAY
;
2690 bt_get(element_type
);
2691 array
->element_type
= element_type
;
2692 array
->length
= length
;
2693 bt_ctf_field_type_init(&array
->parent
, FALSE
);
2694 BT_LOGD("Created array field type object: addr=%p, "
2695 "element-ft-addr=%p, length=%u",
2696 &array
->parent
, element_type
, length
);
2697 return &array
->parent
;
2702 struct bt_ctf_field_type
*bt_ctf_field_type_array_get_element_type(
2703 struct bt_ctf_field_type
*type
)
2705 struct bt_ctf_field_type
*ret
= NULL
;
2706 struct bt_ctf_field_type_array
*array
;
2709 BT_LOGW_STR("Invalid parameter: field type is NULL.");
2713 if (type
->id
!= BT_CTF_FIELD_TYPE_ID_ARRAY
) {
2714 BT_LOGW("Invalid parameter: field type is not an array field type: "
2715 "addr=%p, ft-id=%s", type
,
2716 bt_ctf_field_type_id_string(type
->id
));
2720 array
= container_of(type
, struct bt_ctf_field_type_array
, parent
);
2721 ret
= array
->element_type
;
2728 int bt_ctf_field_type_array_set_element_type(struct bt_ctf_field_type
*type
,
2729 struct bt_ctf_field_type
*element_type
)
2732 struct bt_ctf_field_type_array
*array
;
2735 BT_LOGW_STR("Invalid parameter: array field type is NULL.");
2740 if (!element_type
) {
2741 BT_LOGW_STR("Invalid parameter: element field type is NULL.");
2746 if (type
->id
!= BT_CTF_FIELD_TYPE_ID_ARRAY
) {
2747 BT_LOGW("Invalid parameter: field type is not an array field type: "
2748 "addr=%p, ft-id=%s", type
,
2749 bt_ctf_field_type_id_string(type
->id
));
2754 array
= container_of(type
, struct bt_ctf_field_type_array
, parent
);
2756 if (array
->element_type
) {
2757 BT_PUT(array
->element_type
);
2760 array
->element_type
= element_type
;
2761 bt_get(array
->element_type
);
2762 BT_LOGV("Set array field type's element field type: array-ft-addr=%p, "
2763 "element-ft-addr=%p", type
, element_type
);
2769 int64_t bt_ctf_field_type_array_get_length(struct bt_ctf_field_type
*type
)
2772 struct bt_ctf_field_type_array
*array
;
2775 BT_LOGW_STR("Invalid parameter: field type is NULL.");
2780 if (type
->id
!= BT_CTF_FIELD_TYPE_ID_ARRAY
) {
2781 BT_LOGW("Invalid parameter: field type is not an array field type: "
2782 "addr=%p, ft-id=%s", type
,
2783 bt_ctf_field_type_id_string(type
->id
));
2788 array
= container_of(type
, struct bt_ctf_field_type_array
, parent
);
2789 ret
= (int64_t) array
->length
;
2794 struct bt_ctf_field_type
*bt_ctf_field_type_sequence_create(
2795 struct bt_ctf_field_type
*element_type
,
2796 const char *length_field_name
)
2798 struct bt_ctf_field_type_sequence
*sequence
= NULL
;
2800 BT_LOGD("Creating sequence field type object: element-ft-addr=%p, "
2801 "length-field-name=\"%s\"", element_type
, length_field_name
);
2803 if (!element_type
) {
2804 BT_LOGW_STR("Invalid parameter: element field type is NULL.");
2808 if (bt_ctf_validate_identifier(length_field_name
)) {
2809 BT_LOGW("Invalid parameter: length field name is not a valid CTF identifier: "
2810 "length-field-name=\"%s\"", length_field_name
);
2814 sequence
= g_new0(struct bt_ctf_field_type_sequence
, 1);
2816 BT_LOGE_STR("Failed to allocate one sequence field type.");
2820 sequence
->parent
.id
= BT_CTF_FIELD_TYPE_ID_SEQUENCE
;
2821 bt_get(element_type
);
2822 sequence
->element_type
= element_type
;
2823 sequence
->length_field_name
= g_string_new(length_field_name
);
2824 bt_ctf_field_type_init(&sequence
->parent
, FALSE
);
2825 BT_LOGD("Created sequence field type object: addr=%p, "
2826 "element-ft-addr=%p, length-field-name=\"%s\"",
2827 &sequence
->parent
, element_type
, length_field_name
);
2828 return &sequence
->parent
;
2833 struct bt_ctf_field_type
*bt_ctf_field_type_sequence_get_element_type(
2834 struct bt_ctf_field_type
*type
)
2836 struct bt_ctf_field_type
*ret
= NULL
;
2837 struct bt_ctf_field_type_sequence
*sequence
;
2840 BT_LOGW_STR("Invalid parameter: field type is NULL.");
2844 if (type
->id
!= BT_CTF_FIELD_TYPE_ID_SEQUENCE
) {
2845 BT_LOGW("Invalid parameter: field type is not a sequence field type: "
2846 "addr=%p, ft-id=%s", type
,
2847 bt_ctf_field_type_id_string(type
->id
));
2851 sequence
= container_of(type
, struct bt_ctf_field_type_sequence
,
2853 ret
= sequence
->element_type
;
2860 int bt_ctf_field_type_sequence_set_element_type(struct bt_ctf_field_type
*type
,
2861 struct bt_ctf_field_type
*element_type
)
2864 struct bt_ctf_field_type_sequence
*sequence
;
2867 BT_LOGW_STR("Invalid parameter: sequence field type is NULL.");
2872 if (!element_type
) {
2873 BT_LOGW_STR("Invalid parameter: element field type is NULL.");
2878 if (type
->id
!= BT_CTF_FIELD_TYPE_ID_SEQUENCE
) {
2879 BT_LOGW("Invalid parameter: field type is not a sequence field type: "
2880 "addr=%p, ft-id=%s", type
,
2881 bt_ctf_field_type_id_string(type
->id
));
2886 sequence
= container_of(type
, struct bt_ctf_field_type_sequence
, parent
);
2887 if (sequence
->element_type
) {
2888 BT_PUT(sequence
->element_type
);
2891 sequence
->element_type
= element_type
;
2892 bt_get(sequence
->element_type
);
2893 BT_LOGV("Set sequence field type's element field type: sequence-ft-addr=%p, "
2894 "element-ft-addr=%p", type
, element_type
);
2900 const char *bt_ctf_field_type_sequence_get_length_field_name(
2901 struct bt_ctf_field_type
*type
)
2903 const char *ret
= NULL
;
2904 struct bt_ctf_field_type_sequence
*sequence
;
2907 BT_LOGW_STR("Invalid parameter: field type is NULL.");
2911 if (type
->id
!= BT_CTF_FIELD_TYPE_ID_SEQUENCE
) {
2912 BT_LOGW("Invalid parameter: field type is not a sequence field type: "
2913 "addr=%p, ft-id=%s", type
,
2914 bt_ctf_field_type_id_string(type
->id
));
2918 sequence
= container_of(type
, struct bt_ctf_field_type_sequence
,
2920 ret
= sequence
->length_field_name
->str
;
2925 struct bt_ctf_field_type
*bt_ctf_field_type_string_create(void)
2927 struct bt_ctf_field_type_string
*string
=
2928 g_new0(struct bt_ctf_field_type_string
, 1);
2930 BT_LOGD_STR("Creating string field type object.");
2933 BT_LOGE_STR("Failed to allocate one string field type.");
2937 string
->parent
.id
= BT_CTF_FIELD_TYPE_ID_STRING
;
2938 bt_ctf_field_type_init(&string
->parent
, TRUE
);
2939 string
->encoding
= BT_CTF_STRING_ENCODING_UTF8
;
2940 string
->parent
.alignment
= CHAR_BIT
;
2941 BT_LOGD("Created string field type object: addr=%p", &string
->parent
);
2942 return &string
->parent
;
2945 enum bt_ctf_string_encoding
bt_ctf_field_type_string_get_encoding(
2946 struct bt_ctf_field_type
*type
)
2948 struct bt_ctf_field_type_string
*string
;
2949 enum bt_ctf_string_encoding ret
= BT_CTF_STRING_ENCODING_UNKNOWN
;
2952 BT_LOGW_STR("Invalid parameter: field type is NULL.");
2956 if (type
->id
!= BT_CTF_FIELD_TYPE_ID_STRING
) {
2957 BT_LOGW("Invalid parameter: field type is not a string field type: "
2958 "addr=%p, ft-id=%s", type
,
2959 bt_ctf_field_type_id_string(type
->id
));
2963 string
= container_of(type
, struct bt_ctf_field_type_string
,
2965 ret
= string
->encoding
;
2970 int bt_ctf_field_type_string_set_encoding(struct bt_ctf_field_type
*type
,
2971 enum bt_ctf_string_encoding encoding
)
2974 struct bt_ctf_field_type_string
*string
;
2977 BT_LOGW_STR("Invalid parameter: field type is NULL.");
2982 if (type
->id
!= BT_CTF_FIELD_TYPE_ID_STRING
) {
2983 BT_LOGW("Invalid parameter: field type is not a string field type: "
2984 "addr=%p, ft-id=%s", type
,
2985 bt_ctf_field_type_id_string(type
->id
));
2990 if ((encoding
!= BT_CTF_STRING_ENCODING_UTF8
&&
2991 encoding
!= BT_CTF_STRING_ENCODING_ASCII
)) {
2992 BT_LOGW("Invalid parameter: unknown string encoding: "
2993 "addr=%p, encoding=%d", type
, encoding
);
2998 string
= container_of(type
, struct bt_ctf_field_type_string
, parent
);
2999 string
->encoding
= encoding
;
3000 BT_LOGV("Set string field type's encoding: addr=%p, encoding=%s",
3001 type
, bt_ctf_string_encoding_string(encoding
));
3006 int bt_ctf_field_type_get_alignment(struct bt_ctf_field_type
*type
)
3009 enum bt_ctf_field_type_id type_id
;
3012 BT_LOGW_STR("Invalid parameter: field type is NULL.");
3018 ret
= (int) type
->alignment
;
3022 type_id
= bt_ctf_field_type_get_type_id(type
);
3024 case BT_CTF_FIELD_TYPE_ID_SEQUENCE
:
3026 struct bt_ctf_field_type
*element
=
3027 bt_ctf_field_type_sequence_get_element_type(type
);
3030 ret
= bt_ctf_field_type_get_alignment(element
);
3034 case BT_CTF_FIELD_TYPE_ID_ARRAY
:
3036 struct bt_ctf_field_type
*element
=
3037 bt_ctf_field_type_array_get_element_type(type
);
3040 ret
= bt_ctf_field_type_get_alignment(element
);
3044 case BT_CTF_FIELD_TYPE_ID_STRUCT
:
3046 int64_t i
, element_count
;
3048 element_count
= bt_ctf_field_type_structure_get_field_count(
3050 assert(element_count
>= 0);
3052 for (i
= 0; i
< element_count
; i
++) {
3053 struct bt_ctf_field_type
*field
;
3054 int field_alignment
;
3056 ret
= bt_ctf_field_type_structure_get_field_by_index(
3057 type
, NULL
, &field
, i
);
3060 field_alignment
= bt_ctf_field_type_get_alignment(
3063 if (field_alignment
< 0) {
3064 ret
= field_alignment
;
3068 type
->alignment
= MAX(field_alignment
, type
->alignment
);
3070 ret
= (int) type
->alignment
;
3073 case BT_CTF_FIELD_TYPE_ID_UNKNOWN
:
3074 BT_LOGW("Invalid parameter: unknown field type ID: "
3075 "addr=%p, ft-id=%d", type
, type_id
);
3079 ret
= (int) type
->alignment
;
3087 int is_power_of_two(unsigned int value
)
3089 return ((value
& (value
- 1)) == 0) && value
> 0;
3092 int bt_ctf_field_type_set_alignment(struct bt_ctf_field_type
*type
,
3093 unsigned int alignment
)
3096 enum bt_ctf_field_type_id type_id
;
3098 /* Alignment must be a power of two */
3100 BT_LOGW_STR("Invalid parameter: field type is NULL.");
3106 BT_LOGW("Invalid parameter: field type is frozen: addr=%p",
3112 if (!is_power_of_two(alignment
)) {
3113 BT_LOGW("Invalid parameter: alignment is not a power of two: "
3114 "addr=%p, align=%u", type
, alignment
);
3119 type_id
= bt_ctf_field_type_get_type_id(type
);
3120 if (type_id
== BT_CTF_FIELD_TYPE_ID_UNKNOWN
) {
3121 BT_LOGW("Invalid parameter: unknown field type ID: "
3122 "addr=%p, ft-id=%d", type
, type_id
);
3127 if (type
->id
== BT_CTF_FIELD_TYPE_ID_STRING
&&
3128 alignment
!= CHAR_BIT
) {
3129 BT_LOGW("Invalid parameter: alignment must be %u for a string field type: "
3130 "addr=%p, align=%u", CHAR_BIT
, type
, alignment
);
3135 if (type_id
== BT_CTF_FIELD_TYPE_ID_VARIANT
||
3136 type_id
== BT_CTF_FIELD_TYPE_ID_SEQUENCE
||
3137 type_id
== BT_CTF_FIELD_TYPE_ID_ARRAY
) {
3138 /* Setting an alignment on these types makes no sense */
3139 BT_LOGW("Invalid parameter: cannot set the alignment of this field type: "
3140 "addr=%p, ft-id=%s", type
,
3141 bt_ctf_field_type_id_string(type
->id
));
3146 type
->alignment
= alignment
;
3148 BT_LOGV("Set field type's alignment: addr=%p, align=%u",
3154 enum bt_ctf_byte_order
bt_ctf_field_type_get_byte_order(
3155 struct bt_ctf_field_type
*type
)
3157 enum bt_ctf_byte_order ret
= BT_CTF_BYTE_ORDER_UNKNOWN
;
3160 BT_LOGW_STR("Invalid parameter: field type is NULL.");
3165 case BT_CTF_FIELD_TYPE_ID_INTEGER
:
3167 struct bt_ctf_field_type_integer
*integer
= container_of(
3168 type
, struct bt_ctf_field_type_integer
, parent
);
3169 ret
= integer
->user_byte_order
;
3172 case BT_CTF_FIELD_TYPE_ID_ENUM
:
3174 struct bt_ctf_field_type_enumeration
*enum_ft
= container_of(
3175 type
, struct bt_ctf_field_type_enumeration
, parent
);
3176 ret
= bt_ctf_field_type_get_byte_order(enum_ft
->container
);
3179 case BT_CTF_FIELD_TYPE_ID_FLOAT
:
3181 struct bt_ctf_field_type_floating_point
*floating_point
=
3183 struct bt_ctf_field_type_floating_point
,
3185 ret
= floating_point
->user_byte_order
;
3189 BT_LOGW("Invalid parameter: cannot get the byte order of this field type: "
3190 "addr=%p, ft-id=%s", type
,
3191 bt_ctf_field_type_id_string(type
->id
));
3195 assert(ret
== BT_CTF_BYTE_ORDER_NATIVE
||
3196 ret
== BT_CTF_BYTE_ORDER_LITTLE_ENDIAN
||
3197 ret
== BT_CTF_BYTE_ORDER_BIG_ENDIAN
||
3198 ret
== BT_CTF_BYTE_ORDER_NETWORK
);
3204 int bt_ctf_field_type_set_byte_order(struct bt_ctf_field_type
*type
,
3205 enum bt_ctf_byte_order byte_order
)
3210 BT_LOGW_STR("Invalid parameter: field type is NULL.");
3216 BT_LOGW("Invalid parameter: field type is frozen: addr=%p",
3222 if (byte_order
!= BT_CTF_BYTE_ORDER_NATIVE
&&
3223 byte_order
!= BT_CTF_BYTE_ORDER_LITTLE_ENDIAN
&&
3224 byte_order
!= BT_CTF_BYTE_ORDER_BIG_ENDIAN
&&
3225 byte_order
!= BT_CTF_BYTE_ORDER_NETWORK
) {
3226 BT_LOGW("Invalid parameter: invalid byte order: "
3227 "addr=%p, bo=%s", type
,
3228 bt_ctf_byte_order_string(byte_order
));
3233 if (set_byte_order_funcs
[type
->id
]) {
3234 set_byte_order_funcs
[type
->id
](type
, byte_order
);
3237 BT_LOGV("Set field type's byte order: addr=%p, bo=%s",
3238 type
, bt_ctf_byte_order_string(byte_order
));
3244 enum bt_ctf_field_type_id
bt_ctf_field_type_get_type_id(
3245 struct bt_ctf_field_type
*type
)
3248 BT_LOGW_STR("Invalid parameter: field type is NULL.");
3249 return BT_CTF_FIELD_TYPE_ID_UNKNOWN
;
3255 int bt_ctf_field_type_is_integer(struct bt_ctf_field_type
*type
)
3257 return bt_ctf_field_type_get_type_id(type
) == BT_CTF_FIELD_TYPE_ID_INTEGER
;
3260 int bt_ctf_field_type_is_floating_point(struct bt_ctf_field_type
*type
)
3262 return bt_ctf_field_type_get_type_id(type
) == BT_CTF_FIELD_TYPE_ID_FLOAT
;
3265 int bt_ctf_field_type_is_enumeration(struct bt_ctf_field_type
*type
)
3267 return bt_ctf_field_type_get_type_id(type
) == BT_CTF_FIELD_TYPE_ID_ENUM
;
3270 int bt_ctf_field_type_is_string(struct bt_ctf_field_type
*type
)
3272 return bt_ctf_field_type_get_type_id(type
) == BT_CTF_FIELD_TYPE_ID_STRING
;
3275 int bt_ctf_field_type_is_structure(struct bt_ctf_field_type
*type
)
3277 return bt_ctf_field_type_get_type_id(type
) == BT_CTF_FIELD_TYPE_ID_STRUCT
;
3280 int bt_ctf_field_type_is_array(struct bt_ctf_field_type
*type
)
3282 return bt_ctf_field_type_get_type_id(type
) == BT_CTF_FIELD_TYPE_ID_ARRAY
;
3285 int bt_ctf_field_type_is_sequence(struct bt_ctf_field_type
*type
)
3287 return bt_ctf_field_type_get_type_id(type
) == BT_CTF_FIELD_TYPE_ID_SEQUENCE
;
3290 int bt_ctf_field_type_is_variant(struct bt_ctf_field_type
*type
)
3292 return bt_ctf_field_type_get_type_id(type
) == BT_CTF_FIELD_TYPE_ID_VARIANT
;
3295 /* Pre-2.0 CTF writer backward compatibility */
3296 void bt_ctf_field_type_get(struct bt_ctf_field_type
*type
)
3301 /* Pre-2.0 CTF writer backward compatibility */
3302 void bt_ctf_field_type_put(struct bt_ctf_field_type
*type
)
3308 void bt_ctf_field_type_freeze(struct bt_ctf_field_type
*type
)
3310 if (!type
|| type
->frozen
) {
3318 struct bt_ctf_field_type
*bt_ctf_field_type_variant_get_field_type_signed(
3319 struct bt_ctf_field_type_variant
*variant
,
3322 struct bt_ctf_field_type
*type
= NULL
;
3323 GQuark field_name_quark
;
3325 struct structure_field
*field_entry
;
3326 struct range_overlap_query query
= {
3327 .range_start
._signed
= tag_value
,
3328 .range_end
._signed
= tag_value
,
3333 g_ptr_array_foreach(variant
->tag
->entries
, check_ranges_overlap
,
3335 if (!query
.overlaps
) {
3339 field_name_quark
= query
.mapping_name
;
3340 if (!g_hash_table_lookup_extended(variant
->field_name_to_index
,
3341 GUINT_TO_POINTER(field_name_quark
), NULL
, &index
)) {
3345 field_entry
= g_ptr_array_index(variant
->fields
, (size_t) index
);
3346 type
= field_entry
->type
;
3352 struct bt_ctf_field_type
*bt_ctf_field_type_variant_get_field_type_unsigned(
3353 struct bt_ctf_field_type_variant
*variant
,
3356 struct bt_ctf_field_type
*type
= NULL
;
3357 GQuark field_name_quark
;
3359 struct structure_field
*field_entry
;
3360 struct range_overlap_query query
= {
3361 .range_start
._unsigned
= tag_value
,
3362 .range_end
._unsigned
= tag_value
,
3367 g_ptr_array_foreach(variant
->tag
->entries
,
3368 check_ranges_overlap_unsigned
,
3370 if (!query
.overlaps
) {
3374 field_name_quark
= query
.mapping_name
;
3375 if (!g_hash_table_lookup_extended(variant
->field_name_to_index
,
3376 GUINT_TO_POINTER(field_name_quark
), NULL
, &index
)) {
3380 field_entry
= g_ptr_array_index(variant
->fields
, (size_t)index
);
3381 type
= field_entry
->type
;
3387 int bt_ctf_field_type_serialize(struct bt_ctf_field_type
*type
,
3388 struct metadata_context
*context
)
3395 /* Make sure field type is valid before serializing it */
3396 ret
= bt_ctf_field_type_validate(type
);
3398 BT_LOGW("Cannot serialize field type's metadata: field type is invalid: "
3403 ret
= type
->serialize(type
, context
);
3408 struct bt_ctf_field_type
*bt_ctf_field_type_copy(struct bt_ctf_field_type
*type
)
3410 struct bt_ctf_field_type
*copy
= NULL
;
3413 BT_LOGW_STR("Invalid parameter: field type is NULL.");
3417 copy
= type_copy_funcs
[type
->id
](type
);
3419 BT_LOGE_STR("Cannot copy field type.");
3423 copy
->alignment
= type
->alignment
;
3429 int bt_ctf_field_type_structure_get_field_name_index(
3430 struct bt_ctf_field_type
*type
, const char *name
)
3435 struct bt_ctf_field_type_structure
*structure
;
3438 BT_LOGW_STR("Invalid parameter: field type is NULL.");
3444 BT_LOGW_STR("Invalid parameter: field name is NULL.");
3449 if (bt_ctf_field_type_get_type_id(type
) != BT_CTF_FIELD_TYPE_ID_STRUCT
) {
3450 BT_LOGW("Invalid parameter: field type is not a structure field type: "
3451 "addr=%p, ft-id=%s", type
,
3452 bt_ctf_field_type_id_string(type
->id
));
3457 name_quark
= g_quark_try_string(name
);
3459 BT_LOGV("No such structure field type field name: "
3460 "ft-addr=%p, field-name=\"%s\"",
3466 structure
= container_of(type
, struct bt_ctf_field_type_structure
,
3468 if (!g_hash_table_lookup_extended(structure
->field_name_to_index
,
3469 GUINT_TO_POINTER(name_quark
),
3470 NULL
, (gpointer
*)&index
)) {
3471 BT_LOGV("No such structure field type field name: "
3472 "ft-addr=%p, field-name=\"%s\"",
3483 int bt_ctf_field_type_variant_get_field_name_index(
3484 struct bt_ctf_field_type
*type
, const char *name
)
3489 struct bt_ctf_field_type_variant
*variant
;
3492 BT_LOGW_STR("Invalid parameter: variant field type is NULL.");
3498 BT_LOGW_STR("Invalid parameter: field name is NULL.");
3503 if (bt_ctf_field_type_get_type_id(type
) != BT_CTF_FIELD_TYPE_ID_VARIANT
) {
3504 BT_LOGW("Invalid parameter: field type is not a variant field type: "
3505 "addr=%p, ft-id=%s", type
,
3506 bt_ctf_field_type_id_string(type
->id
));
3511 name_quark
= g_quark_try_string(name
);
3513 BT_LOGV("No such variant field type field name: "
3514 "ft-addr=%p, field-name=\"%s\"",
3520 variant
= container_of(type
, struct bt_ctf_field_type_variant
,
3522 if (!g_hash_table_lookup_extended(variant
->field_name_to_index
,
3523 GUINT_TO_POINTER(name_quark
),
3524 NULL
, (gpointer
*)&index
)) {
3525 BT_LOGV("No such variant field type field name: "
3526 "ft-addr=%p, field-name=\"%s\"",
3537 int bt_ctf_field_type_sequence_set_length_field_path(
3538 struct bt_ctf_field_type
*type
,
3539 struct bt_ctf_field_path
*path
)
3542 struct bt_ctf_field_type_sequence
*sequence
;
3545 BT_LOGW_STR("Invalid parameter: field type is NULL.");
3550 if (bt_ctf_field_type_get_type_id(type
) != BT_CTF_FIELD_TYPE_ID_SEQUENCE
) {
3551 BT_LOGW("Invalid parameter: field type is not a sequence field type: "
3552 "addr=%p, ft-id=%s", type
,
3553 bt_ctf_field_type_id_string(type
->id
));
3558 sequence
= container_of(type
, struct bt_ctf_field_type_sequence
,
3561 BT_MOVE(sequence
->length_field_path
, path
);
3562 BT_LOGV("Set sequence field type's length field path: ft-addr=%p, "
3563 "field-path-addr=%p", type
, path
);
3569 int bt_ctf_field_type_variant_set_tag_field_path(struct bt_ctf_field_type
*type
,
3570 struct bt_ctf_field_path
*path
)
3573 struct bt_ctf_field_type_variant
*variant
;
3576 BT_LOGW_STR("Invalid parameter: field type is NULL.");
3581 if (bt_ctf_field_type_get_type_id(type
) != BT_CTF_FIELD_TYPE_ID_VARIANT
) {
3582 BT_LOGW("Invalid parameter: field type is not a variant field type: "
3583 "addr=%p, ft-id=%s", type
,
3584 bt_ctf_field_type_id_string(type
->id
));
3589 variant
= container_of(type
, struct bt_ctf_field_type_variant
,
3592 BT_MOVE(variant
->tag_field_path
, path
);
3593 BT_LOGV("Set variant field type's tag field path: ft-addr=%p, "
3594 "field-path-addr=%p", type
, path
);
3600 int bt_ctf_field_type_variant_set_tag_field_type(struct bt_ctf_field_type
*type
,
3601 struct bt_ctf_field_type
*tag
)
3604 struct bt_ctf_field_type_variant
*variant
;
3607 BT_LOGW_STR("Invalid parameter: variant field type is NULL.");
3613 BT_LOGW_STR("Invalid parameter: tag field type is NULL.");
3618 if (bt_ctf_field_type_get_type_id(tag
) != BT_CTF_FIELD_TYPE_ID_ENUM
) {
3619 BT_LOGW("Invalid parameter: field type is not an enumeration field type: "
3620 "addr=%p, ft-id=%s", type
,
3621 bt_ctf_field_type_id_string(type
->id
));
3626 variant
= container_of(type
, struct bt_ctf_field_type_variant
,
3630 bt_put(&variant
->tag
->parent
);
3632 variant
->tag
= container_of(tag
, struct bt_ctf_field_type_enumeration
,
3634 BT_LOGV("Set variant field type's tag field type: variant-ft-addr=%p, "
3635 "tag-ft-addr=%p", type
, tag
);
3641 void bt_ctf_field_type_integer_destroy(struct bt_ctf_field_type
*type
)
3643 struct bt_ctf_field_type_integer
*integer
=
3644 (struct bt_ctf_field_type_integer
*) type
;
3650 BT_LOGD("Destroying integer field type object: addr=%p", type
);
3651 BT_LOGD_STR("Putting mapped clock class.");
3652 bt_put(integer
->mapped_clock
);
3657 void bt_ctf_field_type_enumeration_destroy(struct bt_ctf_field_type
*type
)
3659 struct bt_ctf_field_type_enumeration
*enumeration
=
3660 (struct bt_ctf_field_type_enumeration
*) type
;
3666 BT_LOGD("Destroying enumeration field type object: addr=%p", type
);
3667 g_ptr_array_free(enumeration
->entries
, TRUE
);
3668 BT_LOGD_STR("Putting container field type.");
3669 bt_put(enumeration
->container
);
3670 g_free(enumeration
);
3674 void bt_ctf_field_type_floating_point_destroy(struct bt_ctf_field_type
*type
)
3676 struct bt_ctf_field_type_floating_point
*floating_point
=
3677 (struct bt_ctf_field_type_floating_point
*) type
;
3683 BT_LOGD("Destroying floating point number field type object: addr=%p", type
);
3684 g_free(floating_point
);
3688 void bt_ctf_field_type_structure_destroy(struct bt_ctf_field_type
*type
)
3690 struct bt_ctf_field_type_structure
*structure
=
3691 (struct bt_ctf_field_type_structure
*) type
;
3697 BT_LOGD("Destroying structure field type object: addr=%p", type
);
3698 g_ptr_array_free(structure
->fields
, TRUE
);
3699 g_hash_table_destroy(structure
->field_name_to_index
);
3704 void bt_ctf_field_type_variant_destroy(struct bt_ctf_field_type
*type
)
3706 struct bt_ctf_field_type_variant
*variant
=
3707 (struct bt_ctf_field_type_variant
*) type
;
3713 BT_LOGD("Destroying variant field type object: addr=%p", type
);
3714 g_ptr_array_free(variant
->fields
, TRUE
);
3715 g_hash_table_destroy(variant
->field_name_to_index
);
3716 g_string_free(variant
->tag_name
, TRUE
);
3717 BT_LOGD_STR("Putting tag field type.");
3718 bt_put(&variant
->tag
->parent
);
3719 BT_PUT(variant
->tag_field_path
);
3724 void bt_ctf_field_type_array_destroy(struct bt_ctf_field_type
*type
)
3726 struct bt_ctf_field_type_array
*array
=
3727 (struct bt_ctf_field_type_array
*) type
;
3733 BT_LOGD("Destroying array field type object: addr=%p", type
);
3734 BT_LOGD_STR("Putting element field type.");
3735 bt_put(array
->element_type
);
3740 void bt_ctf_field_type_sequence_destroy(struct bt_ctf_field_type
*type
)
3742 struct bt_ctf_field_type_sequence
*sequence
=
3743 (struct bt_ctf_field_type_sequence
*) type
;
3749 BT_LOGD("Destroying sequence field type object: addr=%p", type
);
3750 BT_LOGD_STR("Putting element field type.");
3751 bt_put(sequence
->element_type
);
3752 g_string_free(sequence
->length_field_name
, TRUE
);
3753 BT_LOGD_STR("Putting length field path.");
3754 BT_PUT(sequence
->length_field_path
);
3759 void bt_ctf_field_type_string_destroy(struct bt_ctf_field_type
*type
)
3761 struct bt_ctf_field_type_string
*string
=
3762 (struct bt_ctf_field_type_string
*) type
;
3768 BT_LOGD("Destroying string field type object: addr=%p", type
);
3773 void generic_field_type_freeze(struct bt_ctf_field_type
*type
)
3779 void bt_ctf_field_type_integer_freeze(struct bt_ctf_field_type
*type
)
3781 struct bt_ctf_field_type_integer
*integer_type
= container_of(
3782 type
, struct bt_ctf_field_type_integer
, parent
);
3784 BT_LOGD("Freezing integer field type object: addr=%p", type
);
3786 if (integer_type
->mapped_clock
) {
3787 BT_LOGD_STR("Freezing integer field type's mapped clock class.");
3788 bt_ctf_clock_class_freeze(integer_type
->mapped_clock
);
3791 generic_field_type_freeze(type
);
3795 void bt_ctf_field_type_enumeration_freeze(struct bt_ctf_field_type
*type
)
3797 struct bt_ctf_field_type_enumeration
*enumeration_type
= container_of(
3798 type
, struct bt_ctf_field_type_enumeration
, parent
);
3800 BT_LOGD("Freezing enumeration field type object: addr=%p", type
);
3801 set_enumeration_range_overlap(type
);
3802 generic_field_type_freeze(type
);
3803 BT_LOGD("Freezing enumeration field type object's container field type: int-ft-addr=%p",
3804 enumeration_type
->container
);
3805 bt_ctf_field_type_freeze(enumeration_type
->container
);
3809 void freeze_structure_field(struct structure_field
*field
)
3811 BT_LOGD("Freezing structure/variant field type field: field-addr=%p, "
3812 "field-ft-addr=%p, field-name=\"%s\"", field
,
3813 field
->type
, g_quark_to_string(field
->name
));
3814 bt_ctf_field_type_freeze(field
->type
);
3818 void bt_ctf_field_type_structure_freeze(struct bt_ctf_field_type
*type
)
3820 struct bt_ctf_field_type_structure
*structure_type
= container_of(
3821 type
, struct bt_ctf_field_type_structure
, parent
);
3823 /* Cache the alignment */
3824 BT_LOGD("Freezing structure field type object: addr=%p", type
);
3825 type
->alignment
= bt_ctf_field_type_get_alignment(type
);
3826 generic_field_type_freeze(type
);
3827 g_ptr_array_foreach(structure_type
->fields
,
3828 (GFunc
) freeze_structure_field
, NULL
);
3832 void bt_ctf_field_type_variant_freeze(struct bt_ctf_field_type
*type
)
3834 struct bt_ctf_field_type_variant
*variant_type
= container_of(
3835 type
, struct bt_ctf_field_type_variant
, parent
);
3837 BT_LOGD("Freezing variant field type object: addr=%p", type
);
3838 generic_field_type_freeze(type
);
3839 g_ptr_array_foreach(variant_type
->fields
,
3840 (GFunc
) freeze_structure_field
, NULL
);
3844 void bt_ctf_field_type_array_freeze(struct bt_ctf_field_type
*type
)
3846 struct bt_ctf_field_type_array
*array_type
= container_of(
3847 type
, struct bt_ctf_field_type_array
, parent
);
3849 /* Cache the alignment */
3850 BT_LOGD("Freezing array field type object: addr=%p", type
);
3851 type
->alignment
= bt_ctf_field_type_get_alignment(type
);
3852 generic_field_type_freeze(type
);
3853 BT_LOGD("Freezing array field type object's element field type: element-ft-addr=%p",
3854 array_type
->element_type
);
3855 bt_ctf_field_type_freeze(array_type
->element_type
);
3859 void bt_ctf_field_type_sequence_freeze(struct bt_ctf_field_type
*type
)
3861 struct bt_ctf_field_type_sequence
*sequence_type
= container_of(
3862 type
, struct bt_ctf_field_type_sequence
, parent
);
3864 /* Cache the alignment */
3865 BT_LOGD("Freezing sequence field type object: addr=%p", type
);
3866 type
->alignment
= bt_ctf_field_type_get_alignment(type
);
3867 generic_field_type_freeze(type
);
3868 BT_LOGD("Freezing sequence field type object's element field type: element-ft-addr=%p",
3869 sequence_type
->element_type
);
3870 bt_ctf_field_type_freeze(sequence_type
->element_type
);
3874 const char *get_encoding_string(enum bt_ctf_string_encoding encoding
)
3876 const char *encoding_string
;
3879 case BT_CTF_STRING_ENCODING_NONE
:
3880 encoding_string
= "none";
3882 case BT_CTF_STRING_ENCODING_ASCII
:
3883 encoding_string
= "ASCII";
3885 case BT_CTF_STRING_ENCODING_UTF8
:
3886 encoding_string
= "UTF8";
3889 encoding_string
= "unknown";
3893 return encoding_string
;
3897 const char *get_integer_base_string(enum bt_ctf_integer_base base
)
3899 const char *base_string
;
3902 case BT_CTF_INTEGER_BASE_DECIMAL
:
3903 base_string
= "decimal";
3905 case BT_CTF_INTEGER_BASE_HEXADECIMAL
:
3906 base_string
= "hexadecimal";
3908 case BT_CTF_INTEGER_BASE_OCTAL
:
3909 base_string
= "octal";
3911 case BT_CTF_INTEGER_BASE_BINARY
:
3912 base_string
= "binary";
3915 base_string
= "unknown";
3923 int bt_ctf_field_type_integer_serialize(struct bt_ctf_field_type
*type
,
3924 struct metadata_context
*context
)
3926 struct bt_ctf_field_type_integer
*integer
= container_of(type
,
3927 struct bt_ctf_field_type_integer
, parent
);
3930 BT_LOGD("Serializing integer field type's metadata: "
3931 "ft-addr=%p, metadata-context-addr=%p", type
, context
);
3932 g_string_append_printf(context
->string
,
3933 "integer { size = %u; align = %u; signed = %s; encoding = %s; base = %s; byte_order = %s",
3934 integer
->size
, type
->alignment
,
3935 (integer
->is_signed
? "true" : "false"),
3936 get_encoding_string(integer
->encoding
),
3937 get_integer_base_string(integer
->base
),
3938 get_byte_order_string(integer
->user_byte_order
));
3939 if (integer
->mapped_clock
) {
3940 const char *clock_name
= bt_ctf_clock_class_get_name(
3941 integer
->mapped_clock
);
3944 g_string_append_printf(context
->string
,
3945 "; map = clock.%s.value", clock_name
);
3948 g_string_append(context
->string
, "; }");
3953 int bt_ctf_field_type_enumeration_serialize(struct bt_ctf_field_type
*type
,
3954 struct metadata_context
*context
)
3958 struct bt_ctf_field_type_enumeration
*enumeration
= container_of(type
,
3959 struct bt_ctf_field_type_enumeration
, parent
);
3960 struct bt_ctf_field_type
*container_type
;
3961 int container_signed
;
3963 BT_LOGD("Serializing enumeration field type's metadata: "
3964 "ft-addr=%p, metadata-context-addr=%p", type
, context
);
3965 container_type
= bt_ctf_field_type_enumeration_get_container_type(type
);
3966 assert(container_type
);
3967 container_signed
= bt_ctf_field_type_integer_get_signed(container_type
);
3968 assert(container_signed
>= 0);
3969 g_string_append(context
->string
, "enum : ");
3970 BT_LOGD_STR("Serializing enumeration field type's container field type's metadata.");
3971 ret
= bt_ctf_field_type_serialize(enumeration
->container
, context
);
3973 BT_LOGW("Cannot serialize enumeration field type's container field type's metadata: "
3974 "container-ft-addr=%p", enumeration
->container
);
3978 g_string_append(context
->string
, " { ");
3979 for (entry
= 0; entry
< enumeration
->entries
->len
; entry
++) {
3980 struct enumeration_mapping
*mapping
=
3981 enumeration
->entries
->pdata
[entry
];
3983 if (container_signed
) {
3984 if (mapping
->range_start
._signed
==
3985 mapping
->range_end
._signed
) {
3986 g_string_append_printf(context
->string
,
3987 "\"%s\" = %" PRId64
,
3988 g_quark_to_string(mapping
->string
),
3989 mapping
->range_start
._signed
);
3991 g_string_append_printf(context
->string
,
3992 "\"%s\" = %" PRId64
" ... %" PRId64
,
3993 g_quark_to_string(mapping
->string
),
3994 mapping
->range_start
._signed
,
3995 mapping
->range_end
._signed
);
3998 if (mapping
->range_start
._unsigned
==
3999 mapping
->range_end
._unsigned
) {
4000 g_string_append_printf(context
->string
,
4001 "\"%s\" = %" PRIu64
,
4002 g_quark_to_string(mapping
->string
),
4003 mapping
->range_start
._unsigned
);
4005 g_string_append_printf(context
->string
,
4006 "\"%s\" = %" PRIu64
" ... %" PRIu64
,
4007 g_quark_to_string(mapping
->string
),
4008 mapping
->range_start
._unsigned
,
4009 mapping
->range_end
._unsigned
);
4013 g_string_append(context
->string
,
4014 ((entry
!= (enumeration
->entries
->len
- 1)) ?
4018 if (context
->field_name
->len
) {
4019 g_string_append_printf(context
->string
, " %s",
4020 context
->field_name
->str
);
4021 g_string_assign(context
->field_name
, "");
4024 bt_put(container_type
);
4029 int bt_ctf_field_type_floating_point_serialize(struct bt_ctf_field_type
*type
,
4030 struct metadata_context
*context
)
4032 struct bt_ctf_field_type_floating_point
*floating_point
= container_of(
4033 type
, struct bt_ctf_field_type_floating_point
, parent
);
4035 BT_LOGD("Serializing floating point number field type's metadata: "
4036 "ft-addr=%p, metadata-context-addr=%p", type
, context
);
4037 g_string_append_printf(context
->string
,
4038 "floating_point { exp_dig = %u; mant_dig = %u; byte_order = %s; align = %u; }",
4039 floating_point
->exp_dig
,
4040 floating_point
->mant_dig
,
4041 get_byte_order_string(floating_point
->user_byte_order
),
4047 int bt_ctf_field_type_structure_serialize(struct bt_ctf_field_type
*type
,
4048 struct metadata_context
*context
)
4051 unsigned int indent
;
4053 struct bt_ctf_field_type_structure
*structure
= container_of(type
,
4054 struct bt_ctf_field_type_structure
, parent
);
4055 GString
*structure_field_name
= context
->field_name
;
4057 BT_LOGD("Serializing structure field type's metadata: "
4058 "ft-addr=%p, metadata-context-addr=%p", type
, context
);
4059 context
->field_name
= g_string_new("");
4061 context
->current_indentation_level
++;
4062 g_string_append(context
->string
, "struct {\n");
4064 for (i
= 0; i
< structure
->fields
->len
; i
++) {
4065 struct structure_field
*field
= structure
->fields
->pdata
[i
];
4067 BT_LOGD("Serializing structure field type's field metadata: "
4068 "index=%" PRId64
", "
4069 "field-ft-addr=%p, field-name=\"%s\"",
4070 i
, field
, g_quark_to_string(field
->name
));
4072 for (indent
= 0; indent
< context
->current_indentation_level
;
4074 g_string_append_c(context
->string
, '\t');
4077 g_string_assign(context
->field_name
,
4078 g_quark_to_string(field
->name
));
4079 ret
= bt_ctf_field_type_serialize(field
->type
, context
);
4081 BT_LOGW("Cannot serialize structure field type's field's metadata: "
4082 "index=%" PRId64
", "
4083 "field-ft-addr=%p, field-name=\"%s\"",
4085 g_quark_to_string(field
->name
));
4089 if (context
->field_name
->len
) {
4090 g_string_append_printf(context
->string
, " %s",
4091 context
->field_name
->str
);
4093 g_string_append(context
->string
, ";\n");
4096 context
->current_indentation_level
--;
4097 for (indent
= 0; indent
< context
->current_indentation_level
;
4099 g_string_append_c(context
->string
, '\t');
4102 g_string_append_printf(context
->string
, "} align(%u)",
4105 g_string_free(context
->field_name
, TRUE
);
4106 context
->field_name
= structure_field_name
;
4111 int bt_ctf_field_type_variant_serialize(struct bt_ctf_field_type
*type
,
4112 struct metadata_context
*context
)
4115 unsigned int indent
;
4117 struct bt_ctf_field_type_variant
*variant
= container_of(
4118 type
, struct bt_ctf_field_type_variant
, parent
);
4119 GString
*variant_field_name
= context
->field_name
;
4121 BT_LOGD("Serializing variant field type's metadata: "
4122 "ft-addr=%p, metadata-context-addr=%p", type
, context
);
4123 context
->field_name
= g_string_new("");
4124 if (variant
->tag_name
->len
> 0) {
4125 g_string_append_printf(context
->string
,
4126 "variant <%s> {\n", variant
->tag_name
->str
);
4128 g_string_append(context
->string
, "variant {\n");
4131 context
->current_indentation_level
++;
4132 for (i
= 0; i
< variant
->fields
->len
; i
++) {
4133 struct structure_field
*field
= variant
->fields
->pdata
[i
];
4135 BT_LOGD("Serializing variant field type's field metadata: "
4136 "index=%" PRId64
", "
4137 "field-ft-addr=%p, field-name=\"%s\"",
4138 i
, field
, g_quark_to_string(field
->name
));
4140 g_string_assign(context
->field_name
,
4141 g_quark_to_string(field
->name
));
4142 for (indent
= 0; indent
< context
->current_indentation_level
;
4144 g_string_append_c(context
->string
, '\t');
4147 g_string_assign(context
->field_name
,
4148 g_quark_to_string(field
->name
));
4149 ret
= bt_ctf_field_type_serialize(field
->type
, context
);
4151 BT_LOGW("Cannot serialize variant field type's field's metadata: "
4152 "index=%" PRId64
", "
4153 "field-ft-addr=%p, field-name=\"%s\"",
4155 g_quark_to_string(field
->name
));
4159 if (context
->field_name
->len
) {
4160 g_string_append_printf(context
->string
, " %s;",
4161 context
->field_name
->str
);
4164 g_string_append_c(context
->string
, '\n');
4167 context
->current_indentation_level
--;
4168 for (indent
= 0; indent
< context
->current_indentation_level
;
4170 g_string_append_c(context
->string
, '\t');
4173 g_string_append(context
->string
, "}");
4175 g_string_free(context
->field_name
, TRUE
);
4176 context
->field_name
= variant_field_name
;
4181 int bt_ctf_field_type_array_serialize(struct bt_ctf_field_type
*type
,
4182 struct metadata_context
*context
)
4185 struct bt_ctf_field_type_array
*array
= container_of(type
,
4186 struct bt_ctf_field_type_array
, parent
);
4188 BT_LOGD("Serializing array field type's metadata: "
4189 "ft-addr=%p, metadata-context-addr=%p", type
, context
);
4190 BT_LOGD_STR("Serializing array field type's element field type's metadata.");
4191 ret
= bt_ctf_field_type_serialize(array
->element_type
, context
);
4193 BT_LOGW("Cannot serialize array field type's element field type's metadata: "
4194 "element-ft-addr=%p", array
->element_type
);
4198 if (context
->field_name
->len
) {
4199 g_string_append_printf(context
->string
, " %s[%u]",
4200 context
->field_name
->str
, array
->length
);
4201 g_string_assign(context
->field_name
, "");
4203 g_string_append_printf(context
->string
, "[%u]", array
->length
);
4210 int bt_ctf_field_type_sequence_serialize(struct bt_ctf_field_type
*type
,
4211 struct metadata_context
*context
)
4214 struct bt_ctf_field_type_sequence
*sequence
= container_of(
4215 type
, struct bt_ctf_field_type_sequence
, parent
);
4217 BT_LOGD("Serializing sequence field type's metadata: "
4218 "ft-addr=%p, metadata-context-addr=%p", type
, context
);
4219 BT_LOGD_STR("Serializing sequence field type's element field type's metadata.");
4220 ret
= bt_ctf_field_type_serialize(sequence
->element_type
, context
);
4222 BT_LOGW("Cannot serialize sequence field type's element field type's metadata: "
4223 "element-ft-addr=%p", sequence
->element_type
);
4227 if (context
->field_name
->len
) {
4228 g_string_append_printf(context
->string
, " %s[%s]",
4229 context
->field_name
->str
,
4230 sequence
->length_field_name
->str
);
4231 g_string_assign(context
->field_name
, "");
4233 g_string_append_printf(context
->string
, "[%s]",
4234 sequence
->length_field_name
->str
);
4241 int bt_ctf_field_type_string_serialize(struct bt_ctf_field_type
*type
,
4242 struct metadata_context
*context
)
4244 struct bt_ctf_field_type_string
*string
= container_of(
4245 type
, struct bt_ctf_field_type_string
, parent
);
4247 BT_LOGD("Serializing string field type's metadata: "
4248 "ft-addr=%p, metadata-context-addr=%p", type
, context
);
4249 g_string_append_printf(context
->string
,
4250 "string { encoding = %s; }",
4251 get_encoding_string(string
->encoding
));
4256 void bt_ctf_field_type_integer_set_byte_order(struct bt_ctf_field_type
*type
,
4257 enum bt_ctf_byte_order byte_order
)
4259 struct bt_ctf_field_type_integer
*integer_type
= container_of(type
,
4260 struct bt_ctf_field_type_integer
, parent
);
4262 integer_type
->user_byte_order
= byte_order
;
4266 void bt_ctf_field_type_enumeration_set_byte_order(
4267 struct bt_ctf_field_type
*type
, enum bt_ctf_byte_order byte_order
)
4269 struct bt_ctf_field_type_enumeration
*enum_type
= container_of(type
,
4270 struct bt_ctf_field_type_enumeration
, parent
);
4272 /* Safe to assume that container is an integer */
4273 bt_ctf_field_type_integer_set_byte_order(enum_type
->container
,
4278 void bt_ctf_field_type_floating_point_set_byte_order(
4279 struct bt_ctf_field_type
*type
, enum bt_ctf_byte_order byte_order
)
4281 struct bt_ctf_field_type_floating_point
*floating_point_type
=
4282 container_of(type
, struct bt_ctf_field_type_floating_point
,
4285 floating_point_type
->user_byte_order
= byte_order
;
4289 void bt_ctf_field_type_structure_set_byte_order(struct bt_ctf_field_type
*type
,
4290 enum bt_ctf_byte_order byte_order
)
4293 struct bt_ctf_field_type_structure
*structure_type
=
4294 container_of(type
, struct bt_ctf_field_type_structure
,
4297 for (i
= 0; i
< structure_type
->fields
->len
; i
++) {
4298 struct structure_field
*field
= g_ptr_array_index(
4299 structure_type
->fields
, i
);
4300 struct bt_ctf_field_type
*field_type
= field
->type
;
4302 if (set_byte_order_funcs
[field_type
->id
]) {
4303 set_byte_order_funcs
[field_type
->id
](
4304 field_type
, byte_order
);
4310 void bt_ctf_field_type_variant_set_byte_order(struct bt_ctf_field_type
*type
,
4311 enum bt_ctf_byte_order byte_order
)
4314 struct bt_ctf_field_type_variant
*variant_type
=
4315 container_of(type
, struct bt_ctf_field_type_variant
,
4318 for (i
= 0; i
< variant_type
->fields
->len
; i
++) {
4319 struct structure_field
*field
= g_ptr_array_index(
4320 variant_type
->fields
, i
);
4321 struct bt_ctf_field_type
*field_type
= field
->type
;
4323 if (set_byte_order_funcs
[field_type
->id
]) {
4324 set_byte_order_funcs
[field_type
->id
](
4325 field_type
, byte_order
);
4331 void bt_ctf_field_type_array_set_byte_order(struct bt_ctf_field_type
*type
,
4332 enum bt_ctf_byte_order byte_order
)
4334 struct bt_ctf_field_type_array
*array_type
=
4335 container_of(type
, struct bt_ctf_field_type_array
,
4338 if (set_byte_order_funcs
[array_type
->element_type
->id
]) {
4339 set_byte_order_funcs
[array_type
->element_type
->id
](
4340 array_type
->element_type
, byte_order
);
4345 void bt_ctf_field_type_sequence_set_byte_order(struct bt_ctf_field_type
*type
,
4346 enum bt_ctf_byte_order byte_order
)
4348 struct bt_ctf_field_type_sequence
*sequence_type
=
4349 container_of(type
, struct bt_ctf_field_type_sequence
,
4352 if (set_byte_order_funcs
[
4353 sequence_type
->element_type
->id
]) {
4354 set_byte_order_funcs
[
4355 sequence_type
->element_type
->id
](
4356 sequence_type
->element_type
, byte_order
);
4361 struct bt_ctf_field_type
*bt_ctf_field_type_integer_copy(
4362 struct bt_ctf_field_type
*type
)
4364 struct bt_ctf_field_type
*copy
;
4365 struct bt_ctf_field_type_integer
*integer
, *copy_integer
;
4367 BT_LOGD("Copying integer field type's: addr=%p", type
);
4368 integer
= container_of(type
, struct bt_ctf_field_type_integer
, parent
);
4369 copy
= bt_ctf_field_type_integer_create(integer
->size
);
4371 BT_LOGE_STR("Cannot create integer field type.");
4375 copy_integer
= container_of(copy
, struct bt_ctf_field_type_integer
,
4377 copy_integer
->mapped_clock
= bt_get(integer
->mapped_clock
);
4378 copy_integer
->user_byte_order
= integer
->user_byte_order
;
4379 copy_integer
->is_signed
= integer
->is_signed
;
4380 copy_integer
->size
= integer
->size
;
4381 copy_integer
->base
= integer
->base
;
4382 copy_integer
->encoding
= integer
->encoding
;
4383 BT_LOGD("Copied integer field type: original-ft-addr=%p, copy-ft-addr=%p",
4391 struct bt_ctf_field_type
*bt_ctf_field_type_enumeration_copy(
4392 struct bt_ctf_field_type
*type
)
4395 struct bt_ctf_field_type
*copy
= NULL
, *copy_container
;
4396 struct bt_ctf_field_type_enumeration
*enumeration
, *copy_enumeration
;
4398 BT_LOGD("Copying enumeration field type's: addr=%p", type
);
4399 enumeration
= container_of(type
, struct bt_ctf_field_type_enumeration
,
4402 /* Copy the source enumeration's container */
4403 BT_LOGD_STR("Copying enumeration field type's container field type.");
4404 copy_container
= bt_ctf_field_type_copy(enumeration
->container
);
4405 if (!copy_container
) {
4406 BT_LOGE_STR("Cannot copy enumeration field type's container field type.");
4410 copy
= bt_ctf_field_type_enumeration_create(copy_container
);
4412 BT_LOGE_STR("Cannot create enumeration field type.");
4415 copy_enumeration
= container_of(copy
,
4416 struct bt_ctf_field_type_enumeration
, parent
);
4418 /* Copy all enumaration entries */
4419 for (i
= 0; i
< enumeration
->entries
->len
; i
++) {
4420 struct enumeration_mapping
*mapping
= g_ptr_array_index(
4421 enumeration
->entries
, i
);
4422 struct enumeration_mapping
*copy_mapping
= g_new0(
4423 struct enumeration_mapping
, 1);
4425 if (!copy_mapping
) {
4426 BT_LOGE_STR("Failed to allocate one enumeration mapping.");
4430 *copy_mapping
= *mapping
;
4431 g_ptr_array_add(copy_enumeration
->entries
, copy_mapping
);
4434 BT_LOGD("Copied enumeration field type: original-ft-addr=%p, copy-ft-addr=%p",
4438 bt_put(copy_container
);
4441 bt_put(copy_container
);
4447 struct bt_ctf_field_type
*bt_ctf_field_type_floating_point_copy(
4448 struct bt_ctf_field_type
*type
)
4450 struct bt_ctf_field_type
*copy
;
4451 struct bt_ctf_field_type_floating_point
*floating_point
, *copy_float
;
4453 BT_LOGD("Copying floating point number field type's: addr=%p", type
);
4454 floating_point
= container_of(type
,
4455 struct bt_ctf_field_type_floating_point
, parent
);
4456 copy
= bt_ctf_field_type_floating_point_create();
4458 BT_LOGE_STR("Cannot create floating point number field type.");
4462 copy_float
= container_of(copy
,
4463 struct bt_ctf_field_type_floating_point
, parent
);
4464 copy_float
->user_byte_order
= floating_point
->user_byte_order
;
4465 copy_float
->exp_dig
= floating_point
->exp_dig
;
4466 copy_float
->mant_dig
= floating_point
->mant_dig
;
4467 BT_LOGD("Copied floating point number field type: original-ft-addr=%p, copy-ft-addr=%p",
4474 struct bt_ctf_field_type
*bt_ctf_field_type_structure_copy(
4475 struct bt_ctf_field_type
*type
)
4478 GHashTableIter iter
;
4479 gpointer key
, value
;
4480 struct bt_ctf_field_type
*copy
;
4481 struct bt_ctf_field_type_structure
*structure
, *copy_structure
;
4483 BT_LOGD("Copying structure field type's: addr=%p", type
);
4484 structure
= container_of(type
, struct bt_ctf_field_type_structure
,
4486 copy
= bt_ctf_field_type_structure_create();
4488 BT_LOGE_STR("Cannot create structure field type.");
4492 copy_structure
= container_of(copy
,
4493 struct bt_ctf_field_type_structure
, parent
);
4495 /* Copy field_name_to_index */
4496 g_hash_table_iter_init(&iter
, structure
->field_name_to_index
);
4497 while (g_hash_table_iter_next (&iter
, &key
, &value
)) {
4498 g_hash_table_insert(copy_structure
->field_name_to_index
,
4502 for (i
= 0; i
< structure
->fields
->len
; i
++) {
4503 struct structure_field
*entry
, *copy_entry
;
4504 struct bt_ctf_field_type
*copy_field
;
4506 entry
= g_ptr_array_index(structure
->fields
, i
);
4507 BT_LOGD("Copying structure field type's field: "
4508 "index=%" PRId64
", "
4509 "field-ft-addr=%p, field-name=\"%s\"",
4510 i
, entry
, g_quark_to_string(entry
->name
));
4511 copy_entry
= g_new0(struct structure_field
, 1);
4513 BT_LOGE_STR("Failed to allocate one structure field type field.");
4517 copy_field
= bt_ctf_field_type_copy(entry
->type
);
4519 BT_LOGE("Cannot copy structure field type's field: "
4520 "index=%" PRId64
", "
4521 "field-ft-addr=%p, field-name=\"%s\"",
4522 i
, entry
, g_quark_to_string(entry
->name
));
4527 copy_entry
->name
= entry
->name
;
4528 copy_entry
->type
= copy_field
;
4529 g_ptr_array_add(copy_structure
->fields
, copy_entry
);
4532 BT_LOGD("Copied structure field type: original-ft-addr=%p, copy-ft-addr=%p",
4543 struct bt_ctf_field_type
*bt_ctf_field_type_variant_copy(
4544 struct bt_ctf_field_type
*type
)
4547 GHashTableIter iter
;
4548 gpointer key
, value
;
4549 struct bt_ctf_field_type
*copy
= NULL
, *copy_tag
= NULL
;
4550 struct bt_ctf_field_type_variant
*variant
, *copy_variant
;
4552 BT_LOGD("Copying variant field type's: addr=%p", type
);
4553 variant
= container_of(type
, struct bt_ctf_field_type_variant
,
4556 BT_LOGD_STR("Copying variant field type's tag field type.");
4557 copy_tag
= bt_ctf_field_type_copy(&variant
->tag
->parent
);
4559 BT_LOGE_STR("Cannot copy variant field type's tag field type.");
4564 copy
= bt_ctf_field_type_variant_create(copy_tag
,
4565 variant
->tag_name
->len
? variant
->tag_name
->str
: NULL
);
4567 BT_LOGE_STR("Cannot create variant field type.");
4571 copy_variant
= container_of(copy
, struct bt_ctf_field_type_variant
,
4574 /* Copy field_name_to_index */
4575 g_hash_table_iter_init(&iter
, variant
->field_name_to_index
);
4576 while (g_hash_table_iter_next (&iter
, &key
, &value
)) {
4577 g_hash_table_insert(copy_variant
->field_name_to_index
,
4581 for (i
= 0; i
< variant
->fields
->len
; i
++) {
4582 struct structure_field
*entry
, *copy_entry
;
4583 struct bt_ctf_field_type
*copy_field
;
4585 entry
= g_ptr_array_index(variant
->fields
, i
);
4586 BT_LOGD("Copying variant field type's field: "
4587 "index=%" PRId64
", "
4588 "field-ft-addr=%p, field-name=\"%s\"",
4589 i
, entry
, g_quark_to_string(entry
->name
));
4590 copy_entry
= g_new0(struct structure_field
, 1);
4592 BT_LOGE_STR("Failed to allocate one variant field type field.");
4596 copy_field
= bt_ctf_field_type_copy(entry
->type
);
4598 BT_LOGE("Cannot copy variant field type's field: "
4599 "index=%" PRId64
", "
4600 "field-ft-addr=%p, field-name=\"%s\"",
4601 i
, entry
, g_quark_to_string(entry
->name
));
4606 copy_entry
->name
= entry
->name
;
4607 copy_entry
->type
= copy_field
;
4608 g_ptr_array_add(copy_variant
->fields
, copy_entry
);
4611 if (variant
->tag_field_path
) {
4612 BT_LOGD_STR("Copying variant field type's tag field path.");
4613 copy_variant
->tag_field_path
= bt_ctf_field_path_copy(
4614 variant
->tag_field_path
);
4615 if (!copy_variant
->tag_field_path
) {
4616 BT_LOGE_STR("Cannot copy variant field type's tag field path.");
4621 BT_LOGD("Copied variant field type: original-ft-addr=%p, copy-ft-addr=%p",
4634 struct bt_ctf_field_type
*bt_ctf_field_type_array_copy(
4635 struct bt_ctf_field_type
*type
)
4637 struct bt_ctf_field_type
*copy
= NULL
, *copy_element
;
4638 struct bt_ctf_field_type_array
*array
;
4640 BT_LOGD("Copying array field type's: addr=%p", type
);
4641 array
= container_of(type
, struct bt_ctf_field_type_array
,
4643 BT_LOGD_STR("Copying array field type's element field type.");
4644 copy_element
= bt_ctf_field_type_copy(array
->element_type
);
4645 if (!copy_element
) {
4646 BT_LOGE_STR("Cannot copy array field type's element field type.");
4650 copy
= bt_ctf_field_type_array_create(copy_element
, array
->length
);
4652 BT_LOGE_STR("Cannot create array field type.");
4656 BT_LOGD("Copied array field type: original-ft-addr=%p, copy-ft-addr=%p",
4660 bt_put(copy_element
);
4665 struct bt_ctf_field_type
*bt_ctf_field_type_sequence_copy(
4666 struct bt_ctf_field_type
*type
)
4668 struct bt_ctf_field_type
*copy
= NULL
, *copy_element
;
4669 struct bt_ctf_field_type_sequence
*sequence
, *copy_sequence
;
4671 BT_LOGD("Copying sequence field type's: addr=%p", type
);
4672 sequence
= container_of(type
, struct bt_ctf_field_type_sequence
,
4674 BT_LOGD_STR("Copying sequence field type's element field type.");
4675 copy_element
= bt_ctf_field_type_copy(sequence
->element_type
);
4676 if (!copy_element
) {
4677 BT_LOGE_STR("Cannot copy sequence field type's element field type.");
4681 copy
= bt_ctf_field_type_sequence_create(copy_element
,
4682 sequence
->length_field_name
->len
?
4683 sequence
->length_field_name
->str
: NULL
);
4685 BT_LOGE_STR("Cannot create sequence field type.");
4689 copy_sequence
= container_of(copy
, struct bt_ctf_field_type_sequence
,
4691 if (sequence
->length_field_path
) {
4692 BT_LOGD_STR("Copying sequence field type's length field path.");
4693 copy_sequence
->length_field_path
= bt_ctf_field_path_copy(
4694 sequence
->length_field_path
);
4695 if (!copy_sequence
->length_field_path
) {
4696 BT_LOGE_STR("Cannot copy sequence field type's length field path.");
4701 BT_LOGD("Copied sequence field type: original-ft-addr=%p, copy-ft-addr=%p",
4705 bt_put(copy_element
);
4713 struct bt_ctf_field_type
*bt_ctf_field_type_string_copy(
4714 struct bt_ctf_field_type
*type
)
4716 struct bt_ctf_field_type
*copy
;
4718 BT_LOGD("Copying string field type's: addr=%p", type
);
4719 copy
= bt_ctf_field_type_string_create();
4721 BT_LOGE_STR("Cannot create string field type.");
4725 BT_LOGD("Copied string field type: original-ft-addr=%p, copy-ft-addr=%p",
4732 int bt_ctf_field_type_integer_compare(struct bt_ctf_field_type
*type_a
,
4733 struct bt_ctf_field_type
*type_b
)
4736 struct bt_ctf_field_type_integer
*int_type_a
;
4737 struct bt_ctf_field_type_integer
*int_type_b
;
4739 int_type_a
= container_of(type_a
, struct bt_ctf_field_type_integer
,
4741 int_type_b
= container_of(type_b
, struct bt_ctf_field_type_integer
,
4745 if (int_type_a
->size
!= int_type_b
->size
) {
4746 BT_LOGV("Integer field types differ: different sizes: "
4747 "ft-a-size=%u, ft-b-size=%u",
4748 int_type_a
->size
, int_type_b
->size
);
4753 if (int_type_a
->user_byte_order
!= int_type_b
->user_byte_order
) {
4754 BT_LOGV("Integer field types differ: different byte orders: "
4755 "ft-a-bo=%s, ft-b-bo=%s",
4756 bt_ctf_byte_order_string(int_type_a
->user_byte_order
),
4757 bt_ctf_byte_order_string(int_type_b
->user_byte_order
));
4762 if (int_type_a
->is_signed
!= int_type_b
->is_signed
) {
4763 BT_LOGV("Integer field types differ: different signedness: "
4764 "ft-a-is-signed=%d, ft-b-is-signed=%d",
4765 int_type_a
->is_signed
,
4766 int_type_b
->is_signed
);
4771 if (int_type_a
->base
!= int_type_b
->base
) {
4772 BT_LOGV("Integer field types differ: different bases: "
4773 "ft-a-base=%s, ft-b-base=%s",
4774 bt_ctf_integer_base_string(int_type_a
->base
),
4775 bt_ctf_integer_base_string(int_type_b
->base
));
4780 if (int_type_a
->encoding
!= int_type_b
->encoding
) {
4781 BT_LOGV("Integer field types differ: different encodings: "
4782 "ft-a-encoding=%s, ft-b-encoding=%s",
4783 bt_ctf_string_encoding_string(int_type_a
->encoding
),
4784 bt_ctf_string_encoding_string(int_type_b
->encoding
));
4789 if (int_type_a
->mapped_clock
!= int_type_b
->mapped_clock
) {
4790 BT_LOGV("Integer field types differ: different mapped clock classes: "
4791 "ft-a-mapped-clock-class-addr=%p, "
4792 "ft-b-mapped-clock-class-addr=%p, "
4793 "ft-a-mapped-clock-class-name=\"%s\", "
4794 "ft-b-mapped-clock-class-name=\"%s\"",
4795 int_type_a
->mapped_clock
, int_type_b
->mapped_clock
,
4796 int_type_a
->mapped_clock
? bt_ctf_clock_class_get_name(int_type_a
->mapped_clock
) : "",
4797 int_type_b
->mapped_clock
? bt_ctf_clock_class_get_name(int_type_b
->mapped_clock
) : "");
4809 int bt_ctf_field_type_floating_point_compare(struct bt_ctf_field_type
*type_a
,
4810 struct bt_ctf_field_type
*type_b
)
4813 struct bt_ctf_field_type_floating_point
*float_a
;
4814 struct bt_ctf_field_type_floating_point
*float_b
;
4816 float_a
= container_of(type_a
,
4817 struct bt_ctf_field_type_floating_point
, parent
);
4818 float_b
= container_of(type_b
,
4819 struct bt_ctf_field_type_floating_point
, parent
);
4822 if (float_a
->user_byte_order
!= float_b
->user_byte_order
) {
4823 BT_LOGV("Floating point number field types differ: different byte orders: "
4824 "ft-a-bo=%s, ft-b-bo=%s",
4825 bt_ctf_byte_order_string(float_a
->user_byte_order
),
4826 bt_ctf_byte_order_string(float_b
->user_byte_order
));
4830 /* Exponent length */
4831 if (float_a
->exp_dig
!= float_b
->exp_dig
) {
4832 BT_LOGV("Floating point number field types differ: different exponent sizes: "
4833 "ft-a-exp-size=%u, ft-b-exp-size=%u",
4834 float_a
->exp_dig
, float_b
->exp_dig
);
4838 /* Mantissa length */
4839 if (float_a
->mant_dig
!= float_b
->mant_dig
) {
4840 BT_LOGV("Floating point number field types differ: different mantissa sizes: "
4841 "ft-a-mant-size=%u, ft-b-mant-size=%u",
4842 float_a
->mant_dig
, float_b
->mant_dig
);
4854 int compare_enumeration_mappings(struct enumeration_mapping
*mapping_a
,
4855 struct enumeration_mapping
*mapping_b
)
4860 if (mapping_a
->string
!= mapping_b
->string
) {
4861 BT_LOGV("Enumeration field type mappings differ: different names: "
4862 "mapping-a-name=\"%s\", mapping-b-name=\"%s\"",
4863 g_quark_to_string(mapping_a
->string
),
4864 g_quark_to_string(mapping_b
->string
));
4869 if (mapping_a
->range_start
._unsigned
!=
4870 mapping_b
->range_start
._unsigned
) {
4871 BT_LOGV("Enumeration field type mappings differ: different starts of range: "
4872 "mapping-a-range-start-unsigned=%" PRIu64
", "
4873 "mapping-b-range-start-unsigned=%" PRIu64
,
4874 mapping_a
->range_start
._unsigned
,
4875 mapping_b
->range_start
._unsigned
);
4880 if (mapping_a
->range_end
._unsigned
!=
4881 mapping_b
->range_end
._unsigned
) {
4882 BT_LOGV("Enumeration field type mappings differ: different ends of range: "
4883 "mapping-a-range-end-unsigned=%" PRIu64
", "
4884 "mapping-b-range-end-unsigned=%" PRIu64
,
4885 mapping_a
->range_end
._unsigned
,
4886 mapping_b
->range_end
._unsigned
);
4898 int bt_ctf_field_type_enumeration_compare(struct bt_ctf_field_type
*type_a
,
4899 struct bt_ctf_field_type
*type_b
)
4903 struct bt_ctf_field_type_enumeration
*enum_a
;
4904 struct bt_ctf_field_type_enumeration
*enum_b
;
4906 enum_a
= container_of(type_a
,
4907 struct bt_ctf_field_type_enumeration
, parent
);
4908 enum_b
= container_of(type_b
,
4909 struct bt_ctf_field_type_enumeration
, parent
);
4911 /* Container field type */
4912 ret
= bt_ctf_field_type_compare(enum_a
->container
, enum_b
->container
);
4914 BT_LOGV("Enumeration field types differ: different container field types: "
4915 "ft-a-container-ft-addr=%p, ft-b-container-ft-addr=%p",
4916 enum_a
->container
, enum_b
->container
);
4923 if (enum_a
->entries
->len
!= enum_b
->entries
->len
) {
4927 for (i
= 0; i
< enum_a
->entries
->len
; ++i
) {
4928 struct enumeration_mapping
*mapping_a
=
4929 g_ptr_array_index(enum_a
->entries
, i
);
4930 struct enumeration_mapping
*mapping_b
=
4931 g_ptr_array_index(enum_b
->entries
, i
);
4933 if (compare_enumeration_mappings(mapping_a
, mapping_b
)) {
4934 BT_LOGV("Enumeration field types differ: different mappings: "
4935 "ft-a-mapping-addr=%p, ft-b-mapping-addr=%p, "
4936 "ft-a-mapping-name=\"%s\", ft-b-mapping-name=\"%s\"",
4937 mapping_a
, mapping_b
,
4938 g_quark_to_string(mapping_a
->string
),
4939 g_quark_to_string(mapping_b
->string
));
4952 int bt_ctf_field_type_string_compare(struct bt_ctf_field_type
*type_a
,
4953 struct bt_ctf_field_type
*type_b
)
4956 struct bt_ctf_field_type_string
*string_a
;
4957 struct bt_ctf_field_type_string
*string_b
;
4959 string_a
= container_of(type_a
,
4960 struct bt_ctf_field_type_string
, parent
);
4961 string_b
= container_of(type_b
,
4962 struct bt_ctf_field_type_string
, parent
);
4965 if (string_a
->encoding
!= string_b
->encoding
) {
4966 BT_LOGV("String field types differ: different encodings: "
4967 "ft-a-encoding=%s, ft-b-encoding=%s",
4968 bt_ctf_string_encoding_string(string_a
->encoding
),
4969 bt_ctf_string_encoding_string(string_b
->encoding
));
4981 int compare_structure_fields(struct structure_field
*field_a
,
4982 struct structure_field
*field_b
)
4987 if (field_a
->name
!= field_b
->name
) {
4988 BT_LOGV("Structure/variant field type fields differ: different names: "
4989 "field-a-name=%s, field-b-name=%s",
4990 g_quark_to_string(field_a
->name
),
4991 g_quark_to_string(field_b
->name
));
4996 ret
= bt_ctf_field_type_compare(field_a
->type
, field_b
->type
);
4998 BT_LOGV("Structure/variant field type fields differ: different field types: "
4999 "field-name=\"%s\", field-a-ft-addr=%p, field-b-ft-addr=%p",
5000 g_quark_to_string(field_a
->name
),
5001 field_a
->type
, field_b
->type
);
5009 int bt_ctf_field_type_structure_compare(struct bt_ctf_field_type
*type_a
,
5010 struct bt_ctf_field_type
*type_b
)
5014 struct bt_ctf_field_type_structure
*struct_a
;
5015 struct bt_ctf_field_type_structure
*struct_b
;
5017 struct_a
= container_of(type_a
,
5018 struct bt_ctf_field_type_structure
, parent
);
5019 struct_b
= container_of(type_b
,
5020 struct bt_ctf_field_type_structure
, parent
);
5023 if (bt_ctf_field_type_get_alignment(type_a
) !=
5024 bt_ctf_field_type_get_alignment(type_b
)) {
5025 BT_LOGV("Structure field types differ: different alignments: "
5026 "ft-a-align=%u, ft-b-align=%u",
5027 bt_ctf_field_type_get_alignment(type_a
),
5028 bt_ctf_field_type_get_alignment(type_b
));
5033 if (struct_a
->fields
->len
!= struct_b
->fields
->len
) {
5034 BT_LOGV("Structure field types differ: different field counts: "
5035 "ft-a-field-count=%u, ft-b-field-count=%u",
5036 struct_a
->fields
->len
, struct_b
->fields
->len
);
5040 for (i
= 0; i
< struct_a
->fields
->len
; ++i
) {
5041 struct structure_field
*field_a
=
5042 g_ptr_array_index(struct_a
->fields
, i
);
5043 struct structure_field
*field_b
=
5044 g_ptr_array_index(struct_b
->fields
, i
);
5046 ret
= compare_structure_fields(field_a
, field_b
);
5048 /* compare_structure_fields() logs what differs */
5049 BT_LOGV_STR("Structure field types differ: different fields.");
5062 int bt_ctf_field_type_variant_compare(struct bt_ctf_field_type
*type_a
,
5063 struct bt_ctf_field_type
*type_b
)
5067 struct bt_ctf_field_type_variant
*variant_a
;
5068 struct bt_ctf_field_type_variant
*variant_b
;
5070 variant_a
= container_of(type_a
,
5071 struct bt_ctf_field_type_variant
, parent
);
5072 variant_b
= container_of(type_b
,
5073 struct bt_ctf_field_type_variant
, parent
);
5076 if (strcmp(variant_a
->tag_name
->str
, variant_b
->tag_name
->str
)) {
5077 BT_LOGV("Variant field types differ: different tag field names: "
5078 "ft-a-tag-field-name=\"%s\", ft-b-tag-field-name=\"%s\"",
5079 variant_a
->tag_name
->str
, variant_b
->tag_name
->str
);
5084 ret
= bt_ctf_field_type_compare(
5085 (struct bt_ctf_field_type
*) variant_a
->tag
,
5086 (struct bt_ctf_field_type
*) variant_b
->tag
);
5088 BT_LOGV("Variant field types differ: different tag field types: "
5089 "ft-a-tag-ft-addr=%p, ft-b-tag-ft-addr=%p",
5090 variant_a
->tag
, variant_b
->tag
);
5097 if (variant_a
->fields
->len
!= variant_b
->fields
->len
) {
5098 BT_LOGV("Structure field types differ: different field counts: "
5099 "ft-a-field-count=%u, ft-b-field-count=%u",
5100 variant_a
->fields
->len
, variant_b
->fields
->len
);
5104 for (i
= 0; i
< variant_a
->fields
->len
; ++i
) {
5105 struct structure_field
*field_a
=
5106 g_ptr_array_index(variant_a
->fields
, i
);
5107 struct structure_field
*field_b
=
5108 g_ptr_array_index(variant_b
->fields
, i
);
5110 ret
= compare_structure_fields(field_a
, field_b
);
5112 /* compare_structure_fields() logs what differs */
5113 BT_LOGV_STR("Variant field types differ: different fields.");
5126 int bt_ctf_field_type_array_compare(struct bt_ctf_field_type
*type_a
,
5127 struct bt_ctf_field_type
*type_b
)
5130 struct bt_ctf_field_type_array
*array_a
;
5131 struct bt_ctf_field_type_array
*array_b
;
5133 array_a
= container_of(type_a
,
5134 struct bt_ctf_field_type_array
, parent
);
5135 array_b
= container_of(type_b
,
5136 struct bt_ctf_field_type_array
, parent
);
5139 if (array_a
->length
!= array_b
->length
) {
5140 BT_LOGV("Structure field types differ: different lengths: "
5141 "ft-a-length=%u, ft-b-length=%u",
5142 array_a
->length
, array_b
->length
);
5147 ret
= bt_ctf_field_type_compare(array_a
->element_type
,
5148 array_b
->element_type
);
5150 BT_LOGV("Array field types differ: different element field types: "
5151 "ft-a-element-ft-addr=%p, ft-b-element-ft-addr=%p",
5152 array_a
->element_type
, array_b
->element_type
);
5160 int bt_ctf_field_type_sequence_compare(struct bt_ctf_field_type
*type_a
,
5161 struct bt_ctf_field_type
*type_b
)
5164 struct bt_ctf_field_type_sequence
*sequence_a
;
5165 struct bt_ctf_field_type_sequence
*sequence_b
;
5167 sequence_a
= container_of(type_a
,
5168 struct bt_ctf_field_type_sequence
, parent
);
5169 sequence_b
= container_of(type_b
,
5170 struct bt_ctf_field_type_sequence
, parent
);
5173 if (strcmp(sequence_a
->length_field_name
->str
,
5174 sequence_b
->length_field_name
->str
)) {
5175 BT_LOGV("Sequence field types differ: different length field names: "
5176 "ft-a-length-field-name=\"%s\", "
5177 "ft-b-length-field-name=\"%s\"",
5178 sequence_a
->length_field_name
->str
,
5179 sequence_b
->length_field_name
->str
);
5184 ret
= bt_ctf_field_type_compare(sequence_a
->element_type
,
5185 sequence_b
->element_type
);
5187 BT_LOGV("Sequence field types differ: different element field types: "
5188 "ft-a-element-ft-addr=%p, ft-b-element-ft-addr=%p",
5189 sequence_a
->element_type
, sequence_b
->element_type
);
5196 int bt_ctf_field_type_compare(struct bt_ctf_field_type
*type_a
,
5197 struct bt_ctf_field_type
*type_b
)
5201 if (type_a
== type_b
) {
5202 /* Same reference: equal (even if both are NULL) */
5208 BT_LOGW_STR("Invalid parameter: field type A is NULL.");
5214 BT_LOGW_STR("Invalid parameter: field type B is NULL.");
5219 if (type_a
->id
!= type_b
->id
) {
5220 /* Different type IDs */
5221 BT_LOGV("Field types differ: different IDs: "
5222 "ft-a-addr=%p, ft-b-addr=%p, "
5223 "ft-a-id=%s, ft-b-id=%s",
5225 bt_ctf_field_type_id_string(type_a
->id
),
5226 bt_ctf_field_type_id_string(type_b
->id
));
5230 if (type_a
->id
== BT_CTF_FIELD_TYPE_ID_UNKNOWN
) {
5231 /* Both have unknown type IDs */
5232 BT_LOGW_STR("Invalid parameter: field type IDs are unknown.");
5236 ret
= type_compare_funcs
[type_a
->id
](type_a
, type_b
);
5238 BT_LOGV("Field types differ: ft-a-addr=%p, ft-b-addr=%p",
5247 int64_t bt_ctf_field_type_get_field_count(struct bt_ctf_field_type
*field_type
)
5249 int64_t field_count
= -1;
5250 enum bt_ctf_field_type_id type_id
= bt_ctf_field_type_get_type_id(field_type
);
5253 case CTF_TYPE_STRUCT
:
5255 bt_ctf_field_type_structure_get_field_count(field_type
);
5257 case CTF_TYPE_VARIANT
:
5259 bt_ctf_field_type_variant_get_field_count(field_type
);
5261 case CTF_TYPE_ARRAY
:
5262 case CTF_TYPE_SEQUENCE
:
5264 * Array and sequence types always contain a single member
5265 * (the element type).
5277 struct bt_ctf_field_type
*bt_ctf_field_type_get_field_at_index(
5278 struct bt_ctf_field_type
*field_type
, int index
)
5280 struct bt_ctf_field_type
*field
= NULL
;
5281 enum bt_ctf_field_type_id type_id
= bt_ctf_field_type_get_type_id(field_type
);
5284 case CTF_TYPE_STRUCT
:
5285 bt_ctf_field_type_structure_get_field_by_index(field_type
,
5286 NULL
, &field
, index
);
5288 case CTF_TYPE_VARIANT
:
5290 int ret
= bt_ctf_field_type_variant_get_field_by_index(
5291 field_type
, NULL
, &field
, index
);
5298 case CTF_TYPE_ARRAY
:
5299 field
= bt_ctf_field_type_array_get_element_type(field_type
);
5301 case CTF_TYPE_SEQUENCE
:
5302 field
= bt_ctf_field_type_sequence_get_element_type(field_type
);
5312 int bt_ctf_field_type_get_field_index(struct bt_ctf_field_type
*field_type
,
5315 int field_index
= -1;
5316 enum bt_ctf_field_type_id type_id
= bt_ctf_field_type_get_type_id(field_type
);
5319 case CTF_TYPE_STRUCT
:
5320 field_index
= bt_ctf_field_type_structure_get_field_name_index(
5323 case CTF_TYPE_VARIANT
:
5324 field_index
= bt_ctf_field_type_variant_get_field_name_index(
5334 struct bt_ctf_field_path
*bt_ctf_field_type_variant_get_tag_field_path(
5335 struct bt_ctf_field_type
*type
)
5337 struct bt_ctf_field_path
*field_path
= NULL
;
5338 struct bt_ctf_field_type_variant
*variant
;
5341 BT_LOGW_STR("Invalid parameter: field type is NULL.");
5345 if (!bt_ctf_field_type_is_variant(type
)) {
5346 BT_LOGW("Invalid parameter: field type is not a variant field type: "
5347 "addr=%p, ft-id=%s", type
,
5348 bt_ctf_field_type_id_string(type
->id
));
5352 variant
= container_of(type
, struct bt_ctf_field_type_variant
,
5354 field_path
= bt_get(variant
->tag_field_path
);
5359 struct bt_ctf_field_path
*bt_ctf_field_type_sequence_get_length_field_path(
5360 struct bt_ctf_field_type
*type
)
5362 struct bt_ctf_field_path
*field_path
= NULL
;
5363 struct bt_ctf_field_type_sequence
*sequence
;
5366 BT_LOGW_STR("Invalid parameter: field type is NULL.");
5370 if (!bt_ctf_field_type_is_sequence(type
)) {
5371 BT_LOGW("Invalid parameter: field type is not a sequence field type: "
5372 "addr=%p, ft-id=%s", type
,
5373 bt_ctf_field_type_id_string(type
->id
));
5377 sequence
= container_of(type
, struct bt_ctf_field_type_sequence
,
5379 field_path
= bt_get(sequence
->length_field_path
);