Statistics
| Branch: | Revision:

iof-bird-daemon / nest / route.h @ 04632fd7

History | View | Annotate | Download (23.7 KB)

1 58ef912c Martin Mares
/*
2
 *        BIRD Internet Routing Daemon -- Routing Table
3
 *
4 50fe90ed Martin Mares
 *        (c) 1998--2000 Martin Mares <mj@ucw.cz>
5 58ef912c Martin Mares
 *
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 0e02abfd Martin Mares
#include "lib/lists.h"
13 1feea03e Martin Mares
#include "lib/resource.h"
14 a2ccbb0b Martin Mares
#include "lib/timer.h"
15 c0adf7e9 Ondrej Zajicek
#include "nest/protocol.h"
16 58ef912c Martin Mares
17 2326b001 Martin Mares
struct protocol;
18 4cc78c50 Martin Mares
struct proto;
19 730f2e2c Martin Mares
struct symbol;
20
struct filter;
21
struct cli;
22 2326b001 Martin Mares
23 58ef912c Martin Mares
/*
24
 *        Generic data structure for storing network prefixes. Also used
25 3ab001b9 Martin Mares
 *        for the master routing table. Currently implemented as a hash
26 62aa008a Martin Mares
 *        table.
27 58ef912c Martin Mares
 *
28
 *        Available operations:
29
 *                - insertion of new entry
30
 *                - deletion of entry
31 62aa008a Martin Mares
 *                - searching for entry by network prefix
32 3ab001b9 Martin Mares
 *                - asynchronous retrieval of fib contents
33 58ef912c Martin Mares
 */
34
35
struct fib_node {
36 3ab001b9 Martin Mares
  struct fib_node *next;                /* Next in hash chain */
37
  struct fib_iterator *readers;                /* List of readers of this node */
38 fe9f1a6d Ondrej Zajicek (work)
  byte flags;                                /* User-defined, will be removed */
39
  u32 uid;                                /* Unique ID based on hash, will be removed */
40
  net_addr addr[0];
41 3ab001b9 Martin Mares
};
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 0ba8a614 Martin Mares
  struct fib_node *node;                /* Or NULL if freshly merged */
48 ae80a2de Pavel Tvrdík
  uint hash;
49 58ef912c Martin Mares
};
50
51 fe9f1a6d Ondrej Zajicek (work)
typedef void (*fib_init_fn)(void *);
52 ce4aca09 Martin Mares
53 58ef912c Martin Mares
struct fib {
54 62aa008a Martin Mares
  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 ae80a2de Pavel Tvrdík
  uint hash_size;                        /* Number of hash table entries (a power of two) */
58
  uint hash_order;                        /* Binary logarithm of hash_size */
59 04632fd7 Ondrej Zajicek (work)
  uint hash_shift;                        /* 32 - hash_order */
60 fe9f1a6d Ondrej Zajicek (work)
  uint addr_type;                        /* Type of address data stored in fib (NET_*) */
61
  uint node_size;        /* XXXX */
62
  uint node_offset;        /* XXXX */
63 ae80a2de Pavel Tvrdík
  uint entries;                                /* Number of entries */
64
  uint entries_min, entries_max;        /* Entry count limits (else start rehashing) */
65 fe9f1a6d Ondrej Zajicek (work)
  fib_init_fn init;                        /* Constructor */
66 58ef912c Martin Mares
};
67
68 600998fc Ondrej Zajicek (work)
static inline void * fib_node_to_user(struct fib *f, struct fib_node *e)
69
{ return e ? (void *) ((char *) e - f->node_offset) : NULL; }
70
71
static inline struct fib_node * fib_user_to_node(struct fib *f, void *e)
72
{ return e ? (void *) ((char *) e + f->node_offset) : NULL; }
73
74 fe9f1a6d Ondrej Zajicek (work)
void fib_init(struct fib *f, pool *p, uint addr_type, uint node_size, uint node_offset, uint hash_order, fib_init_fn init);
75 0f7d5b1a Ondrej Zajicek (work)
void *fib_find(struct fib *, const net_addr *);        /* Find or return NULL if doesn't exist */
76
void *fib_get(struct fib *, const net_addr *);         /* Find or create new if nonexistent */
77
void *fib_route(struct fib *, const net_addr *); /* Longest-match routing lookup */
78 62aa008a Martin Mares
void fib_delete(struct fib *, void *);        /* Remove fib entry */
79 a8b60382 Martin Mares
void fib_free(struct fib *);                /* Destroy the fib */
80 3ab001b9 Martin Mares
void fib_check(struct fib *);                /* Consistency check for debugging */
81
82
void fit_init(struct fib_iterator *, struct fib *); /* Internal functions, don't call */
83
struct fib_node *fit_get(struct fib *, struct fib_iterator *);
84
void fit_put(struct fib_iterator *, struct fib_node *);
85 8465dccb Ondrej Zajicek (work)
void fit_put_next(struct fib *f, struct fib_iterator *i, struct fib_node *n, uint hpos);
86
87 600998fc Ondrej Zajicek (work)
88
#define FIB_WALK(fib, type, z) do {                                \
89
        struct fib_node *fn_, **ff_ = (fib)->hash_table;        \
90
        uint count_ = (fib)->hash_size;                                \
