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_real_timestamp
;
45 uint64_t current_cycles_timestamp
;
49 struct trace_collection
*tc
;
50 GArray
*stream_saved_pos
; /* Contains struct stream_saved_pos */
53 static int stream_read_event(struct ctf_file_stream
*sin
)
57 ret
= sin
->pos
.parent
.event_cb(&sin
->pos
.parent
, &sin
->parent
);
61 fprintf(stderr
, "[error] Reading event failed.\n");
68 * returns true if a < b, false otherwise.
70 static int stream_compare(void *a
, void *b
)
72 struct ctf_file_stream
*s_a
= a
, *s_b
= b
;
74 if (s_a
->parent
.real_timestamp
< s_b
->parent
.real_timestamp
)
80 void bt_iter_free_pos(struct bt_iter_pos
*iter_pos
)
85 if (iter_pos
->type
== BT_SEEK_RESTORE
&& iter_pos
->u
.restore
) {
86 if (iter_pos
->u
.restore
->stream_saved_pos
) {
88 iter_pos
->u
.restore
->stream_saved_pos
,
91 g_free(iter_pos
->u
.restore
);
97 * seek_file_stream_by_timestamp
99 * Browse a filestream by index, if an index contains the timestamp passed in
100 * argument, seek inside the corresponding packet it until we find the event we
101 * are looking for (either the exact timestamp or the event just after the
104 * Return 0 if the seek succeded, EOF if we didn't find any packet
105 * containing the timestamp, or a positive integer for error.
107 static int seek_file_stream_by_timestamp(struct ctf_file_stream
*cfs
,
110 struct ctf_stream_pos
*stream_pos
;
111 struct packet_index
*index
;
114 stream_pos
= &cfs
->pos
;
115 for (i
= 0; i
< stream_pos
->packet_real_index
->len
; i
++) {
116 index
= &g_array_index(stream_pos
->packet_real_index
,
117 struct packet_index
, i
);
118 if (index
->timestamp_end
< timestamp
)
121 stream_pos
->packet_seek(&stream_pos
->parent
, i
, SEEK_SET
);
123 ret
= stream_read_event(cfs
);
124 } while (cfs
->parent
.real_timestamp
< timestamp
&& ret
== 0);
126 /* Can return either EOF, 0, or error (> 0). */
130 * Cannot find the timestamp within the stream packets, return
137 * seek_ctf_trace_by_timestamp : for each file stream, seek to the event with
138 * the corresponding timestamp
140 * Return 0 on success.
141 * If the timestamp is not part of any file stream, return EOF to inform the
142 * user the timestamp is out of the scope.
143 * On other errors, return positive value.
145 static int seek_ctf_trace_by_timestamp(struct ctf_trace
*tin
,
146 uint64_t timestamp
, struct ptr_heap
*stream_heap
)
151 /* for each stream_class */
152 for (i
= 0; i
< tin
->streams
->len
; i
++) {
153 struct ctf_stream_declaration
*stream_class
;
155 stream_class
= g_ptr_array_index(tin
->streams
, i
);
158 /* for each file_stream */
159 for (j
= 0; j
< stream_class
->streams
->len
; j
++) {
160 struct ctf_stream_definition
*stream
;
161 struct ctf_file_stream
*cfs
;
163 stream
= g_ptr_array_index(stream_class
->streams
, j
);
166 cfs
= container_of(stream
, struct ctf_file_stream
,
168 ret
= seek_file_stream_by_timestamp(cfs
, timestamp
);
171 ret
= heap_insert(stream_heap
, cfs
);
173 /* Return positive error. */
177 } else if (ret
> 0) {
179 * Error in seek (not EOF), failure.
183 /* on EOF just do not put stream into heap. */
187 return found
? 0 : EOF
;
190 int bt_iter_set_pos(struct bt_iter
*iter
, const struct bt_iter_pos
*iter_pos
)
192 struct trace_collection
*tc
;
195 if (!iter
|| !iter_pos
)
198 switch (iter_pos
->type
) {
199 case BT_SEEK_RESTORE
:
200 if (!iter_pos
->u
.restore
)
203 heap_free(iter
->stream_heap
);
204 ret
= heap_init(iter
->stream_heap
, 0, stream_compare
);
206 goto error_heap_init
;
208 for (i
= 0; i
< iter_pos
->u
.restore
->stream_saved_pos
->len
;
210 struct stream_saved_pos
*saved_pos
;
211 struct ctf_stream_pos
*stream_pos
;
212 struct ctf_stream_definition
*stream
;
214 saved_pos
= &g_array_index(
215 iter_pos
->u
.restore
->stream_saved_pos
,
216 struct stream_saved_pos
, i
);
217 stream
= &saved_pos
->file_stream
->parent
;
218 stream_pos
= &saved_pos
->file_stream
->pos
;
220 stream_pos
->packet_seek(&stream_pos
->parent
,
221 saved_pos
->cur_index
, SEEK_SET
);
224 * the timestamp needs to be restored after
225 * packet_seek, because this function resets
226 * the timestamp to the beginning of the packet
228 stream
->real_timestamp
= saved_pos
->current_real_timestamp
;
229 stream
->cycles_timestamp
= saved_pos
->current_cycles_timestamp
;
230 stream_pos
->offset
= saved_pos
->offset
;
231 stream_pos
->last_offset
= LAST_OFFSET_POISON
;
233 stream
->prev_real_timestamp
= 0;
234 stream
->prev_real_timestamp_end
= 0;
235 stream
->prev_cycles_timestamp
= 0;
236 stream
->prev_cycles_timestamp_end
= 0;
238 printf_debug("restored to cur_index = %zd and "
239 "offset = %zd, timestamp = %" PRIu64
"\n",
240 stream_pos
->cur_index
,
241 stream_pos
->offset
, stream
->real_timestamp
);
243 stream_read_event(saved_pos
->file_stream
);
246 ret
= heap_insert(iter
->stream_heap
,
247 saved_pos
->file_stream
);
255 heap_free(iter
->stream_heap
);
256 ret
= heap_init(iter
->stream_heap
, 0, stream_compare
);
258 goto error_heap_init
;
260 /* for each trace in the trace_collection */
261 for (i
= 0; i
< tc
->array
->len
; i
++) {
262 struct ctf_trace
*tin
;
263 struct trace_descriptor
*td_read
;
265 td_read
= g_ptr_array_index(tc
->array
, i
);
268 tin
= container_of(td_read
, struct ctf_trace
, parent
);
270 ret
= seek_ctf_trace_by_timestamp(tin
,
271 iter_pos
->u
.seek_time
,
274 * Positive errors are failure. Negative value
275 * is EOF (for which we continue with other
276 * traces). 0 is success. Note: on EOF, it just
277 * means that no stream has been added to the
278 * iterator for that trace, which is fine.
280 if (ret
!= 0 && ret
!= EOF
)
286 heap_free(iter
->stream_heap
);
287 ret
= heap_init(iter
->stream_heap
, 0, stream_compare
);
289 goto error_heap_init
;
291 for (i
= 0; i
< tc
->array
->len
; i
++) {
292 struct ctf_trace
*tin
;
293 struct trace_descriptor
*td_read
;
296 td_read
= g_ptr_array_index(tc
->array
, i
);
299 tin
= container_of(td_read
, struct ctf_trace
, parent
);
301 /* Populate heap with each stream */
302 for (stream_id
= 0; stream_id
< tin
->streams
->len
;
304 struct ctf_stream_declaration
*stream
;
307 stream
= g_ptr_array_index(tin
->streams
,
311 for (filenr
= 0; filenr
< stream
->streams
->len
;
313 struct ctf_file_stream
*file_stream
;
314 file_stream
= g_ptr_array_index(
319 ret
= babeltrace_filestream_seek(
320 file_stream
, iter_pos
,
322 if (ret
!= 0 && ret
!= EOF
) {
325 ret
= heap_insert(iter
->stream_heap
, file_stream
);
333 /* not implemented */
340 heap_free(iter
->stream_heap
);
342 if (heap_init(iter
->stream_heap
, 0, stream_compare
) < 0) {
343 heap_free(iter
->stream_heap
);
344 g_free(iter
->stream_heap
);
345 iter
->stream_heap
= NULL
;
352 struct bt_iter_pos
*bt_iter_get_pos(struct bt_iter
*iter
)
354 struct bt_iter_pos
*pos
;
355 struct trace_collection
*tc
;
356 struct ctf_file_stream
*file_stream
= NULL
, *removed
;
357 struct ptr_heap iter_heap_copy
;
364 pos
= g_new0(struct bt_iter_pos
, 1);
365 pos
->type
= BT_SEEK_RESTORE
;
366 pos
->u
.restore
= g_new0(struct bt_saved_pos
, 1);
367 pos
->u
.restore
->tc
= tc
;
368 pos
->u
.restore
->stream_saved_pos
= g_array_new(FALSE
, TRUE
,
369 sizeof(struct stream_saved_pos
));
370 if (!pos
->u
.restore
->stream_saved_pos
)
373 ret
= heap_copy(&iter_heap_copy
, iter
->stream_heap
);
377 /* iterate over each stream in the heap */
378 file_stream
= heap_maximum(&iter_heap_copy
);
379 while (file_stream
!= NULL
) {
380 struct stream_saved_pos saved_pos
;
382 assert(file_stream
->pos
.last_offset
!= LAST_OFFSET_POISON
);
383 saved_pos
.offset
= file_stream
->pos
.last_offset
;
384 saved_pos
.file_stream
= file_stream
;
385 saved_pos
.cur_index
= file_stream
->pos
.cur_index
;
387 saved_pos
.current_real_timestamp
= file_stream
->parent
.real_timestamp
;
388 saved_pos
.current_cycles_timestamp
= file_stream
->parent
.cycles_timestamp
;
391 pos
->u
.restore
->stream_saved_pos
,
394 printf_debug("stream : %" PRIu64
", cur_index : %zd, "
396 "timestamp = %" PRIu64
"\n",
397 file_stream
->parent
.stream_id
,
398 saved_pos
.cur_index
, saved_pos
.offset
,
399 saved_pos
.current_real_timestamp
);
401 /* remove the stream from the heap copy */
402 removed
= heap_remove(&iter_heap_copy
);
403 assert(removed
== file_stream
);
405 file_stream
= heap_maximum(&iter_heap_copy
);
407 heap_free(&iter_heap_copy
);
411 g_array_free(pos
->u
.restore
->stream_saved_pos
, TRUE
);
417 struct bt_iter_pos
*bt_iter_create_time_pos(struct bt_iter
*iter
,
420 struct bt_iter_pos
*pos
;
425 pos
= g_new0(struct bt_iter_pos
, 1);
426 pos
->type
= BT_SEEK_TIME
;
427 pos
->u
.seek_time
= timestamp
;
432 * babeltrace_filestream_seek: seek a filestream to given position.
434 * The stream_id parameter is only useful for BT_SEEK_RESTORE.
436 static int babeltrace_filestream_seek(struct ctf_file_stream
*file_stream
,
437 const struct bt_iter_pos
*begin_pos
,
438 unsigned long stream_id
)
442 if (!file_stream
|| !begin_pos
)
445 switch (begin_pos
->type
) {
448 * just insert into the heap we should already know
453 file_stream
->pos
.packet_seek(&file_stream
->pos
.parent
,
455 ret
= stream_read_event(file_stream
);
458 case BT_SEEK_RESTORE
:
461 assert(0); /* Not yet defined */
467 int bt_iter_init(struct bt_iter
*iter
,
468 struct bt_context
*ctx
,
469 const struct bt_iter_pos
*begin_pos
,
470 const struct bt_iter_pos
*end_pos
)
478 if (ctx
->current_iterator
) {
483 iter
->stream_heap
= g_new(struct ptr_heap
, 1);
484 iter
->end_pos
= end_pos
;
488 ret
= heap_init(iter
->stream_heap
, 0, stream_compare
);
490 goto error_heap_init
;
492 for (i
= 0; i
< ctx
->tc
->array
->len
; i
++) {
493 struct ctf_trace
*tin
;
494 struct trace_descriptor
*td_read
;
496 td_read
= g_ptr_array_index(ctx
->tc
->array
, i
);
499 tin
= container_of(td_read
, struct ctf_trace
, parent
);
501 /* Populate heap with each stream */
502 for (stream_id
= 0; stream_id
< tin
->streams
->len
;
504 struct ctf_stream_declaration
*stream
;
507 stream
= g_ptr_array_index(tin
->streams
, stream_id
);
510 for (filenr
= 0; filenr
< stream
->streams
->len
;
512 struct ctf_file_stream
*file_stream
;
514 file_stream
= g_ptr_array_index(stream
->streams
,
519 ret
= babeltrace_filestream_seek(
524 struct bt_iter_pos pos
;
525 pos
.type
= BT_SEEK_BEGIN
;
526 ret
= babeltrace_filestream_seek(
537 ret
= heap_insert(iter
->stream_heap
, file_stream
);
544 ctx
->current_iterator
= iter
;
548 heap_free(iter
->stream_heap
);
550 g_free(iter
->stream_heap
);
551 iter
->stream_heap
= NULL
;
556 struct bt_iter
*bt_iter_create(struct bt_context
*ctx
,
557 const struct bt_iter_pos
*begin_pos
,
558 const struct bt_iter_pos
*end_pos
)
560 struct bt_iter
*iter
;
566 iter
= g_new0(struct bt_iter
, 1);
567 ret
= bt_iter_init(iter
, ctx
, begin_pos
, end_pos
);
575 void bt_iter_fini(struct bt_iter
*iter
)
578 if (iter
->stream_heap
) {
579 heap_free(iter
->stream_heap
);
580 g_free(iter
->stream_heap
);
582 iter
->ctx
->current_iterator
= NULL
;
583 bt_context_put(iter
->ctx
);
586 void bt_iter_destroy(struct bt_iter
*iter
)
593 int bt_iter_next(struct bt_iter
*iter
)
595 struct ctf_file_stream
*file_stream
, *removed
;
601 file_stream
= heap_maximum(iter
->stream_heap
);
603 /* end of file for all streams */
608 ret
= stream_read_event(file_stream
);
610 removed
= heap_remove(iter
->stream_heap
);
611 assert(removed
== file_stream
);
617 /* Reinsert the file stream into the heap, and rebalance. */
618 removed
= heap_replace_max(iter
->stream_heap
, file_stream
);
619 assert(removed
== file_stream
);