Adapt plugin system to use unified reference counting

[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 2a60ea1292edb6fbefc59618843108e29e42b1b6..3b60ea2f83e275edd1846a180db8c0134ecb093e 100644 (file)
--- a/include/babeltrace/plugin/plugin-internal.h
+++ b/include/babeltrace/plugin/plugin-internal.h
@@ -1,8 +1,8 @@
 #ifndef BABELTRACE_PLUGIN_INTERNAL_H
-#define BABELTRACE_PLUGIN_INTERNAL_H
+#define BABELTRACE_PLUGIN__INTERNAL_H
 
 /*
- * BabelTrace - Plug-in internal
+ * BabelTrace - Plug-in Internal
  *
  * Copyright 2015 Jérémie Galarneau <jeremie.galarneau@efficios.com>
  *
@@ -27,25 +27,38 @@
  * SOFTWARE.
  */
 
-#include <stdint.h>
-
-#ifdef __cplusplus
-extern "C" {
-#endif
-
-struct bt_notification;
+#include <babeltrace/babeltrace-internal.h>
+#include <babeltrace/ref-internal.h>
+#include <babeltrace/plugin/component.h>
+#include <babeltrace/plugin/plugin.h>
+#include <babeltrace/object-internal.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.
+ */
 struct bt_plugin {
-       const char * name;
-       enum bt_plugin_type type;
-
-       /* Plug-in specific callbacks */
-       bt_plugin_destroy_cb destroy;
-       bt_plugin_set_error_stream_cb set_error_stream;
+       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;
 };
 
-#ifdef __cplusplus
-}
-#endif
+BT_HIDDEN
+struct bt_plugin *bt_plugin_create(GModule *module);
+
+BT_HIDDEN
+enum bt_component_status bt_plugin_register_component_classes(
+               struct bt_plugin *plugin, struct bt_component_factory *factory);
 
-#endif /* BABELTRACE_PLUGIN_INTERNAL_H */
+#endif /* BABELTRACE_PLUGIN_COMPONENT_CLASS_INTERNAL_H */