[mirror_ubuntu-hirsute-kernel.git] / include / net / vxlan.h

/* SPDX-License-Identifier: GPL-2.0 */
#ifndef __NET_VXLAN_H
#define __NET_VXLAN_H 1

#include <linux/if_vlan.h>
#include <net/udp_tunnel.h>
#include <net/dst_metadata.h>
#include <net/rtnetlink.h>
#include <net/switchdev.h>

#define IANA_VXLAN_UDP_PORT     4789

/* VXLAN protocol (RFC 7348) header:
 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
 * |R|R|R|R|I|R|R|R|               Reserved                        |
 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
 * |                VXLAN Network Identifier (VNI) |   Reserved    |
 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
 *
 * I = VXLAN Network Identifier (VNI) present.
 */
struct vxlanhdr {
	__be32 vx_flags;
	__be32 vx_vni;
};

/* VXLAN header flags. */
#define VXLAN_HF_VNI	cpu_to_be32(BIT(27))

#define VXLAN_N_VID     (1u << 24)
#define VXLAN_VID_MASK  (VXLAN_N_VID - 1)
#define VXLAN_VNI_MASK	cpu_to_be32(VXLAN_VID_MASK << 8)
#define VXLAN_HLEN (sizeof(struct udphdr) + sizeof(struct vxlanhdr))

#define VNI_HASH_BITS	10
#define VNI_HASH_SIZE	(1<<VNI_HASH_BITS)
#define FDB_HASH_BITS	8
#define FDB_HASH_SIZE	(1<<FDB_HASH_BITS)

/* Remote checksum offload for VXLAN (VXLAN_F_REMCSUM_[RT]X):
 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
 * |R|R|R|R|I|R|R|R|R|R|C|              Reserved                   |
 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
 * |           VXLAN Network Identifier (VNI)      |O| Csum start  |
 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
 *
 * C = Remote checksum offload bit. When set indicates that the
 *     remote checksum offload data is present.
 *
 * O = Offset bit. Indicates the checksum offset relative to
 *     checksum start.
 *
 * Csum start = Checksum start divided by two.
 *
 * http://tools.ietf.org/html/draft-herbert-vxlan-rco
 */

/* VXLAN-RCO header flags. */
#define VXLAN_HF_RCO	cpu_to_be32(BIT(21))

/* Remote checksum offload header option */
#define VXLAN_RCO_MASK	cpu_to_be32(0x7f)  /* Last byte of vni field */
#define VXLAN_RCO_UDP	cpu_to_be32(0x80)  /* Indicate UDP RCO (TCP when not set *) */
#define VXLAN_RCO_SHIFT	1		   /* Left shift of start */
#define VXLAN_RCO_SHIFT_MASK ((1 << VXLAN_RCO_SHIFT) - 1)
#define VXLAN_MAX_REMCSUM_START (0x7f << VXLAN_RCO_SHIFT)

/*
 * VXLAN Group Based Policy Extension (VXLAN_F_GBP):
 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
 * |G|R|R|R|I|R|R|R|R|D|R|R|A|R|R|R|        Group Policy ID        |
 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
 * |                VXLAN Network Identifier (VNI) |   Reserved    |
 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
 *
 * G = Group Policy ID present.
 *
 * D = Don't Learn bit. When set, this bit indicates that the egress
 *     VTEP MUST NOT learn the source address of the encapsulated frame.
 *
 * A = Indicates that the group policy has already been applied to
 *     this packet. Policies MUST NOT be applied by devices when the
 *     A bit is set.
 *
 * https://tools.ietf.org/html/draft-smith-vxlan-group-policy
 */
struct vxlanhdr_gbp {
	u8	vx_flags;
#ifdef __LITTLE_ENDIAN_BITFIELD
	u8	reserved_flags1:3,
		policy_applied:1,
		reserved_flags2:2,
		dont_learn:1,
		reserved_flags3:1;
#elif defined(__BIG_ENDIAN_BITFIELD)
	u8	reserved_flags1:1,
		dont_learn:1,
		reserved_flags2:2,
		policy_applied:1,
		reserved_flags3:3;
#else
#error	"Please fix <asm/byteorder.h>"
#endif
	__be16	policy_id;
	__be32	vx_vni;
};

/* VXLAN-GBP header flags. */
#define VXLAN_HF_GBP	cpu_to_be32(BIT(31))

#define VXLAN_GBP_USED_BITS (VXLAN_HF_GBP | cpu_to_be32(0xFFFFFF))

/* skb->mark mapping
 *
 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
 * |R|R|R|R|R|R|R|R|R|D|R|R|A|R|R|R|        Group Policy ID        |
 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
 */
#define VXLAN_GBP_DONT_LEARN		(BIT(6) << 16)
#define VXLAN_GBP_POLICY_APPLIED	(BIT(3) << 16)
#define VXLAN_GBP_ID_MASK		(0xFFFF)

/*
 * VXLAN Generic Protocol Extension (VXLAN_F_GPE):
 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
 * |R|R|Ver|I|P|R|O|       Reserved                |Next Protocol  |
 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
 * |                VXLAN Network Identifier (VNI) |   Reserved    |
 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
 *
 * Ver = Version. Indicates VXLAN GPE protocol version.
 *
 * P = Next Protocol Bit. The P bit is set to indicate that the
 *     Next Protocol field is present.
 *
 * O = OAM Flag Bit. The O bit is set to indicate that the packet
 *     is an OAM packet.
 *
 * Next Protocol = This 8 bit field indicates the protocol header
 * immediately following the VXLAN GPE header.
 *
 * https://tools.ietf.org/html/draft-ietf-nvo3-vxlan-gpe-01
 */

