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