[mirror_ovs.git] / datapath / flow.h

/*
 * Copyright (c) 2007-2015 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;

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

#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[255];
	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'. */
	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. */
		__be16 tci;		/* 0 if no VLAN, VLAN_TAG_PRESENT set otherwise. */
		__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_label label;
	} 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 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;		/* NUMA-node 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 NUMA node.  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 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);

/* Update the non-metadata part of the flow key using skb. */
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
a14bc59f	1	/*
e23775f2	2	* Copyright (c) 2007-2015 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
b0b906cc	22	#include <linux/cache.h>
064af421	23	#include <linux/kernel.h>
78d18dbb	24	#include <linux/netlink.h>
077257b8	25	#include <linux/openvswitch.h>
064af421 BP	26	#include <linux/spinlock.h>
	27	#include <linux/types.h>
	28	#include <linux/rcupdate.h>
401eeb92	29	#include <linux/if_ether.h>
bfef4717	30	#include <linux/in6.h>
6bfafa55	31	#include <linux/jiffies.h>
5153ef3d	32	#include <linux/time.h>
3544358a	33	#include <linux/flex_array.h>
7257b535	34	#include <net/inet_ecn.h>
e23775f2 PS	35	#include <net/ip_tunnels.h>
e23775f2 PS	36	#include <net/dst_metadata.h>
064af421 BP	37
064af421 BP	38	struct sk_buff;
064af421	39
c1fc1411 JG	40	/* Store options at the end of the array if they are less than the
	41	* maximum size. This allows us to get the benefits of variable length
	42	* matching for small options.
	43	*/
4b163224 TG	44	#define TUN_METADATA_OFFSET(opt_len) \
	45	(FIELD_SIZEOF(struct sw_flow_key, tun_opts) - opt_len)
	46	#define TUN_METADATA_OPTS(flow_key, opt_len) \
	47	((void *)((flow_key)->tun_opts + TUN_METADATA_OFFSET(opt_len)))
	48
e23775f2 PS	49	struct ovs_tunnel_info {
	50	struct metadata_dst *tun_dst;
	51	};
8b7ea2d4	52
7f45215a PS	53	#define OVS_SW_FLOW_KEY_METADATA_SIZE \
	54	(offsetof(struct sw_flow_key, recirc_id) + \
	55	FIELD_SIZEOF(struct sw_flow_key, recirc_id))
	56
