[mirror_ovs.git] / datapath / flow.h

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

enum sw_flow_mac_proto {
	MAC_PROTO_NONE = 0,
	MAC_PROTO_ETHERNET,
};
#define SW_FLOW_KEY_INVALID	0x80

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

struct vlan_head {
	__be16 tpid; /* Vlan type. Generally 802.1q or 802.1ad.*/
	__be16 tci;  /* 0 if no VLAN, VLAN_TAG_PRESENT set otherwise. */
};

#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'. */
	u8 mac_proto;			/* MAC layer protocol (e.g. Ethernet). */
	u8 tun_proto;                   /* Protocol of encapsulating tunnel. */
	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. */
		struct vlan_head vlan;
		struct vlan_head cvlan;
		__be16 type;		/* Ethernet frame type. */
	} eth;
	/* Filling a hole of two bytes. */
	u8 ct_state;
	u8 ct_orig_proto;		/* CT original direction tuple IP
					 * protocol.
					 */
	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;
	};
	u16 ct_zone;			/* Conntrack zone. */
	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;
			union {
				struct {
					__be32 src;
					__be32 dst;
				} ct_orig;	/* Conntrack original direction fields. */
				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. */
			union {
				struct {
					struct in6_addr src;
					struct in6_addr dst;
				} ct_orig;	/* Conntrack original direction fields. */
				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 not packed above. */
		struct {
			__be16 src;	/* CT orig tuple tp src port. */
			__be16 dst;	/* CT orig tuple tp dst port. */
		} orig_tp;
		u32 mark;
		struct ovs_key_ct_labels labels;
	} ct;

} __aligned(BITS_PER_LONG/8); /* Ensure that we can do comparisons as longs. */

static inline bool sw_flow_key_is_nd(const struct sw_flow_key *key)
{
	return key->eth.type == htons(ETH_P_IPV6) &&
		key->ip.proto == NEXTHDR_ICMP &&
		key->tp.dst == 0 &&
		(key->tp.src == htons(NDISC_NEIGHBOUR_SOLICITATION) ||
		 key->tp.src == htons(NDISC_NEIGHBOUR_ADVERTISEMENT));
}

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;		/* CPU 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 CPU.  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 u8 ovs_key_mac_proto(const struct sw_flow_key *key)
{
	return key->mac_proto & ~SW_FLOW_KEY_INVALID;
}

static inline u16 __ovs_mac_header_len(u8 mac_proto)
{
	return mac_proto == MAC_PROTO_ETHERNET ? ETH_HLEN : 0;
}

static inline u16 ovs_mac_header_len(const struct sw_flow_key *key)
{
	return __ovs_mac_header_len(ovs_key_mac_proto(key));
}

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	/*
c30b4cea	2	* Copyright (c) 2007-2017 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
16d76400 YY	40	enum sw_flow_mac_proto {
	41	MAC_PROTO_NONE = 0,
	42	MAC_PROTO_ETHERNET,
	43	};
	44	#define SW_FLOW_KEY_INVALID 0x80
	45
c1fc1411 JG	46	/* Store options at the end of the array if they are less than the
	47	* maximum size. This allows us to get the benefits of variable length
	48	* matching for small options.
	49	*/
4b163224 TG	50	#define TUN_METADATA_OFFSET(opt_len) \
	51	(FIELD_SIZEOF(struct sw_flow_key, tun_opts) - opt_len)
	52	#define TUN_METADATA_OPTS(flow_key, opt_len) \
	53	((void *)((flow_key)->tun_opts + TUN_METADATA_OFFSET(opt_len)))
	54
e23775f2 PS	55	struct ovs_tunnel_info {
	56	struct metadata_dst *tun_dst;
	57	};
8b7ea2d4	58
d7efce7b YY	59	struct vlan_head {
	60	__be16 tpid; /* Vlan type. Generally 802.1q or 802.1ad.*/
	61	__be16 tci; /* 0 if no VLAN, VLAN_TAG_PRESENT set otherwise. */
	62	};
	63
7f45215a PS	64	#define OVS_SW_FLOW_KEY_METADATA_SIZE \
	65	(offsetof(struct sw_flow_key, recirc_id) + \
	66	FIELD_SIZEOF(struct sw_flow_key, recirc_id))
	67
