Add bt_version_get_*() functions to dynamically get the lib's version
[babeltrace.git] / lib / plugin / plugin.c
index ce3a866f18935d0e4f803980a06dbdc249adf020..83f628cd8ef79fe387360ba3e55b9fcc1c95c515 100644 (file)
  * SOFTWARE.
  */
 
+#include <babeltrace/babeltrace-internal.h>
 #include <babeltrace/compiler.h>
 #include <babeltrace/ref.h>
+#include <babeltrace/common-internal.h>
 #include <babeltrace/plugin/plugin-internal.h>
 #include <babeltrace/plugin/plugin-so-internal.h>
 #include <glib.h>
 #include <sys/stat.h>
 #include <dirent.h>
 
-#ifdef WITH_PYTHON_PLUGINS
-# include <babeltrace/plugin/plugin-python-enabled-internal.h>
-#else
-# include <babeltrace/plugin/plugin-python-disabled-internal.h>
-#endif
+#define PYTHON_PLUGIN_PROVIDER_FILENAME        "libbabeltrace-python-plugin-provider." G_MODULE_SUFFIX
+#define PYTHON_PLUGIN_PROVIDER_SYM_NAME        bt_plugin_python_create_all_from_file
+#define PYTHON_PLUGIN_PROVIDER_SYM_NAME_STR    TOSTRING(PYTHON_PLUGIN_PROVIDER_SYM_NAME)
 
+#ifdef BT_BUILT_IN_PYTHON_PLUGIN_SUPPORT
+#include <babeltrace/plugin/python-plugin-provider-internal.h>
 static
