6 * Copyright 2010-2011 EfficiOS Inc. and Linux Foundation
8 * Author: Mathieu Desnoyers <mathieu.desnoyers@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.
22 #include <babeltrace/babeltrace.h>
23 #include <babeltrace/context.h>
24 #include <babeltrace/context-internal.h>
25 #include <babeltrace/iterator-internal.h>
26 #include <babeltrace/iterator.h>
27 #include <babeltrace/prio_heap.h>
28 #include <babeltrace/ctf/metadata.h>
29 #include <babeltrace/ctf/events.h>
32 static int babeltrace_filestream_seek(struct ctf_file_stream
*file_stream
,
33 const struct bt_iter_pos
*begin_pos
,
34 unsigned long stream_id
);
36 struct stream_saved_pos
{
38 * Use file_stream pointer to check if the trace collection we
39 * restore to match the one we saved from, for each stream.
41 struct ctf_file_stream
*file_stream
;
42 size_t cur_index
; /* current index in packet index */
43 ssize_t offset
; /* offset from base, in bits. EOF for end of file. */
44 uint64_t current_timestamp
;
48 struct trace_collection
*tc
;
49 GArray
*stream_saved_pos
; /* Contains struct stream_saved_pos */
52 static int stream_read_event(struct ctf_file_stream
*sin
)
56 ret
= sin
->pos
.parent
.event_cb(&sin
->pos
.parent
, &sin
->parent
);
60 fprintf(stderr
, "[error] Reading event failed.\n");
67 * returns true if a < b, false otherwise.
69 int stream_compare(void *a
, void *b
)
71 struct ctf_file_stream
*s_a
= a
, *s_b
= b
;
73 if (s_a
->parent
.timestamp
< s_b
->parent
.timestamp
)
79 void bt_iter_free_pos(struct bt_iter_pos
*iter_pos
)
84 if (iter_pos
->u
.restore
) {
85 if (iter_pos
->u
.restore
->stream_saved_pos
) {
87 iter_pos
->u
.restore
->stream_saved_pos
,
90 g_free(iter_pos
->u
.restore
);
96 * seek_file_stream_by_timestamp
98 * Browse a filestream by index, if an index contains the timestamp passed in
99 * argument, seek inside the corresponding packet it until we find the event we
100 * are looking for (either the exact timestamp or the event just after the
103 * Return 0 if the seek succeded, EOF if we didn't find any packet
104 * containing the timestamp, or a positive integer for error.
106 static int seek_file_stream_by_timestamp(struct ctf_file_stream
*cfs
,
109 struct ctf_stream_pos
*stream_pos
;
110 struct packet_index
*index
;
113 stream_pos
= &cfs
->pos
;
114 for (i
= 0; i
< stream_pos
->packet_index
->len
; i
++) {
115 index
= &g_array_index(stream_pos
->packet_index
,
116 struct packet_index
, i
);
117 if (index
->timestamp_end
< timestamp
)
120 stream_pos
->packet_seek(&stream_pos
->parent
, i
, SEEK_SET
);
122 ret
= stream_read_event(cfs
);
123 } while (cfs
->parent
.timestamp
< timestamp
&& ret
== 0);
125 /* Can return either EOF, 0, or error (> 0). */
129 * Cannot find the timestamp within the stream packets, return
136 * seek_ctf_trace_by_timestamp : for each file stream, seek to the event with
137 * the corresponding timestamp
139 * Return 0 on success.
140 * If the timestamp is not part of any file stream, return EOF to inform the
141 * user the timestamp is out of the scope.
142 * On other errors, return positive value.
144 static int seek_ctf_trace_by_timestamp(struct ctf_trace
*tin
,
145 uint64_t timestamp
, struct ptr_heap
*stream_heap
)
150 /* for each stream_class */
151 for (i
= 0; i
< tin
->streams
->len
; i
++) {
152 struct ctf_stream_declaration
*stream_class
;
154 stream_class
= g_ptr_array_index(tin
->streams
, i
);
157 /* for each file_stream */
158 for (j
= 0; j
< stream_class
->streams
->len
; j
++) {
159 struct ctf_stream_definition
*stream
;
160 struct ctf_file_stream
*cfs
;
162 stream
= g_ptr_array_index(stream_class
->streams
, j
);
165 cfs
= container_of(stream
, struct ctf_file_stream
,
167 ret
= seek_file_stream_by_timestamp(cfs
, timestamp
);
170 ret
= heap_insert(stream_heap
, cfs
);
172 /* Return positive error. */
176 } else if (ret
> 0) {
178 * Error in seek (not EOF), failure.
182 /* on EOF just do not put stream into heap. */
186 return found
? 0 : EOF
;
189 int bt_iter_set_pos(struct bt_iter
*iter
, const struct bt_iter_pos
*iter_pos
)
191 struct trace_collection
*tc
;
194 switch (iter_pos
->type
) {
195 case BT_SEEK_RESTORE
:
196 if (!iter_pos
->u
.restore
)
199 heap_free(iter
->stream_heap
);
200 ret
= heap_init(iter
->stream_heap
, 0, stream_compare
);
204 for (i
= 0; i
< iter_pos
->u
.restore
->stream_saved_pos
->len
;
206 struct stream_saved_pos
*saved_pos
;
207 struct ctf_stream_pos
*stream_pos
;
208 struct ctf_stream_definition
*stream
;
210 saved_pos
= &g_array_index(
211 iter_pos
->u
.restore
->stream_saved_pos
,
212 struct stream_saved_pos
, i
);
213 stream
= &saved_pos
->file_stream
->parent
;
214 stream_pos
= &saved_pos
->file_stream
->pos
;
216 stream_pos
->packet_seek(&stream_pos
->parent
,
217 saved_pos
->cur_index
, SEEK_SET
);
220 * the timestamp needs to be restored after
221 * packet_seek, because this function resets
222 * the timestamp to the beginning of the packet
224 stream
->timestamp
= saved_pos
->current_timestamp
;
225 stream_pos
->offset
= saved_pos
->offset
;
226 stream_pos
->last_offset
= saved_pos
->offset
;
228 stream
->prev_timestamp
= 0;
229 stream
->prev_timestamp_end
= 0;
230 stream
->consumed
= 0;
232 printf_debug("restored to cur_index = %zd and "
233 "offset = %zd, timestamp = %" PRIu64
"\n",
234 stream_pos
->cur_index
,
235 stream_pos
->offset
, stream
->timestamp
);
237 stream_read_event(saved_pos
->file_stream
);
240 ret
= heap_insert(iter
->stream_heap
,
241 saved_pos
->file_stream
);
248 heap_free(iter
->stream_heap
);
249 ret
= heap_init(iter
->stream_heap
, 0, stream_compare
);
253 /* for each trace in the trace_collection */
254 for (i
= 0; i
< tc
->array
->len
; i
++) {
255 struct ctf_trace
*tin
;
256 struct trace_descriptor
*td_read
;
258 td_read
= g_ptr_array_index(tc
->array
, i
);
261 tin
= container_of(td_read
, struct ctf_trace
, parent
);
263 ret
= seek_ctf_trace_by_timestamp(tin
,
264 iter_pos
->u
.seek_time
,
267 * Positive errors are failure. Negative value
268 * is EOF (for which we continue with other
269 * traces). 0 is success. Note: on EOF, it just
270 * means that no stream has been added to the
271 * iterator for that trace, which is fine.
273 if (ret
!= 0 && ret
!= EOF
)
279 for (i
= 0; i
< tc
->array
->len
; i
++) {
280 struct ctf_trace
*tin
;
281 struct trace_descriptor
*td_read
;
284 td_read
= g_ptr_array_index(tc
->array
, i
);
287 tin
= container_of(td_read
, struct ctf_trace
, parent
);
289 /* Populate heap with each stream */
290 for (stream_id
= 0; stream_id
< tin
->streams
->len
;
292 struct ctf_stream_declaration
*stream
;
295 stream
= g_ptr_array_index(tin
->streams
,
299 for (filenr
= 0; filenr
< stream
->streams
->len
;
301 struct ctf_file_stream
*file_stream
;
302 file_stream
= g_ptr_array_index(
307 ret
= babeltrace_filestream_seek(
308 file_stream
, iter_pos
,
310 if (ret
!= 0 && ret
!= EOF
) {
318 /* not implemented */
325 heap_free(iter
->stream_heap
);
326 if (heap_init(iter
->stream_heap
, 0, stream_compare
) < 0) {
327 heap_free(iter
->stream_heap
);
328 g_free(iter
->stream_heap
);
329 iter
->stream_heap
= NULL
;
335 struct bt_iter_pos
*bt_iter_get_pos(struct bt_iter
*iter
)
337 struct bt_iter_pos
*pos
;
338 struct trace_collection
*tc
= iter
->ctx
->tc
;
339 int i
, stream_class_id
, stream_id
;
341 pos
= g_new0(struct bt_iter_pos
, 1);
342 pos
->u
.restore
= g_new0(struct bt_saved_pos
, 1);
343 pos
->u
.restore
->tc
= tc
;
344 pos
->u
.restore
->stream_saved_pos
= g_array_new(FALSE
, TRUE
,
345 sizeof(struct stream_saved_pos
));
346 if (!pos
->u
.restore
->stream_saved_pos
)
349 for (i
= 0; i
< tc
->array
->len
; i
++) {
350 struct ctf_trace
*tin
;
351 struct trace_descriptor
*td_read
;
353 td_read
= g_ptr_array_index(tc
->array
, i
);
356 tin
= container_of(td_read
, struct ctf_trace
, parent
);
358 for (stream_class_id
= 0; stream_class_id
< tin
->streams
->len
;
360 struct ctf_stream_declaration
*stream_class
;
362 stream_class
= g_ptr_array_index(tin
->streams
,
367 stream_id
< stream_class
->streams
->len
;
369 struct ctf_stream_definition
*stream
;
370 struct ctf_file_stream
*cfs
;
371 struct stream_saved_pos saved_pos
;
373 stream
= g_ptr_array_index(
374 stream_class
->streams
,
378 cfs
= container_of(stream
,
379 struct ctf_file_stream
,
382 saved_pos
.file_stream
= cfs
;
383 saved_pos
.cur_index
= cfs
->pos
.cur_index
;
386 * It is possible that an event was read during
387 * the last restore, never consumed and its
388 * position saved again. For this case, we
389 * need to check if the event really was
390 * consumed by the caller otherwise it is lost.
392 if (stream
->consumed
)
393 saved_pos
.offset
= cfs
->pos
.offset
;
395 saved_pos
.offset
= cfs
->pos
.last_offset
;
397 saved_pos
.current_timestamp
= stream
->timestamp
;
400 pos
->u
.restore
->stream_saved_pos
,
403 printf_debug("stream : %" PRIu64
", cur_index : %zd, "
405 "timestamp = %" PRIu64
"\n",
406 stream
->stream_id
, saved_pos
.cur_index
,
408 saved_pos
.current_timestamp
);
419 struct bt_iter_pos
*bt_iter_create_time_pos(struct bt_iter
*iter
,
422 struct bt_iter_pos
*pos
;
424 pos
= g_new0(struct bt_iter_pos
, 1);
425 pos
->type
= BT_SEEK_TIME
;
426 pos
->u
.seek_time
= timestamp
;
431 * babeltrace_filestream_seek: seek a filestream to given position.
433 * The stream_id parameter is only useful for BT_SEEK_RESTORE.
435 static int babeltrace_filestream_seek(struct ctf_file_stream
*file_stream
,
436 const struct bt_iter_pos
*begin_pos
,
437 unsigned long stream_id
)
441 switch (begin_pos
->type
) {
444 * just insert into the heap we should already know
449 file_stream
->pos
.packet_seek(&file_stream
->pos
.parent
,
451 ret
= stream_read_event(file_stream
);
454 case BT_SEEK_RESTORE
:
457 assert(0); /* Not yet defined */
464 * bt_iter_seek: seek iterator to given position.
466 int bt_iter_seek(struct bt_iter
*iter
,
467 const struct bt_iter_pos
*begin_pos
)
471 struct trace_collection
*tc
= iter
->ctx
->tc
;
473 for (i
= 0; i
< tc
->array
->len
; i
++) {
474 struct ctf_trace
*tin
;
475 struct trace_descriptor
*td_read
;
477 td_read
= g_ptr_array_index(tc
->array
, i
);
480 tin
= container_of(td_read
, struct ctf_trace
, parent
);
482 /* Populate heap with each stream */
483 for (stream_id
= 0; stream_id
< tin
->streams
->len
;
485 struct ctf_stream_declaration
*stream
;
488 stream
= g_ptr_array_index(tin
->streams
, stream_id
);
491 for (filenr
= 0; filenr
< stream
->streams
->len
;
493 struct ctf_file_stream
*file_stream
;
495 file_stream
= g_ptr_array_index(stream
->streams
,
499 ret
= babeltrace_filestream_seek(file_stream
, begin_pos
,
510 int bt_iter_init(struct bt_iter
*iter
,
511 struct bt_context
*ctx
,
512 const struct bt_iter_pos
*begin_pos
,
513 const struct bt_iter_pos
*end_pos
)
518 if (ctx
->current_iterator
) {
523 iter
->stream_heap
= g_new(struct ptr_heap
, 1);
524 iter
->end_pos
= end_pos
;
528 ret
= heap_init(iter
->stream_heap
, 0, stream_compare
);
530 goto error_heap_init
;
532 for (i
= 0; i
< ctx
->tc
->array
->len
; i
++) {
533 struct ctf_trace
*tin
;
534 struct trace_descriptor
*td_read
;
536 td_read
= g_ptr_array_index(ctx
->tc
->array
, i
);
539 tin
= container_of(td_read
, struct ctf_trace
, parent
);
541 /* Populate heap with each stream */
542 for (stream_id
= 0; stream_id
< tin
->streams
->len
;
544 struct ctf_stream_declaration
*stream
;
547 stream
= g_ptr_array_index(tin
->streams
, stream_id
);
550 for (filenr
= 0; filenr
< stream
->streams
->len
;
552 struct ctf_file_stream
*file_stream
;
554 file_stream
= g_ptr_array_index(stream
->streams
,
559 ret
= babeltrace_filestream_seek(
564 struct bt_iter_pos pos
;
565 pos
.type
= BT_SEEK_BEGIN
;
566 ret
= babeltrace_filestream_seek(
577 ret
= heap_insert(iter
->stream_heap
, file_stream
);
584 ctx
->current_iterator
= iter
;
588 heap_free(iter
->stream_heap
);
590 g_free(iter
->stream_heap
);
595 struct bt_iter
*bt_iter_create(struct bt_context
*ctx
,
596 const struct bt_iter_pos
*begin_pos
,
597 const struct bt_iter_pos
*end_pos
)
599 struct bt_iter
*iter
;
602 iter
= g_new0(struct bt_iter
, 1);
603 ret
= bt_iter_init(iter
, ctx
, begin_pos
, end_pos
);
611 void bt_iter_fini(struct bt_iter
*iter
)
613 if (iter
->stream_heap
) {
614 heap_free(iter
->stream_heap
);
615 g_free(iter
->stream_heap
);
617 iter
->ctx
->current_iterator
= NULL
;
618 bt_context_put(iter
->ctx
);
621 void bt_iter_destroy(struct bt_iter
*iter
)
627 int bt_iter_next(struct bt_iter
*iter
)
629 struct ctf_file_stream
*file_stream
, *removed
;
632 file_stream
= heap_maximum(iter
->stream_heap
);
634 /* end of file for all streams */
639 ret
= stream_read_event(file_stream
);
641 removed
= heap_remove(iter
->stream_heap
);
642 assert(removed
== file_stream
);
648 /* Reinsert the file stream into the heap, and rebalance. */
649 removed
= heap_replace_max(iter
->stream_heap
, file_stream
);
650 assert(removed
== file_stream
);