2395ef8895c17c99533c1497cd94610db7337173
[babeltrace.git] / include / babeltrace / ctf / iterator.h
1 #ifndef _BABELTRACE_CTF_ITERATOR_H
2 #define _BABELTRACE_CTF_ITERATOR_H
3
4 /*
5 * BabelTrace
6 *
7 * CTF iterator API
8 *
9 * Copyright 2011-2012 EfficiOS Inc. and Linux Foundation
10 *
11 * Author: Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
12 * Julien Desfossez <julien.desfossez@efficios.com>
13 *
14 * Permission is hereby granted, free of charge, to any person obtaining
15 * a copy of this software and associated documentation files (the
16 * "Software"), to deal in the Software without restriction, including
17 * without limitation the rights to use, copy, modify, merge, publish,
18 * distribute, sublicense, and/or sell copies of the Software, and to
19 * permit persons to whom the Software is furnished to do so, subject to
20 * the following conditions:
21 *
22 * The above copyright notice and this permission notice shall be
23 * included in all copies or substantial portions of the Software.
24 */
25
26 #include <babeltrace/iterator.h>
27
28 #ifdef __cplusplus
29 extern "C" {
30 #endif
31
32 struct bt_ctf_iter;
33 struct bt_ctf_event;
34
35 /*
36 * bt_ctf_iter_create - Allocate a CTF trace collection iterator.
37 *
38 * begin_pos and end_pos are optional parameters to specify the position
39 * at which the trace collection should be seeked upon iterator
40 * creation, and the position at which iteration will start returning
41 * "EOF".
42 *
43 * By default, if begin_pos is NULL, a BT_SEEK_CUR is performed at
44 * creation. By default, if end_pos is NULL, a BT_SEEK_END (end of
45 * trace) is the EOF criterion.
46 *
47 * Return a pointer to the newly allocated iterator.
48 *
49 * Only one iterator can be created against a context. If more than one
50 * iterator is being created for the same context, the second creation
51 * will return NULL. The previous iterator must be destroyed before
52 * creation of the new iterator for this function to succeed.
53 */
54 struct bt_ctf_iter *bt_ctf_iter_create(struct bt_context *ctx,
55 const struct bt_iter_pos *begin_pos,
56 const struct bt_iter_pos *end_pos);
57
58 /*
59 * bt_ctf_get_iter - get iterator from ctf iterator.
60 */
61 struct bt_iter *bt_ctf_get_iter(struct bt_ctf_iter *iter);
62
63 /*
64 * bt_ctf_iter_destroy - Free a CTF trace collection iterator.
65 */
66 void bt_ctf_iter_destroy(struct bt_ctf_iter *iter);
67
68 /*
69 * bt_ctf_iter_read_event: Read the iterator's current event data.
70 *
71 * @iter: trace collection iterator (input). Should NOT be NULL.
72 *
73 * Return current event on success, NULL on end of trace.
74 */
75 struct bt_ctf_event *bt_ctf_iter_read_event(struct bt_ctf_iter *iter);
76
77 /*
78 * bt_ctf_iter_read_event_flags: Read the iterator's current event data.
79 *
80 * @iter: trace collection iterator (input). Should NOT be NULL.
81 * @flags: pointer passed by the user, in which the trace reader populates
82 * flags on special condition (BT_ITER_FLAG_*).
83 *
84 * Return current event on success, NULL on end of trace.
85 */
86 struct bt_ctf_event *bt_ctf_iter_read_event_flags(struct bt_ctf_iter *iter,
87 int *flags);
88
89 /*
90 * bt_ctf_get_lost_events_count: returns the number of events discarded
91 * immediately prior to the last event read
92 *
93 * @iter: trace collection iterator (input). Should NOT be NULL.
94 *
95 * Return the number of lost events or -1ULL on error.
96 */
97 uint64_t bt_ctf_get_lost_events_count(struct bt_ctf_iter *iter);
98
99 #ifdef __cplusplus
100 }
101 #endif
102
103 #endif /* _BABELTRACE_CTF_ITERATOR_H */
This page took 0.043855 seconds and 3 git commands to generate.