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
->type
== BT_SEEK_RESTORE
&& 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
);
202 goto error_heap_init
;
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
= LAST_OFFSET_POISON
;
228 stream
->prev_timestamp
= 0;
229 stream
->prev_timestamp_end
= 0;
231 printf_debug("restored to cur_index = %zd and "
232 "offset = %zd, timestamp = %" PRIu64
"\n",
233 stream_pos
->cur_index
,
234 stream_pos
->offset
, stream
->timestamp
);
236 stream_read_event(saved_pos
->file_stream
);
239 ret
= heap_insert(iter
->stream_heap
,
240 saved_pos
->file_stream
);
248 heap_free(iter
->stream_heap
);
249 ret
= heap_init(iter
->stream_heap
, 0, stream_compare
);
251 goto error_heap_init
;
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 heap_free(iter
->stream_heap
);
280 ret
= heap_init(iter
->stream_heap
, 0, stream_compare
);
282 goto error_heap_init
;
284 for (i
= 0; i
< tc
->array
->len
; i
++) {
285 struct ctf_trace
*tin
;
286 struct trace_descriptor
*td_read
;
289 td_read
= g_ptr_array_index(tc
->array
, i
);
292 tin
= container_of(td_read
, struct ctf_trace
, parent
);
294 /* Populate heap with each stream */
295 for (stream_id
= 0; stream_id
< tin
->streams
->len
;
297 struct ctf_stream_declaration
*stream
;
300 stream
= g_ptr_array_index(tin
->streams
,
304 for (filenr
= 0; filenr
< stream
->streams
->len
;
306 struct ctf_file_stream
*file_stream
;
307 file_stream
= g_ptr_array_index(
312 ret
= babeltrace_filestream_seek(
313 file_stream
, iter_pos
,
315 if (ret
!= 0 && ret
!= EOF
) {
318 ret
= heap_insert(iter
->stream_heap
, file_stream
);
326 /* not implemented */
333 heap_free(iter
->stream_heap
);
335 if (heap_init(iter
->stream_heap
, 0, stream_compare
) < 0) {
336 heap_free(iter
->stream_heap
);
337 g_free(iter
->stream_heap
);
338 iter
->stream_heap
= NULL
;
345 struct bt_iter_pos
*bt_iter_get_pos(struct bt_iter
*iter
)
347 struct bt_iter_pos
*pos
;
348 struct trace_collection
*tc
= iter
->ctx
->tc
;
349 struct ctf_file_stream
*file_stream
= NULL
, *removed
;
350 struct ptr_heap iter_heap_copy
;
353 pos
= g_new0(struct bt_iter_pos
, 1);
354 pos
->type
= BT_SEEK_RESTORE
;
355 pos
->u
.restore
= g_new0(struct bt_saved_pos
, 1);
356 pos
->u
.restore
->tc
= tc
;
357 pos
->u
.restore
->stream_saved_pos
= g_array_new(FALSE
, TRUE
,
358 sizeof(struct stream_saved_pos
));
359 if (!pos
->u
.restore
->stream_saved_pos
)
362 ret
= heap_copy(&iter_heap_copy
, iter
->stream_heap
);
366 /* iterate over each stream in the heap */
367 file_stream
= heap_maximum(&iter_heap_copy
);
368 while (file_stream
!= NULL
) {
369 struct stream_saved_pos saved_pos
;
371 assert(file_stream
->pos
.last_offset
!= LAST_OFFSET_POISON
);
372 saved_pos
.offset
= file_stream
->pos
.last_offset
;
373 saved_pos
.file_stream
= file_stream
;
374 saved_pos
.cur_index
= file_stream
->pos
.cur_index
;
376 saved_pos
.current_timestamp
= file_stream
->parent
.timestamp
;
379 pos
->u
.restore
->stream_saved_pos
,
382 printf_debug("stream : %" PRIu64
", cur_index : %zd, "
384 "timestamp = %" PRIu64
"\n",
385 file_stream
->parent
.stream_id
,
386 saved_pos
.cur_index
, saved_pos
.offset
,
387 saved_pos
.current_timestamp
);
389 /* remove the stream from the heap copy */
390 removed
= heap_remove(&iter_heap_copy
);
391 assert(removed
== file_stream
);
393 file_stream
= heap_maximum(&iter_heap_copy
);
395 heap_free(&iter_heap_copy
);
399 g_array_free(pos
->u
.restore
->stream_saved_pos
, TRUE
);
405 struct bt_iter_pos
*bt_iter_create_time_pos(struct bt_iter
*iter
,
408 struct bt_iter_pos
*pos
;
410 pos
= g_new0(struct bt_iter_pos
, 1);
411 pos
->type
= BT_SEEK_TIME
;
412 pos
->u
.seek_time
= timestamp
;
417 * babeltrace_filestream_seek: seek a filestream to given position.
419 * The stream_id parameter is only useful for BT_SEEK_RESTORE.
421 static int babeltrace_filestream_seek(struct ctf_file_stream
*file_stream
,
422 const struct bt_iter_pos
*begin_pos
,
423 unsigned long stream_id
)
427 switch (begin_pos
->type
) {
430 * just insert into the heap we should already know
435 file_stream
->pos
.packet_seek(&file_stream
->pos
.parent
,
437 ret
= stream_read_event(file_stream
);
440 case BT_SEEK_RESTORE
:
443 assert(0); /* Not yet defined */
449 int bt_iter_init(struct bt_iter
*iter
,
450 struct bt_context
*ctx
,
451 const struct bt_iter_pos
*begin_pos
,
452 const struct bt_iter_pos
*end_pos
)
457 if (ctx
->current_iterator
) {
462 iter
->stream_heap
= g_new(struct ptr_heap
, 1);
463 iter
->end_pos
= end_pos
;
467 ret
= heap_init(iter
->stream_heap
, 0, stream_compare
);
469 goto error_heap_init
;
471 for (i
= 0; i
< ctx
->tc
->array
->len
; i
++) {
472 struct ctf_trace
*tin
;
473 struct trace_descriptor
*td_read
;
475 td_read
= g_ptr_array_index(ctx
->tc
->array
, i
);
478 tin
= container_of(td_read
, struct ctf_trace
, parent
);
480 /* Populate heap with each stream */
481 for (stream_id
= 0; stream_id
< tin
->streams
->len
;
483 struct ctf_stream_declaration
*stream
;
486 stream
= g_ptr_array_index(tin
->streams
, stream_id
);
489 for (filenr
= 0; filenr
< stream
->streams
->len
;
491 struct ctf_file_stream
*file_stream
;
493 file_stream
= g_ptr_array_index(stream
->streams
,
498 ret
= babeltrace_filestream_seek(
503 struct bt_iter_pos pos
;
504 pos
.type
= BT_SEEK_BEGIN
;
505 ret
= babeltrace_filestream_seek(
516 ret
= heap_insert(iter
->stream_heap
, file_stream
);
523 ctx
->current_iterator
= iter
;
527 heap_free(iter
->stream_heap
);
529 g_free(iter
->stream_heap
);
530 iter
->stream_heap
= NULL
;
535 struct bt_iter
*bt_iter_create(struct bt_context
*ctx
,
536 const struct bt_iter_pos
*begin_pos
,
537 const struct bt_iter_pos
*end_pos
)
539 struct bt_iter
*iter
;
542 iter
= g_new0(struct bt_iter
, 1);
543 ret
= bt_iter_init(iter
, ctx
, begin_pos
, end_pos
);
551 void bt_iter_fini(struct bt_iter
*iter
)
553 if (iter
->stream_heap
) {
554 heap_free(iter
->stream_heap
);
555 g_free(iter
->stream_heap
);
557 iter
->ctx
->current_iterator
= NULL
;
558 bt_context_put(iter
->ctx
);
561 void bt_iter_destroy(struct bt_iter
*iter
)
567 int bt_iter_next(struct bt_iter
*iter
)
569 struct ctf_file_stream
*file_stream
, *removed
;
572 file_stream
= heap_maximum(iter
->stream_heap
);
574 /* end of file for all streams */
579 ret
= stream_read_event(file_stream
);
581 removed
= heap_remove(iter
->stream_heap
);
582 assert(removed
== file_stream
);
588 /* Reinsert the file stream into the heap, and rebalance. */
589 removed
= heap_replace_max(iter
->stream_heap
, file_stream
);
590 assert(removed
== file_stream
);