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

#ifndef __NET_VXLAN_H
#define __NET_VXLAN_H 1

#include <linux/ip.h>
#include <linux/ipv6.h>
#include <linux/if_vlan.h>
#include <linux/skbuff.h>
#include <linux/netdevice.h>
#include <linux/udp.h>
#include <net/dst_metadata.h>

/* 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))

/* VXLAN-GPE header Next Protocol. */
#define VXLAN_GPE_NP_IPV4      0x01
#define VXLAN_GPE_NP_IPV6      0x02
#define VXLAN_GPE_NP_ETHERNET  0x03
#define VXLAN_GPE_NP_NSH       0x04

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];
	atomic_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;
	__be32			 remote_vni;
	u32			 remote_ifindex;
	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;
};

/* Pseudo network device */
struct vxlan_dev {
	struct hlist_node hlist;	/* vni hash table */
	struct list_head  next;		/* vxlan's per namespace list */
	struct vxlan_sock *vn4_sock;	/* listening socket for IPv4 */
#if IS_ENABLED(CONFIG_IPV6)
	struct vxlan_sock *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 */
	u32		  flags;	/* VXLAN_F_* in vxlan.h */

	struct timer_list age_timer;
	spinlock_t	  hash_lock;
	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

/* 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_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 __be16 vxlan_dev_dst_port(struct vxlan_dev *vxlan,
					unsigned short family)
{
#if IS_ENABLED(CONFIG_IPV6)
	if (family == AF_INET6)
		return inet_sk(vxlan->vn6_sock->sock->sk)->inet_sport;
#endif
	return inet_sk(vxlan->vn4_sock->sock->sk)->inet_sport;
}

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 __be32 vxlan_tun_id_to_vni(__be64 tun_id)
{
#if defined(__BIG_ENDIAN)
	return (__force __be32)tun_id;
#else
	return (__force __be32)((__force u64)tun_id >> 32);
#endif
}

static inline __be64 vxlan_vni_to_tun_id(__be32 vni)
{
#if defined(__BIG_ENDIAN)
	return (__force __be64)vni;
#else
	return (__force __be64)((u64)(__force u32)vni << 32);
#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 void vxlan_get_rx_port(struct net_device *netdev)
{
	ASSERT_RTNL();
	call_netdevice_notifiers(NETDEV_OFFLOAD_PUSH_VXLAN, netdev);
}

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

#endif
Commit	Line	Data
012a5729 PS	1	#ifndef __NET_VXLAN_H
	2	#define __NET_VXLAN_H 1
	3
5f35227e JG	4	#include <linux/ip.h>
	5	#include <linux/ipv6.h>
	6	#include <linux/if_vlan.h>
012a5729 PS	7	#include <linux/skbuff.h>
	8	#include <linux/netdevice.h>
	9	#include <linux/udp.h>
ee122c79	10	#include <net/dst_metadata.h>
012a5729	11
828788ac JB	12	/* VXLAN protocol (RFC 7348) header:
	13	* +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
	14	* \|R\|R\|R\|R\|I\|R\|R\|R\| Reserved \|
	15	* +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
	16	* \| VXLAN Network Identifier (VNI) \| Reserved \|
	17	* +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
	18	*
	19	* I = VXLAN Network Identifier (VNI) present.
	20	*/
	21	struct vxlanhdr {
	22	__be32 vx_flags;
	23	__be32 vx_vni;
	24	};
	25
	26	/* VXLAN header flags. */
54bfd872	27	#define VXLAN_HF_VNI cpu_to_be32(BIT(27))
828788ac JB	28
	29	#define VXLAN_N_VID (1u << 24)
	30	#define VXLAN_VID_MASK (VXLAN_N_VID - 1)
54bfd872	31	#define VXLAN_VNI_MASK cpu_to_be32(VXLAN_VID_MASK << 8)
828788ac JB	32	#define VXLAN_HLEN (sizeof(struct udphdr) + sizeof(struct vxlanhdr))
	33
	34	#define VNI_HASH_BITS 10
	35	#define VNI_HASH_SIZE (1<<VNI_HASH_BITS)
	36	#define FDB_HASH_BITS 8
	37	#define FDB_HASH_SIZE (1<<FDB_HASH_BITS)
	38
	39	/* Remote checksum offload for VXLAN (VXLAN_F_REMCSUM_[RT]X):
	40	* +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
	41	* \|R\|R\|R\|R\|I\|R\|R\|R\|R\|R\|C\| Reserved \|
	42	* +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
	43	* \| VXLAN Network Identifier (VNI) \|O\| Csum start \|
	44	* +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
	45	*
	46	* C = Remote checksum offload bit. When set indicates that the
	47	* remote checksum offload data is present.
	48	*
	49	* O = Offset bit. Indicates the checksum offset relative to
	50	* checksum start.
	51	*
	52	* Csum start = Checksum start divided by two.
	53	*
	54	* http://tools.ietf.org/html/draft-herbert-vxlan-rco
	55	*/
	56
	57	/* VXLAN-RCO header flags. */
54bfd872	58	#define VXLAN_HF_RCO cpu_to_be32(BIT(21))
828788ac JB	59
828788ac JB	60	/* Remote checksum offload header option */
54bfd872 JB	61	#define VXLAN_RCO_MASK cpu_to_be32(0x7f) /* Last byte of vni field */
	62	#define VXLAN_RCO_UDP cpu_to_be32(0x80) /* Indicate UDP RCO (TCP when not set ) /
	63	#define VXLAN_RCO_SHIFT 1 /* Left shift of start */
828788ac	64	#define VXLAN_RCO_SHIFT_MASK ((1 << VXLAN_RCO_SHIFT) - 1)
54bfd872	65	#define VXLAN_MAX_REMCSUM_START (0x7f << VXLAN_RCO_SHIFT)
828788ac	66
3511494c	67	/*
828788ac	68	* VXLAN Group Based Policy Extension (VXLAN_F_GBP):
3511494c	69	* +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
828788ac	70	* \|G\|R\|R\|R\|I\|R\|R\|R\|R\|D\|R\|R\|A\|R\|R\|R\| Group Policy ID \|
3511494c TG	71	* +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
	72	* \| VXLAN Network Identifier (VNI) \| Reserved \|
	73	* +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
	74	*
828788ac JB	75	* G = Group Policy ID present.
828788ac JB	76	*
3511494c TG	77	* D = Don't Learn bit. When set, this bit indicates that the egress
	78	* VTEP MUST NOT learn the source address of the encapsulated frame.
	79	*
	80	* A = Indicates that the group policy has already been applied to
	81	* this packet. Policies MUST NOT be applied by devices when the
	82	* A bit is set.
	83	*
828788ac	84	* https://tools.ietf.org/html/draft-smith-vxlan-group-policy
3511494c TG	85	*/
3511494c TG	86	struct vxlanhdr_gbp {
0e715d6f	87	u8 vx_flags;
3511494c	88	#ifdef __LITTLE_ENDIAN_BITFIELD
0e715d6f	89	u8 reserved_flags1:3,
3511494c TG	90	policy_applied:1,
	91	reserved_flags2:2,
	92	dont_learn:1,
	93	reserved_flags3:1;
	94	#elif defined(__BIG_ENDIAN_BITFIELD)
0e715d6f	95	u8 reserved_flags1:1,
3511494c TG	96	dont_learn:1,
	97	reserved_flags2:2,
	98	policy_applied:1,
	99	reserved_flags3:3;
	100	#else
	101	#error "Please fix <asm/byteorder.h>"
	102	#endif
	103	__be16 policy_id;
	104	__be32 vx_vni;
	105	};
	106
828788ac	107	/* VXLAN-GBP header flags. */
54bfd872	108	#define VXLAN_HF_GBP cpu_to_be32(BIT(31))
828788ac	109
54bfd872	110	#define VXLAN_GBP_USED_BITS (VXLAN_HF_GBP \| cpu_to_be32(0xFFFFFF))
3511494c TG	111
	112	/* skb->mark mapping
	113	*
	114	* +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
	115	* \|R\|R\|R\|R\|R\|R\|R\|R\|R\|D\|R\|R\|A\|R\|R\|R\| Group Policy ID \|
	116	* +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
	117	*/
	118	#define VXLAN_GBP_DONT_LEARN (BIT(6) << 16)
	119	#define VXLAN_GBP_POLICY_APPLIED (BIT(3) << 16)
	120	#define VXLAN_GBP_ID_MASK (0xFFFF)
	121
e1e5314d JB	122	/*
	123	* VXLAN Generic Protocol Extension (VXLAN_F_GPE):
	124	* +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
	125	* \|R\|R\|Ver\|I\|P\|R\|O\| Reserved \|Next Protocol \|
	126	* +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
	127	* \| VXLAN Network Identifier (VNI) \| Reserved \|
	128	* +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
	129	*
	130	* Ver = Version. Indicates VXLAN GPE protocol version.
	131	*
	132	* P = Next Protocol Bit. The P bit is set to indicate that the
	133	* Next Protocol field is present.
	134	*
	135	* O = OAM Flag Bit. The O bit is set to indicate that the packet
	136	* is an OAM packet.
	137	*
	138	* Next Protocol = This 8 bit field indicates the protocol header
	139	* immediately following the VXLAN GPE header.
	140	*
	141	* https://tools.ietf.org/html/draft-ietf-nvo3-vxlan-gpe-01
	142	*/
	143
	144	struct vxlanhdr_gpe {
	145	#if defined(__LITTLE_ENDIAN_BITFIELD)
	146	u8 oam_flag:1,
	147	reserved_flags1:1,
	148	np_applied:1,
	149	instance_applied:1,
	150	version:2,
	151	reserved_flags2:2;
	152	#elif defined(__BIG_ENDIAN_BITFIELD)
	153	u8 reserved_flags2:2,
	154	version:2,
	155	instance_applied:1,
	156	np_applied:1,
	157	reserved_flags1:1,
	158	oam_flag:1;
	159	#endif
	160	u8 reserved_flags3;
	161	u8 reserved_flags4;
	162	u8 next_protocol;
	163	__be32 vx_vni;
	164	};
	165
	166	/* VXLAN-GPE header flags. */
	167	#define VXLAN_HF_VER cpu_to_be32(BIT(29) \| BIT(28))
	168	#define VXLAN_HF_NP cpu_to_be32(BIT(26))
	169	#define VXLAN_HF_OAM cpu_to_be32(BIT(24))
	170
	171	#define VXLAN_GPE_USED_BITS (VXLAN_HF_VER \| VXLAN_HF_NP \| VXLAN_HF_OAM \| \
	172	cpu_to_be32(0xff))
	173
	174	/* VXLAN-GPE header Next Protocol. */
	175	#define VXLAN_GPE_NP_IPV4 0x01
	176	#define VXLAN_GPE_NP_IPV6 0x02
	177	#define VXLAN_GPE_NP_ETHERNET 0x03
	178	#define VXLAN_GPE_NP_NSH 0x04
	179
