[mirror_frr.git] / zebra / zebra_evpn_mh.h

/*
 * Zebra EVPN MH Data structures and definitions
 *
 * Copyright (C) 2019 Cumulus Networks, Inc.
 * Anuradha Karuppiah
 *
 * 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.
 */

#ifndef _ZEBRA_EVPN_MH_H
#define _ZEBRA_EVPN_MH_H

#include <zebra.h>

#include "if.h"
#include "linklist.h"
#include "bitfield.h"
#include "zebra_vxlan.h"
#include "zebra_vxlan_private.h"
#include "zebra_nhg.h"

#define EVPN_MH_VTY_STR "Multihoming\n"

/* Ethernet Segment entry -
 * - Local and remote ESs are maintained in a global RB tree,
 * zmh_info->es_rb_tree using ESI as key
 * - Local ESs are added via zebra config (ZEBRA_EVPNES_LOCAL) when an
 *   access port is associated with an ES-ID
 * - Remotes ESs are added by BGP based on received/remote EAD/Type-1 routes
 *   (ZEBRA_EVPNES_REMOTE)
 * - An ES can be simultaneously LOCAL and REMOTE; infact all LOCAL ESs are
 *   expected to have REMOTE ES peers.
 */
struct zebra_evpn_es {
	esi_t esi;
	char esi_str[ESI_STR_LEN];

	/* ES flags */
	uint32_t flags;
#define ZEBRA_EVPNES_LOCAL         (1 << 0) /* configured in zebra */
#define ZEBRA_EVPNES_REMOTE        (1 << 1) /* added by bgp */
#define ZEBRA_EVPNES_OPER_UP       (1 << 2) /* es->ifp is oper-up */
#define ZEBRA_EVPNES_READY_FOR_BGP (1 << 3) /* ready to be sent to BGP */
#define ZEBRA_EVPNES_NHG_ACTIVE    (1 << 4) /* NHG has been installed */
/* This flag is only applicable to local ESs and signifies that this
 * VTEP is not the DF
 */
#define ZEBRA_EVPNES_NON_DF (1 << 5)
/* When the ES becomes a bridge port we need to activate the BUM non-DF
 * filter, SPH filter and backup NHG for fast-failover
 */
#define ZEBRA_EVPNES_BR_PORT (1 << 6)
/* ES is in bypass mode i.e. must not be advertised. ES-bypass is set
 * when the associated host bond goes into LACP bypass
 */
#define ZEBRA_EVPNES_BYPASS (1 << 7)

	/* memory used for adding the es to zmh_info->es_rb_tree */
	RB_ENTRY(zebra_evpn_es) rb_node;

	/* [EVPNES_LOCAL] memory used for linking the es to
	 * zmh_info->local_es_list
	 */
	struct listnode local_es_listnode;

	/* [EVPNES_LOCAL] corresponding interface */
	struct zebra_if *zif;

	/* list of ES-EVIs associated with the ES */
	struct list *es_evi_list;

	/* [!EVPNES_LOCAL] List of remote VTEPs (zebra_evpn_es_vtep) */
	struct list *es_vtep_list;

	/* list of zebra_mac entries using this ES as destination */
	struct list *mac_list;

	/* Nexthop group id */
	uint32_t nhg_id;

	/* Preference config for BUM-DF election. Sent to BGP and
	 * advertised via the ESR
	 */
	uint16_t df_pref;

	/* When a new ES is configured it is held in a non-DF state
	 * for 3 seconds. This allows the peer Type-4 routes to be
	 * imported before running the DF election.
	 */
#define ZEBRA_EVPN_MH_DF_DELAY_TIME 3 /* seconds */
	struct thread *df_delay_timer;
};
RB_HEAD(zebra_es_rb_head, zebra_evpn_es);
RB_PROTOTYPE(zebra_es_rb_head, zebra_evpn_es, rb_node, zebra_es_rb_cmp);

/* ES per-EVI info
 * - ES-EVIs are maintained per-EVPN (vni->es_evi_rb_tree)
 * - Local ES-EVIs are linked to per-EVPN list for quick access
 * - Although some infrastucture is present for remote ES-EVIs, currently
 *   BGP does NOT send remote ES-EVIs to zebra. This may change in the
 *   future (but must be changed thoughtfully and only if needed as ES-EVI
 *   can get prolific and come in the way of rapid failovers)
 */
struct zebra_evpn_es_evi {
	struct zebra_evpn_es *es;
	struct zebra_evpn *zevpn;

	/* ES-EVI flags */
	uint32_t flags;
	/* local ES-EVI */
#define ZEBRA_EVPNES_EVI_LOCAL         (1 << 0) /* created by zebra */
#define ZEBRA_EVPNES_EVI_READY_FOR_BGP (1 << 1) /* ready to be sent to BGP */

