[mirror_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[];
};

/* Tunnel flow flags. */
#define OVS_TNL_F_DONT_FRAGMENT		(1 << 0)
#define OVS_TNL_F_CSUM			(1 << 1)
#define OVS_TNL_F_KEY			(1 << 2)

/* 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;
	u16  tun_flags;
	u8   ipv4_tos;
	u8   ipv4_ttl;
};

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(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 *,
		     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_TUNNEL                  0    --     4      4
 *  - OVS_TUNNEL_KEY_ATTR_ID             8    --     4     12
 *  - OVS_TUNNEL_KEY_ATTR_IPV4_SRC       4    --     4      8
 *  - OVS_TUNNEL_KEY_ATTR_IPV4_DST       4    --     4      8
 *  - OVS_TUNNEL_KEY_ATTR_TOS            1    3      4      8
 *  - OVS_TUNNEL_KEY_ATTR_TTL            1    3      4      8
 *  - OVS_TUNNEL_KEY_ATTR_DONT_FRAGMENT  0    --     4      4
 *  - OVS_TUNNEL_KEY_ATTR_CSUM           0    --     4      4
 *  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                                                 220
 */
#define FLOW_BUFSIZE 220

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];
int ipv4_tun_from_nlattr(const struct nlattr *attr,
			 struct ovs_key_ipv4_tunnel *tun_key);
int ipv4_tun_to_nlattr(struct sk_buff *skb,
			const struct ovs_key_ipv4_tunnel *tun_key);

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