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-class-internal.h>
31 #include <babeltrace/ctf-ir/stream-internal.h>
32 #include <babeltrace/ctf-ir/stream-class-internal.h>
33 #include <babeltrace/ctf-ir/event-internal.h>
34 #include <babeltrace/ctf-ir/event-class.h>
35 #include <babeltrace/ctf-ir/event-class-internal.h>
36 #include <babeltrace/ctf-writer/functor-internal.h>
37 #include <babeltrace/ctf-writer/clock-internal.h>
38 #include <babeltrace/ctf-ir/field-types-internal.h>
39 #include <babeltrace/ctf-ir/attributes-internal.h>
40 #include <babeltrace/ctf-ir/validation-internal.h>
41 #include <babeltrace/ctf-ir/visitor-internal.h>
42 #include <babeltrace/ctf-ir/utils.h>
43 #include <babeltrace/graph/notification-schema.h>
44 #include <babeltrace/compiler-internal.h>
45 #include <babeltrace/values.h>
46 #include <babeltrace/ref.h>
47 #include <babeltrace/endian-internal.h>
50 #define DEFAULT_IDENTIFIER_SIZE 128
51 #define DEFAULT_METADATA_STRING_SIZE 4096
53 struct listener_wrapper
{
54 bt_ctf_listener_cb listener
;
59 void bt_ctf_trace_destroy(struct bt_object
*obj
);
61 int init_trace_packet_header(struct bt_ctf_trace
*trace
);
63 void bt_ctf_trace_freeze(struct bt_ctf_trace
*trace
);
66 const unsigned int field_type_aliases_alignments
[] = {
67 [FIELD_TYPE_ALIAS_UINT5_T
] = 1,
68 [FIELD_TYPE_ALIAS_UINT8_T
... FIELD_TYPE_ALIAS_UINT16_T
] = 8,
69 [FIELD_TYPE_ALIAS_UINT27_T
] = 1,
70 [FIELD_TYPE_ALIAS_UINT32_T
... FIELD_TYPE_ALIAS_UINT64_T
] = 8,
74 const unsigned int field_type_aliases_sizes
[] = {
75 [FIELD_TYPE_ALIAS_UINT5_T
] = 5,
76 [FIELD_TYPE_ALIAS_UINT8_T
] = 8,
77 [FIELD_TYPE_ALIAS_UINT16_T
] = 16,
78 [FIELD_TYPE_ALIAS_UINT27_T
] = 27,
79 [FIELD_TYPE_ALIAS_UINT32_T
] = 32,
80 [FIELD_TYPE_ALIAS_UINT64_T
] = 64,
83 struct bt_ctf_trace
*bt_ctf_trace_create(void)
85 struct bt_ctf_trace
*trace
= NULL
;
87 trace
= g_new0(struct bt_ctf_trace
, 1);
92 trace
->native_byte_order
= BT_CTF_BYTE_ORDER_NATIVE
;
93 bt_object_init(trace
, bt_ctf_trace_destroy
);
94 trace
->clocks
= g_ptr_array_new_with_free_func(
95 (GDestroyNotify
) bt_put
);
96 trace
->streams
= g_ptr_array_new_with_free_func(
97 (GDestroyNotify
) bt_object_release
);
98 trace
->stream_classes
= g_ptr_array_new_with_free_func(
99 (GDestroyNotify
) bt_object_release
);
100 if (!trace
->clocks
|| !trace
->stream_classes
|| !trace
->streams
) {
104 /* Generate a trace UUID */
105 uuid_generate(trace
->uuid
);
106 if (init_trace_packet_header(trace
)) {
110 /* Create the environment array object */
111 trace
->environment
= bt_ctf_attributes_create();
112 if (!trace
->environment
) {
116 trace
->listeners
= g_ptr_array_new_with_free_func(
117 (GDestroyNotify
) g_free
);
118 if (!trace
->listeners
) {
129 const char *bt_ctf_trace_get_name(struct bt_ctf_trace
*trace
)
131 const char *name
= NULL
;
133 if (!trace
|| !trace
->name
) {
137 name
= trace
->name
->str
;
142 int bt_ctf_trace_set_name(struct bt_ctf_trace
*trace
, const char *name
)
146 if (!trace
|| !name
|| trace
->frozen
) {
151 trace
->name
= trace
->name
? g_string_assign(trace
->name
, name
) :
161 void bt_ctf_trace_destroy(struct bt_object
*obj
)
163 struct bt_ctf_trace
*trace
;
165 trace
= container_of(obj
, struct bt_ctf_trace
, base
);
166 if (trace
->environment
) {
167 bt_ctf_attributes_destroy(trace
->environment
);
171 g_string_free(trace
->name
, TRUE
);
175 g_ptr_array_free(trace
->clocks
, TRUE
);
178 if (trace
->streams
) {
179 g_ptr_array_free(trace
->streams
, TRUE
);
182 if (trace
->stream_classes
) {
183 g_ptr_array_free(trace
->stream_classes
, TRUE
);
186 if (trace
->listeners
) {
187 g_ptr_array_free(trace
->listeners
, TRUE
);
190 bt_put(trace
->packet_header_type
);
194 int bt_ctf_trace_set_environment_field(struct bt_ctf_trace
*trace
,
195 const char *name
, struct bt_value
*value
)
199 if (!trace
|| !name
|| !value
||
200 bt_ctf_validate_identifier(name
) ||
201 !(bt_value_is_integer(value
) || bt_value_is_string(value
))) {
206 if (strchr(name
, ' ')) {
213 * New environment fields may be added to a frozen trace,
214 * but existing fields may not be changed.
216 * The object passed is frozen like all other attributes.
218 struct bt_value
*attribute
=
219 bt_ctf_attributes_get_field_value_by_name(
220 trace
->environment
, name
);
228 bt_value_freeze(value
);
231 ret
= bt_ctf_attributes_set_field_value(trace
->environment
, name
,
238 int bt_ctf_trace_set_environment_field_string(struct bt_ctf_trace
*trace
,
239 const char *name
, const char *value
)
242 struct bt_value
*env_value_string_obj
= NULL
;
244 if (!trace
|| !name
|| !value
) {
251 * New environment fields may be added to a frozen trace,
252 * but existing fields may not be changed.
254 struct bt_value
*attribute
=
255 bt_ctf_attributes_get_field_value_by_name(
256 trace
->environment
, name
);
265 env_value_string_obj
= bt_value_string_create_init(value
);
267 if (!env_value_string_obj
) {
273 bt_value_freeze(env_value_string_obj
);
275 ret
= bt_ctf_trace_set_environment_field(trace
, name
,
276 env_value_string_obj
);
279 BT_PUT(env_value_string_obj
);
283 int bt_ctf_trace_set_environment_field_integer(struct bt_ctf_trace
*trace
,
284 const char *name
, int64_t value
)
287 struct bt_value
*env_value_integer_obj
= NULL
;
289 if (!trace
|| !name
) {
296 * New environment fields may be added to a frozen trace,
297 * but existing fields may not be changed.
299 struct bt_value
*attribute
=
300 bt_ctf_attributes_get_field_value_by_name(
301 trace
->environment
, name
);
310 env_value_integer_obj
= bt_value_integer_create_init(value
);
311 if (!env_value_integer_obj
) {
316 ret
= bt_ctf_trace_set_environment_field(trace
, name
,
317 env_value_integer_obj
);
319 bt_value_freeze(env_value_integer_obj
);
322 BT_PUT(env_value_integer_obj
);
326 int bt_ctf_trace_get_environment_field_count(struct bt_ctf_trace
*trace
)
335 ret
= bt_ctf_attributes_get_count(trace
->environment
);
342 bt_ctf_trace_get_environment_field_name(struct bt_ctf_trace
*trace
,
345 const char *ret
= NULL
;
351 ret
= bt_ctf_attributes_get_field_name(trace
->environment
, index
);
357 struct bt_value
*bt_ctf_trace_get_environment_field_value(
358 struct bt_ctf_trace
*trace
, int index
)
360 struct bt_value
*ret
= NULL
;
366 ret
= bt_ctf_attributes_get_field_value(trace
->environment
, index
);
372 struct bt_value
*bt_ctf_trace_get_environment_field_value_by_name(
373 struct bt_ctf_trace
*trace
, const char *name
)
375 struct bt_value
*ret
= NULL
;
377 if (!trace
|| !name
) {
381 ret
= bt_ctf_attributes_get_field_value_by_name(trace
->environment
,
388 int bt_ctf_trace_add_clock_class(struct bt_ctf_trace
*trace
,
389 struct bt_ctf_clock_class
*clock_class
)
393 if (!trace
|| !bt_ctf_clock_class_is_valid(clock_class
)) {
398 /* Check for duplicate clock classes */
399 if (bt_ctf_trace_has_clock_class(trace
, clock_class
)) {
405 g_ptr_array_add(trace
->clocks
, clock_class
);
408 bt_ctf_clock_class_freeze(clock_class
);
414 int bt_ctf_trace_get_clock_class_count(struct bt_ctf_trace
*trace
)
422 ret
= trace
->clocks
->len
;
427 struct bt_ctf_clock_class
*bt_ctf_trace_get_clock_class(
428 struct bt_ctf_trace
*trace
, int index
)
430 struct bt_ctf_clock_class
*clock_class
= NULL
;
432 if (!trace
|| index
< 0 || index
>= trace
->clocks
->len
) {
436 clock_class
= g_ptr_array_index(trace
->clocks
, index
);
442 int bt_ctf_trace_add_stream_class(struct bt_ctf_trace
*trace
,
443 struct bt_ctf_stream_class
*stream_class
)
447 struct bt_ctf_validation_output trace_sc_validation_output
= { 0 };
448 struct bt_ctf_validation_output
*ec_validation_outputs
= NULL
;
449 const enum bt_ctf_validation_flag trace_sc_validation_flags
=
450 BT_CTF_VALIDATION_FLAG_TRACE
|
451 BT_CTF_VALIDATION_FLAG_STREAM
;
452 const enum bt_ctf_validation_flag ec_validation_flags
=
453 BT_CTF_VALIDATION_FLAG_EVENT
;
454 struct bt_ctf_field_type
*packet_header_type
= NULL
;
455 struct bt_ctf_field_type
*packet_context_type
= NULL
;
456 struct bt_ctf_field_type
*event_header_type
= NULL
;
457 struct bt_ctf_field_type
*stream_event_ctx_type
= NULL
;
458 int event_class_count
;
459 struct bt_ctf_trace
*current_parent_trace
= NULL
;
461 if (!trace
|| !stream_class
) {
467 * At the end of this function we freeze the trace, so its
468 * native byte order must NOT be BT_CTF_BYTE_ORDER_NATIVE.
470 if (trace
->native_byte_order
== BT_CTF_BYTE_ORDER_NATIVE
) {
475 current_parent_trace
= bt_ctf_stream_class_get_trace(stream_class
);
476 if (current_parent_trace
) {
477 /* Stream class is already associated to a trace, abort. */
483 bt_ctf_stream_class_get_event_class_count(stream_class
);
484 assert(event_class_count
>= 0);
486 /* Check for duplicate stream classes */
487 for (i
= 0; i
< trace
->stream_classes
->len
; i
++) {
488 if (trace
->stream_classes
->pdata
[i
] == stream_class
) {
489 /* Stream class already registered to the trace */
495 if (stream_class
->clock
) {
496 struct bt_ctf_clock_class
*stream_clock_class
=
497 stream_class
->clock
->clock_class
;
499 if (trace
->is_created_by_writer
) {
501 * Make sure this clock was also added to the
502 * trace (potentially through its CTF writer
507 for (i
= 0; i
< trace
->clocks
->len
; i
++) {
508 if (trace
->clocks
->pdata
[i
] ==
509 stream_clock_class
) {
515 if (i
== trace
->clocks
->len
) {
522 * This trace was NOT created by a CTF writer,
523 * thus do not allow the stream class to add to
524 * have a clock at all. Those are two
525 * independent APIs (non-writer and writer
526 * APIs), and isolating them simplifies things.
534 * We're about to freeze both the trace and the stream class.
535 * Also, each event class contained in this stream class are
538 * This trace, this stream class, and all its event classes
539 * should be valid at this point.
541 * Validate trace and stream class first, then each event
542 * class of this stream class can be validated individually.
545 bt_ctf_trace_get_packet_header_type(trace
);
546 packet_context_type
=
547 bt_ctf_stream_class_get_packet_context_type(stream_class
);
549 bt_ctf_stream_class_get_event_header_type(stream_class
);
550 stream_event_ctx_type
=
551 bt_ctf_stream_class_get_event_context_type(stream_class
);
552 ret
= bt_ctf_validate_class_types(trace
->environment
,
553 packet_header_type
, packet_context_type
, event_header_type
,
554 stream_event_ctx_type
, NULL
, NULL
, trace
->valid
,
555 stream_class
->valid
, 1, &trace_sc_validation_output
,
556 trace_sc_validation_flags
);
557 BT_PUT(packet_header_type
);
558 BT_PUT(packet_context_type
);
559 BT_PUT(event_header_type
);
560 BT_PUT(stream_event_ctx_type
);
564 * This means something went wrong during the validation
565 * process, not that the objects are invalid.
570 if ((trace_sc_validation_output
.valid_flags
&
571 trace_sc_validation_flags
) !=
572 trace_sc_validation_flags
) {
573 /* Invalid trace/stream class */
578 if (event_class_count
> 0) {
579 ec_validation_outputs
= g_new0(struct bt_ctf_validation_output
,
581 if (!ec_validation_outputs
) {
587 /* Validate each event class individually */
588 for (i
= 0; i
< event_class_count
; i
++) {
589 struct bt_ctf_event_class
*event_class
=
590 bt_ctf_stream_class_get_event_class(stream_class
, i
);
591 struct bt_ctf_field_type
*event_context_type
= NULL
;
592 struct bt_ctf_field_type
*event_payload_type
= NULL
;
595 bt_ctf_event_class_get_context_type(event_class
);
597 bt_ctf_event_class_get_payload_type(event_class
);
600 * It is important to use the field types returned by
601 * the previous trace and stream class validation here
602 * because copies could have been made.
604 ret
= bt_ctf_validate_class_types(trace
->environment
,
605 trace_sc_validation_output
.packet_header_type
,
606 trace_sc_validation_output
.packet_context_type
,
607 trace_sc_validation_output
.event_header_type
,
608 trace_sc_validation_output
.stream_event_ctx_type
,
609 event_context_type
, event_payload_type
,
610 1, 1, event_class
->valid
, &ec_validation_outputs
[i
],
611 ec_validation_flags
);
612 BT_PUT(event_context_type
);
613 BT_PUT(event_payload_type
);
620 if ((ec_validation_outputs
[i
].valid_flags
&
621 ec_validation_flags
) != ec_validation_flags
) {
622 /* Invalid event class */
628 stream_id
= bt_ctf_stream_class_get_id(stream_class
);
630 stream_id
= trace
->next_stream_id
++;
632 /* Try to assign a new stream id */
633 for (i
= 0; i
< trace
->stream_classes
->len
; i
++) {
634 if (stream_id
== bt_ctf_stream_class_get_id(
635 trace
->stream_classes
->pdata
[i
])) {
636 /* Duplicate stream id found */
642 if (bt_ctf_stream_class_set_id_no_check(stream_class
,
644 /* TODO Should retry with a different stream id */
650 bt_object_set_parent(stream_class
, trace
);
651 g_ptr_array_add(trace
->stream_classes
, stream_class
);
654 * At this point we know that the function will be successful.
655 * Therefore we can replace the trace and stream class field
656 * types with what's in their validation output structure and
657 * mark them as valid. We can also replace the field types of
658 * all the event classes of the stream class and mark them as
661 bt_ctf_validation_replace_types(trace
, stream_class
, NULL
,
662 &trace_sc_validation_output
, trace_sc_validation_flags
);
664 stream_class
->valid
= 1;
667 * Put what was not moved in bt_ctf_validation_replace_types().
669 bt_ctf_validation_output_put_types(&trace_sc_validation_output
);
671 for (i
= 0; i
< event_class_count
; i
++) {
672 struct bt_ctf_event_class
*event_class
=
673 bt_ctf_stream_class_get_event_class(stream_class
, i
);
675 bt_ctf_validation_replace_types(NULL
, NULL
, event_class
,
676 &ec_validation_outputs
[i
], ec_validation_flags
);
677 event_class
->valid
= 1;
681 * Put what was not moved in
682 * bt_ctf_validation_replace_types().
684 bt_ctf_validation_output_put_types(&ec_validation_outputs
[i
]);
688 * Freeze the trace and the stream class.
690 bt_ctf_stream_class_freeze(stream_class
);
691 bt_ctf_trace_freeze(trace
);
693 /* Notifiy listeners of the trace's schema modification. */
694 bt_ctf_stream_class_visit(stream_class
,
695 bt_ctf_trace_object_modification
, trace
);
698 bt_object_set_parent(stream_class
, NULL
);
700 if (ec_validation_outputs
) {
701 for (i
= 0; i
< event_class_count
; i
++) {
702 bt_ctf_validation_output_put_types(
703 &ec_validation_outputs
[i
]);
708 g_free(ec_validation_outputs
);
709 bt_ctf_validation_output_put_types(&trace_sc_validation_output
);
710 bt_put(current_parent_trace
);
711 assert(!packet_header_type
);
712 assert(!packet_context_type
);
713 assert(!event_header_type
);
714 assert(!stream_event_ctx_type
);
719 int bt_ctf_trace_get_stream_class_count(struct bt_ctf_trace
*trace
)
728 ret
= trace
->stream_classes
->len
;
733 struct bt_ctf_stream_class
*bt_ctf_trace_get_stream_class(
734 struct bt_ctf_trace
*trace
, int index
)
736 struct bt_ctf_stream_class
*stream_class
= NULL
;
738 if (!trace
|| index
< 0 || index
>= trace
->stream_classes
->len
) {
742 stream_class
= g_ptr_array_index(trace
->stream_classes
, index
);
743 bt_get(stream_class
);
748 struct bt_ctf_stream_class
*bt_ctf_trace_get_stream_class_by_id(
749 struct bt_ctf_trace
*trace
, uint32_t id
)
752 struct bt_ctf_stream_class
*stream_class
= NULL
;
758 for (i
= 0; i
< trace
->stream_classes
->len
; i
++) {
759 struct bt_ctf_stream_class
*stream_class_candidate
;
761 stream_class_candidate
=
762 g_ptr_array_index(trace
->stream_classes
, i
);
764 if (bt_ctf_stream_class_get_id(stream_class_candidate
) ==
766 stream_class
= stream_class_candidate
;
767 bt_get(stream_class
);
776 struct bt_ctf_clock_class
*bt_ctf_trace_get_clock_class_by_name(
777 struct bt_ctf_trace
*trace
, const char *name
)
780 struct bt_ctf_clock_class
*clock_class
= NULL
;
782 if (!trace
|| !name
) {
786 for (i
= 0; i
< trace
->clocks
->len
; i
++) {
787 struct bt_ctf_clock_class
*cur_clk
=
788 g_ptr_array_index(trace
->clocks
, i
);
789 const char *cur_clk_name
= bt_ctf_clock_class_get_name(cur_clk
);
795 if (!strcmp(cur_clk_name
, name
)) {
796 clock_class
= cur_clk
;
807 bool bt_ctf_trace_has_clock_class(struct bt_ctf_trace
*trace
,
808 struct bt_ctf_clock_class
*clock_class
)
810 struct search_query query
= { .value
= clock_class
, .found
= 0 };
815 g_ptr_array_foreach(trace
->clocks
, value_exists
, &query
);
820 const char *get_byte_order_string(enum bt_ctf_byte_order byte_order
)
824 switch (byte_order
) {
825 case BT_CTF_BYTE_ORDER_LITTLE_ENDIAN
:
828 case BT_CTF_BYTE_ORDER_BIG_ENDIAN
:
831 case BT_CTF_BYTE_ORDER_NATIVE
:
842 int append_trace_metadata(struct bt_ctf_trace
*trace
,
843 struct metadata_context
*context
)
845 unsigned char *uuid
= trace
->uuid
;
848 g_string_append(context
->string
, "trace {\n");
850 g_string_append(context
->string
, "\tmajor = 1;\n");
851 g_string_append(context
->string
, "\tminor = 8;\n");
852 assert(trace
->native_byte_order
== BT_CTF_BYTE_ORDER_LITTLE_ENDIAN
||
853 trace
->native_byte_order
== BT_CTF_BYTE_ORDER_BIG_ENDIAN
||
854 trace
->native_byte_order
== BT_CTF_BYTE_ORDER_NETWORK
);
855 g_string_append_printf(context
->string
,
856 "\tuuid = \"%02x%02x%02x%02x-%02x%02x-%02x%02x-%02x%02x-%02x%02x%02x%02x%02x%02x\";\n",
857 uuid
[0], uuid
[1], uuid
[2], uuid
[3],
858 uuid
[4], uuid
[5], uuid
[6], uuid
[7],
859 uuid
[8], uuid
[9], uuid
[10], uuid
[11],
860 uuid
[12], uuid
[13], uuid
[14], uuid
[15]);
861 g_string_append_printf(context
->string
, "\tbyte_order = %s;\n",
862 get_byte_order_string(trace
->native_byte_order
));
864 g_string_append(context
->string
, "\tpacket.header := ");
865 context
->current_indentation_level
++;
866 g_string_assign(context
->field_name
, "");
867 ret
= bt_ctf_field_type_serialize(trace
->packet_header_type
,
872 context
->current_indentation_level
--;
874 g_string_append(context
->string
, ";\n};\n\n");
880 void append_env_metadata(struct bt_ctf_trace
*trace
,
881 struct metadata_context
*context
)
886 env_size
= bt_ctf_attributes_get_count(trace
->environment
);
892 g_string_append(context
->string
, "env {\n");
894 for (i
= 0; i
< env_size
; i
++) {
895 struct bt_value
*env_field_value_obj
= NULL
;
896 const char *entry_name
;
898 entry_name
= bt_ctf_attributes_get_field_name(
899 trace
->environment
, i
);
900 env_field_value_obj
= bt_ctf_attributes_get_field_value(
901 trace
->environment
, i
);
903 if (!entry_name
|| !env_field_value_obj
) {
907 switch (bt_value_get_type(env_field_value_obj
)) {
908 case BT_VALUE_TYPE_INTEGER
:
913 ret
= bt_value_integer_get(env_field_value_obj
,
920 g_string_append_printf(context
->string
,
921 "\t%s = %" PRId64
";\n", entry_name
,
925 case BT_VALUE_TYPE_STRING
:
928 const char *str_value
;
929 char *escaped_str
= NULL
;
931 ret
= bt_value_string_get(env_field_value_obj
,
938 escaped_str
= g_strescape(str_value
, NULL
);
944 g_string_append_printf(context
->string
,
945 "\t%s = \"%s\";\n", entry_name
, escaped_str
);
955 BT_PUT(env_field_value_obj
);
958 g_string_append(context
->string
, "};\n\n");
961 char *bt_ctf_trace_get_metadata_string(struct bt_ctf_trace
*trace
)
963 char *metadata
= NULL
;
964 struct metadata_context
*context
= NULL
;
972 context
= g_new0(struct metadata_context
, 1);
977 context
->field_name
= g_string_sized_new(DEFAULT_IDENTIFIER_SIZE
);
978 context
->string
= g_string_sized_new(DEFAULT_METADATA_STRING_SIZE
);
979 g_string_append(context
->string
, "/* CTF 1.8 */\n\n");
980 if (append_trace_metadata(trace
, context
)) {
983 append_env_metadata(trace
, context
);
984 g_ptr_array_foreach(trace
->clocks
,
985 (GFunc
)bt_ctf_clock_class_serialize
, context
);
987 for (i
= 0; i
< trace
->stream_classes
->len
; i
++) {
988 err
= bt_ctf_stream_class_serialize(
989 trace
->stream_classes
->pdata
[i
], context
);
995 metadata
= context
->string
->str
;
997 g_string_free(context
->string
, err
? TRUE
: FALSE
);
998 g_string_free(context
->field_name
, TRUE
);
1004 enum bt_ctf_byte_order
bt_ctf_trace_get_byte_order(struct bt_ctf_trace
*trace
)
1006 enum bt_ctf_byte_order ret
= BT_CTF_BYTE_ORDER_UNKNOWN
;
1012 ret
= trace
->native_byte_order
;
1018 int bt_ctf_trace_set_native_byte_order(struct bt_ctf_trace
*trace
,
1019 enum bt_ctf_byte_order byte_order
)
1023 if (!trace
|| trace
->frozen
) {
1028 if (byte_order
!= BT_CTF_BYTE_ORDER_LITTLE_ENDIAN
&&
1029 byte_order
!= BT_CTF_BYTE_ORDER_BIG_ENDIAN
&&
1030 byte_order
!= BT_CTF_BYTE_ORDER_NETWORK
) {
1035 trace
->native_byte_order
= byte_order
;
1041 struct bt_ctf_field_type
*bt_ctf_trace_get_packet_header_type(
1042 struct bt_ctf_trace
*trace
)
1044 struct bt_ctf_field_type
*field_type
= NULL
;
1050 bt_get(trace
->packet_header_type
);
1051 field_type
= trace
->packet_header_type
;
1056 int bt_ctf_trace_set_packet_header_type(struct bt_ctf_trace
*trace
,
1057 struct bt_ctf_field_type
*packet_header_type
)
1061 if (!trace
|| trace
->frozen
) {
1066 /* packet_header_type must be a structure. */
1067 if (packet_header_type
&&
1068 bt_ctf_field_type_get_type_id(packet_header_type
) !=
1069 BT_CTF_FIELD_TYPE_ID_STRUCT
) {
1074 bt_put(trace
->packet_header_type
);
1075 trace
->packet_header_type
= bt_get(packet_header_type
);
1081 int get_stream_class_count(void *element
)
1083 return bt_ctf_trace_get_stream_class_count(
1084 (struct bt_ctf_trace
*) element
);
1088 void *get_stream_class(void *element
, int i
)
1090 return bt_ctf_trace_get_stream_class(
1091 (struct bt_ctf_trace
*) element
, i
);
1095 int visit_stream_class(void *object
, bt_ctf_visitor visitor
,void *data
)
1097 return bt_ctf_stream_class_visit(object
, visitor
, data
);
1100 int bt_ctf_trace_visit(struct bt_ctf_trace
*trace
,
1101 bt_ctf_visitor visitor
, void *data
)
1104 struct bt_ctf_object obj
=
1105 { .object
= trace
, .type
= BT_CTF_OBJECT_TYPE_TRACE
};
1107 if (!trace
|| !visitor
) {
1112 ret
= visitor_helper(&obj
, get_stream_class_count
,
1113 get_stream_class
, visit_stream_class
, visitor
, data
);
1119 int invoke_listener(struct bt_ctf_object
*object
, void *data
)
1121 struct listener_wrapper
*listener_wrapper
= data
;
1123 listener_wrapper
->listener(object
, listener_wrapper
->data
);
1127 int bt_ctf_trace_add_listener(struct bt_ctf_trace
*trace
,
1128 bt_ctf_listener_cb listener
, void *listener_data
)
1131 struct listener_wrapper
*listener_wrapper
=
1132 g_new0(struct listener_wrapper
, 1);
1134 if (!trace
|| !listener
|| !listener_wrapper
) {
1139 listener_wrapper
->listener
= listener
;
1140 listener_wrapper
->data
= listener_data
;
1142 /* Visit the current schema. */
1143 ret
= bt_ctf_trace_visit(trace
, invoke_listener
, listener_wrapper
);
1149 * Add listener to the array of callbacks which will be invoked on
1152 g_ptr_array_add(trace
->listeners
, listener_wrapper
);
1155 g_free(listener_wrapper
);
1160 int bt_ctf_trace_object_modification(struct bt_ctf_object
*object
,
1164 struct bt_ctf_trace
*trace
= trace_ptr
;
1169 if (trace
->listeners
->len
== 0) {
1173 for (i
= 0; i
< trace
->listeners
->len
; i
++) {
1174 struct listener_wrapper
*listener
=
1175 g_ptr_array_index(trace
->listeners
, i
);
1177 listener
->listener(object
, listener
->data
);
1184 struct bt_ctf_field_type
*get_field_type(enum field_type_alias alias
)
1187 unsigned int alignment
, size
;
1188 struct bt_ctf_field_type
*field_type
= NULL
;
1190 if (alias
>= NR_FIELD_TYPE_ALIAS
) {
1194 alignment
= field_type_aliases_alignments
[alias
];
1195 size
= field_type_aliases_sizes
[alias
];
1196 field_type
= bt_ctf_field_type_integer_create(size
);
1197 ret
= bt_ctf_field_type_set_alignment(field_type
, alignment
);
1206 void bt_ctf_trace_freeze(struct bt_ctf_trace
*trace
)
1210 bt_ctf_field_type_freeze(trace
->packet_header_type
);
1211 bt_ctf_attributes_freeze(trace
->environment
);
1213 for (i
= 0; i
< trace
->clocks
->len
; i
++) {
1214 struct bt_ctf_clock_class
*clock_class
=
1215 g_ptr_array_index(trace
->clocks
, i
);
1217 bt_ctf_clock_class_freeze(clock_class
);
1224 int init_trace_packet_header(struct bt_ctf_trace
*trace
)
1227 struct bt_ctf_field
*magic
= NULL
, *uuid_array
= NULL
;
1228 struct bt_ctf_field_type
*_uint32_t
=
1229 get_field_type(FIELD_TYPE_ALIAS_UINT32_T
);
1230 struct bt_ctf_field_type
*_uint8_t
=
1231 get_field_type(FIELD_TYPE_ALIAS_UINT8_T
);
1232 struct bt_ctf_field_type
*trace_packet_header_type
=
1233 bt_ctf_field_type_structure_create();
1234 struct bt_ctf_field_type
*uuid_array_type
=
1235 bt_ctf_field_type_array_create(_uint8_t
, 16);
1237 if (!trace_packet_header_type
|| !uuid_array_type
) {
1242 ret
= bt_ctf_field_type_structure_add_field(trace_packet_header_type
,
1243 _uint32_t
, "magic");
1248 ret
= bt_ctf_field_type_structure_add_field(trace_packet_header_type
,
1249 uuid_array_type
, "uuid");
1254 ret
= bt_ctf_field_type_structure_add_field(trace_packet_header_type
,
1255 _uint32_t
, "stream_id");
1260 ret
= bt_ctf_trace_set_packet_header_type(trace
,
1261 trace_packet_header_type
);
1266 bt_put(uuid_array_type
);
1271 bt_put(trace_packet_header_type
);