5bf1a151f6a87fa2d3060425f52937dfac18faf9
[babeltrace.git] / src / lib / plugin / plugin.c
1 /*
2 * Copyright 2017-2018 Philippe Proulx <pproulx@efficios.com>
3 * Copyright 2016 Jérémie Galarneau <jeremie.galarneau@efficios.com>
4 *
5 * Author: Jérémie Galarneau <jeremie.galarneau@efficios.com>
6 *
7 * Permission is hereby granted, free of charge, to any person obtaining a copy
8 * of this software and associated documentation files (the "Software"), to deal
9 * in the Software without restriction, including without limitation the rights
10 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
11 * copies of the Software, and to permit persons to whom the Software is
12 * furnished to do so, subject to the following conditions:
13 *
14 * The above copyright notice and this permission notice shall be included in
15 * all copies or substantial portions of the Software.
16 *
17 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
18 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
19 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
20 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
21 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
22 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
23 * SOFTWARE.
24 */
25
26 #define BT_LOG_TAG "PLUGIN"
27 #include "lib/lib-logging.h"
28
29 #include "common/assert.h"
30 #include "lib/assert-pre.h"
31 #include "common/macros.h"
32 #include "compat/compiler.h"
33 #include "common/common.h"
34 #include <babeltrace2/plugin/plugin-const.h>
35 #include <babeltrace2/graph/component-class-const.h>
36 #include "lib/graph/component-class.h"
37 #include <babeltrace2/types.h>
38 #include <glib.h>
39 #include <unistd.h>
40 #include <stdlib.h>
41 #include <stdint.h>
42 #include <inttypes.h>
43 #include <sys/stat.h>
44 #include <ftw.h>
45 #include <pthread.h>
46
47 #include "plugin.h"
48 #include "plugin-so.h"
49
50 #define PYTHON_PLUGIN_PROVIDER_FILENAME "libbabeltrace2-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 G_STRINGIFY(PYTHON_PLUGIN_PROVIDER_SYM_NAME)
53
54 #define APPEND_ALL_FROM_DIR_NFDOPEN_MAX 8
55
56 #ifdef BT_BUILT_IN_PYTHON_PLUGIN_SUPPORT
57 #include <plugin/python-plugin-provider.h>
58
59 static
60 struct bt_plugin_set *(*bt_plugin_python_create_all_from_file_sym)(const char *path) =
61 bt_plugin_python_create_all_from_file;
62
63 static
64 void init_python_plugin_provider(void) {}
65 #else /* BT_BUILT_IN_PYTHON_PLUGIN_SUPPORT */
66 static GModule *python_plugin_provider_module;
67 static
68 struct bt_plugin_set *(*bt_plugin_python_create_all_from_file_sym)(const char *path);
69
70 static
71 void init_python_plugin_provider(void) {
72 if (bt_plugin_python_create_all_from_file_sym != NULL) {
73 return;
74 }
75
76 BT_LOGI_STR("Loading Python plugin provider module.");
77 python_plugin_provider_module =
78 g_module_open(PYTHON_PLUGIN_PROVIDER_FILENAME, 0);
79 if (!python_plugin_provider_module) {
80 BT_LOGI("Cannot open `%s`: %s: continuing without Python plugin support.",
81 PYTHON_PLUGIN_PROVIDER_FILENAME, g_module_error());
82 return;
83 }
84
85 if (!g_module_symbol(python_plugin_provider_module,
86 PYTHON_PLUGIN_PROVIDER_SYM_NAME_STR,
87 (gpointer) &bt_plugin_python_create_all_from_file_sym)) {
88 BT_LOGI("Cannot find the Python plugin provider loading symbol: continuing without Python plugin support: "
89 "file=\"%s\", symbol=\"%s\"",
90 PYTHON_PLUGIN_PROVIDER_FILENAME,
91 PYTHON_PLUGIN_PROVIDER_SYM_NAME_STR);
92 return;
93 }
94
95 BT_LOGI("Loaded Python plugin provider module: addr=%p",
96 python_plugin_provider_module);
97 }
98
99 __attribute__((destructor)) static
100 void fini_python_plugin_provider(void) {
101 if (python_plugin_provider_module) {
102 BT_LOGI("Unloading Python plugin provider module.");
103
104 if (!g_module_close(python_plugin_provider_module)) {
105 BT_LOGE("Failed to close the Python plugin provider module: %s.",
106 g_module_error());
107 }
108
109 python_plugin_provider_module = NULL;
110 }
111 }
112 #endif
113
114 uint64_t bt_plugin_set_get_plugin_count(struct bt_plugin_set *plugin_set)
115 {
116 BT_ASSERT_PRE_NON_NULL(plugin_set, "Plugin set");
117 return (uint64_t) plugin_set->plugins->len;
118 }
119
120 const struct bt_plugin *bt_plugin_set_borrow_plugin_by_index_const(
121 const struct bt_plugin_set *plugin_set, uint64_t index)
122 {
123 BT_ASSERT_PRE_NON_NULL(plugin_set, "Plugin set");
124 BT_ASSERT_PRE_VALID_INDEX(index, plugin_set->plugins->len);
125 return g_ptr_array_index(plugin_set->plugins, index);
126 }
127
128 const struct bt_plugin_set *bt_plugin_find_all_from_static(void)
129 {
130 /* bt_plugin_so_create_all_from_static() logs errors */
131 return bt_plugin_so_create_all_from_static();
132 }
133
134 const struct bt_plugin_set *bt_plugin_find_all_from_file(const char *path)
135 {
136 struct bt_plugin_set *plugin_set = NULL;
137
138 BT_ASSERT_PRE_NON_NULL(path, "Path");
139 BT_LOGI("Creating plugins from file: path=\"%s\"", path);
140
141 /* Try shared object plugins */
142 plugin_set = bt_plugin_so_create_all_from_file(path);
143 if (plugin_set) {
144 goto end;
145 }
146
147 /* Try Python plugins if support is available */
148 init_python_plugin_provider();
149 if (bt_plugin_python_create_all_from_file_sym) {
150 plugin_set = bt_plugin_python_create_all_from_file_sym(path);
151 if (plugin_set) {
152 goto end;
153 }
154 }
155
156 end:
157 if (plugin_set) {
158 BT_LOGI("Created %u plugins from file: "
159 "path=\"%s\", count=%u, plugin-set-addr=%p",
160 plugin_set->plugins->len, path,
161 plugin_set->plugins->len, plugin_set);
162 } else {
163 BT_LOGI("Found no plugins in file: path=\"%s\"", path);
164 }
165
166 return plugin_set;
167 }
168
169 static void destroy_gstring(void *data)
170 {
171 g_string_free(data, TRUE);
172 }
173
174 const struct bt_plugin *bt_plugin_find(const char *plugin_name)
175 {
176 const char *system_plugin_dir;
177 char *home_plugin_dir = NULL;
178 const char *envvar;
179 const struct bt_plugin *plugin = NULL;
180 const struct bt_plugin_set *plugin_set = NULL;
181 GPtrArray *dirs = NULL;
182 int ret;
183 size_t i, j;
184
185 BT_ASSERT_PRE_NON_NULL(plugin_name, "Name");
186 BT_LOGI("Finding named plugin in standard directories and built-in plugins: "
187 "name=\"%s\"", plugin_name);
188 dirs = g_ptr_array_new_with_free_func((GDestroyNotify) destroy_gstring);
189 if (!dirs) {
190 BT_LOGE_STR("Failed to allocate a GPtrArray.");
191 goto end;
192 }
193
194 /*
195 * Search order is:
196 *
197 * 1. BABELTRACE_PLUGIN_PATH environment variable
198 * (colon-separated list of directories)
199 * 2. ~/.local/lib/babeltrace2/plugins
200 * 3. Default system directory for Babeltrace plugins, usually
201 * /usr/lib/babeltrace2/plugins or
202 * /usr/local/lib/babeltrace2/plugins if installed
203 * locally
204 * 4. Built-in plugins (static)
205 *
206 * Directories are searched non-recursively.
207 */
208 envvar = getenv("BABELTRACE_PLUGIN_PATH");
209 if (envvar) {
210 ret = bt_common_append_plugin_path_dirs(envvar, dirs);
211 if (ret) {
212 BT_LOGE_STR("Failed to append plugin path to array of directories.");
213 goto end;
214 }
215 }
216
217 home_plugin_dir = bt_common_get_home_plugin_path();
218 if (home_plugin_dir) {
219 GString *home_plugin_dir_str =
220 g_string_new(home_plugin_dir);
221
222 if (!home_plugin_dir_str) {
223 BT_LOGE_STR("Failed to allocate a GString.");
224 goto end;
225 }
226
227 g_ptr_array_add(dirs, home_plugin_dir_str);
228 }
229
230 system_plugin_dir = bt_common_get_system_plugin_path();
231 if (system_plugin_dir) {
232 GString *system_plugin_dir_str =
233 g_string_new(system_plugin_dir);
234
235 if (!system_plugin_dir_str) {
236 BT_LOGE_STR("Failed to allocate a GString.");
237 goto end;
238 }
239
240 g_ptr_array_add(dirs, system_plugin_dir_str);
241 }
242
243 for (i = 0; i < dirs->len; i++) {
244 GString *dir = g_ptr_array_index(dirs, i);
245
246 BT_OBJECT_PUT_REF_AND_RESET(plugin_set);
247
248 /*
249 * Skip this if the directory does not exist because
250 * bt_plugin_find_all_from_dir() would log a warning.
251 */
252 if (!g_file_test(dir->str, G_FILE_TEST_IS_DIR)) {
253 BT_LOGI("Skipping nonexistent directory path: "
254 "path=\"%s\"", dir->str);
255 continue;
256 }
257
258 /* bt_plugin_find_all_from_dir() logs details/errors */
259 plugin_set = bt_plugin_find_all_from_dir(dir->str, BT_FALSE);
260 if (!plugin_set) {
261 BT_LOGI("No plugins found in directory: path=\"%s\"",
262 dir->str);
263 continue;
264 }
265
266 for (j = 0; j < plugin_set->plugins->len; j++) {
267 const struct bt_plugin *candidate_plugin =
268 g_ptr_array_index(plugin_set->plugins, j);
269
270 if (strcmp(bt_plugin_get_name(candidate_plugin),
271 plugin_name) == 0) {
272 BT_LOGI("Plugin found in directory: name=\"%s\", path=\"%s\"",
273 plugin_name, dir->str);
274 plugin = candidate_plugin;
275 bt_object_get_no_null_check(plugin);
276 goto end;
277 }
278 }
279
280 BT_LOGI("Plugin not found in directory: name=\"%s\", path=\"%s\"",
281 plugin_name, dir->str);
282 }
283
284 bt_object_put_ref(plugin_set);
285 plugin_set = bt_plugin_find_all_from_static();
286 if (plugin_set) {
287 for (j = 0; j < plugin_set->plugins->len; j++) {
288 const struct bt_plugin *candidate_plugin =
289 g_ptr_array_index(plugin_set->plugins, j);
290
291 if (strcmp(bt_plugin_get_name(candidate_plugin),
292 plugin_name) == 0) {
293 BT_LOGI("Plugin found in built-in plugins: "
294 "name=\"%s\"", plugin_name);
295 plugin = candidate_plugin;
296 bt_object_get_no_null_check(plugin);
297 goto end;
298 }
299 }
300 }
301
302 end:
303 free(home_plugin_dir);
304 bt_object_put_ref(plugin_set);
305
306 if (dirs) {
307 g_ptr_array_free(dirs, TRUE);
308 }
309
310 if (plugin) {
311 BT_LIB_LOGI("Found plugin in standard directories and built-in plugins: "
312 "%!+l", plugin);
313 } else {
314 BT_LOGI("No plugin found in standard directories and built-in plugins: "
315 "name=\"%s\"", plugin_name);
316 }
317
318 return plugin;
319 }
320
321 static struct {
322 pthread_mutex_t lock;
323 struct bt_plugin_set *plugin_set;
324 bool recurse;
325 } append_all_from_dir_info = {
326 .lock = PTHREAD_MUTEX_INITIALIZER
327 };
328
329 static
330 int nftw_append_all_from_dir(const char *file, const struct stat *sb, int flag,
331 struct FTW *s)
332 {
333 int ret = 0;
334 const char *name = file + s->base;
335
336 /* Check for recursion */
337 if (!append_all_from_dir_info.recurse && s->level > 1) {
338 goto end;
339 }
340
341 switch (flag) {
342 case FTW_F:
343 {
344 const struct bt_plugin_set *plugins_from_file;
345
346 if (name[0] == '.') {
347 /* Skip hidden files */
348 BT_LOGI("Skipping hidden file: path=\"%s\"", file);
349 goto end;
350 }
351
352 plugins_from_file = bt_plugin_find_all_from_file(file);
353
354 if (plugins_from_file) {
355 size_t j;
356
357 for (j = 0; j < plugins_from_file->plugins->len; j++) {
358 struct bt_plugin *plugin =
359 g_ptr_array_index(plugins_from_file->plugins, j);
360
361 BT_LIB_LOGI("Adding plugin to plugin set: "
362 "plugin-path=\"%s\", %![plugin-]+l",
363 file, plugin);
364 bt_plugin_set_add_plugin(
365 append_all_from_dir_info.plugin_set,
366 plugin);
367 }
368
369 bt_object_put_ref(plugins_from_file);
370 }
371 break;
372 }
373 case FTW_DNR:
374 /* Continue to next file / directory. */
375 BT_LOGW("Cannot enter directory: continuing: path=\"%s\"", file);
376 break;
377 case FTW_NS:
378 /* Continue to next file / directory. */
379 BT_LOGI("Cannot get file information: continuing: path=\"%s\"", file);
380 break;
381 }
382
383 end:
384 return ret;
385 }
386
387 static
388 enum bt_plugin_status bt_plugin_create_append_all_from_dir(
389 struct bt_plugin_set *plugin_set, const char *path,
390 bt_bool recurse)
391 {
392 int nftw_flags = FTW_PHYS;
393 enum bt_plugin_status ret = BT_PLUGIN_STATUS_OK;
394
395 BT_ASSERT(plugin_set);
396 BT_ASSERT(path);
397 BT_ASSERT(strlen(path) < PATH_MAX);
398 pthread_mutex_lock(&append_all_from_dir_info.lock);
399 append_all_from_dir_info.plugin_set = plugin_set;
400 append_all_from_dir_info.recurse = recurse;
401 ret = nftw(path, nftw_append_all_from_dir,
402 APPEND_ALL_FROM_DIR_NFDOPEN_MAX, nftw_flags);
403 pthread_mutex_unlock(&append_all_from_dir_info.lock);
404 if (ret != 0) {
405 BT_LOGW_ERRNO("Cannot open directory", ": path=\"%s\"", path);
406 ret = BT_PLUGIN_STATUS_ERROR;
407 }
408
409 return ret;
410 }
411
412 const struct bt_plugin_set *bt_plugin_find_all_from_dir(const char *path,
413 bt_bool recurse)
414 {
415 struct bt_plugin_set *plugin_set;
416 enum bt_plugin_status status;
417
418 BT_LOGI("Creating all plugins in directory: path=\"%s\", recurse=%d",
419 path, recurse);
420 plugin_set = bt_plugin_set_create();
421 if (!plugin_set) {
422 BT_LOGE_STR("Cannot create empty plugin set.");
423 goto error;
424 }
425
426 /* Append found plugins to array */
427 status = bt_plugin_create_append_all_from_dir(plugin_set, path,
428 recurse);
429 if (status < 0) {
430 BT_LOGW("Cannot append plugins found in directory: "
431 "path=\"%s\", status=%s",
432 path, bt_plugin_status_string(status));
433 goto error;
434 }
435
436 BT_LOGI("Created %u plugins from directory: count=%u, path=\"%s\"",
437 plugin_set->plugins->len, plugin_set->plugins->len, path);
438 goto end;
439
440 error:
441 BT_OBJECT_PUT_REF_AND_RESET(plugin_set);
442
443 end:
444 return plugin_set;
445 }
446
447 const char *bt_plugin_get_name(const struct bt_plugin *plugin)
448 {
449 BT_ASSERT_PRE_NON_NULL(plugin, "Plugin");
450 return plugin->info.name_set ? plugin->info.name->str : NULL;
451 }
452
453 const char *bt_plugin_get_author(const struct bt_plugin *plugin)
454 {
455 BT_ASSERT_PRE_NON_NULL(plugin, "Plugin");
456 return plugin->info.author_set ? plugin->info.author->str : NULL;
457 }
458
459 const char *bt_plugin_get_license(const struct bt_plugin *plugin)
460 {
461 BT_ASSERT_PRE_NON_NULL(plugin, "Plugin");
462 return plugin->info.license_set ? plugin->info.license->str : NULL;
463 }
464
465 const char *bt_plugin_get_path(const struct bt_plugin *plugin)
466 {
467 BT_ASSERT_PRE_NON_NULL(plugin, "Plugin");
468 return plugin->info.path_set ? plugin->info.path->str : NULL;
469 }
470
471 const char *bt_plugin_get_description(const struct bt_plugin *plugin)
472 {
473 BT_ASSERT_PRE_NON_NULL(plugin, "Plugin");
474 return plugin->info.description_set ?
475 plugin->info.description->str : NULL;
476 }
477
478 enum bt_property_availability bt_plugin_get_version(const struct bt_plugin *plugin,
479 unsigned int *major, unsigned int *minor, unsigned int *patch,
480 const char **extra)
481 {
482 enum bt_property_availability avail =
483 BT_PROPERTY_AVAILABILITY_AVAILABLE;
484
485 BT_ASSERT_PRE_NON_NULL(plugin, "Plugin");
486
487 if (!plugin->info.version_set) {
488 BT_LIB_LOGD("Plugin's version is not set: %!+l", plugin);
489 avail = BT_PROPERTY_AVAILABILITY_NOT_AVAILABLE;
490 goto end;
491 }
492
493 if (major) {
494 *major = plugin->info.version.major;
495 }
496
497 if (minor) {
498 *minor = plugin->info.version.minor;
499 }
500
501 if (patch) {
502 *patch = plugin->info.version.patch;
503 }
504
505 if (extra) {
506 *extra = plugin->info.version.extra->str;
507 }
508
509 end:
510 return avail;
511 }
512
513 uint64_t bt_plugin_get_source_component_class_count(const struct bt_plugin *plugin)
514 {
515 BT_ASSERT_PRE_NON_NULL(plugin, "Plugin");
516 return (uint64_t) plugin->src_comp_classes->len;
517 }
518
519 uint64_t bt_plugin_get_filter_component_class_count(const struct bt_plugin *plugin)
520 {
521 BT_ASSERT_PRE_NON_NULL(plugin, "Plugin");
522 return (uint64_t) plugin->flt_comp_classes->len;
523 }
524
525 uint64_t bt_plugin_get_sink_component_class_count(const struct bt_plugin *plugin)
526 {
527 BT_ASSERT_PRE_NON_NULL(plugin, "Plugin");
528 return (uint64_t) plugin->sink_comp_classes->len;
529 }
530
531 static inline
532 struct bt_component_class *borrow_component_class_by_index(
533 const struct bt_plugin *plugin, GPtrArray *comp_classes,
534 uint64_t index)
535 {
536 BT_ASSERT_PRE_NON_NULL(plugin, "Plugin");
537 BT_ASSERT_PRE_VALID_INDEX(index, comp_classes->len);
538 return g_ptr_array_index(comp_classes, index);
539 }
540
541 const struct bt_component_class_source *
542 bt_plugin_borrow_source_component_class_by_index_const(
543 const struct bt_plugin *plugin, uint64_t index)
544 {
545 return (const void *) borrow_component_class_by_index(plugin,
546 plugin->src_comp_classes, index);
547 }
548
549 const struct bt_component_class_filter *
550 bt_plugin_borrow_filter_component_class_by_index_const(
551 const struct bt_plugin *plugin, uint64_t index)
552 {
553 return (const void *) borrow_component_class_by_index(plugin,
554 plugin->flt_comp_classes, index);
555 }
556
557 const struct bt_component_class_sink *
558 bt_plugin_borrow_sink_component_class_by_index_const(
559 const struct bt_plugin *plugin, uint64_t index)
560 {
561 return (const void *) borrow_component_class_by_index(plugin,
562 plugin->sink_comp_classes, index);
563 }
564
565 static inline
566 struct bt_component_class *borrow_component_class_by_name(
567 const struct bt_plugin *plugin, GPtrArray *comp_classes,
568 const char *name)
569 {
570 struct bt_component_class *comp_class = NULL;
571 size_t i;
572
573 BT_ASSERT_PRE_NON_NULL(plugin, "Plugin");
574 BT_ASSERT_PRE_NON_NULL(name, "Name");
575
576 for (i = 0; i < comp_classes->len; i++) {
577 struct bt_component_class *comp_class_candidate =
578 g_ptr_array_index(comp_classes, i);
579 const char *comp_class_cand_name =
580 bt_component_class_get_name(comp_class_candidate);
581
582 BT_ASSERT(comp_class_cand_name);
583
584 if (strcmp(name, comp_class_cand_name) == 0) {
585 comp_class = comp_class_candidate;
586 break;
587 }
588 }
589
590 return comp_class;
591 }
592
593 const struct bt_component_class_source *
594 bt_plugin_borrow_source_component_class_by_name_const(
595 const struct bt_plugin *plugin, const char *name)
596 {
597 return (const void *) borrow_component_class_by_name(plugin,
598 plugin->src_comp_classes, name);
599 }
600
601 const struct bt_component_class_filter *
602 bt_plugin_borrow_filter_component_class_by_name_const(
603 const struct bt_plugin *plugin, const char *name)
604 {
605 return (const void *) borrow_component_class_by_name(plugin,
606 plugin->flt_comp_classes, name);
607 }
608
609 const struct bt_component_class_sink *
610 bt_plugin_borrow_sink_component_class_by_name_const(
611 const struct bt_plugin *plugin, const char *name)
612 {
613 return (const void *) borrow_component_class_by_name(plugin,
614 plugin->sink_comp_classes, name);
615 }
616
617 void bt_plugin_get_ref(const struct bt_plugin *plugin)
618 {
619 bt_object_get_ref(plugin);
620 }
621
622 void bt_plugin_put_ref(const struct bt_plugin *plugin)
623 {
624 bt_object_put_ref(plugin);
625 }
626
627 void bt_plugin_set_get_ref(const struct bt_plugin_set *plugin_set)
628 {
629 bt_object_get_ref(plugin_set);
630 }
631
632 void bt_plugin_set_put_ref(const struct bt_plugin_set *plugin_set)
633 {
634 bt_object_put_ref(plugin_set);
635 }
This page took 0.041079 seconds and 3 git commands to generate.