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/callbacks-internal.h>
24 #include <babeltrace/context.h>
25 #include <babeltrace/ctf/metadata.h>
26 #include <babeltrace/iterator-internal.h>
27 #include <babeltrace/iterator.h>
28 #include <babeltrace/prio_heap.h>
31 struct stream_saved_pos
{
33 * Use file_stream pointer to check if the trace collection we
34 * restore to match the one we saved from, for each stream.
36 struct ctf_file_stream
*file_stream
;
37 size_t cur_index
; /* current index in packet index */
38 ssize_t offset
; /* offset from base, in bits. EOF for end of file. */
39 uint64_t current_timestamp
;
43 struct trace_collection
*tc
;
44 GArray
*stream_saved_pos
; /* Contains struct stream_saved_pos */
47 static int stream_read_event(struct ctf_file_stream
*sin
)
51 ret
= sin
->pos
.parent
.event_cb(&sin
->pos
.parent
, &sin
->parent
);
55 fprintf(stderr
, "[error] Reading event failed.\n");
62 * returns true if a < b, false otherwise.
64 int stream_compare(void *a
, void *b
)
66 struct ctf_file_stream
*s_a
= a
, *s_b
= b
;
68 if (s_a
->parent
.timestamp
< s_b
->parent
.timestamp
)
74 void bt_iter_free_pos(struct bt_iter_pos
*iter_pos
)
77 if (iter_pos
->u
.restore
) {
78 if (iter_pos
->u
.restore
->stream_saved_pos
) {
80 iter_pos
->u
.restore
->stream_saved_pos
,
83 g_free(iter_pos
->u
.restore
);
89 int bt_iter_set_pos(struct bt_iter
*iter
, const struct bt_iter_pos
*iter_pos
)
93 if (iter_pos
->u
.restore
) {
94 /* clear and recreate the heap */
95 heap_free(iter
->stream_heap
);
96 g_free(iter
->stream_heap
);
97 iter
->stream_heap
= g_new(struct ptr_heap
, 1);
98 ret
= heap_init(iter
->stream_heap
, 0, stream_compare
);
100 goto error_heap_init
;
102 for (i
= 0; i
< iter_pos
->u
.restore
->stream_saved_pos
->len
;
104 struct stream_saved_pos
*saved_pos
;
105 struct ctf_stream_pos
*stream_pos
;
106 struct packet_index
*index
;
107 struct ctf_stream
*stream
;
109 saved_pos
= &g_array_index(
110 iter_pos
->u
.restore
->stream_saved_pos
,
111 struct stream_saved_pos
, i
);
112 stream
= &saved_pos
->file_stream
->parent
;
113 stream_pos
= &saved_pos
->file_stream
->pos
;
114 index
= &g_array_index(stream_pos
->packet_index
,
116 saved_pos
->cur_index
);
118 stream_pos
->cur_index
= saved_pos
->cur_index
;
119 stream_pos
->move_pos_slow(stream_pos
, index
->offset
,
123 * the timestamp needs to be restored after
124 * move_pos_slow, because this function resets
125 * the timestamp to the beginning of the packet
127 stream
->timestamp
= saved_pos
->current_timestamp
;
128 stream_pos
->offset
= saved_pos
->offset
;
129 stream_pos
->last_offset
= saved_pos
->offset
;
131 stream
->prev_timestamp
= 0;
132 stream
->prev_timestamp_end
= 0;
133 stream
->consumed
= 0;
135 printf_debug("restored to cur_index = %zd and "
136 "offset = %zd, timestamp = %" PRIu64
"\n",
137 stream_pos
->cur_index
,
138 stream_pos
->offset
, stream
->timestamp
);
140 stream_read_event(saved_pos
->file_stream
);
143 ret
= heap_insert(iter
->stream_heap
,
144 saved_pos
->file_stream
);
148 } else if (iter_pos
->u
.seek_time
) {
149 /* not yet implemented */
152 /* nowhere to seek to */
158 heap_free(iter
->stream_heap
);
160 g_free(iter
->stream_heap
);
164 struct bt_iter_pos
*bt_iter_get_pos(struct bt_iter
*iter
)
166 struct bt_iter_pos
*pos
;
167 struct trace_collection
*tc
= iter
->ctx
->tc
;
168 int i
, stream_class_id
, stream_id
;
170 pos
= g_new0(struct bt_iter_pos
, 1);
172 perror("allocating bt_iter_pos");
176 pos
->u
.restore
= g_new0(struct bt_saved_pos
, 1);
177 if (!pos
->u
.restore
) {
178 perror("allocating bt_saved_pos");
182 pos
->u
.restore
->tc
= tc
;
183 pos
->u
.restore
->stream_saved_pos
= g_array_new(FALSE
, TRUE
,
184 sizeof(struct stream_saved_pos
));
185 if (!pos
->u
.restore
->stream_saved_pos
)
188 for (i
= 0; i
< tc
->array
->len
; i
++) {
189 struct ctf_trace
*tin
;
190 struct trace_descriptor
*td_read
;
192 td_read
= g_ptr_array_index(tc
->array
, i
);
193 tin
= container_of(td_read
, struct ctf_trace
, parent
);
195 for (stream_class_id
= 0; stream_class_id
< tin
->streams
->len
;
197 struct ctf_stream_class
*stream_class
;
199 stream_class
= g_ptr_array_index(tin
->streams
,
202 stream_id
< stream_class
->streams
->len
;
204 struct ctf_stream
*stream
;
205 struct ctf_file_stream
*cfs
;
206 struct stream_saved_pos saved_pos
;
208 stream
= g_ptr_array_index(
209 stream_class
->streams
,
211 cfs
= container_of(stream
,
212 struct ctf_file_stream
,
215 saved_pos
.file_stream
= cfs
;
216 saved_pos
.cur_index
= cfs
->pos
.cur_index
;
219 * It is possible that an event was read during
220 * the last restore, never consumed and its
221 * position saved again. For this case, we
222 * need to check if the event really was
223 * consumed by the caller otherwise it is lost.
225 if (stream
->consumed
)
226 saved_pos
.offset
= cfs
->pos
.offset
;
228 saved_pos
.offset
= cfs
->pos
.last_offset
;
230 saved_pos
.current_timestamp
= stream
->timestamp
;
233 pos
->u
.restore
->stream_saved_pos
,
236 printf_debug("stream : %lu, cur_index : %zd, "
238 "timestamp = %" PRIu64
"\n",
239 stream
->stream_id
, saved_pos
.cur_index
,
241 saved_pos
.current_timestamp
);
253 * babeltrace_filestream_seek: seek a filestream to given position.
255 * The stream_id parameter is only useful for BT_SEEK_RESTORE.
257 static int babeltrace_filestream_seek(struct ctf_file_stream
*file_stream
,
258 const struct bt_iter_pos
*begin_pos
,
259 unsigned long stream_id
)
263 switch (begin_pos
->type
) {
266 * just insert into the heap we should already know
271 file_stream
->pos
.move_pos_slow(&file_stream
->pos
, 0, SEEK_SET
);
272 ret
= stream_read_event(file_stream
);
275 case BT_SEEK_RESTORE
:
278 assert(0); /* Not yet defined */
285 * bt_iter_seek: seek iterator to given position.
287 int bt_iter_seek(struct bt_iter
*iter
,
288 const struct bt_iter_pos
*begin_pos
)
292 struct trace_collection
*tc
= iter
->ctx
->tc
;
294 for (i
= 0; i
< tc
->array
->len
; i
++) {
295 struct ctf_trace
*tin
;
296 struct trace_descriptor
*td_read
;
298 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_class
*stream
;
307 stream
= g_ptr_array_index(tin
->streams
, stream_id
);
308 for (filenr
= 0; filenr
< stream
->streams
->len
;
310 struct ctf_file_stream
*file_stream
;
312 file_stream
= g_ptr_array_index(stream
->streams
,
314 ret
= babeltrace_filestream_seek(file_stream
, begin_pos
,
325 struct bt_iter
*bt_iter_create(struct bt_context
*ctx
,
326 struct bt_iter_pos
*begin_pos
,
327 struct bt_iter_pos
*end_pos
)
331 struct bt_iter
*iter
;
333 iter
= g_new0(struct bt_iter
, 1);
336 iter
->stream_heap
= g_new(struct ptr_heap
, 1);
337 iter
->end_pos
= end_pos
;
338 iter
->callbacks
= g_array_new(0, 1, sizeof(struct bt_stream_callbacks
));
339 iter
->recalculate_dep_graph
= 0;
340 iter
->main_callbacks
.callback
= NULL
;
341 iter
->dep_gc
= g_ptr_array_new();
342 if (bt_context_get(ctx
) != 0)
346 ret
= heap_init(iter
->stream_heap
, 0, stream_compare
);
348 goto error_heap_init
;
350 for (i
= 0; i
< ctx
->tc
->array
->len
; i
++) {
351 struct ctf_trace
*tin
;
352 struct trace_descriptor
*td_read
;
354 td_read
= g_ptr_array_index(ctx
->tc
->array
, i
);
355 tin
= container_of(td_read
, struct ctf_trace
, parent
);
357 /* Populate heap with each stream */
358 for (stream_id
= 0; stream_id
< tin
->streams
->len
;
360 struct ctf_stream_class
*stream
;
363 stream
= g_ptr_array_index(tin
->streams
, stream_id
);
366 for (filenr
= 0; filenr
< stream
->streams
->len
;
368 struct ctf_file_stream
*file_stream
;
370 file_stream
= g_ptr_array_index(stream
->streams
,
374 ret
= babeltrace_filestream_seek(file_stream
, begin_pos
,
384 ret
= heap_insert(iter
->stream_heap
, file_stream
);
394 heap_free(iter
->stream_heap
);
396 g_free(iter
->stream_heap
);
403 void bt_iter_destroy(struct bt_iter
*iter
)
405 struct bt_stream_callbacks
*bt_stream_cb
;
406 struct bt_callback_chain
*bt_chain
;
409 heap_free(iter
->stream_heap
);
410 g_free(iter
->stream_heap
);
412 /* free all events callbacks */
413 if (iter
->main_callbacks
.callback
)
414 g_array_free(iter
->main_callbacks
.callback
, TRUE
);
416 /* free per-event callbacks */
417 for (i
= 0; i
< iter
->callbacks
->len
; i
++) {
418 bt_stream_cb
= &g_array_index(iter
->callbacks
,
419 struct bt_stream_callbacks
, i
);
420 if (!bt_stream_cb
|| !bt_stream_cb
->per_id_callbacks
)
422 for (j
= 0; j
< bt_stream_cb
->per_id_callbacks
->len
; j
++) {
423 bt_chain
= &g_array_index(bt_stream_cb
->per_id_callbacks
,
424 struct bt_callback_chain
, j
);
425 if (bt_chain
->callback
) {
426 g_array_free(bt_chain
->callback
, TRUE
);
429 g_array_free(bt_stream_cb
->per_id_callbacks
, TRUE
);
432 bt_context_put(iter
->ctx
);
437 int bt_iter_next(struct bt_iter
*iter
)
439 struct ctf_file_stream
*file_stream
, *removed
;
442 file_stream
= heap_maximum(iter
->stream_heap
);
444 /* end of file for all streams */
449 ret
= stream_read_event(file_stream
);
451 removed
= heap_remove(iter
->stream_heap
);
452 assert(removed
== file_stream
);
458 /* Reinsert the file stream into the heap, and rebalance. */
459 removed
= heap_replace_max(iter
->stream_heap
, file_stream
);
460 assert(removed
== file_stream
);
466 int bt_iter_read_event(struct bt_iter
*iter
,
467 struct ctf_stream
**stream
,
468 struct ctf_stream_event
**event
)
470 struct ctf_file_stream
*file_stream
;
473 file_stream
= heap_maximum(iter
->stream_heap
);
475 /* end of file for all streams */
479 *stream
= &file_stream
->parent
;
480 *event
= g_ptr_array_index((*stream
)->events_by_id
, (*stream
)->event_id
);
482 if ((*stream
)->stream_id
> iter
->callbacks
->len
)
485 process_callbacks(iter
, *stream
);