36956a7d	68	struct sw_flow_key {
c1fc1411 JG	69	u8 tun_opts[255];
c1fc1411 JG	70	u8 tun_opts_len;
e23775f2	71	struct ip_tunnel_key tun_key; /* Encapsulating tunnel key. */
76abe283	72	struct {
abff858b	73	u32 priority; /* Packet QoS priority. */
72e8bf28	74	u32 skb_mark; /* SKB mark. */
95b1d73a	75	u16 in_port; /* Input switch port (or DP_MAX_PORTS). */
708fb4c5	76	} __packed phy; /* Safe when right after 'tun_key'. */
16d76400	77	u8 mac_proto; /* MAC layer protocol (e.g. Ethernet). */
8a2d4905	78	u8 tun_proto; /* Protocol of encapsulating tunnel. */
7804df20	79	u32 ovs_flow_hash; /* Datapath computed hash value. */
a6059080	80	u32 recirc_id; /* Recirculation ID. */
abff858b	81	struct {
76abe283 AE	82	u8 src[ETH_ALEN]; /* Ethernet source address. */
76abe283 AE	83	u8 dst[ETH_ALEN]; /* Ethernet destination address. */
d7efce7b YY	84	struct vlan_head vlan;
d7efce7b YY	85	struct vlan_head cvlan;
76abe283 AE	86	__be16 type; /* Ethernet frame type. */
76abe283 AE	87	} eth;
1963a885 JR	88	/* Filling a hole of two bytes. */
	89	u8 ct_state;
	90	u8 ct_orig_proto; /* CT original direction tuple IP
	91	* protocol.
	92	*/
ccf43786 SH	93	union {
ccf43786 SH	94	struct {
7d16c847	95	__be32 top_lse; /* top label stack entry */
ccf43786 SH	96	} mpls;
ccf43786 SH	97	struct {
7d16c847 PS	98	u8 proto; /* IP protocol or lower 8 bits of ARP opcode. */
	99	u8 tos; /* IP ToS. */
	100	u8 ttl; /* IP TTL/hop limit. */
	101	u8 frag; /* One of OVS_FRAG_TYPE_. /
ccf43786 SH	102	} ip;
ccf43786 SH	103	};
1963a885	104	u16 ct_zone; /* Conntrack zone. */
708fb4c5 JR	105	struct {
	106	__be16 src; /* TCP/UDP/SCTP source port. */
	107	__be16 dst; /* TCP/UDP/SCTP destination port. */
	108	__be16 flags; /* TCP flags. */
	109	} tp;
d31f1109 JP	110	union {
d31f1109 JP	111	struct {
76abe283 AE	112	struct {
	113	__be32 src; /* IP source address. */
	114	__be32 dst; /* IP destination address. */
	115	} addr;
c30b4cea JR	116	union {
	117	struct {
	118	__be32 src;
	119	__be32 dst;
	120	} ct_orig; /* Conntrack original direction fields. */
	121	struct {
	122	u8 sha[ETH_ALEN]; /* ARP source hardware address. */
	123	u8 tha[ETH_ALEN]; /* ARP target hardware address. */
	124	} arp;
	125	};
76abe283	126	} ipv4;
d31f1109	127	struct {
76abe283 AE	128	struct {
	129	struct in6_addr src; /* IPv6 source address. */
	130	struct in6_addr dst; /* IPv6 destination address. */
	131	} addr;
b1672b4c	132	__be32 label; /* IPv6 flow label. */
c30b4cea JR	133	union {
	134	struct {
	135	struct in6_addr src;
	136	struct in6_addr dst;
	137	} ct_orig; /* Conntrack original direction fields. */
	138	struct {
	139	struct in6_addr target; /* ND target address. */
	140	u8 sll[ETH_ALEN]; /* ND source link layer address. */
	141	u8 tll[ETH_ALEN]; /* ND target link layer address. */
	142	} nd;
	143	};
76abe283	144	} ipv6;
d31f1109	145	};
a94ebc39	146	struct {
1963a885	147	/* Connection tracking fields not packed above. */
c30b4cea JR	148	struct {
	149	__be16 src; /* CT orig tuple tp src port. */
	150	__be16 dst; /* CT orig tuple tp dst port. */
	151	} orig_tp;
1963a885	152	u32 mark;
c05e2094	153	struct ovs_key_ct_labels labels;
a94ebc39 JS	154	} ct;
a94ebc39 JS	155
9a6fe4c1	156	} __aligned(BITS_PER_LONG/8); /* Ensure that we can do comparisons as longs. */
36956a7d	157
c30b4cea JR	158	static inline bool sw_flow_key_is_nd(const struct sw_flow_key *key)
	159	{
	160	return key->eth.type == htons(ETH_P_IPV6) &&
	161	key->ip.proto == NEXTHDR_ICMP &&
	162	key->tp.dst == 0 &&
	163	(key->tp.src == htons(NDISC_NEIGHBOUR_SOLICITATION) \|\|
	164	key->tp.src == htons(NDISC_NEIGHBOUR_ADVERTISEMENT));
	165	}
	166
a097c0b2	167	struct sw_flow_key_range {
8c19b83f BP	168	unsigned short int start;
8c19b83f BP	169	unsigned short int end;
a097c0b2 PS	170	};
	171
	172	struct sw_flow_mask {
	173	int ref_count;
	174	struct rcu_head rcu;
a097c0b2 PS	175	struct sw_flow_key_range range;
	176	struct sw_flow_key key;
	177	};
	178
	179	struct sw_flow_match {
	180	struct sw_flow_key *key;
	181	struct sw_flow_key_range range;
	182	struct sw_flow_mask *mask;
	183	};
	184
bc619e29 JS	185	#define MAX_UFID_LENGTH 16 /* 128 bits */
	186
	187	struct sw_flow_id {
	188	u32 ufid_len;
	189	union {
	190	u32 ufid[MAX_UFID_LENGTH / 4];
	191	struct sw_flow_key *unmasked_key;
	192	};
	193	};
	194
a097c0b2 PS	195	struct sw_flow_actions {
a097c0b2 PS	196	struct rcu_head rcu;
c3bb15b3	197	size_t orig_len; /* From flow_cmd_new netlink actions size */
a097c0b2 PS	198	u32 actions_len;
	199	struct nlattr actions[];
	200	};
	201
b0f3a2fe	202	struct flow_stats {
b0b906cc PS	203	u64 packet_count; /* Number of packets matched. */
	204	u64 byte_count; /* Number of bytes matched. */
	205	unsigned long used; /* Last used time (in jiffies). */
	206	spinlock_t lock; /* Lock for atomic stats update. */
a66733a8	207	__be16 tcp_flags; /* Union of seen TCP flags. */
b0f3a2fe PS	208	};
b0f3a2fe PS	209
064af421 BP	210	struct sw_flow {
064af421 BP	211	struct rcu_head rcu;
bc619e29 JS	212	struct {
	213	struct hlist_node node[2];
	214	u32 hash;
	215	} flow_table, ufid_table;
f7dc6d34	216	int stats_last_writer; /* CPU id of the last writer on
9ac56358 JR	217	* 'stats[0]'.
9ac56358 JR	218	*/
36956a7d	219	struct sw_flow_key key;
bc619e29	220	struct sw_flow_id id;
3d097064	221	struct sw_flow_mask *mask;
e1040c77	222	struct sw_flow_actions __rcu *sf_acts;
f7dc6d34	223	struct flow_stats __rcu stats[]; / One for each CPU. First one
9ac56358 JR	224	* is allocated at flow creation time,
	225	* the rest are allocated on demand
	226	* while holding the 'stats[0].lock'.
	227	*/
064af421 BP	228	};
064af421 BP	229
6455100f	230	struct arp_eth_header {
401eeb92 BP	231	__be16 ar_hrd; /* format of hardware address */
	232	__be16 ar_pro; /* format of protocol address */
	233	unsigned char ar_hln; /* length of hardware address */
	234	unsigned char ar_pln; /* length of protocol address */
	235	__be16 ar_op; /* ARP opcode (command) */
	236
	237	/* Ethernet+IPv4 specific members. */
	238	unsigned char ar_sha[ETH_ALEN]; /* sender hardware address */
	239	unsigned char ar_sip[4]; /* sender IP address */
	240	unsigned char ar_tha[ETH_ALEN]; /* target hardware address */
	241	unsigned char ar_tip[4]; /* target IP address */
961703de	242	} __packed;
401eeb92	243
16d76400 YY	244	static inline u8 ovs_key_mac_proto(const struct sw_flow_key *key)
	245	{
	246	return key->mac_proto & ~SW_FLOW_KEY_INVALID;
	247	}
	248
	249	static inline u16 __ovs_mac_header_len(u8 mac_proto)
	250	{
	251	return mac_proto == MAC_PROTO_ETHERNET ? ETH_HLEN : 0;
	252	}
	253
	254	static inline u16 ovs_mac_header_len(const struct sw_flow_key *key)
	255	{
	256	return __ovs_mac_header_len(ovs_key_mac_proto(key));
	257	}
	258
bc619e29 JS	259	static inline bool ovs_identifier_is_ufid(const struct sw_flow_id *sfid)
	260	{
	261	return sfid->ufid_len;
	262	}
	263
	264	static inline bool ovs_identifier_is_key(const struct sw_flow_id *sfid)
	265	{
	266	return !ovs_identifier_is_ufid(sfid);
	267	}
	268
a5b8d49b	269	void ovs_flow_stats_update(struct sw_flow *, __be16 tcp_flags,
f1f60b85	270	const struct sk_buff *);
4bb90bea	271	void ovs_flow_stats_get(const struct sw_flow , struct ovs_flow_stats ,
b0f3a2fe	272	unsigned long used, __be16 tcp_flags);
4bb90bea	273	void ovs_flow_stats_clear(struct sw_flow *);
850b6b3b	274	u64 ovs_flow_used_time(unsigned long flow_jiffies);
36956a7d	275
7d16c847 PS	276	/* Update the non-metadata part of the flow key using skb. */
7d16c847 PS	277	int ovs_flow_key_update(struct sk_buff skb, struct sw_flow_key key);
e23775f2	278	int ovs_flow_key_extract(const struct ip_tunnel_info *tun_info,
7d16c847 PS	279	struct sk_buff *skb,
7d16c847 PS	280	struct sw_flow_key *key);
c135bba1	281	/* Extract key from packet coming from userspace. */
038e34ab	282	int ovs_flow_key_extract_userspace(struct net net, const struct nlattr attr,
c135bba1	283	struct sk_buff *skb,
9233cef7	284	struct sw_flow_key *key, bool log);
a1c564be	285
064af421	286	#endif /* flow.h */