4 * Babeltrace Plugin Component Factory
6 * Copyright 2015 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/plugin/component-factory.h>
30 #include <babeltrace/plugin/component-factory-internal.h>
31 #include <babeltrace/plugin/source-internal.h>
32 #include <babeltrace/plugin/sink-internal.h>
33 #include <babeltrace/babeltrace-internal.h>
34 #include <babeltrace/compiler.h>
35 #include <babeltrace/ref.h>
42 #define NATIVE_PLUGIN_SUFFIX ".so"
43 #define NATIVE_PLUGIN_SUFFIX_LEN sizeof(NATIVE_PLUGIN_SUFFIX)
44 #define LIBTOOL_PLUGIN_SUFFIX ".la"
45 #define LIBTOOL_PLUGIN_SUFFIX_LEN sizeof(LIBTOOL_PLUGIN_SUFFIX)
46 #define PLUGIN_SUFFIX_LEN max_t(size_t, sizeof(NATIVE_PLUGIN_SUFFIX), \
47 sizeof(LIBTOOL_PLUGIN_SUFFIX))
49 /* Allocate dirent as recommended by READDIR(3), NOTES on readdir_r */
51 struct dirent
*alloc_dirent(const char *path
)
57 name_max
= pathconf(path
, _PC_NAME_MAX
);
61 len
= offsetof(struct dirent
, d_name
) + name_max
+ 1;
67 enum bt_component_factory_status
68 bt_component_factory_load_file(struct bt_component_factory
*factory
,
71 enum bt_component_factory_status ret
= BT_COMPONENT_FACTORY_STATUS_OK
;
72 enum bt_component_status component_status
;
75 struct bt_plugin
*plugin
;
76 bool is_libtool_wrapper
= false, is_shared_object
= false;
78 if (!factory
|| !path
) {
79 ret
= BT_COMPONENT_FACTORY_STATUS_INVAL
;
83 path_len
= strlen(path
);
84 if (path_len
<= PLUGIN_SUFFIX_LEN
) {
85 ret
= BT_COMPONENT_FACTORY_STATUS_INVAL
;
91 * Check if the file ends with a known plugin file type suffix (i.e. .so
94 is_libtool_wrapper
= !strncmp(LIBTOOL_PLUGIN_SUFFIX
,
95 path
+ path_len
- LIBTOOL_PLUGIN_SUFFIX_LEN
,
96 LIBTOOL_PLUGIN_SUFFIX_LEN
);
97 is_shared_object
= !strncmp(NATIVE_PLUGIN_SUFFIX
,
98 path
+ path_len
- NATIVE_PLUGIN_SUFFIX_LEN
,
99 NATIVE_PLUGIN_SUFFIX_LEN
);
100 if (!is_shared_object
&& !is_libtool_wrapper
) {
101 /* Name indicates that this is not a plugin file. */
102 ret
= BT_COMPONENT_FACTORY_STATUS_INVAL
;
106 module
= g_module_open(path
, 0);
108 printf_error("Module open error: %s", g_module_error());
109 ret
= BT_COMPONENT_FACTORY_STATUS_ERROR
;
113 /* Load plugin and make sure it defines the required entry points */
114 plugin
= bt_plugin_create(module
);
116 ret
= BT_COMPONENT_FACTORY_STATUS_INVAL_PLUGIN
;
117 if (!g_module_close(module
)) {
118 printf_error("Module close error: %s",
124 component_status
= bt_plugin_register_component_classes(plugin
,
126 if (component_status
!= BT_COMPONENT_STATUS_OK
) {
127 switch (component_status
) {
128 case BT_COMPONENT_STATUS_NOMEM
:
129 ret
= BT_COMPONENT_FACTORY_STATUS_NOMEM
;
132 ret
= BT_COMPONENT_FACTORY_STATUS_ERROR
;
139 g_ptr_array_add(factory
->plugins
, plugin
);
145 enum bt_component_factory_status
146 bt_component_factory_load_dir_recursive(struct bt_component_factory
*factory
,
149 DIR *directory
= NULL
;
150 struct dirent
*entry
= NULL
, *result
= NULL
;
151 char *file_path
= NULL
;
152 size_t path_len
= strlen(path
);
153 enum bt_component_factory_status ret
= BT_COMPONENT_FACTORY_STATUS_OK
;
155 if (path_len
>= PATH_MAX
) {
156 ret
= BT_COMPONENT_FACTORY_STATUS_INVAL
;
160 entry
= alloc_dirent(path
);
162 ret
= BT_COMPONENT_FACTORY_STATUS_NOMEM
;
166 file_path
= zmalloc(PATH_MAX
);
168 ret
= BT_COMPONENT_FACTORY_STATUS_NOMEM
;
172 strncpy(file_path
, path
, path_len
);
173 /* Append a trailing '/' to the path */
174 if (file_path
[path_len
- 1] != '/') {
175 file_path
[path_len
++] = '/';
178 directory
= opendir(file_path
);
180 perror("Failed to open plug-in directory");
181 ret
= BT_COMPONENT_FACTORY_STATUS_ERROR
;
185 /* Recursively walk directory */
186 while (!readdir_r(directory
, entry
, &result
) && result
) {
189 size_t file_name_len
;
191 if (result
->d_name
[0] == '.') {
192 /* Skip hidden files, . and .. */
196 file_name_len
= strlen(result
->d_name
);
198 if (path_len
+ file_name_len
>= PATH_MAX
) {
202 strncpy(file_path
+ path_len
, result
->d_name
, file_name_len
);
203 file_path
[path_len
+ file_name_len
] = '\0';
205 stat_ret
= stat(file_path
, &st
);
207 /* Continue to next file / directory. */
208 printf_perror("Failed to stat() plugin file");
212 if (S_ISDIR(st
.st_mode
)) {
213 ret
= bt_component_factory_load_dir_recursive(factory
,
215 if (ret
!= BT_COMPONENT_FACTORY_STATUS_OK
) {
218 } else if (S_ISREG(st
.st_mode
)) {
219 bt_component_factory_load_file(factory
, file_path
);
224 if (closedir(directory
)) {
226 * We don't want to override the error since there is
229 perror("Failed to close plug-in directory");
238 void bt_component_factory_destroy(struct bt_object
*obj
)
240 struct bt_component_factory
*factory
= NULL
;
243 factory
= container_of(obj
, struct bt_component_factory
, base
);
245 if (factory
->plugins
) {
246 g_ptr_array_free(factory
->plugins
, TRUE
);
248 if (factory
->component_classes
) {
249 g_ptr_array_free(factory
->component_classes
, TRUE
);
254 struct bt_component_factory
*bt_component_factory_create(void)
256 struct bt_component_factory
*factory
;
258 factory
= g_new0(struct bt_component_factory
, 1);
263 bt_object_init(factory
, bt_component_factory_destroy
);
264 factory
->plugins
= g_ptr_array_new_with_free_func(
265 (GDestroyNotify
) bt_put
);
266 if (!factory
->plugins
) {
269 factory
->component_classes
= g_ptr_array_new_with_free_func(
270 (GDestroyNotify
) bt_put
);
271 if (!factory
->component_classes
) {
281 struct bt_value
*bt_component_factory_get_components(
282 struct bt_component_factory
*factory
)
288 enum bt_component_factory_status
bt_component_factory_load(
289 struct bt_component_factory
*factory
, const char *path
)
291 enum bt_component_factory_status ret
= BT_COMPONENT_FACTORY_STATUS_OK
;
293 if (!factory
|| !path
) {
294 ret
= BT_COMPONENT_FACTORY_STATUS_INVAL
;
298 if (!g_file_test(path
, G_FILE_TEST_EXISTS
)) {
299 ret
= BT_COMPONENT_FACTORY_STATUS_NOENT
;
303 if (g_file_test(path
, G_FILE_TEST_IS_DIR
)) {
304 ret
= bt_component_factory_load_dir_recursive(factory
, path
);
305 } else if (g_file_test(path
, G_FILE_TEST_IS_REGULAR
) ||
306 g_file_test(path
, G_FILE_TEST_IS_SYMLINK
)) {
307 ret
= bt_component_factory_load_file(factory
, path
);
309 ret
= BT_COMPONENT_FACTORY_STATUS_INVAL
;
316 enum bt_component_factory_status
317 bt_component_factory_register_source_component_class(
318 struct bt_component_factory
*factory
, const char *name
,
319 bt_component_source_init_cb init
)
322 return BT_COMPONENT_FACTORY_STATUS_ERROR
;
325 enum bt_component_factory_status
326 bt_component_factory_register_sink_component_class(
327 struct bt_component_factory
*factory
, const char *name
,
328 bt_component_sink_init_cb init
)
330 struct bt_component_class
*class;
331 enum bt_component_factory_status ret
= BT_COMPONENT_FACTORY_STATUS_OK
;
333 if (!factory
|| !name
|| !init
) {
334 ret
= BT_COMPONENT_FACTORY_STATUS_INVAL
;