[mirror_ubuntu-zesty-kernel.git] / net / openvswitch / flow.h

/*
 * Copyright (c) 2007-2014 Nicira, Inc.
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of version 2 of the GNU General Public
 * License as published by the Free Software Foundation.
 *
 * This program 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; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
 * 02110-1301, USA
 */

#ifndef FLOW_H
#define FLOW_H 1

#include <linux/cache.h>
#include <linux/kernel.h>
#include <linux/netlink.h>
#include <linux/openvswitch.h>
#include <linux/spinlock.h>
#include <linux/types.h>
#include <linux/rcupdate.h>
#include <linux/if_ether.h>
#include <linux/in6.h>
#include <linux/jiffies.h>
#include <linux/time.h>
#include <linux/flex_array.h>
#include <net/inet_ecn.h>

struct sk_buff;

/* Used to memset ovs_key_ipv4_tunnel padding. */
#define OVS_TUNNEL_KEY_SIZE					\
	(offsetof(struct ovs_key_ipv4_tunnel, tp_dst) +		\
	 FIELD_SIZEOF(struct ovs_key_ipv4_tunnel, tp_dst))

struct ovs_key_ipv4_tunnel {
	__be64 tun_id;
	__be32 ipv4_src;
	__be32 ipv4_dst;
	__be16 tun_flags;
	u8   ipv4_tos;
	u8   ipv4_ttl;
	__be16 tp_src;
	__be16 tp_dst;
} __packed __aligned(4); /* Minimize padding. */

struct ovs_tunnel_info {
	struct ovs_key_ipv4_tunnel tunnel;
	const void *options;
	u8 options_len;
};

/* Store options at the end of the array if they are less than the
 * maximum size. This allows us to get the benefits of variable length
 * matching for small options.
 */
#define TUN_METADATA_OFFSET(opt_len) \
	(FIELD_SIZEOF(struct sw_flow_key, tun_opts) - opt_len)
#define TUN_METADATA_OPTS(flow_key, opt_len) \
	((void *)((flow_key)->tun_opts + TUN_METADATA_OFFSET(opt_len)))

static inline void __ovs_flow_tun_info_init(struct ovs_tunnel_info *tun_info,
					    __be32 saddr, __be32 daddr,
					    u8 tos, u8 ttl,
					    __be16 tp_src,
					    __be16 tp_dst,
					    __be64 tun_id,
					    __be16 tun_flags,
					    const void *opts,
					    u8 opts_len)
{
	tun_info->tunnel.tun_id = tun_id;
	tun_info->tunnel.ipv4_src = saddr;
	tun_info->tunnel.ipv4_dst = daddr;
	tun_info->tunnel.ipv4_tos = tos;
	tun_info->tunnel.ipv4_ttl = ttl;
	tun_info->tunnel.tun_flags = tun_flags;

	/* For the tunnel types on the top of IPsec, the tp_src and tp_dst of
	 * the upper tunnel are used.
	 * E.g: GRE over IPSEC, the tp_src and tp_port are zero.
	 */
	tun_info->tunnel.tp_src = tp_src;
	tun_info->tunnel.tp_dst = tp_dst;

	/* Clear struct padding. */
	if (sizeof(tun_info->tunnel) != OVS_TUNNEL_KEY_SIZE)
		memset((unsigned char *)&tun_info->tunnel + OVS_TUNNEL_KEY_SIZE,
		       0, sizeof(tun_info->tunnel) - OVS_TUNNEL_KEY_SIZE);

	tun_info->options = opts;
	tun_info->options_len = opts_len;
}

static inline void ovs_flow_tun_info_init(struct ovs_tunnel_info *tun_info,
					  const struct iphdr *iph,
					  __be16 tp_src,
					  __be16 tp_dst,
					  __be64 tun_id,
					  __be16 tun_flags,
					  const void *opts,
					  u8 opts_len)
{
	__ovs_flow_tun_info_init(tun_info, iph->saddr, iph->daddr,
				 iph->tos, iph->ttl,
				 tp_src, tp_dst,
				 tun_id, tun_flags,
				 opts, opts_len);
}

