1 #ifndef BABELTRACE_PLUGIN_H
2 #define BABELTRACE_PLUGIN_H
5 * BabelTrace - Babeltrace Plug-in Interface
7 * Copyright 2015 Jérémie Galarneau <jeremie.galarneau@efficios.com>
9 * Author: Jérémie Galarneau <jeremie.galarneau@efficios.com>
11 * Permission is hereby granted, free of charge, to any person obtaining a copy
12 * of this software and associated documentation files (the "Software"), to deal
13 * in the Software without restriction, including without limitation the rights
14 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
15 * copies of the Software, and to permit persons to whom the Software is
16 * furnished to do so, subject to the following conditions:
18 * The above copyright notice and this permission notice shall be included in
19 * all copies or substantial portions of the Software.
21 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
22 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
23 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
24 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
25 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
26 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
40 BT_PLUGIN_TYPE_UNKNOWN
= -1,
42 /* A source plug-in is a notification generator. */
43 BT_PLUGIN_TYPE_SOURCE
= 0,
45 /* A sink plug-in handles incoming notifications. */
46 BT_PLUGIN_TYPE_SINK
= 1,
48 /* A filter plug-in implements both Source and Sink interfaces. */
49 BT_PLUGIN_TYPE_FILTER
= 2,
53 * Status code. Errors are always negative.
55 enum bt_plugin_status
{
56 /* -12 for compatibility with -ENOMEM */
57 BT_PLUGIN_STATUS_NOMEM
= -12,
59 /* -22 for compatibility with -EINVAL */
60 BT_PLUGIN_STATUS_INVAL
= -22,
62 BT_PLUGIN_STATUS_UNSUPPORTED
= -2,
64 BT_PLUGIN_STATUS_ERROR
= -1,
66 BT_PLUGIN_STATUS_OK
= 0,
70 * Get plug-in instance name
72 * @param plugin Plug-in instance of which to get the name
73 * @returns Returns a pointer to the plug-in's name
75 extern const char *bt_plugin_get_name(struct bt_plugin
*plugin
);
78 * Set plug-in instance name
80 * @param plugin Plug-in instance of which to set the name
81 * @param name New plug-in name (will be copied)
82 * @returns One of #bt_plugin_status values
84 extern enum bt_plugin_status
bt_plugin_set_name(
85 struct bt_plugin
*plugin
, const char *name
);
88 * Get plug-in instance type
90 * @param plugin Plug-in instance of which to get the type
91 * @returns One of #bt_plugin_type values
93 extern enum bt_plugin_type
bt_plugin_get_type(struct bt_plugin
*plugin
);
96 * Set a plug-in instance's error stream
98 * @param plugin Plug-in instance
99 * @param error_stream Error stream
100 * @returns One of #bt_plugin_status values
102 extern enum bt_plugin_status
bt_plugin_set_error_stream(
103 struct bt_plugin
*plugin
, FILE *error_stream
);
106 * Increments the reference count of \p plugin.
108 * @param plugin Plug-in of which to increment the reference count
110 * @see bt_plugin_put()
112 extern void bt_plugin_get(struct bt_plugin
*plugin
);
115 * Decrements the reference count of \p plugin, destroying it when this
118 * @param plugin Plug-in of which to decrement the reference count
120 * @see bt_plugin_get()
122 extern void bt_plugin_put(struct bt_plugin
*plugin
);
128 #endif /* BABELTRACE_PLUGIN_H */