[mirror_frr.git] / zebra / zebra_vxlan_private.h

/*
 * Zebra VxLAN (EVPN) Data structures and definitions
 * These are "internal" to this function.
 * Copyright (C) 2016, 2017 Cumulus Networks, Inc.
 *
 * This file is part of FRR.
 *
 * FRR is free software; you can redistribute it and/or modify it
 * under the terms of the GNU General Public License as published by the
 * Free Software Foundation; either version 2, or (at your option) any
 * later version.
 *
 * FRR is distributed in the hope that it will be useful, but
 * WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with FRR; see the file COPYING.  If not, write to the Free
 * Software Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA
 * 02111-1307, USA.
 */

#ifndef _ZEBRA_VXLAN_PRIVATE_H
#define _ZEBRA_VXLAN_PRIVATE_H

#include <zebra.h>

#include "if.h"
#include "linklist.h"
#include "zebra_vxlan.h"

#ifdef __cplusplus
extern "C" {
#endif

#define ERR_STR_SZ 256

/* definitions */
typedef struct zebra_vni_t_ zebra_vni_t;
typedef struct zebra_vtep_t_ zebra_vtep_t;
typedef struct zebra_mac_t_ zebra_mac_t;
typedef struct zebra_neigh_t_ zebra_neigh_t;
typedef struct zebra_l3vni_t_ zebra_l3vni_t;

/*
 * VTEP info
 *
 * Right now, this just has each remote VTEP's IP address.
 */
struct zebra_vtep_t_ {
	/* Remote IP. */
	/* NOTE: Can only be IPv4 right now. */
	struct in_addr vtep_ip;
	/* Flood mode (one of enum vxlan_flood_control) based on the PMSI
	 * tunnel type advertised by the remote VTEP
	 */
	int flood_control;

	/* Links. */
	struct zebra_vtep_t_ *next;
	struct zebra_vtep_t_ *prev;
};


/*
 * VNI hash table
 *
 * Contains information pertaining to a VNI:
 * - the list of remote VTEPs (with this VNI)
 */
struct zebra_vni_t_ {
	/* VNI - key */
	vni_t vni;

	/* Flag for advertising gw macip */
	uint8_t advertise_gw_macip;

	/* Flag for advertising svi macip */
	uint8_t advertise_svi_macip;

	/* Flag for advertising gw macip */
	uint8_t advertise_subnet;

	/* Corresponding VxLAN interface. */
	struct interface *vxlan_if;

	/* List of remote VTEPs */
	zebra_vtep_t *vteps;

	/* Local IP */
	struct in_addr local_vtep_ip;

	/* PIM-SM MDT group for BUM flooding */
	struct in_addr mcast_grp;

	/* tenant VRF, if any */
	vrf_id_t vrf_id;

	/* List of local or remote MAC */
	struct hash *mac_table;

	/* List of local or remote neighbors (MAC+IP) */
	struct hash *neigh_table;
};

/* L3 VNI hash table */
struct zebra_l3vni_t_ {

	/* VNI key */
	vni_t vni;

	/* vrf_id */
	vrf_id_t vrf_id;

	uint32_t filter;
#define PREFIX_ROUTES_ONLY	(1 << 0) /* l3-vni used for prefix routes only */

	/* Local IP */
	struct in_addr local_vtep_ip;

	/* kernel interface for l3vni */
	struct interface *vxlan_if;

	/* SVI interface corresponding to the l3vni */
	struct interface *svi_if;

	/* list of L2 VNIs associated with the L3 VNI */
	struct list *l2vnis;

	/* list of remote router-macs */
	struct hash *rmac_table;

	/* list of remote vtep-ip neigh */
	struct hash *nh_table;
};

/* get the vx-intf name for l3vni */
static inline const char *zl3vni_vxlan_if_name(zebra_l3vni_t *zl3vni)
{
	return zl3vni->vxlan_if ? zl3vni->vxlan_if->name : "None";
}

/* get the svi intf name for l3vni */
static inline const char *zl3vni_svi_if_name(zebra_l3vni_t *zl3vni)
{
	return zl3vni->svi_if ? zl3vni->svi_if->name : "None";
}

/* get the vrf name for l3vni */
static inline const char *zl3vni_vrf_name(zebra_l3vni_t *zl3vni)
{
	return vrf_id_to_name(zl3vni->vrf_id);
}

/* get the rmac string */
static inline const char *zl3vni_rmac2str(zebra_l3vni_t *zl3vni, char *buf,
					  int size)
{
	char *ptr;

	if (!buf)
		ptr = (char *)XMALLOC(MTYPE_TMP,
				      ETHER_ADDR_STRLEN * sizeof(char));
	else {
		assert(size >= ETHER_ADDR_STRLEN);
		ptr = buf;
	}

	if (zl3vni->svi_if)
		snprintf(ptr, (ETHER_ADDR_STRLEN),
			 "%02x:%02x:%02x:%02x:%02x:%02x",
			 (uint8_t)zl3vni->svi_if->hw_addr[0],
			 (uint8_t)zl3vni->svi_if->hw_addr[1],
			 (uint8_t)zl3vni->svi_if->hw_addr[2],
			 (uint8_t)zl3vni->svi_if->hw_addr[3],
			 (uint8_t)zl3vni->svi_if->hw_addr[4],
			 (uint8_t)zl3vni->svi_if->hw_addr[5]);
	else
		snprintf(ptr, ETHER_ADDR_STRLEN, "None");

	return ptr;
}

/*
 * l3-vni is oper up when:
 * 0. if EVPN is enabled (advertise-all-vni cfged)
 * 1. it is associated to a vxlan-intf
 * 2. Associated vxlan-intf is oper up
 * 3. it is associated to an SVI
 * 4. associated SVI is oper up
 */
static inline int is_l3vni_oper_up(zebra_l3vni_t *zl3vni)
{
	return (is_evpn_enabled() && zl3vni && (zl3vni->vrf_id != VRF_UNKNOWN)
		&& zl3vni->vxlan_if && if_is_operative(zl3vni->vxlan_if)
		&& zl3vni->svi_if && if_is_operative(zl3vni->svi_if));
}

static inline const char *zl3vni_state2str(zebra_l3vni_t *zl3vni)
{
	if (!zl3vni)
		return NULL;

	if (is_l3vni_oper_up(zl3vni))
		return "Up";
	else
		return "Down";

	return NULL;
}

static inline vrf_id_t zl3vni_vrf_id(zebra_l3vni_t *zl3vni)
{
	return zl3vni->vrf_id;
}

static inline void zl3vni_get_rmac(zebra_l3vni_t *zl3vni, struct ethaddr *rmac)
{
	if (!zl3vni)
		return;

	if (!is_l3vni_oper_up(zl3vni))
		return;

	if (zl3vni->svi_if && if_is_operative(zl3vni->svi_if))
		memcpy(rmac->octet, zl3vni->svi_if->hw_addr, ETH_ALEN);
}

struct host_rb_entry {
	RB_ENTRY(host_rb_entry) hl_entry;

	struct prefix p;
};

RB_HEAD(host_rb_tree_entry, host_rb_entry);
RB_PROTOTYPE(host_rb_tree_entry, host_rb_entry, hl_entry,
	     host_rb_entry_compare);
/*
 * MAC hash table.
 *
 * This table contains the MAC addresses pertaining to this VNI.
 * This includes local MACs learnt on an attached VLAN that maps
 * to this VNI as well as remote MACs learnt and installed by BGP.
 * Local MACs will be known either on a VLAN sub-interface or
 * on (port, VLAN); however, it is sufficient for zebra to maintain
 * against the VNI i.e., it does not need to retain the local "port"
 * information. The correct VNI will be obtained as zebra maintains
 * the mapping (of VLAN to VNI).
 */
struct zebra_mac_t_ {
	/* MAC address. */
	struct ethaddr macaddr;

	uint32_t flags;
#define ZEBRA_MAC_LOCAL   0x01
#define ZEBRA_MAC_REMOTE  0x02
#define ZEBRA_MAC_AUTO    0x04  /* Auto created for neighbor. */
#define ZEBRA_MAC_STICKY  0x08  /* Static MAC */
#define ZEBRA_MAC_REMOTE_RMAC  0x10  /* remote router mac */
#define ZEBRA_MAC_DEF_GW  0x20
/* remote VTEP advertised MAC as default GW */
#define ZEBRA_MAC_REMOTE_DEF_GW	0x40
#define ZEBRA_MAC_DUPLICATE 0x80

	/* back pointer to zvni */
	zebra_vni_t     *zvni;

	/* Local or remote info. */
	union {
		struct {
			ifindex_t ifindex;
			vlanid_t vid;
		} local;

		struct in_addr r_vtep_ip;
	} fwd_info;

	/* Mobility sequence numbers associated with this entry. */
	uint32_t rem_seq;
	uint32_t loc_seq;

	/* List of neigh associated with this mac */
	struct list *neigh_list;

	/* list of hosts pointing to this remote RMAC */
	struct host_rb_tree_entry host_rb;

	/* Duplicate mac detection */
	uint32_t dad_count;

	struct thread *dad_mac_auto_recovery_timer;

	struct timeval detect_start_time;

	time_t dad_dup_detect_time;
};

/*
 * Context for MAC hash walk - used by callbacks.
 */
struct mac_walk_ctx {
	zebra_vni_t *zvni;      /* VNI hash */
	struct zebra_vrf *zvrf; /* VRF - for client notification. */
	int uninstall;		/* uninstall from kernel? */
	int upd_client;		/* uninstall from client? */

	uint32_t flags;
#define DEL_LOCAL_MAC                0x1
#define DEL_REMOTE_MAC               0x2
#define DEL_ALL_MAC                  (DEL_LOCAL_MAC | DEL_REMOTE_MAC)
#define DEL_REMOTE_MAC_FROM_VTEP     0x4
#define SHOW_REMOTE_MAC_FROM_VTEP    0x8

	struct in_addr r_vtep_ip; /* To walk MACs from specific VTEP */

	struct vty *vty;	  /* Used by VTY handlers */
	uint32_t count;		  /* Used by VTY handlers */
	struct json_object *json; /* Used for JSON Output */
	bool print_dup; /* Used to print dup addr list */
};

struct rmac_walk_ctx {
	struct vty *vty;
	struct json_object *json;
};

#define IS_ZEBRA_NEIGH_ACTIVE(n) (n->state == ZEBRA_NEIGH_ACTIVE)

#define IS_ZEBRA_NEIGH_INACTIVE(n) (n->state == ZEBRA_NEIGH_INACTIVE)

#define ZEBRA_NEIGH_SET_ACTIVE(n) n->state = ZEBRA_NEIGH_ACTIVE

#define ZEBRA_NEIGH_SET_INACTIVE(n) n->state = ZEBRA_NEIGH_INACTIVE

/*
 * Neighbor hash table.
 *
 * This table contains the neighbors (IP to MAC bindings) pertaining to
 * this VNI. This includes local neighbors learnt on the attached VLAN
 * device that maps to this VNI as well as remote neighbors learnt and
 * installed by BGP.
 * Local neighbors will be known against the VLAN device (SVI); however,
 * it is sufficient for zebra to maintain against the VNI. The correct
 * VNI will be obtained as zebra maintains the mapping (of VLAN to VNI).
 */
struct zebra_neigh_t_ {
	/* IP address. */
	struct ipaddr ip;

	/* MAC address. */
	struct ethaddr emac;

	/* Underlying interface. */
	ifindex_t ifindex;

	zebra_vni_t *zvni;

	uint32_t flags;
#define ZEBRA_NEIGH_LOCAL     0x01
#define ZEBRA_NEIGH_REMOTE    0x02
#define ZEBRA_NEIGH_REMOTE_NH    0x04 /* neigh entry for remote vtep */
#define ZEBRA_NEIGH_DEF_GW    0x08
#define ZEBRA_NEIGH_ROUTER_FLAG 0x10
#define ZEBRA_NEIGH_DUPLICATE 0x20

	enum zebra_neigh_state state;

	/* Remote VTEP IP - applicable only for remote neighbors. */
	struct in_addr r_vtep_ip;

	/*
	 * Mobility sequence numbers associated with this entry. The rem_seq
	 * represents the sequence number from the client (BGP) for the most
	 * recent add or update of this entry while the loc_seq represents
	 * the sequence number informed (or to be informed) by zebra to BGP
	 * for this entry.
	 */
	uint32_t rem_seq;
	uint32_t loc_seq;

	/* list of hosts pointing to this remote NH entry */
	struct host_rb_tree_entry host_rb;

	/* Duplicate ip detection */
	uint32_t dad_count;

	struct thread *dad_ip_auto_recovery_timer;

	struct timeval detect_start_time;

	time_t dad_dup_detect_time;
};

/*
 * Context for neighbor hash walk - used by callbacks.
 */
struct neigh_walk_ctx {
	zebra_vni_t *zvni;      /* VNI hash */
	struct zebra_vrf *zvrf; /* VRF - for client notification. */
	int uninstall;		/* uninstall from kernel? */
	int upd_client;		/* uninstall from client? */

	uint32_t flags;
#define DEL_LOCAL_NEIGH              0x1
#define DEL_REMOTE_NEIGH             0x2
#define DEL_ALL_NEIGH                (DEL_LOCAL_NEIGH | DEL_REMOTE_NEIGH)
#define DEL_REMOTE_NEIGH_FROM_VTEP   0x4
#define SHOW_REMOTE_NEIGH_FROM_VTEP  0x8

	struct in_addr r_vtep_ip; /* To walk neighbors from specific VTEP */

	struct vty *vty;	  /* Used by VTY handlers */
	uint32_t count;		  /* Used by VTY handlers */
	uint8_t addr_width;       /* Used by VTY handlers */
	struct json_object *json; /* Used for JSON Output */
};

/* context for neigh hash walk - update l3vni and rmac */
struct neigh_l3info_walk_ctx {

	zebra_vni_t *zvni;
	zebra_l3vni_t *zl3vni;
	int add;
};

struct nh_walk_ctx {

	struct vty *vty;
	struct json_object *json;
};

#ifdef __cplusplus
}
#endif