	/* memory used for adding the es_evi to
	 * es_evi->zevpn->es_evi_rb_tree
	 */
	RB_ENTRY(zebra_evpn_es_evi) rb_node;
	/* memory used for linking the es_evi to
	 * es_evi->zevpn->local_es_evi_list
	 */
	struct listnode l2vni_listnode;
	/* memory used for linking the es_evi to
	 * es_evi->es->es_evi_list
	 */
	struct listnode es_listnode;
};

/* A single L2 nexthop is allocated across all ESs with the same PE/VTEP
 * nexthop
 */
struct zebra_evpn_l2_nh {
	struct in_addr vtep_ip;

	/* MAC nexthop id */
	uint32_t nh_id;

	/* es_vtep entries using this nexthop */
	uint32_t ref_cnt;
};

/* PE attached to an ES */
struct zebra_evpn_es_vtep {
	struct zebra_evpn_es *es; /* parent ES */
	struct in_addr vtep_ip;

	uint32_t flags;
	/* Rxed Type-4 route from this VTEP */
#define ZEBRA_EVPNES_VTEP_RXED_ESR (1 << 0)
#define ZEBRA_EVPNES_VTEP_DEL_IN_PROG (1 << 1)

	/* MAC nexthop info */
	struct zebra_evpn_l2_nh *nh;

	/* memory used for adding the entry to es->es_vtep_list */
	struct listnode es_listnode;

	/* Parameters for DF election */
	uint8_t df_alg;
	uint32_t df_pref;

	/* XXX - maintain a backpointer to struct zebra_vtep */
};

/* Local/access-side broadcast domain - zebra_evpn_access_bd is added to -
 * zrouter->evpn_vlan_table (for VLAN aware bridges) OR
 * zrouter->evpn_bridge_table (for VLAN unaware bridges)
 * XXX - support for VLAN unaware bridges is yet to be flushed out
 */
struct zebra_evpn_access_bd {
	vlanid_t vid;

	struct zebra_if *vxlan_zif; /* vxlan device */
	/* list of members associated with the BD i.e. (potential) ESs */
	struct list *mbr_zifs;
	/* presence of zevpn activates the EVI on all the ESs in mbr_zifs */
	struct zebra_evpn *zevpn;
	/* SVI associated with the VLAN */
	struct zebra_if *vlan_zif;
};

/* multihoming information stored in zrouter */
#define zmh_info (zrouter.mh_info)
struct zebra_evpn_mh_info {
	uint32_t flags;
/* If the dataplane is not capable of handling a backup NHG on an access
 * port we will need to explicitly failover each MAC entry on
 * local ES down
 */
#define ZEBRA_EVPN_MH_REDIRECT_OFF (1 << 0)
/* DAD support for EVPN-MH is yet to be added. So on detection of
 * first local ES, DAD is turned off
 */
#define ZEBRA_EVPN_MH_DUP_ADDR_DETECT_OFF (1 << 1)
/* If EVPN MH is enabled we only advertise REACHABLE neigh entries as Type-2
 * routes. As there is no global config knob for enabling EVPN MH we turn
 * this flag when the first local ES is detected.
 */
#define ZEBRA_EVPN_MH_ADV_REACHABLE_NEIGH_ONLY (1 << 2)
/* If EVPN MH is enabled we advertise the SVI MAC address to avoid
 * flooding of ARP replies rxed from the multi-homed host
 */
#define ZEBRA_EVPN_MH_ADV_SVI_MAC (1 << 3)

	/* RB tree of Ethernet segments (used for EVPN-MH)  */
	struct zebra_es_rb_head es_rb_tree;
	/* List of local ESs */
	struct list *local_es_list;

	/* EVPN MH broadcast domains indexed by the VID */
	struct hash *evpn_vlan_table;

	/* A base L2-VNI is maintained to derive parameters such as
	 * ES originator-IP.
	 * XXX: once single vxlan device model becomes available this will
	 * not be necessary
	 */
	struct zebra_evpn *es_base_evpn;
	struct in_addr es_originator_ip;

	/* L2 NH and NHG ids -
	 * Most significant 4 bits is type. Lower 28 bits is the value
	 * allocated from the nh_id_bitmap.
	 */
	bitfield_t nh_id_bitmap;
#define EVPN_NH_ID_MAX       (16*1024)
#define EVPN_NH_ID_VAL_MASK  0xffffff
/* The purpose of using different types for NHG and NH is NOT to manage the
 * id space separately. It is simply to make debugging easier.
 */
#define EVPN_NH_ID_TYPE_BIT (NHG_TYPE_L2_NH << NHG_ID_TYPE_POS)
#define EVPN_NHG_ID_TYPE_BIT (NHG_TYPE_L2 << NHG_ID_TYPE_POS)
	/* L2-NHG table - key: nhg_id, data: zebra_evpn_es */
	struct hash *nhg_table;
	/* L2-NH table - key: vtep_up, data: zebra_evpn_nh */
	struct hash *nh_ip_table;

