Code

plugin: Make sdb_plugin_info_t public.
[sysdb.git] / src / core / plugin.c
index 873e64a19436903c379bff983565c825008f2a43..f10a904169f5d3993dc89894535e6a7b4ca01513 100644 (file)
 
 #include <pthread.h>
 
+/* helper to access info attributes */
+#define INFO_GET(i, attr) \
+       ((i)->attr ? (i)->attr : #attr" not set")
+
 /*
  * private data types
  */
 
-struct sdb_plugin_info {
-       char *plugin_name;
-       char *filename;
-
-       /* public attributes */
-       char *name;
-
-       char *description;
-       char *copyright;
-       char *license;
-
-       int   version;
-       int   plugin_version;
-};
-#define SDB_PLUGIN_INFO_INIT { \
-       /* plugin_name */ NULL, /* filename */ NULL, \
-       /* name */ NULL, /* desc */ NULL, \
-       /* copyright */ NULL, /* license */ NULL, \
-       /* version */ -1, /* plugin_version */ -1 }
-#define INFO_GET(i, attr) \
-       ((i)->attr ? (i)->attr : #attr" not set")
-
 typedef struct {
        sdb_object_t super;
        sdb_plugin_ctx_t public;
@@ -165,8 +147,6 @@ plugin_info_clear(sdb_plugin_info_t *info)
        if (info->filename)
                free(info->filename);
 
-       if (info->name)
-               free(info->name);
        if (info->description)
                free(info->description);
        if (info->copyright)
@@ -442,7 +422,8 @@ module_init(const char *name, lt_dlhandle lh, sdb_plugin_info_t *info)
 } /* module_init */
 
 static int
-module_load(const char *name, const sdb_plugin_ctx_t *plugin_ctx)
+module_load(const char *basedir, const char *name,
+               const sdb_plugin_ctx_t *plugin_ctx)
 {
        char  base_name[name ? strlen(name) + 1 : 1];
        const char *name_ptr;
@@ -455,6 +436,8 @@ module_load(const char *name, const sdb_plugin_ctx_t *plugin_ctx)
 
        int status;
 
+       assert(name);
+
        base_name[0] = '\0';
        name_ptr = name;
 
@@ -465,8 +448,10 @@ module_load(const char *name, const sdb_plugin_ctx_t *plugin_ctx)
        }
        strcat(base_name, name_ptr);
 
-       snprintf(filename, sizeof(filename), "%s/%s.so",
-                       PKGLIBDIR, base_name);
+       if (! basedir)
+               basedir = PKGLIBDIR;
+
+       snprintf(filename, sizeof(filename), "%s/%s.so", basedir, base_name);
        filename[sizeof(filename) - 1] = '\0';
 
        if (access(filename, R_OK)) {
@@ -520,9 +505,11 @@ module_load(const char *name, const sdb_plugin_ctx_t *plugin_ctx)
        sdb_llist_append(all_plugins, SDB_OBJ(ctx));
 
        sdb_log(SDB_LOG_INFO, "core: Successfully loaded "
-                       "plugin '%s' v%i (%s)\n\t%s\n\tLicense: %s",
-                       INFO_GET(&ctx->info, name), ctx->info.plugin_version,
-                       INFO_GET(&ctx->info, description),
+                       "plugin %s v%i (%s)", ctx->info.plugin_name,
+                       ctx->info.plugin_version,
+                       INFO_GET(&ctx->info, description));
+       sdb_log(SDB_LOG_INFO, "core: Plugin %s: %s, License: %s",
+                       ctx->info.plugin_name,
                        INFO_GET(&ctx->info, copyright),
                        INFO_GET(&ctx->info, license));
 
@@ -534,6 +521,18 @@ module_load(const char *name, const sdb_plugin_ctx_t *plugin_ctx)
        return 0;
 } /* module_load */
 
+static char *
+plugin_get_name(const char *name, char *buf, size_t bufsize)
+{
+       ctx_t *ctx = ctx_get();
+
+       if (ctx)
+               snprintf(buf, bufsize, "%s::%s", ctx->info.plugin_name, name);
+       else
+               snprintf(buf, bufsize, "core::%s", name);
+       return buf;
+} /* plugin_get_name */
+
 static int
 plugin_add_callback(sdb_llist_t **list, const char *type,
                const char *name, void *callback, sdb_object_t *user_data)
@@ -573,7 +572,8 @@ plugin_add_callback(sdb_llist_t **list, const char *type,
  */
 
 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)
 {
        ctx_t *ctx;
 
@@ -602,7 +602,7 @@ sdb_plugin_load(const char *name, const sdb_plugin_ctx_t *plugin_ctx)
                                return status;
 
                        sdb_log(SDB_LOG_INFO, "core: Successfully reloaded plugin "
-                                       "'%s' (%s)", INFO_GET(&ctx->info, name),
+                                       "'%s' (%s)", ctx->info.plugin_name,
                                        INFO_GET(&ctx->info, description));
                        ctx_set(old_ctx);
                }
@@ -610,7 +610,7 @@ sdb_plugin_load(const char *name, const sdb_plugin_ctx_t *plugin_ctx)
                return 0;
        }
 
