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 and EOF if we didn't find any packet
104 * containing the timestamp.
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
);
121 while (cfs
->parent
.timestamp
< timestamp
) {
122 ret
= stream_read_event(cfs
);
132 * seek_ctf_trace_by_timestamp : for each file stream, seek to the event with
133 * the corresponding timestamp
135 * Return 0 on success.
136 * If the timestamp is not part of any file stream, return EOF to inform the
137 * user the timestamp is out of the scope
139 static int seek_ctf_trace_by_timestamp(struct ctf_trace
*tin
,
140 uint64_t timestamp
, struct ptr_heap
*stream_heap
)
145 /* for each stream_class */
146 for (i
= 0; i
< tin
->streams
->len
; i
++) {
147 struct ctf_stream_declaration
*stream_class
;
149 stream_class
= g_ptr_array_index(tin
->streams
, i
);
150 /* for each file_stream */
151 for (j
= 0; j
< stream_class
->streams
->len
; j
++) {
152 struct ctf_stream_definition
*stream
;
153 struct ctf_file_stream
*cfs
;
155 stream
= g_ptr_array_index(stream_class
->streams
, j
);
156 cfs
= container_of(stream
, struct ctf_file_stream
,
158 ret
= seek_file_stream_by_timestamp(cfs
, timestamp
);
161 ret
= heap_insert(stream_heap
, cfs
);
175 int bt_iter_set_pos(struct bt_iter
*iter
, const struct bt_iter_pos
*iter_pos
)
177 struct trace_collection
*tc
;
180 switch (iter_pos
->type
) {
181 case BT_SEEK_RESTORE
:
182 if (!iter_pos
->u
.restore
)
185 heap_free(iter
->stream_heap
);
186 ret
= heap_init(iter
->stream_heap
, 0, stream_compare
);
190 for (i
= 0; i
< iter_pos
->u
.restore
->stream_saved_pos
->len
;
192 struct stream_saved_pos
*saved_pos
;
193 struct ctf_stream_pos
*stream_pos
;
194 struct ctf_stream_definition
*stream
;
196 saved_pos
= &g_array_index(
197 iter_pos
->u
.restore
->stream_saved_pos
,
198 struct stream_saved_pos
, i
);
199 stream
= &saved_pos
->file_stream
->parent
;
200 stream_pos
= &saved_pos
->file_stream
->pos
;
202 stream_pos
->packet_seek(&stream_pos
->parent
,
203 saved_pos
->cur_index
, SEEK_SET
);
206 * the timestamp needs to be restored after
207 * packet_seek, because this function resets
208 * the timestamp to the beginning of the packet
210 stream
->timestamp
= saved_pos
->current_timestamp
;
211 stream_pos
->offset
= saved_pos
->offset
;
212 stream_pos
->last_offset
= saved_pos
->offset
;
214 stream
->prev_timestamp
= 0;
215 stream
->prev_timestamp_end
= 0;
216 stream
->consumed
= 0;
218 printf_debug("restored to cur_index = %zd and "
219 "offset = %zd, timestamp = %" PRIu64
"\n",
220 stream_pos
->cur_index
,
221 stream_pos
->offset
, stream
->timestamp
);
223 stream_read_event(saved_pos
->file_stream
);
226 ret
= heap_insert(iter
->stream_heap
,
227 saved_pos
->file_stream
);
234 heap_free(iter
->stream_heap
);
235 ret
= heap_init(iter
->stream_heap
, 0, stream_compare
);
239 /* for each trace in the trace_collection */
240 for (i
= 0; i
< tc
->array
->len
; i
++) {
241 struct ctf_trace
*tin
;
242 struct trace_descriptor
*td_read
;
244 td_read
= g_ptr_array_index(tc
->array
, i
);
245 tin
= container_of(td_read
, struct ctf_trace
, parent
);
247 ret
= seek_ctf_trace_by_timestamp(tin
,
248 iter_pos
->u
.seek_time
,
256 for (i
= 0; i
< tc
->array
->len
; i
++) {
257 struct ctf_trace
*tin
;
258 struct trace_descriptor
*td_read
;
261 td_read
= g_ptr_array_index(tc
->array
, i
);
262 tin
= container_of(td_read
, struct ctf_trace
, parent
);
264 /* Populate heap with each stream */
265 for (stream_id
= 0; stream_id
< tin
->streams
->len
;
267 struct ctf_stream_declaration
*stream
;
270 stream
= g_ptr_array_index(tin
->streams
,
274 for (filenr
= 0; filenr
< stream
->streams
->len
;
276 struct ctf_file_stream
*file_stream
;
277 file_stream
= g_ptr_array_index(
280 ret
= babeltrace_filestream_seek(
281 file_stream
, iter_pos
,
288 /* not implemented */
295 heap_free(iter
->stream_heap
);
296 if (heap_init(iter
->stream_heap
, 0, stream_compare
) < 0) {
297 heap_free(iter
->stream_heap
);
298 g_free(iter
->stream_heap
);
299 iter
->stream_heap
= NULL
;
305 struct bt_iter_pos
*bt_iter_get_pos(struct bt_iter
*iter
)
307 struct bt_iter_pos
*pos
;
308 struct trace_collection
*tc
= iter
->ctx
->tc
;
309 int i
, stream_class_id
, stream_id
;
311 pos
= g_new0(struct bt_iter_pos
, 1);
312 pos
->u
.restore
= g_new0(struct bt_saved_pos
, 1);
313 pos
->u
.restore
->tc
= tc
;
314 pos
->u
.restore
->stream_saved_pos
= g_array_new(FALSE
, TRUE
,
315 sizeof(struct stream_saved_pos
));
316 if (!pos
->u
.restore
->stream_saved_pos
)
319 for (i
= 0; i
< tc
->array
->len
; i
++) {
320 struct ctf_trace
*tin
;
321 struct trace_descriptor
*td_read
;
323 td_read
= g_ptr_array_index(tc
->array
, i
);
324 tin
= container_of(td_read
, struct ctf_trace
, parent
);
326 for (stream_class_id
= 0; stream_class_id
< tin
->streams
->len
;
328 struct ctf_stream_declaration
*stream_class
;
330 stream_class
= g_ptr_array_index(tin
->streams
,
333 stream_id
< stream_class
->streams
->len
;
335 struct ctf_stream_definition
*stream
;
336 struct ctf_file_stream
*cfs
;
337 struct stream_saved_pos saved_pos
;
339 stream
= g_ptr_array_index(
340 stream_class
->streams
,
342 cfs
= container_of(stream
,
343 struct ctf_file_stream
,
346 saved_pos
.file_stream
= cfs
;
347 saved_pos
.cur_index
= cfs
->pos
.cur_index
;
350 * It is possible that an event was read during
351 * the last restore, never consumed and its
352 * position saved again. For this case, we
353 * need to check if the event really was
354 * consumed by the caller otherwise it is lost.
356 if (stream
->consumed
)
357 saved_pos
.offset
= cfs
->pos
.offset
;
359 saved_pos
.offset
= cfs
->pos
.last_offset
;
361 saved_pos
.current_timestamp
= stream
->timestamp
;
364 pos
->u
.restore
->stream_saved_pos
,
367 printf_debug("stream : %" PRIu64
", cur_index : %zd, "
369 "timestamp = %" PRIu64
"\n",
370 stream
->stream_id
, saved_pos
.cur_index
,
372 saved_pos
.current_timestamp
);
383 struct bt_iter_pos
*bt_iter_create_time_pos(struct bt_iter
*iter
,
386 struct bt_iter_pos
*pos
;
388 pos
= g_new0(struct bt_iter_pos
, 1);
389 pos
->type
= BT_SEEK_TIME
;
390 pos
->u
.seek_time
= timestamp
;
395 * babeltrace_filestream_seek: seek a filestream to given position.
397 * The stream_id parameter is only useful for BT_SEEK_RESTORE.
399 static int babeltrace_filestream_seek(struct ctf_file_stream
*file_stream
,
400 const struct bt_iter_pos
*begin_pos
,
401 unsigned long stream_id
)
405 switch (begin_pos
->type
) {
408 * just insert into the heap we should already know
413 file_stream
->pos
.packet_seek(&file_stream
->pos
.parent
,
415 ret
= stream_read_event(file_stream
);
418 case BT_SEEK_RESTORE
:
421 assert(0); /* Not yet defined */
428 * bt_iter_seek: seek iterator to given position.
430 int bt_iter_seek(struct bt_iter
*iter
,
431 const struct bt_iter_pos
*begin_pos
)
435 struct trace_collection
*tc
= iter
->ctx
->tc
;
437 for (i
= 0; i
< tc
->array
->len
; i
++) {
438 struct ctf_trace
*tin
;
439 struct trace_descriptor
*td_read
;
441 td_read
= g_ptr_array_index(tc
->array
, i
);
442 tin
= container_of(td_read
, struct ctf_trace
, parent
);
444 /* Populate heap with each stream */
445 for (stream_id
= 0; stream_id
< tin
->streams
->len
;
447 struct ctf_stream_declaration
*stream
;
450 stream
= g_ptr_array_index(tin
->streams
, stream_id
);
451 for (filenr
= 0; filenr
< stream
->streams
->len
;
453 struct ctf_file_stream
*file_stream
;
455 file_stream
= g_ptr_array_index(stream
->streams
,
457 ret
= babeltrace_filestream_seek(file_stream
, begin_pos
,
468 int bt_iter_init(struct bt_iter
*iter
,
469 struct bt_context
*ctx
,
470 const struct bt_iter_pos
*begin_pos
,
471 const struct bt_iter_pos
*end_pos
)
476 if (ctx
->current_iterator
) {
481 iter
->stream_heap
= g_new(struct ptr_heap
, 1);
482 iter
->end_pos
= end_pos
;
486 ret
= heap_init(iter
->stream_heap
, 0, stream_compare
);
488 goto error_heap_init
;
490 for (i
= 0; i
< ctx
->tc
->array
->len
; i
++) {
491 struct ctf_trace
*tin
;
492 struct trace_descriptor
*td_read
;
494 td_read
= g_ptr_array_index(ctx
->tc
->array
, i
);
495 tin
= container_of(td_read
, struct ctf_trace
, parent
);
497 /* Populate heap with each stream */
498 for (stream_id
= 0; stream_id
< tin
->streams
->len
;
500 struct ctf_stream_declaration
*stream
;
503 stream
= g_ptr_array_index(tin
->streams
, stream_id
);
506 for (filenr
= 0; filenr
< stream
->streams
->len
;
508 struct ctf_file_stream
*file_stream
;
510 file_stream
= g_ptr_array_index(stream
->streams
,
514 ret
= babeltrace_filestream_seek(
519 struct bt_iter_pos pos
;
520 pos
.type
= BT_SEEK_BEGIN
;
521 ret
= babeltrace_filestream_seek(
532 ret
= heap_insert(iter
->stream_heap
, file_stream
);
539 ctx
->current_iterator
= iter
;
543 heap_free(iter
->stream_heap
);
545 g_free(iter
->stream_heap
);
550 struct bt_iter
*bt_iter_create(struct bt_context
*ctx
,
551 const struct bt_iter_pos
*begin_pos
,
552 const struct bt_iter_pos
*end_pos
)
554 struct bt_iter
*iter
;
557 iter
= g_new0(struct bt_iter
, 1);
558 ret
= bt_iter_init(iter
, ctx
, begin_pos
, end_pos
);
566 void bt_iter_fini(struct bt_iter
*iter
)
568 if (iter
->stream_heap
) {
569 heap_free(iter
->stream_heap
);
570 g_free(iter
->stream_heap
);
572 iter
->ctx
->current_iterator
= NULL
;
573 bt_context_put(iter
->ctx
);
576 void bt_iter_destroy(struct bt_iter
*iter
)
582 int bt_iter_next(struct bt_iter
*iter
)
584 struct ctf_file_stream
*file_stream
, *removed
;
587 file_stream
= heap_maximum(iter
->stream_heap
);
589 /* end of file for all streams */
594 ret
= stream_read_event(file_stream
);
596 removed
= heap_remove(iter
->stream_heap
);
597 assert(removed
== file_stream
);
603 /* Reinsert the file stream into the heap, and rebalance. */
604 removed
= heap_replace_max(iter
->stream_heap
, file_stream
);
605 assert(removed
== file_stream
);