src/filter_chain.c

   1 /**
   2  * collectd - src/filter_chain.h
   3  * Copyright (C) 2008  Florian octo Forster
   4  *
   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.
   8  *
   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.
  13  *
  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
  17  *
  18  * Authors:
  19  *   Florian octo Forster <octo at verplant.org>
  20  **/
  21
  22 /*
  23  * First tell the compiler to stick to the C99 and POSIX standards as close as
  24  * possible.
  25  */
  26 #ifndef __STRICT_ANSI__ /* {{{ */
  27 # define __STRICT_ANSI__
  28 #endif
  29
  30 #ifndef _ISOC99_SOURCE
  31 # define _ISOC99_SOURCE
  32 #endif
  33
  34 #ifdef _POSIX_C_SOURCE
  35 # undef _POSIX_C_SOURCE
  36 #endif
  37 #define _POSIX_C_SOURCE 200112L
  38
  39 #if 0
  40 /* Single UNIX needed for strdup. */
  41 #ifdef _XOPEN_SOURCE
  42 # undef _XOPEN_SOURCE
  43 #endif
  44 #define _XOPEN_SOURCE 500
  45 #endif
  46
  47 #ifndef _REENTRANT
  48 # define _REENTRANT
  49 #endif
  50
  51 #ifndef _THREAD_SAFE
  52 # define _THREAD_SAFE
  53 #endif
  54
  55 #ifdef _GNU_SOURCE
  56 # undef _GNU_SOURCE
  57 #endif
  58 /* }}} */
  59
  60 #include "collectd.h"
  61 #include "configfile.h"
  62 #include "plugin.h"
  63 #include "common.h"
  64 #include "filter_chain.h"
  65
  66 /*
  67  * Data types
  68  */
  69 /* List of matches, used in fc_rule_t and for the global `match_list_head'
  70  * variable. */
  71 struct fc_match_s;
  72 typedef struct fc_match_s fc_match_t; /* {{{ */
  73 struct fc_match_s
  74 {
  75   char name[DATA_MAX_NAME_LEN];
  76   match_proc_t proc;
  77   void *user_data;
  78   fc_match_t *next;
  79 }; /* }}} */
  80
  81 /* List of targets, used in fc_rule_t and for the global `target_list_head'
  82  * variable. */
  83 struct fc_target_s;
  84 typedef struct fc_target_s fc_target_t; /* {{{ */
  85 struct fc_target_s
  86 {
  87   char name[DATA_MAX_NAME_LEN];
  88   void *user_data;
  89   target_proc_t proc;
  90   fc_target_t *next;
  91 }; /* }}} */
  92
  93 /* List of rules, used in fc_chain_t */
  94 struct fc_fule_s;
  95 typedef struct fc_fule_s fc_rule_t; /* {{{ */
  96 struct fc_fule_s
  97 {
  98   char name[DATA_MAX_NAME_LEN];
  99   fc_match_t  *matches;
 100   fc_target_t *targets;
 101   fc_rule_t *next;
 102 }; /* }}} */
 103
 104 /* List of chains, used for `chain_list_head' */
 105 struct fc_chain_s;
 106 typedef struct fc_chain_s fc_chain_t; /* {{{ */
 107 struct fc_chain_s
 108 {
 109   char name[DATA_MAX_NAME_LEN];
 110   fc_rule_t   *rules;
 111   fc_target_t *targets;
 112   fc_chain_t  *next;
 113 }; /* }}} */
 114
 115 /*
 116  * Global variables
 117  */
 118 static fc_match_t  *match_list_head;
 119 static fc_target_t *target_list_head;
 120 static fc_chain_t  *chain_list_head;
 121
 122 /*
 123  * Private functions
 124  */
 125 static void fc_free_matches (fc_match_t *m) /* {{{ */
 126 {
 127   if (m == NULL)
 128     return;
 129
 130   if (m->proc.destroy != NULL)
 131     (*m->proc.destroy) (&m->user_data);
 132   else if (m->user_data != NULL)
 133   {
 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!");
 137   }
 138
 139   if (m->next != NULL)
 140     fc_free_matches (m->next);
 141
 142   free (m);
 143 } /* }}} void fc_free_matches */
 144
 145 static void fc_free_targets (fc_target_t *t) /* {{{ */
 146 {
 147   if (t == NULL)
 148     return;
 149
 150   if (t->proc.destroy != NULL)
 151     (*t->proc.destroy) (&t->user_data);
 152   else if (t->user_data != NULL)
 153   {
 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!");
 157   }
 158
 159   if (t->next != NULL)
 160     fc_free_targets (t->next);
 161
 162   free (t);
 163 } /* }}} void fc_free_targets */
 164
 165 static void fc_free_rules (fc_rule_t *r) /* {{{ */
 166 {
 167   if (r == NULL)
 168     return;
 169
 170   fc_free_matches (r->matches);
 171   fc_free_targets (r->targets);
 172
 173   if (r->next != NULL)
 174     fc_free_rules (r->next);
 175
 176   free (r);
 177 } /* }}} void fc_free_rules */
 178
 179 static void fc_free_chains (fc_chain_t *c) /* {{{ */
 180 {
 181   if (c == NULL)
 182     return;
 183
 184   fc_free_rules (c->rules);
 185   fc_free_targets (c->targets);
 186
 187   if (c->next != NULL)
 188     fc_free_chains (c->next);
 189
 190   free (c);
 191 } /* }}} void fc_free_chains */
 192
 193 static char *fc_strdup (const char *orig) /* {{{ */
 194 {
 195   size_t sz;
 196   char *dest;
 197
 198   if (orig == NULL)
 199     return (NULL);
 200
 201   sz = strlen (orig) + 1;
 202   dest = (char *) malloc (sz);
 203   if (dest == NULL)
 204     return (NULL);
 205
 206   memcpy (dest, orig, sz);
 207
 208   return (dest);
 209 } /* }}} char *fc_strdup */
 210
 211 /*
 212  * Configuration.
 213  *
 214  * The configuration looks somewhat like this:
 215  *
 216  *  <Chain "main">
 217  *    <Rule>
 218  *      <Match "regex">
 219  *        Plugin "^mysql$"
 220  *        Type "^mysql_command$"
 221  *        TypeInstance "^show_"
 222  *      </Match>
 223  *      <Target "drop">
 224  *      </Target>
 225  *    </Rule>
 226  *
 227  *    <Target "write">
 228  *      Plugin "rrdtool"
 229  *    </Target>
 230  *  </Chain>
 231  */
 232 static int fc_config_add_match (fc_match_t **matches_head, /* {{{ */
 233     oconfig_item_t *ci)
 234 {
 235   fc_match_t *m;
 236   fc_match_t *ptr;
 237   int status;
 238
 239   if ((ci->values_num != 1)
 240       || (ci->values[0].type != OCONFIG_TYPE_STRING))
 241   {
 242     WARNING ("Filter subsystem: `Match' blocks require "
 243         "exactly one string argument.");
 244     return (-1);
 245   }
 246
 247   ptr = match_list_head;
 248   while (ptr != NULL)
 249   {
 250     if (strcasecmp (ptr->name, ci->values[0].value.string) == 0)
 251       break;
 252     ptr = ptr->next;
 253   }
 254
 255   if (ptr == NULL)
 256   {
 257     WARNING ("Filter subsystem: Cannot find a \"%s\" match. "
 258         "Did you load the appropriate plugin?",
 259         ci->values[0].value.string);
 260     return (-1);
 261   }
 262
 263   m = (fc_match_t *) malloc (sizeof (*m));
 264   if (m == NULL)
 265   {
 266     ERROR ("fc_config_add_match: malloc failed.");
 267     return (-1);
 268   }
 269   memset (m, 0, sizeof (*m));
 270
 271   sstrncpy (m->name, ptr->name, sizeof (m->name));
 272   memcpy (&m->proc, &ptr->proc, sizeof (m->proc));
 273   assert (m->proc.create != NULL);
 274   m->user_data = NULL;
 275   m->next = NULL;
 276
 277   status = (*m->proc.create) (ci, &m->user_data);
 278   if (status != 0)
 279   {
 280     WARNING ("Filter subsystem: Failed to create a %s match.",
 281         m->name);
 282     fc_free_matches (m);
 283     return (-1);
 284   }
 285
 286   if (*matches_head != NULL)
 287   {
 288     ptr = *matches_head;
 289     while (ptr->next != NULL)
 290       ptr = ptr->next;
 291
 292     ptr->next = m;
 293   }
 294   else
 295   {
 296     *matches_head = m;
 297   }
 298
 299   return (0);
 300 } /* }}} int fc_config_add_match */
 301
 302 static int fc_config_add_target (fc_target_t **targets_head, /* {{{ */
 303     oconfig_item_t *ci)
 304 {
 305   fc_target_t *t;
 306   fc_target_t *ptr;
 307   int status;
 308
 309   if ((ci->values_num != 1)
 310       || (ci->values[0].type != OCONFIG_TYPE_STRING))
 311   {
 312     WARNING ("Filter subsystem: `Target' blocks require "
 313         "exactly one string argument.");
 314     return (-1);
 315   }
 316
 317   ptr = target_list_head;
 318   while (ptr != NULL)
 319   {
 320     if (strcasecmp (ptr->name, ci->values[0].value.string) == 0)
 321       break;
 322     ptr = ptr->next;
 323   }
 324
 325   if (ptr == NULL)
 326   {
 327     WARNING ("Filter subsystem: Cannot find a \"%s\" target. "
 328         "Did you load the appropriate plugin?",
 329         ci->values[0].value.string);
 330     return (-1);
 331   }
 332
 333   t = (fc_target_t *) malloc (sizeof (*t));
 334   if (t == NULL)
 335   {
 336     ERROR ("fc_config_add_match: malloc failed.");
 337     return (-1);
 338   }
 339   memset (t, 0, sizeof (*t));
 340
 341   sstrncpy (t->name, ptr->name, sizeof (t->name));
 342   memcpy (&t->proc, &ptr->proc, sizeof (t->proc));
 343   t->user_data = NULL;
 344   t->next = NULL;
 345
 346   if (t->proc.create != NULL)
 347   {
 348     status = (*t->proc.create) (ci, &t->user_data);
 349     if (status != 0)
 350     {
 351       WARNING ("Filter subsystem: Failed to create a %s match.",
 352           t->name);
 353       fc_free_targets (t);
 354       return (-1);
 355     }
 356   }
 357   else
 358   {
 359     t->user_data = NULL;
 360   }
 361
 362   if (*targets_head != NULL)
 363   {
 364     ptr = *targets_head;
 365     while (ptr->next != NULL)
 366       ptr = ptr->next;
 367
 368     ptr->next = t;
 369   }
 370   else
 371   {
 372     *targets_head = t;
 373   }
 374
 375   return (0);
 376 } /* }}} int fc_config_add_target */
 377
 378 static int fc_config_add_rule (fc_chain_t *chain, /* {{{ */
 379     oconfig_item_t *ci)
 380 {
 381   fc_rule_t *rule;
 382   char rule_name[2*DATA_MAX_NAME_LEN] = "Unnamed rule";
 383   int status = 0;
 384   int i;
 385
 386   if (ci->values_num > 1)
 387   {
 388     WARNING ("Filter subsystem: `Rule' blocks have at most one argument.");
 389     return (-1);
 390   }
 391   else if ((ci->values_num == 1)
 392       && (ci->values[0].type != OCONFIG_TYPE_STRING))
 393   {
 394     WARNING ("Filter subsystem: `Rule' blocks expect one string argument "
 395         "or no argument at all.");
 396     return (-1);
 397   }
 398
 399   rule = (fc_rule_t *) malloc (sizeof (*rule));
 400   if (rule == NULL)
 401   {
 402     ERROR ("fc_config_add_rule: malloc failed.");
 403     return (-1);
 404   }
 405   memset (rule, 0, sizeof (*rule));
 406   rule->next = NULL;
 407
 408   if (ci->values_num == 1)
 409   {
 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);
 413   }
 414
 415   for (i = 0; i < ci->children_num; i++)
 416   {
 417     oconfig_item_t *option = ci->children + i;
 418     status = 0;
 419
 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);
 424     else
 425     {
 426       WARNING ("Filter subsystem: %s: Option `%s' not allowed "
 427           "inside a <Rule> block.", rule_name, option->key);
 428       status = -1;
 429     }
 430
 431     if (status != 0)
 432       break;
 433   } /* for (ci->children) */
 434
 435   /* Additional sanity checking. */
 436   while (status == 0)
 437   {
 438     if (rule->targets == NULL)
 439     {
 440       WARNING ("Filter subsystem: %s: No target has been specified.",
 441           rule_name);
 442       status = -1;
 443       break;
 444     }
 445
 446     break;
 447   } /* while (status == 0) */
 448
 449   if (status != 0)
 450   {
 451     fc_free_rules (rule);
 452     return (-1);
 453   }
 454
 455   if (chain->rules != NULL)
 456   {
 457     fc_rule_t *ptr;
 458
 459     ptr = chain->rules;
 460     while (ptr->next != NULL)
 461       ptr = ptr->next;
 462
 463     ptr->next = rule;
 464   }
 465   else
 466   {
 467     chain->rules = rule;
 468   }
 469
 470   return (0);
 471 } /* }}} int fc_config_add_rule */
 472
 473 static int fc_config_add_chain (const oconfig_item_t *ci) /* {{{ */
 474 {
 475   fc_chain_t *chain;
 476   int status = 0;
 477   int i;
 478
 479   if ((ci->values_num != 1)
 480       || (ci->values[0].type != OCONFIG_TYPE_STRING))
 481   {
 482     WARNING ("Filter subsystem: <Chain> blocks require exactly one "
 483         "string argument.");
 484     return (-1);
 485   }
 486
 487   chain = (fc_chain_t *) malloc (sizeof (*chain));
 488   if (chain == NULL)
 489   {
 490     ERROR ("fc_config_add_chain: malloc failed.");
 491     return (-1);
 492   }
 493   memset (chain, 0, sizeof (*chain));
 494   sstrncpy (chain->name, ci->values[0].value.string, sizeof (chain->name));
 495   chain->rules = NULL;
 496   chain->targets = NULL;
 497   chain->next = NULL;
 498
 499   for (i = 0; i < ci->children_num; i++)
 500   {
 501     oconfig_item_t *option = ci->children + i;
 502     status = 0;
 503
 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);
 508     else
 509     {
 510       WARNING ("Filter subsystem: Chain %s: Option `%s' not allowed "
 511           "inside a <Chain> block.", chain->name, option->key);
 512       status = -1;
 513     }
 514
 515     if (status != 0)
 516       break;
 517   } /* for (ci->children) */
 518
 519   /* Additional sanity checking. */
 520   while (status == 0)
 521   {
 522     if (chain->targets == NULL)
 523     {
 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);
 527       status = -1;
 528       break;
 529     }
 530
 531     break;
 532   } /* while (status == 0) */
 533
 534   if (status != 0)
 535   {
 536     fc_free_chains (chain);
 537     return (-1);
 538   }
 539
 540   if (chain_list_head != NULL)
 541   {
 542     fc_chain_t *ptr;
 543
 544     ptr = chain_list_head;
 545     while (ptr->next != NULL)
 546       ptr = ptr->next;
 547
 548     ptr->next = chain;
 549   }
 550   else
 551   {
 552     chain_list_head = chain;
 553   }
 554
 555   return (0);
 556 } /* }}} int fc_config_add_chain */
 557
 558 int fc_process_chain (const data_set_t *ds, value_list_t *vl, /* {{{ */
 559     fc_chain_t *chain)
 560 {
 561   fc_rule_t *rule;
 562   fc_target_t *target;
 563   int status;
 564
 565   if (chain == NULL)
 566     return (-1);
 567
 568   DEBUG ("fc_process_chain (chain = %s);", chain->name);
 569
 570   status = FC_ACTION_CONTINUE;
 571
 572   for (rule = chain->rules; rule != NULL; rule = rule->next)
 573   {
 574     fc_match_t *match;
 575
 576     if (rule->name[0] != 0)
 577     {
 578       DEBUG ("fc_process_chain: Testing the `%s' rule.", rule->name);
 579     }
 580
 581     /* N. B.: rule->matches may be NULL. */
 582     for (match = rule->matches; match != NULL; match = match->next)
 583     {
 584       status = (*match->proc.match) (ds, vl, /* meta = */ NULL,
 585           &match->user_data);
 586       if (status < 0)
 587       {
 588         WARNING ("fc_process_chain: A match failed.");
 589         break;
 590       }
 591       else if (status != FC_MATCH_MATCHES)
 592         break;
 593     }
 594
 595     /* for-loop has been aborted: Either error or no match. */
 596     if (match != NULL)
 597       continue;
 598
 599     if (rule->name[0] != 0)
 600     {
 601       DEBUG ("fc_process_chain: Rule `%s' matches.", rule->name);
 602     }
 603
 604     for (target = rule->targets; target != NULL; target = target->next)
 605     {
 606       /* If we get here, all matches have matched the value. Execute the
 607        * target. */
 608       status = (*target->proc.invoke) (ds, vl, /* meta = */ NULL,
 609           &target->user_data);
 610       if (status < 0)
 611       {
 612         WARNING ("fc_process_chain: A target failed.");
 613         continue;
 614       }
 615       else if (status == FC_ACTION_CONTINUE)
 616         continue;
 617       else if (status == FC_ACTION_STOP)
 618         break;
 619       else
 620       {
 621         WARNING ("fc_process_chain: Unknown target return value: %i", status);
 622       }
 623     }
 624
 625     if (status == FC_ACTION_STOP)
 626     {
 627       if (rule->name[0] != 0)
 628       {
 629         DEBUG ("fc_process_chain: Rule `%s' signaled the stop condition.",
 630             rule->name);
 631       }
 632       break;
 633     }
 634   } /* for (rule) */
 635
 636   /* for-loop has been aborted: A target returned `FC_ACTION_STOP' */
 637   if (rule != NULL)
 638     return (0);
 639
 640   for (target = chain->targets; target != NULL; target = target->next)
 641   {
 642     /* If we get here, all matches have matched the value. Execute the
 643      * target. */
 644     status = (*target->proc.invoke) (ds, vl, /* meta = */ NULL,
 645         &target->user_data);
 646     if (status < 0)
 647     {
 648       WARNING ("fc_process_chain: The default target failed.");
 649     }
 650   }
 651
 652   return (0);
 653 } /* }}} int fc_process_chain */
 654
 655 /*
 656  * Built-in target "jump"
 657  *
 658  * Prefix `bit' like `_b_uilt-_i_n _t_arget'
 659  */
 660 static int fc_bit_jump_create (const oconfig_item_t *ci, /* {{{ */
 661     void **user_data)
 662 {
 663   oconfig_item_t *ci_chain;
 664
 665   if (ci->children_num != 1)
 666   {
 667     ERROR ("Filter subsystem: The built-in target `jump' needs exactly "
 668         "one `Chain' argument!");
 669     return (-1);
 670   }
 671
 672   ci_chain = ci->children;
 673   if (strcasecmp ("Chain", ci_chain->key) != 0)
 674   {
 675     ERROR ("Filter subsystem: The built-in target `jump' does not "
 676         "support the configuration option `%s'.",
 677         ci_chain->key);
 678     return (-1);
 679   }
 680
 681   if ((ci_chain->values_num != 1)
 682       || (ci_chain->values[0].type != OCONFIG_TYPE_STRING))
 683   {
 684     ERROR ("Filter subsystem: Built-in target `jump': The `Chain' option "
 685         "needs exactly one string argument.");
 686     return (-1);
 687   }
 688
 689   *user_data = fc_strdup (ci_chain->values[0].value.string);
 690   if (*user_data == NULL)
 691   {
 692     ERROR ("fc_bit_jump_create: fc_strdup failed.");
 693     return (-1);
 694   }
 695
 696   return (0);
 697 } /* }}} int fc_bit_jump_create */
 698
 699 static int fc_bit_jump_destroy (void **user_data) /* {{{ */
 700 {
 701   if (user_data != NULL)
 702   {
 703     free (*user_data);
 704     *user_data = NULL;
 705   }
 706
 707   return (0);
 708 } /* }}} int fc_bit_jump_destroy */
 709
 710 static int fc_bit_jump_invoke (const data_set_t *ds, /* {{{ */
 711     value_list_t *vl, notification_meta_t **meta, void **user_data)
 712 {
 713   char *chain_name;
 714   fc_chain_t *chain;
 715   int status;
 716
 717   chain_name = *user_data;
 718
 719   for (chain = chain_list_head; chain != NULL; chain = chain->next)
 720     if (strcasecmp (chain_name, chain->name) == 0)
 721       break;
 722
 723   if (chain == NULL)
 724   {
 725     ERROR ("Filter subsystem: Built-in target `jump': There is no chain "
 726         "named `%s'.", chain_name);
 727     return (-1);
 728   }
 729
 730   status = fc_process_chain (ds, vl, chain);
 731   if (status < 0)
 732     return (status);
 733
 734   return (FC_ACTION_CONTINUE);
 735 } /* }}} int fc_bit_jump_invoke */
 736
 737 static int fc_bit_stop_invoke (const data_set_t *ds, /* {{{ */
 738     value_list_t *vl, notification_meta_t **meta, void **user_data)
 739 {
 740   return (FC_ACTION_STOP);
 741 } /* }}} int fc_bit_stop_invoke */
 742
 743 static int fc_bit_write_create (const oconfig_item_t *ci, /* {{{ */
 744     void **user_data)
 745 {
 746   int i;
 747
 748   char **plugin_list;
 749   size_t plugin_list_len;
 750
 751   plugin_list = NULL;
 752   plugin_list_len = 0;
 753
 754   for (i = 0; i < ci->children_num; i++)
 755   {
 756     oconfig_item_t *child = ci->children + i;
 757     char **temp;
 758     int j;
 759
 760     if (strcasecmp ("Plugin", child->key) != 0)
 761     {
 762       ERROR ("Filter subsystem: The built-in target `write' does not "
 763           "support the configuration option `%s'.",
 764           child->key);
 765       continue;
 766     }
 767
 768     for (j = 0; j < child->values_num; j++)
 769     {
 770       if (child->values[j].type != OCONFIG_TYPE_STRING)
 771       {
 772         ERROR ("Filter subsystem: Built-in target `write': "
 773             "The `Plugin' option accepts only string arguments.");
 774         continue;
 775       }
 776
 777       temp = (char **) realloc (plugin_list, (plugin_list_len + 2)
 778           * (sizeof (*plugin_list)));
 779       if (temp == NULL)
 780       {
 781         ERROR ("fc_bit_write_create: realloc failed.");
 782         continue;
 783       }
 784       plugin_list = temp;
 785
 786       plugin_list[plugin_list_len] = fc_strdup (child->values[j].value.string);
 787       if (plugin_list[plugin_list_len] == NULL)
 788       {
 789         ERROR ("fc_bit_write_create: fc_strdup failed.");
 790         continue;
 791       }
 792       plugin_list_len++;
 793       plugin_list[plugin_list_len] = NULL;
 794     } /* for (j = 0; j < child->values_num; j++) */
 795   } /* for (i = 0; i < ci->children_num; i++) */
 796
 797   *user_data = plugin_list;
 798
 799   return (0);
 800 } /* }}} int fc_bit_write_create */
 801
 802 static int fc_bit_write_destroy (void **user_data) /* {{{ */
 803 {
 804   char **plugin_list;
 805   size_t i;
 806
 807   if ((user_data == NULL) || (*user_data == NULL))
 808     return (0);
 809
 810   plugin_list = *user_data;
 811
 812   for (i = 0; plugin_list[i] != NULL; i++)
 813     free (plugin_list[i]);
 814   free (plugin_list);
 815
 816   return (0);
 817 } /* }}} int fc_bit_write_destroy */
 818
 819 static int fc_bit_write_invoke (const data_set_t *ds, /* {{{ */
 820     value_list_t *vl, notification_meta_t **meta, void **user_data)
 821 {
 822   char **plugin_list;
 823   int status;
 824
 825   plugin_list = NULL;
 826   if (user_data != NULL)
 827     plugin_list = *user_data;
 828
 829   if ((plugin_list == NULL) || (plugin_list[0] == NULL))
 830   {
 831     status = plugin_write (/* plugin = */ NULL, ds, vl);
 832     if (status != 0)
 833     {
 834       INFO ("Filter subsystem: Built-in target `write': Dispatching value to "
 835           "all write plugins failed with status %i.", status);
 836     }
 837   }
 838   else
 839   {
 840     size_t i;
 841
 842     for (i = 0; plugin_list[i] != NULL; i++)
 843     {
 844       status = plugin_write (plugin_list[i], ds, vl);
 845       if (status != 0)
 846       {
 847         INFO ("Filter subsystem: Built-in target `write': Dispatching value to "
 848             "the `%s' plugin failed with status %i.", plugin_list[i], status);
 849       }
 850     } /* for (i = 0; plugin_list[i] != NULL; i++) */
 851   }
 852
 853   return (FC_ACTION_CONTINUE);
 854 } /* }}} int fc_bit_write_invoke */
 855
 856 static int fc_init_once (void) /* {{{ */
 857 {
 858   static int done = 0;
 859   target_proc_t tproc;
 860
 861   if (done != 0)
 862     return (0);
 863
 864   memset (&tproc, 0, sizeof (tproc));
 865   tproc.create  = fc_bit_jump_create;
 866   tproc.destroy = fc_bit_jump_destroy;
 867   tproc.invoke  = fc_bit_jump_invoke;
 868   fc_register_target ("jump", tproc);
 869
 870   memset (&tproc, 0, sizeof (tproc));
 871   tproc.create  = NULL;
 872   tproc.destroy = NULL;
 873   tproc.invoke  = fc_bit_stop_invoke;
 874   fc_register_target ("stop", tproc);
 875
 876   memset (&tproc, 0, sizeof (tproc));
 877   tproc.create  = fc_bit_write_create;
 878   tproc.destroy = fc_bit_write_destroy;
 879   tproc.invoke  = fc_bit_write_invoke;
 880   fc_register_target ("write", tproc);
 881
 882   done++;
 883   return (0);
 884 } /* }}} int fc_init_once */
 885
 886 /*
 887  * Public functions
 888  */
 889 /* Add a match to list of available matches. */
 890 int fc_register_match (const char *name, match_proc_t proc) /* {{{ */
 891 {
 892   fc_match_t *m;
 893
 894   DEBUG ("fc_register_match (%s);", name);
 895
 896   m = (fc_match_t *) malloc (sizeof (*m));
 897   if (m == NULL)
 898     return (-ENOMEM);
 899   memset (m, 0, sizeof (*m));
 900
 901   sstrncpy (m->name, name, sizeof (m->name));
 902   memcpy (&m->proc, &proc, sizeof (m->proc));
 903   m->next = NULL;
 904
 905   if (match_list_head == NULL)
 906   {
 907     match_list_head = m;
 908   }
 909   else
 910   {
 911     fc_match_t *ptr;
 912
 913     ptr = match_list_head;
 914     while (ptr->next != NULL)
 915       ptr = ptr->next;
 916
 917     ptr->next = m;
 918   }
 919
 920   return (0);
 921 } /* }}} int fc_register_match */
 922
 923 /* Add a target to list of available targets. */
 924 int fc_register_target (const char *name, target_proc_t proc) /* {{{ */
 925 {
 926   fc_target_t *t;
 927
 928   DEBUG ("fc_register_target (%s);", name);
 929
 930   t = (fc_target_t *) malloc (sizeof (*t));
 931   if (t == NULL)
 932     return (-ENOMEM);
 933   memset (t, 0, sizeof (*t));
 934
 935   sstrncpy (t->name, name, sizeof (t->name));
 936   memcpy (&t->proc, &proc, sizeof (t->proc));
 937   t->next = NULL;
 938
 939   if (target_list_head == NULL)
 940   {
 941     target_list_head = t;
 942   }
 943   else
 944   {
 945     fc_target_t *ptr;
 946
 947     ptr = target_list_head;
 948     while (ptr->next != NULL)
 949       ptr = ptr->next;
 950
 951     ptr->next = t;
 952   }
 953
 954   return (0);
 955 } /* }}} int fc_register_target */
 956
 957 /* Iterate over all rules in the chain and execute all targets for which all
 958  * matches match. */
 959 int fc_process (const data_set_t *ds, value_list_t *vl) /* {{{ */
 960 {
 961   fc_chain_t *chain;
 962
 963   for (chain = chain_list_head; chain != NULL; chain = chain->next)
 964     if (strcasecmp ("Main", chain->name) == 0)
 965       break;
 966
 967   if (chain != NULL)
 968     return (fc_process_chain (ds, vl, chain));
 969
 970   return (fc_bit_write_invoke (ds, vl,
 971         /* meta = */ NULL, /* user_data = */ NULL));
 972 } /* }}} int fc_process */
 973
 974 int fc_configure (const oconfig_item_t *ci) /* {{{ */
 975 {
 976   fc_init_once ();
 977
 978   if (ci == NULL)
 979     return (-EINVAL);
 980
 981   if (strcasecmp ("Chain", ci->key) == 0)
 982     return (fc_config_add_chain (ci));
 983
 984   WARNING ("Filter subsystem: Unknown top level config option `%s'.",
 985       ci->key);
 986
 987   return (-1);
 988 } /* }}} int fc_configure */
 989
 990 /* vim: set sw=2 sts=2 et fdm=marker : */