3 * Copyright (C) 2008 Everton da Silva Marques
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.
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.
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
22 #include "zebra/rib.h"
39 #include "pim_iface.h"
41 #include "pim_zlookup.h"
42 #include "pim_upstream.h"
43 #include "pim_ifchannel.h"
44 #include "pim_neighbor.h"
46 #include "pim_zebra.h"
48 #include "pim_macro.h"
51 #include "pim_register.h"
53 #include "pim_jp_agg.h"
57 static void join_timer_stop(struct pim_upstream
*up
);
59 pim_upstream_update_assert_tracking_desired(struct pim_upstream
*up
);
62 * A (*,G) or a (*,*) is going away
63 * remove the parent pointer from
64 * those pointing at us
66 static void pim_upstream_remove_children(struct pim_instance
*pim
,
67 struct pim_upstream
*up
)
69 struct pim_upstream
*child
;
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
,
85 list_delete(up
->sources
);
90 * A (*,G) or a (*,*) is being created
91 * Find the children that would point
94 static void pim_upstream_find_new_children(struct pim_instance
*pim
,
95 struct pim_upstream
*up
)
97 struct pim_upstream
*child
;
98 struct listnode
*ch_node
;
100 if ((up
->sg
.src
.s_addr
!= INADDR_ANY
)
101 && (up
->sg
.grp
.s_addr
!= INADDR_ANY
))
104 if ((up
->sg
.src
.s_addr
== INADDR_ANY
)
105 && (up
->sg
.grp
.s_addr
== INADDR_ANY
))
108 for (ALL_LIST_ELEMENTS_RO(pim
->upstream_list
, ch_node
, child
)) {
109 if ((up
->sg
.grp
.s_addr
!= INADDR_ANY
)
110 && (child
->sg
.grp
.s_addr
== up
->sg
.grp
.s_addr
)
113 listnode_add_sort(up
->sources
, child
);
119 * If we have a (*,*) || (S,*) there is no parent
120 * If we have a (S,G), find the (*,G)
121 * If we have a (*,G), find the (*,*)
123 static struct pim_upstream
*pim_upstream_find_parent(struct pim_instance
*pim
,
124 struct pim_upstream
*child
)
126 struct prefix_sg any
= child
->sg
;
127 struct pim_upstream
*up
= NULL
;
130 if ((child
->sg
.src
.s_addr
!= INADDR_ANY
)
131 && (child
->sg
.grp
.s_addr
!= INADDR_ANY
)) {
132 any
.src
.s_addr
= INADDR_ANY
;
133 up
= pim_upstream_find(pim
, &any
);
136 listnode_add(up
->sources
, child
);
144 void pim_upstream_free(struct pim_upstream
*up
)
146 XFREE(MTYPE_PIM_UPSTREAM
, up
);
150 static void upstream_channel_oil_detach(struct pim_upstream
*up
)
152 if (up
->channel_oil
) {
153 /* Detaching from channel_oil, channel_oil may exist post del,
154 but upstream would not keep reference of it
156 pim_channel_oil_del(up
->channel_oil
);
157 up
->channel_oil
= NULL
;
161 struct pim_upstream
*pim_upstream_del(struct pim_instance
*pim
,
162 struct pim_upstream
*up
, const char *name
)
164 bool notify_msdp
= false;
169 "%s(%s): Delete %s ref count: %d , flags: %d c_oil ref count %d (Pre decrement)",
170 __PRETTY_FUNCTION__
, name
, up
->sg_str
, up
->ref_count
,
171 up
->flags
, up
->channel_oil
->oil_ref_count
);
175 if (up
->ref_count
>= 1)
178 THREAD_OFF(up
->t_ka_timer
);
179 THREAD_OFF(up
->t_rs_timer
);
180 THREAD_OFF(up
->t_msdp_reg_timer
);
182 if (up
->join_state
== PIM_UPSTREAM_JOINED
) {
183 pim_jp_agg_single_upstream_send(&up
->rpf
, up
, 0);
185 if (up
->sg
.src
.s_addr
== INADDR_ANY
) {
186 /* if a (*, G) entry in the joined state is being
188 * need to notify MSDP */
194 pim_jp_agg_upstream_verification(up
, false);
195 up
->rpf
.source_nexthop
.interface
= NULL
;
197 if (up
->sg
.src
.s_addr
!= INADDR_ANY
) {
198 wheel_remove_item(pim
->upstream_sg_wheel
, up
);
202 pim_upstream_remove_children(pim
, up
);
204 list_delete(up
->sources
);
206 pim_mroute_del(up
->channel_oil
, __PRETTY_FUNCTION__
);
207 upstream_channel_oil_detach(up
);
209 list_delete(up
->ifchannels
);
210 up
->ifchannels
= NULL
;
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()
217 if (up
->parent
&& up
->parent
->sources
)
218 listnode_delete(up
->parent
->sources
, up
);
221 listnode_delete(pim
->upstream_list
, up
);
222 hash_release(pim
->upstream_hash
, up
);
225 pim_msdp_up_del(pim
, &up
->sg
);
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
);
238 pim_delete_tracked_nexthop(pim
, &nht_p
, up
, NULL
);
240 pim_upstream_free(up
);
245 void pim_upstream_send_join(struct pim_upstream
*up
)
247 if (PIM_DEBUG_TRACE
) {
248 char rpf_str
[PREFIX_STRLEN
];
249 pim_addr_dump("<rpf?>", &up
->rpf
.rpf_addr
, 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
);
262 /* send Join(S,G) to the current upstream neighbor */
263 pim_jp_agg_single_upstream_send(&up
->rpf
, up
, 1 /* join */);
266 static int on_join_timer(struct thread
*t
)
268 struct pim_upstream
*up
;
273 * In the case of a HFR we will not ahve anyone to send this to.
275 if (PIM_UPSTREAM_FLAG_TEST_FHR(up
->flags
))
279 * Don't send the join if the outgoing interface is a loopback
280 * But since this might change leave the join timer running
282 if (up
->rpf
.source_nexthop
283 .interface
&& !if_is_loopback(up
->rpf
.source_nexthop
.interface
))
284 pim_upstream_send_join(up
);
286 join_timer_start(up
);
291 static void join_timer_stop(struct pim_upstream
*up
)
293 struct pim_neighbor
*nbr
;
295 THREAD_OFF(up
->t_join_timer
);
297 nbr
= pim_neighbor_find(up
->rpf
.source_nexthop
.interface
,
298 up
->rpf
.rpf_addr
.u
.prefix4
);
301 pim_jp_agg_remove_group(nbr
->upstream_jp_agg
, up
);
303 pim_jp_agg_upstream_verification(up
, false);
306 void join_timer_start(struct pim_upstream
*up
)
308 struct pim_neighbor
*nbr
= NULL
;
310 if (up
->rpf
.source_nexthop
.interface
) {
311 nbr
= pim_neighbor_find(up
->rpf
.source_nexthop
.interface
,
312 up
->rpf
.rpf_addr
.u
.prefix4
);
314 if (PIM_DEBUG_PIM_EVENTS
) {
316 "%s: starting %d sec timer for upstream (S,G)=%s",
317 __PRETTY_FUNCTION__
, qpim_t_periodic
,
323 pim_jp_agg_add_group(nbr
->upstream_jp_agg
, up
, 1);
325 THREAD_OFF(up
->t_join_timer
);
326 thread_add_timer(master
, on_join_timer
, up
, qpim_t_periodic
,
329 pim_jp_agg_upstream_verification(up
, true);
333 * This is only called when we are switching the upstream
334 * J/P from one neighbor to another
336 * As such we need to remove from the old list and
337 * add to the new list.
339 void pim_upstream_join_timer_restart(struct pim_upstream
*up
,
342 // THREAD_OFF(up->t_join_timer);
343 join_timer_start(up
);
346 static void pim_upstream_join_timer_restart_msec(struct pim_upstream
*up
,
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
);
354 THREAD_OFF(up
->t_join_timer
);
355 thread_add_timer_msec(master
, on_join_timer
, up
, interval_msec
,
359 void pim_upstream_join_suppress(struct pim_upstream
*up
,
360 struct in_addr rpf_addr
, int holdtime
)
362 long t_joinsuppress_msec
;
363 long join_timer_remain_msec
;
365 t_joinsuppress_msec
=
366 MIN(pim_if_t_suppressed_msec(up
->rpf
.source_nexthop
.interface
),
369 join_timer_remain_msec
= pim_time_timer_remain_msec(up
->t_join_timer
);
371 if (PIM_DEBUG_TRACE
) {
372 char rpf_str
[INET_ADDRSTRLEN
];
373 pim_inet4_dump("<rpf?>", rpf_addr
, rpf_str
, sizeof(rpf_str
));
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
);
380 if (join_timer_remain_msec
< t_joinsuppress_msec
) {
381 if (PIM_DEBUG_TRACE
) {
383 "%s %s: suppressing Join(S,G)=%s for %ld msec",
384 __FILE__
, __PRETTY_FUNCTION__
, up
->sg_str
,
385 t_joinsuppress_msec
);
388 pim_upstream_join_timer_restart_msec(up
, t_joinsuppress_msec
);
392 void pim_upstream_join_timer_decrease_to_t_override(const char *debug_label
,
393 struct pim_upstream
*up
)
395 long join_timer_remain_msec
;
398 join_timer_remain_msec
= pim_time_timer_remain_msec(up
->t_join_timer
);
400 pim_if_t_override_msec(up
->rpf
.source_nexthop
.interface
);
402 if (PIM_DEBUG_TRACE
) {
403 char rpf_str
[INET_ADDRSTRLEN
];
404 pim_inet4_dump("<rpf?>", up
->rpf
.rpf_addr
.u
.prefix4
, rpf_str
,
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
);
412 if (join_timer_remain_msec
> t_override_msec
) {
413 if (PIM_DEBUG_TRACE
) {
415 "%s: decreasing (S,G)=%s join timer to t_override=%d msec",
416 debug_label
, up
->sg_str
, t_override_msec
);
419 pim_upstream_join_timer_restart_msec(up
, t_override_msec
);
423 static void forward_on(struct pim_upstream
*up
)
425 struct listnode
*chnode
;
426 struct listnode
*chnextnode
;
427 struct pim_ifchannel
*ch
= NULL
;
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
);
434 } /* scan iface channel list */
437 static void forward_off(struct pim_upstream
*up
)
439 struct listnode
*chnode
;
440 struct listnode
*chnextnode
;
441 struct pim_ifchannel
*ch
;
443 /* scan per-interface (S,G) state */
444 for (ALL_LIST_ELEMENTS(up
->ifchannels
, chnode
, chnextnode
, ch
)) {
446 pim_forward_stop(ch
);
448 } /* scan iface channel list */
451 static int pim_upstream_could_register(struct pim_upstream
*up
)
453 struct pim_interface
*pim_ifp
= NULL
;
455 if (up
->rpf
.source_nexthop
.interface
)
456 pim_ifp
= up
->rpf
.source_nexthop
.interface
->info
;
459 zlog_debug("%s: up %s RPF is not present",
460 __PRETTY_FUNCTION__
, up
->sg_str
);
463 if (pim_ifp
&& PIM_I_am_DR(pim_ifp
)
464 && pim_if_connected_to_source(up
->rpf
.source_nexthop
.interface
,
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
)
475 struct listnode
*upnode
;
476 struct pim_upstream
*up
;
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
482 * registration whenever the flow becomes active. */
483 if (!PIM_UPSTREAM_FLAG_TEST_FHR(up
->flags
) || !up
->t_ka_timer
)
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
)
491 "Clear register for %s as G is now SSM",
493 /* remove regiface from the OIL if it is there*/
494 pim_channel_del_oif(up
->channel_oil
,
496 PIM_OIF_FLAG_PROTO_PIM
);
497 up
->reg_state
= PIM_REG_NOINFO
;
500 /* register ASM sources with the RP */
501 if (up
->reg_state
== PIM_REG_NOINFO
) {
502 if (PIM_DEBUG_PIM_EVENTS
)
504 "Register %s as G is now ASM",
506 pim_channel_add_oif(up
->channel_oil
,
508 PIM_OIF_FLAG_PROTO_PIM
);
509 up
->reg_state
= PIM_REG_JOIN
;
515 void pim_upstream_switch(struct pim_instance
*pim
, struct pim_upstream
*up
,
516 enum pim_upstream_state new_state
)
518 enum pim_upstream_state old_state
= up
->join_state
;
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
));
527 up
->join_state
= new_state
;
528 if (old_state
!= new_state
)
529 up
->state_transition
= pim_time_monotonic_sec();
531 pim_upstream_update_assert_tracking_desired(up
);
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
);
537 pim_msdp_up_join_state_changed(pim
, up
);
538 if (pim_upstream_could_register(up
)) {
539 PIM_UPSTREAM_FLAG_SET_FHR(up
->flags
);
541 && PIM_UPSTREAM_FLAG_TEST_SRC_STREAM(
543 pim_upstream_keep_alive_timer_start(
544 up
, qpim_keep_alive_time
);
545 pim_register_join(up
);
548 pim_upstream_send_join(up
);
549 join_timer_start(up
);
557 if (old_state
== PIM_UPSTREAM_JOINED
)
558 pim_msdp_up_join_state_changed(pim
, up
);
560 /* IHR, Trigger SGRpt on *,G IIF to prune S,G from RPT towards
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
)
567 "%s: *,G IIF %s S,G IIF %s ",
569 up
->parent
->rpf
.source_nexthop
571 up
->rpf
.source_nexthop
.interface
->name
);
572 pim_jp_agg_single_upstream_send(&up
->parent
->rpf
,
576 pim_jp_agg_single_upstream_send(&up
->rpf
, up
,
582 int pim_upstream_compare(void *arg1
, void *arg2
)
584 const struct pim_upstream
*up1
= (const struct pim_upstream
*)arg1
;
585 const struct pim_upstream
*up2
= (const struct pim_upstream
*)arg2
;
587 if (ntohl(up1
->sg
.grp
.s_addr
) < ntohl(up2
->sg
.grp
.s_addr
))
590 if (ntohl(up1
->sg
.grp
.s_addr
) > ntohl(up2
->sg
.grp
.s_addr
))
593 if (ntohl(up1
->sg
.src
.s_addr
) < ntohl(up2
->sg
.src
.s_addr
))
596 if (ntohl(up1
->sg
.src
.s_addr
) > ntohl(up2
->sg
.src
.s_addr
))
602 static struct pim_upstream
*pim_upstream_new(struct pim_instance
*pim
,
603 struct prefix_sg
*sg
,
604 struct interface
*incoming
,
606 struct pim_ifchannel
*ch
)
608 enum pim_rpf_result rpf_result
;
609 struct pim_interface
*pim_ifp
;
610 struct pim_upstream
*up
;
612 up
= XCALLOC(MTYPE_PIM_UPSTREAM
, sizeof(*up
));
614 zlog_err("%s: PIM XCALLOC(%zu) failure", __PRETTY_FUNCTION__
,
620 pim_str_sg_set(sg
, up
->sg_str
);
624 up
= hash_get(pim
->upstream_hash
, up
, hash_alloc_intern
);
625 if (!pim_rp_set_upstream_addr(pim
, &up
->upstream_addr
, sg
->src
,
628 zlog_debug("%s: Received a (*,G) with no RP configured",
629 __PRETTY_FUNCTION__
);
631 hash_release(pim
->upstream_hash
, up
);
632 XFREE(MTYPE_PIM_UPSTREAM
, up
);
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
;
643 pim_upstream_find_new_children(pim
, up
);
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
;
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
=
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
;
667 up
->ifchannels
= list_new();
668 up
->ifchannels
->cmp
= (int (*)(void *, void *))pim_ifchannel_compare
;
670 if (up
->sg
.src
.s_addr
!= INADDR_ANY
)
671 wheel_add_item(pim
->upstream_sg_wheel
, up
);
673 rpf_result
= pim_rpf_update(pim
, up
, NULL
, 1);
674 if (rpf_result
== PIM_RPF_FAILURE
) {
679 "%s: Attempting to create upstream(%s), Unable to RPF for source",
680 __PRETTY_FUNCTION__
, up
->sg_str
);
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
);
688 listnode_delete(up
->parent
->sources
, up
);
692 if (up
->sg
.src
.s_addr
!= INADDR_ANY
)
693 wheel_remove_item(pim
->upstream_sg_wheel
, up
);
695 pim_upstream_remove_children(pim
, up
);
697 list_delete(up
->sources
);
699 hash_release(pim
->upstream_hash
, up
);
700 XFREE(MTYPE_PIM_UPSTREAM
, up
);
704 if (up
->rpf
.source_nexthop
.interface
) {
705 pim_ifp
= up
->rpf
.source_nexthop
.interface
->info
;
707 up
->channel_oil
= pim_channel_oil_add(
708 pim
, &up
->sg
, pim_ifp
->mroute_vif_index
);
710 listnode_add_sort(pim
->upstream_list
, up
);
712 if (PIM_DEBUG_TRACE
) {
714 "%s: Created Upstream %s upstream_addr %s ref count %d increment",
715 __PRETTY_FUNCTION__
, up
->sg_str
,
716 inet_ntoa(up
->upstream_addr
), up
->ref_count
);
722 struct pim_upstream
*pim_upstream_find(struct pim_instance
*pim
,
723 struct prefix_sg
*sg
)
725 struct pim_upstream lookup
;
726 struct pim_upstream
*up
= NULL
;
729 up
= hash_lookup(pim
->upstream_hash
, &lookup
);
733 struct pim_upstream
*pim_upstream_find_or_add(struct prefix_sg
*sg
,
734 struct interface
*incoming
,
735 int flags
, const char *name
)
737 struct pim_upstream
*up
;
738 struct pim_interface
*pim_ifp
;
740 pim_ifp
= incoming
->info
;
742 up
= pim_upstream_find(pim_ifp
->pim
, sg
);
745 if (!(up
->flags
& flags
)) {
750 "%s(%s): upstream %s ref count %d increment",
751 __PRETTY_FUNCTION__
, name
, up
->sg_str
,
755 up
= pim_upstream_add(pim_ifp
->pim
, sg
, incoming
, flags
, name
,
761 void pim_upstream_ref(struct pim_upstream
*up
, int flags
, const char *name
)
766 zlog_debug("%s(%s): upstream %s ref count %d increment",
767 __PRETTY_FUNCTION__
, name
, up
->sg_str
,
771 struct pim_upstream
*pim_upstream_add(struct pim_instance
*pim
,
772 struct prefix_sg
*sg
,
773 struct interface
*incoming
, int flags
,
775 struct pim_ifchannel
*ch
)
777 struct pim_upstream
*up
= NULL
;
780 up
= pim_upstream_find(pim
, sg
);
782 pim_upstream_ref(up
, flags
, name
);
785 up
= pim_upstream_new(pim
, sg
, incoming
, flags
, ch
);
788 if (PIM_DEBUG_TRACE
) {
790 char buf
[PREFIX2STR_BUFFER
];
791 prefix2str(&up
->rpf
.rpf_addr
, buf
, sizeof(buf
));
792 zlog_debug("%s(%s): %s, iif %s (%s) found: %d: ref_count: %d",
793 __PRETTY_FUNCTION__
, name
,
794 up
->sg_str
, buf
, up
->rpf
.source_nexthop
.interface
?
795 up
->rpf
.source_nexthop
.interface
->name
: "NIL" ,
796 found
, up
->ref_count
);
798 zlog_debug("%s(%s): (%s) failure to create",
799 __PRETTY_FUNCTION__
, name
,
800 pim_str_sg_dump(sg
));
807 * Passed in up must be the upstream for ch. starch is NULL if no
810 int pim_upstream_evaluate_join_desired_interface(struct pim_upstream
*up
,
811 struct pim_ifchannel
*ch
,
812 struct pim_ifchannel
*starch
)
815 if (PIM_IF_FLAG_TEST_S_G_RPT(ch
->flags
))
818 if (!pim_macro_ch_lost_assert(ch
)
819 && pim_macro_chisin_joins_or_include(ch
))
827 if (PIM_IF_FLAG_TEST_S_G_RPT(starch
->upstream
->flags
))
830 if (!pim_macro_ch_lost_assert(starch
)
831 && pim_macro_chisin_joins_or_include(starch
))
839 Evaluate JoinDesired(S,G):
841 JoinDesired(S,G) is true if there is a downstream (S,G) interface I
844 inherited_olist(S,G) =
845 joins(S,G) (+) pim_include(S,G) (-) lost_assert(S,G)
847 JoinDesired(S,G) may be affected by changes in the following:
849 pim_ifp->primary_address
851 ch->ifassert_winner_metric
853 ch->local_ifmembership
855 ch->upstream->rpf.source_nexthop.mrib_metric_preference
856 ch->upstream->rpf.source_nexthop.mrib_route_metric
857 ch->upstream->rpf.source_nexthop.interface
859 See also pim_upstream_update_join_desired() below.
861 int pim_upstream_evaluate_join_desired(struct pim_instance
*pim
,
862 struct pim_upstream
*up
)
864 struct interface
*ifp
;
865 struct listnode
*node
;
866 struct pim_ifchannel
*ch
, *starch
;
867 struct pim_upstream
*starup
= up
->parent
;
870 for (ALL_LIST_ELEMENTS_RO(vrf_iflist(pim
->vrf_id
), node
, ifp
)) {
874 ch
= pim_ifchannel_find(ifp
, &up
->sg
);
877 starch
= pim_ifchannel_find(ifp
, &starup
->sg
);
884 ret
+= pim_upstream_evaluate_join_desired_interface(up
, ch
,
886 } /* scan iface channel list */
888 return ret
; /* false */
892 See also pim_upstream_evaluate_join_desired() above.
894 void pim_upstream_update_join_desired(struct pim_instance
*pim
,
895 struct pim_upstream
*up
)
897 int was_join_desired
; /* boolean */
898 int is_join_desired
; /* boolean */
900 was_join_desired
= PIM_UPSTREAM_FLAG_TEST_DR_JOIN_DESIRED(up
->flags
);
902 is_join_desired
= pim_upstream_evaluate_join_desired(pim
, up
);
904 PIM_UPSTREAM_FLAG_SET_DR_JOIN_DESIRED(up
->flags
);
906 PIM_UPSTREAM_FLAG_UNSET_DR_JOIN_DESIRED(up
->flags
);
908 /* switched from false to true */
909 if (is_join_desired
&& !was_join_desired
) {
910 pim_upstream_switch(pim
, up
, PIM_UPSTREAM_JOINED
);
914 /* switched from true to false */
915 if (!is_join_desired
&& was_join_desired
) {
916 pim_upstream_switch(pim
, up
, PIM_UPSTREAM_NOTJOINED
);
922 RFC 4601 4.5.7. Sending (S,G) Join/Prune Messages
923 Transitions from Joined State
924 RPF'(S,G) GenID changes
926 The upstream (S,G) state machine remains in Joined state. If the
927 Join Timer is set to expire in more than t_override seconds, reset
928 it so that it expires after t_override seconds.
930 void pim_upstream_rpf_genid_changed(struct pim_instance
*pim
,
931 struct in_addr neigh_addr
)
933 struct listnode
*up_node
;
934 struct listnode
*up_nextnode
;
935 struct pim_upstream
*up
;
938 * Scan all (S,G) upstreams searching for RPF'(S,G)=neigh_addr
940 for (ALL_LIST_ELEMENTS(pim
->upstream_list
, up_node
, up_nextnode
, up
)) {
942 if (PIM_DEBUG_TRACE
) {
943 char neigh_str
[INET_ADDRSTRLEN
];
944 char rpf_addr_str
[PREFIX_STRLEN
];
945 pim_inet4_dump("<neigh?>", neigh_addr
, neigh_str
,
947 pim_addr_dump("<rpf?>", &up
->rpf
.rpf_addr
, rpf_addr_str
,
948 sizeof(rpf_addr_str
));
950 "%s: matching neigh=%s against upstream (S,G)=%s joined=%d rpf_addr=%s",
951 __PRETTY_FUNCTION__
, neigh_str
, up
->sg_str
,
952 up
->join_state
== PIM_UPSTREAM_JOINED
,
956 /* consider only (S,G) upstream in Joined state */
957 if (up
->join_state
!= PIM_UPSTREAM_JOINED
)
960 /* match RPF'(S,G)=neigh_addr */
961 if (up
->rpf
.rpf_addr
.u
.prefix4
.s_addr
!= neigh_addr
.s_addr
)
964 pim_upstream_join_timer_decrease_to_t_override(
965 "RPF'(S,G) GenID change", up
);
970 void pim_upstream_rpf_interface_changed(struct pim_upstream
*up
,
971 struct interface
*old_rpf_ifp
)
973 struct listnode
*chnode
;
974 struct listnode
*chnextnode
;
975 struct pim_ifchannel
*ch
;
977 /* search all ifchannels */
978 for (ALL_LIST_ELEMENTS(up
->ifchannels
, chnode
, chnextnode
, ch
)) {
979 if (ch
->ifassert_state
== PIM_IFASSERT_I_AM_LOSER
) {
981 /* RPF_interface(S) was NOT I */
982 (old_rpf_ifp
== ch
->interface
) &&
983 /* RPF_interface(S) stopped being I */
984 (ch
->upstream
->rpf
.source_nexthop
985 .interface
!= ch
->interface
)) {
986 assert_action_a5(ch
);
988 } /* PIM_IFASSERT_I_AM_LOSER */
990 pim_ifchannel_update_assert_tracking_desired(ch
);
994 void pim_upstream_update_could_assert(struct pim_upstream
*up
)
996 struct listnode
*chnode
;
997 struct listnode
*chnextnode
;
998 struct pim_ifchannel
*ch
;
1000 /* scan per-interface (S,G) state */
1001 for (ALL_LIST_ELEMENTS(up
->ifchannels
, chnode
, chnextnode
, ch
)) {
1002 pim_ifchannel_update_could_assert(ch
);
1003 } /* scan iface channel list */
1006 void pim_upstream_update_my_assert_metric(struct pim_upstream
*up
)
1008 struct listnode
*chnode
;
1009 struct listnode
*chnextnode
;
1010 struct pim_ifchannel
*ch
;
1012 /* scan per-interface (S,G) state */
1013 for (ALL_LIST_ELEMENTS(up
->ifchannels
, chnode
, chnextnode
, ch
)) {
1014 pim_ifchannel_update_my_assert_metric(ch
);
1016 } /* scan iface channel list */
1019 static void pim_upstream_update_assert_tracking_desired(struct pim_upstream
*up
)
1021 struct listnode
*chnode
;
1022 struct listnode
*chnextnode
;
1023 struct pim_interface
*pim_ifp
;
1024 struct pim_ifchannel
*ch
;
1026 /* scan per-interface (S,G) state */
1027 for (ALL_LIST_ELEMENTS(up
->ifchannels
, chnode
, chnextnode
, ch
)) {
1030 pim_ifp
= ch
->interface
->info
;
1034 pim_ifchannel_update_assert_tracking_desired(ch
);
1036 } /* scan iface channel list */
1039 /* When kat is stopped CouldRegister goes to false so we need to
1040 * transition the (S, G) on FHR to NI state and remove reg tunnel
1042 static void pim_upstream_fhr_kat_expiry(struct pim_instance
*pim
,
1043 struct pim_upstream
*up
)
1045 if (!PIM_UPSTREAM_FLAG_TEST_FHR(up
->flags
))
1048 if (PIM_DEBUG_TRACE
)
1049 zlog_debug("kat expired on %s; clear fhr reg state",
1052 /* stop reg-stop timer */
1053 THREAD_OFF(up
->t_rs_timer
);
1054 /* remove regiface from the OIL if it is there*/
1055 pim_channel_del_oif(up
->channel_oil
, pim
->regiface
,
1056 PIM_OIF_FLAG_PROTO_PIM
);
1057 /* clear the register state */
1058 up
->reg_state
= PIM_REG_NOINFO
;
1059 PIM_UPSTREAM_FLAG_UNSET_FHR(up
->flags
);
1062 /* When kat is started CouldRegister can go to true. And if it does we
1063 * need to transition the (S, G) on FHR to JOINED state and add reg tunnel
1065 static void pim_upstream_fhr_kat_start(struct pim_upstream
*up
)
1067 if (pim_upstream_could_register(up
)) {
1068 if (PIM_DEBUG_TRACE
)
1070 "kat started on %s; set fhr reg state to joined",
1073 PIM_UPSTREAM_FLAG_SET_FHR(up
->flags
);
1074 if (up
->reg_state
== PIM_REG_NOINFO
)
1075 pim_register_join(up
);
1080 * On an RP, the PMBR value must be cleared when the
1081 * Keepalive Timer expires
1082 * KAT expiry indicates that flow is inactive. If the flow was created or
1083 * maintained by activity now is the time to deref it.
1085 static int pim_upstream_keep_alive_timer(struct thread
*t
)
1087 struct pim_upstream
*up
;
1088 struct pim_instance
*pim
;
1091 pim
= up
->channel_oil
->pim
;
1093 if (I_am_RP(pim
, up
->sg
.grp
)) {
1094 pim_br_clear_pmbr(&up
->sg
);
1096 * We need to do more here :)
1097 * But this is the start.
1101 /* source is no longer active - pull the SA from MSDP's cache */
1102 pim_msdp_sa_local_del(pim
, &up
->sg
);
1104 /* if entry was created because of activity we need to deref it */
1105 if (PIM_UPSTREAM_FLAG_TEST_SRC_STREAM(up
->flags
)) {
1106 pim_upstream_fhr_kat_expiry(pim
, up
);
1107 if (PIM_DEBUG_TRACE
)
1108 zlog_debug("kat expired on %s; remove stream reference",
1110 PIM_UPSTREAM_FLAG_UNSET_SRC_STREAM(up
->flags
);
1111 pim_upstream_del(pim
, up
, __PRETTY_FUNCTION__
);
1112 } else if (PIM_UPSTREAM_FLAG_TEST_SRC_LHR(up
->flags
)) {
1113 PIM_UPSTREAM_FLAG_UNSET_SRC_LHR(up
->flags
);
1114 pim_upstream_del(pim
, up
, __PRETTY_FUNCTION__
);
1120 void pim_upstream_keep_alive_timer_start(struct pim_upstream
*up
, uint32_t time
)
1122 if (!PIM_UPSTREAM_FLAG_TEST_SRC_STREAM(up
->flags
)) {
1123 if (PIM_DEBUG_TRACE
)
1124 zlog_debug("kat start on %s with no stream reference",
1127 THREAD_OFF(up
->t_ka_timer
);
1128 thread_add_timer(master
, pim_upstream_keep_alive_timer
, up
, time
,
1131 /* any time keepalive is started against a SG we will have to
1132 * re-evaluate our active source database */
1133 pim_msdp_sa_local_update(up
);
1136 /* MSDP on RP needs to know if a source is registerable to this RP */
1137 static int pim_upstream_msdp_reg_timer(struct thread
*t
)
1139 struct pim_upstream
*up
= THREAD_ARG(t
);
1140 struct pim_instance
*pim
= up
->channel_oil
->pim
;
1142 /* source is no longer active - pull the SA from MSDP's cache */
1143 pim_msdp_sa_local_del(pim
, &up
->sg
);
1146 void pim_upstream_msdp_reg_timer_start(struct pim_upstream
*up
)
1148 THREAD_OFF(up
->t_msdp_reg_timer
);
1149 thread_add_timer(master
, pim_upstream_msdp_reg_timer
, up
,
1150 PIM_MSDP_REG_RXED_PERIOD
, &up
->t_msdp_reg_timer
);
1152 pim_msdp_sa_local_update(up
);
1156 * 4.2.1 Last-Hop Switchover to the SPT
1158 * In Sparse-Mode PIM, last-hop routers join the shared tree towards the
1159 * RP. Once traffic from sources to joined groups arrives at a last-hop
1160 * router, it has the option of switching to receive the traffic on a
1161 * shortest path tree (SPT).
1163 * The decision for a router to switch to the SPT is controlled as
1167 * CheckSwitchToSpt(S,G) {
1168 * if ( ( pim_include(*,G) (-) pim_exclude(S,G)
1169 * (+) pim_include(S,G) != NULL )
1170 * AND SwitchToSptDesired(S,G) ) {
1171 * # Note: Restarting the KAT will result in the SPT switch
1172 * set KeepaliveTimer(S,G) to Keepalive_Period
1176 * SwitchToSptDesired(S,G) is a policy function that is implementation
1177 * defined. An "infinite threshold" policy can be implemented by making
1178 * SwitchToSptDesired(S,G) return false all the time. A "switch on
1179 * first packet" policy can be implemented by making
1180 * SwitchToSptDesired(S,G) return true once a single packet has been
1181 * received for the source and group.
1183 int pim_upstream_switch_to_spt_desired(struct pim_instance
*pim
,
1184 struct prefix_sg
*sg
)
1186 if (I_am_RP(pim
, sg
->grp
))
1192 int pim_upstream_is_sg_rpt(struct pim_upstream
*up
)
1194 struct listnode
*chnode
;
1195 struct pim_ifchannel
*ch
;
1197 for (ALL_LIST_ELEMENTS_RO(up
->ifchannels
, chnode
, ch
)) {
1198 if (PIM_IF_FLAG_TEST_S_G_RPT(ch
->flags
))
1205 * After receiving a packet set SPTbit:
1207 * Update_SPTbit(S,G,iif) {
1208 * if ( iif == RPF_interface(S)
1209 * AND JoinDesired(S,G) == TRUE
1210 * AND ( DirectlyConnected(S) == TRUE
1211 * OR RPF_interface(S) != RPF_interface(RP(G))
1212 * OR inherited_olist(S,G,rpt) == NULL
1213 * OR ( ( RPF'(S,G) == RPF'(*,G) ) AND
1214 * ( RPF'(S,G) != NULL ) )
1215 * OR ( I_Am_Assert_Loser(S,G,iif) ) {
1216 * Set SPTbit(S,G) to TRUE
1220 void pim_upstream_set_sptbit(struct pim_upstream
*up
,
1221 struct interface
*incoming
)
1223 struct pim_upstream
*starup
= up
->parent
;
1225 // iif == RPF_interfvace(S)
1226 if (up
->rpf
.source_nexthop
.interface
!= incoming
) {
1227 if (PIM_DEBUG_TRACE
)
1229 "%s: Incoming Interface: %s is different than RPF_interface(S) %s",
1230 __PRETTY_FUNCTION__
, incoming
->name
,
1231 up
->rpf
.source_nexthop
.interface
->name
);
1235 // AND JoinDesired(S,G) == TRUE
1238 // DirectlyConnected(S) == TRUE
1239 if (pim_if_connected_to_source(up
->rpf
.source_nexthop
.interface
,
1241 if (PIM_DEBUG_TRACE
)
1242 zlog_debug("%s: %s is directly connected to the source",
1243 __PRETTY_FUNCTION__
, up
->sg_str
);
1244 up
->sptbit
= PIM_UPSTREAM_SPTBIT_TRUE
;
1248 // OR RPF_interface(S) != RPF_interface(RP(G))
1250 || up
->rpf
.source_nexthop
1251 .interface
!= starup
->rpf
.source_nexthop
.interface
) {
1252 if (PIM_DEBUG_TRACE
)
1254 "%s: %s RPF_interface(S) != RPF_interface(RP(G))",
1255 __PRETTY_FUNCTION__
, up
->sg_str
);
1256 up
->sptbit
= PIM_UPSTREAM_SPTBIT_TRUE
;
1260 // OR inherited_olist(S,G,rpt) == NULL
1261 if (pim_upstream_is_sg_rpt(up
)
1262 && pim_upstream_empty_inherited_olist(up
)) {
1263 if (PIM_DEBUG_TRACE
)
1264 zlog_debug("%s: %s OR inherited_olist(S,G,rpt) == NULL",
1265 __PRETTY_FUNCTION__
, up
->sg_str
);
1266 up
->sptbit
= PIM_UPSTREAM_SPTBIT_TRUE
;
1270 // OR ( ( RPF'(S,G) == RPF'(*,G) ) AND
1271 // ( RPF'(S,G) != NULL ) )
1272 if (up
->parent
&& pim_rpf_is_same(&up
->rpf
, &up
->parent
->rpf
)) {
1273 if (PIM_DEBUG_TRACE
)
1274 zlog_debug("%s: %s RPF'(S,G) is the same as RPF'(*,G)",
1275 __PRETTY_FUNCTION__
, up
->sg_str
);
1276 up
->sptbit
= PIM_UPSTREAM_SPTBIT_TRUE
;
1283 const char *pim_upstream_state2str(enum pim_upstream_state join_state
)
1285 switch (join_state
) {
1286 case PIM_UPSTREAM_NOTJOINED
:
1289 case PIM_UPSTREAM_JOINED
:
1296 const char *pim_reg_state2str(enum pim_reg_state reg_state
, char *state_str
)
1298 switch (reg_state
) {
1299 case PIM_REG_NOINFO
:
1300 strcpy(state_str
, "RegNoInfo");
1303 strcpy(state_str
, "RegJoined");
1305 case PIM_REG_JOIN_PENDING
:
1306 strcpy(state_str
, "RegJoinPend");
1309 strcpy(state_str
, "RegPrune");
1312 strcpy(state_str
, "RegUnknown");
1317 static int pim_upstream_register_stop_timer(struct thread
*t
)
1319 struct pim_interface
*pim_ifp
;
1320 struct pim_instance
*pim
;
1321 struct pim_upstream
*up
;
1322 struct pim_rpf
*rpg
;
1325 pim
= up
->channel_oil
->pim
;
1327 if (PIM_DEBUG_TRACE
) {
1328 char state_str
[PIM_REG_STATE_STR_LEN
];
1329 zlog_debug("%s: (S,G)=%s upstream register stop timer %s",
1330 __PRETTY_FUNCTION__
, up
->sg_str
,
1331 pim_reg_state2str(up
->reg_state
, state_str
));
1334 switch (up
->reg_state
) {
1335 case PIM_REG_JOIN_PENDING
:
1336 up
->reg_state
= PIM_REG_JOIN
;
1337 pim_channel_add_oif(up
->channel_oil
, pim
->regiface
,
1338 PIM_OIF_FLAG_PROTO_PIM
);
1343 pim_ifp
= up
->rpf
.source_nexthop
.interface
->info
;
1345 if (PIM_DEBUG_TRACE
)
1347 "%s: Interface: %s is not configured for pim",
1348 __PRETTY_FUNCTION__
,
1349 up
->rpf
.source_nexthop
.interface
->name
);
1352 up
->reg_state
= PIM_REG_JOIN_PENDING
;
1353 pim_upstream_start_register_stop_timer(up
, 1);
1355 if (((up
->channel_oil
->cc
.lastused
/ 100)
1356 > PIM_KEEPALIVE_PERIOD
)
1357 && (I_am_RP(pim_ifp
->pim
, up
->sg
.grp
))) {
1358 if (PIM_DEBUG_TRACE
)
1360 "%s: Stop sending the register, because I am the RP and we haven't seen a packet in a while",
1361 __PRETTY_FUNCTION__
);
1364 rpg
= RP(pim_ifp
->pim
, up
->sg
.grp
);
1365 memset(&ip_hdr
, 0, sizeof(struct ip
));
1366 ip_hdr
.ip_p
= PIM_IP_PROTO_PIM
;
1369 ip_hdr
.ip_src
= up
->sg
.src
;
1370 ip_hdr
.ip_dst
= up
->sg
.grp
;
1371 ip_hdr
.ip_len
= htons(20);
1372 // checksum is broken
1373 pim_register_send((uint8_t *)&ip_hdr
, sizeof(struct ip
),
1374 pim_ifp
->primary_address
, rpg
, 1, up
);
1383 void pim_upstream_start_register_stop_timer(struct pim_upstream
*up
,
1388 THREAD_TIMER_OFF(up
->t_rs_timer
);
1390 if (!null_register
) {
1391 uint32_t lower
= (0.5 * PIM_REGISTER_SUPPRESSION_PERIOD
);
1392 uint32_t upper
= (1.5 * PIM_REGISTER_SUPPRESSION_PERIOD
);
1393 time
= lower
+ (random() % (upper
- lower
+ 1))
1394 - PIM_REGISTER_PROBE_PERIOD
;
1396 time
= PIM_REGISTER_PROBE_PERIOD
;
1398 if (PIM_DEBUG_TRACE
) {
1400 "%s: (S,G)=%s Starting upstream register stop timer %d",
1401 __PRETTY_FUNCTION__
, up
->sg_str
, time
);
1403 thread_add_timer(master
, pim_upstream_register_stop_timer
, up
, time
,
1407 int pim_upstream_inherited_olist_decide(struct pim_instance
*pim
,
1408 struct pim_upstream
*up
)
1410 struct interface
*ifp
;
1411 struct pim_interface
*pim_ifp
= NULL
;
1412 struct pim_ifchannel
*ch
, *starch
;
1413 struct listnode
*node
;
1414 struct pim_upstream
*starup
= up
->parent
;
1415 int output_intf
= 0;
1417 if (up
->rpf
.source_nexthop
.interface
)
1418 pim_ifp
= up
->rpf
.source_nexthop
.interface
->info
;
1420 if (PIM_DEBUG_TRACE
)
1421 zlog_debug("%s: up %s RPF is not present",
1422 __PRETTY_FUNCTION__
, up
->sg_str
);
1424 if (pim_ifp
&& !up
->channel_oil
)
1425 up
->channel_oil
= pim_channel_oil_add(
1426 pim
, &up
->sg
, pim_ifp
->mroute_vif_index
);
1428 for (ALL_LIST_ELEMENTS_RO(vrf_iflist(pim
->vrf_id
), node
, ifp
)) {
1432 ch
= pim_ifchannel_find(ifp
, &up
->sg
);
1435 starch
= pim_ifchannel_find(ifp
, &starup
->sg
);
1442 if (pim_upstream_evaluate_join_desired_interface(up
, ch
,
1444 int flag
= PIM_OIF_FLAG_PROTO_PIM
;
1447 flag
= PIM_OIF_FLAG_PROTO_STAR
;
1449 pim_channel_add_oif(up
->channel_oil
, ifp
, flag
);
1458 * For a given upstream, determine the inherited_olist
1461 * inherited_olist(S,G,rpt) =
1462 * ( joins(*,*,RP(G)) (+) joins(*,G) (-) prunes(S,G,rpt) )
1463 * (+) ( pim_include(*,G) (-) pim_exclude(S,G))
1464 * (-) ( lost_assert(*,G) (+) lost_assert(S,G,rpt) )
1466 * inherited_olist(S,G) =
1467 * inherited_olist(S,G,rpt) (+)
1468 * joins(S,G) (+) pim_include(S,G) (-) lost_assert(S,G)
1470 * return 1 if there are any output interfaces
1471 * return 0 if there are not any output interfaces
1473 int pim_upstream_inherited_olist(struct pim_instance
*pim
,
1474 struct pim_upstream
*up
)
1476 int output_intf
= pim_upstream_inherited_olist_decide(pim
, up
);
1479 * If we have output_intf switch state to Join and work like normal
1480 * If we don't have an output_intf that means we are probably a
1481 * switch on a stick so turn on forwarding to just accept the
1482 * incoming packets so we don't bother the other stuff!
1485 pim_upstream_switch(pim
, up
, PIM_UPSTREAM_JOINED
);
1492 int pim_upstream_empty_inherited_olist(struct pim_upstream
*up
)
1494 return pim_channel_oil_empty(up
->channel_oil
);
1498 * When we have a new neighbor,
1499 * find upstreams that don't have their rpf_addr
1500 * set and see if the new neighbor allows
1501 * the join to be sent
1503 void pim_upstream_find_new_rpf(struct pim_instance
*pim
)
1505 struct listnode
*up_node
;
1506 struct listnode
*up_nextnode
;
1507 struct pim_upstream
*up
;
1510 * Scan all (S,G) upstreams searching for RPF'(S,G)=neigh_addr
1512 for (ALL_LIST_ELEMENTS(pim
->upstream_list
, up_node
, up_nextnode
, up
)) {
1513 if (pim_rpf_addr_is_inaddr_any(&up
->rpf
)) {
1514 if (PIM_DEBUG_TRACE
)
1516 "Upstream %s without a path to send join, checking",
1518 pim_rpf_update(pim
, up
, NULL
, 1);
1523 static unsigned int pim_upstream_hash_key(void *arg
)
1525 struct pim_upstream
*up
= (struct pim_upstream
*)arg
;
1527 return jhash_2words(up
->sg
.src
.s_addr
, up
->sg
.grp
.s_addr
, 0);
1530 void pim_upstream_terminate(struct pim_instance
*pim
)
1532 if (pim
->upstream_list
)
1533 list_delete(pim
->upstream_list
);
1534 pim
->upstream_list
= NULL
;
1536 if (pim
->upstream_hash
)
1537 hash_free(pim
->upstream_hash
);
1538 pim
->upstream_hash
= NULL
;
1541 static int pim_upstream_equal(const void *arg1
, const void *arg2
)
1543 const struct pim_upstream
*up1
= (const struct pim_upstream
*)arg1
;
1544 const struct pim_upstream
*up2
= (const struct pim_upstream
*)arg2
;
1546 if ((up1
->sg
.grp
.s_addr
== up2
->sg
.grp
.s_addr
)
1547 && (up1
->sg
.src
.s_addr
== up2
->sg
.src
.s_addr
))
1553 /* rfc4601:section-4.2:"Data Packet Forwarding Rules" defines
1554 * the cases where kat has to be restarted on rxing traffic -
1556 * if( DirectlyConnected(S) == TRUE AND iif == RPF_interface(S) ) {
1557 * set KeepaliveTimer(S,G) to Keepalive_Period
1558 * # Note: a register state transition or UpstreamJPState(S,G)
1559 * # transition may happen as a result of restarting
1560 * # KeepaliveTimer, and must be dealt with here.
1562 * if( iif == RPF_interface(S) AND UpstreamJPState(S,G) == Joined AND
1563 * inherited_olist(S,G) != NULL ) {
1564 * set KeepaliveTimer(S,G) to Keepalive_Period
1567 static bool pim_upstream_kat_start_ok(struct pim_upstream
*up
)
1569 struct pim_instance
*pim
= up
->channel_oil
->pim
;
1571 /* "iif == RPF_interface(S)" check has to be done by the kernel or hw
1572 * so we will skip that here */
1573 if (pim_if_connected_to_source(up
->rpf
.source_nexthop
.interface
,
1578 if ((up
->join_state
== PIM_UPSTREAM_JOINED
)
1579 && !pim_upstream_empty_inherited_olist(up
)) {
1580 /* XXX: I have added this RP check just for 3.2 and it's a
1582 * what rfc-4601 says. Till now we were only running KAT on FHR
1584 * there is some angst around making the change to run it all
1586 * maintain the (S, G) state. This is tracked via CM-13601 and
1588 * removed to handle spt turn-arounds correctly in a 3-tier clos
1590 if (I_am_RP(pim
, up
->sg
.grp
))
1598 * Code to check and see if we've received packets on a S,G mroute
1599 * and if so to set the SPT bit appropriately
1601 static void pim_upstream_sg_running(void *arg
)
1603 struct pim_upstream
*up
= (struct pim_upstream
*)arg
;
1604 struct pim_instance
*pim
= up
->channel_oil
->pim
;
1606 // No packet can have arrived here if this is the case
1607 if (!up
->channel_oil
->installed
) {
1608 if (PIM_DEBUG_TRACE
)
1609 zlog_debug("%s: %s is not installed in mroute",
1610 __PRETTY_FUNCTION__
, up
->sg_str
);
1615 * This is a bit of a hack
1616 * We've noted that we should rescan but
1617 * we've missed the window for doing so in
1618 * pim_zebra.c for some reason. I am
1619 * only doing this at this point in time
1620 * to get us up and working for the moment
1622 if (up
->channel_oil
->oil_inherited_rescan
) {
1623 if (PIM_DEBUG_TRACE
)
1625 "%s: Handling unscanned inherited_olist for %s",
1626 __PRETTY_FUNCTION__
, up
->sg_str
);
1627 pim_upstream_inherited_olist_decide(pim
, up
);
1628 up
->channel_oil
->oil_inherited_rescan
= 0;
1630 pim_mroute_update_counters(up
->channel_oil
);
1632 // Have we seen packets?
1633 if ((up
->channel_oil
->cc
.oldpktcnt
>= up
->channel_oil
->cc
.pktcnt
)
1634 && (up
->channel_oil
->cc
.lastused
/ 100 > 30)) {
1635 if (PIM_DEBUG_TRACE
) {
1637 "%s: %s old packet count is equal or lastused is greater than 30, (%ld,%ld,%lld)",
1638 __PRETTY_FUNCTION__
, up
->sg_str
,
1639 up
->channel_oil
->cc
.oldpktcnt
,
1640 up
->channel_oil
->cc
.pktcnt
,
1641 up
->channel_oil
->cc
.lastused
/ 100);
1646 if (pim_upstream_kat_start_ok(up
)) {
1647 /* Add a source reference to the stream if
1648 * one doesn't already exist */
1649 if (!PIM_UPSTREAM_FLAG_TEST_SRC_STREAM(up
->flags
)) {
1650 if (PIM_DEBUG_TRACE
)
1652 "source reference created on kat restart %s",
1655 pim_upstream_ref(up
, PIM_UPSTREAM_FLAG_MASK_SRC_STREAM
,
1656 __PRETTY_FUNCTION__
);
1657 PIM_UPSTREAM_FLAG_SET_SRC_STREAM(up
->flags
);
1658 pim_upstream_fhr_kat_start(up
);
1660 pim_upstream_keep_alive_timer_start(up
, qpim_keep_alive_time
);
1661 } else if (PIM_UPSTREAM_FLAG_TEST_SRC_LHR(up
->flags
))
1662 pim_upstream_keep_alive_timer_start(up
, qpim_keep_alive_time
);
1664 if (up
->sptbit
!= PIM_UPSTREAM_SPTBIT_TRUE
) {
1665 pim_upstream_set_sptbit(up
, up
->rpf
.source_nexthop
.interface
);
1670 void pim_upstream_add_lhr_star_pimreg(struct pim_instance
*pim
)
1672 struct pim_upstream
*up
;
1673 struct listnode
*node
;
1675 for (ALL_LIST_ELEMENTS_RO(pim
->upstream_list
, node
, up
)) {
1676 if (up
->sg
.src
.s_addr
!= INADDR_ANY
)
1679 if (!PIM_UPSTREAM_FLAG_TEST_SRC_IGMP(up
->flags
))
1682 pim_channel_add_oif(up
->channel_oil
, pim
->regiface
,
1683 PIM_OIF_FLAG_PROTO_IGMP
);
1687 void pim_upstream_spt_prefix_list_update(struct pim_instance
*pim
,
1688 struct prefix_list
*pl
)
1690 const char *pname
= prefix_list_name(pl
);
1692 if (pim
->spt
.plist
&& strcmp(pim
->spt
.plist
, pname
) == 0) {
1693 pim_upstream_remove_lhr_star_pimreg(pim
, pname
);
1698 * nlist -> The new prefix list
1700 * Per Group Application of pimreg to the OIL
1701 * If the prefix list tells us DENY then
1702 * we need to Switchover to SPT immediate
1703 * so add the pimreg.
1704 * If the prefix list tells us to ACCEPT than
1705 * we need to Never do the SPT so remove
1709 void pim_upstream_remove_lhr_star_pimreg(struct pim_instance
*pim
,
1712 struct pim_upstream
*up
;
1713 struct listnode
*node
;
1714 struct prefix_list
*np
;
1716 enum prefix_list_type apply_new
;
1718 np
= prefix_list_lookup(AFI_IP
, nlist
);
1721 g
.prefixlen
= IPV4_MAX_PREFIXLEN
;
1723 for (ALL_LIST_ELEMENTS_RO(pim
->upstream_list
, node
, up
)) {
1724 if (up
->sg
.src
.s_addr
!= INADDR_ANY
)
1727 if (!PIM_UPSTREAM_FLAG_TEST_SRC_IGMP(up
->flags
))
1731 pim_channel_del_oif(up
->channel_oil
, pim
->regiface
,
1732 PIM_OIF_FLAG_PROTO_IGMP
);
1735 g
.u
.prefix4
= up
->sg
.grp
;
1736 apply_new
= prefix_list_apply(np
, &g
);
1737 if (apply_new
== PREFIX_DENY
)
1738 pim_channel_add_oif(up
->channel_oil
, pim
->regiface
,
1739 PIM_OIF_FLAG_PROTO_IGMP
);
1741 pim_channel_del_oif(up
->channel_oil
, pim
->regiface
,
1742 PIM_OIF_FLAG_PROTO_IGMP
);
1746 void pim_upstream_init(struct pim_instance
*pim
)
1748 pim
->upstream_sg_wheel
=
1749 wheel_init(master
, 31000, 100, pim_upstream_hash_key
,
1750 pim_upstream_sg_running
);
1751 pim
->upstream_hash
= hash_create_size(8192, pim_upstream_hash_key
,
1752 pim_upstream_equal
, NULL
);
1754 pim
->upstream_list
= list_new();
1755 pim
->upstream_list
->del
= (void (*)(void *))pim_upstream_free
;
1756 pim
->upstream_list
->cmp
= pim_upstream_compare
;