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>
38 #define DEFAULT_IDENTIFIER_SIZE 128
39 #define DEFAULT_METADATA_STRING_SIZE 4096
42 void environment_variable_destroy(struct environment_variable
*var
);
44 void bt_ctf_trace_destroy(struct bt_ctf_ref
*ref
);
46 int init_trace_packet_header(struct bt_ctf_trace
*trace
);
49 const unsigned int field_type_aliases_alignments
[] = {
50 [FIELD_TYPE_ALIAS_UINT5_T
] = 1,
51 [FIELD_TYPE_ALIAS_UINT8_T
... FIELD_TYPE_ALIAS_UINT16_T
] = 8,
52 [FIELD_TYPE_ALIAS_UINT27_T
] = 1,
53 [FIELD_TYPE_ALIAS_UINT32_T
... FIELD_TYPE_ALIAS_UINT64_T
] = 8,
57 const unsigned int field_type_aliases_sizes
[] = {
58 [FIELD_TYPE_ALIAS_UINT5_T
] = 5,
59 [FIELD_TYPE_ALIAS_UINT8_T
] = 8,
60 [FIELD_TYPE_ALIAS_UINT16_T
] = 16,
61 [FIELD_TYPE_ALIAS_UINT27_T
] = 27,
62 [FIELD_TYPE_ALIAS_UINT32_T
] = 32,
63 [FIELD_TYPE_ALIAS_UINT64_T
] = 64,
66 struct bt_ctf_trace
*bt_ctf_trace_create(void)
68 struct bt_ctf_trace
*trace
= NULL
;
70 trace
= g_new0(struct bt_ctf_trace
, 1);
75 bt_ctf_trace_set_byte_order(trace
, BT_CTF_BYTE_ORDER_NATIVE
);
76 bt_ctf_ref_init(&trace
->ref_count
);
77 trace
->environment
= g_ptr_array_new_with_free_func(
78 (GDestroyNotify
)environment_variable_destroy
);
79 trace
->clocks
= g_ptr_array_new_with_free_func(
80 (GDestroyNotify
)bt_ctf_clock_put
);
81 trace
->streams
= g_ptr_array_new_with_free_func(
82 (GDestroyNotify
)bt_ctf_stream_put
);
83 trace
->stream_classes
= g_ptr_array_new_with_free_func(
84 (GDestroyNotify
)bt_ctf_stream_class_put
);
85 if (!trace
->environment
|| !trace
->clocks
||
86 !trace
->stream_classes
|| !trace
->streams
) {
90 /* Generate a trace UUID */
91 uuid_generate(trace
->uuid
);
92 if (init_trace_packet_header(trace
)) {
99 bt_ctf_trace_destroy(&trace
->ref_count
);
105 void bt_ctf_trace_destroy(struct bt_ctf_ref
*ref
)
107 struct bt_ctf_trace
*trace
;
113 trace
= container_of(ref
, struct bt_ctf_trace
, ref_count
);
114 if (trace
->environment
) {
115 g_ptr_array_free(trace
->environment
, TRUE
);
119 g_ptr_array_free(trace
->clocks
, TRUE
);
122 if (trace
->streams
) {
123 g_ptr_array_free(trace
->streams
, TRUE
);
126 if (trace
->stream_classes
) {
127 g_ptr_array_free(trace
->stream_classes
, TRUE
);
130 bt_ctf_field_type_put(trace
->packet_header_type
);
134 struct bt_ctf_stream
*bt_ctf_trace_create_stream(struct bt_ctf_trace
*trace
,
135 struct bt_ctf_stream_class
*stream_class
)
138 int stream_class_found
= 0;
140 struct bt_ctf_stream
*stream
= NULL
;
142 if (!trace
|| !stream_class
) {
146 stream
= bt_ctf_stream_create(stream_class
, trace
);
151 for (i
= 0; i
< trace
->stream_classes
->len
; i
++) {
152 if (trace
->stream_classes
->pdata
[i
] == stream_class
) {
153 stream_class_found
= 1;
157 if (!stream_class_found
) {
158 ret
= bt_ctf_trace_add_stream_class(trace
, stream_class
);
164 bt_ctf_stream_get(stream
);
165 g_ptr_array_add(trace
->streams
, stream
);
169 bt_ctf_stream_put(stream
);
173 int bt_ctf_trace_add_environment_field(struct bt_ctf_trace
*trace
,
177 struct environment_variable
*var
= NULL
;
178 char *escaped_value
= NULL
;
181 if (!trace
|| !name
|| !value
|| bt_ctf_validate_identifier(name
)) {
186 if (strchr(name
, ' ')) {
191 var
= g_new0(struct environment_variable
, 1);
197 var
->type
= BT_ENVIRONMENT_FIELD_TYPE_STRING
;
198 escaped_value
= g_strescape(value
, NULL
);
199 if (!escaped_value
) {
204 var
->name
= g_string_new(name
);
205 var
->value
.string
= g_string_new(escaped_value
);
206 g_free(escaped_value
);
207 if (!var
->name
|| !var
->value
.string
) {
212 g_ptr_array_add(trace
->environment
, var
);
216 if (var
&& var
->name
) {
217 g_string_free(var
->name
, TRUE
);
220 if (var
&& var
->value
.string
) {
221 g_string_free(var
->value
.string
, TRUE
);
228 int bt_ctf_trace_add_environment_field_integer(struct bt_ctf_trace
*trace
,
232 struct environment_variable
*var
= NULL
;
235 if (!trace
|| !name
) {
240 var
= g_new0(struct environment_variable
, 1);
246 var
->type
= BT_ENVIRONMENT_FIELD_TYPE_INTEGER
;
247 var
->name
= g_string_new(name
);
248 var
->value
.integer
= value
;
254 g_ptr_array_add(trace
->environment
, var
);
258 if (var
&& var
->name
) {
259 g_string_free(var
->name
, TRUE
);
266 int bt_ctf_trace_get_environment_field_count(struct bt_ctf_trace
*trace
)
275 ret
= trace
->environment
->len
;
280 enum bt_environment_field_type
281 bt_ctf_trace_get_environment_field_type(struct bt_ctf_trace
*trace
, int index
)
283 struct environment_variable
*var
;
284 enum bt_environment_field_type type
= BT_ENVIRONMENT_FIELD_TYPE_UNKNOWN
;
286 if (!trace
|| index
< 0 || index
>= trace
->environment
->len
) {
290 var
= g_ptr_array_index(trace
->environment
, index
);
297 bt_ctf_trace_get_environment_field_name(struct bt_ctf_trace
*trace
,
300 struct environment_variable
*var
;
301 const char *ret
= NULL
;
303 if (!trace
|| index
< 0 || index
>= trace
->environment
->len
) {
307 var
= g_ptr_array_index(trace
->environment
, index
);
308 ret
= var
->name
->str
;
314 bt_ctf_trace_get_environment_field_value_string(struct bt_ctf_trace
*trace
,
317 struct environment_variable
*var
;
318 const char *ret
= NULL
;
320 if (!trace
|| index
< 0 || index
>= trace
->environment
->len
) {
324 var
= g_ptr_array_index(trace
->environment
, index
);
325 if (var
->type
!= BT_ENVIRONMENT_FIELD_TYPE_STRING
) {
328 ret
= var
->value
.string
->str
;
334 bt_ctf_trace_get_environment_field_value_integer(struct bt_ctf_trace
*trace
,
335 int index
, int64_t *value
)
337 struct environment_variable
*var
;
340 if (!trace
|| !value
|| index
< 0 || index
>= trace
->environment
->len
) {
345 var
= g_ptr_array_index(trace
->environment
, index
);
346 if (var
->type
!= BT_ENVIRONMENT_FIELD_TYPE_INTEGER
) {
350 *value
= var
->value
.integer
;
355 int bt_ctf_trace_add_clock(struct bt_ctf_trace
*trace
,
356 struct bt_ctf_clock
*clock
)
359 struct search_query query
= { .value
= clock
, .found
= 0 };
361 if (!trace
|| !clock
) {
366 /* Check for duplicate clocks */
367 g_ptr_array_foreach(trace
->clocks
, value_exists
, &query
);
373 bt_ctf_clock_get(clock
);
374 g_ptr_array_add(trace
->clocks
, clock
);
379 int bt_ctf_trace_get_clock_count(struct bt_ctf_trace
*trace
)
387 ret
= trace
->clocks
->len
;
392 struct bt_ctf_clock
*bt_ctf_trace_get_clock(struct bt_ctf_trace
*trace
,
395 struct bt_ctf_clock
*clock
= NULL
;
397 if (!trace
|| index
< 0 || index
>= trace
->clocks
->len
) {
401 clock
= g_ptr_array_index(trace
->clocks
, index
);
402 bt_ctf_clock_get(clock
);
407 int bt_ctf_trace_add_stream_class(struct bt_ctf_trace
*trace
,
408 struct bt_ctf_stream_class
*stream_class
)
413 if (!trace
|| !stream_class
) {
418 for (i
= 0; i
< trace
->stream_classes
->len
; i
++) {
419 if (trace
->stream_classes
->pdata
[i
] == stream_class
) {
425 stream_id
= bt_ctf_stream_class_get_id(stream_class
);
427 stream_id
= trace
->next_stream_id
++;
429 /* Try to assign a new stream id */
430 for (i
= 0; i
< trace
->stream_classes
->len
; i
++) {
431 if (stream_id
== bt_ctf_stream_class_get_id(
432 trace
->stream_classes
->pdata
[i
])) {
433 /* Duplicate stream id found */
439 if (_bt_ctf_stream_class_set_id(stream_class
,
441 /* TODO Should retry with a different stream id */
447 bt_ctf_stream_class_get(stream_class
);
448 g_ptr_array_add(trace
->stream_classes
, stream_class
);
451 * Freeze the trace and its packet header.
453 * All field type byte orders set as "native" byte ordering can now be
454 * safely set to trace's own endianness, including the stream class'.
456 bt_ctf_field_type_set_native_byte_order(trace
->packet_header_type
,
458 ret
= bt_ctf_stream_class_set_byte_order(stream_class
,
459 trace
->byte_order
== LITTLE_ENDIAN
?
460 BT_CTF_BYTE_ORDER_LITTLE_ENDIAN
: BT_CTF_BYTE_ORDER_BIG_ENDIAN
);
464 bt_ctf_stream_class_freeze(stream_class
);
471 int bt_ctf_trace_get_stream_class_count(struct bt_ctf_trace
*trace
)
480 ret
= trace
->stream_classes
->len
;
485 struct bt_ctf_stream_class
*bt_ctf_trace_get_stream_class(
486 struct bt_ctf_trace
*trace
, int index
)
488 struct bt_ctf_stream_class
*stream_class
= NULL
;
490 if (!trace
|| index
< 0 || index
>= trace
->stream_classes
->len
) {
494 stream_class
= g_ptr_array_index(trace
->stream_classes
, index
);
495 bt_ctf_stream_class_get(stream_class
);
501 const char *get_byte_order_string(int byte_order
)
505 switch (byte_order
) {
521 int append_trace_metadata(struct bt_ctf_trace
*trace
,
522 struct metadata_context
*context
)
524 unsigned char *uuid
= trace
->uuid
;
527 g_string_append(context
->string
, "trace {\n");
529 g_string_append(context
->string
, "\tmajor = 1;\n");
530 g_string_append(context
->string
, "\tminor = 8;\n");
532 g_string_append_printf(context
->string
,
533 "\tuuid = \"%02x%02x%02x%02x-%02x%02x-%02x%02x-%02x%02x-%02x%02x%02x%02x%02x%02x\";\n",
534 uuid
[0], uuid
[1], uuid
[2], uuid
[3],
535 uuid
[4], uuid
[5], uuid
[6], uuid
[7],
536 uuid
[8], uuid
[9], uuid
[10], uuid
[11],
537 uuid
[12], uuid
[13], uuid
[14], uuid
[15]);
538 g_string_append_printf(context
->string
, "\tbyte_order = %s;\n",
539 get_byte_order_string(trace
->byte_order
));
541 g_string_append(context
->string
, "\tpacket.header := ");
542 context
->current_indentation_level
++;
543 g_string_assign(context
->field_name
, "");
544 ret
= bt_ctf_field_type_serialize(trace
->packet_header_type
,
549 context
->current_indentation_level
--;
551 g_string_append(context
->string
, ";\n};\n\n");
557 void append_env_field_metadata(struct environment_variable
*var
,
558 struct metadata_context
*context
)
561 case BT_ENVIRONMENT_FIELD_TYPE_STRING
:
562 g_string_append_printf(context
->string
, "\t%s = \"%s\";\n",
563 var
->name
->str
, var
->value
.string
->str
);
565 case BT_ENVIRONMENT_FIELD_TYPE_INTEGER
:
566 g_string_append_printf(context
->string
, "\t%s = %" PRId64
";\n",
567 var
->name
->str
, var
->value
.integer
);
575 void append_env_metadata(struct bt_ctf_trace
*trace
,
576 struct metadata_context
*context
)
578 if (trace
->environment
->len
== 0) {
582 g_string_append(context
->string
, "env {\n");
583 g_ptr_array_foreach(trace
->environment
,
584 (GFunc
)append_env_field_metadata
, context
);
585 g_string_append(context
->string
, "};\n\n");
588 char *bt_ctf_trace_get_metadata_string(struct bt_ctf_trace
*trace
)
590 char *metadata
= NULL
;
591 struct metadata_context
*context
= NULL
;
599 context
= g_new0(struct metadata_context
, 1);
604 context
->field_name
= g_string_sized_new(DEFAULT_IDENTIFIER_SIZE
);
605 context
->string
= g_string_sized_new(DEFAULT_METADATA_STRING_SIZE
);
606 g_string_append(context
->string
, "/* CTF 1.8 */\n\n");
607 if (append_trace_metadata(trace
, context
)) {
610 append_env_metadata(trace
, context
);
611 g_ptr_array_foreach(trace
->clocks
,
612 (GFunc
)bt_ctf_clock_serialize
, context
);
614 for (i
= 0; i
< trace
->stream_classes
->len
; i
++) {
615 err
= bt_ctf_stream_class_serialize(
616 trace
->stream_classes
->pdata
[i
], context
);
622 metadata
= context
->string
->str
;
624 g_string_free(context
->string
, err
? TRUE
: FALSE
);
625 g_string_free(context
->field_name
, TRUE
);
631 enum bt_ctf_byte_order
bt_ctf_trace_get_byte_order(struct bt_ctf_trace
*trace
)
633 enum bt_ctf_byte_order ret
= BT_CTF_BYTE_ORDER_UNKNOWN
;
639 switch (trace
->byte_order
) {
641 ret
= BT_CTF_BYTE_ORDER_BIG_ENDIAN
;
644 ret
= BT_CTF_BYTE_ORDER_LITTLE_ENDIAN
;
653 int bt_ctf_trace_set_byte_order(struct bt_ctf_trace
*trace
,
654 enum bt_ctf_byte_order byte_order
)
657 int internal_byte_order
;
659 if (!trace
|| trace
->frozen
) {
664 switch (byte_order
) {
665 case BT_CTF_BYTE_ORDER_NATIVE
:
667 * This doesn't make sense since the CTF specification defines
668 * the "native" byte order as "the byte order described in the
669 * trace description". However, this behavior had been
670 * implemented as part of v1.2 and is kept to maintain
673 * This may be changed on a major version bump only.
675 internal_byte_order
= (G_BYTE_ORDER
== G_LITTLE_ENDIAN
) ?
676 LITTLE_ENDIAN
: BIG_ENDIAN
;
678 case BT_CTF_BYTE_ORDER_LITTLE_ENDIAN
:
679 internal_byte_order
= LITTLE_ENDIAN
;
681 case BT_CTF_BYTE_ORDER_BIG_ENDIAN
:
682 case BT_CTF_BYTE_ORDER_NETWORK
:
683 internal_byte_order
= BIG_ENDIAN
;
690 trace
->byte_order
= internal_byte_order
;
695 struct bt_ctf_field_type
*bt_ctf_trace_get_packet_header_type(
696 struct bt_ctf_trace
*trace
)
698 struct bt_ctf_field_type
*field_type
= NULL
;
704 bt_ctf_field_type_get(trace
->packet_header_type
);
705 field_type
= trace
->packet_header_type
;
710 int bt_ctf_trace_set_packet_header_type(struct bt_ctf_trace
*trace
,
711 struct bt_ctf_field_type
*packet_header_type
)
715 if (!trace
|| !packet_header_type
|| trace
->frozen
) {
720 /* packet_header_type must be a structure */
721 if (bt_ctf_field_type_get_type_id(packet_header_type
) !=
727 bt_ctf_field_type_get(packet_header_type
);
728 bt_ctf_field_type_put(trace
->packet_header_type
);
729 trace
->packet_header_type
= packet_header_type
;
734 void bt_ctf_trace_get(struct bt_ctf_trace
*trace
)
740 bt_ctf_ref_get(&trace
->ref_count
);
743 void bt_ctf_trace_put(struct bt_ctf_trace
*trace
)
749 bt_ctf_ref_put(&trace
->ref_count
, bt_ctf_trace_destroy
);
753 struct bt_ctf_field_type
*get_field_type(enum field_type_alias alias
)
755 unsigned int alignment
, size
;
756 struct bt_ctf_field_type
*field_type
;
758 if (alias
>= NR_FIELD_TYPE_ALIAS
) {
762 alignment
= field_type_aliases_alignments
[alias
];
763 size
= field_type_aliases_sizes
[alias
];
764 field_type
= bt_ctf_field_type_integer_create(size
);
765 bt_ctf_field_type_set_alignment(field_type
, alignment
);
770 int init_trace_packet_header(struct bt_ctf_trace
*trace
)
773 struct bt_ctf_field
*magic
= NULL
, *uuid_array
= NULL
;
774 struct bt_ctf_field_type
*_uint32_t
=
775 get_field_type(FIELD_TYPE_ALIAS_UINT32_T
);
776 struct bt_ctf_field_type
*_uint8_t
=
777 get_field_type(FIELD_TYPE_ALIAS_UINT8_T
);
778 struct bt_ctf_field_type
*trace_packet_header_type
=
779 bt_ctf_field_type_structure_create();
780 struct bt_ctf_field_type
*uuid_array_type
=
781 bt_ctf_field_type_array_create(_uint8_t
, 16);
783 if (!trace_packet_header_type
|| !uuid_array_type
) {
788 ret
= bt_ctf_field_type_structure_add_field(trace_packet_header_type
,
794 ret
= bt_ctf_field_type_structure_add_field(trace_packet_header_type
,
795 uuid_array_type
, "uuid");
800 ret
= bt_ctf_field_type_structure_add_field(trace_packet_header_type
,
801 _uint32_t
, "stream_id");
806 ret
= bt_ctf_trace_set_packet_header_type(trace
,
807 trace_packet_header_type
);
812 bt_ctf_field_type_put(uuid_array_type
);
813 bt_ctf_field_type_put(_uint32_t
);
814 bt_ctf_field_type_put(_uint8_t
);
815 bt_ctf_field_put(magic
);
816 bt_ctf_field_put(uuid_array
);
817 bt_ctf_field_type_put(trace_packet_header_type
);
823 void environment_variable_destroy(struct environment_variable
*var
)
825 g_string_free(var
->name
, TRUE
);
826 if (var
->type
== BT_ENVIRONMENT_FIELD_TYPE_STRING
) {
827 g_string_free(var
->value
.string
, TRUE
);