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_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_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_loadplugin (const oconfig_item_t *ci)
246 assert (strcasecmp (ci->key, "LoadPlugin") == 0);
248 if (ci->values_num != 1)
250 if (ci->values[0].type != OCONFIG_TYPE_STRING)
253 for (i = 0; i < ci->children_num; ++i) {
254 if (ci->children[i].values_num != 1 ||
255 ci->children[i].values[0].type != OCONFIG_TYPE_BOOLEAN) {
256 WARNING("Ignoring unknown LoadPlugin option %s for plugin %s", ci->children[i].key, ci->values[0].value.string);
259 if (strcasecmp(ci->children[i].key, "globals") == 0) {
260 flags |= PLUGIN_FLAGS_GLOBAL;
262 WARNING("Ignoring unknown LoadPlugin option %s for plugin %s", ci->children[i].key, ci->values[0].value.string);
265 return (plugin_load (ci->values[0].value.string, flags));
266 } /* int dispatch_value_loadplugin */
268 static int dispatch_value_plugin (const char *plugin, oconfig_item_t *ci)
276 buffer_free = sizeof (buffer);
278 for (i = 0; i < ci->values_num; i++)
282 if (ci->values[i].type == OCONFIG_TYPE_STRING)
283 status = ssnprintf (buffer_ptr, buffer_free, " %s",
284 ci->values[i].value.string);
285 else if (ci->values[i].type == OCONFIG_TYPE_NUMBER)
286 status = ssnprintf (buffer_ptr, buffer_free, " %lf",
287 ci->values[i].value.number);
288 else if (ci->values[i].type == OCONFIG_TYPE_BOOLEAN)
289 status = ssnprintf (buffer_ptr, buffer_free, " %s",
290 ci->values[i].value.boolean
293 if ((status < 0) || (status >= buffer_free))
295 buffer_free -= status;
296 buffer_ptr += status;
298 /* skip the initial space */
299 buffer_ptr = buffer + 1;
301 return (cf_dispatch (plugin, ci->key, buffer_ptr));
302 } /* int dispatch_value_plugin */
304 static int dispatch_value (const oconfig_item_t *ci)
309 for (i = 0; i < cf_value_map_num; i++)
310 if (strcasecmp (cf_value_map[i].key, ci->key) == 0)
312 ret = cf_value_map[i].func (ci);
316 for (i = 0; i < cf_global_options_num; i++)
317 if (strcasecmp (cf_global_options[i].key, ci->key) == 0)
319 ret = dispatch_global_option (ci);
324 } /* int dispatch_value */
326 static int dispatch_block_plugin (oconfig_item_t *ci)
331 cf_complex_callback_t *cb;
333 if (strcasecmp (ci->key, "Plugin") != 0)
335 if (ci->values_num < 1)
337 if (ci->values[0].type != OCONFIG_TYPE_STRING)
340 name = ci->values[0].value.string;
342 /* Check for a complex callback first */
343 for (cb = complex_callback_head; cb != NULL; cb = cb->next)
344 if (strcasecmp (name, cb->type) == 0)
345 return (cb->callback (ci));
347 /* Hm, no complex plugin found. Dispatch the values one by one */
348 for (i = 0; i < ci->children_num; i++)
350 if (ci->children[i].children == NULL)
351 dispatch_value_plugin (name, ci->children + i);
354 WARNING ("There is a `%s' block within the "
355 "configuration for the %s plugin. "
356 "The plugin either only expects "
357 "\"simple\" configuration statements "
358 "or wasn't loaded using `LoadPlugin'."
359 " Please check your configuration.",
360 ci->children[i].key, name);
368 static int dispatch_block (oconfig_item_t *ci)
370 if (strcasecmp (ci->key, "LoadPlugin") == 0)
371 return (dispatch_loadplugin (ci));
372 else if (strcasecmp (ci->key, "Plugin") == 0)
373 return (dispatch_block_plugin (ci));
374 else if (strcasecmp (ci->key, "Threshold") == 0)
375 return (ut_config (ci));
376 else if (strcasecmp (ci->key, "Chain") == 0)
377 return (fc_configure (ci));
382 static int cf_ci_replace_child (oconfig_item_t *dst, oconfig_item_t *src,
385 oconfig_item_t *temp;
388 assert (offset >= 0);
389 assert (dst->children_num > offset);
391 /* Free the memory used by the replaced child. Usually that's the
392 * `Include "blah"' statement. */
393 temp = dst->children + offset;
394 for (i = 0; i < temp->values_num; i++)
396 if (temp->values[i].type == OCONFIG_TYPE_STRING)
398 sfree (temp->values[i].value.string);
401 sfree (temp->values);
404 /* If (src->children_num == 0) the array size is decreased. If offset
405 * is _not_ the last element, (offset < (dst->children_num - 1)), then
406 * we need to move the trailing elements before resizing the array. */
407 if ((src->children_num == 0) && (offset < (dst->children_num - 1)))
409 int nmemb = dst->children_num - (offset + 1);
410 memmove (dst->children + offset, dst->children + offset + 1,
411 sizeof (oconfig_item_t) * nmemb);
414 /* Resize the memory containing the children to be big enough to hold
416 temp = (oconfig_item_t *) realloc (dst->children,
417 sizeof (oconfig_item_t)
418 * (dst->children_num + src->children_num - 1));
421 ERROR ("configfile: realloc failed.");
424 dst->children = temp;
426 /* If there are children behind the include statement, and they have
427 * not yet been moved because (src->children_num == 0), then move them
428 * to the end of the list, so that the new children have room before
430 if ((src->children_num > 0)
431 && ((dst->children_num - (offset + 1)) > 0))
433 int nmemb = dst->children_num - (offset + 1);
434 int old_offset = offset + 1;
435 int new_offset = offset + src->children_num;
437 memmove (dst->children + new_offset,
438 dst->children + old_offset,
439 sizeof (oconfig_item_t) * nmemb);
442 /* Last but not least: If there are new children, copy them to the
443 * memory reserved for them. */
444 if (src->children_num > 0)
446 memcpy (dst->children + offset,
448 sizeof (oconfig_item_t) * src->children_num);
451 /* Update the number of children. */
452 dst->children_num += (src->children_num - 1);
455 } /* int cf_ci_replace_child */
457 static int cf_ci_append_children (oconfig_item_t *dst, oconfig_item_t *src)
459 oconfig_item_t *temp;
461 if ((src == NULL) || (src->children_num == 0))
464 temp = (oconfig_item_t *) realloc (dst->children,
465 sizeof (oconfig_item_t)
466 * (dst->children_num + src->children_num));
469 ERROR ("configfile: realloc failed.");
472 dst->children = temp;
474 memcpy (dst->children + dst->children_num,
476 sizeof (oconfig_item_t)
477 * src->children_num);
478 dst->children_num += src->children_num;
481 } /* int cf_ci_append_children */
483 #define CF_MAX_DEPTH 8
484 static oconfig_item_t *cf_read_generic (const char *path, int depth);
486 static int cf_include_all (oconfig_item_t *root, int depth)
490 for (i = 0; i < root->children_num; i++)
495 /* Ignore all blocks, including `Include' blocks. */
496 if (root->children[i].children_num != 0)
499 if (strcasecmp (root->children[i].key, "Include") != 0)
502 old = root->children + i;
504 if ((old->values_num != 1)
505 || (old->values[0].type != OCONFIG_TYPE_STRING))
507 ERROR ("configfile: `Include' needs exactly one string argument.");
511 new = cf_read_generic (old->values[0].value.string, depth + 1);
515 /* Now replace the i'th child in `root' with `new'. */
516 cf_ci_replace_child (root, new, i);
518 /* ... and go back to the new i'th child. */
523 } /* for (i = 0; i < root->children_num; i++) */
526 } /* int cf_include_all */
528 static oconfig_item_t *cf_read_file (const char *file, int depth)
530 oconfig_item_t *root;
532 assert (depth < CF_MAX_DEPTH);
534 root = oconfig_parse_file (file);
537 ERROR ("configfile: Cannot read file `%s'.", file);
541 cf_include_all (root, depth);
544 } /* oconfig_item_t *cf_read_file */
546 static int cf_compare_string (const void *p1, const void *p2)
548 return strcmp (*(const char **) p1, *(const char **) p2);
551 static oconfig_item_t *cf_read_dir (const char *dir, int depth)
553 oconfig_item_t *root = NULL;
556 char **filenames = NULL;
557 int filenames_num = 0;
561 assert (depth < CF_MAX_DEPTH);
567 ERROR ("configfile: opendir failed: %s",
568 sstrerror (errno, errbuf, sizeof (errbuf)));
572 root = (oconfig_item_t *) malloc (sizeof (oconfig_item_t));
575 ERROR ("configfile: malloc failed.");
578 memset (root, '\0', sizeof (oconfig_item_t));
580 while ((de = readdir (dh)) != NULL)
585 if ((de->d_name[0] == '.') || (de->d_name[0] == '\0'))
588 status = ssnprintf (name, sizeof (name), "%s/%s",
590 if ((status < 0) || ((size_t) status >= sizeof (name)))
592 ERROR ("configfile: Not including `%s/%s' because its"
593 " name is too long.",
595 for (i = 0; i < filenames_num; ++i)
603 tmp = (char **) realloc (filenames,
604 filenames_num * sizeof (*filenames));
606 ERROR ("configfile: realloc failed.");
607 for (i = 0; i < filenames_num - 1; ++i)
615 filenames[filenames_num - 1] = sstrdup (name);
618 qsort ((void *) filenames, filenames_num, sizeof (*filenames),
621 for (i = 0; i < filenames_num; ++i)
623 oconfig_item_t *temp;
624 char *name = filenames[i];
626 temp = cf_read_generic (name, depth);
629 for (j = i; j < filenames_num; ++j)
636 cf_ci_append_children (root, temp);
637 sfree (temp->children);
645 } /* oconfig_item_t *cf_read_dir */
650 * Path is stat'ed and either cf_read_file or cf_read_dir is called
653 * There are two versions of this function: If `wordexp' exists shell wildcards
654 * will be expanded and the function will include all matches found. If
655 * `wordexp' (or, more precisely, it's header file) is not available the
656 * simpler function is used which does not do any such expansion.
659 static oconfig_item_t *cf_read_generic (const char *path, int depth)
661 oconfig_item_t *root = NULL;
663 const char *path_ptr;
667 if (depth >= CF_MAX_DEPTH)
669 ERROR ("configfile: Not including `%s' because the maximum "
670 "nesting depth has been reached.", path);
674 status = wordexp (path, &we, WRDE_NOCMD);
677 ERROR ("configfile: wordexp (%s) failed.", path);
681 root = (oconfig_item_t *) malloc (sizeof (oconfig_item_t));
684 ERROR ("configfile: malloc failed.");
687 memset (root, '\0', sizeof (oconfig_item_t));
689 /* wordexp() might return a sorted list already. That's not
690 * documented though, so let's make sure we get what we want. */
691 qsort ((void *) we.we_wordv, we.we_wordc, sizeof (*we.we_wordv),
694 for (i = 0; i < we.we_wordc; i++)
696 oconfig_item_t *temp;
699 path_ptr = we.we_wordv[i];
701 status = stat (path_ptr, &statbuf);
705 ERROR ("configfile: stat (%s) failed: %s",
707 sstrerror (errno, errbuf, sizeof (errbuf)));
712 if (S_ISREG (statbuf.st_mode))
713 temp = cf_read_file (path_ptr, depth);
714 else if (S_ISDIR (statbuf.st_mode))
715 temp = cf_read_dir (path_ptr, depth);
718 ERROR ("configfile: %s is neither a file nor a "
728 cf_ci_append_children (root, temp);
729 sfree (temp->children);
736 } /* oconfig_item_t *cf_read_generic */
737 /* #endif HAVE_WORDEXP_H */
739 #else /* if !HAVE_WORDEXP_H */
740 static oconfig_item_t *cf_read_generic (const char *path, int depth)
745 if (depth >= CF_MAX_DEPTH)
747 ERROR ("configfile: Not including `%s' because the maximum "
748 "nesting depth has been reached.", path);
752 status = stat (path, &statbuf);
756 ERROR ("configfile: stat (%s) failed: %s",
758 sstrerror (errno, errbuf, sizeof (errbuf)));
762 if (S_ISREG (statbuf.st_mode))
763 return (cf_read_file (path, depth));
764 else if (S_ISDIR (statbuf.st_mode))
765 return (cf_read_dir (path, depth));
767 ERROR ("configfile: %s is neither a file nor a directory.", path);
769 } /* oconfig_item_t *cf_read_generic */
770 #endif /* !HAVE_WORDEXP_H */
775 int global_option_set (const char *option, const char *value)
779 DEBUG ("option = %s; value = %s;", option, value);
781 for (i = 0; i < cf_global_options_num; i++)
782 if (strcasecmp (cf_global_options[i].key, option) == 0)
785 if (i >= cf_global_options_num)
788 sfree (cf_global_options[i].value);
791 cf_global_options[i].value = strdup (value);
793 cf_global_options[i].value = NULL;
798 const char *global_option_get (const char *option)
802 for (i = 0; i < cf_global_options_num; i++)
803 if (strcasecmp (cf_global_options[i].key, option) == 0)
806 if (i >= cf_global_options_num)
809 return ((cf_global_options[i].value != NULL)
810 ? cf_global_options[i].value
811 : cf_global_options[i].def);
812 } /* char *global_option_get */
814 void cf_unregister (const char *type)
816 cf_callback_t *this, *prev;
818 for (prev = NULL, this = first_callback;
820 prev = this, this = this->next)
821 if (strcasecmp (this->type, type) == 0)
824 first_callback = this->next;
826 prev->next = this->next;
831 } /* void cf_unregister */
833 void cf_unregister_complex (const char *type)
835 cf_complex_callback_t *this, *prev;
837 for (prev = NULL, this = complex_callback_head;
839 prev = this, this = this->next)
840 if (strcasecmp (this->type, type) == 0)
843 complex_callback_head = this->next;
845 prev->next = this->next;
851 } /* void cf_unregister */
853 void cf_register (const char *type,
854 int (*callback) (const char *, const char *),
855 const char **keys, int keys_num)
857 cf_callback_t *cf_cb;
859 /* Remove this module from the list, if it already exists */
860 cf_unregister (type);
862 /* This pointer will be free'd in `cf_unregister' */
863 if ((cf_cb = (cf_callback_t *) malloc (sizeof (cf_callback_t))) == NULL)
867 cf_cb->callback = callback;
869 cf_cb->keys_num = keys_num;
871 cf_cb->next = first_callback;
872 first_callback = cf_cb;
873 } /* void cf_register */
875 int cf_register_complex (const char *type, int (*callback) (oconfig_item_t *))
877 cf_complex_callback_t *new;
879 new = (cf_complex_callback_t *) malloc (sizeof (cf_complex_callback_t));
883 new->type = strdup (type);
884 if (new->type == NULL)
890 new->callback = callback;
893 if (complex_callback_head == NULL)
895 complex_callback_head = new;
899 cf_complex_callback_t *last = complex_callback_head;
900 while (last->next != NULL)
906 } /* int cf_register_complex */
908 int cf_read (char *filename)
910 oconfig_item_t *conf;
913 conf = cf_read_generic (filename, 0 /* depth */);
916 ERROR ("Unable to read config file %s.", filename);
920 for (i = 0; i < conf->children_num; i++)
922 if (conf->children[i].children == NULL)
923 dispatch_value (conf->children + i);
925 dispatch_block (conf->children + i);
930 /* Read the default types.db if no `TypesDB' option was given. */
931 if (cf_default_typesdb)
932 read_types_list (PKGDATADIR"/types.db");
937 /* Assures the config option is a string, duplicates it and returns the copy in
938 * "ret_string". If necessary "*ret_string" is freed first. Returns zero upon
940 int cf_util_get_string (const oconfig_item_t *ci, char **ret_string) /* {{{ */
944 if ((ci->values_num != 1) || (ci->values[0].type != OCONFIG_TYPE_STRING))
946 ERROR ("cf_util_get_string: The %s plugin requires "
947 "exactly one string argument.", ci->key);
951 string = strdup (ci->values[0].value.string);
955 if (*ret_string != NULL)
957 *ret_string = string;
960 } /* }}} int cf_util_get_string */
962 /* Assures that the config option is a string. The string is then converted to
963 * a port number using `service_name_to_port_number' and returned. Returns the
964 * port number in the range [1-65535] or less than zero upon failure. */
965 int cf_util_get_port_number (const oconfig_item_t *ci) /* {{{ */
967 if ((ci->values_num != 1) || (ci->values[0].type != OCONFIG_TYPE_STRING))
969 ERROR ("cf_util_get_port_number: The %s plugin requires "
970 "exactly one string argument.", ci->key);
974 return (service_name_to_port_number (ci->values[0].value.string));
975 } /* }}} int cf_util_get_port_number */