plugin: Automatically prepend callback names with the plugin name.

[sysdb.git] / src / include / core / plugin.h

diff --git a/src/include/core/plugin.h b/src/include/core/plugin.h
index 6a679ce8a17baa5900573ee38cf0deb3e22882cb..bcf01ec411bd5d2dc7e3ab25d17a99f88edd7037 100644 (file)
--- a/src/include/core/plugin.h
+++ b/src/include/core/plugin.h
@@ -52,7 +52,7 @@ typedef struct sdb_plugin_info sdb_plugin_info_t;
  * missing prototype warnings/errors for the plugin init
  * function */
 #define SDB_PLUGIN_MAGIC \
-       int sdb_module_init(sdb_plugin_info_t *info);
+       int sdb_module_init(sdb_plugin_info_t *info)
 
 typedef struct {
        _Bool do_loop;
@@ -64,10 +64,12 @@ typedef struct {
  * sdb_plugin_load:
  * Load (any type of) plugin by loading the shared object file and calling the
  * sdb_module_init function. If specified, 'plugin_ctx' fine-tunes the
- * behavior of the plugin.
+ * behavior of the plugin. If specified, the plugin will be looked up in
+ * 'basedir', else it defaults to the package libdir.
  */
 int
-sdb_plugin_load(const char *name, const sdb_plugin_ctx_t *plugin_ctx);
+sdb_plugin_load(const char *basedir, const char *name,
+               const sdb_plugin_ctx_t *plugin_ctx);
 
 /*
  * sdb_plugin_set_info:
@@ -91,6 +93,9 @@ sdb_plugin_set_info(sdb_plugin_info_t *info, int type, ...);
  * plugin callback functions:
  * See the description of the respective register function for what arguments
  * the callbacks expect.
+ *
+ * The specified name of callback functions is prepended with the plugin name
+ * before being registered with the core.
  */
 
 typedef int (*sdb_plugin_config_cb)(oconfig_item_t *ci);
@@ -114,7 +119,7 @@ typedef int (*sdb_plugin_log_cb)(int prio, const char *msg,
  *  - a negative value else
  */
 int
-sdb_plugin_register_config(const char *name, sdb_plugin_config_cb callback);
+sdb_plugin_register_config(sdb_plugin_config_cb callback);
 
 /*
  * sdb_plugin_register_init:
@@ -223,7 +228,7 @@ sdb_plugin_register_log(const char *name, sdb_plugin_log_cb callback,
  * every plugin care about it.
  *
  * If non-NULL, sdb_plugin_set_ctx stores the previous context in the location
- * pointed to be 'old'.
+ * pointed to by 'old'.
  */
 sdb_plugin_ctx_t
 sdb_plugin_get_ctx(void);
@@ -232,8 +237,8 @@ sdb_plugin_set_ctx(sdb_plugin_ctx_t ctx, sdb_plugin_ctx_t *old);
 
 /*
  * sdb_plugin_configure:
- * Configure the plugin called 'name' (according to the registered config
- * callback) using the config tree 'ci'.
+ * Configure the plugin called 'name' using the config tree 'ci'. The plugin
+ * name is the same as the one used when loading the plugin.
  *
  * Returns:
  *  - 0 on success
@@ -242,13 +247,47 @@ sdb_plugin_set_ctx(sdb_plugin_ctx_t ctx, sdb_plugin_ctx_t *old);
 int
 sdb_plugin_configure(const char *name, oconfig_item_t *ci);
 
+/*
+ * sdb_plugin_reconfigure_init, sdb_plugin_reconfigure_finish:
+ * Reconfigure all plugins. This happens in multiple steps: first, call
+ * sdb_plugin_reconfigure_init to deconfigure all plugins by calling their
+ * config callbacks with a NULL config tree and unregistering all callbacks.
+ * Then, sdb_plugin_configure and other functions may be used to provide the
+ * new configuration or load new plugins. For all plugins which were already
+ * loaded before, sdb_module_init will be called with a NULL argument when
+ * reloading them.
+ * Finally, sdb_plugin_reconfigure_finish will clean up leftover pieces, like
+ * unloading plugins which are no longer in use.
+ *
+ * Returns:
+ *  - 0 on success
+ *  - a negative value else
+ */
+int
+sdb_plugin_reconfigure_init(void);
+int
+sdb_plugin_reconfigure_finish(void);
+
 /*
  * sdb_plugin_init_all:
  * Initialize all plugins using their registered "init" function.
+ *
+ * Returns:
+ * The number of failed initializations.
  */
 int
 sdb_plugin_init_all(void);
 
+/*
+ * sdb_plugin_shutdown_all:
+ * Shutdown all plugins using their registered "shutdown" function.
+ *
+ * Returns:
+ * The number of failed shutdowns.
+ */
+int
+sdb_plugin_shutdown_all(void);
+
 /*
  * sdb_plugin_collector_loop:
  * Loop until loop->do_loop is false, calling the next collector function on