/*
 * Multicast hash table.
 *
 * This table contains -
 * 1. The (S, G) entries used for encapsulating and forwarding BUM traffic.
 *    S is the local VTEP-IP and G is a BUM mcast group address.
 * 2. The (X, G) entries used for terminating a BUM flow.
 * Multiple L2-VNIs can share the same MDT hence the need to maintain
 * an aggregated table that pimd can consume without much
 * re-interpretation.
 */
typedef struct zebra_vxlan_sg_ {
	struct zebra_vrf *zvrf;

	struct prefix_sg sg;
	char sg_str[PREFIX_SG_STR_LEN];

	/* For SG - num of L2 VNIs using this entry for sending BUM traffic */
	/* For XG - num of SG using this as parent */
	uint32_t ref_cnt;
} zebra_vxlan_sg_t;

#endif /* _ZEBRA_VXLAN_PRIVATE_H */
Commit	Line	Data
18a7a601	1	/*
	2	* Zebra VxLAN (EVPN) Data structures and definitions
	3	* These are "internal" to this function.
	4	* Copyright (C) 2016, 2017 Cumulus Networks, Inc.
	5	*
	6	* This file is part of FRR.
	7	*
	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
	11	* later version.
	12	*
	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.
	17	*
	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
	21	* 02111-1307, USA.
	22	*/
	23
	24	#ifndef _ZEBRA_VXLAN_PRIVATE_H
	25	#define _ZEBRA_VXLAN_PRIVATE_H
	26
	27	#include <zebra.h>
	28
