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/ctf-writer/functor-internal.h>
39 #include <babeltrace/compiler.h>
40 #include <babeltrace/align.h>
41 #include <babeltrace/ctf/ctf-index.h>
44 void bt_ctf_stream_destroy(struct bt_ctf_ref
*ref
);
46 int set_structure_field_integer(struct bt_ctf_field
*, char *, uint64_t);
49 int set_packet_header_magic(struct bt_ctf_stream
*stream
)
52 struct bt_ctf_field_type
*magic_field_type
= NULL
;
53 struct bt_ctf_field
*magic_field
= bt_ctf_field_structure_get_field(
54 stream
->packet_header
, "magic");
57 /* No magic field found. Not an error, skip. */
61 if (!bt_ctf_field_validate(magic_field
)) {
62 /* Value already set. Not an error, skip. */
66 magic_field_type
= bt_ctf_field_get_type(magic_field
);
67 assert(magic_field_type
);
69 if (bt_ctf_field_type_get_type_id(magic_field_type
) !=
71 /* Magic field is not an integer. Not an error, skip. */
75 if (bt_ctf_field_type_integer_get_size(magic_field_type
) != 32) {
77 * Magic field is not of the expected size.
83 ret
= bt_ctf_field_type_integer_get_signed(magic_field_type
);
86 ret
= bt_ctf_field_signed_integer_set_value(magic_field
,
87 (int64_t) 0xC1FC1FC1);
89 ret
= bt_ctf_field_unsigned_integer_set_value(magic_field
,
90 (uint64_t) 0xC1FC1FC1);
94 bt_ctf_field_put(magic_field
);
96 if (magic_field_type
) {
97 bt_ctf_field_type_put(magic_field_type
);
103 int set_packet_header_uuid(struct bt_ctf_stream
*stream
)
106 struct bt_ctf_field_type
*uuid_field_type
= NULL
;
107 struct bt_ctf_field_type
*element_field_type
= NULL
;
108 struct bt_ctf_field
*uuid_field
= bt_ctf_field_structure_get_field(
109 stream
->packet_header
, "uuid");
112 /* No uuid field found. Not an error, skip. */
116 if (!bt_ctf_field_validate(uuid_field
)) {
117 /* Value already set. Not an error, skip. */
121 uuid_field_type
= bt_ctf_field_get_type(uuid_field
);
122 assert(uuid_field_type
);
123 if (bt_ctf_field_type_get_type_id(uuid_field_type
) !=
125 /* UUID field is not an array. Not an error, skip. */
129 if (bt_ctf_field_type_array_get_length(uuid_field_type
) != 16) {
131 * UUID field is not of the expected size.
132 * Not an error, skip.
137 element_field_type
= bt_ctf_field_type_array_get_element_type(
139 assert(element_field_type
);
140 if (bt_ctf_field_type_get_type_id(element_field_type
) !=
142 /* UUID array elements are not integers. Not an error, skip */
146 for (i
= 0; i
< 16; i
++) {
147 struct bt_ctf_field
*uuid_element
=
148 bt_ctf_field_array_get_field(uuid_field
, i
);
150 ret
= bt_ctf_field_type_integer_get_signed(element_field_type
);
154 ret
= bt_ctf_field_signed_integer_set_value(
155 uuid_element
, (int64_t) stream
->trace
->uuid
[i
]);
157 ret
= bt_ctf_field_unsigned_integer_set_value(
159 (uint64_t) stream
->trace
->uuid
[i
]);
161 bt_ctf_field_put(uuid_element
);
169 bt_ctf_field_put(uuid_field
);
171 if (uuid_field_type
) {
172 bt_ctf_field_type_put(uuid_field_type
);
174 if (element_field_type
) {
175 bt_ctf_field_type_put(element_field_type
);
180 int set_packet_header_stream_id(struct bt_ctf_stream
*stream
)
184 struct bt_ctf_field_type
*stream_id_field_type
= NULL
;
185 struct bt_ctf_field
*stream_id_field
= bt_ctf_field_structure_get_field(
186 stream
->packet_header
, "stream_id");
188 if (!stream_id_field
) {
189 /* No stream_id field found. Not an error, skip. */
193 if (!bt_ctf_field_validate(stream_id_field
)) {
194 /* Value already set. Not an error, skip. */
198 stream_id_field_type
= bt_ctf_field_get_type(stream_id_field
);
199 assert(stream_id_field_type
);
200 if (bt_ctf_field_type_get_type_id(stream_id_field_type
) !=
202 /* stream_id field is not an integer. Not an error, skip. */
206 stream_id
= stream
->stream_class
->id
;
207 ret
= bt_ctf_field_type_integer_get_signed(stream_id_field_type
);
210 ret
= bt_ctf_field_signed_integer_set_value(stream_id_field
,
211 (int64_t) stream_id
);
213 ret
= bt_ctf_field_unsigned_integer_set_value(stream_id_field
,
214 (uint64_t) stream_id
);
217 if (stream_id_field
) {
218 bt_ctf_field_put(stream_id_field
);
220 if (stream_id_field_type
) {
221 bt_ctf_field_type_put(stream_id_field_type
);
227 int set_packet_header(struct bt_ctf_stream
*stream
)
231 ret
= set_packet_header_magic(stream
);
236 ret
= set_packet_header_uuid(stream
);
241 ret
= set_packet_header_stream_id(stream
);
250 void put_event(struct bt_ctf_event
*event
)
252 bt_ctf_event_set_stream(event
, NULL
);
253 bt_ctf_event_put(event
);
257 struct bt_ctf_stream
*bt_ctf_stream_create(
258 struct bt_ctf_stream_class
*stream_class
,
259 struct bt_ctf_trace
*trace
)
262 struct bt_ctf_stream
*stream
= NULL
;
264 if (!stream_class
|| !trace
) {
268 stream
= g_new0(struct bt_ctf_stream
, 1);
273 stream
->trace
= trace
;
274 bt_ctf_ref_init(&stream
->ref_count
);
275 stream
->packet_context
= bt_ctf_field_create(
276 stream_class
->packet_context_type
);
277 if (!stream
->packet_context
) {
282 * A stream class may not have a stream event context defined
283 * in which case this stream will never have a stream_event_context
284 * member since, after a stream's creation, the parent stream class
285 * is "frozen" (immutable).
287 if (stream_class
->event_context_type
) {
288 stream
->event_context
= bt_ctf_field_create(
289 stream_class
->event_context_type
);
290 if (!stream
->packet_context
) {
295 /* Initialize events_discarded */
296 ret
= set_structure_field_integer(stream
->packet_context
,
297 "events_discarded", 0);
303 stream
->id
= stream_class
->next_stream_id
++;
304 stream
->stream_class
= stream_class
;
305 bt_ctf_stream_class_get(stream_class
);
306 stream
->events
= g_ptr_array_new_with_free_func(
307 (GDestroyNotify
) put_event
);
308 if (!stream
->events
) {
311 if (stream_class
->event_context_type
) {
312 stream
->event_contexts
= g_ptr_array_new_with_free_func(
313 (GDestroyNotify
) bt_ctf_field_put
);
314 if (!stream
->event_contexts
) {
319 /* A trace is not allowed to have a NULL packet header */
320 assert(trace
->packet_header_type
);
321 stream
->packet_header
= bt_ctf_field_create(trace
->packet_header_type
);
322 if (!stream
->packet_header
) {
326 * Attempt to populate the default trace packet header fields
327 * (magic, uuid and stream_id). This will _not_ fail shall the
328 * fields not be found or be of an incompatible type; they will
329 * simply not be populated automatically. The user will have to
330 * make sure to set the trace packet header fields himself before
333 ret
= set_packet_header(stream
);
340 bt_ctf_stream_destroy(&stream
->ref_count
);
345 int bt_ctf_stream_set_fd(struct bt_ctf_stream
*stream
, int fd
)
349 if (stream
->pos
.fd
!= -1) {
354 ctf_init_pos(&stream
->pos
, NULL
, fd
, O_RDWR
);
361 void bt_ctf_stream_set_trace(struct bt_ctf_stream
*stream
,
362 struct bt_ctf_trace
*trace
)
364 stream
->trace
= trace
;
367 struct bt_ctf_stream_class
*bt_ctf_stream_get_class(
368 struct bt_ctf_stream
*stream
)
370 struct bt_ctf_stream_class
*stream_class
= NULL
;
376 stream_class
= stream
->stream_class
;
377 bt_ctf_stream_class_get(stream_class
);
382 int bt_ctf_stream_get_discarded_events_count(
383 struct bt_ctf_stream
*stream
, uint64_t *count
)
387 struct bt_ctf_field
*events_discarded_field
= NULL
;
388 struct bt_ctf_field_type
*events_discarded_field_type
= NULL
;
390 if (!stream
|| !count
|| !stream
->packet_context
) {
395 events_discarded_field
= bt_ctf_field_structure_get_field(
396 stream
->packet_context
, "events_discarded");
397 if (!events_discarded_field
) {
402 events_discarded_field_type
= bt_ctf_field_get_type(
403 events_discarded_field
);
404 if (!events_discarded_field_type
) {
409 field_signed
= bt_ctf_field_type_integer_get_signed(
410 events_discarded_field_type
);
411 if (field_signed
< 0) {
417 int64_t signed_count
;
419 ret
= bt_ctf_field_signed_integer_get_value(
420 events_discarded_field
, &signed_count
);
424 if (signed_count
< 0) {
429 *count
= (uint64_t) signed_count
;
431 ret
= bt_ctf_field_unsigned_integer_get_value(
432 events_discarded_field
, count
);
438 if (events_discarded_field
) {
439 bt_ctf_field_put(events_discarded_field
);
441 if (events_discarded_field_type
) {
442 bt_ctf_field_type_put(events_discarded_field_type
);
447 void bt_ctf_stream_append_discarded_events(struct bt_ctf_stream
*stream
,
448 uint64_t event_count
)
452 uint64_t previous_count
;
454 struct bt_ctf_field
*events_discarded_field
= NULL
;
455 struct bt_ctf_field_type
*events_discarded_field_type
= NULL
;
457 if (!stream
|| !stream
->packet_context
) {
461 ret
= bt_ctf_stream_get_discarded_events_count(stream
,
467 events_discarded_field
= bt_ctf_field_structure_get_field(
468 stream
->packet_context
, "events_discarded");
469 if (!events_discarded_field
) {
473 events_discarded_field_type
= bt_ctf_field_get_type(
474 events_discarded_field
);
475 if (!events_discarded_field_type
) {
479 field_signed
= bt_ctf_field_type_integer_get_signed(
480 events_discarded_field_type
);
481 if (field_signed
< 0) {
485 new_count
= previous_count
+ event_count
;
487 ret
= bt_ctf_field_signed_integer_set_value(
488 events_discarded_field
, (int64_t) new_count
);
493 ret
= bt_ctf_field_unsigned_integer_set_value(
494 events_discarded_field
, new_count
);
501 if (events_discarded_field
) {
502 bt_ctf_field_put(events_discarded_field
);
504 if (events_discarded_field_type
) {
505 bt_ctf_field_type_put(events_discarded_field_type
);
509 int bt_ctf_stream_append_event(struct bt_ctf_stream
*stream
,
510 struct bt_ctf_event
*event
)
513 struct bt_ctf_field
*event_context_copy
= NULL
;
515 if (!stream
|| !event
) {
520 ret
= bt_ctf_event_set_stream(event
, stream
);
522 /* Event was already associated to a stream */
527 ret
= bt_ctf_event_populate_event_header(event
);
532 /* Make sure the event's payload is set */
533 ret
= bt_ctf_event_validate(event
);
538 /* Sample the current stream event context by copying it */
539 if (stream
->event_context
) {
540 /* Make sure the event context's payload is set */
541 ret
= bt_ctf_field_validate(stream
->event_context
);
546 event_context_copy
= bt_ctf_field_copy(stream
->event_context
);
547 if (!event_context_copy
) {
553 bt_ctf_event_get(event
);
554 /* Save the new event along with its associated stream event context */
555 g_ptr_array_add(stream
->events
, event
);
556 if (event_context_copy
) {
557 g_ptr_array_add(stream
->event_contexts
, event_context_copy
);
561 (void) bt_ctf_event_set_stream(event
, NULL
);
566 struct bt_ctf_field
*bt_ctf_stream_get_packet_context(
567 struct bt_ctf_stream
*stream
)
569 struct bt_ctf_field
*packet_context
= NULL
;
575 packet_context
= stream
->packet_context
;
576 if (packet_context
) {
577 bt_ctf_field_get(packet_context
);
580 return packet_context
;
583 int bt_ctf_stream_set_packet_context(struct bt_ctf_stream
*stream
,
584 struct bt_ctf_field
*field
)
587 struct bt_ctf_field_type
*field_type
;
589 if (!stream
|| !field
) {
594 field_type
= bt_ctf_field_get_type(field
);
595 if (field_type
!= stream
->stream_class
->packet_context_type
) {
600 bt_ctf_field_type_put(field_type
);
601 bt_ctf_field_get(field
);
602 bt_ctf_field_put(stream
->packet_context
);
603 stream
->packet_context
= field
;
608 struct bt_ctf_field
*bt_ctf_stream_get_event_context(
609 struct bt_ctf_stream
*stream
)
611 struct bt_ctf_field
*event_context
= NULL
;
617 event_context
= stream
->event_context
;
619 bt_ctf_field_get(event_context
);
622 return event_context
;
625 int bt_ctf_stream_set_event_context(struct bt_ctf_stream
*stream
,
626 struct bt_ctf_field
*field
)
629 struct bt_ctf_field_type
*field_type
= NULL
;
631 if (!stream
|| !field
) {
636 field_type
= bt_ctf_field_get_type(field
);
637 if (field_type
!= stream
->stream_class
->event_context_type
) {
642 bt_ctf_field_get(field
);
643 bt_ctf_field_put(stream
->event_context
);
644 stream
->event_context
= field
;
647 bt_ctf_field_type_put(field_type
);
652 struct bt_ctf_field
*bt_ctf_stream_get_packet_header(
653 struct bt_ctf_stream
*stream
)
655 struct bt_ctf_field
*packet_header
= NULL
;
661 packet_header
= stream
->packet_header
;
663 bt_ctf_field_get(packet_header
);
666 return packet_header
;
669 int bt_ctf_stream_set_packet_header(struct bt_ctf_stream
*stream
,
670 struct bt_ctf_field
*field
)
673 struct bt_ctf_field_type
*field_type
= NULL
;
675 if (!stream
|| !field
) {
680 field_type
= bt_ctf_field_get_type(field
);
681 if (field_type
!= stream
->trace
->packet_header_type
) {
686 bt_ctf_field_get(field
);
687 bt_ctf_field_put(stream
->packet_header
);
688 stream
->packet_header
= field
;
691 bt_ctf_field_type_put(field_type
);
697 int get_event_header_timestamp(struct bt_ctf_field
*event_header
, uint64_t *timestamp
)
700 struct bt_ctf_field
*timestamp_field
= NULL
;
701 struct bt_ctf_field_type
*timestamp_field_type
= NULL
;
703 timestamp_field
= bt_ctf_field_structure_get_field(event_header
,
705 if (!timestamp_field
) {
710 timestamp_field_type
= bt_ctf_field_get_type(timestamp_field
);
711 assert(timestamp_field_type
);
712 if (bt_ctf_field_type_get_type_id(timestamp_field_type
) !=
718 if (bt_ctf_field_type_integer_get_signed(timestamp_field_type
)) {
721 ret
= bt_ctf_field_signed_integer_get_value(timestamp_field
,
726 *timestamp
= (uint64_t) val
;
728 ret
= bt_ctf_field_unsigned_integer_get_value(timestamp_field
,
735 bt_ctf_field_put(timestamp_field
);
736 bt_ctf_field_type_put(timestamp_field_type
);
740 int bt_ctf_stream_flush(struct bt_ctf_stream
*stream
)
744 uint64_t timestamp_begin
, timestamp_end
, events_discarded
;
745 struct bt_ctf_field
*integer
= NULL
;
746 struct ctf_stream_pos packet_context_pos
;
748 if (!stream
|| stream
->pos
.fd
< 0) {
750 * Stream does not have an associated fd. It is,
751 * therefore, not a stream being used to write events.
757 if (!stream
->events
->len
) {
761 ret
= bt_ctf_field_validate(stream
->packet_header
);
766 /* mmap the next packet */
767 ctf_packet_seek(&stream
->pos
.parent
, 0, SEEK_CUR
);
769 ret
= bt_ctf_field_serialize(stream
->packet_header
, &stream
->pos
);
774 /* Set the default context attributes if present and unset. */
775 if (!get_event_header_timestamp(
776 ((struct bt_ctf_event
*) g_ptr_array_index(
777 stream
->events
, 0))->event_header
, ×tamp_begin
)) {
778 ret
= set_structure_field_integer(stream
->packet_context
,
779 "timestamp_begin", timestamp_begin
);
785 if (!get_event_header_timestamp(
786 ((struct bt_ctf_event
*) g_ptr_array_index(
787 stream
->events
, stream
->events
->len
- 1))->event_header
,
790 ret
= set_structure_field_integer(stream
->packet_context
,
791 "timestamp_end", timestamp_end
);
796 ret
= set_structure_field_integer(stream
->packet_context
,
797 "content_size", UINT64_MAX
);
802 ret
= set_structure_field_integer(stream
->packet_context
,
803 "packet_size", UINT64_MAX
);
808 /* Write packet context */
809 memcpy(&packet_context_pos
, &stream
->pos
,
810 sizeof(struct ctf_stream_pos
));
811 ret
= bt_ctf_field_serialize(stream
->packet_context
,
817 ret
= bt_ctf_stream_get_discarded_events_count(stream
,
823 /* Unset the packet context's fields. */
824 ret
= bt_ctf_field_reset(stream
->packet_context
);
829 /* Set the previous number of discarded events. */
830 ret
= set_structure_field_integer(stream
->packet_context
,
831 "events_discarded", events_discarded
);
836 for (i
= 0; i
< stream
->events
->len
; i
++) {
837 struct bt_ctf_event
*event
= g_ptr_array_index(
840 ret
= bt_ctf_field_reset(event
->event_header
);
845 /* Write event header */
846 ret
= bt_ctf_field_serialize(event
->event_header
,
852 /* Write stream event context */
853 if (stream
->event_contexts
) {
854 ret
= bt_ctf_field_serialize(
855 g_ptr_array_index(stream
->event_contexts
, i
),
862 /* Write event content */
863 ret
= bt_ctf_event_serialize(event
, &stream
->pos
);
870 * Update the packet total size and content size and overwrite the
872 * Copy base_mma as the packet may have been remapped (e.g. when a
873 * packet is resized).
875 packet_context_pos
.base_mma
= stream
->pos
.base_mma
;
876 ret
= set_structure_field_integer(stream
->packet_context
,
877 "content_size", stream
->pos
.offset
);
882 ret
= set_structure_field_integer(stream
->packet_context
,
883 "packet_size", stream
->pos
.packet_size
);
888 ret
= bt_ctf_field_serialize(stream
->packet_context
,
889 &packet_context_pos
);
894 g_ptr_array_set_size(stream
->events
, 0);
895 if (stream
->event_contexts
) {
896 g_ptr_array_set_size(stream
->event_contexts
, 0);
898 stream
->flushed_packet_count
++;
900 bt_ctf_field_put(integer
);
904 void bt_ctf_stream_get(struct bt_ctf_stream
*stream
)
910 bt_ctf_ref_get(&stream
->ref_count
);
913 void bt_ctf_stream_put(struct bt_ctf_stream
*stream
)
919 bt_ctf_ref_put(&stream
->ref_count
, bt_ctf_stream_destroy
);
923 void bt_ctf_stream_destroy(struct bt_ctf_ref
*ref
)
925 struct bt_ctf_stream
*stream
;
931 stream
= container_of(ref
, struct bt_ctf_stream
, ref_count
);
932 ctf_fini_pos(&stream
->pos
);
933 if (stream
->pos
.fd
>= 0 && close(stream
->pos
.fd
)) {
937 if (stream
->stream_class
) {
938 bt_ctf_stream_class_put(stream
->stream_class
);
940 if (stream
->events
) {
941 g_ptr_array_free(stream
->events
, TRUE
);
943 if (stream
->event_contexts
) {
944 g_ptr_array_free(stream
->event_contexts
, TRUE
);
946 if (stream
->packet_header
) {
947 bt_ctf_field_put(stream
->packet_header
);
949 if (stream
->packet_context
) {
950 bt_ctf_field_put(stream
->packet_context
);
952 if (stream
->event_context
) {
953 bt_ctf_field_put(stream
->event_context
);
959 int set_structure_field_integer(struct bt_ctf_field
*structure
, char *name
,
963 struct bt_ctf_field_type
*field_type
= NULL
;
964 struct bt_ctf_field
*integer
=
965 bt_ctf_field_structure_get_field(structure
, name
);
967 if (!structure
|| !name
) {
973 /* Field not found, not an error. */
977 /* Make sure the payload has not already been set. */
978 if (!bt_ctf_field_validate(integer
)) {
979 /* Payload already set, not an error */
983 field_type
= bt_ctf_field_get_type(integer
);
984 /* Something is serioulsly wrong */
986 if (bt_ctf_field_type_get_type_id(field_type
) != CTF_TYPE_INTEGER
) {
988 * The user most likely meant for us to populate this field
989 * automatically. However, we can only do this if the field
990 * is an integer. Return an error.
996 if (bt_ctf_field_type_integer_get_signed(field_type
)) {
997 ret
= bt_ctf_field_signed_integer_set_value(integer
,
1000 ret
= bt_ctf_field_unsigned_integer_set_value(integer
, value
);
1004 bt_ctf_field_put(integer
);
1007 bt_ctf_field_type_put(field_type
);