2 * collectd - src/configfile.c
3 * Copyright (C) 2005-2008 Florian octo Forster
5 * This program is free software; you can redistribute it and/or modify it
6 * under the terms of the GNU General Public License as published by the
7 * Free Software Foundation; either version 2 of the License, or (at your
8 * option) any later version.
10 * This program is distributed in the hope that it will be useful, but
11 * WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13 * General Public License for more details.
15 * You should have received a copy of the GNU General Public License along
16 * with this program; if not, write to the Free Software Foundation, Inc.,
17 * 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
20 * Florian octo Forster <octo at verplant.org>
25 #include "liboconfig/oconfig.h"
29 #include "configfile.h"
30 #include "utils_threshold.h"
32 #define ESCAPE_NULL(str) ((str) == NULL ? "(null)" : (str))
37 typedef struct cf_callback
40 int (*callback) (const char *, const char *);
43 struct cf_callback *next;
46 typedef struct cf_complex_callback_s
49 int (*callback) (oconfig_item_t *);
50 struct cf_complex_callback_s *next;
51 } cf_complex_callback_t;
53 typedef struct cf_value_map_s
56 int (*func) (const oconfig_item_t *);
59 typedef struct cf_global_option_s
67 * Prototypes of callback functions
69 static int dispatch_value_plugindir (const oconfig_item_t *ci);
70 static int dispatch_value_loadplugin (const oconfig_item_t *ci);
75 static cf_callback_t *first_callback = NULL;
76 static cf_complex_callback_t *complex_callback_head = NULL;
78 static cf_value_map_t cf_value_map[] =
80 {"PluginDir", dispatch_value_plugindir},
81 {"LoadPlugin", dispatch_value_loadplugin}
83 static int cf_value_map_num = STATIC_ARRAY_LEN (cf_value_map);
85 static cf_global_option_t cf_global_options[] =
87 {"BaseDir", NULL, PKGLOCALSTATEDIR},
88 {"PIDFile", NULL, PIDFILE},
89 {"Hostname", NULL, NULL},
90 {"FQDNLookup", NULL, "false"},
91 {"Interval", NULL, "10"},
92 {"ReadThreads", NULL, "5"},
93 {"TypesDB", NULL, PLUGINDIR"/types.db"} /* FIXME: Configure path */
95 static int cf_global_options_num = STATIC_ARRAY_LEN (cf_global_options);
98 * Functions to handle register/unregister, search, and other plugin related
101 static cf_callback_t *cf_search (const char *type)
103 cf_callback_t *cf_cb;
108 for (cf_cb = first_callback; cf_cb != NULL; cf_cb = cf_cb->next)
109 if (strcasecmp (cf_cb->type, type) == 0)
115 static int cf_dispatch (const char *type, const char *orig_key,
116 const char *orig_value)
118 cf_callback_t *cf_cb;
124 DEBUG ("type = %s, key = %s, value = %s",
126 ESCAPE_NULL(orig_key),
127 ESCAPE_NULL(orig_value));
129 if ((cf_cb = cf_search (type)) == NULL)
131 WARNING ("Found a configuration for the `%s' plugin, but "
132 "the plugin isn't loaded or didn't register "
133 "a configuration callback.", type);
137 if ((key = strdup (orig_key)) == NULL)
139 if ((value = strdup (orig_value)) == NULL)
147 for (i = 0; i < cf_cb->keys_num; i++)
149 if (strcasecmp (cf_cb->keys[i], key) == 0)
151 ret = (*cf_cb->callback) (key, value);
156 if (i >= cf_cb->keys_num)
157 WARNING ("Plugin `%s' did not register for value `%s'.", type, key);
162 DEBUG ("return (%i)", ret);
165 } /* int cf_dispatch */
167 static int dispatch_global_option (const oconfig_item_t *ci)
169 if (ci->values_num != 1)
171 if (ci->values[0].type == OCONFIG_TYPE_STRING)
172 return (global_option_set (ci->key, ci->values[0].value.string));
173 else if (ci->values[0].type == OCONFIG_TYPE_NUMBER)
176 snprintf (tmp, sizeof (tmp), "%lf", ci->values[0].value.number);
178 return (global_option_set (ci->key, tmp));
180 else if (ci->values[0].type == OCONFIG_TYPE_BOOLEAN)
182 if (ci->values[0].value.boolean)
183 return (global_option_set (ci->key, "true"));
185 return (global_option_set (ci->key, "false"));
189 } /* int dispatch_global_option */
191 static int dispatch_value_plugindir (const oconfig_item_t *ci)
193 assert (strcasecmp (ci->key, "PluginDir") == 0);
195 if (ci->values_num != 1)
197 if (ci->values[0].type != OCONFIG_TYPE_STRING)
200 plugin_set_dir (ci->values[0].value.string);
204 static int dispatch_value_loadplugin (const oconfig_item_t *ci)
206 assert (strcasecmp (ci->key, "LoadPlugin") == 0);
208 if (ci->values_num != 1)
210 if (ci->values[0].type != OCONFIG_TYPE_STRING)
213 return (plugin_load (ci->values[0].value.string));
214 } /* int dispatch_value_loadplugin */
216 static int dispatch_value_plugin (const char *plugin, oconfig_item_t *ci)
224 buffer_free = sizeof (buffer);
226 for (i = 0; i < ci->values_num; i++)
230 if (ci->values[i].type == OCONFIG_TYPE_STRING)
231 status = snprintf (buffer_ptr, buffer_free, " %s",
232 ci->values[i].value.string);
233 else if (ci->values[i].type == OCONFIG_TYPE_NUMBER)
234 status = snprintf (buffer_ptr, buffer_free, " %lf",
235 ci->values[i].value.number);
236 else if (ci->values[i].type == OCONFIG_TYPE_BOOLEAN)
237 status = snprintf (buffer_ptr, buffer_free, " %s",
238 ci->values[i].value.boolean
241 if ((status < 0) || (status >= buffer_free))
243 buffer_free -= status;
244 buffer_ptr += status;
246 /* skip the initial space */
247 buffer_ptr = buffer + 1;
249 return (cf_dispatch (plugin, ci->key, buffer_ptr));
250 } /* int plugin_conf_dispatch */
252 static int dispatch_value (const oconfig_item_t *ci)
257 for (i = 0; i < cf_value_map_num; i++)
258 if (strcasecmp (cf_value_map[i].key, ci->key) == 0)
260 ret = cf_value_map[i].func (ci);
264 for (i = 0; i < cf_global_options_num; i++)
265 if (strcasecmp (cf_global_options[i].key, ci->key) == 0)
267 ret = dispatch_global_option (ci);
272 } /* int dispatch_value */
274 static int dispatch_block_plugin (oconfig_item_t *ci)
279 cf_complex_callback_t *cb;
281 if (strcasecmp (ci->key, "Plugin") != 0)
283 if (ci->values_num < 1)
285 if (ci->values[0].type != OCONFIG_TYPE_STRING)
288 name = ci->values[0].value.string;
290 /* Check for a complex callback first */
291 for (cb = complex_callback_head; cb != NULL; cb = cb->next)
292 if (strcasecmp (name, cb->type) == 0)
293 return (cb->callback (ci));
295 /* Hm, no complex plugin found. Dispatch the values one by one */
296 for (i = 0; i < ci->children_num; i++)
298 if (ci->children[i].children == NULL)
299 dispatch_value_plugin (name, ci->children + i);
301 {DEBUG ("No nested config blocks allow for this plugin.");}
308 static int dispatch_block (oconfig_item_t *ci)
310 if (strcasecmp (ci->key, "Plugin") == 0)
311 return (dispatch_block_plugin (ci));
312 else if (strcasecmp (ci->key, "Threshold") == 0)
313 return (ut_config (ci));
318 #define CF_MAX_DEPTH 8
319 static oconfig_item_t *cf_read_file (const char *file, int depth);
321 static int cf_include_all (oconfig_item_t *root, int depth)
325 for (i = 0; i < root->children_num; i++)
330 /* Ignore all blocks, including `Include' blocks. */
331 if (root->children[i].children_num != 0)
334 if (strcasecmp (root->children[i].key, "Include") != 0)
337 old = root->children + i;
339 if ((old->values_num != 1)
340 || (old->values[0].type != OCONFIG_TYPE_STRING))
342 ERROR ("configfile: `Include' needs exactly one string argument.");
346 new = cf_read_file (old->values[0].value.string, depth + 1);
350 /* There are more children now. We need to expand
352 if (new->children_num > 1)
354 oconfig_item_t *temp;
356 DEBUG ("configfile: Resizing root-children from %i to %i elements.",
358 root->children_num + new->children_num - 1);
360 temp = (oconfig_item_t *) realloc (root->children,
361 sizeof (oconfig_item_t)
362 * (root->children_num + new->children_num - 1));
365 ERROR ("configfile: realloc failed.");
369 root->children = temp;
372 /* Clean up the old include directive while we still have a
374 DEBUG ("configfile: Cleaning up `old'");
375 /* sfree (old->values[0].value.string); */
378 /* If there are trailing children and the number of children
379 * changes, we need to move the trailing ones either one to the
380 * front or (new->num - 1) to the back */
381 if (((root->children_num - i) > 1)
382 && (new->children_num != 1))
384 DEBUG ("configfile: Moving trailing children.");
385 memmove (root->children + i + new->children_num,
386 root->children + i + 1,
387 sizeof (oconfig_item_t)
388 * (root->children_num - (i + 1)));
391 /* Now copy the new children to where the include statement was */
392 if (new->children_num > 0)
394 DEBUG ("configfile: Copying new children.");
395 memcpy (root->children + i,
397 sizeof (oconfig_item_t)
398 * new->children_num);
401 /* Adjust the number of children and the position in the list. */
402 root->children_num = root->children_num + new->children_num - 1;
403 i = i + new->children_num - 1;
405 /* Clean up the `new' struct. We set `new->children' to NULL so
406 * the stuff we've just copied pointers to isn't freed by
408 DEBUG ("configfile: Cleaning up `new'");
409 sfree (new->values); /* should be NULL anyway */
412 } /* for (i = 0; i < root->children_num; i++) */
415 } /* int cf_include_all */
417 static oconfig_item_t *cf_read_file (const char *file, int depth)
419 oconfig_item_t *root;
421 if (depth >= CF_MAX_DEPTH)
423 ERROR ("configfile: Not including `%s' because the maximum nesting depth has been reached.",
428 root = oconfig_parse_file (file);
431 ERROR ("configfile: Cannot read file `%s'.", file);
435 cf_include_all (root, depth);
438 } /* oconfig_item_t *cf_read_file */
443 int global_option_set (const char *option, const char *value)
447 DEBUG ("option = %s; value = %s;", option, value);
449 for (i = 0; i < cf_global_options_num; i++)
450 if (strcasecmp (cf_global_options[i].key, option) == 0)
453 if (i >= cf_global_options_num)
456 sfree (cf_global_options[i].value);
459 cf_global_options[i].value = strdup (value);
461 cf_global_options[i].value = NULL;
466 const char *global_option_get (const char *option)
470 for (i = 0; i < cf_global_options_num; i++)
471 if (strcasecmp (cf_global_options[i].key, option) == 0)
474 if (i >= cf_global_options_num)
477 return ((cf_global_options[i].value != NULL)
478 ? cf_global_options[i].value
479 : cf_global_options[i].def);
480 } /* char *global_option_get */
482 void cf_unregister (const char *type)
484 cf_callback_t *this, *prev;
486 for (prev = NULL, this = first_callback;
488 prev = this, this = this->next)
489 if (strcasecmp (this->type, type) == 0)
492 first_callback = this->next;
494 prev->next = this->next;
499 } /* void cf_unregister */
501 void cf_unregister_complex (const char *type)
503 cf_complex_callback_t *this, *prev;
505 for (prev = NULL, this = complex_callback_head;
507 prev = this, this = this->next)
508 if (strcasecmp (this->type, type) == 0)
511 complex_callback_head = this->next;
513 prev->next = this->next;
519 } /* void cf_unregister */
521 void cf_register (const char *type,
522 int (*callback) (const char *, const char *),
523 const char **keys, int keys_num)
525 cf_callback_t *cf_cb;
527 /* Remove this module from the list, if it already exists */
528 cf_unregister (type);
530 /* This pointer will be free'd in `cf_unregister' */
531 if ((cf_cb = (cf_callback_t *) malloc (sizeof (cf_callback_t))) == NULL)
535 cf_cb->callback = callback;
537 cf_cb->keys_num = keys_num;
539 cf_cb->next = first_callback;
540 first_callback = cf_cb;
541 } /* void cf_register */
543 int cf_register_complex (const char *type, int (*callback) (oconfig_item_t *))
545 cf_complex_callback_t *new;
547 new = (cf_complex_callback_t *) malloc (sizeof (cf_complex_callback_t));
551 new->type = strdup (type);
552 if (new->type == NULL)
558 new->callback = callback;
561 if (complex_callback_head == NULL)
563 complex_callback_head = new;
567 cf_complex_callback_t *last = complex_callback_head;
568 while (last->next != NULL)
574 } /* int cf_register_complex */
576 int cf_read (char *filename)
578 oconfig_item_t *conf;
581 conf = cf_read_file (filename, 0 /* depth */);
584 ERROR ("Unable to read config file %s.", filename);
588 for (i = 0; i < conf->children_num; i++)
590 if (conf->children[i].children == NULL)
591 dispatch_value (conf->children + i);
593 dispatch_block (conf->children + i);