1 #ifndef BABELTRACE_PLUGIN_PLUGIN_H
2 #define BABELTRACE_PLUGIN_PLUGIN_H
5 * BabelTrace - Babeltrace Plug-in Interface
7 * Copyright 2016 Jérémie Galarneau <jeremie.galarneau@efficios.com>
8 * Copyright 2017 Philippe Proulx <pproulx@efficios.com>
10 * Author: Jérémie Galarneau <jeremie.galarneau@efficios.com>
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:
19 * The above copyright notice and this permission notice shall be included in
20 * all copies or substantial portions of the Software.
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
33 #include <babeltrace/component/component-class.h>
40 struct bt_component_class
;
43 * Status code. Errors are always negative.
45 enum bt_plugin_status
{
46 /** No error, okay. */
47 BT_PLUGIN_STATUS_OK
= 0,
49 BT_PLUGIN_STATUS_ERROR
= -1,
50 /** Memory allocation failure. */
51 BT_PLUGIN_STATUS_NOMEM
= -4,
54 extern struct bt_plugin
*bt_plugin_create_from_name(const char *plugin_name
);
56 extern struct bt_plugin
**bt_plugin_create_all_from_file(const char *path
);
58 extern struct bt_plugin
**bt_plugin_create_all_from_dir(const char *path
,
61 extern struct bt_plugin
**bt_plugin_create_all_from_static(void);
64 * Get the name of a plug-in.
66 * @param plugin An instance of a plug-in
67 * @returns Plug-in name or NULL on error
69 extern const char *bt_plugin_get_name(struct bt_plugin
*plugin
);
72 * Get the name of a plug-in's author.
74 * @param plugin An instance of a plug-in
75 * @returns Plug-in author or NULL on error
77 extern const char *bt_plugin_get_author(struct bt_plugin
*plugin
);
80 * Get the license of a plug-in.
82 * @param plugin An instance of a plug-in
83 * @returns Plug-in license or NULL on error
85 extern const char *bt_plugin_get_license(struct bt_plugin
*plugin
);
88 * Get the decription of a plug-in.
90 * @param plugin An instance of a plug-in
91 * @returns Plug-in description or NULL if none is available
93 extern const char *bt_plugin_get_description(struct bt_plugin
*plugin
);
96 * Get the path of a plug-in.
98 * @param plugin An instance of a plug-in
99 * @returns Plug-in path or NULL on error
101 extern const char *bt_plugin_get_path(struct bt_plugin
*plugin
);
103 extern enum bt_plugin_status
bt_plugin_get_version(struct bt_plugin
*plugin
,
104 unsigned int *major
, unsigned int *minor
, unsigned int *patch
,
107 extern int bt_plugin_get_component_class_count(struct bt_plugin
*plugin
);
109 extern struct bt_component_class
*bt_plugin_get_component_class(
110 struct bt_plugin
*plugin
, size_t index
);
113 struct bt_component_class
*bt_plugin_get_component_class_by_name_and_type(
114 struct bt_plugin
*plugin
, const char *name
,
115 enum bt_component_class_type type
);
121 #endif /* BABELTRACE_PLUGIN_PLUGIN_H */