/**
* collectd - src/configfile.c
- * Copyright (C) 2005 Florian octo Forster
+ * Copyright (C) 2005,2006 Florian octo Forster
*
* This program is free software; you can redistribute it and/or modify it
* under the terms of the GNU General Public License as published by the
#include "collectd.h"
-#include "libconfig/libconfig.h"
+#include "liboconfig/oconfig.h"
+#include "common.h"
#include "plugin.h"
#include "configfile.h"
-#include "utils_debug.h"
-#define SHORTOPT_NONE 0
-
-#define ERR_NOT_NESTED "Sections cannot be nested.\n"
-#define ERR_SECTION_ONLY "`%s' can only be used as section.\n"
-#define ERR_NEEDS_ARG "Section `%s' needs an argument.\n"
-#define ERR_NEEDS_SECTION "`%s' can only be used within a section.\n"
-
-#ifdef HAVE_LIBRRD
-extern int operating_mode;
-#else
-static int operating_mode = MODE_CLIENT;
-#endif
+#define ESCAPE_NULL(str) ((str) == NULL ? "(null)" : (str))
+/*
+ * Private types
+ */
typedef struct cf_callback
{
- char *type;
- int (*callback) (char *, char *);
- char **keys;
+ const char *type;
+ int (*callback) (const char *, const char *);
+ const char **keys;
int keys_num;
struct cf_callback *next;
} cf_callback_t;
-static cf_callback_t *first_callback = NULL;
+typedef struct cf_value_map_s
+{
+ char *key;
+ int (*func) (const oconfig_item_t *);
+} cf_value_map_t;
-typedef struct cf_mode_item
+typedef struct cf_global_option_s
{
char *key;
char *value;
- int mode;
-} cf_mode_item_t;
+ char *def;
+} cf_global_option_t;
+
+/*
+ * Prototypes of callback functions
+ */
+static int dispatch_value_plugindir (const oconfig_item_t *ci);
+static int dispatch_value_loadplugin (const oconfig_item_t *ci);
+
+/*
+ * Private variables
+ */
+static cf_callback_t *first_callback = NULL;
-static cf_mode_item_t cf_mode_list[] =
+static cf_value_map_t cf_value_map[] =
{
- {"Server", NULL, MODE_CLIENT },
- {"Port", NULL, MODE_CLIENT | MODE_SERVER },
- {"PIDFile", PIDFILE, MODE_CLIENT | MODE_SERVER | MODE_LOCAL},
- {"DataDir", PKGLOCALSTATEDIR, MODE_SERVER | MODE_LOCAL}
+ {"PluginDir", dispatch_value_plugindir},
+ {"LoadPlugin", dispatch_value_loadplugin}
};
-static int cf_mode_num = 4;
+static int cf_value_map_num = STATIC_ARRAY_LEN (cf_value_map);
-static int nesting_depth = 0;
-static char *current_module = NULL;
-
-/* `cf_register' needs this prototype */
-int cf_callback_plugin_dispatch (const char *, const char *, const char *,
- const char *, lc_flags_t, void *);
+static cf_global_option_t cf_global_options[] =
+{
+ {"BaseDir", NULL, PKGLOCALSTATEDIR},
+ {"PIDFile", NULL, PIDFILE},
+ {"Hostname", NULL, NULL},
+ {"Interval", NULL, "10"},
+ {"ReadThreads", NULL, "5"},
+ {"TypesDB", NULL, PLUGINDIR"/types.db"} /* FIXME: Configure path */
+};
+static int cf_global_options_num = STATIC_ARRAY_LEN (cf_global_options);
/*
* Functions to handle register/unregister, search, and other plugin related
* stuff
*/
-cf_callback_t *cf_search (char *type)
+static cf_callback_t *cf_search (const char *type)
{
cf_callback_t *cf_cb;
return (cf_cb);
}
-int cf_dispatch (char *type, const char *orig_key, const char *orig_value)
+static int cf_dispatch (const char *type, const char *orig_key,
+ const char *orig_value)
{
cf_callback_t *cf_cb;
char *key;
int ret;
int i;
- DBG ("type = %s, key = %s, value = %s", type, orig_key, orig_value);
+ DEBUG ("type = %s, key = %s, value = %s",
+ ESCAPE_NULL(type),
+ ESCAPE_NULL(orig_key),
+ ESCAPE_NULL(orig_value));
if ((cf_cb = cf_search (type)) == NULL)
{
- syslog (LOG_WARNING, "Plugin `%s' did not register a callback.\n", type);
+ WARNING ("Plugin `%s' did not register a callback.", type);
return (-1);
}
}
if (i >= cf_cb->keys_num)
- syslog (LOG_WARNING, "Plugin `%s' did not register for value `%s'.\n", type, key);
+ WARNING ("Plugin `%s' did not register for value `%s'.", type, key);
free (key);
free (value);
+ DEBUG ("return (%i)", ret);
+
return (ret);
-}
+} /* int cf_dispatch */
-void cf_unregister (char *type)
+static int dispatch_global_option (const oconfig_item_t *ci)
{
- cf_callback_t *this, *prev;
-
- for (prev = NULL, this = first_callback;
- this != NULL;
- prev = this, this = this->next)
- if (strcasecmp (this->type, type) == 0)
- {
- if (prev == NULL)
- first_callback = this->next;
- else
- prev->next = this->next;
+ if (ci->values_num != 1)
+ return (-1);
+ if (ci->values[0].type == OCONFIG_TYPE_STRING)
+ return (global_option_set (ci->key, ci->values[0].value.string));
+ else if (ci->values[0].type == OCONFIG_TYPE_NUMBER)
+ {
+ char tmp[128];
+ snprintf (tmp, sizeof (tmp), "%lf", ci->values[0].value.number);
+ tmp[127] = '\0';
+ return (global_option_set (ci->key, tmp));
+ }
- free (this);
- break;
- }
-}
+ return (-1);
+} /* int dispatch_global_option */
-void cf_register (char *type,
- int (*callback) (char *, char *),
- char **keys, int keys_num)
+static int dispatch_value_plugindir (const oconfig_item_t *ci)
{
- cf_callback_t *cf_cb;
- char buf[64];
- int i;
-
- /* Remove this module from the list, if it already exists */
- cf_unregister (type);
+ assert (strcasecmp (ci->key, "PluginDir") == 0);
+
+ if (ci->values_num != 1)
+ return (-1);
+ if (ci->values[0].type != OCONFIG_TYPE_STRING)
+ return (-1);
- /* This pointer will be free'd in `cf_unregister' */
- if ((cf_cb = (cf_callback_t *) malloc (sizeof (cf_callback_t))) == NULL)
- return;
+ plugin_set_dir (ci->values[0].value.string);
+ return (0);
+}
- cf_cb->type = type;
- cf_cb->callback = callback;
- cf_cb->keys = keys;
- cf_cb->keys_num = keys_num;
+static int dispatch_value_loadplugin (const oconfig_item_t *ci)
+{
+ assert (strcasecmp (ci->key, "LoadPlugin") == 0);
- cf_cb->next = first_callback;
- first_callback = cf_cb;
+ if (ci->values_num != 1)
+ return (-1);
+ if (ci->values[0].type != OCONFIG_TYPE_STRING)
+ return (-1);
- for (i = 0; i < keys_num; i++)
- {
- if (snprintf (buf, 64, "Plugin.%s", keys[i]) < 64)
- {
- /* This may be called multiple times for the same
- * `key', but apparently `lc_register_*' can handle
- * it.. */
- lc_register_callback (buf, SHORTOPT_NONE,
- LC_VAR_STRING, cf_callback_plugin_dispatch,
- NULL);
- }
- else
- {
- DBG ("Key was truncated: `%s'", keys[i]);
- }
- }
-}
+ return (plugin_load (ci->values[0].value.string));
+} /* int dispatch_value_loadplugin */
-/*
- * Other query functions
- */
-char *cf_get_mode_option (const char *key)
+static int dispatch_value_plugin (const char *plugin, oconfig_item_t *ci)
{
+ char buffer[4096];
+ char *buffer_ptr;
+ int buffer_free;
int i;
- for (i = 0; i < cf_mode_num; i++)
- {
- if ((cf_mode_list[i].mode & operating_mode) == 0)
- continue;
+ buffer_ptr = buffer;
+ buffer_free = sizeof (buffer);
- if (strcasecmp (cf_mode_list[i].key, key) == 0)
- return (cf_mode_list[i].value);
+ for (i = 0; i < ci->values_num; i++)
+ {
+ int status = -1;
+
+ if (ci->values[i].type == OCONFIG_TYPE_STRING)
+ status = snprintf (buffer_ptr, buffer_free, " %s",
+ ci->values[i].value.string);
+ else if (ci->values[i].type == OCONFIG_TYPE_NUMBER)
+ status = snprintf (buffer_ptr, buffer_free, " %lf",
+ ci->values[i].value.number);
+ else if (ci->values[i].type == OCONFIG_TYPE_BOOLEAN)
+ status = snprintf (buffer_ptr, buffer_free, " %s",
+ ci->values[i].value.boolean
+ ? "true" : "false");
+
+ if ((status < 0) || (status >= buffer_free))
+ return (-1);
+ buffer_free -= status;
+ buffer_ptr += status;
}
+ /* skip the initial space */
+ buffer_ptr = buffer + 1;
- return (NULL);
-}
+ return (cf_dispatch (plugin, ci->key, buffer_ptr));
+} /* int plugin_conf_dispatch */
-int cf_callback_usage (const char *shortvar, const char *var,
- const char *arguments, const char *value, lc_flags_t flags,
- void *extra)
+static int dispatch_value (const oconfig_item_t *ci)
{
- DBG ("shortvar = %s, var = %s, arguments = %s, value = %s, ...",
- shortvar, var, arguments, value);
-
- printf ("Usage: "PACKAGE" [OPTIONS]\n\n"
-
- "Available options:\n"
-#if COLLECT_DAEMON
- " -P <file> PID file.\n"
- " Default: "PIDFILE"\n"
-#endif
- " -M <dir> Module/Plugin directory.\n"
- " Default: "PLUGINDIR"\n"
- " -D <dir> Data storage directory.\n"
- " Default: "PKGLOCALSTATEDIR"\n"
-#if COLLECT_DEBUG
- " -L <file> Log file.\n"
- " Default: "LOGFILE"\n"
-#endif
-#if COLLECT_DAEMON
- " -f Don't fork to the background.\n"
-#endif
-#if HAVE_LIBRRD
- " -l Start in local mode (no network).\n"
- " -c Start in client (sender) mode.\n"
- " -s Start in server (listener) mode.\n"
-#endif /* HAVE_LIBRRD */
-#if COLLECT_PING
- " Ping:\n"
- " -p <host> Host to ping periodically, may be repeated to ping\n"
- " more than one host.\n"
-#endif /* COLLECT_PING */
- "\n"PACKAGE" "VERSION", http://verplant.org/collectd/\n"
- "by Florian octo Forster <octo@verplant.org>\n"
- "for contributions see `AUTHORS'\n");
- exit (0);
-} /* exit_usage */
-
-/* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *
- * Functions for the actual parsing *
- * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
-
-/*
- * `cf_callback_mode'
- * Start/end the `mode' section
- *
- * <Mode `arguments'>
- * ...
- * </Mode>
- */
-int cf_callback_mode (const char *shortvar, const char *var,
- const char *arguments, const char *value, lc_flags_t flags,
- void *extra)
-{
- DBG ("shortvar = %s, var = %s, arguments = %s, value = %s, ...",
- shortvar, var, arguments, value);
-
- if (flags == LC_FLAGS_SECTIONSTART)
- {
- if (nesting_depth != 0)
- {
- fprintf (stderr, ERR_NOT_NESTED);
- return (LC_CBRET_ERROR);
- }
+ int ret = -2;
+ int i;
- if (arguments == NULL)
+ for (i = 0; i < cf_value_map_num; i++)
+ if (strcasecmp (cf_value_map[i].key, ci->key) == 0)
{
- fprintf (stderr, ERR_NEEDS_ARG, shortvar);
- return (LC_CBRET_ERROR);
+ ret = cf_value_map[i].func (ci);
+ break;
}
- nesting_depth++;
-
- if (((operating_mode == MODE_CLIENT)
- && (strcasecmp (arguments, "Client") == 0))
- || ((operating_mode == MODE_SERVER)
- && (strcasecmp (arguments, "Server") == 0))
- || ((operating_mode == MODE_LOCAL)
- && (strcasecmp (arguments, "Local") == 0)))
- {
- return (LC_CBRET_OKAY);
- }
- else
+ for (i = 0; i < cf_global_options_num; i++)
+ if (strcasecmp (cf_global_options[i].key, ci->key) == 0)
{
- return (LC_CBRET_IGNORESECTION);
+ ret = dispatch_global_option (ci);
+ break;
}
- }
- else if (flags == LC_FLAGS_SECTIONEND)
- {
- nesting_depth--;
-
- return (LC_CBRET_OKAY);
- }
- else
- {
- fprintf (stderr, ERR_SECTION_ONLY, shortvar);
- return (LC_CBRET_ERROR);
- }
-
-}
-/*
- * `cf_callback_mode_plugindir'
- * Change the plugin directory
- *
- * <Mode xxx>
- * PluginDir `value'
- * </Mode>
- */
-int cf_callback_mode_plugindir (const char *shortvar, const char *var,
- const char *arguments, const char *value, lc_flags_t flags,
- void *extra)
-{
- DBG ("shortvar = %s, var = %s, arguments = %s, value = %s, ...",
- shortvar, var, arguments, value);
-
- plugin_set_dir (value);
-
- return (LC_CBRET_OKAY);
-}
+ return (ret);
+} /* int dispatch_value */
-int cf_callback_mode_option (const char *shortvar, const char *var,
- const char *arguments, const char *value, lc_flags_t flags,
- void *extra)
+static int dispatch_block_plugin (oconfig_item_t *ci)
{
- cf_mode_item_t *item;
-
- DBG ("shortvar = %s, var = %s, arguments = %s, value = %s, ...",
- shortvar, var, arguments, value);
-
- if (extra == NULL)
- {
- fprintf (stderr, "No extra..?\n");
- return (LC_CBRET_ERROR);
- }
-
- item = (cf_mode_item_t *) extra;
-
- if (strcasecmp (item->key, shortvar))
- {
- fprintf (stderr, "Wrong extra..\n");
- return (LC_CBRET_ERROR);
- }
+ int i;
+ char *name;
- if ((operating_mode & item->mode) == 0)
- {
- fprintf (stderr, "Option `%s' is not valid in this mode!\n", shortvar);
- return (LC_CBRET_ERROR);
- }
+ if (strcasecmp (ci->key, "Plugin") != 0)
+ return (-1);
+ if (ci->values_num != 1)
+ return (-1);
+ if (ci->values[0].type != OCONFIG_TYPE_STRING)
+ return (-1);
- if (item->value != NULL)
- {
- free (item->value);
- item->value = NULL;
- }
+ name = ci->values[0].value.string;
- if ((item->value = strdup (value)) == NULL)
+ for (i = 0; i < ci->children_num; i++)
{
- perror ("strdup");
- return (LC_CBRET_ERROR);
+ if (ci->children[i].children == NULL)
+ dispatch_value_plugin (name, ci->children + i);
+ else
+ {DEBUG ("No nested config blocks allow for plugins. Yet.");}
}
- return (LC_CBRET_OKAY);
+ return (0);
}
-/*
- * `cf_callback_mode_loadmodule':
- * Load a plugin.
- *
- * <Mode xxx>
- * LoadPlugin `value'
- * </Mode>
- */
-int cf_callback_mode_loadmodule (const char *shortvar, const char *var,
- const char *arguments, const char *value, lc_flags_t flags,
- void *extra)
-{
- DBG ("shortvar = %s, var = %s, arguments = %s, value = %s, ...",
- shortvar, var, arguments, value);
-
- if (nesting_depth == 0)
- {
- fprintf (stderr, ERR_NEEDS_SECTION, shortvar);
- return (LC_CBRET_ERROR);
- }
-
- if (plugin_load (value))
- syslog (LOG_ERR, "plugin_load (%s): failed to load plugin", value);
-
- /* Return `okay' even if there was an error, because it's not a syntax
- * problem.. */
- return (LC_CBRET_OKAY);
-}
-/* XXX think about how to do the command line stuff */
-int cf_callback_mode_switch (const char *shortvar, const char *var,
- const char *arguments, const char *value, lc_flags_t flags,
- void *extra)
+static int dispatch_block (oconfig_item_t *ci)
{
- DBG ("shortvar = %s, var = %s, arguments = %s, value = %s, ...",
- shortvar, var, arguments, value);
-
- if (strcasecmp (shortvar, "Client") == 0)
- operating_mode = MODE_CLIENT;
- else if (strcasecmp (shortvar, "Local") == 0)
- operating_mode = MODE_LOCAL;
- else if (strcasecmp (shortvar, "Server") == 0)
- operating_mode = MODE_SERVER;
- else
- {
- fprintf (stderr, "cf_callback_mode_switch: Wrong mode!\n");
- return (LC_CBRET_ERROR);
- }
+ if (strcasecmp (ci->key, "Plugin") == 0)
+ return (dispatch_block_plugin (ci));
- return (LC_CBRET_OKAY);
+ return (0);
}
-/*
- * `cf_callback_plugin'
- * Start/end section `plugin'
- *
- * <Plugin `arguments'>
- * ...
- * </Plugin>
+/*
+ * Public functions
*/
-int cf_callback_plugin (const char *shortvar, const char *var,
- const char *arguments, const char *value, lc_flags_t flags,
- void *extra)
+int global_option_set (const char *option, const char *value)
{
- DBG ("shortvar = %s, var = %s, arguments = %s, value = %s, ...",
- shortvar, var, arguments, value);
-
- if (flags == LC_FLAGS_SECTIONSTART)
- {
- if (nesting_depth != 0)
- {
- fprintf (stderr, ERR_NOT_NESTED);
- return (LC_CBRET_ERROR);
- }
-
- if (arguments == NULL)
- {
- fprintf (stderr, ERR_NEEDS_ARG, shortvar);
- return (LC_CBRET_ERROR);
- }
+ int i;
- if ((current_module = strdup (arguments)) == NULL)
- {
- perror ("strdup");
- return (LC_CBRET_ERROR);
- }
+ DEBUG ("option = %s; value = %s;", option, value);
- nesting_depth++;
+ for (i = 0; i < cf_global_options_num; i++)
+ if (strcasecmp (cf_global_options[i].key, option) == 0)
+ break;
- if (cf_search (current_module) != NULL)
- return (LC_CBRET_OKAY);
- else
- return (LC_CBRET_IGNORESECTION);
- }
- else if (flags == LC_FLAGS_SECTIONEND)
- {
- if (current_module != NULL)
- {
- free (current_module);
- current_module = NULL;
- }
+ if (i >= cf_global_options_num)
+ return (-1);
- nesting_depth--;
+ sfree (cf_global_options[i].value);
- return (LC_CBRET_OKAY);
- }
+ if (value != NULL)
+ cf_global_options[i].value = strdup (value);
else
- {
- fprintf (stderr, ERR_SECTION_ONLY, shortvar);
- return (LC_CBRET_ERROR);
- }
-}
-
-/*
- * `cf_callback_plugin_dispatch'
- * Send options within `plugin' sections to the plugin that requests it.
- *
- * <Plugin `current_module'>
- * `var' `value'
- * </Plugin>
- */
-int cf_callback_plugin_dispatch (const char *shortvar, const char *var,
- const char *arguments, const char *value, lc_flags_t flags,
- void *extra)
-{
- DBG ("shortvar = %s, var = %s, arguments = %s, value = %s, ...",
- shortvar, var, arguments, value);
+ cf_global_options[i].value = NULL;
- if ((nesting_depth == 0) || (current_module == NULL))
- {
- fprintf (stderr, ERR_NEEDS_SECTION, shortvar);
- return (LC_CBRET_ERROR);
- }
-
- /* Send the data to the plugin */
- if (cf_dispatch (current_module, shortvar, value) < 0)
- return (LC_CBRET_ERROR);
-
- return (LC_CBRET_OKAY);
+ return (0);
}
-void cf_init (void)
+const char *global_option_get (const char *option)
{
- static int run_once = 0;
int i;
- if (run_once != 0)
- return;
- run_once = 1;
+ for (i = 0; i < cf_global_options_num; i++)
+ if (strcasecmp (cf_global_options[i].key, option) == 0)
+ break;
- lc_register_callback ("Help", 'h', LC_VAR_NONE,
- cf_callback_usage, NULL);
+ if (i >= cf_global_options_num)
+ return (NULL);
+
+ return ((cf_global_options[i].value != NULL)
+ ? cf_global_options[i].value
+ : cf_global_options[i].def);
+} /* char *global_option_get */
- lc_register_callback ("Client", 'c', LC_VAR_NONE,
- cf_callback_mode_switch, NULL);
- lc_register_callback ("Local", 'l', LC_VAR_NONE,
- cf_callback_mode_switch, NULL);
- lc_register_callback ("Server", 's', LC_VAR_NONE,
- cf_callback_mode_switch, NULL);
+void cf_unregister (const char *type)
+{
+ cf_callback_t *this, *prev;
+
+ for (prev = NULL, this = first_callback;
+ this != NULL;
+ prev = this, this = this->next)
+ if (strcasecmp (this->type, type) == 0)
+ {
+ if (prev == NULL)
+ first_callback = this->next;
+ else
+ prev->next = this->next;
- lc_register_callback ("Mode", SHORTOPT_NONE, LC_VAR_SECTION,
- cf_callback_mode, NULL);
- lc_register_callback ("Plugin", SHORTOPT_NONE, LC_VAR_SECTION,
- cf_callback_plugin, NULL);
+ free (this);
+ break;
+ }
+} /* void cf_unregister */
- lc_register_callback ("Mode.PluginDir", 'P',
- LC_VAR_STRING, cf_callback_mode_plugindir, NULL);
- lc_register_callback ("Mode.LoadPlugin", SHORTOPT_NONE,
- LC_VAR_STRING, cf_callback_mode_loadmodule, NULL);
+void cf_register (const char *type,
+ int (*callback) (const char *, const char *),
+ const char **keys, int keys_num)
+{
+ cf_callback_t *cf_cb;
- for (i = 0; i < cf_mode_num; i++)
- {
- char longvar[256];
- cf_mode_item_t *item;
+ /* Remove this module from the list, if it already exists */
+ cf_unregister (type);
- item = &cf_mode_list[i];
+ /* This pointer will be free'd in `cf_unregister' */
+ if ((cf_cb = (cf_callback_t *) malloc (sizeof (cf_callback_t))) == NULL)
+ return;
- if (snprintf (longvar, 256, "Mode.%s", item->key) >= 256)
- continue;
+ cf_cb->type = type;
+ cf_cb->callback = callback;
+ cf_cb->keys = keys;
+ cf_cb->keys_num = keys_num;
- lc_register_callback (longvar, SHORTOPT_NONE, LC_VAR_STRING,
- cf_callback_mode_option, (void *) item);
- }
-}
+ cf_cb->next = first_callback;
+ first_callback = cf_cb;
+} /* void cf_register */
-int cf_read (int argc, char **argv, char *filename)
+int cf_read (char *filename)
{
- cf_init ();
-
- if (filename == NULL)
- filename = CONFIGFILE;
+ oconfig_item_t *conf;
+ int i;
- if (lc_process (argc, argv, "collectd", LC_CONF_APACHE, filename))
+ conf = oconfig_parse_file (filename);
+ if (conf == NULL)
{
- syslog (LOG_ERR, "lc_process_file (%s): %s", filename, lc_geterrstr ());
+ ERROR ("Unable to read config file %s.", filename);
return (-1);
}
- /* free memory and stuff */
- lc_cleanup ();
+ for (i = 0; i < conf->children_num; i++)
+ {
+ if (conf->children[i].children == NULL)
+ dispatch_value (conf->children + i);
+ else
+ dispatch_block (conf->children + i);
+ }
return (0);
-}
+} /* int cf_read */
projects / collectd.git / blobdiff