[mirror_ubuntu-bionic-kernel.git] / net / openvswitch / flow.h

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

struct sk_buff;

/* 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;
	__be16 tun_flags;
	u8   ipv4_tos;
	u8   ipv4_ttl;
} __packed __aligned(4); /* Minimize padding. */

struct ovs_tunnel_info {
	struct ovs_key_ipv4_tunnel tunnel;
};

static inline void ovs_flow_tun_info_init(struct ovs_tunnel_info *tun_info,
					  const struct iphdr *iph,
					  __be64 tun_id, __be16 tun_flags)
{
	tun_info->tunnel.tun_id = tun_id;
	tun_info->tunnel.ipv4_src = iph->saddr;
	tun_info->tunnel.ipv4_dst = iph->daddr;
	tun_info->tunnel.ipv4_tos = iph->tos;
	tun_info->tunnel.ipv4_ttl = iph->ttl;
	tun_info->tunnel.tun_flags = tun_flags;

	/* clear struct padding. */
	memset((unsigned char *)&tun_info->tunnel + OVS_TUNNEL_KEY_SIZE, 0,
	       sizeof(tun_info->tunnel) - OVS_TUNNEL_KEY_SIZE);
}

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). */
	} __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;
	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;
	};
} __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 list_head list;
	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;
};