#define OVS_SW_FLOW_KEY_METADATA_SIZE			\
	(offsetof(struct sw_flow_key, recirc_id) +	\
	FIELD_SIZEOF(struct sw_flow_key, recirc_id))

struct sw_flow_key {
	u8 tun_opts[255];
	u8 tun_opts_len;
	struct ovs_key_ipv4_tunnel tun_key;  /* Encapsulating tunnel key. */
	struct {
		u32	priority;	/* Packet QoS priority. */
		u32	skb_mark;	/* SKB mark. */
		u16	in_port;	/* Input switch port (or DP_MAX_PORTS). */
	} __packed phy; /* Safe when right after 'tun_key'. */
	u32 ovs_flow_hash;		/* Datapath computed hash value.  */
	u32 recirc_id;			/* Recirculation ID.  */
	struct {
		u8     src[ETH_ALEN];	/* Ethernet source address. */
		u8     dst[ETH_ALEN];	/* Ethernet destination address. */
		__be16 tci;		/* 0 if no VLAN, VLAN_TAG_PRESENT set otherwise. */
		__be16 type;		/* Ethernet frame type. */
	} eth;
	union {
		struct {
			__be32 top_lse;	/* top label stack entry */
		} mpls;
		struct {
			u8     proto;	/* IP protocol or lower 8 bits of ARP opcode. */
			u8     tos;	    /* IP ToS. */
			u8     ttl;	    /* IP TTL/hop limit. */
			u8     frag;	/* One of OVS_FRAG_TYPE_*. */
		} ip;
	};
	struct {
		__be16 src;		/* TCP/UDP/SCTP source port. */
		__be16 dst;		/* TCP/UDP/SCTP destination port. */
		__be16 flags;		/* TCP flags. */
	} tp;
	union {
		struct {
			struct {
				__be32 src;	/* IP source address. */
				__be32 dst;	/* IP destination address. */
			} addr;
			struct {
				u8 sha[ETH_ALEN];	/* ARP source hardware address. */
				u8 tha[ETH_ALEN];	/* ARP target hardware address. */
			} arp;
		} ipv4;
		struct {
			struct {
				struct in6_addr src;	/* IPv6 source address. */
				struct in6_addr dst;	/* IPv6 destination address. */
			} addr;
			__be32 label;			/* IPv6 flow label. */
			struct {
				struct in6_addr target;	/* ND target address. */
				u8 sll[ETH_ALEN];	/* ND source link layer address. */
				u8 tll[ETH_ALEN];	/* ND target link layer address. */
			} nd;
		} ipv6;
	};
} __aligned(BITS_PER_LONG/8); /* Ensure that we can do comparisons as longs. */

struct sw_flow_key_range {
	unsigned short int start;
	unsigned short int end;
};

struct sw_flow_mask {
	int ref_count;
	struct rcu_head rcu;
	struct list_head list;
	struct sw_flow_key_range range;
	struct sw_flow_key key;
};

struct sw_flow_match {
	struct sw_flow_key *key;
	struct sw_flow_key_range range;
	struct sw_flow_mask *mask;
};

#define MAX_UFID_LENGTH 16 /* 128 bits */

struct sw_flow_id {
	u32 ufid_len;
	union {
		u32 ufid[MAX_UFID_LENGTH / 4];
		struct sw_flow_key *unmasked_key;
	};
};

struct sw_flow_actions {
	struct rcu_head rcu;
	u32 actions_len;
	struct nlattr actions[];
};

struct flow_stats {
	u64 packet_count;		/* Number of packets matched. */
	u64 byte_count;			/* Number of bytes matched. */
	unsigned long used;		/* Last used time (in jiffies). */
	spinlock_t lock;		/* Lock for atomic stats update. */
	__be16 tcp_flags;		/* Union of seen TCP flags. */
};

