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
;
96 /* meta-queue structure:
97 * sub-queue 0: connected, kernel
99 * sub-queue 2: RIP, RIPng, OSPF, OSPF6, IS-IS, EIGRP, NHRP
100 * sub-queue 3: iBGP, eBGP
101 * sub-queue 4: any other origin (if any)
105 struct list
*subq
[MQ_SIZE
];
106 uint32_t size
; /* sum of lengths of all subqueues */
110 * Structure that represents a single destination (prefix).
112 typedef struct rib_dest_t_
{
115 * Back pointer to the route node for this destination. This helps
116 * us get to the prefix that this structure is for.
118 struct route_node
*rnode
;
121 * Doubly-linked list of routes for this prefix.
123 struct route_entry
*routes
;
125 struct route_entry
*selected_fib
;
133 * Linkage to put dest on the FPM processing queue.
135 TAILQ_ENTRY(rib_dest_t_
) fpm_q_entries
;
139 #define RIB_ROUTE_QUEUED(x) (1 << (x))
140 // If MQ_SIZE is modified this value needs to be updated.
141 #define RIB_ROUTE_ANY_QUEUED 0x1F
144 * The maximum qindex that can be used.
146 #define ZEBRA_MAX_QINDEX (MQ_SIZE - 1)
149 * This flag indicates that a given prefix has been 'advertised' to
150 * the FPM to be installed in the forwarding plane.
152 #define RIB_DEST_SENT_TO_FPM (1 << (ZEBRA_MAX_QINDEX + 1))
155 * This flag is set when we need to send an update to the FPM about a
158 #define RIB_DEST_UPDATE_FPM (1 << (ZEBRA_MAX_QINDEX + 2))
161 * Macro to iterate over each route for a destination (prefix).
163 #define RE_DEST_FOREACH_ROUTE(dest, re) \
164 for ((re) = (dest) ? (dest)->routes : NULL; (re); (re) = (re)->next)
167 * Same as above, but allows the current node to be unlinked.
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))
173 #define RNODE_FOREACH_RE(rn, re) \
174 RE_DEST_FOREACH_ROUTE (rib_dest_from_rnode(rn), re)
176 #define RNODE_FOREACH_RE_SAFE(rn, re, next) \
177 RE_DEST_FOREACH_ROUTE_SAFE (rib_dest_from_rnode(rn), re, next)
179 #if defined(HAVE_RTADV)
180 /* Structure which hold status of router advertisement. */
185 int adv_msec_if_count
;
187 struct thread
*ra_read
;
188 struct thread
*ra_timer
;
190 #endif /* HAVE_RTADV */
195 * Structure that is hung off of a route_table that holds information about
198 typedef struct rib_table_info_t_
{
201 * Back pointer to zebra_vrf.
203 struct zebra_vrf
*zvrf
;
210 RIB_TABLES_ITER_S_INIT
,
211 RIB_TABLES_ITER_S_ITERATING
,
212 RIB_TABLES_ITER_S_DONE
213 } rib_tables_iter_state_t
;
216 * Structure that holds state for iterating over all tables in the
217 * Routing Information Base.
219 typedef struct rib_tables_iter_t_
{
223 rib_tables_iter_state_t state
;
226 /* Events/reasons triggering a RIB update. */
228 RIB_UPDATE_IF_CHANGE
,
229 RIB_UPDATE_RMAP_CHANGE
,
231 } rib_update_event_t
;
233 extern struct nexthop
*route_entry_nexthop_ifindex_add(struct route_entry
*re
,
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
,
243 extern struct nexthop
*
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
);
247 extern void route_entry_nexthop_delete(struct route_entry
*re
,
248 struct nexthop
*nexthop
);
249 extern struct nexthop
*route_entry_nexthop_ipv6_add(struct route_entry
*re
,
250 struct in6_addr
*ipv6
,
252 extern struct nexthop
*
253 route_entry_nexthop_ipv6_ifindex_add(struct route_entry
*re
,
254 struct in6_addr
*ipv6
, ifindex_t ifindex
,
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
,
261 #define route_entry_dump(prefix, src, re) _route_entry_dump(__func__, prefix, src, re)
262 extern void _route_entry_dump(const char *func
, union prefixconstptr pp
,
263 union prefixconstptr src_pp
,
264 const struct route_entry
*re
);
265 /* RPF lookup behaviour */
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 */
276 extern void multicast_mode_ipv4_set(enum multicast_mode mode
);
277 extern enum multicast_mode
multicast_mode_ipv4_get(void);
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
);
282 extern int rib_lookup_ipv4_route(struct prefix_ipv4
*p
, union sockunion
*qgate
,
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
290 extern int is_zebra_valid_kernel_table(uint32_t table_id
);
291 extern int is_zebra_main_routing_table(uint32_t table_id
);
292 extern int zebra_check_addr(const struct prefix
*p
);
294 extern void rib_delnode(struct route_node
*rn
, struct route_entry
*re
);
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
);
300 * All rib_add function will not just add prefix into RIB, but
301 * also implicitly withdraw equal prefix of same type. */
302 extern int rib_add(afi_t afi
, safi_t safi
, vrf_id_t vrf_id
, int type
,
303 unsigned short instance
, int flags
, struct prefix
*p
,
304 struct prefix_ipv6
*src_p
, const struct nexthop
*nh
,
305 uint32_t table_id
, uint32_t metric
, uint32_t mtu
,
306 uint8_t distance
, route_tag_t tag
);
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
);
311 extern void rib_delete(afi_t afi
, safi_t safi
, vrf_id_t vrf_id
, int type
,
312 unsigned short instance
, int flags
, struct prefix
*p
,
313 struct prefix_ipv6
*src_p
, const struct nexthop
*nh
,
314 uint32_t table_id
, uint32_t metric
, uint8_t distance
,
317 extern struct route_entry
*rib_match(afi_t afi
, safi_t safi
, vrf_id_t vrf_id
,
319 struct route_node
**rn_out
);
320 extern struct route_entry
*rib_match_ipv4_multicast(vrf_id_t vrf_id
,
322 struct route_node
**rn_out
);
324 extern struct route_entry
*rib_lookup_ipv4(struct prefix_ipv4
*p
,
327 extern void rib_update(vrf_id_t vrf_id
, rib_update_event_t event
);
328 extern void rib_update_table(struct route_table
*table
,
329 rib_update_event_t event
);
330 extern void rib_sweep_route(void);
331 extern void rib_sweep_table(struct route_table
*table
);
332 extern void rib_close_table(struct route_table
*table
);
333 extern void rib_init(void);
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
,
337 struct route_table
*table
);
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
);
341 extern struct route_table
*rib_table_ipv6
;
343 extern void rib_unlink(struct route_node
*rn
, struct route_entry
*re
);
344 extern int rib_gc_dest(struct route_node
*rn
);
345 extern struct route_table
*rib_tables_iter_next(rib_tables_iter_t
*iter
);
347 extern uint8_t route_distance(int type
);
356 static inline rib_table_info_t
*rib_table_info(struct route_table
*table
)
358 return (rib_table_info_t
*)table
->info
;
362 * rib_dest_from_rnode
364 static inline rib_dest_t
*rib_dest_from_rnode(struct route_node
*rn
)
366 return (rib_dest_t
*)rn
->info
;
372 * Returns a pointer to the list of routes corresponding to the given
375 static inline struct route_entry
*rnode_to_ribs(struct route_node
*rn
)
379 dest
= rib_dest_from_rnode(rn
);
389 static inline struct prefix
*rib_dest_prefix(rib_dest_t
*dest
)
391 return &dest
->rnode
->p
;
397 * Returns the address family that the destination is for.
399 static inline uint8_t rib_dest_af(rib_dest_t
*dest
)
401 return dest
->rnode
->p
.family
;
407 static inline struct route_table
*rib_dest_table(rib_dest_t
*dest
)
409 return srcdest_rnode_table(dest
->rnode
);
415 static inline struct zebra_vrf
*rib_dest_vrf(rib_dest_t
*dest
)
417 return rib_table_info(rib_dest_table(dest
))->zvrf
;
421 * rib_tables_iter_init
423 static inline void rib_tables_iter_init(rib_tables_iter_t
*iter
)
426 memset(iter
, 0, sizeof(*iter
));
427 iter
->state
= RIB_TABLES_ITER_S_INIT
;
431 * rib_tables_iter_started
433 * Returns TRUE if this iterator has started iterating over the set of
436 static inline int rib_tables_iter_started(rib_tables_iter_t
*iter
)
438 return iter
->state
!= RIB_TABLES_ITER_S_INIT
;
442 * rib_tables_iter_cleanup
444 static inline void rib_tables_iter_cleanup(rib_tables_iter_t
*iter
)
446 iter
->state
= RIB_TABLES_ITER_S_DONE
;
449 DECLARE_HOOK(rib_update
, (struct route_node
* rn
, const char *reason
),
453 extern void zebra_vty_init(void);
457 extern bool v6_rr_semantics
;
458 #endif /*_ZEBRA_RIB_H */