filter.h 8.04 KB
Newer Older
1
/*
2
 *	BIRD Internet Routing Daemon -- Filters
3
 *
4
 *	(c) 1999 Pavel Machek <pavel@ucw.cz>
5 6 7 8 9 10 11 12
 *
 *	Can be freely distributed and used under the terms of the GNU GPL.
 */

#ifndef _BIRD_FILT_H_
#define _BIRD_FILT_H_

#include "lib/resource.h"
13
#include "lib/ip.h"
14
#include "nest/route.h"
15
#include "nest/attrs.h"
16

17 18 19 20 21 22 23 24 25 26 27 28 29
/* Filter instruction types */

#define FI__TWOCHAR(a,b)	((a<<8) | b)
#define FI__LIST \
  F(FI_ADD,			  0, '+') \
  F(FI_SUBTRACT,		  0, '-') \
  F(FI_MULTIPLY,		  0, '*') \
  F(FI_DIVIDE,			  0, '/') \
  F(FI_AND,			  0, '&') \
  F(FI_OR,			  0, '|') \
  F(FI_PAIR_CONSTRUCT,		'm', 'p') \
  F(FI_EC_CONSTRUCT,		'm', 'c') \
  F(FI_LC_CONSTRUCT,		'm', 'l') \
30
  F(FI_PATHMASK_CONSTRUCT,	'm', 'P') \
31 32 33 34 35 36 37 38
  F(FI_NEQ,			'!', '=') \
  F(FI_EQ,			'=', '=') \
  F(FI_LT,			  0, '<') \
  F(FI_LTE,			'<', '=') \
  F(FI_NOT,			  0, '!') \
  F(FI_MATCH,			  0, '~') \
  F(FI_NOT_MATCH,		'!', '~') \
  F(FI_DEFINED,			'd', 'e') \
39 40
  F(FI_TYPE,			  0, 'T') \
  F(FI_IS_V4,			'I', 'i') \
41 42 43 44 45 46 47 48 49 50 51 52 53 54 55
  F(FI_SET,			  0, 's') \
  F(FI_CONSTANT,		  0, 'c') \
  F(FI_VARIABLE,		  0, 'V') \
  F(FI_CONSTANT_INDIRECT,	  0, 'C') \
  F(FI_PRINT,			  0, 'p') \
  F(FI_CONDITION,		  0, '?') \
  F(FI_NOP,			  0, '0') \
  F(FI_PRINT_AND_DIE,		'p', ',') \
  F(FI_RTA_GET,			  0, 'a') \
  F(FI_RTA_SET,			'a', 'S') \
  F(FI_EA_GET,			'e', 'a') \
  F(FI_EA_SET,			'e', 'S') \
  F(FI_PREF_GET,		  0, 'P') \
  F(FI_PREF_SET,		'P', 'S') \
  F(FI_LENGTH,			  0, 'L') \
56 57
  F(FI_ROA_MAXLEN,		'R', 'M') \
  F(FI_ROA_ASN,			'R', 'A') \
58
  F(FI_SADR_SRC,		'n', 's') \
59
  F(FI_IP,			'c', 'p') \
60
  F(FI_ROUTE_DISTINGUISHER,	'R', 'D') \
61 62 63 64 65 66 67 68 69 70 71
  F(FI_AS_PATH_FIRST,		'a', 'f') \
  F(FI_AS_PATH_LAST,		'a', 'l') \
  F(FI_AS_PATH_LAST_NAG,	'a', 'L') \
  F(FI_RETURN,			  0, 'r') \
  F(FI_CALL,			'c', 'a') \
  F(FI_CLEAR_LOCAL_VARS,	'c', 'V') \
  F(FI_SWITCH,			'S', 'W') \
  F(FI_IP_MASK,			'i', 'M') \
  F(FI_EMPTY,			  0, 'E') \
  F(FI_PATH_PREPEND,		'A', 'p') \
  F(FI_CLIST_ADD_DEL,		'C', 'a') \
72 73 74
  F(FI_ROA_CHECK,		'R', 'C') \
  F(FI_FORMAT,			  0, 'F') \
  F(FI_ASSERT,			'a', 's')
75 76 77

