1 // SPDX-License-Identifier: GPL-2.0-or-later
3 * Zebra EVPN MH Data structures and definitions
5 * Copyright (C) 2019 Cumulus Networks, Inc.
9 #ifndef _ZEBRA_EVPN_MH_H
10 #define _ZEBRA_EVPN_MH_H
17 #include "zebra_vxlan.h"
18 #include "zebra_vxlan_private.h"
19 #include "zebra_nhg.h"
21 #define EVPN_MH_VTY_STR "Multihoming\n"
23 /* Ethernet Segment entry -
24 * - Local and remote ESs are maintained in a global RB tree,
25 * zmh_info->es_rb_tree using ESI as key
26 * - Local ESs are added via zebra config (ZEBRA_EVPNES_LOCAL) when an
27 * access port is associated with an ES-ID
28 * - Remotes ESs are added by BGP based on received/remote EAD/Type-1 routes
29 * (ZEBRA_EVPNES_REMOTE)
30 * - An ES can be simultaneously LOCAL and REMOTE; infact all LOCAL ESs are
31 * expected to have REMOTE ES peers.
33 struct zebra_evpn_es
{
35 char esi_str
[ESI_STR_LEN
];
39 #define ZEBRA_EVPNES_LOCAL (1 << 0) /* configured in zebra */
40 #define ZEBRA_EVPNES_REMOTE (1 << 1) /* added by bgp */
41 #define ZEBRA_EVPNES_OPER_UP (1 << 2) /* es->ifp is oper-up */
42 #define ZEBRA_EVPNES_READY_FOR_BGP (1 << 3) /* ready to be sent to BGP */
43 #define ZEBRA_EVPNES_NHG_ACTIVE (1 << 4) /* NHG has been installed */
44 /* This flag is only applicable to local ESs and signifies that this
47 #define ZEBRA_EVPNES_NON_DF (1 << 5)
48 /* When the ES becomes a bridge port we need to activate the BUM non-DF
49 * filter, SPH filter and backup NHG for fast-failover
51 #define ZEBRA_EVPNES_BR_PORT (1 << 6)
52 /* ES is in bypass mode i.e. must not be advertised. ES-bypass is set
53 * when the associated host bond goes into LACP bypass
55 #define ZEBRA_EVPNES_BYPASS (1 << 7)
57 /* memory used for adding the es to zmh_info->es_rb_tree */
58 RB_ENTRY(zebra_evpn_es
) rb_node
;
60 /* [EVPNES_LOCAL] memory used for linking the es to
61 * zmh_info->local_es_list
63 struct listnode local_es_listnode
;
65 /* [EVPNES_LOCAL] corresponding interface */
68 /* list of ES-EVIs associated with the ES */
69 struct list
*es_evi_list
;
71 /* [!EVPNES_LOCAL] List of remote VTEPs (zebra_evpn_es_vtep) */
72 struct list
*es_vtep_list
;
74 /* list of zebra_mac entries using this ES as destination */
75 struct list
*mac_list
;
77 /* Nexthop group id */
80 /* Preference config for BUM-DF election. Sent to BGP and
81 * advertised via the ESR
85 /* When a new ES is configured it is held in a non-DF state
86 * for 3 seconds. This allows the peer Type-4 routes to be
87 * imported before running the DF election.
89 #define ZEBRA_EVPN_MH_DF_DELAY_TIME 3 /* seconds */
90 struct event
*df_delay_timer
;
92 RB_HEAD(zebra_es_rb_head
, zebra_evpn_es
);
93 RB_PROTOTYPE(zebra_es_rb_head
, zebra_evpn_es
, rb_node
, zebra_es_rb_cmp
);
96 * - ES-EVIs are maintained per-EVPN (vni->es_evi_rb_tree)
97 * - Local ES-EVIs are linked to per-EVPN list for quick access
98 * - Although some infrastucture is present for remote ES-EVIs, currently
99 * BGP does NOT send remote ES-EVIs to zebra. This may change in the
100 * future (but must be changed thoughtfully and only if needed as ES-EVI
101 * can get prolific and come in the way of rapid failovers)
103 struct zebra_evpn_es_evi
{
104 struct zebra_evpn_es
*es
;
105 struct zebra_evpn
*zevpn
;
110 #define ZEBRA_EVPNES_EVI_LOCAL (1 << 0) /* created by zebra */
111 #define ZEBRA_EVPNES_EVI_READY_FOR_BGP (1 << 1) /* ready to be sent to BGP */
113 /* memory used for adding the es_evi to
114 * es_evi->zevpn->es_evi_rb_tree
116 RB_ENTRY(zebra_evpn_es_evi
) rb_node
;
117 /* memory used for linking the es_evi to
118 * es_evi->zevpn->local_es_evi_list
120 struct listnode l2vni_listnode
;
121 /* memory used for linking the es_evi to
122 * es_evi->es->es_evi_list
124 struct listnode es_listnode
;
127 /* A single L2 nexthop is allocated across all ESs with the same PE/VTEP
130 struct zebra_evpn_l2_nh
{
131 struct in_addr vtep_ip
;
136 /* es_vtep entries using this nexthop */
140 /* PE attached to an ES */
141 struct zebra_evpn_es_vtep
{
142 struct zebra_evpn_es
*es
; /* parent ES */
143 struct in_addr vtep_ip
;
146 /* Rxed Type-4 route from this VTEP */
147 #define ZEBRA_EVPNES_VTEP_RXED_ESR (1 << 0)
148 #define ZEBRA_EVPNES_VTEP_DEL_IN_PROG (1 << 1)
150 /* MAC nexthop info */
151 struct zebra_evpn_l2_nh
*nh
;
153 /* memory used for adding the entry to es->es_vtep_list */
154 struct listnode es_listnode
;
156 /* Parameters for DF election */
160 /* XXX - maintain a backpointer to struct zebra_vtep */
163 /* Local/access-side broadcast domain - zebra_evpn_access_bd is added to -
164 * zrouter->evpn_vlan_table (for VLAN aware bridges) OR
165 * zrouter->evpn_bridge_table (for VLAN unaware bridges)
166 * XXX - support for VLAN unaware bridges is yet to be flushed out
168 struct zebra_evpn_access_bd
{
171 ifindex_t bridge_ifindex
;
172 struct zebra_if
*bridge_zif
; /* associated bridge */
174 vni_t vni
; /* vni associated with the vxlan device */
175 struct zebra_if
*vxlan_zif
; /* vxlan device */
176 /* list of members associated with the BD i.e. (potential) ESs */
177 struct list
*mbr_zifs
;
178 /* presence of zevpn activates the EVI on all the ESs in mbr_zifs */
179 struct zebra_evpn
*zevpn
;
180 /* SVI associated with the VLAN */
181 struct zebra_if
*vlan_zif
;
184 /* multihoming information stored in zrouter */
185 #define zmh_info (zrouter.mh_info)
186 struct zebra_evpn_mh_info
{
188 /* If the dataplane is not capable of handling a backup NHG on an access
189 * port we will need to explicitly failover each MAC entry on
192 #define ZEBRA_EVPN_MH_REDIRECT_OFF (1 << 0)
193 /* DAD support for EVPN-MH is yet to be added. So on detection of
194 * first local ES, DAD is turned off
196 #define ZEBRA_EVPN_MH_DUP_ADDR_DETECT_OFF (1 << 1)
197 /* If EVPN MH is enabled we only advertise REACHABLE neigh entries as Type-2
198 * routes. As there is no global config knob for enabling EVPN MH we turn
199 * this flag when the first local ES is detected.
201 #define ZEBRA_EVPN_MH_ADV_REACHABLE_NEIGH_ONLY (1 << 2)
202 /* If EVPN MH is enabled we advertise the SVI MAC address to avoid
203 * flooding of ARP replies rxed from the multi-homed host
205 #define ZEBRA_EVPN_MH_ADV_SVI_MAC (1 << 3)
207 /* RB tree of Ethernet segments (used for EVPN-MH) */
208 struct zebra_es_rb_head es_rb_tree
;
209 /* List of local ESs */
210 struct list
*local_es_list
;
212 /* EVPN MH broadcast domains indexed by the VID */
213 struct hash
*evpn_vlan_table
;
215 /* A base L2-VNI is maintained to derive parameters such as
217 * XXX: once single vxlan device model becomes available this will
220 struct zebra_evpn
*es_base_evpn
;
221 struct in_addr es_originator_ip
;
223 /* L2 NH and NHG ids -
224 * Most significant 4 bits is type. Lower 28 bits is the value
225 * allocated from the nh_id_bitmap.
227 bitfield_t nh_id_bitmap
;
228 #define EVPN_NH_ID_MAX (16*1024)
229 #define EVPN_NH_ID_VAL_MASK 0xffffff
230 /* The purpose of using different types for NHG and NH is NOT to manage the
231 * id space separately. It is simply to make debugging easier.
233 #define EVPN_NH_ID_TYPE_BIT (NHG_TYPE_L2_NH << NHG_ID_TYPE_POS)
234 #define EVPN_NHG_ID_TYPE_BIT (NHG_TYPE_L2 << NHG_ID_TYPE_POS)
235 /* L2-NHG table - key: nhg_id, data: zebra_evpn_es */
236 struct hash
*nhg_table
;
237 /* L2-NH table - key: vtep_up, data: zebra_evpn_nh */
238 struct hash
*nh_ip_table
;
240 /* XXX - re-visit the default hold timer value */
242 #define ZEBRA_EVPN_MH_MAC_HOLD_TIME_DEF (18 * 60)
244 #define ZEBRA_EVPN_MH_NEIGH_HOLD_TIME_DEF (18 * 60)
246 /* During this period access ports will be held in a protodown
249 int startup_delay_time
; /* seconds */
250 #define ZEBRA_EVPN_MH_STARTUP_DELAY_DEF (3 * 60)
251 struct event
*startup_delay_timer
;
253 /* Number of configured uplinks */
254 uint32_t uplink_cfg_cnt
;
255 /* Number of operationally-up uplinks */
256 uint32_t uplink_oper_up_cnt
;
258 /* These protodown bits are inherited by all ES bonds */
259 uint32_t protodown_rc
;
262 /* returns TRUE if the EVPN is ready to be sent to BGP */
263 static inline bool zebra_evpn_send_to_client_ok(struct zebra_evpn
*zevpn
)
265 return !!(zevpn
->flags
& ZEVPN_READY_FOR_BGP
);
268 static inline bool zebra_evpn_mac_is_es_local(struct zebra_mac
*mac
)
270 return mac
->es
&& (mac
->es
->flags
& ZEBRA_EVPNES_LOCAL
);
273 /* Returns true if the id is of L2-NHG or L2-NH type */
274 static inline bool zebra_evpn_mh_is_fdb_nh(uint32_t id
)
276 return ((id
& EVPN_NHG_ID_TYPE_BIT
) ||
277 (id
& EVPN_NH_ID_TYPE_BIT
));
281 zebra_evpn_es_local_mac_via_network_port(struct zebra_evpn_es
*es
)
283 return !(es
->flags
& ZEBRA_EVPNES_OPER_UP
)
284 && (zmh_info
->flags
& ZEBRA_EVPN_MH_REDIRECT_OFF
);
287 static inline bool zebra_evpn_mh_do_dup_addr_detect(void)
289 return !(zmh_info
->flags
& ZEBRA_EVPN_MH_DUP_ADDR_DETECT_OFF
);
292 static inline bool zebra_evpn_mh_do_adv_reachable_neigh_only(void)
294 return !!(zmh_info
->flags
& ZEBRA_EVPN_MH_ADV_REACHABLE_NEIGH_ONLY
);
297 static inline bool zebra_evpn_mh_do_adv_svi_mac(void)
299 return zmh_info
&& (zmh_info
->flags
& ZEBRA_EVPN_MH_ADV_SVI_MAC
);
302 /*****************************************************************************/
303 extern esi_t
*zero_esi
;
304 extern void zebra_evpn_mh_init(void);
305 extern void zebra_evpn_mh_terminate(void);
306 extern bool zebra_evpn_is_if_es_capable(struct zebra_if
*zif
);
307 extern void zebra_evpn_if_init(struct zebra_if
*zif
);
308 extern void zebra_evpn_if_cleanup(struct zebra_if
*zif
);
309 extern void zebra_evpn_es_evi_init(struct zebra_evpn
*zevpn
);
310 extern void zebra_evpn_es_evi_cleanup(struct zebra_evpn
*zevpn
);
311 extern void zebra_evpn_vxl_evpn_set(struct zebra_if
*zif
,
312 struct zebra_evpn
*zevpn
, bool set
);
313 extern void zebra_evpn_es_set_base_evpn(struct zebra_evpn
*zevpn
);
314 extern void zebra_evpn_es_clear_base_evpn(struct zebra_evpn
*zevpn
);
315 extern void zebra_evpn_vl_vxl_ref(uint16_t vid
, vni_t vni_id
,
316 struct zebra_if
*vxlan_zif
);
317 extern void zebra_evpn_vl_vxl_deref(uint16_t vid
, vni_t vni_id
,
318 struct zebra_if
*vxlan_zif
);
319 extern void zebra_evpn_vl_mbr_ref(uint16_t vid
, struct zebra_if
*zif
);
320 extern void zebra_evpn_vl_mbr_deref(uint16_t vid
, struct zebra_if
*zif
);
321 extern void zebra_evpn_es_send_all_to_client(bool add
);
322 extern void zebra_evpn_es_if_oper_state_change(struct zebra_if
*zif
, bool up
);
323 extern void zebra_evpn_es_show(struct vty
*vty
, bool uj
);
324 extern void zebra_evpn_es_show_detail(struct vty
*vty
, bool uj
);
325 extern void zebra_evpn_es_show_esi(struct vty
*vty
, bool uj
, esi_t
*esi
);
326 extern void zebra_evpn_update_all_es(struct zebra_evpn
*zevpn
);
327 extern void zebra_evpn_proc_remote_es(ZAPI_HANDLER_ARGS
);
328 int zebra_evpn_remote_es_add(const esi_t
*esi
, struct in_addr vtep_ip
,
329 bool esr_rxed
, uint8_t df_alg
, uint16_t df_pref
);
330 int zebra_evpn_remote_es_del(const esi_t
*esi
, struct in_addr vtep_ip
);
331 extern void zebra_evpn_es_evi_show(struct vty
*vty
, bool uj
, int detail
);
332 extern void zebra_evpn_es_evi_show_vni(struct vty
*vty
, bool uj
,
333 vni_t vni
, int detail
);
334 extern void zebra_evpn_es_mac_deref_entry(struct zebra_mac
*mac
);
335 extern bool zebra_evpn_es_mac_ref_entry(struct zebra_mac
*mac
,
336 struct zebra_evpn_es
*es
);
337 extern bool zebra_evpn_es_mac_ref(struct zebra_mac
*mac
, const esi_t
*esi
);
338 extern struct zebra_evpn_es
*zebra_evpn_es_find(const esi_t
*esi
);
339 extern void zebra_evpn_interface_init(void);
340 extern int zebra_evpn_mh_if_write(struct vty
*vty
, struct interface
*ifp
);
341 extern void zebra_evpn_acc_vl_show(struct vty
*vty
, bool uj
);
342 extern void zebra_evpn_acc_vl_show_detail(struct vty
*vty
, bool uj
);
343 extern void zebra_evpn_if_es_print(struct vty
*vty
, json_object
*json
,
344 struct zebra_if
*zif
);
345 extern struct zebra_evpn_access_bd
*
346 zebra_evpn_acc_vl_find(vlanid_t vid
, struct interface
*br_if
);
347 struct zebra_evpn_access_bd
*
348 zebra_evpn_acc_vl_find_index(vlanid_t vid
, ifindex_t bridge_ifindex
);
349 extern void zebra_evpn_acc_vl_show_vid(struct vty
*vty
, bool uj
, vlanid_t vid
,
350 struct interface
*br_if
);
351 extern void zebra_evpn_es_cleanup(void);
352 extern int zebra_evpn_mh_mac_holdtime_update(struct vty
*vty
,
353 uint32_t duration
, bool set_default
);
354 void zebra_evpn_mh_config_write(struct vty
*vty
);
355 int zebra_evpn_mh_neigh_holdtime_update(struct vty
*vty
,
356 uint32_t duration
, bool set_default
);
357 void zebra_evpn_es_local_br_port_update(struct zebra_if
*zif
);
358 extern int zebra_evpn_mh_startup_delay_update(struct vty
*vty
,
361 extern void zebra_evpn_mh_uplink_oper_update(struct zebra_if
*zif
);
362 extern void zebra_evpn_mh_update_protodown_bond_mbr(struct zebra_if
*zif
,
365 extern bool zebra_evpn_is_es_bond(struct interface
*ifp
);
366 extern bool zebra_evpn_is_es_bond_member(struct interface
*ifp
);
367 extern void zebra_evpn_mh_print(struct vty
*vty
);
368 extern void zebra_evpn_mh_json(json_object
*json
);
369 extern bool zebra_evpn_nhg_is_local_es(uint32_t nhg_id
,
370 struct zebra_evpn_es
**local_es
);
371 extern int zebra_evpn_mh_redirect_off(struct vty
*vty
, bool redirect_off
);
372 extern void zebra_evpn_l2_nh_show(struct vty
*vty
, bool uj
);
373 extern void zebra_evpn_acc_bd_svi_set(struct zebra_if
*vlan_zif
,
374 struct zebra_if
*br_zif
, bool is_up
);
375 extern void zebra_evpn_acc_bd_svi_mac_add(struct interface
*vlan_if
);
377 zebra_evpn_access_bd_bridge_cleanup(vlanid_t vid
, struct interface
*br_if
,
378 struct zebra_evpn_access_bd
*acc_bd
);
379 extern void zebra_evpn_es_bypass_update(struct zebra_evpn_es
*es
,
380 struct interface
*ifp
, bool bypass
);
381 extern void zebra_evpn_proc_remote_nh(ZAPI_HANDLER_ARGS
);
382 extern struct zebra_evpn_es_evi
*
383 zebra_evpn_es_evi_find(struct zebra_evpn_es
*es
, struct zebra_evpn
*zevpn
);
385 #endif /* _ZEBRA_EVPN_MH_H */