Code

plugin: Dynamically allocate plugin info attributes.
[sysdb.git] / src / core / plugin.c
index 205c74f148d3f41cb97a1c5b9c891228d1fcc490..26677979b26257e4a9ef89aeed363e9d032e3418 100644 (file)
 
 #include "sysdb.h"
 #include "core/plugin.h"
-#include "utils/error.h"
+#include "core/error.h"
+#include "core/time.h"
 #include "utils/llist.h"
-#include "utils/time.h"
+#include "utils/strbuf.h"
 
 #include <assert.h>
 
@@ -59,24 +60,24 @@ struct sdb_plugin_info {
        int   version;
        int   plugin_version;
 };
-#define SDB_PLUGIN_INFO_INIT { "no name set", "no description set", \
-       /* copyright */ "", /* license */ "", \
+#define SDB_PLUGIN_INFO_INIT { /* 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;
-       char cb_name[64];
        void *cb_callback;
        sdb_object_t *cb_user_data;
        sdb_plugin_ctx_t cb_ctx;
 } sdb_plugin_cb_t;
-#define SDB_PLUGIN_CB_INIT { SDB_OBJECT_INIT, /* name = */ "", \
+#define SDB_PLUGIN_CB_INIT { SDB_OBJECT_INIT, \
        /* callback = */ NULL, /* user_data = */ NULL, \
        SDB_PLUGIN_CTX_INIT }
 
 typedef struct {
        sdb_plugin_cb_t super;
-#define ccb_name super.cb_name
 #define ccb_callback super.cb_callback
 #define ccb_user_data super.cb_user_data
 #define ccb_ctx super.cb_ctx
@@ -99,12 +100,33 @@ static _Bool            plugin_ctx_key_initialized = 0;
 static sdb_llist_t      *config_list = NULL;
 static sdb_llist_t      *init_list = NULL;
 static sdb_llist_t      *collector_list = NULL;
+static sdb_llist_t      *cname_list = NULL;
 static sdb_llist_t      *shutdown_list = NULL;
+static sdb_llist_t      *log_list = NULL;
 
 /*
  * private helper functions
  */
 
+static void
+sdb_plugin_info_clear(sdb_plugin_info_t *info)
+{
+       sdb_plugin_info_t empty_info = SDB_PLUGIN_INFO_INIT;
+       if (! info)
+               return;
+
+       if (info->name)
+               free(info->name);
+       if (info->description)
+               free(info->description);
+       if (info->copyright)
+               free(info->copyright);
+       if (info->license)
+               free(info->license);
+
+       *info = empty_info;
+} /* sdb_plugin_info_clear */
+
 static void
 sdb_plugin_ctx_destructor(void *ctx)
 {
@@ -140,16 +162,6 @@ sdb_plugin_ctx_create(void)
        return ctx;
 } /* sdb_plugin_ctx_create */
 
-static int
-sdb_plugin_cmp_name(const sdb_object_t *a, const sdb_object_t *b)
-{
-       const sdb_plugin_cb_t *cb1 = (const sdb_plugin_cb_t *)a;
-       const sdb_plugin_cb_t *cb2 = (const sdb_plugin_cb_t *)b;
-
-       assert(cb1 && cb2);
-       return strcasecmp(cb1->cb_name, cb2->cb_name);
-} /* sdb_plugin_cmp_name */
-
 static int
 sdb_plugin_cmp_next_update(const sdb_object_t *a, const sdb_object_t *b)
 {
@@ -165,25 +177,6 @@ sdb_plugin_cmp_next_update(const sdb_object_t *a, const sdb_object_t *b)
                ? -1 : 0;
 } /* sdb_plugin_cmp_next_update */
 
-static sdb_plugin_cb_t *
-sdb_plugin_find_by_name(sdb_llist_t *list, const char *name)
-{
-       sdb_plugin_cb_t tmp = SDB_PLUGIN_CB_INIT;
-
-       sdb_object_t *obj;
-       assert(name);
-
-       if (! list)
-               return NULL;
-
-       snprintf(tmp.cb_name, sizeof(tmp.cb_name), "%s", name);
-       tmp.cb_name[sizeof(tmp.cb_name) - 1] = '\0';
-       obj = sdb_llist_search(list, SDB_OBJ(&tmp), sdb_plugin_cmp_name);
-       if (! obj)
-               return NULL;
-       return SDB_PLUGIN_CB(obj);
-} /* sdb_plugin_find_by_name */
-
 /*
  * private types
  */
@@ -192,26 +185,21 @@ static int
 sdb_plugin_cb_init(sdb_object_t *obj, va_list ap)
 {
        sdb_llist_t **list = va_arg(ap, sdb_llist_t **);
-       const char  *type = va_arg(ap, const char *);
-       const char  *name = va_arg(ap, const char *);
-       void    *callback = va_arg(ap, void *);
+       const char   *type = va_arg(ap, const char *);
+       void     *callback = va_arg(ap, void *);
        sdb_object_t   *ud = va_arg(ap, sdb_object_t *);
 
        assert(list);
        assert(type);
        assert(obj);
 
-       if (sdb_plugin_find_by_name(*list, name)) {
+       if (sdb_llist_search_by_name(*list, obj->name)) {
                sdb_log(SDB_LOG_WARNING, "plugin: %s callback '%s' "
                                "has already been registered. Ignoring newly "
-                               "registered version.", type, name);
+                               "registered version.", type, obj->name);
                return -1;
        }
 
-       snprintf(SDB_PLUGIN_CB(obj)->cb_name,
-                       sizeof(SDB_PLUGIN_CB(obj)->cb_name),
-                       "%s", name);
-       SDB_PLUGIN_CB(obj)->cb_name[sizeof(SDB_PLUGIN_CB(obj)->cb_name) - 1] = '\0';
        SDB_PLUGIN_CB(obj)->cb_callback = callback;
        SDB_PLUGIN_CB(obj)->cb_ctx      = sdb_plugin_get_ctx();
 
@@ -231,16 +219,14 @@ static sdb_type_t sdb_plugin_cb_type = {
        sizeof(sdb_plugin_cb_t),
 
        sdb_plugin_cb_init,
-       sdb_plugin_cb_destroy,
-       /* clone = */ NULL
+       sdb_plugin_cb_destroy
 };
 
 static sdb_type_t sdb_plugin_collector_cb_type = {
        sizeof(sdb_plugin_collector_cb_t),
 
        sdb_plugin_cb_init,
-       sdb_plugin_cb_destroy,
-       /* clone = */ NULL
+       sdb_plugin_cb_destroy
 };
 
 static int
@@ -259,8 +245,8 @@ sdb_plugin_add_callback(sdb_llist_t **list, const char *type,
        if (! *list)
                return -1;
 
-       obj = sdb_object_create(sdb_plugin_cb_type,
-                       list, type, name, callback, user_data);
+       obj = sdb_object_create(name, sdb_plugin_cb_type,
+                       list, type, callback, user_data);
        if (! obj)
                return -1;
 
@@ -293,7 +279,7 @@ sdb_plugin_load(const char *name)
        lt_dlhandle lh;
 
        int (*mod_init)(sdb_plugin_info_t *);
-       sdb_plugin_info_t plugin_info = SDB_PLUGIN_INFO_INIT;
+       sdb_plugin_info_t info = SDB_PLUGIN_INFO_INIT;
 
        int status;
 
@@ -339,26 +325,30 @@ sdb_plugin_load(const char *name)
                return -1;
        }
 
-       status = mod_init(&plugin_info);
+       status = mod_init(&info);
        if (status) {
                sdb_log(SDB_LOG_ERR, "plugin: Failed to initialize "
                                "plugin '%s'", name);
+               sdb_plugin_info_clear(&info);
                return -1;
        }
 
        /* compare minor version */
-       if ((plugin_info.version < 0)
-                       || ((int)(plugin_info.version / 100) != (int)(SDB_VERSION / 100)))
+       if ((info.version < 0)
+                       || ((int)(info.version / 100) != (int)(SDB_VERSION / 100)))
                sdb_log(SDB_LOG_WARNING, "plugin: WARNING: version of "
                                "plugin '%s' (%i.%i.%i) does not match our version "
                                "(%i.%i.%i); this might cause problems",
-                               name, SDB_VERSION_DECODE(plugin_info.version),
+                               name, SDB_VERSION_DECODE(info.version),
                                SDB_VERSION_DECODE(SDB_VERSION));
 
        sdb_log(SDB_LOG_INFO, "plugin: Successfully loaded "
-                       "plugin '%s' v%i (%s)\n\t%s",
-                       plugin_info.name, plugin_info.plugin_version,
-                       plugin_info.description, plugin_info.copyright);
+                       "plugin '%s' v%i (%s)\n\t%s\n\tLicense: %s",
+                       INFO_GET(&info, name), info.plugin_version,
+                       INFO_GET(&info, description),
+                       INFO_GET(&info, copyright),
+                       INFO_GET(&info, license));
+       sdb_plugin_info_clear(&info);
        return 0;
 } /* sdb_plugin_load */
 
