Statistics
| Branch: | Revision:

iof-bird-daemon / nest / route.h @ ce4aca09

History | View | Annotate | Download (13 KB)

1
/*
2
 *        BIRD Internet Routing Daemon -- Routing Table
3
 *
4
 *        (c) 1998--2000 Martin Mares <mj@ucw.cz>
5
 *
6
 *        Can be freely distributed and used under the terms of the GNU GPL.
7
 */
8

    
9
#ifndef _BIRD_ROUTE_H_
10
#define _BIRD_ROUTE_H_
11

    
12
#include "lib/lists.h"
13
#include "lib/resource.h"
14
#include "lib/timer.h"
15

    
16
struct protocol;
17
struct proto;
18
struct symbol;
19
struct filter;
20
struct cli;
21

    
22
/*
23
 *        Generic data structure for storing network prefixes. Also used
24
 *        for the master routing table. Currently implemented as a hash
25
 *        table.
26
 *
27
 *        Available operations:
28
 *                - insertion of new entry
29
 *                - deletion of entry
30
 *                - searching for entry by network prefix
31
 *                - asynchronous retrieval of fib contents
32
 */
33

    
34
struct fib_node {
35
  struct fib_node *next;                /* Next in hash chain */
36
  struct fib_iterator *readers;                /* List of readers of this node */
37
  byte pxlen;
38
  byte flags;                                /* User-defined */
39
  byte x0, x1;                                /* User-defined */
40
  ip_addr prefix;                        /* In host order */
41
};
42

    
43
struct fib_iterator {                        /* See lib/slists.h for an explanation */
44
  struct fib_iterator *prev, *next;        /* Must be synced with struct fib_node! */
45
  byte efef;                                /* 0xff to distinguish between iterator and node */
46
  byte pad[3];
47
  struct fib_node *node;                /* Or NULL if freshly merged */
48
  unsigned int hash;
49
};
50

    
51
typedef void (*fib_init_func)(struct fib_node *);
52

    
53
struct fib {
54
  pool *fib_pool;                        /* Pool holding all our data */
55
  slab *fib_slab;                        /* Slab holding all fib nodes */
56
  struct fib_node **hash_table;                /* Node hash table */
57
  unsigned int hash_size;                /* Number of hash table entries (a power of two) */
58
  unsigned int hash_order;                /* Binary logarithm of hash_size */
59
  unsigned int hash_shift;                /* 16 - hash_log */
60
  unsigned int entries;                        /* Number of entries */
61
  unsigned int entries_min, entries_max;/* Entry count limits (else start rehashing) */
62
  fib_init_func init;                        /* Constructor */
63
};
64

    
65
void fib_init(struct fib *, pool *, unsigned node_size, unsigned hash_order, fib_init_func init);
66
void *fib_find(struct fib *, ip_addr *, int);        /* Find or return NULL if doesn't exist */
67
void *fib_get(struct fib *, ip_addr *, int);         /* Find or create new if nonexistent */
68
void *fib_route(struct fib *, ip_addr, int);        /* Longest-match routing lookup */
69
void fib_delete(struct fib *, void *);        /* Remove fib entry */
70
void fib_free(struct fib *);                /* Destroy the fib */
71
void fib_check(struct fib *);                /* Consistency check for debugging */
72

    
73
void fit_init(struct fib_iterator *, struct fib *); /* Internal functions, don't call */
74
struct fib_node *fit_get(struct fib *, struct fib_iterator *);
75
void fit_put(struct fib_iterator *, struct fib_node *);
76

    
77
#define FIB_WALK(fib, z) do {                                        \
78
        struct fib_node *z, **ff = (fib)->hash_table;                \
79
        unsigned int count = (fib)->hash_size;                        \
80
        while (count--)                                                \
81
          for(z = *ff++; z; z=z->next)
82

    
83
#define FIB_WALK_END } while (0)
84

    
85
#define FIB_ITERATE_INIT(it, fib) fit_init(it, fib)
86

    
87
#define FIB_ITERATE_START(fib, it, z) do {                        \
88
        struct fib_node *z = fit_get(fib, it);                        \
89
        unsigned int count = (fib)->hash_size;                        \
90
        unsigned int hpos = (it)->hash;                                \
