1 /* Routing Information Base.
2 * Copyright (C) 1997, 98, 99, 2001 Kunihiro Ishiguro
4 * This file is part of GNU Zebra.
6 * GNU Zebra is free software; you can redistribute it and/or modify it
7 * under the terms of the GNU General Public License as published by the
8 * Free Software Foundation; either version 2, or (at your option) any
11 * GNU Zebra is distributed in the hope that it will be useful, but
12 * WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14 * General Public License for more details.
16 * You should have received a copy of the GNU General Public License along
17 * with this program; see the file COPYING; if not, write to the Free Software
18 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
33 #include "sockunion.h"
34 #include "srcdest_table.h"
38 #include "workqueue.h"
39 #include "nexthop_group_private.h"
40 #include "frr_pthread.h"
42 #include "zebra/zebra_router.h"
43 #include "zebra/connected.h"
44 #include "zebra/debug.h"
45 #include "zebra/interface.h"
46 #include "zebra/redistribute.h"
47 #include "zebra/rib.h"
49 #include "zebra/zapi_msg.h"
50 #include "zebra/zebra_errors.h"
51 #include "zebra/zebra_memory.h"
52 #include "zebra/zebra_ns.h"
53 #include "zebra/zebra_rnh.h"
54 #include "zebra/zebra_routemap.h"
55 #include "zebra/zebra_vrf.h"
56 #include "zebra/zebra_vxlan.h"
57 #include "zebra/zapi_msg.h"
58 #include "zebra/zebra_dplane.h"
60 DEFINE_MTYPE_STATIC(ZEBRA
, RIB_UPDATE_CTX
, "Rib update context object");
63 * Event, list, and mutex for delivery of dataplane results
65 static pthread_mutex_t dplane_mutex
;
66 static struct thread
*t_dplane
;
67 static struct dplane_ctx_q rib_dplane_q
;
69 DEFINE_HOOK(rib_update
, (struct route_node
* rn
, const char *reason
),
72 /* Should we allow non Quagga processes to delete our routes */
73 extern int allow_delete
;
75 /* Each route type's string and default distance value. */
80 } route_info
[ZEBRA_ROUTE_MAX
] = {
81 [ZEBRA_ROUTE_NHG
] = {ZEBRA_ROUTE_NHG
, 255 /* Uneeded for nhg's */, 0},
82 [ZEBRA_ROUTE_SYSTEM
] = {ZEBRA_ROUTE_SYSTEM
, 0, 5},
83 [ZEBRA_ROUTE_KERNEL
] = {ZEBRA_ROUTE_KERNEL
, 0, 1},
84 [ZEBRA_ROUTE_CONNECT
] = {ZEBRA_ROUTE_CONNECT
, 0, 1},
85 [ZEBRA_ROUTE_STATIC
] = {ZEBRA_ROUTE_STATIC
, 1, 2},
86 [ZEBRA_ROUTE_RIP
] = {ZEBRA_ROUTE_RIP
, 120, 3},
87 [ZEBRA_ROUTE_RIPNG
] = {ZEBRA_ROUTE_RIPNG
, 120, 3},
88 [ZEBRA_ROUTE_OSPF
] = {ZEBRA_ROUTE_OSPF
, 110, 3},
89 [ZEBRA_ROUTE_OSPF6
] = {ZEBRA_ROUTE_OSPF6
, 110, 3},
90 [ZEBRA_ROUTE_ISIS
] = {ZEBRA_ROUTE_ISIS
, 115, 3},
91 [ZEBRA_ROUTE_BGP
] = {ZEBRA_ROUTE_BGP
, 20 /* IBGP is 200. */, 4},
92 [ZEBRA_ROUTE_PIM
] = {ZEBRA_ROUTE_PIM
, 255, 5},
93 [ZEBRA_ROUTE_EIGRP
] = {ZEBRA_ROUTE_EIGRP
, 90, 3},
94 [ZEBRA_ROUTE_NHRP
] = {ZEBRA_ROUTE_NHRP
, 10, 3},
95 [ZEBRA_ROUTE_HSLS
] = {ZEBRA_ROUTE_HSLS
, 255, 5},
96 [ZEBRA_ROUTE_OLSR
] = {ZEBRA_ROUTE_OLSR
, 255, 5},
97 [ZEBRA_ROUTE_TABLE
] = {ZEBRA_ROUTE_TABLE
, 150, 2},
98 [ZEBRA_ROUTE_LDP
] = {ZEBRA_ROUTE_LDP
, 150, 5},
99 [ZEBRA_ROUTE_VNC
] = {ZEBRA_ROUTE_VNC
, 20, 4},
100 [ZEBRA_ROUTE_VNC_DIRECT
] = {ZEBRA_ROUTE_VNC_DIRECT
, 20, 4},
101 [ZEBRA_ROUTE_VNC_DIRECT_RH
] = {ZEBRA_ROUTE_VNC_DIRECT_RH
, 20, 4},
102 [ZEBRA_ROUTE_BGP_DIRECT
] = {ZEBRA_ROUTE_BGP_DIRECT
, 20, 4},
103 [ZEBRA_ROUTE_BGP_DIRECT_EXT
] = {ZEBRA_ROUTE_BGP_DIRECT_EXT
, 20, 4},
104 [ZEBRA_ROUTE_BABEL
] = {ZEBRA_ROUTE_BABEL
, 100, 3},
105 [ZEBRA_ROUTE_SHARP
] = {ZEBRA_ROUTE_SHARP
, 150, 5},
106 [ZEBRA_ROUTE_PBR
] = {ZEBRA_ROUTE_PBR
, 200, 5},
107 [ZEBRA_ROUTE_BFD
] = {ZEBRA_ROUTE_BFD
, 255, 5},
108 [ZEBRA_ROUTE_OPENFABRIC
] = {ZEBRA_ROUTE_OPENFABRIC
, 115, 3},
109 [ZEBRA_ROUTE_VRRP
] = {ZEBRA_ROUTE_VRRP
, 255, 5}
110 /* Any new route type added to zebra, should be mirrored here */
112 /* no entry/default: 150 */
115 static void __attribute__((format(printf
, 5, 6)))
116 _rnode_zlog(const char *_func
, vrf_id_t vrf_id
, struct route_node
*rn
,
117 int priority
, const char *msgfmt
, ...)
119 char buf
[SRCDEST2STR_BUFFER
+ sizeof(" (MRIB)")];
123 va_start(ap
, msgfmt
);
124 vsnprintf(msgbuf
, sizeof(msgbuf
), msgfmt
, ap
);
128 rib_table_info_t
*info
= srcdest_rnode_table_info(rn
);
129 srcdest_rnode2str(rn
, buf
, sizeof(buf
));
131 if (info
->safi
== SAFI_MULTICAST
)
132 strlcat(buf
, " (MRIB)", sizeof(buf
));
134 snprintf(buf
, sizeof(buf
), "{(route_node *) NULL}");
137 zlog(priority
, "%s: %d:%s: %s", _func
, vrf_id
, buf
, msgbuf
);
140 #define rnode_debug(node, vrf_id, ...) \
141 _rnode_zlog(__func__, vrf_id, node, LOG_DEBUG, __VA_ARGS__)
142 #define rnode_info(node, ...) \
143 _rnode_zlog(__func__, vrf_id, node, LOG_INFO, __VA_ARGS__)
145 uint8_t route_distance(int type
)
149 if ((unsigned)type
>= array_size(route_info
))
152 distance
= route_info
[type
].distance
;
157 int is_zebra_valid_kernel_table(uint32_t table_id
)
160 if ((table_id
== RT_TABLE_UNSPEC
) || (table_id
== RT_TABLE_LOCAL
)
161 || (table_id
== RT_TABLE_COMPAT
))
168 int is_zebra_main_routing_table(uint32_t table_id
)
170 if (table_id
== RT_TABLE_MAIN
)
175 int zebra_check_addr(const struct prefix
*p
)
177 if (p
->family
== AF_INET
) {
180 addr
= p
->u
.prefix4
.s_addr
;
183 if (IPV4_NET127(addr
) || IN_CLASSD(addr
)
184 || IPV4_LINKLOCAL(addr
))
187 if (p
->family
== AF_INET6
) {
188 if (IN6_IS_ADDR_LOOPBACK(&p
->u
.prefix6
))
190 if (IN6_IS_ADDR_LINKLOCAL(&p
->u
.prefix6
))
196 /* Add nexthop to the end of a rib node's nexthop list */
197 void route_entry_nexthop_add(struct route_entry
*re
, struct nexthop
*nexthop
)
199 _nexthop_group_add_sorted(re
->ng
, nexthop
);
204 * copy_nexthop - copy a nexthop to the rib structure.
206 void route_entry_copy_nexthops(struct route_entry
*re
, struct nexthop
*nh
)
208 assert(!re
->ng
->nexthop
);
209 copy_nexthops(&re
->ng
->nexthop
, nh
, NULL
);
212 /* Delete specified nexthop from the list. */
213 void route_entry_nexthop_delete(struct route_entry
*re
, struct nexthop
*nexthop
)
216 nexthop
->next
->prev
= nexthop
->prev
;
218 nexthop
->prev
->next
= nexthop
->next
;
220 re
->ng
->nexthop
= nexthop
->next
;
224 struct nexthop
*route_entry_nexthop_ifindex_add(struct route_entry
*re
,
228 struct nexthop
*nexthop
;
230 nexthop
= nexthop_new();
231 nexthop
->type
= NEXTHOP_TYPE_IFINDEX
;
232 nexthop
->ifindex
= ifindex
;
233 nexthop
->vrf_id
= nh_vrf_id
;
235 route_entry_nexthop_add(re
, nexthop
);
240 struct nexthop
*route_entry_nexthop_ipv4_add(struct route_entry
*re
,
241 struct in_addr
*ipv4
,
245 struct nexthop
*nexthop
;
247 nexthop
= nexthop_new();
248 nexthop
->type
= NEXTHOP_TYPE_IPV4
;
249 nexthop
->vrf_id
= nh_vrf_id
;
250 nexthop
->gate
.ipv4
= *ipv4
;
252 nexthop
->src
.ipv4
= *src
;
254 route_entry_nexthop_add(re
, nexthop
);
259 struct nexthop
*route_entry_nexthop_ipv4_ifindex_add(struct route_entry
*re
,
260 struct in_addr
*ipv4
,
265 struct nexthop
*nexthop
;
266 struct interface
*ifp
;
268 nexthop
= nexthop_new();
269 nexthop
->vrf_id
= nh_vrf_id
;
270 nexthop
->type
= NEXTHOP_TYPE_IPV4_IFINDEX
;
271 nexthop
->gate
.ipv4
= *ipv4
;
273 nexthop
->src
.ipv4
= *src
;
274 nexthop
->ifindex
= ifindex
;
275 ifp
= if_lookup_by_index(nexthop
->ifindex
, nh_vrf_id
);
276 /*Pending: need to think if null ifp here is ok during bootup?
277 There was a crash because ifp here was coming to be NULL */
279 if (connected_is_unnumbered(ifp
))
280 SET_FLAG(nexthop
->flags
, NEXTHOP_FLAG_ONLINK
);
282 route_entry_nexthop_add(re
, nexthop
);
287 struct nexthop
*route_entry_nexthop_ipv6_add(struct route_entry
*re
,
288 struct in6_addr
*ipv6
,
291 struct nexthop
*nexthop
;
293 nexthop
= nexthop_new();
294 nexthop
->vrf_id
= nh_vrf_id
;
295 nexthop
->type
= NEXTHOP_TYPE_IPV6
;
296 nexthop
->gate
.ipv6
= *ipv6
;
298 route_entry_nexthop_add(re
, nexthop
);
303 struct nexthop
*route_entry_nexthop_ipv6_ifindex_add(struct route_entry
*re
,
304 struct in6_addr
*ipv6
,
308 struct nexthop
*nexthop
;
310 nexthop
= nexthop_new();
311 nexthop
->vrf_id
= nh_vrf_id
;
312 nexthop
->type
= NEXTHOP_TYPE_IPV6_IFINDEX
;
313 nexthop
->gate
.ipv6
= *ipv6
;
314 nexthop
->ifindex
= ifindex
;
316 route_entry_nexthop_add(re
, nexthop
);
321 struct nexthop
*route_entry_nexthop_blackhole_add(struct route_entry
*re
,
322 enum blackhole_type bh_type
)
324 struct nexthop
*nexthop
;
326 nexthop
= nexthop_new();
327 nexthop
->vrf_id
= VRF_DEFAULT
;
328 nexthop
->type
= NEXTHOP_TYPE_BLACKHOLE
;
329 nexthop
->bh_type
= bh_type
;
331 route_entry_nexthop_add(re
, nexthop
);
336 struct route_entry
*rib_match(afi_t afi
, safi_t safi
, vrf_id_t vrf_id
,
337 union g_addr
*addr
, struct route_node
**rn_out
)
340 struct route_table
*table
;
341 struct route_node
*rn
;
342 struct route_entry
*match
= NULL
;
345 table
= zebra_vrf_table(afi
, safi
, vrf_id
);
349 memset(&p
, 0, sizeof(struct prefix
));
352 p
.u
.prefix4
= addr
->ipv4
;
353 p
.prefixlen
= IPV4_MAX_PREFIXLEN
;
355 p
.u
.prefix6
= addr
->ipv6
;
356 p
.prefixlen
= IPV6_MAX_PREFIXLEN
;
359 rn
= route_node_match(table
, (struct prefix
*)&p
);
364 route_unlock_node(rn
);
366 dest
= rib_dest_from_rnode(rn
);
367 if (dest
&& dest
->selected_fib
368 && !CHECK_FLAG(dest
->selected_fib
->status
,
369 ROUTE_ENTRY_REMOVED
))
370 match
= dest
->selected_fib
;
372 /* If there is no selected route or matched route is EGP, go up
377 } while (rn
&& rn
->info
== NULL
);
381 if (match
->type
!= ZEBRA_ROUTE_CONNECT
) {
382 if (!CHECK_FLAG(match
->status
,
383 ROUTE_ENTRY_INSTALLED
))
395 struct route_entry
*rib_match_ipv4_multicast(vrf_id_t vrf_id
,
397 struct route_node
**rn_out
)
399 struct route_entry
*re
= NULL
, *mre
= NULL
, *ure
= NULL
;
400 struct route_node
*m_rn
= NULL
, *u_rn
= NULL
;
401 union g_addr gaddr
= {.ipv4
= addr
};
403 switch (zrouter
.ipv4_multicast_mode
) {
404 case MCAST_MRIB_ONLY
:
405 return rib_match(AFI_IP
, SAFI_MULTICAST
, vrf_id
, &gaddr
,
407 case MCAST_URIB_ONLY
:
408 return rib_match(AFI_IP
, SAFI_UNICAST
, vrf_id
, &gaddr
, rn_out
);
409 case MCAST_NO_CONFIG
:
410 case MCAST_MIX_MRIB_FIRST
:
411 re
= mre
= rib_match(AFI_IP
, SAFI_MULTICAST
, vrf_id
, &gaddr
,
414 re
= ure
= rib_match(AFI_IP
, SAFI_UNICAST
, vrf_id
,
417 case MCAST_MIX_DISTANCE
:
418 mre
= rib_match(AFI_IP
, SAFI_MULTICAST
, vrf_id
, &gaddr
, &m_rn
);
419 ure
= rib_match(AFI_IP
, SAFI_UNICAST
, vrf_id
, &gaddr
, &u_rn
);
421 re
= ure
->distance
< mre
->distance
? ure
: mre
;
427 case MCAST_MIX_PFXLEN
:
428 mre
= rib_match(AFI_IP
, SAFI_MULTICAST
, vrf_id
, &gaddr
, &m_rn
);
429 ure
= rib_match(AFI_IP
, SAFI_UNICAST
, vrf_id
, &gaddr
, &u_rn
);
431 re
= u_rn
->p
.prefixlen
> m_rn
->p
.prefixlen
? ure
: mre
;
440 *rn_out
= (re
== mre
) ? m_rn
: u_rn
;
442 if (IS_ZEBRA_DEBUG_RIB
) {
444 inet_ntop(AF_INET
, &addr
, buf
, BUFSIZ
);
446 zlog_debug("%s: %s: vrf: %u found %s, using %s",
447 __func__
, buf
, vrf_id
,
448 mre
? (ure
? "MRIB+URIB" : "MRIB")
449 : ure
? "URIB" : "nothing",
450 re
== ure
? "URIB" : re
== mre
? "MRIB" : "none");
455 struct route_entry
*rib_lookup_ipv4(struct prefix_ipv4
*p
, vrf_id_t vrf_id
)
457 struct route_table
*table
;
458 struct route_node
*rn
;
459 struct route_entry
*match
= NULL
;
463 table
= zebra_vrf_table(AFI_IP
, SAFI_UNICAST
, vrf_id
);
467 rn
= route_node_lookup(table
, (struct prefix
*)p
);
469 /* No route for this prefix. */
474 route_unlock_node(rn
);
475 dest
= rib_dest_from_rnode(rn
);
477 if (dest
&& dest
->selected_fib
478 && !CHECK_FLAG(dest
->selected_fib
->status
, ROUTE_ENTRY_REMOVED
))
479 match
= dest
->selected_fib
;
484 if (match
->type
== ZEBRA_ROUTE_CONNECT
)
487 if (CHECK_FLAG(match
->status
, ROUTE_ENTRY_INSTALLED
))
494 * Is this RIB labeled-unicast? It must be of type BGP and all paths
495 * (nexthops) must have a label.
497 int zebra_rib_labeled_unicast(struct route_entry
*re
)
499 struct nexthop
*nexthop
= NULL
;
501 if (re
->type
!= ZEBRA_ROUTE_BGP
)
504 for (ALL_NEXTHOPS_PTR(re
->ng
, nexthop
))
505 if (!nexthop
->nh_label
|| !nexthop
->nh_label
->num_labels
)
511 /* Update flag indicates whether this is a "replace" or not. Currently, this
512 * is only used for IPv4.
514 void rib_install_kernel(struct route_node
*rn
, struct route_entry
*re
,
515 struct route_entry
*old
)
517 struct nexthop
*nexthop
;
518 rib_table_info_t
*info
= srcdest_rnode_table_info(rn
);
519 struct zebra_vrf
*zvrf
= vrf_info_lookup(re
->vrf_id
);
520 const struct prefix
*p
, *src_p
;
521 enum zebra_dplane_result ret
;
523 rib_dest_t
*dest
= rib_dest_from_rnode(rn
);
525 srcdest_rnode_prefixes(rn
, &p
, &src_p
);
527 if (info
->safi
!= SAFI_UNICAST
) {
528 for (ALL_NEXTHOPS_PTR(re
->ng
, nexthop
))
529 SET_FLAG(nexthop
->flags
, NEXTHOP_FLAG_FIB
);
535 * Install the resolved nexthop object first.
537 zebra_nhg_install_kernel(zebra_nhg_lookup_id(re
->nhe_id
));
540 * If this is a replace to a new RE let the originator of the RE
541 * know that they've lost
543 if (old
&& (old
!= re
) && (old
->type
!= re
->type
))
544 zsend_route_notify_owner(old
, p
, ZAPI_ROUTE_BETTER_ADMIN_WON
);
546 /* Update fib selection */
547 dest
->selected_fib
= re
;
550 * Make sure we update the FPM any time we send new information to
553 hook_call(rib_update
, rn
, "installing in kernel");
555 /* Send add or update */
557 ret
= dplane_route_update(rn
, re
, old
);
559 ret
= dplane_route_add(rn
, re
);
562 case ZEBRA_DPLANE_REQUEST_QUEUED
:
563 SET_FLAG(re
->status
, ROUTE_ENTRY_QUEUED
);
566 SET_FLAG(old
->status
, ROUTE_ENTRY_QUEUED
);
568 /* Free old FIB nexthop group */
569 if (old
->fib_ng
.nexthop
) {
570 nexthops_free(old
->fib_ng
.nexthop
);
571 old
->fib_ng
.nexthop
= NULL
;
574 if (!RIB_SYSTEM_ROUTE(old
)) {
575 /* Clear old route's FIB flags */
576 for (ALL_NEXTHOPS_PTR(old
->ng
, nexthop
)) {
577 UNSET_FLAG(nexthop
->flags
,
584 zvrf
->installs_queued
++;
586 case ZEBRA_DPLANE_REQUEST_FAILURE
:
588 char str
[SRCDEST2STR_BUFFER
];
590 srcdest_rnode2str(rn
, str
, sizeof(str
));
591 flog_err(EC_ZEBRA_DP_INSTALL_FAIL
,
592 "%u:%s: Failed to enqueue dataplane install",
596 case ZEBRA_DPLANE_REQUEST_SUCCESS
:
605 /* Uninstall the route from kernel. */
606 void rib_uninstall_kernel(struct route_node
*rn
, struct route_entry
*re
)
608 struct nexthop
*nexthop
;
609 rib_table_info_t
*info
= srcdest_rnode_table_info(rn
);
610 struct zebra_vrf
*zvrf
= vrf_info_lookup(re
->vrf_id
);
612 if (info
->safi
!= SAFI_UNICAST
) {
613 UNSET_FLAG(re
->status
, ROUTE_ENTRY_INSTALLED
);
614 for (ALL_NEXTHOPS_PTR(re
->ng
, nexthop
))
615 UNSET_FLAG(nexthop
->flags
, NEXTHOP_FLAG_FIB
);
620 * Make sure we update the FPM any time we send new information to
623 hook_call(rib_update
, rn
, "uninstalling from kernel");
625 switch (dplane_route_delete(rn
, re
)) {
626 case ZEBRA_DPLANE_REQUEST_QUEUED
:
628 zvrf
->removals_queued
++;
630 case ZEBRA_DPLANE_REQUEST_FAILURE
:
632 char str
[SRCDEST2STR_BUFFER
];
634 srcdest_rnode2str(rn
, str
, sizeof(str
));
635 flog_err(EC_ZEBRA_DP_INSTALL_FAIL
,
636 "%u:%s: Failed to enqueue dataplane uninstall",
640 case ZEBRA_DPLANE_REQUEST_SUCCESS
:
649 /* Uninstall the route from kernel. */
650 static void rib_uninstall(struct route_node
*rn
, struct route_entry
*re
)
652 rib_table_info_t
*info
= srcdest_rnode_table_info(rn
);
653 rib_dest_t
*dest
= rib_dest_from_rnode(rn
);
654 struct nexthop
*nexthop
;
656 if (dest
&& dest
->selected_fib
== re
) {
657 if (info
->safi
== SAFI_UNICAST
)
658 hook_call(rib_update
, rn
, "rib_uninstall");
660 /* If labeled-unicast route, uninstall transit LSP. */
661 if (zebra_rib_labeled_unicast(re
))
662 zebra_mpls_lsp_uninstall(info
->zvrf
, rn
, re
);
664 rib_uninstall_kernel(rn
, re
);
666 dest
->selected_fib
= NULL
;
668 /* Free FIB nexthop group, if present */
669 if (re
->fib_ng
.nexthop
) {
670 nexthops_free(re
->fib_ng
.nexthop
);
671 re
->fib_ng
.nexthop
= NULL
;
674 for (ALL_NEXTHOPS_PTR(re
->ng
, nexthop
))
675 UNSET_FLAG(nexthop
->flags
, NEXTHOP_FLAG_FIB
);
678 if (CHECK_FLAG(re
->flags
, ZEBRA_FLAG_SELECTED
)) {
679 const struct prefix
*p
, *src_p
;
681 srcdest_rnode_prefixes(rn
, &p
, &src_p
);
683 redistribute_delete(p
, src_p
, re
, NULL
);
684 UNSET_FLAG(re
->flags
, ZEBRA_FLAG_SELECTED
);
689 * rib_can_delete_dest
691 * Returns true if the given dest can be deleted from the table.
693 static int rib_can_delete_dest(rib_dest_t
*dest
)
695 if (re_list_first(&dest
->routes
)) {
700 * Unresolved rnh's are stored on the default route's list
702 * dest->rnode can also be the source prefix node in an
703 * ipv6 sourcedest table. Fortunately the prefix of a
704 * source prefix node can never be the default prefix.
706 if (is_default_prefix(&dest
->rnode
->p
))
710 * Don't delete the dest if we have to update the FPM about this
713 if (CHECK_FLAG(dest
->flags
, RIB_DEST_UPDATE_FPM
)
714 || CHECK_FLAG(dest
->flags
, RIB_DEST_SENT_TO_FPM
))
720 void zebra_rib_evaluate_rn_nexthops(struct route_node
*rn
, uint32_t seq
)
722 rib_dest_t
*dest
= rib_dest_from_rnode(rn
);
726 * We are storing the rnh's associated withb
727 * the tracked nexthop as a list of the rn's.
728 * Unresolved rnh's are placed at the top
729 * of the tree list.( 0.0.0.0/0 for v4 and 0::0/0 for v6 )
730 * As such for each rn we need to walk up the tree
731 * and see if any rnh's need to see if they
732 * would match a more specific route
735 if (IS_ZEBRA_DEBUG_NHT_DETAILED
) {
736 char buf
[PREFIX_STRLEN
];
738 zlog_debug("%s: %s Being examined for Nexthop Tracking Count: %zd",
740 srcdest_rnode2str(rn
, buf
, sizeof(buf
)),
741 dest
? rnh_list_count(&dest
->nht
) : 0);
746 dest
= rib_dest_from_rnode(rn
);
750 * If we have any rnh's stored in the nht list
751 * then we know that this route node was used for
752 * nht resolution and as such we need to call the
753 * nexthop tracking evaluation code
755 frr_each_safe(rnh_list
, &dest
->nht
, rnh
) {
756 struct zebra_vrf
*zvrf
=
757 zebra_vrf_lookup_by_id(rnh
->vrf_id
);
758 struct prefix
*p
= &rnh
->node
->p
;
760 if (IS_ZEBRA_DEBUG_NHT_DETAILED
) {
761 char buf1
[PREFIX_STRLEN
];
762 char buf2
[PREFIX_STRLEN
];
764 zlog_debug("%u:%s has Nexthop(%s) Type: %s depending on it, evaluating %u:%u",
766 srcdest_rnode2str(rn
, buf1
,
768 prefix2str(p
, buf2
, sizeof(buf2
)),
769 rnh_type2str(rnh
->type
),
774 * If we have evaluated this node on this pass
775 * already, due to following the tree up
776 * then we know that we can move onto the next
779 * Additionally we call zebra_evaluate_rnh
780 * when we gc the dest. In this case we know
781 * that there must be no other re's where
782 * we were originally as such we know that
783 * that sequence number is ok to respect.
785 if (rnh
->seqno
== seq
) {
786 if (IS_ZEBRA_DEBUG_NHT_DETAILED
)
788 "\tNode processed and moved already");
793 zebra_evaluate_rnh(zvrf
, family2afi(p
->family
), 0,
799 dest
= rib_dest_from_rnode(rn
);
806 * Garbage collect the rib dest corresponding to the given route node
809 * Returns true if the dest was deleted, false otherwise.
811 int rib_gc_dest(struct route_node
*rn
)
815 dest
= rib_dest_from_rnode(rn
);
819 if (!rib_can_delete_dest(dest
))
822 if (IS_ZEBRA_DEBUG_RIB
) {
823 struct zebra_vrf
*zvrf
;
825 zvrf
= rib_dest_vrf(dest
);
826 rnode_debug(rn
, zvrf_id(zvrf
), "removing dest from table");
829 zebra_rib_evaluate_rn_nexthops(rn
, zebra_router_get_next_sequence());
832 rnh_list_fini(&dest
->nht
);
833 XFREE(MTYPE_RIB_DEST
, dest
);
837 * Release the one reference that we keep on the route node.
839 route_unlock_node(rn
);
843 static void rib_process_add_fib(struct zebra_vrf
*zvrf
, struct route_node
*rn
,
844 struct route_entry
*new)
846 hook_call(rib_update
, rn
, "new route selected");
848 /* Update real nexthop. This may actually determine if nexthop is active
850 if (!nexthop_group_active_nexthop_num(new->ng
)) {
851 UNSET_FLAG(new->status
, ROUTE_ENTRY_CHANGED
);
855 if (IS_ZEBRA_DEBUG_RIB
) {
856 char buf
[SRCDEST2STR_BUFFER
];
857 srcdest_rnode2str(rn
, buf
, sizeof(buf
));
858 zlog_debug("%u:%s: Adding route rn %p, re %p (%s)",
859 zvrf_id(zvrf
), buf
, rn
, new,
860 zebra_route_string(new->type
));
863 /* If labeled-unicast route, install transit LSP. */
864 if (zebra_rib_labeled_unicast(new))
865 zebra_mpls_lsp_install(zvrf
, rn
, new);
867 rib_install_kernel(rn
, new, NULL
);
869 UNSET_FLAG(new->status
, ROUTE_ENTRY_CHANGED
);
872 static void rib_process_del_fib(struct zebra_vrf
*zvrf
, struct route_node
*rn
,
873 struct route_entry
*old
)
875 hook_call(rib_update
, rn
, "removing existing route");
877 /* Uninstall from kernel. */
878 if (IS_ZEBRA_DEBUG_RIB
) {
879 char buf
[SRCDEST2STR_BUFFER
];
880 srcdest_rnode2str(rn
, buf
, sizeof(buf
));
881 zlog_debug("%u:%s: Deleting route rn %p, re %p (%s)",
882 zvrf_id(zvrf
), buf
, rn
, old
,
883 zebra_route_string(old
->type
));
886 /* If labeled-unicast route, uninstall transit LSP. */
887 if (zebra_rib_labeled_unicast(old
))
888 zebra_mpls_lsp_uninstall(zvrf
, rn
, old
);
890 rib_uninstall_kernel(rn
, old
);
892 /* Update nexthop for route, reset changed flag. */
893 /* Note: this code also handles the Linux case when an interface goes
894 * down, causing the kernel to delete routes without sending DELROUTE
897 if (RIB_KERNEL_ROUTE(old
))
898 SET_FLAG(old
->status
, ROUTE_ENTRY_REMOVED
);
900 UNSET_FLAG(old
->status
, ROUTE_ENTRY_CHANGED
);
903 static void rib_process_update_fib(struct zebra_vrf
*zvrf
,
904 struct route_node
*rn
,
905 struct route_entry
*old
,
906 struct route_entry
*new)
911 * We have to install or update if a new route has been selected or
912 * something has changed.
914 if (new != old
|| CHECK_FLAG(new->status
, ROUTE_ENTRY_CHANGED
)) {
915 hook_call(rib_update
, rn
, "updating existing route");
917 /* Update the nexthop; we could determine here that nexthop is
919 if (nexthop_group_active_nexthop_num(new->ng
))
922 /* If nexthop is active, install the selected route, if
924 * the install succeeds, cleanup flags for prior route, if
929 if (IS_ZEBRA_DEBUG_RIB
) {
930 char buf
[SRCDEST2STR_BUFFER
];
931 srcdest_rnode2str(rn
, buf
, sizeof(buf
));
934 "%u:%s: Updating route rn %p, re %p (%s) old %p (%s)",
935 zvrf_id(zvrf
), buf
, rn
, new,
936 zebra_route_string(new->type
),
938 zebra_route_string(old
->type
));
941 "%u:%s: Updating route rn %p, re %p (%s)",
942 zvrf_id(zvrf
), buf
, rn
, new,
943 zebra_route_string(new->type
));
946 /* If labeled-unicast route, uninstall transit LSP. */
947 if (zebra_rib_labeled_unicast(old
))
948 zebra_mpls_lsp_uninstall(zvrf
, rn
, old
);
951 * Non-system route should be installed.
952 * If labeled-unicast route, install transit
955 if (zebra_rib_labeled_unicast(new))
956 zebra_mpls_lsp_install(zvrf
, rn
, new);
958 rib_install_kernel(rn
, new, old
);
962 * If nexthop for selected route is not active or install
964 * may need to uninstall and delete for redistribution.
967 if (IS_ZEBRA_DEBUG_RIB
) {
968 char buf
[SRCDEST2STR_BUFFER
];
969 srcdest_rnode2str(rn
, buf
, sizeof(buf
));
972 "%u:%s: Deleting route rn %p, re %p (%s) old %p (%s) - nexthop inactive",
973 zvrf_id(zvrf
), buf
, rn
, new,
974 zebra_route_string(new->type
),
976 zebra_route_string(old
->type
));
979 "%u:%s: Deleting route rn %p, re %p (%s) - nexthop inactive",
980 zvrf_id(zvrf
), buf
, rn
, new,
981 zebra_route_string(new->type
));
984 /* If labeled-unicast route, uninstall transit LSP. */
985 if (zebra_rib_labeled_unicast(old
))
986 zebra_mpls_lsp_uninstall(zvrf
, rn
, old
);
988 rib_uninstall_kernel(rn
, old
);
992 * Same route selected; check if in the FIB and if not,
993 * re-install. This is housekeeping code to deal with
994 * race conditions in kernel with linux netlink reporting
995 * interface up before IPv4 or IPv6 protocol is ready
998 if (!CHECK_FLAG(new->status
, ROUTE_ENTRY_INSTALLED
) ||
999 RIB_SYSTEM_ROUTE(new))
1000 rib_install_kernel(rn
, new, NULL
);
1003 /* Update prior route. */
1005 UNSET_FLAG(old
->status
, ROUTE_ENTRY_CHANGED
);
1007 /* Clear changed flag. */
1008 UNSET_FLAG(new->status
, ROUTE_ENTRY_CHANGED
);
1011 /* Check if 'alternate' RIB entry is better than 'current'. */
1012 static struct route_entry
*rib_choose_best(struct route_entry
*current
,
1013 struct route_entry
*alternate
)
1015 if (current
== NULL
)
1018 /* filter route selection in following order:
1019 * - connected beats other types
1020 * - if both connected, loopback or vrf wins
1021 * - lower distance beats higher
1022 * - lower metric beats higher for equal distance
1023 * - last, hence oldest, route wins tie break.
1026 /* Connected routes. Check to see if either are a vrf
1027 * or loopback interface. If not, pick the last connected
1028 * route of the set of lowest metric connected routes.
1030 if (alternate
->type
== ZEBRA_ROUTE_CONNECT
) {
1031 if (current
->type
!= ZEBRA_ROUTE_CONNECT
)
1034 /* both are connected. are either loop or vrf? */
1035 struct nexthop
*nexthop
= NULL
;
1037 for (ALL_NEXTHOPS_PTR(alternate
->ng
, nexthop
)) {
1038 struct interface
*ifp
= if_lookup_by_index(
1039 nexthop
->ifindex
, alternate
->vrf_id
);
1041 if (ifp
&& if_is_loopback_or_vrf(ifp
))
1045 for (ALL_NEXTHOPS_PTR(current
->ng
, nexthop
)) {
1046 struct interface
*ifp
= if_lookup_by_index(
1047 nexthop
->ifindex
, current
->vrf_id
);
1049 if (ifp
&& if_is_loopback_or_vrf(ifp
))
1053 /* Neither are loop or vrf so pick best metric */
1054 if (alternate
->metric
<= current
->metric
)
1060 if (current
->type
== ZEBRA_ROUTE_CONNECT
)
1063 /* higher distance loses */
1064 if (alternate
->distance
< current
->distance
)
1066 if (current
->distance
< alternate
->distance
)
1069 /* metric tie-breaks equal distance */
1070 if (alternate
->metric
<= current
->metric
)
1076 /* Core function for processing nexthop group contexts's off metaq */
1077 static void rib_nhg_process(struct nhg_ctx
*ctx
)
1079 nhg_ctx_process(ctx
);
1082 /* Core function for processing routing information base. */
1083 static void rib_process(struct route_node
*rn
)
1085 struct route_entry
*re
;
1086 struct route_entry
*next
;
1087 struct route_entry
*old_selected
= NULL
;
1088 struct route_entry
*new_selected
= NULL
;
1089 struct route_entry
*old_fib
= NULL
;
1090 struct route_entry
*new_fib
= NULL
;
1091 struct route_entry
*best
= NULL
;
1092 char buf
[SRCDEST2STR_BUFFER
];
1094 struct zebra_vrf
*zvrf
= NULL
;
1095 const struct prefix
*p
, *src_p
;
1097 srcdest_rnode_prefixes(rn
, &p
, &src_p
);
1098 vrf_id_t vrf_id
= VRF_UNKNOWN
;
1102 dest
= rib_dest_from_rnode(rn
);
1104 zvrf
= rib_dest_vrf(dest
);
1105 vrf_id
= zvrf_id(zvrf
);
1108 if (IS_ZEBRA_DEBUG_RIB
)
1109 srcdest_rnode2str(rn
, buf
, sizeof(buf
));
1111 if (IS_ZEBRA_DEBUG_RIB_DETAILED
)
1112 zlog_debug("%u:%s: Processing rn %p", vrf_id
, buf
, rn
);
1115 * we can have rn's that have a NULL info pointer
1116 * (dest). As such let's not let the deref happen
1117 * additionally we know RNODE_FOREACH_RE_SAFE
1118 * will not iterate so we are ok.
1121 old_fib
= dest
->selected_fib
;
1123 RNODE_FOREACH_RE_SAFE (rn
, re
, next
) {
1124 if (IS_ZEBRA_DEBUG_RIB_DETAILED
)
1126 "%u:%s: Examine re %p (%s) status %x flags %x dist %d metric %d",
1127 vrf_id
, buf
, re
, zebra_route_string(re
->type
),
1128 re
->status
, re
->flags
, re
->distance
,
1131 /* Currently selected re. */
1132 if (CHECK_FLAG(re
->flags
, ZEBRA_FLAG_SELECTED
)) {
1133 assert(old_selected
== NULL
);
1137 /* Skip deleted entries from selection */
1138 if (CHECK_FLAG(re
->status
, ROUTE_ENTRY_REMOVED
))
1141 /* Skip unreachable nexthop. */
1142 /* This first call to nexthop_active_update is merely to
1143 * determine if there's any change to nexthops associated
1144 * with this RIB entry. Now, rib_process() can be invoked due
1145 * to an external event such as link down or due to
1146 * next-hop-tracking evaluation. In the latter case,
1147 * a decision has already been made that the NHs have changed.
1148 * So, no need to invoke a potentially expensive call again.
1149 * Further, since the change might be in a recursive NH which
1150 * is not caught in the nexthop_active_update() code. Thus, we
1151 * might miss changes to recursive NHs.
1153 if (CHECK_FLAG(re
->status
, ROUTE_ENTRY_CHANGED
)
1154 && !nexthop_active_update(rn
, re
)) {
1155 if (re
->type
== ZEBRA_ROUTE_TABLE
) {
1156 /* XXX: HERE BE DRAGONS!!!!!
1157 * In all honesty, I have not yet figured out
1158 * what this part does or why the
1159 * ROUTE_ENTRY_CHANGED test above is correct
1160 * or why we need to delete a route here, and
1161 * also not whether this concerns both selected
1162 * and fib route, or only selected
1165 * This entry was denied by the 'ip protocol
1166 * table' route-map, we need to delete it */
1167 if (re
!= old_selected
) {
1168 if (IS_ZEBRA_DEBUG_RIB
)
1170 "%s: %u:%s: imported via import-table but denied "
1171 "by the ip protocol table route-map",
1172 __func__
, vrf_id
, buf
);
1175 SET_FLAG(re
->status
,
1176 ROUTE_ENTRY_REMOVED
);
1182 /* Infinite distance. */
1183 if (re
->distance
== DISTANCE_INFINITY
) {
1184 UNSET_FLAG(re
->status
, ROUTE_ENTRY_CHANGED
);
1188 if (CHECK_FLAG(re
->flags
, ZEBRA_FLAG_FIB_OVERRIDE
)) {
1189 best
= rib_choose_best(new_fib
, re
);
1190 if (new_fib
&& best
!= new_fib
)
1191 UNSET_FLAG(new_fib
->status
,
1192 ROUTE_ENTRY_CHANGED
);
1195 best
= rib_choose_best(new_selected
, re
);
1196 if (new_selected
&& best
!= new_selected
)
1197 UNSET_FLAG(new_selected
->status
,
1198 ROUTE_ENTRY_CHANGED
);
1199 new_selected
= best
;
1202 UNSET_FLAG(re
->status
, ROUTE_ENTRY_CHANGED
);
1203 } /* RNODE_FOREACH_RE */
1205 /* If no FIB override route, use the selected route also for FIB */
1206 if (new_fib
== NULL
)
1207 new_fib
= new_selected
;
1209 /* After the cycle is finished, the following pointers will be set:
1210 * old_selected --- RE entry currently having SELECTED
1211 * new_selected --- RE entry that is newly SELECTED
1212 * old_fib --- RE entry currently in kernel FIB
1213 * new_fib --- RE entry that is newly to be in kernel FIB
1215 * new_selected will get SELECTED flag, and is going to be redistributed
1216 * the zclients. new_fib (which can be new_selected) will be installed
1220 if (IS_ZEBRA_DEBUG_RIB_DETAILED
) {
1222 "%u:%s: After processing: old_selected %p new_selected %p old_fib %p new_fib %p",
1223 vrf_id
, buf
, (void *)old_selected
, (void *)new_selected
,
1224 (void *)old_fib
, (void *)new_fib
);
1227 /* Buffer ROUTE_ENTRY_CHANGED here, because it will get cleared if
1228 * fib == selected */
1229 bool selected_changed
= new_selected
&& CHECK_FLAG(new_selected
->status
,
1230 ROUTE_ENTRY_CHANGED
);
1232 /* Update fib according to selection results */
1233 if (new_fib
&& old_fib
)
1234 rib_process_update_fib(zvrf
, rn
, old_fib
, new_fib
);
1236 rib_process_add_fib(zvrf
, rn
, new_fib
);
1238 rib_process_del_fib(zvrf
, rn
, old_fib
);
1240 /* Update SELECTED entry */
1241 if (old_selected
!= new_selected
|| selected_changed
) {
1243 if (new_selected
&& new_selected
!= new_fib
)
1244 UNSET_FLAG(new_selected
->status
, ROUTE_ENTRY_CHANGED
);
1247 SET_FLAG(new_selected
->flags
, ZEBRA_FLAG_SELECTED
);
1251 * If we're removing the old entry, we should tell
1252 * redist subscribers about that *if* they aren't
1253 * going to see a redist for the new entry.
1255 if (!new_selected
|| CHECK_FLAG(old_selected
->status
,
1256 ROUTE_ENTRY_REMOVED
))
1257 redistribute_delete(p
, src_p
,
1261 if (old_selected
!= new_selected
)
1262 UNSET_FLAG(old_selected
->flags
,
1263 ZEBRA_FLAG_SELECTED
);
1267 /* Remove all RE entries queued for removal */
1268 RNODE_FOREACH_RE_SAFE (rn
, re
, next
) {
1269 if (CHECK_FLAG(re
->status
, ROUTE_ENTRY_REMOVED
)) {
1270 if (IS_ZEBRA_DEBUG_RIB
) {
1271 rnode_debug(rn
, vrf_id
, "rn %p, removing re %p",
1272 (void *)rn
, (void *)re
);
1279 * Check if the dest can be deleted now.
1284 static void zebra_rib_evaluate_mpls(struct route_node
*rn
)
1286 rib_dest_t
*dest
= rib_dest_from_rnode(rn
);
1287 struct zebra_vrf
*zvrf
= vrf_info_lookup(VRF_DEFAULT
);
1292 if (CHECK_FLAG(dest
->flags
, RIB_DEST_UPDATE_LSPS
)) {
1293 if (IS_ZEBRA_DEBUG_MPLS
)
1295 "%u: Scheduling all LSPs upon RIB completion",
1297 zebra_mpls_lsp_schedule(zvrf
);
1298 mpls_unmark_lsps_for_processing(rn
);
1303 * Utility to match route with dplane context data
1305 static bool rib_route_match_ctx(const struct route_entry
*re
,
1306 const struct zebra_dplane_ctx
*ctx
,
1309 bool result
= false;
1313 * In 'update' case, we test info about the 'previous' or
1316 if ((re
->type
== dplane_ctx_get_old_type(ctx
)) &&
1317 (re
->instance
== dplane_ctx_get_old_instance(ctx
))) {
1320 /* TODO -- we're using this extra test, but it's not
1321 * exactly clear why.
1323 if (re
->type
== ZEBRA_ROUTE_STATIC
&&
1324 (re
->distance
!= dplane_ctx_get_old_distance(ctx
) ||
1325 re
->tag
!= dplane_ctx_get_old_tag(ctx
))) {
1332 * Ordinary, single-route case using primary context info
1334 if ((dplane_ctx_get_op(ctx
) != DPLANE_OP_ROUTE_DELETE
) &&
1335 CHECK_FLAG(re
->status
, ROUTE_ENTRY_REMOVED
)) {
1336 /* Skip route that's been deleted */
1340 if ((re
->type
== dplane_ctx_get_type(ctx
)) &&
1341 (re
->instance
== dplane_ctx_get_instance(ctx
))) {
1344 /* TODO -- we're using this extra test, but it's not
1345 * exactly clear why.
1347 if (re
->type
== ZEBRA_ROUTE_STATIC
&&
1348 (re
->distance
!= dplane_ctx_get_distance(ctx
) ||
1349 re
->tag
!= dplane_ctx_get_tag(ctx
))) {
1360 static void zebra_rib_fixup_system(struct route_node
*rn
)
1362 struct route_entry
*re
;
1364 RNODE_FOREACH_RE(rn
, re
) {
1365 struct nexthop
*nhop
;
1367 if (!RIB_SYSTEM_ROUTE(re
))
1370 if (CHECK_FLAG(re
->status
, ROUTE_ENTRY_REMOVED
))
1373 SET_FLAG(re
->status
, ROUTE_ENTRY_INSTALLED
);
1374 UNSET_FLAG(re
->status
, ROUTE_ENTRY_QUEUED
);
1376 for (ALL_NEXTHOPS_PTR(re
->ng
, nhop
)) {
1377 if (CHECK_FLAG(nhop
->flags
, NEXTHOP_FLAG_RECURSIVE
))
1380 SET_FLAG(nhop
->flags
, NEXTHOP_FLAG_FIB
);
1386 * Update a route from a dplane context. This consolidates common code
1387 * that can be used in processing of results from FIB updates, and in
1388 * async notification processing.
1389 * The return is 'true' if the installed nexthops changed; 'false' otherwise.
1391 static bool rib_update_re_from_ctx(struct route_entry
*re
,
1392 struct route_node
*rn
,
1393 struct zebra_dplane_ctx
*ctx
)
1395 char dest_str
[PREFIX_STRLEN
] = "";
1396 char nh_str
[NEXTHOP_STRLEN
];
1397 struct nexthop
*nexthop
, *ctx_nexthop
;
1399 const struct nexthop_group
*ctxnhg
;
1400 bool is_selected
= false; /* Is 're' currently the selected re? */
1401 bool changed_p
= false; /* Change to nexthops? */
1404 /* Note well: only capturing the prefix string if debug is enabled here;
1405 * unconditional log messages will have to generate the string.
1407 if (IS_ZEBRA_DEBUG_RIB
)
1408 prefix2str(&(rn
->p
), dest_str
, sizeof(dest_str
));
1410 dest
= rib_dest_from_rnode(rn
);
1412 is_selected
= (re
== dest
->selected_fib
);
1414 if (IS_ZEBRA_DEBUG_RIB_DETAILED
)
1415 zlog_debug("update_from_ctx: %u:%s: %sSELECTED",
1416 re
->vrf_id
, dest_str
, (is_selected
? "" : "NOT "));
1418 /* Update zebra's nexthop FIB flag for each nexthop that was installed.
1419 * If the installed set differs from the set requested by the rib/owner,
1420 * we use the fib-specific nexthop-group to record the actual FIB
1424 /* Check both fib group and notif group for equivalence.
1426 * Let's assume the nexthops are ordered here to save time.
1428 if (nexthop_group_equal(&re
->fib_ng
, dplane_ctx_get_ng(ctx
)) == false) {
1429 if (IS_ZEBRA_DEBUG_RIB_DETAILED
) {
1431 "%u:%s update_from_ctx: notif nh and fib nh mismatch",
1432 re
->vrf_id
, dest_str
);
1439 /* If the new FIB set matches the existing FIB set, we're done. */
1441 if (IS_ZEBRA_DEBUG_RIB
)
1442 zlog_debug("%u:%s update_from_ctx(): existing fib nhg, no change",
1443 re
->vrf_id
, dest_str
);
1446 } else if (re
->fib_ng
.nexthop
) {
1448 * Free stale fib list and move on to check the rib nhg.
1450 if (IS_ZEBRA_DEBUG_RIB
)
1451 zlog_debug("%u:%s update_from_ctx(): replacing fib nhg",
1452 re
->vrf_id
, dest_str
);
1453 nexthops_free(re
->fib_ng
.nexthop
);
1454 re
->fib_ng
.nexthop
= NULL
;
1456 /* Note that the installed nexthops have changed */
1459 if (IS_ZEBRA_DEBUG_RIB
)
1460 zlog_debug("%u:%s update_from_ctx(): no fib nhg",
1461 re
->vrf_id
, dest_str
);
1465 * Compare with the rib nexthop group. The comparison here is different:
1466 * the RIB group may be a superset of the list installed in the FIB. We
1467 * walk the RIB group, looking for the 'installable' candidate
1468 * nexthops, and then check those against the set
1469 * that is actually installed.
1471 * Assume nexthops are ordered here as well.
1475 ctx_nexthop
= dplane_ctx_get_ng(ctx
)->nexthop
;
1477 /* Get the first `installed` one to check against.
1478 * If the dataplane doesn't set these to be what was actually installed,
1479 * it will just be whatever was in re->ng?
1481 if (CHECK_FLAG(ctx_nexthop
->flags
, NEXTHOP_FLAG_RECURSIVE
)
1482 || !CHECK_FLAG(ctx_nexthop
->flags
, NEXTHOP_FLAG_ACTIVE
))
1483 ctx_nexthop
= nexthop_next_active_resolved(ctx_nexthop
);
1485 for (ALL_NEXTHOPS_PTR(re
->ng
, nexthop
)) {
1487 if (CHECK_FLAG(nexthop
->flags
, NEXTHOP_FLAG_RECURSIVE
))
1490 if (!CHECK_FLAG(nexthop
->flags
, NEXTHOP_FLAG_ACTIVE
))
1493 /* Check for a FIB nexthop corresponding to the RIB nexthop */
1494 if (nexthop_same(ctx_nexthop
, nexthop
) == false) {
1495 /* If the FIB doesn't know about the nexthop,
1496 * it's not installed
1498 if (IS_ZEBRA_DEBUG_RIB_DETAILED
) {
1499 nexthop2str(nexthop
, nh_str
, sizeof(nh_str
));
1501 "update_from_ctx: no notif match for rib nh %s",
1506 if (CHECK_FLAG(nexthop
->flags
, NEXTHOP_FLAG_FIB
))
1509 UNSET_FLAG(nexthop
->flags
, NEXTHOP_FLAG_FIB
);
1511 /* Keep checking nexthops */
1515 if (CHECK_FLAG(ctx_nexthop
->flags
, NEXTHOP_FLAG_FIB
)) {
1516 if (!CHECK_FLAG(nexthop
->flags
, NEXTHOP_FLAG_FIB
))
1519 SET_FLAG(nexthop
->flags
, NEXTHOP_FLAG_FIB
);
1521 if (CHECK_FLAG(nexthop
->flags
, NEXTHOP_FLAG_FIB
))
1524 UNSET_FLAG(nexthop
->flags
, NEXTHOP_FLAG_FIB
);
1527 ctx_nexthop
= nexthop_next_active_resolved(ctx_nexthop
);
1530 /* If all nexthops were processed, we're done */
1532 if (IS_ZEBRA_DEBUG_RIB
)
1533 zlog_debug("%u:%s update_from_ctx(): rib nhg matched, changed '%s'",
1534 re
->vrf_id
, dest_str
,
1535 (changed_p
? "true" : "false"));
1539 /* FIB nexthop set differs from the RIB set:
1540 * create a fib-specific nexthop-group
1542 if (IS_ZEBRA_DEBUG_RIB
)
1543 zlog_debug("%u:%s update_from_ctx(): changed %s, adding new fib nhg",
1544 re
->vrf_id
, dest_str
,
1545 (changed_p
? "true" : "false"));
1547 ctxnhg
= dplane_ctx_get_ng(ctx
);
1549 if (ctxnhg
->nexthop
)
1550 copy_nexthops(&(re
->fib_ng
.nexthop
), ctxnhg
->nexthop
, NULL
);
1552 /* Bit of a special case when the fib has _no_ installed
1555 nexthop
= nexthop_new();
1556 nexthop
->type
= NEXTHOP_TYPE_IPV4
;
1557 _nexthop_add(&(re
->fib_ng
.nexthop
), nexthop
);
1565 * Helper to locate a zebra route-node from a dplane context. This is used
1566 * when processing dplane results, e.g. Note well: the route-node is returned
1567 * with a ref held - route_unlock_node() must be called eventually.
1569 static struct route_node
*
1570 rib_find_rn_from_ctx(const struct zebra_dplane_ctx
*ctx
)
1572 struct route_table
*table
= NULL
;
1573 struct route_node
*rn
= NULL
;
1574 const struct prefix
*dest_pfx
, *src_pfx
;
1576 /* Locate rn and re(s) from ctx */
1578 table
= zebra_vrf_table_with_table_id(dplane_ctx_get_afi(ctx
),
1579 dplane_ctx_get_safi(ctx
),
1580 dplane_ctx_get_vrf(ctx
),
1581 dplane_ctx_get_table(ctx
));
1582 if (table
== NULL
) {
1583 if (IS_ZEBRA_DEBUG_DPLANE
) {
1584 zlog_debug("Failed to find route for ctx: no table for afi %d, safi %d, vrf %u",
1585 dplane_ctx_get_afi(ctx
),
1586 dplane_ctx_get_safi(ctx
),
1587 dplane_ctx_get_vrf(ctx
));
1592 dest_pfx
= dplane_ctx_get_dest(ctx
);
1593 src_pfx
= dplane_ctx_get_src(ctx
);
1595 rn
= srcdest_rnode_get(table
, dest_pfx
,
1596 src_pfx
? (struct prefix_ipv6
*)src_pfx
: NULL
);
1605 * Route-update results processing after async dataplane update.
1607 static void rib_process_result(struct zebra_dplane_ctx
*ctx
)
1609 struct zebra_vrf
*zvrf
= NULL
;
1610 struct route_node
*rn
= NULL
;
1611 struct route_entry
*re
= NULL
, *old_re
= NULL
, *rib
;
1612 bool is_update
= false;
1613 char dest_str
[PREFIX_STRLEN
] = "";
1614 enum dplane_op_e op
;
1615 enum zebra_dplane_result status
;
1616 const struct prefix
*dest_pfx
, *src_pfx
;
1618 bool fib_changed
= false;
1620 zvrf
= vrf_info_lookup(dplane_ctx_get_vrf(ctx
));
1621 dest_pfx
= dplane_ctx_get_dest(ctx
);
1623 /* Note well: only capturing the prefix string if debug is enabled here;
1624 * unconditional log messages will have to generate the string.
1626 if (IS_ZEBRA_DEBUG_DPLANE
)
1627 prefix2str(dest_pfx
, dest_str
, sizeof(dest_str
));
1629 /* Locate rn and re(s) from ctx */
1630 rn
= rib_find_rn_from_ctx(ctx
);
1632 if (IS_ZEBRA_DEBUG_DPLANE
) {
1633 zlog_debug("Failed to process dplane results: no route for %u:%s",
1634 dplane_ctx_get_vrf(ctx
), dest_str
);
1639 srcdest_rnode_prefixes(rn
, &dest_pfx
, &src_pfx
);
1641 op
= dplane_ctx_get_op(ctx
);
1642 status
= dplane_ctx_get_status(ctx
);
1644 if (IS_ZEBRA_DEBUG_DPLANE_DETAIL
)
1645 zlog_debug("%u:%s Processing dplane ctx %p, op %s result %s",
1646 dplane_ctx_get_vrf(ctx
), dest_str
, ctx
,
1647 dplane_op2str(op
), dplane_res2str(status
));
1650 * Update is a bit of a special case, where we may have both old and new
1651 * routes to post-process.
1653 is_update
= dplane_ctx_is_update(ctx
);
1656 * Take a pass through the routes, look for matches with the context
1659 RNODE_FOREACH_RE(rn
, rib
) {
1662 if (rib_route_match_ctx(rib
, ctx
, false))
1666 /* Check for old route match */
1667 if (is_update
&& (old_re
== NULL
)) {
1668 if (rib_route_match_ctx(rib
, ctx
, true /*is_update*/))
1672 /* Have we found the routes we need to work on? */
1673 if (re
&& ((!is_update
|| old_re
)))
1677 seq
= dplane_ctx_get_seq(ctx
);
1680 * Check sequence number(s) to detect stale results before continuing
1683 if (re
->dplane_sequence
!= seq
) {
1684 if (IS_ZEBRA_DEBUG_DPLANE_DETAIL
)
1685 zlog_debug("%u:%s Stale dplane result for re %p",
1686 dplane_ctx_get_vrf(ctx
),
1689 UNSET_FLAG(re
->status
, ROUTE_ENTRY_QUEUED
);
1693 if (old_re
->dplane_sequence
!= dplane_ctx_get_old_seq(ctx
)) {
1694 if (IS_ZEBRA_DEBUG_DPLANE_DETAIL
)
1695 zlog_debug("%u:%s Stale dplane result for old_re %p",
1696 dplane_ctx_get_vrf(ctx
),
1699 UNSET_FLAG(old_re
->status
, ROUTE_ENTRY_QUEUED
);
1703 case DPLANE_OP_ROUTE_INSTALL
:
1704 case DPLANE_OP_ROUTE_UPDATE
:
1705 if (status
== ZEBRA_DPLANE_REQUEST_SUCCESS
) {
1707 UNSET_FLAG(re
->status
, ROUTE_ENTRY_FAILED
);
1708 SET_FLAG(re
->status
, ROUTE_ENTRY_INSTALLED
);
1711 * On an update operation from the same route type
1712 * context retrieval currently has no way to know
1713 * which was the old and which was the new.
1714 * So don't unset our flags that we just set.
1715 * We know redistribution is ok because the
1716 * old_re in this case is used for nothing
1717 * more than knowing whom to contact if necessary.
1719 if (old_re
&& old_re
!= re
) {
1720 UNSET_FLAG(old_re
->status
, ROUTE_ENTRY_FAILED
);
1721 UNSET_FLAG(old_re
->status
,
1722 ROUTE_ENTRY_INSTALLED
);
1725 /* Update zebra route based on the results in
1726 * the context struct.
1730 rib_update_re_from_ctx(re
, rn
, ctx
);
1733 if (IS_ZEBRA_DEBUG_DPLANE_DETAIL
)
1734 zlog_debug("%u:%s no fib change for re",
1741 redistribute_update(dest_pfx
, src_pfx
,
1746 * System routes are weird in that they
1747 * allow multiple to be installed that match
1748 * to the same prefix, so after we get the
1749 * result we need to clean them up so that
1750 * we can actually use them.
1752 if ((re
&& RIB_SYSTEM_ROUTE(re
)) ||
1753 (old_re
&& RIB_SYSTEM_ROUTE(old_re
)))
1754 zebra_rib_fixup_system(rn
);
1759 /* Notify route owner */
1760 zsend_route_notify_owner_ctx(ctx
, ZAPI_ROUTE_INSTALLED
);
1764 SET_FLAG(re
->status
, ROUTE_ENTRY_FAILED
);
1765 UNSET_FLAG(re
->status
, ROUTE_ENTRY_INSTALLED
);
1767 SET_FLAG(old_re
->status
, ROUTE_ENTRY_FAILED
);
1769 zsend_route_notify_owner(re
, dest_pfx
,
1770 ZAPI_ROUTE_FAIL_INSTALL
);
1772 zlog_warn("%u:%s: Route install failed",
1773 dplane_ctx_get_vrf(ctx
),
1774 prefix2str(dest_pfx
,
1775 dest_str
, sizeof(dest_str
)));
1778 case DPLANE_OP_ROUTE_DELETE
:
1780 SET_FLAG(re
->status
, ROUTE_ENTRY_FAILED
);
1782 * In the delete case, the zebra core datastructs were
1783 * updated (or removed) at the time the delete was issued,
1784 * so we're just notifying the route owner.
1786 if (status
== ZEBRA_DPLANE_REQUEST_SUCCESS
) {
1788 UNSET_FLAG(re
->status
, ROUTE_ENTRY_INSTALLED
);
1789 UNSET_FLAG(re
->status
, ROUTE_ENTRY_FAILED
);
1791 zsend_route_notify_owner_ctx(ctx
, ZAPI_ROUTE_REMOVED
);
1797 SET_FLAG(re
->status
, ROUTE_ENTRY_FAILED
);
1798 zsend_route_notify_owner_ctx(ctx
,
1799 ZAPI_ROUTE_REMOVE_FAIL
);
1801 zlog_warn("%u:%s: Route Deletion failure",
1802 dplane_ctx_get_vrf(ctx
),
1803 prefix2str(dest_pfx
,
1804 dest_str
, sizeof(dest_str
)));
1808 * System routes are weird in that they
1809 * allow multiple to be installed that match
1810 * to the same prefix, so after we get the
1811 * result we need to clean them up so that
1812 * we can actually use them.
1814 if ((re
&& RIB_SYSTEM_ROUTE(re
)) ||
1815 (old_re
&& RIB_SYSTEM_ROUTE(old_re
)))
1816 zebra_rib_fixup_system(rn
);
1822 zebra_rib_evaluate_rn_nexthops(rn
, seq
);
1823 zebra_rib_evaluate_mpls(rn
);
1827 route_unlock_node(rn
);
1829 /* Return context to dataplane module */
1830 dplane_ctx_fini(&ctx
);
1834 * Handle notification from async dataplane: the dataplane has detected
1835 * some change to a route, and notifies zebra so that the control plane
1836 * can reflect that change.
1838 static void rib_process_dplane_notify(struct zebra_dplane_ctx
*ctx
)
1840 struct route_node
*rn
= NULL
;
1841 struct route_entry
*re
= NULL
;
1842 struct nexthop
*nexthop
;
1843 char dest_str
[PREFIX_STRLEN
] = "";
1844 const struct prefix
*dest_pfx
, *src_pfx
;
1846 bool fib_changed
= false;
1847 bool debug_p
= IS_ZEBRA_DEBUG_DPLANE
| IS_ZEBRA_DEBUG_RIB
;
1848 int start_count
, end_count
;
1849 dest_pfx
= dplane_ctx_get_dest(ctx
);
1851 /* Note well: only capturing the prefix string if debug is enabled here;
1852 * unconditional log messages will have to generate the string.
1855 prefix2str(dest_pfx
, dest_str
, sizeof(dest_str
));
1857 /* Locate rn and re(s) from ctx */
1858 rn
= rib_find_rn_from_ctx(ctx
);
1861 zlog_debug("Failed to process dplane notification: no routes for %u:%s",
1862 dplane_ctx_get_vrf(ctx
), dest_str
);
1867 dest
= rib_dest_from_rnode(rn
);
1868 srcdest_rnode_prefixes(rn
, &dest_pfx
, &src_pfx
);
1871 zlog_debug("%u:%s Processing dplane notif ctx %p",
1872 dplane_ctx_get_vrf(ctx
), dest_str
, ctx
);
1875 * Take a pass through the routes, look for matches with the context
1878 RNODE_FOREACH_RE(rn
, re
) {
1879 if (rib_route_match_ctx(re
, ctx
, false /*!update*/))
1883 /* No match? Nothing we can do */
1886 zlog_debug("%u:%s Unable to process dplane notification: no entry for type %s",
1887 dplane_ctx_get_vrf(ctx
), dest_str
,
1889 dplane_ctx_get_type(ctx
)));
1894 /* Ensure we clear the QUEUED flag */
1895 UNSET_FLAG(re
->status
, ROUTE_ENTRY_QUEUED
);
1897 /* Is this a notification that ... matters? We only really care about
1898 * the route that is currently selected for installation.
1900 if (re
!= dest
->selected_fib
) {
1901 /* TODO -- don't skip processing entirely? We might like to
1902 * at least report on the event.
1905 zlog_debug("%u:%s dplane notif, but type %s not selected_fib",
1906 dplane_ctx_get_vrf(ctx
), dest_str
,
1908 dplane_ctx_get_type(ctx
)));
1912 /* We'll want to determine whether the installation status of the
1913 * route has changed: we'll check the status before processing,
1914 * and then again if there's been a change.
1917 for (ALL_NEXTHOPS_PTR(rib_active_nhg(re
), nexthop
)) {
1918 if (CHECK_FLAG(nexthop
->flags
, NEXTHOP_FLAG_FIB
))
1922 /* Update zebra's nexthop FIB flags based on the context struct's
1925 fib_changed
= rib_update_re_from_ctx(re
, rn
, ctx
);
1929 zlog_debug("%u:%s No change from dplane notification",
1930 dplane_ctx_get_vrf(ctx
), dest_str
);
1936 * Perform follow-up work if the actual status of the prefix
1941 for (ALL_NEXTHOPS_PTR(rib_active_nhg(re
), nexthop
)) {
1942 if (CHECK_FLAG(nexthop
->flags
, NEXTHOP_FLAG_FIB
))
1946 /* Various fib transitions: changed nexthops; from installed to
1947 * not-installed; or not-installed to installed.
1949 if (start_count
> 0 && end_count
> 0) {
1951 zlog_debug("%u:%s applied nexthop changes from dplane notification",
1952 dplane_ctx_get_vrf(ctx
), dest_str
);
1954 /* Changed nexthops - update kernel/others */
1955 dplane_route_notif_update(rn
, re
,
1956 DPLANE_OP_ROUTE_UPDATE
, ctx
);
1958 } else if (start_count
== 0 && end_count
> 0) {
1960 zlog_debug("%u:%s installed transition from dplane notification",
1961 dplane_ctx_get_vrf(ctx
), dest_str
);
1963 /* We expect this to be the selected route, so we want
1964 * to tell others about this transition.
1966 SET_FLAG(re
->status
, ROUTE_ENTRY_INSTALLED
);
1968 /* Changed nexthops - update kernel/others */
1969 dplane_route_notif_update(rn
, re
, DPLANE_OP_ROUTE_INSTALL
, ctx
);
1971 /* Redistribute, lsp, and nht update */
1972 redistribute_update(dest_pfx
, src_pfx
, re
, NULL
);
1974 zebra_rib_evaluate_rn_nexthops(
1975 rn
, zebra_router_get_next_sequence());
1977 zebra_rib_evaluate_mpls(rn
);
1979 } else if (start_count
> 0 && end_count
== 0) {
1981 zlog_debug("%u:%s un-installed transition from dplane notification",
1982 dplane_ctx_get_vrf(ctx
), dest_str
);
1984 /* Transition from _something_ installed to _nothing_
1987 /* We expect this to be the selected route, so we want
1988 * to tell others about this transistion.
1990 UNSET_FLAG(re
->status
, ROUTE_ENTRY_INSTALLED
);
1992 /* Changed nexthops - update kernel/others */
1993 dplane_route_notif_update(rn
, re
, DPLANE_OP_ROUTE_DELETE
, ctx
);
1995 /* Redistribute, lsp, and nht update */
1996 redistribute_delete(dest_pfx
, src_pfx
, re
, NULL
);
1998 zebra_rib_evaluate_rn_nexthops(
1999 rn
, zebra_router_get_next_sequence());
2001 zebra_rib_evaluate_mpls(rn
);
2006 route_unlock_node(rn
);
2008 /* Return context to dataplane module */
2009 dplane_ctx_fini(&ctx
);
2012 static void process_subq_nhg(struct listnode
*lnode
)
2014 struct nhg_ctx
*ctx
= NULL
;
2015 uint8_t qindex
= route_info
[ZEBRA_ROUTE_NHG
].meta_q_map
;
2017 ctx
= listgetdata(lnode
);
2022 if (IS_ZEBRA_DEBUG_RIB_DETAILED
)
2023 zlog_debug("NHG Context id=%u dequeued from sub-queue %u",
2026 rib_nhg_process(ctx
);
2029 static void process_subq_route(struct listnode
*lnode
, uint8_t qindex
)
2031 struct route_node
*rnode
= NULL
;
2032 rib_dest_t
*dest
= NULL
;
2033 struct zebra_vrf
*zvrf
= NULL
;
2035 rnode
= listgetdata(lnode
);
2036 dest
= rib_dest_from_rnode(rnode
);
2038 zvrf
= rib_dest_vrf(dest
);
2042 if (IS_ZEBRA_DEBUG_RIB_DETAILED
) {
2043 char buf
[SRCDEST2STR_BUFFER
];
2045 srcdest_rnode2str(rnode
, buf
, sizeof(buf
));
2046 zlog_debug("%u:%s: rn %p dequeued from sub-queue %u",
2047 zvrf
? zvrf_id(zvrf
) : 0, buf
, rnode
, qindex
);
2051 UNSET_FLAG(rib_dest_from_rnode(rnode
)->flags
,
2052 RIB_ROUTE_QUEUED(qindex
));
2057 zlog_debug ("%s: called for route_node (%p, %d) with no ribs",
2058 __func__
, rnode
, rnode
->lock
);
2059 zlog_backtrace(LOG_DEBUG
);
2062 route_unlock_node(rnode
);
2065 /* Take a list of route_node structs and return 1, if there was a record
2066 * picked from it and processed by rib_process(). Don't process more,
2067 * than one RN record; operate only in the specified sub-queue.
2069 static unsigned int process_subq(struct list
*subq
, uint8_t qindex
)
2071 struct listnode
*lnode
= listhead(subq
);
2076 if (qindex
== route_info
[ZEBRA_ROUTE_NHG
].meta_q_map
)
2077 process_subq_nhg(lnode
);
2079 process_subq_route(lnode
, qindex
);
2081 list_delete_node(subq
, lnode
);
2086 /* Dispatch the meta queue by picking, processing and unlocking the next RN from
2087 * a non-empty sub-queue with lowest priority. wq is equal to zebra->ribq and
2089 * is pointed to the meta queue structure.
2091 static wq_item_status
meta_queue_process(struct work_queue
*dummy
, void *data
)
2093 struct meta_queue
*mq
= data
;
2095 uint32_t queue_len
, queue_limit
;
2097 /* Ensure there's room for more dataplane updates */
2098 queue_limit
= dplane_get_in_queue_limit();
2099 queue_len
= dplane_get_in_queue_len();
2100 if (queue_len
> queue_limit
) {
2101 if (IS_ZEBRA_DEBUG_RIB_DETAILED
)
2102 zlog_debug("rib queue: dplane queue len %u, limit %u, retrying",
2103 queue_len
, queue_limit
);
2105 /* Ensure that the meta-queue is actually enqueued */
2106 if (work_queue_empty(zrouter
.ribq
))
2107 work_queue_add(zrouter
.ribq
, zrouter
.mq
);
2109 return WQ_QUEUE_BLOCKED
;
2112 for (i
= 0; i
< MQ_SIZE
; i
++)
2113 if (process_subq(mq
->subq
[i
], i
)) {
2117 return mq
->size
? WQ_REQUEUE
: WQ_SUCCESS
;
2122 * Look into the RN and queue it into the highest priority queue
2123 * at this point in time for processing.
2125 * We will enqueue a route node only once per invocation.
2127 * There are two possibilities here that should be kept in mind.
2128 * If the original invocation has not been pulled off for processing
2129 * yet, A subsuquent invocation can have a route entry with a better
2130 * meta queue index value and we can have a situation where
2131 * we might have the same node enqueued 2 times. Not necessarily
2132 * an optimal situation but it should be ok.
2134 * The other possibility is that the original invocation has not
2135 * been pulled off for processing yet, A subsusquent invocation
2136 * doesn't have a route_entry with a better meta-queue and the
2137 * original metaqueue index value will win and we'll end up with
2138 * the route node enqueued once.
2140 static int rib_meta_queue_add(struct meta_queue
*mq
, void *data
)
2142 struct route_node
*rn
= NULL
;
2143 struct route_entry
*re
= NULL
, *curr_re
= NULL
;
2144 uint8_t qindex
= MQ_SIZE
, curr_qindex
= MQ_SIZE
;
2146 rn
= (struct route_node
*)data
;
2148 RNODE_FOREACH_RE (rn
, curr_re
) {
2149 curr_qindex
= route_info
[curr_re
->type
].meta_q_map
;
2151 if (curr_qindex
<= qindex
) {
2153 qindex
= curr_qindex
;
2160 /* Invariant: at this point we always have rn->info set. */
2161 if (CHECK_FLAG(rib_dest_from_rnode(rn
)->flags
,
2162 RIB_ROUTE_QUEUED(qindex
))) {
2163 if (IS_ZEBRA_DEBUG_RIB_DETAILED
)
2164 rnode_debug(rn
, re
->vrf_id
,
2165 "rn %p is already queued in sub-queue %u",
2166 (void *)rn
, qindex
);
2170 SET_FLAG(rib_dest_from_rnode(rn
)->flags
, RIB_ROUTE_QUEUED(qindex
));
2171 listnode_add(mq
->subq
[qindex
], rn
);
2172 route_lock_node(rn
);
2175 if (IS_ZEBRA_DEBUG_RIB_DETAILED
)
2176 rnode_debug(rn
, re
->vrf_id
, "queued rn %p into sub-queue %u",
2177 (void *)rn
, qindex
);
2182 static int rib_meta_queue_nhg_add(struct meta_queue
*mq
, void *data
)
2184 struct nhg_ctx
*ctx
= NULL
;
2185 uint8_t qindex
= route_info
[ZEBRA_ROUTE_NHG
].meta_q_map
;
2187 ctx
= (struct nhg_ctx
*)data
;
2192 listnode_add(mq
->subq
[qindex
], ctx
);
2195 if (IS_ZEBRA_DEBUG_RIB_DETAILED
)
2196 zlog_debug("NHG Context id=%u queued into sub-queue %u",
2202 static int mq_add_handler(void *data
,
2203 int (*mq_add_func
)(struct meta_queue
*mq
, void *data
))
2205 if (zrouter
.ribq
== NULL
) {
2206 flog_err(EC_ZEBRA_WQ_NONEXISTENT
,
2207 "%s: work_queue does not exist!", __func__
);
2212 * The RIB queue should normally be either empty or holding the only
2213 * work_queue_item element. In the latter case this element would
2214 * hold a pointer to the meta queue structure, which must be used to
2215 * actually queue the route nodes to process. So create the MQ
2216 * holder, if necessary, then push the work into it in any case.
2217 * This semantics was introduced after 0.99.9 release.
2219 if (work_queue_empty(zrouter
.ribq
))
2220 work_queue_add(zrouter
.ribq
, zrouter
.mq
);
2222 return mq_add_func(zrouter
.mq
, data
);
2225 /* Add route_node to work queue and schedule processing */
2226 int rib_queue_add(struct route_node
*rn
)
2230 /* Pointless to queue a route_node with no RIB entries to add or remove
2232 if (!rnode_to_ribs(rn
)) {
2233 zlog_debug("%s: called for route_node (%p, %d) with no ribs",
2234 __func__
, (void *)rn
, rn
->lock
);
2235 zlog_backtrace(LOG_DEBUG
);
2239 return mq_add_handler(rn
, &rib_meta_queue_add
);
2242 int rib_queue_nhg_add(struct nhg_ctx
*ctx
)
2246 return mq_add_handler(ctx
, &rib_meta_queue_nhg_add
);
2249 /* Create new meta queue.
2250 A destructor function doesn't seem to be necessary here.
2252 static struct meta_queue
*meta_queue_new(void)
2254 struct meta_queue
*new;
2257 new = XCALLOC(MTYPE_WORK_QUEUE
, sizeof(struct meta_queue
));
2259 for (i
= 0; i
< MQ_SIZE
; i
++) {
2260 new->subq
[i
] = list_new();
2261 assert(new->subq
[i
]);
2267 void meta_queue_free(struct meta_queue
*mq
)
2271 for (i
= 0; i
< MQ_SIZE
; i
++)
2272 list_delete(&mq
->subq
[i
]);
2274 XFREE(MTYPE_WORK_QUEUE
, mq
);
2277 /* initialise zebra rib work queue */
2278 static void rib_queue_init(void)
2280 if (!(zrouter
.ribq
= work_queue_new(zrouter
.master
,
2281 "route_node processing"))) {
2282 flog_err(EC_ZEBRA_WQ_NONEXISTENT
,
2283 "%s: could not initialise work queue!", __func__
);
2287 /* fill in the work queue spec */
2288 zrouter
.ribq
->spec
.workfunc
= &meta_queue_process
;
2289 zrouter
.ribq
->spec
.errorfunc
= NULL
;
2290 zrouter
.ribq
->spec
.completion_func
= NULL
;
2291 /* XXX: TODO: These should be runtime configurable via vty */
2292 zrouter
.ribq
->spec
.max_retries
= 3;
2293 zrouter
.ribq
->spec
.hold
= ZEBRA_RIB_PROCESS_HOLD_TIME
;
2294 zrouter
.ribq
->spec
.retry
= ZEBRA_RIB_PROCESS_RETRY_TIME
;
2296 if (!(zrouter
.mq
= meta_queue_new())) {
2297 flog_err(EC_ZEBRA_WQ_NONEXISTENT
,
2298 "%s: could not initialise meta queue!", __func__
);
2304 rib_dest_t
*zebra_rib_create_dest(struct route_node
*rn
)
2308 dest
= XCALLOC(MTYPE_RIB_DEST
, sizeof(rib_dest_t
));
2309 rnh_list_init(&dest
->nht
);
2310 route_lock_node(rn
); /* rn route table reference */
2317 /* RIB updates are processed via a queue of pointers to route_nodes.
2319 * The queue length is bounded by the maximal size of the routing table,
2320 * as a route_node will not be requeued, if already queued.
2322 * REs are submitted via rib_addnode or rib_delnode which set minimal
2323 * state, or static_install_route (when an existing RE is updated)
2324 * and then submit route_node to queue for best-path selection later.
2325 * Order of add/delete state changes are preserved for any given RE.
2327 * Deleted REs are reaped during best-path selection.
2330 * |-> rib_link or unset ROUTE_ENTRY_REMOVE |->Update kernel with
2331 * |-------->| | best RE, if required
2333 * static_install->|->rib_addqueue...... -> rib_process
2335 * |-------->| |-> rib_unlink
2336 * |-> set ROUTE_ENTRY_REMOVE |
2337 * rib_delnode (RE freed)
2339 * The 'info' pointer of a route_node points to a rib_dest_t
2340 * ('dest'). Queueing state for a route_node is kept on the dest. The
2341 * dest is created on-demand by rib_link() and is kept around at least
2342 * as long as there are ribs hanging off it (@see rib_gc_dest()).
2344 * Refcounting (aka "locking" throughout the GNU Zebra and Quagga code):
2346 * - route_nodes: refcounted by:
2347 * - dest attached to route_node:
2348 * - managed by: rib_link/rib_gc_dest
2349 * - route_node processing queue
2350 * - managed by: rib_addqueue, rib_process.
2354 /* Add RE to head of the route node. */
2355 static void rib_link(struct route_node
*rn
, struct route_entry
*re
, int process
)
2359 const char *rmap_name
;
2363 dest
= rib_dest_from_rnode(rn
);
2365 if (IS_ZEBRA_DEBUG_RIB_DETAILED
)
2366 rnode_debug(rn
, re
->vrf_id
, "rn %p adding dest", rn
);
2368 dest
= zebra_rib_create_dest(rn
);
2371 re_list_add_head(&dest
->routes
, re
);
2373 afi
= (rn
->p
.family
== AF_INET
)
2375 : (rn
->p
.family
== AF_INET6
) ? AFI_IP6
: AFI_MAX
;
2376 if (is_zebra_import_table_enabled(afi
, re
->vrf_id
, re
->table
)) {
2377 struct zebra_vrf
*zvrf
= zebra_vrf_lookup_by_id(re
->vrf_id
);
2379 rmap_name
= zebra_get_import_table_route_map(afi
, re
->table
);
2380 zebra_add_import_table_entry(zvrf
, rn
, re
, rmap_name
);
2385 static void rib_addnode(struct route_node
*rn
,
2386 struct route_entry
*re
, int process
)
2388 /* RE node has been un-removed before route-node is processed.
2389 * route_node must hence already be on the queue for processing..
2391 if (CHECK_FLAG(re
->status
, ROUTE_ENTRY_REMOVED
)) {
2392 if (IS_ZEBRA_DEBUG_RIB
)
2393 rnode_debug(rn
, re
->vrf_id
, "rn %p, un-removed re %p",
2394 (void *)rn
, (void *)re
);
2396 UNSET_FLAG(re
->status
, ROUTE_ENTRY_REMOVED
);
2399 rib_link(rn
, re
, process
);
2405 * Detach a rib structure from a route_node.
2407 * Note that a call to rib_unlink() should be followed by a call to
2408 * rib_gc_dest() at some point. This allows a rib_dest_t that is no
2409 * longer required to be deleted.
2411 void rib_unlink(struct route_node
*rn
, struct route_entry
*re
)
2414 struct nhg_hash_entry
*nhe
= NULL
;
2418 if (IS_ZEBRA_DEBUG_RIB
)
2419 rnode_debug(rn
, re
->vrf_id
, "rn %p, re %p", (void *)rn
,
2422 dest
= rib_dest_from_rnode(rn
);
2424 re_list_del(&dest
->routes
, re
);
2426 if (dest
->selected_fib
== re
)
2427 dest
->selected_fib
= NULL
;
2430 nhe
= zebra_nhg_lookup_id(re
->nhe_id
);
2432 zebra_nhg_decrement_ref(nhe
);
2434 nexthop_group_delete(&re
->ng
);
2436 nexthops_free(re
->fib_ng
.nexthop
);
2438 XFREE(MTYPE_RE
, re
);
2441 void rib_delnode(struct route_node
*rn
, struct route_entry
*re
)
2445 if (IS_ZEBRA_DEBUG_RIB
)
2446 rnode_debug(rn
, re
->vrf_id
, "rn %p, re %p, removing",
2447 (void *)rn
, (void *)re
);
2448 SET_FLAG(re
->status
, ROUTE_ENTRY_REMOVED
);
2450 afi
= (rn
->p
.family
== AF_INET
)
2452 : (rn
->p
.family
== AF_INET6
) ? AFI_IP6
: AFI_MAX
;
2453 if (is_zebra_import_table_enabled(afi
, re
->vrf_id
, re
->table
)) {
2454 struct zebra_vrf
*zvrf
= zebra_vrf_lookup_by_id(re
->vrf_id
);
2456 zebra_del_import_table_entry(zvrf
, rn
, re
);
2457 /* Just clean up if non main table */
2458 if (IS_ZEBRA_DEBUG_RIB
) {
2459 char buf
[SRCDEST2STR_BUFFER
];
2460 srcdest_rnode2str(rn
, buf
, sizeof(buf
));
2461 zlog_debug("%u:%s: Freeing route rn %p, re %p (%s)",
2462 re
->vrf_id
, buf
, rn
, re
,
2463 zebra_route_string(re
->type
));
2472 /* This function dumps the contents of a given RE entry into
2473 * standard debug log. Calling function name and IP prefix in
2474 * question are passed as 1st and 2nd arguments.
2477 void _route_entry_dump(const char *func
, union prefixconstptr pp
,
2478 union prefixconstptr src_pp
,
2479 const struct route_entry
*re
)
2481 const struct prefix
*src_p
= src_pp
.p
;
2482 bool is_srcdst
= src_p
&& src_p
->prefixlen
;
2483 char straddr
[PREFIX_STRLEN
];
2484 char srcaddr
[PREFIX_STRLEN
];
2485 char nhname
[PREFIX_STRLEN
];
2486 struct nexthop
*nexthop
;
2488 zlog_debug("%s: dumping RE entry %p for %s%s%s vrf %u", func
,
2489 (const void *)re
, prefix2str(pp
, straddr
, sizeof(straddr
)),
2490 is_srcdst
? " from " : "",
2491 is_srcdst
? prefix2str(src_pp
, srcaddr
, sizeof(srcaddr
))
2494 zlog_debug("%s: uptime == %lu, type == %u, instance == %d, table == %d",
2495 straddr
, (unsigned long)re
->uptime
, re
->type
, re
->instance
,
2498 "%s: metric == %u, mtu == %u, distance == %u, flags == %u, status == %u",
2499 straddr
, re
->metric
, re
->mtu
, re
->distance
, re
->flags
, re
->status
);
2500 zlog_debug("%s: nexthop_num == %u, nexthop_active_num == %u", straddr
,
2501 nexthop_group_nexthop_num(re
->ng
),
2502 nexthop_group_active_nexthop_num(re
->ng
));
2504 for (ALL_NEXTHOPS_PTR(re
->ng
, nexthop
)) {
2505 struct interface
*ifp
;
2506 struct vrf
*vrf
= vrf_lookup_by_id(nexthop
->vrf_id
);
2508 switch (nexthop
->type
) {
2509 case NEXTHOP_TYPE_BLACKHOLE
:
2510 sprintf(nhname
, "Blackhole");
2512 case NEXTHOP_TYPE_IFINDEX
:
2513 ifp
= if_lookup_by_index(nexthop
->ifindex
,
2515 sprintf(nhname
, "%s", ifp
? ifp
->name
: "Unknown");
2517 case NEXTHOP_TYPE_IPV4
:
2519 case NEXTHOP_TYPE_IPV4_IFINDEX
:
2520 inet_ntop(AF_INET
, &nexthop
->gate
, nhname
,
2523 case NEXTHOP_TYPE_IPV6
:
2524 case NEXTHOP_TYPE_IPV6_IFINDEX
:
2525 inet_ntop(AF_INET6
, &nexthop
->gate
, nhname
,
2529 zlog_debug("%s: %s %s[%u] vrf %s(%u) with flags %s%s%s%s%s%s",
2530 straddr
, (nexthop
->rparent
? " NH" : "NH"), nhname
,
2531 nexthop
->ifindex
, vrf
? vrf
->name
: "Unknown",
2533 (CHECK_FLAG(nexthop
->flags
, NEXTHOP_FLAG_ACTIVE
)
2536 (CHECK_FLAG(re
->status
, ROUTE_ENTRY_INSTALLED
)
2539 (CHECK_FLAG(nexthop
->flags
, NEXTHOP_FLAG_RECURSIVE
)
2542 (CHECK_FLAG(nexthop
->flags
, NEXTHOP_FLAG_ONLINK
)
2545 (CHECK_FLAG(nexthop
->flags
, NEXTHOP_FLAG_MATCHED
)
2548 (CHECK_FLAG(nexthop
->flags
, NEXTHOP_FLAG_DUPLICATE
)
2552 zlog_debug("%s: dump complete", straddr
);
2555 /* This is an exported helper to rtm_read() to dump the strange
2556 * RE entry found by rib_lookup_ipv4_route()
2559 void rib_lookup_and_dump(struct prefix_ipv4
*p
, vrf_id_t vrf_id
)
2561 struct route_table
*table
;
2562 struct route_node
*rn
;
2563 struct route_entry
*re
;
2564 char prefix_buf
[INET_ADDRSTRLEN
];
2567 table
= zebra_vrf_table(AFI_IP
, SAFI_UNICAST
, vrf_id
);
2569 flog_err(EC_ZEBRA_TABLE_LOOKUP_FAILED
,
2570 "%s:%u zebra_vrf_table() returned NULL", __func__
,
2575 /* Scan the RIB table for exactly matching RE entry. */
2576 rn
= route_node_lookup(table
, (struct prefix
*)p
);
2578 /* No route for this prefix. */
2580 zlog_debug("%s:%u lookup failed for %s", __func__
, vrf_id
,
2581 prefix2str((struct prefix
*)p
, prefix_buf
,
2582 sizeof(prefix_buf
)));
2587 route_unlock_node(rn
);
2590 RNODE_FOREACH_RE (rn
, re
) {
2591 zlog_debug("%s:%u rn %p, re %p: %s, %s",
2593 (void *)rn
, (void *)re
,
2594 (CHECK_FLAG(re
->status
, ROUTE_ENTRY_REMOVED
)
2597 (CHECK_FLAG(re
->flags
, ZEBRA_FLAG_SELECTED
)
2600 route_entry_dump(p
, NULL
, re
);
2604 /* Check if requested address assignment will fail due to another
2605 * route being installed by zebra in FIB already. Take necessary
2606 * actions, if needed: remove such a route from FIB and deSELECT
2607 * corresponding RE entry. Then put affected RN into RIBQ head.
2609 void rib_lookup_and_pushup(struct prefix_ipv4
*p
, vrf_id_t vrf_id
)
2611 struct route_table
*table
;
2612 struct route_node
*rn
;
2615 if (NULL
== (table
= zebra_vrf_table(AFI_IP
, SAFI_UNICAST
, vrf_id
))) {
2616 flog_err(EC_ZEBRA_TABLE_LOOKUP_FAILED
,
2617 "%s:%u zebra_vrf_table() returned NULL", __func__
,
2622 /* No matches would be the simplest case. */
2623 if (NULL
== (rn
= route_node_lookup(table
, (struct prefix
*)p
)))
2627 route_unlock_node(rn
);
2629 dest
= rib_dest_from_rnode(rn
);
2630 /* Check all RE entries. In case any changes have to be done, requeue
2631 * the RN into RIBQ head. If the routing message about the new connected
2632 * route (generated by the IP address we are going to assign very soon)
2633 * comes before the RIBQ is processed, the new RE entry will join
2634 * RIBQ record already on head. This is necessary for proper
2636 * of the rest of the RE.
2638 if (dest
->selected_fib
) {
2639 if (IS_ZEBRA_DEBUG_RIB
) {
2640 char buf
[PREFIX_STRLEN
];
2642 zlog_debug("%u:%s: freeing way for connected prefix",
2643 dest
->selected_fib
->vrf_id
,
2644 prefix2str(&rn
->p
, buf
, sizeof(buf
)));
2645 route_entry_dump(&rn
->p
, NULL
, dest
->selected_fib
);
2647 rib_uninstall(rn
, dest
->selected_fib
);
2652 int rib_add_multipath(afi_t afi
, safi_t safi
, struct prefix
*p
,
2653 struct prefix_ipv6
*src_p
, struct route_entry
*re
)
2655 struct nhg_hash_entry
*nhe
= NULL
;
2656 struct route_table
*table
;
2657 struct route_node
*rn
;
2658 struct route_entry
*same
= NULL
;
2664 assert(!src_p
|| !src_p
->prefixlen
|| afi
== AFI_IP6
);
2667 table
= zebra_vrf_table_with_table_id(afi
, safi
, re
->vrf_id
, re
->table
);
2670 nexthop_group_delete(&re
->ng
);
2671 XFREE(MTYPE_RE
, re
);
2676 nhe
= zebra_nhg_lookup_id(re
->nhe_id
);
2680 EC_ZEBRA_TABLE_LOOKUP_FAILED
,
2681 "Zebra failed to find the nexthop hash entry for id=%u in a route entry",
2683 XFREE(MTYPE_RE
, re
);
2687 nhe
= zebra_nhg_rib_find(0, re
->ng
, afi
);
2690 * The nexthops got copied over into an nhe,
2693 nexthop_group_delete(&re
->ng
);
2696 char buf
[PREFIX_STRLEN
] = "";
2697 char buf2
[PREFIX_STRLEN
] = "";
2700 EC_ZEBRA_TABLE_LOOKUP_FAILED
,
2701 "Zebra failed to find or create a nexthop hash entry for %s%s%s",
2702 prefix2str(p
, buf
, sizeof(buf
)),
2703 src_p
? " from " : "",
2704 src_p
? prefix2str(src_p
, buf2
, sizeof(buf2
))
2707 XFREE(MTYPE_RE
, re
);
2713 * Attach the re to the nhe's nexthop group.
2715 * TODO: This will need to change when we start getting IDs from upper
2716 * level protocols, as the refcnt might be wrong, since it checks
2717 * if old_id != new_id.
2719 zebra_nhg_re_update_ref(re
, nhe
);
2721 /* Make it sure prefixlen is applied to the prefix. */
2724 apply_mask_ipv6(src_p
);
2726 /* Set default distance by route type. */
2727 if (re
->distance
== 0)
2728 re
->distance
= route_distance(re
->type
);
2730 /* Lookup route node.*/
2731 rn
= srcdest_rnode_get(table
, p
, src_p
);
2734 * If same type of route are installed, treat it as a implicit
2736 * If the user has specified the No route replace semantics
2737 * for the install don't do a route replace.
2739 RNODE_FOREACH_RE (rn
, same
) {
2740 if (CHECK_FLAG(same
->status
, ROUTE_ENTRY_REMOVED
))
2743 if (same
->type
!= re
->type
)
2745 if (same
->instance
!= re
->instance
)
2747 if (same
->type
== ZEBRA_ROUTE_KERNEL
2748 && same
->metric
!= re
->metric
)
2751 if (CHECK_FLAG(re
->flags
, ZEBRA_FLAG_RR_USE_DISTANCE
) &&
2752 same
->distance
!= re
->distance
)
2756 * We should allow duplicate connected routes
2757 * because of IPv6 link-local routes and unnumbered
2758 * interfaces on Linux.
2760 if (same
->type
!= ZEBRA_ROUTE_CONNECT
)
2764 /* If this route is kernel/connected route, notify the dataplane. */
2765 if (RIB_SYSTEM_ROUTE(re
)) {
2766 /* Notify dataplane */
2767 dplane_sys_route_add(rn
, re
);
2770 /* Link new re to node.*/
2771 if (IS_ZEBRA_DEBUG_RIB
) {
2772 rnode_debug(rn
, re
->vrf_id
,
2773 "Inserting route rn %p, re %p (%s) existing %p",
2774 rn
, re
, zebra_route_string(re
->type
), same
);
2776 if (IS_ZEBRA_DEBUG_RIB_DETAILED
)
2777 route_entry_dump(p
, src_p
, re
);
2780 SET_FLAG(re
->status
, ROUTE_ENTRY_CHANGED
);
2781 rib_addnode(rn
, re
, 1);
2784 /* Free implicit route.*/
2786 rib_delnode(rn
, same
);
2790 route_unlock_node(rn
);
2794 void rib_delete(afi_t afi
, safi_t safi
, vrf_id_t vrf_id
, int type
,
2795 unsigned short instance
, int flags
, struct prefix
*p
,
2796 struct prefix_ipv6
*src_p
, const struct nexthop
*nh
,
2797 uint32_t nhe_id
, uint32_t table_id
, uint32_t metric
,
2798 uint8_t distance
, bool fromkernel
)
2800 struct route_table
*table
;
2801 struct route_node
*rn
;
2802 struct route_entry
*re
;
2803 struct route_entry
*fib
= NULL
;
2804 struct route_entry
*same
= NULL
;
2805 struct nexthop
*rtnh
;
2806 char buf2
[INET6_ADDRSTRLEN
];
2809 assert(!src_p
|| !src_p
->prefixlen
|| afi
== AFI_IP6
);
2812 table
= zebra_vrf_table_with_table_id(afi
, safi
, vrf_id
, table_id
);
2819 apply_mask_ipv6(src_p
);
2821 /* Lookup route node. */
2822 rn
= srcdest_rnode_lookup(table
, p
, src_p
);
2824 char dst_buf
[PREFIX_STRLEN
], src_buf
[PREFIX_STRLEN
];
2826 prefix2str(p
, dst_buf
, sizeof(dst_buf
));
2827 if (src_p
&& src_p
->prefixlen
)
2828 prefix2str(src_p
, src_buf
, sizeof(src_buf
));
2832 if (IS_ZEBRA_DEBUG_RIB
) {
2833 struct vrf
*vrf
= vrf_lookup_by_id(vrf_id
);
2835 zlog_debug("%s[%d]:%s%s%s doesn't exist in rib",
2836 vrf
->name
, table_id
, dst_buf
,
2837 (src_buf
[0] != '\0') ? " from " : "",
2843 dest
= rib_dest_from_rnode(rn
);
2844 fib
= dest
->selected_fib
;
2846 /* Lookup same type route. */
2847 RNODE_FOREACH_RE (rn
, re
) {
2848 if (CHECK_FLAG(re
->status
, ROUTE_ENTRY_REMOVED
))
2851 if (re
->type
!= type
)
2853 if (re
->instance
!= instance
)
2855 if (CHECK_FLAG(re
->flags
, ZEBRA_FLAG_RR_USE_DISTANCE
) &&
2856 distance
!= re
->distance
)
2859 if (re
->type
== ZEBRA_ROUTE_KERNEL
&& re
->metric
!= metric
)
2861 if (re
->type
== ZEBRA_ROUTE_CONNECT
&& (rtnh
= re
->ng
->nexthop
)
2862 && rtnh
->type
== NEXTHOP_TYPE_IFINDEX
&& nh
) {
2863 if (rtnh
->ifindex
!= nh
->ifindex
)
2869 /* Make sure that the route found has the same gateway. */
2870 if (nhe_id
&& re
->nhe_id
== nhe_id
) {
2879 for (ALL_NEXTHOPS_PTR(re
->ng
, rtnh
)) {
2881 * No guarantee all kernel send nh with labels
2884 if (nexthop_same_no_labels(rtnh
, nh
)) {
2893 /* If same type of route can't be found and this message is from
2897 * In the past(HA!) we could get here because
2898 * we were receiving a route delete from the
2899 * kernel and we're not marking the proto
2900 * as coming from it's appropriate originator.
2901 * Now that we are properly noticing the fact
2902 * that the kernel has deleted our route we
2903 * are not going to get called in this path
2904 * I am going to leave this here because
2905 * this might still work this way on non-linux
2906 * platforms as well as some weird state I have
2907 * not properly thought of yet.
2908 * If we can show that this code path is
2909 * dead then we can remove it.
2911 if (fib
&& CHECK_FLAG(flags
, ZEBRA_FLAG_SELFROUTE
)) {
2912 if (IS_ZEBRA_DEBUG_RIB
) {
2913 rnode_debug(rn
, vrf_id
,
2914 "rn %p, re %p (%s) was deleted from kernel, adding",
2916 zebra_route_string(fib
->type
));
2919 UNSET_FLAG(fib
->status
, ROUTE_ENTRY_INSTALLED
);
2921 for (rtnh
= fib
->ng
->nexthop
; rtnh
;
2923 UNSET_FLAG(rtnh
->flags
,
2927 * This is a non FRR route
2928 * as such we should mark
2931 dest
->selected_fib
= NULL
;
2933 /* This means someone else, other than Zebra,
2935 * a Zebra router from the kernel. We will add
2937 rib_install_kernel(rn
, fib
, NULL
);
2940 if (IS_ZEBRA_DEBUG_RIB
) {
2944 "via %s ifindex %d type %d "
2945 "doesn't exist in rib",
2946 inet_ntop(afi2family(afi
),
2953 "type %d doesn't exist in rib",
2956 route_unlock_node(rn
);
2962 if (fromkernel
&& CHECK_FLAG(flags
, ZEBRA_FLAG_SELFROUTE
)
2964 rib_install_kernel(rn
, same
, NULL
);
2965 route_unlock_node(rn
);
2970 /* Special handling for IPv4 or IPv6 routes sourced from
2971 * EVPN - the nexthop (and associated MAC) need to be
2972 * uninstalled if no more refs.
2974 if (CHECK_FLAG(flags
, ZEBRA_FLAG_EVPN_ROUTE
)) {
2975 struct nexthop
*tmp_nh
;
2977 for (ALL_NEXTHOPS_PTR(re
->ng
, tmp_nh
)) {
2978 struct ipaddr vtep_ip
;
2980 memset(&vtep_ip
, 0, sizeof(struct ipaddr
));
2981 if (afi
== AFI_IP
) {
2982 vtep_ip
.ipa_type
= IPADDR_V4
;
2983 memcpy(&(vtep_ip
.ipaddr_v4
),
2984 &(tmp_nh
->gate
.ipv4
),
2985 sizeof(struct in_addr
));
2987 vtep_ip
.ipa_type
= IPADDR_V6
;
2988 memcpy(&(vtep_ip
.ipaddr_v6
),
2989 &(tmp_nh
->gate
.ipv6
),
2990 sizeof(struct in6_addr
));
2992 zebra_vxlan_evpn_vrf_route_del(re
->vrf_id
,
2997 /* Notify dplane if system route changes */
2998 if (RIB_SYSTEM_ROUTE(re
))
2999 dplane_sys_route_del(rn
, same
);
3001 rib_delnode(rn
, same
);
3004 route_unlock_node(rn
);
3009 int rib_add(afi_t afi
, safi_t safi
, vrf_id_t vrf_id
, int type
,
3010 unsigned short instance
, int flags
, struct prefix
*p
,
3011 struct prefix_ipv6
*src_p
, const struct nexthop
*nh
,
3012 uint32_t nhe_id
, uint32_t table_id
, uint32_t metric
, uint32_t mtu
,
3013 uint8_t distance
, route_tag_t tag
)
3015 struct route_entry
*re
= NULL
;
3016 struct nexthop
*nexthop
= NULL
;
3018 /* Allocate new route_entry structure. */
3019 re
= XCALLOC(MTYPE_RE
, sizeof(struct route_entry
));
3021 re
->instance
= instance
;
3022 re
->distance
= distance
;
3024 re
->metric
= metric
;
3026 re
->table
= table_id
;
3027 re
->vrf_id
= vrf_id
;
3028 re
->uptime
= monotime(NULL
);
3030 re
->nhe_id
= nhe_id
;
3033 re
->ng
= nexthop_group_new();
3036 nexthop
= nexthop_new();
3038 route_entry_nexthop_add(re
, nexthop
);
3041 return rib_add_multipath(afi
, safi
, p
, src_p
, re
);
3044 static const char *rib_update_event2str(rib_update_event_t event
)
3046 const char *ret
= "UNKNOWN";
3049 case RIB_UPDATE_KERNEL
:
3050 ret
= "RIB_UPDATE_KERNEL";
3052 case RIB_UPDATE_RMAP_CHANGE
:
3053 ret
= "RIB_UPDATE_RMAP_CHANGE";
3055 case RIB_UPDATE_OTHER
:
3056 ret
= "RIB_UPDATE_OTHER";
3058 case RIB_UPDATE_MAX
:
3066 /* Schedule route nodes to be processed if they match the type */
3067 static void rib_update_route_node(struct route_node
*rn
, int type
)
3069 struct route_entry
*re
, *next
;
3070 bool re_changed
= false;
3072 RNODE_FOREACH_RE_SAFE (rn
, re
, next
) {
3073 if (type
== ZEBRA_ROUTE_ALL
|| type
== re
->type
) {
3074 SET_FLAG(re
->status
, ROUTE_ENTRY_CHANGED
);
3083 /* Schedule routes of a particular table (address-family) based on event. */
3084 void rib_update_table(struct route_table
*table
, rib_update_event_t event
)
3086 struct route_node
*rn
;
3088 if (IS_ZEBRA_DEBUG_EVENT
) {
3089 struct zebra_vrf
*zvrf
;
3092 zvrf
= table
->info
? ((rib_table_info_t
*)table
->info
)->zvrf
3094 vrf
= zvrf
? zvrf
->vrf
: NULL
;
3096 zlog_debug("%s: %s VRF %s Table %u event %s", __func__
,
3097 table
->info
? afi2str(
3098 ((rib_table_info_t
*)table
->info
)->afi
)
3100 vrf
? vrf
->name
: "Unknown",
3101 zvrf
? zvrf
->table_id
: 0,
3102 rib_update_event2str(event
));
3105 /* Walk all routes and queue for processing, if appropriate for
3106 * the trigger event.
3108 for (rn
= route_top(table
); rn
; rn
= srcdest_route_next(rn
)) {
3110 * If we are looking at a route node and the node
3111 * has already been queued we don't
3112 * need to queue it up again
3115 && CHECK_FLAG(rib_dest_from_rnode(rn
)->flags
,
3116 RIB_ROUTE_ANY_QUEUED
))
3120 case RIB_UPDATE_KERNEL
:
3121 rib_update_route_node(rn
, ZEBRA_ROUTE_KERNEL
);
3123 case RIB_UPDATE_RMAP_CHANGE
:
3124 case RIB_UPDATE_OTHER
:
3125 rib_update_route_node(rn
, ZEBRA_ROUTE_ALL
);
3133 static void rib_update_handle_vrf(vrf_id_t vrf_id
, rib_update_event_t event
)
3135 struct route_table
*table
;
3137 if (IS_ZEBRA_DEBUG_EVENT
)
3138 zlog_debug("%s: Handling VRF %s event %s", __func__
,
3139 vrf_id_to_name(vrf_id
), rib_update_event2str(event
));
3141 /* Process routes of interested address-families. */
3142 table
= zebra_vrf_table(AFI_IP
, SAFI_UNICAST
, vrf_id
);
3144 rib_update_table(table
, event
);
3146 table
= zebra_vrf_table(AFI_IP6
, SAFI_UNICAST
, vrf_id
);
3148 rib_update_table(table
, event
);
3151 static void rib_update_handle_vrf_all(rib_update_event_t event
)
3153 struct zebra_router_table
*zrt
;
3155 if (IS_ZEBRA_DEBUG_EVENT
)
3156 zlog_debug("%s: Handling VRF (ALL) event %s", __func__
,
3157 rib_update_event2str(event
));
3159 /* Just iterate over all the route tables, rather than vrf lookups */
3160 RB_FOREACH (zrt
, zebra_router_table_head
, &zrouter
.tables
)
3161 rib_update_table(zrt
->table
, event
);
3164 struct rib_update_ctx
{
3165 rib_update_event_t event
;
3170 static struct rib_update_ctx
*rib_update_ctx_init(vrf_id_t vrf_id
,
3171 rib_update_event_t event
)
3173 struct rib_update_ctx
*ctx
;
3175 ctx
= XCALLOC(MTYPE_RIB_UPDATE_CTX
, sizeof(struct rib_update_ctx
));
3178 ctx
->vrf_id
= vrf_id
;
3183 static void rib_update_ctx_fini(struct rib_update_ctx
**ctx
)
3185 XFREE(MTYPE_RIB_UPDATE_CTX
, *ctx
);
3190 static int rib_update_handler(struct thread
*thread
)
3192 struct rib_update_ctx
*ctx
;
3194 ctx
= THREAD_ARG(thread
);
3197 rib_update_handle_vrf_all(ctx
->event
);
3199 rib_update_handle_vrf(ctx
->vrf_id
, ctx
->event
);
3201 rib_update_ctx_fini(&ctx
);
3207 * Thread list to ensure we don't schedule a ton of events
3208 * if interfaces are flapping for instance.
3210 static struct thread
*t_rib_update_threads
[RIB_UPDATE_MAX
];
3212 /* Schedule a RIB update event for specific vrf */
3213 void rib_update_vrf(vrf_id_t vrf_id
, rib_update_event_t event
)
3215 struct rib_update_ctx
*ctx
;
3217 ctx
= rib_update_ctx_init(vrf_id
, event
);
3219 /* Don't worry about making sure multiple rib updates for specific vrf
3220 * are scheduled at once for now. If it becomes a problem, we can use a
3221 * lookup of some sort to keep track of running threads via t_vrf_id
3222 * like how we are doing it in t_rib_update_threads[].
3224 thread_add_event(zrouter
.master
, rib_update_handler
, ctx
, 0, NULL
);
3226 if (IS_ZEBRA_DEBUG_EVENT
)
3227 zlog_debug("%s: Scheduled VRF %s, event %s", __func__
,
3228 vrf_id_to_name(ctx
->vrf_id
),
3229 rib_update_event2str(event
));
3232 /* Schedule a RIB update event for all vrfs */
3233 void rib_update(rib_update_event_t event
)
3235 struct rib_update_ctx
*ctx
;
3237 ctx
= rib_update_ctx_init(0, event
);
3239 ctx
->vrf_all
= true;
3241 if (!thread_add_event(zrouter
.master
, rib_update_handler
, ctx
, 0,
3242 &t_rib_update_threads
[event
]))
3243 rib_update_ctx_fini(&ctx
); /* Already scheduled */
3244 else if (IS_ZEBRA_DEBUG_EVENT
)
3245 zlog_debug("%s: Schedued VRF (ALL), event %s", __func__
,
3246 rib_update_event2str(event
));
3249 /* Delete self installed routes after zebra is relaunched. */
3250 void rib_sweep_table(struct route_table
*table
)
3252 struct route_node
*rn
;
3253 struct route_entry
*re
;
3254 struct route_entry
*next
;
3255 struct nexthop
*nexthop
;
3260 for (rn
= route_top(table
); rn
; rn
= srcdest_route_next(rn
)) {
3261 RNODE_FOREACH_RE_SAFE (rn
, re
, next
) {
3263 if (IS_ZEBRA_DEBUG_RIB
)
3264 route_entry_dump(&rn
->p
, NULL
, re
);
3266 if (CHECK_FLAG(re
->status
, ROUTE_ENTRY_REMOVED
))
3269 if (!CHECK_FLAG(re
->flags
, ZEBRA_FLAG_SELFROUTE
))
3273 * If routes are older than startup_time then
3274 * we know we read them in from the kernel.
3275 * As such we can safely remove them.
3277 if (zrouter
.startup_time
< re
->uptime
)
3281 * So we are starting up and have received
3282 * routes from the kernel that we have installed
3283 * from a previous run of zebra but not cleaned
3284 * up ( say a kill -9 )
3285 * But since we haven't actually installed
3286 * them yet( we received them from the kernel )
3287 * we don't think they are active.
3288 * So let's pretend they are active to actually
3290 * In all honesty I'm not sure if we should
3291 * mark them as active when we receive them
3292 * This is startup only so probably ok.
3294 * If we ever decide to move rib_sweep_table
3295 * to a different spot (ie startup )
3296 * this decision needs to be revisited
3298 SET_FLAG(re
->status
, ROUTE_ENTRY_INSTALLED
);
3299 for (ALL_NEXTHOPS_PTR(re
->ng
, nexthop
))
3300 SET_FLAG(nexthop
->flags
, NEXTHOP_FLAG_FIB
);
3302 rib_uninstall_kernel(rn
, re
);
3303 rib_delnode(rn
, re
);
3308 /* Sweep all RIB tables. */
3309 int rib_sweep_route(struct thread
*t
)
3312 struct zebra_vrf
*zvrf
;
3314 RB_FOREACH (vrf
, vrf_id_head
, &vrfs_by_id
) {
3315 if ((zvrf
= vrf
->info
) == NULL
)
3318 rib_sweep_table(zvrf
->table
[AFI_IP
][SAFI_UNICAST
]);
3319 rib_sweep_table(zvrf
->table
[AFI_IP6
][SAFI_UNICAST
]);
3322 zebra_router_sweep_route();
3323 zebra_router_sweep_nhgs();
3328 /* Remove specific by protocol routes from 'table'. */
3329 unsigned long rib_score_proto_table(uint8_t proto
, unsigned short instance
,
3330 struct route_table
*table
)
3332 struct route_node
*rn
;
3333 struct route_entry
*re
;
3334 struct route_entry
*next
;
3335 unsigned long n
= 0;
3338 for (rn
= route_top(table
); rn
; rn
= srcdest_route_next(rn
))
3339 RNODE_FOREACH_RE_SAFE (rn
, re
, next
) {
3340 if (CHECK_FLAG(re
->status
, ROUTE_ENTRY_REMOVED
))
3342 if (re
->type
== proto
3343 && re
->instance
== instance
) {
3344 rib_delnode(rn
, re
);
3351 /* Remove specific by protocol routes. */
3352 unsigned long rib_score_proto(uint8_t proto
, unsigned short instance
)
3355 struct zebra_vrf
*zvrf
;
3356 struct other_route_table
*ort
;
3357 unsigned long cnt
= 0;
3359 RB_FOREACH (vrf
, vrf_id_head
, &vrfs_by_id
) {
3364 cnt
+= rib_score_proto_table(proto
, instance
,
3365 zvrf
->table
[AFI_IP
][SAFI_UNICAST
])
3366 + rib_score_proto_table(
3368 zvrf
->table
[AFI_IP6
][SAFI_UNICAST
]);
3370 frr_each(otable
, &zvrf
->other_tables
, ort
) cnt
+=
3371 rib_score_proto_table(proto
, instance
, ort
->table
);
3377 /* Close RIB and clean up kernel routes. */
3378 void rib_close_table(struct route_table
*table
)
3380 struct route_node
*rn
;
3381 rib_table_info_t
*info
;
3387 info
= route_table_get_info(table
);
3389 for (rn
= route_top(table
); rn
; rn
= srcdest_route_next(rn
)) {
3390 dest
= rib_dest_from_rnode(rn
);
3392 if (dest
&& dest
->selected_fib
) {
3393 if (info
->safi
== SAFI_UNICAST
)
3394 hook_call(rib_update
, rn
, NULL
);
3396 rib_uninstall_kernel(rn
, dest
->selected_fib
);
3397 dest
->selected_fib
= NULL
;
3403 * Handler for async dataplane results after a pseudowire installation
3405 static int handle_pw_result(struct zebra_dplane_ctx
*ctx
)
3407 struct zebra_pw
*pw
;
3408 struct zebra_vrf
*vrf
;
3410 /* The pseudowire code assumes success - we act on an error
3411 * result for installation attempts here.
3413 if (dplane_ctx_get_op(ctx
) != DPLANE_OP_PW_INSTALL
)
3416 if (dplane_ctx_get_status(ctx
) != ZEBRA_DPLANE_REQUEST_SUCCESS
) {
3417 vrf
= zebra_vrf_lookup_by_id(dplane_ctx_get_vrf(ctx
));
3418 pw
= zebra_pw_find(vrf
, dplane_ctx_get_ifname(ctx
));
3420 zebra_pw_install_failure(pw
);
3430 * Handle results from the dataplane system. Dequeue update context
3431 * structs, dispatch to appropriate internal handlers.
3433 static int rib_process_dplane_results(struct thread
*thread
)
3435 struct zebra_dplane_ctx
*ctx
;
3436 struct dplane_ctx_q ctxlist
;
3437 bool shut_p
= false;
3439 /* Dequeue a list of completed updates with one lock/unlock cycle */
3442 TAILQ_INIT(&ctxlist
);
3444 /* Take lock controlling queue of results */
3445 frr_with_mutex(&dplane_mutex
) {
3446 /* Dequeue list of context structs */
3447 dplane_ctx_list_append(&ctxlist
, &rib_dplane_q
);
3450 /* Dequeue context block */
3451 ctx
= dplane_ctx_dequeue(&ctxlist
);
3453 /* If we've emptied the results queue, we're done */
3457 /* If zebra is shutting down, avoid processing results,
3458 * just drain the results queue.
3460 shut_p
= atomic_load_explicit(&zrouter
.in_shutdown
,
3461 memory_order_relaxed
);
3464 dplane_ctx_fini(&ctx
);
3466 ctx
= dplane_ctx_dequeue(&ctxlist
);
3473 switch (dplane_ctx_get_op(ctx
)) {
3474 case DPLANE_OP_ROUTE_INSTALL
:
3475 case DPLANE_OP_ROUTE_UPDATE
:
3476 case DPLANE_OP_ROUTE_DELETE
:
3478 /* Bit of special case for route updates
3479 * that were generated by async notifications:
3480 * we don't want to continue processing these
3483 if (dplane_ctx_get_notif_provider(ctx
) == 0)
3484 rib_process_result(ctx
);
3486 dplane_ctx_fini(&ctx
);
3490 case DPLANE_OP_ROUTE_NOTIFY
:
3491 rib_process_dplane_notify(ctx
);
3494 case DPLANE_OP_NH_INSTALL
:
3495 case DPLANE_OP_NH_UPDATE
:
3496 case DPLANE_OP_NH_DELETE
:
3497 zebra_nhg_dplane_result(ctx
);
3500 case DPLANE_OP_LSP_INSTALL
:
3501 case DPLANE_OP_LSP_UPDATE
:
3502 case DPLANE_OP_LSP_DELETE
:
3504 /* Bit of special case for LSP updates
3505 * that were generated by async notifications:
3506 * we don't want to continue processing these.
3508 if (dplane_ctx_get_notif_provider(ctx
) == 0)
3509 zebra_mpls_lsp_dplane_result(ctx
);
3511 dplane_ctx_fini(&ctx
);
3515 case DPLANE_OP_LSP_NOTIFY
:
3516 zebra_mpls_process_dplane_notify(ctx
);
3519 case DPLANE_OP_PW_INSTALL
:
3520 case DPLANE_OP_PW_UNINSTALL
:
3521 handle_pw_result(ctx
);
3524 case DPLANE_OP_SYS_ROUTE_ADD
:
3525 case DPLANE_OP_SYS_ROUTE_DELETE
:
3526 /* No further processing in zebra for these. */
3527 dplane_ctx_fini(&ctx
);
3530 case DPLANE_OP_MAC_INSTALL
:
3531 case DPLANE_OP_MAC_DELETE
:
3532 zebra_vxlan_handle_result(ctx
);
3535 /* Some op codes not handled here */
3536 case DPLANE_OP_ADDR_INSTALL
:
3537 case DPLANE_OP_ADDR_UNINSTALL
:
3538 case DPLANE_OP_NEIGH_INSTALL
:
3539 case DPLANE_OP_NEIGH_UPDATE
:
3540 case DPLANE_OP_NEIGH_DELETE
:
3541 case DPLANE_OP_VTEP_ADD
:
3542 case DPLANE_OP_VTEP_DELETE
:
3543 case DPLANE_OP_NONE
:
3544 /* Don't expect this: just return the struct? */
3545 dplane_ctx_fini(&ctx
);
3548 } /* Dispatch by op code */
3550 ctx
= dplane_ctx_dequeue(&ctxlist
);
3559 * Results are returned from the dataplane subsystem, in the context of
3560 * the dataplane pthread. We enqueue the results here for processing by
3561 * the main thread later.
3563 static int rib_dplane_results(struct dplane_ctx_q
*ctxlist
)
3565 /* Take lock controlling queue of results */
3566 frr_with_mutex(&dplane_mutex
) {
3567 /* Enqueue context blocks */
3568 dplane_ctx_list_append(&rib_dplane_q
, ctxlist
);
3571 /* Ensure event is signalled to zebra main pthread */
3572 thread_add_event(zrouter
.master
, rib_process_dplane_results
, NULL
, 0,
3579 * Ensure there are no empty slots in the route_info array.
3580 * Every route type in zebra should be present there.
3582 static void check_route_info(void)
3584 int len
= array_size(route_info
);
3587 * ZEBRA_ROUTE_SYSTEM is special cased since
3588 * its key is 0 anyway.
3590 * ZEBRA_ROUTE_ALL is also ignored.
3592 for (int i
= 0; i
< len
; i
++) {
3593 if (i
== ZEBRA_ROUTE_SYSTEM
|| i
== ZEBRA_ROUTE_ALL
)
3595 assert(route_info
[i
].key
);
3596 assert(route_info
[i
].meta_q_map
< MQ_SIZE
);
3600 /* Routing information base initialize. */
3607 /* Init dataplane, and register for results */
3608 pthread_mutex_init(&dplane_mutex
, NULL
);
3609 TAILQ_INIT(&rib_dplane_q
);
3610 zebra_dplane_init(rib_dplane_results
);
3616 * Get the first vrf id that is greater than the given vrf id if any.
3618 * Returns true if a vrf id was found, false otherwise.
3620 static inline int vrf_id_get_next(vrf_id_t vrf_id
, vrf_id_t
*next_id_p
)
3624 vrf
= vrf_lookup_by_id(vrf_id
);
3626 vrf
= RB_NEXT(vrf_id_head
, vrf
);
3628 *next_id_p
= vrf
->vrf_id
;
3637 * rib_tables_iter_next
3639 * Returns the next table in the iteration.
3641 struct route_table
*rib_tables_iter_next(rib_tables_iter_t
*iter
)
3643 struct route_table
*table
;
3646 * Array that helps us go over all AFI/SAFI combinations via one
3653 {AFI_IP
, SAFI_UNICAST
}, {AFI_IP
, SAFI_MULTICAST
},
3654 {AFI_IP
, SAFI_LABELED_UNICAST
}, {AFI_IP6
, SAFI_UNICAST
},
3655 {AFI_IP6
, SAFI_MULTICAST
}, {AFI_IP6
, SAFI_LABELED_UNICAST
},
3660 switch (iter
->state
) {
3662 case RIB_TABLES_ITER_S_INIT
:
3663 iter
->vrf_id
= VRF_DEFAULT
;
3664 iter
->afi_safi_ix
= -1;
3668 case RIB_TABLES_ITER_S_ITERATING
:
3669 iter
->afi_safi_ix
++;
3672 while (iter
->afi_safi_ix
3673 < (int)array_size(afi_safis
)) {
3674 table
= zebra_vrf_table(
3675 afi_safis
[iter
->afi_safi_ix
].afi
,
3676 afi_safis
[iter
->afi_safi_ix
].safi
,
3681 iter
->afi_safi_ix
++;
3685 * Found another table in this vrf.
3691 * Done with all tables in the current vrf, go to the
3695 if (!vrf_id_get_next(iter
->vrf_id
, &iter
->vrf_id
))
3698 iter
->afi_safi_ix
= 0;
3703 case RIB_TABLES_ITER_S_DONE
:
3708 iter
->state
= RIB_TABLES_ITER_S_ITERATING
;
3710 iter
->state
= RIB_TABLES_ITER_S_DONE
;