]> git.ipfire.org Git - thirdparty/bird.git/blobdiff - filter/filter.c
Filter: any lvalue can get its methods called
[thirdparty/bird.git] / filter / filter.c
index 50d9414b37dd7a2ff2599e8d5657a9043d204ebc..d080cadcf747244e21a74e1ed986c191983b1310 100644 (file)
  * the source from user into a tree of &f_inst structures. These trees are
  * later interpreted using code in |filter/filter.c|.
  *
- * A filter is represented by a tree of &f_inst structures, one structure per
- * "instruction". Each &f_inst contains @code, @aux value which is
- * usually the data type this instruction operates on and two generic
- * arguments (@a[0], @a[1]). Some instructions contain pointer(s) to other
- * instructions in their (@a[0], @a[1]) fields.
+ * A filter is represented by a tree of &f_inst structures, later translated
+ * into lists called &f_line. All the instructions are defined and documented
+ * in |filter/f-inst.c| definition file.
  *
  * Filters use a &f_val structure for their data. Each &f_val
- * contains type and value (types are constants prefixed with %T_). Few
- * of the types are special; %T_RETURN can be or-ed with a type to indicate
- * that return from a function or from the whole filter should be
- * forced. Important thing about &f_val's is that they may be copied
- * with a simple |=|. That's fine for all currently defined types: strings
- * are read-only (and therefore okay), paths are copied for each
- * operation (okay too).
+ * contains type and value (types are constants prefixed with %T_).
+ * Look into |filter/data.h| for more information and appropriate calls.
  */
 
 #undef LOCAL_DEBUG
@@ -39,8 +32,9 @@
 #include "lib/socket.h"
 #include "lib/string.h"
 #include "lib/unaligned.h"
-#include "lib/net.h"
 #include "lib/ip.h"
+#include "lib/net.h"
+#include "lib/flowspec.h"
 #include "nest/route.h"
 #include "nest/protocol.h"
 #include "nest/iface.h"
 #include "filter/f-inst.h"
 #include "filter/data.h"
 
+
+/* Exception bits */
+enum f_exception {
+  FE_RETURN = 0x1,
+};
+
+
+struct filter_stack {
+  /* Value stack for execution */
+#define F_VAL_STACK_MAX        4096
+  uint vcnt;                           /* Current value stack size; 0 for empty */
+  uint ecnt;                           /* Current execute stack size; 0 for empty */
+
+  struct f_val vstk[F_VAL_STACK_MAX];  /* The stack itself */
+
+  /* Instruction stack for execution */
+#define F_EXEC_STACK_MAX 4096
+  struct {
+    const struct f_line *line;         /* The line that is being executed */
+    uint pos;                          /* Instruction index in the line */
+    uint ventry;                       /* Value stack depth on entry */
+    uint vbase;                                /* Where to index variable positions from */
+    enum f_exception emask;            /* Exception mask */
+  } estk[F_EXEC_STACK_MAX];
+};
+
 /* Internal filter state, to be allocated on stack when executing filters */
-_Thread_local struct filter_state {
+struct filter_state {
+  /* Stacks needed for execution */
+  struct filter_stack *stack;
+
   /* The route we are processing. This may be NULL to indicate no route available. */
   struct rte **rte;
 
@@ -60,10 +83,19 @@ _Thread_local struct filter_state {
 
   /* Cached pointer to ea_list */
   struct ea_list **eattrs;
+
+  /* Linpool for adata allocation */
   struct linpool *pool;
+
+  /* Buffer for log output */
   struct buffer buf;
+
+  /* Filter execution flags */
   int flags;
-} filter_state;
+};
+
+_Thread_local static struct filter_state filter_state;
+_Thread_local static struct filter_stack filter_stack;
 
 void (*bt_assert_hook)(int result, const struct f_line_item *assert);
 
@@ -107,14 +139,6 @@ f_rta_cow(struct filter_state *fs)
   f_cache_eattrs(fs);
 }
 
-static char *
-val_format_str(struct filter_state *fs, struct f_val *v) {
-  buffer b;
-  LOG_BUFFER_INIT(b);
-  val_format(v, &b);
-  return lp_strdup(fs->pool, b.start);
-}
-
 static struct tbf rl_runtime_err = TBF_DEFAULT_LOG_LIMITS;
 
 /**
@@ -135,58 +159,37 @@ static struct tbf rl_runtime_err = TBF_DEFAULT_LOG_LIMITS;
 static enum filter_return
 interpret(struct filter_state *fs, const struct f_line *line, struct f_val *val)
 {
+  /* No arguments allowed */
+  ASSERT(line->args == 0);
 
