2 * Zebra VxLAN (EVPN) Data structures and definitions
3 * These are "internal" to this function.
4 * Copyright (C) 2016, 2017 Cumulus Networks, Inc.
6 * This file is part of FRR.
8 * FRR is free software; you can redistribute it and/or modify it
9 * under the terms of the GNU General Public License as published by the
10 * Free Software Foundation; either version 2, or (at your option) any
13 * FRR is distributed in the hope that it will be useful, but
14 * WITHOUT ANY WARRANTY; without even the implied warranty of
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
16 * General Public License for more details.
18 * You should have received a copy of the GNU General Public License
19 * along with FRR; see the file COPYING. If not, write to the Free
20 * Software Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA
24 #ifndef _ZEBRA_VXLAN_PRIVATE_H
25 #define _ZEBRA_VXLAN_PRIVATE_H
33 #include "zebra_vxlan.h"
35 #define ERR_STR_SZ 256
38 typedef struct zebra_vni_t_ zebra_vni_t
;
39 typedef struct zebra_vtep_t_ zebra_vtep_t
;
40 typedef struct zebra_mac_t_ zebra_mac_t
;
41 typedef struct zebra_neigh_t_ zebra_neigh_t
;
42 typedef struct zebra_l3vni_t_ zebra_l3vni_t
;
47 * Right now, this just has each remote VTEP's IP address.
49 struct zebra_vtep_t_
{
51 /* NOTE: Can only be IPv4 right now. */
52 struct in_addr vtep_ip
;
55 struct zebra_vtep_t_
*next
;
56 struct zebra_vtep_t_
*prev
;
63 * Contains information pertaining to a VNI:
64 * - the list of remote VTEPs (with this VNI)
70 /* Flag for advertising gw macip */
71 uint8_t advertise_gw_macip
;
73 /* Flag for advertising svi macip */
74 uint8_t advertise_svi_macip
;
76 /* Flag for advertising gw macip */
77 uint8_t advertise_subnet
;
79 /* Corresponding VxLAN interface. */
80 struct interface
*vxlan_if
;
82 /* List of remote VTEPs */
86 struct in_addr local_vtep_ip
;
88 /* tenant VRF, if any */
91 /* List of local or remote MAC */
92 struct hash
*mac_table
;
94 /* List of local or remote neighbors (MAC+IP) */
95 struct hash
*neigh_table
;
98 /* L3 VNI hash table */
99 struct zebra_l3vni_t_
{
108 #define PREFIX_ROUTES_ONLY (1 << 0) /* l3-vni used for prefix routes only */
111 struct in_addr local_vtep_ip
;
113 /* kernel interface for l3vni */
114 struct interface
*vxlan_if
;
116 /* SVI interface corresponding to the l3vni */
117 struct interface
*svi_if
;
119 /* list of L2 VNIs associated with the L3 VNI */
122 /* list of remote router-macs */
123 struct hash
*rmac_table
;
125 /* list of remote vtep-ip neigh */
126 struct hash
*nh_table
;
129 /* get the vx-intf name for l3vni */
130 static inline const char *zl3vni_vxlan_if_name(zebra_l3vni_t
*zl3vni
)
132 return zl3vni
->vxlan_if
? zl3vni
->vxlan_if
->name
: "None";
135 /* get the svi intf name for l3vni */
136 static inline const char *zl3vni_svi_if_name(zebra_l3vni_t
*zl3vni
)
138 return zl3vni
->svi_if
? zl3vni
->svi_if
->name
: "None";
141 /* get the vrf name for l3vni */
142 static inline const char *zl3vni_vrf_name(zebra_l3vni_t
*zl3vni
)
144 return vrf_id_to_name(zl3vni
->vrf_id
);
147 /* get the rmac string */
148 static inline const char *zl3vni_rmac2str(zebra_l3vni_t
*zl3vni
, char *buf
,
154 ptr
= (char *)XMALLOC(MTYPE_TMP
,
155 ETHER_ADDR_STRLEN
* sizeof(char));
157 assert(size
>= ETHER_ADDR_STRLEN
);
162 snprintf(ptr
, (ETHER_ADDR_STRLEN
),
163 "%02x:%02x:%02x:%02x:%02x:%02x",
164 (uint8_t)zl3vni
->svi_if
->hw_addr
[0],
165 (uint8_t)zl3vni
->svi_if
->hw_addr
[1],
166 (uint8_t)zl3vni
->svi_if
->hw_addr
[2],
167 (uint8_t)zl3vni
->svi_if
->hw_addr
[3],
168 (uint8_t)zl3vni
->svi_if
->hw_addr
[4],
169 (uint8_t)zl3vni
->svi_if
->hw_addr
[5]);
171 snprintf(ptr
, ETHER_ADDR_STRLEN
, "None");
177 * l3-vni is oper up when:
178 * 0. if EVPN is enabled (advertise-all-vni cfged)
179 * 1. it is associated to a vxlan-intf
180 * 2. Associated vxlan-intf is oper up
181 * 3. it is associated to an SVI
182 * 4. associated SVI is oper up
184 static inline int is_l3vni_oper_up(zebra_l3vni_t
*zl3vni
)
186 return (is_evpn_enabled() && zl3vni
&& (zl3vni
->vrf_id
!= VRF_UNKNOWN
)
187 && zl3vni
->vxlan_if
&& if_is_operative(zl3vni
->vxlan_if
)
188 && zl3vni
->svi_if
&& if_is_operative(zl3vni
->svi_if
));
191 static inline const char *zl3vni_state2str(zebra_l3vni_t
*zl3vni
)
196 if (is_l3vni_oper_up(zl3vni
))
204 static inline vrf_id_t
zl3vni_vrf_id(zebra_l3vni_t
*zl3vni
)
206 return zl3vni
->vrf_id
;
209 static inline void zl3vni_get_rmac(zebra_l3vni_t
*zl3vni
, struct ethaddr
*rmac
)
214 if (!is_l3vni_oper_up(zl3vni
))
217 if (zl3vni
->svi_if
&& if_is_operative(zl3vni
->svi_if
))
218 memcpy(rmac
->octet
, zl3vni
->svi_if
->hw_addr
, ETH_ALEN
);
221 struct host_rb_entry
{
222 RB_ENTRY(host_rb_entry
) hl_entry
;
227 RB_HEAD(host_rb_tree_entry
, host_rb_entry
);
228 RB_PROTOTYPE(host_rb_tree_entry
, host_rb_entry
, hl_entry
,
229 host_rb_entry_compare
);
233 * This table contains the MAC addresses pertaining to this VNI.
234 * This includes local MACs learnt on an attached VLAN that maps
235 * to this VNI as well as remote MACs learnt and installed by BGP.
236 * Local MACs will be known either on a VLAN sub-interface or
237 * on (port, VLAN); however, it is sufficient for zebra to maintain
238 * against the VNI i.e., it does not need to retain the local "port"
239 * information. The correct VNI will be obtained as zebra maintains
240 * the mapping (of VLAN to VNI).
242 struct zebra_mac_t_
{
244 struct ethaddr macaddr
;
247 #define ZEBRA_MAC_LOCAL 0x01
248 #define ZEBRA_MAC_REMOTE 0x02
249 #define ZEBRA_MAC_AUTO 0x04 /* Auto created for neighbor. */
250 #define ZEBRA_MAC_STICKY 0x08 /* Static MAC */
251 #define ZEBRA_MAC_REMOTE_RMAC 0x10 /* remote router mac */
252 #define ZEBRA_MAC_DEF_GW 0x20
253 /* remote VTEP advertised MAC as default GW */
254 #define ZEBRA_MAC_REMOTE_DEF_GW 0x40
255 #define ZEBRA_MAC_DUPLICATE 0x80
257 /* back pointer to zvni */
260 /* Local or remote info. */
267 struct in_addr r_vtep_ip
;
270 /* Mobility sequence numbers associated with this entry. */
274 /* List of neigh associated with this mac */
275 struct list
*neigh_list
;
277 /* list of hosts pointing to this remote RMAC */
278 struct host_rb_tree_entry host_rb
;
280 /* Duplicate mac detection */
283 struct thread
*dad_mac_auto_recovery_timer
;
285 struct timeval detect_start_time
;
287 time_t dad_dup_detect_time
;
291 * Context for MAC hash walk - used by callbacks.
293 struct mac_walk_ctx
{
294 zebra_vni_t
*zvni
; /* VNI hash */
295 struct zebra_vrf
*zvrf
; /* VRF - for client notification. */
296 int uninstall
; /* uninstall from kernel? */
297 int upd_client
; /* uninstall from client? */
300 #define DEL_LOCAL_MAC 0x1
301 #define DEL_REMOTE_MAC 0x2
302 #define DEL_ALL_MAC (DEL_LOCAL_MAC | DEL_REMOTE_MAC)
303 #define DEL_REMOTE_MAC_FROM_VTEP 0x4
304 #define SHOW_REMOTE_MAC_FROM_VTEP 0x8
306 struct in_addr r_vtep_ip
; /* To walk MACs from specific VTEP */
308 struct vty
*vty
; /* Used by VTY handlers */
309 uint32_t count
; /* Used by VTY handlers */
310 struct json_object
*json
; /* Used for JSON Output */
311 bool print_dup
; /* Used to print dup addr list */
314 struct rmac_walk_ctx
{
316 struct json_object
*json
;
319 #define IS_ZEBRA_NEIGH_ACTIVE(n) (n->state == ZEBRA_NEIGH_ACTIVE)
321 #define IS_ZEBRA_NEIGH_INACTIVE(n) (n->state == ZEBRA_NEIGH_INACTIVE)
323 #define ZEBRA_NEIGH_SET_ACTIVE(n) n->state = ZEBRA_NEIGH_ACTIVE
325 #define ZEBRA_NEIGH_SET_INACTIVE(n) n->state = ZEBRA_NEIGH_INACTIVE
328 * Neighbor hash table.
330 * This table contains the neighbors (IP to MAC bindings) pertaining to
331 * this VNI. This includes local neighbors learnt on the attached VLAN
332 * device that maps to this VNI as well as remote neighbors learnt and
334 * Local neighbors will be known against the VLAN device (SVI); however,
335 * it is sufficient for zebra to maintain against the VNI. The correct
336 * VNI will be obtained as zebra maintains the mapping (of VLAN to VNI).
338 struct zebra_neigh_t_
{
345 /* Underlying interface. */
351 #define ZEBRA_NEIGH_LOCAL 0x01
352 #define ZEBRA_NEIGH_REMOTE 0x02
353 #define ZEBRA_NEIGH_REMOTE_NH 0x04 /* neigh entry for remote vtep */
354 #define ZEBRA_NEIGH_DEF_GW 0x08
355 #define ZEBRA_NEIGH_ROUTER_FLAG 0x10
356 #define ZEBRA_NEIGH_DUPLICATE 0x20
358 enum zebra_neigh_state state
;
360 /* Remote VTEP IP - applicable only for remote neighbors. */
361 struct in_addr r_vtep_ip
;
364 * Mobility sequence numbers associated with this entry. The rem_seq
365 * represents the sequence number from the client (BGP) for the most
366 * recent add or update of this entry while the loc_seq represents
367 * the sequence number informed (or to be informed) by zebra to BGP
373 /* list of hosts pointing to this remote NH entry */
374 struct host_rb_tree_entry host_rb
;
376 /* Duplicate ip detection */
379 struct thread
*dad_ip_auto_recovery_timer
;
381 struct timeval detect_start_time
;
383 time_t dad_dup_detect_time
;
387 * Context for neighbor hash walk - used by callbacks.
389 struct neigh_walk_ctx
{
390 zebra_vni_t
*zvni
; /* VNI hash */
391 struct zebra_vrf
*zvrf
; /* VRF - for client notification. */
392 int uninstall
; /* uninstall from kernel? */
393 int upd_client
; /* uninstall from client? */
396 #define DEL_LOCAL_NEIGH 0x1
397 #define DEL_REMOTE_NEIGH 0x2
398 #define DEL_ALL_NEIGH (DEL_LOCAL_NEIGH | DEL_REMOTE_NEIGH)
399 #define DEL_REMOTE_NEIGH_FROM_VTEP 0x4
400 #define SHOW_REMOTE_NEIGH_FROM_VTEP 0x8
402 struct in_addr r_vtep_ip
; /* To walk neighbors from specific VTEP */
404 struct vty
*vty
; /* Used by VTY handlers */
405 uint32_t count
; /* Used by VTY handlers */
406 uint8_t addr_width
; /* Used by VTY handlers */
407 struct json_object
*json
; /* Used for JSON Output */
410 /* context for neigh hash walk - update l3vni and rmac */
411 struct neigh_l3info_walk_ctx
{
414 zebra_l3vni_t
*zl3vni
;
421 struct json_object
*json
;
424 #endif /* _ZEBRA_VXLAN_PRIVATE_H */