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/component-class-internal.h>
32 #include <babeltrace/plugin/source-internal.h>
33 #include <babeltrace/plugin/sink-internal.h>
34 #include <babeltrace/babeltrace-internal.h>
35 #include <babeltrace/compiler.h>
36 #include <babeltrace/ref.h>
44 #define NATIVE_PLUGIN_SUFFIX ".so"
45 #define NATIVE_PLUGIN_SUFFIX_LEN sizeof(NATIVE_PLUGIN_SUFFIX)
46 #define LIBTOOL_PLUGIN_SUFFIX ".la"
47 #define LIBTOOL_PLUGIN_SUFFIX_LEN sizeof(LIBTOOL_PLUGIN_SUFFIX)
48 #define PLUGIN_SUFFIX_LEN max_t(size_t, sizeof(NATIVE_PLUGIN_SUFFIX), \
49 sizeof(LIBTOOL_PLUGIN_SUFFIX))
51 DECLARE_PLUG_IN_SECTIONS
;
53 /* Allocate dirent as recommended by READDIR(3), NOTES on readdir_r */
55 struct dirent
*alloc_dirent(const char *path
)
61 name_max
= pathconf(path
, _PC_NAME_MAX
);
65 len
= offsetof(struct dirent
, d_name
) + name_max
+ 1;
71 enum bt_component_factory_status
init_plugin(
72 struct bt_component_factory
*factory
, struct bt_plugin
*plugin
)
74 enum bt_component_status component_status
;
75 enum bt_component_factory_status ret
= BT_COMPONENT_FACTORY_STATUS_OK
;
77 BT_MOVE(factory
->current_plugin
, plugin
);
78 component_status
= bt_plugin_register_component_classes(
79 factory
->current_plugin
, factory
);
80 BT_PUT(factory
->current_plugin
);
81 if (component_status
!= BT_COMPONENT_STATUS_OK
) {
82 switch (component_status
) {
83 case BT_COMPONENT_STATUS_NOMEM
:
84 ret
= BT_COMPONENT_FACTORY_STATUS_NOMEM
;
87 ret
= BT_COMPONENT_FACTORY_STATUS_ERROR
;
95 enum bt_component_factory_status
96 bt_component_factory_load_file(struct bt_component_factory
*factory
,
99 enum bt_component_factory_status ret
= BT_COMPONENT_FACTORY_STATUS_OK
;
102 struct bt_plugin
*plugin
;
103 bool is_libtool_wrapper
= false, is_shared_object
= false;
105 if (!factory
|| !path
) {
106 ret
= BT_COMPONENT_FACTORY_STATUS_INVAL
;
110 path_len
= strlen(path
);
111 if (path_len
<= PLUGIN_SUFFIX_LEN
) {
112 ret
= BT_COMPONENT_FACTORY_STATUS_INVAL
;
118 * Check if the file ends with a known plugin file type suffix (i.e. .so
121 is_libtool_wrapper
= !strncmp(LIBTOOL_PLUGIN_SUFFIX
,
122 path
+ path_len
- LIBTOOL_PLUGIN_SUFFIX_LEN
,
123 LIBTOOL_PLUGIN_SUFFIX_LEN
);
124 is_shared_object
= !strncmp(NATIVE_PLUGIN_SUFFIX
,
125 path
+ path_len
- NATIVE_PLUGIN_SUFFIX_LEN
,
126 NATIVE_PLUGIN_SUFFIX_LEN
);
127 if (!is_shared_object
&& !is_libtool_wrapper
) {
128 /* Name indicates that this is not a plugin file. */
129 ret
= BT_COMPONENT_FACTORY_STATUS_INVAL
;
133 module
= g_module_open(path
, 0);
135 printf_verbose("Module open error: %s\n", g_module_error());
136 ret
= BT_COMPONENT_FACTORY_STATUS_ERROR
;
140 /* Load plugin and make sure it defines the required entry points. */
141 plugin
= bt_plugin_create_from_module(module
, path
);
143 ret
= BT_COMPONENT_FACTORY_STATUS_INVAL_PLUGIN
;
144 if (!g_module_close(module
)) {
145 printf_error("Module close error: %s\n",
150 ret
= init_plugin(factory
, plugin
);
156 enum bt_component_factory_status
157 bt_component_factory_load_dir(struct bt_component_factory
*factory
,
158 const char *path
, bool recurse
)
160 DIR *directory
= NULL
;
161 struct dirent
*entry
= NULL
, *result
= NULL
;
162 char *file_path
= NULL
;
163 size_t path_len
= strlen(path
);
164 enum bt_component_factory_status ret
= BT_COMPONENT_FACTORY_STATUS_OK
;
166 if (path_len
>= PATH_MAX
) {
167 ret
= BT_COMPONENT_FACTORY_STATUS_INVAL
;
171 entry
= alloc_dirent(path
);
173 ret
= BT_COMPONENT_FACTORY_STATUS_NOMEM
;
177 file_path
= zmalloc(PATH_MAX
);
179 ret
= BT_COMPONENT_FACTORY_STATUS_NOMEM
;
183 strncpy(file_path
, path
, path_len
);
184 /* Append a trailing '/' to the path */
185 if (file_path
[path_len
- 1] != '/') {
186 file_path
[path_len
++] = '/';
189 directory
= opendir(file_path
);
191 perror("Failed to open plug-in directory");
192 ret
= BT_COMPONENT_FACTORY_STATUS_ERROR
;
196 /* Recursively walk directory */
197 while (!readdir_r(directory
, entry
, &result
) && result
) {
200 size_t file_name_len
;
202 if (result
->d_name
[0] == '.') {
203 /* Skip hidden files, . and .. */
207 file_name_len
= strlen(result
->d_name
);
209 if (path_len
+ file_name_len
>= PATH_MAX
) {
213 strncpy(file_path
+ path_len
, result
->d_name
, file_name_len
);
214 file_path
[path_len
+ file_name_len
] = '\0';
216 stat_ret
= stat(file_path
, &st
);
218 /* Continue to next file / directory. */
219 printf_perror("Failed to stat() plugin file\n");
223 if (S_ISDIR(st
.st_mode
) && recurse
) {
224 ret
= bt_component_factory_load_dir(factory
,
226 if (ret
!= BT_COMPONENT_FACTORY_STATUS_OK
) {
229 } else if (S_ISREG(st
.st_mode
)) {
230 bt_component_factory_load_file(factory
, file_path
);
235 if (closedir(directory
)) {
237 * We don't want to override the error since there is
240 perror("Failed to close plug-in directory");
249 void bt_component_factory_destroy(struct bt_object
*obj
)
251 struct bt_component_factory
*factory
= NULL
;
254 factory
= container_of(obj
, struct bt_component_factory
, base
);
256 if (factory
->component_classes
) {
257 g_ptr_array_free(factory
->component_classes
, TRUE
);
262 struct bt_component_factory
*bt_component_factory_create(void)
264 struct bt_component_factory
*factory
;
266 factory
= g_new0(struct bt_component_factory
, 1);
271 bt_object_init(factory
, bt_component_factory_destroy
);
272 factory
->component_classes
= g_ptr_array_new_with_free_func(
273 (GDestroyNotify
) bt_put
);
274 if (!factory
->component_classes
) {
284 int bt_component_factory_get_component_class_count(
285 struct bt_component_factory
*factory
)
287 return factory
? factory
->component_classes
->len
: -1;
290 struct bt_component_class
*bt_component_factory_get_component_class_index(
291 struct bt_component_factory
*factory
, int index
)
293 struct bt_component_class
*component_class
= NULL
;
295 if (!factory
|| index
< 0 || index
>= factory
->component_classes
->len
) {
299 component_class
= bt_get(g_ptr_array_index(
300 factory
->component_classes
, index
));
302 return component_class
;
305 struct bt_component_class
*bt_component_factory_get_component_class(
306 struct bt_component_factory
*factory
,
307 const char *plugin_name
, enum bt_component_type type
,
308 const char *component_name
)
311 struct bt_component_class
*component_class
= NULL
;
313 if (!factory
|| (!plugin_name
&& !component_name
&&
314 type
== BT_COMPONENT_TYPE_UNKNOWN
)) {
315 /* At least one criterion must be provided. */
319 for (i
= 0; i
< factory
->component_classes
->len
; i
++) {
320 struct bt_plugin
*plugin
= NULL
;
322 component_class
= g_ptr_array_index(factory
->component_classes
,
324 plugin
= bt_component_class_get_plugin(component_class
);
327 if (type
!= BT_COMPONENT_TYPE_UNKNOWN
) {
328 if (type
!= bt_component_class_get_type(
336 const char *cur_plugin_name
= bt_plugin_get_name(
339 assert(cur_plugin_name
);
340 if (strcmp(plugin_name
, cur_plugin_name
)) {
346 if (component_name
) {
347 const char *cur_cc_name
= bt_component_class_get_name(
351 if (strcmp(component_name
, cur_cc_name
)) {
358 /* All criteria met. */
365 return bt_get(component_class
);
369 enum bt_component_factory_status
_bt_component_factory_load(
370 struct bt_component_factory
*factory
, const char *path
,
373 enum bt_component_factory_status ret
= BT_COMPONENT_FACTORY_STATUS_OK
;
375 if (!factory
|| !path
) {
376 ret
= BT_COMPONENT_FACTORY_STATUS_INVAL
;
380 if (!g_file_test(path
, G_FILE_TEST_EXISTS
)) {
381 ret
= BT_COMPONENT_FACTORY_STATUS_NOENT
;
385 if (g_file_test(path
, G_FILE_TEST_IS_DIR
)) {
386 ret
= bt_component_factory_load_dir(factory
, path
, recursive
);
387 } else if (g_file_test(path
, G_FILE_TEST_IS_REGULAR
) ||
388 g_file_test(path
, G_FILE_TEST_IS_SYMLINK
)) {
389 ret
= bt_component_factory_load_file(factory
, path
);
391 ret
= BT_COMPONENT_FACTORY_STATUS_INVAL
;
398 enum bt_component_factory_status
bt_component_factory_load_recursive(
399 struct bt_component_factory
*factory
, const char *path
)
401 return _bt_component_factory_load(factory
, path
, true);
404 enum bt_component_factory_status
bt_component_factory_load(
405 struct bt_component_factory
*factory
, const char *path
)
407 return _bt_component_factory_load(factory
, path
, false);
410 enum bt_component_factory_status
bt_component_factory_load_static(
411 struct bt_component_factory
*factory
)
414 enum bt_component_factory_status ret
= BT_COMPONENT_FACTORY_STATUS_OK
;
416 PRINT_PLUG_IN_SECTIONS(printf_verbose
);
418 count
= SECTION_ELEMENT_COUNT(__plugin_register_funcs
);
419 if (SECTION_ELEMENT_COUNT(__plugin_register_funcs
) != count
||
420 SECTION_ELEMENT_COUNT(__plugin_names
) != count
||
421 SECTION_ELEMENT_COUNT(__plugin_authors
) != count
||
422 SECTION_ELEMENT_COUNT(__plugin_licenses
) != count
||
423 SECTION_ELEMENT_COUNT(__plugin_descriptions
) != count
) {
424 printf_error("Some statically-linked plug-ins do not define all mandatory symbols\n");
425 ret
= BT_COMPONENT_FACTORY_STATUS_INVAL_PLUGIN
;
428 printf_verbose("Detected %zu statically-linked plug-ins\n", count
);
430 for (i
= 0; i
< count
; i
++) {
431 struct bt_plugin
*plugin
= bt_plugin_create_from_static(i
);
437 (void) init_plugin(factory
, plugin
);
444 enum bt_component_factory_status
445 add_component_class(struct bt_component_factory
*factory
, const char *name
,
446 const char *description
, bt_component_init_cb init
,
447 enum bt_component_type type
)
449 struct bt_component_class
*component_class
;
450 enum bt_component_factory_status ret
= BT_COMPONENT_FACTORY_STATUS_OK
;
452 if (!factory
|| !name
|| !init
) {
453 ret
= BT_COMPONENT_FACTORY_STATUS_INVAL
;
456 assert(factory
->current_plugin
);
459 * Ensure this component class does not clash with a currently
462 component_class
= bt_component_factory_get_component_class(factory
,
463 bt_plugin_get_name(factory
->current_plugin
), type
, name
);
464 if (component_class
) {
465 struct bt_plugin
*plugin
= bt_component_class_get_plugin(
468 printf_warning("Duplicate component class registration attempted. Component class %s being registered by plugin %s (path: %s) conflicts with one already registered by plugin %s (path: %s)\n",
469 name
, bt_plugin_get_name(factory
->current_plugin
),
470 bt_plugin_get_path(factory
->current_plugin
),
471 bt_plugin_get_name(plugin
),
472 bt_plugin_get_path(plugin
));
473 ret
= BT_COMPONENT_FACTORY_STATUS_DUPLICATE
;
474 BT_PUT(component_class
);
479 component_class
= bt_component_class_create(type
, name
, description
,
480 init
, factory
->current_plugin
);
481 g_ptr_array_add(factory
->component_classes
, component_class
);
486 enum bt_component_factory_status
487 bt_component_factory_register_source_component_class(
488 struct bt_component_factory
*factory
, const char *name
,
489 const char *description
, bt_component_init_cb init
)
491 return add_component_class(factory
, name
, description
, init
,
492 BT_COMPONENT_TYPE_SOURCE
);
495 enum bt_component_factory_status
496 bt_component_factory_register_sink_component_class(
497 struct bt_component_factory
*factory
, const char *name
,
498 const char *description
, bt_component_init_cb init
)
500 return add_component_class(factory
, name
, description
, init
,
501 BT_COMPONENT_TYPE_SINK
);
504 enum bt_component_factory_status
505 bt_component_factory_register_filter_component_class(
506 struct bt_component_factory
*factory
, const char *name
,
507 const char *description
, bt_component_init_cb init
)
509 return add_component_class(factory
, name
, description
, init
,
510 BT_COMPONENT_TYPE_FILTER
);