Commit | Line | Data |
---|---|---|
6f3077a2 JD |
1 | /* |
2 | * iterator.c | |
3 | * | |
4 | * Babeltrace Library | |
5 | * | |
6 | * Copyright 2010-2011 EfficiOS Inc. and Linux Foundation | |
7 | * | |
8 | * Author: Mathieu Desnoyers <mathieu.desnoyers@efficios.com> | |
9 | * | |
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: | |
16 | * | |
17 | * The above copyright notice and this permission notice shall be included in | |
18 | * all copies or substantial portions of the Software. | |
c462e188 MD |
19 | * |
20 | * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR | |
21 | * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, | |
22 | * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE | |
23 | * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER | |
24 | * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, | |
25 | * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE | |
26 | * SOFTWARE. | |
6f3077a2 JD |
27 | */ |
28 | ||
29 | #include <stdlib.h> | |
30 | #include <babeltrace/babeltrace.h> | |
95d36295 | 31 | #include <babeltrace/context.h> |
08c22d05 | 32 | #include <babeltrace/context-internal.h> |
6f3077a2 | 33 | #include <babeltrace/iterator-internal.h> |
6204d33c | 34 | #include <babeltrace/iterator.h> |
6f3077a2 | 35 | #include <babeltrace/prio_heap.h> |
e4195791 | 36 | #include <babeltrace/ctf/metadata.h> |
9843982d | 37 | #include <babeltrace/ctf/events.h> |
90fcbacc | 38 | #include <inttypes.h> |
6f3077a2 | 39 | |
55c21ea5 JD |
40 | static int babeltrace_filestream_seek(struct ctf_file_stream *file_stream, |
41 | const struct bt_iter_pos *begin_pos, | |
42 | unsigned long stream_id); | |
43 | ||
6f3077a2 JD |
44 | struct stream_saved_pos { |
45 | /* | |
46 | * Use file_stream pointer to check if the trace collection we | |
47 | * restore to match the one we saved from, for each stream. | |
48 | */ | |
49 | struct ctf_file_stream *file_stream; | |
50 | size_t cur_index; /* current index in packet index */ | |
51 | ssize_t offset; /* offset from base, in bits. EOF for end of file. */ | |
03798a93 JD |
52 | uint64_t current_real_timestamp; |
53 | uint64_t current_cycles_timestamp; | |
6f3077a2 JD |
54 | }; |
55 | ||
e8c92a62 | 56 | struct bt_saved_pos { |
6f3077a2 JD |
57 | struct trace_collection *tc; |
58 | GArray *stream_saved_pos; /* Contains struct stream_saved_pos */ | |
59 | }; | |
60 | ||
61 | static int stream_read_event(struct ctf_file_stream *sin) | |
62 | { | |
63 | int ret; | |
64 | ||
65 | ret = sin->pos.parent.event_cb(&sin->pos.parent, &sin->parent); | |
66 | if (ret == EOF) | |
67 | return EOF; | |
8793d9f8 JD |
68 | else if (ret == EAGAIN) |
69 | /* Stream is inactive for now (live reading). */ | |
70 | return EAGAIN; | |
6f3077a2 | 71 | else if (ret) { |
3394d22e | 72 | fprintf(stderr, "[error] Reading event failed.\n"); |
6f3077a2 JD |
73 | return ret; |
74 | } | |
75 | return 0; | |
76 | } | |
77 | ||
78 | /* | |
6c9a50c0 MD |
79 | * Return true if a < b, false otherwise. |
80 | * If time stamps are exactly the same, compare by stream path. This | |
81 | * ensures we get the same result between runs on the same trace | |
82 | * collection on different environments. | |
83 | * The result will be random for memory-mapped traces since there is no | |
84 | * fixed path leading to those (they have empty path string). | |
6f3077a2 | 85 | */ |
2002e48a | 86 | static int stream_compare(void *a, void *b) |
6f3077a2 JD |
87 | { |
88 | struct ctf_file_stream *s_a = a, *s_b = b; | |
89 | ||
6c9a50c0 | 90 | if (s_a->parent.real_timestamp < s_b->parent.real_timestamp) { |
6f3077a2 | 91 | return 1; |
6c9a50c0 | 92 | } else if (likely(s_a->parent.real_timestamp > s_b->parent.real_timestamp)) { |
6f3077a2 | 93 | return 0; |
6c9a50c0 MD |
94 | } else { |
95 | return strcmp(s_a->parent.path, s_b->parent.path); | |
96 | } | |
6f3077a2 JD |
97 | } |
98 | ||
90fcbacc JD |
99 | void bt_iter_free_pos(struct bt_iter_pos *iter_pos) |
100 | { | |
6cba487f MD |
101 | if (!iter_pos) |
102 | return; | |
103 | ||
5acdc773 | 104 | if (iter_pos->type == BT_SEEK_RESTORE && iter_pos->u.restore) { |
6cba487f MD |
105 | if (iter_pos->u.restore->stream_saved_pos) { |
106 | g_array_free( | |
107 | iter_pos->u.restore->stream_saved_pos, | |
108 | TRUE); | |
90fcbacc | 109 | } |
6cba487f | 110 | g_free(iter_pos->u.restore); |
90fcbacc | 111 | } |
6cba487f | 112 | g_free(iter_pos); |
90fcbacc JD |
113 | } |
114 | ||
dc81689e JD |
115 | /* |
116 | * seek_file_stream_by_timestamp | |
117 | * | |
118 | * Browse a filestream by index, if an index contains the timestamp passed in | |
119 | * argument, seek inside the corresponding packet it until we find the event we | |
120 | * are looking for (either the exact timestamp or the event just after the | |
121 | * timestamp). | |
122 | * | |
e32cb1e4 MD |
123 | * Return 0 if the seek succeded, EOF if we didn't find any packet |
124 | * containing the timestamp, or a positive integer for error. | |
f7ed6563 MD |
125 | * |
126 | * TODO: this should be turned into a binary search! It is currently | |
127 | * doing a linear search in the packets. This is a O(n) operation on a | |
128 | * very frequent code path. | |
dc81689e JD |
129 | */ |
130 | static int seek_file_stream_by_timestamp(struct ctf_file_stream *cfs, | |
131 | uint64_t timestamp) | |
132 | { | |
133 | struct ctf_stream_pos *stream_pos; | |
134 | struct packet_index *index; | |
135 | int i, ret; | |
136 | ||
137 | stream_pos = &cfs->pos; | |
992e8cc0 MD |
138 | for (i = 0; i < stream_pos->packet_index->len; i++) { |
139 | index = &g_array_index(stream_pos->packet_index, | |
dc81689e | 140 | struct packet_index, i); |
992e8cc0 | 141 | if (index->ts_real.timestamp_end < timestamp) |
dc81689e JD |
142 | continue; |
143 | ||
20d0dcf9 | 144 | stream_pos->packet_seek(&stream_pos->parent, i, SEEK_SET); |
5d2a5af2 | 145 | do { |
dc81689e | 146 | ret = stream_read_event(cfs); |
03798a93 | 147 | } while (cfs->parent.real_timestamp < timestamp && ret == 0); |
5d2a5af2 | 148 | |
e32cb1e4 MD |
149 | /* Can return either EOF, 0, or error (> 0). */ |
150 | return ret; | |
dc81689e | 151 | } |
e32cb1e4 MD |
152 | /* |
153 | * Cannot find the timestamp within the stream packets, return | |
154 | * EOF. | |
155 | */ | |
dc81689e JD |
156 | return EOF; |
157 | } | |
158 | ||
159 | /* | |
160 | * seek_ctf_trace_by_timestamp : for each file stream, seek to the event with | |
161 | * the corresponding timestamp | |
162 | * | |
163 | * Return 0 on success. | |
164 | * If the timestamp is not part of any file stream, return EOF to inform the | |
e32cb1e4 MD |
165 | * user the timestamp is out of the scope. |
166 | * On other errors, return positive value. | |
dc81689e JD |
167 | */ |
168 | static int seek_ctf_trace_by_timestamp(struct ctf_trace *tin, | |
169 | uint64_t timestamp, struct ptr_heap *stream_heap) | |
170 | { | |
171 | int i, j, ret; | |
e32cb1e4 | 172 | int found = 0; |
dc81689e JD |
173 | |
174 | /* for each stream_class */ | |
175 | for (i = 0; i < tin->streams->len; i++) { | |
f380e105 | 176 | struct ctf_stream_declaration *stream_class; |
dc81689e JD |
177 | |
178 | stream_class = g_ptr_array_index(tin->streams, i); | |
e32cb1e4 MD |
179 | if (!stream_class) |
180 | continue; | |
dc81689e JD |
181 | /* for each file_stream */ |
182 | for (j = 0; j < stream_class->streams->len; j++) { | |
9e88d150 | 183 | struct ctf_stream_definition *stream; |
dc81689e JD |
184 | struct ctf_file_stream *cfs; |
185 | ||
186 | stream = g_ptr_array_index(stream_class->streams, j); | |
e32cb1e4 MD |
187 | if (!stream) |
188 | continue; | |
dc81689e JD |
189 | cfs = container_of(stream, struct ctf_file_stream, |
190 | parent); | |
191 | ret = seek_file_stream_by_timestamp(cfs, timestamp); | |
192 | if (ret == 0) { | |
193 | /* Add to heap */ | |
dd06413f | 194 | ret = bt_heap_insert(stream_heap, cfs); |
e32cb1e4 MD |
195 | if (ret) { |
196 | /* Return positive error. */ | |
197 | return -ret; | |
198 | } | |
199 | found = 1; | |
200 | } else if (ret > 0) { | |
201 | /* | |
202 | * Error in seek (not EOF), failure. | |
203 | */ | |
204 | return ret; | |
dc81689e | 205 | } |
e32cb1e4 | 206 | /* on EOF just do not put stream into heap. */ |
dc81689e JD |
207 | } |
208 | } | |
209 | ||
e32cb1e4 | 210 | return found ? 0 : EOF; |
dc81689e JD |
211 | } |
212 | ||
f7ed6563 MD |
213 | /* |
214 | * Find timestamp of last event in the stream. | |
215 | * | |
216 | * Return value: 0 if OK, positive error value on error, EOF if no | |
217 | * events were found. | |
218 | */ | |
219 | static int find_max_timestamp_ctf_file_stream(struct ctf_file_stream *cfs, | |
220 | uint64_t *timestamp_end) | |
221 | { | |
222 | int ret, count = 0, i; | |
223 | uint64_t timestamp = 0; | |
224 | struct ctf_stream_pos *stream_pos; | |
225 | ||
226 | stream_pos = &cfs->pos; | |
227 | /* | |
228 | * We start by the last packet, and iterate backwards until we | |
229 | * either find at least one event, or we reach the first packet | |
230 | * (some packets can be empty). | |
231 | */ | |
992e8cc0 | 232 | for (i = stream_pos->packet_index->len - 1; i >= 0; i--) { |
f7ed6563 MD |
233 | stream_pos->packet_seek(&stream_pos->parent, i, SEEK_SET); |
234 | count = 0; | |
235 | /* read each event until we reach the end of the stream */ | |
236 | do { | |
237 | ret = stream_read_event(cfs); | |
238 | if (ret == 0) { | |
239 | count++; | |
240 | timestamp = cfs->parent.real_timestamp; | |
241 | } | |
242 | } while (ret == 0); | |
243 | ||
244 | /* Error */ | |
245 | if (ret > 0) | |
246 | goto end; | |
247 | assert(ret == EOF); | |
248 | if (count) | |
249 | break; | |
250 | } | |
251 | ||
252 | if (count) { | |
253 | *timestamp_end = timestamp; | |
254 | ret = 0; | |
255 | } else { | |
256 | /* Return EOF if no events were found */ | |
257 | ret = EOF; | |
258 | } | |
259 | end: | |
260 | return ret; | |
261 | } | |
262 | ||
263 | /* | |
264 | * Find the stream within a stream class that contains the event with | |
265 | * the largest timestamp, and save that timestamp. | |
266 | * | |
267 | * Return 0 if OK, EOF if no events were found in the streams, or | |
268 | * positive value on error. | |
269 | */ | |
270 | static int find_max_timestamp_ctf_stream_class( | |
271 | struct ctf_stream_declaration *stream_class, | |
272 | struct ctf_file_stream **cfsp, | |
273 | uint64_t *max_timestamp) | |
274 | { | |
38380786 | 275 | int ret = EOF, i, found = 0; |
f7ed6563 MD |
276 | |
277 | for (i = 0; i < stream_class->streams->len; i++) { | |
278 | struct ctf_stream_definition *stream; | |
279 | struct ctf_file_stream *cfs; | |
280 | uint64_t current_max_ts = 0; | |
281 | ||
282 | stream = g_ptr_array_index(stream_class->streams, i); | |
283 | if (!stream) | |
284 | continue; | |
285 | cfs = container_of(stream, struct ctf_file_stream, parent); | |
286 | ret = find_max_timestamp_ctf_file_stream(cfs, ¤t_max_ts); | |
287 | if (ret == EOF) | |
288 | continue; | |
289 | if (ret != 0) | |
290 | break; | |
291 | if (current_max_ts >= *max_timestamp) { | |
292 | *max_timestamp = current_max_ts; | |
293 | *cfsp = cfs; | |
38380786 | 294 | found = 1; |
f7ed6563 MD |
295 | } |
296 | } | |
297 | assert(ret >= 0 || ret == EOF); | |
38380786 YB |
298 | if (found) { |
299 | return 0; | |
300 | } | |
f7ed6563 MD |
301 | return ret; |
302 | } | |
303 | ||
304 | /* | |
305 | * seek_last_ctf_trace_collection: seek trace collection to last event. | |
306 | * | |
307 | * Return 0 if OK, EOF if no events were found, or positive error value | |
308 | * on error. | |
309 | */ | |
310 | static int seek_last_ctf_trace_collection(struct trace_collection *tc, | |
311 | struct ctf_file_stream **cfsp) | |
312 | { | |
313 | int i, j, ret; | |
314 | int found = 0; | |
315 | uint64_t max_timestamp = 0; | |
316 | ||
317 | if (!tc) | |
318 | return 1; | |
319 | ||
320 | /* For each trace in the trace_collection */ | |
321 | for (i = 0; i < tc->array->len; i++) { | |
322 | struct ctf_trace *tin; | |
1b8455b7 | 323 | struct bt_trace_descriptor *td_read; |
f7ed6563 MD |
324 | |
325 | td_read = g_ptr_array_index(tc->array, i); | |
326 | if (!td_read) | |
327 | continue; | |
328 | tin = container_of(td_read, struct ctf_trace, parent); | |
329 | /* For each stream_class in the trace */ | |
330 | for (j = 0; j < tin->streams->len; j++) { | |
331 | struct ctf_stream_declaration *stream_class; | |
332 | ||
333 | stream_class = g_ptr_array_index(tin->streams, j); | |
334 | if (!stream_class) | |
335 | continue; | |
336 | ret = find_max_timestamp_ctf_stream_class(stream_class, | |
337 | cfsp, &max_timestamp); | |
338 | if (ret > 0) | |
339 | goto end; | |
340 | if (ret == 0) | |
341 | found = 1; | |
342 | assert(ret == EOF || ret == 0); | |
343 | } | |
344 | } | |
345 | /* | |
346 | * Now we know in which file stream the last event is located, | |
347 | * and we know its timestamp. | |
348 | */ | |
349 | if (!found) { | |
350 | ret = EOF; | |
351 | } else { | |
352 | ret = seek_file_stream_by_timestamp(*cfsp, max_timestamp); | |
353 | assert(ret == 0); | |
354 | } | |
355 | end: | |
356 | return ret; | |
357 | } | |
358 | ||
90fcbacc JD |
359 | int bt_iter_set_pos(struct bt_iter *iter, const struct bt_iter_pos *iter_pos) |
360 | { | |
dc81689e | 361 | struct trace_collection *tc; |
90fcbacc JD |
362 | int i, ret; |
363 | ||
7f89ddce MD |
364 | if (!iter || !iter_pos) |
365 | return -EINVAL; | |
366 | ||
dc81689e JD |
367 | switch (iter_pos->type) { |
368 | case BT_SEEK_RESTORE: | |
369 | if (!iter_pos->u.restore) | |
7344374e | 370 | return -EINVAL; |
dc81689e | 371 | |
dd06413f JD |
372 | bt_heap_free(iter->stream_heap); |
373 | ret = bt_heap_init(iter->stream_heap, 0, stream_compare); | |
90fcbacc | 374 | if (ret < 0) |
bed54c92 | 375 | goto error_heap_init; |
90fcbacc JD |
376 | |
377 | for (i = 0; i < iter_pos->u.restore->stream_saved_pos->len; | |
378 | i++) { | |
379 | struct stream_saved_pos *saved_pos; | |
380 | struct ctf_stream_pos *stream_pos; | |
9e88d150 | 381 | struct ctf_stream_definition *stream; |
90fcbacc JD |
382 | |
383 | saved_pos = &g_array_index( | |
384 | iter_pos->u.restore->stream_saved_pos, | |
385 | struct stream_saved_pos, i); | |
386 | stream = &saved_pos->file_stream->parent; | |
387 | stream_pos = &saved_pos->file_stream->pos; | |
90fcbacc | 388 | |
06789ffd | 389 | stream_pos->packet_seek(&stream_pos->parent, |
20d0dcf9 | 390 | saved_pos->cur_index, SEEK_SET); |
90fcbacc JD |
391 | |
392 | /* | |
393 | * the timestamp needs to be restored after | |
06789ffd | 394 | * packet_seek, because this function resets |
90fcbacc JD |
395 | * the timestamp to the beginning of the packet |
396 | */ | |
03798a93 JD |
397 | stream->real_timestamp = saved_pos->current_real_timestamp; |
398 | stream->cycles_timestamp = saved_pos->current_cycles_timestamp; | |
90fcbacc | 399 | stream_pos->offset = saved_pos->offset; |
3a25e036 | 400 | stream_pos->last_offset = LAST_OFFSET_POISON; |
90fcbacc | 401 | |
2654fe9b MD |
402 | stream->current.real.begin = 0; |
403 | stream->current.real.end = 0; | |
404 | stream->current.cycles.begin = 0; | |
405 | stream->current.cycles.end = 0; | |
406 | ||
407 | stream->prev.real.begin = 0; | |
408 | stream->prev.real.end = 0; | |
409 | stream->prev.cycles.begin = 0; | |
410 | stream->prev.cycles.end = 0; | |
90fcbacc | 411 | |
fef3bf22 MD |
412 | printf_debug("restored to cur_index = %" PRId64 " and " |
413 | "offset = %" PRId64 ", timestamp = %" PRIu64 "\n", | |
90fcbacc | 414 | stream_pos->cur_index, |
03798a93 | 415 | stream_pos->offset, stream->real_timestamp); |
90fcbacc | 416 | |
28fcbaca MD |
417 | ret = stream_read_event(saved_pos->file_stream); |
418 | if (ret != 0) { | |
419 | goto error; | |
420 | } | |
90fcbacc JD |
421 | |
422 | /* Add to heap */ | |
dd06413f | 423 | ret = bt_heap_insert(iter->stream_heap, |
90fcbacc JD |
424 | saved_pos->file_stream); |
425 | if (ret) | |
426 | goto error; | |
427 | } | |
5acdc773 | 428 | return 0; |
dc81689e JD |
429 | case BT_SEEK_TIME: |
430 | tc = iter->ctx->tc; | |
431 | ||
dd06413f JD |
432 | bt_heap_free(iter->stream_heap); |
433 | ret = bt_heap_init(iter->stream_heap, 0, stream_compare); | |
dc81689e | 434 | if (ret < 0) |
bed54c92 | 435 | goto error_heap_init; |
dc81689e JD |
436 | |
437 | /* for each trace in the trace_collection */ | |
438 | for (i = 0; i < tc->array->len; i++) { | |
439 | struct ctf_trace *tin; | |
1b8455b7 | 440 | struct bt_trace_descriptor *td_read; |
dc81689e JD |
441 | |
442 | td_read = g_ptr_array_index(tc->array, i); | |
e32cb1e4 MD |
443 | if (!td_read) |
444 | continue; | |
dc81689e JD |
445 | tin = container_of(td_read, struct ctf_trace, parent); |
446 | ||
447 | ret = seek_ctf_trace_by_timestamp(tin, | |
448 | iter_pos->u.seek_time, | |
449 | iter->stream_heap); | |
e32cb1e4 MD |
450 | /* |
451 | * Positive errors are failure. Negative value | |
452 | * is EOF (for which we continue with other | |
453 | * traces). 0 is success. Note: on EOF, it just | |
454 | * means that no stream has been added to the | |
455 | * iterator for that trace, which is fine. | |
456 | */ | |
457 | if (ret != 0 && ret != EOF) | |
dc81689e JD |
458 | goto error; |
459 | } | |
460 | return 0; | |
55c21ea5 JD |
461 | case BT_SEEK_BEGIN: |
462 | tc = iter->ctx->tc; | |
dd06413f JD |
463 | bt_heap_free(iter->stream_heap); |
464 | ret = bt_heap_init(iter->stream_heap, 0, stream_compare); | |
db8a4511 | 465 | if (ret < 0) |
bed54c92 | 466 | goto error_heap_init; |
db8a4511 | 467 | |
55c21ea5 JD |
468 | for (i = 0; i < tc->array->len; i++) { |
469 | struct ctf_trace *tin; | |
1b8455b7 | 470 | struct bt_trace_descriptor *td_read; |
55c21ea5 JD |
471 | int stream_id; |
472 | ||
473 | td_read = g_ptr_array_index(tc->array, i); | |
e32cb1e4 MD |
474 | if (!td_read) |
475 | continue; | |
55c21ea5 JD |
476 | tin = container_of(td_read, struct ctf_trace, parent); |
477 | ||
478 | /* Populate heap with each stream */ | |
479 | for (stream_id = 0; stream_id < tin->streams->len; | |
480 | stream_id++) { | |
f380e105 | 481 | struct ctf_stream_declaration *stream; |
55c21ea5 JD |
482 | int filenr; |
483 | ||
484 | stream = g_ptr_array_index(tin->streams, | |
485 | stream_id); | |
486 | if (!stream) | |
487 | continue; | |
488 | for (filenr = 0; filenr < stream->streams->len; | |
489 | filenr++) { | |
490 | struct ctf_file_stream *file_stream; | |
491 | file_stream = g_ptr_array_index( | |
492 | stream->streams, | |
493 | filenr); | |
e32cb1e4 MD |
494 | if (!file_stream) |
495 | continue; | |
55c21ea5 JD |
496 | ret = babeltrace_filestream_seek( |
497 | file_stream, iter_pos, | |
498 | stream_id); | |
e32cb1e4 MD |
499 | if (ret != 0 && ret != EOF) { |
500 | goto error; | |
501 | } | |
08ac0e08 MD |
502 | if (ret == EOF) { |
503 | /* Do not add EOF streams */ | |
504 | continue; | |
505 | } | |
dd06413f | 506 | ret = bt_heap_insert(iter->stream_heap, file_stream); |
db8a4511 JD |
507 | if (ret) |
508 | goto error; | |
55c21ea5 JD |
509 | } |
510 | } | |
511 | } | |
512 | break; | |
f7ed6563 MD |
513 | case BT_SEEK_LAST: |
514 | { | |
4b8de153 | 515 | struct ctf_file_stream *cfs = NULL; |
f7ed6563 MD |
516 | |
517 | tc = iter->ctx->tc; | |
518 | ret = seek_last_ctf_trace_collection(tc, &cfs); | |
4b8de153 | 519 | if (ret != 0 || !cfs) |
f7ed6563 MD |
520 | goto error; |
521 | /* remove all streams from the heap */ | |
dd06413f | 522 | bt_heap_free(iter->stream_heap); |
f7ed6563 | 523 | /* Create a new empty heap */ |
dd06413f | 524 | ret = bt_heap_init(iter->stream_heap, 0, stream_compare); |
f7ed6563 MD |
525 | if (ret < 0) |
526 | goto error; | |
527 | /* Insert the stream that contains the last event */ | |
dd06413f | 528 | ret = bt_heap_insert(iter->stream_heap, cfs); |
f7ed6563 MD |
529 | if (ret) |
530 | goto error; | |
531 | break; | |
532 | } | |
dc81689e JD |
533 | default: |
534 | /* not implemented */ | |
7344374e | 535 | return -EINVAL; |
90fcbacc JD |
536 | } |
537 | ||
538 | return 0; | |
dc81689e | 539 | |
90fcbacc | 540 | error: |
dd06413f | 541 | bt_heap_free(iter->stream_heap); |
bed54c92 | 542 | error_heap_init: |
dd06413f JD |
543 | if (bt_heap_init(iter->stream_heap, 0, stream_compare) < 0) { |
544 | bt_heap_free(iter->stream_heap); | |
dc81689e JD |
545 | g_free(iter->stream_heap); |
546 | iter->stream_heap = NULL; | |
547 | ret = -ENOMEM; | |
548 | } | |
bed54c92 | 549 | |
dc81689e | 550 | return ret; |
90fcbacc JD |
551 | } |
552 | ||
553 | struct bt_iter_pos *bt_iter_get_pos(struct bt_iter *iter) | |
554 | { | |
555 | struct bt_iter_pos *pos; | |
7f89ddce | 556 | struct trace_collection *tc; |
6fabd7af JD |
557 | struct ctf_file_stream *file_stream = NULL, *removed; |
558 | struct ptr_heap iter_heap_copy; | |
559 | int ret; | |
90fcbacc | 560 | |
7f89ddce MD |
561 | if (!iter) |
562 | return NULL; | |
563 | ||
564 | tc = iter->ctx->tc; | |
90fcbacc | 565 | pos = g_new0(struct bt_iter_pos, 1); |
5acdc773 | 566 | pos->type = BT_SEEK_RESTORE; |
90fcbacc | 567 | pos->u.restore = g_new0(struct bt_saved_pos, 1); |
90fcbacc JD |
568 | pos->u.restore->tc = tc; |
569 | pos->u.restore->stream_saved_pos = g_array_new(FALSE, TRUE, | |
570 | sizeof(struct stream_saved_pos)); | |
571 | if (!pos->u.restore->stream_saved_pos) | |
572 | goto error; | |
573 | ||
dd06413f | 574 | ret = bt_heap_copy(&iter_heap_copy, iter->stream_heap); |
6fabd7af JD |
575 | if (ret < 0) |
576 | goto error_heap; | |
90fcbacc | 577 | |
6fabd7af | 578 | /* iterate over each stream in the heap */ |
dd06413f | 579 | file_stream = bt_heap_maximum(&iter_heap_copy); |
6fabd7af JD |
580 | while (file_stream != NULL) { |
581 | struct stream_saved_pos saved_pos; | |
90fcbacc | 582 | |
6fabd7af JD |
583 | assert(file_stream->pos.last_offset != LAST_OFFSET_POISON); |
584 | saved_pos.offset = file_stream->pos.last_offset; | |
585 | saved_pos.file_stream = file_stream; | |
586 | saved_pos.cur_index = file_stream->pos.cur_index; | |
90fcbacc | 587 | |
03798a93 JD |
588 | saved_pos.current_real_timestamp = file_stream->parent.real_timestamp; |
589 | saved_pos.current_cycles_timestamp = file_stream->parent.cycles_timestamp; | |
90fcbacc | 590 | |
6fabd7af JD |
591 | g_array_append_val( |
592 | pos->u.restore->stream_saved_pos, | |
593 | saved_pos); | |
90fcbacc | 594 | |
6fabd7af JD |
595 | printf_debug("stream : %" PRIu64 ", cur_index : %zd, " |
596 | "offset : %zd, " | |
597 | "timestamp = %" PRIu64 "\n", | |
598 | file_stream->parent.stream_id, | |
599 | saved_pos.cur_index, saved_pos.offset, | |
03798a93 | 600 | saved_pos.current_real_timestamp); |
6fabd7af JD |
601 | |
602 | /* remove the stream from the heap copy */ | |
dd06413f | 603 | removed = bt_heap_remove(&iter_heap_copy); |
6fabd7af JD |
604 | assert(removed == file_stream); |
605 | ||
dd06413f | 606 | file_stream = bt_heap_maximum(&iter_heap_copy); |
6fabd7af | 607 | } |
dd06413f | 608 | bt_heap_free(&iter_heap_copy); |
90fcbacc JD |
609 | return pos; |
610 | ||
6fabd7af JD |
611 | error_heap: |
612 | g_array_free(pos->u.restore->stream_saved_pos, TRUE); | |
90fcbacc | 613 | error: |
6fabd7af | 614 | g_free(pos); |
90fcbacc JD |
615 | return NULL; |
616 | } | |
617 | ||
dc81689e JD |
618 | struct bt_iter_pos *bt_iter_create_time_pos(struct bt_iter *iter, |
619 | uint64_t timestamp) | |
620 | { | |
621 | struct bt_iter_pos *pos; | |
622 | ||
7f89ddce MD |
623 | if (!iter) |
624 | return NULL; | |
625 | ||
dc81689e JD |
626 | pos = g_new0(struct bt_iter_pos, 1); |
627 | pos->type = BT_SEEK_TIME; | |
628 | pos->u.seek_time = timestamp; | |
629 | return pos; | |
630 | } | |
631 | ||
6f3077a2 JD |
632 | /* |
633 | * babeltrace_filestream_seek: seek a filestream to given position. | |
634 | * | |
635 | * The stream_id parameter is only useful for BT_SEEK_RESTORE. | |
636 | */ | |
637 | static int babeltrace_filestream_seek(struct ctf_file_stream *file_stream, | |
e8c92a62 | 638 | const struct bt_iter_pos *begin_pos, |
6f3077a2 JD |
639 | unsigned long stream_id) |
640 | { | |
641 | int ret = 0; | |
642 | ||
7f89ddce MD |
643 | if (!file_stream || !begin_pos) |
644 | return -EINVAL; | |
645 | ||
6f3077a2 JD |
646 | switch (begin_pos->type) { |
647 | case BT_SEEK_CUR: | |
648 | /* | |
649 | * just insert into the heap we should already know | |
650 | * the timestamps | |
651 | */ | |
652 | break; | |
653 | case BT_SEEK_BEGIN: | |
06789ffd | 654 | file_stream->pos.packet_seek(&file_stream->pos.parent, |
d6425aaf | 655 | 0, SEEK_SET); |
6f3077a2 JD |
656 | ret = stream_read_event(file_stream); |
657 | break; | |
658 | case BT_SEEK_TIME: | |
659 | case BT_SEEK_RESTORE: | |
6f3077a2 JD |
660 | default: |
661 | assert(0); /* Not yet defined */ | |
662 | } | |
663 | ||
664 | return ret; | |
665 | } | |
666 | ||
b587c608 JD |
667 | int bt_iter_add_trace(struct bt_iter *iter, |
668 | struct bt_trace_descriptor *td_read) | |
669 | { | |
670 | struct ctf_trace *tin; | |
788b424d | 671 | int stream_id, ret = 0; |
b587c608 JD |
672 | |
673 | tin = container_of(td_read, struct ctf_trace, parent); | |
674 | ||
675 | /* Populate heap with each stream */ | |
676 | for (stream_id = 0; stream_id < tin->streams->len; | |
677 | stream_id++) { | |
678 | struct ctf_stream_declaration *stream; | |
679 | int filenr; | |
680 | ||
681 | stream = g_ptr_array_index(tin->streams, stream_id); | |
682 | if (!stream) | |
683 | continue; | |
684 | for (filenr = 0; filenr < stream->streams->len; | |
685 | filenr++) { | |
686 | struct ctf_file_stream *file_stream; | |
687 | struct bt_iter_pos pos; | |
688 | ||
689 | file_stream = g_ptr_array_index(stream->streams, | |
690 | filenr); | |
691 | if (!file_stream) | |
692 | continue; | |
693 | ||
694 | pos.type = BT_SEEK_BEGIN; | |
695 | ret = babeltrace_filestream_seek(file_stream, | |
696 | &pos, stream_id); | |
697 | ||
698 | if (ret == EOF) { | |
699 | ret = 0; | |
700 | continue; | |
701 | } else if (ret != 0 && ret != EAGAIN) { | |
702 | goto error; | |
703 | } | |
704 | /* Add to heap */ | |
705 | ret = bt_heap_insert(iter->stream_heap, file_stream); | |
706 | if (ret) | |
707 | goto error; | |
708 | } | |
709 | } | |
710 | ||
711 | error: | |
712 | return ret; | |
713 | } | |
714 | ||
e4195791 MD |
715 | int bt_iter_init(struct bt_iter *iter, |
716 | struct bt_context *ctx, | |
04ae3991 MD |
717 | const struct bt_iter_pos *begin_pos, |
718 | const struct bt_iter_pos *end_pos) | |
6f3077a2 | 719 | { |
b587c608 | 720 | int i; |
6f3077a2 | 721 | int ret = 0; |
6f3077a2 | 722 | |
7f89ddce MD |
723 | if (!iter || !ctx) |
724 | return -EINVAL; | |
725 | ||
e003e871 JD |
726 | if (ctx->current_iterator) { |
727 | ret = -1; | |
728 | goto error_ctx; | |
729 | } | |
730 | ||
6f3077a2 | 731 | iter->stream_heap = g_new(struct ptr_heap, 1); |
6f3077a2 | 732 | iter->end_pos = end_pos; |
6cba487f | 733 | bt_context_get(ctx); |
95d36295 | 734 | iter->ctx = ctx; |
6f3077a2 | 735 | |
dd06413f | 736 | ret = bt_heap_init(iter->stream_heap, 0, stream_compare); |
6f3077a2 JD |
737 | if (ret < 0) |
738 | goto error_heap_init; | |
739 | ||
95d36295 | 740 | for (i = 0; i < ctx->tc->array->len; i++) { |
1b8455b7 | 741 | struct bt_trace_descriptor *td_read; |
6f3077a2 | 742 | |
95d36295 | 743 | td_read = g_ptr_array_index(ctx->tc->array, i); |
e32cb1e4 MD |
744 | if (!td_read) |
745 | continue; | |
b587c608 JD |
746 | ret = bt_iter_add_trace(iter, td_read); |
747 | if (ret < 0) | |
748 | goto error; | |
6f3077a2 JD |
749 | } |
750 | ||
e003e871 | 751 | ctx->current_iterator = iter; |
d899d6de JG |
752 | if (begin_pos && begin_pos->type != BT_SEEK_BEGIN) { |
753 | ret = bt_iter_set_pos(iter, begin_pos); | |
754 | } | |
755 | ||
756 | return ret; | |
6f3077a2 JD |
757 | |
758 | error: | |
dd06413f | 759 | bt_heap_free(iter->stream_heap); |
6f3077a2 JD |
760 | error_heap_init: |
761 | g_free(iter->stream_heap); | |
bed54c92 | 762 | iter->stream_heap = NULL; |
e003e871 | 763 | error_ctx: |
e4195791 | 764 | return ret; |
6f3077a2 JD |
765 | } |
766 | ||
e4195791 | 767 | struct bt_iter *bt_iter_create(struct bt_context *ctx, |
04ae3991 MD |
768 | const struct bt_iter_pos *begin_pos, |
769 | const struct bt_iter_pos *end_pos) | |
e4195791 MD |
770 | { |
771 | struct bt_iter *iter; | |
772 | int ret; | |
773 | ||
7f89ddce MD |
774 | if (!ctx) |
775 | return NULL; | |
776 | ||
e4195791 MD |
777 | iter = g_new0(struct bt_iter, 1); |
778 | ret = bt_iter_init(iter, ctx, begin_pos, end_pos); | |
779 | if (ret) { | |
780 | g_free(iter); | |
781 | return NULL; | |
782 | } | |
783 | return iter; | |
784 | } | |
785 | ||
786 | void bt_iter_fini(struct bt_iter *iter) | |
6f3077a2 | 787 | { |
7f89ddce | 788 | assert(iter); |
dc81689e | 789 | if (iter->stream_heap) { |
dd06413f | 790 | bt_heap_free(iter->stream_heap); |
dc81689e JD |
791 | g_free(iter->stream_heap); |
792 | } | |
e003e871 | 793 | iter->ctx->current_iterator = NULL; |
95d36295 | 794 | bt_context_put(iter->ctx); |
e4195791 | 795 | } |
95d36295 | 796 | |
e4195791 MD |
797 | void bt_iter_destroy(struct bt_iter *iter) |
798 | { | |
7f89ddce | 799 | assert(iter); |
e4195791 | 800 | bt_iter_fini(iter); |
90fcbacc | 801 | g_free(iter); |
6f3077a2 JD |
802 | } |
803 | ||
e8c92a62 | 804 | int bt_iter_next(struct bt_iter *iter) |
6f3077a2 JD |
805 | { |
806 | struct ctf_file_stream *file_stream, *removed; | |
807 | int ret; | |
808 | ||
7f89ddce MD |
809 | if (!iter) |
810 | return -EINVAL; | |
811 | ||
dd06413f | 812 | file_stream = bt_heap_maximum(iter->stream_heap); |
6f3077a2 JD |
813 | if (!file_stream) { |
814 | /* end of file for all streams */ | |
815 | ret = 0; | |
816 | goto end; | |
817 | } | |
818 | ||
819 | ret = stream_read_event(file_stream); | |
820 | if (ret == EOF) { | |
dd06413f | 821 | removed = bt_heap_remove(iter->stream_heap); |
6f3077a2 JD |
822 | assert(removed == file_stream); |
823 | ret = 0; | |
824 | goto end; | |
8793d9f8 JD |
825 | } else if (ret == EAGAIN) { |
826 | /* | |
500634be JD |
827 | * Live streaming: the stream is inactive for now, we |
828 | * just updated the timestamp_end to skip over this | |
829 | * stream up to a certain point in time. | |
830 | * | |
831 | * Since we can't guarantee that a stream will ever have | |
832 | * any activity, we can't rely on the fact that | |
833 | * bt_iter_next will be called for each stream and deal | |
834 | * with inactive streams. So instead, we return 0 here | |
835 | * to the caller and let the read API handle the | |
836 | * retry case. | |
8793d9f8 | 837 | */ |
500634be | 838 | ret = 0; |
8793d9f8 | 839 | goto reinsert; |
6f3077a2 JD |
840 | } else if (ret) { |
841 | goto end; | |
842 | } | |
8793d9f8 JD |
843 | |
844 | reinsert: | |
6f3077a2 | 845 | /* Reinsert the file stream into the heap, and rebalance. */ |
dd06413f | 846 | removed = bt_heap_replace_max(iter->stream_heap, file_stream); |
6f3077a2 | 847 | assert(removed == file_stream); |
6f3077a2 JD |
848 | end: |
849 | return ret; | |
850 | } |