X-Git-Url: https://git.tokkee.org/?a=blobdiff_plain;f=src%2Fcore%2Fplugin.c;h=8200338a9d8fbb0804869b96f9267ed7b776e683;hb=ddb933096618a6bceded29e4dc2b37cb72134366;hp=a31ede30f2ed4104f104d9780bb6104ed484ed17;hpb=336bcee462f82f33c8f9d8612959208b047ea93a;p=sysdb.git diff --git a/src/core/plugin.c b/src/core/plugin.c index a31ede3..8200338 100644 --- a/src/core/plugin.c +++ b/src/core/plugin.c @@ -27,8 +27,8 @@ #include "sysdb.h" #include "core/plugin.h" -#include "core/error.h" #include "core/time.h" +#include "utils/error.h" #include "utils/llist.h" #include "utils/strbuf.h" @@ -51,6 +51,10 @@ */ struct sdb_plugin_info { + char *plugin_name; + char *filename; + + /* public attributes */ char *name; char *description; @@ -60,7 +64,9 @@ struct sdb_plugin_info { int version; int plugin_version; }; -#define SDB_PLUGIN_INFO_INIT { /* name */ NULL, /* desc */ NULL, \ +#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) \ @@ -69,9 +75,11 @@ struct sdb_plugin_info { typedef struct { sdb_object_t super; sdb_plugin_ctx_t public; + + sdb_plugin_info_t info; } ctx_t; #define CTX_INIT { SDB_OBJECT_INIT, \ - SDB_PLUGIN_CTX_INIT } + SDB_PLUGIN_CTX_INIT, SDB_PLUGIN_INFO_INIT } #define CTX(obj) ((ctx_t *)(obj)) @@ -95,13 +103,16 @@ typedef struct { } sdb_plugin_collector_cb_t; #define SDB_PLUGIN_CB(obj) ((sdb_plugin_cb_t *)(obj)) +#define SDB_CONST_PLUGIN_CB(obj) ((const sdb_plugin_cb_t *)(obj)) #define SDB_PLUGIN_CCB(obj) ((sdb_plugin_collector_cb_t *)(obj)) +#define SDB_CONST_PLUGIN_CCB(obj) ((const sdb_plugin_collector_cb_t *)(obj)) /* * private variables */ -static sdb_plugin_ctx_t plugin_default_ctx = SDB_PLUGIN_CTX_INIT; +static sdb_plugin_ctx_t plugin_default_ctx = SDB_PLUGIN_CTX_INIT; +static sdb_plugin_info_t plugin_default_info = SDB_PLUGIN_INFO_INIT; static pthread_key_t plugin_ctx_key; static _Bool plugin_ctx_key_initialized = 0; @@ -118,12 +129,17 @@ static sdb_llist_t *log_list = NULL; */ static void -sdb_plugin_info_clear(sdb_plugin_info_t *info) +plugin_info_clear(sdb_plugin_info_t *info) { sdb_plugin_info_t empty_info = SDB_PLUGIN_INFO_INIT; if (! info) return; + if (info->plugin_name) + free(info->plugin_name); + if (info->filename) + free(info->filename); + if (info->name) free(info->name); if (info->description) @@ -134,7 +150,7 @@ sdb_plugin_info_clear(sdb_plugin_info_t *info) free(info->license); *info = empty_info; -} /* sdb_plugin_info_clear */ +} /* plugin_info_clear */ static void ctx_key_init(void) @@ -147,7 +163,7 @@ ctx_key_init(void) } /* ctx_key_init */ static int -sdb_plugin_cmp_next_update(const sdb_object_t *a, const sdb_object_t *b) +plugin_cmp_next_update(const sdb_object_t *a, const sdb_object_t *b) { const sdb_plugin_collector_cb_t *ccb1 = (const sdb_plugin_collector_cb_t *)a; @@ -159,7 +175,56 @@ sdb_plugin_cmp_next_update(const sdb_object_t *a, const sdb_object_t *b) return (ccb1->ccb_next_update > ccb2->ccb_next_update) ? 1 : (ccb1->ccb_next_update < ccb2->ccb_next_update) ? -1 : 0; -} /* sdb_plugin_cmp_next_update */ +} /* plugin_cmp_next_update */ + +static int +plugin_lookup_by_name(const sdb_object_t *obj, const void *id) +{ + const sdb_plugin_cb_t *cb = SDB_CONST_PLUGIN_CB(obj); + const char *name = id; + + assert(cb && id && cb->cb_ctx); + if (!strcasecmp(cb->cb_ctx->info.plugin_name, name)) + return 0; + return 1; +} /* plugin_lookup_by_name */ + +static void +plugin_unregister_by_name(const char *plugin_name) +{ + size_t i; + + struct { + const char *type; + sdb_llist_t *list; + } all_lists[] = { + { "config", config_list }, + { "init", init_list }, + { "collector", collector_list }, + { "cname", cname_list }, + { "shutdown", shutdown_list }, + { "log", log_list }, + }; + + for (i = 0; i < SDB_STATIC_ARRAY_LEN(all_lists); ++i) { + const char *type = all_lists[i].type; + sdb_llist_t *list = all_lists[i].list; + + while (1) { + sdb_object_t *obj = sdb_llist_remove(list, + plugin_lookup_by_name, plugin_name); + sdb_plugin_cb_t *cb = SDB_PLUGIN_CB(obj); + + if (! obj) + break; + + sdb_log(SDB_LOG_INFO, "core: Unregistering " + "%s callback '%s' (module %s)", type, obj->name, + cb->cb_ctx->info.plugin_name); + sdb_object_deref(obj); + } + } +} /* plugin_unregister_by_name */ /* * private types @@ -173,14 +238,22 @@ ctx_init(sdb_object_t *obj, va_list __attribute__((unused)) ap) assert(ctx); ctx->public = plugin_default_ctx; + ctx->info = plugin_default_info; return 0; } /* ctx_init */ +static void +ctx_destroy(sdb_object_t *obj) +{ + ctx_t *ctx = CTX(obj); + plugin_info_clear(&ctx->info); +} /* ctx_destroy */ + static sdb_type_t ctx_type = { sizeof(ctx_t), ctx_init, - NULL + ctx_destroy }; static ctx_t * @@ -220,7 +293,7 @@ ctx_set(ctx_t *new) } /* ctx_set */ static int -sdb_plugin_cb_init(sdb_object_t *obj, va_list ap) +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 *); @@ -232,7 +305,7 @@ sdb_plugin_cb_init(sdb_object_t *obj, va_list ap) assert(obj); if (sdb_llist_search_by_name(*list, obj->name)) { - sdb_log(SDB_LOG_WARNING, "plugin: %s callback '%s' " + sdb_log(SDB_LOG_WARNING, "core: %s callback '%s' " "has already been registered. Ignoring newly " "registered version.", type, obj->name); return -1; @@ -245,32 +318,32 @@ sdb_plugin_cb_init(sdb_object_t *obj, va_list ap) sdb_object_ref(ud); SDB_PLUGIN_CB(obj)->cb_user_data = ud; return 0; -} /* sdb_plugin_cb_init */ +} /* plugin_cb_init */ static void -sdb_plugin_cb_destroy(sdb_object_t *obj) +plugin_cb_destroy(sdb_object_t *obj) { assert(obj); sdb_object_deref(SDB_PLUGIN_CB(obj)->cb_user_data); sdb_object_deref(SDB_OBJ(SDB_PLUGIN_CB(obj)->cb_ctx)); -} /* sdb_plugin_cb_destroy */ +} /* plugin_cb_destroy */ static sdb_type_t sdb_plugin_cb_type = { sizeof(sdb_plugin_cb_t), - sdb_plugin_cb_init, - sdb_plugin_cb_destroy + plugin_cb_init, + 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 + plugin_cb_init, + plugin_cb_destroy }; static int -sdb_plugin_add_callback(sdb_llist_t **list, const char *type, +plugin_add_callback(sdb_llist_t **list, const char *type, const char *name, void *callback, sdb_object_t *user_data) { sdb_object_t *obj; @@ -298,10 +371,10 @@ sdb_plugin_add_callback(sdb_llist_t **list, const char *type, /* pass control to the list */ sdb_object_deref(obj); - sdb_log(SDB_LOG_INFO, "plugin: Registered %s callback '%s'.", + sdb_log(SDB_LOG_INFO, "core: Registered %s callback '%s'.", type, name); return 0; -} /* sdb_plugin_add_callback */ +} /* plugin_add_callback */ /* * public API @@ -320,8 +393,6 @@ sdb_plugin_load(const char *name, const sdb_plugin_ctx_t *plugin_ctx) lt_dlhandle lh; int (*mod_init)(sdb_plugin_info_t *); - sdb_plugin_info_t info = SDB_PLUGIN_INFO_INIT; - int status; if ((! name) || (! *name)) @@ -343,7 +414,7 @@ sdb_plugin_load(const char *name, const sdb_plugin_ctx_t *plugin_ctx) if (access(filename, R_OK)) { char errbuf[1024]; - sdb_log(SDB_LOG_ERR, "plugin: Failed to load plugin '%s' (%s): %s", + sdb_log(SDB_LOG_ERR, "core: Failed to load plugin '%s' (%s): %s", name, filename, sdb_strerror(errno, errbuf, sizeof(errbuf))); return -1; } @@ -353,58 +424,60 @@ sdb_plugin_load(const char *name, const sdb_plugin_ctx_t *plugin_ctx) lh = lt_dlopen(filename); if (! lh) { - sdb_log(SDB_LOG_ERR, "plugin: Failed to load plugin '%s': %s" + sdb_log(SDB_LOG_ERR, "core: Failed to load plugin '%s': %s" "The most common cause for this problem are missing " "dependencies.\n", name, lt_dlerror()); return -1; } if (ctx_get()) - sdb_log(SDB_LOG_WARNING, "plugin: Discarding old plugin context"); + sdb_log(SDB_LOG_WARNING, "core: Discarding old plugin context"); ctx = ctx_create(); if (! ctx) { - sdb_log(SDB_LOG_ERR, "plugin: Failed to initialize plugin context"); + sdb_log(SDB_LOG_ERR, "core: Failed to initialize plugin context"); return -1; } + ctx->info.plugin_name = strdup(name); + ctx->info.filename = strdup(filename); + if (plugin_ctx) ctx->public = *plugin_ctx; mod_init = (int (*)(sdb_plugin_info_t *))lt_dlsym(lh, "sdb_module_init"); if (! mod_init) { - sdb_log(SDB_LOG_ERR, "plugin: Failed to load plugin '%s': " + sdb_log(SDB_LOG_ERR, "core: Failed to load plugin '%s': " "could not find symbol 'sdb_module_init'", name); sdb_object_deref(SDB_OBJ(ctx)); return -1; } - status = mod_init(&info); + status = mod_init(&ctx->info); if (status) { - sdb_log(SDB_LOG_ERR, "plugin: Failed to initialize " - "plugin '%s'", name); - sdb_plugin_info_clear(&info); + sdb_log(SDB_LOG_ERR, "core: Failed to initialize " + "module '%s'", name); + plugin_unregister_by_name(ctx->info.plugin_name); sdb_object_deref(SDB_OBJ(ctx)); return -1; } /* compare minor version */ - if ((info.version < 0) - || ((int)(info.version / 100) != (int)(SDB_VERSION / 100))) - sdb_log(SDB_LOG_WARNING, "plugin: WARNING: version of " + if ((ctx->info.version < 0) + || ((int)(ctx->info.version / 100) != (int)(SDB_VERSION / 100))) + sdb_log(SDB_LOG_WARNING, "core: WARNING: version of " "plugin '%s' (%i.%i.%i) does not match our version " "(%i.%i.%i); this might cause problems", - name, SDB_VERSION_DECODE(info.version), + name, SDB_VERSION_DECODE(ctx->info.version), SDB_VERSION_DECODE(SDB_VERSION)); - sdb_log(SDB_LOG_INFO, "plugin: Successfully loaded " + sdb_log(SDB_LOG_INFO, "core: Successfully loaded " "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)); + INFO_GET(&ctx->info, name), ctx->info.plugin_version, + INFO_GET(&ctx->info, description), + INFO_GET(&ctx->info, copyright), + INFO_GET(&ctx->info, license)); - sdb_plugin_info_clear(&info); /* any registered callbacks took ownership of the context */ sdb_object_deref(SDB_OBJ(ctx)); @@ -485,7 +558,7 @@ sdb_plugin_set_info(sdb_plugin_info_t *info, int type, ...) int sdb_plugin_register_config(const char *name, sdb_plugin_config_cb callback) { - return sdb_plugin_add_callback(&config_list, "init", name, + return plugin_add_callback(&config_list, "init", name, callback, NULL); } /* sdb_plugin_register_config */ @@ -493,7 +566,7 @@ int sdb_plugin_register_init(const char *name, sdb_plugin_init_cb callback, sdb_object_t *user_data) { - return sdb_plugin_add_callback(&init_list, "init", name, + return plugin_add_callback(&init_list, "init", name, callback, user_data); } /* sdb_plugin_register_init */ @@ -501,7 +574,7 @@ int sdb_plugin_register_shutdown(const char *name, sdb_plugin_shutdown_cb callback, sdb_object_t *user_data) { - return sdb_plugin_add_callback(&shutdown_list, "shutdown", name, + return plugin_add_callback(&shutdown_list, "shutdown", name, callback, user_data); } /* sdb_plugin_register_shutdown */ @@ -509,7 +582,7 @@ 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, + return plugin_add_callback(&log_list, "log", name, callback, user_data); } /* sdb_plugin_register_log */ @@ -517,7 +590,7 @@ 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, + return plugin_add_callback(&cname_list, "cname", name, callback, user_data); } /* sdb_plugin_register_cname */ @@ -553,14 +626,14 @@ sdb_plugin_register_collector(const char *name, sdb_plugin_collector_cb callback if (! (SDB_PLUGIN_CCB(obj)->ccb_next_update = sdb_gettime())) { char errbuf[1024]; - sdb_log(SDB_LOG_ERR, "plugin: Failed to determine current " + sdb_log(SDB_LOG_ERR, "core: Failed to determine current " "time: %s", sdb_strerror(errno, errbuf, sizeof(errbuf))); sdb_object_deref(obj); return -1; } if (sdb_llist_insert_sorted(collector_list, obj, - sdb_plugin_cmp_next_update)) { + plugin_cmp_next_update)) { sdb_object_deref(obj); return -1; } @@ -568,7 +641,7 @@ sdb_plugin_register_collector(const char *name, sdb_plugin_collector_cb callback /* pass control to the list */ sdb_object_deref(obj); - sdb_log(SDB_LOG_INFO, "plugin: Registered collector callback '%s' " + sdb_log(SDB_LOG_INFO, "core: Registered collector callback '%s' " "(interval = %.3fs).", name, SDB_TIME_TO_DOUBLE(SDB_PLUGIN_CCB(obj)->ccb_interval)); return 0; @@ -581,7 +654,7 @@ sdb_plugin_get_ctx(void) c = ctx_get(); if (! c) { - sdb_plugin_log(SDB_LOG_ERR, "plugin: Invalid read access to plugin " + sdb_plugin_log(SDB_LOG_ERR, "core: Invalid read access to plugin " "context outside a plugin"); return plugin_default_ctx; } @@ -595,7 +668,7 @@ sdb_plugin_set_ctx(sdb_plugin_ctx_t ctx, sdb_plugin_ctx_t *old) c = ctx_get(); if (! c) { - sdb_plugin_log(SDB_LOG_ERR, "plugin: Invalid write access to plugin " + sdb_plugin_log(SDB_LOG_ERR, "core: Invalid write access to plugin " "context outside a plugin"); return -1; } @@ -622,7 +695,7 @@ sdb_plugin_configure(const char *name, oconfig_item_t *ci) 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 " + sdb_log(SDB_LOG_ERR, "core: Plugin '%s' did not register " "a config callback.", name); errno = ENOENT; return -1; @@ -639,32 +712,38 @@ int sdb_plugin_init_all(void) { sdb_llist_iter_t *iter; + int ret = 0; iter = sdb_llist_get_iter(init_list); while (sdb_llist_iter_has_next(iter)) { + sdb_plugin_cb_t *cb; sdb_plugin_init_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_CB(obj)->cb_callback; + callback = cb->cb_callback; - old_ctx = ctx_set(SDB_PLUGIN_CB(obj)->cb_ctx); - if (callback(SDB_PLUGIN_CB(obj)->cb_user_data)) { - /* XXX: unload plugin */ + old_ctx = ctx_set(cb->cb_ctx); + if (callback(cb->cb_user_data)) { + sdb_log(SDB_LOG_ERR, "core: Failed to initialize plugin " + "'%s'. Unregistering all callbacks.", obj->name); + plugin_unregister_by_name(cb->cb_ctx->info.plugin_name); + ++ret; } ctx_set(old_ctx); } sdb_llist_iter_destroy(iter); - return 0; + return ret; } /* sdb_plugin_init_all */ int sdb_plugin_collector_loop(sdb_plugin_loop_t *loop) { if (! collector_list) { - sdb_log(SDB_LOG_WARNING, "plugin: No collectors registered. " + sdb_log(SDB_LOG_WARNING, "core: No collectors registered. " "Quiting main loop."); return -1; } @@ -686,8 +765,9 @@ sdb_plugin_collector_loop(sdb_plugin_loop_t *loop) if (! (now = sdb_gettime())) { char errbuf[1024]; - sdb_log(SDB_LOG_ERR, "plugin: Failed to determine current " - "time: %s", sdb_strerror(errno, errbuf, sizeof(errbuf))); + sdb_log(SDB_LOG_ERR, "core: Failed to determine current " + "time in collector main loop: %s", + sdb_strerror(errno, errbuf, sizeof(errbuf))); now = SDB_PLUGIN_CCB(obj)->ccb_next_update; } @@ -698,7 +778,8 @@ sdb_plugin_collector_loop(sdb_plugin_loop_t *loop) while (loop->do_loop && sdb_sleep(interval, &interval)) { if (errno != EINTR) { char errbuf[1024]; - sdb_log(SDB_LOG_ERR, "plugin: Failed to sleep: %s", + sdb_log(SDB_LOG_ERR, "core: Failed to sleep " + "in collector main loop: %s", sdb_strerror(errno, errbuf, sizeof(errbuf))); return -1; } @@ -719,7 +800,7 @@ sdb_plugin_collector_loop(sdb_plugin_loop_t *loop) if (! interval) interval = loop->default_interval; if (! interval) { - sdb_log(SDB_LOG_WARNING, "plugin: No interval configured " + sdb_log(SDB_LOG_WARNING, "core: No interval configured " "for plugin '%s'; skipping any further " "iterations.", obj->name); sdb_object_deref(obj); @@ -730,21 +811,22 @@ sdb_plugin_collector_loop(sdb_plugin_loop_t *loop) if (! (now = sdb_gettime())) { char errbuf[1024]; - sdb_log(SDB_LOG_ERR, "plugin: Failed to determine current " - "time: %s", sdb_strerror(errno, errbuf, sizeof(errbuf))); + sdb_log(SDB_LOG_ERR, "core: Failed to determine current " + "time in collector main loop: %s", + sdb_strerror(errno, errbuf, sizeof(errbuf))); now = SDB_PLUGIN_CCB(obj)->ccb_next_update; } if (now > SDB_PLUGIN_CCB(obj)->ccb_next_update) { - sdb_log(SDB_LOG_WARNING, "plugin: Plugin '%s' took too " + sdb_log(SDB_LOG_WARNING, "core: Plugin '%s' took too " "long; skipping iterations to keep up.", obj->name); SDB_PLUGIN_CCB(obj)->ccb_next_update = now; } if (sdb_llist_insert_sorted(collector_list, obj, - sdb_plugin_cmp_next_update)) { - sdb_log(SDB_LOG_ERR, "plugin: Failed to re-insert " + plugin_cmp_next_update)) { + sdb_log(SDB_LOG_ERR, "core: Failed to re-insert " "plugin '%s' into collector list. Unable to further " "use the plugin.", obj->name);