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_iface.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_PREFIXLEN
;
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
);
136 "Allocated: %p for rp_info: %p(224.0.0.0/4) Lock: %d",
137 rn
, rp_info
, rn
->lock
);
140 void pim_rp_free(struct pim_instance
*pim
)
143 list_delete(&pim
->rp_list
);
147 * Given an RP's prefix-list, return the RP's rp_info for that prefix-list
149 static struct rp_info
*pim_rp_find_prefix_list(struct pim_instance
*pim
,
153 struct listnode
*node
;
154 struct rp_info
*rp_info
;
156 for (ALL_LIST_ELEMENTS_RO(pim
->rp_list
, node
, rp_info
)) {
157 if (rp
.s_addr
== rp_info
->rp
.rpf_addr
.u
.prefix4
.s_addr
158 && rp_info
->plist
&& strcmp(rp_info
->plist
, plist
) == 0) {
167 * Return true if plist is used by any rp_info
169 static int pim_rp_prefix_list_used(struct pim_instance
*pim
, const char *plist
)
171 struct listnode
*node
;
172 struct rp_info
*rp_info
;
174 for (ALL_LIST_ELEMENTS_RO(pim
->rp_list
, node
, rp_info
)) {
175 if (rp_info
->plist
&& strcmp(rp_info
->plist
, plist
) == 0) {
184 * Given an RP's address, return the RP's rp_info that is an exact match for
187 static struct rp_info
*pim_rp_find_exact(struct pim_instance
*pim
,
189 const struct prefix
*group
)
191 struct listnode
*node
;
192 struct rp_info
*rp_info
;
194 for (ALL_LIST_ELEMENTS_RO(pim
->rp_list
, node
, rp_info
)) {
195 if (rp
.s_addr
== rp_info
->rp
.rpf_addr
.u
.prefix4
.s_addr
196 && prefix_same(&rp_info
->group
, group
))
204 * Given a group, return the rp_info for that group
206 struct rp_info
*pim_rp_find_match_group(struct pim_instance
*pim
,
207 const struct prefix
*group
)
209 struct listnode
*node
;
210 struct rp_info
*best
= NULL
;
211 struct rp_info
*rp_info
;
212 struct prefix_list
*plist
;
213 const struct prefix
*p
, *bp
;
214 struct route_node
*rn
;
217 for (ALL_LIST_ELEMENTS_RO(pim
->rp_list
, node
, rp_info
)) {
218 if (rp_info
->plist
) {
219 plist
= prefix_list_lookup(AFI_IP
, rp_info
->plist
);
221 if (prefix_list_apply_which_prefix(plist
, &p
, group
)
231 if (bp
&& bp
->prefixlen
< p
->prefixlen
) {
238 rn
= route_node_match(pim
->rp_table
, group
);
242 "%s: BUG We should have found default group information\n",
243 __PRETTY_FUNCTION__
);
248 if (PIM_DEBUG_TRACE
) {
249 char buf
[PREFIX_STRLEN
];
251 route_unlock_node(rn
);
252 zlog_debug("Lookedup: %p for rp_info: %p(%s) Lock: %d", rn
,
254 prefix2str(&rp_info
->group
, buf
, sizeof(buf
)),
261 if (rp_info
->group
.prefixlen
< best
->group
.prefixlen
)
268 * When the user makes "ip pim rp" configuration changes or if they change the
269 * prefix-list(s) used by these statements we must tickle the upstream state
270 * for each group to make them re-lookup who their RP should be.
272 * This is a placeholder function for now.
274 static void pim_rp_refresh_group_to_rp_mapping(struct pim_instance
*pim
)
276 pim_msdp_i_am_rp_changed(pim
);
279 void pim_rp_prefix_list_update(struct pim_instance
*pim
,
280 struct prefix_list
*plist
)
282 struct listnode
*node
;
283 struct rp_info
*rp_info
;
284 int refresh_needed
= 0;
286 for (ALL_LIST_ELEMENTS_RO(pim
->rp_list
, node
, rp_info
)) {
288 && strcmp(rp_info
->plist
, prefix_list_name(plist
)) == 0) {
295 pim_rp_refresh_group_to_rp_mapping(pim
);
298 static int pim_rp_check_interface_addrs(struct rp_info
*rp_info
,
299 struct pim_interface
*pim_ifp
)
301 struct listnode
*node
;
302 struct pim_secondary_addr
*sec_addr
;
304 if (pim_ifp
->primary_address
.s_addr
305 == rp_info
->rp
.rpf_addr
.u
.prefix4
.s_addr
)
308 if (!pim_ifp
->sec_addr_list
) {
312 for (ALL_LIST_ELEMENTS_RO(pim_ifp
->sec_addr_list
, node
, sec_addr
)) {
313 if (prefix_same(&sec_addr
->addr
, &rp_info
->rp
.rpf_addr
)) {
321 static void pim_rp_check_interfaces(struct pim_instance
*pim
,
322 struct rp_info
*rp_info
)
324 struct interface
*ifp
;
326 rp_info
->i_am_rp
= 0;
327 FOR_ALL_INTERFACES (pim
->vrf
, ifp
) {
328 struct pim_interface
*pim_ifp
= ifp
->info
;
333 if (pim_rp_check_interface_addrs(rp_info
, pim_ifp
)) {
334 rp_info
->i_am_rp
= 1;
339 void pim_upstream_update(struct pim_instance
*pim
, struct pim_upstream
*up
)
341 struct pim_rpf old_rpf
;
342 enum pim_rpf_result rpf_result
;
343 struct in_addr old_upstream_addr
;
344 struct in_addr new_upstream_addr
;
347 old_upstream_addr
= up
->upstream_addr
;
348 pim_rp_set_upstream_addr(pim
, &new_upstream_addr
, up
->sg
.src
,
352 zlog_debug("%s: pim upstream update for old upstream %s",
354 inet_ntoa(old_upstream_addr
));
356 if (old_upstream_addr
.s_addr
== new_upstream_addr
.s_addr
)
359 /* Lets consider a case, where a PIM upstream has a better RP as a
360 * result of a new RP configuration with more precise group range.
361 * This upstream has to be added to the upstream hash of new RP's
362 * NHT(pnc) and has to be removed from old RP's NHT upstream hash
364 if (old_upstream_addr
.s_addr
!= INADDR_ANY
) {
365 /* Deregister addr with Zebra NHT */
366 nht_p
.family
= AF_INET
;
367 nht_p
.prefixlen
= IPV4_MAX_BITLEN
;
368 nht_p
.u
.prefix4
= old_upstream_addr
;
369 if (PIM_DEBUG_TRACE
) {
370 char buf
[PREFIX2STR_BUFFER
];
372 prefix2str(&nht_p
, buf
, sizeof(buf
));
373 zlog_debug("%s: Deregister upstream %s addr %s with Zebra NHT",
374 __PRETTY_FUNCTION__
, up
->sg_str
, buf
);
376 pim_delete_tracked_nexthop(pim
, &nht_p
, up
, NULL
, false);
379 /* Update the upstream address */
380 up
->upstream_addr
= new_upstream_addr
;
382 old_rpf
.source_nexthop
.interface
= up
->rpf
.source_nexthop
.interface
;
384 rpf_result
= pim_rpf_update(pim
, up
, &old_rpf
);
385 if (rpf_result
== PIM_RPF_FAILURE
)
386 pim_mroute_del(up
->channel_oil
, __PRETTY_FUNCTION__
);
388 /* update kernel multicast forwarding cache (MFC) */
389 if (up
->rpf
.source_nexthop
.interface
&& up
->channel_oil
) {
390 ifindex_t ifindex
= up
->rpf
.source_nexthop
.interface
->ifindex
;
391 int vif_index
= pim_if_find_vifindex_by_ifindex(pim
, ifindex
);
392 /* Pass Current selected NH vif index to mroute download */
394 pim_scan_individual_oil(up
->channel_oil
, vif_index
);
396 if (PIM_DEBUG_PIM_NHT
)
398 "%s: NHT upstream %s channel_oil IIF %s vif_index is not valid",
399 __PRETTY_FUNCTION__
, up
->sg_str
,
400 up
->rpf
.source_nexthop
.interface
->name
);
404 if (rpf_result
== PIM_RPF_CHANGED
)
405 pim_zebra_upstream_rpf_changed(pim
, up
, &old_rpf
);
407 pim_zebra_update_all_interfaces(pim
);
410 int pim_rp_new_config(struct pim_instance
*pim
, const char *rp
,
411 const char *group_range
, const char *plist
)
415 struct in_addr rp_addr
;
417 if (group_range
== NULL
)
418 result
= str2prefix("224.0.0.0/4", &group
);
420 result
= str2prefix(group_range
, &group
);
424 prefix_copy(&temp
, &group
);
426 if (!prefix_same(&group
, &temp
))
427 return PIM_GROUP_BAD_ADDR_MASK_COMBO
;
432 return PIM_GROUP_BAD_ADDRESS
;
434 result
= inet_pton(AF_INET
, rp
, &rp_addr
);
437 return PIM_RP_BAD_ADDRESS
;
439 result
= pim_rp_new(pim
, rp_addr
, group
, plist
, RP_SRC_STATIC
);
443 int pim_rp_new(struct pim_instance
*pim
, struct in_addr rp_addr
,
444 struct prefix group
, const char *plist
,
445 enum rp_source rp_src_flag
)
448 char rp
[INET_ADDRSTRLEN
];
449 struct rp_info
*rp_info
;
450 struct rp_info
*rp_all
;
451 struct prefix group_all
;
452 struct listnode
*node
, *nnode
;
453 struct rp_info
*tmp_rp_info
;
456 struct route_node
*rn
;
457 struct pim_upstream
*up
;
458 struct listnode
*upnode
;
460 rp_info
= XCALLOC(MTYPE_PIM_RP
, sizeof(*rp_info
));
462 rp_info
->rp
.rpf_addr
.family
= AF_INET
;
463 rp_info
->rp
.rpf_addr
.prefixlen
= IPV4_MAX_PREFIXLEN
;
464 rp_info
->rp
.rpf_addr
.u
.prefix4
= rp_addr
;
465 prefix_copy(&rp_info
->group
, &group
);
466 rp_info
->rp_src
= rp_src_flag
;
468 inet_ntop(AF_INET
, &rp_info
->rp
.rpf_addr
.u
.prefix4
, rp
, sizeof(rp
));
472 * Return if the prefix-list is already configured for this RP
474 if (pim_rp_find_prefix_list(pim
, rp_info
->rp
.rpf_addr
.u
.prefix4
,
476 XFREE(MTYPE_PIM_RP
, rp_info
);
481 * Barf if the prefix-list is already configured for an RP
483 if (pim_rp_prefix_list_used(pim
, plist
)) {
484 XFREE(MTYPE_PIM_RP
, rp_info
);
485 return PIM_RP_PFXLIST_IN_USE
;
489 * Free any existing rp_info entries for this RP
491 for (ALL_LIST_ELEMENTS(pim
->rp_list
, node
, nnode
,
493 if (rp_info
->rp
.rpf_addr
.u
.prefix4
.s_addr
494 == tmp_rp_info
->rp
.rpf_addr
.u
.prefix4
.s_addr
) {
495 if (tmp_rp_info
->plist
)
496 pim_rp_del_config(pim
, rp
, NULL
,
501 prefix2str(&tmp_rp_info
->group
,
507 rp_info
->plist
= XSTRDUP(MTYPE_PIM_FILTER_NAME
, plist
);
510 if (!str2prefix("224.0.0.0/4", &group_all
)) {
511 XFREE(MTYPE_PIM_RP
, rp_info
);
512 return PIM_GROUP_BAD_ADDRESS
;
514 rp_all
= pim_rp_find_match_group(pim
, &group_all
);
517 * Barf if group is a non-multicast subnet
519 if (!prefix_match(&rp_all
->group
, &rp_info
->group
)) {
520 XFREE(MTYPE_PIM_RP
, rp_info
);
521 return PIM_GROUP_BAD_ADDRESS
;
525 * Remove any prefix-list rp_info entries for this RP
527 for (ALL_LIST_ELEMENTS(pim
->rp_list
, node
, nnode
,
529 if (tmp_rp_info
->plist
530 && rp_info
->rp
.rpf_addr
.u
.prefix4
.s_addr
531 == tmp_rp_info
->rp
.rpf_addr
.u
.prefix4
533 pim_rp_del_config(pim
, rp
, NULL
,
539 * Take over the 224.0.0.0/4 group if the rp is INADDR_NONE
541 if (prefix_same(&rp_all
->group
, &rp_info
->group
)
542 && pim_rpf_addr_is_inaddr_none(&rp_all
->rp
)) {
543 rp_all
->rp
.rpf_addr
= rp_info
->rp
.rpf_addr
;
544 rp_all
->rp_src
= rp_src_flag
;
545 XFREE(MTYPE_PIM_RP
, rp_info
);
547 /* Register addr with Zebra NHT */
548 nht_p
.family
= AF_INET
;
549 nht_p
.prefixlen
= IPV4_MAX_BITLEN
;
551 rp_all
->rp
.rpf_addr
.u
.prefix4
; // RP address
552 if (PIM_DEBUG_PIM_NHT_RP
) {
553 char buf
[PREFIX2STR_BUFFER
];
554 char buf1
[PREFIX2STR_BUFFER
];
555 prefix2str(&nht_p
, buf
, sizeof(buf
));
556 prefix2str(&rp_all
->group
, buf1
, sizeof(buf1
));
558 "%s: NHT Register rp_all addr %s grp %s ",
559 __PRETTY_FUNCTION__
, buf
, buf1
);
562 for (ALL_LIST_ELEMENTS_RO(pim
->upstream_list
, upnode
,
564 /* Find (*, G) upstream whose RP is not
567 if ((up
->upstream_addr
.s_addr
== INADDR_ANY
)
568 && (up
->sg
.src
.s_addr
== INADDR_ANY
)) {
570 struct rp_info
*trp_info
;
572 grp
.family
= AF_INET
;
573 grp
.prefixlen
= IPV4_MAX_BITLEN
;
574 grp
.u
.prefix4
= up
->sg
.grp
;
575 trp_info
= pim_rp_find_match_group(
577 if (trp_info
== rp_all
)
578 pim_upstream_update(pim
, up
);
582 pim_rp_check_interfaces(pim
, rp_all
);
583 pim_rp_refresh_group_to_rp_mapping(pim
);
584 pim_find_or_track_nexthop(pim
, &nht_p
, NULL
, rp_all
,
587 if (!pim_ecmp_nexthop_lookup(pim
,
588 &rp_all
->rp
.source_nexthop
,
589 &nht_p
, &rp_all
->group
, 1))
590 return PIM_RP_NO_PATH
;
595 * Return if the group is already configured for this RP
597 tmp_rp_info
= pim_rp_find_exact(
598 pim
, rp_info
->rp
.rpf_addr
.u
.prefix4
, &rp_info
->group
);
600 if ((tmp_rp_info
->rp_src
!= rp_src_flag
)
601 && (rp_src_flag
== RP_SRC_STATIC
))
602 tmp_rp_info
->rp_src
= rp_src_flag
;
603 XFREE(MTYPE_PIM_RP
, rp_info
);
608 * Barf if this group is already covered by some other RP
610 tmp_rp_info
= pim_rp_find_match_group(pim
, &rp_info
->group
);
613 if (tmp_rp_info
->plist
) {
614 XFREE(MTYPE_PIM_RP
, rp_info
);
615 return PIM_GROUP_PFXLIST_OVERLAP
;
618 * If the only RP that covers this group is an
620 * 224.0.0.0/4 that is fine, ignore that one.
622 * though we must return PIM_GROUP_OVERLAP
624 if (prefix_same(&rp_info
->group
,
625 &tmp_rp_info
->group
)) {
626 if ((rp_src_flag
== RP_SRC_STATIC
)
627 && (tmp_rp_info
->rp_src
629 XFREE(MTYPE_PIM_RP
, rp_info
);
630 return PIM_GROUP_OVERLAP
;
633 result
= pim_rp_change(
635 rp_info
->rp
.rpf_addr
.u
.prefix4
,
638 XFREE(MTYPE_PIM_RP
, rp_info
);
645 listnode_add_sort(pim
->rp_list
, rp_info
);
646 rn
= route_node_get(pim
->rp_table
, &rp_info
->group
);
649 if (PIM_DEBUG_TRACE
) {
650 char buf
[PREFIX_STRLEN
];
652 zlog_debug("Allocated: %p for rp_info: %p(%s) Lock: %d", rn
,
654 prefix2str(&rp_info
->group
, buf
, sizeof(buf
)),
658 for (ALL_LIST_ELEMENTS_RO(pim
->upstream_list
, upnode
, up
)) {
659 if (up
->sg
.src
.s_addr
== INADDR_ANY
) {
661 struct rp_info
*trp_info
;
663 grp
.family
= AF_INET
;
664 grp
.prefixlen
= IPV4_MAX_BITLEN
;
665 grp
.u
.prefix4
= up
->sg
.grp
;
666 trp_info
= pim_rp_find_match_group(pim
, &grp
);
668 if (trp_info
== rp_info
)
669 pim_upstream_update(pim
, up
);
673 pim_rp_check_interfaces(pim
, rp_info
);
674 pim_rp_refresh_group_to_rp_mapping(pim
);
676 /* Register addr with Zebra NHT */
677 nht_p
.family
= AF_INET
;
678 nht_p
.prefixlen
= IPV4_MAX_BITLEN
;
679 nht_p
.u
.prefix4
= rp_info
->rp
.rpf_addr
.u
.prefix4
;
680 if (PIM_DEBUG_PIM_NHT_RP
) {
681 char buf
[PREFIX2STR_BUFFER
];
682 char buf1
[PREFIX2STR_BUFFER
];
683 prefix2str(&nht_p
, buf
, sizeof(buf
));
684 prefix2str(&rp_info
->group
, buf1
, sizeof(buf1
));
685 zlog_debug("%s: NHT Register RP addr %s grp %s with Zebra ",
686 __PRETTY_FUNCTION__
, buf
, buf1
);
688 pim_find_or_track_nexthop(pim
, &nht_p
, NULL
, rp_info
, false, NULL
);
689 if (!pim_ecmp_nexthop_lookup(pim
, &rp_info
->rp
.source_nexthop
, &nht_p
,
691 return PIM_RP_NO_PATH
;
696 int pim_rp_del_config(struct pim_instance
*pim
, const char *rp
,
697 const char *group_range
, const char *plist
)
700 struct in_addr rp_addr
;
703 if (group_range
== NULL
)
704 result
= str2prefix("224.0.0.0/4", &group
);
706 result
= str2prefix(group_range
, &group
);
709 return PIM_GROUP_BAD_ADDRESS
;
711 result
= inet_pton(AF_INET
, rp
, &rp_addr
);
713 return PIM_RP_BAD_ADDRESS
;
715 result
= pim_rp_del(pim
, rp_addr
, group
, plist
, RP_SRC_STATIC
);
719 int pim_rp_del(struct pim_instance
*pim
, struct in_addr rp_addr
,
720 struct prefix group
, const char *plist
,
721 enum rp_source rp_src_flag
)
724 struct rp_info
*rp_info
;
725 struct rp_info
*rp_all
;
727 struct route_node
*rn
;
728 bool was_plist
= false;
729 struct rp_info
*trp_info
;
730 struct pim_upstream
*up
;
731 struct listnode
*upnode
;
732 struct bsgrp_node
*bsgrp
= NULL
;
733 struct bsm_rpinfo
*bsrp
= NULL
;
734 char grp_str
[PREFIX2STR_BUFFER
];
735 char rp_str
[INET_ADDRSTRLEN
];
737 if (!inet_ntop(AF_INET
, &rp_addr
, rp_str
, sizeof(rp_str
)))
738 sprintf(rp_str
, "<rp?>");
739 prefix2str(&group
, grp_str
, sizeof(grp_str
));
742 rp_info
= pim_rp_find_prefix_list(pim
, rp_addr
, plist
);
744 rp_info
= pim_rp_find_exact(pim
, rp_addr
, &group
);
747 return PIM_RP_NOT_FOUND
;
749 if (rp_info
->plist
) {
750 XFREE(MTYPE_PIM_FILTER_NAME
, rp_info
->plist
);
755 zlog_debug("%s: Delete RP %s for the group %s",
756 __PRETTY_FUNCTION__
, rp_str
, grp_str
);
758 /* While static RP is getting deleted, we need to check if dynamic RP
759 * present for the same group in BSM RP table, then install the dynamic
760 * RP for the group node into the main rp table
762 if (rp_src_flag
== RP_SRC_STATIC
) {
763 bsgrp
= pim_bsm_get_bsgrp_node(&pim
->global_scope
, &group
);
766 bsrp
= listnode_head(bsgrp
->bsrp_list
);
768 if (PIM_DEBUG_TRACE
) {
769 char bsrp_str
[INET_ADDRSTRLEN
];
771 if (!inet_ntop(AF_INET
, bsrp
, bsrp_str
,
773 sprintf(bsrp_str
, "<bsrp?>");
775 zlog_debug("%s: BSM RP %s found for the group %s",
779 return pim_rp_change(pim
, bsrp
->rp_address
,
785 "%s: BSM RP not found for the group %s",
786 __PRETTY_FUNCTION__
, grp_str
);
790 /* Deregister addr with Zebra NHT */
791 nht_p
.family
= AF_INET
;
792 nht_p
.prefixlen
= IPV4_MAX_BITLEN
;
793 nht_p
.u
.prefix4
= rp_info
->rp
.rpf_addr
.u
.prefix4
;
794 if (PIM_DEBUG_PIM_NHT_RP
) {
795 char buf
[PREFIX2STR_BUFFER
];
796 prefix2str(&nht_p
, buf
, sizeof(buf
));
797 zlog_debug("%s: Deregister RP addr %s with Zebra ",
798 __PRETTY_FUNCTION__
, buf
);
800 pim_delete_tracked_nexthop(pim
, &nht_p
, NULL
, rp_info
, false);
802 if (!str2prefix("224.0.0.0/4", &g_all
))
803 return PIM_RP_BAD_ADDRESS
;
805 rp_all
= pim_rp_find_match_group(pim
, &g_all
);
807 if (rp_all
== rp_info
) {
808 for (ALL_LIST_ELEMENTS_RO(pim
->upstream_list
, upnode
, up
)) {
809 /* Find the upstream (*, G) whose upstream address is
810 * same as the deleted RP
812 if ((up
->upstream_addr
.s_addr
813 == rp_info
->rp
.rpf_addr
.u
.prefix4
.s_addr
)
814 && (up
->sg
.src
.s_addr
== INADDR_ANY
)) {
816 grp
.family
= AF_INET
;
817 grp
.prefixlen
= IPV4_MAX_BITLEN
;
818 grp
.u
.prefix4
= up
->sg
.grp
;
819 trp_info
= pim_rp_find_match_group(pim
, &grp
);
820 if (trp_info
== rp_all
) {
821 pim_upstream_rpf_clear(pim
, up
);
822 up
->upstream_addr
.s_addr
= INADDR_ANY
;
826 rp_all
->rp
.rpf_addr
.family
= AF_INET
;
827 rp_all
->rp
.rpf_addr
.u
.prefix4
.s_addr
= INADDR_NONE
;
832 listnode_delete(pim
->rp_list
, rp_info
);
835 rn
= route_node_get(pim
->rp_table
, &rp_info
->group
);
837 if (rn
->info
!= rp_info
)
840 "Expected rn->info to be equal to rp_info");
842 if (PIM_DEBUG_TRACE
) {
843 char buf
[PREFIX_STRLEN
];
846 "%s:Found for Freeing: %p for rp_info: %p(%s) Lock: %d",
847 __PRETTY_FUNCTION__
, rn
, rp_info
,
848 prefix2str(&rp_info
->group
, buf
,
853 route_unlock_node(rn
);
854 route_unlock_node(rn
);
858 pim_rp_refresh_group_to_rp_mapping(pim
);
860 for (ALL_LIST_ELEMENTS_RO(pim
->upstream_list
, upnode
, up
)) {
861 /* Find the upstream (*, G) whose upstream address is same as
864 if ((up
->upstream_addr
.s_addr
865 == rp_info
->rp
.rpf_addr
.u
.prefix4
.s_addr
)
866 && (up
->sg
.src
.s_addr
== INADDR_ANY
)) {
869 grp
.family
= AF_INET
;
870 grp
.prefixlen
= IPV4_MAX_BITLEN
;
871 grp
.u
.prefix4
= up
->sg
.grp
;
873 trp_info
= pim_rp_find_match_group(pim
, &grp
);
875 /* RP not found for the group grp */
876 if (pim_rpf_addr_is_inaddr_none(&trp_info
->rp
)) {
877 pim_upstream_rpf_clear(pim
, up
);
878 pim_rp_set_upstream_addr(
879 pim
, &up
->upstream_addr
, up
->sg
.src
,
883 /* RP found for the group grp */
885 pim_upstream_update(pim
, up
);
889 XFREE(MTYPE_PIM_RP
, rp_info
);
893 int pim_rp_change(struct pim_instance
*pim
, struct in_addr new_rp_addr
,
894 struct prefix group
, enum rp_source rp_src_flag
)
897 struct route_node
*rn
;
899 struct rp_info
*rp_info
= NULL
;
900 struct pim_upstream
*up
;
901 struct listnode
*upnode
;
903 rn
= route_node_lookup(pim
->rp_table
, &group
);
905 result
= pim_rp_new(pim
, new_rp_addr
, group
, NULL
, rp_src_flag
);
912 route_unlock_node(rn
);
913 result
= pim_rp_new(pim
, new_rp_addr
, group
, NULL
, rp_src_flag
);
917 if (rp_info
->rp
.rpf_addr
.u
.prefix4
.s_addr
== new_rp_addr
.s_addr
) {
918 if (rp_info
->rp_src
!= rp_src_flag
) {
919 rp_info
->rp_src
= rp_src_flag
;
920 route_unlock_node(rn
);
925 /* Deregister old RP addr with Zebra NHT */
926 if (rp_info
->rp
.rpf_addr
.u
.prefix4
.s_addr
!= INADDR_ANY
) {
927 nht_p
.family
= AF_INET
;
928 nht_p
.prefixlen
= IPV4_MAX_BITLEN
;
929 nht_p
.u
.prefix4
= rp_info
->rp
.rpf_addr
.u
.prefix4
;
930 if (PIM_DEBUG_PIM_NHT_RP
) {
931 char buf
[PREFIX2STR_BUFFER
];
933 prefix2str(&nht_p
, buf
, sizeof(buf
));
934 zlog_debug("%s: Deregister RP addr %s with Zebra ",
935 __PRETTY_FUNCTION__
, buf
);
937 pim_delete_tracked_nexthop(pim
, &nht_p
, NULL
, rp_info
, false);
940 pim_rp_nexthop_del(rp_info
);
941 listnode_delete(pim
->rp_list
, rp_info
);
942 /* Update the new RP address*/
943 rp_info
->rp
.rpf_addr
.u
.prefix4
= new_rp_addr
;
944 rp_info
->rp_src
= rp_src_flag
;
945 rp_info
->i_am_rp
= 0;
947 listnode_add_sort(pim
->rp_list
, rp_info
);
949 for (ALL_LIST_ELEMENTS_RO(pim
->upstream_list
, upnode
, up
)) {
950 if (up
->sg
.src
.s_addr
== INADDR_ANY
) {
952 struct rp_info
*trp_info
;
954 grp
.family
= AF_INET
;
955 grp
.prefixlen
= IPV4_MAX_BITLEN
;
956 grp
.u
.prefix4
= up
->sg
.grp
;
957 trp_info
= pim_rp_find_match_group(pim
, &grp
);
959 if (trp_info
== rp_info
)
960 pim_upstream_update(pim
, up
);
964 /* Register new RP addr with Zebra NHT */
965 nht_p
.u
.prefix4
= rp_info
->rp
.rpf_addr
.u
.prefix4
;
966 if (PIM_DEBUG_PIM_NHT_RP
) {
967 char buf
[PREFIX2STR_BUFFER
];
968 char buf1
[PREFIX2STR_BUFFER
];
970 prefix2str(&nht_p
, buf
, sizeof(buf
));
971 prefix2str(&rp_info
->group
, buf1
, sizeof(buf1
));
972 zlog_debug("%s: NHT Register RP addr %s grp %s with Zebra ",
973 __PRETTY_FUNCTION__
, buf
, buf1
);
976 pim_find_or_track_nexthop(pim
, &nht_p
, NULL
, rp_info
, false, NULL
);
977 if (!pim_ecmp_nexthop_lookup(pim
, &rp_info
->rp
.source_nexthop
, &nht_p
,
978 &rp_info
->group
, 1)) {
979 route_unlock_node(rn
);
980 return PIM_RP_NO_PATH
;
983 pim_rp_check_interfaces(pim
, rp_info
);
985 route_unlock_node(rn
);
987 pim_rp_refresh_group_to_rp_mapping(pim
);
992 void pim_rp_setup(struct pim_instance
*pim
)
994 struct listnode
*node
;
995 struct rp_info
*rp_info
;
998 for (ALL_LIST_ELEMENTS_RO(pim
->rp_list
, node
, rp_info
)) {
999 if (rp_info
->rp
.rpf_addr
.u
.prefix4
.s_addr
== INADDR_NONE
)
1002 nht_p
.family
= AF_INET
;
1003 nht_p
.prefixlen
= IPV4_MAX_BITLEN
;
1004 nht_p
.u
.prefix4
= rp_info
->rp
.rpf_addr
.u
.prefix4
;
1006 pim_find_or_track_nexthop(pim
, &nht_p
, NULL
, rp_info
, false,
1008 if (!pim_ecmp_nexthop_lookup(pim
, &rp_info
->rp
.source_nexthop
,
1009 &nht_p
, &rp_info
->group
, 1))
1010 if (PIM_DEBUG_PIM_NHT_RP
)
1012 "Unable to lookup nexthop for rp specified");
1017 * Checks to see if we should elect ourself the actual RP when new if
1018 * addresses are added against an interface.
1020 void pim_rp_check_on_if_add(struct pim_interface
*pim_ifp
)
1022 struct listnode
*node
;
1023 struct rp_info
*rp_info
;
1024 bool i_am_rp_changed
= false;
1025 struct pim_instance
*pim
= pim_ifp
->pim
;
1027 if (pim
->rp_list
== NULL
)
1030 for (ALL_LIST_ELEMENTS_RO(pim
->rp_list
, node
, rp_info
)) {
1031 if (pim_rpf_addr_is_inaddr_none(&rp_info
->rp
))
1034 /* if i_am_rp is already set nothing to be done (adding new
1036 * is not going to make a difference). */
1037 if (rp_info
->i_am_rp
) {
1041 if (pim_rp_check_interface_addrs(rp_info
, pim_ifp
)) {
1042 i_am_rp_changed
= true;
1043 rp_info
->i_am_rp
= 1;
1044 if (PIM_DEBUG_PIM_NHT_RP
) {
1045 char rp
[PREFIX_STRLEN
];
1046 pim_addr_dump("<rp?>", &rp_info
->rp
.rpf_addr
,
1048 zlog_debug("%s: %s: i am rp", __func__
, rp
);
1053 if (i_am_rp_changed
) {
1054 pim_msdp_i_am_rp_changed(pim
);
1058 /* up-optimized re-evaluation of "i_am_rp". this is used when ifaddresses
1059 * are removed. Removing numbers is an uncommon event in an active network
1060 * so I have made no attempt to optimize it. */
1061 void pim_i_am_rp_re_evaluate(struct pim_instance
*pim
)
1063 struct listnode
*node
;
1064 struct rp_info
*rp_info
;
1065 bool i_am_rp_changed
= false;
1068 if (pim
->rp_list
== NULL
)
1071 for (ALL_LIST_ELEMENTS_RO(pim
->rp_list
, node
, rp_info
)) {
1072 if (pim_rpf_addr_is_inaddr_none(&rp_info
->rp
))
1075 old_i_am_rp
= rp_info
->i_am_rp
;
1076 pim_rp_check_interfaces(pim
, rp_info
);
1078 if (old_i_am_rp
!= rp_info
->i_am_rp
) {
1079 i_am_rp_changed
= true;
1080 if (PIM_DEBUG_PIM_NHT_RP
) {
1081 char rp
[PREFIX_STRLEN
];
1082 pim_addr_dump("<rp?>", &rp_info
->rp
.rpf_addr
,
1084 if (rp_info
->i_am_rp
) {
1085 zlog_debug("%s: %s: i am rp", __func__
,
1088 zlog_debug("%s: %s: i am no longer rp",
1095 if (i_am_rp_changed
) {
1096 pim_msdp_i_am_rp_changed(pim
);
1101 * I_am_RP(G) is true if the group-to-RP mapping indicates that
1102 * this router is the RP for the group.
1104 * Since we only have static RP, all groups are part of this RP
1106 int pim_rp_i_am_rp(struct pim_instance
*pim
, struct in_addr group
)
1109 struct rp_info
*rp_info
;
1111 memset(&g
, 0, sizeof(g
));
1114 g
.u
.prefix4
= group
;
1116 rp_info
= pim_rp_find_match_group(pim
, &g
);
1119 return rp_info
->i_am_rp
;
1127 * Return the RP that the Group belongs too.
1129 struct pim_rpf
*pim_rp_g(struct pim_instance
*pim
, struct in_addr group
)
1132 struct rp_info
*rp_info
;
1134 memset(&g
, 0, sizeof(g
));
1137 g
.u
.prefix4
= group
;
1139 rp_info
= pim_rp_find_match_group(pim
, &g
);
1142 struct prefix nht_p
;
1144 /* Register addr with Zebra NHT */
1145 nht_p
.family
= AF_INET
;
1146 nht_p
.prefixlen
= IPV4_MAX_BITLEN
;
1147 nht_p
.u
.prefix4
= rp_info
->rp
.rpf_addr
.u
.prefix4
;
1148 if (PIM_DEBUG_PIM_NHT_RP
) {
1149 char buf
[PREFIX2STR_BUFFER
];
1150 char buf1
[PREFIX2STR_BUFFER
];
1151 prefix2str(&nht_p
, buf
, sizeof(buf
));
1152 prefix2str(&rp_info
->group
, buf1
, sizeof(buf1
));
1154 "%s: NHT Register RP addr %s grp %s with Zebra",
1155 __PRETTY_FUNCTION__
, buf
, buf1
);
1157 pim_find_or_track_nexthop(pim
, &nht_p
, NULL
, rp_info
, false,
1159 pim_rpf_set_refresh_time(pim
);
1160 (void)pim_ecmp_nexthop_lookup(pim
, &rp_info
->rp
.source_nexthop
,
1161 &nht_p
, &rp_info
->group
, 1);
1162 return (&rp_info
->rp
);
1170 * Set the upstream IP address we want to talk to based upon
1171 * the rp configured and the source address
1173 * If we have don't have a RP configured and the source address is *
1174 * then set the upstream addr as INADDR_ANY and return failure.
1177 int pim_rp_set_upstream_addr(struct pim_instance
*pim
, struct in_addr
*up
,
1178 struct in_addr source
, struct in_addr group
)
1180 struct rp_info
*rp_info
;
1183 memset(&g
, 0, sizeof(g
));
1186 g
.u
.prefix4
= group
;
1188 rp_info
= pim_rp_find_match_group(pim
, &g
);
1190 if ((pim_rpf_addr_is_inaddr_none(&rp_info
->rp
))
1191 && (source
.s_addr
== INADDR_ANY
)) {
1192 if (PIM_DEBUG_PIM_NHT_RP
)
1193 zlog_debug("%s: Received a (*,G) with no RP configured",
1194 __PRETTY_FUNCTION__
);
1195 up
->s_addr
= INADDR_ANY
;
1199 *up
= (source
.s_addr
== INADDR_ANY
) ? rp_info
->rp
.rpf_addr
.u
.prefix4
1205 int pim_rp_config_write(struct pim_instance
*pim
, struct vty
*vty
,
1208 struct listnode
*node
;
1209 struct rp_info
*rp_info
;
1211 char group_buffer
[32];
1214 for (ALL_LIST_ELEMENTS_RO(pim
->rp_list
, node
, rp_info
)) {
1215 if (pim_rpf_addr_is_inaddr_none(&rp_info
->rp
))
1218 if (rp_info
->rp_src
== RP_SRC_BSR
)
1222 vty_out(vty
, "%sip pim rp %s prefix-list %s\n", spaces
,
1224 &rp_info
->rp
.rpf_addr
.u
.prefix4
,
1228 vty_out(vty
, "%sip pim rp %s %s\n", spaces
,
1230 &rp_info
->rp
.rpf_addr
.u
.prefix4
,
1232 prefix2str(&rp_info
->group
, group_buffer
, 32));
1239 bool pim_rp_check_is_my_ip_address(struct pim_instance
*pim
,
1240 struct in_addr dest_addr
)
1242 if (if_lookup_exact_address(&dest_addr
, AF_INET
, pim
->vrf_id
))
1248 void pim_rp_show_information(struct pim_instance
*pim
, struct vty
*vty
, bool uj
)
1250 struct rp_info
*rp_info
;
1251 struct rp_info
*prev_rp_info
= NULL
;
1252 struct listnode
*node
;
1255 json_object
*json
= NULL
;
1256 json_object
*json_rp_rows
= NULL
;
1257 json_object
*json_row
= NULL
;
1260 json
= json_object_new_object();
1263 "RP address group/prefix-list OIF I am RP Source\n");
1264 for (ALL_LIST_ELEMENTS_RO(pim
->rp_list
, node
, rp_info
)) {
1265 if (!pim_rpf_addr_is_inaddr_none(&rp_info
->rp
)) {
1268 if (rp_info
->rp_src
== RP_SRC_STATIC
)
1269 strcpy(source
, "Static");
1270 else if (rp_info
->rp_src
== RP_SRC_BSR
)
1271 strcpy(source
, "BSR");
1273 strcpy(source
, "None");
1276 * If we have moved on to a new RP then add the
1277 * entry for the previous RP
1280 && prev_rp_info
->rp
.rpf_addr
.u
.prefix4
1282 != rp_info
->rp
.rpf_addr
.u
.prefix4
1284 json_object_object_add(
1286 inet_ntoa(prev_rp_info
->rp
1290 json_rp_rows
= NULL
;
1294 json_rp_rows
= json_object_new_array();
1296 json_row
= json_object_new_object();
1297 if (rp_info
->rp
.source_nexthop
.interface
)
1298 json_object_string_add(
1299 json_row
, "outboundInterface",
1300 rp_info
->rp
.source_nexthop
1303 if (rp_info
->i_am_rp
)
1304 json_object_boolean_true_add(json_row
,
1308 json_object_string_add(json_row
,
1312 json_object_string_add(
1314 prefix2str(&rp_info
->group
, buf
,
1316 json_object_string_add(json_row
, "source",
1319 json_object_array_add(json_rp_rows
, json_row
);
1321 vty_out(vty
, "%-15s ",
1322 inet_ntoa(rp_info
->rp
.rpf_addr
.u
1326 vty_out(vty
, "%-18s ", rp_info
->plist
);
1328 vty_out(vty
, "%-18s ",
1329 prefix2str(&rp_info
->group
, buf
,
1332 if (rp_info
->rp
.source_nexthop
.interface
)
1333 vty_out(vty
, "%-16s ",
1334 rp_info
->rp
.source_nexthop
1337 vty_out(vty
, "%-16s ", "(Unknown)");
1339 if (rp_info
->i_am_rp
)
1340 vty_out(vty
, "yes\n");
1344 vty_out(vty
, "%14s\n", source
);
1346 prev_rp_info
= rp_info
;
1351 if (prev_rp_info
&& json_rp_rows
)
1352 json_object_object_add(
1354 inet_ntoa(prev_rp_info
->rp
.rpf_addr
.u
.prefix4
),
1357 vty_out(vty
, "%s\n", json_object_to_json_string_ext(
1358 json
, JSON_C_TO_STRING_PRETTY
));
1359 json_object_free(json
);
1363 void pim_resolve_rp_nh(struct pim_instance
*pim
, struct pim_neighbor
*nbr
)
1365 struct listnode
*node
= NULL
;
1366 struct rp_info
*rp_info
= NULL
;
1367 struct nexthop
*nh_node
= NULL
;
1368 struct prefix nht_p
;
1369 struct pim_nexthop_cache pnc
;
1371 for (ALL_LIST_ELEMENTS_RO(pim
->rp_list
, node
, rp_info
)) {
1372 if (rp_info
->rp
.rpf_addr
.u
.prefix4
.s_addr
== INADDR_NONE
)
1375 nht_p
.family
= AF_INET
;
1376 nht_p
.prefixlen
= IPV4_MAX_BITLEN
;
1377 nht_p
.u
.prefix4
= rp_info
->rp
.rpf_addr
.u
.prefix4
;
1378 memset(&pnc
, 0, sizeof(struct pim_nexthop_cache
));
1379 if (!pim_find_or_track_nexthop(pim
, &nht_p
, NULL
, rp_info
,
1383 for (nh_node
= pnc
.nexthop
; nh_node
; nh_node
= nh_node
->next
) {
1384 if (nh_node
->gate
.ipv4
.s_addr
!= 0)
1387 struct interface
*ifp1
= if_lookup_by_index(
1388 nh_node
->ifindex
, pim
->vrf_id
);
1390 if (nbr
->interface
!= ifp1
)
1393 nh_node
->gate
.ipv4
= nbr
->source_addr
;
1394 if (PIM_DEBUG_PIM_NHT_RP
) {
1395 char str
[PREFIX_STRLEN
];
1396 char str1
[INET_ADDRSTRLEN
];
1397 pim_inet4_dump("<nht_nbr?>", nbr
->source_addr
,
1398 str1
, sizeof(str1
));
1399 pim_addr_dump("<nht_addr?>", &nht_p
, str
,
1402 "%s: addr %s new nexthop addr %s interface %s",
1403 __PRETTY_FUNCTION__
, str
, str1
,