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