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.h>
30 #include <babeltrace/ctf-ir/clock-internal.h>
31 #include <babeltrace/ctf-writer/event.h>
32 #include <babeltrace/ctf-ir/event-internal.h>
33 #include <babeltrace/ctf-ir/event-types-internal.h>
34 #include <babeltrace/ctf-ir/event-fields-internal.h>
35 #include <babeltrace/ctf-ir/stream.h>
36 #include <babeltrace/ctf-ir/stream-internal.h>
37 #include <babeltrace/ctf-ir/stream-class-internal.h>
38 #include <babeltrace/ref.h>
39 #include <babeltrace/ctf-writer/functor-internal.h>
40 #include <babeltrace/compiler.h>
41 #include <babeltrace/align.h>
42 #include <babeltrace/ctf/ctf-index.h>
45 void bt_ctf_stream_destroy(struct bt_object
*obj
);
47 int set_structure_field_integer(struct bt_ctf_field
*, char *, uint64_t);
50 int set_packet_header_magic(struct bt_ctf_stream
*stream
)
53 struct bt_ctf_field_type
*magic_field_type
= NULL
;
54 struct bt_ctf_field
*magic_field
= bt_ctf_field_structure_get_field(
55 stream
->packet_header
, "magic");
58 /* No magic field found. Not an error, skip. */
62 if (!bt_ctf_field_validate(magic_field
)) {
63 /* Value already set. Not an error, skip. */
67 magic_field_type
= bt_ctf_field_get_type(magic_field
);
68 assert(magic_field_type
);
70 if (bt_ctf_field_type_get_type_id(magic_field_type
) !=
72 /* Magic field is not an integer. Not an error, skip. */
76 if (bt_ctf_field_type_integer_get_size(magic_field_type
) != 32) {
78 * Magic field is not of the expected size.
84 ret
= bt_ctf_field_type_integer_get_signed(magic_field_type
);
87 ret
= bt_ctf_field_signed_integer_set_value(magic_field
,
88 (int64_t) 0xC1FC1FC1);
90 ret
= bt_ctf_field_unsigned_integer_set_value(magic_field
,
91 (uint64_t) 0xC1FC1FC1);
95 bt_put(magic_field_type
);
100 int set_packet_header_uuid(struct bt_ctf_stream
*stream
)
103 struct bt_ctf_field_type
*uuid_field_type
= NULL
;
104 struct bt_ctf_field_type
*element_field_type
= NULL
;
105 struct bt_ctf_field
*uuid_field
= bt_ctf_field_structure_get_field(
106 stream
->packet_header
, "uuid");
109 /* No uuid field found. Not an error, skip. */
113 if (!bt_ctf_field_validate(uuid_field
)) {
114 /* Value already set. Not an error, skip. */
118 uuid_field_type
= bt_ctf_field_get_type(uuid_field
);
119 assert(uuid_field_type
);
120 if (bt_ctf_field_type_get_type_id(uuid_field_type
) !=
122 /* UUID field is not an array. Not an error, skip. */
126 if (bt_ctf_field_type_array_get_length(uuid_field_type
) != 16) {
128 * UUID field is not of the expected size.
129 * Not an error, skip.
134 element_field_type
= bt_ctf_field_type_array_get_element_type(
136 assert(element_field_type
);
137 if (bt_ctf_field_type_get_type_id(element_field_type
) !=
139 /* UUID array elements are not integers. Not an error, skip */
143 for (i
= 0; i
< 16; i
++) {
144 struct bt_ctf_field
*uuid_element
=
145 bt_ctf_field_array_get_field(uuid_field
, i
);
147 ret
= bt_ctf_field_type_integer_get_signed(element_field_type
);
151 ret
= bt_ctf_field_signed_integer_set_value(
152 uuid_element
, (int64_t) stream
->trace
->uuid
[i
]);
154 ret
= bt_ctf_field_unsigned_integer_set_value(
156 (uint64_t) stream
->trace
->uuid
[i
]);
158 bt_put(uuid_element
);
166 bt_put(uuid_field_type
);
167 bt_put(element_field_type
);
171 int set_packet_header_stream_id(struct bt_ctf_stream
*stream
)
175 struct bt_ctf_field_type
*stream_id_field_type
= NULL
;
176 struct bt_ctf_field
*stream_id_field
= bt_ctf_field_structure_get_field(
177 stream
->packet_header
, "stream_id");
179 if (!stream_id_field
) {
180 /* No stream_id field found. Not an error, skip. */
184 if (!bt_ctf_field_validate(stream_id_field
)) {
185 /* Value already set. Not an error, skip. */
189 stream_id_field_type
= bt_ctf_field_get_type(stream_id_field
);
190 assert(stream_id_field_type
);
191 if (bt_ctf_field_type_get_type_id(stream_id_field_type
) !=
193 /* stream_id field is not an integer. Not an error, skip. */
197 stream_id
= stream
->stream_class
->id
;
198 ret
= bt_ctf_field_type_integer_get_signed(stream_id_field_type
);
201 ret
= bt_ctf_field_signed_integer_set_value(stream_id_field
,
202 (int64_t) stream_id
);
204 ret
= bt_ctf_field_unsigned_integer_set_value(stream_id_field
,
205 (uint64_t) stream_id
);
208 bt_put(stream_id_field
);
209 bt_put(stream_id_field_type
);
214 int set_packet_header(struct bt_ctf_stream
*stream
)
218 ret
= set_packet_header_magic(stream
);
223 ret
= set_packet_header_uuid(stream
);
228 ret
= set_packet_header_stream_id(stream
);
237 void put_event(struct bt_ctf_event
*event
)
239 bt_ctf_event_set_stream(event
, NULL
);
244 struct bt_ctf_stream
*bt_ctf_stream_create(
245 struct bt_ctf_stream_class
*stream_class
,
246 struct bt_ctf_trace
*trace
)
249 struct bt_ctf_stream
*stream
= NULL
;
251 if (!stream_class
|| !trace
) {
255 stream
= g_new0(struct bt_ctf_stream
, 1);
260 /* A stream has no ownership of its trace (weak ptr) */
261 stream
->trace
= trace
;
262 bt_object_init(stream
, bt_ctf_stream_destroy
);
263 stream
->packet_context
= bt_ctf_field_create(
264 stream_class
->packet_context_type
);
265 if (!stream
->packet_context
) {
270 * A stream class may not have a stream event context defined
271 * in which case this stream will never have a stream_event_context
272 * member since, after a stream's creation, the parent stream class
273 * is "frozen" (immutable).
275 if (stream_class
->event_context_type
) {
276 stream
->event_context
= bt_ctf_field_create(
277 stream_class
->event_context_type
);
278 if (!stream
->packet_context
) {
283 /* Initialize events_discarded */
284 ret
= set_structure_field_integer(stream
->packet_context
,
285 "events_discarded", 0);
291 stream
->id
= stream_class
->next_stream_id
++;
292 stream
->stream_class
= stream_class
;
293 bt_get(stream_class
);
294 stream
->events
= g_ptr_array_new_with_free_func(
295 (GDestroyNotify
) put_event
);
296 if (!stream
->events
) {
299 if (stream_class
->event_context_type
) {
300 stream
->event_contexts
= g_ptr_array_new_with_free_func(
301 (GDestroyNotify
) bt_put
);
302 if (!stream
->event_contexts
) {
307 /* A trace is not allowed to have a NULL packet header */
308 assert(trace
->packet_header_type
);
309 stream
->packet_header
= bt_ctf_field_create(trace
->packet_header_type
);
310 if (!stream
->packet_header
) {
314 * Attempt to populate the default trace packet header fields
315 * (magic, uuid and stream_id). This will _not_ fail shall the
316 * fields not be found or be of an incompatible type; they will
317 * simply not be populated automatically. The user will have to
318 * make sure to set the trace packet header fields himself before
321 ret
= set_packet_header(stream
);
333 int bt_ctf_stream_set_fd(struct bt_ctf_stream
*stream
, int fd
)
337 if (stream
->pos
.fd
!= -1) {
342 ctf_init_pos(&stream
->pos
, NULL
, fd
, O_RDWR
);
348 struct bt_ctf_stream_class
*bt_ctf_stream_get_class(
349 struct bt_ctf_stream
*stream
)
351 struct bt_ctf_stream_class
*stream_class
= NULL
;
357 stream_class
= stream
->stream_class
;
358 bt_get(stream_class
);
363 int bt_ctf_stream_get_discarded_events_count(
364 struct bt_ctf_stream
*stream
, uint64_t *count
)
368 struct bt_ctf_field
*events_discarded_field
= NULL
;
369 struct bt_ctf_field_type
*events_discarded_field_type
= NULL
;
371 if (!stream
|| !count
|| !stream
->packet_context
) {
376 events_discarded_field
= bt_ctf_field_structure_get_field(
377 stream
->packet_context
, "events_discarded");
378 if (!events_discarded_field
) {
383 events_discarded_field_type
= bt_ctf_field_get_type(
384 events_discarded_field
);
385 if (!events_discarded_field_type
) {
390 field_signed
= bt_ctf_field_type_integer_get_signed(
391 events_discarded_field_type
);
392 if (field_signed
< 0) {
398 int64_t signed_count
;
400 ret
= bt_ctf_field_signed_integer_get_value(
401 events_discarded_field
, &signed_count
);
405 if (signed_count
< 0) {
410 *count
= (uint64_t) signed_count
;
412 ret
= bt_ctf_field_unsigned_integer_get_value(
413 events_discarded_field
, count
);
419 bt_put(events_discarded_field
);
420 bt_put(events_discarded_field_type
);
424 void bt_ctf_stream_append_discarded_events(struct bt_ctf_stream
*stream
,
425 uint64_t event_count
)
429 uint64_t previous_count
;
431 struct bt_ctf_field
*events_discarded_field
= NULL
;
432 struct bt_ctf_field_type
*events_discarded_field_type
= NULL
;
434 if (!stream
|| !stream
->packet_context
) {
438 ret
= bt_ctf_stream_get_discarded_events_count(stream
,
444 events_discarded_field
= bt_ctf_field_structure_get_field(
445 stream
->packet_context
, "events_discarded");
446 if (!events_discarded_field
) {
450 events_discarded_field_type
= bt_ctf_field_get_type(
451 events_discarded_field
);
452 if (!events_discarded_field_type
) {
456 field_signed
= bt_ctf_field_type_integer_get_signed(
457 events_discarded_field_type
);
458 if (field_signed
< 0) {
462 new_count
= previous_count
+ event_count
;
464 ret
= bt_ctf_field_signed_integer_set_value(
465 events_discarded_field
, (int64_t) new_count
);
470 ret
= bt_ctf_field_unsigned_integer_set_value(
471 events_discarded_field
, new_count
);
478 bt_put(events_discarded_field
);
479 bt_put(events_discarded_field_type
);
482 int bt_ctf_stream_append_event(struct bt_ctf_stream
*stream
,
483 struct bt_ctf_event
*event
)
486 struct bt_ctf_field
*event_context_copy
= NULL
;
488 if (!stream
|| !event
) {
493 ret
= bt_ctf_event_set_stream(event
, stream
);
495 /* Event was already associated to a stream */
500 ret
= bt_ctf_event_populate_event_header(event
);
505 /* Make sure the event's payload is set */
506 ret
= bt_ctf_event_validate(event
);
511 /* Sample the current stream event context by copying it */
512 if (stream
->event_context
) {
513 /* Make sure the event context's payload is set */
514 ret
= bt_ctf_field_validate(stream
->event_context
);
519 event_context_copy
= bt_ctf_field_copy(stream
->event_context
);
520 if (!event_context_copy
) {
527 /* Save the new event along with its associated stream event context */
528 g_ptr_array_add(stream
->events
, event
);
529 if (event_context_copy
) {
530 g_ptr_array_add(stream
->event_contexts
, event_context_copy
);
534 (void) bt_ctf_event_set_stream(event
, NULL
);
539 struct bt_ctf_field
*bt_ctf_stream_get_packet_context(
540 struct bt_ctf_stream
*stream
)
542 struct bt_ctf_field
*packet_context
= NULL
;
548 packet_context
= stream
->packet_context
;
549 if (packet_context
) {
550 bt_get(packet_context
);
553 return packet_context
;
556 int bt_ctf_stream_set_packet_context(struct bt_ctf_stream
*stream
,
557 struct bt_ctf_field
*field
)
560 struct bt_ctf_field_type
*field_type
;
562 if (!stream
|| !field
) {
567 field_type
= bt_ctf_field_get_type(field
);
568 if (field_type
!= stream
->stream_class
->packet_context_type
) {
575 bt_put(stream
->packet_context
);
576 stream
->packet_context
= field
;
581 struct bt_ctf_field
*bt_ctf_stream_get_event_context(
582 struct bt_ctf_stream
*stream
)
584 struct bt_ctf_field
*event_context
= NULL
;
590 event_context
= stream
->event_context
;
592 bt_get(event_context
);
595 return event_context
;
598 int bt_ctf_stream_set_event_context(struct bt_ctf_stream
*stream
,
599 struct bt_ctf_field
*field
)
602 struct bt_ctf_field_type
*field_type
= NULL
;
604 if (!stream
|| !field
) {
609 field_type
= bt_ctf_field_get_type(field
);
610 if (field_type
!= stream
->stream_class
->event_context_type
) {
616 bt_put(stream
->event_context
);
617 stream
->event_context
= field
;
623 struct bt_ctf_field
*bt_ctf_stream_get_packet_header(
624 struct bt_ctf_stream
*stream
)
626 struct bt_ctf_field
*packet_header
= NULL
;
632 packet_header
= stream
->packet_header
;
634 bt_get(packet_header
);
637 return packet_header
;
640 int bt_ctf_stream_set_packet_header(struct bt_ctf_stream
*stream
,
641 struct bt_ctf_field
*field
)
644 struct bt_ctf_field_type
*field_type
= NULL
;
646 if (!stream
|| !field
) {
651 field_type
= bt_ctf_field_get_type(field
);
652 if (field_type
!= stream
->trace
->packet_header_type
) {
658 bt_put(stream
->packet_header
);
659 stream
->packet_header
= field
;
666 int get_event_header_timestamp(struct bt_ctf_field
*event_header
, uint64_t *timestamp
)
669 struct bt_ctf_field
*timestamp_field
= NULL
;
670 struct bt_ctf_field_type
*timestamp_field_type
= NULL
;
672 timestamp_field
= bt_ctf_field_structure_get_field(event_header
,
674 if (!timestamp_field
) {
679 timestamp_field_type
= bt_ctf_field_get_type(timestamp_field
);
680 assert(timestamp_field_type
);
681 if (bt_ctf_field_type_get_type_id(timestamp_field_type
) !=
687 if (bt_ctf_field_type_integer_get_signed(timestamp_field_type
)) {
690 ret
= bt_ctf_field_signed_integer_get_value(timestamp_field
,
695 *timestamp
= (uint64_t) val
;
697 ret
= bt_ctf_field_unsigned_integer_get_value(timestamp_field
,
704 bt_put(timestamp_field
);
705 bt_put(timestamp_field_type
);
709 int bt_ctf_stream_flush(struct bt_ctf_stream
*stream
)
713 uint64_t timestamp_begin
, timestamp_end
, events_discarded
;
714 struct bt_ctf_field
*integer
= NULL
;
715 struct ctf_stream_pos packet_context_pos
;
717 if (!stream
|| stream
->pos
.fd
< 0) {
719 * Stream does not have an associated fd. It is,
720 * therefore, not a stream being used to write events.
726 if (!stream
->events
->len
) {
730 ret
= bt_ctf_field_validate(stream
->packet_header
);
735 /* mmap the next packet */
736 ctf_packet_seek(&stream
->pos
.parent
, 0, SEEK_CUR
);
738 ret
= bt_ctf_field_serialize(stream
->packet_header
, &stream
->pos
);
743 /* Set the default context attributes if present and unset. */
744 if (!get_event_header_timestamp(
745 ((struct bt_ctf_event
*) g_ptr_array_index(
746 stream
->events
, 0))->event_header
, ×tamp_begin
)) {
747 ret
= set_structure_field_integer(stream
->packet_context
,
748 "timestamp_begin", timestamp_begin
);
754 if (!get_event_header_timestamp(
755 ((struct bt_ctf_event
*) g_ptr_array_index(
756 stream
->events
, stream
->events
->len
- 1))->event_header
,
759 ret
= set_structure_field_integer(stream
->packet_context
,
760 "timestamp_end", timestamp_end
);
765 ret
= set_structure_field_integer(stream
->packet_context
,
766 "content_size", UINT64_MAX
);
771 ret
= set_structure_field_integer(stream
->packet_context
,
772 "packet_size", UINT64_MAX
);
777 /* Write packet context */
778 memcpy(&packet_context_pos
, &stream
->pos
,
779 sizeof(struct ctf_stream_pos
));
780 ret
= bt_ctf_field_serialize(stream
->packet_context
,
786 ret
= bt_ctf_stream_get_discarded_events_count(stream
,
792 /* Unset the packet context's fields. */
793 ret
= bt_ctf_field_reset(stream
->packet_context
);
798 /* Set the previous number of discarded events. */
799 ret
= set_structure_field_integer(stream
->packet_context
,
800 "events_discarded", events_discarded
);
805 for (i
= 0; i
< stream
->events
->len
; i
++) {
806 struct bt_ctf_event
*event
= g_ptr_array_index(
809 ret
= bt_ctf_field_reset(event
->event_header
);
814 /* Write event header */
815 ret
= bt_ctf_field_serialize(event
->event_header
,
821 /* Write stream event context */
822 if (stream
->event_contexts
) {
823 ret
= bt_ctf_field_serialize(
824 g_ptr_array_index(stream
->event_contexts
, i
),
831 /* Write event content */
832 ret
= bt_ctf_event_serialize(event
, &stream
->pos
);
839 * Update the packet total size and content size and overwrite the
841 * Copy base_mma as the packet may have been remapped (e.g. when a
842 * packet is resized).
844 packet_context_pos
.base_mma
= stream
->pos
.base_mma
;
845 ret
= set_structure_field_integer(stream
->packet_context
,
846 "content_size", stream
->pos
.offset
);
851 ret
= set_structure_field_integer(stream
->packet_context
,
852 "packet_size", stream
->pos
.packet_size
);
857 ret
= bt_ctf_field_serialize(stream
->packet_context
,
858 &packet_context_pos
);
863 g_ptr_array_set_size(stream
->events
, 0);
864 if (stream
->event_contexts
) {
865 g_ptr_array_set_size(stream
->event_contexts
, 0);
867 stream
->flushed_packet_count
++;
873 void bt_ctf_stream_get(struct bt_ctf_stream
*stream
)
878 void bt_ctf_stream_put(struct bt_ctf_stream
*stream
)
884 void bt_ctf_stream_destroy(struct bt_object
*obj
)
886 struct bt_ctf_stream
*stream
;
888 stream
= container_of(obj
, struct bt_ctf_stream
, base
);
889 ctf_fini_pos(&stream
->pos
);
890 if (stream
->pos
.fd
>= 0 && close(stream
->pos
.fd
)) {
894 bt_put(stream
->stream_class
);
895 if (stream
->events
) {
896 g_ptr_array_free(stream
->events
, TRUE
);
898 if (stream
->event_contexts
) {
899 g_ptr_array_free(stream
->event_contexts
, TRUE
);
901 bt_put(stream
->packet_header
);
902 bt_put(stream
->packet_context
);
903 bt_put(stream
->event_context
);
908 int set_structure_field_integer(struct bt_ctf_field
*structure
, char *name
,
912 struct bt_ctf_field_type
*field_type
= NULL
;
913 struct bt_ctf_field
*integer
=
914 bt_ctf_field_structure_get_field(structure
, name
);
916 if (!structure
|| !name
) {
922 /* Field not found, not an error. */
926 /* Make sure the payload has not already been set. */
927 if (!bt_ctf_field_validate(integer
)) {
928 /* Payload already set, not an error */
932 field_type
= bt_ctf_field_get_type(integer
);
933 /* Something is serioulsly wrong */
935 if (bt_ctf_field_type_get_type_id(field_type
) != CTF_TYPE_INTEGER
) {
937 * The user most likely meant for us to populate this field
938 * automatically. However, we can only do this if the field
939 * is an integer. Return an error.
945 if (bt_ctf_field_type_integer_get_signed(field_type
)) {
946 ret
= bt_ctf_field_signed_integer_set_value(integer
,
949 ret
= bt_ctf_field_unsigned_integer_set_value(integer
, value
);