	/* XXX - re-visit the default hold timer value */
	int mac_hold_time;
#define ZEBRA_EVPN_MH_MAC_HOLD_TIME_DEF (18 * 60)
	int neigh_hold_time;
#define ZEBRA_EVPN_MH_NEIGH_HOLD_TIME_DEF (18 * 60)

	/* During this period access ports will be held in a protodown
	 * state
	 */
	int startup_delay_time; /* seconds */
#define ZEBRA_EVPN_MH_STARTUP_DELAY_DEF (3 * 60)
	struct thread *startup_delay_timer;

	/* Number of configured uplinks */
	uint32_t uplink_cfg_cnt;
	/* Number of operationally-up uplinks */
	uint32_t uplink_oper_up_cnt;

	/* These protodown bits are inherited by all ES bonds */
	uint32_t protodown_rc;
};

/* returns TRUE if the EVPN is ready to be sent to BGP */
static inline bool zebra_evpn_send_to_client_ok(struct zebra_evpn *zevpn)
{
	return !!(zevpn->flags & ZEVPN_READY_FOR_BGP);
}

static inline bool zebra_evpn_mac_is_es_local(struct zebra_mac *mac)
{
	return mac->es && (mac->es->flags & ZEBRA_EVPNES_LOCAL);
}

/* Returns true if the id is of L2-NHG or L2-NH type */
static inline bool zebra_evpn_mh_is_fdb_nh(uint32_t id)
{
	return ((id & EVPN_NHG_ID_TYPE_BIT) ||
			(id & EVPN_NH_ID_TYPE_BIT));
}

static inline bool
zebra_evpn_es_local_mac_via_network_port(struct zebra_evpn_es *es)
{
	return !(es->flags & ZEBRA_EVPNES_OPER_UP)
	       && (zmh_info->flags & ZEBRA_EVPN_MH_REDIRECT_OFF);
}

static inline bool zebra_evpn_mh_do_dup_addr_detect(void)
{
	return !(zmh_info->flags & ZEBRA_EVPN_MH_DUP_ADDR_DETECT_OFF);
}

static inline bool zebra_evpn_mh_do_adv_reachable_neigh_only(void)
{
	return !!(zmh_info->flags & ZEBRA_EVPN_MH_ADV_REACHABLE_NEIGH_ONLY);
}

static inline bool zebra_evpn_mh_do_adv_svi_mac(void)
{
	return zmh_info && (zmh_info->flags & ZEBRA_EVPN_MH_ADV_SVI_MAC);
}

/*****************************************************************************/
extern esi_t *zero_esi;
extern void zebra_evpn_mh_init(void);
extern void zebra_evpn_mh_terminate(void);
extern bool zebra_evpn_is_if_es_capable(struct zebra_if *zif);
extern void zebra_evpn_if_init(struct zebra_if *zif);
extern void zebra_evpn_if_cleanup(struct zebra_if *zif);
extern void zebra_evpn_es_evi_init(struct zebra_evpn *zevpn);
extern void zebra_evpn_es_evi_cleanup(struct zebra_evpn *zevpn);
extern void zebra_evpn_vxl_evpn_set(struct zebra_if *zif,
				    struct zebra_evpn *zevpn, bool set);
extern void zebra_evpn_es_set_base_evpn(struct zebra_evpn *zevpn);
extern void zebra_evpn_es_clear_base_evpn(struct zebra_evpn *zevpn);
extern void zebra_evpn_vl_vxl_ref(uint16_t vid, struct zebra_if *vxlan_zif);
extern void zebra_evpn_vl_vxl_deref(uint16_t vid, struct zebra_if *vxlan_zif);
extern void zebra_evpn_vl_mbr_ref(uint16_t vid, struct zebra_if *zif);
extern void zebra_evpn_vl_mbr_deref(uint16_t vid, struct zebra_if *zif);
extern void zebra_evpn_es_send_all_to_client(bool add);
extern void zebra_evpn_es_if_oper_state_change(struct zebra_if *zif, bool up);
extern void zebra_evpn_es_show(struct vty *vty, bool uj);
extern void zebra_evpn_es_show_detail(struct vty *vty, bool uj);
extern void zebra_evpn_es_show_esi(struct vty *vty, bool uj, esi_t *esi);
extern void zebra_evpn_update_all_es(struct zebra_evpn *zevpn);
extern void zebra_evpn_proc_remote_es(ZAPI_HANDLER_ARGS);
int zebra_evpn_remote_es_add(const esi_t *esi, struct in_addr vtep_ip,
			     bool esr_rxed, uint8_t df_alg, uint16_t df_pref);
