2 * pim_bsm.c: PIM BSM handling routines
4 * Copyright (C) 2018-19 Vmware, Inc.
7 * This program is free software; you can redistribute it and/or modify
8 * it under the terms of the GNU General Public License as published by
9 * the Free Software Foundation; either version 2 of the License, or
10 * (at your option) any later version.
12 * This program is distributed in the hope that it will be useful, but
13 * WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15 * General Public License for more details.
17 * You should have received a copy of the GNU General Public License
18 * along with this program; see the file COPYING; if not, write to the
19 * Free Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston,
29 #include "pim_iface.h"
30 #include "pim_instance.h"
32 #include "pim_hello.h"
38 /* Functions forward declaration */
39 static void pim_bs_timer_start(struct bsm_scope
*scope
, int bs_timeout
);
40 static void pim_g2rp_timer_start(struct bsm_rpinfo
*bsrp
, int hold_time
);
41 static inline void pim_g2rp_timer_restart(struct bsm_rpinfo
*bsrp
,
45 DEFINE_MTYPE_STATIC(PIMD
, PIM_BSGRP_NODE
, "PIM BSR advertised grp info")
46 DEFINE_MTYPE_STATIC(PIMD
, PIM_BSRP_NODE
, "PIM BSR advertised RP info")
47 DEFINE_MTYPE_STATIC(PIMD
, PIM_BSM_INFO
, "PIM BSM Info")
48 DEFINE_MTYPE_STATIC(PIMD
, PIM_BSM_PKT_VAR_MEM
, "PIM BSM Packet")
50 /* All bsm packets forwarded shall be fit within ip mtu less iphdr(max) */
51 #define MAX_IP_HDR_LEN 24
53 /* pim_bsm_write_config - Write the interface pim bsm configuration.*/
54 void pim_bsm_write_config(struct vty
*vty
, struct interface
*ifp
)
56 struct pim_interface
*pim_ifp
= ifp
->info
;
59 if (!pim_ifp
->bsm_enable
)
60 vty_out(vty
, " no ip pim bsm\n");
61 if (!pim_ifp
->ucast_bsm_accept
)
62 vty_out(vty
, " no ip pim unicast-bsm\n");
66 static void pim_free_bsgrp_data(struct bsgrp_node
*bsgrp_node
)
68 if (bsgrp_node
->bsrp_list
)
69 list_delete(&bsgrp_node
->bsrp_list
);
70 if (bsgrp_node
->partial_bsrp_list
)
71 list_delete(&bsgrp_node
->partial_bsrp_list
);
72 XFREE(MTYPE_PIM_BSGRP_NODE
, bsgrp_node
);
75 static void pim_free_bsgrp_node(struct route_table
*rt
, struct prefix
*grp
)
77 struct route_node
*rn
;
79 rn
= route_node_lookup(rt
, grp
);
82 route_unlock_node(rn
);
83 route_unlock_node(rn
);
87 static void pim_bsm_node_free(struct bsm_info
*bsm
)
89 XFREE(MTYPE_PIM_BSM_PKT_VAR_MEM
, bsm
->bsm
);
90 XFREE(MTYPE_PIM_BSM_INFO
, bsm
);
93 static int pim_g2rp_list_compare(struct bsm_rpinfo
*node1
,
94 struct bsm_rpinfo
*node2
)
97 * Step-1 : Loweset Rp priority will have higher precedance.
98 * Step-2 : If priority same then higher hash val will have
100 * Step-3 : If Hash val is same then highest rp address will
103 if (node1
->rp_prio
< node2
->rp_prio
)
105 if (node1
->rp_prio
> node2
->rp_prio
)
107 if (node1
->hash
< node2
->hash
)
109 if (node1
->hash
> node2
->hash
)
111 if (node1
->rp_address
.s_addr
< node2
->rp_address
.s_addr
)
113 if (node1
->rp_address
.s_addr
> node2
->rp_address
.s_addr
)
118 static void pim_free_bsrp_node(struct bsm_rpinfo
*bsrp_info
)
120 THREAD_OFF(bsrp_info
->g2rp_timer
);
121 XFREE(MTYPE_PIM_BSRP_NODE
, bsrp_info
);
124 static struct list
*pim_alloc_bsrp_list(void)
126 struct list
*new_list
= NULL
;
128 new_list
= list_new();
133 new_list
->cmp
= (int (*)(void *, void *))pim_g2rp_list_compare
;
134 new_list
->del
= (void (*)(void *))pim_free_bsrp_node
;
139 static struct bsgrp_node
*pim_bsm_new_bsgrp_node(struct route_table
*rt
,
142 struct route_node
*rn
;
143 struct bsgrp_node
*bsgrp
;
145 rn
= route_node_get(rt
, grp
);
147 zlog_warn("%s: route node creation failed", __func__
);
150 bsgrp
= XCALLOC(MTYPE_PIM_BSGRP_NODE
, sizeof(struct bsgrp_node
));
153 bsgrp
->bsrp_list
= pim_alloc_bsrp_list();
154 bsgrp
->partial_bsrp_list
= pim_alloc_bsrp_list();
156 if ((!bsgrp
->bsrp_list
) || (!bsgrp
->partial_bsrp_list
)) {
157 route_unlock_node(rn
);
158 pim_free_bsgrp_data(bsgrp
);
162 prefix_copy(&bsgrp
->group
, grp
);
166 static int pim_on_bs_timer(struct thread
*t
)
168 struct route_node
*rn
;
169 struct bsm_scope
*scope
;
170 struct bsgrp_node
*bsgrp_node
;
171 struct bsm_rpinfo
*bsrp
;
173 bool is_bsr_tracking
= true;
175 scope
= THREAD_ARG(t
);
176 THREAD_OFF(scope
->bs_timer
);
179 zlog_debug("%s: Bootstrap Timer expired for scope: %d",
180 __func__
, scope
->sz_id
);
182 /* Remove next hop tracking for the bsr */
183 nht_p
.family
= AF_INET
;
184 nht_p
.prefixlen
= IPV4_MAX_BITLEN
;
185 nht_p
.u
.prefix4
= scope
->current_bsr
;
187 zlog_debug("%s: Deregister BSR addr %pFX with Zebra NHT",
189 pim_delete_tracked_nexthop(scope
->pim
, &nht_p
, NULL
, NULL
,
192 /* Reset scope zone data */
193 scope
->accept_nofwd_bsm
= false;
194 scope
->state
= ACCEPT_ANY
;
195 scope
->current_bsr
.s_addr
= INADDR_ANY
;
196 scope
->current_bsr_prio
= 0;
197 scope
->current_bsr_first_ts
= 0;
198 scope
->current_bsr_last_ts
= 0;
199 scope
->bsm_frag_tag
= 0;
200 list_delete_all_node(scope
->bsm_list
);
202 for (rn
= route_top(scope
->bsrp_table
); rn
; rn
= route_next(rn
)) {
204 bsgrp_node
= (struct bsgrp_node
*)rn
->info
;
207 zlog_debug("%s: bsgrp_node is null", __func__
);
210 /* Give grace time for rp to continue for another hold time */
211 if ((bsgrp_node
->bsrp_list
) && (bsgrp_node
->bsrp_list
->count
)) {
212 bsrp
= listnode_head(bsgrp_node
->bsrp_list
);
213 pim_g2rp_timer_restart(bsrp
, bsrp
->rp_holdtime
);
215 /* clear pending list */
216 if ((bsgrp_node
->partial_bsrp_list
)
217 && (bsgrp_node
->partial_bsrp_list
->count
)) {
218 list_delete_all_node(bsgrp_node
->partial_bsrp_list
);
219 bsgrp_node
->pend_rp_cnt
= 0;
225 static void pim_bs_timer_stop(struct bsm_scope
*scope
)
228 zlog_debug("%s : BS timer being stopped of sz: %d", __func__
,
230 THREAD_OFF(scope
->bs_timer
);
233 static void pim_bs_timer_start(struct bsm_scope
*scope
, int bs_timeout
)
237 zlog_debug("%s : Invalid scope(NULL).", __func__
);
240 THREAD_OFF(scope
->bs_timer
);
243 "%s : starting bs timer for scope %d with timeout %d secs",
244 __func__
, scope
->sz_id
, bs_timeout
);
245 thread_add_timer(router
->master
, pim_on_bs_timer
, scope
, bs_timeout
,
249 static inline void pim_bs_timer_restart(struct bsm_scope
*scope
, int bs_timeout
)
251 pim_bs_timer_start(scope
, bs_timeout
);
254 void pim_bsm_proc_init(struct pim_instance
*pim
)
256 memset(&pim
->global_scope
, 0, sizeof(struct bsm_scope
));
258 pim
->global_scope
.sz_id
= PIM_GBL_SZ_ID
;
259 pim
->global_scope
.bsrp_table
= route_table_init();
260 pim
->global_scope
.accept_nofwd_bsm
= true;
261 pim
->global_scope
.state
= NO_INFO
;
262 pim
->global_scope
.pim
= pim
;
263 pim
->global_scope
.bsm_list
= list_new();
264 pim
->global_scope
.bsm_list
->del
= (void (*)(void *))pim_bsm_node_free
;
265 pim_bs_timer_start(&pim
->global_scope
, PIM_BS_TIME
);
268 void pim_bsm_proc_free(struct pim_instance
*pim
)
270 struct route_node
*rn
;
271 struct bsgrp_node
*bsgrp
;
273 pim_bs_timer_stop(&pim
->global_scope
);
275 if (pim
->global_scope
.bsm_list
)
276 list_delete(&pim
->global_scope
.bsm_list
);
278 for (rn
= route_top(pim
->global_scope
.bsrp_table
); rn
;
279 rn
= route_next(rn
)) {
283 pim_free_bsgrp_data(bsgrp
);
286 route_table_finish(pim
->global_scope
.bsrp_table
);
289 static bool is_hold_time_elapsed(void *data
)
291 struct bsm_rpinfo
*bsrp
;
295 if (bsrp
->elapse_time
< bsrp
->rp_holdtime
)
301 static int pim_on_g2rp_timer(struct thread
*t
)
303 struct bsm_rpinfo
*bsrp
;
304 struct bsm_rpinfo
*bsrp_node
;
305 struct bsgrp_node
*bsgrp_node
;
306 struct listnode
*bsrp_ln
;
307 struct pim_instance
*pim
;
308 struct rp_info
*rp_info
;
309 struct route_node
*rn
;
311 struct in_addr bsrp_addr
;
313 bsrp
= THREAD_ARG(t
);
314 THREAD_OFF(bsrp
->g2rp_timer
);
315 bsgrp_node
= bsrp
->bsgrp_node
;
317 /* elapse time is the hold time of expired node */
318 elapse
= bsrp
->rp_holdtime
;
319 bsrp_addr
= bsrp
->rp_address
;
321 /* update elapse for all bsrp nodes */
322 for (ALL_LIST_ELEMENTS_RO(bsgrp_node
->bsrp_list
, bsrp_ln
, bsrp_node
))
323 bsrp_node
->elapse_time
+= elapse
;
325 /* remove the expired nodes from the list */
326 list_filter_out_nodes(bsgrp_node
->bsrp_list
, is_hold_time_elapsed
);
328 /* Get the next elected rp node */
329 bsrp
= listnode_head(bsgrp_node
->bsrp_list
);
330 pim
= bsgrp_node
->scope
->pim
;
331 rn
= route_node_lookup(pim
->rp_table
, &bsgrp_node
->group
);
334 zlog_warn("%s: Route node doesn't exist", __func__
);
338 rp_info
= (struct rp_info
*)rn
->info
;
341 route_unlock_node(rn
);
345 if (rp_info
->rp_src
!= RP_SRC_STATIC
) {
346 /* If new rp available, change it else delete the existing */
348 bsrp_addr
= bsrp
->rp_address
;
349 pim_g2rp_timer_start(
350 bsrp
, (bsrp
->rp_holdtime
- bsrp
->elapse_time
));
351 pim_rp_change(pim
, bsrp_addr
, bsgrp_node
->group
,
354 pim_rp_del(pim
, bsrp_addr
, bsgrp_node
->group
, NULL
,
359 if ((!bsgrp_node
->bsrp_list
->count
)
360 && (!bsgrp_node
->partial_bsrp_list
->count
)) {
361 pim_free_bsgrp_node(pim
->global_scope
.bsrp_table
,
363 pim_free_bsgrp_data(bsgrp_node
);
369 static void pim_g2rp_timer_start(struct bsm_rpinfo
*bsrp
, int hold_time
)
373 zlog_debug("%s : Invalid brsp(NULL).", __func__
);
376 THREAD_OFF(bsrp
->g2rp_timer
);
379 "%s : starting g2rp timer for grp: %pFX - rp: %pI4 with timeout %d secs(Actual Hold time : %d secs)",
380 __func__
, &bsrp
->bsgrp_node
->group
,
381 &bsrp
->rp_address
, hold_time
,
384 thread_add_timer(router
->master
, pim_on_g2rp_timer
, bsrp
, hold_time
,
388 static inline void pim_g2rp_timer_restart(struct bsm_rpinfo
*bsrp
,
391 pim_g2rp_timer_start(bsrp
, hold_time
);
394 static void pim_g2rp_timer_stop(struct bsm_rpinfo
*bsrp
)
400 zlog_debug("%s : stopping g2rp timer for grp: %pFX - rp: %pI4",
401 __func__
, &bsrp
->bsgrp_node
->group
,
404 THREAD_OFF(bsrp
->g2rp_timer
);
407 static bool is_hold_time_zero(void *data
)
409 struct bsm_rpinfo
*bsrp
;
413 if (bsrp
->rp_holdtime
)
419 static void pim_instate_pend_list(struct bsgrp_node
*bsgrp_node
)
421 struct bsm_rpinfo
*active
;
422 struct bsm_rpinfo
*pend
;
424 struct rp_info
*rp_info
;
425 struct route_node
*rn
;
426 struct pim_instance
*pim
;
427 struct rp_info
*rp_all
;
428 struct prefix group_all
;
429 bool had_rp_node
= true;
431 pim
= bsgrp_node
->scope
->pim
;
432 active
= listnode_head(bsgrp_node
->bsrp_list
);
434 /* Remove nodes with hold time 0 & check if list still has a head */
435 list_filter_out_nodes(bsgrp_node
->partial_bsrp_list
, is_hold_time_zero
);
436 pend
= listnode_head(bsgrp_node
->partial_bsrp_list
);
438 if (!str2prefix("224.0.0.0/4", &group_all
))
441 rp_all
= pim_rp_find_match_group(pim
, &group_all
);
442 rn
= route_node_lookup(pim
->rp_table
, &bsgrp_node
->group
);
445 pim_g2rp_timer_start(pend
, pend
->rp_holdtime
);
447 /* if rp node doesn't exist or exist but not configured(rp_all),
448 * install the rp from head(if exists) of partial list. List is
449 * is sorted such that head is the elected RP for the group.
451 if (!rn
|| (prefix_same(&rp_all
->group
, &bsgrp_node
->group
)
452 && pim_rpf_addr_is_inaddr_none(&rp_all
->rp
))) {
454 zlog_debug("%s: Route node doesn't exist", __func__
);
456 pim_rp_new(pim
, pend
->rp_address
, bsgrp_node
->group
,
460 rp_info
= (struct rp_info
*)rn
->info
;
462 route_unlock_node(rn
);
464 pim_rp_new(pim
, pend
->rp_address
,
465 bsgrp_node
->group
, NULL
, RP_SRC_BSR
);
470 /* We didn't have rp node and pending list is empty(unlikely), cleanup*/
471 if ((!had_rp_node
) && (!pend
)) {
472 pim_free_bsgrp_node(bsgrp_node
->scope
->bsrp_table
,
474 pim_free_bsgrp_data(bsgrp_node
);
478 if ((had_rp_node
) && (rp_info
->rp_src
!= RP_SRC_STATIC
)) {
479 /* This means we searched and got rp node, needs unlock */
480 route_unlock_node(rn
);
482 if (active
&& pend
) {
483 if ((active
->rp_address
.s_addr
484 != pend
->rp_address
.s_addr
))
485 pim_rp_change(pim
, pend
->rp_address
,
486 bsgrp_node
->group
, RP_SRC_BSR
);
489 /* Possible when the first BSM has group with 0 rp count */
490 if ((!active
) && (!pend
)) {
493 "%s: Both bsrp and partial list are empty",
496 pim_free_bsgrp_node(bsgrp_node
->scope
->bsrp_table
,
498 pim_free_bsgrp_data(bsgrp_node
);
502 /* Possible when a group with 0 rp count received in BSM */
503 if ((active
) && (!pend
)) {
504 pim_rp_del(pim
, active
->rp_address
, bsgrp_node
->group
,
506 pim_free_bsgrp_node(bsgrp_node
->scope
->bsrp_table
,
509 zlog_debug("%s:Pend List is null,del grp node",
512 pim_free_bsgrp_data(bsgrp_node
);
517 if ((had_rp_node
) && (rp_info
->rp_src
== RP_SRC_STATIC
)) {
518 /* We need to unlock rn this case */
519 route_unlock_node(rn
);
520 /* there is a chance that static rp exist and bsrp cleaned
521 * so clean bsgrp node if pending list empty
526 "%s: Partial list is empty, static rp exists",
528 pim_free_bsgrp_node(bsgrp_node
->scope
->bsrp_table
,
530 pim_free_bsgrp_data(bsgrp_node
);
535 /* swap the list & delete all nodes in partial list (old bsrp_list)
537 * active is head of bsrp list
538 * pend is head of partial list
540 * active is head of partial list
541 * pend is head of bsrp list
542 * So check appriate head after swap and clean the new partial list
544 temp
= bsgrp_node
->bsrp_list
;
545 bsgrp_node
->bsrp_list
= bsgrp_node
->partial_bsrp_list
;
546 bsgrp_node
->partial_bsrp_list
= temp
;
549 pim_g2rp_timer_stop(active
);
550 list_delete_all_node(bsgrp_node
->partial_bsrp_list
);
554 static bool pim_bsr_rpf_check(struct pim_instance
*pim
, struct in_addr bsr
,
555 struct in_addr ip_src_addr
)
557 struct pim_nexthop nexthop
;
560 memset(&nexthop
, 0, sizeof(nexthop
));
562 /* New BSR recived */
563 if (bsr
.s_addr
!= pim
->global_scope
.current_bsr
.s_addr
) {
564 result
= pim_nexthop_match(pim
, bsr
, ip_src_addr
);
566 /* Nexthop lookup pass for the new BSR address */
571 char bsr_str
[INET_ADDRSTRLEN
];
573 pim_inet4_dump("<bsr?>", bsr
, bsr_str
, sizeof(bsr_str
));
574 zlog_debug("%s : No route to BSR address %s", __func__
,
580 return pim_nexthop_match_nht_cache(pim
, bsr
, ip_src_addr
);
583 static bool is_preferred_bsr(struct pim_instance
*pim
, struct in_addr bsr
,
586 if (bsr
.s_addr
== pim
->global_scope
.current_bsr
.s_addr
)
589 if (bsr_prio
> pim
->global_scope
.current_bsr_prio
)
592 else if (bsr_prio
== pim
->global_scope
.current_bsr_prio
) {
593 if (ntohl(bsr
.s_addr
)
594 >= ntohl(pim
->global_scope
.current_bsr
.s_addr
))
602 static void pim_bsm_update(struct pim_instance
*pim
, struct in_addr bsr
,
605 struct pim_nexthop_cache pnc
;
607 if (bsr
.s_addr
!= pim
->global_scope
.current_bsr
.s_addr
) {
609 bool is_bsr_tracking
= true;
611 /* De-register old BSR and register new BSR with Zebra NHT */
612 nht_p
.family
= AF_INET
;
613 nht_p
.prefixlen
= IPV4_MAX_BITLEN
;
615 if (pim
->global_scope
.current_bsr
.s_addr
!= INADDR_ANY
) {
616 nht_p
.u
.prefix4
= pim
->global_scope
.current_bsr
;
619 "%s: Deregister BSR addr %pFX with Zebra NHT",
621 pim_delete_tracked_nexthop(pim
, &nht_p
, NULL
, NULL
,
625 nht_p
.u
.prefix4
= bsr
;
628 "%s: NHT Register BSR addr %pFX with Zebra NHT",
631 memset(&pnc
, 0, sizeof(struct pim_nexthop_cache
));
632 pim_find_or_track_nexthop(pim
, &nht_p
, NULL
, NULL
,
633 is_bsr_tracking
, &pnc
);
634 pim
->global_scope
.current_bsr
= bsr
;
635 pim
->global_scope
.current_bsr_first_ts
=
636 pim_time_monotonic_sec();
637 pim
->global_scope
.state
= ACCEPT_PREFERRED
;
639 pim
->global_scope
.current_bsr_prio
= bsr_prio
;
640 pim
->global_scope
.current_bsr_last_ts
= pim_time_monotonic_sec();
643 static bool pim_bsm_send_intf(uint8_t *buf
, int len
, struct interface
*ifp
,
644 struct in_addr dst_addr
)
646 struct pim_interface
*pim_ifp
;
652 zlog_debug("%s: Pim interface not available for %s",
653 __func__
, ifp
->name
);
657 if (pim_ifp
->pim_sock_fd
== -1) {
659 zlog_debug("%s: Pim sock not available for %s",
660 __func__
, ifp
->name
);
664 if (pim_msg_send(pim_ifp
->pim_sock_fd
, pim_ifp
->primary_address
,
665 dst_addr
, buf
, len
, ifp
->name
)) {
666 zlog_warn("%s: Could not send BSM message on interface: %s",
667 __func__
, ifp
->name
);
671 pim_ifp
->pim_ifstat_bsm_tx
++;
672 pim_ifp
->pim
->bsm_sent
++;
676 static bool pim_bsm_frag_send(uint8_t *buf
, uint32_t len
, struct interface
*ifp
,
677 uint32_t pim_mtu
, struct in_addr dst_addr
,
680 struct bsmmsg_grpinfo
*grpinfo
, *curgrp
;
681 uint8_t *firstgrp_ptr
;
684 uint32_t parsed_len
= 0;
685 uint32_t this_pkt_rem
;
686 uint32_t copy_byte_count
;
687 uint32_t this_pkt_len
;
688 uint8_t total_rp_cnt
;
692 bool pak_pending
= false;
694 /* MTU passed here is PIM MTU (IP MTU less IP Hdr) */
695 if (pim_mtu
< (PIM_MIN_BSM_LEN
)) {
697 "%s: mtu(pim mtu: %d) size less than minimum bootstrap len",
701 "%s: mtu (pim mtu:%d) less than minimum bootstrap len",
706 pak_start
= XCALLOC(MTYPE_PIM_BSM_PKT_VAR_MEM
, pim_mtu
);
710 /* Fill PIM header later before sending packet to calc checksum */
711 pkt
+= PIM_MSG_HEADER_LEN
;
712 buf
+= PIM_MSG_HEADER_LEN
;
714 /* copy bsm header to new packet at offset of pim hdr */
715 memcpy(pkt
, buf
, PIM_BSM_HDR_LEN
);
716 pkt
+= PIM_BSM_HDR_LEN
;
717 buf
+= PIM_BSM_HDR_LEN
;
718 parsed_len
+= (PIM_MSG_HEADER_LEN
+ PIM_BSM_HDR_LEN
);
720 /* Store the position of first grp ptr, which can be reused for
721 * next packet to start filling group. old bsm header and pim hdr
722 * remains. So need not be filled again for next packet onwards.
726 /* we received mtu excluding IP hdr len as param
727 * now this_pkt_rem is mtu excluding
728 * PIM_BSM_HDR_LEN + PIM_MSG_HEADER_LEN
730 this_pkt_rem
= pim_mtu
- (PIM_BSM_HDR_LEN
+ PIM_MSG_HEADER_LEN
);
732 /* For each group till the packet length parsed */
733 while (parsed_len
< len
) {
734 /* pkt ---> fragment's current pointer
735 * buf ---> input buffer's current pointer
736 * mtu ---> size of the pim packet - PIM header
737 * curgrp ---> current group on the fragment
738 * grpinfo ---> current group on the input buffer
739 * this_pkt_rem ---> bytes remaing on the current fragment
740 * rp_fit_cnt ---> num of rp for current grp that
742 * total_rp_cnt ---> total rp present for the group in the buf
743 * frag_rp_cnt ---> no of rp for the group to be fit in
745 * this_rp_cnt ---> how many rp have we parsed
747 grpinfo
= (struct bsmmsg_grpinfo
*)buf
;
748 memcpy(pkt
, buf
, PIM_BSM_GRP_LEN
);
749 curgrp
= (struct bsmmsg_grpinfo
*)pkt
;
750 parsed_len
+= PIM_BSM_GRP_LEN
;
751 pkt
+= PIM_BSM_GRP_LEN
;
752 buf
+= PIM_BSM_GRP_LEN
;
753 this_pkt_rem
-= PIM_BSM_GRP_LEN
;
755 /* initialize rp count and total_rp_cnt before the rp loop */
757 total_rp_cnt
= grpinfo
->frag_rp_count
;
759 /* Loop till all RPs for the group parsed */
760 while (this_rp_cnt
< total_rp_cnt
) {
761 /* All RP from a group processed here.
762 * group is pointed by grpinfo.
763 * At this point make sure buf pointing to a RP
766 rp_fit_cnt
= this_pkt_rem
/ PIM_BSM_RP_LEN
;
768 /* calculate how many rp am i going to copy in
771 if (rp_fit_cnt
> (total_rp_cnt
- this_rp_cnt
))
772 frag_rp_cnt
= total_rp_cnt
- this_rp_cnt
;
774 frag_rp_cnt
= rp_fit_cnt
;
776 /* populate the frag rp count for the current grp */
777 curgrp
->frag_rp_count
= frag_rp_cnt
;
778 copy_byte_count
= frag_rp_cnt
* PIM_BSM_RP_LEN
;
780 /* copy all the rp that we are fitting in this
783 memcpy(pkt
, buf
, copy_byte_count
);
784 this_rp_cnt
+= frag_rp_cnt
;
785 buf
+= copy_byte_count
;
786 pkt
+= copy_byte_count
;
787 parsed_len
+= copy_byte_count
;
788 this_pkt_rem
-= copy_byte_count
;
790 /* Either we couldn't fit all rp for the group or the
793 if ((this_rp_cnt
< total_rp_cnt
)
795 < (PIM_BSM_GRP_LEN
+ PIM_BSM_RP_LEN
))) {
796 /* No space to fit in more rp, send this pkt */
797 this_pkt_len
= pim_mtu
- this_pkt_rem
;
798 pim_msg_build_header(pak_start
, this_pkt_len
,
799 PIM_MSG_TYPE_BOOTSTRAP
,
801 pim_bsm_send_intf(pak_start
, this_pkt_len
, ifp
,
804 /* Construct next fragment. Reuse old packet */
806 this_pkt_rem
= pim_mtu
- (PIM_BSM_HDR_LEN
807 + PIM_MSG_HEADER_LEN
);
809 /* If pkt can't accomodate next group + atleast
810 * one rp, we must break out of this inner loop
811 * and process next RP
813 if (total_rp_cnt
== this_rp_cnt
)
816 /* If some more RPs for the same group pending,
819 memcpy(pkt
, (uint8_t *)grpinfo
,
821 curgrp
= (struct bsmmsg_grpinfo
*)pkt
;
822 pkt
+= PIM_BSM_GRP_LEN
;
823 this_pkt_rem
-= PIM_BSM_GRP_LEN
;
826 /* We filled something but not yet sent out */
829 } /* while RP count */
830 } /*while parsed len */
832 /* Send if we have any unsent packet */
834 this_pkt_len
= pim_mtu
- this_pkt_rem
;
835 pim_msg_build_header(pak_start
, this_pkt_len
,
836 PIM_MSG_TYPE_BOOTSTRAP
, no_fwd
);
837 pim_bsm_send_intf(pak_start
, (pim_mtu
- this_pkt_rem
), ifp
,
840 XFREE(MTYPE_PIM_BSM_PKT_VAR_MEM
, pak_start
);
844 static void pim_bsm_fwd_whole_sz(struct pim_instance
*pim
, uint8_t *buf
,
845 uint32_t len
, int sz
)
847 struct interface
*ifp
;
848 struct pim_interface
*pim_ifp
;
849 struct in_addr dst_addr
;
854 /* For now only global scope zone is supported, so send on all
855 * pim interfaces in the vrf
857 dst_addr
= qpim_all_pim_routers_addr
;
858 FOR_ALL_INTERFACES (pim
->vrf
, ifp
) {
860 if ((!pim_ifp
) || (!pim_ifp
->bsm_enable
))
865 * When a Bootstrap message is forwarded, it is forwarded out
866 * of every multicast-capable interface that has PIM neighbors.
868 * So skipping pim interfaces with no neighbors.
870 if (listcount(pim_ifp
->pim_neighbor_list
) == 0)
873 pim_hello_require(ifp
);
874 pim_mtu
= ifp
->mtu
- MAX_IP_HDR_LEN
;
876 ret
= pim_bsm_frag_send(buf
, len
, ifp
, pim_mtu
,
879 zlog_debug("%s: pim_bsm_frag_send returned %s",
880 __func__
, ret
? "TRUE" : "FALSE");
882 pim_msg_build_header(buf
, len
, PIM_MSG_TYPE_BOOTSTRAP
,
884 if (!pim_bsm_send_intf(buf
, len
, ifp
, dst_addr
)) {
887 "%s: pim_bsm_send_intf returned false",
894 bool pim_bsm_new_nbr_fwd(struct pim_neighbor
*neigh
, struct interface
*ifp
)
896 struct in_addr dst_addr
;
897 struct pim_interface
*pim_ifp
;
898 struct bsm_scope
*scope
;
899 struct listnode
*bsm_ln
;
900 struct bsm_info
*bsminfo
;
901 char neigh_src_str
[INET_ADDRSTRLEN
];
907 pim_inet4_dump("<src?>", neigh
->source_addr
, neigh_src_str
,
908 sizeof(neigh_src_str
));
909 zlog_debug("%s: New neighbor %s seen on %s", __func__
,
910 neigh_src_str
, ifp
->name
);
915 /* DR only forwards BSM packet */
916 if (pim_ifp
->pim_dr_addr
.s_addr
== pim_ifp
->primary_address
.s_addr
) {
919 "%s: It is not DR, so don't forward BSM packet",
923 if (!pim_ifp
->bsm_enable
) {
925 zlog_debug("%s: BSM proc not enabled on %s", __func__
,
930 scope
= &pim_ifp
->pim
->global_scope
;
932 if (!scope
->bsm_list
->count
) {
934 zlog_debug("%s: BSM list for the scope is empty",
939 if (!pim_ifp
->ucast_bsm_accept
) {
940 dst_addr
= qpim_all_pim_routers_addr
;
942 zlog_debug("%s: Sending BSM mcast to %s", __func__
,
945 dst_addr
= neigh
->source_addr
;
947 zlog_debug("%s: Sending BSM ucast to %s", __func__
,
950 pim_mtu
= ifp
->mtu
- MAX_IP_HDR_LEN
;
951 pim_hello_require(ifp
);
953 for (ALL_LIST_ELEMENTS_RO(scope
->bsm_list
, bsm_ln
, bsminfo
)) {
954 if (pim_mtu
< bsminfo
->size
) {
955 ret
= pim_bsm_frag_send(bsminfo
->bsm
, bsminfo
->size
,
956 ifp
, pim_mtu
, dst_addr
, no_fwd
);
960 "%s: pim_bsm_frag_send failed",
964 /* Pim header needs to be constructed */
965 pim_msg_build_header(bsminfo
->bsm
, bsminfo
->size
,
966 PIM_MSG_TYPE_BOOTSTRAP
, no_fwd
);
967 ret
= pim_bsm_send_intf(bsminfo
->bsm
, bsminfo
->size
,
972 "%s: pim_bsm_frag_send failed",
980 struct bsgrp_node
*pim_bsm_get_bsgrp_node(struct bsm_scope
*scope
,
983 struct route_node
*rn
;
984 struct bsgrp_node
*bsgrp
;
986 rn
= route_node_lookup(scope
->bsrp_table
, grp
);
989 zlog_debug("%s: Route node doesn't exist for the group",
994 route_unlock_node(rn
);
999 static uint32_t hash_calc_on_grp_rp(struct prefix group
, struct in_addr rp
,
1000 uint8_t hashmasklen
)
1006 uint32_t mask
= 0xffffffff;
1008 /* mask to be made zero if hashmasklen is 0 because mask << 32
1009 * may not give 0. hashmasklen can be 0 to 32.
1011 if (hashmasklen
== 0)
1014 /* in_addr stores ip in big endian, hence network byte order
1015 * convert to uint32 before processing hash
1017 grpaddr
= ntohl(group
.u
.prefix4
.s_addr
);
1018 /* Avoid shifting by 32 bit on a 32 bit register */
1020 grpaddr
= grpaddr
& ((mask
<< (32 - hashmasklen
)));
1022 grpaddr
= grpaddr
& mask
;
1023 rp_add
= ntohl(rp
.s_addr
);
1024 temp
= 1103515245 * ((1103515245 * (uint64_t)grpaddr
+ 12345) ^ rp_add
)
1026 hash
= temp
& (0x7fffffff);
1030 static bool pim_install_bsm_grp_rp(struct pim_instance
*pim
,
1031 struct bsgrp_node
*grpnode
,
1032 struct bsmmsg_rpinfo
*rp
)
1034 struct bsm_rpinfo
*bsm_rpinfo
;
1035 uint8_t hashMask_len
= pim
->global_scope
.hashMasklen
;
1037 /*memory allocation for bsm_rpinfo */
1038 bsm_rpinfo
= XCALLOC(MTYPE_PIM_BSRP_NODE
, sizeof(*bsm_rpinfo
));
1040 bsm_rpinfo
->rp_prio
= rp
->rp_pri
;
1041 bsm_rpinfo
->rp_holdtime
= rp
->rp_holdtime
;
1042 memcpy(&bsm_rpinfo
->rp_address
, &rp
->rpaddr
.addr
,
1043 sizeof(struct in_addr
));
1044 bsm_rpinfo
->elapse_time
= 0;
1046 /* Back pointer to the group node. */
1047 bsm_rpinfo
->bsgrp_node
= grpnode
;
1049 /* update hash for this rp node */
1050 bsm_rpinfo
->hash
= hash_calc_on_grp_rp(grpnode
->group
, rp
->rpaddr
.addr
,
1052 if (listnode_add_sort_nodup(grpnode
->partial_bsrp_list
, bsm_rpinfo
)) {
1055 "%s, bs_rpinfo node added to the partial bs_rplist.",
1061 zlog_debug("%s: list node not added", __func__
);
1063 XFREE(MTYPE_PIM_BSRP_NODE
, bsm_rpinfo
);
1067 static void pim_update_pending_rp_cnt(struct bsm_scope
*sz
,
1068 struct bsgrp_node
*bsgrp
,
1069 uint16_t bsm_frag_tag
,
1070 uint32_t total_rp_count
)
1072 if (bsgrp
->pend_rp_cnt
) {
1073 /* received bsm is different packet ,
1074 * it is not same fragment.
1076 if (bsm_frag_tag
!= bsgrp
->frag_tag
) {
1079 "%s,Received a new BSM ,so clear the pending bs_rpinfo list.",
1081 list_delete_all_node(bsgrp
->partial_bsrp_list
);
1082 bsgrp
->pend_rp_cnt
= total_rp_count
;
1085 bsgrp
->pend_rp_cnt
= total_rp_count
;
1087 bsgrp
->frag_tag
= bsm_frag_tag
;
1090 /* Parsing BSR packet and adding to partial list of corresponding bsgrp node */
1091 static bool pim_bsm_parse_install_g2rp(struct bsm_scope
*scope
, uint8_t *buf
,
1092 int buflen
, uint16_t bsm_frag_tag
)
1094 struct bsmmsg_grpinfo grpinfo
;
1095 struct bsmmsg_rpinfo rpinfo
;
1096 struct prefix group
;
1097 struct bsgrp_node
*bsgrp
= NULL
;
1098 int frag_rp_cnt
= 0;
1102 while (buflen
> offset
) {
1103 if (offset
+ (int)sizeof(struct bsmmsg_grpinfo
) > buflen
) {
1106 "%s: buflen received %d is less than the internal data structure of the packet would suggest",
1110 /* Extract Group tlv from BSM */
1111 memcpy(&grpinfo
, buf
, sizeof(struct bsmmsg_grpinfo
));
1113 if (PIM_DEBUG_BSM
) {
1114 char grp_str
[INET_ADDRSTRLEN
];
1116 pim_inet4_dump("<Group?>", grpinfo
.group
.addr
, grp_str
,
1119 "%s, Group %s Rpcount:%d Fragment-Rp-count:%d",
1120 __func__
, grp_str
, grpinfo
.rp_count
,
1121 grpinfo
.frag_rp_count
);
1124 buf
+= sizeof(struct bsmmsg_grpinfo
);
1125 offset
+= sizeof(struct bsmmsg_grpinfo
);
1127 if (grpinfo
.rp_count
== 0) {
1128 if (PIM_DEBUG_BSM
) {
1129 char grp_str
[INET_ADDRSTRLEN
];
1131 pim_inet4_dump("<Group?>", grpinfo
.group
.addr
,
1132 grp_str
, sizeof(grp_str
));
1133 zlog_debug("%s, Rp count is zero for group: %s",
1139 group
.family
= AF_INET
;
1140 if (grpinfo
.group
.mask
> IPV4_MAX_BITLEN
) {
1143 "%s, v4 prefix length specified: %d is too long",
1144 __func__
, grpinfo
.group
.mask
);
1147 group
.prefixlen
= grpinfo
.group
.mask
;
1148 group
.u
.prefix4
.s_addr
= grpinfo
.group
.addr
.s_addr
;
1150 /* Get the Group node for the BSM rp table */
1151 bsgrp
= pim_bsm_get_bsgrp_node(scope
, &group
);
1155 zlog_debug("%s, Create new BSM Group node.",
1158 /* create a new node to be added to the tree. */
1159 bsgrp
= pim_bsm_new_bsgrp_node(scope
->bsrp_table
,
1164 "%s, Failed to get the BSM group node.",
1169 bsgrp
->scope
= scope
;
1172 pim_update_pending_rp_cnt(scope
, bsgrp
, bsm_frag_tag
,
1174 frag_rp_cnt
= grpinfo
.frag_rp_count
;
1177 while (frag_rp_cnt
--) {
1178 if (offset
+ (int)sizeof(struct bsmmsg_rpinfo
)
1182 "%s, buflen received: %u is less than the internal data structure of the packet would suggest",
1187 /* Extract RP address tlv from BSM */
1188 memcpy(&rpinfo
, buf
, sizeof(struct bsmmsg_rpinfo
));
1189 rpinfo
.rp_holdtime
= ntohs(rpinfo
.rp_holdtime
);
1190 buf
+= sizeof(struct bsmmsg_rpinfo
);
1191 offset
+= sizeof(struct bsmmsg_rpinfo
);
1193 if (PIM_DEBUG_BSM
) {
1194 char rp_str
[INET_ADDRSTRLEN
];
1196 pim_inet4_dump("<Rpaddr?>", rpinfo
.rpaddr
.addr
,
1197 rp_str
, sizeof(rp_str
));
1199 "%s, Rp address - %s; pri:%d hold:%d",
1200 __func__
, rp_str
, rpinfo
.rp_pri
,
1201 rpinfo
.rp_holdtime
);
1204 /* Call Install api to update grp-rp mappings */
1205 if (pim_install_bsm_grp_rp(scope
->pim
, bsgrp
, &rpinfo
))
1209 bsgrp
->pend_rp_cnt
-= ins_count
;
1211 if (!bsgrp
->pend_rp_cnt
) {
1214 "%s, Recvd all the rps for this group, so bsrp list with penidng rp list.",
1216 /* replace the bsrp_list with pending list */
1217 pim_instate_pend_list(bsgrp
);
1223 int pim_bsm_process(struct interface
*ifp
, struct ip
*ip_hdr
, uint8_t *buf
,
1224 uint32_t buf_size
, bool no_fwd
)
1226 struct bsm_hdr
*bshdr
;
1227 int sz
= PIM_GBL_SZ_ID
;
1228 struct bsmmsg_grpinfo
*msg_grp
;
1229 struct pim_interface
*pim_ifp
= NULL
;
1230 struct bsm_info
*bsminfo
;
1231 struct pim_instance
*pim
;
1232 char bsr_str
[INET_ADDRSTRLEN
];
1234 bool empty_bsm
= false;
1236 /* BSM Packet acceptance validation */
1237 pim_ifp
= ifp
->info
;
1240 zlog_debug("%s: multicast not enabled on interface %s",
1241 __func__
, ifp
->name
);
1245 pim_ifp
->pim_ifstat_bsm_rx
++;
1249 /* Drop if bsm processing is disabled on interface */
1250 if (!pim_ifp
->bsm_enable
) {
1251 zlog_warn("%s: BSM not enabled on interface %s", __func__
,
1253 pim_ifp
->pim_ifstat_bsm_cfg_miss
++;
1258 if (buf_size
< (PIM_MSG_HEADER_LEN
+ sizeof(struct bsm_hdr
))) {
1261 "%s: received buffer length of %d which is too small to properly decode",
1262 __func__
, buf_size
);
1266 bshdr
= (struct bsm_hdr
*)(buf
+ PIM_MSG_HEADER_LEN
);
1267 pim_inet4_dump("<bsr?>", bshdr
->bsr_addr
.addr
, bsr_str
,
1269 if (bshdr
->hm_len
> 32) {
1270 zlog_warn("Bad hashmask length for IPv4; got %hhu, expected value in range 0-32",
1275 pim
->global_scope
.hashMasklen
= bshdr
->hm_len
;
1276 frag_tag
= ntohs(bshdr
->frag_tag
);
1278 /* Identify empty BSM */
1279 if ((buf_size
- PIM_BSM_HDR_LEN
- PIM_MSG_HEADER_LEN
) < PIM_BSM_GRP_LEN
)
1283 msg_grp
= (struct bsmmsg_grpinfo
*)(buf
+ PIM_MSG_HEADER_LEN
1285 /* Currently we don't support scope zoned BSM */
1286 if (msg_grp
->group
.sz
) {
1289 "%s : Administratively scoped range BSM received",
1291 pim_ifp
->pim_ifstat_bsm_invalid_sz
++;
1297 /* Drop if bsr is not preferred bsr */
1298 if (!is_preferred_bsr(pim
, bshdr
->bsr_addr
.addr
, bshdr
->bsr_prio
)) {
1300 zlog_debug("%s : Received a non-preferred BSM",
1307 /* only accept no-forward BSM if quick refresh on startup */
1308 if ((pim
->global_scope
.accept_nofwd_bsm
)
1309 || (frag_tag
== pim
->global_scope
.bsm_frag_tag
)) {
1310 pim
->global_scope
.accept_nofwd_bsm
= false;
1314 "%s : nofwd_bsm received on %s when accpt_nofwd_bsm false",
1317 pim_ifp
->pim_ifstat_ucast_bsm_cfg_miss
++;
1322 /* Mulicast BSM received */
1323 if (ip_hdr
->ip_dst
.s_addr
== qpim_all_pim_routers_addr
.s_addr
) {
1325 if (!pim_bsr_rpf_check(pim
, bshdr
->bsr_addr
.addr
,
1329 "%s : RPF check fail for BSR address %s",
1335 } else if (if_lookup_exact_address(&ip_hdr
->ip_dst
, AF_INET
,
1337 /* Unicast BSM received - if ucast bsm not enabled on
1338 * the interface, drop it
1340 if (!pim_ifp
->ucast_bsm_accept
) {
1343 "%s : Unicast BSM not enabled on interface %s",
1344 __func__
, ifp
->name
);
1345 pim_ifp
->pim_ifstat_ucast_bsm_cfg_miss
++;
1352 zlog_debug("%s : Invalid destination address",
1360 zlog_debug("%s : Empty Pref BSM received", __func__
);
1362 /* Parse Update bsm rp table and install/uninstall rp if required */
1363 if (!pim_bsm_parse_install_g2rp(
1364 &pim_ifp
->pim
->global_scope
,
1365 (buf
+ PIM_BSM_HDR_LEN
+ PIM_MSG_HEADER_LEN
),
1366 (buf_size
- PIM_BSM_HDR_LEN
- PIM_MSG_HEADER_LEN
),
1368 if (PIM_DEBUG_BSM
) {
1369 zlog_debug("%s, Parsing BSM failed.", __func__
);
1374 /* Restart the bootstrap timer */
1375 pim_bs_timer_restart(&pim_ifp
->pim
->global_scope
,
1376 PIM_BSR_DEFAULT_TIMEOUT
);
1378 /* If new BSM received, clear the old bsm database */
1379 if (pim_ifp
->pim
->global_scope
.bsm_frag_tag
!= frag_tag
) {
1380 if (PIM_DEBUG_BSM
) {
1381 zlog_debug("%s: Current frag tag: %d Frag teg rcvd: %d",
1383 pim_ifp
->pim
->global_scope
.bsm_frag_tag
,
1386 list_delete_all_node(pim_ifp
->pim
->global_scope
.bsm_list
);
1387 pim_ifp
->pim
->global_scope
.bsm_frag_tag
= frag_tag
;
1390 /* update the scope information from bsm */
1391 pim_bsm_update(pim
, bshdr
->bsr_addr
.addr
, bshdr
->bsr_prio
);
1394 pim_bsm_fwd_whole_sz(pim_ifp
->pim
, buf
, buf_size
, sz
);
1395 bsminfo
= XCALLOC(MTYPE_PIM_BSM_INFO
, sizeof(struct bsm_info
));
1397 bsminfo
->bsm
= XCALLOC(MTYPE_PIM_BSM_PKT_VAR_MEM
, buf_size
);
1399 bsminfo
->size
= buf_size
;
1400 memcpy(bsminfo
->bsm
, buf
, buf_size
);
1401 listnode_add(pim_ifp
->pim
->global_scope
.bsm_list
, bsminfo
);