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 #include <babeltrace/ctf-ir/clock-class.h>
30 #include <babeltrace/ctf-writer/clock.h>
31 #include <babeltrace/ctf-writer/clock-internal.h>
32 #include <babeltrace/ctf-writer/event.h>
33 #include <babeltrace/ctf-ir/event-internal.h>
34 #include <babeltrace/ctf-ir/field-types-internal.h>
35 #include <babeltrace/ctf-ir/fields-internal.h>
36 #include <babeltrace/ctf-ir/stream.h>
37 #include <babeltrace/ctf-ir/stream-internal.h>
38 #include <babeltrace/ctf-ir/stream-class-internal.h>
39 #include <babeltrace/ctf-ir/trace-internal.h>
40 #include <babeltrace/ctf-writer/writer-internal.h>
41 #include <babeltrace/ref.h>
42 #include <babeltrace/ctf-writer/functor-internal.h>
43 #include <babeltrace/compiler-internal.h>
44 #include <babeltrace/align-internal.h>
48 void bt_ctf_stream_destroy(struct bt_object
*obj
);
50 int try_set_structure_field_integer(struct bt_ctf_field
*, char *, uint64_t);
52 int set_structure_field_integer(struct bt_ctf_field
*, char *, uint64_t);
55 int set_integer_field_value(struct bt_ctf_field
* field
, uint64_t value
)
58 struct bt_ctf_field_type
*field_type
= NULL
;
65 field_type
= bt_ctf_field_get_type(field
);
68 if (bt_ctf_field_type_get_type_id(field_type
) !=
69 BT_CTF_FIELD_TYPE_ID_INTEGER
) {
70 /* Not an integer and the value is unset, error. */
75 if (bt_ctf_field_type_integer_get_signed(field_type
)) {
76 ret
= bt_ctf_field_signed_integer_set_value(field
, (int64_t) value
);
78 /* Value is out of range, error. */
82 ret
= bt_ctf_field_unsigned_integer_set_value(field
, value
);
84 /* Value is out of range, error. */
94 int set_packet_header_magic(struct bt_ctf_stream
*stream
)
97 struct bt_ctf_field_type
*magic_field_type
= NULL
;
98 struct bt_ctf_field
*magic_field
= bt_ctf_field_structure_get_field(
99 stream
->packet_header
, "magic");
102 /* No magic field found. Not an error, skip. */
106 if (bt_ctf_field_is_set(magic_field
)) {
107 /* Value already set. Not an error, skip. */
111 magic_field_type
= bt_ctf_field_get_type(magic_field
);
112 assert(magic_field_type
);
114 if (bt_ctf_field_type_get_type_id(magic_field_type
) !=
115 BT_CTF_FIELD_TYPE_ID_INTEGER
) {
116 /* Magic field is not an integer. Not an error, skip. */
120 if (bt_ctf_field_type_integer_get_size(magic_field_type
) != 32) {
122 * Magic field is not of the expected size.
123 * Not an error, skip.
128 ret
= bt_ctf_field_type_integer_get_signed(magic_field_type
);
131 ret
= bt_ctf_field_signed_integer_set_value(magic_field
,
132 (int64_t) 0xC1FC1FC1);
134 ret
= bt_ctf_field_unsigned_integer_set_value(magic_field
,
135 (uint64_t) 0xC1FC1FC1);
139 bt_put(magic_field_type
);
144 int set_packet_header_uuid(struct bt_ctf_stream
*stream
)
147 struct bt_ctf_trace
*trace
= NULL
;
148 struct bt_ctf_field_type
*uuid_field_type
= NULL
;
149 struct bt_ctf_field_type
*element_field_type
= NULL
;
150 struct bt_ctf_field
*uuid_field
= bt_ctf_field_structure_get_field(
151 stream
->packet_header
, "uuid");
154 /* No uuid field found. Not an error, skip. */
158 if (bt_ctf_field_is_set(uuid_field
)) {
159 /* Value already set. Not an error, skip. */
163 uuid_field_type
= bt_ctf_field_get_type(uuid_field
);
164 assert(uuid_field_type
);
165 if (bt_ctf_field_type_get_type_id(uuid_field_type
) !=
166 BT_CTF_FIELD_TYPE_ID_ARRAY
) {
167 /* UUID field is not an array. Not an error, skip. */
171 if (bt_ctf_field_type_array_get_length(uuid_field_type
) != 16) {
173 * UUID field is not of the expected size.
174 * Not an error, skip.
179 element_field_type
= bt_ctf_field_type_array_get_element_type(
181 assert(element_field_type
);
182 if (bt_ctf_field_type_get_type_id(element_field_type
) !=
183 BT_CTF_FIELD_TYPE_ID_INTEGER
) {
184 /* UUID array elements are not integers. Not an error, skip */
188 trace
= (struct bt_ctf_trace
*) bt_object_get_parent(stream
);
189 for (i
= 0; i
< 16; i
++) {
190 struct bt_ctf_field
*uuid_element
=
191 bt_ctf_field_array_get_field(uuid_field
, i
);
193 ret
= bt_ctf_field_type_integer_get_signed(element_field_type
);
197 ret
= bt_ctf_field_signed_integer_set_value(
198 uuid_element
, (int64_t) trace
->uuid
[i
]);
200 ret
= bt_ctf_field_unsigned_integer_set_value(
202 (uint64_t) trace
->uuid
[i
]);
204 bt_put(uuid_element
);
212 bt_put(uuid_field_type
);
213 bt_put(element_field_type
);
218 int set_packet_header_stream_id(struct bt_ctf_stream
*stream
)
222 struct bt_ctf_field_type
*stream_id_field_type
= NULL
;
223 struct bt_ctf_field
*stream_id_field
= bt_ctf_field_structure_get_field(
224 stream
->packet_header
, "stream_id");
226 if (!stream_id_field
) {
227 /* No stream_id field found. Not an error, skip. */
231 if (bt_ctf_field_is_set(stream_id_field
)) {
232 /* Value already set. Not an error, skip. */
236 stream_id_field_type
= bt_ctf_field_get_type(stream_id_field
);
237 assert(stream_id_field_type
);
238 if (bt_ctf_field_type_get_type_id(stream_id_field_type
) !=
239 BT_CTF_FIELD_TYPE_ID_INTEGER
) {
240 /* stream_id field is not an integer. Not an error, skip. */
244 stream_id
= stream
->stream_class
->id
;
245 ret
= bt_ctf_field_type_integer_get_signed(stream_id_field_type
);
248 ret
= bt_ctf_field_signed_integer_set_value(stream_id_field
,
249 (int64_t) stream_id
);
251 ret
= bt_ctf_field_unsigned_integer_set_value(stream_id_field
,
252 (uint64_t) stream_id
);
255 bt_put(stream_id_field
);
256 bt_put(stream_id_field_type
);
261 int set_packet_header(struct bt_ctf_stream
*stream
)
265 ret
= set_packet_header_magic(stream
);
270 ret
= set_packet_header_uuid(stream
);
275 ret
= set_packet_header_stream_id(stream
);
284 void release_event(struct bt_ctf_event
*event
)
286 if (bt_object_get_ref_count(event
)) {
288 * The event is being orphaned, but it must guarantee the
289 * existence of its event class for the duration of its
292 bt_get(event
->event_class
);
293 BT_PUT(event
->base
.parent
);
295 bt_object_release(event
);
300 int create_stream_file(struct bt_ctf_writer
*writer
,
301 struct bt_ctf_stream
*stream
)
304 GString
*filename
= g_string_new(stream
->stream_class
->name
->str
);
306 if (stream
->stream_class
->name
->len
== 0) {
309 ret
= bt_ctf_stream_class_get_id(stream
->stream_class
);
315 g_string_printf(filename
, "stream_%" PRId64
, ret
);
318 g_string_append_printf(filename
, "_%" PRIu32
, stream
->id
);
319 fd
= openat(writer
->trace_dir_fd
, filename
->str
,
320 O_RDWR
| O_CREAT
| O_TRUNC
,
321 S_IRUSR
| S_IWUSR
| S_IRGRP
| S_IWGRP
);
323 g_string_free(filename
, TRUE
);
328 int set_stream_fd(struct bt_ctf_stream
*stream
, int fd
)
332 if (stream
->pos
.fd
!= -1) {
337 (void) bt_ctf_stream_pos_init(&stream
->pos
, fd
, O_RDWR
);
343 struct bt_ctf_stream
*bt_ctf_stream_create(
344 struct bt_ctf_stream_class
*stream_class
,
348 struct bt_ctf_stream
*stream
= NULL
;
349 struct bt_ctf_trace
*trace
= NULL
;
350 struct bt_ctf_writer
*writer
= NULL
;
356 trace
= bt_ctf_stream_class_get_trace(stream_class
);
361 stream
= g_new0(struct bt_ctf_stream
, 1);
366 bt_object_init(stream
, bt_ctf_stream_destroy
);
368 * Acquire reference to parent since stream will become publicly
369 * reachable; it needs its parent to remain valid.
371 bt_object_set_parent(stream
, trace
);
372 stream
->id
= stream_class
->next_stream_id
++;
373 stream
->stream_class
= stream_class
;
377 stream
->name
= g_string_new(name
);
383 if (trace
->is_created_by_writer
) {
385 writer
= (struct bt_ctf_writer
*)
386 bt_object_get_parent(trace
);
389 if (stream_class
->packet_context_type
) {
390 stream
->packet_context
= bt_ctf_field_create(
391 stream_class
->packet_context_type
);
392 if (!stream
->packet_context
) {
396 /* Initialize events_discarded */
397 ret
= try_set_structure_field_integer(
398 stream
->packet_context
,
399 "events_discarded", 0);
405 stream
->events
= g_ptr_array_new_with_free_func(
406 (GDestroyNotify
) release_event
);
407 if (!stream
->events
) {
411 /* A trace is not allowed to have a NULL packet header */
412 assert(trace
->packet_header_type
);
413 stream
->packet_header
=
414 bt_ctf_field_create(trace
->packet_header_type
);
415 if (!stream
->packet_header
) {
420 * Attempt to populate the default trace packet header fields
421 * (magic, uuid and stream_id). This will _not_ fail shall the
422 * fields not be found or be of an incompatible type; they will
423 * simply not be populated automatically. The user will have to
424 * make sure to set the trace packet header fields himself
427 ret
= set_packet_header(stream
);
432 /* Create file associated with this stream */
433 fd
= create_stream_file(writer
, stream
);
438 ret
= set_stream_fd(stream
, fd
);
443 /* Freeze the writer */
444 bt_ctf_writer_freeze(writer
);
446 /* Non-writer stream indicated by a negative FD */
447 ret
= set_stream_fd(stream
, -1);
453 /* Add this stream to the trace's streams */
454 g_ptr_array_add(trace
->streams
, stream
);
466 struct bt_ctf_stream_class
*bt_ctf_stream_get_class(
467 struct bt_ctf_stream
*stream
)
469 struct bt_ctf_stream_class
*stream_class
= NULL
;
475 stream_class
= stream
->stream_class
;
476 bt_get(stream_class
);
481 int bt_ctf_stream_get_discarded_events_count(
482 struct bt_ctf_stream
*stream
, uint64_t *count
)
486 struct bt_ctf_field
*events_discarded_field
= NULL
;
487 struct bt_ctf_field_type
*events_discarded_field_type
= NULL
;
489 if (!stream
|| !count
|| !stream
->packet_context
||
490 stream
->pos
.fd
< 0) {
495 events_discarded_field
= bt_ctf_field_structure_get_field(
496 stream
->packet_context
, "events_discarded");
497 if (!events_discarded_field
) {
502 events_discarded_field_type
= bt_ctf_field_get_type(
503 events_discarded_field
);
504 if (!events_discarded_field_type
) {
509 field_signed
= bt_ctf_field_type_integer_get_signed(
510 events_discarded_field_type
);
511 if (field_signed
< 0) {
517 int64_t signed_count
;
519 ret
= bt_ctf_field_signed_integer_get_value(
520 events_discarded_field
, &signed_count
);
524 if (signed_count
< 0) {
529 *count
= (uint64_t) signed_count
;
531 ret
= bt_ctf_field_unsigned_integer_get_value(
532 events_discarded_field
, count
);
538 bt_put(events_discarded_field
);
539 bt_put(events_discarded_field_type
);
543 void bt_ctf_stream_append_discarded_events(struct bt_ctf_stream
*stream
,
544 uint64_t event_count
)
548 uint64_t previous_count
;
550 struct bt_ctf_field
*events_discarded_field
= NULL
;
551 struct bt_ctf_field_type
*events_discarded_field_type
= NULL
;
553 if (!stream
|| !stream
->packet_context
|| stream
->pos
.fd
< 0) {
557 ret
= bt_ctf_stream_get_discarded_events_count(stream
,
563 events_discarded_field
= bt_ctf_field_structure_get_field(
564 stream
->packet_context
, "events_discarded");
565 if (!events_discarded_field
) {
569 events_discarded_field_type
= bt_ctf_field_get_type(
570 events_discarded_field
);
571 if (!events_discarded_field_type
) {
575 field_signed
= bt_ctf_field_type_integer_get_signed(
576 events_discarded_field_type
);
577 if (field_signed
< 0) {
581 new_count
= previous_count
+ event_count
;
583 ret
= bt_ctf_field_signed_integer_set_value(
584 events_discarded_field
, (int64_t) new_count
);
589 ret
= bt_ctf_field_unsigned_integer_set_value(
590 events_discarded_field
, new_count
);
597 bt_put(events_discarded_field
);
598 bt_put(events_discarded_field_type
);
601 static int auto_populate_event_header(struct bt_ctf_stream
*stream
,
602 struct bt_ctf_event
*event
)
605 struct bt_ctf_field
*id_field
= NULL
, *timestamp_field
= NULL
;
606 struct bt_ctf_clock_class
*mapped_clock_class
= NULL
;
608 if (!event
|| event
->frozen
) {
614 * The condition to automatically set the ID are:
616 * 1. The event header field "id" exists and is an integer
618 * 2. The event header field "id" is NOT set.
620 id_field
= bt_ctf_field_structure_get_field(event
->event_header
, "id");
621 if (id_field
&& !bt_ctf_field_is_set(id_field
)) {
622 ret
= set_integer_field_value(id_field
,
623 (uint64_t) bt_ctf_event_class_get_id(
624 event
->event_class
));
631 * The conditions to automatically set the timestamp are:
633 * 1. The event header field "timestamp" exists and is an
635 * 2. This stream's class has a registered clock (set with
636 * bt_ctf_stream_class_set_clock()).
637 * 3. The event header field "timestamp" has its type mapped to
638 * a clock class which is also the clock class of this
639 * stream's class's registered clock.
640 * 4. The event header field "timestamp" is NOT set.
642 timestamp_field
= bt_ctf_field_structure_get_field(event
->event_header
,
644 if (timestamp_field
&& !bt_ctf_field_is_set(timestamp_field
) &&
645 stream
->stream_class
->clock
) {
646 struct bt_ctf_clock_class
*stream_class_clock_class
=
647 stream
->stream_class
->clock
->clock_class
;
648 struct bt_ctf_field_type
*timestamp_field_type
=
649 bt_ctf_field_get_type(timestamp_field
);
651 assert(timestamp_field_type
);
653 bt_ctf_field_type_integer_get_mapped_clock_class(
654 timestamp_field_type
);
655 BT_PUT(timestamp_field_type
);
656 if (mapped_clock_class
== stream_class_clock_class
) {
659 ret
= bt_ctf_clock_get_value(
660 stream
->stream_class
->clock
,
666 ret
= set_integer_field_value(timestamp_field
,
676 bt_put(timestamp_field
);
677 bt_put(mapped_clock_class
);
681 int bt_ctf_stream_append_event(struct bt_ctf_stream
*stream
,
682 struct bt_ctf_event
*event
)
686 if (!stream
|| !event
|| stream
->pos
.fd
< 0) {
692 * The event is not supposed to have a parent stream at this
693 * point. The only other way an event can have a parent stream
694 * is if it was assigned when setting a packet to the event,
695 * in which case the packet's stream is not a writer stream,
696 * and thus the user is trying to append an event which belongs
699 if (event
->base
.parent
) {
704 bt_object_set_parent(event
, stream
);
705 ret
= auto_populate_event_header(stream
, event
);
710 /* Make sure the various scopes of the event are set */
711 ret
= bt_ctf_event_validate(event
);
716 /* Save the new event and freeze it */
717 bt_ctf_event_freeze(event
);
718 g_ptr_array_add(stream
->events
, event
);
721 * Event had to hold a reference to its event class as long as it wasn't
722 * part of the same trace hierarchy. From now on, the event and its
723 * class share the same lifetime guarantees and the reference is no
726 bt_put(event
->event_class
);
733 * Orphan the event; we were not successful in associating it to
736 bt_object_set_parent(event
, NULL
);
741 struct bt_ctf_field
*bt_ctf_stream_get_packet_context(
742 struct bt_ctf_stream
*stream
)
744 struct bt_ctf_field
*packet_context
= NULL
;
746 if (!stream
|| stream
->pos
.fd
< 0) {
750 packet_context
= stream
->packet_context
;
751 if (packet_context
) {
752 bt_get(packet_context
);
755 return packet_context
;
758 int bt_ctf_stream_set_packet_context(struct bt_ctf_stream
*stream
,
759 struct bt_ctf_field
*field
)
762 struct bt_ctf_field_type
*field_type
;
764 if (!stream
|| stream
->pos
.fd
< 0) {
769 field_type
= bt_ctf_field_get_type(field
);
770 if (bt_ctf_field_type_compare(field_type
,
771 stream
->stream_class
->packet_context_type
)) {
777 bt_put(stream
->packet_context
);
778 stream
->packet_context
= bt_get(field
);
783 struct bt_ctf_field
*bt_ctf_stream_get_packet_header(
784 struct bt_ctf_stream
*stream
)
786 struct bt_ctf_field
*packet_header
= NULL
;
788 if (!stream
|| stream
->pos
.fd
< 0) {
792 packet_header
= stream
->packet_header
;
794 bt_get(packet_header
);
797 return packet_header
;
800 int bt_ctf_stream_set_packet_header(struct bt_ctf_stream
*stream
,
801 struct bt_ctf_field
*field
)
804 struct bt_ctf_trace
*trace
= NULL
;
805 struct bt_ctf_field_type
*field_type
= NULL
;
807 if (!stream
|| stream
->pos
.fd
< 0) {
812 trace
= (struct bt_ctf_trace
*) bt_object_get_parent(stream
);
813 field_type
= bt_ctf_field_get_type(field
);
814 if (bt_ctf_field_type_compare(field_type
, trace
->packet_header_type
)) {
819 bt_put(stream
->packet_header
);
820 stream
->packet_header
= bt_get(field
);
828 int get_event_header_timestamp(struct bt_ctf_field
*event_header
, uint64_t *timestamp
)
831 struct bt_ctf_field
*timestamp_field
= NULL
;
832 struct bt_ctf_field_type
*timestamp_field_type
= NULL
;
834 timestamp_field
= bt_ctf_field_structure_get_field(event_header
,
836 if (!timestamp_field
) {
841 timestamp_field_type
= bt_ctf_field_get_type(timestamp_field
);
842 assert(timestamp_field_type
);
843 if (bt_ctf_field_type_get_type_id(timestamp_field_type
) !=
844 BT_CTF_FIELD_TYPE_ID_INTEGER
) {
849 if (bt_ctf_field_type_integer_get_signed(timestamp_field_type
)) {
852 ret
= bt_ctf_field_signed_integer_get_value(timestamp_field
,
857 *timestamp
= (uint64_t) val
;
859 ret
= bt_ctf_field_unsigned_integer_get_value(timestamp_field
,
866 bt_put(timestamp_field
);
867 bt_put(timestamp_field_type
);
872 void reset_structure_field(struct bt_ctf_field
*structure
, const char *name
)
874 struct bt_ctf_field
*member
;
876 member
= bt_ctf_field_structure_get_field(structure
, name
);
878 (void) bt_ctf_field_reset(member
);
882 int bt_ctf_stream_flush(struct bt_ctf_stream
*stream
)
886 uint64_t timestamp_begin
, timestamp_end
;
887 struct bt_ctf_field
*integer
= NULL
;
888 struct bt_ctf_stream_pos packet_context_pos
;
889 struct bt_ctf_trace
*trace
;
890 enum bt_ctf_byte_order native_byte_order
;
892 uint64_t packet_size_bits
;
894 bool timestamp_begin
;
898 } auto_set_fields
= { 0 };
900 if (!stream
|| stream
->pos
.fd
< 0) {
902 * Stream does not have an associated fd. It is,
903 * therefore, not a stream being used to write events.
909 if (!stream
->packet_context
&& stream
->flushed_packet_count
> 0) {
911 * A stream without a packet context, and thus without
912 * content and packet size members, can't have more than
919 trace
= bt_ctf_stream_class_borrow_trace(stream
->stream_class
);
921 native_byte_order
= bt_ctf_trace_get_byte_order(trace
);
922 empty_packet
= (stream
->events
->len
== 0);
924 /* mmap the next packet */
925 bt_ctf_stream_pos_packet_seek(&stream
->pos
, 0, SEEK_CUR
);
926 ret
= bt_ctf_field_serialize(stream
->packet_header
, &stream
->pos
,
932 if (stream
->packet_context
) {
933 /* Set the default context attributes if present and unset. */
934 if (!empty_packet
&& !get_event_header_timestamp(
935 ((struct bt_ctf_event
*) g_ptr_array_index(
936 stream
->events
, 0))->event_header
, ×tamp_begin
)) {
937 ret
= try_set_structure_field_integer(
938 stream
->packet_context
,
939 "timestamp_begin", timestamp_begin
);
943 auto_set_fields
.timestamp_begin
= ret
== 1;
946 if (!empty_packet
&& !get_event_header_timestamp(
947 ((struct bt_ctf_event
*) g_ptr_array_index(
948 stream
->events
, stream
->events
->len
- 1))->event_header
,
951 ret
= try_set_structure_field_integer(
952 stream
->packet_context
,
953 "timestamp_end", timestamp_end
);
957 auto_set_fields
.timestamp_end
= ret
== 1;
959 ret
= try_set_structure_field_integer(stream
->packet_context
,
960 "content_size", UINT64_MAX
);
964 auto_set_fields
.content_size
= ret
== 1;
966 ret
= try_set_structure_field_integer(stream
->packet_context
,
967 "packet_size", UINT64_MAX
);
971 auto_set_fields
.packet_size
= ret
== 1;
973 /* Write packet context */
974 memcpy(&packet_context_pos
, &stream
->pos
,
975 sizeof(packet_context_pos
));
976 ret
= bt_ctf_field_serialize(stream
->packet_context
,
977 &stream
->pos
, native_byte_order
);
983 for (i
= 0; i
< stream
->events
->len
; i
++) {
984 struct bt_ctf_event
*event
= g_ptr_array_index(
987 /* Write event header */
988 ret
= bt_ctf_field_serialize(event
->event_header
,
989 &stream
->pos
, native_byte_order
);
994 /* Write stream event context */
995 if (event
->stream_event_context
) {
996 ret
= bt_ctf_field_serialize(
997 event
->stream_event_context
, &stream
->pos
,
1004 /* Write event content */
1005 ret
= bt_ctf_event_serialize(event
, &stream
->pos
,
1012 /* Rounded-up in case content_size is not byte-aligned. */
1013 packet_size_bits
= (stream
->pos
.offset
+ (CHAR_BIT
- 1)) &
1015 stream
->pos
.packet_size
= packet_size_bits
;
1017 if (stream
->packet_context
) {
1019 * Update the packet total size and content size and overwrite
1020 * the packet context.
1021 * Copy base_mma as the packet may have been remapped (e.g. when
1022 * a packet is resized).
1024 packet_context_pos
.base_mma
= stream
->pos
.base_mma
;
1025 if (auto_set_fields
.content_size
) {
1026 ret
= set_structure_field_integer(
1027 stream
->packet_context
,
1028 "content_size", stream
->pos
.offset
);
1034 if (auto_set_fields
.packet_size
) {
1035 ret
= set_structure_field_integer(stream
->packet_context
,
1036 "packet_size", packet_size_bits
);
1042 ret
= bt_ctf_field_serialize(stream
->packet_context
,
1043 &packet_context_pos
, native_byte_order
);
1049 g_ptr_array_set_size(stream
->events
, 0);
1050 stream
->flushed_packet_count
++;
1051 stream
->size
+= packet_size_bits
/ CHAR_BIT
;
1053 /* Reset automatically-set fields. */
1054 if (auto_set_fields
.timestamp_begin
) {
1055 reset_structure_field(stream
->packet_context
,
1058 if (auto_set_fields
.timestamp_end
) {
1059 reset_structure_field(stream
->packet_context
,
1062 if (auto_set_fields
.packet_size
) {
1063 reset_structure_field(stream
->packet_context
,
1066 if (auto_set_fields
.content_size
) {
1067 reset_structure_field(stream
->packet_context
,
1074 * We failed to write the packet. Its size is therefore set to 0
1075 * to ensure the next mapping is done in the same place rather
1076 * than advancing by "stream->pos.packet_size", which would
1077 * leave a corrupted packet in the trace.
1079 stream
->pos
.packet_size
= 0;
1084 void bt_ctf_stream_get(struct bt_ctf_stream
*stream
)
1089 void bt_ctf_stream_put(struct bt_ctf_stream
*stream
)
1095 void bt_ctf_stream_destroy(struct bt_object
*obj
)
1097 struct bt_ctf_stream
*stream
;
1099 stream
= container_of(obj
, struct bt_ctf_stream
, base
);
1100 (void) bt_ctf_stream_pos_fini(&stream
->pos
);
1101 if (stream
->pos
.fd
>= 0) {
1105 * Truncate the file's size to the minimum required to fit the
1106 * last packet as we might have grown it too much on the last
1110 ret
= ftruncate(stream
->pos
.fd
, stream
->size
);
1111 } while (ret
== -1 && errno
== EINTR
);
1113 perror("ftruncate");
1116 if (close(stream
->pos
.fd
)) {
1121 if (stream
->events
) {
1122 g_ptr_array_free(stream
->events
, TRUE
);
1126 g_string_free(stream
->name
, TRUE
);
1129 bt_put(stream
->packet_header
);
1130 bt_put(stream
->packet_context
);
1135 int _set_structure_field_integer(struct bt_ctf_field
*structure
, char *name
,
1136 uint64_t value
, bool force
)
1139 struct bt_ctf_field_type
*field_type
= NULL
;
1140 struct bt_ctf_field
*integer
=
1141 bt_ctf_field_structure_get_field(structure
, name
);
1143 if (!structure
|| !name
) {
1149 /* Field not found, not an error. */
1153 /* Make sure the payload has not already been set. */
1154 if (!force
&& bt_ctf_field_is_set(integer
)) {
1155 /* Payload already set, not an error */
1159 field_type
= bt_ctf_field_get_type(integer
);
1161 if (bt_ctf_field_type_get_type_id(field_type
) != BT_CTF_FIELD_TYPE_ID_INTEGER
) {
1163 * The user most likely meant for us to populate this field
1164 * automatically. However, we can only do this if the field
1165 * is an integer. Return an error.
1171 if (bt_ctf_field_type_integer_get_signed(field_type
)) {
1172 ret
= bt_ctf_field_signed_integer_set_value(integer
,
1175 ret
= bt_ctf_field_unsigned_integer_set_value(integer
, value
);
1177 ret
= !ret
? 1 : ret
;
1185 int set_structure_field_integer(struct bt_ctf_field
*structure
, char *name
,
1188 return _set_structure_field_integer(structure
, name
, value
, true);
1192 * Returns the following codes:
1193 * 1 if the field was found and set,
1194 * 0 if nothing was done (field not found, or was already set),
1195 * <0 if an error was encoutered
1198 int try_set_structure_field_integer(struct bt_ctf_field
*structure
, char *name
,
1201 return _set_structure_field_integer(structure
, name
, value
, false);
1204 const char *bt_ctf_stream_get_name(struct bt_ctf_stream
*stream
)
1206 const char *name
= NULL
;
1212 name
= stream
->name
? stream
->name
->str
: NULL
;
1218 int bt_ctf_stream_is_writer(struct bt_ctf_stream
*stream
)
1226 ret
= (stream
->pos
.fd
>= 0);