int zebra_evpn_remote_es_del(const esi_t *esi, struct in_addr vtep_ip);
extern void zebra_evpn_es_evi_show(struct vty *vty, bool uj, int detail);
extern void zebra_evpn_es_evi_show_vni(struct vty *vty, bool uj,
		vni_t vni, int detail);
extern void zebra_evpn_es_mac_deref_entry(struct zebra_mac *mac);
extern bool zebra_evpn_es_mac_ref_entry(struct zebra_mac *mac,
					struct zebra_evpn_es *es);
extern bool zebra_evpn_es_mac_ref(struct zebra_mac *mac, const esi_t *esi);
extern struct zebra_evpn_es *zebra_evpn_es_find(const esi_t *esi);
extern void zebra_evpn_interface_init(void);
extern int zebra_evpn_mh_if_write(struct vty *vty, struct interface *ifp);
extern void zebra_evpn_acc_vl_show(struct vty *vty, bool uj);
extern void zebra_evpn_acc_vl_show_detail(struct vty *vty, bool uj);
extern void zebra_evpn_acc_vl_show_vid(struct vty *vty, bool uj, vlanid_t vid);
extern void zebra_evpn_if_es_print(struct vty *vty, json_object *json,
				   struct zebra_if *zif);
extern void zebra_evpn_es_cleanup(void);
extern int zebra_evpn_mh_mac_holdtime_update(struct vty *vty,
		uint32_t duration, bool set_default);
void zebra_evpn_mh_config_write(struct vty *vty);
int zebra_evpn_mh_neigh_holdtime_update(struct vty *vty,
		uint32_t duration, bool set_default);
void zebra_evpn_es_local_br_port_update(struct zebra_if *zif);
extern int zebra_evpn_mh_startup_delay_update(struct vty *vty,
					      uint32_t duration,
					      bool set_default);
extern void zebra_evpn_mh_uplink_oper_update(struct zebra_if *zif);
extern void zebra_evpn_mh_update_protodown_bond_mbr(struct zebra_if *zif,
						    bool clear,
						    const char *caller);
extern bool zebra_evpn_is_es_bond(struct interface *ifp);
extern bool zebra_evpn_is_es_bond_member(struct interface *ifp);
extern void zebra_evpn_mh_print(struct vty *vty);
extern void zebra_evpn_mh_json(json_object *json);
extern bool zebra_evpn_nhg_is_local_es(uint32_t nhg_id,
				       struct zebra_evpn_es **local_es);
extern int zebra_evpn_mh_redirect_off(struct vty *vty, bool redirect_off);
extern void zebra_evpn_l2_nh_show(struct vty *vty, bool uj);
extern void zebra_evpn_acc_bd_svi_set(struct zebra_if *vlan_zif,
				      struct zebra_if *br_zif, bool is_up);
extern void zebra_evpn_acc_bd_svi_mac_add(struct interface *vlan_if);
extern void zebra_evpn_es_bypass_update(struct zebra_evpn_es *es,
					struct interface *ifp, bool bypass);
extern void zebra_evpn_proc_remote_nh(ZAPI_HANDLER_ARGS);
extern struct zebra_evpn_es_evi *
zebra_evpn_es_evi_find(struct zebra_evpn_es *es, struct zebra_evpn *zevpn);

#endif /* _ZEBRA_EVPN_MH_H */
Commit	Line	Data
ce5160c0 AK	1	/*
	2	* Zebra EVPN MH Data structures and definitions
	3	*
	4	* Copyright (C) 2019 Cumulus Networks, Inc.
	5	* Anuradha Karuppiah
	6	*
	7	* This file is part of FRR.
	8	*
	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
	12	* later version.
	13	*
	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.
	18	*/
	19
	20	#ifndef _ZEBRA_EVPN_MH_H
	21	#define _ZEBRA_EVPN_MH_H
	22
	23	#include <zebra.h>
	24
	25	#include "if.h"
	26	#include "linklist.h"
	27	#include "bitfield.h"
	28	#include "zebra_vxlan.h"
	29	#include "zebra_vxlan_private.h"
