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/context-internal.h>
26 #include <babeltrace/ctf/metadata.h>
27 #include <babeltrace/iterator-internal.h>
28 #include <babeltrace/iterator.h>
29 #include <babeltrace/prio_heap.h>
32 struct stream_saved_pos
{
34 * Use file_stream pointer to check if the trace collection we
35 * restore to match the one we saved from, for each stream.
37 struct ctf_file_stream
*file_stream
;
38 size_t cur_index
; /* current index in packet index */
39 ssize_t offset
; /* offset from base, in bits. EOF for end of file. */
40 uint64_t current_timestamp
;
44 struct trace_collection
*tc
;
45 GArray
*stream_saved_pos
; /* Contains struct stream_saved_pos */
48 static int stream_read_event(struct ctf_file_stream
*sin
)
52 ret
= sin
->pos
.parent
.event_cb(&sin
->pos
.parent
, &sin
->parent
);
56 fprintf(stderr
, "[error] Reading event failed.\n");
63 * returns true if a < b, false otherwise.
65 int stream_compare(void *a
, void *b
)
67 struct ctf_file_stream
*s_a
= a
, *s_b
= b
;
69 if (s_a
->parent
.timestamp
< s_b
->parent
.timestamp
)
75 void bt_iter_free_pos(struct bt_iter_pos
*iter_pos
)
80 if (iter_pos
->u
.restore
) {
81 if (iter_pos
->u
.restore
->stream_saved_pos
) {
83 iter_pos
->u
.restore
->stream_saved_pos
,
86 g_free(iter_pos
->u
.restore
);
91 int bt_iter_set_pos(struct bt_iter
*iter
, const struct bt_iter_pos
*iter_pos
)
95 if (iter_pos
->u
.restore
) {
96 /* clear and recreate the heap */
97 heap_free(iter
->stream_heap
);
98 g_free(iter
->stream_heap
);
99 iter
->stream_heap
= g_new(struct ptr_heap
, 1);
100 ret
= heap_init(iter
->stream_heap
, 0, stream_compare
);
102 goto error_heap_init
;
104 for (i
= 0; i
< iter_pos
->u
.restore
->stream_saved_pos
->len
;
106 struct stream_saved_pos
*saved_pos
;
107 struct ctf_stream_pos
*stream_pos
;
108 struct packet_index
*index
;
109 struct ctf_stream
*stream
;
111 saved_pos
= &g_array_index(
112 iter_pos
->u
.restore
->stream_saved_pos
,
113 struct stream_saved_pos
, i
);
114 stream
= &saved_pos
->file_stream
->parent
;
115 stream_pos
= &saved_pos
->file_stream
->pos
;
116 index
= &g_array_index(stream_pos
->packet_index
,
118 saved_pos
->cur_index
);
120 stream_pos
->cur_index
= saved_pos
->cur_index
;
121 stream_pos
->move_pos_slow(stream_pos
, index
->offset
,
125 * the timestamp needs to be restored after
126 * move_pos_slow, because this function resets
127 * the timestamp to the beginning of the packet
129 stream
->timestamp
= saved_pos
->current_timestamp
;
130 stream_pos
->offset
= saved_pos
->offset
;
131 stream_pos
->last_offset
= saved_pos
->offset
;
133 stream
->prev_timestamp
= 0;
134 stream
->prev_timestamp_end
= 0;
135 stream
->consumed
= 0;
137 printf_debug("restored to cur_index = %zd and "
138 "offset = %zd, timestamp = %" PRIu64
"\n",
139 stream_pos
->cur_index
,
140 stream_pos
->offset
, stream
->timestamp
);
142 stream_read_event(saved_pos
->file_stream
);
145 ret
= heap_insert(iter
->stream_heap
,
146 saved_pos
->file_stream
);
150 } else if (iter_pos
->u
.seek_time
) {
151 /* not yet implemented */
154 /* nowhere to seek to */
160 heap_free(iter
->stream_heap
);
162 g_free(iter
->stream_heap
);
166 struct bt_iter_pos
*bt_iter_get_pos(struct bt_iter
*iter
)
168 struct bt_iter_pos
*pos
;
169 struct trace_collection
*tc
= iter
->ctx
->tc
;
170 int i
, stream_class_id
, stream_id
;
172 pos
= g_new0(struct bt_iter_pos
, 1);
173 pos
->u
.restore
= g_new0(struct bt_saved_pos
, 1);
174 pos
->u
.restore
->tc
= tc
;
175 pos
->u
.restore
->stream_saved_pos
= g_array_new(FALSE
, TRUE
,
176 sizeof(struct stream_saved_pos
));
177 if (!pos
->u
.restore
->stream_saved_pos
)
180 for (i
= 0; i
< tc
->array
->len
; i
++) {
181 struct ctf_trace
*tin
;
182 struct trace_descriptor
*td_read
;
184 td_read
= g_ptr_array_index(tc
->array
, i
);
185 tin
= container_of(td_read
, struct ctf_trace
, parent
);
187 for (stream_class_id
= 0; stream_class_id
< tin
->streams
->len
;
189 struct ctf_stream_class
*stream_class
;
191 stream_class
= g_ptr_array_index(tin
->streams
,
194 stream_id
< stream_class
->streams
->len
;
196 struct ctf_stream
*stream
;
197 struct ctf_file_stream
*cfs
;
198 struct stream_saved_pos saved_pos
;
200 stream
= g_ptr_array_index(
201 stream_class
->streams
,
203 cfs
= container_of(stream
,
204 struct ctf_file_stream
,
207 saved_pos
.file_stream
= cfs
;
208 saved_pos
.cur_index
= cfs
->pos
.cur_index
;
211 * It is possible that an event was read during
212 * the last restore, never consumed and its
213 * position saved again. For this case, we
214 * need to check if the event really was
215 * consumed by the caller otherwise it is lost.
217 if (stream
->consumed
)
218 saved_pos
.offset
= cfs
->pos
.offset
;
220 saved_pos
.offset
= cfs
->pos
.last_offset
;
222 saved_pos
.current_timestamp
= stream
->timestamp
;
225 pos
->u
.restore
->stream_saved_pos
,
228 printf_debug("stream : %" PRIu64
", cur_index : %zd, "
230 "timestamp = %" PRIu64
"\n",
231 stream
->stream_id
, saved_pos
.cur_index
,
233 saved_pos
.current_timestamp
);
245 * babeltrace_filestream_seek: seek a filestream to given position.
247 * The stream_id parameter is only useful for BT_SEEK_RESTORE.
249 static int babeltrace_filestream_seek(struct ctf_file_stream
*file_stream
,
250 const struct bt_iter_pos
*begin_pos
,
251 unsigned long stream_id
)
255 switch (begin_pos
->type
) {
258 * just insert into the heap we should already know
263 file_stream
->pos
.move_pos_slow(&file_stream
->pos
, 0, SEEK_SET
);
264 ret
= stream_read_event(file_stream
);
267 case BT_SEEK_RESTORE
:
270 assert(0); /* Not yet defined */
277 * bt_iter_seek: seek iterator to given position.
279 int bt_iter_seek(struct bt_iter
*iter
,
280 const struct bt_iter_pos
*begin_pos
)
284 struct trace_collection
*tc
= iter
->ctx
->tc
;
286 for (i
= 0; i
< tc
->array
->len
; i
++) {
287 struct ctf_trace
*tin
;
288 struct trace_descriptor
*td_read
;
290 td_read
= g_ptr_array_index(tc
->array
, i
);
291 tin
= container_of(td_read
, struct ctf_trace
, parent
);
293 /* Populate heap with each stream */
294 for (stream_id
= 0; stream_id
< tin
->streams
->len
;
296 struct ctf_stream_class
*stream
;
299 stream
= g_ptr_array_index(tin
->streams
, stream_id
);
300 for (filenr
= 0; filenr
< stream
->streams
->len
;
302 struct ctf_file_stream
*file_stream
;
304 file_stream
= g_ptr_array_index(stream
->streams
,
306 ret
= babeltrace_filestream_seek(file_stream
, begin_pos
,
317 struct bt_iter
*bt_iter_create(struct bt_context
*ctx
,
318 struct bt_iter_pos
*begin_pos
,
319 struct bt_iter_pos
*end_pos
)
323 struct bt_iter
*iter
;
325 iter
= g_new0(struct bt_iter
, 1);
326 iter
->stream_heap
= g_new(struct ptr_heap
, 1);
327 iter
->end_pos
= end_pos
;
328 iter
->callbacks
= g_array_new(0, 1, sizeof(struct bt_stream_callbacks
));
329 iter
->recalculate_dep_graph
= 0;
330 iter
->main_callbacks
.callback
= NULL
;
331 iter
->dep_gc
= g_ptr_array_new();
335 ret
= heap_init(iter
->stream_heap
, 0, stream_compare
);
337 goto error_heap_init
;
339 for (i
= 0; i
< ctx
->tc
->array
->len
; i
++) {
340 struct ctf_trace
*tin
;
341 struct trace_descriptor
*td_read
;
343 td_read
= g_ptr_array_index(ctx
->tc
->array
, i
);
344 tin
= container_of(td_read
, struct ctf_trace
, parent
);
346 /* Populate heap with each stream */
347 for (stream_id
= 0; stream_id
< tin
->streams
->len
;
349 struct ctf_stream_class
*stream
;
352 stream
= g_ptr_array_index(tin
->streams
, stream_id
);
355 for (filenr
= 0; filenr
< stream
->streams
->len
;
357 struct ctf_file_stream
*file_stream
;
359 file_stream
= g_ptr_array_index(stream
->streams
,
363 ret
= babeltrace_filestream_seek(file_stream
, begin_pos
,
373 ret
= heap_insert(iter
->stream_heap
, file_stream
);
383 heap_free(iter
->stream_heap
);
385 g_free(iter
->stream_heap
);
390 void bt_iter_destroy(struct bt_iter
*iter
)
392 struct bt_stream_callbacks
*bt_stream_cb
;
393 struct bt_callback_chain
*bt_chain
;
396 heap_free(iter
->stream_heap
);
397 g_free(iter
->stream_heap
);
399 /* free all events callbacks */
400 if (iter
->main_callbacks
.callback
)
401 g_array_free(iter
->main_callbacks
.callback
, TRUE
);
403 /* free per-event callbacks */
404 for (i
= 0; i
< iter
->callbacks
->len
; i
++) {
405 bt_stream_cb
= &g_array_index(iter
->callbacks
,
406 struct bt_stream_callbacks
, i
);
407 if (!bt_stream_cb
|| !bt_stream_cb
->per_id_callbacks
)
409 for (j
= 0; j
< bt_stream_cb
->per_id_callbacks
->len
; j
++) {
410 bt_chain
= &g_array_index(bt_stream_cb
->per_id_callbacks
,
411 struct bt_callback_chain
, j
);
412 if (bt_chain
->callback
) {
413 g_array_free(bt_chain
->callback
, TRUE
);
416 g_array_free(bt_stream_cb
->per_id_callbacks
, TRUE
);
419 bt_context_put(iter
->ctx
);
424 int bt_iter_next(struct bt_iter
*iter
)
426 struct ctf_file_stream
*file_stream
, *removed
;
429 file_stream
= heap_maximum(iter
->stream_heap
);
431 /* end of file for all streams */
436 ret
= stream_read_event(file_stream
);
438 removed
= heap_remove(iter
->stream_heap
);
439 assert(removed
== file_stream
);
445 /* Reinsert the file stream into the heap, and rebalance. */
446 removed
= heap_replace_max(iter
->stream_heap
, file_stream
);
447 assert(removed
== file_stream
);
453 int bt_iter_read_event(struct bt_iter
*iter
,
454 struct ctf_stream
**stream
,
455 struct ctf_stream_event
**event
)
457 struct ctf_file_stream
*file_stream
;
460 file_stream
= heap_maximum(iter
->stream_heap
);
462 /* end of file for all streams */
466 *stream
= &file_stream
->parent
;
467 *event
= g_ptr_array_index((*stream
)->events_by_id
, (*stream
)->event_id
);
469 if ((*stream
)->stream_id
> iter
->callbacks
->len
)
472 process_callbacks(iter
, *stream
);