[mirror_ovs.git] / datapath / 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>
#include <net/ip_tunnels.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 source port. */
					__be16 dst;		/* TCP/UDP 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 source port. */
				__be16 dst;		/* TCP/UDP 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;
	};
};

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;
};

static inline u16 ovs_sw_flow_key_range_actual_size(const struct sw_flow_key_range *range)
{
	return range->end - range->start;
}

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_len);

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;
};

static inline u16
ovs_sw_flow_mask_actual_size(const struct sw_flow_mask *mask)
{
	return ovs_sw_flow_key_range_actual_size(&mask->range);
}

static inline u16
ovs_sw_flow_mask_size_roundup(const struct sw_flow_mask *mask)
{
	return roundup(ovs_sw_flow_mask_actual_size(mask), sizeof(u32));
}

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
a14bc59f	1	/*
a1c564be	2	* Copyright (c) 2007-2013 Nicira, Inc.
a14bc59f	3	*
a9a29d22 JG	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
a14bc59f BP	17	*/
a14bc59f BP	18
064af421 BP	19	#ifndef FLOW_H
	20	#define FLOW_H 1
	21
	22	#include <linux/kernel.h>
78d18dbb	23	#include <linux/netlink.h>
077257b8	24	#include <linux/openvswitch.h>
064af421 BP	25	#include <linux/spinlock.h>
	26	#include <linux/types.h>
	27	#include <linux/rcupdate.h>
401eeb92	28	#include <linux/if_ether.h>
bfef4717	29	#include <linux/in6.h>
6bfafa55	30	#include <linux/jiffies.h>
5153ef3d	31	#include <linux/time.h>
3544358a	32	#include <linux/flex_array.h>
5ebaf571	33
7257b535	34	#include <net/inet_ecn.h>
5ebaf571	35	#include <net/ip_tunnels.h>
064af421 BP	36
064af421 BP	37	struct sk_buff;
a1c564be AZ	38	struct sw_flow_mask;
a1c564be AZ	39	struct flow_table;
064af421 BP	40
	41	struct sw_flow_actions {
	42	struct rcu_head rcu;
cdee00fd BP	43	u32 actions_len;
cdee00fd BP	44	struct nlattr actions[];
064af421 BP	45	};
064af421 BP	46
fa54c2d9 PS	47	/* Used to memset ovs_key_ipv4_tunnel padding. */
	48	#define OVS_TUNNEL_KEY_SIZE \
	49	(offsetof(struct ovs_key_ipv4_tunnel, ipv4_ttl) + \
	50	FIELD_SIZEOF(struct ovs_key_ipv4_tunnel, ipv4_ttl))
	51
9b405f1a PS	52	struct ovs_key_ipv4_tunnel {
	53	__be64 tun_id;
	54	__be32 ipv4_src;
	55	__be32 ipv4_dst;
5ebaf571	56	__be16 tun_flags;
9b405f1a PS	57	u8 ipv4_tos;
	58	u8 ipv4_ttl;
	59	};
	60
adda018c PS	61	static inline void ovs_flow_tun_key_init(struct ovs_key_ipv4_tunnel *tun_key,
	62	const struct iphdr *iph, __be64 tun_id,
	63	__be16 tun_flags)
	64	{
	65	tun_key->tun_id = tun_id;
	66	tun_key->ipv4_src = iph->saddr;
	67	tun_key->ipv4_dst = iph->daddr;
	68	tun_key->ipv4_tos = iph->tos;
	69	tun_key->ipv4_ttl = iph->ttl;
	70	tun_key->tun_flags = tun_flags;
	71
	72	/* clear struct padding. */
	73	memset((unsigned char *) tun_key + OVS_TUNNEL_KEY_SIZE, 0,
	74	sizeof(*tun_key) - OVS_TUNNEL_KEY_SIZE);
	75	}
	76
36956a7d	77	struct sw_flow_key {
6694e498	78	struct ovs_key_ipv4_tunnel tun_key; /* Encapsulating tunnel key. */
76abe283	79	struct {
abff858b	80	u32 priority; /* Packet QoS priority. */
72e8bf28	81	u32 skb_mark; /* SKB mark. */
95b1d73a	82	u16 in_port; /* Input switch port (or DP_MAX_PORTS). */
abff858b PS	83	} phy;
abff858b PS	84	struct {
76abe283 AE	85	u8 src[ETH_ALEN]; /* Ethernet source address. */
	86	u8 dst[ETH_ALEN]; /* Ethernet destination address. */
	87	__be16 tci; /* 0 if no VLAN, VLAN_TAG_PRESENT set otherwise. */
	88	__be16 type; /* Ethernet frame type. */
	89	} eth;
	90	struct {
28bad473	91	u8 proto; /* IP protocol or lower 8 bits of ARP opcode. */
3dc9baa0	92	u8 tos; /* IP ToS. */
b1672b4c JG	93	u8 ttl; /* IP TTL/hop limit. */
b1672b4c JG	94	u8 frag; /* One of OVS_FRAG_TYPE_. /
76abe283	95	} ip;
d31f1109 JP	96	union {
d31f1109 JP	97	struct {
76abe283 AE	98	struct {
	99	__be32 src; /* IP source address. */
	100	__be32 dst; /* IP destination address. */
	101	} addr;
	102	union {
	103	struct {
	104	__be16 src; /* TCP/UDP source port. */
	105	__be16 dst; /* TCP/UDP destination port. */
	106	} tp;
	107	struct {
	108	u8 sha[ETH_ALEN]; /* ARP source hardware address. */
	109	u8 tha[ETH_ALEN]; /* ARP target hardware address. */
	110	} arp;
	111	};
	112	} ipv4;
