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