]>
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" |
244a59d2 | 32 | #include "vrf.h" |
fb148af4 | 33 | #include "if.h" |
40c7bdb0 | 34 | #include "mpls.h" |
05737783 | 35 | #include "srcdest_table.h" |
ec1a4283 | 36 | |
718e3744 | 37 | #define DISTANCE_INFINITY 255 |
7a4bb9c5 | 38 | #define ZEBRA_KERNEL_TABLE_MAX 252 /* support for no more than this rt tables */ |
718e3744 | 39 | |
d62a17ae | 40 | struct route_entry { |
41 | /* Link list. */ | |
42 | struct route_entry *next; | |
43 | struct route_entry *prev; | |
44 | ||
45 | /* Nexthop structure */ | |
46 | struct nexthop *nexthop; | |
47 | ||
d62a17ae | 48 | /* Tag */ |
49 | route_tag_t tag; | |
50 | ||
51 | /* Uptime. */ | |
52 | time_t uptime; | |
53 | ||
54 | /* Type fo this route. */ | |
55 | int type; | |
56 | ||
57 | /* Source protocol instance */ | |
58 | u_short instance; | |
59 | ||
60 | /* VRF identifier. */ | |
61 | vrf_id_t vrf_id; | |
8f43b4d8 | 62 | vrf_id_t nh_vrf_id; |
d62a17ae | 63 | |
64 | /* Which routing table */ | |
65 | uint32_t table; | |
66 | ||
67 | /* Metric */ | |
68 | u_int32_t metric; | |
69 | ||
70 | /* MTU */ | |
71 | u_int32_t mtu; | |
72 | u_int32_t nexthop_mtu; | |
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 | */ | |
81 | u_int32_t flags; | |
82 | ||
83 | /* RIB internal status */ | |
84 | u_char 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. */ |
92 | u_char nexthop_num; | |
93 | u_char 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]; | |
106 | u_int32_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 | */ | |
130 | u_int32_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) \ |
174 | RE_DEST_FOREACH_ROUTE(rib_dest_from_rnode(rn), re) | |
9fd92e3c | 175 | |
d62a17ae | 176 | #define RNODE_FOREACH_RE_SAFE(rn, re, next) \ |
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 | ||
d62a17ae | 233 | extern struct nexthop *route_entry_nexthop_ifindex_add(struct route_entry *, |
234 | ifindex_t); | |
a8309422 DL |
235 | extern struct nexthop *route_entry_nexthop_blackhole_add(struct route_entry *, |
236 | enum blackhole_type); | |
d62a17ae | 237 | extern struct nexthop *route_entry_nexthop_ipv4_add(struct route_entry *, |
238 | struct in_addr *, | |
239 | struct in_addr *); | |
240 | extern struct nexthop * | |
241 | route_entry_nexthop_ipv4_ifindex_add(struct route_entry *, struct in_addr *, | |
242 | struct in_addr *, ifindex_t); | |
243 | extern void route_entry_nexthop_delete(struct route_entry *re, | |
244 | struct nexthop *nexthop); | |
245 | extern struct nexthop *route_entry_nexthop_ipv6_add(struct route_entry *, | |
246 | struct in6_addr *); | |
247 | extern struct nexthop * | |
248 | route_entry_nexthop_ipv6_ifindex_add(struct route_entry *re, | |
249 | struct in6_addr *ipv6, ifindex_t ifindex); | |
250 | extern void route_entry_nexthop_add(struct route_entry *re, | |
251 | struct nexthop *nexthop); | |
252 | extern void route_entry_copy_nexthops(struct route_entry *re, | |
253 | struct nexthop *nh); | |
f0f77c9a DS |
254 | |
255 | #define route_entry_dump(prefix, src, re) _route_entry_dump(__func__, prefix, src, re) | |
d62a17ae | 256 | extern void _route_entry_dump(const char *, union prefixconstptr, |
257 | union prefixconstptr, const struct route_entry *); | |
4623d897 | 258 | /* RPF lookup behaviour */ |
d62a17ae | 259 | enum multicast_mode { |
260 | MCAST_NO_CONFIG = 0, /* MIX_MRIB_FIRST, but no show in config write */ | |
261 | MCAST_MRIB_ONLY, /* MRIB only */ | |
262 | MCAST_URIB_ONLY, /* URIB only */ | |
263 | MCAST_MIX_MRIB_FIRST, /* MRIB, if nothing at all then URIB */ | |
264 | MCAST_MIX_DISTANCE, /* MRIB & URIB, lower distance wins */ | |
265 | MCAST_MIX_PFXLEN, /* MRIB & URIB, longer prefix wins */ | |
266 | /* on equal value, MRIB wins for last 2 */ | |
4623d897 DL |
267 | }; |
268 | ||
d62a17ae | 269 | extern void multicast_mode_ipv4_set(enum multicast_mode mode); |
270 | extern enum multicast_mode multicast_mode_ipv4_get(void); | |
4623d897 | 271 | |
d62a17ae | 272 | extern void rib_lookup_and_dump(struct prefix_ipv4 *, vrf_id_t); |
273 | extern void rib_lookup_and_pushup(struct prefix_ipv4 *, vrf_id_t); | |
f0f77c9a | 274 | |
d62a17ae | 275 | extern int rib_lookup_ipv4_route(struct prefix_ipv4 *, union sockunion *, |
276 | vrf_id_t); | |
dc95824a DO |
277 | #define ZEBRA_RIB_LOOKUP_ERROR -1 |
278 | #define ZEBRA_RIB_FOUND_EXACT 0 | |
279 | #define ZEBRA_RIB_FOUND_NOGATE 1 | |
280 | #define ZEBRA_RIB_FOUND_CONNECTED 2 | |
281 | #define ZEBRA_RIB_NOTFOUND 3 | |
282 | ||
7a4bb9c5 DS |
283 | extern int is_zebra_valid_kernel_table(u_int32_t table_id); |
284 | extern int is_zebra_main_routing_table(u_int32_t table_id); | |
d62a17ae | 285 | extern int zebra_check_addr(struct prefix *p); |
718e3744 | 286 | |
d62a17ae | 287 | extern void rib_addnode(struct route_node *rn, struct route_entry *re, |
288 | int process); | |
289 | extern void rib_delnode(struct route_node *rn, struct route_entry *re); | |
0c555cc6 DS |
290 | extern void rib_install_kernel(struct route_node *rn, struct route_entry *re, |
291 | struct route_entry *old); | |
292 | extern void rib_uninstall_kernel(struct route_node *rn, struct route_entry *re); | |
28f6dde8 | 293 | |
d24af186 | 294 | /* NOTE: |
b4c034b0 | 295 | * All rib_add function will not just add prefix into RIB, but |
d24af186 | 296 | * also implicitly withdraw equal prefix of same type. */ |
8795f904 DS |
297 | extern int rib_add(afi_t afi, safi_t safi, vrf_id_t vrf_id, vrf_id_t nh_vrf_id, |
298 | int type, u_short instance, int flags, struct prefix *p, | |
fd36be7e DL |
299 | struct prefix_ipv6 *src_p, const struct nexthop *nh, |
300 | u_int32_t table_id, u_int32_t metric, u_int32_t mtu, | |
4e40b6d6 | 301 | uint8_t distance, route_tag_t tag); |
d62a17ae | 302 | |
303 | extern int rib_add_multipath(afi_t afi, safi_t safi, struct prefix *, | |
304 | struct prefix_ipv6 *src_p, struct route_entry *); | |
305 | ||
306 | extern void rib_delete(afi_t afi, safi_t safi, vrf_id_t vrf_id, int type, | |
307 | u_short instance, int flags, struct prefix *p, | |
fd36be7e | 308 | struct prefix_ipv6 *src_p, const struct nexthop *nh, |
6134fd82 | 309 | u_int32_t table_id, u_int32_t metric, bool fromkernel, |
310 | struct ethaddr *rmac); | |
d62a17ae | 311 | |
312 | extern struct route_entry *rib_match(afi_t afi, safi_t safi, vrf_id_t, | |
313 | union g_addr *, | |
314 | struct route_node **rn_out); | |
315 | extern struct route_entry *rib_match_ipv4_multicast(vrf_id_t vrf_id, | |
316 | struct in_addr addr, | |
317 | struct route_node **rn_out); | |
318 | ||
319 | extern struct route_entry *rib_lookup_ipv4(struct prefix_ipv4 *, vrf_id_t); | |
320 | ||
321 | extern void rib_update(vrf_id_t, rib_update_event_t); | |
322 | extern void rib_weed_tables(void); | |
323 | extern void rib_sweep_route(void); | |
324 | extern void rib_close_table(struct route_table *); | |
325 | extern void rib_init(void); | |
326 | extern unsigned long rib_score_proto(u_char proto, u_short instance); | |
327 | extern void rib_queue_add(struct route_node *rn); | |
328 | extern void meta_queue_free(struct meta_queue *mq); | |
329 | extern int zebra_rib_labeled_unicast(struct route_entry *re); | |
718e3744 | 330 | extern struct route_table *rib_table_ipv6; |
331 | ||
d62a17ae | 332 | extern void rib_unlink(struct route_node *, struct route_entry *); |
333 | extern int rib_gc_dest(struct route_node *rn); | |
334 | extern struct route_table *rib_tables_iter_next(rib_tables_iter_t *iter); | |
9fd92e3c | 335 | |
fd289fc8 | 336 | extern uint8_t route_distance(int type); |
40c7bdb0 | 337 | |
9fd92e3c AS |
338 | /* |
339 | * Inline functions. | |
340 | */ | |
341 | ||
1b5ed1b0 AS |
342 | /* |
343 | * rib_table_info | |
344 | */ | |
d62a17ae | 345 | static inline rib_table_info_t *rib_table_info(struct route_table *table) |
1b5ed1b0 | 346 | { |
d62a17ae | 347 | return (rib_table_info_t *)table->info; |
1b5ed1b0 AS |
348 | } |
349 | ||
9fd92e3c AS |
350 | /* |
351 | * rib_dest_from_rnode | |
352 | */ | |
d62a17ae | 353 | static inline rib_dest_t *rib_dest_from_rnode(struct route_node *rn) |
9fd92e3c | 354 | { |
d62a17ae | 355 | return (rib_dest_t *)rn->info; |
9fd92e3c AS |
356 | } |
357 | ||
358 | /* | |
359 | * rnode_to_ribs | |
360 | * | |
361 | * Returns a pointer to the list of routes corresponding to the given | |
362 | * route_node. | |
363 | */ | |
d62a17ae | 364 | static inline struct route_entry *rnode_to_ribs(struct route_node *rn) |
9fd92e3c | 365 | { |
d62a17ae | 366 | rib_dest_t *dest; |
9fd92e3c | 367 | |
d62a17ae | 368 | dest = rib_dest_from_rnode(rn); |
369 | if (!dest) | |
370 | return NULL; | |
9fd92e3c | 371 | |
d62a17ae | 372 | return dest->routes; |
9fd92e3c AS |
373 | } |
374 | ||
375 | /* | |
376 | * rib_dest_prefix | |
377 | */ | |
d62a17ae | 378 | static inline struct prefix *rib_dest_prefix(rib_dest_t *dest) |
9fd92e3c | 379 | { |
d62a17ae | 380 | return &dest->rnode->p; |
9fd92e3c AS |
381 | } |
382 | ||
383 | /* | |
384 | * rib_dest_af | |
385 | * | |
386 | * Returns the address family that the destination is for. | |
387 | */ | |
d62a17ae | 388 | static inline u_char rib_dest_af(rib_dest_t *dest) |
9fd92e3c | 389 | { |
d62a17ae | 390 | return dest->rnode->p.family; |
9fd92e3c AS |
391 | } |
392 | ||
393 | /* | |
394 | * rib_dest_table | |
395 | */ | |
d62a17ae | 396 | static inline struct route_table *rib_dest_table(rib_dest_t *dest) |
9fd92e3c | 397 | { |
d62a17ae | 398 | return srcdest_rnode_table(dest->rnode); |
9fd92e3c AS |
399 | } |
400 | ||
1b5ed1b0 AS |
401 | /* |
402 | * rib_dest_vrf | |
403 | */ | |
d62a17ae | 404 | static inline struct zebra_vrf *rib_dest_vrf(rib_dest_t *dest) |
1b5ed1b0 | 405 | { |
d62a17ae | 406 | return rib_table_info(rib_dest_table(dest))->zvrf; |
1b5ed1b0 AS |
407 | } |
408 | ||
0915bb0c AS |
409 | /* |
410 | * rib_tables_iter_init | |
411 | */ | |
d62a17ae | 412 | static inline void rib_tables_iter_init(rib_tables_iter_t *iter) |
0915bb0c AS |
413 | |
414 | { | |
d62a17ae | 415 | memset(iter, 0, sizeof(*iter)); |
416 | iter->state = RIB_TABLES_ITER_S_INIT; | |
0915bb0c AS |
417 | } |
418 | ||
419 | /* | |
420 | * rib_tables_iter_started | |
421 | * | |
422 | * Returns TRUE if this iterator has started iterating over the set of | |
423 | * tables. | |
424 | */ | |
d62a17ae | 425 | static inline int rib_tables_iter_started(rib_tables_iter_t *iter) |
0915bb0c | 426 | { |
d62a17ae | 427 | return iter->state != RIB_TABLES_ITER_S_INIT; |
0915bb0c AS |
428 | } |
429 | ||
430 | /* | |
431 | * rib_tables_iter_cleanup | |
432 | */ | |
d62a17ae | 433 | static inline void rib_tables_iter_cleanup(rib_tables_iter_t *iter) |
0915bb0c | 434 | { |
d62a17ae | 435 | iter->state = RIB_TABLES_ITER_S_DONE; |
0915bb0c AS |
436 | } |
437 | ||
d62a17ae | 438 | DECLARE_HOOK(rib_update, (struct route_node * rn, const char *reason), |
439 | (rn, reason)) | |
4f8ea50c | 440 | |
05f7f5db DS |
441 | |
442 | extern void zebra_vty_init(void); | |
37728041 DS |
443 | extern int static_config(struct vty *vty, struct zebra_vrf *zvrf, |
444 | afi_t afi, safi_t safi, const char *cmd); | |
05f7f5db DS |
445 | extern pid_t pid; |
446 | ||
718e3744 | 447 | #endif /*_ZEBRA_RIB_H */ |