struct sw_flow {
	struct rcu_head rcu;
	struct {
		struct hlist_node node[2];
		u32 hash;
	} flow_table, ufid_table;
	int stats_last_writer;		/* NUMA-node id of the last writer on
					 * 'stats[0]'.
					 */
	struct sw_flow_key key;
	struct sw_flow_id id;
	struct sw_flow_mask *mask;
	struct sw_flow_actions __rcu *sf_acts;
	struct flow_stats __rcu *stats[]; /* One for each NUMA node.  First one
					   * is allocated at flow creation time,
					   * the rest are allocated on demand
					   * while holding the 'stats[0].lock'.
					   */
};

struct arp_eth_header {
	__be16      ar_hrd;	/* format of hardware address   */
	__be16      ar_pro;	/* format of protocol address   */
	unsigned char   ar_hln;	/* length of hardware address   */
	unsigned char   ar_pln;	/* length of protocol address   */
	__be16      ar_op;	/* ARP opcode (command)     */

	/* Ethernet+IPv4 specific members. */
	unsigned char       ar_sha[ETH_ALEN];	/* sender hardware address  */
	unsigned char       ar_sip[4];		/* sender IP address        */
	unsigned char       ar_tha[ETH_ALEN];	/* target hardware address  */
	unsigned char       ar_tip[4];		/* target IP address        */
} __packed;

static inline bool ovs_identifier_is_ufid(const struct sw_flow_id *sfid)
{
	return sfid->ufid_len;
}

static inline bool ovs_identifier_is_key(const struct sw_flow_id *sfid)
{
	return !ovs_identifier_is_ufid(sfid);
}

void ovs_flow_stats_update(struct sw_flow *, __be16 tcp_flags,
			   const struct sk_buff *);
void ovs_flow_stats_get(const struct sw_flow *, struct ovs_flow_stats *,
			unsigned long *used, __be16 *tcp_flags);
void ovs_flow_stats_clear(struct sw_flow *);
u64 ovs_flow_used_time(unsigned long flow_jiffies);

int ovs_flow_key_update(struct sk_buff *skb, struct sw_flow_key *key);
int ovs_flow_key_extract(const struct ovs_tunnel_info *tun_info,
			 struct sk_buff *skb,
			 struct sw_flow_key *key);
/* Extract key from packet coming from userspace. */
int ovs_flow_key_extract_userspace(const struct nlattr *attr,
				   struct sk_buff *skb,
				   struct sw_flow_key *key, bool log);

#endif /* flow.h */
Commit	Line	Data
ccb1352e	1	/*
ad552007	2	* Copyright (c) 2007-2014 Nicira, Inc.
ccb1352e JG	3	*
	4	* This program is free software; you can redistribute it and/or
	5	* modify it under the terms of version 2 of the GNU General Public
	6	* License as published by the Free Software Foundation.
	7	*
	8	* This program is distributed in the hope that it will be useful, but
	9	* WITHOUT ANY WARRANTY; without even the implied warranty of
	10	* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
	11	* General Public License for more details.
	12	*
	13	* You should have received a copy of the GNU General Public License
	14	* along with this program; if not, write to the Free Software
	15	* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
	16	* 02110-1301, USA
	17	*/
	18
	19	#ifndef FLOW_H
	20	#define FLOW_H 1
	21
e298e505	22	#include <linux/cache.h>
ccb1352e JG	23	#include <linux/kernel.h>
	24	#include <linux/netlink.h>
	25	#include <linux/openvswitch.h>
	26	#include <linux/spinlock.h>
	27	#include <linux/types.h>
	28	#include <linux/rcupdate.h>
	29	#include <linux/if_ether.h>
	30	#include <linux/in6.h>
	31	#include <linux/jiffies.h>
	32	#include <linux/time.h>
	33	#include <linux/flex_array.h>
	34	#include <net/inet_ecn.h>
	35
	36	struct sk_buff;