@@ -376,25 +366,38 @@ sdb_plugin_set_info(sdb_plugin_info_t *info, int type, ...)
                case SDB_PLUGIN_INFO_NAME:
                        {
                                char *name = va_arg(ap, char *);
-                               info->name = name;
+                               if (name) {
+                                       if (info->name)
+                                               free(info->name);
+                                       info->name = strdup(name);
+                               }
                        }
                        break;
                case SDB_PLUGIN_INFO_DESC:
                        {
                                char *desc = va_arg(ap, char *);
-                               info->description = desc;
+                               if (desc) {
+                                       if (info->description)
+                                               free(info->description);
+                                       info->description = strdup(desc);
+                               }
                        }
                        break;
                case SDB_PLUGIN_INFO_COPYRIGHT:
                        {
                                char *copyright = va_arg(ap, char *);
-                               info->copyright = copyright;
+                               if (copyright)
+                                       info->copyright = strdup(copyright);
                        }
                        break;
                case SDB_PLUGIN_INFO_LICENSE:
                        {
                                char *license = va_arg(ap, char *);
-                               info->license = license;
+                               if (license) {
+                                       if (info->license)
+                                               free(info->license);
+                                       info->license = strdup(license);
+                               }
                        }
                        break;
                case SDB_PLUGIN_INFO_VERSION:
