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 bt_ctf_stream_class_freeze(stream_class
);
300 stream
->events
= g_ptr_array_new_with_free_func(
301 (GDestroyNotify
) bt_ctf_event_put
);
302 if (!stream
->events
) {
305 if (stream_class
->event_context_type
) {
306 stream
->event_contexts
= g_ptr_array_new_with_free_func(
307 (GDestroyNotify
) bt_ctf_field_put
);
308 if (!stream
->event_contexts
) {
313 /* A trace is not allowed to have a NULL packet header */
314 assert(trace
->packet_header_type
);
315 stream
->packet_header
= bt_ctf_field_create(trace
->packet_header_type
);
317 * Attempt to populate the default trace packet header fields
318 * (magic, uuid and stream_id). This will _not_ fail shall the
319 * fields not be found or be of an incompatible type; they will
320 * simply not be populated automatically. The user will have to
321 * make sure to set the trace packet header fields himself before
324 ret
= set_packet_header(stream
);
331 bt_ctf_stream_destroy(&stream
->ref_count
);
336 int bt_ctf_stream_set_fd(struct bt_ctf_stream
*stream
, int fd
)
340 if (stream
->pos
.fd
!= -1) {
345 ctf_init_pos(&stream
->pos
, NULL
, fd
, O_RDWR
);
352 void bt_ctf_stream_set_trace(struct bt_ctf_stream
*stream
,
353 struct bt_ctf_trace
*trace
)
355 stream
->trace
= trace
;
358 int bt_ctf_stream_get_discarded_events_count(
359 struct bt_ctf_stream
*stream
, uint64_t *count
)
363 struct bt_ctf_field
*events_discarded_field
= NULL
;
364 struct bt_ctf_field_type
*events_discarded_field_type
= NULL
;
366 if (!stream
|| !count
|| !stream
->packet_context
) {
371 events_discarded_field
= bt_ctf_field_structure_get_field(
372 stream
->packet_context
, "events_discarded");
373 if (!events_discarded_field
) {
378 events_discarded_field_type
= bt_ctf_field_get_type(
379 events_discarded_field
);
380 if (!events_discarded_field_type
) {
385 field_signed
= bt_ctf_field_type_integer_get_signed(
386 events_discarded_field_type
);
387 if (field_signed
< 0) {
393 int64_t signed_count
;
395 ret
= bt_ctf_field_signed_integer_get_value(
396 events_discarded_field
, &signed_count
);
400 if (signed_count
< 0) {
405 *count
= (uint64_t) signed_count
;
407 ret
= bt_ctf_field_unsigned_integer_get_value(
408 events_discarded_field
, count
);
414 if (events_discarded_field
) {
415 bt_ctf_field_put(events_discarded_field
);
417 if (events_discarded_field_type
) {
418 bt_ctf_field_type_put(events_discarded_field_type
);
423 void bt_ctf_stream_append_discarded_events(struct bt_ctf_stream
*stream
,
424 uint64_t event_count
)
428 uint64_t previous_count
;
430 struct bt_ctf_field
*events_discarded_field
= NULL
;
431 struct bt_ctf_field_type
*events_discarded_field_type
= NULL
;
433 if (!stream
|| !stream
->packet_context
) {
437 ret
= bt_ctf_stream_get_discarded_events_count(stream
,
443 events_discarded_field
= bt_ctf_field_structure_get_field(
444 stream
->packet_context
, "events_discarded");
445 if (!events_discarded_field
) {
449 events_discarded_field_type
= bt_ctf_field_get_type(
450 events_discarded_field
);
451 if (!events_discarded_field_type
) {
455 field_signed
= bt_ctf_field_type_integer_get_signed(
456 events_discarded_field_type
);
457 if (field_signed
< 0) {
461 new_count
= previous_count
+ event_count
;
463 ret
= bt_ctf_field_signed_integer_set_value(
464 events_discarded_field
, (int64_t) new_count
);
469 ret
= bt_ctf_field_unsigned_integer_set_value(
470 events_discarded_field
, new_count
);
477 if (events_discarded_field
) {
478 bt_ctf_field_put(events_discarded_field
);
480 if (events_discarded_field_type
) {
481 bt_ctf_field_type_put(events_discarded_field_type
);
485 int bt_ctf_stream_append_event(struct bt_ctf_stream
*stream
,
486 struct bt_ctf_event
*event
)
490 struct bt_ctf_field
*event_context_copy
= NULL
;
492 if (!stream
|| !event
) {
497 /* Make sure the event's payload is set */
498 ret
= bt_ctf_event_validate(event
);
503 /* Sample the current stream event context by copying it */
504 if (stream
->event_context
) {
505 /* Make sure the event context's payload is set */
506 ret
= bt_ctf_field_validate(stream
->event_context
);
511 event_context_copy
= bt_ctf_field_copy(stream
->event_context
);
512 if (!event_context_copy
) {
518 timestamp
= bt_ctf_clock_get_time(stream
->stream_class
->clock
);
519 ret
= bt_ctf_event_set_timestamp(event
, timestamp
);
524 bt_ctf_event_get(event
);
525 /* Save the new event along with its associated stream event context */
526 g_ptr_array_add(stream
->events
, event
);
527 if (event_context_copy
) {
528 g_ptr_array_add(stream
->event_contexts
, event_context_copy
);
534 struct bt_ctf_field
*bt_ctf_stream_get_packet_context(
535 struct bt_ctf_stream
*stream
)
537 struct bt_ctf_field
*packet_context
= NULL
;
543 packet_context
= stream
->packet_context
;
544 if (packet_context
) {
545 bt_ctf_field_get(packet_context
);
548 return packet_context
;
551 int bt_ctf_stream_set_packet_context(struct bt_ctf_stream
*stream
,
552 struct bt_ctf_field
*field
)
555 struct bt_ctf_field_type
*field_type
;
557 if (!stream
|| !field
) {
562 field_type
= bt_ctf_field_get_type(field
);
563 if (field_type
!= stream
->stream_class
->packet_context_type
) {
568 bt_ctf_field_type_put(field_type
);
569 bt_ctf_field_get(field
);
570 bt_ctf_field_put(stream
->packet_context
);
571 stream
->packet_context
= field
;
576 struct bt_ctf_field
*bt_ctf_stream_get_event_context(
577 struct bt_ctf_stream
*stream
)
579 struct bt_ctf_field
*event_context
= NULL
;
585 event_context
= stream
->event_context
;
587 bt_ctf_field_get(event_context
);
590 return event_context
;
593 int bt_ctf_stream_set_event_context(struct bt_ctf_stream
*stream
,
594 struct bt_ctf_field
*field
)
597 struct bt_ctf_field_type
*field_type
= NULL
;
599 if (!stream
|| !field
) {
604 field_type
= bt_ctf_field_get_type(field
);
605 if (field_type
!= stream
->stream_class
->event_context_type
) {
610 bt_ctf_field_get(field
);
611 bt_ctf_field_put(stream
->event_context
);
612 stream
->event_context
= field
;
615 bt_ctf_field_type_put(field_type
);
620 struct bt_ctf_field
*bt_ctf_stream_get_packet_header(
621 struct bt_ctf_stream
*stream
)
623 struct bt_ctf_field
*packet_header
= NULL
;
629 packet_header
= stream
->packet_header
;
631 bt_ctf_field_get(packet_header
);
634 return packet_header
;
637 int bt_ctf_stream_set_packet_header(struct bt_ctf_stream
*stream
,
638 struct bt_ctf_field
*field
)
641 struct bt_ctf_field_type
*field_type
= NULL
;
643 if (!stream
|| !field
) {
648 field_type
= bt_ctf_field_get_type(field
);
649 if (field_type
!= stream
->trace
->packet_header_type
) {
654 bt_ctf_field_get(field
);
655 bt_ctf_field_put(stream
->packet_header
);
656 stream
->packet_header
= field
;
659 bt_ctf_field_type_put(field_type
);
664 int bt_ctf_stream_flush(struct bt_ctf_stream
*stream
)
668 uint64_t timestamp_begin
, timestamp_end
, events_discarded
;
669 struct bt_ctf_stream_class
*stream_class
;
670 struct bt_ctf_field
*integer
= NULL
;
671 struct ctf_stream_pos packet_context_pos
;
673 if (!stream
|| stream
->pos
.fd
< 0) {
675 * Stream does not have an associated fd. It is,
676 * therefore, not a stream being used to write events.
682 if (!stream
->events
->len
) {
686 ret
= bt_ctf_field_validate(stream
->packet_header
);
691 if (stream
->flushed_packet_count
) {
692 /* ctf_init_pos has already initialized the first packet */
693 ctf_packet_seek(&stream
->pos
.parent
, 0, SEEK_CUR
);
696 ret
= bt_ctf_field_serialize(stream
->packet_header
, &stream
->pos
);
701 stream_class
= stream
->stream_class
;
702 timestamp_begin
= ((struct bt_ctf_event
*) g_ptr_array_index(
703 stream
->events
, 0))->timestamp
;
704 timestamp_end
= ((struct bt_ctf_event
*) g_ptr_array_index(
705 stream
->events
, stream
->events
->len
- 1))->timestamp
;
707 /* Set the default context attributes if present and unset. */
708 ret
= set_structure_field_integer(stream
->packet_context
,
709 "timestamp_begin", timestamp_begin
);
714 ret
= set_structure_field_integer(stream
->packet_context
,
715 "timestamp_end", timestamp_end
);
720 ret
= set_structure_field_integer(stream
->packet_context
,
721 "content_size", UINT64_MAX
);
726 ret
= set_structure_field_integer(stream
->packet_context
,
727 "packet_size", UINT64_MAX
);
732 /* Write packet context */
733 memcpy(&packet_context_pos
, &stream
->pos
,
734 sizeof(struct ctf_stream_pos
));
735 ret
= bt_ctf_field_serialize(stream
->packet_context
,
741 ret
= bt_ctf_stream_get_discarded_events_count(stream
,
747 /* Unset the packet context's fields. */
748 ret
= bt_ctf_field_reset(stream
->packet_context
);
753 /* Set the previous number of discarded events. */
754 ret
= set_structure_field_integer(stream
->packet_context
,
755 "events_discarded", events_discarded
);
760 for (i
= 0; i
< stream
->events
->len
; i
++) {
761 struct bt_ctf_event
*event
= g_ptr_array_index(
763 uint32_t event_id
= bt_ctf_event_class_get_id(
765 uint64_t timestamp
= bt_ctf_event_get_timestamp(event
);
767 ret
= bt_ctf_field_reset(stream_class
->event_header
);
772 ret
= set_structure_field_integer(stream_class
->event_header
,
777 ret
= set_structure_field_integer(stream_class
->event_header
,
778 "timestamp", timestamp
);
783 /* Write event header */
784 ret
= bt_ctf_field_serialize(stream_class
->event_header
,
790 /* Write stream event context */
791 if (stream
->event_contexts
) {
792 ret
= bt_ctf_field_serialize(
793 g_ptr_array_index(stream
->event_contexts
, i
),
800 /* Write event content */
801 ret
= bt_ctf_event_serialize(event
, &stream
->pos
);
808 * Update the packet total size and content size and overwrite the
810 * Copy base_mma as the packet may have been remapped (e.g. when a
811 * packet is resized).
813 packet_context_pos
.base_mma
= stream
->pos
.base_mma
;
814 ret
= set_structure_field_integer(stream
->packet_context
,
815 "content_size", stream
->pos
.offset
);
820 ret
= set_structure_field_integer(stream
->packet_context
,
821 "packet_size", stream
->pos
.packet_size
);
826 ret
= bt_ctf_field_serialize(stream
->packet_context
,
827 &packet_context_pos
);
832 g_ptr_array_set_size(stream
->events
, 0);
833 if (stream
->event_contexts
) {
834 g_ptr_array_set_size(stream
->event_contexts
, 0);
836 stream
->flushed_packet_count
++;
838 bt_ctf_field_put(integer
);
842 void bt_ctf_stream_get(struct bt_ctf_stream
*stream
)
848 bt_ctf_ref_get(&stream
->ref_count
);
851 void bt_ctf_stream_put(struct bt_ctf_stream
*stream
)
857 bt_ctf_ref_put(&stream
->ref_count
, bt_ctf_stream_destroy
);
861 void bt_ctf_stream_destroy(struct bt_ctf_ref
*ref
)
863 struct bt_ctf_stream
*stream
;
869 stream
= container_of(ref
, struct bt_ctf_stream
, ref_count
);
870 ctf_fini_pos(&stream
->pos
);
871 if (close(stream
->pos
.fd
)) {
875 if (stream
->stream_class
) {
876 bt_ctf_stream_class_put(stream
->stream_class
);
878 if (stream
->events
) {
879 g_ptr_array_free(stream
->events
, TRUE
);
881 if (stream
->event_contexts
) {
882 g_ptr_array_free(stream
->event_contexts
, TRUE
);
884 if (stream
->packet_header
) {
885 bt_ctf_field_put(stream
->packet_header
);
887 if (stream
->packet_context
) {
888 bt_ctf_field_put(stream
->packet_context
);
890 if (stream
->event_context
) {
891 bt_ctf_field_put(stream
->event_context
);
897 int set_structure_field_integer(struct bt_ctf_field
*structure
, char *name
,
901 struct bt_ctf_field_type
*field_type
= NULL
;
902 struct bt_ctf_field
*integer
=
903 bt_ctf_field_structure_get_field(structure
, name
);
905 if (!structure
|| !name
) {
911 /* Field not found, not an error. */
915 /* Make sure the payload has not already been set. */
916 if (!bt_ctf_field_validate(integer
)) {
917 /* Payload already set, not an error */
921 field_type
= bt_ctf_field_get_type(integer
);
922 /* Something is serioulsly wrong */
924 if (bt_ctf_field_type_get_type_id(field_type
) != CTF_TYPE_INTEGER
) {
926 * The user most likely meant for us to populate this field
927 * automatically. However, we can only do this if the field
928 * is an integer. Return an error.
934 if (bt_ctf_field_type_integer_get_signed(field_type
)) {
935 ret
= bt_ctf_field_signed_integer_set_value(integer
,
938 ret
= bt_ctf_field_unsigned_integer_set_value(integer
, value
);
942 bt_ctf_field_put(integer
);
945 bt_ctf_field_type_put(field_type
);