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 int get_event_header_timestamp(struct bt_stream
*stream
,
410 struct bt_field
*event_header
, uint64_t *timestamp
)
413 struct bt_field
*timestamp_field
= NULL
;
414 struct bt_clock_class
*ts_field_mapped_clock_class
= NULL
;
419 BT_LOGV_STR("Event header does not exist.");
423 timestamp_field
= bt_field_structure_get_field_by_name(event_header
,
425 if (!timestamp_field
) {
426 BT_LOGV("Cannot get event header's `timestamp` field: "
427 "event-header-field-addr=%p", event_header
);
431 if (!bt_field_type_is_integer(timestamp_field
->type
)) {
432 BT_LOGV("Event header's `timestamp` field's type is not an integer field type: "
433 "event-header-field-addr=%p", event_header
);
437 ts_field_mapped_clock_class
=
438 bt_field_type_integer_get_mapped_clock_class(
439 timestamp_field
->type
);
440 if (!ts_field_mapped_clock_class
) {
441 BT_LOGV("Event header's `timestamp` field's type is not mapped to a clock class: "
442 "event-header-field-addr=%p", event_header
);
446 if (ts_field_mapped_clock_class
!=
447 stream
->stream_class
->clock
->clock_class
) {
448 BT_LOGV("Event header's `timestamp` field's type is not mapped to the stream's clock's class: "
449 "event-header-field-addr=%p", event_header
);
453 ret
= bt_field_unsigned_integer_get_value(timestamp_field
,
456 BT_LOGW("Cannot get unsigned integer field's value: "
457 "event-header-field-addr=%p, "
458 "timestamp-field-addr=%p",
459 event_header
, timestamp_field
);
464 bt_put(timestamp_field
);
465 bt_put(ts_field_mapped_clock_class
);
470 int set_packet_context_timestamp_field(struct bt_stream
*stream
,
471 const char *field_name
, struct bt_event
*event
)
474 struct bt_field
*field
= bt_field_structure_get_field_by_name(
475 stream
->packet_context
, field_name
);
476 struct bt_clock_class
*field_mapped_clock_class
= NULL
;
482 /* No beginning timestamp field found. Not an error, skip. */
483 BT_LOGV("No field named `%s` in packet context: skipping: "
484 "stream-addr=%p, stream-name=\"%s\"", field_name
,
485 stream
, bt_stream_get_name(stream
));
489 if (!stream
->stream_class
->clock
) {
490 BT_LOGV("Stream has no clock: skipping: "
491 "stream-addr=%p, stream-name=\"%s\"",
492 stream
, bt_stream_get_name(stream
));
496 field_mapped_clock_class
=
497 bt_field_type_integer_get_mapped_clock_class(field
->type
);
498 if (field_mapped_clock_class
&& field_mapped_clock_class
!=
499 stream
->stream_class
->clock
->clock_class
) {
500 BT_LOGV("Packet context's `%s` field's type is not mapped to the stream's clock's class: skipping: "
501 "stream-addr=%p, stream-name=\"%s\", "
502 "field-addr=%p, ft-addr=%p, "
503 "ft-mapped-clock-class-addr=%p, "
504 "ft-mapped-clock-class-name=\"%s\", "
505 "stream-clock-class-addr=%p, "
506 "stream-clock-class-name=\"%s\"",
508 stream
, bt_stream_get_name(stream
),
510 field_mapped_clock_class
,
511 bt_clock_class_get_name(field_mapped_clock_class
),
512 stream
->stream_class
->clock
->clock_class
,
513 bt_clock_class_get_name(
514 stream
->stream_class
->clock
->clock_class
));
518 if (get_event_header_timestamp(stream
, event
->event_header
, &ts
)) {
519 BT_LOGW("Cannot get event's timestamp: "
520 "event-header-field-addr=%p",
521 event
->event_header
);
526 ret
= bt_field_unsigned_integer_set_value(field
, ts
);
528 BT_LOGW("Cannot set packet context field's `%s` integer field's value: "
529 "stream-addr=%p, stream-name=\"%s\", field-addr=%p, value=%" PRIu64
,
530 field_name
, stream
, bt_stream_get_name(stream
),
531 field
, stream
->discarded_events
);
533 BT_LOGV("Set packet context field's `%s` field's value: "
534 "stream-addr=%p, stream-name=\"%s\", field-addr=%p, value=%" PRIu64
,
535 field_name
, stream
, bt_stream_get_name(stream
),
536 field
, stream
->discarded_events
);
541 bt_put(field_mapped_clock_class
);
546 int set_packet_context_timestamp_begin(struct bt_stream
*stream
)
550 if (stream
->events
->len
== 0) {
551 BT_LOGV("Current packet contains no events: skipping: "
552 "stream-addr=%p, stream-name=\"%s\"",
553 stream
, bt_stream_get_name(stream
));
557 ret
= set_packet_context_timestamp_field(stream
, "timestamp_begin",
558 g_ptr_array_index(stream
->events
, 0));
565 int set_packet_context_timestamp_end(struct bt_stream
*stream
)
569 if (stream
->events
->len
== 0) {
570 BT_LOGV("Current packet contains no events: skipping: "
571 "stream-addr=%p, stream-name=\"%s\"",
572 stream
, bt_stream_get_name(stream
));
576 ret
= set_packet_context_timestamp_field(stream
, "timestamp_end",
577 g_ptr_array_index(stream
->events
, stream
->events
->len
- 1));
584 int auto_populate_packet_context(struct bt_stream
*stream
)
588 if (!stream
->packet_context
) {
592 ret
= set_packet_context_packet_size(stream
);
594 BT_LOGW("Cannot set packet context's packet size field: "
595 "stream-addr=%p, stream-name=\"%s\"",
596 stream
, bt_stream_get_name(stream
));
600 ret
= set_packet_context_content_size(stream
);
602 BT_LOGW("Cannot set packet context's content size field: "
603 "stream-addr=%p, stream-name=\"%s\"",
604 stream
, bt_stream_get_name(stream
));
608 ret
= set_packet_context_timestamp_begin(stream
);
610 BT_LOGW("Cannot set packet context's beginning timestamp field: "
611 "stream-addr=%p, stream-name=\"%s\"",
612 stream
, bt_stream_get_name(stream
));
616 ret
= set_packet_context_timestamp_end(stream
);
618 BT_LOGW("Cannot set packet context's end timestamp field: "
619 "stream-addr=%p, stream-name=\"%s\"",
620 stream
, bt_stream_get_name(stream
));
624 ret
= set_packet_context_events_discarded(stream
);
626 BT_LOGW("Cannot set packet context's discarded events count field: "
627 "stream-addr=%p, stream-name=\"%s\"",
628 stream
, bt_stream_get_name(stream
));
632 BT_LOGV("Automatically populated stream's packet context's known fields: "
633 "stream-addr=%p, stream-name=\"%s\"",
634 stream
, bt_stream_get_name(stream
));
641 void release_event(struct bt_event
*event
)
643 if (bt_object_get_ref_count(event
)) {
645 * The event is being orphaned, but it must guarantee the
646 * existence of its event class for the duration of its
649 bt_get(event
->event_class
);
650 BT_PUT(event
->base
.parent
);
652 bt_object_release(event
);
657 int create_stream_file(struct bt_ctf_writer
*writer
,
658 struct bt_stream
*stream
)
661 GString
*filename
= g_string_new(NULL
);
662 int64_t stream_class_id
;
663 char *file_path
= NULL
;
665 BT_LOGD("Creating stream file: writer-addr=%p, stream-addr=%p, "
666 "stream-name=\"%s\", stream-class-addr=%p, stream-class-name=\"%s\"",
667 writer
, stream
, bt_stream_get_name(stream
),
668 stream
->stream_class
, stream
->stream_class
->name
->str
);
670 if (stream
->name
&& stream
->name
->len
> 0) {
671 /* Use stream name's base name as prefix */
672 gchar
*basename
= g_path_get_basename(stream
->name
->str
);
676 if (strcmp(basename
, G_DIR_SEPARATOR_S
) == 0) {
677 g_string_assign(filename
, "stream");
679 g_string_assign(filename
, basename
);
686 if (stream
->stream_class
->name
&&
687 stream
->stream_class
->name
->len
> 0) {
688 /* Use stream class name's base name as prefix */
690 g_path_get_basename(stream
->stream_class
->name
->str
);
694 if (strcmp(basename
, G_DIR_SEPARATOR_S
) == 0) {
695 g_string_assign(filename
, "stream");
697 g_string_assign(filename
, basename
);
704 /* Default to using `stream-` as prefix */
705 g_string_assign(filename
, "stream");
708 stream_class_id
= bt_stream_class_get_id(stream
->stream_class
);
709 assert(stream_class_id
>= 0);
710 assert(stream
->id
>= 0);
711 g_string_append_printf(filename
, "-%" PRId64
"-%" PRId64
,
712 stream_class_id
, stream
->id
);
714 file_path
= g_build_filename(writer
->path
->str
, filename
->str
, NULL
);
715 if (file_path
== NULL
) {
721 O_RDWR
| O_CREAT
| O_TRUNC
,
722 S_IRUSR
| S_IWUSR
| S_IRGRP
| S_IWGRP
);
725 BT_LOGW_ERRNO("Failed to open stream file for writing",
726 ": file_path=\"%s\", filename=\"%s\", ret=%d",
727 file_path
, filename
->str
, fd
);
731 BT_LOGD("Created stream file for writing: "
732 "stream-addr=%p, stream-name=\"%s\", "
733 "filename=\"%s\", fd=%d", stream
, bt_stream_get_name(stream
),
737 g_string_free(filename
, TRUE
);
742 void set_stream_fd(struct bt_stream
*stream
, int fd
)
744 (void) bt_stream_pos_init(&stream
->pos
, fd
, O_RDWR
);
749 void component_destroy_listener(struct bt_component
*component
, void *data
)
751 struct bt_stream
*stream
= data
;
753 BT_LOGD("Component is being destroyed, stream is notified: "
754 "comp-addr=%p, stream-addr=%p", component
, stream
);
755 g_hash_table_remove(stream
->comp_cur_port
, component
);
759 struct bt_stream
*bt_stream_create_with_id_no_check(
760 struct bt_stream_class
*stream_class
,
761 const char *name
, uint64_t id
)
764 struct bt_stream
*stream
= NULL
;
765 struct bt_trace
*trace
= NULL
;
766 struct bt_ctf_writer
*writer
= NULL
;
769 BT_LOGW_STR("Invalid parameter: stream class is NULL.");
773 BT_LOGD("Creating stream object: stream-class-addr=%p, "
774 "stream-class-name=\"%s\", stream-name=\"%s\", "
775 "stream-id=%" PRIu64
,
776 stream_class
, bt_stream_class_get_name(stream_class
),
778 trace
= bt_stream_class_borrow_trace(stream_class
);
780 BT_LOGW("Invalid parameter: cannot create stream from a stream class which is not part of trace: "
781 "stream-class-addr=%p, stream-class-name=\"%s\", "
782 "stream-name=\"%s\"",
783 stream_class
, bt_stream_class_get_name(stream_class
),
788 if (bt_trace_is_static(trace
)) {
790 * A static trace has the property that all its stream
791 * classes, clock classes, and streams are definitive:
792 * no more can be added, and each object is also frozen.
794 BT_LOGW("Invalid parameter: cannot create stream from a stream class which is part of a static trace: "
795 "stream-class-addr=%p, stream-class-name=\"%s\", "
796 "stream-name=\"%s\", trace-addr=%p",
797 stream_class
, bt_stream_class_get_name(stream_class
),
804 * Validate that the given ID is unique amongst all the
805 * existing trace's streams created from the same stream
810 for (i
= 0; i
< trace
->streams
->len
; i
++) {
811 struct bt_stream
*trace_stream
=
812 g_ptr_array_index(trace
->streams
, i
);
814 if (trace_stream
->stream_class
!= stream_class
) {
818 if (trace_stream
->id
== id
) {
819 BT_LOGW_STR("Invalid parameter: another stream in the same trace already has this ID.");
825 stream
= g_new0(struct bt_stream
, 1);
827 BT_LOGE_STR("Failed to allocate one stream.");
831 bt_object_init(stream
, bt_stream_destroy
);
833 * Acquire reference to parent since stream will become publicly
834 * reachable; it needs its parent to remain valid.
836 bt_object_set_parent(stream
, trace
);
837 stream
->stream_class
= stream_class
;
839 stream
->id
= (int64_t) id
;
841 stream
->destroy_listeners
= g_array_new(FALSE
, TRUE
,
842 sizeof(struct bt_stream_destroy_listener
));
843 if (!stream
->destroy_listeners
) {
844 BT_LOGE_STR("Failed to allocate a GArray.");
849 stream
->name
= g_string_new(name
);
851 BT_LOGE_STR("Failed to allocate a GString.");
856 BT_LOGD("Set stream's trace parent: trace-addr=%p", trace
);
858 if (trace
->is_created_by_writer
) {
860 writer
= (struct bt_ctf_writer
*) bt_object_get_parent(trace
);
861 stream
->id
= (int64_t) stream_class
->next_stream_id
++;
863 BT_LOGD("Stream object belongs to a writer's trace: "
864 "writer-addr=%p", writer
);
867 if (stream_class
->packet_context_type
) {
868 BT_LOGD("Creating stream's packet context field: "
869 "ft-addr=%p", stream_class
->packet_context_type
);
870 stream
->packet_context
= bt_field_create(
871 stream_class
->packet_context_type
);
872 if (!stream
->packet_context
) {
873 BT_LOGW_STR("Cannot create stream's packet context field.");
877 /* Initialize events_discarded */
878 ret
= try_set_structure_field_integer(
879 stream
->packet_context
, "events_discarded", 0);
881 BT_LOGW("Cannot set `events_discarded` field in packet context: "
882 "ret=%d, packet-context-field-addr=%p",
883 ret
, stream
->packet_context
);
888 stream
->events
= g_ptr_array_new_with_free_func(
889 (GDestroyNotify
) release_event
);
890 if (!stream
->events
) {
891 BT_LOGE_STR("Failed to allocate a GPtrArray.");
895 if (trace
->packet_header_type
) {
896 BT_LOGD("Creating stream's packet header field: "
897 "ft-addr=%p", trace
->packet_header_type
);
898 stream
->packet_header
=
899 bt_field_create(trace
->packet_header_type
);
900 if (!stream
->packet_header
) {
901 BT_LOGW_STR("Cannot create stream's packet header field.");
907 * Attempt to populate the default trace packet header fields
908 * (magic, uuid and stream_id). This will _not_ fail shall the
909 * fields not be found or be of an incompatible type; they will
910 * simply not be populated automatically. The user will have to
911 * make sure to set the trace packet header fields himself
914 ret
= auto_populate_packet_header(stream
);
916 BT_LOGW_STR("Cannot automatically populate the stream's packet header.");
920 /* Create file associated with this stream */
921 fd
= create_stream_file(writer
, stream
);
923 BT_LOGW_STR("Cannot create stream file.");
927 set_stream_fd(stream
, fd
);
929 /* Freeze the writer */
930 BT_LOGD_STR("Freezing stream's CTF writer.");
931 bt_ctf_writer_freeze(writer
);
933 /* Non-writer stream indicated by a negative FD */
934 set_stream_fd(stream
, -1);
935 stream
->comp_cur_port
= g_hash_table_new(g_direct_hash
,
937 if (!stream
->comp_cur_port
) {
938 BT_LOGE_STR("Failed to allocate a GHashTable.");
943 /* Add this stream to the trace's streams */
944 g_ptr_array_add(trace
->streams
, stream
);
945 BT_LOGD("Created stream object: addr=%p", stream
);
956 struct bt_stream
*bt_stream_create_with_id(
957 struct bt_stream_class
*stream_class
,
958 const char *name
, uint64_t id_param
)
960 struct bt_trace
*trace
;
961 struct bt_stream
*stream
= NULL
;
962 int64_t id
= (int64_t) id_param
;
965 BT_LOGW_STR("Invalid parameter: stream class is NULL.");
970 BT_LOGW("Invalid parameter: invalid stream's ID: "
971 "name=\"%s\", id=%" PRIu64
,
976 trace
= bt_stream_class_borrow_trace(stream_class
);
978 BT_LOGW("Invalid parameter: cannot create stream from a stream class which is not part of trace: "
979 "stream-class-addr=%p, stream-class-name=\"%s\", "
980 "stream-name=\"%s\", stream-id=%" PRIu64
,
981 stream_class
, bt_stream_class_get_name(stream_class
),
986 if (trace
->is_created_by_writer
) {
987 BT_LOGW("Invalid parameter: cannot create a CTF writer stream with this function; use bt_stream_create(): "
988 "stream-class-addr=%p, stream-class-name=\"%s\", "
989 "stream-name=\"%s\", stream-id=%" PRIu64
,
990 stream_class
, bt_stream_class_get_name(stream_class
),
995 stream
= bt_stream_create_with_id_no_check(stream_class
,
1002 struct bt_stream
*bt_stream_create(
1003 struct bt_stream_class
*stream_class
,
1006 return bt_stream_create_with_id_no_check(stream_class
,
1010 struct bt_stream_class
*bt_stream_get_class(
1011 struct bt_stream
*stream
)
1013 struct bt_stream_class
*stream_class
= NULL
;
1016 BT_LOGW_STR("Invalid parameter: stream is NULL.");
1020 stream_class
= stream
->stream_class
;
1021 bt_get(stream_class
);
1023 return stream_class
;
1026 int bt_stream_get_discarded_events_count(
1027 struct bt_stream
*stream
, uint64_t *count
)
1032 BT_LOGW_STR("Invalid parameter: stream is NULL.");
1038 BT_LOGW_STR("Invalid parameter: count is NULL.");
1043 if (stream
->pos
.fd
< 0) {
1044 BT_LOGW("Invalid parameter: stream is not a CTF writer stream: "
1045 "stream-addr=%p, stream-name=\"%s\"",
1046 stream
, bt_stream_get_name(stream
));
1051 *count
= (uint64_t) stream
->discarded_events
;
1058 int set_packet_context_events_discarded_field(struct bt_stream
*stream
,
1062 struct bt_field
*events_discarded_field
= NULL
;
1064 if (!stream
->packet_context
) {
1068 events_discarded_field
= bt_field_structure_get_field_by_name(
1069 stream
->packet_context
, "events_discarded");
1070 if (!events_discarded_field
) {
1074 ret
= bt_field_unsigned_integer_set_value(
1075 events_discarded_field
, count
);
1077 BT_LOGW("Cannot set packet context's `events_discarded` field: "
1078 "field-addr=%p, value=%" PRIu64
,
1079 events_discarded_field
, count
);
1084 bt_put(events_discarded_field
);
1088 void bt_stream_append_discarded_events(struct bt_stream
*stream
,
1089 uint64_t event_count
)
1093 struct bt_field
*events_discarded_field
= NULL
;
1096 BT_LOGW_STR("Invalid parameter: stream is NULL.");
1100 BT_LOGV("Appending discarded events to stream: "
1101 "stream-addr=%p, stream-name=\"%s\", append-count=%" PRIu64
,
1102 stream
, bt_stream_get_name(stream
), event_count
);
1104 if (!stream
->packet_context
) {
1105 BT_LOGW_STR("Invalid parameter: stream has no packet context field.");
1109 if (stream
->pos
.fd
< 0) {
1110 BT_LOGW_STR("Invalid parameter: stream is not a CTF writer stream.");
1114 events_discarded_field
= bt_field_structure_get_field_by_name(
1115 stream
->packet_context
, "events_discarded");
1116 if (!events_discarded_field
) {
1117 BT_LOGW_STR("No field named `events_discarded` in stream's packet context.");
1121 new_count
= stream
->discarded_events
+ event_count
;
1122 if (new_count
< stream
->discarded_events
) {
1123 BT_LOGW("New discarded events count is less than the stream's current discarded events count: "
1124 "cur-count=%" PRIu64
", new-count=%" PRIu64
,
1125 stream
->discarded_events
, new_count
);
1129 ret
= set_packet_context_events_discarded_field(stream
, new_count
);
1131 /* set_packet_context_events_discarded_field() logs errors */
1135 stream
->discarded_events
= new_count
;
1136 BT_LOGV("Appended discarded events to stream: "
1137 "stream-addr=%p, stream-name=\"%s\", append-count=%" PRIu64
,
1138 stream
, bt_stream_get_name(stream
), event_count
);
1141 bt_put(events_discarded_field
);
1144 static int auto_populate_event_header(struct bt_stream
*stream
,
1145 struct bt_event
*event
)
1148 struct bt_field
*id_field
= NULL
, *timestamp_field
= NULL
;
1149 struct bt_clock_class
*mapped_clock_class
= NULL
;
1150 int64_t event_class_id
;
1154 if (!event
->event_header
) {
1158 if (event
->frozen
) {
1159 BT_LOGW_STR("Cannot populate event header field: event is frozen.");
1164 BT_LOGV("Automatically populating event's header field: "
1165 "stream-addr=%p, stream-name=\"%s\", event-addr=%p",
1166 stream
, bt_stream_get_name(stream
), event
);
1168 id_field
= bt_field_structure_get_field_by_name(event
->event_header
, "id");
1169 event_class_id
= bt_event_class_get_id(event
->event_class
);
1170 if (event_class_id
< 0) {
1171 BT_LOGE("Event class ID cannot be found");
1175 if (id_field
&& bt_field_type_is_integer(id_field
->type
)) {
1176 ret
= set_integer_field_value(id_field
, event_class_id
);
1178 BT_LOGW("Cannot set event header's `id` field's value: "
1179 "addr=%p, value=%" PRIu64
, id_field
,
1186 * The conditions to automatically set the timestamp are:
1188 * 1. The event header field "timestamp" exists and is an
1190 * 2. This stream's class has a registered clock (set with
1191 * bt_stream_class_set_clock()).
1192 * 3. The event header field "timestamp" has its type mapped to
1193 * a clock class which is also the clock class of this
1194 * stream's class's registered clock.
1196 timestamp_field
= bt_field_structure_get_field_by_name(event
->event_header
,
1198 if (timestamp_field
&& stream
->stream_class
->clock
&&
1199 bt_field_type_is_integer(timestamp_field
->type
)) {
1200 struct bt_clock_class
*stream_class_clock_class
=
1201 stream
->stream_class
->clock
->clock_class
;
1203 mapped_clock_class
=
1204 bt_field_type_integer_get_mapped_clock_class(
1205 timestamp_field
->type
);
1206 if (!mapped_clock_class
||
1207 mapped_clock_class
== stream_class_clock_class
) {
1210 ret
= bt_ctf_clock_get_value(
1211 stream
->stream_class
->clock
,
1214 ret
= set_integer_field_value(timestamp_field
,
1217 BT_LOGW("Cannot set event header's `timestamp` field's value: "
1218 "addr=%p, value=%" PRIu64
,
1219 timestamp_field
, timestamp
);
1225 BT_LOGV("Automatically populated event's header field: "
1226 "stream-addr=%p, stream-name=\"%s\", event-addr=%p",
1227 stream
, bt_stream_get_name(stream
), event
);
1231 bt_put(timestamp_field
);
1232 bt_put(mapped_clock_class
);
1236 int bt_stream_append_event(struct bt_stream
*stream
,
1237 struct bt_event
*event
)
1242 BT_LOGW_STR("Invalid parameter: stream is NULL.");
1248 BT_LOGW_STR("Invalid parameter: event is NULL.");
1253 if (stream
->pos
.fd
< 0) {
1254 BT_LOGW_STR("Invalid parameter: stream is not a CTF writer stream.");
1259 BT_LOGV("Appending event to stream: "
1260 "stream-addr=%p, stream-name=\"%s\", event-addr=%p, "
1261 "event-class-name=\"%s\", event-class-id=%" PRId64
,
1262 stream
, bt_stream_get_name(stream
), event
,
1263 bt_event_class_get_name(bt_event_borrow_event_class(event
)),
1264 bt_event_class_get_id(bt_event_borrow_event_class(event
)));
1267 * The event is not supposed to have a parent stream at this
1268 * point. The only other way an event can have a parent stream
1269 * is if it was assigned when setting a packet to the event,
1270 * in which case the packet's stream is not a writer stream,
1271 * and thus the user is trying to append an event which belongs
1272 * to another stream.
1274 if (event
->base
.parent
) {
1279 bt_object_set_parent(event
, stream
);
1280 BT_LOGV_STR("Automatically populating the header of the event to append.");
1281 ret
= auto_populate_event_header(stream
, event
);
1283 /* auto_populate_event_header() reports errors */
1287 /* Make sure the various scopes of the event are set */
1288 BT_LOGV_STR("Validating event to append.");
1289 ret
= bt_event_validate(event
);
1294 /* Save the new event and freeze it */
1295 BT_LOGV_STR("Freezing the event to append.");
1296 bt_event_freeze(event
);
1297 g_ptr_array_add(stream
->events
, event
);
1300 * Event had to hold a reference to its event class as long as it wasn't
1301 * part of the same trace hierarchy. From now on, the event and its
1302 * class share the same lifetime guarantees and the reference is no
1305 BT_LOGV_STR("Putting the event's class.");
1306 bt_put(event
->event_class
);
1307 BT_LOGV("Appended event to stream: "
1308 "stream-addr=%p, stream-name=\"%s\", event-addr=%p, "
1309 "event-class-name=\"%s\", event-class-id=%" PRId64
,
1310 stream
, bt_stream_get_name(stream
), event
,
1311 bt_event_class_get_name(bt_event_borrow_event_class(event
)),
1312 bt_event_class_get_id(bt_event_borrow_event_class(event
)));
1319 * Orphan the event; we were not successful in associating it to
1322 bt_object_set_parent(event
, NULL
);
1327 struct bt_field
*bt_stream_get_packet_context(struct bt_stream
*stream
)
1329 struct bt_field
*packet_context
= NULL
;
1332 BT_LOGW_STR("Invalid parameter: stream is NULL.");
1336 if (stream
->pos
.fd
< 0) {
1337 BT_LOGW("Invalid parameter: stream is not a CTF writer stream: "
1338 "stream-addr=%p, stream-name=\"%s\"", stream
,
1339 bt_stream_get_name(stream
));
1343 packet_context
= stream
->packet_context
;
1344 if (packet_context
) {
1345 bt_get(packet_context
);
1348 return packet_context
;
1351 int bt_stream_set_packet_context(struct bt_stream
*stream
,
1352 struct bt_field
*field
)
1355 struct bt_field_type
*field_type
;
1358 BT_LOGW_STR("Invalid parameter: stream is NULL.");
1363 if (stream
->pos
.fd
< 0) {
1364 BT_LOGW_STR("Invalid parameter: stream is not a CTF writer stream.");
1369 field_type
= bt_field_get_type(field
);
1370 if (bt_field_type_compare(field_type
,
1371 stream
->stream_class
->packet_context_type
)) {
1372 BT_LOGW("Invalid parameter: packet context's field type is different from the stream's packet context field type: "
1373 "stream-addr=%p, stream-name=\"%s\", "
1374 "packet-context-field-addr=%p, "
1375 "packet-context-ft-addr=%p",
1376 stream
, bt_stream_get_name(stream
),
1383 bt_put(stream
->packet_context
);
1384 stream
->packet_context
= bt_get(field
);
1385 BT_LOGV("Set stream's packet context field: "
1386 "stream-addr=%p, stream-name=\"%s\", "
1387 "packet-context-field-addr=%p",
1388 stream
, bt_stream_get_name(stream
), field
);
1393 struct bt_field
*bt_stream_get_packet_header(struct bt_stream
*stream
)
1395 struct bt_field
*packet_header
= NULL
;
1398 BT_LOGW_STR("Invalid parameter: stream is NULL.");
1402 if (stream
->pos
.fd
< 0) {
1403 BT_LOGW("Invalid parameter: stream is not a CTF writer stream: "
1404 "stream-addr=%p, stream-name=\"%s\"", stream
,
1405 bt_stream_get_name(stream
));
1409 packet_header
= stream
->packet_header
;
1410 if (packet_header
) {
1411 bt_get(packet_header
);
1414 return packet_header
;
1417 int bt_stream_set_packet_header(struct bt_stream
*stream
,
1418 struct bt_field
*field
)
1421 struct bt_trace
*trace
= NULL
;
1422 struct bt_field_type
*field_type
= NULL
;
1425 BT_LOGW_STR("Invalid parameter: stream is NULL.");
1430 if (stream
->pos
.fd
< 0) {
1431 BT_LOGW_STR("Invalid parameter: stream is not a CTF writer stream.");
1436 trace
= (struct bt_trace
*) bt_object_get_parent(stream
);
1439 if (trace
->packet_header_type
) {
1440 BT_LOGW("Invalid parameter: setting no packet header but packet header field type is not NULL: "
1441 "stream-addr=%p, stream-name=\"%s\", "
1442 "packet-header-field-addr=%p, "
1443 "expected-ft-addr=%p",
1444 stream
, bt_stream_get_name(stream
),
1445 field
, trace
->packet_header_type
);
1450 goto skip_validation
;
1453 field_type
= bt_field_get_type(field
);
1456 if (bt_field_type_compare(field_type
, trace
->packet_header_type
)) {
1457 BT_LOGW("Invalid parameter: packet header's field type is different from the stream's packet header field type: "
1458 "stream-addr=%p, stream-name=\"%s\", "
1459 "packet-header-field-addr=%p, "
1460 "packet-header-ft-addr=%p",
1461 stream
, bt_stream_get_name(stream
),
1468 bt_put(stream
->packet_header
);
1469 stream
->packet_header
= bt_get(field
);
1470 BT_LOGV("Set stream's packet header field: "
1471 "stream-addr=%p, stream-name=\"%s\", "
1472 "packet-header-field-addr=%p",
1473 stream
, bt_stream_get_name(stream
), field
);
1481 void reset_structure_field(struct bt_field
*structure
, const char *name
)
1483 struct bt_field
*member
;
1485 member
= bt_field_structure_get_field_by_name(structure
, name
);
1487 (void) bt_field_reset(member
);
1492 int bt_stream_flush(struct bt_stream
*stream
)
1496 struct bt_stream_pos packet_context_pos
;
1497 struct bt_trace
*trace
;
1498 enum bt_byte_order native_byte_order
;
1499 bool has_packet_size
= false;
1502 BT_LOGW_STR("Invalid parameter: stream is NULL.");
1507 if (stream
->pos
.fd
< 0) {
1508 BT_LOGW_STR("Invalid parameter: stream is not a CTF writer stream.");
1513 if (stream
->packet_context
) {
1514 struct bt_field
*packet_size_field
;
1516 packet_size_field
= bt_field_structure_get_field_by_name(
1517 stream
->packet_context
, "packet_size");
1518 has_packet_size
= (packet_size_field
!= NULL
);
1519 bt_put(packet_size_field
);
1522 if (stream
->flushed_packet_count
== 1) {
1523 if (!stream
->packet_context
) {
1524 BT_LOGW_STR("Cannot flush a stream which has no packet context field more than once.");
1529 if (!has_packet_size
) {
1530 BT_LOGW_STR("Cannot flush a stream which has no packet context's `packet_size` field more than once.");
1536 BT_LOGV("Flushing stream's current packet: stream-addr=%p, "
1537 "stream-name=\"%s\", packet-index=%u", stream
,
1538 bt_stream_get_name(stream
), stream
->flushed_packet_count
);
1539 trace
= bt_stream_class_borrow_trace(stream
->stream_class
);
1541 native_byte_order
= bt_trace_get_native_byte_order(trace
);
1543 ret
= auto_populate_packet_header(stream
);
1545 BT_LOGW_STR("Cannot automatically populate the stream's packet header field.");
1550 ret
= auto_populate_packet_context(stream
);
1552 BT_LOGW_STR("Cannot automatically populate the stream's packet context field.");
1557 /* mmap the next packet */
1558 BT_LOGV("Seeking to the next packet: pos-offset=%" PRId64
,
1559 stream
->pos
.offset
);
1560 bt_stream_pos_packet_seek(&stream
->pos
, 0, SEEK_CUR
);
1561 assert(stream
->pos
.packet_size
% 8 == 0);
1563 if (stream
->packet_header
) {
1564 BT_LOGV_STR("Serializing packet header field.");
1565 ret
= bt_field_serialize(stream
->packet_header
, &stream
->pos
,
1568 BT_LOGW("Cannot serialize stream's packet header field: "
1569 "field-addr=%p", stream
->packet_header
);
1574 if (stream
->packet_context
) {
1575 /* Write packet context */
1576 memcpy(&packet_context_pos
, &stream
->pos
,
1577 sizeof(packet_context_pos
));
1578 BT_LOGV_STR("Serializing packet context field.");
1579 ret
= bt_field_serialize(stream
->packet_context
,
1580 &stream
->pos
, native_byte_order
);
1582 BT_LOGW("Cannot serialize stream's packet context field: "
1583 "field-addr=%p", stream
->packet_context
);
1588 BT_LOGV("Serializing events: count=%u", stream
->events
->len
);
1590 for (i
= 0; i
< stream
->events
->len
; i
++) {
1591 struct bt_event
*event
= g_ptr_array_index(
1593 struct bt_event_class
*event_class
=
1594 bt_event_borrow_event_class(event
);
1596 BT_LOGV("Serializing event: index=%zu, event-addr=%p, "
1597 "event-class-name=\"%s\", event-class-id=%" PRId64
", "
1598 "pos-offset=%" PRId64
", packet-size=%" PRIu64
,
1599 i
, event
, bt_event_class_get_name(event_class
),
1600 bt_event_class_get_id(event_class
),
1601 stream
->pos
.offset
, stream
->pos
.packet_size
);
1603 /* Write event header */
1604 if (event
->event_header
) {
1605 BT_LOGV_STR("Serializing event's header field.");
1606 ret
= bt_field_serialize(event
->event_header
,
1607 &stream
->pos
, native_byte_order
);
1609 BT_LOGW("Cannot serialize event's header field: "
1610 "field-addr=%p", event
->event_header
);
1615 /* Write stream event context */
1616 if (event
->stream_event_context
) {
1617 BT_LOGV_STR("Serializing event's stream event context field.");
1618 ret
= bt_field_serialize(
1619 event
->stream_event_context
, &stream
->pos
,
1622 BT_LOGW("Cannot serialize event's stream event context field: "
1623 "field-addr=%p", event
->stream_event_context
);
1628 /* Write event content */
1629 ret
= bt_event_serialize(event
, &stream
->pos
,
1632 /* bt_event_serialize() logs errors */
1637 if (!has_packet_size
&& stream
->pos
.offset
% 8 != 0) {
1638 BT_LOGW("Stream's packet context field type has no `packet_size` field, "
1639 "but current content size is not a multiple of 8 bits: "
1640 "content-size=%" PRId64
", "
1641 "packet-size=%" PRIu64
,
1643 stream
->pos
.packet_size
);
1648 assert(stream
->pos
.packet_size
% 8 == 0);
1651 * Remove extra padding bytes.
1653 stream
->pos
.packet_size
= (stream
->pos
.offset
+ 7) & ~7;
1655 if (stream
->packet_context
) {
1657 * The whole packet is serialized at this point. Make sure that,
1658 * if `packet_size` is missing, the current content size is
1659 * equal to the current packet size.
1661 struct bt_field
*field
= bt_field_structure_get_field_by_name(
1662 stream
->packet_context
, "content_size");
1666 if (stream
->pos
.offset
!= stream
->pos
.packet_size
) {
1667 BT_LOGW("Stream's packet context's `content_size` field is missing, "
1668 "but current packet's content size is not equal to its packet size: "
1669 "content-size=%" PRId64
", "
1670 "packet-size=%" PRIu64
,
1672 stream
->pos
.packet_size
);
1679 * Overwrite the packet context now that the stream
1680 * position's packet and content sizes have the correct
1683 * Copy base_mma as the packet may have been remapped
1684 * (e.g. when a packet is resized).
1686 packet_context_pos
.base_mma
= stream
->pos
.base_mma
;
1687 ret
= auto_populate_packet_context(stream
);
1689 BT_LOGW_STR("Cannot automatically populate the stream's packet context field.");
1694 BT_LOGV("Rewriting (serializing) packet context field.");
1695 ret
= bt_field_serialize(stream
->packet_context
,
1696 &packet_context_pos
, native_byte_order
);
1698 BT_LOGW("Cannot serialize stream's packet context field: "
1699 "field-addr=%p", stream
->packet_context
);
1704 g_ptr_array_set_size(stream
->events
, 0);
1705 stream
->flushed_packet_count
++;
1706 stream
->size
+= stream
->pos
.packet_size
/ CHAR_BIT
;
1709 /* Reset automatically-set fields. */
1710 if (stream
->packet_context
) {
1711 reset_structure_field(stream
->packet_context
, "timestamp_begin");
1712 reset_structure_field(stream
->packet_context
, "timestamp_end");
1713 reset_structure_field(stream
->packet_context
, "packet_size");
1714 reset_structure_field(stream
->packet_context
, "content_size");
1715 reset_structure_field(stream
->packet_context
, "events_discarded");
1720 * We failed to write the packet. Its size is therefore set to 0
1721 * to ensure the next mapping is done in the same place rather
1722 * than advancing by "stream->pos.packet_size", which would
1723 * leave a corrupted packet in the trace.
1725 stream
->pos
.packet_size
= 0;
1727 BT_LOGV("Flushed stream's current packet: content-size=%" PRId64
", "
1728 "packet-size=%" PRIu64
,
1729 stream
->pos
.offset
, stream
->pos
.packet_size
);
1736 /* Pre-2.0 CTF writer backward compatibility */
1737 void bt_ctf_stream_get(struct bt_stream
*stream
)
1742 /* Pre-2.0 CTF writer backward compatibility */
1743 void bt_ctf_stream_put(struct bt_stream
*stream
)
1749 void bt_stream_destroy(struct bt_object
*obj
)
1751 struct bt_stream
*stream
;
1754 stream
= container_of(obj
, struct bt_stream
, base
);
1755 BT_LOGD("Destroying stream object: addr=%p, name=\"%s\"",
1756 stream
, bt_stream_get_name(stream
));
1758 /* Call destroy listeners in reverse registration order */
1759 for (i
= stream
->destroy_listeners
->len
- 1; i
>= 0; i
--) {
1760 struct bt_stream_destroy_listener
*listener
=
1761 &g_array_index(stream
->destroy_listeners
,
1762 struct bt_stream_destroy_listener
, i
);
1764 BT_LOGD("Calling destroy listener: func=%p, data=%p, index=%d",
1765 listener
->func
, listener
->data
, i
);
1766 listener
->func(stream
, listener
->data
);
1769 (void) bt_stream_pos_fini(&stream
->pos
);
1770 if (stream
->pos
.fd
>= 0) {
1774 * Truncate the file's size to the minimum required to fit the
1775 * last packet as we might have grown it too much on the last
1779 ret
= ftruncate(stream
->pos
.fd
, stream
->size
);
1780 } while (ret
== -1 && errno
== EINTR
);
1782 BT_LOGE_ERRNO("Failed to truncate stream file",
1783 ": ret=%d, size=%" PRIu64
,
1784 ret
, (uint64_t) stream
->size
);
1787 if (close(stream
->pos
.fd
)) {
1788 BT_LOGE_ERRNO("Failed to close stream file",
1793 if (stream
->events
) {
1794 BT_LOGD_STR("Putting events.");
1795 g_ptr_array_free(stream
->events
, TRUE
);
1799 g_string_free(stream
->name
, TRUE
);
1802 if (stream
->comp_cur_port
) {
1803 GHashTableIter ht_iter
;
1804 gpointer comp_gptr
, port_gptr
;
1807 * Since we're destroying the stream, remove the destroy
1808 * listeners that it registered for each component in
1809 * its component-port mapping hash table. Otherwise they
1810 * would be called and the stream would be accessed once
1811 * it's freed or another stream would be accessed.
1813 g_hash_table_iter_init(&ht_iter
, stream
->comp_cur_port
);
1815 while (g_hash_table_iter_next(&ht_iter
, &comp_gptr
, &port_gptr
)) {
1817 bt_component_remove_destroy_listener((void *) comp_gptr
,
1818 component_destroy_listener
, stream
);
1821 g_hash_table_destroy(stream
->comp_cur_port
);
1824 if (stream
->destroy_listeners
) {
1825 g_array_free(stream
->destroy_listeners
, TRUE
);
1828 BT_LOGD_STR("Putting packet header field.");
1829 bt_put(stream
->packet_header
);
1830 BT_LOGD_STR("Putting packet context field.");
1831 bt_put(stream
->packet_context
);
1836 int _set_structure_field_integer(struct bt_field
*structure
, char *name
,
1837 uint64_t value
, bt_bool force
)
1840 struct bt_field_type
*field_type
= NULL
;
1841 struct bt_field
*integer
;
1846 integer
= bt_field_structure_get_field_by_name(structure
, name
);
1848 /* Field not found, not an error. */
1849 BT_LOGV("Field not found: struct-field-addr=%p, "
1850 "name=\"%s\", force=%d", structure
, name
, force
);
1854 /* Make sure the payload has not already been set. */
1855 if (!force
&& bt_field_is_set(integer
)) {
1856 /* Payload already set, not an error */
1857 BT_LOGV("Field's payload is already set: struct-field-addr=%p, "
1858 "name=\"%s\", force=%d", structure
, name
, force
);
1862 field_type
= bt_field_get_type(integer
);
1864 if (bt_field_type_get_type_id(field_type
) != BT_FIELD_TYPE_ID_INTEGER
) {
1866 * The user most likely meant for us to populate this field
1867 * automatically. However, we can only do this if the field
1868 * is an integer. Return an error.
1870 BT_LOGW("Invalid parameter: field's type is not an integer field type: "
1871 "field-addr=%p, ft-addr=%p, ft-id=%s",
1872 integer
, field_type
,
1873 bt_field_type_id_string(field_type
->id
));
1878 if (bt_field_type_integer_is_signed(field_type
)) {
1879 ret
= bt_field_signed_integer_set_value(integer
,
1882 ret
= bt_field_unsigned_integer_set_value(integer
, value
);
1884 ret
= !ret
? 1 : ret
;
1892 * Returns the following codes:
1893 * 1 if the field was found and set,
1894 * 0 if nothing was done (field not found, or was already set),
1895 * <0 if an error was encoutered
1898 int try_set_structure_field_integer(struct bt_field
*structure
, char *name
,
1901 return _set_structure_field_integer(structure
, name
, value
, BT_FALSE
);
1904 const char *bt_stream_get_name(struct bt_stream
*stream
)
1906 const char *name
= NULL
;
1909 BT_LOGW_STR("Invalid parameter: stream is NULL.");
1913 name
= stream
->name
? stream
->name
->str
: NULL
;
1919 int bt_stream_is_writer(struct bt_stream
*stream
)
1924 BT_LOGW_STR("Invalid parameter: stream is NULL.");
1928 ret
= (stream
->pos
.fd
>= 0);
1935 void bt_stream_map_component_to_port(struct bt_stream
*stream
,
1936 struct bt_component
*comp
,
1937 struct bt_port
*port
)
1942 assert(stream
->comp_cur_port
);
1945 * Do not take a reference to the component here because we
1946 * don't want the component to exist as long as this stream
1947 * exists. Instead, keep a weak reference, but add a destroy
1948 * listener so that we remove this hash table entry when we know
1949 * the component is destroyed.
1951 BT_LOGV("Adding component's destroy listener for stream: "
1952 "stream-addr=%p, stream-name=\"%s\", comp-addr=%p, "
1953 "comp-name=\"%s\", port-addr=%p, port-name=\"%s\"",
1954 stream
, bt_stream_get_name(stream
),
1955 comp
, bt_component_get_name(comp
), port
,
1956 bt_port_get_name(port
));
1957 bt_component_add_destroy_listener(comp
, component_destroy_listener
,
1959 g_hash_table_insert(stream
->comp_cur_port
, comp
, port
);
1960 BT_LOGV_STR("Mapped component to port for stream.");
1964 struct bt_port
*bt_stream_port_for_component(struct bt_stream
*stream
,
1965 struct bt_component
*comp
)
1969 assert(stream
->comp_cur_port
);
1970 return g_hash_table_lookup(stream
->comp_cur_port
, comp
);
1974 void bt_stream_add_destroy_listener(struct bt_stream
*stream
,
1975 bt_stream_destroy_listener_func func
, void *data
)
1977 struct bt_stream_destroy_listener listener
;
1981 listener
.func
= func
;
1982 listener
.data
= data
;
1983 g_array_append_val(stream
->destroy_listeners
, listener
);
1984 BT_LOGV("Added stream destroy listener: stream-addr=%p, "
1985 "stream-name=\"%s\", func=%p, data=%p",
1986 stream
, bt_stream_get_name(stream
), func
, data
);
1990 void bt_stream_remove_destroy_listener(struct bt_stream
*stream
,
1991 bt_stream_destroy_listener_func func
, void *data
)
1998 for (i
= 0; i
< stream
->destroy_listeners
->len
; i
++) {
1999 struct bt_stream_destroy_listener
*listener
=
2000 &g_array_index(stream
->destroy_listeners
,
2001 struct bt_stream_destroy_listener
, i
);
2003 if (listener
->func
== func
&& listener
->data
== data
) {
2004 g_array_remove_index(stream
->destroy_listeners
, i
);
2006 BT_LOGV("Removed stream destroy listener: stream-addr=%p, "
2007 "stream-name=\"%s\", func=%p, data=%p",
2008 stream
, bt_stream_get_name(stream
),
2014 int64_t bt_stream_get_id(struct bt_stream
*stream
)
2019 BT_LOGW_STR("Invalid parameter: stream is NULL.");
2026 BT_LOGV("Stream's ID is not set: addr=%p, name=\"%s\"",
2027 stream
, bt_stream_get_name(stream
));