[ovs.git] / datapath / flow.h

/*
 * Copyright (c) 2007-2011 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_actions {
	struct rcu_head rcu;
	u32 actions_len;
	struct nlattr actions[];
};

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_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 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 *);

struct sw_flow_actions *ovs_flow_actions_alloc(const struct nlattr *);
void ovs_flow_deferred_free_acts(struct sw_flow_actions *);

int ovs_flow_extract(struct sk_buff *, u16 in_port, struct sw_flow_key *,
		     int *key_lenp);
void ovs_flow_used(struct sw_flow *, struct sk_buff *);
u64 ovs_flow_used_time(unsigned long flow_jiffies);

/* Upper bound on the length of a nlattr-formatted flow key.  The longest
 * nlattr-formatted flow key would be:
 *
 *                         struct  pad  nl hdr  total
 *                         ------  ---  ------  -----
 *  OVS_KEY_ATTR_PRIORITY      4    --     4      8
 *  OVS_KEY_ATTR_TUN_ID        8    --     4     12
 *  OVS_KEY_ATTR_IPV4_TUNNEL  24    --     4     28
 *  OVS_KEY_ATTR_IN_PORT       4    --     4      8
 *  OVS_KEY_ATTR_SKB_MARK      4    --     4      8
 *  OVS_KEY_ATTR_ETHERNET     12    --     4     16
 *  OVS_KEY_ATTR_ETHERTYPE     2     2     4      8  (outer VLAN ethertype)
 *  OVS_KEY_ATTR_8021Q         4    --     4      8
 *  OVS_KEY_ATTR_ENCAP         0    --     4      4  (VLAN encapsulation)
 *  OVS_KEY_ATTR_ETHERTYPE     2     2     4      8  (inner VLAN ethertype)
 *  OVS_KEY_ATTR_IPV6         40    --     4     44
 *  OVS_KEY_ATTR_ICMPV6        2     2     4      8
 *  OVS_KEY_ATTR_ND           28    --     4     32
 *  -------------------------------------------------
 *  total                                       192
 */
#define FLOW_BUFSIZE 192

int ovs_flow_to_nlattrs(const struct sw_flow_key *, struct sk_buff *);
int ovs_flow_from_nlattrs(struct sw_flow_key *swkey, int *key_lenp,
		      const struct nlattr *);
int ovs_flow_metadata_from_nlattrs(struct sw_flow *flow, int key_len,
				   const struct nlattr *attr);

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

struct flow_table {
	struct flex_array *buckets;
	unsigned int count, n_buckets;
	struct rcu_head rcu;
	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_tbl_lookup(struct flow_table *table,
				    struct sw_flow_key *key, int len);
void ovs_flow_tbl_destroy(struct flow_table *table);
void ovs_flow_tbl_deferred_destroy(struct flow_table *table);
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_tbl_insert(struct flow_table *table, struct sw_flow *flow,
			 struct sw_flow_key *key, int key_len);
void ovs_flow_tbl_remove(struct flow_table *table, struct sw_flow *flow);

struct sw_flow *ovs_flow_tbl_next(struct flow_table *table, u32 *bucket, u32 *idx);
extern const int ovs_key_lens[OVS_KEY_ATTR_MAX + 1];

#endif /* flow.h */
Commit	Line	Data
a14bc59f	1	/*
e0edde6f	2	* Copyright (c) 2007-2011 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>
7257b535	33	#include <net/inet_ecn.h>
064af421 BP	34
	35	struct sk_buff;
	36
	37	struct sw_flow_actions {
	38	struct rcu_head rcu;
cdee00fd BP	39	u32 actions_len;
cdee00fd BP	40	struct nlattr actions[];
064af421 BP	41	};
064af421 BP	42
36956a7d	43	struct sw_flow_key {
6694e498	44	struct ovs_key_ipv4_tunnel tun_key; /* Encapsulating tunnel key. */
76abe283	45	struct {
abff858b	46	u32 priority; /* Packet QoS priority. */
72e8bf28	47	u32 skb_mark; /* SKB mark. */
95b1d73a	48	u16 in_port; /* Input switch port (or DP_MAX_PORTS). */
abff858b PS	49	} phy;
abff858b PS	50	struct {
76abe283 AE	51	u8 src[ETH_ALEN]; /* Ethernet source address. */
	52	u8 dst[ETH_ALEN]; /* Ethernet destination address. */
	53	__be16 tci; /* 0 if no VLAN, VLAN_TAG_PRESENT set otherwise. */
	54	__be16 type; /* Ethernet frame type. */
	55	} eth;
	56	struct {
28bad473	57	u8 proto; /* IP protocol or lower 8 bits of ARP opcode. */
3dc9baa0	58	u8 tos; /* IP ToS. */
b1672b4c JG	59	u8 ttl; /* IP TTL/hop limit. */
b1672b4c JG	60	u8 frag; /* One of OVS_FRAG_TYPE_. /
76abe283	61	} ip;
d31f1109 JP	62	union {
d31f1109 JP	63	struct {
76abe283 AE	64	struct {
	65	__be32 src; /* IP source address. */
	66	__be32 dst; /* IP destination address. */
	67	} addr;
	68	union {
	69	struct {
	70	__be16 src; /* TCP/UDP source port. */
	71	__be16 dst; /* TCP/UDP destination port. */
	72	} tp;
	73	struct {
	74	u8 sha[ETH_ALEN]; /* ARP source hardware address. */
	75	u8 tha[ETH_ALEN]; /* ARP target hardware address. */
	76	} arp;
	77	};
	78	} ipv4;
