[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/cpumask.h>
#include <net/inet_ecn.h>
#include <net/ip_tunnels.h>
#include <net/dst_metadata.h>
#include <net/nsh.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 ovs_key_nsh {
	struct ovs_nsh_key_base base;
	__be32 context[NSH_MD1_CONTEXT_SIZE];
};

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