3511494c	180	struct vxlan_metadata {
3511494c TG	181	u32 gbp;
	182	};
	183
012a5729 PS	184	/* per UDP socket information */
	185	struct vxlan_sock {
	186	struct hlist_node hlist;
012a5729	187	struct socket *sock;
012a5729 PS	188	struct hlist_head vni_list[VNI_HASH_SIZE];
012a5729 PS	189	atomic_t refcnt;
dfd8645e	190	u32 flags;
012a5729 PS	191	};
012a5729 PS	192
0dfbdf41 TG	193	union vxlan_addr {
	194	struct sockaddr_in sin;
	195	struct sockaddr_in6 sin6;
	196	struct sockaddr sa;
	197	};
	198
	199	struct vxlan_rdst {
	200	union vxlan_addr remote_ip;
	201	__be16 remote_port;
54bfd872	202	__be32 remote_vni;
0dfbdf41 TG	203	u32 remote_ifindex;
	204	struct list_head list;
	205	struct rcu_head rcu;
0c1d70af	206	struct dst_cache dst_cache;
0dfbdf41 TG	207	};
	208
	209	struct vxlan_config {
	210	union vxlan_addr remote_ip;
	211	union vxlan_addr saddr;
54bfd872	212	__be32 vni;
0dfbdf41 TG	213	int remote_ifindex;
	214	int mtu;
	215	__be16 dst_port;
0e715d6f JB	216	u16 port_min;
	217	u16 port_max;
	218	u8 tos;
	219	u8 ttl;
e7f70af1	220	__be32 label;
0dfbdf41 TG	221	u32 flags;
	222	unsigned long age_interval;
	223	unsigned int addrmax;
	224	bool no_share;
	225	};
	226
	227	/* Pseudo network device */
	228	struct vxlan_dev {
	229	struct hlist_node hlist; /* vni hash table */
	230	struct list_head next; /* vxlan's per namespace list */
b1be00a6 JB	231	struct vxlan_sock vn4_sock; / listening socket for IPv4 */
	232	#if IS_ENABLED(CONFIG_IPV6)
	233	struct vxlan_sock vn6_sock; / listening socket for IPv6 */
	234	#endif
0dfbdf41 TG	235	struct net_device *dev;
	236	struct net net; / netns for packet i/o */
	237	struct vxlan_rdst default_dst; /* default destination */
	238	u32 flags; /* VXLAN_F_* in vxlan.h */
	239
	240	struct timer_list age_timer;
	241	spinlock_t hash_lock;
	242	unsigned int addrcnt;
58ce31cc	243	struct gro_cells gro_cells;
0dfbdf41 TG	244
	245	struct vxlan_config cfg;
	246
	247	struct hlist_head fdb_head[FDB_HASH_SIZE];
	248	};
	249