enum f_instruction_code {
#define F(c,a,b) \
78
  c,
79 80
FI__LIST
#undef F
81
  FI__MAX,
82 83
} PACKED;

84 85
const char *f_instruction_name(enum f_instruction_code fi);

86 87
struct f_inst {		/* Instruction */
  struct f_inst *next;	/* Structure is 16 bytes, anyway */
88
  enum f_instruction_code fi_code;
89
  u16 aux;		/* Extension to instruction code, T_*, EA_*, EAF_*  */
90
  union {
91
    uint i;
92
    void *p;
93
  } a1;			/* The first argument */
94
  union {
95
    uint i;
96
    void *p;
97
  } a2;			/* The second argument */
98 99 100 101
  union {
    int i;
    void *p;
  } a3;			/* The third argument */
102
  int lineno;
103 104
};

105 106 107
#define arg1 a1.p
#define arg2 a2.p

108 109 110
/* Not enough fields in f_inst for three args used by roa_check() */
struct f_inst_roa_check {
  struct f_inst i;
111
  struct rtable_config *rtc;
112 113
};

114
struct f_prefix {
115
  net_addr net;
116
  u8 lo, hi;
117 118
};

119
struct f_val {
120
  int type;		/* T_*  */
121
  union {
122
    uint i;
123
    u64 ec;
124
    lcomm lc;
125 126
    ip_addr ip;
    const net_addr *net;
127
    char *s;
128
    struct f_tree *t;
129
    struct f_trie *ti;
130 131
    struct adata *ad;
    struct f_path_mask *path_mask;
132 133 134
  } val;
};

135 136 137 138 139 140 141 142 143 144 145 146
struct f_dynamic_attr {
  int type;
  int f_type;
  int ea_code;
};

struct f_static_attr {
  int f_type;
  int sa_code;
  int readonly;
};

147 148 149 150 151
struct filter {
  char *name;
  struct f_inst *root;
};

152 153 154 155 156 157 158
struct f_inst *f_new_inst(enum f_instruction_code fi_code);
struct f_inst *f_new_inst_da(enum f_instruction_code fi_code, struct f_dynamic_attr da);
struct f_inst *f_new_inst_sa(enum f_instruction_code fi_code, struct f_static_attr sa);
static inline struct f_dynamic_attr 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 */
{ return (struct f_dynamic_attr) { .type = type, .f_type = f_type, .ea_code = code }; }   /* f_type currently unused; will be handy for static type checking */
static inline struct f_static_attr f_new_static_attr(int f_type, int code, int readonly)
{ return (struct f_static_attr) { .f_type = f_type, .sa_code = code, .readonly = readonly }; }
159
struct f_tree *f_new_tree(void);
160
struct f_inst *f_generate_complex(int operation, int operation_aux, struct f_dynamic_attr da, struct f_inst *argument);
161
struct f_inst *f_generate_roa_check(struct rtable_config *table, struct f_inst *prefix, struct f_inst *asn);
162

163 164 165

struct f_tree *build_tree(struct f_tree *);
struct f_tree *find_tree(struct f_tree *t, struct f_val val);
166
int same_tree(struct f_tree *t1, struct f_tree *t2);
167
void tree_format(struct f_tree *t, buffer *buf);
168

169
struct f_trie *f_new_trie(linpool *lp, uint node_size);
170
void *trie_add_prefix(struct f_trie *t, const net_addr *n, uint l, uint h);
171
int trie_match_net(struct f_trie *t, const net_addr *n);
172
int trie_same(struct f_trie *t1, struct f_trie *t2);
173
void trie_format(struct f_trie *t, buffer *buf);
174

175 176 177
struct ea_list;
struct rte;

178
int f_run(struct filter *filter, struct rte **rte, struct linpool *tmp_pool, int flags);
179
struct f_val f_eval_rte(struct f_inst *expr, struct rte **rte, struct linpool *tmp_pool);
180
struct f_val f_eval(struct f_inst *expr, struct linpool *tmp_pool);
181
uint f_eval_int(struct f_inst *expr);
Ondřej Zajíček's avatar
Ondřej Zajíček committed
182

183
char *filter_name(struct filter *filter);
184
int filter_same(struct filter *new, struct filter *old);
185

