2 * Zebra EVPN Neighbor 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_NEIGH_H
26 #define _ZEBRA_EVPN_NEIGH_H
32 typedef struct zebra_neigh_t_ zebra_neigh_t
;
34 #define IS_ZEBRA_NEIGH_ACTIVE(n) (n->state == ZEBRA_NEIGH_ACTIVE)
36 #define IS_ZEBRA_NEIGH_INACTIVE(n) (n->state == ZEBRA_NEIGH_INACTIVE)
38 #define ZEBRA_NEIGH_SET_ACTIVE(n) n->state = ZEBRA_NEIGH_ACTIVE
40 #define ZEBRA_NEIGH_SET_INACTIVE(n) n->state = ZEBRA_NEIGH_INACTIVE
43 * Neighbor hash table.
45 * This table contains the neighbors (IP to MAC bindings) pertaining to
46 * this VNI. This includes local neighbors learnt on the attached VLAN
47 * device that maps to this VNI as well as remote neighbors learnt and
49 * Local neighbors will be known against the VLAN device (SVI); however,
50 * it is sufficient for zebra to maintain against the VNI. The correct
51 * VNI will be obtained as zebra maintains the mapping (of VLAN to VNI).
53 struct zebra_neigh_t_
{
60 /* Back pointer to MAC. Only applicable to hosts in a L2-VNI. */
63 /* Underlying interface. */
69 #define ZEBRA_NEIGH_LOCAL 0x01
70 #define ZEBRA_NEIGH_REMOTE 0x02
71 #define ZEBRA_NEIGH_REMOTE_NH 0x04 /* neigh entry for remote vtep */
72 #define ZEBRA_NEIGH_DEF_GW 0x08
73 #define ZEBRA_NEIGH_ROUTER_FLAG 0x10
74 #define ZEBRA_NEIGH_DUPLICATE 0x20
75 #define ZEBRA_NEIGH_SVI_IP 0x40
76 /* rxed from an ES peer */
77 #define ZEBRA_NEIGH_ES_PEER_ACTIVE 0x80
78 /* rxed from an ES peer as a proxy advertisement */
79 #define ZEBRA_NEIGH_ES_PEER_PROXY 0x100
80 /* We have not been able to independently establish that the host
83 #define ZEBRA_NEIGH_LOCAL_INACTIVE 0x200
84 #define ZEBRA_NEIGH_ALL_LOCAL_FLAGS \
85 (ZEBRA_NEIGH_LOCAL | ZEBRA_NEIGH_LOCAL_INACTIVE)
86 #define ZEBRA_NEIGH_ALL_PEER_FLAGS \
87 (ZEBRA_NEIGH_ES_PEER_PROXY | ZEBRA_NEIGH_ES_PEER_ACTIVE)
89 enum zebra_neigh_state state
;
91 /* Remote VTEP IP - applicable only for remote neighbors. */
92 struct in_addr r_vtep_ip
;
95 * Mobility sequence numbers associated with this entry. The rem_seq
96 * represents the sequence number from the client (BGP) for the most
97 * recent add or update of this entry while the loc_seq represents
98 * the sequence number informed (or to be informed) by zebra to BGP
104 /* list of hosts pointing to this remote NH entry */
105 struct host_rb_tree_entry host_rb
;
107 /* Duplicate ip detection */
110 struct thread
*dad_ip_auto_recovery_timer
;
112 struct timeval detect_start_time
;
114 time_t dad_dup_detect_time
;
116 /* used for ageing out the PEER_ACTIVE flag */
117 struct thread
*hold_timer
;
121 * Context for neighbor hash walk - used by callbacks.
123 struct neigh_walk_ctx
{
124 zebra_evpn_t
*zevpn
; /* VNI hash */
125 struct zebra_vrf
*zvrf
; /* VRF - for client notification. */
126 int uninstall
; /* uninstall from kernel? */
127 int upd_client
; /* uninstall from client? */
130 #define DEL_LOCAL_NEIGH 0x1
131 #define DEL_REMOTE_NEIGH 0x2
132 #define DEL_ALL_NEIGH (DEL_LOCAL_NEIGH | DEL_REMOTE_NEIGH)
133 #define DEL_REMOTE_NEIGH_FROM_VTEP 0x4
134 #define SHOW_REMOTE_NEIGH_FROM_VTEP 0x8
136 struct in_addr r_vtep_ip
; /* To walk neighbors from specific VTEP */
138 struct vty
*vty
; /* Used by VTY handlers */
139 uint32_t count
; /* Used by VTY handlers */
140 uint8_t addr_width
; /* Used by VTY handlers */
141 struct json_object
*json
; /* Used for JSON Output */
144 /**************************** SYNC neigh handling **************************/
145 static inline bool zebra_evpn_neigh_is_static(zebra_neigh_t
*neigh
)
147 return !!(neigh
->flags
& ZEBRA_NEIGH_ALL_PEER_FLAGS
);
150 static inline bool zebra_evpn_neigh_is_ready_for_bgp(zebra_neigh_t
*n
)
155 mac_ready
= !!(n
->mac
->flags
& ZEBRA_MAC_LOCAL
);
157 ((n
->flags
& ZEBRA_NEIGH_LOCAL
) && IS_ZEBRA_NEIGH_ACTIVE(n
)
158 && (!(n
->flags
& ZEBRA_NEIGH_LOCAL_INACTIVE
)
159 || (n
->flags
& ZEBRA_NEIGH_ES_PEER_ACTIVE
)))
163 return mac_ready
&& neigh_ready
;
166 static inline void zebra_evpn_neigh_stop_hold_timer(zebra_neigh_t
*n
)
168 char macbuf
[ETHER_ADDR_STRLEN
];
169 char ipbuf
[INET6_ADDRSTRLEN
];
174 if (IS_ZEBRA_DEBUG_EVPN_MH_NEIGH
)
175 zlog_debug("sync-neigh vni %u ip %s mac %s 0x%x hold stop",
177 ipaddr2str(&n
->ip
, ipbuf
, sizeof(ipbuf
)),
178 prefix_mac2str(&n
->emac
, macbuf
, sizeof(macbuf
)),
180 THREAD_OFF(n
->hold_timer
);
183 void zebra_evpn_sync_neigh_static_chg(zebra_neigh_t
*n
, bool old_n_static
,
184 bool new_n_static
, bool defer_n_dp
,
185 bool defer_mac_dp
, const char *caller
);
187 static inline bool zebra_evpn_neigh_clear_sync_info(zebra_neigh_t
*n
)
189 char macbuf
[ETHER_ADDR_STRLEN
];
190 char ipbuf
[INET6_ADDRSTRLEN
];
191 bool old_n_static
= false;
192 bool new_n_static
= false;
194 if (n
->flags
& ZEBRA_NEIGH_ALL_PEER_FLAGS
) {
195 if (IS_ZEBRA_DEBUG_EVPN_MH_NEIGH
)
196 zlog_debug("sync-neigh vni %u ip %s mac %s 0x%x clear",
198 ipaddr2str(&n
->ip
, ipbuf
, sizeof(ipbuf
)),
199 prefix_mac2str(&n
->emac
, macbuf
,
203 old_n_static
= zebra_evpn_neigh_is_static(n
);
204 UNSET_FLAG(n
->flags
, ZEBRA_NEIGH_ALL_PEER_FLAGS
);
205 new_n_static
= zebra_evpn_neigh_is_static(n
);
206 if (old_n_static
!= new_n_static
)
207 zebra_evpn_sync_neigh_static_chg(
208 n
, old_n_static
, new_n_static
,
209 true /*defer_dp)*/, false /*defer_mac_dp*/,
212 zebra_evpn_neigh_stop_hold_timer(n
);
214 /* if the neigh static flag changed inform that a dp
215 * re-install maybe needed
217 return old_n_static
!= new_n_static
;
220 int remote_neigh_count(zebra_mac_t
*zmac
);
222 int neigh_list_cmp(void *p1
, void *p2
);
223 struct hash
*zebra_neigh_db_create(const char *desc
);
224 uint32_t num_dup_detected_neighs(zebra_evpn_t
*zevpn
);
225 void zebra_evpn_find_neigh_addr_width(struct hash_bucket
*bucket
, void *ctxt
);
226 int remote_neigh_count(zebra_mac_t
*zmac
);
227 int zebra_evpn_rem_neigh_install(zebra_evpn_t
*zevpn
, zebra_neigh_t
*n
,
229 void zebra_evpn_install_neigh_hash(struct hash_bucket
*bucket
, void *ctxt
);
230 int zebra_evpn_neigh_send_add_to_client(vni_t vni
, struct ipaddr
*ip
,
231 struct ethaddr
*macaddr
,
232 zebra_mac_t
*zmac
, uint32_t neigh_flags
,
234 int zebra_evpn_neigh_send_del_to_client(vni_t vni
, struct ipaddr
*ip
,
235 struct ethaddr
*macaddr
, uint32_t flags
,
236 int state
, bool force
);
237 bool zebra_evpn_neigh_is_bgp_seq_ok(zebra_evpn_t
*zevpn
, zebra_neigh_t
*n
,
238 struct ethaddr
*macaddr
, uint32_t seq
);
239 int zebra_evpn_neigh_del(zebra_evpn_t
*zevpn
, zebra_neigh_t
*n
);
240 void zebra_evpn_sync_neigh_del(zebra_neigh_t
*n
);
242 zebra_evpn_proc_sync_neigh_update(zebra_evpn_t
*zevpn
, zebra_neigh_t
*n
,
243 uint16_t ipa_len
, struct ipaddr
*ipaddr
,
244 uint8_t flags
, uint32_t seq
, esi_t
*esi
,
245 struct sync_mac_ip_ctx
*ctx
);
246 void zebra_evpn_neigh_del_all(zebra_evpn_t
*zevpn
, int uninstall
,
247 int upd_client
, uint32_t flags
);
248 zebra_neigh_t
*zebra_evpn_neigh_lookup(zebra_evpn_t
*zevpn
, struct ipaddr
*ip
);
250 int zebra_evpn_rem_neigh_install(zebra_evpn_t
*zevpn
, zebra_neigh_t
*n
,
252 void zebra_evpn_process_neigh_on_remote_mac_add(zebra_evpn_t
*zevpn
,
254 void zebra_evpn_process_neigh_on_local_mac_del(zebra_evpn_t
*zevpn
,
256 void zebra_evpn_process_neigh_on_local_mac_change(zebra_evpn_t
*zevpn
,
260 void zebra_evpn_process_neigh_on_remote_mac_del(zebra_evpn_t
*zevpn
,
262 int zebra_evpn_local_neigh_update(zebra_evpn_t
*zevpn
, struct interface
*ifp
,
263 struct ipaddr
*ip
, struct ethaddr
*macaddr
,
264 bool is_router
, bool local_inactive
,
266 int zebra_evpn_remote_neigh_update(zebra_evpn_t
*zevpn
, struct interface
*ifp
,
267 struct ipaddr
*ip
, struct ethaddr
*macaddr
,
269 void zebra_evpn_send_neigh_to_client(zebra_evpn_t
*zevpn
);
270 void zebra_evpn_clear_dup_neigh_hash(struct hash_bucket
*bucket
, void *ctxt
);
271 void zebra_evpn_print_neigh(zebra_neigh_t
*n
, void *ctxt
, json_object
*json
);
272 void zebra_evpn_print_neigh_hash(struct hash_bucket
*bucket
, void *ctxt
);
273 void zebra_evpn_print_neigh_hdr(struct vty
*vty
, struct neigh_walk_ctx
*wctx
);
274 void zebra_evpn_print_neigh_hash_detail(struct hash_bucket
*bucket
, void *ctxt
);
275 void zebra_evpn_print_dad_neigh_hash(struct hash_bucket
*bucket
, void *ctxt
);
276 void zebra_evpn_print_dad_neigh_hash_detail(struct hash_bucket
*bucket
,
278 void process_neigh_remote_macip_add(zebra_evpn_t
*zevpn
, struct zebra_vrf
*zvrf
,
279 struct ipaddr
*ipaddr
, zebra_mac_t
*mac
,
280 struct in_addr vtep_ip
, uint8_t flags
,
282 int zebra_evpn_neigh_gw_macip_add(struct interface
*ifp
, zebra_evpn_t
*zevpn
,
283 struct ipaddr
*ip
, zebra_mac_t
*mac
);
284 void zebra_evpn_neigh_remote_uninstall(zebra_evpn_t
*zevpn
,
285 struct zebra_vrf
*zvrf
, zebra_neigh_t
*n
,
286 zebra_mac_t
*mac
, struct ipaddr
*ipaddr
);
287 int zebra_evpn_neigh_del_ip(zebra_evpn_t
*zevpn
, struct ipaddr
*ip
);
294 #endif /*_ZEBRA_EVPN_NEIGH_H */