4 * Babeltrace CTF Writer
6 * Copyright 2013 EfficiOS Inc.
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-writer/event-types-internal.h>
31 #include <babeltrace/ctf-writer/writer-internal.h>
32 #include <babeltrace/compiler.h>
33 #include <babeltrace/endian.h>
38 struct range_overlap_query
{
39 int64_t range_start
, range_end
;
45 void bt_ctf_field_type_integer_destroy(struct bt_ctf_ref
*);
47 void bt_ctf_field_type_enumeration_destroy(struct bt_ctf_ref
*);
49 void bt_ctf_field_type_floating_point_destroy(struct bt_ctf_ref
*);
51 void bt_ctf_field_type_structure_destroy(struct bt_ctf_ref
*);
53 void bt_ctf_field_type_variant_destroy(struct bt_ctf_ref
*);
55 void bt_ctf_field_type_array_destroy(struct bt_ctf_ref
*);
57 void bt_ctf_field_type_sequence_destroy(struct bt_ctf_ref
*);
59 void bt_ctf_field_type_string_destroy(struct bt_ctf_ref
*);
62 void (* const type_destroy_funcs
[])(struct bt_ctf_ref
*) = {
63 [CTF_TYPE_INTEGER
] = bt_ctf_field_type_integer_destroy
,
65 bt_ctf_field_type_enumeration_destroy
,
67 bt_ctf_field_type_floating_point_destroy
,
68 [CTF_TYPE_STRUCT
] = bt_ctf_field_type_structure_destroy
,
69 [CTF_TYPE_VARIANT
] = bt_ctf_field_type_variant_destroy
,
70 [CTF_TYPE_ARRAY
] = bt_ctf_field_type_array_destroy
,
71 [CTF_TYPE_SEQUENCE
] = bt_ctf_field_type_sequence_destroy
,
72 [CTF_TYPE_STRING
] = bt_ctf_field_type_string_destroy
,
76 void generic_field_type_freeze(struct bt_ctf_field_type
*);
78 void bt_ctf_field_type_enumeration_freeze(struct bt_ctf_field_type
*);
80 void bt_ctf_field_type_structure_freeze(struct bt_ctf_field_type
*);
82 void bt_ctf_field_type_variant_freeze(struct bt_ctf_field_type
*);
84 void bt_ctf_field_type_array_freeze(struct bt_ctf_field_type
*);
86 void bt_ctf_field_type_sequence_freeze(struct bt_ctf_field_type
*);
89 type_freeze_func
const type_freeze_funcs
[] = {
90 [CTF_TYPE_INTEGER
] = generic_field_type_freeze
,
91 [CTF_TYPE_ENUM
] = bt_ctf_field_type_enumeration_freeze
,
92 [CTF_TYPE_FLOAT
] = generic_field_type_freeze
,
93 [CTF_TYPE_STRUCT
] = bt_ctf_field_type_structure_freeze
,
94 [CTF_TYPE_VARIANT
] = bt_ctf_field_type_variant_freeze
,
95 [CTF_TYPE_ARRAY
] = bt_ctf_field_type_array_freeze
,
96 [CTF_TYPE_SEQUENCE
] = bt_ctf_field_type_sequence_freeze
,
97 [CTF_TYPE_STRING
] = generic_field_type_freeze
,
101 int bt_ctf_field_type_integer_serialize(struct bt_ctf_field_type
*,
102 struct metadata_context
*);
104 int bt_ctf_field_type_enumeration_serialize(struct bt_ctf_field_type
*,
105 struct metadata_context
*);
107 int bt_ctf_field_type_floating_point_serialize(
108 struct bt_ctf_field_type
*, struct metadata_context
*);
110 int bt_ctf_field_type_structure_serialize(struct bt_ctf_field_type
*,
111 struct metadata_context
*);
113 int bt_ctf_field_type_variant_serialize(struct bt_ctf_field_type
*,
114 struct metadata_context
*);
116 int bt_ctf_field_type_array_serialize(struct bt_ctf_field_type
*,
117 struct metadata_context
*);
119 int bt_ctf_field_type_sequence_serialize(struct bt_ctf_field_type
*,
120 struct metadata_context
*);
122 int bt_ctf_field_type_string_serialize(struct bt_ctf_field_type
*,
123 struct metadata_context
*);
126 type_serialize_func
const type_serialize_funcs
[] = {
127 [CTF_TYPE_INTEGER
] = bt_ctf_field_type_integer_serialize
,
129 bt_ctf_field_type_enumeration_serialize
,
131 bt_ctf_field_type_floating_point_serialize
,
133 bt_ctf_field_type_structure_serialize
,
134 [CTF_TYPE_VARIANT
] = bt_ctf_field_type_variant_serialize
,
135 [CTF_TYPE_ARRAY
] = bt_ctf_field_type_array_serialize
,
136 [CTF_TYPE_SEQUENCE
] = bt_ctf_field_type_sequence_serialize
,
137 [CTF_TYPE_STRING
] = bt_ctf_field_type_string_serialize
,
141 void bt_ctf_field_type_integer_set_byte_order(struct bt_ctf_field_type
*,
144 void bt_ctf_field_type_floating_point_set_byte_order(
145 struct bt_ctf_field_type
*, int byte_order
);
148 void (* const set_byte_order_funcs
[])(struct bt_ctf_field_type
*,
151 bt_ctf_field_type_integer_set_byte_order
,
153 bt_ctf_field_type_floating_point_set_byte_order
,
154 [CTF_TYPE_ENUM
... CTF_TYPE_SEQUENCE
] = NULL
,
159 void destroy_enumeration_mapping(struct enumeration_mapping
*mapping
)
165 void destroy_structure_field(struct structure_field
*field
)
168 bt_ctf_field_type_put(field
->type
);
175 void check_ranges_overlap(gpointer element
, gpointer query
)
177 struct enumeration_mapping
*mapping
= element
;
178 struct range_overlap_query
*overlap_query
= query
;
180 if (mapping
->range_start
<= overlap_query
->range_end
181 && overlap_query
->range_start
<= mapping
->range_end
) {
182 overlap_query
->overlaps
= 1;
183 overlap_query
->mapping_name
= mapping
->string
;
186 overlap_query
->overlaps
|=
187 mapping
->string
== overlap_query
->mapping_name
;
191 void bt_ctf_field_type_init(struct bt_ctf_field_type
*type
)
193 enum ctf_type_id type_id
= type
->declaration
->id
;
196 assert(type
&& (type_id
> CTF_TYPE_UNKNOWN
) &&
197 (type_id
< NR_CTF_TYPES
));
199 bt_ctf_ref_init(&type
->ref_count
);
200 type
->freeze
= type_freeze_funcs
[type_id
];
201 type
->serialize
= type_serialize_funcs
[type_id
];
202 ret
= bt_ctf_field_type_set_byte_order(type
, BT_CTF_BYTE_ORDER_NATIVE
);
204 type
->declaration
->alignment
= 1;
208 int add_structure_field(GPtrArray
*fields
,
209 GHashTable
*field_name_to_index
,
210 struct bt_ctf_field_type
*field_type
,
211 const char *field_name
)
214 GQuark name_quark
= g_quark_from_string(field_name
);
215 struct structure_field
*field
;
217 /* Make sure structure does not contain a field of the same name */
218 if (g_hash_table_lookup_extended(field_name_to_index
,
219 GUINT_TO_POINTER(name_quark
), NULL
, NULL
)) {
224 field
= g_new0(struct structure_field
, 1);
230 bt_ctf_field_type_get(field_type
);
231 field
->name
= name_quark
;
232 field
->type
= field_type
;
233 g_hash_table_insert(field_name_to_index
,
234 (gpointer
) (unsigned long) name_quark
,
235 (gpointer
) (unsigned long) fields
->len
);
236 g_ptr_array_add(fields
, field
);
237 bt_ctf_field_type_freeze(field_type
);
243 int bt_ctf_field_type_validate(struct bt_ctf_field_type
*type
)
252 if (type
->declaration
->id
== CTF_TYPE_ENUM
) {
253 struct bt_ctf_field_type_enumeration
*enumeration
=
254 container_of(type
, struct bt_ctf_field_type_enumeration
,
257 ret
= enumeration
->entries
->len
? 0 : -1;
263 struct bt_ctf_field_type
*bt_ctf_field_type_integer_create(unsigned int size
)
265 struct bt_ctf_field_type_integer
*integer
=
266 g_new0(struct bt_ctf_field_type_integer
, 1);
268 if (!integer
|| size
> 64) {
272 integer
->parent
.declaration
= &integer
->declaration
.p
;
273 integer
->parent
.declaration
->id
= CTF_TYPE_INTEGER
;
274 integer
->declaration
.len
= size
;
275 integer
->declaration
.base
= BT_CTF_INTEGER_BASE_DECIMAL
;
276 integer
->declaration
.encoding
= CTF_STRING_NONE
;
277 bt_ctf_field_type_init(&integer
->parent
);
278 return &integer
->parent
;
281 int bt_ctf_field_type_integer_set_signed(struct bt_ctf_field_type
*type
,
285 struct bt_ctf_field_type_integer
*integer
;
287 if (!type
|| type
->frozen
||
288 type
->declaration
->id
!= CTF_TYPE_INTEGER
) {
293 integer
= container_of(type
, struct bt_ctf_field_type_integer
, parent
);
294 if (is_signed
&& integer
->declaration
.len
<= 1) {
299 integer
->declaration
.signedness
= !!is_signed
;
304 int bt_ctf_field_type_integer_set_base(struct bt_ctf_field_type
*type
,
305 enum bt_ctf_integer_base base
)
309 if (!type
|| type
->frozen
||
310 type
->declaration
->id
!= CTF_TYPE_INTEGER
) {
316 case BT_CTF_INTEGER_BASE_BINARY
:
317 case BT_CTF_INTEGER_BASE_OCTAL
:
318 case BT_CTF_INTEGER_BASE_DECIMAL
:
319 case BT_CTF_INTEGER_BASE_HEXADECIMAL
:
321 struct bt_ctf_field_type_integer
*integer
= container_of(type
,
322 struct bt_ctf_field_type_integer
, parent
);
323 integer
->declaration
.base
= base
;
333 int bt_ctf_field_type_integer_set_encoding(struct bt_ctf_field_type
*type
,
334 enum ctf_string_encoding encoding
)
337 struct bt_ctf_field_type_integer
*integer
;
339 if (!type
|| type
->frozen
||
340 (type
->declaration
->id
!= CTF_TYPE_INTEGER
) ||
341 (encoding
< CTF_STRING_NONE
) ||
342 (encoding
>= CTF_STRING_UNKNOWN
)) {
347 integer
= container_of(type
, struct bt_ctf_field_type_integer
, parent
);
348 integer
->declaration
.encoding
= encoding
;
353 struct bt_ctf_field_type
*bt_ctf_field_type_enumeration_create(
354 struct bt_ctf_field_type
*integer_container_type
)
356 struct bt_ctf_field_type_enumeration
*enumeration
= NULL
;
358 if (!integer_container_type
) {
362 enumeration
= g_new0(struct bt_ctf_field_type_enumeration
, 1);
367 enumeration
->parent
.declaration
= &enumeration
->declaration
.p
;
368 enumeration
->parent
.declaration
->id
= CTF_TYPE_ENUM
;
369 bt_ctf_field_type_get(integer_container_type
);
370 enumeration
->container
= integer_container_type
;
371 enumeration
->entries
= g_ptr_array_new_with_free_func(
372 (GDestroyNotify
)destroy_enumeration_mapping
);
373 bt_ctf_field_type_init(&enumeration
->parent
);
374 return &enumeration
->parent
;
380 int bt_ctf_field_type_enumeration_add_mapping(
381 struct bt_ctf_field_type
*type
, const char *string
,
382 int64_t range_start
, int64_t range_end
)
386 struct enumeration_mapping
*mapping
;
387 struct bt_ctf_field_type_enumeration
*enumeration
;
388 struct range_overlap_query query
;
389 char *escaped_string
;
391 if (!type
|| (type
->declaration
->id
!= CTF_TYPE_ENUM
) ||
393 (range_end
< range_start
)) {
398 if (!string
|| strlen(string
) == 0) {
403 escaped_string
= g_strescape(string
, NULL
);
404 if (!escaped_string
) {
409 mapping_name
= g_quark_from_string(escaped_string
);
410 query
= (struct range_overlap_query
) { .range_start
= range_start
,
411 .range_end
= range_end
,
412 .mapping_name
= mapping_name
,
414 enumeration
= container_of(type
, struct bt_ctf_field_type_enumeration
,
417 /* Check that the range does not overlap with one already present */
418 g_ptr_array_foreach(enumeration
->entries
, check_ranges_overlap
, &query
);
419 if (query
.overlaps
) {
424 mapping
= g_new(struct enumeration_mapping
, 1);
430 *mapping
= (struct enumeration_mapping
) {.range_start
= range_start
,
431 .range_end
= range_end
, .string
= mapping_name
};
432 g_ptr_array_add(enumeration
->entries
, mapping
);
434 free(escaped_string
);
439 struct bt_ctf_field_type
*bt_ctf_field_type_floating_point_create(void)
441 struct bt_ctf_field_type_floating_point
*floating_point
=
442 g_new0(struct bt_ctf_field_type_floating_point
, 1);
444 if (!floating_point
) {
448 floating_point
->declaration
.sign
= &floating_point
->sign
;
449 floating_point
->declaration
.mantissa
= &floating_point
->mantissa
;
450 floating_point
->declaration
.exp
= &floating_point
->exp
;
451 floating_point
->sign
.len
= 1;
452 floating_point
->parent
.declaration
= &floating_point
->declaration
.p
;
453 floating_point
->parent
.declaration
->id
= CTF_TYPE_FLOAT
;
454 floating_point
->declaration
.exp
->len
=
455 sizeof(float) * CHAR_BIT
- FLT_MANT_DIG
;
456 floating_point
->declaration
.mantissa
->len
= FLT_MANT_DIG
- 1;
457 floating_point
->sign
.p
.alignment
= 1;
458 floating_point
->mantissa
.p
.alignment
= 1;
459 floating_point
->exp
.p
.alignment
= 1;
461 bt_ctf_field_type_init(&floating_point
->parent
);
463 return floating_point
? &floating_point
->parent
: NULL
;
466 int bt_ctf_field_type_floating_point_set_exponent_digits(
467 struct bt_ctf_field_type
*type
,
468 unsigned int exponent_digits
)
471 struct bt_ctf_field_type_floating_point
*floating_point
;
473 if (!type
|| type
->frozen
||
474 (type
->declaration
->id
!= CTF_TYPE_FLOAT
)) {
479 floating_point
= container_of(type
,
480 struct bt_ctf_field_type_floating_point
, parent
);
481 if ((exponent_digits
!= sizeof(float) * CHAR_BIT
- FLT_MANT_DIG
) &&
482 (exponent_digits
!= sizeof(double) * CHAR_BIT
- DBL_MANT_DIG
) &&
484 sizeof(long double) * CHAR_BIT
- LDBL_MANT_DIG
)) {
489 floating_point
->declaration
.exp
->len
= exponent_digits
;
494 int bt_ctf_field_type_floating_point_set_mantissa_digits(
495 struct bt_ctf_field_type
*type
,
496 unsigned int mantissa_digits
)
499 struct bt_ctf_field_type_floating_point
*floating_point
;
501 if (!type
|| type
->frozen
||
502 (type
->declaration
->id
!= CTF_TYPE_FLOAT
)) {
507 floating_point
= container_of(type
,
508 struct bt_ctf_field_type_floating_point
, parent
);
510 if ((mantissa_digits
!= FLT_MANT_DIG
) &&
511 (mantissa_digits
!= DBL_MANT_DIG
) &&
512 (mantissa_digits
!= LDBL_MANT_DIG
)) {
517 floating_point
->declaration
.mantissa
->len
= mantissa_digits
- 1;
522 struct bt_ctf_field_type
*bt_ctf_field_type_structure_create(void)
524 struct bt_ctf_field_type_structure
*structure
=
525 g_new0(struct bt_ctf_field_type_structure
, 1);
531 structure
->parent
.declaration
= &structure
->declaration
.p
;
532 structure
->parent
.declaration
->id
= CTF_TYPE_STRUCT
;
533 bt_ctf_field_type_init(&structure
->parent
);
534 structure
->fields
= g_ptr_array_new_with_free_func(
535 (GDestroyNotify
)destroy_structure_field
);
536 structure
->field_name_to_index
= g_hash_table_new(NULL
, NULL
);
537 return &structure
->parent
;
542 int bt_ctf_field_type_structure_add_field(struct bt_ctf_field_type
*type
,
543 struct bt_ctf_field_type
*field_type
,
544 const char *field_name
)
547 struct bt_ctf_field_type_structure
*structure
;
549 if (!type
|| !field_type
|| type
->frozen
||
550 validate_identifier(field_name
) ||
551 (type
->declaration
->id
!= CTF_TYPE_STRUCT
) ||
552 bt_ctf_field_type_validate(field_type
)) {
556 structure
= container_of(type
,
557 struct bt_ctf_field_type_structure
, parent
);
558 if (add_structure_field(structure
->fields
,
559 structure
->field_name_to_index
, field_type
, field_name
)) {
564 if (type
->declaration
->alignment
< field_type
->declaration
->alignment
) {
565 type
->declaration
->alignment
=
566 field_type
->declaration
->alignment
;
572 struct bt_ctf_field_type
*bt_ctf_field_type_variant_create(
573 struct bt_ctf_field_type
*enum_tag
, const char *tag_name
)
575 struct bt_ctf_field_type_variant
*variant
= NULL
;
577 if (!enum_tag
|| validate_identifier(tag_name
) ||
578 (enum_tag
->declaration
->id
!= CTF_TYPE_ENUM
)) {
582 variant
= g_new0(struct bt_ctf_field_type_variant
, 1);
587 variant
->parent
.declaration
= &variant
->declaration
.p
;
588 variant
->parent
.declaration
->id
= CTF_TYPE_VARIANT
;
589 variant
->tag_name
= g_string_new(tag_name
);
590 bt_ctf_field_type_init(&variant
->parent
);
591 variant
->field_name_to_index
= g_hash_table_new(NULL
, NULL
);
592 variant
->fields
= g_ptr_array_new_with_free_func(
593 (GDestroyNotify
)destroy_structure_field
);
594 bt_ctf_field_type_get(enum_tag
);
595 variant
->tag
= container_of(enum_tag
,
596 struct bt_ctf_field_type_enumeration
, parent
);
597 return &variant
->parent
;
602 int bt_ctf_field_type_variant_add_field(struct bt_ctf_field_type
*type
,
603 struct bt_ctf_field_type
*field_type
,
604 const char *field_name
)
609 struct bt_ctf_field_type_variant
*variant
;
610 GQuark field_name_quark
= g_quark_from_string(field_name
);
612 if (!type
|| !field_type
|| type
->frozen
||
613 validate_identifier(field_name
) ||
614 (type
->declaration
->id
!= CTF_TYPE_VARIANT
) ||
615 bt_ctf_field_type_validate(field_type
)) {
620 variant
= container_of(type
, struct bt_ctf_field_type_variant
, parent
);
621 /* Make sure this name is present in the enum tag */
622 for (i
= 0; i
< variant
->tag
->entries
->len
; i
++) {
623 struct enumeration_mapping
*mapping
=
624 g_ptr_array_index(variant
->tag
->entries
, i
);
626 if (mapping
->string
== field_name_quark
) {
632 if (!name_found
|| add_structure_field(variant
->fields
,
633 variant
->field_name_to_index
, field_type
, field_name
)) {
641 struct bt_ctf_field_type
*bt_ctf_field_type_array_create(
642 struct bt_ctf_field_type
*element_type
,
645 struct bt_ctf_field_type_array
*array
= NULL
;
647 if (!element_type
|| length
== 0 ||
648 bt_ctf_field_type_validate(element_type
)) {
652 array
= g_new0(struct bt_ctf_field_type_array
, 1);
657 array
->parent
.declaration
= &array
->declaration
.p
;
658 array
->parent
.declaration
->id
= CTF_TYPE_ARRAY
;
659 bt_ctf_field_type_init(&array
->parent
);
660 bt_ctf_field_type_get(element_type
);
661 array
->element_type
= element_type
;
662 array
->length
= length
;
663 array
->parent
.declaration
->alignment
=
664 element_type
->declaration
->alignment
;
665 return &array
->parent
;
670 struct bt_ctf_field_type
*bt_ctf_field_type_sequence_create(
671 struct bt_ctf_field_type
*element_type
,
672 const char *length_field_name
)
674 struct bt_ctf_field_type_sequence
*sequence
= NULL
;
676 if (!element_type
|| validate_identifier(length_field_name
) ||
677 bt_ctf_field_type_validate(element_type
)) {
681 sequence
= g_new0(struct bt_ctf_field_type_sequence
, 1);
686 sequence
->parent
.declaration
= &sequence
->declaration
.p
;
687 sequence
->parent
.declaration
->id
= CTF_TYPE_SEQUENCE
;
688 bt_ctf_field_type_init(&sequence
->parent
);
689 bt_ctf_field_type_get(element_type
);
690 sequence
->element_type
= element_type
;
691 sequence
->length_field_name
= g_string_new(length_field_name
);
692 sequence
->parent
.declaration
->alignment
=
693 element_type
->declaration
->alignment
;
694 return &sequence
->parent
;
699 struct bt_ctf_field_type
*bt_ctf_field_type_string_create(void)
701 struct bt_ctf_field_type_string
*string
=
702 g_new0(struct bt_ctf_field_type_string
, 1);
708 string
->parent
.declaration
= &string
->declaration
.p
;
709 string
->parent
.declaration
->id
= CTF_TYPE_STRING
;
710 bt_ctf_field_type_init(&string
->parent
);
711 string
->declaration
.encoding
= CTF_STRING_UTF8
;
712 string
->parent
.declaration
->alignment
= CHAR_BIT
;
713 return &string
->parent
;
716 int bt_ctf_field_type_string_set_encoding(
717 struct bt_ctf_field_type
*type
,
718 enum ctf_string_encoding encoding
)
721 struct bt_ctf_field_type_string
*string
;
723 if (!type
|| type
->declaration
->id
!= CTF_TYPE_STRING
||
724 (encoding
!= CTF_STRING_UTF8
&&
725 encoding
!= CTF_STRING_ASCII
)) {
730 string
= container_of(type
, struct bt_ctf_field_type_string
, parent
);
731 string
->declaration
.encoding
= encoding
;
736 int bt_ctf_field_type_set_alignment(struct bt_ctf_field_type
*type
,
737 unsigned int alignment
)
741 /* Alignment must be bit-aligned (1) or byte aligned */
742 if (!type
|| type
->frozen
|| (alignment
!= 1 && (alignment
& 0x7))) {
747 if (type
->declaration
->id
== CTF_TYPE_STRING
&&
748 alignment
!= CHAR_BIT
) {
753 type
->declaration
->alignment
= alignment
;
759 int bt_ctf_field_type_set_byte_order(struct bt_ctf_field_type
*type
,
760 enum bt_ctf_byte_order byte_order
)
763 int internal_byte_order
;
764 enum ctf_type_id type_id
;
766 if (!type
|| type
->frozen
) {
771 type_id
= type
->declaration
->id
;
772 switch (byte_order
) {
773 case BT_CTF_BYTE_ORDER_NATIVE
:
774 internal_byte_order
= (G_BYTE_ORDER
== G_LITTLE_ENDIAN
?
775 LITTLE_ENDIAN
: BIG_ENDIAN
);
777 case BT_CTF_BYTE_ORDER_LITTLE_ENDIAN
:
778 internal_byte_order
= LITTLE_ENDIAN
;
780 case BT_CTF_BYTE_ORDER_BIG_ENDIAN
:
781 case BT_CTF_BYTE_ORDER_NETWORK
:
782 internal_byte_order
= BIG_ENDIAN
;
789 if (set_byte_order_funcs
[type_id
]) {
790 set_byte_order_funcs
[type_id
](type
, internal_byte_order
);
796 void bt_ctf_field_type_get(struct bt_ctf_field_type
*type
)
802 bt_ctf_ref_get(&type
->ref_count
);
805 void bt_ctf_field_type_put(struct bt_ctf_field_type
*type
)
807 enum ctf_type_id type_id
;
813 type_id
= type
->declaration
->id
;
814 assert(type_id
> CTF_TYPE_UNKNOWN
&& type_id
< NR_CTF_TYPES
);
815 bt_ctf_ref_put(&type
->ref_count
, type_destroy_funcs
[type_id
]);
819 void bt_ctf_field_type_freeze(struct bt_ctf_field_type
*type
)
829 enum ctf_type_id
bt_ctf_field_type_get_type_id(
830 struct bt_ctf_field_type
*type
)
833 return CTF_TYPE_UNKNOWN
;
836 return type
->declaration
->id
;
840 struct bt_ctf_field_type
*bt_ctf_field_type_structure_get_type(
841 struct bt_ctf_field_type_structure
*structure
,
844 struct bt_ctf_field_type
*type
= NULL
;
845 struct structure_field
*field
;
846 GQuark name_quark
= g_quark_try_string(name
);
853 if (!g_hash_table_lookup_extended(structure
->field_name_to_index
,
854 GUINT_TO_POINTER(name_quark
), NULL
, (gpointer
*)&index
)) {
858 field
= structure
->fields
->pdata
[index
];
865 struct bt_ctf_field_type
*bt_ctf_field_type_array_get_element_type(
866 struct bt_ctf_field_type_array
*array
)
869 return array
->element_type
;
873 struct bt_ctf_field_type
*bt_ctf_field_type_sequence_get_element_type(
874 struct bt_ctf_field_type_sequence
*sequence
)
877 return sequence
->element_type
;
881 struct bt_ctf_field_type
*bt_ctf_field_type_variant_get_field_type(
882 struct bt_ctf_field_type_variant
*variant
,
885 struct bt_ctf_field_type
*type
= NULL
;
886 GQuark field_name_quark
;
888 struct structure_field
*field_entry
;
889 struct range_overlap_query query
= {.range_start
= tag_value
,
890 .range_end
= tag_value
, .mapping_name
= 0, .overlaps
= 0};
892 g_ptr_array_foreach(variant
->tag
->entries
, check_ranges_overlap
,
894 if (!query
.overlaps
) {
898 field_name_quark
= query
.mapping_name
;
899 if (!g_hash_table_lookup_extended(variant
->field_name_to_index
,
900 GUINT_TO_POINTER(field_name_quark
), NULL
, &index
)) {
904 field_entry
= g_ptr_array_index(variant
->fields
, (size_t)index
);
905 type
= field_entry
->type
;
911 int bt_ctf_field_type_serialize(struct bt_ctf_field_type
*type
,
912 struct metadata_context
*context
)
916 if (!type
|| !context
) {
921 ret
= type
->serialize(type
, context
);
927 void bt_ctf_field_type_integer_destroy(struct bt_ctf_ref
*ref
)
929 struct bt_ctf_field_type_integer
*integer
;
935 integer
= container_of(
936 container_of(ref
, struct bt_ctf_field_type
, ref_count
),
937 struct bt_ctf_field_type_integer
, parent
);
942 void bt_ctf_field_type_enumeration_destroy(struct bt_ctf_ref
*ref
)
944 struct bt_ctf_field_type_enumeration
*enumeration
;
950 enumeration
= container_of(
951 container_of(ref
, struct bt_ctf_field_type
, ref_count
),
952 struct bt_ctf_field_type_enumeration
, parent
);
953 g_ptr_array_free(enumeration
->entries
, TRUE
);
954 bt_ctf_field_type_put(enumeration
->container
);
959 void bt_ctf_field_type_floating_point_destroy(struct bt_ctf_ref
*ref
)
961 struct bt_ctf_field_type_floating_point
*floating_point
;
967 floating_point
= container_of(
968 container_of(ref
, struct bt_ctf_field_type
, ref_count
),
969 struct bt_ctf_field_type_floating_point
, parent
);
970 g_free(floating_point
);
974 void bt_ctf_field_type_structure_destroy(struct bt_ctf_ref
*ref
)
976 struct bt_ctf_field_type_structure
*structure
;
982 structure
= container_of(
983 container_of(ref
, struct bt_ctf_field_type
, ref_count
),
984 struct bt_ctf_field_type_structure
, parent
);
985 g_ptr_array_free(structure
->fields
, TRUE
);
986 g_hash_table_destroy(structure
->field_name_to_index
);
991 void bt_ctf_field_type_variant_destroy(struct bt_ctf_ref
*ref
)
993 struct bt_ctf_field_type_variant
*variant
;
999 variant
= container_of(
1000 container_of(ref
, struct bt_ctf_field_type
, ref_count
),
1001 struct bt_ctf_field_type_variant
, parent
);
1002 g_ptr_array_free(variant
->fields
, TRUE
);
1003 g_hash_table_destroy(variant
->field_name_to_index
);
1004 g_string_free(variant
->tag_name
, TRUE
);
1005 bt_ctf_field_type_put(&variant
->tag
->parent
);
1010 void bt_ctf_field_type_array_destroy(struct bt_ctf_ref
*ref
)
1012 struct bt_ctf_field_type_array
*array
;
1018 array
= container_of(
1019 container_of(ref
, struct bt_ctf_field_type
, ref_count
),
1020 struct bt_ctf_field_type_array
, parent
);
1021 bt_ctf_field_type_put(array
->element_type
);
1026 void bt_ctf_field_type_sequence_destroy(struct bt_ctf_ref
*ref
)
1028 struct bt_ctf_field_type_sequence
*sequence
;
1034 sequence
= container_of(
1035 container_of(ref
, struct bt_ctf_field_type
, ref_count
),
1036 struct bt_ctf_field_type_sequence
, parent
);
1037 bt_ctf_field_type_put(sequence
->element_type
);
1038 g_string_free(sequence
->length_field_name
, TRUE
);
1043 void bt_ctf_field_type_string_destroy(struct bt_ctf_ref
*ref
)
1045 struct bt_ctf_field_type_string
*string
;
1051 string
= container_of(
1052 container_of(ref
, struct bt_ctf_field_type
, ref_count
),
1053 struct bt_ctf_field_type_string
, parent
);
1058 void generic_field_type_freeze(struct bt_ctf_field_type
*type
)
1064 void bt_ctf_field_type_enumeration_freeze(struct bt_ctf_field_type
*type
)
1066 struct bt_ctf_field_type_enumeration
*enumeration_type
= container_of(
1067 type
, struct bt_ctf_field_type_enumeration
, parent
);
1069 generic_field_type_freeze(type
);
1070 bt_ctf_field_type_freeze(enumeration_type
->container
);
1074 void freeze_structure_field(struct structure_field
*field
)
1076 bt_ctf_field_type_freeze(field
->type
);
1080 void bt_ctf_field_type_structure_freeze(struct bt_ctf_field_type
*type
)
1082 struct bt_ctf_field_type_structure
*structure_type
= container_of(
1083 type
, struct bt_ctf_field_type_structure
, parent
);
1085 generic_field_type_freeze(type
);
1086 g_ptr_array_foreach(structure_type
->fields
, (GFunc
)freeze_structure_field
,
1091 void bt_ctf_field_type_variant_freeze(struct bt_ctf_field_type
*type
)
1093 struct bt_ctf_field_type_variant
*variant_type
= container_of(
1094 type
, struct bt_ctf_field_type_variant
, parent
);
1096 generic_field_type_freeze(type
);
1097 g_ptr_array_foreach(variant_type
->fields
, (GFunc
)freeze_structure_field
,
1102 void bt_ctf_field_type_array_freeze(struct bt_ctf_field_type
*type
)
1104 struct bt_ctf_field_type_array
*array_type
= container_of(
1105 type
, struct bt_ctf_field_type_array
, parent
);
1107 generic_field_type_freeze(type
);
1108 bt_ctf_field_type_freeze(array_type
->element_type
);
1112 void bt_ctf_field_type_sequence_freeze(struct bt_ctf_field_type
*type
)
1114 struct bt_ctf_field_type_sequence
*sequence_type
= container_of(
1115 type
, struct bt_ctf_field_type_sequence
, parent
);
1117 generic_field_type_freeze(type
);
1118 bt_ctf_field_type_freeze(sequence_type
->element_type
);
1122 const char *get_encoding_string(enum ctf_string_encoding encoding
)
1124 const char *encoding_string
;
1127 case CTF_STRING_NONE
:
1128 encoding_string
= "none";
1130 case CTF_STRING_ASCII
:
1131 encoding_string
= "ASCII";
1133 case CTF_STRING_UTF8
:
1134 encoding_string
= "UTF8";
1137 encoding_string
= "unknown";
1141 return encoding_string
;
1145 const char *get_integer_base_string(enum bt_ctf_integer_base base
)
1147 const char *base_string
;
1150 case BT_CTF_INTEGER_BASE_DECIMAL
:
1151 base_string
= "decimal";
1153 case BT_CTF_INTEGER_BASE_HEXADECIMAL
:
1154 base_string
= "hexadecimal";
1156 case BT_CTF_INTEGER_BASE_OCTAL
:
1157 base_string
= "octal";
1159 case BT_CTF_INTEGER_BASE_BINARY
:
1160 base_string
= "binary";
1163 base_string
= "unknown";
1171 int bt_ctf_field_type_integer_serialize(struct bt_ctf_field_type
*type
,
1172 struct metadata_context
*context
)
1174 struct bt_ctf_field_type_integer
*integer
= container_of(type
,
1175 struct bt_ctf_field_type_integer
, parent
);
1177 g_string_append_printf(context
->string
,
1178 "integer { size = %zu; align = %zu; signed = %s; encoding = %s; base = %s; byte_order = %s; }",
1179 integer
->declaration
.len
, type
->declaration
->alignment
,
1180 (integer
->declaration
.signedness
? "true" : "false"),
1181 get_encoding_string(integer
->declaration
.encoding
),
1182 get_integer_base_string(integer
->declaration
.base
),
1183 get_byte_order_string(integer
->declaration
.byte_order
));
1188 int bt_ctf_field_type_enumeration_serialize(struct bt_ctf_field_type
*type
,
1189 struct metadata_context
*context
)
1193 struct bt_ctf_field_type_enumeration
*enumeration
= container_of(type
,
1194 struct bt_ctf_field_type_enumeration
, parent
);
1196 ret
= bt_ctf_field_type_validate(type
);
1201 g_string_append(context
->string
, "enum : ");
1202 ret
= bt_ctf_field_type_serialize(enumeration
->container
, context
);
1207 g_string_append(context
->string
, " { ");
1208 for (entry
= 0; entry
< enumeration
->entries
->len
; entry
++) {
1209 struct enumeration_mapping
*mapping
=
1210 enumeration
->entries
->pdata
[entry
];
1212 if (mapping
->range_start
== mapping
->range_end
) {
1213 g_string_append_printf(context
->string
,
1214 "\"%s\" = %" PRId64
,
1215 g_quark_to_string(mapping
->string
),
1216 mapping
->range_start
);
1218 g_string_append_printf(context
->string
,
1219 "\"%s\" = %" PRId64
" ... %" PRId64
,
1220 g_quark_to_string(mapping
->string
),
1221 mapping
->range_start
, mapping
->range_end
);
1224 g_string_append(context
->string
,
1225 ((entry
!= (enumeration
->entries
->len
- 1)) ?
1229 if (context
->field_name
->len
) {
1230 g_string_append_printf(context
->string
, " %s",
1231 context
->field_name
->str
);
1232 g_string_assign(context
->field_name
, "");
1239 int bt_ctf_field_type_floating_point_serialize(struct bt_ctf_field_type
*type
,
1240 struct metadata_context
*context
)
1242 struct bt_ctf_field_type_floating_point
*floating_point
= container_of(
1243 type
, struct bt_ctf_field_type_floating_point
, parent
);
1245 g_string_append_printf(context
->string
,
1246 "floating_point { exp_dig = %zu; mant_dig = %zu; byte_order = %s; align = %zu; }",
1247 floating_point
->declaration
.exp
->len
,
1248 floating_point
->declaration
.mantissa
->len
+ 1,
1249 get_byte_order_string(floating_point
->declaration
.byte_order
),
1250 type
->declaration
->alignment
);
1255 int bt_ctf_field_type_structure_serialize(struct bt_ctf_field_type
*type
,
1256 struct metadata_context
*context
)
1259 unsigned int indent
;
1261 struct bt_ctf_field_type_structure
*structure
= container_of(type
,
1262 struct bt_ctf_field_type_structure
, parent
);
1263 GString
*structure_field_name
= context
->field_name
;
1265 context
->field_name
= g_string_new("");
1267 context
->current_indentation_level
++;
1268 g_string_append(context
->string
, "struct {\n");
1270 for (i
= 0; i
< structure
->fields
->len
; i
++) {
1271 struct structure_field
*field
;
1273 for (indent
= 0; indent
< context
->current_indentation_level
;
1275 g_string_append_c(context
->string
, '\t');
1278 field
= structure
->fields
->pdata
[i
];
1279 g_string_assign(context
->field_name
,
1280 g_quark_to_string(field
->name
));
1281 ret
= bt_ctf_field_type_serialize(field
->type
, context
);
1286 if (context
->field_name
->len
) {
1287 g_string_append_printf(context
->string
, " %s",
1288 context
->field_name
->str
);
1290 g_string_append(context
->string
, ";\n");
1293 context
->current_indentation_level
--;
1294 for (indent
= 0; indent
< context
->current_indentation_level
;
1296 g_string_append_c(context
->string
, '\t');
1299 g_string_append_printf(context
->string
, "} align(%zu)",
1300 type
->declaration
->alignment
);
1302 g_string_free(context
->field_name
, TRUE
);
1303 context
->field_name
= structure_field_name
;
1308 int bt_ctf_field_type_variant_serialize(struct bt_ctf_field_type
*type
,
1309 struct metadata_context
*context
)
1312 unsigned int indent
;
1314 struct bt_ctf_field_type_variant
*variant
= container_of(
1315 type
, struct bt_ctf_field_type_variant
, parent
);
1316 GString
*variant_field_name
= context
->field_name
;
1318 context
->field_name
= g_string_new("");
1319 g_string_append_printf(context
->string
,
1320 "variant <%s> {\n", variant
->tag_name
->str
);
1321 context
->current_indentation_level
++;
1322 for (i
= 0; i
< variant
->fields
->len
; i
++) {
1323 struct structure_field
*field
= variant
->fields
->pdata
[i
];
1325 g_string_assign(context
->field_name
,
1326 g_quark_to_string(field
->name
));
1327 for (indent
= 0; indent
< context
->current_indentation_level
;
1329 g_string_append_c(context
->string
, '\t');
1332 g_string_assign(context
->field_name
,
1333 g_quark_to_string(field
->name
));
1334 ret
= bt_ctf_field_type_serialize(field
->type
, context
);
1339 if (context
->field_name
->len
) {
1340 g_string_append_printf(context
->string
, " %s;",
1341 context
->field_name
->str
);
1344 g_string_append_c(context
->string
, '\n');
1347 context
->current_indentation_level
--;
1348 for (indent
= 0; indent
< context
->current_indentation_level
;
1350 g_string_append_c(context
->string
, '\t');
1353 g_string_append(context
->string
, "}");
1355 g_string_free(context
->field_name
, TRUE
);
1356 context
->field_name
= variant_field_name
;
1361 int bt_ctf_field_type_array_serialize(struct bt_ctf_field_type
*type
,
1362 struct metadata_context
*context
)
1365 struct bt_ctf_field_type_array
*array
= container_of(type
,
1366 struct bt_ctf_field_type_array
, parent
);
1368 ret
= bt_ctf_field_type_serialize(array
->element_type
, context
);
1373 if (context
->field_name
->len
) {
1374 g_string_append_printf(context
->string
, " %s[%u]",
1375 context
->field_name
->str
, array
->length
);
1376 g_string_assign(context
->field_name
, "");
1378 g_string_append_printf(context
->string
, "[%u]", array
->length
);
1385 int bt_ctf_field_type_sequence_serialize(struct bt_ctf_field_type
*type
,
1386 struct metadata_context
*context
)
1389 struct bt_ctf_field_type_sequence
*sequence
= container_of(
1390 type
, struct bt_ctf_field_type_sequence
, parent
);
1392 ret
= bt_ctf_field_type_serialize(sequence
->element_type
, context
);
1397 if (context
->field_name
->len
) {
1398 g_string_append_printf(context
->string
, " %s[%s]",
1399 context
->field_name
->str
,
1400 sequence
->length_field_name
->str
);
1401 g_string_assign(context
->field_name
, "");
1403 g_string_append_printf(context
->string
, "[%s]",
1404 sequence
->length_field_name
->str
);
1411 int bt_ctf_field_type_string_serialize(struct bt_ctf_field_type
*type
,
1412 struct metadata_context
*context
)
1414 struct bt_ctf_field_type_string
*string
= container_of(
1415 type
, struct bt_ctf_field_type_string
, parent
);
1417 g_string_append_printf(context
->string
,
1418 "string { encoding = %s; }",
1419 get_encoding_string(string
->declaration
.encoding
));
1424 void bt_ctf_field_type_integer_set_byte_order(struct bt_ctf_field_type
*type
,
1427 struct bt_ctf_field_type_integer
*integer_type
= container_of(type
,
1428 struct bt_ctf_field_type_integer
, parent
);
1430 integer_type
->declaration
.byte_order
= byte_order
;
1434 void bt_ctf_field_type_floating_point_set_byte_order(
1435 struct bt_ctf_field_type
*type
, int byte_order
)
1437 struct bt_ctf_field_type_floating_point
*floating_point_type
=
1438 container_of(type
, struct bt_ctf_field_type_floating_point
,
1441 floating_point_type
->declaration
.byte_order
= byte_order
;
1442 floating_point_type
->sign
.byte_order
= byte_order
;
1443 floating_point_type
->mantissa
.byte_order
= byte_order
;
1444 floating_point_type
->exp
.byte_order
= byte_order
;