struct vxlanhdr_gpe {
#if defined(__LITTLE_ENDIAN_BITFIELD)
	u8	oam_flag:1,
		reserved_flags1:1,
		np_applied:1,
		instance_applied:1,
		version:2,
		reserved_flags2:2;
#elif defined(__BIG_ENDIAN_BITFIELD)
	u8	reserved_flags2:2,
		version:2,
		instance_applied:1,
		np_applied:1,
		reserved_flags1:1,
		oam_flag:1;
#endif
	u8	reserved_flags3;
	u8	reserved_flags4;
	u8	next_protocol;
	__be32	vx_vni;
};

/* VXLAN-GPE header flags. */
#define VXLAN_HF_VER	cpu_to_be32(BIT(29) | BIT(28))
#define VXLAN_HF_NP	cpu_to_be32(BIT(26))
#define VXLAN_HF_OAM	cpu_to_be32(BIT(24))

#define VXLAN_GPE_USED_BITS (VXLAN_HF_VER | VXLAN_HF_NP | VXLAN_HF_OAM | \
			     cpu_to_be32(0xff))

struct vxlan_metadata {
	u32		gbp;
};

/* per UDP socket information */
struct vxlan_sock {
	struct hlist_node hlist;
	struct socket	 *sock;
	struct hlist_head vni_list[VNI_HASH_SIZE];
	refcount_t	  refcnt;
	u32		  flags;
};

union vxlan_addr {
	struct sockaddr_in sin;
	struct sockaddr_in6 sin6;
	struct sockaddr sa;
};

struct vxlan_rdst {
	union vxlan_addr	 remote_ip;
	__be16			 remote_port;
	u8			 offloaded:1;
	__be32			 remote_vni;
	u32			 remote_ifindex;
	struct net_device	 *remote_dev;
	struct list_head	 list;
	struct rcu_head		 rcu;
	struct dst_cache	 dst_cache;
};

struct vxlan_config {
	union vxlan_addr	remote_ip;
	union vxlan_addr	saddr;
	__be32			vni;
	int			remote_ifindex;
	int			mtu;
	__be16			dst_port;
	u16			port_min;
	u16			port_max;
	u8			tos;
	u8			ttl;
	__be32			label;
	u32			flags;
	unsigned long		age_interval;
	unsigned int		addrmax;
	bool			no_share;
	enum ifla_vxlan_df	df;
};

struct vxlan_dev_node {
	struct hlist_node hlist;
	struct vxlan_dev *vxlan;
};

/* Pseudo network device */
struct vxlan_dev {
	struct vxlan_dev_node hlist4;	/* vni hash table for IPv4 socket */
#if IS_ENABLED(CONFIG_IPV6)
	struct vxlan_dev_node hlist6;	/* vni hash table for IPv6 socket */
#endif
	struct list_head  next;		/* vxlan's per namespace list */
	struct vxlan_sock __rcu *vn4_sock;	/* listening socket for IPv4 */
#if IS_ENABLED(CONFIG_IPV6)
	struct vxlan_sock __rcu *vn6_sock;	/* listening socket for IPv6 */
#endif
	struct net_device *dev;
	struct net	  *net;		/* netns for packet i/o */
	struct vxlan_rdst default_dst;	/* default destination */

	struct timer_list age_timer;
	spinlock_t	  hash_lock[FDB_HASH_SIZE];
	unsigned int	  addrcnt;
	struct gro_cells  gro_cells;

	struct vxlan_config	cfg;

	struct hlist_head fdb_head[FDB_HASH_SIZE];
};

#define VXLAN_F_LEARN			0x01
#define VXLAN_F_PROXY			0x02
#define VXLAN_F_RSC			0x04
#define VXLAN_F_L2MISS			0x08
#define VXLAN_F_L3MISS			0x10
#define VXLAN_F_IPV6			0x20
#define VXLAN_F_UDP_ZERO_CSUM_TX	0x40
#define VXLAN_F_UDP_ZERO_CSUM6_TX	0x80
#define VXLAN_F_UDP_ZERO_CSUM6_RX	0x100
#define VXLAN_F_REMCSUM_TX		0x200
#define VXLAN_F_REMCSUM_RX		0x400
#define VXLAN_F_GBP			0x800
#define VXLAN_F_REMCSUM_NOPARTIAL	0x1000
#define VXLAN_F_COLLECT_METADATA	0x2000
#define VXLAN_F_GPE			0x4000
#define VXLAN_F_IPV6_LINKLOCAL		0x8000
#define VXLAN_F_TTL_INHERIT		0x10000

/* Flags that are used in the receive path. These flags must match in
 * order for a socket to be shareable
 */
#define VXLAN_F_RCV_FLAGS		(VXLAN_F_GBP |			\
					 VXLAN_F_GPE |			\
					 VXLAN_F_UDP_ZERO_CSUM6_RX |	\
					 VXLAN_F_REMCSUM_RX |		\
					 VXLAN_F_REMCSUM_NOPARTIAL |	\
					 VXLAN_F_COLLECT_METADATA)

