include/babeltrace/iterator-internal.h

   1 #ifndef _BABELTRACE_ITERATOR_INTERNAL_H
   2 #define _BABELTRACE_ITERATOR_INTERNAL_H
   3
   4 /*
   5  * BabelTrace
   6  *
   7  * Internal iterator header
   8  *
   9  * Copyright 2010-2011 EfficiOS Inc. and Linux Foundation
  10  *
  11  * Author: Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
  12  *
  13  * Permission is hereby granted, free of charge, to any person obtaining a copy
  14  * of this software and associated documentation files (the "Software"), to deal
  15  * in the Software without restriction, including without limitation the rights
  16  * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
  17  * copies of the Software, and to permit persons to whom the Software is
  18  * furnished to do so, subject to the following conditions:
  19  *
  20  * The above copyright notice and this permission notice shall be included in
  21  * all copies or substantial portions of the Software.
  22  */
  23
  24 #include <babeltrace/callbacks-internal.h>
  25 #include <babeltrace/ctf/events.h>
  26
  27 /*
  28  * struct bt_iter: data structure representing an iterator on a trace
  29  * collection.
  30  */
  31 struct bt_iter {
  32         struct ptr_heap *stream_heap;
  33         struct bt_context *ctx;
  34         struct bt_iter_pos *end_pos;
  35         GArray *callbacks;                              /* Array of struct bt_stream_callbacks */
  36         struct bt_callback_chain main_callbacks;        /* For all events */
  37         /*
  38          * Flag indicating if dependency graph needs to be recalculated.
  39          * Set by bt_iter_add_callback(), and checked (and
  40          * cleared) by upon entry into bt_iter_read_event().
  41          * bt_iter_read_event() is responsible for calling dep
  42          * graph calculation if it sees this flag set.
  43          */
  44         int recalculate_dep_graph;
  45         /*
  46          * Array of pointers to struct bt_dependencies, for garbage
  47          * collection. We're not using a linked list here because each
  48          * struct bt_dependencies can belong to more than one
  49          * bt_iter.
  50          */
  51         GPtrArray *dep_gc;
  52 };
  53
  54 int bt_iter_init(struct bt_iter *iter,
  55                 struct bt_context *ctx,
  56                 struct bt_iter_pos *begin_pos,
  57                 struct bt_iter_pos *end_pos);
  58 void bt_iter_fini(struct bt_iter *iter);
  59
  60 #endif /* _BABELTRACE_ITERATOR_INTERNAL_H */