Statistics
| Branch: | Revision:

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

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