/* Flags that can be set together with VXLAN_F_GPE. */
#define VXLAN_F_ALLOWED_GPE		(VXLAN_F_GPE |			\
					 VXLAN_F_IPV6 |			\
					 VXLAN_F_IPV6_LINKLOCAL |	\
					 VXLAN_F_UDP_ZERO_CSUM_TX |	\
					 VXLAN_F_UDP_ZERO_CSUM6_TX |	\
					 VXLAN_F_UDP_ZERO_CSUM6_RX |	\
					 VXLAN_F_COLLECT_METADATA)

struct net_device *vxlan_dev_create(struct net *net, const char *name,
				    u8 name_assign_type, struct vxlan_config *conf);

static inline netdev_features_t vxlan_features_check(struct sk_buff *skb,
						     netdev_features_t features)
{
	u8 l4_hdr = 0;

	if (!skb->encapsulation)
		return features;

	switch (vlan_get_protocol(skb)) {
	case htons(ETH_P_IP):
		l4_hdr = ip_hdr(skb)->protocol;
		break;
	case htons(ETH_P_IPV6):
		l4_hdr = ipv6_hdr(skb)->nexthdr;
		break;
	default:
		return features;
	}

	if ((l4_hdr == IPPROTO_UDP) &&
	    (skb->inner_protocol_type != ENCAP_TYPE_ETHER ||
	     skb->inner_protocol != htons(ETH_P_TEB) ||
	     (skb_inner_mac_header(skb) - skb_transport_header(skb) !=
	      sizeof(struct udphdr) + sizeof(struct vxlanhdr)) ||
	     (skb->ip_summed != CHECKSUM_NONE &&
	      !can_checksum_protocol(features, inner_eth_hdr(skb)->h_proto))))
		return features & ~(NETIF_F_CSUM_MASK | NETIF_F_GSO_MASK);

	return features;
}

/* IP header + UDP + VXLAN + Ethernet header */
#define VXLAN_HEADROOM (20 + 8 + 8 + 14)
/* IPv6 header + UDP + VXLAN + Ethernet header */
#define VXLAN6_HEADROOM (40 + 8 + 8 + 14)

static inline struct vxlanhdr *vxlan_hdr(struct sk_buff *skb)
{
	return (struct vxlanhdr *)(udp_hdr(skb) + 1);
}

static inline __be32 vxlan_vni(__be32 vni_field)
{
#if defined(__BIG_ENDIAN)
	return (__force __be32)((__force u32)vni_field >> 8);
#else
	return (__force __be32)((__force u32)(vni_field & VXLAN_VNI_MASK) << 8);
#endif
}

static inline __be32 vxlan_vni_field(__be32 vni)
{
#if defined(__BIG_ENDIAN)
	return (__force __be32)((__force u32)vni << 8);
#else
	return (__force __be32)((__force u32)vni >> 8);
#endif
}

static inline size_t vxlan_rco_start(__be32 vni_field)
{
	return be32_to_cpu(vni_field & VXLAN_RCO_MASK) << VXLAN_RCO_SHIFT;
}

static inline size_t vxlan_rco_offset(__be32 vni_field)
{
	return (vni_field & VXLAN_RCO_UDP) ?
		offsetof(struct udphdr, check) :
		offsetof(struct tcphdr, check);
}

static inline __be32 vxlan_compute_rco(unsigned int start, unsigned int offset)
{
	__be32 vni_field = cpu_to_be32(start >> VXLAN_RCO_SHIFT);

	if (offset == offsetof(struct udphdr, check))
		vni_field |= VXLAN_RCO_UDP;
	return vni_field;
}

static inline unsigned short vxlan_get_sk_family(struct vxlan_sock *vs)
{
	return vs->sock->sk->sk_family;
}

#if IS_ENABLED(CONFIG_IPV6)

static inline bool vxlan_addr_any(const union vxlan_addr *ipa)
{
	if (ipa->sa.sa_family == AF_INET6)
		return ipv6_addr_any(&ipa->sin6.sin6_addr);
	else
		return ipa->sin.sin_addr.s_addr == htonl(INADDR_ANY);
}

static inline bool vxlan_addr_multicast(const union vxlan_addr *ipa)
{
	if (ipa->sa.sa_family == AF_INET6)
		return ipv6_addr_is_multicast(&ipa->sin6.sin6_addr);
	else
		return ipv4_is_multicast(ipa->sin.sin_addr.s_addr);
}

#else /* !IS_ENABLED(CONFIG_IPV6) */

static inline bool vxlan_addr_any(const union vxlan_addr *ipa)
{
	return ipa->sin.sin_addr.s_addr == htonl(INADDR_ANY);
}

static inline bool vxlan_addr_multicast(const union vxlan_addr *ipa)
{
	return ipv4_is_multicast(ipa->sin.sin_addr.s_addr);
}

#endif /* IS_ENABLED(CONFIG_IPV6) */

static inline bool netif_is_vxlan(const struct net_device *dev)
{
	return dev->rtnl_link_ops &&
	       !strcmp(dev->rtnl_link_ops->kind, "vxlan");
}

struct switchdev_notifier_vxlan_fdb_info {
	struct switchdev_notifier_info info; /* must be first */
	union vxlan_addr remote_ip;
	__be16 remote_port;
	__be32 remote_vni;
	u32 remote_ifindex;
	u8 eth_addr[ETH_ALEN];
	__be32 vni;
	bool offloaded;
	bool added_by_user;
};

