2 * Routing Information Base header
3 * Copyright (C) 1997 Kunihiro Ishiguro
5 * This file is part of GNU Zebra.
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
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.
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
32 #include "nexthop_group.h"
36 #include "srcdest_table.h"
38 #define DISTANCE_INFINITY 255
39 #define ZEBRA_KERNEL_TABLE_MAX 252 /* support for no more than this rt tables */
43 struct route_entry
*next
;
44 struct route_entry
*prev
;
46 /* Nexthop structure */
47 struct nexthop_group ng
;
55 /* Type fo this route. */
58 /* Source protocol instance */
59 unsigned short instance
;
64 /* Which routing table */
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
83 /* RIB internal status */
85 #define ROUTE_ENTRY_REMOVED 0x1
86 /* to simplify NHT logic when NHs change, instead of doing a NH by NH cmp */
87 #define ROUTE_ENTRY_NEXTHOPS_CHANGED 0x2
88 #define ROUTE_ENTRY_CHANGED 0x4
89 #define ROUTE_ENTRY_LABELS_CHANGED 0x8
91 /* Nexthop information. */
93 uint8_t nexthop_active_num
;
95 /* Sequence value incremented for each dataplane operation */
96 uint32_t dplane_sequence
;
99 /* meta-queue structure:
100 * sub-queue 0: connected, kernel
101 * sub-queue 1: static
102 * sub-queue 2: RIP, RIPng, OSPF, OSPF6, IS-IS, EIGRP, NHRP
103 * sub-queue 3: iBGP, eBGP
104 * sub-queue 4: any other origin (if any)
108 struct list
*subq
[MQ_SIZE
];
109 uint32_t size
; /* sum of lengths of all subqueues */
113 * Structure that represents a single destination (prefix).
115 typedef struct rib_dest_t_
{
118 * Back pointer to the route node for this destination. This helps
119 * us get to the prefix that this structure is for.
121 struct route_node
*rnode
;
124 * Doubly-linked list of routes for this prefix.
126 struct route_entry
*routes
;
128 struct route_entry
*selected_fib
;
136 * Linkage to put dest on the FPM processing queue.
138 TAILQ_ENTRY(rib_dest_t_
) fpm_q_entries
;
142 #define RIB_ROUTE_QUEUED(x) (1 << (x))
143 // If MQ_SIZE is modified this value needs to be updated.
144 #define RIB_ROUTE_ANY_QUEUED 0x1F
147 * The maximum qindex that can be used.
149 #define ZEBRA_MAX_QINDEX (MQ_SIZE - 1)
152 * This flag indicates that a given prefix has been 'advertised' to
153 * the FPM to be installed in the forwarding plane.
155 #define RIB_DEST_SENT_TO_FPM (1 << (ZEBRA_MAX_QINDEX + 1))
158 * This flag is set when we need to send an update to the FPM about a
161 #define RIB_DEST_UPDATE_FPM (1 << (ZEBRA_MAX_QINDEX + 2))
164 * Macro to iterate over each route for a destination (prefix).
166 #define RE_DEST_FOREACH_ROUTE(dest, re) \
167 for ((re) = (dest) ? (dest)->routes : NULL; (re); (re) = (re)->next)
170 * Same as above, but allows the current node to be unlinked.
172 #define RE_DEST_FOREACH_ROUTE_SAFE(dest, re, next) \
173 for ((re) = (dest) ? (dest)->routes : NULL; \
174 (re) && ((next) = (re)->next, 1); (re) = (next))
176 #define RNODE_FOREACH_RE(rn, re) \
177 RE_DEST_FOREACH_ROUTE (rib_dest_from_rnode(rn), re)
179 #define RNODE_FOREACH_RE_SAFE(rn, re, next) \
180 RE_DEST_FOREACH_ROUTE_SAFE (rib_dest_from_rnode(rn), re, next)
182 #if defined(HAVE_RTADV)
183 /* Structure which hold status of router advertisement. */
188 int adv_msec_if_count
;
190 struct thread
*ra_read
;
191 struct thread
*ra_timer
;
193 #endif /* HAVE_RTADV */
198 * Structure that is hung off of a route_table that holds information about
201 typedef struct rib_table_info_t_
{
204 * Back pointer to zebra_vrf.
206 struct zebra_vrf
*zvrf
;
213 RIB_TABLES_ITER_S_INIT
,
214 RIB_TABLES_ITER_S_ITERATING
,
215 RIB_TABLES_ITER_S_DONE
216 } rib_tables_iter_state_t
;
219 * Structure that holds state for iterating over all tables in the
220 * Routing Information Base.
222 typedef struct rib_tables_iter_t_
{
226 rib_tables_iter_state_t state
;
229 /* Events/reasons triggering a RIB update. */
231 RIB_UPDATE_IF_CHANGE
,
232 RIB_UPDATE_RMAP_CHANGE
,
234 } rib_update_event_t
;
236 extern struct nexthop
*route_entry_nexthop_ifindex_add(struct route_entry
*re
,
239 extern struct nexthop
*
240 route_entry_nexthop_blackhole_add(struct route_entry
*re
,
241 enum blackhole_type bh_type
);
242 extern struct nexthop
*route_entry_nexthop_ipv4_add(struct route_entry
*re
,
243 struct in_addr
*ipv4
,
246 extern struct nexthop
*
247 route_entry_nexthop_ipv4_ifindex_add(struct route_entry
*re
,
248 struct in_addr
*ipv4
, struct in_addr
*src
,
249 ifindex_t ifindex
, vrf_id_t nh_vrf_id
);
250 extern void route_entry_nexthop_delete(struct route_entry
*re
,
251 struct nexthop
*nexthop
);
252 extern struct nexthop
*route_entry_nexthop_ipv6_add(struct route_entry
*re
,
253 struct in6_addr
*ipv6
,
255 extern struct nexthop
*
256 route_entry_nexthop_ipv6_ifindex_add(struct route_entry
*re
,
257 struct in6_addr
*ipv6
, ifindex_t ifindex
,
259 extern void route_entry_nexthop_add(struct route_entry
*re
,
260 struct nexthop
*nexthop
);
261 extern void route_entry_copy_nexthops(struct route_entry
*re
,
264 #define route_entry_dump(prefix, src, re) _route_entry_dump(__func__, prefix, src, re)
265 extern void _route_entry_dump(const char *func
, union prefixconstptr pp
,
266 union prefixconstptr src_pp
,
267 const struct route_entry
*re
);
268 /* RPF lookup behaviour */
269 enum multicast_mode
{
270 MCAST_NO_CONFIG
= 0, /* MIX_MRIB_FIRST, but no show in config write */
271 MCAST_MRIB_ONLY
, /* MRIB only */
272 MCAST_URIB_ONLY
, /* URIB only */
273 MCAST_MIX_MRIB_FIRST
, /* MRIB, if nothing at all then URIB */
274 MCAST_MIX_DISTANCE
, /* MRIB & URIB, lower distance wins */
275 MCAST_MIX_PFXLEN
, /* MRIB & URIB, longer prefix wins */
276 /* on equal value, MRIB wins for last 2 */
279 extern void multicast_mode_ipv4_set(enum multicast_mode mode
);
280 extern enum multicast_mode
multicast_mode_ipv4_get(void);
282 extern void rib_lookup_and_dump(struct prefix_ipv4
*p
, vrf_id_t vrf_id
);
283 extern void rib_lookup_and_pushup(struct prefix_ipv4
*p
, vrf_id_t vrf_id
);
285 extern int rib_lookup_ipv4_route(struct prefix_ipv4
*p
, union sockunion
*qgate
,
287 #define ZEBRA_RIB_LOOKUP_ERROR -1
288 #define ZEBRA_RIB_FOUND_EXACT 0
289 #define ZEBRA_RIB_FOUND_NOGATE 1
290 #define ZEBRA_RIB_FOUND_CONNECTED 2
291 #define ZEBRA_RIB_NOTFOUND 3
293 extern int is_zebra_valid_kernel_table(uint32_t table_id
);
294 extern int is_zebra_main_routing_table(uint32_t table_id
);
295 extern int zebra_check_addr(const struct prefix
*p
);
297 extern void rib_delnode(struct route_node
*rn
, struct route_entry
*re
);
298 extern void rib_install_kernel(struct route_node
*rn
, struct route_entry
*re
,
299 struct route_entry
*old
);
300 extern void rib_uninstall_kernel(struct route_node
*rn
, struct route_entry
*re
);
303 * All rib_add function will not just add prefix into RIB, but
304 * also implicitly withdraw equal prefix of same type. */
305 extern int rib_add(afi_t afi
, safi_t safi
, vrf_id_t vrf_id
, int type
,
306 unsigned short instance
, int flags
, struct prefix
*p
,
307 struct prefix_ipv6
*src_p
, const struct nexthop
*nh
,
308 uint32_t table_id
, uint32_t metric
, uint32_t mtu
,
309 uint8_t distance
, route_tag_t tag
);
311 extern int rib_add_multipath(afi_t afi
, safi_t safi
, struct prefix
*p
,
312 struct prefix_ipv6
*src_p
, struct route_entry
*re
);
314 extern void rib_delete(afi_t afi
, safi_t safi
, vrf_id_t vrf_id
, int type
,
315 unsigned short instance
, int flags
, struct prefix
*p
,
316 struct prefix_ipv6
*src_p
, const struct nexthop
*nh
,
317 uint32_t table_id
, uint32_t metric
, uint8_t distance
,
320 extern struct route_entry
*rib_match(afi_t afi
, safi_t safi
, vrf_id_t vrf_id
,
322 struct route_node
**rn_out
);
323 extern struct route_entry
*rib_match_ipv4_multicast(vrf_id_t vrf_id
,
325 struct route_node
**rn_out
);
327 extern struct route_entry
*rib_lookup_ipv4(struct prefix_ipv4
*p
,
330 extern void rib_update(vrf_id_t vrf_id
, rib_update_event_t event
);
331 extern void rib_update_table(struct route_table
*table
,
332 rib_update_event_t event
);
333 extern void rib_sweep_route(void);
334 extern void rib_sweep_table(struct route_table
*table
);
335 extern void rib_close_table(struct route_table
*table
);
336 extern void rib_init(void);
337 extern unsigned long rib_score_proto(uint8_t proto
, unsigned short instance
);
338 extern unsigned long rib_score_proto_table(uint8_t proto
,
339 unsigned short instance
,
340 struct route_table
*table
);
341 extern void rib_queue_add(struct route_node
*rn
);
342 extern void meta_queue_free(struct meta_queue
*mq
);
343 extern int zebra_rib_labeled_unicast(struct route_entry
*re
);
344 extern struct route_table
*rib_table_ipv6
;
346 extern void rib_unlink(struct route_node
*rn
, struct route_entry
*re
);
347 extern int rib_gc_dest(struct route_node
*rn
);
348 extern struct route_table
*rib_tables_iter_next(rib_tables_iter_t
*iter
);
350 extern uint8_t route_distance(int type
);
359 static inline rib_table_info_t
*rib_table_info(struct route_table
*table
)
361 return (rib_table_info_t
*)route_table_get_info(table
);
365 * rib_dest_from_rnode
367 static inline rib_dest_t
*rib_dest_from_rnode(struct route_node
*rn
)
369 return (rib_dest_t
*)rn
->info
;
375 * Returns a pointer to the list of routes corresponding to the given
378 static inline struct route_entry
*rnode_to_ribs(struct route_node
*rn
)
382 dest
= rib_dest_from_rnode(rn
);
392 static inline struct prefix
*rib_dest_prefix(rib_dest_t
*dest
)
394 return &dest
->rnode
->p
;
400 * Returns the address family that the destination is for.
402 static inline uint8_t rib_dest_af(rib_dest_t
*dest
)
404 return dest
->rnode
->p
.family
;
410 static inline struct route_table
*rib_dest_table(rib_dest_t
*dest
)
412 return srcdest_rnode_table(dest
->rnode
);
418 static inline struct zebra_vrf
*rib_dest_vrf(rib_dest_t
*dest
)
420 return rib_table_info(rib_dest_table(dest
))->zvrf
;
424 * rib_tables_iter_init
426 static inline void rib_tables_iter_init(rib_tables_iter_t
*iter
)
429 memset(iter
, 0, sizeof(*iter
));
430 iter
->state
= RIB_TABLES_ITER_S_INIT
;
434 * rib_tables_iter_started
436 * Returns TRUE if this iterator has started iterating over the set of
439 static inline int rib_tables_iter_started(rib_tables_iter_t
*iter
)
441 return iter
->state
!= RIB_TABLES_ITER_S_INIT
;
445 * rib_tables_iter_cleanup
447 static inline void rib_tables_iter_cleanup(rib_tables_iter_t
*iter
)
449 iter
->state
= RIB_TABLES_ITER_S_DONE
;
452 DECLARE_HOOK(rib_update
, (struct route_node
* rn
, const char *reason
),
456 extern void zebra_vty_init(void);
460 extern bool v6_rr_semantics
;
461 #endif /*_ZEBRA_RIB_H */