]>
Commit | Line | Data |
---|---|---|
718e3744 | 1 | /* |
2 | * Routing Information Base header | |
3 | * Copyright (C) 1997 Kunihiro Ishiguro | |
4 | * | |
5 | * This file is part of GNU Zebra. | |
6 | * | |
7 | * GNU Zebra is free software; you can redistribute it and/or modify it | |
8 | * under the terms of the GNU General Public License as published by the | |
9 | * Free Software Foundation; either version 2, or (at your option) any | |
10 | * later version. | |
11 | * | |
12 | * GNU Zebra is distributed in the hope that it will be useful, but | |
13 | * WITHOUT ANY WARRANTY; without even the implied warranty of | |
14 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU | |
15 | * General Public License for more details. | |
16 | * | |
896014f4 DL |
17 | * You should have received a copy of the GNU General Public License along |
18 | * with this program; see the file COPYING; if not, write to the Free Software | |
19 | * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA | |
718e3744 | 20 | */ |
21 | ||
22 | #ifndef _ZEBRA_RIB_H | |
23 | #define _ZEBRA_RIB_H | |
24 | ||
dc9ffce8 | 25 | #include "zebra.h" |
4f8ea50c | 26 | #include "hook.h" |
c6ffe645 | 27 | #include "linklist.h" |
ec1a4283 | 28 | #include "prefix.h" |
9fd92e3c | 29 | #include "table.h" |
5adc2528 | 30 | #include "queue.h" |
fb018d25 | 31 | #include "nexthop.h" |
7ee30f28 | 32 | #include "nexthop_group.h" |
244a59d2 | 33 | #include "vrf.h" |
fb148af4 | 34 | #include "if.h" |
40c7bdb0 | 35 | #include "mpls.h" |
05737783 | 36 | #include "srcdest_table.h" |
ec1a4283 | 37 | |
718e3744 | 38 | #define DISTANCE_INFINITY 255 |
7a4bb9c5 | 39 | #define ZEBRA_KERNEL_TABLE_MAX 252 /* support for no more than this rt tables */ |
718e3744 | 40 | |
d62a17ae | 41 | struct route_entry { |
42 | /* Link list. */ | |
43 | struct route_entry *next; | |
44 | struct route_entry *prev; | |
45 | ||
46 | /* Nexthop structure */ | |
7ee30f28 | 47 | struct nexthop_group ng; |
d62a17ae | 48 | |
d62a17ae | 49 | /* Tag */ |
50 | route_tag_t tag; | |
51 | ||
52 | /* Uptime. */ | |
53 | time_t uptime; | |
54 | ||
55 | /* Type fo this route. */ | |
56 | int type; | |
57 | ||
58 | /* Source protocol instance */ | |
d7c0a89a | 59 | unsigned short instance; |
d62a17ae | 60 | |
61 | /* VRF identifier. */ | |
62 | vrf_id_t vrf_id; | |
63 | ||
64 | /* Which routing table */ | |
65 | uint32_t table; | |
66 | ||
67 | /* Metric */ | |
d7c0a89a | 68 | uint32_t metric; |
d62a17ae | 69 | |
70 | /* MTU */ | |
d7c0a89a QY |
71 | uint32_t mtu; |
72 | uint32_t nexthop_mtu; | |
d62a17ae | 73 | |
74 | /* Distance. */ | |
fd289fc8 | 75 | uint8_t distance; |
d62a17ae | 76 | |
77 | /* Flags of this route. | |
78 | * This flag's definition is in lib/zebra.h ZEBRA_FLAG_* and is exposed | |
79 | * to clients via Zserv | |
80 | */ | |
d7c0a89a | 81 | uint32_t flags; |
d62a17ae | 82 | |
83 | /* RIB internal status */ | |
d7c0a89a | 84 | uint8_t status; |
f0f77c9a | 85 | #define ROUTE_ENTRY_REMOVED 0x1 |
d62a17ae | 86 | /* to simplify NHT logic when NHs change, instead of doing a NH by NH cmp */ |
f0f77c9a DS |
87 | #define ROUTE_ENTRY_NEXTHOPS_CHANGED 0x2 |
88 | #define ROUTE_ENTRY_CHANGED 0x4 | |
5f7a4718 | 89 | #define ROUTE_ENTRY_LABELS_CHANGED 0x8 |
6d691129 | 90 | |
d62a17ae | 91 | /* Nexthop information. */ |
d7c0a89a QY |
92 | uint8_t nexthop_num; |
93 | uint8_t nexthop_active_num; | |
718e3744 | 94 | }; |
95 | ||
e96f9203 DO |
96 | /* meta-queue structure: |
97 | * sub-queue 0: connected, kernel | |
98 | * sub-queue 1: static | |
43cf4ba4 | 99 | * sub-queue 2: RIP, RIPng, OSPF, OSPF6, IS-IS, EIGRP, NHRP |
e96f9203 DO |
100 | * sub-queue 3: iBGP, eBGP |
101 | * sub-queue 4: any other origin (if any) | |
102 | */ | |
103 | #define MQ_SIZE 5 | |
d62a17ae | 104 | struct meta_queue { |
105 | struct list *subq[MQ_SIZE]; | |
d7c0a89a | 106 | uint32_t size; /* sum of lengths of all subqueues */ |
e96f9203 DO |
107 | }; |
108 | ||
9fd92e3c AS |
109 | /* |
110 | * Structure that represents a single destination (prefix). | |
111 | */ | |
d62a17ae | 112 | typedef struct rib_dest_t_ { |
9fd92e3c | 113 | |
d62a17ae | 114 | /* |
115 | * Back pointer to the route node for this destination. This helps | |
116 | * us get to the prefix that this structure is for. | |
117 | */ | |
118 | struct route_node *rnode; | |
9fd92e3c | 119 | |
d62a17ae | 120 | /* |
121 | * Doubly-linked list of routes for this prefix. | |
122 | */ | |
123 | struct route_entry *routes; | |
9fd92e3c | 124 | |
5f7a4718 DS |
125 | struct route_entry *selected_fib; |
126 | ||
d62a17ae | 127 | /* |
128 | * Flags, see below. | |
129 | */ | |
d7c0a89a | 130 | uint32_t flags; |
9fd92e3c | 131 | |
d62a17ae | 132 | /* |
133 | * Linkage to put dest on the FPM processing queue. | |
134 | */ | |
135 | TAILQ_ENTRY(rib_dest_t_) fpm_q_entries; | |
5adc2528 | 136 | |
9fd92e3c AS |
137 | } rib_dest_t; |
138 | ||
139 | #define RIB_ROUTE_QUEUED(x) (1 << (x)) | |
1ca60f2c DS |
140 | // If MQ_SIZE is modified this value needs to be updated. |
141 | #define RIB_ROUTE_ANY_QUEUED 0x1F | |
9fd92e3c AS |
142 | |
143 | /* | |
144 | * The maximum qindex that can be used. | |
145 | */ | |
146 | #define ZEBRA_MAX_QINDEX (MQ_SIZE - 1) | |
147 | ||
5adc2528 AS |
148 | /* |
149 | * This flag indicates that a given prefix has been 'advertised' to | |
150 | * the FPM to be installed in the forwarding plane. | |
151 | */ | |
152 | #define RIB_DEST_SENT_TO_FPM (1 << (ZEBRA_MAX_QINDEX + 1)) | |
153 | ||
154 | /* | |
155 | * This flag is set when we need to send an update to the FPM about a | |
156 | * dest. | |
157 | */ | |
158 | #define RIB_DEST_UPDATE_FPM (1 << (ZEBRA_MAX_QINDEX + 2)) | |
159 | ||
9fd92e3c AS |
160 | /* |
161 | * Macro to iterate over each route for a destination (prefix). | |
162 | */ | |
d62a17ae | 163 | #define RE_DEST_FOREACH_ROUTE(dest, re) \ |
164 | for ((re) = (dest) ? (dest)->routes : NULL; (re); (re) = (re)->next) | |
9fd92e3c AS |
165 | |
166 | /* | |
167 | * Same as above, but allows the current node to be unlinked. | |
168 | */ | |
d62a17ae | 169 | #define RE_DEST_FOREACH_ROUTE_SAFE(dest, re, next) \ |
170 | for ((re) = (dest) ? (dest)->routes : NULL; \ | |
171 | (re) && ((next) = (re)->next, 1); (re) = (next)) | |
9fd92e3c | 172 | |
d62a17ae | 173 | #define RNODE_FOREACH_RE(rn, re) \ |
996c9314 | 174 | RE_DEST_FOREACH_ROUTE (rib_dest_from_rnode(rn), re) |
9fd92e3c | 175 | |
d62a17ae | 176 | #define RNODE_FOREACH_RE_SAFE(rn, re, next) \ |
996c9314 | 177 | RE_DEST_FOREACH_ROUTE_SAFE (rib_dest_from_rnode(rn), re, next) |
9fd92e3c | 178 | |
d62a17ae | 179 | #if defined(HAVE_RTADV) |
cd80d74f | 180 | /* Structure which hold status of router advertisement. */ |
d62a17ae | 181 | struct rtadv { |
182 | int sock; | |
cd80d74f | 183 | |
d62a17ae | 184 | int adv_if_count; |
185 | int adv_msec_if_count; | |
cd80d74f | 186 | |
d62a17ae | 187 | struct thread *ra_read; |
188 | struct thread *ra_timer; | |
cd80d74f | 189 | }; |
8da4e946 | 190 | #endif /* HAVE_RTADV */ |
cd80d74f | 191 | |
1b5ed1b0 AS |
192 | /* |
193 | * rib_table_info_t | |
194 | * | |
195 | * Structure that is hung off of a route_table that holds information about | |
196 | * the table. | |
197 | */ | |
d62a17ae | 198 | typedef struct rib_table_info_t_ { |
1b5ed1b0 | 199 | |
d62a17ae | 200 | /* |
201 | * Back pointer to zebra_vrf. | |
202 | */ | |
203 | struct zebra_vrf *zvrf; | |
204 | afi_t afi; | |
205 | safi_t safi; | |
1b5ed1b0 AS |
206 | |
207 | } rib_table_info_t; | |
208 | ||
d62a17ae | 209 | typedef enum { |
210 | RIB_TABLES_ITER_S_INIT, | |
211 | RIB_TABLES_ITER_S_ITERATING, | |
212 | RIB_TABLES_ITER_S_DONE | |
0915bb0c AS |
213 | } rib_tables_iter_state_t; |
214 | ||
215 | /* | |
216 | * Structure that holds state for iterating over all tables in the | |
217 | * Routing Information Base. | |
218 | */ | |
d62a17ae | 219 | typedef struct rib_tables_iter_t_ { |
220 | vrf_id_t vrf_id; | |
221 | int afi_safi_ix; | |
0915bb0c | 222 | |
d62a17ae | 223 | rib_tables_iter_state_t state; |
0915bb0c AS |
224 | } rib_tables_iter_t; |
225 | ||
1c848137 | 226 | /* Events/reasons triggering a RIB update. */ |
d62a17ae | 227 | typedef enum { |
228 | RIB_UPDATE_IF_CHANGE, | |
229 | RIB_UPDATE_RMAP_CHANGE, | |
230 | RIB_UPDATE_OTHER | |
1c848137 | 231 | } rib_update_event_t; |
232 | ||
072834ca DS |
233 | extern struct nexthop *route_entry_nexthop_ifindex_add(struct route_entry *re, |
234 | ifindex_t ifindex, | |
4a7371e9 | 235 | vrf_id_t nh_vrf_id); |
072834ca DS |
236 | extern struct nexthop * |
237 | route_entry_nexthop_blackhole_add(struct route_entry *re, | |
238 | enum blackhole_type bh_type); | |
239 | extern struct nexthop *route_entry_nexthop_ipv4_add(struct route_entry *re, | |
240 | struct in_addr *ipv4, | |
241 | struct in_addr *src, | |
4a7371e9 | 242 | vrf_id_t nh_vrf_id); |
d62a17ae | 243 | extern struct nexthop * |
072834ca DS |
244 | route_entry_nexthop_ipv4_ifindex_add(struct route_entry *re, |
245 | struct in_addr *ipv4, struct in_addr *src, | |
246 | ifindex_t ifindex, vrf_id_t nh_vrf_id); | |
d62a17ae | 247 | extern void route_entry_nexthop_delete(struct route_entry *re, |
248 | struct nexthop *nexthop); | |
072834ca DS |
249 | extern struct nexthop *route_entry_nexthop_ipv6_add(struct route_entry *re, |
250 | struct in6_addr *ipv6, | |
4a7371e9 | 251 | vrf_id_t nh_vrf_id); |
d62a17ae | 252 | extern struct nexthop * |
253 | route_entry_nexthop_ipv6_ifindex_add(struct route_entry *re, | |
4a7371e9 DS |
254 | struct in6_addr *ipv6, ifindex_t ifindex, |
255 | vrf_id_t nh_vrf_id); | |
d62a17ae | 256 | extern void route_entry_nexthop_add(struct route_entry *re, |
257 | struct nexthop *nexthop); | |
258 | extern void route_entry_copy_nexthops(struct route_entry *re, | |
259 | struct nexthop *nh); | |
f0f77c9a DS |
260 | |
261 | #define route_entry_dump(prefix, src, re) _route_entry_dump(__func__, prefix, src, re) | |
072834ca DS |
262 | extern void _route_entry_dump(const char *func, union prefixconstptr pp, |
263 | union prefixconstptr src_pp, | |
264 | const struct route_entry *re); | |
4623d897 | 265 | /* RPF lookup behaviour */ |
d62a17ae | 266 | enum multicast_mode { |
267 | MCAST_NO_CONFIG = 0, /* MIX_MRIB_FIRST, but no show in config write */ | |
268 | MCAST_MRIB_ONLY, /* MRIB only */ | |
269 | MCAST_URIB_ONLY, /* URIB only */ | |
270 | MCAST_MIX_MRIB_FIRST, /* MRIB, if nothing at all then URIB */ | |
271 | MCAST_MIX_DISTANCE, /* MRIB & URIB, lower distance wins */ | |
272 | MCAST_MIX_PFXLEN, /* MRIB & URIB, longer prefix wins */ | |
273 | /* on equal value, MRIB wins for last 2 */ | |
4623d897 DL |
274 | }; |
275 | ||
d62a17ae | 276 | extern void multicast_mode_ipv4_set(enum multicast_mode mode); |
277 | extern enum multicast_mode multicast_mode_ipv4_get(void); | |
4623d897 | 278 | |
072834ca DS |
279 | extern void rib_lookup_and_dump(struct prefix_ipv4 *p, vrf_id_t vrf_id); |
280 | extern void rib_lookup_and_pushup(struct prefix_ipv4 *p, vrf_id_t vrf_id); | |
f0f77c9a | 281 | |
072834ca DS |
282 | extern int rib_lookup_ipv4_route(struct prefix_ipv4 *p, union sockunion *qgate, |
283 | vrf_id_t vrf_id); | |
dc95824a DO |
284 | #define ZEBRA_RIB_LOOKUP_ERROR -1 |
285 | #define ZEBRA_RIB_FOUND_EXACT 0 | |
286 | #define ZEBRA_RIB_FOUND_NOGATE 1 | |
287 | #define ZEBRA_RIB_FOUND_CONNECTED 2 | |
288 | #define ZEBRA_RIB_NOTFOUND 3 | |
289 | ||
d7c0a89a QY |
290 | extern int is_zebra_valid_kernel_table(uint32_t table_id); |
291 | extern int is_zebra_main_routing_table(uint32_t table_id); | |
86391e56 | 292 | extern int zebra_check_addr(const struct prefix *p); |
718e3744 | 293 | |
d62a17ae | 294 | extern void rib_delnode(struct route_node *rn, struct route_entry *re); |
0c555cc6 DS |
295 | extern void rib_install_kernel(struct route_node *rn, struct route_entry *re, |
296 | struct route_entry *old); | |
297 | extern void rib_uninstall_kernel(struct route_node *rn, struct route_entry *re); | |
28f6dde8 | 298 | |
d24af186 | 299 | /* NOTE: |
b4c034b0 | 300 | * All rib_add function will not just add prefix into RIB, but |
d24af186 | 301 | * also implicitly withdraw equal prefix of same type. */ |
4a7371e9 | 302 | extern int rib_add(afi_t afi, safi_t safi, vrf_id_t vrf_id, int type, |
d7c0a89a | 303 | unsigned short instance, int flags, struct prefix *p, |
fd36be7e | 304 | struct prefix_ipv6 *src_p, const struct nexthop *nh, |
d7c0a89a | 305 | uint32_t table_id, uint32_t metric, uint32_t mtu, |
4e40b6d6 | 306 | uint8_t distance, route_tag_t tag); |
d62a17ae | 307 | |
072834ca DS |
308 | extern int rib_add_multipath(afi_t afi, safi_t safi, struct prefix *p, |
309 | struct prefix_ipv6 *src_p, struct route_entry *re); | |
d62a17ae | 310 | |
311 | extern void rib_delete(afi_t afi, safi_t safi, vrf_id_t vrf_id, int type, | |
d7c0a89a | 312 | unsigned short instance, int flags, struct prefix *p, |
fd36be7e | 313 | struct prefix_ipv6 *src_p, const struct nexthop *nh, |
40ecd8e4 DS |
314 | uint32_t table_id, uint32_t metric, uint8_t distance, |
315 | bool fromkernel); | |
d62a17ae | 316 | |
072834ca DS |
317 | extern struct route_entry *rib_match(afi_t afi, safi_t safi, vrf_id_t vrf_id, |
318 | union g_addr *addr, | |
d62a17ae | 319 | struct route_node **rn_out); |
320 | extern struct route_entry *rib_match_ipv4_multicast(vrf_id_t vrf_id, | |
321 | struct in_addr addr, | |
322 | struct route_node **rn_out); | |
323 | ||
072834ca DS |
324 | extern struct route_entry *rib_lookup_ipv4(struct prefix_ipv4 *p, |
325 | vrf_id_t vrf_id); | |
d62a17ae | 326 | |
072834ca | 327 | extern void rib_update(vrf_id_t vrf_id, rib_update_event_t event); |
d5b8c216 | 328 | extern void rib_update_table(struct route_table *table, |
329 | rib_update_event_t event); | |
d62a17ae | 330 | extern void rib_sweep_route(void); |
072834ca DS |
331 | extern void rib_sweep_table(struct route_table *table); |
332 | extern void rib_close_table(struct route_table *table); | |
d62a17ae | 333 | extern void rib_init(void); |
d7c0a89a QY |
334 | extern unsigned long rib_score_proto(uint8_t proto, unsigned short instance); |
335 | extern unsigned long rib_score_proto_table(uint8_t proto, | |
336 | unsigned short instance, | |
47a08aa9 | 337 | struct route_table *table); |
d62a17ae | 338 | extern void rib_queue_add(struct route_node *rn); |
339 | extern void meta_queue_free(struct meta_queue *mq); | |
340 | extern int zebra_rib_labeled_unicast(struct route_entry *re); | |
718e3744 | 341 | extern struct route_table *rib_table_ipv6; |
342 | ||
072834ca | 343 | extern void rib_unlink(struct route_node *rn, struct route_entry *re); |
d62a17ae | 344 | extern int rib_gc_dest(struct route_node *rn); |
345 | extern struct route_table *rib_tables_iter_next(rib_tables_iter_t *iter); | |
9fd92e3c | 346 | |
fd289fc8 | 347 | extern uint8_t route_distance(int type); |
40c7bdb0 | 348 | |
9fd92e3c AS |
349 | /* |
350 | * Inline functions. | |
351 | */ | |
352 | ||
1b5ed1b0 AS |
353 | /* |
354 | * rib_table_info | |
355 | */ | |
d62a17ae | 356 | static inline rib_table_info_t *rib_table_info(struct route_table *table) |
1b5ed1b0 | 357 | { |
d62a17ae | 358 | return (rib_table_info_t *)table->info; |
1b5ed1b0 AS |
359 | } |
360 | ||
9fd92e3c AS |
361 | /* |
362 | * rib_dest_from_rnode | |
363 | */ | |
d62a17ae | 364 | static inline rib_dest_t *rib_dest_from_rnode(struct route_node *rn) |
9fd92e3c | 365 | { |
d62a17ae | 366 | return (rib_dest_t *)rn->info; |
9fd92e3c AS |
367 | } |
368 | ||
369 | /* | |
370 | * rnode_to_ribs | |
371 | * | |
372 | * Returns a pointer to the list of routes corresponding to the given | |
373 | * route_node. | |
374 | */ | |
d62a17ae | 375 | static inline struct route_entry *rnode_to_ribs(struct route_node *rn) |
9fd92e3c | 376 | { |
d62a17ae | 377 | rib_dest_t *dest; |
9fd92e3c | 378 | |
d62a17ae | 379 | dest = rib_dest_from_rnode(rn); |
380 | if (!dest) | |
381 | return NULL; | |
9fd92e3c | 382 | |
d62a17ae | 383 | return dest->routes; |
9fd92e3c AS |
384 | } |
385 | ||
386 | /* | |
387 | * rib_dest_prefix | |
388 | */ | |
d62a17ae | 389 | static inline struct prefix *rib_dest_prefix(rib_dest_t *dest) |
9fd92e3c | 390 | { |
d62a17ae | 391 | return &dest->rnode->p; |
9fd92e3c AS |
392 | } |
393 | ||
394 | /* | |
395 | * rib_dest_af | |
396 | * | |
397 | * Returns the address family that the destination is for. | |
398 | */ | |
d7c0a89a | 399 | static inline uint8_t rib_dest_af(rib_dest_t *dest) |
9fd92e3c | 400 | { |
d62a17ae | 401 | return dest->rnode->p.family; |
9fd92e3c AS |
402 | } |
403 | ||
404 | /* | |
405 | * rib_dest_table | |
406 | */ | |
d62a17ae | 407 | static inline struct route_table *rib_dest_table(rib_dest_t *dest) |
9fd92e3c | 408 | { |
d62a17ae | 409 | return srcdest_rnode_table(dest->rnode); |
9fd92e3c AS |
410 | } |
411 | ||
1b5ed1b0 AS |
412 | /* |
413 | * rib_dest_vrf | |
414 | */ | |
d62a17ae | 415 | static inline struct zebra_vrf *rib_dest_vrf(rib_dest_t *dest) |
1b5ed1b0 | 416 | { |
d62a17ae | 417 | return rib_table_info(rib_dest_table(dest))->zvrf; |
1b5ed1b0 AS |
418 | } |
419 | ||
0915bb0c AS |
420 | /* |
421 | * rib_tables_iter_init | |
422 | */ | |
d62a17ae | 423 | static inline void rib_tables_iter_init(rib_tables_iter_t *iter) |
0915bb0c AS |
424 | |
425 | { | |
d62a17ae | 426 | memset(iter, 0, sizeof(*iter)); |
427 | iter->state = RIB_TABLES_ITER_S_INIT; | |
0915bb0c AS |
428 | } |
429 | ||
430 | /* | |
431 | * rib_tables_iter_started | |
432 | * | |
433 | * Returns TRUE if this iterator has started iterating over the set of | |
434 | * tables. | |
435 | */ | |
d62a17ae | 436 | static inline int rib_tables_iter_started(rib_tables_iter_t *iter) |
0915bb0c | 437 | { |
d62a17ae | 438 | return iter->state != RIB_TABLES_ITER_S_INIT; |
0915bb0c AS |
439 | } |
440 | ||
441 | /* | |
442 | * rib_tables_iter_cleanup | |
443 | */ | |
d62a17ae | 444 | static inline void rib_tables_iter_cleanup(rib_tables_iter_t *iter) |
0915bb0c | 445 | { |
d62a17ae | 446 | iter->state = RIB_TABLES_ITER_S_DONE; |
0915bb0c AS |
447 | } |
448 | ||
d62a17ae | 449 | DECLARE_HOOK(rib_update, (struct route_node * rn, const char *reason), |
450 | (rn, reason)) | |
4f8ea50c | 451 | |
05f7f5db DS |
452 | |
453 | extern void zebra_vty_init(void); | |
4060008b | 454 | |
05f7f5db DS |
455 | extern pid_t pid; |
456 | ||
6b093863 | 457 | extern bool v6_rr_semantics; |
718e3744 | 458 | #endif /*_ZEBRA_RIB_H */ |