4f9bb78e	30	#include "zebra_nhg.h"
ce5160c0 AK	31
	32	#define EVPN_MH_VTY_STR "Multihoming\n"
	33
	34	/* Ethernet Segment entry -
	35	* - Local and remote ESs are maintained in a global RB tree,
	36	* zmh_info->es_rb_tree using ESI as key
	37	* - Local ESs are added via zebra config (ZEBRA_EVPNES_LOCAL) when an
	38	* access port is associated with an ES-ID
	39	* - Remotes ESs are added by BGP based on received/remote EAD/Type-1 routes
	40	* (ZEBRA_EVPNES_REMOTE)
b0b9a2fe	41	* - An ES can be simultaneously LOCAL and REMOTE; infact all LOCAL ESs are
ce5160c0 AK	42	* expected to have REMOTE ES peers.
	43	*/
	44	struct zebra_evpn_es {
	45	esi_t esi;
	46	char esi_str[ESI_STR_LEN];
	47
	48	/* ES flags */
	49	uint32_t flags;
	50	#define ZEBRA_EVPNES_LOCAL (1 << 0) /* configured in zebra */
	51	#define ZEBRA_EVPNES_REMOTE (1 << 1) /* added by bgp */
	52	#define ZEBRA_EVPNES_OPER_UP (1 << 2) /* es->ifp is oper-up */
	53	#define ZEBRA_EVPNES_READY_FOR_BGP (1 << 3) /* ready to be sent to BGP */
	54	#define ZEBRA_EVPNES_NHG_ACTIVE (1 << 4) /* NHG has been installed */
1103c5c6 AK	55	/* This flag is only applicable to local ESs and signifies that this
	56	* VTEP is not the DF
	57	*/
	58	#define ZEBRA_EVPNES_NON_DF (1 << 5)
28e80a03 AK	59	/* When the ES becomes a bridge port we need to activate the BUM non-DF
	60	* filter, SPH filter and backup NHG for fast-failover
	61	*/
	62	#define ZEBRA_EVPNES_BR_PORT (1 << 6)
00a7710c AK	63	/* ES is in bypass mode i.e. must not be advertised. ES-bypass is set
	64	* when the associated host bond goes into LACP bypass
	65	*/
	66	#define ZEBRA_EVPNES_BYPASS (1 << 7)
ce5160c0 AK	67
	68	/* memory used for adding the es to zmh_info->es_rb_tree */
	69	RB_ENTRY(zebra_evpn_es) rb_node;
	70
	71	/* [EVPNES_LOCAL] memory used for linking the es to
	72	* zmh_info->local_es_list
	73	*/
	74	struct listnode local_es_listnode;
	75
	76	/* [EVPNES_LOCAL] corresponding interface */
	77	struct zebra_if *zif;
	78
	79	/* list of ES-EVIs associated with the ES */
	80	struct list *es_evi_list;
	81
	82	/* [!EVPNES_LOCAL] List of remote VTEPs (zebra_evpn_es_vtep) */
	83	struct list *es_vtep_list;
	84
b169fd6f AK	85	/* list of zebra_mac entries using this ES as destination */
b169fd6f AK	86	struct list *mac_list;
ce5160c0 AK	87
	88	/* Nexthop group id */
	89	uint32_t nhg_id;
1103c5c6 AK	90
	91	/* Preference config for BUM-DF election. Sent to BGP and
	92	* advertised via the ESR
	93	*/
	94	uint16_t df_pref;
35f5c31b AK	95
	96	/* When a new ES is configured it is held in a non-DF state
	97	* for 3 seconds. This allows the peer Type-4 routes to be
	98	* imported before running the DF election.
	99	*/
	100	#define ZEBRA_EVPN_MH_DF_DELAY_TIME 3 /* seconds */
	101	struct thread *df_delay_timer;
ce5160c0 AK	102	};
	103	RB_HEAD(zebra_es_rb_head, zebra_evpn_es);
	104	RB_PROTOTYPE(zebra_es_rb_head, zebra_evpn_es, rb_node, zebra_es_rb_cmp);
	105
	106	/* ES per-EVI info
87d76d54 PR	107	* - ES-EVIs are maintained per-EVPN (vni->es_evi_rb_tree)
87d76d54 PR	108	* - Local ES-EVIs are linked to per-EVPN list for quick access
ce5160c0 AK	109	* - Although some infrastucture is present for remote ES-EVIs, currently
	110	* BGP does NOT send remote ES-EVIs to zebra. This may change in the
	111	* future (but must be changed thoughtfully and only if needed as ES-EVI
	112	* can get prolific and come in the way of rapid failovers)
	113	*/
	114	struct zebra_evpn_es_evi {
	115	struct zebra_evpn_es *es;
f6371c34	116	struct zebra_evpn *zevpn;
ce5160c0 AK	117
	118	/* ES-EVI flags */
	119	uint32_t flags;
	120	/* local ES-EVI */
	121	#define ZEBRA_EVPNES_EVI_LOCAL (1 << 0) /* created by zebra */
	122	#define ZEBRA_EVPNES_EVI_READY_FOR_BGP (1 << 1) /* ready to be sent to BGP */
	123
	124	/* memory used for adding the es_evi to
87d76d54	125	* es_evi->zevpn->es_evi_rb_tree
ce5160c0 AK	126	*/
	127	RB_ENTRY(zebra_evpn_es_evi) rb_node;
	128	/* memory used for linking the es_evi to
87d76d54	129	* es_evi->zevpn->local_es_evi_list
ce5160c0 AK	130	*/
	131	struct listnode l2vni_listnode;
	132	/* memory used for linking the es_evi to
	133	* es_evi->es->es_evi_list
	134	*/
	135	struct listnode es_listnode;
	136	};
	137
