3 * Copyright (C) 2015 Cumulus Networks, Inc.
6 * This program is free software; you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License as published by
8 * the Free Software Foundation; either version 2 of the License, or
9 * (at your option) any later version.
11 * This program 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
34 #include "lib_errors.h"
39 #include "pim_iface.h"
44 #include "pim_memory.h"
45 #include "pim_neighbor.h"
48 #include "pim_mroute.h"
50 #include "pim_zebra.h"
53 /* Cleanup pim->rpf_hash each node data */
54 void pim_rp_list_hash_clean(void *data
)
56 struct pim_nexthop_cache
*pnc
= (struct pim_nexthop_cache
*)data
;
58 list_delete(&pnc
->rp_list
);
60 hash_clean(pnc
->upstream_hash
, NULL
);
61 hash_free(pnc
->upstream_hash
);
62 pnc
->upstream_hash
= NULL
;
64 nexthops_free(pnc
->nexthop
);
66 XFREE(MTYPE_PIM_NEXTHOP_CACHE
, pnc
);
69 static void pim_rp_info_free(struct rp_info
*rp_info
)
71 XFREE(MTYPE_PIM_FILTER_NAME
, rp_info
->plist
);
73 XFREE(MTYPE_PIM_RP
, rp_info
);
76 int pim_rp_list_cmp(void *v1
, void *v2
)
78 struct rp_info
*rp1
= (struct rp_info
*)v1
;
79 struct rp_info
*rp2
= (struct rp_info
*)v2
;
82 * Sort by RP IP address
84 if (rp1
->rp
.rpf_addr
.u
.prefix4
.s_addr
85 < rp2
->rp
.rpf_addr
.u
.prefix4
.s_addr
)
88 if (rp1
->rp
.rpf_addr
.u
.prefix4
.s_addr
89 > rp2
->rp
.rpf_addr
.u
.prefix4
.s_addr
)
93 * Sort by group IP address
95 if (rp1
->group
.u
.prefix4
.s_addr
< rp2
->group
.u
.prefix4
.s_addr
)
98 if (rp1
->group
.u
.prefix4
.s_addr
> rp2
->group
.u
.prefix4
.s_addr
)
104 void pim_rp_init(struct pim_instance
*pim
)
106 struct rp_info
*rp_info
;
107 struct route_node
*rn
;
109 pim
->rp_list
= list_new();
110 pim
->rp_list
->del
= (void (*)(void *))pim_rp_info_free
;
111 pim
->rp_list
->cmp
= pim_rp_list_cmp
;
113 pim
->rp_table
= route_table_init();
115 rp_info
= XCALLOC(MTYPE_PIM_RP
, sizeof(*rp_info
));
117 if (!str2prefix("224.0.0.0/4", &rp_info
->group
)) {
118 flog_err(EC_LIB_DEVELOPMENT
,
119 "Unable to convert 224.0.0.0/4 to prefix");
120 list_delete(&pim
->rp_list
);
121 route_table_finish(pim
->rp_table
);
122 XFREE(MTYPE_PIM_RP
, rp_info
);
125 rp_info
->group
.family
= AF_INET
;
126 rp_info
->rp
.rpf_addr
.family
= AF_INET
;
127 rp_info
->rp
.rpf_addr
.prefixlen
= IPV4_MAX_BITLEN
;
128 rp_info
->rp
.rpf_addr
.u
.prefix4
.s_addr
= INADDR_NONE
;
130 listnode_add(pim
->rp_list
, rp_info
);
132 rn
= route_node_get(pim
->rp_table
, &rp_info
->group
);
134 if (PIM_DEBUG_PIM_TRACE
)
136 "Allocated: %p for rp_info: %p(224.0.0.0/4) Lock: %d",
137 rn
, rp_info
, route_node_get_lock_count(rn
));
140 void pim_rp_free(struct pim_instance
*pim
)
143 route_table_finish(pim
->rp_table
);
144 pim
->rp_table
= NULL
;
147 list_delete(&pim
->rp_list
);
151 * Given an RP's prefix-list, return the RP's rp_info for that prefix-list
153 static struct rp_info
*pim_rp_find_prefix_list(struct pim_instance
*pim
,
157 struct listnode
*node
;
158 struct rp_info
*rp_info
;
160 for (ALL_LIST_ELEMENTS_RO(pim
->rp_list
, node
, rp_info
)) {
161 if (rp
.s_addr
== rp_info
->rp
.rpf_addr
.u
.prefix4
.s_addr
162 && rp_info
->plist
&& strcmp(rp_info
->plist
, plist
) == 0) {
171 * Return true if plist is used by any rp_info
173 static int pim_rp_prefix_list_used(struct pim_instance
*pim
, const char *plist
)
175 struct listnode
*node
;
176 struct rp_info
*rp_info
;
178 for (ALL_LIST_ELEMENTS_RO(pim
->rp_list
, node
, rp_info
)) {
179 if (rp_info
->plist
&& strcmp(rp_info
->plist
, plist
) == 0) {
188 * Given an RP's address, return the RP's rp_info that is an exact match for
191 static struct rp_info
*pim_rp_find_exact(struct pim_instance
*pim
,
193 const struct prefix
*group
)
195 struct listnode
*node
;
196 struct rp_info
*rp_info
;
198 for (ALL_LIST_ELEMENTS_RO(pim
->rp_list
, node
, rp_info
)) {
199 if (rp
.s_addr
== rp_info
->rp
.rpf_addr
.u
.prefix4
.s_addr
200 && prefix_same(&rp_info
->group
, group
))
208 * XXX: long-term issue: we don't actually have a good "ip address-list"
209 * implementation. ("access-list XYZ" is the closest but honestly it's
212 * So it's using a prefix-list to match an address here, which causes very
213 * unexpected results for the user since prefix-lists by default only match
214 * when the prefix length is an exact match too. i.e. you'd have to add the
215 * "le 32" and do "ip prefix-list foo permit 10.0.0.0/24 le 32"
217 * To avoid this pitfall, this code uses "address_mode = true" for the prefix
218 * list match (this is the only user for that.)
220 * In the long run, we need to add a "ip address-list", but that's a wholly
221 * separate bag of worms, and existing configs using ip prefix-list would
222 * drop into the UX pitfall.
225 #include "lib/plist_int.h"
228 * Given a group, return the rp_info for that group
230 struct rp_info
*pim_rp_find_match_group(struct pim_instance
*pim
,
231 const struct prefix
*group
)
233 struct listnode
*node
;
234 struct rp_info
*best
= NULL
;
235 struct rp_info
*rp_info
;
236 struct prefix_list
*plist
;
237 const struct prefix
*bp
;
238 const struct prefix_list_entry
*entry
;
239 struct route_node
*rn
;
242 for (ALL_LIST_ELEMENTS_RO(pim
->rp_list
, node
, rp_info
)) {
243 if (rp_info
->plist
) {
244 plist
= prefix_list_lookup(AFI_IP
, rp_info
->plist
);
246 if (prefix_list_apply_ext(plist
, &entry
, group
, true)
247 == PREFIX_DENY
|| !entry
)
256 if (bp
&& bp
->prefixlen
< entry
->prefix
.prefixlen
) {
263 rn
= route_node_match(pim
->rp_table
, group
);
267 "%s: BUG We should have found default group information",
273 if (PIM_DEBUG_PIM_TRACE
)
274 zlog_debug("Lookedup: %p for rp_info: %p(%pFX) Lock: %d", rn
,
275 rp_info
, &rp_info
->group
,
276 route_node_get_lock_count(rn
));
278 route_unlock_node(rn
);
283 if (rp_info
->group
.prefixlen
< best
->group
.prefixlen
)
290 * When the user makes "ip pim rp" configuration changes or if they change the
291 * prefix-list(s) used by these statements we must tickle the upstream state
292 * for each group to make them re-lookup who their RP should be.
294 * This is a placeholder function for now.
296 void pim_rp_refresh_group_to_rp_mapping(struct pim_instance
*pim
)
298 pim_msdp_i_am_rp_changed(pim
);
299 pim_upstream_reeval_use_rpt(pim
);
302 void pim_rp_prefix_list_update(struct pim_instance
*pim
,
303 struct prefix_list
*plist
)
305 struct listnode
*node
;
306 struct rp_info
*rp_info
;
307 int refresh_needed
= 0;
309 for (ALL_LIST_ELEMENTS_RO(pim
->rp_list
, node
, rp_info
)) {
311 && strcmp(rp_info
->plist
, prefix_list_name(plist
)) == 0) {
318 pim_rp_refresh_group_to_rp_mapping(pim
);
321 static int pim_rp_check_interface_addrs(struct rp_info
*rp_info
,
322 struct pim_interface
*pim_ifp
)
324 struct listnode
*node
;
325 struct pim_secondary_addr
*sec_addr
;
327 if (pim_ifp
->primary_address
.s_addr
328 == rp_info
->rp
.rpf_addr
.u
.prefix4
.s_addr
)
331 if (!pim_ifp
->sec_addr_list
) {
335 for (ALL_LIST_ELEMENTS_RO(pim_ifp
->sec_addr_list
, node
, sec_addr
)) {
336 if (prefix_same(&sec_addr
->addr
, &rp_info
->rp
.rpf_addr
)) {
344 static void pim_rp_check_interfaces(struct pim_instance
*pim
,
345 struct rp_info
*rp_info
)
347 struct interface
*ifp
;
349 rp_info
->i_am_rp
= 0;
350 FOR_ALL_INTERFACES (pim
->vrf
, ifp
) {
351 struct pim_interface
*pim_ifp
= ifp
->info
;
356 if (pim_rp_check_interface_addrs(rp_info
, pim_ifp
)) {
357 rp_info
->i_am_rp
= 1;
362 void pim_upstream_update(struct pim_instance
*pim
, struct pim_upstream
*up
)
364 struct pim_rpf old_rpf
;
365 enum pim_rpf_result rpf_result
;
366 struct in_addr old_upstream_addr
;
367 struct in_addr new_upstream_addr
;
370 old_upstream_addr
= up
->upstream_addr
;
371 pim_rp_set_upstream_addr(pim
, &new_upstream_addr
, up
->sg
.src
,
374 if (PIM_DEBUG_PIM_TRACE
)
375 zlog_debug("%s: pim upstream update for old upstream %pI4",
376 __func__
, &old_upstream_addr
);
378 if (old_upstream_addr
.s_addr
== new_upstream_addr
.s_addr
)
381 /* Lets consider a case, where a PIM upstream has a better RP as a
382 * result of a new RP configuration with more precise group range.
383 * This upstream has to be added to the upstream hash of new RP's
384 * NHT(pnc) and has to be removed from old RP's NHT upstream hash
386 if (old_upstream_addr
.s_addr
!= INADDR_ANY
) {
387 /* Deregister addr with Zebra NHT */
388 nht_p
.family
= AF_INET
;
389 nht_p
.prefixlen
= IPV4_MAX_BITLEN
;
390 nht_p
.u
.prefix4
= old_upstream_addr
;
391 if (PIM_DEBUG_PIM_TRACE
)
393 "%s: Deregister upstream %s addr %pFX with Zebra NHT",
394 __func__
, up
->sg_str
, &nht_p
);
395 pim_delete_tracked_nexthop(pim
, &nht_p
, up
, NULL
);
398 /* Update the upstream address */
399 up
->upstream_addr
= new_upstream_addr
;
401 old_rpf
.source_nexthop
.interface
= up
->rpf
.source_nexthop
.interface
;
403 rpf_result
= pim_rpf_update(pim
, up
, &old_rpf
, __func__
);
404 if (rpf_result
== PIM_RPF_FAILURE
)
405 pim_mroute_del(up
->channel_oil
, __func__
);
407 /* update kernel multicast forwarding cache (MFC) */
408 if (up
->rpf
.source_nexthop
.interface
&& up
->channel_oil
)
409 pim_upstream_mroute_iif_update(up
->channel_oil
, __func__
);
411 if (rpf_result
== PIM_RPF_CHANGED
||
412 (rpf_result
== PIM_RPF_FAILURE
&&
413 old_rpf
.source_nexthop
.interface
))
414 pim_zebra_upstream_rpf_changed(pim
, up
, &old_rpf
);
418 int pim_rp_new(struct pim_instance
*pim
, struct in_addr rp_addr
,
419 struct prefix group
, const char *plist
,
420 enum rp_source rp_src_flag
)
423 char rp
[INET_ADDRSTRLEN
];
424 struct rp_info
*rp_info
;
425 struct rp_info
*rp_all
;
426 struct prefix group_all
;
427 struct listnode
*node
, *nnode
;
428 struct rp_info
*tmp_rp_info
;
431 struct route_node
*rn
;
432 struct pim_upstream
*up
;
433 bool upstream_updated
= false;
435 if (rp_addr
.s_addr
== INADDR_ANY
||
436 rp_addr
.s_addr
== INADDR_NONE
)
437 return PIM_RP_BAD_ADDRESS
;
439 rp_info
= XCALLOC(MTYPE_PIM_RP
, sizeof(*rp_info
));
441 rp_info
->rp
.rpf_addr
.family
= AF_INET
;
442 rp_info
->rp
.rpf_addr
.prefixlen
= IPV4_MAX_BITLEN
;
443 rp_info
->rp
.rpf_addr
.u
.prefix4
= rp_addr
;
444 prefix_copy(&rp_info
->group
, &group
);
445 rp_info
->rp_src
= rp_src_flag
;
447 inet_ntop(AF_INET
, &rp_info
->rp
.rpf_addr
.u
.prefix4
, rp
, sizeof(rp
));
451 * Return if the prefix-list is already configured for this RP
453 if (pim_rp_find_prefix_list(pim
, rp_info
->rp
.rpf_addr
.u
.prefix4
,
455 XFREE(MTYPE_PIM_RP
, rp_info
);
460 * Barf if the prefix-list is already configured for an RP
462 if (pim_rp_prefix_list_used(pim
, plist
)) {
463 XFREE(MTYPE_PIM_RP
, rp_info
);
464 return PIM_RP_PFXLIST_IN_USE
;
468 * Free any existing rp_info entries for this RP
470 for (ALL_LIST_ELEMENTS(pim
->rp_list
, node
, nnode
,
472 if (rp_info
->rp
.rpf_addr
.u
.prefix4
.s_addr
473 == tmp_rp_info
->rp
.rpf_addr
.u
.prefix4
.s_addr
) {
474 if (tmp_rp_info
->plist
)
475 pim_rp_del_config(pim
, rp
, NULL
,
480 prefix2str(&tmp_rp_info
->group
,
486 rp_info
->plist
= XSTRDUP(MTYPE_PIM_FILTER_NAME
, plist
);
489 if (!str2prefix("224.0.0.0/4", &group_all
)) {
490 XFREE(MTYPE_PIM_RP
, rp_info
);
491 return PIM_GROUP_BAD_ADDRESS
;
493 rp_all
= pim_rp_find_match_group(pim
, &group_all
);
496 * Barf if group is a non-multicast subnet
498 if (!prefix_match(&rp_all
->group
, &rp_info
->group
)) {
499 XFREE(MTYPE_PIM_RP
, rp_info
);
500 return PIM_GROUP_BAD_ADDRESS
;
504 * Remove any prefix-list rp_info entries for this RP
506 for (ALL_LIST_ELEMENTS(pim
->rp_list
, node
, nnode
,
508 if (tmp_rp_info
->plist
509 && rp_info
->rp
.rpf_addr
.u
.prefix4
.s_addr
510 == tmp_rp_info
->rp
.rpf_addr
.u
.prefix4
512 pim_rp_del_config(pim
, rp
, NULL
,
518 * Take over the 224.0.0.0/4 group if the rp is INADDR_NONE
520 if (prefix_same(&rp_all
->group
, &rp_info
->group
)
521 && pim_rpf_addr_is_inaddr_none(&rp_all
->rp
)) {
522 rp_all
->rp
.rpf_addr
= rp_info
->rp
.rpf_addr
;
523 rp_all
->rp_src
= rp_src_flag
;
524 XFREE(MTYPE_PIM_RP
, rp_info
);
526 /* Register addr with Zebra NHT */
527 nht_p
.family
= AF_INET
;
528 nht_p
.prefixlen
= IPV4_MAX_BITLEN
;
530 rp_all
->rp
.rpf_addr
.u
.prefix4
; // RP address
531 if (PIM_DEBUG_PIM_NHT_RP
)
533 "%s: NHT Register rp_all addr %pFX grp %pFX ",
534 __func__
, &nht_p
, &rp_all
->group
);
536 frr_each (rb_pim_upstream
, &pim
->upstream_head
, up
) {
537 /* Find (*, G) upstream whose RP is not
540 if ((up
->upstream_addr
.s_addr
== INADDR_ANY
)
541 && (up
->sg
.src
.s_addr
== INADDR_ANY
)) {
543 struct rp_info
*trp_info
;
545 grp
.family
= AF_INET
;
546 grp
.prefixlen
= IPV4_MAX_BITLEN
;
547 grp
.u
.prefix4
= up
->sg
.grp
;
548 trp_info
= pim_rp_find_match_group(
550 if (trp_info
== rp_all
) {
551 pim_upstream_update(pim
, up
);
552 upstream_updated
= true;
556 if (upstream_updated
)
557 pim_zebra_update_all_interfaces(pim
);
559 pim_rp_check_interfaces(pim
, rp_all
);
560 pim_rp_refresh_group_to_rp_mapping(pim
);
561 pim_find_or_track_nexthop(pim
, &nht_p
, NULL
, rp_all
,
564 if (!pim_ecmp_nexthop_lookup(pim
,
565 &rp_all
->rp
.source_nexthop
,
566 &nht_p
, &rp_all
->group
, 1))
567 return PIM_RP_NO_PATH
;
572 * Return if the group is already configured for this RP
574 tmp_rp_info
= pim_rp_find_exact(
575 pim
, rp_info
->rp
.rpf_addr
.u
.prefix4
, &rp_info
->group
);
577 if ((tmp_rp_info
->rp_src
!= rp_src_flag
)
578 && (rp_src_flag
== RP_SRC_STATIC
))
579 tmp_rp_info
->rp_src
= rp_src_flag
;
580 XFREE(MTYPE_PIM_RP
, rp_info
);
585 * Barf if this group is already covered by some other RP
587 tmp_rp_info
= pim_rp_find_match_group(pim
, &rp_info
->group
);
590 if (tmp_rp_info
->plist
) {
591 XFREE(MTYPE_PIM_RP
, rp_info
);
592 return PIM_GROUP_PFXLIST_OVERLAP
;
595 * If the only RP that covers this group is an
597 * 224.0.0.0/4 that is fine, ignore that one.
599 * though we must return PIM_GROUP_OVERLAP
601 if (prefix_same(&rp_info
->group
,
602 &tmp_rp_info
->group
)) {
603 if ((rp_src_flag
== RP_SRC_STATIC
)
604 && (tmp_rp_info
->rp_src
606 XFREE(MTYPE_PIM_RP
, rp_info
);
607 return PIM_GROUP_OVERLAP
;
610 result
= pim_rp_change(
612 rp_info
->rp
.rpf_addr
.u
.prefix4
,
615 XFREE(MTYPE_PIM_RP
, rp_info
);
622 listnode_add_sort(pim
->rp_list
, rp_info
);
623 rn
= route_node_get(pim
->rp_table
, &rp_info
->group
);
626 if (PIM_DEBUG_PIM_TRACE
)
627 zlog_debug("Allocated: %p for rp_info: %p(%pFX) Lock: %d", rn
,
628 rp_info
, &rp_info
->group
,
629 route_node_get_lock_count(rn
));
631 frr_each (rb_pim_upstream
, &pim
->upstream_head
, up
) {
632 if (up
->sg
.src
.s_addr
== INADDR_ANY
) {
634 struct rp_info
*trp_info
;
636 grp
.family
= AF_INET
;
637 grp
.prefixlen
= IPV4_MAX_BITLEN
;
638 grp
.u
.prefix4
= up
->sg
.grp
;
639 trp_info
= pim_rp_find_match_group(pim
, &grp
);
641 if (trp_info
== rp_info
) {
642 pim_upstream_update(pim
, up
);
643 upstream_updated
= true;
648 if (upstream_updated
)
649 pim_zebra_update_all_interfaces(pim
);
651 pim_rp_check_interfaces(pim
, rp_info
);
652 pim_rp_refresh_group_to_rp_mapping(pim
);
654 /* Register addr with Zebra NHT */
655 nht_p
.family
= AF_INET
;
656 nht_p
.prefixlen
= IPV4_MAX_BITLEN
;
657 nht_p
.u
.prefix4
= rp_info
->rp
.rpf_addr
.u
.prefix4
;
658 if (PIM_DEBUG_PIM_NHT_RP
)
659 zlog_debug("%s: NHT Register RP addr %pFX grp %pFX with Zebra ",
660 __func__
, &nht_p
, &rp_info
->group
);
661 pim_find_or_track_nexthop(pim
, &nht_p
, NULL
, rp_info
, NULL
);
662 if (!pim_ecmp_nexthop_lookup(pim
, &rp_info
->rp
.source_nexthop
, &nht_p
,
664 return PIM_RP_NO_PATH
;
669 int pim_rp_del_config(struct pim_instance
*pim
, const char *rp
,
670 const char *group_range
, const char *plist
)
673 struct in_addr rp_addr
;
676 if (group_range
== NULL
)
677 result
= str2prefix("224.0.0.0/4", &group
);
679 result
= str2prefix(group_range
, &group
);
682 return PIM_GROUP_BAD_ADDRESS
;
684 result
= inet_pton(AF_INET
, rp
, &rp_addr
);
686 return PIM_RP_BAD_ADDRESS
;
688 result
= pim_rp_del(pim
, rp_addr
, group
, plist
, RP_SRC_STATIC
);
692 int pim_rp_del(struct pim_instance
*pim
, struct in_addr rp_addr
,
693 struct prefix group
, const char *plist
,
694 enum rp_source rp_src_flag
)
697 struct rp_info
*rp_info
;
698 struct rp_info
*rp_all
;
700 struct route_node
*rn
;
701 bool was_plist
= false;
702 struct rp_info
*trp_info
;
703 struct pim_upstream
*up
;
704 struct bsgrp_node
*bsgrp
= NULL
;
705 struct bsm_rpinfo
*bsrp
= NULL
;
706 char rp_str
[INET_ADDRSTRLEN
];
707 bool upstream_updated
= false;
709 if (!inet_ntop(AF_INET
, &rp_addr
, rp_str
, sizeof(rp_str
)))
710 snprintf(rp_str
, sizeof(rp_str
), "<rp?>");
713 rp_info
= pim_rp_find_prefix_list(pim
, rp_addr
, plist
);
715 rp_info
= pim_rp_find_exact(pim
, rp_addr
, &group
);
718 return PIM_RP_NOT_FOUND
;
720 if (rp_info
->plist
) {
721 XFREE(MTYPE_PIM_FILTER_NAME
, rp_info
->plist
);
725 if (PIM_DEBUG_PIM_TRACE
)
726 zlog_debug("%s: Delete RP %s for the group %pFX", __func__
,
729 /* While static RP is getting deleted, we need to check if dynamic RP
730 * present for the same group in BSM RP table, then install the dynamic
731 * RP for the group node into the main rp table
733 if (rp_src_flag
== RP_SRC_STATIC
) {
734 bsgrp
= pim_bsm_get_bsgrp_node(&pim
->global_scope
, &group
);
737 bsrp
= bsm_rpinfos_first(bsgrp
->bsrp_list
);
739 if (PIM_DEBUG_PIM_TRACE
) {
740 char bsrp_str
[INET_ADDRSTRLEN
];
742 if (!inet_ntop(AF_INET
, bsrp
, bsrp_str
,
749 "%s: BSM RP %s found for the group %pFX",
750 __func__
, bsrp_str
, &group
);
752 return pim_rp_change(pim
, bsrp
->rp_address
,
756 if (PIM_DEBUG_PIM_TRACE
)
758 "%s: BSM RP not found for the group %pFX",
763 /* Deregister addr with Zebra NHT */
764 nht_p
.family
= AF_INET
;
765 nht_p
.prefixlen
= IPV4_MAX_BITLEN
;
766 nht_p
.u
.prefix4
= rp_info
->rp
.rpf_addr
.u
.prefix4
;
767 if (PIM_DEBUG_PIM_NHT_RP
)
768 zlog_debug("%s: Deregister RP addr %pFX with Zebra ", __func__
,
770 pim_delete_tracked_nexthop(pim
, &nht_p
, NULL
, rp_info
);
772 if (!str2prefix("224.0.0.0/4", &g_all
))
773 return PIM_RP_BAD_ADDRESS
;
775 rp_all
= pim_rp_find_match_group(pim
, &g_all
);
777 if (rp_all
== rp_info
) {
778 frr_each (rb_pim_upstream
, &pim
->upstream_head
, up
) {
779 /* Find the upstream (*, G) whose upstream address is
780 * same as the deleted RP
782 if ((up
->upstream_addr
.s_addr
783 == rp_info
->rp
.rpf_addr
.u
.prefix4
.s_addr
)
784 && (up
->sg
.src
.s_addr
== INADDR_ANY
)) {
786 grp
.family
= AF_INET
;
787 grp
.prefixlen
= IPV4_MAX_BITLEN
;
788 grp
.u
.prefix4
= up
->sg
.grp
;
789 trp_info
= pim_rp_find_match_group(pim
, &grp
);
790 if (trp_info
== rp_all
) {
791 pim_upstream_rpf_clear(pim
, up
);
792 up
->upstream_addr
.s_addr
= INADDR_ANY
;
796 rp_all
->rp
.rpf_addr
.family
= AF_INET
;
797 rp_all
->rp
.rpf_addr
.u
.prefix4
.s_addr
= INADDR_NONE
;
802 listnode_delete(pim
->rp_list
, rp_info
);
805 rn
= route_node_get(pim
->rp_table
, &rp_info
->group
);
807 if (rn
->info
!= rp_info
)
810 "Expected rn->info to be equal to rp_info");
812 if (PIM_DEBUG_PIM_TRACE
)
814 "%s:Found for Freeing: %p for rp_info: %p(%pFX) Lock: %d",
815 __func__
, rn
, rp_info
, &rp_info
->group
,
816 route_node_get_lock_count(rn
));
819 route_unlock_node(rn
);
820 route_unlock_node(rn
);
824 pim_rp_refresh_group_to_rp_mapping(pim
);
826 frr_each (rb_pim_upstream
, &pim
->upstream_head
, up
) {
827 /* Find the upstream (*, G) whose upstream address is same as
830 if ((up
->upstream_addr
.s_addr
831 == rp_info
->rp
.rpf_addr
.u
.prefix4
.s_addr
)
832 && (up
->sg
.src
.s_addr
== INADDR_ANY
)) {
835 grp
.family
= AF_INET
;
836 grp
.prefixlen
= IPV4_MAX_BITLEN
;
837 grp
.u
.prefix4
= up
->sg
.grp
;
839 trp_info
= pim_rp_find_match_group(pim
, &grp
);
841 /* RP not found for the group grp */
842 if (pim_rpf_addr_is_inaddr_none(&trp_info
->rp
)) {
843 pim_upstream_rpf_clear(pim
, up
);
844 pim_rp_set_upstream_addr(
845 pim
, &up
->upstream_addr
, up
->sg
.src
,
849 /* RP found for the group grp */
851 pim_upstream_update(pim
, up
);
852 upstream_updated
= true;
857 if (upstream_updated
)
858 pim_zebra_update_all_interfaces(pim
);
860 XFREE(MTYPE_PIM_RP
, rp_info
);
864 int pim_rp_change(struct pim_instance
*pim
, struct in_addr new_rp_addr
,
865 struct prefix group
, enum rp_source rp_src_flag
)
868 struct route_node
*rn
;
870 struct rp_info
*rp_info
= NULL
;
871 struct pim_upstream
*up
;
872 bool upstream_updated
= false;
874 rn
= route_node_lookup(pim
->rp_table
, &group
);
876 result
= pim_rp_new(pim
, new_rp_addr
, group
, NULL
, rp_src_flag
);
883 route_unlock_node(rn
);
884 result
= pim_rp_new(pim
, new_rp_addr
, group
, NULL
, rp_src_flag
);
888 if (rp_info
->rp
.rpf_addr
.u
.prefix4
.s_addr
== new_rp_addr
.s_addr
) {
889 if (rp_info
->rp_src
!= rp_src_flag
) {
890 rp_info
->rp_src
= rp_src_flag
;
891 route_unlock_node(rn
);
896 nht_p
.family
= AF_INET
;
897 nht_p
.prefixlen
= IPV4_MAX_BITLEN
;
899 /* Deregister old RP addr with Zebra NHT */
900 if (rp_info
->rp
.rpf_addr
.u
.prefix4
.s_addr
!= INADDR_ANY
) {
901 nht_p
.u
.prefix4
= rp_info
->rp
.rpf_addr
.u
.prefix4
;
902 if (PIM_DEBUG_PIM_NHT_RP
)
903 zlog_debug("%s: Deregister RP addr %pFX with Zebra ",
905 pim_delete_tracked_nexthop(pim
, &nht_p
, NULL
, rp_info
);
908 pim_rp_nexthop_del(rp_info
);
909 listnode_delete(pim
->rp_list
, rp_info
);
910 /* Update the new RP address*/
911 rp_info
->rp
.rpf_addr
.u
.prefix4
= new_rp_addr
;
912 rp_info
->rp_src
= rp_src_flag
;
913 rp_info
->i_am_rp
= 0;
915 listnode_add_sort(pim
->rp_list
, rp_info
);
917 frr_each (rb_pim_upstream
, &pim
->upstream_head
, up
) {
918 if (up
->sg
.src
.s_addr
== INADDR_ANY
) {
920 struct rp_info
*trp_info
;
922 grp
.family
= AF_INET
;
923 grp
.prefixlen
= IPV4_MAX_BITLEN
;
924 grp
.u
.prefix4
= up
->sg
.grp
;
925 trp_info
= pim_rp_find_match_group(pim
, &grp
);
927 if (trp_info
== rp_info
) {
928 pim_upstream_update(pim
, up
);
929 upstream_updated
= true;
934 if (upstream_updated
)
935 pim_zebra_update_all_interfaces(pim
);
937 /* Register new RP addr with Zebra NHT */
938 nht_p
.u
.prefix4
= rp_info
->rp
.rpf_addr
.u
.prefix4
;
939 if (PIM_DEBUG_PIM_NHT_RP
)
940 zlog_debug("%s: NHT Register RP addr %pFX grp %pFX with Zebra ",
941 __func__
, &nht_p
, &rp_info
->group
);
943 pim_find_or_track_nexthop(pim
, &nht_p
, NULL
, rp_info
, NULL
);
944 if (!pim_ecmp_nexthop_lookup(pim
, &rp_info
->rp
.source_nexthop
, &nht_p
,
945 &rp_info
->group
, 1)) {
946 route_unlock_node(rn
);
947 return PIM_RP_NO_PATH
;
950 pim_rp_check_interfaces(pim
, rp_info
);
952 route_unlock_node(rn
);
954 pim_rp_refresh_group_to_rp_mapping(pim
);
959 void pim_rp_setup(struct pim_instance
*pim
)
961 struct listnode
*node
;
962 struct rp_info
*rp_info
;
965 for (ALL_LIST_ELEMENTS_RO(pim
->rp_list
, node
, rp_info
)) {
966 if (rp_info
->rp
.rpf_addr
.u
.prefix4
.s_addr
== INADDR_NONE
)
969 nht_p
.family
= AF_INET
;
970 nht_p
.prefixlen
= IPV4_MAX_BITLEN
;
971 nht_p
.u
.prefix4
= rp_info
->rp
.rpf_addr
.u
.prefix4
;
973 pim_find_or_track_nexthop(pim
, &nht_p
, NULL
, rp_info
, NULL
);
974 if (!pim_ecmp_nexthop_lookup(pim
, &rp_info
->rp
.source_nexthop
,
975 &nht_p
, &rp_info
->group
, 1))
976 if (PIM_DEBUG_PIM_NHT_RP
)
978 "Unable to lookup nexthop for rp specified");
983 * Checks to see if we should elect ourself the actual RP when new if
984 * addresses are added against an interface.
986 void pim_rp_check_on_if_add(struct pim_interface
*pim_ifp
)
988 struct listnode
*node
;
989 struct rp_info
*rp_info
;
990 bool i_am_rp_changed
= false;
991 struct pim_instance
*pim
= pim_ifp
->pim
;
993 if (pim
->rp_list
== NULL
)
996 for (ALL_LIST_ELEMENTS_RO(pim
->rp_list
, node
, rp_info
)) {
997 if (pim_rpf_addr_is_inaddr_none(&rp_info
->rp
))
1000 /* if i_am_rp is already set nothing to be done (adding new
1002 * is not going to make a difference). */
1003 if (rp_info
->i_am_rp
) {
1007 if (pim_rp_check_interface_addrs(rp_info
, pim_ifp
)) {
1008 i_am_rp_changed
= true;
1009 rp_info
->i_am_rp
= 1;
1010 if (PIM_DEBUG_PIM_NHT_RP
) {
1011 char rp
[PREFIX_STRLEN
];
1012 pim_addr_dump("<rp?>", &rp_info
->rp
.rpf_addr
,
1014 zlog_debug("%s: %s: i am rp", __func__
, rp
);
1019 if (i_am_rp_changed
) {
1020 pim_msdp_i_am_rp_changed(pim
);
1021 pim_upstream_reeval_use_rpt(pim
);
1025 /* up-optimized re-evaluation of "i_am_rp". this is used when ifaddresses
1026 * are removed. Removing numbers is an uncommon event in an active network
1027 * so I have made no attempt to optimize it. */
1028 void pim_i_am_rp_re_evaluate(struct pim_instance
*pim
)
1030 struct listnode
*node
;
1031 struct rp_info
*rp_info
;
1032 bool i_am_rp_changed
= false;
1035 if (pim
->rp_list
== NULL
)
1038 for (ALL_LIST_ELEMENTS_RO(pim
->rp_list
, node
, rp_info
)) {
1039 if (pim_rpf_addr_is_inaddr_none(&rp_info
->rp
))
1042 old_i_am_rp
= rp_info
->i_am_rp
;
1043 pim_rp_check_interfaces(pim
, rp_info
);
1045 if (old_i_am_rp
!= rp_info
->i_am_rp
) {
1046 i_am_rp_changed
= true;
1047 if (PIM_DEBUG_PIM_NHT_RP
) {
1048 char rp
[PREFIX_STRLEN
];
1049 pim_addr_dump("<rp?>", &rp_info
->rp
.rpf_addr
,
1051 if (rp_info
->i_am_rp
) {
1052 zlog_debug("%s: %s: i am rp", __func__
,
1055 zlog_debug("%s: %s: i am no longer rp",
1062 if (i_am_rp_changed
) {
1063 pim_msdp_i_am_rp_changed(pim
);
1064 pim_upstream_reeval_use_rpt(pim
);
1069 * I_am_RP(G) is true if the group-to-RP mapping indicates that
1070 * this router is the RP for the group.
1072 * Since we only have static RP, all groups are part of this RP
1074 int pim_rp_i_am_rp(struct pim_instance
*pim
, struct in_addr group
)
1077 struct rp_info
*rp_info
;
1079 memset(&g
, 0, sizeof(g
));
1081 g
.prefixlen
= IPV4_MAX_BITLEN
;
1082 g
.u
.prefix4
= group
;
1084 rp_info
= pim_rp_find_match_group(pim
, &g
);
1087 return rp_info
->i_am_rp
;
1095 * Return the RP that the Group belongs too.
1097 struct pim_rpf
*pim_rp_g(struct pim_instance
*pim
, struct in_addr group
)
1100 struct rp_info
*rp_info
;
1102 memset(&g
, 0, sizeof(g
));
1104 g
.prefixlen
= IPV4_MAX_BITLEN
;
1105 g
.u
.prefix4
= group
;
1107 rp_info
= pim_rp_find_match_group(pim
, &g
);
1110 struct prefix nht_p
;
1112 /* Register addr with Zebra NHT */
1113 nht_p
.family
= AF_INET
;
1114 nht_p
.prefixlen
= IPV4_MAX_BITLEN
;
1115 nht_p
.u
.prefix4
= rp_info
->rp
.rpf_addr
.u
.prefix4
;
1116 if (PIM_DEBUG_PIM_NHT_RP
)
1118 "%s: NHT Register RP addr %pFX grp %pFX with Zebra",
1119 __func__
, &nht_p
, &rp_info
->group
);
1120 pim_find_or_track_nexthop(pim
, &nht_p
, NULL
, rp_info
, NULL
);
1121 pim_rpf_set_refresh_time(pim
);
1122 (void)pim_ecmp_nexthop_lookup(pim
, &rp_info
->rp
.source_nexthop
,
1123 &nht_p
, &rp_info
->group
, 1);
1124 return (&rp_info
->rp
);
1132 * Set the upstream IP address we want to talk to based upon
1133 * the rp configured and the source address
1135 * If we have don't have a RP configured and the source address is *
1136 * then set the upstream addr as INADDR_ANY and return failure.
1139 int pim_rp_set_upstream_addr(struct pim_instance
*pim
, struct in_addr
*up
,
1140 struct in_addr source
, struct in_addr group
)
1142 struct rp_info
*rp_info
;
1145 memset(&g
, 0, sizeof(g
));
1147 g
.prefixlen
= IPV4_MAX_BITLEN
;
1148 g
.u
.prefix4
= group
;
1150 rp_info
= pim_rp_find_match_group(pim
, &g
);
1152 if (!rp_info
|| ((pim_rpf_addr_is_inaddr_none(&rp_info
->rp
))
1153 && (source
.s_addr
== INADDR_ANY
))) {
1154 if (PIM_DEBUG_PIM_NHT_RP
)
1155 zlog_debug("%s: Received a (*,G) with no RP configured",
1157 up
->s_addr
= INADDR_ANY
;
1161 *up
= (source
.s_addr
== INADDR_ANY
) ? rp_info
->rp
.rpf_addr
.u
.prefix4
1167 int pim_rp_config_write(struct pim_instance
*pim
, struct vty
*vty
,
1170 struct listnode
*node
;
1171 struct rp_info
*rp_info
;
1175 for (ALL_LIST_ELEMENTS_RO(pim
->rp_list
, node
, rp_info
)) {
1176 if (pim_rpf_addr_is_inaddr_none(&rp_info
->rp
))
1179 if (rp_info
->rp_src
== RP_SRC_BSR
)
1183 vty_out(vty
, "%sip pim rp %s prefix-list %s\n", spaces
,
1185 &rp_info
->rp
.rpf_addr
.u
.prefix4
,
1189 vty_out(vty
, "%sip pim rp %s %pFX\n", spaces
,
1191 &rp_info
->rp
.rpf_addr
.u
.prefix4
,
1200 void pim_rp_show_information(struct pim_instance
*pim
, struct vty
*vty
, bool uj
)
1202 struct rp_info
*rp_info
;
1203 struct rp_info
*prev_rp_info
= NULL
;
1204 struct listnode
*node
;
1206 char buf
[PREFIX_STRLEN
];
1208 json_object
*json
= NULL
;
1209 json_object
*json_rp_rows
= NULL
;
1210 json_object
*json_row
= NULL
;
1213 json
= json_object_new_object();
1216 "RP address group/prefix-list OIF I am RP Source\n");
1217 for (ALL_LIST_ELEMENTS_RO(pim
->rp_list
, node
, rp_info
)) {
1218 if (!pim_rpf_addr_is_inaddr_none(&rp_info
->rp
)) {
1221 if (rp_info
->rp_src
== RP_SRC_STATIC
)
1222 strlcpy(source
, "Static", sizeof(source
));
1223 else if (rp_info
->rp_src
== RP_SRC_BSR
)
1224 strlcpy(source
, "BSR", sizeof(source
));
1226 strlcpy(source
, "None", sizeof(source
));
1229 * If we have moved on to a new RP then add the
1230 * entry for the previous RP
1233 && prev_rp_info
->rp
.rpf_addr
.u
.prefix4
1235 != rp_info
->rp
.rpf_addr
.u
.prefix4
1237 json_object_object_add(
1245 json_rp_rows
= NULL
;
1249 json_rp_rows
= json_object_new_array();
1251 json_row
= json_object_new_object();
1252 json_object_string_addf(
1253 json_row
, "rpAddress", "%pI4",
1254 &rp_info
->rp
.rpf_addr
.u
.prefix4
);
1255 if (rp_info
->rp
.source_nexthop
.interface
)
1256 json_object_string_add(
1257 json_row
, "outboundInterface",
1258 rp_info
->rp
.source_nexthop
1261 json_object_string_add(
1262 json_row
, "outboundInterface",
1264 if (rp_info
->i_am_rp
)
1265 json_object_boolean_true_add(json_row
,
1268 json_object_boolean_false_add(json_row
,
1272 json_object_string_add(json_row
,
1276 json_object_string_addf(
1277 json_row
, "group", "%pFX",
1279 json_object_string_add(json_row
, "source",
1282 json_object_array_add(json_rp_rows
, json_row
);
1284 vty_out(vty
, "%-15s ",
1286 &rp_info
->rp
.rpf_addr
.u
1291 vty_out(vty
, "%-18s ", rp_info
->plist
);
1293 vty_out(vty
, "%-18pFX ",
1296 if (rp_info
->rp
.source_nexthop
.interface
)
1297 vty_out(vty
, "%-16s ",
1298 rp_info
->rp
.source_nexthop
1301 vty_out(vty
, "%-16s ", "(Unknown)");
1303 if (rp_info
->i_am_rp
)
1304 vty_out(vty
, "yes");
1308 vty_out(vty
, "%14s\n", source
);
1310 prev_rp_info
= rp_info
;
1315 if (prev_rp_info
&& json_rp_rows
)
1316 json_object_object_add(
1319 &prev_rp_info
->rp
.rpf_addr
.u
.prefix4
,
1323 vty_json(vty
, json
);
1327 void pim_resolve_rp_nh(struct pim_instance
*pim
, struct pim_neighbor
*nbr
)
1329 struct listnode
*node
= NULL
;
1330 struct rp_info
*rp_info
= NULL
;
1331 struct nexthop
*nh_node
= NULL
;
1332 struct prefix nht_p
;
1333 struct pim_nexthop_cache pnc
;
1335 for (ALL_LIST_ELEMENTS_RO(pim
->rp_list
, node
, rp_info
)) {
1336 if (rp_info
->rp
.rpf_addr
.u
.prefix4
.s_addr
== INADDR_NONE
)
1339 nht_p
.family
= AF_INET
;
1340 nht_p
.prefixlen
= IPV4_MAX_BITLEN
;
1341 nht_p
.u
.prefix4
= rp_info
->rp
.rpf_addr
.u
.prefix4
;
1342 memset(&pnc
, 0, sizeof(struct pim_nexthop_cache
));
1343 if (!pim_find_or_track_nexthop(pim
, &nht_p
, NULL
, rp_info
,
1347 for (nh_node
= pnc
.nexthop
; nh_node
; nh_node
= nh_node
->next
) {
1348 if (nh_node
->gate
.ipv4
.s_addr
!= INADDR_ANY
)
1351 struct interface
*ifp1
= if_lookup_by_index(
1352 nh_node
->ifindex
, pim
->vrf
->vrf_id
);
1354 if (nbr
->interface
!= ifp1
)
1357 nh_node
->gate
.ipv4
= nbr
->source_addr
;
1358 if (PIM_DEBUG_PIM_NHT_RP
) {
1359 char str
[PREFIX_STRLEN
];
1360 char str1
[INET_ADDRSTRLEN
];
1361 pim_inet4_dump("<nht_nbr?>", nbr
->source_addr
,
1362 str1
, sizeof(str1
));
1363 pim_addr_dump("<nht_addr?>", &nht_p
, str
,
1366 "%s: addr %s new nexthop addr %s interface %s",
1367 __func__
, str
, str1
, ifp1
->name
);