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