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_ctf_stream_destroy(struct bt_object
*obj
);
56 int try_set_structure_field_integer(struct bt_ctf_field
*, char *, uint64_t);
59 int set_integer_field_value(struct bt_ctf_field
* field
, uint64_t value
)
62 struct bt_ctf_field_type
*field_type
= NULL
;
65 BT_LOGW_STR("Invalid parameter: field is NULL.");
70 field_type
= bt_ctf_field_get_type(field
);
73 if (bt_ctf_field_type_get_type_id(field_type
) !=
74 BT_CTF_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_ctf_field_type_id_string(field_type
->id
));
84 if (bt_ctf_field_type_integer_get_signed(field_type
)) {
85 ret
= bt_ctf_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_ctf_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_ctf_stream
*stream
)
112 struct bt_ctf_field
*magic_field
= bt_ctf_field_structure_get_field(
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_ctf_stream_get_name(stream
));
126 ret
= bt_ctf_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_ctf_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_ctf_stream_get_name(stream
),
138 magic_field
, (uint64_t) magic_value
);
146 int set_packet_header_uuid(struct bt_ctf_stream
*stream
)
150 struct bt_ctf_trace
*trace
= NULL
;
151 struct bt_ctf_field
*uuid_field
= bt_ctf_field_structure_get_field(
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_ctf_stream_get_name(stream
));
164 trace
= (struct bt_ctf_trace
*) bt_object_get_parent(stream
);
165 for (i
= 0; i
< 16; i
++) {
166 struct bt_ctf_field
*uuid_element
=
167 bt_ctf_field_array_get_field(uuid_field
, i
);
169 ret
= bt_ctf_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_ctf_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_ctf_stream_get_name(stream
), uuid_field
);
192 int set_packet_header_stream_id(struct bt_ctf_stream
*stream
)
196 struct bt_ctf_field
*stream_id_field
= bt_ctf_field_structure_get_field(
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_ctf_stream_get_name(stream
));
207 stream_id
= stream
->stream_class
->id
;
208 ret
= bt_ctf_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_ctf_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_ctf_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_ctf_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_ctf_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_ctf_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_ctf_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_ctf_stream_get_name(stream
));
269 int set_packet_context_packet_size(struct bt_ctf_stream
*stream
)
272 struct bt_ctf_field
*field
= bt_ctf_field_structure_get_field(
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_ctf_stream_get_name(stream
));
285 ret
= bt_ctf_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_ctf_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_ctf_stream_get_name(stream
),
296 field
, stream
->pos
.packet_size
);
305 int set_packet_context_content_size(struct bt_ctf_stream
*stream
)
308 struct bt_ctf_field
*field
= bt_ctf_field_structure_get_field(
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_ctf_stream_get_name(stream
));
321 ret
= bt_ctf_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_ctf_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_ctf_stream_get_name(stream
),
332 field
, stream
->pos
.offset
);
341 int set_packet_context_events_discarded(struct bt_ctf_stream
*stream
)
344 struct bt_ctf_field
*field
= bt_ctf_field_structure_get_field(
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_ctf_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_ctf_field_is_set(field
)) {
366 ret
= bt_ctf_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_ctf_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_ctf_stream_get_name(stream
), field
,
382 user_val
, stream
->discarded_events
);
386 stream
->discarded_events
= user_val
;
388 ret
= bt_ctf_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_ctf_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_ctf_stream_get_name(stream
),
399 field
, stream
->discarded_events
);
409 int get_event_header_timestamp(struct bt_ctf_stream
*stream
,
410 struct bt_ctf_field
*event_header
, uint64_t *timestamp
)
413 struct bt_ctf_field
*timestamp_field
= NULL
;
414 struct bt_ctf_clock_class
*ts_field_mapped_clock_class
= NULL
;
419 BT_LOGV_STR("Event header does not exist.");
423 timestamp_field
= bt_ctf_field_structure_get_field(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_ctf_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_ctf_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_ctf_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_ctf_stream
*stream
,
471 const char *field_name
, struct bt_ctf_event
*event
)
474 struct bt_ctf_field
*field
= bt_ctf_field_structure_get_field(
475 stream
->packet_context
, field_name
);
476 struct bt_ctf_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_ctf_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_ctf_stream_get_name(stream
));
496 field_mapped_clock_class
=
497 bt_ctf_field_type_integer_get_mapped_clock_class(field
->type
);
498 if (!field_mapped_clock_class
) {
499 BT_LOGV("Packet context's `%s` field's type is not mapped to a clock class: skipping: "
500 "stream-addr=%p, stream-name=\"%s\", "
501 "field-addr=%p, ft-addr=%p", field_name
,
502 stream
, bt_ctf_stream_get_name(stream
),
507 if (field_mapped_clock_class
!=
508 stream
->stream_class
->clock
->clock_class
) {
509 BT_LOGV("Packet context's `%s` field's type is not mapped to the stream's clock's class: skipping: "
510 "stream-addr=%p, stream-name=\"%s\", "
511 "field-addr=%p, ft-addr=%p, "
512 "ft-mapped-clock-class-addr=%p, "
513 "ft-mapped-clock-class-name=\"%s\", "
514 "stream-clock-class-addr=%p, "
515 "stream-clock-class-name=\"%s\"",
517 stream
, bt_ctf_stream_get_name(stream
),
519 field_mapped_clock_class
,
520 bt_ctf_clock_class_get_name(field_mapped_clock_class
),
521 stream
->stream_class
->clock
->clock_class
,
522 bt_ctf_clock_class_get_name(
523 stream
->stream_class
->clock
->clock_class
));
527 if (get_event_header_timestamp(stream
, event
->event_header
, &ts
)) {
528 BT_LOGW("Cannot get event's timestamp: "
529 "event-header-field-addr=%p",
530 event
->event_header
);
535 ret
= bt_ctf_field_unsigned_integer_set_value(field
, ts
);
537 BT_LOGW("Cannot set packet context field's `%s` integer field's value: "
538 "stream-addr=%p, stream-name=\"%s\", field-addr=%p, value=%" PRIu64
,
539 field_name
, stream
, bt_ctf_stream_get_name(stream
),
540 field
, stream
->discarded_events
);
542 BT_LOGV("Set packet context field's `%s` field's value: "
543 "stream-addr=%p, stream-name=\"%s\", field-addr=%p, value=%" PRIu64
,
544 field_name
, stream
, bt_ctf_stream_get_name(stream
),
545 field
, stream
->discarded_events
);
550 bt_put(field_mapped_clock_class
);
555 int set_packet_context_timestamp_begin(struct bt_ctf_stream
*stream
)
559 if (stream
->events
->len
== 0) {
560 BT_LOGV("Current packet contains no events: skipping: "
561 "stream-addr=%p, stream-name=\"%s\"",
562 stream
, bt_ctf_stream_get_name(stream
));
566 ret
= set_packet_context_timestamp_field(stream
, "timestamp_begin",
567 g_ptr_array_index(stream
->events
, 0));
574 int set_packet_context_timestamp_end(struct bt_ctf_stream
*stream
)
578 if (stream
->events
->len
== 0) {
579 BT_LOGV("Current packet contains no events: skipping: "
580 "stream-addr=%p, stream-name=\"%s\"",
581 stream
, bt_ctf_stream_get_name(stream
));
585 ret
= set_packet_context_timestamp_field(stream
, "timestamp_end",
586 g_ptr_array_index(stream
->events
, stream
->events
->len
- 1));
593 int auto_populate_packet_context(struct bt_ctf_stream
*stream
)
597 if (!stream
->packet_context
) {
601 ret
= set_packet_context_packet_size(stream
);
603 BT_LOGW("Cannot set packet context's packet size field: "
604 "stream-addr=%p, stream-name=\"%s\"",
605 stream
, bt_ctf_stream_get_name(stream
));
609 ret
= set_packet_context_content_size(stream
);
611 BT_LOGW("Cannot set packet context's content size field: "
612 "stream-addr=%p, stream-name=\"%s\"",
613 stream
, bt_ctf_stream_get_name(stream
));
617 ret
= set_packet_context_timestamp_begin(stream
);
619 BT_LOGW("Cannot set packet context's beginning timestamp field: "
620 "stream-addr=%p, stream-name=\"%s\"",
621 stream
, bt_ctf_stream_get_name(stream
));
625 ret
= set_packet_context_timestamp_end(stream
);
627 BT_LOGW("Cannot set packet context's end timestamp field: "
628 "stream-addr=%p, stream-name=\"%s\"",
629 stream
, bt_ctf_stream_get_name(stream
));
633 ret
= set_packet_context_events_discarded(stream
);
635 BT_LOGW("Cannot set packet context's discarded events count field: "
636 "stream-addr=%p, stream-name=\"%s\"",
637 stream
, bt_ctf_stream_get_name(stream
));
641 BT_LOGV("Automatically populated stream's packet context's known fields: "
642 "stream-addr=%p, stream-name=\"%s\"",
643 stream
, bt_ctf_stream_get_name(stream
));
650 void release_event(struct bt_ctf_event
*event
)
652 if (bt_object_get_ref_count(event
)) {
654 * The event is being orphaned, but it must guarantee the
655 * existence of its event class for the duration of its
658 bt_get(event
->event_class
);
659 BT_PUT(event
->base
.parent
);
661 bt_object_release(event
);
666 int create_stream_file(struct bt_ctf_writer
*writer
,
667 struct bt_ctf_stream
*stream
)
670 GString
*filename
= g_string_new(stream
->stream_class
->name
->str
);
672 BT_LOGD("Creating stream file: writer-addr=%p, stream-addr=%p, "
673 "stream-name=\"%s\", stream-class-addr=%p, stream-class-name=\"%s\"",
674 writer
, stream
, bt_ctf_stream_get_name(stream
),
675 stream
->stream_class
, stream
->stream_class
->name
->str
);
677 if (stream
->stream_class
->name
->len
== 0) {
680 ret
= bt_ctf_stream_class_get_id(stream
->stream_class
);
682 BT_LOGW("Cannot get stream class's ID: "
683 "stream-class-addr=%p, "
684 "stream-class-name=\"%s\"",
685 stream
->stream_class
,
686 stream
->stream_class
->name
->str
);
691 g_string_printf(filename
, "stream_%" PRId64
, ret
);
694 g_string_append_printf(filename
, "_%" PRId64
, stream
->id
);
695 fd
= openat(writer
->trace_dir_fd
, filename
->str
,
696 O_RDWR
| O_CREAT
| O_TRUNC
,
697 S_IRUSR
| S_IWUSR
| S_IRGRP
| S_IWGRP
);
699 BT_LOGW("Failed to open stream file for writing: %s: "
700 "writer-trace-dir-fd=%d, filename=\"%s\", "
701 "ret=%d, errno=%d", strerror(errno
),
702 writer
->trace_dir_fd
, filename
->str
, fd
, errno
);
706 BT_LOGD("Created stream file for writing: "
707 "stream-addr=%p, stream-name=\"%s\", writer-trace-dir-fd=%d, "
708 "filename=\"%s\", fd=%d", stream
, bt_ctf_stream_get_name(stream
),
709 writer
->trace_dir_fd
, filename
->str
, fd
);
712 g_string_free(filename
, TRUE
);
717 void set_stream_fd(struct bt_ctf_stream
*stream
, int fd
)
719 (void) bt_ctf_stream_pos_init(&stream
->pos
, fd
, O_RDWR
);
724 void component_destroy_listener(struct bt_component
*component
, void *data
)
726 struct bt_ctf_stream
*stream
= data
;
728 BT_LOGD("Component is being destroyed, stream is notified: "
729 "comp-addr=%p, stream-addr=%p", component
, stream
);
730 g_hash_table_remove(stream
->comp_cur_port
, component
);
734 struct bt_ctf_stream
*bt_ctf_stream_create_with_id_no_check(
735 struct bt_ctf_stream_class
*stream_class
,
736 const char *name
, uint64_t id
)
739 struct bt_ctf_stream
*stream
= NULL
;
740 struct bt_ctf_trace
*trace
= NULL
;
741 struct bt_ctf_writer
*writer
= NULL
;
744 BT_LOGW_STR("Invalid parameter: stream class is NULL.");
748 BT_LOGD("Creating stream object: stream-class-addr=%p, "
749 "stream-class-name=\"%s\", stream-name=\"%s\", "
750 "stream-id=%" PRIu64
,
751 stream_class
, bt_ctf_stream_class_get_name(stream_class
),
753 trace
= bt_ctf_stream_class_borrow_trace(stream_class
);
755 BT_LOGW("Invalid parameter: cannot create stream from a stream class which is not part of trace: "
756 "stream-class-addr=%p, stream-class-name=\"%s\", "
757 "stream-name=\"%s\"",
758 stream_class
, bt_ctf_stream_class_get_name(stream_class
),
763 if (bt_ctf_trace_is_static(trace
)) {
765 * A static trace has the property that all its stream
766 * classes, clock classes, and streams are definitive:
767 * no more can be added, and each object is also frozen.
769 BT_LOGW("Invalid parameter: cannot create stream from a stream class which is part of a static trace: "
770 "stream-class-addr=%p, stream-class-name=\"%s\", "
771 "stream-name=\"%s\", trace-addr=%p",
772 stream_class
, bt_ctf_stream_class_get_name(stream_class
),
779 * Validate that the given ID is unique amongst all the
780 * existing trace's streams created from the same stream
785 for (i
= 0; i
< trace
->streams
->len
; i
++) {
786 struct bt_ctf_stream
*trace_stream
=
787 g_ptr_array_index(trace
->streams
, i
);
789 if (trace_stream
->stream_class
!= stream_class
) {
793 if (trace_stream
->id
== id
) {
794 BT_LOGW_STR("Invalid parameter: another stream in the same trace already has this ID.");
800 stream
= g_new0(struct bt_ctf_stream
, 1);
802 BT_LOGE_STR("Failed to allocate one stream.");
806 bt_object_init(stream
, bt_ctf_stream_destroy
);
808 * Acquire reference to parent since stream will become publicly
809 * reachable; it needs its parent to remain valid.
811 bt_object_set_parent(stream
, trace
);
812 stream
->stream_class
= stream_class
;
814 stream
->id
= (int64_t) id
;
816 stream
->destroy_listeners
= g_array_new(FALSE
, TRUE
,
817 sizeof(struct bt_ctf_stream_destroy_listener
));
818 if (!stream
->destroy_listeners
) {
819 BT_LOGE_STR("Failed to allocate a GArray.");
824 stream
->name
= g_string_new(name
);
826 BT_LOGE_STR("Failed to allocate a GString.");
831 BT_LOGD("Set stream's trace parent: trace-addr=%p", trace
);
833 if (trace
->is_created_by_writer
) {
835 writer
= (struct bt_ctf_writer
*) bt_object_get_parent(trace
);
836 stream
->id
= (int64_t) stream_class
->next_stream_id
++;
838 BT_LOGD("Stream object belongs to a writer's trace: "
839 "writer-addr=%p", writer
);
842 if (stream_class
->packet_context_type
) {
843 BT_LOGD("Creating stream's packet context field: "
844 "ft-addr=%p", stream_class
->packet_context_type
);
845 stream
->packet_context
= bt_ctf_field_create(
846 stream_class
->packet_context_type
);
847 if (!stream
->packet_context
) {
848 BT_LOGW_STR("Cannot create stream's packet context field.");
852 /* Initialize events_discarded */
853 ret
= try_set_structure_field_integer(
854 stream
->packet_context
, "events_discarded", 0);
856 BT_LOGW("Cannot set `events_discarded` field in packet context: "
857 "ret=%d, packet-context-field-addr=%p",
858 ret
, stream
->packet_context
);
863 stream
->events
= g_ptr_array_new_with_free_func(
864 (GDestroyNotify
) release_event
);
865 if (!stream
->events
) {
866 BT_LOGE_STR("Failed to allocate a GPtrArray.");
870 if (trace
->packet_header_type
) {
871 BT_LOGD("Creating stream's packet header field: "
872 "ft-addr=%p", trace
->packet_header_type
);
873 stream
->packet_header
=
874 bt_ctf_field_create(trace
->packet_header_type
);
875 if (!stream
->packet_header
) {
876 BT_LOGW_STR("Cannot create stream's packet header field.");
882 * Attempt to populate the default trace packet header fields
883 * (magic, uuid and stream_id). This will _not_ fail shall the
884 * fields not be found or be of an incompatible type; they will
885 * simply not be populated automatically. The user will have to
886 * make sure to set the trace packet header fields himself
889 ret
= auto_populate_packet_header(stream
);
891 BT_LOGW_STR("Cannot automatically populate the stream's packet header.");
895 /* Create file associated with this stream */
896 fd
= create_stream_file(writer
, stream
);
898 BT_LOGW_STR("Cannot create stream file.");
902 set_stream_fd(stream
, fd
);
904 /* Freeze the writer */
905 BT_LOGD_STR("Freezing stream's CTF writer.");
906 bt_ctf_writer_freeze(writer
);
908 /* Non-writer stream indicated by a negative FD */
909 set_stream_fd(stream
, -1);
910 stream
->comp_cur_port
= g_hash_table_new(g_direct_hash
,
912 if (!stream
->comp_cur_port
) {
913 BT_LOGE_STR("Failed to allocate a GHashTable.");
918 /* Add this stream to the trace's streams */
919 g_ptr_array_add(trace
->streams
, stream
);
920 BT_LOGD("Created stream object: addr=%p", stream
);
931 struct bt_ctf_stream
*bt_ctf_stream_create_with_id(
932 struct bt_ctf_stream_class
*stream_class
,
933 const char *name
, uint64_t id_param
)
935 struct bt_ctf_trace
*trace
;
936 struct bt_ctf_stream
*stream
= NULL
;
937 int64_t id
= (int64_t) id_param
;
940 BT_LOGW_STR("Invalid parameter: stream class is NULL.");
945 BT_LOGW("Invalid parameter: invalid stream's ID: "
946 "name=\"%s\", id=%" PRIu64
,
951 trace
= bt_ctf_stream_class_borrow_trace(stream_class
);
953 BT_LOGW("Invalid parameter: cannot create stream from a stream class which is not part of trace: "
954 "stream-class-addr=%p, stream-class-name=\"%s\", "
955 "stream-name=\"%s\", stream-id=%" PRIu64
,
956 stream_class
, bt_ctf_stream_class_get_name(stream_class
),
961 if (trace
->is_created_by_writer
) {
962 BT_LOGW("Invalid parameter: cannot create a CTF writer stream with this function; use bt_ctf_stream_create(): "
963 "stream-class-addr=%p, stream-class-name=\"%s\", "
964 "stream-name=\"%s\", stream-id=%" PRIu64
,
965 stream_class
, bt_ctf_stream_class_get_name(stream_class
),
970 stream
= bt_ctf_stream_create_with_id_no_check(stream_class
,
977 struct bt_ctf_stream
*bt_ctf_stream_create(
978 struct bt_ctf_stream_class
*stream_class
,
981 return bt_ctf_stream_create_with_id_no_check(stream_class
,
985 struct bt_ctf_stream_class
*bt_ctf_stream_get_class(
986 struct bt_ctf_stream
*stream
)
988 struct bt_ctf_stream_class
*stream_class
= NULL
;
991 BT_LOGW_STR("Invalid parameter: stream is NULL.");
995 stream_class
= stream
->stream_class
;
996 bt_get(stream_class
);
1001 int bt_ctf_stream_get_discarded_events_count(
1002 struct bt_ctf_stream
*stream
, uint64_t *count
)
1007 BT_LOGW_STR("Invalid parameter: stream is NULL.");
1013 BT_LOGW_STR("Invalid parameter: count is NULL.");
1018 if (stream
->pos
.fd
< 0) {
1019 BT_LOGW("Invalid parameter: stream is not a CTF writer stream: "
1020 "stream-addr=%p, stream-name=\"%s\"",
1021 stream
, bt_ctf_stream_get_name(stream
));
1026 *count
= (uint64_t) stream
->discarded_events
;
1033 int set_packet_context_events_discarded_field(struct bt_ctf_stream
*stream
,
1037 struct bt_ctf_field
*events_discarded_field
= NULL
;
1039 if (!stream
->packet_context
) {
1043 events_discarded_field
= bt_ctf_field_structure_get_field(
1044 stream
->packet_context
, "events_discarded");
1045 if (!events_discarded_field
) {
1049 ret
= bt_ctf_field_unsigned_integer_set_value(
1050 events_discarded_field
, count
);
1052 BT_LOGW("Cannot set packet context's `events_discarded` field: "
1053 "field-addr=%p, value=%" PRIu64
,
1054 events_discarded_field
, count
);
1059 bt_put(events_discarded_field
);
1063 void bt_ctf_stream_append_discarded_events(struct bt_ctf_stream
*stream
,
1064 uint64_t event_count
)
1068 struct bt_ctf_field
*events_discarded_field
= NULL
;
1071 BT_LOGW_STR("Invalid parameter: stream is NULL.");
1075 BT_LOGV("Appending discarded events to stream: "
1076 "stream-addr=%p, stream-name=\"%s\", append-count=%" PRIu64
,
1077 stream
, bt_ctf_stream_get_name(stream
), event_count
);
1079 if (!stream
->packet_context
) {
1080 BT_LOGW_STR("Invalid parameter: stream has no packet context field.");
1084 if (stream
->pos
.fd
< 0) {
1085 BT_LOGW_STR("Invalid parameter: stream is not a CTF writer stream.");
1089 events_discarded_field
= bt_ctf_field_structure_get_field(
1090 stream
->packet_context
, "events_discarded");
1091 if (!events_discarded_field
) {
1092 BT_LOGW_STR("No field named `events_discarded` in stream's packet context.");
1096 new_count
= stream
->discarded_events
+ event_count
;
1097 if (new_count
< stream
->discarded_events
) {
1098 BT_LOGW("New discarded events count is less than the stream's current discarded events count: "
1099 "cur-count=%" PRIu64
", new-count=%" PRIu64
,
1100 stream
->discarded_events
, new_count
);
1104 ret
= set_packet_context_events_discarded_field(stream
, new_count
);
1106 /* set_packet_context_events_discarded_field() logs errors */
1110 stream
->discarded_events
= new_count
;
1111 BT_LOGV("Appended discarded events to stream: "
1112 "stream-addr=%p, stream-name=\"%s\", append-count=%" PRIu64
,
1113 stream
, bt_ctf_stream_get_name(stream
), event_count
);
1116 bt_put(events_discarded_field
);
1119 static int auto_populate_event_header(struct bt_ctf_stream
*stream
,
1120 struct bt_ctf_event
*event
)
1123 struct bt_ctf_field
*id_field
= NULL
, *timestamp_field
= NULL
;
1124 struct bt_ctf_clock_class
*mapped_clock_class
= NULL
;
1125 uint64_t event_class_id
;
1129 if (event
->frozen
) {
1130 BT_LOGW_STR("Cannot populate event header field: event is frozen.");
1135 BT_LOGV("Automatically populating event's header field: "
1136 "stream-addr=%p, stream-name=\"%s\", event-addr=%p",
1137 stream
, bt_ctf_stream_get_name(stream
), event
);
1139 id_field
= bt_ctf_field_structure_get_field(event
->event_header
, "id");
1140 event_class_id
= (uint64_t) bt_ctf_event_class_get_id(event
->event_class
);
1141 assert(event_class_id
>= 0);
1142 if (id_field
&& bt_ctf_field_type_is_integer(id_field
->type
)) {
1143 ret
= set_integer_field_value(id_field
, event_class_id
);
1145 BT_LOGW("Cannot set event header's `id` field's value: "
1146 "addr=%p, value=%" PRIu64
, id_field
,
1153 * The conditions to automatically set the timestamp are:
1155 * 1. The event header field "timestamp" exists and is an
1157 * 2. This stream's class has a registered clock (set with
1158 * bt_ctf_stream_class_set_clock()).
1159 * 3. The event header field "timestamp" has its type mapped to
1160 * a clock class which is also the clock class of this
1161 * stream's class's registered clock.
1163 timestamp_field
= bt_ctf_field_structure_get_field(event
->event_header
,
1165 if (timestamp_field
&& stream
->stream_class
->clock
&&
1166 bt_ctf_field_type_is_integer(timestamp_field
->type
)) {
1167 struct bt_ctf_clock_class
*stream_class_clock_class
=
1168 stream
->stream_class
->clock
->clock_class
;
1170 mapped_clock_class
=
1171 bt_ctf_field_type_integer_get_mapped_clock_class(
1172 timestamp_field
->type
);
1173 if (mapped_clock_class
== stream_class_clock_class
) {
1176 ret
= bt_ctf_clock_get_value(
1177 stream
->stream_class
->clock
,
1180 ret
= set_integer_field_value(timestamp_field
,
1183 BT_LOGW("Cannot set event header's `timestamp` field's value: "
1184 "addr=%p, value=%" PRIu64
,
1185 timestamp_field
, timestamp
);
1191 BT_LOGV("Automatically populated event's header field: "
1192 "stream-addr=%p, stream-name=\"%s\", event-addr=%p",
1193 stream
, bt_ctf_stream_get_name(stream
), event
);
1197 bt_put(timestamp_field
);
1198 bt_put(mapped_clock_class
);
1202 int bt_ctf_stream_append_event(struct bt_ctf_stream
*stream
,
1203 struct bt_ctf_event
*event
)
1208 BT_LOGW_STR("Invalid parameter: stream is NULL.");
1214 BT_LOGW_STR("Invalid parameter: event is NULL.");
1219 if (stream
->pos
.fd
< 0) {
1220 BT_LOGW_STR("Invalid parameter: stream is not a CTF writer stream.");
1225 BT_LOGV("Appending event to stream: "
1226 "stream-addr=%p, stream-name=\"%s\", event-addr=%p, "
1227 "event-class-name=\"%s\", event-class-id=%" PRId64
,
1228 stream
, bt_ctf_stream_get_name(stream
), event
,
1229 bt_ctf_event_class_get_name(bt_ctf_event_borrow_event_class(event
)),
1230 bt_ctf_event_class_get_id(bt_ctf_event_borrow_event_class(event
)));
1233 * The event is not supposed to have a parent stream at this
1234 * point. The only other way an event can have a parent stream
1235 * is if it was assigned when setting a packet to the event,
1236 * in which case the packet's stream is not a writer stream,
1237 * and thus the user is trying to append an event which belongs
1238 * to another stream.
1240 if (event
->base
.parent
) {
1245 bt_object_set_parent(event
, stream
);
1246 BT_LOGV_STR("Automatically populating the header of the event to append.");
1247 ret
= auto_populate_event_header(stream
, event
);
1249 /* auto_populate_event_header() reports errors */
1253 /* Make sure the various scopes of the event are set */
1254 BT_LOGV_STR("Validating event to append.");
1255 ret
= bt_ctf_event_validate(event
);
1260 /* Save the new event and freeze it */
1261 BT_LOGV_STR("Freezing the event to append.");
1262 bt_ctf_event_freeze(event
);
1263 g_ptr_array_add(stream
->events
, event
);
1266 * Event had to hold a reference to its event class as long as it wasn't
1267 * part of the same trace hierarchy. From now on, the event and its
1268 * class share the same lifetime guarantees and the reference is no
1271 BT_LOGV_STR("Putting the event's class.");
1272 bt_put(event
->event_class
);
1273 BT_LOGV("Appended event to stream: "
1274 "stream-addr=%p, stream-name=\"%s\", event-addr=%p, "
1275 "event-class-name=\"%s\", event-class-id=%" PRId64
,
1276 stream
, bt_ctf_stream_get_name(stream
), event
,
1277 bt_ctf_event_class_get_name(bt_ctf_event_borrow_event_class(event
)),
1278 bt_ctf_event_class_get_id(bt_ctf_event_borrow_event_class(event
)));
1285 * Orphan the event; we were not successful in associating it to
1288 bt_object_set_parent(event
, NULL
);
1293 struct bt_ctf_field
*bt_ctf_stream_get_packet_context(
1294 struct bt_ctf_stream
*stream
)
1296 struct bt_ctf_field
*packet_context
= NULL
;
1299 BT_LOGW_STR("Invalid parameter: stream is NULL.");
1303 if (stream
->pos
.fd
< 0) {
1304 BT_LOGW("Invalid parameter: stream is not a CTF writer stream: "
1305 "stream-addr=%p, stream-name=\"%s\"", stream
,
1306 bt_ctf_stream_get_name(stream
));
1310 packet_context
= stream
->packet_context
;
1311 if (packet_context
) {
1312 bt_get(packet_context
);
1315 return packet_context
;
1318 int bt_ctf_stream_set_packet_context(struct bt_ctf_stream
*stream
,
1319 struct bt_ctf_field
*field
)
1322 struct bt_ctf_field_type
*field_type
;
1325 BT_LOGW_STR("Invalid parameter: stream is NULL.");
1330 if (stream
->pos
.fd
< 0) {
1331 BT_LOGW_STR("Invalid parameter: stream is not a CTF writer stream.");
1336 field_type
= bt_ctf_field_get_type(field
);
1337 if (bt_ctf_field_type_compare(field_type
,
1338 stream
->stream_class
->packet_context_type
)) {
1339 BT_LOGW("Invalid parameter: packet context's field type is different from the stream's packet context field type: "
1340 "stream-addr=%p, stream-name=\"%s\", "
1341 "packet-context-field-addr=%p, "
1342 "packet-context-ft-addr=%p",
1343 stream
, bt_ctf_stream_get_name(stream
),
1350 bt_put(stream
->packet_context
);
1351 stream
->packet_context
= bt_get(field
);
1352 BT_LOGV("Set stream's packet context field: "
1353 "stream-addr=%p, stream-name=\"%s\", "
1354 "packet-context-field-addr=%p",
1355 stream
, bt_ctf_stream_get_name(stream
), field
);
1360 struct bt_ctf_field
*bt_ctf_stream_get_packet_header(
1361 struct bt_ctf_stream
*stream
)
1363 struct bt_ctf_field
*packet_header
= NULL
;
1366 BT_LOGW_STR("Invalid parameter: stream is NULL.");
1370 if (stream
->pos
.fd
< 0) {
1371 BT_LOGW("Invalid parameter: stream is not a CTF writer stream: "
1372 "stream-addr=%p, stream-name=\"%s\"", stream
,
1373 bt_ctf_stream_get_name(stream
));
1377 packet_header
= stream
->packet_header
;
1378 if (packet_header
) {
1379 bt_get(packet_header
);
1382 return packet_header
;
1385 int bt_ctf_stream_set_packet_header(struct bt_ctf_stream
*stream
,
1386 struct bt_ctf_field
*field
)
1389 struct bt_ctf_trace
*trace
= NULL
;
1390 struct bt_ctf_field_type
*field_type
= NULL
;
1393 BT_LOGW_STR("Invalid parameter: stream is NULL.");
1398 if (stream
->pos
.fd
< 0) {
1399 BT_LOGW_STR("Invalid parameter: stream is not a CTF writer stream.");
1404 trace
= (struct bt_ctf_trace
*) bt_object_get_parent(stream
);
1407 if (trace
->packet_header_type
) {
1408 BT_LOGW("Invalid parameter: setting no packet header but packet header field type is not NULL: "
1409 "stream-addr=%p, stream-name=\"%s\", "
1410 "packet-header-field-addr=%p, "
1411 "expected-ft-addr=%p",
1412 stream
, bt_ctf_stream_get_name(stream
),
1413 field
, trace
->packet_header_type
);
1418 goto skip_validation
;
1421 field_type
= bt_ctf_field_get_type(field
);
1424 if (bt_ctf_field_type_compare(field_type
, trace
->packet_header_type
)) {
1425 BT_LOGW("Invalid parameter: packet header's field type is different from the stream's packet header field type: "
1426 "stream-addr=%p, stream-name=\"%s\", "
1427 "packet-header-field-addr=%p, "
1428 "packet-header-ft-addr=%p",
1429 stream
, bt_ctf_stream_get_name(stream
),
1436 bt_put(stream
->packet_header
);
1437 stream
->packet_header
= bt_get(field
);
1438 BT_LOGV("Set stream's packet header field: "
1439 "stream-addr=%p, stream-name=\"%s\", "
1440 "packet-header-field-addr=%p",
1441 stream
, bt_ctf_stream_get_name(stream
), field
);
1449 void reset_structure_field(struct bt_ctf_field
*structure
, const char *name
)
1451 struct bt_ctf_field
*member
;
1453 member
= bt_ctf_field_structure_get_field(structure
, name
);
1455 (void) bt_ctf_field_reset(member
);
1460 int bt_ctf_stream_flush(struct bt_ctf_stream
*stream
)
1464 struct bt_ctf_stream_pos packet_context_pos
;
1465 struct bt_ctf_trace
*trace
;
1466 enum bt_ctf_byte_order native_byte_order
;
1467 bool has_packet_size
= false;
1470 BT_LOGW_STR("Invalid parameter: stream is NULL.");
1475 if (stream
->pos
.fd
< 0) {
1476 BT_LOGW_STR("Invalid parameter: stream is not a CTF writer stream.");
1481 if (stream
->packet_context
) {
1482 struct bt_ctf_field
*packet_size_field
;
1484 packet_size_field
= bt_ctf_field_structure_get_field(
1485 stream
->packet_context
, "packet_size");
1486 has_packet_size
= (packet_size_field
!= NULL
);
1487 bt_put(packet_size_field
);
1490 if (stream
->flushed_packet_count
== 1) {
1491 if (!stream
->packet_context
) {
1492 BT_LOGW_STR("Cannot flush a stream which has no packet context field more than once.");
1497 if (!has_packet_size
) {
1498 BT_LOGW_STR("Cannot flush a stream which has no packet context's `packet_size` field more than once.");
1504 BT_LOGV("Flushing stream's current packet: stream-addr=%p, "
1505 "stream-name=\"%s\", packet-index=%u", stream
,
1506 bt_ctf_stream_get_name(stream
), stream
->flushed_packet_count
);
1507 trace
= bt_ctf_stream_class_borrow_trace(stream
->stream_class
);
1509 native_byte_order
= bt_ctf_trace_get_native_byte_order(trace
);
1511 ret
= auto_populate_packet_header(stream
);
1513 BT_LOGW_STR("Cannot automatically populate the stream's packet header field.");
1518 ret
= auto_populate_packet_context(stream
);
1520 BT_LOGW_STR("Cannot automatically populate the stream's packet context field.");
1525 /* mmap the next packet */
1526 BT_LOGV("Seeking to the next packet: pos-offset=%" PRId64
,
1527 stream
->pos
.offset
);
1528 bt_ctf_stream_pos_packet_seek(&stream
->pos
, 0, SEEK_CUR
);
1529 assert(stream
->pos
.packet_size
% 8 == 0);
1531 if (stream
->packet_header
) {
1532 BT_LOGV_STR("Serializing packet header field.");
1533 ret
= bt_ctf_field_serialize(stream
->packet_header
, &stream
->pos
,
1536 BT_LOGW("Cannot serialize stream's packet header field: "
1537 "field-addr=%p", stream
->packet_header
);
1542 if (stream
->packet_context
) {
1543 /* Write packet context */
1544 memcpy(&packet_context_pos
, &stream
->pos
,
1545 sizeof(packet_context_pos
));
1546 BT_LOGV_STR("Serializing packet context field.");
1547 ret
= bt_ctf_field_serialize(stream
->packet_context
,
1548 &stream
->pos
, native_byte_order
);
1550 BT_LOGW("Cannot serialize stream's packet context field: "
1551 "field-addr=%p", stream
->packet_context
);
1556 BT_LOGV("Serializing events: count=%u", stream
->events
->len
);
1558 for (i
= 0; i
< stream
->events
->len
; i
++) {
1559 struct bt_ctf_event
*event
= g_ptr_array_index(
1561 struct bt_ctf_event_class
*event_class
=
1562 bt_ctf_event_borrow_event_class(event
);
1564 BT_LOGV("Serializing event: index=%zu, event-addr=%p, "
1565 "event-class-name=\"%s\", event-class-id=%" PRId64
", "
1566 "pos-offset=%" PRId64
", packet-size=%" PRIu64
,
1567 i
, event
, bt_ctf_event_class_get_name(event_class
),
1568 bt_ctf_event_class_get_id(event_class
),
1569 stream
->pos
.offset
, stream
->pos
.packet_size
);
1571 /* Write event header */
1572 BT_LOGV_STR("Serializing event's header field.");
1573 ret
= bt_ctf_field_serialize(event
->event_header
,
1574 &stream
->pos
, native_byte_order
);
1576 BT_LOGW("Cannot serialize event's header field: "
1577 "field-addr=%p", event
->event_header
);
1581 /* Write stream event context */
1582 if (event
->stream_event_context
) {
1583 BT_LOGV_STR("Serializing event's stream event context field.");
1584 ret
= bt_ctf_field_serialize(
1585 event
->stream_event_context
, &stream
->pos
,
1588 BT_LOGW("Cannot serialize event's stream event context field: "
1589 "field-addr=%p", event
->stream_event_context
);
1594 /* Write event content */
1595 ret
= bt_ctf_event_serialize(event
, &stream
->pos
,
1598 /* bt_ctf_event_serialize() logs errors */
1603 if (!has_packet_size
&& stream
->pos
.offset
% 8 != 0) {
1604 BT_LOGW("Stream's packet context field type has no `packet_size` field, "
1605 "but current content size is not a multiple of 8 bits: "
1606 "content-size=%" PRId64
", "
1607 "packet-size=%" PRIu64
,
1609 stream
->pos
.packet_size
);
1614 assert(stream
->pos
.packet_size
% 8 == 0);
1617 * Remove extra padding bytes.
1619 stream
->pos
.packet_size
= (stream
->pos
.offset
+ 7) & ~7;
1621 if (stream
->packet_context
) {
1623 * The whole packet is serialized at this point. Make sure that,
1624 * if `packet_size` is missing, the current content size is
1625 * equal to the current packet size.
1627 struct bt_ctf_field
*field
= bt_ctf_field_structure_get_field(
1628 stream
->packet_context
, "content_size");
1632 if (stream
->pos
.offset
!= stream
->pos
.packet_size
) {
1633 BT_LOGW("Stream's packet context's `content_size` field is missing, "
1634 "but current packet's content size is not equal to its packet size: "
1635 "content-size=%" PRId64
", "
1636 "packet-size=%" PRIu64
,
1638 stream
->pos
.packet_size
);
1645 * Overwrite the packet context now that the stream
1646 * position's packet and content sizes have the correct
1649 * Copy base_mma as the packet may have been remapped
1650 * (e.g. when a packet is resized).
1652 packet_context_pos
.base_mma
= stream
->pos
.base_mma
;
1653 ret
= auto_populate_packet_context(stream
);
1655 BT_LOGW_STR("Cannot automatically populate the stream's packet context field.");
1660 BT_LOGV("Rewriting (serializing) packet context field.");
1661 ret
= bt_ctf_field_serialize(stream
->packet_context
,
1662 &packet_context_pos
, native_byte_order
);
1664 BT_LOGW("Cannot serialize stream's packet context field: "
1665 "field-addr=%p", stream
->packet_context
);
1670 g_ptr_array_set_size(stream
->events
, 0);
1671 stream
->flushed_packet_count
++;
1672 stream
->size
+= stream
->pos
.packet_size
/ CHAR_BIT
;
1675 ret
= ftruncate(stream
->pos
.fd
, stream
->size
);
1676 } while (ret
== -1 && errno
== EINTR
);
1678 BT_LOGE_ERRNO("Cannot ftruncate() stream file to new size",
1679 "size = %" PRIu64
", name = %s",
1681 stream
->name
? stream
->name
->str
: "(null)");
1685 /* Reset automatically-set fields. */
1686 if (stream
->packet_context
) {
1687 reset_structure_field(stream
->packet_context
, "timestamp_begin");
1688 reset_structure_field(stream
->packet_context
, "timestamp_end");
1689 reset_structure_field(stream
->packet_context
, "packet_size");
1690 reset_structure_field(stream
->packet_context
, "content_size");
1691 reset_structure_field(stream
->packet_context
, "events_discarded");
1696 * We failed to write the packet. Its size is therefore set to 0
1697 * to ensure the next mapping is done in the same place rather
1698 * than advancing by "stream->pos.packet_size", which would
1699 * leave a corrupted packet in the trace.
1701 stream
->pos
.packet_size
= 0;
1703 BT_LOGV("Flushed stream's current packet: content-size=%" PRId64
", "
1704 "packet-size=%" PRIu64
,
1705 stream
->pos
.offset
, stream
->pos
.packet_size
);
1710 /* Pre-2.0 CTF writer backward compatibility */
1711 void bt_ctf_stream_get(struct bt_ctf_stream
*stream
)
1716 /* Pre-2.0 CTF writer backward compatibility */
1717 void bt_ctf_stream_put(struct bt_ctf_stream
*stream
)
1723 void bt_ctf_stream_destroy(struct bt_object
*obj
)
1725 struct bt_ctf_stream
*stream
;
1728 stream
= container_of(obj
, struct bt_ctf_stream
, base
);
1729 BT_LOGD("Destroying stream object: addr=%p, name=\"%s\"",
1730 stream
, bt_ctf_stream_get_name(stream
));
1732 /* Call destroy listeners in reverse registration order */
1733 for (i
= stream
->destroy_listeners
->len
- 1; i
>= 0; i
--) {
1734 struct bt_ctf_stream_destroy_listener
*listener
=
1735 &g_array_index(stream
->destroy_listeners
,
1736 struct bt_ctf_stream_destroy_listener
, i
);
1738 BT_LOGD("Calling destroy listener: func=%p, data=%p, index=%d",
1739 listener
->func
, listener
->data
, i
);
1740 listener
->func(stream
, listener
->data
);
1743 (void) bt_ctf_stream_pos_fini(&stream
->pos
);
1744 if (stream
->pos
.fd
>= 0) {
1748 * Truncate the file's size to the minimum required to fit the
1749 * last packet as we might have grown it too much on the last
1753 ret
= ftruncate(stream
->pos
.fd
, stream
->size
);
1754 } while (ret
== -1 && errno
== EINTR
);
1756 BT_LOGE("Failed to truncate stream file: %s: "
1757 "ret=%d, errno=%d, size=%" PRIu64
,
1758 strerror(errno
), ret
, errno
,
1759 (uint64_t) stream
->size
);
1762 if (close(stream
->pos
.fd
)) {
1763 BT_LOGE("Failed to close stream file: %s: "
1764 "ret=%d, errno=%d", strerror(errno
),
1769 if (stream
->events
) {
1770 BT_LOGD_STR("Putting events.");
1771 g_ptr_array_free(stream
->events
, TRUE
);
1775 g_string_free(stream
->name
, TRUE
);
1778 if (stream
->comp_cur_port
) {
1779 GHashTableIter ht_iter
;
1780 gpointer comp_gptr
, port_gptr
;
1783 * Since we're destroying the stream, remove the destroy
1784 * listeners that it registered for each component in
1785 * its component-port mapping hash table. Otherwise they
1786 * would be called and the stream would be accessed once
1787 * it's freed or another stream would be accessed.
1789 g_hash_table_iter_init(&ht_iter
, stream
->comp_cur_port
);
1791 while (g_hash_table_iter_next(&ht_iter
, &comp_gptr
, &port_gptr
)) {
1793 bt_component_remove_destroy_listener((void *) comp_gptr
,
1794 component_destroy_listener
, stream
);
1797 g_hash_table_destroy(stream
->comp_cur_port
);
1800 if (stream
->destroy_listeners
) {
1801 g_array_free(stream
->destroy_listeners
, TRUE
);
1804 BT_LOGD_STR("Putting packet header field.");
1805 bt_put(stream
->packet_header
);
1806 BT_LOGD_STR("Putting packet context field.");
1807 bt_put(stream
->packet_context
);
1812 int _set_structure_field_integer(struct bt_ctf_field
*structure
, char *name
,
1813 uint64_t value
, bt_bool force
)
1816 struct bt_ctf_field_type
*field_type
= NULL
;
1817 struct bt_ctf_field
*integer
;
1822 integer
= bt_ctf_field_structure_get_field(structure
, name
);
1824 /* Field not found, not an error. */
1825 BT_LOGV("Field not found: struct-field-addr=%p, "
1826 "name=\"%s\", force=%d", structure
, name
, force
);
1830 /* Make sure the payload has not already been set. */
1831 if (!force
&& bt_ctf_field_is_set(integer
)) {
1832 /* Payload already set, not an error */
1833 BT_LOGV("Field's payload is already set: struct-field-addr=%p, "
1834 "name=\"%s\", force=%d", structure
, name
, force
);
1838 field_type
= bt_ctf_field_get_type(integer
);
1840 if (bt_ctf_field_type_get_type_id(field_type
) != BT_CTF_FIELD_TYPE_ID_INTEGER
) {
1842 * The user most likely meant for us to populate this field
1843 * automatically. However, we can only do this if the field
1844 * is an integer. Return an error.
1846 BT_LOGW("Invalid parameter: field's type is not an integer field type: "
1847 "field-addr=%p, ft-addr=%p, ft-id=%s",
1848 integer
, field_type
,
1849 bt_ctf_field_type_id_string(field_type
->id
));
1854 if (bt_ctf_field_type_integer_get_signed(field_type
)) {
1855 ret
= bt_ctf_field_signed_integer_set_value(integer
,
1858 ret
= bt_ctf_field_unsigned_integer_set_value(integer
, value
);
1860 ret
= !ret
? 1 : ret
;
1868 * Returns the following codes:
1869 * 1 if the field was found and set,
1870 * 0 if nothing was done (field not found, or was already set),
1871 * <0 if an error was encoutered
1874 int try_set_structure_field_integer(struct bt_ctf_field
*structure
, char *name
,
1877 return _set_structure_field_integer(structure
, name
, value
, BT_FALSE
);
1880 const char *bt_ctf_stream_get_name(struct bt_ctf_stream
*stream
)
1882 const char *name
= NULL
;
1885 BT_LOGW_STR("Invalid parameter: stream is NULL.");
1889 name
= stream
->name
? stream
->name
->str
: NULL
;
1895 int bt_ctf_stream_is_writer(struct bt_ctf_stream
*stream
)
1900 BT_LOGW_STR("Invalid parameter: stream is NULL.");
1904 ret
= (stream
->pos
.fd
>= 0);
1911 void bt_ctf_stream_map_component_to_port(struct bt_ctf_stream
*stream
,
1912 struct bt_component
*comp
,
1913 struct bt_port
*port
)
1918 assert(stream
->comp_cur_port
);
1921 * Do not take a reference to the component here because we
1922 * don't want the component to exist as long as this stream
1923 * exists. Instead, keep a weak reference, but add a destroy
1924 * listener so that we remove this hash table entry when we know
1925 * the component is destroyed.
1927 BT_LOGV("Adding component's destroy listener for stream: "
1928 "stream-addr=%p, stream-name=\"%s\", comp-addr=%p, "
1929 "comp-name=\"%s\", port-addr=%p, port-name=\"%s\"",
1930 stream
, bt_ctf_stream_get_name(stream
),
1931 comp
, bt_component_get_name(comp
), port
,
1932 bt_port_get_name(port
));
1933 bt_component_add_destroy_listener(comp
, component_destroy_listener
,
1935 g_hash_table_insert(stream
->comp_cur_port
, comp
, port
);
1936 BT_LOGV_STR("Mapped component to port for stream.");
1940 struct bt_port
*bt_ctf_stream_port_for_component(struct bt_ctf_stream
*stream
,
1941 struct bt_component
*comp
)
1945 assert(stream
->comp_cur_port
);
1946 return g_hash_table_lookup(stream
->comp_cur_port
, comp
);
1950 void bt_ctf_stream_add_destroy_listener(struct bt_ctf_stream
*stream
,
1951 bt_ctf_stream_destroy_listener_func func
, void *data
)
1953 struct bt_ctf_stream_destroy_listener listener
;
1957 listener
.func
= func
;
1958 listener
.data
= data
;
1959 g_array_append_val(stream
->destroy_listeners
, listener
);
1960 BT_LOGV("Added stream destroy listener: stream-addr=%p, "
1961 "stream-name=\"%s\", func=%p, data=%p",
1962 stream
, bt_ctf_stream_get_name(stream
), func
, data
);
1966 void bt_ctf_stream_remove_destroy_listener(struct bt_ctf_stream
*stream
,
1967 bt_ctf_stream_destroy_listener_func func
, void *data
)
1974 for (i
= 0; i
< stream
->destroy_listeners
->len
; i
++) {
1975 struct bt_ctf_stream_destroy_listener
*listener
=
1976 &g_array_index(stream
->destroy_listeners
,
1977 struct bt_ctf_stream_destroy_listener
, i
);
1979 if (listener
->func
== func
&& listener
->data
== data
) {
1980 g_array_remove_index(stream
->destroy_listeners
, i
);
1982 BT_LOGV("Removed stream destroy listener: stream-addr=%p, "
1983 "stream-name=\"%s\", func=%p, data=%p",
1984 stream
, bt_ctf_stream_get_name(stream
),
1990 int64_t bt_ctf_stream_get_id(struct bt_ctf_stream
*stream
)
1995 BT_LOGW_STR("Invalid parameter: stream is NULL.");
2002 BT_LOGV("Stream's ID is not set: addr=%p, name=\"%s\"",
2003 stream
, bt_ctf_stream_get_name(stream
));