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_variant_validate(struct bt_ctf_field_type
*type
)
705 struct bt_ctf_field_type
*child_type
= NULL
;
706 struct bt_ctf_field_type_variant
*variant
=
707 container_of(type
, struct bt_ctf_field_type_variant
,
711 if (variant
->tag_name
->len
== 0) {
712 BT_LOGW("Invalid variant field type: no tag field name: "
719 BT_LOGW("Invalid variant field type: no tag field type: "
720 "addr=%p, tag-field-name=\"%s\"", type
,
721 variant
->tag_name
->str
);
726 if (bt_ctf_field_type_enumeration_has_overlapping_ranges(
728 BT_LOGW("Invalid variant field type: enumeration tag field type has overlapping ranges: "
729 "variant-ft-addr=%p, tag-field-name=\"%s\", "
730 "enum-ft-addr=%p", type
, variant
->tag_name
->str
,
737 * It is valid to have a variant field type which does not have
738 * the fields corresponding to each label in the associated
741 * It is also valid to have variant field type fields which
742 * cannot be selected because the variant field type tag has no
743 * mapping named as such. This scenario, while not ideal, cannot
746 * If a non-existing field happens to be selected by an
747 * enumeration while reading a variant field, an error will be
748 * generated at that point (while reading the stream).
750 field_count
= bt_ctf_field_type_variant_get_field_count(type
);
751 if (field_count
< 0) {
752 BT_LOGW("Invalid variant field type: no fields: "
753 "addr=%p, tag-field-name=\"%s\"",
754 type
, variant
->tag_name
->str
);
759 for (i
= 0; i
< field_count
; ++i
) {
760 const char *field_name
;
762 ret
= bt_ctf_field_type_variant_get_field_by_index(type
,
763 &field_name
, &child_type
, i
);
765 ret
= bt_ctf_field_type_validate(child_type
);
767 BT_LOGW("Invalid variant field type: "
768 "a contained field type is invalid: "
769 "variant-ft-addr=%p, tag-field-name=\"%s\", "
770 "field-ft-addr=%p, field-name=\"%s\", "
771 "field-index=%" PRId64
,
772 type
, variant
->tag_name
->str
, child_type
,
787 * This function validates a given field type without considering
788 * where this field type is located. It only validates the properties
789 * of the given field type and the properties of its children if
793 int bt_ctf_field_type_validate(struct bt_ctf_field_type
*type
)
796 enum bt_ctf_field_type_id id
= bt_ctf_field_type_get_type_id(type
);
801 /* Already marked as valid */
805 if (type_validate_funcs
[id
]) {
806 ret
= type_validate_funcs
[id
](type
);
809 if (!ret
&& type
->frozen
) {
810 /* Field type is valid */
811 BT_LOGV("Marking field type as valid: addr=%p", type
);
819 struct bt_ctf_field_type
*bt_ctf_field_type_integer_create(unsigned int size
)
821 struct bt_ctf_field_type_integer
*integer
=
822 g_new0(struct bt_ctf_field_type_integer
, 1);
824 BT_LOGD("Creating integer field type object: size=%u", size
);
827 BT_LOGE_STR("Failed to allocate one integer field type.");
831 if (size
== 0 || size
> 64) {
832 BT_LOGW("Invalid parameter: size must be between 1 and 64: "
837 integer
->parent
.id
= BT_CTF_FIELD_TYPE_ID_INTEGER
;
838 integer
->size
= size
;
839 integer
->base
= BT_CTF_INTEGER_BASE_DECIMAL
;
840 integer
->encoding
= BT_CTF_STRING_ENCODING_NONE
;
841 bt_ctf_field_type_init(&integer
->parent
, TRUE
);
842 BT_LOGD("Created integer field type object: addr=%p, size=%u",
843 &integer
->parent
, size
);
844 return &integer
->parent
;
847 int bt_ctf_field_type_integer_get_size(struct bt_ctf_field_type
*type
)
850 struct bt_ctf_field_type_integer
*integer
;
853 BT_LOGW_STR("Invalid parameter: field type is NULL.");
858 if (type
->id
!= BT_CTF_FIELD_TYPE_ID_INTEGER
) {
859 BT_LOGW("Invalid parameter: field type is not an integer field type: "
860 "addr=%p, ft-id=%s", type
,
861 bt_ctf_field_type_id_string(type
->id
));
866 integer
= container_of(type
, struct bt_ctf_field_type_integer
, parent
);
867 ret
= (int) integer
->size
;
872 int bt_ctf_field_type_integer_get_signed(struct bt_ctf_field_type
*type
)
875 struct bt_ctf_field_type_integer
*integer
;
878 BT_LOGW_STR("Invalid parameter: field type is NULL.");
883 if (type
->id
!= BT_CTF_FIELD_TYPE_ID_INTEGER
) {
884 BT_LOGW("Invalid parameter: field type is not an integer field type: "
885 "addr=%p, ft-id=%s", type
,
886 bt_ctf_field_type_id_string(type
->id
));
891 integer
= container_of(type
, struct bt_ctf_field_type_integer
, parent
);
892 ret
= integer
->is_signed
;
897 bt_bool
bt_ctf_field_type_integer_is_signed(
898 struct bt_ctf_field_type
*int_field_type
)
900 return bt_ctf_field_type_integer_get_signed(int_field_type
) ?
904 int bt_ctf_field_type_integer_set_signed(struct bt_ctf_field_type
*type
,
908 struct bt_ctf_field_type_integer
*integer
;
911 BT_LOGW_STR("Invalid parameter: field type is NULL.");
917 BT_LOGW("Invalid parameter: field type is frozen: addr=%p",
923 if (type
->id
!= BT_CTF_FIELD_TYPE_ID_INTEGER
) {
924 BT_LOGW("Invalid parameter: field type is not an integer field type: "
925 "addr=%p, ft-id=%s", type
,
926 bt_ctf_field_type_id_string(type
->id
));
931 integer
= container_of(type
, struct bt_ctf_field_type_integer
, parent
);
932 integer
->is_signed
= !!is_signed
;
933 BT_LOGV("Set integer field type's signedness: addr=%p, is-signed=%d",
939 int bt_ctf_field_type_integer_set_size(struct bt_ctf_field_type
*type
,
943 struct bt_ctf_field_type_integer
*integer
;
946 BT_LOGW_STR("Invalid parameter: field type is NULL.");
952 BT_LOGW("Invalid parameter: field type is frozen: addr=%p",
958 if (type
->id
!= BT_CTF_FIELD_TYPE_ID_INTEGER
) {
959 BT_LOGW("Invalid parameter: field type is not an integer field type: "
960 "addr=%p, ft-id=%s", type
,
961 bt_ctf_field_type_id_string(type
->id
));
966 if (size
== 0 || size
> 64) {
967 BT_LOGW("Invalid parameter: size must be between 1 and 64: "
968 "addr=%p, size=%u", type
, size
);
973 integer
= container_of(type
, struct bt_ctf_field_type_integer
, parent
);
974 integer
->size
= size
;
975 BT_LOGV("Set integer field type's size: addr=%p, size=%u",
981 enum bt_ctf_integer_base
bt_ctf_field_type_integer_get_base(
982 struct bt_ctf_field_type
*type
)
984 enum bt_ctf_integer_base ret
= BT_CTF_INTEGER_BASE_UNKNOWN
;
985 struct bt_ctf_field_type_integer
*integer
;
988 BT_LOGW_STR("Invalid parameter: field type is NULL.");
992 if (type
->id
!= BT_CTF_FIELD_TYPE_ID_INTEGER
) {
993 BT_LOGW("Invalid parameter: field type is not an integer field type: "
994 "addr=%p, ft-id=%s", type
,
995 bt_ctf_field_type_id_string(type
->id
));
999 integer
= container_of(type
, struct bt_ctf_field_type_integer
, parent
);
1000 ret
= integer
->base
;
1005 int bt_ctf_field_type_integer_set_base(struct bt_ctf_field_type
*type
,
1006 enum bt_ctf_integer_base base
)
1011 BT_LOGW_STR("Invalid parameter: field type is NULL.");
1017 BT_LOGW("Invalid parameter: field type is frozen: addr=%p",
1023 if (type
->id
!= BT_CTF_FIELD_TYPE_ID_INTEGER
) {
1024 BT_LOGW("Invalid parameter: field type is not an integer field type: "
1025 "addr=%p, ft-id=%s", type
,
1026 bt_ctf_field_type_id_string(type
->id
));
1032 case BT_CTF_INTEGER_BASE_UNSPECIFIED
:
1033 case BT_CTF_INTEGER_BASE_BINARY
:
1034 case BT_CTF_INTEGER_BASE_OCTAL
:
1035 case BT_CTF_INTEGER_BASE_DECIMAL
:
1036 case BT_CTF_INTEGER_BASE_HEXADECIMAL
:
1038 struct bt_ctf_field_type_integer
*integer
= container_of(type
,
1039 struct bt_ctf_field_type_integer
, parent
);
1040 integer
->base
= base
;
1044 BT_LOGW("Invalid parameter: unknown integer field type base: "
1045 "addr=%p, base=%d", type
, base
);
1049 BT_LOGV("Set integer field type's base: addr=%p, base=%s",
1050 type
, bt_ctf_integer_base_string(base
));
1056 enum bt_ctf_string_encoding
bt_ctf_field_type_integer_get_encoding(
1057 struct bt_ctf_field_type
*type
)
1059 enum bt_ctf_string_encoding ret
= BT_CTF_STRING_ENCODING_UNKNOWN
;
1060 struct bt_ctf_field_type_integer
*integer
;
1063 BT_LOGW_STR("Invalid parameter: field type is NULL.");
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
));
1074 integer
= container_of(type
, struct bt_ctf_field_type_integer
, parent
);
1075 ret
= integer
->encoding
;
1080 int bt_ctf_field_type_integer_set_encoding(struct bt_ctf_field_type
*type
,
1081 enum bt_ctf_string_encoding encoding
)
1084 struct bt_ctf_field_type_integer
*integer
;
1087 BT_LOGW_STR("Invalid parameter: field type is NULL.");
1093 BT_LOGW("Invalid parameter: field type is frozen: addr=%p",
1099 if (type
->id
!= BT_CTF_FIELD_TYPE_ID_INTEGER
) {
1100 BT_LOGW("Invalid parameter: field type is not an integer field type: "
1101 "addr=%p, ft-id=%s", type
,
1102 bt_ctf_field_type_id_string(type
->id
));
1107 if (encoding
< BT_CTF_STRING_ENCODING_NONE
||
1108 encoding
>= BT_CTF_STRING_ENCODING_UNKNOWN
) {
1109 BT_LOGW("Invalid parameter: unknown string encoding: "
1110 "addr=%p, encoding=%d", type
, encoding
);
1115 integer
= container_of(type
, struct bt_ctf_field_type_integer
, parent
);
1116 integer
->encoding
= encoding
;
1117 BT_LOGV("Set integer field type's encoding: addr=%p, encoding=%s",
1118 type
, bt_ctf_string_encoding_string(encoding
));
1123 struct bt_ctf_clock_class
*bt_ctf_field_type_integer_get_mapped_clock_class(
1124 struct bt_ctf_field_type
*type
)
1126 struct bt_ctf_field_type_integer
*integer
;
1127 struct bt_ctf_clock_class
*clock_class
= NULL
;
1130 BT_LOGW_STR("Invalid parameter: field type is NULL.");
1134 integer
= container_of(type
, struct bt_ctf_field_type_integer
, parent
);
1135 clock_class
= integer
->mapped_clock
;
1136 bt_get(clock_class
);
1142 int bt_ctf_field_type_integer_set_mapped_clock_class_no_check(
1143 struct bt_ctf_field_type
*type
,
1144 struct bt_ctf_clock_class
*clock_class
)
1146 struct bt_ctf_field_type_integer
*integer
;
1150 BT_LOGW_STR("Invalid parameter: field type is NULL.");
1156 BT_LOGW_STR("Invalid parameter: clock class is NULL.");
1161 if (type
->id
!= BT_CTF_FIELD_TYPE_ID_INTEGER
) {
1162 BT_LOGW("Invalid parameter: field type is not an integer field type: "
1163 "addr=%p, ft-id=%s", type
,
1164 bt_ctf_field_type_id_string(type
->id
));
1168 if (!bt_ctf_clock_class_is_valid(clock_class
)) {
1169 BT_LOGW("Invalid parameter: clock class is invalid: ft-addr=%p"
1170 "clock-class-addr=%p, clock-class-name=\"%s\"",
1172 bt_ctf_clock_class_get_name(clock_class
));
1177 integer
= container_of(type
, struct bt_ctf_field_type_integer
, parent
);
1178 bt_put(integer
->mapped_clock
);
1179 integer
->mapped_clock
= bt_get(clock_class
);
1180 BT_LOGV("Set integer field type's mapped clock class: ft-addr=%p, "
1181 "clock-class-addr=%p, clock-class-name=\"%s\"",
1182 type
, clock_class
, bt_ctf_clock_class_get_name(clock_class
));
1187 int bt_ctf_field_type_integer_set_mapped_clock_class(
1188 struct bt_ctf_field_type
*type
,
1189 struct bt_ctf_clock_class
*clock_class
)
1194 BT_LOGW_STR("Invalid parameter: field type is NULL.");
1200 BT_LOGW("Invalid parameter: field type is frozen: addr=%p",
1206 ret
= bt_ctf_field_type_integer_set_mapped_clock_class_no_check(
1214 void bt_ctf_field_type_enum_iter_destroy(struct bt_object
*obj
)
1216 struct bt_ctf_field_type_enumeration_mapping_iterator
*iter
=
1218 struct bt_ctf_field_type_enumeration_mapping_iterator
,
1221 BT_LOGD("Destroying enumeration field type mapping iterator: addr=%p",
1223 BT_LOGD_STR("Putting parent enumeration field type.");
1224 bt_put(&iter
->enumeration_type
->parent
);
1229 struct bt_ctf_field_type_enumeration_mapping_iterator
*
1230 bt_ctf_field_type_enumeration_find_mappings_type(
1231 struct bt_ctf_field_type
*type
,
1232 enum bt_ctf_field_type_enumeration_mapping_iterator_type iterator_type
)
1234 struct bt_ctf_field_type_enumeration
*enumeration_type
;
1235 struct bt_ctf_field_type_enumeration_mapping_iterator
*iter
= NULL
;
1238 BT_LOGW_STR("Invalid parameter: field type is NULL.");
1242 if (type
->id
!= BT_CTF_FIELD_TYPE_ID_ENUM
) {
1243 BT_LOGW("Invalid parameter: field type is not an enumeration field type: "
1244 "addr=%p, ft-id=%s", type
,
1245 bt_ctf_field_type_id_string(type
->id
));
1249 enumeration_type
= container_of(type
,
1250 struct bt_ctf_field_type_enumeration
, parent
);
1251 iter
= g_new0(struct bt_ctf_field_type_enumeration_mapping_iterator
, 1);
1253 BT_LOGE_STR("Failed to allocate one enumeration field type mapping.");
1257 bt_object_init(&iter
->base
, bt_ctf_field_type_enum_iter_destroy
);
1259 iter
->enumeration_type
= enumeration_type
;
1261 iter
->type
= iterator_type
;
1266 struct bt_ctf_field_type_enumeration_mapping_iterator
*
1267 bt_ctf_field_type_enumeration_find_mappings_by_name(
1268 struct bt_ctf_field_type
*type
, const char *name
)
1270 struct bt_ctf_field_type_enumeration_mapping_iterator
*iter
;
1272 iter
= bt_ctf_field_type_enumeration_find_mappings_type(
1273 type
, ITERATOR_BY_NAME
);
1275 BT_LOGE("Cannot create enumeration field type mapping iterator: "
1276 "ft-addr=%p, mapping-name=\"%s\"", type
, name
);
1280 iter
->u
.name_quark
= g_quark_try_string(name
);
1281 if (!iter
->u
.name_quark
) {
1282 BT_LOGV("No such enumeration field type mapping name: "
1283 "ft-addr=%p, mapping-name=\"%s\"",
1288 /* Advance iterator to first entry, or leave index at -1. */
1289 if (bt_ctf_field_type_enumeration_mapping_iterator_next(iter
)) {
1290 /* No entry found. */
1291 BT_LOGV("No such enumeration field type mapping name: "
1292 "ft-addr=%p, mapping-name=\"%s\"",
1303 int bt_ctf_field_type_enumeration_mapping_iterator_next(
1304 struct bt_ctf_field_type_enumeration_mapping_iterator
*iter
)
1306 struct bt_ctf_field_type_enumeration
*enumeration
;
1307 struct bt_ctf_field_type
*type
;
1308 int i
, ret
= 0, len
;
1311 BT_LOGW_STR("Invalid parameter: enumeration field type mapping iterator is NULL.");
1316 enumeration
= iter
->enumeration_type
;
1317 type
= &enumeration
->parent
;
1318 len
= enumeration
->entries
->len
;
1319 for (i
= iter
->index
+ 1; i
< len
; i
++) {
1320 struct enumeration_mapping
*mapping
=
1321 get_enumeration_mapping(type
, i
);
1323 switch (iter
->type
) {
1324 case ITERATOR_BY_NAME
:
1325 if (mapping
->string
== iter
->u
.name_quark
) {
1330 case ITERATOR_BY_SIGNED_VALUE
:
1332 int64_t value
= iter
->u
.signed_value
;
1334 if (value
>= mapping
->range_start
._signed
&&
1335 value
<= mapping
->range_end
._signed
) {
1341 case ITERATOR_BY_UNSIGNED_VALUE
:
1343 uint64_t value
= iter
->u
.unsigned_value
;
1345 if (value
>= mapping
->range_start
._unsigned
&&
1346 value
<= mapping
->range_end
._unsigned
) {
1353 BT_LOGF("Invalid enumeration field type mapping iterator type: "
1354 "type=%d", iter
->type
);
1364 struct bt_ctf_field_type_enumeration_mapping_iterator
*
1365 bt_ctf_field_type_enumeration_find_mappings_by_signed_value(
1366 struct bt_ctf_field_type
*type
, int64_t value
)
1368 struct bt_ctf_field_type_enumeration_mapping_iterator
*iter
;
1370 iter
= bt_ctf_field_type_enumeration_find_mappings_type(
1371 type
, ITERATOR_BY_SIGNED_VALUE
);
1373 BT_LOGE("Cannot create enumeration field type mapping iterator: "
1374 "ft-addr=%p, value=%" PRId64
, type
, value
);
1378 if (bt_ctf_field_type_integer_get_signed(
1379 iter
->enumeration_type
->container
) != 1) {
1380 BT_LOGW("Invalid parameter: enumeration field type is unsigned: "
1381 "enum-ft-addr=%p, int-ft-addr=%p",
1382 type
, iter
->enumeration_type
->container
);
1386 iter
->u
.signed_value
= value
;
1388 /* Advance iterator to first entry, or leave index at -1. */
1389 if (bt_ctf_field_type_enumeration_mapping_iterator_next(iter
)) {
1390 /* No entry found. */
1400 struct bt_ctf_field_type_enumeration_mapping_iterator
*
1401 bt_ctf_field_type_enumeration_find_mappings_by_unsigned_value(
1402 struct bt_ctf_field_type
*type
, uint64_t value
)
1404 struct bt_ctf_field_type_enumeration_mapping_iterator
*iter
= NULL
;
1407 BT_LOGW_STR("Invalid parameter: field type is NULL.");
1411 iter
= bt_ctf_field_type_enumeration_find_mappings_type(
1412 type
, ITERATOR_BY_UNSIGNED_VALUE
);
1414 BT_LOGE("Cannot create enumeration field type mapping iterator: "
1415 "ft-addr=%p, value=%" PRIu64
, type
, value
);
1419 if (bt_ctf_field_type_integer_get_signed(
1420 iter
->enumeration_type
->container
) != 0) {
1421 BT_LOGW("Invalid parameter: enumeration field type is signed: "
1422 "enum-ft-addr=%p, int-ft-addr=%p",
1423 type
, iter
->enumeration_type
->container
);
1426 iter
->u
.unsigned_value
= value
;
1428 /* Advance iterator to first entry, or leave index at -1. */
1429 if (bt_ctf_field_type_enumeration_mapping_iterator_next(iter
)) {
1430 /* No entry found. */
1440 int bt_ctf_field_type_enumeration_mapping_iterator_get_signed(
1441 struct bt_ctf_field_type_enumeration_mapping_iterator
*iter
,
1442 const char **mapping_name
, int64_t *range_begin
,
1448 BT_LOGW_STR("Invalid parameter: enumeration field type mapping iterator is NULL.");
1453 ret
= bt_ctf_field_type_enumeration_get_mapping_signed(
1454 &iter
->enumeration_type
->parent
, iter
->index
,
1455 mapping_name
, range_begin
, range_end
);
1460 int bt_ctf_field_type_enumeration_mapping_iterator_get_unsigned(
1461 struct bt_ctf_field_type_enumeration_mapping_iterator
*iter
,
1462 const char **mapping_name
, uint64_t *range_begin
,
1463 uint64_t *range_end
)
1468 BT_LOGW_STR("Invalid parameter: enumeration field type mapping iterator is NULL.");
1473 ret
= bt_ctf_field_type_enumeration_get_mapping_unsigned(
1474 &iter
->enumeration_type
->parent
, iter
->index
,
1475 mapping_name
, range_begin
, range_end
);
1480 int bt_ctf_field_type_enumeration_get_mapping_signed(
1481 struct bt_ctf_field_type
*enum_field_type
,
1482 uint64_t index
, const char **mapping_name
, int64_t *range_begin
,
1486 struct enumeration_mapping
*mapping
;
1488 if (!enum_field_type
) {
1489 BT_LOGW_STR("Invalid parameter: field type is NULL.");
1494 mapping
= get_enumeration_mapping(enum_field_type
, index
);
1496 /* get_enumeration_mapping() reports any error */
1502 *mapping_name
= g_quark_to_string(mapping
->string
);
1503 assert(*mapping_name
);
1507 *range_begin
= mapping
->range_start
._signed
;
1511 *range_end
= mapping
->range_end
._signed
;
1517 int bt_ctf_field_type_enumeration_get_mapping_unsigned(
1518 struct bt_ctf_field_type
*enum_field_type
,
1520 const char **mapping_name
, uint64_t *range_begin
,
1521 uint64_t *range_end
)
1524 struct enumeration_mapping
*mapping
;
1526 if (!enum_field_type
) {
1527 BT_LOGW_STR("Invalid parameter: field type is NULL.");
1532 mapping
= get_enumeration_mapping(enum_field_type
, index
);
1534 /* get_enumeration_mapping() reports any error */
1540 *mapping_name
= g_quark_to_string(mapping
->string
);
1541 assert(*mapping_name
);
1545 *range_begin
= mapping
->range_start
._unsigned
;
1549 *range_end
= mapping
->range_end
._unsigned
;
1555 struct bt_ctf_field_type
*bt_ctf_field_type_enumeration_create(
1556 struct bt_ctf_field_type
*integer_container_type
)
1558 struct bt_ctf_field_type_enumeration
*enumeration
= NULL
;
1560 BT_LOGD("Creating enumeration field type object: int-ft-addr=%p",
1561 integer_container_type
);
1563 if (!integer_container_type
) {
1564 BT_LOGW_STR("Invalid parameter: field type is NULL.");
1568 if (integer_container_type
->id
!= BT_CTF_FIELD_TYPE_ID_INTEGER
) {
1569 BT_LOGW("Invalid parameter: container field type is not an integer field type: "
1570 "container-ft-addr=%p, container-ft-id=%s",
1571 integer_container_type
,
1572 bt_ctf_field_type_id_string(integer_container_type
->id
));
1576 enumeration
= g_new0(struct bt_ctf_field_type_enumeration
, 1);
1578 BT_LOGE_STR("Failed to allocate one enumeration field type.");
1582 enumeration
->parent
.id
= BT_CTF_FIELD_TYPE_ID_ENUM
;
1583 bt_get(integer_container_type
);
1584 enumeration
->container
= integer_container_type
;
1585 enumeration
->entries
= g_ptr_array_new_with_free_func(
1586 (GDestroyNotify
)destroy_enumeration_mapping
);
1587 bt_ctf_field_type_init(&enumeration
->parent
, FALSE
);
1588 BT_LOGD("Created enumeration field type object: addr=%p, "
1589 "int-ft-addr=%p, int-ft-size=%u",
1590 &enumeration
->parent
, integer_container_type
,
1591 bt_ctf_field_type_integer_get_size(integer_container_type
));
1592 return &enumeration
->parent
;
1594 g_free(enumeration
);
1598 struct bt_ctf_field_type
*bt_ctf_field_type_enumeration_get_container_type(
1599 struct bt_ctf_field_type
*type
)
1601 struct bt_ctf_field_type
*container_type
= NULL
;
1602 struct bt_ctf_field_type_enumeration
*enumeration_type
;
1605 BT_LOGW_STR("Invalid parameter: field type is NULL.");
1609 if (type
->id
!= BT_CTF_FIELD_TYPE_ID_ENUM
) {
1610 BT_LOGW("Invalid parameter: field type is not an enumeration field type: "
1611 "addr=%p, ft-id=%s", type
,
1612 bt_ctf_field_type_id_string(type
->id
));
1616 enumeration_type
= container_of(type
,
1617 struct bt_ctf_field_type_enumeration
, parent
);
1618 container_type
= enumeration_type
->container
;
1619 bt_get(container_type
);
1621 return container_type
;
1624 int bt_ctf_field_type_enumeration_add_mapping_signed(
1625 struct bt_ctf_field_type
*type
, const char *string
,
1626 int64_t range_start
, int64_t range_end
)
1629 GQuark mapping_name
;
1630 struct enumeration_mapping
*mapping
;
1631 struct bt_ctf_field_type_enumeration
*enumeration
;
1632 char *escaped_string
;
1635 BT_LOGW_STR("Invalid parameter: field type is NULL.");
1641 BT_LOGW_STR("Invalid parameter: string is NULL.");
1647 BT_LOGW("Invalid parameter: field type is frozen: addr=%p",
1653 if (type
->id
!= BT_CTF_FIELD_TYPE_ID_ENUM
) {
1654 BT_LOGW("Invalid parameter: field type is not an enumeration field type: "
1655 "addr=%p, ft-id=%s", type
,
1656 bt_ctf_field_type_id_string(type
->id
));
1661 if (range_end
< range_start
) {
1662 BT_LOGW("Invalid parameter: range's end is lesser than range's start: "
1663 "addr=%p, range-start=%" PRId64
", range-end=%" PRId64
,
1664 type
, range_start
, range_end
);
1669 if (strlen(string
) == 0) {
1670 BT_LOGW("Invalid parameter: mapping name is an empty string: "
1671 "enum-ft-addr=%p, mapping-name-addr=%p", type
,
1677 escaped_string
= g_strescape(string
, NULL
);
1678 if (!escaped_string
) {
1679 BT_LOGE("Cannot escape mapping name: enum-ft-addr=%p, "
1680 "mapping-name-addr=%p, mapping-name=\"%s\"",
1681 type
, string
, string
);
1686 mapping
= g_new(struct enumeration_mapping
, 1);
1688 BT_LOGE_STR("Failed to allocate one enumeration mapping.");
1692 mapping_name
= g_quark_from_string(escaped_string
);
1693 *mapping
= (struct enumeration_mapping
) {
1694 .range_start
._signed
= range_start
,
1695 .range_end
._signed
= range_end
,
1696 .string
= mapping_name
,
1698 enumeration
= container_of(type
, struct bt_ctf_field_type_enumeration
,
1700 g_ptr_array_add(enumeration
->entries
, mapping
);
1701 g_ptr_array_sort(enumeration
->entries
,
1702 (GCompareFunc
)compare_enumeration_mappings_signed
);
1703 BT_LOGV("Added mapping to signed enumeration field type: addr=%p, "
1704 "name=\"%s\", range-start=%" PRId64
", "
1705 "range-end=%" PRId64
,
1706 type
, string
, range_start
, range_end
);
1708 free(escaped_string
);
1713 int bt_ctf_field_type_enumeration_add_mapping_unsigned(
1714 struct bt_ctf_field_type
*type
, const char *string
,
1715 uint64_t range_start
, uint64_t range_end
)
1718 GQuark mapping_name
;
1719 struct enumeration_mapping
*mapping
;
1720 struct bt_ctf_field_type_enumeration
*enumeration
;
1721 char *escaped_string
;
1724 BT_LOGW_STR("Invalid parameter: field type is NULL.");
1730 BT_LOGW_STR("Invalid parameter: string is NULL.");
1736 BT_LOGW("Invalid parameter: field type is frozen: addr=%p",
1742 if (type
->id
!= BT_CTF_FIELD_TYPE_ID_ENUM
) {
1743 BT_LOGW("Invalid parameter: field type is not an enumeration field type: "
1744 "addr=%p, ft-id=%s", type
,
1745 bt_ctf_field_type_id_string(type
->id
));
1750 if (range_end
< range_start
) {
1751 BT_LOGW("Invalid parameter: range's end is lesser than range's start: "
1752 "addr=%p, range-start=%" PRIu64
", range-end=%" PRIu64
,
1753 type
, range_start
, range_end
);
1758 if (strlen(string
) == 0) {
1759 BT_LOGW("Invalid parameter: mapping name is an empty string: "
1760 "enum-ft-addr=%p, mapping-name-addr=%p", type
,
1766 escaped_string
= g_strescape(string
, NULL
);
1767 if (!escaped_string
) {
1768 BT_LOGE("Cannot escape mapping name: enum-ft-addr=%p, "
1769 "mapping-name-addr=%p, mapping-name=\"%s\"",
1770 type
, string
, string
);
1775 mapping
= g_new(struct enumeration_mapping
, 1);
1777 BT_LOGE_STR("Failed to allocate one enumeration mapping.");
1781 mapping_name
= g_quark_from_string(escaped_string
);
1782 *mapping
= (struct enumeration_mapping
) {
1783 .range_start
._unsigned
= range_start
,
1784 .range_end
._unsigned
= range_end
,
1785 .string
= mapping_name
,
1787 enumeration
= container_of(type
, struct bt_ctf_field_type_enumeration
,
1789 g_ptr_array_add(enumeration
->entries
, mapping
);
1790 g_ptr_array_sort(enumeration
->entries
,
1791 (GCompareFunc
)compare_enumeration_mappings_unsigned
);
1792 BT_LOGV("Added mapping to unsigned enumeration field type: addr=%p, "
1793 "name=\"%s\", range-start=%" PRIu64
", "
1794 "range-end=%" PRIu64
,
1795 type
, string
, range_start
, range_end
);
1797 free(escaped_string
);
1802 int64_t bt_ctf_field_type_enumeration_get_mapping_count(
1803 struct bt_ctf_field_type
*type
)
1806 struct bt_ctf_field_type_enumeration
*enumeration
;
1809 BT_LOGW_STR("Invalid parameter: field type is NULL.");
1814 if (type
->id
!= BT_CTF_FIELD_TYPE_ID_ENUM
) {
1815 BT_LOGW("Invalid parameter: field type is not an enumeration field type: "
1816 "addr=%p, ft-id=%s", type
,
1817 bt_ctf_field_type_id_string(type
->id
));
1822 enumeration
= container_of(type
, struct bt_ctf_field_type_enumeration
,
1824 ret
= (int64_t) enumeration
->entries
->len
;
1829 struct bt_ctf_field_type
*bt_ctf_field_type_floating_point_create(void)
1831 struct bt_ctf_field_type_floating_point
*floating_point
=
1832 g_new0(struct bt_ctf_field_type_floating_point
, 1);
1834 BT_LOGD_STR("Creating floating point number field type object.");
1836 if (!floating_point
) {
1837 BT_LOGE_STR("Failed to allocate one floating point number field type.");
1841 floating_point
->parent
.id
= BT_CTF_FIELD_TYPE_ID_FLOAT
;
1842 floating_point
->exp_dig
= sizeof(float) * CHAR_BIT
- FLT_MANT_DIG
;
1843 floating_point
->mant_dig
= FLT_MANT_DIG
;
1844 bt_ctf_field_type_init(&floating_point
->parent
, TRUE
);
1845 BT_LOGD("Created floating point number field type object: addr=%p, "
1846 "exp-size=%u, mant-size=%u", &floating_point
->parent
,
1847 floating_point
->exp_dig
, floating_point
->mant_dig
);
1849 return floating_point
? &floating_point
->parent
: NULL
;
1852 int bt_ctf_field_type_floating_point_get_exponent_digits(
1853 struct bt_ctf_field_type
*type
)
1856 struct bt_ctf_field_type_floating_point
*floating_point
;
1859 BT_LOGW_STR("Invalid parameter: field type is NULL.");
1864 if (type
->id
!= BT_CTF_FIELD_TYPE_ID_FLOAT
) {
1865 BT_LOGW("Invalid parameter: field type is not a floating point number field type: "
1866 "addr=%p, ft-id=%s", type
,
1867 bt_ctf_field_type_id_string(type
->id
));
1872 floating_point
= container_of(type
,
1873 struct bt_ctf_field_type_floating_point
, parent
);
1874 ret
= (int) floating_point
->exp_dig
;
1879 int bt_ctf_field_type_floating_point_set_exponent_digits(
1880 struct bt_ctf_field_type
*type
,
1881 unsigned int exponent_digits
)
1884 struct bt_ctf_field_type_floating_point
*floating_point
;
1887 BT_LOGW_STR("Invalid parameter: field type is NULL.");
1893 BT_LOGW("Invalid parameter: field type is frozen: addr=%p",
1899 if (type
->id
!= BT_CTF_FIELD_TYPE_ID_FLOAT
) {
1900 BT_LOGW("Invalid parameter: field type is not a floating point number field type: "
1901 "addr=%p, ft-id=%s", type
,
1902 bt_ctf_field_type_id_string(type
->id
));
1907 floating_point
= container_of(type
,
1908 struct bt_ctf_field_type_floating_point
, parent
);
1909 if ((exponent_digits
!= sizeof(float) * CHAR_BIT
- FLT_MANT_DIG
) &&
1910 (exponent_digits
!= sizeof(double) * CHAR_BIT
- DBL_MANT_DIG
) &&
1912 sizeof(long double) * CHAR_BIT
- LDBL_MANT_DIG
)) {
1913 BT_LOGW("Invalid parameter: invalid exponent size: "
1914 "addr=%p, exp-size=%u", type
, exponent_digits
);
1919 floating_point
->exp_dig
= exponent_digits
;
1920 BT_LOGV("Set floating point number field type's exponent size: addr=%p, "
1921 "exp-size=%u", type
, exponent_digits
);
1926 int bt_ctf_field_type_floating_point_get_mantissa_digits(
1927 struct bt_ctf_field_type
*type
)
1930 struct bt_ctf_field_type_floating_point
*floating_point
;
1933 BT_LOGW_STR("Invalid parameter: field type is NULL.");
1938 if (type
->id
!= BT_CTF_FIELD_TYPE_ID_FLOAT
) {
1939 BT_LOGW("Invalid parameter: field type is not a floating point number field type: "
1940 "addr=%p, ft-id=%s", type
,
1941 bt_ctf_field_type_id_string(type
->id
));
1946 floating_point
= container_of(type
,
1947 struct bt_ctf_field_type_floating_point
, parent
);
1948 ret
= (int) floating_point
->mant_dig
;
1953 int bt_ctf_field_type_floating_point_set_mantissa_digits(
1954 struct bt_ctf_field_type
*type
,
1955 unsigned int mantissa_digits
)
1958 struct bt_ctf_field_type_floating_point
*floating_point
;
1961 BT_LOGW_STR("Invalid parameter: field type is NULL.");
1967 BT_LOGW("Invalid parameter: field type is frozen: addr=%p",
1973 if (type
->id
!= BT_CTF_FIELD_TYPE_ID_FLOAT
) {
1974 BT_LOGW("Invalid parameter: field type is not a floating point number field type: "
1975 "addr=%p, ft-id=%s", type
,
1976 bt_ctf_field_type_id_string(type
->id
));
1981 floating_point
= container_of(type
,
1982 struct bt_ctf_field_type_floating_point
, parent
);
1984 if ((mantissa_digits
!= FLT_MANT_DIG
) &&
1985 (mantissa_digits
!= DBL_MANT_DIG
) &&
1986 (mantissa_digits
!= LDBL_MANT_DIG
)) {
1987 BT_LOGW("Invalid parameter: invalid mantissa size: "
1988 "addr=%p, mant-size=%u", type
, mantissa_digits
);
1993 floating_point
->mant_dig
= mantissa_digits
;
1994 BT_LOGV("Set floating point number field type's mantissa size: addr=%p, "
1995 "mant-size=%u", type
, mantissa_digits
);
2000 struct bt_ctf_field_type
*bt_ctf_field_type_structure_create(void)
2002 struct bt_ctf_field_type_structure
*structure
=
2003 g_new0(struct bt_ctf_field_type_structure
, 1);
2005 BT_LOGD_STR("Creating structure field type object.");
2008 BT_LOGE_STR("Failed to allocate one structure field type.");
2012 structure
->parent
.id
= BT_CTF_FIELD_TYPE_ID_STRUCT
;
2013 structure
->fields
= g_ptr_array_new_with_free_func(
2014 (GDestroyNotify
)destroy_structure_field
);
2015 structure
->field_name_to_index
= g_hash_table_new(NULL
, NULL
);
2016 bt_ctf_field_type_init(&structure
->parent
, TRUE
);
2017 BT_LOGD("Created structure field type object: addr=%p",
2018 &structure
->parent
);
2019 return &structure
->parent
;
2024 int bt_ctf_field_type_structure_add_field(struct bt_ctf_field_type
*type
,
2025 struct bt_ctf_field_type
*field_type
,
2026 const char *field_name
)
2029 struct bt_ctf_field_type_structure
*structure
;
2032 * TODO: check that `field_type` does not contain `type`,
2036 BT_LOGW_STR("Invalid parameter: field type is NULL.");
2042 BT_LOGW_STR("Invalid parameter: field name is NULL.");
2048 BT_LOGW("Invalid parameter: field type is frozen: addr=%p",
2054 if (bt_ctf_validate_identifier(field_name
)) {
2055 BT_LOGW("Invalid parameter: field name is not a valid CTF identifier: "
2056 "struct-ft-addr=%p, field-name=\"%s\"",
2062 if (type
->id
!= BT_CTF_FIELD_TYPE_ID_STRUCT
) {
2063 BT_LOGW("Invalid parameter: field type is not a structure field type: "
2064 "addr=%p, ft-id=%s", type
,
2065 bt_ctf_field_type_id_string(type
->id
));
2070 if (type
== field_type
) {
2071 BT_LOGW("Invalid parameter: structure field type and field type to add are the same: "
2077 structure
= container_of(type
,
2078 struct bt_ctf_field_type_structure
, parent
);
2079 if (add_structure_field(structure
->fields
,
2080 structure
->field_name_to_index
, field_type
, field_name
)) {
2081 BT_LOGW("Cannot add field to structure field type: "
2082 "struct-ft-addr=%p, field-ft-addr=%p, field-name=\"%s\"",
2083 type
, field_type
, field_name
);
2088 BT_LOGV("Added structure field type field: struct-ft-addr=%p, "
2089 "field-ft-addr=%p, field-name=\"%s\"", type
,
2090 field_type
, field_name
);
2095 int64_t bt_ctf_field_type_structure_get_field_count(
2096 struct bt_ctf_field_type
*type
)
2099 struct bt_ctf_field_type_structure
*structure
;
2102 BT_LOGW_STR("Invalid parameter: field type is NULL.");
2107 if (type
->id
!= BT_CTF_FIELD_TYPE_ID_STRUCT
) {
2108 BT_LOGW("Invalid parameter: field type is not a structure field type: "
2109 "addr=%p, ft-id=%s", type
,
2110 bt_ctf_field_type_id_string(type
->id
));
2115 structure
= container_of(type
, struct bt_ctf_field_type_structure
,
2117 ret
= (int64_t) structure
->fields
->len
;
2122 int bt_ctf_field_type_structure_get_field_by_index(
2123 struct bt_ctf_field_type
*type
,
2124 const char **field_name
, struct bt_ctf_field_type
**field_type
,
2127 struct bt_ctf_field_type_structure
*structure
;
2128 struct structure_field
*field
;
2132 BT_LOGW_STR("Invalid parameter: field type is NULL.");
2137 if (type
->id
!= BT_CTF_FIELD_TYPE_ID_STRUCT
) {
2138 BT_LOGW("Invalid parameter: field type is not a structure field type: "
2139 "addr=%p, ft-id=%s", type
,
2140 bt_ctf_field_type_id_string(type
->id
));
2145 structure
= container_of(type
, struct bt_ctf_field_type_structure
,
2147 if (index
>= structure
->fields
->len
) {
2148 BT_LOGW("Invalid parameter: index is out of bounds: "
2149 "addr=%p, index=%" PRIu64
", count=%u",
2150 type
, index
, structure
->fields
->len
);
2155 field
= g_ptr_array_index(structure
->fields
, index
);
2157 *field_type
= field
->type
;
2158 bt_get(field
->type
);
2161 *field_name
= g_quark_to_string(field
->name
);
2162 assert(*field_name
);
2168 struct bt_ctf_field_type
*bt_ctf_field_type_structure_get_field_type_by_name(
2169 struct bt_ctf_field_type
*type
,
2174 struct structure_field
*field
;
2175 struct bt_ctf_field_type_structure
*structure
;
2176 struct bt_ctf_field_type
*field_type
= NULL
;
2179 BT_LOGW_STR("Invalid parameter: field type is NULL.");
2184 BT_LOGW_STR("Invalid parameter: name is NULL.");
2188 name_quark
= g_quark_try_string(name
);
2190 BT_LOGV("No such structure field type field name: "
2191 "ft-addr=%p, field-name=\"%s\"",
2196 structure
= container_of(type
, struct bt_ctf_field_type_structure
,
2198 if (!g_hash_table_lookup_extended(structure
->field_name_to_index
,
2199 GUINT_TO_POINTER(name_quark
), NULL
, (gpointer
*)&index
)) {
2200 BT_LOGV("No such structure field type field name: "
2201 "ft-addr=%p, field-name=\"%s\"",
2206 field
= structure
->fields
->pdata
[index
];
2207 field_type
= field
->type
;
2213 struct bt_ctf_field_type
*bt_ctf_field_type_variant_create(
2214 struct bt_ctf_field_type
*enum_tag
, const char *tag_name
)
2216 struct bt_ctf_field_type_variant
*variant
= NULL
;
2218 BT_LOGD("Creating variant field type object: "
2219 "tag-ft-addr=%p, tag-field-name=\"%s\"",
2220 enum_tag
, tag_name
);
2222 if (tag_name
&& bt_ctf_validate_identifier(tag_name
)) {
2223 BT_LOGW("Invalid parameter: tag field name is not a valid CTF identifier: "
2224 "tag-ft-addr=%p, tag-field-name=\"%s\"",
2225 enum_tag
, tag_name
);
2229 variant
= g_new0(struct bt_ctf_field_type_variant
, 1);
2231 BT_LOGE_STR("Failed to allocate one variant field type.");
2235 variant
->parent
.id
= BT_CTF_FIELD_TYPE_ID_VARIANT
;
2236 variant
->tag_name
= g_string_new(tag_name
);
2237 variant
->field_name_to_index
= g_hash_table_new(NULL
, NULL
);
2238 variant
->fields
= g_ptr_array_new_with_free_func(
2239 (GDestroyNotify
) destroy_structure_field
);
2242 variant
->tag
= container_of(enum_tag
,
2243 struct bt_ctf_field_type_enumeration
, parent
);
2246 bt_ctf_field_type_init(&variant
->parent
, TRUE
);
2247 /* A variant's alignment is undefined */
2248 variant
->parent
.alignment
= 0;
2249 BT_LOGD("Created variant field type object: addr=%p, "
2250 "tag-ft-addr=%p, tag-field-name=\"%s\"",
2251 &variant
->parent
, enum_tag
, tag_name
);
2252 return &variant
->parent
;
2257 struct bt_ctf_field_type
*bt_ctf_field_type_variant_get_tag_type(
2258 struct bt_ctf_field_type
*type
)
2260 struct bt_ctf_field_type_variant
*variant
;
2261 struct bt_ctf_field_type
*tag_type
= NULL
;
2264 BT_LOGW_STR("Invalid parameter: field type is NULL.");
2268 if (type
->id
!= BT_CTF_FIELD_TYPE_ID_VARIANT
) {
2269 BT_LOGW("Invalid parameter: field type is not a variant field type: "
2270 "addr=%p, ft-id=%s", type
,
2271 bt_ctf_field_type_id_string(type
->id
));
2275 variant
= container_of(type
, struct bt_ctf_field_type_variant
, parent
);
2276 if (!variant
->tag
) {
2277 BT_LOGV("Variant field type has no tag field type: "
2282 tag_type
= &variant
->tag
->parent
;
2288 const char *bt_ctf_field_type_variant_get_tag_name(
2289 struct bt_ctf_field_type
*type
)
2291 struct bt_ctf_field_type_variant
*variant
;
2292 const char *tag_name
= NULL
;
2295 BT_LOGW_STR("Invalid parameter: field type is NULL.");
2299 if (type
->id
!= BT_CTF_FIELD_TYPE_ID_VARIANT
) {
2300 BT_LOGW("Invalid parameter: field type is not a variant field type: "
2301 "addr=%p, ft-id=%s", type
,
2302 bt_ctf_field_type_id_string(type
->id
));
2306 variant
= container_of(type
, struct bt_ctf_field_type_variant
, parent
);
2307 if (variant
->tag_name
->len
== 0) {
2308 BT_LOGV("Variant field type has no tag field name: "
2313 tag_name
= variant
->tag_name
->str
;
2318 int bt_ctf_field_type_variant_set_tag_name(
2319 struct bt_ctf_field_type
*type
, const char *name
)
2322 struct bt_ctf_field_type_variant
*variant
;
2325 BT_LOGW_STR("Invalid parameter: field type is NULL.");
2331 BT_LOGW("Invalid parameter: field type is frozen: addr=%p",
2337 if (type
->id
!= BT_CTF_FIELD_TYPE_ID_VARIANT
) {
2338 BT_LOGW("Invalid parameter: field type is not a variant field type: "
2339 "addr=%p, ft-id=%s", type
,
2340 bt_ctf_field_type_id_string(type
->id
));
2345 if (bt_ctf_validate_identifier(name
)) {
2346 BT_LOGW("Invalid parameter: tag field name is not a valid CTF identifier: "
2347 "variant-ft-addr=%p, tag-field-name=\"%s\"",
2353 variant
= container_of(type
, struct bt_ctf_field_type_variant
, parent
);
2354 g_string_assign(variant
->tag_name
, name
);
2355 BT_LOGV("Set variant field type's tag field name: addr=%p, "
2356 "tag-field-name=\"%s\"", type
, name
);
2361 int bt_ctf_field_type_variant_add_field(struct bt_ctf_field_type
*type
,
2362 struct bt_ctf_field_type
*field_type
,
2363 const char *field_name
)
2367 struct bt_ctf_field_type_variant
*variant
;
2368 GQuark field_name_quark
= g_quark_from_string(field_name
);
2371 * TODO: check that `field_type` does not contain `type`,
2375 BT_LOGW_STR("Invalid parameter: field type is NULL.");
2381 BT_LOGW("Invalid parameter: field type is frozen: addr=%p",
2387 if (bt_ctf_validate_identifier(field_name
)) {
2388 BT_LOGW("Invalid parameter: field name is not a valid CTF identifier: "
2389 "variant-ft-addr=%p, field-name=\"%s\"",
2395 if (type
->id
!= BT_CTF_FIELD_TYPE_ID_VARIANT
) {
2396 BT_LOGW("Invalid parameter: field type is not a variant field type: "
2397 "addr=%p, ft-id=%s", type
,
2398 bt_ctf_field_type_id_string(type
->id
));
2403 if (type
== field_type
) {
2404 BT_LOGW("Invalid parameter: variant field type and field type to add are the same: "
2410 variant
= container_of(type
, struct bt_ctf_field_type_variant
, parent
);
2412 /* The user has explicitly provided a tag; validate against it. */
2416 /* Make sure this name is present in the enum tag */
2417 for (i
= 0; i
< variant
->tag
->entries
->len
; i
++) {
2418 struct enumeration_mapping
*mapping
=
2419 g_ptr_array_index(variant
->tag
->entries
, i
);
2421 if (mapping
->string
== field_name_quark
) {
2428 /* Validation failed */
2429 BT_LOGW("Invalid parameter: field name does not name a tag field type's mapping: "
2430 "variant-ft-addr=%p, tag-ft-addr=%p, "
2431 "tag-field-name=\"%s\""
2432 "field-ft-addr=%p, field-name=\"%s\"",
2433 type
, variant
->tag
, variant
->tag_name
->str
,
2434 field_type
, field_name
);
2440 if (add_structure_field(variant
->fields
, variant
->field_name_to_index
,
2441 field_type
, field_name
)) {
2442 BT_LOGW("Cannot add field to variant field type: "
2443 "variant-ft-addr=%p, field-ft-addr=%p, field-name=\"%s\"",
2444 type
, field_type
, field_name
);
2449 BT_LOGV("Added variant field type field: variant-ft-addr=%p, "
2450 "field-ft-addr=%p, field-name=\"%s\"", type
,
2451 field_type
, field_name
);
2457 struct bt_ctf_field_type
*bt_ctf_field_type_variant_get_field_type_by_name(
2458 struct bt_ctf_field_type
*type
,
2459 const char *field_name
)
2463 struct structure_field
*field
;
2464 struct bt_ctf_field_type_variant
*variant
;
2465 struct bt_ctf_field_type
*field_type
= NULL
;
2468 BT_LOGW_STR("Invalid parameter: field type is NULL.");
2473 BT_LOGW_STR("Invalid parameter: field name is NULL.");
2477 name_quark
= g_quark_try_string(field_name
);
2479 BT_LOGV("No such variant field type field name: "
2480 "ft-addr=%p, field-name=\"%s\"",
2485 variant
= container_of(type
, struct bt_ctf_field_type_variant
, parent
);
2486 if (!g_hash_table_lookup_extended(variant
->field_name_to_index
,
2487 GUINT_TO_POINTER(name_quark
), NULL
, (gpointer
*)&index
)) {
2488 BT_LOGV("No such variant field type field name: "
2489 "ft-addr=%p, field-name=\"%s\"",
2494 field
= g_ptr_array_index(variant
->fields
, index
);
2495 field_type
= field
->type
;
2501 struct bt_ctf_field_type
*bt_ctf_field_type_variant_get_field_type_from_tag(
2502 struct bt_ctf_field_type
*type
,
2503 struct bt_ctf_field
*tag
)
2506 const char *enum_value
;
2507 struct bt_ctf_field_type
*field_type
= NULL
;
2508 struct bt_ctf_field_type_enumeration_mapping_iterator
*iter
= NULL
;
2511 BT_LOGW_STR("Invalid parameter: variant field type is NULL.");
2516 BT_LOGW_STR("Invalid parameter: tag field is NULL.");
2520 if (type
->id
!= BT_CTF_FIELD_TYPE_ID_VARIANT
) {
2521 BT_LOGW("Invalid parameter: field type is not a variant field type: "
2522 "addr=%p, ft-id=%s", type
,
2523 bt_ctf_field_type_id_string(type
->id
));
2527 iter
= bt_ctf_field_enumeration_get_mappings(tag
);
2529 BT_LOGE("Cannot get enumeration field type mapping iterator from enumeration field: "
2530 "enum-field-addr=%p", tag
);
2534 ret
= bt_ctf_field_type_enumeration_mapping_iterator_get_signed(iter
,
2535 &enum_value
, NULL
, NULL
);
2537 BT_LOGW("Cannot get enumeration field type mapping iterator's current mapping: "
2538 "iter-addr=%p", iter
);
2542 field_type
= bt_ctf_field_type_variant_get_field_type_by_name(
2549 int64_t bt_ctf_field_type_variant_get_field_count(struct bt_ctf_field_type
*type
)
2552 struct bt_ctf_field_type_variant
*variant
;
2555 BT_LOGW_STR("Invalid parameter: field type is NULL.");
2560 if (type
->id
!= BT_CTF_FIELD_TYPE_ID_VARIANT
) {
2561 BT_LOGW("Invalid parameter: field type is not a variant field type: "
2562 "addr=%p, ft-id=%s", type
,
2563 bt_ctf_field_type_id_string(type
->id
));
2568 variant
= container_of(type
, struct bt_ctf_field_type_variant
,
2570 ret
= (int64_t) variant
->fields
->len
;
2576 int bt_ctf_field_type_variant_get_field_by_index(struct bt_ctf_field_type
*type
,
2577 const char **field_name
, struct bt_ctf_field_type
**field_type
,
2580 struct bt_ctf_field_type_variant
*variant
;
2581 struct structure_field
*field
;
2585 BT_LOGW_STR("Invalid parameter: field type is NULL.");
2590 if (type
->id
!= BT_CTF_FIELD_TYPE_ID_VARIANT
) {
2591 BT_LOGW("Invalid parameter: field type is not a variant field type: "
2592 "addr=%p, ft-id=%s", type
,
2593 bt_ctf_field_type_id_string(type
->id
));
2598 variant
= container_of(type
, struct bt_ctf_field_type_variant
,
2600 if (index
>= variant
->fields
->len
) {
2601 BT_LOGW("Invalid parameter: index is out of bounds: "
2602 "addr=%p, index=%" PRIu64
", count=%u",
2603 type
, index
, variant
->fields
->len
);
2608 field
= g_ptr_array_index(variant
->fields
, index
);
2610 *field_type
= field
->type
;
2611 bt_get(field
->type
);
2614 *field_name
= g_quark_to_string(field
->name
);
2615 assert(*field_name
);
2621 struct bt_ctf_field_type
*bt_ctf_field_type_array_create(
2622 struct bt_ctf_field_type
*element_type
,
2623 unsigned int length
)
2625 struct bt_ctf_field_type_array
*array
= NULL
;
2627 BT_LOGD("Creating array field type object: element-ft-addr=%p, "
2628 "length=%u", element_type
, length
);
2630 if (!element_type
) {
2631 BT_LOGW_STR("Invalid parameter: element field type is NULL.");
2636 BT_LOGW_STR("Invalid parameter: length is zero.");
2640 array
= g_new0(struct bt_ctf_field_type_array
, 1);
2642 BT_LOGE_STR("Failed to allocate one array field type.");
2646 array
->parent
.id
= BT_CTF_FIELD_TYPE_ID_ARRAY
;
2647 bt_get(element_type
);
2648 array
->element_type
= element_type
;
2649 array
->length
= length
;
2650 bt_ctf_field_type_init(&array
->parent
, FALSE
);
2651 BT_LOGD("Created array field type object: addr=%p, "
2652 "element-ft-addr=%p, length=%u",
2653 &array
->parent
, element_type
, length
);
2654 return &array
->parent
;
2659 struct bt_ctf_field_type
*bt_ctf_field_type_array_get_element_type(
2660 struct bt_ctf_field_type
*type
)
2662 struct bt_ctf_field_type
*ret
= NULL
;
2663 struct bt_ctf_field_type_array
*array
;
2666 BT_LOGW_STR("Invalid parameter: field type is NULL.");
2670 if (type
->id
!= BT_CTF_FIELD_TYPE_ID_ARRAY
) {
2671 BT_LOGW("Invalid parameter: field type is not an array field type: "
2672 "addr=%p, ft-id=%s", type
,
2673 bt_ctf_field_type_id_string(type
->id
));
2677 array
= container_of(type
, struct bt_ctf_field_type_array
, parent
);
2678 ret
= array
->element_type
;
2685 int bt_ctf_field_type_array_set_element_type(struct bt_ctf_field_type
*type
,
2686 struct bt_ctf_field_type
*element_type
)
2689 struct bt_ctf_field_type_array
*array
;
2692 BT_LOGW_STR("Invalid parameter: array field type is NULL.");
2697 if (!element_type
) {
2698 BT_LOGW_STR("Invalid parameter: element field type is NULL.");
2703 if (type
->id
!= BT_CTF_FIELD_TYPE_ID_ARRAY
) {
2704 BT_LOGW("Invalid parameter: field type is not an array field type: "
2705 "addr=%p, ft-id=%s", type
,
2706 bt_ctf_field_type_id_string(type
->id
));
2711 array
= container_of(type
, struct bt_ctf_field_type_array
, parent
);
2713 if (array
->element_type
) {
2714 BT_PUT(array
->element_type
);
2717 array
->element_type
= element_type
;
2718 bt_get(array
->element_type
);
2719 BT_LOGV("Set array field type's element field type: array-ft-addr=%p, "
2720 "element-ft-addr=%p", type
, element_type
);
2726 int64_t bt_ctf_field_type_array_get_length(struct bt_ctf_field_type
*type
)
2729 struct bt_ctf_field_type_array
*array
;
2732 BT_LOGW_STR("Invalid parameter: field type is NULL.");
2737 if (type
->id
!= BT_CTF_FIELD_TYPE_ID_ARRAY
) {
2738 BT_LOGW("Invalid parameter: field type is not an array field type: "
2739 "addr=%p, ft-id=%s", type
,
2740 bt_ctf_field_type_id_string(type
->id
));
2745 array
= container_of(type
, struct bt_ctf_field_type_array
, parent
);
2746 ret
= (int64_t) array
->length
;
2751 struct bt_ctf_field_type
*bt_ctf_field_type_sequence_create(
2752 struct bt_ctf_field_type
*element_type
,
2753 const char *length_field_name
)
2755 struct bt_ctf_field_type_sequence
*sequence
= NULL
;
2757 BT_LOGD("Creating sequence field type object: element-ft-addr=%p, "
2758 "length-field-name=\"%s\"", element_type
, length_field_name
);
2760 if (!element_type
) {
2761 BT_LOGW_STR("Invalid parameter: element field type is NULL.");
2765 if (bt_ctf_validate_identifier(length_field_name
)) {
2766 BT_LOGW("Invalid parameter: length field name is not a valid CTF identifier: "
2767 "length-field-name=\"%s\"", length_field_name
);
2771 sequence
= g_new0(struct bt_ctf_field_type_sequence
, 1);
2773 BT_LOGE_STR("Failed to allocate one sequence field type.");
2777 sequence
->parent
.id
= BT_CTF_FIELD_TYPE_ID_SEQUENCE
;
2778 bt_get(element_type
);
2779 sequence
->element_type
= element_type
;
2780 sequence
->length_field_name
= g_string_new(length_field_name
);
2781 bt_ctf_field_type_init(&sequence
->parent
, FALSE
);
2782 BT_LOGD("Created sequence field type object: addr=%p, "
2783 "element-ft-addr=%p, length-field-name=\"%s\"",
2784 &sequence
->parent
, element_type
, length_field_name
);
2785 return &sequence
->parent
;
2790 struct bt_ctf_field_type
*bt_ctf_field_type_sequence_get_element_type(
2791 struct bt_ctf_field_type
*type
)
2793 struct bt_ctf_field_type
*ret
= NULL
;
2794 struct bt_ctf_field_type_sequence
*sequence
;
2797 BT_LOGW_STR("Invalid parameter: field type is NULL.");
2801 if (type
->id
!= BT_CTF_FIELD_TYPE_ID_SEQUENCE
) {
2802 BT_LOGW("Invalid parameter: field type is not a sequence field type: "
2803 "addr=%p, ft-id=%s", type
,
2804 bt_ctf_field_type_id_string(type
->id
));
2808 sequence
= container_of(type
, struct bt_ctf_field_type_sequence
,
2810 ret
= sequence
->element_type
;
2817 int bt_ctf_field_type_sequence_set_element_type(struct bt_ctf_field_type
*type
,
2818 struct bt_ctf_field_type
*element_type
)
2821 struct bt_ctf_field_type_sequence
*sequence
;
2824 BT_LOGW_STR("Invalid parameter: sequence field type is NULL.");
2829 if (!element_type
) {
2830 BT_LOGW_STR("Invalid parameter: element field type is NULL.");
2835 if (type
->id
!= BT_CTF_FIELD_TYPE_ID_SEQUENCE
) {
2836 BT_LOGW("Invalid parameter: field type is not a sequence field type: "
2837 "addr=%p, ft-id=%s", type
,
2838 bt_ctf_field_type_id_string(type
->id
));
2843 sequence
= container_of(type
, struct bt_ctf_field_type_sequence
, parent
);
2844 if (sequence
->element_type
) {
2845 BT_PUT(sequence
->element_type
);
2848 sequence
->element_type
= element_type
;
2849 bt_get(sequence
->element_type
);
2850 BT_LOGV("Set sequence field type's element field type: sequence-ft-addr=%p, "
2851 "element-ft-addr=%p", type
, element_type
);
2857 const char *bt_ctf_field_type_sequence_get_length_field_name(
2858 struct bt_ctf_field_type
*type
)
2860 const char *ret
= NULL
;
2861 struct bt_ctf_field_type_sequence
*sequence
;
2864 BT_LOGW_STR("Invalid parameter: field type is NULL.");
2868 if (type
->id
!= BT_CTF_FIELD_TYPE_ID_SEQUENCE
) {
2869 BT_LOGW("Invalid parameter: field type is not a sequence field type: "
2870 "addr=%p, ft-id=%s", type
,
2871 bt_ctf_field_type_id_string(type
->id
));
2875 sequence
= container_of(type
, struct bt_ctf_field_type_sequence
,
2877 ret
= sequence
->length_field_name
->str
;
2882 struct bt_ctf_field_type
*bt_ctf_field_type_string_create(void)
2884 struct bt_ctf_field_type_string
*string
=
2885 g_new0(struct bt_ctf_field_type_string
, 1);
2887 BT_LOGD_STR("Creating string field type object.");
2890 BT_LOGE_STR("Failed to allocate one string field type.");
2894 string
->parent
.id
= BT_CTF_FIELD_TYPE_ID_STRING
;
2895 bt_ctf_field_type_init(&string
->parent
, TRUE
);
2896 string
->encoding
= BT_CTF_STRING_ENCODING_UTF8
;
2897 string
->parent
.alignment
= CHAR_BIT
;
2898 BT_LOGD("Created string field type object: addr=%p", &string
->parent
);
2899 return &string
->parent
;
2902 enum bt_ctf_string_encoding
bt_ctf_field_type_string_get_encoding(
2903 struct bt_ctf_field_type
*type
)
2905 struct bt_ctf_field_type_string
*string
;
2906 enum bt_ctf_string_encoding ret
= BT_CTF_STRING_ENCODING_UNKNOWN
;
2909 BT_LOGW_STR("Invalid parameter: field type is NULL.");
2913 if (type
->id
!= BT_CTF_FIELD_TYPE_ID_STRING
) {
2914 BT_LOGW("Invalid parameter: field type is not a string field type: "
2915 "addr=%p, ft-id=%s", type
,
2916 bt_ctf_field_type_id_string(type
->id
));
2920 string
= container_of(type
, struct bt_ctf_field_type_string
,
2922 ret
= string
->encoding
;
2927 int bt_ctf_field_type_string_set_encoding(struct bt_ctf_field_type
*type
,
2928 enum bt_ctf_string_encoding encoding
)
2931 struct bt_ctf_field_type_string
*string
;
2934 BT_LOGW_STR("Invalid parameter: field type is NULL.");
2939 if (type
->id
!= BT_CTF_FIELD_TYPE_ID_STRING
) {
2940 BT_LOGW("Invalid parameter: field type is not a string field type: "
2941 "addr=%p, ft-id=%s", type
,
2942 bt_ctf_field_type_id_string(type
->id
));
2947 if ((encoding
!= BT_CTF_STRING_ENCODING_UTF8
&&
2948 encoding
!= BT_CTF_STRING_ENCODING_ASCII
)) {
2949 BT_LOGW("Invalid parameter: unknown string encoding: "
2950 "addr=%p, encoding=%d", type
, encoding
);
2955 string
= container_of(type
, struct bt_ctf_field_type_string
, parent
);
2956 string
->encoding
= encoding
;
2957 BT_LOGV("Set string field type's encoding: addr=%p, encoding=%s",
2958 type
, bt_ctf_string_encoding_string(encoding
));
2963 int bt_ctf_field_type_get_alignment(struct bt_ctf_field_type
*type
)
2966 enum bt_ctf_field_type_id type_id
;
2969 BT_LOGW_STR("Invalid parameter: field type is NULL.");
2975 ret
= (int) type
->alignment
;
2979 type_id
= bt_ctf_field_type_get_type_id(type
);
2981 case BT_CTF_FIELD_TYPE_ID_SEQUENCE
:
2983 struct bt_ctf_field_type
*element
=
2984 bt_ctf_field_type_sequence_get_element_type(type
);
2987 ret
= bt_ctf_field_type_get_alignment(element
);
2991 case BT_CTF_FIELD_TYPE_ID_ARRAY
:
2993 struct bt_ctf_field_type
*element
=
2994 bt_ctf_field_type_array_get_element_type(type
);
2997 ret
= bt_ctf_field_type_get_alignment(element
);
3001 case BT_CTF_FIELD_TYPE_ID_STRUCT
:
3003 int64_t i
, element_count
;
3005 element_count
= bt_ctf_field_type_structure_get_field_count(
3007 assert(element_count
>= 0);
3009 for (i
= 0; i
< element_count
; i
++) {
3010 struct bt_ctf_field_type
*field
;
3011 int field_alignment
;
3013 ret
= bt_ctf_field_type_structure_get_field_by_index(
3014 type
, NULL
, &field
, i
);
3017 field_alignment
= bt_ctf_field_type_get_alignment(
3020 if (field_alignment
< 0) {
3021 ret
= field_alignment
;
3025 type
->alignment
= MAX(field_alignment
, type
->alignment
);
3027 ret
= (int) type
->alignment
;
3030 case BT_CTF_FIELD_TYPE_ID_UNKNOWN
:
3031 BT_LOGW("Invalid parameter: unknown field type ID: "
3032 "addr=%p, ft-id=%d", type
, type_id
);
3036 ret
= (int) type
->alignment
;
3044 int is_power_of_two(unsigned int value
)
3046 return ((value
& (value
- 1)) == 0) && value
> 0;
3049 int bt_ctf_field_type_set_alignment(struct bt_ctf_field_type
*type
,
3050 unsigned int alignment
)
3053 enum bt_ctf_field_type_id type_id
;
3055 /* Alignment must be a power of two */
3057 BT_LOGW_STR("Invalid parameter: field type is NULL.");
3063 BT_LOGW("Invalid parameter: field type is frozen: addr=%p",
3069 if (!is_power_of_two(alignment
)) {
3070 BT_LOGW("Invalid parameter: alignment is not a power of two: "
3071 "addr=%p, align=%u", type
, alignment
);
3076 type_id
= bt_ctf_field_type_get_type_id(type
);
3077 if (type_id
== BT_CTF_FIELD_TYPE_ID_UNKNOWN
) {
3078 BT_LOGW("Invalid parameter: unknown field type ID: "
3079 "addr=%p, ft-id=%d", type
, type_id
);
3084 if (type
->id
== BT_CTF_FIELD_TYPE_ID_STRING
&&
3085 alignment
!= CHAR_BIT
) {
3086 BT_LOGW("Invalid parameter: alignment must be %u for a string field type: "
3087 "addr=%p, align=%u", CHAR_BIT
, type
, alignment
);
3092 if (type_id
== BT_CTF_FIELD_TYPE_ID_VARIANT
||
3093 type_id
== BT_CTF_FIELD_TYPE_ID_SEQUENCE
||
3094 type_id
== BT_CTF_FIELD_TYPE_ID_ARRAY
) {
3095 /* Setting an alignment on these types makes no sense */
3096 BT_LOGW("Invalid parameter: cannot set the alignment of this field type: "
3097 "addr=%p, ft-id=%s", type
,
3098 bt_ctf_field_type_id_string(type
->id
));
3103 type
->alignment
= alignment
;
3105 BT_LOGV("Set field type's alignment: addr=%p, align=%u",
3111 enum bt_ctf_byte_order
bt_ctf_field_type_get_byte_order(
3112 struct bt_ctf_field_type
*type
)
3114 enum bt_ctf_byte_order ret
= BT_CTF_BYTE_ORDER_UNKNOWN
;
3117 BT_LOGW_STR("Invalid parameter: field type is NULL.");
3122 case BT_CTF_FIELD_TYPE_ID_INTEGER
:
3124 struct bt_ctf_field_type_integer
*integer
= container_of(
3125 type
, struct bt_ctf_field_type_integer
, parent
);
3126 ret
= integer
->user_byte_order
;
3129 case BT_CTF_FIELD_TYPE_ID_ENUM
:
3131 struct bt_ctf_field_type_enumeration
*enum_ft
= container_of(
3132 type
, struct bt_ctf_field_type_enumeration
, parent
);
3133 ret
= bt_ctf_field_type_get_byte_order(enum_ft
->container
);
3136 case BT_CTF_FIELD_TYPE_ID_FLOAT
:
3138 struct bt_ctf_field_type_floating_point
*floating_point
=
3140 struct bt_ctf_field_type_floating_point
,
3142 ret
= floating_point
->user_byte_order
;
3146 BT_LOGW("Invalid parameter: cannot get the byte order of this field type: "
3147 "addr=%p, ft-id=%s", type
,
3148 bt_ctf_field_type_id_string(type
->id
));
3152 assert(ret
== BT_CTF_BYTE_ORDER_NATIVE
||
3153 ret
== BT_CTF_BYTE_ORDER_LITTLE_ENDIAN
||
3154 ret
== BT_CTF_BYTE_ORDER_BIG_ENDIAN
||
3155 ret
== BT_CTF_BYTE_ORDER_NETWORK
);
3161 int bt_ctf_field_type_set_byte_order(struct bt_ctf_field_type
*type
,
3162 enum bt_ctf_byte_order byte_order
)
3167 BT_LOGW_STR("Invalid parameter: field type is NULL.");
3173 BT_LOGW("Invalid parameter: field type is frozen: addr=%p",
3179 if (byte_order
!= BT_CTF_BYTE_ORDER_NATIVE
&&
3180 byte_order
!= BT_CTF_BYTE_ORDER_LITTLE_ENDIAN
&&
3181 byte_order
!= BT_CTF_BYTE_ORDER_BIG_ENDIAN
&&
3182 byte_order
!= BT_CTF_BYTE_ORDER_NETWORK
) {
3183 BT_LOGW("Invalid parameter: invalid byte order: "
3184 "addr=%p, bo=%s", type
,
3185 bt_ctf_byte_order_string(byte_order
));
3190 if (set_byte_order_funcs
[type
->id
]) {
3191 set_byte_order_funcs
[type
->id
](type
, byte_order
);
3194 BT_LOGV("Set field type's byte order: addr=%p, bo=%s",
3195 type
, bt_ctf_byte_order_string(byte_order
));
3201 enum bt_ctf_field_type_id
bt_ctf_field_type_get_type_id(
3202 struct bt_ctf_field_type
*type
)
3205 BT_LOGW_STR("Invalid parameter: field type is NULL.");
3206 return BT_CTF_FIELD_TYPE_ID_UNKNOWN
;
3212 int bt_ctf_field_type_is_integer(struct bt_ctf_field_type
*type
)
3214 return bt_ctf_field_type_get_type_id(type
) == BT_CTF_FIELD_TYPE_ID_INTEGER
;
3217 int bt_ctf_field_type_is_floating_point(struct bt_ctf_field_type
*type
)
3219 return bt_ctf_field_type_get_type_id(type
) == BT_CTF_FIELD_TYPE_ID_FLOAT
;
3222 int bt_ctf_field_type_is_enumeration(struct bt_ctf_field_type
*type
)
3224 return bt_ctf_field_type_get_type_id(type
) == BT_CTF_FIELD_TYPE_ID_ENUM
;
3227 int bt_ctf_field_type_is_string(struct bt_ctf_field_type
*type
)
3229 return bt_ctf_field_type_get_type_id(type
) == BT_CTF_FIELD_TYPE_ID_STRING
;
3232 int bt_ctf_field_type_is_structure(struct bt_ctf_field_type
*type
)
3234 return bt_ctf_field_type_get_type_id(type
) == BT_CTF_FIELD_TYPE_ID_STRUCT
;
3237 int bt_ctf_field_type_is_array(struct bt_ctf_field_type
*type
)
3239 return bt_ctf_field_type_get_type_id(type
) == BT_CTF_FIELD_TYPE_ID_ARRAY
;
3242 int bt_ctf_field_type_is_sequence(struct bt_ctf_field_type
*type
)
3244 return bt_ctf_field_type_get_type_id(type
) == BT_CTF_FIELD_TYPE_ID_SEQUENCE
;
3247 int bt_ctf_field_type_is_variant(struct bt_ctf_field_type
*type
)
3249 return bt_ctf_field_type_get_type_id(type
) == BT_CTF_FIELD_TYPE_ID_VARIANT
;
3252 /* Pre-2.0 CTF writer backward compatibility */
3253 void bt_ctf_field_type_get(struct bt_ctf_field_type
*type
)
3258 /* Pre-2.0 CTF writer backward compatibility */
3259 void bt_ctf_field_type_put(struct bt_ctf_field_type
*type
)
3265 void bt_ctf_field_type_freeze(struct bt_ctf_field_type
*type
)
3267 if (!type
|| type
->frozen
) {
3275 struct bt_ctf_field_type
*bt_ctf_field_type_variant_get_field_type_signed(
3276 struct bt_ctf_field_type_variant
*variant
,
3279 struct bt_ctf_field_type
*type
= NULL
;
3280 GQuark field_name_quark
;
3282 struct structure_field
*field_entry
;
3283 struct range_overlap_query query
= {
3284 .range_start
._signed
= tag_value
,
3285 .range_end
._signed
= tag_value
,
3290 g_ptr_array_foreach(variant
->tag
->entries
, check_ranges_overlap
,
3292 if (!query
.overlaps
) {
3296 field_name_quark
= query
.mapping_name
;
3297 if (!g_hash_table_lookup_extended(variant
->field_name_to_index
,
3298 GUINT_TO_POINTER(field_name_quark
), NULL
, &index
)) {
3302 field_entry
= g_ptr_array_index(variant
->fields
, (size_t) index
);
3303 type
= field_entry
->type
;
3309 struct bt_ctf_field_type
*bt_ctf_field_type_variant_get_field_type_unsigned(
3310 struct bt_ctf_field_type_variant
*variant
,
3313 struct bt_ctf_field_type
*type
= NULL
;
3314 GQuark field_name_quark
;
3316 struct structure_field
*field_entry
;
3317 struct range_overlap_query query
= {
3318 .range_start
._unsigned
= tag_value
,
3319 .range_end
._unsigned
= tag_value
,
3324 g_ptr_array_foreach(variant
->tag
->entries
,
3325 check_ranges_overlap_unsigned
,
3327 if (!query
.overlaps
) {
3331 field_name_quark
= query
.mapping_name
;
3332 if (!g_hash_table_lookup_extended(variant
->field_name_to_index
,
3333 GUINT_TO_POINTER(field_name_quark
), NULL
, &index
)) {
3337 field_entry
= g_ptr_array_index(variant
->fields
, (size_t)index
);
3338 type
= field_entry
->type
;
3344 int bt_ctf_field_type_serialize(struct bt_ctf_field_type
*type
,
3345 struct metadata_context
*context
)
3352 /* Make sure field type is valid before serializing it */
3353 ret
= bt_ctf_field_type_validate(type
);
3355 BT_LOGW("Cannot serialize field type's metadata: field type is invalid: "
3360 ret
= type
->serialize(type
, context
);
3365 struct bt_ctf_field_type
*bt_ctf_field_type_copy(struct bt_ctf_field_type
*type
)
3367 struct bt_ctf_field_type
*copy
= NULL
;
3370 BT_LOGW_STR("Invalid parameter: field type is NULL.");
3374 copy
= type_copy_funcs
[type
->id
](type
);
3376 BT_LOGE_STR("Cannot copy field type.");
3380 copy
->alignment
= type
->alignment
;
3386 int bt_ctf_field_type_structure_get_field_name_index(
3387 struct bt_ctf_field_type
*type
, const char *name
)
3392 struct bt_ctf_field_type_structure
*structure
;
3395 BT_LOGW_STR("Invalid parameter: field type is NULL.");
3401 BT_LOGW_STR("Invalid parameter: field name is NULL.");
3406 if (bt_ctf_field_type_get_type_id(type
) != BT_CTF_FIELD_TYPE_ID_STRUCT
) {
3407 BT_LOGW("Invalid parameter: field type is not a structure field type: "
3408 "addr=%p, ft-id=%s", type
,
3409 bt_ctf_field_type_id_string(type
->id
));
3414 name_quark
= g_quark_try_string(name
);
3416 BT_LOGV("No such structure field type field name: "
3417 "ft-addr=%p, field-name=\"%s\"",
3423 structure
= container_of(type
, struct bt_ctf_field_type_structure
,
3425 if (!g_hash_table_lookup_extended(structure
->field_name_to_index
,
3426 GUINT_TO_POINTER(name_quark
),
3427 NULL
, (gpointer
*)&index
)) {
3428 BT_LOGV("No such structure field type field name: "
3429 "ft-addr=%p, field-name=\"%s\"",
3440 int bt_ctf_field_type_variant_get_field_name_index(
3441 struct bt_ctf_field_type
*type
, const char *name
)
3446 struct bt_ctf_field_type_variant
*variant
;
3449 BT_LOGW_STR("Invalid parameter: variant field type is NULL.");
3455 BT_LOGW_STR("Invalid parameter: field name is NULL.");
3460 if (bt_ctf_field_type_get_type_id(type
) != BT_CTF_FIELD_TYPE_ID_VARIANT
) {
3461 BT_LOGW("Invalid parameter: field type is not a variant field type: "
3462 "addr=%p, ft-id=%s", type
,
3463 bt_ctf_field_type_id_string(type
->id
));
3468 name_quark
= g_quark_try_string(name
);
3470 BT_LOGV("No such variant field type field name: "
3471 "ft-addr=%p, field-name=\"%s\"",
3477 variant
= container_of(type
, struct bt_ctf_field_type_variant
,
3479 if (!g_hash_table_lookup_extended(variant
->field_name_to_index
,
3480 GUINT_TO_POINTER(name_quark
),
3481 NULL
, (gpointer
*)&index
)) {
3482 BT_LOGV("No such variant field type field name: "
3483 "ft-addr=%p, field-name=\"%s\"",
3494 int bt_ctf_field_type_sequence_set_length_field_path(
3495 struct bt_ctf_field_type
*type
,
3496 struct bt_ctf_field_path
*path
)
3499 struct bt_ctf_field_type_sequence
*sequence
;
3502 BT_LOGW_STR("Invalid parameter: field type is NULL.");
3507 if (bt_ctf_field_type_get_type_id(type
) != BT_CTF_FIELD_TYPE_ID_SEQUENCE
) {
3508 BT_LOGW("Invalid parameter: field type is not a sequence field type: "
3509 "addr=%p, ft-id=%s", type
,
3510 bt_ctf_field_type_id_string(type
->id
));
3515 sequence
= container_of(type
, struct bt_ctf_field_type_sequence
,
3518 BT_MOVE(sequence
->length_field_path
, path
);
3519 BT_LOGV("Set sequence field type's length field path: ft-addr=%p, "
3520 "field-path-addr=%p", type
, path
);
3526 int bt_ctf_field_type_variant_set_tag_field_path(struct bt_ctf_field_type
*type
,
3527 struct bt_ctf_field_path
*path
)
3530 struct bt_ctf_field_type_variant
*variant
;
3533 BT_LOGW_STR("Invalid parameter: field type is NULL.");
3538 if (bt_ctf_field_type_get_type_id(type
) != BT_CTF_FIELD_TYPE_ID_VARIANT
) {
3539 BT_LOGW("Invalid parameter: field type is not a variant field type: "
3540 "addr=%p, ft-id=%s", type
,
3541 bt_ctf_field_type_id_string(type
->id
));
3546 variant
= container_of(type
, struct bt_ctf_field_type_variant
,
3549 BT_MOVE(variant
->tag_field_path
, path
);
3550 BT_LOGV("Set variant field type's tag field path: ft-addr=%p, "
3551 "field-path-addr=%p", type
, path
);
3557 int bt_ctf_field_type_variant_set_tag_field_type(struct bt_ctf_field_type
*type
,
3558 struct bt_ctf_field_type
*tag
)
3561 struct bt_ctf_field_type_variant
*variant
;
3564 BT_LOGW_STR("Invalid parameter: variant field type is NULL.");
3570 BT_LOGW_STR("Invalid parameter: tag field type is NULL.");
3575 if (bt_ctf_field_type_get_type_id(tag
) != BT_CTF_FIELD_TYPE_ID_ENUM
) {
3576 BT_LOGW("Invalid parameter: field type is not an enumeration field type: "
3577 "addr=%p, ft-id=%s", type
,
3578 bt_ctf_field_type_id_string(type
->id
));
3583 variant
= container_of(type
, struct bt_ctf_field_type_variant
,
3587 bt_put(&variant
->tag
->parent
);
3589 variant
->tag
= container_of(tag
, struct bt_ctf_field_type_enumeration
,
3591 BT_LOGV("Set variant field type's tag field type: variant-ft-addr=%p, "
3592 "tag-ft-addr=%p", type
, tag
);
3598 void bt_ctf_field_type_integer_destroy(struct bt_ctf_field_type
*type
)
3600 struct bt_ctf_field_type_integer
*integer
=
3601 (struct bt_ctf_field_type_integer
*) type
;
3607 BT_LOGD("Destroying integer field type object: addr=%p", type
);
3608 BT_LOGD_STR("Putting mapped clock class.");
3609 bt_put(integer
->mapped_clock
);
3614 void bt_ctf_field_type_enumeration_destroy(struct bt_ctf_field_type
*type
)
3616 struct bt_ctf_field_type_enumeration
*enumeration
=
3617 (struct bt_ctf_field_type_enumeration
*) type
;
3623 BT_LOGD("Destroying enumeration field type object: addr=%p", type
);
3624 g_ptr_array_free(enumeration
->entries
, TRUE
);
3625 BT_LOGD_STR("Putting container field type.");
3626 bt_put(enumeration
->container
);
3627 g_free(enumeration
);
3631 void bt_ctf_field_type_floating_point_destroy(struct bt_ctf_field_type
*type
)
3633 struct bt_ctf_field_type_floating_point
*floating_point
=
3634 (struct bt_ctf_field_type_floating_point
*) type
;
3640 BT_LOGD("Destroying floating point number field type object: addr=%p", type
);
3641 g_free(floating_point
);
3645 void bt_ctf_field_type_structure_destroy(struct bt_ctf_field_type
*type
)
3647 struct bt_ctf_field_type_structure
*structure
=
3648 (struct bt_ctf_field_type_structure
*) type
;
3654 BT_LOGD("Destroying structure field type object: addr=%p", type
);
3655 g_ptr_array_free(structure
->fields
, TRUE
);
3656 g_hash_table_destroy(structure
->field_name_to_index
);
3661 void bt_ctf_field_type_variant_destroy(struct bt_ctf_field_type
*type
)
3663 struct bt_ctf_field_type_variant
*variant
=
3664 (struct bt_ctf_field_type_variant
*) type
;
3670 BT_LOGD("Destroying variant field type object: addr=%p", type
);
3671 g_ptr_array_free(variant
->fields
, TRUE
);
3672 g_hash_table_destroy(variant
->field_name_to_index
);
3673 g_string_free(variant
->tag_name
, TRUE
);
3674 BT_LOGD_STR("Putting tag field type.");
3675 bt_put(&variant
->tag
->parent
);
3676 BT_PUT(variant
->tag_field_path
);
3681 void bt_ctf_field_type_array_destroy(struct bt_ctf_field_type
*type
)
3683 struct bt_ctf_field_type_array
*array
=
3684 (struct bt_ctf_field_type_array
*) type
;
3690 BT_LOGD("Destroying array field type object: addr=%p", type
);
3691 BT_LOGD_STR("Putting element field type.");
3692 bt_put(array
->element_type
);
3697 void bt_ctf_field_type_sequence_destroy(struct bt_ctf_field_type
*type
)
3699 struct bt_ctf_field_type_sequence
*sequence
=
3700 (struct bt_ctf_field_type_sequence
*) type
;
3706 BT_LOGD("Destroying sequence field type object: addr=%p", type
);
3707 BT_LOGD_STR("Putting element field type.");
3708 bt_put(sequence
->element_type
);
3709 g_string_free(sequence
->length_field_name
, TRUE
);
3710 BT_LOGD_STR("Putting length field path.");
3711 BT_PUT(sequence
->length_field_path
);
3716 void bt_ctf_field_type_string_destroy(struct bt_ctf_field_type
*type
)
3718 struct bt_ctf_field_type_string
*string
=
3719 (struct bt_ctf_field_type_string
*) type
;
3725 BT_LOGD("Destroying string field type object: addr=%p", type
);
3730 void generic_field_type_freeze(struct bt_ctf_field_type
*type
)
3736 void bt_ctf_field_type_integer_freeze(struct bt_ctf_field_type
*type
)
3738 struct bt_ctf_field_type_integer
*integer_type
= container_of(
3739 type
, struct bt_ctf_field_type_integer
, parent
);
3741 BT_LOGD("Freezing integer field type object: addr=%p", type
);
3743 if (integer_type
->mapped_clock
) {
3744 BT_LOGD_STR("Freezing integer field type's mapped clock class.");
3745 bt_ctf_clock_class_freeze(integer_type
->mapped_clock
);
3748 generic_field_type_freeze(type
);
3752 void bt_ctf_field_type_enumeration_freeze(struct bt_ctf_field_type
*type
)
3754 struct bt_ctf_field_type_enumeration
*enumeration_type
= container_of(
3755 type
, struct bt_ctf_field_type_enumeration
, parent
);
3757 BT_LOGD("Freezing enumeration field type object: addr=%p", type
);
3758 set_enumeration_range_overlap(type
);
3759 generic_field_type_freeze(type
);
3760 BT_LOGD("Freezing enumeration field type object's container field type: int-ft-addr=%p",
3761 enumeration_type
->container
);
3762 bt_ctf_field_type_freeze(enumeration_type
->container
);
3766 void freeze_structure_field(struct structure_field
*field
)
3768 BT_LOGD("Freezing structure/variant field type field: field-addr=%p, "
3769 "field-ft-addr=%p, field-name=\"%s\"", field
,
3770 field
->type
, g_quark_to_string(field
->name
));
3771 bt_ctf_field_type_freeze(field
->type
);
3775 void bt_ctf_field_type_structure_freeze(struct bt_ctf_field_type
*type
)
3777 struct bt_ctf_field_type_structure
*structure_type
= container_of(
3778 type
, struct bt_ctf_field_type_structure
, parent
);
3780 /* Cache the alignment */
3781 BT_LOGD("Freezing structure field type object: addr=%p", type
);
3782 type
->alignment
= bt_ctf_field_type_get_alignment(type
);
3783 generic_field_type_freeze(type
);
3784 g_ptr_array_foreach(structure_type
->fields
,
3785 (GFunc
) freeze_structure_field
, NULL
);
3789 void bt_ctf_field_type_variant_freeze(struct bt_ctf_field_type
*type
)
3791 struct bt_ctf_field_type_variant
*variant_type
= container_of(
3792 type
, struct bt_ctf_field_type_variant
, parent
);
3794 BT_LOGD("Freezing variant field type object: addr=%p", type
);
3795 generic_field_type_freeze(type
);
3796 g_ptr_array_foreach(variant_type
->fields
,
3797 (GFunc
) freeze_structure_field
, NULL
);
3801 void bt_ctf_field_type_array_freeze(struct bt_ctf_field_type
*type
)
3803 struct bt_ctf_field_type_array
*array_type
= container_of(
3804 type
, struct bt_ctf_field_type_array
, parent
);
3806 /* Cache the alignment */
3807 BT_LOGD("Freezing array field type object: addr=%p", type
);
3808 type
->alignment
= bt_ctf_field_type_get_alignment(type
);
3809 generic_field_type_freeze(type
);
3810 BT_LOGD("Freezing array field type object's element field type: element-ft-addr=%p",
3811 array_type
->element_type
);
3812 bt_ctf_field_type_freeze(array_type
->element_type
);
3816 void bt_ctf_field_type_sequence_freeze(struct bt_ctf_field_type
*type
)
3818 struct bt_ctf_field_type_sequence
*sequence_type
= container_of(
3819 type
, struct bt_ctf_field_type_sequence
, parent
);
3821 /* Cache the alignment */
3822 BT_LOGD("Freezing sequence field type object: addr=%p", type
);
3823 type
->alignment
= bt_ctf_field_type_get_alignment(type
);
3824 generic_field_type_freeze(type
);
3825 BT_LOGD("Freezing sequence field type object's element field type: element-ft-addr=%p",
3826 sequence_type
->element_type
);
3827 bt_ctf_field_type_freeze(sequence_type
->element_type
);
3831 const char *get_encoding_string(enum bt_ctf_string_encoding encoding
)
3833 const char *encoding_string
;
3836 case BT_CTF_STRING_ENCODING_NONE
:
3837 encoding_string
= "none";
3839 case BT_CTF_STRING_ENCODING_ASCII
:
3840 encoding_string
= "ASCII";
3842 case BT_CTF_STRING_ENCODING_UTF8
:
3843 encoding_string
= "UTF8";
3846 encoding_string
= "unknown";
3850 return encoding_string
;
3854 const char *get_integer_base_string(enum bt_ctf_integer_base base
)
3856 const char *base_string
;
3859 case BT_CTF_INTEGER_BASE_DECIMAL
:
3860 case BT_CTF_INTEGER_BASE_UNSPECIFIED
:
3861 base_string
= "decimal";
3863 case BT_CTF_INTEGER_BASE_HEXADECIMAL
:
3864 base_string
= "hexadecimal";
3866 case BT_CTF_INTEGER_BASE_OCTAL
:
3867 base_string
= "octal";
3869 case BT_CTF_INTEGER_BASE_BINARY
:
3870 base_string
= "binary";
3873 base_string
= "unknown";
3881 int bt_ctf_field_type_integer_serialize(struct bt_ctf_field_type
*type
,
3882 struct metadata_context
*context
)
3884 struct bt_ctf_field_type_integer
*integer
= container_of(type
,
3885 struct bt_ctf_field_type_integer
, parent
);
3888 BT_LOGD("Serializing integer field type's metadata: "
3889 "ft-addr=%p, metadata-context-addr=%p", type
, context
);
3890 g_string_append_printf(context
->string
,
3891 "integer { size = %u; align = %u; signed = %s; encoding = %s; base = %s; byte_order = %s",
3892 integer
->size
, type
->alignment
,
3893 (integer
->is_signed
? "true" : "false"),
3894 get_encoding_string(integer
->encoding
),
3895 get_integer_base_string(integer
->base
),
3896 get_byte_order_string(integer
->user_byte_order
));
3897 if (integer
->mapped_clock
) {
3898 const char *clock_name
= bt_ctf_clock_class_get_name(
3899 integer
->mapped_clock
);
3902 g_string_append_printf(context
->string
,
3903 "; map = clock.%s.value", clock_name
);
3906 g_string_append(context
->string
, "; }");
3911 int bt_ctf_field_type_enumeration_serialize(struct bt_ctf_field_type
*type
,
3912 struct metadata_context
*context
)
3916 struct bt_ctf_field_type_enumeration
*enumeration
= container_of(type
,
3917 struct bt_ctf_field_type_enumeration
, parent
);
3918 struct bt_ctf_field_type
*container_type
;
3919 int container_signed
;
3921 BT_LOGD("Serializing enumeration field type's metadata: "
3922 "ft-addr=%p, metadata-context-addr=%p", type
, context
);
3923 container_type
= bt_ctf_field_type_enumeration_get_container_type(type
);
3924 assert(container_type
);
3925 container_signed
= bt_ctf_field_type_integer_get_signed(container_type
);
3926 assert(container_signed
>= 0);
3927 g_string_append(context
->string
, "enum : ");
3928 BT_LOGD_STR("Serializing enumeration field type's container field type's metadata.");
3929 ret
= bt_ctf_field_type_serialize(enumeration
->container
, context
);
3931 BT_LOGW("Cannot serialize enumeration field type's container field type's metadata: "
3932 "container-ft-addr=%p", enumeration
->container
);
3936 g_string_append(context
->string
, " { ");
3937 for (entry
= 0; entry
< enumeration
->entries
->len
; entry
++) {
3938 struct enumeration_mapping
*mapping
=
3939 enumeration
->entries
->pdata
[entry
];
3941 if (container_signed
) {
3942 if (mapping
->range_start
._signed
==
3943 mapping
->range_end
._signed
) {
3944 g_string_append_printf(context
->string
,
3945 "\"%s\" = %" PRId64
,
3946 g_quark_to_string(mapping
->string
),
3947 mapping
->range_start
._signed
);
3949 g_string_append_printf(context
->string
,
3950 "\"%s\" = %" PRId64
" ... %" PRId64
,
3951 g_quark_to_string(mapping
->string
),
3952 mapping
->range_start
._signed
,
3953 mapping
->range_end
._signed
);
3956 if (mapping
->range_start
._unsigned
==
3957 mapping
->range_end
._unsigned
) {
3958 g_string_append_printf(context
->string
,
3959 "\"%s\" = %" PRIu64
,
3960 g_quark_to_string(mapping
->string
),
3961 mapping
->range_start
._unsigned
);
3963 g_string_append_printf(context
->string
,
3964 "\"%s\" = %" PRIu64
" ... %" PRIu64
,
3965 g_quark_to_string(mapping
->string
),
3966 mapping
->range_start
._unsigned
,
3967 mapping
->range_end
._unsigned
);
3971 g_string_append(context
->string
,
3972 ((entry
!= (enumeration
->entries
->len
- 1)) ?
3976 if (context
->field_name
->len
) {
3977 g_string_append_printf(context
->string
, " %s",
3978 context
->field_name
->str
);
3979 g_string_assign(context
->field_name
, "");
3982 bt_put(container_type
);
3987 int bt_ctf_field_type_floating_point_serialize(struct bt_ctf_field_type
*type
,
3988 struct metadata_context
*context
)
3990 struct bt_ctf_field_type_floating_point
*floating_point
= container_of(
3991 type
, struct bt_ctf_field_type_floating_point
, parent
);
3993 BT_LOGD("Serializing floating point number field type's metadata: "
3994 "ft-addr=%p, metadata-context-addr=%p", type
, context
);
3995 g_string_append_printf(context
->string
,
3996 "floating_point { exp_dig = %u; mant_dig = %u; byte_order = %s; align = %u; }",
3997 floating_point
->exp_dig
,
3998 floating_point
->mant_dig
,
3999 get_byte_order_string(floating_point
->user_byte_order
),
4005 int bt_ctf_field_type_structure_serialize(struct bt_ctf_field_type
*type
,
4006 struct metadata_context
*context
)
4009 unsigned int indent
;
4011 struct bt_ctf_field_type_structure
*structure
= container_of(type
,
4012 struct bt_ctf_field_type_structure
, parent
);
4013 GString
*structure_field_name
= context
->field_name
;
4015 BT_LOGD("Serializing structure field type's metadata: "
4016 "ft-addr=%p, metadata-context-addr=%p", type
, context
);
4017 context
->field_name
= g_string_new("");
4019 context
->current_indentation_level
++;
4020 g_string_append(context
->string
, "struct {\n");
4022 for (i
= 0; i
< structure
->fields
->len
; i
++) {
4023 struct structure_field
*field
= structure
->fields
->pdata
[i
];
4025 BT_LOGD("Serializing structure field type's field metadata: "
4027 "field-ft-addr=%p, field-name=\"%s\"",
4028 i
, field
, g_quark_to_string(field
->name
));
4030 for (indent
= 0; indent
< context
->current_indentation_level
;
4032 g_string_append_c(context
->string
, '\t');
4035 g_string_assign(context
->field_name
,
4036 g_quark_to_string(field
->name
));
4037 ret
= bt_ctf_field_type_serialize(field
->type
, context
);
4039 BT_LOGW("Cannot serialize structure field type's field's metadata: "
4041 "field-ft-addr=%p, field-name=\"%s\"",
4043 g_quark_to_string(field
->name
));
4047 if (context
->field_name
->len
) {
4048 g_string_append_printf(context
->string
, " %s",
4049 context
->field_name
->str
);
4051 g_string_append(context
->string
, ";\n");
4054 context
->current_indentation_level
--;
4055 for (indent
= 0; indent
< context
->current_indentation_level
;
4057 g_string_append_c(context
->string
, '\t');
4060 g_string_append_printf(context
->string
, "} align(%u)",
4063 g_string_free(context
->field_name
, TRUE
);
4064 context
->field_name
= structure_field_name
;
4069 int bt_ctf_field_type_variant_serialize(struct bt_ctf_field_type
*type
,
4070 struct metadata_context
*context
)
4073 unsigned int indent
;
4075 struct bt_ctf_field_type_variant
*variant
= container_of(
4076 type
, struct bt_ctf_field_type_variant
, parent
);
4077 GString
*variant_field_name
= context
->field_name
;
4079 BT_LOGD("Serializing variant field type's metadata: "
4080 "ft-addr=%p, metadata-context-addr=%p", type
, context
);
4081 context
->field_name
= g_string_new("");
4082 if (variant
->tag_name
->len
> 0) {
4083 g_string_append_printf(context
->string
,
4084 "variant <%s> {\n", variant
->tag_name
->str
);
4086 g_string_append(context
->string
, "variant {\n");
4089 context
->current_indentation_level
++;
4090 for (i
= 0; i
< variant
->fields
->len
; i
++) {
4091 struct structure_field
*field
= variant
->fields
->pdata
[i
];
4093 BT_LOGD("Serializing variant field type's field metadata: "
4095 "field-ft-addr=%p, field-name=\"%s\"",
4096 i
, field
, g_quark_to_string(field
->name
));
4098 g_string_assign(context
->field_name
,
4099 g_quark_to_string(field
->name
));
4100 for (indent
= 0; indent
< context
->current_indentation_level
;
4102 g_string_append_c(context
->string
, '\t');
4105 g_string_assign(context
->field_name
,
4106 g_quark_to_string(field
->name
));
4107 ret
= bt_ctf_field_type_serialize(field
->type
, context
);
4109 BT_LOGW("Cannot serialize variant field type's field's metadata: "
4111 "field-ft-addr=%p, field-name=\"%s\"",
4113 g_quark_to_string(field
->name
));
4117 if (context
->field_name
->len
) {
4118 g_string_append_printf(context
->string
, " %s;",
4119 context
->field_name
->str
);
4122 g_string_append_c(context
->string
, '\n');
4125 context
->current_indentation_level
--;
4126 for (indent
= 0; indent
< context
->current_indentation_level
;
4128 g_string_append_c(context
->string
, '\t');
4131 g_string_append(context
->string
, "}");
4133 g_string_free(context
->field_name
, TRUE
);
4134 context
->field_name
= variant_field_name
;
4139 int bt_ctf_field_type_array_serialize(struct bt_ctf_field_type
*type
,
4140 struct metadata_context
*context
)
4143 struct bt_ctf_field_type_array
*array
= container_of(type
,
4144 struct bt_ctf_field_type_array
, parent
);
4146 BT_LOGD("Serializing array field type's metadata: "
4147 "ft-addr=%p, metadata-context-addr=%p", type
, context
);
4148 BT_LOGD_STR("Serializing array field type's element field type's metadata.");
4149 ret
= bt_ctf_field_type_serialize(array
->element_type
, context
);
4151 BT_LOGW("Cannot serialize array field type's element field type's metadata: "
4152 "element-ft-addr=%p", array
->element_type
);
4156 if (context
->field_name
->len
) {
4157 g_string_append_printf(context
->string
, " %s[%u]",
4158 context
->field_name
->str
, array
->length
);
4159 g_string_assign(context
->field_name
, "");
4161 g_string_append_printf(context
->string
, "[%u]", array
->length
);
4168 int bt_ctf_field_type_sequence_serialize(struct bt_ctf_field_type
*type
,
4169 struct metadata_context
*context
)
4172 struct bt_ctf_field_type_sequence
*sequence
= container_of(
4173 type
, struct bt_ctf_field_type_sequence
, parent
);
4175 BT_LOGD("Serializing sequence field type's metadata: "
4176 "ft-addr=%p, metadata-context-addr=%p", type
, context
);
4177 BT_LOGD_STR("Serializing sequence field type's element field type's metadata.");
4178 ret
= bt_ctf_field_type_serialize(sequence
->element_type
, context
);
4180 BT_LOGW("Cannot serialize sequence field type's element field type's metadata: "
4181 "element-ft-addr=%p", sequence
->element_type
);
4185 if (context
->field_name
->len
) {
4186 g_string_append_printf(context
->string
, " %s[%s]",
4187 context
->field_name
->str
,
4188 sequence
->length_field_name
->str
);
4189 g_string_assign(context
->field_name
, "");
4191 g_string_append_printf(context
->string
, "[%s]",
4192 sequence
->length_field_name
->str
);
4199 int bt_ctf_field_type_string_serialize(struct bt_ctf_field_type
*type
,
4200 struct metadata_context
*context
)
4202 struct bt_ctf_field_type_string
*string
= container_of(
4203 type
, struct bt_ctf_field_type_string
, parent
);
4205 BT_LOGD("Serializing string field type's metadata: "
4206 "ft-addr=%p, metadata-context-addr=%p", type
, context
);
4207 g_string_append_printf(context
->string
,
4208 "string { encoding = %s; }",
4209 get_encoding_string(string
->encoding
));
4214 void bt_ctf_field_type_integer_set_byte_order(struct bt_ctf_field_type
*type
,
4215 enum bt_ctf_byte_order byte_order
)
4217 struct bt_ctf_field_type_integer
*integer_type
= container_of(type
,
4218 struct bt_ctf_field_type_integer
, parent
);
4220 integer_type
->user_byte_order
= byte_order
;
4224 void bt_ctf_field_type_enumeration_set_byte_order(
4225 struct bt_ctf_field_type
*type
, enum bt_ctf_byte_order byte_order
)
4227 struct bt_ctf_field_type_enumeration
*enum_type
= container_of(type
,
4228 struct bt_ctf_field_type_enumeration
, parent
);
4230 /* Safe to assume that container is an integer */
4231 bt_ctf_field_type_integer_set_byte_order(enum_type
->container
,
4236 void bt_ctf_field_type_floating_point_set_byte_order(
4237 struct bt_ctf_field_type
*type
, enum bt_ctf_byte_order byte_order
)
4239 struct bt_ctf_field_type_floating_point
*floating_point_type
=
4240 container_of(type
, struct bt_ctf_field_type_floating_point
,
4243 floating_point_type
->user_byte_order
= byte_order
;
4247 void bt_ctf_field_type_structure_set_byte_order(struct bt_ctf_field_type
*type
,
4248 enum bt_ctf_byte_order byte_order
)
4251 struct bt_ctf_field_type_structure
*structure_type
=
4252 container_of(type
, struct bt_ctf_field_type_structure
,
4255 for (i
= 0; i
< structure_type
->fields
->len
; i
++) {
4256 struct structure_field
*field
= g_ptr_array_index(
4257 structure_type
->fields
, i
);
4258 struct bt_ctf_field_type
*field_type
= field
->type
;
4260 if (set_byte_order_funcs
[field_type
->id
]) {
4261 set_byte_order_funcs
[field_type
->id
](
4262 field_type
, byte_order
);
4268 void bt_ctf_field_type_variant_set_byte_order(struct bt_ctf_field_type
*type
,
4269 enum bt_ctf_byte_order byte_order
)
4272 struct bt_ctf_field_type_variant
*variant_type
=
4273 container_of(type
, struct bt_ctf_field_type_variant
,
4276 for (i
= 0; i
< variant_type
->fields
->len
; i
++) {
4277 struct structure_field
*field
= g_ptr_array_index(
4278 variant_type
->fields
, i
);
4279 struct bt_ctf_field_type
*field_type
= field
->type
;
4281 if (set_byte_order_funcs
[field_type
->id
]) {
4282 set_byte_order_funcs
[field_type
->id
](
4283 field_type
, byte_order
);
4289 void bt_ctf_field_type_array_set_byte_order(struct bt_ctf_field_type
*type
,
4290 enum bt_ctf_byte_order byte_order
)
4292 struct bt_ctf_field_type_array
*array_type
=
4293 container_of(type
, struct bt_ctf_field_type_array
,
4296 if (set_byte_order_funcs
[array_type
->element_type
->id
]) {
4297 set_byte_order_funcs
[array_type
->element_type
->id
](
4298 array_type
->element_type
, byte_order
);
4303 void bt_ctf_field_type_sequence_set_byte_order(struct bt_ctf_field_type
*type
,
4304 enum bt_ctf_byte_order byte_order
)
4306 struct bt_ctf_field_type_sequence
*sequence_type
=
4307 container_of(type
, struct bt_ctf_field_type_sequence
,
4310 if (set_byte_order_funcs
[
4311 sequence_type
->element_type
->id
]) {
4312 set_byte_order_funcs
[
4313 sequence_type
->element_type
->id
](
4314 sequence_type
->element_type
, byte_order
);
4319 struct bt_ctf_field_type
*bt_ctf_field_type_integer_copy(
4320 struct bt_ctf_field_type
*type
)
4322 struct bt_ctf_field_type
*copy
;
4323 struct bt_ctf_field_type_integer
*integer
, *copy_integer
;
4325 BT_LOGD("Copying integer field type's: addr=%p", type
);
4326 integer
= container_of(type
, struct bt_ctf_field_type_integer
, parent
);
4327 copy
= bt_ctf_field_type_integer_create(integer
->size
);
4329 BT_LOGE_STR("Cannot create integer field type.");
4333 copy_integer
= container_of(copy
, struct bt_ctf_field_type_integer
,
4335 copy_integer
->mapped_clock
= bt_get(integer
->mapped_clock
);
4336 copy_integer
->user_byte_order
= integer
->user_byte_order
;
4337 copy_integer
->is_signed
= integer
->is_signed
;
4338 copy_integer
->size
= integer
->size
;
4339 copy_integer
->base
= integer
->base
;
4340 copy_integer
->encoding
= integer
->encoding
;
4341 BT_LOGD("Copied integer field type: original-ft-addr=%p, copy-ft-addr=%p",
4349 struct bt_ctf_field_type
*bt_ctf_field_type_enumeration_copy(
4350 struct bt_ctf_field_type
*type
)
4353 struct bt_ctf_field_type
*copy
= NULL
, *copy_container
;
4354 struct bt_ctf_field_type_enumeration
*enumeration
, *copy_enumeration
;
4356 BT_LOGD("Copying enumeration field type's: addr=%p", type
);
4357 enumeration
= container_of(type
, struct bt_ctf_field_type_enumeration
,
4360 /* Copy the source enumeration's container */
4361 BT_LOGD_STR("Copying enumeration field type's container field type.");
4362 copy_container
= bt_ctf_field_type_copy(enumeration
->container
);
4363 if (!copy_container
) {
4364 BT_LOGE_STR("Cannot copy enumeration field type's container field type.");
4368 copy
= bt_ctf_field_type_enumeration_create(copy_container
);
4370 BT_LOGE_STR("Cannot create enumeration field type.");
4373 copy_enumeration
= container_of(copy
,
4374 struct bt_ctf_field_type_enumeration
, parent
);
4376 /* Copy all enumaration entries */
4377 for (i
= 0; i
< enumeration
->entries
->len
; i
++) {
4378 struct enumeration_mapping
*mapping
= g_ptr_array_index(
4379 enumeration
->entries
, i
);
4380 struct enumeration_mapping
*copy_mapping
= g_new0(
4381 struct enumeration_mapping
, 1);
4383 if (!copy_mapping
) {
4384 BT_LOGE_STR("Failed to allocate one enumeration mapping.");
4388 *copy_mapping
= *mapping
;
4389 g_ptr_array_add(copy_enumeration
->entries
, copy_mapping
);
4392 BT_LOGD("Copied enumeration field type: original-ft-addr=%p, copy-ft-addr=%p",
4396 bt_put(copy_container
);
4399 bt_put(copy_container
);
4405 struct bt_ctf_field_type
*bt_ctf_field_type_floating_point_copy(
4406 struct bt_ctf_field_type
*type
)
4408 struct bt_ctf_field_type
*copy
;
4409 struct bt_ctf_field_type_floating_point
*floating_point
, *copy_float
;
4411 BT_LOGD("Copying floating point number field type's: addr=%p", type
);
4412 floating_point
= container_of(type
,
4413 struct bt_ctf_field_type_floating_point
, parent
);
4414 copy
= bt_ctf_field_type_floating_point_create();
4416 BT_LOGE_STR("Cannot create floating point number field type.");
4420 copy_float
= container_of(copy
,
4421 struct bt_ctf_field_type_floating_point
, parent
);
4422 copy_float
->user_byte_order
= floating_point
->user_byte_order
;
4423 copy_float
->exp_dig
= floating_point
->exp_dig
;
4424 copy_float
->mant_dig
= floating_point
->mant_dig
;
4425 BT_LOGD("Copied floating point number field type: original-ft-addr=%p, copy-ft-addr=%p",
4432 struct bt_ctf_field_type
*bt_ctf_field_type_structure_copy(
4433 struct bt_ctf_field_type
*type
)
4436 GHashTableIter iter
;
4437 gpointer key
, value
;
4438 struct bt_ctf_field_type
*copy
;
4439 struct bt_ctf_field_type_structure
*structure
, *copy_structure
;
4441 BT_LOGD("Copying structure field type's: addr=%p", type
);
4442 structure
= container_of(type
, struct bt_ctf_field_type_structure
,
4444 copy
= bt_ctf_field_type_structure_create();
4446 BT_LOGE_STR("Cannot create structure field type.");
4450 copy_structure
= container_of(copy
,
4451 struct bt_ctf_field_type_structure
, parent
);
4453 /* Copy field_name_to_index */
4454 g_hash_table_iter_init(&iter
, structure
->field_name_to_index
);
4455 while (g_hash_table_iter_next (&iter
, &key
, &value
)) {
4456 g_hash_table_insert(copy_structure
->field_name_to_index
,
4460 for (i
= 0; i
< structure
->fields
->len
; i
++) {
4461 struct structure_field
*entry
, *copy_entry
;
4462 struct bt_ctf_field_type
*copy_field
;
4464 entry
= g_ptr_array_index(structure
->fields
, i
);
4465 BT_LOGD("Copying structure field type's field: "
4466 "index=%" PRId64
", "
4467 "field-ft-addr=%p, field-name=\"%s\"",
4468 i
, entry
, g_quark_to_string(entry
->name
));
4469 copy_entry
= g_new0(struct structure_field
, 1);
4471 BT_LOGE_STR("Failed to allocate one structure field type field.");
4475 copy_field
= bt_ctf_field_type_copy(entry
->type
);
4477 BT_LOGE("Cannot copy structure field type's field: "
4478 "index=%" PRId64
", "
4479 "field-ft-addr=%p, field-name=\"%s\"",
4480 i
, entry
, g_quark_to_string(entry
->name
));
4485 copy_entry
->name
= entry
->name
;
4486 copy_entry
->type
= copy_field
;
4487 g_ptr_array_add(copy_structure
->fields
, copy_entry
);
4490 BT_LOGD("Copied structure field type: original-ft-addr=%p, copy-ft-addr=%p",
4501 struct bt_ctf_field_type
*bt_ctf_field_type_variant_copy(
4502 struct bt_ctf_field_type
*type
)
4505 GHashTableIter iter
;
4506 gpointer key
, value
;
4507 struct bt_ctf_field_type
*copy
= NULL
, *copy_tag
= NULL
;
4508 struct bt_ctf_field_type_variant
*variant
, *copy_variant
;
4510 BT_LOGD("Copying variant field type's: addr=%p", type
);
4511 variant
= container_of(type
, struct bt_ctf_field_type_variant
,
4514 BT_LOGD_STR("Copying variant field type's tag field type.");
4515 copy_tag
= bt_ctf_field_type_copy(&variant
->tag
->parent
);
4517 BT_LOGE_STR("Cannot copy variant field type's tag field type.");
4522 copy
= bt_ctf_field_type_variant_create(copy_tag
,
4523 variant
->tag_name
->len
? variant
->tag_name
->str
: NULL
);
4525 BT_LOGE_STR("Cannot create variant field type.");
4529 copy_variant
= container_of(copy
, struct bt_ctf_field_type_variant
,
4532 /* Copy field_name_to_index */
4533 g_hash_table_iter_init(&iter
, variant
->field_name_to_index
);
4534 while (g_hash_table_iter_next (&iter
, &key
, &value
)) {
4535 g_hash_table_insert(copy_variant
->field_name_to_index
,
4539 for (i
= 0; i
< variant
->fields
->len
; i
++) {
4540 struct structure_field
*entry
, *copy_entry
;
4541 struct bt_ctf_field_type
*copy_field
;
4543 entry
= g_ptr_array_index(variant
->fields
, i
);
4544 BT_LOGD("Copying variant field type's field: "
4545 "index=%" PRId64
", "
4546 "field-ft-addr=%p, field-name=\"%s\"",
4547 i
, entry
, g_quark_to_string(entry
->name
));
4548 copy_entry
= g_new0(struct structure_field
, 1);
4550 BT_LOGE_STR("Failed to allocate one variant field type field.");
4554 copy_field
= bt_ctf_field_type_copy(entry
->type
);
4556 BT_LOGE("Cannot copy variant field type's field: "
4557 "index=%" PRId64
", "
4558 "field-ft-addr=%p, field-name=\"%s\"",
4559 i
, entry
, g_quark_to_string(entry
->name
));
4564 copy_entry
->name
= entry
->name
;
4565 copy_entry
->type
= copy_field
;
4566 g_ptr_array_add(copy_variant
->fields
, copy_entry
);
4569 if (variant
->tag_field_path
) {
4570 BT_LOGD_STR("Copying variant field type's tag field path.");
4571 copy_variant
->tag_field_path
= bt_ctf_field_path_copy(
4572 variant
->tag_field_path
);
4573 if (!copy_variant
->tag_field_path
) {
4574 BT_LOGE_STR("Cannot copy variant field type's tag field path.");
4579 BT_LOGD("Copied variant field type: original-ft-addr=%p, copy-ft-addr=%p",
4592 struct bt_ctf_field_type
*bt_ctf_field_type_array_copy(
4593 struct bt_ctf_field_type
*type
)
4595 struct bt_ctf_field_type
*copy
= NULL
, *copy_element
;
4596 struct bt_ctf_field_type_array
*array
;
4598 BT_LOGD("Copying array field type's: addr=%p", type
);
4599 array
= container_of(type
, struct bt_ctf_field_type_array
,
4601 BT_LOGD_STR("Copying array field type's element field type.");
4602 copy_element
= bt_ctf_field_type_copy(array
->element_type
);
4603 if (!copy_element
) {
4604 BT_LOGE_STR("Cannot copy array field type's element field type.");
4608 copy
= bt_ctf_field_type_array_create(copy_element
, array
->length
);
4610 BT_LOGE_STR("Cannot create array field type.");
4614 BT_LOGD("Copied array field type: original-ft-addr=%p, copy-ft-addr=%p",
4618 bt_put(copy_element
);
4623 struct bt_ctf_field_type
*bt_ctf_field_type_sequence_copy(
4624 struct bt_ctf_field_type
*type
)
4626 struct bt_ctf_field_type
*copy
= NULL
, *copy_element
;
4627 struct bt_ctf_field_type_sequence
*sequence
, *copy_sequence
;
4629 BT_LOGD("Copying sequence field type's: addr=%p", type
);
4630 sequence
= container_of(type
, struct bt_ctf_field_type_sequence
,
4632 BT_LOGD_STR("Copying sequence field type's element field type.");
4633 copy_element
= bt_ctf_field_type_copy(sequence
->element_type
);
4634 if (!copy_element
) {
4635 BT_LOGE_STR("Cannot copy sequence field type's element field type.");
4639 copy
= bt_ctf_field_type_sequence_create(copy_element
,
4640 sequence
->length_field_name
->len
?
4641 sequence
->length_field_name
->str
: NULL
);
4643 BT_LOGE_STR("Cannot create sequence field type.");
4647 copy_sequence
= container_of(copy
, struct bt_ctf_field_type_sequence
,
4649 if (sequence
->length_field_path
) {
4650 BT_LOGD_STR("Copying sequence field type's length field path.");
4651 copy_sequence
->length_field_path
= bt_ctf_field_path_copy(
4652 sequence
->length_field_path
);
4653 if (!copy_sequence
->length_field_path
) {
4654 BT_LOGE_STR("Cannot copy sequence field type's length field path.");
4659 BT_LOGD("Copied sequence field type: original-ft-addr=%p, copy-ft-addr=%p",
4663 bt_put(copy_element
);
4671 struct bt_ctf_field_type
*bt_ctf_field_type_string_copy(
4672 struct bt_ctf_field_type
*type
)
4674 struct bt_ctf_field_type
*copy
;
4676 BT_LOGD("Copying string field type's: addr=%p", type
);
4677 copy
= bt_ctf_field_type_string_create();
4679 BT_LOGE_STR("Cannot create string field type.");
4683 BT_LOGD("Copied string field type: original-ft-addr=%p, copy-ft-addr=%p",
4690 int bt_ctf_field_type_integer_compare(struct bt_ctf_field_type
*type_a
,
4691 struct bt_ctf_field_type
*type_b
)
4694 struct bt_ctf_field_type_integer
*int_type_a
;
4695 struct bt_ctf_field_type_integer
*int_type_b
;
4697 int_type_a
= container_of(type_a
, struct bt_ctf_field_type_integer
,
4699 int_type_b
= container_of(type_b
, struct bt_ctf_field_type_integer
,
4703 if (int_type_a
->size
!= int_type_b
->size
) {
4704 BT_LOGV("Integer field types differ: different sizes: "
4705 "ft-a-size=%u, ft-b-size=%u",
4706 int_type_a
->size
, int_type_b
->size
);
4711 if (int_type_a
->user_byte_order
!= int_type_b
->user_byte_order
) {
4712 BT_LOGV("Integer field types differ: different byte orders: "
4713 "ft-a-bo=%s, ft-b-bo=%s",
4714 bt_ctf_byte_order_string(int_type_a
->user_byte_order
),
4715 bt_ctf_byte_order_string(int_type_b
->user_byte_order
));
4720 if (int_type_a
->is_signed
!= int_type_b
->is_signed
) {
4721 BT_LOGV("Integer field types differ: different signedness: "
4722 "ft-a-is-signed=%d, ft-b-is-signed=%d",
4723 int_type_a
->is_signed
,
4724 int_type_b
->is_signed
);
4729 if (int_type_a
->base
!= int_type_b
->base
) {
4730 BT_LOGV("Integer field types differ: different bases: "
4731 "ft-a-base=%s, ft-b-base=%s",
4732 bt_ctf_integer_base_string(int_type_a
->base
),
4733 bt_ctf_integer_base_string(int_type_b
->base
));
4738 if (int_type_a
->encoding
!= int_type_b
->encoding
) {
4739 BT_LOGV("Integer field types differ: different encodings: "
4740 "ft-a-encoding=%s, ft-b-encoding=%s",
4741 bt_ctf_string_encoding_string(int_type_a
->encoding
),
4742 bt_ctf_string_encoding_string(int_type_b
->encoding
));
4747 if (int_type_a
->mapped_clock
!= int_type_b
->mapped_clock
) {
4748 BT_LOGV("Integer field types differ: different mapped clock classes: "
4749 "ft-a-mapped-clock-class-addr=%p, "
4750 "ft-b-mapped-clock-class-addr=%p, "
4751 "ft-a-mapped-clock-class-name=\"%s\", "
4752 "ft-b-mapped-clock-class-name=\"%s\"",
4753 int_type_a
->mapped_clock
, int_type_b
->mapped_clock
,
4754 int_type_a
->mapped_clock
? bt_ctf_clock_class_get_name(int_type_a
->mapped_clock
) : "",
4755 int_type_b
->mapped_clock
? bt_ctf_clock_class_get_name(int_type_b
->mapped_clock
) : "");
4767 int bt_ctf_field_type_floating_point_compare(struct bt_ctf_field_type
*type_a
,
4768 struct bt_ctf_field_type
*type_b
)
4771 struct bt_ctf_field_type_floating_point
*float_a
;
4772 struct bt_ctf_field_type_floating_point
*float_b
;
4774 float_a
= container_of(type_a
,
4775 struct bt_ctf_field_type_floating_point
, parent
);
4776 float_b
= container_of(type_b
,
4777 struct bt_ctf_field_type_floating_point
, parent
);
4780 if (float_a
->user_byte_order
!= float_b
->user_byte_order
) {
4781 BT_LOGV("Floating point number field types differ: different byte orders: "
4782 "ft-a-bo=%s, ft-b-bo=%s",
4783 bt_ctf_byte_order_string(float_a
->user_byte_order
),
4784 bt_ctf_byte_order_string(float_b
->user_byte_order
));
4788 /* Exponent length */
4789 if (float_a
->exp_dig
!= float_b
->exp_dig
) {
4790 BT_LOGV("Floating point number field types differ: different exponent sizes: "
4791 "ft-a-exp-size=%u, ft-b-exp-size=%u",
4792 float_a
->exp_dig
, float_b
->exp_dig
);
4796 /* Mantissa length */
4797 if (float_a
->mant_dig
!= float_b
->mant_dig
) {
4798 BT_LOGV("Floating point number field types differ: different mantissa sizes: "
4799 "ft-a-mant-size=%u, ft-b-mant-size=%u",
4800 float_a
->mant_dig
, float_b
->mant_dig
);
4812 int compare_enumeration_mappings(struct enumeration_mapping
*mapping_a
,
4813 struct enumeration_mapping
*mapping_b
)
4818 if (mapping_a
->string
!= mapping_b
->string
) {
4819 BT_LOGV("Enumeration field type mappings differ: different names: "
4820 "mapping-a-name=\"%s\", mapping-b-name=\"%s\"",
4821 g_quark_to_string(mapping_a
->string
),
4822 g_quark_to_string(mapping_b
->string
));
4827 if (mapping_a
->range_start
._unsigned
!=
4828 mapping_b
->range_start
._unsigned
) {
4829 BT_LOGV("Enumeration field type mappings differ: different starts of range: "
4830 "mapping-a-range-start-unsigned=%" PRIu64
", "
4831 "mapping-b-range-start-unsigned=%" PRIu64
,
4832 mapping_a
->range_start
._unsigned
,
4833 mapping_b
->range_start
._unsigned
);
4838 if (mapping_a
->range_end
._unsigned
!=
4839 mapping_b
->range_end
._unsigned
) {
4840 BT_LOGV("Enumeration field type mappings differ: different ends of range: "
4841 "mapping-a-range-end-unsigned=%" PRIu64
", "
4842 "mapping-b-range-end-unsigned=%" PRIu64
,
4843 mapping_a
->range_end
._unsigned
,
4844 mapping_b
->range_end
._unsigned
);
4856 int bt_ctf_field_type_enumeration_compare(struct bt_ctf_field_type
*type_a
,
4857 struct bt_ctf_field_type
*type_b
)
4861 struct bt_ctf_field_type_enumeration
*enum_a
;
4862 struct bt_ctf_field_type_enumeration
*enum_b
;
4864 enum_a
= container_of(type_a
,
4865 struct bt_ctf_field_type_enumeration
, parent
);
4866 enum_b
= container_of(type_b
,
4867 struct bt_ctf_field_type_enumeration
, parent
);
4869 /* Container field type */
4870 ret
= bt_ctf_field_type_compare(enum_a
->container
, enum_b
->container
);
4872 BT_LOGV("Enumeration field types differ: different container field types: "
4873 "ft-a-container-ft-addr=%p, ft-b-container-ft-addr=%p",
4874 enum_a
->container
, enum_b
->container
);
4881 if (enum_a
->entries
->len
!= enum_b
->entries
->len
) {
4885 for (i
= 0; i
< enum_a
->entries
->len
; ++i
) {
4886 struct enumeration_mapping
*mapping_a
=
4887 g_ptr_array_index(enum_a
->entries
, i
);
4888 struct enumeration_mapping
*mapping_b
=
4889 g_ptr_array_index(enum_b
->entries
, i
);
4891 if (compare_enumeration_mappings(mapping_a
, mapping_b
)) {
4892 BT_LOGV("Enumeration field types differ: different mappings: "
4893 "ft-a-mapping-addr=%p, ft-b-mapping-addr=%p, "
4894 "ft-a-mapping-name=\"%s\", ft-b-mapping-name=\"%s\"",
4895 mapping_a
, mapping_b
,
4896 g_quark_to_string(mapping_a
->string
),
4897 g_quark_to_string(mapping_b
->string
));
4910 int bt_ctf_field_type_string_compare(struct bt_ctf_field_type
*type_a
,
4911 struct bt_ctf_field_type
*type_b
)
4914 struct bt_ctf_field_type_string
*string_a
;
4915 struct bt_ctf_field_type_string
*string_b
;
4917 string_a
= container_of(type_a
,
4918 struct bt_ctf_field_type_string
, parent
);
4919 string_b
= container_of(type_b
,
4920 struct bt_ctf_field_type_string
, parent
);
4923 if (string_a
->encoding
!= string_b
->encoding
) {
4924 BT_LOGV("String field types differ: different encodings: "
4925 "ft-a-encoding=%s, ft-b-encoding=%s",
4926 bt_ctf_string_encoding_string(string_a
->encoding
),
4927 bt_ctf_string_encoding_string(string_b
->encoding
));
4939 int compare_structure_fields(struct structure_field
*field_a
,
4940 struct structure_field
*field_b
)
4945 if (field_a
->name
!= field_b
->name
) {
4946 BT_LOGV("Structure/variant field type fields differ: different names: "
4947 "field-a-name=%s, field-b-name=%s",
4948 g_quark_to_string(field_a
->name
),
4949 g_quark_to_string(field_b
->name
));
4954 ret
= bt_ctf_field_type_compare(field_a
->type
, field_b
->type
);
4956 BT_LOGV("Structure/variant field type fields differ: different field types: "
4957 "field-name=\"%s\", field-a-ft-addr=%p, field-b-ft-addr=%p",
4958 g_quark_to_string(field_a
->name
),
4959 field_a
->type
, field_b
->type
);
4967 int bt_ctf_field_type_structure_compare(struct bt_ctf_field_type
*type_a
,
4968 struct bt_ctf_field_type
*type_b
)
4972 struct bt_ctf_field_type_structure
*struct_a
;
4973 struct bt_ctf_field_type_structure
*struct_b
;
4975 struct_a
= container_of(type_a
,
4976 struct bt_ctf_field_type_structure
, parent
);
4977 struct_b
= container_of(type_b
,
4978 struct bt_ctf_field_type_structure
, parent
);
4981 if (bt_ctf_field_type_get_alignment(type_a
) !=
4982 bt_ctf_field_type_get_alignment(type_b
)) {
4983 BT_LOGV("Structure field types differ: different alignments: "
4984 "ft-a-align=%u, ft-b-align=%u",
4985 bt_ctf_field_type_get_alignment(type_a
),
4986 bt_ctf_field_type_get_alignment(type_b
));
4991 if (struct_a
->fields
->len
!= struct_b
->fields
->len
) {
4992 BT_LOGV("Structure field types differ: different field counts: "
4993 "ft-a-field-count=%u, ft-b-field-count=%u",
4994 struct_a
->fields
->len
, struct_b
->fields
->len
);
4998 for (i
= 0; i
< struct_a
->fields
->len
; ++i
) {
4999 struct structure_field
*field_a
=
5000 g_ptr_array_index(struct_a
->fields
, i
);
5001 struct structure_field
*field_b
=
5002 g_ptr_array_index(struct_b
->fields
, i
);
5004 ret
= compare_structure_fields(field_a
, field_b
);
5006 /* compare_structure_fields() logs what differs */
5007 BT_LOGV_STR("Structure field types differ: different fields.");
5020 int bt_ctf_field_type_variant_compare(struct bt_ctf_field_type
*type_a
,
5021 struct bt_ctf_field_type
*type_b
)
5025 struct bt_ctf_field_type_variant
*variant_a
;
5026 struct bt_ctf_field_type_variant
*variant_b
;
5028 variant_a
= container_of(type_a
,
5029 struct bt_ctf_field_type_variant
, parent
);
5030 variant_b
= container_of(type_b
,
5031 struct bt_ctf_field_type_variant
, parent
);
5034 if (strcmp(variant_a
->tag_name
->str
, variant_b
->tag_name
->str
)) {
5035 BT_LOGV("Variant field types differ: different tag field names: "
5036 "ft-a-tag-field-name=\"%s\", ft-b-tag-field-name=\"%s\"",
5037 variant_a
->tag_name
->str
, variant_b
->tag_name
->str
);
5042 ret
= bt_ctf_field_type_compare(
5043 (struct bt_ctf_field_type
*) variant_a
->tag
,
5044 (struct bt_ctf_field_type
*) variant_b
->tag
);
5046 BT_LOGV("Variant field types differ: different tag field types: "
5047 "ft-a-tag-ft-addr=%p, ft-b-tag-ft-addr=%p",
5048 variant_a
->tag
, variant_b
->tag
);
5055 if (variant_a
->fields
->len
!= variant_b
->fields
->len
) {
5056 BT_LOGV("Structure field types differ: different field counts: "
5057 "ft-a-field-count=%u, ft-b-field-count=%u",
5058 variant_a
->fields
->len
, variant_b
->fields
->len
);
5062 for (i
= 0; i
< variant_a
->fields
->len
; ++i
) {
5063 struct structure_field
*field_a
=
5064 g_ptr_array_index(variant_a
->fields
, i
);
5065 struct structure_field
*field_b
=
5066 g_ptr_array_index(variant_b
->fields
, i
);
5068 ret
= compare_structure_fields(field_a
, field_b
);
5070 /* compare_structure_fields() logs what differs */
5071 BT_LOGV_STR("Variant field types differ: different fields.");
5084 int bt_ctf_field_type_array_compare(struct bt_ctf_field_type
*type_a
,
5085 struct bt_ctf_field_type
*type_b
)
5088 struct bt_ctf_field_type_array
*array_a
;
5089 struct bt_ctf_field_type_array
*array_b
;
5091 array_a
= container_of(type_a
,
5092 struct bt_ctf_field_type_array
, parent
);
5093 array_b
= container_of(type_b
,
5094 struct bt_ctf_field_type_array
, parent
);
5097 if (array_a
->length
!= array_b
->length
) {
5098 BT_LOGV("Structure field types differ: different lengths: "
5099 "ft-a-length=%u, ft-b-length=%u",
5100 array_a
->length
, array_b
->length
);
5105 ret
= bt_ctf_field_type_compare(array_a
->element_type
,
5106 array_b
->element_type
);
5108 BT_LOGV("Array field types differ: different element field types: "
5109 "ft-a-element-ft-addr=%p, ft-b-element-ft-addr=%p",
5110 array_a
->element_type
, array_b
->element_type
);
5118 int bt_ctf_field_type_sequence_compare(struct bt_ctf_field_type
*type_a
,
5119 struct bt_ctf_field_type
*type_b
)
5122 struct bt_ctf_field_type_sequence
*sequence_a
;
5123 struct bt_ctf_field_type_sequence
*sequence_b
;
5125 sequence_a
= container_of(type_a
,
5126 struct bt_ctf_field_type_sequence
, parent
);
5127 sequence_b
= container_of(type_b
,
5128 struct bt_ctf_field_type_sequence
, parent
);
5131 if (strcmp(sequence_a
->length_field_name
->str
,
5132 sequence_b
->length_field_name
->str
)) {
5133 BT_LOGV("Sequence field types differ: different length field names: "
5134 "ft-a-length-field-name=\"%s\", "
5135 "ft-b-length-field-name=\"%s\"",
5136 sequence_a
->length_field_name
->str
,
5137 sequence_b
->length_field_name
->str
);
5142 ret
= bt_ctf_field_type_compare(sequence_a
->element_type
,
5143 sequence_b
->element_type
);
5145 BT_LOGV("Sequence field types differ: different element field types: "
5146 "ft-a-element-ft-addr=%p, ft-b-element-ft-addr=%p",
5147 sequence_a
->element_type
, sequence_b
->element_type
);
5154 int bt_ctf_field_type_compare(struct bt_ctf_field_type
*type_a
,
5155 struct bt_ctf_field_type
*type_b
)
5159 if (type_a
== type_b
) {
5160 /* Same reference: equal (even if both are NULL) */
5166 BT_LOGW_STR("Invalid parameter: field type A is NULL.");
5172 BT_LOGW_STR("Invalid parameter: field type B is NULL.");
5177 if (type_a
->id
!= type_b
->id
) {
5178 /* Different type IDs */
5179 BT_LOGV("Field types differ: different IDs: "
5180 "ft-a-addr=%p, ft-b-addr=%p, "
5181 "ft-a-id=%s, ft-b-id=%s",
5183 bt_ctf_field_type_id_string(type_a
->id
),
5184 bt_ctf_field_type_id_string(type_b
->id
));
5188 if (type_a
->id
== BT_CTF_FIELD_TYPE_ID_UNKNOWN
) {
5189 /* Both have unknown type IDs */
5190 BT_LOGW_STR("Invalid parameter: field type IDs are unknown.");
5194 ret
= type_compare_funcs
[type_a
->id
](type_a
, type_b
);
5196 BT_LOGV("Field types differ: ft-a-addr=%p, ft-b-addr=%p",
5205 int64_t bt_ctf_field_type_get_field_count(struct bt_ctf_field_type
*field_type
)
5207 int64_t field_count
= -1;
5208 enum bt_ctf_field_type_id type_id
= bt_ctf_field_type_get_type_id(field_type
);
5211 case CTF_TYPE_STRUCT
:
5213 bt_ctf_field_type_structure_get_field_count(field_type
);
5215 case CTF_TYPE_VARIANT
:
5217 bt_ctf_field_type_variant_get_field_count(field_type
);
5219 case CTF_TYPE_ARRAY
:
5220 case CTF_TYPE_SEQUENCE
:
5222 * Array and sequence types always contain a single member
5223 * (the element type).
5235 struct bt_ctf_field_type
*bt_ctf_field_type_get_field_at_index(
5236 struct bt_ctf_field_type
*field_type
, int index
)
5238 struct bt_ctf_field_type
*field
= NULL
;
5239 enum bt_ctf_field_type_id type_id
= bt_ctf_field_type_get_type_id(field_type
);
5242 case CTF_TYPE_STRUCT
:
5244 int ret
= bt_ctf_field_type_structure_get_field_by_index(
5245 field_type
, NULL
, &field
, index
);
5252 case CTF_TYPE_VARIANT
:
5254 int ret
= bt_ctf_field_type_variant_get_field_by_index(
5255 field_type
, NULL
, &field
, index
);
5262 case CTF_TYPE_ARRAY
:
5263 field
= bt_ctf_field_type_array_get_element_type(field_type
);
5265 case CTF_TYPE_SEQUENCE
:
5266 field
= bt_ctf_field_type_sequence_get_element_type(field_type
);
5276 int bt_ctf_field_type_get_field_index(struct bt_ctf_field_type
*field_type
,
5279 int field_index
= -1;
5280 enum bt_ctf_field_type_id type_id
= bt_ctf_field_type_get_type_id(field_type
);
5283 case CTF_TYPE_STRUCT
:
5284 field_index
= bt_ctf_field_type_structure_get_field_name_index(
5287 case CTF_TYPE_VARIANT
:
5288 field_index
= bt_ctf_field_type_variant_get_field_name_index(
5298 struct bt_ctf_field_path
*bt_ctf_field_type_variant_get_tag_field_path(
5299 struct bt_ctf_field_type
*type
)
5301 struct bt_ctf_field_path
*field_path
= NULL
;
5302 struct bt_ctf_field_type_variant
*variant
;
5305 BT_LOGW_STR("Invalid parameter: field type is NULL.");
5309 if (!bt_ctf_field_type_is_variant(type
)) {
5310 BT_LOGW("Invalid parameter: field type is not a variant field type: "
5311 "addr=%p, ft-id=%s", type
,
5312 bt_ctf_field_type_id_string(type
->id
));
5316 variant
= container_of(type
, struct bt_ctf_field_type_variant
,
5318 field_path
= bt_get(variant
->tag_field_path
);
5323 struct bt_ctf_field_path
*bt_ctf_field_type_sequence_get_length_field_path(
5324 struct bt_ctf_field_type
*type
)
5326 struct bt_ctf_field_path
*field_path
= NULL
;
5327 struct bt_ctf_field_type_sequence
*sequence
;
5330 BT_LOGW_STR("Invalid parameter: field type is NULL.");
5334 if (!bt_ctf_field_type_is_sequence(type
)) {
5335 BT_LOGW("Invalid parameter: field type is not a sequence field type: "
5336 "addr=%p, ft-id=%s", type
,
5337 bt_ctf_field_type_id_string(type
->id
));
5341 sequence
= container_of(type
, struct bt_ctf_field_type_sequence
,
5343 field_path
= bt_get(sequence
->length_field_path
);