]> git.ipfire.org Git - thirdparty/bird.git/blobdiff - filter/filter.c
Revert "Reducing filter stack size to allow for lesser thread stack size"
[thirdparty/bird.git] / filter / filter.c
index 98df7bd09f33ed51769a80557680833b36303213..20a380dc0a29f48ada71bdc8db4b989a364a43f4 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/data.h"
 
 
+/* Exception bits */
+enum f_exception {
+  FE_RETURN = 0x1,
+};
+
+
 struct filter_stack {
   /* Value stack for execution */
 #define F_VAL_STACK_MAX        4096
@@ -94,13 +94,8 @@ struct filter_state {
   int flags;
 };
 
-#if HAVE_THREAD_LOCAL
 _Thread_local static struct filter_state filter_state;
 _Thread_local static struct filter_stack filter_stack;
-#define FS_INIT(...)   filter_state = (struct filter_state) { .stack = &filter_stack, __VA_ARGS__ }
-#else
-#define FS_INIT(...)   struct filter_state filter_state = { .stack = alloca(sizeof(struct filter_stack)), __VA_ARGS__ };
-#endif
 
 void (*bt_assert_hook)(int result, const struct f_line_item *assert);
 
@@ -144,243 +139,8 @@ f_rta_cow(struct filter_state *fs)
   f_cache_eattrs(fs);
 }
 
