src/match_regex.c

   1 /**
   2  * collectd - src/match_regex.c
   3  * Copyright (C) 2008       Sebastian Harl
   4  * Copyright (C) 2008       Florian Forster
   5  *
   6  * Permission is hereby granted, free of charge, to any person obtaining a
   7  * copy of this software and associated documentation files (the "Software"),
   8  * to deal in the Software without restriction, including without limitation
   9  * the rights to use, copy, modify, merge, publish, distribute, sublicense,
  10  * and/or sell copies of the Software, and to permit persons to whom the
  11  * Software is furnished to do so, subject to the following conditions:
  12  *
  13  * The above copyright notice and this permission notice shall be included in
  14  * all copies or substantial portions of the Software.
  15  *
  16  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  17  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  18  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
  19  * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  20  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
  21  * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
  22  * DEALINGS IN THE SOFTWARE.
  23  *
  24  * Authors:
  25  *   Sebastian Harl <sh at tokkee.org>
  26  *   Florian Forster <octo at collectd.org>
  27  **/
  28
  29 /*
  30  * This module allows to filter and rewrite value lists based on
  31  * Perl-compatible regular expressions.
  32  */
  33
  34 #include "collectd.h"
  35 #include "filter_chain.h"
  36
  37 #include <sys/types.h>
  38 #include <regex.h>
  39
  40 #define log_err(...) ERROR ("`regex' match: " __VA_ARGS__)
  41 #define log_warn(...) WARNING ("`regex' match: " __VA_ARGS__)
  42
  43 /*
  44  * private data types
  45  */
  46
  47 struct mr_regex_s;
  48 typedef struct mr_regex_s mr_regex_t;
  49 struct mr_regex_s
  50 {
  51         regex_t re;
  52         char *re_str;
  53
  54         mr_regex_t *next;
  55 };
  56
  57 struct mr_match_s;
  58 typedef struct mr_match_s mr_match_t;
  59 struct mr_match_s
  60 {
  61         mr_regex_t *host;
  62         mr_regex_t *plugin;
  63         mr_regex_t *plugin_instance;
  64         mr_regex_t *type;
  65         mr_regex_t *type_instance;
  66         _Bool invert;
  67 };
  68
  69 /*
  70  * internal helper functions
  71  */
  72 static void mr_free_regex (mr_regex_t *r) /* {{{ */
  73 {
  74         if (r == NULL)
  75                 return;
  76
  77         regfree (&r->re);
  78         memset (&r->re, 0, sizeof (r->re));
  79         free (r->re_str);
  80
  81         if (r->next != NULL)
  82                 mr_free_regex (r->next);
  83 } /* }}} void mr_free_regex */
  84
  85 static void mr_free_match (mr_match_t *m) /* {{{ */
  86 {
  87         if (m == NULL)
  88                 return;
  89
  90         mr_free_regex (m->host);
  91         mr_free_regex (m->plugin);
  92         mr_free_regex (m->plugin_instance);
  93         mr_free_regex (m->type);
  94         mr_free_regex (m->type_instance);
  95
  96         free (m);
  97 } /* }}} void mr_free_match */
  98
  99 static int mr_match_regexen (mr_regex_t *re_head, /* {{{ */
 100                 const char *string)
 101 {
 102         mr_regex_t *re;
 103
 104         if (re_head == NULL)
 105                 return (FC_MATCH_MATCHES);
 106
 107         for (re = re_head; re != NULL; re = re->next)
 108         {
 109                 int status;
 110
 111                 status = regexec (&re->re, string,
 112                                 /* nmatch = */ 0, /* pmatch = */ NULL,
 113                                 /* eflags = */ 0);
 114                 if (status == 0)
 115                 {
 116                         DEBUG ("regex match: Regular expression `%s' matches `%s'.",
 117                                         re->re_str, string);
 118                 }
 119                 else
 120                 {
 121                         DEBUG ("regex match: Regular expression `%s' does not match `%s'.",
 122                                         re->re_str, string);
 123                         return (FC_MATCH_NO_MATCH);
 124                 }
 125
 126         }
 127
 128         return (FC_MATCH_MATCHES);
 129 } /* }}} int mr_match_regexen */
 130
 131 static int mr_config_add_regex (mr_regex_t **re_head, /* {{{ */
 132                 oconfig_item_t *ci)
 133 {
 134         mr_regex_t *re;
 135         int status;
 136
 137         if ((ci->values_num != 1) || (ci->values[0].type != OCONFIG_TYPE_STRING))
 138         {
 139                 log_warn ("`%s' needs exactly one string argument.", ci->key);
 140                 return (-1);
 141         }
 142
 143         re = calloc (1, sizeof (*re));
 144         if (re == NULL)
 145         {
 146                 log_err ("mr_config_add_regex: calloc failed.");
 147                 return (-1);
 148         }
 149         re->next = NULL;
 150
 151         re->re_str = strdup (ci->values[0].value.string);
 152         if (re->re_str == NULL)
 153         {
 154                 free (re);
 155                 log_err ("mr_config_add_regex: strdup failed.");
 156                 return (-1);
 157         }
 158
 159         status = regcomp (&re->re, re->re_str, REG_EXTENDED | REG_NOSUB);
 160         if (status != 0)
 161         {
 162                 char errmsg[1024];
 163                 regerror (status, &re->re, errmsg, sizeof (errmsg));
 164                 errmsg[sizeof (errmsg) - 1] = 0;
 165                 log_err ("Compiling regex `%s' for `%s' failed: %s.",
 166                                 re->re_str, ci->key, errmsg);
 167                 free (re->re_str);
 168                 free (re);
 169                 return (-1);
 170         }
 171
 172         if (*re_head == NULL)
 173         {
 174                 *re_head = re;
 175         }
 176         else
 177         {
 178                 mr_regex_t *ptr;
 179
 180                 ptr = *re_head;
 181                 while (ptr->next != NULL)
 182                         ptr = ptr->next;
 183
 184                 ptr->next = re;
 185         }
 186
 187         return (0);
 188 } /* }}} int mr_config_add_regex */
 189
 190 static int mr_create (const oconfig_item_t *ci, void **user_data) /* {{{ */
 191 {
 192         mr_match_t *m;
 193         int status;
 194         int i;
 195
 196         m = calloc (1, sizeof (*m));
 197         if (m == NULL)
 198         {
 199                 log_err ("mr_create: calloc failed.");
 200                 return (-ENOMEM);
 201         }
 202
 203         m->invert = 0;
 204
 205         status = 0;
 206         for (i = 0; i < ci->children_num; i++)
 207         {
 208                 oconfig_item_t *child = ci->children + i;
 209
 210                 if ((strcasecmp ("Host", child->key) == 0)
 211                                 || (strcasecmp ("Hostname", child->key) == 0))
 212                         status = mr_config_add_regex (&m->host, child);
 213                 else if (strcasecmp ("Plugin", child->key) == 0)
 214                         status = mr_config_add_regex (&m->plugin, child);
 215                 else if (strcasecmp ("PluginInstance", child->key) == 0)
 216                         status = mr_config_add_regex (&m->plugin_instance, child);
 217                 else if (strcasecmp ("Type", child->key) == 0)
 218                         status = mr_config_add_regex (&m->type, child);
 219                 else if (strcasecmp ("TypeInstance", child->key) == 0)
 220                         status = mr_config_add_regex (&m->type_instance, child);
 221                 else if (strcasecmp ("Invert", child->key) == 0)
 222                         status = cf_util_get_boolean(child, &m->invert);
 223                 else
 224                 {
 225                         log_err ("The `%s' configuration option is not understood and "
 226                                         "will be ignored.", child->key);
 227                         status = 0;
 228                 }
 229
 230                 if (status != 0)
 231                         break;
 232         }
 233
 234         /* Additional sanity-checking */
 235         while (status == 0)
 236         {
 237                 if ((m->host == NULL)
 238                                 && (m->plugin == NULL)
 239                                 && (m->plugin_instance == NULL)
 240                                 && (m->type == NULL)
 241                                 && (m->type_instance == NULL))
 242                 {
 243                         log_err ("No (valid) regular expressions have been configured. "
 244                                         "This match will be ignored.");
 245                         status = -1;
 246                 }
 247
 248                 break;
 249         }
 250
 251         if (status != 0)
 252         {
 253                 mr_free_match (m);
 254                 return (status);
 255         }
 256
 257         *user_data = m;
 258         return (0);
 259 } /* }}} int mr_create */
 260
 261 static int mr_destroy (void **user_data) /* {{{ */
 262 {
 263         if ((user_data != NULL) && (*user_data != NULL))
 264                 mr_free_match (*user_data);
 265         return (0);
 266 } /* }}} int mr_destroy */
 267
 268 static int mr_match (const data_set_t __attribute__((unused)) *ds, /* {{{ */
 269                 const value_list_t *vl,
 270                 notification_meta_t __attribute__((unused)) **meta,
 271                 void **user_data)
 272 {
 273         mr_match_t *m;
 274         int match_value = FC_MATCH_MATCHES;
 275         int nomatch_value = FC_MATCH_NO_MATCH;
 276
 277         if ((user_data == NULL) || (*user_data == NULL))
 278                 return (-1);
 279
 280         m = *user_data;
 281
 282         if (m->invert)
 283         {
 284                 match_value = FC_MATCH_NO_MATCH;
 285                 nomatch_value = FC_MATCH_MATCHES;
 286         }
 287
 288         if (mr_match_regexen (m->host, vl->host) == FC_MATCH_NO_MATCH)
 289                 return (nomatch_value);
 290         if (mr_match_regexen (m->plugin, vl->plugin) == FC_MATCH_NO_MATCH)
 291                 return (nomatch_value);
 292         if (mr_match_regexen (m->plugin_instance,
 293                                 vl->plugin_instance) == FC_MATCH_NO_MATCH)
 294                 return (nomatch_value);
 295         if (mr_match_regexen (m->type, vl->type) == FC_MATCH_NO_MATCH)
 296                 return (nomatch_value);
 297         if (mr_match_regexen (m->type_instance,
 298                                 vl->type_instance) == FC_MATCH_NO_MATCH)
 299                 return (nomatch_value);
 300
 301         return (match_value);
 302 } /* }}} int mr_match */
 303
 304 void module_register (void)
 305 {
 306         match_proc_t mproc;
 307
 308         memset (&mproc, 0, sizeof (mproc));
 309         mproc.create  = mr_create;
 310         mproc.destroy = mr_destroy;
 311         mproc.match   = mr_match;
 312         fc_register_match ("regex", mproc);
 313 } /* module_register */
 314
 315 /* vim: set sw=4 ts=4 tw=78 noexpandtab fdm=marker : */
 316