-#ifndef BABELTRACE_PLUGIN_INTERNAL_H
-#define BABELTRACE_PLUGIN__INTERNAL_H
+#ifndef BABELTRACE_PLUGIN_PLUGIN_INTERNAL_H
+#define BABELTRACE_PLUGIN_PLUGIN_INTERNAL_H
/*
* BabelTrace - Plug-in Internal
*/
#include <babeltrace/babeltrace-internal.h>
-#include <babeltrace/ref-internal.h>
-#include <babeltrace/plugin/component.h>
-#include <babeltrace/plugin/plugin.h>
-#include <gmodule.h>
-
-/**
- * Plug-ins are owned by bt_component_factory and the bt_component_class-es
- * it provides. This means that its lifetime bound by either the component
- * factory's, or the concrete components' lifetime which may be in use and which
- * have hold a reference to their bt_component_class which, in turn, have a
- * reference to their plugin.
- *
- * This ensures that a plugin's library is not closed while it is being used
- * even if the bt_component_factory which created its components is destroyed.
- */
+#include <babeltrace/plugin/plugin-dev.h>
+#include <babeltrace/object-internal.h>
+#include <stdbool.h>
+#include <glib.h>
+
+enum bt_plugin_type {
+ BT_PLUGIN_TYPE_SO = 0,
+ BT_PLUGIN_TYPE_PYTHON = 1,
+};
+
struct bt_plugin {
- struct bt_ref ref;
- const char *name;
- const char *author;
- const char *license;
- bt_plugin_init_func init;
- bt_plugin_exit_func exit;
- GModule *module;
+ struct bt_object base;
+ enum bt_plugin_type type;
+ bool frozen;
+
+ /* Array of pointers to bt_component_class (owned by this) */
+ GPtrArray *comp_classes;
+
+ /* Info (owned by this) */
+ struct {
+ GString *path;
+ GString *name;
+ GString *author;
+ GString *license;
+ GString *description;
+ struct {
+ unsigned int major;
+ unsigned int minor;
+ unsigned int patch;
+ GString *extra;
+ } version;
+ bool path_set;
+ bool name_set;
+ bool author_set;
+ bool license_set;
+ bool description_set;
+ bool version_set;
+ } info;
+
+ /* Value depends on the specific plugin type */
+ void *spec_data;
+ void (*destroy_spec_data)(struct bt_plugin *);
+};
+
+struct bt_plugin_set {
+ struct bt_object base;
+
+ /* Array of struct bt_plugin * */
+ GPtrArray *plugins;
};
-BT_HIDDEN
-struct bt_plugin *bt_plugin_create(GModule *module);
+static inline
+void bt_plugin_destroy(struct bt_object *obj)
+{
+ struct bt_plugin *plugin;
+
+ assert(obj);
+ plugin = container_of(obj, struct bt_plugin, base);
+
+ if (plugin->destroy_spec_data) {
+ plugin->destroy_spec_data(plugin);
+ }
+
+ if (plugin->comp_classes) {
+ g_ptr_array_free(plugin->comp_classes, TRUE);
+ }
+
+ if (plugin->info.name) {
+ g_string_free(plugin->info.name, TRUE);
+ }
+
+ if (plugin->info.path) {
+ g_string_free(plugin->info.path, TRUE);
+ }
+
+ if (plugin->info.description) {
+ g_string_free(plugin->info.description, TRUE);
+ }
+
+ if (plugin->info.author) {
+ g_string_free(plugin->info.author, TRUE);
+ }
+
+ if (plugin->info.license) {
+ g_string_free(plugin->info.license, TRUE);
+ }
+
+ if (plugin->info.version.extra) {
+ g_string_free(plugin->info.version.extra, TRUE);
+ }
+
+ g_free(plugin);
+}
+
+static inline
+struct bt_plugin *bt_plugin_create_empty(enum bt_plugin_type type)
+{
+ struct bt_plugin *plugin = NULL;
+
+ plugin = g_new0(struct bt_plugin, 1);
+ if (!plugin) {
+ goto error;
+ }
+
+ bt_object_init(plugin, bt_plugin_destroy);
+ plugin->type = type;
+
+ /* 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;
+ }
+
+ /* Create empty info */
+ plugin->info.name = g_string_new(NULL);
+ if (!plugin->info.name) {
+ goto error;
+ }
+
+ plugin->info.path = g_string_new(NULL);
+ if (!plugin->info.path) {
+ goto error;
+ }
+
+ plugin->info.description = g_string_new(NULL);
+ if (!plugin->info.description) {
+ goto error;
+ }
+
+ plugin->info.author = g_string_new(NULL);
+ if (!plugin->info.author) {
+ goto error;
+ }
+
+ plugin->info.license = g_string_new(NULL);
+ if (!plugin->info.license) {
+ goto error;
+ }
+
+ plugin->info.version.extra = g_string_new(NULL);
+ if (!plugin->info.version.extra) {
+ goto error;
+ }
+
+ goto end;
+
+error:
+ BT_PUT(plugin);
+
+end:
+ return plugin;
+}
+
+static inline
+void bt_plugin_set_path(struct bt_plugin *plugin, const char *path)
+{
+ assert(plugin);
+ assert(path);
+ g_string_assign(plugin->info.path, path);
+ plugin->info.path_set = true;
+}
+
+static inline
+void bt_plugin_set_name(struct bt_plugin *plugin, const char *name)
+{
+ assert(plugin);
+ assert(name);
+ g_string_assign(plugin->info.name, name);
+ plugin->info.name_set = true;
+}
+
+static inline
+void bt_plugin_set_description(struct bt_plugin *plugin,
+ const char *description)
+{
+ assert(plugin);
+ assert(description);
+ g_string_assign(plugin->info.description, description);
+ plugin->info.description_set = true;
+}
+
+static inline
+void bt_plugin_set_author(struct bt_plugin *plugin, const char *author)
+{
+ assert(plugin);
+ assert(author);
+ g_string_assign(plugin->info.author, author);
+ plugin->info.author_set = true;
+}
+
+static inline
+void bt_plugin_set_license(struct bt_plugin *plugin, const char *license)
+{
+ assert(plugin);
+ assert(license);
+ g_string_assign(plugin->info.license, license);
+ plugin->info.license_set = true;
+}
+
+static inline
+void bt_plugin_set_version(struct bt_plugin *plugin, unsigned int major,
+ unsigned int minor, unsigned int patch, const char *extra)
+{
+ assert(plugin);
+ plugin->info.version.major = major;
+ plugin->info.version.minor = minor;
+ plugin->info.version.patch = patch;
+
+ if (extra) {
+ g_string_assign(plugin->info.version.extra, extra);
+ }
+
+ plugin->info.version_set = true;
+}
+
+static inline
+void bt_plugin_freeze(struct bt_plugin *plugin)
+{
+ assert(plugin);
+ plugin->frozen = true;
+}
+
+static
+void bt_plugin_set_destroy(struct bt_object *obj)
+{
+ struct bt_plugin_set *plugin_set =
+ container_of(obj, struct bt_plugin_set, base);
+
+ if (!plugin_set) {
+ return;
+ }
+
+ if (plugin_set->plugins) {
+ g_ptr_array_free(plugin_set->plugins, TRUE);
+ }
+
+ g_free(plugin_set);
+}
+
+static inline
+struct bt_plugin_set *bt_plugin_set_create(void)
+{
+ struct bt_plugin_set *plugin_set = g_new0(struct bt_plugin_set, 1);
+
+ if (!plugin_set) {
+ goto end;
+ }
+
+ bt_object_init(plugin_set, bt_plugin_set_destroy);
-BT_HIDDEN
-enum bt_component_status bt_plugin_register_component_classes(
- struct bt_plugin *plugin, struct bt_component_factory *factory);
+ plugin_set->plugins = g_ptr_array_new_with_free_func(
+ (GDestroyNotify) bt_put);
+ if (!plugin_set->plugins) {
+ BT_PUT(plugin_set);
+ goto end;
+ }
-BT_HIDDEN
-void bt_plugin_get(struct bt_plugin *plugin);
+end:
+ return plugin_set;
+}
-BT_HIDDEN
-void bt_plugin_put(struct bt_plugin *plugin);
+static inline
+void bt_plugin_set_add_plugin(struct bt_plugin_set *plugin_set,
+ struct bt_plugin *plugin)
+{
+ assert(plugin_set);
+ assert(plugin);
+ g_ptr_array_add(plugin_set->plugins, bt_get(plugin));
+}
-#endif /* BABELTRACE_PLUGIN_COMPONENT_CLASS_INTERNAL_H */
+#endif /* BABELTRACE_PLUGIN_PLUGIN_INTERNAL_H */
projects / babeltrace.git / blobdiff