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
20 #ifndef PIM_UPSTREAM_H
21 #define PIM_UPSTREAM_H
27 #include <pimd/pim_rpf.h>
29 #include "pim_ifchannel.h"
31 #define PIM_UPSTREAM_FLAG_MASK_DR_JOIN_DESIRED (1 << 0)
32 #define PIM_UPSTREAM_FLAG_MASK_DR_JOIN_DESIRED_UPDATED (1 << 1)
33 #define PIM_UPSTREAM_FLAG_MASK_FHR (1 << 2)
34 #define PIM_UPSTREAM_FLAG_MASK_SRC_IGMP (1 << 3)
35 #define PIM_UPSTREAM_FLAG_MASK_SRC_PIM (1 << 4)
36 #define PIM_UPSTREAM_FLAG_MASK_SRC_STREAM (1 << 5)
37 #define PIM_UPSTREAM_FLAG_MASK_SRC_MSDP (1 << 6)
38 #define PIM_UPSTREAM_FLAG_MASK_SEND_SG_RPT_PRUNE (1 << 7)
39 #define PIM_UPSTREAM_FLAG_MASK_SRC_LHR (1 << 8)
40 /* In the case of pim vxlan we prime the pump by registering the
41 * vxlan source and keeping the SPT (FHR-RP) alive by sending periodic
42 * NULL registers. So we need to prevent KAT expiry because of the
43 * lack of BUM traffic.
45 #define PIM_UPSTREAM_FLAG_MASK_DISABLE_KAT_EXPIRY (1 << 9)
46 /* for pim vxlan we need to pin the IIF to lo or MLAG-ISL on the
47 * originating VTEP. This flag allows that by setting IIF to the
48 * value specified and preventing next-hop-tracking on the entry
50 #define PIM_UPSTREAM_FLAG_MASK_STATIC_IIF (1 << 10)
51 #define PIM_UPSTREAM_FLAG_MASK_ALLOW_IIF_IN_OIL (1 << 11)
52 /* Disable pimreg encasulation for a flow */
53 #define PIM_UPSTREAM_FLAG_MASK_NO_PIMREG_DATA (1 << 12)
54 /* For some MDTs we need to register the router as a source even
55 * if the not DR or directly connected on the IIF. This is typically
56 * needed on a VxLAN-AA (MLAG) setup.
58 #define PIM_UPSTREAM_FLAG_MASK_FORCE_PIMREG (1 << 13)
59 /* VxLAN origination mroute - SG was registered by EVPN where S is the
60 * local VTEP IP and G is the BUM multicast group address
62 #define PIM_UPSTREAM_FLAG_MASK_SRC_VXLAN_ORIG (1 << 14)
63 /* VxLAN termination mroute - *G entry where G is the BUM multicast group
66 #define PIM_UPSTREAM_FLAG_MASK_SRC_VXLAN_TERM (1 << 15)
67 /* MLAG mroute - synced to the MLAG peer and subject to DF (designated
70 #define PIM_UPSTREAM_FLAG_MASK_MLAG_VXLAN (1 << 16)
71 /* MLAG mroute that lost the DF election with peer and is installed in
72 * a dormant state i.e. MLAG OIFs are removed from the MFC.
73 * In most cases the OIL is empty (but not not always) simply
74 * blackholing the traffic pulled down to the LHR.
76 #define PIM_UPSTREAM_FLAG_MASK_MLAG_NON_DF (1 << 17)
78 * We are creating a non-joined upstream data structure
79 * for this S,G as that we want to have a channel oil
80 * associated with an upstream
82 #define PIM_UPSTREAM_FLAG_MASK_SRC_NOCACHE (1 << 19)
83 /* By default as SG entry will use the SPT for forwarding traffic
84 * unless it was setup as a result of a Prune(S,G,rpt) from a
85 * downstream router and has JoinDesired(S,G) as False.
86 * This flag is only relevant for (S,G) entries.
88 #define PIM_UPSTREAM_FLAG_MASK_USE_RPT (1 << 20)
90 #define PIM_UPSTREAM_FLAG_ALL 0xFFFFFFFF
92 #define PIM_UPSTREAM_FLAG_TEST_DR_JOIN_DESIRED(flags) ((flags) & PIM_UPSTREAM_FLAG_MASK_DR_JOIN_DESIRED)
93 #define PIM_UPSTREAM_FLAG_TEST_DR_JOIN_DESIRED_UPDATED(flags) ((flags) & PIM_UPSTREAM_FLAG_MASK_DR_JOIN_DESIRED_UPDATED)
94 #define PIM_UPSTREAM_FLAG_TEST_FHR(flags) ((flags) & PIM_UPSTREAM_FLAG_MASK_FHR)
95 #define PIM_UPSTREAM_FLAG_TEST_SRC_IGMP(flags) ((flags) & PIM_UPSTREAM_FLAG_MASK_SRC_IGMP)
96 #define PIM_UPSTREAM_FLAG_TEST_SRC_PIM(flags) ((flags) & PIM_UPSTREAM_FLAG_MASK_SRC_PIM)
97 #define PIM_UPSTREAM_FLAG_TEST_SRC_STREAM(flags) ((flags) & PIM_UPSTREAM_FLAG_MASK_SRC_STREAM)
98 #define PIM_UPSTREAM_FLAG_TEST_SRC_MSDP(flags) ((flags) & PIM_UPSTREAM_FLAG_MASK_SRC_MSDP)
99 #define PIM_UPSTREAM_FLAG_TEST_SEND_SG_RPT_PRUNE(flags) ((flags) & PIM_UPSTREAM_FLAG_MASK_SEND_SG_RPT_PRUNE)
100 #define PIM_UPSTREAM_FLAG_TEST_SRC_LHR(flags) ((flags) & PIM_UPSTREAM_FLAG_MASK_SRC_LHR)
101 #define PIM_UPSTREAM_FLAG_TEST_DISABLE_KAT_EXPIRY(flags) ((flags) & PIM_UPSTREAM_FLAG_MASK_DISABLE_KAT_EXPIRY)
102 #define PIM_UPSTREAM_FLAG_TEST_STATIC_IIF(flags) ((flags) & PIM_UPSTREAM_FLAG_MASK_STATIC_IIF)
103 #define PIM_UPSTREAM_FLAG_TEST_ALLOW_IIF_IN_OIL(flags) ((flags) & PIM_UPSTREAM_FLAG_MASK_ALLOW_IIF_IN_OIL)
104 #define PIM_UPSTREAM_FLAG_TEST_NO_PIMREG_DATA(flags) ((flags) & PIM_UPSTREAM_FLAG_MASK_NO_PIMREG_DATA)
105 #define PIM_UPSTREAM_FLAG_TEST_FORCE_PIMREG(flags) ((flags) & PIM_UPSTREAM_FLAG_MASK_FORCE_PIMREG)
106 #define PIM_UPSTREAM_FLAG_TEST_SRC_VXLAN_ORIG(flags) ((flags) & PIM_UPSTREAM_FLAG_MASK_SRC_VXLAN_ORIG)
107 #define PIM_UPSTREAM_FLAG_TEST_SRC_VXLAN_TERM(flags) ((flags) & PIM_UPSTREAM_FLAG_MASK_SRC_VXLAN_TERM)
108 #define PIM_UPSTREAM_FLAG_TEST_SRC_VXLAN(flags) ((flags) & (PIM_UPSTREAM_FLAG_MASK_SRC_VXLAN_ORIG | PIM_UPSTREAM_FLAG_MASK_SRC_VXLAN_TERM))
109 #define PIM_UPSTREAM_FLAG_TEST_MLAG_VXLAN(flags) ((flags) & PIM_UPSTREAM_FLAG_MASK_MLAG_VXLAN)
110 #define PIM_UPSTREAM_FLAG_TEST_MLAG_NON_DF(flags) ((flags) & PIM_UPSTREAM_FLAG_MASK_MLAG_NON_DF)
111 #define PIM_UPSTREAM_FLAG_TEST_SRC_NOCACHE(flags) ((flags) &PIM_UPSTREAM_FLAG_MASK_SRC_NOCACHE)
112 #define PIM_UPSTREAM_FLAG_TEST_USE_RPT(flags) ((flags) & PIM_UPSTREAM_FLAG_MASK_USE_RPT)
114 #define PIM_UPSTREAM_FLAG_SET_DR_JOIN_DESIRED(flags) ((flags) |= PIM_UPSTREAM_FLAG_MASK_DR_JOIN_DESIRED)
115 #define PIM_UPSTREAM_FLAG_SET_DR_JOIN_DESIRED_UPDATED(flags) ((flags) |= PIM_UPSTREAM_FLAG_MASK_DR_JOIN_DESIRED_UPDATED)
116 #define PIM_UPSTREAM_FLAG_SET_FHR(flags) ((flags) |= PIM_UPSTREAM_FLAG_MASK_FHR)
117 #define PIM_UPSTREAM_FLAG_SET_SRC_IGMP(flags) ((flags) |= PIM_UPSTREAM_FLAG_MASK_SRC_IGMP)
118 #define PIM_UPSTREAM_FLAG_SET_SRC_PIM(flags) ((flags) |= PIM_UPSTREAM_FLAG_MASK_SRC_PIM)
119 #define PIM_UPSTREAM_FLAG_SET_SRC_STREAM(flags) ((flags) |= PIM_UPSTREAM_FLAG_MASK_SRC_STREAM)
120 #define PIM_UPSTREAM_FLAG_SET_SRC_MSDP(flags) ((flags) |= PIM_UPSTREAM_FLAG_MASK_SRC_MSDP)
121 #define PIM_UPSTREAM_FLAG_SET_SEND_SG_RPT_PRUNE(flags) ((flags) |= PIM_UPSTREAM_FLAG_MASK_SEND_SG_RPT_PRUNE)
122 #define PIM_UPSTREAM_FLAG_SET_SRC_LHR(flags) ((flags) |= PIM_UPSTREAM_FLAG_MASK_SRC_LHR)
123 #define PIM_UPSTREAM_FLAG_SET_DISABLE_KAT_EXPIRY(flags) ((flags) |= PIM_UPSTREAM_FLAG_MASK_DISABLE_KAT_EXPIRY)
124 #define PIM_UPSTREAM_FLAG_SET_STATIC_IIF(flags) ((flags) |= PIM_UPSTREAM_FLAG_MASK_STATIC_IIF)
125 #define PIM_UPSTREAM_FLAG_SET_ALLOW_IIF_IN_OIL(flags) ((flags) |= PIM_UPSTREAM_FLAG_MASK_ALLOW_IIF_IN_OIL)
126 #define PIM_UPSTREAM_FLAG_SET_NO_PIMREG_DATA(flags) ((flags) |= PIM_UPSTREAM_FLAG_MASK_NO_PIMREG_DATA)
127 #define PIM_UPSTREAM_FLAG_SET_FORCE_PIMREG(flags) ((flags) |= PIM_UPSTREAM_FLAG_MASK_FORCE_PIMREG)
128 #define PIM_UPSTREAM_FLAG_SET_SRC_VXLAN_ORIG(flags) ((flags) |= PIM_UPSTREAM_FLAG_MASK_SRC_VXLAN_ORIG)
129 #define PIM_UPSTREAM_FLAG_SET_SRC_VXLAN_TERM(flags) ((flags) |= PIM_UPSTREAM_FLAG_MASK_SRC_VXLAN_TERM)
130 #define PIM_UPSTREAM_FLAG_SET_MLAG_VXLAN(flags) ((flags) |= PIM_UPSTREAM_FLAG_MASK_MLAG_VXLAN)
131 #define PIM_UPSTREAM_FLAG_SET_MLAG_NON_DF(flags) ((flags) |= PIM_UPSTREAM_FLAG_MASK_MLAG_NON_DF)
132 #define PIM_UPSTREAM_FLAG_SET_USE_RPT(flags) ((flags) |= PIM_UPSTREAM_FLAG_MASK_USE_RPT)
134 #define PIM_UPSTREAM_FLAG_UNSET_DR_JOIN_DESIRED(flags) ((flags) &= ~PIM_UPSTREAM_FLAG_MASK_DR_JOIN_DESIRED)
135 #define PIM_UPSTREAM_FLAG_UNSET_DR_JOIN_DESIRED_UPDATED(flags) ((flags) &= ~PIM_UPSTREAM_FLAG_MASK_DR_JOIN_DESIRED_UPDATED)
136 #define PIM_UPSTREAM_FLAG_UNSET_FHR(flags) ((flags) &= ~PIM_UPSTREAM_FLAG_MASK_FHR)
137 #define PIM_UPSTREAM_FLAG_UNSET_SRC_IGMP(flags) ((flags) &= ~PIM_UPSTREAM_FLAG_MASK_SRC_IGMP)
138 #define PIM_UPSTREAM_FLAG_UNSET_SRC_PIM(flags) ((flags) &= ~PIM_UPSTREAM_FLAG_MASK_SRC_PIM)
139 #define PIM_UPSTREAM_FLAG_UNSET_SRC_STREAM(flags) ((flags) &= ~PIM_UPSTREAM_FLAG_MASK_SRC_STREAM)
140 #define PIM_UPSTREAM_FLAG_UNSET_SRC_MSDP(flags) ((flags) &= ~PIM_UPSTREAM_FLAG_MASK_SRC_MSDP)
141 #define PIM_UPSTREAM_FLAG_UNSET_SEND_SG_RPT_PRUNE(flags) ((flags) &= ~PIM_UPSTREAM_FLAG_MASK_SEND_SG_RPT_PRUNE)
142 #define PIM_UPSTREAM_FLAG_UNSET_SRC_LHR(flags) ((flags) &= ~PIM_UPSTREAM_FLAG_MASK_SRC_LHR)
143 #define PIM_UPSTREAM_FLAG_UNSET_DISABLE_KAT_EXPIRY(flags) ((flags) &= ~PIM_UPSTREAM_FLAG_MASK_DISABLE_KAT_EXPIRY)
144 #define PIM_UPSTREAM_FLAG_UNSET_STATIC_IIF(flags) ((flags) &= ~PIM_UPSTREAM_FLAG_MASK_STATIC_IIF)
145 #define PIM_UPSTREAM_FLAG_UNSET_ALLOW_IIF_IN_OIL(flags) ((flags) &= ~PIM_UPSTREAM_FLAG_MASK_ALLOW_IIF_IN_OIL)
146 #define PIM_UPSTREAM_FLAG_UNSET_NO_PIMREG_DATA(flags) ((flags) &= ~PIM_UPSTREAM_FLAG_MASK_NO_PIMREG_DATA)
147 #define PIM_UPSTREAM_FLAG_UNSET_FORCE_PIMREG(flags) ((flags) &= ~PIM_UPSTREAM_FLAG_MASK_FORCE_PIMREG)
148 #define PIM_UPSTREAM_FLAG_UNSET_SRC_VXLAN_ORIG(flags) ((flags) &= ~PIM_UPSTREAM_FLAG_MASK_SRC_VXLAN_ORIG)
149 #define PIM_UPSTREAM_FLAG_UNSET_SRC_VXLAN_TERM(flags) ((flags) &= ~PIM_UPSTREAM_FLAG_MASK_SRC_VXLAN_TERM)
150 #define PIM_UPSTREAM_FLAG_UNSET_MLAG_VXLAN(flags) ((flags) &= ~PIM_UPSTREAM_FLAG_MASK_MLAG_VXLAN)
151 #define PIM_UPSTREAM_FLAG_UNSET_MLAG_NON_DF(flags) ((flags) &= ~PIM_UPSTREAM_FLAG_MASK_MLAG_NON_DF)
152 #define PIM_UPSTREAM_FLAG_UNSET_SRC_NOCACHE(flags) ((flags) &= ~PIM_UPSTREAM_FLAG_MASK_SRC_NOCACHE)
153 #define PIM_UPSTREAM_FLAG_UNSET_USE_RPT(flags) ((flags) &= ~PIM_UPSTREAM_FLAG_MASK_USE_RPT)
155 enum pim_upstream_state
{
156 PIM_UPSTREAM_NOTJOINED
,
163 PIM_REG_JOIN_PENDING
,
167 enum pim_upstream_sptbit
{
168 PIM_UPSTREAM_SPTBIT_FALSE
,
169 PIM_UPSTREAM_SPTBIT_TRUE
172 PREDECL_RBTREE_UNIQ(rb_pim_upstream
);
174 Upstream (S,G) channel in Joined state
175 (S,G) in the "Not Joined" state is not represented
176 See RFC 4601: 4.5.7. Sending (S,G) Join/Prune Message
178 upstream_addr : Who we are talking to.
179 For (*, G), upstream_addr is RP address or INADDR_ANY(if RP not configured)
180 For (S, G), upstream_addr is source address
182 rpf: contains the nexthop information to whom we are talking to.
184 join_state: JOINED/NOTJOINED
186 In the case when FRR receives IGMP/PIM (*, G) join for group G and RP is not
187 configured, then create a pim_upstream with the below information.
188 pim_upstream->upstream address: INADDR_ANY
189 pim_upstream->rpf: Unknown
190 pim_upstream->state: NOTJOINED
192 When a new RP gets configured for G, find the corresponding pim upstream (*,G)
193 entries and update the upstream address as new RP address if it the better one
196 When RP becomes reachable, populate the nexthop information in
197 pim_upstream->rpf and update the state to JOINED.
200 struct pim_upstream
{
201 struct pim_instance
*pim
;
202 struct rb_pim_upstream_item upstream_rb
;
203 struct pim_upstream
*parent
;
204 struct in_addr upstream_addr
; /* Who we are talking to */
205 struct in_addr upstream_register
; /*Who we received a register from*/
206 struct prefix_sg sg
; /* (S,G) group key */
207 char sg_str
[PIM_SG_LEN
];
209 struct channel_oil
*channel_oil
;
210 struct list
*sources
;
211 struct list
*ifchannels
;
213 enum pim_upstream_state join_state
;
214 enum pim_reg_state reg_state
;
215 enum pim_upstream_sptbit sptbit
;
221 struct thread
*t_join_timer
;
226 struct thread
*t_rs_timer
;
227 #define PIM_REGISTER_SUPPRESSION_PERIOD (60)
228 #define PIM_REGISTER_PROBE_PERIOD (5)
233 struct thread
*t_ka_timer
;
234 #define PIM_KEEPALIVE_PERIOD (210)
235 #define PIM_RP_KEEPALIVE_PERIOD \
236 (3 * router->register_suppress_time + router->register_probe_time)
238 /* on the RP we restart a timer to indicate if registers are being rxed
240 * SG. This is needed by MSDP to determine its local SA cache */
241 struct thread
*t_msdp_reg_timer
;
242 #define PIM_MSDP_REG_RXED_PERIOD (3 * (1.5 * router->register_suppress_time))
244 int64_t state_transition
; /* Record current state uptime */
247 static inline bool pim_upstream_is_kat_running(struct pim_upstream
*up
)
249 return (up
->t_ka_timer
!= NULL
);
252 struct pim_upstream
*pim_upstream_find(struct pim_instance
*pim
,
253 struct prefix_sg
*sg
);
254 struct pim_upstream
*pim_upstream_find_or_add(struct prefix_sg
*sg
,
255 struct interface
*ifp
, int flags
,
257 struct pim_upstream
*pim_upstream_add(struct pim_instance
*pim
,
258 struct prefix_sg
*sg
,
259 struct interface
*ifp
, int flags
,
261 struct pim_ifchannel
*ch
);
262 void pim_upstream_ref(struct pim_upstream
*up
, int flags
, const char *name
);
263 struct pim_upstream
*pim_upstream_del(struct pim_instance
*pim
,
264 struct pim_upstream
*up
,
267 int pim_upstream_evaluate_join_desired(struct pim_instance
*pim
,
268 struct pim_upstream
*up
);
269 int pim_upstream_evaluate_join_desired_interface(struct pim_upstream
*up
,
270 struct pim_ifchannel
*ch
,
271 struct pim_ifchannel
*starch
);
272 int pim_upstream_eval_inherit_if(struct pim_upstream
*up
,
273 struct pim_ifchannel
*ch
,
274 struct pim_ifchannel
*starch
);
275 void pim_upstream_update_join_desired(struct pim_instance
*pim
,
276 struct pim_upstream
*up
);
278 void pim_upstream_join_suppress(struct pim_upstream
*up
,
279 struct in_addr rpf_addr
, int holdtime
);
281 void pim_upstream_join_timer_decrease_to_t_override(const char *debug_label
,
282 struct pim_upstream
*up
);
284 void pim_upstream_join_timer_restart(struct pim_upstream
*up
,
285 struct pim_rpf
*old
);
286 void pim_upstream_rpf_genid_changed(struct pim_instance
*pim
,
287 struct in_addr neigh_addr
);
288 void pim_upstream_rpf_interface_changed(struct pim_upstream
*up
,
289 struct interface
*old_rpf_ifp
);
291 void pim_upstream_update_could_assert(struct pim_upstream
*up
);
292 void pim_upstream_update_my_assert_metric(struct pim_upstream
*up
);
294 void pim_upstream_keep_alive_timer_start(struct pim_upstream
*up
,
297 int pim_upstream_switch_to_spt_desired_on_rp(struct pim_instance
*pim
,
298 struct prefix_sg
*sg
);
299 #define SwitchToSptDesiredOnRp(pim, sg) pim_upstream_switch_to_spt_desired_on_rp (pim, sg)
300 int pim_upstream_is_sg_rpt(struct pim_upstream
*up
);
302 void pim_upstream_set_sptbit(struct pim_upstream
*up
,
303 struct interface
*incoming
);
305 void pim_upstream_start_register_stop_timer(struct pim_upstream
*up
,
308 void pim_upstream_send_join(struct pim_upstream
*up
);
310 void pim_upstream_switch(struct pim_instance
*pim
, struct pim_upstream
*up
,
311 enum pim_upstream_state new_state
);
313 const char *pim_upstream_state2str(enum pim_upstream_state join_state
);
314 #define PIM_REG_STATE_STR_LEN 12
315 const char *pim_reg_state2str(enum pim_reg_state state
, char *state_str
,
316 size_t state_str_len
);
318 int pim_upstream_inherited_olist_decide(struct pim_instance
*pim
,
319 struct pim_upstream
*up
);
320 int pim_upstream_inherited_olist(struct pim_instance
*pim
,
321 struct pim_upstream
*up
);
322 int pim_upstream_empty_inherited_olist(struct pim_upstream
*up
);
324 void pim_upstream_find_new_rpf(struct pim_instance
*pim
);
325 void pim_upstream_msdp_reg_timer_start(struct pim_upstream
*up
);
327 void pim_upstream_init(struct pim_instance
*pim
);
328 void pim_upstream_terminate(struct pim_instance
*pim
);
330 void join_timer_start(struct pim_upstream
*up
);
331 int pim_upstream_compare(const struct pim_upstream
*up1
,
332 const struct pim_upstream
*up2
);
333 DECLARE_RBTREE_UNIQ(rb_pim_upstream
, struct pim_upstream
, upstream_rb
,
334 pim_upstream_compare
)
336 void pim_upstream_register_reevaluate(struct pim_instance
*pim
);
338 void pim_upstream_add_lhr_star_pimreg(struct pim_instance
*pim
);
339 void pim_upstream_remove_lhr_star_pimreg(struct pim_instance
*pim
,
342 void pim_upstream_spt_prefix_list_update(struct pim_instance
*pim
,
343 struct prefix_list
*pl
);
345 unsigned int pim_upstream_hash_key(const void *arg
);
346 bool pim_upstream_equal(const void *arg1
, const void *arg2
);
347 struct pim_upstream
*pim_upstream_keep_alive_timer_proc(
348 struct pim_upstream
*up
);
349 void pim_upstream_fill_static_iif(struct pim_upstream
*up
,
350 struct interface
*incoming
);
351 void pim_upstream_update_use_rpt(struct pim_upstream
*up
,
353 void pim_upstream_reeval_use_rpt(struct pim_instance
*pim
);
354 #endif /* PIM_UPSTREAM_H */