-static char *
-val_format_str(struct filter_state *fs, const 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;
 
-#define runtime(fmt, ...) do { \
-  if (!(fs->flags & FF_SILENT)) \
-    log_rl(&rl_runtime_err, L_ERR "filters, line %d: " fmt, \
-       (fs->stack->estk[fs->stack->ecnt-1].line->items[fs->stack->estk[fs->stack->ecnt-1].pos-1]).lineno, \
-       ##__VA_ARGS__); \
-  return F_ERROR; \
-} while(0)
-
-#define ACCESS_RTE do { if (!fs->rte) runtime("No route to access"); } while (0)
-#define ACCESS_EATTRS do { if (!fs->eattrs) f_cache_eattrs(fs); } while (0)
-
-static inline enum filter_return
-f_rta_set(struct filter_state *fs, struct f_static_attr sa, const struct f_val *val)
-{
-    ACCESS_RTE;
-    if (sa.f_type != val->type)
-      runtime( "Attempt to set static attribute to incompatible type" );
-
-    f_rta_cow(fs);
-    {
-      struct rta *rta = (*fs->rte)->attrs;
-
-      switch (sa.sa_code)
-      {
-      case SA_FROM:
-       rta->from = val->val.ip;
-       return F_NOP;
-
-      case SA_GW:
-       {
-         ip_addr ip = val->val.ip;
-         neighbor *n = neigh_find(rta->src->proto, ip, NULL, 0);
-         if (!n || (n->scope == SCOPE_HOST))
-           runtime( "Invalid gw address" );
-
-         rta->dest = RTD_UNICAST;
-         rta->nh.gw = ip;
-         rta->nh.iface = n->iface;
-         rta->nh.next = NULL;
-         rta->hostentry = NULL;
-       }
-       return F_NOP;
-
-      case SA_SCOPE:
-       rta->scope = val->val.i;
-       return F_NOP;
-
-      case SA_DEST:
-       {
-         int i = val->val.i;
-         if ((i != RTD_BLACKHOLE) && (i != RTD_UNREACHABLE) && (i != RTD_PROHIBIT))
-           runtime( "Destination can be changed only to blackhole, unreachable or prohibit" );
-
-         rta->dest = i;
-         rta->nh.gw = IPA_NONE;
-         rta->nh.iface = NULL;
-         rta->nh.next = NULL;
-         rta->hostentry = NULL;
-       }
-       return F_NOP;
-
-      case SA_IFNAME:
-       {
-         struct iface *ifa = if_find_by_name(val->val.s);
-         if (!ifa)
-           runtime( "Invalid iface name" );
-
-         rta->dest = RTD_UNICAST;
-         rta->nh.gw = IPA_NONE;
-         rta->nh.iface = ifa;
-         rta->nh.next = NULL;
-         rta->hostentry = NULL;
-       }
-       return F_NOP;
-
-      default:
-       bug("Invalid static attribute access (%u/%u)", sa.f_type, sa.sa_code);
-      }
-    }
-}
-
-static inline enum filter_return
-f_ea_set(struct filter_state *fs, struct f_dynamic_attr da, const struct f_val *val)
-{
-    ACCESS_RTE;
-    ACCESS_EATTRS;
-    {
-      struct ea_list *l = lp_alloc(fs->pool, sizeof(struct ea_list) + sizeof(eattr));
-
-      l->next = NULL;
-      l->flags = EALF_SORTED;
-      l->count = 1;
-      l->attrs[0].id = da.ea_code;
-      l->attrs[0].flags = 0;
-      l->attrs[0].type = da.type | EAF_ORIGINATED | EAF_FRESH;
-
-      switch (da.type) {
-      case EAF_TYPE_INT:
-       if (val->type != da.f_type)
-         runtime( "Setting int attribute to non-int value" );
-       l->attrs[0].u.data = val->val.i;
-       break;
-
-      case EAF_TYPE_ROUTER_ID:
-       /* IP->Quad implicit conversion */
-       if (val_is_ip4(val)) {
-         l->attrs[0].u.data = ipa_to_u32(val->val.ip);
-         break;
-       }
-       /* T_INT for backward compatibility */
-       if ((val->type != T_QUAD) && (val->type != T_INT))
-         runtime( "Setting quad attribute to non-quad value" );
-       l->attrs[0].u.data = val->val.i;
-       break;
-
-      case EAF_TYPE_OPAQUE:
-       runtime( "Setting opaque attribute is not allowed" );
-       break;
-      case EAF_TYPE_IP_ADDRESS:
-       if (val->type != T_IP)
-         runtime( "Setting ip attribute to non-ip value" );
-       int len = sizeof(ip_addr);
-       struct adata *ad = lp_alloc(fs->pool, sizeof(struct adata) + len);
-       ad->length = len;
-       (* (ip_addr *) ad->data) = val->val.ip;
-       l->attrs[0].u.ptr = ad;
-       break;
-      case EAF_TYPE_AS_PATH:
-       if (val->type != T_PATH)
-         runtime( "Setting path attribute to non-path value" );
-       l->attrs[0].u.ptr = val->val.ad;
-       break;
-      case EAF_TYPE_BITFIELD:
-       if (val->type != T_BOOL)
-         runtime( "Setting bit in bitfield attribute to non-bool value" );
-       {
-         /* First, we have to find the old value */
-         eattr *e = ea_find(*fs->eattrs, da.ea_code);
-         u32 data = e ? e->u.data : 0;
-
-         if (val->val.i)
-           l->attrs[0].u.data = data | (1u << da.bit);
-         else
-           l->attrs[0].u.data = data & ~(1u << da.bit);
-       }
-       break;
-      case EAF_TYPE_INT_SET:
-       if (val->type != T_CLIST)
-         runtime( "Setting clist attribute to non-clist value" );
-       l->attrs[0].u.ptr = val->val.ad;
-       break;
-      case EAF_TYPE_EC_SET:
-       if (val->type != T_ECLIST)
-         runtime( "Setting eclist attribute to non-eclist value" );
-       l->attrs[0].u.ptr = val->val.ad;
-       break;
-      case EAF_TYPE_LC_SET:
-       if (val->type != T_LCLIST)
-         runtime( "Setting lclist attribute to non-lclist value" );
-       l->attrs[0].u.ptr = val->val.ad;
-       break;
-      default: bug("Unknown type in e,S");
-      }
-
-      f_rta_cow(fs);
-      l->next = *fs->eattrs;
-      *fs->eattrs = l;
-
-      return F_NOP;
-    }
-}
-
-static inline enum filter_return
-f_lval_set(struct filter_state *fs, const struct f_lval *lv, const struct f_val *val)
-{
-  switch (lv->type) {
-    case F_LVAL_STACK:
-      fs->stack->vstk[fs->stack->vcnt] = *val;
-      fs->stack->vcnt++;
-      return F_NOP;
-    case F_LVAL_EXCEPTION:
-      {
-       /* Drop every sub-block including ourselves */
-       while ((fs->stack->ecnt-- > 0) && !(fs->stack->estk[fs->stack->ecnt].emask & lv->exception))
-         ;
-
-       /* Now we are at the catch frame; if no such, try to convert to accept/reject. */
-       if (!fs->stack->ecnt)
-         if (lv->exception == FE_RETURN)
-           if (val->type == T_BOOL)
-             if (val->val.i)
-               return F_ACCEPT;
-             else
-               return F_REJECT;
-           else
-             runtime("Can't return non-bool from non-function");
-         else
-           runtime("Unhandled exception 0x%x: %s", lv->exception, val_format_str(fs, val));
-
-       /* Set the value stack position, overwriting the former implicit void */
-       fs->stack->vcnt = fs->stack->estk[fs->stack->ecnt].ventry;
-
-       /* Copy the return value */
-       fs->stack->vstk[fs->stack->vcnt - 1] = *val;
-       return F_NOP;
-      }
-    case F_LVAL_VARIABLE:
-      fs->stack->vstk[fs->stack->estk[fs->stack->ecnt-1].vbase + lv->sym->offset] = *val;
-      return F_NOP;
-    case F_LVAL_PREFERENCE:
-      ACCESS_RTE;
-      if (val->type != T_INT)
-       runtime("Preference must be integer, got 0x%02x", val->type);
-      if (val->val.i > 0xFFFF)
-       runtime("Preference is at most 65536");
-      f_rte_cow(fs);
-      (*fs->rte)->pref = val->val.i;
-      return F_NOP;
-    case F_LVAL_SA:
-      return f_rta_set(fs, lv->sa, val);
-    case F_LVAL_EA:
-      return f_ea_set(fs, lv->da, val);
-    default:
-      bug("This shall never happen");
-  }    
-}
-
 /**
  * interpret
  * @fs: filter state
@@ -410,12 +170,12 @@ interpret(struct filter_state *fs, const struct f_line *line, struct f_val *val)
 
   /* The same as with the value stack. Not resetting the stack for performance reasons. */
   fstk->ecnt = 1;
-  fstk->estk[0].line = line;           
+  fstk->estk[0].line = line;
   fstk->estk[0].pos = 0;
 
 #define curline fstk->estk[fstk->ecnt-1]
 
-#if DEBUGGING
+#ifdef LOCAL_DEBUG
   debug("Interpreting line.");
   f_dump_line(line, 1);
 #endif
@@ -426,9 +186,21 @@ interpret(struct filter_state *fs, const struct f_line *line, struct f_val *val)
 
       switch (what->fi_code) {
 #define res fstk->vstk[fstk->vcnt]
-#define v1 fstk->vstk[fstk->vcnt]
-#define v2 fstk->vstk[fstk->vcnt + 1]
-#define v3 fstk->vstk[fstk->vcnt + 2]
+#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)) \
+    log_rl(&rl_runtime_err, L_ERR "filters, line %d: " fmt, what->lineno, ##__VA_ARGS__); \
+  return F_ERROR; \
+} 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"
 #undef res
@@ -436,25 +208,15 @@ 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
       }
     }
