src/daemon/utils_ignorelist.c

   1 /**
   2  * collectd - src/utils_ignorelist.c
   3  * Copyright (C) 2006 Lubos Stanek <lubek at users.sourceforge.net>
   4  * Copyright (C) 2008 Florian Forster <octo at collectd.org>
   5  *
   6  * This program is free software; you can redistribute it and/
   7  * or modify it under the terms of the GNU General Public Li-
   8  * cence as published by the Free Software Foundation; either
   9  * version 2 of the Licence, or any later version.
  10  *
  11  * This program is distributed in the hope that it will be use-
  12  * ful, but WITHOUT ANY WARRANTY; without even the implied war-
  13  * ranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
  14  * See the GNU General Public Licence for more details.
  15  *
  16  * You should have received a copy of the GNU General Public License along
  17  * with this program; if not, write to the Free Software Foundation, Inc.,
  18  * 51 Franklin St, Fifth Floor, Boston, MA  02110-1301 USA
  19  *
  20  * Authors:
  21  *   Lubos Stanek <lubek at users.sourceforge.net>
  22  *   Florian Forster <octo at collectd.org>
  23  **/
  24 /**
  25  * ignorelist handles plugin's list of configured collectable
  26  * entries with global ignore action
  27  **/
  28 /**
  29  * Usage:
  30  *
  31  * Define plugin's global pointer variable of type ignorelist_t:
  32  *   ignorelist_t *myconfig_ignore;
  33  * If you know the state of the global ignore (IgnoreSelected),
  34  * allocate the variable with:
  35  *   myconfig_ignore = ignorelist_create (YourKnownIgnore);
  36  * If you do not know the state of the global ignore,
  37  * initialize the global variable and set the ignore flag later:
  38  *   myconfig_ignore = ignorelist_init ();
  39  * Append single entries in your cf_register'ed callback function:
  40  *   ignorelist_add (myconfig_ignore, newentry);
  41  * When you hit the IgnoreSelected config option,
  42  * offer it to the list:
  43  *   ignorelist_ignore (myconfig_ignore, instantly_got_value_of_ignore);
  44  * That is all for the ignorelist initialization.
  45  * Later during read and write (plugin's registered functions) get
  46  * the information whether this entry would be collected or not:
  47  *   if (ignorelist_match (myconfig_ignore, thisentry))
  48  *     return;
  49  **/
  50
  51 #if HAVE_CONFIG_H
  52 # include "config.h"
  53 #endif
  54
  55 #include "common.h"
  56 #include "plugin.h"
  57 #include "utils_ignorelist.h"
  58
  59 /*
  60  * private prototypes
  61  */
  62 struct ignorelist_item_s
  63 {
  64 #if HAVE_REGEX_H
  65         regex_t *rmatch;        /* regular expression entry identification */
  66 #endif
  67         char *smatch;           /* string entry identification */
  68         struct ignorelist_item_s *next;
  69 };
  70 typedef struct ignorelist_item_s ignorelist_item_t;
  71
  72 struct ignorelist_s
  73 {
  74         int ignore;             /* ignore entries */
  75         ignorelist_item_t *head;        /* pointer to the first entry */
  76 };
  77
  78 /* *** *** *** ********************************************* *** *** *** */
  79 /* *** *** *** *** *** ***   private functions   *** *** *** *** *** *** */
  80 /* *** *** *** ********************************************* *** *** *** */
  81
  82 static inline void ignorelist_append (ignorelist_t *il, ignorelist_item_t *item)
  83 {
  84         assert ((il != NULL) && (item != NULL));
  85
  86         item->next = il->head;
  87         il->head = item;
  88 }
  89
  90 #if HAVE_REGEX_H
  91 static int ignorelist_append_regex(ignorelist_t *il, const char *re_str)
  92 {
  93         regex_t *re;
  94         ignorelist_item_t *entry;
  95         int status;
  96
  97         re = malloc (sizeof (*re));
  98         if (re == NULL)
  99         {
 100                 ERROR ("ignorelist_append_regex: malloc failed.");
 101                 return (ENOMEM);
 102         }
 103         memset (re, 0, sizeof (*re));
 104
 105         status = regcomp (re, re_str, REG_EXTENDED);
 106         if (status != 0)
 107         {
 108                 char errbuf[1024];
 109                 (void) regerror (status, re, errbuf, sizeof (errbuf));
 110                 ERROR ("utils_ignorelist: regcomp failed: %s", errbuf);
 111                 ERROR ("ignorelist_append_regex: Compiling regular expression \"%s\" failed: %s", re_str, errbuf);
 112                 sfree (re);
 113                 return (status);
 114         }
 115
 116         entry = malloc (sizeof (*entry));
 117         if (entry == NULL)
 118         {
 119                 ERROR ("ignorelist_append_regex: malloc failed.");
 120                 regfree (re);
 121                 sfree (re);
 122                 return (ENOMEM);
 123         }
 124         memset (entry, 0, sizeof (*entry));
 125         entry->rmatch = re;
 126
 127         ignorelist_append (il, entry);
 128         return (0);
 129 } /* int ignorelist_append_regex */
 130 #endif
 131
 132 static int ignorelist_append_string(ignorelist_t *il, const char *entry)
 133 {
 134         ignorelist_item_t *new;
 135
 136         /* create new entry */
 137         if ((new = malloc(sizeof(ignorelist_item_t))) == NULL )
 138         {
 139                 ERROR ("cannot allocate new entry");
 140                 return (1);
 141         }
 142         memset (new, '\0', sizeof(ignorelist_item_t));
 143         new->smatch = sstrdup(entry);
 144
 145         /* append new entry */
 146         ignorelist_append (il, new);
 147
 148         return (0);
 149 } /* int ignorelist_append_string(ignorelist_t *il, const char *entry) */
 150
 151 #if HAVE_REGEX_H
 152 /*
 153  * check list for entry regex match
 154  * return 1 if found
 155  */
 156 static int ignorelist_match_regex (ignorelist_item_t *item, const char *entry)
 157 {
 158         assert ((item != NULL) && (item->rmatch != NULL)
 159                         && (entry != NULL) && (strlen (entry) > 0));
 160
 161         /* match regex */
 162         if (regexec (item->rmatch, entry, 0, NULL, 0) == 0)
 163                 return (1);
 164
 165         return (0);
 166 } /* int ignorelist_match_regex (ignorelist_item_t *item, const char *entry) */
 167 #endif
 168
 169 /*
 170  * check list for entry string match
 171  * return 1 if found
 172  */
 173 static int ignorelist_match_string (ignorelist_item_t *item, const char *entry)
 174 {
 175         assert ((item != NULL) && (item->smatch != NULL)
 176                         && (entry != NULL) && (strlen (entry) > 0));
 177
 178         if (strcmp (entry, item->smatch) == 0)
 179                 return (1);
 180
 181         return (0);
 182 } /* int ignorelist_match_string (ignorelist_item_t *item, const char *entry) */
 183
 184
 185 /* *** *** *** ******************************************** *** *** *** */
 186 /* *** *** *** *** *** ***   public functions   *** *** *** *** *** *** */
 187 /* *** *** *** ******************************************** *** *** *** */
 188
 189 /*
 190  * create the ignorelist_t with known ignore state
 191  * return pointer to ignorelist_t
 192  */
 193 ignorelist_t *ignorelist_create (int invert)
 194 {
 195         ignorelist_t *il;
 196
 197         il = malloc (sizeof (*il));
 198         if (il == NULL)
 199                 return NULL;
 200         memset (il, 0, sizeof (*il));
 201
 202         /*
 203          * ->ignore == 0  =>  collect
 204          * ->ignore == 1  =>  ignore
 205          */
 206         il->ignore = invert ? 0 : 1;
 207
 208         return (il);
 209 } /* ignorelist_t *ignorelist_create (int ignore) */
 210
 211 /*
 212  * free memory used by ignorelist_t
 213  */
 214 void ignorelist_free (ignorelist_t *il)
 215 {
 216         ignorelist_item_t *this;
 217         ignorelist_item_t *next;
 218
 219         if (il == NULL)
 220                 return;
 221
 222         for (this = il->head; this != NULL; this = next)
 223         {
 224                 next = this->next;
 225 #if HAVE_REGEX_H
 226                 if (this->rmatch != NULL)
 227                 {
 228                         regfree (this->rmatch);
 229                         sfree (this->rmatch);
 230                         this->rmatch = NULL;
 231                 }
 232 #endif
 233                 if (this->smatch != NULL)
 234                 {
 235                         sfree (this->smatch);
 236                         this->smatch = NULL;
 237                 }
 238                 sfree (this);
 239         }
 240
 241         sfree (il);
 242         il = NULL;
 243 } /* void ignorelist_destroy (ignorelist_t *il) */
 244
 245 /*
 246  * set ignore state of the ignorelist_t
 247  */
 248 void ignorelist_set_invert (ignorelist_t *il, int invert)
 249 {
 250         if (il == NULL)
 251         {
 252                 DEBUG("ignore call with ignorelist_t == NULL");
 253                 return;
 254         }
 255
 256         il->ignore = invert ? 0 : 1;
 257 } /* void ignorelist_set_invert (ignorelist_t *il, int ignore) */
 258
 259 /*
 260  * append entry into ignorelist_t
 261  * return 0 for success
 262  */
 263 int ignorelist_add (ignorelist_t *il, const char *entry)
 264 {
 265         size_t len;
 266
 267         if (il == NULL)
 268         {
 269                 DEBUG ("add called with ignorelist_t == NULL");
 270                 return (1);
 271         }
 272
 273         len = strlen (entry);
 274
 275         /* append nothing */
 276         if (len == 0)
 277         {
 278                 DEBUG("not appending: empty entry");
 279                 return (1);
 280         }
 281
 282 #if HAVE_REGEX_H
 283         /* regex string is enclosed in "/.../" */
 284         if ((len > 2) && (entry[0] == '/') && entry[len - 1] == '/')
 285         {
 286                 char *copy;
 287                 int status;
 288
 289                 /* skip leading slash */
 290                 copy = strdup (entry + 1);
 291                 if (copy == NULL)
 292                         return ENOMEM;
 293
 294                 /* trim trailing slash */
 295                 copy[strlen (copy) - 1] = 0;
 296
 297                 status = ignorelist_append_regex (il, copy);
 298                 sfree (copy);
 299                 return status;
 300         }
 301 #endif
 302
 303         return ignorelist_append_string(il, entry);
 304 } /* int ignorelist_add (ignorelist_t *il, const char *entry) */
 305
 306 /*
 307  * check list for entry
 308  * return 1 for ignored entry
 309  */
 310 int ignorelist_match (ignorelist_t *il, const char *entry)
 311 {
 312         ignorelist_item_t *traverse;
 313
 314         /* if no entries, collect all */
 315         if ((il == NULL) || (il->head == NULL))
 316                 return (0);
 317
 318         if ((entry == NULL) || (strlen (entry) == 0))
 319                 return (0);
 320
 321         /* traverse list and check entries */
 322         for (traverse = il->head; traverse != NULL; traverse = traverse->next)
 323         {
 324 #if HAVE_REGEX_H
 325                 if (traverse->rmatch != NULL)
 326                 {
 327                         if (ignorelist_match_regex (traverse, entry))
 328                                 return (il->ignore);
 329                 }
 330                 else
 331 #endif
 332                 {
 333                         if (ignorelist_match_string (traverse, entry))
 334                                 return (il->ignore);
 335                 }
 336         } /* for traverse */
 337
 338         return (1 - il->ignore);
 339 } /* int ignorelist_match (ignorelist_t *il, const char *entry) */
 340