2 * Zebra EVPN MAC Data structures and definitions
3 * These are "internal" to this function.
4 * Copyright (C) 2016, 2017 Cumulus Networks, Inc.
5 * Copyright (C) 2020 Volta Networks.
7 * This file is part of FRR.
9 * FRR is free software; you can redistribute it and/or modify it
10 * under the terms of the GNU General Public License as published by the
11 * Free Software Foundation; either version 2, or (at your option) any
14 * FRR is distributed in the hope that it will be useful, but
15 * WITHOUT ANY WARRANTY; without even the implied warranty of
16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
17 * General Public License for more details.
19 * You should have received a copy of the GNU General Public License
20 * along with FRR; see the file COPYING. If not, write to the Free
21 * Software Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA
25 #ifndef _ZEBRA_EVPN_MAC_H
26 #define _ZEBRA_EVPN_MAC_H
32 typedef struct zebra_mac_t_ zebra_mac_t
;
34 struct host_rb_entry
{
35 RB_ENTRY(host_rb_entry
) hl_entry
;
40 RB_HEAD(host_rb_tree_entry
, host_rb_entry
);
41 RB_PROTOTYPE(host_rb_tree_entry
, host_rb_entry
, hl_entry
,
42 host_rb_entry_compare
);
46 * This table contains the MAC addresses pertaining to this VNI.
47 * This includes local MACs learnt on an attached VLAN that maps
48 * to this VNI as well as remote MACs learnt and installed by BGP.
49 * Local MACs will be known either on a VLAN sub-interface or
50 * on (port, VLAN); however, it is sufficient for zebra to maintain
51 * against the VNI i.e., it does not need to retain the local "port"
52 * information. The correct VNI will be obtained as zebra maintains
53 * the mapping (of VLAN to VNI).
57 struct ethaddr macaddr
;
59 /* When modifying flags please fixup zebra_evpn_zebra_mac_flag_dump */
61 #define ZEBRA_MAC_LOCAL 0x01
62 #define ZEBRA_MAC_REMOTE 0x02
63 #define ZEBRA_MAC_AUTO 0x04 /* Auto created for neighbor. */
64 #define ZEBRA_MAC_STICKY 0x08 /* Static MAC */
65 #define ZEBRA_MAC_REMOTE_RMAC 0x10 /* remote router mac */
66 #define ZEBRA_MAC_DEF_GW 0x20
67 /* remote VTEP advertised MAC as default GW */
68 #define ZEBRA_MAC_REMOTE_DEF_GW 0x40
69 #define ZEBRA_MAC_DUPLICATE 0x80
70 #define ZEBRA_MAC_FPM_SENT 0x100 /* whether or not this entry was sent. */
71 /* MAC is locally active on an ethernet segment peer */
72 #define ZEBRA_MAC_ES_PEER_ACTIVE 0x200
73 /* MAC has been proxy-advertised by peers. This means we need to
74 * keep the entry for forwarding but cannot advertise it
76 #define ZEBRA_MAC_ES_PEER_PROXY 0x400
77 /* We have not been able to independently establish that the host is
78 * local connected but one or more ES peers claims it is.
79 * We will maintain the entry for forwarding purposes and continue
80 * to advertise it as locally attached but with a "proxy" flag
82 #define ZEBRA_MAC_LOCAL_INACTIVE 0x800
83 /* The MAC entry was created because of advertise_svi_mac */
84 #define ZEBRA_MAC_SVI 0x1000
86 #define ZEBRA_MAC_ALL_LOCAL_FLAGS (ZEBRA_MAC_LOCAL | ZEBRA_MAC_LOCAL_INACTIVE)
87 #define ZEBRA_MAC_ALL_PEER_FLAGS \
88 (ZEBRA_MAC_ES_PEER_PROXY | ZEBRA_MAC_ES_PEER_ACTIVE)
90 /* back pointer to zevpn */
93 /* Local or remote info.
94 * Note: fwd_info is only relevant if mac->es is NULL.
103 struct in_addr r_vtep_ip
;
106 /* Local or remote ES */
107 struct zebra_evpn_es
*es
;
108 /* memory used to link the mac to the es */
109 struct listnode es_listnode
;
111 /* access-port/bridge member. only relevant for local macs that
112 * are associated with a zero-ESI,
113 * XXX - this belongs in fwd_info.local; however fwd_info is
114 * being cleared and memset to zero in different ways that can
117 struct interface
*ifp
;
118 /* memory used to link the mac to the ifp */
119 struct listnode ifp_listnode
;
121 /* Mobility sequence numbers associated with this entry. */
125 /* List of neigh associated with this mac */
126 struct list
*neigh_list
;
128 /* list of hosts pointing to this remote RMAC */
129 struct host_rb_tree_entry host_rb
;
131 /* Duplicate mac detection */
134 struct thread
*dad_mac_auto_recovery_timer
;
136 struct timeval detect_start_time
;
138 time_t dad_dup_detect_time
;
140 /* used for ageing out the PEER_ACTIVE flag */
141 struct thread
*hold_timer
;
143 /* number of neigh entries (using this mac) that have
144 * ZEBRA_MAC_ES_PEER_ACTIVE or ZEBRA_NEIGH_ES_PEER_PROXY
146 uint32_t sync_neigh_cnt
;
152 * Context for MAC hash walk - used by callbacks.
154 struct mac_walk_ctx
{
155 zebra_evpn_t
*zevpn
; /* EVPN hash */
156 struct zebra_vrf
*zvrf
; /* VRF - for client notification. */
157 int uninstall
; /* uninstall from kernel? */
158 int upd_client
; /* uninstall from client? */
161 #define DEL_LOCAL_MAC 0x1
162 #define DEL_REMOTE_MAC 0x2
163 #define DEL_ALL_MAC (DEL_LOCAL_MAC | DEL_REMOTE_MAC)
164 #define DEL_REMOTE_MAC_FROM_VTEP 0x4
165 #define SHOW_REMOTE_MAC_FROM_VTEP 0x8
167 struct in_addr r_vtep_ip
; /* To walk MACs from specific VTEP */
169 struct vty
*vty
; /* Used by VTY handlers */
170 uint32_t count
; /* Used by VTY handlers */
171 struct json_object
*json
; /* Used for JSON Output */
172 bool print_dup
; /* Used to print dup addr list */
175 struct rmac_walk_ctx
{
177 struct json_object
*json
;
180 /* temporary datastruct to pass info between the mac-update and
181 * neigh-update while handling mac-ip routes
183 struct sync_mac_ip_ctx
{
187 bool mac_dp_update_deferred
;
191 /**************************** SYNC MAC handling *****************************/
192 /* if the mac has been added of a mac-route from the peer
193 * or if it is being referenced by a neigh added by the
194 * peer we cannot let it age out i.e. we set the static bit
197 static inline bool zebra_evpn_mac_is_static(zebra_mac_t
*mac
)
199 return ((mac
->flags
& ZEBRA_MAC_ALL_PEER_FLAGS
) || mac
->sync_neigh_cnt
);
202 /* mac needs to be locally active or active on an ES peer */
203 static inline bool zebra_evpn_mac_is_ready_for_bgp(uint32_t flags
)
205 return (flags
& ZEBRA_MAC_LOCAL
)
206 && (!(flags
& ZEBRA_MAC_LOCAL_INACTIVE
)
207 || (flags
& ZEBRA_MAC_ES_PEER_ACTIVE
));
210 void zebra_evpn_mac_stop_hold_timer(zebra_mac_t
*mac
);
212 static inline void zebra_evpn_mac_clear_sync_info(zebra_mac_t
*mac
)
214 UNSET_FLAG(mac
->flags
, ZEBRA_MAC_ALL_PEER_FLAGS
);
215 zebra_evpn_mac_stop_hold_timer(mac
);
218 static inline bool zebra_evpn_mac_in_use(zebra_mac_t
*mac
)
220 return !list_isempty(mac
->neigh_list
)
221 || CHECK_FLAG(mac
->flags
, ZEBRA_MAC_SVI
);
224 struct hash
*zebra_mac_db_create(const char *desc
);
225 uint32_t num_valid_macs(zebra_evpn_t
*zevi
);
226 uint32_t num_dup_detected_macs(zebra_evpn_t
*zevi
);
227 int zebra_evpn_rem_mac_uninstall(zebra_evpn_t
*zevi
, zebra_mac_t
*mac
,
229 int zebra_evpn_rem_mac_install(zebra_evpn_t
*zevi
, zebra_mac_t
*mac
,
231 void zebra_evpn_deref_ip2mac(zebra_evpn_t
*zevi
, zebra_mac_t
*mac
);
232 zebra_mac_t
*zebra_evpn_mac_lookup(zebra_evpn_t
*zevi
,
233 const struct ethaddr
*mac
);
234 zebra_mac_t
*zebra_evpn_mac_add(zebra_evpn_t
*zevi
,
235 const struct ethaddr
*macaddr
);
236 int zebra_evpn_mac_del(zebra_evpn_t
*zevi
, zebra_mac_t
*mac
);
237 int zebra_evpn_macip_send_msg_to_client(uint32_t id
,
238 const struct ethaddr
*macaddr
,
239 const struct ipaddr
*ip
, uint8_t flags
,
240 uint32_t seq
, int state
,
241 struct zebra_evpn_es
*es
, uint16_t cmd
);
242 void zebra_evpn_print_mac(zebra_mac_t
*mac
, void *ctxt
, json_object
*json
);
243 void zebra_evpn_print_mac_hash(struct hash_bucket
*bucket
, void *ctxt
);
244 void zebra_evpn_print_mac_hash_detail(struct hash_bucket
*bucket
, void *ctxt
);
245 int zebra_evpn_sync_mac_dp_install(zebra_mac_t
*mac
, bool set_inactive
,
246 bool force_clear_static
, const char *caller
);
247 void zebra_evpn_mac_send_add_del_to_client(zebra_mac_t
*mac
, bool old_bgp_ready
,
250 void zebra_evpn_mac_del_all(zebra_evpn_t
*zevi
, int uninstall
, int upd_client
,
252 int zebra_evpn_mac_send_add_to_client(vni_t vni
, const struct ethaddr
*macaddr
,
253 uint32_t mac_flags
, uint32_t seq
,
254 struct zebra_evpn_es
*es
);
255 int zebra_evpn_mac_send_del_to_client(vni_t vni
, const struct ethaddr
*macaddr
,
256 uint32_t flags
, bool force
);
257 void zebra_evpn_send_mac_list_to_client(zebra_evpn_t
*zevi
);
258 zebra_mac_t
*zebra_evpn_proc_sync_mac_update(
259 zebra_evpn_t
*zevi
, const struct ethaddr
*macaddr
, uint16_t ipa_len
,
260 const struct ipaddr
*ipaddr
, uint8_t flags
, uint32_t seq
,
261 const esi_t
*esi
, struct sync_mac_ip_ctx
*ctx
);
262 void zebra_evpn_sync_mac_del(zebra_mac_t
*mac
);
263 void zebra_evpn_rem_mac_del(zebra_evpn_t
*zevi
, zebra_mac_t
*mac
);
264 void zebra_evpn_print_dad_mac_hash(struct hash_bucket
*bucket
, void *ctxt
);
265 void zebra_evpn_print_dad_mac_hash_detail(struct hash_bucket
*bucket
,
267 int zebra_evpn_mac_remote_macip_add(zebra_evpn_t
*zevpn
, struct zebra_vrf
*zvrf
,
268 const struct ethaddr
*macaddr
,
270 const struct ipaddr
*ipaddr
,
271 zebra_mac_t
**macp
, struct in_addr vtep_ip
,
272 uint8_t flags
, uint32_t seq
,
275 int zebra_evpn_add_update_local_mac(struct zebra_vrf
*zvrf
, zebra_evpn_t
*zevpn
,
276 struct interface
*ifp
,
277 const struct ethaddr
*macaddr
, vlanid_t vid
,
278 bool sticky
, bool local_inactive
,
279 bool dp_static
, zebra_mac_t
*mac
);
280 int zebra_evpn_del_local_mac(zebra_evpn_t
*zevpn
, zebra_mac_t
*mac
,
282 int zebra_evpn_mac_gw_macip_add(struct interface
*ifp
, zebra_evpn_t
*zevpn
,
283 const struct ipaddr
*ip
, zebra_mac_t
**macp
,
284 const struct ethaddr
*macaddr
, vlanid_t vlan_id
,
286 void zebra_evpn_mac_svi_add(struct interface
*ifp
, zebra_evpn_t
*zevpn
);
287 void zebra_evpn_mac_svi_del(struct interface
*ifp
, zebra_evpn_t
*zevpn
);
288 void zebra_evpn_mac_ifp_del(struct interface
*ifp
);
289 void zebra_evpn_mac_clear_fwd_info(zebra_mac_t
*zmac
);
295 #endif /*_ZEBRA_EVPN_MAC_H */