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>
53 void bt_ctf_stream_destroy(struct bt_object
*obj
);
55 int try_set_structure_field_integer(struct bt_ctf_field
*, char *, uint64_t);
58 int set_integer_field_value(struct bt_ctf_field
* field
, uint64_t value
)
61 struct bt_ctf_field_type
*field_type
= NULL
;
64 BT_LOGW_STR("Invalid parameter: field is NULL.");
69 field_type
= bt_ctf_field_get_type(field
);
72 if (bt_ctf_field_type_get_type_id(field_type
) !=
73 BT_CTF_FIELD_TYPE_ID_INTEGER
) {
74 /* Not an integer and the value is unset, error. */
75 BT_LOGW("Invalid parameter: field's type is not an integer field type: "
76 "field-addr=%p, ft-addr=%p, ft-id=%s",
78 bt_ctf_field_type_id_string(field_type
->id
));
83 if (bt_ctf_field_type_integer_get_signed(field_type
)) {
84 ret
= bt_ctf_field_signed_integer_set_value(field
, (int64_t) value
);
86 /* Value is out of range, error. */
87 BT_LOGW("Cannot set signed integer field's value: "
88 "addr=%p, value=%" PRId64
,
89 field
, (int64_t) value
);
93 ret
= bt_ctf_field_unsigned_integer_set_value(field
, value
);
95 /* Value is out of range, error. */
96 BT_LOGW("Cannot set unsigned integer field's value: "
97 "addr=%p, value=%" PRIu64
,
108 int set_packet_header_magic(struct bt_ctf_stream
*stream
)
111 struct bt_ctf_field
*magic_field
= bt_ctf_field_structure_get_field(
112 stream
->packet_header
, "magic");
113 const uint32_t magic_value
= 0xc1fc1fc1;
118 /* No magic field found. Not an error, skip. */
119 BT_LOGV("No field named `magic` in packet header: skipping: "
120 "stream-addr=%p, stream-name=\"%s\"",
121 stream
, bt_ctf_stream_get_name(stream
));
125 ret
= bt_ctf_field_unsigned_integer_set_value(magic_field
,
126 (uint64_t) magic_value
);
129 BT_LOGW("Cannot set packet header field's `magic` integer field's value: "
130 "stream-addr=%p, stream-name=\"%s\", field-addr=%p, value=%" PRIu64
,
131 stream
, bt_ctf_stream_get_name(stream
),
132 magic_field
, (uint64_t) magic_value
);
134 BT_LOGV("Set packet header field's `magic` field's value: "
135 "stream-addr=%p, stream-name=\"%s\", field-addr=%p, value=%" PRIu64
,
136 stream
, bt_ctf_stream_get_name(stream
),
137 magic_field
, (uint64_t) magic_value
);
145 int set_packet_header_uuid(struct bt_ctf_stream
*stream
)
149 struct bt_ctf_trace
*trace
= NULL
;
150 struct bt_ctf_field
*uuid_field
= bt_ctf_field_structure_get_field(
151 stream
->packet_header
, "uuid");
156 /* No uuid field found. Not an error, skip. */
157 BT_LOGV("No field named `uuid` in packet header: skipping: "
158 "stream-addr=%p, stream-name=\"%s\"",
159 stream
, bt_ctf_stream_get_name(stream
));
163 trace
= (struct bt_ctf_trace
*) bt_object_get_parent(stream
);
164 for (i
= 0; i
< 16; i
++) {
165 struct bt_ctf_field
*uuid_element
=
166 bt_ctf_field_array_get_field(uuid_field
, i
);
168 ret
= bt_ctf_field_unsigned_integer_set_value(
169 uuid_element
, (uint64_t) trace
->uuid
[i
]);
170 bt_put(uuid_element
);
172 BT_LOGW("Cannot set integer field's value (for `uuid` packet header field): "
173 "stream-addr=%p, stream-name=\"%s\", field-addr=%p, "
174 "value=%" PRIu64
", index=%" PRId64
,
175 stream
, bt_ctf_stream_get_name(stream
),
176 uuid_element
, (uint64_t) trace
->uuid
[i
], i
);
181 BT_LOGV("Set packet header field's `uuid` field's value: "
182 "stream-addr=%p, stream-name=\"%s\", field-addr=%p",
183 stream
, bt_ctf_stream_get_name(stream
), uuid_field
);
191 int set_packet_header_stream_id(struct bt_ctf_stream
*stream
)
195 struct bt_ctf_field
*stream_id_field
= bt_ctf_field_structure_get_field(
196 stream
->packet_header
, "stream_id");
198 if (!stream_id_field
) {
199 /* No stream_id field found. Not an error, skip. */
200 BT_LOGV("No field named `stream_id` in packet header: skipping: "
201 "stream-addr=%p, stream-name=\"%s\"",
202 stream
, bt_ctf_stream_get_name(stream
));
206 stream_id
= stream
->stream_class
->id
;
207 ret
= bt_ctf_field_unsigned_integer_set_value(stream_id_field
,
208 (uint64_t) stream_id
);
210 BT_LOGW("Cannot set packet header field's `stream_id` integer field's value: "
211 "stream-addr=%p, stream-name=\"%s\", field-addr=%p, value=%" PRIu64
,
212 stream
, bt_ctf_stream_get_name(stream
),
213 stream_id_field
, (uint64_t) stream_id
);
215 BT_LOGV("Set packet header field's `stream_id` field's value: "
216 "stream-addr=%p, stream-name=\"%s\", field-addr=%p, value=%" PRIu64
,
217 stream
, bt_ctf_stream_get_name(stream
),
218 stream_id_field
, (uint64_t) stream_id
);
222 bt_put(stream_id_field
);
227 int auto_populate_packet_header(struct bt_ctf_stream
*stream
)
231 if (!stream
->packet_header
) {
235 ret
= set_packet_header_magic(stream
);
237 BT_LOGW("Cannot set packet header's magic number field: "
238 "stream-addr=%p, stream-name=\"%s\"",
239 stream
, bt_ctf_stream_get_name(stream
));
243 ret
= set_packet_header_uuid(stream
);
245 BT_LOGW("Cannot set packet header's UUID field: "
246 "stream-addr=%p, stream-name=\"%s\"",
247 stream
, bt_ctf_stream_get_name(stream
));
251 ret
= set_packet_header_stream_id(stream
);
253 BT_LOGW("Cannot set packet header's stream class ID field: "
254 "stream-addr=%p, stream-name=\"%s\"",
255 stream
, bt_ctf_stream_get_name(stream
));
259 BT_LOGV("Automatically populated stream's packet header's known fields: "
260 "stream-addr=%p, stream-name=\"%s\"",
261 stream
, bt_ctf_stream_get_name(stream
));
268 int set_packet_context_packet_size(struct bt_ctf_stream
*stream
)
271 struct bt_ctf_field
*field
= bt_ctf_field_structure_get_field(
272 stream
->packet_context
, "packet_size");
277 /* No packet size field found. Not an error, skip. */
278 BT_LOGV("No field named `packet_size` in packet context: skipping: "
279 "stream-addr=%p, stream-name=\"%s\"",
280 stream
, bt_ctf_stream_get_name(stream
));
284 ret
= bt_ctf_field_unsigned_integer_set_value(field
,
285 stream
->pos
.packet_size
);
287 BT_LOGW("Cannot set packet context field's `packet_size` integer field's value: "
288 "stream-addr=%p, stream-name=\"%s\", field-addr=%p, value=%" PRIu64
,
289 stream
, bt_ctf_stream_get_name(stream
),
290 field
, stream
->pos
.packet_size
);
292 BT_LOGV("Set packet context field's `packet_size` field's value: "
293 "stream-addr=%p, stream-name=\"%s\", field-addr=%p, value=%" PRIu64
,
294 stream
, bt_ctf_stream_get_name(stream
),
295 field
, stream
->pos
.packet_size
);
304 int set_packet_context_content_size(struct bt_ctf_stream
*stream
)
307 struct bt_ctf_field
*field
= bt_ctf_field_structure_get_field(
308 stream
->packet_context
, "content_size");
313 /* No content size field found. Not an error, skip. */
314 BT_LOGV("No field named `content_size` in packet context: skipping: "
315 "stream-addr=%p, stream-name=\"%s\"",
316 stream
, bt_ctf_stream_get_name(stream
));
320 ret
= bt_ctf_field_unsigned_integer_set_value(field
,
323 BT_LOGW("Cannot set packet context field's `content_size` integer field's value: "
324 "stream-addr=%p, stream-name=\"%s\", field-addr=%p, value=%" PRId64
,
325 stream
, bt_ctf_stream_get_name(stream
),
326 field
, stream
->pos
.offset
);
328 BT_LOGV("Set packet context field's `content_size` field's value: "
329 "stream-addr=%p, stream-name=\"%s\", field-addr=%p, value=%" PRId64
,
330 stream
, bt_ctf_stream_get_name(stream
),
331 field
, stream
->pos
.offset
);
340 int set_packet_context_events_discarded(struct bt_ctf_stream
*stream
)
343 struct bt_ctf_field
*field
= bt_ctf_field_structure_get_field(
344 stream
->packet_context
, "events_discarded");
349 /* No discarded events count field found. Not an error, skip. */
350 BT_LOGV("No field named `events_discarded` in packet context: skipping: "
351 "stream-addr=%p, stream-name=\"%s\"",
352 stream
, bt_ctf_stream_get_name(stream
));
356 ret
= bt_ctf_field_unsigned_integer_set_value(field
,
357 stream
->discarded_events
);
359 BT_LOGW("Cannot set packet context field's `events_discarded` integer field's value: "
360 "stream-addr=%p, stream-name=\"%s\", field-addr=%p, value=%" PRIu64
,
361 stream
, bt_ctf_stream_get_name(stream
),
362 field
, stream
->discarded_events
);
364 BT_LOGV("Set packet context field's `events_discarded` field's value: "
365 "stream-addr=%p, stream-name=\"%s\", field-addr=%p, value=%" PRIu64
,
366 stream
, bt_ctf_stream_get_name(stream
),
367 field
, stream
->discarded_events
);
376 int get_event_header_timestamp(struct bt_ctf_stream
*stream
,
377 struct bt_ctf_field
*event_header
, uint64_t *timestamp
)
380 struct bt_ctf_field
*timestamp_field
= NULL
;
381 struct bt_ctf_clock_class
*ts_field_mapped_clock_class
= NULL
;
386 BT_LOGV_STR("Event header does not exist.");
390 timestamp_field
= bt_ctf_field_structure_get_field(event_header
,
392 if (!timestamp_field
) {
393 BT_LOGV("Cannot get event header's `timestamp` field: "
394 "event-header-field-addr=%p", event_header
);
398 if (!bt_ctf_field_type_is_integer(timestamp_field
->type
)) {
399 BT_LOGV("Event header's `timestamp` field's type is not an integer field type: "
400 "event-header-field-addr=%p", event_header
);
404 ts_field_mapped_clock_class
=
405 bt_ctf_field_type_integer_get_mapped_clock_class(
406 timestamp_field
->type
);
407 if (!ts_field_mapped_clock_class
) {
408 BT_LOGV("Event header's `timestamp` field's type is not mapped to a clock class: "
409 "event-header-field-addr=%p", event_header
);
413 if (ts_field_mapped_clock_class
!=
414 stream
->stream_class
->clock
->clock_class
) {
415 BT_LOGV("Event header's `timestamp` field's type is not mapped to the stream's clock's class: "
416 "event-header-field-addr=%p", event_header
);
420 ret
= bt_ctf_field_unsigned_integer_get_value(timestamp_field
,
423 BT_LOGW("Cannot get unsigned integer field's value: "
424 "event-header-field-addr=%p, "
425 "timestamp-field-addr=%p",
426 event_header
, timestamp_field
);
431 bt_put(timestamp_field
);
432 bt_put(ts_field_mapped_clock_class
);
437 int set_packet_context_timestamp_field(struct bt_ctf_stream
*stream
,
438 const char *field_name
, struct bt_ctf_event
*event
)
441 struct bt_ctf_field
*field
= bt_ctf_field_structure_get_field(
442 stream
->packet_context
, field_name
);
443 struct bt_ctf_clock_class
*field_mapped_clock_class
= NULL
;
449 /* No beginning timestamp field found. Not an error, skip. */
450 BT_LOGV("No field named `%s` in packet context: skipping: "
451 "stream-addr=%p, stream-name=\"%s\"", field_name
,
452 stream
, bt_ctf_stream_get_name(stream
));
456 if (!stream
->stream_class
->clock
) {
457 BT_LOGV("Stream has no clock: skipping: "
458 "stream-addr=%p, stream-name=\"%s\"",
459 stream
, bt_ctf_stream_get_name(stream
));
463 field_mapped_clock_class
=
464 bt_ctf_field_type_integer_get_mapped_clock_class(field
->type
);
465 if (!field_mapped_clock_class
) {
466 BT_LOGV("Packet context's `%s` field's type is not mapped to a clock class: skipping: "
467 "stream-addr=%p, stream-name=\"%s\", "
468 "field-addr=%p, ft-addr=%p", field_name
,
469 stream
, bt_ctf_stream_get_name(stream
),
474 if (field_mapped_clock_class
!=
475 stream
->stream_class
->clock
->clock_class
) {
476 BT_LOGV("Packet context's `%s` field's type is not mapped to the stream's clock's class: skipping: "
477 "stream-addr=%p, stream-name=\"%s\", "
478 "field-addr=%p, ft-addr=%p, "
479 "ft-mapped-clock-class-addr=%p, "
480 "ft-mapped-clock-class-name=\"%s\", "
481 "stream-clock-class-addr=%p, "
482 "stream-clock-class-name=\"%s\"",
484 stream
, bt_ctf_stream_get_name(stream
),
486 field_mapped_clock_class
,
487 bt_ctf_clock_class_get_name(field_mapped_clock_class
),
488 stream
->stream_class
->clock
->clock_class
,
489 bt_ctf_clock_class_get_name(
490 stream
->stream_class
->clock
->clock_class
));
494 if (get_event_header_timestamp(stream
, event
->event_header
, &ts
)) {
495 BT_LOGW("Cannot get event's timestamp: "
496 "event-header-field-addr=%p",
497 event
->event_header
);
502 ret
= bt_ctf_field_unsigned_integer_set_value(field
, ts
);
504 BT_LOGW("Cannot set packet context field's `%s` integer field's value: "
505 "stream-addr=%p, stream-name=\"%s\", field-addr=%p, value=%" PRIu64
,
506 field_name
, stream
, bt_ctf_stream_get_name(stream
),
507 field
, stream
->discarded_events
);
509 BT_LOGV("Set packet context field's `%s` field's value: "
510 "stream-addr=%p, stream-name=\"%s\", field-addr=%p, value=%" PRIu64
,
511 field_name
, stream
, bt_ctf_stream_get_name(stream
),
512 field
, stream
->discarded_events
);
517 bt_put(field_mapped_clock_class
);
522 int set_packet_context_timestamp_begin(struct bt_ctf_stream
*stream
)
526 if (stream
->events
->len
== 0) {
527 BT_LOGV("Current packet contains no events: skipping: "
528 "stream-addr=%p, stream-name=\"%s\"",
529 stream
, bt_ctf_stream_get_name(stream
));
533 ret
= set_packet_context_timestamp_field(stream
, "timestamp_begin",
534 g_ptr_array_index(stream
->events
, 0));
541 int set_packet_context_timestamp_end(struct bt_ctf_stream
*stream
)
545 if (stream
->events
->len
== 0) {
546 BT_LOGV("Current packet contains no events: skipping: "
547 "stream-addr=%p, stream-name=\"%s\"",
548 stream
, bt_ctf_stream_get_name(stream
));
552 ret
= set_packet_context_timestamp_field(stream
, "timestamp_end",
553 g_ptr_array_index(stream
->events
, stream
->events
->len
- 1));
560 int auto_populate_packet_context(struct bt_ctf_stream
*stream
)
564 if (!stream
->packet_context
) {
568 ret
= set_packet_context_packet_size(stream
);
570 BT_LOGW("Cannot set packet context's packet size field: "
571 "stream-addr=%p, stream-name=\"%s\"",
572 stream
, bt_ctf_stream_get_name(stream
));
576 ret
= set_packet_context_content_size(stream
);
578 BT_LOGW("Cannot set packet context's content size field: "
579 "stream-addr=%p, stream-name=\"%s\"",
580 stream
, bt_ctf_stream_get_name(stream
));
584 ret
= set_packet_context_timestamp_begin(stream
);
586 BT_LOGW("Cannot set packet context's beginning timestamp field: "
587 "stream-addr=%p, stream-name=\"%s\"",
588 stream
, bt_ctf_stream_get_name(stream
));
592 ret
= set_packet_context_timestamp_end(stream
);
594 BT_LOGW("Cannot set packet context's end timestamp field: "
595 "stream-addr=%p, stream-name=\"%s\"",
596 stream
, bt_ctf_stream_get_name(stream
));
600 ret
= set_packet_context_events_discarded(stream
);
602 BT_LOGW("Cannot set packet context's discarded events count field: "
603 "stream-addr=%p, stream-name=\"%s\"",
604 stream
, bt_ctf_stream_get_name(stream
));
608 BT_LOGV("Automatically populated stream's packet context's known fields: "
609 "stream-addr=%p, stream-name=\"%s\"",
610 stream
, bt_ctf_stream_get_name(stream
));
617 void release_event(struct bt_ctf_event
*event
)
619 if (bt_object_get_ref_count(event
)) {
621 * The event is being orphaned, but it must guarantee the
622 * existence of its event class for the duration of its
625 bt_get(event
->event_class
);
626 BT_PUT(event
->base
.parent
);
628 bt_object_release(event
);
633 int create_stream_file(struct bt_ctf_writer
*writer
,
634 struct bt_ctf_stream
*stream
)
637 GString
*filename
= g_string_new(stream
->stream_class
->name
->str
);
639 BT_LOGD("Creating stream file: writer-addr=%p, stream-addr=%p, "
640 "stream-name=\"%s\", stream-class-addr=%p, stream-class-name=\"%s\"",
641 writer
, stream
, bt_ctf_stream_get_name(stream
),
642 stream
->stream_class
, stream
->stream_class
->name
->str
);
644 if (stream
->stream_class
->name
->len
== 0) {
647 ret
= bt_ctf_stream_class_get_id(stream
->stream_class
);
649 BT_LOGW("Cannot get stream class's ID: "
650 "stream-class-addr=%p, "
651 "stream-class-name=\"%s\"",
652 stream
->stream_class
,
653 stream
->stream_class
->name
->str
);
658 g_string_printf(filename
, "stream_%" PRId64
, ret
);
661 g_string_append_printf(filename
, "_%" PRId64
, stream
->id
);
662 fd
= openat(writer
->trace_dir_fd
, filename
->str
,
663 O_RDWR
| O_CREAT
| O_TRUNC
,
664 S_IRUSR
| S_IWUSR
| S_IRGRP
| S_IWGRP
);
666 BT_LOGW("Failed to open stream file for writing: %s: "
667 "writer-trace-dir-fd=%d, filename=\"%s\", "
668 "ret=%d, errno=%d", strerror(errno
),
669 writer
->trace_dir_fd
, filename
->str
, fd
, errno
);
673 BT_LOGD("Created stream file for writing: "
674 "stream-addr=%p, stream-name=\"%s\", writer-trace-dir-fd=%d, "
675 "filename=\"%s\", fd=%d", stream
, bt_ctf_stream_get_name(stream
),
676 writer
->trace_dir_fd
, filename
->str
, fd
);
679 g_string_free(filename
, TRUE
);
684 void set_stream_fd(struct bt_ctf_stream
*stream
, int fd
)
686 (void) bt_ctf_stream_pos_init(&stream
->pos
, fd
, O_RDWR
);
691 void component_destroy_listener(struct bt_component
*component
, void *data
)
693 struct bt_ctf_stream
*stream
= data
;
695 BT_LOGD("Component is being destroyed, stream is notified: "
696 "comp-addr=%p, stream-addr=%p", component
, stream
);
697 g_hash_table_remove(stream
->comp_cur_port
, component
);
701 struct bt_ctf_stream
*bt_ctf_stream_create_with_id_no_check(
702 struct bt_ctf_stream_class
*stream_class
,
703 const char *name
, uint64_t id
)
706 struct bt_ctf_stream
*stream
= NULL
;
707 struct bt_ctf_trace
*trace
= NULL
;
708 struct bt_ctf_writer
*writer
= NULL
;
711 BT_LOGW_STR("Invalid parameter: stream class is NULL.");
715 BT_LOGD("Creating stream object: stream-class-addr=%p, "
716 "stream-class-name=\"%s\", stream-name=\"%s\", "
717 "stream-id=%" PRIu64
,
718 stream_class
, bt_ctf_stream_class_get_name(stream_class
),
720 trace
= bt_ctf_stream_class_borrow_trace(stream_class
);
722 BT_LOGW("Invalid parameter: cannot create stream from a stream class which is not part of trace: "
723 "stream-class-addr=%p, stream-class-name=\"%s\", "
724 "stream-name=\"%s\"",
725 stream_class
, bt_ctf_stream_class_get_name(stream_class
),
730 if (bt_ctf_trace_is_static(trace
)) {
732 * A static trace has the property that all its stream
733 * classes, clock classes, and streams are definitive:
734 * no more can be added, and each object is also frozen.
736 BT_LOGW("Invalid parameter: cannot create stream from a stream class which is part of a static trace: "
737 "stream-class-addr=%p, stream-class-name=\"%s\", "
738 "stream-name=\"%s\", trace-addr=%p",
739 stream_class
, bt_ctf_stream_class_get_name(stream_class
),
746 * Validate that the given ID is unique amongst all the
747 * existing trace's streams created from the same stream
752 for (i
= 0; i
< trace
->streams
->len
; i
++) {
753 struct bt_ctf_stream
*trace_stream
=
754 g_ptr_array_index(trace
->streams
, i
);
756 if (trace_stream
->stream_class
!= stream_class
) {
760 if (trace_stream
->id
== id
) {
761 BT_LOGW_STR("Invalid parameter: another stream in the same trace already has this ID.");
767 stream
= g_new0(struct bt_ctf_stream
, 1);
769 BT_LOGE_STR("Failed to allocate one stream.");
773 bt_object_init(stream
, bt_ctf_stream_destroy
);
775 * Acquire reference to parent since stream will become publicly
776 * reachable; it needs its parent to remain valid.
778 bt_object_set_parent(stream
, trace
);
779 stream
->stream_class
= stream_class
;
781 stream
->id
= (int64_t) id
;
783 stream
->destroy_listeners
= g_array_new(FALSE
, TRUE
,
784 sizeof(struct bt_ctf_stream_destroy_listener
));
785 if (!stream
->destroy_listeners
) {
786 BT_LOGE_STR("Failed to allocate a GArray.");
791 stream
->name
= g_string_new(name
);
793 BT_LOGE_STR("Failed to allocate a GString.");
798 BT_LOGD("Set stream's trace parent: trace-addr=%p", trace
);
800 if (trace
->is_created_by_writer
) {
802 writer
= (struct bt_ctf_writer
*) bt_object_get_parent(trace
);
803 stream
->id
= (int64_t) stream_class
->next_stream_id
++;
805 BT_LOGD("Stream object belongs to a writer's trace: "
806 "writer-addr=%p", writer
);
809 if (stream_class
->packet_context_type
) {
810 BT_LOGD("Creating stream's packet context field: "
811 "ft-addr=%p", stream_class
->packet_context_type
);
812 stream
->packet_context
= bt_ctf_field_create(
813 stream_class
->packet_context_type
);
814 if (!stream
->packet_context
) {
815 BT_LOGW_STR("Cannot create stream's packet context field.");
819 /* Initialize events_discarded */
820 ret
= try_set_structure_field_integer(
821 stream
->packet_context
, "events_discarded", 0);
823 BT_LOGW("Cannot set `events_discarded` field in packet context: "
824 "ret=%d, packet-context-field-addr=%p",
825 ret
, stream
->packet_context
);
830 stream
->events
= g_ptr_array_new_with_free_func(
831 (GDestroyNotify
) release_event
);
832 if (!stream
->events
) {
833 BT_LOGE_STR("Failed to allocate a GPtrArray.");
837 if (trace
->packet_header_type
) {
838 BT_LOGD("Creating stream's packet header field: "
839 "ft-addr=%p", trace
->packet_header_type
);
840 stream
->packet_header
=
841 bt_ctf_field_create(trace
->packet_header_type
);
842 if (!stream
->packet_header
) {
843 BT_LOGW_STR("Cannot create stream's packet header field.");
849 * Attempt to populate the default trace packet header fields
850 * (magic, uuid and stream_id). This will _not_ fail shall the
851 * fields not be found or be of an incompatible type; they will
852 * simply not be populated automatically. The user will have to
853 * make sure to set the trace packet header fields himself
856 ret
= auto_populate_packet_header(stream
);
858 BT_LOGW_STR("Cannot automatically populate the stream's packet header.");
862 /* Create file associated with this stream */
863 fd
= create_stream_file(writer
, stream
);
865 BT_LOGW_STR("Cannot create stream file.");
869 set_stream_fd(stream
, fd
);
871 /* Freeze the writer */
872 BT_LOGD_STR("Freezing stream's CTF writer.");
873 bt_ctf_writer_freeze(writer
);
875 /* Non-writer stream indicated by a negative FD */
876 set_stream_fd(stream
, -1);
877 stream
->comp_cur_port
= g_hash_table_new(g_direct_hash
,
879 if (!stream
->comp_cur_port
) {
880 BT_LOGE_STR("Failed to allocate a GHashTable.");
885 /* Add this stream to the trace's streams */
886 g_ptr_array_add(trace
->streams
, stream
);
887 BT_LOGD("Created stream object: addr=%p", stream
);
898 struct bt_ctf_stream
*bt_ctf_stream_create_with_id(
899 struct bt_ctf_stream_class
*stream_class
,
900 const char *name
, uint64_t id_param
)
902 struct bt_ctf_trace
*trace
;
903 struct bt_ctf_stream
*stream
= NULL
;
904 int64_t id
= (int64_t) id_param
;
907 BT_LOGW_STR("Invalid parameter: stream class is NULL.");
912 BT_LOGW("Invalid parameter: invalid stream's ID: "
913 "name=\"%s\", id=%" PRIu64
,
918 trace
= bt_ctf_stream_class_borrow_trace(stream_class
);
920 BT_LOGW("Invalid parameter: cannot create stream from a stream class which is not part of trace: "
921 "stream-class-addr=%p, stream-class-name=\"%s\", "
922 "stream-name=\"%s\", stream-id=%" PRIu64
,
923 stream_class
, bt_ctf_stream_class_get_name(stream_class
),
928 if (trace
->is_created_by_writer
) {
929 BT_LOGW("Invalid parameter: cannot create a CTF writer stream with this function; use bt_ctf_stream_create(): "
930 "stream-class-addr=%p, stream-class-name=\"%s\", "
931 "stream-name=\"%s\", stream-id=%" PRIu64
,
932 stream_class
, bt_ctf_stream_class_get_name(stream_class
),
937 stream
= bt_ctf_stream_create_with_id_no_check(stream_class
,
944 struct bt_ctf_stream
*bt_ctf_stream_create(
945 struct bt_ctf_stream_class
*stream_class
,
948 return bt_ctf_stream_create_with_id_no_check(stream_class
,
952 struct bt_ctf_stream_class
*bt_ctf_stream_get_class(
953 struct bt_ctf_stream
*stream
)
955 struct bt_ctf_stream_class
*stream_class
= NULL
;
958 BT_LOGW_STR("Invalid parameter: stream is NULL.");
962 stream_class
= stream
->stream_class
;
963 bt_get(stream_class
);
968 int64_t bt_ctf_stream_get_discarded_events_count(
969 struct bt_ctf_stream
*stream
, uint64_t *count
)
974 BT_LOGW_STR("Invalid parameter: stream is NULL.");
980 BT_LOGW_STR("Invalid parameter: count is NULL.");
985 if (stream
->pos
.fd
< 0) {
986 BT_LOGW("Invalid parameter: stream is not a CTF writer stream: "
987 "stream-addr=%p, stream-name=\"%s\"",
988 stream
, bt_ctf_stream_get_name(stream
));
993 *count
= (uint64_t) stream
->discarded_events
;
1000 int set_packet_context_events_discarded_field(struct bt_ctf_stream
*stream
,
1004 struct bt_ctf_field
*events_discarded_field
= NULL
;
1006 if (!stream
->packet_context
) {
1010 events_discarded_field
= bt_ctf_field_structure_get_field(
1011 stream
->packet_context
, "events_discarded");
1012 if (!events_discarded_field
) {
1016 ret
= bt_ctf_field_unsigned_integer_set_value(
1017 events_discarded_field
, count
);
1019 BT_LOGW("Cannot set packet context's `events_discarded` field: "
1020 "field-addr=%p, value=%" PRIu64
,
1021 events_discarded_field
, count
);
1026 bt_put(events_discarded_field
);
1030 void bt_ctf_stream_append_discarded_events(struct bt_ctf_stream
*stream
,
1031 uint64_t event_count
)
1035 struct bt_ctf_field
*events_discarded_field
= NULL
;
1038 BT_LOGW_STR("Invalid parameter: stream is NULL.");
1042 BT_LOGV("Appending discarded events to stream: "
1043 "stream-addr=%p, stream-name=\"%s\", append-count=%" PRIu64
,
1044 stream
, bt_ctf_stream_get_name(stream
), event_count
);
1046 if (!stream
->packet_context
) {
1047 BT_LOGW_STR("Invalid parameter: stream has no packet context field.");
1051 if (stream
->pos
.fd
< 0) {
1052 BT_LOGW_STR("Invalid parameter: stream is not a CTF writer stream.");
1056 events_discarded_field
= bt_ctf_field_structure_get_field(
1057 stream
->packet_context
, "events_discarded");
1058 if (!events_discarded_field
) {
1059 BT_LOGW_STR("No field named `events_discarded` in stream's packet context.");
1063 new_count
= stream
->discarded_events
+ event_count
;
1064 if (new_count
< stream
->discarded_events
) {
1065 BT_LOGW("New discarded events count is less than the stream's current discarded events count: "
1066 "cur-count=%" PRIu64
", new-count=%" PRIu64
,
1067 stream
->discarded_events
, new_count
);
1071 ret
= set_packet_context_events_discarded_field(stream
, new_count
);
1073 /* set_packet_context_events_discarded_field() logs errors */
1077 stream
->discarded_events
= new_count
;
1078 BT_LOGV("Appended discarded events to stream: "
1079 "stream-addr=%p, stream-name=\"%s\", append-count=%" PRIu64
,
1080 stream
, bt_ctf_stream_get_name(stream
), event_count
);
1083 bt_put(events_discarded_field
);
1086 static int auto_populate_event_header(struct bt_ctf_stream
*stream
,
1087 struct bt_ctf_event
*event
)
1090 struct bt_ctf_field
*id_field
= NULL
, *timestamp_field
= NULL
;
1091 struct bt_ctf_clock_class
*mapped_clock_class
= NULL
;
1092 uint64_t event_class_id
;
1096 if (event
->frozen
) {
1097 BT_LOGW_STR("Cannot populate event header field: event is frozen.");
1102 BT_LOGV("Automatically populating event's header field: "
1103 "stream-addr=%p, stream-name=\"%s\", event-addr=%p",
1104 stream
, bt_ctf_stream_get_name(stream
), event
);
1106 id_field
= bt_ctf_field_structure_get_field(event
->event_header
, "id");
1107 event_class_id
= (uint64_t) bt_ctf_event_class_get_id(event
->event_class
);
1108 assert(event_class_id
>= 0);
1109 if (id_field
&& bt_ctf_field_type_is_integer(id_field
->type
)) {
1110 ret
= set_integer_field_value(id_field
, event_class_id
);
1112 BT_LOGW("Cannot set event header's `id` field's value: "
1113 "addr=%p, value=%" PRIu64
, id_field
,
1120 * The conditions to automatically set the timestamp are:
1122 * 1. The event header field "timestamp" exists and is an
1124 * 2. This stream's class has a registered clock (set with
1125 * bt_ctf_stream_class_set_clock()).
1126 * 3. The event header field "timestamp" has its type mapped to
1127 * a clock class which is also the clock class of this
1128 * stream's class's registered clock.
1130 timestamp_field
= bt_ctf_field_structure_get_field(event
->event_header
,
1132 if (timestamp_field
&& stream
->stream_class
->clock
&&
1133 bt_ctf_field_type_is_integer(timestamp_field
->type
)) {
1134 struct bt_ctf_clock_class
*stream_class_clock_class
=
1135 stream
->stream_class
->clock
->clock_class
;
1137 mapped_clock_class
=
1138 bt_ctf_field_type_integer_get_mapped_clock_class(
1139 timestamp_field
->type
);
1140 if (mapped_clock_class
== stream_class_clock_class
) {
1143 ret
= bt_ctf_clock_get_value(
1144 stream
->stream_class
->clock
,
1147 ret
= set_integer_field_value(timestamp_field
,
1150 BT_LOGW("Cannot set event header's `timestamp` field's value: "
1151 "addr=%p, value=%" PRIu64
,
1152 timestamp_field
, timestamp
);
1158 BT_LOGV("Automatically populated event's header field: "
1159 "stream-addr=%p, stream-name=\"%s\", event-addr=%p",
1160 stream
, bt_ctf_stream_get_name(stream
), event
);
1164 bt_put(timestamp_field
);
1165 bt_put(mapped_clock_class
);
1169 int bt_ctf_stream_append_event(struct bt_ctf_stream
*stream
,
1170 struct bt_ctf_event
*event
)
1175 BT_LOGW_STR("Invalid parameter: stream is NULL.");
1181 BT_LOGW_STR("Invalid parameter: event is NULL.");
1186 if (stream
->pos
.fd
< 0) {
1187 BT_LOGW_STR("Invalid parameter: stream is not a CTF writer stream.");
1192 BT_LOGV("Appending event to stream: "
1193 "stream-addr=%p, stream-name=\"%s\", event-addr=%p, "
1194 "event-class-name=\"%s\", event-class-id=%" PRId64
,
1195 stream
, bt_ctf_stream_get_name(stream
), event
,
1196 bt_ctf_event_class_get_name(bt_ctf_event_borrow_event_class(event
)),
1197 bt_ctf_event_class_get_id(bt_ctf_event_borrow_event_class(event
)));
1200 * The event is not supposed to have a parent stream at this
1201 * point. The only other way an event can have a parent stream
1202 * is if it was assigned when setting a packet to the event,
1203 * in which case the packet's stream is not a writer stream,
1204 * and thus the user is trying to append an event which belongs
1205 * to another stream.
1207 if (event
->base
.parent
) {
1212 bt_object_set_parent(event
, stream
);
1213 BT_LOGV_STR("Automatically populating the header of the event to append.");
1214 ret
= auto_populate_event_header(stream
, event
);
1216 /* auto_populate_event_header() reports errors */
1220 /* Make sure the various scopes of the event are set */
1221 BT_LOGV_STR("Validating event to append.");
1222 ret
= bt_ctf_event_validate(event
);
1227 /* Save the new event and freeze it */
1228 BT_LOGV_STR("Freezing the event to append.");
1229 bt_ctf_event_freeze(event
);
1230 g_ptr_array_add(stream
->events
, event
);
1233 * Event had to hold a reference to its event class as long as it wasn't
1234 * part of the same trace hierarchy. From now on, the event and its
1235 * class share the same lifetime guarantees and the reference is no
1238 BT_LOGV_STR("Putting the event's class.");
1239 bt_put(event
->event_class
);
1240 BT_LOGV("Appended event to stream: "
1241 "stream-addr=%p, stream-name=\"%s\", event-addr=%p, "
1242 "event-class-name=\"%s\", event-class-id=%" PRId64
,
1243 stream
, bt_ctf_stream_get_name(stream
), event
,
1244 bt_ctf_event_class_get_name(bt_ctf_event_borrow_event_class(event
)),
1245 bt_ctf_event_class_get_id(bt_ctf_event_borrow_event_class(event
)));
1252 * Orphan the event; we were not successful in associating it to
1255 bt_object_set_parent(event
, NULL
);
1260 struct bt_ctf_field
*bt_ctf_stream_get_packet_context(
1261 struct bt_ctf_stream
*stream
)
1263 struct bt_ctf_field
*packet_context
= NULL
;
1266 BT_LOGW_STR("Invalid parameter: stream is NULL.");
1270 if (stream
->pos
.fd
< 0) {
1271 BT_LOGW("Invalid parameter: stream is not a CTF writer stream: "
1272 "stream-addr=%p, stream-name=\"%s\"", stream
,
1273 bt_ctf_stream_get_name(stream
));
1277 packet_context
= stream
->packet_context
;
1278 if (packet_context
) {
1279 bt_get(packet_context
);
1282 return packet_context
;
1285 int bt_ctf_stream_set_packet_context(struct bt_ctf_stream
*stream
,
1286 struct bt_ctf_field
*field
)
1289 struct bt_ctf_field_type
*field_type
;
1292 BT_LOGW_STR("Invalid parameter: stream is NULL.");
1297 if (stream
->pos
.fd
< 0) {
1298 BT_LOGW_STR("Invalid parameter: stream is not a CTF writer stream.");
1303 field_type
= bt_ctf_field_get_type(field
);
1304 if (bt_ctf_field_type_compare(field_type
,
1305 stream
->stream_class
->packet_context_type
)) {
1306 BT_LOGW("Invalid parameter: packet context's field type is different from the stream's packet context field type: "
1307 "stream-addr=%p, stream-name=\"%s\", "
1308 "packet-context-field-addr=%p, "
1309 "packet-context-ft-addr=%p",
1310 stream
, bt_ctf_stream_get_name(stream
),
1317 bt_put(stream
->packet_context
);
1318 stream
->packet_context
= bt_get(field
);
1319 BT_LOGV("Set stream's packet context field: "
1320 "stream-addr=%p, stream-name=\"%s\", "
1321 "packet-context-field-addr=%p",
1322 stream
, bt_ctf_stream_get_name(stream
), field
);
1327 struct bt_ctf_field
*bt_ctf_stream_get_packet_header(
1328 struct bt_ctf_stream
*stream
)
1330 struct bt_ctf_field
*packet_header
= NULL
;
1333 BT_LOGW_STR("Invalid parameter: stream is NULL.");
1337 if (stream
->pos
.fd
< 0) {
1338 BT_LOGW("Invalid parameter: stream is not a CTF writer stream: "
1339 "stream-addr=%p, stream-name=\"%s\"", stream
,
1340 bt_ctf_stream_get_name(stream
));
1344 packet_header
= stream
->packet_header
;
1345 if (packet_header
) {
1346 bt_get(packet_header
);
1349 return packet_header
;
1352 int bt_ctf_stream_set_packet_header(struct bt_ctf_stream
*stream
,
1353 struct bt_ctf_field
*field
)
1356 struct bt_ctf_trace
*trace
= NULL
;
1357 struct bt_ctf_field_type
*field_type
= NULL
;
1360 BT_LOGW_STR("Invalid parameter: stream is NULL.");
1365 if (stream
->pos
.fd
< 0) {
1366 BT_LOGW_STR("Invalid parameter: stream is not a CTF writer stream.");
1371 trace
= (struct bt_ctf_trace
*) bt_object_get_parent(stream
);
1374 if (trace
->packet_header_type
) {
1375 BT_LOGW("Invalid parameter: setting no packet header but packet header field type is not NULL: "
1376 "stream-addr=%p, stream-name=\"%s\", "
1377 "packet-header-field-addr=%p, "
1378 "expected-ft-addr=%p",
1379 stream
, bt_ctf_stream_get_name(stream
),
1380 field
, trace
->packet_header_type
);
1385 goto skip_validation
;
1388 field_type
= bt_ctf_field_get_type(field
);
1391 if (bt_ctf_field_type_compare(field_type
, trace
->packet_header_type
)) {
1392 BT_LOGW("Invalid parameter: packet header's field type is different from the stream's packet header field type: "
1393 "stream-addr=%p, stream-name=\"%s\", "
1394 "packet-header-field-addr=%p, "
1395 "packet-header-ft-addr=%p",
1396 stream
, bt_ctf_stream_get_name(stream
),
1403 bt_put(stream
->packet_header
);
1404 stream
->packet_header
= bt_get(field
);
1405 BT_LOGV("Set stream's packet header field: "
1406 "stream-addr=%p, stream-name=\"%s\", "
1407 "packet-header-field-addr=%p",
1408 stream
, bt_ctf_stream_get_name(stream
), field
);
1416 void reset_structure_field(struct bt_ctf_field
*structure
, const char *name
)
1418 struct bt_ctf_field
*member
;
1420 member
= bt_ctf_field_structure_get_field(structure
, name
);
1422 (void) bt_ctf_field_reset(member
);
1426 int bt_ctf_stream_flush(struct bt_ctf_stream
*stream
)
1430 struct bt_ctf_stream_pos packet_context_pos
;
1431 struct bt_ctf_trace
*trace
;
1432 enum bt_ctf_byte_order native_byte_order
;
1435 BT_LOGW_STR("Invalid parameter: stream is NULL.");
1440 if (stream
->pos
.fd
< 0) {
1441 BT_LOGW_STR("Invalid parameter: stream is not a CTF writer stream.");
1446 if (stream
->flushed_packet_count
== 1) {
1447 struct bt_ctf_field
*packet_size_field
;
1449 if (!stream
->packet_context
) {
1450 BT_LOGW_STR("Cannot flush a stream which has no packet context field more than once.");
1455 packet_size_field
= bt_ctf_field_structure_get_field(
1456 stream
->packet_context
, "packet_size");
1457 bt_put(packet_size_field
);
1458 if (!packet_size_field
) {
1459 BT_LOGW_STR("Cannot flush a stream which has no packet context's `packet_size` field more than once.");
1465 BT_LOGV("Flushing stream's current packet: stream-addr=%p, "
1466 "stream-name=\"%s\", packet-index=%u", stream
,
1467 bt_ctf_stream_get_name(stream
), stream
->flushed_packet_count
);
1468 trace
= bt_ctf_stream_class_borrow_trace(stream
->stream_class
);
1470 native_byte_order
= bt_ctf_trace_get_native_byte_order(trace
);
1472 ret
= auto_populate_packet_header(stream
);
1474 BT_LOGW_STR("Cannot automatically populate the stream's packet header field.");
1479 ret
= auto_populate_packet_context(stream
);
1481 BT_LOGW_STR("Cannot automatically populate the stream's packet context field.");
1486 /* mmap the next packet */
1487 BT_LOGV("Seeking to the next packet: pos-offset=%" PRId64
,
1488 stream
->pos
.offset
);
1489 bt_ctf_stream_pos_packet_seek(&stream
->pos
, 0, SEEK_CUR
);
1490 assert(stream
->pos
.packet_size
% 8 == 0);
1492 if (stream
->packet_header
) {
1493 BT_LOGV_STR("Serializing packet header field.");
1494 ret
= bt_ctf_field_serialize(stream
->packet_header
, &stream
->pos
,
1497 BT_LOGW("Cannot serialize stream's packet header field: "
1498 "field-addr=%p", stream
->packet_header
);
1503 if (stream
->packet_context
) {
1504 /* Write packet context */
1505 memcpy(&packet_context_pos
, &stream
->pos
,
1506 sizeof(packet_context_pos
));
1507 BT_LOGV_STR("Serializing packet context field.");
1508 ret
= bt_ctf_field_serialize(stream
->packet_context
,
1509 &stream
->pos
, native_byte_order
);
1511 BT_LOGW("Cannot serialize stream's packet context field: "
1512 "field-addr=%p", stream
->packet_context
);
1517 BT_LOGV("Serializing events: count=%u", stream
->events
->len
);
1519 for (i
= 0; i
< stream
->events
->len
; i
++) {
1520 struct bt_ctf_event
*event
= g_ptr_array_index(
1522 struct bt_ctf_event_class
*event_class
=
1523 bt_ctf_event_borrow_event_class(event
);
1525 BT_LOGV("Serializing event: index=%zu, event-addr=%p, "
1526 "event-class-name=\"%s\", event-class-id=%" PRId64
", "
1527 "pos-offset=%" PRId64
", packet-size=%" PRIu64
,
1528 i
, event
, bt_ctf_event_class_get_name(event_class
),
1529 bt_ctf_event_class_get_id(event_class
),
1530 stream
->pos
.offset
, stream
->pos
.packet_size
);
1532 /* Write event header */
1533 BT_LOGV_STR("Serializing event's header field.");
1534 ret
= bt_ctf_field_serialize(event
->event_header
,
1535 &stream
->pos
, native_byte_order
);
1537 BT_LOGW("Cannot serialize event's header field: "
1538 "field-addr=%p", event
->event_header
);
1542 /* Write stream event context */
1543 if (event
->stream_event_context
) {
1544 BT_LOGV_STR("Serializing event's stream event context field.");
1545 ret
= bt_ctf_field_serialize(
1546 event
->stream_event_context
, &stream
->pos
,
1549 BT_LOGW("Cannot serialize event's stream event context field: "
1550 "field-addr=%p", event
->stream_event_context
);
1555 /* Write event content */
1556 ret
= bt_ctf_event_serialize(event
, &stream
->pos
,
1559 /* bt_ctf_event_serialize() logs errors */
1564 assert(stream
->pos
.packet_size
% 8 == 0);
1566 if (stream
->packet_context
) {
1568 * The whole packet is serialized at this point. Make sure that,
1569 * if `packet_size` is missing, the current content size is
1570 * equal to the current packet size.
1572 struct bt_ctf_field
*field
= bt_ctf_field_structure_get_field(
1573 stream
->packet_context
, "content_size");
1577 if (stream
->pos
.offset
!= stream
->pos
.packet_size
) {
1578 BT_LOGW("Stream's packet context's `content_size` field is missing, "
1579 "but current packet's content size is not equal to its packet size: "
1580 "content-size=%" PRId64
", "
1581 "packet-size=%" PRIu64
,
1583 stream
->pos
.packet_size
);
1590 * Overwrite the packet context now that the stream
1591 * position's packet and content sizes have the correct
1594 * Copy base_mma as the packet may have been remapped
1595 * (e.g. when a packet is resized).
1597 packet_context_pos
.base_mma
= stream
->pos
.base_mma
;
1598 ret
= auto_populate_packet_context(stream
);
1600 BT_LOGW_STR("Cannot automatically populate the stream's packet context field.");
1605 BT_LOGV("Rewriting (serializing) packet context field.");
1606 ret
= bt_ctf_field_serialize(stream
->packet_context
,
1607 &packet_context_pos
, native_byte_order
);
1609 BT_LOGW("Cannot serialize stream's packet context field: "
1610 "field-addr=%p", stream
->packet_context
);
1615 g_ptr_array_set_size(stream
->events
, 0);
1616 stream
->flushed_packet_count
++;
1617 stream
->size
+= stream
->pos
.packet_size
/ CHAR_BIT
;
1619 /* Reset automatically-set fields. */
1620 reset_structure_field(stream
->packet_context
, "timestamp_begin");
1621 reset_structure_field(stream
->packet_context
, "timestamp_end");
1622 reset_structure_field(stream
->packet_context
, "packet_size");
1623 reset_structure_field(stream
->packet_context
, "content_size");
1627 * We failed to write the packet. Its size is therefore set to 0
1628 * to ensure the next mapping is done in the same place rather
1629 * than advancing by "stream->pos.packet_size", which would
1630 * leave a corrupted packet in the trace.
1632 stream
->pos
.packet_size
= 0;
1634 BT_LOGV("Flushed stream's current packet: content-size=%" PRId64
", "
1635 "packet-size=%" PRIu64
,
1636 stream
->pos
.offset
, stream
->pos
.packet_size
);
1641 /* Pre-2.0 CTF writer backward compatibility */
1642 void bt_ctf_stream_get(struct bt_ctf_stream
*stream
)
1647 /* Pre-2.0 CTF writer backward compatibility */
1648 void bt_ctf_stream_put(struct bt_ctf_stream
*stream
)
1654 void bt_ctf_stream_destroy(struct bt_object
*obj
)
1656 struct bt_ctf_stream
*stream
;
1659 stream
= container_of(obj
, struct bt_ctf_stream
, base
);
1660 BT_LOGD("Destroying stream object: addr=%p, name=\"%s\"",
1661 stream
, bt_ctf_stream_get_name(stream
));
1663 /* Call destroy listeners in reverse registration order */
1664 for (i
= stream
->destroy_listeners
->len
- 1; i
>= 0; i
--) {
1665 struct bt_ctf_stream_destroy_listener
*listener
=
1666 &g_array_index(stream
->destroy_listeners
,
1667 struct bt_ctf_stream_destroy_listener
, i
);
1669 BT_LOGD("Calling destroy listener: func=%p, data=%p, index=%d",
1670 listener
->func
, listener
->data
, i
);
1671 listener
->func(stream
, listener
->data
);
1674 (void) bt_ctf_stream_pos_fini(&stream
->pos
);
1675 if (stream
->pos
.fd
>= 0) {
1679 * Truncate the file's size to the minimum required to fit the
1680 * last packet as we might have grown it too much on the last
1684 ret
= ftruncate(stream
->pos
.fd
, stream
->size
);
1685 } while (ret
== -1 && errno
== EINTR
);
1687 BT_LOGE("Failed to truncate stream file: %s: "
1688 "ret=%d, errno=%d, size=%" PRIu64
,
1689 strerror(errno
), ret
, errno
,
1690 (uint64_t) stream
->size
);
1693 if (close(stream
->pos
.fd
)) {
1694 BT_LOGE("Failed to close stream file: %s: "
1695 "ret=%d, errno=%d", strerror(errno
),
1700 if (stream
->events
) {
1701 BT_LOGD_STR("Putting events.");
1702 g_ptr_array_free(stream
->events
, TRUE
);
1706 g_string_free(stream
->name
, TRUE
);
1709 if (stream
->comp_cur_port
) {
1710 GHashTableIter ht_iter
;
1711 gpointer comp_gptr
, port_gptr
;
1714 * Since we're destroying the stream, remove the destroy
1715 * listeners that it registered for each component in
1716 * its component-port mapping hash table. Otherwise they
1717 * would be called and the stream would be accessed once
1718 * it's freed or another stream would be accessed.
1720 g_hash_table_iter_init(&ht_iter
, stream
->comp_cur_port
);
1722 while (g_hash_table_iter_next(&ht_iter
, &comp_gptr
, &port_gptr
)) {
1724 bt_component_remove_destroy_listener((void *) comp_gptr
,
1725 component_destroy_listener
, stream
);
1728 g_hash_table_destroy(stream
->comp_cur_port
);
1731 if (stream
->destroy_listeners
) {
1732 g_array_free(stream
->destroy_listeners
, TRUE
);
1735 BT_LOGD_STR("Putting packet header field.");
1736 bt_put(stream
->packet_header
);
1737 BT_LOGD_STR("Putting packet context field.");
1738 bt_put(stream
->packet_context
);
1743 int _set_structure_field_integer(struct bt_ctf_field
*structure
, char *name
,
1744 uint64_t value
, bt_bool force
)
1747 struct bt_ctf_field_type
*field_type
= NULL
;
1748 struct bt_ctf_field
*integer
;
1753 integer
= bt_ctf_field_structure_get_field(structure
, name
);
1755 /* Field not found, not an error. */
1756 BT_LOGV("Field not found: struct-field-addr=%p, "
1757 "name=\"%s\", force=%d", structure
, name
, force
);
1761 /* Make sure the payload has not already been set. */
1762 if (!force
&& bt_ctf_field_is_set(integer
)) {
1763 /* Payload already set, not an error */
1764 BT_LOGV("Field's payload is already set: struct-field-addr=%p, "
1765 "name=\"%s\", force=%d", structure
, name
, force
);
1769 field_type
= bt_ctf_field_get_type(integer
);
1771 if (bt_ctf_field_type_get_type_id(field_type
) != BT_CTF_FIELD_TYPE_ID_INTEGER
) {
1773 * The user most likely meant for us to populate this field
1774 * automatically. However, we can only do this if the field
1775 * is an integer. Return an error.
1777 BT_LOGW("Invalid parameter: field's type is not an integer field type: "
1778 "field-addr=%p, ft-addr=%p, ft-id=%s",
1779 integer
, field_type
,
1780 bt_ctf_field_type_id_string(field_type
->id
));
1785 if (bt_ctf_field_type_integer_get_signed(field_type
)) {
1786 ret
= bt_ctf_field_signed_integer_set_value(integer
,
1789 ret
= bt_ctf_field_unsigned_integer_set_value(integer
, value
);
1791 ret
= !ret
? 1 : ret
;
1799 * Returns the following codes:
1800 * 1 if the field was found and set,
1801 * 0 if nothing was done (field not found, or was already set),
1802 * <0 if an error was encoutered
1805 int try_set_structure_field_integer(struct bt_ctf_field
*structure
, char *name
,
1808 return _set_structure_field_integer(structure
, name
, value
, BT_FALSE
);
1811 const char *bt_ctf_stream_get_name(struct bt_ctf_stream
*stream
)
1813 const char *name
= NULL
;
1816 BT_LOGW_STR("Invalid parameter: stream is NULL.");
1820 name
= stream
->name
? stream
->name
->str
: NULL
;
1826 int bt_ctf_stream_is_writer(struct bt_ctf_stream
*stream
)
1831 BT_LOGW_STR("Invalid parameter: stream is NULL.");
1835 ret
= (stream
->pos
.fd
>= 0);
1842 void bt_ctf_stream_map_component_to_port(struct bt_ctf_stream
*stream
,
1843 struct bt_component
*comp
,
1844 struct bt_port
*port
)
1849 assert(stream
->comp_cur_port
);
1852 * Do not take a reference to the component here because we
1853 * don't want the component to exist as long as this stream
1854 * exists. Instead, keep a weak reference, but add a destroy
1855 * listener so that we remove this hash table entry when we know
1856 * the component is destroyed.
1858 bt_component_add_destroy_listener(comp
, component_destroy_listener
,
1860 g_hash_table_insert(stream
->comp_cur_port
, comp
, port
);
1861 BT_LOGV("Mapped component to port for stream: stream-addr=%p, "
1862 "stream-name=\"%s\", comp-addr=%p, comp-name=\"%s\", "
1863 "port-addr=%p, port-name=\"%s\"",
1864 stream
, bt_ctf_stream_get_name(stream
),
1865 comp
, bt_component_get_name(comp
), port
,
1866 bt_port_get_name(port
));
1870 struct bt_port
*bt_ctf_stream_port_for_component(struct bt_ctf_stream
*stream
,
1871 struct bt_component
*comp
)
1875 assert(stream
->comp_cur_port
);
1876 return g_hash_table_lookup(stream
->comp_cur_port
, comp
);
1880 void bt_ctf_stream_add_destroy_listener(struct bt_ctf_stream
*stream
,
1881 bt_ctf_stream_destroy_listener_func func
, void *data
)
1883 struct bt_ctf_stream_destroy_listener listener
;
1887 listener
.func
= func
;
1888 listener
.data
= data
;
1889 g_array_append_val(stream
->destroy_listeners
, listener
);
1890 BT_LOGV("Added stream destroy listener: stream-addr=%p, "
1891 "stream-name=\"%s\", func=%p, data=%p",
1892 stream
, bt_ctf_stream_get_name(stream
), func
, data
);
1896 void bt_ctf_stream_remove_destroy_listener(struct bt_ctf_stream
*stream
,
1897 bt_ctf_stream_destroy_listener_func func
, void *data
)
1904 for (i
= 0; i
< stream
->destroy_listeners
->len
; i
++) {
1905 struct bt_ctf_stream_destroy_listener
*listener
=
1906 &g_array_index(stream
->destroy_listeners
,
1907 struct bt_ctf_stream_destroy_listener
, i
);
1909 if (listener
->func
== func
&& listener
->data
== data
) {
1910 g_array_remove_index(stream
->destroy_listeners
, i
);
1912 BT_LOGV("Removed stream destroy listener: stream-addr=%p, "
1913 "stream-name=\"%s\", func=%p, data=%p",
1914 stream
, bt_ctf_stream_get_name(stream
),
1920 int64_t bt_ctf_stream_get_id(struct bt_ctf_stream
*stream
)
1925 BT_LOGW_STR("Invalid parameter: stream is NULL.");
1932 BT_LOGV("Stream's ID is not set: addr=%p, name=\"%s\"",
1933 stream
, bt_ctf_stream_get_name(stream
));