[mirror_frr.git] / zebra / interface.h


/* Interface function header.
 * Copyright (C) 1999 Kunihiro Ishiguro
 *
 * This file is part of GNU Zebra.
 *
 * GNU Zebra 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.
 *
 * GNU Zebra 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 this program; see the file COPYING; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
 */

#ifndef _ZEBRA_INTERFACE_H
#define _ZEBRA_INTERFACE_H

#include "redistribute.h"
#include "vrf.h"
#include "hook.h"
#include "bitfield.h"

#include "zebra/zebra_l2.h"
#include "zebra/zebra_nhg_private.h"
#include "zebra/zebra_router.h"

#ifdef __cplusplus
extern "C" {
#endif

/* For interface multicast configuration. */
#define IF_ZEBRA_MULTICAST_UNSPEC 0
#define IF_ZEBRA_MULTICAST_ON     1
#define IF_ZEBRA_MULTICAST_OFF    2

/* For interface shutdown configuration. */
#define IF_ZEBRA_SHUTDOWN_OFF    0
#define IF_ZEBRA_SHUTDOWN_ON     1

#define IF_VLAN_BITMAP_MAX 4096

#if defined(HAVE_RTADV)
/* Router advertisement parameter.  From RFC4861, RFC6275 and RFC4191. */
struct rtadvconf {
	/* A flag indicating whether or not the router sends periodic Router
	   Advertisements and responds to Router Solicitations.
	   Default: false */
	int AdvSendAdvertisements;

	/* The maximum time allowed between sending unsolicited multicast
	   Router Advertisements from the interface, in milliseconds.
	   MUST be no less than 70 ms [RFC6275 7.5] and no greater
	   than 1800000 ms [RFC4861 6.2.1].

	   Default: 600000 milliseconds */
	int MaxRtrAdvInterval;
#define RTADV_MAX_RTR_ADV_INTERVAL 600000

	/* The minimum time allowed between sending unsolicited multicast
	   Router Advertisements from the interface, in milliseconds.
	   MUST be no less than 30 ms [RFC6275 7.5].
	   MUST be no greater than .75 * MaxRtrAdvInterval.

	   Default: 0.33 * MaxRtrAdvInterval */
	int MinRtrAdvInterval; /* This field is currently unused. */
#define RTADV_MIN_RTR_ADV_INTERVAL (0.33 * RTADV_MAX_RTR_ADV_INTERVAL)

	/* Unsolicited Router Advertisements' interval timer. */
	int AdvIntervalTimer;

	/* The true/false value to be placed in the "Managed address
	   configuration" flag field in the Router Advertisement.  See
	   [ADDRCONF].

	   Default: false */
	int AdvManagedFlag;
	struct timeval lastadvmanagedflag;


	/* The true/false value to be placed in the "Other stateful
	   configuration" flag field in the Router Advertisement.  See
	   [ADDRCONF].

	   Default: false */
	int AdvOtherConfigFlag;
	struct timeval lastadvotherconfigflag;

	/* The value to be placed in MTU options sent by the router.  A
	   value of zero indicates that no MTU options are sent.

	   Default: 0 */
	int AdvLinkMTU;


	/* The value to be placed in the Reachable Time field in the Router
	   Advertisement messages sent by the router.  The value zero means
	   unspecified (by this router).  MUST be no greater than 3,600,000
	   milliseconds (1 hour).

	   Default: 0 */
	uint32_t AdvReachableTime;
#define RTADV_MAX_REACHABLE_TIME 3600000
	struct timeval lastadvreachabletime;

	/* The value to be placed in the Retrans Timer field in the Router
	   Advertisement messages sent by the router.  The value zero means
	   unspecified (by this router).

	   Default: 0 */
	int AdvRetransTimer;
	struct timeval lastadvretranstimer;

	/* The default value to be placed in the Cur Hop Limit field in the
	   Router Advertisement messages sent by the router.  The value
	   should be set to that current diameter of the Internet.  The
	   value zero means unspecified (by this router).

	   Default: The value specified in the "Assigned Numbers" RFC
	   [ASSIGNED] that was in effect at the time of implementation. */
	int AdvCurHopLimit;
	struct timeval lastadvcurhoplimit;

#define RTADV_DEFAULT_HOPLIMIT 64 /* 64 hops */

	/* The value to be placed in the Router Lifetime field of Router
	   Advertisements sent from the interface, in seconds.  MUST be
	   either zero or between MaxRtrAdvInterval and 9000 seconds.  A
	   value of zero indicates that the router is not to be used as a
	   default router.

	   Default: 3 * MaxRtrAdvInterval */
	int AdvDefaultLifetime;
#define RTADV_MAX_RTRLIFETIME 9000 /* 2.5 hours */

	/* A list of prefixes to be placed in Prefix Information options in
	   Router Advertisement messages sent from the interface.

	   Default: all prefixes that the router advertises via routing
	   protocols as being on-link for the interface from which the
	   advertisement is sent. The link-local prefix SHOULD NOT be
	   included in the list of advertised prefixes. */
	struct list *AdvPrefixList;

	/* The true/false value to be placed in the "Home agent"
	   flag field in the Router Advertisement.  See [RFC6275 7.1].

	   Default: false */
	int AdvHomeAgentFlag;
#ifndef ND_RA_FLAG_HOME_AGENT
#define ND_RA_FLAG_HOME_AGENT 	0x20
#endif

	/* The value to be placed in Home Agent Information option if Home
	   Flag is set.
	   Default: 0 */
	int HomeAgentPreference;

	/* The value to be placed in Home Agent Information option if Home
	   Flag is set. Lifetime (seconds) MUST not be greater than 18.2
	   hours.
	   The value 0 has special meaning: use of AdvDefaultLifetime value.

	   Default: 0 */
	int HomeAgentLifetime;
#define RTADV_MAX_HALIFETIME 65520 /* 18.2 hours */

	/* The true/false value to insert or not an Advertisement Interval
	   option. See [RFC 6275 7.3]

	   Default: false */
	int AdvIntervalOption;

	/* The value to be placed in the Default Router Preference field of
	   a router advertisement. See [RFC 4191 2.1 & 2.2]

	   Default: 0 (medium) */
	int DefaultPreference;
#define RTADV_PREF_MEDIUM 0x0 /* Per RFC4191. */

	/*
	 * List of recursive DNS servers to include in the RDNSS option.
	 * See [RFC8106 5.1]
	 *
	 * Default: empty list; do not emit RDNSS option
	 */
	struct list *AdvRDNSSList;

	/*
	 * List of DNS search domains to include in the DNSSL option.
	 * See [RFC8106 5.2]
	 *
	 * Default: empty list; do not emit DNSSL option
	 */
	struct list *AdvDNSSLList;

	/*
	 * rfc4861 states RAs must be sent at least 3 seconds apart.
	 * We allow faster retransmits to speed up convergence but can
	 * turn that capability off to meet the rfc if needed.
	 */
	bool UseFastRexmit; /* True if fast rexmits are enabled */

	uint8_t inFastRexmit; /* True if we're rexmits faster than usual */

	/* Track if RA was configured by BGP or by the Operator or both */
	uint8_t ra_configured;    /* Was RA configured? */
#define BGP_RA_CONFIGURED (1<<0)  /* BGP configured RA? */
#define VTY_RA_CONFIGURED (1<<1)  /* Operator configured RA? */
#define VTY_RA_INTERVAL_CONFIGURED (1<<2)  /* Operator configured RA interval */
	int NumFastReXmitsRemain; /* Loaded first with number of fast
				     rexmits to do */

#define RTADV_FAST_REXMIT_PERIOD 1 /* 1 sec */
#define RTADV_NUM_FAST_REXMITS   4 /* Fast Rexmit RA 4 times on certain events */
};

struct rtadv_rdnss {
	/* Address of recursive DNS server to advertise */
	struct in6_addr addr;

	/*
	 * Lifetime in seconds; all-ones means infinity, zero
	 * stop using it.
	 */
	uint32_t lifetime;

	/* If lifetime not set, use a default of 3*MaxRtrAdvInterval */
	int lifetime_set;
};

/*
 * [RFC1035 2.3.4] sets the maximum length of a domain name (a sequence of
 * labels, each prefixed by a length octet) at 255 octets.
 */
#define RTADV_MAX_ENCODED_DOMAIN_NAME 255

struct rtadv_dnssl {
	/* Domain name without trailing root zone dot (NUL-terminated) */
	char name[RTADV_MAX_ENCODED_DOMAIN_NAME - 1];

	/* Name encoded as in [RFC1035 3.1] */
	uint8_t encoded_name[RTADV_MAX_ENCODED_DOMAIN_NAME];

	/* Actual length of encoded_name */
	size_t encoded_len;

	/* Lifetime as for RDNSS */
	uint32_t lifetime;
	int lifetime_set;
};

#endif /* HAVE_RTADV */

/* Zebra interface type - ones of interest. */
enum zebra_iftype {
	ZEBRA_IF_OTHER = 0, /* Anything else */
	ZEBRA_IF_VXLAN,     /* VxLAN interface */
	ZEBRA_IF_VRF,       /* VRF device */
	ZEBRA_IF_BRIDGE,    /* bridge device */
	ZEBRA_IF_VLAN,      /* VLAN sub-interface */
	ZEBRA_IF_MACVLAN,   /* MAC VLAN interface*/
	ZEBRA_IF_VETH,      /* VETH interface*/
	ZEBRA_IF_BOND,	    /* Bond */
	ZEBRA_IF_BOND_SLAVE,	    /* Bond */
	ZEBRA_IF_GRE,      /* GRE interface */
};

/* Zebra "slave" interface type */
enum zebra_slave_iftype {
	ZEBRA_IF_SLAVE_NONE,   /* Not a slave */
	ZEBRA_IF_SLAVE_VRF,    /* Member of a VRF */
	ZEBRA_IF_SLAVE_BRIDGE, /* Member of a bridge */
	ZEBRA_IF_SLAVE_BOND,   /* Bond member */
	ZEBRA_IF_SLAVE_OTHER,  /* Something else - e.g., bond slave */
};

struct irdp_interface;

/* Ethernet segment info used for setting up EVPN multihoming */
struct zebra_evpn_es;
struct zebra_es_if_info {
	/* type-3 esi config */
	struct ethaddr sysmac;
	uint32_t lid; /* local-id; has to be unique per-ES-sysmac */

	esi_t esi;

	uint16_t df_pref;
	uint8_t flags;
#define ZIF_CFG_ES_FLAG_BYPASS (1 << 0)

	struct zebra_evpn_es *es; /* local ES */
};

enum zebra_if_flags {
	/* device has been configured as an uplink for
	 * EVPN multihoming
	 */
	ZIF_FLAG_EVPN_MH_UPLINK = (1 << 0),
	ZIF_FLAG_EVPN_MH_UPLINK_OPER_UP = (1 << 1),

	/* Dataplane protodown-on */
	ZIF_FLAG_PROTODOWN = (1 << 2),

	/* LACP bypass state is set by the dataplane on a bond member
	 * and inherited by the bond (if one or more bond members are in
	 * a bypass state the bond is placed in a bypass state)
	 */
	ZIF_FLAG_LACP_BYPASS = (1 << 3)
};

/* `zebra' daemon local interface structure. */
struct zebra_if {
	/* back pointer to the interface */
	struct interface *ifp;

	enum zebra_if_flags flags;

	/* Shutdown configuration. */
	uint8_t shutdown;

	/* Multicast configuration. */
	uint8_t multicast;

	/* Router advertise configuration. */
	uint8_t rtadv_enable;

	/* Installed addresses chains tree. */
	struct route_table *ipv4_subnets;

	/* Nexthops pointing to this interface */
	/**
	 * Any nexthop that we get should have an
	 * interface. When an interface goes down,
	 * we will use this list to update the nexthops
	 * pointing to it with that info.
	 */
	struct nhg_connected_tree_head nhg_dependents;

	/* Information about up/down changes */
	unsigned int up_count;
	char up_last[FRR_TIMESTAMP_LEN];
	unsigned int down_count;
	char down_last[FRR_TIMESTAMP_LEN];

#if defined(HAVE_RTADV)
	struct rtadvconf rtadv;
	unsigned int ra_sent, ra_rcvd;
#endif /* HAVE_RTADV */

	struct irdp_interface *irdp;

#ifdef HAVE_STRUCT_SOCKADDR_DL
	union {
		/* note that sdl_storage is never accessed, it only exists to
		 * make space.
		 * all actual uses refer to sdl - but use sizeof(sdl_storage)!
		 * this fits
		 * best with C aliasing rules. */
		struct sockaddr_dl sdl;
		struct sockaddr_storage sdl_storage;
	};
#endif

	/* ptm enable configuration */
	uint8_t ptm_enable;

	/* Zebra interface and "slave" interface type */
	enum zebra_iftype zif_type;
	enum zebra_slave_iftype zif_slave_type;

	/* Additional L2 info, depends on zif_type */
	union zebra_l2if_info l2info;

	/* For members of a bridge, link to bridge. */
	/* Note: If additional fields become necessary, this can be modified to
	 * be a pointer to a dynamically allocd struct.
	 */
	struct zebra_l2info_brslave brslave_info;

	struct zebra_l2info_bondslave bondslave_info;
	struct zebra_l2info_bond bond_info;

	/* ethernet segment */
	struct zebra_es_if_info es_info;

	/* bitmap of vlans associated with this interface */
	bitfield_t vlan_bitmap;

	/* An interface can be error-disabled if a protocol (such as EVPN or
	 * VRRP) detects a problem with keeping it operationally-up.
	 * If any of the protodown bits are set protodown-on is programmed
	 * in the dataplane. This results in a carrier/L1 down on the
	 * physical device.
	 */
	enum protodown_reasons protodown_rc;

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

	/* Link fields - for sub-interfaces. */
	ifindex_t link_ifindex;
	struct interface *link;

	struct thread *speed_update;

	/*
	 * Does this interface have a v6 to v4 ll neighbor entry
	 * for bgp unnumbered?
	 */
	bool v6_2_v4_ll_neigh_entry;
	char neigh_mac[6];
	struct in6_addr v6_2_v4_ll_addr6;

	/* The description of the interface */
	char *desc;
};

DECLARE_HOOK(zebra_if_extra_info, (struct vty * vty, struct interface *ifp),
	     (vty, ifp));
DECLARE_HOOK(zebra_if_config_wr, (struct vty * vty, struct interface *ifp),
	     (vty, ifp));

#define IS_ZEBRA_IF_VRF(ifp)                                                   \
	(((struct zebra_if *)(ifp->info))->zif_type == ZEBRA_IF_VRF)

#define IS_ZEBRA_IF_BRIDGE(ifp)                                                \
	(((struct zebra_if *)(ifp->info))->zif_type == ZEBRA_IF_BRIDGE)

#define IS_ZEBRA_IF_VLAN(ifp)                                                  \
	(((struct zebra_if *)(ifp->info))->zif_type == ZEBRA_IF_VLAN)

#define IS_ZEBRA_IF_VXLAN(ifp)                                                 \
	(((struct zebra_if *)(ifp->info))->zif_type == ZEBRA_IF_VXLAN)

#define IS_ZEBRA_IF_MACVLAN(ifp)                                               \
	(((struct zebra_if *)(ifp->info))->zif_type == ZEBRA_IF_MACVLAN)

#define IS_ZEBRA_IF_VETH(ifp)                                               \
	(((struct zebra_if *)(ifp->info))->zif_type == ZEBRA_IF_VETH)

#define IS_ZEBRA_IF_BOND(ifp)                                                  \
	(((struct zebra_if *)(ifp->info))->zif_type == ZEBRA_IF_BOND)

#define IS_ZEBRA_IF_GRE(ifp)                                               \
	(((struct zebra_if *)(ifp->info))->zif_type == ZEBRA_IF_GRE)

#define IS_ZEBRA_IF_BRIDGE_SLAVE(ifp)					\
	(((struct zebra_if *)(ifp->info))->zif_slave_type                      \
	 == ZEBRA_IF_SLAVE_BRIDGE)

#define IS_ZEBRA_IF_VRF_SLAVE(ifp)                                             \
	(((struct zebra_if *)(ifp->info))->zif_slave_type == ZEBRA_IF_SLAVE_VRF)

#define IS_ZEBRA_IF_BOND_SLAVE(ifp)					\
	(((struct zebra_if *)(ifp->info))->zif_slave_type                      \
	 == ZEBRA_IF_SLAVE_BOND)

extern void zebra_if_init(void);

extern struct interface *if_lookup_by_index_per_ns(struct zebra_ns *, uint32_t);
extern struct interface *if_lookup_by_name_per_ns(struct zebra_ns *,
						  const char *);
extern struct interface *if_link_per_ns(struct zebra_ns *, struct interface *);
extern const char *ifindex2ifname_per_ns(struct zebra_ns *, unsigned int);

extern void if_unlink_per_ns(struct interface *);
extern void if_nbr_mac_to_ipv4ll_neigh_update(struct interface *fip,
					      char mac[6],
					      struct in6_addr *address,
					      int add);
extern void if_nbr_ipv6ll_to_ipv4ll_neigh_update(struct interface *ifp,
						 struct in6_addr *address,
						 int add);
extern void if_nbr_ipv6ll_to_ipv4ll_neigh_del_all(struct interface *ifp);
extern void if_delete_update(struct interface *ifp);
extern void if_add_update(struct interface *ifp);
extern void if_up(struct interface *);
extern void if_down(struct interface *);
extern void if_refresh(struct interface *);
extern void if_flags_update(struct interface *, uint64_t);
extern int if_subnet_add(struct interface *, struct connected *);
extern int if_subnet_delete(struct interface *, struct connected *);
extern int ipv6_address_configured(struct interface *ifp);
extern void if_handle_vrf_change(struct interface *ifp, vrf_id_t vrf_id);
extern void zebra_if_update_link(struct interface *ifp, ifindex_t link_ifindex,
				 ns_id_t ns_id);
extern void zebra_if_update_all_links(struct zebra_ns *zns);
extern void zebra_if_set_protodown(struct interface *ifp, bool down);
extern int if_ip_address_install(struct interface *ifp, struct prefix *prefix,
				 const char *label, struct prefix *pp);
extern int if_ipv6_address_install(struct interface *ifp, struct prefix *prefix,
				   const char *label);
extern int if_ip_address_uinstall(struct interface *ifp, struct prefix *prefix);
extern int if_shutdown(struct interface *ifp);
extern int if_no_shutdown(struct interface *ifp);
extern int if_multicast_set(struct interface *ifp);
extern int if_multicast_unset(struct interface *ifp);
extern int if_linkdetect(struct interface *ifp, bool detect);
extern void if_addr_wakeup(struct interface *ifp);

/* Nexthop group connected functions */
extern void if_nhg_dependents_add(struct interface *ifp,
				  struct nhg_hash_entry *nhe);
extern void if_nhg_dependents_del(struct interface *ifp,
				  struct nhg_hash_entry *nhe);
extern unsigned int if_nhg_dependents_count(const struct interface *ifp);
extern bool if_nhg_dependents_is_empty(const struct interface *ifp);

extern void vrf_add_update(struct vrf *vrfp);
extern void zebra_l2_map_slave_to_bond(struct zebra_if *zif, vrf_id_t vrf);
extern void zebra_l2_unmap_slave_from_bond(struct zebra_if *zif);
extern const char *zebra_protodown_rc_str(enum protodown_reasons protodown_rc,
					  char *pd_buf, uint32_t pd_buf_len);
void zebra_if_addr_update_ctx(struct zebra_dplane_ctx *ctx);

#ifdef HAVE_PROC_NET_DEV
extern void ifstat_update_proc(void);
#endif /* HAVE_PROC_NET_DEV */
#ifdef HAVE_NET_RT_IFLIST
extern void ifstat_update_sysctl(void);

#endif /* HAVE_NET_RT_IFLIST */
#ifdef HAVE_PROC_NET_DEV
extern int interface_list_proc(void);
#endif /* HAVE_PROC_NET_DEV */
#ifdef HAVE_PROC_NET_IF_INET6
extern int ifaddr_proc_ipv6(void);
#endif /* HAVE_PROC_NET_IF_INET6 */

#ifdef __cplusplus
}
#endif

