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_fule_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));
343 assert (t->proc.create != NULL);
347 status = (*t->proc.create) (ci, &t->user_data);
350 WARNING ("Filter subsystem: Failed to create a %s match.",
356 if (*targets_head != NULL)
359 while (ptr->next != NULL)
370 } /* }}} int fc_config_add_target */
372 static int fc_config_add_rule (fc_chain_t *chain, /* {{{ */
376 char rule_name[2*DATA_MAX_NAME_LEN] = "Unnamed rule";
380 if (ci->values_num > 1)
382 WARNING ("Filter subsystem: `Rule' blocks have at most one argument.");
385 else if ((ci->values_num == 1)
386 && (ci->values[0].type != OCONFIG_TYPE_STRING))
388 WARNING ("Filter subsystem: `Rule' blocks expect one string argument "
389 "or no argument at all.");
393 rule = (fc_rule_t *) malloc (sizeof (*rule));
396 ERROR ("fc_config_add_rule: malloc failed.");
399 memset (rule, 0, sizeof (*rule));
402 if (ci->values_num == 1)
404 sstrncpy (rule->name, ci->values[0].value.string, sizeof (rule->name));
405 ssnprintf (rule_name, sizeof (rule_name), "Rule \"%s\"",
406 ci->values[0].value.string);
409 for (i = 0; i < ci->children_num; i++)
411 oconfig_item_t *option = ci->children + i;
414 if (strcasecmp ("Match", option->key) == 0)
415 status = fc_config_add_match (&rule->matches, option);
416 else if (strcasecmp ("Target", option->key) == 0)
417 status = fc_config_add_target (&rule->targets, option);
420 WARNING ("Filter subsystem: %s: Option `%s' not allowed "
421 "inside a <Rule> block.", rule_name, option->key);
427 } /* for (ci->children) */
429 /* Additional sanity checking. */
432 if (rule->targets == NULL)
434 WARNING ("Filter subsystem: %s: No target has been specified.",
441 } /* while (status == 0) */
445 fc_free_rules (rule);
449 if (chain->rules != NULL)
454 while (ptr->next != NULL)
465 } /* }}} int fc_config_add_rule */
467 static int fc_config_add_chain (const oconfig_item_t *ci) /* {{{ */
473 if ((ci->values_num != 1)
474 || (ci->values[0].type != OCONFIG_TYPE_STRING))
476 WARNING ("Filter subsystem: <Chain> blocks require exactly one "
481 chain = (fc_chain_t *) malloc (sizeof (*chain));
484 ERROR ("fc_config_add_chain: malloc failed.");
487 memset (chain, 0, sizeof (*chain));
488 sstrncpy (chain->name, ci->values[0].value.string, sizeof (chain->name));
490 chain->targets = NULL;
493 for (i = 0; i < ci->children_num; i++)
495 oconfig_item_t *option = ci->children + i;
498 if (strcasecmp ("Rule", option->key) == 0)
499 status = fc_config_add_rule (chain, option);
502 WARNING ("Filter subsystem: Chain %s: Option `%s' not allowed "
503 "inside a <Chain> block.", chain->name, option->key);
509 } /* for (ci->children) */
511 /* Additional sanity checking. */
514 if (chain->targets == NULL)
516 WARNING ("Filter subsystem: Chain %s: No default target has been "
517 "specified. Please make sure that there is a <Target> block within "
518 "the <Chain> block!", chain->name);
524 } /* while (status == 0) */
528 fc_free_chains (chain);
532 if (chain_list_head != NULL)
536 ptr = chain_list_head;
537 while (ptr->next != NULL)
544 chain_list_head = chain;
548 } /* }}} int fc_config_add_chain */
550 int fc_process_chain (const data_set_t *ds, value_list_t *vl, /* {{{ */
560 status = FC_ACTION_CONTINUE;
562 for (rule = chain->rules; rule != NULL; rule = rule->next)
566 /* N. B.: rule->matches may be NULL. */
567 for (match = rule->matches; match != NULL; match = match->next)
569 status = (*match->proc.match) (ds, vl, /* meta = */ NULL,
573 WARNING ("fc_process: A match failed.");
576 else if (status != FC_MATCH_MATCHES)
580 /* for-loop has been aborted: Either error or no match. */
584 for (target = rule->targets; target != NULL; target = target->next)
586 /* If we get here, all matches have matched the value. Execute the target. */
587 status = (*target->proc.invoke) (ds, vl, /* meta = */ NULL,
591 WARNING ("fc_process: A target failed.");
594 else if (status == FC_ACTION_CONTINUE)
596 else if (status == FC_ACTION_STOP)
600 WARNING ("fc_process: Unknown target return value: %i", status);
604 if (status == FC_ACTION_STOP)
608 /* for-loop has been aborted: A target returned `FC_ACTION_STOP' */
612 for (target = chain->targets; target != NULL; target = target->next)
614 /* If we get here, all matches have matched the value. Execute the target. */
615 status = (*target->proc.invoke) (ds, vl, /* meta = */ NULL,
619 WARNING ("fc_process: The default target failed.");
624 } /* }}} int fc_process_chain */
627 * Built-in target "jump"
629 * Prefix `bit' like `_b_uilt-_i_n _t_arget'
631 static int fc_bit_jump_create (const oconfig_item_t *ci, /* {{{ */
634 oconfig_item_t *ci_chain;
636 if (ci->children_num != 1)
638 ERROR ("Filter subsystem: The built-in target `jump' needs exactly "
639 "one `Chain' argument!");
643 ci_chain = ci->children;
644 if (strcasecmp ("Chain", ci_chain->key) != 0)
646 ERROR ("Filter subsystem: The built-in target `jump' does not "
647 "support the configuration option `%s'.",
652 if ((ci_chain->values_num != 1)
653 || (ci_chain->values[0].type != OCONFIG_TYPE_STRING))
655 ERROR ("Filter subsystem: Built-in target `jump': The `Chain' option "
656 "needs exactly one string argument.");
660 *user_data = fc_strdup (ci_chain->values[0].value.string);
661 if (*user_data == NULL)
663 ERROR ("fc_bit_jump_create: fc_strdup failed.");
668 } /* }}} int fc_bit_jump_create */
670 static int fc_bit_jump_destroy (void **user_data) /* {{{ */
672 if (user_data != NULL)
679 } /* }}} int fc_bit_jump_destroy */
681 static int fc_bit_jump_invoke (const data_set_t *ds, /* {{{ */
682 value_list_t *vl, notification_meta_t **meta, void **user_data)
688 chain_name = *user_data;
690 for (chain = chain_list_head; chain != NULL; chain = chain->next)
691 if (strcasecmp (chain_name, chain->name) == 0)
696 ERROR ("Filter subsystem: Built-in target `jump': There is no chain "
697 "named `%s'.", chain_name);
701 status = fc_process_chain (ds, vl, chain);
705 return (FC_ACTION_CONTINUE);
706 } /* }}} int fc_bit_jump_invoke */
708 static int fc_bit_stop_invoke (const data_set_t *ds, /* {{{ */
709 value_list_t *vl, notification_meta_t **meta, void **user_data)
711 return (FC_ACTION_STOP);
712 } /* }}} int fc_bit_stop_invoke */
714 static int fc_bit_write_create (const oconfig_item_t *ci, /* {{{ */
720 size_t plugin_list_len;
725 for (i = 0; i < ci->children_num; i++)
727 oconfig_item_t *child = ci->children + i;
731 if (strcasecmp ("Plugin", child->key) != 0)
733 ERROR ("Filter subsystem: The built-in target `write' does not "
734 "support the configuration option `%s'.",
739 for (j = 0; j < child->values_num; j++)
741 if (child->values[j].type != OCONFIG_TYPE_STRING)
743 ERROR ("Filter subsystem: Built-in target `write': "
744 "The `Plugin' option accepts only string arguments.");
748 temp = (char **) realloc (plugin_list, (plugin_list_len + 2)
749 * (sizeof (*plugin_list)));
752 ERROR ("fc_bit_write_create: realloc failed.");
757 plugin_list[plugin_list_len] = fc_strdup (child->values[j].value.string);
758 if (plugin_list[plugin_list_len] == NULL)
760 ERROR ("fc_bit_write_create: fc_strdup failed.");
764 plugin_list[plugin_list_len] = NULL;
765 } /* for (j = 0; j < child->values_num; j++) */
766 } /* for (i = 0; i < ci->children_num; i++) */
768 *user_data = plugin_list;
771 } /* }}} int fc_bit_write_create */
773 static int fc_bit_write_destroy (void **user_data) /* {{{ */
778 if ((user_data == NULL) || (*user_data == NULL))
781 plugin_list = *user_data;
783 for (i = 0; plugin_list[i] != NULL; i++)
784 free (plugin_list[i]);
788 } /* }}} int fc_bit_write_destroy */
790 static int fc_bit_write_invoke (const data_set_t *ds, /* {{{ */
791 value_list_t *vl, notification_meta_t **meta, void **user_data)
797 if (user_data != NULL)
798 plugin_list = *user_data;
800 if ((plugin_list == NULL) || (plugin_list[0] == NULL))
802 status = plugin_write (/* plugin = */ NULL, ds, vl);
805 INFO ("Filter subsystem: Built-in target `write': Dispatching value to "
806 "all write plugins failed with status %i.", status);
813 for (i = 0; plugin_list[i] != NULL; i++)
815 status = plugin_write (plugin_list[i], ds, vl);
818 INFO ("Filter subsystem: Built-in target `write': Dispatching value to "
819 "the `%s' plugin failed with status %i.", plugin_list[i], status);
821 } /* for (i = 0; plugin_list[i] != NULL; i++) */
824 return (FC_ACTION_CONTINUE);
825 } /* }}} int fc_bit_write_invoke */
827 static int fc_init_once (void) /* {{{ */
835 memset (&tproc, 0, sizeof (tproc));
836 tproc.create = fc_bit_jump_create;
837 tproc.destroy = fc_bit_jump_destroy;
838 tproc.invoke = fc_bit_jump_invoke;
839 fc_register_target ("jump", tproc);
841 memset (&tproc, 0, sizeof (tproc));
843 tproc.destroy = NULL;
844 tproc.invoke = fc_bit_stop_invoke;
845 fc_register_target ("stop", tproc);
847 memset (&tproc, 0, sizeof (tproc));
848 tproc.create = fc_bit_write_create;
849 tproc.destroy = fc_bit_write_destroy;
850 tproc.invoke = fc_bit_write_invoke;
851 fc_register_target ("write", tproc);
855 } /* }}} int fc_init_once */
860 /* Add a match to list of available matches. */
861 int fc_register_match (const char *name, match_proc_t proc) /* {{{ */
865 m = (fc_match_t *) malloc (sizeof (*m));
868 memset (m, 0, sizeof (*m));
870 sstrncpy (m->name, name, sizeof (m->name));
871 memcpy (&m->proc, &proc, sizeof (m->proc));
874 if (match_list_head == NULL)
882 ptr = match_list_head;
883 while (ptr->next != NULL)
890 } /* }}} int fc_register_match */
892 /* Add a target to list of available targets. */
893 int fc_register_target (const char *name, target_proc_t proc) /* {{{ */
897 t = (fc_target_t *) malloc (sizeof (*t));
900 memset (t, 0, sizeof (*t));
902 sstrncpy (t->name, name, sizeof (t->name));
903 memcpy (&t->proc, &proc, sizeof (t->proc));
906 if (target_list_head == NULL)
908 target_list_head = t;
914 ptr = target_list_head;
915 while (ptr->next != NULL)
922 } /* }}} int fc_register_target */
924 /* Iterate over all rules in the chain and execute all targets for which all
926 int fc_process (const data_set_t *ds, value_list_t *vl) /* {{{ */
930 for (chain = chain_list_head; chain != NULL; chain = chain->next)
931 if (strcasecmp ("Main", chain->name) == 0)
935 return (fc_process_chain (ds, vl, chain));
937 ERROR ("fc_process: TODO: Implement default behavior!");
940 } /* }}} int fc_process */
942 int fc_configure (const oconfig_item_t *ci) /* {{{ */
949 if (strcasecmp ("Chain", ci->key) == 0)
950 return (fc_config_add_chain (ci));
952 WARNING ("Filter subsystem: Unknown top level config option `%s'.",
956 } /* }}} int fc_configure */
958 /* vim: set sw=2 sts=2 et fdm=marker : */