#if IS_ENABLED(CONFIG_VXLAN)
int vxlan_fdb_find_uc(struct net_device *dev, const u8 *mac, __be32 vni,
		      struct switchdev_notifier_vxlan_fdb_info *fdb_info);
int vxlan_fdb_replay(const struct net_device *dev, __be32 vni,
		     struct notifier_block *nb,
		     struct netlink_ext_ack *extack);
void vxlan_fdb_clear_offload(const struct net_device *dev, __be32 vni);

#else
static inline int
vxlan_fdb_find_uc(struct net_device *dev, const u8 *mac, __be32 vni,
		  struct switchdev_notifier_vxlan_fdb_info *fdb_info)
{
	return -ENOENT;
}

static inline int vxlan_fdb_replay(const struct net_device *dev, __be32 vni,
				   struct notifier_block *nb,
				   struct netlink_ext_ack *extack)
{
	return -EOPNOTSUPP;
}

static inline void
vxlan_fdb_clear_offload(const struct net_device *dev, __be32 vni)
{
}
#endif

static inline void vxlan_flag_attr_error(int attrtype,
					 struct netlink_ext_ack *extack)
{
#define VXLAN_FLAG(flg) \
	case IFLA_VXLAN_##flg: \
		NL_SET_ERR_MSG_MOD(extack, \
				   "cannot change " #flg " flag"); \
		break
	switch (attrtype) {
	VXLAN_FLAG(TTL_INHERIT);
	VXLAN_FLAG(LEARNING);
	VXLAN_FLAG(PROXY);
	VXLAN_FLAG(RSC);
	VXLAN_FLAG(L2MISS);
	VXLAN_FLAG(L3MISS);
	VXLAN_FLAG(COLLECT_METADATA);
	VXLAN_FLAG(UDP_ZERO_CSUM6_TX);
	VXLAN_FLAG(UDP_ZERO_CSUM6_RX);
	VXLAN_FLAG(REMCSUM_TX);
	VXLAN_FLAG(REMCSUM_RX);
	VXLAN_FLAG(GBP);
	VXLAN_FLAG(GPE);
	VXLAN_FLAG(REMCSUM_NOPARTIAL);
	default:
		NL_SET_ERR_MSG_MOD(extack, \
				   "cannot change flag");
		break;
	}
#undef VXLAN_FLAG
}

#endif
Commit	Line	Data
b2441318	1	/* SPDX-License-Identifier: GPL-2.0 */
012a5729 PS	2	#ifndef __NET_VXLAN_H
	3	#define __NET_VXLAN_H 1
	4
5f35227e	5	#include <linux/if_vlan.h>
86a98057	6	#include <net/udp_tunnel.h>
ee122c79	7	#include <net/dst_metadata.h>
5ff4ff4f	8	#include <net/rtnetlink.h>
9a997353	9	#include <net/switchdev.h>
012a5729	10
bea96410 MS	11	#define IANA_VXLAN_UDP_PORT 4789
bea96410 MS	12
828788ac JB	13	/* VXLAN protocol (RFC 7348) header:
	14	* +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
	15	* \|R\|R\|R\|R\|I\|R\|R\|R\| Reserved \|
	16	* +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
	17	* \| VXLAN Network Identifier (VNI) \| Reserved \|
	18	* +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
	19	*
	20	* I = VXLAN Network Identifier (VNI) present.
	21	*/
	22	struct vxlanhdr {
	23	__be32 vx_flags;
	24	__be32 vx_vni;
	25	};
	26
	27	/* VXLAN header flags. */
54bfd872	28	#define VXLAN_HF_VNI cpu_to_be32(BIT(27))
828788ac JB	29
	30	#define VXLAN_N_VID (1u << 24)
	31	#define VXLAN_VID_MASK (VXLAN_N_VID - 1)
54bfd872	32	#define VXLAN_VNI_MASK cpu_to_be32(VXLAN_VID_MASK << 8)
828788ac JB	33	#define VXLAN_HLEN (sizeof(struct udphdr) + sizeof(struct vxlanhdr))
	34
	35	#define VNI_HASH_BITS 10
	36	#define VNI_HASH_SIZE (1<<VNI_HASH_BITS)
	37	#define FDB_HASH_BITS 8
	38	#define FDB_HASH_SIZE (1<<FDB_HASH_BITS)
	39
	40	/* Remote checksum offload for VXLAN (VXLAN_F_REMCSUM_[RT]X):
	41	* +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
	42	* \|R\|R\|R\|R\|I\|R\|R\|R\|R\|R\|C\| Reserved \|
	43	* +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
	44	* \| VXLAN Network Identifier (VNI) \|O\| Csum start \|
	45	* +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
	46	*
	47	* C = Remote checksum offload bit. When set indicates that the
	48	* remote checksum offload data is present.
	49	*
	50	* O = Offset bit. Indicates the checksum offset relative to
	51	* checksum start.
	52	*
	53	* Csum start = Checksum start divided by two.
	54	*
	55	* http://tools.ietf.org/html/draft-herbert-vxlan-rco
	56	*/
	57
	58	/* VXLAN-RCO header flags. */
54bfd872	59	#define VXLAN_HF_RCO cpu_to_be32(BIT(21))
828788ac JB	60
828788ac JB	61	/* Remote checksum offload header option */
54bfd872 JB	62	#define VXLAN_RCO_MASK cpu_to_be32(0x7f) /* Last byte of vni field */
	63	#define VXLAN_RCO_UDP cpu_to_be32(0x80) /* Indicate UDP RCO (TCP when not set ) /
	64	#define VXLAN_RCO_SHIFT 1 /* Left shift of start */
828788ac	65	#define VXLAN_RCO_SHIFT_MASK ((1 << VXLAN_RCO_SHIFT) - 1)
54bfd872	66	#define VXLAN_MAX_REMCSUM_START (0x7f << VXLAN_RCO_SHIFT)
828788ac	67
3511494c	68	/*
828788ac	69	* VXLAN Group Based Policy Extension (VXLAN_F_GBP):
3511494c	70	* +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
828788ac	71	* \|G\|R\|R\|R\|I\|R\|R\|R\|R\|D\|R\|R\|A\|R\|R\|R\| Group Policy ID \|
3511494c TG	72	* +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
	73	* \| VXLAN Network Identifier (VNI) \| Reserved \|
	74	* +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
	75	*
828788ac JB	76	* G = Group Policy ID present.
828788ac JB	77	*
3511494c TG	78	* D = Don't Learn bit. When set, this bit indicates that the egress
	79	* VTEP MUST NOT learn the source address of the encapsulated frame.
	80	*
	81	* A = Indicates that the group policy has already been applied to
	82	* this packet. Policies MUST NOT be applied by devices when the
	83	* A bit is set.
	84	*
828788ac	85	* https://tools.ietf.org/html/draft-smith-vxlan-group-policy
3511494c TG	86	*/
3511494c TG	87	struct vxlanhdr_gbp {
0e715d6f	88	u8 vx_flags;
3511494c	89	#ifdef __LITTLE_ENDIAN_BITFIELD
0e715d6f	90	u8 reserved_flags1:3,
3511494c TG	91	policy_applied:1,
	92	reserved_flags2:2,
	93	dont_learn:1,
	94	reserved_flags3:1;
	95	#elif defined(__BIG_ENDIAN_BITFIELD)
0e715d6f	96	u8 reserved_flags1:1,
3511494c TG	97	dont_learn:1,
	98	reserved_flags2:2,
	99	policy_applied:1,
	100	reserved_flags3:3;
	101	#else
	102	#error "Please fix <asm/byteorder.h>"
	103	#endif
	104	__be16 policy_id;
	105	__be32 vx_vni;
	106	};
	107
828788ac	108	/* VXLAN-GBP header flags. */
54bfd872	109	#define VXLAN_HF_GBP cpu_to_be32(BIT(31))
828788ac	110
54bfd872	111	#define VXLAN_GBP_USED_BITS (VXLAN_HF_GBP \| cpu_to_be32(0xFFFFFF))
3511494c TG	112
	113	/* skb->mark mapping
	114	*
	115	* +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
	116	* \|R\|R\|R\|R\|R\|R\|R\|R\|R\|D\|R\|R\|A\|R\|R\|R\| Group Policy ID \|
	117	* +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
	118	*/
	119	#define VXLAN_GBP_DONT_LEARN (BIT(6) << 16)
	120	#define VXLAN_GBP_POLICY_APPLIED (BIT(3) << 16)
	121	#define VXLAN_GBP_ID_MASK (0xFFFF)
	122
e1e5314d JB	123	/*
	124	* VXLAN Generic Protocol Extension (VXLAN_F_GPE):
	125	* +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
	126	* \|R\|R\|Ver\|I\|P\|R\|O\| Reserved \|Next Protocol \|
	127	* +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
	128	* \| VXLAN Network Identifier (VNI) \| Reserved \|
	129	* +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
	130	*
	131	* Ver = Version. Indicates VXLAN GPE protocol version.
	132	*
	133	* P = Next Protocol Bit. The P bit is set to indicate that the
	134	* Next Protocol field is present.
	135	*
	136	* O = OAM Flag Bit. The O bit is set to indicate that the packet
	137	* is an OAM packet.
	138	*
	139	* Next Protocol = This 8 bit field indicates the protocol header
	140	* immediately following the VXLAN GPE header.
	141	*
	142	* https://tools.ietf.org/html/draft-ietf-nvo3-vxlan-gpe-01
	143	*/
	144
	145	struct vxlanhdr_gpe {
	146	#if defined(__LITTLE_ENDIAN_BITFIELD)
	147	u8 oam_flag:1,
	148	reserved_flags1:1,
	149	np_applied:1,
	150	instance_applied:1,
	151	version:2,
f1c8d372	152	reserved_flags2:2;
e1e5314d JB	153	#elif defined(__BIG_ENDIAN_BITFIELD)
	154	u8 reserved_flags2:2,
	155	version:2,
	156	instance_applied:1,
	157	np_applied:1,
	158	reserved_flags1:1,
	159	oam_flag:1;
	160	#endif
	161	u8 reserved_flags3;
	162	u8 reserved_flags4;
	163	u8 next_protocol;
	164	__be32 vx_vni;
	165	};
	166
	167	/* VXLAN-GPE header flags. */
	168	#define VXLAN_HF_VER cpu_to_be32(BIT(29) \| BIT(28))
	169	#define VXLAN_HF_NP cpu_to_be32(BIT(26))
	170	#define VXLAN_HF_OAM cpu_to_be32(BIT(24))
	171
	172	#define VXLAN_GPE_USED_BITS (VXLAN_HF_VER \| VXLAN_HF_NP \| VXLAN_HF_OAM \| \
	173	cpu_to_be32(0xff))
	174
