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
17 * Licence along with this program; if not, write to the Free
18 * Software Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139,
19 * USA.
20 *
21 * Authors:
22 * Lubos Stanek <lubek at users.sourceforge.net>
23 * Florian Forster <octo at collectd.org>
24 **/
25 /**
26 * ignorelist handles plugin's list of configured collectable
27 * entries with global ignore action
28 **/
29 /**
30 * Usage:
31 *
32 * Define plugin's global pointer variable of type ignorelist_t:
33 * ignorelist_t *myconfig_ignore;
34 * If you know the state of the global ignore (IgnoreSelected),
35 * allocate the variable with:
36 * myconfig_ignore = ignorelist_create (YourKnownIgnore);
37 * If you do not know the state of the global ignore,
38 * initialize the global variable and set the ignore flag later:
39 * myconfig_ignore = ignorelist_init ();
40 * Append single entries in your cf_register'ed callback function:
41 * ignorelist_add (myconfig_ignore, newentry);
42 * When you hit the IgnoreSelected config option,
43 * offer it to the list:
44 * ignorelist_ignore (myconfig_ignore, instantly_got_value_of_ignore);
45 * That is all for the ignorelist initialization.
46 * Later during read and write (plugin's registered functions) get
47 * the information whether this entry would be collected or not:
48 * if (ignorelist_match (myconfig_ignore, thisentry))
49 * return;
50 **/
52 #if HAVE_CONFIG_H
53 # include "config.h"
54 #endif
56 #include "common.h"
57 #include "plugin.h"
58 #include "utils_ignorelist.h"
60 /*
61 * private prototypes
62 */
63 struct ignorelist_item_s
64 {
65 #if HAVE_REGEX_H
66 regex_t *rmatch; /* regular expression entry identification */
67 #endif
68 char *smatch; /* string entry identification */
69 struct ignorelist_item_s *next;
70 };
71 typedef struct ignorelist_item_s ignorelist_item_t;
73 struct ignorelist_s
74 {
75 int ignore; /* ignore entries */
76 ignorelist_item_t *head; /* pointer to the first entry */
77 };
79 /* *** *** *** ********************************************* *** *** *** */
80 /* *** *** *** *** *** *** private functions *** *** *** *** *** *** */
81 /* *** *** *** ********************************************* *** *** *** */
83 static inline void ignorelist_append (ignorelist_t *il, ignorelist_item_t *item)
84 {
85 assert ((il != NULL) && (item != NULL));
87 item->next = il->head;
88 il->head = item;
89 }
91 #if HAVE_REGEX_H
92 static int ignorelist_append_regex(ignorelist_t *il, const char *re_str)
93 {
94 regex_t *re;
95 ignorelist_item_t *entry;
96 int status;
98 re = malloc (sizeof (*re));
99 if (re == NULL)
100 {
101 ERROR ("ignorelist_append_regex: malloc failed.");
102 return (ENOMEM);
103 }
104 memset (re, 0, sizeof (*re));
106 status = regcomp (re, re_str, REG_EXTENDED);
107 if (status != 0)
108 {
109 char errbuf[1024];
110 (void) regerror (status, re, errbuf, sizeof (errbuf));
111 ERROR ("utils_ignorelist: regcomp failed: %s", errbuf);
112 ERROR ("ignorelist_append_regex: Compiling regular expression \"%s\" failed: %s", re_str, errbuf);
113 sfree (re);
114 return (status);
115 }
117 entry = malloc (sizeof (*entry));
118 if (entry == NULL)
119 {
120 ERROR ("ignorelist_append_regex: malloc failed.");
121 regfree (re);
122 sfree (re);
123 return (ENOMEM);
124 }
125 memset (entry, 0, sizeof (*entry));
126 entry->rmatch = re;
128 ignorelist_append (il, entry);
129 return (0);
130 } /* int ignorelist_append_regex */
131 #endif
133 static int ignorelist_append_string(ignorelist_t *il, const char *entry)
134 {
135 ignorelist_item_t *new;
137 /* create new entry */
138 if ((new = malloc(sizeof(ignorelist_item_t))) == NULL )
139 {
140 ERROR ("cannot allocate new entry");
141 return (1);
142 }
143 memset (new, '\0', sizeof(ignorelist_item_t));
144 new->smatch = sstrdup(entry);
146 /* append new entry */
147 ignorelist_append (il, new);
149 return (0);
150 } /* int ignorelist_append_string(ignorelist_t *il, const char *entry) */
152 #if HAVE_REGEX_H
153 /*
154 * check list for entry regex match
155 * return 1 if found
156 */
157 static int ignorelist_match_regex (ignorelist_item_t *item, const char *entry)
158 {
159 assert ((item != NULL) && (item->rmatch != NULL)
160 && (entry != NULL) && (strlen (entry) > 0));
162 /* match regex */
163 if (regexec (item->rmatch, entry, 0, NULL, 0) == 0)
164 return (1);
166 return (0);
167 } /* int ignorelist_match_regex (ignorelist_item_t *item, const char *entry) */
168 #endif
170 /*
171 * check list for entry string match
172 * return 1 if found
173 */
174 static int ignorelist_match_string (ignorelist_item_t *item, const char *entry)
175 {
176 assert ((item != NULL) && (item->smatch != NULL)
177 && (entry != NULL) && (strlen (entry) > 0));
179 if (strcmp (entry, item->smatch) == 0)
180 return (1);
182 return (0);
183 } /* int ignorelist_match_string (ignorelist_item_t *item, const char *entry) */
186 /* *** *** *** ******************************************** *** *** *** */
187 /* *** *** *** *** *** *** public functions *** *** *** *** *** *** */
188 /* *** *** *** ******************************************** *** *** *** */
190 /*
191 * create the ignorelist_t with known ignore state
192 * return pointer to ignorelist_t
193 */
194 ignorelist_t *ignorelist_create (int invert)
195 {
196 ignorelist_t *il;
198 il = malloc (sizeof (*il));
199 if (il == NULL)
200 return NULL;
201 memset (il, 0, sizeof (*il));
203 /*
204 * ->ignore == 0 => collect
205 * ->ignore == 1 => ignore
206 */
207 il->ignore = invert ? 0 : 1;
209 return (il);
210 } /* ignorelist_t *ignorelist_create (int ignore) */
212 /*
213 * free memory used by ignorelist_t
214 */
215 void ignorelist_free (ignorelist_t *il)
216 {
217 ignorelist_item_t *this;
218 ignorelist_item_t *next;
220 if (il == NULL)
221 return;
223 for (this = il->head; this != NULL; this = next)
224 {
225 next = this->next;
226 #if HAVE_REGEX_H
227 if (this->rmatch != NULL)
228 {
229 regfree (this->rmatch);
230 sfree (this->rmatch);
231 this->rmatch = NULL;
232 }
233 #endif
234 if (this->smatch != NULL)
235 {
236 sfree (this->smatch);
237 this->smatch = NULL;
238 }
239 sfree (this);
240 }
242 sfree (il);
243 il = NULL;
244 } /* void ignorelist_destroy (ignorelist_t *il) */
246 /*
247 * set ignore state of the ignorelist_t
248 */
249 void ignorelist_set_invert (ignorelist_t *il, int invert)
250 {
251 if (il == NULL)
252 {
253 DEBUG("ignore call with ignorelist_t == NULL");
254 return;
255 }
257 il->ignore = invert ? 0 : 1;
258 } /* void ignorelist_set_invert (ignorelist_t *il, int ignore) */
260 /*
261 * append entry into ignorelist_t
262 * return 0 for success
263 */
264 int ignorelist_add (ignorelist_t *il, const char *entry)
265 {
266 size_t len;
268 if (il == NULL)
269 {
270 DEBUG ("add called with ignorelist_t == NULL");
271 return (1);
272 }
274 len = strlen (entry);
276 /* append nothing */
277 if (len == 0)
278 {
279 DEBUG("not appending: empty entry");
280 return (1);
281 }
283 #if HAVE_REGEX_H
284 /* regex string is enclosed in "/.../" */
285 if ((len > 2) && (entry[0] == '/') && entry[len - 1] == '/')
286 {
287 char *copy;
288 int status;
290 /* skip leading slash */
291 copy = strdup (entry + 1);
292 if (copy == NULL)
293 return ENOMEM;
295 /* trim trailing slash */
296 copy[strlen (copy) - 1] = 0;
298 status = ignorelist_append_regex (il, copy);
299 sfree (copy);
300 return status;
301 }
302 #endif
304 return ignorelist_append_string(il, entry);
305 } /* int ignorelist_add (ignorelist_t *il, const char *entry) */
307 /*
308 * check list for entry
309 * return 1 for ignored entry
310 */
311 int ignorelist_match (ignorelist_t *il, const char *entry)
312 {
313 ignorelist_item_t *traverse;
315 /* if no entries, collect all */
316 if ((il == NULL) || (il->head == NULL))
317 return (0);
319 if ((entry == NULL) || (strlen (entry) == 0))
320 return (0);
322 /* traverse list and check entries */
323 for (traverse = il->head; traverse != NULL; traverse = traverse->next)
324 {
325 #if HAVE_REGEX_H
326 if (traverse->rmatch != NULL)
327 {
328 if (ignorelist_match_regex (traverse, entry))
329 return (il->ignore);
330 }
331 else
332 #endif
333 {
334 if (ignorelist_match_string (traverse, entry))
335 return (il->ignore);
336 }
337 } /* for traverse */
339 return (1 - il->ignore);
340 } /* int ignorelist_match (ignorelist_t *il, const char *entry) */