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