@@ -441,6 +444,22 @@ sdb_plugin_register_shutdown(const char *name, sdb_plugin_shutdown_cb callback,
                        callback, user_data);
 } /* sdb_plugin_register_shutdown */
 
+int
+sdb_plugin_register_log(const char *name, sdb_plugin_log_cb callback,
+               sdb_object_t *user_data)
+{
+       return sdb_plugin_add_callback(&log_list, "log", 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 sdb_plugin_add_callback(&cname_list, "cname", 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)
@@ -455,8 +474,8 @@ sdb_plugin_register_collector(const char *name, sdb_plugin_collector_cb callback
        if (! collector_list)
                return -1;
 
-       obj = sdb_object_create(sdb_plugin_collector_cb_type,
-                       &collector_list, "collector", name, callback, user_data);
+       obj = sdb_object_create(name, sdb_plugin_collector_cb_type,
+                       &collector_list, "collector", callback, user_data);
        if (! obj)
                return -1;
 
@@ -543,7 +562,7 @@ sdb_plugin_configure(const char *name, oconfig_item_t *ci)
        if ((! name) || (! ci))
                return -1;
 
-       plugin = sdb_plugin_find_by_name(config_list, name);
+       plugin = SDB_PLUGIN_CB(sdb_llist_search_by_name(config_list, name));
        if (! plugin) {
                /* XXX: check if any such plugin has been loaded */
                sdb_log(SDB_LOG_ERR, "plugin: Plugin '%s' did not register "
@@ -580,6 +599,7 @@ sdb_plugin_init_all(void)
                }
                sdb_plugin_set_ctx(old_ctx);
        }
+       sdb_llist_iter_destroy(iter);
        return 0;
 } /* sdb_plugin_init_all */
 
@@ -644,7 +664,7 @@ sdb_plugin_collector_loop(sdb_plugin_loop_t *loop)
                if (! interval) {
                        sdb_log(SDB_LOG_WARNING, "plugin: No interval configured "
                                        "for plugin '%s'; skipping any further "
-                                       "iterations.", SDB_PLUGIN_CCB(obj)->ccb_name);
+                                       "iterations.", obj->name);
                        sdb_object_deref(obj);
                        continue;
                }
@@ -661,7 +681,7 @@ sdb_plugin_collector_loop(sdb_plugin_loop_t *loop)
                if (now > SDB_PLUGIN_CCB(obj)->ccb_next_update) {
                        sdb_log(SDB_LOG_WARNING, "plugin: Plugin '%s' took too "
                                        "long; skipping iterations to keep up.",
-                                       SDB_PLUGIN_CCB(obj)->ccb_name);
+                                       obj->name);
                        SDB_PLUGIN_CCB(obj)->ccb_next_update = now;
                }
 