359a0ea9 TH	250	#define VXLAN_F_LEARN 0x01
	251	#define VXLAN_F_PROXY 0x02
	252	#define VXLAN_F_RSC 0x04
	253	#define VXLAN_F_L2MISS 0x08
	254	#define VXLAN_F_L3MISS 0x10
	255	#define VXLAN_F_IPV6 0x20
6ceb31ca	256	#define VXLAN_F_UDP_ZERO_CSUM_TX 0x40
359a0ea9 TH	257	#define VXLAN_F_UDP_ZERO_CSUM6_TX 0x80
359a0ea9 TH	258	#define VXLAN_F_UDP_ZERO_CSUM6_RX 0x100
dfd8645e TH	259	#define VXLAN_F_REMCSUM_TX 0x200
dfd8645e TH	260	#define VXLAN_F_REMCSUM_RX 0x400
3511494c	261	#define VXLAN_F_GBP 0x800
0ace2ca8	262	#define VXLAN_F_REMCSUM_NOPARTIAL 0x1000
ee122c79	263	#define VXLAN_F_COLLECT_METADATA 0x2000
e1e5314d	264	#define VXLAN_F_GPE 0x4000
359a0ea9	265
d299ce14	266	/* Flags that are used in the receive path. These flags must match in
af33c1ad TH	267	* order for a socket to be shareable
	268	*/
	269	#define VXLAN_F_RCV_FLAGS (VXLAN_F_GBP \| \
