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
34 #include "nexthop_group.h"
38 #include "srcdest_table.h"
39 #include "zebra/zebra_nhg.h"
45 DECLARE_MGROUP(ZEBRA
);
49 enum rnh_type
{ RNH_NEXTHOP_TYPE
, RNH_IMPORT_CHECK_TYPE
};
51 PREDECL_LIST(rnh_list
);
53 /* Nexthop structure. */
57 #define ZEBRA_NHT_CONNECTED 0x1
58 #define ZEBRA_NHT_DELETED 0x2
59 #define ZEBRA_NHT_EXACT_MATCH 0x4
70 struct route_entry
*state
;
71 struct prefix resolved_route
;
72 struct list
*client_list
;
74 /* pseudowires dependent on this nh */
75 struct list
*zebra_pseudowire_list
;
77 struct route_node
*node
;
80 * if this has been filtered for the client
82 int filtered
[ZEBRA_ROUTE_MAX
];
84 struct rnh_list_item rnh_list_item
;
87 #define DISTANCE_INFINITY 255
88 #define ZEBRA_KERNEL_TABLE_MAX 252 /* support for no more than this rt tables */
90 PREDECL_LIST(re_list
);
99 struct re_list_item next
;
101 /* Nexthop group, shared/refcounted, based on the nexthop(s)
102 * provided by the owner of the route
104 struct nhg_hash_entry
*nhe
;
106 /* Nexthop group from FIB (optional), reflecting what is actually
107 * installed in the FIB if that differs. The 'backup' group is used
108 * when backup nexthops are present in the route's nhg.
110 struct nexthop_group fib_ng
;
111 struct nexthop_group fib_backup_ng
;
113 /* Nexthop group hash entry ID */
122 /* Type of this route. */
125 /* VRF identifier. */
128 /* Which routing table */
136 uint32_t nexthop_mtu
;
138 /* Flags of this route.
139 * This flag's definition is in lib/zebra.h ZEBRA_FLAG_* and is exposed
140 * to clients via Zserv
144 /* RIB internal status */
146 #define ROUTE_ENTRY_REMOVED 0x1
147 /* The Route Entry has changed */
148 #define ROUTE_ENTRY_CHANGED 0x2
149 /* The Label has changed on the Route entry */
150 #define ROUTE_ENTRY_LABELS_CHANGED 0x4
151 /* Route is queued for Installation into the Data Plane */
152 #define ROUTE_ENTRY_QUEUED 0x8
153 /* Route is installed into the Data Plane */
154 #define ROUTE_ENTRY_INSTALLED 0x10
155 /* Route has Failed installation into the Data Plane in some manner */
156 #define ROUTE_ENTRY_FAILED 0x20
157 /* Route has a 'fib' set of nexthops, probably because the installed set
158 * differs from the rib/normal set of nexthops.
160 #define ROUTE_ENTRY_USE_FIB_NHG 0x40
162 /* Sequence value incremented for each dataplane operation */
163 uint32_t dplane_sequence
;
165 /* Source protocol instance */
171 struct opaque
*opaque
;
174 #define RIB_SYSTEM_ROUTE(R) RSYSTEM_ROUTE((R)->type)
176 #define RIB_KERNEL_ROUTE(R) RKERNEL_ROUTE((R)->type)
178 /* meta-queue structure:
179 * sub-queue 0: nexthop group objects
180 * sub-queue 1: EVPN/VxLAN objects
181 * sub-queue 2: connected
182 * sub-queue 3: kernel
183 * sub-queue 4: static
184 * sub-queue 5: RIP, RIPng, OSPF, OSPF6, IS-IS, EIGRP, NHRP
185 * sub-queue 6: iBGP, eBGP
186 * sub-queue 7: any other origin (if any) typically those that
187 * don't generate routes
191 struct list
*subq
[MQ_SIZE
];
192 uint32_t size
; /* sum of lengths of all subqueues */
196 * Structure that represents a single destination (prefix).
198 typedef struct rib_dest_t_
{
201 * Back pointer to the route node for this destination. This helps
202 * us get to the prefix that this structure is for.
204 struct route_node
*rnode
;
207 * Doubly-linked list of routes for this prefix.
209 struct re_list_head routes
;
211 struct route_entry
*selected_fib
;
219 * The list of nht prefixes that have ended up
220 * depending on this route node.
221 * After route processing is returned from
222 * the data plane we will run evaluate_rnh
225 struct rnh_list_head nht
;
228 * Linkage to put dest on the FPM processing queue.
230 TAILQ_ENTRY(rib_dest_t_
) fpm_q_entries
;
234 DECLARE_LIST(rnh_list
, struct rnh
, rnh_list_item
);
235 DECLARE_LIST(re_list
, struct route_entry
, next
);
237 #define RIB_ROUTE_QUEUED(x) (1 << (x))
238 // If MQ_SIZE is modified this value needs to be updated.
239 #define RIB_ROUTE_ANY_QUEUED 0x3F
242 * The maximum qindex that can be used.
244 #define ZEBRA_MAX_QINDEX (MQ_SIZE - 1)
247 * This flag indicates that a given prefix has been 'advertised' to
248 * the FPM to be installed in the forwarding plane.
250 #define RIB_DEST_SENT_TO_FPM (1 << (ZEBRA_MAX_QINDEX + 1))
253 * This flag is set when we need to send an update to the FPM about a
256 #define RIB_DEST_UPDATE_FPM (1 << (ZEBRA_MAX_QINDEX + 2))
258 #define RIB_DEST_UPDATE_LSPS (1 << (ZEBRA_MAX_QINDEX + 3))
261 * Macro to iterate over each route for a destination (prefix).
263 #define RE_DEST_FOREACH_ROUTE(dest, re) \
264 for ((re) = (dest) ? re_list_first(&((dest)->routes)) : NULL; (re); \
265 (re) = re_list_next(&((dest)->routes), (re)))
268 * Same as above, but allows the current node to be unlinked.
270 #define RE_DEST_FOREACH_ROUTE_SAFE(dest, re, next) \
271 for ((re) = (dest) ? re_list_first(&((dest)->routes)) : NULL; \
272 (re) && ((next) = re_list_next(&((dest)->routes), (re)), 1); \
275 #define RE_DEST_FIRST_ROUTE(dest, re) \
276 ((re) = (dest) ? re_list_first(&((dest)->routes)) : NULL)
278 #define RE_DEST_NEXT_ROUTE(dest, re) \
279 ((re) = (dest) ? re_list_next(&((dest)->routes), (re)) : NULL)
281 #define RNODE_FOREACH_RE(rn, re) \
282 RE_DEST_FOREACH_ROUTE (rib_dest_from_rnode(rn), re)
284 #define RNODE_FOREACH_RE_SAFE(rn, re, next) \
285 RE_DEST_FOREACH_ROUTE_SAFE (rib_dest_from_rnode(rn), re, next)
287 #define RNODE_FIRST_RE(rn, re) RE_DEST_FIRST_ROUTE(rib_dest_from_rnode(rn), re)
289 #define RNODE_NEXT_RE(rn, re) RE_DEST_NEXT_ROUTE(rib_dest_from_rnode(rn), re)
291 #if defined(HAVE_RTADV)
292 PREDECL_SORTLIST_UNIQ(adv_if_list
);
293 /* Structure which hold status of router advertisement. */
297 struct adv_if_list_head adv_if
;
298 struct adv_if_list_head adv_msec_if
;
300 struct thread
*ra_read
;
301 struct thread
*ra_timer
;
306 char name
[INTERFACE_NAMSIZ
];
307 struct adv_if_list_item list_item
;
310 static int adv_if_cmp(const struct adv_if
*a
, const struct adv_if
*b
)
312 return if_cmp_name_func(a
->name
, b
->name
);
315 DECLARE_SORTLIST_UNIQ(adv_if_list
, struct adv_if
, list_item
, adv_if_cmp
);
316 #endif /* HAVE_RTADV */
321 * Structure that is hung off of a route_table that holds information about
324 struct rib_table_info
{
327 * Back pointer to zebra_vrf.
329 struct zebra_vrf
*zvrf
;
335 enum rib_tables_iter_state
{
336 RIB_TABLES_ITER_S_INIT
,
337 RIB_TABLES_ITER_S_ITERATING
,
338 RIB_TABLES_ITER_S_DONE
342 * Structure that holds state for iterating over all tables in the
343 * Routing Information Base.
345 typedef struct rib_tables_iter_t_
{
349 enum rib_tables_iter_state state
;
352 /* Events/reasons triggering a RIB update. */
353 enum rib_update_event
{
355 RIB_UPDATE_RMAP_CHANGE
,
360 extern void route_entry_copy_nexthops(struct route_entry
*re
,
362 int route_entry_update_nhe(struct route_entry
*re
,
363 struct nhg_hash_entry
*new_nhghe
);
365 /* NHG replace has happend, we have to update route_entry pointers to new one */
366 void rib_handle_nhg_replace(struct nhg_hash_entry
*old_entry
,
367 struct nhg_hash_entry
*new_entry
);
369 #define route_entry_dump(prefix, src, re) _route_entry_dump(__func__, prefix, src, re)
370 extern void _route_entry_dump(const char *func
, union prefixconstptr pp
,
371 union prefixconstptr src_pp
,
372 const struct route_entry
*re
);
374 #define ZEBRA_RIB_LOOKUP_ERROR -1
375 #define ZEBRA_RIB_FOUND_EXACT 0
376 #define ZEBRA_RIB_FOUND_NOGATE 1
377 #define ZEBRA_RIB_FOUND_CONNECTED 2
378 #define ZEBRA_RIB_NOTFOUND 3
380 extern int is_zebra_valid_kernel_table(uint32_t table_id
);
381 extern int is_zebra_main_routing_table(uint32_t table_id
);
382 extern int zebra_check_addr(const struct prefix
*p
);
384 extern void rib_delnode(struct route_node
*rn
, struct route_entry
*re
);
385 extern void rib_install_kernel(struct route_node
*rn
, struct route_entry
*re
,
386 struct route_entry
*old
);
387 extern void rib_uninstall_kernel(struct route_node
*rn
, struct route_entry
*re
);
390 * All rib_add function will not just add prefix into RIB, but
391 * also implicitly withdraw equal prefix of same type. */
392 extern int rib_add(afi_t afi
, safi_t safi
, vrf_id_t vrf_id
, int type
,
393 unsigned short instance
, uint32_t flags
, struct prefix
*p
,
394 struct prefix_ipv6
*src_p
, const struct nexthop
*nh
,
395 uint32_t nhe_id
, uint32_t table_id
, uint32_t metric
,
396 uint32_t mtu
, uint8_t distance
, route_tag_t tag
);
398 * Multipath route apis.
400 extern int rib_add_multipath(afi_t afi
, safi_t safi
, struct prefix
*p
,
401 struct prefix_ipv6
*src_p
, struct route_entry
*re
,
402 struct nexthop_group
*ng
);
404 * -1 -> some sort of error
408 extern int rib_add_multipath_nhe(afi_t afi
, safi_t safi
, struct prefix
*p
,
409 struct prefix_ipv6
*src_p
,
410 struct route_entry
*re
,
411 struct nhg_hash_entry
*nhe
);
413 extern void rib_delete(afi_t afi
, safi_t safi
, vrf_id_t vrf_id
, int type
,
414 unsigned short instance
, uint32_t flags
,
415 struct prefix
*p
, struct prefix_ipv6
*src_p
,
416 const struct nexthop
*nh
, uint32_t nhe_id
,
417 uint32_t table_id
, uint32_t metric
, uint8_t distance
,
420 extern struct route_entry
*rib_match(afi_t afi
, safi_t safi
, vrf_id_t vrf_id
,
421 const union g_addr
*addr
,
422 struct route_node
**rn_out
);
423 extern struct route_entry
*rib_match_ipv4_multicast(vrf_id_t vrf_id
,
425 struct route_node
**rn_out
);
427 extern struct route_entry
*rib_lookup_ipv4(struct prefix_ipv4
*p
,
430 extern void rib_update(enum rib_update_event event
);
431 extern void rib_update_table(struct route_table
*table
,
432 enum rib_update_event event
, int rtype
);
433 extern int rib_sweep_route(struct thread
*t
);
434 extern void rib_sweep_table(struct route_table
*table
);
435 extern void rib_close_table(struct route_table
*table
);
436 extern void rib_init(void);
437 extern unsigned long rib_score_proto(uint8_t proto
, unsigned short instance
);
438 extern unsigned long rib_score_proto_table(uint8_t proto
,
439 unsigned short instance
,
440 struct route_table
*table
);
442 extern int rib_queue_add(struct route_node
*rn
);
444 struct nhg_ctx
; /* Forward declaration */
446 /* Enqueue incoming nhg from OS for processing */
447 extern int rib_queue_nhg_ctx_add(struct nhg_ctx
*ctx
);
449 /* Enqueue incoming nhg from proto daemon for processing */
450 extern int rib_queue_nhe_add(struct nhg_hash_entry
*nhe
);
452 /* Enqueue evpn route for processing */
453 int zebra_rib_queue_evpn_route_add(vrf_id_t vrf_id
, const struct ethaddr
*rmac
,
454 const struct ipaddr
*vtep_ip
,
455 const struct prefix
*host_prefix
);
456 int zebra_rib_queue_evpn_route_del(vrf_id_t vrf_id
,
457 const struct ipaddr
*vtep_ip
,
458 const struct prefix
*host_prefix
);
459 /* Enqueue EVPN remote ES for processing */
460 int zebra_rib_queue_evpn_rem_es_add(const esi_t
*esi
,
461 const struct in_addr
*vtep_ip
,
462 bool esr_rxed
, uint8_t df_alg
,
464 int zebra_rib_queue_evpn_rem_es_del(const esi_t
*esi
,
465 const struct in_addr
*vtep_ip
);
466 /* Enqueue EVPN remote macip update for processing */
467 int zebra_rib_queue_evpn_rem_macip_del(vni_t vni
, const struct ethaddr
*macaddr
,
468 const struct ipaddr
*ip
,
469 struct in_addr vtep_ip
);
470 int zebra_rib_queue_evpn_rem_macip_add(vni_t vni
, const struct ethaddr
*macaddr
,
471 const struct ipaddr
*ipaddr
,
472 uint8_t flags
, uint32_t seq
,
473 struct in_addr vtep_ip
,
475 /* Enqueue VXLAN remote vtep update for processing */
476 int zebra_rib_queue_evpn_rem_vtep_add(vrf_id_t vrf_id
, vni_t vni
,
477 struct in_addr vtep_ip
,
479 int zebra_rib_queue_evpn_rem_vtep_del(vrf_id_t vrf_id
, vni_t vni
,
480 struct in_addr vtep_ip
);
482 extern void meta_queue_free(struct meta_queue
*mq
);
483 extern int zebra_rib_labeled_unicast(struct route_entry
*re
);
484 extern struct route_table
*rib_table_ipv6
;
486 extern void rib_unlink(struct route_node
*rn
, struct route_entry
*re
);
487 extern int rib_gc_dest(struct route_node
*rn
);
488 extern struct route_table
*rib_tables_iter_next(rib_tables_iter_t
*iter
);
490 extern uint8_t route_distance(int type
);
492 extern void zebra_rib_evaluate_rn_nexthops(struct route_node
*rn
, uint32_t seq
);
501 static inline struct rib_table_info
*rib_table_info(struct route_table
*table
)
503 return (struct rib_table_info
*)route_table_get_info(table
);
507 * rib_dest_from_rnode
509 static inline rib_dest_t
*rib_dest_from_rnode(struct route_node
*rn
)
511 return (rib_dest_t
*)rn
->info
;
517 * Returns a pointer to the list of routes corresponding to the given
520 static inline struct route_entry
*rnode_to_ribs(struct route_node
*rn
)
524 dest
= rib_dest_from_rnode(rn
);
528 return re_list_first(&dest
->routes
);
534 static inline struct prefix
*rib_dest_prefix(rib_dest_t
*dest
)
536 return &dest
->rnode
->p
;
542 * Returns the address family that the destination is for.
544 static inline uint8_t rib_dest_af(rib_dest_t
*dest
)
546 return dest
->rnode
->p
.family
;
552 static inline struct route_table
*rib_dest_table(rib_dest_t
*dest
)
554 return srcdest_rnode_table(dest
->rnode
);
560 static inline struct zebra_vrf
*rib_dest_vrf(rib_dest_t
*dest
)
562 return rib_table_info(rib_dest_table(dest
))->zvrf
;
566 * Create the rib_dest_t and attach it to the specified node
568 extern rib_dest_t
*zebra_rib_create_dest(struct route_node
*rn
);
571 * rib_tables_iter_init
573 static inline void rib_tables_iter_init(rib_tables_iter_t
*iter
)
576 memset(iter
, 0, sizeof(*iter
));
577 iter
->state
= RIB_TABLES_ITER_S_INIT
;
581 * rib_tables_iter_started
583 * Returns true if this iterator has started iterating over the set of
586 static inline int rib_tables_iter_started(rib_tables_iter_t
*iter
)
588 return iter
->state
!= RIB_TABLES_ITER_S_INIT
;
592 * rib_tables_iter_cleanup
594 static inline void rib_tables_iter_cleanup(rib_tables_iter_t
*iter
)
596 iter
->state
= RIB_TABLES_ITER_S_DONE
;
599 DECLARE_HOOK(rib_update
, (struct route_node
* rn
, const char *reason
),
603 * Access installed/fib nexthops, which may be a subset of the
606 static inline struct nexthop_group
*rib_get_fib_nhg(struct route_entry
*re
)
608 /* If the fib set is a subset of the active rib set,
609 * use the dedicated fib list.
611 if (CHECK_FLAG(re
->status
, ROUTE_ENTRY_USE_FIB_NHG
))
612 return &(re
->fib_ng
);
614 return &(re
->nhe
->nhg
);
618 * Access backup nexthop-group that represents the installed backup nexthops;
619 * any installed backup will be on the fib list.
621 static inline struct nexthop_group
*rib_get_fib_backup_nhg(
622 struct route_entry
*re
)
624 return &(re
->fib_backup_ng
);
627 extern void zebra_vty_init(void);
631 extern bool v6_rr_semantics
;
637 #endif /*_ZEBRA_RIB_H */