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/values.h>
40 #include <babeltrace/ref.h>
41 #include <babeltrace/endian.h>
43 #define DEFAULT_IDENTIFIER_SIZE 128
44 #define DEFAULT_METADATA_STRING_SIZE 4096
47 void bt_ctf_trace_destroy(struct bt_object
*obj
);
49 int init_trace_packet_header(struct bt_ctf_trace
*trace
);
51 int bt_ctf_trace_freeze(struct bt_ctf_trace
*trace
);
54 const unsigned int field_type_aliases_alignments
[] = {
55 [FIELD_TYPE_ALIAS_UINT5_T
] = 1,
56 [FIELD_TYPE_ALIAS_UINT8_T
... FIELD_TYPE_ALIAS_UINT16_T
] = 8,
57 [FIELD_TYPE_ALIAS_UINT27_T
] = 1,
58 [FIELD_TYPE_ALIAS_UINT32_T
... FIELD_TYPE_ALIAS_UINT64_T
] = 8,
62 const unsigned int field_type_aliases_sizes
[] = {
63 [FIELD_TYPE_ALIAS_UINT5_T
] = 5,
64 [FIELD_TYPE_ALIAS_UINT8_T
] = 8,
65 [FIELD_TYPE_ALIAS_UINT16_T
] = 16,
66 [FIELD_TYPE_ALIAS_UINT27_T
] = 27,
67 [FIELD_TYPE_ALIAS_UINT32_T
] = 32,
68 [FIELD_TYPE_ALIAS_UINT64_T
] = 64,
71 struct bt_ctf_trace
*bt_ctf_trace_create(void)
73 struct bt_ctf_trace
*trace
= NULL
;
75 trace
= g_new0(struct bt_ctf_trace
, 1);
80 bt_ctf_trace_set_byte_order(trace
, BT_CTF_BYTE_ORDER_NATIVE
);
81 bt_object_init(trace
, bt_ctf_trace_destroy
);
82 trace
->clocks
= g_ptr_array_new_with_free_func(
83 (GDestroyNotify
) bt_put
);
84 trace
->streams
= g_ptr_array_new_with_free_func(
85 (GDestroyNotify
) bt_object_release
);
86 trace
->stream_classes
= g_ptr_array_new_with_free_func(
87 (GDestroyNotify
) bt_object_release
);
88 if (!trace
->clocks
|| !trace
->stream_classes
|| !trace
->streams
) {
92 /* Generate a trace UUID */
93 uuid_generate(trace
->uuid
);
94 if (init_trace_packet_header(trace
)) {
98 /* Create the environment array object */
99 trace
->environment
= bt_ctf_attributes_create();
100 if (!trace
->environment
) {
111 void bt_ctf_trace_destroy(struct bt_object
*obj
)
113 struct bt_ctf_trace
*trace
;
115 trace
= container_of(obj
, struct bt_ctf_trace
, base
);
116 if (trace
->environment
) {
117 bt_ctf_attributes_destroy(trace
->environment
);
121 g_ptr_array_free(trace
->clocks
, TRUE
);
124 if (trace
->streams
) {
125 g_ptr_array_free(trace
->streams
, TRUE
);
128 if (trace
->stream_classes
) {
129 g_ptr_array_free(trace
->stream_classes
, TRUE
);
132 bt_put(trace
->packet_header_type
);
136 struct bt_ctf_stream
*bt_ctf_trace_create_stream(struct bt_ctf_trace
*trace
,
137 struct bt_ctf_stream_class
*stream_class
)
140 int stream_class_found
= 0;
142 struct bt_ctf_stream
*stream
= NULL
;
144 if (!trace
|| !stream_class
) {
148 for (i
= 0; i
< trace
->stream_classes
->len
; i
++) {
149 if (trace
->stream_classes
->pdata
[i
] == stream_class
) {
150 stream_class_found
= 1;
154 if (!stream_class_found
) {
155 ret
= bt_ctf_trace_add_stream_class(trace
, stream_class
);
161 stream
= bt_ctf_stream_create(stream_class
, trace
);
166 g_ptr_array_add(trace
->streams
, stream
);
173 int bt_ctf_trace_set_environment_field(struct bt_ctf_trace
*trace
,
174 const char *name
, struct bt_value
*value
)
178 if (!trace
|| !name
|| !value
||
179 bt_ctf_validate_identifier(name
) ||
180 !(bt_value_is_integer(value
) || bt_value_is_string(value
))) {
185 if (strchr(name
, ' ')) {
192 * New environment fields may be added to a frozen trace,
193 * but existing fields may not be changed.
195 * The object passed is frozen like all other attributes.
197 struct bt_value
*attribute
=
198 bt_ctf_attributes_get_field_value_by_name(
199 trace
->environment
, name
);
207 bt_value_freeze(value
);
210 ret
= bt_ctf_attributes_set_field_value(trace
->environment
, name
,
217 int bt_ctf_trace_set_environment_field_string(struct bt_ctf_trace
*trace
,
218 const char *name
, const char *value
)
221 struct bt_value
*env_value_string_obj
= NULL
;
223 if (!trace
|| !name
|| !value
) {
230 * New environment fields may be added to a frozen trace,
231 * but existing fields may not be changed.
233 struct bt_value
*attribute
=
234 bt_ctf_attributes_get_field_value_by_name(
235 trace
->environment
, name
);
244 env_value_string_obj
= bt_value_string_create_init(value
);
246 if (!env_value_string_obj
) {
252 bt_value_freeze(env_value_string_obj
);
254 ret
= bt_ctf_trace_set_environment_field(trace
, name
,
255 env_value_string_obj
);
258 BT_PUT(env_value_string_obj
);
262 int bt_ctf_trace_set_environment_field_integer(struct bt_ctf_trace
*trace
,
263 const char *name
, int64_t value
)
266 struct bt_value
*env_value_integer_obj
= NULL
;
268 if (!trace
|| !name
) {
275 * New environment fields may be added to a frozen trace,
276 * but existing fields may not be changed.
278 struct bt_value
*attribute
=
279 bt_ctf_attributes_get_field_value_by_name(
280 trace
->environment
, name
);
289 env_value_integer_obj
= bt_value_integer_create_init(value
);
290 if (!env_value_integer_obj
) {
295 ret
= bt_ctf_trace_set_environment_field(trace
, name
,
296 env_value_integer_obj
);
298 bt_value_freeze(env_value_integer_obj
);
301 BT_PUT(env_value_integer_obj
);
305 int bt_ctf_trace_get_environment_field_count(struct bt_ctf_trace
*trace
)
314 ret
= bt_ctf_attributes_get_count(trace
->environment
);
321 bt_ctf_trace_get_environment_field_name(struct bt_ctf_trace
*trace
,
324 const char *ret
= NULL
;
330 ret
= bt_ctf_attributes_get_field_name(trace
->environment
, index
);
336 struct bt_value
*bt_ctf_trace_get_environment_field_value(
337 struct bt_ctf_trace
*trace
, int index
)
339 struct bt_value
*ret
= NULL
;
345 ret
= bt_ctf_attributes_get_field_value(trace
->environment
, index
);
351 struct bt_value
*bt_ctf_trace_get_environment_field_value_by_name(
352 struct bt_ctf_trace
*trace
, const char *name
)
354 struct bt_value
*ret
= NULL
;
356 if (!trace
|| !name
) {
360 ret
= bt_ctf_attributes_get_field_value_by_name(trace
->environment
,
367 int bt_ctf_trace_add_clock(struct bt_ctf_trace
*trace
,
368 struct bt_ctf_clock
*clock
)
371 struct search_query query
= { .value
= clock
, .found
= 0 };
373 if (!trace
|| !clock
) {
378 /* Check for duplicate clocks */
379 g_ptr_array_foreach(trace
->clocks
, value_exists
, &query
);
386 g_ptr_array_add(trace
->clocks
, clock
);
391 int bt_ctf_trace_get_clock_count(struct bt_ctf_trace
*trace
)
399 ret
= trace
->clocks
->len
;
404 struct bt_ctf_clock
*bt_ctf_trace_get_clock(struct bt_ctf_trace
*trace
,
407 struct bt_ctf_clock
*clock
= NULL
;
409 if (!trace
|| index
< 0 || index
>= trace
->clocks
->len
) {
413 clock
= g_ptr_array_index(trace
->clocks
, index
);
419 int bt_ctf_trace_add_stream_class(struct bt_ctf_trace
*trace
,
420 struct bt_ctf_stream_class
*stream_class
)
425 if (!trace
|| !stream_class
) {
430 for (i
= 0; i
< trace
->stream_classes
->len
; i
++) {
431 if (trace
->stream_classes
->pdata
[i
] == stream_class
) {
432 /* Stream already registered to the trace */
438 ret
= bt_ctf_stream_class_resolve_types(stream_class
, trace
);
443 stream_id
= bt_ctf_stream_class_get_id(stream_class
);
445 stream_id
= trace
->next_stream_id
++;
447 /* Try to assign a new stream id */
448 for (i
= 0; i
< trace
->stream_classes
->len
; i
++) {
449 if (stream_id
== bt_ctf_stream_class_get_id(
450 trace
->stream_classes
->pdata
[i
])) {
451 /* Duplicate stream id found */
457 if (bt_ctf_stream_class_set_id_no_check(stream_class
,
459 /* TODO Should retry with a different stream id */
465 bt_object_set_parent(stream_class
, trace
);
466 g_ptr_array_add(trace
->stream_classes
, stream_class
);
469 * Freeze the trace and its packet header.
471 * All field type byte orders set as "native" byte ordering can now be
472 * safely set to trace's own endianness, including the stream class'.
474 bt_ctf_field_type_set_native_byte_order(trace
->packet_header_type
,
476 bt_ctf_stream_class_set_byte_order(stream_class
, trace
->byte_order
);
478 bt_ctf_stream_class_freeze(stream_class
);
479 if (!trace
->frozen
) {
480 ret
= bt_ctf_trace_freeze(trace
);
484 bt_object_set_parent(stream_class
, NULL
);
489 int bt_ctf_trace_get_stream_class_count(struct bt_ctf_trace
*trace
)
498 ret
= trace
->stream_classes
->len
;
503 struct bt_ctf_stream_class
*bt_ctf_trace_get_stream_class(
504 struct bt_ctf_trace
*trace
, int index
)
506 struct bt_ctf_stream_class
*stream_class
= NULL
;
508 if (!trace
|| index
< 0 || index
>= trace
->stream_classes
->len
) {
512 stream_class
= g_ptr_array_index(trace
->stream_classes
, index
);
513 bt_get(stream_class
);
518 struct bt_ctf_stream_class
*bt_ctf_trace_get_stream_class_by_id(
519 struct bt_ctf_trace
*trace
, uint32_t id
)
522 struct bt_ctf_stream_class
*stream_class
= NULL
;
528 for (i
= 0; i
< trace
->stream_classes
->len
; ++i
) {
529 struct bt_ctf_stream_class
*stream_class_candidate
;
531 stream_class_candidate
=
532 g_ptr_array_index(trace
->stream_classes
, i
);
534 if (bt_ctf_stream_class_get_id(stream_class_candidate
) ==
536 stream_class
= stream_class_candidate
;
537 bt_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
)) {
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_value
*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_value_get_type(env_field_value_obj
)) {
661 case BT_VALUE_TYPE_INTEGER
:
666 ret
= bt_value_integer_get(env_field_value_obj
,
673 g_string_append_printf(context
->string
,
674 "\t%s = %" PRId64
";\n", entry_name
,
678 case BT_VALUE_TYPE_STRING
:
681 const char *str_value
;
682 char *escaped_str
= NULL
;
684 ret
= bt_value_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_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_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_get(packet_header_type
);
854 bt_put(trace
->packet_header_type
);
855 trace
->packet_header_type
= packet_header_type
;
860 void bt_ctf_trace_get(struct bt_ctf_trace
*trace
)
865 void bt_ctf_trace_put(struct bt_ctf_trace
*trace
)
872 struct bt_ctf_field_type
*get_field_type(enum field_type_alias alias
)
874 unsigned int alignment
, size
;
875 struct bt_ctf_field_type
*field_type
= NULL
;
877 if (alias
>= NR_FIELD_TYPE_ALIAS
) {
881 alignment
= field_type_aliases_alignments
[alias
];
882 size
= field_type_aliases_sizes
[alias
];
883 field_type
= bt_ctf_field_type_integer_create(size
);
884 bt_ctf_field_type_set_alignment(field_type
, alignment
);
890 int bt_ctf_trace_freeze(struct bt_ctf_trace
*trace
)
894 ret
= bt_ctf_trace_resolve_types(trace
);
899 bt_ctf_attributes_freeze(trace
->environment
);
906 int init_trace_packet_header(struct bt_ctf_trace
*trace
)
909 struct bt_ctf_field
*magic
= NULL
, *uuid_array
= NULL
;
910 struct bt_ctf_field_type
*_uint32_t
=
911 get_field_type(FIELD_TYPE_ALIAS_UINT32_T
);
912 struct bt_ctf_field_type
*_uint8_t
=
913 get_field_type(FIELD_TYPE_ALIAS_UINT8_T
);
914 struct bt_ctf_field_type
*trace_packet_header_type
=
915 bt_ctf_field_type_structure_create();
916 struct bt_ctf_field_type
*uuid_array_type
=
917 bt_ctf_field_type_array_create(_uint8_t
, 16);
919 if (!trace_packet_header_type
|| !uuid_array_type
) {
924 ret
= bt_ctf_field_type_structure_add_field(trace_packet_header_type
,
930 ret
= bt_ctf_field_type_structure_add_field(trace_packet_header_type
,
931 uuid_array_type
, "uuid");
936 ret
= bt_ctf_field_type_structure_add_field(trace_packet_header_type
,
937 _uint32_t
, "stream_id");
942 ret
= bt_ctf_trace_set_packet_header_type(trace
,
943 trace_packet_header_type
);
948 bt_put(uuid_array_type
);
953 bt_put(trace_packet_header_type
);