3511494c	175	struct vxlan_metadata {
3511494c TG	176	u32 gbp;
	177	};
	178
012a5729 PS	179	/* per UDP socket information */
	180	struct vxlan_sock {
	181	struct hlist_node hlist;
012a5729	182	struct socket *sock;
012a5729	183	struct hlist_head vni_list[VNI_HASH_SIZE];
66af846f	184	refcount_t refcnt;
dfd8645e	185	u32 flags;
012a5729 PS	186	};
012a5729 PS	187
0dfbdf41 TG	188	union vxlan_addr {
	189	struct sockaddr_in sin;
	190	struct sockaddr_in6 sin6;
	191	struct sockaddr sa;
	192	};
	193
	194	struct vxlan_rdst {
	195	union vxlan_addr remote_ip;
	196	__be16 remote_port;
0efe1173	197	u8 offloaded:1;
54bfd872	198	__be32 remote_vni;
0dfbdf41	199	u32 remote_ifindex;
0ce1822c	200	struct net_device *remote_dev;
0dfbdf41 TG	201	struct list_head list;
0dfbdf41 TG	202	struct rcu_head rcu;
0c1d70af	203	struct dst_cache dst_cache;
0dfbdf41 TG	204	};
	205
	206	struct vxlan_config {
	207	union vxlan_addr remote_ip;
	208	union vxlan_addr saddr;
54bfd872	209	__be32 vni;
0dfbdf41 TG	210	int remote_ifindex;
	211	int mtu;
	212	__be16 dst_port;
0e715d6f JB	213	u16 port_min;
	214	u16 port_max;
	215	u8 tos;
	216	u8 ttl;
e7f70af1	217	__be32 label;
0dfbdf41 TG	218	u32 flags;
	219	unsigned long age_interval;
	220	unsigned int addrmax;
	221	bool no_share;
b4d30697	222	enum ifla_vxlan_df df;
0dfbdf41 TG	223	};
0dfbdf41 TG	224
69e76661 JB	225	struct vxlan_dev_node {
	226	struct hlist_node hlist;
	227	struct vxlan_dev *vxlan;
	228	};
	229
