4 * Babeltrace Plugin (generic)
6 * Copyright 2016 Jérémie Galarneau <jeremie.galarneau@efficios.com>
7 * Copyright 2017 Philippe Proulx <pproulx@efficios.com>
9 * Author: Jérémie Galarneau <jeremie.galarneau@efficios.com>
11 * Permission is hereby granted, free of charge, to any person obtaining a copy
12 * of this software and associated documentation files (the "Software"), to deal
13 * in the Software without restriction, including without limitation the rights
14 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
15 * copies of the Software, and to permit persons to whom the Software is
16 * furnished to do so, subject to the following conditions:
18 * The above copyright notice and this permission notice shall be included in
19 * all copies or substantial portions of the Software.
21 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
22 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
23 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
24 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
25 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
26 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
30 #define BT_LOG_TAG "PLUGIN"
31 #include <babeltrace/lib-logging-internal.h>
33 #include <babeltrace/babeltrace-internal.h>
34 #include <babeltrace/compiler-internal.h>
35 #include <babeltrace/ref.h>
36 #include <babeltrace/common-internal.h>
37 #include <babeltrace/plugin/plugin-internal.h>
38 #include <babeltrace/plugin/plugin-so-internal.h>
39 #include <babeltrace/graph/component-class.h>
40 #include <babeltrace/graph/component-class-internal.h>
41 #include <babeltrace/types.h>
50 #define PYTHON_PLUGIN_PROVIDER_FILENAME "libbabeltrace-python-plugin-provider." G_MODULE_SUFFIX
51 #define PYTHON_PLUGIN_PROVIDER_SYM_NAME bt_plugin_python_create_all_from_file
52 #define PYTHON_PLUGIN_PROVIDER_SYM_NAME_STR TOSTRING(PYTHON_PLUGIN_PROVIDER_SYM_NAME)
54 #ifdef BT_BUILT_IN_PYTHON_PLUGIN_SUPPORT
55 #include <babeltrace/plugin/python-plugin-provider-internal.h>
57 struct bt_plugin_set
*(*bt_plugin_python_create_all_from_file_sym
)(const char *path
) =
58 bt_plugin_python_create_all_from_file
;
59 #else /* BT_BUILT_IN_PYTHON_PLUGIN_SUPPORT */
60 static GModule
*python_plugin_provider_module
;
62 struct bt_plugin_set
*(*bt_plugin_python_create_all_from_file_sym
)(const char *path
);
64 __attribute__((constructor
)) static
65 void init_python_plugin_provider(void) {
66 BT_LOGD_STR("Loading Python plugin provider module.");
67 python_plugin_provider_module
=
68 g_module_open(PYTHON_PLUGIN_PROVIDER_FILENAME
,
70 if (!python_plugin_provider_module
) {
71 BT_LOGI("Cannot find `%s`: continuing without Python plugin support.",
72 PYTHON_PLUGIN_PROVIDER_FILENAME
);
76 if (!g_module_symbol(python_plugin_provider_module
,
77 PYTHON_PLUGIN_PROVIDER_SYM_NAME_STR
,
78 (gpointer
) &bt_plugin_python_create_all_from_file_sym
)) {
79 BT_LOGI("Cannot find the Python plugin provider loading symbol: continuing without Python plugin support: "
80 "file=\"%s\", symbol=\"%s\"",
81 PYTHON_PLUGIN_PROVIDER_FILENAME
,
82 PYTHON_PLUGIN_PROVIDER_SYM_NAME_STR
);
86 BT_LOGI("Loaded Python plugin provider module: addr=%p",
87 python_plugin_provider_module
);
90 __attribute__((destructor
)) static
91 void fini_python_plugin_provider(void) {
92 if (python_plugin_provider_module
) {
93 BT_LOGD("Unloading Python plugin provider module.");
95 if (!g_module_close(python_plugin_provider_module
)) {
96 BT_LOGE("Failed to close the Python plugin provider module: %s.",
100 python_plugin_provider_module
= NULL
;
106 int64_t bt_plugin_set_get_plugin_count(struct bt_plugin_set
*plugin_set
)
111 BT_LOGW_STR("Invalid parameter: plugin set is NULL.");
115 count
= (int64_t) plugin_set
->plugins
->len
;
122 struct bt_plugin
*bt_plugin_set_get_plugin(struct bt_plugin_set
*plugin_set
,
125 struct bt_plugin
*plugin
= NULL
;
128 BT_LOGW_STR("Invalid parameter: plugin set is NULL.");
132 if (index
>= plugin_set
->plugins
->len
) {
133 BT_LOGW("Invalid parameter: index is out of bounds: "
134 "addr=%p, index=%" PRIu64
", count=%u",
135 plugin_set
, index
, plugin_set
->plugins
->len
);
139 plugin
= bt_get(g_ptr_array_index(plugin_set
->plugins
, index
));
145 struct bt_plugin_set
*bt_plugin_create_all_from_static(void)
147 /* bt_plugin_so_create_all_from_static() logs errors */
148 return bt_plugin_so_create_all_from_static();
151 struct bt_plugin_set
*bt_plugin_create_all_from_file(const char *path
)
153 struct bt_plugin_set
*plugin_set
= NULL
;
156 BT_LOGW_STR("Invalid parameter: path is NULL.");
160 BT_LOGD("Creating plugins from file: path=\"%s\"", path
);
162 /* Try shared object plugins */
163 plugin_set
= bt_plugin_so_create_all_from_file(path
);
168 /* Try Python plugins if support is available */
169 if (bt_plugin_python_create_all_from_file_sym
) {
170 plugin_set
= bt_plugin_python_create_all_from_file_sym(path
);
178 BT_LOGD("Created %u plugins from file: "
179 "path=\"%s\", count=%u, plugin-set-addr=%p",
180 plugin_set
->plugins
->len
, path
,
181 plugin_set
->plugins
->len
, plugin_set
);
183 BT_LOGD("Found no plugins in file: path=\"%s\"", path
);
189 static void destroy_gstring(void *data
)
191 g_string_free(data
, TRUE
);
194 struct bt_plugin
*bt_plugin_find(const char *plugin_name
)
196 const char *system_plugin_dir
;
197 char *home_plugin_dir
= NULL
;
199 struct bt_plugin
*plugin
= NULL
;
200 struct bt_plugin_set
*plugin_set
= NULL
;
201 GPtrArray
*dirs
= NULL
;
206 BT_LOGW_STR("Invalid parameter: plugin name is NULL.");
210 BT_LOGD("Finding named plugin in standard directories and built-in plugins: "
211 "name=\"%s\"", plugin_name
);
212 dirs
= g_ptr_array_new_with_free_func((GDestroyNotify
) destroy_gstring
);
214 BT_LOGE_STR("Failed to allocate a GPtrArray.");
221 * 1. BABELTRACE_PLUGIN_PATH environment variable
222 * (colon-separated list of directories)
223 * 2. ~/.local/lib/babeltrace/plugins
224 * 3. Default system directory for Babeltrace plugins, usually
225 * /usr/lib/babeltrace/plugins or
226 * /usr/local/lib/babeltrace/plugins if installed
228 * 4. Built-in plugins (static)
230 * Directories are searched non-recursively.
232 envvar
= getenv("BABELTRACE_PLUGIN_PATH");
234 ret
= bt_common_append_plugin_path_dirs(envvar
, dirs
);
236 BT_LOGE_STR("Failed to append plugin path to array of directories.");
241 home_plugin_dir
= bt_common_get_home_plugin_path();
242 if (home_plugin_dir
) {
243 GString
*home_plugin_dir_str
=
244 g_string_new(home_plugin_dir
);
246 if (!home_plugin_dir_str
) {
247 BT_LOGE_STR("Failed to allocate a GString.");
251 g_ptr_array_add(dirs
, home_plugin_dir_str
);
254 system_plugin_dir
= bt_common_get_system_plugin_path();
255 if (system_plugin_dir
) {
256 GString
*system_plugin_dir_str
=
257 g_string_new(system_plugin_dir
);
259 if (!system_plugin_dir_str
) {
260 BT_LOGE_STR("Failed to allocate a GString.");
264 g_ptr_array_add(dirs
, system_plugin_dir_str
);
267 for (i
= 0; i
< dirs
->len
; i
++) {
268 GString
*dir
= g_ptr_array_index(dirs
, i
);
273 * Skip this if the directory does not exist because
274 * bt_plugin_create_all_from_dir() would log a warning.
276 if (!g_file_test(dir
->str
, G_FILE_TEST_IS_DIR
)) {
277 BT_LOGV("Skipping nonexistent directory path: "
278 "path=\"%s\"", dir
->str
);
282 /* bt_plugin_create_all_from_dir() logs details/errors */
283 plugin_set
= bt_plugin_create_all_from_dir(dir
->str
, BT_FALSE
);
285 BT_LOGD("No plugins found in directory: path=\"%s\"",
290 for (j
= 0; j
< plugin_set
->plugins
->len
; j
++) {
291 struct bt_plugin
*candidate_plugin
=
292 g_ptr_array_index(plugin_set
->plugins
, j
);
294 if (strcmp(bt_plugin_get_name(candidate_plugin
),
296 BT_LOGD("Plugin found in directory: name=\"%s\", path=\"%s\"",
297 plugin_name
, dir
->str
);
298 plugin
= bt_get(candidate_plugin
);
303 BT_LOGD("Plugin not found in directory: name=\"%s\", path=\"%s\"",
304 plugin_name
, dir
->str
);
308 plugin_set
= bt_plugin_create_all_from_static();
310 for (j
= 0; j
< plugin_set
->plugins
->len
; j
++) {
311 struct bt_plugin
*candidate_plugin
=
312 g_ptr_array_index(plugin_set
->plugins
, j
);
314 if (strcmp(bt_plugin_get_name(candidate_plugin
),
316 BT_LOGD("Plugin found in built-in plugins: "
317 "name=\"%s\"", plugin_name
);
318 plugin
= bt_get(candidate_plugin
);
325 free(home_plugin_dir
);
329 g_ptr_array_free(dirs
, TRUE
);
333 BT_LOGD("Found plugin in standard directories and built-in plugins: "
334 "addr=%p, name=\"%s\", path=\"%s\"",
335 plugin
, plugin_name
, bt_plugin_get_path(plugin
));
337 BT_LOGD("No plugin found in standard directories and built-in plugins: "
338 "name=\"%s\"", plugin_name
);
344 struct bt_component_class
*bt_plugin_find_component_class(
345 const char *plugin_name
, const char *comp_cls_name
,
346 enum bt_component_class_type comp_cls_type
)
348 struct bt_plugin
*plugin
= NULL
;
349 struct bt_component_class
*comp_cls
= NULL
;
352 BT_LOGW_STR("Invalid parameter: plugin name is NULL.");
356 if (!comp_cls_name
) {
357 BT_LOGW_STR("Invalid parameter: component class name is NULL.");
361 BT_LOGD("Finding named plugin and component class in standard directories and built-in plugins: "
362 "plugin-name=\"%s\", comp-class-name=\"%s\"",
363 plugin_name
, comp_cls_name
);
364 plugin
= bt_plugin_find(plugin_name
);
366 BT_LOGD_STR("Plugin not found.");
370 comp_cls
= bt_plugin_get_component_class_by_name_and_type(
371 plugin
, comp_cls_name
, comp_cls_type
);
373 BT_LOGD("Component class not found in plugin: "
374 "plugin-addr=%p, plugin-path=\"%s\"",
375 plugin
, bt_plugin_get_path(plugin
));
383 /* Allocate dirent as recommended by READDIR(3), NOTES on readdir_r */
385 struct dirent
*alloc_dirent(const char *path
)
389 struct dirent
*entry
;
391 name_max
= pathconf(path
, _PC_NAME_MAX
);
392 if (name_max
== -1) {
395 len
= offsetof(struct dirent
, d_name
) + name_max
+ 1;
396 entry
= zmalloc(len
);
401 enum bt_plugin_status
bt_plugin_create_append_all_from_dir(
402 struct bt_plugin_set
*plugin_set
, const char *path
,
405 DIR *directory
= NULL
;
406 struct dirent
*entry
= NULL
, *result
= NULL
;
407 char *file_path
= NULL
;
409 enum bt_plugin_status ret
= BT_PLUGIN_STATUS_OK
;
412 BT_LOGW_STR("Invalid parameter: path is NULL.");
413 ret
= BT_PLUGIN_STATUS_ERROR
;
417 path_len
= strlen(path
);
418 if (path_len
>= PATH_MAX
) {
419 BT_LOGW("Invalid parameter: path length is too large: "
420 "path-length=%zu", path_len
);
421 ret
= BT_PLUGIN_STATUS_ERROR
;
425 entry
= alloc_dirent(path
);
427 BT_LOGE_STR("Failed to allocate a directory entry.");
428 ret
= BT_PLUGIN_STATUS_ERROR
;
432 file_path
= zmalloc(PATH_MAX
);
434 BT_LOGE("Failed to allocate %zu bytes.", (size_t) PATH_MAX
);
435 ret
= BT_PLUGIN_STATUS_NOMEM
;
439 strncpy(file_path
, path
, path_len
);
440 /* Append a trailing '/' to the path */
441 if (file_path
[path_len
- 1] != '/') {
442 file_path
[path_len
++] = '/';
445 directory
= opendir(file_path
);
447 if (errno
== EACCES
) {
448 BT_LOGD("Cannot open directory: %s: continuing: "
449 "path=\"%s\", errno=%d",
450 strerror(errno
), file_path
, errno
);
454 BT_LOGW("Cannot open directory: %s: "
455 "path=\"%s\", errno=%d",
456 strerror(errno
), file_path
, errno
);
457 ret
= BT_PLUGIN_STATUS_ERROR
;
461 /* Recursively walk directory */
462 while (!readdir_r(directory
, entry
, &result
) && result
) {
465 size_t file_name_len
;
467 if (strcmp(result
->d_name
, ".") == 0 ||
468 strcmp(result
->d_name
, "..") == 0) {
469 /* Obviously not logging this */
473 if (result
->d_name
[0] == '.') {
474 /* Skip hidden files, . and .. */
475 BT_LOGV("Skipping hidden file: path=\"%s/%s\"",
476 path
, result
->d_name
);
480 file_name_len
= strlen(result
->d_name
);
482 if (path_len
+ file_name_len
>= PATH_MAX
) {
483 BT_LOGD("Skipping file because its path length is too large: continuing: "
484 "path=\"%s/%s\", length=%zu",
485 path
, result
->d_name
,
486 (size_t) (path_len
+ file_name_len
));
490 strncpy(file_path
+ path_len
, result
->d_name
, file_name_len
);
491 file_path
[path_len
+ file_name_len
] = '\0';
492 stat_ret
= stat(file_path
, &st
);
494 /* Continue to next file / directory. */
495 BT_LOGD("Cannot get file information: %s: continuing: "
496 "path=\"%s\", errno=%d",
497 strerror(errno
), file_path
, errno
);
501 if (S_ISDIR(st
.st_mode
) && recurse
) {
502 ret
= bt_plugin_create_append_all_from_dir(plugin_set
,
505 BT_LOGW("Cannot recurse into directory to find plugins: "
506 "path=\"%s\", ret=%d", file_path
, ret
);
509 } else if (S_ISREG(st
.st_mode
)) {
510 struct bt_plugin_set
*plugins_from_file
=
511 bt_plugin_create_all_from_file(file_path
);
513 if (plugins_from_file
) {
516 for (j
= 0; j
< plugins_from_file
->plugins
->len
; j
++) {
517 struct bt_plugin
*plugin
=
518 g_ptr_array_index(plugins_from_file
->plugins
, j
);
520 BT_LOGD("Adding plugin to plugin set: "
521 "plugin-path=\"%s\", plugin-addr=%p, plugin-name=\"%s\"",
523 bt_plugin_get_name(plugin
));
524 bt_plugin_set_add_plugin(plugin_set
,
528 bt_put(plugins_from_file
);
535 if (closedir(directory
)) {
537 * We don't want to override the error since there is
540 BT_LOGE("Cannot close directory entry: %s: "
541 "path=\"%s\", errno=%d",
542 strerror(errno
), path
, errno
);
551 struct bt_plugin_set
*bt_plugin_create_all_from_dir(const char *path
,
554 struct bt_plugin_set
*plugin_set
;
555 enum bt_plugin_status status
;
557 BT_LOGD("Creating all plugins in directory: path=\"%s\", recurse=%d",
559 plugin_set
= bt_plugin_set_create();
561 BT_LOGE_STR("Cannot create empty plugin set.");
565 /* Append found plugins to array */
566 status
= bt_plugin_create_append_all_from_dir(plugin_set
, path
,
569 BT_LOGW("Cannot append plugins found in directory: "
570 "path=\"%s\", status=%s",
571 path
, bt_plugin_status_string(status
));
575 BT_LOGD("Created %u plugins from directory: count=%u, path=\"%s\"",
576 plugin_set
->plugins
->len
, plugin_set
->plugins
->len
, path
);
586 const char *bt_plugin_get_name(struct bt_plugin
*plugin
)
588 const char *val
= NULL
;
591 BT_LOGW_STR("Invalid parameter: plugin is NULL.");
595 if (plugin
->info
.name_set
) {
596 val
= plugin
->info
.name
->str
;
603 const char *bt_plugin_get_author(struct bt_plugin
*plugin
)
605 const char *val
= NULL
;
608 BT_LOGW_STR("Invalid parameter: plugin is NULL.");
612 if (plugin
->info
.author_set
) {
613 val
= plugin
->info
.author
->str
;
620 const char *bt_plugin_get_license(struct bt_plugin
*plugin
)
622 const char *val
= NULL
;
625 BT_LOGW_STR("Invalid parameter: plugin is NULL.");
629 if (plugin
->info
.license_set
) {
630 val
= plugin
->info
.license
->str
;
637 const char *bt_plugin_get_path(struct bt_plugin
*plugin
)
639 const char *val
= NULL
;
642 BT_LOGW_STR("Invalid parameter: plugin is NULL.");
646 if (plugin
->info
.path_set
) {
647 val
= plugin
->info
.path
->str
;
654 const char *bt_plugin_get_description(struct bt_plugin
*plugin
)
656 const char *val
= NULL
;
659 BT_LOGW_STR("Invalid parameter: plugin is NULL.");
663 if (plugin
->info
.description_set
) {
664 val
= plugin
->info
.description
->str
;
671 enum bt_plugin_status
bt_plugin_get_version(struct bt_plugin
*plugin
,
672 unsigned int *major
, unsigned int *minor
, unsigned int *patch
,
675 enum bt_plugin_status status
= BT_PLUGIN_STATUS_OK
;
678 BT_LOGW_STR("Invalid parameter: plugin is NULL.");
679 status
= BT_PLUGIN_STATUS_ERROR
;
683 if (!plugin
->info
.version_set
) {
684 BT_LOGV("Plugin's version is not set: addr=%p", plugin
);
685 status
= BT_PLUGIN_STATUS_ERROR
;
690 *major
= plugin
->info
.version
.major
;
694 *minor
= plugin
->info
.version
.minor
;
698 *patch
= plugin
->info
.version
.patch
;
702 *extra
= plugin
->info
.version
.extra
->str
;
709 int64_t bt_plugin_get_component_class_count(struct bt_plugin
*plugin
)
711 return plugin
? plugin
->comp_classes
->len
: (int64_t) -1;
714 struct bt_component_class
*bt_plugin_get_component_class_by_index(
715 struct bt_plugin
*plugin
, uint64_t index
)
717 struct bt_component_class
*comp_class
= NULL
;
720 BT_LOGW_STR("Invalid parameter: plugin is NULL.");
724 if (index
>= plugin
->comp_classes
->len
) {
725 BT_LOGW("Invalid parameter: index is out of bounds: "
726 "addr=%p, index=%" PRIu64
", count=%u",
727 plugin
, index
, plugin
->comp_classes
->len
);
731 comp_class
= g_ptr_array_index(plugin
->comp_classes
, index
);
742 struct bt_component_class
*bt_plugin_get_component_class_by_name_and_type(
743 struct bt_plugin
*plugin
, const char *name
,
744 enum bt_component_class_type type
)
746 struct bt_component_class
*comp_class
= NULL
;
750 BT_LOGW_STR("Invalid parameter: plugin is NULL.");
755 BT_LOGW_STR("Invalid parameter: name is NULL.");
759 for (i
= 0; i
< plugin
->comp_classes
->len
; i
++) {
760 struct bt_component_class
*comp_class_candidate
=
761 g_ptr_array_index(plugin
->comp_classes
, i
);
762 const char *comp_class_cand_name
=
763 bt_component_class_get_name(comp_class_candidate
);
764 enum bt_component_class_type comp_class_cand_type
=
765 bt_component_class_get_type(comp_class_candidate
);
767 assert(comp_class_cand_name
);
768 assert(comp_class_cand_type
>= 0);
770 if (strcmp(name
, comp_class_cand_name
) == 0 &&
771 comp_class_cand_type
== type
) {
772 comp_class
= bt_get(comp_class_candidate
);
786 enum bt_plugin_status
bt_plugin_add_component_class(
787 struct bt_plugin
*plugin
, struct bt_component_class
*comp_class
)
789 enum bt_plugin_status status
= BT_PLUGIN_STATUS_OK
;
790 struct bt_component_class
*comp_class_dup
= NULL
;
791 int comp_class_index
= -1;
794 BT_LOGW_STR("Invalid parameter: plugin is NULL.");
799 BT_LOGW_STR("Invalid parameter: component class is NULL.");
803 if (plugin
->frozen
) {
804 BT_LOGW("Invalid parameter: plugin is frozen: "
805 "addr=%p, name=\"%s\"", plugin
,
806 bt_plugin_get_name(plugin
));
810 /* Check for duplicate */
811 comp_class_dup
= bt_plugin_get_component_class_by_name_and_type(plugin
,
812 bt_component_class_get_name(comp_class
),
813 bt_component_class_get_type(comp_class
));
814 if (comp_class_dup
) {
815 BT_LOGW("Invalid parameter: a component class with this name and type already exists in the plugin: "
816 "plugin-addr=%p, plugin-name=\"%s\", plugin-path=\"%s\", "
817 "comp-class-name=\"%s\", comp-class-type=%s",
818 plugin
, bt_plugin_get_name(plugin
),
819 bt_plugin_get_path(plugin
),
820 bt_component_class_get_name(comp_class
),
821 bt_component_class_type_string(
822 bt_component_class_get_type(comp_class
)));
826 /* Add new component class */
827 comp_class_index
= plugin
->comp_classes
->len
;
828 g_ptr_array_add(plugin
->comp_classes
, bt_get(comp_class
));
830 /* Special case for a shared object plugin */
831 if (plugin
->type
== BT_PLUGIN_TYPE_SO
) {
832 bt_plugin_so_on_add_component_class(plugin
, comp_class
);
835 BT_LOGD("Added component class to plugin: "
836 "plugin-addr=%p, plugin-name=\"%s\", plugin-path=\"%s\", "
837 "comp-class-addr=%p, comp-class-name=\"%s\", comp-class-type=%s",
838 plugin
, bt_plugin_get_name(plugin
),
839 bt_plugin_get_path(plugin
),
841 bt_component_class_get_name(comp_class
),
842 bt_component_class_type_string(
843 bt_component_class_get_type(comp_class
)));
847 /* Remove entry from plugin's component classes (if added) */
848 if (comp_class_index
>= 0) {
849 g_ptr_array_remove_index(plugin
->comp_classes
,
853 status
= BT_PLUGIN_STATUS_ERROR
;
856 bt_put(comp_class_dup
);