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

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

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

static inline void ovs_flow_tun_key_init(struct ovs_key_ipv4_tunnel *tun_key,
					 const struct iphdr *iph, __be64 tun_id,
					 __be16 tun_flags)
{
	tun_key->tun_id = tun_id;
	tun_key->ipv4_src = iph->saddr;
	tun_key->ipv4_dst = iph->daddr;
	tun_key->ipv4_tos = iph->tos;
	tun_key->ipv4_ttl = iph->ttl;
	tun_key->tun_flags = tun_flags;

	/* clear struct padding. */
	memset((unsigned char *) tun_key + OVS_TUNNEL_KEY_SIZE, 0,
	       sizeof(*tun_key) - 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). */
	} 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/SCTP source port. */
					__be16 dst;		/* TCP/UDP/SCTP destination port. */
					__be16 flags;		/* TCP flags. */
				} 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/SCTP source port. */
				__be16 dst;		/* TCP/UDP/SCTP destination port. */
				__be16 flags;		/* TCP flags. */
			} 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;
	};
} __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 sw_flow {
	struct rcu_head rcu;
	struct hlist_node hash_node[2];
	u32 hash;

	struct sw_flow_key key;
	struct sw_flow_key unmasked_key;
	struct sw_flow_mask *mask;
	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. */
	__be16 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;

void ovs_flow_used(struct sw_flow *, struct sk_buff *);
u64 ovs_flow_used_time(unsigned long flow_jiffies);

int ovs_flow_extract(struct sk_buff *, u16 in_port, struct sw_flow_key *);

#endif /* flow.h */
Commit	Line	Data
ccb1352e	1	/*
03f0d916	2	* Copyright (c) 2007-2013 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
	22	#include <linux/kernel.h>
	23	#include <linux/netlink.h>
	24	#include <linux/openvswitch.h>
	25	#include <linux/spinlock.h>
	26	#include <linux/types.h>
	27	#include <linux/rcupdate.h>
	28	#include <linux/if_ether.h>
	29	#include <linux/in6.h>
	30	#include <linux/jiffies.h>
	31	#include <linux/time.h>
	32	#include <linux/flex_array.h>
	33	#include <net/inet_ecn.h>
	34
	35	struct sk_buff;
ccb1352e	36
7d5437c7 PS	37	/* Used to memset ovs_key_ipv4_tunnel padding. */
	38	#define OVS_TUNNEL_KEY_SIZE \
	39	(offsetof(struct ovs_key_ipv4_tunnel, ipv4_ttl) + \
	40	FIELD_SIZEOF(struct ovs_key_ipv4_tunnel, ipv4_ttl))
	41
	42	struct ovs_key_ipv4_tunnel {
	43	__be64 tun_id;
	44	__be32 ipv4_src;
	45	__be32 ipv4_dst;
aa310701	46	__be16 tun_flags;
7d5437c7 PS	47	u8 ipv4_tos;
	48	u8 ipv4_ttl;
	49	};
	50
aa310701 PS	51	static inline void ovs_flow_tun_key_init(struct ovs_key_ipv4_tunnel *tun_key,
	52	const struct iphdr *iph, __be64 tun_id,
	53	__be16 tun_flags)
	54	{
	55	tun_key->tun_id = tun_id;
	56	tun_key->ipv4_src = iph->saddr;
	57	tun_key->ipv4_dst = iph->daddr;
	58	tun_key->ipv4_tos = iph->tos;
	59	tun_key->ipv4_ttl = iph->ttl;
	60	tun_key->tun_flags = tun_flags;
	61
	62	/* clear struct padding. */
	63	memset((unsigned char *) tun_key + OVS_TUNNEL_KEY_SIZE, 0,
	64	sizeof(*tun_key) - OVS_TUNNEL_KEY_SIZE);
	65	}
	66
ccb1352e	67	struct sw_flow_key {
7d5437c7	68	struct ovs_key_ipv4_tunnel tun_key; /* Encapsulating tunnel key. */
ccb1352e JG	69	struct {
ccb1352e JG	70	u32 priority; /* Packet QoS priority. */
39c7caeb	71	u32 skb_mark; /* SKB mark. */
15eac2a7	72	u16 in_port; /* Input switch port (or DP_MAX_PORTS). */
ccb1352e JG	73	} phy;
	74	struct {
	75	u8 src[ETH_ALEN]; /* Ethernet source address. */
	76	u8 dst[ETH_ALEN]; /* Ethernet destination address. */
	77	__be16 tci; /* 0 if no VLAN, VLAN_TAG_PRESENT set otherwise. */
	78	__be16 type; /* Ethernet frame type. */
	79	} eth;
	80	struct {
	81	u8 proto; /* IP protocol or lower 8 bits of ARP opcode. */
	82	u8 tos; /* IP ToS. */
	83	u8 ttl; /* IP TTL/hop limit. */
	84	u8 frag; /* One of OVS_FRAG_TYPE_. /
	85	} ip;
	86	union {
	87	struct {
	88	struct {
	89	__be32 src; /* IP source address. */
	90	__be32 dst; /* IP destination address. */
	91	} addr;
	92	union {
	93	struct {
a175a723 JS	94	__be16 src; /* TCP/UDP/SCTP source port. */
a175a723 JS	95	__be16 dst; /* TCP/UDP/SCTP destination port. */
5eb26b15	96	__be16 flags; /* TCP flags. */
ccb1352e JG	97	} tp;
	98	struct {
	99	u8 sha[ETH_ALEN]; /* ARP source hardware address. */
	100	u8 tha[ETH_ALEN]; /* ARP target hardware address. */
	101	} arp;
	102	};
	103	} ipv4;
	104	struct {
	105	struct {
	106	struct in6_addr src; /* IPv6 source address. */
	107	struct in6_addr dst; /* IPv6 destination address. */
	108	} addr;
	109	__be32 label; /* IPv6 flow label. */
	110	struct {
a175a723 JS	111	__be16 src; /* TCP/UDP/SCTP source port. */
a175a723 JS	112	__be16 dst; /* TCP/UDP/SCTP destination port. */
5eb26b15	113	__be16 flags; /* TCP flags. */
ccb1352e JG	114	} tp;
	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
ccb1352e JG	149	struct sw_flow {
	150	struct rcu_head rcu;
	151	struct hlist_node hash_node[2];
	152	u32 hash;
	153
	154	struct sw_flow_key key;
03f0d916 AZ	155	struct sw_flow_key unmasked_key;
03f0d916 AZ	156	struct sw_flow_mask *mask;
ccb1352e JG	157	struct sw_flow_actions __rcu *sf_acts;
	158
	159	spinlock_t lock; /* Lock for values below. */
	160	unsigned long used; /* Last used time (in jiffies). */
	161	u64 packet_count; /* Number of packets matched. */
	162	u64 byte_count; /* Number of bytes matched. */
df23e9f6	163	__be16 tcp_flags; /* Union of seen TCP flags. */
ccb1352e JG	164	};
	165
	166	struct arp_eth_header {
	167	__be16 ar_hrd; /* format of hardware address */
	168	__be16 ar_pro; /* format of protocol address */
	169	unsigned char ar_hln; /* length of hardware address */
	170	unsigned char ar_pln; /* length of protocol address */
	171	__be16 ar_op; /* ARP opcode (command) */
	172
	173	/* Ethernet+IPv4 specific members. */
	174	unsigned char ar_sha[ETH_ALEN]; /* sender hardware address */
	175	unsigned char ar_sip[4]; /* sender IP address */
	176	unsigned char ar_tha[ETH_ALEN]; /* target hardware address */
	177	unsigned char ar_tip[4]; /* target IP address */
	178	} __packed;
	179
ccb1352e JG	180	void ovs_flow_used(struct sw_flow , struct sk_buff );
ccb1352e JG	181	u64 ovs_flow_used_time(unsigned long flow_jiffies);
ccb1352e	182
e6445719	183	int ovs_flow_extract(struct sk_buff , u16 in_port, struct sw_flow_key );
03f0d916	184
ccb1352e	185	#endif /* flow.h */