struct sw_flow_actions {
	struct rcu_head rcu;
	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 hlist_node hash_node[2];
	u32 hash;
	int stats_last_writer;		/* NUMA-node id of the last writer on
					 * 'stats[0]'.
					 */
	struct sw_flow_key key;
	struct sw_flow_key unmasked_key;
	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;

void ovs_flow_stats_update(struct sw_flow *, __be16 tcp_flags,
			   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);

int ovs_flow_key_update(struct sk_buff *skb, struct sw_flow_key *key);
int ovs_flow_key_extract(struct ovs_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(const struct nlattr *attr,
				   struct sk_buff *skb,
				   struct sw_flow_key *key);

#endif /* flow.h */
Commit	Line	Data
ccb1352e	1	/*
ad552007	2	* Copyright (c) 2007-2014 Nicira, Inc.
ccb1352e JG	3	*
	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
	17	*/
	18
	19	#ifndef FLOW_H
	20	#define FLOW_H 1
	21
e298e505	22	#include <linux/cache.h>
ccb1352e JG	23	#include <linux/kernel.h>
	24	#include <linux/netlink.h>
	25	#include <linux/openvswitch.h>
	26	#include <linux/spinlock.h>
	27	#include <linux/types.h>
	28	#include <linux/rcupdate.h>
	29	#include <linux/if_ether.h>
	30	#include <linux/in6.h>
	31	#include <linux/jiffies.h>
	32	#include <linux/time.h>
	33	#include <linux/flex_array.h>
	34	#include <net/inet_ecn.h>
	35
	36	struct sk_buff;
ccb1352e	37
7d5437c7 PS	38	/* Used to memset ovs_key_ipv4_tunnel padding. */
	39	#define OVS_TUNNEL_KEY_SIZE \
	40	(offsetof(struct ovs_key_ipv4_tunnel, ipv4_ttl) + \
	41	FIELD_SIZEOF(struct ovs_key_ipv4_tunnel, ipv4_ttl))
	42
	43	struct ovs_key_ipv4_tunnel {
	44	__be64 tun_id;
	45	__be32 ipv4_src;
	46	__be32 ipv4_dst;
aa310701	47	__be16 tun_flags;
7d5437c7 PS	48	u8 ipv4_tos;
7d5437c7 PS	49	u8 ipv4_ttl;
1139e241	50	} __packed __aligned(4); /* Minimize padding. */
7d5437c7	51
f0b128c1 JG	52	struct ovs_tunnel_info {
	53	struct ovs_key_ipv4_tunnel tunnel;
	54	};
	55
	56	static inline void ovs_flow_tun_info_init(struct ovs_tunnel_info *tun_info,
	57	const struct iphdr *iph,
	58	__be64 tun_id, __be16 tun_flags)
aa310701	59	{
f0b128c1 JG	60	tun_info->tunnel.tun_id = tun_id;
	61	tun_info->tunnel.ipv4_src = iph->saddr;
	62	tun_info->tunnel.ipv4_dst = iph->daddr;
	63	tun_info->tunnel.ipv4_tos = iph->tos;
	64	tun_info->tunnel.ipv4_ttl = iph->ttl;
	65	tun_info->tunnel.tun_flags = tun_flags;
aa310701 PS	66
aa310701 PS	67	/* clear struct padding. */
f0b128c1 JG	68	memset((unsigned char *)&tun_info->tunnel + OVS_TUNNEL_KEY_SIZE, 0,
f0b128c1 JG	69	sizeof(tun_info->tunnel) - OVS_TUNNEL_KEY_SIZE);
aa310701 PS	70	}
aa310701 PS	71
ccb1352e	72	struct sw_flow_key {
7d5437c7	73	struct ovs_key_ipv4_tunnel tun_key; /* Encapsulating tunnel key. */
ccb1352e JG	74	struct {
ccb1352e JG	75	u32 priority; /* Packet QoS priority. */
39c7caeb	76	u32 skb_mark; /* SKB mark. */
15eac2a7	77	u16 in_port; /* Input switch port (or DP_MAX_PORTS). */
1139e241	78	} __packed phy; /* Safe when right after 'tun_key'. */
971427f3 AZ	79	u32 ovs_flow_hash; /* Datapath computed hash value. */
971427f3 AZ	80	u32 recirc_id; /* Recirculation ID. */
ccb1352e JG	81	struct {
	82	u8 src[ETH_ALEN]; /* Ethernet source address. */
	83	u8 dst[ETH_ALEN]; /* Ethernet destination address. */
	84	__be16 tci; /* 0 if no VLAN, VLAN_TAG_PRESENT set otherwise. */
	85	__be16 type; /* Ethernet frame type. */
	86	} eth;
	87	struct {
	88	u8 proto; /* IP protocol or lower 8 bits of ARP opcode. */
	89	u8 tos; /* IP ToS. */
	90	u8 ttl; /* IP TTL/hop limit. */
	91	u8 frag; /* One of OVS_FRAG_TYPE_. /
	92	} ip;
1139e241 JR	93	struct {
	94	__be16 src; /* TCP/UDP/SCTP source port. */
	95	__be16 dst; /* TCP/UDP/SCTP destination port. */
	96	__be16 flags; /* TCP flags. */
	97	} tp;
ccb1352e JG	98	union {
	99	struct {
	100	struct {
	101	__be32 src; /* IP source address. */
	102	__be32 dst; /* IP destination address. */
	103	} addr;
1139e241 JR	104	struct {
	105	u8 sha[ETH_ALEN]; /* ARP source hardware address. */
	106	u8 tha[ETH_ALEN]; /* ARP target hardware address. */
	107	} arp;
ccb1352e JG	108	} ipv4;
	109	struct {
	110	struct {
	111	struct in6_addr src; /* IPv6 source address. */
	112	struct in6_addr dst; /* IPv6 destination address. */
	113	} addr;
	114	__be32 label; /* IPv6 flow label. */
ccb1352e JG	115	struct {
	116	struct in6_addr target; /* ND target address. */
	117	u8 sll[ETH_ALEN]; /* ND source link layer address. */
	118	u8 tll[ETH_ALEN]; /* ND target link layer address. */
	119	} nd;
	120	} ipv6;
	121	};
0d40f75b	122	} __aligned(BITS_PER_LONG/8); /* Ensure that we can do comparisons as longs. */
ccb1352e	123
e6445719	124	struct sw_flow_key_range {
8f49ce11 BP	125	unsigned short int start;
8f49ce11 BP	126	unsigned short int end;
e6445719 PS	127	};
	128
	129	struct sw_flow_mask {
	130	int ref_count;
	131	struct rcu_head rcu;
	132	struct list_head list;
	133	struct sw_flow_key_range range;
	134	struct sw_flow_key key;
	135	};
	136
	137	struct sw_flow_match {
	138	struct sw_flow_key *key;
	139	struct sw_flow_key_range range;
	140	struct sw_flow_mask *mask;
	141	};
	142
	143	struct sw_flow_actions {
	144	struct rcu_head rcu;
	145	u32 actions_len;
	146	struct nlattr actions[];
	147	};
	148
e298e505 PS	149	struct flow_stats {
	150	u64 packet_count; /* Number of packets matched. */
	151	u64 byte_count; /* Number of bytes matched. */
	152	unsigned long used; /* Last used time (in jiffies). */
	153	spinlock_t lock; /* Lock for atomic stats update. */
	154	__be16 tcp_flags; /* Union of seen TCP flags. */
	155	};
	156
ccb1352e JG	157	struct sw_flow {
	158	struct rcu_head rcu;
	159	struct hlist_node hash_node[2];
	160	u32 hash;
63e7959c JR	161	int stats_last_writer; /* NUMA-node id of the last writer on
	162	* 'stats[0]'.
	163	*/
ccb1352e	164	struct sw_flow_key key;
03f0d916 AZ	165	struct sw_flow_key unmasked_key;
03f0d916 AZ	166	struct sw_flow_mask *mask;
ccb1352e	167	struct sw_flow_actions __rcu *sf_acts;
63e7959c JR	168	struct flow_stats __rcu stats[]; / One for each NUMA node. First one
	169	* is allocated at flow creation time,
	170	* the rest are allocated on demand
	171	* while holding the 'stats[0].lock'.
	172	*/
ccb1352e JG	173	};
	174
	175	struct arp_eth_header {
	176	__be16 ar_hrd; /* format of hardware address */
	177	__be16 ar_pro; /* format of protocol address */
	178	unsigned char ar_hln; /* length of hardware address */
	179	unsigned char ar_pln; /* length of protocol address */
	180	__be16 ar_op; /* ARP opcode (command) */
	181
	182	/* Ethernet+IPv4 specific members. */
	183	unsigned char ar_sha[ETH_ALEN]; /* sender hardware address */
	184	unsigned char ar_sip[4]; /* sender IP address */
	185	unsigned char ar_tha[ETH_ALEN]; /* target hardware address */
	186	unsigned char ar_tip[4]; /* target IP address */
	187	} __packed;
	188
ad552007 BP	189	void ovs_flow_stats_update(struct sw_flow *, __be16 tcp_flags,
ad552007 BP	190	struct sk_buff *);
86ec8dba	191	void ovs_flow_stats_get(const struct sw_flow , struct ovs_flow_stats ,
e298e505	192	unsigned long used, __be16 tcp_flags);
86ec8dba	193	void ovs_flow_stats_clear(struct sw_flow *);
ccb1352e	194	u64 ovs_flow_used_time(unsigned long flow_jiffies);
ccb1352e	195
971427f3	196	int ovs_flow_key_update(struct sk_buff skb, struct sw_flow_key key);
f0b128c1 JG	197	int ovs_flow_key_extract(struct ovs_tunnel_info tun_info, struct sk_buff skb,
f0b128c1 JG	198	struct sw_flow_key *key);
83c8df26 PS	199	/* Extract key from packet coming from userspace. */
	200	int ovs_flow_key_extract_userspace(const struct nlattr *attr,
	201	struct sk_buff *skb,
	202	struct sw_flow_key *key);
03f0d916	203
ccb1352e	204	#endif /* flow.h */