xref: /openbmc/linux/net/openvswitch/flow.h (revision bc000245)
1 /*
2  * Copyright (c) 2007-2013 Nicira, Inc.
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;
36 
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;
46 	__be16 tun_flags;
47 	u8   ipv4_tos;
48 	u8   ipv4_ttl;
49 };
50 
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 
67 struct sw_flow_key {
68 	struct ovs_key_ipv4_tunnel tun_key;  /* Encapsulating tunnel key. */
69 	struct {
70 		u32	priority;	/* Packet QoS priority. */
71 		u32	skb_mark;	/* SKB mark. */
72 		u16	in_port;	/* Input switch port (or DP_MAX_PORTS). */
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 {
94 					__be16 src;		/* TCP/UDP/SCTP source port. */
95 					__be16 dst;		/* TCP/UDP/SCTP destination port. */
96 					__be16 flags;		/* TCP flags. */
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 {
111 				__be16 src;		/* TCP/UDP/SCTP source port. */
112 				__be16 dst;		/* TCP/UDP/SCTP destination port. */
113 				__be16 flags;		/* TCP flags. */
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 	};
122 } __aligned(BITS_PER_LONG/8); /* Ensure that we can do comparisons as longs. */
123 
124 struct sw_flow_key_range {
125 	size_t start;
126 	size_t end;
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 
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;
155 	struct sw_flow_key unmasked_key;
156 	struct sw_flow_mask *mask;
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. */
163 	__be16 tcp_flags;	/* Union of seen TCP flags. */
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 
180 void ovs_flow_used(struct sw_flow *, struct sk_buff *);
181 u64 ovs_flow_used_time(unsigned long flow_jiffies);
182 
183 int ovs_flow_extract(struct sk_buff *, u16 in_port, struct sw_flow_key *);
184 
185 #endif /* flow.h */
186