Commit | Line | Data |
---|---|---|
634d474b MD |
1 | #ifndef _BABELTRACE_CTF_CALLBACKS_H |
2 | #define _BABELTRACE_CTF_CALLBACKS_H | |
3 | ||
4 | /* | |
5 | * BabelTrace | |
6 | * | |
7 | * CTF events 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/format.h> | |
27 | ||
6946751f JD |
28 | #ifdef __cplusplus |
29 | extern "C" { | |
30 | #endif | |
31 | ||
634d474b MD |
32 | /* Forward declarations */ |
33 | struct bt_ctf_iter; | |
34 | struct bt_dependencies; | |
35 | ||
36 | enum bt_cb_ret { | |
37 | BT_CB_OK = 0, | |
38 | BT_CB_OK_STOP = 1, | |
39 | BT_CB_ERROR_STOP = 2, | |
40 | BT_CB_ERROR_CONTINUE = 3, | |
41 | }; | |
42 | ||
43 | /* | |
44 | * Receives a variable number of strings as parameter, ended with NULL. | |
45 | */ | |
46 | struct bt_dependencies *babeltrace_dependencies_create(const char *first, ...); | |
47 | ||
48 | /* | |
49 | * struct bt_dependencies must be destroyed explicitly if not passed as | |
0ba1c5f9 | 50 | * parameter to a bt_ctf_iter_add_callback(). |
634d474b MD |
51 | */ |
52 | void babeltrace_dependencies_destroy(struct bt_dependencies *dep); | |
53 | ||
54 | /* | |
0ba1c5f9 | 55 | * bt_ctf_iter_add_callback: Add a callback to iterator. |
634d474b MD |
56 | * |
57 | * @iter: trace collection iterator (input) | |
58 | * @event: event to target. 0 for all events. | |
59 | * @private_data: private data pointer to pass to the callback | |
60 | * @flags: specific flags controlling the behavior of this callback | |
61 | * (or'd). | |
62 | * | |
63 | * @callback: function pointer to call | |
64 | * @depends: struct bt_dependency detailing the required computation results. | |
7f89ddce | 65 | * Ends with 0. NULL is accepted as empty dependency. |
634d474b MD |
66 | * @weak_depends: struct bt_dependency detailing the optional computation |
67 | * results that can be optionally consumed by this | |
7f89ddce | 68 | * callback. NULL is accepted as empty dependency. |
634d474b MD |
69 | * @provides: struct bt_dependency detailing the computation results |
70 | * provided by this callback. | |
7f89ddce | 71 | * Ends with 0. NULL is accepted as empty dependency. |
634d474b MD |
72 | * |
73 | * "depends", "weak_depends" and "provides" memory is handled by the | |
74 | * babeltrace library after this call succeeds or fails. These objects | |
75 | * can still be used by the caller until the babeltrace iterator is | |
76 | * destroyed, but they belong to the babeltrace library. | |
77 | * | |
78 | * (note to implementor: we need to keep a gptrarray of struct | |
0ba1c5f9 | 79 | * bt_dependencies to "garbage collect" in struct bt_ctf_iter, and |
634d474b MD |
80 | * dependencies need to have a refcount to handle the case where they |
81 | * would be passed to more than one iterator. Upon iterator detroy, we | |
82 | * iterate on all the gc ptrarray and decrement the refcounts, freeing | |
83 | * if we reach 0.) | |
84 | * (note to implementor: we calculate the dependency graph when | |
0ba1c5f9 MD |
85 | * bt_ctf_iter_read_event() is executed after a |
86 | * bt_ctf_iter_add_callback(). Beware that it is valid to create/add | |
634d474b MD |
87 | * callbacks/read/add more callbacks/read some more.) |
88 | */ | |
89 | int bt_ctf_iter_add_callback(struct bt_ctf_iter *iter, | |
90 | bt_intern_str event, void *private_data, int flags, | |
c50d2a7a | 91 | enum bt_cb_ret (*callback)(struct bt_ctf_event *ctf_data, |
634d474b MD |
92 | void *caller_data), |
93 | struct bt_dependencies *depends, | |
94 | struct bt_dependencies *weak_depends, | |
95 | struct bt_dependencies *provides); | |
96 | ||
97 | /* | |
98 | * For flags parameter above. | |
99 | */ | |
100 | enum { | |
101 | BT_FLAGS_FREE_PRIVATE_DATA = (1 << 0), | |
102 | }; | |
103 | ||
6946751f JD |
104 | #ifdef __cplusplus |
105 | } | |
106 | #endif | |
107 | ||
634d474b | 108 | #endif /*_BABELTRACE_CTF_CALLBACKS_H */ |