-void bt_plugin_destroy(struct bt_object *obj)
-{
-       struct bt_plugin *plugin;
-
-       assert(obj);
-       plugin = container_of(obj, struct bt_plugin, base);
+struct bt_plugin **(*bt_plugin_python_create_all_from_file_sym)(const char *path) =
+       bt_plugin_python_create_all_from_file;
+#else /* BT_BUILT_IN_PYTHON_PLUGIN_SUPPORT */
+static GModule *python_plugin_provider_module;
+static
+struct bt_plugin **(*bt_plugin_python_create_all_from_file_sym)(const char *path);
 
-       if (plugin->type == BT_PLUGIN_TYPE_SO) {
-               bt_plugin_so_destroy_spec_data(plugin);
-       } else if (plugin->type == BT_PLUGIN_TYPE_PYTHON) {
-               bt_plugin_python_destroy_spec_data(plugin);
-       } else {
-               assert(false);
+__attribute__((constructor)) static
+void init_python_plugin_provider(void) {
+       python_plugin_provider_module =
+               g_module_open(PYTHON_PLUGIN_PROVIDER_FILENAME,
+                       G_MODULE_BIND_LOCAL);
+       if (!python_plugin_provider_module) {
+               printf_warning("Cannot find `%s`: Python plugin support is disabled\n",
+                       PYTHON_PLUGIN_PROVIDER_FILENAME);
+               return;
        }
 
-       if (plugin->comp_classes) {
-               g_ptr_array_free(plugin->comp_classes, TRUE);
+       if (!g_module_symbol(python_plugin_provider_module,
+                       PYTHON_PLUGIN_PROVIDER_SYM_NAME_STR,
+                       (gpointer) &bt_plugin_python_create_all_from_file_sym)) {
+               printf_warning("Cannot find the Python plugin provider loading symbole: Python plugin support is disabled\n");
        }
+}
 
-       if (plugin->info.name) {
-               g_string_free(plugin->info.name, TRUE);
+__attribute__((destructor)) static
+void fini_python_plugin_provider(void) {
+       if (python_plugin_provider_module) {
+               (void) g_module_close(python_plugin_provider_module);
+               python_plugin_provider_module = NULL;
        }
+}
+#endif
 
-       if (plugin->info.path) {
-               g_string_free(plugin->info.path, TRUE);
-       }
+struct bt_plugin **bt_plugin_create_all_from_static(void)
+{
+       return bt_plugin_so_create_all_from_static();
+}
 
-       if (plugin->info.description) {
-               g_string_free(plugin->info.description, TRUE);
-       }
+struct bt_plugin **bt_plugin_create_all_from_file(const char *path)
+{
+       struct bt_plugin **plugins = NULL;
 
-       if (plugin->info.author) {
-               g_string_free(plugin->info.author, TRUE);
+       if (!path) {
+               goto end;
        }
 
-       if (plugin->info.license) {
-               g_string_free(plugin->info.license, TRUE);
+       printf_verbose("Trying to load plugins from `%s`\n", path);
+
+       /* Try shared object plugins */
+       plugins = bt_plugin_so_create_all_from_file(path);
+       if (plugins) {
+               goto end;
        }
 
-       if (plugin->info.version.extra) {
-               g_string_free(plugin->info.version.extra, TRUE);
+       /* Try Python plugins if support is available */
+       if (bt_plugin_python_create_all_from_file_sym) {
+               plugins = bt_plugin_python_create_all_from_file_sym(path);
+               if (plugins) {
+                       goto end;
+               }
        }
 
-       g_free(plugin);
+end:
+       return plugins;
 }
 
-BT_HIDDEN
-struct bt_plugin *bt_plugin_create_empty(enum bt_plugin_type type)
+static void destroy_gstring(void *data)
 {
-       struct bt_plugin *plugin = NULL;
+       g_string_free(data, TRUE);
+}
 
-       plugin = g_new0(struct bt_plugin, 1);
-       if (!plugin) {
-               goto error;
-       }
+void free_plugins(struct bt_plugin **plugins) {
+       if (plugins) {
+               struct bt_plugin **cur_plugin = plugins;
 
-       bt_object_init(plugin, bt_plugin_destroy);
-       plugin->type = type;
+               while (*cur_plugin) {
+                       bt_put(*cur_plugin);
+                       cur_plugin++;
+               }
 
-       /* Create empty array of component classes */
-       plugin->comp_classes =
-               g_ptr_array_new_with_free_func((GDestroyNotify) bt_put);
-       if (!plugin->comp_classes) {
-               goto error;
+               free(plugins);
        }
+}
 
-       /* Create empty info */
-       plugin->info.name = g_string_new(NULL);
-       if (!plugin->info.name) {
-               goto error;
-       }
+struct bt_plugin *bt_plugin_create_from_name(const char *plugin_name)
+{
+       const char *system_plugin_dir;
+       char *home_plugin_dir = NULL;
+       const char *envvar;
+       struct bt_plugin *plugin = NULL;
+       struct bt_plugin **plugins = NULL;
+       struct bt_plugin **cur_plugin;
+       GPtrArray *dirs = NULL;
+       int ret;
+       size_t i;
 
-       plugin->info.path = g_string_new(NULL);
-       if (!plugin->info.path) {
-               goto error;
+       if (!plugin_name) {
+               goto end;
        }
 
-       plugin->info.description = g_string_new(NULL);
-       if (!plugin->info.description) {
-               goto error;
+       dirs = g_ptr_array_new_with_free_func((GDestroyNotify) destroy_gstring);
+       if (!dirs) {
+               goto end;
        }
 
-       plugin->info.author = g_string_new(NULL);
-       if (!plugin->info.author) {
-               goto error;
+       /*
+        * Search order is:
+        *
+        * 1. BABELTRACE_PLUGIN_PATH environment variable
+        *    (colon-separated list of directories)
+        * 2. ~/.local/lib/babeltrace/plugins
+        * 3. Default system directory for Babeltrace plugins, usually
+        *    /usr/lib/babeltrace/plugins or
+        *    /usr/local/lib/babeltrace/plugins if installed
+        *    locally
+        * 4. Built-in plugins (static)
+        *
+        * Directories are searched non-recursively.
+        */
+       envvar = getenv("BABELTRACE_PLUGIN_PATH");
+       if (envvar) {
+               ret = bt_common_append_plugin_path_dirs(envvar, dirs);
+               if (ret) {
+                       goto end;
+               }
        }
 
-       plugin->info.license = g_string_new(NULL);
-       if (!plugin->info.license) {
-               goto error;
-       }
+       home_plugin_dir = bt_common_get_home_plugin_path();
+       if (home_plugin_dir) {
+               GString *home_plugin_dir_str =
+                       g_string_new(home_plugin_dir);
 
-       plugin->info.version.extra = g_string_new(NULL);
-       if (!plugin->info.version.extra) {
-               goto error;
+               if (!home_plugin_dir_str) {
+                       goto end;
+               }
+
+               g_ptr_array_add(dirs, home_plugin_dir_str);
        }
 
-       goto end;
+       system_plugin_dir = bt_common_get_system_plugin_path();
+       if (system_plugin_dir) {
+               GString *system_plugin_dir_str =
+                       g_string_new(system_plugin_dir);
 
-error:
-       BT_PUT(plugin);
+               if (!system_plugin_dir_str) {
+                       goto end;
+               }
 
-end:
-       return plugin;
-}
+               g_ptr_array_add(dirs, system_plugin_dir_str);
+       }
 
-struct bt_plugin **bt_plugin_create_all_from_static(void)
-{
-       return bt_plugin_so_create_all_from_static();
-}
+       for (i = 0; i < dirs->len; i++) {
+               GString *dir = g_ptr_array_index(dirs, i);
 
-struct bt_plugin **bt_plugin_create_all_from_file(const char *path)
-{
-       struct bt_plugin **plugins = NULL;
+               printf_verbose("Trying to load plugins from directory `%s`\n",
+                       dir->str);
+               free_plugins(plugins);
+               plugins = bt_plugin_create_all_from_dir(dir->str, false);
+               if (!plugins) {
+                       continue;
+               }
 
-       if (!path) {
-               goto end;
-       }
+               cur_plugin = plugins;
 
-       printf_verbose("Trying to load plugins from `%s`\n", path);
+               while (*cur_plugin) {
+                       if (strcmp(bt_plugin_get_name(*cur_plugin), plugin_name)
+                                       == 0) {
+                               plugin = bt_get(*cur_plugin);
+                               goto end;
+                       }
 
-       /* Try shared object plugins */
-       plugins = bt_plugin_so_create_all_from_file(path);
-       if (plugins) {
-               goto end;
+                       cur_plugin++;
+               }
        }
 
-       plugins = bt_plugin_python_create_all_from_file(path);
-       if (plugins) {
-               goto end;
+       free_plugins(plugins);
+       plugins = bt_plugin_create_all_from_static();
+       cur_plugin = plugins;
+
+       while (*cur_plugin) {
+               if (strcmp(bt_plugin_get_name(*cur_plugin), plugin_name) == 0) {
+                       plugin = bt_get(*cur_plugin);
+                       goto end;
+               }
+
+               cur_plugin++;
        }
 
 end:
-       return plugins;
+       free(home_plugin_dir);
+       free_plugins(plugins);
+
+       if (dirs) {
+               g_ptr_array_free(dirs, TRUE);
+       }
+
+       return plugin;
 }
 
 /* Allocate dirent as recommended by READDIR(3), NOTES on readdir_r */
This page took 0.027545 seconds and 4 git commands to generate.