[deliverable/linux.git] / net / openvswitch / flow.h

/*
 * Copyright (c) 2007-2013 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/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;
struct sw_flow_mask;
struct flow_table;

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

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

struct ovs_key_ipv4_tunnel {
	__be64 tun_id;
	__be32 ipv4_src;
	__be32 ipv4_dst;
	__be16 tun_flags;
	u8   ipv4_tos;
	u8   ipv4_ttl;
};

static inline void ovs_flow_tun_key_init(struct ovs_key_ipv4_tunnel *tun_key,
					 const struct iphdr *iph, __be64 tun_id,
					 __be16 tun_flags)
{
	tun_key->tun_id = tun_id;
	tun_key->ipv4_src = iph->saddr;
	tun_key->ipv4_dst = iph->daddr;
	tun_key->ipv4_tos = iph->tos;
	tun_key->ipv4_ttl = iph->ttl;
	tun_key->tun_flags = tun_flags;

	/* clear struct padding. */
	memset((unsigned char *) tun_key + OVS_TUNNEL_KEY_SIZE, 0,
	       sizeof(*tun_key) - OVS_TUNNEL_KEY_SIZE);
}

struct sw_flow_key {
	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). */
	} phy;
	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;
	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;
	union {
		struct {
			struct {
				__be32 src;	/* IP source address. */
				__be32 dst;	/* IP destination address. */
			} addr;
			union {
				struct {
					__be16 src;		/* TCP/UDP/SCTP source port. */
					__be16 dst;		/* TCP/UDP/SCTP destination port. */
				} tp;
				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 {
				__be16 src;		/* TCP/UDP/SCTP source port. */
				__be16 dst;		/* TCP/UDP/SCTP destination port. */
			} tp;
			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 {
	struct rcu_head rcu;
	struct hlist_node hash_node[2];
	u32 hash;

	struct sw_flow_key key;
	struct sw_flow_key unmasked_key;
	struct sw_flow_mask *mask;
	struct sw_flow_actions __rcu *sf_acts;

	spinlock_t lock;	/* Lock for values below. */
	unsigned long used;	/* Last used time (in jiffies). */
	u64 packet_count;	/* Number of packets matched. */
	u64 byte_count;		/* Number of bytes matched. */
	u8 tcp_flags;		/* Union of seen TCP flags. */
};

struct sw_flow_key_range {
	size_t start;
	size_t end;
};

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

void ovs_match_init(struct sw_flow_match *match,
		struct sw_flow_key *key, struct sw_flow_mask *mask);

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;

int ovs_flow_init(void);
void ovs_flow_exit(void);

struct sw_flow *ovs_flow_alloc(void);
void ovs_flow_deferred_free(struct sw_flow *);
void ovs_flow_free(struct sw_flow *, bool deferred);

struct sw_flow_actions *ovs_flow_actions_alloc(int actions_len);
void ovs_flow_deferred_free_acts(struct sw_flow_actions *);

int ovs_flow_extract(struct sk_buff *, u16 in_port, struct sw_flow_key *);
void ovs_flow_used(struct sw_flow *, struct sk_buff *);
u64 ovs_flow_used_time(unsigned long flow_jiffies);
int ovs_flow_to_nlattrs(const struct sw_flow_key *,
		const struct sw_flow_key *, struct sk_buff *);
int ovs_match_from_nlattrs(struct sw_flow_match *match,
		      const struct nlattr *,
		      const struct nlattr *);
int ovs_flow_metadata_from_nlattrs(struct sw_flow *flow,
		const struct nlattr *attr);

#define MAX_ACTIONS_BUFSIZE    (32 * 1024)
#define TBL_MIN_BUCKETS		1024

struct flow_table {
	struct flex_array *buckets;
	unsigned int count, n_buckets;
	struct rcu_head rcu;
	struct list_head *mask_list;
	int node_ver;
	u32 hash_seed;
	bool keep_flows;
};

static inline int ovs_flow_tbl_count(struct flow_table *table)
{
	return table->count;
}

static inline int ovs_flow_tbl_need_to_expand(struct flow_table *table)
{
	return (table->count > table->n_buckets);
}

struct sw_flow *ovs_flow_lookup(struct flow_table *,
				const struct sw_flow_key *);
struct sw_flow *ovs_flow_lookup_unmasked_key(struct flow_table *table,
				    struct sw_flow_match *match);

void ovs_flow_tbl_destroy(struct flow_table *table, bool deferred);
struct flow_table *ovs_flow_tbl_alloc(int new_size);
struct flow_table *ovs_flow_tbl_expand(struct flow_table *table);
struct flow_table *ovs_flow_tbl_rehash(struct flow_table *table);

void ovs_flow_insert(struct flow_table *table, struct sw_flow *flow);
void ovs_flow_remove(struct flow_table *table, struct sw_flow *flow);

struct sw_flow *ovs_flow_dump_next(struct flow_table *table, u32 *bucket, u32 *idx);
extern const int ovs_key_lens[OVS_KEY_ATTR_MAX + 1];
int ovs_ipv4_tun_from_nlattr(const struct nlattr *attr,
			     struct sw_flow_match *match, bool is_mask);
int ovs_ipv4_tun_to_nlattr(struct sk_buff *skb,
			   const struct ovs_key_ipv4_tunnel *tun_key,
			   const struct ovs_key_ipv4_tunnel *output);

bool ovs_flow_cmp_unmasked_key(const struct sw_flow *flow,
		const struct sw_flow_key *key, int key_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_mask *ovs_sw_flow_mask_alloc(void);
void ovs_sw_flow_mask_add_ref(struct sw_flow_mask *);
void ovs_sw_flow_mask_del_ref(struct sw_flow_mask *, bool deferred);
void ovs_sw_flow_mask_insert(struct flow_table *, struct sw_flow_mask *);
struct sw_flow_mask *ovs_sw_flow_mask_find(const struct flow_table *,
		const struct sw_flow_mask *);
void ovs_flow_key_mask(struct sw_flow_key *dst, const struct sw_flow_key *src,
		       const struct sw_flow_mask *mask);
#endif /* flow.h */
Commit	Line	Data
ccb1352e	1	/*
03f0d916	2	* Copyright (c) 2007-2013 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
	22	#include <linux/kernel.h>
	23	#include <linux/netlink.h>
	24	#include <linux/openvswitch.h>
	25	#include <linux/spinlock.h>
	26	#include <linux/types.h>
	27	#include <linux/rcupdate.h>
	28	#include <linux/if_ether.h>
	29	#include <linux/in6.h>
	30	#include <linux/jiffies.h>
	31	#include <linux/time.h>
	32	#include <linux/flex_array.h>
	33	#include <net/inet_ecn.h>
	34
	35	struct sk_buff;
03f0d916 AZ	36	struct sw_flow_mask;
03f0d916 AZ	37	struct flow_table;
ccb1352e JG	38
	39	struct sw_flow_actions {
	40	struct rcu_head rcu;
	41	u32 actions_len;
	42	struct nlattr actions[];
	43	};
	44
7d5437c7 PS	45	/* Used to memset ovs_key_ipv4_tunnel padding. */
	46	#define OVS_TUNNEL_KEY_SIZE \
	47	(offsetof(struct ovs_key_ipv4_tunnel, ipv4_ttl) + \
	48	FIELD_SIZEOF(struct ovs_key_ipv4_tunnel, ipv4_ttl))
	49
	50	struct ovs_key_ipv4_tunnel {
	51	__be64 tun_id;
	52	__be32 ipv4_src;
	53	__be32 ipv4_dst;
aa310701	54	__be16 tun_flags;
7d5437c7 PS	55	u8 ipv4_tos;
	56	u8 ipv4_ttl;
	57	};
	58
aa310701 PS	59	static inline void ovs_flow_tun_key_init(struct ovs_key_ipv4_tunnel *tun_key,
	60	const struct iphdr *iph, __be64 tun_id,
	61	__be16 tun_flags)
	62	{
	63	tun_key->tun_id = tun_id;
	64	tun_key->ipv4_src = iph->saddr;
	65	tun_key->ipv4_dst = iph->daddr;
	66	tun_key->ipv4_tos = iph->tos;
	67	tun_key->ipv4_ttl = iph->ttl;
	68	tun_key->tun_flags = tun_flags;
	69
	70	/* clear struct padding. */
	71	memset((unsigned char *) tun_key + OVS_TUNNEL_KEY_SIZE, 0,
	72	sizeof(*tun_key) - OVS_TUNNEL_KEY_SIZE);
	73	}
	74
ccb1352e	75	struct sw_flow_key {
7d5437c7	76	struct ovs_key_ipv4_tunnel tun_key; /* Encapsulating tunnel key. */
ccb1352e JG	77	struct {
ccb1352e JG	78	u32 priority; /* Packet QoS priority. */
39c7caeb	79	u32 skb_mark; /* SKB mark. */
15eac2a7	80	u16 in_port; /* Input switch port (or DP_MAX_PORTS). */
ccb1352e JG	81	} phy;
	82	struct {
	83	u8 src[ETH_ALEN]; /* Ethernet source address. */
	84	u8 dst[ETH_ALEN]; /* Ethernet destination address. */
	85	__be16 tci; /* 0 if no VLAN, VLAN_TAG_PRESENT set otherwise. */
	86	__be16 type; /* Ethernet frame type. */
	87	} eth;
	88	struct {
	89	u8 proto; /* IP protocol or lower 8 bits of ARP opcode. */
	90	u8 tos; /* IP ToS. */
	91	u8 ttl; /* IP TTL/hop limit. */
	92	u8 frag; /* One of OVS_FRAG_TYPE_. /
	93	} ip;
	94	union {
	95	struct {
	96	struct {
	97	__be32 src; /* IP source address. */
	98	__be32 dst; /* IP destination address. */
	99	} addr;
	100	union {
	101	struct {
a175a723 JS	102	__be16 src; /* TCP/UDP/SCTP source port. */
a175a723 JS	103	__be16 dst; /* TCP/UDP/SCTP destination port. */
ccb1352e JG	104	} tp;
	105	struct {
	106	u8 sha[ETH_ALEN]; /* ARP source hardware address. */
	107	u8 tha[ETH_ALEN]; /* ARP target hardware address. */
	108	} arp;
	109	};
	110	} ipv4;
	111	struct {
	112	struct {
	113	struct in6_addr src; /* IPv6 source address. */
	114	struct in6_addr dst; /* IPv6 destination address. */
	115	} addr;
	116	__be32 label; /* IPv6 flow label. */
	117	struct {
a175a723 JS	118	__be16 src; /* TCP/UDP/SCTP source port. */
a175a723 JS	119	__be16 dst; /* TCP/UDP/SCTP destination port. */
ccb1352e JG	120	} tp;
	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	};
0d40f75b	128	} __aligned(BITS_PER_LONG/8); /* Ensure that we can do comparisons as longs. */
ccb1352e JG	129
	130	struct sw_flow {
	131	struct rcu_head rcu;
	132	struct hlist_node hash_node[2];
	133	u32 hash;
	134
	135	struct sw_flow_key key;
03f0d916 AZ	136	struct sw_flow_key unmasked_key;
03f0d916 AZ	137	struct sw_flow_mask *mask;
ccb1352e JG	138	struct sw_flow_actions __rcu *sf_acts;
	139
	140	spinlock_t lock; /* Lock for values below. */
	141	unsigned long used; /* Last used time (in jiffies). */
	142	u64 packet_count; /* Number of packets matched. */
	143	u64 byte_count; /* Number of bytes matched. */
	144	u8 tcp_flags; /* Union of seen TCP flags. */
	145	};
	146
03f0d916 AZ	147	struct sw_flow_key_range {
	148	size_t start;
	149	size_t end;
	150	};
	151
03f0d916 AZ	152	struct sw_flow_match {
	153	struct sw_flow_key *key;
	154	struct sw_flow_key_range range;
	155	struct sw_flow_mask *mask;
	156	};
	157
	158	void ovs_match_init(struct sw_flow_match *match,
	159	struct sw_flow_key key, struct sw_flow_mask mask);
	160
ccb1352e JG	161	struct arp_eth_header {
	162	__be16 ar_hrd; /* format of hardware address */
	163	__be16 ar_pro; /* format of protocol address */
	164	unsigned char ar_hln; /* length of hardware address */
	165	unsigned char ar_pln; /* length of protocol address */
	166	__be16 ar_op; /* ARP opcode (command) */
	167
	168	/* Ethernet+IPv4 specific members. */
	169	unsigned char ar_sha[ETH_ALEN]; /* sender hardware address */
	170	unsigned char ar_sip[4]; /* sender IP address */
	171	unsigned char ar_tha[ETH_ALEN]; /* target hardware address */
	172	unsigned char ar_tip[4]; /* target IP address */
	173	} __packed;
	174
	175	int ovs_flow_init(void);
	176	void ovs_flow_exit(void);
	177
	178	struct sw_flow *ovs_flow_alloc(void);
	179	void ovs_flow_deferred_free(struct sw_flow *);
03f0d916	180	void ovs_flow_free(struct sw_flow *, bool deferred);
ccb1352e	181
74f84a57	182	struct sw_flow_actions *ovs_flow_actions_alloc(int actions_len);
ccb1352e JG	183	void ovs_flow_deferred_free_acts(struct sw_flow_actions *);
ccb1352e JG	184
03f0d916	185	int ovs_flow_extract(struct sk_buff , u16 in_port, struct sw_flow_key );
ccb1352e JG	186	void ovs_flow_used(struct sw_flow , struct sk_buff );
ccb1352e JG	187	u64 ovs_flow_used_time(unsigned long flow_jiffies);
03f0d916 AZ	188	int ovs_flow_to_nlattrs(const struct sw_flow_key *,
	189	const struct sw_flow_key , struct sk_buff );
	190	int ovs_match_from_nlattrs(struct sw_flow_match *match,
	191	const struct nlattr *,
ccb1352e	192	const struct nlattr *);
03f0d916 AZ	193	int ovs_flow_metadata_from_nlattrs(struct sw_flow *flow,
03f0d916 AZ	194	const struct nlattr *attr);
ccb1352e	195
ffe3f432	196	#define MAX_ACTIONS_BUFSIZE (32 * 1024)
ccb1352e JG	197	#define TBL_MIN_BUCKETS 1024
	198
	199	struct flow_table {
	200	struct flex_array *buckets;
	201	unsigned int count, n_buckets;
	202	struct rcu_head rcu;
03f0d916	203	struct list_head *mask_list;
ccb1352e JG	204	int node_ver;
	205	u32 hash_seed;
	206	bool keep_flows;
	207	};
	208
	209	static inline int ovs_flow_tbl_count(struct flow_table *table)
	210	{
	211	return table->count;
	212	}
	213
	214	static inline int ovs_flow_tbl_need_to_expand(struct flow_table *table)
	215	{
	216	return (table->count > table->n_buckets);
	217	}
	218
03f0d916 AZ	219	struct sw_flow ovs_flow_lookup(struct flow_table ,
	220	const struct sw_flow_key *);
	221	struct sw_flow ovs_flow_lookup_unmasked_key(struct flow_table table,
	222	struct sw_flow_match *match);
	223
	224	void ovs_flow_tbl_destroy(struct flow_table *table, bool deferred);
ccb1352e JG	225	struct flow_table *ovs_flow_tbl_alloc(int new_size);
	226	struct flow_table ovs_flow_tbl_expand(struct flow_table table);
	227	struct flow_table ovs_flow_tbl_rehash(struct flow_table table);
ccb1352e	228
03f0d916 AZ	229	void ovs_flow_insert(struct flow_table table, struct sw_flow flow);
	230	void ovs_flow_remove(struct flow_table table, struct sw_flow flow);
	231
	232	struct sw_flow ovs_flow_dump_next(struct flow_table table, u32 bucket, u32 idx);
ccb1352e	233	extern const int ovs_key_lens[OVS_KEY_ATTR_MAX + 1];
7d5437c7	234	int ovs_ipv4_tun_from_nlattr(const struct nlattr *attr,
03f0d916	235	struct sw_flow_match *match, bool is_mask);
7d5437c7	236	int ovs_ipv4_tun_to_nlattr(struct sk_buff *skb,
03f0d916 AZ	237	const struct ovs_key_ipv4_tunnel *tun_key,
	238	const struct ovs_key_ipv4_tunnel *output);
	239
	240	bool ovs_flow_cmp_unmasked_key(const struct sw_flow *flow,
02237373	241	const struct sw_flow_key *key, int key_end);
03f0d916 AZ	242
	243	struct sw_flow_mask {
	244	int ref_count;
	245	struct rcu_head rcu;
	246	struct list_head list;
	247	struct sw_flow_key_range range;
	248	struct sw_flow_key key;
	249	};
	250
03f0d916 AZ	251	struct sw_flow_mask *ovs_sw_flow_mask_alloc(void);
	252	void ovs_sw_flow_mask_add_ref(struct sw_flow_mask *);
	253	void ovs_sw_flow_mask_del_ref(struct sw_flow_mask *, bool deferred);
	254	void ovs_sw_flow_mask_insert(struct flow_table , struct sw_flow_mask );
	255	struct sw_flow_mask ovs_sw_flow_mask_find(const struct flow_table ,
	256	const struct sw_flow_mask *);
	257	void ovs_flow_key_mask(struct sw_flow_key dst, const struct sw_flow_key src,
	258	const struct sw_flow_mask *mask);
ccb1352e	259	#endif /* flow.h */