ccb1352e	37
7d5437c7 PS	38	/* Used to memset ovs_key_ipv4_tunnel padding. */
7d5437c7 PS	39	#define OVS_TUNNEL_KEY_SIZE \
8f0aad6f WZ	40	(offsetof(struct ovs_key_ipv4_tunnel, tp_dst) + \
8f0aad6f WZ	41	FIELD_SIZEOF(struct ovs_key_ipv4_tunnel, tp_dst))
7d5437c7 PS	42
	43	struct ovs_key_ipv4_tunnel {
	44	__be64 tun_id;
	45	__be32 ipv4_src;
	46	__be32 ipv4_dst;
aa310701	47	__be16 tun_flags;
7d5437c7 PS	48	u8 ipv4_tos;
7d5437c7 PS	49	u8 ipv4_ttl;
8f0aad6f WZ	50	__be16 tp_src;
8f0aad6f WZ	51	__be16 tp_dst;
1139e241	52	} __packed __aligned(4); /* Minimize padding. */
7d5437c7	53
f0b128c1 JG	54	struct ovs_tunnel_info {
f0b128c1 JG	55	struct ovs_key_ipv4_tunnel tunnel;
d91641d9	56	const void *options;
f5796684	57	u8 options_len;
f0b128c1 JG	58	};
f0b128c1 JG	59
f5796684 JG	60	/* Store options at the end of the array if they are less than the
	61	* maximum size. This allows us to get the benefits of variable length
	62	* matching for small options.
	63	*/
d91641d9 TG	64	#define TUN_METADATA_OFFSET(opt_len) \
	65	(FIELD_SIZEOF(struct sw_flow_key, tun_opts) - opt_len)
	66	#define TUN_METADATA_OPTS(flow_key, opt_len) \
	67	((void *)((flow_key)->tun_opts + TUN_METADATA_OFFSET(opt_len)))
f5796684	68
8f0aad6f WZ	69	static inline void __ovs_flow_tun_info_init(struct ovs_tunnel_info *tun_info,
	70	__be32 saddr, __be32 daddr,
	71	u8 tos, u8 ttl,
	72	__be16 tp_src,
	73	__be16 tp_dst,
	74	__be64 tun_id,
	75	__be16 tun_flags,
d91641d9	76	const void *opts,
8f0aad6f	77	u8 opts_len)
aa310701	78	{
f0b128c1	79	tun_info->tunnel.tun_id = tun_id;
8f0aad6f WZ	80	tun_info->tunnel.ipv4_src = saddr;
	81	tun_info->tunnel.ipv4_dst = daddr;
	82	tun_info->tunnel.ipv4_tos = tos;
	83	tun_info->tunnel.ipv4_ttl = ttl;
f0b128c1	84	tun_info->tunnel.tun_flags = tun_flags;
aa310701	85
8f0aad6f WZ	86	/* For the tunnel types on the top of IPsec, the tp_src and tp_dst of
	87	* the upper tunnel are used.
	88	* E.g: GRE over IPSEC, the tp_src and tp_port are zero.
	89	*/
	90	tun_info->tunnel.tp_src = tp_src;
	91	tun_info->tunnel.tp_dst = tp_dst;
	92
	93	/* Clear struct padding. */
	94	if (sizeof(tun_info->tunnel) != OVS_TUNNEL_KEY_SIZE)
	95	memset((unsigned char *)&tun_info->tunnel + OVS_TUNNEL_KEY_SIZE,
	96	0, sizeof(tun_info->tunnel) - OVS_TUNNEL_KEY_SIZE);
f5796684 JG	97
	98	tun_info->options = opts;
	99	tun_info->options_len = opts_len;
aa310701 PS	100	}
aa310701 PS	101
8f0aad6f WZ	102	static inline void ovs_flow_tun_info_init(struct ovs_tunnel_info *tun_info,
	103	const struct iphdr *iph,
	104	__be16 tp_src,
	105	__be16 tp_dst,
	106	__be64 tun_id,
	107	__be16 tun_flags,
d91641d9	108	const void *opts,
8f0aad6f WZ	109	u8 opts_len)
	110	{
	111	__ovs_flow_tun_info_init(tun_info, iph->saddr, iph->daddr,
	112	iph->tos, iph->ttl,
	113	tp_src, tp_dst,
	114	tun_id, tun_flags,
	115	opts, opts_len);
	116	}
	117
	118	#define OVS_SW_FLOW_KEY_METADATA_SIZE \
	119	(offsetof(struct sw_flow_key, recirc_id) + \
	120	FIELD_SIZEOF(struct sw_flow_key, recirc_id))
	121
