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_trace
*trace
= NULL
;
104 struct bt_ctf_field_type
*uuid_field_type
= NULL
;
105 struct bt_ctf_field_type
*element_field_type
= NULL
;
106 struct bt_ctf_field
*uuid_field
= bt_ctf_field_structure_get_field(
107 stream
->packet_header
, "uuid");
110 /* No uuid field found. Not an error, skip. */
114 if (!bt_ctf_field_validate(uuid_field
)) {
115 /* Value already set. Not an error, skip. */
119 uuid_field_type
= bt_ctf_field_get_type(uuid_field
);
120 assert(uuid_field_type
);
121 if (bt_ctf_field_type_get_type_id(uuid_field_type
) !=
123 /* UUID field is not an array. Not an error, skip. */
127 if (bt_ctf_field_type_array_get_length(uuid_field_type
) != 16) {
129 * UUID field is not of the expected size.
130 * Not an error, skip.
135 element_field_type
= bt_ctf_field_type_array_get_element_type(
137 assert(element_field_type
);
138 if (bt_ctf_field_type_get_type_id(element_field_type
) !=
140 /* UUID array elements are not integers. Not an error, skip */
144 trace
= (struct bt_ctf_trace
*) bt_object_get_parent(stream
);
145 for (i
= 0; i
< 16; i
++) {
146 struct bt_ctf_field
*uuid_element
=
147 bt_ctf_field_array_get_field(uuid_field
, i
);
149 ret
= bt_ctf_field_type_integer_get_signed(element_field_type
);
153 ret
= bt_ctf_field_signed_integer_set_value(
154 uuid_element
, (int64_t) trace
->uuid
[i
]);
156 ret
= bt_ctf_field_unsigned_integer_set_value(
158 (uint64_t) trace
->uuid
[i
]);
160 bt_put(uuid_element
);
168 bt_put(uuid_field_type
);
169 bt_put(element_field_type
);
174 int set_packet_header_stream_id(struct bt_ctf_stream
*stream
)
178 struct bt_ctf_field_type
*stream_id_field_type
= NULL
;
179 struct bt_ctf_field
*stream_id_field
= bt_ctf_field_structure_get_field(
180 stream
->packet_header
, "stream_id");
182 if (!stream_id_field
) {
183 /* No stream_id field found. Not an error, skip. */
187 if (!bt_ctf_field_validate(stream_id_field
)) {
188 /* Value already set. Not an error, skip. */
192 stream_id_field_type
= bt_ctf_field_get_type(stream_id_field
);
193 assert(stream_id_field_type
);
194 if (bt_ctf_field_type_get_type_id(stream_id_field_type
) !=
196 /* stream_id field is not an integer. Not an error, skip. */
200 stream_id
= stream
->stream_class
->id
;
201 ret
= bt_ctf_field_type_integer_get_signed(stream_id_field_type
);
204 ret
= bt_ctf_field_signed_integer_set_value(stream_id_field
,
205 (int64_t) stream_id
);
207 ret
= bt_ctf_field_unsigned_integer_set_value(stream_id_field
,
208 (uint64_t) stream_id
);
211 bt_put(stream_id_field
);
212 bt_put(stream_id_field_type
);
217 int set_packet_header(struct bt_ctf_stream
*stream
)
221 ret
= set_packet_header_magic(stream
);
226 ret
= set_packet_header_uuid(stream
);
231 ret
= set_packet_header_stream_id(stream
);
240 void release_event(struct bt_ctf_event
*event
)
242 if (bt_object_get_ref_count(event
)) {
244 * The event is being orphaned, but it must guarantee the
245 * existence of its event class for the duration of its
248 bt_get(event
->event_class
);
249 BT_PUT(event
->base
.parent
);
251 bt_object_release(event
);
256 struct bt_ctf_stream
*bt_ctf_stream_create(
257 struct bt_ctf_stream_class
*stream_class
,
258 struct bt_ctf_trace
*trace
)
261 struct bt_ctf_stream
*stream
= NULL
;
263 if (!stream_class
|| !trace
) {
267 stream
= g_new0(struct bt_ctf_stream
, 1);
272 bt_object_init(stream
, bt_ctf_stream_destroy
);
274 * Acquire reference to parent since stream will become publicly
275 * reachable; it needs its parent to remain valid.
277 bt_object_set_parent(stream
, trace
);
278 stream
->packet_context
= bt_ctf_field_create(
279 stream_class
->packet_context_type
);
280 if (!stream
->packet_context
) {
285 * A stream class may not have a stream event context defined
286 * in which case this stream will never have a stream_event_context
287 * member since, after a stream's creation, the parent stream class
288 * is "frozen" (immutable).
290 if (stream_class
->event_context_type
) {
291 stream
->event_context
= bt_ctf_field_create(
292 stream_class
->event_context_type
);
293 if (!stream
->event_context
) {
298 /* Initialize events_discarded */
299 ret
= set_structure_field_integer(stream
->packet_context
,
300 "events_discarded", 0);
306 stream
->id
= stream_class
->next_stream_id
++;
307 stream
->stream_class
= stream_class
;
308 stream
->events
= g_ptr_array_new_with_free_func(
309 (GDestroyNotify
) release_event
);
310 if (!stream
->events
) {
313 if (stream_class
->event_context_type
) {
314 stream
->event_contexts
= g_ptr_array_new_with_free_func(
315 (GDestroyNotify
) bt_put
);
316 if (!stream
->event_contexts
) {
321 /* A trace is not allowed to have a NULL packet header */
322 assert(trace
->packet_header_type
);
323 stream
->packet_header
= bt_ctf_field_create(trace
->packet_header_type
);
324 if (!stream
->packet_header
) {
328 * Attempt to populate the default trace packet header fields
329 * (magic, uuid and stream_id). This will _not_ fail shall the
330 * fields not be found or be of an incompatible type; they will
331 * simply not be populated automatically. The user will have to
332 * make sure to set the trace packet header fields himself before
335 ret
= set_packet_header(stream
);
348 int bt_ctf_stream_set_fd(struct bt_ctf_stream
*stream
, int fd
)
352 if (stream
->pos
.fd
!= -1) {
357 ctf_init_pos(&stream
->pos
, NULL
, fd
, O_RDWR
);
363 struct bt_ctf_stream_class
*bt_ctf_stream_get_class(
364 struct bt_ctf_stream
*stream
)
366 struct bt_ctf_stream_class
*stream_class
= NULL
;
372 stream_class
= stream
->stream_class
;
373 bt_get(stream_class
);
378 int bt_ctf_stream_get_discarded_events_count(
379 struct bt_ctf_stream
*stream
, uint64_t *count
)
383 struct bt_ctf_field
*events_discarded_field
= NULL
;
384 struct bt_ctf_field_type
*events_discarded_field_type
= NULL
;
386 if (!stream
|| !count
|| !stream
->packet_context
) {
391 events_discarded_field
= bt_ctf_field_structure_get_field(
392 stream
->packet_context
, "events_discarded");
393 if (!events_discarded_field
) {
398 events_discarded_field_type
= bt_ctf_field_get_type(
399 events_discarded_field
);
400 if (!events_discarded_field_type
) {
405 field_signed
= bt_ctf_field_type_integer_get_signed(
406 events_discarded_field_type
);
407 if (field_signed
< 0) {
413 int64_t signed_count
;
415 ret
= bt_ctf_field_signed_integer_get_value(
416 events_discarded_field
, &signed_count
);
420 if (signed_count
< 0) {
425 *count
= (uint64_t) signed_count
;
427 ret
= bt_ctf_field_unsigned_integer_get_value(
428 events_discarded_field
, count
);
434 bt_put(events_discarded_field
);
435 bt_put(events_discarded_field_type
);
439 void bt_ctf_stream_append_discarded_events(struct bt_ctf_stream
*stream
,
440 uint64_t event_count
)
444 uint64_t previous_count
;
446 struct bt_ctf_field
*events_discarded_field
= NULL
;
447 struct bt_ctf_field_type
*events_discarded_field_type
= NULL
;
449 if (!stream
|| !stream
->packet_context
) {
453 ret
= bt_ctf_stream_get_discarded_events_count(stream
,
459 events_discarded_field
= bt_ctf_field_structure_get_field(
460 stream
->packet_context
, "events_discarded");
461 if (!events_discarded_field
) {
465 events_discarded_field_type
= bt_ctf_field_get_type(
466 events_discarded_field
);
467 if (!events_discarded_field_type
) {
471 field_signed
= bt_ctf_field_type_integer_get_signed(
472 events_discarded_field_type
);
473 if (field_signed
< 0) {
477 new_count
= previous_count
+ event_count
;
479 ret
= bt_ctf_field_signed_integer_set_value(
480 events_discarded_field
, (int64_t) new_count
);
485 ret
= bt_ctf_field_unsigned_integer_set_value(
486 events_discarded_field
, new_count
);
493 bt_put(events_discarded_field
);
494 bt_put(events_discarded_field_type
);
497 int bt_ctf_stream_append_event(struct bt_ctf_stream
*stream
,
498 struct bt_ctf_event
*event
)
501 struct bt_ctf_field
*event_context_copy
= NULL
;
503 if (!stream
|| !event
) {
508 bt_object_set_parent(event
, stream
);
509 ret
= bt_ctf_event_populate_event_header(event
);
514 /* Make sure the event's payload is set */
515 ret
= bt_ctf_event_validate(event
);
520 /* Sample the current stream event context by copying it */
521 if (stream
->event_context
) {
522 /* Make sure the event context's payload is set */
523 ret
= bt_ctf_field_validate(stream
->event_context
);
528 event_context_copy
= bt_ctf_field_copy(stream
->event_context
);
529 if (!event_context_copy
) {
535 /* Save the new event along with its associated stream event context */
536 g_ptr_array_add(stream
->events
, event
);
537 if (event_context_copy
) {
538 g_ptr_array_add(stream
->event_contexts
, event_context_copy
);
541 * Event had to hold a reference to its event class as long as it wasn't
542 * part of the same trace hierarchy. From now on, the event and its
543 * class share the same lifetime guarantees and the reference is no
546 bt_put(event
->event_class
);
550 * Orphan the event; we were not succesful in associating it to
553 bt_object_set_parent(event
, NULL
);
558 struct bt_ctf_field
*bt_ctf_stream_get_packet_context(
559 struct bt_ctf_stream
*stream
)
561 struct bt_ctf_field
*packet_context
= NULL
;
567 packet_context
= stream
->packet_context
;
568 if (packet_context
) {
569 bt_get(packet_context
);
572 return packet_context
;
575 int bt_ctf_stream_set_packet_context(struct bt_ctf_stream
*stream
,
576 struct bt_ctf_field
*field
)
579 struct bt_ctf_field_type
*field_type
;
581 if (!stream
|| !field
) {
586 field_type
= bt_ctf_field_get_type(field
);
587 if (field_type
!= stream
->stream_class
->packet_context_type
) {
594 bt_put(stream
->packet_context
);
595 stream
->packet_context
= field
;
600 struct bt_ctf_field
*bt_ctf_stream_get_event_context(
601 struct bt_ctf_stream
*stream
)
603 struct bt_ctf_field
*event_context
= NULL
;
609 event_context
= stream
->event_context
;
611 bt_get(event_context
);
614 return event_context
;
617 int bt_ctf_stream_set_event_context(struct bt_ctf_stream
*stream
,
618 struct bt_ctf_field
*field
)
621 struct bt_ctf_field_type
*field_type
= NULL
;
623 if (!stream
|| !field
) {
628 field_type
= bt_ctf_field_get_type(field
);
629 if (field_type
!= stream
->stream_class
->event_context_type
) {
635 bt_put(stream
->event_context
);
636 stream
->event_context
= field
;
642 struct bt_ctf_field
*bt_ctf_stream_get_packet_header(
643 struct bt_ctf_stream
*stream
)
645 struct bt_ctf_field
*packet_header
= NULL
;
651 packet_header
= stream
->packet_header
;
653 bt_get(packet_header
);
656 return packet_header
;
659 int bt_ctf_stream_set_packet_header(struct bt_ctf_stream
*stream
,
660 struct bt_ctf_field
*field
)
663 struct bt_ctf_trace
*trace
= NULL
;
664 struct bt_ctf_field_type
*field_type
= NULL
;
666 if (!stream
|| !field
) {
671 trace
= (struct bt_ctf_trace
*) bt_object_get_parent(stream
);
672 field_type
= bt_ctf_field_get_type(field
);
673 if (field_type
!= trace
->packet_header_type
) {
679 bt_put(stream
->packet_header
);
680 stream
->packet_header
= field
;
688 int get_event_header_timestamp(struct bt_ctf_field
*event_header
, uint64_t *timestamp
)
691 struct bt_ctf_field
*timestamp_field
= NULL
;
692 struct bt_ctf_field_type
*timestamp_field_type
= NULL
;
694 timestamp_field
= bt_ctf_field_structure_get_field(event_header
,
696 if (!timestamp_field
) {
701 timestamp_field_type
= bt_ctf_field_get_type(timestamp_field
);
702 assert(timestamp_field_type
);
703 if (bt_ctf_field_type_get_type_id(timestamp_field_type
) !=
709 if (bt_ctf_field_type_integer_get_signed(timestamp_field_type
)) {
712 ret
= bt_ctf_field_signed_integer_get_value(timestamp_field
,
717 *timestamp
= (uint64_t) val
;
719 ret
= bt_ctf_field_unsigned_integer_get_value(timestamp_field
,
726 bt_put(timestamp_field
);
727 bt_put(timestamp_field_type
);
731 int bt_ctf_stream_flush(struct bt_ctf_stream
*stream
)
735 uint64_t timestamp_begin
, timestamp_end
, events_discarded
;
736 struct bt_ctf_field
*integer
= NULL
;
737 struct ctf_stream_pos packet_context_pos
;
739 if (!stream
|| stream
->pos
.fd
< 0) {
741 * Stream does not have an associated fd. It is,
742 * therefore, not a stream being used to write events.
748 if (!stream
->events
->len
) {
752 ret
= bt_ctf_field_validate(stream
->packet_header
);
757 /* mmap the next packet */
758 ctf_packet_seek(&stream
->pos
.parent
, 0, SEEK_CUR
);
760 ret
= bt_ctf_field_serialize(stream
->packet_header
, &stream
->pos
);
765 /* Set the default context attributes if present and unset. */
766 if (!get_event_header_timestamp(
767 ((struct bt_ctf_event
*) g_ptr_array_index(
768 stream
->events
, 0))->event_header
, ×tamp_begin
)) {
769 ret
= set_structure_field_integer(stream
->packet_context
,
770 "timestamp_begin", timestamp_begin
);
776 if (!get_event_header_timestamp(
777 ((struct bt_ctf_event
*) g_ptr_array_index(
778 stream
->events
, stream
->events
->len
- 1))->event_header
,
781 ret
= set_structure_field_integer(stream
->packet_context
,
782 "timestamp_end", timestamp_end
);
787 ret
= set_structure_field_integer(stream
->packet_context
,
788 "content_size", UINT64_MAX
);
793 ret
= set_structure_field_integer(stream
->packet_context
,
794 "packet_size", UINT64_MAX
);
799 /* Write packet context */
800 memcpy(&packet_context_pos
, &stream
->pos
,
801 sizeof(struct ctf_stream_pos
));
802 ret
= bt_ctf_field_serialize(stream
->packet_context
,
808 ret
= bt_ctf_stream_get_discarded_events_count(stream
,
814 /* Unset the packet context's fields. */
815 ret
= bt_ctf_field_reset(stream
->packet_context
);
820 /* Set the previous number of discarded events. */
821 ret
= set_structure_field_integer(stream
->packet_context
,
822 "events_discarded", events_discarded
);
827 for (i
= 0; i
< stream
->events
->len
; i
++) {
828 struct bt_ctf_event
*event
= g_ptr_array_index(
831 ret
= bt_ctf_field_reset(event
->event_header
);
836 /* Write event header */
837 ret
= bt_ctf_field_serialize(event
->event_header
,
843 /* Write stream event context */
844 if (stream
->event_contexts
) {
845 ret
= bt_ctf_field_serialize(
846 g_ptr_array_index(stream
->event_contexts
, i
),
853 /* Write event content */
854 ret
= bt_ctf_event_serialize(event
, &stream
->pos
);
861 * Update the packet total size and content size and overwrite the
863 * Copy base_mma as the packet may have been remapped (e.g. when a
864 * packet is resized).
866 packet_context_pos
.base_mma
= stream
->pos
.base_mma
;
867 ret
= set_structure_field_integer(stream
->packet_context
,
868 "content_size", stream
->pos
.offset
);
873 ret
= set_structure_field_integer(stream
->packet_context
,
874 "packet_size", stream
->pos
.packet_size
);
879 ret
= bt_ctf_field_serialize(stream
->packet_context
,
880 &packet_context_pos
);
885 g_ptr_array_set_size(stream
->events
, 0);
886 if (stream
->event_contexts
) {
887 g_ptr_array_set_size(stream
->event_contexts
, 0);
889 stream
->flushed_packet_count
++;
895 void bt_ctf_stream_get(struct bt_ctf_stream
*stream
)
900 void bt_ctf_stream_put(struct bt_ctf_stream
*stream
)
906 void bt_ctf_stream_destroy(struct bt_object
*obj
)
908 struct bt_ctf_stream
*stream
;
910 stream
= container_of(obj
, struct bt_ctf_stream
, base
);
911 ctf_fini_pos(&stream
->pos
);
912 if (stream
->pos
.fd
>= 0 && close(stream
->pos
.fd
)) {
916 if (stream
->events
) {
917 g_ptr_array_free(stream
->events
, TRUE
);
919 if (stream
->event_contexts
) {
920 g_ptr_array_free(stream
->event_contexts
, TRUE
);
922 bt_put(stream
->packet_header
);
923 bt_put(stream
->packet_context
);
924 bt_put(stream
->event_context
);
929 int set_structure_field_integer(struct bt_ctf_field
*structure
, char *name
,
933 struct bt_ctf_field_type
*field_type
= NULL
;
934 struct bt_ctf_field
*integer
=
935 bt_ctf_field_structure_get_field(structure
, name
);
937 if (!structure
|| !name
) {
943 /* Field not found, not an error. */
947 /* Make sure the payload has not already been set. */
948 if (!bt_ctf_field_validate(integer
)) {
949 /* Payload already set, not an error */
953 field_type
= bt_ctf_field_get_type(integer
);
954 /* Something is serioulsly wrong */
956 if (bt_ctf_field_type_get_type_id(field_type
) != CTF_TYPE_INTEGER
) {
958 * The user most likely meant for us to populate this field
959 * automatically. However, we can only do this if the field
960 * is an integer. Return an error.
966 if (bt_ctf_field_type_integer_get_signed(field_type
)) {
967 ret
= bt_ctf_field_signed_integer_set_value(integer
,
970 ret
= bt_ctf_field_unsigned_integer_set_value(integer
, value
);