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 struct bt_ctf_stream
*bt_ctf_stream_create(
251 struct bt_ctf_stream_class
*stream_class
,
252 struct bt_ctf_trace
*trace
)
255 struct bt_ctf_stream
*stream
= NULL
;
257 if (!stream_class
|| !trace
) {
261 stream
= g_new0(struct bt_ctf_stream
, 1);
266 stream
->trace
= trace
;
267 bt_ctf_ref_init(&stream
->ref_count
);
268 stream
->packet_context
= bt_ctf_field_create(
269 stream_class
->packet_context_type
);
270 if (!stream
->packet_context
) {
275 * A stream class may not have a stream event context defined
276 * in which case this stream will never have a stream_event_context
277 * member since, after a stream's creation, the parent stream class
278 * is "frozen" (immutable).
280 if (stream_class
->event_context_type
) {
281 stream
->event_context
= bt_ctf_field_create(
282 stream_class
->event_context_type
);
283 if (!stream
->packet_context
) {
288 /* Initialize events_discarded */
289 ret
= set_structure_field_integer(stream
->packet_context
,
290 "events_discarded", 0);
296 stream
->id
= stream_class
->next_stream_id
++;
297 stream
->stream_class
= stream_class
;
298 bt_ctf_stream_class_get(stream_class
);
299 stream
->events
= g_ptr_array_new_with_free_func(
300 (GDestroyNotify
) bt_ctf_event_put
);
301 if (!stream
->events
) {
304 if (stream_class
->event_context_type
) {
305 stream
->event_contexts
= g_ptr_array_new_with_free_func(
306 (GDestroyNotify
) bt_ctf_field_put
);
307 if (!stream
->event_contexts
) {
312 /* A trace is not allowed to have a NULL packet header */
313 assert(trace
->packet_header_type
);
314 stream
->packet_header
= bt_ctf_field_create(trace
->packet_header_type
);
315 if (!stream
->packet_header
) {
319 * Attempt to populate the default trace packet header fields
320 * (magic, uuid and stream_id). This will _not_ fail shall the
321 * fields not be found or be of an incompatible type; they will
322 * simply not be populated automatically. The user will have to
323 * make sure to set the trace packet header fields himself before
326 ret
= set_packet_header(stream
);
333 bt_ctf_stream_destroy(&stream
->ref_count
);
338 int bt_ctf_stream_set_fd(struct bt_ctf_stream
*stream
, int fd
)
342 if (stream
->pos
.fd
!= -1) {
347 ctf_init_pos(&stream
->pos
, NULL
, fd
, O_RDWR
);
354 void bt_ctf_stream_set_trace(struct bt_ctf_stream
*stream
,
355 struct bt_ctf_trace
*trace
)
357 stream
->trace
= trace
;
360 struct bt_ctf_stream_class
*bt_ctf_stream_get_class(
361 struct bt_ctf_stream
*stream
)
363 struct bt_ctf_stream_class
*stream_class
= NULL
;
369 stream_class
= stream
->stream_class
;
370 bt_ctf_stream_class_get(stream_class
);
375 int bt_ctf_stream_get_discarded_events_count(
376 struct bt_ctf_stream
*stream
, uint64_t *count
)
380 struct bt_ctf_field
*events_discarded_field
= NULL
;
381 struct bt_ctf_field_type
*events_discarded_field_type
= NULL
;
383 if (!stream
|| !count
|| !stream
->packet_context
) {
388 events_discarded_field
= bt_ctf_field_structure_get_field(
389 stream
->packet_context
, "events_discarded");
390 if (!events_discarded_field
) {
395 events_discarded_field_type
= bt_ctf_field_get_type(
396 events_discarded_field
);
397 if (!events_discarded_field_type
) {
402 field_signed
= bt_ctf_field_type_integer_get_signed(
403 events_discarded_field_type
);
404 if (field_signed
< 0) {
410 int64_t signed_count
;
412 ret
= bt_ctf_field_signed_integer_get_value(
413 events_discarded_field
, &signed_count
);
417 if (signed_count
< 0) {
422 *count
= (uint64_t) signed_count
;
424 ret
= bt_ctf_field_unsigned_integer_get_value(
425 events_discarded_field
, count
);
431 if (events_discarded_field
) {
432 bt_ctf_field_put(events_discarded_field
);
434 if (events_discarded_field_type
) {
435 bt_ctf_field_type_put(events_discarded_field_type
);
440 void bt_ctf_stream_append_discarded_events(struct bt_ctf_stream
*stream
,
441 uint64_t event_count
)
445 uint64_t previous_count
;
447 struct bt_ctf_field
*events_discarded_field
= NULL
;
448 struct bt_ctf_field_type
*events_discarded_field_type
= NULL
;
450 if (!stream
|| !stream
->packet_context
) {
454 ret
= bt_ctf_stream_get_discarded_events_count(stream
,
460 events_discarded_field
= bt_ctf_field_structure_get_field(
461 stream
->packet_context
, "events_discarded");
462 if (!events_discarded_field
) {
466 events_discarded_field_type
= bt_ctf_field_get_type(
467 events_discarded_field
);
468 if (!events_discarded_field_type
) {
472 field_signed
= bt_ctf_field_type_integer_get_signed(
473 events_discarded_field_type
);
474 if (field_signed
< 0) {
478 new_count
= previous_count
+ event_count
;
480 ret
= bt_ctf_field_signed_integer_set_value(
481 events_discarded_field
, (int64_t) new_count
);
486 ret
= bt_ctf_field_unsigned_integer_set_value(
487 events_discarded_field
, new_count
);
494 if (events_discarded_field
) {
495 bt_ctf_field_put(events_discarded_field
);
497 if (events_discarded_field_type
) {
498 bt_ctf_field_type_put(events_discarded_field_type
);
502 int bt_ctf_stream_append_event(struct bt_ctf_stream
*stream
,
503 struct bt_ctf_event
*event
)
506 struct bt_ctf_field
*event_context_copy
= NULL
;
508 if (!stream
|| !event
) {
513 ret
= bt_ctf_event_populate_event_header(event
);
518 /* Make sure the event's payload is set */
519 ret
= bt_ctf_event_validate(event
);
524 /* Sample the current stream event context by copying it */
525 if (stream
->event_context
) {
526 /* Make sure the event context's payload is set */
527 ret
= bt_ctf_field_validate(stream
->event_context
);
532 event_context_copy
= bt_ctf_field_copy(stream
->event_context
);
533 if (!event_context_copy
) {
539 bt_ctf_event_get(event
);
540 /* Save the new event along with its associated stream event context */
541 g_ptr_array_add(stream
->events
, event
);
542 if (event_context_copy
) {
543 g_ptr_array_add(stream
->event_contexts
, event_context_copy
);
549 struct bt_ctf_field
*bt_ctf_stream_get_packet_context(
550 struct bt_ctf_stream
*stream
)
552 struct bt_ctf_field
*packet_context
= NULL
;
558 packet_context
= stream
->packet_context
;
559 if (packet_context
) {
560 bt_ctf_field_get(packet_context
);
563 return packet_context
;
566 int bt_ctf_stream_set_packet_context(struct bt_ctf_stream
*stream
,
567 struct bt_ctf_field
*field
)
570 struct bt_ctf_field_type
*field_type
;
572 if (!stream
|| !field
) {
577 field_type
= bt_ctf_field_get_type(field
);
578 if (field_type
!= stream
->stream_class
->packet_context_type
) {
583 bt_ctf_field_type_put(field_type
);
584 bt_ctf_field_get(field
);
585 bt_ctf_field_put(stream
->packet_context
);
586 stream
->packet_context
= field
;
591 struct bt_ctf_field
*bt_ctf_stream_get_event_context(
592 struct bt_ctf_stream
*stream
)
594 struct bt_ctf_field
*event_context
= NULL
;
600 event_context
= stream
->event_context
;
602 bt_ctf_field_get(event_context
);
605 return event_context
;
608 int bt_ctf_stream_set_event_context(struct bt_ctf_stream
*stream
,
609 struct bt_ctf_field
*field
)
612 struct bt_ctf_field_type
*field_type
= NULL
;
614 if (!stream
|| !field
) {
619 field_type
= bt_ctf_field_get_type(field
);
620 if (field_type
!= stream
->stream_class
->event_context_type
) {
625 bt_ctf_field_get(field
);
626 bt_ctf_field_put(stream
->event_context
);
627 stream
->event_context
= field
;
630 bt_ctf_field_type_put(field_type
);
635 struct bt_ctf_field
*bt_ctf_stream_get_packet_header(
636 struct bt_ctf_stream
*stream
)
638 struct bt_ctf_field
*packet_header
= NULL
;
644 packet_header
= stream
->packet_header
;
646 bt_ctf_field_get(packet_header
);
649 return packet_header
;
652 int bt_ctf_stream_set_packet_header(struct bt_ctf_stream
*stream
,
653 struct bt_ctf_field
*field
)
656 struct bt_ctf_field_type
*field_type
= NULL
;
658 if (!stream
|| !field
) {
663 field_type
= bt_ctf_field_get_type(field
);
664 if (field_type
!= stream
->trace
->packet_header_type
) {
669 bt_ctf_field_get(field
);
670 bt_ctf_field_put(stream
->packet_header
);
671 stream
->packet_header
= field
;
674 bt_ctf_field_type_put(field_type
);
680 int get_event_header_timestamp(struct bt_ctf_field
*event_header
, uint64_t *timestamp
)
683 struct bt_ctf_field
*timestamp_field
= NULL
;
684 struct bt_ctf_field_type
*timestamp_field_type
= NULL
;
686 timestamp_field
= bt_ctf_field_structure_get_field(event_header
,
688 if (!timestamp_field
) {
693 timestamp_field_type
= bt_ctf_field_get_type(timestamp_field
);
694 assert(timestamp_field_type
);
695 if (bt_ctf_field_type_get_type_id(timestamp_field_type
) !=
701 if (bt_ctf_field_type_integer_get_signed(timestamp_field_type
)) {
704 ret
= bt_ctf_field_signed_integer_get_value(timestamp_field
,
709 *timestamp
= (uint64_t) val
;
711 ret
= bt_ctf_field_unsigned_integer_get_value(timestamp_field
,
718 bt_ctf_field_put(timestamp_field
);
719 bt_ctf_field_type_put(timestamp_field_type
);
723 int bt_ctf_stream_flush(struct bt_ctf_stream
*stream
)
727 uint64_t timestamp_begin
, timestamp_end
, events_discarded
;
728 struct bt_ctf_field
*integer
= NULL
;
729 struct ctf_stream_pos packet_context_pos
;
731 if (!stream
|| stream
->pos
.fd
< 0) {
733 * Stream does not have an associated fd. It is,
734 * therefore, not a stream being used to write events.
740 if (!stream
->events
->len
) {
744 ret
= bt_ctf_field_validate(stream
->packet_header
);
749 /* mmap the next packet */
750 ctf_packet_seek(&stream
->pos
.parent
, 0, SEEK_CUR
);
752 ret
= bt_ctf_field_serialize(stream
->packet_header
, &stream
->pos
);
757 /* Set the default context attributes if present and unset. */
758 if (!get_event_header_timestamp(
759 ((struct bt_ctf_event
*) g_ptr_array_index(
760 stream
->events
, 0))->event_header
, ×tamp_begin
)) {
761 ret
= set_structure_field_integer(stream
->packet_context
,
762 "timestamp_begin", timestamp_begin
);
768 if (!get_event_header_timestamp(
769 ((struct bt_ctf_event
*) g_ptr_array_index(
770 stream
->events
, stream
->events
->len
- 1))->event_header
,
773 ret
= set_structure_field_integer(stream
->packet_context
,
774 "timestamp_end", timestamp_end
);
779 ret
= set_structure_field_integer(stream
->packet_context
,
780 "content_size", UINT64_MAX
);
785 ret
= set_structure_field_integer(stream
->packet_context
,
786 "packet_size", UINT64_MAX
);
791 /* Write packet context */
792 memcpy(&packet_context_pos
, &stream
->pos
,
793 sizeof(struct ctf_stream_pos
));
794 ret
= bt_ctf_field_serialize(stream
->packet_context
,
800 ret
= bt_ctf_stream_get_discarded_events_count(stream
,
806 /* Unset the packet context's fields. */
807 ret
= bt_ctf_field_reset(stream
->packet_context
);
812 /* Set the previous number of discarded events. */
813 ret
= set_structure_field_integer(stream
->packet_context
,
814 "events_discarded", events_discarded
);
819 for (i
= 0; i
< stream
->events
->len
; i
++) {
820 struct bt_ctf_event
*event
= g_ptr_array_index(
823 ret
= bt_ctf_field_reset(event
->event_header
);
828 /* Write event header */
829 ret
= bt_ctf_field_serialize(event
->event_header
,
835 /* Write stream event context */
836 if (stream
->event_contexts
) {
837 ret
= bt_ctf_field_serialize(
838 g_ptr_array_index(stream
->event_contexts
, i
),
845 /* Write event content */
846 ret
= bt_ctf_event_serialize(event
, &stream
->pos
);
853 * Update the packet total size and content size and overwrite the
855 * Copy base_mma as the packet may have been remapped (e.g. when a
856 * packet is resized).
858 packet_context_pos
.base_mma
= stream
->pos
.base_mma
;
859 ret
= set_structure_field_integer(stream
->packet_context
,
860 "content_size", stream
->pos
.offset
);
865 ret
= set_structure_field_integer(stream
->packet_context
,
866 "packet_size", stream
->pos
.packet_size
);
871 ret
= bt_ctf_field_serialize(stream
->packet_context
,
872 &packet_context_pos
);
877 g_ptr_array_set_size(stream
->events
, 0);
878 if (stream
->event_contexts
) {
879 g_ptr_array_set_size(stream
->event_contexts
, 0);
881 stream
->flushed_packet_count
++;
883 bt_ctf_field_put(integer
);
887 void bt_ctf_stream_get(struct bt_ctf_stream
*stream
)
893 bt_ctf_ref_get(&stream
->ref_count
);
896 void bt_ctf_stream_put(struct bt_ctf_stream
*stream
)
902 bt_ctf_ref_put(&stream
->ref_count
, bt_ctf_stream_destroy
);
906 void bt_ctf_stream_destroy(struct bt_ctf_ref
*ref
)
908 struct bt_ctf_stream
*stream
;
914 stream
= container_of(ref
, struct bt_ctf_stream
, ref_count
);
915 ctf_fini_pos(&stream
->pos
);
916 if (close(stream
->pos
.fd
)) {
920 if (stream
->stream_class
) {
921 bt_ctf_stream_class_put(stream
->stream_class
);
923 if (stream
->events
) {
924 g_ptr_array_free(stream
->events
, TRUE
);
926 if (stream
->event_contexts
) {
927 g_ptr_array_free(stream
->event_contexts
, TRUE
);
929 if (stream
->packet_header
) {
930 bt_ctf_field_put(stream
->packet_header
);
932 if (stream
->packet_context
) {
933 bt_ctf_field_put(stream
->packet_context
);
935 if (stream
->event_context
) {
936 bt_ctf_field_put(stream
->event_context
);
942 int set_structure_field_integer(struct bt_ctf_field
*structure
, char *name
,
946 struct bt_ctf_field_type
*field_type
= NULL
;
947 struct bt_ctf_field
*integer
=
948 bt_ctf_field_structure_get_field(structure
, name
);
950 if (!structure
|| !name
) {
956 /* Field not found, not an error. */
960 /* Make sure the payload has not already been set. */
961 if (!bt_ctf_field_validate(integer
)) {
962 /* Payload already set, not an error */
966 field_type
= bt_ctf_field_get_type(integer
);
967 /* Something is serioulsly wrong */
969 if (bt_ctf_field_type_get_type_id(field_type
) != CTF_TYPE_INTEGER
) {
971 * The user most likely meant for us to populate this field
972 * automatically. However, we can only do this if the field
973 * is an integer. Return an error.
979 if (bt_ctf_field_type_integer_get_signed(field_type
)) {
980 ret
= bt_ctf_field_signed_integer_set_value(integer
,
983 ret
= bt_ctf_field_unsigned_integer_set_value(integer
, value
);
987 bt_ctf_field_put(integer
);
990 bt_ctf_field_type_put(field_type
);