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>
43 void bt_ctf_stream_destroy(struct bt_ctf_ref
*ref
);
45 int set_structure_field_integer(struct bt_ctf_field
*, char *, uint64_t);
48 struct bt_ctf_stream
*bt_ctf_stream_create(
49 struct bt_ctf_stream_class
*stream_class
)
52 struct bt_ctf_stream
*stream
= NULL
;
58 stream
= g_new0(struct bt_ctf_stream
, 1);
63 bt_ctf_ref_init(&stream
->ref_count
);
64 stream
->packet_context
= bt_ctf_field_create(
65 stream_class
->packet_context_type
);
66 if (!stream
->packet_context
) {
71 * A stream class may not have a stream event context defined
72 * in which case this stream will never have a stream_event_context
73 * member since, after a stream's creation, the parent stream class
74 * is "frozen" (immutable).
76 if (stream_class
->event_context_type
) {
77 stream
->event_context
= bt_ctf_field_create(
78 stream_class
->event_context_type
);
79 if (!stream
->packet_context
) {
84 /* Initialize events_discarded */
85 ret
= set_structure_field_integer(stream
->packet_context
,
86 "events_discarded", 0);
92 stream
->id
= stream_class
->next_stream_id
++;
93 stream
->stream_class
= stream_class
;
94 bt_ctf_stream_class_get(stream_class
);
95 bt_ctf_stream_class_freeze(stream_class
);
96 stream
->events
= g_ptr_array_new_with_free_func(
97 (GDestroyNotify
)bt_ctf_event_put
);
101 bt_ctf_stream_destroy(&stream
->ref_count
);
106 int bt_ctf_stream_set_flush_callback(struct bt_ctf_stream
*stream
,
107 flush_func callback
, void *data
)
109 int ret
= stream
? 0 : -1;
115 stream
->flush
.func
= callback
;
116 stream
->flush
.data
= data
;
122 int bt_ctf_stream_set_fd(struct bt_ctf_stream
*stream
, int fd
)
126 if (stream
->pos
.fd
!= -1) {
131 ctf_init_pos(&stream
->pos
, NULL
, fd
, O_RDWR
);
137 int bt_ctf_stream_get_discarded_events_count(
138 struct bt_ctf_stream
*stream
, uint64_t *count
)
142 struct bt_ctf_field
*events_discarded_field
= NULL
;
143 struct bt_ctf_field_type
*events_discarded_field_type
= NULL
;
145 if (!stream
|| !count
|| !stream
->packet_context
) {
150 events_discarded_field
= bt_ctf_field_structure_get_field(
151 stream
->packet_context
, "events_discarded");
152 if (!events_discarded_field
) {
157 events_discarded_field_type
= bt_ctf_field_get_type(
158 events_discarded_field
);
159 if (!events_discarded_field_type
) {
164 field_signed
= bt_ctf_field_type_integer_get_signed(
165 events_discarded_field_type
);
166 if (field_signed
< 0) {
172 int64_t signed_count
;
174 ret
= bt_ctf_field_signed_integer_get_value(
175 events_discarded_field
, &signed_count
);
179 if (signed_count
< 0) {
184 *count
= (uint64_t) signed_count
;
186 ret
= bt_ctf_field_unsigned_integer_get_value(
187 events_discarded_field
, count
);
193 if (events_discarded_field
) {
194 bt_ctf_field_put(events_discarded_field
);
196 if (events_discarded_field_type
) {
197 bt_ctf_field_type_put(events_discarded_field_type
);
202 void bt_ctf_stream_append_discarded_events(struct bt_ctf_stream
*stream
,
203 uint64_t event_count
)
207 uint64_t previous_count
;
209 struct bt_ctf_field
*events_discarded_field
= NULL
;
210 struct bt_ctf_field_type
*events_discarded_field_type
= NULL
;
212 if (!stream
|| !stream
->packet_context
) {
216 ret
= bt_ctf_stream_get_discarded_events_count(stream
,
222 events_discarded_field
= bt_ctf_field_structure_get_field(
223 stream
->packet_context
, "events_discarded");
224 if (!events_discarded_field
) {
228 events_discarded_field_type
= bt_ctf_field_get_type(
229 events_discarded_field
);
230 if (!events_discarded_field_type
) {
234 field_signed
= bt_ctf_field_type_integer_get_signed(
235 events_discarded_field_type
);
236 if (field_signed
< 0) {
240 new_count
= previous_count
+ event_count
;
242 ret
= bt_ctf_field_signed_integer_set_value(
243 events_discarded_field
, (int64_t) new_count
);
248 ret
= bt_ctf_field_unsigned_integer_set_value(
249 events_discarded_field
, new_count
);
256 if (events_discarded_field
) {
257 bt_ctf_field_put(events_discarded_field
);
259 if (events_discarded_field_type
) {
260 bt_ctf_field_type_put(events_discarded_field_type
);
264 int bt_ctf_stream_append_event(struct bt_ctf_stream
*stream
,
265 struct bt_ctf_event
*event
)
269 struct bt_ctf_field
*event_context_copy
= NULL
;
271 if (!stream
|| !event
) {
276 ret
= bt_ctf_event_validate(event
);
281 timestamp
= bt_ctf_clock_get_time(stream
->stream_class
->clock
);
282 ret
= bt_ctf_event_set_timestamp(event
, timestamp
);
287 bt_ctf_event_get(event
);
288 g_ptr_array_add(stream
->events
, event
);
293 struct bt_ctf_field
*bt_ctf_stream_get_packet_context(
294 struct bt_ctf_stream
*stream
)
296 struct bt_ctf_field
*packet_context
= NULL
;
302 packet_context
= stream
->packet_context
;
304 if (packet_context
) {
305 bt_ctf_field_get(packet_context
);
307 return packet_context
;
310 int bt_ctf_stream_set_packet_context(struct bt_ctf_stream
*stream
,
311 struct bt_ctf_field
*field
)
314 struct bt_ctf_field_type
*field_type
;
316 if (!stream
|| !field
) {
321 field_type
= bt_ctf_field_get_type(field
);
322 if (field_type
!= stream
->stream_class
->packet_context_type
) {
327 bt_ctf_field_type_put(field_type
);
328 bt_ctf_field_get(field
);
329 bt_ctf_field_put(stream
->packet_context
);
330 stream
->packet_context
= field
;
335 int bt_ctf_stream_flush(struct bt_ctf_stream
*stream
)
339 uint64_t timestamp_begin
, timestamp_end
, events_discarded
;
340 struct bt_ctf_stream_class
*stream_class
;
341 struct bt_ctf_field
*integer
= NULL
;
342 struct ctf_stream_pos packet_context_pos
;
344 if (!stream
|| stream
->pos
.fd
< 0) {
346 * Stream does not have an associated fd. It is,
347 * therefore, not a stream being used to write events.
353 if (!stream
->events
->len
) {
357 if (stream
->flush
.func
) {
358 stream
->flush
.func(stream
, stream
->flush
.data
);
361 stream_class
= stream
->stream_class
;
362 timestamp_begin
= ((struct bt_ctf_event
*) g_ptr_array_index(
363 stream
->events
, 0))->timestamp
;
364 timestamp_end
= ((struct bt_ctf_event
*) g_ptr_array_index(
365 stream
->events
, stream
->events
->len
- 1))->timestamp
;
367 /* Set the default context attributes if present and unset. */
368 ret
= set_structure_field_integer(stream
->packet_context
,
369 "timestamp_begin", timestamp_begin
);
374 ret
= set_structure_field_integer(stream
->packet_context
,
375 "timestamp_end", timestamp_end
);
380 ret
= set_structure_field_integer(stream
->packet_context
,
381 "content_size", UINT64_MAX
);
386 ret
= set_structure_field_integer(stream
->packet_context
,
387 "packet_size", UINT64_MAX
);
392 /* Write packet context */
393 memcpy(&packet_context_pos
, &stream
->pos
,
394 sizeof(struct ctf_stream_pos
));
395 ret
= bt_ctf_field_serialize(stream
->packet_context
,
401 ret
= bt_ctf_stream_get_discarded_events_count(stream
,
407 /* Unset the packet context's fields. */
408 ret
= bt_ctf_field_reset(stream
->packet_context
);
413 /* Set the previous number of discarded events. */
414 ret
= set_structure_field_integer(stream
->packet_context
,
415 "events_discarded", events_discarded
);
420 for (i
= 0; i
< stream
->events
->len
; i
++) {
421 struct bt_ctf_event
*event
= g_ptr_array_index(
423 uint32_t event_id
= bt_ctf_event_class_get_id(
425 uint64_t timestamp
= bt_ctf_event_get_timestamp(event
);
427 ret
= bt_ctf_field_reset(stream_class
->event_header
);
432 ret
= set_structure_field_integer(stream_class
->event_header
,
437 ret
= set_structure_field_integer(stream_class
->event_header
,
438 "timestamp", timestamp
);
443 /* Write event header */
444 ret
= bt_ctf_field_serialize(stream_class
->event_header
,
450 /* Write event content */
451 ret
= bt_ctf_event_serialize(event
, &stream
->pos
);
458 * Update the packet total size and content size and overwrite the
460 * Copy base_mma as the packet may have been remapped (e.g. when a
461 * packet is resized).
463 packet_context_pos
.base_mma
= stream
->pos
.base_mma
;
464 ret
= set_structure_field_integer(stream
->packet_context
,
465 "content_size", stream
->pos
.offset
);
470 ret
= set_structure_field_integer(stream
->packet_context
,
471 "packet_size", stream
->pos
.packet_size
);
476 ret
= bt_ctf_field_serialize(stream
->packet_context
,
477 &packet_context_pos
);
482 g_ptr_array_set_size(stream
->events
, 0);
483 stream
->flushed_packet_count
++;
485 bt_ctf_field_put(integer
);
489 void bt_ctf_stream_get(struct bt_ctf_stream
*stream
)
495 bt_ctf_ref_get(&stream
->ref_count
);
498 void bt_ctf_stream_put(struct bt_ctf_stream
*stream
)
504 bt_ctf_ref_put(&stream
->ref_count
, bt_ctf_stream_destroy
);
508 void bt_ctf_stream_destroy(struct bt_ctf_ref
*ref
)
510 struct bt_ctf_stream
*stream
;
516 stream
= container_of(ref
, struct bt_ctf_stream
, ref_count
);
517 ctf_fini_pos(&stream
->pos
);
518 if (close(stream
->pos
.fd
)) {
522 if (stream
->stream_class
) {
523 bt_ctf_stream_class_put(stream
->stream_class
);
525 if (stream
->events
) {
526 g_ptr_array_free(stream
->events
, TRUE
);
528 if (stream
->packet_context
) {
529 bt_ctf_field_put(stream
->packet_context
);
535 int set_structure_field_integer(struct bt_ctf_field
*structure
, char *name
,
539 struct bt_ctf_field
*integer
=
540 bt_ctf_field_structure_get_field(structure
, name
);
542 if (!structure
|| !name
) {
548 /* Field not found, not an error. */
552 /* Make sure the payload has not already been set. */
553 if (!bt_ctf_field_validate(integer
)) {
554 /* Payload already set, not an error */
558 ret
= bt_ctf_field_unsigned_integer_set_value(integer
, value
);
560 bt_ctf_field_put(integer
);