18a7a601	29	#include "if.h"
18a7a601	30	#include "linklist.h"
655b04d1	31	#include "zebra_vxlan.h"
18a7a601	32
51e94aa7 EDP	33	#ifdef __cplusplus
	34	extern "C" {
	35	#endif
	36
b7cfce93 MK	37	#define ERR_STR_SZ 256
b7cfce93 MK	38
18a7a601	39	/* definitions */
	40	typedef struct zebra_vni_t_ zebra_vni_t;
	41	typedef struct zebra_vtep_t_ zebra_vtep_t;
4122e252	42	typedef struct zebra_mac_t_ zebra_mac_t;
4122e252	43	typedef struct zebra_neigh_t_ zebra_neigh_t;
b7cfce93	44	typedef struct zebra_l3vni_t_ zebra_l3vni_t;
18a7a601	45
	46	/*
	47	* VTEP info
	48	*
	49	* Right now, this just has each remote VTEP's IP address.
	50	*/
d62a17ae	51	struct zebra_vtep_t_ {
	52	/* Remote IP. */
	53	/* NOTE: Can only be IPv4 right now. */
	54	struct in_addr vtep_ip;
9718c54e AK	55	/* Flood mode (one of enum vxlan_flood_control) based on the PMSI
	56	* tunnel type advertised by the remote VTEP
	57	*/
	58	int flood_control;
d62a17ae	59
	60	/* Links. */
	61	struct zebra_vtep_t_ *next;
	62	struct zebra_vtep_t_ *prev;
18a7a601	63	};
	64
	65
	66	/*
	67	* VNI hash table
	68	*
	69	* Contains information pertaining to a VNI:
	70	* - the list of remote VTEPs (with this VNI)
	71	*/
d62a17ae	72	struct zebra_vni_t_ {
	73	/* VNI - key */
	74	vni_t vni;
18a7a601	75
1a98c087	76	/* Flag for advertising gw macip */
d7c0a89a	77	uint8_t advertise_gw_macip;
1a98c087	78
278e26de CS	79	/* Flag for advertising svi macip */
	80	uint8_t advertise_svi_macip;
	81
31310b25	82	/* Flag for advertising gw macip */
d7c0a89a	83	uint8_t advertise_subnet;
31310b25	84
d62a17ae	85	/* Corresponding VxLAN interface. */
d62a17ae	86	struct interface *vxlan_if;
18a7a601	87
d62a17ae	88	/* List of remote VTEPs */
d62a17ae	89	zebra_vtep_t *vteps;
18a7a601	90
d62a17ae	91	/* Local IP */
d62a17ae	92	struct in_addr local_vtep_ip;
4122e252	93
3d434f5c AK	94	/* PIM-SM MDT group for BUM flooding */
	95	struct in_addr mcast_grp;
	96
b7cfce93 MK	97	/* tenant VRF, if any */
	98	vrf_id_t vrf_id;
	99
d62a17ae	100	/* List of local or remote MAC */
d62a17ae	101	struct hash *mac_table;
4122e252	102
d62a17ae	103	/* List of local or remote neighbors (MAC+IP) */
d62a17ae	104	struct hash *neigh_table;
4122e252	105	};
4122e252	106
b7cfce93 MK	107	/* L3 VNI hash table */
	108	struct zebra_l3vni_t_ {
	109
	110	/* VNI key */
	111	vni_t vni;
	112
	113	/* vrf_id */
	114	vrf_id_t vrf_id;
	115
c48d9f5f MK	116	uint32_t filter;
	117	#define PREFIX_ROUTES_ONLY (1 << 0) /* l3-vni used for prefix routes only */
	118
b67a60d2	119	/* Local IP */
	120	struct in_addr local_vtep_ip;
	121
b7cfce93 MK	122	/* kernel interface for l3vni */
	123	struct interface *vxlan_if;
	124
	125	/* SVI interface corresponding to the l3vni */
	126	struct interface *svi_if;
	127
	128	/* list of L2 VNIs associated with the L3 VNI */
	129	struct list *l2vnis;
	130
	131	/* list of remote router-macs */
	132	struct hash *rmac_table;
	133
	134	/* list of remote vtep-ip neigh */
	135	struct hash *nh_table;
	136	};
	137
	138	/* get the vx-intf name for l3vni */
	139	static inline const char zl3vni_vxlan_if_name(zebra_l3vni_t zl3vni)
	140	{
	141	return zl3vni->vxlan_if ? zl3vni->vxlan_if->name : "None";
	142	}
	143
	144	/* get the svi intf name for l3vni */
	145	static inline const char zl3vni_svi_if_name(zebra_l3vni_t zl3vni)
	146	{
	147	return zl3vni->svi_if ? zl3vni->svi_if->name : "None";
	148	}
	149
	150	/* get the vrf name for l3vni */
	151	static inline const char zl3vni_vrf_name(zebra_l3vni_t zl3vni)
	152	{
	153	return vrf_id_to_name(zl3vni->vrf_id);
	154	}
	155
	156	/* get the rmac string */
	157	static inline const char zl3vni_rmac2str(zebra_l3vni_t zl3vni, char *buf,
	158	int size)
	159	{
	160	char *ptr;
	161
	162	if (!buf)
	163	ptr = (char *)XMALLOC(MTYPE_TMP,
	164	ETHER_ADDR_STRLEN * sizeof(char));
	165	else {
	166	assert(size >= ETHER_ADDR_STRLEN);
	167	ptr = buf;
	168	}
	169
	170	if (zl3vni->svi_if)
	171	snprintf(ptr, (ETHER_ADDR_STRLEN),
	172	"%02x:%02x:%02x:%02x:%02x:%02x",
	173	(uint8_t)zl3vni->svi_if->hw_addr[0],
	174	(uint8_t)zl3vni->svi_if->hw_addr[1],
	175	(uint8_t)zl3vni->svi_if->hw_addr[2],
	176	(uint8_t)zl3vni->svi_if->hw_addr[3],
	177	(uint8_t)zl3vni->svi_if->hw_addr[4],
	178	(uint8_t)zl3vni->svi_if->hw_addr[5]);
	179	else
	180	snprintf(ptr, ETHER_ADDR_STRLEN, "None");
	181
	182	return ptr;
	183	}
	184
	185	/*
186	* l3-vni is oper up when:
655b04d1	187	* 0. if EVPN is enabled (advertise-all-vni cfged)
b7cfce93 MK	188	* 1. it is associated to a vxlan-intf
	189	* 2. Associated vxlan-intf is oper up
	190	* 3. it is associated to an SVI
	191	* 4. associated SVI is oper up
	192	*/
	193	static inline int is_l3vni_oper_up(zebra_l3vni_t *zl3vni)
	194	{
996c9314 LB	195	return (is_evpn_enabled() && zl3vni && (zl3vni->vrf_id != VRF_UNKNOWN)
	196	&& zl3vni->vxlan_if && if_is_operative(zl3vni->vxlan_if)
	197	&& zl3vni->svi_if && if_is_operative(zl3vni->svi_if));
b7cfce93 MK	198	}
	199
	200	static inline const char zl3vni_state2str(zebra_l3vni_t zl3vni)
	201	{
	202	if (!zl3vni)
	203	return NULL;
	204
	205	if (is_l3vni_oper_up(zl3vni))
	206	return "Up";
	207	else
	208	return "Down";
	209
	210	return NULL;
	211	}
	212
	213	static inline vrf_id_t zl3vni_vrf_id(zebra_l3vni_t *zl3vni)
	214	{
	215	return zl3vni->vrf_id;
	216	}
	217
996c9314	218	static inline void zl3vni_get_rmac(zebra_l3vni_t zl3vni, struct ethaddr rmac)
b7cfce93 MK	219	{
	220	if (!zl3vni)
	221	return;
	222
	223	if (!is_l3vni_oper_up(zl3vni))
	224	return;
	225
	226	if (zl3vni->svi_if && if_is_operative(zl3vni->svi_if))
	227	memcpy(rmac->octet, zl3vni->svi_if->hw_addr, ETH_ALEN);
	228	}
	229
5e1b0650 DS	230	struct host_rb_entry {
	231	RB_ENTRY(host_rb_entry) hl_entry;
	232
	233	struct prefix p;
	234	};
	235
85442b09 DS	236	RB_HEAD(host_rb_tree_entry, host_rb_entry);
85442b09 DS	237	RB_PROTOTYPE(host_rb_tree_entry, host_rb_entry, hl_entry,
5e1b0650	238	host_rb_entry_compare);
4122e252	239	/*
	240	* MAC hash table.
	241	*
	242	* This table contains the MAC addresses pertaining to this VNI.
	243	* This includes local MACs learnt on an attached VLAN that maps
	244	* to this VNI as well as remote MACs learnt and installed by BGP.
	245	* Local MACs will be known either on a VLAN sub-interface or
	246	* on (port, VLAN); however, it is sufficient for zebra to maintain
	247	* against the VNI i.e., it does not need to retain the local "port"
	248	* information. The correct VNI will be obtained as zebra maintains
	249	* the mapping (of VLAN to VNI).
	250	*/
d62a17ae	251	struct zebra_mac_t_ {
	252	/* MAC address. */
	253	struct ethaddr macaddr;
4122e252	254
d7c0a89a	255	uint32_t flags;
4122e252	256	#define ZEBRA_MAC_LOCAL 0x01
	257	#define ZEBRA_MAC_REMOTE 0x02
	258	#define ZEBRA_MAC_AUTO 0x04 /* Auto created for neighbor. */
c85c03c7	259	#define ZEBRA_MAC_STICKY 0x08 /* Static MAC */
b7cfce93	260	#define ZEBRA_MAC_REMOTE_RMAC 0x10 /* remote router mac */
ead40654	261	#define ZEBRA_MAC_DEF_GW 0x20
51f4dab4 AK	262	/* remote VTEP advertised MAC as default GW */
51f4dab4 AK	263	#define ZEBRA_MAC_REMOTE_DEF_GW 0x40
e22a946a CS	264	#define ZEBRA_MAC_DUPLICATE 0x80
	265
	266	/* back pointer to zvni */
	267	zebra_vni_t *zvni;
4122e252	268
d62a17ae	269	/* Local or remote info. */
	270	union {
	271	struct {
	272	ifindex_t ifindex;
	273	vlanid_t vid;
	274	} local;
4122e252	275
d62a17ae	276	struct in_addr r_vtep_ip;
d62a17ae	277	} fwd_info;
4122e252	278
f07e1c99	279	/* Mobility sequence numbers associated with this entry. */
	280	uint32_t rem_seq;
	281	uint32_t loc_seq;
	282
b6938a74 MK	283	/* List of neigh associated with this mac */
b6938a74 MK	284	struct list *neigh_list;
b7cfce93	285
6134fd82	286	/* list of hosts pointing to this remote RMAC */
85442b09	287	struct host_rb_tree_entry host_rb;
e22a946a CS	288
	289	/* Duplicate mac detection */
	290	uint32_t dad_count;
	291
	292	struct thread *dad_mac_auto_recovery_timer;
	293
	294	struct timeval detect_start_time;
	295
	296	time_t dad_dup_detect_time;
4122e252	297	};
	298
	299	/*
	300	* Context for MAC hash walk - used by callbacks.
	301	*/
d62a17ae	302	struct mac_walk_ctx {
	303	zebra_vni_t zvni; / VNI hash */
	304	struct zebra_vrf zvrf; / VRF - for client notification. */
	305	int uninstall; /* uninstall from kernel? */
	306	int upd_client; /* uninstall from client? */
	307
d7c0a89a	308	uint32_t flags;
4122e252	309	#define DEL_LOCAL_MAC 0x1
	310	#define DEL_REMOTE_MAC 0x2
	311	#define DEL_ALL_MAC (DEL_LOCAL_MAC \| DEL_REMOTE_MAC)
	312	#define DEL_REMOTE_MAC_FROM_VTEP 0x4
	313	#define SHOW_REMOTE_MAC_FROM_VTEP 0x8
	314
d62a17ae	315	struct in_addr r_vtep_ip; /* To walk MACs from specific VTEP */
4122e252	316
cd233079	317	struct vty vty; / Used by VTY handlers */
d7c0a89a	318	uint32_t count; /* Used by VTY handlers */
cd233079	319	struct json_object json; / Used for JSON Output */
1374d4db	320	bool print_dup; /* Used to print dup addr list */
4122e252	321	};
4122e252	322
b7cfce93 MK	323	struct rmac_walk_ctx {
	324	struct vty *vty;
	325	struct json_object *json;
	326	};
	327
2c476b72	328	#define IS_ZEBRA_NEIGH_ACTIVE(n) (n->state == ZEBRA_NEIGH_ACTIVE)
b6938a74	329
2c476b72	330	#define IS_ZEBRA_NEIGH_INACTIVE(n) (n->state == ZEBRA_NEIGH_INACTIVE)
b6938a74 MK	331
	332	#define ZEBRA_NEIGH_SET_ACTIVE(n) n->state = ZEBRA_NEIGH_ACTIVE
	333
	334	#define ZEBRA_NEIGH_SET_INACTIVE(n) n->state = ZEBRA_NEIGH_INACTIVE
	335
4122e252	336	/*
	337	* Neighbor hash table.
	338	*
	339	* This table contains the neighbors (IP to MAC bindings) pertaining to
	340	* this VNI. This includes local neighbors learnt on the attached VLAN
	341	* device that maps to this VNI as well as remote neighbors learnt and
	342	* installed by BGP.
	343	* Local neighbors will be known against the VLAN device (SVI); however,
	344	* it is sufficient for zebra to maintain against the VNI. The correct
	345	* VNI will be obtained as zebra maintains the mapping (of VLAN to VNI).
	346	*/
d62a17ae	347	struct zebra_neigh_t_ {
	348	/* IP address. */
	349	struct ipaddr ip;
4122e252	350
d62a17ae	351	/* MAC address. */
d62a17ae	352	struct ethaddr emac;
4122e252	353
d62a17ae	354	/* Underlying interface. */
d62a17ae	355	ifindex_t ifindex;
4122e252	356
c80a972c CS	357	zebra_vni_t *zvni;
c80a972c CS	358
d7c0a89a	359	uint32_t flags;
b6938a74 MK	360	#define ZEBRA_NEIGH_LOCAL 0x01
b6938a74 MK	361	#define ZEBRA_NEIGH_REMOTE 0x02
b7cfce93	362	#define ZEBRA_NEIGH_REMOTE_NH 0x04 /* neigh entry for remote vtep */
ead40654	363	#define ZEBRA_NEIGH_DEF_GW 0x08
68e33151	364	#define ZEBRA_NEIGH_ROUTER_FLAG 0x10
e22a946a	365	#define ZEBRA_NEIGH_DUPLICATE 0x20
b6938a74 MK	366
b6938a74 MK	367	enum zebra_neigh_state state;
4122e252	368
d62a17ae	369	/* Remote VTEP IP - applicable only for remote neighbors. */
d62a17ae	370	struct in_addr r_vtep_ip;
b7cfce93	371
f07e1c99	372	/*
	373	* Mobility sequence numbers associated with this entry. The rem_seq
	374	* represents the sequence number from the client (BGP) for the most
	375	* recent add or update of this entry while the loc_seq represents
	376	* the sequence number informed (or to be informed) by zebra to BGP
	377	* for this entry.
	378	*/
	379	uint32_t rem_seq;
	380	uint32_t loc_seq;
	381
6134fd82	382	/* list of hosts pointing to this remote NH entry */
85442b09	383	struct host_rb_tree_entry host_rb;
e22a946a CS	384
	385	/* Duplicate ip detection */
	386	uint32_t dad_count;
	387
	388	struct thread *dad_ip_auto_recovery_timer;
	389
	390	struct timeval detect_start_time;
	391
	392	time_t dad_dup_detect_time;
4122e252	393	};
	394
	395	/*
	396	* Context for neighbor hash walk - used by callbacks.
	397	*/
d62a17ae	398	struct neigh_walk_ctx {
	399	zebra_vni_t zvni; / VNI hash */
	400	struct zebra_vrf zvrf; / VRF - for client notification. */
	401	int uninstall; /* uninstall from kernel? */
	402	int upd_client; /* uninstall from client? */
	403
d7c0a89a	404	uint32_t flags;
4122e252	405	#define DEL_LOCAL_NEIGH 0x1
	406	#define DEL_REMOTE_NEIGH 0x2
	407	#define DEL_ALL_NEIGH (DEL_LOCAL_NEIGH \| DEL_REMOTE_NEIGH)
	408	#define DEL_REMOTE_NEIGH_FROM_VTEP 0x4
	409	#define SHOW_REMOTE_NEIGH_FROM_VTEP 0x8
	410
d62a17ae	411	struct in_addr r_vtep_ip; /* To walk neighbors from specific VTEP */
4122e252	412
cd233079	413	struct vty vty; / Used by VTY handlers */
d7c0a89a QY	414	uint32_t count; /* Used by VTY handlers */
d7c0a89a QY	415	uint8_t addr_width; /* Used by VTY handlers */
cd233079	416	struct json_object json; / Used for JSON Output */
18a7a601	417	};
18a7a601	418
b7cfce93 MK	419	/* context for neigh hash walk - update l3vni and rmac */
	420	struct neigh_l3info_walk_ctx {
	421
	422	zebra_vni_t *zvni;
	423	zebra_l3vni_t *zl3vni;
	424	int add;
	425	};
	426
	427	struct nh_walk_ctx {
	428
	429	struct vty *vty;
	430	struct json_object *json;
	431	};
	432
51e94aa7 EDP	433	#ifdef __cplusplus
	434	}
	435	#endif
	436
8a93734c AK	437	/*
	438	* Multicast hash table.
	439	*
	440	* This table contains -
	441	* 1. The (S, G) entries used for encapsulating and forwarding BUM traffic.
	442	* S is the local VTEP-IP and G is a BUM mcast group address.
	443	* 2. The (X, G) entries used for terminating a BUM flow.
	444	* Multiple L2-VNIs can share the same MDT hence the need to maintain
	445	* an aggregated table that pimd can consume without much
	446	* re-interpretation.
	447	*/
	448	typedef struct zebra_vxlan_sg_ {
	449	struct zebra_vrf *zvrf;
	450
	451	struct prefix_sg sg;
	452	char sg_str[PREFIX_SG_STR_LEN];
	453
	454	/* For SG - num of L2 VNIs using this entry for sending BUM traffic */
	455	/* For XG - num of SG using this as parent */
	456	uint32_t ref_cnt;
	457	} zebra_vxlan_sg_t;
	458
18a7a601	459	#endif /* _ZEBRA_VXLAN_PRIVATE_H */