4 * Babeltrace CTF IR - Trace
6 * Copyright 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-ir/trace-internal.h>
30 #include <babeltrace/ctf-ir/clock-internal.h>
31 #include <babeltrace/ctf-ir/stream-internal.h>
32 #include <babeltrace/ctf-ir/stream-class-internal.h>
33 #include <babeltrace/ctf-writer/functor-internal.h>
34 #include <babeltrace/ctf-ir/event-types-internal.h>
35 #include <babeltrace/ctf-ir/attributes-internal.h>
36 #include <babeltrace/ctf-ir/visitor-internal.h>
37 #include <babeltrace/ctf-ir/utils.h>
38 #include <babeltrace/compiler.h>
39 #include <babeltrace/objects.h>
41 #define DEFAULT_IDENTIFIER_SIZE 128
42 #define DEFAULT_METADATA_STRING_SIZE 4096
45 void bt_ctf_trace_destroy(struct bt_ctf_ref
*ref
);
47 int init_trace_packet_header(struct bt_ctf_trace
*trace
);
49 int bt_ctf_trace_freeze(struct bt_ctf_trace
*trace
);
52 const unsigned int field_type_aliases_alignments
[] = {
53 [FIELD_TYPE_ALIAS_UINT5_T
] = 1,
54 [FIELD_TYPE_ALIAS_UINT8_T
... FIELD_TYPE_ALIAS_UINT16_T
] = 8,
55 [FIELD_TYPE_ALIAS_UINT27_T
] = 1,
56 [FIELD_TYPE_ALIAS_UINT32_T
... FIELD_TYPE_ALIAS_UINT64_T
] = 8,
60 const unsigned int field_type_aliases_sizes
[] = {
61 [FIELD_TYPE_ALIAS_UINT5_T
] = 5,
62 [FIELD_TYPE_ALIAS_UINT8_T
] = 8,
63 [FIELD_TYPE_ALIAS_UINT16_T
] = 16,
64 [FIELD_TYPE_ALIAS_UINT27_T
] = 27,
65 [FIELD_TYPE_ALIAS_UINT32_T
] = 32,
66 [FIELD_TYPE_ALIAS_UINT64_T
] = 64,
70 void put_stream_class(struct bt_ctf_stream_class
*stream_class
)
72 (void) bt_ctf_stream_class_set_trace(stream_class
, NULL
);
73 bt_ctf_stream_class_put(stream_class
);
76 struct bt_ctf_trace
*bt_ctf_trace_create(void)
78 struct bt_ctf_trace
*trace
= NULL
;
80 trace
= g_new0(struct bt_ctf_trace
, 1);
85 bt_ctf_trace_set_byte_order(trace
, BT_CTF_BYTE_ORDER_NATIVE
);
86 bt_ctf_ref_init(&trace
->ref_count
);
87 trace
->clocks
= g_ptr_array_new_with_free_func(
88 (GDestroyNotify
) bt_ctf_clock_put
);
89 trace
->streams
= g_ptr_array_new_with_free_func(
90 (GDestroyNotify
) bt_ctf_stream_put
);
91 trace
->stream_classes
= g_ptr_array_new_with_free_func(
92 (GDestroyNotify
) put_stream_class
);
93 if (!trace
->clocks
|| !trace
->stream_classes
|| !trace
->streams
) {
97 /* Generate a trace UUID */
98 uuid_generate(trace
->uuid
);
99 if (init_trace_packet_header(trace
)) {
103 /* Create the environment array object */
104 trace
->environment
= bt_ctf_attributes_create();
105 if (!trace
->environment
) {
112 bt_ctf_trace_destroy(&trace
->ref_count
);
118 void bt_ctf_trace_destroy(struct bt_ctf_ref
*ref
)
120 struct bt_ctf_trace
*trace
;
126 trace
= container_of(ref
, struct bt_ctf_trace
, ref_count
);
127 if (trace
->environment
) {
128 bt_ctf_attributes_destroy(trace
->environment
);
132 g_ptr_array_free(trace
->clocks
, TRUE
);
135 if (trace
->streams
) {
136 g_ptr_array_free(trace
->streams
, TRUE
);
139 if (trace
->stream_classes
) {
140 g_ptr_array_free(trace
->stream_classes
, TRUE
);
143 bt_ctf_field_type_put(trace
->packet_header_type
);
147 struct bt_ctf_stream
*bt_ctf_trace_create_stream(struct bt_ctf_trace
*trace
,
148 struct bt_ctf_stream_class
*stream_class
)
151 int stream_class_found
= 0;
153 struct bt_ctf_stream
*stream
= NULL
;
155 if (!trace
|| !stream_class
) {
159 stream
= bt_ctf_stream_create(stream_class
, trace
);
164 for (i
= 0; i
< trace
->stream_classes
->len
; i
++) {
165 if (trace
->stream_classes
->pdata
[i
] == stream_class
) {
166 stream_class_found
= 1;
170 if (!stream_class_found
) {
171 ret
= bt_ctf_trace_add_stream_class(trace
, stream_class
);
177 bt_ctf_stream_get(stream
);
178 g_ptr_array_add(trace
->streams
, stream
);
182 bt_ctf_stream_put(stream
);
186 int bt_ctf_trace_set_environment_field(struct bt_ctf_trace
*trace
,
187 const char *name
, struct bt_object
*value
)
191 if (!trace
|| !name
|| !value
||
192 bt_ctf_validate_identifier(name
) ||
193 !(bt_object_is_integer(value
) || bt_object_is_string(value
))) {
198 if (strchr(name
, ' ')) {
205 * New environment fields may be added to a frozen trace,
206 * but existing fields may not be changed.
208 * The object passed is frozen like all other attributes.
210 struct bt_object
*attribute
=
211 bt_ctf_attributes_get_field_value_by_name(
212 trace
->environment
, name
);
215 BT_OBJECT_PUT(attribute
);
220 bt_object_freeze(value
);
223 ret
= bt_ctf_attributes_set_field_value(trace
->environment
, name
,
230 int bt_ctf_trace_set_environment_field_string(struct bt_ctf_trace
*trace
,
231 const char *name
, const char *value
)
234 struct bt_object
*env_value_string_obj
= NULL
;
236 if (!trace
|| !name
|| !value
) {
243 * New environment fields may be added to a frozen trace,
244 * but existing fields may not be changed.
246 struct bt_object
*attribute
=
247 bt_ctf_attributes_get_field_value_by_name(
248 trace
->environment
, name
);
251 BT_OBJECT_PUT(attribute
);
257 env_value_string_obj
= bt_object_string_create_init(value
);
259 if (!env_value_string_obj
) {
265 bt_object_freeze(env_value_string_obj
);
267 ret
= bt_ctf_trace_set_environment_field(trace
, name
,
268 env_value_string_obj
);
271 BT_OBJECT_PUT(env_value_string_obj
);
276 int bt_ctf_trace_set_environment_field_integer(struct bt_ctf_trace
*trace
,
277 const char *name
, int64_t value
)
280 struct bt_object
*env_value_integer_obj
= NULL
;
282 if (!trace
|| !name
) {
289 * New environment fields may be added to a frozen trace,
290 * but existing fields may not be changed.
292 struct bt_object
*attribute
=
293 bt_ctf_attributes_get_field_value_by_name(
294 trace
->environment
, name
);
297 BT_OBJECT_PUT(attribute
);
303 env_value_integer_obj
= bt_object_integer_create_init(value
);
304 if (!env_value_integer_obj
) {
309 ret
= bt_ctf_trace_set_environment_field(trace
, name
,
310 env_value_integer_obj
);
312 bt_object_freeze(env_value_integer_obj
);
315 BT_OBJECT_PUT(env_value_integer_obj
);
320 int bt_ctf_trace_get_environment_field_count(struct bt_ctf_trace
*trace
)
329 ret
= bt_ctf_attributes_get_count(trace
->environment
);
336 bt_ctf_trace_get_environment_field_name(struct bt_ctf_trace
*trace
,
339 const char *ret
= NULL
;
345 ret
= bt_ctf_attributes_get_field_name(trace
->environment
, index
);
351 struct bt_object
*bt_ctf_trace_get_environment_field_value(
352 struct bt_ctf_trace
*trace
, int index
)
354 struct bt_object
*ret
= NULL
;
360 ret
= bt_ctf_attributes_get_field_value(trace
->environment
, index
);
366 struct bt_object
*bt_ctf_trace_get_environment_field_value_by_name(
367 struct bt_ctf_trace
*trace
, const char *name
)
369 struct bt_object
*ret
= NULL
;
371 if (!trace
|| !name
) {
375 ret
= bt_ctf_attributes_get_field_value_by_name(trace
->environment
,
382 int bt_ctf_trace_add_clock(struct bt_ctf_trace
*trace
,
383 struct bt_ctf_clock
*clock
)
386 struct search_query query
= { .value
= clock
, .found
= 0 };
388 if (!trace
|| !clock
) {
393 /* Check for duplicate clocks */
394 g_ptr_array_foreach(trace
->clocks
, value_exists
, &query
);
400 bt_ctf_clock_get(clock
);
401 g_ptr_array_add(trace
->clocks
, clock
);
406 int bt_ctf_trace_get_clock_count(struct bt_ctf_trace
*trace
)
414 ret
= trace
->clocks
->len
;
419 struct bt_ctf_clock
*bt_ctf_trace_get_clock(struct bt_ctf_trace
*trace
,
422 struct bt_ctf_clock
*clock
= NULL
;
424 if (!trace
|| index
< 0 || index
>= trace
->clocks
->len
) {
428 clock
= g_ptr_array_index(trace
->clocks
, index
);
429 bt_ctf_clock_get(clock
);
434 int bt_ctf_trace_add_stream_class(struct bt_ctf_trace
*trace
,
435 struct bt_ctf_stream_class
*stream_class
)
440 if (!trace
|| !stream_class
) {
445 for (i
= 0; i
< trace
->stream_classes
->len
; i
++) {
446 if (trace
->stream_classes
->pdata
[i
] == stream_class
) {
447 /* Stream already registered to the trace */
453 ret
= bt_ctf_stream_class_resolve_types(stream_class
, trace
);
458 stream_id
= bt_ctf_stream_class_get_id(stream_class
);
460 stream_id
= trace
->next_stream_id
++;
462 /* Try to assign a new stream id */
463 for (i
= 0; i
< trace
->stream_classes
->len
; i
++) {
464 if (stream_id
== bt_ctf_stream_class_get_id(
465 trace
->stream_classes
->pdata
[i
])) {
466 /* Duplicate stream id found */
472 if (bt_ctf_stream_class_set_id_no_check(stream_class
,
474 /* TODO Should retry with a different stream id */
480 /* Set weak reference to trace in stream class */
481 ret
= bt_ctf_stream_class_set_trace(stream_class
, trace
);
483 /* Stream class already part of another trace */
487 bt_ctf_stream_class_get(stream_class
);
488 g_ptr_array_add(trace
->stream_classes
, stream_class
);
491 * Freeze the trace and its packet header.
493 * All field type byte orders set as "native" byte ordering can now be
494 * safely set to trace's own endianness, including the stream class'.
496 bt_ctf_field_type_set_native_byte_order(trace
->packet_header_type
,
498 ret
= bt_ctf_stream_class_set_byte_order(stream_class
,
499 trace
->byte_order
== LITTLE_ENDIAN
?
500 BT_CTF_BYTE_ORDER_LITTLE_ENDIAN
: BT_CTF_BYTE_ORDER_BIG_ENDIAN
);
505 bt_ctf_stream_class_freeze(stream_class
);
506 if (!trace
->frozen
) {
507 ret
= bt_ctf_trace_freeze(trace
);
512 (void) bt_ctf_stream_class_set_trace(stream_class
, NULL
);
517 int bt_ctf_trace_get_stream_class_count(struct bt_ctf_trace
*trace
)
526 ret
= trace
->stream_classes
->len
;
531 struct bt_ctf_stream_class
*bt_ctf_trace_get_stream_class(
532 struct bt_ctf_trace
*trace
, int index
)
534 struct bt_ctf_stream_class
*stream_class
= NULL
;
536 if (!trace
|| index
< 0 || index
>= trace
->stream_classes
->len
) {
540 stream_class
= g_ptr_array_index(trace
->stream_classes
, index
);
541 bt_ctf_stream_class_get(stream_class
);
546 struct bt_ctf_clock
*bt_ctf_trace_get_clock_by_name(
547 struct bt_ctf_trace
*trace
, const char *name
)
550 struct bt_ctf_clock
*clock
= NULL
;
552 if (!trace
|| !name
) {
556 for (i
= 0; i
< trace
->clocks
->len
; ++i
) {
557 struct bt_ctf_clock
*cur_clk
=
558 g_ptr_array_index(trace
->clocks
, i
);
559 const char *cur_clk_name
= bt_ctf_clock_get_name(cur_clk
);
565 if (!strcmp(cur_clk_name
, name
)) {
567 bt_ctf_clock_get(clock
);
577 const char *get_byte_order_string(int byte_order
)
581 switch (byte_order
) {
597 int append_trace_metadata(struct bt_ctf_trace
*trace
,
598 struct metadata_context
*context
)
600 unsigned char *uuid
= trace
->uuid
;
603 g_string_append(context
->string
, "trace {\n");
605 g_string_append(context
->string
, "\tmajor = 1;\n");
606 g_string_append(context
->string
, "\tminor = 8;\n");
608 g_string_append_printf(context
->string
,
609 "\tuuid = \"%02x%02x%02x%02x-%02x%02x-%02x%02x-%02x%02x-%02x%02x%02x%02x%02x%02x\";\n",
610 uuid
[0], uuid
[1], uuid
[2], uuid
[3],
611 uuid
[4], uuid
[5], uuid
[6], uuid
[7],
612 uuid
[8], uuid
[9], uuid
[10], uuid
[11],
613 uuid
[12], uuid
[13], uuid
[14], uuid
[15]);
614 g_string_append_printf(context
->string
, "\tbyte_order = %s;\n",
615 get_byte_order_string(trace
->byte_order
));
617 g_string_append(context
->string
, "\tpacket.header := ");
618 context
->current_indentation_level
++;
619 g_string_assign(context
->field_name
, "");
620 ret
= bt_ctf_field_type_serialize(trace
->packet_header_type
,
625 context
->current_indentation_level
--;
627 g_string_append(context
->string
, ";\n};\n\n");
633 void append_env_metadata(struct bt_ctf_trace
*trace
,
634 struct metadata_context
*context
)
639 env_size
= bt_ctf_attributes_get_count(trace
->environment
);
645 g_string_append(context
->string
, "env {\n");
647 for (i
= 0; i
< env_size
; ++i
) {
648 struct bt_object
*env_field_value_obj
= NULL
;
649 const char *entry_name
;
651 entry_name
= bt_ctf_attributes_get_field_name(
652 trace
->environment
, i
);
653 env_field_value_obj
= bt_ctf_attributes_get_field_value(
654 trace
->environment
, i
);
656 if (!entry_name
|| !env_field_value_obj
) {
660 switch (bt_object_get_type(env_field_value_obj
)) {
661 case BT_OBJECT_TYPE_INTEGER
:
666 ret
= bt_object_integer_get(env_field_value_obj
,
673 g_string_append_printf(context
->string
,
674 "\t%s = %" PRId64
";\n", entry_name
,
678 case BT_OBJECT_TYPE_STRING
:
681 const char *str_value
;
682 char *escaped_str
= NULL
;
684 ret
= bt_object_string_get(env_field_value_obj
,
691 escaped_str
= g_strescape(str_value
, NULL
);
697 g_string_append_printf(context
->string
,
698 "\t%s = \"%s\";\n", entry_name
, escaped_str
);
708 BT_OBJECT_PUT(env_field_value_obj
);
711 g_string_append(context
->string
, "};\n\n");
714 char *bt_ctf_trace_get_metadata_string(struct bt_ctf_trace
*trace
)
716 char *metadata
= NULL
;
717 struct metadata_context
*context
= NULL
;
725 context
= g_new0(struct metadata_context
, 1);
730 context
->field_name
= g_string_sized_new(DEFAULT_IDENTIFIER_SIZE
);
731 context
->string
= g_string_sized_new(DEFAULT_METADATA_STRING_SIZE
);
732 g_string_append(context
->string
, "/* CTF 1.8 */\n\n");
733 if (append_trace_metadata(trace
, context
)) {
736 append_env_metadata(trace
, context
);
737 g_ptr_array_foreach(trace
->clocks
,
738 (GFunc
)bt_ctf_clock_serialize
, context
);
740 for (i
= 0; i
< trace
->stream_classes
->len
; i
++) {
741 err
= bt_ctf_stream_class_serialize(
742 trace
->stream_classes
->pdata
[i
], context
);
748 metadata
= context
->string
->str
;
750 g_string_free(context
->string
, err
? TRUE
: FALSE
);
751 g_string_free(context
->field_name
, TRUE
);
757 enum bt_ctf_byte_order
bt_ctf_trace_get_byte_order(struct bt_ctf_trace
*trace
)
759 enum bt_ctf_byte_order ret
= BT_CTF_BYTE_ORDER_UNKNOWN
;
765 switch (trace
->byte_order
) {
767 ret
= BT_CTF_BYTE_ORDER_BIG_ENDIAN
;
770 ret
= BT_CTF_BYTE_ORDER_LITTLE_ENDIAN
;
779 int bt_ctf_trace_set_byte_order(struct bt_ctf_trace
*trace
,
780 enum bt_ctf_byte_order byte_order
)
783 int internal_byte_order
;
785 if (!trace
|| trace
->frozen
) {
790 switch (byte_order
) {
791 case BT_CTF_BYTE_ORDER_NATIVE
:
793 * This doesn't make sense since the CTF specification defines
794 * the "native" byte order as "the byte order described in the
795 * trace description". However, this behavior had been
796 * implemented as part of v1.2 and is kept to maintain
799 * This may be changed on a major version bump only.
801 internal_byte_order
= (G_BYTE_ORDER
== G_LITTLE_ENDIAN
) ?
802 LITTLE_ENDIAN
: BIG_ENDIAN
;
804 case BT_CTF_BYTE_ORDER_LITTLE_ENDIAN
:
805 internal_byte_order
= LITTLE_ENDIAN
;
807 case BT_CTF_BYTE_ORDER_BIG_ENDIAN
:
808 case BT_CTF_BYTE_ORDER_NETWORK
:
809 internal_byte_order
= BIG_ENDIAN
;
816 trace
->byte_order
= internal_byte_order
;
821 struct bt_ctf_field_type
*bt_ctf_trace_get_packet_header_type(
822 struct bt_ctf_trace
*trace
)
824 struct bt_ctf_field_type
*field_type
= NULL
;
830 bt_ctf_field_type_get(trace
->packet_header_type
);
831 field_type
= trace
->packet_header_type
;
836 int bt_ctf_trace_set_packet_header_type(struct bt_ctf_trace
*trace
,
837 struct bt_ctf_field_type
*packet_header_type
)
841 if (!trace
|| !packet_header_type
|| trace
->frozen
) {
846 /* packet_header_type must be a structure */
847 if (bt_ctf_field_type_get_type_id(packet_header_type
) !=
853 bt_ctf_field_type_get(packet_header_type
);
854 bt_ctf_field_type_put(trace
->packet_header_type
);
855 trace
->packet_header_type
= packet_header_type
;
860 void bt_ctf_trace_get(struct bt_ctf_trace
*trace
)
866 bt_ctf_ref_get(&trace
->ref_count
);
869 void bt_ctf_trace_put(struct bt_ctf_trace
*trace
)
875 bt_ctf_ref_put(&trace
->ref_count
, bt_ctf_trace_destroy
);
879 struct bt_ctf_field_type
*get_field_type(enum field_type_alias alias
)
881 unsigned int alignment
, size
;
882 struct bt_ctf_field_type
*field_type
= NULL
;
884 if (alias
>= NR_FIELD_TYPE_ALIAS
) {
888 alignment
= field_type_aliases_alignments
[alias
];
889 size
= field_type_aliases_sizes
[alias
];
890 field_type
= bt_ctf_field_type_integer_create(size
);
891 bt_ctf_field_type_set_alignment(field_type
, alignment
);
897 int bt_ctf_trace_freeze(struct bt_ctf_trace
*trace
)
901 ret
= bt_ctf_trace_resolve_types(trace
);
906 bt_ctf_attributes_freeze(trace
->environment
);
913 int init_trace_packet_header(struct bt_ctf_trace
*trace
)
916 struct bt_ctf_field
*magic
= NULL
, *uuid_array
= NULL
;
917 struct bt_ctf_field_type
*_uint32_t
=
918 get_field_type(FIELD_TYPE_ALIAS_UINT32_T
);
919 struct bt_ctf_field_type
*_uint8_t
=
920 get_field_type(FIELD_TYPE_ALIAS_UINT8_T
);
921 struct bt_ctf_field_type
*trace_packet_header_type
=
922 bt_ctf_field_type_structure_create();
923 struct bt_ctf_field_type
*uuid_array_type
=
924 bt_ctf_field_type_array_create(_uint8_t
, 16);
926 if (!trace_packet_header_type
|| !uuid_array_type
) {
931 ret
= bt_ctf_field_type_structure_add_field(trace_packet_header_type
,
937 ret
= bt_ctf_field_type_structure_add_field(trace_packet_header_type
,
938 uuid_array_type
, "uuid");
943 ret
= bt_ctf_field_type_structure_add_field(trace_packet_header_type
,
944 _uint32_t
, "stream_id");
949 ret
= bt_ctf_trace_set_packet_header_type(trace
,
950 trace_packet_header_type
);
955 bt_ctf_field_type_put(uuid_array_type
);
956 bt_ctf_field_type_put(_uint32_t
);
957 bt_ctf_field_type_put(_uint8_t
);
958 bt_ctf_field_put(magic
);
959 bt_ctf_field_put(uuid_array
);
960 bt_ctf_field_type_put(trace_packet_header_type
);