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>
41 #define NATIVE_PLUGIN_SUFFIX ".so"
42 #define NATIVE_PLUGIN_SUFFIX_LEN sizeof(NATIVE_PLUGIN_SUFFIX)
43 #define LIBTOOL_PLUGIN_SUFFIX ".la"
44 #define LIBTOOL_PLUGIN_SUFFIX_LEN sizeof(LIBTOOL_PLUGIN_SUFFIX)
45 #define PLUGIN_SUFFIX_LEN max_t(size_t, sizeof(NATIVE_PLUGIN_SUFFIX), \
46 sizeof(LIBTOOL_PLUGIN_SUFFIX))
48 /* Allocate dirent as recommended by READDIR(3), NOTES on readdir_r */
50 struct dirent
*alloc_dirent(const char *path
)
56 name_max
= pathconf(path
, _PC_NAME_MAX
);
60 len
= offsetof(struct dirent
, d_name
) + name_max
+ 1;
66 enum bt_component_factory_status
67 bt_component_factory_load_file(struct bt_component_factory
*factory
,
70 enum bt_component_factory_status ret
= BT_COMPONENT_FACTORY_STATUS_OK
;
71 enum bt_component_status component_status
;
74 struct bt_plugin
*plugin
;
75 bool is_libtool_wrapper
= false, is_shared_object
= false;
77 if (!factory
|| !path
) {
78 ret
= BT_COMPONENT_FACTORY_STATUS_INVAL
;
82 path_len
= strlen(path
);
83 if (path_len
<= PLUGIN_SUFFIX_LEN
) {
84 ret
= BT_COMPONENT_FACTORY_STATUS_INVAL
;
90 * Check if the file ends with a known plugin file type suffix (i.e. .so
93 is_libtool_wrapper
= !strncmp(LIBTOOL_PLUGIN_SUFFIX
,
94 path
+ path_len
- LIBTOOL_PLUGIN_SUFFIX_LEN
,
95 LIBTOOL_PLUGIN_SUFFIX_LEN
);
96 is_shared_object
= !strncmp(NATIVE_PLUGIN_SUFFIX
,
97 path
+ path_len
- NATIVE_PLUGIN_SUFFIX_LEN
,
98 NATIVE_PLUGIN_SUFFIX_LEN
);
99 if (!is_shared_object
&& !is_libtool_wrapper
) {
100 /* Name indicates that this is not a plugin file. */
101 ret
= BT_COMPONENT_FACTORY_STATUS_INVAL
;
105 module
= g_module_open(path
, 0);
107 printf_error("Module open error: %s", g_module_error());
108 ret
= BT_COMPONENT_FACTORY_STATUS_ERROR
;
112 /* Load plugin and make sure it defines the required entry points */
113 plugin
= bt_plugin_create(module
);
115 ret
= BT_COMPONENT_FACTORY_STATUS_INVAL_PLUGIN
;
116 if (!g_module_close(module
)) {
117 printf_error("Module close error: %s",
123 component_status
= bt_plugin_register_component_classes(plugin
,
125 if (component_status
!= BT_COMPONENT_STATUS_OK
) {
126 switch (component_status
) {
127 case BT_COMPONENT_STATUS_NOMEM
:
128 ret
= BT_COMPONENT_FACTORY_STATUS_NOMEM
;
131 ret
= BT_COMPONENT_FACTORY_STATUS_ERROR
;
138 g_ptr_array_add(factory
->plugins
, plugin
);
144 enum bt_component_factory_status
145 bt_component_factory_load_dir_recursive(struct bt_component_factory
*factory
,
148 DIR *directory
= NULL
;
149 struct dirent
*entry
= NULL
, *result
= NULL
;
150 char *file_path
= NULL
;
151 size_t path_len
= strlen(path
);
152 enum bt_component_factory_status ret
= BT_COMPONENT_FACTORY_STATUS_OK
;
154 if (path_len
>= PATH_MAX
) {
155 ret
= BT_COMPONENT_FACTORY_STATUS_INVAL
;
159 entry
= alloc_dirent(path
);
161 ret
= BT_COMPONENT_FACTORY_STATUS_NOMEM
;
165 file_path
= zmalloc(PATH_MAX
);
167 ret
= BT_COMPONENT_FACTORY_STATUS_NOMEM
;
171 strncpy(file_path
, path
, path_len
);
172 /* Append a trailing '/' to the path */
173 if (file_path
[path_len
- 1] != '/') {
174 file_path
[path_len
++] = '/';
177 directory
= opendir(file_path
);
179 perror("Failed to open plug-in directory");
180 ret
= BT_COMPONENT_FACTORY_STATUS_ERROR
;
184 /* Recursively walk directory */
185 while (!readdir_r(directory
, entry
, &result
) && result
) {
188 size_t file_name_len
;
190 if (result
->d_name
[0] == '.') {
191 /* Skip hidden files, . and .. */
195 file_name_len
= strlen(result
->d_name
);
197 if (path_len
+ file_name_len
>= PATH_MAX
) {
201 strncpy(file_path
+ path_len
, result
->d_name
, file_name_len
);
202 file_path
[path_len
+ file_name_len
] = '\0';
204 stat_ret
= stat(file_path
, &st
);
206 /* Continue to next file / directory. */
207 printf_perror("Failed to stat() plugin file");
211 if (S_ISDIR(st
.st_mode
)) {
212 ret
= bt_component_factory_load_dir_recursive(factory
,
214 if (ret
!= BT_COMPONENT_FACTORY_STATUS_OK
) {
217 } else if (S_ISREG(st
.st_mode
)) {
218 bt_component_factory_load_file(factory
, file_path
);
223 if (closedir(directory
)) {
225 * We don't want to override the error since there is
228 perror("Failed to close plug-in directory");
237 void bt_component_factory_destroy(struct bt_object
*obj
)
239 struct bt_component_factory
*factory
= NULL
;
242 factory
= container_of(obj
, struct bt_component_factory
, base
);
244 if (factory
->plugins
) {
245 g_ptr_array_free(factory
->plugins
, TRUE
);
247 if (factory
->component_classes
) {
248 g_ptr_array_free(factory
->component_classes
, TRUE
);
253 struct bt_component_factory
*bt_component_factory_create(void)
255 struct bt_component_factory
*factory
;
257 factory
= g_new0(struct bt_component_factory
, 1);
262 bt_object_init(factory
, bt_component_factory_destroy
);
263 factory
->plugins
= g_ptr_array_new_with_free_func(
264 (GDestroyNotify
) bt_put
);
265 if (!factory
->plugins
) {
268 factory
->component_classes
= g_ptr_array_new_with_free_func(
269 (GDestroyNotify
) bt_put
);
270 if (!factory
->component_classes
) {
280 struct bt_object
*bt_component_factory_get_components(
281 struct bt_component_factory
*factory
)
287 enum bt_component_factory_status
bt_component_factory_load(
288 struct bt_component_factory
*factory
, const char *path
)
290 enum bt_component_factory_status ret
= BT_COMPONENT_FACTORY_STATUS_OK
;
292 if (!factory
|| !path
) {
293 ret
= BT_COMPONENT_FACTORY_STATUS_INVAL
;
297 if (!g_file_test(path
, G_FILE_TEST_EXISTS
)) {
298 ret
= BT_COMPONENT_FACTORY_STATUS_NOENT
;
302 if (g_file_test(path
, G_FILE_TEST_IS_DIR
)) {
303 ret
= bt_component_factory_load_dir_recursive(factory
, path
);
304 } else if (g_file_test(path
, G_FILE_TEST_IS_REGULAR
) ||
305 g_file_test(path
, G_FILE_TEST_IS_SYMLINK
)) {
306 ret
= bt_component_factory_load_file(factory
, path
);
308 ret
= BT_COMPONENT_FACTORY_STATUS_INVAL
;
315 enum bt_component_factory_status
316 bt_component_factory_register_source_component_class(
317 struct bt_component_factory
*factory
, const char *name
,
318 bt_component_source_init_cb init
)
321 return BT_COMPONENT_FACTORY_STATUS_ERROR
;
324 enum bt_component_factory_status
325 bt_component_factory_register_sink_component_class(
326 struct bt_component_factory
*factory
, const char *name
,
327 bt_component_sink_init_cb init
)
329 struct bt_component_class
*class;
330 enum bt_component_factory_status ret
= BT_COMPONENT_FACTORY_STATUS_OK
;
332 if (!factory
|| !name
|| !init
) {
333 ret
= BT_COMPONENT_FACTORY_STATUS_INVAL
;