[mirror_ubuntu-artful-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>
#include <net/ip_tunnels.h>
#include <net/dst_metadata.h>

struct sk_buff;

enum sw_flow_mac_proto {
	MAC_PROTO_NONE = 0,
	MAC_PROTO_ETHERNET,
};
#define SW_FLOW_KEY_INVALID	0x80

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

struct ovs_tunnel_info {
	struct metadata_dst	*tun_dst;
};

struct vlan_head {
	__be16 tpid; /* Vlan type. Generally 802.1q or 802.1ad.*/
	__be16 tci;  /* 0 if no VLAN, VLAN_TAG_PRESENT set otherwise. */
};

#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[IP_TUNNEL_OPTS_MAX];
	u8 tun_opts_len;
	struct ip_tunnel_key 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'. */
	u8 mac_proto;			/* MAC layer protocol (e.g. Ethernet). */
	u8 tun_proto;			/* Protocol of encapsulating tunnel. */
	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. */
		struct vlan_head vlan;
		struct vlan_head cvlan;
		__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;
	};
	struct {
		/* Connection tracking fields. */
		u16 zone;
		u32 mark;
		u8 state;
		struct ovs_key_ct_labels labels;
	} ct;

} __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;
	size_t orig_len;	/* From flow_cmd_new netlink actions size */
	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;		/* CPU 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 CPU.  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 u8 ovs_key_mac_proto(const struct sw_flow_key *key)
{
	return key->mac_proto & ~SW_FLOW_KEY_INVALID;
}

static inline u16 __ovs_mac_header_len(u8 mac_proto)
{
	return mac_proto == MAC_PROTO_ETHERNET ? ETH_HLEN : 0;
}

static inline u16 ovs_mac_header_len(const struct sw_flow_key *key)
{
	return __ovs_mac_header_len(ovs_key_mac_proto(key));
}

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 ip_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(struct net *net, 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>
1d8fff90	35	#include <net/ip_tunnels.h>
34ae932a	36	#include <net/dst_metadata.h>
ccb1352e JG	37
ccb1352e JG	38	struct sk_buff;
ccb1352e	39
329f45bc JB	40	enum sw_flow_mac_proto {
	41	MAC_PROTO_NONE = 0,
	42	MAC_PROTO_ETHERNET,
	43	};
	44	#define SW_FLOW_KEY_INVALID 0x80
	45
f5796684 JG	46	/* Store options at the end of the array if they are less than the
	47	* maximum size. This allows us to get the benefits of variable length
	48	* matching for small options.
	49	*/
d91641d9 TG	50	#define TUN_METADATA_OFFSET(opt_len) \
	51	(FIELD_SIZEOF(struct sw_flow_key, tun_opts) - opt_len)
	52	#define TUN_METADATA_OPTS(flow_key, opt_len) \
	53	((void *)((flow_key)->tun_opts + TUN_METADATA_OFFSET(opt_len)))
f5796684	54
34ae932a TG	55	struct ovs_tunnel_info {
	56	struct metadata_dst *tun_dst;
	57	};
	58
018c1dda EG	59	struct vlan_head {
	60	__be16 tpid; /* Vlan type. Generally 802.1q or 802.1ad.*/
	61	__be16 tci; /* 0 if no VLAN, VLAN_TAG_PRESENT set otherwise. */
	62	};
	63
8f0aad6f WZ	64	#define OVS_SW_FLOW_KEY_METADATA_SIZE \
	65	(offsetof(struct sw_flow_key, recirc_id) + \
	66	FIELD_SIZEOF(struct sw_flow_key, recirc_id))
	67
