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/compiler-internal.h>
44 #include <babeltrace/values.h>
45 #include <babeltrace/ref.h>
46 #include <babeltrace/endian-internal.h>
51 #define DEFAULT_IDENTIFIER_SIZE 128
52 #define DEFAULT_METADATA_STRING_SIZE 4096
54 struct listener_wrapper
{
55 bt_ctf_listener_cb listener
;
60 void bt_ctf_trace_destroy(struct bt_object
*obj
);
62 void bt_ctf_trace_freeze(struct bt_ctf_trace
*trace
);
65 const unsigned int field_type_aliases_alignments
[] = {
66 [FIELD_TYPE_ALIAS_UINT5_T
] = 1,
67 [FIELD_TYPE_ALIAS_UINT8_T
... FIELD_TYPE_ALIAS_UINT16_T
] = 8,
68 [FIELD_TYPE_ALIAS_UINT27_T
] = 1,
69 [FIELD_TYPE_ALIAS_UINT32_T
... FIELD_TYPE_ALIAS_UINT64_T
] = 8,
73 const unsigned int field_type_aliases_sizes
[] = {
74 [FIELD_TYPE_ALIAS_UINT5_T
] = 5,
75 [FIELD_TYPE_ALIAS_UINT8_T
] = 8,
76 [FIELD_TYPE_ALIAS_UINT16_T
] = 16,
77 [FIELD_TYPE_ALIAS_UINT27_T
] = 27,
78 [FIELD_TYPE_ALIAS_UINT32_T
] = 32,
79 [FIELD_TYPE_ALIAS_UINT64_T
] = 64,
82 struct bt_ctf_trace
*bt_ctf_trace_create(void)
84 struct bt_ctf_trace
*trace
= NULL
;
85 struct bt_ctf_field_type
*packet_header_type
= 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 packet_header_type
= bt_ctf_field_type_structure_create();
105 if (!packet_header_type
) {
109 BT_MOVE(trace
->packet_header_type
, packet_header_type
);
111 /* Create the environment array object */
112 trace
->environment
= bt_ctf_attributes_create();
113 if (!trace
->environment
) {
117 trace
->listeners
= g_ptr_array_new_with_free_func(
118 (GDestroyNotify
) g_free
);
119 if (!trace
->listeners
) {
127 bt_put(packet_header_type
);
131 const char *bt_ctf_trace_get_name(struct bt_ctf_trace
*trace
)
133 const char *name
= NULL
;
135 if (!trace
|| !trace
->name
) {
139 name
= trace
->name
->str
;
144 int bt_ctf_trace_set_name(struct bt_ctf_trace
*trace
, const char *name
)
148 if (!trace
|| !name
|| trace
->frozen
) {
153 trace
->name
= trace
->name
? g_string_assign(trace
->name
, name
) :
163 const unsigned char *bt_ctf_trace_get_uuid(struct bt_ctf_trace
*trace
)
165 return trace
&& trace
->uuid_set
? trace
->uuid
: NULL
;
168 int bt_ctf_trace_set_uuid(struct bt_ctf_trace
*trace
, const unsigned char *uuid
)
172 if (!trace
|| !uuid
|| trace
->frozen
) {
177 memcpy(trace
->uuid
, uuid
, sizeof(uuid_t
));
178 trace
->uuid_set
= true;
184 void bt_ctf_trace_destroy(struct bt_object
*obj
)
186 struct bt_ctf_trace
*trace
;
188 trace
= container_of(obj
, struct bt_ctf_trace
, base
);
189 if (trace
->environment
) {
190 bt_ctf_attributes_destroy(trace
->environment
);
194 g_string_free(trace
->name
, TRUE
);
198 g_ptr_array_free(trace
->clocks
, TRUE
);
201 if (trace
->streams
) {
202 g_ptr_array_free(trace
->streams
, TRUE
);
205 if (trace
->stream_classes
) {
206 g_ptr_array_free(trace
->stream_classes
, TRUE
);
209 if (trace
->listeners
) {
210 g_ptr_array_free(trace
->listeners
, TRUE
);
213 bt_put(trace
->packet_header_type
);
217 int bt_ctf_trace_set_environment_field(struct bt_ctf_trace
*trace
,
218 const char *name
, struct bt_value
*value
)
222 if (!trace
|| !name
|| !value
||
223 bt_ctf_validate_identifier(name
) ||
224 !(bt_value_is_integer(value
) || bt_value_is_string(value
))) {
229 if (strchr(name
, ' ')) {
236 * New environment fields may be added to a frozen trace,
237 * but existing fields may not be changed.
239 * The object passed is frozen like all other attributes.
241 struct bt_value
*attribute
=
242 bt_ctf_attributes_get_field_value_by_name(
243 trace
->environment
, name
);
251 bt_value_freeze(value
);
254 ret
= bt_ctf_attributes_set_field_value(trace
->environment
, name
,
261 int bt_ctf_trace_set_environment_field_string(struct bt_ctf_trace
*trace
,
262 const char *name
, const char *value
)
265 struct bt_value
*env_value_string_obj
= NULL
;
267 if (!trace
|| !name
|| !value
) {
274 * New environment fields may be added to a frozen trace,
275 * but existing fields may not be changed.
277 struct bt_value
*attribute
=
278 bt_ctf_attributes_get_field_value_by_name(
279 trace
->environment
, name
);
288 env_value_string_obj
= bt_value_string_create_init(value
);
290 if (!env_value_string_obj
) {
296 bt_value_freeze(env_value_string_obj
);
298 ret
= bt_ctf_trace_set_environment_field(trace
, name
,
299 env_value_string_obj
);
302 BT_PUT(env_value_string_obj
);
306 int bt_ctf_trace_set_environment_field_integer(struct bt_ctf_trace
*trace
,
307 const char *name
, int64_t value
)
310 struct bt_value
*env_value_integer_obj
= NULL
;
312 if (!trace
|| !name
) {
319 * New environment fields may be added to a frozen trace,
320 * but existing fields may not be changed.
322 struct bt_value
*attribute
=
323 bt_ctf_attributes_get_field_value_by_name(
324 trace
->environment
, name
);
333 env_value_integer_obj
= bt_value_integer_create_init(value
);
334 if (!env_value_integer_obj
) {
339 ret
= bt_ctf_trace_set_environment_field(trace
, name
,
340 env_value_integer_obj
);
342 bt_value_freeze(env_value_integer_obj
);
345 BT_PUT(env_value_integer_obj
);
349 int64_t bt_ctf_trace_get_environment_field_count(struct bt_ctf_trace
*trace
)
358 ret
= bt_ctf_attributes_get_count(trace
->environment
);
365 bt_ctf_trace_get_environment_field_name_by_index(struct bt_ctf_trace
*trace
,
368 const char *ret
= NULL
;
374 ret
= bt_ctf_attributes_get_field_name(trace
->environment
, index
);
380 struct bt_value
*bt_ctf_trace_get_environment_field_value_by_index(
381 struct bt_ctf_trace
*trace
, uint64_t index
)
383 struct bt_value
*ret
= NULL
;
389 ret
= bt_ctf_attributes_get_field_value(trace
->environment
, index
);
395 struct bt_value
*bt_ctf_trace_get_environment_field_value_by_name(
396 struct bt_ctf_trace
*trace
, const char *name
)
398 struct bt_value
*ret
= NULL
;
400 if (!trace
|| !name
) {
404 ret
= bt_ctf_attributes_get_field_value_by_name(trace
->environment
,
411 int bt_ctf_trace_add_clock_class(struct bt_ctf_trace
*trace
,
412 struct bt_ctf_clock_class
*clock_class
)
416 if (!trace
|| trace
->is_static
||
417 !bt_ctf_clock_class_is_valid(clock_class
)) {
422 /* Check for duplicate clock classes */
423 if (bt_ctf_trace_has_clock_class(trace
, clock_class
)) {
429 g_ptr_array_add(trace
->clocks
, clock_class
);
432 bt_ctf_clock_class_freeze(clock_class
);
438 int64_t bt_ctf_trace_get_clock_class_count(struct bt_ctf_trace
*trace
)
440 int64_t ret
= (int64_t) -1;
446 ret
= trace
->clocks
->len
;
451 struct bt_ctf_clock_class
*bt_ctf_trace_get_clock_class_by_index(
452 struct bt_ctf_trace
*trace
, uint64_t index
)
454 struct bt_ctf_clock_class
*clock_class
= NULL
;
456 if (!trace
|| index
>= trace
->clocks
->len
) {
460 clock_class
= g_ptr_array_index(trace
->clocks
, index
);
466 int bt_ctf_trace_add_stream_class(struct bt_ctf_trace
*trace
,
467 struct bt_ctf_stream_class
*stream_class
)
472 struct bt_ctf_validation_output trace_sc_validation_output
= { 0 };
473 struct bt_ctf_validation_output
*ec_validation_outputs
= NULL
;
474 const enum bt_ctf_validation_flag trace_sc_validation_flags
=
475 BT_CTF_VALIDATION_FLAG_TRACE
|
476 BT_CTF_VALIDATION_FLAG_STREAM
;
477 const enum bt_ctf_validation_flag ec_validation_flags
=
478 BT_CTF_VALIDATION_FLAG_EVENT
;
479 struct bt_ctf_field_type
*packet_header_type
= NULL
;
480 struct bt_ctf_field_type
*packet_context_type
= NULL
;
481 struct bt_ctf_field_type
*event_header_type
= NULL
;
482 struct bt_ctf_field_type
*stream_event_ctx_type
= NULL
;
483 int64_t event_class_count
;
484 struct bt_ctf_trace
*current_parent_trace
= NULL
;
486 if (!trace
|| !stream_class
|| trace
->is_static
) {
492 * At the end of this function we freeze the trace, so its
493 * native byte order must NOT be BT_CTF_BYTE_ORDER_NATIVE.
495 if (trace
->native_byte_order
== BT_CTF_BYTE_ORDER_NATIVE
) {
500 current_parent_trace
= bt_ctf_stream_class_get_trace(stream_class
);
501 if (current_parent_trace
) {
502 /* Stream class is already associated to a trace, abort. */
508 bt_ctf_stream_class_get_event_class_count(stream_class
);
509 assert(event_class_count
>= 0);
511 /* Check for duplicate stream classes */
512 for (i
= 0; i
< trace
->stream_classes
->len
; i
++) {
513 if (trace
->stream_classes
->pdata
[i
] == stream_class
) {
514 /* Stream class already registered to the trace */
520 if (stream_class
->clock
) {
521 struct bt_ctf_clock_class
*stream_clock_class
=
522 stream_class
->clock
->clock_class
;
524 if (trace
->is_created_by_writer
) {
526 * Make sure this clock was also added to the
527 * trace (potentially through its CTF writer
532 for (i
= 0; i
< trace
->clocks
->len
; i
++) {
533 if (trace
->clocks
->pdata
[i
] ==
534 stream_clock_class
) {
540 if (i
== trace
->clocks
->len
) {
547 * This trace was NOT created by a CTF writer,
548 * thus do not allow the stream class to add to
549 * have a clock at all. Those are two
550 * independent APIs (non-writer and writer
551 * APIs), and isolating them simplifies things.
559 * We're about to freeze both the trace and the stream class.
560 * Also, each event class contained in this stream class are
563 * This trace, this stream class, and all its event classes
564 * should be valid at this point.
566 * Validate trace and stream class first, then each event
567 * class of this stream class can be validated individually.
570 bt_ctf_trace_get_packet_header_type(trace
);
571 packet_context_type
=
572 bt_ctf_stream_class_get_packet_context_type(stream_class
);
574 bt_ctf_stream_class_get_event_header_type(stream_class
);
575 stream_event_ctx_type
=
576 bt_ctf_stream_class_get_event_context_type(stream_class
);
577 ret
= bt_ctf_validate_class_types(trace
->environment
,
578 packet_header_type
, packet_context_type
, event_header_type
,
579 stream_event_ctx_type
, NULL
, NULL
, trace
->valid
,
580 stream_class
->valid
, 1, &trace_sc_validation_output
,
581 trace_sc_validation_flags
);
582 BT_PUT(packet_header_type
);
583 BT_PUT(packet_context_type
);
584 BT_PUT(event_header_type
);
585 BT_PUT(stream_event_ctx_type
);
589 * This means something went wrong during the validation
590 * process, not that the objects are invalid.
595 if ((trace_sc_validation_output
.valid_flags
&
596 trace_sc_validation_flags
) !=
597 trace_sc_validation_flags
) {
598 /* Invalid trace/stream class */
603 if (event_class_count
> 0) {
604 ec_validation_outputs
= g_new0(struct bt_ctf_validation_output
,
606 if (!ec_validation_outputs
) {
612 /* Validate each event class individually */
613 for (i
= 0; i
< event_class_count
; i
++) {
614 struct bt_ctf_event_class
*event_class
=
615 bt_ctf_stream_class_get_event_class_by_index(
617 struct bt_ctf_field_type
*event_context_type
= NULL
;
618 struct bt_ctf_field_type
*event_payload_type
= NULL
;
621 bt_ctf_event_class_get_context_type(event_class
);
623 bt_ctf_event_class_get_payload_type(event_class
);
626 * It is important to use the field types returned by
627 * the previous trace and stream class validation here
628 * because copies could have been made.
630 ret
= bt_ctf_validate_class_types(trace
->environment
,
631 trace_sc_validation_output
.packet_header_type
,
632 trace_sc_validation_output
.packet_context_type
,
633 trace_sc_validation_output
.event_header_type
,
634 trace_sc_validation_output
.stream_event_ctx_type
,
635 event_context_type
, event_payload_type
,
636 1, 1, event_class
->valid
, &ec_validation_outputs
[i
],
637 ec_validation_flags
);
638 BT_PUT(event_context_type
);
639 BT_PUT(event_payload_type
);
646 if ((ec_validation_outputs
[i
].valid_flags
&
647 ec_validation_flags
) != ec_validation_flags
) {
648 /* Invalid event class */
654 stream_id
= bt_ctf_stream_class_get_id(stream_class
);
656 stream_id
= trace
->next_stream_id
++;
662 /* Try to assign a new stream id */
663 for (i
= 0; i
< trace
->stream_classes
->len
; i
++) {
664 if (stream_id
== bt_ctf_stream_class_get_id(
665 trace
->stream_classes
->pdata
[i
])) {
666 /* Duplicate stream id found */
672 if (bt_ctf_stream_class_set_id_no_check(stream_class
,
674 /* TODO Should retry with a different stream id */
680 bt_object_set_parent(stream_class
, trace
);
681 g_ptr_array_add(trace
->stream_classes
, stream_class
);
684 * At this point we know that the function will be successful.
685 * Therefore we can replace the trace and stream class field
686 * types with what's in their validation output structure and
687 * mark them as valid. We can also replace the field types of
688 * all the event classes of the stream class and mark them as
691 bt_ctf_validation_replace_types(trace
, stream_class
, NULL
,
692 &trace_sc_validation_output
, trace_sc_validation_flags
);
694 stream_class
->valid
= 1;
697 * Put what was not moved in bt_ctf_validation_replace_types().
699 bt_ctf_validation_output_put_types(&trace_sc_validation_output
);
701 for (i
= 0; i
< event_class_count
; i
++) {
702 struct bt_ctf_event_class
*event_class
=
703 bt_ctf_stream_class_get_event_class_by_index(
706 bt_ctf_validation_replace_types(NULL
, NULL
, event_class
,
707 &ec_validation_outputs
[i
], ec_validation_flags
);
708 event_class
->valid
= 1;
712 * Put what was not moved in
713 * bt_ctf_validation_replace_types().
715 bt_ctf_validation_output_put_types(&ec_validation_outputs
[i
]);
719 * Freeze the trace and the stream class.
721 bt_ctf_stream_class_freeze(stream_class
);
722 bt_ctf_trace_freeze(trace
);
724 /* Notifiy listeners of the trace's schema modification. */
725 bt_ctf_stream_class_visit(stream_class
,
726 bt_ctf_trace_object_modification
, trace
);
729 bt_object_set_parent(stream_class
, NULL
);
731 if (ec_validation_outputs
) {
732 for (i
= 0; i
< event_class_count
; i
++) {
733 bt_ctf_validation_output_put_types(
734 &ec_validation_outputs
[i
]);
739 g_free(ec_validation_outputs
);
740 bt_ctf_validation_output_put_types(&trace_sc_validation_output
);
741 bt_put(current_parent_trace
);
742 assert(!packet_header_type
);
743 assert(!packet_context_type
);
744 assert(!event_header_type
);
745 assert(!stream_event_ctx_type
);
750 int64_t bt_ctf_trace_get_stream_count(struct bt_ctf_trace
*trace
)
759 ret
= (int64_t) trace
->streams
->len
;
765 struct bt_ctf_stream
*bt_ctf_trace_get_stream_by_index(
766 struct bt_ctf_trace
*trace
,
769 struct bt_ctf_stream
*stream
= NULL
;
771 if (!trace
|| index
>= trace
->streams
->len
) {
775 stream
= bt_get(g_ptr_array_index(trace
->streams
, index
));
781 int64_t bt_ctf_trace_get_stream_class_count(struct bt_ctf_trace
*trace
)
790 ret
= (int64_t) trace
->stream_classes
->len
;
795 struct bt_ctf_stream_class
*bt_ctf_trace_get_stream_class_by_index(
796 struct bt_ctf_trace
*trace
, uint64_t index
)
798 struct bt_ctf_stream_class
*stream_class
= NULL
;
800 if (!trace
|| index
>= trace
->stream_classes
->len
) {
804 stream_class
= g_ptr_array_index(trace
->stream_classes
, index
);
805 bt_get(stream_class
);
810 struct bt_ctf_stream_class
*bt_ctf_trace_get_stream_class_by_id(
811 struct bt_ctf_trace
*trace
, uint64_t id_param
)
814 struct bt_ctf_stream_class
*stream_class
= NULL
;
815 int64_t id
= (int64_t) id_param
;
817 if (!trace
|| id
< 0) {
821 for (i
= 0; i
< trace
->stream_classes
->len
; i
++) {
822 struct bt_ctf_stream_class
*stream_class_candidate
;
824 stream_class_candidate
=
825 g_ptr_array_index(trace
->stream_classes
, i
);
827 if (bt_ctf_stream_class_get_id(stream_class_candidate
) ==
829 stream_class
= stream_class_candidate
;
830 bt_get(stream_class
);
839 struct bt_ctf_clock_class
*bt_ctf_trace_get_clock_class_by_name(
840 struct bt_ctf_trace
*trace
, const char *name
)
843 struct bt_ctf_clock_class
*clock_class
= NULL
;
845 if (!trace
|| !name
) {
849 for (i
= 0; i
< trace
->clocks
->len
; i
++) {
850 struct bt_ctf_clock_class
*cur_clk
=
851 g_ptr_array_index(trace
->clocks
, i
);
852 const char *cur_clk_name
= bt_ctf_clock_class_get_name(cur_clk
);
858 if (!strcmp(cur_clk_name
, name
)) {
859 clock_class
= cur_clk
;
870 bool bt_ctf_trace_has_clock_class(struct bt_ctf_trace
*trace
,
871 struct bt_ctf_clock_class
*clock_class
)
873 struct search_query query
= { .value
= clock_class
, .found
= 0 };
878 g_ptr_array_foreach(trace
->clocks
, value_exists
, &query
);
883 const char *get_byte_order_string(enum bt_ctf_byte_order byte_order
)
887 switch (byte_order
) {
888 case BT_CTF_BYTE_ORDER_LITTLE_ENDIAN
:
891 case BT_CTF_BYTE_ORDER_BIG_ENDIAN
:
894 case BT_CTF_BYTE_ORDER_NATIVE
:
905 int append_trace_metadata(struct bt_ctf_trace
*trace
,
906 struct metadata_context
*context
)
908 unsigned char *uuid
= trace
->uuid
;
911 if (trace
->native_byte_order
== BT_CTF_BYTE_ORDER_NATIVE
) {
916 g_string_append(context
->string
, "trace {\n");
917 g_string_append(context
->string
, "\tmajor = 1;\n");
918 g_string_append(context
->string
, "\tminor = 8;\n");
919 assert(trace
->native_byte_order
== BT_CTF_BYTE_ORDER_LITTLE_ENDIAN
||
920 trace
->native_byte_order
== BT_CTF_BYTE_ORDER_BIG_ENDIAN
||
921 trace
->native_byte_order
== BT_CTF_BYTE_ORDER_NETWORK
);
923 if (trace
->uuid_set
) {
924 g_string_append_printf(context
->string
,
925 "\tuuid = \"%02x%02x%02x%02x-%02x%02x-%02x%02x-%02x%02x-%02x%02x%02x%02x%02x%02x\";\n",
926 uuid
[0], uuid
[1], uuid
[2], uuid
[3],
927 uuid
[4], uuid
[5], uuid
[6], uuid
[7],
928 uuid
[8], uuid
[9], uuid
[10], uuid
[11],
929 uuid
[12], uuid
[13], uuid
[14], uuid
[15]);
932 g_string_append_printf(context
->string
, "\tbyte_order = %s;\n",
933 get_byte_order_string(trace
->native_byte_order
));
935 g_string_append(context
->string
, "\tpacket.header := ");
936 context
->current_indentation_level
++;
937 g_string_assign(context
->field_name
, "");
938 ret
= bt_ctf_field_type_serialize(trace
->packet_header_type
,
943 context
->current_indentation_level
--;
945 g_string_append(context
->string
, ";\n};\n\n");
951 void append_env_metadata(struct bt_ctf_trace
*trace
,
952 struct metadata_context
*context
)
957 env_size
= bt_ctf_attributes_get_count(trace
->environment
);
963 g_string_append(context
->string
, "env {\n");
965 for (i
= 0; i
< env_size
; i
++) {
966 struct bt_value
*env_field_value_obj
= NULL
;
967 const char *entry_name
;
969 entry_name
= bt_ctf_attributes_get_field_name(
970 trace
->environment
, i
);
971 env_field_value_obj
= bt_ctf_attributes_get_field_value(
972 trace
->environment
, i
);
974 if (!entry_name
|| !env_field_value_obj
) {
978 switch (bt_value_get_type(env_field_value_obj
)) {
979 case BT_VALUE_TYPE_INTEGER
:
984 ret
= bt_value_integer_get(env_field_value_obj
,
991 g_string_append_printf(context
->string
,
992 "\t%s = %" PRId64
";\n", entry_name
,
996 case BT_VALUE_TYPE_STRING
:
999 const char *str_value
;
1000 char *escaped_str
= NULL
;
1002 ret
= bt_value_string_get(env_field_value_obj
,
1009 escaped_str
= g_strescape(str_value
, NULL
);
1015 g_string_append_printf(context
->string
,
1016 "\t%s = \"%s\";\n", entry_name
, escaped_str
);
1026 BT_PUT(env_field_value_obj
);
1029 g_string_append(context
->string
, "};\n\n");
1032 char *bt_ctf_trace_get_metadata_string(struct bt_ctf_trace
*trace
)
1034 char *metadata
= NULL
;
1035 struct metadata_context
*context
= NULL
;
1043 context
= g_new0(struct metadata_context
, 1);
1048 context
->field_name
= g_string_sized_new(DEFAULT_IDENTIFIER_SIZE
);
1049 context
->string
= g_string_sized_new(DEFAULT_METADATA_STRING_SIZE
);
1050 g_string_append(context
->string
, "/* CTF 1.8 */\n\n");
1051 if (append_trace_metadata(trace
, context
)) {
1054 append_env_metadata(trace
, context
);
1055 g_ptr_array_foreach(trace
->clocks
,
1056 (GFunc
)bt_ctf_clock_class_serialize
, context
);
1058 for (i
= 0; i
< trace
->stream_classes
->len
; i
++) {
1059 err
= bt_ctf_stream_class_serialize(
1060 trace
->stream_classes
->pdata
[i
], context
);
1066 metadata
= context
->string
->str
;
1068 g_string_free(context
->string
, err
? TRUE
: FALSE
);
1069 g_string_free(context
->field_name
, TRUE
);
1075 enum bt_ctf_byte_order
bt_ctf_trace_get_native_byte_order(
1076 struct bt_ctf_trace
*trace
)
1078 enum bt_ctf_byte_order ret
= BT_CTF_BYTE_ORDER_UNKNOWN
;
1084 ret
= trace
->native_byte_order
;
1090 int bt_ctf_trace_set_native_byte_order(struct bt_ctf_trace
*trace
,
1091 enum bt_ctf_byte_order byte_order
)
1095 if (!trace
|| trace
->frozen
) {
1100 if (byte_order
!= BT_CTF_BYTE_ORDER_LITTLE_ENDIAN
&&
1101 byte_order
!= BT_CTF_BYTE_ORDER_BIG_ENDIAN
&&
1102 byte_order
!= BT_CTF_BYTE_ORDER_NETWORK
) {
1107 trace
->native_byte_order
= byte_order
;
1113 struct bt_ctf_field_type
*bt_ctf_trace_get_packet_header_type(
1114 struct bt_ctf_trace
*trace
)
1116 struct bt_ctf_field_type
*field_type
= NULL
;
1122 bt_get(trace
->packet_header_type
);
1123 field_type
= trace
->packet_header_type
;
1128 int bt_ctf_trace_set_packet_header_type(struct bt_ctf_trace
*trace
,
1129 struct bt_ctf_field_type
*packet_header_type
)
1133 if (!trace
|| trace
->frozen
) {
1138 /* packet_header_type must be a structure. */
1139 if (packet_header_type
&&
1140 bt_ctf_field_type_get_type_id(packet_header_type
) !=
1141 BT_CTF_FIELD_TYPE_ID_STRUCT
) {
1146 bt_put(trace
->packet_header_type
);
1147 trace
->packet_header_type
= bt_get(packet_header_type
);
1153 int64_t get_stream_class_count(void *element
)
1155 return bt_ctf_trace_get_stream_class_count(
1156 (struct bt_ctf_trace
*) element
);
1160 void *get_stream_class(void *element
, int i
)
1162 return bt_ctf_trace_get_stream_class_by_index(
1163 (struct bt_ctf_trace
*) element
, i
);
1167 int visit_stream_class(void *object
, bt_ctf_visitor visitor
,void *data
)
1169 return bt_ctf_stream_class_visit(object
, visitor
, data
);
1172 int bt_ctf_trace_visit(struct bt_ctf_trace
*trace
,
1173 bt_ctf_visitor visitor
, void *data
)
1176 struct bt_ctf_object obj
=
1177 { .object
= trace
, .type
= BT_CTF_OBJECT_TYPE_TRACE
};
1179 if (!trace
|| !visitor
) {
1184 ret
= visitor_helper(&obj
, get_stream_class_count
,
1185 get_stream_class
, visit_stream_class
, visitor
, data
);
1191 int invoke_listener(struct bt_ctf_object
*object
, void *data
)
1193 struct listener_wrapper
*listener_wrapper
= data
;
1195 listener_wrapper
->listener(object
, listener_wrapper
->data
);
1199 int bt_ctf_trace_add_listener(struct bt_ctf_trace
*trace
,
1200 bt_ctf_listener_cb listener
, void *listener_data
)
1203 struct listener_wrapper
*listener_wrapper
=
1204 g_new0(struct listener_wrapper
, 1);
1206 if (!trace
|| !listener
|| !listener_wrapper
) {
1211 listener_wrapper
->listener
= listener
;
1212 listener_wrapper
->data
= listener_data
;
1214 /* Visit the current schema. */
1215 ret
= bt_ctf_trace_visit(trace
, invoke_listener
, listener_wrapper
);
1221 * Add listener to the array of callbacks which will be invoked on
1224 g_ptr_array_add(trace
->listeners
, listener_wrapper
);
1227 g_free(listener_wrapper
);
1232 int bt_ctf_trace_object_modification(struct bt_ctf_object
*object
,
1236 struct bt_ctf_trace
*trace
= trace_ptr
;
1241 if (trace
->listeners
->len
== 0) {
1245 for (i
= 0; i
< trace
->listeners
->len
; i
++) {
1246 struct listener_wrapper
*listener
=
1247 g_ptr_array_index(trace
->listeners
, i
);
1249 listener
->listener(object
, listener
->data
);
1256 struct bt_ctf_field_type
*get_field_type(enum field_type_alias alias
)
1259 unsigned int alignment
, size
;
1260 struct bt_ctf_field_type
*field_type
= NULL
;
1262 if (alias
>= NR_FIELD_TYPE_ALIAS
) {
1266 alignment
= field_type_aliases_alignments
[alias
];
1267 size
= field_type_aliases_sizes
[alias
];
1268 field_type
= bt_ctf_field_type_integer_create(size
);
1269 ret
= bt_ctf_field_type_set_alignment(field_type
, alignment
);
1278 void bt_ctf_trace_freeze(struct bt_ctf_trace
*trace
)
1282 bt_ctf_field_type_freeze(trace
->packet_header_type
);
1283 bt_ctf_attributes_freeze(trace
->environment
);
1285 for (i
= 0; i
< trace
->clocks
->len
; i
++) {
1286 struct bt_ctf_clock_class
*clock_class
=
1287 g_ptr_array_index(trace
->clocks
, i
);
1289 bt_ctf_clock_class_freeze(clock_class
);
1295 bool bt_ctf_trace_is_static(struct bt_ctf_trace
*trace
)
1297 bool is_static
= false;
1303 is_static
= trace
->is_static
;
1309 int bt_ctf_trace_set_is_static(struct bt_ctf_trace
*trace
)
1318 trace
->is_static
= true;
1319 bt_ctf_trace_freeze(trace
);