1 /* Zebra next hop tracking code
2 * Copyright (C) 2013 Cumulus Networks, Inc.
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
29 #include "sockunion.h"
32 #include "workqueue.h"
39 #include "zebra/zebra_router.h"
40 #include "zebra/rib.h"
42 #include "zebra/zserv.h"
43 #include "zebra/zebra_ns.h"
44 #include "zebra/zebra_vrf.h"
45 #include "zebra/redistribute.h"
46 #include "zebra/debug.h"
47 #include "zebra/zebra_rnh.h"
48 #include "zebra/zebra_routemap.h"
49 #include "zebra/interface.h"
50 #include "zebra/zebra_memory.h"
51 #include "zebra/zebra_errors.h"
53 DEFINE_MTYPE_STATIC(ZEBRA
, RNH
, "Nexthop tracking object")
55 static void free_state(vrf_id_t vrf_id
, struct route_entry
*re
,
56 struct route_node
*rn
);
57 static void copy_state(struct rnh
*rnh
, const struct route_entry
*re
,
58 struct route_node
*rn
);
59 static int compare_state(struct route_entry
*r1
, struct route_entry
*r2
);
60 static int send_client(struct rnh
*rnh
, struct zserv
*client
, rnh_type_t type
,
62 static void print_rnh(struct route_node
*rn
, struct vty
*vty
);
63 static int zebra_client_cleanup_rnh(struct zserv
*client
);
65 void zebra_rnh_init(void)
67 hook_register(zserv_client_close
, zebra_client_cleanup_rnh
);
70 static inline struct route_table
*get_rnh_table(vrf_id_t vrfid
, afi_t afi
,
73 struct zebra_vrf
*zvrf
;
74 struct route_table
*t
= NULL
;
76 zvrf
= zebra_vrf_lookup_by_id(vrfid
);
79 case RNH_NEXTHOP_TYPE
:
80 t
= zvrf
->rnh_table
[afi
];
82 case RNH_IMPORT_CHECK_TYPE
:
83 t
= zvrf
->import_check_table
[afi
];
90 char *rnh_str(struct rnh
*rnh
, char *buf
, int size
)
92 prefix2str(&(rnh
->node
->p
), buf
, size
);
96 static void zebra_rnh_remove_from_routing_table(struct rnh
*rnh
)
98 struct zebra_vrf
*zvrf
= zebra_vrf_lookup_by_id(rnh
->vrf_id
);
99 struct route_table
*table
= zvrf
->table
[rnh
->afi
][SAFI_UNICAST
];
100 struct route_node
*rn
;
106 rn
= route_node_match(table
, &rnh
->resolved_route
);
110 if (IS_ZEBRA_DEBUG_NHT_DETAILED
) {
111 char buf
[PREFIX_STRLEN
];
112 char buf1
[PREFIX_STRLEN
];
114 zlog_debug("%s: %u:%s removed from tracking on %s",
115 __PRETTY_FUNCTION__
, rnh
->vrf_id
,
116 prefix2str(&rnh
->node
->p
, buf
, sizeof(buf
)),
117 srcdest_rnode2str(rn
, buf1
, sizeof(buf
)));
120 dest
= rib_dest_from_rnode(rn
);
121 rnh_list_del(&dest
->nht
, rnh
);
122 route_unlock_node(rn
);
125 static void zebra_rnh_store_in_routing_table(struct rnh
*rnh
)
127 struct zebra_vrf
*zvrf
= zebra_vrf_lookup_by_id(rnh
->vrf_id
);
128 struct route_table
*table
= zvrf
->table
[rnh
->afi
][SAFI_UNICAST
];
129 struct route_node
*rn
;
132 rn
= route_node_match(table
, &rnh
->resolved_route
);
136 if (IS_ZEBRA_DEBUG_NHT_DETAILED
) {
137 char buf
[PREFIX_STRLEN
];
138 char buf1
[PREFIX_STRLEN
];
140 zlog_debug("%s: %u:%s added for tracking on %s",
141 __PRETTY_FUNCTION__
, rnh
->vrf_id
,
142 prefix2str(&rnh
->node
->p
, buf
, sizeof(buf
)),
143 srcdest_rnode2str(rn
, buf1
, sizeof(buf
)));
146 dest
= rib_dest_from_rnode(rn
);
147 rnh_list_add_tail(&dest
->nht
, rnh
);
148 route_unlock_node(rn
);
151 struct rnh
*zebra_add_rnh(struct prefix
*p
, vrf_id_t vrfid
, rnh_type_t type
,
154 struct route_table
*table
;
155 struct route_node
*rn
;
156 struct rnh
*rnh
= NULL
;
157 char buf
[PREFIX2STR_BUFFER
];
158 afi_t afi
= family2afi(p
->family
);
160 if (IS_ZEBRA_DEBUG_NHT
) {
161 prefix2str(p
, buf
, sizeof(buf
));
162 zlog_debug("%u: Add RNH %s type %s", vrfid
, buf
,
165 table
= get_rnh_table(vrfid
, afi
, type
);
167 prefix2str(p
, buf
, sizeof(buf
));
168 flog_warn(EC_ZEBRA_RNH_NO_TABLE
,
169 "%u: Add RNH %s type %s - table not found", vrfid
,
170 buf
, rnh_type2str(type
));
175 /* Make it sure prefixlen is applied to the prefix. */
178 /* Lookup (or add) route node.*/
179 rn
= route_node_get(table
, p
);
182 rnh
= XCALLOC(MTYPE_RNH
, sizeof(struct rnh
));
185 * The resolved route is already 0.0.0.0/0 or
186 * 0::0/0 due to the calloc right above, but
187 * we should set the family so that future
188 * comparisons can just be done
190 rnh
->resolved_route
.family
= p
->family
;
191 rnh
->client_list
= list_new();
196 rnh
->zebra_pseudowire_list
= list_new();
202 zebra_rnh_store_in_routing_table(rnh
);
206 route_unlock_node(rn
);
210 struct rnh
*zebra_lookup_rnh(struct prefix
*p
, vrf_id_t vrfid
, rnh_type_t type
)
212 struct route_table
*table
;
213 struct route_node
*rn
;
215 table
= get_rnh_table(vrfid
, family2afi(PREFIX_FAMILY(p
)), type
);
219 /* Make it sure prefixlen is applied to the prefix. */
222 /* Lookup route node.*/
223 rn
= route_node_lookup(table
, p
);
227 route_unlock_node(rn
);
231 void zebra_free_rnh(struct rnh
*rnh
)
233 struct zebra_vrf
*zvrf
;
234 struct route_table
*table
;
236 zebra_rnh_remove_from_routing_table(rnh
);
237 rnh
->flags
|= ZEBRA_NHT_DELETED
;
238 list_delete(&rnh
->client_list
);
239 list_delete(&rnh
->zebra_pseudowire_list
);
241 zvrf
= zebra_vrf_lookup_by_id(rnh
->vrf_id
);
242 table
= zvrf
->table
[family2afi(rnh
->resolved_route
.family
)][SAFI_UNICAST
];
245 struct route_node
*rern
;
247 rern
= route_node_match(table
, &rnh
->resolved_route
);
251 route_unlock_node(rern
);
253 dest
= rib_dest_from_rnode(rern
);
254 rnh_list_del(&dest
->nht
, rnh
);
257 free_state(rnh
->vrf_id
, rnh
->state
, rnh
->node
);
258 XFREE(MTYPE_RNH
, rnh
);
261 static void zebra_delete_rnh(struct rnh
*rnh
, rnh_type_t type
)
263 struct route_node
*rn
;
265 if (!list_isempty(rnh
->client_list
)
266 || !list_isempty(rnh
->zebra_pseudowire_list
))
269 if ((rnh
->flags
& ZEBRA_NHT_DELETED
) || !(rn
= rnh
->node
))
272 if (IS_ZEBRA_DEBUG_NHT
) {
273 char buf
[PREFIX2STR_BUFFER
];
274 zlog_debug("%u: Del RNH %s type %s", rnh
->vrf_id
,
275 rnh_str(rnh
, buf
, sizeof(buf
)), rnh_type2str(type
));
280 route_unlock_node(rn
);
284 * This code will send to the registering client
286 * For a rnh that was created, there is no data
287 * so it will send an empty nexthop group
288 * If rnh exists then we know it has been evaluated
289 * and as such it will have a resolved rnh.
291 void zebra_add_rnh_client(struct rnh
*rnh
, struct zserv
*client
,
292 rnh_type_t type
, vrf_id_t vrf_id
)
294 if (IS_ZEBRA_DEBUG_NHT
) {
295 char buf
[PREFIX2STR_BUFFER
];
296 zlog_debug("%u: Client %s registers for RNH %s type %s", vrf_id
,
297 zebra_route_string(client
->proto
),
298 rnh_str(rnh
, buf
, sizeof(buf
)), rnh_type2str(type
));
300 if (!listnode_lookup(rnh
->client_list
, client
))
301 listnode_add(rnh
->client_list
, client
);
304 * We always need to respond with known information,
305 * currently multiple daemons expect this behavior
307 send_client(rnh
, client
, type
, vrf_id
);
310 void zebra_remove_rnh_client(struct rnh
*rnh
, struct zserv
*client
,
313 if (IS_ZEBRA_DEBUG_NHT
) {
314 char buf
[PREFIX2STR_BUFFER
];
315 zlog_debug("Client %s unregisters for RNH %s type %s",
316 zebra_route_string(client
->proto
),
317 rnh_str(rnh
, buf
, sizeof(buf
)), rnh_type2str(type
));
319 listnode_delete(rnh
->client_list
, client
);
320 zebra_delete_rnh(rnh
, type
);
323 /* XXX move this utility function elsewhere? */
324 static void addr2hostprefix(int af
, const union g_addr
*addr
,
325 struct prefix
*prefix
)
329 prefix
->family
= AF_INET
;
330 prefix
->prefixlen
= IPV4_MAX_BITLEN
;
331 prefix
->u
.prefix4
= addr
->ipv4
;
334 prefix
->family
= AF_INET6
;
335 prefix
->prefixlen
= IPV6_MAX_BITLEN
;
336 prefix
->u
.prefix6
= addr
->ipv6
;
339 memset(prefix
, 0, sizeof(*prefix
));
340 zlog_warn("%s: unknown address family %d", __func__
, af
);
345 void zebra_register_rnh_pseudowire(vrf_id_t vrf_id
, struct zebra_pw
*pw
)
350 struct zebra_vrf
*zvrf
;
352 zvrf
= vrf_info_lookup(vrf_id
);
356 addr2hostprefix(pw
->af
, &pw
->nexthop
, &nh
);
357 rnh
= zebra_add_rnh(&nh
, vrf_id
, RNH_NEXTHOP_TYPE
, &exists
);
358 if (rnh
&& !listnode_lookup(rnh
->zebra_pseudowire_list
, pw
)) {
359 listnode_add(rnh
->zebra_pseudowire_list
, pw
);
361 zebra_evaluate_rnh(zvrf
, family2afi(pw
->af
), 1,
362 RNH_NEXTHOP_TYPE
, &nh
);
366 void zebra_deregister_rnh_pseudowire(vrf_id_t vrf_id
, struct zebra_pw
*pw
)
374 listnode_delete(rnh
->zebra_pseudowire_list
, pw
);
377 zebra_delete_rnh(rnh
, RNH_NEXTHOP_TYPE
);
380 /* Clear the NEXTHOP_FLAG_RNH_FILTERED flags on all nexthops
382 static void zebra_rnh_clear_nexthop_rnh_filters(struct route_entry
*re
)
384 struct nexthop
*nexthop
;
387 for (nexthop
= re
->nhe
->nhg
.nexthop
; nexthop
;
388 nexthop
= nexthop
->next
) {
389 UNSET_FLAG(nexthop
->flags
, NEXTHOP_FLAG_RNH_FILTERED
);
394 /* Apply the NHT route-map for a client to the route (and nexthops)
397 static int zebra_rnh_apply_nht_rmap(afi_t afi
, struct zebra_vrf
*zvrf
,
398 struct route_node
*prn
,
399 struct route_entry
*re
, int proto
)
401 int at_least_one
= 0;
402 struct nexthop
*nexthop
;
403 route_map_result_t ret
;
406 for (nexthop
= re
->nhe
->nhg
.nexthop
; nexthop
;
407 nexthop
= nexthop
->next
) {
408 ret
= zebra_nht_route_map_check(
409 afi
, proto
, &prn
->p
, zvrf
, re
, nexthop
);
410 if (ret
!= RMAP_DENYMATCH
)
411 at_least_one
++; /* at least one valid NH */
413 SET_FLAG(nexthop
->flags
,
414 NEXTHOP_FLAG_RNH_FILTERED
);
418 return (at_least_one
);
422 * Determine appropriate route (RE entry) resolving a tracked BGP route
423 * for BGP route for import.
425 static struct route_entry
*
426 zebra_rnh_resolve_import_entry(struct zebra_vrf
*zvrf
, afi_t afi
,
427 struct route_node
*nrn
, struct rnh
*rnh
,
428 struct route_node
**prn
)
430 struct route_table
*route_table
;
431 struct route_node
*rn
;
432 struct route_entry
*re
;
436 route_table
= zvrf
->table
[afi
][SAFI_UNICAST
];
437 if (!route_table
) // unexpected
440 rn
= route_node_match(route_table
, &nrn
->p
);
444 /* Unlock route node - we don't need to lock when walking the tree. */
445 route_unlock_node(rn
);
447 if (CHECK_FLAG(rnh
->flags
, ZEBRA_NHT_EXACT_MATCH
)
448 && !prefix_same(&nrn
->p
, &rn
->p
))
451 if (IS_ZEBRA_DEBUG_NHT_DETAILED
) {
452 char buf
[PREFIX_STRLEN
];
453 char buf1
[PREFIX_STRLEN
];
455 zlog_debug("%s: %u:%s Resolved Import Entry to %s",
456 __PRETTY_FUNCTION__
, rnh
->vrf_id
,
457 prefix2str(&rnh
->node
->p
, buf
, sizeof(buf
)),
458 srcdest_rnode2str(rn
, buf1
, sizeof(buf
)));
461 /* Identify appropriate route entry. */
462 RNODE_FOREACH_RE (rn
, re
) {
463 if (!CHECK_FLAG(re
->status
, ROUTE_ENTRY_REMOVED
)
464 && CHECK_FLAG(re
->flags
, ZEBRA_FLAG_SELECTED
)
465 && !CHECK_FLAG(re
->status
, ROUTE_ENTRY_QUEUED
)
466 && (re
->type
!= ZEBRA_ROUTE_BGP
))
473 if (!re
&& IS_ZEBRA_DEBUG_NHT_DETAILED
)
474 zlog_debug("\tRejected due to removed or is a bgp route");
480 * See if a tracked route entry for import (by BGP) has undergone any
481 * change, and if so, notify the client.
483 static void zebra_rnh_eval_import_check_entry(struct zebra_vrf
*zvrf
, afi_t afi
,
484 int force
, struct route_node
*nrn
,
486 struct route_node
*prn
,
487 struct route_entry
*re
)
489 int state_changed
= 0;
490 struct zserv
*client
;
491 char bufn
[INET6_ADDRSTRLEN
];
492 struct listnode
*node
;
494 zebra_rnh_remove_from_routing_table(rnh
);
496 prefix_copy(&rnh
->resolved_route
, &prn
->p
);
498 int family
= rnh
->resolved_route
.family
;
500 memset(&rnh
->resolved_route
.family
, 0, sizeof(struct prefix
));
501 rnh
->resolved_route
.family
= family
;
503 zebra_rnh_store_in_routing_table(rnh
);
505 if (re
&& (rnh
->state
== NULL
)) {
506 if (CHECK_FLAG(re
->status
, ROUTE_ENTRY_INSTALLED
))
508 } else if (!re
&& (rnh
->state
!= NULL
))
511 if (compare_state(re
, rnh
->state
)) {
512 copy_state(rnh
, re
, nrn
);
516 if (state_changed
|| force
) {
517 if (IS_ZEBRA_DEBUG_NHT
) {
518 prefix2str(&nrn
->p
, bufn
, INET6_ADDRSTRLEN
);
519 zlog_debug("%u:%s: Route import check %s %s",
521 bufn
, rnh
->state
? "passed" : "failed",
522 state_changed
? "(state changed)" : "");
524 /* state changed, notify clients */
525 for (ALL_LIST_ELEMENTS_RO(rnh
->client_list
, node
, client
)) {
526 send_client(rnh
, client
,
527 RNH_IMPORT_CHECK_TYPE
, zvrf
->vrf
->vrf_id
);
533 * Notify clients registered for this nexthop about a change.
535 static void zebra_rnh_notify_protocol_clients(struct zebra_vrf
*zvrf
, afi_t afi
,
536 struct route_node
*nrn
,
538 struct route_node
*prn
,
539 struct route_entry
*re
)
541 struct listnode
*node
;
542 struct zserv
*client
;
543 char bufn
[INET6_ADDRSTRLEN
];
544 char bufp
[INET6_ADDRSTRLEN
];
545 int num_resolving_nh
;
547 if (IS_ZEBRA_DEBUG_NHT
) {
548 prefix2str(&nrn
->p
, bufn
, INET6_ADDRSTRLEN
);
550 srcdest_rnode2str(prn
, bufp
, INET6_ADDRSTRLEN
);
551 zlog_debug("%u:%s: NH resolved over route %s",
552 zvrf
->vrf
->vrf_id
, bufn
, bufp
);
554 zlog_debug("%u:%s: NH has become unresolved",
555 zvrf
->vrf
->vrf_id
, bufn
);
558 for (ALL_LIST_ELEMENTS_RO(rnh
->client_list
, node
, client
)) {
560 /* Apply route-map for this client to route resolving
562 * nexthop to see if it is filtered or not.
564 zebra_rnh_clear_nexthop_rnh_filters(re
);
565 num_resolving_nh
= zebra_rnh_apply_nht_rmap(
566 afi
, zvrf
, prn
, re
, client
->proto
);
567 if (num_resolving_nh
)
568 rnh
->filtered
[client
->proto
] = 0;
570 rnh
->filtered
[client
->proto
] = 1;
572 if (IS_ZEBRA_DEBUG_NHT
)
574 "%u:%s: Notifying client %s about NH %s",
575 zvrf
->vrf
->vrf_id
, bufn
,
576 zebra_route_string(client
->proto
),
579 : "(filtered by route-map)");
581 rnh
->filtered
[client
->proto
] = 0;
582 if (IS_ZEBRA_DEBUG_NHT
)
584 "%u:%s: Notifying client %s about NH (unreachable)",
585 zvrf
->vrf
->vrf_id
, bufn
,
586 zebra_route_string(client
->proto
));
589 send_client(rnh
, client
, RNH_NEXTHOP_TYPE
, zvrf
->vrf
->vrf_id
);
593 zebra_rnh_clear_nexthop_rnh_filters(re
);
597 * Utility to determine whether a candidate nexthop is useable. We make this
598 * check in a couple of places, so this is a single home for the logic we
601 static bool rnh_nexthop_valid(const struct route_entry
*re
,
602 const struct nexthop
*nh
)
604 return (CHECK_FLAG(re
->status
, ROUTE_ENTRY_INSTALLED
)
605 && CHECK_FLAG(nh
->flags
, NEXTHOP_FLAG_ACTIVE
)
606 && !CHECK_FLAG(nh
->flags
, NEXTHOP_FLAG_RECURSIVE
)
607 && !CHECK_FLAG(nh
->flags
, NEXTHOP_FLAG_DUPLICATE
)
608 && !CHECK_FLAG(nh
->flags
, NEXTHOP_FLAG_RNH_FILTERED
));
612 * Determine appropriate route (route entry) resolving a tracked
615 static struct route_entry
*
616 zebra_rnh_resolve_nexthop_entry(struct zebra_vrf
*zvrf
, afi_t afi
,
617 struct route_node
*nrn
, struct rnh
*rnh
,
618 struct route_node
**prn
)
620 struct route_table
*route_table
;
621 struct route_node
*rn
;
622 struct route_entry
*re
;
623 struct nexthop
*nexthop
;
627 route_table
= zvrf
->table
[afi
][SAFI_UNICAST
];
631 rn
= route_node_match(route_table
, &nrn
->p
);
635 /* Unlock route node - we don't need to lock when walking the tree. */
636 route_unlock_node(rn
);
638 /* While resolving nexthops, we may need to walk up the tree from the
639 * most-specific match. Do similar logic as in zebra_rib.c
642 if (IS_ZEBRA_DEBUG_NHT_DETAILED
) {
643 char buf
[PREFIX_STRLEN
];
644 char buf1
[PREFIX_STRLEN
];
646 zlog_debug("%s: %u:%s Possible Match to %s",
647 __PRETTY_FUNCTION__
, rnh
->vrf_id
,
648 prefix2str(&rnh
->node
->p
, buf
, sizeof(buf
)),
649 srcdest_rnode2str(rn
, buf1
, sizeof(buf
)));
652 /* Do not resolve over default route unless allowed &&
653 * match route to be exact if so specified
655 if (is_default_prefix(&rn
->p
)
656 && !rnh_resolve_via_default(zvrf
, rn
->p
.family
)) {
657 if (IS_ZEBRA_DEBUG_NHT_DETAILED
)
659 "\tNot allowed to resolve through default prefix");
663 /* Identify appropriate route entry. */
664 RNODE_FOREACH_RE (rn
, re
) {
665 if (CHECK_FLAG(re
->status
, ROUTE_ENTRY_REMOVED
)) {
666 if (IS_ZEBRA_DEBUG_NHT_DETAILED
)
668 "\tRoute Entry %s removed",
669 zebra_route_string(re
->type
));
672 if (!CHECK_FLAG(re
->flags
, ZEBRA_FLAG_SELECTED
)) {
673 if (IS_ZEBRA_DEBUG_NHT_DETAILED
)
675 "\tRoute Entry %s !selected",
676 zebra_route_string(re
->type
));
680 if (CHECK_FLAG(re
->status
, ROUTE_ENTRY_QUEUED
)) {
681 if (IS_ZEBRA_DEBUG_NHT_DETAILED
)
683 "\tRoute Entry %s queued",
684 zebra_route_string(re
->type
));
688 /* Just being SELECTED isn't quite enough - must
689 * have an installed nexthop to be useful.
691 for (ALL_NEXTHOPS(re
->nhe
->nhg
, nexthop
)) {
692 if (rnh_nexthop_valid(re
, nexthop
))
696 if (nexthop
== NULL
) {
697 if (IS_ZEBRA_DEBUG_NHT_DETAILED
)
699 "\tRoute Entry %s no nexthops",
700 zebra_route_string(re
->type
));
704 if (CHECK_FLAG(rnh
->flags
, ZEBRA_NHT_CONNECTED
)) {
705 if ((re
->type
== ZEBRA_ROUTE_CONNECT
)
706 || (re
->type
== ZEBRA_ROUTE_STATIC
))
708 if (re
->type
== ZEBRA_ROUTE_NHRP
) {
710 for (nexthop
= re
->nhe
->nhg
.nexthop
;
712 nexthop
= nexthop
->next
)
714 == NEXTHOP_TYPE_IFINDEX
)
723 /* Route entry found, we're done; else, walk up the tree. */
729 if (!CHECK_FLAG(rnh
->flags
, ZEBRA_NHT_CONNECTED
))
732 if (IS_ZEBRA_DEBUG_NHT_DETAILED
)
734 "\tNexthop must be connected, cannot recurse up");
742 static void zebra_rnh_process_pseudowires(vrf_id_t vrfid
, struct rnh
*rnh
)
745 struct listnode
*node
;
747 for (ALL_LIST_ELEMENTS_RO(rnh
->zebra_pseudowire_list
, node
, pw
))
752 * See if a tracked nexthop entry has undergone any change, and if so,
753 * take appropriate action; this involves notifying any clients and/or
754 * scheduling dependent static routes for processing.
756 static void zebra_rnh_eval_nexthop_entry(struct zebra_vrf
*zvrf
, afi_t afi
,
757 int force
, struct route_node
*nrn
,
759 struct route_node
*prn
,
760 struct route_entry
*re
)
762 int state_changed
= 0;
764 /* If we're resolving over a different route, resolution has changed or
765 * the resolving route has some change (e.g., metric), there is a state
768 zebra_rnh_remove_from_routing_table(rnh
);
769 if (!prefix_same(&rnh
->resolved_route
, prn
? &prn
->p
: NULL
)) {
771 prefix_copy(&rnh
->resolved_route
, &prn
->p
);
774 * Just quickly store the family of the resolved
775 * route so that we can reset it in a second here
777 int family
= rnh
->resolved_route
.family
;
779 memset(&rnh
->resolved_route
, 0, sizeof(struct prefix
));
780 rnh
->resolved_route
.family
= family
;
783 copy_state(rnh
, re
, nrn
);
785 } else if (compare_state(re
, rnh
->state
)) {
786 copy_state(rnh
, re
, nrn
);
789 zebra_rnh_store_in_routing_table(rnh
);
791 if (state_changed
|| force
) {
792 /* NOTE: Use the "copy" of resolving route stored in 'rnh' i.e.,
795 /* Notify registered protocol clients. */
796 zebra_rnh_notify_protocol_clients(zvrf
, afi
, nrn
, rnh
, prn
,
799 /* Process pseudowires attached to this nexthop */
800 zebra_rnh_process_pseudowires(zvrf
->vrf
->vrf_id
, rnh
);
804 /* Evaluate one tracked entry */
805 static void zebra_rnh_evaluate_entry(struct zebra_vrf
*zvrf
, afi_t afi
,
806 int force
, rnh_type_t type
,
807 struct route_node
*nrn
)
810 struct route_entry
*re
;
811 struct route_node
*prn
;
812 char bufn
[INET6_ADDRSTRLEN
];
814 if (IS_ZEBRA_DEBUG_NHT
) {
815 prefix2str(&nrn
->p
, bufn
, INET6_ADDRSTRLEN
);
816 zlog_debug("%u:%s: Evaluate RNH, type %s %s", zvrf
->vrf
->vrf_id
,
817 bufn
, rnh_type2str(type
), force
? "(force)" : "");
822 /* Identify route entry (RE) resolving this tracked entry. */
823 if (type
== RNH_IMPORT_CHECK_TYPE
)
824 re
= zebra_rnh_resolve_import_entry(zvrf
, afi
, nrn
, rnh
, &prn
);
826 re
= zebra_rnh_resolve_nexthop_entry(zvrf
, afi
, nrn
, rnh
, &prn
);
828 /* If the entry cannot be resolved and that is also the existing state,
829 * there is nothing further to do.
831 if (!re
&& rnh
->state
== NULL
&& !force
)
834 /* Process based on type of entry. */
835 if (type
== RNH_IMPORT_CHECK_TYPE
)
836 zebra_rnh_eval_import_check_entry(zvrf
, afi
, force
, nrn
, rnh
,
839 zebra_rnh_eval_nexthop_entry(zvrf
, afi
, force
, nrn
, rnh
, prn
,
844 * Clear the ROUTE_ENTRY_NEXTHOPS_CHANGED flag
845 * from the re entries.
847 * Please note we are doing this *after* we have
848 * notified the world about each nexthop as that
849 * we can have a situation where one re entry
850 * covers multiple nexthops we are interested in.
852 static void zebra_rnh_clear_nhc_flag(struct zebra_vrf
*zvrf
, afi_t afi
,
853 rnh_type_t type
, struct route_node
*nrn
)
856 struct route_entry
*re
;
857 struct route_node
*prn
;
861 /* Identify route entry (RIB) resolving this tracked entry. */
862 if (type
== RNH_IMPORT_CHECK_TYPE
)
863 re
= zebra_rnh_resolve_import_entry(zvrf
, afi
, nrn
, rnh
,
866 re
= zebra_rnh_resolve_nexthop_entry(zvrf
, afi
, nrn
, rnh
,
870 UNSET_FLAG(re
->status
, ROUTE_ENTRY_LABELS_CHANGED
);
873 /* Evaluate all tracked entries (nexthops or routes for import into BGP)
874 * of a particular VRF and address-family or a specific prefix.
876 void zebra_evaluate_rnh(struct zebra_vrf
*zvrf
, afi_t afi
, int force
,
877 rnh_type_t type
, struct prefix
*p
)
879 struct route_table
*rnh_table
;
880 struct route_node
*nrn
;
882 rnh_table
= get_rnh_table(zvrf
->vrf
->vrf_id
, afi
, type
);
883 if (!rnh_table
) // unexpected
887 /* Evaluating a specific entry, make sure it exists. */
888 nrn
= route_node_lookup(rnh_table
, p
);
889 if (nrn
&& nrn
->info
)
890 zebra_rnh_evaluate_entry(zvrf
, afi
, force
, type
, nrn
);
893 route_unlock_node(nrn
);
895 /* Evaluate entire table. */
896 nrn
= route_top(rnh_table
);
899 zebra_rnh_evaluate_entry(zvrf
, afi
, force
, type
,
901 nrn
= route_next(nrn
); /* this will also unlock nrn */
903 nrn
= route_top(rnh_table
);
906 zebra_rnh_clear_nhc_flag(zvrf
, afi
, type
, nrn
);
907 nrn
= route_next(nrn
); /* this will also unlock nrn */
912 void zebra_print_rnh_table(vrf_id_t vrfid
, afi_t afi
, struct vty
*vty
,
913 rnh_type_t type
, struct prefix
*p
)
915 struct route_table
*table
;
916 struct route_node
*rn
;
918 table
= get_rnh_table(vrfid
, afi
, type
);
920 if (IS_ZEBRA_DEBUG_NHT
)
921 zlog_debug("print_rnhs: rnh table not found");
925 for (rn
= route_top(table
); rn
; rn
= route_next(rn
)) {
926 if (p
&& !prefix_match(&rn
->p
, p
))
935 * free_state - free up the re structure associated with the rnh.
937 static void free_state(vrf_id_t vrf_id
, struct route_entry
*re
,
938 struct route_node
*rn
)
943 /* free RE and nexthops */
944 zebra_nhg_free(re
->nhe
);
948 static void copy_state(struct rnh
*rnh
, const struct route_entry
*re
,
949 struct route_node
*rn
)
951 struct route_entry
*state
;
954 free_state(rnh
->vrf_id
, rnh
->state
, rn
);
961 state
= XCALLOC(MTYPE_RE
, sizeof(struct route_entry
));
962 state
->type
= re
->type
;
963 state
->distance
= re
->distance
;
964 state
->metric
= re
->metric
;
965 state
->vrf_id
= re
->vrf_id
;
966 state
->status
= re
->status
;
968 state
->nhe
= zebra_nhg_alloc();
970 nexthop_group_copy(&(state
->nhe
->nhg
), &(re
->nhe
->nhg
));
974 static int compare_state(struct route_entry
*r1
, struct route_entry
*r2
)
979 if ((!r1
&& r2
) || (r1
&& !r2
))
982 if (r1
->distance
!= r2
->distance
)
985 if (r1
->metric
!= r2
->metric
)
988 if (nexthop_group_nexthop_num(&(r1
->nhe
->nhg
))
989 != nexthop_group_nexthop_num(&(r2
->nhe
->nhg
)))
992 if (nexthop_group_hash(&(r1
->nhe
->nhg
)) !=
993 nexthop_group_hash(&(r2
->nhe
->nhg
)))
999 static int send_client(struct rnh
*rnh
, struct zserv
*client
, rnh_type_t type
,
1003 struct route_entry
*re
;
1007 struct route_node
*rn
;
1008 int cmd
= (type
== RNH_IMPORT_CHECK_TYPE
) ? ZEBRA_IMPORT_CHECK_UPDATE
1009 : ZEBRA_NEXTHOP_UPDATE
;
1014 /* Get output stream. */
1015 s
= stream_new(ZEBRA_MAX_PACKET_SIZ
);
1017 zclient_create_header(s
, cmd
, vrf_id
);
1019 stream_putw(s
, rn
->p
.family
);
1020 switch (rn
->p
.family
) {
1022 stream_putc(s
, rn
->p
.prefixlen
);
1023 stream_put_in_addr(s
, &rn
->p
.u
.prefix4
);
1026 stream_putc(s
, rn
->p
.prefixlen
);
1027 stream_put(s
, &rn
->p
.u
.prefix6
, IPV6_MAX_BYTELEN
);
1030 flog_err(EC_ZEBRA_RNH_UNKNOWN_FAMILY
,
1031 "%s: Unknown family (%d) notification attempted\n",
1032 __FUNCTION__
, rn
->p
.family
);
1036 struct zapi_nexthop znh
;
1038 stream_putc(s
, re
->type
);
1039 stream_putw(s
, re
->instance
);
1040 stream_putc(s
, re
->distance
);
1041 stream_putl(s
, re
->metric
);
1043 nump
= stream_get_endp(s
);
1045 for (ALL_NEXTHOPS(re
->nhe
->nhg
, nh
))
1046 if (rnh_nexthop_valid(re
, nh
)) {
1047 zapi_nexthop_from_nexthop(&znh
, nh
);
1048 zapi_nexthop_encode(s
, &znh
, 0 /* flags */);
1051 stream_putc_at(s
, nump
, num
);
1053 stream_putc(s
, 0); // type
1054 stream_putw(s
, 0); // instance
1055 stream_putc(s
, 0); // distance
1056 stream_putl(s
, 0); // metric
1057 stream_putc(s
, 0); // nexthops
1059 stream_putw_at(s
, 0, stream_get_endp(s
));
1061 client
->nh_last_upd_time
= monotime(NULL
);
1062 client
->last_write_cmd
= cmd
;
1063 return zserv_send_message(client
, s
);
1066 static void print_nh(struct nexthop
*nexthop
, struct vty
*vty
)
1069 struct zebra_ns
*zns
= zebra_ns_lookup(nexthop
->vrf_id
);
1071 switch (nexthop
->type
) {
1072 case NEXTHOP_TYPE_IPV4
:
1073 case NEXTHOP_TYPE_IPV4_IFINDEX
:
1074 vty_out(vty
, " via %s", inet_ntoa(nexthop
->gate
.ipv4
));
1075 if (nexthop
->ifindex
)
1076 vty_out(vty
, ", %s",
1077 ifindex2ifname_per_ns(zns
, nexthop
->ifindex
));
1079 case NEXTHOP_TYPE_IPV6
:
1080 case NEXTHOP_TYPE_IPV6_IFINDEX
:
1082 inet_ntop(AF_INET6
, &nexthop
->gate
.ipv6
, buf
, BUFSIZ
));
1083 if (nexthop
->ifindex
)
1084 vty_out(vty
, ", via %s",
1085 ifindex2ifname_per_ns(zns
, nexthop
->ifindex
));
1087 case NEXTHOP_TYPE_IFINDEX
:
1088 vty_out(vty
, " is directly connected, %s",
1089 ifindex2ifname_per_ns(zns
, nexthop
->ifindex
));
1091 case NEXTHOP_TYPE_BLACKHOLE
:
1092 vty_out(vty
, " is directly connected, Null0");
1100 static void print_rnh(struct route_node
*rn
, struct vty
*vty
)
1103 struct nexthop
*nexthop
;
1104 struct listnode
*node
;
1105 struct zserv
*client
;
1109 vty_out(vty
, "%s%s\n",
1110 inet_ntop(rn
->p
.family
, &rn
->p
.u
.prefix
, buf
, BUFSIZ
),
1111 CHECK_FLAG(rnh
->flags
, ZEBRA_NHT_CONNECTED
) ? "(Connected)"
1114 vty_out(vty
, " resolved via %s\n",
1115 zebra_route_string(rnh
->state
->type
));
1116 for (nexthop
= rnh
->state
->nhe
->nhg
.nexthop
; nexthop
;
1117 nexthop
= nexthop
->next
)
1118 print_nh(nexthop
, vty
);
1120 vty_out(vty
, " unresolved%s\n",
1121 CHECK_FLAG(rnh
->flags
, ZEBRA_NHT_CONNECTED
)
1125 vty_out(vty
, " Client list:");
1126 for (ALL_LIST_ELEMENTS_RO(rnh
->client_list
, node
, client
))
1127 vty_out(vty
, " %s(fd %d)%s", zebra_route_string(client
->proto
),
1129 rnh
->filtered
[client
->proto
] ? "(filtered)" : "");
1130 if (!list_isempty(rnh
->zebra_pseudowire_list
))
1131 vty_out(vty
, " zebra[pseudowires]");
1135 static int zebra_cleanup_rnh_client(vrf_id_t vrf_id
, afi_t afi
,
1136 struct zserv
*client
, rnh_type_t type
)
1138 struct route_table
*ntable
;
1139 struct route_node
*nrn
;
1142 if (IS_ZEBRA_DEBUG_NHT
)
1143 zlog_debug("%u: Client %s RNH cleanup for family %s type %s",
1144 vrf_id
, zebra_route_string(client
->proto
),
1145 afi2str(afi
), rnh_type2str(type
));
1147 ntable
= get_rnh_table(vrf_id
, afi
, type
);
1149 zlog_debug("cleanup_rnh_client: rnh table not found");
1153 for (nrn
= route_top(ntable
); nrn
; nrn
= route_next(nrn
)) {
1158 zebra_remove_rnh_client(rnh
, client
, type
);
1163 /* Cleanup registered nexthops (across VRFs) upon client disconnect. */
1164 static int zebra_client_cleanup_rnh(struct zserv
*client
)
1167 struct zebra_vrf
*zvrf
;
1169 RB_FOREACH (vrf
, vrf_id_head
, &vrfs_by_id
) {
1172 zebra_cleanup_rnh_client(zvrf_id(zvrf
), AFI_IP
, client
,
1174 zebra_cleanup_rnh_client(zvrf_id(zvrf
), AFI_IP6
, client
,
1176 zebra_cleanup_rnh_client(zvrf_id(zvrf
), AFI_IP
, client
,
1177 RNH_IMPORT_CHECK_TYPE
);
1178 zebra_cleanup_rnh_client(zvrf_id(zvrf
), AFI_IP6
, client
,
1179 RNH_IMPORT_CHECK_TYPE
);
1186 int rnh_resolve_via_default(struct zebra_vrf
*zvrf
, int family
)
1188 if (((family
== AF_INET
) && zvrf
->zebra_rnh_ip_default_route
)
1189 || ((family
== AF_INET6
) && zvrf
->zebra_rnh_ipv6_default_route
))