1 /**
2 * collectd - src/filter_chain.c
3 * Copyright (C) 2008-2010 Florian octo 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 octo Forster <octo at collectd.org>
25 **/
27 #include "collectd.h"
28 #include "configfile.h"
29 #include "plugin.h"
30 #include "utils_complain.h"
31 #include "common.h"
32 #include "filter_chain.h"
34 /*
35 * Data types
36 */
37 /* List of matches, used in fc_rule_t and for the global `match_list_head'
38 * variable. */
39 struct fc_match_s;
40 typedef struct fc_match_s fc_match_t; /* {{{ */
41 struct fc_match_s
42 {
43 char name[DATA_MAX_NAME_LEN];
44 match_proc_t proc;
45 void *user_data;
46 fc_match_t *next;
47 }; /* }}} */
49 /* List of targets, used in fc_rule_t and for the global `target_list_head'
50 * variable. */
51 struct fc_target_s;
52 typedef struct fc_target_s fc_target_t; /* {{{ */
53 struct fc_target_s
54 {
55 char name[DATA_MAX_NAME_LEN];
56 void *user_data;
57 target_proc_t proc;
58 fc_target_t *next;
59 }; /* }}} */
61 /* List of rules, used in fc_chain_t */
62 struct fc_rule_s;
63 typedef struct fc_rule_s fc_rule_t; /* {{{ */
64 struct fc_rule_s
65 {
66 char name[DATA_MAX_NAME_LEN];
67 fc_match_t *matches;
68 fc_target_t *targets;
69 fc_rule_t *next;
70 }; /* }}} */
72 /* List of chains, used for `chain_list_head' */
73 struct fc_chain_s /* {{{ */
74 {
75 char name[DATA_MAX_NAME_LEN];
76 fc_rule_t *rules;
77 fc_target_t *targets;
78 fc_chain_t *next;
79 }; /* }}} */
81 /* Writer configuration. */
82 struct fc_writer_s;
83 typedef struct fc_writer_s fc_writer_t; /* {{{ */
84 struct fc_writer_s
85 {
86 char *plugin;
87 c_complain_t complaint;
88 }; /* }}} */
90 /*
91 * Global variables
92 */
93 static fc_match_t *match_list_head;
94 static fc_target_t *target_list_head;
95 static fc_chain_t *chain_list_head;
97 /*
98 * Private functions
99 */
100 static void fc_free_matches (fc_match_t *m) /* {{{ */
101 {
102 if (m == NULL)
103 return;
105 if (m->proc.destroy != NULL)
106 (*m->proc.destroy) (&m->user_data);
107 else if (m->user_data != NULL)
108 {
109 ERROR ("Filter subsystem: fc_free_matches: There is user data, but no "
110 "destroy functions has been specified. "
111 "Memory will probably be lost!");
112 }
114 if (m->next != NULL)
115 fc_free_matches (m->next);
117 free (m);
118 } /* }}} void fc_free_matches */
120 static void fc_free_targets (fc_target_t *t) /* {{{ */
121 {
122 if (t == NULL)
123 return;
125 if (t->proc.destroy != NULL)
126 (*t->proc.destroy) (&t->user_data);
127 else if (t->user_data != NULL)
128 {
129 ERROR ("Filter subsystem: fc_free_targets: There is user data, but no "
130 "destroy functions has been specified. "
131 "Memory will probably be lost!");
132 }
134 if (t->next != NULL)
135 fc_free_targets (t->next);
137 free (t);
138 } /* }}} void fc_free_targets */
140 static void fc_free_rules (fc_rule_t *r) /* {{{ */
141 {
142 if (r == NULL)
143 return;
145 fc_free_matches (r->matches);
146 fc_free_targets (r->targets);
148 if (r->next != NULL)
149 fc_free_rules (r->next);
151 free (r);
152 } /* }}} void fc_free_rules */
154 static void fc_free_chains (fc_chain_t *c) /* {{{ */
155 {
156 if (c == NULL)
157 return;
159 fc_free_rules (c->rules);
160 fc_free_targets (c->targets);
162 if (c->next != NULL)
163 fc_free_chains (c->next);
165 free (c);
166 } /* }}} void fc_free_chains */
168 static char *fc_strdup (const char *orig) /* {{{ */
169 {
170 size_t sz;
171 char *dest;
173 if (orig == NULL)
174 return (NULL);
176 sz = strlen (orig) + 1;
177 dest = (char *) malloc (sz);
178 if (dest == NULL)
179 return (NULL);
181 memcpy (dest, orig, sz);
183 return (dest);
184 } /* }}} char *fc_strdup */
186 /*
187 * Configuration.
188 *
189 * The configuration looks somewhat like this:
190 *
191 * <Chain "PreCache">
192 * <Rule>
193 * <Match "regex">
194 * Plugin "^mysql$"
195 * Type "^mysql_command$"
196 * TypeInstance "^show_"
197 * </Match>
198 * <Target "drop">
199 * </Target>
200 * </Rule>
201 *
202 * <Target "write">
203 * Plugin "rrdtool"
204 * </Target>
205 * </Chain>
206 */
207 static int fc_config_add_match (fc_match_t **matches_head, /* {{{ */
208 oconfig_item_t *ci)
209 {
210 fc_match_t *m;
211 fc_match_t *ptr;
212 int status;
214 if ((ci->values_num != 1)
215 || (ci->values[0].type != OCONFIG_TYPE_STRING))
216 {
217 WARNING ("Filter subsystem: `Match' blocks require "
218 "exactly one string argument.");
219 return (-1);
220 }
222 ptr = match_list_head;
223 while (ptr != NULL)
224 {
225 if (strcasecmp (ptr->name, ci->values[0].value.string) == 0)
226 break;
227 ptr = ptr->next;
228 }
230 if (ptr == NULL)
231 {
232 WARNING ("Filter subsystem: Cannot find a \"%s\" match. "
233 "Did you load the appropriate plugin?",
234 ci->values[0].value.string);
235 return (-1);
236 }
238 m = (fc_match_t *) malloc (sizeof (*m));
239 if (m == NULL)
240 {
241 ERROR ("fc_config_add_match: malloc failed.");
242 return (-1);
243 }
244 memset (m, 0, sizeof (*m));
246 sstrncpy (m->name, ptr->name, sizeof (m->name));
247 memcpy (&m->proc, &ptr->proc, sizeof (m->proc));
248 m->user_data = NULL;
249 m->next = NULL;
251 if (m->proc.create != NULL)
252 {
253 status = (*m->proc.create) (ci, &m->user_data);
254 if (status != 0)
255 {
256 WARNING ("Filter subsystem: Failed to create a %s match.",
257 m->name);
258 fc_free_matches (m);
259 return (-1);
260 }
261 }
263 if (*matches_head != NULL)
264 {
265 ptr = *matches_head;
266 while (ptr->next != NULL)
267 ptr = ptr->next;
269 ptr->next = m;
270 }
271 else
272 {
273 *matches_head = m;
274 }
276 return (0);
277 } /* }}} int fc_config_add_match */
279 static int fc_config_add_target (fc_target_t **targets_head, /* {{{ */
280 oconfig_item_t *ci)
281 {
282 fc_target_t *t;
283 fc_target_t *ptr;
284 int status;
286 if ((ci->values_num != 1)
287 || (ci->values[0].type != OCONFIG_TYPE_STRING))
288 {
289 WARNING ("Filter subsystem: `Target' blocks require "
290 "exactly one string argument.");
291 return (-1);
292 }
294 ptr = target_list_head;
295 while (ptr != NULL)
296 {
297 if (strcasecmp (ptr->name, ci->values[0].value.string) == 0)
298 break;
299 ptr = ptr->next;
300 }
302 if (ptr == NULL)
303 {
304 WARNING ("Filter subsystem: Cannot find a \"%s\" target. "
305 "Did you load the appropriate plugin?",
306 ci->values[0].value.string);
307 return (-1);
308 }
310 t = (fc_target_t *) malloc (sizeof (*t));
311 if (t == NULL)
312 {
313 ERROR ("fc_config_add_target: malloc failed.");
314 return (-1);
315 }
316 memset (t, 0, sizeof (*t));
318 sstrncpy (t->name, ptr->name, sizeof (t->name));
319 memcpy (&t->proc, &ptr->proc, sizeof (t->proc));
320 t->user_data = NULL;
321 t->next = NULL;
323 if (t->proc.create != NULL)
324 {
325 status = (*t->proc.create) (ci, &t->user_data);
326 if (status != 0)
327 {
328 WARNING ("Filter subsystem: Failed to create a %s target.",
329 t->name);
330 fc_free_targets (t);
331 return (-1);
332 }
333 }
334 else
335 {
336 t->user_data = NULL;
337 }
339 if (*targets_head != NULL)
340 {
341 ptr = *targets_head;
342 while (ptr->next != NULL)
343 ptr = ptr->next;
345 ptr->next = t;
346 }
347 else
348 {
349 *targets_head = t;
350 }
352 return (0);
353 } /* }}} int fc_config_add_target */
355 static int fc_config_add_rule (fc_chain_t *chain, /* {{{ */
356 oconfig_item_t *ci)
357 {
358 fc_rule_t *rule;
359 char rule_name[2*DATA_MAX_NAME_LEN] = "Unnamed rule";
360 int status = 0;
361 int i;
363 if (ci->values_num > 1)
364 {
365 WARNING ("Filter subsystem: `Rule' blocks have at most one argument.");
366 return (-1);
367 }
368 else if ((ci->values_num == 1)
369 && (ci->values[0].type != OCONFIG_TYPE_STRING))
370 {
371 WARNING ("Filter subsystem: `Rule' blocks expect one string argument "
372 "or no argument at all.");
373 return (-1);
374 }
376 rule = (fc_rule_t *) malloc (sizeof (*rule));
377 if (rule == NULL)
378 {
379 ERROR ("fc_config_add_rule: malloc failed.");
380 return (-1);
381 }
382 memset (rule, 0, sizeof (*rule));
383 rule->next = NULL;
385 if (ci->values_num == 1)
386 {
387 sstrncpy (rule->name, ci->values[0].value.string, sizeof (rule->name));
388 ssnprintf (rule_name, sizeof (rule_name), "Rule \"%s\"",
389 ci->values[0].value.string);
390 }
392 for (i = 0; i < ci->children_num; i++)
393 {
394 oconfig_item_t *option = ci->children + i;
395 status = 0;
397 if (strcasecmp ("Match", option->key) == 0)
398 status = fc_config_add_match (&rule->matches, option);
399 else if (strcasecmp ("Target", option->key) == 0)
400 status = fc_config_add_target (&rule->targets, option);
401 else
402 {
403 WARNING ("Filter subsystem: %s: Option `%s' not allowed "
404 "inside a <Rule> block.", rule_name, option->key);
405 status = -1;
406 }
408 if (status != 0)
409 break;
410 } /* for (ci->children) */
412 /* Additional sanity checking. */
413 while (status == 0)
414 {
415 if (rule->targets == NULL)
416 {
417 WARNING ("Filter subsystem: %s: No target has been specified.",
418 rule_name);
419 status = -1;
420 break;
421 }
423 break;
424 } /* while (status == 0) */
426 if (status != 0)
427 {
428 fc_free_rules (rule);
429 return (-1);
430 }
432 if (chain->rules != NULL)
433 {
434 fc_rule_t *ptr;
436 ptr = chain->rules;
437 while (ptr->next != NULL)
438 ptr = ptr->next;
440 ptr->next = rule;
441 }
442 else
443 {
444 chain->rules = rule;
445 }
447 return (0);
448 } /* }}} int fc_config_add_rule */
450 static int fc_config_add_chain (const oconfig_item_t *ci) /* {{{ */
451 {
452 fc_chain_t *chain = NULL;
453 int status = 0;
454 int i;
455 int new_chain = 1;
457 if ((ci->values_num != 1)
458 || (ci->values[0].type != OCONFIG_TYPE_STRING))
459 {
460 WARNING ("Filter subsystem: <Chain> blocks require exactly one "
461 "string argument.");
462 return (-1);
463 }
465 if (chain_list_head != NULL)
466 {
467 if ((chain = fc_chain_get_by_name (ci->values[0].value.string)) != NULL)
468 new_chain = 0;
469 }
471 if (chain == NULL)
472 {
473 chain = (fc_chain_t *) malloc (sizeof (*chain));
474 if (chain == NULL)
475 {
476 ERROR ("fc_config_add_chain: malloc failed.");
477 return (-1);
478 }
479 memset (chain, 0, sizeof (*chain));
480 sstrncpy (chain->name, ci->values[0].value.string, sizeof (chain->name));
481 chain->rules = NULL;
482 chain->targets = NULL;
483 chain->next = NULL;
484 }
486 for (i = 0; i < ci->children_num; i++)
487 {
488 oconfig_item_t *option = ci->children + i;
489 status = 0;
491 if (strcasecmp ("Rule", option->key) == 0)
492 status = fc_config_add_rule (chain, option);
493 else if (strcasecmp ("Target", option->key) == 0)
494 status = fc_config_add_target (&chain->targets, option);
495 else
496 {
497 WARNING ("Filter subsystem: Chain %s: Option `%s' not allowed "
498 "inside a <Chain> block.", chain->name, option->key);
499 status = -1;
500 }
502 if (status != 0)
503 break;
504 } /* for (ci->children) */
506 if (status != 0)
507 {
508 fc_free_chains (chain);
509 return (-1);
510 }
512 if (chain_list_head != NULL)
513 {
514 if (!new_chain)
515 return (0);
517 fc_chain_t *ptr;
519 ptr = chain_list_head;
520 while (ptr->next != NULL)
521 ptr = ptr->next;
523 ptr->next = chain;
524 }
525 else
526 {
527 chain_list_head = chain;
528 }
530 return (0);
531 } /* }}} int fc_config_add_chain */
533 /*
534 * Built-in target "jump"
535 *
536 * Prefix `bit' like `_b_uilt-_i_n _t_arget'
537 */
538 static int fc_bit_jump_create (const oconfig_item_t *ci, /* {{{ */
539 void **user_data)
540 {
541 oconfig_item_t *ci_chain;
543 if (ci->children_num != 1)
544 {
545 ERROR ("Filter subsystem: The built-in target `jump' needs exactly "
546 "one `Chain' argument!");
547 return (-1);
548 }
550 ci_chain = ci->children;
551 if (strcasecmp ("Chain", ci_chain->key) != 0)
552 {
553 ERROR ("Filter subsystem: The built-in target `jump' does not "
554 "support the configuration option `%s'.",
555 ci_chain->key);
556 return (-1);
557 }
559 if ((ci_chain->values_num != 1)
560 || (ci_chain->values[0].type != OCONFIG_TYPE_STRING))
561 {
562 ERROR ("Filter subsystem: Built-in target `jump': The `Chain' option "
563 "needs exactly one string argument.");
564 return (-1);
565 }
567 *user_data = fc_strdup (ci_chain->values[0].value.string);
568 if (*user_data == NULL)
569 {
570 ERROR ("fc_bit_jump_create: fc_strdup failed.");
571 return (-1);
572 }
574 return (0);
575 } /* }}} int fc_bit_jump_create */
577 static int fc_bit_jump_destroy (void **user_data) /* {{{ */
578 {
579 if (user_data != NULL)
580 {
581 free (*user_data);
582 *user_data = NULL;
583 }
585 return (0);
586 } /* }}} int fc_bit_jump_destroy */
588 static int fc_bit_jump_invoke (const data_set_t *ds, /* {{{ */
589 value_list_t *vl, notification_meta_t __attribute__((unused)) **meta,
590 void **user_data)
591 {
592 char *chain_name;
593 fc_chain_t *chain;
594 int status;
596 chain_name = *user_data;
598 for (chain = chain_list_head; chain != NULL; chain = chain->next)
599 if (strcasecmp (chain_name, chain->name) == 0)
600 break;
602 if (chain == NULL)
603 {
604 ERROR ("Filter subsystem: Built-in target `jump': There is no chain "
605 "named `%s'.", chain_name);
606 return (-1);
607 }
609 status = fc_process_chain (ds, vl, chain);
610 if (status < 0)
611 return (status);
612 else if (status == FC_TARGET_STOP)
613 return (FC_TARGET_STOP);
614 else
615 return (FC_TARGET_CONTINUE);
616 } /* }}} int fc_bit_jump_invoke */
618 static int fc_bit_stop_invoke (const data_set_t __attribute__((unused)) *ds, /* {{{ */
619 value_list_t __attribute__((unused)) *vl,
620 notification_meta_t __attribute__((unused)) **meta,
621 void __attribute__((unused)) **user_data)
622 {
623 return (FC_TARGET_STOP);
624 } /* }}} int fc_bit_stop_invoke */
626 static int fc_bit_return_invoke (const data_set_t __attribute__((unused)) *ds, /* {{{ */
627 value_list_t __attribute__((unused)) *vl,
628 notification_meta_t __attribute__((unused)) **meta,
629 void __attribute__((unused)) **user_data)
630 {
631 return (FC_TARGET_RETURN);
632 } /* }}} int fc_bit_return_invoke */
634 static int fc_bit_write_create (const oconfig_item_t *ci, /* {{{ */
635 void **user_data)
636 {
637 int i;
639 fc_writer_t *plugin_list = NULL;
640 size_t plugin_list_len = 0;
642 for (i = 0; i < ci->children_num; i++)
643 {
644 oconfig_item_t *child = ci->children + i;
645 fc_writer_t *temp;
646 int j;
648 if (strcasecmp ("Plugin", child->key) != 0)
649 {
650 ERROR ("Filter subsystem: The built-in target `write' does not "
651 "support the configuration option `%s'.",
652 child->key);
653 continue;
654 }
656 for (j = 0; j < child->values_num; j++)
657 {
658 char *plugin;
660 if (child->values[j].type != OCONFIG_TYPE_STRING)
661 {
662 ERROR ("Filter subsystem: Built-in target `write': "
663 "The `Plugin' option accepts only string arguments.");
664 continue;
665 }
666 plugin = child->values[j].value.string;
668 temp = (fc_writer_t *) realloc (plugin_list, (plugin_list_len + 2)
669 * (sizeof (*plugin_list)));
670 if (temp == NULL)
671 {
672 ERROR ("fc_bit_write_create: realloc failed.");
673 continue;
674 }
675 plugin_list = temp;
677 plugin_list[plugin_list_len].plugin = fc_strdup (plugin);
678 if (plugin_list[plugin_list_len].plugin == NULL)
679 {
680 ERROR ("fc_bit_write_create: fc_strdup failed.");
681 continue;
682 }
683 C_COMPLAIN_INIT (&plugin_list[plugin_list_len].complaint);
684 plugin_list_len++;
685 plugin_list[plugin_list_len].plugin = NULL;
686 } /* for (j = 0; j < child->values_num; j++) */
687 } /* for (i = 0; i < ci->children_num; i++) */
689 *user_data = plugin_list;
691 return (0);
692 } /* }}} int fc_bit_write_create */
694 static int fc_bit_write_destroy (void **user_data) /* {{{ */
695 {
696 fc_writer_t *plugin_list;
697 size_t i;
699 if ((user_data == NULL) || (*user_data == NULL))
700 return (0);
702 plugin_list = *user_data;
704 for (i = 0; plugin_list[i].plugin != NULL; i++)
705 free (plugin_list[i].plugin);
706 free (plugin_list);
708 return (0);
709 } /* }}} int fc_bit_write_destroy */
711 static int fc_bit_write_invoke (const data_set_t *ds, /* {{{ */
712 value_list_t *vl, notification_meta_t __attribute__((unused)) **meta,
713 void **user_data)
714 {
715 fc_writer_t *plugin_list;
716 int status;
718 plugin_list = NULL;
719 if (user_data != NULL)
720 plugin_list = *user_data;
722 if ((plugin_list == NULL) || (plugin_list[0].plugin == NULL))
723 {
724 static c_complain_t write_complaint = C_COMPLAIN_INIT_STATIC;
726 status = plugin_write (/* plugin = */ NULL, ds, vl);
727 if (status == ENOENT)
728 {
729 /* in most cases this is a permanent error, so use the complain
730 * mechanism rather than spamming the logs */
731 c_complain (LOG_INFO, &write_complaint,
732 "Filter subsystem: Built-in target `write': Dispatching value to "
733 "all write plugins failed with status %i (ENOENT). "
734 "Most likely this means you didn't load any write plugins.",
735 status);
737 plugin_log_available_writers ();
738 }
739 else if (status != 0)
740 {
741 /* often, this is a permanent error (e.g. target system unavailable),
742 * so use the complain mechanism rather than spamming the logs */
743 c_complain (LOG_INFO, &write_complaint,
744 "Filter subsystem: Built-in target `write': Dispatching value to "
745 "all write plugins failed with status %i.", status);
746 }
747 else
748 {
749 assert (status == 0);
750 c_release (LOG_INFO, &write_complaint, "Filter subsystem: "
751 "Built-in target `write': Some write plugin is back to normal "
752 "operation. `write' succeeded.");
753 }
754 }
755 else
756 {
757 size_t i;
759 for (i = 0; plugin_list[i].plugin != NULL; i++)
760 {
761 status = plugin_write (plugin_list[i].plugin, ds, vl);
762 if (status != 0)
763 {
764 c_complain (LOG_INFO, &plugin_list[i].complaint,
765 "Filter subsystem: Built-in target `write': Dispatching value to "
766 "the `%s' plugin failed with status %i.",
767 plugin_list[i].plugin, status);
769 plugin_log_available_writers ();
770 }
771 else
772 {
773 c_release (LOG_INFO, &plugin_list[i].complaint,
774 "Filter subsystem: Built-in target `write': Plugin `%s' is back "
775 "to normal operation. `write' succeeded.", plugin_list[i].plugin);
776 }
777 } /* for (i = 0; plugin_list[i] != NULL; i++) */
778 }
780 return (FC_TARGET_CONTINUE);
781 } /* }}} int fc_bit_write_invoke */
783 static int fc_init_once (void) /* {{{ */
784 {
785 static int done = 0;
786 target_proc_t tproc;
788 if (done != 0)
789 return (0);
791 memset (&tproc, 0, sizeof (tproc));
792 tproc.create = fc_bit_jump_create;
793 tproc.destroy = fc_bit_jump_destroy;
794 tproc.invoke = fc_bit_jump_invoke;
795 fc_register_target ("jump", tproc);
797 memset (&tproc, 0, sizeof (tproc));
798 tproc.create = NULL;
799 tproc.destroy = NULL;
800 tproc.invoke = fc_bit_stop_invoke;
801 fc_register_target ("stop", tproc);
803 memset (&tproc, 0, sizeof (tproc));
804 tproc.create = NULL;
805 tproc.destroy = NULL;
806 tproc.invoke = fc_bit_return_invoke;
807 fc_register_target ("return", tproc);
809 memset (&tproc, 0, sizeof (tproc));
810 tproc.create = fc_bit_write_create;
811 tproc.destroy = fc_bit_write_destroy;
812 tproc.invoke = fc_bit_write_invoke;
813 fc_register_target ("write", tproc);
815 done++;
816 return (0);
817 } /* }}} int fc_init_once */
819 /*
820 * Public functions
821 */
822 /* Add a match to list of available matches. */
823 int fc_register_match (const char *name, match_proc_t proc) /* {{{ */
824 {
825 fc_match_t *m;
827 DEBUG ("fc_register_match (%s);", name);
829 m = (fc_match_t *) malloc (sizeof (*m));
830 if (m == NULL)
831 return (-ENOMEM);
832 memset (m, 0, sizeof (*m));
834 sstrncpy (m->name, name, sizeof (m->name));
835 memcpy (&m->proc, &proc, sizeof (m->proc));
836 m->next = NULL;
838 if (match_list_head == NULL)
839 {
840 match_list_head = m;
841 }
842 else
843 {
844 fc_match_t *ptr;
846 ptr = match_list_head;
847 while (ptr->next != NULL)
848 ptr = ptr->next;
850 ptr->next = m;
851 }
853 return (0);
854 } /* }}} int fc_register_match */
856 /* Add a target to list of available targets. */
857 int fc_register_target (const char *name, target_proc_t proc) /* {{{ */
858 {
859 fc_target_t *t;
861 DEBUG ("fc_register_target (%s);", name);
863 t = (fc_target_t *) malloc (sizeof (*t));
864 if (t == NULL)
865 return (-ENOMEM);
866 memset (t, 0, sizeof (*t));
868 sstrncpy (t->name, name, sizeof (t->name));
869 memcpy (&t->proc, &proc, sizeof (t->proc));
870 t->next = NULL;
872 if (target_list_head == NULL)
873 {
874 target_list_head = t;
875 }
876 else
877 {
878 fc_target_t *ptr;
880 ptr = target_list_head;
881 while (ptr->next != NULL)
882 ptr = ptr->next;
884 ptr->next = t;
885 }
887 return (0);
888 } /* }}} int fc_register_target */
890 fc_chain_t *fc_chain_get_by_name (const char *chain_name) /* {{{ */
891 {
892 fc_chain_t *chain;
894 if (chain_name == NULL)
895 return (NULL);
897 for (chain = chain_list_head; chain != NULL; chain = chain->next)
898 if (strcasecmp (chain_name, chain->name) == 0)
899 return (chain);
901 return (NULL);
902 } /* }}} int fc_chain_get_by_name */
904 int fc_process_chain (const data_set_t *ds, value_list_t *vl, /* {{{ */
905 fc_chain_t *chain)
906 {
907 fc_rule_t *rule;
908 fc_target_t *target;
909 int status;
911 if (chain == NULL)
912 return (-1);
914 DEBUG ("fc_process_chain (chain = %s);", chain->name);
916 status = FC_TARGET_CONTINUE;
917 for (rule = chain->rules; rule != NULL; rule = rule->next)
918 {
919 fc_match_t *match;
921 if (rule->name[0] != 0)
922 {
923 DEBUG ("fc_process_chain (%s): Testing the `%s' rule.",
924 chain->name, rule->name);
925 }
927 /* N. B.: rule->matches may be NULL. */
928 for (match = rule->matches; match != NULL; match = match->next)
929 {
930 /* FIXME: Pass the meta-data to match targets here (when implemented). */
931 status = (*match->proc.match) (ds, vl, /* meta = */ NULL,
932 &match->user_data);
933 if (status < 0)
934 {
935 WARNING ("fc_process_chain (%s): A match failed.", chain->name);
936 break;
937 }
938 else if (status != FC_MATCH_MATCHES)
939 break;
940 }
942 /* for-loop has been aborted: Either error or no match. */
943 if (match != NULL)
944 {
945 status = FC_TARGET_CONTINUE;
946 continue;
947 }
949 if (rule->name[0] != 0)
950 {
951 DEBUG ("fc_process_chain (%s): Rule `%s' matches.",
952 chain->name, rule->name);
953 }
955 for (target = rule->targets; target != NULL; target = target->next)
956 {
957 /* If we get here, all matches have matched the value. Execute the
958 * target. */
959 /* FIXME: Pass the meta-data to match targets here (when implemented). */
960 status = (*target->proc.invoke) (ds, vl, /* meta = */ NULL,
961 &target->user_data);
962 if (status < 0)
963 {
964 WARNING ("fc_process_chain (%s): A target failed.", chain->name);
965 continue;
966 }
967 else if (status == FC_TARGET_CONTINUE)
968 continue;
969 else if (status == FC_TARGET_STOP)
970 break;
971 else if (status == FC_TARGET_RETURN)
972 break;
973 else
974 {
975 WARNING ("fc_process_chain (%s): Unknown return value "
976 "from target `%s': %i",
977 chain->name, target->name, status);
978 }
979 }
981 if ((status == FC_TARGET_STOP)
982 || (status == FC_TARGET_RETURN))
983 {
984 if (rule->name[0] != 0)
985 {
986 DEBUG ("fc_process_chain (%s): Rule `%s' signaled "
987 "the %s condition.",
988 chain->name, rule->name,
989 (status == FC_TARGET_STOP) ? "stop" : "return");
990 }
991 break;
992 }
993 else
994 {
995 status = FC_TARGET_CONTINUE;
996 }
997 } /* for (rule) */
999 if (status == FC_TARGET_STOP)
1000 return (FC_TARGET_STOP);
1001 else if (status == FC_TARGET_RETURN)
1002 return (FC_TARGET_CONTINUE);
1004 /* for-loop has been aborted: A target returned `FC_TARGET_STOP' */
1005 if (rule != NULL)
1006 return (FC_TARGET_CONTINUE);
1008 DEBUG ("fc_process_chain (%s): Executing the default targets.",
1009 chain->name);
1011 status = FC_TARGET_CONTINUE;
1012 for (target = chain->targets; target != NULL; target = target->next)
1013 {
1014 /* If we get here, all matches have matched the value. Execute the
1015 * target. */
1016 /* FIXME: Pass the meta-data to match targets here (when implemented). */
1017 status = (*target->proc.invoke) (ds, vl, /* meta = */ NULL,
1018 &target->user_data);
1019 if (status < 0)
1020 {
1021 WARNING ("fc_process_chain (%s): The default target failed.",
1022 chain->name);
1023 }
1024 else if (status == FC_TARGET_CONTINUE)
1025 continue;
1026 else if (status == FC_TARGET_STOP)
1027 break;
1028 else if (status == FC_TARGET_RETURN)
1029 break;
1030 else
1031 {
1032 WARNING ("fc_process_chain (%s): Unknown return value "
1033 "from target `%s': %i",
1034 chain->name, target->name, status);
1035 }
1036 }
1038 if ((status == FC_TARGET_STOP)
1039 || (status == FC_TARGET_RETURN))
1040 {
1041 assert (target != NULL);
1042 DEBUG ("fc_process_chain (%s): Default target `%s' signaled "
1043 "the %s condition.",
1044 chain->name, target->name,
1045 (status == FC_TARGET_STOP) ? "stop" : "return");
1046 if (status == FC_TARGET_STOP)
1047 return (FC_TARGET_STOP);
1048 else
1049 return (FC_TARGET_CONTINUE);
1050 }
1052 DEBUG ("fc_process_chain (%s): Signaling `continue' at end of chain.",
1053 chain->name);
1055 return (FC_TARGET_CONTINUE);
1056 } /* }}} int fc_process_chain */
1058 /* Iterate over all rules in the chain and execute all targets for which all
1059 * matches match. */
1060 int fc_default_action (const data_set_t *ds, value_list_t *vl) /* {{{ */
1061 {
1062 /* FIXME: Pass the meta-data to match targets here (when implemented). */
1063 return (fc_bit_write_invoke (ds, vl,
1064 /* meta = */ NULL, /* user_data = */ NULL));
1065 } /* }}} int fc_default_action */
1067 int fc_configure (const oconfig_item_t *ci) /* {{{ */
1068 {
1069 fc_init_once ();
1071 if (ci == NULL)
1072 return (-EINVAL);
1074 if (strcasecmp ("Chain", ci->key) == 0)
1075 return (fc_config_add_chain (ci));
1077 WARNING ("Filter subsystem: Unknown top level config option `%s'.",
1078 ci->key);
1080 return (-1);
1081 } /* }}} int fc_configure */
1083 /* vim: set sw=2 sts=2 et fdm=marker : */