Component creation

[babeltrace.git] / include / babeltrace / plugin / plugin-internal.h

diff --git a/include/babeltrace/plugin/plugin-internal.h b/include/babeltrace/plugin/plugin-internal.h
index 3fc85c858c90b905e5a40531960cfb4308f729b1..673b7818f4838d8ed6998a2a18ef9e1e1981a0ca 100644 (file)
--- a/include/babeltrace/plugin/plugin-internal.h
+++ b/include/babeltrace/plugin/plugin-internal.h
@@ -1,8 +1,8 @@
-#ifndef BABELTRACE_PLUGIN_COMPONENT_INTERNAL_H
-#define BABELTRACE_PLUGIN_COMPONENT_INTERNAL_H
+#ifndef BABELTRACE_PLUGIN_INTERNAL_H
+#define BABELTRACE_PLUGIN_INTERNAL_H
 
 /*
- * BabelTrace - Component internal
+ * BabelTrace - Plug-in Internal
  *
  * Copyright 2015 Jérémie Galarneau <jeremie.galarneau@efficios.com>
  *
@@ -28,40 +28,37 @@
  */
 
 #include <babeltrace/babeltrace-internal.h>
-#include <babeltrace/plugin/plugin.h>
+#include <babeltrace/ref-internal.h>
 #include <babeltrace/plugin/component.h>
 #include <babeltrace/plugin/plugin-system.h>
-#include <babeltrace/ctf-writer/ref-internal.h>
-#include <glib.h>
-#include <stdio.h>
+#include <babeltrace/object-internal.h>
+#include <gmodule.h>
 
-#ifdef __cplusplus
-extern "C" {
-#endif
-
-struct bt_notification;
-
-struct bt_component {
-       struct bt_ctf_ref ref_count;
-       GString *name;
-       enum bt_plugin_type type;
-       /** No ownership taken */
-       FILE *error_stream;
-
-       void *user_data;
-       bt_plugin_destroy_cb user_data_destroy;
-       bt_plugin_destroy_cb destroy;
+/**
+ * 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.
+ */
+struct bt_plugin {
+       struct bt_object base;
+       const char *name;
+       const char *author;
+       const char *license;
+        bt_plugin_init_func init;
+       bt_plugin_exit_func exit;
+       GModule *module;
 };
 
 BT_HIDDEN
-enum bt_component_status bt_component_init(struct bt_component *plugin,
-               const char *name, void *user_data,
-               bt_component_destroy_cb destroy_func,
-               enum bt_component_type component_type,
-               bt_component_destroy_cb component_destroy);
+struct bt_plugin *bt_plugin_create(GModule *module);
 
-#ifdef __cplusplus
-}
-#endif
+BT_HIDDEN
+enum bt_component_status bt_plugin_register_component_classes(
+               struct bt_plugin *plugin, struct bt_component_factory *factory);
 
-#endif /* BABELTRACE_PLUGIN_COMPONENT_INTERNAL_H */
+#endif /* BABELTRACE_PLUGIN_INTERNAL_H */