186 187
int i_same(struct f_inst *f1, struct f_inst *f2);

188
int val_compare(struct f_val v1, struct f_val v2);
189
int val_same(struct f_val v1, struct f_val v2);
190

191 192
void val_format(struct f_val v, buffer *buf);

193

194
#define F_NOP 0
195 196
#define F_NONL 1
#define F_ACCEPT 2	/* Need to preserve ordering: accepts < rejects! */
197 198 199
#define F_REJECT 3
#define F_ERROR 4
#define F_QUITBIRD 5
200

201 202
#define FILTER_ACCEPT NULL
#define FILTER_REJECT ((void *) 1)
203
#define FILTER_UNDEF  ((void *) 2)	/* Used in BGP */
204

205 206 207 208
/* Type numbers must be in 0..0xff range */
#define T_MASK 0xff

/* Internal types */
209 210
/* Do not use type of zero, that way we'll see errors easier. */
#define T_VOID 1
211 212 213 214

/* User visible types, which fit in int */
#define T_INT 0x10
#define T_BOOL 0x11
215
#define T_PAIR 0x12  /*	Notice that pair is stored as integer: first << 16 | second */
216
#define T_QUAD 0x13
217

218
/* Put enumerational types in 0x30..0x3f range */
219
#define T_ENUM_LO 0x30
220
#define T_ENUM_HI 0x3f
221

222
#define T_ENUM_RTS 0x30
223
#define T_ENUM_BGP_ORIGIN 0x31
224 225 226
#define T_ENUM_SCOPE 0x32
#define T_ENUM_RTC 0x33
#define T_ENUM_RTD 0x34
227
#define T_ENUM_ROA 0x35
228
#define T_ENUM_NETTYPE 0x36
229
#define T_ENUM_RA_PREFERENCE 0x37
230

231
/* new enums go here */
232
#define T_ENUM_EMPTY 0x3f	/* Special hack for atomic_aggr */
233

234
#define T_ENUM T_ENUM_LO ... T_ENUM_HI
235 236 237

/* Bigger ones */
#define T_IP 0x20
238
#define T_NET 0x21
239
#define T_STRING 0x22
240
#define T_PATH_MASK 0x23	/* mask for BGP path */
241 242
#define T_PATH 0x24		/* BGP path */
#define T_CLIST 0x25		/* Community list */
243 244 245 246
#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 */
247
#define T_RD 0x2a		/* Route distinguisher for VPN addresses */
248

249
#define T_RETURN 0x40
250
#define T_SET 0x80
251
#define T_PREFIX_SET 0x81
252

253

254 255 256 257 258 259
#define SA_FROM		 1
#define SA_GW		 2
#define SA_NET		 3
#define SA_PROTO	 4
#define SA_SOURCE	 5
#define SA_SCOPE	 6
Ondřej Zajíček's avatar
Ondřej Zajíček committed
260 261 262
#define SA_DEST    	 7
#define SA_IFNAME  	 8
#define SA_IFINDEX    	 9
263 264


265 266 267 268 269 270
struct f_tree {
  struct f_tree *left, *right;
  struct f_val from, to;
  void *data;
};

271 272 273
struct f_trie_node
{
  ip_addr addr, mask, accept;
274
  uint plen;
275 276 277 278 279
  struct f_trie_node *c[2];
};

struct f_trie
{
280
  linpool *lp;
281
  int zero;
282 283
  uint node_size;
  struct f_trie_node root[0];		/* Root trie node follows */
284 285
};

286 287
#define NEW_F_VAL struct f_val * val; val = cfg_alloc(sizeof(struct f_val));

288
#define FF_SILENT 2			/* Silent filter execution */
289

Maria Matejka's avatar
Maria Matejka committed
290 291 292 293 294 295 296 297 298
/* Custom route attributes */
struct custom_attribute {
  resource r;
  struct f_dynamic_attr *fda;
  const char *name;
};

struct custom_attribute *ca_lookup(pool *p, const char *name, int ea_type);

299 300 301 302 303 304 305 306 307 308 309
/* 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 */
};

/* Hook for call bt_assert() function in configuration */
extern void (*bt_assert_hook)(int result, struct f_inst *assert);

310
#endif