1 // SPDX-License-Identifier: GPL-2.0-or-later
3 * Routing Information Base header
4 * Copyright (C) 1997 Kunihiro Ishiguro
19 #include "nexthop_group.h"
23 #include "srcdest_table.h"
24 #include "zebra/zebra_nhg.h"
30 DECLARE_MGROUP(ZEBRA
);
34 PREDECL_LIST(rnh_list
);
36 /* Nexthop structure. */
40 #define ZEBRA_NHT_CONNECTED 0x1
41 #define ZEBRA_NHT_DELETED 0x2
42 #define ZEBRA_NHT_RESOLVE_VIA_DEFAULT 0x4
52 struct route_entry
*state
;
53 struct prefix resolved_route
;
54 struct list
*client_list
;
56 /* pseudowires dependent on this nh */
57 struct list
*zebra_pseudowire_list
;
59 struct route_node
*node
;
62 * if this has been filtered for the client
64 int filtered
[ZEBRA_ROUTE_MAX
];
66 struct rnh_list_item rnh_list_item
;
69 #define DISTANCE_INFINITY 255
70 #define ZEBRA_KERNEL_TABLE_MAX 252 /* support for no more than this rt tables */
72 PREDECL_LIST(re_list
);
81 struct re_list_item next
;
83 /* Nexthop group, shared/refcounted, based on the nexthop(s)
84 * provided by the owner of the route
86 struct nhg_hash_entry
*nhe
;
88 /* Nexthop group from FIB (optional), reflecting what is actually
89 * installed in the FIB if that differs. The 'backup' group is used
90 * when backup nexthops are present in the route's nhg.
92 struct nexthop_group fib_ng
;
93 struct nexthop_group fib_backup_ng
;
95 /* Nexthop group hash entry IDs. The "installed" id is the id
96 * used in linux/netlink, if available.
99 uint32_t nhe_installed_id
;
107 /* Type of this route. */
110 /* VRF identifier. */
113 /* Which routing table */
121 uint32_t nexthop_mtu
;
123 /* Flags of this route.
124 * This flag's definition is in lib/zebra.h ZEBRA_FLAG_* and is exposed
125 * to clients via Zserv
129 /* RIB internal status */
131 #define ROUTE_ENTRY_REMOVED 0x1
132 /* The Route Entry has changed */
133 #define ROUTE_ENTRY_CHANGED 0x2
134 /* The Label has changed on the Route entry */
135 #define ROUTE_ENTRY_LABELS_CHANGED 0x4
136 /* Route is queued for Installation into the Data Plane */
137 #define ROUTE_ENTRY_QUEUED 0x8
138 /* Route is installed into the Data Plane */
139 #define ROUTE_ENTRY_INSTALLED 0x10
140 /* Route has Failed installation into the Data Plane in some manner */
141 #define ROUTE_ENTRY_FAILED 0x20
142 /* Route has a 'fib' set of nexthops, probably because the installed set
143 * differs from the rib/normal set of nexthops.
145 #define ROUTE_ENTRY_USE_FIB_NHG 0x40
147 * Route entries that are going to the dplane for a Route Replace
148 * let's note the fact that this is happening. This will
149 * be useful when zebra is determing if a route can be
152 #define ROUTE_ENTRY_ROUTE_REPLACING 0x80
154 /* Sequence value incremented for each dataplane operation */
155 uint32_t dplane_sequence
;
157 /* Source protocol instance */
163 struct re_opaque
*opaque
;
166 #define RIB_SYSTEM_ROUTE(R) RSYSTEM_ROUTE((R)->type)
168 #define RIB_KERNEL_ROUTE(R) RKERNEL_ROUTE((R)->type)
170 /* meta-queue structure:
171 * sub-queue 0: nexthop group objects
172 * sub-queue 1: EVPN/VxLAN objects
173 * sub-queue 2: Early Route Processing
174 * sub-queue 3: Early Label Processing
175 * sub-queue 4: connected
176 * sub-queue 5: kernel
177 * sub-queue 6: static
178 * sub-queue 7: RIP, RIPng, OSPF, OSPF6, IS-IS, EIGRP, NHRP
179 * sub-queue 8: iBGP, eBGP
180 * sub-queue 9: any other origin (if any) typically those that
181 * don't generate routes
185 struct list
*subq
[MQ_SIZE
];
186 uint32_t size
; /* sum of lengths of all subqueues */
190 * Structure that represents a single destination (prefix).
192 typedef struct rib_dest_t_
{
195 * Back pointer to the route node for this destination. This helps
196 * us get to the prefix that this structure is for.
198 struct route_node
*rnode
;
201 * Doubly-linked list of routes for this prefix.
203 struct re_list_head routes
;
205 struct route_entry
*selected_fib
;
213 * The list of nht prefixes that have ended up
214 * depending on this route node.
215 * After route processing is returned from
216 * the data plane we will run evaluate_rnh
219 struct rnh_list_head nht
;
222 * Linkage to put dest on the FPM processing queue.
224 TAILQ_ENTRY(rib_dest_t_
) fpm_q_entries
;
228 DECLARE_LIST(rnh_list
, struct rnh
, rnh_list_item
);
229 DECLARE_LIST(re_list
, struct route_entry
, next
);
231 #define RIB_ROUTE_QUEUED(x) (1 << (x))
232 // If MQ_SIZE is modified this value needs to be updated.
233 #define RIB_ROUTE_ANY_QUEUED 0x3F
236 * The maximum qindex that can be used.
238 #define ZEBRA_MAX_QINDEX (MQ_SIZE - 1)
241 * This flag indicates that a given prefix has been 'advertised' to
242 * the FPM to be installed in the forwarding plane.
244 #define RIB_DEST_SENT_TO_FPM (1 << (ZEBRA_MAX_QINDEX + 1))
247 * This flag is set when we need to send an update to the FPM about a
250 #define RIB_DEST_UPDATE_FPM (1 << (ZEBRA_MAX_QINDEX + 2))
252 #define RIB_DEST_UPDATE_LSPS (1 << (ZEBRA_MAX_QINDEX + 3))
255 * Macro to iterate over each route for a destination (prefix).
257 #define RE_DEST_FOREACH_ROUTE(dest, re) \
258 for ((re) = (dest) ? re_list_first(&((dest)->routes)) : NULL; (re); \
259 (re) = re_list_next(&((dest)->routes), (re)))
262 * Same as above, but allows the current node to be unlinked.
264 #define RE_DEST_FOREACH_ROUTE_SAFE(dest, re, next) \
265 for ((re) = (dest) ? re_list_first(&((dest)->routes)) : NULL; \
266 (re) && ((next) = re_list_next(&((dest)->routes), (re)), 1); \
269 #define RE_DEST_FIRST_ROUTE(dest, re) \
270 ((re) = (dest) ? re_list_first(&((dest)->routes)) : NULL)
272 #define RE_DEST_NEXT_ROUTE(dest, re) \
273 ((re) = (dest) ? re_list_next(&((dest)->routes), (re)) : NULL)
275 #define RNODE_FOREACH_RE(rn, re) \
276 RE_DEST_FOREACH_ROUTE (rib_dest_from_rnode(rn), re)
278 #define RNODE_FOREACH_RE_SAFE(rn, re, next) \
279 RE_DEST_FOREACH_ROUTE_SAFE (rib_dest_from_rnode(rn), re, next)
281 #define RNODE_FIRST_RE(rn, re) RE_DEST_FIRST_ROUTE(rib_dest_from_rnode(rn), re)
283 #define RNODE_NEXT_RE(rn, re) RE_DEST_NEXT_ROUTE(rib_dest_from_rnode(rn), re)
288 * Structure that is hung off of a route_table that holds information about
291 struct rib_table_info
{
294 * Back pointer to zebra_vrf.
296 struct zebra_vrf
*zvrf
;
302 enum rib_tables_iter_state
{
303 RIB_TABLES_ITER_S_INIT
,
304 RIB_TABLES_ITER_S_ITERATING
,
305 RIB_TABLES_ITER_S_DONE
309 * Structure that holds state for iterating over all tables in the
310 * Routing Information Base.
312 typedef struct rib_tables_iter_t_
{
316 enum rib_tables_iter_state state
;
319 /* Events/reasons triggering a RIB update. */
320 enum rib_update_event
{
322 RIB_UPDATE_RMAP_CHANGE
,
327 int route_entry_update_nhe(struct route_entry
*re
,
328 struct nhg_hash_entry
*new_nhghe
);
330 /* NHG replace has happend, we have to update route_entry pointers to new one */
331 void rib_handle_nhg_replace(struct nhg_hash_entry
*old_entry
,
332 struct nhg_hash_entry
*new_entry
);
334 #define route_entry_dump(prefix, src, re) _route_entry_dump(__func__, prefix, src, re)
335 extern void _route_entry_dump(const char *func
, union prefixconstptr pp
,
336 union prefixconstptr src_pp
,
337 const struct route_entry
*re
);
340 zebra_rib_route_entry_new(vrf_id_t vrf_id
, int type
, uint8_t instance
,
341 uint32_t flags
, uint32_t nhe_id
, uint32_t table_id
,
342 uint32_t metric
, uint32_t mtu
, uint8_t distance
,
345 #define ZEBRA_RIB_LOOKUP_ERROR -1
346 #define ZEBRA_RIB_FOUND_EXACT 0
347 #define ZEBRA_RIB_FOUND_NOGATE 1
348 #define ZEBRA_RIB_FOUND_CONNECTED 2
349 #define ZEBRA_RIB_NOTFOUND 3
351 extern int is_zebra_valid_kernel_table(uint32_t table_id
);
352 extern int is_zebra_main_routing_table(uint32_t table_id
);
353 extern int zebra_check_addr(const struct prefix
*p
);
355 extern void rib_delnode(struct route_node
*rn
, struct route_entry
*re
);
356 extern void rib_install_kernel(struct route_node
*rn
, struct route_entry
*re
,
357 struct route_entry
*old
);
358 extern void rib_uninstall_kernel(struct route_node
*rn
, struct route_entry
*re
);
361 * All rib_add function will not just add prefix into RIB, but
362 * also implicitly withdraw equal prefix of same type. */
363 extern int rib_add(afi_t afi
, safi_t safi
, vrf_id_t vrf_id
, int type
,
364 unsigned short instance
, uint32_t flags
, struct prefix
*p
,
365 struct prefix_ipv6
*src_p
, const struct nexthop
*nh
,
366 uint32_t nhe_id
, uint32_t table_id
, uint32_t metric
,
367 uint32_t mtu
, uint8_t distance
, route_tag_t tag
,
370 * Multipath route apis.
372 extern int rib_add_multipath(afi_t afi
, safi_t safi
, struct prefix
*p
,
373 struct prefix_ipv6
*src_p
, struct route_entry
*re
,
374 struct nexthop_group
*ng
, bool startup
);
376 * -1 -> some sort of error
380 extern int rib_add_multipath_nhe(afi_t afi
, safi_t safi
, struct prefix
*p
,
381 struct prefix_ipv6
*src_p
,
382 struct route_entry
*re
,
383 struct nhg_hash_entry
*nhe
, bool startup
);
385 extern void rib_delete(afi_t afi
, safi_t safi
, vrf_id_t vrf_id
, int type
,
386 unsigned short instance
, uint32_t flags
,
387 struct prefix
*p
, struct prefix_ipv6
*src_p
,
388 const struct nexthop
*nh
, uint32_t nhe_id
,
389 uint32_t table_id
, uint32_t metric
, uint8_t distance
,
392 extern struct route_entry
*rib_match(afi_t afi
, safi_t safi
, vrf_id_t vrf_id
,
393 const union g_addr
*addr
,
394 struct route_node
**rn_out
);
395 extern struct route_entry
*rib_match_multicast(afi_t afi
, vrf_id_t vrf_id
,
397 struct route_node
**rn_out
);
399 extern struct route_entry
*rib_lookup_ipv4(struct prefix_ipv4
*p
,
402 extern void rib_update(enum rib_update_event event
);
403 extern void rib_update_table(struct route_table
*table
,
404 enum rib_update_event event
, int rtype
);
405 extern void rib_sweep_route(struct thread
*t
);
406 extern void rib_sweep_table(struct route_table
*table
);
407 extern void rib_close_table(struct route_table
*table
);
408 extern void rib_init(void);
409 extern unsigned long rib_score_proto(uint8_t proto
, unsigned short instance
);
410 extern unsigned long rib_score_proto_table(uint8_t proto
,
411 unsigned short instance
,
412 struct route_table
*table
);
414 extern int rib_queue_add(struct route_node
*rn
);
416 struct nhg_ctx
; /* Forward declaration */
418 /* Enqueue incoming nhg from OS for processing */
419 extern int rib_queue_nhg_ctx_add(struct nhg_ctx
*ctx
);
421 /* Enqueue incoming nhg from proto daemon for processing */
422 extern int rib_queue_nhe_add(struct nhg_hash_entry
*nhe
);
424 /* Enqueue evpn route for processing */
425 int zebra_rib_queue_evpn_route_add(vrf_id_t vrf_id
, const struct ethaddr
*rmac
,
426 const struct ipaddr
*vtep_ip
,
427 const struct prefix
*host_prefix
);
428 int zebra_rib_queue_evpn_route_del(vrf_id_t vrf_id
,
429 const struct ipaddr
*vtep_ip
,
430 const struct prefix
*host_prefix
);
431 /* Enqueue EVPN remote ES for processing */
432 int zebra_rib_queue_evpn_rem_es_add(const esi_t
*esi
,
433 const struct in_addr
*vtep_ip
,
434 bool esr_rxed
, uint8_t df_alg
,
436 int zebra_rib_queue_evpn_rem_es_del(const esi_t
*esi
,
437 const struct in_addr
*vtep_ip
);
438 /* Enqueue EVPN remote macip update for processing */
439 int zebra_rib_queue_evpn_rem_macip_del(vni_t vni
, const struct ethaddr
*macaddr
,
440 const struct ipaddr
*ip
,
441 struct in_addr vtep_ip
);
442 int zebra_rib_queue_evpn_rem_macip_add(vni_t vni
, const struct ethaddr
*macaddr
,
443 const struct ipaddr
*ipaddr
,
444 uint8_t flags
, uint32_t seq
,
445 struct in_addr vtep_ip
,
447 /* Enqueue VXLAN remote vtep update for processing */
448 int zebra_rib_queue_evpn_rem_vtep_add(vrf_id_t vrf_id
, vni_t vni
,
449 struct in_addr vtep_ip
,
451 int zebra_rib_queue_evpn_rem_vtep_del(vrf_id_t vrf_id
, vni_t vni
,
452 struct in_addr vtep_ip
);
454 extern void meta_queue_free(struct meta_queue
*mq
, struct zebra_vrf
*zvrf
);
455 extern int zebra_rib_labeled_unicast(struct route_entry
*re
);
456 extern struct route_table
*rib_table_ipv6
;
458 extern void rib_unlink(struct route_node
*rn
, struct route_entry
*re
);
459 extern int rib_gc_dest(struct route_node
*rn
);
460 extern struct route_table
*rib_tables_iter_next(rib_tables_iter_t
*iter
);
462 extern uint8_t route_distance(int type
);
464 extern void zebra_rib_evaluate_rn_nexthops(struct route_node
*rn
, uint32_t seq
,
467 extern struct route_node
*
468 rib_find_rn_from_ctx(const struct zebra_dplane_ctx
*ctx
);
477 static inline struct rib_table_info
*rib_table_info(struct route_table
*table
)
479 return (struct rib_table_info
*)route_table_get_info(table
);
483 * rib_dest_from_rnode
485 static inline rib_dest_t
*rib_dest_from_rnode(struct route_node
*rn
)
487 return (rib_dest_t
*)rn
->info
;
493 * Returns a pointer to the list of routes corresponding to the given
496 static inline struct route_entry
*rnode_to_ribs(struct route_node
*rn
)
500 dest
= rib_dest_from_rnode(rn
);
504 return re_list_first(&dest
->routes
);
510 static inline struct prefix
*rib_dest_prefix(rib_dest_t
*dest
)
512 return &dest
->rnode
->p
;
518 * Returns the address family that the destination is for.
520 static inline uint8_t rib_dest_af(rib_dest_t
*dest
)
522 return dest
->rnode
->p
.family
;
528 static inline struct route_table
*rib_dest_table(rib_dest_t
*dest
)
530 return srcdest_rnode_table(dest
->rnode
);
536 static inline struct zebra_vrf
*rib_dest_vrf(rib_dest_t
*dest
)
538 return rib_table_info(rib_dest_table(dest
))->zvrf
;
542 * Create the rib_dest_t and attach it to the specified node
544 extern rib_dest_t
*zebra_rib_create_dest(struct route_node
*rn
);
547 * rib_tables_iter_init
549 static inline void rib_tables_iter_init(rib_tables_iter_t
*iter
)
552 memset(iter
, 0, sizeof(*iter
));
553 iter
->state
= RIB_TABLES_ITER_S_INIT
;
557 * rib_tables_iter_started
559 * Returns true if this iterator has started iterating over the set of
562 static inline int rib_tables_iter_started(rib_tables_iter_t
*iter
)
564 return iter
->state
!= RIB_TABLES_ITER_S_INIT
;
568 * rib_tables_iter_cleanup
570 static inline void rib_tables_iter_cleanup(rib_tables_iter_t
*iter
)
572 iter
->state
= RIB_TABLES_ITER_S_DONE
;
575 DECLARE_HOOK(rib_update
, (struct route_node
* rn
, const char *reason
),
577 DECLARE_HOOK(rib_shutdown
, (struct route_node
* rn
), (rn
));
580 * Access installed/fib nexthops, which may be a subset of the
583 static inline struct nexthop_group
*rib_get_fib_nhg(struct route_entry
*re
)
585 /* If the fib set is a subset of the active rib set,
586 * use the dedicated fib list.
588 if (CHECK_FLAG(re
->status
, ROUTE_ENTRY_USE_FIB_NHG
))
589 return &(re
->fib_ng
);
591 return &(re
->nhe
->nhg
);
595 * Access backup nexthop-group that represents the installed backup nexthops;
596 * any installed backup will be on the fib list.
598 static inline struct nexthop_group
*rib_get_fib_backup_nhg(
599 struct route_entry
*re
)
601 return &(re
->fib_backup_ng
);
604 extern void zebra_vty_init(void);
608 extern bool v6_rr_semantics
;
610 /* Name of hook calls */
611 #define ZEBRA_ON_RIB_PROCESS_HOOK_CALL "on_rib_process_dplane_results"
617 #endif /*_ZEBRA_RIB_H */