]> git.proxmox.com Git - mirror_frr.git/blob - pimd/pim_upstream.c
projects / mirror_frr.git / blob
? search:
summary | shortlog | log | commit | commitdiff | tree
blame | history | raw | HEAD
Merge pull request #1298 from opensourcerouting/iface-rb-tree
[mirror_frr.git] / pimd / pim_upstream.c
1 /*
2 * PIM for Quagga
3 * Copyright (C) 2008 Everton da Silva Marques
4 *
5 * This program is free software; you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License as published by
7 * the Free Software Foundation; either version 2 of the License, or
8 * (at your option) any later version.
9 *
10 * This program is distributed in the hope that it will be useful, but
11 * WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13 * General Public License for more details.
14 *
15 * You should have received a copy of the GNU General Public License along
16 * with this program; see the file COPYING; if not, write to the Free Software
17 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
18 */
19
20 #include <zebra.h>
21
22 #include "zebra/rib.h"
23
24 #include "log.h"
25 #include "zclient.h"
26 #include "memory.h"
27 #include "thread.h"
28 #include "linklist.h"
29 #include "vty.h"
30 #include "plist.h"
31 #include "hash.h"
32 #include "jhash.h"
33 #include "wheel.h"
34
35 #include "pimd.h"
36 #include "pim_pim.h"
37 #include "pim_str.h"
38 #include "pim_time.h"
39 #include "pim_iface.h"
40 #include "pim_join.h"
41 #include "pim_zlookup.h"
42 #include "pim_upstream.h"
43 #include "pim_ifchannel.h"
44 #include "pim_neighbor.h"
45 #include "pim_rpf.h"
46 #include "pim_zebra.h"
47 #include "pim_oil.h"
48 #include "pim_macro.h"
49 #include "pim_rp.h"
50 #include "pim_br.h"
51 #include "pim_register.h"
52 #include "pim_msdp.h"
53 #include "pim_jp_agg.h"
54 #include "pim_nht.h"
55 #include "pim_ssm.h"
56
57 static void join_timer_stop(struct pim_upstream *up);
58 static void
59 pim_upstream_update_assert_tracking_desired(struct pim_upstream *up);
60
61 /*
62 * A (*,G) or a (*,*) is going away
63 * remove the parent pointer from
64 * those pointing at us
65 */
66 static void pim_upstream_remove_children(struct pim_instance *pim,
67 struct pim_upstream *up)
68 {
69 struct pim_upstream *child;
70
71 if (!up->sources)
72 return;
73
74 while (!list_isempty(up->sources)) {
75 child = listnode_head(up->sources);
76 listnode_delete(up->sources, child);
77 if (PIM_UPSTREAM_FLAG_TEST_SRC_LHR(child->flags)) {
78 PIM_UPSTREAM_FLAG_UNSET_SRC_LHR(child->flags);
79 child = pim_upstream_del(pim, child,
80 __PRETTY_FUNCTION__);
81 }
82 if (child)
83 child->parent = NULL;
84 }
85 list_delete_and_null(&up->sources);
86 }
87
88 /*
89 * A (*,G) or a (*,*) is being created
90 * Find the children that would point
91 * at us.
92 */
93 static void pim_upstream_find_new_children(struct pim_instance *pim,
94 struct pim_upstream *up)
95 {
96 struct pim_upstream *child;
97 struct listnode *ch_node;
98
99 if ((up->sg.src.s_addr != INADDR_ANY)
100 && (up->sg.grp.s_addr != INADDR_ANY))
101 return;
102
103 if ((up->sg.src.s_addr == INADDR_ANY)
104 && (up->sg.grp.s_addr == INADDR_ANY))
105 return;
106
107 for (ALL_LIST_ELEMENTS_RO(pim->upstream_list, ch_node, child)) {
108 if ((up->sg.grp.s_addr != INADDR_ANY)
109 && (child->sg.grp.s_addr == up->sg.grp.s_addr)
110 && (child != up)) {
111 child->parent = up;
112 listnode_add_sort(up->sources, child);
113 }
114 }
115 }
116
117 /*
118 * If we have a (*,*) || (S,*) there is no parent
119 * If we have a (S,G), find the (*,G)
120 * If we have a (*,G), find the (*,*)
121 */
122 static struct pim_upstream *pim_upstream_find_parent(struct pim_instance *pim,
123 struct pim_upstream *child)
124 {
125 struct prefix_sg any = child->sg;
126 struct pim_upstream *up = NULL;
127
128 // (S,G)
129 if ((child->sg.src.s_addr != INADDR_ANY)
130 && (child->sg.grp.s_addr != INADDR_ANY)) {
131 any.src.s_addr = INADDR_ANY;
132 up = pim_upstream_find(pim, &any);
133
134 if (up)
135 listnode_add(up->sources, child);
136
137 return up;
138 }
139
140 return NULL;
141 }
142
143 void pim_upstream_free(struct pim_upstream *up)
144 {
145 XFREE(MTYPE_PIM_UPSTREAM, up);
146 up = NULL;
147 }
148
149 static void upstream_channel_oil_detach(struct pim_upstream *up)
150 {
151 if (up->channel_oil) {
152 /* Detaching from channel_oil, channel_oil may exist post del,
153 but upstream would not keep reference of it
154 */
155 up->channel_oil->up = NULL;
156 pim_channel_oil_del(up->channel_oil);
157 up->channel_oil = NULL;
158 }
159 }
160
161 struct pim_upstream *pim_upstream_del(struct pim_instance *pim,
162 struct pim_upstream *up, const char *name)
163 {
164 bool notify_msdp = false;
165 struct prefix nht_p;
166
167 if (PIM_DEBUG_TRACE)
168 zlog_debug(
169 "%s(%s): Delete %s[%s] ref count: %d , flags: %d c_oil ref count %d (Pre decrement)",
170 __PRETTY_FUNCTION__, name, up->sg_str,
171 pim->vrf->name, up->ref_count,
172 up->flags, up->channel_oil->oil_ref_count);
173
174 --up->ref_count;
175
176 if (up->ref_count >= 1)
177 return up;
178
179 THREAD_OFF(up->t_ka_timer);
180 THREAD_OFF(up->t_rs_timer);
181 THREAD_OFF(up->t_msdp_reg_timer);
182
183 if (up->join_state == PIM_UPSTREAM_JOINED) {
184 pim_jp_agg_single_upstream_send(&up->rpf, up, 0);
185
186 if (up->sg.src.s_addr == INADDR_ANY) {
187 /* if a (*, G) entry in the joined state is being
188 * deleted we
189 * need to notify MSDP */
190 notify_msdp = true;
191 }
192 }
193
194 join_timer_stop(up);
195 pim_jp_agg_upstream_verification(up, false);
196 up->rpf.source_nexthop.interface = NULL;
197
198 if (up->sg.src.s_addr != INADDR_ANY) {
199 wheel_remove_item(pim->upstream_sg_wheel, up);
200 notify_msdp = true;
201 }
202
203 pim_upstream_remove_children(pim, up);
204 if (up->sources)
205 list_delete_and_null(&up->sources);
206
207 pim_mroute_del(up->channel_oil, __PRETTY_FUNCTION__);
208 upstream_channel_oil_detach(up);
209
210 list_delete_and_null(&up->ifchannels);
211
212 /*
213 notice that listnode_delete() can't be moved
214 into pim_upstream_free() because the later is
215 called by list_delete_all_node()
216 */
217 if (up->parent && up->parent->sources)
218 listnode_delete(up->parent->sources, up);
219 up->parent = NULL;
220
221 listnode_delete(pim->upstream_list, up);
222 hash_release(pim->upstream_hash, up);
223
224 if (notify_msdp) {
225 pim_msdp_up_del(pim, &up->sg);
226 }
227
228 /* Deregister addr with Zebra NHT */
229 nht_p.family = AF_INET;
230 nht_p.prefixlen = IPV4_MAX_BITLEN;
231 nht_p.u.prefix4 = up->upstream_addr;
232 if (PIM_DEBUG_TRACE) {
233 char buf[PREFIX2STR_BUFFER];
234 prefix2str(&nht_p, buf, sizeof(buf));
235 zlog_debug("%s: Deregister upstream %s addr %s with Zebra NHT",
236 __PRETTY_FUNCTION__, up->sg_str, buf);
237 }
238 pim_delete_tracked_nexthop(pim, &nht_p, up, NULL);
239
240 pim_upstream_free(up);
241
242 return NULL;
243 }
244
245 void pim_upstream_send_join(struct pim_upstream *up)
246 {
247 if (PIM_DEBUG_TRACE) {
248 char rpf_str[PREFIX_STRLEN];
249 pim_addr_dump("<rpf?>", &up->rpf.rpf_addr, rpf_str,
250 sizeof(rpf_str));
251 zlog_debug("%s: RPF'%s=%s(%s) for Interface %s",
252 __PRETTY_FUNCTION__, up->sg_str, rpf_str,
253 pim_upstream_state2str(up->join_state),
254 up->rpf.source_nexthop.interface->name);
255 if (pim_rpf_addr_is_inaddr_any(&up->rpf)) {
256 zlog_debug("%s: can't send join upstream: RPF'%s=%s",
257 __PRETTY_FUNCTION__, up->sg_str, rpf_str);
258 /* warning only */
259 }
260 }
261
262 /* send Join(S,G) to the current upstream neighbor */
263 pim_jp_agg_single_upstream_send(&up->rpf, up, 1 /* join */);
264 }
265
266 static int on_join_timer(struct thread *t)
267 {
268 struct pim_upstream *up;
269
270 up = THREAD_ARG(t);
271
272 /*
273 * In the case of a HFR we will not ahve anyone to send this to.
274 */
275 if (PIM_UPSTREAM_FLAG_TEST_FHR(up->flags))
276 return 0;
277
278 /*
279 * Don't send the join if the outgoing interface is a loopback
280 * But since this might change leave the join timer running
281 */
282 if (up->rpf.source_nexthop
283 .interface && !if_is_loopback(up->rpf.source_nexthop.interface))
284 pim_upstream_send_join(up);
285
286 join_timer_start(up);
287
288 return 0;
289 }
290
291 static void join_timer_stop(struct pim_upstream *up)
292 {
293 struct pim_neighbor *nbr;
294
295 THREAD_OFF(up->t_join_timer);
296
297 nbr = pim_neighbor_find(up->rpf.source_nexthop.interface,
298 up->rpf.rpf_addr.u.prefix4);
299
300 if (nbr)
301 pim_jp_agg_remove_group(nbr->upstream_jp_agg, up);
302
303 pim_jp_agg_upstream_verification(up, false);
304 }
305
306 void join_timer_start(struct pim_upstream *up)
307 {
308 struct pim_neighbor *nbr = NULL;
309
310 if (up->rpf.source_nexthop.interface) {
311 nbr = pim_neighbor_find(up->rpf.source_nexthop.interface,
312 up->rpf.rpf_addr.u.prefix4);
313
314 if (PIM_DEBUG_PIM_EVENTS) {
315 zlog_debug(
316 "%s: starting %d sec timer for upstream (S,G)=%s",
317 __PRETTY_FUNCTION__, qpim_t_periodic,
318 up->sg_str);
319 }
320 }
321
322 if (nbr)
323 pim_jp_agg_add_group(nbr->upstream_jp_agg, up, 1);
324 else {
325 THREAD_OFF(up->t_join_timer);
326 thread_add_timer(master, on_join_timer, up, qpim_t_periodic,
327 &up->t_join_timer);
328 }
329 pim_jp_agg_upstream_verification(up, true);
330 }
331
332 /*
333 * This is only called when we are switching the upstream
334 * J/P from one neighbor to another
335 *
336 * As such we need to remove from the old list and
337 * add to the new list.
338 */
339 void pim_upstream_join_timer_restart(struct pim_upstream *up,
340 struct pim_rpf *old)
341 {
342 // THREAD_OFF(up->t_join_timer);
343 join_timer_start(up);
344 }
345
346 static void pim_upstream_join_timer_restart_msec(struct pim_upstream *up,
347 int interval_msec)
348 {
349 if (PIM_DEBUG_PIM_EVENTS) {
350 zlog_debug("%s: restarting %d msec timer for upstream (S,G)=%s",
351 __PRETTY_FUNCTION__, interval_msec, up->sg_str);
352 }
353
354 THREAD_OFF(up->t_join_timer);
355 thread_add_timer_msec(master, on_join_timer, up, interval_msec,
356 &up->t_join_timer);
357 }
358
359 void pim_upstream_join_suppress(struct pim_upstream *up,
360 struct in_addr rpf_addr, int holdtime)
361 {
362 long t_joinsuppress_msec;
363 long join_timer_remain_msec;
364
365 t_joinsuppress_msec =
366 MIN(pim_if_t_suppressed_msec(up->rpf.source_nexthop.interface),
367 1000 * holdtime);
368
369 join_timer_remain_msec = pim_time_timer_remain_msec(up->t_join_timer);
370
371 if (PIM_DEBUG_TRACE) {
372 char rpf_str[INET_ADDRSTRLEN];
373 pim_inet4_dump("<rpf?>", rpf_addr, rpf_str, sizeof(rpf_str));
374 zlog_debug(
375 "%s %s: detected Join%s to RPF'(S,G)=%s: join_timer=%ld msec t_joinsuppress=%ld msec",
376 __FILE__, __PRETTY_FUNCTION__, up->sg_str, rpf_str,
377 join_timer_remain_msec, t_joinsuppress_msec);
378 }
379
380 if (join_timer_remain_msec < t_joinsuppress_msec) {
381 if (PIM_DEBUG_TRACE) {
382 zlog_debug(
383 "%s %s: suppressing Join(S,G)=%s for %ld msec",
384 __FILE__, __PRETTY_FUNCTION__, up->sg_str,
385 t_joinsuppress_msec);
386 }
387
388 pim_upstream_join_timer_restart_msec(up, t_joinsuppress_msec);
389 }
390 }
391
392 void pim_upstream_join_timer_decrease_to_t_override(const char *debug_label,
393 struct pim_upstream *up)
394 {
395 long join_timer_remain_msec;
396 int t_override_msec;
397
398 join_timer_remain_msec = pim_time_timer_remain_msec(up->t_join_timer);
399 t_override_msec =
400 pim_if_t_override_msec(up->rpf.source_nexthop.interface);
401
402 if (PIM_DEBUG_TRACE) {
403 char rpf_str[INET_ADDRSTRLEN];
404 pim_inet4_dump("<rpf?>", up->rpf.rpf_addr.u.prefix4, rpf_str,
405 sizeof(rpf_str));
406 zlog_debug(
407 "%s: to RPF'%s=%s: join_timer=%ld msec t_override=%d msec",
408 debug_label, up->sg_str, rpf_str,
409 join_timer_remain_msec, t_override_msec);
410 }
411
412 if (join_timer_remain_msec > t_override_msec) {
413 if (PIM_DEBUG_TRACE) {
414 zlog_debug(
415 "%s: decreasing (S,G)=%s join timer to t_override=%d msec",
416 debug_label, up->sg_str, t_override_msec);
417 }
418
419 pim_upstream_join_timer_restart_msec(up, t_override_msec);
420 }
421 }
422
423 static void forward_on(struct pim_upstream *up)
424 {
425 struct listnode *chnode;
426 struct listnode *chnextnode;
427 struct pim_ifchannel *ch = NULL;
428
429 /* scan (S,G) state */
430 for (ALL_LIST_ELEMENTS(up->ifchannels, chnode, chnextnode, ch)) {
431 if (pim_macro_chisin_oiflist(ch))
432 pim_forward_start(ch);
433
434 } /* scan iface channel list */
435 }
436
437 static void forward_off(struct pim_upstream *up)
438 {
439 struct listnode *chnode;
440 struct listnode *chnextnode;
441 struct pim_ifchannel *ch;
442
443 /* scan per-interface (S,G) state */
444 for (ALL_LIST_ELEMENTS(up->ifchannels, chnode, chnextnode, ch)) {
445
446 pim_forward_stop(ch, false);
447
448 } /* scan iface channel list */
449 }
450
451 static int pim_upstream_could_register(struct pim_upstream *up)
452 {
453 struct pim_interface *pim_ifp = NULL;
454
455 if (up->rpf.source_nexthop.interface)
456 pim_ifp = up->rpf.source_nexthop.interface->info;
457 else {
458 if (PIM_DEBUG_TRACE)
459 zlog_debug("%s: up %s RPF is not present",
460 __PRETTY_FUNCTION__, up->sg_str);
461 }
462
463 if (pim_ifp && PIM_I_am_DR(pim_ifp)
464 && pim_if_connected_to_source(up->rpf.source_nexthop.interface,
465 up->sg.src))
466 return 1;
467
468 return 0;
469 }
470
471 /* Source registration is supressed for SSM groups. When the SSM range changes
472 * we re-revaluate register setup for existing upstream entries */
473 void pim_upstream_register_reevaluate(struct pim_instance *pim)
474 {
475 struct listnode *upnode;
476 struct pim_upstream *up;
477
478 for (ALL_LIST_ELEMENTS_RO(pim->upstream_list, upnode, up)) {
479 /* If FHR is set CouldRegister is True. Also check if the flow
480 * is actually active; if it is not kat setup will trigger
481 * source
482 * registration whenever the flow becomes active. */
483 if (!PIM_UPSTREAM_FLAG_TEST_FHR(up->flags) || !up->t_ka_timer)
484 continue;
485
486 if (pim_is_grp_ssm(pim, up->sg.grp)) {
487 /* clear the register state for SSM groups */
488 if (up->reg_state != PIM_REG_NOINFO) {
489 if (PIM_DEBUG_PIM_EVENTS)
490 zlog_debug(
491 "Clear register for %s as G is now SSM",
492 up->sg_str);
493 /* remove regiface from the OIL if it is there*/
494 pim_channel_del_oif(up->channel_oil,
495 pim->regiface,
496 PIM_OIF_FLAG_PROTO_PIM);
497 up->reg_state = PIM_REG_NOINFO;
498 }
499 } else {
500 /* register ASM sources with the RP */
501 if (up->reg_state == PIM_REG_NOINFO) {
502 if (PIM_DEBUG_PIM_EVENTS)
503 zlog_debug(
504 "Register %s as G is now ASM",
505 up->sg_str);
506 pim_channel_add_oif(up->channel_oil,
507 pim->regiface,
508 PIM_OIF_FLAG_PROTO_PIM);
509 up->reg_state = PIM_REG_JOIN;
510 }
511 }
512 }
513 }
514
515 void pim_upstream_switch(struct pim_instance *pim, struct pim_upstream *up,
516 enum pim_upstream_state new_state)
517 {
518 enum pim_upstream_state old_state = up->join_state;
519
520 if (PIM_DEBUG_PIM_EVENTS) {
521 zlog_debug("%s: PIM_UPSTREAM_%s: (S,G) old: %s new: %s",
522 __PRETTY_FUNCTION__, up->sg_str,
523 pim_upstream_state2str(up->join_state),
524 pim_upstream_state2str(new_state));
525 }
526
527 up->join_state = new_state;
528 if (old_state != new_state)
529 up->state_transition = pim_time_monotonic_sec();
530
531 pim_upstream_update_assert_tracking_desired(up);
532
533 if (new_state == PIM_UPSTREAM_JOINED) {
534 if (old_state != PIM_UPSTREAM_JOINED) {
535 int old_fhr = PIM_UPSTREAM_FLAG_TEST_FHR(up->flags);
536 forward_on(up);
537 pim_msdp_up_join_state_changed(pim, up);
538 if (pim_upstream_could_register(up)) {
539 PIM_UPSTREAM_FLAG_SET_FHR(up->flags);
540 if (!old_fhr
541 && PIM_UPSTREAM_FLAG_TEST_SRC_STREAM(
542 up->flags)) {
543 pim_upstream_keep_alive_timer_start(
544 up, pim->keep_alive_time);
545 pim_register_join(up);
546 }
547 } else {
548 pim_upstream_send_join(up);
549 join_timer_start(up);
550 }
551 } else {
552 forward_on(up);
553 }
554 } else {
555
556 forward_off(up);
557 if (old_state == PIM_UPSTREAM_JOINED)
558 pim_msdp_up_join_state_changed(pim, up);
559
560 /* IHR, Trigger SGRpt on *,G IIF to prune S,G from RPT towards
561 RP.
562 If I am RP for G then send S,G prune to its IIF. */
563 if (pim_upstream_is_sg_rpt(up) && up->parent
564 && !I_am_RP(pim, up->sg.grp)) {
565 if (PIM_DEBUG_PIM_TRACE_DETAIL)
566 zlog_debug(
567 "%s: *,G IIF %s S,G IIF %s ",
568 __PRETTY_FUNCTION__,
569 up->parent->rpf.source_nexthop
570 .interface->name,
571 up->rpf.source_nexthop.interface->name);
572 pim_jp_agg_single_upstream_send(&up->parent->rpf,
573 up->parent,
574 1 /* (W,G) Join */);
575 } else
576 pim_jp_agg_single_upstream_send(&up->rpf, up,
577 0 /* prune */);
578 join_timer_stop(up);
579 }
580 }
581
582 int pim_upstream_compare(void *arg1, void *arg2)
583 {
584 const struct pim_upstream *up1 = (const struct pim_upstream *)arg1;
585 const struct pim_upstream *up2 = (const struct pim_upstream *)arg2;
586
587 if (ntohl(up1->sg.grp.s_addr) < ntohl(up2->sg.grp.s_addr))
588 return -1;
589
590 if (ntohl(up1->sg.grp.s_addr) > ntohl(up2->sg.grp.s_addr))
591 return 1;
592
593 if (ntohl(up1->sg.src.s_addr) < ntohl(up2->sg.src.s_addr))
594 return -1;
595
596 if (ntohl(up1->sg.src.s_addr) > ntohl(up2->sg.src.s_addr))
597 return 1;
598
599 return 0;
600 }
601
602 static struct pim_upstream *pim_upstream_new(struct pim_instance *pim,
603 struct prefix_sg *sg,
604 struct interface *incoming,
605 int flags,
606 struct pim_ifchannel *ch)
607 {
608 enum pim_rpf_result rpf_result;
609 struct pim_interface *pim_ifp;
610 struct pim_upstream *up;
611
612 up = XCALLOC(MTYPE_PIM_UPSTREAM, sizeof(*up));
613 if (!up) {
614 zlog_err("%s: PIM XCALLOC(%zu) failure", __PRETTY_FUNCTION__,
615 sizeof(*up));
616 return NULL;
617 }
618
619 up->sg = *sg;
620 pim_str_sg_set(sg, up->sg_str);
621 if (ch)
622 ch->upstream = up;
623
624 up = hash_get(pim->upstream_hash, up, hash_alloc_intern);
625 if (!pim_rp_set_upstream_addr(pim, &up->upstream_addr, sg->src,
626 sg->grp)) {
627 if (PIM_DEBUG_TRACE)
628 zlog_debug("%s: Received a (*,G) with no RP configured",
629 __PRETTY_FUNCTION__);
630
631 hash_release(pim->upstream_hash, up);
632 XFREE(MTYPE_PIM_UPSTREAM, up);
633 return NULL;
634 }
635
636 up->parent = pim_upstream_find_parent(pim, up);
637 if (up->sg.src.s_addr == INADDR_ANY) {
638 up->sources = list_new();
639 up->sources->cmp = pim_upstream_compare;
640 } else
641 up->sources = NULL;
642
643 pim_upstream_find_new_children(pim, up);
644 up->flags = flags;
645 up->ref_count = 1;
646 up->t_join_timer = NULL;
647 up->t_ka_timer = NULL;
648 up->t_rs_timer = NULL;
649 up->t_msdp_reg_timer = NULL;
650 up->join_state = PIM_UPSTREAM_NOTJOINED;
651 up->reg_state = PIM_REG_NOINFO;
652 up->state_transition = pim_time_monotonic_sec();
653 up->channel_oil = NULL;
654 up->sptbit = PIM_UPSTREAM_SPTBIT_FALSE;
655
656 up->rpf.source_nexthop.interface = NULL;
657 up->rpf.source_nexthop.mrib_nexthop_addr.family = AF_INET;
658 up->rpf.source_nexthop.mrib_nexthop_addr.u.prefix4.s_addr =
659 PIM_NET_INADDR_ANY;
660 up->rpf.source_nexthop.mrib_metric_preference =
661 qpim_infinite_assert_metric.metric_preference;
662 up->rpf.source_nexthop.mrib_route_metric =
663 qpim_infinite_assert_metric.route_metric;
664 up->rpf.rpf_addr.family = AF_INET;
665 up->rpf.rpf_addr.u.prefix4.s_addr = PIM_NET_INADDR_ANY;
666
667 up->ifchannels = list_new();
668 up->ifchannels->cmp = (int (*)(void *, void *))pim_ifchannel_compare;
669
670 if (up->sg.src.s_addr != INADDR_ANY)
671 wheel_add_item(pim->upstream_sg_wheel, up);
672
673 rpf_result = pim_rpf_update(pim, up, NULL, 1);
674 if (rpf_result == PIM_RPF_FAILURE) {
675 struct prefix nht_p;
676
677 if (PIM_DEBUG_TRACE)
678 zlog_debug(
679 "%s: Attempting to create upstream(%s), Unable to RPF for source",
680 __PRETTY_FUNCTION__, up->sg_str);
681
682 nht_p.family = AF_INET;
683 nht_p.prefixlen = IPV4_MAX_BITLEN;
684 nht_p.u.prefix4 = up->upstream_addr;
685 pim_delete_tracked_nexthop(pim, &nht_p, up, NULL);
686
687 if (up->parent) {
688 listnode_delete(up->parent->sources, up);
689 up->parent = NULL;
690 }
691
692 if (up->sg.src.s_addr != INADDR_ANY)
693 wheel_remove_item(pim->upstream_sg_wheel, up);
694
695 pim_upstream_remove_children(pim, up);
696 if (up->sources)
697 list_delete_and_null(&up->sources);
698
699 list_delete_and_null(&up->ifchannels);
700
701 hash_release(pim->upstream_hash, up);
702 XFREE(MTYPE_PIM_UPSTREAM, up);
703 return NULL;
704 }
705
706 if (up->rpf.source_nexthop.interface) {
707 pim_ifp = up->rpf.source_nexthop.interface->info;
708 if (pim_ifp)
709 up->channel_oil = pim_channel_oil_add(
710 pim, &up->sg, pim_ifp->mroute_vif_index);
711 }
712 listnode_add_sort(pim->upstream_list, up);
713
714 if (PIM_DEBUG_TRACE) {
715 zlog_debug(
716 "%s: Created Upstream %s upstream_addr %s ref count %d increment",
717 __PRETTY_FUNCTION__, up->sg_str,
718 inet_ntoa(up->upstream_addr), up->ref_count);
719 }
720
721 return up;
722 }
723
724 struct pim_upstream *pim_upstream_find(struct pim_instance *pim,
725 struct prefix_sg *sg)
726 {
727 struct pim_upstream lookup;
728 struct pim_upstream *up = NULL;
729
730 lookup.sg = *sg;
731 up = hash_lookup(pim->upstream_hash, &lookup);
732 return up;
733 }
734
735 struct pim_upstream *pim_upstream_find_or_add(struct prefix_sg *sg,
736 struct interface *incoming,
737 int flags, const char *name)
738 {
739 struct pim_upstream *up;
740 struct pim_interface *pim_ifp;
741
742 pim_ifp = incoming->info;
743
744 up = pim_upstream_find(pim_ifp->pim, sg);
745
746 if (up) {
747 if (!(up->flags & flags)) {
748 up->flags |= flags;
749 up->ref_count++;
750 if (PIM_DEBUG_TRACE)
751 zlog_debug(
752 "%s(%s): upstream %s ref count %d increment",
753 __PRETTY_FUNCTION__, name, up->sg_str,
754 up->ref_count);
755 }
756 } else
757 up = pim_upstream_add(pim_ifp->pim, sg, incoming, flags, name,
758 NULL);
759
760 return up;
761 }
762
763 void pim_upstream_ref(struct pim_upstream *up, int flags, const char *name)
764 {
765 up->flags |= flags;
766 ++up->ref_count;
767 if (PIM_DEBUG_TRACE)
768 zlog_debug("%s(%s): upstream %s ref count %d increment",
769 __PRETTY_FUNCTION__, name, up->sg_str,
770 up->ref_count);
771 }
772
773 struct pim_upstream *pim_upstream_add(struct pim_instance *pim,
774 struct prefix_sg *sg,
775 struct interface *incoming, int flags,
776 const char *name,
777 struct pim_ifchannel *ch)
778 {
779 struct pim_upstream *up = NULL;
780 int found = 0;
781
782 up = pim_upstream_find(pim, sg);
783 if (up) {
784 pim_upstream_ref(up, flags, name);
785 found = 1;
786 } else {
787 up = pim_upstream_new(pim, sg, incoming, flags, ch);
788 }
789
790 if (PIM_DEBUG_TRACE) {
791 if (up) {
792 char buf[PREFIX2STR_BUFFER];
793 prefix2str(&up->rpf.rpf_addr, buf, sizeof(buf));
794 zlog_debug("%s(%s): %s, iif %s (%s) found: %d: ref_count: %d",
795 __PRETTY_FUNCTION__, name,
796 up->sg_str, buf, up->rpf.source_nexthop.interface ?
797 up->rpf.source_nexthop.interface->name : "NIL" ,
798 found, up->ref_count);
799 } else
800 zlog_debug("%s(%s): (%s) failure to create",
801 __PRETTY_FUNCTION__, name,
802 pim_str_sg_dump(sg));
803 }
804
805 return up;
806 }
807
808 /*
809 * Passed in up must be the upstream for ch. starch is NULL if no
810 * information
811 */
812 int pim_upstream_evaluate_join_desired_interface(struct pim_upstream *up,
813 struct pim_ifchannel *ch,
814 struct pim_ifchannel *starch)
815 {
816 if (ch) {
817 if (PIM_IF_FLAG_TEST_S_G_RPT(ch->flags))
818 return 0;
819
820 if (!pim_macro_ch_lost_assert(ch)
821 && pim_macro_chisin_joins_or_include(ch))
822 return 1;
823 }
824
825 /*
826 * joins (*,G)
827 */
828 if (starch) {
829 if (PIM_IF_FLAG_TEST_S_G_RPT(starch->upstream->flags))
830 return 0;
831
832 if (!pim_macro_ch_lost_assert(starch)
833 && pim_macro_chisin_joins_or_include(starch))
834 return 1;
835 }
836
837 return 0;
838 }
839
840 /*
841 Evaluate JoinDesired(S,G):
842
843 JoinDesired(S,G) is true if there is a downstream (S,G) interface I
844 in the set:
845
846 inherited_olist(S,G) =
847 joins(S,G) (+) pim_include(S,G) (-) lost_assert(S,G)
848
849 JoinDesired(S,G) may be affected by changes in the following:
850
851 pim_ifp->primary_address
852 pim_ifp->pim_dr_addr
853 ch->ifassert_winner_metric
854 ch->ifassert_winner
855 ch->local_ifmembership
856 ch->ifjoin_state
857 ch->upstream->rpf.source_nexthop.mrib_metric_preference
858 ch->upstream->rpf.source_nexthop.mrib_route_metric
859 ch->upstream->rpf.source_nexthop.interface
860
861 See also pim_upstream_update_join_desired() below.
862 */
863 int pim_upstream_evaluate_join_desired(struct pim_instance *pim,
864 struct pim_upstream *up)
865 {
866 struct interface *ifp;
867 struct pim_ifchannel *ch, *starch;
868 struct pim_upstream *starup = up->parent;
869 int ret = 0;
870
871 FOR_ALL_INTERFACES (pim->vrf, ifp) {
872 if (!ifp->info)
873 continue;
874
875 ch = pim_ifchannel_find(ifp, &up->sg);
876
877 if (starup)
878 starch = pim_ifchannel_find(ifp, &starup->sg);
879 else
880 starch = NULL;
881
882 if (!ch && !starch)
883 continue;
884
885 ret += pim_upstream_evaluate_join_desired_interface(up, ch,
886 starch);
887 } /* scan iface channel list */
888
889 return ret; /* false */
890 }
891
892 /*
893 See also pim_upstream_evaluate_join_desired() above.
894 */
895 void pim_upstream_update_join_desired(struct pim_instance *pim,
896 struct pim_upstream *up)
897 {
898 int was_join_desired; /* boolean */
899 int is_join_desired; /* boolean */
900
901 was_join_desired = PIM_UPSTREAM_FLAG_TEST_DR_JOIN_DESIRED(up->flags);
902
903 is_join_desired = pim_upstream_evaluate_join_desired(pim, up);
904 if (is_join_desired)
905 PIM_UPSTREAM_FLAG_SET_DR_JOIN_DESIRED(up->flags);
906 else
907 PIM_UPSTREAM_FLAG_UNSET_DR_JOIN_DESIRED(up->flags);
908
909 /* switched from false to true */
910 if (is_join_desired && !was_join_desired) {
911 pim_upstream_switch(pim, up, PIM_UPSTREAM_JOINED);
912 return;
913 }
914
915 /* switched from true to false */
916 if (!is_join_desired && was_join_desired) {
917 pim_upstream_switch(pim, up, PIM_UPSTREAM_NOTJOINED);
918 return;
919 }
920 }
921
922 /*
923 RFC 4601 4.5.7. Sending (S,G) Join/Prune Messages
924 Transitions from Joined State
925 RPF'(S,G) GenID changes
926
927 The upstream (S,G) state machine remains in Joined state. If the
928 Join Timer is set to expire in more than t_override seconds, reset
929 it so that it expires after t_override seconds.
930 */
931 void pim_upstream_rpf_genid_changed(struct pim_instance *pim,
932 struct in_addr neigh_addr)
933 {
934 struct listnode *up_node;
935 struct listnode *up_nextnode;
936 struct pim_upstream *up;
937
938 /*
939 * Scan all (S,G) upstreams searching for RPF'(S,G)=neigh_addr
940 */
941 for (ALL_LIST_ELEMENTS(pim->upstream_list, up_node, up_nextnode, up)) {
942
943 if (PIM_DEBUG_TRACE) {
944 char neigh_str[INET_ADDRSTRLEN];
945 char rpf_addr_str[PREFIX_STRLEN];
946 pim_inet4_dump("<neigh?>", neigh_addr, neigh_str,
947 sizeof(neigh_str));
948 pim_addr_dump("<rpf?>", &up->rpf.rpf_addr, rpf_addr_str,
949 sizeof(rpf_addr_str));
950 zlog_debug(
951 "%s: matching neigh=%s against upstream (S,G)=%s[%s] joined=%d rpf_addr=%s",
952 __PRETTY_FUNCTION__, neigh_str, up->sg_str, pim->vrf->name,
953 up->join_state == PIM_UPSTREAM_JOINED,
954 rpf_addr_str);
955 }
956
957 /* consider only (S,G) upstream in Joined state */
958 if (up->join_state != PIM_UPSTREAM_JOINED)
959 continue;
960
961 /* match RPF'(S,G)=neigh_addr */
962 if (up->rpf.rpf_addr.u.prefix4.s_addr != neigh_addr.s_addr)
963 continue;
964
965 pim_upstream_join_timer_decrease_to_t_override(
966 "RPF'(S,G) GenID change", up);
967 }
968 }
969
970
971 void pim_upstream_rpf_interface_changed(struct pim_upstream *up,
972 struct interface *old_rpf_ifp)
973 {
974 struct listnode *chnode;
975 struct listnode *chnextnode;
976 struct pim_ifchannel *ch;
977
978 /* search all ifchannels */
979 for (ALL_LIST_ELEMENTS(up->ifchannels, chnode, chnextnode, ch)) {
980 if (ch->ifassert_state == PIM_IFASSERT_I_AM_LOSER) {
981 if (
982 /* RPF_interface(S) was NOT I */
983 (old_rpf_ifp == ch->interface) &&
984 /* RPF_interface(S) stopped being I */
985 (ch->upstream->rpf.source_nexthop
986 .interface != ch->interface)) {
987 assert_action_a5(ch);
988 }
989 } /* PIM_IFASSERT_I_AM_LOSER */
990
991 pim_ifchannel_update_assert_tracking_desired(ch);
992 }
993 }
994
995 void pim_upstream_update_could_assert(struct pim_upstream *up)
996 {
997 struct listnode *chnode;
998 struct listnode *chnextnode;
999 struct pim_ifchannel *ch;
1000
1001 /* scan per-interface (S,G) state */
1002 for (ALL_LIST_ELEMENTS(up->ifchannels, chnode, chnextnode, ch)) {
1003 pim_ifchannel_update_could_assert(ch);
1004 } /* scan iface channel list */
1005 }
1006
1007 void pim_upstream_update_my_assert_metric(struct pim_upstream *up)
1008 {
1009 struct listnode *chnode;
1010 struct listnode *chnextnode;
1011 struct pim_ifchannel *ch;
1012
1013 /* scan per-interface (S,G) state */
1014 for (ALL_LIST_ELEMENTS(up->ifchannels, chnode, chnextnode, ch)) {
1015 pim_ifchannel_update_my_assert_metric(ch);
1016
1017 } /* scan iface channel list */
1018 }
1019
1020 static void pim_upstream_update_assert_tracking_desired(struct pim_upstream *up)
1021 {
1022 struct listnode *chnode;
1023 struct listnode *chnextnode;
1024 struct pim_interface *pim_ifp;
1025 struct pim_ifchannel *ch;
1026
1027 /* scan per-interface (S,G) state */
1028 for (ALL_LIST_ELEMENTS(up->ifchannels, chnode, chnextnode, ch)) {
1029 if (!ch->interface)
1030 continue;
1031 pim_ifp = ch->interface->info;
1032 if (!pim_ifp)
1033 continue;
1034
1035 pim_ifchannel_update_assert_tracking_desired(ch);
1036
1037 } /* scan iface channel list */
1038 }
1039
1040 /* When kat is stopped CouldRegister goes to false so we need to
1041 * transition the (S, G) on FHR to NI state and remove reg tunnel
1042 * from the OIL */
1043 static void pim_upstream_fhr_kat_expiry(struct pim_instance *pim,
1044 struct pim_upstream *up)
1045 {
1046 if (!PIM_UPSTREAM_FLAG_TEST_FHR(up->flags))
1047 return;
1048
1049 if (PIM_DEBUG_TRACE)
1050 zlog_debug("kat expired on %s; clear fhr reg state",
1051 up->sg_str);
1052
1053 /* stop reg-stop timer */
1054 THREAD_OFF(up->t_rs_timer);
1055 /* remove regiface from the OIL if it is there*/
1056 pim_channel_del_oif(up->channel_oil, pim->regiface,
1057 PIM_OIF_FLAG_PROTO_PIM);
1058 /* clear the register state */
1059 up->reg_state = PIM_REG_NOINFO;
1060 PIM_UPSTREAM_FLAG_UNSET_FHR(up->flags);
1061 }
1062
1063 /* When kat is started CouldRegister can go to true. And if it does we
1064 * need to transition the (S, G) on FHR to JOINED state and add reg tunnel
1065 * to the OIL */
1066 static void pim_upstream_fhr_kat_start(struct pim_upstream *up)
1067 {
1068 if (pim_upstream_could_register(up)) {
1069 if (PIM_DEBUG_TRACE)
1070 zlog_debug(
1071 "kat started on %s; set fhr reg state to joined",
1072 up->sg_str);
1073
1074 PIM_UPSTREAM_FLAG_SET_FHR(up->flags);
1075 if (up->reg_state == PIM_REG_NOINFO)
1076 pim_register_join(up);
1077 }
1078 }
1079
1080 /*
1081 * On an RP, the PMBR value must be cleared when the
1082 * Keepalive Timer expires
1083 * KAT expiry indicates that flow is inactive. If the flow was created or
1084 * maintained by activity now is the time to deref it.
1085 */
1086 static int pim_upstream_keep_alive_timer(struct thread *t)
1087 {
1088 struct pim_upstream *up;
1089 struct pim_instance *pim;
1090
1091 up = THREAD_ARG(t);
1092 pim = up->channel_oil->pim;
1093
1094 if (I_am_RP(pim, up->sg.grp)) {
1095 pim_br_clear_pmbr(&up->sg);
1096 /*
1097 * We need to do more here :)
1098 * But this is the start.
1099 */
1100 }
1101
1102 /* source is no longer active - pull the SA from MSDP's cache */
1103 pim_msdp_sa_local_del(pim, &up->sg);
1104
1105 /* if entry was created because of activity we need to deref it */
1106 if (PIM_UPSTREAM_FLAG_TEST_SRC_STREAM(up->flags)) {
1107 pim_upstream_fhr_kat_expiry(pim, up);
1108 if (PIM_DEBUG_TRACE)
1109 zlog_debug("kat expired on %s[%s]; remove stream reference",
1110 up->sg_str, pim->vrf->name);
1111 PIM_UPSTREAM_FLAG_UNSET_SRC_STREAM(up->flags);
1112 pim_upstream_del(pim, up, __PRETTY_FUNCTION__);
1113 } else if (PIM_UPSTREAM_FLAG_TEST_SRC_LHR(up->flags)) {
1114 struct pim_upstream *parent = up->parent;
1115
1116 PIM_UPSTREAM_FLAG_UNSET_SRC_LHR(up->flags);
1117 pim_upstream_del(pim, up, __PRETTY_FUNCTION__);
1118
1119 if (parent) {
1120 pim_jp_agg_single_upstream_send(&parent->rpf,
1121 parent, true);
1122 }
1123 }
1124
1125 return 0;
1126 }
1127
1128 void pim_upstream_keep_alive_timer_start(struct pim_upstream *up, uint32_t time)
1129 {
1130 if (!PIM_UPSTREAM_FLAG_TEST_SRC_STREAM(up->flags)) {
1131 if (PIM_DEBUG_TRACE)
1132 zlog_debug("kat start on %s with no stream reference",
1133 up->sg_str);
1134 }
1135 THREAD_OFF(up->t_ka_timer);
1136 thread_add_timer(master, pim_upstream_keep_alive_timer, up, time,
1137 &up->t_ka_timer);
1138
1139 /* any time keepalive is started against a SG we will have to
1140 * re-evaluate our active source database */
1141 pim_msdp_sa_local_update(up);
1142 }
1143
1144 /* MSDP on RP needs to know if a source is registerable to this RP */
1145 static int pim_upstream_msdp_reg_timer(struct thread *t)
1146 {
1147 struct pim_upstream *up = THREAD_ARG(t);
1148 struct pim_instance *pim = up->channel_oil->pim;
1149
1150 /* source is no longer active - pull the SA from MSDP's cache */
1151 pim_msdp_sa_local_del(pim, &up->sg);
1152 return 1;
1153 }
1154 void pim_upstream_msdp_reg_timer_start(struct pim_upstream *up)
1155 {
1156 THREAD_OFF(up->t_msdp_reg_timer);
1157 thread_add_timer(master, pim_upstream_msdp_reg_timer, up,
1158 PIM_MSDP_REG_RXED_PERIOD, &up->t_msdp_reg_timer);
1159
1160 pim_msdp_sa_local_update(up);
1161 }
1162
1163 /*
1164 * 4.2.1 Last-Hop Switchover to the SPT
1165 *
1166 * In Sparse-Mode PIM, last-hop routers join the shared tree towards the
1167 * RP. Once traffic from sources to joined groups arrives at a last-hop
1168 * router, it has the option of switching to receive the traffic on a
1169 * shortest path tree (SPT).
1170 *
1171 * The decision for a router to switch to the SPT is controlled as
1172 * follows:
1173 *
1174 * void
1175 * CheckSwitchToSpt(S,G) {
1176 * if ( ( pim_include(*,G) (-) pim_exclude(S,G)
1177 * (+) pim_include(S,G) != NULL )
1178 * AND SwitchToSptDesired(S,G) ) {
1179 * # Note: Restarting the KAT will result in the SPT switch
1180 * set KeepaliveTimer(S,G) to Keepalive_Period
1181 * }
1182 * }
1183 *
1184 * SwitchToSptDesired(S,G) is a policy function that is implementation
1185 * defined. An "infinite threshold" policy can be implemented by making
1186 * SwitchToSptDesired(S,G) return false all the time. A "switch on
1187 * first packet" policy can be implemented by making
1188 * SwitchToSptDesired(S,G) return true once a single packet has been
1189 * received for the source and group.
1190 */
1191 int pim_upstream_switch_to_spt_desired(struct pim_instance *pim,
1192 struct prefix_sg *sg)
1193 {
1194 if (I_am_RP(pim, sg->grp))
1195 return 1;
1196
1197 return 0;
1198 }
1199
1200 int pim_upstream_is_sg_rpt(struct pim_upstream *up)
1201 {
1202 struct listnode *chnode;
1203 struct pim_ifchannel *ch;
1204
1205 for (ALL_LIST_ELEMENTS_RO(up->ifchannels, chnode, ch)) {
1206 if (PIM_IF_FLAG_TEST_S_G_RPT(ch->flags))
1207 return 1;
1208 }
1209
1210 return 0;
1211 }
1212 /*
1213 * After receiving a packet set SPTbit:
1214 * void
1215 * Update_SPTbit(S,G,iif) {
1216 * if ( iif == RPF_interface(S)
1217 * AND JoinDesired(S,G) == TRUE
1218 * AND ( DirectlyConnected(S) == TRUE
1219 * OR RPF_interface(S) != RPF_interface(RP(G))
1220 * OR inherited_olist(S,G,rpt) == NULL
1221 * OR ( ( RPF'(S,G) == RPF'(*,G) ) AND
1222 * ( RPF'(S,G) != NULL ) )
1223 * OR ( I_Am_Assert_Loser(S,G,iif) ) {
1224 * Set SPTbit(S,G) to TRUE
1225 * }
1226 * }
1227 */
1228 void pim_upstream_set_sptbit(struct pim_upstream *up,
1229 struct interface *incoming)
1230 {
1231 struct pim_upstream *starup = up->parent;
1232
1233 // iif == RPF_interfvace(S)
1234 if (up->rpf.source_nexthop.interface != incoming) {
1235 if (PIM_DEBUG_TRACE)
1236 zlog_debug(
1237 "%s: Incoming Interface: %s is different than RPF_interface(S) %s",
1238 __PRETTY_FUNCTION__, incoming->name,
1239 up->rpf.source_nexthop.interface->name);
1240 return;
1241 }
1242
1243 // AND JoinDesired(S,G) == TRUE
1244 // FIXME
1245
1246 // DirectlyConnected(S) == TRUE
1247 if (pim_if_connected_to_source(up->rpf.source_nexthop.interface,
1248 up->sg.src)) {
1249 if (PIM_DEBUG_TRACE)
1250 zlog_debug("%s: %s is directly connected to the source",
1251 __PRETTY_FUNCTION__, up->sg_str);
1252 up->sptbit = PIM_UPSTREAM_SPTBIT_TRUE;
1253 return;
1254 }
1255
1256 // OR RPF_interface(S) != RPF_interface(RP(G))
1257 if (!starup
1258 || up->rpf.source_nexthop
1259 .interface != starup->rpf.source_nexthop.interface) {
1260 if (PIM_DEBUG_TRACE)
1261 zlog_debug(
1262 "%s: %s RPF_interface(S) != RPF_interface(RP(G))",
1263 __PRETTY_FUNCTION__, up->sg_str);
1264 up->sptbit = PIM_UPSTREAM_SPTBIT_TRUE;
1265 return;
1266 }
1267
1268 // OR inherited_olist(S,G,rpt) == NULL
1269 if (pim_upstream_is_sg_rpt(up)
1270 && pim_upstream_empty_inherited_olist(up)) {
1271 if (PIM_DEBUG_TRACE)
1272 zlog_debug("%s: %s OR inherited_olist(S,G,rpt) == NULL",
1273 __PRETTY_FUNCTION__, up->sg_str);
1274 up->sptbit = PIM_UPSTREAM_SPTBIT_TRUE;
1275 return;
1276 }
1277
1278 // OR ( ( RPF'(S,G) == RPF'(*,G) ) AND
1279 // ( RPF'(S,G) != NULL ) )
1280 if (up->parent && pim_rpf_is_same(&up->rpf, &up->parent->rpf)) {
1281 if (PIM_DEBUG_TRACE)
1282 zlog_debug("%s: %s RPF'(S,G) is the same as RPF'(*,G)",
1283 __PRETTY_FUNCTION__, up->sg_str);
1284 up->sptbit = PIM_UPSTREAM_SPTBIT_TRUE;
1285 return;
1286 }
1287
1288 return;
1289 }
1290
1291 const char *pim_upstream_state2str(enum pim_upstream_state join_state)
1292 {
1293 switch (join_state) {
1294 case PIM_UPSTREAM_NOTJOINED:
1295 return "NotJoined";
1296 break;
1297 case PIM_UPSTREAM_JOINED:
1298 return "Joined";
1299 break;
1300 }
1301 return "Unknown";
1302 }
1303
1304 const char *pim_reg_state2str(enum pim_reg_state reg_state, char *state_str)
1305 {
1306 switch (reg_state) {
1307 case PIM_REG_NOINFO:
1308 strcpy(state_str, "RegNoInfo");
1309 break;
1310 case PIM_REG_JOIN:
1311 strcpy(state_str, "RegJoined");
1312 break;
1313 case PIM_REG_JOIN_PENDING:
1314 strcpy(state_str, "RegJoinPend");
1315 break;
1316 case PIM_REG_PRUNE:
1317 strcpy(state_str, "RegPrune");
1318 break;
1319 default:
1320 strcpy(state_str, "RegUnknown");
1321 }
1322 return state_str;
1323 }
1324
1325 static int pim_upstream_register_stop_timer(struct thread *t)
1326 {
1327 struct pim_interface *pim_ifp;
1328 struct pim_instance *pim;
1329 struct pim_upstream *up;
1330 struct pim_rpf *rpg;
1331 struct ip ip_hdr;
1332 up = THREAD_ARG(t);
1333 pim = up->channel_oil->pim;
1334
1335 if (PIM_DEBUG_TRACE) {
1336 char state_str[PIM_REG_STATE_STR_LEN];
1337 zlog_debug("%s: (S,G)=%s[%s] upstream register stop timer %s",
1338 __PRETTY_FUNCTION__, up->sg_str, pim->vrf->name,
1339 pim_reg_state2str(up->reg_state, state_str));
1340 }
1341
1342 switch (up->reg_state) {
1343 case PIM_REG_JOIN_PENDING:
1344 up->reg_state = PIM_REG_JOIN;
1345 pim_channel_add_oif(up->channel_oil, pim->regiface,
1346 PIM_OIF_FLAG_PROTO_PIM);
1347 break;
1348 case PIM_REG_JOIN:
1349 break;
1350 case PIM_REG_PRUNE:
1351 pim_ifp = up->rpf.source_nexthop.interface->info;
1352 if (!pim_ifp) {
1353 if (PIM_DEBUG_TRACE)
1354 zlog_debug(
1355 "%s: Interface: %s is not configured for pim",
1356 __PRETTY_FUNCTION__,
1357 up->rpf.source_nexthop.interface->name);
1358 return 0;
1359 }
1360 up->reg_state = PIM_REG_JOIN_PENDING;
1361 pim_upstream_start_register_stop_timer(up, 1);
1362
1363 if (((up->channel_oil->cc.lastused / 100)
1364 > pim->keep_alive_time)
1365 && (I_am_RP(pim_ifp->pim, up->sg.grp))) {
1366 if (PIM_DEBUG_TRACE)
1367 zlog_debug(
1368 "%s: Stop sending the register, because I am the RP and we haven't seen a packet in a while",
1369 __PRETTY_FUNCTION__);
1370 return 0;
1371 }
1372 rpg = RP(pim_ifp->pim, up->sg.grp);
1373 if (!rpg) {
1374 if (PIM_DEBUG_TRACE)
1375 zlog_debug(
1376 "%s: Cannot send register for %s no RPF to the RP",
1377 __PRETTY_FUNCTION__, up->sg_str);
1378 return 0;
1379 }
1380 memset(&ip_hdr, 0, sizeof(struct ip));
1381 ip_hdr.ip_p = PIM_IP_PROTO_PIM;
1382 ip_hdr.ip_hl = 5;
1383 ip_hdr.ip_v = 4;
1384 ip_hdr.ip_src = up->sg.src;
1385 ip_hdr.ip_dst = up->sg.grp;
1386 ip_hdr.ip_len = htons(20);
1387 // checksum is broken
1388 pim_register_send((uint8_t *)&ip_hdr, sizeof(struct ip),
1389 pim_ifp->primary_address, rpg, 1, up);
1390 break;
1391 default:
1392 break;
1393 }
1394
1395 return 0;
1396 }
1397
1398 void pim_upstream_start_register_stop_timer(struct pim_upstream *up,
1399 int null_register)
1400 {
1401 uint32_t time;
1402
1403 THREAD_TIMER_OFF(up->t_rs_timer);
1404
1405 if (!null_register) {
1406 uint32_t lower = (0.5 * PIM_REGISTER_SUPPRESSION_PERIOD);
1407 uint32_t upper = (1.5 * PIM_REGISTER_SUPPRESSION_PERIOD);
1408 time = lower + (random() % (upper - lower + 1))
1409 - PIM_REGISTER_PROBE_PERIOD;
1410 } else
1411 time = PIM_REGISTER_PROBE_PERIOD;
1412
1413 if (PIM_DEBUG_TRACE) {
1414 zlog_debug(
1415 "%s: (S,G)=%s Starting upstream register stop timer %d",
1416 __PRETTY_FUNCTION__, up->sg_str, time);
1417 }
1418 thread_add_timer(master, pim_upstream_register_stop_timer, up, time,
1419 &up->t_rs_timer);
1420 }
1421
1422 int pim_upstream_inherited_olist_decide(struct pim_instance *pim,
1423 struct pim_upstream *up)
1424 {
1425 struct interface *ifp;
1426 struct pim_interface *pim_ifp = NULL;
1427 struct pim_ifchannel *ch, *starch;
1428 struct pim_upstream *starup = up->parent;
1429 int output_intf = 0;
1430
1431 if (up->rpf.source_nexthop.interface)
1432 pim_ifp = up->rpf.source_nexthop.interface->info;
1433 else {
1434 if (PIM_DEBUG_TRACE)
1435 zlog_debug("%s: up %s RPF is not present",
1436 __PRETTY_FUNCTION__, up->sg_str);
1437 }
1438 if (pim_ifp && !up->channel_oil)
1439 up->channel_oil = pim_channel_oil_add(
1440 pim, &up->sg, pim_ifp->mroute_vif_index);
1441
1442 FOR_ALL_INTERFACES (pim->vrf, ifp) {
1443 if (!ifp->info)
1444 continue;
1445
1446 ch = pim_ifchannel_find(ifp, &up->sg);
1447
1448 if (starup)
1449 starch = pim_ifchannel_find(ifp, &starup->sg);
1450 else
1451 starch = NULL;
1452
1453 if (!ch && !starch)
1454 continue;
1455
1456 if (pim_upstream_evaluate_join_desired_interface(up, ch,
1457 starch)) {
1458 int flag = PIM_OIF_FLAG_PROTO_PIM;
1459
1460 if (!ch)
1461 flag = PIM_OIF_FLAG_PROTO_STAR;
1462
1463 pim_channel_add_oif(up->channel_oil, ifp, flag);
1464 output_intf++;
1465 }
1466 }
1467
1468 return output_intf;
1469 }
1470
1471 /*
1472 * For a given upstream, determine the inherited_olist
1473 * and apply it.
1474 *
1475 * inherited_olist(S,G,rpt) =
1476 * ( joins(*,*,RP(G)) (+) joins(*,G) (-) prunes(S,G,rpt) )
1477 * (+) ( pim_include(*,G) (-) pim_exclude(S,G))
1478 * (-) ( lost_assert(*,G) (+) lost_assert(S,G,rpt) )
1479 *
1480 * inherited_olist(S,G) =
1481 * inherited_olist(S,G,rpt) (+)
1482 * joins(S,G) (+) pim_include(S,G) (-) lost_assert(S,G)
1483 *
1484 * return 1 if there are any output interfaces
1485 * return 0 if there are not any output interfaces
1486 */
1487 int pim_upstream_inherited_olist(struct pim_instance *pim,
1488 struct pim_upstream *up)
1489 {
1490 int output_intf = pim_upstream_inherited_olist_decide(pim, up);
1491
1492 /*
1493 * If we have output_intf switch state to Join and work like normal
1494 * If we don't have an output_intf that means we are probably a
1495 * switch on a stick so turn on forwarding to just accept the
1496 * incoming packets so we don't bother the other stuff!
1497 */
1498 if (output_intf)
1499 pim_upstream_switch(pim, up, PIM_UPSTREAM_JOINED);
1500 else
1501 forward_on(up);
1502
1503 return output_intf;
1504 }
1505
1506 int pim_upstream_empty_inherited_olist(struct pim_upstream *up)
1507 {
1508 return pim_channel_oil_empty(up->channel_oil);
1509 }
1510
1511 /*
1512 * When we have a new neighbor,
1513 * find upstreams that don't have their rpf_addr
1514 * set and see if the new neighbor allows
1515 * the join to be sent
1516 */
1517 void pim_upstream_find_new_rpf(struct pim_instance *pim)
1518 {
1519 struct listnode *up_node;
1520 struct listnode *up_nextnode;
1521 struct pim_upstream *up;
1522
1523 /*
1524 * Scan all (S,G) upstreams searching for RPF'(S,G)=neigh_addr
1525 */
1526 for (ALL_LIST_ELEMENTS(pim->upstream_list, up_node, up_nextnode, up)) {
1527 if (pim_rpf_addr_is_inaddr_any(&up->rpf)) {
1528 if (PIM_DEBUG_TRACE)
1529 zlog_debug(
1530 "Upstream %s without a path to send join, checking",
1531 up->sg_str);
1532 pim_rpf_update(pim, up, NULL, 1);
1533 }
1534 }
1535 }
1536
1537 unsigned int pim_upstream_hash_key(void *arg)
1538 {
1539 struct pim_upstream *up = (struct pim_upstream *)arg;
1540
1541 return jhash_2words(up->sg.src.s_addr, up->sg.grp.s_addr, 0);
1542 }
1543
1544 void pim_upstream_terminate(struct pim_instance *pim)
1545 {
1546 if (pim->upstream_list)
1547 list_delete_and_null(&pim->upstream_list);
1548
1549 if (pim->upstream_hash)
1550 hash_free(pim->upstream_hash);
1551 pim->upstream_hash = NULL;
1552 }
1553
1554 int pim_upstream_equal(const void *arg1, const void *arg2)
1555 {
1556 const struct pim_upstream *up1 = (const struct pim_upstream *)arg1;
1557 const struct pim_upstream *up2 = (const struct pim_upstream *)arg2;
1558
1559 if ((up1->sg.grp.s_addr == up2->sg.grp.s_addr)
1560 && (up1->sg.src.s_addr == up2->sg.src.s_addr))
1561 return 1;
1562
1563 return 0;
1564 }
1565
1566 /* rfc4601:section-4.2:"Data Packet Forwarding Rules" defines
1567 * the cases where kat has to be restarted on rxing traffic -
1568 *
1569 * if( DirectlyConnected(S) == TRUE AND iif == RPF_interface(S) ) {
1570 * set KeepaliveTimer(S,G) to Keepalive_Period
1571 * # Note: a register state transition or UpstreamJPState(S,G)
1572 * # transition may happen as a result of restarting
1573 * # KeepaliveTimer, and must be dealt with here.
1574 * }
1575 * if( iif == RPF_interface(S) AND UpstreamJPState(S,G) == Joined AND
1576 * inherited_olist(S,G) != NULL ) {
1577 * set KeepaliveTimer(S,G) to Keepalive_Period
1578 * }
1579 */
1580 static bool pim_upstream_kat_start_ok(struct pim_upstream *up)
1581 {
1582 struct pim_instance *pim = up->channel_oil->pim;
1583
1584 /* "iif == RPF_interface(S)" check has to be done by the kernel or hw
1585 * so we will skip that here */
1586 if (pim_if_connected_to_source(up->rpf.source_nexthop.interface,
1587 up->sg.src)) {
1588 return true;
1589 }
1590
1591 if ((up->join_state == PIM_UPSTREAM_JOINED)
1592 && !pim_upstream_empty_inherited_olist(up)) {
1593 /* XXX: I have added this RP check just for 3.2 and it's a
1594 * digression from
1595 * what rfc-4601 says. Till now we were only running KAT on FHR
1596 * and RP and
1597 * there is some angst around making the change to run it all
1598 * routers that
1599 * maintain the (S, G) state. This is tracked via CM-13601 and
1600 * MUST be
1601 * removed to handle spt turn-arounds correctly in a 3-tier clos
1602 */
1603 if (I_am_RP(pim, up->sg.grp))
1604 return true;
1605 }
1606
1607 return false;
1608 }
1609
1610 /*
1611 * Code to check and see if we've received packets on a S,G mroute
1612 * and if so to set the SPT bit appropriately
1613 */
1614 static void pim_upstream_sg_running(void *arg)
1615 {
1616 struct pim_upstream *up = (struct pim_upstream *)arg;
1617 struct pim_instance *pim = up->channel_oil->pim;
1618
1619 // No packet can have arrived here if this is the case
1620 if (!up->channel_oil->installed) {
1621 if (PIM_DEBUG_TRACE)
1622 zlog_debug("%s: %s[%s] is not installed in mroute",
1623 __PRETTY_FUNCTION__,
1624 up->sg_str, pim->vrf->name);
1625 return;
1626 }
1627
1628 /*
1629 * This is a bit of a hack
1630 * We've noted that we should rescan but
1631 * we've missed the window for doing so in
1632 * pim_zebra.c for some reason. I am
1633 * only doing this at this point in time
1634 * to get us up and working for the moment
1635 */
1636 if (up->channel_oil->oil_inherited_rescan) {
1637 if (PIM_DEBUG_TRACE)
1638 zlog_debug(
1639 "%s: Handling unscanned inherited_olist for %s[%s]",
1640 __PRETTY_FUNCTION__, up->sg_str, pim->vrf->name);
1641 pim_upstream_inherited_olist_decide(pim, up);
1642 up->channel_oil->oil_inherited_rescan = 0;
1643 }
1644 pim_mroute_update_counters(up->channel_oil);
1645
1646 // Have we seen packets?
1647 if ((up->channel_oil->cc.oldpktcnt >= up->channel_oil->cc.pktcnt)
1648 && (up->channel_oil->cc.lastused / 100 > 30)) {
1649 if (PIM_DEBUG_TRACE) {
1650 zlog_debug(
1651 "%s[%s]: %s old packet count is equal or lastused is greater than 30, (%ld,%ld,%lld)",
1652 __PRETTY_FUNCTION__, up->sg_str, pim->vrf->name,
1653 up->channel_oil->cc.oldpktcnt,
1654 up->channel_oil->cc.pktcnt,
1655 up->channel_oil->cc.lastused / 100);
1656 }
1657 return;
1658 }
1659
1660 if (pim_upstream_kat_start_ok(up)) {
1661 /* Add a source reference to the stream if
1662 * one doesn't already exist */
1663 if (!PIM_UPSTREAM_FLAG_TEST_SRC_STREAM(up->flags)) {
1664 if (PIM_DEBUG_TRACE)
1665 zlog_debug(
1666 "source reference created on kat restart %s[%s]",
1667 up->sg_str, pim->vrf->name);
1668
1669 pim_upstream_ref(up, PIM_UPSTREAM_FLAG_MASK_SRC_STREAM,
1670 __PRETTY_FUNCTION__);
1671 PIM_UPSTREAM_FLAG_SET_SRC_STREAM(up->flags);
1672 pim_upstream_fhr_kat_start(up);
1673 }
1674 pim_upstream_keep_alive_timer_start(up, pim->keep_alive_time);
1675 } else if (PIM_UPSTREAM_FLAG_TEST_SRC_LHR(up->flags))
1676 pim_upstream_keep_alive_timer_start(up, pim->keep_alive_time);
1677
1678 if (up->sptbit != PIM_UPSTREAM_SPTBIT_TRUE) {
1679 pim_upstream_set_sptbit(up, up->rpf.source_nexthop.interface);
1680 }
1681 return;
1682 }
1683
1684 void pim_upstream_add_lhr_star_pimreg(struct pim_instance *pim)
1685 {
1686 struct pim_upstream *up;
1687 struct listnode *node;
1688
1689 for (ALL_LIST_ELEMENTS_RO(pim->upstream_list, node, up)) {
1690 if (up->sg.src.s_addr != INADDR_ANY)
1691 continue;
1692
1693 if (!PIM_UPSTREAM_FLAG_TEST_SRC_IGMP(up->flags))
1694 continue;
1695
1696 pim_channel_add_oif(up->channel_oil, pim->regiface,
1697 PIM_OIF_FLAG_PROTO_IGMP);
1698 }
1699 }
1700
1701 void pim_upstream_spt_prefix_list_update(struct pim_instance *pim,
1702 struct prefix_list *pl)
1703 {
1704 const char *pname = prefix_list_name(pl);
1705
1706 if (pim->spt.plist && strcmp(pim->spt.plist, pname) == 0) {
1707 pim_upstream_remove_lhr_star_pimreg(pim, pname);
1708 }
1709 }
1710
1711 /*
1712 * nlist -> The new prefix list
1713 *
1714 * Per Group Application of pimreg to the OIL
1715 * If the prefix list tells us DENY then
1716 * we need to Switchover to SPT immediate
1717 * so add the pimreg.
1718 * If the prefix list tells us to ACCEPT than
1719 * we need to Never do the SPT so remove
1720 * the interface
1721 *
1722 */
1723 void pim_upstream_remove_lhr_star_pimreg(struct pim_instance *pim,
1724 const char *nlist)
1725 {
1726 struct pim_upstream *up;
1727 struct listnode *node;
1728 struct prefix_list *np;
1729 struct prefix g;
1730 enum prefix_list_type apply_new;
1731
1732 np = prefix_list_lookup(AFI_IP, nlist);
1733
1734 g.family = AF_INET;
1735 g.prefixlen = IPV4_MAX_PREFIXLEN;
1736
1737 for (ALL_LIST_ELEMENTS_RO(pim->upstream_list, node, up)) {
1738 if (up->sg.src.s_addr != INADDR_ANY)
1739 continue;
1740
1741 if (!PIM_UPSTREAM_FLAG_TEST_SRC_IGMP(up->flags))
1742 continue;
1743
1744 if (!nlist) {
1745 pim_channel_del_oif(up->channel_oil, pim->regiface,
1746 PIM_OIF_FLAG_PROTO_IGMP);
1747 continue;
1748 }
1749 g.u.prefix4 = up->sg.grp;
1750 apply_new = prefix_list_apply(np, &g);
1751 if (apply_new == PREFIX_DENY)
1752 pim_channel_add_oif(up->channel_oil, pim->regiface,
1753 PIM_OIF_FLAG_PROTO_IGMP);
1754 else
1755 pim_channel_del_oif(up->channel_oil, pim->regiface,
1756 PIM_OIF_FLAG_PROTO_IGMP);
1757 }
1758 }
1759
1760 void pim_upstream_init(struct pim_instance *pim)
1761 {
1762 char hash_name[64];
1763
1764 pim->upstream_sg_wheel =
1765 wheel_init(master, 31000, 100, pim_upstream_hash_key,
1766 pim_upstream_sg_running);
1767
1768 snprintf(hash_name, 64, "PIM %s Upstream Hash",
1769 pim->vrf->name);
1770 pim->upstream_hash = hash_create_size(8192, pim_upstream_hash_key,
1771 pim_upstream_equal, hash_name);
1772
1773 pim->upstream_list = list_new();
1774 pim->upstream_list->del = (void (*)(void *))pim_upstream_free;
1775 pim->upstream_list->cmp = pim_upstream_compare;
1776 }
FRRouting mirror