5de10c37 AK	138	/* A single L2 nexthop is allocated across all ESs with the same PE/VTEP
	139	* nexthop
	140	*/
	141	struct zebra_evpn_l2_nh {
	142	struct in_addr vtep_ip;
	143
	144	/* MAC nexthop id */
	145	uint32_t nh_id;
	146
	147	/* es_vtep entries using this nexthop */
	148	uint32_t ref_cnt;
	149	};
	150
ce5160c0 AK	151	/* PE attached to an ES */
	152	struct zebra_evpn_es_vtep {
	153	struct zebra_evpn_es es; / parent ES */
	154	struct in_addr vtep_ip;
	155
1103c5c6 AK	156	uint32_t flags;
	157	/* Rxed Type-4 route from this VTEP */
	158	#define ZEBRA_EVPNES_VTEP_RXED_ESR (1 << 0)
28e80a03	159	#define ZEBRA_EVPNES_VTEP_DEL_IN_PROG (1 << 1)
1103c5c6	160
5de10c37 AK	161	/* MAC nexthop info */
	162	struct zebra_evpn_l2_nh *nh;
	163
ce5160c0 AK	164	/* memory used for adding the entry to es->es_vtep_list */
	165	struct listnode es_listnode;
	166
1103c5c6 AK	167	/* Parameters for DF election */
	168	uint8_t df_alg;
	169	uint32_t df_pref;
	170
c172c032	171	/* XXX - maintain a backpointer to struct zebra_vtep */
ce5160c0 AK	172	};
	173
	174	/* Local/access-side broadcast domain - zebra_evpn_access_bd is added to -
	175	* zrouter->evpn_vlan_table (for VLAN aware bridges) OR
	176	* zrouter->evpn_bridge_table (for VLAN unaware bridges)
	177	* XXX - support for VLAN unaware bridges is yet to be flushed out
	178	*/
	179	struct zebra_evpn_access_bd {
	180	vlanid_t vid;
	181
	182	struct zebra_if vxlan_zif; / vxlan device */
	183	/* list of members associated with the BD i.e. (potential) ESs */
	184	struct list *mbr_zifs;
87d76d54	185	/* presence of zevpn activates the EVI on all the ESs in mbr_zifs */
f6371c34	186	struct zebra_evpn *zevpn;
243b74ed AK	187	/* SVI associated with the VLAN */
243b74ed AK	188	struct zebra_if *vlan_zif;
ce5160c0 AK	189	};
	190
	191	/* multihoming information stored in zrouter */
	192	#define zmh_info (zrouter.mh_info)
	193	struct zebra_evpn_mh_info {
b2ee2b71	194	uint32_t flags;
15400f95 AK	195	/* If the dataplane is not capable of handling a backup NHG on an access
	196	* port we will need to explicitly failover each MAC entry on
	197	* local ES down
	198	*/
	199	#define ZEBRA_EVPN_MH_REDIRECT_OFF (1 << 0)
b2ee2b71 AK	200	/* DAD support for EVPN-MH is yet to be added. So on detection of
	201	* first local ES, DAD is turned off
	202	*/
	203	#define ZEBRA_EVPN_MH_DUP_ADDR_DETECT_OFF (1 << 1)
c7bfd085 AK	204	/* If EVPN MH is enabled we only advertise REACHABLE neigh entries as Type-2
	205	* routes. As there is no global config knob for enabling EVPN MH we turn
	206	* this flag when the first local ES is detected.
	207	*/
	208	#define ZEBRA_EVPN_MH_ADV_REACHABLE_NEIGH_ONLY (1 << 2)
243b74ed AK	209	/* If EVPN MH is enabled we advertise the SVI MAC address to avoid
	210	* flooding of ARP replies rxed from the multi-homed host
	211	*/
	212	#define ZEBRA_EVPN_MH_ADV_SVI_MAC (1 << 3)
b2ee2b71	213
ce5160c0 AK	214	/* RB tree of Ethernet segments (used for EVPN-MH) */
	215	struct zebra_es_rb_head es_rb_tree;
	216	/* List of local ESs */
	217	struct list *local_es_list;
	218
	219	/* EVPN MH broadcast domains indexed by the VID */
	220	struct hash *evpn_vlan_table;
	221
	222	/* A base L2-VNI is maintained to derive parameters such as
	223	* ES originator-IP.
	224	* XXX: once single vxlan device model becomes available this will
	225	* not be necessary
	226	*/
f6371c34	227	struct zebra_evpn *es_base_evpn;
ce5160c0 AK	228	struct in_addr es_originator_ip;
	229
	230	/* L2 NH and NHG ids -
4f9bb78e	231	* Most significant 4 bits is type. Lower 28 bits is the value
ce5160c0 AK	232	* allocated from the nh_id_bitmap.
	233	*/
	234	bitfield_t nh_id_bitmap;
	235	#define EVPN_NH_ID_MAX (16*1024)
	236	#define EVPN_NH_ID_VAL_MASK 0xffffff
ce5160c0 AK	237	/* The purpose of using different types for NHG and NH is NOT to manage the
	238	* id space separately. It is simply to make debugging easier.
	239	*/
4f9bb78e AK	240	#define EVPN_NH_ID_TYPE_BIT (NHG_TYPE_L2_NH << NHG_ID_TYPE_POS)
4f9bb78e AK	241	#define EVPN_NHG_ID_TYPE_BIT (NHG_TYPE_L2 << NHG_ID_TYPE_POS)
15400f95 AK	242	/* L2-NHG table - key: nhg_id, data: zebra_evpn_es */
15400f95 AK	243	struct hash *nhg_table;
5de10c37 AK	244	/* L2-NH table - key: vtep_up, data: zebra_evpn_nh */
5de10c37 AK	245	struct hash *nh_ip_table;
b169fd6f AK	246
b169fd6f AK	247	/* XXX - re-visit the default hold timer value */
c36e442c AK	248	int mac_hold_time;
	249	#define ZEBRA_EVPN_MH_MAC_HOLD_TIME_DEF (18 * 60)
	250	int neigh_hold_time;
	251	#define ZEBRA_EVPN_MH_NEIGH_HOLD_TIME_DEF (18 * 60)
	252
	253	/* During this period access ports will be held in a protodown
	254	* state
	255	*/
	256	int startup_delay_time; /* seconds */
	257	#define ZEBRA_EVPN_MH_STARTUP_DELAY_DEF (3 * 60)
	258	struct thread *startup_delay_timer;
	259
	260	/* Number of configured uplinks */
	261	uint32_t uplink_cfg_cnt;
	262	/* Number of operationally-up uplinks */
	263	uint32_t uplink_oper_up_cnt;
	264
	265	/* These protodown bits are inherited by all ES bonds */
5d414138	266	uint32_t protodown_rc;
ce5160c0 AK	267	};
ce5160c0 AK	268
e4c3ece6	269	/* returns TRUE if the EVPN is ready to be sent to BGP */
f6371c34	270	static inline bool zebra_evpn_send_to_client_ok(struct zebra_evpn *zevpn)
e4c3ece6 AK	271	{
	272	return !!(zevpn->flags & ZEVPN_READY_FOR_BGP);
	273	}
	274