e1e5314d	270	VXLAN_F_GPE \| \
af33c1ad	271	VXLAN_F_UDP_ZERO_CSUM6_RX \| \
0ace2ca8	272	VXLAN_F_REMCSUM_RX \| \
ee122c79	273	VXLAN_F_REMCSUM_NOPARTIAL \| \
da8b43c0	274	VXLAN_F_COLLECT_METADATA)
ac5132d1	275
e1e5314d JB	276	/* Flags that can be set together with VXLAN_F_GPE. */
	277	#define VXLAN_F_ALLOWED_GPE (VXLAN_F_GPE \| \
	278	VXLAN_F_IPV6 \| \
	279	VXLAN_F_UDP_ZERO_CSUM_TX \| \
	280	VXLAN_F_UDP_ZERO_CSUM6_TX \| \
	281	VXLAN_F_UDP_ZERO_CSUM6_RX \| \
	282	VXLAN_F_COLLECT_METADATA)
	283
0dfbdf41 TG	284	struct net_device vxlan_dev_create(struct net net, const char *name,
	285	u8 name_assign_type, struct vxlan_config *conf);
	286
b1be00a6 JB	287	static inline __be16 vxlan_dev_dst_port(struct vxlan_dev *vxlan,
b1be00a6 JB	288	unsigned short family)
614732ea	289	{
b1be00a6 JB	290	#if IS_ENABLED(CONFIG_IPV6)
	291	if (family == AF_INET6)
	292	return inet_sk(vxlan->vn6_sock->sock->sk)->inet_sport;
	293	#endif
	294	return inet_sk(vxlan->vn4_sock->sock->sk)->inet_sport;
614732ea	295	}
49560532	296
5f35227e JG	297	static inline netdev_features_t vxlan_features_check(struct sk_buff *skb,
5f35227e JG	298	netdev_features_t features)
11bf7828	299	{
5f35227e JG	300	u8 l4_hdr = 0;
	301
	302	if (!skb->encapsulation)
	303	return features;
	304
	305	switch (vlan_get_protocol(skb)) {
	306	case htons(ETH_P_IP):
	307	l4_hdr = ip_hdr(skb)->protocol;
	308	break;
	309	case htons(ETH_P_IPV6):
	310	l4_hdr = ipv6_hdr(skb)->nexthdr;
	311	break;
	312	default:
	313	return features;;
	314	}
	315
	316	if ((l4_hdr == IPPROTO_UDP) &&
11bf7828 JS	317	(skb->inner_protocol_type != ENCAP_TYPE_ETHER \|\|
	318	skb->inner_protocol != htons(ETH_P_TEB) \|\|
	319	(skb_inner_mac_header(skb) - skb_transport_header(skb) !=
af67eb9e AD	320	sizeof(struct udphdr) + sizeof(struct vxlanhdr)) \|\|
	321	(skb->ip_summed != CHECKSUM_NONE &&
	322	!can_checksum_protocol(features, inner_eth_hdr(skb)->h_proto))))
a188222b	323	return features & ~(NETIF_F_CSUM_MASK \| NETIF_F_GSO_MASK);
11bf7828	324
5f35227e	325	return features;
11bf7828	326	}
23e62de3	327
e6cd988c JG	328	/* IP header + UDP + VXLAN + Ethernet header */
	329	#define VXLAN_HEADROOM (20 + 8 + 8 + 14)
	330	/* IPv6 header + UDP + VXLAN + Ethernet header */
	331	#define VXLAN6_HEADROOM (40 + 8 + 8 + 14)
	332
