Code

src/configfile.c: Fix another access of free'd memory.
[collectd.git] / src / configfile.c
1 /**
2  * collectd - src/configfile.c
3  * Copyright (C) 2005-2008  Florian octo Forster
4  *
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.
9  *
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.
14  *
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
18  *
19  * Authors:
20  *   Florian octo Forster <octo at verplant.org>
21  **/
23 #include "collectd.h"
25 #include "liboconfig/oconfig.h"
27 #include "common.h"
28 #include "plugin.h"
29 #include "configfile.h"
30 #include "types_list.h"
31 #include "utils_threshold.h"
33 #if HAVE_WORDEXP_H
34 # include <wordexp.h>
35 #endif /* HAVE_WORDEXP_H */
37 #define ESCAPE_NULL(str) ((str) == NULL ? "(null)" : (str))
39 /*
40  * Private types
41  */
42 typedef struct cf_callback
43 {
44         const char  *type;
45         int  (*callback) (const char *, const char *);
46         const char **keys;
47         int    keys_num;
48         struct cf_callback *next;
49 } cf_callback_t;
51 typedef struct cf_complex_callback_s
52 {
53         char *type;
54         int (*callback) (oconfig_item_t *);
55         struct cf_complex_callback_s *next;
56 } cf_complex_callback_t;
58 typedef struct cf_value_map_s
59 {
60         char *key;
61         int (*func) (const oconfig_item_t *);
62 } cf_value_map_t;
64 typedef struct cf_global_option_s
65 {
66         char *key;
67         char *value;
68         char *def;
69 } cf_global_option_t;
71 /*
72  * Prototypes of callback functions
73  */
74 static int dispatch_value_typesdb (const oconfig_item_t *ci);
75 static int dispatch_value_plugindir (const oconfig_item_t *ci);
76 static int dispatch_value_loadplugin (const oconfig_item_t *ci);
78 /*
79  * Private variables
80  */
81 static cf_callback_t *first_callback = NULL;
82 static cf_complex_callback_t *complex_callback_head = NULL;
84 static cf_value_map_t cf_value_map[] =
85 {
86         {"TypesDB",    dispatch_value_typesdb},
87         {"PluginDir",  dispatch_value_plugindir},
88         {"LoadPlugin", dispatch_value_loadplugin}
89 };
90 static int cf_value_map_num = STATIC_ARRAY_LEN (cf_value_map);
92 static cf_global_option_t cf_global_options[] =
93 {
94         {"BaseDir",     NULL, PKGLOCALSTATEDIR},
95         {"PIDFile",     NULL, PIDFILE},
96         {"Hostname",    NULL, NULL},
97         {"FQDNLookup",  NULL, "false"},
98         {"Interval",    NULL, "10"},
99         {"ReadThreads", NULL, "5"}
100 };
101 static int cf_global_options_num = STATIC_ARRAY_LEN (cf_global_options);
103 static int cf_default_typesdb = 1;
105 /*
106  * Functions to handle register/unregister, search, and other plugin related
107  * stuff
108  */
109 static cf_callback_t *cf_search (const char *type)
111         cf_callback_t *cf_cb;
113         if (type == NULL)
114                 return (NULL);
116         for (cf_cb = first_callback; cf_cb != NULL; cf_cb = cf_cb->next)
117                 if (strcasecmp (cf_cb->type, type) == 0)
118                         break;
120         return (cf_cb);
123 static int cf_dispatch (const char *type, const char *orig_key,
124                 const char *orig_value)
126         cf_callback_t *cf_cb;
127         char *key;
128         char *value;
129         int ret;
130         int i;
132         DEBUG ("type = %s, key = %s, value = %s",
133                         ESCAPE_NULL(type),
134                         ESCAPE_NULL(orig_key),
135                         ESCAPE_NULL(orig_value));
137         if ((cf_cb = cf_search (type)) == NULL)
138         {
139                 WARNING ("Found a configuration for the `%s' plugin, but "
140                                 "the plugin isn't loaded or didn't register "
141                                 "a configuration callback.", type);
142                 return (-1);
143         }
145         if ((key = strdup (orig_key)) == NULL)
146                 return (1);
147         if ((value = strdup (orig_value)) == NULL)
148         {
149                 free (key);
150                 return (2);
151         }
153         ret = -1;
155         for (i = 0; i < cf_cb->keys_num; i++)
156         {
157                 if (strcasecmp (cf_cb->keys[i], key) == 0)
158                 {
159                         ret = (*cf_cb->callback) (key, value);
160                         break;
161                 }
162         }
164         if (i >= cf_cb->keys_num)
165                 WARNING ("Plugin `%s' did not register for value `%s'.", type, key);
167         free (key);
168         free (value);
170         DEBUG ("return (%i)", ret);
172         return (ret);
173 } /* int cf_dispatch */
175 static int dispatch_global_option (const oconfig_item_t *ci)
177         if (ci->values_num != 1)
178                 return (-1);
179         if (ci->values[0].type == OCONFIG_TYPE_STRING)
180                 return (global_option_set (ci->key, ci->values[0].value.string));
181         else if (ci->values[0].type == OCONFIG_TYPE_NUMBER)
182         {
183                 char tmp[128];
184                 snprintf (tmp, sizeof (tmp), "%lf", ci->values[0].value.number);
185                 tmp[127] = '\0';
186                 return (global_option_set (ci->key, tmp));
187         }
188         else if (ci->values[0].type == OCONFIG_TYPE_BOOLEAN)
189         {
190                 if (ci->values[0].value.boolean)
191                         return (global_option_set (ci->key, "true"));
192                 else
193                         return (global_option_set (ci->key, "false"));
194         }
196         return (-1);
197 } /* int dispatch_global_option */
199 static int dispatch_value_typesdb (const oconfig_item_t *ci)
201         int i = 0;
203         assert (strcasecmp (ci->key, "TypesDB") == 0);
205         cf_default_typesdb = 0;
207         if (ci->values_num < 1)
208                 return (-1);
210         for (i = 0; i < ci->values_num; ++i)
211         {
212                 if (OCONFIG_TYPE_STRING != ci->values[i].type)
213                         continue;
215                 read_types_list (ci->values[i].value.string);
216         }
217         return (0);
218 } /* int dispatch_value_typesdb */
220 static int dispatch_value_plugindir (const oconfig_item_t *ci)
222         assert (strcasecmp (ci->key, "PluginDir") == 0);
223         
224         if (ci->values_num != 1)
225                 return (-1);
226         if (ci->values[0].type != OCONFIG_TYPE_STRING)
227                 return (-1);
229         plugin_set_dir (ci->values[0].value.string);
230         return (0);
233 static int dispatch_value_loadplugin (const oconfig_item_t *ci)
235         assert (strcasecmp (ci->key, "LoadPlugin") == 0);
237         if (ci->values_num != 1)
238                 return (-1);
239         if (ci->values[0].type != OCONFIG_TYPE_STRING)
240                 return (-1);
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)
247         char  buffer[4096];
248         char *buffer_ptr;
249         int   buffer_free;
250         int i;
252         buffer_ptr = buffer;
253         buffer_free = sizeof (buffer);
255         for (i = 0; i < ci->values_num; i++)
256         {
257                 int status = -1;
259                 if (ci->values[i].type == OCONFIG_TYPE_STRING)
260                         status = snprintf (buffer_ptr, buffer_free, " %s",
261                                         ci->values[i].value.string);
262                 else if (ci->values[i].type == OCONFIG_TYPE_NUMBER)
263                         status = snprintf (buffer_ptr, buffer_free, " %lf",
264                                         ci->values[i].value.number);
265                 else if (ci->values[i].type == OCONFIG_TYPE_BOOLEAN)
266                         status = snprintf (buffer_ptr, buffer_free, " %s",
267                                         ci->values[i].value.boolean
268                                         ? "true" : "false");
270                 if ((status < 0) || (status >= buffer_free))
271                         return (-1);
272                 buffer_free -= status;
273                 buffer_ptr  += status;
274         }
275         /* skip the initial space */
276         buffer_ptr = buffer + 1;
278         return (cf_dispatch (plugin, ci->key, buffer_ptr));
279 } /* int plugin_conf_dispatch */
281 static int dispatch_value (const oconfig_item_t *ci)
283         int ret = -2;
284         int i;
286         for (i = 0; i < cf_value_map_num; i++)
287                 if (strcasecmp (cf_value_map[i].key, ci->key) == 0)
288                 {
289                         ret = cf_value_map[i].func (ci);
290                         break;
291                 }
293         for (i = 0; i < cf_global_options_num; i++)
294                 if (strcasecmp (cf_global_options[i].key, ci->key) == 0)
295                 {
296                         ret = dispatch_global_option (ci);
297                         break;
298                 }
300         return (ret);
301 } /* int dispatch_value */
303 static int dispatch_block_plugin (oconfig_item_t *ci)
305         int i;
306         char *name;
308         cf_complex_callback_t *cb;
310         if (strcasecmp (ci->key, "Plugin") != 0)
311                 return (-1);
312         if (ci->values_num < 1)
313                 return (-1);
314         if (ci->values[0].type != OCONFIG_TYPE_STRING)
315                 return (-1);
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++)
326         {
327                 if (ci->children[i].children == NULL)
328                         dispatch_value_plugin (name, ci->children + i);
329                 else
330                         {DEBUG ("No nested config blocks allow for this plugin.");}
331         }
333         return (0);
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));
344         return (0);
347 static int cf_ci_replace_child (oconfig_item_t *dst, oconfig_item_t *src,
348                 int offset)
350         oconfig_item_t *temp;
351         int i;
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++)
360         {
361                 if (temp->values[i].type == OCONFIG_TYPE_STRING)
362                 {
363                         sfree (temp->values[i].value.string);
364                 }
365         }
366         sfree (temp->values);
367         temp = NULL;
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)))
373         {
374                 int nmemb = src->children_num - (offset + 1);
375                 memmove (src->children + offset, src->children + offset + 1,
376                                 sizeof (oconfig_item_t) * nmemb);
377         }
379         /* Resize the memory containing the children to be big enough to hold
380          * all children. */
381         temp = (oconfig_item_t *) realloc (dst->children,
382                         sizeof (oconfig_item_t)
383                         * (dst->children_num + src->children_num - 1));
384         if (temp == NULL)
385         {
386                 ERROR ("configfile: realloc failed.");
387                 return (-1);
388         }
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
394          * them. */
395         if ((src->children_num > 0)
396                         && ((dst->children_num - (offset + 1)) > 0))
397         {
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);
405         }
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)
410         {
411                 memcpy (dst->children + offset,
412                                 src->children,
413                                 sizeof (oconfig_item_t) * src->children_num);
414         }
416         /* Update the number of children. */
417         dst->children_num += (src->children_num - 1);
419         return (0);
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         temp = (oconfig_item_t *) realloc (dst->children,
427                         sizeof (oconfig_item_t)
428                         * (dst->children_num + src->children_num));
429         if (temp == NULL)
430         {
431                 ERROR ("configfile: realloc failed.");
432                 return (-1);
433         }
434         dst->children = temp;
436         memcpy (dst->children + dst->children_num,
437                         src->children,
438                         sizeof (oconfig_item_t)
439                         * src->children_num);
440         dst->children_num += src->children_num;
442         return (0);
443 } /* int cf_ci_append_children */
445 #define CF_MAX_DEPTH 8
446 static oconfig_item_t *cf_read_generic (const char *path, int depth);
448 static int cf_include_all (oconfig_item_t *root, int depth)
450         int i;
452         for (i = 0; i < root->children_num; i++)
453         {
454                 oconfig_item_t *new;
455                 oconfig_item_t *old;
457                 /* Ignore all blocks, including `Include' blocks. */
458                 if (root->children[i].children_num != 0)
459                         continue;
461                 if (strcasecmp (root->children[i].key, "Include") != 0)
462                         continue;
464                 old = root->children + i;
466                 if ((old->values_num != 1)
467                                 || (old->values[0].type != OCONFIG_TYPE_STRING))
468                 {
469                         ERROR ("configfile: `Include' needs exactly one string argument.");
470                         continue;
471                 }
473                 new = cf_read_generic (old->values[0].value.string, depth + 1);
474                 if (new == NULL)
475                         continue;
477                 /* Now replace the i'th child in `root' with `new'. */
478                 cf_ci_replace_child (root, new, i);
480                 sfree (new->values);
481                 sfree (new);
482         } /* for (i = 0; i < root->children_num; i++) */
484         return (0);
485 } /* int cf_include_all */
487 static oconfig_item_t *cf_read_file (const char *file, int depth)
489         oconfig_item_t *root;
491         assert (depth < CF_MAX_DEPTH);
493         root = oconfig_parse_file (file);
494         if (root == NULL)
495         {
496                 ERROR ("configfile: Cannot read file `%s'.", file);
497                 return (NULL);
498         }
500         cf_include_all (root, depth);
502         return (root);
503 } /* oconfig_item_t *cf_read_file */
505 static oconfig_item_t *cf_read_dir (const char *dir, int depth)
507         oconfig_item_t *root = NULL;
508         DIR *dh;
509         struct dirent *de;
510         char name[1024];
511         int status;
513         assert (depth < CF_MAX_DEPTH);
515         dh = opendir (dir);
516         if (dh == NULL)
517         {
518                 char errbuf[1024];
519                 ERROR ("configfile: opendir failed: %s",
520                                 sstrerror (errno, errbuf, sizeof (errbuf)));
521                 return (NULL);
522         }
524         root = (oconfig_item_t *) malloc (sizeof (oconfig_item_t));
525         if (root == NULL)
526         {
527                 ERROR ("configfile: malloc failed.");
528                 return (NULL);
529         }
530         memset (root, '\0', sizeof (oconfig_item_t));
532         while ((de = readdir (dh)) != NULL)
533         {
534                 oconfig_item_t *temp;
536                 if ((de->d_name[0] == '.') || (de->d_name[0] == '\0'))
537                         continue;
539                 status = snprintf (name, sizeof (name), "%s/%s",
540                                 dir, de->d_name);
541                 if (status >= sizeof (name))
542                 {
543                         ERROR ("configfile: Not including `%s/%s' because its"
544                                         " name is too long.",
545                                         dir, de->d_name);
546                         continue;
547                 }
549                 temp = cf_read_generic (name, depth);
550                 if (temp == NULL)
551                         continue;
553                 cf_ci_append_children (root, temp);
554                 sfree (temp->children);
555                 sfree (temp);
556         }
558         return (root);
559 } /* oconfig_item_t *cf_read_dir */
561 /* 
562  * cf_read_generic
563  *
564  * Path is stat'ed and either cf_read_file or cf_read_dir is called
565  * accordingly.
566  *
567  * There are two versions of this function: If `wordexp' exists shell wildcards
568  * will be expanded and the function will include all matches found. If
569  * `wordexp' (or, more precisely, it's header file) is not available the
570  * simpler function is used which does not do any such expansion.
571  */
572 #if HAVE_WORDEXP_H
573 static oconfig_item_t *cf_read_generic (const char *path, int depth)
575         oconfig_item_t *root = NULL;
576         int status;
577         const char *path_ptr;
578         wordexp_t we;
579         int i;
581         if (depth >= CF_MAX_DEPTH)
582         {
583                 ERROR ("configfile: Not including `%s' because the maximum "
584                                 "nesting depth has been reached.", path);
585                 return (NULL);
586         }
588         status = wordexp (path, &we, WRDE_NOCMD);
589         if (status != 0)
590         {
591                 ERROR ("configfile: wordexp (%s) failed.", path);
592                 return (NULL);
593         }
595         root = (oconfig_item_t *) malloc (sizeof (oconfig_item_t));
596         if (root == NULL)
597         {
598                 ERROR ("configfile: malloc failed.");
599                 return (NULL);
600         }
601         memset (root, '\0', sizeof (oconfig_item_t));
603         for (i = 0; i < we.we_wordc; i++)
604         {
605                 oconfig_item_t *temp;
606                 struct stat statbuf;
608                 path_ptr = we.we_wordv[i];
610                 status = stat (path_ptr, &statbuf);
611                 if (status != 0)
612                 {
613                         char errbuf[1024];
614                         ERROR ("configfile: stat (%s) failed: %s",
615                                         path_ptr,
616                                         sstrerror (errno, errbuf, sizeof (errbuf)));
617                         return (NULL);
618                 }
620                 if (S_ISREG (statbuf.st_mode))
621                         temp = cf_read_file (path_ptr, depth);
622                 else if (S_ISDIR (statbuf.st_mode))
623                         temp = cf_read_dir (path_ptr, depth);
624                 else
625                 {
626                         ERROR ("configfile: %s is neither a file nor a "
627                                         "directory.", path);
628                         continue;
629                 }
631                 cf_ci_append_children (root, temp);
632                 sfree (temp->children);
633                 sfree (temp);
634         }
636         wordfree (&we);
638         return (root);
639 } /* oconfig_item_t *cf_read_generic */
640 /* #endif HAVE_WORDEXP_H */
642 #else /* if !HAVE_WORDEXP_H */
643 static oconfig_item_t *cf_read_generic (const char *path, int depth)
645         struct stat statbuf;
646         int status;
648         if (depth >= CF_MAX_DEPTH)
649         {
650                 ERROR ("configfile: Not including `%s' because the maximum "
651                                 "nesting depth has been reached.", path);
652                 return (NULL);
653         }
655         status = stat (path, &statbuf);
656         if (status != 0)
657         {
658                 char errbuf[1024];
659                 ERROR ("configfile: stat (%s) failed: %s",
660                                 path,
661                                 sstrerror (errno, errbuf, sizeof (errbuf)));
662                 return (NULL);
663         }
665         if (S_ISREG (statbuf.st_mode))
666                 return (cf_read_file (path, depth));
667         else if (S_ISDIR (statbuf.st_mode))
668                 return (cf_read_dir (path, depth));
670         ERROR ("configfile: %s is neither a file nor a directory.", path);
671         return (NULL);
672 } /* oconfig_item_t *cf_read_generic */
673 #endif /* !HAVE_WORDEXP_H */
675 /* 
676  * Public functions
677  */
678 int global_option_set (const char *option, const char *value)
680         int i;
682         DEBUG ("option = %s; value = %s;", option, value);
684         for (i = 0; i < cf_global_options_num; i++)
685                 if (strcasecmp (cf_global_options[i].key, option) == 0)
686                         break;
688         if (i >= cf_global_options_num)
689                 return (-1);
691         sfree (cf_global_options[i].value);
693         if (value != NULL)
694                 cf_global_options[i].value = strdup (value);
695         else
696                 cf_global_options[i].value = NULL;
698         return (0);
701 const char *global_option_get (const char *option)
703         int i;
705         for (i = 0; i < cf_global_options_num; i++)
706                 if (strcasecmp (cf_global_options[i].key, option) == 0)
707                         break;
709         if (i >= cf_global_options_num)
710                 return (NULL);
711         
712         return ((cf_global_options[i].value != NULL)
713                         ? cf_global_options[i].value
714                         : cf_global_options[i].def);
715 } /* char *global_option_get */
717 void cf_unregister (const char *type)
719         cf_callback_t *this, *prev;
721         for (prev = NULL, this = first_callback;
722                         this != NULL;
723                         prev = this, this = this->next)
724                 if (strcasecmp (this->type, type) == 0)
725                 {
726                         if (prev == NULL)
727                                 first_callback = this->next;
728                         else
729                                 prev->next = this->next;
731                         free (this);
732                         break;
733                 }
734 } /* void cf_unregister */
736 void cf_unregister_complex (const char *type)
738         cf_complex_callback_t *this, *prev;
740         for (prev = NULL, this = complex_callback_head;
741                         this != NULL;
742                         prev = this, this = this->next)
743                 if (strcasecmp (this->type, type) == 0)
744                 {
745                         if (prev == NULL)
746                                 complex_callback_head = this->next;
747                         else
748                                 prev->next = this->next;
750                         sfree (this->type);
751                         sfree (this);
752                         break;
753                 }
754 } /* void cf_unregister */
756 void cf_register (const char *type,
757                 int (*callback) (const char *, const char *),
758                 const char **keys, int keys_num)
760         cf_callback_t *cf_cb;
762         /* Remove this module from the list, if it already exists */
763         cf_unregister (type);
765         /* This pointer will be free'd in `cf_unregister' */
766         if ((cf_cb = (cf_callback_t *) malloc (sizeof (cf_callback_t))) == NULL)
767                 return;
769         cf_cb->type     = type;
770         cf_cb->callback = callback;
771         cf_cb->keys     = keys;
772         cf_cb->keys_num = keys_num;
774         cf_cb->next = first_callback;
775         first_callback = cf_cb;
776 } /* void cf_register */
778 int cf_register_complex (const char *type, int (*callback) (oconfig_item_t *))
780         cf_complex_callback_t *new;
782         new = (cf_complex_callback_t *) malloc (sizeof (cf_complex_callback_t));
783         if (new == NULL)
784                 return (-1);
786         new->type = strdup (type);
787         if (new->type == NULL)
788         {
789                 sfree (new);
790                 return (-1);
791         }
793         new->callback = callback;
794         new->next = NULL;
796         if (complex_callback_head == NULL)
797         {
798                 complex_callback_head = new;
799         }
800         else
801         {
802                 cf_complex_callback_t *last = complex_callback_head;
803                 while (last->next != NULL)
804                         last = last->next;
805                 last->next = new;
806         }
808         return (0);
809 } /* int cf_register_complex */
811 int cf_read (char *filename)
813         oconfig_item_t *conf;
814         int i;
816         conf = cf_read_generic (filename, 0 /* depth */);
817         if (conf == NULL)
818         {
819                 ERROR ("Unable to read config file %s.", filename);
820                 return (-1);
821         }
823         for (i = 0; i < conf->children_num; i++)
824         {
825                 if (conf->children[i].children == NULL)
826                         dispatch_value (conf->children + i);
827                 else
828                         dispatch_block (conf->children + i);
829         }
831         if (cf_default_typesdb)
832                 read_types_list (PLUGINDIR"/types.db"); /* FIXME: Configure path */
833         return (0);
834 } /* int cf_read */