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 int64_t stream_id
= bt_ctf_stream_class_get_id(stream_class
);
161 /* Try to assign a new stream id */
162 if (_bt_ctf_stream_class_set_id(stream
->stream_class
,
163 trace
->next_stream_id
++)) {
168 for (i
= 0; i
< trace
->stream_classes
->len
; i
++) {
169 if (stream_id
== bt_ctf_stream_class_get_id(
170 trace
->stream_classes
->pdata
[i
])) {
171 /* Duplicate stream id found */
175 bt_ctf_stream_class_get(stream
->stream_class
);
176 g_ptr_array_add(trace
->stream_classes
, stream
->stream_class
);
179 bt_ctf_stream_get(stream
);
180 g_ptr_array_add(trace
->streams
, stream
);
183 * Freeze the trace and its packet header.
185 * All field type byte orders set as "native" byte ordering can now be
186 * safely set to trace's own endianness, including the stream class'.
188 bt_ctf_field_type_set_native_byte_order(trace
->packet_header_type
,
190 ret
= bt_ctf_stream_class_set_byte_order(stream_class
,
191 trace
->byte_order
== LITTLE_ENDIAN
?
192 BT_CTF_BYTE_ORDER_LITTLE_ENDIAN
: BT_CTF_BYTE_ORDER_BIG_ENDIAN
);
197 bt_ctf_stream_class_freeze(stream_class
);
201 bt_ctf_stream_put(stream
);
205 int bt_ctf_trace_add_environment_field(struct bt_ctf_trace
*trace
,
209 struct environment_variable
*var
= NULL
;
210 char *escaped_value
= NULL
;
213 if (!trace
|| !name
|| !value
|| bt_ctf_validate_identifier(name
)) {
218 if (strchr(name
, ' ')) {
223 var
= g_new0(struct environment_variable
, 1);
229 var
->type
= BT_ENVIRONMENT_FIELD_TYPE_STRING
;
230 escaped_value
= g_strescape(value
, NULL
);
231 if (!escaped_value
) {
236 var
->name
= g_string_new(name
);
237 var
->value
.string
= g_string_new(escaped_value
);
238 g_free(escaped_value
);
239 if (!var
->name
|| !var
->value
.string
) {
244 g_ptr_array_add(trace
->environment
, var
);
248 if (var
&& var
->name
) {
249 g_string_free(var
->name
, TRUE
);
252 if (var
&& var
->value
.string
) {
253 g_string_free(var
->value
.string
, TRUE
);
260 int bt_ctf_trace_add_environment_field_integer(struct bt_ctf_trace
*trace
,
264 struct environment_variable
*var
= NULL
;
267 if (!trace
|| !name
) {
272 var
= g_new0(struct environment_variable
, 1);
278 var
->type
= BT_ENVIRONMENT_FIELD_TYPE_INTEGER
;
279 var
->name
= g_string_new(name
);
280 var
->value
.integer
= value
;
286 g_ptr_array_add(trace
->environment
, var
);
290 if (var
&& var
->name
) {
291 g_string_free(var
->name
, TRUE
);
298 int bt_ctf_trace_get_environment_field_count(struct bt_ctf_trace
*trace
)
307 ret
= trace
->environment
->len
;
312 enum bt_environment_field_type
313 bt_ctf_trace_get_environment_field_type(struct bt_ctf_trace
*trace
, int index
)
315 struct environment_variable
*var
;
316 enum bt_environment_field_type type
= BT_ENVIRONMENT_FIELD_TYPE_UNKNOWN
;
318 if (!trace
|| index
< 0 || index
>= trace
->environment
->len
) {
322 var
= g_ptr_array_index(trace
->environment
, index
);
329 bt_ctf_trace_get_environment_field_name(struct bt_ctf_trace
*trace
,
332 struct environment_variable
*var
;
333 const char *ret
= NULL
;
335 if (!trace
|| index
< 0 || index
>= trace
->environment
->len
) {
339 var
= g_ptr_array_index(trace
->environment
, index
);
340 ret
= var
->name
->str
;
346 bt_ctf_trace_get_environment_field_value_string(struct bt_ctf_trace
*trace
,
349 struct environment_variable
*var
;
350 const char *ret
= NULL
;
352 if (!trace
|| index
< 0 || index
>= trace
->environment
->len
) {
356 var
= g_ptr_array_index(trace
->environment
, index
);
357 if (var
->type
!= BT_ENVIRONMENT_FIELD_TYPE_STRING
) {
360 ret
= var
->value
.string
->str
;
366 bt_ctf_trace_get_environment_field_value_integer(struct bt_ctf_trace
*trace
,
367 int index
, int64_t *value
)
369 struct environment_variable
*var
;
372 if (!trace
|| !value
|| index
< 0 || index
>= trace
->environment
->len
) {
377 var
= g_ptr_array_index(trace
->environment
, index
);
378 if (var
->type
!= BT_ENVIRONMENT_FIELD_TYPE_INTEGER
) {
382 *value
= var
->value
.integer
;
387 int bt_ctf_trace_add_clock(struct bt_ctf_trace
*trace
,
388 struct bt_ctf_clock
*clock
)
391 struct search_query query
= { .value
= clock
, .found
= 0 };
393 if (!trace
|| !clock
) {
398 /* Check for duplicate clocks */
399 g_ptr_array_foreach(trace
->clocks
, value_exists
, &query
);
405 bt_ctf_clock_get(clock
);
406 g_ptr_array_add(trace
->clocks
, clock
);
411 int bt_ctf_trace_get_clock_count(struct bt_ctf_trace
*trace
)
419 ret
= trace
->clocks
->len
;
424 struct bt_ctf_clock
*bt_ctf_trace_get_clock(struct bt_ctf_trace
*trace
,
427 struct bt_ctf_clock
*clock
= NULL
;
429 if (!trace
|| index
< 0 || index
>= trace
->clocks
->len
) {
433 clock
= g_ptr_array_index(trace
->clocks
, index
);
434 bt_ctf_clock_get(clock
);
440 const char *get_byte_order_string(int byte_order
)
444 switch (byte_order
) {
460 int append_trace_metadata(struct bt_ctf_trace
*trace
,
461 struct metadata_context
*context
)
463 unsigned char *uuid
= trace
->uuid
;
466 g_string_append(context
->string
, "trace {\n");
468 g_string_append(context
->string
, "\tmajor = 1;\n");
469 g_string_append(context
->string
, "\tminor = 8;\n");
471 g_string_append_printf(context
->string
,
472 "\tuuid = \"%02x%02x%02x%02x-%02x%02x-%02x%02x-%02x%02x-%02x%02x%02x%02x%02x%02x\";\n",
473 uuid
[0], uuid
[1], uuid
[2], uuid
[3],
474 uuid
[4], uuid
[5], uuid
[6], uuid
[7],
475 uuid
[8], uuid
[9], uuid
[10], uuid
[11],
476 uuid
[12], uuid
[13], uuid
[14], uuid
[15]);
477 g_string_append_printf(context
->string
, "\tbyte_order = %s;\n",
478 get_byte_order_string(trace
->byte_order
));
480 g_string_append(context
->string
, "\tpacket.header := ");
481 context
->current_indentation_level
++;
482 g_string_assign(context
->field_name
, "");
483 ret
= bt_ctf_field_type_serialize(trace
->packet_header_type
,
488 context
->current_indentation_level
--;
490 g_string_append(context
->string
, ";\n};\n\n");
496 void append_env_field_metadata(struct environment_variable
*var
,
497 struct metadata_context
*context
)
500 case BT_ENVIRONMENT_FIELD_TYPE_STRING
:
501 g_string_append_printf(context
->string
, "\t%s = \"%s\";\n",
502 var
->name
->str
, var
->value
.string
->str
);
504 case BT_ENVIRONMENT_FIELD_TYPE_INTEGER
:
505 g_string_append_printf(context
->string
, "\t%s = %" PRId64
";\n",
506 var
->name
->str
, var
->value
.integer
);
514 void append_env_metadata(struct bt_ctf_trace
*trace
,
515 struct metadata_context
*context
)
517 if (trace
->environment
->len
== 0) {
521 g_string_append(context
->string
, "env {\n");
522 g_ptr_array_foreach(trace
->environment
,
523 (GFunc
)append_env_field_metadata
, context
);
524 g_string_append(context
->string
, "};\n\n");
527 char *bt_ctf_trace_get_metadata_string(struct bt_ctf_trace
*trace
)
529 char *metadata
= NULL
;
530 struct metadata_context
*context
= NULL
;
538 context
= g_new0(struct metadata_context
, 1);
543 context
->field_name
= g_string_sized_new(DEFAULT_IDENTIFIER_SIZE
);
544 context
->string
= g_string_sized_new(DEFAULT_METADATA_STRING_SIZE
);
545 g_string_append(context
->string
, "/* CTF 1.8 */\n\n");
546 if (append_trace_metadata(trace
, context
)) {
549 append_env_metadata(trace
, context
);
550 g_ptr_array_foreach(trace
->clocks
,
551 (GFunc
)bt_ctf_clock_serialize
, context
);
553 for (i
= 0; i
< trace
->stream_classes
->len
; i
++) {
554 err
= bt_ctf_stream_class_serialize(
555 trace
->stream_classes
->pdata
[i
], context
);
561 metadata
= context
->string
->str
;
563 g_string_free(context
->string
, err
? TRUE
: FALSE
);
564 g_string_free(context
->field_name
, TRUE
);
570 int bt_ctf_trace_set_byte_order(struct bt_ctf_trace
*trace
,
571 enum bt_ctf_byte_order byte_order
)
574 int internal_byte_order
;
576 if (!trace
|| trace
->frozen
) {
581 switch (byte_order
) {
582 case BT_CTF_BYTE_ORDER_NATIVE
:
584 * This doesn't make sense since the CTF specification defines
585 * the "native" byte order as "the byte order described in the
586 * trace description". However, this behavior had been
587 * implemented as part of v1.2 and is kept to maintain
590 * This may be changed on a major version bump only.
592 internal_byte_order
= (G_BYTE_ORDER
== G_LITTLE_ENDIAN
) ?
593 LITTLE_ENDIAN
: BIG_ENDIAN
;
595 case BT_CTF_BYTE_ORDER_LITTLE_ENDIAN
:
596 internal_byte_order
= LITTLE_ENDIAN
;
598 case BT_CTF_BYTE_ORDER_BIG_ENDIAN
:
599 case BT_CTF_BYTE_ORDER_NETWORK
:
600 internal_byte_order
= BIG_ENDIAN
;
607 trace
->byte_order
= internal_byte_order
;
612 struct bt_ctf_field_type
*bt_ctf_trace_get_packet_header_type(
613 struct bt_ctf_trace
*trace
)
615 struct bt_ctf_field_type
*field_type
= NULL
;
621 bt_ctf_field_type_get(trace
->packet_header_type
);
622 field_type
= trace
->packet_header_type
;
627 int bt_ctf_trace_set_packet_header_type(struct bt_ctf_trace
*trace
,
628 struct bt_ctf_field_type
*packet_header_type
)
632 if (!trace
|| !packet_header_type
|| trace
->frozen
) {
637 /* packet_header_type must be a structure */
638 if (bt_ctf_field_type_get_type_id(packet_header_type
) !=
644 bt_ctf_field_type_get(packet_header_type
);
645 bt_ctf_field_type_put(trace
->packet_header_type
);
646 trace
->packet_header_type
= packet_header_type
;
651 void bt_ctf_trace_get(struct bt_ctf_trace
*trace
)
657 bt_ctf_ref_get(&trace
->ref_count
);
660 void bt_ctf_trace_put(struct bt_ctf_trace
*trace
)
666 bt_ctf_ref_put(&trace
->ref_count
, bt_ctf_trace_destroy
);
670 struct bt_ctf_field_type
*get_field_type(enum field_type_alias alias
)
672 unsigned int alignment
, size
;
673 struct bt_ctf_field_type
*field_type
;
675 if (alias
>= NR_FIELD_TYPE_ALIAS
) {
679 alignment
= field_type_aliases_alignments
[alias
];
680 size
= field_type_aliases_sizes
[alias
];
681 field_type
= bt_ctf_field_type_integer_create(size
);
682 bt_ctf_field_type_set_alignment(field_type
, alignment
);
687 int init_trace_packet_header(struct bt_ctf_trace
*trace
)
690 struct bt_ctf_field
*magic
= NULL
, *uuid_array
= NULL
;
691 struct bt_ctf_field_type
*_uint32_t
=
692 get_field_type(FIELD_TYPE_ALIAS_UINT32_T
);
693 struct bt_ctf_field_type
*_uint8_t
=
694 get_field_type(FIELD_TYPE_ALIAS_UINT8_T
);
695 struct bt_ctf_field_type
*trace_packet_header_type
=
696 bt_ctf_field_type_structure_create();
697 struct bt_ctf_field_type
*uuid_array_type
=
698 bt_ctf_field_type_array_create(_uint8_t
, 16);
700 if (!trace_packet_header_type
|| !uuid_array_type
) {
705 ret
= bt_ctf_field_type_structure_add_field(trace_packet_header_type
,
711 ret
= bt_ctf_field_type_structure_add_field(trace_packet_header_type
,
712 uuid_array_type
, "uuid");
717 ret
= bt_ctf_field_type_structure_add_field(trace_packet_header_type
,
718 _uint32_t
, "stream_id");
723 ret
= bt_ctf_trace_set_packet_header_type(trace
,
724 trace_packet_header_type
);
729 bt_ctf_field_type_put(uuid_array_type
);
730 bt_ctf_field_type_put(_uint32_t
);
731 bt_ctf_field_type_put(_uint8_t
);
732 bt_ctf_field_put(magic
);
733 bt_ctf_field_put(uuid_array
);
734 bt_ctf_field_type_put(trace_packet_header_type
);
740 void environment_variable_destroy(struct environment_variable
*var
)
742 g_string_free(var
->name
, TRUE
);
743 if (var
->type
== BT_ENVIRONMENT_FIELD_TYPE_STRING
) {
744 g_string_free(var
->value
.string
, TRUE
);