2 * collectd - src/filter_chain.h
3 * Copyright (C) 2008,2009 Florian octo Forster
5 * This program is free software; you can redistribute it and/or modify it
6 * under the terms of the GNU General Public License as published by the
7 * Free Software Foundation; only version 2 of the License is applicable.
9 * This program is distributed in the hope that it will be useful, but
10 * WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
12 * General Public License for more details.
14 * You should have received a copy of the GNU General Public License along
15 * with this program; if not, write to the Free Software Foundation, Inc.,
16 * 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
19 * Florian octo Forster <octo at verplant.org>
23 * First tell the compiler to stick to the C99 and POSIX standards as close as
26 #ifndef __STRICT_ANSI__ /* {{{ */
27 # define __STRICT_ANSI__
30 #ifndef _ISOC99_SOURCE
31 # define _ISOC99_SOURCE
34 #ifdef _POSIX_C_SOURCE
35 # undef _POSIX_C_SOURCE
37 #define _POSIX_C_SOURCE 200112L
40 /* Single UNIX needed for strdup. */
44 #define _XOPEN_SOURCE 500
61 #include "configfile.h"
64 #include "filter_chain.h"
69 /* List of matches, used in fc_rule_t and for the global `match_list_head'
72 typedef struct fc_match_s fc_match_t; /* {{{ */
75 char name[DATA_MAX_NAME_LEN];
81 /* List of targets, used in fc_rule_t and for the global `target_list_head'
84 typedef struct fc_target_s fc_target_t; /* {{{ */
87 char name[DATA_MAX_NAME_LEN];
93 /* List of rules, used in fc_chain_t */
95 typedef struct fc_rule_s fc_rule_t; /* {{{ */
98 char name[DATA_MAX_NAME_LEN];
100 fc_target_t *targets;
104 /* List of chains, used for `chain_list_head' */
105 struct fc_chain_s /* {{{ */
107 char name[DATA_MAX_NAME_LEN];
109 fc_target_t *targets;
116 static fc_match_t *match_list_head;
117 static fc_target_t *target_list_head;
118 static fc_chain_t *chain_list_head;
123 static void fc_free_matches (fc_match_t *m) /* {{{ */
128 if (m->proc.destroy != NULL)
129 (*m->proc.destroy) (&m->user_data);
130 else if (m->user_data != NULL)
132 ERROR ("Filter sybsystem: fc_free_matches: There is user data, but no "
133 "destroy functions has been specified. "
134 "Memory will probably be lost!");
138 fc_free_matches (m->next);
141 } /* }}} void fc_free_matches */
143 static void fc_free_targets (fc_target_t *t) /* {{{ */
148 if (t->proc.destroy != NULL)
149 (*t->proc.destroy) (&t->user_data);
150 else if (t->user_data != NULL)
152 ERROR ("Filter sybsystem: fc_free_targets: There is user data, but no "
153 "destroy functions has been specified. "
154 "Memory will probably be lost!");
158 fc_free_targets (t->next);
161 } /* }}} void fc_free_targets */
163 static void fc_free_rules (fc_rule_t *r) /* {{{ */
168 fc_free_matches (r->matches);
169 fc_free_targets (r->targets);
172 fc_free_rules (r->next);
175 } /* }}} void fc_free_rules */
177 static void fc_free_chains (fc_chain_t *c) /* {{{ */
182 fc_free_rules (c->rules);
183 fc_free_targets (c->targets);
186 fc_free_chains (c->next);
189 } /* }}} void fc_free_chains */
191 static char *fc_strdup (const char *orig) /* {{{ */
199 sz = strlen (orig) + 1;
200 dest = (char *) malloc (sz);
204 memcpy (dest, orig, sz);
207 } /* }}} char *fc_strdup */
212 * The configuration looks somewhat like this:
218 * Type "^mysql_command$"
219 * TypeInstance "^show_"
230 static int fc_config_add_match (fc_match_t **matches_head, /* {{{ */
237 if ((ci->values_num != 1)
238 || (ci->values[0].type != OCONFIG_TYPE_STRING))
240 WARNING ("Filter subsystem: `Match' blocks require "
241 "exactly one string argument.");
245 ptr = match_list_head;
248 if (strcasecmp (ptr->name, ci->values[0].value.string) == 0)
255 WARNING ("Filter subsystem: Cannot find a \"%s\" match. "
256 "Did you load the appropriate plugin?",
257 ci->values[0].value.string);
261 m = (fc_match_t *) malloc (sizeof (*m));
264 ERROR ("fc_config_add_match: malloc failed.");
267 memset (m, 0, sizeof (*m));
269 sstrncpy (m->name, ptr->name, sizeof (m->name));
270 memcpy (&m->proc, &ptr->proc, sizeof (m->proc));
274 if (m->proc.create != NULL)
276 status = (*m->proc.create) (ci, &m->user_data);
279 WARNING ("Filter subsystem: Failed to create a %s match.",
286 if (*matches_head != NULL)
289 while (ptr->next != NULL)
300 } /* }}} int fc_config_add_match */
302 static int fc_config_add_target (fc_target_t **targets_head, /* {{{ */
309 if ((ci->values_num != 1)
310 || (ci->values[0].type != OCONFIG_TYPE_STRING))
312 WARNING ("Filter subsystem: `Target' blocks require "
313 "exactly one string argument.");
317 ptr = target_list_head;
320 if (strcasecmp (ptr->name, ci->values[0].value.string) == 0)
327 WARNING ("Filter subsystem: Cannot find a \"%s\" target. "
328 "Did you load the appropriate plugin?",
329 ci->values[0].value.string);
333 t = (fc_target_t *) malloc (sizeof (*t));
336 ERROR ("fc_config_add_target: malloc failed.");
339 memset (t, 0, sizeof (*t));
341 sstrncpy (t->name, ptr->name, sizeof (t->name));
342 memcpy (&t->proc, &ptr->proc, sizeof (t->proc));
346 if (t->proc.create != NULL)
348 status = (*t->proc.create) (ci, &t->user_data);
351 WARNING ("Filter subsystem: Failed to create a %s target.",
362 if (*targets_head != NULL)
365 while (ptr->next != NULL)
376 } /* }}} int fc_config_add_target */
378 static int fc_config_add_rule (fc_chain_t *chain, /* {{{ */
382 char rule_name[2*DATA_MAX_NAME_LEN] = "Unnamed rule";
386 if (ci->values_num > 1)
388 WARNING ("Filter subsystem: `Rule' blocks have at most one argument.");
391 else if ((ci->values_num == 1)
392 && (ci->values[0].type != OCONFIG_TYPE_STRING))
394 WARNING ("Filter subsystem: `Rule' blocks expect one string argument "
395 "or no argument at all.");
399 rule = (fc_rule_t *) malloc (sizeof (*rule));
402 ERROR ("fc_config_add_rule: malloc failed.");
405 memset (rule, 0, sizeof (*rule));
408 if (ci->values_num == 1)
410 sstrncpy (rule->name, ci->values[0].value.string, sizeof (rule->name));
411 ssnprintf (rule_name, sizeof (rule_name), "Rule \"%s\"",
412 ci->values[0].value.string);
415 for (i = 0; i < ci->children_num; i++)
417 oconfig_item_t *option = ci->children + i;
420 if (strcasecmp ("Match", option->key) == 0)
421 status = fc_config_add_match (&rule->matches, option);
422 else if (strcasecmp ("Target", option->key) == 0)
423 status = fc_config_add_target (&rule->targets, option);
426 WARNING ("Filter subsystem: %s: Option `%s' not allowed "
427 "inside a <Rule> block.", rule_name, option->key);
433 } /* for (ci->children) */
435 /* Additional sanity checking. */
438 if (rule->targets == NULL)
440 WARNING ("Filter subsystem: %s: No target has been specified.",
447 } /* while (status == 0) */
451 fc_free_rules (rule);
455 if (chain->rules != NULL)
460 while (ptr->next != NULL)
471 } /* }}} int fc_config_add_rule */
473 static int fc_config_add_chain (const oconfig_item_t *ci) /* {{{ */
479 if ((ci->values_num != 1)
480 || (ci->values[0].type != OCONFIG_TYPE_STRING))
482 WARNING ("Filter subsystem: <Chain> blocks require exactly one "
487 chain = (fc_chain_t *) malloc (sizeof (*chain));
490 ERROR ("fc_config_add_chain: malloc failed.");
493 memset (chain, 0, sizeof (*chain));
494 sstrncpy (chain->name, ci->values[0].value.string, sizeof (chain->name));
496 chain->targets = NULL;
499 for (i = 0; i < ci->children_num; i++)
501 oconfig_item_t *option = ci->children + i;
504 if (strcasecmp ("Rule", option->key) == 0)
505 status = fc_config_add_rule (chain, option);
506 else if (strcasecmp ("Target", option->key) == 0)
507 status = fc_config_add_target (&chain->targets, option);
510 WARNING ("Filter subsystem: Chain %s: Option `%s' not allowed "
511 "inside a <Chain> block.", chain->name, option->key);
517 } /* for (ci->children) */
521 fc_free_chains (chain);
525 if (chain_list_head != NULL)
529 ptr = chain_list_head;
530 while (ptr->next != NULL)
537 chain_list_head = chain;
541 } /* }}} int fc_config_add_chain */
544 * Built-in target "jump"
546 * Prefix `bit' like `_b_uilt-_i_n _t_arget'
548 static int fc_bit_jump_create (const oconfig_item_t *ci, /* {{{ */
551 oconfig_item_t *ci_chain;
553 if (ci->children_num != 1)
555 ERROR ("Filter subsystem: The built-in target `jump' needs exactly "
556 "one `Chain' argument!");
560 ci_chain = ci->children;
561 if (strcasecmp ("Chain", ci_chain->key) != 0)
563 ERROR ("Filter subsystem: The built-in target `jump' does not "
564 "support the configuration option `%s'.",
569 if ((ci_chain->values_num != 1)
570 || (ci_chain->values[0].type != OCONFIG_TYPE_STRING))
572 ERROR ("Filter subsystem: Built-in target `jump': The `Chain' option "
573 "needs exactly one string argument.");
577 *user_data = fc_strdup (ci_chain->values[0].value.string);
578 if (*user_data == NULL)
580 ERROR ("fc_bit_jump_create: fc_strdup failed.");
585 } /* }}} int fc_bit_jump_create */
587 static int fc_bit_jump_destroy (void **user_data) /* {{{ */
589 if (user_data != NULL)
596 } /* }}} int fc_bit_jump_destroy */
598 static int fc_bit_jump_invoke (const data_set_t *ds, /* {{{ */
599 value_list_t *vl, notification_meta_t __attribute__((unused)) **meta,
606 chain_name = *user_data;
608 for (chain = chain_list_head; chain != NULL; chain = chain->next)
609 if (strcasecmp (chain_name, chain->name) == 0)
614 ERROR ("Filter subsystem: Built-in target `jump': There is no chain "
615 "named `%s'.", chain_name);
619 status = fc_process_chain (ds, vl, chain);
622 else if (status == FC_TARGET_STOP)
623 return (FC_TARGET_STOP);
625 return (FC_TARGET_CONTINUE);
626 } /* }}} int fc_bit_jump_invoke */
628 static int fc_bit_stop_invoke (const data_set_t __attribute__((unused)) *ds, /* {{{ */
629 value_list_t __attribute__((unused)) *vl,
630 notification_meta_t __attribute__((unused)) **meta,
631 void __attribute__((unused)) **user_data)
633 return (FC_TARGET_STOP);
634 } /* }}} int fc_bit_stop_invoke */
636 static int fc_bit_return_invoke (const data_set_t __attribute__((unused)) *ds, /* {{{ */
637 value_list_t __attribute__((unused)) *vl,
638 notification_meta_t __attribute__((unused)) **meta,
639 void __attribute__((unused)) **user_data)
641 return (FC_TARGET_RETURN);
642 } /* }}} int fc_bit_return_invoke */
644 static int fc_bit_write_create (const oconfig_item_t *ci, /* {{{ */
650 size_t plugin_list_len;
655 for (i = 0; i < ci->children_num; i++)
657 oconfig_item_t *child = ci->children + i;
661 if (strcasecmp ("Plugin", child->key) != 0)
663 ERROR ("Filter subsystem: The built-in target `write' does not "
664 "support the configuration option `%s'.",
669 for (j = 0; j < child->values_num; j++)
671 if (child->values[j].type != OCONFIG_TYPE_STRING)
673 ERROR ("Filter subsystem: Built-in target `write': "
674 "The `Plugin' option accepts only string arguments.");
678 temp = (char **) realloc (plugin_list, (plugin_list_len + 2)
679 * (sizeof (*plugin_list)));
682 ERROR ("fc_bit_write_create: realloc failed.");
687 plugin_list[plugin_list_len] = fc_strdup (child->values[j].value.string);
688 if (plugin_list[plugin_list_len] == NULL)
690 ERROR ("fc_bit_write_create: fc_strdup failed.");
694 plugin_list[plugin_list_len] = NULL;
695 } /* for (j = 0; j < child->values_num; j++) */
696 } /* for (i = 0; i < ci->children_num; i++) */
698 *user_data = plugin_list;
701 } /* }}} int fc_bit_write_create */
703 static int fc_bit_write_destroy (void **user_data) /* {{{ */
708 if ((user_data == NULL) || (*user_data == NULL))
711 plugin_list = *user_data;
713 for (i = 0; plugin_list[i] != NULL; i++)
714 free (plugin_list[i]);
718 } /* }}} int fc_bit_write_destroy */
720 static int fc_bit_write_invoke (const data_set_t *ds, /* {{{ */
721 value_list_t *vl, notification_meta_t __attribute__((unused)) **meta,
728 if (user_data != NULL)
729 plugin_list = *user_data;
731 if ((plugin_list == NULL) || (plugin_list[0] == NULL))
733 status = plugin_write (/* plugin = */ NULL, ds, vl);
736 INFO ("Filter subsystem: Built-in target `write': Dispatching value to "
737 "all write plugins failed with status %i.", status);
744 for (i = 0; plugin_list[i] != NULL; i++)
746 status = plugin_write (plugin_list[i], ds, vl);
749 INFO ("Filter subsystem: Built-in target `write': Dispatching value to "
750 "the `%s' plugin failed with status %i.", plugin_list[i], status);
752 } /* for (i = 0; plugin_list[i] != NULL; i++) */
755 return (FC_TARGET_CONTINUE);
756 } /* }}} int fc_bit_write_invoke */
758 static int fc_init_once (void) /* {{{ */
766 memset (&tproc, 0, sizeof (tproc));
767 tproc.create = fc_bit_jump_create;
768 tproc.destroy = fc_bit_jump_destroy;
769 tproc.invoke = fc_bit_jump_invoke;
770 fc_register_target ("jump", tproc);
772 memset (&tproc, 0, sizeof (tproc));
774 tproc.destroy = NULL;
775 tproc.invoke = fc_bit_stop_invoke;
776 fc_register_target ("stop", tproc);
778 memset (&tproc, 0, sizeof (tproc));
780 tproc.destroy = NULL;
781 tproc.invoke = fc_bit_return_invoke;
782 fc_register_target ("return", tproc);
784 memset (&tproc, 0, sizeof (tproc));
785 tproc.create = fc_bit_write_create;
786 tproc.destroy = fc_bit_write_destroy;
787 tproc.invoke = fc_bit_write_invoke;
788 fc_register_target ("write", tproc);
792 } /* }}} int fc_init_once */
797 /* Add a match to list of available matches. */
798 int fc_register_match (const char *name, match_proc_t proc) /* {{{ */
802 DEBUG ("fc_register_match (%s);", name);
804 m = (fc_match_t *) malloc (sizeof (*m));
807 memset (m, 0, sizeof (*m));
809 sstrncpy (m->name, name, sizeof (m->name));
810 memcpy (&m->proc, &proc, sizeof (m->proc));
813 if (match_list_head == NULL)
821 ptr = match_list_head;
822 while (ptr->next != NULL)
829 } /* }}} int fc_register_match */
831 /* Add a target to list of available targets. */
832 int fc_register_target (const char *name, target_proc_t proc) /* {{{ */
836 DEBUG ("fc_register_target (%s);", name);
838 t = (fc_target_t *) malloc (sizeof (*t));
841 memset (t, 0, sizeof (*t));
843 sstrncpy (t->name, name, sizeof (t->name));
844 memcpy (&t->proc, &proc, sizeof (t->proc));
847 if (target_list_head == NULL)
849 target_list_head = t;
855 ptr = target_list_head;
856 while (ptr->next != NULL)
863 } /* }}} int fc_register_target */
865 fc_chain_t *fc_chain_get_by_name (const char *chain_name) /* {{{ */
869 if (chain_name == NULL)
872 for (chain = chain_list_head; chain != NULL; chain = chain->next)
873 if (strcasecmp (chain_name, chain->name) == 0)
877 } /* }}} int fc_chain_get_by_name */
879 int fc_process_chain (const data_set_t *ds, value_list_t *vl, /* {{{ */
889 DEBUG ("fc_process_chain (chain = %s);", chain->name);
891 status = FC_TARGET_CONTINUE;
892 for (rule = chain->rules; rule != NULL; rule = rule->next)
896 if (rule->name[0] != 0)
898 DEBUG ("fc_process_chain (%s): Testing the `%s' rule.",
899 chain->name, rule->name);
902 /* N. B.: rule->matches may be NULL. */
903 for (match = rule->matches; match != NULL; match = match->next)
905 /* FIXME: Pass the meta-data to match targets here (when implemented). */
906 status = (*match->proc.match) (ds, vl, /* meta = */ NULL,
910 WARNING ("fc_process_chain (%s): A match failed.", chain->name);
913 else if (status != FC_MATCH_MATCHES)
917 /* for-loop has been aborted: Either error or no match. */
920 status = FC_TARGET_CONTINUE;
924 if (rule->name[0] != 0)
926 DEBUG ("fc_process_chain (%s): Rule `%s' matches.",
927 chain->name, rule->name);
930 for (target = rule->targets; target != NULL; target = target->next)
932 /* If we get here, all matches have matched the value. Execute the
934 /* FIXME: Pass the meta-data to match targets here (when implemented). */
935 status = (*target->proc.invoke) (ds, vl, /* meta = */ NULL,
939 WARNING ("fc_process_chain (%s): A target failed.", chain->name);
942 else if (status == FC_TARGET_CONTINUE)
944 else if (status == FC_TARGET_STOP)
946 else if (status == FC_TARGET_RETURN)
950 WARNING ("fc_process_chain (%s): Unknown return value "
951 "from target `%s': %i",
952 chain->name, target->name, status);
956 if ((status == FC_TARGET_STOP)
957 || (status == FC_TARGET_RETURN))
959 if (rule->name[0] != 0)
961 DEBUG ("fc_process_chain (%s): Rule `%s' signaled "
963 chain->name, rule->name,
964 (status == FC_TARGET_STOP) ? "stop" : "return");
970 status = FC_TARGET_CONTINUE;
974 if (status == FC_TARGET_STOP)
975 return (FC_TARGET_STOP);
976 else if (status == FC_TARGET_RETURN)
977 return (FC_TARGET_CONTINUE);
979 /* for-loop has been aborted: A target returned `FC_TARGET_STOP' */
981 return (FC_TARGET_CONTINUE);
983 DEBUG ("fc_process_chain (%s): Executing the default targets.",
986 status = FC_TARGET_CONTINUE;
987 for (target = chain->targets; target != NULL; target = target->next)
989 /* If we get here, all matches have matched the value. Execute the
991 /* FIXME: Pass the meta-data to match targets here (when implemented). */
992 status = (*target->proc.invoke) (ds, vl, /* meta = */ NULL,
996 WARNING ("fc_process_chain (%s): The default target failed.",
999 else if (status == FC_TARGET_CONTINUE)
1001 else if (status == FC_TARGET_STOP)
1003 else if (status == FC_TARGET_RETURN)
1007 WARNING ("fc_process_chain (%s): Unknown return value "
1008 "from target `%s': %i",
1009 chain->name, target->name, status);
1013 if ((status == FC_TARGET_STOP)
1014 || (status == FC_TARGET_RETURN))
1016 assert (target != NULL);
1017 DEBUG ("fc_process_chain (%s): Default target `%s' signaled "
1018 "the %s condition.",
1019 chain->name, target->name,
1020 (status == FC_TARGET_STOP) ? "stop" : "return");
1021 if (status == FC_TARGET_STOP)
1022 return (FC_TARGET_STOP);
1024 return (FC_TARGET_CONTINUE);
1027 DEBUG ("fc_process_chain (%s): Signaling `continue' at end of chain.",
1030 return (FC_TARGET_CONTINUE);
1031 } /* }}} int fc_process_chain */
1033 /* Iterate over all rules in the chain and execute all targets for which all
1035 int fc_default_action (const data_set_t *ds, value_list_t *vl) /* {{{ */
1037 /* FIXME: Pass the meta-data to match targets here (when implemented). */
1038 return (fc_bit_write_invoke (ds, vl,
1039 /* meta = */ NULL, /* user_data = */ NULL));
1040 } /* }}} int fc_default_action */
1042 int fc_configure (const oconfig_item_t *ci) /* {{{ */
1049 if (strcasecmp ("Chain", ci->key) == 0)
1050 return (fc_config_add_chain (ci));
1052 WARNING ("Filter subsystem: Unknown top level config option `%s'.",
1056 } /* }}} int fc_configure */
1058 /* vim: set sw=2 sts=2 et fdm=marker : */