-       return module_load(name, plugin_ctx);
+       return module_load(basedir, name, plugin_ctx);
 } /* sdb_plugin_load */
 
 int
@@ -624,16 +624,6 @@ sdb_plugin_set_info(sdb_plugin_info_t *info, int type, ...)
        va_start(ap, type);
 
        switch (type) {
-               case SDB_PLUGIN_INFO_NAME:
-                       {
-                               char *name = va_arg(ap, char *);
-                               if (name) {
-                                       if (info->name)
-                                               free(info->name);
-                                       info->name = strdup(name);
-                               }
-                       }
-                       break;
                case SDB_PLUGIN_INFO_DESC:
                        {
                                char *desc = va_arg(ap, char *);
@@ -683,9 +673,16 @@ sdb_plugin_set_info(sdb_plugin_info_t *info, int type, ...)
 } /* sdb_plugin_set_info */
 
 int
-sdb_plugin_register_config(const char *name, sdb_plugin_config_cb callback)
+sdb_plugin_register_config(sdb_plugin_config_cb callback)
 {
-       return plugin_add_callback(&config_list, "init", name,
+       ctx_t *ctx = ctx_get();
+
+       if (! ctx) {
+               sdb_log(SDB_LOG_ERR, "core: Invalid attempt to register a "
+                               "config callback from outside a plugin");
+               return -1;
+       }
+       return plugin_add_callback(&config_list, "init", ctx->info.plugin_name,
                        (void *)callback, NULL);
 } /* sdb_plugin_register_config */
 
@@ -693,7 +690,9 @@ int
 sdb_plugin_register_init(const char *name, sdb_plugin_init_cb callback,
                sdb_object_t *user_data)
 {
-       return plugin_add_callback(&init_list, "init", name,
+       char cb_name[1024];
+       return plugin_add_callback(&init_list, "init",
+                       plugin_get_name(name, cb_name, sizeof(cb_name)),
                        (void *)callback, user_data);
 } /* sdb_plugin_register_init */
 
@@ -701,7 +700,9 @@ int
 sdb_plugin_register_shutdown(const char *name, sdb_plugin_shutdown_cb callback,
                sdb_object_t *user_data)
 {
-       return plugin_add_callback(&shutdown_list, "shutdown", name,
+       char cb_name[1024];
+       return plugin_add_callback(&shutdown_list, "shutdown",
+                       plugin_get_name(name, cb_name, sizeof(cb_name)),
                        (void *)callback, user_data);
 } /* sdb_plugin_register_shutdown */
 
@@ -709,22 +710,27 @@ int
 sdb_plugin_register_log(const char *name, sdb_plugin_log_cb callback,
                sdb_object_t *user_data)
 {
-       return plugin_add_callback(&log_list, "log", name, (void *)callback,
-                       user_data);
+       char cb_name[1024];
+       return plugin_add_callback(&log_list, "log",
+                       plugin_get_name(name, cb_name, sizeof(cb_name)),
+                       callback, user_data);
 } /* sdb_plugin_register_log */
 
 int
 sdb_plugin_register_cname(const char *name, sdb_plugin_cname_cb callback,
                sdb_object_t *user_data)
 {
-       return plugin_add_callback(&cname_list, "cname", name, (void *)callback,
-                       user_data);
+       char cb_name[1024];
+       return plugin_add_callback(&cname_list, "cname",
+                       plugin_get_name(name, cb_name, sizeof(cb_name)),
+                       callback, user_data);
 } /* sdb_plugin_register_cname */
 
 int
 sdb_plugin_register_collector(const char *name, sdb_plugin_collector_cb callback,
                const sdb_time_t *interval, sdb_object_t *user_data)
 {
+       char cb_name[1024];
        sdb_object_t *obj;
 
        if ((! name) || (! callback))
@@ -735,7 +741,9 @@ sdb_plugin_register_collector(const char *name, sdb_plugin_collector_cb callback
        if (! collector_list)
                return -1;
 
-       obj = sdb_object_create(name, sdb_plugin_collector_cb_type,
+       plugin_get_name(name, cb_name, sizeof(cb_name));
+
+       obj = sdb_object_create(cb_name, sdb_plugin_collector_cb_type,
                        &collector_list, "collector", callback, user_data);
        if (! obj)
                return -1;
@@ -769,7 +777,7 @@ sdb_plugin_register_collector(const char *name, sdb_plugin_collector_cb callback
        sdb_object_deref(obj);
 
        sdb_log(SDB_LOG_INFO, "core: Registered collector callback '%s' "
-                       "(interval = %.3fs).", name,
+                       "(interval = %.3fs).", cb_name,
                        SDB_TIME_TO_DOUBLE(SDB_PLUGIN_CCB(obj)->ccb_interval));
        return 0;
 } /* sdb_plugin_register_collector */
@@ -823,7 +831,9 @@ sdb_plugin_configure(const char *name, oconfig_item_t *ci)
        if (! plugin) {
                ctx_t *ctx = CTX(sdb_llist_search_by_name(all_plugins, name));
                if (! ctx)
-                       sdb_log(SDB_LOG_ERR, "core: Plugin '%s' not loaded.", name);
+                       sdb_log(SDB_LOG_ERR, "core: Cannot configure unknown "
+                                       "plugin '%s'. Missing 'LoadPlugin \"%s\"'?",
+                                       name, name);
                else
                        sdb_log(SDB_LOG_ERR, "core: Plugin '%s' did not register "
                                        "a config callback.", name);
@@ -931,6 +941,36 @@ sdb_plugin_init_all(void)
        return ret;
 } /* sdb_plugin_init_all */
 
+int
+sdb_plugin_shutdown_all(void)
+{
+       sdb_llist_iter_t *iter;
+       int ret = 0;
+
+       iter = sdb_llist_get_iter(shutdown_list);
+       while (sdb_llist_iter_has_next(iter)) {
+               sdb_plugin_cb_t *cb;
+               sdb_plugin_shutdown_cb callback;
+               ctx_t *old_ctx;
+
+               sdb_object_t *obj = sdb_llist_iter_get_next(iter);
+               assert(obj);
+               cb = SDB_PLUGIN_CB(obj);
+
+               callback = (sdb_plugin_shutdown_cb)cb->cb_callback;
+
+               old_ctx = ctx_set(cb->cb_ctx);
+               if (callback(cb->cb_user_data)) {
+                       sdb_log(SDB_LOG_ERR, "core: Failed to shutdown plugin '%s'.",
+                                       obj->name);
+                       ++ret;
+               }
+               ctx_set(old_ctx);
+       }
+       sdb_llist_iter_destroy(iter);
+       return ret;
+} /* sdb_plugin_shutdown_all */
+
 int
 sdb_plugin_collector_loop(sdb_plugin_loop_t *loop)
 {
@@ -973,13 +1013,21 @@ sdb_plugin_collector_loop(sdb_plugin_loop_t *loop)
                                        sdb_log(SDB_LOG_ERR, "core: Failed to sleep "
                                                        "in collector main loop: %s",
                                                        sdb_strerror(errno, errbuf, sizeof(errbuf)));
+                                       sdb_llist_insert_sorted(collector_list, obj,
+                                                       plugin_cmp_next_update);
+                                       sdb_object_deref(obj);
                                        return -1;
                                }
                                errno = 0;
                        }
 
-                       if (! loop->do_loop)
+                       if (! loop->do_loop) {
+                               /* put back; don't worry about errors */
+                               sdb_llist_insert_sorted(collector_list, obj,
+                                               plugin_cmp_next_update);
+                               sdb_object_deref(obj);
                                return 0;
+                       }
                }
 
                old_ctx = ctx_set(SDB_PLUGIN_CCB(obj)->ccb_ctx);
@@ -1069,12 +1117,11 @@ sdb_plugin_log(int prio, const char *msg)
        sdb_llist_iter_t *iter;
        int ret = -1;
 
+       _Bool logged = 0;
+
        if (! msg)
                return 0;
 
-       if (! sdb_llist_len(log_list))
-               return fprintf(stderr, "[%s] %s\n", SDB_LOG_PRIO_TO_STRING(prio), msg);
-
        iter = sdb_llist_get_iter(log_list);
        while (sdb_llist_iter_has_next(iter)) {
                sdb_plugin_log_cb callback;
@@ -1087,8 +1134,15 @@ sdb_plugin_log(int prio, const char *msg)
                tmp = callback(prio, msg, SDB_PLUGIN_CB(obj)->cb_user_data);
                if (tmp > ret)
                        ret = tmp;
+
+               if (SDB_PLUGIN_CB(obj)->cb_ctx)
+                       logged = 1;
+               /* else: this is an internally registered callback */
        }
        sdb_llist_iter_destroy(iter);
+
+       if (! logged)
+               return fprintf(stderr, "[%s] %s\n", SDB_LOG_PRIO_TO_STRING(prio), msg);
        return ret;
 } /* sdb_plugin_log */