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
)
90 XFREE(MTYPE_PIM_BSM_PKT_VAR_MEM
, bsm
->bsm
);
91 XFREE(MTYPE_PIM_BSM_INFO
, bsm
);
94 static int pim_g2rp_list_compare(struct bsm_rpinfo
*node1
,
95 struct bsm_rpinfo
*node2
)
98 * Step-1 : Loweset Rp priority will have higher precedance.
99 * Step-2 : If priority same then higher hash val will have
101 * Step-3 : If Hash val is same then highest rp address will
104 if (node1
->rp_prio
< node2
->rp_prio
)
106 if (node1
->rp_prio
> node2
->rp_prio
)
108 if (node1
->hash
< node2
->hash
)
110 if (node1
->hash
> node2
->hash
)
112 if (node1
->rp_address
.s_addr
< node2
->rp_address
.s_addr
)
114 if (node1
->rp_address
.s_addr
> node2
->rp_address
.s_addr
)
119 static void pim_free_bsrp_node(struct bsm_rpinfo
*bsrp_info
)
121 if (bsrp_info
->g2rp_timer
)
122 THREAD_OFF(bsrp_info
->g2rp_timer
);
123 XFREE(MTYPE_PIM_BSRP_NODE
, bsrp_info
);
126 static struct list
*pim_alloc_bsrp_list(void)
128 struct list
*new_list
= NULL
;
130 new_list
= list_new();
135 new_list
->cmp
= (int (*)(void *, void *))pim_g2rp_list_compare
;
136 new_list
->del
= (void (*)(void *))pim_free_bsrp_node
;
141 static struct bsgrp_node
*pim_bsm_new_bsgrp_node(struct route_table
*rt
,
144 struct route_node
*rn
;
145 struct bsgrp_node
*bsgrp
;
147 rn
= route_node_get(rt
, grp
);
149 zlog_warn("%s: route node creation failed",
150 __PRETTY_FUNCTION__
);
153 bsgrp
= XCALLOC(MTYPE_PIM_BSGRP_NODE
, sizeof(struct bsgrp_node
));
156 bsgrp
->bsrp_list
= pim_alloc_bsrp_list();
157 bsgrp
->partial_bsrp_list
= pim_alloc_bsrp_list();
159 if ((!bsgrp
->bsrp_list
) || (!bsgrp
->partial_bsrp_list
)) {
160 route_unlock_node(rn
);
161 pim_free_bsgrp_data(bsgrp
);
165 prefix_copy(&bsgrp
->group
, grp
);
169 static int pim_on_bs_timer(struct thread
*t
)
171 struct route_node
*rn
;
172 struct bsm_scope
*scope
;
173 struct bsgrp_node
*bsgrp_node
;
174 struct bsm_rpinfo
*bsrp
;
176 char buf
[PREFIX2STR_BUFFER
];
177 bool is_bsr_tracking
= true;
179 scope
= THREAD_ARG(t
);
180 THREAD_OFF(scope
->bs_timer
);
183 zlog_debug("%s: Bootstrap Timer expired for scope: %d",
184 __PRETTY_FUNCTION__
, scope
->sz_id
);
186 /* Remove next hop tracking for the bsr */
187 nht_p
.family
= AF_INET
;
188 nht_p
.prefixlen
= IPV4_MAX_BITLEN
;
189 nht_p
.u
.prefix4
= scope
->current_bsr
;
191 prefix2str(&nht_p
, buf
, sizeof(buf
));
192 zlog_debug("%s: Deregister BSR addr %s with Zebra NHT",
193 __PRETTY_FUNCTION__
, buf
);
195 pim_delete_tracked_nexthop(scope
->pim
, &nht_p
, NULL
, NULL
,
198 /* Reset scope zone data */
199 scope
->accept_nofwd_bsm
= false;
200 scope
->state
= ACCEPT_ANY
;
201 scope
->current_bsr
.s_addr
= INADDR_ANY
;
202 scope
->current_bsr_prio
= 0;
203 scope
->current_bsr_first_ts
= 0;
204 scope
->current_bsr_last_ts
= 0;
205 scope
->bsm_frag_tag
= 0;
206 list_delete_all_node(scope
->bsm_list
);
208 for (rn
= route_top(scope
->bsrp_table
); rn
; rn
= route_next(rn
)) {
210 bsgrp_node
= (struct bsgrp_node
*)rn
->info
;
213 zlog_debug("%s: bsgrp_node is null",
214 __PRETTY_FUNCTION__
);
217 /* Give grace time for rp to continue for another hold time */
218 if ((bsgrp_node
->bsrp_list
) && (bsgrp_node
->bsrp_list
->count
)) {
219 bsrp
= listnode_head(bsgrp_node
->bsrp_list
);
220 pim_g2rp_timer_restart(bsrp
, bsrp
->rp_holdtime
);
222 /* clear pending list */
223 if ((bsgrp_node
->partial_bsrp_list
)
224 && (bsgrp_node
->partial_bsrp_list
->count
)) {
225 list_delete_all_node(bsgrp_node
->partial_bsrp_list
);
226 bsgrp_node
->pend_rp_cnt
= 0;
232 static void pim_bs_timer_stop(struct bsm_scope
*scope
)
235 zlog_debug("%s : BS timer being stopped of sz: %d",
236 __PRETTY_FUNCTION__
, scope
->sz_id
);
237 THREAD_OFF(scope
->bs_timer
);
240 static void pim_bs_timer_start(struct bsm_scope
*scope
, int bs_timeout
)
244 zlog_debug("%s : Invalid scope(NULL).",
245 __PRETTY_FUNCTION__
);
248 THREAD_OFF(scope
->bs_timer
);
250 zlog_debug("%s : starting bs timer for scope %d with timeout %d secs",
251 __PRETTY_FUNCTION__
, scope
->sz_id
, bs_timeout
);
252 thread_add_timer(router
->master
, pim_on_bs_timer
, scope
, bs_timeout
,
256 static inline void pim_bs_timer_restart(struct bsm_scope
*scope
, int bs_timeout
)
258 pim_bs_timer_start(scope
, bs_timeout
);
261 void pim_bsm_proc_init(struct pim_instance
*pim
)
263 memset(&pim
->global_scope
, 0, sizeof(struct bsm_scope
));
265 pim
->global_scope
.sz_id
= PIM_GBL_SZ_ID
;
266 pim
->global_scope
.bsrp_table
= route_table_init();
267 pim
->global_scope
.accept_nofwd_bsm
= true;
268 pim
->global_scope
.state
= NO_INFO
;
269 pim
->global_scope
.pim
= pim
;
270 pim
->global_scope
.bsm_list
= list_new();
271 pim
->global_scope
.bsm_list
->del
= (void (*)(void *))pim_bsm_node_free
;
272 pim_bs_timer_start(&pim
->global_scope
, PIM_BS_TIME
);
275 void pim_bsm_proc_free(struct pim_instance
*pim
)
277 struct route_node
*rn
;
278 struct bsgrp_node
*bsgrp
;
280 pim_bs_timer_stop(&pim
->global_scope
);
282 if (pim
->global_scope
.bsm_list
)
283 list_delete(&pim
->global_scope
.bsm_list
);
285 for (rn
= route_top(pim
->global_scope
.bsrp_table
); rn
;
286 rn
= route_next(rn
)) {
290 pim_free_bsgrp_data(bsgrp
);
293 if (pim
->global_scope
.bsrp_table
)
294 route_table_finish(pim
->global_scope
.bsrp_table
);
297 static bool is_hold_time_elapsed(void *data
)
299 struct bsm_rpinfo
*bsrp
;
303 if (bsrp
->elapse_time
< bsrp
->rp_holdtime
)
309 static int pim_on_g2rp_timer(struct thread
*t
)
311 struct bsm_rpinfo
*bsrp
;
312 struct bsm_rpinfo
*bsrp_node
;
313 struct bsgrp_node
*bsgrp_node
;
314 struct listnode
*bsrp_ln
;
315 struct pim_instance
*pim
;
316 struct rp_info
*rp_info
;
317 struct route_node
*rn
;
319 struct in_addr bsrp_addr
;
321 bsrp
= THREAD_ARG(t
);
322 THREAD_OFF(bsrp
->g2rp_timer
);
323 bsgrp_node
= bsrp
->bsgrp_node
;
325 /* elapse time is the hold time of expired node */
326 elapse
= bsrp
->rp_holdtime
;
327 bsrp_addr
= bsrp
->rp_address
;
329 /* update elapse for all bsrp nodes */
330 for (ALL_LIST_ELEMENTS_RO(bsgrp_node
->bsrp_list
, bsrp_ln
, bsrp_node
))
331 bsrp_node
->elapse_time
+= elapse
;
333 /* remove the expired nodes from the list */
334 list_filter_out_nodes(bsgrp_node
->bsrp_list
, is_hold_time_elapsed
);
336 /* Get the next elected rp node */
337 bsrp
= listnode_head(bsgrp_node
->bsrp_list
);
338 pim
= bsgrp_node
->scope
->pim
;
339 rn
= route_node_lookup(pim
->rp_table
, &bsgrp_node
->group
);
342 zlog_warn("%s: Route node doesn't exist", __PRETTY_FUNCTION__
);
346 rp_info
= (struct rp_info
*)rn
->info
;
349 route_unlock_node(rn
);
353 if (rp_info
->rp_src
!= RP_SRC_STATIC
) {
354 /* If new rp available, change it else delete the existing */
356 bsrp_addr
= bsrp
->rp_address
;
357 pim_g2rp_timer_start(
358 bsrp
, (bsrp
->rp_holdtime
- bsrp
->elapse_time
));
359 pim_rp_change(pim
, bsrp_addr
, bsgrp_node
->group
,
362 pim_rp_del(pim
, bsrp_addr
, bsgrp_node
->group
, NULL
,
367 if ((!bsgrp_node
->bsrp_list
->count
)
368 && (!bsgrp_node
->partial_bsrp_list
->count
)) {
369 pim_free_bsgrp_node(pim
->global_scope
.bsrp_table
,
371 pim_free_bsgrp_data(bsgrp_node
);
377 static void pim_g2rp_timer_start(struct bsm_rpinfo
*bsrp
, int hold_time
)
381 zlog_debug("%s : Invalid brsp(NULL).",
382 __PRETTY_FUNCTION__
);
385 THREAD_OFF(bsrp
->g2rp_timer
);
390 "%s : starting g2rp timer for grp: %s - rp: %s with timeout %d secs(Actual Hold time : %d secs)",
392 prefix2str(&bsrp
->bsgrp_node
->group
, buf
, 48),
393 inet_ntoa(bsrp
->rp_address
), hold_time
,
397 thread_add_timer(router
->master
, pim_on_g2rp_timer
, bsrp
, hold_time
,
401 static inline void pim_g2rp_timer_restart(struct bsm_rpinfo
*bsrp
,
404 pim_g2rp_timer_start(bsrp
, hold_time
);
407 static void pim_g2rp_timer_stop(struct bsm_rpinfo
*bsrp
)
415 zlog_debug("%s : stopping g2rp timer for grp: %s - rp: %s",
417 prefix2str(&bsrp
->bsgrp_node
->group
, buf
, 48),
418 inet_ntoa(bsrp
->rp_address
));
421 THREAD_OFF(bsrp
->g2rp_timer
);
424 static bool is_hold_time_zero(void *data
)
426 struct bsm_rpinfo
*bsrp
;
430 if (bsrp
->rp_holdtime
)
436 static void pim_instate_pend_list(struct bsgrp_node
*bsgrp_node
)
438 struct bsm_rpinfo
*active
;
439 struct bsm_rpinfo
*pend
;
441 struct rp_info
*rp_info
;
442 struct route_node
*rn
;
443 struct pim_instance
*pim
;
444 struct rp_info
*rp_all
;
445 struct prefix group_all
;
446 bool had_rp_node
= true;
448 pim
= bsgrp_node
->scope
->pim
;
449 active
= listnode_head(bsgrp_node
->bsrp_list
);
451 /* Remove nodes with hold time 0 & check if list still has a head */
452 list_filter_out_nodes(bsgrp_node
->partial_bsrp_list
, is_hold_time_zero
);
453 pend
= listnode_head(bsgrp_node
->partial_bsrp_list
);
455 if (!str2prefix("224.0.0.0/4", &group_all
))
458 rp_all
= pim_rp_find_match_group(pim
, &group_all
);
459 rn
= route_node_lookup(pim
->rp_table
, &bsgrp_node
->group
);
462 pim_g2rp_timer_start(pend
, pend
->rp_holdtime
);
464 /* if rp node doesn't exist or exist but not configured(rp_all),
465 * install the rp from head(if exists) of partial list. List is
466 * is sorted such that head is the elected RP for the group.
468 if (!rn
|| (prefix_same(&rp_all
->group
, &bsgrp_node
->group
)
469 && pim_rpf_addr_is_inaddr_none(&rp_all
->rp
))) {
471 zlog_debug("%s: Route node doesn't exist",
472 __PRETTY_FUNCTION__
);
474 pim_rp_new(pim
, pend
->rp_address
, bsgrp_node
->group
,
478 rp_info
= (struct rp_info
*)rn
->info
;
480 route_unlock_node(rn
);
482 pim_rp_new(pim
, pend
->rp_address
,
483 bsgrp_node
->group
, NULL
, RP_SRC_BSR
);
488 /* We didn't have rp node and pending list is empty(unlikely), cleanup*/
489 if ((!had_rp_node
) && (!pend
)) {
490 pim_free_bsgrp_node(bsgrp_node
->scope
->bsrp_table
,
492 pim_free_bsgrp_data(bsgrp_node
);
496 if ((had_rp_node
) && (rp_info
->rp_src
!= RP_SRC_STATIC
)) {
497 /* This means we searched and got rp node, needs unlock */
498 route_unlock_node(rn
);
500 if (active
&& pend
) {
501 if ((active
->rp_address
.s_addr
502 != pend
->rp_address
.s_addr
))
503 pim_rp_change(pim
, pend
->rp_address
,
504 bsgrp_node
->group
, RP_SRC_BSR
);
507 /* Possible when the first BSM has group with 0 rp count */
508 if ((!active
) && (!pend
)) {
511 "%s: Both bsrp and partial list are empty",
512 __PRETTY_FUNCTION__
);
514 pim_free_bsgrp_node(bsgrp_node
->scope
->bsrp_table
,
516 pim_free_bsgrp_data(bsgrp_node
);
520 /* Possible when a group with 0 rp count received in BSM */
521 if ((active
) && (!pend
)) {
522 pim_rp_del(pim
, active
->rp_address
, bsgrp_node
->group
,
524 pim_free_bsgrp_node(bsgrp_node
->scope
->bsrp_table
,
527 zlog_debug("%s:Pend List is null,del grp node",
528 __PRETTY_FUNCTION__
);
530 pim_free_bsgrp_data(bsgrp_node
);
535 if ((had_rp_node
) && (rp_info
->rp_src
== RP_SRC_STATIC
)) {
536 /* We need to unlock rn this case */
537 route_unlock_node(rn
);
538 /* there is a chance that static rp exist and bsrp cleaned
539 * so clean bsgrp node if pending list empty
544 "%s: Partial list is empty, static rp exists",
545 __PRETTY_FUNCTION__
);
546 pim_free_bsgrp_node(bsgrp_node
->scope
->bsrp_table
,
548 pim_free_bsgrp_data(bsgrp_node
);
553 /* swap the list & delete all nodes in partial list (old bsrp_list)
555 * active is head of bsrp list
556 * pend is head of partial list
558 * active is head of partial list
559 * pend is head of bsrp list
560 * So check appriate head after swap and clean the new partial list
562 temp
= bsgrp_node
->bsrp_list
;
563 bsgrp_node
->bsrp_list
= bsgrp_node
->partial_bsrp_list
;
564 bsgrp_node
->partial_bsrp_list
= temp
;
567 pim_g2rp_timer_stop(active
);
568 list_delete_all_node(bsgrp_node
->partial_bsrp_list
);
572 static bool pim_bsr_rpf_check(struct pim_instance
*pim
, struct in_addr bsr
,
573 struct in_addr ip_src_addr
)
575 struct pim_nexthop nexthop
;
578 memset(&nexthop
, 0, sizeof(nexthop
));
580 /* New BSR recived */
581 if (bsr
.s_addr
!= pim
->global_scope
.current_bsr
.s_addr
) {
582 result
= pim_nexthop_match(pim
, bsr
, ip_src_addr
);
584 /* Nexthop lookup pass for the new BSR address */
589 char bsr_str
[INET_ADDRSTRLEN
];
591 pim_inet4_dump("<bsr?>", bsr
, bsr_str
, sizeof(bsr_str
));
592 zlog_debug("%s : No route to BSR address %s",
593 __PRETTY_FUNCTION__
, bsr_str
);
598 return pim_nexthop_match_nht_cache(pim
, bsr
, ip_src_addr
);
601 static bool is_preferred_bsr(struct pim_instance
*pim
, struct in_addr bsr
,
604 if (bsr
.s_addr
== pim
->global_scope
.current_bsr
.s_addr
)
607 if (bsr_prio
> pim
->global_scope
.current_bsr_prio
)
610 else if (bsr_prio
== pim
->global_scope
.current_bsr_prio
) {
611 if (bsr
.s_addr
>= pim
->global_scope
.current_bsr
.s_addr
)
619 static void pim_bsm_update(struct pim_instance
*pim
, struct in_addr bsr
,
622 struct pim_nexthop_cache pnc
;
624 if (bsr
.s_addr
!= pim
->global_scope
.current_bsr
.s_addr
) {
626 char buf
[PREFIX2STR_BUFFER
];
627 bool is_bsr_tracking
= true;
629 /* De-register old BSR and register new BSR with Zebra NHT */
630 nht_p
.family
= AF_INET
;
631 nht_p
.prefixlen
= IPV4_MAX_BITLEN
;
633 if (pim
->global_scope
.current_bsr
.s_addr
!= INADDR_ANY
) {
634 nht_p
.u
.prefix4
= pim
->global_scope
.current_bsr
;
636 prefix2str(&nht_p
, buf
, sizeof(buf
));
638 "%s: Deregister BSR addr %s with Zebra NHT",
639 __PRETTY_FUNCTION__
, buf
);
641 pim_delete_tracked_nexthop(pim
, &nht_p
, NULL
, NULL
,
645 nht_p
.u
.prefix4
= bsr
;
647 prefix2str(&nht_p
, buf
, sizeof(buf
));
649 "%s: NHT Register BSR addr %s with Zebra NHT",
650 __PRETTY_FUNCTION__
, buf
);
653 memset(&pnc
, 0, sizeof(struct pim_nexthop_cache
));
654 pim_find_or_track_nexthop(pim
, &nht_p
, NULL
, NULL
,
655 is_bsr_tracking
, &pnc
);
656 pim
->global_scope
.current_bsr
= bsr
;
657 pim
->global_scope
.current_bsr_first_ts
=
658 pim_time_monotonic_sec();
659 pim
->global_scope
.state
= ACCEPT_PREFERRED
;
661 pim
->global_scope
.current_bsr_prio
= bsr_prio
;
662 pim
->global_scope
.current_bsr_last_ts
= pim_time_monotonic_sec();
665 static bool pim_bsm_send_intf(uint8_t *buf
, int len
, struct interface
*ifp
,
666 struct in_addr dst_addr
)
668 struct pim_interface
*pim_ifp
;
674 zlog_debug("%s: Pim interface not available for %s",
675 __PRETTY_FUNCTION__
, ifp
->name
);
679 if (pim_ifp
->pim_sock_fd
== -1) {
681 zlog_debug("%s: Pim sock not available for %s",
682 __PRETTY_FUNCTION__
, ifp
->name
);
686 pim_msg_send(pim_ifp
->pim_sock_fd
, pim_ifp
->primary_address
, dst_addr
,
687 buf
, len
, ifp
->name
);
688 pim_ifp
->pim_ifstat_bsm_tx
++;
689 pim_ifp
->pim
->bsm_sent
++;
693 static bool pim_bsm_frag_send(uint8_t *buf
, uint32_t len
, struct interface
*ifp
,
694 uint32_t pim_mtu
, struct in_addr dst_addr
,
697 struct bsmmsg_grpinfo
*grpinfo
, *curgrp
;
698 uint8_t *firstgrp_ptr
;
701 uint32_t parsed_len
= 0;
702 uint32_t this_pkt_rem
;
703 uint32_t copy_byte_count
;
704 uint32_t this_pkt_len
;
705 uint8_t total_rp_cnt
;
709 bool pak_pending
= false;
711 /* MTU passed here is PIM MTU (IP MTU less IP Hdr) */
712 if (pim_mtu
< (PIM_MIN_BSM_LEN
)) {
714 "%s: mtu(pim mtu: %d) size less than minimum bootsrap len",
715 __PRETTY_FUNCTION__
, pim_mtu
);
718 "%s: mtu (pim mtu:%d) less than minimum bootsrap len",
719 __PRETTY_FUNCTION__
, pim_mtu
);
723 pak_start
= XCALLOC(MTYPE_PIM_BSM_PKT_VAR_MEM
, pim_mtu
);
727 /* Fill PIM header later before sending packet to calc checksum */
728 pkt
+= PIM_MSG_HEADER_LEN
;
729 buf
+= PIM_MSG_HEADER_LEN
;
731 /* copy bsm header to new packet at offset of pim hdr */
732 memcpy(pkt
, buf
, PIM_BSM_HDR_LEN
);
733 pkt
+= PIM_BSM_HDR_LEN
;
734 buf
+= PIM_BSM_HDR_LEN
;
735 parsed_len
+= (PIM_MSG_HEADER_LEN
+ PIM_BSM_HDR_LEN
);
737 /* Store the position of first grp ptr, which can be reused for
738 * next packet to start filling group. old bsm header and pim hdr
739 * remains. So need not be filled again for next packet onwards.
743 /* we received mtu excluding IP hdr len as param
744 * now this_pkt_rem is mtu excluding
745 * PIM_BSM_HDR_LEN + PIM_MSG_HEADER_LEN
747 this_pkt_rem
= pim_mtu
- (PIM_BSM_HDR_LEN
+ PIM_MSG_HEADER_LEN
);
749 /* For each group till the packet length parsed */
750 while (parsed_len
< len
) {
751 /* pkt ---> fragment's current pointer
752 * buf ---> input buffer's current pointer
753 * mtu ---> size of the pim packet - PIM header
754 * curgrp ---> current group on the fragment
755 * grpinfo ---> current group on the input buffer
756 * this_pkt_rem ---> bytes remaing on the current fragment
757 * rp_fit_cnt ---> num of rp for current grp that
759 * total_rp_cnt ---> total rp present for the group in the buf
760 * frag_rp_cnt ---> no of rp for the group to be fit in
762 * this_rp_cnt ---> how many rp have we parsed
764 grpinfo
= (struct bsmmsg_grpinfo
*)buf
;
765 memcpy(pkt
, buf
, PIM_BSM_GRP_LEN
);
766 curgrp
= (struct bsmmsg_grpinfo
*)pkt
;
767 parsed_len
+= PIM_BSM_GRP_LEN
;
768 pkt
+= PIM_BSM_GRP_LEN
;
769 buf
+= PIM_BSM_GRP_LEN
;
770 this_pkt_rem
-= PIM_BSM_GRP_LEN
;
772 /* initialize rp count and total_rp_cnt before the rp loop */
774 total_rp_cnt
= grpinfo
->frag_rp_count
;
776 /* Loop till all RPs for the group parsed */
777 while (this_rp_cnt
< total_rp_cnt
) {
778 /* All RP from a group processed here.
779 * group is pointed by grpinfo.
780 * At this point make sure buf pointing to a RP
783 rp_fit_cnt
= this_pkt_rem
/ PIM_BSM_RP_LEN
;
785 /* calculate how many rp am i going to copy in
788 if (rp_fit_cnt
> (total_rp_cnt
- this_rp_cnt
))
789 frag_rp_cnt
= total_rp_cnt
- this_rp_cnt
;
791 frag_rp_cnt
= rp_fit_cnt
;
793 /* populate the frag rp count for the current grp */
794 curgrp
->frag_rp_count
= frag_rp_cnt
;
795 copy_byte_count
= frag_rp_cnt
* PIM_BSM_RP_LEN
;
797 /* copy all the rp that we are fitting in this
800 memcpy(pkt
, buf
, copy_byte_count
);
801 this_rp_cnt
+= frag_rp_cnt
;
802 buf
+= copy_byte_count
;
803 pkt
+= copy_byte_count
;
804 parsed_len
+= copy_byte_count
;
805 this_pkt_rem
-= copy_byte_count
;
807 /* Either we couldn't fit all rp for the group or the
810 if ((this_rp_cnt
< total_rp_cnt
)
812 < (PIM_BSM_GRP_LEN
+ PIM_BSM_RP_LEN
))) {
813 /* No space to fit in more rp, send this pkt */
814 this_pkt_len
= pim_mtu
- this_pkt_rem
;
815 pim_msg_build_header(pak_start
, this_pkt_len
,
816 PIM_MSG_TYPE_BOOTSTRAP
,
818 pim_bsm_send_intf(pak_start
, this_pkt_len
, ifp
,
821 /* Construct next fragment. Reuse old packet */
823 this_pkt_rem
= pim_mtu
- (PIM_BSM_HDR_LEN
824 + PIM_MSG_HEADER_LEN
);
826 /* If pkt can't accomodate next group + atleast
827 * one rp, we must break out of this inner loop
828 * and process next RP
830 if (total_rp_cnt
== this_rp_cnt
)
833 /* If some more RPs for the same group pending,
836 memcpy(pkt
, (uint8_t *)grpinfo
,
838 curgrp
= (struct bsmmsg_grpinfo
*)pkt
;
839 pkt
+= PIM_BSM_GRP_LEN
;
840 this_pkt_rem
-= PIM_BSM_GRP_LEN
;
843 /* We filled something but not yet sent out */
846 } /* while RP count */
847 } /*while parsed len */
849 /* Send if we have any unsent packet */
851 this_pkt_len
= pim_mtu
- this_pkt_rem
;
852 pim_msg_build_header(pak_start
, this_pkt_len
,
853 PIM_MSG_TYPE_BOOTSTRAP
, no_fwd
);
854 pim_bsm_send_intf(pak_start
, (pim_mtu
- this_pkt_rem
), ifp
,
857 XFREE(MTYPE_PIM_BSM_PKT_VAR_MEM
, pak_start
);
861 static void pim_bsm_fwd_whole_sz(struct pim_instance
*pim
, uint8_t *buf
,
862 uint32_t len
, int sz
)
864 struct interface
*ifp
;
865 struct pim_interface
*pim_ifp
;
866 struct in_addr dst_addr
;
871 /* For now only global scope zone is supported, so send on all
872 * pim interfaces in the vrf
874 dst_addr
= qpim_all_pim_routers_addr
;
875 FOR_ALL_INTERFACES (pim
->vrf
, ifp
) {
877 if ((!pim_ifp
) || (!pim_ifp
->bsm_enable
))
879 pim_hello_require(ifp
);
880 pim_mtu
= ifp
->mtu
- MAX_IP_HDR_LEN
;
882 ret
= pim_bsm_frag_send(buf
, len
, ifp
, pim_mtu
,
885 zlog_debug("%s: pim_bsm_frag_send returned %s",
887 ret
? "TRUE" : "FALSE");
889 pim_msg_build_header(buf
, len
, PIM_MSG_TYPE_BOOTSTRAP
,
891 if (!pim_bsm_send_intf(buf
, len
, ifp
, dst_addr
)) {
894 "%s: pim_bsm_send_intf returned FALSE",
895 __PRETTY_FUNCTION__
);
901 bool pim_bsm_new_nbr_fwd(struct pim_neighbor
*neigh
, struct interface
*ifp
)
903 struct in_addr dst_addr
;
904 struct pim_interface
*pim_ifp
;
905 struct bsm_scope
*scope
;
906 struct listnode
*bsm_ln
;
907 struct bsm_info
*bsminfo
;
908 char neigh_src_str
[INET_ADDRSTRLEN
];
914 pim_inet4_dump("<src?>", neigh
->source_addr
, neigh_src_str
,
915 sizeof(neigh_src_str
));
916 zlog_debug("%s: New neighbor %s seen on %s",
917 __PRETTY_FUNCTION__
, neigh_src_str
, ifp
->name
);
922 /* DR only forwards BSM packet */
923 if (pim_ifp
->pim_dr_addr
.s_addr
== pim_ifp
->primary_address
.s_addr
) {
926 "%s: It is not DR, so don't forward BSM packet",
927 __PRETTY_FUNCTION__
);
930 if (!pim_ifp
->bsm_enable
) {
932 zlog_debug("%s: BSM proc not enabled on %s",
933 __PRETTY_FUNCTION__
, ifp
->name
);
937 scope
= &pim_ifp
->pim
->global_scope
;
939 if (!scope
->bsm_list
->count
) {
941 zlog_debug("%s: BSM list for the scope is empty",
942 __PRETTY_FUNCTION__
);
946 if (!pim_ifp
->ucast_bsm_accept
) {
947 dst_addr
= qpim_all_pim_routers_addr
;
949 zlog_debug("%s: Sending BSM mcast to %s",
950 __PRETTY_FUNCTION__
, neigh_src_str
);
952 dst_addr
= neigh
->source_addr
;
954 zlog_debug("%s: Sending BSM ucast to %s",
955 __PRETTY_FUNCTION__
, neigh_src_str
);
957 pim_mtu
= ifp
->mtu
- MAX_IP_HDR_LEN
;
958 pim_hello_require(ifp
);
960 for (ALL_LIST_ELEMENTS_RO(scope
->bsm_list
, bsm_ln
, bsminfo
)) {
961 if (pim_mtu
< bsminfo
->size
) {
962 ret
= pim_bsm_frag_send(bsminfo
->bsm
, bsminfo
->size
,
963 ifp
, pim_mtu
, dst_addr
, no_fwd
);
967 "%s: pim_bsm_frag_send failed",
968 __PRETTY_FUNCTION__
);
971 /* Pim header needs to be constructed */
972 pim_msg_build_header(bsminfo
->bsm
, bsminfo
->size
,
973 PIM_MSG_TYPE_BOOTSTRAP
, no_fwd
);
974 ret
= pim_bsm_send_intf(bsminfo
->bsm
, bsminfo
->size
,
979 "%s: pim_bsm_frag_send failed",
980 __PRETTY_FUNCTION__
);
987 struct bsgrp_node
*pim_bsm_get_bsgrp_node(struct bsm_scope
*scope
,
990 struct route_node
*rn
;
991 struct bsgrp_node
*bsgrp
;
993 rn
= route_node_lookup(scope
->bsrp_table
, grp
);
996 zlog_debug("%s: Route node doesn't exist for the group",
997 __PRETTY_FUNCTION__
);
1001 route_unlock_node(rn
);
1006 static uint32_t hash_calc_on_grp_rp(struct prefix group
, struct in_addr rp
,
1007 uint8_t hashmasklen
)
1013 uint32_t mask
= 0xffffffff;
1015 /* mask to be made zero if hashmasklen is 0 because mask << 32
1016 * may not give 0. hashmasklen can be 0 to 32.
1018 if (hashmasklen
== 0)
1021 /* in_addr stores ip in big endian, hence network byte order
1022 * convert to uint32 before processing hash
1024 grpaddr
= ntohl(group
.u
.prefix4
.s_addr
);
1025 /* Avoid shifting by 32 bit on a 32 bit register */
1027 grpaddr
= grpaddr
& ((mask
<< (32 - hashmasklen
)));
1029 grpaddr
= grpaddr
& mask
;
1030 rp_add
= ntohl(rp
.s_addr
);
1031 temp
= 1103515245 * ((1103515245 * grpaddr
+ 12345) ^ rp_add
) + 12345;
1032 hash
= temp
& (0x7fffffff);
1036 static bool pim_install_bsm_grp_rp(struct pim_instance
*pim
,
1037 struct bsgrp_node
*grpnode
,
1038 struct bsmmsg_rpinfo
*rp
)
1040 struct bsm_rpinfo
*bsm_rpinfo
;
1041 uint8_t hashMask_len
= pim
->global_scope
.hashMasklen
;
1043 /*memory allocation for bsm_rpinfo */
1044 bsm_rpinfo
= XCALLOC(MTYPE_PIM_BSRP_NODE
, sizeof(*bsm_rpinfo
));
1046 bsm_rpinfo
->rp_prio
= rp
->rp_pri
;
1047 bsm_rpinfo
->rp_holdtime
= rp
->rp_holdtime
;
1048 memcpy(&bsm_rpinfo
->rp_address
, &rp
->rpaddr
.addr
,
1049 sizeof(struct in_addr
));
1050 bsm_rpinfo
->elapse_time
= 0;
1052 /* Back pointer to the group node. */
1053 bsm_rpinfo
->bsgrp_node
= grpnode
;
1055 /* update hash for this rp node */
1056 bsm_rpinfo
->hash
= hash_calc_on_grp_rp(grpnode
->group
, rp
->rpaddr
.addr
,
1058 if (listnode_add_sort_nodup(grpnode
->partial_bsrp_list
, bsm_rpinfo
)) {
1061 "%s, bs_rpinfo node added to the partial bs_rplist.\r\n",
1062 __PRETTY_FUNCTION__
);
1067 zlog_debug("%s: list node not added\n", __PRETTY_FUNCTION__
);
1069 XFREE(MTYPE_PIM_BSRP_NODE
, bsm_rpinfo
);
1073 static void pim_update_pending_rp_cnt(struct bsm_scope
*sz
,
1074 struct bsgrp_node
*bsgrp
,
1075 uint16_t bsm_frag_tag
,
1076 uint32_t total_rp_count
)
1078 if (bsgrp
->pend_rp_cnt
) {
1079 /* received bsm is different packet ,
1080 * it is not same fragment.
1082 if (bsm_frag_tag
!= bsgrp
->frag_tag
) {
1085 "%s,Received a new BSM ,so clear the pending bs_rpinfo list.\r\n",
1086 __PRETTY_FUNCTION__
);
1087 list_delete_all_node(bsgrp
->partial_bsrp_list
);
1088 bsgrp
->pend_rp_cnt
= total_rp_count
;
1091 bsgrp
->pend_rp_cnt
= total_rp_count
;
1093 bsgrp
->frag_tag
= bsm_frag_tag
;
1096 /* Parsing BSR packet and adding to partial list of corresponding bsgrp node */
1097 static bool pim_bsm_parse_install_g2rp(struct bsm_scope
*scope
, uint8_t *buf
,
1098 int buflen
, uint16_t bsm_frag_tag
)
1100 struct bsmmsg_grpinfo grpinfo
;
1101 struct bsmmsg_rpinfo rpinfo
;
1102 struct prefix group
;
1103 struct bsgrp_node
*bsgrp
= NULL
;
1104 int frag_rp_cnt
= 0;
1108 while (buflen
> offset
) {
1109 /* Extract Group tlv from BSM */
1110 memcpy(&grpinfo
, buf
, sizeof(struct bsmmsg_grpinfo
));
1112 if (PIM_DEBUG_BSM
) {
1113 char grp_str
[INET_ADDRSTRLEN
];
1115 pim_inet4_dump("<Group?>", grpinfo
.group
.addr
, grp_str
,
1118 "%s, Group %s Rpcount:%d Fragment-Rp-count:%d\r\n",
1119 __PRETTY_FUNCTION__
, grp_str
, grpinfo
.rp_count
,
1120 grpinfo
.frag_rp_count
);
1123 buf
+= sizeof(struct bsmmsg_grpinfo
);
1124 offset
+= sizeof(struct bsmmsg_grpinfo
);
1126 if (grpinfo
.rp_count
== 0) {
1127 if (PIM_DEBUG_BSM
) {
1128 char grp_str
[INET_ADDRSTRLEN
];
1130 pim_inet4_dump("<Group?>", grpinfo
.group
.addr
,
1131 grp_str
, sizeof(grp_str
));
1133 "%s, Rp count is zero for group: %s\r\n",
1134 __PRETTY_FUNCTION__
, grp_str
);
1139 group
.family
= AF_INET
;
1140 group
.prefixlen
= grpinfo
.group
.mask
;
1141 group
.u
.prefix4
.s_addr
= grpinfo
.group
.addr
.s_addr
;
1143 /* Get the Group node for the BSM rp table */
1144 bsgrp
= pim_bsm_get_bsgrp_node(scope
, &group
);
1149 "%s, Create new BSM Group node.\r\n",
1150 __PRETTY_FUNCTION__
);
1152 /* create a new node to be added to the tree. */
1153 bsgrp
= pim_bsm_new_bsgrp_node(scope
->bsrp_table
,
1158 "%s, Failed to get the BSM group node.\r\n",
1159 __PRETTY_FUNCTION__
);
1163 bsgrp
->scope
= scope
;
1166 pim_update_pending_rp_cnt(scope
, bsgrp
, bsm_frag_tag
,
1168 frag_rp_cnt
= grpinfo
.frag_rp_count
;
1171 while (frag_rp_cnt
--) {
1172 /* Extract RP address tlv from BSM */
1173 memcpy(&rpinfo
, buf
, sizeof(struct bsmmsg_rpinfo
));
1174 rpinfo
.rp_holdtime
= ntohs(rpinfo
.rp_holdtime
);
1175 buf
+= sizeof(struct bsmmsg_rpinfo
);
1176 offset
+= sizeof(struct bsmmsg_rpinfo
);
1178 if (PIM_DEBUG_BSM
) {
1179 char rp_str
[INET_ADDRSTRLEN
];
1181 pim_inet4_dump("<Rpaddr?>", rpinfo
.rpaddr
.addr
,
1182 rp_str
, sizeof(rp_str
));
1184 "%s, Rp address - %s; pri:%d hold:%d\r\n",
1185 __PRETTY_FUNCTION__
, rp_str
,
1186 rpinfo
.rp_pri
, rpinfo
.rp_holdtime
);
1189 /* Call Install api to update grp-rp mappings */
1190 if (pim_install_bsm_grp_rp(scope
->pim
, bsgrp
, &rpinfo
))
1194 bsgrp
->pend_rp_cnt
-= ins_count
;
1196 if (!bsgrp
->pend_rp_cnt
) {
1199 "%s, Recvd all the rps for this group, so bsrp list with penidng rp list.",
1200 __PRETTY_FUNCTION__
);
1201 /* replace the bsrp_list with pending list */
1202 pim_instate_pend_list(bsgrp
);
1208 int pim_bsm_process(struct interface
*ifp
, struct ip
*ip_hdr
, uint8_t *buf
,
1209 uint32_t buf_size
, bool no_fwd
)
1211 struct bsm_hdr
*bshdr
;
1212 int sz
= PIM_GBL_SZ_ID
;
1213 struct bsmmsg_grpinfo
*msg_grp
;
1214 struct pim_interface
*pim_ifp
= NULL
;
1215 struct bsm_info
*bsminfo
;
1216 struct pim_instance
*pim
;
1217 char bsr_str
[INET_ADDRSTRLEN
];
1219 bool empty_bsm
= FALSE
;
1221 /* BSM Packet acceptance validation */
1222 pim_ifp
= ifp
->info
;
1225 zlog_debug("%s: multicast not enabled on interface %s",
1226 __PRETTY_FUNCTION__
, ifp
->name
);
1230 pim_ifp
->pim_ifstat_bsm_rx
++;
1234 /* Drop if bsm processing is disabled on interface */
1235 if (!pim_ifp
->bsm_enable
) {
1236 zlog_warn("%s: BSM not enabled on interface %s",
1237 __PRETTY_FUNCTION__
, ifp
->name
);
1238 pim_ifp
->pim_ifstat_bsm_cfg_miss
++;
1243 bshdr
= (struct bsm_hdr
*)(buf
+ PIM_MSG_HEADER_LEN
);
1244 pim_inet4_dump("<bsr?>", bshdr
->bsr_addr
.addr
, bsr_str
,
1246 pim
->global_scope
.hashMasklen
= bshdr
->hm_len
;
1247 frag_tag
= ntohs(bshdr
->frag_tag
);
1249 /* Identify empty BSM */
1250 if ((buf_size
- PIM_BSM_HDR_LEN
- PIM_MSG_HEADER_LEN
) < PIM_BSM_GRP_LEN
)
1254 msg_grp
= (struct bsmmsg_grpinfo
*)(buf
+ PIM_MSG_HEADER_LEN
1256 /* Currently we don't support scope zoned BSM */
1257 if (msg_grp
->group
.sz
) {
1260 "%s : Administratively scoped range BSM received",
1261 __PRETTY_FUNCTION__
);
1262 pim_ifp
->pim_ifstat_bsm_invalid_sz
++;
1268 /* Drop if bsr is not preferred bsr */
1269 if (!is_preferred_bsr(pim
, bshdr
->bsr_addr
.addr
, bshdr
->bsr_prio
)) {
1271 zlog_debug("%s : Received a non-preferred BSM",
1272 __PRETTY_FUNCTION__
);
1278 /* only accept no-forward BSM if quick refresh on startup */
1279 if ((pim
->global_scope
.accept_nofwd_bsm
)
1280 || (frag_tag
== pim
->global_scope
.bsm_frag_tag
)) {
1281 pim
->global_scope
.accept_nofwd_bsm
= false;
1285 "%s : nofwd_bsm received on %s when accpt_nofwd_bsm false",
1286 __PRETTY_FUNCTION__
, bsr_str
);
1288 pim_ifp
->pim_ifstat_ucast_bsm_cfg_miss
++;
1293 /* Mulicast BSM received */
1294 if (ip_hdr
->ip_dst
.s_addr
== qpim_all_pim_routers_addr
.s_addr
) {
1296 if (!pim_bsr_rpf_check(pim
, bshdr
->bsr_addr
.addr
,
1300 "%s : RPF check fail for BSR address %s",
1301 __PRETTY_FUNCTION__
, bsr_str
);
1306 } else if (if_lookup_exact_address(&ip_hdr
->ip_dst
, AF_INET
,
1308 /* Unicast BSM received - if ucast bsm not enabled on
1309 * the interface, drop it
1311 if (!pim_ifp
->ucast_bsm_accept
) {
1314 "%s : Unicast BSM not enabled on interface %s",
1315 __PRETTY_FUNCTION__
, ifp
->name
);
1316 pim_ifp
->pim_ifstat_ucast_bsm_cfg_miss
++;
1323 zlog_debug("%s : Invalid destination address",
1324 __PRETTY_FUNCTION__
);
1331 zlog_debug("%s : Empty Pref BSM received",
1332 __PRETTY_FUNCTION__
);
1334 /* Parse Update bsm rp table and install/uninstall rp if required */
1335 if (!pim_bsm_parse_install_g2rp(
1336 &pim_ifp
->pim
->global_scope
,
1337 (buf
+ PIM_BSM_HDR_LEN
+ PIM_MSG_HEADER_LEN
),
1338 (buf_size
- PIM_BSM_HDR_LEN
- PIM_MSG_HEADER_LEN
),
1340 if (PIM_DEBUG_BSM
) {
1341 zlog_debug("%s, Parsing BSM failed.\r\n",
1342 __PRETTY_FUNCTION__
);
1347 /* Restart the bootstrap timer */
1348 pim_bs_timer_restart(&pim_ifp
->pim
->global_scope
,
1349 PIM_BSR_DEFAULT_TIMEOUT
);
1351 /* If new BSM received, clear the old bsm database */
1352 if (pim_ifp
->pim
->global_scope
.bsm_frag_tag
!= frag_tag
) {
1353 if (PIM_DEBUG_BSM
) {
1354 zlog_debug("%s: Current frag tag: %d Frag teg rcvd: %d",
1355 __PRETTY_FUNCTION__
,
1356 pim_ifp
->pim
->global_scope
.bsm_frag_tag
,
1359 list_delete_all_node(pim_ifp
->pim
->global_scope
.bsm_list
);
1360 pim_ifp
->pim
->global_scope
.bsm_frag_tag
= frag_tag
;
1363 /* update the scope information from bsm */
1364 pim_bsm_update(pim
, bshdr
->bsr_addr
.addr
, bshdr
->bsr_prio
);
1367 pim_bsm_fwd_whole_sz(pim_ifp
->pim
, buf
, buf_size
, sz
);
1368 bsminfo
= XCALLOC(MTYPE_PIM_BSM_INFO
, sizeof(struct bsm_info
));
1370 bsminfo
->bsm
= XCALLOC(MTYPE_PIM_BSM_PKT_VAR_MEM
, buf_size
);
1372 bsminfo
->size
= buf_size
;
1373 memcpy(bsminfo
->bsm
, buf
, buf_size
);
1374 listnode_add(pim_ifp
->pim
->global_scope
.bsm_list
, bsminfo
);