src/filter_chain.c

   1 /**
   2  * collectd - src/filter_chain.h
   3  * Copyright (C) 2008,2009  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_rule_s;
  95 typedef struct fc_rule_s fc_rule_t; /* {{{ */
  96 struct fc_rule_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 {
 107   char name[DATA_MAX_NAME_LEN];
 108   fc_rule_t   *rules;
 109   fc_target_t *targets;
 110   fc_chain_t  *next;
 111 }; /* }}} */
 112
 113 /*
 114  * Global variables
 115  */
 116 static fc_match_t  *match_list_head;
 117 static fc_target_t *target_list_head;
 118 static fc_chain_t  *chain_list_head;
 119
 120 /*
 121  * Private functions
 122  */
 123 static void fc_free_matches (fc_match_t *m) /* {{{ */
 124 {
 125   if (m == NULL)
 126     return;
 127
 128   if (m->proc.destroy != NULL)
 129     (*m->proc.destroy) (&m->user_data);
 130   else if (m->user_data != NULL)
 131   {
 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!");
 135   }
 136
 137   if (m->next != NULL)
 138     fc_free_matches (m->next);
 139
 140   free (m);
 141 } /* }}} void fc_free_matches */
 142
 143 static void fc_free_targets (fc_target_t *t) /* {{{ */
 144 {
 145   if (t == NULL)
 146     return;
 147
 148   if (t->proc.destroy != NULL)
 149     (*t->proc.destroy) (&t->user_data);
 150   else if (t->user_data != NULL)
 151   {
 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!");
 155   }
 156
 157   if (t->next != NULL)
 158     fc_free_targets (t->next);
 159
 160   free (t);
 161 } /* }}} void fc_free_targets */
 162
 163 static void fc_free_rules (fc_rule_t *r) /* {{{ */
 164 {
 165   if (r == NULL)
 166     return;
 167
 168   fc_free_matches (r->matches);
 169   fc_free_targets (r->targets);
 170
 171   if (r->next != NULL)
 172     fc_free_rules (r->next);
 173
 174   free (r);
 175 } /* }}} void fc_free_rules */
 176
 177 static void fc_free_chains (fc_chain_t *c) /* {{{ */
 178 {
 179   if (c == NULL)
 180     return;
 181
 182   fc_free_rules (c->rules);
 183   fc_free_targets (c->targets);
 184
 185   if (c->next != NULL)
 186     fc_free_chains (c->next);
 187
 188   free (c);
 189 } /* }}} void fc_free_chains */
 190
 191 static char *fc_strdup (const char *orig) /* {{{ */
 192 {
 193   size_t sz;
 194   char *dest;
 195
 196   if (orig == NULL)
 197     return (NULL);
 198
 199   sz = strlen (orig) + 1;
 200   dest = (char *) malloc (sz);
 201   if (dest == NULL)
 202     return (NULL);
 203
 204   memcpy (dest, orig, sz);
 205
 206   return (dest);
 207 } /* }}} char *fc_strdup */
 208
 209 /*
 210  * Configuration.
 211  *
 212  * The configuration looks somewhat like this:
 213  *
 214  *  <Chain "main">
 215  *    <Rule>
 216  *      <Match "regex">
 217  *        Plugin "^mysql$"
 218  *        Type "^mysql_command$"
 219  *        TypeInstance "^show_"
 220  *      </Match>
 221  *      <Target "drop">
 222  *      </Target>
 223  *    </Rule>
 224  *
 225  *    <Target "write">
 226  *      Plugin "rrdtool"
 227  *    </Target>
 228  *  </Chain>
 229  */
 230 static int fc_config_add_match (fc_match_t **matches_head, /* {{{ */
 231     oconfig_item_t *ci)
 232 {
 233   fc_match_t *m;
 234   fc_match_t *ptr;
 235   int status;
 236
 237   if ((ci->values_num != 1)
 238       || (ci->values[0].type != OCONFIG_TYPE_STRING))
 239   {
 240     WARNING ("Filter subsystem: `Match' blocks require "
 241         "exactly one string argument.");
 242     return (-1);
 243   }
 244
 245   ptr = match_list_head;
 246   while (ptr != NULL)
 247   {
 248     if (strcasecmp (ptr->name, ci->values[0].value.string) == 0)
 249       break;
 250     ptr = ptr->next;
 251   }
 252
 253   if (ptr == NULL)
 254   {
 255     WARNING ("Filter subsystem: Cannot find a \"%s\" match. "
 256         "Did you load the appropriate plugin?",
 257         ci->values[0].value.string);
 258     return (-1);
 259   }
 260
 261   m = (fc_match_t *) malloc (sizeof (*m));
 262   if (m == NULL)
 263   {
 264     ERROR ("fc_config_add_match: malloc failed.");
 265     return (-1);
 266   }
 267   memset (m, 0, sizeof (*m));
 268
 269   sstrncpy (m->name, ptr->name, sizeof (m->name));
 270   memcpy (&m->proc, &ptr->proc, sizeof (m->proc));
 271   m->user_data = NULL;
 272   m->next = NULL;
 273
 274   if (m->proc.create != NULL)
 275   {
 276     status = (*m->proc.create) (ci, &m->user_data);
 277     if (status != 0)
 278     {
 279       WARNING ("Filter subsystem: Failed to create a %s match.",
 280           m->name);
 281       fc_free_matches (m);
 282       return (-1);
 283     }
 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_target: 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 target.",
 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 /*
 559  * Built-in target "jump"
 560  *
 561  * Prefix `bit' like `_b_uilt-_i_n _t_arget'
 562  */
 563 static int fc_bit_jump_create (const oconfig_item_t *ci, /* {{{ */
 564     void **user_data)
 565 {
 566   oconfig_item_t *ci_chain;
 567
 568   if (ci->children_num != 1)
 569   {
 570     ERROR ("Filter subsystem: The built-in target `jump' needs exactly "
 571         "one `Chain' argument!");
 572     return (-1);
 573   }
 574
 575   ci_chain = ci->children;
 576   if (strcasecmp ("Chain", ci_chain->key) != 0)
 577   {
 578     ERROR ("Filter subsystem: The built-in target `jump' does not "
 579         "support the configuration option `%s'.",
 580         ci_chain->key);
 581     return (-1);
 582   }
 583
 584   if ((ci_chain->values_num != 1)
 585       || (ci_chain->values[0].type != OCONFIG_TYPE_STRING))
 586   {
 587     ERROR ("Filter subsystem: Built-in target `jump': The `Chain' option "
 588         "needs exactly one string argument.");
 589     return (-1);
 590   }
 591
 592   *user_data = fc_strdup (ci_chain->values[0].value.string);
 593   if (*user_data == NULL)
 594   {
 595     ERROR ("fc_bit_jump_create: fc_strdup failed.");
 596     return (-1);
 597   }
 598
 599   return (0);
 600 } /* }}} int fc_bit_jump_create */
 601
 602 static int fc_bit_jump_destroy (void **user_data) /* {{{ */
 603 {
 604   if (user_data != NULL)
 605   {
 606     free (*user_data);
 607     *user_data = NULL;
 608   }
 609
 610   return (0);
 611 } /* }}} int fc_bit_jump_destroy */
 612
 613 static int fc_bit_jump_invoke (const data_set_t *ds, /* {{{ */
 614     value_list_t *vl, notification_meta_t __attribute__((unused)) **meta,
 615     void **user_data)
 616 {
 617   char *chain_name;
 618   fc_chain_t *chain;
 619   int status;
 620
 621   chain_name = *user_data;
 622
 623   for (chain = chain_list_head; chain != NULL; chain = chain->next)
 624     if (strcasecmp (chain_name, chain->name) == 0)
 625       break;
 626
 627   if (chain == NULL)
 628   {
 629     ERROR ("Filter subsystem: Built-in target `jump': There is no chain "
 630         "named `%s'.", chain_name);
 631     return (-1);
 632   }
 633
 634   status = fc_process_chain (ds, vl, chain);
 635   if (status < 0)
 636     return (status);
 637   else if (status == FC_TARGET_STOP)
 638     return (FC_TARGET_STOP);
 639   else
 640     return (FC_TARGET_CONTINUE);
 641 } /* }}} int fc_bit_jump_invoke */
 642
 643 static int fc_bit_stop_invoke (const data_set_t __attribute__((unused)) *ds, /* {{{ */
 644     value_list_t __attribute__((unused)) *vl,
 645     notification_meta_t __attribute__((unused)) **meta,
 646     void __attribute__((unused)) **user_data)
 647 {
 648   return (FC_TARGET_STOP);
 649 } /* }}} int fc_bit_stop_invoke */
 650
 651 static int fc_bit_return_invoke (const data_set_t __attribute__((unused)) *ds, /* {{{ */
 652     value_list_t __attribute__((unused)) *vl,
 653     notification_meta_t __attribute__((unused)) **meta,
 654     void __attribute__((unused)) **user_data)
 655 {
 656   return (FC_TARGET_RETURN);
 657 } /* }}} int fc_bit_return_invoke */
 658
 659 static int fc_bit_write_create (const oconfig_item_t *ci, /* {{{ */
 660     void **user_data)
 661 {
 662   int i;
 663
 664   char **plugin_list;
 665   size_t plugin_list_len;
 666
 667   plugin_list = NULL;
 668   plugin_list_len = 0;
 669
 670   for (i = 0; i < ci->children_num; i++)
 671   {
 672     oconfig_item_t *child = ci->children + i;
 673     char **temp;
 674     int j;
 675
 676     if (strcasecmp ("Plugin", child->key) != 0)
 677     {
 678       ERROR ("Filter subsystem: The built-in target `write' does not "
 679           "support the configuration option `%s'.",
 680           child->key);
 681       continue;
 682     }
 683
 684     for (j = 0; j < child->values_num; j++)
 685     {
 686       if (child->values[j].type != OCONFIG_TYPE_STRING)
 687       {
 688         ERROR ("Filter subsystem: Built-in target `write': "
 689             "The `Plugin' option accepts only string arguments.");
 690         continue;
 691       }
 692
 693       temp = (char **) realloc (plugin_list, (plugin_list_len + 2)
 694           * (sizeof (*plugin_list)));
 695       if (temp == NULL)
 696       {
 697         ERROR ("fc_bit_write_create: realloc failed.");
 698         continue;
 699       }
 700       plugin_list = temp;
 701
 702       plugin_list[plugin_list_len] = fc_strdup (child->values[j].value.string);
 703       if (plugin_list[plugin_list_len] == NULL)
 704       {
 705         ERROR ("fc_bit_write_create: fc_strdup failed.");
 706         continue;
 707       }
 708       plugin_list_len++;
 709       plugin_list[plugin_list_len] = NULL;
 710     } /* for (j = 0; j < child->values_num; j++) */
 711   } /* for (i = 0; i < ci->children_num; i++) */
 712
 713   *user_data = plugin_list;
 714
 715   return (0);
 716 } /* }}} int fc_bit_write_create */
 717
 718 static int fc_bit_write_destroy (void **user_data) /* {{{ */
 719 {
 720   char **plugin_list;
 721   size_t i;
 722
 723   if ((user_data == NULL) || (*user_data == NULL))
 724     return (0);
 725
 726   plugin_list = *user_data;
 727
 728   for (i = 0; plugin_list[i] != NULL; i++)
 729     free (plugin_list[i]);
 730   free (plugin_list);
 731
 732   return (0);
 733 } /* }}} int fc_bit_write_destroy */
 734
 735 static int fc_bit_write_invoke (const data_set_t *ds, /* {{{ */
 736     value_list_t *vl, notification_meta_t __attribute__((unused)) **meta,
 737     void **user_data)
 738 {
 739   char **plugin_list;
 740   int status;
 741
 742   plugin_list = NULL;
 743   if (user_data != NULL)
 744     plugin_list = *user_data;
 745
 746   if ((plugin_list == NULL) || (plugin_list[0] == NULL))
 747   {
 748     status = plugin_write (/* plugin = */ NULL, ds, vl);
 749     if (status != 0)
 750     {
 751       INFO ("Filter subsystem: Built-in target `write': Dispatching value to "
 752           "all write plugins failed with status %i.", status);
 753     }
 754   }
 755   else
 756   {
 757     size_t i;
 758
 759     for (i = 0; plugin_list[i] != NULL; i++)
 760     {
 761       status = plugin_write (plugin_list[i], ds, vl);
 762       if (status != 0)
 763       {
 764         INFO ("Filter subsystem: Built-in target `write': Dispatching value to "
 765             "the `%s' plugin failed with status %i.", plugin_list[i], status);
 766       }
 767     } /* for (i = 0; plugin_list[i] != NULL; i++) */
 768   }
 769
 770   return (FC_TARGET_CONTINUE);
 771 } /* }}} int fc_bit_write_invoke */
 772
 773 static int fc_init_once (void) /* {{{ */
 774 {
 775   static int done = 0;
 776   target_proc_t tproc;
 777
 778   if (done != 0)
 779     return (0);
 780
 781   memset (&tproc, 0, sizeof (tproc));
 782   tproc.create  = fc_bit_jump_create;
 783   tproc.destroy = fc_bit_jump_destroy;
 784   tproc.invoke  = fc_bit_jump_invoke;
 785   fc_register_target ("jump", tproc);
 786
 787   memset (&tproc, 0, sizeof (tproc));
 788   tproc.create  = NULL;
 789   tproc.destroy = NULL;
 790   tproc.invoke  = fc_bit_stop_invoke;
 791   fc_register_target ("stop", tproc);
 792
 793   memset (&tproc, 0, sizeof (tproc));
 794   tproc.create  = NULL;
 795   tproc.destroy = NULL;
 796   tproc.invoke  = fc_bit_return_invoke;
 797   fc_register_target ("return", tproc);
 798
 799   memset (&tproc, 0, sizeof (tproc));
 800   tproc.create  = fc_bit_write_create;
 801   tproc.destroy = fc_bit_write_destroy;
 802   tproc.invoke  = fc_bit_write_invoke;
 803   fc_register_target ("write", tproc);
 804
 805   done++;
 806   return (0);
 807 } /* }}} int fc_init_once */
 808
 809 /*
 810  * Public functions
 811  */
 812 /* Add a match to list of available matches. */
 813 int fc_register_match (const char *name, match_proc_t proc) /* {{{ */
 814 {
 815   fc_match_t *m;
 816
 817   DEBUG ("fc_register_match (%s);", name);
 818
 819   m = (fc_match_t *) malloc (sizeof (*m));
 820   if (m == NULL)
 821     return (-ENOMEM);
 822   memset (m, 0, sizeof (*m));
 823
 824   sstrncpy (m->name, name, sizeof (m->name));
 825   memcpy (&m->proc, &proc, sizeof (m->proc));
 826   m->next = NULL;
 827
 828   if (match_list_head == NULL)
 829   {
 830     match_list_head = m;
 831   }
 832   else
 833   {
 834     fc_match_t *ptr;
 835
 836     ptr = match_list_head;
 837     while (ptr->next != NULL)
 838       ptr = ptr->next;
 839
 840     ptr->next = m;
 841   }
 842
 843   return (0);
 844 } /* }}} int fc_register_match */
 845
 846 /* Add a target to list of available targets. */
 847 int fc_register_target (const char *name, target_proc_t proc) /* {{{ */
 848 {
 849   fc_target_t *t;
 850
 851   DEBUG ("fc_register_target (%s);", name);
 852
 853   t = (fc_target_t *) malloc (sizeof (*t));
 854   if (t == NULL)
 855     return (-ENOMEM);
 856   memset (t, 0, sizeof (*t));
 857
 858   sstrncpy (t->name, name, sizeof (t->name));
 859   memcpy (&t->proc, &proc, sizeof (t->proc));
 860   t->next = NULL;
 861
 862   if (target_list_head == NULL)
 863   {
 864     target_list_head = t;
 865   }
 866   else
 867   {
 868     fc_target_t *ptr;
 869
 870     ptr = target_list_head;
 871     while (ptr->next != NULL)
 872       ptr = ptr->next;
 873
 874     ptr->next = t;
 875   }
 876
 877   return (0);
 878 } /* }}} int fc_register_target */
 879
 880 fc_chain_t *fc_chain_get_by_name (const char *chain_name) /* {{{ */
 881 {
 882   fc_chain_t *chain;
 883
 884   if (chain_name == NULL)
 885     return (NULL);
 886
 887   for (chain = chain_list_head; chain != NULL; chain = chain->next)
 888     if (strcasecmp (chain_name, chain->name) == 0)
 889       return (chain);
 890
 891   return (NULL);
 892 } /* }}} int fc_chain_get_by_name */
 893
 894 int fc_process_chain (const data_set_t *ds, value_list_t *vl, /* {{{ */
 895     fc_chain_t *chain)
 896 {
 897   fc_rule_t *rule;
 898   fc_target_t *target;
 899   int status;
 900
 901   if (chain == NULL)
 902     return (-1);
 903
 904   DEBUG ("fc_process_chain (chain = %s);", chain->name);
 905
 906   status = FC_TARGET_CONTINUE;
 907   for (rule = chain->rules; rule != NULL; rule = rule->next)
 908   {
 909     fc_match_t *match;
 910
 911     if (rule->name[0] != 0)
 912     {
 913       DEBUG ("fc_process_chain (%s): Testing the `%s' rule.",
 914           chain->name, rule->name);
 915     }
 916
 917     /* N. B.: rule->matches may be NULL. */
 918     for (match = rule->matches; match != NULL; match = match->next)
 919     {
 920       /* FIXME: Pass the meta-data to match targets here (when implemented). */
 921       status = (*match->proc.match) (ds, vl, /* meta = */ NULL,
 922           &match->user_data);
 923       if (status < 0)
 924       {
 925         WARNING ("fc_process_chain (%s): A match failed.", chain->name);
 926         break;
 927       }
 928       else if (status != FC_MATCH_MATCHES)
 929         break;
 930     }
 931
 932     /* for-loop has been aborted: Either error or no match. */
 933     if (match != NULL)
 934     {
 935       status = FC_TARGET_CONTINUE;
 936       continue;
 937     }
 938
 939     if (rule->name[0] != 0)
 940     {
 941       DEBUG ("fc_process_chain (%s): Rule `%s' matches.",
 942           chain->name, rule->name);
 943     }
 944
 945     for (target = rule->targets; target != NULL; target = target->next)
 946     {
 947       /* If we get here, all matches have matched the value. Execute the
 948        * target. */
 949       /* FIXME: Pass the meta-data to match targets here (when implemented). */
 950       status = (*target->proc.invoke) (ds, vl, /* meta = */ NULL,
 951           &target->user_data);
 952       if (status < 0)
 953       {
 954         WARNING ("fc_process_chain (%s): A target failed.", chain->name);
 955         continue;
 956       }
 957       else if (status == FC_TARGET_CONTINUE)
 958         continue;
 959       else if (status == FC_TARGET_STOP)
 960         break;
 961       else if (status == FC_TARGET_RETURN)
 962         break;
 963       else
 964       {
 965         WARNING ("fc_process_chain (%s): Unknown return value "
 966             "from target `%s': %i",
 967             chain->name, target->name, status);
 968       }
 969     }
 970
 971     if ((status == FC_TARGET_STOP)
 972         || (status == FC_TARGET_RETURN))
 973     {
 974       if (rule->name[0] != 0)
 975       {
 976         DEBUG ("fc_process_chain (%s): Rule `%s' signaled "
 977             "the %s condition.",
 978             chain->name, rule->name,
 979             (status == FC_TARGET_STOP) ? "stop" : "return");
 980       }
 981       break;
 982     }
 983     else
 984     {
 985       status = FC_TARGET_CONTINUE;
 986     }
 987   } /* for (rule) */
 988
 989   if (status == FC_TARGET_STOP)
 990     return (FC_TARGET_STOP);
 991   else if (status == FC_TARGET_RETURN)
 992     return (FC_TARGET_CONTINUE);
 993
 994   /* for-loop has been aborted: A target returned `FC_TARGET_STOP' */
 995   if (rule != NULL)
 996     return (FC_TARGET_CONTINUE);
 997
 998   DEBUG ("fc_process_chain (%s): Executing the default targets.",
 999       chain->name);
1000
1001   status = FC_TARGET_CONTINUE;
1002   for (target = chain->targets; target != NULL; target = target->next)
1003   {
1004     /* If we get here, all matches have matched the value. Execute the
1005      * target. */
1006     /* FIXME: Pass the meta-data to match targets here (when implemented). */
1007     status = (*target->proc.invoke) (ds, vl, /* meta = */ NULL,
1008         &target->user_data);
1009     if (status < 0)
1010     {
1011       WARNING ("fc_process_chain (%s): The default target failed.",
1012           chain->name);
1013     }
1014     else if (status == FC_TARGET_CONTINUE)
1015       continue;
1016     else if (status == FC_TARGET_STOP)
1017       break;
1018     else if (status == FC_TARGET_RETURN)
1019       break;
1020     else
1021     {
1022       WARNING ("fc_process_chain (%s): Unknown return value "
1023           "from target `%s': %i",
1024           chain->name, target->name, status);
1025     }
1026   }
1027
1028   if ((status == FC_TARGET_STOP)
1029       || (status == FC_TARGET_RETURN))
1030   {
1031     assert (target != NULL);
1032     DEBUG ("fc_process_chain (%s): Default target `%s' signaled "
1033         "the %s condition.",
1034         chain->name, target->name,
1035         (status == FC_TARGET_STOP) ? "stop" : "return");
1036     if (status == FC_TARGET_STOP)
1037       return (FC_TARGET_STOP);
1038     else
1039       return (FC_TARGET_CONTINUE);
1040   }
1041
1042   DEBUG ("fc_process_chain (%s): Signaling `continue' at end of chain.",
1043       chain->name);
1044
1045   return (FC_TARGET_CONTINUE);
1046 } /* }}} int fc_process_chain */
1047
1048 /* Iterate over all rules in the chain and execute all targets for which all
1049  * matches match. */
1050 int fc_default_action (const data_set_t *ds, value_list_t *vl) /* {{{ */
1051 {
1052   /* FIXME: Pass the meta-data to match targets here (when implemented). */
1053   return (fc_bit_write_invoke (ds, vl,
1054         /* meta = */ NULL, /* user_data = */ NULL));
1055 } /* }}} int fc_default_action */
1056
1057 int fc_configure (const oconfig_item_t *ci) /* {{{ */
1058 {
1059   fc_init_once ();
1060
1061   if (ci == NULL)
1062     return (-EINVAL);
1063
1064   if (strcasecmp ("Chain", ci->key) == 0)
1065     return (fc_config_add_chain (ci));
1066
1067   WARNING ("Filter subsystem: Unknown top level config option `%s'.",
1068       ci->key);
1069
1070   return (-1);
1071 } /* }}} int fc_configure */
1072
1073 /* vim: set sw=2 sts=2 et fdm=marker : */