]> git.proxmox.com Git - mirror_frr.git/blob - pimd/pim_bsm.c
pim6d: bsr nht handling for IPV6
[mirror_frr.git] / pimd / pim_bsm.c
1 /*
2 * pim_bsm.c: PIM BSM handling routines
3 *
4 * Copyright (C) 2018-19 Vmware, Inc.
5 * Saravanan K
6 *
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.
11 *
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.
16 *
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,
20 * MA 02110-1301 USA
21 */
22
23 #ifdef HAVE_CONFIG_H
24 #include "config.h"
25 #endif
26
27 #include "if.h"
28 #include "pimd.h"
29 #include "pim_iface.h"
30 #include "pim_instance.h"
31 #include "pim_neighbor.h"
32 #include "pim_rpf.h"
33 #include "pim_hello.h"
34 #include "pim_pim.h"
35 #include "pim_nht.h"
36 #include "pim_bsm.h"
37 #include "pim_time.h"
38 #include "pim_zebra.h"
39 #include "pim_util.h"
40
41 /* Functions forward declaration */
42 static void pim_bs_timer_start(struct bsm_scope *scope, int bs_timeout);
43 static void pim_g2rp_timer_start(struct bsm_rpinfo *bsrp, int hold_time);
44 static inline void pim_g2rp_timer_restart(struct bsm_rpinfo *bsrp,
45 int hold_time);
46
47 /* Memory Types */
48 DEFINE_MTYPE_STATIC(PIMD, PIM_BSGRP_NODE, "PIM BSR advertised grp info");
49 DEFINE_MTYPE_STATIC(PIMD, PIM_BSRP_INFO, "PIM BSR advertised RP info");
50 DEFINE_MTYPE_STATIC(PIMD, PIM_BSM_FRAG, "PIM BSM fragment");
51 DEFINE_MTYPE_STATIC(PIMD, PIM_BSM_PKT_VAR_MEM, "PIM BSM Packet");
52
53 /* All bsm packets forwarded shall be fit within ip mtu less iphdr(max) */
54 #define MAX_IP_HDR_LEN 24
55
56 /* pim_bsm_write_config - Write the interface pim bsm configuration.*/
57 void pim_bsm_write_config(struct vty *vty, struct interface *ifp)
58 {
59 struct pim_interface *pim_ifp = ifp->info;
60
61 if (pim_ifp) {
62 if (!pim_ifp->bsm_enable)
63 vty_out(vty, " no " PIM_AF_NAME " pim bsm\n");
64 if (!pim_ifp->ucast_bsm_accept)
65 vty_out(vty, " no " PIM_AF_NAME " pim unicast-bsm\n");
66 }
67 }
68
69 static void pim_bsm_rpinfo_free(struct bsm_rpinfo *bsrp_info)
70 {
71 THREAD_OFF(bsrp_info->g2rp_timer);
72 XFREE(MTYPE_PIM_BSRP_INFO, bsrp_info);
73 }
74
75 static void pim_bsm_rpinfos_free(struct bsm_rpinfos_head *head)
76 {
77 struct bsm_rpinfo *bsrp_info;
78
79 while ((bsrp_info = bsm_rpinfos_pop(head)))
80 pim_bsm_rpinfo_free(bsrp_info);
81 }
82
83 static void pim_free_bsgrp_data(struct bsgrp_node *bsgrp_node)
84 {
85 pim_bsm_rpinfos_free(bsgrp_node->bsrp_list);
86 pim_bsm_rpinfos_free(bsgrp_node->partial_bsrp_list);
87 XFREE(MTYPE_PIM_BSGRP_NODE, bsgrp_node);
88 }
89
90 static void pim_free_bsgrp_node(struct route_table *rt, struct prefix *grp)
91 {
92 struct route_node *rn;
93
94 rn = route_node_lookup(rt, grp);
95 if (rn) {
96 rn->info = NULL;
97 route_unlock_node(rn);
98 route_unlock_node(rn);
99 }
100 }
101
102 static void pim_bsm_frag_free(struct bsm_frag *bsfrag)
103 {
104 XFREE(MTYPE_PIM_BSM_FRAG, bsfrag);
105 }
106
107 static void pim_bsm_frags_free(struct bsm_scope *scope)
108 {
109 struct bsm_frag *bsfrag;
110
111 while ((bsfrag = bsm_frags_pop(scope->bsm_frags)))
112 pim_bsm_frag_free(bsfrag);
113 }
114
115 int pim_bsm_rpinfo_cmp(const struct bsm_rpinfo *node1,
116 const struct bsm_rpinfo *node2)
117 {
118 /* RP election Algo :
119 * Step-1 : Loweset Rp priority will have higher precedance.
120 * Step-2 : If priority same then higher hash val will have
121 * higher precedance.
122 * Step-3 : If Hash val is same then highest rp address will
123 * become elected RP.
124 */
125 if (node1->rp_prio < node2->rp_prio)
126 return -1;
127 if (node1->rp_prio > node2->rp_prio)
128 return 1;
129 if (node1->hash < node2->hash)
130 return 1;
131 if (node1->hash > node2->hash)
132 return -1;
133 if (node1->rp_address.s_addr < node2->rp_address.s_addr)
134 return 1;
135 if (node1->rp_address.s_addr > node2->rp_address.s_addr)
136 return -1;
137 return 0;
138 }
139
140 static struct bsgrp_node *pim_bsm_new_bsgrp_node(struct route_table *rt,
141 struct prefix *grp)
142 {
143 struct route_node *rn;
144 struct bsgrp_node *bsgrp;
145
146 rn = route_node_get(rt, grp);
147 if (!rn) {
148 zlog_warn("%s: route node creation failed", __func__);
149 return NULL;
150 }
151 bsgrp = XCALLOC(MTYPE_PIM_BSGRP_NODE, sizeof(struct bsgrp_node));
152
153 rn->info = bsgrp;
154 bsm_rpinfos_init(bsgrp->bsrp_list);
155 bsm_rpinfos_init(bsgrp->partial_bsrp_list);
156
157 prefix_copy(&bsgrp->group, grp);
158 return bsgrp;
159 }
160
161 static void pim_on_bs_timer(struct thread *t)
162 {
163 struct route_node *rn;
164 struct bsm_scope *scope;
165 struct bsgrp_node *bsgrp_node;
166 struct bsm_rpinfo *bsrp;
167
168 scope = THREAD_ARG(t);
169 THREAD_OFF(scope->bs_timer);
170
171 if (PIM_DEBUG_BSM)
172 zlog_debug("%s: Bootstrap Timer expired for scope: %d",
173 __func__, scope->sz_id);
174
175 pim_nht_bsr_del(scope->pim, scope->current_bsr);
176
177 /* Reset scope zone data */
178 scope->accept_nofwd_bsm = false;
179 scope->state = ACCEPT_ANY;
180 scope->current_bsr = PIMADDR_ANY;
181 scope->current_bsr_prio = 0;
182 scope->current_bsr_first_ts = 0;
183 scope->current_bsr_last_ts = 0;
184 scope->bsm_frag_tag = 0;
185 pim_bsm_frags_free(scope);
186
187 for (rn = route_top(scope->bsrp_table); rn; rn = route_next(rn)) {
188
189 bsgrp_node = (struct bsgrp_node *)rn->info;
190 if (!bsgrp_node) {
191 if (PIM_DEBUG_BSM)
192 zlog_debug("%s: bsgrp_node is null", __func__);
193 continue;
194 }
195 /* Give grace time for rp to continue for another hold time */
196 bsrp = bsm_rpinfos_first(bsgrp_node->bsrp_list);
197 if (bsrp)
198 pim_g2rp_timer_restart(bsrp, bsrp->rp_holdtime);
199
200 /* clear pending list */
201 pim_bsm_rpinfos_free(bsgrp_node->partial_bsrp_list);
202 bsgrp_node->pend_rp_cnt = 0;
203 }
204 }
205
206 static void pim_bs_timer_stop(struct bsm_scope *scope)
207 {
208 if (PIM_DEBUG_BSM)
209 zlog_debug("%s : BS timer being stopped of sz: %d", __func__,
210 scope->sz_id);
211 THREAD_OFF(scope->bs_timer);
212 }
213
214 static void pim_bs_timer_start(struct bsm_scope *scope, int bs_timeout)
215 {
216 if (!scope) {
217 if (PIM_DEBUG_BSM)
218 zlog_debug("%s : Invalid scope(NULL).", __func__);
219 return;
220 }
221 THREAD_OFF(scope->bs_timer);
222 if (PIM_DEBUG_BSM)
223 zlog_debug(
224 "%s : starting bs timer for scope %d with timeout %d secs",
225 __func__, scope->sz_id, bs_timeout);
226 thread_add_timer(router->master, pim_on_bs_timer, scope, bs_timeout,
227 &scope->bs_timer);
228 }
229
230 static inline void pim_bs_timer_restart(struct bsm_scope *scope, int bs_timeout)
231 {
232 pim_bs_timer_start(scope, bs_timeout);
233 }
234
235 void pim_bsm_proc_init(struct pim_instance *pim)
236 {
237 memset(&pim->global_scope, 0, sizeof(struct bsm_scope));
238
239 pim->global_scope.sz_id = PIM_GBL_SZ_ID;
240 pim->global_scope.bsrp_table = route_table_init();
241 pim->global_scope.accept_nofwd_bsm = true;
242 pim->global_scope.state = NO_INFO;
243 pim->global_scope.pim = pim;
244 bsm_frags_init(pim->global_scope.bsm_frags);
245 pim_bs_timer_start(&pim->global_scope, PIM_BS_TIME);
246 }
247
248 void pim_bsm_proc_free(struct pim_instance *pim)
249 {
250 struct route_node *rn;
251 struct bsgrp_node *bsgrp;
252
253 pim_bs_timer_stop(&pim->global_scope);
254 pim_bsm_frags_free(&pim->global_scope);
255
256 for (rn = route_top(pim->global_scope.bsrp_table); rn;
257 rn = route_next(rn)) {
258 bsgrp = rn->info;
259 if (!bsgrp)
260 continue;
261 pim_free_bsgrp_data(bsgrp);
262 }
263
264 route_table_finish(pim->global_scope.bsrp_table);
265 }
266
267 static bool is_hold_time_elapsed(void *data)
268 {
269 struct bsm_rpinfo *bsrp;
270
271 bsrp = data;
272
273 if (bsrp->elapse_time < bsrp->rp_holdtime)
274 return false;
275 else
276 return true;
277 }
278
279 static void pim_on_g2rp_timer(struct thread *t)
280 {
281 struct bsm_rpinfo *bsrp;
282 struct bsm_rpinfo *bsrp_node;
283 struct bsgrp_node *bsgrp_node;
284 struct pim_instance *pim;
285 struct rp_info *rp_info;
286 struct route_node *rn;
287 uint16_t elapse;
288 pim_addr bsrp_addr;
289
290 bsrp = THREAD_ARG(t);
291 THREAD_OFF(bsrp->g2rp_timer);
292 bsgrp_node = bsrp->bsgrp_node;
293
294 /* elapse time is the hold time of expired node */
295 elapse = bsrp->rp_holdtime;
296 bsrp_addr = bsrp->rp_address;
297
298 /* update elapse for all bsrp nodes */
299 frr_each_safe (bsm_rpinfos, bsgrp_node->bsrp_list, bsrp_node) {
300 bsrp_node->elapse_time += elapse;
301
302 if (is_hold_time_elapsed(bsrp_node)) {
303 bsm_rpinfos_del(bsgrp_node->bsrp_list, bsrp_node);
304 pim_bsm_rpinfo_free(bsrp_node);
305 }
306 }
307
308 /* Get the next elected rp node */
309 bsrp = bsm_rpinfos_first(bsgrp_node->bsrp_list);
310 pim = bsgrp_node->scope->pim;
311 rn = route_node_lookup(pim->rp_table, &bsgrp_node->group);
312
313 if (!rn) {
314 zlog_warn("%s: Route node doesn't exist", __func__);
315 return;
316 }
317
318 rp_info = (struct rp_info *)rn->info;
319
320 if (!rp_info) {
321 route_unlock_node(rn);
322 return;
323 }
324
325 if (rp_info->rp_src != RP_SRC_STATIC) {
326 /* If new rp available, change it else delete the existing */
327 if (bsrp) {
328 pim_g2rp_timer_start(
329 bsrp, (bsrp->rp_holdtime - bsrp->elapse_time));
330 pim_rp_change(pim, bsrp->rp_address, bsgrp_node->group,
331 RP_SRC_BSR);
332 } else {
333 pim_rp_del(pim, bsrp_addr, bsgrp_node->group, NULL,
334 RP_SRC_BSR);
335 }
336 }
337
338 if (!bsm_rpinfos_count(bsgrp_node->bsrp_list)
339 && !bsm_rpinfos_count(bsgrp_node->partial_bsrp_list)) {
340 pim_free_bsgrp_node(pim->global_scope.bsrp_table,
341 &bsgrp_node->group);
342 pim_free_bsgrp_data(bsgrp_node);
343 }
344 }
345
346 static void pim_g2rp_timer_start(struct bsm_rpinfo *bsrp, int hold_time)
347 {
348 if (!bsrp) {
349 if (PIM_DEBUG_BSM)
350 zlog_debug("%s : Invalid brsp(NULL).", __func__);
351 return;
352 }
353 THREAD_OFF(bsrp->g2rp_timer);
354 if (PIM_DEBUG_BSM)
355 zlog_debug(
356 "%s : starting g2rp timer for grp: %pFX - rp: %pI4 with timeout %d secs(Actual Hold time : %d secs)",
357 __func__, &bsrp->bsgrp_node->group,
358 &bsrp->rp_address, hold_time,
359 bsrp->rp_holdtime);
360
361 thread_add_timer(router->master, pim_on_g2rp_timer, bsrp, hold_time,
362 &bsrp->g2rp_timer);
363 }
364
365 static inline void pim_g2rp_timer_restart(struct bsm_rpinfo *bsrp,
366 int hold_time)
367 {
368 pim_g2rp_timer_start(bsrp, hold_time);
369 }
370
371 static void pim_g2rp_timer_stop(struct bsm_rpinfo *bsrp)
372 {
373 if (!bsrp)
374 return;
375
376 if (PIM_DEBUG_BSM)
377 zlog_debug("%s : stopping g2rp timer for grp: %pFX - rp: %pI4",
378 __func__, &bsrp->bsgrp_node->group,
379 &bsrp->rp_address);
380
381 THREAD_OFF(bsrp->g2rp_timer);
382 }
383
384 static bool is_hold_time_zero(void *data)
385 {
386 struct bsm_rpinfo *bsrp;
387
388 bsrp = data;
389
390 if (bsrp->rp_holdtime)
391 return false;
392 else
393 return true;
394 }
395
396 static void pim_instate_pend_list(struct bsgrp_node *bsgrp_node)
397 {
398 struct bsm_rpinfo *active;
399 struct bsm_rpinfo *pend;
400 struct rp_info *rp_info;
401 struct route_node *rn;
402 struct pim_instance *pim;
403 struct rp_info *rp_all;
404 struct prefix group_all;
405 bool had_rp_node = true;
406
407 pim = bsgrp_node->scope->pim;
408 active = bsm_rpinfos_first(bsgrp_node->bsrp_list);
409
410 /* Remove nodes with hold time 0 & check if list still has a head */
411 frr_each_safe (bsm_rpinfos, bsgrp_node->partial_bsrp_list, pend) {
412 if (is_hold_time_zero(pend)) {
413 bsm_rpinfos_del(bsgrp_node->partial_bsrp_list, pend);
414 pim_bsm_rpinfo_free(pend);
415 }
416 }
417
418 pend = bsm_rpinfos_first(bsgrp_node->partial_bsrp_list);
419
420 if (!pim_get_all_mcast_group(&group_all))
421 return;
422
423 rp_all = pim_rp_find_match_group(pim, &group_all);
424 rn = route_node_lookup(pim->rp_table, &bsgrp_node->group);
425
426 if (pend)
427 pim_g2rp_timer_start(pend, pend->rp_holdtime);
428
429 /* if rp node doesn't exist or exist but not configured(rp_all),
430 * install the rp from head(if exists) of partial list. List is
431 * is sorted such that head is the elected RP for the group.
432 */
433 if (!rn || (prefix_same(&rp_all->group, &bsgrp_node->group) &&
434 pim_rpf_addr_is_inaddr_any(&rp_all->rp))) {
435 if (PIM_DEBUG_BSM)
436 zlog_debug("%s: Route node doesn't exist", __func__);
437 if (pend)
438 pim_rp_new(pim, pend->rp_address, bsgrp_node->group,
439 NULL, RP_SRC_BSR);
440 had_rp_node = false;
441 } else {
442 rp_info = (struct rp_info *)rn->info;
443 if (!rp_info) {
444 route_unlock_node(rn);
445 if (pend)
446 pim_rp_new(pim, pend->rp_address,
447 bsgrp_node->group, NULL, RP_SRC_BSR);
448 had_rp_node = false;
449 }
450 }
451
452 /* We didn't have rp node and pending list is empty(unlikely), cleanup*/
453 if ((!had_rp_node) && (!pend)) {
454 pim_free_bsgrp_node(bsgrp_node->scope->bsrp_table,
455 &bsgrp_node->group);
456 pim_free_bsgrp_data(bsgrp_node);
457 return;
458 }
459
460 if ((had_rp_node) && (rp_info->rp_src != RP_SRC_STATIC)) {
461 /* This means we searched and got rp node, needs unlock */
462 route_unlock_node(rn);
463
464 if (active && pend) {
465 if ((active->rp_address.s_addr
466 != pend->rp_address.s_addr))
467 pim_rp_change(pim, pend->rp_address,
468 bsgrp_node->group, RP_SRC_BSR);
469 }
470
471 /* Possible when the first BSM has group with 0 rp count */
472 if ((!active) && (!pend)) {
473 if (PIM_DEBUG_BSM) {
474 zlog_debug(
475 "%s: Both bsrp and partial list are empty",
476 __func__);
477 }
478 pim_free_bsgrp_node(bsgrp_node->scope->bsrp_table,
479 &bsgrp_node->group);
480 pim_free_bsgrp_data(bsgrp_node);
481 return;
482 }
483
484 /* Possible when a group with 0 rp count received in BSM */
485 if ((active) && (!pend)) {
486 pim_rp_del(pim, active->rp_address, bsgrp_node->group,
487 NULL, RP_SRC_BSR);
488 pim_free_bsgrp_node(bsgrp_node->scope->bsrp_table,
489 &bsgrp_node->group);
490 if (PIM_DEBUG_BSM) {
491 zlog_debug("%s:Pend List is null,del grp node",
492 __func__);
493 }
494 pim_free_bsgrp_data(bsgrp_node);
495 return;
496 }
497 }
498
499 if ((had_rp_node) && (rp_info->rp_src == RP_SRC_STATIC)) {
500 /* We need to unlock rn this case */
501 route_unlock_node(rn);
502 /* there is a chance that static rp exist and bsrp cleaned
503 * so clean bsgrp node if pending list empty
504 */
505 if (!pend) {
506 if (PIM_DEBUG_BSM)
507 zlog_debug(
508 "%s: Partial list is empty, static rp exists",
509 __func__);
510 pim_free_bsgrp_node(bsgrp_node->scope->bsrp_table,
511 &bsgrp_node->group);
512 pim_free_bsgrp_data(bsgrp_node);
513 return;
514 }
515 }
516
517 /* swap the list & delete all nodes in partial list (old bsrp_list)
518 * before swap
519 * active is head of bsrp list
520 * pend is head of partial list
521 * After swap
522 * active is head of partial list
523 * pend is head of bsrp list
524 * So check appriate head after swap and clean the new partial list
525 */
526 bsm_rpinfos_swap_all(bsgrp_node->bsrp_list,
527 bsgrp_node->partial_bsrp_list);
528
529 if (active)
530 pim_g2rp_timer_stop(active);
531 pim_bsm_rpinfos_free(bsgrp_node->partial_bsrp_list);
532 }
533
534 static bool is_preferred_bsr(struct pim_instance *pim, pim_addr bsr,
535 uint32_t bsr_prio)
536 {
537 if (!pim_addr_cmp(bsr, pim->global_scope.current_bsr))
538 return true;
539
540 if (bsr_prio > pim->global_scope.current_bsr_prio)
541 return true;
542
543 else if (bsr_prio == pim->global_scope.current_bsr_prio) {
544 if (pim_addr_cmp(bsr, pim->global_scope.current_bsr) >= 0)
545 return true;
546 else
547 return false;
548 } else
549 return false;
550 }
551
552 static void pim_bsm_update(struct pim_instance *pim, pim_addr bsr,
553 uint32_t bsr_prio)
554 {
555 if (bsr.s_addr != pim->global_scope.current_bsr.s_addr) {
556 pim_nht_bsr_del(pim, pim->global_scope.current_bsr);
557 pim_nht_bsr_add(pim, bsr);
558
559 pim->global_scope.current_bsr = bsr;
560 pim->global_scope.current_bsr_first_ts =
561 pim_time_monotonic_sec();
562 pim->global_scope.state = ACCEPT_PREFERRED;
563 }
564 pim->global_scope.current_bsr_prio = bsr_prio;
565 pim->global_scope.current_bsr_last_ts = pim_time_monotonic_sec();
566 }
567
568 void pim_bsm_clear(struct pim_instance *pim)
569 {
570 struct route_node *rn;
571 struct route_node *rpnode;
572 struct bsgrp_node *bsgrp;
573 pim_addr nht_p;
574 struct prefix g_all;
575 struct rp_info *rp_all;
576 struct pim_upstream *up;
577 struct rp_info *rp_info;
578 bool upstream_updated = false;
579
580 pim_nht_bsr_del(pim, pim->global_scope.current_bsr);
581
582 /* Reset scope zone data */
583 pim->global_scope.accept_nofwd_bsm = false;
584 pim->global_scope.state = ACCEPT_ANY;
585 pim->global_scope.current_bsr = PIMADDR_ANY;
586 pim->global_scope.current_bsr_prio = 0;
587 pim->global_scope.current_bsr_first_ts = 0;
588 pim->global_scope.current_bsr_last_ts = 0;
589 pim->global_scope.bsm_frag_tag = 0;
590 pim_bsm_frags_free(&pim->global_scope);
591
592 pim_bs_timer_stop(&pim->global_scope);
593
594 for (rn = route_top(pim->global_scope.bsrp_table); rn;
595 rn = route_next(rn)) {
596 bsgrp = rn->info;
597 if (!bsgrp)
598 continue;
599
600 rpnode = route_node_lookup(pim->rp_table, &bsgrp->group);
601
602 if (!rpnode) {
603 pim_free_bsgrp_node(bsgrp->scope->bsrp_table,
604 &bsgrp->group);
605 pim_free_bsgrp_data(bsgrp);
606 continue;
607 }
608
609 rp_info = (struct rp_info *)rpnode->info;
610
611 if ((!rp_info) || (rp_info->rp_src != RP_SRC_BSR)) {
612 pim_free_bsgrp_node(bsgrp->scope->bsrp_table,
613 &bsgrp->group);
614 pim_free_bsgrp_data(bsgrp);
615 continue;
616 }
617
618 /* Deregister addr with Zebra NHT */
619 nht_p = rp_info->rp.rpf_addr;
620
621 if (PIM_DEBUG_PIM_NHT_RP) {
622 zlog_debug("%s: Deregister RP addr %pPA with Zebra ",
623 __func__, &nht_p);
624 }
625
626 pim_delete_tracked_nexthop(pim, nht_p, NULL, rp_info);
627
628 if (!pim_get_all_mcast_group(&g_all))
629 return;
630
631 rp_all = pim_rp_find_match_group(pim, &g_all);
632
633 if (rp_all == rp_info) {
634 rp_all->rp.rpf_addr = PIMADDR_ANY;
635 rp_all->i_am_rp = 0;
636 } else {
637 /* Delete the rp_info from rp-list */
638 listnode_delete(pim->rp_list, rp_info);
639
640 /* Delete the rp node from rp_table */
641 rpnode->info = NULL;
642 route_unlock_node(rpnode);
643 route_unlock_node(rpnode);
644 XFREE(MTYPE_PIM_RP, rp_info);
645 }
646
647 pim_free_bsgrp_node(bsgrp->scope->bsrp_table, &bsgrp->group);
648 pim_free_bsgrp_data(bsgrp);
649 }
650 pim_rp_refresh_group_to_rp_mapping(pim);
651
652
653 frr_each (rb_pim_upstream, &pim->upstream_head, up) {
654 /* Find the upstream (*, G) whose upstream address is same as
655 * the RP
656 */
657 if (!pim_addr_is_any(up->sg.src))
658 continue;
659
660 struct prefix grp;
661 struct rp_info *trp_info;
662
663 pim_addr_to_prefix(&grp, up->sg.grp);
664 trp_info = pim_rp_find_match_group(pim, &grp);
665
666 /* RP not found for the group grp */
667 if (pim_rpf_addr_is_inaddr_any(&trp_info->rp)) {
668 pim_upstream_rpf_clear(pim, up);
669 pim_rp_set_upstream_addr(pim, &up->upstream_addr,
670 up->sg.src, up->sg.grp);
671 } else {
672 /* RP found for the group grp */
673 pim_upstream_update(pim, up);
674 upstream_updated = true;
675 }
676 }
677
678 if (upstream_updated)
679 pim_zebra_update_all_interfaces(pim);
680 }
681
682 static bool pim_bsm_send_intf(uint8_t *buf, int len, struct interface *ifp,
683 pim_addr dst_addr)
684 {
685 struct pim_interface *pim_ifp;
686
687 pim_ifp = ifp->info;
688
689 if (!pim_ifp) {
690 if (PIM_DEBUG_BSM)
691 zlog_debug("%s: Pim interface not available for %s",
692 __func__, ifp->name);
693 return false;
694 }
695
696 if (pim_ifp->pim_sock_fd == -1) {
697 if (PIM_DEBUG_BSM)
698 zlog_debug("%s: Pim sock not available for %s",
699 __func__, ifp->name);
700 return false;
701 }
702
703 if (pim_msg_send(pim_ifp->pim_sock_fd, pim_ifp->primary_address,
704 dst_addr, buf, len, ifp)) {
705 zlog_warn("%s: Could not send BSM message on interface: %s",
706 __func__, ifp->name);
707 return false;
708 }
709
710 if (!pim_ifp->pim_passive_enable)
711 pim_ifp->pim_ifstat_bsm_tx++;
712
713 pim_ifp->pim->bsm_sent++;
714 return true;
715 }
716
717 static bool pim_bsm_frag_send(uint8_t *buf, uint32_t len, struct interface *ifp,
718 uint32_t pim_mtu, pim_addr dst_addr, bool no_fwd)
719 {
720 struct pim_interface *pim_ifp = ifp->info;
721 struct bsmmsg_grpinfo *grpinfo, *curgrp;
722 uint8_t *firstgrp_ptr;
723 uint8_t *pkt;
724 uint8_t *pak_start;
725 uint32_t parsed_len = 0;
726 uint32_t this_pkt_rem;
727 uint32_t copy_byte_count;
728 uint32_t this_pkt_len;
729 uint8_t total_rp_cnt;
730 uint8_t this_rp_cnt;
731 uint8_t frag_rp_cnt;
732 uint8_t rp_fit_cnt;
733 bool pak_pending = false;
734
735 /* MTU passed here is PIM MTU (IP MTU less IP Hdr) */
736 if (pim_mtu < (PIM_MIN_BSM_LEN)) {
737 zlog_warn(
738 "%s: mtu(pim mtu: %d) size less than minimum bootstrap len",
739 __func__, pim_mtu);
740 if (PIM_DEBUG_BSM)
741 zlog_debug(
742 "%s: mtu (pim mtu:%d) less than minimum bootstrap len",
743 __func__, pim_mtu);
744 return false;
745 }
746
747 pak_start = XCALLOC(MTYPE_PIM_BSM_PKT_VAR_MEM, pim_mtu);
748
749 pkt = pak_start;
750
751 /* Fill PIM header later before sending packet to calc checksum */
752 pkt += PIM_MSG_HEADER_LEN;
753 buf += PIM_MSG_HEADER_LEN;
754
755 /* copy bsm header to new packet at offset of pim hdr */
756 memcpy(pkt, buf, PIM_BSM_HDR_LEN);
757 pkt += PIM_BSM_HDR_LEN;
758 buf += PIM_BSM_HDR_LEN;
759 parsed_len += (PIM_MSG_HEADER_LEN + PIM_BSM_HDR_LEN);
760
761 /* Store the position of first grp ptr, which can be reused for
762 * next packet to start filling group. old bsm header and pim hdr
763 * remains. So need not be filled again for next packet onwards.
764 */
765 firstgrp_ptr = pkt;
766
767 /* we received mtu excluding IP hdr len as param
768 * now this_pkt_rem is mtu excluding
769 * PIM_BSM_HDR_LEN + PIM_MSG_HEADER_LEN
770 */
771 this_pkt_rem = pim_mtu - (PIM_BSM_HDR_LEN + PIM_MSG_HEADER_LEN);
772
773 /* For each group till the packet length parsed */
774 while (parsed_len < len) {
775 /* pkt ---> fragment's current pointer
776 * buf ---> input buffer's current pointer
777 * mtu ---> size of the pim packet - PIM header
778 * curgrp ---> current group on the fragment
779 * grpinfo ---> current group on the input buffer
780 * this_pkt_rem ---> bytes remaing on the current fragment
781 * rp_fit_cnt ---> num of rp for current grp that
782 * fits this frag
783 * total_rp_cnt ---> total rp present for the group in the buf
784 * frag_rp_cnt ---> no of rp for the group to be fit in
785 * the frag
786 * this_rp_cnt ---> how many rp have we parsed
787 */
788 grpinfo = (struct bsmmsg_grpinfo *)buf;
789 memcpy(pkt, buf, PIM_BSM_GRP_LEN);
790 curgrp = (struct bsmmsg_grpinfo *)pkt;
791 parsed_len += PIM_BSM_GRP_LEN;
792 pkt += PIM_BSM_GRP_LEN;
793 buf += PIM_BSM_GRP_LEN;
794 this_pkt_rem -= PIM_BSM_GRP_LEN;
795
796 /* initialize rp count and total_rp_cnt before the rp loop */
797 this_rp_cnt = 0;
798 total_rp_cnt = grpinfo->frag_rp_count;
799
800 /* Loop till all RPs for the group parsed */
801 while (this_rp_cnt < total_rp_cnt) {
802 /* All RP from a group processed here.
803 * group is pointed by grpinfo.
804 * At this point make sure buf pointing to a RP
805 * within a group
806 */
807 rp_fit_cnt = this_pkt_rem / PIM_BSM_RP_LEN;
808
809 /* calculate how many rp am i going to copy in
810 * this frag
811 */
812 if (rp_fit_cnt > (total_rp_cnt - this_rp_cnt))
813 frag_rp_cnt = total_rp_cnt - this_rp_cnt;
814 else
815 frag_rp_cnt = rp_fit_cnt;
816
817 /* populate the frag rp count for the current grp */
818 curgrp->frag_rp_count = frag_rp_cnt;
819 copy_byte_count = frag_rp_cnt * PIM_BSM_RP_LEN;
820
821 /* copy all the rp that we are fitting in this
822 * frag for the grp
823 */
824 memcpy(pkt, buf, copy_byte_count);
825 this_rp_cnt += frag_rp_cnt;
826 buf += copy_byte_count;
827 pkt += copy_byte_count;
828 parsed_len += copy_byte_count;
829 this_pkt_rem -= copy_byte_count;
830
831 /* Either we couldn't fit all rp for the group or the
832 * mtu reached
833 */
834 if ((this_rp_cnt < total_rp_cnt)
835 || (this_pkt_rem
836 < (PIM_BSM_GRP_LEN + PIM_BSM_RP_LEN))) {
837 /* No space to fit in more rp, send this pkt */
838 this_pkt_len = pim_mtu - this_pkt_rem;
839 pim_msg_build_header(
840 pim_ifp->primary_address, dst_addr,
841 pak_start, this_pkt_len,
842 PIM_MSG_TYPE_BOOTSTRAP, no_fwd);
843 pim_bsm_send_intf(pak_start, this_pkt_len, ifp,
844 dst_addr);
845
846 /* Construct next fragment. Reuse old packet */
847 pkt = firstgrp_ptr;
848 this_pkt_rem = pim_mtu - (PIM_BSM_HDR_LEN
849 + PIM_MSG_HEADER_LEN);
850
851 /* If pkt can't accommodate next group + at
852 * least one rp, we must break out of this inner
853 * loop and process next RP
854 */
855 if (total_rp_cnt == this_rp_cnt)
856 break;
857
858 /* If some more RPs for the same group pending,
859 * fill grp hdr
860 */
861 memcpy(pkt, (uint8_t *)grpinfo,
862 PIM_BSM_GRP_LEN);
863 curgrp = (struct bsmmsg_grpinfo *)pkt;
864 pkt += PIM_BSM_GRP_LEN;
865 this_pkt_rem -= PIM_BSM_GRP_LEN;
866 pak_pending = false;
867 } else {
868 /* We filled something but not yet sent out */
869 pak_pending = true;
870 }
871 } /* while RP count */
872 } /*while parsed len */
873
874 /* Send if we have any unsent packet */
875 if (pak_pending) {
876 this_pkt_len = pim_mtu - this_pkt_rem;
877 pim_msg_build_header(pim_ifp->primary_address, dst_addr,
878 pak_start, this_pkt_len,
879 PIM_MSG_TYPE_BOOTSTRAP, no_fwd);
880 pim_bsm_send_intf(pak_start, (pim_mtu - this_pkt_rem), ifp,
881 dst_addr);
882 }
883 XFREE(MTYPE_PIM_BSM_PKT_VAR_MEM, pak_start);
884 return true;
885 }
886
887 static void pim_bsm_fwd_whole_sz(struct pim_instance *pim, uint8_t *buf,
888 uint32_t len, int sz)
889 {
890 struct interface *ifp;
891 struct pim_interface *pim_ifp;
892 pim_addr dst_addr;
893 uint32_t pim_mtu;
894 bool no_fwd = false;
895 bool ret = false;
896
897 /* For now only global scope zone is supported, so send on all
898 * pim interfaces in the vrf
899 */
900 dst_addr = qpim_all_pim_routers_addr;
901 FOR_ALL_INTERFACES (pim->vrf, ifp) {
902 pim_ifp = ifp->info;
903 if ((!pim_ifp) || (!pim_ifp->bsm_enable))
904 continue;
905
906 /*
907 * RFC 5059 Sec 3.4:
908 * When a Bootstrap message is forwarded, it is forwarded out
909 * of every multicast-capable interface that has PIM neighbors.
910 *
911 * So skipping pim interfaces with no neighbors.
912 */
913 if (listcount(pim_ifp->pim_neighbor_list) == 0)
914 continue;
915
916 pim_hello_require(ifp);
917 pim_mtu = ifp->mtu - MAX_IP_HDR_LEN;
918 if (pim_mtu < len) {
919 ret = pim_bsm_frag_send(buf, len, ifp, pim_mtu,
920 dst_addr, no_fwd);
921 if (PIM_DEBUG_BSM)
922 zlog_debug("%s: pim_bsm_frag_send returned %s",
923 __func__, ret ? "TRUE" : "FALSE");
924 } else {
925 pim_msg_build_header(pim_ifp->primary_address, dst_addr,
926 buf, len, PIM_MSG_TYPE_BOOTSTRAP,
927 no_fwd);
928 if (!pim_bsm_send_intf(buf, len, ifp, dst_addr)) {
929 if (PIM_DEBUG_BSM)
930 zlog_debug(
931 "%s: pim_bsm_send_intf returned false",
932 __func__);
933 }
934 }
935 }
936 }
937
938 bool pim_bsm_new_nbr_fwd(struct pim_neighbor *neigh, struct interface *ifp)
939 {
940 pim_addr dst_addr;
941 struct pim_interface *pim_ifp;
942 struct bsm_scope *scope;
943 struct bsm_frag *bsfrag;
944 char neigh_src_str[INET_ADDRSTRLEN];
945 uint32_t pim_mtu;
946 bool no_fwd = true;
947 bool ret = false;
948
949 if (PIM_DEBUG_BSM)
950 zlog_debug("%s: New neighbor %pPA seen on %s", __func__,
951 &neigh->source_addr, ifp->name);
952
953 pim_ifp = ifp->info;
954
955 /* DR only forwards BSM packet */
956 if (!pim_addr_cmp(pim_ifp->pim_dr_addr, pim_ifp->primary_address)) {
957 if (PIM_DEBUG_BSM)
958 zlog_debug(
959 "%s: It is not DR, so don't forward BSM packet",
960 __func__);
961 }
962
963 if (!pim_ifp->bsm_enable) {
964 if (PIM_DEBUG_BSM)
965 zlog_debug("%s: BSM proc not enabled on %s", __func__,
966 ifp->name);
967 return ret;
968 }
969
970 scope = &pim_ifp->pim->global_scope;
971
972 if (!bsm_frags_count(scope->bsm_frags)) {
973 if (PIM_DEBUG_BSM)
974 zlog_debug("%s: BSM list for the scope is empty",
975 __func__);
976 return ret;
977 }
978
979 if (!pim_ifp->ucast_bsm_accept) {
980 dst_addr = qpim_all_pim_routers_addr;
981 if (PIM_DEBUG_BSM)
982 zlog_debug("%s: Sending BSM mcast to %s", __func__,
983 neigh_src_str);
984 } else {
985 dst_addr = neigh->source_addr;
986 if (PIM_DEBUG_BSM)
987 zlog_debug("%s: Sending BSM ucast to %s", __func__,
988 neigh_src_str);
989 }
990 pim_mtu = ifp->mtu - MAX_IP_HDR_LEN;
991 pim_hello_require(ifp);
992
993 frr_each (bsm_frags, scope->bsm_frags, bsfrag) {
994 if (pim_mtu < bsfrag->size) {
995 ret = pim_bsm_frag_send(bsfrag->data, bsfrag->size, ifp,
996 pim_mtu, dst_addr, no_fwd);
997 if (!ret) {
998 if (PIM_DEBUG_BSM)
999 zlog_debug(
1000 "%s: pim_bsm_frag_send failed",
1001 __func__);
1002 }
1003 } else {
1004 /* Pim header needs to be constructed */
1005 pim_msg_build_header(pim_ifp->primary_address, dst_addr,
1006 bsfrag->data, bsfrag->size,
1007 PIM_MSG_TYPE_BOOTSTRAP, no_fwd);
1008 ret = pim_bsm_send_intf(bsfrag->data, bsfrag->size, ifp,
1009 dst_addr);
1010 if (!ret) {
1011 if (PIM_DEBUG_BSM)
1012 zlog_debug(
1013 "%s: pim_bsm_frag_send failed",
1014 __func__);
1015 }
1016 }
1017 }
1018 return ret;
1019 }
1020
1021 struct bsgrp_node *pim_bsm_get_bsgrp_node(struct bsm_scope *scope,
1022 struct prefix *grp)
1023 {
1024 struct route_node *rn;
1025 struct bsgrp_node *bsgrp;
1026
1027 rn = route_node_lookup(scope->bsrp_table, grp);
1028 if (!rn) {
1029 if (PIM_DEBUG_BSM)
1030 zlog_debug("%s: Route node doesn't exist for the group",
1031 __func__);
1032 return NULL;
1033 }
1034 bsgrp = rn->info;
1035 route_unlock_node(rn);
1036
1037 return bsgrp;
1038 }
1039
1040 static uint32_t hash_calc_on_grp_rp(struct prefix group, struct in_addr rp,
1041 uint8_t hashmasklen)
1042 {
1043 uint64_t temp;
1044 uint32_t hash;
1045 uint32_t grpaddr;
1046 uint32_t rp_add;
1047 uint32_t mask = 0xffffffff;
1048
1049 /* mask to be made zero if hashmasklen is 0 because mask << 32
1050 * may not give 0. hashmasklen can be 0 to 32.
1051 */
1052 if (hashmasklen == 0)
1053 mask = 0;
1054
1055 /* in_addr stores ip in big endian, hence network byte order
1056 * convert to uint32 before processing hash
1057 */
1058 grpaddr = ntohl(group.u.prefix4.s_addr);
1059 /* Avoid shifting by 32 bit on a 32 bit register */
1060 if (hashmasklen)
1061 grpaddr = grpaddr & ((mask << (32 - hashmasklen)));
1062 else
1063 grpaddr = grpaddr & mask;
1064 rp_add = ntohl(rp.s_addr);
1065 temp = 1103515245 * ((1103515245 * (uint64_t)grpaddr + 12345) ^ rp_add)
1066 + 12345;
1067 hash = temp & (0x7fffffff);
1068 return hash;
1069 }
1070
1071 static bool pim_install_bsm_grp_rp(struct pim_instance *pim,
1072 struct bsgrp_node *grpnode,
1073 struct bsmmsg_rpinfo *rp)
1074 {
1075 struct bsm_rpinfo *bsm_rpinfo;
1076 uint8_t hashMask_len = pim->global_scope.hashMasklen;
1077
1078 /*memory allocation for bsm_rpinfo */
1079 bsm_rpinfo = XCALLOC(MTYPE_PIM_BSRP_INFO, sizeof(*bsm_rpinfo));
1080
1081 bsm_rpinfo->rp_prio = rp->rp_pri;
1082 bsm_rpinfo->rp_holdtime = rp->rp_holdtime;
1083 memcpy(&bsm_rpinfo->rp_address, &rp->rpaddr.addr,
1084 sizeof(struct in_addr));
1085 bsm_rpinfo->elapse_time = 0;
1086
1087 /* Back pointer to the group node. */
1088 bsm_rpinfo->bsgrp_node = grpnode;
1089
1090 /* update hash for this rp node */
1091 bsm_rpinfo->hash = hash_calc_on_grp_rp(grpnode->group, rp->rpaddr.addr,
1092 hashMask_len);
1093 if (bsm_rpinfos_add(grpnode->partial_bsrp_list, bsm_rpinfo) == NULL) {
1094 if (PIM_DEBUG_BSM)
1095 zlog_debug(
1096 "%s, bs_rpinfo node added to the partial bs_rplist.",
1097 __func__);
1098 return true;
1099 }
1100
1101 if (PIM_DEBUG_BSM)
1102 zlog_debug("%s: list node not added", __func__);
1103
1104 XFREE(MTYPE_PIM_BSRP_INFO, bsm_rpinfo);
1105 return false;
1106 }
1107
1108 static void pim_update_pending_rp_cnt(struct bsm_scope *sz,
1109 struct bsgrp_node *bsgrp,
1110 uint16_t bsm_frag_tag,
1111 uint32_t total_rp_count)
1112 {
1113 if (bsgrp->pend_rp_cnt) {
1114 /* received bsm is different packet ,
1115 * it is not same fragment.
1116 */
1117 if (bsm_frag_tag != bsgrp->frag_tag) {
1118 if (PIM_DEBUG_BSM)
1119 zlog_debug(
1120 "%s,Received a new BSM ,so clear the pending bs_rpinfo list.",
1121 __func__);
1122 pim_bsm_rpinfos_free(bsgrp->partial_bsrp_list);
1123 bsgrp->pend_rp_cnt = total_rp_count;
1124 }
1125 } else
1126 bsgrp->pend_rp_cnt = total_rp_count;
1127
1128 bsgrp->frag_tag = bsm_frag_tag;
1129 }
1130
1131 /* Parsing BSR packet and adding to partial list of corresponding bsgrp node */
1132 static bool pim_bsm_parse_install_g2rp(struct bsm_scope *scope, uint8_t *buf,
1133 int buflen, uint16_t bsm_frag_tag)
1134 {
1135 struct bsmmsg_grpinfo grpinfo;
1136 struct bsmmsg_rpinfo rpinfo;
1137 struct prefix group;
1138 struct bsgrp_node *bsgrp = NULL;
1139 int frag_rp_cnt = 0;
1140 int offset = 0;
1141 int ins_count = 0;
1142
1143 while (buflen > offset) {
1144 if (offset + (int)sizeof(struct bsmmsg_grpinfo) > buflen) {
1145 if (PIM_DEBUG_BSM)
1146 zlog_debug(
1147 "%s: buflen received %d is less than the internal data structure of the packet would suggest",
1148 __func__, buflen);
1149 return false;
1150 }
1151 /* Extract Group tlv from BSM */
1152 memcpy(&grpinfo, buf, sizeof(struct bsmmsg_grpinfo));
1153
1154 if (PIM_DEBUG_BSM) {
1155 char grp_str[INET_ADDRSTRLEN];
1156
1157 pim_inet4_dump("<Group?>", grpinfo.group.addr, grp_str,
1158 sizeof(grp_str));
1159 zlog_debug(
1160 "%s, Group %s Rpcount:%d Fragment-Rp-count:%d",
1161 __func__, grp_str, grpinfo.rp_count,
1162 grpinfo.frag_rp_count);
1163 }
1164
1165 buf += sizeof(struct bsmmsg_grpinfo);
1166 offset += sizeof(struct bsmmsg_grpinfo);
1167
1168 group.family = AF_INET;
1169 if (grpinfo.group.mask > IPV4_MAX_BITLEN) {
1170 if (PIM_DEBUG_BSM)
1171 zlog_debug(
1172 "%s, v4 prefix length specified: %d is too long",
1173 __func__, grpinfo.group.mask);
1174 return false;
1175 }
1176 group.prefixlen = grpinfo.group.mask;
1177 group.u.prefix4.s_addr = grpinfo.group.addr.s_addr;
1178
1179 /* Get the Group node for the BSM rp table */
1180 bsgrp = pim_bsm_get_bsgrp_node(scope, &group);
1181
1182 if (grpinfo.rp_count == 0) {
1183 struct bsm_rpinfo *old_rpinfo;
1184
1185 /* BSR explicitly no longer has RPs for this group */
1186 if (!bsgrp)
1187 continue;
1188
1189 if (PIM_DEBUG_BSM) {
1190 char grp_str[INET_ADDRSTRLEN];
1191
1192 pim_inet4_dump("<Group?>", grpinfo.group.addr,
1193 grp_str, sizeof(grp_str));
1194 zlog_debug("%s, Rp count is zero for group: %s",
1195 __func__, grp_str);
1196 }
1197
1198 old_rpinfo = bsm_rpinfos_first(bsgrp->bsrp_list);
1199 if (old_rpinfo)
1200 pim_rp_del(scope->pim, old_rpinfo->rp_address,
1201 group, NULL, RP_SRC_BSR);
1202
1203 pim_free_bsgrp_node(scope->bsrp_table, &bsgrp->group);
1204 pim_free_bsgrp_data(bsgrp);
1205 continue;
1206 }
1207
1208 if (!bsgrp) {
1209 if (PIM_DEBUG_BSM)
1210 zlog_debug("%s, Create new BSM Group node.",
1211 __func__);
1212
1213 /* create a new node to be added to the tree. */
1214 bsgrp = pim_bsm_new_bsgrp_node(scope->bsrp_table,
1215 &group);
1216
1217 if (!bsgrp) {
1218 zlog_debug(
1219 "%s, Failed to get the BSM group node.",
1220 __func__);
1221 continue;
1222 }
1223
1224 bsgrp->scope = scope;
1225 }
1226
1227 pim_update_pending_rp_cnt(scope, bsgrp, bsm_frag_tag,
1228 grpinfo.rp_count);
1229 frag_rp_cnt = grpinfo.frag_rp_count;
1230 ins_count = 0;
1231
1232 while (frag_rp_cnt--) {
1233 if (offset + (int)sizeof(struct bsmmsg_rpinfo)
1234 > buflen) {
1235 if (PIM_DEBUG_BSM)
1236 zlog_debug(
1237 "%s, buflen received: %u is less than the internal data structure of the packet would suggest",
1238 __func__, buflen);
1239 return false;
1240 }
1241
1242 /* Extract RP address tlv from BSM */
1243 memcpy(&rpinfo, buf, sizeof(struct bsmmsg_rpinfo));
1244 rpinfo.rp_holdtime = ntohs(rpinfo.rp_holdtime);
1245 buf += sizeof(struct bsmmsg_rpinfo);
1246 offset += sizeof(struct bsmmsg_rpinfo);
1247
1248 if (PIM_DEBUG_BSM) {
1249 char rp_str[INET_ADDRSTRLEN];
1250
1251 pim_inet4_dump("<Rpaddr?>", rpinfo.rpaddr.addr,
1252 rp_str, sizeof(rp_str));
1253 zlog_debug(
1254 "%s, Rp address - %s; pri:%d hold:%d",
1255 __func__, rp_str, rpinfo.rp_pri,
1256 rpinfo.rp_holdtime);
1257 }
1258
1259 /* Call Install api to update grp-rp mappings */
1260 if (pim_install_bsm_grp_rp(scope->pim, bsgrp, &rpinfo))
1261 ins_count++;
1262 }
1263
1264 bsgrp->pend_rp_cnt -= ins_count;
1265
1266 if (!bsgrp->pend_rp_cnt) {
1267 if (PIM_DEBUG_BSM)
1268 zlog_debug(
1269 "%s, Recvd all the rps for this group, so bsrp list with penidng rp list.",
1270 __func__);
1271 /* replace the bsrp_list with pending list */
1272 pim_instate_pend_list(bsgrp);
1273 }
1274 }
1275 return true;
1276 }
1277
1278 int pim_bsm_process(struct interface *ifp, pim_sgaddr *sg, uint8_t *buf,
1279 uint32_t buf_size, bool no_fwd)
1280 {
1281 struct bsm_hdr *bshdr;
1282 int sz = PIM_GBL_SZ_ID;
1283 struct bsmmsg_grpinfo *msg_grp;
1284 struct pim_interface *pim_ifp = NULL;
1285 struct bsm_frag *bsfrag;
1286 struct pim_instance *pim;
1287 char bsr_str[INET_ADDRSTRLEN];
1288 uint16_t frag_tag;
1289 bool empty_bsm = false;
1290
1291 /* BSM Packet acceptance validation */
1292 pim_ifp = ifp->info;
1293 if (!pim_ifp) {
1294 if (PIM_DEBUG_BSM)
1295 zlog_debug("%s: multicast not enabled on interface %s",
1296 __func__, ifp->name);
1297 return -1;
1298 }
1299
1300 if (pim_ifp->pim_passive_enable) {
1301 if (PIM_DEBUG_PIM_PACKETS)
1302 zlog_debug(
1303 "skip receiving PIM message on passive interface %s",
1304 ifp->name);
1305 return 0;
1306 }
1307
1308 pim_ifp->pim_ifstat_bsm_rx++;
1309 pim = pim_ifp->pim;
1310 pim->bsm_rcvd++;
1311
1312 /* Drop if bsm processing is disabled on interface */
1313 if (!pim_ifp->bsm_enable) {
1314 zlog_warn("%s: BSM not enabled on interface %s", __func__,
1315 ifp->name);
1316 pim_ifp->pim_ifstat_bsm_cfg_miss++;
1317 pim->bsm_dropped++;
1318 return -1;
1319 }
1320
1321 if (buf_size < (PIM_MSG_HEADER_LEN + sizeof(struct bsm_hdr))) {
1322 if (PIM_DEBUG_BSM)
1323 zlog_debug(
1324 "%s: received buffer length of %d which is too small to properly decode",
1325 __func__, buf_size);
1326 return -1;
1327 }
1328
1329 bshdr = (struct bsm_hdr *)(buf + PIM_MSG_HEADER_LEN);
1330 pim_inet4_dump("<bsr?>", bshdr->bsr_addr.addr, bsr_str,
1331 sizeof(bsr_str));
1332 if (bshdr->hm_len > IPV4_MAX_BITLEN) {
1333 zlog_warn("Bad hashmask length for IPv4; got %hhu, expected value in range 0-32",
1334 bshdr->hm_len);
1335 pim->bsm_dropped++;
1336 return -1;
1337 }
1338 pim->global_scope.hashMasklen = bshdr->hm_len;
1339 frag_tag = ntohs(bshdr->frag_tag);
1340
1341 /* Identify empty BSM */
1342 if ((buf_size - PIM_BSM_HDR_LEN - PIM_MSG_HEADER_LEN) < PIM_BSM_GRP_LEN)
1343 empty_bsm = true;
1344
1345 if (!empty_bsm) {
1346 msg_grp = (struct bsmmsg_grpinfo *)(buf + PIM_MSG_HEADER_LEN
1347 + PIM_BSM_HDR_LEN);
1348 /* Currently we don't support scope zoned BSM */
1349 if (msg_grp->group.sz) {
1350 if (PIM_DEBUG_BSM)
1351 zlog_debug(
1352 "%s : Administratively scoped range BSM received",
1353 __func__);
1354 pim_ifp->pim_ifstat_bsm_invalid_sz++;
1355 pim->bsm_dropped++;
1356 return -1;
1357 }
1358 }
1359
1360 /* Drop if bsr is not preferred bsr */
1361 if (!is_preferred_bsr(pim, bshdr->bsr_addr.addr, bshdr->bsr_prio)) {
1362 if (PIM_DEBUG_BSM)
1363 zlog_debug("%s : Received a non-preferred BSM",
1364 __func__);
1365 pim->bsm_dropped++;
1366 return -1;
1367 }
1368
1369 if (no_fwd) {
1370 /* only accept no-forward BSM if quick refresh on startup */
1371 if ((pim->global_scope.accept_nofwd_bsm)
1372 || (frag_tag == pim->global_scope.bsm_frag_tag)) {
1373 pim->global_scope.accept_nofwd_bsm = false;
1374 } else {
1375 if (PIM_DEBUG_BSM)
1376 zlog_debug(
1377 "%s : nofwd_bsm received on %s when accpt_nofwd_bsm false",
1378 __func__, bsr_str);
1379 pim->bsm_dropped++;
1380 pim_ifp->pim_ifstat_ucast_bsm_cfg_miss++;
1381 return -1;
1382 }
1383 }
1384
1385 #if PIM_IPV == 4
1386 if (!pim_addr_cmp(sg->grp, qpim_all_pim_routers_addr))
1387 #else
1388 if (0)
1389 #endif
1390 {
1391 #if PIM_IPV == 4
1392 /* Multicast BSMs are only accepted if source interface & IP
1393 * match RPF towards the BSR's IP address, or they have
1394 * no-forward set
1395 */
1396 if (!no_fwd && !pim_nht_bsr_rpf_check(pim, bshdr->bsr_addr.addr,
1397 ifp, sg->src)) {
1398 if (PIM_DEBUG_BSM)
1399 zlog_debug(
1400 "BSM check: RPF to BSR %s is not %pPA%%%s",
1401 bsr_str, &sg->src, ifp->name);
1402 pim->bsm_dropped++;
1403 return -1;
1404 }
1405 } else if (if_address_is_local(&sg->grp, PIM_AF, pim->vrf->vrf_id)) {
1406 /* Unicast BSM received - if ucast bsm not enabled on
1407 * the interface, drop it
1408 */
1409 if (!pim_ifp->ucast_bsm_accept) {
1410 if (PIM_DEBUG_BSM)
1411 zlog_debug(
1412 "%s : Unicast BSM not enabled on interface %s",
1413 __func__, ifp->name);
1414 pim_ifp->pim_ifstat_ucast_bsm_cfg_miss++;
1415 pim->bsm_dropped++;
1416 return -1;
1417 }
1418
1419 } else {
1420 if (PIM_DEBUG_BSM)
1421 zlog_debug("%s : Invalid destination address",
1422 __func__);
1423 pim->bsm_dropped++;
1424 return -1;
1425 }
1426
1427 if (empty_bsm) {
1428 if (PIM_DEBUG_BSM)
1429 zlog_debug("%s : Empty Pref BSM received", __func__);
1430 }
1431 /* Parse Update bsm rp table and install/uninstall rp if required */
1432 if (!pim_bsm_parse_install_g2rp(
1433 &pim_ifp->pim->global_scope,
1434 (buf + PIM_BSM_HDR_LEN + PIM_MSG_HEADER_LEN),
1435 (buf_size - PIM_BSM_HDR_LEN - PIM_MSG_HEADER_LEN),
1436 frag_tag)) {
1437 if (PIM_DEBUG_BSM) {
1438 zlog_debug("%s, Parsing BSM failed.", __func__);
1439 }
1440 pim->bsm_dropped++;
1441 return -1;
1442 }
1443 /* Restart the bootstrap timer */
1444 pim_bs_timer_restart(&pim_ifp->pim->global_scope,
1445 PIM_BSR_DEFAULT_TIMEOUT);
1446
1447 /* If new BSM received, clear the old bsm database */
1448 if (pim_ifp->pim->global_scope.bsm_frag_tag != frag_tag) {
1449 if (PIM_DEBUG_BSM) {
1450 zlog_debug("%s: Current frag tag: %d Frag teg rcvd: %d",
1451 __func__,
1452 pim_ifp->pim->global_scope.bsm_frag_tag,
1453 frag_tag);
1454 }
1455 pim_bsm_frags_free(&pim_ifp->pim->global_scope);
1456 pim_ifp->pim->global_scope.bsm_frag_tag = frag_tag;
1457 }
1458
1459 /* update the scope information from bsm */
1460 pim_bsm_update(pim, bshdr->bsr_addr.addr, bshdr->bsr_prio);
1461
1462 if (!no_fwd) {
1463 pim_bsm_fwd_whole_sz(pim_ifp->pim, buf, buf_size, sz);
1464 bsfrag = XCALLOC(MTYPE_PIM_BSM_FRAG,
1465 sizeof(struct bsm_frag) + buf_size);
1466
1467 bsfrag->size = buf_size;
1468 memcpy(bsfrag->data, buf, buf_size);
1469 bsm_frags_add_tail(pim_ifp->pim->global_scope.bsm_frags,
1470 bsfrag);
1471 }
1472
1473 return 0;
1474 }