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
)
79 if (iter_pos
->u
.restore
) {
80 if (iter_pos
->u
.restore
->stream_saved_pos
) {
82 iter_pos
->u
.restore
->stream_saved_pos
,
85 g_free(iter_pos
->u
.restore
);
90 int bt_iter_set_pos(struct bt_iter
*iter
, const struct bt_iter_pos
*iter_pos
)
94 if (iter_pos
->u
.restore
) {
95 /* clear and recreate the heap */
96 heap_free(iter
->stream_heap
);
97 g_free(iter
->stream_heap
);
98 iter
->stream_heap
= g_new(struct ptr_heap
, 1);
99 ret
= heap_init(iter
->stream_heap
, 0, stream_compare
);
101 goto error_heap_init
;
103 for (i
= 0; i
< iter_pos
->u
.restore
->stream_saved_pos
->len
;
105 struct stream_saved_pos
*saved_pos
;
106 struct ctf_stream_pos
*stream_pos
;
107 struct packet_index
*index
;
108 struct ctf_stream
*stream
;
110 saved_pos
= &g_array_index(
111 iter_pos
->u
.restore
->stream_saved_pos
,
112 struct stream_saved_pos
, i
);
113 stream
= &saved_pos
->file_stream
->parent
;
114 stream_pos
= &saved_pos
->file_stream
->pos
;
115 index
= &g_array_index(stream_pos
->packet_index
,
117 saved_pos
->cur_index
);
119 stream_pos
->cur_index
= saved_pos
->cur_index
;
120 stream_pos
->move_pos_slow(stream_pos
, index
->offset
,
124 * the timestamp needs to be restored after
125 * move_pos_slow, because this function resets
126 * the timestamp to the beginning of the packet
128 stream
->timestamp
= saved_pos
->current_timestamp
;
129 stream_pos
->offset
= saved_pos
->offset
;
130 stream_pos
->last_offset
= saved_pos
->offset
;
132 stream
->prev_timestamp
= 0;
133 stream
->prev_timestamp_end
= 0;
134 stream
->consumed
= 0;
136 printf_debug("restored to cur_index = %zd and "
137 "offset = %zd, timestamp = %" PRIu64
"\n",
138 stream_pos
->cur_index
,
139 stream_pos
->offset
, stream
->timestamp
);
141 stream_read_event(saved_pos
->file_stream
);
144 ret
= heap_insert(iter
->stream_heap
,
145 saved_pos
->file_stream
);
149 } else if (iter_pos
->u
.seek_time
) {
150 /* not yet implemented */
153 /* nowhere to seek to */
159 heap_free(iter
->stream_heap
);
161 g_free(iter
->stream_heap
);
165 struct bt_iter_pos
*bt_iter_get_pos(struct bt_iter
*iter
)
167 struct bt_iter_pos
*pos
;
168 struct trace_collection
*tc
= iter
->ctx
->tc
;
169 int i
, stream_class_id
, stream_id
;
171 pos
= g_new0(struct bt_iter_pos
, 1);
172 pos
->u
.restore
= g_new0(struct bt_saved_pos
, 1);
173 pos
->u
.restore
->tc
= tc
;
174 pos
->u
.restore
->stream_saved_pos
= g_array_new(FALSE
, TRUE
,
175 sizeof(struct stream_saved_pos
));
176 if (!pos
->u
.restore
->stream_saved_pos
)
179 for (i
= 0; i
< tc
->array
->len
; i
++) {
180 struct ctf_trace
*tin
;
181 struct trace_descriptor
*td_read
;
183 td_read
= g_ptr_array_index(tc
->array
, i
);
184 tin
= container_of(td_read
, struct ctf_trace
, parent
);
186 for (stream_class_id
= 0; stream_class_id
< tin
->streams
->len
;
188 struct ctf_stream_class
*stream_class
;
190 stream_class
= g_ptr_array_index(tin
->streams
,
193 stream_id
< stream_class
->streams
->len
;
195 struct ctf_stream
*stream
;
196 struct ctf_file_stream
*cfs
;
197 struct stream_saved_pos saved_pos
;
199 stream
= g_ptr_array_index(
200 stream_class
->streams
,
202 cfs
= container_of(stream
,
203 struct ctf_file_stream
,
206 saved_pos
.file_stream
= cfs
;
207 saved_pos
.cur_index
= cfs
->pos
.cur_index
;
210 * It is possible that an event was read during
211 * the last restore, never consumed and its
212 * position saved again. For this case, we
213 * need to check if the event really was
214 * consumed by the caller otherwise it is lost.
216 if (stream
->consumed
)
217 saved_pos
.offset
= cfs
->pos
.offset
;
219 saved_pos
.offset
= cfs
->pos
.last_offset
;
221 saved_pos
.current_timestamp
= stream
->timestamp
;
224 pos
->u
.restore
->stream_saved_pos
,
227 printf_debug("stream : %lu, cur_index : %zd, "
229 "timestamp = %" PRIu64
"\n",
230 stream
->stream_id
, saved_pos
.cur_index
,
232 saved_pos
.current_timestamp
);
244 * babeltrace_filestream_seek: seek a filestream to given position.
246 * The stream_id parameter is only useful for BT_SEEK_RESTORE.
248 static int babeltrace_filestream_seek(struct ctf_file_stream
*file_stream
,
249 const struct bt_iter_pos
*begin_pos
,
250 unsigned long stream_id
)
254 switch (begin_pos
->type
) {
257 * just insert into the heap we should already know
262 file_stream
->pos
.move_pos_slow(&file_stream
->pos
, 0, SEEK_SET
);
263 ret
= stream_read_event(file_stream
);
266 case BT_SEEK_RESTORE
:
269 assert(0); /* Not yet defined */
276 * bt_iter_seek: seek iterator to given position.
278 int bt_iter_seek(struct bt_iter
*iter
,
279 const struct bt_iter_pos
*begin_pos
)
283 struct trace_collection
*tc
= iter
->ctx
->tc
;
285 for (i
= 0; i
< tc
->array
->len
; i
++) {
286 struct ctf_trace
*tin
;
287 struct trace_descriptor
*td_read
;
289 td_read
= g_ptr_array_index(tc
->array
, i
);
290 tin
= container_of(td_read
, struct ctf_trace
, parent
);
292 /* Populate heap with each stream */
293 for (stream_id
= 0; stream_id
< tin
->streams
->len
;
295 struct ctf_stream_class
*stream
;
298 stream
= g_ptr_array_index(tin
->streams
, stream_id
);
299 for (filenr
= 0; filenr
< stream
->streams
->len
;
301 struct ctf_file_stream
*file_stream
;
303 file_stream
= g_ptr_array_index(stream
->streams
,
305 ret
= babeltrace_filestream_seek(file_stream
, begin_pos
,
316 struct bt_iter
*bt_iter_create(struct bt_context
*ctx
,
317 struct bt_iter_pos
*begin_pos
,
318 struct bt_iter_pos
*end_pos
)
322 struct bt_iter
*iter
;
324 iter
= g_new0(struct bt_iter
, 1);
325 iter
->stream_heap
= g_new(struct ptr_heap
, 1);
326 iter
->end_pos
= end_pos
;
327 iter
->callbacks
= g_array_new(0, 1, sizeof(struct bt_stream_callbacks
));
328 iter
->recalculate_dep_graph
= 0;
329 iter
->main_callbacks
.callback
= NULL
;
330 iter
->dep_gc
= g_ptr_array_new();
334 ret
= heap_init(iter
->stream_heap
, 0, stream_compare
);
336 goto error_heap_init
;
338 for (i
= 0; i
< ctx
->tc
->array
->len
; i
++) {
339 struct ctf_trace
*tin
;
340 struct trace_descriptor
*td_read
;
342 td_read
= g_ptr_array_index(ctx
->tc
->array
, i
);
343 tin
= container_of(td_read
, struct ctf_trace
, parent
);
345 /* Populate heap with each stream */
346 for (stream_id
= 0; stream_id
< tin
->streams
->len
;
348 struct ctf_stream_class
*stream
;
351 stream
= g_ptr_array_index(tin
->streams
, stream_id
);
354 for (filenr
= 0; filenr
< stream
->streams
->len
;
356 struct ctf_file_stream
*file_stream
;
358 file_stream
= g_ptr_array_index(stream
->streams
,
362 ret
= babeltrace_filestream_seek(file_stream
, begin_pos
,
372 ret
= heap_insert(iter
->stream_heap
, file_stream
);
382 heap_free(iter
->stream_heap
);
384 g_free(iter
->stream_heap
);
389 void bt_iter_destroy(struct bt_iter
*iter
)
391 struct bt_stream_callbacks
*bt_stream_cb
;
392 struct bt_callback_chain
*bt_chain
;
395 heap_free(iter
->stream_heap
);
396 g_free(iter
->stream_heap
);
398 /* free all events callbacks */
399 if (iter
->main_callbacks
.callback
)
400 g_array_free(iter
->main_callbacks
.callback
, TRUE
);
402 /* free per-event callbacks */
403 for (i
= 0; i
< iter
->callbacks
->len
; i
++) {
404 bt_stream_cb
= &g_array_index(iter
->callbacks
,
405 struct bt_stream_callbacks
, i
);
406 if (!bt_stream_cb
|| !bt_stream_cb
->per_id_callbacks
)
408 for (j
= 0; j
< bt_stream_cb
->per_id_callbacks
->len
; j
++) {
409 bt_chain
= &g_array_index(bt_stream_cb
->per_id_callbacks
,
410 struct bt_callback_chain
, j
);
411 if (bt_chain
->callback
) {
412 g_array_free(bt_chain
->callback
, TRUE
);
415 g_array_free(bt_stream_cb
->per_id_callbacks
, TRUE
);
418 bt_context_put(iter
->ctx
);
423 int bt_iter_next(struct bt_iter
*iter
)
425 struct ctf_file_stream
*file_stream
, *removed
;
428 file_stream
= heap_maximum(iter
->stream_heap
);
430 /* end of file for all streams */
435 ret
= stream_read_event(file_stream
);
437 removed
= heap_remove(iter
->stream_heap
);
438 assert(removed
== file_stream
);
444 /* Reinsert the file stream into the heap, and rebalance. */
445 removed
= heap_replace_max(iter
->stream_heap
, file_stream
);
446 assert(removed
== file_stream
);
452 int bt_iter_read_event(struct bt_iter
*iter
,
453 struct ctf_stream
**stream
,
454 struct ctf_stream_event
**event
)
456 struct ctf_file_stream
*file_stream
;
459 file_stream
= heap_maximum(iter
->stream_heap
);
461 /* end of file for all streams */
465 *stream
= &file_stream
->parent
;
466 *event
= g_ptr_array_index((*stream
)->events_by_id
, (*stream
)->event_id
);
468 if ((*stream
)->stream_id
> iter
->callbacks
->len
)
471 process_callbacks(iter
, *stream
);