1 #ifndef BABELTRACE_PLUGIN_SYSTEM_H
2 #define BABELTRACE_PLUGIN_SYSTEM_H
5 * BabelTrace - Babeltrace Plug-in System Interface
7 * This interface is provided for plug-ins to use the Babeltrace
8 * plug-in system facilities.
10 * Copyright 2015 Jérémie Galarneau <jeremie.galarneau@efficios.com>
12 * Author: Jérémie Galarneau <jeremie.galarneau@efficios.com>
14 * Permission is hereby granted, free of charge, to any person obtaining a copy
15 * of this software and associated documentation files (the "Software"), to deal
16 * in the Software without restriction, including without limitation the rights
17 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
18 * copies of the Software, and to permit persons to whom the Software is
19 * furnished to do so, subject to the following conditions:
21 * The above copyright notice and this permission notice shall be included in
22 * all copies or substantial portions of the Software.
24 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
25 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
26 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
27 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
28 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
29 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
33 #include <babeltrace/plugin/notification/notification.h>
40 struct bt_notification
;
41 struct bt_notification_iterator
;
43 struct bt_component_factory
;
46 typedef enum bt_component_status (*bt_plugin_init_func
)(
47 struct bt_component_factory
*factory
);
48 typedef void (*bt_plugin_exit_func
)(void);
51 * Component private data deallocation function type.
53 * @param component Component instance
55 typedef void (*bt_component_destroy_cb
)(struct bt_component
*component
);
58 * Component initialization function type.
60 * A component's private data and required callbacks must be set by this
63 * @param component Component instance
64 * @param params A dictionary of component parameters
65 * @returns One of #bt_component_status values
67 typedef enum bt_component_status (*bt_component_init_cb
)(
68 struct bt_component
*component
, struct bt_value
*params
);
71 * Get a component's private data.
73 * @param component Component of which to get the private data
74 * @returns Component's private data
76 extern void *bt_component_get_private_data(struct bt_component
*component
);
79 * Set a component's private data.
81 * @param component Component of which to set the private data
82 * @param data Component private data
83 * @returns One of #bt_component_status values
85 extern enum bt_component_status
bt_component_set_private_data(
86 struct bt_component
*component
, void *data
);
89 * Set a component's private data cleanup function.
91 * @param component Component of which to set the private data destruction
93 * @param data Component private data clean-up function
94 * @returns One of #bt_component_status values
96 extern enum bt_component_status
bt_component_set_destroy_cb(
97 struct bt_component
*component
,
98 bt_component_destroy_cb destroy
);
100 /** bt_component_souce */
102 * Iterator initialization function type.
104 * A notification iterator's private data, deinitialization, next, and get
105 * callbacks must be set by this function.
107 * @param source Source component instance
108 * @param iterator Notification iterator instance
110 typedef enum bt_component_status (*bt_component_source_init_iterator_cb
)(
111 struct bt_component
*, struct bt_notification_iterator
*);
114 * Set a source component's iterator initialization function.
116 * @param source Source component instance
117 * @param init_iterator Notification iterator initialization callback
119 extern enum bt_component_status
120 bt_component_source_set_iterator_init_cb(struct bt_component
*source
,
121 bt_component_source_init_iterator_cb init_iterator
);
123 /** bt_component_sink */
125 * Notification consumption function type.
127 * @param sink Sink component instance
128 * @returns One of #bt_component_status values
130 typedef enum bt_component_status (*bt_component_sink_consume_cb
)(
131 struct bt_component
*);
134 * Iterator addition function type.
136 * A sink component may choose to refuse the addition of an iterator
137 * by not returning BT_COMPONENT_STATUS_OK.
139 * @param sink Sink component instance
140 * @returns One of #bt_component_status values
142 typedef enum bt_component_status (*bt_component_sink_add_iterator_cb
)(
143 struct bt_component
*, struct bt_notification_iterator
*);
146 * Set a sink component's consumption callback.
148 * @param sink Sink component instance
149 * @param consume Consumption callback
150 * @returns One of #bt_component_status values
152 extern enum bt_component_status
153 bt_component_sink_set_consume_cb(struct bt_component
*sink
,
154 bt_component_sink_consume_cb consume
);
157 * Set a sink component's iterator addition callback.
159 * @param sink Sink component instance
160 * @param add_iterator Iterator addition callback
161 * @returns One of #bt_component_status values
163 extern enum bt_component_status
164 bt_component_sink_set_add_iterator_cb(struct bt_component
*sink
,
165 bt_component_sink_add_iterator_cb add_iterator
);
168 extern enum bt_component_status
169 bt_component_sink_set_minimum_input_count(struct bt_component
*sink
,
170 unsigned int minimum
);
173 extern enum bt_component_status
174 bt_component_sink_set_maximum_input_count(struct bt_component
*sink
,
175 unsigned int maximum
);
177 extern enum bt_component_status
178 bt_component_sink_get_input_count(struct bt_component
*sink
,
179 unsigned int *count
);
181 /* May return NULL after an interator has reached its end. */
182 extern enum bt_component_status
183 bt_component_sink_get_input_iterator(struct bt_component
*sink
,
184 unsigned int input
, struct bt_notification_iterator
**iterator
);
186 /** bt_component_filter */
188 * Iterator initialization function type.
190 * A notification iterator's private data, deinitialization, next, and get
191 * callbacks must be set by this function.
193 * @param filter Filter component instance
194 * @param iterator Notification iterator instance
196 typedef enum bt_component_status (*bt_component_filter_init_iterator_cb
)(
197 struct bt_component
*, struct bt_notification_iterator
*);
200 * Iterator addition function type.
202 * A filter component may choose to refuse the addition of an iterator
203 * by not returning BT_COMPONENT_STATUS_OK.
205 * @param filter Filter component instance
206 * @returns One of #bt_component_status values
208 typedef enum bt_component_status (*bt_component_filter_add_iterator_cb
)(
209 struct bt_component
*, struct bt_notification_iterator
*);
212 * Set a filter component's iterator initialization function.
214 * @param filter Filter component instance
215 * @param init_iterator Notification iterator initialization callback
217 extern enum bt_component_status
218 bt_component_filter_set_iterator_init_cb(struct bt_component
*filter
,
219 bt_component_filter_init_iterator_cb init_iterator
);
222 * Set a filter component's iterator addition callback.
224 * @param filter Filter component instance
225 * @param add_iterator Iterator addition callback
226 * @returns One of #bt_component_status values
228 extern enum bt_component_status
229 bt_component_filter_set_add_iterator_cb(struct bt_component
*filter
,
230 bt_component_filter_add_iterator_cb add_iterator
);
233 extern enum bt_component_status
234 bt_component_filter_set_minimum_input_count(struct bt_component
*filter
,
235 unsigned int minimum
);
238 extern enum bt_component_status
239 bt_component_filter_set_maximum_input_count(struct bt_component
*filter
,
240 unsigned int maximum
);
242 extern enum bt_component_status
243 bt_component_filter_get_input_count(struct bt_component
*filter
,
244 unsigned int *count
);
246 /* May return NULL after an interator has reached its end. */
247 extern enum bt_component_status
248 bt_component_filter_get_input_iterator(struct bt_component
*filter
,
249 unsigned int input
, struct bt_notification_iterator
**iterator
);
251 /** bt_notification_iterator */
253 * Function returning an iterator's current notification.
255 * @param iterator Notification iterator instance
256 * @returns A notification instance
258 typedef struct bt_notification
*(*bt_notification_iterator_get_cb
)(
259 struct bt_notification_iterator
*iterator
);
262 * Function advancing an iterator's position of one element.
264 * @param iterator Notification iterator instance
265 * @returns One of #bt_notification_iterator_status values
267 typedef enum bt_notification_iterator_status (*bt_notification_iterator_next_cb
)(
268 struct bt_notification_iterator
*iterator
);
271 * Function cleaning-up an iterator's private data on destruction.
273 * @param iterator Notification iterator instance
275 typedef void (*bt_notification_iterator_destroy_cb
)(
276 struct bt_notification_iterator
*iterator
);
279 * Set an iterator's "get" callback which return the current notification.
281 * @param iterator Notification iterator instance
282 * @param get Notification return callback
283 * @returns One of #bt_notification_iterator_status values
285 extern enum bt_notification_iterator_status
286 bt_notification_iterator_set_get_cb(struct bt_notification_iterator
*iterator
,
287 bt_notification_iterator_get_cb get
);
290 * Set an iterator's "next" callback which advances the iterator's position.
292 * @param iterator Notification iterator instance
293 * @param next Iterator "next" callback
294 * @returns One of #bt_notification_iterator_status values
296 extern enum bt_notification_iterator_status
297 bt_notification_iterator_set_next_cb(struct bt_notification_iterator
*iterator
,
298 bt_notification_iterator_next_cb next
);
301 * Set an iterator's "destroy" callback.
303 * @param iterator Notification iterator instance
304 * @param next Iterator destruction callback
305 * @returns One of #bt_notification_iterator_status values
307 extern enum bt_notification_iterator_status
308 bt_notification_iterator_set_destroy_cb(
309 struct bt_notification_iterator
*iterator
,
310 bt_notification_iterator_destroy_cb destroy
);
313 * Set an iterator's private data.
315 * @param iterator Notification iterator instance
316 * @param data Iterator private data
317 * @returns One of #bt_notification_iterator_status values
319 extern enum bt_notification_iterator_status
320 bt_notification_iterator_set_private_data(
321 struct bt_notification_iterator
*iterator
, void *data
);
324 * Get an iterator's private data.
326 * @param iterator Notification iterator instance
327 * @returns Iterator instance private data
329 extern void *bt_notification_iterator_get_private_data(
330 struct bt_notification_iterator
*iterator
);
336 #endif /* BABELTRACE_PLUGIN_SYSTEM_H */