#endif /* _ZEBRA_INTERFACE_H */
Commit	Line	Data
b9368db9	1
718e3744	2	/* Interface function header.
	3	* Copyright (C) 1999 Kunihiro Ishiguro
	4	*
	5	* This file is part of GNU Zebra.
	6	*
	7	* GNU Zebra is free software; you can redistribute it and/or modify it
	8	* under the terms of the GNU General Public License as published by the
	9	* Free Software Foundation; either version 2, or (at your option) any
	10	* later version.
	11	*
	12	* GNU Zebra is distributed in the hope that it will be useful, but
	13	* WITHOUT ANY WARRANTY; without even the implied warranty of
	14	* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
	15	* General Public License for more details.
	16	*
896014f4 DL	17	* You should have received a copy of the GNU General Public License along
	18	* with this program; see the file COPYING; if not, write to the Free Software
	19	* Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
718e3744	20	*/
718e3744	21
5b73a671	22	#ifndef _ZEBRA_INTERFACE_H
	23	#define _ZEBRA_INTERFACE_H
	24
	25	#include "redistribute.h"
12f6fb97	26	#include "vrf.h"
2eb27eec	27	#include "hook.h"
ce5160c0	28	#include "bitfield.h"
ca776988	29
6675513d	30	#include "zebra/zebra_l2.h"
5948f013	31	#include "zebra/zebra_nhg_private.h"
c36e442c	32	#include "zebra/zebra_router.h"
6675513d	33
51e94aa7 EDP	34	#ifdef __cplusplus
	35	extern "C" {
	36	#endif
	37
718e3744	38	/* For interface multicast configuration. */
	39	#define IF_ZEBRA_MULTICAST_UNSPEC 0
	40	#define IF_ZEBRA_MULTICAST_ON 1
	41	#define IF_ZEBRA_MULTICAST_OFF 2
	42
	43	/* For interface shutdown configuration. */
bfac8dcd	44	#define IF_ZEBRA_SHUTDOWN_OFF 0
718e3744	45	#define IF_ZEBRA_SHUTDOWN_ON 1
718e3744	46
ce5160c0 AK	47	#define IF_VLAN_BITMAP_MAX 4096
ce5160c0 AK	48
d62a17ae	49	#if defined(HAVE_RTADV)
6eb0c5ab	50	/* Router advertisement parameter. From RFC4861, RFC6275 and RFC4191. */
d62a17ae	51	struct rtadvconf {
	52	/* A flag indicating whether or not the router sends periodic Router
	53	Advertisements and responds to Router Solicitations.
2951a7a4	54	Default: false */
d62a17ae	55	int AdvSendAdvertisements;
	56
	57	/* The maximum time allowed between sending unsolicited multicast
	58	Router Advertisements from the interface, in milliseconds.
	59	MUST be no less than 70 ms [RFC6275 7.5] and no greater
	60	than 1800000 ms [RFC4861 6.2.1].
	61
	62	Default: 600000 milliseconds */
	63	int MaxRtrAdvInterval;
7cee1bb1	64	#define RTADV_MAX_RTR_ADV_INTERVAL 600000
718e3744	65
d62a17ae	66	/* The minimum time allowed between sending unsolicited multicast
	67	Router Advertisements from the interface, in milliseconds.
	68	MUST be no less than 30 ms [RFC6275 7.5].
	69	MUST be no greater than .75 * MaxRtrAdvInterval.
718e3744	70
d62a17ae	71	Default: 0.33 * MaxRtrAdvInterval */
d62a17ae	72	int MinRtrAdvInterval; /* This field is currently unused. */
718e3744	73	#define RTADV_MIN_RTR_ADV_INTERVAL (0.33 * RTADV_MAX_RTR_ADV_INTERVAL)
718e3744	74
d62a17ae	75	/* Unsolicited Router Advertisements' interval timer. */
d62a17ae	76	int AdvIntervalTimer;
718e3744	77
2951a7a4	78	/* The true/false value to be placed in the "Managed address
d62a17ae	79	configuration" flag field in the Router Advertisement. See
d62a17ae	80	[ADDRCONF].
718e3744	81
2951a7a4	82	Default: false */
d62a17ae	83	int AdvManagedFlag;
637f95bf	84	struct timeval lastadvmanagedflag;
718e3744	85
718e3744	86
2951a7a4	87	/* The true/false value to be placed in the "Other stateful
d62a17ae	88	configuration" flag field in the Router Advertisement. See
d62a17ae	89	[ADDRCONF].
718e3744	90
2951a7a4	91	Default: false */
d62a17ae	92	int AdvOtherConfigFlag;
637f95bf	93	struct timeval lastadvotherconfigflag;
718e3744	94
d62a17ae	95	/* The value to be placed in MTU options sent by the router. A
d62a17ae	96	value of zero indicates that no MTU options are sent.
718e3744	97
d62a17ae	98	Default: 0 */
d62a17ae	99	int AdvLinkMTU;
718e3744	100
718e3744	101
d62a17ae	102	/* The value to be placed in the Reachable Time field in the Router
	103	Advertisement messages sent by the router. The value zero means
	104	unspecified (by this router). MUST be no greater than 3,600,000
	105	milliseconds (1 hour).
718e3744	106
d62a17ae	107	Default: 0 */
d7c0a89a	108	uint32_t AdvReachableTime;
d62a17ae	109	#define RTADV_MAX_REACHABLE_TIME 3600000
637f95bf	110	struct timeval lastadvreachabletime;
718e3744	111
d62a17ae	112	/* The value to be placed in the Retrans Timer field in the Router
	113	Advertisement messages sent by the router. The value zero means
	114	unspecified (by this router).
718e3744	115
d62a17ae	116	Default: 0 */
d62a17ae	117	int AdvRetransTimer;
637f95bf	118	struct timeval lastadvretranstimer;
718e3744	119
d62a17ae	120	/* The default value to be placed in the Cur Hop Limit field in the
	121	Router Advertisement messages sent by the router. The value
	122	should be set to that current diameter of the Internet. The
	123	value zero means unspecified (by this router).
718e3744	124
d62a17ae	125	Default: The value specified in the "Assigned Numbers" RFC
	126	[ASSIGNED] that was in effect at the time of implementation. */
	127	int AdvCurHopLimit;
637f95bf DS	128	struct timeval lastadvcurhoplimit;
637f95bf DS	129
fae01935	130	#define RTADV_DEFAULT_HOPLIMIT 64 /* 64 hops */
718e3744	131
d62a17ae	132	/* The value to be placed in the Router Lifetime field of Router
	133	Advertisements sent from the interface, in seconds. MUST be
	134	either zero or between MaxRtrAdvInterval and 9000 seconds. A
	135	value of zero indicates that the router is not to be used as a
	136	default router.
718e3744	137
d62a17ae	138	Default: 3 * MaxRtrAdvInterval */
d62a17ae	139	int AdvDefaultLifetime;
d660f698	140	#define RTADV_MAX_RTRLIFETIME 9000 /* 2.5 hours */
718e3744	141
d62a17ae	142	/* A list of prefixes to be placed in Prefix Information options in
d62a17ae	143	Router Advertisement messages sent from the interface.
718e3744	144
d62a17ae	145	Default: all prefixes that the router advertises via routing
	146	protocols as being on-link for the interface from which the
	147	advertisement is sent. The link-local prefix SHOULD NOT be
	148	included in the list of advertised prefixes. */
	149	struct list *AdvPrefixList;
7cee1bb1	150
2951a7a4	151	/* The true/false value to be placed in the "Home agent"
d62a17ae	152	flag field in the Router Advertisement. See [RFC6275 7.1].
7cee1bb1	153
2951a7a4	154	Default: false */
d62a17ae	155	int AdvHomeAgentFlag;
7cee1bb1	156	#ifndef ND_RA_FLAG_HOME_AGENT
	157	#define ND_RA_FLAG_HOME_AGENT 0x20
	158	#endif
	159
d62a17ae	160	/* The value to be placed in Home Agent Information option if Home
	161	Flag is set.
	162	Default: 0 */
	163	int HomeAgentPreference;
	164
	165	/* The value to be placed in Home Agent Information option if Home
	166	Flag is set. Lifetime (seconds) MUST not be greater than 18.2
	167	hours.
	168	The value 0 has special meaning: use of AdvDefaultLifetime value.
	169
	170	Default: 0 */
	171	int HomeAgentLifetime;
7cee1bb1	172	#define RTADV_MAX_HALIFETIME 65520 /* 18.2 hours */
7cee1bb1	173
2951a7a4	174	/* The true/false value to insert or not an Advertisement Interval
d62a17ae	175	option. See [RFC 6275 7.3]
7cee1bb1	176
2951a7a4	177	Default: false */
d62a17ae	178	int AdvIntervalOption;
b60668d0	179
d62a17ae	180	/* The value to be placed in the Default Router Preference field of
d62a17ae	181	a router advertisement. See [RFC 4191 2.1 & 2.2]
b60668d0	182
d62a17ae	183	Default: 0 (medium) */
d62a17ae	184	int DefaultPreference;
b60668d0	185	#define RTADV_PREF_MEDIUM 0x0 /* Per RFC4191. */
6c9678b4	186
3eb4fbb0 LS	187	/*
	188	* List of recursive DNS servers to include in the RDNSS option.
	189	* See [RFC8106 5.1]
	190	*
	191	* Default: empty list; do not emit RDNSS option
	192	*/
	193	struct list *AdvRDNSSList;
	194
	195	/*
	196	* List of DNS search domains to include in the DNSSL option.
	197	* See [RFC8106 5.2]
	198	*
	199	* Default: empty list; do not emit DNSSL option
	200	*/
	201	struct list *AdvDNSSLList;
	202
adee8f21 DS	203	/*
	204	* rfc4861 states RAs must be sent at least 3 seconds apart.
	205	* We allow faster retransmits to speed up convergence but can
	206	* turn that capability off to meet the rfc if needed.
	207	*/
	208	bool UseFastRexmit; /* True if fast rexmits are enabled */
	209
d7c0a89a	210	uint8_t inFastRexmit; /* True if we're rexmits faster than usual */
3ea48364 DS	211
3ea48364 DS	212	/* Track if RA was configured by BGP or by the Operator or both */
d7c0a89a	213	uint8_t ra_configured; /* Was RA configured? */
3ea48364 DS	214	#define BGP_RA_CONFIGURED (1<<0) /* BGP configured RA? */
	215	#define VTY_RA_CONFIGURED (1<<1) /* Operator configured RA? */
	216	#define VTY_RA_INTERVAL_CONFIGURED (1<<2) /* Operator configured RA interval */
996c9314 LB	217	int NumFastReXmitsRemain; /* Loaded first with number of fast
996c9314 LB	218	rexmits to do */
6c9678b4 DD	219
	220	#define RTADV_FAST_REXMIT_PERIOD 1 /* 1 sec */
	221	#define RTADV_NUM_FAST_REXMITS 4 /* Fast Rexmit RA 4 times on certain events */
718e3744	222	};
718e3744	223
3eb4fbb0 LS	224	struct rtadv_rdnss {
	225	/* Address of recursive DNS server to advertise */
	226	struct in6_addr addr;
	227
	228	/*
	229	* Lifetime in seconds; all-ones means infinity, zero
	230	* stop using it.
	231	*/
	232	uint32_t lifetime;
	233
	234	/* If lifetime not set, use a default of 3MaxRtrAdvInterval /
	235	int lifetime_set;
	236	};
	237
	238	/*
	239	* [RFC1035 2.3.4] sets the maximum length of a domain name (a sequence of
	240	* labels, each prefixed by a length octet) at 255 octets.
	241	*/
	242	#define RTADV_MAX_ENCODED_DOMAIN_NAME 255
	243
	244	struct rtadv_dnssl {
	245	/* Domain name without trailing root zone dot (NUL-terminated) */
	246	char name[RTADV_MAX_ENCODED_DOMAIN_NAME - 1];
	247
	248	/* Name encoded as in [RFC1035 3.1] */
	249	uint8_t encoded_name[RTADV_MAX_ENCODED_DOMAIN_NAME];
	250
	251	/* Actual length of encoded_name */
	252	size_t encoded_len;
	253
	254	/* Lifetime as for RDNSS */
	255	uint32_t lifetime;
	256	int lifetime_set;
	257	};
	258
8da4e946	259	#endif /* HAVE_RTADV */
718e3744	260
6675513d	261	/* Zebra interface type - ones of interest. */
e6f2bec0	262	enum zebra_iftype {
7a38782a DL	263	ZEBRA_IF_OTHER = 0, /* Anything else */
	264	ZEBRA_IF_VXLAN, /* VxLAN interface */
	265	ZEBRA_IF_VRF, /* VRF device */
	266	ZEBRA_IF_BRIDGE, /* bridge device */
	267	ZEBRA_IF_VLAN, /* VLAN sub-interface */
	268	ZEBRA_IF_MACVLAN, /* MAC VLAN interface*/
0e4864ea	269	ZEBRA_IF_VETH, /* VETH interface*/
b9368db9 DD	270	ZEBRA_IF_BOND, /* Bond */
b9368db9 DD	271	ZEBRA_IF_BOND_SLAVE, /* Bond */
077c07cc	272	ZEBRA_IF_GRE, /* GRE interface */
e6f2bec0	273	};
6675513d	274
6675513d	275	/* Zebra "slave" interface type */
a81982fa	276	enum zebra_slave_iftype {
d62a17ae	277	ZEBRA_IF_SLAVE_NONE, /* Not a slave */
	278	ZEBRA_IF_SLAVE_VRF, /* Member of a VRF */
	279	ZEBRA_IF_SLAVE_BRIDGE, /* Member of a bridge */
b9368db9	280	ZEBRA_IF_SLAVE_BOND, /* Bond member */
d62a17ae	281	ZEBRA_IF_SLAVE_OTHER, /* Something else - e.g., bond slave */
a81982fa	282	};
6675513d	283
2eb27eec DL	284	struct irdp_interface;
2eb27eec DL	285
ce5160c0 AK	286	/* Ethernet segment info used for setting up EVPN multihoming */
	287	struct zebra_evpn_es;
	288	struct zebra_es_if_info {
325d694b	289	/* type-3 esi config */
ce5160c0 AK	290	struct ethaddr sysmac;
ce5160c0 AK	291	uint32_t lid; /* local-id; has to be unique per-ES-sysmac */
325d694b AK	292
	293	esi_t esi;
	294
1103c5c6	295	uint16_t df_pref;
00a7710c AK	296	uint8_t flags;
	297	#define ZIF_CFG_ES_FLAG_BYPASS (1 << 0)
	298
ce5160c0 AK	299	struct zebra_evpn_es es; / local ES */
	300	};
	301
c36e442c AK	302	enum zebra_if_flags {
	303	/* device has been configured as an uplink for
	304	* EVPN multihoming
	305	*/
	306	ZIF_FLAG_EVPN_MH_UPLINK = (1 << 0),
	307	ZIF_FLAG_EVPN_MH_UPLINK_OPER_UP = (1 << 1),
	308
	309	/* Dataplane protodown-on */
00a7710c AK	310	ZIF_FLAG_PROTODOWN = (1 << 2),
	311
	312	/* LACP bypass state is set by the dataplane on a bond member
	313	* and inherited by the bond (if one or more bond members are in
	314	* a bypass state the bond is placed in a bypass state)
	315	*/
	316	ZIF_FLAG_LACP_BYPASS = (1 << 3)
c36e442c AK	317	};
c36e442c AK	318
718e3744	319	/* `zebra' daemon local interface structure. */
d62a17ae	320	struct zebra_if {
ce5160c0 AK	321	/* back pointer to the interface */
	322	struct interface *ifp;
	323
c36e442c AK	324	enum zebra_if_flags flags;
c36e442c AK	325
d62a17ae	326	/* Shutdown configuration. */
d7c0a89a	327	uint8_t shutdown;
718e3744	328
d62a17ae	329	/* Multicast configuration. */
d7c0a89a	330	uint8_t multicast;
718e3744	331
d62a17ae	332	/* Router advertise configuration. */
d7c0a89a	333	uint8_t rtadv_enable;
718e3744	334
d62a17ae	335	/* Installed addresses chains tree. */
d62a17ae	336	struct route_table *ipv4_subnets;
eef1fe11	337
fe593b78	338	/* Nexthops pointing to this interface */
602fea61 SW	339	/**
	340	* Any nexthop that we get should have an
	341	* interface. When an interface goes down,
	342	* we will use this list to update the nexthops
	343	* pointing to it with that info.
	344	*/
37c6708b	345	struct nhg_connected_tree_head nhg_dependents;
602fea61	346
d62a17ae	347	/* Information about up/down changes */
d62a17ae	348	unsigned int up_count;
e36f61b5	349	char up_last[FRR_TIMESTAMP_LEN];
d62a17ae	350	unsigned int down_count;
e36f61b5	351	char down_last[FRR_TIMESTAMP_LEN];
55ce4d3a	352
8da4e946	353	#if defined(HAVE_RTADV)
d62a17ae	354	struct rtadvconf rtadv;
d62a17ae	355	unsigned int ra_sent, ra_rcvd;
8da4e946	356	#endif /* HAVE_RTADV */
ca776988	357
2eb27eec	358	struct irdp_interface *irdp;
ca776988	359
8ccc7e80	360	#ifdef HAVE_STRUCT_SOCKADDR_DL
d62a17ae	361	union {
	362	/* note that sdl_storage is never accessed, it only exists to
	363	* make space.
	364	* all actual uses refer to sdl - but use sizeof(sdl_storage)!
	365	* this fits
	366	* best with C aliasing rules. */
	367	struct sockaddr_dl sdl;
	368	struct sockaddr_storage sdl_storage;
	369	};
8ccc7e80 TT	370	#endif
8ccc7e80 TT	371
d62a17ae	372	/* ptm enable configuration */
d7c0a89a	373	uint8_t ptm_enable;
6675513d	374
d62a17ae	375	/* Zebra interface and "slave" interface type */
e6f2bec0	376	enum zebra_iftype zif_type;
a81982fa	377	enum zebra_slave_iftype zif_slave_type;
6675513d	378
d62a17ae	379	/* Additional L2 info, depends on zif_type */
d62a17ae	380	union zebra_l2if_info l2info;
6675513d	381
d62a17ae	382	/* For members of a bridge, link to bridge. */
	383	/* Note: If additional fields become necessary, this can be modified to
	384	* be a pointer to a dynamically allocd struct.
	385	*/
	386	struct zebra_l2info_brslave brslave_info;
6675513d	387
b9368db9	388	struct zebra_l2info_bondslave bondslave_info;
c36e442c	389	struct zebra_l2info_bond bond_info;
b9368db9	390
ce5160c0 AK	391	/* ethernet segment */
	392	struct zebra_es_if_info es_info;
	393
	394	/* bitmap of vlans associated with this interface */
	395	bitfield_t vlan_bitmap;
	396
c36e442c AK	397	/* An interface can be error-disabled if a protocol (such as EVPN or
	398	* VRRP) detects a problem with keeping it operationally-up.
	399	* If any of the protodown bits are set protodown-on is programmed
	400	* in the dataplane. This results in a carrier/L1 down on the
	401	* physical device.
	402	*/
	403	enum protodown_reasons protodown_rc;
	404
8b07f173 AK	405	/* list of zebra_mac entries using this interface as destination */
	406	struct list *mac_list;
	407
d62a17ae	408	/* Link fields - for sub-interfaces. */
	409	ifindex_t link_ifindex;
	410	struct interface *link;
dc7b3cae DS	411
dc7b3cae DS	412	struct thread *speed_update;
20089ae2 DS	413
	414	/*
	415	* Does this interface have a v6 to v4 ll neighbor entry
	416	* for bgp unnumbered?
	417	*/
	418	bool v6_2_v4_ll_neigh_entry;
ee98d1f1	419	char neigh_mac[6];
20089ae2	420	struct in6_addr v6_2_v4_ll_addr6;
ba5165ec DS	421
	422	/* The description of the interface */
	423	char *desc;
718e3744	424	};
718e3744	425
996c9314	426	DECLARE_HOOK(zebra_if_extra_info, (struct vty * vty, struct interface *ifp),
8451921b	427	(vty, ifp));
996c9314	428	DECLARE_HOOK(zebra_if_config_wr, (struct vty * vty, struct interface *ifp),
8451921b	429	(vty, ifp));
2eb27eec	430
d62a17ae	431	#define IS_ZEBRA_IF_VRF(ifp) \
	432	(((struct zebra_if *)(ifp->info))->zif_type == ZEBRA_IF_VRF)
	433
	434	#define IS_ZEBRA_IF_BRIDGE(ifp) \
	435	(((struct zebra_if *)(ifp->info))->zif_type == ZEBRA_IF_BRIDGE)
	436
	437	#define IS_ZEBRA_IF_VLAN(ifp) \
	438	(((struct zebra_if *)(ifp->info))->zif_type == ZEBRA_IF_VLAN)
	439
	440	#define IS_ZEBRA_IF_VXLAN(ifp) \
	441	(((struct zebra_if *)(ifp->info))->zif_type == ZEBRA_IF_VXLAN)
	442
1a98c087 MK	443	#define IS_ZEBRA_IF_MACVLAN(ifp) \
	444	(((struct zebra_if *)(ifp->info))->zif_type == ZEBRA_IF_MACVLAN)
	445
0e4864ea PG	446	#define IS_ZEBRA_IF_VETH(ifp) \
	447	(((struct zebra_if *)(ifp->info))->zif_type == ZEBRA_IF_VETH)
	448
c36e442c AK	449	#define IS_ZEBRA_IF_BOND(ifp) \
	450	(((struct zebra_if *)(ifp->info))->zif_type == ZEBRA_IF_BOND)
	451
077c07cc PG	452	#define IS_ZEBRA_IF_GRE(ifp) \
	453	(((struct zebra_if *)(ifp->info))->zif_type == ZEBRA_IF_GRE)
	454
0e4864ea	455	#define IS_ZEBRA_IF_BRIDGE_SLAVE(ifp) \
d62a17ae	456	(((struct zebra_if *)(ifp->info))->zif_slave_type \
	457	== ZEBRA_IF_SLAVE_BRIDGE)
	458
	459	#define IS_ZEBRA_IF_VRF_SLAVE(ifp) \
	460	(((struct zebra_if *)(ifp->info))->zif_slave_type == ZEBRA_IF_SLAVE_VRF)
	461
b9368db9 DD	462	#define IS_ZEBRA_IF_BOND_SLAVE(ifp) \
	463	(((struct zebra_if *)(ifp->info))->zif_slave_type \
	464	== ZEBRA_IF_SLAVE_BOND)
	465
05f7f5db DS	466	extern void zebra_if_init(void);
05f7f5db DS	467
d7c0a89a	468	extern struct interface if_lookup_by_index_per_ns(struct zebra_ns , uint32_t);
d62a17ae	469	extern struct interface if_lookup_by_name_per_ns(struct zebra_ns ,
	470	const char *);
	471	extern struct interface if_link_per_ns(struct zebra_ns , struct interface *);
	472	extern const char ifindex2ifname_per_ns(struct zebra_ns , unsigned int);
	473
	474	extern void if_unlink_per_ns(struct interface *);
ee98d1f1 DS	475	extern void if_nbr_mac_to_ipv4ll_neigh_update(struct interface *fip,
	476	char mac[6],
	477	struct in6_addr *address,
	478	int add);
d62a17ae	479	extern void if_nbr_ipv6ll_to_ipv4ll_neigh_update(struct interface *ifp,
	480	struct in6_addr *address,
	481	int add);
	482	extern void if_nbr_ipv6ll_to_ipv4ll_neigh_del_all(struct interface *ifp);
	483	extern void if_delete_update(struct interface *ifp);
	484	extern void if_add_update(struct interface *ifp);
	485	extern void if_up(struct interface *);
	486	extern void if_down(struct interface *);
	487	extern void if_refresh(struct interface *);
	488	extern void if_flags_update(struct interface *, uint64_t);
	489	extern int if_subnet_add(struct interface , struct connected );
	490	extern int if_subnet_delete(struct interface , struct connected );
	491	extern int ipv6_address_configured(struct interface *ifp);
	492	extern void if_handle_vrf_change(struct interface *ifp, vrf_id_t vrf_id);
680c278f PG	493	extern void zebra_if_update_link(struct interface *ifp, ifindex_t link_ifindex,
680c278f PG	494	ns_id_t ns_id);
357b150d	495	extern void zebra_if_update_all_links(struct zebra_ns *zns);
c3bd894e	496	extern void zebra_if_set_protodown(struct interface *ifp, bool down);
09268680 CS	497	extern int if_ip_address_install(struct interface ifp, struct prefix prefix,
	498	const char label, struct prefix pp);
	499	extern int if_ipv6_address_install(struct interface ifp, struct prefix prefix,
	500	const char *label);
	501	extern int if_ip_address_uinstall(struct interface ifp, struct prefix prefix);
	502	extern int if_shutdown(struct interface *ifp);
	503	extern int if_no_shutdown(struct interface *ifp);
	504	extern int if_multicast_set(struct interface *ifp);
	505	extern int if_multicast_unset(struct interface *ifp);
	506	extern int if_linkdetect(struct interface *ifp, bool detect);
	507	extern void if_addr_wakeup(struct interface *ifp);
d62a17ae	508
fe593b78 SW	509	/* Nexthop group connected functions */
	510	extern void if_nhg_dependents_add(struct interface *ifp,
	511	struct nhg_hash_entry *nhe);
	512	extern void if_nhg_dependents_del(struct interface *ifp,
	513	struct nhg_hash_entry *nhe);
	514	extern unsigned int if_nhg_dependents_count(const struct interface *ifp);
	515	extern bool if_nhg_dependents_is_empty(const struct interface *ifp);
602fea61	516
d62a17ae	517	extern void vrf_add_update(struct vrf *vrfp);
c36e442c AK	518	extern void zebra_l2_map_slave_to_bond(struct zebra_if *zif, vrf_id_t vrf);
c36e442c AK	519	extern void zebra_l2_unmap_slave_from_bond(struct zebra_if *zif);
904e9b05 MS	520	extern const char *zebra_protodown_rc_str(enum protodown_reasons protodown_rc,
904e9b05 MS	521	char *pd_buf, uint32_t pd_buf_len);
d166308b	522	void zebra_if_addr_update_ctx(struct zebra_dplane_ctx *ctx);
12f6fb97	523
718e3744	524	#ifdef HAVE_PROC_NET_DEV
d62a17ae	525	extern void ifstat_update_proc(void);
718e3744	526	#endif /* HAVE_PROC_NET_DEV */
718e3744	527	#ifdef HAVE_NET_RT_IFLIST
d62a17ae	528	extern void ifstat_update_sysctl(void);
718e3744	529
	530	#endif /* HAVE_NET_RT_IFLIST */
	531	#ifdef HAVE_PROC_NET_DEV
d62a17ae	532	extern int interface_list_proc(void);
718e3744	533	#endif /* HAVE_PROC_NET_DEV */
718e3744	534	#ifdef HAVE_PROC_NET_IF_INET6
d62a17ae	535	extern int ifaddr_proc_ipv6(void);
718e3744	536	#endif /* HAVE_PROC_NET_IF_INET6 */
718e3744	537
51e94aa7 EDP	538	#ifdef __cplusplus
	539	}
	540	#endif
	541
5b73a671	542	#endif /* _ZEBRA_INTERFACE_H */