d31f1109	79	struct {
76abe283 AE	80	struct {
	81	struct in6_addr src; /* IPv6 source address. */
	82	struct in6_addr dst; /* IPv6 destination address. */
	83	} addr;
b1672b4c	84	__be32 label; /* IPv6 flow label. */
76abe283 AE	85	struct {
	86	__be16 src; /* TCP/UDP source port. */
	87	__be16 dst; /* TCP/UDP destination port. */
	88	} tp;
	89	struct {
	90	struct in6_addr target; /* ND target address. */
	91	u8 sll[ETH_ALEN]; /* ND source link layer address. */
	92	u8 tll[ETH_ALEN]; /* ND target link layer address. */
	93	} nd;
	94	} ipv6;
d31f1109	95	};
36956a7d BP	96	};
36956a7d BP	97
064af421 BP	98	struct sw_flow {
064af421 BP	99	struct rcu_head rcu;
acd051f1	100	struct hlist_node hash_node[2];
3544358a	101	u32 hash;
8d5ebd83	102
36956a7d	103	struct sw_flow_key key;
e1040c77	104	struct sw_flow_actions __rcu *sf_acts;
064af421	105
064af421	106	spinlock_t lock; /* Lock for values below. */
6bfafa55	107	unsigned long used; /* Last used time (in jiffies). */
064af421 BP	108	u64 packet_count; /* Number of packets matched. */
	109	u64 byte_count; /* Number of bytes matched. */
	110	u8 tcp_flags; /* Union of seen TCP flags. */
	111	};
	112
6455100f	113	struct arp_eth_header {
401eeb92 BP	114	__be16 ar_hrd; /* format of hardware address */
	115	__be16 ar_pro; /* format of protocol address */
	116	unsigned char ar_hln; /* length of hardware address */
	117	unsigned char ar_pln; /* length of protocol address */
	118	__be16 ar_op; /* ARP opcode (command) */
	119
	120	/* Ethernet+IPv4 specific members. */
	121	unsigned char ar_sha[ETH_ALEN]; /* sender hardware address */
	122	unsigned char ar_sip[4]; /* sender IP address */
	123	unsigned char ar_tha[ETH_ALEN]; /* target hardware address */
	124	unsigned char ar_tip[4]; /* target IP address */
961703de	125	} __packed;
401eeb92	126
850b6b3b JG	127	int ovs_flow_init(void);
850b6b3b JG	128	void ovs_flow_exit(void);
064af421	129
850b6b3b JG	130	struct sw_flow *ovs_flow_alloc(void);
850b6b3b JG	131	void ovs_flow_deferred_free(struct sw_flow *);
9321954a	132	void ovs_flow_free(struct sw_flow *);
560e8022	133
850b6b3b JG	134	struct sw_flow_actions ovs_flow_actions_alloc(const struct nlattr );
850b6b3b JG	135	void ovs_flow_deferred_free_acts(struct sw_flow_actions *);
560e8022	136
850b6b3b JG	137	int ovs_flow_extract(struct sk_buff , u16 in_port, struct sw_flow_key ,
	138	int *key_lenp);
	139	void ovs_flow_used(struct sw_flow , struct sk_buff );
	140	u64 ovs_flow_used_time(unsigned long flow_jiffies);
