filter/filter.h

   1 /*
   2  *      BIRD Internet Routing Daemon -- Filters
   3  *
   4  *      (c) 1999 Pavel Machek <pavel@ucw.cz>
   5  *
   6  *      Can be freely distributed and used under the terms of the GNU GPL.
   7  */
   8
   9 #ifndef _BIRD_FILT_H_
  10 #define _BIRD_FILT_H_
  11
  12 #include "lib/resource.h"
  13 #include "lib/ip.h"
  14 #include "nest/route.h"
  15 #include "nest/attrs.h"
  16
  17 struct f_inst {         /* Instruction */
  18   struct f_inst *next;  /* Structure is 16 bytes, anyway */
  19   u16 code;             /* Instruction code, see the interpret() function and P() macro */
  20   u16 aux;              /* Extension to instruction code, T_*, EA_*, EAF_*  */
  21   union {
  22     uint i;
  23     void *p;
  24   } a1;                 /* The first argument */
  25   union {
  26     uint i;
  27     void *p;
  28   } a2;                 /* The second argument */
  29   int lineno;
  30 };
  31
  32 #define arg1 a1.p
  33 #define arg2 a2.p
  34
  35 /* Not enough fields in f_inst for three args used by roa_check() */
  36 struct f_inst_roa_check {
  37   struct f_inst i;
  38   struct rtable_config *rtc;
  39 };
  40
  41 struct f_inst3 {
  42   struct f_inst i;
  43   union {
  44     int i;
  45     void *p;
  46   } a3;
  47 };
  48
  49 #define INST3(x) (((struct f_inst3 *) x)->a3)
  50
  51
  52 struct f_prefix {
  53   net_addr net;
  54   u8 lo, hi;
  55 };
  56
  57 struct f_val {
  58   int type;             /* T_*  */
  59   union {
  60     uint i;
  61     u64 ec;
  62     lcomm lc;
  63     ip_addr ip;
  64     const net_addr *net;
  65     char *s;
  66     struct f_tree *t;
  67     struct f_trie *ti;
  68     struct adata *ad;
  69     struct f_path_mask *path_mask;
  70   } val;
  71 };
  72
  73 struct filter {
  74   char *name;
  75   struct f_inst *root;
  76 };
  77
  78 struct f_inst *f_new_inst(void);
  79 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 */
  80 struct f_tree *f_new_tree(void);
  81 struct f_inst *f_generate_complex(int operation, int operation_aux, struct f_inst *dyn, struct f_inst *argument);
  82 struct f_inst *f_generate_roa_check(struct rtable_config *table, struct f_inst *prefix, struct f_inst *asn);
  83
  84
  85 struct f_tree *build_tree(struct f_tree *);
  86 struct f_tree *find_tree(struct f_tree *t, struct f_val val);
  87 int same_tree(struct f_tree *t1, struct f_tree *t2);
  88 void tree_format(struct f_tree *t, buffer *buf);
  89
  90 struct f_trie *f_new_trie(linpool *lp, uint node_size);
  91 void *trie_add_prefix(struct f_trie *t, const net_addr *n, uint l, uint h);
  92 int trie_match_net(struct f_trie *t, const net_addr *n);
  93 int trie_same(struct f_trie *t1, struct f_trie *t2);
  94 void trie_format(struct f_trie *t, buffer *buf);
  95
  96 struct ea_list;
  97 struct rte;
  98
  99 int f_run(struct filter *filter, struct rte **rte, struct ea_list **tmp_attrs, struct linpool *tmp_pool, int flags);
 100 struct f_val f_eval_rte(struct f_inst *expr, struct rte **rte, struct linpool *tmp_pool);
 101 struct f_val f_eval(struct f_inst *expr, struct linpool *tmp_pool);
 102 uint f_eval_int(struct f_inst *expr);
 103 u32 f_eval_asn(struct f_inst *expr);
 104
 105 char *filter_name(struct filter *filter);
 106 int filter_same(struct filter *new, struct filter *old);
 107
 108 int i_same(struct f_inst *f1, struct f_inst *f2);
 109
 110 int val_compare(struct f_val v1, struct f_val v2);
 111 int val_same(struct f_val v1, struct f_val v2);
 112
 113 void val_format(struct f_val v, buffer *buf);
 114
 115
 116 #define F_NOP 0
 117 #define F_NONL 1
 118 #define F_ACCEPT 2      /* Need to preserve ordering: accepts < rejects! */
 119 #define F_REJECT 3
 120 #define F_ERROR 4
 121 #define F_QUITBIRD 5
 122
 123 #define FILTER_ACCEPT NULL
 124 #define FILTER_REJECT ((void *) 1)
 125 #define FILTER_UNDEF  ((void *) 2)      /* Used in BGP */
 126
 127 /* Type numbers must be in 0..0xff range */
 128 #define T_MASK 0xff
 129
 130 /* Internal types */
 131 /* Do not use type of zero, that way we'll see errors easier. */
 132 #define T_VOID 1
 133
 134 /* User visible types, which fit in int */
 135 #define T_INT 0x10
 136 #define T_BOOL 0x11
 137 #define T_PAIR 0x12  /* Notice that pair is stored as integer: first << 16 | second */
 138 #define T_QUAD 0x13
 139
 140 /* Put enumerational types in 0x30..0x3f range */
 141 #define T_ENUM_LO 0x30
 142 #define T_ENUM_HI 0x3f
 143
 144 #define T_ENUM_RTS 0x30
 145 #define T_ENUM_BGP_ORIGIN 0x31
 146 #define T_ENUM_SCOPE 0x32
 147 #define T_ENUM_RTC 0x33
 148 #define T_ENUM_RTD 0x34
 149 #define T_ENUM_ROA 0x35
 150 #define T_ENUM_NETTYPE 0x36
 151 #define T_ENUM_RA_PREFERENCE 0x37
 152
 153 /* new enums go here */
 154 #define T_ENUM_EMPTY 0x3f       /* Special hack for atomic_aggr */
 155
 156 #define T_ENUM T_ENUM_LO ... T_ENUM_HI
 157
 158 /* Bigger ones */
 159 #define T_IP 0x20
 160 #define T_NET 0x21
 161 #define T_STRING 0x22
 162 #define T_PATH_MASK 0x23        /* mask for BGP path */
 163 #define T_PATH 0x24             /* BGP path */
 164 #define T_CLIST 0x25            /* Community list */
 165 #define T_EC 0x26               /* Extended community value, u64 */
 166 #define T_ECLIST 0x27           /* Extended community list */
 167 #define T_LC 0x28               /* Large community value, lcomm */
 168 #define T_LCLIST 0x29           /* Large community list */
 169 #define T_RD 0x2a               /* Route distinguisher for VPN addresses */
 170
 171 #define T_RETURN 0x40
 172 #define T_SET 0x80
 173 #define T_PREFIX_SET 0x81
 174
 175
 176 #define SA_FROM          1
 177 #define SA_GW            2
 178 #define SA_NET           3
 179 #define SA_PROTO         4
 180 #define SA_SOURCE        5
 181 #define SA_SCOPE         6
 182 #define SA_DEST          7
 183 #define SA_IFNAME        8
 184 #define SA_IFINDEX       9
 185
 186
 187 struct f_tree {
 188   struct f_tree *left, *right;
 189   struct f_val from, to;
 190   void *data;
 191 };
 192
 193 struct f_trie_node
 194 {
 195   ip_addr addr, mask, accept;
 196   uint plen;
 197   struct f_trie_node *c[2];
 198 };
 199
 200 struct f_trie
 201 {
 202   linpool *lp;
 203   int zero;
 204   uint node_size;
 205   struct f_trie_node root[0];           /* Root trie node follows */
 206 };
 207
 208 #define NEW_F_VAL struct f_val * val; val = cfg_alloc(sizeof(struct f_val));
 209
 210 #define FF_FORCE_TMPATTR 1              /* Force all attributes to be temporary */
 211
 212 /* Bird Tests */
 213 struct f_bt_test_suite {
 214   node n;                       /* Node in config->tests */
 215   struct f_inst *fn;            /* Root of function */
 216   const char *fn_name;          /* Name of test */
 217   const char *dsc;              /* Description */
 218 };
 219
 220 /* Hook for call bt_assert() function in configuration */
 221 extern void (*bt_assert_hook)(int result, struct f_inst *assert);
 222
 223 #endif