4 * Babeltrace CTF IR - Event Types
6 * Copyright 2013, 2014 Jérémie Galarneau <jeremie.galarneau@efficios.com>
8 * Author: Jérémie Galarneau <jeremie.galarneau@efficios.com>
10 * Permission is hereby granted, free of charge, to any person obtaining a copy
11 * of this software and associated documentation files (the "Software"), to deal
12 * in the Software without restriction, including without limitation the rights
13 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
14 * copies of the Software, and to permit persons to whom the Software is
15 * furnished to do so, subject to the following conditions:
17 * The above copyright notice and this permission notice shall be included in
18 * all copies or substantial portions of the Software.
20 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
21 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
22 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
23 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
24 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
25 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
29 #define BT_LOG_TAG "FIELD-TYPES"
30 #include <babeltrace/lib-logging-internal.h>
32 #include <babeltrace/ctf-ir/field-types-internal.h>
33 #include <babeltrace/ctf-ir/field-path-internal.h>
34 #include <babeltrace/ctf-ir/utils.h>
35 #include <babeltrace/ref.h>
36 #include <babeltrace/ctf-ir/clock-class.h>
37 #include <babeltrace/ctf-ir/clock-class-internal.h>
38 #include <babeltrace/ctf-writer/writer-internal.h>
39 #include <babeltrace/object-internal.h>
40 #include <babeltrace/ref.h>
41 #include <babeltrace/compiler-internal.h>
42 #include <babeltrace/endian-internal.h>
47 struct range_overlap_query
{
62 void bt_ctf_field_type_destroy(struct bt_object
*);
64 void bt_ctf_field_type_integer_destroy(struct bt_ctf_field_type
*);
66 void bt_ctf_field_type_enumeration_destroy(struct bt_ctf_field_type
*);
68 void bt_ctf_field_type_floating_point_destroy(struct bt_ctf_field_type
*);
70 void bt_ctf_field_type_structure_destroy(struct bt_ctf_field_type
*);
72 void bt_ctf_field_type_variant_destroy(struct bt_ctf_field_type
*);
74 void bt_ctf_field_type_array_destroy(struct bt_ctf_field_type
*);
76 void bt_ctf_field_type_sequence_destroy(struct bt_ctf_field_type
*);
78 void bt_ctf_field_type_string_destroy(struct bt_ctf_field_type
*);
81 void (* const type_destroy_funcs
[])(struct bt_ctf_field_type
*) = {
82 [BT_CTF_FIELD_TYPE_ID_INTEGER
] = bt_ctf_field_type_integer_destroy
,
83 [BT_CTF_FIELD_TYPE_ID_ENUM
] =
84 bt_ctf_field_type_enumeration_destroy
,
85 [BT_CTF_FIELD_TYPE_ID_FLOAT
] =
86 bt_ctf_field_type_floating_point_destroy
,
87 [BT_CTF_FIELD_TYPE_ID_STRUCT
] = bt_ctf_field_type_structure_destroy
,
88 [BT_CTF_FIELD_TYPE_ID_VARIANT
] = bt_ctf_field_type_variant_destroy
,
89 [BT_CTF_FIELD_TYPE_ID_ARRAY
] = bt_ctf_field_type_array_destroy
,
90 [BT_CTF_FIELD_TYPE_ID_SEQUENCE
] = bt_ctf_field_type_sequence_destroy
,
91 [BT_CTF_FIELD_TYPE_ID_STRING
] = bt_ctf_field_type_string_destroy
,
95 void generic_field_type_freeze(struct bt_ctf_field_type
*);
97 void bt_ctf_field_type_integer_freeze(struct bt_ctf_field_type
*);
99 void bt_ctf_field_type_enumeration_freeze(struct bt_ctf_field_type
*);
101 void bt_ctf_field_type_structure_freeze(struct bt_ctf_field_type
*);
103 void bt_ctf_field_type_variant_freeze(struct bt_ctf_field_type
*);
105 void bt_ctf_field_type_array_freeze(struct bt_ctf_field_type
*);
107 void bt_ctf_field_type_sequence_freeze(struct bt_ctf_field_type
*);
110 type_freeze_func
const type_freeze_funcs
[] = {
111 [BT_CTF_FIELD_TYPE_ID_INTEGER
] = bt_ctf_field_type_integer_freeze
,
112 [BT_CTF_FIELD_TYPE_ID_ENUM
] = bt_ctf_field_type_enumeration_freeze
,
113 [BT_CTF_FIELD_TYPE_ID_FLOAT
] = generic_field_type_freeze
,
114 [BT_CTF_FIELD_TYPE_ID_STRUCT
] = bt_ctf_field_type_structure_freeze
,
115 [BT_CTF_FIELD_TYPE_ID_VARIANT
] = bt_ctf_field_type_variant_freeze
,
116 [BT_CTF_FIELD_TYPE_ID_ARRAY
] = bt_ctf_field_type_array_freeze
,
117 [BT_CTF_FIELD_TYPE_ID_SEQUENCE
] = bt_ctf_field_type_sequence_freeze
,
118 [BT_CTF_FIELD_TYPE_ID_STRING
] = generic_field_type_freeze
,
122 int bt_ctf_field_type_integer_serialize(struct bt_ctf_field_type
*,
123 struct metadata_context
*);
125 int bt_ctf_field_type_enumeration_serialize(struct bt_ctf_field_type
*,
126 struct metadata_context
*);
128 int bt_ctf_field_type_floating_point_serialize(
129 struct bt_ctf_field_type
*, struct metadata_context
*);
131 int bt_ctf_field_type_structure_serialize(struct bt_ctf_field_type
*,
132 struct metadata_context
*);
134 int bt_ctf_field_type_variant_serialize(struct bt_ctf_field_type
*,
135 struct metadata_context
*);
137 int bt_ctf_field_type_array_serialize(struct bt_ctf_field_type
*,
138 struct metadata_context
*);
140 int bt_ctf_field_type_sequence_serialize(struct bt_ctf_field_type
*,
141 struct metadata_context
*);
143 int bt_ctf_field_type_string_serialize(struct bt_ctf_field_type
*,
144 struct metadata_context
*);
147 type_serialize_func
const type_serialize_funcs
[] = {
148 [BT_CTF_FIELD_TYPE_ID_INTEGER
] = bt_ctf_field_type_integer_serialize
,
149 [BT_CTF_FIELD_TYPE_ID_ENUM
] =
150 bt_ctf_field_type_enumeration_serialize
,
151 [BT_CTF_FIELD_TYPE_ID_FLOAT
] =
152 bt_ctf_field_type_floating_point_serialize
,
153 [BT_CTF_FIELD_TYPE_ID_STRUCT
] =
154 bt_ctf_field_type_structure_serialize
,
155 [BT_CTF_FIELD_TYPE_ID_VARIANT
] = bt_ctf_field_type_variant_serialize
,
156 [BT_CTF_FIELD_TYPE_ID_ARRAY
] = bt_ctf_field_type_array_serialize
,
157 [BT_CTF_FIELD_TYPE_ID_SEQUENCE
] = bt_ctf_field_type_sequence_serialize
,
158 [BT_CTF_FIELD_TYPE_ID_STRING
] = bt_ctf_field_type_string_serialize
,
162 void bt_ctf_field_type_integer_set_byte_order(struct bt_ctf_field_type
*,
163 enum bt_ctf_byte_order byte_order
);
165 void bt_ctf_field_type_enumeration_set_byte_order(struct bt_ctf_field_type
*,
166 enum bt_ctf_byte_order byte_order
);
168 void bt_ctf_field_type_floating_point_set_byte_order(
169 struct bt_ctf_field_type
*, enum bt_ctf_byte_order byte_order
);
171 void bt_ctf_field_type_structure_set_byte_order(struct bt_ctf_field_type
*,
172 enum bt_ctf_byte_order byte_order
);
174 void bt_ctf_field_type_variant_set_byte_order(struct bt_ctf_field_type
*,
175 enum bt_ctf_byte_order byte_order
);
177 void bt_ctf_field_type_array_set_byte_order(struct bt_ctf_field_type
*,
178 enum bt_ctf_byte_order byte_order
);
180 void bt_ctf_field_type_sequence_set_byte_order(struct bt_ctf_field_type
*,
181 enum bt_ctf_byte_order byte_order
);
184 void (* const set_byte_order_funcs
[])(struct bt_ctf_field_type
*,
185 enum bt_ctf_byte_order
) = {
186 [BT_CTF_FIELD_TYPE_ID_INTEGER
] = bt_ctf_field_type_integer_set_byte_order
,
187 [BT_CTF_FIELD_TYPE_ID_ENUM
] =
188 bt_ctf_field_type_enumeration_set_byte_order
,
189 [BT_CTF_FIELD_TYPE_ID_FLOAT
] =
190 bt_ctf_field_type_floating_point_set_byte_order
,
191 [BT_CTF_FIELD_TYPE_ID_STRUCT
] =
192 bt_ctf_field_type_structure_set_byte_order
,
193 [BT_CTF_FIELD_TYPE_ID_VARIANT
] = bt_ctf_field_type_variant_set_byte_order
,
194 [BT_CTF_FIELD_TYPE_ID_ARRAY
] = bt_ctf_field_type_array_set_byte_order
,
195 [BT_CTF_FIELD_TYPE_ID_SEQUENCE
] = bt_ctf_field_type_sequence_set_byte_order
,
196 [BT_CTF_FIELD_TYPE_ID_STRING
] = NULL
,
200 struct bt_ctf_field_type
*bt_ctf_field_type_integer_copy(
201 struct bt_ctf_field_type
*);
203 struct bt_ctf_field_type
*bt_ctf_field_type_enumeration_copy(
204 struct bt_ctf_field_type
*);
206 struct bt_ctf_field_type
*bt_ctf_field_type_floating_point_copy(
207 struct bt_ctf_field_type
*);
209 struct bt_ctf_field_type
*bt_ctf_field_type_structure_copy(
210 struct bt_ctf_field_type
*);
212 struct bt_ctf_field_type
*bt_ctf_field_type_variant_copy(
213 struct bt_ctf_field_type
*);
215 struct bt_ctf_field_type
*bt_ctf_field_type_array_copy(
216 struct bt_ctf_field_type
*);
218 struct bt_ctf_field_type
*bt_ctf_field_type_sequence_copy(
219 struct bt_ctf_field_type
*);
221 struct bt_ctf_field_type
*bt_ctf_field_type_string_copy(
222 struct bt_ctf_field_type
*);
225 struct bt_ctf_field_type
*(* const type_copy_funcs
[])(
226 struct bt_ctf_field_type
*) = {
227 [BT_CTF_FIELD_TYPE_ID_INTEGER
] = bt_ctf_field_type_integer_copy
,
228 [BT_CTF_FIELD_TYPE_ID_ENUM
] = bt_ctf_field_type_enumeration_copy
,
229 [BT_CTF_FIELD_TYPE_ID_FLOAT
] = bt_ctf_field_type_floating_point_copy
,
230 [BT_CTF_FIELD_TYPE_ID_STRUCT
] = bt_ctf_field_type_structure_copy
,
231 [BT_CTF_FIELD_TYPE_ID_VARIANT
] = bt_ctf_field_type_variant_copy
,
232 [BT_CTF_FIELD_TYPE_ID_ARRAY
] = bt_ctf_field_type_array_copy
,
233 [BT_CTF_FIELD_TYPE_ID_SEQUENCE
] = bt_ctf_field_type_sequence_copy
,
234 [BT_CTF_FIELD_TYPE_ID_STRING
] = bt_ctf_field_type_string_copy
,
238 int bt_ctf_field_type_integer_compare(struct bt_ctf_field_type
*,
239 struct bt_ctf_field_type
*);
241 int bt_ctf_field_type_floating_point_compare(struct bt_ctf_field_type
*,
242 struct bt_ctf_field_type
*);
244 int bt_ctf_field_type_enumeration_compare(struct bt_ctf_field_type
*,
245 struct bt_ctf_field_type
*);
247 int bt_ctf_field_type_string_compare(struct bt_ctf_field_type
*,
248 struct bt_ctf_field_type
*);
250 int bt_ctf_field_type_structure_compare(struct bt_ctf_field_type
*,
251 struct bt_ctf_field_type
*);
253 int bt_ctf_field_type_variant_compare(struct bt_ctf_field_type
*,
254 struct bt_ctf_field_type
*);
256 int bt_ctf_field_type_array_compare(struct bt_ctf_field_type
*,
257 struct bt_ctf_field_type
*);
259 int bt_ctf_field_type_sequence_compare(struct bt_ctf_field_type
*,
260 struct bt_ctf_field_type
*);
263 int (* const type_compare_funcs
[])(struct bt_ctf_field_type
*,
264 struct bt_ctf_field_type
*) = {
265 [BT_CTF_FIELD_TYPE_ID_INTEGER
] = bt_ctf_field_type_integer_compare
,
266 [BT_CTF_FIELD_TYPE_ID_ENUM
] = bt_ctf_field_type_enumeration_compare
,
267 [BT_CTF_FIELD_TYPE_ID_FLOAT
] = bt_ctf_field_type_floating_point_compare
,
268 [BT_CTF_FIELD_TYPE_ID_STRUCT
] = bt_ctf_field_type_structure_compare
,
269 [BT_CTF_FIELD_TYPE_ID_VARIANT
] = bt_ctf_field_type_variant_compare
,
270 [BT_CTF_FIELD_TYPE_ID_ARRAY
] = bt_ctf_field_type_array_compare
,
271 [BT_CTF_FIELD_TYPE_ID_SEQUENCE
] = bt_ctf_field_type_sequence_compare
,
272 [BT_CTF_FIELD_TYPE_ID_STRING
] = bt_ctf_field_type_string_compare
,
276 int bt_ctf_field_type_integer_validate(struct bt_ctf_field_type
*);
278 int bt_ctf_field_type_enumeration_validate(struct bt_ctf_field_type
*);
280 int bt_ctf_field_type_structure_validate(struct bt_ctf_field_type
*);
282 int bt_ctf_field_type_variant_validate(struct bt_ctf_field_type
*);
284 int bt_ctf_field_type_array_validate(struct bt_ctf_field_type
*);
286 int bt_ctf_field_type_sequence_validate(struct bt_ctf_field_type
*);
289 int (* const type_validate_funcs
[])(struct bt_ctf_field_type
*) = {
290 [BT_CTF_FIELD_TYPE_ID_INTEGER
] = bt_ctf_field_type_integer_validate
,
291 [BT_CTF_FIELD_TYPE_ID_FLOAT
] = NULL
,
292 [BT_CTF_FIELD_TYPE_ID_STRING
] = NULL
,
293 [BT_CTF_FIELD_TYPE_ID_ENUM
] = bt_ctf_field_type_enumeration_validate
,
294 [BT_CTF_FIELD_TYPE_ID_STRUCT
] = bt_ctf_field_type_structure_validate
,
295 [BT_CTF_FIELD_TYPE_ID_VARIANT
] = bt_ctf_field_type_variant_validate
,
296 [BT_CTF_FIELD_TYPE_ID_ARRAY
] = bt_ctf_field_type_array_validate
,
297 [BT_CTF_FIELD_TYPE_ID_SEQUENCE
] = bt_ctf_field_type_sequence_validate
,
301 void destroy_enumeration_mapping(struct enumeration_mapping
*mapping
)
307 void destroy_structure_field(struct structure_field
*field
)
313 BT_LOGD("Destroying structure/variant field type's field object: "
314 "addr=%p, field-ft-addr=%p, field-name=\"%s\"",
315 field
, field
->type
, g_quark_to_string(field
->name
));
316 BT_LOGD_STR("Putting field type.");
322 void check_ranges_overlap(gpointer element
, gpointer query
)
324 struct enumeration_mapping
*mapping
= element
;
325 struct range_overlap_query
*overlap_query
= query
;
327 if (mapping
->range_start
._signed
<= overlap_query
->range_end
._signed
328 && overlap_query
->range_start
._signed
<=
329 mapping
->range_end
._signed
) {
330 overlap_query
->overlaps
= 1;
331 overlap_query
->mapping_name
= mapping
->string
;
334 overlap_query
->overlaps
|=
335 mapping
->string
== overlap_query
->mapping_name
;
337 if (overlap_query
->overlaps
) {
338 BT_LOGV("Overlapping enumeration field type mappings: "
339 "mapping-name=\"%s\", "
340 "mapping-a-range-start=%" PRId64
", "
341 "mapping-a-range-end=%" PRId64
", "
342 "mapping-b-range-start=%" PRId64
", "
343 "mapping-b-range-end=%" PRId64
,
344 g_quark_to_string(mapping
->string
),
345 mapping
->range_start
._signed
,
346 mapping
->range_end
._signed
,
347 overlap_query
->range_start
._signed
,
348 overlap_query
->range_end
._signed
);
353 void check_ranges_overlap_unsigned(gpointer element
, gpointer query
)
355 struct enumeration_mapping
*mapping
= element
;
356 struct range_overlap_query
*overlap_query
= query
;
358 if (mapping
->range_start
._unsigned
<= overlap_query
->range_end
._unsigned
359 && overlap_query
->range_start
._unsigned
<=
360 mapping
->range_end
._unsigned
) {
361 overlap_query
->overlaps
= 1;
362 overlap_query
->mapping_name
= mapping
->string
;
365 overlap_query
->overlaps
|=
366 mapping
->string
== overlap_query
->mapping_name
;
368 if (overlap_query
->overlaps
) {
369 BT_LOGW("Overlapping enumeration field type mappings: "
370 "mapping-name=\"%s\", "
371 "mapping-a-range-start=%" PRIu64
", "
372 "mapping-a-range-end=%" PRIu64
", "
373 "mapping-b-range-start=%" PRIu64
", "
374 "mapping-b-range-end=%" PRIu64
,
375 g_quark_to_string(mapping
->string
),
376 mapping
->range_start
._unsigned
,
377 mapping
->range_end
._unsigned
,
378 overlap_query
->range_start
._unsigned
,
379 overlap_query
->range_end
._unsigned
);
384 gint
compare_enumeration_mappings_signed(struct enumeration_mapping
**a
,
385 struct enumeration_mapping
**b
)
387 return ((*a
)->range_start
._signed
< (*b
)->range_start
._signed
) ? -1 : 1;
391 gint
compare_enumeration_mappings_unsigned(struct enumeration_mapping
**a
,
392 struct enumeration_mapping
**b
)
394 return ((*a
)->range_start
._unsigned
< (*b
)->range_start
._unsigned
) ? -1 : 1;
398 void bt_ctf_field_type_init(struct bt_ctf_field_type
*type
, bt_bool init_bo
)
400 assert(type
&& (type
->id
> BT_CTF_FIELD_TYPE_ID_UNKNOWN
) &&
401 (type
->id
< BT_CTF_NR_TYPE_IDS
));
403 bt_object_init(type
, bt_ctf_field_type_destroy
);
404 type
->freeze
= type_freeze_funcs
[type
->id
];
405 type
->serialize
= type_serialize_funcs
[type
->id
];
409 const enum bt_ctf_byte_order bo
= BT_CTF_BYTE_ORDER_NATIVE
;
411 BT_LOGD("Setting initial field type's byte order: bo=%s",
412 bt_ctf_byte_order_string(bo
));
413 ret
= bt_ctf_field_type_set_byte_order(type
, bo
);
421 int add_structure_field(GPtrArray
*fields
,
422 GHashTable
*field_name_to_index
,
423 struct bt_ctf_field_type
*field_type
,
424 const char *field_name
)
427 GQuark name_quark
= g_quark_from_string(field_name
);
428 struct structure_field
*field
;
430 /* Make sure structure does not contain a field of the same name */
431 if (g_hash_table_lookup_extended(field_name_to_index
,
432 GUINT_TO_POINTER(name_quark
), NULL
, NULL
)) {
433 BT_LOGW("Structure or variant field type already contains a field type with this name: "
434 "field-name=\"%s\"", field_name
);
439 field
= g_new0(struct structure_field
, 1);
441 BT_LOGE_STR("Failed to allocate one structure/variant field type field.");
447 field
->name
= name_quark
;
448 field
->type
= field_type
;
449 g_hash_table_insert(field_name_to_index
,
450 GUINT_TO_POINTER(name_quark
),
451 GUINT_TO_POINTER(fields
->len
));
452 g_ptr_array_add(fields
, field
);
453 BT_LOGV("Added structure/variant field type field: field-ft-addr=%p, "
454 "field-name=\"%s\"", field_type
, field_name
);
460 void bt_ctf_field_type_destroy(struct bt_object
*obj
)
462 struct bt_ctf_field_type
*type
;
463 enum bt_ctf_field_type_id type_id
;
465 type
= container_of(obj
, struct bt_ctf_field_type
, base
);
467 assert(type_id
> BT_CTF_FIELD_TYPE_ID_UNKNOWN
&&
468 type_id
< BT_CTF_NR_TYPE_IDS
);
469 type_destroy_funcs
[type_id
](type
);
473 int bt_ctf_field_type_integer_validate(struct bt_ctf_field_type
*type
)
477 struct bt_ctf_field_type_integer
*integer
=
478 container_of(type
, struct bt_ctf_field_type_integer
,
481 if (integer
->mapped_clock
&& integer
->is_signed
) {
482 BT_LOGW("Invalid integer field type: cannot be signed and have a mapped clock class: "
483 "ft-addr=%p, clock-class-addr=%p, clock-class-name=\"%s\"",
484 type
, integer
->mapped_clock
,
485 bt_ctf_clock_class_get_name(integer
->mapped_clock
));
495 struct enumeration_mapping
*get_enumeration_mapping(
496 struct bt_ctf_field_type
*type
, uint64_t index
)
498 struct enumeration_mapping
*mapping
= NULL
;
499 struct bt_ctf_field_type_enumeration
*enumeration
;
501 enumeration
= container_of(type
, struct bt_ctf_field_type_enumeration
,
503 if (index
>= enumeration
->entries
->len
) {
504 BT_LOGW("Invalid parameter: index is out of bounds: "
505 "addr=%p, index=%" PRIu64
", count=%u",
506 type
, index
, enumeration
->entries
->len
);
510 mapping
= g_ptr_array_index(enumeration
->entries
, index
);
516 * Note: This algorithm is O(n^2) vs number of enumeration mappings.
517 * Only used when freezing an enumeration.
520 void set_enumeration_range_overlap(
521 struct bt_ctf_field_type
*type
)
524 struct bt_ctf_field_type
*container_type
;
525 struct bt_ctf_field_type_enumeration
*enumeration_type
;
528 BT_LOGV("Setting enumeration field type's overlap flag: addr=%p",
530 enumeration_type
= container_of(type
,
531 struct bt_ctf_field_type_enumeration
, parent
);
533 len
= enumeration_type
->entries
->len
;
534 container_type
= enumeration_type
->container
;
535 is_signed
= bt_ctf_field_type_integer_get_signed(container_type
);
537 for (i
= 0; i
< len
; i
++) {
538 for (j
= i
+ 1; j
< len
; j
++) {
539 struct enumeration_mapping
*mapping
[2];
541 mapping
[0] = get_enumeration_mapping(type
, i
);
542 mapping
[1] = get_enumeration_mapping(type
, j
);
544 if (mapping
[0]->range_start
._signed
545 <= mapping
[1]->range_end
._signed
546 && mapping
[0]->range_end
._signed
547 >= mapping
[1]->range_start
._signed
) {
548 enumeration_type
->has_overlapping_ranges
= BT_TRUE
;
552 if (mapping
[0]->range_start
._unsigned
553 <= mapping
[1]->range_end
._unsigned
554 && mapping
[0]->range_end
._unsigned
555 >= mapping
[1]->range_start
._unsigned
) {
556 enumeration_type
->has_overlapping_ranges
= BT_TRUE
;
564 if (enumeration_type
->has_overlapping_ranges
) {
565 BT_LOGV_STR("Enumeration field type has overlapping ranges.");
567 BT_LOGV_STR("Enumeration field type has no overlapping ranges.");
572 int bt_ctf_field_type_enumeration_validate(struct bt_ctf_field_type
*type
)
576 struct bt_ctf_field_type_enumeration
*enumeration
=
577 container_of(type
, struct bt_ctf_field_type_enumeration
,
579 struct bt_ctf_field_type
*container_type
=
580 bt_ctf_field_type_enumeration_get_container_type(type
);
582 assert(container_type
);
583 ret
= bt_ctf_field_type_validate(container_type
);
585 BT_LOGW("Invalid enumeration field type: container type is invalid: "
586 "enum-ft-addr=%p, int-ft-addr=%p",
587 type
, container_type
);
591 /* Ensure enum has entries */
592 if (enumeration
->entries
->len
== 0) {
593 BT_LOGW("Invalid enumeration field type: no entries: "
600 BT_PUT(container_type
);
605 int bt_ctf_field_type_sequence_validate(struct bt_ctf_field_type
*type
)
608 struct bt_ctf_field_type
*element_type
= NULL
;
609 struct bt_ctf_field_type_sequence
*sequence
=
610 container_of(type
, struct bt_ctf_field_type_sequence
,
613 /* Length field name should be set at this point */
614 if (sequence
->length_field_name
->len
== 0) {
615 BT_LOGW("Invalid sequence field type: no length field name: "
621 element_type
= bt_ctf_field_type_sequence_get_element_type(type
);
622 assert(element_type
);
623 ret
= bt_ctf_field_type_validate(element_type
);
625 BT_LOGW("Invalid sequence field type: invalid element field type: "
626 "seq-ft-addr=%p, element-ft-add=%p",
631 BT_PUT(element_type
);
637 int bt_ctf_field_type_array_validate(struct bt_ctf_field_type
*type
)
640 struct bt_ctf_field_type
*element_type
= NULL
;
642 element_type
= bt_ctf_field_type_array_get_element_type(type
);
643 assert(element_type
);
644 ret
= bt_ctf_field_type_validate(element_type
);
646 BT_LOGW("Invalid array field type: invalid element field type: "
647 "array-ft-addr=%p, element-ft-add=%p",
651 BT_PUT(element_type
);
656 int bt_ctf_field_type_structure_validate(struct bt_ctf_field_type
*type
)
659 struct bt_ctf_field_type
*child_type
= NULL
;
660 int64_t field_count
= bt_ctf_field_type_structure_get_field_count(type
);
663 assert(field_count
>= 0);
665 for (i
= 0; i
< field_count
; ++i
) {
666 const char *field_name
;
668 ret
= bt_ctf_field_type_structure_get_field_by_index(type
,
669 &field_name
, &child_type
, i
);
671 ret
= bt_ctf_field_type_validate(child_type
);
673 BT_LOGW("Invalid structure field type: "
674 "a contained field type is invalid: "
675 "struct-ft-addr=%p, field-ft-addr=%p, "
676 "field-name=\"%s\", field-index=%" PRId64
,
677 type
, child_type
, field_name
, i
);
691 bt_bool
bt_ctf_field_type_enumeration_has_overlapping_ranges(
692 struct bt_ctf_field_type_enumeration
*enumeration_type
)
694 if (!enumeration_type
->parent
.frozen
) {
695 set_enumeration_range_overlap(&enumeration_type
->parent
);
697 return enumeration_type
->has_overlapping_ranges
;
701 int bt_ctf_field_type_enumeration_get_mapping_name(
702 struct bt_ctf_field_type
*enum_field_type
,
704 const char **mapping_name
)
707 struct enumeration_mapping
*mapping
;
709 assert(enum_field_type
);
710 mapping
= get_enumeration_mapping(enum_field_type
, index
);
713 *mapping_name
= g_quark_to_string(mapping
->string
);
720 int bt_ctf_field_type_variant_validate(struct bt_ctf_field_type
*type
)
724 struct bt_ctf_field_type
*child_type
= NULL
;
725 struct bt_ctf_field_type_variant
*variant
=
726 container_of(type
, struct bt_ctf_field_type_variant
,
729 int64_t tag_mappings_count
;
731 if (variant
->tag_name
->len
== 0) {
732 BT_LOGW("Invalid variant field type: no tag field name: "
739 BT_LOGW("Invalid variant field type: no tag field type: "
740 "addr=%p, tag-field-name=\"%s\"", type
,
741 variant
->tag_name
->str
);
746 if (bt_ctf_field_type_enumeration_has_overlapping_ranges(
748 BT_LOGW("Invalid variant field type: enumeration tag field type has overlapping ranges: "
749 "variant-ft-addr=%p, tag-field-name=\"%s\", "
750 "enum-ft-addr=%p", type
, variant
->tag_name
->str
,
757 bt_ctf_field_type_enumeration_get_mapping_count(
758 (struct bt_ctf_field_type
*) variant
->tag
);
759 assert(tag_mappings_count
>= 0);
762 * Validate that each mapping found in the tag has a name which
763 * is also the name of a field in this variant field type.
765 * The opposite is accepted: variant FT fields which cannot be
766 * selected because the variant FT tag has no mapping named as
767 * such. This scenario, while not ideal, cannot cause any error.
769 for (i
= 0; i
< tag_mappings_count
; ++i
) {
771 struct bt_ctf_field_type
*ft
;
773 ret
= bt_ctf_field_type_enumeration_get_mapping_name(
774 (struct bt_ctf_field_type
*) variant
->tag
,
778 ft
= bt_ctf_field_type_variant_get_field_type_by_name(
781 BT_LOGW("Invalid variant field type: "
782 "enumeration tag field type contains a mapping which does not name a variant field type field: "
783 "variant-ft-addr=%p, tag-field-name=\"%s\", "
784 "enum-ft-addr=%p, mapping-name=\"%s\"",
785 type
, variant
->tag_name
->str
, variant
->tag
,
794 field_count
= bt_ctf_field_type_variant_get_field_count(type
);
795 if (field_count
< 0) {
796 BT_LOGW("Invalid variant field type: no fields: "
797 "addr=%p, tag-field-name=\"%s\"",
798 type
, variant
->tag_name
->str
);
803 for (i
= 0; i
< field_count
; ++i
) {
804 const char *field_name
;
806 ret
= bt_ctf_field_type_variant_get_field_by_index(type
,
807 &field_name
, &child_type
, i
);
809 ret
= bt_ctf_field_type_validate(child_type
);
811 BT_LOGW("Invalid variant field type: "
812 "a contained field type is invalid: "
813 "variant-ft-addr=%p, tag-field-name=\"%s\", "
814 "field-ft-addr=%p, field-name=\"%s\", "
815 "field-index=%" PRId64
,
816 type
, variant
->tag_name
->str
, child_type
,
831 * This function validates a given field type without considering
832 * where this field type is located. It only validates the properties
833 * of the given field type and the properties of its children if
837 int bt_ctf_field_type_validate(struct bt_ctf_field_type
*type
)
840 enum bt_ctf_field_type_id id
= bt_ctf_field_type_get_type_id(type
);
845 /* Already marked as valid */
849 if (type_validate_funcs
[id
]) {
850 ret
= type_validate_funcs
[id
](type
);
853 if (!ret
&& type
->frozen
) {
854 /* Field type is valid */
855 BT_LOGV("Marking field type as valid: addr=%p", type
);
863 struct bt_ctf_field_type
*bt_ctf_field_type_integer_create(unsigned int size
)
865 struct bt_ctf_field_type_integer
*integer
=
866 g_new0(struct bt_ctf_field_type_integer
, 1);
868 BT_LOGD("Creating integer field type object: size=%u", size
);
871 BT_LOGE_STR("Failed to allocate one integer field type.");
875 if (size
== 0 || size
> 64) {
876 BT_LOGW("Invalid parameter: size must be between 1 and 64: "
881 integer
->parent
.id
= BT_CTF_FIELD_TYPE_ID_INTEGER
;
882 integer
->size
= size
;
883 integer
->base
= BT_CTF_INTEGER_BASE_DECIMAL
;
884 integer
->encoding
= BT_CTF_STRING_ENCODING_NONE
;
885 bt_ctf_field_type_init(&integer
->parent
, TRUE
);
886 BT_LOGD("Created integer field type object: addr=%p, size=%u",
887 &integer
->parent
, size
);
888 return &integer
->parent
;
891 int bt_ctf_field_type_integer_get_size(struct bt_ctf_field_type
*type
)
894 struct bt_ctf_field_type_integer
*integer
;
897 BT_LOGW_STR("Invalid parameter: field type is NULL.");
902 if (type
->id
!= BT_CTF_FIELD_TYPE_ID_INTEGER
) {
903 BT_LOGW("Invalid parameter: field type is not an integer field type: "
904 "addr=%p, ft-id=%s", type
,
905 bt_ctf_field_type_id_string(type
->id
));
910 integer
= container_of(type
, struct bt_ctf_field_type_integer
, parent
);
911 ret
= (int) integer
->size
;
916 int bt_ctf_field_type_integer_get_signed(struct bt_ctf_field_type
*type
)
919 struct bt_ctf_field_type_integer
*integer
;
922 BT_LOGW_STR("Invalid parameter: field type is NULL.");
927 if (type
->id
!= BT_CTF_FIELD_TYPE_ID_INTEGER
) {
928 BT_LOGW("Invalid parameter: field type is not an integer field type: "
929 "addr=%p, ft-id=%s", type
,
930 bt_ctf_field_type_id_string(type
->id
));
935 integer
= container_of(type
, struct bt_ctf_field_type_integer
, parent
);
936 ret
= integer
->is_signed
;
941 bt_bool
bt_ctf_field_type_integer_is_signed(
942 struct bt_ctf_field_type
*int_field_type
)
944 return bt_ctf_field_type_integer_get_signed(int_field_type
) ?
948 int bt_ctf_field_type_integer_set_signed(struct bt_ctf_field_type
*type
,
952 struct bt_ctf_field_type_integer
*integer
;
955 BT_LOGW_STR("Invalid parameter: field type is NULL.");
961 BT_LOGW("Invalid parameter: field type is frozen: addr=%p",
967 if (type
->id
!= BT_CTF_FIELD_TYPE_ID_INTEGER
) {
968 BT_LOGW("Invalid parameter: field type is not an integer field type: "
969 "addr=%p, ft-id=%s", type
,
970 bt_ctf_field_type_id_string(type
->id
));
975 integer
= container_of(type
, struct bt_ctf_field_type_integer
, parent
);
976 integer
->is_signed
= !!is_signed
;
977 BT_LOGV("Set integer field type's signedness: addr=%p, is-signed=%d",
983 int bt_ctf_field_type_integer_set_size(struct bt_ctf_field_type
*type
,
987 struct bt_ctf_field_type_integer
*integer
;
990 BT_LOGW_STR("Invalid parameter: field type is NULL.");
996 BT_LOGW("Invalid parameter: field type is frozen: addr=%p",
1002 if (type
->id
!= BT_CTF_FIELD_TYPE_ID_INTEGER
) {
1003 BT_LOGW("Invalid parameter: field type is not an integer field type: "
1004 "addr=%p, ft-id=%s", type
,
1005 bt_ctf_field_type_id_string(type
->id
));
1010 if (size
== 0 || size
> 64) {
1011 BT_LOGW("Invalid parameter: size must be between 1 and 64: "
1012 "addr=%p, size=%u", type
, size
);
1017 integer
= container_of(type
, struct bt_ctf_field_type_integer
, parent
);
1018 integer
->size
= size
;
1019 BT_LOGV("Set integer field type's size: addr=%p, size=%u",
1025 enum bt_ctf_integer_base
bt_ctf_field_type_integer_get_base(
1026 struct bt_ctf_field_type
*type
)
1028 enum bt_ctf_integer_base ret
= BT_CTF_INTEGER_BASE_UNKNOWN
;
1029 struct bt_ctf_field_type_integer
*integer
;
1032 BT_LOGW_STR("Invalid parameter: field type is NULL.");
1036 if (type
->id
!= BT_CTF_FIELD_TYPE_ID_INTEGER
) {
1037 BT_LOGW("Invalid parameter: field type is not an integer field type: "
1038 "addr=%p, ft-id=%s", type
,
1039 bt_ctf_field_type_id_string(type
->id
));
1043 integer
= container_of(type
, struct bt_ctf_field_type_integer
, parent
);
1044 ret
= integer
->base
;
1049 int bt_ctf_field_type_integer_set_base(struct bt_ctf_field_type
*type
,
1050 enum bt_ctf_integer_base base
)
1055 BT_LOGW_STR("Invalid parameter: field type is NULL.");
1061 BT_LOGW("Invalid parameter: field type is frozen: addr=%p",
1067 if (type
->id
!= BT_CTF_FIELD_TYPE_ID_INTEGER
) {
1068 BT_LOGW("Invalid parameter: field type is not an integer field type: "
1069 "addr=%p, ft-id=%s", type
,
1070 bt_ctf_field_type_id_string(type
->id
));
1076 case BT_CTF_INTEGER_BASE_BINARY
:
1077 case BT_CTF_INTEGER_BASE_OCTAL
:
1078 case BT_CTF_INTEGER_BASE_DECIMAL
:
1079 case BT_CTF_INTEGER_BASE_HEXADECIMAL
:
1081 struct bt_ctf_field_type_integer
*integer
= container_of(type
,
1082 struct bt_ctf_field_type_integer
, parent
);
1083 integer
->base
= base
;
1087 BT_LOGW("Invalid parameter: unknown integer field type base: "
1088 "addr=%p, base=%d", type
, base
);
1092 BT_LOGV("Set integer field type's base: addr=%p, base=%s",
1093 type
, bt_ctf_integer_base_string(base
));
1099 enum bt_ctf_string_encoding
bt_ctf_field_type_integer_get_encoding(
1100 struct bt_ctf_field_type
*type
)
1102 enum bt_ctf_string_encoding ret
= BT_CTF_STRING_ENCODING_UNKNOWN
;
1103 struct bt_ctf_field_type_integer
*integer
;
1106 BT_LOGW_STR("Invalid parameter: field type is NULL.");
1110 if (type
->id
!= BT_CTF_FIELD_TYPE_ID_INTEGER
) {
1111 BT_LOGW("Invalid parameter: field type is not an integer field type: "
1112 "addr=%p, ft-id=%s", type
,
1113 bt_ctf_field_type_id_string(type
->id
));
1117 integer
= container_of(type
, struct bt_ctf_field_type_integer
, parent
);
1118 ret
= integer
->encoding
;
1123 int bt_ctf_field_type_integer_set_encoding(struct bt_ctf_field_type
*type
,
1124 enum bt_ctf_string_encoding encoding
)
1127 struct bt_ctf_field_type_integer
*integer
;
1130 BT_LOGW_STR("Invalid parameter: field type is NULL.");
1136 BT_LOGW("Invalid parameter: field type is frozen: addr=%p",
1142 if (type
->id
!= BT_CTF_FIELD_TYPE_ID_INTEGER
) {
1143 BT_LOGW("Invalid parameter: field type is not an integer field type: "
1144 "addr=%p, ft-id=%s", type
,
1145 bt_ctf_field_type_id_string(type
->id
));
1150 if (encoding
< BT_CTF_STRING_ENCODING_NONE
||
1151 encoding
>= BT_CTF_STRING_ENCODING_UNKNOWN
) {
1152 BT_LOGW("Invalid parameter: unknown string encoding: "
1153 "addr=%p, encoding=%d", type
, encoding
);
1158 integer
= container_of(type
, struct bt_ctf_field_type_integer
, parent
);
1159 integer
->encoding
= encoding
;
1160 BT_LOGV("Set integer field type's encoding: addr=%p, encoding=%s",
1161 type
, bt_ctf_string_encoding_string(encoding
));
1166 struct bt_ctf_clock_class
*bt_ctf_field_type_integer_get_mapped_clock_class(
1167 struct bt_ctf_field_type
*type
)
1169 struct bt_ctf_field_type_integer
*integer
;
1170 struct bt_ctf_clock_class
*clock_class
= NULL
;
1173 BT_LOGW_STR("Invalid parameter: field type is NULL.");
1177 integer
= container_of(type
, struct bt_ctf_field_type_integer
, parent
);
1178 clock_class
= integer
->mapped_clock
;
1179 bt_get(clock_class
);
1184 int bt_ctf_field_type_integer_set_mapped_clock_class(
1185 struct bt_ctf_field_type
*type
,
1186 struct bt_ctf_clock_class
*clock_class
)
1188 struct bt_ctf_field_type_integer
*integer
;
1192 BT_LOGW_STR("Invalid parameter: field type is NULL.");
1198 BT_LOGW_STR("Invalid parameter: clock class is NULL.");
1204 BT_LOGW("Invalid parameter: field type is frozen: addr=%p",
1210 if (!bt_ctf_clock_class_is_valid(clock_class
)) {
1211 BT_LOGW("Invalid parameter: clock class is invalid: ft-addr=%p"
1212 "clock-class-addr=%p, clock-class-name=\"%s\"",
1214 bt_ctf_clock_class_get_name(clock_class
));
1219 integer
= container_of(type
, struct bt_ctf_field_type_integer
, parent
);
1220 bt_put(integer
->mapped_clock
);
1221 integer
->mapped_clock
= bt_get(clock_class
);
1222 BT_LOGV("Set integer field type's mapped clock class: ft-addr=%p, "
1223 "clock-class-addr=%p, clock-class-name=\"%s\"",
1224 type
, clock_class
, bt_ctf_clock_class_get_name(clock_class
));
1230 void bt_ctf_field_type_enum_iter_destroy(struct bt_object
*obj
)
1232 struct bt_ctf_field_type_enumeration_mapping_iterator
*iter
=
1234 struct bt_ctf_field_type_enumeration_mapping_iterator
,
1237 BT_LOGD("Destroying enumeration field type mapping iterator: addr=%p",
1239 BT_LOGD_STR("Putting parent enumeration field type.");
1240 bt_put(&iter
->enumeration_type
->parent
);
1245 struct bt_ctf_field_type_enumeration_mapping_iterator
*
1246 bt_ctf_field_type_enumeration_find_mappings_type(
1247 struct bt_ctf_field_type
*type
,
1248 enum bt_ctf_field_type_enumeration_mapping_iterator_type iterator_type
)
1250 struct bt_ctf_field_type_enumeration
*enumeration_type
;
1251 struct bt_ctf_field_type_enumeration_mapping_iterator
*iter
= NULL
;
1254 BT_LOGW_STR("Invalid parameter: field type is NULL.");
1258 if (type
->id
!= BT_CTF_FIELD_TYPE_ID_ENUM
) {
1259 BT_LOGW("Invalid parameter: field type is not an enumeration field type: "
1260 "addr=%p, ft-id=%s", type
,
1261 bt_ctf_field_type_id_string(type
->id
));
1265 enumeration_type
= container_of(type
,
1266 struct bt_ctf_field_type_enumeration
, parent
);
1267 iter
= g_new0(struct bt_ctf_field_type_enumeration_mapping_iterator
, 1);
1269 BT_LOGE_STR("Failed to allocate one enumeration field type mapping.");
1273 bt_object_init(&iter
->base
, bt_ctf_field_type_enum_iter_destroy
);
1275 iter
->enumeration_type
= enumeration_type
;
1277 iter
->type
= iterator_type
;
1282 struct bt_ctf_field_type_enumeration_mapping_iterator
*
1283 bt_ctf_field_type_enumeration_find_mappings_by_name(
1284 struct bt_ctf_field_type
*type
, const char *name
)
1286 struct bt_ctf_field_type_enumeration_mapping_iterator
*iter
;
1288 iter
= bt_ctf_field_type_enumeration_find_mappings_type(
1289 type
, ITERATOR_BY_NAME
);
1291 BT_LOGE("Cannot create enumeration field type mapping iterator: "
1292 "ft-addr=%p, mapping-name=\"%s\"", type
, name
);
1296 iter
->u
.name_quark
= g_quark_try_string(name
);
1297 if (!iter
->u
.name_quark
) {
1298 BT_LOGE("Cannot get GQuark: string=\"%s\"", name
);
1302 /* Advance iterator to first entry, or leave index at -1. */
1303 if (bt_ctf_field_type_enumeration_mapping_iterator_next(iter
)) {
1304 /* No entry found. */
1314 int bt_ctf_field_type_enumeration_mapping_iterator_next(
1315 struct bt_ctf_field_type_enumeration_mapping_iterator
*iter
)
1317 struct bt_ctf_field_type_enumeration
*enumeration
;
1318 struct bt_ctf_field_type
*type
;
1319 int i
, ret
= 0, len
;
1322 BT_LOGW_STR("Invalid parameter: enumeration field type mapping iterator is NULL.");
1327 enumeration
= iter
->enumeration_type
;
1328 type
= &enumeration
->parent
;
1329 len
= enumeration
->entries
->len
;
1330 for (i
= iter
->index
+ 1; i
< len
; i
++) {
1331 struct enumeration_mapping
*mapping
=
1332 get_enumeration_mapping(type
, i
);
1334 switch (iter
->type
) {
1335 case ITERATOR_BY_NAME
:
1336 if (mapping
->string
== iter
->u
.name_quark
) {
1341 case ITERATOR_BY_SIGNED_VALUE
:
1343 int64_t value
= iter
->u
.signed_value
;
1345 if (value
>= mapping
->range_start
._signed
&&
1346 value
<= mapping
->range_end
._signed
) {
1352 case ITERATOR_BY_UNSIGNED_VALUE
:
1354 uint64_t value
= iter
->u
.unsigned_value
;
1356 if (value
>= mapping
->range_start
._unsigned
&&
1357 value
<= mapping
->range_end
._unsigned
) {
1364 BT_LOGF("Invalid enumeration field type mapping iterator type: "
1365 "type=%d", iter
->type
);
1375 struct bt_ctf_field_type_enumeration_mapping_iterator
*
1376 bt_ctf_field_type_enumeration_find_mappings_by_signed_value(
1377 struct bt_ctf_field_type
*type
, int64_t value
)
1379 struct bt_ctf_field_type_enumeration_mapping_iterator
*iter
;
1381 iter
= bt_ctf_field_type_enumeration_find_mappings_type(
1382 type
, ITERATOR_BY_SIGNED_VALUE
);
1384 BT_LOGE("Cannot create enumeration field type mapping iterator: "
1385 "ft-addr=%p, value=%" PRId64
, type
, value
);
1389 if (bt_ctf_field_type_integer_get_signed(
1390 iter
->enumeration_type
->container
) != 1) {
1391 BT_LOGW("Invalid parameter: enumeration field type is unsigned: "
1392 "enum-ft-addr=%p, int-ft-addr=%p",
1393 type
, iter
->enumeration_type
->container
);
1397 iter
->u
.signed_value
= value
;
1399 /* Advance iterator to first entry, or leave index at -1. */
1400 if (bt_ctf_field_type_enumeration_mapping_iterator_next(iter
)) {
1401 /* No entry found. */
1411 struct bt_ctf_field_type_enumeration_mapping_iterator
*
1412 bt_ctf_field_type_enumeration_find_mappings_by_unsigned_value(
1413 struct bt_ctf_field_type
*type
, uint64_t value
)
1415 struct bt_ctf_field_type_enumeration_mapping_iterator
*iter
= NULL
;
1418 BT_LOGW_STR("Invalid parameter: field type is NULL.");
1422 iter
= bt_ctf_field_type_enumeration_find_mappings_type(
1423 type
, ITERATOR_BY_UNSIGNED_VALUE
);
1425 BT_LOGE("Cannot create enumeration field type mapping iterator: "
1426 "ft-addr=%p, value=%" PRIu64
, type
, value
);
1430 if (bt_ctf_field_type_integer_get_signed(
1431 iter
->enumeration_type
->container
) != 0) {
1432 BT_LOGW("Invalid parameter: enumeration field type is signed: "
1433 "enum-ft-addr=%p, int-ft-addr=%p",
1434 type
, iter
->enumeration_type
->container
);
1437 iter
->u
.unsigned_value
= value
;
1439 /* Advance iterator to first entry, or leave index at -1. */
1440 if (bt_ctf_field_type_enumeration_mapping_iterator_next(iter
)) {
1441 /* No entry found. */
1451 int bt_ctf_field_type_enumeration_mapping_iterator_get_signed(
1452 struct bt_ctf_field_type_enumeration_mapping_iterator
*iter
,
1453 const char **mapping_name
, int64_t *range_begin
,
1459 BT_LOGW_STR("Invalid parameter: enumeration field type mapping iterator is NULL.");
1464 ret
= bt_ctf_field_type_enumeration_get_mapping_signed(
1465 &iter
->enumeration_type
->parent
, iter
->index
,
1466 mapping_name
, range_begin
, range_end
);
1471 int bt_ctf_field_type_enumeration_mapping_iterator_get_unsigned(
1472 struct bt_ctf_field_type_enumeration_mapping_iterator
*iter
,
1473 const char **mapping_name
, uint64_t *range_begin
,
1474 uint64_t *range_end
)
1479 BT_LOGW_STR("Invalid parameter: enumeration field type mapping iterator is NULL.");
1484 ret
= bt_ctf_field_type_enumeration_get_mapping_unsigned(
1485 &iter
->enumeration_type
->parent
, iter
->index
,
1486 mapping_name
, range_begin
, range_end
);
1491 int bt_ctf_field_type_enumeration_get_mapping_signed(
1492 struct bt_ctf_field_type
*enum_field_type
,
1493 uint64_t index
, const char **mapping_name
, int64_t *range_begin
,
1497 struct enumeration_mapping
*mapping
;
1499 if (!enum_field_type
) {
1500 BT_LOGW_STR("Invalid parameter: field type is NULL.");
1505 mapping
= get_enumeration_mapping(enum_field_type
, index
);
1507 /* get_enumeration_mapping() reports any error */
1513 *mapping_name
= g_quark_to_string(mapping
->string
);
1514 assert(*mapping_name
);
1518 *range_begin
= mapping
->range_start
._signed
;
1522 *range_end
= mapping
->range_end
._signed
;
1528 int bt_ctf_field_type_enumeration_get_mapping_unsigned(
1529 struct bt_ctf_field_type
*enum_field_type
,
1531 const char **mapping_name
, uint64_t *range_begin
,
1532 uint64_t *range_end
)
1535 struct enumeration_mapping
*mapping
;
1537 if (!enum_field_type
) {
1538 BT_LOGW_STR("Invalid parameter: field type is NULL.");
1543 mapping
= get_enumeration_mapping(enum_field_type
, index
);
1545 /* get_enumeration_mapping() reports any error */
1551 *mapping_name
= g_quark_to_string(mapping
->string
);
1552 assert(*mapping_name
);
1556 *range_begin
= mapping
->range_start
._unsigned
;
1560 *range_end
= mapping
->range_end
._unsigned
;
1566 struct bt_ctf_field_type
*bt_ctf_field_type_enumeration_create(
1567 struct bt_ctf_field_type
*integer_container_type
)
1569 struct bt_ctf_field_type_enumeration
*enumeration
= NULL
;
1571 BT_LOGD("Creating enumeration field type object: int-ft-addr=%p",
1572 integer_container_type
);
1574 if (!integer_container_type
) {
1575 BT_LOGW_STR("Invalid parameter: field type is NULL.");
1579 if (integer_container_type
->id
!= BT_CTF_FIELD_TYPE_ID_INTEGER
) {
1580 BT_LOGW("Invalid parameter: container field type is not an integer field type: "
1581 "container-ft-addr=%p, container-ft-id=%s",
1582 integer_container_type
,
1583 bt_ctf_field_type_id_string(integer_container_type
->id
));
1587 enumeration
= g_new0(struct bt_ctf_field_type_enumeration
, 1);
1589 BT_LOGE_STR("Failed to allocate one enumeration field type.");
1593 enumeration
->parent
.id
= BT_CTF_FIELD_TYPE_ID_ENUM
;
1594 bt_get(integer_container_type
);
1595 enumeration
->container
= integer_container_type
;
1596 enumeration
->entries
= g_ptr_array_new_with_free_func(
1597 (GDestroyNotify
)destroy_enumeration_mapping
);
1598 bt_ctf_field_type_init(&enumeration
->parent
, FALSE
);
1599 BT_LOGD("Created enumeration field type object: addr=%p, "
1600 "int-ft-addr=%p, int-ft-size=%u",
1601 &enumeration
->parent
, integer_container_type
,
1602 bt_ctf_field_type_integer_get_size(integer_container_type
));
1603 return &enumeration
->parent
;
1605 g_free(enumeration
);
1609 struct bt_ctf_field_type
*bt_ctf_field_type_enumeration_get_container_type(
1610 struct bt_ctf_field_type
*type
)
1612 struct bt_ctf_field_type
*container_type
= NULL
;
1613 struct bt_ctf_field_type_enumeration
*enumeration_type
;
1616 BT_LOGW_STR("Invalid parameter: field type is NULL.");
1620 if (type
->id
!= BT_CTF_FIELD_TYPE_ID_ENUM
) {
1621 BT_LOGW("Invalid parameter: field type is not an enumeration field type: "
1622 "addr=%p, ft-id=%s", type
,
1623 bt_ctf_field_type_id_string(type
->id
));
1627 enumeration_type
= container_of(type
,
1628 struct bt_ctf_field_type_enumeration
, parent
);
1629 container_type
= enumeration_type
->container
;
1630 bt_get(container_type
);
1632 return container_type
;
1635 int bt_ctf_field_type_enumeration_add_mapping_signed(
1636 struct bt_ctf_field_type
*type
, const char *string
,
1637 int64_t range_start
, int64_t range_end
)
1640 GQuark mapping_name
;
1641 struct enumeration_mapping
*mapping
;
1642 struct bt_ctf_field_type_enumeration
*enumeration
;
1643 char *escaped_string
;
1646 BT_LOGW_STR("Invalid parameter: field type is NULL.");
1652 BT_LOGW_STR("Invalid parameter: string is NULL.");
1658 BT_LOGW("Invalid parameter: field type is frozen: addr=%p",
1664 if (type
->id
!= BT_CTF_FIELD_TYPE_ID_ENUM
) {
1665 BT_LOGW("Invalid parameter: field type is not an enumeration field type: "
1666 "addr=%p, ft-id=%s", type
,
1667 bt_ctf_field_type_id_string(type
->id
));
1672 if (range_end
< range_start
) {
1673 BT_LOGW("Invalid parameter: range's end is lesser than range's start: "
1674 "addr=%p, range-start=%" PRId64
", range-end=%" PRId64
,
1675 type
, range_start
, range_end
);
1680 if (strlen(string
) == 0) {
1681 BT_LOGW("Invalid parameter: mapping name is an empty string: "
1682 "enum-ft-addr=%p, mapping-name-addr=%p", type
,
1688 escaped_string
= g_strescape(string
, NULL
);
1689 if (!escaped_string
) {
1690 BT_LOGE("Cannot escape mapping name: enum-ft-addr=%p, "
1691 "mapping-name-addr=%p, mapping-name=\"%s\"",
1692 type
, string
, string
);
1697 mapping
= g_new(struct enumeration_mapping
, 1);
1699 BT_LOGE_STR("Failed to allocate one enumeration mapping.");
1703 mapping_name
= g_quark_from_string(escaped_string
);
1704 *mapping
= (struct enumeration_mapping
) {
1705 .range_start
._signed
= range_start
,
1706 .range_end
._signed
= range_end
,
1707 .string
= mapping_name
,
1709 enumeration
= container_of(type
, struct bt_ctf_field_type_enumeration
,
1711 g_ptr_array_add(enumeration
->entries
, mapping
);
1712 g_ptr_array_sort(enumeration
->entries
,
1713 (GCompareFunc
)compare_enumeration_mappings_signed
);
1714 BT_LOGV("Added mapping to signed enumeration field type: addr=%p, "
1715 "name=\"%s\", range-start=%" PRId64
", "
1716 "range-end=%" PRId64
,
1717 type
, string
, range_start
, range_end
);
1719 free(escaped_string
);
1724 int bt_ctf_field_type_enumeration_add_mapping_unsigned(
1725 struct bt_ctf_field_type
*type
, const char *string
,
1726 uint64_t range_start
, uint64_t range_end
)
1729 GQuark mapping_name
;
1730 struct enumeration_mapping
*mapping
;
1731 struct bt_ctf_field_type_enumeration
*enumeration
;
1732 char *escaped_string
;
1735 BT_LOGW_STR("Invalid parameter: field type is NULL.");
1741 BT_LOGW_STR("Invalid parameter: string is NULL.");
1747 BT_LOGW("Invalid parameter: field type is frozen: addr=%p",
1753 if (type
->id
!= BT_CTF_FIELD_TYPE_ID_ENUM
) {
1754 BT_LOGW("Invalid parameter: field type is not an enumeration field type: "
1755 "addr=%p, ft-id=%s", type
,
1756 bt_ctf_field_type_id_string(type
->id
));
1761 if (range_end
< range_start
) {
1762 BT_LOGW("Invalid parameter: range's end is lesser than range's start: "
1763 "addr=%p, range-start=%" PRIu64
", range-end=%" PRIu64
,
1764 type
, range_start
, range_end
);
1769 if (strlen(string
) == 0) {
1770 BT_LOGW("Invalid parameter: mapping name is an empty string: "
1771 "enum-ft-addr=%p, mapping-name-addr=%p", type
,
1777 escaped_string
= g_strescape(string
, NULL
);
1778 if (!escaped_string
) {
1779 BT_LOGE("Cannot escape mapping name: enum-ft-addr=%p, "
1780 "mapping-name-addr=%p, mapping-name=\"%s\"",
1781 type
, string
, string
);
1786 mapping
= g_new(struct enumeration_mapping
, 1);
1788 BT_LOGE_STR("Failed to allocate one enumeration mapping.");
1792 mapping_name
= g_quark_from_string(escaped_string
);
1793 *mapping
= (struct enumeration_mapping
) {
1794 .range_start
._unsigned
= range_start
,
1795 .range_end
._unsigned
= range_end
,
1796 .string
= mapping_name
,
1798 enumeration
= container_of(type
, struct bt_ctf_field_type_enumeration
,
1800 g_ptr_array_add(enumeration
->entries
, mapping
);
1801 g_ptr_array_sort(enumeration
->entries
,
1802 (GCompareFunc
)compare_enumeration_mappings_unsigned
);
1803 BT_LOGV("Added mapping to unsigned enumeration field type: addr=%p, "
1804 "name=\"%s\", range-start=%" PRIu64
", "
1805 "range-end=%" PRIu64
,
1806 type
, string
, range_start
, range_end
);
1808 free(escaped_string
);
1813 int64_t bt_ctf_field_type_enumeration_get_mapping_count(
1814 struct bt_ctf_field_type
*type
)
1817 struct bt_ctf_field_type_enumeration
*enumeration
;
1820 BT_LOGW_STR("Invalid parameter: field type is NULL.");
1825 if (type
->id
!= BT_CTF_FIELD_TYPE_ID_ENUM
) {
1826 BT_LOGW("Invalid parameter: field type is not an enumeration field type: "
1827 "addr=%p, ft-id=%s", type
,
1828 bt_ctf_field_type_id_string(type
->id
));
1833 enumeration
= container_of(type
, struct bt_ctf_field_type_enumeration
,
1835 ret
= (int64_t) enumeration
->entries
->len
;
1840 struct bt_ctf_field_type
*bt_ctf_field_type_floating_point_create(void)
1842 struct bt_ctf_field_type_floating_point
*floating_point
=
1843 g_new0(struct bt_ctf_field_type_floating_point
, 1);
1845 BT_LOGD_STR("Creating floating point number field type object.");
1847 if (!floating_point
) {
1848 BT_LOGE_STR("Failed to allocate one floating point number field type.");
1852 floating_point
->parent
.id
= BT_CTF_FIELD_TYPE_ID_FLOAT
;
1853 floating_point
->exp_dig
= sizeof(float) * CHAR_BIT
- FLT_MANT_DIG
;
1854 floating_point
->mant_dig
= FLT_MANT_DIG
;
1855 bt_ctf_field_type_init(&floating_point
->parent
, TRUE
);
1856 BT_LOGD("Created floating point number field type object: addr=%p, "
1857 "exp-size=%u, mant-size=%u", &floating_point
->parent
,
1858 floating_point
->exp_dig
, floating_point
->mant_dig
);
1860 return floating_point
? &floating_point
->parent
: NULL
;
1863 int bt_ctf_field_type_floating_point_get_exponent_digits(
1864 struct bt_ctf_field_type
*type
)
1867 struct bt_ctf_field_type_floating_point
*floating_point
;
1870 BT_LOGW_STR("Invalid parameter: field type is NULL.");
1875 if (type
->id
!= BT_CTF_FIELD_TYPE_ID_FLOAT
) {
1876 BT_LOGW("Invalid parameter: field type is not a floating point number field type: "
1877 "addr=%p, ft-id=%s", type
,
1878 bt_ctf_field_type_id_string(type
->id
));
1883 floating_point
= container_of(type
,
1884 struct bt_ctf_field_type_floating_point
, parent
);
1885 ret
= (int) floating_point
->exp_dig
;
1890 int bt_ctf_field_type_floating_point_set_exponent_digits(
1891 struct bt_ctf_field_type
*type
,
1892 unsigned int exponent_digits
)
1895 struct bt_ctf_field_type_floating_point
*floating_point
;
1898 BT_LOGW_STR("Invalid parameter: field type is NULL.");
1904 BT_LOGW("Invalid parameter: field type is frozen: addr=%p",
1910 if (type
->id
!= BT_CTF_FIELD_TYPE_ID_FLOAT
) {
1911 BT_LOGW("Invalid parameter: field type is not a floating point number field type: "
1912 "addr=%p, ft-id=%s", type
,
1913 bt_ctf_field_type_id_string(type
->id
));
1918 floating_point
= container_of(type
,
1919 struct bt_ctf_field_type_floating_point
, parent
);
1920 if ((exponent_digits
!= sizeof(float) * CHAR_BIT
- FLT_MANT_DIG
) &&
1921 (exponent_digits
!= sizeof(double) * CHAR_BIT
- DBL_MANT_DIG
) &&
1923 sizeof(long double) * CHAR_BIT
- LDBL_MANT_DIG
)) {
1924 BT_LOGW("Invalid parameter: invalid exponent size: "
1925 "addr=%p, exp-size=%u", type
, exponent_digits
);
1930 floating_point
->exp_dig
= exponent_digits
;
1931 BT_LOGV("Set floating point number field type's exponent size: addr=%p, "
1932 "exp-size=%u", type
, exponent_digits
);
1937 int bt_ctf_field_type_floating_point_get_mantissa_digits(
1938 struct bt_ctf_field_type
*type
)
1941 struct bt_ctf_field_type_floating_point
*floating_point
;
1944 BT_LOGW_STR("Invalid parameter: field type is NULL.");
1949 if (type
->id
!= BT_CTF_FIELD_TYPE_ID_FLOAT
) {
1950 BT_LOGW("Invalid parameter: field type is not a floating point number field type: "
1951 "addr=%p, ft-id=%s", type
,
1952 bt_ctf_field_type_id_string(type
->id
));
1957 floating_point
= container_of(type
,
1958 struct bt_ctf_field_type_floating_point
, parent
);
1959 ret
= (int) floating_point
->mant_dig
;
1964 int bt_ctf_field_type_floating_point_set_mantissa_digits(
1965 struct bt_ctf_field_type
*type
,
1966 unsigned int mantissa_digits
)
1969 struct bt_ctf_field_type_floating_point
*floating_point
;
1972 BT_LOGW_STR("Invalid parameter: field type is NULL.");
1978 BT_LOGW("Invalid parameter: field type is frozen: addr=%p",
1984 if (type
->id
!= BT_CTF_FIELD_TYPE_ID_FLOAT
) {
1985 BT_LOGW("Invalid parameter: field type is not a floating point number field type: "
1986 "addr=%p, ft-id=%s", type
,
1987 bt_ctf_field_type_id_string(type
->id
));
1992 floating_point
= container_of(type
,
1993 struct bt_ctf_field_type_floating_point
, parent
);
1995 if ((mantissa_digits
!= FLT_MANT_DIG
) &&
1996 (mantissa_digits
!= DBL_MANT_DIG
) &&
1997 (mantissa_digits
!= LDBL_MANT_DIG
)) {
1998 BT_LOGW("Invalid parameter: invalid mantissa size: "
1999 "addr=%p, mant-size=%u", type
, mantissa_digits
);
2004 floating_point
->mant_dig
= mantissa_digits
;
2005 BT_LOGV("Set floating point number field type's mantissa size: addr=%p, "
2006 "mant-size=%u", type
, mantissa_digits
);
2011 struct bt_ctf_field_type
*bt_ctf_field_type_structure_create(void)
2013 struct bt_ctf_field_type_structure
*structure
=
2014 g_new0(struct bt_ctf_field_type_structure
, 1);
2016 BT_LOGD_STR("Creating structure field type object.");
2019 BT_LOGE_STR("Failed to allocate one structure field type.");
2023 structure
->parent
.id
= BT_CTF_FIELD_TYPE_ID_STRUCT
;
2024 structure
->fields
= g_ptr_array_new_with_free_func(
2025 (GDestroyNotify
)destroy_structure_field
);
2026 structure
->field_name_to_index
= g_hash_table_new(NULL
, NULL
);
2027 bt_ctf_field_type_init(&structure
->parent
, TRUE
);
2028 BT_LOGD("Created structure field type object: addr=%p",
2029 &structure
->parent
);
2030 return &structure
->parent
;
2035 int bt_ctf_field_type_structure_add_field(struct bt_ctf_field_type
*type
,
2036 struct bt_ctf_field_type
*field_type
,
2037 const char *field_name
)
2040 struct bt_ctf_field_type_structure
*structure
;
2043 * TODO: check that `field_type` does not contain `type`,
2047 BT_LOGW_STR("Invalid parameter: field type is NULL.");
2053 BT_LOGW_STR("Invalid parameter: field name is NULL.");
2059 BT_LOGW("Invalid parameter: field type is frozen: addr=%p",
2065 if (bt_ctf_validate_identifier(field_name
)) {
2066 BT_LOGW("Invalid parameter: field name is not a valid CTF identifier: "
2067 "struct-ft-addr=%p, field-name=\"%s\"",
2073 if (type
->id
!= BT_CTF_FIELD_TYPE_ID_STRUCT
) {
2074 BT_LOGW("Invalid parameter: field type is not a structure field type: "
2075 "addr=%p, ft-id=%s", type
,
2076 bt_ctf_field_type_id_string(type
->id
));
2081 if (type
== field_type
) {
2082 BT_LOGW("Invalid parameter: structure field type and field type to add are the same: "
2088 structure
= container_of(type
,
2089 struct bt_ctf_field_type_structure
, parent
);
2090 if (add_structure_field(structure
->fields
,
2091 structure
->field_name_to_index
, field_type
, field_name
)) {
2092 BT_LOGW("Cannot add field to structure field type: "
2093 "struct-ft-addr=%p, field-ft-addr=%p, field-name=\"%s\"",
2094 type
, field_type
, field_name
);
2099 BT_LOGV("Added structure field type field: struct-ft-addr=%p, "
2100 "field-ft-addr=%p, field-name=\"%s\"", type
,
2101 field_type
, field_name
);
2106 int64_t bt_ctf_field_type_structure_get_field_count(
2107 struct bt_ctf_field_type
*type
)
2110 struct bt_ctf_field_type_structure
*structure
;
2113 BT_LOGW_STR("Invalid parameter: field type is NULL.");
2118 if (type
->id
!= BT_CTF_FIELD_TYPE_ID_STRUCT
) {
2119 BT_LOGW("Invalid parameter: field type is not a structure field type: "
2120 "addr=%p, ft-id=%s", type
,
2121 bt_ctf_field_type_id_string(type
->id
));
2126 structure
= container_of(type
, struct bt_ctf_field_type_structure
,
2128 ret
= (int64_t) structure
->fields
->len
;
2133 int bt_ctf_field_type_structure_get_field_by_index(
2134 struct bt_ctf_field_type
*type
,
2135 const char **field_name
, struct bt_ctf_field_type
**field_type
,
2138 struct bt_ctf_field_type_structure
*structure
;
2139 struct structure_field
*field
;
2143 BT_LOGW_STR("Invalid parameter: field type is NULL.");
2148 if (type
->id
!= BT_CTF_FIELD_TYPE_ID_STRUCT
) {
2149 BT_LOGW("Invalid parameter: field type is not a structure field type: "
2150 "addr=%p, ft-id=%s", type
,
2151 bt_ctf_field_type_id_string(type
->id
));
2156 structure
= container_of(type
, struct bt_ctf_field_type_structure
,
2158 if (index
>= structure
->fields
->len
) {
2159 BT_LOGW("Invalid parameter: index is out of bounds: "
2160 "addr=%p, index=%" PRIu64
", count=%u",
2161 type
, index
, structure
->fields
->len
);
2166 field
= g_ptr_array_index(structure
->fields
, index
);
2168 *field_type
= field
->type
;
2169 bt_get(field
->type
);
2172 *field_name
= g_quark_to_string(field
->name
);
2173 assert(*field_name
);
2179 struct bt_ctf_field_type
*bt_ctf_field_type_structure_get_field_type_by_name(
2180 struct bt_ctf_field_type
*type
,
2185 struct structure_field
*field
;
2186 struct bt_ctf_field_type_structure
*structure
;
2187 struct bt_ctf_field_type
*field_type
= NULL
;
2190 BT_LOGW_STR("Invalid parameter: field type is NULL.");
2195 BT_LOGW_STR("Invalid parameter: name is NULL.");
2199 name_quark
= g_quark_try_string(name
);
2201 BT_LOGE("Cannot get GQuark: string=\"%s\"", name
);
2205 structure
= container_of(type
, struct bt_ctf_field_type_structure
,
2207 if (!g_hash_table_lookup_extended(structure
->field_name_to_index
,
2208 GUINT_TO_POINTER(name_quark
), NULL
, (gpointer
*)&index
)) {
2212 field
= structure
->fields
->pdata
[index
];
2213 field_type
= field
->type
;
2219 struct bt_ctf_field_type
*bt_ctf_field_type_variant_create(
2220 struct bt_ctf_field_type
*enum_tag
, const char *tag_name
)
2222 struct bt_ctf_field_type_variant
*variant
= NULL
;
2224 BT_LOGD("Creating variant field type object: "
2225 "tag-ft-addr=%p, tag-field-name=\"%s\"",
2226 enum_tag
, tag_name
);
2228 if (tag_name
&& bt_ctf_validate_identifier(tag_name
)) {
2229 BT_LOGW("Invalid parameter: tag field name is not a valid CTF identifier: "
2230 "tag-ft-addr=%p, tag-field-name=\"%s\"",
2231 enum_tag
, tag_name
);
2235 variant
= g_new0(struct bt_ctf_field_type_variant
, 1);
2237 BT_LOGE_STR("Failed to allocate one variant field type.");
2241 variant
->parent
.id
= BT_CTF_FIELD_TYPE_ID_VARIANT
;
2242 variant
->tag_name
= g_string_new(tag_name
);
2243 variant
->field_name_to_index
= g_hash_table_new(NULL
, NULL
);
2244 variant
->fields
= g_ptr_array_new_with_free_func(
2245 (GDestroyNotify
) destroy_structure_field
);
2248 variant
->tag
= container_of(enum_tag
,
2249 struct bt_ctf_field_type_enumeration
, parent
);
2252 bt_ctf_field_type_init(&variant
->parent
, TRUE
);
2253 /* A variant's alignment is undefined */
2254 variant
->parent
.alignment
= 0;
2255 BT_LOGD("Created variant field type object: addr=%p, "
2256 "tag-ft-addr=%p, tag-field-name=\"%s\"",
2257 &variant
->parent
, enum_tag
, tag_name
);
2258 return &variant
->parent
;
2263 struct bt_ctf_field_type
*bt_ctf_field_type_variant_get_tag_type(
2264 struct bt_ctf_field_type
*type
)
2266 struct bt_ctf_field_type_variant
*variant
;
2267 struct bt_ctf_field_type
*tag_type
= NULL
;
2270 BT_LOGW_STR("Invalid parameter: field type is NULL.");
2274 if (type
->id
!= BT_CTF_FIELD_TYPE_ID_VARIANT
) {
2275 BT_LOGW("Invalid parameter: field type is not a variant field type: "
2276 "addr=%p, ft-id=%s", type
,
2277 bt_ctf_field_type_id_string(type
->id
));
2281 variant
= container_of(type
, struct bt_ctf_field_type_variant
, parent
);
2282 if (!variant
->tag
) {
2283 BT_LOGV("Variant field type has no tag field type: "
2288 tag_type
= &variant
->tag
->parent
;
2294 const char *bt_ctf_field_type_variant_get_tag_name(
2295 struct bt_ctf_field_type
*type
)
2297 struct bt_ctf_field_type_variant
*variant
;
2298 const char *tag_name
= NULL
;
2301 BT_LOGW_STR("Invalid parameter: field type is NULL.");
2305 if (type
->id
!= BT_CTF_FIELD_TYPE_ID_VARIANT
) {
2306 BT_LOGW("Invalid parameter: field type is not a variant field type: "
2307 "addr=%p, ft-id=%s", type
,
2308 bt_ctf_field_type_id_string(type
->id
));
2312 variant
= container_of(type
, struct bt_ctf_field_type_variant
, parent
);
2313 if (variant
->tag_name
->len
== 0) {
2314 BT_LOGV("Variant field type has no tag field name: "
2319 tag_name
= variant
->tag_name
->str
;
2324 int bt_ctf_field_type_variant_set_tag_name(
2325 struct bt_ctf_field_type
*type
, const char *name
)
2328 struct bt_ctf_field_type_variant
*variant
;
2331 BT_LOGW_STR("Invalid parameter: field type is NULL.");
2337 BT_LOGW("Invalid parameter: field type is frozen: addr=%p",
2343 if (type
->id
!= BT_CTF_FIELD_TYPE_ID_VARIANT
) {
2344 BT_LOGW("Invalid parameter: field type is not a variant field type: "
2345 "addr=%p, ft-id=%s", type
,
2346 bt_ctf_field_type_id_string(type
->id
));
2351 if (bt_ctf_validate_identifier(name
)) {
2352 BT_LOGW("Invalid parameter: tag field name is not a valid CTF identifier: "
2353 "variant-ft-addr=%p, tag-field-name=\"%s\"",
2359 variant
= container_of(type
, struct bt_ctf_field_type_variant
, parent
);
2360 g_string_assign(variant
->tag_name
, name
);
2361 BT_LOGV("Set variant field type's tag field name: addr=%p, "
2362 "tag-field-name=\"%s\"", type
, name
);
2367 int bt_ctf_field_type_variant_add_field(struct bt_ctf_field_type
*type
,
2368 struct bt_ctf_field_type
*field_type
,
2369 const char *field_name
)
2373 struct bt_ctf_field_type_variant
*variant
;
2374 GQuark field_name_quark
= g_quark_from_string(field_name
);
2377 * TODO: check that `field_type` does not contain `type`,
2381 BT_LOGW_STR("Invalid parameter: field type is NULL.");
2387 BT_LOGW("Invalid parameter: field type is frozen: addr=%p",
2393 if (bt_ctf_validate_identifier(field_name
)) {
2394 BT_LOGW("Invalid parameter: field name is not a valid CTF identifier: "
2395 "variant-ft-addr=%p, field-name=\"%s\"",
2401 if (type
->id
!= BT_CTF_FIELD_TYPE_ID_VARIANT
) {
2402 BT_LOGW("Invalid parameter: field type is not a variant field type: "
2403 "addr=%p, ft-id=%s", type
,
2404 bt_ctf_field_type_id_string(type
->id
));
2409 if (type
== field_type
) {
2410 BT_LOGW("Invalid parameter: variant field type and field type to add are the same: "
2416 variant
= container_of(type
, struct bt_ctf_field_type_variant
, parent
);
2418 /* The user has explicitly provided a tag; validate against it. */
2422 /* Make sure this name is present in the enum tag */
2423 for (i
= 0; i
< variant
->tag
->entries
->len
; i
++) {
2424 struct enumeration_mapping
*mapping
=
2425 g_ptr_array_index(variant
->tag
->entries
, i
);
2427 if (mapping
->string
== field_name_quark
) {
2434 /* Validation failed */
2435 BT_LOGW("Invalid parameter: field name does not name a tag field type's mapping: "
2436 "variant-ft-addr=%p, tag-ft-addr=%p, "
2437 "tag-field-name=\"%s\""
2438 "field-ft-addr=%p, field-name=\"%s\"",
2439 type
, variant
->tag
, variant
->tag_name
->str
,
2440 field_type
, field_name
);
2446 if (add_structure_field(variant
->fields
, variant
->field_name_to_index
,
2447 field_type
, field_name
)) {
2448 BT_LOGW("Cannot add field to variant field type: "
2449 "variant-ft-addr=%p, field-ft-addr=%p, field-name=\"%s\"",
2450 type
, field_type
, field_name
);
2455 BT_LOGV("Added variant field type field: variant-ft-addr=%p, "
2456 "field-ft-addr=%p, field-name=\"%s\"", type
,
2457 field_type
, field_name
);
2463 struct bt_ctf_field_type
*bt_ctf_field_type_variant_get_field_type_by_name(
2464 struct bt_ctf_field_type
*type
,
2465 const char *field_name
)
2469 struct structure_field
*field
;
2470 struct bt_ctf_field_type_variant
*variant
;
2471 struct bt_ctf_field_type
*field_type
= NULL
;
2474 BT_LOGW_STR("Invalid parameter: field type is NULL.");
2479 BT_LOGW_STR("Invalid parameter: field name is NULL.");
2483 name_quark
= g_quark_try_string(field_name
);
2485 BT_LOGE("Cannot get GQuark: string=\"%s\"", field_name
);
2489 variant
= container_of(type
, struct bt_ctf_field_type_variant
, parent
);
2490 if (!g_hash_table_lookup_extended(variant
->field_name_to_index
,
2491 GUINT_TO_POINTER(name_quark
), NULL
, (gpointer
*)&index
)) {
2495 field
= g_ptr_array_index(variant
->fields
, index
);
2496 field_type
= field
->type
;
2502 struct bt_ctf_field_type
*bt_ctf_field_type_variant_get_field_type_from_tag(
2503 struct bt_ctf_field_type
*type
,
2504 struct bt_ctf_field
*tag
)
2507 const char *enum_value
;
2508 struct bt_ctf_field_type
*field_type
= NULL
;
2509 struct bt_ctf_field_type_enumeration_mapping_iterator
*iter
= NULL
;
2512 BT_LOGW_STR("Invalid parameter: variant field type is NULL.");
2517 BT_LOGW_STR("Invalid parameter: tag field is NULL.");
2521 if (type
->id
!= BT_CTF_FIELD_TYPE_ID_VARIANT
) {
2522 BT_LOGW("Invalid parameter: field type is not a variant field type: "
2523 "addr=%p, ft-id=%s", type
,
2524 bt_ctf_field_type_id_string(type
->id
));
2528 iter
= bt_ctf_field_enumeration_get_mappings(tag
);
2530 BT_LOGE("Cannot get enumeration field type mapping iterator from enumeration field: "
2531 "enum-field-addr=%p", tag
);
2535 ret
= bt_ctf_field_type_enumeration_mapping_iterator_get_signed(iter
,
2536 &enum_value
, NULL
, NULL
);
2538 BT_LOGW("Cannot get enumeration field type mapping iterator's current mapping: "
2539 "iter-addr=%p", iter
);
2543 field_type
= bt_ctf_field_type_variant_get_field_type_by_name(
2550 int64_t bt_ctf_field_type_variant_get_field_count(struct bt_ctf_field_type
*type
)
2553 struct bt_ctf_field_type_variant
*variant
;
2556 BT_LOGW_STR("Invalid parameter: field type is NULL.");
2561 if (type
->id
!= BT_CTF_FIELD_TYPE_ID_VARIANT
) {
2562 BT_LOGW("Invalid parameter: field type is not a variant field type: "
2563 "addr=%p, ft-id=%s", type
,
2564 bt_ctf_field_type_id_string(type
->id
));
2569 variant
= container_of(type
, struct bt_ctf_field_type_variant
,
2571 ret
= (int64_t) variant
->fields
->len
;
2577 int bt_ctf_field_type_variant_get_field_by_index(struct bt_ctf_field_type
*type
,
2578 const char **field_name
, struct bt_ctf_field_type
**field_type
,
2581 struct bt_ctf_field_type_variant
*variant
;
2582 struct structure_field
*field
;
2586 BT_LOGW_STR("Invalid parameter: field type is NULL.");
2591 if (type
->id
!= BT_CTF_FIELD_TYPE_ID_VARIANT
) {
2592 BT_LOGW("Invalid parameter: field type is not a variant field type: "
2593 "addr=%p, ft-id=%s", type
,
2594 bt_ctf_field_type_id_string(type
->id
));
2599 variant
= container_of(type
, struct bt_ctf_field_type_variant
,
2601 if (index
>= variant
->fields
->len
) {
2602 BT_LOGW("Invalid parameter: index is out of bounds: "
2603 "addr=%p, index=%" PRIu64
", count=%u",
2604 type
, index
, variant
->fields
->len
);
2609 field
= g_ptr_array_index(variant
->fields
, index
);
2611 *field_type
= field
->type
;
2612 bt_get(field
->type
);
2615 *field_name
= g_quark_to_string(field
->name
);
2616 assert(*field_name
);
2622 struct bt_ctf_field_type
*bt_ctf_field_type_array_create(
2623 struct bt_ctf_field_type
*element_type
,
2624 unsigned int length
)
2626 struct bt_ctf_field_type_array
*array
= NULL
;
2628 BT_LOGD("Creating array field type object: element-ft-addr=%p, "
2629 "length=%u", element_type
, length
);
2631 if (!element_type
) {
2632 BT_LOGW_STR("Invalid parameter: element field type is NULL.");
2637 BT_LOGW_STR("Invalid parameter: length is zero.");
2641 array
= g_new0(struct bt_ctf_field_type_array
, 1);
2643 BT_LOGE_STR("Failed to allocate one array field type.");
2647 array
->parent
.id
= BT_CTF_FIELD_TYPE_ID_ARRAY
;
2648 bt_get(element_type
);
2649 array
->element_type
= element_type
;
2650 array
->length
= length
;
2651 bt_ctf_field_type_init(&array
->parent
, FALSE
);
2652 BT_LOGD("Created array field type object: addr=%p, "
2653 "element-ft-addr=%p, length=%u",
2654 &array
->parent
, element_type
, length
);
2655 return &array
->parent
;
2660 struct bt_ctf_field_type
*bt_ctf_field_type_array_get_element_type(
2661 struct bt_ctf_field_type
*type
)
2663 struct bt_ctf_field_type
*ret
= NULL
;
2664 struct bt_ctf_field_type_array
*array
;
2667 BT_LOGW_STR("Invalid parameter: field type is NULL.");
2671 if (type
->id
!= BT_CTF_FIELD_TYPE_ID_ARRAY
) {
2672 BT_LOGW("Invalid parameter: field type is not an array field type: "
2673 "addr=%p, ft-id=%s", type
,
2674 bt_ctf_field_type_id_string(type
->id
));
2678 array
= container_of(type
, struct bt_ctf_field_type_array
, parent
);
2679 ret
= array
->element_type
;
2686 int bt_ctf_field_type_array_set_element_type(struct bt_ctf_field_type
*type
,
2687 struct bt_ctf_field_type
*element_type
)
2690 struct bt_ctf_field_type_array
*array
;
2693 BT_LOGW_STR("Invalid parameter: array field type is NULL.");
2698 if (!element_type
) {
2699 BT_LOGW_STR("Invalid parameter: element field type is NULL.");
2704 if (type
->id
!= BT_CTF_FIELD_TYPE_ID_ARRAY
) {
2705 BT_LOGW("Invalid parameter: field type is not an array field type: "
2706 "addr=%p, ft-id=%s", type
,
2707 bt_ctf_field_type_id_string(type
->id
));
2712 array
= container_of(type
, struct bt_ctf_field_type_array
, parent
);
2714 if (array
->element_type
) {
2715 BT_PUT(array
->element_type
);
2718 array
->element_type
= element_type
;
2719 bt_get(array
->element_type
);
2720 BT_LOGV("Set array field type's element field type: array-ft-addr=%p, "
2721 "element-ft-addr=%p", type
, element_type
);
2727 int64_t bt_ctf_field_type_array_get_length(struct bt_ctf_field_type
*type
)
2730 struct bt_ctf_field_type_array
*array
;
2733 BT_LOGW_STR("Invalid parameter: field type is NULL.");
2738 if (type
->id
!= BT_CTF_FIELD_TYPE_ID_ARRAY
) {
2739 BT_LOGW("Invalid parameter: field type is not an array field type: "
2740 "addr=%p, ft-id=%s", type
,
2741 bt_ctf_field_type_id_string(type
->id
));
2746 array
= container_of(type
, struct bt_ctf_field_type_array
, parent
);
2747 ret
= (int64_t) array
->length
;
2752 struct bt_ctf_field_type
*bt_ctf_field_type_sequence_create(
2753 struct bt_ctf_field_type
*element_type
,
2754 const char *length_field_name
)
2756 struct bt_ctf_field_type_sequence
*sequence
= NULL
;
2758 BT_LOGD("Creating sequence field type object: element-ft-addr=%p, "
2759 "length-field-name=\"%s\"", element_type
, length_field_name
);
2761 if (!element_type
) {
2762 BT_LOGW_STR("Invalid parameter: element field type is NULL.");
2766 if (bt_ctf_validate_identifier(length_field_name
)) {
2767 BT_LOGW("Invalid parameter: length field name is not a valid CTF identifier: "
2768 "length-field-name=\"%s\"", length_field_name
);
2772 sequence
= g_new0(struct bt_ctf_field_type_sequence
, 1);
2774 BT_LOGE_STR("Failed to allocate one sequence field type.");
2778 sequence
->parent
.id
= BT_CTF_FIELD_TYPE_ID_SEQUENCE
;
2779 bt_get(element_type
);
2780 sequence
->element_type
= element_type
;
2781 sequence
->length_field_name
= g_string_new(length_field_name
);
2782 bt_ctf_field_type_init(&sequence
->parent
, FALSE
);
2783 BT_LOGD("Created sequence field type object: addr=%p, "
2784 "element-ft-addr=%p, length-field-name=\"%s\"",
2785 &sequence
->parent
, element_type
, length_field_name
);
2786 return &sequence
->parent
;
2791 struct bt_ctf_field_type
*bt_ctf_field_type_sequence_get_element_type(
2792 struct bt_ctf_field_type
*type
)
2794 struct bt_ctf_field_type
*ret
= NULL
;
2795 struct bt_ctf_field_type_sequence
*sequence
;
2798 BT_LOGW_STR("Invalid parameter: field type is NULL.");
2802 if (type
->id
!= BT_CTF_FIELD_TYPE_ID_SEQUENCE
) {
2803 BT_LOGW("Invalid parameter: field type is not a sequence field type: "
2804 "addr=%p, ft-id=%s", type
,
2805 bt_ctf_field_type_id_string(type
->id
));
2809 sequence
= container_of(type
, struct bt_ctf_field_type_sequence
,
2811 ret
= sequence
->element_type
;
2818 int bt_ctf_field_type_sequence_set_element_type(struct bt_ctf_field_type
*type
,
2819 struct bt_ctf_field_type
*element_type
)
2822 struct bt_ctf_field_type_sequence
*sequence
;
2825 BT_LOGW_STR("Invalid parameter: sequence field type is NULL.");
2830 if (!element_type
) {
2831 BT_LOGW_STR("Invalid parameter: element field type is NULL.");
2836 if (type
->id
!= BT_CTF_FIELD_TYPE_ID_SEQUENCE
) {
2837 BT_LOGW("Invalid parameter: field type is not a sequence field type: "
2838 "addr=%p, ft-id=%s", type
,
2839 bt_ctf_field_type_id_string(type
->id
));
2844 sequence
= container_of(type
, struct bt_ctf_field_type_sequence
, parent
);
2845 if (sequence
->element_type
) {
2846 BT_PUT(sequence
->element_type
);
2849 sequence
->element_type
= element_type
;
2850 bt_get(sequence
->element_type
);
2851 BT_LOGV("Set sequence field type's element field type: sequence-ft-addr=%p, "
2852 "element-ft-addr=%p", type
, element_type
);
2858 const char *bt_ctf_field_type_sequence_get_length_field_name(
2859 struct bt_ctf_field_type
*type
)
2861 const char *ret
= NULL
;
2862 struct bt_ctf_field_type_sequence
*sequence
;
2865 BT_LOGW_STR("Invalid parameter: field type is NULL.");
2869 if (type
->id
!= BT_CTF_FIELD_TYPE_ID_SEQUENCE
) {
2870 BT_LOGW("Invalid parameter: field type is not a sequence field type: "
2871 "addr=%p, ft-id=%s", type
,
2872 bt_ctf_field_type_id_string(type
->id
));
2876 sequence
= container_of(type
, struct bt_ctf_field_type_sequence
,
2878 ret
= sequence
->length_field_name
->str
;
2883 struct bt_ctf_field_type
*bt_ctf_field_type_string_create(void)
2885 struct bt_ctf_field_type_string
*string
=
2886 g_new0(struct bt_ctf_field_type_string
, 1);
2888 BT_LOGD_STR("Creating string field type object.");
2891 BT_LOGE_STR("Failed to allocate one string field type.");
2895 string
->parent
.id
= BT_CTF_FIELD_TYPE_ID_STRING
;
2896 bt_ctf_field_type_init(&string
->parent
, TRUE
);
2897 string
->encoding
= BT_CTF_STRING_ENCODING_UTF8
;
2898 string
->parent
.alignment
= CHAR_BIT
;
2899 BT_LOGD("Created string field type object: addr=%p", &string
->parent
);
2900 return &string
->parent
;
2903 enum bt_ctf_string_encoding
bt_ctf_field_type_string_get_encoding(
2904 struct bt_ctf_field_type
*type
)
2906 struct bt_ctf_field_type_string
*string
;
2907 enum bt_ctf_string_encoding ret
= BT_CTF_STRING_ENCODING_UNKNOWN
;
2910 BT_LOGW_STR("Invalid parameter: field type is NULL.");
2914 if (type
->id
!= BT_CTF_FIELD_TYPE_ID_STRING
) {
2915 BT_LOGW("Invalid parameter: field type is not a string field type: "
2916 "addr=%p, ft-id=%s", type
,
2917 bt_ctf_field_type_id_string(type
->id
));
2921 string
= container_of(type
, struct bt_ctf_field_type_string
,
2923 ret
= string
->encoding
;
2928 int bt_ctf_field_type_string_set_encoding(struct bt_ctf_field_type
*type
,
2929 enum bt_ctf_string_encoding encoding
)
2932 struct bt_ctf_field_type_string
*string
;
2935 BT_LOGW_STR("Invalid parameter: field type is NULL.");
2940 if (type
->id
!= BT_CTF_FIELD_TYPE_ID_STRING
) {
2941 BT_LOGW("Invalid parameter: field type is not a string field type: "
2942 "addr=%p, ft-id=%s", type
,
2943 bt_ctf_field_type_id_string(type
->id
));
2948 if ((encoding
!= BT_CTF_STRING_ENCODING_UTF8
&&
2949 encoding
!= BT_CTF_STRING_ENCODING_ASCII
)) {
2950 BT_LOGW("Invalid parameter: unknown string encoding: "
2951 "addr=%p, encoding=%d", type
, encoding
);
2956 string
= container_of(type
, struct bt_ctf_field_type_string
, parent
);
2957 string
->encoding
= encoding
;
2958 BT_LOGV("Set string field type's encoding: addr=%p, encoding=%s",
2959 type
, bt_ctf_string_encoding_string(encoding
));
2964 int bt_ctf_field_type_get_alignment(struct bt_ctf_field_type
*type
)
2967 enum bt_ctf_field_type_id type_id
;
2970 BT_LOGW_STR("Invalid parameter: field type is NULL.");
2976 ret
= (int) type
->alignment
;
2980 type_id
= bt_ctf_field_type_get_type_id(type
);
2982 case BT_CTF_FIELD_TYPE_ID_SEQUENCE
:
2984 struct bt_ctf_field_type
*element
=
2985 bt_ctf_field_type_sequence_get_element_type(type
);
2988 ret
= bt_ctf_field_type_get_alignment(element
);
2992 case BT_CTF_FIELD_TYPE_ID_ARRAY
:
2994 struct bt_ctf_field_type
*element
=
2995 bt_ctf_field_type_array_get_element_type(type
);
2998 ret
= bt_ctf_field_type_get_alignment(element
);
3002 case BT_CTF_FIELD_TYPE_ID_STRUCT
:
3004 int64_t i
, element_count
;
3006 element_count
= bt_ctf_field_type_structure_get_field_count(
3008 assert(element_count
>= 0);
3010 for (i
= 0; i
< element_count
; i
++) {
3011 struct bt_ctf_field_type
*field
;
3012 int field_alignment
;
3014 ret
= bt_ctf_field_type_structure_get_field_by_index(
3015 type
, NULL
, &field
, i
);
3018 field_alignment
= bt_ctf_field_type_get_alignment(
3021 if (field_alignment
< 0) {
3022 ret
= field_alignment
;
3026 type
->alignment
= MAX(field_alignment
, type
->alignment
);
3028 ret
= (int) type
->alignment
;
3031 case BT_CTF_FIELD_TYPE_ID_UNKNOWN
:
3032 BT_LOGW("Invalid parameter: unknown field type ID: "
3033 "addr=%p, ft-id=%d", type
, type_id
);
3037 ret
= (int) type
->alignment
;
3045 int is_power_of_two(unsigned int value
)
3047 return ((value
& (value
- 1)) == 0) && value
> 0;
3050 int bt_ctf_field_type_set_alignment(struct bt_ctf_field_type
*type
,
3051 unsigned int alignment
)
3054 enum bt_ctf_field_type_id type_id
;
3056 /* Alignment must be a power of two */
3058 BT_LOGW_STR("Invalid parameter: field type is NULL.");
3064 BT_LOGW("Invalid parameter: field type is frozen: addr=%p",
3070 if (!is_power_of_two(alignment
)) {
3071 BT_LOGW("Invalid parameter: alignment is not a power of two: "
3072 "addr=%p, align=%u", type
, alignment
);
3077 type_id
= bt_ctf_field_type_get_type_id(type
);
3078 if (type_id
== BT_CTF_FIELD_TYPE_ID_UNKNOWN
) {
3079 BT_LOGW("Invalid parameter: unknown field type ID: "
3080 "addr=%p, ft-id=%d", type
, type_id
);
3085 if (type
->id
== BT_CTF_FIELD_TYPE_ID_STRING
&&
3086 alignment
!= CHAR_BIT
) {
3087 BT_LOGW("Invalid parameter: alignment must be %u for a string field type: "
3088 "addr=%p, align=%u", CHAR_BIT
, type
, alignment
);
3093 if (type_id
== BT_CTF_FIELD_TYPE_ID_VARIANT
||
3094 type_id
== BT_CTF_FIELD_TYPE_ID_SEQUENCE
||
3095 type_id
== BT_CTF_FIELD_TYPE_ID_ARRAY
) {
3096 /* Setting an alignment on these types makes no sense */
3097 BT_LOGW("Invalid parameter: cannot set the alignment of this field type: "
3098 "addr=%p, ft-id=%s", type
,
3099 bt_ctf_field_type_id_string(type
->id
));
3104 type
->alignment
= alignment
;
3106 BT_LOGV("Set field type's alignment: addr=%p, align=%u",
3112 enum bt_ctf_byte_order
bt_ctf_field_type_get_byte_order(
3113 struct bt_ctf_field_type
*type
)
3115 enum bt_ctf_byte_order ret
= BT_CTF_BYTE_ORDER_UNKNOWN
;
3118 BT_LOGW_STR("Invalid parameter: field type is NULL.");
3123 case BT_CTF_FIELD_TYPE_ID_INTEGER
:
3125 struct bt_ctf_field_type_integer
*integer
= container_of(
3126 type
, struct bt_ctf_field_type_integer
, parent
);
3127 ret
= integer
->user_byte_order
;
3130 case BT_CTF_FIELD_TYPE_ID_ENUM
:
3132 struct bt_ctf_field_type_enumeration
*enum_ft
= container_of(
3133 type
, struct bt_ctf_field_type_enumeration
, parent
);
3134 ret
= bt_ctf_field_type_get_byte_order(enum_ft
->container
);
3137 case BT_CTF_FIELD_TYPE_ID_FLOAT
:
3139 struct bt_ctf_field_type_floating_point
*floating_point
=
3141 struct bt_ctf_field_type_floating_point
,
3143 ret
= floating_point
->user_byte_order
;
3147 BT_LOGW("Invalid parameter: cannot get the byte order of this field type: "
3148 "addr=%p, ft-id=%s", type
,
3149 bt_ctf_field_type_id_string(type
->id
));
3153 assert(ret
== BT_CTF_BYTE_ORDER_NATIVE
||
3154 ret
== BT_CTF_BYTE_ORDER_LITTLE_ENDIAN
||
3155 ret
== BT_CTF_BYTE_ORDER_BIG_ENDIAN
||
3156 ret
== BT_CTF_BYTE_ORDER_NETWORK
);
3162 int bt_ctf_field_type_set_byte_order(struct bt_ctf_field_type
*type
,
3163 enum bt_ctf_byte_order byte_order
)
3168 BT_LOGW_STR("Invalid parameter: field type is NULL.");
3174 BT_LOGW("Invalid parameter: field type is frozen: addr=%p",
3180 if (byte_order
!= BT_CTF_BYTE_ORDER_NATIVE
&&
3181 byte_order
!= BT_CTF_BYTE_ORDER_LITTLE_ENDIAN
&&
3182 byte_order
!= BT_CTF_BYTE_ORDER_BIG_ENDIAN
&&
3183 byte_order
!= BT_CTF_BYTE_ORDER_NETWORK
) {
3184 BT_LOGW("Invalid parameter: unknown byte order: "
3185 "addr=%p, bo=%s", type
,
3186 bt_ctf_byte_order_string(byte_order
));
3191 if (set_byte_order_funcs
[type
->id
]) {
3192 set_byte_order_funcs
[type
->id
](type
, byte_order
);
3195 BT_LOGV("Set field type's byte order: addr=%p, bo=%s",
3196 type
, bt_ctf_byte_order_string(byte_order
));
3202 enum bt_ctf_field_type_id
bt_ctf_field_type_get_type_id(
3203 struct bt_ctf_field_type
*type
)
3206 BT_LOGW_STR("Invalid parameter: field type is NULL.");
3207 return BT_CTF_FIELD_TYPE_ID_UNKNOWN
;
3213 int bt_ctf_field_type_is_integer(struct bt_ctf_field_type
*type
)
3215 return bt_ctf_field_type_get_type_id(type
) == BT_CTF_FIELD_TYPE_ID_INTEGER
;
3218 int bt_ctf_field_type_is_floating_point(struct bt_ctf_field_type
*type
)
3220 return bt_ctf_field_type_get_type_id(type
) == BT_CTF_FIELD_TYPE_ID_FLOAT
;
3223 int bt_ctf_field_type_is_enumeration(struct bt_ctf_field_type
*type
)
3225 return bt_ctf_field_type_get_type_id(type
) == BT_CTF_FIELD_TYPE_ID_ENUM
;
3228 int bt_ctf_field_type_is_string(struct bt_ctf_field_type
*type
)
3230 return bt_ctf_field_type_get_type_id(type
) == BT_CTF_FIELD_TYPE_ID_STRING
;
3233 int bt_ctf_field_type_is_structure(struct bt_ctf_field_type
*type
)
3235 return bt_ctf_field_type_get_type_id(type
) == BT_CTF_FIELD_TYPE_ID_STRUCT
;
3238 int bt_ctf_field_type_is_array(struct bt_ctf_field_type
*type
)
3240 return bt_ctf_field_type_get_type_id(type
) == BT_CTF_FIELD_TYPE_ID_ARRAY
;
3243 int bt_ctf_field_type_is_sequence(struct bt_ctf_field_type
*type
)
3245 return bt_ctf_field_type_get_type_id(type
) == BT_CTF_FIELD_TYPE_ID_SEQUENCE
;
3248 int bt_ctf_field_type_is_variant(struct bt_ctf_field_type
*type
)
3250 return bt_ctf_field_type_get_type_id(type
) == BT_CTF_FIELD_TYPE_ID_VARIANT
;
3253 /* Pre-2.0 CTF writer backward compatibility */
3254 void bt_ctf_field_type_get(struct bt_ctf_field_type
*type
)
3259 /* Pre-2.0 CTF writer backward compatibility */
3260 void bt_ctf_field_type_put(struct bt_ctf_field_type
*type
)
3266 void bt_ctf_field_type_freeze(struct bt_ctf_field_type
*type
)
3268 if (!type
|| type
->frozen
) {
3276 struct bt_ctf_field_type
*bt_ctf_field_type_variant_get_field_type_signed(
3277 struct bt_ctf_field_type_variant
*variant
,
3280 struct bt_ctf_field_type
*type
= NULL
;
3281 GQuark field_name_quark
;
3283 struct structure_field
*field_entry
;
3284 struct range_overlap_query query
= {
3285 .range_start
._signed
= tag_value
,
3286 .range_end
._signed
= tag_value
,
3291 g_ptr_array_foreach(variant
->tag
->entries
, check_ranges_overlap
,
3293 if (!query
.overlaps
) {
3297 field_name_quark
= query
.mapping_name
;
3298 if (!g_hash_table_lookup_extended(variant
->field_name_to_index
,
3299 GUINT_TO_POINTER(field_name_quark
), NULL
, &index
)) {
3303 field_entry
= g_ptr_array_index(variant
->fields
, (size_t) index
);
3304 type
= field_entry
->type
;
3310 struct bt_ctf_field_type
*bt_ctf_field_type_variant_get_field_type_unsigned(
3311 struct bt_ctf_field_type_variant
*variant
,
3314 struct bt_ctf_field_type
*type
= NULL
;
3315 GQuark field_name_quark
;
3317 struct structure_field
*field_entry
;
3318 struct range_overlap_query query
= {
3319 .range_start
._unsigned
= tag_value
,
3320 .range_end
._unsigned
= tag_value
,
3325 g_ptr_array_foreach(variant
->tag
->entries
,
3326 check_ranges_overlap_unsigned
,
3328 if (!query
.overlaps
) {
3332 field_name_quark
= query
.mapping_name
;
3333 if (!g_hash_table_lookup_extended(variant
->field_name_to_index
,
3334 GUINT_TO_POINTER(field_name_quark
), NULL
, &index
)) {
3338 field_entry
= g_ptr_array_index(variant
->fields
, (size_t)index
);
3339 type
= field_entry
->type
;
3345 int bt_ctf_field_type_serialize(struct bt_ctf_field_type
*type
,
3346 struct metadata_context
*context
)
3353 /* Make sure field type is valid before serializing it */
3354 ret
= bt_ctf_field_type_validate(type
);
3356 BT_LOGW("Cannot serialize field type's metadata: field type is invalid: "
3361 ret
= type
->serialize(type
, context
);
3366 struct bt_ctf_field_type
*bt_ctf_field_type_copy(struct bt_ctf_field_type
*type
)
3368 struct bt_ctf_field_type
*copy
= NULL
;
3371 BT_LOGW_STR("Invalid parameter: field type is NULL.");
3375 copy
= type_copy_funcs
[type
->id
](type
);
3377 BT_LOGE_STR("Cannot copy field type.");
3381 copy
->alignment
= type
->alignment
;
3387 int bt_ctf_field_type_structure_get_field_name_index(
3388 struct bt_ctf_field_type
*type
, const char *name
)
3393 struct bt_ctf_field_type_structure
*structure
;
3396 BT_LOGW_STR("Invalid parameter: field type is NULL.");
3402 BT_LOGW_STR("Invalid parameter: field name is NULL.");
3407 if (bt_ctf_field_type_get_type_id(type
) != BT_CTF_FIELD_TYPE_ID_STRUCT
) {
3408 BT_LOGW("Invalid parameter: field type is not a structure field type: "
3409 "addr=%p, ft-id=%s", type
,
3410 bt_ctf_field_type_id_string(type
->id
));
3415 name_quark
= g_quark_try_string(name
);
3417 BT_LOGE("Cannot get GQuark: string=\"%s\"", name
);
3422 structure
= container_of(type
, struct bt_ctf_field_type_structure
,
3424 if (!g_hash_table_lookup_extended(structure
->field_name_to_index
,
3425 GUINT_TO_POINTER(name_quark
),
3426 NULL
, (gpointer
*)&index
)) {
3436 int bt_ctf_field_type_variant_get_field_name_index(
3437 struct bt_ctf_field_type
*type
, const char *name
)
3442 struct bt_ctf_field_type_variant
*variant
;
3445 BT_LOGW_STR("Invalid parameter: variant field type is NULL.");
3451 BT_LOGW_STR("Invalid parameter: field name is NULL.");
3456 if (bt_ctf_field_type_get_type_id(type
) != BT_CTF_FIELD_TYPE_ID_VARIANT
) {
3457 BT_LOGW("Invalid parameter: field type is not a variant field type: "
3458 "addr=%p, ft-id=%s", type
,
3459 bt_ctf_field_type_id_string(type
->id
));
3464 name_quark
= g_quark_try_string(name
);
3466 BT_LOGE("Cannot get GQuark: string=\"%s\"", name
);
3471 variant
= container_of(type
, struct bt_ctf_field_type_variant
,
3473 if (!g_hash_table_lookup_extended(variant
->field_name_to_index
,
3474 GUINT_TO_POINTER(name_quark
),
3475 NULL
, (gpointer
*)&index
)) {
3485 int bt_ctf_field_type_sequence_set_length_field_path(
3486 struct bt_ctf_field_type
*type
,
3487 struct bt_ctf_field_path
*path
)
3490 struct bt_ctf_field_type_sequence
*sequence
;
3493 BT_LOGW_STR("Invalid parameter: field type is NULL.");
3498 if (bt_ctf_field_type_get_type_id(type
) != BT_CTF_FIELD_TYPE_ID_SEQUENCE
) {
3499 BT_LOGW("Invalid parameter: field type is not a sequence field type: "
3500 "addr=%p, ft-id=%s", type
,
3501 bt_ctf_field_type_id_string(type
->id
));
3506 sequence
= container_of(type
, struct bt_ctf_field_type_sequence
,
3509 BT_MOVE(sequence
->length_field_path
, path
);
3510 BT_LOGV("Set sequence field type's length field path: ft-addr=%p, "
3511 "field-path-addr=%p", type
, path
);
3517 int bt_ctf_field_type_variant_set_tag_field_path(struct bt_ctf_field_type
*type
,
3518 struct bt_ctf_field_path
*path
)
3521 struct bt_ctf_field_type_variant
*variant
;
3524 BT_LOGW_STR("Invalid parameter: field type is NULL.");
3529 if (bt_ctf_field_type_get_type_id(type
) != BT_CTF_FIELD_TYPE_ID_VARIANT
) {
3530 BT_LOGW("Invalid parameter: field type is not a variant field type: "
3531 "addr=%p, ft-id=%s", type
,
3532 bt_ctf_field_type_id_string(type
->id
));
3537 variant
= container_of(type
, struct bt_ctf_field_type_variant
,
3540 BT_MOVE(variant
->tag_field_path
, path
);
3541 BT_LOGV("Set variant field type's tag field path: ft-addr=%p, "
3542 "field-path-addr=%p", type
, path
);
3548 int bt_ctf_field_type_variant_set_tag_field_type(struct bt_ctf_field_type
*type
,
3549 struct bt_ctf_field_type
*tag
)
3552 struct bt_ctf_field_type_variant
*variant
;
3555 BT_LOGW_STR("Invalid parameter: variant field type is NULL.");
3561 BT_LOGW_STR("Invalid parameter: tag field type is NULL.");
3566 if (bt_ctf_field_type_get_type_id(tag
) != BT_CTF_FIELD_TYPE_ID_ENUM
) {
3567 BT_LOGW("Invalid parameter: field type is not an enumeration field type: "
3568 "addr=%p, ft-id=%s", type
,
3569 bt_ctf_field_type_id_string(type
->id
));
3574 variant
= container_of(type
, struct bt_ctf_field_type_variant
,
3578 bt_put(&variant
->tag
->parent
);
3580 variant
->tag
= container_of(tag
, struct bt_ctf_field_type_enumeration
,
3582 BT_LOGV("Set variant field type's tag field type: variant-ft-addr=%p, "
3583 "tag-ft-addr=%p", type
, tag
);
3589 void bt_ctf_field_type_integer_destroy(struct bt_ctf_field_type
*type
)
3591 struct bt_ctf_field_type_integer
*integer
=
3592 (struct bt_ctf_field_type_integer
*) type
;
3598 BT_LOGD("Destroying integer field type object: addr=%p", type
);
3599 BT_LOGD_STR("Putting mapped clock class.");
3600 bt_put(integer
->mapped_clock
);
3605 void bt_ctf_field_type_enumeration_destroy(struct bt_ctf_field_type
*type
)
3607 struct bt_ctf_field_type_enumeration
*enumeration
=
3608 (struct bt_ctf_field_type_enumeration
*) type
;
3614 BT_LOGD("Destroying enumeration field type object: addr=%p", type
);
3615 g_ptr_array_free(enumeration
->entries
, TRUE
);
3616 BT_LOGD_STR("Putting container field type.");
3617 bt_put(enumeration
->container
);
3618 g_free(enumeration
);
3622 void bt_ctf_field_type_floating_point_destroy(struct bt_ctf_field_type
*type
)
3624 struct bt_ctf_field_type_floating_point
*floating_point
=
3625 (struct bt_ctf_field_type_floating_point
*) type
;
3631 BT_LOGD("Destroying floating point number field type object: addr=%p", type
);
3632 g_free(floating_point
);
3636 void bt_ctf_field_type_structure_destroy(struct bt_ctf_field_type
*type
)
3638 struct bt_ctf_field_type_structure
*structure
=
3639 (struct bt_ctf_field_type_structure
*) type
;
3645 BT_LOGD("Destroying structure field type object: addr=%p", type
);
3646 g_ptr_array_free(structure
->fields
, TRUE
);
3647 g_hash_table_destroy(structure
->field_name_to_index
);
3652 void bt_ctf_field_type_variant_destroy(struct bt_ctf_field_type
*type
)
3654 struct bt_ctf_field_type_variant
*variant
=
3655 (struct bt_ctf_field_type_variant
*) type
;
3661 BT_LOGD("Destroying variant field type object: addr=%p", type
);
3662 g_ptr_array_free(variant
->fields
, TRUE
);
3663 g_hash_table_destroy(variant
->field_name_to_index
);
3664 g_string_free(variant
->tag_name
, TRUE
);
3665 BT_LOGD_STR("Putting tag field type.");
3666 bt_put(&variant
->tag
->parent
);
3667 BT_PUT(variant
->tag_field_path
);
3672 void bt_ctf_field_type_array_destroy(struct bt_ctf_field_type
*type
)
3674 struct bt_ctf_field_type_array
*array
=
3675 (struct bt_ctf_field_type_array
*) type
;
3681 BT_LOGD("Destroying array field type object: addr=%p", type
);
3682 BT_LOGD_STR("Putting element field type.");
3683 bt_put(array
->element_type
);
3688 void bt_ctf_field_type_sequence_destroy(struct bt_ctf_field_type
*type
)
3690 struct bt_ctf_field_type_sequence
*sequence
=
3691 (struct bt_ctf_field_type_sequence
*) type
;
3697 BT_LOGD("Destroying sequence field type object: addr=%p", type
);
3698 BT_LOGD_STR("Putting element field type.");
3699 bt_put(sequence
->element_type
);
3700 g_string_free(sequence
->length_field_name
, TRUE
);
3701 BT_LOGD_STR("Putting length field path.");
3702 BT_PUT(sequence
->length_field_path
);
3707 void bt_ctf_field_type_string_destroy(struct bt_ctf_field_type
*type
)
3709 struct bt_ctf_field_type_string
*string
=
3710 (struct bt_ctf_field_type_string
*) type
;
3716 BT_LOGD("Destroying string field type object: addr=%p", type
);
3721 void generic_field_type_freeze(struct bt_ctf_field_type
*type
)
3727 void bt_ctf_field_type_integer_freeze(struct bt_ctf_field_type
*type
)
3729 struct bt_ctf_field_type_integer
*integer_type
= container_of(
3730 type
, struct bt_ctf_field_type_integer
, parent
);
3732 BT_LOGD("Freezing integer field type object: addr=%p", type
);
3734 if (integer_type
->mapped_clock
) {
3735 BT_LOGD_STR("Freezing integer field type's mapped clock class.");
3736 bt_ctf_clock_class_freeze(integer_type
->mapped_clock
);
3739 generic_field_type_freeze(type
);
3743 void bt_ctf_field_type_enumeration_freeze(struct bt_ctf_field_type
*type
)
3745 struct bt_ctf_field_type_enumeration
*enumeration_type
= container_of(
3746 type
, struct bt_ctf_field_type_enumeration
, parent
);
3748 BT_LOGD("Freezing enumeration field type object: addr=%p", type
);
3749 set_enumeration_range_overlap(type
);
3750 generic_field_type_freeze(type
);
3751 BT_LOGD("Freezing enumeration field type object's container field type: int-ft-addr=%p",
3752 enumeration_type
->container
);
3753 bt_ctf_field_type_freeze(enumeration_type
->container
);
3757 void freeze_structure_field(struct structure_field
*field
)
3759 BT_LOGD("Freezing structure/variant field type field: field-addr=%p, "
3760 "field-ft-addr=%p, field-name=\"%s\"", field
,
3761 field
->type
, g_quark_to_string(field
->name
));
3762 bt_ctf_field_type_freeze(field
->type
);
3766 void bt_ctf_field_type_structure_freeze(struct bt_ctf_field_type
*type
)
3768 struct bt_ctf_field_type_structure
*structure_type
= container_of(
3769 type
, struct bt_ctf_field_type_structure
, parent
);
3771 /* Cache the alignment */
3772 BT_LOGD("Freezing structure field type object: addr=%p", type
);
3773 type
->alignment
= bt_ctf_field_type_get_alignment(type
);
3774 generic_field_type_freeze(type
);
3775 g_ptr_array_foreach(structure_type
->fields
,
3776 (GFunc
) freeze_structure_field
, NULL
);
3780 void bt_ctf_field_type_variant_freeze(struct bt_ctf_field_type
*type
)
3782 struct bt_ctf_field_type_variant
*variant_type
= container_of(
3783 type
, struct bt_ctf_field_type_variant
, parent
);
3785 BT_LOGD("Freezing variant field type object: addr=%p", type
);
3786 generic_field_type_freeze(type
);
3787 g_ptr_array_foreach(variant_type
->fields
,
3788 (GFunc
) freeze_structure_field
, NULL
);
3792 void bt_ctf_field_type_array_freeze(struct bt_ctf_field_type
*type
)
3794 struct bt_ctf_field_type_array
*array_type
= container_of(
3795 type
, struct bt_ctf_field_type_array
, parent
);
3797 /* Cache the alignment */
3798 BT_LOGD("Freezing array field type object: addr=%p", type
);
3799 type
->alignment
= bt_ctf_field_type_get_alignment(type
);
3800 generic_field_type_freeze(type
);
3801 BT_LOGD("Freezing array field type object's element field type: element-ft-addr=%p",
3802 array_type
->element_type
);
3803 bt_ctf_field_type_freeze(array_type
->element_type
);
3807 void bt_ctf_field_type_sequence_freeze(struct bt_ctf_field_type
*type
)
3809 struct bt_ctf_field_type_sequence
*sequence_type
= container_of(
3810 type
, struct bt_ctf_field_type_sequence
, parent
);
3812 /* Cache the alignment */
3813 BT_LOGD("Freezing sequence field type object: addr=%p", type
);
3814 type
->alignment
= bt_ctf_field_type_get_alignment(type
);
3815 generic_field_type_freeze(type
);
3816 BT_LOGD("Freezing sequence field type object's element field type: element-ft-addr=%p",
3817 sequence_type
->element_type
);
3818 bt_ctf_field_type_freeze(sequence_type
->element_type
);
3822 const char *get_encoding_string(enum bt_ctf_string_encoding encoding
)
3824 const char *encoding_string
;
3827 case BT_CTF_STRING_ENCODING_NONE
:
3828 encoding_string
= "none";
3830 case BT_CTF_STRING_ENCODING_ASCII
:
3831 encoding_string
= "ASCII";
3833 case BT_CTF_STRING_ENCODING_UTF8
:
3834 encoding_string
= "UTF8";
3837 encoding_string
= "unknown";
3841 return encoding_string
;
3845 const char *get_integer_base_string(enum bt_ctf_integer_base base
)
3847 const char *base_string
;
3850 case BT_CTF_INTEGER_BASE_DECIMAL
:
3851 base_string
= "decimal";
3853 case BT_CTF_INTEGER_BASE_HEXADECIMAL
:
3854 base_string
= "hexadecimal";
3856 case BT_CTF_INTEGER_BASE_OCTAL
:
3857 base_string
= "octal";
3859 case BT_CTF_INTEGER_BASE_BINARY
:
3860 base_string
= "binary";
3863 base_string
= "unknown";
3871 int bt_ctf_field_type_integer_serialize(struct bt_ctf_field_type
*type
,
3872 struct metadata_context
*context
)
3874 struct bt_ctf_field_type_integer
*integer
= container_of(type
,
3875 struct bt_ctf_field_type_integer
, parent
);
3878 BT_LOGD("Serializing integer field type's metadata: "
3879 "ft-addr=%p, metadata-context-addr=%p", type
, context
);
3880 g_string_append_printf(context
->string
,
3881 "integer { size = %u; align = %u; signed = %s; encoding = %s; base = %s; byte_order = %s",
3882 integer
->size
, type
->alignment
,
3883 (integer
->is_signed
? "true" : "false"),
3884 get_encoding_string(integer
->encoding
),
3885 get_integer_base_string(integer
->base
),
3886 get_byte_order_string(integer
->user_byte_order
));
3887 if (integer
->mapped_clock
) {
3888 const char *clock_name
= bt_ctf_clock_class_get_name(
3889 integer
->mapped_clock
);
3892 g_string_append_printf(context
->string
,
3893 "; map = clock.%s.value", clock_name
);
3896 g_string_append(context
->string
, "; }");
3901 int bt_ctf_field_type_enumeration_serialize(struct bt_ctf_field_type
*type
,
3902 struct metadata_context
*context
)
3906 struct bt_ctf_field_type_enumeration
*enumeration
= container_of(type
,
3907 struct bt_ctf_field_type_enumeration
, parent
);
3908 struct bt_ctf_field_type
*container_type
;
3909 int container_signed
;
3911 BT_LOGD("Serializing enumeration field type's metadata: "
3912 "ft-addr=%p, metadata-context-addr=%p", type
, context
);
3913 container_type
= bt_ctf_field_type_enumeration_get_container_type(type
);
3914 assert(container_type
);
3915 container_signed
= bt_ctf_field_type_integer_get_signed(container_type
);
3916 assert(container_signed
>= 0);
3917 g_string_append(context
->string
, "enum : ");
3918 BT_LOGD_STR("Serializing enumeration field type's container field type's metadata.");
3919 ret
= bt_ctf_field_type_serialize(enumeration
->container
, context
);
3921 BT_LOGW("Cannot serialize enumeration field type's container field type's metadata: "
3922 "container-ft-addr=%p", enumeration
->container
);
3926 g_string_append(context
->string
, " { ");
3927 for (entry
= 0; entry
< enumeration
->entries
->len
; entry
++) {
3928 struct enumeration_mapping
*mapping
=
3929 enumeration
->entries
->pdata
[entry
];
3931 if (container_signed
) {
3932 if (mapping
->range_start
._signed
==
3933 mapping
->range_end
._signed
) {
3934 g_string_append_printf(context
->string
,
3935 "\"%s\" = %" PRId64
,
3936 g_quark_to_string(mapping
->string
),
3937 mapping
->range_start
._signed
);
3939 g_string_append_printf(context
->string
,
3940 "\"%s\" = %" PRId64
" ... %" PRId64
,
3941 g_quark_to_string(mapping
->string
),
3942 mapping
->range_start
._signed
,
3943 mapping
->range_end
._signed
);
3946 if (mapping
->range_start
._unsigned
==
3947 mapping
->range_end
._unsigned
) {
3948 g_string_append_printf(context
->string
,
3949 "\"%s\" = %" PRIu64
,
3950 g_quark_to_string(mapping
->string
),
3951 mapping
->range_start
._unsigned
);
3953 g_string_append_printf(context
->string
,
3954 "\"%s\" = %" PRIu64
" ... %" PRIu64
,
3955 g_quark_to_string(mapping
->string
),
3956 mapping
->range_start
._unsigned
,
3957 mapping
->range_end
._unsigned
);
3961 g_string_append(context
->string
,
3962 ((entry
!= (enumeration
->entries
->len
- 1)) ?
3966 if (context
->field_name
->len
) {
3967 g_string_append_printf(context
->string
, " %s",
3968 context
->field_name
->str
);
3969 g_string_assign(context
->field_name
, "");
3972 bt_put(container_type
);
3977 int bt_ctf_field_type_floating_point_serialize(struct bt_ctf_field_type
*type
,
3978 struct metadata_context
*context
)
3980 struct bt_ctf_field_type_floating_point
*floating_point
= container_of(
3981 type
, struct bt_ctf_field_type_floating_point
, parent
);
3983 BT_LOGD("Serializing floating point number field type's metadata: "
3984 "ft-addr=%p, metadata-context-addr=%p", type
, context
);
3985 g_string_append_printf(context
->string
,
3986 "floating_point { exp_dig = %u; mant_dig = %u; byte_order = %s; align = %u; }",
3987 floating_point
->exp_dig
,
3988 floating_point
->mant_dig
,
3989 get_byte_order_string(floating_point
->user_byte_order
),
3995 int bt_ctf_field_type_structure_serialize(struct bt_ctf_field_type
*type
,
3996 struct metadata_context
*context
)
3999 unsigned int indent
;
4001 struct bt_ctf_field_type_structure
*structure
= container_of(type
,
4002 struct bt_ctf_field_type_structure
, parent
);
4003 GString
*structure_field_name
= context
->field_name
;
4005 BT_LOGD("Serializing structure field type's metadata: "
4006 "ft-addr=%p, metadata-context-addr=%p", type
, context
);
4007 context
->field_name
= g_string_new("");
4009 context
->current_indentation_level
++;
4010 g_string_append(context
->string
, "struct {\n");
4012 for (i
= 0; i
< structure
->fields
->len
; i
++) {
4013 struct structure_field
*field
= structure
->fields
->pdata
[i
];
4015 BT_LOGD("Serializing structure field type's field metadata: "
4016 "index=%" PRId64
", "
4017 "field-ft-addr=%p, field-name=\"%s\"",
4018 i
, field
, g_quark_to_string(field
->name
));
4020 for (indent
= 0; indent
< context
->current_indentation_level
;
4022 g_string_append_c(context
->string
, '\t');
4025 g_string_assign(context
->field_name
,
4026 g_quark_to_string(field
->name
));
4027 ret
= bt_ctf_field_type_serialize(field
->type
, context
);
4029 BT_LOGW("Cannot serialize structure field type's field's metadata: "
4030 "index=%" PRId64
", "
4031 "field-ft-addr=%p, field-name=\"%s\"",
4033 g_quark_to_string(field
->name
));
4037 if (context
->field_name
->len
) {
4038 g_string_append_printf(context
->string
, " %s",
4039 context
->field_name
->str
);
4041 g_string_append(context
->string
, ";\n");
4044 context
->current_indentation_level
--;
4045 for (indent
= 0; indent
< context
->current_indentation_level
;
4047 g_string_append_c(context
->string
, '\t');
4050 g_string_append_printf(context
->string
, "} align(%u)",
4053 g_string_free(context
->field_name
, TRUE
);
4054 context
->field_name
= structure_field_name
;
4059 int bt_ctf_field_type_variant_serialize(struct bt_ctf_field_type
*type
,
4060 struct metadata_context
*context
)
4063 unsigned int indent
;
4065 struct bt_ctf_field_type_variant
*variant
= container_of(
4066 type
, struct bt_ctf_field_type_variant
, parent
);
4067 GString
*variant_field_name
= context
->field_name
;
4069 BT_LOGD("Serializing variant field type's metadata: "
4070 "ft-addr=%p, metadata-context-addr=%p", type
, context
);
4071 context
->field_name
= g_string_new("");
4072 if (variant
->tag_name
->len
> 0) {
4073 g_string_append_printf(context
->string
,
4074 "variant <%s> {\n", variant
->tag_name
->str
);
4076 g_string_append(context
->string
, "variant {\n");
4079 context
->current_indentation_level
++;
4080 for (i
= 0; i
< variant
->fields
->len
; i
++) {
4081 struct structure_field
*field
= variant
->fields
->pdata
[i
];
4083 BT_LOGD("Serializing variant field type's field metadata: "
4084 "index=%" PRId64
", "
4085 "field-ft-addr=%p, field-name=\"%s\"",
4086 i
, field
, g_quark_to_string(field
->name
));
4088 g_string_assign(context
->field_name
,
4089 g_quark_to_string(field
->name
));
4090 for (indent
= 0; indent
< context
->current_indentation_level
;
4092 g_string_append_c(context
->string
, '\t');
4095 g_string_assign(context
->field_name
,
4096 g_quark_to_string(field
->name
));
4097 ret
= bt_ctf_field_type_serialize(field
->type
, context
);
4099 BT_LOGW("Cannot serialize variant field type's field's metadata: "
4100 "index=%" PRId64
", "
4101 "field-ft-addr=%p, field-name=\"%s\"",
4103 g_quark_to_string(field
->name
));
4107 if (context
->field_name
->len
) {
4108 g_string_append_printf(context
->string
, " %s;",
4109 context
->field_name
->str
);
4112 g_string_append_c(context
->string
, '\n');
4115 context
->current_indentation_level
--;
4116 for (indent
= 0; indent
< context
->current_indentation_level
;
4118 g_string_append_c(context
->string
, '\t');
4121 g_string_append(context
->string
, "}");
4123 g_string_free(context
->field_name
, TRUE
);
4124 context
->field_name
= variant_field_name
;
4129 int bt_ctf_field_type_array_serialize(struct bt_ctf_field_type
*type
,
4130 struct metadata_context
*context
)
4133 struct bt_ctf_field_type_array
*array
= container_of(type
,
4134 struct bt_ctf_field_type_array
, parent
);
4136 BT_LOGD("Serializing array field type's metadata: "
4137 "ft-addr=%p, metadata-context-addr=%p", type
, context
);
4138 BT_LOGD_STR("Serializing array field type's element field type's metadata.");
4139 ret
= bt_ctf_field_type_serialize(array
->element_type
, context
);
4141 BT_LOGW("Cannot serialize array field type's element field type's metadata: "
4142 "element-ft-addr=%p", array
->element_type
);
4146 if (context
->field_name
->len
) {
4147 g_string_append_printf(context
->string
, " %s[%u]",
4148 context
->field_name
->str
, array
->length
);
4149 g_string_assign(context
->field_name
, "");
4151 g_string_append_printf(context
->string
, "[%u]", array
->length
);
4158 int bt_ctf_field_type_sequence_serialize(struct bt_ctf_field_type
*type
,
4159 struct metadata_context
*context
)
4162 struct bt_ctf_field_type_sequence
*sequence
= container_of(
4163 type
, struct bt_ctf_field_type_sequence
, parent
);
4165 BT_LOGD("Serializing sequence field type's metadata: "
4166 "ft-addr=%p, metadata-context-addr=%p", type
, context
);
4167 BT_LOGD_STR("Serializing sequence field type's element field type's metadata.");
4168 ret
= bt_ctf_field_type_serialize(sequence
->element_type
, context
);
4170 BT_LOGW("Cannot serialize sequence field type's element field type's metadata: "
4171 "element-ft-addr=%p", sequence
->element_type
);
4175 if (context
->field_name
->len
) {
4176 g_string_append_printf(context
->string
, " %s[%s]",
4177 context
->field_name
->str
,
4178 sequence
->length_field_name
->str
);
4179 g_string_assign(context
->field_name
, "");
4181 g_string_append_printf(context
->string
, "[%s]",
4182 sequence
->length_field_name
->str
);
4189 int bt_ctf_field_type_string_serialize(struct bt_ctf_field_type
*type
,
4190 struct metadata_context
*context
)
4192 struct bt_ctf_field_type_string
*string
= container_of(
4193 type
, struct bt_ctf_field_type_string
, parent
);
4195 BT_LOGD("Serializing string field type's metadata: "
4196 "ft-addr=%p, metadata-context-addr=%p", type
, context
);
4197 g_string_append_printf(context
->string
,
4198 "string { encoding = %s; }",
4199 get_encoding_string(string
->encoding
));
4204 void bt_ctf_field_type_integer_set_byte_order(struct bt_ctf_field_type
*type
,
4205 enum bt_ctf_byte_order byte_order
)
4207 struct bt_ctf_field_type_integer
*integer_type
= container_of(type
,
4208 struct bt_ctf_field_type_integer
, parent
);
4210 integer_type
->user_byte_order
= byte_order
;
4214 void bt_ctf_field_type_enumeration_set_byte_order(
4215 struct bt_ctf_field_type
*type
, enum bt_ctf_byte_order byte_order
)
4217 struct bt_ctf_field_type_enumeration
*enum_type
= container_of(type
,
4218 struct bt_ctf_field_type_enumeration
, parent
);
4220 /* Safe to assume that container is an integer */
4221 bt_ctf_field_type_integer_set_byte_order(enum_type
->container
,
4226 void bt_ctf_field_type_floating_point_set_byte_order(
4227 struct bt_ctf_field_type
*type
, enum bt_ctf_byte_order byte_order
)
4229 struct bt_ctf_field_type_floating_point
*floating_point_type
=
4230 container_of(type
, struct bt_ctf_field_type_floating_point
,
4233 floating_point_type
->user_byte_order
= byte_order
;
4237 void bt_ctf_field_type_structure_set_byte_order(struct bt_ctf_field_type
*type
,
4238 enum bt_ctf_byte_order byte_order
)
4241 struct bt_ctf_field_type_structure
*structure_type
=
4242 container_of(type
, struct bt_ctf_field_type_structure
,
4245 for (i
= 0; i
< structure_type
->fields
->len
; i
++) {
4246 struct structure_field
*field
= g_ptr_array_index(
4247 structure_type
->fields
, i
);
4248 struct bt_ctf_field_type
*field_type
= field
->type
;
4250 if (set_byte_order_funcs
[field_type
->id
]) {
4251 set_byte_order_funcs
[field_type
->id
](
4252 field_type
, byte_order
);
4258 void bt_ctf_field_type_variant_set_byte_order(struct bt_ctf_field_type
*type
,
4259 enum bt_ctf_byte_order byte_order
)
4262 struct bt_ctf_field_type_variant
*variant_type
=
4263 container_of(type
, struct bt_ctf_field_type_variant
,
4266 for (i
= 0; i
< variant_type
->fields
->len
; i
++) {
4267 struct structure_field
*field
= g_ptr_array_index(
4268 variant_type
->fields
, i
);
4269 struct bt_ctf_field_type
*field_type
= field
->type
;
4271 if (set_byte_order_funcs
[field_type
->id
]) {
4272 set_byte_order_funcs
[field_type
->id
](
4273 field_type
, byte_order
);
4279 void bt_ctf_field_type_array_set_byte_order(struct bt_ctf_field_type
*type
,
4280 enum bt_ctf_byte_order byte_order
)
4282 struct bt_ctf_field_type_array
*array_type
=
4283 container_of(type
, struct bt_ctf_field_type_array
,
4286 if (set_byte_order_funcs
[array_type
->element_type
->id
]) {
4287 set_byte_order_funcs
[array_type
->element_type
->id
](
4288 array_type
->element_type
, byte_order
);
4293 void bt_ctf_field_type_sequence_set_byte_order(struct bt_ctf_field_type
*type
,
4294 enum bt_ctf_byte_order byte_order
)
4296 struct bt_ctf_field_type_sequence
*sequence_type
=
4297 container_of(type
, struct bt_ctf_field_type_sequence
,
4300 if (set_byte_order_funcs
[
4301 sequence_type
->element_type
->id
]) {
4302 set_byte_order_funcs
[
4303 sequence_type
->element_type
->id
](
4304 sequence_type
->element_type
, byte_order
);
4309 struct bt_ctf_field_type
*bt_ctf_field_type_integer_copy(
4310 struct bt_ctf_field_type
*type
)
4312 struct bt_ctf_field_type
*copy
;
4313 struct bt_ctf_field_type_integer
*integer
, *copy_integer
;
4315 BT_LOGD("Copying integer field type's: addr=%p", type
);
4316 integer
= container_of(type
, struct bt_ctf_field_type_integer
, parent
);
4317 copy
= bt_ctf_field_type_integer_create(integer
->size
);
4319 BT_LOGE_STR("Cannot create integer field type.");
4323 copy_integer
= container_of(copy
, struct bt_ctf_field_type_integer
,
4325 copy_integer
->mapped_clock
= bt_get(integer
->mapped_clock
);
4326 copy_integer
->user_byte_order
= integer
->user_byte_order
;
4327 copy_integer
->is_signed
= integer
->is_signed
;
4328 copy_integer
->size
= integer
->size
;
4329 copy_integer
->base
= integer
->base
;
4330 copy_integer
->encoding
= integer
->encoding
;
4331 BT_LOGD("Copied integer field type: original-ft-addr=%p, copy-ft-addr=%p",
4339 struct bt_ctf_field_type
*bt_ctf_field_type_enumeration_copy(
4340 struct bt_ctf_field_type
*type
)
4343 struct bt_ctf_field_type
*copy
= NULL
, *copy_container
;
4344 struct bt_ctf_field_type_enumeration
*enumeration
, *copy_enumeration
;
4346 BT_LOGD("Copying enumeration field type's: addr=%p", type
);
4347 enumeration
= container_of(type
, struct bt_ctf_field_type_enumeration
,
4350 /* Copy the source enumeration's container */
4351 BT_LOGD_STR("Copying enumeration field type's container field type.");
4352 copy_container
= bt_ctf_field_type_copy(enumeration
->container
);
4353 if (!copy_container
) {
4354 BT_LOGE_STR("Cannot copy enumeration field type's container field type.");
4358 copy
= bt_ctf_field_type_enumeration_create(copy_container
);
4360 BT_LOGE_STR("Cannot create enumeration field type.");
4363 copy_enumeration
= container_of(copy
,
4364 struct bt_ctf_field_type_enumeration
, parent
);
4366 /* Copy all enumaration entries */
4367 for (i
= 0; i
< enumeration
->entries
->len
; i
++) {
4368 struct enumeration_mapping
*mapping
= g_ptr_array_index(
4369 enumeration
->entries
, i
);
4370 struct enumeration_mapping
*copy_mapping
= g_new0(
4371 struct enumeration_mapping
, 1);
4373 if (!copy_mapping
) {
4374 BT_LOGE_STR("Failed to allocate one enumeration mapping.");
4378 *copy_mapping
= *mapping
;
4379 g_ptr_array_add(copy_enumeration
->entries
, copy_mapping
);
4382 BT_LOGD("Copied enumeration field type: original-ft-addr=%p, copy-ft-addr=%p",
4386 bt_put(copy_container
);
4389 bt_put(copy_container
);
4395 struct bt_ctf_field_type
*bt_ctf_field_type_floating_point_copy(
4396 struct bt_ctf_field_type
*type
)
4398 struct bt_ctf_field_type
*copy
;
4399 struct bt_ctf_field_type_floating_point
*floating_point
, *copy_float
;
4401 BT_LOGD("Copying floating point number field type's: addr=%p", type
);
4402 floating_point
= container_of(type
,
4403 struct bt_ctf_field_type_floating_point
, parent
);
4404 copy
= bt_ctf_field_type_floating_point_create();
4406 BT_LOGE_STR("Cannot create floating point number field type.");
4410 copy_float
= container_of(copy
,
4411 struct bt_ctf_field_type_floating_point
, parent
);
4412 copy_float
->user_byte_order
= floating_point
->user_byte_order
;
4413 copy_float
->exp_dig
= floating_point
->exp_dig
;
4414 copy_float
->mant_dig
= floating_point
->mant_dig
;
4415 BT_LOGD("Copied floating point number field type: original-ft-addr=%p, copy-ft-addr=%p",
4422 struct bt_ctf_field_type
*bt_ctf_field_type_structure_copy(
4423 struct bt_ctf_field_type
*type
)
4426 GHashTableIter iter
;
4427 gpointer key
, value
;
4428 struct bt_ctf_field_type
*copy
;
4429 struct bt_ctf_field_type_structure
*structure
, *copy_structure
;
4431 BT_LOGD("Copying structure field type's: addr=%p", type
);
4432 structure
= container_of(type
, struct bt_ctf_field_type_structure
,
4434 copy
= bt_ctf_field_type_structure_create();
4436 BT_LOGE_STR("Cannot create structure field type.");
4440 copy_structure
= container_of(copy
,
4441 struct bt_ctf_field_type_structure
, parent
);
4443 /* Copy field_name_to_index */
4444 g_hash_table_iter_init(&iter
, structure
->field_name_to_index
);
4445 while (g_hash_table_iter_next (&iter
, &key
, &value
)) {
4446 g_hash_table_insert(copy_structure
->field_name_to_index
,
4450 for (i
= 0; i
< structure
->fields
->len
; i
++) {
4451 struct structure_field
*entry
, *copy_entry
;
4452 struct bt_ctf_field_type
*copy_field
;
4454 entry
= g_ptr_array_index(structure
->fields
, i
);
4455 BT_LOGD("Copying structure field type's field: "
4456 "index=%" PRId64
", "
4457 "field-ft-addr=%p, field-name=\"%s\"",
4458 i
, entry
, g_quark_to_string(entry
->name
));
4459 copy_entry
= g_new0(struct structure_field
, 1);
4461 BT_LOGE_STR("Failed to allocate one structure field type field.");
4465 copy_field
= bt_ctf_field_type_copy(entry
->type
);
4467 BT_LOGE("Cannot copy structure field type's field: "
4468 "index=%" PRId64
", "
4469 "field-ft-addr=%p, field-name=\"%s\"",
4470 i
, entry
, g_quark_to_string(entry
->name
));
4475 copy_entry
->name
= entry
->name
;
4476 copy_entry
->type
= copy_field
;
4477 g_ptr_array_add(copy_structure
->fields
, copy_entry
);
4480 BT_LOGD("Copied structure field type: original-ft-addr=%p, copy-ft-addr=%p",
4491 struct bt_ctf_field_type
*bt_ctf_field_type_variant_copy(
4492 struct bt_ctf_field_type
*type
)
4495 GHashTableIter iter
;
4496 gpointer key
, value
;
4497 struct bt_ctf_field_type
*copy
= NULL
, *copy_tag
= NULL
;
4498 struct bt_ctf_field_type_variant
*variant
, *copy_variant
;
4500 BT_LOGD("Copying variant field type's: addr=%p", type
);
4501 variant
= container_of(type
, struct bt_ctf_field_type_variant
,
4504 BT_LOGD_STR("Copying variant field type's tag field type.");
4505 copy_tag
= bt_ctf_field_type_copy(&variant
->tag
->parent
);
4507 BT_LOGE_STR("Cannot copy variant field type's tag field type.");
4512 copy
= bt_ctf_field_type_variant_create(copy_tag
,
4513 variant
->tag_name
->len
? variant
->tag_name
->str
: NULL
);
4515 BT_LOGE_STR("Cannot create variant field type.");
4519 copy_variant
= container_of(copy
, struct bt_ctf_field_type_variant
,
4522 /* Copy field_name_to_index */
4523 g_hash_table_iter_init(&iter
, variant
->field_name_to_index
);
4524 while (g_hash_table_iter_next (&iter
, &key
, &value
)) {
4525 g_hash_table_insert(copy_variant
->field_name_to_index
,
4529 for (i
= 0; i
< variant
->fields
->len
; i
++) {
4530 struct structure_field
*entry
, *copy_entry
;
4531 struct bt_ctf_field_type
*copy_field
;
4533 entry
= g_ptr_array_index(variant
->fields
, i
);
4534 BT_LOGD("Copying variant field type's field: "
4535 "index=%" PRId64
", "
4536 "field-ft-addr=%p, field-name=\"%s\"",
4537 i
, entry
, g_quark_to_string(entry
->name
));
4538 copy_entry
= g_new0(struct structure_field
, 1);
4540 BT_LOGE_STR("Failed to allocate one variant field type field.");
4544 copy_field
= bt_ctf_field_type_copy(entry
->type
);
4546 BT_LOGE("Cannot copy variant field type's field: "
4547 "index=%" PRId64
", "
4548 "field-ft-addr=%p, field-name=\"%s\"",
4549 i
, entry
, g_quark_to_string(entry
->name
));
4554 copy_entry
->name
= entry
->name
;
4555 copy_entry
->type
= copy_field
;
4556 g_ptr_array_add(copy_variant
->fields
, copy_entry
);
4559 if (variant
->tag_field_path
) {
4560 BT_LOGD_STR("Copying variant field type's tag field path.");
4561 copy_variant
->tag_field_path
= bt_ctf_field_path_copy(
4562 variant
->tag_field_path
);
4563 if (!copy_variant
->tag_field_path
) {
4564 BT_LOGE_STR("Cannot copy variant field type's tag field path.");
4569 BT_LOGD("Copied variant field type: original-ft-addr=%p, copy-ft-addr=%p",
4582 struct bt_ctf_field_type
*bt_ctf_field_type_array_copy(
4583 struct bt_ctf_field_type
*type
)
4585 struct bt_ctf_field_type
*copy
= NULL
, *copy_element
;
4586 struct bt_ctf_field_type_array
*array
;
4588 BT_LOGD("Copying array field type's: addr=%p", type
);
4589 array
= container_of(type
, struct bt_ctf_field_type_array
,
4591 BT_LOGD_STR("Copying array field type's element field type.");
4592 copy_element
= bt_ctf_field_type_copy(array
->element_type
);
4593 if (!copy_element
) {
4594 BT_LOGE_STR("Cannot copy array field type's element field type.");
4598 copy
= bt_ctf_field_type_array_create(copy_element
, array
->length
);
4600 BT_LOGE_STR("Cannot create array field type.");
4604 BT_LOGD("Copied array field type: original-ft-addr=%p, copy-ft-addr=%p",
4608 bt_put(copy_element
);
4613 struct bt_ctf_field_type
*bt_ctf_field_type_sequence_copy(
4614 struct bt_ctf_field_type
*type
)
4616 struct bt_ctf_field_type
*copy
= NULL
, *copy_element
;
4617 struct bt_ctf_field_type_sequence
*sequence
, *copy_sequence
;
4619 BT_LOGD("Copying sequence field type's: addr=%p", type
);
4620 sequence
= container_of(type
, struct bt_ctf_field_type_sequence
,
4622 BT_LOGD_STR("Copying sequence field type's element field type.");
4623 copy_element
= bt_ctf_field_type_copy(sequence
->element_type
);
4624 if (!copy_element
) {
4625 BT_LOGE_STR("Cannot copy sequence field type's element field type.");
4629 copy
= bt_ctf_field_type_sequence_create(copy_element
,
4630 sequence
->length_field_name
->len
?
4631 sequence
->length_field_name
->str
: NULL
);
4633 BT_LOGE_STR("Cannot create sequence field type.");
4637 copy_sequence
= container_of(copy
, struct bt_ctf_field_type_sequence
,
4639 if (sequence
->length_field_path
) {
4640 BT_LOGD_STR("Copying sequence field type's length field path.");
4641 copy_sequence
->length_field_path
= bt_ctf_field_path_copy(
4642 sequence
->length_field_path
);
4643 if (!copy_sequence
->length_field_path
) {
4644 BT_LOGE_STR("Cannot copy sequence field type's length field path.");
4649 BT_LOGD("Copied sequence field type: original-ft-addr=%p, copy-ft-addr=%p",
4653 bt_put(copy_element
);
4661 struct bt_ctf_field_type
*bt_ctf_field_type_string_copy(
4662 struct bt_ctf_field_type
*type
)
4664 struct bt_ctf_field_type
*copy
;
4665 struct bt_ctf_field_type_string
*string
;
4667 BT_LOGD("Copying string field type's: addr=%p", type
);
4668 copy
= bt_ctf_field_type_string_create();
4670 BT_LOGE_STR("Cannot create string field type.");
4674 string
= container_of(type
, struct bt_ctf_field_type_string
,
4676 BT_LOGD("Copied string field type: original-ft-addr=%p, copy-ft-addr=%p",
4683 int bt_ctf_field_type_integer_compare(struct bt_ctf_field_type
*type_a
,
4684 struct bt_ctf_field_type
*type_b
)
4687 struct bt_ctf_field_type_integer
*int_type_a
;
4688 struct bt_ctf_field_type_integer
*int_type_b
;
4690 int_type_a
= container_of(type_a
, struct bt_ctf_field_type_integer
,
4692 int_type_b
= container_of(type_b
, struct bt_ctf_field_type_integer
,
4696 if (int_type_a
->size
!= int_type_b
->size
) {
4697 BT_LOGV("Integer field types differ: different sizes: "
4698 "ft-a-size=%u, ft-b-size=%u",
4699 int_type_a
->size
, int_type_b
->size
);
4704 if (int_type_a
->user_byte_order
!= int_type_b
->user_byte_order
) {
4705 BT_LOGV("Integer field types differ: different byte orders: "
4706 "ft-a-bo=%s, ft-b-bo=%s",
4707 bt_ctf_byte_order_string(int_type_a
->user_byte_order
),
4708 bt_ctf_byte_order_string(int_type_b
->user_byte_order
));
4713 if (int_type_a
->is_signed
!= int_type_b
->is_signed
) {
4714 BT_LOGV("Integer field types differ: different signedness: "
4715 "ft-a-is-signed=%d, ft-b-is-signed=%d",
4716 int_type_a
->is_signed
,
4717 int_type_b
->is_signed
);
4722 if (int_type_a
->base
!= int_type_b
->base
) {
4723 BT_LOGV("Integer field types differ: different bases: "
4724 "ft-a-base=%s, ft-b-base=%s",
4725 bt_ctf_integer_base_string(int_type_a
->base
),
4726 bt_ctf_integer_base_string(int_type_b
->base
));
4731 if (int_type_a
->encoding
!= int_type_b
->encoding
) {
4732 BT_LOGV("Integer field types differ: different encodings: "
4733 "ft-a-encoding=%s, ft-b-encoding=%s",
4734 bt_ctf_string_encoding_string(int_type_a
->encoding
),
4735 bt_ctf_string_encoding_string(int_type_b
->encoding
));
4740 if (int_type_a
->mapped_clock
!= int_type_b
->mapped_clock
) {
4741 BT_LOGV("Integer field types differ: different mapped clock classes: "
4742 "ft-a-mapped-clock-class-addr=%p, "
4743 "ft-b-mapped-clock-class-addr=%p, ",
4744 "ft-a-mapped-clock-class-name=\"%s\", ",
4745 "ft-b-mapped-clock-class-name=\"%s\"",
4746 int_type_a
->mapped_clock
, int_type_b
->mapped_clock
,
4747 int_type_a
->mapped_clock
? bt_ctf_clock_class_get_name(int_type_a
->mapped_clock
) : "",
4748 int_type_b
->mapped_clock
? bt_ctf_clock_class_get_name(int_type_b
->mapped_clock
) : "");
4760 int bt_ctf_field_type_floating_point_compare(struct bt_ctf_field_type
*type_a
,
4761 struct bt_ctf_field_type
*type_b
)
4764 struct bt_ctf_field_type_floating_point
*float_a
;
4765 struct bt_ctf_field_type_floating_point
*float_b
;
4767 float_a
= container_of(type_a
,
4768 struct bt_ctf_field_type_floating_point
, parent
);
4769 float_b
= container_of(type_b
,
4770 struct bt_ctf_field_type_floating_point
, parent
);
4773 if (float_a
->user_byte_order
!= float_b
->user_byte_order
) {
4774 BT_LOGV("Floating point number field types differ: different byte orders: "
4775 "ft-a-bo=%s, ft-b-bo=%s",
4776 bt_ctf_byte_order_string(float_a
->user_byte_order
),
4777 bt_ctf_byte_order_string(float_b
->user_byte_order
));
4781 /* Exponent length */
4782 if (float_a
->exp_dig
!= float_b
->exp_dig
) {
4783 BT_LOGV("Floating point number field types differ: different exponent sizes: "
4784 "ft-a-exp-size=%s, ft-b-exp-size=%s",
4785 float_a
->exp_dig
, float_b
->exp_dig
);
4789 /* Mantissa length */
4790 if (float_a
->mant_dig
!= float_b
->mant_dig
) {
4791 BT_LOGV("Floating point number field types differ: different mantissa sizes: "
4792 "ft-a-mant-size=%s, ft-b-mant-size=%s",
4793 float_a
->mant_dig
, float_b
->mant_dig
);
4805 int compare_enumeration_mappings(struct enumeration_mapping
*mapping_a
,
4806 struct enumeration_mapping
*mapping_b
)
4811 if (mapping_a
->string
!= mapping_b
->string
) {
4812 BT_LOGV("Enumeration field type mappings differ: different names: "
4813 "mapping-a-name=\"%s\", mapping-b-name=\"%s\"",
4814 g_quark_to_string(mapping_a
->string
),
4815 g_quark_to_string(mapping_b
->string
));
4820 if (mapping_a
->range_start
._unsigned
!=
4821 mapping_b
->range_start
._unsigned
) {
4822 BT_LOGV("Enumeration field type mappings differ: different starts of range: "
4823 "mapping-a-range-start-unsigned=%" PRIu64
", "
4824 "mapping-b-range-start-unsigned=%" PRIu64
,
4825 mapping_a
->range_start
._unsigned
,
4826 mapping_b
->range_start
._unsigned
);
4831 if (mapping_a
->range_end
._unsigned
!=
4832 mapping_b
->range_end
._unsigned
) {
4833 BT_LOGV("Enumeration field type mappings differ: different ends of range: "
4834 "mapping-a-range-end-unsigned=%" PRIu64
", "
4835 "mapping-b-range-end-unsigned=%" PRIu64
,
4836 mapping_a
->range_end
._unsigned
,
4837 mapping_b
->range_end
._unsigned
);
4849 int bt_ctf_field_type_enumeration_compare(struct bt_ctf_field_type
*type_a
,
4850 struct bt_ctf_field_type
*type_b
)
4854 struct bt_ctf_field_type_enumeration
*enum_a
;
4855 struct bt_ctf_field_type_enumeration
*enum_b
;
4857 enum_a
= container_of(type_a
,
4858 struct bt_ctf_field_type_enumeration
, parent
);
4859 enum_b
= container_of(type_b
,
4860 struct bt_ctf_field_type_enumeration
, parent
);
4862 /* Container field type */
4863 ret
= bt_ctf_field_type_compare(enum_a
->container
, enum_b
->container
);
4865 BT_LOGV("Enumeration field types differ: different container field types: "
4866 "ft-a-container-ft-addr=%p, ft-b-container-ft-addr=%p",
4867 enum_a
->container
, enum_b
->container
);
4874 if (enum_a
->entries
->len
!= enum_b
->entries
->len
) {
4878 for (i
= 0; i
< enum_a
->entries
->len
; ++i
) {
4879 struct enumeration_mapping
*mapping_a
=
4880 g_ptr_array_index(enum_a
->entries
, i
);
4881 struct enumeration_mapping
*mapping_b
=
4882 g_ptr_array_index(enum_b
->entries
, i
);
4884 if (compare_enumeration_mappings(mapping_a
, mapping_b
)) {
4885 BT_LOGV("Enumeration field types differ: different mappings: "
4886 "ft-a-mapping-addr=%p, ft-b-mapping-addr=%p, "
4887 "ft-a-mapping-name=\"%s\", ft-b-mapping-name=\"%s\"",
4888 mapping_a
, mapping_b
,
4889 g_quark_to_string(mapping_a
->string
),
4890 g_quark_to_string(mapping_b
->string
));
4903 int bt_ctf_field_type_string_compare(struct bt_ctf_field_type
*type_a
,
4904 struct bt_ctf_field_type
*type_b
)
4907 struct bt_ctf_field_type_string
*string_a
;
4908 struct bt_ctf_field_type_string
*string_b
;
4910 string_a
= container_of(type_a
,
4911 struct bt_ctf_field_type_string
, parent
);
4912 string_b
= container_of(type_b
,
4913 struct bt_ctf_field_type_string
, parent
);
4916 if (string_a
->encoding
!= string_b
->encoding
) {
4917 BT_LOGV("String field types differ: different encodings: "
4918 "ft-a-encoding=%s, ft-b-encoding=%s",
4919 bt_ctf_string_encoding_string(string_a
->encoding
),
4920 bt_ctf_string_encoding_string(string_b
->encoding
));
4932 int compare_structure_fields(struct structure_field
*field_a
,
4933 struct structure_field
*field_b
)
4938 if (field_a
->name
!= field_b
->name
) {
4939 BT_LOGV("Structure/variant field type fields differ: different names: "
4940 "field-a-name=%s, field-b-name=%s",
4941 g_quark_to_string(field_a
->name
),
4942 g_quark_to_string(field_b
->name
));
4947 ret
= bt_ctf_field_type_compare(field_a
->type
, field_b
->type
);
4949 BT_LOGV("Structure/variant field type fields differ: different field types: "
4950 "field-name=\"%s\", field-a-ft-addr=%s, field-b-ft-addr=%s",
4951 g_quark_to_string(field_a
->name
),
4952 field_a
->type
, field_b
->type
);
4960 int bt_ctf_field_type_structure_compare(struct bt_ctf_field_type
*type_a
,
4961 struct bt_ctf_field_type
*type_b
)
4965 struct bt_ctf_field_type_structure
*struct_a
;
4966 struct bt_ctf_field_type_structure
*struct_b
;
4968 struct_a
= container_of(type_a
,
4969 struct bt_ctf_field_type_structure
, parent
);
4970 struct_b
= container_of(type_b
,
4971 struct bt_ctf_field_type_structure
, parent
);
4974 if (bt_ctf_field_type_get_alignment(type_a
) !=
4975 bt_ctf_field_type_get_alignment(type_b
)) {
4976 BT_LOGV("Structure field types differ: different alignments: "
4977 "ft-a-align=%u, ft-b-align=%u",
4978 bt_ctf_field_type_get_alignment(type_a
),
4979 bt_ctf_field_type_get_alignment(type_b
));
4984 if (struct_a
->fields
->len
!= struct_b
->fields
->len
) {
4985 BT_LOGV("Structure field types differ: different field counts: "
4986 "ft-a-field-count=%u, ft-b-field-count=%u",
4987 struct_a
->fields
->len
, struct_b
->fields
->len
);
4991 for (i
= 0; i
< struct_a
->fields
->len
; ++i
) {
4992 struct structure_field
*field_a
=
4993 g_ptr_array_index(struct_a
->fields
, i
);
4994 struct structure_field
*field_b
=
4995 g_ptr_array_index(struct_b
->fields
, i
);
4997 ret
= compare_structure_fields(field_a
, field_b
);
4999 /* compare_structure_fields() logs what differs */
5000 BT_LOGV_STR("Structure field types differ: different fields.");
5013 int bt_ctf_field_type_variant_compare(struct bt_ctf_field_type
*type_a
,
5014 struct bt_ctf_field_type
*type_b
)
5018 struct bt_ctf_field_type_variant
*variant_a
;
5019 struct bt_ctf_field_type_variant
*variant_b
;
5021 variant_a
= container_of(type_a
,
5022 struct bt_ctf_field_type_variant
, parent
);
5023 variant_b
= container_of(type_b
,
5024 struct bt_ctf_field_type_variant
, parent
);
5027 if (strcmp(variant_a
->tag_name
->str
, variant_b
->tag_name
->str
)) {
5028 BT_LOGV("Variant field types differ: different tag field names: "
5029 "ft-a-tag-field-name=%u, ft-b-tag-field-name=%u",
5030 variant_a
->tag_name
->str
, variant_b
->tag_name
->str
);
5035 ret
= bt_ctf_field_type_compare(
5036 (struct bt_ctf_field_type
*) variant_a
->tag
,
5037 (struct bt_ctf_field_type
*) variant_b
->tag
);
5039 BT_LOGV("Variant field types differ: different tag field types: "
5040 "ft-a-tag-ft-addr=%p, ft-b-tag-ft-addr=%p",
5041 variant_a
->tag
, variant_b
->tag
);
5048 if (variant_a
->fields
->len
!= variant_b
->fields
->len
) {
5049 BT_LOGV("Structure field types differ: different field counts: "
5050 "ft-a-field-count=%u, ft-b-field-count=%u",
5051 variant_a
->fields
->len
, variant_b
->fields
->len
);
5055 for (i
= 0; i
< variant_a
->fields
->len
; ++i
) {
5056 struct structure_field
*field_a
=
5057 g_ptr_array_index(variant_a
->fields
, i
);
5058 struct structure_field
*field_b
=
5059 g_ptr_array_index(variant_b
->fields
, i
);
5061 ret
= compare_structure_fields(field_a
, field_b
);
5063 /* compare_structure_fields() logs what differs */
5064 BT_LOGV_STR("Variant field types differ: different fields.");
5077 int bt_ctf_field_type_array_compare(struct bt_ctf_field_type
*type_a
,
5078 struct bt_ctf_field_type
*type_b
)
5081 struct bt_ctf_field_type_array
*array_a
;
5082 struct bt_ctf_field_type_array
*array_b
;
5084 array_a
= container_of(type_a
,
5085 struct bt_ctf_field_type_array
, parent
);
5086 array_b
= container_of(type_b
,
5087 struct bt_ctf_field_type_array
, parent
);
5090 if (array_a
->length
!= array_b
->length
) {
5091 BT_LOGV("Structure field types differ: different lengths: "
5092 "ft-a-length=%u, ft-b-length=%u",
5093 array_a
->length
, array_b
->length
);
5098 ret
= bt_ctf_field_type_compare(array_a
->element_type
,
5099 array_b
->element_type
);
5101 BT_LOGV("Array field types differ: different element field types: "
5102 "ft-a-element-ft-addr=%p, ft-b-element-ft-addr=%p",
5103 array_a
->element_type
, array_b
->element_type
);
5111 int bt_ctf_field_type_sequence_compare(struct bt_ctf_field_type
*type_a
,
5112 struct bt_ctf_field_type
*type_b
)
5115 struct bt_ctf_field_type_sequence
*sequence_a
;
5116 struct bt_ctf_field_type_sequence
*sequence_b
;
5118 sequence_a
= container_of(type_a
,
5119 struct bt_ctf_field_type_sequence
, parent
);
5120 sequence_b
= container_of(type_b
,
5121 struct bt_ctf_field_type_sequence
, parent
);
5124 if (strcmp(sequence_a
->length_field_name
->str
,
5125 sequence_b
->length_field_name
->str
)) {
5126 BT_LOGV("Sequence field types differ: different length field names: "
5127 "ft-a-length-field-name=%u, ft-b-length-field-name=%u",
5128 sequence_a
->length_field_name
->str
,
5129 sequence_b
->length_field_name
->str
);
5134 ret
= bt_ctf_field_type_compare(sequence_a
->element_type
,
5135 sequence_b
->element_type
);
5137 BT_LOGV("Sequence field types differ: different element field types: "
5138 "ft-a-element-ft-addr=%p, ft-b-element-ft-addr=%p",
5139 sequence_a
->element_type
, sequence_b
->element_type
);
5146 int bt_ctf_field_type_compare(struct bt_ctf_field_type
*type_a
,
5147 struct bt_ctf_field_type
*type_b
)
5151 if (type_a
== type_b
) {
5152 /* Same reference: equal (even if both are NULL) */
5158 BT_LOGW_STR("Invalid parameter: field type A is NULL.");
5164 BT_LOGW_STR("Invalid parameter: field type B is NULL.");
5169 if (type_a
->id
!= type_b
->id
) {
5170 /* Different type IDs */
5171 BT_LOGV("Field types differ: different IDs: "
5172 "ft-a-addr=%p, ft-b-addr=%p, "
5173 "ft-a-id=%s, ft-b-id=%s",
5175 bt_ctf_field_type_id_string(type_a
->id
),
5176 bt_ctf_field_type_id_string(type_b
->id
));
5180 if (type_a
->id
== BT_CTF_FIELD_TYPE_ID_UNKNOWN
) {
5181 /* Both have unknown type IDs */
5182 BT_LOGW_STR("Invalid parameter: field type IDs are unknown.");
5186 ret
= type_compare_funcs
[type_a
->id
](type_a
, type_b
);
5188 BT_LOGV("Field types differ: ft-a-addr=%p, ft-b-addr=%p",
5197 int64_t bt_ctf_field_type_get_field_count(struct bt_ctf_field_type
*field_type
)
5199 int64_t field_count
= -1;
5200 enum bt_ctf_field_type_id type_id
= bt_ctf_field_type_get_type_id(field_type
);
5203 case CTF_TYPE_STRUCT
:
5205 bt_ctf_field_type_structure_get_field_count(field_type
);
5207 case CTF_TYPE_VARIANT
:
5209 bt_ctf_field_type_variant_get_field_count(field_type
);
5211 case CTF_TYPE_ARRAY
:
5212 case CTF_TYPE_SEQUENCE
:
5214 * Array and sequence types always contain a single member
5215 * (the element type).
5227 struct bt_ctf_field_type
*bt_ctf_field_type_get_field_at_index(
5228 struct bt_ctf_field_type
*field_type
, int index
)
5230 struct bt_ctf_field_type
*field
= NULL
;
5231 enum bt_ctf_field_type_id type_id
= bt_ctf_field_type_get_type_id(field_type
);
5234 case CTF_TYPE_STRUCT
:
5235 bt_ctf_field_type_structure_get_field_by_index(field_type
,
5236 NULL
, &field
, index
);
5238 case CTF_TYPE_VARIANT
:
5240 int ret
= bt_ctf_field_type_variant_get_field_by_index(
5241 field_type
, NULL
, &field
, index
);
5248 case CTF_TYPE_ARRAY
:
5249 field
= bt_ctf_field_type_array_get_element_type(field_type
);
5251 case CTF_TYPE_SEQUENCE
:
5252 field
= bt_ctf_field_type_sequence_get_element_type(field_type
);
5262 int bt_ctf_field_type_get_field_index(struct bt_ctf_field_type
*field_type
,
5265 int field_index
= -1;
5266 enum bt_ctf_field_type_id type_id
= bt_ctf_field_type_get_type_id(field_type
);
5269 case CTF_TYPE_STRUCT
:
5270 field_index
= bt_ctf_field_type_structure_get_field_name_index(
5273 case CTF_TYPE_VARIANT
:
5274 field_index
= bt_ctf_field_type_variant_get_field_name_index(
5284 struct bt_ctf_field_path
*bt_ctf_field_type_variant_get_tag_field_path(
5285 struct bt_ctf_field_type
*type
)
5287 struct bt_ctf_field_path
*field_path
= NULL
;
5288 struct bt_ctf_field_type_variant
*variant
;
5291 BT_LOGW_STR("Invalid parameter: field type is NULL.");
5295 if (!bt_ctf_field_type_is_variant(type
)) {
5296 BT_LOGW("Invalid parameter: field type is not a variant field type: "
5297 "addr=%p, ft-id=%s", type
,
5298 bt_ctf_field_type_id_string(type
->id
));
5302 variant
= container_of(type
, struct bt_ctf_field_type_variant
,
5304 field_path
= bt_get(variant
->tag_field_path
);
5309 struct bt_ctf_field_path
*bt_ctf_field_type_sequence_get_length_field_path(
5310 struct bt_ctf_field_type
*type
)
5312 struct bt_ctf_field_path
*field_path
= NULL
;
5313 struct bt_ctf_field_type_sequence
*sequence
;
5316 BT_LOGW_STR("Invalid parameter: field type is NULL.");
5320 if (!bt_ctf_field_type_is_sequence(type
)) {
5321 BT_LOGW("Invalid parameter: field type is not a sequence field type: "
5322 "addr=%p, ft-id=%s", type
,
5323 bt_ctf_field_type_id_string(type
->id
));
5327 sequence
= container_of(type
, struct bt_ctf_field_type_sequence
,
5329 field_path
= bt_get(sequence
->length_field_path
);