]>
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 | ||
48 | /* Refrence count. */ | |
49 | unsigned long refcnt; | |
50 | ||
51 | /* Tag */ | |
52 | route_tag_t tag; | |
53 | ||
54 | /* Uptime. */ | |
55 | time_t uptime; | |
56 | ||
57 | /* Type fo this route. */ | |
58 | int type; | |
59 | ||
60 | /* Source protocol instance */ | |
61 | u_short instance; | |
62 | ||
63 | /* VRF identifier. */ | |
64 | vrf_id_t vrf_id; | |
65 | ||
66 | /* Which routing table */ | |
67 | uint32_t table; | |
68 | ||
69 | /* Metric */ | |
70 | u_int32_t metric; | |
71 | ||
72 | /* MTU */ | |
73 | u_int32_t mtu; | |
74 | u_int32_t nexthop_mtu; | |
75 | ||
76 | /* Distance. */ | |
77 | u_char distance; | |
78 | ||
79 | /* Flags of this route. | |
80 | * This flag's definition is in lib/zebra.h ZEBRA_FLAG_* and is exposed | |
81 | * to clients via Zserv | |
82 | */ | |
83 | u_int32_t flags; | |
84 | ||
85 | /* RIB internal status */ | |
86 | u_char status; | |
f0f77c9a | 87 | #define ROUTE_ENTRY_REMOVED 0x1 |
d62a17ae | 88 | /* to simplify NHT logic when NHs change, instead of doing a NH by NH cmp */ |
f0f77c9a DS |
89 | #define ROUTE_ENTRY_NEXTHOPS_CHANGED 0x2 |
90 | #define ROUTE_ENTRY_CHANGED 0x4 | |
91 | #define ROUTE_ENTRY_SELECTED_FIB 0x8 | |
332ad713 | 92 | #define ROUTE_ENTRY_LABELS_CHANGED 0x10 |
6d691129 | 93 | |
d62a17ae | 94 | /* Nexthop information. */ |
95 | u_char nexthop_num; | |
96 | u_char nexthop_active_num; | |
718e3744 | 97 | }; |
98 | ||
e96f9203 DO |
99 | /* meta-queue structure: |
100 | * sub-queue 0: connected, kernel | |
101 | * sub-queue 1: static | |
43cf4ba4 | 102 | * sub-queue 2: RIP, RIPng, OSPF, OSPF6, IS-IS, EIGRP, NHRP |
e96f9203 DO |
103 | * sub-queue 3: iBGP, eBGP |
104 | * sub-queue 4: any other origin (if any) | |
105 | */ | |
106 | #define MQ_SIZE 5 | |
d62a17ae | 107 | struct meta_queue { |
108 | struct list *subq[MQ_SIZE]; | |
109 | u_int32_t size; /* sum of lengths of all subqueues */ | |
e96f9203 DO |
110 | }; |
111 | ||
9fd92e3c AS |
112 | /* |
113 | * Structure that represents a single destination (prefix). | |
114 | */ | |
d62a17ae | 115 | typedef struct rib_dest_t_ { |
9fd92e3c | 116 | |
d62a17ae | 117 | /* |
118 | * Back pointer to the route node for this destination. This helps | |
119 | * us get to the prefix that this structure is for. | |
120 | */ | |
121 | struct route_node *rnode; | |
9fd92e3c | 122 | |
d62a17ae | 123 | /* |
124 | * Doubly-linked list of routes for this prefix. | |
125 | */ | |
126 | struct route_entry *routes; | |
9fd92e3c | 127 | |
d62a17ae | 128 | /* |
129 | * Flags, see below. | |
130 | */ | |
131 | u_int32_t flags; | |
9fd92e3c | 132 | |
d62a17ae | 133 | /* |
134 | * Linkage to put dest on the FPM processing queue. | |
135 | */ | |
136 | TAILQ_ENTRY(rib_dest_t_) fpm_q_entries; | |
5adc2528 | 137 | |
9fd92e3c AS |
138 | } rib_dest_t; |
139 | ||
140 | #define RIB_ROUTE_QUEUED(x) (1 << (x)) | |
141 | ||
142 | /* | |
143 | * The maximum qindex that can be used. | |
144 | */ | |
145 | #define ZEBRA_MAX_QINDEX (MQ_SIZE - 1) | |
146 | ||
5adc2528 AS |
147 | /* |
148 | * This flag indicates that a given prefix has been 'advertised' to | |
149 | * the FPM to be installed in the forwarding plane. | |
150 | */ | |
151 | #define RIB_DEST_SENT_TO_FPM (1 << (ZEBRA_MAX_QINDEX + 1)) | |
152 | ||
153 | /* | |
154 | * This flag is set when we need to send an update to the FPM about a | |
155 | * dest. | |
156 | */ | |
157 | #define RIB_DEST_UPDATE_FPM (1 << (ZEBRA_MAX_QINDEX + 2)) | |
158 | ||
9fd92e3c AS |
159 | /* |
160 | * Macro to iterate over each route for a destination (prefix). | |
161 | */ | |
d62a17ae | 162 | #define RE_DEST_FOREACH_ROUTE(dest, re) \ |
163 | for ((re) = (dest) ? (dest)->routes : NULL; (re); (re) = (re)->next) | |
9fd92e3c AS |
164 | |
165 | /* | |
166 | * Same as above, but allows the current node to be unlinked. | |
167 | */ | |
d62a17ae | 168 | #define RE_DEST_FOREACH_ROUTE_SAFE(dest, re, next) \ |
169 | for ((re) = (dest) ? (dest)->routes : NULL; \ | |
170 | (re) && ((next) = (re)->next, 1); (re) = (next)) | |
9fd92e3c | 171 | |
d62a17ae | 172 | #define RNODE_FOREACH_RE(rn, re) \ |
173 | RE_DEST_FOREACH_ROUTE(rib_dest_from_rnode(rn), re) | |
9fd92e3c | 174 | |
d62a17ae | 175 | #define RNODE_FOREACH_RE_SAFE(rn, re, next) \ |
176 | RE_DEST_FOREACH_ROUTE_SAFE(rib_dest_from_rnode(rn), re, next) | |
9fd92e3c | 177 | |
d62a17ae | 178 | #if defined(HAVE_RTADV) |
cd80d74f | 179 | /* Structure which hold status of router advertisement. */ |
d62a17ae | 180 | struct rtadv { |
181 | int sock; | |
cd80d74f | 182 | |
d62a17ae | 183 | int adv_if_count; |
184 | int adv_msec_if_count; | |
cd80d74f | 185 | |
d62a17ae | 186 | struct thread *ra_read; |
187 | struct thread *ra_timer; | |
cd80d74f | 188 | }; |
8da4e946 | 189 | #endif /* HAVE_RTADV */ |
cd80d74f | 190 | |
1b5ed1b0 AS |
191 | /* |
192 | * rib_table_info_t | |
193 | * | |
194 | * Structure that is hung off of a route_table that holds information about | |
195 | * the table. | |
196 | */ | |
d62a17ae | 197 | typedef struct rib_table_info_t_ { |
1b5ed1b0 | 198 | |
d62a17ae | 199 | /* |
200 | * Back pointer to zebra_vrf. | |
201 | */ | |
202 | struct zebra_vrf *zvrf; | |
203 | afi_t afi; | |
204 | safi_t safi; | |
1b5ed1b0 AS |
205 | |
206 | } rib_table_info_t; | |
207 | ||
d62a17ae | 208 | typedef enum { |
209 | RIB_TABLES_ITER_S_INIT, | |
210 | RIB_TABLES_ITER_S_ITERATING, | |
211 | RIB_TABLES_ITER_S_DONE | |
0915bb0c AS |
212 | } rib_tables_iter_state_t; |
213 | ||
214 | /* | |
215 | * Structure that holds state for iterating over all tables in the | |
216 | * Routing Information Base. | |
217 | */ | |
d62a17ae | 218 | typedef struct rib_tables_iter_t_ { |
219 | vrf_id_t vrf_id; | |
220 | int afi_safi_ix; | |
0915bb0c | 221 | |
d62a17ae | 222 | rib_tables_iter_state_t state; |
0915bb0c AS |
223 | } rib_tables_iter_t; |
224 | ||
1c848137 | 225 | /* Events/reasons triggering a RIB update. */ |
d62a17ae | 226 | typedef enum { |
227 | RIB_UPDATE_IF_CHANGE, | |
228 | RIB_UPDATE_RMAP_CHANGE, | |
229 | RIB_UPDATE_OTHER | |
1c848137 | 230 | } rib_update_event_t; |
231 | ||
d62a17ae | 232 | extern struct nexthop *route_entry_nexthop_ifindex_add(struct route_entry *, |
233 | ifindex_t); | |
234 | extern struct nexthop *route_entry_nexthop_blackhole_add(struct route_entry *); | |
235 | extern struct nexthop *route_entry_nexthop_ipv4_add(struct route_entry *, | |
236 | struct in_addr *, | |
237 | struct in_addr *); | |
238 | extern struct nexthop * | |
239 | route_entry_nexthop_ipv4_ifindex_add(struct route_entry *, struct in_addr *, | |
240 | struct in_addr *, ifindex_t); | |
241 | extern void route_entry_nexthop_delete(struct route_entry *re, | |
242 | struct nexthop *nexthop); | |
243 | extern struct nexthop *route_entry_nexthop_ipv6_add(struct route_entry *, | |
244 | struct in6_addr *); | |
245 | extern struct nexthop * | |
246 | route_entry_nexthop_ipv6_ifindex_add(struct route_entry *re, | |
247 | struct in6_addr *ipv6, ifindex_t ifindex); | |
248 | extern void route_entry_nexthop_add(struct route_entry *re, | |
249 | struct nexthop *nexthop); | |
250 | extern void route_entry_copy_nexthops(struct route_entry *re, | |
251 | struct nexthop *nh); | |
f0f77c9a DS |
252 | |
253 | #define route_entry_dump(prefix, src, re) _route_entry_dump(__func__, prefix, src, re) | |
d62a17ae | 254 | extern void _route_entry_dump(const char *, union prefixconstptr, |
255 | union prefixconstptr, const struct route_entry *); | |
4623d897 | 256 | /* RPF lookup behaviour */ |
d62a17ae | 257 | enum multicast_mode { |
258 | MCAST_NO_CONFIG = 0, /* MIX_MRIB_FIRST, but no show in config write */ | |
259 | MCAST_MRIB_ONLY, /* MRIB only */ | |
260 | MCAST_URIB_ONLY, /* URIB only */ | |
261 | MCAST_MIX_MRIB_FIRST, /* MRIB, if nothing at all then URIB */ | |
262 | MCAST_MIX_DISTANCE, /* MRIB & URIB, lower distance wins */ | |
263 | MCAST_MIX_PFXLEN, /* MRIB & URIB, longer prefix wins */ | |
264 | /* on equal value, MRIB wins for last 2 */ | |
4623d897 DL |
265 | }; |
266 | ||
d62a17ae | 267 | extern void multicast_mode_ipv4_set(enum multicast_mode mode); |
268 | extern enum multicast_mode multicast_mode_ipv4_get(void); | |
4623d897 | 269 | |
d62a17ae | 270 | extern void rib_lookup_and_dump(struct prefix_ipv4 *, vrf_id_t); |
271 | extern void rib_lookup_and_pushup(struct prefix_ipv4 *, vrf_id_t); | |
f0f77c9a | 272 | |
d62a17ae | 273 | extern int rib_lookup_ipv4_route(struct prefix_ipv4 *, union sockunion *, |
274 | vrf_id_t); | |
dc95824a DO |
275 | #define ZEBRA_RIB_LOOKUP_ERROR -1 |
276 | #define ZEBRA_RIB_FOUND_EXACT 0 | |
277 | #define ZEBRA_RIB_FOUND_NOGATE 1 | |
278 | #define ZEBRA_RIB_FOUND_CONNECTED 2 | |
279 | #define ZEBRA_RIB_NOTFOUND 3 | |
280 | ||
7a4bb9c5 DS |
281 | extern int is_zebra_valid_kernel_table(u_int32_t table_id); |
282 | extern int is_zebra_main_routing_table(u_int32_t table_id); | |
d62a17ae | 283 | extern int zebra_check_addr(struct prefix *p); |
718e3744 | 284 | |
d62a17ae | 285 | extern void rib_addnode(struct route_node *rn, struct route_entry *re, |
286 | int process); | |
287 | extern void rib_delnode(struct route_node *rn, struct route_entry *re); | |
288 | extern int rib_install_kernel(struct route_node *rn, struct route_entry *re, | |
289 | struct route_entry *old); | |
290 | extern int rib_uninstall_kernel(struct route_node *rn, struct route_entry *re); | |
28f6dde8 | 291 | |
d24af186 | 292 | /* NOTE: |
b4c034b0 | 293 | * All rib_add function will not just add prefix into RIB, but |
d24af186 | 294 | * also implicitly withdraw equal prefix of same type. */ |
d62a17ae | 295 | extern int rib_add(afi_t afi, safi_t safi, vrf_id_t vrf_id, int type, |
296 | u_short instance, int flags, struct prefix *p, | |
fd36be7e DL |
297 | struct prefix_ipv6 *src_p, const struct nexthop *nh, |
298 | u_int32_t table_id, u_int32_t metric, u_int32_t mtu, | |
299 | u_char distance); | |
d62a17ae | 300 | |
301 | extern int rib_add_multipath(afi_t afi, safi_t safi, struct prefix *, | |
302 | struct prefix_ipv6 *src_p, struct route_entry *); | |
303 | ||
304 | extern void rib_delete(afi_t afi, safi_t safi, vrf_id_t vrf_id, int type, | |
305 | u_short instance, int flags, struct prefix *p, | |
fd36be7e DL |
306 | struct prefix_ipv6 *src_p, const struct nexthop *nh, |
307 | u_int32_t table_id, u_int32_t metric); | |
d62a17ae | 308 | |
309 | extern struct route_entry *rib_match(afi_t afi, safi_t safi, vrf_id_t, | |
310 | union g_addr *, | |
311 | struct route_node **rn_out); | |
312 | extern struct route_entry *rib_match_ipv4_multicast(vrf_id_t vrf_id, | |
313 | struct in_addr addr, | |
314 | struct route_node **rn_out); | |
315 | ||
316 | extern struct route_entry *rib_lookup_ipv4(struct prefix_ipv4 *, vrf_id_t); | |
317 | ||
318 | extern void rib_update(vrf_id_t, rib_update_event_t); | |
319 | extern void rib_weed_tables(void); | |
320 | extern void rib_sweep_route(void); | |
321 | extern void rib_close_table(struct route_table *); | |
322 | extern void rib_init(void); | |
323 | extern unsigned long rib_score_proto(u_char proto, u_short instance); | |
324 | extern void rib_queue_add(struct route_node *rn); | |
325 | extern void meta_queue_free(struct meta_queue *mq); | |
326 | extern int zebra_rib_labeled_unicast(struct route_entry *re); | |
718e3744 | 327 | extern struct route_table *rib_table_ipv6; |
328 | ||
d62a17ae | 329 | extern void rib_unlink(struct route_node *, struct route_entry *); |
330 | extern int rib_gc_dest(struct route_node *rn); | |
331 | extern struct route_table *rib_tables_iter_next(rib_tables_iter_t *iter); | |
9fd92e3c | 332 | |
40c7bdb0 | 333 | extern u_char route_distance(int type); |
334 | ||
9fd92e3c AS |
335 | /* |
336 | * Inline functions. | |
337 | */ | |
338 | ||
1b5ed1b0 AS |
339 | /* |
340 | * rib_table_info | |
341 | */ | |
d62a17ae | 342 | static inline rib_table_info_t *rib_table_info(struct route_table *table) |
1b5ed1b0 | 343 | { |
d62a17ae | 344 | return (rib_table_info_t *)table->info; |
1b5ed1b0 AS |
345 | } |
346 | ||
9fd92e3c AS |
347 | /* |
348 | * rib_dest_from_rnode | |
349 | */ | |
d62a17ae | 350 | static inline rib_dest_t *rib_dest_from_rnode(struct route_node *rn) |
9fd92e3c | 351 | { |
d62a17ae | 352 | return (rib_dest_t *)rn->info; |
9fd92e3c AS |
353 | } |
354 | ||
355 | /* | |
356 | * rnode_to_ribs | |
357 | * | |
358 | * Returns a pointer to the list of routes corresponding to the given | |
359 | * route_node. | |
360 | */ | |
d62a17ae | 361 | static inline struct route_entry *rnode_to_ribs(struct route_node *rn) |
9fd92e3c | 362 | { |
d62a17ae | 363 | rib_dest_t *dest; |
9fd92e3c | 364 | |
d62a17ae | 365 | dest = rib_dest_from_rnode(rn); |
366 | if (!dest) | |
367 | return NULL; | |
9fd92e3c | 368 | |
d62a17ae | 369 | return dest->routes; |
9fd92e3c AS |
370 | } |
371 | ||
372 | /* | |
373 | * rib_dest_prefix | |
374 | */ | |
d62a17ae | 375 | static inline struct prefix *rib_dest_prefix(rib_dest_t *dest) |
9fd92e3c | 376 | { |
d62a17ae | 377 | return &dest->rnode->p; |
9fd92e3c AS |
378 | } |
379 | ||
380 | /* | |
381 | * rib_dest_af | |
382 | * | |
383 | * Returns the address family that the destination is for. | |
384 | */ | |
d62a17ae | 385 | static inline u_char rib_dest_af(rib_dest_t *dest) |
9fd92e3c | 386 | { |
d62a17ae | 387 | return dest->rnode->p.family; |
9fd92e3c AS |
388 | } |
389 | ||
390 | /* | |
391 | * rib_dest_table | |
392 | */ | |
d62a17ae | 393 | static inline struct route_table *rib_dest_table(rib_dest_t *dest) |
9fd92e3c | 394 | { |
d62a17ae | 395 | return srcdest_rnode_table(dest->rnode); |
9fd92e3c AS |
396 | } |
397 | ||
1b5ed1b0 AS |
398 | /* |
399 | * rib_dest_vrf | |
400 | */ | |
d62a17ae | 401 | static inline struct zebra_vrf *rib_dest_vrf(rib_dest_t *dest) |
1b5ed1b0 | 402 | { |
d62a17ae | 403 | return rib_table_info(rib_dest_table(dest))->zvrf; |
1b5ed1b0 AS |
404 | } |
405 | ||
0915bb0c AS |
406 | /* |
407 | * rib_tables_iter_init | |
408 | */ | |
d62a17ae | 409 | static inline void rib_tables_iter_init(rib_tables_iter_t *iter) |
0915bb0c AS |
410 | |
411 | { | |
d62a17ae | 412 | memset(iter, 0, sizeof(*iter)); |
413 | iter->state = RIB_TABLES_ITER_S_INIT; | |
0915bb0c AS |
414 | } |
415 | ||
416 | /* | |
417 | * rib_tables_iter_started | |
418 | * | |
419 | * Returns TRUE if this iterator has started iterating over the set of | |
420 | * tables. | |
421 | */ | |
d62a17ae | 422 | static inline int rib_tables_iter_started(rib_tables_iter_t *iter) |
0915bb0c | 423 | { |
d62a17ae | 424 | return iter->state != RIB_TABLES_ITER_S_INIT; |
0915bb0c AS |
425 | } |
426 | ||
427 | /* | |
428 | * rib_tables_iter_cleanup | |
429 | */ | |
d62a17ae | 430 | static inline void rib_tables_iter_cleanup(rib_tables_iter_t *iter) |
0915bb0c | 431 | { |
d62a17ae | 432 | iter->state = RIB_TABLES_ITER_S_DONE; |
0915bb0c AS |
433 | } |
434 | ||
d62a17ae | 435 | DECLARE_HOOK(rib_update, (struct route_node * rn, const char *reason), |
436 | (rn, reason)) | |
4f8ea50c | 437 | |
718e3744 | 438 | #endif /*_ZEBRA_RIB_H */ |