ccb1352e	122	struct sw_flow_key {
f5796684 JG	123	u8 tun_opts[255];
f5796684 JG	124	u8 tun_opts_len;
7d5437c7	125	struct ovs_key_ipv4_tunnel tun_key; /* Encapsulating tunnel key. */
ccb1352e JG	126	struct {
ccb1352e JG	127	u32 priority; /* Packet QoS priority. */
39c7caeb	128	u32 skb_mark; /* SKB mark. */
15eac2a7	129	u16 in_port; /* Input switch port (or DP_MAX_PORTS). */
1139e241	130	} __packed phy; /* Safe when right after 'tun_key'. */
971427f3 AZ	131	u32 ovs_flow_hash; /* Datapath computed hash value. */
971427f3 AZ	132	u32 recirc_id; /* Recirculation ID. */
ccb1352e JG	133	struct {
	134	u8 src[ETH_ALEN]; /* Ethernet source address. */
	135	u8 dst[ETH_ALEN]; /* Ethernet destination address. */
	136	__be16 tci; /* 0 if no VLAN, VLAN_TAG_PRESENT set otherwise. */
	137	__be16 type; /* Ethernet frame type. */
	138	} eth;
25cd9ba0 SH	139	union {
	140	struct {
	141	__be32 top_lse; /* top label stack entry */
	142	} mpls;
	143	struct {
	144	u8 proto; /* IP protocol or lower 8 bits of ARP opcode. */
	145	u8 tos; /* IP ToS. */
	146	u8 ttl; /* IP TTL/hop limit. */
	147	u8 frag; /* One of OVS_FRAG_TYPE_. /
	148	} ip;
	149	};
1139e241 JR	150	struct {
	151	__be16 src; /* TCP/UDP/SCTP source port. */
	152	__be16 dst; /* TCP/UDP/SCTP destination port. */
	153	__be16 flags; /* TCP flags. */
	154	} tp;
ccb1352e JG	155	union {
	156	struct {
	157	struct {
	158	__be32 src; /* IP source address. */
	159	__be32 dst; /* IP destination address. */
	160	} addr;
1139e241 JR	161	struct {
	162	u8 sha[ETH_ALEN]; /* ARP source hardware address. */
	163	u8 tha[ETH_ALEN]; /* ARP target hardware address. */
	164	} arp;
ccb1352e JG	165	} ipv4;
	166	struct {
	167	struct {
	168	struct in6_addr src; /* IPv6 source address. */
	169	struct in6_addr dst; /* IPv6 destination address. */
	170	} addr;
	171	__be32 label; /* IPv6 flow label. */
ccb1352e JG	172	struct {
	173	struct in6_addr target; /* ND target address. */
	174	u8 sll[ETH_ALEN]; /* ND source link layer address. */
	175	u8 tll[ETH_ALEN]; /* ND target link layer address. */
	176	} nd;
	177	} ipv6;
	178	};
0d40f75b	179	} __aligned(BITS_PER_LONG/8); /* Ensure that we can do comparisons as longs. */
ccb1352e	180
e6445719	181	struct sw_flow_key_range {
8f49ce11 BP	182	unsigned short int start;
8f49ce11 BP	183	unsigned short int end;
e6445719 PS	184	};
	185
	186	struct sw_flow_mask {
	187	int ref_count;
	188	struct rcu_head rcu;
	189	struct list_head list;
	190	struct sw_flow_key_range range;
	191	struct sw_flow_key key;
	192	};
	193
	194	struct sw_flow_match {
	195	struct sw_flow_key *key;
	196	struct sw_flow_key_range range;
	197	struct sw_flow_mask *mask;
	198	};
	199
74ed7ab9 JS	200	#define MAX_UFID_LENGTH 16 /* 128 bits */
	201
	202	struct sw_flow_id {
	203	u32 ufid_len;
	204	union {
	205	u32 ufid[MAX_UFID_LENGTH / 4];
	206	struct sw_flow_key *unmasked_key;
	207	};
	208	};
	209
e6445719 PS	210	struct sw_flow_actions {
	211	struct rcu_head rcu;
	212	u32 actions_len;
	213	struct nlattr actions[];
	214	};
	215
e298e505 PS	216	struct flow_stats {
	217	u64 packet_count; /* Number of packets matched. */
	218	u64 byte_count; /* Number of bytes matched. */
	219	unsigned long used; /* Last used time (in jiffies). */
	220	spinlock_t lock; /* Lock for atomic stats update. */
	221	__be16 tcp_flags; /* Union of seen TCP flags. */
	222	};
	223
ccb1352e JG	224	struct sw_flow {
ccb1352e JG	225	struct rcu_head rcu;
74ed7ab9 JS	226	struct {
	227	struct hlist_node node[2];
	228	u32 hash;
	229	} flow_table, ufid_table;
63e7959c JR	230	int stats_last_writer; /* NUMA-node id of the last writer on
	231	* 'stats[0]'.
	232	*/
ccb1352e	233	struct sw_flow_key key;
74ed7ab9	234	struct sw_flow_id id;
03f0d916	235	struct sw_flow_mask *mask;
ccb1352e	236	struct sw_flow_actions __rcu *sf_acts;
63e7959c JR	237	struct flow_stats __rcu stats[]; / One for each NUMA node. First one
	238	* is allocated at flow creation time,
	239	* the rest are allocated on demand
	240	* while holding the 'stats[0].lock'.
	241	*/
ccb1352e JG	242	};
	243
	244	struct arp_eth_header {
	245	__be16 ar_hrd; /* format of hardware address */
	246	__be16 ar_pro; /* format of protocol address */
	247	unsigned char ar_hln; /* length of hardware address */
	248	unsigned char ar_pln; /* length of protocol address */
	249	__be16 ar_op; /* ARP opcode (command) */
	250
	251	/* Ethernet+IPv4 specific members. */
	252	unsigned char ar_sha[ETH_ALEN]; /* sender hardware address */
	253	unsigned char ar_sip[4]; /* sender IP address */
	254	unsigned char ar_tha[ETH_ALEN]; /* target hardware address */
	255	unsigned char ar_tip[4]; /* target IP address */
	256	} __packed;
	257
74ed7ab9 JS	258	static inline bool ovs_identifier_is_ufid(const struct sw_flow_id *sfid)
	259	{
	260	return sfid->ufid_len;
	261	}
	262
	263	static inline bool ovs_identifier_is_key(const struct sw_flow_id *sfid)
	264	{
	265	return !ovs_identifier_is_ufid(sfid);
	266	}
	267
ad552007	268	void ovs_flow_stats_update(struct sw_flow *, __be16 tcp_flags,
12eb18f7	269	const struct sk_buff *);
86ec8dba	270	void ovs_flow_stats_get(const struct sw_flow , struct ovs_flow_stats ,
e298e505	271	unsigned long used, __be16 tcp_flags);
86ec8dba	272	void ovs_flow_stats_clear(struct sw_flow *);
ccb1352e	273	u64 ovs_flow_used_time(unsigned long flow_jiffies);
ccb1352e	274
971427f3	275	int ovs_flow_key_update(struct sk_buff skb, struct sw_flow_key key);
12eb18f7 TG	276	int ovs_flow_key_extract(const struct ovs_tunnel_info *tun_info,
12eb18f7 TG	277	struct sk_buff *skb,
f0b128c1	278	struct sw_flow_key *key);
83c8df26 PS	279	/* Extract key from packet coming from userspace. */
	280	int ovs_flow_key_extract_userspace(const struct nlattr *attr,
	281	struct sk_buff *skb,
05da5898	282	struct sw_flow_key *key, bool log);
03f0d916	283
ccb1352e	284	#endif /* flow.h */