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>
37 struct range_overlap_query
{
38 int64_t range_start
, range_end
;
44 void bt_ctf_field_type_integer_destroy(struct bt_ctf_ref
*);
46 void bt_ctf_field_type_enumeration_destroy(struct bt_ctf_ref
*);
48 void bt_ctf_field_type_floating_point_destroy(struct bt_ctf_ref
*);
50 void bt_ctf_field_type_structure_destroy(struct bt_ctf_ref
*);
52 void bt_ctf_field_type_variant_destroy(struct bt_ctf_ref
*);
54 void bt_ctf_field_type_array_destroy(struct bt_ctf_ref
*);
56 void bt_ctf_field_type_sequence_destroy(struct bt_ctf_ref
*);
58 void bt_ctf_field_type_string_destroy(struct bt_ctf_ref
*);
61 void (* const type_destroy_funcs
[])(struct bt_ctf_ref
*) = {
62 [CTF_TYPE_INTEGER
] = bt_ctf_field_type_integer_destroy
,
64 bt_ctf_field_type_enumeration_destroy
,
66 bt_ctf_field_type_floating_point_destroy
,
67 [CTF_TYPE_STRUCT
] = bt_ctf_field_type_structure_destroy
,
68 [CTF_TYPE_VARIANT
] = bt_ctf_field_type_variant_destroy
,
69 [CTF_TYPE_ARRAY
] = bt_ctf_field_type_array_destroy
,
70 [CTF_TYPE_SEQUENCE
] = bt_ctf_field_type_sequence_destroy
,
71 [CTF_TYPE_STRING
] = bt_ctf_field_type_string_destroy
,
75 void generic_field_type_freeze(struct bt_ctf_field_type
*);
77 void bt_ctf_field_type_enumeration_freeze(struct bt_ctf_field_type
*);
79 void bt_ctf_field_type_structure_freeze(struct bt_ctf_field_type
*);
81 void bt_ctf_field_type_variant_freeze(struct bt_ctf_field_type
*);
83 void bt_ctf_field_type_array_freeze(struct bt_ctf_field_type
*);
85 void bt_ctf_field_type_sequence_freeze(struct bt_ctf_field_type
*);
88 type_freeze_func
const type_freeze_funcs
[] = {
89 [CTF_TYPE_INTEGER
] = generic_field_type_freeze
,
90 [CTF_TYPE_ENUM
] = bt_ctf_field_type_enumeration_freeze
,
91 [CTF_TYPE_FLOAT
] = generic_field_type_freeze
,
92 [CTF_TYPE_STRUCT
] = bt_ctf_field_type_structure_freeze
,
93 [CTF_TYPE_VARIANT
] = bt_ctf_field_type_variant_freeze
,
94 [CTF_TYPE_ARRAY
] = bt_ctf_field_type_array_freeze
,
95 [CTF_TYPE_SEQUENCE
] = bt_ctf_field_type_sequence_freeze
,
96 [CTF_TYPE_STRING
] = generic_field_type_freeze
,
100 int bt_ctf_field_type_integer_serialize(struct bt_ctf_field_type
*,
101 struct metadata_context
*);
103 int bt_ctf_field_type_enumeration_serialize(struct bt_ctf_field_type
*,
104 struct metadata_context
*);
106 int bt_ctf_field_type_floating_point_serialize(
107 struct bt_ctf_field_type
*, struct metadata_context
*);
109 int bt_ctf_field_type_structure_serialize(struct bt_ctf_field_type
*,
110 struct metadata_context
*);
112 int bt_ctf_field_type_variant_serialize(struct bt_ctf_field_type
*,
113 struct metadata_context
*);
115 int bt_ctf_field_type_array_serialize(struct bt_ctf_field_type
*,
116 struct metadata_context
*);
118 int bt_ctf_field_type_sequence_serialize(struct bt_ctf_field_type
*,
119 struct metadata_context
*);
121 int bt_ctf_field_type_string_serialize(struct bt_ctf_field_type
*,
122 struct metadata_context
*);
125 type_serialize_func
const type_serialize_funcs
[] = {
126 [CTF_TYPE_INTEGER
] = bt_ctf_field_type_integer_serialize
,
128 bt_ctf_field_type_enumeration_serialize
,
130 bt_ctf_field_type_floating_point_serialize
,
132 bt_ctf_field_type_structure_serialize
,
133 [CTF_TYPE_VARIANT
] = bt_ctf_field_type_variant_serialize
,
134 [CTF_TYPE_ARRAY
] = bt_ctf_field_type_array_serialize
,
135 [CTF_TYPE_SEQUENCE
] = bt_ctf_field_type_sequence_serialize
,
136 [CTF_TYPE_STRING
] = bt_ctf_field_type_string_serialize
,
140 void bt_ctf_field_type_integer_set_byte_order(struct bt_ctf_field_type
*,
143 void bt_ctf_field_type_floating_point_set_byte_order(
144 struct bt_ctf_field_type
*, int byte_order
);
147 void (* const set_byte_order_funcs
[])(struct bt_ctf_field_type
*,
150 bt_ctf_field_type_integer_set_byte_order
,
152 bt_ctf_field_type_floating_point_set_byte_order
,
153 [CTF_TYPE_ENUM
... CTF_TYPE_SEQUENCE
] = NULL
,
158 void destroy_enumeration_mapping(struct enumeration_mapping
*mapping
)
164 void destroy_structure_field(struct structure_field
*field
)
167 bt_ctf_field_type_put(field
->type
);
174 void check_ranges_overlap(gpointer element
, gpointer query
)
176 struct enumeration_mapping
*mapping
= element
;
177 struct range_overlap_query
*overlap_query
= query
;
179 if (mapping
->range_start
<= overlap_query
->range_end
180 && overlap_query
->range_start
<= mapping
->range_end
) {
181 overlap_query
->overlaps
= 1;
182 overlap_query
->mapping_name
= mapping
->string
;
185 overlap_query
->overlaps
|=
186 mapping
->string
== overlap_query
->mapping_name
;
190 void bt_ctf_field_type_init(struct bt_ctf_field_type
*type
)
192 enum ctf_type_id type_id
= type
->declaration
->id
;
194 assert(type
&& (type_id
> CTF_TYPE_UNKNOWN
) &&
195 (type_id
< NR_CTF_TYPES
));
197 bt_ctf_ref_init(&type
->ref_count
);
198 type
->freeze
= type_freeze_funcs
[type_id
];
199 type
->serialize
= type_serialize_funcs
[type_id
];
200 bt_ctf_field_type_set_byte_order(type
, BT_CTF_BYTE_ORDER_NATIVE
);
201 type
->declaration
->alignment
= 1;
205 int add_structure_field(GPtrArray
*fields
,
206 GHashTable
*field_name_to_index
,
207 struct bt_ctf_field_type
*field_type
,
208 const char *field_name
)
211 GQuark name_quark
= g_quark_from_string(field_name
);
212 struct structure_field
*field
;
214 /* Make sure structure does not contain a field of the same name */
215 if (g_hash_table_contains(field_name_to_index
,
216 GUINT_TO_POINTER(name_quark
))) {
221 field
= g_new0(struct structure_field
, 1);
227 bt_ctf_field_type_get(field_type
);
228 field
->name
= name_quark
;
229 field
->type
= field_type
;
230 g_hash_table_insert(field_name_to_index
,
231 (gpointer
) (unsigned long) name_quark
,
232 (gpointer
) (unsigned long) fields
->len
);
233 g_ptr_array_add(fields
, field
);
234 bt_ctf_field_type_freeze(field_type
);
239 struct bt_ctf_field_type
*bt_ctf_field_type_integer_create(unsigned int size
)
241 struct bt_ctf_field_type_integer
*integer
=
242 g_new0(struct bt_ctf_field_type_integer
, 1);
244 if (!integer
|| size
> 64) {
248 integer
->parent
.declaration
= &integer
->declaration
.p
;
249 integer
->parent
.declaration
->id
= CTF_TYPE_INTEGER
;
250 integer
->declaration
.len
= size
;
251 integer
->declaration
.base
= BT_CTF_INTEGER_BASE_DECIMAL
;
252 integer
->declaration
.encoding
= CTF_STRING_NONE
;
253 bt_ctf_field_type_init(&integer
->parent
);
254 return &integer
->parent
;
257 int bt_ctf_field_type_integer_set_signed(struct bt_ctf_field_type
*type
,
261 struct bt_ctf_field_type_integer
*integer
;
263 if (!type
|| type
->frozen
||
264 type
->declaration
->id
!= CTF_TYPE_INTEGER
) {
269 integer
= container_of(type
, struct bt_ctf_field_type_integer
, parent
);
270 if (is_signed
&& integer
->declaration
.len
<= 1) {
275 integer
->declaration
.signedness
= !!is_signed
;
280 int bt_ctf_field_type_integer_set_base(struct bt_ctf_field_type
*type
,
281 enum bt_ctf_integer_base base
)
285 if (!type
|| type
->frozen
||
286 type
->declaration
->id
!= CTF_TYPE_INTEGER
) {
292 case BT_CTF_INTEGER_BASE_BINARY
:
293 case BT_CTF_INTEGER_BASE_OCTAL
:
294 case BT_CTF_INTEGER_BASE_DECIMAL
:
295 case BT_CTF_INTEGER_BASE_HEXADECIMAL
:
297 struct bt_ctf_field_type_integer
*integer
= container_of(type
,
298 struct bt_ctf_field_type_integer
, parent
);
299 integer
->declaration
.base
= base
;
309 int bt_ctf_field_type_integer_set_encoding(struct bt_ctf_field_type
*type
,
310 enum ctf_string_encoding encoding
)
313 struct bt_ctf_field_type_integer
*integer
;
315 if (!type
|| type
->frozen
||
316 (type
->declaration
->id
!= CTF_TYPE_INTEGER
) ||
317 (encoding
< CTF_STRING_NONE
) ||
318 (encoding
>= CTF_STRING_UNKNOWN
)) {
323 integer
= container_of(type
, struct bt_ctf_field_type_integer
, parent
);
324 integer
->declaration
.encoding
= encoding
;
329 struct bt_ctf_field_type
*bt_ctf_field_type_enumeration_create(
330 struct bt_ctf_field_type
*integer_container_type
)
332 struct bt_ctf_field_type_enumeration
*enumeration
= NULL
;
334 if (!integer_container_type
) {
338 enumeration
= g_new0(struct bt_ctf_field_type_enumeration
, 1);
343 enumeration
->parent
.declaration
= &enumeration
->declaration
.p
;
344 enumeration
->parent
.declaration
->id
= CTF_TYPE_ENUM
;
345 bt_ctf_field_type_get(integer_container_type
);
346 enumeration
->container
= integer_container_type
;
347 enumeration
->entries
= g_ptr_array_new_with_free_func(
348 (GDestroyNotify
)destroy_enumeration_mapping
);
349 bt_ctf_field_type_init(&enumeration
->parent
);
350 return &enumeration
->parent
;
356 int bt_ctf_field_type_enumeration_add_mapping(
357 struct bt_ctf_field_type
*type
, const char *string
,
358 int64_t range_start
, int64_t range_end
)
362 struct enumeration_mapping
*mapping
;
363 struct bt_ctf_field_type_enumeration
*enumeration
;
364 struct range_overlap_query query
;
366 if (!type
|| (type
->declaration
->id
!= CTF_TYPE_ENUM
) ||
368 (range_end
< range_start
)) {
373 if (validate_identifier(string
)) {
378 mapping_name
= g_quark_from_string(string
);
379 query
= (struct range_overlap_query
) { .range_start
= range_start
,
380 .range_end
= range_end
,
381 .mapping_name
= mapping_name
,
383 enumeration
= container_of(type
, struct bt_ctf_field_type_enumeration
,
386 /* Check that the range does not overlap with one already present */
387 g_ptr_array_foreach(enumeration
->entries
, check_ranges_overlap
, &query
);
388 if (query
.overlaps
) {
393 mapping
= g_new(struct enumeration_mapping
, 1);
399 *mapping
= (struct enumeration_mapping
) {.range_start
= range_start
,
400 .range_end
= range_end
, .string
= mapping_name
};
401 g_ptr_array_add(enumeration
->entries
, mapping
);
406 struct bt_ctf_field_type
*bt_ctf_field_type_floating_point_create(void)
408 struct bt_ctf_field_type_floating_point
*floating_point
=
409 g_new0(struct bt_ctf_field_type_floating_point
, 1);
411 if (!floating_point
) {
415 floating_point
->declaration
.sign
= &floating_point
->sign
;
416 floating_point
->declaration
.mantissa
= &floating_point
->mantissa
;
417 floating_point
->declaration
.exp
= &floating_point
->exp
;
418 floating_point
->sign
.len
= 1;
419 floating_point
->parent
.declaration
= &floating_point
->declaration
.p
;
420 floating_point
->parent
.declaration
->id
= CTF_TYPE_FLOAT
;
421 floating_point
->declaration
.exp
->len
=
422 sizeof(float) * CHAR_BIT
- FLT_MANT_DIG
;
423 floating_point
->declaration
.mantissa
->len
= FLT_MANT_DIG
- 1;
424 floating_point
->sign
.p
.alignment
= 1;
425 floating_point
->mantissa
.p
.alignment
= 1;
426 floating_point
->exp
.p
.alignment
= 1;
428 bt_ctf_field_type_init(&floating_point
->parent
);
430 return floating_point
? &floating_point
->parent
: NULL
;
433 int bt_ctf_field_type_floating_point_set_exponent_digits(
434 struct bt_ctf_field_type
*type
,
435 unsigned int exponent_digits
)
438 struct bt_ctf_field_type_floating_point
*floating_point
;
440 if (!type
|| type
->frozen
||
441 (type
->declaration
->id
!= CTF_TYPE_FLOAT
)) {
446 floating_point
= container_of(type
,
447 struct bt_ctf_field_type_floating_point
, parent
);
448 if ((exponent_digits
!= sizeof(float) * CHAR_BIT
- FLT_MANT_DIG
) &&
449 (exponent_digits
!= sizeof(double) * CHAR_BIT
- DBL_MANT_DIG
) &&
451 sizeof(long double) * CHAR_BIT
- LDBL_MANT_DIG
)) {
456 floating_point
->declaration
.exp
->len
= exponent_digits
;
461 int bt_ctf_field_type_floating_point_set_mantissa_digits(
462 struct bt_ctf_field_type
*type
,
463 unsigned int mantissa_digits
)
466 struct bt_ctf_field_type_floating_point
*floating_point
;
468 if (!type
|| type
->frozen
||
469 (type
->declaration
->id
!= CTF_TYPE_FLOAT
)) {
474 floating_point
= container_of(type
,
475 struct bt_ctf_field_type_floating_point
, parent
);
477 if ((mantissa_digits
!= FLT_MANT_DIG
) &&
478 (mantissa_digits
!= DBL_MANT_DIG
) &&
479 (mantissa_digits
!= LDBL_MANT_DIG
)) {
484 floating_point
->declaration
.mantissa
->len
= mantissa_digits
- 1;
489 struct bt_ctf_field_type
*bt_ctf_field_type_structure_create(void)
491 struct bt_ctf_field_type_structure
*structure
=
492 g_new0(struct bt_ctf_field_type_structure
, 1);
498 structure
->parent
.declaration
= &structure
->declaration
.p
;
499 structure
->parent
.declaration
->id
= CTF_TYPE_STRUCT
;
500 bt_ctf_field_type_init(&structure
->parent
);
501 structure
->fields
= g_ptr_array_new_with_free_func(
502 (GDestroyNotify
)destroy_structure_field
);
503 structure
->field_name_to_index
= g_hash_table_new(NULL
, NULL
);
504 return &structure
->parent
;
509 int bt_ctf_field_type_structure_add_field(struct bt_ctf_field_type
*type
,
510 struct bt_ctf_field_type
*field_type
,
511 const char *field_name
)
514 struct bt_ctf_field_type_structure
*structure
;
516 if (!type
|| !field_type
|| type
->frozen
||
517 validate_identifier(field_name
) ||
518 (type
->declaration
->id
!= CTF_TYPE_STRUCT
)) {
522 structure
= container_of(type
,
523 struct bt_ctf_field_type_structure
, parent
);
524 if (add_structure_field(structure
->fields
,
525 structure
->field_name_to_index
, field_type
, field_name
)) {
530 if (type
->declaration
->alignment
< field_type
->declaration
->alignment
) {
531 type
->declaration
->alignment
=
532 field_type
->declaration
->alignment
;
538 struct bt_ctf_field_type
*bt_ctf_field_type_variant_create(
539 struct bt_ctf_field_type
*enum_tag
, const char *tag_name
)
541 struct bt_ctf_field_type_variant
*variant
= NULL
;
543 if (!enum_tag
|| validate_identifier(tag_name
) ||
544 (enum_tag
->declaration
->id
!= CTF_TYPE_ENUM
)) {
548 variant
= g_new0(struct bt_ctf_field_type_variant
, 1);
553 variant
->parent
.declaration
= &variant
->declaration
.p
;
554 variant
->parent
.declaration
->id
= CTF_TYPE_VARIANT
;
555 variant
->tag_name
= g_string_new(tag_name
);
556 bt_ctf_field_type_init(&variant
->parent
);
557 variant
->field_name_to_index
= g_hash_table_new(NULL
, NULL
);
558 variant
->fields
= g_ptr_array_new_with_free_func(
559 (GDestroyNotify
)destroy_structure_field
);
560 bt_ctf_field_type_get(enum_tag
);
561 variant
->tag
= container_of(enum_tag
,
562 struct bt_ctf_field_type_enumeration
, parent
);
563 return &variant
->parent
;
568 int bt_ctf_field_type_variant_add_field(struct bt_ctf_field_type
*type
,
569 struct bt_ctf_field_type
*field_type
,
570 const char *field_name
)
575 struct bt_ctf_field_type_variant
*variant
;
576 GQuark field_name_quark
= g_quark_from_string(field_name
);
578 if (!type
|| !field_type
|| type
->frozen
||
579 validate_identifier(field_name
) ||
580 (type
->declaration
->id
!= CTF_TYPE_VARIANT
)) {
585 variant
= container_of(type
, struct bt_ctf_field_type_variant
, parent
);
586 /* Make sure this name is present in the enum tag */
587 for (i
= 0; i
< variant
->tag
->entries
->len
; i
++) {
588 struct enumeration_mapping
*mapping
=
589 g_ptr_array_index(variant
->tag
->entries
, i
);
591 if (mapping
->string
== field_name_quark
) {
597 if (!name_found
|| add_structure_field(variant
->fields
,
598 variant
->field_name_to_index
, field_type
, field_name
)) {
606 struct bt_ctf_field_type
*bt_ctf_field_type_array_create(
607 struct bt_ctf_field_type
*element_type
,
610 struct bt_ctf_field_type_array
*array
= NULL
;
612 if (!element_type
|| length
== 0) {
616 array
= g_new0(struct bt_ctf_field_type_array
, 1);
621 array
->parent
.declaration
= &array
->declaration
.p
;
622 array
->parent
.declaration
->id
= CTF_TYPE_ARRAY
;
623 bt_ctf_field_type_init(&array
->parent
);
624 bt_ctf_field_type_get(element_type
);
625 array
->element_type
= element_type
;
626 array
->length
= length
;
627 array
->parent
.declaration
->alignment
=
628 element_type
->declaration
->alignment
;
629 return &array
->parent
;
634 struct bt_ctf_field_type
*bt_ctf_field_type_sequence_create(
635 struct bt_ctf_field_type
*element_type
,
636 const char *length_field_name
)
638 struct bt_ctf_field_type_sequence
*sequence
= NULL
;
640 if (!element_type
|| validate_identifier(length_field_name
)) {
644 sequence
= g_new0(struct bt_ctf_field_type_sequence
, 1);
649 sequence
->parent
.declaration
= &sequence
->declaration
.p
;
650 sequence
->parent
.declaration
->id
= CTF_TYPE_SEQUENCE
;
651 bt_ctf_field_type_init(&sequence
->parent
);
652 bt_ctf_field_type_get(element_type
);
653 sequence
->element_type
= element_type
;
654 sequence
->length_field_name
= g_string_new(length_field_name
);
655 sequence
->parent
.declaration
->alignment
=
656 element_type
->declaration
->alignment
;
657 return &sequence
->parent
;
662 struct bt_ctf_field_type
*bt_ctf_field_type_string_create(void)
664 struct bt_ctf_field_type_string
*string
=
665 g_new0(struct bt_ctf_field_type_string
, 1);
671 string
->parent
.declaration
= &string
->declaration
.p
;
672 string
->parent
.declaration
->id
= CTF_TYPE_STRING
;
673 bt_ctf_field_type_init(&string
->parent
);
674 string
->declaration
.encoding
= CTF_STRING_UTF8
;
675 string
->parent
.declaration
->alignment
= CHAR_BIT
;
676 return &string
->parent
;
679 int bt_ctf_field_type_string_set_encoding(
680 struct bt_ctf_field_type
*type
,
681 enum ctf_string_encoding encoding
)
684 struct bt_ctf_field_type_string
*string
;
686 if (!type
|| type
->declaration
->id
!= CTF_TYPE_STRING
||
687 (encoding
!= CTF_STRING_UTF8
&&
688 encoding
!= CTF_STRING_ASCII
)) {
693 string
= container_of(type
, struct bt_ctf_field_type_string
, parent
);
694 string
->declaration
.encoding
= encoding
;
699 int bt_ctf_field_type_set_alignment(struct bt_ctf_field_type
*type
,
700 unsigned int alignment
)
704 /* Alignment must be bit-aligned (1) or byte aligned */
705 if (!type
|| type
->frozen
|| (alignment
!= 1 && (alignment
& 0x7))) {
710 if (type
->declaration
->id
== CTF_TYPE_STRING
&&
711 alignment
!= CHAR_BIT
) {
716 type
->declaration
->alignment
= alignment
;
722 int bt_ctf_field_type_set_byte_order(struct bt_ctf_field_type
*type
,
723 enum bt_ctf_byte_order byte_order
)
726 int internal_byte_order
;
727 enum ctf_type_id type_id
;
729 if (!type
|| type
->frozen
) {
734 type_id
= type
->declaration
->id
;
735 switch (byte_order
) {
736 case BT_CTF_BYTE_ORDER_NATIVE
:
737 internal_byte_order
= (G_BYTE_ORDER
== G_LITTLE_ENDIAN
?
738 LITTLE_ENDIAN
: BIG_ENDIAN
);
740 case BT_CTF_BYTE_ORDER_LITTLE_ENDIAN
:
741 internal_byte_order
= LITTLE_ENDIAN
;
743 case BT_CTF_BYTE_ORDER_BIG_ENDIAN
:
744 case BT_CTF_BYTE_ORDER_NETWORK
:
745 internal_byte_order
= BIG_ENDIAN
;
752 if (set_byte_order_funcs
[type_id
]) {
753 set_byte_order_funcs
[type_id
](type
, internal_byte_order
);
759 void bt_ctf_field_type_get(struct bt_ctf_field_type
*type
)
765 bt_ctf_ref_get(&type
->ref_count
);
768 void bt_ctf_field_type_put(struct bt_ctf_field_type
*type
)
770 enum ctf_type_id type_id
;
776 type_id
= type
->declaration
->id
;
777 assert(type_id
> CTF_TYPE_UNKNOWN
&& type_id
< NR_CTF_TYPES
);
778 bt_ctf_ref_put(&type
->ref_count
, type_destroy_funcs
[type_id
]);
782 void bt_ctf_field_type_freeze(struct bt_ctf_field_type
*type
)
792 enum ctf_type_id
bt_ctf_field_type_get_type_id(
793 struct bt_ctf_field_type
*type
)
796 return CTF_TYPE_UNKNOWN
;
799 return type
->declaration
->id
;
803 struct bt_ctf_field_type
*bt_ctf_field_type_structure_get_type(
804 struct bt_ctf_field_type_structure
*structure
,
807 struct bt_ctf_field_type
*type
= NULL
;
808 struct structure_field
*field
;
809 GQuark name_quark
= g_quark_try_string(name
);
816 if (!g_hash_table_lookup_extended(structure
->field_name_to_index
,
817 GUINT_TO_POINTER(name_quark
), NULL
, (gpointer
*)&index
)) {
821 field
= structure
->fields
->pdata
[index
];
828 struct bt_ctf_field_type
*bt_ctf_field_type_array_get_element_type(
829 struct bt_ctf_field_type_array
*array
)
832 return array
->element_type
;
836 struct bt_ctf_field_type
*bt_ctf_field_type_sequence_get_element_type(
837 struct bt_ctf_field_type_sequence
*sequence
)
840 return sequence
->element_type
;
844 struct bt_ctf_field_type
*bt_ctf_field_type_variant_get_field_type(
845 struct bt_ctf_field_type_variant
*variant
,
848 struct bt_ctf_field_type
*type
= NULL
;
849 GQuark field_name_quark
;
851 struct structure_field
*field_entry
;
852 struct range_overlap_query query
= {.range_start
= tag_value
,
853 .range_end
= tag_value
, .mapping_name
= 0, .overlaps
= 0};
855 g_ptr_array_foreach(variant
->tag
->entries
, check_ranges_overlap
,
857 if (!query
.overlaps
) {
861 field_name_quark
= query
.mapping_name
;
862 if (!g_hash_table_lookup_extended(variant
->field_name_to_index
,
863 GUINT_TO_POINTER(field_name_quark
), NULL
, &index
)) {
867 field_entry
= g_ptr_array_index(variant
->fields
, (size_t)index
);
868 type
= field_entry
->type
;
874 int bt_ctf_field_type_serialize(struct bt_ctf_field_type
*type
,
875 struct metadata_context
*context
)
879 if (!type
|| !context
) {
884 ret
= type
->serialize(type
, context
);
890 void bt_ctf_field_type_integer_destroy(struct bt_ctf_ref
*ref
)
892 struct bt_ctf_field_type_integer
*integer
;
898 integer
= container_of(
899 container_of(ref
, struct bt_ctf_field_type
, ref_count
),
900 struct bt_ctf_field_type_integer
, parent
);
905 void bt_ctf_field_type_enumeration_destroy(struct bt_ctf_ref
*ref
)
907 struct bt_ctf_field_type_enumeration
*enumeration
;
913 enumeration
= container_of(
914 container_of(ref
, struct bt_ctf_field_type
, ref_count
),
915 struct bt_ctf_field_type_enumeration
, parent
);
916 g_ptr_array_free(enumeration
->entries
, TRUE
);
917 bt_ctf_field_type_put(enumeration
->container
);
922 void bt_ctf_field_type_floating_point_destroy(struct bt_ctf_ref
*ref
)
924 struct bt_ctf_field_type_floating_point
*floating_point
;
930 floating_point
= container_of(
931 container_of(ref
, struct bt_ctf_field_type
, ref_count
),
932 struct bt_ctf_field_type_floating_point
, parent
);
933 g_free(floating_point
);
937 void bt_ctf_field_type_structure_destroy(struct bt_ctf_ref
*ref
)
939 struct bt_ctf_field_type_structure
*structure
;
945 structure
= container_of(
946 container_of(ref
, struct bt_ctf_field_type
, ref_count
),
947 struct bt_ctf_field_type_structure
, parent
);
948 g_ptr_array_free(structure
->fields
, TRUE
);
949 g_hash_table_destroy(structure
->field_name_to_index
);
954 void bt_ctf_field_type_variant_destroy(struct bt_ctf_ref
*ref
)
956 struct bt_ctf_field_type_variant
*variant
;
962 variant
= container_of(
963 container_of(ref
, struct bt_ctf_field_type
, ref_count
),
964 struct bt_ctf_field_type_variant
, parent
);
965 g_ptr_array_free(variant
->fields
, TRUE
);
966 g_hash_table_destroy(variant
->field_name_to_index
);
967 g_string_free(variant
->tag_name
, TRUE
);
968 bt_ctf_field_type_put(&variant
->tag
->parent
);
973 void bt_ctf_field_type_array_destroy(struct bt_ctf_ref
*ref
)
975 struct bt_ctf_field_type_array
*array
;
981 array
= container_of(
982 container_of(ref
, struct bt_ctf_field_type
, ref_count
),
983 struct bt_ctf_field_type_array
, parent
);
984 bt_ctf_field_type_put(array
->element_type
);
989 void bt_ctf_field_type_sequence_destroy(struct bt_ctf_ref
*ref
)
991 struct bt_ctf_field_type_sequence
*sequence
;
997 sequence
= container_of(
998 container_of(ref
, struct bt_ctf_field_type
, ref_count
),
999 struct bt_ctf_field_type_sequence
, parent
);
1000 bt_ctf_field_type_put(sequence
->element_type
);
1001 g_string_free(sequence
->length_field_name
, TRUE
);
1006 void bt_ctf_field_type_string_destroy(struct bt_ctf_ref
*ref
)
1008 struct bt_ctf_field_type_string
*string
;
1014 string
= container_of(
1015 container_of(ref
, struct bt_ctf_field_type
, ref_count
),
1016 struct bt_ctf_field_type_string
, parent
);
1021 void generic_field_type_freeze(struct bt_ctf_field_type
*type
)
1027 void bt_ctf_field_type_enumeration_freeze(struct bt_ctf_field_type
*type
)
1029 struct bt_ctf_field_type_enumeration
*enumeration_type
= container_of(
1030 type
, struct bt_ctf_field_type_enumeration
, parent
);
1032 generic_field_type_freeze(type
);
1033 bt_ctf_field_type_freeze(enumeration_type
->container
);
1037 void freeze_structure_field(struct structure_field
*field
)
1039 bt_ctf_field_type_freeze(field
->type
);
1043 void bt_ctf_field_type_structure_freeze(struct bt_ctf_field_type
*type
)
1045 struct bt_ctf_field_type_structure
*structure_type
= container_of(
1046 type
, struct bt_ctf_field_type_structure
, parent
);
1048 generic_field_type_freeze(type
);
1049 g_ptr_array_foreach(structure_type
->fields
, (GFunc
)freeze_structure_field
,
1054 void bt_ctf_field_type_variant_freeze(struct bt_ctf_field_type
*type
)
1056 struct bt_ctf_field_type_variant
*variant_type
= container_of(
1057 type
, struct bt_ctf_field_type_variant
, parent
);
1059 generic_field_type_freeze(type
);
1060 g_ptr_array_foreach(variant_type
->fields
, (GFunc
)freeze_structure_field
,
1065 void bt_ctf_field_type_array_freeze(struct bt_ctf_field_type
*type
)
1067 struct bt_ctf_field_type_array
*array_type
= container_of(
1068 type
, struct bt_ctf_field_type_array
, parent
);
1070 generic_field_type_freeze(type
);
1071 bt_ctf_field_type_freeze(array_type
->element_type
);
1075 void bt_ctf_field_type_sequence_freeze(struct bt_ctf_field_type
*type
)
1077 struct bt_ctf_field_type_sequence
*sequence_type
= container_of(
1078 type
, struct bt_ctf_field_type_sequence
, parent
);
1080 generic_field_type_freeze(type
);
1081 bt_ctf_field_type_freeze(sequence_type
->element_type
);
1085 const char *get_encoding_string(enum ctf_string_encoding encoding
)
1087 const char *encoding_string
;
1090 case CTF_STRING_NONE
:
1091 encoding_string
= "none";
1093 case CTF_STRING_ASCII
:
1094 encoding_string
= "ASCII";
1096 case CTF_STRING_UTF8
:
1097 encoding_string
= "UTF8";
1100 encoding_string
= "unknown";
1104 return encoding_string
;
1108 const char *get_integer_base_string(enum bt_ctf_integer_base base
)
1110 const char *base_string
;
1113 case BT_CTF_INTEGER_BASE_DECIMAL
:
1114 base_string
= "decimal";
1116 case BT_CTF_INTEGER_BASE_HEXADECIMAL
:
1117 base_string
= "hexadecimal";
1119 case BT_CTF_INTEGER_BASE_OCTAL
:
1120 base_string
= "octal";
1122 case BT_CTF_INTEGER_BASE_BINARY
:
1123 base_string
= "binary";
1126 base_string
= "unknown";
1134 int bt_ctf_field_type_integer_serialize(struct bt_ctf_field_type
*type
,
1135 struct metadata_context
*context
)
1137 struct bt_ctf_field_type_integer
*integer
= container_of(type
,
1138 struct bt_ctf_field_type_integer
, parent
);
1140 g_string_append_printf(context
->string
,
1141 "integer { size = %zu; align = %zu; signed = %s; encoding = %s; base = %s; byte_order = %s; }",
1142 integer
->declaration
.len
, type
->declaration
->alignment
,
1143 (integer
->declaration
.signedness
? "true" : "false"),
1144 get_encoding_string(integer
->declaration
.encoding
),
1145 get_integer_base_string(integer
->declaration
.base
),
1146 get_byte_order_string(integer
->declaration
.byte_order
));
1151 int bt_ctf_field_type_enumeration_serialize(struct bt_ctf_field_type
*type
,
1152 struct metadata_context
*context
)
1156 struct bt_ctf_field_type_enumeration
*enumeration
= container_of(type
,
1157 struct bt_ctf_field_type_enumeration
, parent
);
1159 g_string_append(context
->string
, "enum : ");
1160 ret
= bt_ctf_field_type_serialize(enumeration
->container
, context
);
1165 g_string_append(context
->string
, " { ");
1166 for (entry
= 0; entry
< enumeration
->entries
->len
; entry
++) {
1167 struct enumeration_mapping
*mapping
=
1168 enumeration
->entries
->pdata
[entry
];
1170 if (mapping
->range_start
== mapping
->range_end
) {
1171 g_string_append_printf(context
->string
, "%s = %" PRId64
,
1172 g_quark_to_string(mapping
->string
),
1173 mapping
->range_start
);
1175 g_string_append_printf(context
->string
,
1176 "%s = %" PRId64
" ... %" PRId64
,
1177 g_quark_to_string(mapping
->string
),
1178 mapping
->range_start
, mapping
->range_end
);
1181 g_string_append(context
->string
,
1182 ((entry
!= (enumeration
->entries
->len
- 1)) ?
1186 if (context
->field_name
->len
) {
1187 g_string_append_printf(context
->string
, " %s",
1188 context
->field_name
->str
);
1189 g_string_assign(context
->field_name
, "");
1196 int bt_ctf_field_type_floating_point_serialize(struct bt_ctf_field_type
*type
,
1197 struct metadata_context
*context
)
1199 struct bt_ctf_field_type_floating_point
*floating_point
= container_of(
1200 type
, struct bt_ctf_field_type_floating_point
, parent
);
1202 g_string_append_printf(context
->string
,
1203 "floating_point { exp_dig = %zu; mant_dig = %zu; byte_order = %s; align = %zu; }",
1204 floating_point
->declaration
.exp
->len
,
1205 floating_point
->declaration
.mantissa
->len
+ 1,
1206 get_byte_order_string(floating_point
->declaration
.byte_order
),
1207 type
->declaration
->alignment
);
1212 int bt_ctf_field_type_structure_serialize(struct bt_ctf_field_type
*type
,
1213 struct metadata_context
*context
)
1216 unsigned int indent
;
1218 struct bt_ctf_field_type_structure
*structure
= container_of(type
,
1219 struct bt_ctf_field_type_structure
, parent
);
1220 GString
*structure_field_name
= context
->field_name
;
1222 context
->field_name
= g_string_new("");
1224 context
->current_indentation_level
++;
1225 g_string_append(context
->string
, "struct {\n");
1227 for (i
= 0; i
< structure
->fields
->len
; i
++) {
1228 struct structure_field
*field
;
1230 for (indent
= 0; indent
< context
->current_indentation_level
;
1232 g_string_append_c(context
->string
, '\t');
1235 field
= structure
->fields
->pdata
[i
];
1236 g_string_assign(context
->field_name
,
1237 g_quark_to_string(field
->name
));
1238 ret
= bt_ctf_field_type_serialize(field
->type
, context
);
1243 if (context
->field_name
->len
) {
1244 g_string_append_printf(context
->string
, " %s",
1245 context
->field_name
->str
);
1247 g_string_append(context
->string
, ";\n");
1250 context
->current_indentation_level
--;
1251 for (indent
= 0; indent
< context
->current_indentation_level
;
1253 g_string_append_c(context
->string
, '\t');
1256 g_string_append_printf(context
->string
, "} align(%zu)",
1257 type
->declaration
->alignment
);
1259 g_string_free(context
->field_name
, TRUE
);
1260 context
->field_name
= structure_field_name
;
1265 int bt_ctf_field_type_variant_serialize(struct bt_ctf_field_type
*type
,
1266 struct metadata_context
*context
)
1269 unsigned int indent
;
1271 struct bt_ctf_field_type_variant
*variant
= container_of(
1272 type
, struct bt_ctf_field_type_variant
, parent
);
1273 GString
*variant_field_name
= context
->field_name
;
1275 context
->field_name
= g_string_new("");
1276 g_string_append_printf(context
->string
,
1277 "variant <%s> {\n", variant
->tag_name
->str
);
1278 context
->current_indentation_level
++;
1279 for (i
= 0; i
< variant
->fields
->len
; i
++) {
1280 struct structure_field
*field
= variant
->fields
->pdata
[i
];
1282 g_string_assign(context
->field_name
,
1283 g_quark_to_string(field
->name
));
1284 for (indent
= 0; indent
< context
->current_indentation_level
;
1286 g_string_append_c(context
->string
, '\t');
1289 g_string_assign(context
->field_name
,
1290 g_quark_to_string(field
->name
));
1291 ret
= bt_ctf_field_type_serialize(field
->type
, context
);
1296 if (context
->field_name
->len
) {
1297 g_string_append_printf(context
->string
, " %s;",
1298 context
->field_name
->str
);
1301 g_string_append_c(context
->string
, '\n');
1304 context
->current_indentation_level
--;
1305 for (indent
= 0; indent
< context
->current_indentation_level
;
1307 g_string_append_c(context
->string
, '\t');
1310 g_string_append(context
->string
, "}");
1312 g_string_free(context
->field_name
, TRUE
);
1313 context
->field_name
= variant_field_name
;
1318 int bt_ctf_field_type_array_serialize(struct bt_ctf_field_type
*type
,
1319 struct metadata_context
*context
)
1322 struct bt_ctf_field_type_array
*array
= container_of(type
,
1323 struct bt_ctf_field_type_array
, parent
);
1325 ret
= bt_ctf_field_type_serialize(array
->element_type
, context
);
1330 if (context
->field_name
->len
) {
1331 g_string_append_printf(context
->string
, " %s[%u]",
1332 context
->field_name
->str
, array
->length
);
1333 g_string_assign(context
->field_name
, "");
1335 g_string_append_printf(context
->string
, "[%u]", array
->length
);
1342 int bt_ctf_field_type_sequence_serialize(struct bt_ctf_field_type
*type
,
1343 struct metadata_context
*context
)
1346 struct bt_ctf_field_type_sequence
*sequence
= container_of(
1347 type
, struct bt_ctf_field_type_sequence
, parent
);
1349 ret
= bt_ctf_field_type_serialize(sequence
->element_type
, context
);
1354 if (context
->field_name
->len
) {
1355 g_string_append_printf(context
->string
, " %s[%s]",
1356 context
->field_name
->str
,
1357 sequence
->length_field_name
->str
);
1358 g_string_assign(context
->field_name
, "");
1360 g_string_append_printf(context
->string
, "[%s]",
1361 sequence
->length_field_name
->str
);
1368 int bt_ctf_field_type_string_serialize(struct bt_ctf_field_type
*type
,
1369 struct metadata_context
*context
)
1371 struct bt_ctf_field_type_string
*string
= container_of(
1372 type
, struct bt_ctf_field_type_string
, parent
);
1374 g_string_append_printf(context
->string
,
1375 "string { encoding = %s; }",
1376 get_encoding_string(string
->declaration
.encoding
));
1381 void bt_ctf_field_type_integer_set_byte_order(struct bt_ctf_field_type
*type
,
1384 struct bt_ctf_field_type_integer
*integer_type
= container_of(type
,
1385 struct bt_ctf_field_type_integer
, parent
);
1387 integer_type
->declaration
.byte_order
= byte_order
;
1391 void bt_ctf_field_type_floating_point_set_byte_order(
1392 struct bt_ctf_field_type
*type
, int byte_order
)
1394 struct bt_ctf_field_type_floating_point
*floating_point_type
=
1395 container_of(type
, struct bt_ctf_field_type_floating_point
,
1398 floating_point_type
->declaration
.byte_order
= byte_order
;
1399 floating_point_type
->sign
.byte_order
= byte_order
;
1400 floating_point_type
->mantissa
.byte_order
= byte_order
;
1401 floating_point_type
->exp
.byte_order
= byte_order
;