d31f1109	113	struct {
76abe283 AE	114	struct {
	115	struct in6_addr src; /* IPv6 source address. */
	116	struct in6_addr dst; /* IPv6 destination address. */
	117	} addr;
b1672b4c	118	__be32 label; /* IPv6 flow label. */
76abe283 AE	119	struct {
	120	__be16 src; /* TCP/UDP source port. */
	121	__be16 dst; /* TCP/UDP destination port. */
	122	} tp;
	123	struct {
	124	struct in6_addr target; /* ND target address. */
	125	u8 sll[ETH_ALEN]; /* ND source link layer address. */
	126	u8 tll[ETH_ALEN]; /* ND target link layer address. */
	127	} nd;
	128	} ipv6;
d31f1109	129	};
36956a7d BP	130	};
36956a7d BP	131
064af421 BP	132	struct sw_flow {
064af421 BP	133	struct rcu_head rcu;
acd051f1	134	struct hlist_node hash_node[2];
3544358a	135	u32 hash;
8d5ebd83	136
36956a7d	137	struct sw_flow_key key;
a1c564be	138	struct sw_flow_key unmasked_key;
3d097064	139	struct sw_flow_mask *mask;
e1040c77	140	struct sw_flow_actions __rcu *sf_acts;
064af421	141
064af421	142	spinlock_t lock; /* Lock for values below. */
6bfafa55	143	unsigned long used; /* Last used time (in jiffies). */
064af421 BP	144	u64 packet_count; /* Number of packets matched. */
	145	u64 byte_count; /* Number of bytes matched. */
	146	u8 tcp_flags; /* Union of seen TCP flags. */
	147	};
	148
a1c564be AZ	149	struct sw_flow_key_range {
	150	size_t start;
	151	size_t end;
	152	};
	153
	154	static inline u16 ovs_sw_flow_key_range_actual_size(const struct sw_flow_key_range *range)
	155	{
	156	return range->end - range->start;
	157	}
	158
	159	struct sw_flow_match {
	160	struct sw_flow_key *key;
	161	struct sw_flow_key_range range;
	162	struct sw_flow_mask *mask;
	163	};
	164
	165	void ovs_match_init(struct sw_flow_match *match,
	166	struct sw_flow_key key, struct sw_flow_mask mask);
	167
