4 * Babeltrace CTF IR - Stream
6 * Copyright 2013, 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 "STREAM"
30 #include <babeltrace/lib-logging-internal.h>
32 #include <babeltrace/ctf-ir/clock-class.h>
33 #include <babeltrace/ctf-writer/clock.h>
34 #include <babeltrace/ctf-writer/clock-internal.h>
35 #include <babeltrace/ctf-writer/event.h>
36 #include <babeltrace/ctf-ir/event-internal.h>
37 #include <babeltrace/ctf-ir/field-types-internal.h>
38 #include <babeltrace/ctf-ir/fields-internal.h>
39 #include <babeltrace/ctf-ir/stream.h>
40 #include <babeltrace/ctf-ir/stream-internal.h>
41 #include <babeltrace/ctf-ir/stream-class-internal.h>
42 #include <babeltrace/ctf-ir/trace.h>
43 #include <babeltrace/ctf-ir/trace-internal.h>
44 #include <babeltrace/ctf-writer/writer-internal.h>
45 #include <babeltrace/graph/component-internal.h>
46 #include <babeltrace/ref.h>
47 #include <babeltrace/ctf-writer/functor-internal.h>
48 #include <babeltrace/compiler-internal.h>
49 #include <babeltrace/align-internal.h>
54 void bt_stream_destroy(struct bt_object
*obj
);
56 int try_set_structure_field_integer(struct bt_field
*, char *, uint64_t);
59 int set_integer_field_value(struct bt_field
* field
, uint64_t value
)
62 struct bt_field_type
*field_type
= NULL
;
65 BT_LOGW_STR("Invalid parameter: field is NULL.");
70 field_type
= bt_field_get_type(field
);
73 if (bt_field_type_get_type_id(field_type
) !=
74 BT_FIELD_TYPE_ID_INTEGER
) {
75 /* Not an integer and the value is unset, error. */
76 BT_LOGW("Invalid parameter: field's type is not an integer field type: "
77 "field-addr=%p, ft-addr=%p, ft-id=%s",
79 bt_field_type_id_string(field_type
->id
));
84 if (bt_field_type_integer_is_signed(field_type
)) {
85 ret
= bt_field_signed_integer_set_value(field
, (int64_t) value
);
87 /* Value is out of range, error. */
88 BT_LOGW("Cannot set signed integer field's value: "
89 "addr=%p, value=%" PRId64
,
90 field
, (int64_t) value
);
94 ret
= bt_field_unsigned_integer_set_value(field
, value
);
96 /* Value is out of range, error. */
97 BT_LOGW("Cannot set unsigned integer field's value: "
98 "addr=%p, value=%" PRIu64
,
109 int set_packet_header_magic(struct bt_stream
*stream
)
112 struct bt_field
*magic_field
= bt_field_structure_get_field_by_name(
113 stream
->packet_header
, "magic");
114 const uint32_t magic_value
= 0xc1fc1fc1;
119 /* No magic field found. Not an error, skip. */
120 BT_LOGV("No field named `magic` in packet header: skipping: "
121 "stream-addr=%p, stream-name=\"%s\"",
122 stream
, bt_stream_get_name(stream
));
126 ret
= bt_field_unsigned_integer_set_value(magic_field
,
127 (uint64_t) magic_value
);
130 BT_LOGW("Cannot set packet header field's `magic` integer field's value: "
131 "stream-addr=%p, stream-name=\"%s\", field-addr=%p, value=%" PRIu64
,
132 stream
, bt_stream_get_name(stream
),
133 magic_field
, (uint64_t) magic_value
);
135 BT_LOGV("Set packet header field's `magic` field's value: "
136 "stream-addr=%p, stream-name=\"%s\", field-addr=%p, value=%" PRIu64
,
137 stream
, bt_stream_get_name(stream
),
138 magic_field
, (uint64_t) magic_value
);
146 int set_packet_header_uuid(struct bt_stream
*stream
)
150 struct bt_trace
*trace
= NULL
;
151 struct bt_field
*uuid_field
= bt_field_structure_get_field_by_name(
152 stream
->packet_header
, "uuid");
157 /* No uuid field found. Not an error, skip. */
158 BT_LOGV("No field named `uuid` in packet header: skipping: "
159 "stream-addr=%p, stream-name=\"%s\"",
160 stream
, bt_stream_get_name(stream
));
164 trace
= (struct bt_trace
*) bt_object_get_parent(stream
);
165 for (i
= 0; i
< 16; i
++) {
166 struct bt_field
*uuid_element
=
167 bt_field_array_get_field(uuid_field
, i
);
169 ret
= bt_field_unsigned_integer_set_value(
170 uuid_element
, (uint64_t) trace
->uuid
[i
]);
171 bt_put(uuid_element
);
173 BT_LOGW("Cannot set integer field's value (for `uuid` packet header field): "
174 "stream-addr=%p, stream-name=\"%s\", field-addr=%p, "
175 "value=%" PRIu64
", index=%" PRId64
,
176 stream
, bt_stream_get_name(stream
),
177 uuid_element
, (uint64_t) trace
->uuid
[i
], i
);
182 BT_LOGV("Set packet header field's `uuid` field's value: "
183 "stream-addr=%p, stream-name=\"%s\", field-addr=%p",
184 stream
, bt_stream_get_name(stream
), uuid_field
);
192 int set_packet_header_stream_id(struct bt_stream
*stream
)
196 struct bt_field
*stream_id_field
= bt_field_structure_get_field_by_name(
197 stream
->packet_header
, "stream_id");
199 if (!stream_id_field
) {
200 /* No stream_id field found. Not an error, skip. */
201 BT_LOGV("No field named `stream_id` in packet header: skipping: "
202 "stream-addr=%p, stream-name=\"%s\"",
203 stream
, bt_stream_get_name(stream
));
207 stream_id
= stream
->stream_class
->id
;
208 ret
= bt_field_unsigned_integer_set_value(stream_id_field
,
209 (uint64_t) stream_id
);
211 BT_LOGW("Cannot set packet header field's `stream_id` integer field's value: "
212 "stream-addr=%p, stream-name=\"%s\", field-addr=%p, value=%" PRIu64
,
213 stream
, bt_stream_get_name(stream
),
214 stream_id_field
, (uint64_t) stream_id
);
216 BT_LOGV("Set packet header field's `stream_id` field's value: "
217 "stream-addr=%p, stream-name=\"%s\", field-addr=%p, value=%" PRIu64
,
218 stream
, bt_stream_get_name(stream
),
219 stream_id_field
, (uint64_t) stream_id
);
223 bt_put(stream_id_field
);
228 int auto_populate_packet_header(struct bt_stream
*stream
)
232 if (!stream
->packet_header
) {
236 ret
= set_packet_header_magic(stream
);
238 BT_LOGW("Cannot set packet header's magic number field: "
239 "stream-addr=%p, stream-name=\"%s\"",
240 stream
, bt_stream_get_name(stream
));
244 ret
= set_packet_header_uuid(stream
);
246 BT_LOGW("Cannot set packet header's UUID field: "
247 "stream-addr=%p, stream-name=\"%s\"",
248 stream
, bt_stream_get_name(stream
));
252 ret
= set_packet_header_stream_id(stream
);
254 BT_LOGW("Cannot set packet header's stream class ID field: "
255 "stream-addr=%p, stream-name=\"%s\"",
256 stream
, bt_stream_get_name(stream
));
260 BT_LOGV("Automatically populated stream's packet header's known fields: "
261 "stream-addr=%p, stream-name=\"%s\"",
262 stream
, bt_stream_get_name(stream
));
269 int set_packet_context_packet_size(struct bt_stream
*stream
)
272 struct bt_field
*field
= bt_field_structure_get_field_by_name(
273 stream
->packet_context
, "packet_size");
278 /* No packet size field found. Not an error, skip. */
279 BT_LOGV("No field named `packet_size` in packet context: skipping: "
280 "stream-addr=%p, stream-name=\"%s\"",
281 stream
, bt_stream_get_name(stream
));
285 ret
= bt_field_unsigned_integer_set_value(field
,
286 stream
->pos
.packet_size
);
288 BT_LOGW("Cannot set packet context field's `packet_size` integer field's value: "
289 "stream-addr=%p, stream-name=\"%s\", field-addr=%p, value=%" PRIu64
,
290 stream
, bt_stream_get_name(stream
),
291 field
, stream
->pos
.packet_size
);
293 BT_LOGV("Set packet context field's `packet_size` field's value: "
294 "stream-addr=%p, stream-name=\"%s\", field-addr=%p, value=%" PRIu64
,
295 stream
, bt_stream_get_name(stream
),
296 field
, stream
->pos
.packet_size
);
305 int set_packet_context_content_size(struct bt_stream
*stream
)
308 struct bt_field
*field
= bt_field_structure_get_field_by_name(
309 stream
->packet_context
, "content_size");
314 /* No content size field found. Not an error, skip. */
315 BT_LOGV("No field named `content_size` in packet context: skipping: "
316 "stream-addr=%p, stream-name=\"%s\"",
317 stream
, bt_stream_get_name(stream
));
321 ret
= bt_field_unsigned_integer_set_value(field
,
324 BT_LOGW("Cannot set packet context field's `content_size` integer field's value: "
325 "stream-addr=%p, stream-name=\"%s\", field-addr=%p, value=%" PRId64
,
326 stream
, bt_stream_get_name(stream
),
327 field
, stream
->pos
.offset
);
329 BT_LOGV("Set packet context field's `content_size` field's value: "
330 "stream-addr=%p, stream-name=\"%s\", field-addr=%p, value=%" PRId64
,
331 stream
, bt_stream_get_name(stream
),
332 field
, stream
->pos
.offset
);
341 int set_packet_context_events_discarded(struct bt_stream
*stream
)
344 struct bt_field
*field
= bt_field_structure_get_field_by_name(
345 stream
->packet_context
, "events_discarded");
350 /* No discarded events count field found. Not an error, skip. */
351 BT_LOGV("No field named `events_discarded` in packet context: skipping: "
352 "stream-addr=%p, stream-name=\"%s\"",
353 stream
, bt_stream_get_name(stream
));
358 * If the field is set by the user, make sure that the value is
359 * greater than or equal to the stream's current count of
360 * discarded events. We do not allow wrapping here. If it's
361 * valid, update the stream's current count.
363 if (bt_field_is_set(field
)) {
366 ret
= bt_field_unsigned_integer_get_value(field
,
369 BT_LOGW("Cannot get packet context `events_discarded` field's unsigned value: "
370 "stream-addr=%p, stream-name=\"%s\", field-addr=%p",
371 stream
, bt_stream_get_name(stream
), field
);
375 if (user_val
< stream
->discarded_events
) {
376 BT_LOGW("Invalid packet context `events_discarded` field's unsigned value: "
377 "value is lesser than the stream's current discarded events count: "
378 "stream-addr=%p, stream-name=\"%s\", field-addr=%p, "
379 "value=%" PRIu64
", "
380 "stream-discarded-events-count=%" PRIu64
,
381 stream
, bt_stream_get_name(stream
), field
,
382 user_val
, stream
->discarded_events
);
386 stream
->discarded_events
= user_val
;
388 ret
= bt_field_unsigned_integer_set_value(field
,
389 stream
->discarded_events
);
391 BT_LOGW("Cannot set packet context field's `events_discarded` integer field's value: "
392 "stream-addr=%p, stream-name=\"%s\", field-addr=%p, value=%" PRIu64
,
393 stream
, bt_stream_get_name(stream
),
394 field
, stream
->discarded_events
);
396 BT_LOGV("Set packet context field's `events_discarded` field's value: "
397 "stream-addr=%p, stream-name=\"%s\", field-addr=%p, value=%" PRIu64
,
398 stream
, bt_stream_get_name(stream
),
399 field
, stream
->discarded_events
);
409 void update_clock_value(uint64_t *val
, uint64_t new_val
,
410 unsigned int new_val_size
)
412 const uint64_t pow2
= 1ULL << new_val_size
;
413 const uint64_t mask
= pow2
- 1;
416 #ifdef BT_LOG_ENABLED_VERBOSE
417 uint64_t old_val
= *val
;
420 if (new_val_size
== 64) {
425 val_masked
= *val
& mask
;
427 if (new_val
< val_masked
) {
436 BT_LOGV("Updated clock value: old-val=%" PRIu64
", new-val=%" PRIu64
,
442 int visit_field_update_clock_value(struct bt_field
*field
, uint64_t *val
)
450 switch (bt_field_get_type_id(field
)) {
451 case BT_FIELD_TYPE_ID_INTEGER
:
453 struct bt_clock_class
*cc
=
454 bt_field_type_integer_get_mapped_clock_class(
464 val_size
= bt_field_type_integer_get_size(field
->type
);
465 assert(val_size
>= 1);
467 if (bt_field_type_integer_is_signed(field
->type
)) {
470 ret
= bt_field_signed_integer_get_value(field
, &ival
);
471 uval
= (uint64_t) ival
;
473 ret
= bt_field_unsigned_integer_get_value(field
, &uval
);
481 update_clock_value(val
, uval
, val_size
);
484 case BT_FIELD_TYPE_ID_ENUM
:
486 struct bt_field
*int_field
=
487 bt_field_enumeration_get_container(field
);
490 ret
= visit_field_update_clock_value(int_field
, val
);
494 case BT_FIELD_TYPE_ID_ARRAY
:
497 int64_t len
= bt_field_type_array_get_length(field
->type
);
501 for (i
= 0; i
< len
; i
++) {
502 struct bt_field
*elem_field
=
503 bt_field_array_get_field(field
, i
);
506 ret
= visit_field_update_clock_value(elem_field
, val
);
514 case BT_FIELD_TYPE_ID_SEQUENCE
:
517 int64_t len
= bt_field_sequence_get_int_length(field
);
524 for (i
= 0; i
< len
; i
++) {
525 struct bt_field
*elem_field
=
526 bt_field_sequence_get_field(field
, i
);
529 ret
= visit_field_update_clock_value(elem_field
, val
);
537 case BT_FIELD_TYPE_ID_STRUCT
:
540 int64_t len
= bt_field_type_structure_get_field_count(
545 for (i
= 0; i
< len
; i
++) {
546 struct bt_field
*member_field
=
547 bt_field_structure_get_field_by_index(field
, i
);
549 assert(member_field
);
550 ret
= visit_field_update_clock_value(member_field
, val
);
551 bt_put(member_field
);
558 case BT_FIELD_TYPE_ID_VARIANT
:
560 struct bt_field
*cur_field
=
561 bt_field_variant_get_current_field(field
);
568 ret
= visit_field_update_clock_value(cur_field
, val
);
580 int visit_event_update_clock_value(struct bt_event
*event
, uint64_t *val
)
583 struct bt_field
*field
;
585 field
= bt_event_get_header(event
);
586 ret
= visit_field_update_clock_value(field
, val
);
589 BT_LOGW_STR("Cannot automatically update clock value in "
594 field
= bt_event_get_stream_event_context(event
);
595 ret
= visit_field_update_clock_value(field
, val
);
598 BT_LOGW_STR("Cannot automatically update clock value in "
599 "event's stream event context.");
603 field
= bt_event_get_event_context(event
);
604 ret
= visit_field_update_clock_value(field
, val
);
607 BT_LOGW_STR("Cannot automatically update clock value in "
612 field
= bt_event_get_event_payload(event
);
613 ret
= visit_field_update_clock_value(field
, val
);
616 BT_LOGW_STR("Cannot automatically update clock value in "
626 int set_packet_context_timestamps(struct bt_stream
*stream
)
630 uint64_t cur_clock_value
;
631 uint64_t init_clock_value
= 0;
632 struct bt_field
*ts_begin_field
= bt_field_structure_get_field_by_name(
633 stream
->packet_context
, "timestamp_begin");
634 struct bt_field
*ts_end_field
= bt_field_structure_get_field_by_name(
635 stream
->packet_context
, "timestamp_end");
639 if (ts_begin_field
&& bt_field_is_set(ts_begin_field
)) {
640 /* Use provided `timestamp_begin` value as starting value */
641 ret
= bt_field_unsigned_integer_get_value(ts_begin_field
, &val
);
643 init_clock_value
= val
;
644 } else if (stream
->last_ts_end
!= -1ULL) {
645 /* Use last packet's ending timestamp as starting value */
646 init_clock_value
= stream
->last_ts_end
;
649 cur_clock_value
= init_clock_value
;
651 if (stream
->last_ts_end
!= -1ULL &&
652 cur_clock_value
< stream
->last_ts_end
) {
653 BT_LOGW("Packet's initial timestamp is less than previous "
654 "packet's final timestamp: "
655 "stream-addr=%p, stream-name=\"%s\", "
656 "cur-packet-ts-begin=%" PRIu64
", "
657 "prev-packet-ts-end=%" PRIu64
,
658 stream
, bt_stream_get_name(stream
),
659 cur_clock_value
, stream
->last_ts_end
);
665 * Visit all the packet context fields, followed by all the
666 * fields of all the events, in order, updating our current
667 * clock value as we visit.
669 * While visiting the packet context fields, do not consider
670 * `timestamp_begin` and `timestamp_end` because this function's
671 * purpose is to set them anyway. Also do not consider
672 * `packet_size`, `content_size`, `events_discarded`, and
673 * `packet_seq_num` if they are not set because those are
674 * autopopulating fields.
676 len
= bt_field_type_structure_get_field_count(
677 stream
->packet_context
->type
);
680 for (i
= 0; i
< len
; i
++) {
681 const char *member_name
;
682 struct bt_field
*member_field
;
684 ret
= bt_field_type_structure_get_field_by_index(
685 stream
->packet_context
->type
, &member_name
, NULL
, i
);
688 if (strcmp(member_name
, "timestamp_begin") == 0 ||
689 strcmp(member_name
, "timestamp_end") == 0) {
693 member_field
= bt_field_structure_get_field_by_index(
694 stream
->packet_context
, i
);
695 assert(member_field
);
697 if (strcmp(member_name
, "packet_size") == 0 &&
698 !bt_field_is_set(member_field
)) {
699 bt_put(member_field
);
703 if (strcmp(member_name
, "content_size") == 0 &&
704 !bt_field_is_set(member_field
)) {
705 bt_put(member_field
);
709 if (strcmp(member_name
, "events_discarded") == 0 &&
710 !bt_field_is_set(member_field
)) {
711 bt_put(member_field
);
715 if (strcmp(member_name
, "packet_seq_num") == 0 &&
716 !bt_field_is_set(member_field
)) {
717 bt_put(member_field
);
721 ret
= visit_field_update_clock_value(member_field
,
723 bt_put(member_field
);
725 BT_LOGW("Cannot automatically update clock value "
726 "in stream's packet context: "
727 "stream-addr=%p, stream-name=\"%s\", "
729 stream
, bt_stream_get_name(stream
),
735 for (i
= 0; i
< stream
->events
->len
; i
++) {
736 struct bt_event
*event
= g_ptr_array_index(stream
->events
, i
);
739 ret
= visit_event_update_clock_value(event
, &cur_clock_value
);
741 BT_LOGW("Cannot automatically update clock value "
742 "in stream's packet context: "
743 "stream-addr=%p, stream-name=\"%s\", "
744 "index=%" PRIu64
", event-addr=%p, "
745 "event-class-id=%" PRId64
", "
746 "event-class-name=\"%s\"",
747 stream
, bt_stream_get_name(stream
),
749 bt_event_class_get_id(event
->event_class
),
750 bt_event_class_get_name(event
->event_class
));
756 * Everything is visited, thus the current clock value
757 * corresponds to the ending timestamp. Validate this value
758 * against the provided value of `timestamp_end`, if any,
761 if (ts_end_field
&& bt_field_is_set(ts_end_field
)) {
762 ret
= bt_field_unsigned_integer_get_value(ts_end_field
, &val
);
765 if (val
< cur_clock_value
) {
766 BT_LOGW("Packet's final timestamp is less than "
767 "computed packet's final timestamp: "
768 "stream-addr=%p, stream-name=\"%s\", "
769 "cur-packet-ts-end=%" PRIu64
", "
770 "computed-packet-ts-end=%" PRIu64
,
771 stream
, bt_stream_get_name(stream
),
772 val
, cur_clock_value
);
777 stream
->last_ts_end
= val
;
780 if (ts_end_field
&& !bt_field_is_set(ts_end_field
)) {
781 ret
= set_integer_field_value(ts_end_field
, cur_clock_value
);
783 stream
->last_ts_end
= cur_clock_value
;
787 stream
->last_ts_end
= cur_clock_value
;
790 /* Set `timestamp_begin` field to initial clock value */
791 if (ts_begin_field
&& !bt_field_is_set(ts_begin_field
)) {
792 ret
= set_integer_field_value(ts_begin_field
, init_clock_value
);
797 bt_put(ts_begin_field
);
798 bt_put(ts_end_field
);
803 int auto_populate_packet_context(struct bt_stream
*stream
, bool set_ts
)
807 if (!stream
->packet_context
) {
811 ret
= set_packet_context_packet_size(stream
);
813 BT_LOGW("Cannot set packet context's packet size field: "
814 "stream-addr=%p, stream-name=\"%s\"",
815 stream
, bt_stream_get_name(stream
));
819 ret
= set_packet_context_content_size(stream
);
821 BT_LOGW("Cannot set packet context's content size field: "
822 "stream-addr=%p, stream-name=\"%s\"",
823 stream
, bt_stream_get_name(stream
));
828 ret
= set_packet_context_timestamps(stream
);
830 BT_LOGW("Cannot set packet context's timestamp fields: "
831 "stream-addr=%p, stream-name=\"%s\"",
832 stream
, bt_stream_get_name(stream
));
837 ret
= set_packet_context_events_discarded(stream
);
839 BT_LOGW("Cannot set packet context's discarded events count field: "
840 "stream-addr=%p, stream-name=\"%s\"",
841 stream
, bt_stream_get_name(stream
));
845 BT_LOGV("Automatically populated stream's packet context's known fields: "
846 "stream-addr=%p, stream-name=\"%s\"",
847 stream
, bt_stream_get_name(stream
));
854 void release_event(struct bt_event
*event
)
856 if (bt_object_get_ref_count(event
)) {
858 * The event is being orphaned, but it must guarantee the
859 * existence of its event class for the duration of its
862 bt_get(event
->event_class
);
863 BT_PUT(event
->base
.parent
);
865 bt_object_release(event
);
870 int create_stream_file(struct bt_ctf_writer
*writer
,
871 struct bt_stream
*stream
)
874 GString
*filename
= g_string_new(NULL
);
875 int64_t stream_class_id
;
876 char *file_path
= NULL
;
878 BT_LOGD("Creating stream file: writer-addr=%p, stream-addr=%p, "
879 "stream-name=\"%s\", stream-class-addr=%p, stream-class-name=\"%s\"",
880 writer
, stream
, bt_stream_get_name(stream
),
881 stream
->stream_class
, stream
->stream_class
->name
->str
);
883 if (stream
->name
&& stream
->name
->len
> 0) {
884 /* Use stream name's base name as prefix */
885 gchar
*basename
= g_path_get_basename(stream
->name
->str
);
889 if (strcmp(basename
, G_DIR_SEPARATOR_S
) == 0) {
890 g_string_assign(filename
, "stream");
892 g_string_assign(filename
, basename
);
899 if (stream
->stream_class
->name
&&
900 stream
->stream_class
->name
->len
> 0) {
901 /* Use stream class name's base name as prefix */
903 g_path_get_basename(stream
->stream_class
->name
->str
);
907 if (strcmp(basename
, G_DIR_SEPARATOR_S
) == 0) {
908 g_string_assign(filename
, "stream");
910 g_string_assign(filename
, basename
);
917 /* Default to using `stream-` as prefix */
918 g_string_assign(filename
, "stream");
921 stream_class_id
= bt_stream_class_get_id(stream
->stream_class
);
922 assert(stream_class_id
>= 0);
923 assert(stream
->id
>= 0);
924 g_string_append_printf(filename
, "-%" PRId64
"-%" PRId64
,
925 stream_class_id
, stream
->id
);
927 file_path
= g_build_filename(writer
->path
->str
, filename
->str
, NULL
);
928 if (file_path
== NULL
) {
934 O_RDWR
| O_CREAT
| O_TRUNC
,
935 S_IRUSR
| S_IWUSR
| S_IRGRP
| S_IWGRP
);
938 BT_LOGW_ERRNO("Failed to open stream file for writing",
939 ": file_path=\"%s\", filename=\"%s\", ret=%d",
940 file_path
, filename
->str
, fd
);
944 BT_LOGD("Created stream file for writing: "
945 "stream-addr=%p, stream-name=\"%s\", "
946 "filename=\"%s\", fd=%d", stream
, bt_stream_get_name(stream
),
950 g_string_free(filename
, TRUE
);
955 void set_stream_fd(struct bt_stream
*stream
, int fd
)
957 (void) bt_stream_pos_init(&stream
->pos
, fd
, O_RDWR
);
962 void component_destroy_listener(struct bt_component
*component
, void *data
)
964 struct bt_stream
*stream
= data
;
966 BT_LOGD("Component is being destroyed, stream is notified: "
967 "comp-addr=%p, stream-addr=%p", component
, stream
);
968 g_hash_table_remove(stream
->comp_cur_port
, component
);
972 struct bt_stream
*bt_stream_create_with_id_no_check(
973 struct bt_stream_class
*stream_class
,
974 const char *name
, uint64_t id
)
977 struct bt_stream
*stream
= NULL
;
978 struct bt_trace
*trace
= NULL
;
979 struct bt_ctf_writer
*writer
= NULL
;
982 BT_LOGW_STR("Invalid parameter: stream class is NULL.");
986 BT_LOGD("Creating stream object: stream-class-addr=%p, "
987 "stream-class-name=\"%s\", stream-name=\"%s\", "
988 "stream-id=%" PRIu64
,
989 stream_class
, bt_stream_class_get_name(stream_class
),
991 trace
= bt_stream_class_borrow_trace(stream_class
);
993 BT_LOGW("Invalid parameter: cannot create stream from a stream class which is not part of trace: "
994 "stream-class-addr=%p, stream-class-name=\"%s\", "
995 "stream-name=\"%s\"",
996 stream_class
, bt_stream_class_get_name(stream_class
),
1001 if (bt_trace_is_static(trace
)) {
1003 * A static trace has the property that all its stream
1004 * classes, clock classes, and streams are definitive:
1005 * no more can be added, and each object is also frozen.
1007 BT_LOGW("Invalid parameter: cannot create stream from a stream class which is part of a static trace: "
1008 "stream-class-addr=%p, stream-class-name=\"%s\", "
1009 "stream-name=\"%s\", trace-addr=%p",
1010 stream_class
, bt_stream_class_get_name(stream_class
),
1017 * Validate that the given ID is unique amongst all the
1018 * existing trace's streams created from the same stream
1023 for (i
= 0; i
< trace
->streams
->len
; i
++) {
1024 struct bt_stream
*trace_stream
=
1025 g_ptr_array_index(trace
->streams
, i
);
1027 if (trace_stream
->stream_class
!= stream_class
) {
1031 if (trace_stream
->id
== id
) {
1032 BT_LOGW_STR("Invalid parameter: another stream in the same trace already has this ID.");
1038 stream
= g_new0(struct bt_stream
, 1);
1040 BT_LOGE_STR("Failed to allocate one stream.");
1044 bt_object_init(stream
, bt_stream_destroy
);
1046 * Acquire reference to parent since stream will become publicly
1047 * reachable; it needs its parent to remain valid.
1049 bt_object_set_parent(stream
, trace
);
1050 stream
->stream_class
= stream_class
;
1051 stream
->pos
.fd
= -1;
1052 stream
->id
= (int64_t) id
;
1054 stream
->destroy_listeners
= g_array_new(FALSE
, TRUE
,
1055 sizeof(struct bt_stream_destroy_listener
));
1056 if (!stream
->destroy_listeners
) {
1057 BT_LOGE_STR("Failed to allocate a GArray.");
1062 stream
->name
= g_string_new(name
);
1063 if (!stream
->name
) {
1064 BT_LOGE_STR("Failed to allocate a GString.");
1069 BT_LOGD("Set stream's trace parent: trace-addr=%p", trace
);
1071 if (trace
->is_created_by_writer
) {
1074 writer
= (struct bt_ctf_writer
*) bt_object_get_parent(trace
);
1075 stream
->id
= (int64_t) stream_class
->next_stream_id
++;
1076 stream
->last_ts_end
= -1ULL;
1078 BT_LOGD("Stream object belongs to a writer's trace: "
1079 "writer-addr=%p", writer
);
1082 if (stream_class
->packet_context_type
) {
1083 BT_LOGD("Creating stream's packet context field: "
1084 "ft-addr=%p", stream_class
->packet_context_type
);
1085 stream
->packet_context
= bt_field_create(
1086 stream_class
->packet_context_type
);
1087 if (!stream
->packet_context
) {
1088 BT_LOGW_STR("Cannot create stream's packet context field.");
1092 /* Initialize events_discarded */
1093 ret
= try_set_structure_field_integer(
1094 stream
->packet_context
, "events_discarded", 0);
1096 BT_LOGW("Cannot set `events_discarded` field in packet context: "
1097 "ret=%d, packet-context-field-addr=%p",
1098 ret
, stream
->packet_context
);
1103 stream
->events
= g_ptr_array_new_with_free_func(
1104 (GDestroyNotify
) release_event
);
1105 if (!stream
->events
) {
1106 BT_LOGE_STR("Failed to allocate a GPtrArray.");
1110 if (trace
->packet_header_type
) {
1111 BT_LOGD("Creating stream's packet header field: "
1112 "ft-addr=%p", trace
->packet_header_type
);
1113 stream
->packet_header
=
1114 bt_field_create(trace
->packet_header_type
);
1115 if (!stream
->packet_header
) {
1116 BT_LOGW_STR("Cannot create stream's packet header field.");
1122 * Attempt to populate the default trace packet header fields
1123 * (magic, uuid and stream_id). This will _not_ fail shall the
1124 * fields not be found or be of an incompatible type; they will
1125 * simply not be populated automatically. The user will have to
1126 * make sure to set the trace packet header fields himself
1129 ret
= auto_populate_packet_header(stream
);
1131 BT_LOGW_STR("Cannot automatically populate the stream's packet header.");
1135 /* Create file associated with this stream */
1136 fd
= create_stream_file(writer
, stream
);
1138 BT_LOGW_STR("Cannot create stream file.");
1142 set_stream_fd(stream
, fd
);
1144 /* Freeze the writer */
1145 BT_LOGD_STR("Freezing stream's CTF writer.");
1146 bt_ctf_writer_freeze(writer
);
1148 /* Non-writer stream indicated by a negative FD */
1149 set_stream_fd(stream
, -1);
1150 stream
->comp_cur_port
= g_hash_table_new(g_direct_hash
,
1152 if (!stream
->comp_cur_port
) {
1153 BT_LOGE_STR("Failed to allocate a GHashTable.");
1158 /* Add this stream to the trace's streams */
1159 g_ptr_array_add(trace
->streams
, stream
);
1160 BT_LOGD("Created stream object: addr=%p", stream
);
1171 struct bt_stream
*bt_stream_create_with_id(
1172 struct bt_stream_class
*stream_class
,
1173 const char *name
, uint64_t id_param
)
1175 struct bt_trace
*trace
;
1176 struct bt_stream
*stream
= NULL
;
1177 int64_t id
= (int64_t) id_param
;
1179 if (!stream_class
) {
1180 BT_LOGW_STR("Invalid parameter: stream class is NULL.");
1185 BT_LOGW("Invalid parameter: invalid stream's ID: "
1186 "name=\"%s\", id=%" PRIu64
,
1191 trace
= bt_stream_class_borrow_trace(stream_class
);
1193 BT_LOGW("Invalid parameter: cannot create stream from a stream class which is not part of trace: "
1194 "stream-class-addr=%p, stream-class-name=\"%s\", "
1195 "stream-name=\"%s\", stream-id=%" PRIu64
,
1196 stream_class
, bt_stream_class_get_name(stream_class
),
1201 if (trace
->is_created_by_writer
) {
1202 BT_LOGW("Invalid parameter: cannot create a CTF writer stream with this function; use bt_stream_create(): "
1203 "stream-class-addr=%p, stream-class-name=\"%s\", "
1204 "stream-name=\"%s\", stream-id=%" PRIu64
,
1205 stream_class
, bt_stream_class_get_name(stream_class
),
1210 stream
= bt_stream_create_with_id_no_check(stream_class
,
1217 struct bt_stream
*bt_stream_create(
1218 struct bt_stream_class
*stream_class
,
1221 return bt_stream_create_with_id_no_check(stream_class
,
1225 struct bt_stream_class
*bt_stream_get_class(
1226 struct bt_stream
*stream
)
1228 struct bt_stream_class
*stream_class
= NULL
;
1231 BT_LOGW_STR("Invalid parameter: stream is NULL.");
1235 stream_class
= stream
->stream_class
;
1236 bt_get(stream_class
);
1238 return stream_class
;
1241 int bt_stream_get_discarded_events_count(
1242 struct bt_stream
*stream
, uint64_t *count
)
1247 BT_LOGW_STR("Invalid parameter: stream is NULL.");
1253 BT_LOGW_STR("Invalid parameter: count is NULL.");
1258 if (stream
->pos
.fd
< 0) {
1259 BT_LOGW("Invalid parameter: stream is not a CTF writer stream: "
1260 "stream-addr=%p, stream-name=\"%s\"",
1261 stream
, bt_stream_get_name(stream
));
1266 *count
= (uint64_t) stream
->discarded_events
;
1273 int set_packet_context_events_discarded_field(struct bt_stream
*stream
,
1277 struct bt_field
*events_discarded_field
= NULL
;
1279 if (!stream
->packet_context
) {
1283 events_discarded_field
= bt_field_structure_get_field_by_name(
1284 stream
->packet_context
, "events_discarded");
1285 if (!events_discarded_field
) {
1289 ret
= bt_field_unsigned_integer_set_value(
1290 events_discarded_field
, count
);
1292 BT_LOGW("Cannot set packet context's `events_discarded` field: "
1293 "field-addr=%p, value=%" PRIu64
,
1294 events_discarded_field
, count
);
1299 bt_put(events_discarded_field
);
1303 void bt_stream_append_discarded_events(struct bt_stream
*stream
,
1304 uint64_t event_count
)
1308 struct bt_field
*events_discarded_field
= NULL
;
1311 BT_LOGW_STR("Invalid parameter: stream is NULL.");
1315 BT_LOGV("Appending discarded events to stream: "
1316 "stream-addr=%p, stream-name=\"%s\", append-count=%" PRIu64
,
1317 stream
, bt_stream_get_name(stream
), event_count
);
1319 if (!stream
->packet_context
) {
1320 BT_LOGW_STR("Invalid parameter: stream has no packet context field.");
1324 if (stream
->pos
.fd
< 0) {
1325 BT_LOGW_STR("Invalid parameter: stream is not a CTF writer stream.");
1329 events_discarded_field
= bt_field_structure_get_field_by_name(
1330 stream
->packet_context
, "events_discarded");
1331 if (!events_discarded_field
) {
1332 BT_LOGW_STR("No field named `events_discarded` in stream's packet context.");
1336 new_count
= stream
->discarded_events
+ event_count
;
1337 if (new_count
< stream
->discarded_events
) {
1338 BT_LOGW("New discarded events count is less than the stream's current discarded events count: "
1339 "cur-count=%" PRIu64
", new-count=%" PRIu64
,
1340 stream
->discarded_events
, new_count
);
1344 ret
= set_packet_context_events_discarded_field(stream
, new_count
);
1346 /* set_packet_context_events_discarded_field() logs errors */
1350 stream
->discarded_events
= new_count
;
1351 BT_LOGV("Appended discarded events to stream: "
1352 "stream-addr=%p, stream-name=\"%s\", append-count=%" PRIu64
,
1353 stream
, bt_stream_get_name(stream
), event_count
);
1356 bt_put(events_discarded_field
);
1359 static int auto_populate_event_header(struct bt_stream
*stream
,
1360 struct bt_event
*event
)
1363 struct bt_field
*id_field
= NULL
, *timestamp_field
= NULL
;
1364 struct bt_clock_class
*mapped_clock_class
= NULL
;
1365 int64_t event_class_id
;
1369 if (!event
->event_header
) {
1373 if (event
->frozen
) {
1374 BT_LOGW_STR("Cannot populate event header field: event is frozen.");
1379 BT_LOGV("Automatically populating event's header field: "
1380 "stream-addr=%p, stream-name=\"%s\", event-addr=%p",
1381 stream
, bt_stream_get_name(stream
), event
);
1383 id_field
= bt_field_structure_get_field_by_name(event
->event_header
, "id");
1384 event_class_id
= bt_event_class_get_id(event
->event_class
);
1385 assert(event_class_id
>= 0);
1387 if (id_field
&& bt_field_type_is_integer(id_field
->type
)) {
1388 ret
= set_integer_field_value(id_field
, event_class_id
);
1390 BT_LOGW("Cannot set event header's `id` field's value: "
1391 "addr=%p, value=%" PRIu64
, id_field
,
1398 * The conditions to automatically set the timestamp are:
1400 * 1. The event header field "timestamp" exists and is an
1402 * 2. This stream's class has a registered clock (set with
1403 * bt_stream_class_set_clock()).
1404 * 3. The "timestamp" field is not set.
1406 timestamp_field
= bt_field_structure_get_field_by_name(
1407 event
->event_header
, "timestamp");
1408 if (timestamp_field
&& stream
->stream_class
->clock
&&
1409 bt_field_type_is_integer(timestamp_field
->type
) &&
1410 !bt_field_is_set(timestamp_field
)) {
1411 struct bt_clock_class
*stream_class_clock_class
=
1412 stream
->stream_class
->clock
->clock_class
;
1414 mapped_clock_class
=
1415 bt_field_type_integer_get_mapped_clock_class(
1416 timestamp_field
->type
);
1417 if (mapped_clock_class
) {
1420 assert(mapped_clock_class
== stream_class_clock_class
);
1421 ret
= bt_ctf_clock_get_value(
1422 stream
->stream_class
->clock
,
1425 ret
= set_integer_field_value(timestamp_field
,
1428 BT_LOGW("Cannot set event header's `timestamp` field's value: "
1429 "addr=%p, value=%" PRIu64
,
1430 timestamp_field
, timestamp
);
1436 BT_LOGV("Automatically populated event's header field: "
1437 "stream-addr=%p, stream-name=\"%s\", event-addr=%p",
1438 stream
, bt_stream_get_name(stream
), event
);
1442 bt_put(timestamp_field
);
1443 bt_put(mapped_clock_class
);
1447 int bt_stream_append_event(struct bt_stream
*stream
,
1448 struct bt_event
*event
)
1453 BT_LOGW_STR("Invalid parameter: stream is NULL.");
1459 BT_LOGW_STR("Invalid parameter: event is NULL.");
1464 if (stream
->pos
.fd
< 0) {
1465 BT_LOGW_STR("Invalid parameter: stream is not a CTF writer stream.");
1470 BT_LOGV("Appending event to stream: "
1471 "stream-addr=%p, stream-name=\"%s\", event-addr=%p, "
1472 "event-class-name=\"%s\", event-class-id=%" PRId64
,
1473 stream
, bt_stream_get_name(stream
), event
,
1474 bt_event_class_get_name(bt_event_borrow_event_class(event
)),
1475 bt_event_class_get_id(bt_event_borrow_event_class(event
)));
1478 * The event is not supposed to have a parent stream at this
1479 * point. The only other way an event can have a parent stream
1480 * is if it was assigned when setting a packet to the event,
1481 * in which case the packet's stream is not a writer stream,
1482 * and thus the user is trying to append an event which belongs
1483 * to another stream.
1485 if (event
->base
.parent
) {
1490 bt_object_set_parent(event
, stream
);
1491 BT_LOGV_STR("Automatically populating the header of the event to append.");
1492 ret
= auto_populate_event_header(stream
, event
);
1494 /* auto_populate_event_header() reports errors */
1498 /* Make sure the various scopes of the event are set */
1499 BT_LOGV_STR("Validating event to append.");
1500 ret
= bt_event_validate(event
);
1505 /* Save the new event and freeze it */
1506 BT_LOGV_STR("Freezing the event to append.");
1507 bt_event_freeze(event
);
1508 g_ptr_array_add(stream
->events
, event
);
1511 * Event had to hold a reference to its event class as long as it wasn't
1512 * part of the same trace hierarchy. From now on, the event and its
1513 * class share the same lifetime guarantees and the reference is no
1516 BT_LOGV_STR("Putting the event's class.");
1517 bt_put(event
->event_class
);
1518 BT_LOGV("Appended event to stream: "
1519 "stream-addr=%p, stream-name=\"%s\", event-addr=%p, "
1520 "event-class-name=\"%s\", event-class-id=%" PRId64
,
1521 stream
, bt_stream_get_name(stream
), event
,
1522 bt_event_class_get_name(bt_event_borrow_event_class(event
)),
1523 bt_event_class_get_id(bt_event_borrow_event_class(event
)));
1530 * Orphan the event; we were not successful in associating it to
1533 bt_object_set_parent(event
, NULL
);
1538 struct bt_field
*bt_stream_get_packet_context(struct bt_stream
*stream
)
1540 struct bt_field
*packet_context
= NULL
;
1543 BT_LOGW_STR("Invalid parameter: stream is NULL.");
1547 if (stream
->pos
.fd
< 0) {
1548 BT_LOGW("Invalid parameter: stream is not a CTF writer stream: "
1549 "stream-addr=%p, stream-name=\"%s\"", stream
,
1550 bt_stream_get_name(stream
));
1554 packet_context
= stream
->packet_context
;
1555 if (packet_context
) {
1556 bt_get(packet_context
);
1559 return packet_context
;
1562 int bt_stream_set_packet_context(struct bt_stream
*stream
,
1563 struct bt_field
*field
)
1566 struct bt_field_type
*field_type
;
1569 BT_LOGW_STR("Invalid parameter: stream is NULL.");
1574 if (stream
->pos
.fd
< 0) {
1575 BT_LOGW_STR("Invalid parameter: stream is not a CTF writer stream.");
1580 field_type
= bt_field_get_type(field
);
1581 if (bt_field_type_compare(field_type
,
1582 stream
->stream_class
->packet_context_type
)) {
1583 BT_LOGW("Invalid parameter: packet context's field type is different from the stream's packet context field type: "
1584 "stream-addr=%p, stream-name=\"%s\", "
1585 "packet-context-field-addr=%p, "
1586 "packet-context-ft-addr=%p",
1587 stream
, bt_stream_get_name(stream
),
1594 bt_put(stream
->packet_context
);
1595 stream
->packet_context
= bt_get(field
);
1596 BT_LOGV("Set stream's packet context field: "
1597 "stream-addr=%p, stream-name=\"%s\", "
1598 "packet-context-field-addr=%p",
1599 stream
, bt_stream_get_name(stream
), field
);
1604 struct bt_field
*bt_stream_get_packet_header(struct bt_stream
*stream
)
1606 struct bt_field
*packet_header
= NULL
;
1609 BT_LOGW_STR("Invalid parameter: stream is NULL.");
1613 if (stream
->pos
.fd
< 0) {
1614 BT_LOGW("Invalid parameter: stream is not a CTF writer stream: "
1615 "stream-addr=%p, stream-name=\"%s\"", stream
,
1616 bt_stream_get_name(stream
));
1620 packet_header
= stream
->packet_header
;
1621 if (packet_header
) {
1622 bt_get(packet_header
);
1625 return packet_header
;
1628 int bt_stream_set_packet_header(struct bt_stream
*stream
,
1629 struct bt_field
*field
)
1632 struct bt_trace
*trace
= NULL
;
1633 struct bt_field_type
*field_type
= NULL
;
1636 BT_LOGW_STR("Invalid parameter: stream is NULL.");
1641 if (stream
->pos
.fd
< 0) {
1642 BT_LOGW_STR("Invalid parameter: stream is not a CTF writer stream.");
1647 trace
= (struct bt_trace
*) bt_object_get_parent(stream
);
1650 if (trace
->packet_header_type
) {
1651 BT_LOGW("Invalid parameter: setting no packet header but packet header field type is not NULL: "
1652 "stream-addr=%p, stream-name=\"%s\", "
1653 "packet-header-field-addr=%p, "
1654 "expected-ft-addr=%p",
1655 stream
, bt_stream_get_name(stream
),
1656 field
, trace
->packet_header_type
);
1661 goto skip_validation
;
1664 field_type
= bt_field_get_type(field
);
1667 if (bt_field_type_compare(field_type
, trace
->packet_header_type
)) {
1668 BT_LOGW("Invalid parameter: packet header's field type is different from the stream's packet header field type: "
1669 "stream-addr=%p, stream-name=\"%s\", "
1670 "packet-header-field-addr=%p, "
1671 "packet-header-ft-addr=%p",
1672 stream
, bt_stream_get_name(stream
),
1679 bt_put(stream
->packet_header
);
1680 stream
->packet_header
= bt_get(field
);
1681 BT_LOGV("Set stream's packet header field: "
1682 "stream-addr=%p, stream-name=\"%s\", "
1683 "packet-header-field-addr=%p",
1684 stream
, bt_stream_get_name(stream
), field
);
1692 void reset_structure_field(struct bt_field
*structure
, const char *name
)
1694 struct bt_field
*member
;
1696 member
= bt_field_structure_get_field_by_name(structure
, name
);
1698 (void) bt_field_reset(member
);
1703 int bt_stream_flush(struct bt_stream
*stream
)
1707 struct bt_stream_pos packet_context_pos
;
1708 struct bt_trace
*trace
;
1709 enum bt_byte_order native_byte_order
;
1710 bool has_packet_size
= false;
1713 BT_LOGW_STR("Invalid parameter: stream is NULL.");
1718 if (stream
->pos
.fd
< 0) {
1719 BT_LOGW_STR("Invalid parameter: stream is not a CTF writer stream.");
1724 if (stream
->packet_context
) {
1725 struct bt_field
*packet_size_field
;
1727 packet_size_field
= bt_field_structure_get_field_by_name(
1728 stream
->packet_context
, "packet_size");
1729 has_packet_size
= (packet_size_field
!= NULL
);
1730 bt_put(packet_size_field
);
1733 if (stream
->flushed_packet_count
== 1) {
1734 if (!stream
->packet_context
) {
1735 BT_LOGW_STR("Cannot flush a stream which has no packet context field more than once.");
1740 if (!has_packet_size
) {
1741 BT_LOGW_STR("Cannot flush a stream which has no packet context's `packet_size` field more than once.");
1747 BT_LOGV("Flushing stream's current packet: stream-addr=%p, "
1748 "stream-name=\"%s\", packet-index=%u", stream
,
1749 bt_stream_get_name(stream
), stream
->flushed_packet_count
);
1750 trace
= bt_stream_class_borrow_trace(stream
->stream_class
);
1752 native_byte_order
= bt_trace_get_native_byte_order(trace
);
1754 ret
= auto_populate_packet_header(stream
);
1756 BT_LOGW_STR("Cannot automatically populate the stream's packet header field.");
1761 ret
= auto_populate_packet_context(stream
, true);
1763 BT_LOGW_STR("Cannot automatically populate the stream's packet context field.");
1768 /* mmap the next packet */
1769 BT_LOGV("Seeking to the next packet: pos-offset=%" PRId64
,
1770 stream
->pos
.offset
);
1771 bt_stream_pos_packet_seek(&stream
->pos
, 0, SEEK_CUR
);
1772 assert(stream
->pos
.packet_size
% 8 == 0);
1774 if (stream
->packet_header
) {
1775 BT_LOGV_STR("Serializing packet header field.");
1776 ret
= bt_field_serialize(stream
->packet_header
, &stream
->pos
,
1779 BT_LOGW("Cannot serialize stream's packet header field: "
1780 "field-addr=%p", stream
->packet_header
);
1785 if (stream
->packet_context
) {
1786 /* Write packet context */
1787 memcpy(&packet_context_pos
, &stream
->pos
,
1788 sizeof(packet_context_pos
));
1789 BT_LOGV_STR("Serializing packet context field.");
1790 ret
= bt_field_serialize(stream
->packet_context
,
1791 &stream
->pos
, native_byte_order
);
1793 BT_LOGW("Cannot serialize stream's packet context field: "
1794 "field-addr=%p", stream
->packet_context
);
1799 BT_LOGV("Serializing events: count=%u", stream
->events
->len
);
1801 for (i
= 0; i
< stream
->events
->len
; i
++) {
1802 struct bt_event
*event
= g_ptr_array_index(
1804 struct bt_event_class
*event_class
=
1805 bt_event_borrow_event_class(event
);
1807 BT_LOGV("Serializing event: index=%zu, event-addr=%p, "
1808 "event-class-name=\"%s\", event-class-id=%" PRId64
", "
1809 "pos-offset=%" PRId64
", packet-size=%" PRIu64
,
1810 i
, event
, bt_event_class_get_name(event_class
),
1811 bt_event_class_get_id(event_class
),
1812 stream
->pos
.offset
, stream
->pos
.packet_size
);
1814 /* Write event header */
1815 if (event
->event_header
) {
1816 BT_LOGV_STR("Serializing event's header field.");
1817 ret
= bt_field_serialize(event
->event_header
,
1818 &stream
->pos
, native_byte_order
);
1820 BT_LOGW("Cannot serialize event's header field: "
1821 "field-addr=%p", event
->event_header
);
1826 /* Write stream event context */
1827 if (event
->stream_event_context
) {
1828 BT_LOGV_STR("Serializing event's stream event context field.");
1829 ret
= bt_field_serialize(
1830 event
->stream_event_context
, &stream
->pos
,
1833 BT_LOGW("Cannot serialize event's stream event context field: "
1834 "field-addr=%p", event
->stream_event_context
);
1839 /* Write event content */
1840 ret
= bt_event_serialize(event
, &stream
->pos
,
1843 /* bt_event_serialize() logs errors */
1848 if (!has_packet_size
&& stream
->pos
.offset
% 8 != 0) {
1849 BT_LOGW("Stream's packet context field type has no `packet_size` field, "
1850 "but current content size is not a multiple of 8 bits: "
1851 "content-size=%" PRId64
", "
1852 "packet-size=%" PRIu64
,
1854 stream
->pos
.packet_size
);
1859 assert(stream
->pos
.packet_size
% 8 == 0);
1862 * Remove extra padding bytes.
1864 stream
->pos
.packet_size
= (stream
->pos
.offset
+ 7) & ~7;
1866 if (stream
->packet_context
) {
1868 * The whole packet is serialized at this point. Make sure that,
1869 * if `packet_size` is missing, the current content size is
1870 * equal to the current packet size.
1872 struct bt_field
*field
= bt_field_structure_get_field_by_name(
1873 stream
->packet_context
, "content_size");
1877 if (stream
->pos
.offset
!= stream
->pos
.packet_size
) {
1878 BT_LOGW("Stream's packet context's `content_size` field is missing, "
1879 "but current packet's content size is not equal to its packet size: "
1880 "content-size=%" PRId64
", "
1881 "packet-size=%" PRIu64
,
1883 stream
->pos
.packet_size
);
1890 * Overwrite the packet context now that the stream
1891 * position's packet and content sizes have the correct
1894 * Copy base_mma as the packet may have been remapped
1895 * (e.g. when a packet is resized).
1897 packet_context_pos
.base_mma
= stream
->pos
.base_mma
;
1898 ret
= auto_populate_packet_context(stream
, false);
1900 BT_LOGW_STR("Cannot automatically populate the stream's packet context field.");
1905 BT_LOGV("Rewriting (serializing) packet context field.");
1906 ret
= bt_field_serialize(stream
->packet_context
,
1907 &packet_context_pos
, native_byte_order
);
1909 BT_LOGW("Cannot serialize stream's packet context field: "
1910 "field-addr=%p", stream
->packet_context
);
1915 g_ptr_array_set_size(stream
->events
, 0);
1916 stream
->flushed_packet_count
++;
1917 stream
->size
+= stream
->pos
.packet_size
/ CHAR_BIT
;
1920 /* Reset automatically-set fields. */
1921 if (stream
->packet_context
) {
1922 reset_structure_field(stream
->packet_context
, "timestamp_begin");
1923 reset_structure_field(stream
->packet_context
, "timestamp_end");
1924 reset_structure_field(stream
->packet_context
, "packet_size");
1925 reset_structure_field(stream
->packet_context
, "content_size");
1926 reset_structure_field(stream
->packet_context
, "events_discarded");
1931 * We failed to write the packet. Its size is therefore set to 0
1932 * to ensure the next mapping is done in the same place rather
1933 * than advancing by "stream->pos.packet_size", which would
1934 * leave a corrupted packet in the trace.
1936 stream
->pos
.packet_size
= 0;
1938 BT_LOGV("Flushed stream's current packet: content-size=%" PRId64
", "
1939 "packet-size=%" PRIu64
,
1940 stream
->pos
.offset
, stream
->pos
.packet_size
);
1947 /* Pre-2.0 CTF writer backward compatibility */
1948 void bt_ctf_stream_get(struct bt_stream
*stream
)
1953 /* Pre-2.0 CTF writer backward compatibility */
1954 void bt_ctf_stream_put(struct bt_stream
*stream
)
1960 void bt_stream_destroy(struct bt_object
*obj
)
1962 struct bt_stream
*stream
;
1965 stream
= container_of(obj
, struct bt_stream
, base
);
1966 BT_LOGD("Destroying stream object: addr=%p, name=\"%s\"",
1967 stream
, bt_stream_get_name(stream
));
1969 /* Call destroy listeners in reverse registration order */
1970 for (i
= stream
->destroy_listeners
->len
- 1; i
>= 0; i
--) {
1971 struct bt_stream_destroy_listener
*listener
=
1972 &g_array_index(stream
->destroy_listeners
,
1973 struct bt_stream_destroy_listener
, i
);
1975 BT_LOGD("Calling destroy listener: func=%p, data=%p, index=%d",
1976 listener
->func
, listener
->data
, i
);
1977 listener
->func(stream
, listener
->data
);
1980 (void) bt_stream_pos_fini(&stream
->pos
);
1981 if (stream
->pos
.fd
>= 0) {
1985 * Truncate the file's size to the minimum required to fit the
1986 * last packet as we might have grown it too much on the last
1990 ret
= ftruncate(stream
->pos
.fd
, stream
->size
);
1991 } while (ret
== -1 && errno
== EINTR
);
1993 BT_LOGE_ERRNO("Failed to truncate stream file",
1994 ": ret=%d, size=%" PRIu64
,
1995 ret
, (uint64_t) stream
->size
);
1998 if (close(stream
->pos
.fd
)) {
1999 BT_LOGE_ERRNO("Failed to close stream file",
2004 if (stream
->events
) {
2005 BT_LOGD_STR("Putting events.");
2006 g_ptr_array_free(stream
->events
, TRUE
);
2010 g_string_free(stream
->name
, TRUE
);
2013 if (stream
->comp_cur_port
) {
2014 GHashTableIter ht_iter
;
2015 gpointer comp_gptr
, port_gptr
;
2018 * Since we're destroying the stream, remove the destroy
2019 * listeners that it registered for each component in
2020 * its component-port mapping hash table. Otherwise they
2021 * would be called and the stream would be accessed once
2022 * it's freed or another stream would be accessed.
2024 g_hash_table_iter_init(&ht_iter
, stream
->comp_cur_port
);
2026 while (g_hash_table_iter_next(&ht_iter
, &comp_gptr
, &port_gptr
)) {
2028 bt_component_remove_destroy_listener((void *) comp_gptr
,
2029 component_destroy_listener
, stream
);
2032 g_hash_table_destroy(stream
->comp_cur_port
);
2035 if (stream
->destroy_listeners
) {
2036 g_array_free(stream
->destroy_listeners
, TRUE
);
2039 BT_LOGD_STR("Putting packet header field.");
2040 bt_put(stream
->packet_header
);
2041 BT_LOGD_STR("Putting packet context field.");
2042 bt_put(stream
->packet_context
);
2047 int _set_structure_field_integer(struct bt_field
*structure
, char *name
,
2048 uint64_t value
, bt_bool force
)
2051 struct bt_field_type
*field_type
= NULL
;
2052 struct bt_field
*integer
;
2057 integer
= bt_field_structure_get_field_by_name(structure
, name
);
2059 /* Field not found, not an error. */
2060 BT_LOGV("Field not found: struct-field-addr=%p, "
2061 "name=\"%s\", force=%d", structure
, name
, force
);
2065 /* Make sure the payload has not already been set. */
2066 if (!force
&& bt_field_is_set(integer
)) {
2067 /* Payload already set, not an error */
2068 BT_LOGV("Field's payload is already set: struct-field-addr=%p, "
2069 "name=\"%s\", force=%d", structure
, name
, force
);
2073 field_type
= bt_field_get_type(integer
);
2075 if (bt_field_type_get_type_id(field_type
) != BT_FIELD_TYPE_ID_INTEGER
) {
2077 * The user most likely meant for us to populate this field
2078 * automatically. However, we can only do this if the field
2079 * is an integer. Return an error.
2081 BT_LOGW("Invalid parameter: field's type is not an integer field type: "
2082 "field-addr=%p, ft-addr=%p, ft-id=%s",
2083 integer
, field_type
,
2084 bt_field_type_id_string(field_type
->id
));
2089 if (bt_field_type_integer_is_signed(field_type
)) {
2090 ret
= bt_field_signed_integer_set_value(integer
,
2093 ret
= bt_field_unsigned_integer_set_value(integer
, value
);
2095 ret
= !ret
? 1 : ret
;
2103 * Returns the following codes:
2104 * 1 if the field was found and set,
2105 * 0 if nothing was done (field not found, or was already set),
2106 * <0 if an error was encoutered
2109 int try_set_structure_field_integer(struct bt_field
*structure
, char *name
,
2112 return _set_structure_field_integer(structure
, name
, value
, BT_FALSE
);
2115 const char *bt_stream_get_name(struct bt_stream
*stream
)
2117 const char *name
= NULL
;
2120 BT_LOGW_STR("Invalid parameter: stream is NULL.");
2124 name
= stream
->name
? stream
->name
->str
: NULL
;
2130 int bt_stream_is_writer(struct bt_stream
*stream
)
2135 BT_LOGW_STR("Invalid parameter: stream is NULL.");
2139 ret
= (stream
->pos
.fd
>= 0);
2146 void bt_stream_map_component_to_port(struct bt_stream
*stream
,
2147 struct bt_component
*comp
,
2148 struct bt_port
*port
)
2153 assert(stream
->comp_cur_port
);
2156 * Do not take a reference to the component here because we
2157 * don't want the component to exist as long as this stream
2158 * exists. Instead, keep a weak reference, but add a destroy
2159 * listener so that we remove this hash table entry when we know
2160 * the component is destroyed.
2162 BT_LOGV("Adding component's destroy listener for stream: "
2163 "stream-addr=%p, stream-name=\"%s\", comp-addr=%p, "
2164 "comp-name=\"%s\", port-addr=%p, port-name=\"%s\"",
2165 stream
, bt_stream_get_name(stream
),
2166 comp
, bt_component_get_name(comp
), port
,
2167 bt_port_get_name(port
));
2168 bt_component_add_destroy_listener(comp
, component_destroy_listener
,
2170 g_hash_table_insert(stream
->comp_cur_port
, comp
, port
);
2171 BT_LOGV_STR("Mapped component to port for stream.");
2175 struct bt_port
*bt_stream_port_for_component(struct bt_stream
*stream
,
2176 struct bt_component
*comp
)
2180 assert(stream
->comp_cur_port
);
2181 return g_hash_table_lookup(stream
->comp_cur_port
, comp
);
2185 void bt_stream_add_destroy_listener(struct bt_stream
*stream
,
2186 bt_stream_destroy_listener_func func
, void *data
)
2188 struct bt_stream_destroy_listener listener
;
2192 listener
.func
= func
;
2193 listener
.data
= data
;
2194 g_array_append_val(stream
->destroy_listeners
, listener
);
2195 BT_LOGV("Added stream destroy listener: stream-addr=%p, "
2196 "stream-name=\"%s\", func=%p, data=%p",
2197 stream
, bt_stream_get_name(stream
), func
, data
);
2201 void bt_stream_remove_destroy_listener(struct bt_stream
*stream
,
2202 bt_stream_destroy_listener_func func
, void *data
)
2209 for (i
= 0; i
< stream
->destroy_listeners
->len
; i
++) {
2210 struct bt_stream_destroy_listener
*listener
=
2211 &g_array_index(stream
->destroy_listeners
,
2212 struct bt_stream_destroy_listener
, i
);
2214 if (listener
->func
== func
&& listener
->data
== data
) {
2215 g_array_remove_index(stream
->destroy_listeners
, i
);
2217 BT_LOGV("Removed stream destroy listener: stream-addr=%p, "
2218 "stream-name=\"%s\", func=%p, data=%p",
2219 stream
, bt_stream_get_name(stream
),
2225 int64_t bt_stream_get_id(struct bt_stream
*stream
)
2230 BT_LOGW_STR("Invalid parameter: stream is NULL.");
2237 BT_LOGV("Stream's ID is not set: addr=%p, name=\"%s\"",
2238 stream
, bt_stream_get_name(stream
));