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-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-ir/field-types-internal.h>
38 #include <babeltrace/ctf-ir/attributes-internal.h>
39 #include <babeltrace/ctf-ir/validation-internal.h>
40 #include <babeltrace/ctf-ir/visitor-internal.h>
41 #include <babeltrace/ctf-ir/utils.h>
42 #include <babeltrace/plugin/notification/schema.h>
43 #include <babeltrace/compiler.h>
44 #include <babeltrace/values.h>
45 #include <babeltrace/ref.h>
46 #include <babeltrace/endian.h>
48 #define DEFAULT_IDENTIFIER_SIZE 128
49 #define DEFAULT_METADATA_STRING_SIZE 4096
51 struct listener_wrapper
{
52 bt_ctf_listener_cb listener
;
57 void bt_ctf_trace_destroy(struct bt_object
*obj
);
59 int init_trace_packet_header(struct bt_ctf_trace
*trace
);
61 void bt_ctf_trace_freeze(struct bt_ctf_trace
*trace
);
64 const unsigned int field_type_aliases_alignments
[] = {
65 [FIELD_TYPE_ALIAS_UINT5_T
] = 1,
66 [FIELD_TYPE_ALIAS_UINT8_T
... FIELD_TYPE_ALIAS_UINT16_T
] = 8,
67 [FIELD_TYPE_ALIAS_UINT27_T
] = 1,
68 [FIELD_TYPE_ALIAS_UINT32_T
... FIELD_TYPE_ALIAS_UINT64_T
] = 8,
72 const unsigned int field_type_aliases_sizes
[] = {
73 [FIELD_TYPE_ALIAS_UINT5_T
] = 5,
74 [FIELD_TYPE_ALIAS_UINT8_T
] = 8,
75 [FIELD_TYPE_ALIAS_UINT16_T
] = 16,
76 [FIELD_TYPE_ALIAS_UINT27_T
] = 27,
77 [FIELD_TYPE_ALIAS_UINT32_T
] = 32,
78 [FIELD_TYPE_ALIAS_UINT64_T
] = 64,
81 struct bt_ctf_trace
*bt_ctf_trace_create(void)
83 struct bt_ctf_trace
*trace
= NULL
;
85 trace
= g_new0(struct bt_ctf_trace
, 1);
90 bt_ctf_trace_set_byte_order(trace
, BT_CTF_BYTE_ORDER_NATIVE
);
91 bt_object_init(trace
, bt_ctf_trace_destroy
);
92 trace
->clocks
= g_ptr_array_new_with_free_func(
93 (GDestroyNotify
) bt_put
);
94 trace
->streams
= g_ptr_array_new_with_free_func(
95 (GDestroyNotify
) bt_object_release
);
96 trace
->stream_classes
= g_ptr_array_new_with_free_func(
97 (GDestroyNotify
) bt_object_release
);
98 if (!trace
->clocks
|| !trace
->stream_classes
|| !trace
->streams
) {
102 /* Generate a trace UUID */
103 uuid_generate(trace
->uuid
);
104 if (init_trace_packet_header(trace
)) {
108 /* Create the environment array object */
109 trace
->environment
= bt_ctf_attributes_create();
110 if (!trace
->environment
) {
114 trace
->listeners
= g_ptr_array_new_with_free_func(
115 (GDestroyNotify
) g_free
);
116 if (!trace
->listeners
) {
127 void bt_ctf_trace_destroy(struct bt_object
*obj
)
129 struct bt_ctf_trace
*trace
;
131 trace
= container_of(obj
, struct bt_ctf_trace
, base
);
132 if (trace
->environment
) {
133 bt_ctf_attributes_destroy(trace
->environment
);
137 g_ptr_array_free(trace
->clocks
, TRUE
);
140 if (trace
->streams
) {
141 g_ptr_array_free(trace
->streams
, TRUE
);
144 if (trace
->stream_classes
) {
145 g_ptr_array_free(trace
->stream_classes
, TRUE
);
148 if (trace
->listeners
) {
149 g_ptr_array_free(trace
->listeners
, TRUE
);
152 bt_put(trace
->packet_header_type
);
156 int bt_ctf_trace_set_environment_field(struct bt_ctf_trace
*trace
,
157 const char *name
, struct bt_value
*value
)
161 if (!trace
|| !name
|| !value
||
162 bt_ctf_validate_identifier(name
) ||
163 !(bt_value_is_integer(value
) || bt_value_is_string(value
))) {
168 if (strchr(name
, ' ')) {
175 * New environment fields may be added to a frozen trace,
176 * but existing fields may not be changed.
178 * The object passed is frozen like all other attributes.
180 struct bt_value
*attribute
=
181 bt_ctf_attributes_get_field_value_by_name(
182 trace
->environment
, name
);
190 bt_value_freeze(value
);
193 ret
= bt_ctf_attributes_set_field_value(trace
->environment
, name
,
200 int bt_ctf_trace_set_environment_field_string(struct bt_ctf_trace
*trace
,
201 const char *name
, const char *value
)
204 struct bt_value
*env_value_string_obj
= NULL
;
206 if (!trace
|| !name
|| !value
) {
213 * New environment fields may be added to a frozen trace,
214 * but existing fields may not be changed.
216 struct bt_value
*attribute
=
217 bt_ctf_attributes_get_field_value_by_name(
218 trace
->environment
, name
);
227 env_value_string_obj
= bt_value_string_create_init(value
);
229 if (!env_value_string_obj
) {
235 bt_value_freeze(env_value_string_obj
);
237 ret
= bt_ctf_trace_set_environment_field(trace
, name
,
238 env_value_string_obj
);
241 BT_PUT(env_value_string_obj
);
245 int bt_ctf_trace_set_environment_field_integer(struct bt_ctf_trace
*trace
,
246 const char *name
, int64_t value
)
249 struct bt_value
*env_value_integer_obj
= NULL
;
251 if (!trace
|| !name
) {
258 * New environment fields may be added to a frozen trace,
259 * but existing fields may not be changed.
261 struct bt_value
*attribute
=
262 bt_ctf_attributes_get_field_value_by_name(
263 trace
->environment
, name
);
272 env_value_integer_obj
= bt_value_integer_create_init(value
);
273 if (!env_value_integer_obj
) {
278 ret
= bt_ctf_trace_set_environment_field(trace
, name
,
279 env_value_integer_obj
);
281 bt_value_freeze(env_value_integer_obj
);
284 BT_PUT(env_value_integer_obj
);
288 int bt_ctf_trace_get_environment_field_count(struct bt_ctf_trace
*trace
)
297 ret
= bt_ctf_attributes_get_count(trace
->environment
);
304 bt_ctf_trace_get_environment_field_name(struct bt_ctf_trace
*trace
,
307 const char *ret
= NULL
;
313 ret
= bt_ctf_attributes_get_field_name(trace
->environment
, index
);
319 struct bt_value
*bt_ctf_trace_get_environment_field_value(
320 struct bt_ctf_trace
*trace
, int index
)
322 struct bt_value
*ret
= NULL
;
328 ret
= bt_ctf_attributes_get_field_value(trace
->environment
, index
);
334 struct bt_value
*bt_ctf_trace_get_environment_field_value_by_name(
335 struct bt_ctf_trace
*trace
, const char *name
)
337 struct bt_value
*ret
= NULL
;
339 if (!trace
|| !name
) {
343 ret
= bt_ctf_attributes_get_field_value_by_name(trace
->environment
,
350 int bt_ctf_trace_add_clock(struct bt_ctf_trace
*trace
,
351 struct bt_ctf_clock
*clock
)
354 struct search_query query
= { .value
= clock
, .found
= 0 };
356 if (!trace
|| !bt_ctf_clock_is_valid(clock
)) {
361 /* Check for duplicate clocks */
362 g_ptr_array_foreach(trace
->clocks
, value_exists
, &query
);
369 g_ptr_array_add(trace
->clocks
, clock
);
371 if (!trace
->is_created_by_writer
) {
373 * Non-writer mode trace: disable clock value functions
374 * because clock values are per-stream in that
377 clock
->has_value
= 0;
381 bt_ctf_clock_freeze(clock
);
387 int bt_ctf_trace_get_clock_count(struct bt_ctf_trace
*trace
)
395 ret
= trace
->clocks
->len
;
400 struct bt_ctf_clock
*bt_ctf_trace_get_clock(struct bt_ctf_trace
*trace
,
403 struct bt_ctf_clock
*clock
= NULL
;
405 if (!trace
|| index
< 0 || index
>= trace
->clocks
->len
) {
409 clock
= g_ptr_array_index(trace
->clocks
, index
);
415 int bt_ctf_trace_add_stream_class(struct bt_ctf_trace
*trace
,
416 struct bt_ctf_stream_class
*stream_class
)
420 struct bt_ctf_validation_output trace_sc_validation_output
= { 0 };
421 struct bt_ctf_validation_output
*ec_validation_outputs
= NULL
;
422 const enum bt_ctf_validation_flag trace_sc_validation_flags
=
423 BT_CTF_VALIDATION_FLAG_TRACE
|
424 BT_CTF_VALIDATION_FLAG_STREAM
;
425 const enum bt_ctf_validation_flag ec_validation_flags
=
426 BT_CTF_VALIDATION_FLAG_EVENT
;
427 struct bt_ctf_field_type
*packet_header_type
= NULL
;
428 struct bt_ctf_field_type
*packet_context_type
= NULL
;
429 struct bt_ctf_field_type
*event_header_type
= NULL
;
430 struct bt_ctf_field_type
*stream_event_ctx_type
= NULL
;
431 int event_class_count
;
432 struct bt_ctf_clock
*clock_to_add_to_trace
= NULL
;
433 struct bt_ctf_trace
*current_parent_trace
= NULL
;
435 if (!trace
|| !stream_class
) {
440 current_parent_trace
= bt_ctf_stream_class_get_trace(stream_class
);
441 if (current_parent_trace
) {
442 /* Stream class is already associated to a trace, abort. */
448 bt_ctf_stream_class_get_event_class_count(stream_class
);
449 assert(event_class_count
>= 0);
451 /* Check for duplicate stream classes */
452 for (i
= 0; i
< trace
->stream_classes
->len
; i
++) {
453 if (trace
->stream_classes
->pdata
[i
] == stream_class
) {
454 /* Stream class already registered to the trace */
461 * If the stream class has a clock, register this clock to this
462 * trace if not already done.
464 if (stream_class
->clock
) {
465 const char *clock_name
=
466 bt_ctf_clock_get_name(stream_class
->clock
);
467 struct bt_ctf_clock
*trace_clock
;
470 trace_clock
= bt_ctf_trace_get_clock_by_name(trace
, clock_name
);
473 if (trace_clock
!= stream_class
->clock
) {
475 * Error: two different clocks in the
476 * trace would share the same name.
482 clock_to_add_to_trace
= bt_get(stream_class
->clock
);
487 * We're about to freeze both the trace and the stream class.
488 * Also, each event class contained in this stream class are
491 * This trace, this stream class, and all its event classes
492 * should be valid at this point.
494 * Validate trace and stream class first, then each event
495 * class of this stream class can be validated individually.
498 bt_ctf_trace_get_packet_header_type(trace
);
499 packet_context_type
=
500 bt_ctf_stream_class_get_packet_context_type(stream_class
);
502 bt_ctf_stream_class_get_event_header_type(stream_class
);
503 stream_event_ctx_type
=
504 bt_ctf_stream_class_get_event_context_type(stream_class
);
505 ret
= bt_ctf_validate_class_types(trace
->environment
,
506 packet_header_type
, packet_context_type
, event_header_type
,
507 stream_event_ctx_type
, NULL
, NULL
, trace
->valid
,
508 stream_class
->valid
, 1, &trace_sc_validation_output
,
509 trace_sc_validation_flags
);
510 BT_PUT(packet_header_type
);
511 BT_PUT(packet_context_type
);
512 BT_PUT(event_header_type
);
513 BT_PUT(stream_event_ctx_type
);
517 * This means something went wrong during the validation
518 * process, not that the objects are invalid.
523 if ((trace_sc_validation_output
.valid_flags
&
524 trace_sc_validation_flags
) !=
525 trace_sc_validation_flags
) {
526 /* Invalid trace/stream class */
531 if (event_class_count
> 0) {
532 ec_validation_outputs
= g_new0(struct bt_ctf_validation_output
,
534 if (!ec_validation_outputs
) {
540 /* Validate each event class individually */
541 for (i
= 0; i
< event_class_count
; i
++) {
542 struct bt_ctf_event_class
*event_class
=
543 bt_ctf_stream_class_get_event_class(stream_class
, i
);
544 struct bt_ctf_field_type
*event_context_type
= NULL
;
545 struct bt_ctf_field_type
*event_payload_type
= NULL
;
548 bt_ctf_event_class_get_context_type(event_class
);
550 bt_ctf_event_class_get_payload_type(event_class
);
553 * It is important to use the field types returned by
554 * the previous trace and stream class validation here
555 * because copies could have been made.
557 ret
= bt_ctf_validate_class_types(trace
->environment
,
558 trace_sc_validation_output
.packet_header_type
,
559 trace_sc_validation_output
.packet_context_type
,
560 trace_sc_validation_output
.event_header_type
,
561 trace_sc_validation_output
.stream_event_ctx_type
,
562 event_context_type
, event_payload_type
,
563 1, 1, event_class
->valid
, &ec_validation_outputs
[i
],
564 ec_validation_flags
);
565 BT_PUT(event_context_type
);
566 BT_PUT(event_payload_type
);
573 if ((ec_validation_outputs
[i
].valid_flags
&
574 ec_validation_flags
) != ec_validation_flags
) {
575 /* Invalid event class */
581 stream_id
= bt_ctf_stream_class_get_id(stream_class
);
583 stream_id
= trace
->next_stream_id
++;
585 /* Try to assign a new stream id */
586 for (i
= 0; i
< trace
->stream_classes
->len
; i
++) {
587 if (stream_id
== bt_ctf_stream_class_get_id(
588 trace
->stream_classes
->pdata
[i
])) {
589 /* Duplicate stream id found */
595 if (bt_ctf_stream_class_set_id_no_check(stream_class
,
597 /* TODO Should retry with a different stream id */
603 bt_object_set_parent(stream_class
, trace
);
604 g_ptr_array_add(trace
->stream_classes
, stream_class
);
607 * At this point we know that the function will be successful.
608 * Therefore we can replace the trace and stream class field
609 * types with what's in their validation output structure and
610 * mark them as valid. We can also replace the field types of
611 * all the event classes of the stream class and mark them as
614 bt_ctf_validation_replace_types(trace
, stream_class
, NULL
,
615 &trace_sc_validation_output
, trace_sc_validation_flags
);
617 stream_class
->valid
= 1;
620 * Put what was not moved in bt_ctf_validation_replace_types().
622 bt_ctf_validation_output_put_types(&trace_sc_validation_output
);
624 for (i
= 0; i
< event_class_count
; i
++) {
625 struct bt_ctf_event_class
*event_class
=
626 bt_ctf_stream_class_get_event_class(stream_class
, i
);
628 bt_ctf_validation_replace_types(NULL
, NULL
, event_class
,
629 &ec_validation_outputs
[i
], ec_validation_flags
);
630 event_class
->valid
= 1;
634 * Put what was not moved in
635 * bt_ctf_validation_replace_types().
637 bt_ctf_validation_output_put_types(&ec_validation_outputs
[i
]);
641 * All field type byte orders set as "native" byte ordering can now be
642 * safely set to trace's own endianness, including the stream class'.
644 bt_ctf_field_type_set_native_byte_order(trace
->packet_header_type
,
646 bt_ctf_stream_class_set_byte_order(stream_class
, trace
->byte_order
);
648 /* Add stream class's clock if it exists */
649 if (clock_to_add_to_trace
) {
651 bt_ctf_trace_add_clock(trace
, clock_to_add_to_trace
);
652 assert(add_clock_ret
== 0);
656 * Freeze the trace and the stream class.
658 bt_ctf_stream_class_freeze(stream_class
);
659 bt_ctf_trace_freeze(trace
);
661 /* Notifiy listeners of the trace's schema modification. */
662 bt_ctf_stream_class_visit(stream_class
,
663 bt_ctf_trace_element_modification
, trace
);
666 bt_object_set_parent(stream_class
, NULL
);
668 if (ec_validation_outputs
) {
669 for (i
= 0; i
< event_class_count
; i
++) {
670 bt_ctf_validation_output_put_types(
671 &ec_validation_outputs
[i
]);
676 g_free(ec_validation_outputs
);
677 bt_ctf_validation_output_put_types(&trace_sc_validation_output
);
678 BT_PUT(clock_to_add_to_trace
);
679 bt_put(current_parent_trace
);
680 assert(!packet_header_type
);
681 assert(!packet_context_type
);
682 assert(!event_header_type
);
683 assert(!stream_event_ctx_type
);
688 int bt_ctf_trace_get_stream_class_count(struct bt_ctf_trace
*trace
)
697 ret
= trace
->stream_classes
->len
;
702 struct bt_ctf_stream_class
*bt_ctf_trace_get_stream_class(
703 struct bt_ctf_trace
*trace
, int index
)
705 struct bt_ctf_stream_class
*stream_class
= NULL
;
707 if (!trace
|| index
< 0 || index
>= trace
->stream_classes
->len
) {
711 stream_class
= g_ptr_array_index(trace
->stream_classes
, index
);
712 bt_get(stream_class
);
717 struct bt_ctf_stream_class
*bt_ctf_trace_get_stream_class_by_id(
718 struct bt_ctf_trace
*trace
, uint32_t id
)
721 struct bt_ctf_stream_class
*stream_class
= NULL
;
727 for (i
= 0; i
< trace
->stream_classes
->len
; i
++) {
728 struct bt_ctf_stream_class
*stream_class_candidate
;
730 stream_class_candidate
=
731 g_ptr_array_index(trace
->stream_classes
, i
);
733 if (bt_ctf_stream_class_get_id(stream_class_candidate
) ==
735 stream_class
= stream_class_candidate
;
736 bt_get(stream_class
);
745 struct bt_ctf_clock
*bt_ctf_trace_get_clock_by_name(
746 struct bt_ctf_trace
*trace
, const char *name
)
749 struct bt_ctf_clock
*clock
= NULL
;
751 if (!trace
|| !name
) {
755 for (i
= 0; i
< trace
->clocks
->len
; i
++) {
756 struct bt_ctf_clock
*cur_clk
=
757 g_ptr_array_index(trace
->clocks
, i
);
758 const char *cur_clk_name
= bt_ctf_clock_get_name(cur_clk
);
764 if (!strcmp(cur_clk_name
, name
)) {
776 const char *get_byte_order_string(int byte_order
)
780 switch (byte_order
) {
796 int append_trace_metadata(struct bt_ctf_trace
*trace
,
797 struct metadata_context
*context
)
799 unsigned char *uuid
= trace
->uuid
;
802 g_string_append(context
->string
, "trace {\n");
804 g_string_append(context
->string
, "\tmajor = 1;\n");
805 g_string_append(context
->string
, "\tminor = 8;\n");
807 g_string_append_printf(context
->string
,
808 "\tuuid = \"%02x%02x%02x%02x-%02x%02x-%02x%02x-%02x%02x-%02x%02x%02x%02x%02x%02x\";\n",
809 uuid
[0], uuid
[1], uuid
[2], uuid
[3],
810 uuid
[4], uuid
[5], uuid
[6], uuid
[7],
811 uuid
[8], uuid
[9], uuid
[10], uuid
[11],
812 uuid
[12], uuid
[13], uuid
[14], uuid
[15]);
813 g_string_append_printf(context
->string
, "\tbyte_order = %s;\n",
814 get_byte_order_string(trace
->byte_order
));
816 g_string_append(context
->string
, "\tpacket.header := ");
817 context
->current_indentation_level
++;
818 g_string_assign(context
->field_name
, "");
819 ret
= bt_ctf_field_type_serialize(trace
->packet_header_type
,
824 context
->current_indentation_level
--;
826 g_string_append(context
->string
, ";\n};\n\n");
832 void append_env_metadata(struct bt_ctf_trace
*trace
,
833 struct metadata_context
*context
)
838 env_size
= bt_ctf_attributes_get_count(trace
->environment
);
844 g_string_append(context
->string
, "env {\n");
846 for (i
= 0; i
< env_size
; i
++) {
847 struct bt_value
*env_field_value_obj
= NULL
;
848 const char *entry_name
;
850 entry_name
= bt_ctf_attributes_get_field_name(
851 trace
->environment
, i
);
852 env_field_value_obj
= bt_ctf_attributes_get_field_value(
853 trace
->environment
, i
);
855 if (!entry_name
|| !env_field_value_obj
) {
859 switch (bt_value_get_type(env_field_value_obj
)) {
860 case BT_VALUE_TYPE_INTEGER
:
865 ret
= bt_value_integer_get(env_field_value_obj
,
872 g_string_append_printf(context
->string
,
873 "\t%s = %" PRId64
";\n", entry_name
,
877 case BT_VALUE_TYPE_STRING
:
880 const char *str_value
;
881 char *escaped_str
= NULL
;
883 ret
= bt_value_string_get(env_field_value_obj
,
890 escaped_str
= g_strescape(str_value
, NULL
);
896 g_string_append_printf(context
->string
,
897 "\t%s = \"%s\";\n", entry_name
, escaped_str
);
907 BT_PUT(env_field_value_obj
);
910 g_string_append(context
->string
, "};\n\n");
913 char *bt_ctf_trace_get_metadata_string(struct bt_ctf_trace
*trace
)
915 char *metadata
= NULL
;
916 struct metadata_context
*context
= NULL
;
924 context
= g_new0(struct metadata_context
, 1);
929 context
->field_name
= g_string_sized_new(DEFAULT_IDENTIFIER_SIZE
);
930 context
->string
= g_string_sized_new(DEFAULT_METADATA_STRING_SIZE
);
931 g_string_append(context
->string
, "/* CTF 1.8 */\n\n");
932 if (append_trace_metadata(trace
, context
)) {
935 append_env_metadata(trace
, context
);
936 g_ptr_array_foreach(trace
->clocks
,
937 (GFunc
)bt_ctf_clock_serialize
, context
);
939 for (i
= 0; i
< trace
->stream_classes
->len
; i
++) {
940 err
= bt_ctf_stream_class_serialize(
941 trace
->stream_classes
->pdata
[i
], context
);
947 metadata
= context
->string
->str
;
949 g_string_free(context
->string
, err
? TRUE
: FALSE
);
950 g_string_free(context
->field_name
, TRUE
);
956 enum bt_ctf_byte_order
bt_ctf_trace_get_byte_order(struct bt_ctf_trace
*trace
)
958 enum bt_ctf_byte_order ret
= BT_CTF_BYTE_ORDER_UNKNOWN
;
964 switch (trace
->byte_order
) {
966 ret
= BT_CTF_BYTE_ORDER_BIG_ENDIAN
;
969 ret
= BT_CTF_BYTE_ORDER_LITTLE_ENDIAN
;
978 int bt_ctf_trace_set_byte_order(struct bt_ctf_trace
*trace
,
979 enum bt_ctf_byte_order byte_order
)
982 int internal_byte_order
;
984 if (!trace
|| trace
->frozen
) {
989 switch (byte_order
) {
990 case BT_CTF_BYTE_ORDER_NATIVE
:
992 * This doesn't make sense since the CTF specification defines
993 * the "native" byte order as "the byte order described in the
994 * trace description". However, this behavior had been
995 * implemented as part of v1.2 and is kept to maintain
998 * This may be changed on a major version bump only.
1000 internal_byte_order
= (G_BYTE_ORDER
== G_LITTLE_ENDIAN
) ?
1001 LITTLE_ENDIAN
: BIG_ENDIAN
;
1003 case BT_CTF_BYTE_ORDER_LITTLE_ENDIAN
:
1004 internal_byte_order
= LITTLE_ENDIAN
;
1006 case BT_CTF_BYTE_ORDER_BIG_ENDIAN
:
1007 case BT_CTF_BYTE_ORDER_NETWORK
:
1008 internal_byte_order
= BIG_ENDIAN
;
1015 trace
->byte_order
= internal_byte_order
;
1020 struct bt_ctf_field_type
*bt_ctf_trace_get_packet_header_type(
1021 struct bt_ctf_trace
*trace
)
1023 struct bt_ctf_field_type
*field_type
= NULL
;
1029 bt_get(trace
->packet_header_type
);
1030 field_type
= trace
->packet_header_type
;
1035 int bt_ctf_trace_set_packet_header_type(struct bt_ctf_trace
*trace
,
1036 struct bt_ctf_field_type
*packet_header_type
)
1040 if (!trace
|| !packet_header_type
|| trace
->frozen
) {
1045 /* packet_header_type must be a structure */
1046 if (bt_ctf_field_type_get_type_id(packet_header_type
) !=
1047 BT_CTF_TYPE_ID_STRUCT
) {
1052 bt_get(packet_header_type
);
1053 bt_put(trace
->packet_header_type
);
1054 trace
->packet_header_type
= packet_header_type
;
1060 int get_stream_class_count(void *element
)
1062 return bt_ctf_trace_get_stream_class_count(
1063 (struct bt_ctf_trace
*) element
);
1067 void *get_stream_class(void *element
, int i
)
1069 return bt_ctf_trace_get_stream_class(
1070 (struct bt_ctf_trace
*) element
, i
);
1074 int visit_stream_class(void *element
, bt_ctf_ir_visitor visitor
,void *data
)
1076 return bt_ctf_stream_class_visit(element
, visitor
, data
);
1079 int bt_ctf_trace_visit(struct bt_ctf_trace
*trace
,
1080 bt_ctf_ir_visitor visitor
, void *data
)
1083 struct bt_ctf_ir_element element
=
1084 { .element
= trace
, .type
= BT_CTF_IR_TYPE_TRACE
};
1086 if (!trace
|| !visitor
) {
1091 ret
= visitor_helper(&element
, get_stream_class_count
,
1092 get_stream_class
, visit_stream_class
, visitor
, data
);
1098 int invoke_listener(struct bt_ctf_ir_element
*element
, void *data
)
1100 struct listener_wrapper
*listener_wrapper
= data
;
1102 listener_wrapper
->listener(element
, listener_wrapper
->data
);
1106 int bt_ctf_trace_add_listener(struct bt_ctf_trace
*trace
,
1107 bt_ctf_listener_cb listener
, void *listener_data
)
1110 struct listener_wrapper
*listener_wrapper
=
1111 g_new0(struct listener_wrapper
, 1);
1113 if (!trace
|| !listener
|| !listener_wrapper
) {
1118 listener_wrapper
->listener
= listener
;
1119 listener_wrapper
->data
= listener_data
;
1121 /* Visit the current schema. */
1122 ret
= bt_ctf_trace_visit(trace
, invoke_listener
, listener_wrapper
);
1128 * Add listener to the array of callbacks which will be invoked on
1131 g_ptr_array_add(trace
->listeners
, listener_wrapper
);
1134 g_free(listener_wrapper
);
1139 int bt_ctf_trace_element_modification(struct bt_ctf_ir_element
*element
,
1143 struct bt_ctf_trace
*trace
= trace_ptr
;
1148 if (trace
->listeners
->len
== 0) {
1152 for (i
= 0; i
< trace
->listeners
->len
; i
++) {
1153 struct listener_wrapper
*listener
=
1154 g_ptr_array_index(trace
->listeners
, i
);
1156 listener
->listener(element
, listener
->data
);
1163 struct bt_ctf_field_type
*get_field_type(enum field_type_alias alias
)
1166 unsigned int alignment
, size
;
1167 struct bt_ctf_field_type
*field_type
= NULL
;
1169 if (alias
>= NR_FIELD_TYPE_ALIAS
) {
1173 alignment
= field_type_aliases_alignments
[alias
];
1174 size
= field_type_aliases_sizes
[alias
];
1175 field_type
= bt_ctf_field_type_integer_create(size
);
1176 ret
= bt_ctf_field_type_set_alignment(field_type
, alignment
);
1185 void bt_ctf_trace_freeze(struct bt_ctf_trace
*trace
)
1189 bt_ctf_field_type_freeze(trace
->packet_header_type
);
1190 bt_ctf_attributes_freeze(trace
->environment
);
1192 for (i
= 0; i
< trace
->clocks
->len
; i
++) {
1193 struct bt_ctf_clock
*clock
=
1194 g_ptr_array_index(trace
->clocks
, i
);
1196 bt_ctf_clock_freeze(clock
);
1203 int init_trace_packet_header(struct bt_ctf_trace
*trace
)
1206 struct bt_ctf_field
*magic
= NULL
, *uuid_array
= NULL
;
1207 struct bt_ctf_field_type
*_uint32_t
=
1208 get_field_type(FIELD_TYPE_ALIAS_UINT32_T
);
1209 struct bt_ctf_field_type
*_uint8_t
=
1210 get_field_type(FIELD_TYPE_ALIAS_UINT8_T
);
1211 struct bt_ctf_field_type
*trace_packet_header_type
=
1212 bt_ctf_field_type_structure_create();
1213 struct bt_ctf_field_type
*uuid_array_type
=
1214 bt_ctf_field_type_array_create(_uint8_t
, 16);
1216 if (!trace_packet_header_type
|| !uuid_array_type
) {
1221 ret
= bt_ctf_field_type_structure_add_field(trace_packet_header_type
,
1222 _uint32_t
, "magic");
1227 ret
= bt_ctf_field_type_structure_add_field(trace_packet_header_type
,
1228 uuid_array_type
, "uuid");
1233 ret
= bt_ctf_field_type_structure_add_field(trace_packet_header_type
,
1234 _uint32_t
, "stream_id");
1239 ret
= bt_ctf_trace_set_packet_header_type(trace
,
1240 trace_packet_header_type
);
1245 bt_put(uuid_array_type
);
1250 bt_put(trace_packet_header_type
);