-#define F_VAL_STACK_MAX        4096
-  /* Value stack for execution */
-  struct f_val_stack {
-    uint cnt;                          /* Current stack size; 0 for empty */
-    struct f_val val[F_VAL_STACK_MAX]; /* The stack itself */
-  } vstk;
-
-  /* The stack itself is intentionally kept as-is for performance reasons.
-   * Do NOT rewrite this to initialization by struct literal. It's slow.
-   */
-  vstk.cnt = 0;
-#define F_EXEC_STACK_MAX 4096
+  /* Initialize the filter stack */
+  struct filter_stack *fstk = fs->stack;
 
-  /* Exception bits */
-  enum f_exception {
-    FE_RETURN = 0x1,
-  };
-
-  /* Instruction stack for execution */
-  struct f_exec_stack {
-    struct {
-      const struct f_line *line;               /* The line that is being executed */
-      uint pos;                                /* Instruction index in the line */
-      uint ventry;                     /* Value stack depth on entry */
-      enum f_exception emask;          /* Exception mask */
-    } item[F_EXEC_STACK_MAX];
-    uint cnt;                          /* Current stack size; 0 for empty */
-  } estk;
+  fstk->vcnt = line->vars;
+  memset(fstk->vstk, 0, sizeof(struct f_val) * line->vars);
 
   /* The same as with the value stack. Not resetting the stack for performance reasons. */
-  estk.cnt = 1;
-  estk.item[0].line = line;            
-  estk.item[0].pos = 0;
+  fstk->ecnt = 1;
+  fstk->estk[0].line = line;
+  fstk->estk[0].pos = 0;
 
-#define curline estk.item[estk.cnt-1]
+#define curline fstk->estk[fstk->ecnt-1]
 
-#if DEBUGGING
+#ifdef LOCAL_DEBUG
   debug("Interpreting line.");
   f_dump_line(line, 1);
 #endif
 
-  while (estk.cnt > 0) {
+  while (fstk->ecnt > 0) {
     while (curline.pos < curline.line->len) {
       const struct f_line_item *what = &(curline.line->items[curline.pos++]);
 
-
       switch (what->fi_code) {
-#define res vstk.val[vstk.cnt]
-#define v1 vstk.val[vstk.cnt]
-#define v2 vstk.val[vstk.cnt + 1]
-#define v3 vstk.val[vstk.cnt + 2]
+#define res fstk->vstk[fstk->vcnt]
+#define vv(i) fstk->vstk[fstk->vcnt + (i)]
+#define v1 vv(0)
+#define v2 vv(1)
+#define v3 vv(2)
 
 #define runtime(fmt, ...) do { \
   if (!(fs->flags & FF_SILENT)) \
@@ -194,7 +197,9 @@ interpret(struct filter_state *fs, const struct f_line *line, struct f_val *val)
   return F_ERROR; \
 } while(0)
 
-#define ACCESS_RTE do { if (!fs->rte) runtime("No route to access"); } while (0)
+#define falloc(size)  lp_alloc(fs->pool, size)
+#define fpool fs->pool
+
 #define ACCESS_EATTRS do { if (!fs->eattrs) f_cache_eattrs(fs); } while (0)
 
 #include "filter/inst-interpret.c"
@@ -203,30 +208,32 @@ interpret(struct filter_state *fs, const struct f_line *line, struct f_val *val)
 #undef v2
 #undef v3
 #undef runtime
-#undef ACCESS_RTE
+#undef falloc
+#undef fpool
 #undef ACCESS_EATTRS
       }
     }
-    estk.cnt--;
+
+    /* End of current line. Drop local variables before exiting. */
+    fstk->vcnt = curline.ventry + curline.line->results;
+    fstk->ecnt--;
   }
 
-  switch (vstk.cnt) {
-    case 0:
-      if (val) {
-       log_rl(&rl_runtime_err, L_ERR "filters: No value left on stack");
-       return F_ERROR;
-      }
-      return F_NOP;
-    case 1:
-      if (val) {
-       *val = vstk.val[0];
-       return F_NOP;
-      }
-      /* fallthrough */
-    default:
-      log_rl(&rl_runtime_err, L_ERR "Too many items left on stack: %u", vstk.cnt);
+  if (fstk->vcnt == 0) {
+    if (val) {
+      log_rl(&rl_runtime_err, L_ERR "filters: No value left on stack");
       return F_ERROR;
+    }
+    return F_NOP;
   }
+
+  if (val && (fstk->vcnt == 1)) {
+    *val = fstk->vstk[0];
+    return F_NOP;
+  }
+
+  log_rl(&rl_runtime_err, L_ERR "Too many items left on stack: %u", fstk->vcnt);
+  return F_ERROR;
 }
 
 