0dfbdf41 TG	230	/* Pseudo network device */
0dfbdf41 TG	231	struct vxlan_dev {
69e76661 JB	232	struct vxlan_dev_node hlist4; /* vni hash table for IPv4 socket */
	233	#if IS_ENABLED(CONFIG_IPV6)
	234	struct vxlan_dev_node hlist6; /* vni hash table for IPv6 socket */
	235	#endif
0dfbdf41	236	struct list_head next; /* vxlan's per namespace list */
c6fcc4fc	237	struct vxlan_sock __rcu vn4_sock; / listening socket for IPv4 */
b1be00a6	238	#if IS_ENABLED(CONFIG_IPV6)
c6fcc4fc	239	struct vxlan_sock __rcu vn6_sock; / listening socket for IPv6 */
b1be00a6	240	#endif
0dfbdf41 TG	241	struct net_device *dev;
	242	struct net net; / netns for packet i/o */
	243	struct vxlan_rdst default_dst; /* default destination */
0dfbdf41 TG	244
0dfbdf41 TG	245	struct timer_list age_timer;
fe1e0713	246	spinlock_t hash_lock[FDB_HASH_SIZE];
0dfbdf41	247	unsigned int addrcnt;
58ce31cc	248	struct gro_cells gro_cells;
0dfbdf41 TG	249
	250	struct vxlan_config cfg;
	251
	252	struct hlist_head fdb_head[FDB_HASH_SIZE];
	253	};
	254
359a0ea9 TH	255	#define VXLAN_F_LEARN 0x01
	256	#define VXLAN_F_PROXY 0x02
	257	#define VXLAN_F_RSC 0x04
	258	#define VXLAN_F_L2MISS 0x08
	259	#define VXLAN_F_L3MISS 0x10
	260	#define VXLAN_F_IPV6 0x20
6ceb31ca	261	#define VXLAN_F_UDP_ZERO_CSUM_TX 0x40
359a0ea9 TH	262	#define VXLAN_F_UDP_ZERO_CSUM6_TX 0x80
359a0ea9 TH	263	#define VXLAN_F_UDP_ZERO_CSUM6_RX 0x100
dfd8645e TH	264	#define VXLAN_F_REMCSUM_TX 0x200
dfd8645e TH	265	#define VXLAN_F_REMCSUM_RX 0x400
3511494c	266	#define VXLAN_F_GBP 0x800
0ace2ca8	267	#define VXLAN_F_REMCSUM_NOPARTIAL 0x1000
ee122c79	268	#define VXLAN_F_COLLECT_METADATA 0x2000
e1e5314d	269	#define VXLAN_F_GPE 0x4000
0f22a3c6	270	#define VXLAN_F_IPV6_LINKLOCAL 0x8000
72f6d71e	271	#define VXLAN_F_TTL_INHERIT 0x10000
359a0ea9	272
d299ce14	273	/* Flags that are used in the receive path. These flags must match in
af33c1ad TH	274	* order for a socket to be shareable
	275	*/
	276	#define VXLAN_F_RCV_FLAGS (VXLAN_F_GBP \| \