91
        type *z;                                                \
92
        while (count_--)                                        \
93
          for (fn_ = *ff_++; z = fib_node_to_user(fib, fn_); fn_=fn_->next)
94 236d4eb8 Martin Mares
95
#define FIB_WALK_END } while (0)
96 a8b60382 Martin Mares
97 3ab001b9 Martin Mares
#define FIB_ITERATE_INIT(it, fib) fit_init(it, fib)
98
99 600998fc Ondrej Zajicek (work)
#define FIB_ITERATE_START(fib, it, type, z) do {                \
100
        struct fib_node *fn_ = fit_get(fib, it);                \
101
        uint count_ = (fib)->hash_size;                                \
102
        uint hpos_ = (it)->hash;                                \
103
        type *z;                                                \
104 3ab001b9 Martin Mares
        for(;;) {                                                \
105 600998fc Ondrej Zajicek (work)
          if (!fn_)                                                \
106 8abbde02 Martin Mares
            {                                                        \
107 600998fc Ondrej Zajicek (work)
               if (++hpos_ >= count_)                                \
108 8abbde02 Martin Mares
                 break;                                                \
109 600998fc Ondrej Zajicek (work)
               fn_ = (fib)->hash_table[hpos_];                        \
110 8abbde02 Martin Mares
               continue;                                        \
111 600998fc Ondrej Zajicek (work)
            }                                                        \
112
          z = fib_node_to_user(fib, fn_);
113 3ab001b9 Martin Mares
114 600998fc Ondrej Zajicek (work)
#define FIB_ITERATE_END fn_ = fn_->next; } } while(0)
115 3ab001b9 Martin Mares
116 600998fc Ondrej Zajicek (work)
#define FIB_ITERATE_PUT(it) fit_put(it, fn_)
117 3ab001b9 Martin Mares
118 600998fc Ondrej Zajicek (work)
#define FIB_ITERATE_PUT_NEXT(it, fib) fit_put_next(fib, it, fn_, hpos_)
119 8465dccb Ondrej Zajicek (work)
120
#define FIB_ITERATE_UNLINK(it, fib) fit_get(fib, it)
121
122
123 a8b60382 Martin Mares
/*
124 08e2d625 Martin Mares
 *        Master Routing Tables. Generally speaking, each of them contains a FIB
125
 *        with each entry pointing to a list of route entries representing routes
126
 *        to given network (with the selected one at the head).
127
 *
128 58ef912c Martin Mares
 *        Each of the RTE's contains variable data (the preference and protocol-dependent
129 62aa008a Martin Mares
 *        metrics) and a pointer to a route attribute block common for many routes).
130 08e2d625 Martin Mares
 *
131
 *        It's guaranteed that there is at most one RTE for every (prefix,proto) pair.
132 58ef912c Martin Mares
 */
133
134 0e02abfd Martin Mares
struct rtable_config {
135
  node n;
136
  char *name;
137
  struct rtable *table;
138 7de45ba4 Martin Mares
  struct proto_config *krt_attached;        /* Kernel syncer attached to this table */
139 fe9f1a6d Ondrej Zajicek (work)
  uint addr_type;                        /* Type of address data stored in table (NET_*) */
140 b9626ec6 Martin Mares
  int gc_max_ops;                        /* Maximum number of operations before GC is run */
141
  int gc_min_time;                        /* Minimum time between two consecutive GC runs */
142 26822d8f Ondrej Zajicek
  byte sorted;                                /* Routes of network are sorted according to rte_better() */
143 0e02abfd Martin Mares
};
144
145 62aa008a Martin Mares
typedef struct rtable {
146 0e02abfd Martin Mares
  node n;                                /* Node in list of all tables */
147 62aa008a Martin Mares
  struct fib fib;
148
  char *name;                                /* Name of this table */
149 0e02abfd Martin Mares
  list hooks;                                /* List of announcement hooks */
150 fe9f1a6d Ondrej Zajicek (work)
  uint addr_type;                        /* Type of address data stored in table (NET_*) */
151 9c11ec9e Martin Mares
  int pipe_busy;                        /* Pipe loop detection */
152 50fe90ed Martin Mares
  int use_count;                        /* Number of protocols using this table */
153 cfe34a31 Ondrej Zajicek
  struct hostcache *hostcache;
154 b9626ec6 Martin Mares
  struct rtable_config *config;                /* Configuration of this table */
155 50fe90ed Martin Mares
  struct config *deleted;                /* Table doesn't exist in current configuration,
156
                                         * delete as soon as use_count becomes 0 and remove
157
                                         * obstacle from this routing table.
158
                                         */
159 cfe34a31 Ondrej Zajicek
  struct event *rt_event;                /* Routing table event */
160 b9626ec6 Martin Mares
  int gc_counter;                        /* Number of operations since last GC */
161
  bird_clock_t gc_time;                        /* Time of last GC */
162 cfe34a31 Ondrej Zajicek
  byte gc_scheduled;                        /* GC is scheduled */
163 9135c1f0 Ondrej Zajicek
  byte prune_state;                        /* Table prune state, 1 -> scheduled, 2-> running */
164 cfe34a31 Ondrej Zajicek
  byte hcu_scheduled;                        /* Hostcache update is scheduled */
165
  byte nhu_state;                        /* Next Hop Update state */
166 fb829de6 Ondrej Zajicek
  struct fib_iterator prune_fit;        /* Rtable prune FIB iterator */
167 cfe34a31 Ondrej Zajicek
  struct fib_iterator nhu_fit;                /* Next Hop Update FIB iterator */
168 62aa008a Martin Mares
} rtable;
169
170 0c791f87 Ondrej Zajicek
#define RPS_NONE        0
171
#define RPS_SCHEDULED        1
172
#define RPS_RUNNING        2
173
174 58ef912c Martin Mares
typedef struct network {
175
  struct rte *routes;                        /* Available routes for this network */
176 fe9f1a6d Ondrej Zajicek (work)
  struct fib_node n;                        /* FIB flags reserved for kernel syncer */
177 58ef912c Martin Mares
} net;
178
179 cfe34a31 Ondrej Zajicek
struct hostcache {
180 f2b76f2c Ondrej Zajicek
  slab *slab;                                /* Slab holding all hostentries */
181
  struct hostentry **hash_table;        /* Hash table for hostentries */
182
  unsigned hash_order, hash_shift;
183
  unsigned hash_max, hash_min;
184
  unsigned hash_items;
185 c477f489 Ondrej Zajicek
  linpool *lp;                                /* Linpool for trie */
186
  struct f_trie *trie;                        /* Trie of prefixes that might affect hostentries */
187
  list hostentries;                        /* List of all hostentries */
188 cfe34a31 Ondrej Zajicek
  byte update_hostcache;
189
};
190
191
struct hostentry {
192
  node ln;
193 1b180121 Ondrej Zajicek
  ip_addr addr;                                /* IP address of host, part of key */
194
  ip_addr link;                                /* (link-local) IP address of host, used as gw
195
                                           if host is directly attached */
196 acb04cfd Ondrej Zajicek (work)
  struct rtable *tab;                        /* Dependent table, part of key */
197 f2b76f2c Ondrej Zajicek
  struct hostentry *next;                /* Next in hash chain */
198
  unsigned hash_key;                        /* Hash key */
199 cfe34a31 Ondrej Zajicek
  unsigned uc;                                /* Use count */
200 7e95c05d Ondrej Zajicek
  struct rta *src;                        /* Source rta entry */
201 cfe34a31 Ondrej Zajicek
  ip_addr gw;                                /* Chosen next hop */
202
  byte dest;                                /* Chosen route destination type (RTD_...) */
203 d1e146f2 Ondrej Zajicek
  u32 igp_metric;                        /* Chosen route IGP metric */
204 cfe34a31 Ondrej Zajicek
};
205
206 58ef912c Martin Mares
typedef struct rte {
207
  struct rte *next;
208 a0762910 Martin Mares
  net *net;                                /* Network this RTE belongs to */
209 c0adf7e9 Ondrej Zajicek
  struct announce_hook *sender;                /* Announce hook used to send the route to the routing table */
210 1b769b08 Martin Mares
  struct rta *attrs;                        /* Attributes of this route */
211 58ef912c Martin Mares
  byte flags;                                /* Flags (REF_...) */
212 481f6985 Martin Mares
  byte pflags;                                /* Protocol-specific flags */
213 58ef912c Martin Mares
  word pref;                                /* Route preference */
214 a2ccbb0b Martin Mares
  bird_clock_t lastmod;                        /* Last modified */
215 58ef912c Martin Mares
  union {                                /* Protocol-dependent data (metrics etc.) */
216
#ifdef CONFIG_RIP
217
    struct {
218 8465dccb Ondrej Zajicek (work)
      struct iface *from;                /* Incoming iface */
219
      u8 metric;                        /* RIP metric */
220 481f6985 Martin Mares
      u16 tag;                                /* External route tag */
221 58ef912c Martin Mares
    } rip;
222
#endif
223
#ifdef CONFIG_OSPF
224
    struct {
225
      u32 metric1, metric2;                /* OSPF Type 1 and Type 2 metrics */
226 481f6985 Martin Mares
      u32 tag;                                /* External route tag */
227 c27b2449 Ondrej Zajicek
      u32 router_id;                        /* Router that originated this route */
228 58ef912c Martin Mares
    } ospf;
229
#endif
230 be4cd99a Ondrej Zajicek
#ifdef CONFIG_BGP
231
    struct {
232
      u8 suppressed;                        /* Used for deterministic MED comparison */
233
    } bgp;
234
#endif
235 c10421d3 Martin Mares
    struct {                                /* Routes generated by krt sync (both temporary and inherited ones) */
236
      s8 src;                                /* Alleged route source (see krt.h) */
237
      u8 proto;                                /* Kernel source protocol ID */
238
      u8 type;                                /* Kernel route type */
239
      u8 seen;                                /* Seen during last scan */
240
      u32 metric;                        /* Kernel metric */
241
    } krt;
242 58ef912c Martin Mares
  } u;
243
} rte;
244
245 00a09f3c Ondrej Zajicek
#define REF_COW                1                /* Copy this rte on write */
246 15550957 Ondrej Zajicek
#define REF_FILTERED        2                /* Route is rejected by import filter */
247 0c791f87 Ondrej Zajicek
#define REF_STALE        4                /* Route is stale in a refresh cycle */
248
#define REF_DISCARD        8                /* Route is scheduled for discard */
249 cf98be7b Ondrej Zajicek
250
/* Route is valid for propagation (may depend on other flags in the future), accepts NULL */
251 15550957 Ondrej Zajicek
static inline int rte_is_valid(rte *r) { return r && !(r->flags & REF_FILTERED); }
252 cf98be7b Ondrej Zajicek
253 15550957 Ondrej Zajicek
/* Route just has REF_FILTERED flag */
254
static inline int rte_is_filtered(rte *r) { return !!(r->flags & REF_FILTERED); }
255 cf98be7b Ondrej Zajicek
256 e2dc2f30 Martin Mares
257 23ac9e9a Ondrej Zajicek
/* Types of route announcement, also used as flags */
258 00a09f3c Ondrej Zajicek
#define RA_OPTIMAL        1                /* Announcement of optimal route change */
259
#define RA_ACCEPTED        2                /* Announcement of first accepted route */
260
#define RA_ANY                3                /* Announcement of any route change */
261 8d9eef17 Ondrej Zajicek
#define RA_MERGED        4                /* Announcement of optimal route merged with next ones */
262 23ac9e9a Ondrej Zajicek
263 36da2857 Ondrej Zajicek
/* Return value of import_control() callback */
264
#define RIC_ACCEPT        1                /* Accepted by protocol */
265
#define RIC_PROCESS        0                /* Process it through import filter */
266
#define RIC_REJECT        -1                /* Rejected by protocol */
267
#define RIC_DROP        -2                /* Silently dropped by protocol */
268
269 0e02abfd Martin Mares
struct config;
270 2326b001 Martin Mares
271
void rt_init(void);
272 0e02abfd Martin Mares
void rt_preconfig(struct config *);
273 50fe90ed Martin Mares
void rt_commit(struct config *new, struct config *old);
274
void rt_lock_table(rtable *);
275
void rt_unlock_table(rtable *);
276 b9626ec6 Martin Mares
void rt_setup(pool *, rtable *, char *, struct rtable_config *);
277 fe9f1a6d Ondrej Zajicek (work)
static inline net *net_find(rtable *tab, net_addr *addr) { return (net *) fib_find(&tab->fib, addr); }
278
static inline net *net_get(rtable *tab, net_addr *addr) { return (net *) fib_get(&tab->fib, addr); }
279
280 094d2bdb Ondrej Zajicek
rte *rte_find(net *net, struct rte_src *src);
281 1b769b08 Martin Mares
rte *rte_get_temp(struct rta *);
282 094d2bdb Ondrej Zajicek
void rte_update2(struct announce_hook *ah, net *net, rte *new, struct rte_src *src);
283
static inline void rte_update(struct proto *p, net *net, rte *new) { rte_update2(p->main_ahook, net, new, p->main_source); }
284 0e02abfd Martin Mares
void rte_discard(rtable *tab, rte *old);
285 fe9f1a6d Ondrej Zajicek (work)
int rt_examine(rtable *t, net_addr *a, struct proto *p, struct filter *filter);
286 8d9eef17 Ondrej Zajicek
rte *rt_export_merged(struct announce_hook *ah, net *net, rte **rt_free, struct ea_list **tmpa, int silent);
287 0c791f87 Ondrej Zajicek
void rt_refresh_begin(rtable *t, struct announce_hook *ah);
288
void rt_refresh_end(rtable *t, struct announce_hook *ah);
289 a0762910 Martin Mares
void rte_dump(rte *);
290 04925e90 Martin Mares
void rte_free(rte *);
291 e2dc2f30 Martin Mares
rte *rte_do_cow(rte *);
292
static inline rte * rte_cow(rte *r) { return (r->flags & REF_COW) ? rte_do_cow(r) : r; }
293 8d9eef17 Ondrej Zajicek
rte *rte_cow_rta(rte *r, linpool *lp);
294 2326b001 Martin Mares
void rt_dump(rtable *);
295 a2ccbb0b Martin Mares
void rt_dump_all(void);
296 ac5d8012 Martin Mares
int rt_feed_baby(struct proto *p);
297
void rt_feed_baby_abort(struct proto *p);
298 fb829de6 Ondrej Zajicek
int rt_prune_loop(void);
299 fe9f1a6d Ondrej Zajicek (work)
struct rtable_config *rt_new_table(struct symbol *s, uint addr_type);
300 2326b001 Martin Mares
301 0c791f87 Ondrej Zajicek
static inline void
302
rt_mark_for_prune(rtable *tab)
303
{
304
  if (tab->prune_state == RPS_RUNNING)
305
    fit_get(&tab->fib, &tab->prune_fit);
306
307
  tab->prune_state = RPS_SCHEDULED;
308
}
309
310 730f2e2c Martin Mares
struct rt_show_data {
311 04632fd7 Ondrej Zajicek (work)
  net_addr *addr;
312 730f2e2c Martin Mares
  rtable *table;
313
  struct filter *filter;
314
  int verbose;
315
  struct fib_iterator fit;
316 4d176e14 Ondrej Filip
  struct proto *show_protocol;
317 ea2ae6dd Ondrej Zajicek
  struct proto *export_protocol;
318 15550957 Ondrej Zajicek
  int export_mode, primary_only, filtered;
319 ce1da96e Martin Mares
  struct config *running_on_config;
320 23693958 Martin Mares
  int net_counter, rt_counter, show_counter;
321 56d6c530 Martin Mares
  int stats, show_for;
322 730f2e2c Martin Mares
};
323
void rt_show(struct rt_show_data *);
324
325 7aa80901 Ondrej Zajicek
/* Value of export_mode in struct rt_show_data */
326
#define RSEM_NONE        0                /* Export mode not used */
327
#define RSEM_PREEXPORT        1                /* Routes ready for export, before filtering */
328
#define RSEM_EXPORT        2                /* Routes accepted by export filter */
329
#define RSEM_NOEXPORT        3                /* Routes rejected by export filter */
330
331 58ef912c Martin Mares
/*
332
 *        Route Attributes
333
 *
334
 *        Beware: All standard BGP attributes must be represented here instead
335
 *        of making them local to the route. This is needed to ensure proper
336
 *        construction of BGP route attribute lists.
337
 */
338
339 7e95c05d Ondrej Zajicek
/* Multipath next-hop */
340
struct mpnh {
341
  ip_addr gw;                                /* Next hop */
342
  struct iface *iface;                        /* Outgoing interface */
343
  struct mpnh *next;
344 e348ef01 Pavel Tvrdík
  byte weight;
345 7e95c05d Ondrej Zajicek
};
346
347 094d2bdb Ondrej Zajicek
struct rte_src {
348
  struct rte_src *next;                        /* Hash chain */
349
  struct proto *proto;                        /* Protocol the source is based on */
350
  u32 private_id;                        /* Private ID, assigned by the protocol */
351
  u32 global_id;                        /* Globally unique ID of the source */
352
  unsigned uc;                                /* Use count */
353
};
354
355
356 1b769b08 Martin Mares
typedef struct rta {
357 ee76a92a Martin Mares
  struct rta *next, **pprev;                /* Hash chain */
358 094d2bdb Ondrej Zajicek
  struct rte_src *src;                        /* Route source that created the route */
359 58ef912c Martin Mares
  unsigned uc;                                /* Use count */
360
  byte source;                                /* Route source (RTS_...) */
361 a8b60382 Martin Mares
  byte scope;                                /* Route scope (SCOPE_... -- see ip.h) */
362 58ef912c Martin Mares
  byte cast;                                /* Casting type (RTC_...) */
363
  byte dest;                                /* Route destination type (RTD_...) */
364 c8518ae1 Martin Mares
  byte flags;                                /* Route flags (RTF_...), now unused */
365 04925e90 Martin Mares
  byte aflags;                                /* Attribute cache flags (RTAF_...) */
366 ee76a92a Martin Mares
  u16 hash_key;                                /* Hash over important fields */
367 d1e146f2 Ondrej Zajicek
  u32 igp_metric;                        /* IGP metric to next hop (for iBGP routes) */
368 58ef912c Martin Mares
  ip_addr gw;                                /* Next hop */
369 a8b60382 Martin Mares
  ip_addr from;                                /* Advertising router */
370 cfe34a31 Ondrej Zajicek
  struct hostentry *hostentry;                /* Hostentry for recursive next-hops */
371 58ef912c Martin Mares
  struct iface *iface;                        /* Outgoing interface */
372 7e95c05d Ondrej Zajicek
  struct mpnh *nexthops;                /* Next-hops for multipath routes */
373 2727bb7c Martin Mares
  struct ea_list *eattrs;                /* Extended Attribute chain */
374 58ef912c Martin Mares
} rta;
375
376 618533af Martin Mares
#define RTS_DUMMY 0                        /* Dummy route to be removed soon */
377 58ef912c Martin Mares
#define RTS_STATIC 1                        /* Normal static route */
378
#define RTS_INHERIT 2                        /* Route inherited from kernel */
379
#define RTS_DEVICE 3                        /* Device route */
380
#define RTS_STATIC_DEVICE 4                /* Static device route */
381
#define RTS_REDIRECT 5                        /* Learned via redirect */
382
#define RTS_RIP 6                        /* RIP route */
383 beaf86e1 Martin Mares
#define RTS_OSPF 7                        /* OSPF route */
384 8bf684ec Ondrej Filip
#define RTS_OSPF_IA 8                        /* OSPF inter-area route */
385 98ac6176 Ondrej Filip
#define RTS_OSPF_EXT1 9                        /* OSPF external route type 1 */
386
#define RTS_OSPF_EXT2 10                /* OSPF external route type 2 */
387
#define RTS_BGP 11                        /* BGP route */
388
#define RTS_PIPE 12                        /* Inter-table wormhole */
389 58ef912c Martin Mares
390
#define RTC_UNICAST 0
391
#define RTC_BROADCAST 1
392
#define RTC_MULTICAST 2
393
#define RTC_ANYCAST 3                        /* IPv6 Anycast */
394
395
#define RTD_ROUTER 0                        /* Next hop is neighbor router */
396
#define RTD_DEVICE 1                        /* Points to device */
397
#define RTD_BLACKHOLE 2                        /* Silently drop packets */
398
#define RTD_UNREACHABLE 3                /* Reject as unreachable */
399
#define RTD_PROHIBIT 4                        /* Administratively prohibited */
400 7e95c05d Ondrej Zajicek
#define RTD_MULTIPATH 5                        /* Multipath route (nexthops != NULL) */
401
#define RTD_NONE 6                        /* Invalid RTD */
402 58ef912c Martin Mares
403 32f95476 Ondrej Zajicek
                                        /* Flags for net->n.flags, used by kernel syncer */
404
#define KRF_INSTALLED 0x80                /* This route should be installed in the kernel */
405
#define KRF_SYNC_ERROR 0x40                /* Error during kernel table synchronization */
406
407 04925e90 Martin Mares
#define RTAF_CACHED 1                        /* This is a cached rta */
408
409 d1e146f2 Ondrej Zajicek
#define IGP_METRIC_UNKNOWN 0x80000000        /* Default igp_metric used when no other
410
                                           protocol-specific metric is availabe */
411
412 8d9eef17 Ondrej Zajicek
413
/* Route has regular, reachable nexthop (i.e. not RTD_UNREACHABLE and like) */
414
static inline int rte_is_reachable(rte *r)
415
{ uint d = r->attrs->dest; return (d == RTD_ROUTER) || (d == RTD_DEVICE) || (d == RTD_MULTIPATH); }
416
417
418 58ef912c Martin Mares
/*
419
 *        Extended Route Attributes
420
 */
421
422
typedef struct eattr {
423 b77ae37d Martin Mares
  word id;                                /* EA_CODE(EAP_..., protocol-dependent ID) */
424
  byte flags;                                /* Protocol-dependent flags */
425
  byte type;                                /* Attribute type and several flags (EAF_...) */
426 58ef912c Martin Mares
  union {
427
    u32 data;
428
    struct adata *ptr;                        /* Attribute data elsewhere */
429
  } u;
430
} eattr;
431
432
#define EAP_GENERIC 0                        /* Generic attributes */
433
#define EAP_BGP 1                        /* BGP attributes */
434 9c9e49ac Pavel Machek
#define EAP_RIP 2                        /* RIP */
435 5919c66e Martin Mares
#define EAP_OSPF 3                        /* OSPF */
436 71ca7716 Ondrej Zajicek
#define EAP_KRT 4                        /* Kernel route attributes */
437
#define EAP_MAX 5
438 58ef912c Martin Mares
439 b77ae37d Martin Mares
#define EA_CODE(proto,id) (((proto) << 8) | (id))
440
#define EA_PROTO(ea) ((ea) >> 8)
441
#define EA_ID(ea) ((ea) & 0xff)
442
443 ba5e5940 Ondrej Zajicek
#define EA_GEN_IGP_METRIC EA_CODE(EAP_GENERIC, 0)
444
445 8d24b689 Martin Mares
#define EA_CODE_MASK 0xffff
446
#define EA_ALLOW_UNDEF 0x10000                /* ea_find: allow EAF_TYPE_UNDEF */
447 315f23a0 Ondrej Zajicek
#define EA_BIT(n) ((n) << 24)                /* Used in bitfield accessors */
448 8d24b689 Martin Mares
449 b77ae37d Martin Mares
#define EAF_TYPE_MASK 0x0f                /* Mask with this to get type */
450 315f23a0 Ondrej Zajicek
#define EAF_TYPE_INT 0x01                /* 32-bit unsigned integer number */
451 b77ae37d Martin Mares
#define EAF_TYPE_OPAQUE 0x02                /* Opaque byte string (not filterable) */
452 ca97b489 Martin Mares
#define EAF_TYPE_IP_ADDRESS 0x04        /* IP address */
453
#define EAF_TYPE_ROUTER_ID 0x05                /* Router ID (IPv4 address) */
454 b475c543 Martin Mares
#define EAF_TYPE_AS_PATH 0x06                /* BGP AS path (encoding per RFC 1771:4.3) */
455 315f23a0 Ondrej Zajicek
#define EAF_TYPE_BITFIELD 0x09                /* 32-bit embedded bitfield */
456 b475c543 Martin Mares
#define EAF_TYPE_INT_SET 0x0a                /* Set of u32's (e.g., a community list) */
457 42a0c054 Ondrej Zajicek
#define EAF_TYPE_EC_SET 0x0e                /* Set of pairs of u32's - ext. community list */
458 8d24b689 Martin Mares
#define EAF_TYPE_UNDEF 0x0f                /* `force undefined' entry */
459 b77ae37d Martin Mares
#define EAF_EMBEDDED 0x01                /* Data stored in eattr.u.data (part of type spec) */
460 ca97b489 Martin Mares
#define EAF_VAR_LENGTH 0x02                /* Attribute length is variable (part of type spec) */
461 51a183af Martin Mares
#define EAF_ORIGINATED 0x40                /* The attribute has originated locally */
462 9f4929e7 Martin Mares
#define EAF_TEMP 0x80                        /* A temporary attribute (the one stored in the tmp attr list) */
463 58ef912c Martin Mares
464
struct adata {
465 ae80a2de Pavel Tvrdík
  uint length;                                /* Length of data */
466 58ef912c Martin Mares
  byte data[0];
467
};
468
469 28a10f84 Ondrej Zajicek
static inline int adata_same(struct adata *a, struct adata *b)
470
{ return (a->length == b->length && !memcmp(a->data, b->data, a->length)); }
471
472
473 58ef912c Martin Mares
typedef struct ea_list {
474
  struct ea_list *next;                        /* In case we have an override list */
475 b77ae37d Martin Mares
  byte flags;                                /* Flags: EALF_... */
476 58ef912c Martin Mares
  byte rfu;
477 b77ae37d Martin Mares
  word count;                                /* Number of attributes */
478 58ef912c Martin Mares
  eattr attrs[0];                        /* Attribute definitions themselves */
479
} ea_list;
480
481 b77ae37d Martin Mares
#define EALF_SORTED 1                        /* Attributes are sorted by code */
482
#define EALF_BISECT 2                        /* Use interval bisection for searching */
483
#define EALF_CACHED 4                        /* Attributes belonging to cached rta */
484 58ef912c Martin Mares
485 094d2bdb Ondrej Zajicek
struct rte_src *rt_find_source(struct proto *p, u32 id);
486
struct rte_src *rt_get_source(struct proto *p, u32 id);
487
static inline void rt_lock_source(struct rte_src *src) { src->uc++; }
488
static inline void rt_unlock_source(struct rte_src *src) { src->uc--; }
489
void rt_prune_sources(void);
490
491 9fdf9d29 Ondrej Zajicek
struct ea_walk_state {
492
  ea_list *eattrs;                        /* Ccurrent ea_list, initially set by caller */
493
  eattr *ea;                                /* Current eattr, initially NULL */
494
  u32 visited[4];                        /* Bitfield, limiting max to 128 */
495
};
496 094d2bdb Ondrej Zajicek
497 b77ae37d Martin Mares
eattr *ea_find(ea_list *, unsigned ea);
498 9fdf9d29 Ondrej Zajicek
eattr *ea_walk(struct ea_walk_state *s, uint id, uint max);
499 c0100454 Pavel Machek
int ea_get_int(ea_list *, unsigned ea, int def);
500 b77ae37d Martin Mares
void ea_dump(ea_list *);
501
void ea_sort(ea_list *);                /* Sort entries in all sub-lists */
502 6f57dcc0 Martin Mares
unsigned ea_scan(ea_list *);                /* How many bytes do we need for merged ea_list */
503 b77ae37d Martin Mares
void ea_merge(ea_list *from, ea_list *to); /* Merge sub-lists to allocated buffer */
504 6f57dcc0 Martin Mares
int ea_same(ea_list *x, ea_list *y);        /* Test whether two ea_lists are identical */
505 ae80a2de Pavel Tvrdík
uint ea_hash(ea_list *e);        /* Calculate 16-bit hash value */
506 ce1da96e Martin Mares
ea_list *ea_append(ea_list *to, ea_list *what);
507 315f23a0 Ondrej Zajicek
void ea_format_bitfield(struct eattr *a, byte *buf, int bufsize, const char **names, int min, int max);
508 58ef912c Martin Mares
509 7e95c05d Ondrej Zajicek
int mpnh__same(struct mpnh *x, struct mpnh *y); /* Compare multipath nexthops */
510
static inline int mpnh_same(struct mpnh *x, struct mpnh *y)
511
{ return (x == y) || mpnh__same(x, y); }
512 d217ba51 Ondrej Zajicek
struct mpnh *mpnh_merge(struct mpnh *x, struct mpnh *y, int rx, int ry, int max, linpool *lp);
513 7e95c05d Ondrej Zajicek
514 2326b001 Martin Mares
void rta_init(void);
515
rta *rta_lookup(rta *);                        /* Get rta equivalent to this one, uc++ */
516 094d2bdb Ondrej Zajicek
static inline int rta_is_cached(rta *r) { return r->aflags & RTAF_CACHED; }
517 2326b001 Martin Mares
static inline rta *rta_clone(rta *r) { r->uc++; return r; }
518 b77ae37d Martin Mares
void rta__free(rta *r);
519
static inline void rta_free(rta *r) { if (r && !--r->uc) rta__free(r); }
520 8d9eef17 Ondrej Zajicek
rta *rta_do_cow(rta *o, linpool *lp);
521
static inline rta * rta_cow(rta *r, linpool *lp) { return rta_is_cached(r) ? rta_do_cow(r, lp) : r; }
522 2326b001 Martin Mares
void rta_dump(rta *);
523
void rta_dump_all(void);
524 ce1da96e Martin Mares
void rta_show(struct cli *, rta *, ea_list *);
525 1b180121 Ondrej Zajicek
void rta_set_recursive_next_hop(rtable *dep, rta *a, rtable *tab, ip_addr *gw, ip_addr *ll);
526 cfe34a31 Ondrej Zajicek
527
/*
528 acb04cfd Ondrej Zajicek (work)
 * rta_set_recursive_next_hop() acquires hostentry from hostcache and fills
529
 * rta->hostentry field.  New hostentry has zero use count. Cached rta locks its
530
 * hostentry (increases its use count), uncached rta does not lock it. Hostentry
531
 * with zero use count is removed asynchronously during host cache update,
532
 * therefore it is safe to hold such hostentry temorarily. Hostentry holds a
533
 * lock for a 'source' rta, mainly to share multipath nexthops.
534
 *
535
 * There is no need to hold a lock for hostentry->dep table, because that table
536
 * contains routes responsible for that hostentry, and therefore is non-empty if
537
 * given hostentry has non-zero use count. If the hostentry has zero use count,
538
 * the entry is removed before dep is referenced.
539
 *
540
 * The protocol responsible for routes with recursive next hops should hold a
541
 * lock for a 'source' table governing that routes (argument tab to
542
 * rta_set_recursive_next_hop()), because its routes reference hostentries
543
 * (through rta) related to the governing table. When all such routes are
544
 * removed, rtas are immediately removed achieving zero uc. Then the 'source'
545
 * table lock could be immediately released, although hostentries may still
546
 * exist - they will be freed together with the 'source' table.
547 cfe34a31 Ondrej Zajicek
 */
548
549
static inline void rt_lock_hostentry(struct hostentry *he) { if (he) he->uc++; }
550
static inline void rt_unlock_hostentry(struct hostentry *he) { if (he) he->uc--; }
551
552 2326b001 Martin Mares
553 3991d84e Martin Mares
extern struct protocol *attr_class_to_protocol[EAP_MAX];
554
555 a8b60382 Martin Mares
/*
556
 *        Default protocol preferences
557
 */
558
559
#define DEF_PREF_DIRECT                    240        /* Directly connected */
560
#define DEF_PREF_STATIC                200        /* Static route */
561 916c8c0a Martin Mares
#define DEF_PREF_OSPF                150        /* OSPF intra-area, inter-area and type 1 external routes */
562 a8b60382 Martin Mares
#define DEF_PREF_RIP                120        /* RIP */
563
#define DEF_PREF_BGP                100        /* BGP */
564 beaf86e1 Martin Mares
#define DEF_PREF_PIPE                70        /* Routes piped from other tables */
565 916c8c0a Martin Mares
#define DEF_PREF_INHERITED        10        /* Routes inherited from other routing daemons */
566 a8b60382 Martin Mares
567 9656dce7 Jan Moskyto Matejka
#if 0
568 af582c48 Ondrej Zajicek

569
/*
570
 *        Route Origin Authorization
571
 */
572

573
struct roa_item {
574
  u32 asn;
575
  byte maxlen;
576
  byte src;
577
  struct roa_item *next;
578
};
579

580
struct roa_node {
581
  struct fib_node n;
582
  struct roa_item *items;
583
  // u32 cached_asn;
584
};
585

586
struct roa_table {
587
  node n;                                /* Node in roa_table_list */
588
  struct fib fib;
589
  char *name;                                /* Name of this ROA table */
590
  struct roa_table_config *cf;                /* Configuration of this ROA table */
591
};
592

593
struct roa_item_config {
594
  ip_addr prefix;
595
  byte pxlen, maxlen;
596
  u32 asn;
597
  struct roa_item_config *next;
598
};
599

600
struct roa_table_config {
601
  node n;                                /* Node in config->rpa_tables */
602
  char *name;                                /* Name of this ROA table */
603
  struct roa_table *table;
604

605
  struct roa_item_config *roa_items;        /* Preconfigured ROA items */
606

607
  // char *filename;
608
  // int gc_max_ops;                        /* Maximum number of operations before GC is run */
609
  // int gc_min_time;                        /* Minimum time between two consecutive GC runs */
610
};
611

612
struct roa_show_data {
613
  struct fib_iterator fit;
614
  struct roa_table *table;
615
  ip_addr prefix;
616
  byte pxlen;
617
  byte mode;                                /* ROA_SHOW_* values */
618
  u32 asn;                                /* Filter ASN, 0 -> all */
619
};
620

621
#define ROA_UNKNOWN        0
622
#define ROA_VALID        1
623
#define ROA_INVALID        2
624

625
#define ROA_SRC_ANY        0
626
#define ROA_SRC_CONFIG        1
627
#define ROA_SRC_DYNAMIC        2
628

629
#define ROA_SHOW_ALL        0
630
#define ROA_SHOW_PX        1
631
#define ROA_SHOW_IN        2
632
#define ROA_SHOW_FOR        3
633

634
extern struct roa_table *roa_table_default;
635

636
void roa_add_item(struct roa_table *t, ip_addr prefix, byte pxlen, byte maxlen, u32 asn, byte src);
637
void roa_delete_item(struct roa_table *t, ip_addr prefix, byte pxlen, byte maxlen, u32 asn, byte src);
638
void roa_flush(struct roa_table *t, byte src);
639
byte roa_check(struct roa_table *t, ip_addr prefix, byte pxlen, u32 asn);
640
struct roa_table_config * roa_new_table_config(struct symbol *s);
641
void roa_add_item_config(struct roa_table_config *rtc, ip_addr prefix, byte pxlen, byte maxlen, u32 asn);
642
void roa_init(void);
643
void roa_preconfig(struct config *c);
644
void roa_commit(struct config *new, struct config *old);
645
void roa_show(struct roa_show_data *d);
646

647 9656dce7 Jan Moskyto Matejka
#endif
648 58ef912c Martin Mares
#endif