36956a7d	57	struct sw_flow_key {
c1fc1411 JG	58	u8 tun_opts[255];
c1fc1411 JG	59	u8 tun_opts_len;
e23775f2	60	struct ip_tunnel_key tun_key; /* Encapsulating tunnel key. */
76abe283	61	struct {
abff858b	62	u32 priority; /* Packet QoS priority. */
72e8bf28	63	u32 skb_mark; /* SKB mark. */
95b1d73a	64	u16 in_port; /* Input switch port (or DP_MAX_PORTS). */
708fb4c5	65	} __packed phy; /* Safe when right after 'tun_key'. */
7804df20	66	u32 ovs_flow_hash; /* Datapath computed hash value. */
a6059080	67	u32 recirc_id; /* Recirculation ID. */
abff858b	68	struct {
76abe283 AE	69	u8 src[ETH_ALEN]; /* Ethernet source address. */
	70	u8 dst[ETH_ALEN]; /* Ethernet destination address. */
	71	__be16 tci; /* 0 if no VLAN, VLAN_TAG_PRESENT set otherwise. */
	72	__be16 type; /* Ethernet frame type. */
	73	} eth;
ccf43786 SH	74	union {
ccf43786 SH	75	struct {
7d16c847	76	__be32 top_lse; /* top label stack entry */
ccf43786 SH	77	} mpls;
ccf43786 SH	78	struct {
7d16c847 PS	79	u8 proto; /* IP protocol or lower 8 bits of ARP opcode. */
	80	u8 tos; /* IP ToS. */
	81	u8 ttl; /* IP TTL/hop limit. */
	82	u8 frag; /* One of OVS_FRAG_TYPE_. /
ccf43786 SH	83	} ip;
ccf43786 SH	84	};
708fb4c5 JR	85	struct {
	86	__be16 src; /* TCP/UDP/SCTP source port. */
	87	__be16 dst; /* TCP/UDP/SCTP destination port. */
	88	__be16 flags; /* TCP flags. */
	89	} tp;
d31f1109 JP	90	union {
d31f1109 JP	91	struct {
76abe283 AE	92	struct {
	93	__be32 src; /* IP source address. */
	94	__be32 dst; /* IP destination address. */
	95	} addr;
708fb4c5 JR	96	struct {
	97	u8 sha[ETH_ALEN]; /* ARP source hardware address. */
	98	u8 tha[ETH_ALEN]; /* ARP target hardware address. */
	99	} arp;
76abe283	100	} ipv4;
d31f1109	101	struct {
76abe283 AE	102	struct {
	103	struct in6_addr src; /* IPv6 source address. */
	104	struct in6_addr dst; /* IPv6 destination address. */
	105	} addr;
b1672b4c	106	__be32 label; /* IPv6 flow label. */
76abe283 AE	107	struct {
	108	struct in6_addr target; /* ND target address. */
	109	u8 sll[ETH_ALEN]; /* ND source link layer address. */
	110	u8 tll[ETH_ALEN]; /* ND target link layer address. */
	111	} nd;
	112	} ipv6;
d31f1109	113	};
a94ebc39 JS	114	struct {
	115	/* Connection tracking fields. */
	116	u16 zone;
372ce973	117	u32 mark;
a94ebc39	118	u8 state;
038e34ab	119	struct ovs_key_ct_label label;
a94ebc39 JS	120	} ct;
a94ebc39 JS	121
9a6fe4c1	122	} __aligned(BITS_PER_LONG/8); /* Ensure that we can do comparisons as longs. */
36956a7d	123
a097c0b2	124	struct sw_flow_key_range {
8c19b83f BP	125	unsigned short int start;
8c19b83f BP	126	unsigned short int end;
a097c0b2 PS	127	};
	128
	129	struct sw_flow_mask {
	130	int ref_count;
	131	struct rcu_head rcu;
a097c0b2 PS	132	struct sw_flow_key_range range;
	133	struct sw_flow_key key;
	134	};
	135
	136	struct sw_flow_match {
	137	struct sw_flow_key *key;
	138	struct sw_flow_key_range range;
	139	struct sw_flow_mask *mask;
	140	};
	141
bc619e29 JS	142	#define MAX_UFID_LENGTH 16 /* 128 bits */
	143
	144	struct sw_flow_id {
	145	u32 ufid_len;
	146	union {
	147	u32 ufid[MAX_UFID_LENGTH / 4];
	148	struct sw_flow_key *unmasked_key;
	149	};
	150	};
	151
a097c0b2 PS	152	struct sw_flow_actions {
a097c0b2 PS	153	struct rcu_head rcu;
c3bb15b3	154	size_t orig_len; /* From flow_cmd_new netlink actions size */
a097c0b2 PS	155	u32 actions_len;
	156	struct nlattr actions[];
	157	};
	158
b0f3a2fe	159	struct flow_stats {
b0b906cc PS	160	u64 packet_count; /* Number of packets matched. */
	161	u64 byte_count; /* Number of bytes matched. */
	162	unsigned long used; /* Last used time (in jiffies). */
	163	spinlock_t lock; /* Lock for atomic stats update. */
a66733a8	164	__be16 tcp_flags; /* Union of seen TCP flags. */
b0f3a2fe PS	165	};
b0f3a2fe PS	166
064af421 BP	167	struct sw_flow {
064af421 BP	168	struct rcu_head rcu;
bc619e29 JS	169	struct {
	170	struct hlist_node node[2];
	171	u32 hash;
	172	} flow_table, ufid_table;
9ac56358 JR	173	int stats_last_writer; /* NUMA-node id of the last writer on
	174	* 'stats[0]'.
	175	*/
36956a7d	176	struct sw_flow_key key;
bc619e29	177	struct sw_flow_id id;
3d097064	178	struct sw_flow_mask *mask;
e1040c77	179	struct sw_flow_actions __rcu *sf_acts;
9ac56358 JR	180	struct flow_stats __rcu stats[]; / One for each NUMA node. First one
	181	* is allocated at flow creation time,
	182	* the rest are allocated on demand
	183	* while holding the 'stats[0].lock'.
	184	*/
064af421 BP	185	};
064af421 BP	186
6455100f	187	struct arp_eth_header {
401eeb92 BP	188	__be16 ar_hrd; /* format of hardware address */
	189	__be16 ar_pro; /* format of protocol address */
	190	unsigned char ar_hln; /* length of hardware address */
	191	unsigned char ar_pln; /* length of protocol address */
	192	__be16 ar_op; /* ARP opcode (command) */
	193
	194	/* Ethernet+IPv4 specific members. */
	195	unsigned char ar_sha[ETH_ALEN]; /* sender hardware address */
	196	unsigned char ar_sip[4]; /* sender IP address */
	197	unsigned char ar_tha[ETH_ALEN]; /* target hardware address */
	198	unsigned char ar_tip[4]; /* target IP address */
961703de	199	} __packed;
401eeb92	200
bc619e29 JS	201	static inline bool ovs_identifier_is_ufid(const struct sw_flow_id *sfid)
	202	{
	203	return sfid->ufid_len;
	204	}
	205
	206	static inline bool ovs_identifier_is_key(const struct sw_flow_id *sfid)
	207	{
	208	return !ovs_identifier_is_ufid(sfid);
	209	}
	210
a5b8d49b	211	void ovs_flow_stats_update(struct sw_flow *, __be16 tcp_flags,
f1f60b85	212	const struct sk_buff *);
4bb90bea	213	void ovs_flow_stats_get(const struct sw_flow , struct ovs_flow_stats ,
b0f3a2fe	214	unsigned long used, __be16 tcp_flags);
4bb90bea	215	void ovs_flow_stats_clear(struct sw_flow *);
850b6b3b	216	u64 ovs_flow_used_time(unsigned long flow_jiffies);
36956a7d	217
7d16c847 PS	218	/* Update the non-metadata part of the flow key using skb. */
7d16c847 PS	219	int ovs_flow_key_update(struct sk_buff skb, struct sw_flow_key key);
e23775f2	220	int ovs_flow_key_extract(const struct ip_tunnel_info *tun_info,
7d16c847 PS	221	struct sk_buff *skb,
7d16c847 PS	222	struct sw_flow_key *key);
c135bba1	223	/* Extract key from packet coming from userspace. */
038e34ab	224	int ovs_flow_key_extract_userspace(struct net net, const struct nlattr attr,
c135bba1	225	struct sk_buff *skb,
9233cef7	226	struct sw_flow_key *key, bool log);
a1c564be	227
064af421	228	#endif /* flow.h */