e1e5314d	277	VXLAN_F_GPE \| \
af33c1ad	278	VXLAN_F_UDP_ZERO_CSUM6_RX \| \
0ace2ca8	279	VXLAN_F_REMCSUM_RX \| \
ee122c79	280	VXLAN_F_REMCSUM_NOPARTIAL \| \
da8b43c0	281	VXLAN_F_COLLECT_METADATA)
ac5132d1	282
e1e5314d JB	283	/* Flags that can be set together with VXLAN_F_GPE. */
	284	#define VXLAN_F_ALLOWED_GPE (VXLAN_F_GPE \| \
	285	VXLAN_F_IPV6 \| \
0f22a3c6	286	VXLAN_F_IPV6_LINKLOCAL \| \
e1e5314d JB	287	VXLAN_F_UDP_ZERO_CSUM_TX \| \
	288	VXLAN_F_UDP_ZERO_CSUM6_TX \| \
	289	VXLAN_F_UDP_ZERO_CSUM6_RX \| \
	290	VXLAN_F_COLLECT_METADATA)
	291
0dfbdf41 TG	292	struct net_device vxlan_dev_create(struct net net, const char *name,
	293	u8 name_assign_type, struct vxlan_config *conf);
	294
5f35227e JG	295	static inline netdev_features_t vxlan_features_check(struct sk_buff *skb,
5f35227e JG	296	netdev_features_t features)
11bf7828	297	{
5f35227e JG	298	u8 l4_hdr = 0;
	299
	300	if (!skb->encapsulation)
	301	return features;
	302
	303	switch (vlan_get_protocol(skb)) {
	304	case htons(ETH_P_IP):
	305	l4_hdr = ip_hdr(skb)->protocol;
	306	break;
	307	case htons(ETH_P_IPV6):
	308	l4_hdr = ipv6_hdr(skb)->nexthdr;
	309	break;
	310	default:
5ef7e0ba	311	return features;
5f35227e JG	312	}
	313
	314	if ((l4_hdr == IPPROTO_UDP) &&
11bf7828 JS	315	(skb->inner_protocol_type != ENCAP_TYPE_ETHER \|\|
	316	skb->inner_protocol != htons(ETH_P_TEB) \|\|
	317	(skb_inner_mac_header(skb) - skb_transport_header(skb) !=
af67eb9e AD	318	sizeof(struct udphdr) + sizeof(struct vxlanhdr)) \|\|
	319	(skb->ip_summed != CHECKSUM_NONE &&
	320	!can_checksum_protocol(features, inner_eth_hdr(skb)->h_proto))))
a188222b	321	return features & ~(NETIF_F_CSUM_MASK \| NETIF_F_GSO_MASK);
11bf7828	322
5f35227e	323	return features;
11bf7828	324	}
23e62de3	325
e6cd988c JG	326	/* IP header + UDP + VXLAN + Ethernet header */
	327	#define VXLAN_HEADROOM (20 + 8 + 8 + 14)
	328	/* IPv6 header + UDP + VXLAN + Ethernet header */
	329	#define VXLAN6_HEADROOM (40 + 8 + 8 + 14)
	330
d4ac05ff JB	331	static inline struct vxlanhdr vxlan_hdr(struct sk_buff skb)
	332	{
	333	return (struct vxlanhdr *)(udp_hdr(skb) + 1);
	334	}
	335
54bfd872 JB	336	static inline __be32 vxlan_vni(__be32 vni_field)
	337	{
	338	#if defined(__BIG_ENDIAN)
5692d7ea	339	return (__force __be32)((__force u32)vni_field >> 8);
54bfd872	340	#else
5692d7ea	341	return (__force __be32)((__force u32)(vni_field & VXLAN_VNI_MASK) << 8);
54bfd872 JB	342	#endif
	343	}
	344
	345	static inline __be32 vxlan_vni_field(__be32 vni)
	346	{
	347	#if defined(__BIG_ENDIAN)
5692d7ea	348	return (__force __be32)((__force u32)vni << 8);
54bfd872	349	#else
5692d7ea	350	return (__force __be32)((__force u32)vni >> 8);
54bfd872 JB	351	#endif
	352	}
	353
54bfd872 JB	354	static inline size_t vxlan_rco_start(__be32 vni_field)
	355	{
	356	return be32_to_cpu(vni_field & VXLAN_RCO_MASK) << VXLAN_RCO_SHIFT;
	357	}
	358
	359	static inline size_t vxlan_rco_offset(__be32 vni_field)
	360	{
	361	return (vni_field & VXLAN_RCO_UDP) ?
	362	offsetof(struct udphdr, check) :
	363	offsetof(struct tcphdr, check);
	364	}
	365
	366	static inline __be32 vxlan_compute_rco(unsigned int start, unsigned int offset)
	367	{
	368	__be32 vni_field = cpu_to_be32(start >> VXLAN_RCO_SHIFT);
	369
	370	if (offset == offsetof(struct udphdr, check))
	371	vni_field \|= VXLAN_RCO_UDP;
	372	return vni_field;
	373	}
	374
705cc62f JB	375	static inline unsigned short vxlan_get_sk_family(struct vxlan_sock *vs)
	376	{
	377	return vs->sock->sk->sk_family;
	378	}
