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 #include <babeltrace/ctf-writer/event-types.h>
30 #include <babeltrace/ctf-ir/event-types-internal.h>
31 #include <babeltrace/ctf-ir/utils.h>
32 #include <babeltrace/ctf-ir/clock.h>
33 #include <babeltrace/ctf-writer/writer-internal.h>
34 #include <babeltrace/compiler.h>
35 #include <babeltrace/endian.h>
40 struct range_overlap_query
{
55 void bt_ctf_field_type_destroy(struct bt_ctf_ref
*);
57 void bt_ctf_field_type_integer_destroy(struct bt_ctf_ref
*);
59 void bt_ctf_field_type_enumeration_destroy(struct bt_ctf_ref
*);
61 void bt_ctf_field_type_floating_point_destroy(struct bt_ctf_ref
*);
63 void bt_ctf_field_type_structure_destroy(struct bt_ctf_ref
*);
65 void bt_ctf_field_type_variant_destroy(struct bt_ctf_ref
*);
67 void bt_ctf_field_type_array_destroy(struct bt_ctf_ref
*);
69 void bt_ctf_field_type_sequence_destroy(struct bt_ctf_ref
*);
71 void bt_ctf_field_type_string_destroy(struct bt_ctf_ref
*);
74 void (* const type_destroy_funcs
[])(struct bt_ctf_ref
*) = {
75 [CTF_TYPE_INTEGER
] = bt_ctf_field_type_integer_destroy
,
77 bt_ctf_field_type_enumeration_destroy
,
79 bt_ctf_field_type_floating_point_destroy
,
80 [CTF_TYPE_STRUCT
] = bt_ctf_field_type_structure_destroy
,
81 [CTF_TYPE_VARIANT
] = bt_ctf_field_type_variant_destroy
,
82 [CTF_TYPE_ARRAY
] = bt_ctf_field_type_array_destroy
,
83 [CTF_TYPE_SEQUENCE
] = bt_ctf_field_type_sequence_destroy
,
84 [CTF_TYPE_STRING
] = bt_ctf_field_type_string_destroy
,
88 void generic_field_type_freeze(struct bt_ctf_field_type
*);
90 void bt_ctf_field_type_enumeration_freeze(struct bt_ctf_field_type
*);
92 void bt_ctf_field_type_structure_freeze(struct bt_ctf_field_type
*);
94 void bt_ctf_field_type_variant_freeze(struct bt_ctf_field_type
*);
96 void bt_ctf_field_type_array_freeze(struct bt_ctf_field_type
*);
98 void bt_ctf_field_type_sequence_freeze(struct bt_ctf_field_type
*);
101 type_freeze_func
const type_freeze_funcs
[] = {
102 [CTF_TYPE_INTEGER
] = generic_field_type_freeze
,
103 [CTF_TYPE_ENUM
] = bt_ctf_field_type_enumeration_freeze
,
104 [CTF_TYPE_FLOAT
] = generic_field_type_freeze
,
105 [CTF_TYPE_STRUCT
] = bt_ctf_field_type_structure_freeze
,
106 [CTF_TYPE_VARIANT
] = bt_ctf_field_type_variant_freeze
,
107 [CTF_TYPE_ARRAY
] = bt_ctf_field_type_array_freeze
,
108 [CTF_TYPE_SEQUENCE
] = bt_ctf_field_type_sequence_freeze
,
109 [CTF_TYPE_STRING
] = generic_field_type_freeze
,
113 int bt_ctf_field_type_integer_serialize(struct bt_ctf_field_type
*,
114 struct metadata_context
*);
116 int bt_ctf_field_type_enumeration_serialize(struct bt_ctf_field_type
*,
117 struct metadata_context
*);
119 int bt_ctf_field_type_floating_point_serialize(
120 struct bt_ctf_field_type
*, struct metadata_context
*);
122 int bt_ctf_field_type_structure_serialize(struct bt_ctf_field_type
*,
123 struct metadata_context
*);
125 int bt_ctf_field_type_variant_serialize(struct bt_ctf_field_type
*,
126 struct metadata_context
*);
128 int bt_ctf_field_type_array_serialize(struct bt_ctf_field_type
*,
129 struct metadata_context
*);
131 int bt_ctf_field_type_sequence_serialize(struct bt_ctf_field_type
*,
132 struct metadata_context
*);
134 int bt_ctf_field_type_string_serialize(struct bt_ctf_field_type
*,
135 struct metadata_context
*);
138 type_serialize_func
const type_serialize_funcs
[] = {
139 [CTF_TYPE_INTEGER
] = bt_ctf_field_type_integer_serialize
,
141 bt_ctf_field_type_enumeration_serialize
,
143 bt_ctf_field_type_floating_point_serialize
,
145 bt_ctf_field_type_structure_serialize
,
146 [CTF_TYPE_VARIANT
] = bt_ctf_field_type_variant_serialize
,
147 [CTF_TYPE_ARRAY
] = bt_ctf_field_type_array_serialize
,
148 [CTF_TYPE_SEQUENCE
] = bt_ctf_field_type_sequence_serialize
,
149 [CTF_TYPE_STRING
] = bt_ctf_field_type_string_serialize
,
153 void bt_ctf_field_type_integer_set_byte_order(struct bt_ctf_field_type
*,
154 int byte_order
, int set_native
);
156 void bt_ctf_field_type_enumeration_set_byte_order(struct bt_ctf_field_type
*,
157 int byte_order
, int set_native
);
159 void bt_ctf_field_type_floating_point_set_byte_order(
160 struct bt_ctf_field_type
*, int byte_order
, int set_native
);
162 void bt_ctf_field_type_structure_set_byte_order(struct bt_ctf_field_type
*,
163 int byte_order
, int set_native
);
165 void bt_ctf_field_type_variant_set_byte_order(struct bt_ctf_field_type
*,
166 int byte_order
, int set_native
);
168 void bt_ctf_field_type_array_set_byte_order(struct bt_ctf_field_type
*,
169 int byte_order
, int set_native
);
171 void bt_ctf_field_type_sequence_set_byte_order(struct bt_ctf_field_type
*,
172 int byte_order
, int set_native
);
174 /* The set_native flag only set the byte order if it is set to native */
176 void (* const set_byte_order_funcs
[])(struct bt_ctf_field_type
*,
177 int byte_order
, int set_native
) = {
178 [CTF_TYPE_INTEGER
] = bt_ctf_field_type_integer_set_byte_order
,
180 bt_ctf_field_type_enumeration_set_byte_order
,
182 bt_ctf_field_type_floating_point_set_byte_order
,
184 bt_ctf_field_type_structure_set_byte_order
,
185 [CTF_TYPE_VARIANT
] = bt_ctf_field_type_variant_set_byte_order
,
186 [CTF_TYPE_ARRAY
] = bt_ctf_field_type_array_set_byte_order
,
187 [CTF_TYPE_SEQUENCE
] = bt_ctf_field_type_sequence_set_byte_order
,
188 [CTF_TYPE_STRING
] = NULL
,
192 void destroy_enumeration_mapping(struct enumeration_mapping
*mapping
)
198 void destroy_structure_field(struct structure_field
*field
)
201 bt_ctf_field_type_put(field
->type
);
208 void check_ranges_overlap(gpointer element
, gpointer query
)
210 struct enumeration_mapping
*mapping
= element
;
211 struct range_overlap_query
*overlap_query
= query
;
213 if (mapping
->range_start
._signed
<= overlap_query
->range_end
._signed
214 && overlap_query
->range_start
._signed
<=
215 mapping
->range_end
._signed
) {
216 overlap_query
->overlaps
= 1;
217 overlap_query
->mapping_name
= mapping
->string
;
220 overlap_query
->overlaps
|=
221 mapping
->string
== overlap_query
->mapping_name
;
225 void check_ranges_overlap_unsigned(gpointer element
, gpointer query
)
227 struct enumeration_mapping
*mapping
= element
;
228 struct range_overlap_query
*overlap_query
= query
;
230 if (mapping
->range_start
._unsigned
<= overlap_query
->range_end
._unsigned
231 && overlap_query
->range_start
._unsigned
<=
232 mapping
->range_end
._unsigned
) {
233 overlap_query
->overlaps
= 1;
234 overlap_query
->mapping_name
= mapping
->string
;
237 overlap_query
->overlaps
|=
238 mapping
->string
== overlap_query
->mapping_name
;
242 gint
compare_enumeration_mappings_signed(struct enumeration_mapping
**a
,
243 struct enumeration_mapping
**b
)
245 return ((*a
)->range_start
._signed
< (*b
)->range_start
._signed
) ? -1 : 1;
249 gint
compare_enumeration_mappings_unsigned(struct enumeration_mapping
**a
,
250 struct enumeration_mapping
**b
)
252 return ((*a
)->range_start
._unsigned
< (*b
)->range_start
._unsigned
) ? -1 : 1;
256 void bt_ctf_field_type_init(struct bt_ctf_field_type
*type
)
258 enum ctf_type_id type_id
= type
->declaration
->id
;
261 assert(type
&& (type_id
> CTF_TYPE_UNKNOWN
) &&
262 (type_id
< NR_CTF_TYPES
));
264 bt_ctf_ref_init(&type
->ref_count
);
265 type
->freeze
= type_freeze_funcs
[type_id
];
266 type
->serialize
= type_serialize_funcs
[type_id
];
267 ret
= bt_ctf_field_type_set_byte_order(type
, BT_CTF_BYTE_ORDER_NATIVE
);
269 type
->declaration
->alignment
= 1;
273 int add_structure_field(GPtrArray
*fields
,
274 GHashTable
*field_name_to_index
,
275 struct bt_ctf_field_type
*field_type
,
276 const char *field_name
)
279 GQuark name_quark
= g_quark_from_string(field_name
);
280 struct structure_field
*field
;
282 /* Make sure structure does not contain a field of the same name */
283 if (g_hash_table_lookup_extended(field_name_to_index
,
284 GUINT_TO_POINTER(name_quark
), NULL
, NULL
)) {
289 field
= g_new0(struct structure_field
, 1);
295 bt_ctf_field_type_get(field_type
);
296 field
->name
= name_quark
;
297 field
->type
= field_type
;
298 g_hash_table_insert(field_name_to_index
,
299 (gpointer
) (unsigned long) name_quark
,
300 (gpointer
) (unsigned long) fields
->len
);
301 g_ptr_array_add(fields
, field
);
307 void bt_ctf_field_type_destroy(struct bt_ctf_ref
*ref
)
309 struct bt_ctf_field_type
*type
;
310 enum ctf_type_id type_id
;
316 type
= container_of(ref
, struct bt_ctf_field_type
, ref_count
);
317 type_id
= type
->declaration
->id
;
318 if (type_id
<= CTF_TYPE_UNKNOWN
||
319 type_id
>= NR_CTF_TYPES
) {
323 if (type
->alias_name
) {
324 g_string_free(type
->alias_name
, TRUE
);
326 type_destroy_funcs
[type_id
](ref
);
330 int bt_ctf_field_type_validate(struct bt_ctf_field_type
*type
)
339 switch (type
->declaration
->id
) {
342 struct bt_ctf_field_type_enumeration
*enumeration
=
343 container_of(type
, struct bt_ctf_field_type_enumeration
,
346 /* Ensure enum has entries */
347 ret
= enumeration
->entries
->len
? 0 : -1;
357 struct bt_ctf_field_type
*bt_ctf_field_type_integer_create(unsigned int size
)
359 struct bt_ctf_field_type_integer
*integer
=
360 g_new0(struct bt_ctf_field_type_integer
, 1);
362 if (!integer
|| size
== 0 || size
> 64) {
366 integer
->parent
.declaration
= &integer
->declaration
.p
;
367 integer
->parent
.declaration
->id
= CTF_TYPE_INTEGER
;
368 integer
->declaration
.len
= size
;
369 integer
->declaration
.base
= BT_CTF_INTEGER_BASE_DECIMAL
;
370 integer
->declaration
.encoding
= CTF_STRING_NONE
;
371 bt_ctf_field_type_init(&integer
->parent
);
372 return &integer
->parent
;
375 int bt_ctf_field_type_integer_get_size(struct bt_ctf_field_type
*type
)
378 struct bt_ctf_field_type_integer
*integer
;
380 if (!type
|| type
->declaration
->id
!= CTF_TYPE_INTEGER
) {
385 integer
= container_of(type
, struct bt_ctf_field_type_integer
, parent
);
386 ret
= (int) integer
->declaration
.len
;
391 int bt_ctf_field_type_integer_get_signed(struct bt_ctf_field_type
*type
)
394 struct bt_ctf_field_type_integer
*integer
;
396 if (!type
|| type
->declaration
->id
!= CTF_TYPE_INTEGER
) {
401 integer
= container_of(type
, struct bt_ctf_field_type_integer
, parent
);
402 ret
= integer
->declaration
.signedness
;
407 int bt_ctf_field_type_integer_set_signed(struct bt_ctf_field_type
*type
,
411 struct bt_ctf_field_type_integer
*integer
;
413 if (!type
|| type
->frozen
||
414 type
->declaration
->id
!= CTF_TYPE_INTEGER
) {
419 integer
= container_of(type
, struct bt_ctf_field_type_integer
, parent
);
420 integer
->declaration
.signedness
= !!is_signed
;
425 enum bt_ctf_integer_base
bt_ctf_field_type_integer_get_base(
426 struct bt_ctf_field_type
*type
)
428 enum bt_ctf_integer_base ret
= BT_CTF_INTEGER_BASE_UNKNOWN
;
429 struct bt_ctf_field_type_integer
*integer
;
431 if (!type
|| type
->declaration
->id
!= CTF_TYPE_INTEGER
) {
435 integer
= container_of(type
, struct bt_ctf_field_type_integer
, parent
);
436 ret
= integer
->declaration
.base
;
441 int bt_ctf_field_type_integer_set_base(struct bt_ctf_field_type
*type
,
442 enum bt_ctf_integer_base base
)
446 if (!type
|| type
->frozen
||
447 type
->declaration
->id
!= CTF_TYPE_INTEGER
) {
453 case BT_CTF_INTEGER_BASE_BINARY
:
454 case BT_CTF_INTEGER_BASE_OCTAL
:
455 case BT_CTF_INTEGER_BASE_DECIMAL
:
456 case BT_CTF_INTEGER_BASE_HEXADECIMAL
:
458 struct bt_ctf_field_type_integer
*integer
= container_of(type
,
459 struct bt_ctf_field_type_integer
, parent
);
460 integer
->declaration
.base
= base
;
470 enum ctf_string_encoding
bt_ctf_field_type_integer_get_encoding(
471 struct bt_ctf_field_type
*type
)
473 enum ctf_string_encoding ret
= CTF_STRING_UNKNOWN
;
474 struct bt_ctf_field_type_integer
*integer
;
476 if (!type
|| type
->declaration
->id
!= CTF_TYPE_INTEGER
) {
480 integer
= container_of(type
, struct bt_ctf_field_type_integer
, parent
);
481 ret
= integer
->declaration
.encoding
;
486 int bt_ctf_field_type_integer_set_encoding(struct bt_ctf_field_type
*type
,
487 enum ctf_string_encoding encoding
)
490 struct bt_ctf_field_type_integer
*integer
;
492 if (!type
|| type
->frozen
||
493 (type
->declaration
->id
!= CTF_TYPE_INTEGER
) ||
494 (encoding
< CTF_STRING_NONE
) ||
495 (encoding
>= CTF_STRING_UNKNOWN
)) {
500 integer
= container_of(type
, struct bt_ctf_field_type_integer
, parent
);
501 integer
->declaration
.encoding
= encoding
;
506 struct bt_ctf_clock
*bt_ctf_field_type_integer_get_mapped_clock(
507 struct bt_ctf_field_type
*type
)
509 struct bt_ctf_field_type_integer
*integer
;
510 struct bt_ctf_clock
*clock
= NULL
;
516 integer
= container_of(type
, struct bt_ctf_field_type_integer
, parent
);
517 clock
= integer
->mapped_clock
;
519 bt_ctf_clock_get(clock
);
525 int bt_ctf_field_type_integer_set_mapped_clock(
526 struct bt_ctf_field_type
*type
,
527 struct bt_ctf_clock
*clock
)
529 struct bt_ctf_field_type_integer
*integer
;
532 if (!type
|| type
->frozen
) {
537 integer
= container_of(type
, struct bt_ctf_field_type_integer
, parent
);
538 if (integer
->mapped_clock
) {
539 bt_ctf_clock_put(integer
->mapped_clock
);
543 bt_ctf_clock_get(clock
);
546 integer
->mapped_clock
= clock
;
551 struct bt_ctf_field_type
*bt_ctf_field_type_enumeration_create(
552 struct bt_ctf_field_type
*integer_container_type
)
554 struct bt_ctf_field_type_enumeration
*enumeration
= NULL
;
556 if (!integer_container_type
) {
560 if (integer_container_type
->declaration
->id
!= CTF_TYPE_INTEGER
) {
564 enumeration
= g_new0(struct bt_ctf_field_type_enumeration
, 1);
569 enumeration
->parent
.declaration
= &enumeration
->declaration
.p
;
570 enumeration
->parent
.declaration
->id
= CTF_TYPE_ENUM
;
571 bt_ctf_field_type_get(integer_container_type
);
572 enumeration
->container
= integer_container_type
;
573 enumeration
->entries
= g_ptr_array_new_with_free_func(
574 (GDestroyNotify
)destroy_enumeration_mapping
);
575 bt_ctf_field_type_init(&enumeration
->parent
);
576 return &enumeration
->parent
;
582 struct bt_ctf_field_type
*bt_ctf_field_type_enumeration_get_container_type(
583 struct bt_ctf_field_type
*type
)
585 struct bt_ctf_field_type
*container_type
= NULL
;
586 struct bt_ctf_field_type_enumeration
*enumeration_type
;
592 if (type
->declaration
->id
!= CTF_TYPE_ENUM
) {
596 enumeration_type
= container_of(type
,
597 struct bt_ctf_field_type_enumeration
, parent
);
598 container_type
= enumeration_type
->container
;
599 bt_ctf_field_type_get(container_type
);
601 return container_type
;
604 int bt_ctf_field_type_enumeration_add_mapping(
605 struct bt_ctf_field_type
*type
, const char *string
,
606 int64_t range_start
, int64_t range_end
)
610 struct enumeration_mapping
*mapping
;
611 struct bt_ctf_field_type_enumeration
*enumeration
;
612 struct range_overlap_query query
;
613 char *escaped_string
;
615 if (!type
|| (type
->declaration
->id
!= CTF_TYPE_ENUM
) ||
617 (range_end
< range_start
)) {
622 if (!string
|| strlen(string
) == 0) {
627 escaped_string
= g_strescape(string
, NULL
);
628 if (!escaped_string
) {
633 mapping_name
= g_quark_from_string(escaped_string
);
634 query
= (struct range_overlap_query
) {
635 .range_start
._signed
= range_start
,
636 .range_end
._signed
= range_end
,
637 .mapping_name
= mapping_name
,
639 enumeration
= container_of(type
, struct bt_ctf_field_type_enumeration
,
642 /* Check that the range does not overlap with one already present */
643 g_ptr_array_foreach(enumeration
->entries
, check_ranges_overlap
, &query
);
644 if (query
.overlaps
) {
649 mapping
= g_new(struct enumeration_mapping
, 1);
655 *mapping
= (struct enumeration_mapping
) {
656 .range_start
._signed
= range_start
,
657 .range_end
._signed
= range_end
, .string
= mapping_name
};
658 g_ptr_array_add(enumeration
->entries
, mapping
);
659 g_ptr_array_sort(enumeration
->entries
,
660 (GCompareFunc
)compare_enumeration_mappings_signed
);
662 free(escaped_string
);
667 int bt_ctf_field_type_enumeration_add_mapping_unsigned(
668 struct bt_ctf_field_type
*type
, const char *string
,
669 uint64_t range_start
, uint64_t range_end
)
673 struct enumeration_mapping
*mapping
;
674 struct bt_ctf_field_type_enumeration
*enumeration
;
675 struct range_overlap_query query
;
676 char *escaped_string
;
678 if (!type
|| (type
->declaration
->id
!= CTF_TYPE_ENUM
) ||
680 (range_end
< range_start
)) {
685 if (!string
|| strlen(string
) == 0) {
690 escaped_string
= g_strescape(string
, NULL
);
691 if (!escaped_string
) {
696 mapping_name
= g_quark_from_string(escaped_string
);
697 query
= (struct range_overlap_query
) {
698 .range_start
._unsigned
= range_start
,
699 .range_end
._unsigned
= range_end
,
700 .mapping_name
= mapping_name
,
702 enumeration
= container_of(type
, struct bt_ctf_field_type_enumeration
,
705 /* Check that the range does not overlap with one already present */
706 g_ptr_array_foreach(enumeration
->entries
, check_ranges_overlap_unsigned
,
708 if (query
.overlaps
) {
713 mapping
= g_new(struct enumeration_mapping
, 1);
719 *mapping
= (struct enumeration_mapping
) {
720 .range_start
._unsigned
= range_start
,
721 .range_end
._unsigned
= range_end
, .string
= mapping_name
};
722 g_ptr_array_add(enumeration
->entries
, mapping
);
723 g_ptr_array_sort(enumeration
->entries
,
724 (GCompareFunc
)compare_enumeration_mappings_unsigned
);
726 free(escaped_string
);
731 const char *bt_ctf_field_type_enumeration_get_mapping_name_unsigned(
732 struct bt_ctf_field_type_enumeration
*enumeration_type
,
735 const char *name
= NULL
;
736 struct range_overlap_query query
=
737 (struct range_overlap_query
) {
738 .range_start
._unsigned
= value
,
739 .range_end
._unsigned
= value
,
742 g_ptr_array_foreach(enumeration_type
->entries
,
743 check_ranges_overlap_unsigned
,
745 if (!query
.overlaps
) {
749 name
= g_quark_to_string(query
.mapping_name
);
754 const char *bt_ctf_field_type_enumeration_get_mapping_name_signed(
755 struct bt_ctf_field_type_enumeration
*enumeration_type
,
758 const char *name
= NULL
;
759 struct range_overlap_query query
=
760 (struct range_overlap_query
) {
761 .range_start
._signed
= value
,
762 .range_end
._signed
= value
,
765 g_ptr_array_foreach(enumeration_type
->entries
, check_ranges_overlap
,
767 if (!query
.overlaps
) {
771 name
= g_quark_to_string(query
.mapping_name
);
776 int bt_ctf_field_type_enumeration_get_mapping_count(
777 struct bt_ctf_field_type
*type
)
780 struct bt_ctf_field_type_enumeration
*enumeration
;
782 if (!type
|| (type
->declaration
->id
!= CTF_TYPE_ENUM
)) {
787 enumeration
= container_of(type
, struct bt_ctf_field_type_enumeration
,
789 ret
= (int) enumeration
->entries
->len
;
795 struct enumeration_mapping
*get_enumeration_mapping(
796 struct bt_ctf_field_type
*type
, int index
)
798 struct enumeration_mapping
*mapping
= NULL
;
799 struct bt_ctf_field_type_enumeration
*enumeration
;
801 enumeration
= container_of(type
, struct bt_ctf_field_type_enumeration
,
803 if (index
>= enumeration
->entries
->len
) {
807 mapping
= g_ptr_array_index(enumeration
->entries
, index
);
812 int bt_ctf_field_type_enumeration_get_mapping(
813 struct bt_ctf_field_type
*type
, int index
,
814 const char **string
, int64_t *range_start
, int64_t *range_end
)
816 struct enumeration_mapping
*mapping
;
819 if (!type
|| index
< 0 || !string
|| !range_start
|| !range_end
||
820 (type
->declaration
->id
!= CTF_TYPE_ENUM
)) {
825 mapping
= get_enumeration_mapping(type
, index
);
831 *string
= g_quark_to_string(mapping
->string
);
832 *range_start
= mapping
->range_start
._signed
;
833 *range_end
= mapping
->range_end
._signed
;
838 int bt_ctf_field_type_enumeration_get_mapping_unsigned(
839 struct bt_ctf_field_type
*type
, int index
,
840 const char **string
, uint64_t *range_start
, uint64_t *range_end
)
842 struct enumeration_mapping
*mapping
;
845 if (!type
|| index
< 0 || !string
|| !range_start
|| !range_end
||
846 (type
->declaration
->id
!= CTF_TYPE_ENUM
)) {
851 mapping
= get_enumeration_mapping(type
, index
);
857 *string
= g_quark_to_string(mapping
->string
);
858 *range_start
= mapping
->range_start
._unsigned
;
859 *range_end
= mapping
->range_end
._unsigned
;
864 int bt_ctf_field_type_enumeration_get_mapping_index_by_name(
865 struct bt_ctf_field_type
*type
, const char *name
)
868 struct bt_ctf_field_type_enumeration
*enumeration
;
871 if (!type
|| !name
||
872 (type
->declaration
->id
!= CTF_TYPE_ENUM
)) {
877 name_quark
= g_quark_try_string(name
);
883 enumeration
= container_of(type
,
884 struct bt_ctf_field_type_enumeration
, parent
);
885 for (i
= 0; i
< enumeration
->entries
->len
; i
++) {
886 struct enumeration_mapping
*mapping
=
887 get_enumeration_mapping(type
, i
);
889 if (mapping
->string
== name_quark
) {
900 int bt_ctf_field_type_enumeration_get_mapping_index_by_value(
901 struct bt_ctf_field_type
*type
, int64_t value
)
903 struct bt_ctf_field_type_enumeration
*enumeration
;
906 if (!type
|| (type
->declaration
->id
!= CTF_TYPE_ENUM
)) {
911 enumeration
= container_of(type
,
912 struct bt_ctf_field_type_enumeration
, parent
);
913 for (i
= 0; i
< enumeration
->entries
->len
; i
++) {
914 struct enumeration_mapping
*mapping
=
915 get_enumeration_mapping(type
, i
);
917 if (value
>= mapping
->range_start
._signed
&&
918 value
<= mapping
->range_end
._signed
) {
929 int bt_ctf_field_type_enumeration_get_mapping_index_by_unsigned_value(
930 struct bt_ctf_field_type
*type
, uint64_t value
)
932 struct bt_ctf_field_type_enumeration
*enumeration
;
935 if (!type
|| (type
->declaration
->id
!= CTF_TYPE_ENUM
)) {
940 enumeration
= container_of(type
,
941 struct bt_ctf_field_type_enumeration
, parent
);
942 for (i
= 0; i
< enumeration
->entries
->len
; i
++) {
943 struct enumeration_mapping
*mapping
=
944 get_enumeration_mapping(type
, i
);
946 if (value
>= mapping
->range_start
._unsigned
&&
947 value
<= mapping
->range_end
._unsigned
) {
958 struct bt_ctf_field_type
*bt_ctf_field_type_floating_point_create(void)
960 struct bt_ctf_field_type_floating_point
*floating_point
=
961 g_new0(struct bt_ctf_field_type_floating_point
, 1);
963 if (!floating_point
) {
967 floating_point
->declaration
.sign
= &floating_point
->sign
;
968 floating_point
->declaration
.mantissa
= &floating_point
->mantissa
;
969 floating_point
->declaration
.exp
= &floating_point
->exp
;
970 floating_point
->sign
.len
= 1;
971 floating_point
->parent
.declaration
= &floating_point
->declaration
.p
;
972 floating_point
->parent
.declaration
->id
= CTF_TYPE_FLOAT
;
973 floating_point
->declaration
.exp
->len
=
974 sizeof(float) * CHAR_BIT
- FLT_MANT_DIG
;
975 floating_point
->declaration
.mantissa
->len
= FLT_MANT_DIG
- 1;
976 floating_point
->sign
.p
.alignment
= 1;
977 floating_point
->mantissa
.p
.alignment
= 1;
978 floating_point
->exp
.p
.alignment
= 1;
980 bt_ctf_field_type_init(&floating_point
->parent
);
982 return floating_point
? &floating_point
->parent
: NULL
;
985 int bt_ctf_field_type_floating_point_get_exponent_digits(
986 struct bt_ctf_field_type
*type
)
989 struct bt_ctf_field_type_floating_point
*floating_point
;
991 if (!type
|| (type
->declaration
->id
!= CTF_TYPE_FLOAT
)) {
996 floating_point
= container_of(type
,
997 struct bt_ctf_field_type_floating_point
, parent
);
998 ret
= (int) floating_point
->declaration
.exp
->len
;
1003 int bt_ctf_field_type_floating_point_set_exponent_digits(
1004 struct bt_ctf_field_type
*type
,
1005 unsigned int exponent_digits
)
1008 struct bt_ctf_field_type_floating_point
*floating_point
;
1010 if (!type
|| type
->frozen
||
1011 (type
->declaration
->id
!= CTF_TYPE_FLOAT
)) {
1016 floating_point
= container_of(type
,
1017 struct bt_ctf_field_type_floating_point
, parent
);
1018 if ((exponent_digits
!= sizeof(float) * CHAR_BIT
- FLT_MANT_DIG
) &&
1019 (exponent_digits
!= sizeof(double) * CHAR_BIT
- DBL_MANT_DIG
) &&
1021 sizeof(long double) * CHAR_BIT
- LDBL_MANT_DIG
)) {
1026 floating_point
->declaration
.exp
->len
= exponent_digits
;
1031 int bt_ctf_field_type_floating_point_get_mantissa_digits(
1032 struct bt_ctf_field_type
*type
)
1035 struct bt_ctf_field_type_floating_point
*floating_point
;
1037 if (!type
|| (type
->declaration
->id
!= CTF_TYPE_FLOAT
)) {
1042 floating_point
= container_of(type
,
1043 struct bt_ctf_field_type_floating_point
, parent
);
1044 ret
= (int) floating_point
->mantissa
.len
+ 1;
1049 int bt_ctf_field_type_floating_point_set_mantissa_digits(
1050 struct bt_ctf_field_type
*type
,
1051 unsigned int mantissa_digits
)
1054 struct bt_ctf_field_type_floating_point
*floating_point
;
1056 if (!type
|| type
->frozen
||
1057 (type
->declaration
->id
!= CTF_TYPE_FLOAT
)) {
1062 floating_point
= container_of(type
,
1063 struct bt_ctf_field_type_floating_point
, parent
);
1065 if ((mantissa_digits
!= FLT_MANT_DIG
) &&
1066 (mantissa_digits
!= DBL_MANT_DIG
) &&
1067 (mantissa_digits
!= LDBL_MANT_DIG
)) {
1072 floating_point
->declaration
.mantissa
->len
= mantissa_digits
- 1;
1077 struct bt_ctf_field_type
*bt_ctf_field_type_structure_create(void)
1079 struct bt_ctf_field_type_structure
*structure
=
1080 g_new0(struct bt_ctf_field_type_structure
, 1);
1086 structure
->parent
.declaration
= &structure
->declaration
.p
;
1087 structure
->parent
.declaration
->id
= CTF_TYPE_STRUCT
;
1088 structure
->fields
= g_ptr_array_new_with_free_func(
1089 (GDestroyNotify
)destroy_structure_field
);
1090 structure
->field_name_to_index
= g_hash_table_new(NULL
, NULL
);
1091 bt_ctf_field_type_init(&structure
->parent
);
1092 return &structure
->parent
;
1097 int bt_ctf_field_type_structure_add_field(struct bt_ctf_field_type
*type
,
1098 struct bt_ctf_field_type
*field_type
,
1099 const char *field_name
)
1102 struct bt_ctf_field_type_structure
*structure
;
1104 if (!type
|| !field_type
|| type
->frozen
||
1105 bt_ctf_validate_identifier(field_name
) ||
1106 (type
->declaration
->id
!= CTF_TYPE_STRUCT
) ||
1107 bt_ctf_field_type_validate(field_type
)) {
1112 structure
= container_of(type
,
1113 struct bt_ctf_field_type_structure
, parent
);
1114 if (add_structure_field(structure
->fields
,
1115 structure
->field_name_to_index
, field_type
, field_name
)) {
1120 if (type
->declaration
->alignment
< field_type
->declaration
->alignment
) {
1121 type
->declaration
->alignment
=
1122 field_type
->declaration
->alignment
;
1128 int bt_ctf_field_type_structure_get_field_count(
1129 struct bt_ctf_field_type
*type
)
1132 struct bt_ctf_field_type_structure
*structure
;
1134 if (!type
|| (type
->declaration
->id
!= CTF_TYPE_STRUCT
)) {
1139 structure
= container_of(type
, struct bt_ctf_field_type_structure
,
1141 ret
= (int) structure
->fields
->len
;
1146 int bt_ctf_field_type_structure_get_field(struct bt_ctf_field_type
*type
,
1147 const char **field_name
, struct bt_ctf_field_type
**field_type
,
1150 struct bt_ctf_field_type_structure
*structure
;
1151 struct structure_field
*field
;
1154 if (!type
|| index
< 0 || !field_name
|| !field_type
||
1155 (type
->declaration
->id
!= CTF_TYPE_STRUCT
)) {
1160 structure
= container_of(type
, struct bt_ctf_field_type_structure
,
1162 if (index
>= structure
->fields
->len
) {
1167 field
= g_ptr_array_index(structure
->fields
, index
);
1168 *field_type
= field
->type
;
1169 bt_ctf_field_type_get(field
->type
);
1170 *field_name
= g_quark_to_string(field
->name
);
1175 struct bt_ctf_field_type
*bt_ctf_field_type_structure_get_field_type_by_name(
1176 struct bt_ctf_field_type
*type
,
1181 struct structure_field
*field
;
1182 struct bt_ctf_field_type_structure
*structure
;
1183 struct bt_ctf_field_type
*field_type
= NULL
;
1185 if (!type
|| !name
) {
1189 name_quark
= g_quark_try_string(name
);
1194 structure
= container_of(type
, struct bt_ctf_field_type_structure
,
1196 if (!g_hash_table_lookup_extended(structure
->field_name_to_index
,
1197 GUINT_TO_POINTER(name_quark
), NULL
, (gpointer
*)&index
)) {
1201 field
= structure
->fields
->pdata
[index
];
1202 field_type
= field
->type
;
1203 bt_ctf_field_type_get(field_type
);
1208 struct bt_ctf_field_type
*bt_ctf_field_type_variant_create(
1209 struct bt_ctf_field_type
*enum_tag
, const char *tag_name
)
1211 struct bt_ctf_field_type_variant
*variant
= NULL
;
1213 if (!enum_tag
|| bt_ctf_validate_identifier(tag_name
) ||
1214 (enum_tag
->declaration
->id
!= CTF_TYPE_ENUM
)) {
1218 variant
= g_new0(struct bt_ctf_field_type_variant
, 1);
1223 variant
->parent
.declaration
= &variant
->declaration
.p
;
1224 variant
->parent
.declaration
->id
= CTF_TYPE_VARIANT
;
1225 variant
->tag_name
= g_string_new(tag_name
);
1226 variant
->field_name_to_index
= g_hash_table_new(NULL
, NULL
);
1227 variant
->fields
= g_ptr_array_new_with_free_func(
1228 (GDestroyNotify
)destroy_structure_field
);
1229 bt_ctf_field_type_get(enum_tag
);
1230 variant
->tag
= container_of(enum_tag
,
1231 struct bt_ctf_field_type_enumeration
, parent
);
1232 bt_ctf_field_type_init(&variant
->parent
);
1233 return &variant
->parent
;
1238 struct bt_ctf_field_type
*bt_ctf_field_type_variant_get_tag_type(
1239 struct bt_ctf_field_type
*type
)
1241 struct bt_ctf_field_type_variant
*variant
;
1242 struct bt_ctf_field_type
*tag_type
= NULL
;
1244 if (!type
|| (type
->declaration
->id
!= CTF_TYPE_VARIANT
)) {
1248 variant
= container_of(type
, struct bt_ctf_field_type_variant
, parent
);
1249 tag_type
= &variant
->tag
->parent
;
1250 bt_ctf_field_type_get(tag_type
);
1255 const char *bt_ctf_field_type_variant_get_tag_name(
1256 struct bt_ctf_field_type
*type
)
1258 struct bt_ctf_field_type_variant
*variant
;
1259 const char *tag_name
= NULL
;
1261 if (!type
|| (type
->declaration
->id
!= CTF_TYPE_VARIANT
)) {
1265 variant
= container_of(type
, struct bt_ctf_field_type_variant
, parent
);
1266 tag_name
= variant
->tag_name
->str
;
1271 int bt_ctf_field_type_variant_add_field(struct bt_ctf_field_type
*type
,
1272 struct bt_ctf_field_type
*field_type
,
1273 const char *field_name
)
1278 struct bt_ctf_field_type_variant
*variant
;
1279 GQuark field_name_quark
= g_quark_from_string(field_name
);
1281 if (!type
|| !field_type
|| type
->frozen
||
1282 bt_ctf_validate_identifier(field_name
) ||
1283 (type
->declaration
->id
!= CTF_TYPE_VARIANT
) ||
1284 bt_ctf_field_type_validate(field_type
)) {
1289 variant
= container_of(type
, struct bt_ctf_field_type_variant
, parent
);
1290 /* Make sure this name is present in the enum tag */
1291 for (i
= 0; i
< variant
->tag
->entries
->len
; i
++) {
1292 struct enumeration_mapping
*mapping
=
1293 g_ptr_array_index(variant
->tag
->entries
, i
);
1295 if (mapping
->string
== field_name_quark
) {
1301 if (!name_found
|| add_structure_field(variant
->fields
,
1302 variant
->field_name_to_index
, field_type
, field_name
)) {
1310 struct bt_ctf_field_type
*bt_ctf_field_type_variant_get_field_type_by_name(
1311 struct bt_ctf_field_type
*type
,
1312 const char *field_name
)
1316 struct structure_field
*field
;
1317 struct bt_ctf_field_type_variant
*variant
;
1318 struct bt_ctf_field_type
*field_type
= NULL
;
1320 if (!type
|| !field_name
) {
1324 name_quark
= g_quark_try_string(field_name
);
1329 variant
= container_of(type
, struct bt_ctf_field_type_variant
, parent
);
1330 if (!g_hash_table_lookup_extended(variant
->field_name_to_index
,
1331 GUINT_TO_POINTER(name_quark
), NULL
, (gpointer
*)&index
)) {
1335 field
= g_ptr_array_index(variant
->fields
, index
);
1336 field_type
= field
->type
;
1337 bt_ctf_field_type_get(field_type
);
1342 struct bt_ctf_field_type
*bt_ctf_field_type_variant_get_field_type_from_tag(
1343 struct bt_ctf_field_type
*type
,
1344 struct bt_ctf_field
*tag
)
1346 const char *enum_value
;
1347 struct bt_ctf_field_type
*field_type
= NULL
;
1349 if (!type
|| !tag
|| type
->declaration
->id
!= CTF_TYPE_VARIANT
) {
1353 enum_value
= bt_ctf_field_enumeration_get_mapping_name(tag
);
1358 /* Already increments field_type's reference count */
1359 field_type
= bt_ctf_field_type_variant_get_field_type_by_name(
1365 int bt_ctf_field_type_variant_get_field_count(struct bt_ctf_field_type
*type
)
1368 struct bt_ctf_field_type_variant
*variant
;
1370 if (!type
|| (type
->declaration
->id
!= CTF_TYPE_VARIANT
)) {
1375 variant
= container_of(type
, struct bt_ctf_field_type_variant
,
1377 ret
= (int) variant
->fields
->len
;
1383 int bt_ctf_field_type_variant_get_field(struct bt_ctf_field_type
*type
,
1384 const char **field_name
, struct bt_ctf_field_type
**field_type
,
1387 struct bt_ctf_field_type_variant
*variant
;
1388 struct structure_field
*field
;
1391 if (!type
|| index
< 0 || !field_name
|| !field_type
||
1392 (type
->declaration
->id
!= CTF_TYPE_VARIANT
)) {
1397 variant
= container_of(type
, struct bt_ctf_field_type_variant
,
1399 if (index
>= variant
->fields
->len
) {
1404 field
= g_ptr_array_index(variant
->fields
, index
);
1405 *field_type
= field
->type
;
1406 bt_ctf_field_type_get(field
->type
);
1407 *field_name
= g_quark_to_string(field
->name
);
1412 struct bt_ctf_field_type
*bt_ctf_field_type_array_create(
1413 struct bt_ctf_field_type
*element_type
,
1414 unsigned int length
)
1416 struct bt_ctf_field_type_array
*array
= NULL
;
1418 if (!element_type
|| length
== 0 ||
1419 bt_ctf_field_type_validate(element_type
)) {
1423 array
= g_new0(struct bt_ctf_field_type_array
, 1);
1428 array
->parent
.declaration
= &array
->declaration
.p
;
1429 array
->parent
.declaration
->id
= CTF_TYPE_ARRAY
;
1431 bt_ctf_field_type_get(element_type
);
1432 array
->element_type
= element_type
;
1433 array
->length
= length
;
1434 bt_ctf_field_type_init(&array
->parent
);
1435 array
->parent
.declaration
->alignment
=
1436 element_type
->declaration
->alignment
;
1437 return &array
->parent
;
1442 struct bt_ctf_field_type
*bt_ctf_field_type_array_get_element_type(
1443 struct bt_ctf_field_type
*type
)
1445 struct bt_ctf_field_type
*ret
= NULL
;
1446 struct bt_ctf_field_type_array
*array
;
1448 if (!type
|| (type
->declaration
->id
!= CTF_TYPE_ARRAY
)) {
1452 array
= container_of(type
, struct bt_ctf_field_type_array
, parent
);
1453 ret
= array
->element_type
;
1454 bt_ctf_field_type_get(ret
);
1459 int64_t bt_ctf_field_type_array_get_length(struct bt_ctf_field_type
*type
)
1462 struct bt_ctf_field_type_array
*array
;
1464 if (!type
|| (type
->declaration
->id
!= CTF_TYPE_ARRAY
)) {
1469 array
= container_of(type
, struct bt_ctf_field_type_array
, parent
);
1470 ret
= (int64_t) array
->length
;
1475 struct bt_ctf_field_type
*bt_ctf_field_type_sequence_create(
1476 struct bt_ctf_field_type
*element_type
,
1477 const char *length_field_name
)
1479 struct bt_ctf_field_type_sequence
*sequence
= NULL
;
1481 if (!element_type
|| bt_ctf_validate_identifier(length_field_name
) ||
1482 bt_ctf_field_type_validate(element_type
)) {
1486 sequence
= g_new0(struct bt_ctf_field_type_sequence
, 1);
1491 sequence
->parent
.declaration
= &sequence
->declaration
.p
;
1492 sequence
->parent
.declaration
->id
= CTF_TYPE_SEQUENCE
;
1493 bt_ctf_field_type_get(element_type
);
1494 sequence
->element_type
= element_type
;
1495 sequence
->length_field_name
= g_string_new(length_field_name
);
1496 bt_ctf_field_type_init(&sequence
->parent
);
1497 sequence
->parent
.declaration
->alignment
=
1498 element_type
->declaration
->alignment
;
1499 return &sequence
->parent
;
1504 struct bt_ctf_field_type
*bt_ctf_field_type_sequence_get_element_type(
1505 struct bt_ctf_field_type
*type
)
1507 struct bt_ctf_field_type
*ret
= NULL
;
1508 struct bt_ctf_field_type_sequence
*sequence
;
1510 if (!type
|| (type
->declaration
->id
!= CTF_TYPE_SEQUENCE
)) {
1514 sequence
= container_of(type
, struct bt_ctf_field_type_sequence
,
1516 ret
= sequence
->element_type
;
1517 bt_ctf_field_type_get(ret
);
1522 const char *bt_ctf_field_type_sequence_get_length_field_name(
1523 struct bt_ctf_field_type
*type
)
1525 const char *ret
= NULL
;
1526 struct bt_ctf_field_type_sequence
*sequence
;
1528 if (!type
|| (type
->declaration
->id
!= CTF_TYPE_SEQUENCE
)) {
1532 sequence
= container_of(type
, struct bt_ctf_field_type_sequence
,
1534 ret
= sequence
->length_field_name
->str
;
1539 struct bt_ctf_field_type
*bt_ctf_field_type_string_create(void)
1541 struct bt_ctf_field_type_string
*string
=
1542 g_new0(struct bt_ctf_field_type_string
, 1);
1548 string
->parent
.declaration
= &string
->declaration
.p
;
1549 string
->parent
.declaration
->id
= CTF_TYPE_STRING
;
1550 bt_ctf_field_type_init(&string
->parent
);
1551 string
->declaration
.encoding
= CTF_STRING_UTF8
;
1552 string
->parent
.declaration
->alignment
= CHAR_BIT
;
1553 return &string
->parent
;
1556 enum ctf_string_encoding
bt_ctf_field_type_string_get_encoding(
1557 struct bt_ctf_field_type
*type
)
1559 struct bt_ctf_field_type_string
*string
;
1560 enum ctf_string_encoding ret
= CTF_STRING_UNKNOWN
;
1562 if (!type
|| (type
->declaration
->id
!= CTF_TYPE_STRING
)) {
1566 string
= container_of(type
, struct bt_ctf_field_type_string
,
1568 ret
= string
->declaration
.encoding
;
1573 int bt_ctf_field_type_string_set_encoding(struct bt_ctf_field_type
*type
,
1574 enum ctf_string_encoding encoding
)
1577 struct bt_ctf_field_type_string
*string
;
1579 if (!type
|| type
->declaration
->id
!= CTF_TYPE_STRING
||
1580 (encoding
!= CTF_STRING_UTF8
&&
1581 encoding
!= CTF_STRING_ASCII
)) {
1586 string
= container_of(type
, struct bt_ctf_field_type_string
, parent
);
1587 string
->declaration
.encoding
= encoding
;
1592 int bt_ctf_field_type_get_alignment(struct bt_ctf_field_type
*type
)
1601 ret
= (int) type
->declaration
->alignment
;
1606 int bt_ctf_field_type_set_alignment(struct bt_ctf_field_type
*type
,
1607 unsigned int alignment
)
1611 /* Alignment must be bit-aligned (1) or byte aligned */
1612 if (!type
|| type
->frozen
|| (alignment
!= 1 && (alignment
& 0x7))) {
1617 if (type
->declaration
->id
== CTF_TYPE_STRING
&&
1618 alignment
!= CHAR_BIT
) {
1623 type
->declaration
->alignment
= alignment
;
1629 enum bt_ctf_byte_order
bt_ctf_field_type_get_byte_order(
1630 struct bt_ctf_field_type
*type
)
1632 enum bt_ctf_byte_order ret
= BT_CTF_BYTE_ORDER_UNKNOWN
;
1633 int internal_byte_order
= -1;
1639 switch (type
->declaration
->id
) {
1640 case CTF_TYPE_INTEGER
:
1642 struct bt_ctf_field_type_integer
*integer
= container_of(
1643 type
, struct bt_ctf_field_type_integer
, parent
);
1644 internal_byte_order
= integer
->declaration
.byte_order
;
1647 case CTF_TYPE_FLOAT
:
1649 struct bt_ctf_field_type_floating_point
*floating_point
=
1651 struct bt_ctf_field_type_floating_point
,
1653 internal_byte_order
= floating_point
->declaration
.byte_order
;
1660 switch (internal_byte_order
) {
1662 ret
= BT_CTF_BYTE_ORDER_LITTLE_ENDIAN
;
1665 ret
= BT_CTF_BYTE_ORDER_BIG_ENDIAN
;
1668 ret
= BT_CTF_BYTE_ORDER_NATIVE
;
1671 ret
= BT_CTF_BYTE_ORDER_UNKNOWN
;
1677 int bt_ctf_field_type_set_byte_order(struct bt_ctf_field_type
*type
,
1678 enum bt_ctf_byte_order byte_order
)
1681 int internal_byte_order
;
1682 enum ctf_type_id type_id
;
1684 if (!type
|| type
->frozen
) {
1689 type_id
= type
->declaration
->id
;
1690 switch (byte_order
) {
1691 case BT_CTF_BYTE_ORDER_NATIVE
:
1692 /* Leave unset. Will be initialized by parent. */
1693 internal_byte_order
= 0;
1695 case BT_CTF_BYTE_ORDER_LITTLE_ENDIAN
:
1696 internal_byte_order
= LITTLE_ENDIAN
;
1698 case BT_CTF_BYTE_ORDER_BIG_ENDIAN
:
1699 case BT_CTF_BYTE_ORDER_NETWORK
:
1700 internal_byte_order
= BIG_ENDIAN
;
1707 if (set_byte_order_funcs
[type_id
]) {
1708 set_byte_order_funcs
[type_id
](type
, internal_byte_order
, 0);
1714 enum ctf_type_id
bt_ctf_field_type_get_type_id(
1715 struct bt_ctf_field_type
*type
)
1718 return CTF_TYPE_UNKNOWN
;
1721 return type
->declaration
->id
;
1724 const char *bt_ctf_field_type_get_alias_name(
1725 struct bt_ctf_field_type
*type
)
1727 const char *name
= NULL
;
1729 if (!type
|| !type
->alias_name
) {
1733 name
= type
->alias_name
->str
;
1738 void bt_ctf_field_type_get(struct bt_ctf_field_type
*type
)
1744 bt_ctf_ref_get(&type
->ref_count
);
1747 void bt_ctf_field_type_put(struct bt_ctf_field_type
*type
)
1753 bt_ctf_ref_put(&type
->ref_count
, bt_ctf_field_type_destroy
);
1757 void bt_ctf_field_type_freeze(struct bt_ctf_field_type
*type
)
1767 struct bt_ctf_field_type
*bt_ctf_field_type_variant_get_field_type_signed(
1768 struct bt_ctf_field_type_variant
*variant
,
1771 struct bt_ctf_field_type
*type
= NULL
;
1772 GQuark field_name_quark
;
1774 struct structure_field
*field_entry
;
1775 struct range_overlap_query query
= {
1776 .range_start
._signed
= tag_value
,
1777 .range_end
._signed
= tag_value
,
1778 .mapping_name
= 0, .overlaps
= 0};
1780 g_ptr_array_foreach(variant
->tag
->entries
, check_ranges_overlap
,
1782 if (!query
.overlaps
) {
1786 field_name_quark
= query
.mapping_name
;
1787 if (!g_hash_table_lookup_extended(variant
->field_name_to_index
,
1788 GUINT_TO_POINTER(field_name_quark
), NULL
, &index
)) {
1792 field_entry
= g_ptr_array_index(variant
->fields
, (size_t) index
);
1793 type
= field_entry
->type
;
1799 struct bt_ctf_field_type
*bt_ctf_field_type_variant_get_field_type_unsigned(
1800 struct bt_ctf_field_type_variant
*variant
,
1803 struct bt_ctf_field_type
*type
= NULL
;
1804 GQuark field_name_quark
;
1806 struct structure_field
*field_entry
;
1807 struct range_overlap_query query
= {
1808 .range_start
._unsigned
= tag_value
,
1809 .range_end
._unsigned
= tag_value
,
1810 .mapping_name
= 0, .overlaps
= 0};
1812 g_ptr_array_foreach(variant
->tag
->entries
,
1813 check_ranges_overlap_unsigned
,
1815 if (!query
.overlaps
) {
1819 field_name_quark
= query
.mapping_name
;
1820 if (!g_hash_table_lookup_extended(variant
->field_name_to_index
,
1821 GUINT_TO_POINTER(field_name_quark
), NULL
, &index
)) {
1825 field_entry
= g_ptr_array_index(variant
->fields
, (size_t)index
);
1826 type
= field_entry
->type
;
1832 int bt_ctf_field_type_serialize(struct bt_ctf_field_type
*type
,
1833 struct metadata_context
*context
)
1837 if (!type
|| !context
) {
1842 ret
= type
->serialize(type
, context
);
1848 void bt_ctf_field_type_set_native_byte_order(struct bt_ctf_field_type
*type
,
1855 assert(byte_order
== LITTLE_ENDIAN
|| byte_order
== BIG_ENDIAN
);
1856 if (set_byte_order_funcs
[type
->declaration
->id
]) {
1857 set_byte_order_funcs
[type
->declaration
->id
](type
,
1863 void bt_ctf_field_type_integer_destroy(struct bt_ctf_ref
*ref
)
1865 struct bt_ctf_field_type_integer
*integer
;
1871 integer
= container_of(
1872 container_of(ref
, struct bt_ctf_field_type
, ref_count
),
1873 struct bt_ctf_field_type_integer
, parent
);
1874 bt_ctf_clock_put(integer
->mapped_clock
);
1879 void bt_ctf_field_type_enumeration_destroy(struct bt_ctf_ref
*ref
)
1881 struct bt_ctf_field_type_enumeration
*enumeration
;
1887 enumeration
= container_of(
1888 container_of(ref
, struct bt_ctf_field_type
, ref_count
),
1889 struct bt_ctf_field_type_enumeration
, parent
);
1890 g_ptr_array_free(enumeration
->entries
, TRUE
);
1891 bt_ctf_field_type_put(enumeration
->container
);
1892 g_free(enumeration
);
1896 void bt_ctf_field_type_floating_point_destroy(struct bt_ctf_ref
*ref
)
1898 struct bt_ctf_field_type_floating_point
*floating_point
;
1904 floating_point
= container_of(
1905 container_of(ref
, struct bt_ctf_field_type
, ref_count
),
1906 struct bt_ctf_field_type_floating_point
, parent
);
1907 g_free(floating_point
);
1911 void bt_ctf_field_type_structure_destroy(struct bt_ctf_ref
*ref
)
1913 struct bt_ctf_field_type_structure
*structure
;
1919 structure
= container_of(
1920 container_of(ref
, struct bt_ctf_field_type
, ref_count
),
1921 struct bt_ctf_field_type_structure
, parent
);
1922 g_ptr_array_free(structure
->fields
, TRUE
);
1923 g_hash_table_destroy(structure
->field_name_to_index
);
1928 void bt_ctf_field_type_variant_destroy(struct bt_ctf_ref
*ref
)
1930 struct bt_ctf_field_type_variant
*variant
;
1936 variant
= container_of(
1937 container_of(ref
, struct bt_ctf_field_type
, ref_count
),
1938 struct bt_ctf_field_type_variant
, parent
);
1939 g_ptr_array_free(variant
->fields
, TRUE
);
1940 g_hash_table_destroy(variant
->field_name_to_index
);
1941 g_string_free(variant
->tag_name
, TRUE
);
1942 bt_ctf_field_type_put(&variant
->tag
->parent
);
1947 void bt_ctf_field_type_array_destroy(struct bt_ctf_ref
*ref
)
1949 struct bt_ctf_field_type_array
*array
;
1955 array
= container_of(
1956 container_of(ref
, struct bt_ctf_field_type
, ref_count
),
1957 struct bt_ctf_field_type_array
, parent
);
1958 bt_ctf_field_type_put(array
->element_type
);
1963 void bt_ctf_field_type_sequence_destroy(struct bt_ctf_ref
*ref
)
1965 struct bt_ctf_field_type_sequence
*sequence
;
1971 sequence
= container_of(
1972 container_of(ref
, struct bt_ctf_field_type
, ref_count
),
1973 struct bt_ctf_field_type_sequence
, parent
);
1974 bt_ctf_field_type_put(sequence
->element_type
);
1975 g_string_free(sequence
->length_field_name
, TRUE
);
1980 void bt_ctf_field_type_string_destroy(struct bt_ctf_ref
*ref
)
1982 struct bt_ctf_field_type_string
*string
;
1988 string
= container_of(
1989 container_of(ref
, struct bt_ctf_field_type
, ref_count
),
1990 struct bt_ctf_field_type_string
, parent
);
1995 void generic_field_type_freeze(struct bt_ctf_field_type
*type
)
2001 void bt_ctf_field_type_enumeration_freeze(struct bt_ctf_field_type
*type
)
2003 struct bt_ctf_field_type_enumeration
*enumeration_type
= container_of(
2004 type
, struct bt_ctf_field_type_enumeration
, parent
);
2006 generic_field_type_freeze(type
);
2007 bt_ctf_field_type_freeze(enumeration_type
->container
);
2011 void freeze_structure_field(struct structure_field
*field
)
2013 bt_ctf_field_type_freeze(field
->type
);
2017 void bt_ctf_field_type_structure_freeze(struct bt_ctf_field_type
*type
)
2019 struct bt_ctf_field_type_structure
*structure_type
= container_of(
2020 type
, struct bt_ctf_field_type_structure
, parent
);
2022 generic_field_type_freeze(type
);
2023 g_ptr_array_foreach(structure_type
->fields
, (GFunc
)freeze_structure_field
,
2028 void bt_ctf_field_type_variant_freeze(struct bt_ctf_field_type
*type
)
2030 struct bt_ctf_field_type_variant
*variant_type
= container_of(
2031 type
, struct bt_ctf_field_type_variant
, parent
);
2033 generic_field_type_freeze(type
);
2034 g_ptr_array_foreach(variant_type
->fields
, (GFunc
)freeze_structure_field
,
2039 void bt_ctf_field_type_array_freeze(struct bt_ctf_field_type
*type
)
2041 struct bt_ctf_field_type_array
*array_type
= container_of(
2042 type
, struct bt_ctf_field_type_array
, parent
);
2044 generic_field_type_freeze(type
);
2045 bt_ctf_field_type_freeze(array_type
->element_type
);
2049 void bt_ctf_field_type_sequence_freeze(struct bt_ctf_field_type
*type
)
2051 struct bt_ctf_field_type_sequence
*sequence_type
= container_of(
2052 type
, struct bt_ctf_field_type_sequence
, parent
);
2054 generic_field_type_freeze(type
);
2055 bt_ctf_field_type_freeze(sequence_type
->element_type
);
2059 const char *get_encoding_string(enum ctf_string_encoding encoding
)
2061 const char *encoding_string
;
2064 case CTF_STRING_NONE
:
2065 encoding_string
= "none";
2067 case CTF_STRING_ASCII
:
2068 encoding_string
= "ASCII";
2070 case CTF_STRING_UTF8
:
2071 encoding_string
= "UTF8";
2074 encoding_string
= "unknown";
2078 return encoding_string
;
2082 const char *get_integer_base_string(enum bt_ctf_integer_base base
)
2084 const char *base_string
;
2087 case BT_CTF_INTEGER_BASE_DECIMAL
:
2088 base_string
= "decimal";
2090 case BT_CTF_INTEGER_BASE_HEXADECIMAL
:
2091 base_string
= "hexadecimal";
2093 case BT_CTF_INTEGER_BASE_OCTAL
:
2094 base_string
= "octal";
2096 case BT_CTF_INTEGER_BASE_BINARY
:
2097 base_string
= "binary";
2100 base_string
= "unknown";
2108 int bt_ctf_field_type_integer_serialize(struct bt_ctf_field_type
*type
,
2109 struct metadata_context
*context
)
2111 struct bt_ctf_field_type_integer
*integer
= container_of(type
,
2112 struct bt_ctf_field_type_integer
, parent
);
2115 g_string_append_printf(context
->string
,
2116 "integer { size = %zu; align = %zu; signed = %s; encoding = %s; base = %s; byte_order = %s",
2117 integer
->declaration
.len
, type
->declaration
->alignment
,
2118 (integer
->declaration
.signedness
? "true" : "false"),
2119 get_encoding_string(integer
->declaration
.encoding
),
2120 get_integer_base_string(integer
->declaration
.base
),
2121 get_byte_order_string(integer
->declaration
.byte_order
));
2122 if (integer
->mapped_clock
) {
2123 const char *clock_name
= bt_ctf_clock_get_name(
2124 integer
->mapped_clock
);
2131 g_string_append_printf(context
->string
,
2132 "; map = clock.%s.value", clock_name
);
2135 g_string_append(context
->string
, "; }");
2141 int bt_ctf_field_type_enumeration_serialize(struct bt_ctf_field_type
*type
,
2142 struct metadata_context
*context
)
2146 struct bt_ctf_field_type_enumeration
*enumeration
= container_of(type
,
2147 struct bt_ctf_field_type_enumeration
, parent
);
2148 struct bt_ctf_field_type
*container_type
;
2149 int container_signed
;
2151 ret
= bt_ctf_field_type_validate(type
);
2156 container_type
= bt_ctf_field_type_enumeration_get_container_type(type
);
2157 if (!container_type
) {
2162 container_signed
= bt_ctf_field_type_integer_get_signed(container_type
);
2163 if (container_signed
< 0) {
2164 ret
= container_signed
;
2165 goto error_put_container_type
;
2168 g_string_append(context
->string
, "enum : ");
2169 ret
= bt_ctf_field_type_serialize(enumeration
->container
, context
);
2171 goto error_put_container_type
;
2174 g_string_append(context
->string
, " { ");
2175 for (entry
= 0; entry
< enumeration
->entries
->len
; entry
++) {
2176 struct enumeration_mapping
*mapping
=
2177 enumeration
->entries
->pdata
[entry
];
2179 if (container_signed
) {
2180 if (mapping
->range_start
._signed
==
2181 mapping
->range_end
._signed
) {
2182 g_string_append_printf(context
->string
,
2183 "\"%s\" = %" PRId64
,
2184 g_quark_to_string(mapping
->string
),
2185 mapping
->range_start
._signed
);
2187 g_string_append_printf(context
->string
,
2188 "\"%s\" = %" PRId64
" ... %" PRId64
,
2189 g_quark_to_string(mapping
->string
),
2190 mapping
->range_start
._signed
,
2191 mapping
->range_end
._signed
);
2194 if (mapping
->range_start
._unsigned
==
2195 mapping
->range_end
._unsigned
) {
2196 g_string_append_printf(context
->string
,
2197 "\"%s\" = %" PRIu64
,
2198 g_quark_to_string(mapping
->string
),
2199 mapping
->range_start
._unsigned
);
2201 g_string_append_printf(context
->string
,
2202 "\"%s\" = %" PRIu64
" ... %" PRIu64
,
2203 g_quark_to_string(mapping
->string
),
2204 mapping
->range_start
._unsigned
,
2205 mapping
->range_end
._unsigned
);
2209 g_string_append(context
->string
,
2210 ((entry
!= (enumeration
->entries
->len
- 1)) ?
2214 if (context
->field_name
->len
) {
2215 g_string_append_printf(context
->string
, " %s",
2216 context
->field_name
->str
);
2217 g_string_assign(context
->field_name
, "");
2219 error_put_container_type
:
2220 bt_ctf_field_type_put(container_type
);
2226 int bt_ctf_field_type_floating_point_serialize(struct bt_ctf_field_type
*type
,
2227 struct metadata_context
*context
)
2229 struct bt_ctf_field_type_floating_point
*floating_point
= container_of(
2230 type
, struct bt_ctf_field_type_floating_point
, parent
);
2232 g_string_append_printf(context
->string
,
2233 "floating_point { exp_dig = %zu; mant_dig = %zu; byte_order = %s; align = %zu; }",
2234 floating_point
->declaration
.exp
->len
,
2235 floating_point
->declaration
.mantissa
->len
+ 1,
2236 get_byte_order_string(floating_point
->declaration
.byte_order
),
2237 type
->declaration
->alignment
);
2242 int bt_ctf_field_type_structure_serialize(struct bt_ctf_field_type
*type
,
2243 struct metadata_context
*context
)
2246 unsigned int indent
;
2248 struct bt_ctf_field_type_structure
*structure
= container_of(type
,
2249 struct bt_ctf_field_type_structure
, parent
);
2250 GString
*structure_field_name
= context
->field_name
;
2252 context
->field_name
= g_string_new("");
2254 context
->current_indentation_level
++;
2255 g_string_append(context
->string
, "struct {\n");
2257 for (i
= 0; i
< structure
->fields
->len
; i
++) {
2258 struct structure_field
*field
;
2260 for (indent
= 0; indent
< context
->current_indentation_level
;
2262 g_string_append_c(context
->string
, '\t');
2265 field
= structure
->fields
->pdata
[i
];
2266 g_string_assign(context
->field_name
,
2267 g_quark_to_string(field
->name
));
2268 ret
= bt_ctf_field_type_serialize(field
->type
, context
);
2273 if (context
->field_name
->len
) {
2274 g_string_append_printf(context
->string
, " %s",
2275 context
->field_name
->str
);
2277 g_string_append(context
->string
, ";\n");
2280 context
->current_indentation_level
--;
2281 for (indent
= 0; indent
< context
->current_indentation_level
;
2283 g_string_append_c(context
->string
, '\t');
2286 g_string_append_printf(context
->string
, "} align(%zu)",
2287 type
->declaration
->alignment
);
2289 g_string_free(context
->field_name
, TRUE
);
2290 context
->field_name
= structure_field_name
;
2295 int bt_ctf_field_type_variant_serialize(struct bt_ctf_field_type
*type
,
2296 struct metadata_context
*context
)
2299 unsigned int indent
;
2301 struct bt_ctf_field_type_variant
*variant
= container_of(
2302 type
, struct bt_ctf_field_type_variant
, parent
);
2303 GString
*variant_field_name
= context
->field_name
;
2305 context
->field_name
= g_string_new("");
2306 g_string_append_printf(context
->string
,
2307 "variant <%s> {\n", variant
->tag_name
->str
);
2308 context
->current_indentation_level
++;
2309 for (i
= 0; i
< variant
->fields
->len
; i
++) {
2310 struct structure_field
*field
= variant
->fields
->pdata
[i
];
2312 g_string_assign(context
->field_name
,
2313 g_quark_to_string(field
->name
));
2314 for (indent
= 0; indent
< context
->current_indentation_level
;
2316 g_string_append_c(context
->string
, '\t');
2319 g_string_assign(context
->field_name
,
2320 g_quark_to_string(field
->name
));
2321 ret
= bt_ctf_field_type_serialize(field
->type
, context
);
2326 if (context
->field_name
->len
) {
2327 g_string_append_printf(context
->string
, " %s;",
2328 context
->field_name
->str
);
2331 g_string_append_c(context
->string
, '\n');
2334 context
->current_indentation_level
--;
2335 for (indent
= 0; indent
< context
->current_indentation_level
;
2337 g_string_append_c(context
->string
, '\t');
2340 g_string_append(context
->string
, "}");
2342 g_string_free(context
->field_name
, TRUE
);
2343 context
->field_name
= variant_field_name
;
2348 int bt_ctf_field_type_array_serialize(struct bt_ctf_field_type
*type
,
2349 struct metadata_context
*context
)
2352 struct bt_ctf_field_type_array
*array
= container_of(type
,
2353 struct bt_ctf_field_type_array
, parent
);
2355 ret
= bt_ctf_field_type_serialize(array
->element_type
, context
);
2360 if (context
->field_name
->len
) {
2361 g_string_append_printf(context
->string
, " %s[%u]",
2362 context
->field_name
->str
, array
->length
);
2363 g_string_assign(context
->field_name
, "");
2365 g_string_append_printf(context
->string
, "[%u]", array
->length
);
2372 int bt_ctf_field_type_sequence_serialize(struct bt_ctf_field_type
*type
,
2373 struct metadata_context
*context
)
2376 struct bt_ctf_field_type_sequence
*sequence
= container_of(
2377 type
, struct bt_ctf_field_type_sequence
, parent
);
2379 ret
= bt_ctf_field_type_serialize(sequence
->element_type
, context
);
2384 if (context
->field_name
->len
) {
2385 g_string_append_printf(context
->string
, " %s[%s]",
2386 context
->field_name
->str
,
2387 sequence
->length_field_name
->str
);
2388 g_string_assign(context
->field_name
, "");
2390 g_string_append_printf(context
->string
, "[%s]",
2391 sequence
->length_field_name
->str
);
2398 int bt_ctf_field_type_string_serialize(struct bt_ctf_field_type
*type
,
2399 struct metadata_context
*context
)
2401 struct bt_ctf_field_type_string
*string
= container_of(
2402 type
, struct bt_ctf_field_type_string
, parent
);
2404 g_string_append_printf(context
->string
,
2405 "string { encoding = %s; }",
2406 get_encoding_string(string
->declaration
.encoding
));
2411 void bt_ctf_field_type_integer_set_byte_order(struct bt_ctf_field_type
*type
,
2412 int byte_order
, int set_native
)
2414 struct bt_ctf_field_type_integer
*integer_type
= container_of(type
,
2415 struct bt_ctf_field_type_integer
, parent
);
2418 integer_type
->declaration
.byte_order
=
2419 integer_type
->declaration
.byte_order
== 0 ?
2420 byte_order
: integer_type
->declaration
.byte_order
;
2422 integer_type
->declaration
.byte_order
= byte_order
;
2427 void bt_ctf_field_type_enumeration_set_byte_order(
2428 struct bt_ctf_field_type
*type
, int byte_order
, int set_native
)
2430 struct bt_ctf_field_type_enumeration
*enum_type
= container_of(type
,
2431 struct bt_ctf_field_type_enumeration
, parent
);
2433 /* Safe to assume that container is an integer */
2434 bt_ctf_field_type_integer_set_byte_order(enum_type
->container
,
2435 byte_order
, set_native
);
2439 void bt_ctf_field_type_floating_point_set_byte_order(
2440 struct bt_ctf_field_type
*type
, int byte_order
, int set_native
)
2442 struct bt_ctf_field_type_floating_point
*floating_point_type
=
2443 container_of(type
, struct bt_ctf_field_type_floating_point
,
2447 floating_point_type
->declaration
.byte_order
=
2448 floating_point_type
->declaration
.byte_order
== 0 ?
2450 floating_point_type
->declaration
.byte_order
;
2451 floating_point_type
->sign
.byte_order
=
2452 floating_point_type
->sign
.byte_order
== 0 ?
2453 byte_order
: floating_point_type
->sign
.byte_order
;
2454 floating_point_type
->mantissa
.byte_order
=
2455 floating_point_type
->mantissa
.byte_order
== 0 ?
2456 byte_order
: floating_point_type
->mantissa
.byte_order
;
2457 floating_point_type
->exp
.byte_order
=
2458 floating_point_type
->exp
.byte_order
== 0 ?
2459 byte_order
: floating_point_type
->exp
.byte_order
;
2461 floating_point_type
->declaration
.byte_order
= byte_order
;
2462 floating_point_type
->sign
.byte_order
= byte_order
;
2463 floating_point_type
->mantissa
.byte_order
= byte_order
;
2464 floating_point_type
->exp
.byte_order
= byte_order
;
2469 void bt_ctf_field_type_structure_set_byte_order(struct bt_ctf_field_type
*type
,
2470 int byte_order
, int set_native
)
2473 struct bt_ctf_field_type_structure
*structure_type
=
2474 container_of(type
, struct bt_ctf_field_type_structure
,
2477 for (i
= 0; i
< structure_type
->fields
->len
; i
++) {
2478 struct structure_field
*field
= g_ptr_array_index(
2479 structure_type
->fields
, i
);
2480 struct bt_ctf_field_type
*field_type
= field
->type
;
2482 if (set_byte_order_funcs
[field_type
->declaration
->id
]) {
2483 set_byte_order_funcs
[field_type
->declaration
->id
](
2484 field_type
, byte_order
, set_native
);
2490 void bt_ctf_field_type_variant_set_byte_order(struct bt_ctf_field_type
*type
,
2491 int byte_order
, int set_native
)
2494 struct bt_ctf_field_type_variant
*variant_type
=
2495 container_of(type
, struct bt_ctf_field_type_variant
,
2498 for (i
= 0; i
< variant_type
->fields
->len
; i
++) {
2499 struct structure_field
*field
= g_ptr_array_index(
2500 variant_type
->fields
, i
);
2501 struct bt_ctf_field_type
*field_type
= field
->type
;
2503 if (set_byte_order_funcs
[field_type
->declaration
->id
]) {
2504 set_byte_order_funcs
[field_type
->declaration
->id
](
2505 field_type
, byte_order
, set_native
);
2511 void bt_ctf_field_type_array_set_byte_order(struct bt_ctf_field_type
*type
,
2512 int byte_order
, int set_native
)
2514 struct bt_ctf_field_type_array
*array_type
=
2515 container_of(type
, struct bt_ctf_field_type_array
,
2518 if (set_byte_order_funcs
[array_type
->element_type
->declaration
->id
]) {
2519 set_byte_order_funcs
[array_type
->element_type
->declaration
->id
](
2520 array_type
->element_type
, byte_order
, set_native
);
2525 void bt_ctf_field_type_sequence_set_byte_order(struct bt_ctf_field_type
*type
,
2526 int byte_order
, int set_native
)
2528 struct bt_ctf_field_type_sequence
*sequence_type
=
2529 container_of(type
, struct bt_ctf_field_type_sequence
,
2532 if (set_byte_order_funcs
[
2533 sequence_type
->element_type
->declaration
->id
]) {
2534 set_byte_order_funcs
[
2535 sequence_type
->element_type
->declaration
->id
](
2536 sequence_type
->element_type
, byte_order
, set_native
);