Commit | Line | Data |
---|---|---|
33b34c43 PP |
1 | #ifndef BABELTRACE_PLUGIN_PLUGIN_H |
2 | #define BABELTRACE_PLUGIN_PLUGIN_H | |
90354d3a JG |
3 | |
4 | /* | |
584e4e78 | 5 | * BabelTrace - Babeltrace Plug-in Interface |
90354d3a | 6 | * |
38b48196 | 7 | * Copyright 2016 Jérémie Galarneau <jeremie.galarneau@efficios.com> |
33b34c43 | 8 | * Copyright 2017 Philippe Proulx <pproulx@efficios.com> |
90354d3a JG |
9 | * |
10 | * Author: Jérémie Galarneau <jeremie.galarneau@efficios.com> | |
11 | * | |
12 | * Permission is hereby granted, free of charge, to any person obtaining a copy | |
13 | * of this software and associated documentation files (the "Software"), to deal | |
14 | * in the Software without restriction, including without limitation the rights | |
15 | * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell | |
16 | * copies of the Software, and to permit persons to whom the Software is | |
17 | * furnished to do so, subject to the following conditions: | |
18 | * | |
19 | * The above copyright notice and this permission notice shall be included in | |
20 | * all copies or substantial portions of the Software. | |
21 | * | |
22 | * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR | |
23 | * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, | |
24 | * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE | |
25 | * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER | |
26 | * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, | |
27 | * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE | |
28 | * SOFTWARE. | |
29 | */ | |
30 | ||
33b34c43 PP |
31 | #include <stddef.h> |
32 | #include <stdbool.h> | |
33 | #include <babeltrace/component/component-class.h> | |
34 | ||
38b48196 JG |
35 | #ifdef __cplusplus |
36 | extern "C" { | |
37 | #endif | |
633edee0 | 38 | |
38b48196 | 39 | struct bt_plugin; |
33b34c43 PP |
40 | struct bt_component_class; |
41 | ||
42 | /** | |
43 | * Status code. Errors are always negative. | |
44 | */ | |
45 | enum bt_plugin_status { | |
46 | /** No error, okay. */ | |
47 | BT_PLUGIN_STATUS_OK = 0, | |
48 | /** General error. */ | |
49 | BT_PLUGIN_STATUS_ERROR = -1, | |
50 | /** Memory allocation failure. */ | |
51 | BT_PLUGIN_STATUS_NOMEM = -4, | |
52 | }; | |
53 | ||
1670bffd PP |
54 | extern struct bt_plugin *bt_plugin_create_from_name(const char *plugin_name); |
55 | ||
6ba0b073 | 56 | extern struct bt_plugin **bt_plugin_create_all_from_file(const char *path); |
33b34c43 PP |
57 | |
58 | extern struct bt_plugin **bt_plugin_create_all_from_dir(const char *path, | |
59 | bool recurse); | |
60 | ||
61 | extern struct bt_plugin **bt_plugin_create_all_from_static(void); | |
73299554 | 62 | |
38b48196 JG |
63 | /** |
64 | * Get the name of a plug-in. | |
65 | * | |
66 | * @param plugin An instance of a plug-in | |
67 | * @returns Plug-in name or NULL on error | |
68 | */ | |
69 | extern const char *bt_plugin_get_name(struct bt_plugin *plugin); | |
633edee0 | 70 | |
38b48196 JG |
71 | /** |
72 | * Get the name of a plug-in's author. | |
73 | * | |
74 | * @param plugin An instance of a plug-in | |
75 | * @returns Plug-in author or NULL on error | |
76 | */ | |
77 | extern const char *bt_plugin_get_author(struct bt_plugin *plugin); | |
633edee0 | 78 | |
38b48196 JG |
79 | /** |
80 | * Get the license of a plug-in. | |
81 | * | |
82 | * @param plugin An instance of a plug-in | |
83 | * @returns Plug-in license or NULL on error | |
84 | */ | |
85 | extern const char *bt_plugin_get_license(struct bt_plugin *plugin); | |
633edee0 | 86 | |
f3bc2010 JG |
87 | /** |
88 | * Get the decription of a plug-in. | |
89 | * | |
90 | * @param plugin An instance of a plug-in | |
91 | * @returns Plug-in description or NULL if none is available | |
92 | */ | |
93 | extern const char *bt_plugin_get_description(struct bt_plugin *plugin); | |
94 | ||
7c7c0433 JG |
95 | /** |
96 | * Get the path of a plug-in. | |
97 | * | |
98 | * @param plugin An instance of a plug-in | |
99 | * @returns Plug-in path or NULL on error | |
100 | */ | |
101 | extern const char *bt_plugin_get_path(struct bt_plugin *plugin); | |
102 | ||
b6de043b PP |
103 | extern enum bt_plugin_status bt_plugin_get_version(struct bt_plugin *plugin, |
104 | unsigned int *major, unsigned int *minor, unsigned int *patch, | |
105 | const char **extra); | |
106 | ||
33b34c43 PP |
107 | extern int bt_plugin_get_component_class_count(struct bt_plugin *plugin); |
108 | ||
109 | extern struct bt_component_class *bt_plugin_get_component_class( | |
110 | struct bt_plugin *plugin, size_t index); | |
111 | ||
112 | extern | |
113 | struct bt_component_class *bt_plugin_get_component_class_by_name_and_type( | |
114 | struct bt_plugin *plugin, const char *name, | |
d3e4dcd8 | 115 | enum bt_component_class_type type); |
33b34c43 | 116 | |
38b48196 JG |
117 | #ifdef __cplusplus |
118 | } | |
119 | #endif | |
90354d3a | 120 | |
33b34c43 | 121 | #endif /* BABELTRACE_PLUGIN_PLUGIN_H */ |