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_and_null(&up
->sources
);
89 * A (*,G) or a (*,*) is being created
90 * Find the children that would point
93 static void pim_upstream_find_new_children(struct pim_instance
*pim
,
94 struct pim_upstream
*up
)
96 struct pim_upstream
*child
;
97 struct listnode
*ch_node
;
99 if ((up
->sg
.src
.s_addr
!= INADDR_ANY
)
100 && (up
->sg
.grp
.s_addr
!= INADDR_ANY
))
103 if ((up
->sg
.src
.s_addr
== INADDR_ANY
)
104 && (up
->sg
.grp
.s_addr
== INADDR_ANY
))
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
)
112 listnode_add_sort(up
->sources
, child
);
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 (*,*)
122 static struct pim_upstream
*pim_upstream_find_parent(struct pim_instance
*pim
,
123 struct pim_upstream
*child
)
125 struct prefix_sg any
= child
->sg
;
126 struct pim_upstream
*up
= NULL
;
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
);
135 listnode_add(up
->sources
, child
);
143 void pim_upstream_free(struct pim_upstream
*up
)
145 XFREE(MTYPE_PIM_UPSTREAM
, up
);
149 static void upstream_channel_oil_detach(struct pim_upstream
*up
)
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
155 up
->channel_oil
->up
= NULL
;
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[%s] ref count: %d , flags: %d c_oil ref count %d (Pre decrement)",
170 __PRETTY_FUNCTION__
, name
, up
->sg_str
, pim
->vrf
->name
,
171 up
->ref_count
, up
->flags
,
172 up
->channel_oil
->oil_ref_count
);
176 if (up
->ref_count
>= 1)
179 THREAD_OFF(up
->t_ka_timer
);
180 THREAD_OFF(up
->t_rs_timer
);
181 THREAD_OFF(up
->t_msdp_reg_timer
);
183 if (up
->join_state
== PIM_UPSTREAM_JOINED
) {
184 pim_jp_agg_single_upstream_send(&up
->rpf
, up
, 0);
186 if (up
->sg
.src
.s_addr
== INADDR_ANY
) {
187 /* if a (*, G) entry in the joined state is being
189 * need to notify MSDP */
195 pim_jp_agg_upstream_verification(up
, false);
196 up
->rpf
.source_nexthop
.interface
= NULL
;
198 if (up
->sg
.src
.s_addr
!= INADDR_ANY
) {
199 wheel_remove_item(pim
->upstream_sg_wheel
, up
);
203 pim_upstream_remove_children(pim
, up
);
205 list_delete_and_null(&up
->sources
);
207 pim_mroute_del(up
->channel_oil
, __PRETTY_FUNCTION__
);
208 upstream_channel_oil_detach(up
);
210 list_delete_and_null(&up
->ifchannels
);
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
, false);
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
, pim
->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_and_null(&up
->sources
);
699 list_delete_and_null(&up
->ifchannels
);
701 hash_release(pim
->upstream_hash
, up
);
702 XFREE(MTYPE_PIM_UPSTREAM
, up
);
706 if (up
->rpf
.source_nexthop
.interface
) {
707 pim_ifp
= up
->rpf
.source_nexthop
.interface
->info
;
709 up
->channel_oil
= pim_channel_oil_add(
710 pim
, &up
->sg
, pim_ifp
->mroute_vif_index
);
712 listnode_add_sort(pim
->upstream_list
, up
);
714 if (PIM_DEBUG_TRACE
) {
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
);
724 struct pim_upstream
*pim_upstream_find(struct pim_instance
*pim
,
725 struct prefix_sg
*sg
)
727 struct pim_upstream lookup
;
728 struct pim_upstream
*up
= NULL
;
731 up
= hash_lookup(pim
->upstream_hash
, &lookup
);
735 struct pim_upstream
*pim_upstream_find_or_add(struct prefix_sg
*sg
,
736 struct interface
*incoming
,
737 int flags
, const char *name
)
739 struct pim_upstream
*up
;
740 struct pim_interface
*pim_ifp
;
742 pim_ifp
= incoming
->info
;
744 up
= pim_upstream_find(pim_ifp
->pim
, sg
);
747 if (!(up
->flags
& flags
)) {
752 "%s(%s): upstream %s ref count %d increment",
753 __PRETTY_FUNCTION__
, name
, up
->sg_str
,
757 up
= pim_upstream_add(pim_ifp
->pim
, sg
, incoming
, flags
, name
,
763 void pim_upstream_ref(struct pim_upstream
*up
, int flags
, const char *name
)
768 zlog_debug("%s(%s): upstream %s ref count %d increment",
769 __PRETTY_FUNCTION__
, name
, up
->sg_str
,
773 struct pim_upstream
*pim_upstream_add(struct pim_instance
*pim
,
774 struct prefix_sg
*sg
,
775 struct interface
*incoming
, int flags
,
777 struct pim_ifchannel
*ch
)
779 struct pim_upstream
*up
= NULL
;
782 up
= pim_upstream_find(pim
, sg
);
784 pim_upstream_ref(up
, flags
, name
);
787 up
= pim_upstream_new(pim
, sg
, incoming
, flags
, ch
);
790 if (PIM_DEBUG_TRACE
) {
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
);
800 zlog_debug("%s(%s): (%s) failure to create",
801 __PRETTY_FUNCTION__
, name
,
802 pim_str_sg_dump(sg
));
809 * Passed in up must be the upstream for ch. starch is NULL if no
812 int pim_upstream_evaluate_join_desired_interface(struct pim_upstream
*up
,
813 struct pim_ifchannel
*ch
,
814 struct pim_ifchannel
*starch
)
817 if (PIM_IF_FLAG_TEST_S_G_RPT(ch
->flags
))
820 if (!pim_macro_ch_lost_assert(ch
)
821 && pim_macro_chisin_joins_or_include(ch
))
829 if (PIM_IF_FLAG_TEST_S_G_RPT(starch
->upstream
->flags
))
832 if (!pim_macro_ch_lost_assert(starch
)
833 && pim_macro_chisin_joins_or_include(starch
))
841 Evaluate JoinDesired(S,G):
843 JoinDesired(S,G) is true if there is a downstream (S,G) interface I
846 inherited_olist(S,G) =
847 joins(S,G) (+) pim_include(S,G) (-) lost_assert(S,G)
849 JoinDesired(S,G) may be affected by changes in the following:
851 pim_ifp->primary_address
853 ch->ifassert_winner_metric
855 ch->local_ifmembership
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
861 See also pim_upstream_update_join_desired() below.
863 int pim_upstream_evaluate_join_desired(struct pim_instance
*pim
,
864 struct pim_upstream
*up
)
866 struct interface
*ifp
;
867 struct pim_ifchannel
*ch
, *starch
;
868 struct pim_upstream
*starup
= up
->parent
;
871 FOR_ALL_INTERFACES (pim
->vrf
, ifp
) {
875 ch
= pim_ifchannel_find(ifp
, &up
->sg
);
878 starch
= pim_ifchannel_find(ifp
, &starup
->sg
);
885 ret
+= pim_upstream_evaluate_join_desired_interface(up
, ch
,
887 } /* scan iface channel list */
889 return ret
; /* false */
893 See also pim_upstream_evaluate_join_desired() above.
895 void pim_upstream_update_join_desired(struct pim_instance
*pim
,
896 struct pim_upstream
*up
)
898 int was_join_desired
; /* boolean */
899 int is_join_desired
; /* boolean */
901 was_join_desired
= PIM_UPSTREAM_FLAG_TEST_DR_JOIN_DESIRED(up
->flags
);
903 is_join_desired
= pim_upstream_evaluate_join_desired(pim
, up
);
905 PIM_UPSTREAM_FLAG_SET_DR_JOIN_DESIRED(up
->flags
);
907 PIM_UPSTREAM_FLAG_UNSET_DR_JOIN_DESIRED(up
->flags
);
909 /* switched from false to true */
910 if (is_join_desired
&& !was_join_desired
) {
911 pim_upstream_switch(pim
, up
, PIM_UPSTREAM_JOINED
);
915 /* switched from true to false */
916 if (!is_join_desired
&& was_join_desired
) {
917 pim_upstream_switch(pim
, up
, PIM_UPSTREAM_NOTJOINED
);
923 RFC 4601 4.5.7. Sending (S,G) Join/Prune Messages
924 Transitions from Joined State
925 RPF'(S,G) GenID changes
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.
931 void pim_upstream_rpf_genid_changed(struct pim_instance
*pim
,
932 struct in_addr neigh_addr
)
934 struct listnode
*up_node
;
935 struct listnode
*up_nextnode
;
936 struct pim_upstream
*up
;
939 * Scan all (S,G) upstreams searching for RPF'(S,G)=neigh_addr
941 for (ALL_LIST_ELEMENTS(pim
->upstream_list
, up_node
, up_nextnode
, up
)) {
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
,
948 pim_addr_dump("<rpf?>", &up
->rpf
.rpf_addr
, rpf_addr_str
,
949 sizeof(rpf_addr_str
));
951 "%s: matching neigh=%s against upstream (S,G)=%s[%s] joined=%d rpf_addr=%s",
952 __PRETTY_FUNCTION__
, neigh_str
, up
->sg_str
,
954 up
->join_state
== PIM_UPSTREAM_JOINED
,
958 /* consider only (S,G) upstream in Joined state */
959 if (up
->join_state
!= PIM_UPSTREAM_JOINED
)
962 /* match RPF'(S,G)=neigh_addr */
963 if (up
->rpf
.rpf_addr
.u
.prefix4
.s_addr
!= neigh_addr
.s_addr
)
966 pim_upstream_join_timer_decrease_to_t_override(
967 "RPF'(S,G) GenID change", up
);
972 void pim_upstream_rpf_interface_changed(struct pim_upstream
*up
,
973 struct interface
*old_rpf_ifp
)
975 struct listnode
*chnode
;
976 struct listnode
*chnextnode
;
977 struct pim_ifchannel
*ch
;
979 /* search all ifchannels */
980 for (ALL_LIST_ELEMENTS(up
->ifchannels
, chnode
, chnextnode
, ch
)) {
981 if (ch
->ifassert_state
== PIM_IFASSERT_I_AM_LOSER
) {
983 /* RPF_interface(S) was NOT I */
984 (old_rpf_ifp
== ch
->interface
) &&
985 /* RPF_interface(S) stopped being I */
986 (ch
->upstream
->rpf
.source_nexthop
987 .interface
!= ch
->interface
)) {
988 assert_action_a5(ch
);
990 } /* PIM_IFASSERT_I_AM_LOSER */
992 pim_ifchannel_update_assert_tracking_desired(ch
);
996 void pim_upstream_update_could_assert(struct pim_upstream
*up
)
998 struct listnode
*chnode
;
999 struct listnode
*chnextnode
;
1000 struct pim_ifchannel
*ch
;
1002 /* scan per-interface (S,G) state */
1003 for (ALL_LIST_ELEMENTS(up
->ifchannels
, chnode
, chnextnode
, ch
)) {
1004 pim_ifchannel_update_could_assert(ch
);
1005 } /* scan iface channel list */
1008 void pim_upstream_update_my_assert_metric(struct pim_upstream
*up
)
1010 struct listnode
*chnode
;
1011 struct listnode
*chnextnode
;
1012 struct pim_ifchannel
*ch
;
1014 /* scan per-interface (S,G) state */
1015 for (ALL_LIST_ELEMENTS(up
->ifchannels
, chnode
, chnextnode
, ch
)) {
1016 pim_ifchannel_update_my_assert_metric(ch
);
1018 } /* scan iface channel list */
1021 static void pim_upstream_update_assert_tracking_desired(struct pim_upstream
*up
)
1023 struct listnode
*chnode
;
1024 struct listnode
*chnextnode
;
1025 struct pim_interface
*pim_ifp
;
1026 struct pim_ifchannel
*ch
;
1028 /* scan per-interface (S,G) state */
1029 for (ALL_LIST_ELEMENTS(up
->ifchannels
, chnode
, chnextnode
, ch
)) {
1032 pim_ifp
= ch
->interface
->info
;
1036 pim_ifchannel_update_assert_tracking_desired(ch
);
1038 } /* scan iface channel list */
1041 /* When kat is stopped CouldRegister goes to false so we need to
1042 * transition the (S, G) on FHR to NI state and remove reg tunnel
1044 static void pim_upstream_fhr_kat_expiry(struct pim_instance
*pim
,
1045 struct pim_upstream
*up
)
1047 if (!PIM_UPSTREAM_FLAG_TEST_FHR(up
->flags
))
1050 if (PIM_DEBUG_TRACE
)
1051 zlog_debug("kat expired on %s; clear fhr reg state",
1054 /* stop reg-stop timer */
1055 THREAD_OFF(up
->t_rs_timer
);
1056 /* remove regiface from the OIL if it is there*/
1057 pim_channel_del_oif(up
->channel_oil
, pim
->regiface
,
1058 PIM_OIF_FLAG_PROTO_PIM
);
1059 /* clear the register state */
1060 up
->reg_state
= PIM_REG_NOINFO
;
1061 PIM_UPSTREAM_FLAG_UNSET_FHR(up
->flags
);
1064 /* When kat is started CouldRegister can go to true. And if it does we
1065 * need to transition the (S, G) on FHR to JOINED state and add reg tunnel
1067 static void pim_upstream_fhr_kat_start(struct pim_upstream
*up
)
1069 if (pim_upstream_could_register(up
)) {
1070 if (PIM_DEBUG_TRACE
)
1072 "kat started on %s; set fhr reg state to joined",
1075 PIM_UPSTREAM_FLAG_SET_FHR(up
->flags
);
1076 if (up
->reg_state
== PIM_REG_NOINFO
)
1077 pim_register_join(up
);
1082 * On an RP, the PMBR value must be cleared when the
1083 * Keepalive Timer expires
1084 * KAT expiry indicates that flow is inactive. If the flow was created or
1085 * maintained by activity now is the time to deref it.
1087 static int pim_upstream_keep_alive_timer(struct thread
*t
)
1089 struct pim_upstream
*up
;
1090 struct pim_instance
*pim
;
1093 pim
= up
->channel_oil
->pim
;
1095 if (I_am_RP(pim
, up
->sg
.grp
)) {
1096 pim_br_clear_pmbr(&up
->sg
);
1098 * We need to do more here :)
1099 * But this is the start.
1103 /* source is no longer active - pull the SA from MSDP's cache */
1104 pim_msdp_sa_local_del(pim
, &up
->sg
);
1106 /* if entry was created because of activity we need to deref it */
1107 if (PIM_UPSTREAM_FLAG_TEST_SRC_STREAM(up
->flags
)) {
1108 pim_upstream_fhr_kat_expiry(pim
, up
);
1109 if (PIM_DEBUG_TRACE
)
1111 "kat expired on %s[%s]; remove stream reference",
1112 up
->sg_str
, pim
->vrf
->name
);
1113 PIM_UPSTREAM_FLAG_UNSET_SRC_STREAM(up
->flags
);
1114 pim_upstream_del(pim
, up
, __PRETTY_FUNCTION__
);
1115 } else if (PIM_UPSTREAM_FLAG_TEST_SRC_LHR(up
->flags
)) {
1116 struct pim_upstream
*parent
= up
->parent
;
1118 PIM_UPSTREAM_FLAG_UNSET_SRC_LHR(up
->flags
);
1119 pim_upstream_del(pim
, up
, __PRETTY_FUNCTION__
);
1122 pim_jp_agg_single_upstream_send(&parent
->rpf
, parent
,
1130 void pim_upstream_keep_alive_timer_start(struct pim_upstream
*up
, uint32_t time
)
1132 if (!PIM_UPSTREAM_FLAG_TEST_SRC_STREAM(up
->flags
)) {
1133 if (PIM_DEBUG_TRACE
)
1134 zlog_debug("kat start on %s with no stream reference",
1137 THREAD_OFF(up
->t_ka_timer
);
1138 thread_add_timer(master
, pim_upstream_keep_alive_timer
, up
, time
,
1141 /* any time keepalive is started against a SG we will have to
1142 * re-evaluate our active source database */
1143 pim_msdp_sa_local_update(up
);
1146 /* MSDP on RP needs to know if a source is registerable to this RP */
1147 static int pim_upstream_msdp_reg_timer(struct thread
*t
)
1149 struct pim_upstream
*up
= THREAD_ARG(t
);
1150 struct pim_instance
*pim
= up
->channel_oil
->pim
;
1152 /* source is no longer active - pull the SA from MSDP's cache */
1153 pim_msdp_sa_local_del(pim
, &up
->sg
);
1156 void pim_upstream_msdp_reg_timer_start(struct pim_upstream
*up
)
1158 THREAD_OFF(up
->t_msdp_reg_timer
);
1159 thread_add_timer(master
, pim_upstream_msdp_reg_timer
, up
,
1160 PIM_MSDP_REG_RXED_PERIOD
, &up
->t_msdp_reg_timer
);
1162 pim_msdp_sa_local_update(up
);
1166 * 4.2.1 Last-Hop Switchover to the SPT
1168 * In Sparse-Mode PIM, last-hop routers join the shared tree towards the
1169 * RP. Once traffic from sources to joined groups arrives at a last-hop
1170 * router, it has the option of switching to receive the traffic on a
1171 * shortest path tree (SPT).
1173 * The decision for a router to switch to the SPT is controlled as
1177 * CheckSwitchToSpt(S,G) {
1178 * if ( ( pim_include(*,G) (-) pim_exclude(S,G)
1179 * (+) pim_include(S,G) != NULL )
1180 * AND SwitchToSptDesired(S,G) ) {
1181 * # Note: Restarting the KAT will result in the SPT switch
1182 * set KeepaliveTimer(S,G) to Keepalive_Period
1186 * SwitchToSptDesired(S,G) is a policy function that is implementation
1187 * defined. An "infinite threshold" policy can be implemented by making
1188 * SwitchToSptDesired(S,G) return false all the time. A "switch on
1189 * first packet" policy can be implemented by making
1190 * SwitchToSptDesired(S,G) return true once a single packet has been
1191 * received for the source and group.
1193 int pim_upstream_switch_to_spt_desired(struct pim_instance
*pim
,
1194 struct prefix_sg
*sg
)
1196 if (I_am_RP(pim
, sg
->grp
))
1202 int pim_upstream_is_sg_rpt(struct pim_upstream
*up
)
1204 struct listnode
*chnode
;
1205 struct pim_ifchannel
*ch
;
1207 for (ALL_LIST_ELEMENTS_RO(up
->ifchannels
, chnode
, ch
)) {
1208 if (PIM_IF_FLAG_TEST_S_G_RPT(ch
->flags
))
1215 * After receiving a packet set SPTbit:
1217 * Update_SPTbit(S,G,iif) {
1218 * if ( iif == RPF_interface(S)
1219 * AND JoinDesired(S,G) == TRUE
1220 * AND ( DirectlyConnected(S) == TRUE
1221 * OR RPF_interface(S) != RPF_interface(RP(G))
1222 * OR inherited_olist(S,G,rpt) == NULL
1223 * OR ( ( RPF'(S,G) == RPF'(*,G) ) AND
1224 * ( RPF'(S,G) != NULL ) )
1225 * OR ( I_Am_Assert_Loser(S,G,iif) ) {
1226 * Set SPTbit(S,G) to TRUE
1230 void pim_upstream_set_sptbit(struct pim_upstream
*up
,
1231 struct interface
*incoming
)
1233 struct pim_upstream
*starup
= up
->parent
;
1235 // iif == RPF_interfvace(S)
1236 if (up
->rpf
.source_nexthop
.interface
!= incoming
) {
1237 if (PIM_DEBUG_TRACE
)
1239 "%s: Incoming Interface: %s is different than RPF_interface(S) %s",
1240 __PRETTY_FUNCTION__
, incoming
->name
,
1241 up
->rpf
.source_nexthop
.interface
->name
);
1245 // AND JoinDesired(S,G) == TRUE
1248 // DirectlyConnected(S) == TRUE
1249 if (pim_if_connected_to_source(up
->rpf
.source_nexthop
.interface
,
1251 if (PIM_DEBUG_TRACE
)
1252 zlog_debug("%s: %s is directly connected to the source",
1253 __PRETTY_FUNCTION__
, up
->sg_str
);
1254 up
->sptbit
= PIM_UPSTREAM_SPTBIT_TRUE
;
1258 // OR RPF_interface(S) != RPF_interface(RP(G))
1260 || up
->rpf
.source_nexthop
1261 .interface
!= starup
->rpf
.source_nexthop
.interface
) {
1262 if (PIM_DEBUG_TRACE
)
1264 "%s: %s RPF_interface(S) != RPF_interface(RP(G))",
1265 __PRETTY_FUNCTION__
, up
->sg_str
);
1266 up
->sptbit
= PIM_UPSTREAM_SPTBIT_TRUE
;
1270 // OR inherited_olist(S,G,rpt) == NULL
1271 if (pim_upstream_is_sg_rpt(up
)
1272 && pim_upstream_empty_inherited_olist(up
)) {
1273 if (PIM_DEBUG_TRACE
)
1274 zlog_debug("%s: %s OR inherited_olist(S,G,rpt) == NULL",
1275 __PRETTY_FUNCTION__
, up
->sg_str
);
1276 up
->sptbit
= PIM_UPSTREAM_SPTBIT_TRUE
;
1280 // OR ( ( RPF'(S,G) == RPF'(*,G) ) AND
1281 // ( RPF'(S,G) != NULL ) )
1282 if (up
->parent
&& pim_rpf_is_same(&up
->rpf
, &up
->parent
->rpf
)) {
1283 if (PIM_DEBUG_TRACE
)
1284 zlog_debug("%s: %s RPF'(S,G) is the same as RPF'(*,G)",
1285 __PRETTY_FUNCTION__
, up
->sg_str
);
1286 up
->sptbit
= PIM_UPSTREAM_SPTBIT_TRUE
;
1293 const char *pim_upstream_state2str(enum pim_upstream_state join_state
)
1295 switch (join_state
) {
1296 case PIM_UPSTREAM_NOTJOINED
:
1299 case PIM_UPSTREAM_JOINED
:
1306 const char *pim_reg_state2str(enum pim_reg_state reg_state
, char *state_str
)
1308 switch (reg_state
) {
1309 case PIM_REG_NOINFO
:
1310 strcpy(state_str
, "RegNoInfo");
1313 strcpy(state_str
, "RegJoined");
1315 case PIM_REG_JOIN_PENDING
:
1316 strcpy(state_str
, "RegJoinPend");
1319 strcpy(state_str
, "RegPrune");
1322 strcpy(state_str
, "RegUnknown");
1327 static int pim_upstream_register_stop_timer(struct thread
*t
)
1329 struct pim_interface
*pim_ifp
;
1330 struct pim_instance
*pim
;
1331 struct pim_upstream
*up
;
1332 struct pim_rpf
*rpg
;
1335 pim
= up
->channel_oil
->pim
;
1337 if (PIM_DEBUG_TRACE
) {
1338 char state_str
[PIM_REG_STATE_STR_LEN
];
1339 zlog_debug("%s: (S,G)=%s[%s] upstream register stop timer %s",
1340 __PRETTY_FUNCTION__
, up
->sg_str
, pim
->vrf
->name
,
1341 pim_reg_state2str(up
->reg_state
, state_str
));
1344 switch (up
->reg_state
) {
1345 case PIM_REG_JOIN_PENDING
:
1346 up
->reg_state
= PIM_REG_JOIN
;
1347 pim_channel_add_oif(up
->channel_oil
, pim
->regiface
,
1348 PIM_OIF_FLAG_PROTO_PIM
);
1353 pim_ifp
= up
->rpf
.source_nexthop
.interface
->info
;
1355 if (PIM_DEBUG_TRACE
)
1357 "%s: Interface: %s is not configured for pim",
1358 __PRETTY_FUNCTION__
,
1359 up
->rpf
.source_nexthop
.interface
->name
);
1362 up
->reg_state
= PIM_REG_JOIN_PENDING
;
1363 pim_upstream_start_register_stop_timer(up
, 1);
1365 if (((up
->channel_oil
->cc
.lastused
/ 100)
1366 > pim
->keep_alive_time
)
1367 && (I_am_RP(pim_ifp
->pim
, up
->sg
.grp
))) {
1368 if (PIM_DEBUG_TRACE
)
1370 "%s: Stop sending the register, because I am the RP and we haven't seen a packet in a while",
1371 __PRETTY_FUNCTION__
);
1374 rpg
= RP(pim_ifp
->pim
, up
->sg
.grp
);
1376 if (PIM_DEBUG_TRACE
)
1378 "%s: Cannot send register for %s no RPF to the RP",
1379 __PRETTY_FUNCTION__
, up
->sg_str
);
1382 memset(&ip_hdr
, 0, sizeof(struct ip
));
1383 ip_hdr
.ip_p
= PIM_IP_PROTO_PIM
;
1386 ip_hdr
.ip_src
= up
->sg
.src
;
1387 ip_hdr
.ip_dst
= up
->sg
.grp
;
1388 ip_hdr
.ip_len
= htons(20);
1389 // checksum is broken
1390 pim_register_send((uint8_t *)&ip_hdr
, sizeof(struct ip
),
1391 pim_ifp
->primary_address
, rpg
, 1, up
);
1400 void pim_upstream_start_register_stop_timer(struct pim_upstream
*up
,
1405 THREAD_TIMER_OFF(up
->t_rs_timer
);
1407 if (!null_register
) {
1408 uint32_t lower
= (0.5 * PIM_REGISTER_SUPPRESSION_PERIOD
);
1409 uint32_t upper
= (1.5 * PIM_REGISTER_SUPPRESSION_PERIOD
);
1410 time
= lower
+ (random() % (upper
- lower
+ 1))
1411 - PIM_REGISTER_PROBE_PERIOD
;
1413 time
= PIM_REGISTER_PROBE_PERIOD
;
1415 if (PIM_DEBUG_TRACE
) {
1417 "%s: (S,G)=%s Starting upstream register stop timer %d",
1418 __PRETTY_FUNCTION__
, up
->sg_str
, time
);
1420 thread_add_timer(master
, pim_upstream_register_stop_timer
, up
, time
,
1424 int pim_upstream_inherited_olist_decide(struct pim_instance
*pim
,
1425 struct pim_upstream
*up
)
1427 struct interface
*ifp
;
1428 struct pim_interface
*pim_ifp
= NULL
;
1429 struct pim_ifchannel
*ch
, *starch
;
1430 struct pim_upstream
*starup
= up
->parent
;
1431 int output_intf
= 0;
1433 if (up
->rpf
.source_nexthop
.interface
)
1434 pim_ifp
= up
->rpf
.source_nexthop
.interface
->info
;
1436 if (PIM_DEBUG_TRACE
)
1437 zlog_debug("%s: up %s RPF is not present",
1438 __PRETTY_FUNCTION__
, up
->sg_str
);
1440 if (pim_ifp
&& !up
->channel_oil
)
1441 up
->channel_oil
= pim_channel_oil_add(
1442 pim
, &up
->sg
, pim_ifp
->mroute_vif_index
);
1444 FOR_ALL_INTERFACES (pim
->vrf
, ifp
) {
1448 ch
= pim_ifchannel_find(ifp
, &up
->sg
);
1451 starch
= pim_ifchannel_find(ifp
, &starup
->sg
);
1458 if (pim_upstream_evaluate_join_desired_interface(up
, ch
,
1460 int flag
= PIM_OIF_FLAG_PROTO_PIM
;
1463 flag
= PIM_OIF_FLAG_PROTO_STAR
;
1465 pim_channel_add_oif(up
->channel_oil
, ifp
, flag
);
1474 * For a given upstream, determine the inherited_olist
1477 * inherited_olist(S,G,rpt) =
1478 * ( joins(*,*,RP(G)) (+) joins(*,G) (-) prunes(S,G,rpt) )
1479 * (+) ( pim_include(*,G) (-) pim_exclude(S,G))
1480 * (-) ( lost_assert(*,G) (+) lost_assert(S,G,rpt) )
1482 * inherited_olist(S,G) =
1483 * inherited_olist(S,G,rpt) (+)
1484 * joins(S,G) (+) pim_include(S,G) (-) lost_assert(S,G)
1486 * return 1 if there are any output interfaces
1487 * return 0 if there are not any output interfaces
1489 int pim_upstream_inherited_olist(struct pim_instance
*pim
,
1490 struct pim_upstream
*up
)
1492 int output_intf
= pim_upstream_inherited_olist_decide(pim
, up
);
1495 * If we have output_intf switch state to Join and work like normal
1496 * If we don't have an output_intf that means we are probably a
1497 * switch on a stick so turn on forwarding to just accept the
1498 * incoming packets so we don't bother the other stuff!
1501 pim_upstream_switch(pim
, up
, PIM_UPSTREAM_JOINED
);
1508 int pim_upstream_empty_inherited_olist(struct pim_upstream
*up
)
1510 return pim_channel_oil_empty(up
->channel_oil
);
1514 * When we have a new neighbor,
1515 * find upstreams that don't have their rpf_addr
1516 * set and see if the new neighbor allows
1517 * the join to be sent
1519 void pim_upstream_find_new_rpf(struct pim_instance
*pim
)
1521 struct listnode
*up_node
;
1522 struct listnode
*up_nextnode
;
1523 struct pim_upstream
*up
;
1526 * Scan all (S,G) upstreams searching for RPF'(S,G)=neigh_addr
1528 for (ALL_LIST_ELEMENTS(pim
->upstream_list
, up_node
, up_nextnode
, up
)) {
1529 if (pim_rpf_addr_is_inaddr_any(&up
->rpf
)) {
1530 if (PIM_DEBUG_TRACE
)
1532 "Upstream %s without a path to send join, checking",
1534 pim_rpf_update(pim
, up
, NULL
, 1);
1539 unsigned int pim_upstream_hash_key(void *arg
)
1541 struct pim_upstream
*up
= (struct pim_upstream
*)arg
;
1543 return jhash_2words(up
->sg
.src
.s_addr
, up
->sg
.grp
.s_addr
, 0);
1546 void pim_upstream_terminate(struct pim_instance
*pim
)
1548 if (pim
->upstream_list
)
1549 list_delete_and_null(&pim
->upstream_list
);
1551 if (pim
->upstream_hash
)
1552 hash_free(pim
->upstream_hash
);
1553 pim
->upstream_hash
= NULL
;
1556 int pim_upstream_equal(const void *arg1
, const void *arg2
)
1558 const struct pim_upstream
*up1
= (const struct pim_upstream
*)arg1
;
1559 const struct pim_upstream
*up2
= (const struct pim_upstream
*)arg2
;
1561 if ((up1
->sg
.grp
.s_addr
== up2
->sg
.grp
.s_addr
)
1562 && (up1
->sg
.src
.s_addr
== up2
->sg
.src
.s_addr
))
1568 /* rfc4601:section-4.2:"Data Packet Forwarding Rules" defines
1569 * the cases where kat has to be restarted on rxing traffic -
1571 * if( DirectlyConnected(S) == TRUE AND iif == RPF_interface(S) ) {
1572 * set KeepaliveTimer(S,G) to Keepalive_Period
1573 * # Note: a register state transition or UpstreamJPState(S,G)
1574 * # transition may happen as a result of restarting
1575 * # KeepaliveTimer, and must be dealt with here.
1577 * if( iif == RPF_interface(S) AND UpstreamJPState(S,G) == Joined AND
1578 * inherited_olist(S,G) != NULL ) {
1579 * set KeepaliveTimer(S,G) to Keepalive_Period
1582 static bool pim_upstream_kat_start_ok(struct pim_upstream
*up
)
1584 struct pim_instance
*pim
= up
->channel_oil
->pim
;
1586 /* "iif == RPF_interface(S)" check has to be done by the kernel or hw
1587 * so we will skip that here */
1588 if (pim_if_connected_to_source(up
->rpf
.source_nexthop
.interface
,
1593 if ((up
->join_state
== PIM_UPSTREAM_JOINED
)
1594 && !pim_upstream_empty_inherited_olist(up
)) {
1595 /* XXX: I have added this RP check just for 3.2 and it's a
1597 * what rfc-4601 says. Till now we were only running KAT on FHR
1599 * there is some angst around making the change to run it all
1601 * maintain the (S, G) state. This is tracked via CM-13601 and
1603 * removed to handle spt turn-arounds correctly in a 3-tier clos
1605 if (I_am_RP(pim
, up
->sg
.grp
))
1613 * Code to check and see if we've received packets on a S,G mroute
1614 * and if so to set the SPT bit appropriately
1616 static void pim_upstream_sg_running(void *arg
)
1618 struct pim_upstream
*up
= (struct pim_upstream
*)arg
;
1619 struct pim_instance
*pim
= up
->channel_oil
->pim
;
1621 // No packet can have arrived here if this is the case
1622 if (!up
->channel_oil
->installed
) {
1623 if (PIM_DEBUG_TRACE
)
1624 zlog_debug("%s: %s[%s] is not installed in mroute",
1625 __PRETTY_FUNCTION__
, up
->sg_str
,
1631 * This is a bit of a hack
1632 * We've noted that we should rescan but
1633 * we've missed the window for doing so in
1634 * pim_zebra.c for some reason. I am
1635 * only doing this at this point in time
1636 * to get us up and working for the moment
1638 if (up
->channel_oil
->oil_inherited_rescan
) {
1639 if (PIM_DEBUG_TRACE
)
1641 "%s: Handling unscanned inherited_olist for %s[%s]",
1642 __PRETTY_FUNCTION__
, up
->sg_str
,
1644 pim_upstream_inherited_olist_decide(pim
, up
);
1645 up
->channel_oil
->oil_inherited_rescan
= 0;
1647 pim_mroute_update_counters(up
->channel_oil
);
1649 // Have we seen packets?
1650 if ((up
->channel_oil
->cc
.oldpktcnt
>= up
->channel_oil
->cc
.pktcnt
)
1651 && (up
->channel_oil
->cc
.lastused
/ 100 > 30)) {
1652 if (PIM_DEBUG_TRACE
) {
1654 "%s[%s]: %s old packet count is equal or lastused is greater than 30, (%ld,%ld,%lld)",
1655 __PRETTY_FUNCTION__
, up
->sg_str
, pim
->vrf
->name
,
1656 up
->channel_oil
->cc
.oldpktcnt
,
1657 up
->channel_oil
->cc
.pktcnt
,
1658 up
->channel_oil
->cc
.lastused
/ 100);
1663 if (pim_upstream_kat_start_ok(up
)) {
1664 /* Add a source reference to the stream if
1665 * one doesn't already exist */
1666 if (!PIM_UPSTREAM_FLAG_TEST_SRC_STREAM(up
->flags
)) {
1667 if (PIM_DEBUG_TRACE
)
1669 "source reference created on kat restart %s[%s]",
1670 up
->sg_str
, pim
->vrf
->name
);
1672 pim_upstream_ref(up
, PIM_UPSTREAM_FLAG_MASK_SRC_STREAM
,
1673 __PRETTY_FUNCTION__
);
1674 PIM_UPSTREAM_FLAG_SET_SRC_STREAM(up
->flags
);
1675 pim_upstream_fhr_kat_start(up
);
1677 pim_upstream_keep_alive_timer_start(up
, pim
->keep_alive_time
);
1678 } else if (PIM_UPSTREAM_FLAG_TEST_SRC_LHR(up
->flags
))
1679 pim_upstream_keep_alive_timer_start(up
, pim
->keep_alive_time
);
1681 if (up
->sptbit
!= PIM_UPSTREAM_SPTBIT_TRUE
) {
1682 pim_upstream_set_sptbit(up
, up
->rpf
.source_nexthop
.interface
);
1687 void pim_upstream_add_lhr_star_pimreg(struct pim_instance
*pim
)
1689 struct pim_upstream
*up
;
1690 struct listnode
*node
;
1692 for (ALL_LIST_ELEMENTS_RO(pim
->upstream_list
, node
, up
)) {
1693 if (up
->sg
.src
.s_addr
!= INADDR_ANY
)
1696 if (!PIM_UPSTREAM_FLAG_TEST_SRC_IGMP(up
->flags
))
1699 pim_channel_add_oif(up
->channel_oil
, pim
->regiface
,
1700 PIM_OIF_FLAG_PROTO_IGMP
);
1704 void pim_upstream_spt_prefix_list_update(struct pim_instance
*pim
,
1705 struct prefix_list
*pl
)
1707 const char *pname
= prefix_list_name(pl
);
1709 if (pim
->spt
.plist
&& strcmp(pim
->spt
.plist
, pname
) == 0) {
1710 pim_upstream_remove_lhr_star_pimreg(pim
, pname
);
1715 * nlist -> The new prefix list
1717 * Per Group Application of pimreg to the OIL
1718 * If the prefix list tells us DENY then
1719 * we need to Switchover to SPT immediate
1720 * so add the pimreg.
1721 * If the prefix list tells us to ACCEPT than
1722 * we need to Never do the SPT so remove
1726 void pim_upstream_remove_lhr_star_pimreg(struct pim_instance
*pim
,
1729 struct pim_upstream
*up
;
1730 struct listnode
*node
;
1731 struct prefix_list
*np
;
1733 enum prefix_list_type apply_new
;
1735 np
= prefix_list_lookup(AFI_IP
, nlist
);
1738 g
.prefixlen
= IPV4_MAX_PREFIXLEN
;
1740 for (ALL_LIST_ELEMENTS_RO(pim
->upstream_list
, node
, up
)) {
1741 if (up
->sg
.src
.s_addr
!= INADDR_ANY
)
1744 if (!PIM_UPSTREAM_FLAG_TEST_SRC_IGMP(up
->flags
))
1748 pim_channel_del_oif(up
->channel_oil
, pim
->regiface
,
1749 PIM_OIF_FLAG_PROTO_IGMP
);
1752 g
.u
.prefix4
= up
->sg
.grp
;
1753 apply_new
= prefix_list_apply(np
, &g
);
1754 if (apply_new
== PREFIX_DENY
)
1755 pim_channel_add_oif(up
->channel_oil
, pim
->regiface
,
1756 PIM_OIF_FLAG_PROTO_IGMP
);
1758 pim_channel_del_oif(up
->channel_oil
, pim
->regiface
,
1759 PIM_OIF_FLAG_PROTO_IGMP
);
1763 void pim_upstream_init(struct pim_instance
*pim
)
1767 pim
->upstream_sg_wheel
=
1768 wheel_init(master
, 31000, 100, pim_upstream_hash_key
,
1769 pim_upstream_sg_running
);
1771 snprintf(hash_name
, 64, "PIM %s Upstream Hash", pim
->vrf
->name
);
1772 pim
->upstream_hash
= hash_create_size(8192, pim_upstream_hash_key
,
1773 pim_upstream_equal
, hash_name
);
1775 pim
->upstream_list
= list_new();
1776 pim
->upstream_list
->del
= (void (*)(void *))pim_upstream_free
;
1777 pim
->upstream_list
->cmp
= pim_upstream_compare
;