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>
21 * Sebastian tokkee Harl <sh at tokkee.org>
26 #include "liboconfig/oconfig.h"
30 #include "configfile.h"
31 #include "types_list.h"
32 #include "utils_threshold.h"
36 #endif /* HAVE_WORDEXP_H */
38 #define ESCAPE_NULL(str) ((str) == NULL ? "(null)" : (str))
43 typedef struct cf_callback
46 int (*callback) (const char *, const char *);
49 struct cf_callback *next;
52 typedef struct cf_complex_callback_s
55 int (*callback) (oconfig_item_t *);
56 struct cf_complex_callback_s *next;
57 } cf_complex_callback_t;
59 typedef struct cf_value_map_s
62 int (*func) (const oconfig_item_t *);
65 typedef struct cf_global_option_s
73 * Prototypes of callback functions
75 static int dispatch_value_typesdb (const oconfig_item_t *ci);
76 static int dispatch_value_plugindir (const oconfig_item_t *ci);
77 static int dispatch_value_loadplugin (const oconfig_item_t *ci);
82 static cf_callback_t *first_callback = NULL;
83 static cf_complex_callback_t *complex_callback_head = NULL;
85 static cf_value_map_t cf_value_map[] =
87 {"TypesDB", dispatch_value_typesdb},
88 {"PluginDir", dispatch_value_plugindir},
89 {"LoadPlugin", dispatch_value_loadplugin}
91 static int cf_value_map_num = STATIC_ARRAY_LEN (cf_value_map);
93 static cf_global_option_t cf_global_options[] =
95 {"BaseDir", NULL, PKGLOCALSTATEDIR},
96 {"PIDFile", NULL, PIDFILE},
97 {"Hostname", NULL, NULL},
98 {"FQDNLookup", NULL, "false"},
99 {"Interval", NULL, "10"},
100 {"ReadThreads", NULL, "5"}
102 static int cf_global_options_num = STATIC_ARRAY_LEN (cf_global_options);
104 static int cf_default_typesdb = 1;
107 * Functions to handle register/unregister, search, and other plugin related
110 static cf_callback_t *cf_search (const char *type)
112 cf_callback_t *cf_cb;
117 for (cf_cb = first_callback; cf_cb != NULL; cf_cb = cf_cb->next)
118 if (strcasecmp (cf_cb->type, type) == 0)
124 static int cf_dispatch (const char *type, const char *orig_key,
125 const char *orig_value)
127 cf_callback_t *cf_cb;
133 DEBUG ("type = %s, key = %s, value = %s",
135 ESCAPE_NULL(orig_key),
136 ESCAPE_NULL(orig_value));
138 if ((cf_cb = cf_search (type)) == NULL)
140 WARNING ("Found a configuration for the `%s' plugin, but "
141 "the plugin isn't loaded or didn't register "
142 "a configuration callback.", type);
146 if ((key = strdup (orig_key)) == NULL)
148 if ((value = strdup (orig_value)) == NULL)
156 for (i = 0; i < cf_cb->keys_num; i++)
158 if (strcasecmp (cf_cb->keys[i], key) == 0)
160 ret = (*cf_cb->callback) (key, value);
165 if (i >= cf_cb->keys_num)
166 WARNING ("Plugin `%s' did not register for value `%s'.", type, key);
171 DEBUG ("return (%i)", ret);
174 } /* int cf_dispatch */
176 static int dispatch_global_option (const oconfig_item_t *ci)
178 if (ci->values_num != 1)
180 if (ci->values[0].type == OCONFIG_TYPE_STRING)
181 return (global_option_set (ci->key, ci->values[0].value.string));
182 else if (ci->values[0].type == OCONFIG_TYPE_NUMBER)
185 ssnprintf (tmp, sizeof (tmp), "%lf", ci->values[0].value.number);
186 return (global_option_set (ci->key, tmp));
188 else if (ci->values[0].type == OCONFIG_TYPE_BOOLEAN)
190 if (ci->values[0].value.boolean)
191 return (global_option_set (ci->key, "true"));
193 return (global_option_set (ci->key, "false"));
197 } /* int dispatch_global_option */
199 static int dispatch_value_typesdb (const oconfig_item_t *ci)
203 assert (strcasecmp (ci->key, "TypesDB") == 0);
205 cf_default_typesdb = 0;
207 if (ci->values_num < 1)
210 for (i = 0; i < ci->values_num; ++i)
212 if (OCONFIG_TYPE_STRING != ci->values[i].type)
215 read_types_list (ci->values[i].value.string);
218 } /* int dispatch_value_typesdb */
220 static int dispatch_value_plugindir (const oconfig_item_t *ci)
222 assert (strcasecmp (ci->key, "PluginDir") == 0);
224 if (ci->values_num != 1)
226 if (ci->values[0].type != OCONFIG_TYPE_STRING)
229 plugin_set_dir (ci->values[0].value.string);
233 static int dispatch_value_loadplugin (const oconfig_item_t *ci)
235 assert (strcasecmp (ci->key, "LoadPlugin") == 0);
237 if (ci->values_num != 1)
239 if (ci->values[0].type != OCONFIG_TYPE_STRING)
242 return (plugin_load (ci->values[0].value.string));
243 } /* int dispatch_value_loadplugin */
245 static int dispatch_value_plugin (const char *plugin, oconfig_item_t *ci)
253 buffer_free = sizeof (buffer);
255 for (i = 0; i < ci->values_num; i++)
259 if (ci->values[i].type == OCONFIG_TYPE_STRING)
260 status = ssnprintf (buffer_ptr, buffer_free, " %s",
261 ci->values[i].value.string);
262 else if (ci->values[i].type == OCONFIG_TYPE_NUMBER)
263 status = ssnprintf (buffer_ptr, buffer_free, " %lf",
264 ci->values[i].value.number);
265 else if (ci->values[i].type == OCONFIG_TYPE_BOOLEAN)
266 status = ssnprintf (buffer_ptr, buffer_free, " %s",
267 ci->values[i].value.boolean
270 if ((status < 0) || (status >= buffer_free))
272 buffer_free -= status;
273 buffer_ptr += status;
275 /* skip the initial space */
276 buffer_ptr = buffer + 1;
278 return (cf_dispatch (plugin, ci->key, buffer_ptr));
279 } /* int dispatch_value_plugin */
281 static int dispatch_value (const oconfig_item_t *ci)
286 for (i = 0; i < cf_value_map_num; i++)
287 if (strcasecmp (cf_value_map[i].key, ci->key) == 0)
289 ret = cf_value_map[i].func (ci);
293 for (i = 0; i < cf_global_options_num; i++)
294 if (strcasecmp (cf_global_options[i].key, ci->key) == 0)
296 ret = dispatch_global_option (ci);
301 } /* int dispatch_value */
303 static int dispatch_block_plugin (oconfig_item_t *ci)
308 cf_complex_callback_t *cb;
310 if (strcasecmp (ci->key, "Plugin") != 0)
312 if (ci->values_num < 1)
314 if (ci->values[0].type != OCONFIG_TYPE_STRING)
317 name = ci->values[0].value.string;
319 /* Check for a complex callback first */
320 for (cb = complex_callback_head; cb != NULL; cb = cb->next)
321 if (strcasecmp (name, cb->type) == 0)
322 return (cb->callback (ci));
324 /* Hm, no complex plugin found. Dispatch the values one by one */
325 for (i = 0; i < ci->children_num; i++)
327 if (ci->children[i].children == NULL)
328 dispatch_value_plugin (name, ci->children + i);
330 {DEBUG ("No nested config blocks allowed for this plugin.");}
337 static int dispatch_block (oconfig_item_t *ci)
339 if (strcasecmp (ci->key, "Plugin") == 0)
340 return (dispatch_block_plugin (ci));
341 else if (strcasecmp (ci->key, "Threshold") == 0)
342 return (ut_config (ci));
347 static int cf_ci_replace_child (oconfig_item_t *dst, oconfig_item_t *src,
350 oconfig_item_t *temp;
353 assert (offset >= 0);
354 assert (dst->children_num > offset);
356 /* Free the memory used by the replaced child. Usually that's the
357 * `Include "blah"' statement. */
358 temp = dst->children + offset;
359 for (i = 0; i < temp->values_num; i++)
361 if (temp->values[i].type == OCONFIG_TYPE_STRING)
363 sfree (temp->values[i].value.string);
366 sfree (temp->values);
369 /* If (src->children_num == 0) the array size is decreased. If offset
370 * is _not_ the last element, (offset < (src->children_num - 1)), then
371 * we need to move the trailing elements before resizing the array. */
372 if ((src->children_num == 0) && (offset < (src->children_num - 1)))
374 int nmemb = src->children_num - (offset + 1);
375 memmove (src->children + offset, src->children + offset + 1,
376 sizeof (oconfig_item_t) * nmemb);
379 /* Resize the memory containing the children to be big enough to hold
381 temp = (oconfig_item_t *) realloc (dst->children,
382 sizeof (oconfig_item_t)
383 * (dst->children_num + src->children_num - 1));
386 ERROR ("configfile: realloc failed.");
389 dst->children = temp;
391 /* If there are children behind the include statement, and they have
392 * not yet been moved because (src->children_num == 0), then move them
393 * to the end of the list, so that the new children have room before
395 if ((src->children_num > 0)
396 && ((dst->children_num - (offset + 1)) > 0))
398 int nmemb = dst->children_num - (offset + 1);
399 int old_offset = offset + 1;
400 int new_offset = offset + src->children_num;
402 memmove (dst->children + new_offset,
403 dst->children + old_offset,
404 sizeof (oconfig_item_t) * nmemb);
407 /* Last but not least: If there are new childrem, copy them to the
408 * memory reserved for them. */
409 if (src->children_num > 0)
411 memcpy (dst->children + offset,
413 sizeof (oconfig_item_t) * src->children_num);
416 /* Update the number of children. */
417 dst->children_num += (src->children_num - 1);
420 } /* int cf_ci_replace_child */
422 static int cf_ci_append_children (oconfig_item_t *dst, oconfig_item_t *src)
424 oconfig_item_t *temp;
426 if ((src == NULL) || (src->children_num == 0))
429 temp = (oconfig_item_t *) realloc (dst->children,
430 sizeof (oconfig_item_t)
431 * (dst->children_num + src->children_num));
434 ERROR ("configfile: realloc failed.");
437 dst->children = temp;
439 memcpy (dst->children + dst->children_num,
441 sizeof (oconfig_item_t)
442 * src->children_num);
443 dst->children_num += src->children_num;
446 } /* int cf_ci_append_children */
448 #define CF_MAX_DEPTH 8
449 static oconfig_item_t *cf_read_generic (const char *path, int depth);
451 static int cf_include_all (oconfig_item_t *root, int depth)
455 for (i = 0; i < root->children_num; i++)
460 /* Ignore all blocks, including `Include' blocks. */
461 if (root->children[i].children_num != 0)
464 if (strcasecmp (root->children[i].key, "Include") != 0)
467 old = root->children + i;
469 if ((old->values_num != 1)
470 || (old->values[0].type != OCONFIG_TYPE_STRING))
472 ERROR ("configfile: `Include' needs exactly one string argument.");
476 new = cf_read_generic (old->values[0].value.string, depth + 1);
480 /* Now replace the i'th child in `root' with `new'. */
481 cf_ci_replace_child (root, new, i);
485 } /* for (i = 0; i < root->children_num; i++) */
488 } /* int cf_include_all */
490 static oconfig_item_t *cf_read_file (const char *file, int depth)
492 oconfig_item_t *root;
494 assert (depth < CF_MAX_DEPTH);
496 root = oconfig_parse_file (file);
499 ERROR ("configfile: Cannot read file `%s'.", file);
503 cf_include_all (root, depth);
506 } /* oconfig_item_t *cf_read_file */
508 static int cf_compare_string (const void *p1, const void *p2)
510 return strcmp (*(const char **) p1, *(const char **) p2);
513 static oconfig_item_t *cf_read_dir (const char *dir, int depth)
515 oconfig_item_t *root = NULL;
518 char **filenames = NULL;
519 int filenames_num = 0;
523 assert (depth < CF_MAX_DEPTH);
529 ERROR ("configfile: opendir failed: %s",
530 sstrerror (errno, errbuf, sizeof (errbuf)));
534 root = (oconfig_item_t *) malloc (sizeof (oconfig_item_t));
537 ERROR ("configfile: malloc failed.");
540 memset (root, '\0', sizeof (oconfig_item_t));
542 while ((de = readdir (dh)) != NULL)
547 if ((de->d_name[0] == '.') || (de->d_name[0] == '\0'))
550 status = ssnprintf (name, sizeof (name), "%s/%s",
552 if (status >= sizeof (name))
554 ERROR ("configfile: Not including `%s/%s' because its"
555 " name is too long.",
557 for (i = 0; i < filenames_num; ++i)
565 tmp = (char **) realloc (filenames,
566 filenames_num * sizeof (*filenames));
568 ERROR ("configfile: realloc failed.");
569 for (i = 0; i < filenames_num - 1; ++i)
577 filenames[filenames_num - 1] = sstrdup (name);
580 qsort ((void *) filenames, filenames_num, sizeof (*filenames),
583 for (i = 0; i < filenames_num; ++i)
585 oconfig_item_t *temp;
586 char *name = filenames[i];
588 temp = cf_read_generic (name, depth);
591 for (j = i; j < filenames_num; ++j)
598 cf_ci_append_children (root, temp);
599 sfree (temp->children);
607 } /* oconfig_item_t *cf_read_dir */
612 * Path is stat'ed and either cf_read_file or cf_read_dir is called
615 * There are two versions of this function: If `wordexp' exists shell wildcards
616 * will be expanded and the function will include all matches found. If
617 * `wordexp' (or, more precisely, it's header file) is not available the
618 * simpler function is used which does not do any such expansion.
621 static oconfig_item_t *cf_read_generic (const char *path, int depth)
623 oconfig_item_t *root = NULL;
625 const char *path_ptr;
629 if (depth >= CF_MAX_DEPTH)
631 ERROR ("configfile: Not including `%s' because the maximum "
632 "nesting depth has been reached.", path);
636 status = wordexp (path, &we, WRDE_NOCMD);
639 ERROR ("configfile: wordexp (%s) failed.", path);
643 root = (oconfig_item_t *) malloc (sizeof (oconfig_item_t));
646 ERROR ("configfile: malloc failed.");
649 memset (root, '\0', sizeof (oconfig_item_t));
651 /* wordexp() might return a sorted list already. That's not
652 * documented though, so let's make sure we get what we want. */
653 qsort ((void *) we.we_wordv, we.we_wordc, sizeof (*we.we_wordv),
656 for (i = 0; i < we.we_wordc; i++)
658 oconfig_item_t *temp;
661 path_ptr = we.we_wordv[i];
663 status = stat (path_ptr, &statbuf);
667 ERROR ("configfile: stat (%s) failed: %s",
669 sstrerror (errno, errbuf, sizeof (errbuf)));
674 if (S_ISREG (statbuf.st_mode))
675 temp = cf_read_file (path_ptr, depth);
676 else if (S_ISDIR (statbuf.st_mode))
677 temp = cf_read_dir (path_ptr, depth);
680 ERROR ("configfile: %s is neither a file nor a "
690 cf_ci_append_children (root, temp);
691 sfree (temp->children);
698 } /* oconfig_item_t *cf_read_generic */
699 /* #endif HAVE_WORDEXP_H */
701 #else /* if !HAVE_WORDEXP_H */
702 static oconfig_item_t *cf_read_generic (const char *path, int depth)
707 if (depth >= CF_MAX_DEPTH)
709 ERROR ("configfile: Not including `%s' because the maximum "
710 "nesting depth has been reached.", path);
714 status = stat (path, &statbuf);
718 ERROR ("configfile: stat (%s) failed: %s",
720 sstrerror (errno, errbuf, sizeof (errbuf)));
724 if (S_ISREG (statbuf.st_mode))
725 return (cf_read_file (path, depth));
726 else if (S_ISDIR (statbuf.st_mode))
727 return (cf_read_dir (path, depth));
729 ERROR ("configfile: %s is neither a file nor a directory.", path);
731 } /* oconfig_item_t *cf_read_generic */
732 #endif /* !HAVE_WORDEXP_H */
737 int global_option_set (const char *option, const char *value)
741 DEBUG ("option = %s; value = %s;", option, value);
743 for (i = 0; i < cf_global_options_num; i++)
744 if (strcasecmp (cf_global_options[i].key, option) == 0)
747 if (i >= cf_global_options_num)
750 sfree (cf_global_options[i].value);
753 cf_global_options[i].value = strdup (value);
755 cf_global_options[i].value = NULL;
760 const char *global_option_get (const char *option)
764 for (i = 0; i < cf_global_options_num; i++)
765 if (strcasecmp (cf_global_options[i].key, option) == 0)
768 if (i >= cf_global_options_num)
771 return ((cf_global_options[i].value != NULL)
772 ? cf_global_options[i].value
773 : cf_global_options[i].def);
774 } /* char *global_option_get */
776 void cf_unregister (const char *type)
778 cf_callback_t *this, *prev;
780 for (prev = NULL, this = first_callback;
782 prev = this, this = this->next)
783 if (strcasecmp (this->type, type) == 0)
786 first_callback = this->next;
788 prev->next = this->next;
793 } /* void cf_unregister */
795 void cf_unregister_complex (const char *type)
797 cf_complex_callback_t *this, *prev;
799 for (prev = NULL, this = complex_callback_head;
801 prev = this, this = this->next)
802 if (strcasecmp (this->type, type) == 0)
805 complex_callback_head = this->next;
807 prev->next = this->next;
813 } /* void cf_unregister */
815 void cf_register (const char *type,
816 int (*callback) (const char *, const char *),
817 const char **keys, int keys_num)
819 cf_callback_t *cf_cb;
821 /* Remove this module from the list, if it already exists */
822 cf_unregister (type);
824 /* This pointer will be free'd in `cf_unregister' */
825 if ((cf_cb = (cf_callback_t *) malloc (sizeof (cf_callback_t))) == NULL)
829 cf_cb->callback = callback;
831 cf_cb->keys_num = keys_num;
833 cf_cb->next = first_callback;
834 first_callback = cf_cb;
835 } /* void cf_register */
837 int cf_register_complex (const char *type, int (*callback) (oconfig_item_t *))
839 cf_complex_callback_t *new;
841 new = (cf_complex_callback_t *) malloc (sizeof (cf_complex_callback_t));
845 new->type = strdup (type);
846 if (new->type == NULL)
852 new->callback = callback;
855 if (complex_callback_head == NULL)
857 complex_callback_head = new;
861 cf_complex_callback_t *last = complex_callback_head;
862 while (last->next != NULL)
868 } /* int cf_register_complex */
870 int cf_read (char *filename)
872 oconfig_item_t *conf;
875 conf = cf_read_generic (filename, 0 /* depth */);
878 ERROR ("Unable to read config file %s.", filename);
882 for (i = 0; i < conf->children_num; i++)
884 if (conf->children[i].children == NULL)
885 dispatch_value (conf->children + i);
887 dispatch_block (conf->children + i);
892 /* Read the default types.db if no `TypesDB' option was given. */
893 if (cf_default_typesdb)
894 read_types_list (PLUGINDIR"/types.db");