48e92c44	379
cca45e05 IS	380	#if IS_ENABLED(CONFIG_IPV6)
	381
	382	static inline bool vxlan_addr_any(const union vxlan_addr *ipa)
	383	{
	384	if (ipa->sa.sa_family == AF_INET6)
	385	return ipv6_addr_any(&ipa->sin6.sin6_addr);
	386	else
	387	return ipa->sin.sin_addr.s_addr == htonl(INADDR_ANY);
	388	}
	389
	390	static inline bool vxlan_addr_multicast(const union vxlan_addr *ipa)
	391	{
	392	if (ipa->sa.sa_family == AF_INET6)
	393	return ipv6_addr_is_multicast(&ipa->sin6.sin6_addr);
	394	else
842841ec	395	return ipv4_is_multicast(ipa->sin.sin_addr.s_addr);
cca45e05 IS	396	}
	397
	398	#else /* !IS_ENABLED(CONFIG_IPV6) */
	399
	400	static inline bool vxlan_addr_any(const union vxlan_addr *ipa)
	401	{
	402	return ipa->sin.sin_addr.s_addr == htonl(INADDR_ANY);
	403	}
	404
	405	static inline bool vxlan_addr_multicast(const union vxlan_addr *ipa)
	406	{
842841ec	407	return ipv4_is_multicast(ipa->sin.sin_addr.s_addr);
cca45e05 IS	408	}
	409
	410	#endif /* IS_ENABLED(CONFIG_IPV6) */
	411
5ff4ff4f IS	412	static inline bool netif_is_vxlan(const struct net_device *dev)
	413	{
	414	return dev->rtnl_link_ops &&
	415	!strcmp(dev->rtnl_link_ops->kind, "vxlan");
	416	}
	417
9a997353 PM	418	struct switchdev_notifier_vxlan_fdb_info {
	419	struct switchdev_notifier_info info; /* must be first */
	420	union vxlan_addr remote_ip;
	421	__be16 remote_port;
	422	__be32 remote_vni;
	423	u32 remote_ifindex;
	424	u8 eth_addr[ETH_ALEN];
	425	__be32 vni;
0efe1173	426	bool offloaded;
45598c1c	427	bool added_by_user;
9a997353 PM	428	};
9a997353 PM	429
1941f1d6 PM	430	#if IS_ENABLED(CONFIG_VXLAN)
	431	int vxlan_fdb_find_uc(struct net_device dev, const u8 mac, __be32 vni,
	432	struct switchdev_notifier_vxlan_fdb_info *fdb_info);
4f89f5b5	433	int vxlan_fdb_replay(const struct net_device *dev, __be32 vni,
4c59b7d1 PM	434	struct notifier_block *nb,
4c59b7d1 PM	435	struct netlink_ext_ack *extack);
e5ff4b19	436	void vxlan_fdb_clear_offload(const struct net_device *dev, __be32 vni);
4f89f5b5	437
1941f1d6 PM	438	#else
	439	static inline int
	440	vxlan_fdb_find_uc(struct net_device dev, const u8 mac, __be32 vni,
	441	struct switchdev_notifier_vxlan_fdb_info *fdb_info)
	442	{
	443	return -ENOENT;
	444	}
4f89f5b5 PM	445
4f89f5b5 PM	446	static inline int vxlan_fdb_replay(const struct net_device *dev, __be32 vni,
4c59b7d1 PM	447	struct notifier_block *nb,
4c59b7d1 PM	448	struct netlink_ext_ack *extack)
4f89f5b5 PM	449	{
	450	return -EOPNOTSUPP;
	451	}
e5ff4b19 PM	452
	453	static inline void
	454	vxlan_fdb_clear_offload(const struct net_device *dev, __be32 vni)
	455	{
	456	}
1941f1d6 PM	457	#endif
1941f1d6 PM	458
70fb0828 RP	459	static inline void vxlan_flag_attr_error(int attrtype,
	460	struct netlink_ext_ack *extack)
	461	{
	462	#define VXLAN_FLAG(flg) \
	463	case IFLA_VXLAN_##flg: \
	464	NL_SET_ERR_MSG_MOD(extack, \
	465	"cannot change " #flg " flag"); \
	466	break
	467	switch (attrtype) {
	468	VXLAN_FLAG(TTL_INHERIT);
	469	VXLAN_FLAG(LEARNING);
	470	VXLAN_FLAG(PROXY);
	471	VXLAN_FLAG(RSC);
	472	VXLAN_FLAG(L2MISS);
	473	VXLAN_FLAG(L3MISS);
	474	VXLAN_FLAG(COLLECT_METADATA);
	475	VXLAN_FLAG(UDP_ZERO_CSUM6_TX);
	476	VXLAN_FLAG(UDP_ZERO_CSUM6_RX);
	477	VXLAN_FLAG(REMCSUM_TX);
	478	VXLAN_FLAG(REMCSUM_RX);
	479	VXLAN_FLAG(GBP);
	480	VXLAN_FLAG(GPE);
	481	VXLAN_FLAG(REMCSUM_NOPARTIAL);
	482	default:
	483	NL_SET_ERR_MSG_MOD(extack, \
	484	"cannot change flag");
	485	break;
	486	}
	487	#undef VXLAN_FLAG
	488	}
	489
48e92c44	490	#endif