@@ -670,7 +690,7 @@ sdb_plugin_collector_loop(sdb_plugin_loop_t *loop)
                        sdb_log(SDB_LOG_ERR, "plugin: Failed to re-insert "
                                        "plugin '%s' into collector list. Unable to further "
                                        "use the plugin.",
-                                       SDB_PLUGIN_CCB(obj)->ccb_name);
+                                       obj->name);
                        sdb_object_deref(obj);
                        return -1;
                }
@@ -681,5 +701,106 @@ sdb_plugin_collector_loop(sdb_plugin_loop_t *loop)
        return 0;
 } /* sdb_plugin_read_loop */
 
+char *
+sdb_plugin_cname(char *hostname)
+{
+       sdb_llist_iter_t *iter;
+
+       if (! hostname)
+               return NULL;
+
+       if (! cname_list)
+               return hostname;
+
+       iter = sdb_llist_get_iter(cname_list);
+       while (sdb_llist_iter_has_next(iter)) {
+               sdb_plugin_cname_cb callback;
+               char *cname;
+
+               sdb_object_t *obj = sdb_llist_iter_get_next(iter);
+               assert(obj);
+
+               callback = SDB_PLUGIN_CB(obj)->cb_callback;
+               cname = callback(hostname, SDB_PLUGIN_CB(obj)->cb_user_data);
+               if (cname) {
+                       free(hostname);
+                       hostname = cname;
+               }
+               /* else: don't change hostname */
+       }
+       sdb_llist_iter_destroy(iter);
+       return hostname;
+} /* sdb_plugin_cname */
+
+int
+sdb_plugin_log(int prio, const char *msg)
+{
+       sdb_llist_iter_t *iter;
+       int ret = -1;
+
+       if (! msg)
+               return 0;
+
+       if (! 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;
+               int tmp;
+
+               sdb_object_t *obj = sdb_llist_iter_get_next(iter);
+               assert(obj);
+
+               callback = SDB_PLUGIN_CB(obj)->cb_callback;
+               tmp = callback(prio, msg, SDB_PLUGIN_CB(obj)->cb_user_data);
+               if (tmp > ret)
+                       ret = tmp;
+       }
+       sdb_llist_iter_destroy(iter);
+       return ret;
+} /* sdb_plugin_log */
+
+int
+sdb_plugin_vlogf(int prio, const char *fmt, va_list ap)
+{
+       sdb_strbuf_t *buf;
+       int ret;
+
+       if (! fmt)
+               return 0;
+
+       buf = sdb_strbuf_create(64);
+       if (! buf) {
+               ret = fprintf(stderr, "[%s] ", SDB_LOG_PRIO_TO_STRING(prio));
+               ret += vfprintf(stderr, fmt, ap);
+               return ret;
+       }
+
+       if (sdb_strbuf_vsprintf(buf, fmt, ap) < 0) {
+               sdb_strbuf_destroy(buf);
+               return -1;
+       }
+
+       ret = sdb_plugin_log(prio, sdb_strbuf_string(buf));
+       sdb_strbuf_destroy(buf);
+       return ret;
+} /* sdb_plugin_vlogf */
+
+int
+sdb_plugin_logf(int prio, const char *fmt, ...)
+{
+       va_list ap;
+       int ret;
+
+       if (! fmt)
+               return 0;
+
+       va_start(ap, fmt);
+       ret = sdb_plugin_vlogf(prio, fmt, ap);
+       va_end(ap);
+       return ret;
+} /* sdb_plugin_logf */
+
 /* vim: set tw=78 sw=4 ts=4 noexpandtab : */