91
        for(;;) {                                                \
92
          if (!z)                                                \
93
            {                                                        \
94
               if (++hpos >= count)                                \
95
                 break;                                                \
96
               z = (fib)->hash_table[hpos];                        \
97
               continue;                                        \
98
            }
99

    
100
#define FIB_ITERATE_END(z) z = z->next; } } while(0)
101

    
102
#define FIB_ITERATE_PUT(it, z) fit_put(it, z)
103

    
104
/*
105
 *        Master Routing Tables. Generally speaking, each of them contains a FIB
106
 *        with each entry pointing to a list of route entries representing routes
107
 *        to given network (with the selected one at the head).
108
 *
109
 *        Each of the RTE's contains variable data (the preference and protocol-dependent
110
 *        metrics) and a pointer to a route attribute block common for many routes).
111
 *
112
 *        It's guaranteed that there is at most one RTE for every (prefix,proto) pair.
113
 */
114

    
115
struct rtable_config {
116
  node n;
117
  char *name;
118
  struct rtable *table;
119
  struct proto_config *krt_attached;        /* Kernel syncer attached to this table */
120
  int gc_max_ops;                        /* Maximum number of operations before GC is run */
121
  int gc_min_time;                        /* Minimum time between two consecutive GC runs */
122
};
123

    
124
typedef struct rtable {
125
  node n;                                /* Node in list of all tables */
126
  struct fib fib;
127
  char *name;                                /* Name of this table */
128
  list hooks;                                /* List of announcement hooks */
129
  int pipe_busy;                        /* Pipe loop detection */
130
  int use_count;                        /* Number of protocols using this table */
131
  struct rtable_config *config;                /* Configuration of this table */
132
  struct config *deleted;                /* Table doesn't exist in current configuration,
133
                                         * delete as soon as use_count becomes 0 and remove
134
                                         * obstacle from this routing table.
135
                                         */
136
  struct event *gc_event;                /* Garbage collector event */
137
  int gc_counter;                        /* Number of operations since last GC */
138
  bird_clock_t gc_time;                        /* Time of last GC */
139
} rtable;
140

    
141
typedef struct network {
142
  struct fib_node n;                        /* FIB flags reserved for kernel syncer */
143
  struct rte *routes;                        /* Available routes for this network */
144
} net;
145

    
146
typedef struct rte {
147
  struct rte *next;
148
  net *net;                                /* Network this RTE belongs to */
149
  struct rta *attrs;                        /* Attributes of this route */
150
  byte flags;                                /* Flags (REF_...) */
151
  byte pflags;                                /* Protocol-specific flags */
152
  word pref;                                /* Route preference */
153
  bird_clock_t lastmod;                        /* Last modified */
154
  union {                                /* Protocol-dependent data (metrics etc.) */
155
#ifdef CONFIG_RIP
156
    struct {
157
      node garbage;                        /* List for garbage collection */
158
      byte metric;                        /* RIP metric */
159
      u16 tag;                                /* External route tag */
160
      bird_clock_t lastmodX;                /* Strange kind of last modification time */
161
      struct rip_entry *entry;
162
    } rip;
163
#endif
164
#ifdef CONFIG_OSPF
165
    struct {
166
      u32 metric1, metric2;                /* OSPF Type 1 and Type 2 metrics */
167
      u32 tag;                                /* External route tag */
168
    } ospf;
169
#endif
170
    struct {                                /* Routes generated by krt sync (both temporary and inherited ones) */
171
      s8 src;                                /* Alleged route source (see krt.h) */
172
      u8 proto;                                /* Kernel source protocol ID */
173
      u8 type;                                /* Kernel route type */
174
      u8 seen;                                /* Seen during last scan */
175
      u32 metric;                        /* Kernel metric */
176
    } krt;
177
  } u;
178
} rte;
179

    
180
#define REF_COW 1                        /* Copy this rte on write */
181

    
182
struct config;
183

    
184
void rt_init(void);
185
void rt_preconfig(struct config *);
186
void rt_commit(struct config *new, struct config *old);
187
void rt_lock_table(rtable *);
188
void rt_unlock_table(rtable *);
189
void rt_setup(pool *, rtable *, char *, struct rtable_config *);
190
static inline net *net_find(rtable *tab, ip_addr addr, unsigned len) { return (net *) fib_find(&tab->fib, &addr, len); }
191
static inline net *net_get(rtable *tab, ip_addr addr, unsigned len) { return (net *) fib_get(&tab->fib, &addr, len); }
192
rte *rte_find(net *net, struct proto *p);
193
rte *rte_get_temp(struct rta *);
194
void rte_update(rtable *tab, net *net, struct proto *p, rte *new);
195
void rte_discard(rtable *tab, rte *old);
196
void rte_dump(rte *);
197
void rte_free(rte *);
198
rte *rte_do_cow(rte *);
199
static inline rte * rte_cow(rte *r) { return (r->flags & REF_COW) ? rte_do_cow(r) : r; }
200
void rt_dump(rtable *);
201
void rt_dump_all(void);
202
int rt_feed_baby(struct proto *p);
203
void rt_feed_baby_abort(struct proto *p);
204
void rt_prune(rtable *tab);
205
void rt_prune_all(void);
206
struct rtable_config *rt_new_table(struct symbol *s);
207

    
208
struct rt_show_data {
209
  ip_addr prefix;
210
  unsigned pxlen;
211
  rtable *table;
212
  struct filter *filter;
213
  int verbose;
214
  struct fib_iterator fit;
215
  struct proto *import_protocol;
216
  int import_mode, primary_only;
217
  struct config *running_on_config;
218
  int net_counter, rt_counter, show_counter;
219
  int stats, show_for;
220
};
221
void rt_show(struct rt_show_data *);
222

    
223
/*
224
 *        Route Attributes
225
 *
226
 *        Beware: All standard BGP attributes must be represented here instead
227
 *        of making them local to the route. This is needed to ensure proper
228
 *        construction of BGP route attribute lists.
229
 */
230

    
231
typedef struct rta {
232
  struct rta *next, **pprev;                /* Hash chain */
233
  struct proto *proto;                        /* Protocol instance */
234
  unsigned uc;                                /* Use count */
235
  byte source;                                /* Route source (RTS_...) */
236
  byte scope;                                /* Route scope (SCOPE_... -- see ip.h) */
237
  byte cast;                                /* Casting type (RTC_...) */
238
  byte dest;                                /* Route destination type (RTD_...) */
239
  byte flags;                                /* Route flags (RTF_...), now unused */
240
  byte aflags;                                /* Attribute cache flags (RTAF_...) */
241
  u16 hash_key;                                /* Hash over important fields */
242
  ip_addr gw;                                /* Next hop */
243
  ip_addr from;                                /* Advertising router */
244
  struct iface *iface;                        /* Outgoing interface */
245
  struct ea_list *eattrs;                /* Extended Attribute chain */
246
} rta;
247

    
248
#define RTS_DUMMY 0                        /* Dummy route to be removed soon */
249
#define RTS_STATIC 1                        /* Normal static route */
250
#define RTS_INHERIT 2                        /* Route inherited from kernel */
251
#define RTS_DEVICE 3                        /* Device route */
252
#define RTS_STATIC_DEVICE 4                /* Static device route */
253
#define RTS_REDIRECT 5                        /* Learned via redirect */
254
#define RTS_RIP 6                        /* RIP route */
255
#define RTS_OSPF 7                        /* OSPF route */
256
#define RTS_OSPF_EXT 8                        /* OSPF external route */
257
#define RTS_OSPF_IA 9                        /* OSPF inter-area route */
258
#define RTS_OSPF_BOUNDARY 10                /* OSPF route to boundary router */
259
#define RTS_BGP 11                        /* BGP route */
260
#define RTS_PIPE 12                        /* Inter-table wormhole */
261

    
262
#define RTC_UNICAST 0
263
#define RTC_BROADCAST 1
264
#define RTC_MULTICAST 2
265
#define RTC_ANYCAST 3                        /* IPv6 Anycast */
266

    
267
#define RTD_ROUTER 0                        /* Next hop is neighbor router */
268
#define RTD_DEVICE 1                        /* Points to device */
269
#define RTD_BLACKHOLE 2                        /* Silently drop packets */
270
#define RTD_UNREACHABLE 3                /* Reject as unreachable */
271
#define RTD_PROHIBIT 4                        /* Administratively prohibited */
272

    
273
#define RTAF_CACHED 1                        /* This is a cached rta */
274

    
275
/*
276
 *        Extended Route Attributes
277
 */
278

    
279
typedef struct eattr {
280
  word id;                                /* EA_CODE(EAP_..., protocol-dependent ID) */
281
  byte flags;                                /* Protocol-dependent flags */
282
  byte type;                                /* Attribute type and several flags (EAF_...) */
283
  union {
284
    u32 data;
285
    struct adata *ptr;                        /* Attribute data elsewhere */
286
  } u;
287
} eattr;
288

    
289
#define EAP_GENERIC 0                        /* Generic attributes */
290
#define EAP_BGP 1                        /* BGP attributes */
291
#define EAP_RIP 2                        /* RIP */
292
#define EAP_OSPF 3                        /* OSPF */
293
#define EAP_MAX 4
294

    
295
#define EA_CODE(proto,id) (((proto) << 8) | (id))
296
#define EA_PROTO(ea) ((ea) >> 8)
297
#define EA_ID(ea) ((ea) & 0xff)
298

    
299
#define EA_CODE_MASK 0xffff
300
#define EA_ALLOW_UNDEF 0x10000                /* ea_find: allow EAF_TYPE_UNDEF */
301

    
302
#define EAF_TYPE_MASK 0x0f                /* Mask with this to get type */
303
#define EAF_TYPE_INT 0x01                /* 32-bit signed integer number */
304
#define EAF_TYPE_OPAQUE 0x02                /* Opaque byte string (not filterable) */
305
#define EAF_TYPE_IP_ADDRESS 0x04        /* IP address */
306
#define EAF_TYPE_ROUTER_ID 0x05                /* Router ID (IPv4 address) */
307
#define EAF_TYPE_AS_PATH 0x06                /* BGP AS path (encoding per RFC 1771:4.3) */
308
#define EAF_TYPE_INT_SET 0x0a                /* Set of u32's (e.g., a community list) */
309
#define EAF_TYPE_UNDEF 0x0f                /* `force undefined' entry */
310
#define EAF_EMBEDDED 0x01                /* Data stored in eattr.u.data (part of type spec) */
311
#define EAF_VAR_LENGTH 0x02                /* Attribute length is variable (part of type spec) */
312
#define EAF_ORIGINATED 0x40                /* The attribute has originated locally */
313
#define EAF_TEMP 0x80                        /* A temporary attribute (the one stored in the tmp attr list) */
314

    
315
struct adata {
316
  unsigned int length;                        /* Length of data */
317
  byte data[0];
318
};
319

    
320
typedef struct ea_list {
321
  struct ea_list *next;                        /* In case we have an override list */
322
  byte flags;                                /* Flags: EALF_... */
323
  byte rfu;
324
  word count;                                /* Number of attributes */
325
  eattr attrs[0];                        /* Attribute definitions themselves */
326
} ea_list;
327

    
328
#define EALF_SORTED 1                        /* Attributes are sorted by code */
329
#define EALF_BISECT 2                        /* Use interval bisection for searching */
330
#define EALF_CACHED 4                        /* Attributes belonging to cached rta */
331

    
332
eattr *ea_find(ea_list *, unsigned ea);
333
int ea_get_int(ea_list *, unsigned ea, int def);
334
void ea_dump(ea_list *);
335
void ea_sort(ea_list *);                /* Sort entries in all sub-lists */
336
unsigned ea_scan(ea_list *);                /* How many bytes do we need for merged ea_list */
337
void ea_merge(ea_list *from, ea_list *to); /* Merge sub-lists to allocated buffer */
338
int ea_same(ea_list *x, ea_list *y);        /* Test whether two ea_lists are identical */
339
unsigned int ea_hash(ea_list *e);        /* Calculate 16-bit hash value */
340
void ea_format(eattr *e, byte *buf);
341
#define EA_FORMAT_BUF_SIZE 256
342
ea_list *ea_append(ea_list *to, ea_list *what);
343

    
344
void rta_init(void);
345
rta *rta_lookup(rta *);                        /* Get rta equivalent to this one, uc++ */
346
static inline rta *rta_clone(rta *r) { r->uc++; return r; }
347
void rta__free(rta *r);
348
static inline void rta_free(rta *r) { if (r && !--r->uc) rta__free(r); }
349
void rta_dump(rta *);
350
void rta_dump_all(void);
351
static inline eattr * rta_find(rta *a, unsigned ea) { return ea_find(a->eattrs, ea); }
352
void rta_show(struct cli *, rta *, ea_list *);
353

    
354
extern struct protocol *attr_class_to_protocol[EAP_MAX];
355

    
356
/*
357
 *        Default protocol preferences
358
 */
359

    
360
#define DEF_PREF_DIRECT                    240        /* Directly connected */
361
#define DEF_PREF_STATIC                200        /* Static route */
362
#define DEF_PREF_OSPF                150        /* OSPF intra-area, inter-area and type 1 external routes */
363
#define DEF_PREF_RIP                120        /* RIP */
364
#define DEF_PREF_BGP                100        /* BGP */
365
#define DEF_PREF_PIPE                70        /* Routes piped from other tables */
366
#define DEF_PREF_INHERITED        10        /* Routes inherited from other routing daemons */
367

    
368
#endif