3198b2b3	275	static inline bool zebra_evpn_mac_is_es_local(struct zebra_mac *mac)
ce5160c0 AK	276	{
	277	return mac->es && (mac->es->flags & ZEBRA_EVPNES_LOCAL);
	278	}
	279
	280	/* Returns true if the id is of L2-NHG or L2-NH type */
	281	static inline bool zebra_evpn_mh_is_fdb_nh(uint32_t id)
	282	{
	283	return ((id & EVPN_NHG_ID_TYPE_BIT) \|\|
	284	(id & EVPN_NH_ID_TYPE_BIT));
	285	}
	286
15400f95 AK	287	static inline bool
	288	zebra_evpn_es_local_mac_via_network_port(struct zebra_evpn_es *es)
	289	{
	290	return !(es->flags & ZEBRA_EVPNES_OPER_UP)
	291	&& (zmh_info->flags & ZEBRA_EVPN_MH_REDIRECT_OFF);
	292	}
	293
b2ee2b71 AK	294	static inline bool zebra_evpn_mh_do_dup_addr_detect(void)
	295	{
	296	return !(zmh_info->flags & ZEBRA_EVPN_MH_DUP_ADDR_DETECT_OFF);
	297	}
	298
c7bfd085 AK	299	static inline bool zebra_evpn_mh_do_adv_reachable_neigh_only(void)
	300	{
	301	return !!(zmh_info->flags & ZEBRA_EVPN_MH_ADV_REACHABLE_NEIGH_ONLY);
	302	}
	303
243b74ed AK	304	static inline bool zebra_evpn_mh_do_adv_svi_mac(void)
	305	{
	306	return zmh_info && (zmh_info->flags & ZEBRA_EVPN_MH_ADV_SVI_MAC);
	307	}
c7bfd085	308
ce5160c0 AK	309	/*****************************************************************************/
	310	extern esi_t *zero_esi;
	311	extern void zebra_evpn_mh_init(void);
	312	extern void zebra_evpn_mh_terminate(void);
	313	extern bool zebra_evpn_is_if_es_capable(struct zebra_if *zif);
	314	extern void zebra_evpn_if_init(struct zebra_if *zif);
	315	extern void zebra_evpn_if_cleanup(struct zebra_if *zif);
