2 * collectd - src/configfile.c
3 * Copyright (C) 2005-2009 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"
33 #include "filter_chain.h"
37 #endif /* HAVE_WORDEXP_H */
39 #define ESCAPE_NULL(str) ((str) == NULL ? "(null)" : (str))
44 typedef struct cf_callback
47 int (*callback) (const char *, const char *);
50 struct cf_callback *next;
53 typedef struct cf_complex_callback_s
56 int (*callback) (oconfig_item_t *);
57 struct cf_complex_callback_s *next;
58 } cf_complex_callback_t;
60 typedef struct cf_value_map_s
63 int (*func) (const oconfig_item_t *);
66 typedef struct cf_global_option_s
74 * Prototypes of callback functions
76 static int dispatch_value_typesdb (const oconfig_item_t *ci);
77 static int dispatch_value_plugindir (const oconfig_item_t *ci);
78 static int dispatch_value_loadplugin (const oconfig_item_t *ci);
83 static cf_callback_t *first_callback = NULL;
84 static cf_complex_callback_t *complex_callback_head = NULL;
86 static cf_value_map_t cf_value_map[] =
88 {"TypesDB", dispatch_value_typesdb},
89 {"PluginDir", dispatch_value_plugindir},
90 {"LoadPlugin", dispatch_value_loadplugin}
92 static int cf_value_map_num = STATIC_ARRAY_LEN (cf_value_map);
94 static cf_global_option_t cf_global_options[] =
96 {"BaseDir", NULL, PKGLOCALSTATEDIR},
97 {"PIDFile", NULL, PIDFILE},
98 {"Hostname", NULL, NULL},
99 {"FQDNLookup", NULL, "false"},
100 {"Interval", NULL, "10"},
101 {"ReadThreads", NULL, "5"},
102 {"PreCacheChain", NULL, "PreCache"},
103 {"PostCacheChain", NULL, "PostCache"}
105 static int cf_global_options_num = STATIC_ARRAY_LEN (cf_global_options);
107 static int cf_default_typesdb = 1;
110 * Functions to handle register/unregister, search, and other plugin related
113 static cf_callback_t *cf_search (const char *type)
115 cf_callback_t *cf_cb;
120 for (cf_cb = first_callback; cf_cb != NULL; cf_cb = cf_cb->next)
121 if (strcasecmp (cf_cb->type, type) == 0)
127 static int cf_dispatch (const char *type, const char *orig_key,
128 const char *orig_value)
130 cf_callback_t *cf_cb;
136 DEBUG ("type = %s, key = %s, value = %s",
138 ESCAPE_NULL(orig_key),
139 ESCAPE_NULL(orig_value));
141 if ((cf_cb = cf_search (type)) == NULL)
143 WARNING ("Found a configuration for the `%s' plugin, but "
144 "the plugin isn't loaded or didn't register "
145 "a configuration callback.", type);
149 if ((key = strdup (orig_key)) == NULL)
151 if ((value = strdup (orig_value)) == NULL)
159 for (i = 0; i < cf_cb->keys_num; i++)
161 if ((cf_cb->keys[i] != NULL)
162 && (strcasecmp (cf_cb->keys[i], key) == 0))
164 ret = (*cf_cb->callback) (key, value);
169 if (i >= cf_cb->keys_num)
170 WARNING ("Plugin `%s' did not register for value `%s'.", type, key);
175 DEBUG ("cf_dispatch: return (%i)", ret);
178 } /* int cf_dispatch */
180 static int dispatch_global_option (const oconfig_item_t *ci)
182 if (ci->values_num != 1)
184 if (ci->values[0].type == OCONFIG_TYPE_STRING)
185 return (global_option_set (ci->key, ci->values[0].value.string));
186 else if (ci->values[0].type == OCONFIG_TYPE_NUMBER)
189 ssnprintf (tmp, sizeof (tmp), "%lf", ci->values[0].value.number);
190 return (global_option_set (ci->key, tmp));
192 else if (ci->values[0].type == OCONFIG_TYPE_BOOLEAN)
194 if (ci->values[0].value.boolean)
195 return (global_option_set (ci->key, "true"));
197 return (global_option_set (ci->key, "false"));
201 } /* int dispatch_global_option */
203 static int dispatch_value_typesdb (const oconfig_item_t *ci)
207 assert (strcasecmp (ci->key, "TypesDB") == 0);
209 cf_default_typesdb = 0;
211 if (ci->values_num < 1) {
212 ERROR ("configfile: `TypesDB' needs at least one argument.");
216 for (i = 0; i < ci->values_num; ++i)
218 if (OCONFIG_TYPE_STRING != ci->values[i].type) {
219 WARNING ("configfile: TypesDB: Skipping %i. argument which "
220 "is not a string.", i + 1);
224 read_types_list (ci->values[i].value.string);
227 } /* int dispatch_value_typesdb */
229 static int dispatch_value_plugindir (const oconfig_item_t *ci)
231 assert (strcasecmp (ci->key, "PluginDir") == 0);
233 if (ci->values_num != 1)
235 if (ci->values[0].type != OCONFIG_TYPE_STRING)
238 plugin_set_dir (ci->values[0].value.string);
242 static int dispatch_value_loadplugin (const oconfig_item_t *ci)
244 assert (strcasecmp (ci->key, "LoadPlugin") == 0);
246 if (ci->values_num != 1)
248 if (ci->values[0].type != OCONFIG_TYPE_STRING)
251 return (plugin_load (ci->values[0].value.string));
252 } /* int dispatch_value_loadplugin */
254 static int dispatch_value_plugin (const char *plugin, oconfig_item_t *ci)
262 buffer_free = sizeof (buffer);
264 for (i = 0; i < ci->values_num; i++)
268 if (ci->values[i].type == OCONFIG_TYPE_STRING)
269 status = ssnprintf (buffer_ptr, buffer_free, " %s",
270 ci->values[i].value.string);
271 else if (ci->values[i].type == OCONFIG_TYPE_NUMBER)
272 status = ssnprintf (buffer_ptr, buffer_free, " %lf",
273 ci->values[i].value.number);
274 else if (ci->values[i].type == OCONFIG_TYPE_BOOLEAN)
275 status = ssnprintf (buffer_ptr, buffer_free, " %s",
276 ci->values[i].value.boolean
279 if ((status < 0) || (status >= buffer_free))
281 buffer_free -= status;
282 buffer_ptr += status;
284 /* skip the initial space */
285 buffer_ptr = buffer + 1;
287 return (cf_dispatch (plugin, ci->key, buffer_ptr));
288 } /* int dispatch_value_plugin */
290 static int dispatch_value (const oconfig_item_t *ci)
295 for (i = 0; i < cf_value_map_num; i++)
296 if (strcasecmp (cf_value_map[i].key, ci->key) == 0)
298 ret = cf_value_map[i].func (ci);
302 for (i = 0; i < cf_global_options_num; i++)
303 if (strcasecmp (cf_global_options[i].key, ci->key) == 0)
305 ret = dispatch_global_option (ci);
310 } /* int dispatch_value */
312 static int dispatch_block_plugin (oconfig_item_t *ci)
317 cf_complex_callback_t *cb;
319 if (strcasecmp (ci->key, "Plugin") != 0)
321 if (ci->values_num < 1)
323 if (ci->values[0].type != OCONFIG_TYPE_STRING)
326 name = ci->values[0].value.string;
328 /* Check for a complex callback first */
329 for (cb = complex_callback_head; cb != NULL; cb = cb->next)
330 if (strcasecmp (name, cb->type) == 0)
331 return (cb->callback (ci));
333 /* Hm, no complex plugin found. Dispatch the values one by one */
334 for (i = 0; i < ci->children_num; i++)
336 if (ci->children[i].children == NULL)
337 dispatch_value_plugin (name, ci->children + i);
339 {DEBUG ("No nested config blocks allowed for this plugin.");}
346 static int dispatch_block (oconfig_item_t *ci)
348 if (strcasecmp (ci->key, "Plugin") == 0)
349 return (dispatch_block_plugin (ci));
350 else if (strcasecmp (ci->key, "Threshold") == 0)
351 return (ut_config (ci));
352 else if (strcasecmp (ci->key, "Chain") == 0)
353 return (fc_configure (ci));
358 static int cf_ci_replace_child (oconfig_item_t *dst, oconfig_item_t *src,
361 oconfig_item_t *temp;
364 assert (offset >= 0);
365 assert (dst->children_num > offset);
367 /* Free the memory used by the replaced child. Usually that's the
368 * `Include "blah"' statement. */
369 temp = dst->children + offset;
370 for (i = 0; i < temp->values_num; i++)
372 if (temp->values[i].type == OCONFIG_TYPE_STRING)
374 sfree (temp->values[i].value.string);
377 sfree (temp->values);
380 /* If (src->children_num == 0) the array size is decreased. If offset
381 * is _not_ the last element, (offset < (dst->children_num - 1)), then
382 * we need to move the trailing elements before resizing the array. */
383 if ((src->children_num == 0) && (offset < (dst->children_num - 1)))
385 int nmemb = dst->children_num - (offset + 1);
386 memmove (dst->children + offset, dst->children + offset + 1,
387 sizeof (oconfig_item_t) * nmemb);
390 /* Resize the memory containing the children to be big enough to hold
392 temp = (oconfig_item_t *) realloc (dst->children,
393 sizeof (oconfig_item_t)
394 * (dst->children_num + src->children_num - 1));
397 ERROR ("configfile: realloc failed.");
400 dst->children = temp;
402 /* If there are children behind the include statement, and they have
403 * not yet been moved because (src->children_num == 0), then move them
404 * to the end of the list, so that the new children have room before
406 if ((src->children_num > 0)
407 && ((dst->children_num - (offset + 1)) > 0))
409 int nmemb = dst->children_num - (offset + 1);
410 int old_offset = offset + 1;
411 int new_offset = offset + src->children_num;
413 memmove (dst->children + new_offset,
414 dst->children + old_offset,
415 sizeof (oconfig_item_t) * nmemb);
418 /* Last but not least: If there are new children, copy them to the
419 * memory reserved for them. */
420 if (src->children_num > 0)
422 memcpy (dst->children + offset,
424 sizeof (oconfig_item_t) * src->children_num);
427 /* Update the number of children. */
428 dst->children_num += (src->children_num - 1);
431 } /* int cf_ci_replace_child */
433 static int cf_ci_append_children (oconfig_item_t *dst, oconfig_item_t *src)
435 oconfig_item_t *temp;
437 if ((src == NULL) || (src->children_num == 0))
440 temp = (oconfig_item_t *) realloc (dst->children,
441 sizeof (oconfig_item_t)
442 * (dst->children_num + src->children_num));
445 ERROR ("configfile: realloc failed.");
448 dst->children = temp;
450 memcpy (dst->children + dst->children_num,
452 sizeof (oconfig_item_t)
453 * src->children_num);
454 dst->children_num += src->children_num;
457 } /* int cf_ci_append_children */
459 #define CF_MAX_DEPTH 8
460 static oconfig_item_t *cf_read_generic (const char *path, int depth);
462 static int cf_include_all (oconfig_item_t *root, int depth)
466 for (i = 0; i < root->children_num; i++)
471 /* Ignore all blocks, including `Include' blocks. */
472 if (root->children[i].children_num != 0)
475 if (strcasecmp (root->children[i].key, "Include") != 0)
478 old = root->children + i;
480 if ((old->values_num != 1)
481 || (old->values[0].type != OCONFIG_TYPE_STRING))
483 ERROR ("configfile: `Include' needs exactly one string argument.");
487 new = cf_read_generic (old->values[0].value.string, depth + 1);
491 /* Now replace the i'th child in `root' with `new'. */
492 cf_ci_replace_child (root, new, i);
494 /* ... and go back to the new i'th child. */
499 } /* for (i = 0; i < root->children_num; i++) */
502 } /* int cf_include_all */
504 static oconfig_item_t *cf_read_file (const char *file, int depth)
506 oconfig_item_t *root;
508 assert (depth < CF_MAX_DEPTH);
510 root = oconfig_parse_file (file);
513 ERROR ("configfile: Cannot read file `%s'.", file);
517 cf_include_all (root, depth);
520 } /* oconfig_item_t *cf_read_file */
522 static int cf_compare_string (const void *p1, const void *p2)
524 return strcmp (*(const char **) p1, *(const char **) p2);
527 static oconfig_item_t *cf_read_dir (const char *dir, int depth)
529 oconfig_item_t *root = NULL;
532 char **filenames = NULL;
533 int filenames_num = 0;
537 assert (depth < CF_MAX_DEPTH);
543 ERROR ("configfile: opendir failed: %s",
544 sstrerror (errno, errbuf, sizeof (errbuf)));
548 root = (oconfig_item_t *) malloc (sizeof (oconfig_item_t));
551 ERROR ("configfile: malloc failed.");
554 memset (root, '\0', sizeof (oconfig_item_t));
556 while ((de = readdir (dh)) != NULL)
561 if ((de->d_name[0] == '.') || (de->d_name[0] == '\0'))
564 status = ssnprintf (name, sizeof (name), "%s/%s",
566 if ((status < 0) || ((size_t) status >= sizeof (name)))
568 ERROR ("configfile: Not including `%s/%s' because its"
569 " name is too long.",
571 for (i = 0; i < filenames_num; ++i)
579 tmp = (char **) realloc (filenames,
580 filenames_num * sizeof (*filenames));
582 ERROR ("configfile: realloc failed.");
583 for (i = 0; i < filenames_num - 1; ++i)
591 filenames[filenames_num - 1] = sstrdup (name);
594 qsort ((void *) filenames, filenames_num, sizeof (*filenames),
597 for (i = 0; i < filenames_num; ++i)
599 oconfig_item_t *temp;
600 char *name = filenames[i];
602 temp = cf_read_generic (name, depth);
605 for (j = i; j < filenames_num; ++j)
612 cf_ci_append_children (root, temp);
613 sfree (temp->children);
621 } /* oconfig_item_t *cf_read_dir */
626 * Path is stat'ed and either cf_read_file or cf_read_dir is called
629 * There are two versions of this function: If `wordexp' exists shell wildcards
630 * will be expanded and the function will include all matches found. If
631 * `wordexp' (or, more precisely, it's header file) is not available the
632 * simpler function is used which does not do any such expansion.
635 static oconfig_item_t *cf_read_generic (const char *path, int depth)
637 oconfig_item_t *root = NULL;
639 const char *path_ptr;
643 if (depth >= CF_MAX_DEPTH)
645 ERROR ("configfile: Not including `%s' because the maximum "
646 "nesting depth has been reached.", path);
650 status = wordexp (path, &we, WRDE_NOCMD);
653 ERROR ("configfile: wordexp (%s) failed.", path);
657 root = (oconfig_item_t *) malloc (sizeof (oconfig_item_t));
660 ERROR ("configfile: malloc failed.");
663 memset (root, '\0', sizeof (oconfig_item_t));
665 /* wordexp() might return a sorted list already. That's not
666 * documented though, so let's make sure we get what we want. */
667 qsort ((void *) we.we_wordv, we.we_wordc, sizeof (*we.we_wordv),
670 for (i = 0; i < we.we_wordc; i++)
672 oconfig_item_t *temp;
675 path_ptr = we.we_wordv[i];
677 status = stat (path_ptr, &statbuf);
681 ERROR ("configfile: stat (%s) failed: %s",
683 sstrerror (errno, errbuf, sizeof (errbuf)));
688 if (S_ISREG (statbuf.st_mode))
689 temp = cf_read_file (path_ptr, depth);
690 else if (S_ISDIR (statbuf.st_mode))
691 temp = cf_read_dir (path_ptr, depth);
694 ERROR ("configfile: %s is neither a file nor a "
704 cf_ci_append_children (root, temp);
705 sfree (temp->children);
712 } /* oconfig_item_t *cf_read_generic */
713 /* #endif HAVE_WORDEXP_H */
715 #else /* if !HAVE_WORDEXP_H */
716 static oconfig_item_t *cf_read_generic (const char *path, int depth)
721 if (depth >= CF_MAX_DEPTH)
723 ERROR ("configfile: Not including `%s' because the maximum "
724 "nesting depth has been reached.", path);
728 status = stat (path, &statbuf);
732 ERROR ("configfile: stat (%s) failed: %s",
734 sstrerror (errno, errbuf, sizeof (errbuf)));
738 if (S_ISREG (statbuf.st_mode))
739 return (cf_read_file (path, depth));
740 else if (S_ISDIR (statbuf.st_mode))
741 return (cf_read_dir (path, depth));
743 ERROR ("configfile: %s is neither a file nor a directory.", path);
745 } /* oconfig_item_t *cf_read_generic */
746 #endif /* !HAVE_WORDEXP_H */
751 int global_option_set (const char *option, const char *value)
755 DEBUG ("option = %s; value = %s;", option, value);
757 for (i = 0; i < cf_global_options_num; i++)
758 if (strcasecmp (cf_global_options[i].key, option) == 0)
761 if (i >= cf_global_options_num)
764 sfree (cf_global_options[i].value);
767 cf_global_options[i].value = strdup (value);
769 cf_global_options[i].value = NULL;
774 const char *global_option_get (const char *option)
778 for (i = 0; i < cf_global_options_num; i++)
779 if (strcasecmp (cf_global_options[i].key, option) == 0)
782 if (i >= cf_global_options_num)
785 return ((cf_global_options[i].value != NULL)
786 ? cf_global_options[i].value
787 : cf_global_options[i].def);
788 } /* char *global_option_get */
790 void cf_unregister (const char *type)
792 cf_callback_t *this, *prev;
794 for (prev = NULL, this = first_callback;
796 prev = this, this = this->next)
797 if (strcasecmp (this->type, type) == 0)
800 first_callback = this->next;
802 prev->next = this->next;
807 } /* void cf_unregister */
809 void cf_unregister_complex (const char *type)
811 cf_complex_callback_t *this, *prev;
813 for (prev = NULL, this = complex_callback_head;
815 prev = this, this = this->next)
816 if (strcasecmp (this->type, type) == 0)
819 complex_callback_head = this->next;
821 prev->next = this->next;
827 } /* void cf_unregister */
829 void cf_register (const char *type,
830 int (*callback) (const char *, const char *),
831 const char **keys, int keys_num)
833 cf_callback_t *cf_cb;
835 /* Remove this module from the list, if it already exists */
836 cf_unregister (type);
838 /* This pointer will be free'd in `cf_unregister' */
839 if ((cf_cb = (cf_callback_t *) malloc (sizeof (cf_callback_t))) == NULL)
843 cf_cb->callback = callback;
845 cf_cb->keys_num = keys_num;
847 cf_cb->next = first_callback;
848 first_callback = cf_cb;
849 } /* void cf_register */
851 int cf_register_complex (const char *type, int (*callback) (oconfig_item_t *))
853 cf_complex_callback_t *new;
855 new = (cf_complex_callback_t *) malloc (sizeof (cf_complex_callback_t));
859 new->type = strdup (type);
860 if (new->type == NULL)
866 new->callback = callback;
869 if (complex_callback_head == NULL)
871 complex_callback_head = new;
875 cf_complex_callback_t *last = complex_callback_head;
876 while (last->next != NULL)
882 } /* int cf_register_complex */
884 int cf_read (char *filename)
886 oconfig_item_t *conf;
889 conf = cf_read_generic (filename, 0 /* depth */);
892 ERROR ("Unable to read config file %s.", filename);
896 for (i = 0; i < conf->children_num; i++)
898 if (conf->children[i].children == NULL)
899 dispatch_value (conf->children + i);
901 dispatch_block (conf->children + i);
906 /* Read the default types.db if no `TypesDB' option was given. */
907 if (cf_default_typesdb)
908 read_types_list (PKGDATADIR"/types.db");