6 * Copyright 2016 Jérémie Galarneau <jeremie.galarneau@efficios.com>
8 * Author: Jérémie Galarneau <jeremie.galarneau@efficios.com>
10 * Permission is hereby granted, free of charge, to any person obtaining a copy
11 * of this software and associated documentation files (the "Software"), to deal
12 * in the Software without restriction, including without limitation the rights
13 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
14 * copies of the Software, and to permit persons to whom the Software is
15 * furnished to do so, subject to the following conditions:
17 * The above copyright notice and this permission notice shall be included in
18 * all copies or substantial portions of the Software.
20 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
21 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
22 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
23 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
24 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
25 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
29 #include <babeltrace/compiler.h>
30 #include <babeltrace/ref.h>
31 #include <babeltrace/plugin/plugin-internal.h>
32 #include <babeltrace/plugin/component-factory-internal.h>
35 #define PLUGIN_SYMBOL_NAME "__bt_plugin_name"
36 #define PLUGIN_SYMBOL_AUTHOR "__bt_plugin_author"
37 #define PLUGIN_SYMBOL_LICENSE "__bt_plugin_license"
38 #define PLUGIN_SYMBOL_REGISTER "__bt_plugin_register"
39 #define PLUGIN_SYMBOL_DESCRIPTION "__bt_plugin_description"
41 DECLARE_PLUG_IN_SECTIONS
;
44 void bt_plugin_destroy(struct bt_object
*obj
)
46 struct bt_plugin
*plugin
;
49 plugin
= container_of(obj
, struct bt_plugin
, base
);
52 if (!g_module_close(plugin
->module
)) {
53 printf_error("Module close error: %s\n",
59 g_string_free(plugin
->path
, TRUE
);
65 struct bt_plugin
*bt_plugin_create_from_module(GModule
*module
,
68 struct bt_plugin
*plugin
= NULL
;
69 gpointer symbol
= NULL
;
71 if (!module
|| !path
) {
75 plugin
= g_new0(struct bt_plugin
, 1);
80 bt_object_init(plugin
, bt_plugin_destroy
);
81 plugin
->path
= g_string_new(path
);
86 if (!g_module_symbol(module
, PLUGIN_SYMBOL_NAME
,
87 (gpointer
*) &plugin
->name
)) {
88 printf_verbose("Unable to resolve plugin symbol %s from %s\n",
89 PLUGIN_SYMBOL_NAME
, g_module_name(module
));
93 if (!g_module_symbol(module
, PLUGIN_SYMBOL_LICENSE
,
94 (gpointer
*) &plugin
->license
)) {
95 printf_verbose("Unable to resolve plugin symbol %s from %s\n",
96 PLUGIN_SYMBOL_LICENSE
, g_module_name(module
));
99 if (!g_module_symbol(module
, PLUGIN_SYMBOL_AUTHOR
,
100 (gpointer
*) &plugin
->author
)) {
101 printf_verbose("Unable to resolve plugin symbol %s from %s\n",
102 PLUGIN_SYMBOL_AUTHOR
, g_module_name(module
));
105 if (!g_module_symbol(module
, PLUGIN_SYMBOL_DESCRIPTION
,
106 (gpointer
*) &plugin
->description
)) {
107 printf_verbose("Unable to resolve plugin symbol %s from %s\n",
108 PLUGIN_SYMBOL_DESCRIPTION
,
109 g_module_name(module
));
112 if (!g_module_symbol(module
, PLUGIN_SYMBOL_REGISTER
, &symbol
)) {
113 printf_verbose("Unable to resolve plugin symbol %s from %s\n",
114 PLUGIN_SYMBOL_REGISTER
, g_module_name(module
));
117 plugin
->_register
= *((bt_plugin_register_func
*) symbol
);
118 if (!plugin
->_register
) {
119 printf_verbose("NULL %s symbol target\n",
120 PLUGIN_SYMBOL_REGISTER
);
132 struct bt_plugin
*bt_plugin_create_from_static(size_t i
)
134 struct bt_plugin
*plugin
= NULL
;
136 plugin
= g_new0(struct bt_plugin
, 1);
141 bt_object_init(plugin
, bt_plugin_destroy
);
142 plugin
->_register
= (SECTION_BEGIN(__plugin_register_funcs
))[i
];
143 if (!plugin
->_register
) {
146 plugin
->name
= (SECTION_BEGIN(__plugin_names
))[i
];
147 plugin
->author
= (SECTION_BEGIN(__plugin_authors
))[i
];
148 plugin
->license
= (SECTION_BEGIN(__plugin_licenses
))[i
];
149 plugin
->description
= (SECTION_BEGIN(__plugin_descriptions
))[i
];
157 enum bt_component_status
bt_plugin_register_component_classes(
158 struct bt_plugin
*plugin
, struct bt_component_factory
*factory
)
160 assert(plugin
&& factory
);
161 return plugin
->_register(factory
);
164 const char *bt_plugin_get_name(struct bt_plugin
*plugin
)
166 return plugin
? plugin
->name
: NULL
;
169 const char *bt_plugin_get_author(struct bt_plugin
*plugin
)
171 return plugin
? plugin
->author
: NULL
;
174 const char *bt_plugin_get_license(struct bt_plugin
*plugin
)
176 return plugin
? plugin
->license
: NULL
;
179 const char *bt_plugin_get_path(struct bt_plugin
*plugin
)
181 return (plugin
&& plugin
->path
) ? plugin
->path
->str
: NULL
;
184 const char *bt_plugin_get_description(struct bt_plugin
*plugin
)
186 return plugin
? plugin
->description
: NULL
;