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/utils.h>
37 #include <babeltrace/compiler.h>
38 #include <babeltrace/objects.h>
40 #define DEFAULT_IDENTIFIER_SIZE 128
41 #define DEFAULT_METADATA_STRING_SIZE 4096
44 void bt_ctf_trace_destroy(struct bt_ctf_ref
*ref
);
46 int init_trace_packet_header(struct bt_ctf_trace
*trace
);
48 void bt_ctf_trace_freeze(struct bt_ctf_trace
*trace
);
51 const unsigned int field_type_aliases_alignments
[] = {
52 [FIELD_TYPE_ALIAS_UINT5_T
] = 1,
53 [FIELD_TYPE_ALIAS_UINT8_T
... FIELD_TYPE_ALIAS_UINT16_T
] = 8,
54 [FIELD_TYPE_ALIAS_UINT27_T
] = 1,
55 [FIELD_TYPE_ALIAS_UINT32_T
... FIELD_TYPE_ALIAS_UINT64_T
] = 8,
59 const unsigned int field_type_aliases_sizes
[] = {
60 [FIELD_TYPE_ALIAS_UINT5_T
] = 5,
61 [FIELD_TYPE_ALIAS_UINT8_T
] = 8,
62 [FIELD_TYPE_ALIAS_UINT16_T
] = 16,
63 [FIELD_TYPE_ALIAS_UINT27_T
] = 27,
64 [FIELD_TYPE_ALIAS_UINT32_T
] = 32,
65 [FIELD_TYPE_ALIAS_UINT64_T
] = 64,
69 void put_stream_class(struct bt_ctf_stream_class
*stream_class
)
71 (void) bt_ctf_stream_class_set_trace(stream_class
, NULL
);
72 bt_ctf_stream_class_put(stream_class
);
75 struct bt_ctf_trace
*bt_ctf_trace_create(void)
77 struct bt_ctf_trace
*trace
= NULL
;
79 trace
= g_new0(struct bt_ctf_trace
, 1);
84 bt_ctf_trace_set_byte_order(trace
, BT_CTF_BYTE_ORDER_NATIVE
);
85 bt_ctf_ref_init(&trace
->ref_count
);
86 trace
->clocks
= g_ptr_array_new_with_free_func(
87 (GDestroyNotify
) bt_ctf_clock_put
);
88 trace
->streams
= g_ptr_array_new_with_free_func(
89 (GDestroyNotify
) bt_ctf_stream_put
);
90 trace
->stream_classes
= g_ptr_array_new_with_free_func(
91 (GDestroyNotify
) put_stream_class
);
92 if (!trace
->clocks
|| !trace
->stream_classes
|| !trace
->streams
) {
96 /* Generate a trace UUID */
97 uuid_generate(trace
->uuid
);
98 if (init_trace_packet_header(trace
)) {
102 /* Create the environment array object */
103 trace
->environment
= bt_ctf_attributes_create();
104 if (!trace
->environment
) {
111 bt_ctf_trace_destroy(&trace
->ref_count
);
117 void bt_ctf_trace_destroy(struct bt_ctf_ref
*ref
)
119 struct bt_ctf_trace
*trace
;
125 trace
= container_of(ref
, struct bt_ctf_trace
, ref_count
);
126 if (trace
->environment
) {
127 bt_ctf_attributes_destroy(trace
->environment
);
131 g_ptr_array_free(trace
->clocks
, TRUE
);
134 if (trace
->streams
) {
135 g_ptr_array_free(trace
->streams
, TRUE
);
138 if (trace
->stream_classes
) {
139 g_ptr_array_free(trace
->stream_classes
, TRUE
);
142 bt_ctf_field_type_put(trace
->packet_header_type
);
146 struct bt_ctf_stream
*bt_ctf_trace_create_stream(struct bt_ctf_trace
*trace
,
147 struct bt_ctf_stream_class
*stream_class
)
150 int stream_class_found
= 0;
152 struct bt_ctf_stream
*stream
= NULL
;
154 if (!trace
|| !stream_class
) {
158 stream
= bt_ctf_stream_create(stream_class
, trace
);
163 for (i
= 0; i
< trace
->stream_classes
->len
; i
++) {
164 if (trace
->stream_classes
->pdata
[i
] == stream_class
) {
165 stream_class_found
= 1;
169 if (!stream_class_found
) {
170 ret
= bt_ctf_trace_add_stream_class(trace
, stream_class
);
176 bt_ctf_stream_get(stream
);
177 g_ptr_array_add(trace
->streams
, stream
);
181 bt_ctf_stream_put(stream
);
185 int bt_ctf_trace_set_environment_field(struct bt_ctf_trace
*trace
,
186 const char *name
, struct bt_object
*value
)
190 if (!trace
|| !name
|| !value
||
191 bt_ctf_validate_identifier(name
) ||
192 !(bt_object_is_integer(value
) || bt_object_is_string(value
))) {
197 if (strchr(name
, ' ')) {
204 * New environment fields may be added to a frozen trace,
205 * but existing fields may not be changed.
207 * The object passed is frozen like all other attributes.
209 struct bt_object
*attribute
=
210 bt_ctf_attributes_get_field_value_by_name(
211 trace
->environment
, name
);
214 BT_OBJECT_PUT(attribute
);
219 bt_object_freeze(value
);
222 ret
= bt_ctf_attributes_set_field_value(trace
->environment
, name
,
229 int bt_ctf_trace_set_environment_field_string(struct bt_ctf_trace
*trace
,
230 const char *name
, const char *value
)
233 struct bt_object
*env_value_string_obj
= NULL
;
235 if (!trace
|| !name
|| !value
) {
242 * New environment fields may be added to a frozen trace,
243 * but existing fields may not be changed.
245 struct bt_object
*attribute
=
246 bt_ctf_attributes_get_field_value_by_name(
247 trace
->environment
, name
);
250 BT_OBJECT_PUT(attribute
);
256 env_value_string_obj
= bt_object_string_create_init(value
);
258 if (!env_value_string_obj
) {
264 bt_object_freeze(env_value_string_obj
);
266 ret
= bt_ctf_trace_set_environment_field(trace
, name
,
267 env_value_string_obj
);
270 BT_OBJECT_PUT(env_value_string_obj
);
275 int bt_ctf_trace_set_environment_field_integer(struct bt_ctf_trace
*trace
,
276 const char *name
, int64_t value
)
279 struct bt_object
*env_value_integer_obj
= NULL
;
281 if (!trace
|| !name
) {
288 * New environment fields may be added to a frozen trace,
289 * but existing fields may not be changed.
291 struct bt_object
*attribute
=
292 bt_ctf_attributes_get_field_value_by_name(
293 trace
->environment
, name
);
296 BT_OBJECT_PUT(attribute
);
302 env_value_integer_obj
= bt_object_integer_create_init(value
);
303 if (!env_value_integer_obj
) {
308 ret
= bt_ctf_trace_set_environment_field(trace
, name
,
309 env_value_integer_obj
);
311 bt_object_freeze(env_value_integer_obj
);
314 BT_OBJECT_PUT(env_value_integer_obj
);
319 int bt_ctf_trace_get_environment_field_count(struct bt_ctf_trace
*trace
)
328 ret
= bt_ctf_attributes_get_count(trace
->environment
);
335 bt_ctf_trace_get_environment_field_name(struct bt_ctf_trace
*trace
,
338 const char *ret
= NULL
;
344 ret
= bt_ctf_attributes_get_field_name(trace
->environment
, index
);
350 struct bt_object
*bt_ctf_trace_get_environment_field_value(
351 struct bt_ctf_trace
*trace
, int index
)
353 struct bt_object
*ret
= NULL
;
359 ret
= bt_ctf_attributes_get_field_value(trace
->environment
, index
);
365 struct bt_object
*bt_ctf_trace_get_environment_field_value_by_name(
366 struct bt_ctf_trace
*trace
, const char *name
)
368 struct bt_object
*ret
= NULL
;
370 if (!trace
|| !name
) {
374 ret
= bt_ctf_attributes_get_field_value_by_name(trace
->environment
,
381 int bt_ctf_trace_add_clock(struct bt_ctf_trace
*trace
,
382 struct bt_ctf_clock
*clock
)
385 struct search_query query
= { .value
= clock
, .found
= 0 };
387 if (!trace
|| !clock
) {
392 /* Check for duplicate clocks */
393 g_ptr_array_foreach(trace
->clocks
, value_exists
, &query
);
399 bt_ctf_clock_get(clock
);
400 g_ptr_array_add(trace
->clocks
, clock
);
405 int bt_ctf_trace_get_clock_count(struct bt_ctf_trace
*trace
)
413 ret
= trace
->clocks
->len
;
418 struct bt_ctf_clock
*bt_ctf_trace_get_clock(struct bt_ctf_trace
*trace
,
421 struct bt_ctf_clock
*clock
= NULL
;
423 if (!trace
|| index
< 0 || index
>= trace
->clocks
->len
) {
427 clock
= g_ptr_array_index(trace
->clocks
, index
);
428 bt_ctf_clock_get(clock
);
433 int bt_ctf_trace_add_stream_class(struct bt_ctf_trace
*trace
,
434 struct bt_ctf_stream_class
*stream_class
)
439 if (!trace
|| !stream_class
) {
444 for (i
= 0; i
< trace
->stream_classes
->len
; i
++) {
445 if (trace
->stream_classes
->pdata
[i
] == stream_class
) {
446 /* Stream already registered to the trace */
452 stream_id
= bt_ctf_stream_class_get_id(stream_class
);
454 stream_id
= trace
->next_stream_id
++;
456 /* Try to assign a new stream id */
457 for (i
= 0; i
< trace
->stream_classes
->len
; i
++) {
458 if (stream_id
== bt_ctf_stream_class_get_id(
459 trace
->stream_classes
->pdata
[i
])) {
460 /* Duplicate stream id found */
466 if (bt_ctf_stream_class_set_id_no_check(stream_class
, stream_id
)) {
467 /* TODO Should retry with a different stream id */
473 /* Set weak reference to trace in stream class */
474 ret
= bt_ctf_stream_class_set_trace(stream_class
, trace
);
476 /* Stream class already part of another trace */
480 bt_ctf_stream_class_get(stream_class
);
481 g_ptr_array_add(trace
->stream_classes
, stream_class
);
484 * Freeze the trace and its packet header.
486 * All field type byte orders set as "native" byte ordering can now be
487 * safely set to trace's own endianness, including the stream class'.
489 bt_ctf_field_type_set_native_byte_order(trace
->packet_header_type
,
491 ret
= bt_ctf_stream_class_set_byte_order(stream_class
,
492 trace
->byte_order
== LITTLE_ENDIAN
?
493 BT_CTF_BYTE_ORDER_LITTLE_ENDIAN
: BT_CTF_BYTE_ORDER_BIG_ENDIAN
);
498 bt_ctf_stream_class_freeze(stream_class
);
499 bt_ctf_trace_freeze(trace
);
502 (void) bt_ctf_stream_class_set_trace(stream_class
, NULL
);
507 int bt_ctf_trace_get_stream_class_count(struct bt_ctf_trace
*trace
)
516 ret
= trace
->stream_classes
->len
;
521 struct bt_ctf_stream_class
*bt_ctf_trace_get_stream_class(
522 struct bt_ctf_trace
*trace
, int index
)
524 struct bt_ctf_stream_class
*stream_class
= NULL
;
526 if (!trace
|| index
< 0 || index
>= trace
->stream_classes
->len
) {
530 stream_class
= g_ptr_array_index(trace
->stream_classes
, index
);
531 bt_ctf_stream_class_get(stream_class
);
536 struct bt_ctf_clock
*bt_ctf_trace_get_clock_by_name(
537 struct bt_ctf_trace
*trace
, const char *name
)
540 struct bt_ctf_clock
*clock
= NULL
;
542 if (!trace
|| !name
) {
546 for (i
= 0; i
< trace
->clocks
->len
; ++i
) {
547 struct bt_ctf_clock
*cur_clk
=
548 g_ptr_array_index(trace
->clocks
, i
);
549 const char *cur_clk_name
= bt_ctf_clock_get_name(cur_clk
);
555 if (!strcmp(cur_clk_name
, name
)) {
557 bt_ctf_clock_get(clock
);
567 const char *get_byte_order_string(int byte_order
)
571 switch (byte_order
) {
587 int append_trace_metadata(struct bt_ctf_trace
*trace
,
588 struct metadata_context
*context
)
590 unsigned char *uuid
= trace
->uuid
;
593 g_string_append(context
->string
, "trace {\n");
595 g_string_append(context
->string
, "\tmajor = 1;\n");
596 g_string_append(context
->string
, "\tminor = 8;\n");
598 g_string_append_printf(context
->string
,
599 "\tuuid = \"%02x%02x%02x%02x-%02x%02x-%02x%02x-%02x%02x-%02x%02x%02x%02x%02x%02x\";\n",
600 uuid
[0], uuid
[1], uuid
[2], uuid
[3],
601 uuid
[4], uuid
[5], uuid
[6], uuid
[7],
602 uuid
[8], uuid
[9], uuid
[10], uuid
[11],
603 uuid
[12], uuid
[13], uuid
[14], uuid
[15]);
604 g_string_append_printf(context
->string
, "\tbyte_order = %s;\n",
605 get_byte_order_string(trace
->byte_order
));
607 g_string_append(context
->string
, "\tpacket.header := ");
608 context
->current_indentation_level
++;
609 g_string_assign(context
->field_name
, "");
610 ret
= bt_ctf_field_type_serialize(trace
->packet_header_type
,
615 context
->current_indentation_level
--;
617 g_string_append(context
->string
, ";\n};\n\n");
623 void append_env_metadata(struct bt_ctf_trace
*trace
,
624 struct metadata_context
*context
)
629 env_size
= bt_ctf_attributes_get_count(trace
->environment
);
635 g_string_append(context
->string
, "env {\n");
637 for (i
= 0; i
< env_size
; ++i
) {
638 struct bt_object
*env_field_value_obj
= NULL
;
639 const char *entry_name
;
641 entry_name
= bt_ctf_attributes_get_field_name(
642 trace
->environment
, i
);
643 env_field_value_obj
= bt_ctf_attributes_get_field_value(
644 trace
->environment
, i
);
646 if (!entry_name
|| !env_field_value_obj
) {
650 switch (bt_object_get_type(env_field_value_obj
)) {
651 case BT_OBJECT_TYPE_INTEGER
:
656 ret
= bt_object_integer_get(env_field_value_obj
,
663 g_string_append_printf(context
->string
,
664 "\t%s = %" PRId64
";\n", entry_name
,
668 case BT_OBJECT_TYPE_STRING
:
671 const char *str_value
;
672 char *escaped_str
= NULL
;
674 ret
= bt_object_string_get(env_field_value_obj
,
681 escaped_str
= g_strescape(str_value
, NULL
);
687 g_string_append_printf(context
->string
,
688 "\t%s = \"%s\";\n", entry_name
, escaped_str
);
698 BT_OBJECT_PUT(env_field_value_obj
);
701 g_string_append(context
->string
, "};\n\n");
704 char *bt_ctf_trace_get_metadata_string(struct bt_ctf_trace
*trace
)
706 char *metadata
= NULL
;
707 struct metadata_context
*context
= NULL
;
715 context
= g_new0(struct metadata_context
, 1);
720 context
->field_name
= g_string_sized_new(DEFAULT_IDENTIFIER_SIZE
);
721 context
->string
= g_string_sized_new(DEFAULT_METADATA_STRING_SIZE
);
722 g_string_append(context
->string
, "/* CTF 1.8 */\n\n");
723 if (append_trace_metadata(trace
, context
)) {
726 append_env_metadata(trace
, context
);
727 g_ptr_array_foreach(trace
->clocks
,
728 (GFunc
)bt_ctf_clock_serialize
, context
);
730 for (i
= 0; i
< trace
->stream_classes
->len
; i
++) {
731 err
= bt_ctf_stream_class_serialize(
732 trace
->stream_classes
->pdata
[i
], context
);
738 metadata
= context
->string
->str
;
740 g_string_free(context
->string
, err
? TRUE
: FALSE
);
741 g_string_free(context
->field_name
, TRUE
);
747 enum bt_ctf_byte_order
bt_ctf_trace_get_byte_order(struct bt_ctf_trace
*trace
)
749 enum bt_ctf_byte_order ret
= BT_CTF_BYTE_ORDER_UNKNOWN
;
755 switch (trace
->byte_order
) {
757 ret
= BT_CTF_BYTE_ORDER_BIG_ENDIAN
;
760 ret
= BT_CTF_BYTE_ORDER_LITTLE_ENDIAN
;
769 int bt_ctf_trace_set_byte_order(struct bt_ctf_trace
*trace
,
770 enum bt_ctf_byte_order byte_order
)
773 int internal_byte_order
;
775 if (!trace
|| trace
->frozen
) {
780 switch (byte_order
) {
781 case BT_CTF_BYTE_ORDER_NATIVE
:
783 * This doesn't make sense since the CTF specification defines
784 * the "native" byte order as "the byte order described in the
785 * trace description". However, this behavior had been
786 * implemented as part of v1.2 and is kept to maintain
789 * This may be changed on a major version bump only.
791 internal_byte_order
= (G_BYTE_ORDER
== G_LITTLE_ENDIAN
) ?
792 LITTLE_ENDIAN
: BIG_ENDIAN
;
794 case BT_CTF_BYTE_ORDER_LITTLE_ENDIAN
:
795 internal_byte_order
= LITTLE_ENDIAN
;
797 case BT_CTF_BYTE_ORDER_BIG_ENDIAN
:
798 case BT_CTF_BYTE_ORDER_NETWORK
:
799 internal_byte_order
= BIG_ENDIAN
;
806 trace
->byte_order
= internal_byte_order
;
811 struct bt_ctf_field_type
*bt_ctf_trace_get_packet_header_type(
812 struct bt_ctf_trace
*trace
)
814 struct bt_ctf_field_type
*field_type
= NULL
;
820 bt_ctf_field_type_get(trace
->packet_header_type
);
821 field_type
= trace
->packet_header_type
;
826 int bt_ctf_trace_set_packet_header_type(struct bt_ctf_trace
*trace
,
827 struct bt_ctf_field_type
*packet_header_type
)
831 if (!trace
|| !packet_header_type
|| trace
->frozen
) {
836 /* packet_header_type must be a structure */
837 if (bt_ctf_field_type_get_type_id(packet_header_type
) !=
843 bt_ctf_field_type_get(packet_header_type
);
844 bt_ctf_field_type_put(trace
->packet_header_type
);
845 trace
->packet_header_type
= packet_header_type
;
850 void bt_ctf_trace_get(struct bt_ctf_trace
*trace
)
856 bt_ctf_ref_get(&trace
->ref_count
);
859 void bt_ctf_trace_put(struct bt_ctf_trace
*trace
)
865 bt_ctf_ref_put(&trace
->ref_count
, bt_ctf_trace_destroy
);
869 struct bt_ctf_field_type
*get_field_type(enum field_type_alias alias
)
871 unsigned int alignment
, size
;
872 struct bt_ctf_field_type
*field_type
;
874 if (alias
>= NR_FIELD_TYPE_ALIAS
) {
878 alignment
= field_type_aliases_alignments
[alias
];
879 size
= field_type_aliases_sizes
[alias
];
880 field_type
= bt_ctf_field_type_integer_create(size
);
881 bt_ctf_field_type_set_alignment(field_type
, alignment
);
886 void bt_ctf_trace_freeze(struct bt_ctf_trace
*trace
)
888 bt_ctf_attributes_freeze(trace
->environment
);
893 int init_trace_packet_header(struct bt_ctf_trace
*trace
)
896 struct bt_ctf_field
*magic
= NULL
, *uuid_array
= NULL
;
897 struct bt_ctf_field_type
*_uint32_t
=
898 get_field_type(FIELD_TYPE_ALIAS_UINT32_T
);
899 struct bt_ctf_field_type
*_uint8_t
=
900 get_field_type(FIELD_TYPE_ALIAS_UINT8_T
);
901 struct bt_ctf_field_type
*trace_packet_header_type
=
902 bt_ctf_field_type_structure_create();
903 struct bt_ctf_field_type
*uuid_array_type
=
904 bt_ctf_field_type_array_create(_uint8_t
, 16);
906 if (!trace_packet_header_type
|| !uuid_array_type
) {
911 ret
= bt_ctf_field_type_structure_add_field(trace_packet_header_type
,
917 ret
= bt_ctf_field_type_structure_add_field(trace_packet_header_type
,
918 uuid_array_type
, "uuid");
923 ret
= bt_ctf_field_type_structure_add_field(trace_packet_header_type
,
924 _uint32_t
, "stream_id");
929 ret
= bt_ctf_trace_set_packet_header_type(trace
,
930 trace_packet_header_type
);
935 bt_ctf_field_type_put(uuid_array_type
);
936 bt_ctf_field_type_put(_uint32_t
);
937 bt_ctf_field_type_put(_uint8_t
);
938 bt_ctf_field_put(magic
);
939 bt_ctf_field_put(uuid_array
);
940 bt_ctf_field_type_put(trace_packet_header_type
);