@@ -268,6 +275,7 @@ f_run(const struct filter *filter, struct rte **rte, struct linpool *tmp_pool, i
 
   /* Initialize the filter state */
   filter_state = (struct filter_state) {
+    .stack = &filter_stack,
     .rte = rte,
     .pool = tmp_pool,
     .flags = flags,
@@ -315,7 +323,7 @@ f_run(const struct filter *filter, struct rte **rte, struct linpool *tmp_pool, i
 }
 
 /**
- * f_eval_rte  run a filter line for an uncached route
+ * f_eval_rte - run a filter line for an uncached route
  * @expr: filter line to run
  * @rte: route being filtered, may be modified
  * @tmp_pool: all filter allocations go from this pool
@@ -331,6 +339,7 @@ enum filter_return
 f_eval_rte(const struct f_line *expr, struct rte **rte, struct linpool *tmp_pool)
 {
   filter_state = (struct filter_state) {
+    .stack = &filter_stack,
     .rte = rte,
     .pool = tmp_pool,
   };
@@ -344,7 +353,7 @@ f_eval_rte(const struct f_line *expr, struct rte **rte, struct linpool *tmp_pool
 }
 
 /*
- * f_eval  get a value of a term
+ * f_eval - get a value of a term
  * @expr: filter line containing the term
  * @tmp_pool: long data may get allocated from this pool
  * @pres: here the output will be stored
@@ -353,6 +362,7 @@ enum filter_return
 f_eval(const struct f_line *expr, struct linpool *tmp_pool, struct f_val *pres)
 {
   filter_state = (struct filter_state) {
+    .stack = &filter_stack,
     .pool = tmp_pool,
   };
 
@@ -363,40 +373,33 @@ f_eval(const struct f_line *expr, struct linpool *tmp_pool, struct f_val *pres)
 }
 
 /*
- * f_eval_int – get an integer value of a term 
+ * cf_eval - evaluate a value of a term and check its type
  * Called internally from the config parser, uses its internal memory pool
  * for allocations. Do not call in other cases.
  */
-uint
-f_eval_int(const struct f_line *expr)
+struct f_val
+cf_eval(const struct f_inst *inst, int type)
 {
-  /* Called independently in parse-time to eval expressions */
-  filter_state = (struct filter_state) {
-    .pool = cfg_mem,
-  };
-
   struct f_val val;
 
-  LOG_BUFFER_INIT(filter_state.buf);
-
-  if (interpret(&filter_state, expr, &val) > F_RETURN)
-    cf_error("Runtime error while evaluating expression");
+  if (f_eval(f_linearize(inst, 1), cfg_mem, &val) > F_RETURN)
+    cf_error("Runtime error while evaluating expression; see log for details");
 
-  if (val.type != T_INT)
-    cf_error("Integer expression expected");
+  if (type != T_VOID && val.type != type)
+    cf_error("Expression of type %s expected", f_type_name(type));
 
-  return val.val.i;
+  return val;
 }
 
 /*
- * f_eval_buf  get a value of a term and print it to the supplied buffer
+ * f_eval_buf - get a value of a term and print it to the supplied buffer
  */
 enum filter_return
 f_eval_buf(const struct f_line *expr, struct linpool *tmp_pool, buffer *buf)
 {
   struct f_val val;
   enum filter_return fret = f_eval(expr, tmp_pool, &val);
-  if (fret > F_RETURN)
+  if (fret <= F_RETURN)
     val_format(&val, buf);
   return fret;
 }
@@ -435,7 +438,7 @@ filter_same(const struct filter *new, const struct filter *old)
  * filter_commit - do filter comparisons on all the named functions and filters
  */
 void
-filter_commit(const struct config *new, const struct config *old)
+filter_commit(struct config *new, struct config *old)
 {
   if (!old)
     return;
@@ -462,3 +465,41 @@ filter_commit(const struct config *new, const struct config *old)
        break;
     }
 }
+
+void filters_dump_all(void)
+{
+  struct symbol *sym;
+  WALK_LIST(sym, config->symbols) {
+    switch (sym->class) {
+      case SYM_FILTER:
+       debug("Named filter %s:\n", sym->name);
+       f_dump_line(sym->filter->root, 1);
+       break;
+      case SYM_FUNCTION:
+       debug("Function %s:\n", sym->name);
+       f_dump_line(sym->function, 1);
+       break;
+      case SYM_PROTO:
+       {
+         debug("Protocol %s:\n", sym->name);
+         struct channel *c;
+         WALK_LIST(c, sym->proto->proto->channels) {
+           debug(" Channel %s (%s) IMPORT", c->name, net_label[c->net_type]);
+           if (c->in_filter == FILTER_ACCEPT)
+             debug(" ALL\n");
+           else if (c->in_filter == FILTER_REJECT)
+             debug(" NONE\n");
+           else if (c->in_filter == FILTER_UNDEF)
+             debug(" UNDEF\n");
+           else if (c->in_filter->sym) {
+             ASSERT(c->in_filter->sym->filter == c->in_filter);
+             debug(" named filter %s\n", c->in_filter->sym->name);
+           } else {
+             debug("\n");
+             f_dump_line(c->in_filter->root, 2);
+           }
+         }
+       }
+    }
+  }
+}