d4ac05ff JB	333	static inline struct vxlanhdr vxlan_hdr(struct sk_buff skb)
	334	{
	335	return (struct vxlanhdr *)(udp_hdr(skb) + 1);
	336	}
	337
54bfd872 JB	338	static inline __be32 vxlan_vni(__be32 vni_field)
	339	{
	340	#if defined(__BIG_ENDIAN)
5692d7ea	341	return (__force __be32)((__force u32)vni_field >> 8);
54bfd872	342	#else
5692d7ea	343	return (__force __be32)((__force u32)(vni_field & VXLAN_VNI_MASK) << 8);
54bfd872 JB	344	#endif
	345	}
	346
	347	static inline __be32 vxlan_vni_field(__be32 vni)
	348	{
	349	#if defined(__BIG_ENDIAN)
5692d7ea	350	return (__force __be32)((__force u32)vni << 8);
54bfd872	351	#else
5692d7ea	352	return (__force __be32)((__force u32)vni >> 8);
54bfd872 JB	353	#endif
	354	}
	355
	356	static inline __be32 vxlan_tun_id_to_vni(__be64 tun_id)
	357	{
	358	#if defined(__BIG_ENDIAN)
5692d7ea	359	return (__force __be32)tun_id;
54bfd872	360	#else
5692d7ea	361	return (__force __be32)((__force u64)tun_id >> 32);
54bfd872 JB	362	#endif
	363	}
	364
07dabf20 JB	365	static inline __be64 vxlan_vni_to_tun_id(__be32 vni)
	366	{
	367	#if defined(__BIG_ENDIAN)
5692d7ea	368	return (__force __be64)vni;
07dabf20	369	#else
5692d7ea	370	return (__force __be64)((u64)(__force u32)vni << 32);
07dabf20 JB	371	#endif
	372	}
	373
54bfd872 JB	374	static inline size_t vxlan_rco_start(__be32 vni_field)
	375	{
	376	return be32_to_cpu(vni_field & VXLAN_RCO_MASK) << VXLAN_RCO_SHIFT;
	377	}
	378
	379	static inline size_t vxlan_rco_offset(__be32 vni_field)
	380	{
	381	return (vni_field & VXLAN_RCO_UDP) ?
	382	offsetof(struct udphdr, check) :
	383	offsetof(struct tcphdr, check);
	384	}
	385
	386	static inline __be32 vxlan_compute_rco(unsigned int start, unsigned int offset)
	387	{
	388	__be32 vni_field = cpu_to_be32(start >> VXLAN_RCO_SHIFT);
	389
	390	if (offset == offsetof(struct udphdr, check))
	391	vni_field \|= VXLAN_RCO_UDP;
	392	return vni_field;
	393	}
	394
e6cd988c JG	395	static inline void vxlan_get_rx_port(struct net_device *netdev)
e6cd988c JG	396	{
b7aade15 HFS	397	ASSERT_RTNL();
b7aade15 HFS	398	call_netdevice_notifiers(NETDEV_OFFLOAD_PUSH_VXLAN, netdev);
e6cd988c	399	}
705cc62f JB	400
	401	static inline unsigned short vxlan_get_sk_family(struct vxlan_sock *vs)
	402	{
	403	return vs->sock->sk->sk_family;
	404	}
48e92c44 JB	405
48e92c44 JB	406	#endif