1 /**
2 * collectd - src/match_value.c
3 * Copyright (C) 2008 Florian Forster
4 *
5 * Permission is hereby granted, free of charge, to any person obtaining a
6 * copy of this software and associated documentation files (the "Software"),
7 * to deal in the Software without restriction, including without limitation
8 * the rights to use, copy, modify, merge, publish, distribute, sublicense,
9 * and/or sell copies of the Software, and to permit persons to whom the
10 * Software is furnished to do so, subject to the following conditions:
11 *
12 * The above copyright notice and this permission notice shall be included in
13 * all copies or substantial portions of the Software.
14 *
15 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
20 * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
21 * DEALINGS IN THE SOFTWARE.
22 *
23 * Authors:
24 * Florian Forster <octo at collectd.org>
25 **/
27 /*
28 * This module allows to filter and rewrite value lists based on
29 * Perl-compatible regular expressions.
30 */
32 #include "collectd.h"
33 #include "common.h"
34 #include "utils_cache.h"
35 #include "filter_chain.h"
37 #define SATISFY_ALL 0
38 #define SATISFY_ANY 1
40 /*
41 * private data types
42 */
43 struct mv_match_s;
44 typedef struct mv_match_s mv_match_t;
45 struct mv_match_s
46 {
47 gauge_t min;
48 gauge_t max;
49 int invert;
50 int satisfy;
52 char **data_sources;
53 size_t data_sources_num;
54 };
56 /*
57 * internal helper functions
58 */
59 static void mv_free_match (mv_match_t *m) /* {{{ */
60 {
61 size_t i;
63 if (m == NULL)
64 return;
66 if (m->data_sources != NULL)
67 {
68 for (i = 0; i < m->data_sources_num; ++i)
69 free(m->data_sources[i]);
70 free(m->data_sources);
71 }
73 free (m);
74 } /* }}} void mv_free_match */
76 static int mv_config_add_satisfy (mv_match_t *m, /* {{{ */
77 oconfig_item_t *ci)
78 {
79 if ((ci->values_num != 1) || (ci->values[0].type != OCONFIG_TYPE_STRING))
80 {
81 ERROR ("`value' match: `%s' needs exactly one string argument.",
82 ci->key);
83 return (-1);
84 }
86 if (strcasecmp ("All", ci->values[0].value.string) == 0)
87 m->satisfy = SATISFY_ALL;
88 else if (strcasecmp ("Any", ci->values[0].value.string) == 0)
89 m->satisfy = SATISFY_ANY;
90 else
91 {
92 ERROR ("`value' match: Passing `%s' to the `%s' option is invalid. "
93 "The argument must either be `All' or `Any'.",
94 ci->values[0].value.string, ci->key);
95 return (-1);
96 }
98 return (0);
99 } /* }}} int mv_config_add_satisfy */
101 static int mv_config_add_data_source (mv_match_t *m, /* {{{ */
102 oconfig_item_t *ci)
103 {
104 size_t new_data_sources_num;
105 char **temp;
106 int i;
108 /* Check number of arbuments. */
109 if (ci->values_num < 1)
110 {
111 ERROR ("`value' match: `%s' needs at least one argument.",
112 ci->key);
113 return (-1);
114 }
116 /* Check type of arguments */
117 for (i = 0; i < ci->values_num; i++)
118 {
119 if (ci->values[i].type == OCONFIG_TYPE_STRING)
120 continue;
122 ERROR ("`value' match: `%s' accepts only string arguments "
123 "(argument %i is a %s).",
124 ci->key, i + 1,
125 (ci->values[i].type == OCONFIG_TYPE_BOOLEAN)
126 ? "truth value" : "number");
127 return (-1);
128 }
130 /* Allocate space for the char pointers */
131 new_data_sources_num = m->data_sources_num + ((size_t) ci->values_num);
132 temp = (char **) realloc (m->data_sources,
133 new_data_sources_num * sizeof (char *));
134 if (temp == NULL)
135 {
136 ERROR ("`value' match: realloc failed.");
137 return (-1);
138 }
139 m->data_sources = temp;
141 /* Copy the strings, allocating memory as needed. */
142 for (i = 0; i < ci->values_num; i++)
143 {
144 size_t j;
146 /* If we get here, there better be memory for us to write to. */
147 assert (m->data_sources_num < new_data_sources_num);
149 j = m->data_sources_num;
150 m->data_sources[j] = sstrdup (ci->values[i].value.string);
151 if (m->data_sources[j] == NULL)
152 {
153 ERROR ("`value' match: sstrdup failed.");
154 continue;
155 }
156 m->data_sources_num++;
157 }
159 return (0);
160 } /* }}} int mv_config_add_data_source */
162 static int mv_config_add_gauge (gauge_t *ret_value, /* {{{ */
163 oconfig_item_t *ci)
164 {
166 if ((ci->values_num != 1) || (ci->values[0].type != OCONFIG_TYPE_NUMBER))
167 {
168 ERROR ("`value' match: `%s' needs exactly one numeric argument.",
169 ci->key);
170 return (-1);
171 }
173 *ret_value = ci->values[0].value.number;
175 return (0);
176 } /* }}} int mv_config_add_gauge */
178 static int mv_config_add_boolean (int *ret_value, /* {{{ */
179 oconfig_item_t *ci)
180 {
182 if ((ci->values_num != 1) || (ci->values[0].type != OCONFIG_TYPE_BOOLEAN))
183 {
184 ERROR ("`value' match: `%s' needs exactly one boolean argument.",
185 ci->key);
186 return (-1);
187 }
189 if (ci->values[0].value.boolean)
190 *ret_value = 1;
191 else
192 *ret_value = 0;
194 return (0);
195 } /* }}} int mv_config_add_boolean */
197 static int mv_create (const oconfig_item_t *ci, void **user_data) /* {{{ */
198 {
199 mv_match_t *m;
200 int status;
201 int i;
203 m = (mv_match_t *) malloc (sizeof (*m));
204 if (m == NULL)
205 {
206 ERROR ("mv_create: malloc failed.");
207 return (-ENOMEM);
208 }
209 memset (m, 0, sizeof (*m));
211 m->min = NAN;
212 m->max = NAN;
213 m->invert = 0;
214 m->satisfy = SATISFY_ALL;
215 m->data_sources = NULL;
216 m->data_sources_num = 0;
218 status = 0;
219 for (i = 0; i < ci->children_num; i++)
220 {
221 oconfig_item_t *child = ci->children + i;
223 if (strcasecmp ("Min", child->key) == 0)
224 status = mv_config_add_gauge (&m->min, child);
225 else if (strcasecmp ("Max", child->key) == 0)
226 status = mv_config_add_gauge (&m->max, child);
227 else if (strcasecmp ("Invert", child->key) == 0)
228 status = mv_config_add_boolean (&m->invert, child);
229 else if (strcasecmp ("Satisfy", child->key) == 0)
230 status = mv_config_add_satisfy (m, child);
231 else if (strcasecmp ("DataSource", child->key) == 0)
232 status = mv_config_add_data_source (m, child);
233 else
234 {
235 ERROR ("`value' match: The `%s' configuration option is not "
236 "understood and will be ignored.", child->key);
237 status = 0;
238 }
240 if (status != 0)
241 break;
242 }
244 /* Additional sanity-checking */
245 while (status == 0)
246 {
247 if (isnan (m->min) && isnan (m->max))
248 {
249 ERROR ("`value' match: Neither minimum nor maximum are defined. "
250 "This match will be ignored.");
251 status = -1;
252 }
254 break;
255 }
257 if (status != 0)
258 {
259 mv_free_match (m);
260 return (status);
261 }
263 *user_data = m;
264 return (0);
265 } /* }}} int mv_create */
267 static int mv_destroy (void **user_data) /* {{{ */
268 {
269 if ((user_data != NULL) && (*user_data != NULL))
270 mv_free_match (*user_data);
271 return (0);
272 } /* }}} int mv_destroy */
274 static int mv_match (const data_set_t *ds, const value_list_t *vl, /* {{{ */
275 notification_meta_t __attribute__((unused)) **meta, void **user_data)
276 {
277 mv_match_t *m;
278 gauge_t *values;
279 int status;
280 size_t i;
282 if ((user_data == NULL) || (*user_data == NULL))
283 return (-1);
285 m = *user_data;
287 values = uc_get_rate (ds, vl);
288 if (values == NULL)
289 {
290 ERROR ("`value' match: Retrieving the current rate from the cache "
291 "failed.");
292 return (-1);
293 }
295 status = FC_MATCH_NO_MATCH;
297 for (i = 0; i < ds->ds_num; i++)
298 {
299 int value_matches = 0;
301 /* Check if this data source is relevant. */
302 if (m->data_sources != NULL)
303 {
304 size_t j;
306 for (j = 0; j < m->data_sources_num; j++)
307 if (strcasecmp (ds->ds[i].name, m->data_sources[j]) == 0)
308 break;
310 /* No match, ignore this data source. */
311 if (j >= m->data_sources_num)
312 continue;
313 }
315 DEBUG ("`value' match: current = %g; min = %g; max = %g; invert = %s;",
316 values[i], m->min, m->max,
317 m->invert ? "true" : "false");
319 if ((!isnan (m->min) && (values[i] < m->min))
320 || (!isnan (m->max) && (values[i] > m->max)))
321 value_matches = 0;
322 else
323 value_matches = 1;
325 if (m->invert)
326 {
327 if (value_matches)
328 value_matches = 0;
329 else
330 value_matches = 1;
331 }
333 if (value_matches != 0)
334 {
335 status = FC_MATCH_MATCHES;
336 if (m->satisfy == SATISFY_ANY)
337 break;
338 }
339 else if (value_matches == 0)
340 {
341 status = FC_MATCH_NO_MATCH;
342 if (m->satisfy == SATISFY_ALL)
343 break;
344 }
345 } /* for (i = 0; i < ds->ds_num; i++) */
347 free (values);
348 return (status);
349 } /* }}} int mv_match */
351 void module_register (void)
352 {
353 match_proc_t mproc;
355 memset (&mproc, 0, sizeof (mproc));
356 mproc.create = mv_create;
357 mproc.destroy = mv_destroy;
358 mproc.match = mv_match;
359 fc_register_match ("value", mproc);
360 } /* module_register */
362 /* vim: set sw=2 sts=2 tw=78 et fdm=marker : */