6455100f	168	struct arp_eth_header {
401eeb92 BP	169	__be16 ar_hrd; /* format of hardware address */
	170	__be16 ar_pro; /* format of protocol address */
	171	unsigned char ar_hln; /* length of hardware address */
	172	unsigned char ar_pln; /* length of protocol address */
	173	__be16 ar_op; /* ARP opcode (command) */
	174
	175	/* Ethernet+IPv4 specific members. */
	176	unsigned char ar_sha[ETH_ALEN]; /* sender hardware address */
	177	unsigned char ar_sip[4]; /* sender IP address */
	178	unsigned char ar_tha[ETH_ALEN]; /* target hardware address */
	179	unsigned char ar_tip[4]; /* target IP address */
961703de	180	} __packed;
401eeb92	181
850b6b3b JG	182	int ovs_flow_init(void);
850b6b3b JG	183	void ovs_flow_exit(void);
064af421	184
850b6b3b JG	185	struct sw_flow *ovs_flow_alloc(void);
850b6b3b JG	186	void ovs_flow_deferred_free(struct sw_flow *);
a1c564be	187	void ovs_flow_free(struct sw_flow *, bool deferred);
560e8022	188
9b405f1a	189	struct sw_flow_actions *ovs_flow_actions_alloc(int actions_len);
850b6b3b	190	void ovs_flow_deferred_free_acts(struct sw_flow_actions *);
560e8022	191
a1c564be	192	int ovs_flow_extract(struct sk_buff , u16 in_port, struct sw_flow_key );
850b6b3b JG	193	void ovs_flow_used(struct sw_flow , struct sk_buff );
850b6b3b JG	194	u64 ovs_flow_used_time(unsigned long flow_jiffies);
a1c564be AZ	195	int ovs_flow_to_nlattrs(const struct sw_flow_key *,
	196	const struct sw_flow_key , struct sk_buff );
	197	int ovs_match_from_nlattrs(struct sw_flow_match *match,
	198	const struct nlattr *,
76abe283	199	const struct nlattr *);
a1c564be AZ	200	int ovs_flow_metadata_from_nlattrs(struct sw_flow *flow,
a1c564be AZ	201	const struct nlattr *attr);
36956a7d	202
9ccb22ec	203	#define MAX_ACTIONS_BUFSIZE (32 * 1024)
3544358a PS	204	#define TBL_MIN_BUCKETS 1024
	205
	206	struct flow_table {
6455100f PS	207	struct flex_array *buckets;
	208	unsigned int count, n_buckets;
	209	struct rcu_head rcu;
ede77a46	210	struct list_head *mask_list;
acd051f1 PS	211	int node_ver;
	212	u32 hash_seed;
	213	bool keep_flows;
3544358a PS	214	};
3544358a PS	215
850b6b3b	216	static inline int ovs_flow_tbl_count(struct flow_table *table)
9d209493	217	{
3544358a	218	return table->count;
9d209493 BP	219	}
9d209493 BP	220
850b6b3b	221	static inline int ovs_flow_tbl_need_to_expand(struct flow_table *table)
3544358a PS	222	{
	223	return (table->count > table->n_buckets);
	224	}
	225
a1c564be AZ	226	struct sw_flow ovs_flow_lookup(struct flow_table ,
	227	const struct sw_flow_key *);
	228	struct sw_flow ovs_flow_lookup_unmasked_key(struct flow_table table,
	229	struct sw_flow_match *match);
	230
	231	void ovs_flow_tbl_destroy(struct flow_table *table, bool deferred);
850b6b3b JG	232	struct flow_table *ovs_flow_tbl_alloc(int new_size);
850b6b3b JG	233	struct flow_table ovs_flow_tbl_expand(struct flow_table table);
acd051f1	234	struct flow_table ovs_flow_tbl_rehash(struct flow_table table);
a1c564be	235
529db635	236	void ovs_flow_insert(struct flow_table table, struct sw_flow flow);
a1c564be	237	void ovs_flow_remove(struct flow_table table, struct sw_flow flow);
850b6b3b	238
a1c564be	239	struct sw_flow ovs_flow_dump_next(struct flow_table table, u32 bucket, u32 idx);
4094406f	240	extern const int ovs_key_lens[OVS_KEY_ATTR_MAX + 1];
54cc3ec6 JG	241	int ovs_ipv4_tun_from_nlattr(const struct nlattr *attr,
	242	struct sw_flow_match *match, bool is_mask);
	243	int ovs_ipv4_tun_to_nlattr(struct sk_buff *skb,
	244	const struct ovs_key_ipv4_tunnel *tun_key,
	245	const struct ovs_key_ipv4_tunnel *output);
a1c564be AZ	246
	247	bool ovs_flow_cmp_unmasked_key(const struct sw_flow *flow,
	248	const struct sw_flow_key *key, int key_len);
	249
	250	struct sw_flow_mask {
	251	int ref_count;
	252	struct rcu_head rcu;
	253	struct list_head list;
	254	struct sw_flow_key_range range;
	255	struct sw_flow_key key;
	256	};
	257
	258	static inline u16
	259	ovs_sw_flow_mask_actual_size(const struct sw_flow_mask *mask)
	260	{
	261	return ovs_sw_flow_key_range_actual_size(&mask->range);
	262	}
	263
	264	static inline u16
	265	ovs_sw_flow_mask_size_roundup(const struct sw_flow_mask *mask)
	266	{
	267	return roundup(ovs_sw_flow_mask_actual_size(mask), sizeof(u32));
	268	}
3544358a	269
a1c564be AZ	270	struct sw_flow_mask *ovs_sw_flow_mask_alloc(void);
	271	void ovs_sw_flow_mask_add_ref(struct sw_flow_mask *);
	272	void ovs_sw_flow_mask_del_ref(struct sw_flow_mask *, bool deferred);
	273	void ovs_sw_flow_mask_insert(struct flow_table , struct sw_flow_mask );
	274	struct sw_flow_mask ovs_sw_flow_mask_find(const struct flow_table ,
	275	const struct sw_flow_mask *);
529db635 JG	276	void ovs_flow_key_mask(struct sw_flow_key dst, const struct sw_flow_key src,
529db635 JG	277	const struct sw_flow_mask *mask);
064af421	278	#endif /* flow.h */