lib/iterator.c

   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.
  19  */
  20
  21 #include <stdlib.h>
  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>
  30 #include <inttypes.h>
  31
  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);
  35
  36 struct stream_saved_pos {
  37         /*
  38          * Use file_stream pointer to check if the trace collection we
  39          * restore to match the one we saved from, for each stream.
  40          */
  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_timestamp;
  45 };
  46
  47 struct bt_saved_pos {
  48         struct trace_collection *tc;
  49         GArray *stream_saved_pos;       /* Contains struct stream_saved_pos */
  50 };
  51
  52 static int stream_read_event(struct ctf_file_stream *sin)
  53 {
  54         int ret;
  55
  56         ret = sin->pos.parent.event_cb(&sin->pos.parent, &sin->parent);
  57         if (ret == EOF)
  58                 return EOF;
  59         else if (ret) {
  60                 fprintf(stderr, "[error] Reading event failed.\n");
  61                 return ret;
  62         }
  63         return 0;
  64 }
  65
  66 /*
  67  * returns true if a < b, false otherwise.
  68  */
  69 int stream_compare(void *a, void *b)
  70 {
  71         struct ctf_file_stream *s_a = a, *s_b = b;
  72
  73         if (s_a->parent.timestamp < s_b->parent.timestamp)
  74                 return 1;
  75         else
  76                 return 0;
  77 }
  78
  79 void bt_iter_free_pos(struct bt_iter_pos *iter_pos)
  80 {
  81         if (!iter_pos)
  82                 return;
  83
  84         if (iter_pos->type == BT_SEEK_RESTORE && iter_pos->u.restore) {
  85                 if (iter_pos->u.restore->stream_saved_pos) {
  86                         g_array_free(
  87                                 iter_pos->u.restore->stream_saved_pos,
  88                                 TRUE);
  89                 }
  90                 g_free(iter_pos->u.restore);
  91         }
  92         g_free(iter_pos);
  93 }
  94
  95 /*
  96  * seek_file_stream_by_timestamp
  97  *
  98  * Browse a filestream by index, if an index contains the timestamp passed in
  99  * argument, seek inside the corresponding packet it until we find the event we
 100  * are looking for (either the exact timestamp or the event just after the
 101  * timestamp).
 102  *
 103  * Return 0 if the seek succeded, EOF if we didn't find any packet
 104  * containing the timestamp, or a positive integer for error.
 105  */
 106 static int seek_file_stream_by_timestamp(struct ctf_file_stream *cfs,
 107                 uint64_t timestamp)
 108 {
 109         struct ctf_stream_pos *stream_pos;
 110         struct packet_index *index;
 111         int i, ret;
 112
 113         stream_pos = &cfs->pos;
 114         for (i = 0; i < stream_pos->packet_index->len; i++) {
 115                 index = &g_array_index(stream_pos->packet_index,
 116                                 struct packet_index, i);
 117                 if (index->timestamp_end < timestamp)
 118                         continue;
 119
 120                 stream_pos->packet_seek(&stream_pos->parent, i, SEEK_SET);
 121                 do {
 122                         ret = stream_read_event(cfs);
 123                 } while (cfs->parent.timestamp < timestamp && ret == 0);
 124
 125                 /* Can return either EOF, 0, or error (> 0). */
 126                 return ret;
 127         }
 128         /*
 129          * Cannot find the timestamp within the stream packets, return
 130          * EOF.
 131          */
 132         return EOF;
 133 }
 134
 135 /*
 136  * seek_ctf_trace_by_timestamp : for each file stream, seek to the event with
 137  * the corresponding timestamp
 138  *
 139  * Return 0 on success.
 140  * If the timestamp is not part of any file stream, return EOF to inform the
 141  * user the timestamp is out of the scope.
 142  * On other errors, return positive value.
 143  */
 144 static int seek_ctf_trace_by_timestamp(struct ctf_trace *tin,
 145                 uint64_t timestamp, struct ptr_heap *stream_heap)
 146 {
 147         int i, j, ret;
 148         int found = 0;
 149
 150         /* for each stream_class */
 151         for (i = 0; i < tin->streams->len; i++) {
 152                 struct ctf_stream_declaration *stream_class;
 153
 154                 stream_class = g_ptr_array_index(tin->streams, i);
 155                 if (!stream_class)
 156                         continue;
 157                 /* for each file_stream */
 158                 for (j = 0; j < stream_class->streams->len; j++) {
 159                         struct ctf_stream_definition *stream;
 160                         struct ctf_file_stream *cfs;
 161
 162                         stream = g_ptr_array_index(stream_class->streams, j);
 163                         if (!stream)
 164                                 continue;
 165                         cfs = container_of(stream, struct ctf_file_stream,
 166                                         parent);
 167                         ret = seek_file_stream_by_timestamp(cfs, timestamp);
 168                         if (ret == 0) {
 169                                 /* Add to heap */
 170                                 ret = heap_insert(stream_heap, cfs);
 171                                 if (ret) {
 172                                         /* Return positive error. */
 173                                         return -ret;
 174                                 }
 175                                 found = 1;
 176                         } else if (ret > 0) {
 177                                 /*
 178                                  * Error in seek (not EOF), failure.
 179                                  */
 180                                 return ret;
 181                         }
 182                         /* on EOF just do not put stream into heap. */
 183                 }
 184         }
 185
 186         return found ? 0 : EOF;
 187 }
 188
 189 int bt_iter_set_pos(struct bt_iter *iter, const struct bt_iter_pos *iter_pos)
 190 {
 191         struct trace_collection *tc;
 192         int i, ret;
 193
 194         switch (iter_pos->type) {
 195         case BT_SEEK_RESTORE:
 196                 if (!iter_pos->u.restore)
 197                         return -EINVAL;
 198
 199                 heap_free(iter->stream_heap);
 200                 ret = heap_init(iter->stream_heap, 0, stream_compare);
 201                 if (ret < 0)
 202                         goto error;
 203
 204                 for (i = 0; i < iter_pos->u.restore->stream_saved_pos->len;
 205                                 i++) {
 206                         struct stream_saved_pos *saved_pos;
 207                         struct ctf_stream_pos *stream_pos;
 208                         struct ctf_stream_definition *stream;
 209
 210                         saved_pos = &g_array_index(
 211                                         iter_pos->u.restore->stream_saved_pos,
 212                                         struct stream_saved_pos, i);
 213                         stream = &saved_pos->file_stream->parent;
 214                         stream_pos = &saved_pos->file_stream->pos;
 215
 216                         stream_pos->packet_seek(&stream_pos->parent,
 217                                         saved_pos->cur_index, SEEK_SET);
 218
 219                         /*
 220                          * the timestamp needs to be restored after
 221                          * packet_seek, because this function resets
 222                          * the timestamp to the beginning of the packet
 223                          */
 224                         stream->timestamp = saved_pos->current_timestamp;
 225                         stream_pos->offset = saved_pos->offset;
 226                         stream_pos->last_offset = LAST_OFFSET_POISON;
 227
 228                         stream->prev_timestamp = 0;
 229                         stream->prev_timestamp_end = 0;
 230
 231                         printf_debug("restored to cur_index = %zd and "
 232                                 "offset = %zd, timestamp = %" PRIu64 "\n",
 233                                 stream_pos->cur_index,
 234                                 stream_pos->offset, stream->timestamp);
 235
 236                         stream_read_event(saved_pos->file_stream);
 237
 238                         /* Add to heap */
 239                         ret = heap_insert(iter->stream_heap,
 240                                         saved_pos->file_stream);
 241                         if (ret)
 242                                 goto error;
 243                 }
 244                 return 0;
 245         case BT_SEEK_TIME:
 246                 tc = iter->ctx->tc;
 247
 248                 heap_free(iter->stream_heap);
 249                 ret = heap_init(iter->stream_heap, 0, stream_compare);
 250                 if (ret < 0)
 251                         goto error;
 252
 253                 /* for each trace in the trace_collection */
 254                 for (i = 0; i < tc->array->len; i++) {
 255                         struct ctf_trace *tin;
 256                         struct trace_descriptor *td_read;
 257
 258                         td_read = g_ptr_array_index(tc->array, i);
 259                         if (!td_read)
 260                                 continue;
 261                         tin = container_of(td_read, struct ctf_trace, parent);
 262
 263                         ret = seek_ctf_trace_by_timestamp(tin,
 264                                         iter_pos->u.seek_time,
 265                                         iter->stream_heap);
 266                         /*
 267                          * Positive errors are failure. Negative value
 268                          * is EOF (for which we continue with other
 269                          * traces). 0 is success. Note: on EOF, it just
 270                          * means that no stream has been added to the
 271                          * iterator for that trace, which is fine.
 272                          */
 273                         if (ret != 0 && ret != EOF)
 274                                 goto error;
 275                 }
 276                 return 0;
 277         case BT_SEEK_BEGIN:
 278                 tc = iter->ctx->tc;
 279                 heap_free(iter->stream_heap);
 280                 ret = heap_init(iter->stream_heap, 0, stream_compare);
 281                 if (ret < 0)
 282                         goto error;
 283
 284                 for (i = 0; i < tc->array->len; i++) {
 285                         struct ctf_trace *tin;
 286                         struct trace_descriptor *td_read;
 287                         int stream_id;
 288
 289                         td_read = g_ptr_array_index(tc->array, i);
 290                         if (!td_read)
 291                                 continue;
 292                         tin = container_of(td_read, struct ctf_trace, parent);
 293
 294                         /* Populate heap with each stream */
 295                         for (stream_id = 0; stream_id < tin->streams->len;
 296                                         stream_id++) {
 297                                 struct ctf_stream_declaration *stream;
 298                                 int filenr;
 299
 300                                 stream = g_ptr_array_index(tin->streams,
 301                                                 stream_id);
 302                                 if (!stream)
 303                                         continue;
 304                                 for (filenr = 0; filenr < stream->streams->len;
 305                                                 filenr++) {
 306                                         struct ctf_file_stream *file_stream;
 307                                         file_stream = g_ptr_array_index(
 308                                                         stream->streams,
 309                                                         filenr);
 310                                         if (!file_stream)
 311                                                 continue;
 312                                         ret = babeltrace_filestream_seek(
 313                                                         file_stream, iter_pos,
 314                                                         stream_id);
 315                                         if (ret != 0 && ret != EOF) {
 316                                                 goto error;
 317                                         }
 318                                         ret = heap_insert(iter->stream_heap, file_stream);
 319                                         if (ret)
 320                                                 goto error;
 321                                 }
 322                         }
 323                 }
 324                 break;
 325         default:
 326                 /* not implemented */
 327                 return -EINVAL;
 328         }
 329
 330         return 0;
 331
 332 error:
 333         heap_free(iter->stream_heap);
 334         if (heap_init(iter->stream_heap, 0, stream_compare) < 0) {
 335                 heap_free(iter->stream_heap);
 336                 g_free(iter->stream_heap);
 337                 iter->stream_heap = NULL;
 338                 ret = -ENOMEM;
 339         }
 340         return ret;
 341 }
 342
 343 struct bt_iter_pos *bt_iter_get_pos(struct bt_iter *iter)
 344 {
 345         struct bt_iter_pos *pos;
 346         struct trace_collection *tc = iter->ctx->tc;
 347         struct ctf_file_stream *file_stream = NULL, *removed;
 348         struct ptr_heap iter_heap_copy;
 349         int ret;
 350
 351         pos = g_new0(struct bt_iter_pos, 1);
 352         pos->type = BT_SEEK_RESTORE;
 353         pos->u.restore = g_new0(struct bt_saved_pos, 1);
 354         pos->u.restore->tc = tc;
 355         pos->u.restore->stream_saved_pos = g_array_new(FALSE, TRUE,
 356                         sizeof(struct stream_saved_pos));
 357         if (!pos->u.restore->stream_saved_pos)
 358                 goto error;
 359
 360         ret = heap_copy(&iter_heap_copy, iter->stream_heap);
 361         if (ret < 0)
 362                 goto error_heap;
 363
 364         /* iterate over each stream in the heap */
 365         file_stream = heap_maximum(&iter_heap_copy);
 366         while (file_stream != NULL) {
 367                 struct stream_saved_pos saved_pos;
 368
 369                 assert(file_stream->pos.last_offset != LAST_OFFSET_POISON);
 370                 saved_pos.offset = file_stream->pos.last_offset;
 371                 saved_pos.file_stream = file_stream;
 372                 saved_pos.cur_index = file_stream->pos.cur_index;
 373
 374                 saved_pos.current_timestamp = file_stream->parent.timestamp;
 375
 376                 g_array_append_val(
 377                                 pos->u.restore->stream_saved_pos,
 378                                 saved_pos);
 379
 380                 printf_debug("stream : %" PRIu64 ", cur_index : %zd, "
 381                                 "offset : %zd, "
 382                                 "timestamp = %" PRIu64 "\n",
 383                                 file_stream->parent.stream_id,
 384                                 saved_pos.cur_index, saved_pos.offset,
 385                                 saved_pos.current_timestamp);
 386
 387                 /* remove the stream from the heap copy */
 388                 removed = heap_remove(&iter_heap_copy);
 389                 assert(removed == file_stream);
 390
 391                 file_stream = heap_maximum(&iter_heap_copy);
 392         }
 393         heap_free(&iter_heap_copy);
 394         return pos;
 395
 396 error_heap:
 397         g_array_free(pos->u.restore->stream_saved_pos, TRUE);
 398 error:
 399         g_free(pos);
 400         return NULL;
 401 }
 402
 403 struct bt_iter_pos *bt_iter_create_time_pos(struct bt_iter *iter,
 404                 uint64_t timestamp)
 405 {
 406         struct bt_iter_pos *pos;
 407
 408         pos = g_new0(struct bt_iter_pos, 1);
 409         pos->type = BT_SEEK_TIME;
 410         pos->u.seek_time = timestamp;
 411         return pos;
 412 }
 413
 414 /*
 415  * babeltrace_filestream_seek: seek a filestream to given position.
 416  *
 417  * The stream_id parameter is only useful for BT_SEEK_RESTORE.
 418  */
 419 static int babeltrace_filestream_seek(struct ctf_file_stream *file_stream,
 420                 const struct bt_iter_pos *begin_pos,
 421                 unsigned long stream_id)
 422 {
 423         int ret = 0;
 424
 425         switch (begin_pos->type) {
 426         case BT_SEEK_CUR:
 427                 /*
 428                  * just insert into the heap we should already know
 429                  * the timestamps
 430                  */
 431                 break;
 432         case BT_SEEK_BEGIN:
 433                 file_stream->pos.packet_seek(&file_stream->pos.parent,
 434                                 0, SEEK_SET);
 435                 ret = stream_read_event(file_stream);
 436                 break;
 437         case BT_SEEK_TIME:
 438         case BT_SEEK_RESTORE:
 439         case BT_SEEK_END:
 440         default:
 441                 assert(0); /* Not yet defined */
 442         }
 443
 444         return ret;
 445 }
 446
 447 /*
 448  * bt_iter_seek: seek iterator to given position.
 449  */
 450 int bt_iter_seek(struct bt_iter *iter,
 451                 const struct bt_iter_pos *begin_pos)
 452 {
 453         int i, stream_id;
 454         int ret = 0;
 455         struct trace_collection *tc = iter->ctx->tc;
 456
 457         for (i = 0; i < tc->array->len; i++) {
 458                 struct ctf_trace *tin;
 459                 struct trace_descriptor *td_read;
 460
 461                 td_read = g_ptr_array_index(tc->array, i);
 462                 if (!td_read)
 463                         continue;
 464                 tin = container_of(td_read, struct ctf_trace, parent);
 465
 466                 /* Populate heap with each stream */
 467                 for (stream_id = 0; stream_id < tin->streams->len;
 468                                 stream_id++) {
 469                         struct ctf_stream_declaration *stream;
 470                         int filenr;
 471
 472                         stream = g_ptr_array_index(tin->streams, stream_id);
 473                         if (!stream)
 474                                 continue;
 475                         for (filenr = 0; filenr < stream->streams->len;
 476                                         filenr++) {
 477                                 struct ctf_file_stream *file_stream;
 478
 479                                 file_stream = g_ptr_array_index(stream->streams,
 480                                                 filenr);
 481                                 if (!file_stream)
 482                                         continue;
 483                                 ret = babeltrace_filestream_seek(file_stream, begin_pos,
 484                                                 stream_id);
 485                                 if (ret < 0)
 486                                         goto end;
 487                         }
 488                 }
 489         }
 490 end:
 491         return ret;
 492 }
 493
 494 int bt_iter_init(struct bt_iter *iter,
 495                 struct bt_context *ctx,
 496                 const struct bt_iter_pos *begin_pos,
 497                 const struct bt_iter_pos *end_pos)
 498 {
 499         int i, stream_id;
 500         int ret = 0;
 501
 502         if (ctx->current_iterator) {
 503                 ret = -1;
 504                 goto error_ctx;
 505         }
 506
 507         iter->stream_heap = g_new(struct ptr_heap, 1);
 508         iter->end_pos = end_pos;
 509         bt_context_get(ctx);
 510         iter->ctx = ctx;
 511
 512         ret = heap_init(iter->stream_heap, 0, stream_compare);
 513         if (ret < 0)
 514                 goto error_heap_init;
 515
 516         for (i = 0; i < ctx->tc->array->len; i++) {
 517                 struct ctf_trace *tin;
 518                 struct trace_descriptor *td_read;
 519
 520                 td_read = g_ptr_array_index(ctx->tc->array, i);
 521                 if (!td_read)
 522                         continue;
 523                 tin = container_of(td_read, struct ctf_trace, parent);
 524
 525                 /* Populate heap with each stream */
 526                 for (stream_id = 0; stream_id < tin->streams->len;
 527                                 stream_id++) {
 528                         struct ctf_stream_declaration *stream;
 529                         int filenr;
 530
 531                         stream = g_ptr_array_index(tin->streams, stream_id);
 532                         if (!stream)
 533                                 continue;
 534                         for (filenr = 0; filenr < stream->streams->len;
 535                                         filenr++) {
 536                                 struct ctf_file_stream *file_stream;
 537
 538                                 file_stream = g_ptr_array_index(stream->streams,
 539                                                 filenr);
 540                                 if (!file_stream)
 541                                         continue;
 542                                 if (begin_pos) {
 543                                         ret = babeltrace_filestream_seek(
 544                                                         file_stream,
 545                                                         begin_pos,
 546                                                         stream_id);
 547                                 } else {
 548                                         struct bt_iter_pos pos;
 549                                         pos.type = BT_SEEK_BEGIN;
 550                                         ret = babeltrace_filestream_seek(
 551                                                         file_stream, &pos,
 552                                                         stream_id);
 553                                 }
 554                                 if (ret == EOF) {
 555                                         ret = 0;
 556                                         continue;
 557                                 } else if (ret) {
 558                                         goto error;
 559                                 }
 560                                 /* Add to heap */
 561                                 ret = heap_insert(iter->stream_heap, file_stream);
 562                                 if (ret)
 563                                         goto error;
 564                         }
 565                 }
 566         }
 567
 568         ctx->current_iterator = iter;
 569         return 0;
 570
 571 error:
 572         heap_free(iter->stream_heap);
 573 error_heap_init:
 574         g_free(iter->stream_heap);
 575 error_ctx:
 576         return ret;
 577 }
 578
 579 struct bt_iter *bt_iter_create(struct bt_context *ctx,
 580                 const struct bt_iter_pos *begin_pos,
 581                 const struct bt_iter_pos *end_pos)
 582 {
 583         struct bt_iter *iter;
 584         int ret;
 585
 586         iter = g_new0(struct bt_iter, 1);
 587         ret = bt_iter_init(iter, ctx, begin_pos, end_pos);
 588         if (ret) {
 589                 g_free(iter);
 590                 return NULL;
 591         }
 592         return iter;
 593 }
 594
 595 void bt_iter_fini(struct bt_iter *iter)
 596 {
 597         if (iter->stream_heap) {
 598                 heap_free(iter->stream_heap);
 599                 g_free(iter->stream_heap);
 600         }
 601         iter->ctx->current_iterator = NULL;
 602         bt_context_put(iter->ctx);
 603 }
 604
 605 void bt_iter_destroy(struct bt_iter *iter)
 606 {
 607         bt_iter_fini(iter);
 608         g_free(iter);
 609 }
 610
 611 int bt_iter_next(struct bt_iter *iter)
 612 {
 613         struct ctf_file_stream *file_stream, *removed;
 614         int ret;
 615
 616         file_stream = heap_maximum(iter->stream_heap);
 617         if (!file_stream) {
 618                 /* end of file for all streams */
 619                 ret = 0;
 620                 goto end;
 621         }
 622
 623         ret = stream_read_event(file_stream);
 624         if (ret == EOF) {
 625                 removed = heap_remove(iter->stream_heap);
 626                 assert(removed == file_stream);
 627                 ret = 0;
 628                 goto end;
 629         } else if (ret) {
 630                 goto end;
 631         }
 632         /* Reinsert the file stream into the heap, and rebalance. */
 633         removed = heap_replace_max(iter->stream_heap, file_stream);
 634         assert(removed == file_stream);
 635
 636 end:
 637         return ret;
 638 }