f6371c34 DS	316	extern void zebra_evpn_es_evi_init(struct zebra_evpn *zevpn);
	317	extern void zebra_evpn_es_evi_cleanup(struct zebra_evpn *zevpn);
	318	extern void zebra_evpn_vxl_evpn_set(struct zebra_if *zif,
	319	struct zebra_evpn *zevpn, bool set);
	320	extern void zebra_evpn_es_set_base_evpn(struct zebra_evpn *zevpn);
	321	extern void zebra_evpn_es_clear_base_evpn(struct zebra_evpn *zevpn);
ce5160c0 AK	322	extern void zebra_evpn_vl_vxl_ref(uint16_t vid, struct zebra_if *vxlan_zif);
	323	extern void zebra_evpn_vl_vxl_deref(uint16_t vid, struct zebra_if *vxlan_zif);
	324	extern void zebra_evpn_vl_mbr_ref(uint16_t vid, struct zebra_if *zif);
	325	extern void zebra_evpn_vl_mbr_deref(uint16_t vid, struct zebra_if *zif);
	326	extern void zebra_evpn_es_send_all_to_client(bool add);
	327	extern void zebra_evpn_es_if_oper_state_change(struct zebra_if *zif, bool up);
	328	extern void zebra_evpn_es_show(struct vty *vty, bool uj);
	329	extern void zebra_evpn_es_show_detail(struct vty *vty, bool uj);
	330	extern void zebra_evpn_es_show_esi(struct vty vty, bool uj, esi_t esi);
f6371c34	331	extern void zebra_evpn_update_all_es(struct zebra_evpn *zevpn);
ce5160c0	332	extern void zebra_evpn_proc_remote_es(ZAPI_HANDLER_ARGS);
32367e7a MS	333	int zebra_evpn_remote_es_add(const esi_t *esi, struct in_addr vtep_ip,
	334	bool esr_rxed, uint8_t df_alg, uint16_t df_pref);
	335	int zebra_evpn_remote_es_del(const esi_t *esi, struct in_addr vtep_ip);
ce5160c0 AK	336	extern void zebra_evpn_es_evi_show(struct vty *vty, bool uj, int detail);
	337	extern void zebra_evpn_es_evi_show_vni(struct vty *vty, bool uj,
	338	vni_t vni, int detail);
3198b2b3 DS	339	extern void zebra_evpn_es_mac_deref_entry(struct zebra_mac *mac);
3198b2b3 DS	340	extern bool zebra_evpn_es_mac_ref_entry(struct zebra_mac *mac,
1a3bd37f	341	struct zebra_evpn_es *es);
3198b2b3	342	extern bool zebra_evpn_es_mac_ref(struct zebra_mac mac, const esi_t esi);
32367e7a	343	extern struct zebra_evpn_es zebra_evpn_es_find(const esi_t esi);
ce5160c0 AK	344	extern void zebra_evpn_interface_init(void);
	345	extern int zebra_evpn_mh_if_write(struct vty vty, struct interface ifp);
	346	extern void zebra_evpn_acc_vl_show(struct vty *vty, bool uj);
	347	extern void zebra_evpn_acc_vl_show_detail(struct vty *vty, bool uj);
	348	extern void zebra_evpn_acc_vl_show_vid(struct vty *vty, bool uj, vlanid_t vid);
c15dc24f RW	349	extern void zebra_evpn_if_es_print(struct vty vty, json_object json,
c15dc24f RW	350	struct zebra_if *zif);
ce5160c0	351	extern void zebra_evpn_es_cleanup(void);
b169fd6f AK	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);
72f2674a	357	void zebra_evpn_es_local_br_port_update(struct zebra_if *zif);
c36e442c AK	358	extern int zebra_evpn_mh_startup_delay_update(struct vty *vty,
	359	uint32_t duration,
	360	bool set_default);
	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,
	363	bool clear,
	364	const char *caller);
	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);
15400f95 AK	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);
5de10c37	372	extern void zebra_evpn_l2_nh_show(struct vty *vty, bool uj);
243b74ed AK	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);
00a7710c AK	376	extern void zebra_evpn_es_bypass_update(struct zebra_evpn_es *es,
00a7710c AK	377	struct interface *ifp, bool bypass);
7bfa7d02	378	extern void zebra_evpn_proc_remote_nh(ZAPI_HANDLER_ARGS);
09de6e45 AK	379	extern struct zebra_evpn_es_evi *
09de6e45 AK	380	zebra_evpn_es_evi_find(struct zebra_evpn_es es, struct zebra_evpn zevpn);
ce5160c0 AK	381
ce5160c0 AK	382	#endif /* _ZEBRA_EVPN_MH_H */