2 * collectd - src/filter_chain.h
3 * Copyright (C) 2008 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' */
106 typedef struct fc_chain_s fc_chain_t; /* {{{ */
109 char name[DATA_MAX_NAME_LEN];
111 fc_target_t *targets;
118 static fc_match_t *match_list_head;
119 static fc_target_t *target_list_head;
120 static fc_chain_t *chain_list_head;
125 static void fc_free_matches (fc_match_t *m) /* {{{ */
130 if (m->proc.destroy != NULL)
131 (*m->proc.destroy) (&m->user_data);
132 else if (m->user_data != NULL)
134 ERROR ("Filter sybsystem: fc_free_matches: There is user data, but no "
135 "destroy functions has been specified. "
136 "Memory will probably be lost!");
140 fc_free_matches (m->next);
143 } /* }}} void fc_free_matches */
145 static void fc_free_targets (fc_target_t *t) /* {{{ */
150 if (t->proc.destroy != NULL)
151 (*t->proc.destroy) (&t->user_data);
152 else if (t->user_data != NULL)
154 ERROR ("Filter sybsystem: fc_free_targets: There is user data, but no "
155 "destroy functions has been specified. "
156 "Memory will probably be lost!");
160 fc_free_targets (t->next);
163 } /* }}} void fc_free_targets */
165 static void fc_free_rules (fc_rule_t *r) /* {{{ */
170 fc_free_matches (r->matches);
171 fc_free_targets (r->targets);
174 fc_free_rules (r->next);
177 } /* }}} void fc_free_rules */
179 static void fc_free_chains (fc_chain_t *c) /* {{{ */
184 fc_free_rules (c->rules);
185 fc_free_targets (c->targets);
188 fc_free_chains (c->next);
191 } /* }}} void fc_free_chains */
193 static char *fc_strdup (const char *orig) /* {{{ */
201 sz = strlen (orig) + 1;
202 dest = (char *) malloc (sz);
206 memcpy (dest, orig, sz);
209 } /* }}} char *fc_strdup */
214 * The configuration looks somewhat like this:
220 * Type "^mysql_command$"
221 * TypeInstance "^show_"
232 static int fc_config_add_match (fc_match_t **matches_head, /* {{{ */
239 if ((ci->values_num != 1)
240 || (ci->values[0].type != OCONFIG_TYPE_STRING))
242 WARNING ("Filter subsystem: `Match' blocks require "
243 "exactly one string argument.");
247 ptr = match_list_head;
250 if (strcasecmp (ptr->name, ci->values[0].value.string) == 0)
257 WARNING ("Filter subsystem: Cannot find a \"%s\" match. "
258 "Did you load the appropriate plugin?",
259 ci->values[0].value.string);
263 m = (fc_match_t *) malloc (sizeof (*m));
266 ERROR ("fc_config_add_match: malloc failed.");
269 memset (m, 0, sizeof (*m));
271 sstrncpy (m->name, ptr->name, sizeof (m->name));
272 memcpy (&m->proc, &ptr->proc, sizeof (m->proc));
273 assert (m->proc.create != NULL);
277 status = (*m->proc.create) (ci, &m->user_data);
280 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_match: 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 match.",
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) */
519 /* Additional sanity checking. */
522 if (chain->targets == NULL)
524 WARNING ("Filter subsystem: Chain %s: No default target has been "
525 "specified. Please make sure that there is a <Target> block within "
526 "the <Chain> block!", chain->name);
532 } /* while (status == 0) */
536 fc_free_chains (chain);
540 if (chain_list_head != NULL)
544 ptr = chain_list_head;
545 while (ptr->next != NULL)
552 chain_list_head = chain;
556 } /* }}} int fc_config_add_chain */
558 int fc_process_chain (const data_set_t *ds, value_list_t *vl, /* {{{ */
568 DEBUG ("fc_process_chain (chain = %s);", chain->name);
570 status = FC_TARGET_CONTINUE;
571 for (rule = chain->rules; rule != NULL; rule = rule->next)
575 if (rule->name[0] != 0)
577 DEBUG ("fc_process_chain (%s): Testing the `%s' rule.",
578 chain->name, rule->name);
581 /* N. B.: rule->matches may be NULL. */
582 for (match = rule->matches; match != NULL; match = match->next)
584 status = (*match->proc.match) (ds, vl, /* meta = */ NULL,
588 WARNING ("fc_process_chain (%s): A match failed.", chain->name);
591 else if (status != FC_MATCH_MATCHES)
595 /* for-loop has been aborted: Either error or no match. */
598 status = FC_TARGET_CONTINUE;
602 if (rule->name[0] != 0)
604 DEBUG ("fc_process_chain (%s): Rule `%s' matches.",
605 chain->name, rule->name);
608 for (target = rule->targets; target != NULL; target = target->next)
610 /* If we get here, all matches have matched the value. Execute the
612 status = (*target->proc.invoke) (ds, vl, /* meta = */ NULL,
616 WARNING ("fc_process_chain (%s): A target failed.", chain->name);
619 else if (status == FC_TARGET_CONTINUE)
621 else if (status == FC_TARGET_STOP)
623 else if (status == FC_TARGET_RETURN)
627 WARNING ("fc_process_chain (%s): Unknown return value "
628 "from target `%s': %i",
629 chain->name, target->name, status);
633 if ((status == FC_TARGET_STOP)
634 || (status == FC_TARGET_RETURN))
636 if (rule->name[0] != 0)
638 DEBUG ("fc_process_chain (%s): Rule `%s' signaled "
640 chain->name, rule->name,
641 (status == FC_TARGET_STOP) ? "stop" : "return");
647 status = FC_TARGET_CONTINUE;
651 if (status == FC_TARGET_STOP)
652 return (FC_TARGET_STOP);
653 else if (status == FC_TARGET_RETURN)
654 return (FC_TARGET_CONTINUE);
656 /* for-loop has been aborted: A target returned `FC_TARGET_STOP' */
658 return (FC_TARGET_CONTINUE);
660 DEBUG ("fc_process_chain (%s): Executing the default targets.",
663 status = FC_TARGET_CONTINUE;
664 for (target = chain->targets; target != NULL; target = target->next)
666 /* If we get here, all matches have matched the value. Execute the
668 status = (*target->proc.invoke) (ds, vl, /* meta = */ NULL,
672 WARNING ("fc_process_chain (%s): The default target failed.",
675 else if (status == FC_TARGET_CONTINUE)
677 else if (status == FC_TARGET_STOP)
679 else if (status == FC_TARGET_RETURN)
683 WARNING ("fc_process_chain (%s): Unknown return value "
684 "from target `%s': %i",
685 chain->name, target->name, status);
689 if ((status == FC_TARGET_STOP)
690 || (status == FC_TARGET_RETURN))
692 assert (target != NULL);
693 DEBUG ("fc_process_chain (%s): Default target `%s' signaled "
695 chain->name, target->name,
696 (status == FC_TARGET_STOP) ? "stop" : "return");
697 if (status == FC_TARGET_STOP)
698 return (FC_TARGET_STOP);
700 return (FC_TARGET_CONTINUE);
703 DEBUG ("fc_process_chain (%s): Signaling `continue' at end of chain.",
706 return (FC_TARGET_CONTINUE);
707 } /* }}} int fc_process_chain */
710 * Built-in target "jump"
712 * Prefix `bit' like `_b_uilt-_i_n _t_arget'
714 static int fc_bit_jump_create (const oconfig_item_t *ci, /* {{{ */
717 oconfig_item_t *ci_chain;
719 if (ci->children_num != 1)
721 ERROR ("Filter subsystem: The built-in target `jump' needs exactly "
722 "one `Chain' argument!");
726 ci_chain = ci->children;
727 if (strcasecmp ("Chain", ci_chain->key) != 0)
729 ERROR ("Filter subsystem: The built-in target `jump' does not "
730 "support the configuration option `%s'.",
735 if ((ci_chain->values_num != 1)
736 || (ci_chain->values[0].type != OCONFIG_TYPE_STRING))
738 ERROR ("Filter subsystem: Built-in target `jump': The `Chain' option "
739 "needs exactly one string argument.");
743 *user_data = fc_strdup (ci_chain->values[0].value.string);
744 if (*user_data == NULL)
746 ERROR ("fc_bit_jump_create: fc_strdup failed.");
751 } /* }}} int fc_bit_jump_create */
753 static int fc_bit_jump_destroy (void **user_data) /* {{{ */
755 if (user_data != NULL)
762 } /* }}} int fc_bit_jump_destroy */
764 static int fc_bit_jump_invoke (const data_set_t *ds, /* {{{ */
765 value_list_t *vl, notification_meta_t **meta, void **user_data)
771 chain_name = *user_data;
773 for (chain = chain_list_head; chain != NULL; chain = chain->next)
774 if (strcasecmp (chain_name, chain->name) == 0)
779 ERROR ("Filter subsystem: Built-in target `jump': There is no chain "
780 "named `%s'.", chain_name);
784 status = fc_process_chain (ds, vl, chain);
787 else if (status == FC_TARGET_STOP)
788 return (FC_TARGET_STOP);
790 return (FC_TARGET_CONTINUE);
791 } /* }}} int fc_bit_jump_invoke */
793 static int fc_bit_stop_invoke (const data_set_t *ds, /* {{{ */
794 value_list_t *vl, notification_meta_t **meta, void **user_data)
796 return (FC_TARGET_STOP);
797 } /* }}} int fc_bit_stop_invoke */
799 static int fc_bit_return_invoke (const data_set_t *ds, /* {{{ */
800 value_list_t *vl, notification_meta_t **meta, void **user_data)
802 return (FC_TARGET_RETURN);
803 } /* }}} int fc_bit_return_invoke */
805 static int fc_bit_write_create (const oconfig_item_t *ci, /* {{{ */
811 size_t plugin_list_len;
816 for (i = 0; i < ci->children_num; i++)
818 oconfig_item_t *child = ci->children + i;
822 if (strcasecmp ("Plugin", child->key) != 0)
824 ERROR ("Filter subsystem: The built-in target `write' does not "
825 "support the configuration option `%s'.",
830 for (j = 0; j < child->values_num; j++)
832 if (child->values[j].type != OCONFIG_TYPE_STRING)
834 ERROR ("Filter subsystem: Built-in target `write': "
835 "The `Plugin' option accepts only string arguments.");
839 temp = (char **) realloc (plugin_list, (plugin_list_len + 2)
840 * (sizeof (*plugin_list)));
843 ERROR ("fc_bit_write_create: realloc failed.");
848 plugin_list[plugin_list_len] = fc_strdup (child->values[j].value.string);
849 if (plugin_list[plugin_list_len] == NULL)
851 ERROR ("fc_bit_write_create: fc_strdup failed.");
855 plugin_list[plugin_list_len] = NULL;
856 } /* for (j = 0; j < child->values_num; j++) */
857 } /* for (i = 0; i < ci->children_num; i++) */
859 *user_data = plugin_list;
862 } /* }}} int fc_bit_write_create */
864 static int fc_bit_write_destroy (void **user_data) /* {{{ */
869 if ((user_data == NULL) || (*user_data == NULL))
872 plugin_list = *user_data;
874 for (i = 0; plugin_list[i] != NULL; i++)
875 free (plugin_list[i]);
879 } /* }}} int fc_bit_write_destroy */
881 static int fc_bit_write_invoke (const data_set_t *ds, /* {{{ */
882 value_list_t *vl, notification_meta_t **meta, void **user_data)
888 if (user_data != NULL)
889 plugin_list = *user_data;
891 if ((plugin_list == NULL) || (plugin_list[0] == NULL))
893 status = plugin_write (/* plugin = */ NULL, ds, vl);
896 INFO ("Filter subsystem: Built-in target `write': Dispatching value to "
897 "all write plugins failed with status %i.", status);
904 for (i = 0; plugin_list[i] != NULL; i++)
906 status = plugin_write (plugin_list[i], ds, vl);
909 INFO ("Filter subsystem: Built-in target `write': Dispatching value to "
910 "the `%s' plugin failed with status %i.", plugin_list[i], status);
912 } /* for (i = 0; plugin_list[i] != NULL; i++) */
915 return (FC_TARGET_CONTINUE);
916 } /* }}} int fc_bit_write_invoke */
918 static int fc_init_once (void) /* {{{ */
926 memset (&tproc, 0, sizeof (tproc));
927 tproc.create = fc_bit_jump_create;
928 tproc.destroy = fc_bit_jump_destroy;
929 tproc.invoke = fc_bit_jump_invoke;
930 fc_register_target ("jump", tproc);
932 memset (&tproc, 0, sizeof (tproc));
934 tproc.destroy = NULL;
935 tproc.invoke = fc_bit_stop_invoke;
936 fc_register_target ("stop", tproc);
938 memset (&tproc, 0, sizeof (tproc));
940 tproc.destroy = NULL;
941 tproc.invoke = fc_bit_return_invoke;
942 fc_register_target ("return", tproc);
944 memset (&tproc, 0, sizeof (tproc));
945 tproc.create = fc_bit_write_create;
946 tproc.destroy = fc_bit_write_destroy;
947 tproc.invoke = fc_bit_write_invoke;
948 fc_register_target ("write", tproc);
952 } /* }}} int fc_init_once */
957 /* Add a match to list of available matches. */
958 int fc_register_match (const char *name, match_proc_t proc) /* {{{ */
962 DEBUG ("fc_register_match (%s);", name);
964 m = (fc_match_t *) malloc (sizeof (*m));
967 memset (m, 0, sizeof (*m));
969 sstrncpy (m->name, name, sizeof (m->name));
970 memcpy (&m->proc, &proc, sizeof (m->proc));
973 if (match_list_head == NULL)
981 ptr = match_list_head;
982 while (ptr->next != NULL)
989 } /* }}} int fc_register_match */
991 /* Add a target to list of available targets. */
992 int fc_register_target (const char *name, target_proc_t proc) /* {{{ */
996 DEBUG ("fc_register_target (%s);", name);
998 t = (fc_target_t *) malloc (sizeof (*t));
1001 memset (t, 0, sizeof (*t));
1003 sstrncpy (t->name, name, sizeof (t->name));
1004 memcpy (&t->proc, &proc, sizeof (t->proc));
1007 if (target_list_head == NULL)
1009 target_list_head = t;
1015 ptr = target_list_head;
1016 while (ptr->next != NULL)
1023 } /* }}} int fc_register_target */
1025 /* Iterate over all rules in the chain and execute all targets for which all
1027 int fc_process (const data_set_t *ds, value_list_t *vl) /* {{{ */
1031 for (chain = chain_list_head; chain != NULL; chain = chain->next)
1032 if (strcasecmp ("Main", chain->name) == 0)
1036 return (fc_process_chain (ds, vl, chain));
1038 return (fc_bit_write_invoke (ds, vl,
1039 /* meta = */ NULL, /* user_data = */ NULL));
1040 } /* }}} int fc_process */
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 : */