]> git.ipfire.org Git - thirdparty/bird.git/blobdiff - filter/filter.h
Config: Dropping filter instruction trees after linearization
[thirdparty/bird.git] / filter / filter.h
index 0beac6795cbc61295d343f965e666e7750f733df..26c1037b71f815491019220636cd4222e0096861 100644 (file)
@@ -2,6 +2,7 @@
  *     BIRD Internet Routing Daemon -- Filters
  *
  *     (c) 1999 Pavel Machek <pavel@ucw.cz>
+ *     (c) 2018--2019 Maria Matejka <mq@jmq.cz>
  *
  *     Can be freely distributed and used under the terms of the GNU GPL.
  */
 
 #include "lib/resource.h"
 #include "lib/ip.h"
+#include "lib/macro.h"
 #include "nest/route.h"
 #include "nest/attrs.h"
 
-struct f_inst {                /* Instruction */
-  struct f_inst *next; /* Structure is 16 bytes, anyway */
-  u16 code;            /* Instruction code, see the interpret() function and P() macro */
-  u16 aux;             /* Extension to instruction code, T_*, EA_*, EAF_*  */
-  union {
-    int i;
-    void *p;
-  } a1;                        /* The first argument */
-  union {
-    int i;
-    void *p;
-  } a2;                        /* The second argument */
-  int lineno;
-};
-
-#define arg1 a1.p
-#define arg2 a2.p
-
-/* Not enough fields in f_inst for three args used by roa_check() */
-struct f_inst_roa_check {
-  struct f_inst i;
-  struct rtable_config *rtc;
-};
-
-struct f_inst3 {
-  struct f_inst i;
-  union {
-    int i;
-    void *p;
-  } a3;
-};
-
-#define INST3(x) (((struct f_inst3 *) x)->a3)
-
-
-struct f_prefix {
-  net_addr net;
-  u8 lo, hi;
-};
-
-struct f_val {
-  int type;            /* T_*  */
-  union {
-    uint i;
-    u64 ec;
-    lcomm lc;
-    ip_addr ip;
-    const net_addr *net;
-    char *s;
-    struct f_tree *t;
-    struct f_trie *ti;
-    struct adata *ad;
-    struct f_path_mask *path_mask;
-  } val;
+/* Possible return values of filter execution */
+enum filter_return {
+  F_NOP = 0,
+  F_NONL,
+  F_RETURN,
+  F_ACCEPT,   /* Need to preserve ordering: accepts < rejects! */
+  F_REJECT,
+  F_ERROR,
 };
 
+static inline const char *filter_return_str(const enum filter_return fret) {
+  switch (fret) {
+#define FRS(x) case x: return #x
+    FRS(F_NOP);
+    FRS(F_NONL);
+    FRS(F_RETURN);
+    FRS(F_ACCEPT);
+    FRS(F_REJECT);
+    FRS(F_ERROR);
+#undef FRS
+    default: bug("This shall not happen");
+  }
+}
+
+struct f_val;
+
+/* The filter encapsulating structure to be pointed-to from outside */
+struct f_line;
 struct filter {
-  char *name;
-  struct f_inst *root;
+  struct symbol *sym;
+  const struct f_line *root;
 };
 
-struct f_inst *f_new_inst(void);
-struct f_inst *f_new_dynamic_attr(int type, int f_type, int code);     /* Type as core knows it, type as filters know it, and code of dynamic attribute */
-struct f_tree *f_new_tree(void);
-struct f_inst *f_generate_complex(int operation, int operation_aux, struct f_inst *dyn, struct f_inst *argument);
-struct f_inst *f_generate_roa_check(struct rtable_config *table, struct f_inst *prefix, struct f_inst *asn);
-
-
-struct f_tree *build_tree(struct f_tree *);
-struct f_tree *find_tree(struct f_tree *t, struct f_val val);
-int same_tree(struct f_tree *t1, struct f_tree *t2);
-void tree_format(struct f_tree *t, buffer *buf);
-
-struct f_trie *f_new_trie(linpool *lp, uint node_size);
-void *trie_add_prefix(struct f_trie *t, const net_addr *n, uint l, uint h);
-int trie_match_net(struct f_trie *t, const net_addr *n);
-int trie_same(struct f_trie *t1, struct f_trie *t2);
-void trie_format(struct f_trie *t, buffer *buf);
-
-struct ea_list;
 struct rte;
 
-int f_run(struct filter *filter, struct rte **rte, struct ea_list **tmp_attrs, struct linpool *tmp_pool, int flags);
-struct f_val f_eval_rte(struct f_inst *expr, struct rte **rte, struct linpool *tmp_pool);
-struct f_val f_eval(struct f_inst *expr, struct linpool *tmp_pool);
-uint f_eval_int(struct f_inst *expr);
-u32 f_eval_asn(struct f_inst *expr);
-
-char *filter_name(struct filter *filter);
-int filter_same(struct filter *new, struct filter *old);
-
-int i_same(struct f_inst *f1, struct f_inst *f2);
-
-int val_compare(struct f_val v1, struct f_val v2);
-int val_same(struct f_val v1, struct f_val v2);
+enum filter_return f_run(const struct filter *filter, struct rte **rte, struct linpool *tmp_pool, int flags);
+enum filter_return f_eval_rte(const struct f_line *expr, struct rte **rte, struct linpool *tmp_pool);
+uint f_eval_int(const struct f_line *expr);
+enum filter_return f_eval_buf(const struct f_line *expr, struct linpool *tmp_pool, buffer *buf);
 
-void val_format(struct f_val v, buffer *buf);
+const char *filter_name(const struct filter *filter);
+int filter_same(const struct filter *new, const struct filter *old);
+int f_same(const struct f_line *f1, const struct f_line *f2);
 
+void filter_commit(struct config *new, struct config *old);
 
-#define F_NOP 0
-#define F_NONL 1
-#define F_ACCEPT 2     /* Need to preserve ordering: accepts < rejects! */
-#define F_REJECT 3
-#define F_ERROR 4
-#define F_QUITBIRD 5
+void filters_dump_all(void);
 
 #define FILTER_ACCEPT NULL
-#define FILTER_REJECT ((void *) 1)
-
-/* Type numbers must be in 0..0xff range */
-#define T_MASK 0xff
-
-/* Internal types */
-/* Do not use type of zero, that way we'll see errors easier. */
-#define T_VOID 1
-
-/* User visible types, which fit in int */
-#define T_INT 0x10
-#define T_BOOL 0x11
-#define T_PAIR 0x12  /*        Notice that pair is stored as integer: first << 16 | second */
-#define T_QUAD 0x13
-
-/* Put enumerational types in 0x30..0x3f range */
-#define T_ENUM_LO 0x30
-#define T_ENUM_HI 0x3f
-
-#define T_ENUM_RTS 0x30
-#define T_ENUM_BGP_ORIGIN 0x31
-#define T_ENUM_SCOPE 0x32
-#define T_ENUM_RTC 0x33
-#define T_ENUM_RTD 0x34
-#define T_ENUM_ROA 0x35
-#define T_ENUM_NETTYPE 0x36
-
-/* new enums go here */
-#define T_ENUM_EMPTY 0x3f      /* Special hack for atomic_aggr */
-
-#define T_ENUM T_ENUM_LO ... T_ENUM_HI
-
-/* Bigger ones */
-#define T_IP 0x20
-#define T_NET 0x21
-#define T_STRING 0x22
-#define T_PATH_MASK 0x23       /* mask for BGP path */
-#define T_PATH 0x24            /* BGP path */
-#define T_CLIST 0x25           /* Community list */
-#define T_EC 0x26              /* Extended community value, u64 */
-#define T_ECLIST 0x27          /* Extended community list */
-#define T_LC 0x28              /* Large community value, lcomm */
-#define T_LCLIST 0x29          /* Large community list */
-#define T_RD 0x2a              /* Route distinguisher for VPN addresses */
-
-#define T_RETURN 0x40
-#define T_SET 0x80
-#define T_PREFIX_SET 0x81
-
-
-#define SA_FROM                 1
-#define SA_GW           2
-#define SA_NET          3
-#define SA_PROTO        4
-#define SA_SOURCE       5
-#define SA_SCOPE        6
-#define SA_DEST         7
-#define SA_IFNAME       8
-#define SA_IFINDEX      9
-
-
-struct f_tree {
-  struct f_tree *left, *right;
-  struct f_val from, to;
-  void *data;
-};
-
-struct f_trie_node
-{
-  ip_addr addr, mask, accept;
-  uint plen;
-  struct f_trie_node *c[2];
-};
-
-struct f_trie
-{
-  linpool *lp;
-  int zero;
-  uint node_size;
-  struct f_trie_node root[0];          /* Root trie node follows */
-};
-
-#define NEW_F_VAL struct f_val * val; val = cfg_alloc(sizeof(struct f_val));
+#define FILTER_REJECT ((struct filter *) 1)
+#define FILTER_UNDEF  ((struct filter *) 2)    /* Used in BGP */
 
-#define FF_FORCE_TMPATTR 1             /* Force all attributes to be temporary */
+#define FF_SILENT 2                    /* Silent filter execution */
 
-/* Bird Tests */
-struct f_bt_test_suite {
-  node n;                      /* Node in config->tests */
-  struct f_inst *fn;           /* Root of function */
-  const char *fn_name;         /* Name of test */
-  const char *dsc;             /* Description */
+/* Custom route attributes */
+struct custom_attribute {
+  resource r;
+  struct f_dynamic_attr *fda;
+  const char *name;
 };
 
-/* Hook for call bt_assert() function in configuration */
-extern void (*bt_assert_hook)(int result, struct f_inst *assert);
+struct custom_attribute *ca_lookup(pool *p, const char *name, int ea_type);
 
 #endif