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/utils.h>
36 #include <babeltrace/compiler.h>
37 #include <babeltrace/objects.h>
39 #define DEFAULT_IDENTIFIER_SIZE 128
40 #define DEFAULT_METADATA_STRING_SIZE 4096
43 void bt_ctf_trace_destroy(struct bt_ctf_ref
*ref
);
45 int init_trace_packet_header(struct bt_ctf_trace
*trace
);
48 const unsigned int field_type_aliases_alignments
[] = {
49 [FIELD_TYPE_ALIAS_UINT5_T
] = 1,
50 [FIELD_TYPE_ALIAS_UINT8_T
... FIELD_TYPE_ALIAS_UINT16_T
] = 8,
51 [FIELD_TYPE_ALIAS_UINT27_T
] = 1,
52 [FIELD_TYPE_ALIAS_UINT32_T
... FIELD_TYPE_ALIAS_UINT64_T
] = 8,
56 const unsigned int field_type_aliases_sizes
[] = {
57 [FIELD_TYPE_ALIAS_UINT5_T
] = 5,
58 [FIELD_TYPE_ALIAS_UINT8_T
] = 8,
59 [FIELD_TYPE_ALIAS_UINT16_T
] = 16,
60 [FIELD_TYPE_ALIAS_UINT27_T
] = 27,
61 [FIELD_TYPE_ALIAS_UINT32_T
] = 32,
62 [FIELD_TYPE_ALIAS_UINT64_T
] = 64,
65 struct bt_ctf_trace
*bt_ctf_trace_create(void)
67 struct bt_ctf_trace
*trace
= NULL
;
69 trace
= g_new0(struct bt_ctf_trace
, 1);
74 bt_ctf_trace_set_byte_order(trace
, BT_CTF_BYTE_ORDER_NATIVE
);
75 bt_ctf_ref_init(&trace
->ref_count
);
76 trace
->clocks
= g_ptr_array_new_with_free_func(
77 (GDestroyNotify
)bt_ctf_clock_put
);
78 trace
->streams
= g_ptr_array_new_with_free_func(
79 (GDestroyNotify
)bt_ctf_stream_put
);
80 trace
->stream_classes
= g_ptr_array_new_with_free_func(
81 (GDestroyNotify
)bt_ctf_stream_class_put
);
82 if (!trace
->clocks
|| !trace
->stream_classes
|| !trace
->streams
) {
86 /* Generate a trace UUID */
87 uuid_generate(trace
->uuid
);
88 if (init_trace_packet_header(trace
)) {
92 /* Create the environment array object */
93 trace
->environment
= bt_ctf_attributes_create();
94 if (!trace
->environment
) {
101 bt_ctf_trace_destroy(&trace
->ref_count
);
107 void bt_ctf_trace_destroy(struct bt_ctf_ref
*ref
)
109 struct bt_ctf_trace
*trace
;
115 trace
= container_of(ref
, struct bt_ctf_trace
, ref_count
);
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_ctf_field_type_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 stream
= bt_ctf_stream_create(stream_class
, trace
);
153 for (i
= 0; i
< trace
->stream_classes
->len
; i
++) {
154 if (trace
->stream_classes
->pdata
[i
] == stream_class
) {
155 stream_class_found
= 1;
159 if (!stream_class_found
) {
160 ret
= bt_ctf_trace_add_stream_class(trace
, stream_class
);
166 bt_ctf_stream_get(stream
);
167 g_ptr_array_add(trace
->streams
, stream
);
171 bt_ctf_stream_put(stream
);
175 int bt_ctf_trace_set_environment_field(struct bt_ctf_trace
*trace
,
176 const char *name
, struct bt_object
*value
)
180 if (!trace
|| trace
->frozen
|| !name
|| !value
||
181 bt_ctf_validate_identifier(name
) ||
182 !(bt_object_is_integer(value
) || bt_object_is_string(value
))) {
187 if (strchr(name
, ' ')) {
192 ret
= bt_ctf_attributes_set_field_value(trace
->environment
, name
,
199 int bt_ctf_trace_set_environment_field_string(struct bt_ctf_trace
*trace
,
200 const char *name
, const char *value
)
203 struct bt_object
*env_value_string_obj
= NULL
;
205 if (!trace
|| !name
|| !value
) {
210 env_value_string_obj
= bt_object_string_create_init(value
);
212 if (!env_value_string_obj
) {
217 ret
= bt_ctf_trace_set_environment_field(trace
, name
,
218 env_value_string_obj
);
221 BT_OBJECT_PUT(env_value_string_obj
);
226 int bt_ctf_trace_set_environment_field_integer(struct bt_ctf_trace
*trace
,
227 const char *name
, int64_t value
)
230 struct bt_object
*env_value_integer_obj
= NULL
;
232 if (!trace
|| !name
) {
237 env_value_integer_obj
= bt_object_integer_create_init(value
);
238 if (!env_value_integer_obj
) {
243 ret
= bt_ctf_trace_set_environment_field(trace
, name
,
244 env_value_integer_obj
);
247 BT_OBJECT_PUT(env_value_integer_obj
);
252 int bt_ctf_trace_get_environment_field_count(struct bt_ctf_trace
*trace
)
261 ret
= bt_ctf_attributes_get_count(trace
->environment
);
268 bt_ctf_trace_get_environment_field_name(struct bt_ctf_trace
*trace
,
271 const char *ret
= NULL
;
277 ret
= bt_ctf_attributes_get_field_name(trace
->environment
, index
);
283 struct bt_object
*bt_ctf_trace_get_environment_field_value(
284 struct bt_ctf_trace
*trace
, int index
)
286 struct bt_object
*ret
= NULL
;
292 ret
= bt_ctf_attributes_get_field_value(trace
->environment
, index
);
298 struct bt_object
*bt_ctf_trace_get_environment_field_value_by_name(
299 struct bt_ctf_trace
*trace
, const char *name
)
301 struct bt_object
*ret
= NULL
;
303 if (!trace
|| !name
) {
307 ret
= bt_ctf_attributes_get_field_value_by_name(trace
->environment
,
314 int bt_ctf_trace_add_clock(struct bt_ctf_trace
*trace
,
315 struct bt_ctf_clock
*clock
)
318 struct search_query query
= { .value
= clock
, .found
= 0 };
320 if (!trace
|| !clock
) {
325 /* Check for duplicate clocks */
326 g_ptr_array_foreach(trace
->clocks
, value_exists
, &query
);
332 bt_ctf_clock_get(clock
);
333 g_ptr_array_add(trace
->clocks
, clock
);
338 int bt_ctf_trace_get_clock_count(struct bt_ctf_trace
*trace
)
346 ret
= trace
->clocks
->len
;
351 struct bt_ctf_clock
*bt_ctf_trace_get_clock(struct bt_ctf_trace
*trace
,
354 struct bt_ctf_clock
*clock
= NULL
;
356 if (!trace
|| index
< 0 || index
>= trace
->clocks
->len
) {
360 clock
= g_ptr_array_index(trace
->clocks
, index
);
361 bt_ctf_clock_get(clock
);
366 int bt_ctf_trace_add_stream_class(struct bt_ctf_trace
*trace
,
367 struct bt_ctf_stream_class
*stream_class
)
372 if (!trace
|| !stream_class
) {
377 for (i
= 0; i
< trace
->stream_classes
->len
; i
++) {
378 if (trace
->stream_classes
->pdata
[i
] == stream_class
) {
384 stream_id
= bt_ctf_stream_class_get_id(stream_class
);
386 stream_id
= trace
->next_stream_id
++;
388 /* Try to assign a new stream id */
389 for (i
= 0; i
< trace
->stream_classes
->len
; i
++) {
390 if (stream_id
== bt_ctf_stream_class_get_id(
391 trace
->stream_classes
->pdata
[i
])) {
392 /* Duplicate stream id found */
398 if (_bt_ctf_stream_class_set_id(stream_class
,
400 /* TODO Should retry with a different stream id */
406 bt_ctf_stream_class_get(stream_class
);
407 g_ptr_array_add(trace
->stream_classes
, stream_class
);
410 * Freeze the trace and its packet header.
412 * All field type byte orders set as "native" byte ordering can now be
413 * safely set to trace's own endianness, including the stream class'.
415 bt_ctf_field_type_set_native_byte_order(trace
->packet_header_type
,
417 ret
= bt_ctf_stream_class_set_byte_order(stream_class
,
418 trace
->byte_order
== LITTLE_ENDIAN
?
419 BT_CTF_BYTE_ORDER_LITTLE_ENDIAN
: BT_CTF_BYTE_ORDER_BIG_ENDIAN
);
423 bt_ctf_stream_class_freeze(stream_class
);
425 bt_ctf_attributes_freeze(trace
->environment
);
431 int bt_ctf_trace_get_stream_class_count(struct bt_ctf_trace
*trace
)
440 ret
= trace
->stream_classes
->len
;
445 struct bt_ctf_stream_class
*bt_ctf_trace_get_stream_class(
446 struct bt_ctf_trace
*trace
, int index
)
448 struct bt_ctf_stream_class
*stream_class
= NULL
;
450 if (!trace
|| index
< 0 || index
>= trace
->stream_classes
->len
) {
454 stream_class
= g_ptr_array_index(trace
->stream_classes
, index
);
455 bt_ctf_stream_class_get(stream_class
);
460 struct bt_ctf_clock
*bt_ctf_trace_get_clock_by_name(
461 struct bt_ctf_trace
*trace
, const char *name
)
464 struct bt_ctf_clock
*clock
= NULL
;
466 if (!trace
|| !name
) {
470 for (i
= 0; i
< trace
->clocks
->len
; ++i
) {
471 struct bt_ctf_clock
*cur_clk
=
472 g_ptr_array_index(trace
->clocks
, i
);
473 const char *cur_clk_name
= bt_ctf_clock_get_name(cur_clk
);
479 if (!strcmp(cur_clk_name
, name
)) {
481 bt_ctf_clock_get(clock
);
491 const char *get_byte_order_string(int byte_order
)
495 switch (byte_order
) {
511 int append_trace_metadata(struct bt_ctf_trace
*trace
,
512 struct metadata_context
*context
)
514 unsigned char *uuid
= trace
->uuid
;
517 g_string_append(context
->string
, "trace {\n");
519 g_string_append(context
->string
, "\tmajor = 1;\n");
520 g_string_append(context
->string
, "\tminor = 8;\n");
522 g_string_append_printf(context
->string
,
523 "\tuuid = \"%02x%02x%02x%02x-%02x%02x-%02x%02x-%02x%02x-%02x%02x%02x%02x%02x%02x\";\n",
524 uuid
[0], uuid
[1], uuid
[2], uuid
[3],
525 uuid
[4], uuid
[5], uuid
[6], uuid
[7],
526 uuid
[8], uuid
[9], uuid
[10], uuid
[11],
527 uuid
[12], uuid
[13], uuid
[14], uuid
[15]);
528 g_string_append_printf(context
->string
, "\tbyte_order = %s;\n",
529 get_byte_order_string(trace
->byte_order
));
531 g_string_append(context
->string
, "\tpacket.header := ");
532 context
->current_indentation_level
++;
533 g_string_assign(context
->field_name
, "");
534 ret
= bt_ctf_field_type_serialize(trace
->packet_header_type
,
539 context
->current_indentation_level
--;
541 g_string_append(context
->string
, ";\n};\n\n");
547 void append_env_metadata(struct bt_ctf_trace
*trace
,
548 struct metadata_context
*context
)
553 env_size
= bt_ctf_attributes_get_count(trace
->environment
);
559 g_string_append(context
->string
, "env {\n");
561 for (i
= 0; i
< env_size
; ++i
) {
562 struct bt_object
*env_field_value_obj
= NULL
;
563 const char *entry_name
;
565 entry_name
= bt_ctf_attributes_get_field_name(
566 trace
->environment
, i
);
567 env_field_value_obj
= bt_ctf_attributes_get_field_value(
568 trace
->environment
, i
);
570 if (!entry_name
|| !env_field_value_obj
) {
574 switch (bt_object_get_type(env_field_value_obj
)) {
575 case BT_OBJECT_TYPE_INTEGER
:
580 ret
= bt_object_integer_get(env_field_value_obj
,
587 g_string_append_printf(context
->string
,
588 "\t%s = %" PRId64
";\n", entry_name
,
592 case BT_OBJECT_TYPE_STRING
:
595 const char *str_value
;
596 char *escaped_str
= NULL
;
598 ret
= bt_object_string_get(env_field_value_obj
,
605 escaped_str
= g_strescape(str_value
, NULL
);
611 g_string_append_printf(context
->string
,
612 "\t%s = \"%s\";\n", entry_name
, escaped_str
);
622 BT_OBJECT_PUT(env_field_value_obj
);
625 g_string_append(context
->string
, "};\n\n");
628 char *bt_ctf_trace_get_metadata_string(struct bt_ctf_trace
*trace
)
630 char *metadata
= NULL
;
631 struct metadata_context
*context
= NULL
;
639 context
= g_new0(struct metadata_context
, 1);
644 context
->field_name
= g_string_sized_new(DEFAULT_IDENTIFIER_SIZE
);
645 context
->string
= g_string_sized_new(DEFAULT_METADATA_STRING_SIZE
);
646 g_string_append(context
->string
, "/* CTF 1.8 */\n\n");
647 if (append_trace_metadata(trace
, context
)) {
650 append_env_metadata(trace
, context
);
651 g_ptr_array_foreach(trace
->clocks
,
652 (GFunc
)bt_ctf_clock_serialize
, context
);
654 for (i
= 0; i
< trace
->stream_classes
->len
; i
++) {
655 err
= bt_ctf_stream_class_serialize(
656 trace
->stream_classes
->pdata
[i
], context
);
662 metadata
= context
->string
->str
;
664 g_string_free(context
->string
, err
? TRUE
: FALSE
);
665 g_string_free(context
->field_name
, TRUE
);
671 enum bt_ctf_byte_order
bt_ctf_trace_get_byte_order(struct bt_ctf_trace
*trace
)
673 enum bt_ctf_byte_order ret
= BT_CTF_BYTE_ORDER_UNKNOWN
;
679 switch (trace
->byte_order
) {
681 ret
= BT_CTF_BYTE_ORDER_BIG_ENDIAN
;
684 ret
= BT_CTF_BYTE_ORDER_LITTLE_ENDIAN
;
693 int bt_ctf_trace_set_byte_order(struct bt_ctf_trace
*trace
,
694 enum bt_ctf_byte_order byte_order
)
697 int internal_byte_order
;
699 if (!trace
|| trace
->frozen
) {
704 switch (byte_order
) {
705 case BT_CTF_BYTE_ORDER_NATIVE
:
707 * This doesn't make sense since the CTF specification defines
708 * the "native" byte order as "the byte order described in the
709 * trace description". However, this behavior had been
710 * implemented as part of v1.2 and is kept to maintain
713 * This may be changed on a major version bump only.
715 internal_byte_order
= (G_BYTE_ORDER
== G_LITTLE_ENDIAN
) ?
716 LITTLE_ENDIAN
: BIG_ENDIAN
;
718 case BT_CTF_BYTE_ORDER_LITTLE_ENDIAN
:
719 internal_byte_order
= LITTLE_ENDIAN
;
721 case BT_CTF_BYTE_ORDER_BIG_ENDIAN
:
722 case BT_CTF_BYTE_ORDER_NETWORK
:
723 internal_byte_order
= BIG_ENDIAN
;
730 trace
->byte_order
= internal_byte_order
;
735 struct bt_ctf_field_type
*bt_ctf_trace_get_packet_header_type(
736 struct bt_ctf_trace
*trace
)
738 struct bt_ctf_field_type
*field_type
= NULL
;
744 bt_ctf_field_type_get(trace
->packet_header_type
);
745 field_type
= trace
->packet_header_type
;
750 int bt_ctf_trace_set_packet_header_type(struct bt_ctf_trace
*trace
,
751 struct bt_ctf_field_type
*packet_header_type
)
755 if (!trace
|| !packet_header_type
|| trace
->frozen
) {
760 /* packet_header_type must be a structure */
761 if (bt_ctf_field_type_get_type_id(packet_header_type
) !=
767 bt_ctf_field_type_get(packet_header_type
);
768 bt_ctf_field_type_put(trace
->packet_header_type
);
769 trace
->packet_header_type
= packet_header_type
;
774 void bt_ctf_trace_get(struct bt_ctf_trace
*trace
)
780 bt_ctf_ref_get(&trace
->ref_count
);
783 void bt_ctf_trace_put(struct bt_ctf_trace
*trace
)
789 bt_ctf_ref_put(&trace
->ref_count
, bt_ctf_trace_destroy
);
793 struct bt_ctf_field_type
*get_field_type(enum field_type_alias alias
)
795 unsigned int alignment
, size
;
796 struct bt_ctf_field_type
*field_type
;
798 if (alias
>= NR_FIELD_TYPE_ALIAS
) {
802 alignment
= field_type_aliases_alignments
[alias
];
803 size
= field_type_aliases_sizes
[alias
];
804 field_type
= bt_ctf_field_type_integer_create(size
);
805 bt_ctf_field_type_set_alignment(field_type
, alignment
);
810 int init_trace_packet_header(struct bt_ctf_trace
*trace
)
813 struct bt_ctf_field
*magic
= NULL
, *uuid_array
= NULL
;
814 struct bt_ctf_field_type
*_uint32_t
=
815 get_field_type(FIELD_TYPE_ALIAS_UINT32_T
);
816 struct bt_ctf_field_type
*_uint8_t
=
817 get_field_type(FIELD_TYPE_ALIAS_UINT8_T
);
818 struct bt_ctf_field_type
*trace_packet_header_type
=
819 bt_ctf_field_type_structure_create();
820 struct bt_ctf_field_type
*uuid_array_type
=
821 bt_ctf_field_type_array_create(_uint8_t
, 16);
823 if (!trace_packet_header_type
|| !uuid_array_type
) {
828 ret
= bt_ctf_field_type_structure_add_field(trace_packet_header_type
,
834 ret
= bt_ctf_field_type_structure_add_field(trace_packet_header_type
,
835 uuid_array_type
, "uuid");
840 ret
= bt_ctf_field_type_structure_add_field(trace_packet_header_type
,
841 _uint32_t
, "stream_id");
846 ret
= bt_ctf_trace_set_packet_header_type(trace
,
847 trace_packet_header_type
);
852 bt_ctf_field_type_put(uuid_array_type
);
853 bt_ctf_field_type_put(_uint32_t
);
854 bt_ctf_field_type_put(_uint8_t
);
855 bt_ctf_field_put(magic
);
856 bt_ctf_field_put(uuid_array
);
857 bt_ctf_field_type_put(trace_packet_header_type
);