-    
+
     /* End of current line. Drop local variables before exiting. */
-    fstk->vcnt -= curline.line->vars;
-    fstk->vcnt -= curline.line->args;
+    fstk->vcnt = curline.ventry + curline.line->results;
     fstk->ecnt--;
-
-    /* If the caller wants to store the result somewhere, do it. */
-    if (fstk->ecnt) {
-      const struct f_line_item *caller = &(curline.line->items[curline.pos-1]);
-      if (caller->result.type != F_LVAL_STACK) {
-       enum filter_return fret = f_lval_set(fs, &(caller->result), &fstk->vstk[--fstk->vcnt]);
-       if (fret != F_NOP)
-         return fret;
-      }
-    }
   }
 
   if (fstk->vcnt == 0) {
@@ -512,11 +274,12 @@ f_run(const struct filter *filter, struct rte **rte, struct linpool *tmp_pool, i
   DBG( "Running filter `%s'...", filter->name );
 
   /* Initialize the filter state */
-  FS_INIT(
-      .rte = rte,
-      .pool = tmp_pool,
-      .flags = flags,
-      );
+  filter_state = (struct filter_state) {
+    .stack = &filter_stack,
+    .rte = rte,
+    .pool = tmp_pool,
+    .flags = flags,
+  };
 
   LOG_BUFFER_INIT(filter_state.buf);
 
@@ -560,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
@@ -575,10 +338,11 @@ f_run(const struct filter *filter, struct rte **rte, struct linpool *tmp_pool, i
 enum filter_return
 f_eval_rte(const struct f_line *expr, struct rte **rte, struct linpool *tmp_pool)
 {
-  FS_INIT(
-      .rte = rte,
-      .pool = tmp_pool,
-      );
+  filter_state = (struct filter_state) {
+    .stack = &filter_stack,
+    .rte = rte,
+    .pool = tmp_pool,
+  };
 
   LOG_BUFFER_INIT(filter_state.buf);
 
@@ -589,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
@@ -597,9 +361,10 @@ f_eval_rte(const struct f_line *expr, struct rte **rte, struct linpool *tmp_pool
 enum filter_return
 f_eval(const struct f_line *expr, struct linpool *tmp_pool, struct f_val *pres)
 {
-  FS_INIT(
-      .pool = tmp_pool,
-      );
+  filter_state = (struct filter_state) {
+    .stack = &filter_stack,
+    .pool = tmp_pool,
+  };
 
   LOG_BUFFER_INIT(filter_state.buf);
 
@@ -608,7 +373,7 @@ 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 
+ * f_eval_int - get an integer value of a term
  * Called internally from the config parser, uses its internal memory pool
  * for allocations. Do not call in other cases.
  */
@@ -616,16 +381,17 @@ uint
 f_eval_int(const struct f_line *expr)
 {
   /* Called independently in parse-time to eval expressions */
-  FS_INIT(
-      .pool = cfg_mem,
-      );
+  filter_state = (struct filter_state) {
+    .stack = &filter_stack,
+    .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");
+    cf_error("Runtime error while evaluating expression; see log for details");
 
   if (val.type != T_INT)
     cf_error("Integer expression expected");
@@ -634,14 +400,14 @@ f_eval_int(const struct f_line *expr)
 }
 
 /*
- * 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;
 }
@@ -680,7 +446,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;
@@ -707,3 +473,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);
+           }
+         }
+       }
+    }
+  }
+}