064af421	141
18c43631 JP	142	/* Upper bound on the length of a nlattr-formatted flow key. The longest
	143	* nlattr-formatted flow key would be:
	144	*
	145	* struct pad nl hdr total
	146	* ------ --- ------ -----
abff858b	147	* OVS_KEY_ATTR_PRIORITY 4 -- 4 8
df2c07f4	148	* OVS_KEY_ATTR_TUN_ID 8 -- 4 12
356af50b	149	* OVS_KEY_ATTR_IPV4_TUNNEL 24 -- 4 28
df2c07f4	150	* OVS_KEY_ATTR_IN_PORT 4 -- 4 8
72e8bf28	151	* OVS_KEY_ATTR_SKB_MARK 4 -- 4 8
df2c07f4	152	* OVS_KEY_ATTR_ETHERNET 12 -- 4 16
4f825a34	153	* OVS_KEY_ATTR_ETHERTYPE 2 2 4 8 (outer VLAN ethertype)
df2c07f4	154	* OVS_KEY_ATTR_8021Q 4 -- 4 8
4f825a34 JG	155	* OVS_KEY_ATTR_ENCAP 0 -- 4 4 (VLAN encapsulation)
4f825a34 JG	156	* OVS_KEY_ATTR_ETHERTYPE 2 2 4 8 (inner VLAN ethertype)
a61680c6	157	* OVS_KEY_ATTR_IPV6 40 -- 4 44
df2c07f4 JP	158	* OVS_KEY_ATTR_ICMPV6 2 2 4 8
df2c07f4 JP	159	* OVS_KEY_ATTR_ND 28 -- 4 32
18c43631	160	* -------------------------------------------------
72e8bf28	161	* total 192
36956a7d	162	*/
72e8bf28	163	#define FLOW_BUFSIZE 192
36956a7d	164
850b6b3b JG	165	int ovs_flow_to_nlattrs(const struct sw_flow_key , struct sk_buff );
850b6b3b JG	166	int ovs_flow_from_nlattrs(struct sw_flow_key swkey, int key_lenp,
76abe283	167	const struct nlattr *);
13e24889 PS	168	int ovs_flow_metadata_from_nlattrs(struct sw_flow *flow, int key_len,
13e24889 PS	169	const struct nlattr *attr);
36956a7d	170
95b1d73a	171	#define MAX_ACTIONS_BUFSIZE (16 * 1024)
3544358a PS	172	#define TBL_MIN_BUCKETS 1024
	173
	174	struct flow_table {
6455100f PS	175	struct flex_array *buckets;
	176	unsigned int count, n_buckets;
	177	struct rcu_head rcu;
acd051f1 PS	178	int node_ver;
	179	u32 hash_seed;
	180	bool keep_flows;
3544358a PS	181	};
3544358a PS	182
850b6b3b	183	static inline int ovs_flow_tbl_count(struct flow_table *table)
9d209493	184	{
3544358a	185	return table->count;
9d209493 BP	186	}
9d209493 BP	187
850b6b3b	188	static inline int ovs_flow_tbl_need_to_expand(struct flow_table *table)
3544358a PS	189	{
	190	return (table->count > table->n_buckets);
	191	}
	192
850b6b3b JG	193	struct sw_flow ovs_flow_tbl_lookup(struct flow_table table,
	194	struct sw_flow_key *key, int len);
	195	void ovs_flow_tbl_destroy(struct flow_table *table);
	196	void ovs_flow_tbl_deferred_destroy(struct flow_table *table);
	197	struct flow_table *ovs_flow_tbl_alloc(int new_size);
	198	struct flow_table ovs_flow_tbl_expand(struct flow_table table);
acd051f1	199	struct flow_table ovs_flow_tbl_rehash(struct flow_table table);
13e24889 PS	200	void ovs_flow_tbl_insert(struct flow_table table, struct sw_flow flow,
13e24889 PS	201	struct sw_flow_key *key, int key_len);
850b6b3b	202	void ovs_flow_tbl_remove(struct flow_table table, struct sw_flow flow);
850b6b3b JG	203
850b6b3b JG	204	struct sw_flow ovs_flow_tbl_next(struct flow_table table, u32 bucket, u32 idx);
4094406f	205	extern const int ovs_key_lens[OVS_KEY_ATTR_MAX + 1];
3544358a	206
064af421	207	#endif /* flow.h */