ccb1352e	68	struct sw_flow_key {
fca5fdf6	69	u8 tun_opts[IP_TUNNEL_OPTS_MAX];
f5796684	70	u8 tun_opts_len;
1d8fff90	71	struct ip_tunnel_key tun_key; /* Encapsulating tunnel key. */
ccb1352e JG	72	struct {
ccb1352e JG	73	u32 priority; /* Packet QoS priority. */
39c7caeb	74	u32 skb_mark; /* SKB mark. */
15eac2a7	75	u16 in_port; /* Input switch port (or DP_MAX_PORTS). */
1139e241	76	} __packed phy; /* Safe when right after 'tun_key'. */
329f45bc	77	u8 mac_proto; /* MAC layer protocol (e.g. Ethernet). */
00a93bab	78	u8 tun_proto; /* Protocol of encapsulating tunnel. */
971427f3 AZ	79	u32 ovs_flow_hash; /* Datapath computed hash value. */
971427f3 AZ	80	u32 recirc_id; /* Recirculation ID. */
ccb1352e JG	81	struct {
	82	u8 src[ETH_ALEN]; /* Ethernet source address. */
	83	u8 dst[ETH_ALEN]; /* Ethernet destination address. */
018c1dda EG	84	struct vlan_head vlan;
018c1dda EG	85	struct vlan_head cvlan;
ccb1352e JG	86	__be16 type; /* Ethernet frame type. */
ccb1352e JG	87	} eth;
25cd9ba0 SH	88	union {
	89	struct {
	90	__be32 top_lse; /* top label stack entry */
	91	} mpls;
	92	struct {
	93	u8 proto; /* IP protocol or lower 8 bits of ARP opcode. */
	94	u8 tos; /* IP ToS. */
	95	u8 ttl; /* IP TTL/hop limit. */
	96	u8 frag; /* One of OVS_FRAG_TYPE_. /
	97	} ip;
	98	};
1139e241 JR	99	struct {
	100	__be16 src; /* TCP/UDP/SCTP source port. */
	101	__be16 dst; /* TCP/UDP/SCTP destination port. */
	102	__be16 flags; /* TCP flags. */
	103	} tp;
ccb1352e JG	104	union {
	105	struct {
	106	struct {
	107	__be32 src; /* IP source address. */
	108	__be32 dst; /* IP destination address. */
	109	} addr;
1139e241 JR	110	struct {
	111	u8 sha[ETH_ALEN]; /* ARP source hardware address. */
	112	u8 tha[ETH_ALEN]; /* ARP target hardware address. */
	113	} arp;
ccb1352e JG	114	} ipv4;
	115	struct {
	116	struct {
	117	struct in6_addr src; /* IPv6 source address. */
	118	struct in6_addr dst; /* IPv6 destination address. */
	119	} addr;
	120	__be32 label; /* IPv6 flow label. */
ccb1352e JG	121	struct {
	122	struct in6_addr target; /* ND target address. */
	123	u8 sll[ETH_ALEN]; /* ND source link layer address. */
	124	u8 tll[ETH_ALEN]; /* ND target link layer address. */
	125	} nd;
	126	} ipv6;
	127	};
7f8a436e JS	128	struct {
	129	/* Connection tracking fields. */
	130	u16 zone;
182e3042	131	u32 mark;
7f8a436e	132	u8 state;
33db4125	133	struct ovs_key_ct_labels labels;
7f8a436e JS	134	} ct;
7f8a436e JS	135
0d40f75b	136	} __aligned(BITS_PER_LONG/8); /* Ensure that we can do comparisons as longs. */
ccb1352e	137
e6445719	138	struct sw_flow_key_range {
8f49ce11 BP	139	unsigned short int start;
8f49ce11 BP	140	unsigned short int end;
e6445719 PS	141	};
	142
	143	struct sw_flow_mask {
	144	int ref_count;
	145	struct rcu_head rcu;
	146	struct list_head list;
	147	struct sw_flow_key_range range;
	148	struct sw_flow_key key;
	149	};
	150
	151	struct sw_flow_match {
	152	struct sw_flow_key *key;
	153	struct sw_flow_key_range range;
	154	struct sw_flow_mask *mask;
	155	};
	156
74ed7ab9 JS	157	#define MAX_UFID_LENGTH 16 /* 128 bits */
	158
	159	struct sw_flow_id {
	160	u32 ufid_len;
	161	union {
	162	u32 ufid[MAX_UFID_LENGTH / 4];
	163	struct sw_flow_key *unmasked_key;
	164	};
	165	};
	166
e6445719 PS	167	struct sw_flow_actions {
e6445719 PS	168	struct rcu_head rcu;
8e2fed1c	169	size_t orig_len; /* From flow_cmd_new netlink actions size */
e6445719 PS	170	u32 actions_len;
	171	struct nlattr actions[];
	172	};
	173
e298e505 PS	174	struct flow_stats {
	175	u64 packet_count; /* Number of packets matched. */
	176	u64 byte_count; /* Number of bytes matched. */
	177	unsigned long used; /* Last used time (in jiffies). */
	178	spinlock_t lock; /* Lock for atomic stats update. */
	179	__be16 tcp_flags; /* Union of seen TCP flags. */
	180	};
	181
ccb1352e JG	182	struct sw_flow {
ccb1352e JG	183	struct rcu_head rcu;
74ed7ab9 JS	184	struct {
	185	struct hlist_node node[2];
	186	u32 hash;
	187	} flow_table, ufid_table;
db74a333	188	int stats_last_writer; /* CPU id of the last writer on
63e7959c JR	189	* 'stats[0]'.
63e7959c JR	190	*/
ccb1352e	191	struct sw_flow_key key;
74ed7ab9	192	struct sw_flow_id id;
03f0d916	193	struct sw_flow_mask *mask;
ccb1352e	194	struct sw_flow_actions __rcu *sf_acts;
db74a333	195	struct flow_stats __rcu stats[]; / One for each CPU. First one
63e7959c JR	196	* is allocated at flow creation time,
	197	* the rest are allocated on demand
	198	* while holding the 'stats[0].lock'.
	199	*/
ccb1352e JG	200	};
	201
	202	struct arp_eth_header {
	203	__be16 ar_hrd; /* format of hardware address */
	204	__be16 ar_pro; /* format of protocol address */
	205	unsigned char ar_hln; /* length of hardware address */
	206	unsigned char ar_pln; /* length of protocol address */
	207	__be16 ar_op; /* ARP opcode (command) */
	208
	209	/* Ethernet+IPv4 specific members. */
	210	unsigned char ar_sha[ETH_ALEN]; /* sender hardware address */
	211	unsigned char ar_sip[4]; /* sender IP address */
	212	unsigned char ar_tha[ETH_ALEN]; /* target hardware address */
	213	unsigned char ar_tip[4]; /* target IP address */
	214	} __packed;
	215
329f45bc JB	216	static inline u8 ovs_key_mac_proto(const struct sw_flow_key *key)
	217	{
	218	return key->mac_proto & ~SW_FLOW_KEY_INVALID;
	219	}
	220
	221	static inline u16 __ovs_mac_header_len(u8 mac_proto)
	222	{
	223	return mac_proto == MAC_PROTO_ETHERNET ? ETH_HLEN : 0;
	224	}
	225
	226	static inline u16 ovs_mac_header_len(const struct sw_flow_key *key)
	227	{
	228	return __ovs_mac_header_len(ovs_key_mac_proto(key));
	229	}
	230
74ed7ab9 JS	231	static inline bool ovs_identifier_is_ufid(const struct sw_flow_id *sfid)
	232	{
	233	return sfid->ufid_len;
	234	}
	235
	236	static inline bool ovs_identifier_is_key(const struct sw_flow_id *sfid)
	237	{
	238	return !ovs_identifier_is_ufid(sfid);
	239	}
	240
ad552007	241	void ovs_flow_stats_update(struct sw_flow *, __be16 tcp_flags,
12eb18f7	242	const struct sk_buff *);
86ec8dba	243	void ovs_flow_stats_get(const struct sw_flow , struct ovs_flow_stats ,
e298e505	244	unsigned long used, __be16 tcp_flags);
86ec8dba	245	void ovs_flow_stats_clear(struct sw_flow *);
ccb1352e	246	u64 ovs_flow_used_time(unsigned long flow_jiffies);
ccb1352e	247
971427f3	248	int ovs_flow_key_update(struct sk_buff skb, struct sw_flow_key key);
1d8fff90	249	int ovs_flow_key_extract(const struct ip_tunnel_info *tun_info,
12eb18f7	250	struct sk_buff *skb,
f0b128c1	251	struct sw_flow_key *key);
83c8df26	252	/* Extract key from packet coming from userspace. */
c2ac6673	253	int ovs_flow_key_extract_userspace(struct net net, const struct nlattr attr,
83c8df26	254	struct sk_buff *skb,
05da5898	255	struct sw_flow_key *key, bool log);
03f0d916	256
ccb1352e	257	#endif /* flow.h */