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 #define BT_LOG_TAG "TRACE"
30 #include <babeltrace/lib-logging-internal.h>
32 #include <babeltrace/ctf-ir/trace-internal.h>
33 #include <babeltrace/ctf-ir/clock-class-internal.h>
34 #include <babeltrace/ctf-ir/stream-internal.h>
35 #include <babeltrace/ctf-ir/stream-class-internal.h>
36 #include <babeltrace/ctf-ir/event-internal.h>
37 #include <babeltrace/ctf-ir/event-class.h>
38 #include <babeltrace/ctf-ir/event-class-internal.h>
39 #include <babeltrace/ctf-writer/functor-internal.h>
40 #include <babeltrace/ctf-writer/clock-internal.h>
41 #include <babeltrace/ctf-ir/field-types-internal.h>
42 #include <babeltrace/ctf-ir/attributes-internal.h>
43 #include <babeltrace/ctf-ir/validation-internal.h>
44 #include <babeltrace/ctf-ir/visitor-internal.h>
45 #include <babeltrace/ctf-ir/utils.h>
46 #include <babeltrace/ctf-ir/utils-internal.h>
47 #include <babeltrace/compiler-internal.h>
48 #include <babeltrace/values.h>
49 #include <babeltrace/values-internal.h>
50 #include <babeltrace/ref.h>
51 #include <babeltrace/types.h>
52 #include <babeltrace/endian-internal.h>
58 #define DEFAULT_IDENTIFIER_SIZE 128
59 #define DEFAULT_METADATA_STRING_SIZE 4096
61 struct listener_wrapper
{
62 bt_listener_cb listener
;
66 struct bt_trace_is_static_listener_elem
{
67 bt_trace_is_static_listener func
;
68 bt_trace_listener_removed removed
;
73 void bt_trace_destroy(struct bt_object
*obj
);
75 void bt_trace_freeze(struct bt_trace
*trace
);
78 const unsigned int field_type_aliases_alignments
[] = {
79 [FIELD_TYPE_ALIAS_UINT5_T
] = 1,
80 [FIELD_TYPE_ALIAS_UINT8_T
... FIELD_TYPE_ALIAS_UINT16_T
] = 8,
81 [FIELD_TYPE_ALIAS_UINT27_T
] = 1,
82 [FIELD_TYPE_ALIAS_UINT32_T
... FIELD_TYPE_ALIAS_UINT64_T
] = 8,
86 const unsigned int field_type_aliases_sizes
[] = {
87 [FIELD_TYPE_ALIAS_UINT5_T
] = 5,
88 [FIELD_TYPE_ALIAS_UINT8_T
] = 8,
89 [FIELD_TYPE_ALIAS_UINT16_T
] = 16,
90 [FIELD_TYPE_ALIAS_UINT27_T
] = 27,
91 [FIELD_TYPE_ALIAS_UINT32_T
] = 32,
92 [FIELD_TYPE_ALIAS_UINT64_T
] = 64,
95 struct bt_trace
*bt_trace_create(void)
97 struct bt_trace
*trace
= NULL
;
99 trace
= g_new0(struct bt_trace
, 1);
101 BT_LOGE_STR("Failed to allocate one trace.");
105 BT_LOGD_STR("Creating trace object.");
106 trace
->native_byte_order
= BT_BYTE_ORDER_UNSPECIFIED
;
107 bt_object_init(trace
, bt_trace_destroy
);
108 trace
->clocks
= g_ptr_array_new_with_free_func(
109 (GDestroyNotify
) bt_put
);
110 if (!trace
->clocks
) {
111 BT_LOGE_STR("Failed to allocate one GPtrArray.");
115 trace
->streams
= g_ptr_array_new_with_free_func(
116 (GDestroyNotify
) bt_object_release
);
117 if (!trace
->streams
) {
118 BT_LOGE_STR("Failed to allocate one GPtrArray.");
122 trace
->stream_classes
= g_ptr_array_new_with_free_func(
123 (GDestroyNotify
) bt_object_release
);
124 if (!trace
->stream_classes
) {
125 BT_LOGE_STR("Failed to allocate one GPtrArray.");
129 /* Create the environment array object */
130 trace
->environment
= bt_attributes_create();
131 if (!trace
->environment
) {
132 BT_LOGE_STR("Cannot create empty attributes object.");
136 trace
->listeners
= g_ptr_array_new_with_free_func(
137 (GDestroyNotify
) g_free
);
138 if (!trace
->listeners
) {
139 BT_LOGE_STR("Failed to allocate one GPtrArray.");
143 trace
->is_static_listeners
= g_array_new(FALSE
, TRUE
,
144 sizeof(struct bt_trace_is_static_listener_elem
));
145 if (!trace
->is_static_listeners
) {
146 BT_LOGE_STR("Failed to allocate one GArray.");
150 BT_LOGD("Created trace object: addr=%p", trace
);
158 const char *bt_trace_get_name(struct bt_trace
*trace
)
160 const char *name
= NULL
;
163 BT_LOGW_STR("Invalid parameter: trace is NULL.");
171 name
= trace
->name
->str
;
176 int bt_trace_set_name(struct bt_trace
*trace
, const char *name
)
181 BT_LOGW_STR("Invalid parameter: trace is NULL.");
187 BT_LOGW_STR("Invalid parameter: name is NULL.");
193 BT_LOGW("Invalid parameter: trace is frozen: "
194 "addr=%p, name=\"%s\"",
195 trace
, bt_trace_get_name(trace
));
200 trace
->name
= trace
->name
? g_string_assign(trace
->name
, name
) :
203 BT_LOGE_STR("Failed to allocate one GString.");
208 BT_LOGV("Set trace's name: addr=%p, name=\"%s\"", trace
, name
);
214 const unsigned char *bt_trace_get_uuid(struct bt_trace
*trace
)
216 return trace
&& trace
->uuid_set
? trace
->uuid
: NULL
;
219 int bt_trace_set_uuid(struct bt_trace
*trace
, const unsigned char *uuid
)
224 BT_LOGW_STR("Invalid parameter: trace is NULL.");
230 BT_LOGW_STR("Invalid parameter: UUID is NULL.");
236 BT_LOGW("Invalid parameter: trace is frozen: "
237 "addr=%p, name=\"%s\"",
238 trace
, bt_trace_get_name(trace
));
243 memcpy(trace
->uuid
, uuid
, BABELTRACE_UUID_LEN
);
244 trace
->uuid_set
= BT_TRUE
;
245 BT_LOGV("Set trace's UUID: addr=%p, name=\"%s\", "
246 "uuid=\"%02x%02x%02x%02x-%02x%02x-%02x%02x-%02x%02x-%02x%02x%02x%02x%02x%02x\"",
247 trace
, bt_trace_get_name(trace
),
248 (unsigned int) uuid
[0],
249 (unsigned int) uuid
[1],
250 (unsigned int) uuid
[2],
251 (unsigned int) uuid
[3],
252 (unsigned int) uuid
[4],
253 (unsigned int) uuid
[5],
254 (unsigned int) uuid
[6],
255 (unsigned int) uuid
[7],
256 (unsigned int) uuid
[8],
257 (unsigned int) uuid
[9],
258 (unsigned int) uuid
[10],
259 (unsigned int) uuid
[11],
260 (unsigned int) uuid
[12],
261 (unsigned int) uuid
[13],
262 (unsigned int) uuid
[14],
263 (unsigned int) uuid
[15]);
269 void bt_trace_destroy(struct bt_object
*obj
)
271 struct bt_trace
*trace
;
273 trace
= container_of(obj
, struct bt_trace
, base
);
275 BT_LOGD("Destroying trace object: addr=%p, name=\"%s\"",
276 trace
, bt_trace_get_name(trace
));
279 * Call remove listeners first so that everything else still
280 * exists in the trace.
282 if (trace
->is_static_listeners
) {
285 for (i
= 0; i
< trace
->is_static_listeners
->len
; i
++) {
286 struct bt_trace_is_static_listener_elem elem
=
287 g_array_index(trace
->is_static_listeners
,
288 struct bt_trace_is_static_listener_elem
, i
);
291 elem
.removed(trace
, elem
.data
);
295 g_array_free(trace
->is_static_listeners
, TRUE
);
298 if (trace
->listeners
) {
299 g_ptr_array_free(trace
->listeners
, TRUE
);
302 if (trace
->environment
) {
303 BT_LOGD_STR("Destroying environment attributes.");
304 bt_attributes_destroy(trace
->environment
);
308 g_string_free(trace
->name
, TRUE
);
312 BT_LOGD_STR("Putting clock classes.");
313 g_ptr_array_free(trace
->clocks
, TRUE
);
316 if (trace
->streams
) {
317 BT_LOGD_STR("Destroying streams.");
318 g_ptr_array_free(trace
->streams
, TRUE
);
321 if (trace
->stream_classes
) {
322 BT_LOGD_STR("Destroying stream classes.");
323 g_ptr_array_free(trace
->stream_classes
, TRUE
);
326 BT_LOGD_STR("Putting packet header field type.");
327 bt_put(trace
->packet_header_type
);
331 int bt_trace_set_environment_field(struct bt_trace
*trace
,
332 const char *name
, struct bt_value
*value
)
337 BT_LOGW_STR("Invalid parameter: trace is NULL.");
343 BT_LOGW_STR("Invalid parameter: name is NULL.");
349 BT_LOGW_STR("Invalid parameter: value is NULL.");
354 if (!bt_identifier_is_valid(name
)) {
355 BT_LOGW("Invalid parameter: environment field's name is not a valid CTF identifier: "
356 "trace-addr=%p, trace-name=\"%s\", "
358 trace
, bt_trace_get_name(trace
), name
);
363 if (!bt_value_is_integer(value
) && !bt_value_is_string(value
)) {
364 BT_LOGW("Invalid parameter: environment field's value is not an integer or string value: "
365 "trace-addr=%p, trace-name=\"%s\", "
366 "env-name=\"%s\", env-value-type=%s",
367 trace
, bt_trace_get_name(trace
), name
,
368 bt_value_type_string(bt_value_get_type(value
)));
373 if (trace
->is_static
) {
374 BT_LOGW("Invalid parameter: trace is static: "
375 "addr=%p, name=\"%s\"",
376 trace
, bt_trace_get_name(trace
));
383 * New environment fields may be added to a frozen trace,
384 * but existing fields may not be changed.
386 * The object passed is frozen like all other attributes.
388 struct bt_value
*attribute
=
389 bt_attributes_get_field_value_by_name(
390 trace
->environment
, name
);
393 BT_LOGW("Invalid parameter: trace is frozen and environment field already exists with this name: "
394 "trace-addr=%p, trace-name=\"%s\", "
396 trace
, bt_trace_get_name(trace
), name
);
402 bt_value_freeze(value
);
405 ret
= bt_attributes_set_field_value(trace
->environment
, name
,
408 BT_LOGE("Cannot set environment field's value: "
409 "trace-addr=%p, trace-name=\"%s\", "
411 trace
, bt_trace_get_name(trace
), name
);
413 BT_LOGV("Set environment field's value: "
414 "trace-addr=%p, trace-name=\"%s\", "
415 "env-name=\"%s\", value-addr=%p",
416 trace
, bt_trace_get_name(trace
), name
, value
);
423 int bt_trace_set_environment_field_string(struct bt_trace
*trace
,
424 const char *name
, const char *value
)
427 struct bt_value
*env_value_string_obj
= NULL
;
430 BT_LOGW_STR("Invalid parameter: value is NULL.");
435 env_value_string_obj
= bt_value_string_create_init(value
);
436 if (!env_value_string_obj
) {
437 BT_LOGE_STR("Cannot create string value object.");
442 /* bt_trace_set_environment_field() logs errors */
443 ret
= bt_trace_set_environment_field(trace
, name
,
444 env_value_string_obj
);
447 bt_put(env_value_string_obj
);
451 int bt_trace_set_environment_field_integer(struct bt_trace
*trace
,
452 const char *name
, int64_t value
)
455 struct bt_value
*env_value_integer_obj
= NULL
;
457 env_value_integer_obj
= bt_value_integer_create_init(value
);
458 if (!env_value_integer_obj
) {
459 BT_LOGE_STR("Cannot create integer value object.");
464 /* bt_trace_set_environment_field() logs errors */
465 ret
= bt_trace_set_environment_field(trace
, name
,
466 env_value_integer_obj
);
469 bt_put(env_value_integer_obj
);
473 int64_t bt_trace_get_environment_field_count(struct bt_trace
*trace
)
478 BT_LOGW_STR("Invalid parameter: trace is NULL.");
483 ret
= bt_attributes_get_count(trace
->environment
);
491 bt_trace_get_environment_field_name_by_index(struct bt_trace
*trace
,
494 const char *ret
= NULL
;
497 BT_LOGW_STR("Invalid parameter: trace is NULL.");
501 ret
= bt_attributes_get_field_name(trace
->environment
, index
);
507 struct bt_value
*bt_trace_get_environment_field_value_by_index(
508 struct bt_trace
*trace
, uint64_t index
)
510 struct bt_value
*ret
= NULL
;
513 BT_LOGW_STR("Invalid parameter: trace is NULL.");
517 ret
= bt_attributes_get_field_value(trace
->environment
, index
);
523 struct bt_value
*bt_trace_get_environment_field_value_by_name(
524 struct bt_trace
*trace
, const char *name
)
526 struct bt_value
*ret
= NULL
;
529 BT_LOGW_STR("Invalid parameter: trace is NULL.");
534 BT_LOGW_STR("Invalid parameter: name is NULL.");
538 ret
= bt_attributes_get_field_value_by_name(trace
->environment
,
545 int bt_trace_add_clock_class(struct bt_trace
*trace
,
546 struct bt_clock_class
*clock_class
)
551 BT_LOGW_STR("Invalid parameter: trace is NULL.");
556 if (trace
->is_static
) {
557 BT_LOGW("Invalid parameter: trace is static: "
558 "addr=%p, name=\"%s\"",
559 trace
, bt_trace_get_name(trace
));
564 if (!bt_clock_class_is_valid(clock_class
)) {
565 BT_LOGW("Invalid parameter: clock class is invalid: "
566 "trace-addr=%p, trace-name=\"%s\", "
567 "clock-class-addr=%p, clock-class-name=\"%s\"",
568 trace
, bt_trace_get_name(trace
),
569 clock_class
, bt_clock_class_get_name(clock_class
));
574 /* Check for duplicate clock classes */
575 if (bt_trace_has_clock_class(trace
, clock_class
)) {
576 BT_LOGW("Invalid parameter: clock class already exists in trace: "
577 "trace-addr=%p, trace-name=\"%s\", "
578 "clock-class-addr=%p, clock-class-name=\"%s\"",
579 trace
, bt_trace_get_name(trace
),
580 clock_class
, bt_clock_class_get_name(clock_class
));
586 g_ptr_array_add(trace
->clocks
, clock_class
);
589 BT_LOGV_STR("Freezing added clock class because trace is frozen.");
590 bt_clock_class_freeze(clock_class
);
593 BT_LOGV("Added clock class to trace: "
594 "trace-addr=%p, trace-name=\"%s\", "
595 "clock-class-addr=%p, clock-class-name=\"%s\"",
596 trace
, bt_trace_get_name(trace
),
597 clock_class
, bt_clock_class_get_name(clock_class
));
603 int64_t bt_trace_get_clock_class_count(struct bt_trace
*trace
)
605 int64_t ret
= (int64_t) -1;
608 BT_LOGW_STR("Invalid parameter: trace is NULL.");
612 ret
= trace
->clocks
->len
;
617 struct bt_clock_class
*bt_trace_get_clock_class_by_index(
618 struct bt_trace
*trace
, uint64_t index
)
620 struct bt_clock_class
*clock_class
= NULL
;
623 BT_LOGW_STR("Invalid parameter: trace is NULL.");
627 if (index
>= trace
->clocks
->len
) {
628 BT_LOGW("Invalid parameter: index is out of bounds: "
629 "addr=%p, name=\"%s\", "
630 "index=%" PRIu64
", count=%u",
631 trace
, bt_trace_get_name(trace
),
632 index
, trace
->clocks
->len
);
636 clock_class
= g_ptr_array_index(trace
->clocks
, index
);
643 bool packet_header_field_type_is_valid(struct bt_trace
*trace
,
644 struct bt_field_type
*packet_header_type
)
647 bool is_valid
= true;
648 struct bt_field_type
*field_type
= NULL
;
650 if (!packet_header_type
) {
652 * No packet header field type: trace must have only
653 * one stream. At this point the stream class being
654 * added is not part of the trace yet, so we validate
655 * that the trace contains no stream classes yet.
657 if (trace
->stream_classes
->len
>= 1) {
658 BT_LOGW_STR("Invalid packet header field type: "
659 "packet header field type does not exist but there's more than one stream class in the trace.");
663 /* No packet header field type: valid at this point */
667 /* Packet header field type, if it exists, must be a structure */
668 if (!bt_field_type_is_structure(packet_header_type
)) {
669 BT_LOGW("Invalid packet header field type: must be a structure field type if it exists: "
670 "ft-addr=%p, ft-id=%s",
672 bt_field_type_id_string(packet_header_type
->id
));
677 * If there's a `magic` field, it must be a 32-bit unsigned
678 * integer field type. Also it must be the first field of the
679 * packet header field type.
681 field_type
= bt_field_type_structure_get_field_type_by_name(
682 packet_header_type
, "magic");
684 const char *field_name
;
686 if (!bt_field_type_is_integer(field_type
)) {
687 BT_LOGW("Invalid packet header field type: `magic` field must be an integer field type: "
688 "magic-ft-addr=%p, magic-ft-id=%s",
690 bt_field_type_id_string(field_type
->id
));
694 if (bt_field_type_integer_is_signed(field_type
)) {
695 BT_LOGW("Invalid packet header field type: `magic` field must be an unsigned integer field type: "
696 "magic-ft-addr=%p", field_type
);
700 if (bt_field_type_integer_get_size(field_type
) != 32) {
701 BT_LOGW("Invalid packet header field type: `magic` field must be a 32-bit unsigned integer field type: "
702 "magic-ft-addr=%p, magic-ft-size=%u",
704 bt_field_type_integer_get_size(field_type
));
708 ret
= bt_field_type_structure_get_field_by_index(
709 packet_header_type
, &field_name
, NULL
, 0);
712 if (strcmp(field_name
, "magic") != 0) {
713 BT_LOGW("Invalid packet header field type: `magic` field must be the first field: "
714 "magic-ft-addr=%p, first-field-name=\"%s\"",
715 field_type
, field_name
);
723 * If there's a `uuid` field, it must be an array field type of
724 * length 16 with an 8-bit unsigned integer element field type.
726 field_type
= bt_field_type_structure_get_field_type_by_name(
727 packet_header_type
, "uuid");
729 struct bt_field_type
*elem_ft
;
731 if (!bt_field_type_is_array(field_type
)) {
732 BT_LOGW("Invalid packet header field type: `uuid` field must be an array field type: "
733 "uuid-ft-addr=%p, uuid-ft-id=%s",
735 bt_field_type_id_string(field_type
->id
));
739 if (bt_field_type_array_get_length(field_type
) != 16) {
740 BT_LOGW("Invalid packet header field type: `uuid` array field type's length must be 16: "
741 "uuid-ft-addr=%p, uuid-ft-length=%" PRId64
,
743 bt_field_type_array_get_length(field_type
));
747 elem_ft
= bt_field_type_array_get_element_type(field_type
);
750 if (!bt_field_type_is_integer(elem_ft
)) {
751 BT_LOGW("Invalid packet header field type: `uuid` field's element field type must be an integer field type: "
752 "elem-ft-addr=%p, elem-ft-id=%s",
754 bt_field_type_id_string(elem_ft
->id
));
759 if (bt_field_type_integer_is_signed(elem_ft
)) {
760 BT_LOGW("Invalid packet header field type: `uuid` field's element field type must be an unsigned integer field type: "
761 "elem-ft-addr=%p", elem_ft
);
766 if (bt_field_type_integer_get_size(elem_ft
) != 8) {
767 BT_LOGW("Invalid packet header field type: `uuid` field's element field type must be an 8-bit unsigned integer field type: "
768 "elem-ft-addr=%p, elem-ft-size=%u",
770 bt_field_type_integer_get_size(elem_ft
));
780 * The `stream_id` field must exist if there's more than one
781 * stream classes in the trace.
783 field_type
= bt_field_type_structure_get_field_type_by_name(
784 packet_header_type
, "stream_id");
786 if (!field_type
&& trace
->stream_classes
->len
>= 1) {
787 BT_LOGW_STR("Invalid packet header field type: "
788 "`stream_id` field does not exist but there's more than one stream class in the trace.");
793 * If there's a `stream_id` field, it must be an unsigned
794 * integer field type.
797 if (!bt_field_type_is_integer(field_type
)) {
798 BT_LOGW("Invalid packet header field type: `stream_id` field must be an integer field type: "
799 "stream-id-ft-addr=%p, stream-id-ft-id=%s",
801 bt_field_type_id_string(field_type
->id
));
805 if (bt_field_type_integer_is_signed(field_type
)) {
806 BT_LOGW("Invalid packet header field type: `stream_id` field must be an unsigned integer field type: "
807 "stream-id-ft-addr=%p", field_type
);
815 * If there's a `packet_seq_num` field, it must be an unsigned
816 * integer field type.
818 field_type
= bt_field_type_structure_get_field_type_by_name(
819 packet_header_type
, "packet_seq_num");
821 if (!bt_field_type_is_integer(field_type
)) {
822 BT_LOGW("Invalid packet header field type: `packet_seq_num` field must be an integer field type: "
823 "stream-id-ft-addr=%p, packet-seq-num-ft-id=%s",
825 bt_field_type_id_string(field_type
->id
));
829 if (bt_field_type_integer_is_signed(field_type
)) {
830 BT_LOGW("Invalid packet header field type: `packet_seq_num` field must be an unsigned integer field type: "
831 "packet-seq-num-ft-addr=%p", field_type
);
849 bool packet_context_field_type_is_valid(struct bt_trace
*trace
,
850 struct bt_stream_class
*stream_class
,
851 struct bt_field_type
*packet_context_type
)
853 bool is_valid
= true;
854 struct bt_field_type
*field_type
= NULL
;
856 if (!packet_context_type
) {
857 /* No packet context field type: valid at this point */
861 /* Packet context field type, if it exists, must be a structure */
862 if (!bt_field_type_is_structure(packet_context_type
)) {
863 BT_LOGW("Invalid packet context field type: must be a structure field type if it exists: "
864 "ft-addr=%p, ft-id=%s",
866 bt_field_type_id_string(packet_context_type
->id
));
871 * If there's a `packet_size` field, it must be an unsigned
872 * integer field type.
874 field_type
= bt_field_type_structure_get_field_type_by_name(
875 packet_context_type
, "packet_size");
877 if (!bt_field_type_is_integer(field_type
)) {
878 BT_LOGW("Invalid packet context field type: `packet_size` field must be an integer field type: "
879 "packet-size-ft-addr=%p, packet-size-ft-id=%s",
881 bt_field_type_id_string(field_type
->id
));
885 if (bt_field_type_integer_is_signed(field_type
)) {
886 BT_LOGW("Invalid packet context field type: `packet_size` field must be an unsigned integer field type: "
887 "packet-size-ft-addr=%p", field_type
);
895 * If there's a `content_size` field, it must be an unsigned
896 * integer field type.
898 field_type
= bt_field_type_structure_get_field_type_by_name(
899 packet_context_type
, "content_size");
901 if (!bt_field_type_is_integer(field_type
)) {
902 BT_LOGW("Invalid packet context field type: `content_size` field must be an integer field type: "
903 "content-size-ft-addr=%p, content-size-ft-id=%s",
905 bt_field_type_id_string(field_type
->id
));
909 if (bt_field_type_integer_is_signed(field_type
)) {
910 BT_LOGW("Invalid packet context field type: `content_size` field must be an unsigned integer field type: "
911 "content-size-ft-addr=%p", field_type
);
919 * If there's a `events_discarded` field, it must be an unsigned
920 * integer field type.
922 field_type
= bt_field_type_structure_get_field_type_by_name(
923 packet_context_type
, "events_discarded");
925 if (!bt_field_type_is_integer(field_type
)) {
926 BT_LOGW("Invalid packet context field type: `events_discarded` field must be an integer field type: "
927 "events-discarded-ft-addr=%p, events-discarded-ft-id=%s",
929 bt_field_type_id_string(field_type
->id
));
933 if (bt_field_type_integer_is_signed(field_type
)) {
934 BT_LOGW("Invalid packet context field type: `events_discarded` field must be an unsigned integer field type: "
935 "events-discarded-ft-addr=%p", field_type
);
943 * If there's a `timestamp_begin` field, it must be an unsigned
944 * integer field type. Also, if the trace is not a CTF writer's
945 * trace, then we cannot automatically set the mapped clock
946 * class of this field, so it must have a mapped clock class.
948 field_type
= bt_field_type_structure_get_field_type_by_name(
949 packet_context_type
, "timestamp_begin");
951 if (!bt_field_type_is_integer(field_type
)) {
952 BT_LOGW("Invalid packet context field type: `timestamp_begin` field must be an integer field type: "
953 "timestamp-begin-ft-addr=%p, timestamp-begin-ft-id=%s",
955 bt_field_type_id_string(field_type
->id
));
959 if (bt_field_type_integer_is_signed(field_type
)) {
960 BT_LOGW("Invalid packet context field type: `timestamp_begin` field must be an unsigned integer field type: "
961 "timestamp-begin-ft-addr=%p", field_type
);
965 if (!trace
->is_created_by_writer
) {
966 struct bt_clock_class
*clock_class
=
967 bt_field_type_integer_get_mapped_clock_class(
972 BT_LOGW("Invalid packet context field type: `timestamp_begin` field must be mapped to a clock class: "
973 "timestamp-begin-ft-addr=%p", field_type
);
982 * If there's a `timestamp_end` field, it must be an unsigned
983 * integer field type. Also, if the trace is not a CTF writer's
984 * trace, then we cannot automatically set the mapped clock
985 * class of this field, so it must have a mapped clock class.
987 field_type
= bt_field_type_structure_get_field_type_by_name(
988 packet_context_type
, "timestamp_end");
990 if (!bt_field_type_is_integer(field_type
)) {
991 BT_LOGW("Invalid packet context field type: `timestamp_end` field must be an integer field type: "
992 "timestamp-end-ft-addr=%p, timestamp-end-ft-id=%s",
994 bt_field_type_id_string(field_type
->id
));
998 if (bt_field_type_integer_is_signed(field_type
)) {
999 BT_LOGW("Invalid packet context field type: `timestamp_end` field must be an unsigned integer field type: "
1000 "timestamp-end-ft-addr=%p", field_type
);
1004 if (!trace
->is_created_by_writer
) {
1005 struct bt_clock_class
*clock_class
=
1006 bt_field_type_integer_get_mapped_clock_class(
1009 bt_put(clock_class
);
1011 BT_LOGW("Invalid packet context field type: `timestamp_end` field must be mapped to a clock class: "
1012 "timestamp-end-ft-addr=%p", field_type
);
1031 bool event_header_field_type_is_valid(struct bt_trace
*trace
,
1032 struct bt_stream_class
*stream_class
,
1033 struct bt_field_type
*event_header_type
)
1035 bool is_valid
= true;
1036 struct bt_field_type
*field_type
= NULL
;
1039 * We do not validate that the `timestamp` field exists here
1040 * because CTF does not require this exact name to be mapped to
1044 if (!event_header_type
) {
1046 * No event header field type: stream class must have
1047 * only one event class.
1049 if (bt_stream_class_get_event_class_count(stream_class
) > 1) {
1050 BT_LOGW_STR("Invalid event header field type: "
1051 "event header field type does not exist but there's more than one event class in the stream class.");
1055 /* No event header field type: valid at this point */
1059 /* Event header field type, if it exists, must be a structure */
1060 if (!bt_field_type_is_structure(event_header_type
)) {
1061 BT_LOGW("Invalid event header field type: must be a structure field type if it exists: "
1062 "ft-addr=%p, ft-id=%s",
1064 bt_field_type_id_string(event_header_type
->id
));
1069 * If there's an `id` field, it must be an unsigned integer
1070 * field type or an enumeration field type with an unsigned
1071 * integer container field type.
1073 field_type
= bt_field_type_structure_get_field_type_by_name(
1074 event_header_type
, "id");
1076 struct bt_field_type
*int_ft
;
1078 if (bt_field_type_is_integer(field_type
)) {
1079 int_ft
= bt_get(field_type
);
1080 } else if (bt_field_type_is_enumeration(field_type
)) {
1081 int_ft
= bt_field_type_enumeration_get_container_type(
1084 BT_LOGW("Invalid event header field type: `id` field must be an integer or enumeration field type: "
1085 "id-ft-addr=%p, id-ft-id=%s",
1087 bt_field_type_id_string(field_type
->id
));
1092 if (bt_field_type_integer_is_signed(int_ft
)) {
1093 BT_LOGW("Invalid event header field type: `id` field must be an unsigned integer or enumeration field type: "
1094 "id-ft-addr=%p", int_ft
);
1113 int check_packet_header_type_has_no_clock_class(struct bt_trace
*trace
)
1117 if (trace
->packet_header_type
) {
1118 struct bt_clock_class
*clock_class
= NULL
;
1120 ret
= bt_validate_single_clock_class(trace
->packet_header_type
,
1122 bt_put(clock_class
);
1123 if (ret
|| clock_class
) {
1124 BT_LOGW("Trace's packet header field type cannot "
1125 "contain a field type which is mapped to "
1127 "trace-addr=%p, trace-name=\"%s\", "
1128 "clock-class-name=\"%s\"",
1129 trace
, bt_trace_get_name(trace
),
1131 bt_clock_class_get_name(clock_class
) :
1140 int bt_trace_add_stream_class(struct bt_trace
*trace
,
1141 struct bt_stream_class
*stream_class
)
1146 struct bt_validation_output trace_sc_validation_output
= { 0 };
1147 struct bt_validation_output
*ec_validation_outputs
= NULL
;
1148 const enum bt_validation_flag trace_sc_validation_flags
=
1149 BT_VALIDATION_FLAG_TRACE
|
1150 BT_VALIDATION_FLAG_STREAM
;
1151 const enum bt_validation_flag ec_validation_flags
=
1152 BT_VALIDATION_FLAG_EVENT
;
1153 struct bt_field_type
*packet_header_type
= NULL
;
1154 struct bt_field_type
*packet_context_type
= NULL
;
1155 struct bt_field_type
*event_header_type
= NULL
;
1156 struct bt_field_type
*stream_event_ctx_type
= NULL
;
1157 int64_t event_class_count
;
1158 struct bt_trace
*current_parent_trace
= NULL
;
1161 BT_LOGW_STR("Invalid parameter: trace is NULL.");
1166 if (!stream_class
) {
1167 BT_LOGW_STR("Invalid parameter: stream class is NULL.");
1172 if (trace
->is_static
) {
1173 BT_LOGW_STR("Invalid parameter: trace is static.");
1178 BT_LOGD("Adding stream class to trace: "
1179 "trace-addr=%p, trace-name=\"%s\", "
1180 "stream-class-addr=%p, stream-class-name=\"%s\", "
1181 "stream-class-id=%" PRId64
,
1182 trace
, bt_trace_get_name(trace
),
1183 stream_class
, bt_stream_class_get_name(stream_class
),
1184 bt_stream_class_get_id(stream_class
));
1186 current_parent_trace
= bt_stream_class_get_trace(stream_class
);
1187 if (current_parent_trace
) {
1188 /* Stream class is already associated to a trace, abort. */
1189 BT_LOGW("Invalid parameter: stream class is already part of a trace: "
1190 "stream-class-trace-addr=%p, "
1191 "stream-class-trace-name=\"%s\"",
1192 current_parent_trace
,
1193 bt_trace_get_name(current_parent_trace
));
1199 bt_stream_class_get_event_class_count(stream_class
);
1200 assert(event_class_count
>= 0);
1202 if (stream_class
->clock
) {
1203 struct bt_clock_class
*stream_clock_class
=
1204 stream_class
->clock
->clock_class
;
1206 if (trace
->is_created_by_writer
) {
1208 * Make sure this clock was also added to the
1209 * trace (potentially through its CTF writer
1214 for (i
= 0; i
< trace
->clocks
->len
; i
++) {
1215 if (trace
->clocks
->pdata
[i
] ==
1216 stream_clock_class
) {
1222 if (i
== trace
->clocks
->len
) {
1224 BT_LOGW("Stream class's clock's class is not part of the trace: "
1225 "clock-class-addr=%p, clock-class-name=\"%s\"",
1227 bt_clock_class_get_name(stream_clock_class
));
1233 * This trace was NOT created by a CTF writer,
1234 * thus do not allow the stream class to add to
1235 * have a clock at all. Those are two
1236 * independent APIs (non-writer and writer
1237 * APIs), and isolating them simplifies things.
1239 BT_LOGW("Cannot add stream class with a clock to a trace which was not created by a CTF writer object: "
1240 "clock-class-addr=%p, clock-class-name=\"%s\"",
1242 bt_clock_class_get_name(stream_clock_class
));
1248 ret
= check_packet_header_type_has_no_clock_class(trace
);
1250 /* check_packet_header_type_has_no_clock_class() logs errors */
1255 * We're about to freeze both the trace and the stream class.
1256 * Also, each event class contained in this stream class are
1259 * This trace, this stream class, and all its event classes
1260 * should be valid at this point.
1262 * Validate trace and stream class first, then each event
1263 * class of this stream class can be validated individually.
1265 packet_header_type
=
1266 bt_trace_get_packet_header_type(trace
);
1267 packet_context_type
=
1268 bt_stream_class_get_packet_context_type(stream_class
);
1270 bt_stream_class_get_event_header_type(stream_class
);
1271 stream_event_ctx_type
=
1272 bt_stream_class_get_event_context_type(stream_class
);
1274 BT_LOGD("Validating trace and stream class field types.");
1275 ret
= bt_validate_class_types(trace
->environment
,
1276 packet_header_type
, packet_context_type
, event_header_type
,
1277 stream_event_ctx_type
, NULL
, NULL
, trace
->valid
,
1278 stream_class
->valid
, 1, &trace_sc_validation_output
,
1279 trace_sc_validation_flags
);
1280 BT_PUT(packet_header_type
);
1281 BT_PUT(packet_context_type
);
1282 BT_PUT(event_header_type
);
1283 BT_PUT(stream_event_ctx_type
);
1287 * This means something went wrong during the validation
1288 * process, not that the objects are invalid.
1290 BT_LOGE("Failed to validate trace and stream class field types: "
1295 if ((trace_sc_validation_output
.valid_flags
&
1296 trace_sc_validation_flags
) !=
1297 trace_sc_validation_flags
) {
1298 /* Invalid trace/stream class */
1299 BT_LOGW("Invalid trace or stream class field types: "
1301 trace_sc_validation_output
.valid_flags
);
1306 if (event_class_count
> 0) {
1307 ec_validation_outputs
= g_new0(struct bt_validation_output
,
1309 if (!ec_validation_outputs
) {
1310 BT_LOGE_STR("Failed to allocate one validation output structure.");
1316 /* Validate each event class individually */
1317 for (i
= 0; i
< event_class_count
; i
++) {
1318 struct bt_event_class
*event_class
=
1319 bt_stream_class_get_event_class_by_index(
1321 struct bt_field_type
*event_context_type
= NULL
;
1322 struct bt_field_type
*event_payload_type
= NULL
;
1324 event_context_type
=
1325 bt_event_class_get_context_type(event_class
);
1326 event_payload_type
=
1327 bt_event_class_get_payload_type(event_class
);
1330 * It is important to use the field types returned by
1331 * the previous trace and stream class validation here
1332 * because copies could have been made.
1334 BT_LOGD("Validating event class's field types: "
1335 "addr=%p, name=\"%s\", id=%" PRId64
,
1336 event_class
, bt_event_class_get_name(event_class
),
1337 bt_event_class_get_id(event_class
));
1338 ret
= bt_validate_class_types(trace
->environment
,
1339 trace_sc_validation_output
.packet_header_type
,
1340 trace_sc_validation_output
.packet_context_type
,
1341 trace_sc_validation_output
.event_header_type
,
1342 trace_sc_validation_output
.stream_event_ctx_type
,
1343 event_context_type
, event_payload_type
,
1344 1, 1, event_class
->valid
, &ec_validation_outputs
[i
],
1345 ec_validation_flags
);
1346 BT_PUT(event_context_type
);
1347 BT_PUT(event_payload_type
);
1348 BT_PUT(event_class
);
1351 BT_LOGE("Failed to validate event class field types: "
1356 if ((ec_validation_outputs
[i
].valid_flags
&
1357 ec_validation_flags
) != ec_validation_flags
) {
1358 /* Invalid event class */
1359 BT_LOGW("Invalid event class field types: "
1361 ec_validation_outputs
[i
].valid_flags
);
1367 stream_id
= bt_stream_class_get_id(stream_class
);
1368 if (stream_id
< 0) {
1369 stream_id
= trace
->next_stream_id
++;
1370 if (stream_id
< 0) {
1371 BT_LOGE_STR("No more stream class IDs available.");
1376 /* Try to assign a new stream id */
1377 for (i
= 0; i
< trace
->stream_classes
->len
; i
++) {
1378 if (stream_id
== bt_stream_class_get_id(
1379 trace
->stream_classes
->pdata
[i
])) {
1380 /* Duplicate stream id found */
1381 BT_LOGW("Duplicate stream class ID: "
1382 "id=%" PRId64
, (int64_t) stream_id
);
1388 if (bt_stream_class_set_id_no_check(stream_class
,
1390 /* TODO Should retry with a different stream id */
1391 BT_LOGE("Cannot set stream class's ID: "
1392 "id=%" PRId64
, (int64_t) stream_id
);
1399 * At this point all the field types in the validation output
1400 * are valid. Validate the semantics of some scopes according to
1401 * the CTF specification.
1403 if (!packet_header_field_type_is_valid(trace
,
1404 trace_sc_validation_output
.packet_header_type
)) {
1405 BT_LOGW_STR("Invalid trace's packet header field type.");
1410 if (!packet_context_field_type_is_valid(trace
,
1412 trace_sc_validation_output
.packet_context_type
)) {
1413 BT_LOGW_STR("Invalid stream class's packet context field type.");
1418 if (!event_header_field_type_is_valid(trace
,
1420 trace_sc_validation_output
.event_header_type
)) {
1421 BT_LOGW_STR("Invalid steam class's event header field type.");
1427 * Now is the time to automatically map specific field types of
1428 * the stream class's packet context and event header field
1429 * types to the stream class's clock's class if they are not
1430 * mapped to a clock class yet. We do it here because we know
1431 * that after this point, everything is frozen so it won't be
1432 * possible for the user to modify the stream class's clock, or
1433 * to map those field types to other clock classes.
1435 if (trace
->is_created_by_writer
) {
1436 if (bt_stream_class_map_clock_class(stream_class
,
1437 trace_sc_validation_output
.packet_context_type
,
1438 trace_sc_validation_output
.event_header_type
)) {
1439 BT_LOGW_STR("Cannot automatically map selected stream class's field types to stream class's clock's class.");
1445 bt_object_set_parent(stream_class
, trace
);
1446 g_ptr_array_add(trace
->stream_classes
, stream_class
);
1449 * At this point we know that the function will be successful.
1450 * Therefore we can replace the trace and stream class field
1451 * types with what's in their validation output structure and
1452 * mark them as valid. We can also replace the field types of
1453 * all the event classes of the stream class and mark them as
1456 bt_validation_replace_types(trace
, stream_class
, NULL
,
1457 &trace_sc_validation_output
, trace_sc_validation_flags
);
1459 stream_class
->valid
= 1;
1462 * Put what was not moved in bt_validation_replace_types().
1464 bt_validation_output_put_types(&trace_sc_validation_output
);
1466 for (i
= 0; i
< event_class_count
; i
++) {
1467 struct bt_event_class
*event_class
=
1468 bt_stream_class_get_event_class_by_index(
1471 bt_validation_replace_types(NULL
, NULL
, event_class
,
1472 &ec_validation_outputs
[i
], ec_validation_flags
);
1473 event_class
->valid
= 1;
1474 BT_PUT(event_class
);
1477 * Put what was not moved in
1478 * bt_validation_replace_types().
1480 bt_validation_output_put_types(&ec_validation_outputs
[i
]);
1484 * Freeze the trace and the stream class.
1486 bt_stream_class_freeze(stream_class
);
1487 bt_trace_freeze(trace
);
1489 /* Notifiy listeners of the trace's schema modification. */
1490 bt_stream_class_visit(stream_class
,
1491 bt_trace_object_modification
, trace
);
1492 BT_LOGD("Added stream class to trace: "
1493 "trace-addr=%p, trace-name=\"%s\", "
1494 "stream-class-addr=%p, stream-class-name=\"%s\", "
1495 "stream-class-id=%" PRId64
,
1496 trace
, bt_trace_get_name(trace
),
1497 stream_class
, bt_stream_class_get_name(stream_class
),
1498 bt_stream_class_get_id(stream_class
));
1502 bt_object_set_parent(stream_class
, NULL
);
1504 if (ec_validation_outputs
) {
1505 for (i
= 0; i
< event_class_count
; i
++) {
1506 bt_validation_output_put_types(
1507 &ec_validation_outputs
[i
]);
1512 g_free(ec_validation_outputs
);
1513 bt_validation_output_put_types(&trace_sc_validation_output
);
1514 bt_put(current_parent_trace
);
1515 assert(!packet_header_type
);
1516 assert(!packet_context_type
);
1517 assert(!event_header_type
);
1518 assert(!stream_event_ctx_type
);
1522 int64_t bt_trace_get_stream_count(struct bt_trace
*trace
)
1527 BT_LOGW_STR("Invalid parameter: trace is NULL.");
1532 ret
= (int64_t) trace
->streams
->len
;
1538 struct bt_stream
*bt_trace_get_stream_by_index(
1539 struct bt_trace
*trace
,
1542 struct bt_stream
*stream
= NULL
;
1545 BT_LOGW_STR("Invalid parameter: trace is NULL.");
1549 if (index
>= trace
->streams
->len
) {
1550 BT_LOGW("Invalid parameter: index is out of bounds: "
1551 "addr=%p, name=\"%s\", "
1552 "index=%" PRIu64
", count=%u",
1553 trace
, bt_trace_get_name(trace
),
1554 index
, trace
->streams
->len
);
1558 stream
= bt_get(g_ptr_array_index(trace
->streams
, index
));
1564 int64_t bt_trace_get_stream_class_count(struct bt_trace
*trace
)
1569 BT_LOGW_STR("Invalid parameter: trace is NULL.");
1574 ret
= (int64_t) trace
->stream_classes
->len
;
1579 struct bt_stream_class
*bt_trace_get_stream_class_by_index(
1580 struct bt_trace
*trace
, uint64_t index
)
1582 struct bt_stream_class
*stream_class
= NULL
;
1585 BT_LOGW_STR("Invalid parameter: trace is NULL.");
1589 if (index
>= trace
->stream_classes
->len
) {
1590 BT_LOGW("Invalid parameter: index is out of bounds: "
1591 "addr=%p, name=\"%s\", "
1592 "index=%" PRIu64
", count=%u",
1593 trace
, bt_trace_get_name(trace
),
1594 index
, trace
->stream_classes
->len
);
1598 stream_class
= g_ptr_array_index(trace
->stream_classes
, index
);
1599 bt_get(stream_class
);
1601 return stream_class
;
1604 struct bt_stream_class
*bt_trace_get_stream_class_by_id(
1605 struct bt_trace
*trace
, uint64_t id_param
)
1608 struct bt_stream_class
*stream_class
= NULL
;
1609 int64_t id
= (int64_t) id_param
;
1612 BT_LOGW_STR("Invalid parameter: trace is NULL.");
1617 BT_LOGW("Invalid parameter: invalid stream class's ID: "
1618 "trace-addr=%p, trace-name=\"%s\", id=%" PRIu64
,
1619 trace
, bt_trace_get_name(trace
), id_param
);
1623 for (i
= 0; i
< trace
->stream_classes
->len
; i
++) {
1624 struct bt_stream_class
*stream_class_candidate
;
1626 stream_class_candidate
=
1627 g_ptr_array_index(trace
->stream_classes
, i
);
1629 if (bt_stream_class_get_id(stream_class_candidate
) ==
1631 stream_class
= stream_class_candidate
;
1632 bt_get(stream_class
);
1638 return stream_class
;
1641 struct bt_clock_class
*bt_trace_get_clock_class_by_name(
1642 struct bt_trace
*trace
, const char *name
)
1645 struct bt_clock_class
*clock_class
= NULL
;
1648 BT_LOGW_STR("Invalid parameter: trace is NULL.");
1653 BT_LOGW_STR("Invalid parameter: name is NULL.");
1657 for (i
= 0; i
< trace
->clocks
->len
; i
++) {
1658 struct bt_clock_class
*cur_clk
=
1659 g_ptr_array_index(trace
->clocks
, i
);
1660 const char *cur_clk_name
= bt_clock_class_get_name(cur_clk
);
1662 if (!cur_clk_name
) {
1666 if (!strcmp(cur_clk_name
, name
)) {
1667 clock_class
= cur_clk
;
1668 bt_get(clock_class
);
1678 bt_bool
bt_trace_has_clock_class(struct bt_trace
*trace
,
1679 struct bt_clock_class
*clock_class
)
1681 struct search_query query
= { .value
= clock_class
, .found
= 0 };
1684 assert(clock_class
);
1686 g_ptr_array_foreach(trace
->clocks
, value_exists
, &query
);
1691 const char *get_byte_order_string(enum bt_byte_order byte_order
)
1695 switch (byte_order
) {
1696 case BT_BYTE_ORDER_LITTLE_ENDIAN
:
1699 case BT_BYTE_ORDER_BIG_ENDIAN
:
1702 case BT_BYTE_ORDER_NATIVE
:
1713 int append_trace_metadata(struct bt_trace
*trace
,
1714 struct metadata_context
*context
)
1716 unsigned char *uuid
= trace
->uuid
;
1719 if (trace
->native_byte_order
== BT_BYTE_ORDER_NATIVE
||
1720 trace
->native_byte_order
== BT_BYTE_ORDER_UNSPECIFIED
) {
1721 BT_LOGW("Invalid parameter: trace's byte order cannot be BT_BYTE_ORDER_NATIVE or BT_BYTE_ORDER_UNSPECIFIED at this point; "
1722 "set it with bt_trace_set_native_byte_order(): "
1723 "addr=%p, name=\"%s\"",
1724 trace
, bt_trace_get_name(trace
));
1729 g_string_append(context
->string
, "trace {\n");
1730 g_string_append(context
->string
, "\tmajor = 1;\n");
1731 g_string_append(context
->string
, "\tminor = 8;\n");
1732 assert(trace
->native_byte_order
== BT_BYTE_ORDER_LITTLE_ENDIAN
||
1733 trace
->native_byte_order
== BT_BYTE_ORDER_BIG_ENDIAN
||
1734 trace
->native_byte_order
== BT_BYTE_ORDER_NETWORK
);
1736 if (trace
->uuid_set
) {
1737 g_string_append_printf(context
->string
,
1738 "\tuuid = \"%02x%02x%02x%02x-%02x%02x-%02x%02x-%02x%02x-%02x%02x%02x%02x%02x%02x\";\n",
1739 uuid
[0], uuid
[1], uuid
[2], uuid
[3],
1740 uuid
[4], uuid
[5], uuid
[6], uuid
[7],
1741 uuid
[8], uuid
[9], uuid
[10], uuid
[11],
1742 uuid
[12], uuid
[13], uuid
[14], uuid
[15]);
1745 g_string_append_printf(context
->string
, "\tbyte_order = %s;\n",
1746 get_byte_order_string(trace
->native_byte_order
));
1748 if (trace
->packet_header_type
) {
1749 g_string_append(context
->string
, "\tpacket.header := ");
1750 context
->current_indentation_level
++;
1751 g_string_assign(context
->field_name
, "");
1752 BT_LOGD_STR("Serializing trace's packet header field type's metadata.");
1753 ret
= bt_field_type_serialize(trace
->packet_header_type
,
1758 context
->current_indentation_level
--;
1761 g_string_append(context
->string
, ";\n};\n\n");
1767 void append_env_metadata(struct bt_trace
*trace
,
1768 struct metadata_context
*context
)
1773 env_size
= bt_attributes_get_count(trace
->environment
);
1774 if (env_size
<= 0) {
1778 g_string_append(context
->string
, "env {\n");
1780 for (i
= 0; i
< env_size
; i
++) {
1781 struct bt_value
*env_field_value_obj
= NULL
;
1782 const char *entry_name
;
1784 entry_name
= bt_attributes_get_field_name(
1785 trace
->environment
, i
);
1786 env_field_value_obj
= bt_attributes_get_field_value(
1787 trace
->environment
, i
);
1790 assert(env_field_value_obj
);
1792 switch (bt_value_get_type(env_field_value_obj
)) {
1793 case BT_VALUE_TYPE_INTEGER
:
1798 ret
= bt_value_integer_get(env_field_value_obj
,
1801 g_string_append_printf(context
->string
,
1802 "\t%s = %" PRId64
";\n", entry_name
,
1806 case BT_VALUE_TYPE_STRING
:
1809 const char *str_value
;
1810 char *escaped_str
= NULL
;
1812 ret
= bt_value_string_get(env_field_value_obj
,
1815 escaped_str
= g_strescape(str_value
, NULL
);
1817 BT_LOGE("Cannot escape string: string=\"%s\"",
1822 g_string_append_printf(context
->string
,
1823 "\t%s = \"%s\";\n", entry_name
, escaped_str
);
1832 BT_PUT(env_field_value_obj
);
1835 g_string_append(context
->string
, "};\n\n");
1838 char *bt_trace_get_metadata_string(struct bt_trace
*trace
)
1840 char *metadata
= NULL
;
1841 struct metadata_context
*context
= NULL
;
1846 BT_LOGW_STR("Invalid parameter: trace is NULL.");
1850 context
= g_new0(struct metadata_context
, 1);
1852 BT_LOGE_STR("Failed to allocate one metadata context.");
1856 context
->field_name
= g_string_sized_new(DEFAULT_IDENTIFIER_SIZE
);
1857 context
->string
= g_string_sized_new(DEFAULT_METADATA_STRING_SIZE
);
1858 g_string_append(context
->string
, "/* CTF 1.8 */\n\n");
1859 if (append_trace_metadata(trace
, context
)) {
1860 /* append_trace_metadata() logs errors */
1863 append_env_metadata(trace
, context
);
1864 g_ptr_array_foreach(trace
->clocks
,
1865 (GFunc
)bt_clock_class_serialize
, context
);
1867 for (i
= 0; i
< trace
->stream_classes
->len
; i
++) {
1868 /* bt_stream_class_serialize() logs details */
1869 err
= bt_stream_class_serialize(
1870 trace
->stream_classes
->pdata
[i
], context
);
1872 /* bt_stream_class_serialize() logs errors */
1877 metadata
= context
->string
->str
;
1880 g_string_free(context
->string
, err
? TRUE
: FALSE
);
1881 g_string_free(context
->field_name
, TRUE
);
1888 enum bt_byte_order
bt_trace_get_native_byte_order(
1889 struct bt_trace
*trace
)
1891 enum bt_byte_order ret
= BT_BYTE_ORDER_UNKNOWN
;
1894 BT_LOGW_STR("Invalid parameter: trace is NULL.");
1898 ret
= trace
->native_byte_order
;
1904 int bt_trace_set_native_byte_order(struct bt_trace
*trace
,
1905 enum bt_byte_order byte_order
)
1910 BT_LOGW_STR("Invalid parameter: trace is NULL.");
1915 if (trace
->frozen
) {
1916 BT_LOGW("Invalid parameter: trace is frozen: "
1917 "addr=%p, name=\"%s\"",
1918 trace
, bt_trace_get_name(trace
));
1923 if (trace
->is_created_by_writer
&&
1924 byte_order
== BT_BYTE_ORDER_UNSPECIFIED
) {
1925 BT_LOGW("Invalid parameter: BT_BYTE_ORDER_UNSPECIFIED byte order is not allowed for a CTF writer trace: "
1926 "addr=%p, name=\"%s\"",
1927 trace
, bt_trace_get_name(trace
));
1932 if (byte_order
!= BT_BYTE_ORDER_LITTLE_ENDIAN
&&
1933 byte_order
!= BT_BYTE_ORDER_BIG_ENDIAN
&&
1934 byte_order
!= BT_BYTE_ORDER_NETWORK
) {
1935 BT_LOGW("Invalid parameter: invalid byte order: "
1936 "addr=%p, name=\"%s\", bo=%s",
1937 trace
, bt_trace_get_name(trace
),
1938 bt_byte_order_string(byte_order
));
1943 trace
->native_byte_order
= byte_order
;
1944 BT_LOGV("Set trace's native byte order: "
1945 "addr=%p, name=\"%s\", bo=%s",
1946 trace
, bt_trace_get_name(trace
),
1947 bt_byte_order_string(byte_order
));
1953 struct bt_field_type
*bt_trace_get_packet_header_type(
1954 struct bt_trace
*trace
)
1956 struct bt_field_type
*field_type
= NULL
;
1959 BT_LOGW_STR("Invalid parameter: trace is NULL.");
1963 bt_get(trace
->packet_header_type
);
1964 field_type
= trace
->packet_header_type
;
1969 int bt_trace_set_packet_header_type(struct bt_trace
*trace
,
1970 struct bt_field_type
*packet_header_type
)
1975 BT_LOGW_STR("Invalid parameter: trace is NULL.");
1980 if (trace
->frozen
) {
1981 BT_LOGW("Invalid parameter: trace is frozen: "
1982 "addr=%p, name=\"%s\"",
1983 trace
, bt_trace_get_name(trace
));
1988 /* packet_header_type must be a structure. */
1989 if (packet_header_type
&&
1990 !bt_field_type_is_structure(packet_header_type
)) {
1991 BT_LOGW("Invalid parameter: packet header field type must be a structure field type if it exists: "
1992 "addr=%p, name=\"%s\", ft-addr=%p, ft-id=%s",
1993 trace
, bt_trace_get_name(trace
),
1995 bt_field_type_id_string(packet_header_type
->id
));
2000 bt_put(trace
->packet_header_type
);
2001 trace
->packet_header_type
= bt_get(packet_header_type
);
2002 BT_LOGV("Set trace's packet header field type: "
2003 "addr=%p, name=\"%s\", packet-context-ft-addr=%p",
2004 trace
, bt_trace_get_name(trace
), packet_header_type
);
2010 int64_t get_stream_class_count(void *element
)
2012 return bt_trace_get_stream_class_count(
2013 (struct bt_trace
*) element
);
2017 void *get_stream_class(void *element
, int i
)
2019 return bt_trace_get_stream_class_by_index(
2020 (struct bt_trace
*) element
, i
);
2024 int visit_stream_class(void *object
, bt_visitor visitor
,void *data
)
2026 return bt_stream_class_visit(object
, visitor
, data
);
2029 int bt_trace_visit(struct bt_trace
*trace
,
2030 bt_visitor visitor
, void *data
)
2033 struct bt_visitor_object obj
= {
2035 .type
= BT_VISITOR_OBJECT_TYPE_TRACE
2039 BT_LOGW_STR("Invalid parameter: trace is NULL.");
2045 BT_LOGW_STR("Invalid parameter: visitor is NULL.");
2050 BT_LOGV("Visiting trace: addr=%p, name=\"%s\"",
2051 trace
, bt_trace_get_name(trace
));
2052 ret
= visitor_helper(&obj
, get_stream_class_count
,
2053 get_stream_class
, visit_stream_class
, visitor
, data
);
2059 int invoke_listener(struct bt_visitor_object
*object
, void *data
)
2061 struct listener_wrapper
*listener_wrapper
= data
;
2063 listener_wrapper
->listener(object
, listener_wrapper
->data
);
2067 // TODO: add logging to this function once we use it internally.
2068 int bt_trace_add_listener(struct bt_trace
*trace
,
2069 bt_listener_cb listener
, void *listener_data
)
2072 struct listener_wrapper
*listener_wrapper
=
2073 g_new0(struct listener_wrapper
, 1);
2075 if (!trace
|| !listener
|| !listener_wrapper
) {
2080 listener_wrapper
->listener
= listener
;
2081 listener_wrapper
->data
= listener_data
;
2083 /* Visit the current schema. */
2084 ret
= bt_trace_visit(trace
, invoke_listener
, listener_wrapper
);
2090 * Add listener to the array of callbacks which will be invoked on
2093 g_ptr_array_add(trace
->listeners
, listener_wrapper
);
2096 g_free(listener_wrapper
);
2101 int bt_trace_object_modification(struct bt_visitor_object
*object
,
2105 struct bt_trace
*trace
= trace_ptr
;
2110 if (trace
->listeners
->len
== 0) {
2114 for (i
= 0; i
< trace
->listeners
->len
; i
++) {
2115 struct listener_wrapper
*listener
=
2116 g_ptr_array_index(trace
->listeners
, i
);
2118 listener
->listener(object
, listener
->data
);
2125 struct bt_field_type
*get_field_type(enum field_type_alias alias
)
2128 unsigned int alignment
, size
;
2129 struct bt_field_type
*field_type
= NULL
;
2131 if (alias
>= NR_FIELD_TYPE_ALIAS
) {
2135 alignment
= field_type_aliases_alignments
[alias
];
2136 size
= field_type_aliases_sizes
[alias
];
2137 field_type
= bt_field_type_integer_create(size
);
2138 ret
= bt_field_type_set_alignment(field_type
, alignment
);
2147 void bt_trace_freeze(struct bt_trace
*trace
)
2151 if (trace
->frozen
) {
2155 BT_LOGD("Freezing trace: addr=%p, name=\"%s\"",
2156 trace
, bt_trace_get_name(trace
));
2157 BT_LOGD_STR("Freezing packet header field type.");
2158 bt_field_type_freeze(trace
->packet_header_type
);
2159 BT_LOGD_STR("Freezing environment attributes.");
2160 bt_attributes_freeze(trace
->environment
);
2162 if (trace
->clocks
->len
> 0) {
2163 BT_LOGD_STR("Freezing clock classes.");
2166 for (i
= 0; i
< trace
->clocks
->len
; i
++) {
2167 struct bt_clock_class
*clock_class
=
2168 g_ptr_array_index(trace
->clocks
, i
);
2170 bt_clock_class_freeze(clock_class
);
2176 bt_bool
bt_trace_is_static(struct bt_trace
*trace
)
2178 bt_bool is_static
= BT_FALSE
;
2181 BT_LOGW_STR("Invalid parameter: trace is NULL.");
2185 is_static
= trace
->is_static
;
2191 int bt_trace_set_is_static(struct bt_trace
*trace
)
2197 BT_LOGW_STR("Invalid parameter: trace is NULL.");
2202 ret
= check_packet_header_type_has_no_clock_class(trace
);
2204 /* check_packet_header_type_has_no_clock_class() logs errors */
2208 trace
->is_static
= BT_TRUE
;
2209 bt_trace_freeze(trace
);
2210 BT_LOGV("Set trace static: addr=%p, name=\"%s\"",
2211 trace
, bt_trace_get_name(trace
));
2213 /* Call all the "trace is static" listeners */
2214 for (i
= 0; i
< trace
->is_static_listeners
->len
; i
++) {
2215 struct bt_trace_is_static_listener_elem elem
=
2216 g_array_index(trace
->is_static_listeners
,
2217 struct bt_trace_is_static_listener_elem
, i
);
2220 elem
.func(trace
, elem
.data
);
2228 int bt_trace_add_is_static_listener(struct bt_trace
*trace
,
2229 bt_trace_is_static_listener listener
,
2230 bt_trace_listener_removed listener_removed
, void *data
)
2233 struct bt_trace_is_static_listener_elem new_elem
= {
2235 .removed
= listener_removed
,
2240 BT_LOGW_STR("Invalid parameter: trace is NULL.");
2246 BT_LOGW_STR("Invalid parameter: listener is NULL.");
2251 if (trace
->is_static
) {
2252 BT_LOGW("Invalid parameter: trace is already static: "
2253 "addr=%p, name=\"%s\"",
2254 trace
, bt_trace_get_name(trace
));
2259 if (trace
->in_remove_listener
) {
2260 BT_LOGW("Cannot call this function during the execution of a remove listener: "
2261 "addr=%p, name=\"%s\"",
2262 trace
, bt_trace_get_name(trace
));
2267 /* Find the next available spot */
2268 for (i
= 0; i
< trace
->is_static_listeners
->len
; i
++) {
2269 struct bt_trace_is_static_listener_elem elem
=
2270 g_array_index(trace
->is_static_listeners
,
2271 struct bt_trace_is_static_listener_elem
, i
);
2278 if (i
== trace
->is_static_listeners
->len
) {
2279 g_array_append_val(trace
->is_static_listeners
, new_elem
);
2281 g_array_insert_val(trace
->is_static_listeners
, i
, new_elem
);
2284 BT_LOGV("Added \"trace is static\" listener: "
2285 "trace-addr=%p, trace-name=\"%s\", func-addr=%p, "
2286 "data-addr=%p, listener-id=%d",
2287 trace
, bt_trace_get_name(trace
), listener
, data
, i
);
2293 int bt_trace_remove_is_static_listener(
2294 struct bt_trace
*trace
, int listener_id
)
2297 struct bt_trace_is_static_listener_elem
*elem
;
2300 BT_LOGW_STR("Invalid parameter: trace is NULL.");
2305 if (trace
->in_remove_listener
) {
2306 BT_LOGW("Cannot call this function during the execution of a remove listener: "
2307 "addr=%p, name=\"%s\", listener-id=%d",
2308 trace
, bt_trace_get_name(trace
),
2314 if (listener_id
< 0) {
2315 BT_LOGW("Invalid listener ID: must be zero or positive: "
2316 "listener-id=%d", listener_id
);
2321 if (listener_id
>= trace
->is_static_listeners
->len
) {
2322 BT_LOGW("Invalid parameter: no listener with this listener ID: "
2323 "addr=%p, name=\"%s\", listener-id=%d",
2324 trace
, bt_trace_get_name(trace
),
2330 elem
= &g_array_index(trace
->is_static_listeners
,
2331 struct bt_trace_is_static_listener_elem
,
2334 BT_LOGW("Invalid parameter: no listener with this listener ID: "
2335 "addr=%p, name=\"%s\", listener-id=%d",
2336 trace
, bt_trace_get_name(trace
),
2342 if (elem
->removed
) {
2343 /* Call remove listener */
2344 BT_LOGV("Calling remove listener: "
2345 "trace-addr=%p, trace-name=\"%s\", "
2346 "listener-id=%d", trace
, bt_trace_get_name(trace
),
2348 trace
->in_remove_listener
= BT_TRUE
;
2349 elem
->removed(trace
, elem
->data
);
2350 trace
->in_remove_listener
= BT_FALSE
;
2354 elem
->removed
= NULL
;
2356 BT_LOGV("Removed \"trace is static\" listener: "
2357 "trace-addr=%p, trace-name=\"%s\", "
2358 "listener-id=%d", trace
, bt_trace_get_name(trace
),