Loading...
1/*
2 * Copyright (c) 2007-2014 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/cache.h>
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#include <net/ip_tunnels.h>
36#include <net/dst_metadata.h>
37
38struct sk_buff;
39
40enum sw_flow_mac_proto {
41 MAC_PROTO_NONE = 0,
42 MAC_PROTO_ETHERNET,
43};
44#define SW_FLOW_KEY_INVALID 0x80
45
46/* Store options at the end of the array if they are less than the
47 * maximum size. This allows us to get the benefits of variable length
48 * matching for small options.
49 */
50#define TUN_METADATA_OFFSET(opt_len) \
51 (FIELD_SIZEOF(struct sw_flow_key, tun_opts) - opt_len)
52#define TUN_METADATA_OPTS(flow_key, opt_len) \
53 ((void *)((flow_key)->tun_opts + TUN_METADATA_OFFSET(opt_len)))
54
55struct ovs_tunnel_info {
56 struct metadata_dst *tun_dst;
57};
58
59struct vlan_head {
60 __be16 tpid; /* Vlan type. Generally 802.1q or 802.1ad.*/
61 __be16 tci; /* 0 if no VLAN, VLAN_TAG_PRESENT set otherwise. */
62};
63
64#define OVS_SW_FLOW_KEY_METADATA_SIZE \
65 (offsetof(struct sw_flow_key, recirc_id) + \
66 FIELD_SIZEOF(struct sw_flow_key, recirc_id))
67
68struct sw_flow_key {
69 u8 tun_opts[IP_TUNNEL_OPTS_MAX];
70 u8 tun_opts_len;
71 struct ip_tunnel_key tun_key; /* Encapsulating tunnel key. */
72 struct {
73 u32 priority; /* Packet QoS priority. */
74 u32 skb_mark; /* SKB mark. */
75 u16 in_port; /* Input switch port (or DP_MAX_PORTS). */
76 } __packed phy; /* Safe when right after 'tun_key'. */
77 u8 mac_proto; /* MAC layer protocol (e.g. Ethernet). */
78 u8 tun_proto; /* Protocol of encapsulating tunnel. */
79 u32 ovs_flow_hash; /* Datapath computed hash value. */
80 u32 recirc_id; /* Recirculation ID. */
81 struct {
82 u8 src[ETH_ALEN]; /* Ethernet source address. */
83 u8 dst[ETH_ALEN]; /* Ethernet destination address. */
84 struct vlan_head vlan;
85 struct vlan_head cvlan;
86 __be16 type; /* Ethernet frame type. */
87 } eth;
88 union {
89 struct {
90 __be32 top_lse; /* top label stack entry */
91 } mpls;
92 struct {
93 u8 proto; /* IP protocol or lower 8 bits of ARP opcode. */
94 u8 tos; /* IP ToS. */
95 u8 ttl; /* IP TTL/hop limit. */
96 u8 frag; /* One of OVS_FRAG_TYPE_*. */
97 } ip;
98 };
99 struct {
100 __be16 src; /* TCP/UDP/SCTP source port. */
101 __be16 dst; /* TCP/UDP/SCTP destination port. */
102 __be16 flags; /* TCP flags. */
103 } tp;
104 union {
105 struct {
106 struct {
107 __be32 src; /* IP source address. */
108 __be32 dst; /* IP destination address. */
109 } addr;
110 struct {
111 u8 sha[ETH_ALEN]; /* ARP source hardware address. */
112 u8 tha[ETH_ALEN]; /* ARP target hardware address. */
113 } arp;
114 } ipv4;
115 struct {
116 struct {
117 struct in6_addr src; /* IPv6 source address. */
118 struct in6_addr dst; /* IPv6 destination address. */
119 } addr;
120 __be32 label; /* IPv6 flow label. */
121 struct {
122 struct in6_addr target; /* ND target address. */
123 u8 sll[ETH_ALEN]; /* ND source link layer address. */
124 u8 tll[ETH_ALEN]; /* ND target link layer address. */
125 } nd;
126 } ipv6;
127 };
128 struct {
129 /* Connection tracking fields. */
130 u16 zone;
131 u32 mark;
132 u8 state;
133 struct ovs_key_ct_labels labels;
134 } ct;
135
136} __aligned(BITS_PER_LONG/8); /* Ensure that we can do comparisons as longs. */
137
138struct sw_flow_key_range {
139 unsigned short int start;
140 unsigned short int end;
141};
142
143struct sw_flow_mask {
144 int ref_count;
145 struct rcu_head rcu;
146 struct list_head list;
147 struct sw_flow_key_range range;
148 struct sw_flow_key key;
149};
150
151struct sw_flow_match {
152 struct sw_flow_key *key;
153 struct sw_flow_key_range range;
154 struct sw_flow_mask *mask;
155};
156
157#define MAX_UFID_LENGTH 16 /* 128 bits */
158
159struct sw_flow_id {
160 u32 ufid_len;
161 union {
162 u32 ufid[MAX_UFID_LENGTH / 4];
163 struct sw_flow_key *unmasked_key;
164 };
165};
166
167struct sw_flow_actions {
168 struct rcu_head rcu;
169 size_t orig_len; /* From flow_cmd_new netlink actions size */
170 u32 actions_len;
171 struct nlattr actions[];
172};
173
174struct flow_stats {
175 u64 packet_count; /* Number of packets matched. */
176 u64 byte_count; /* Number of bytes matched. */
177 unsigned long used; /* Last used time (in jiffies). */
178 spinlock_t lock; /* Lock for atomic stats update. */
179 __be16 tcp_flags; /* Union of seen TCP flags. */
180};
181
182struct sw_flow {
183 struct rcu_head rcu;
184 struct {
185 struct hlist_node node[2];
186 u32 hash;
187 } flow_table, ufid_table;
188 int stats_last_writer; /* CPU id of the last writer on
189 * 'stats[0]'.
190 */
191 struct sw_flow_key key;
192 struct sw_flow_id id;
193 struct sw_flow_mask *mask;
194 struct sw_flow_actions __rcu *sf_acts;
195 struct flow_stats __rcu *stats[]; /* One for each CPU. First one
196 * is allocated at flow creation time,
197 * the rest are allocated on demand
198 * while holding the 'stats[0].lock'.
199 */
200};
201
202struct arp_eth_header {
203 __be16 ar_hrd; /* format of hardware address */
204 __be16 ar_pro; /* format of protocol address */
205 unsigned char ar_hln; /* length of hardware address */
206 unsigned char ar_pln; /* length of protocol address */
207 __be16 ar_op; /* ARP opcode (command) */
208
209 /* Ethernet+IPv4 specific members. */
210 unsigned char ar_sha[ETH_ALEN]; /* sender hardware address */
211 unsigned char ar_sip[4]; /* sender IP address */
212 unsigned char ar_tha[ETH_ALEN]; /* target hardware address */
213 unsigned char ar_tip[4]; /* target IP address */
214} __packed;
215
216static inline u8 ovs_key_mac_proto(const struct sw_flow_key *key)
217{
218 return key->mac_proto & ~SW_FLOW_KEY_INVALID;
219}
220
221static inline u16 __ovs_mac_header_len(u8 mac_proto)
222{
223 return mac_proto == MAC_PROTO_ETHERNET ? ETH_HLEN : 0;
224}
225
226static inline u16 ovs_mac_header_len(const struct sw_flow_key *key)
227{
228 return __ovs_mac_header_len(ovs_key_mac_proto(key));
229}
230
231static inline bool ovs_identifier_is_ufid(const struct sw_flow_id *sfid)
232{
233 return sfid->ufid_len;
234}
235
236static inline bool ovs_identifier_is_key(const struct sw_flow_id *sfid)
237{
238 return !ovs_identifier_is_ufid(sfid);
239}
240
241void ovs_flow_stats_update(struct sw_flow *, __be16 tcp_flags,
242 const struct sk_buff *);
243void ovs_flow_stats_get(const struct sw_flow *, struct ovs_flow_stats *,
244 unsigned long *used, __be16 *tcp_flags);
245void ovs_flow_stats_clear(struct sw_flow *);
246u64 ovs_flow_used_time(unsigned long flow_jiffies);
247
248int ovs_flow_key_update(struct sk_buff *skb, struct sw_flow_key *key);
249int ovs_flow_key_extract(const struct ip_tunnel_info *tun_info,
250 struct sk_buff *skb,
251 struct sw_flow_key *key);
252/* Extract key from packet coming from userspace. */
253int ovs_flow_key_extract_userspace(struct net *net, const struct nlattr *attr,
254 struct sk_buff *skb,
255 struct sw_flow_key *key, bool log);
256
257#endif /* flow.h */
1/* SPDX-License-Identifier: GPL-2.0-only */
2/*
3 * Copyright (c) 2007-2017 Nicira, Inc.
4 */
5
6#ifndef FLOW_H
7#define FLOW_H 1
8
9#include <linux/cache.h>
10#include <linux/kernel.h>
11#include <linux/netlink.h>
12#include <linux/openvswitch.h>
13#include <linux/spinlock.h>
14#include <linux/types.h>
15#include <linux/rcupdate.h>
16#include <linux/if_ether.h>
17#include <linux/in6.h>
18#include <linux/jiffies.h>
19#include <linux/time.h>
20#include <linux/cpumask.h>
21#include <net/inet_ecn.h>
22#include <net/ip_tunnels.h>
23#include <net/dst_metadata.h>
24#include <net/nsh.h>
25
26struct sk_buff;
27
28enum sw_flow_mac_proto {
29 MAC_PROTO_NONE = 0,
30 MAC_PROTO_ETHERNET,
31};
32#define SW_FLOW_KEY_INVALID 0x80
33#define MPLS_LABEL_DEPTH 3
34
35/* Bit definitions for IPv6 Extension Header pseudo-field. */
36enum ofp12_ipv6exthdr_flags {
37 OFPIEH12_NONEXT = 1 << 0, /* "No next header" encountered. */
38 OFPIEH12_ESP = 1 << 1, /* Encrypted Sec Payload header present. */
39 OFPIEH12_AUTH = 1 << 2, /* Authentication header present. */
40 OFPIEH12_DEST = 1 << 3, /* 1 or 2 dest headers present. */
41 OFPIEH12_FRAG = 1 << 4, /* Fragment header present. */
42 OFPIEH12_ROUTER = 1 << 5, /* Router header present. */
43 OFPIEH12_HOP = 1 << 6, /* Hop-by-hop header present. */
44 OFPIEH12_UNREP = 1 << 7, /* Unexpected repeats encountered. */
45 OFPIEH12_UNSEQ = 1 << 8 /* Unexpected sequencing encountered. */
46};
47
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 */
52#define TUN_METADATA_OFFSET(opt_len) \
53 (sizeof_field(struct sw_flow_key, tun_opts) - opt_len)
54#define TUN_METADATA_OPTS(flow_key, opt_len) \
55 ((void *)((flow_key)->tun_opts + TUN_METADATA_OFFSET(opt_len)))
56
57struct ovs_tunnel_info {
58 struct metadata_dst *tun_dst;
59};
60
61struct vlan_head {
62 __be16 tpid; /* Vlan type. Generally 802.1q or 802.1ad.*/
63 __be16 tci; /* 0 if no VLAN, VLAN_CFI_MASK set otherwise. */
64};
65
66#define OVS_SW_FLOW_KEY_METADATA_SIZE \
67 (offsetof(struct sw_flow_key, recirc_id) + \
68 sizeof_field(struct sw_flow_key, recirc_id))
69
70struct ovs_key_nsh {
71 struct ovs_nsh_key_base base;
72 __be32 context[NSH_MD1_CONTEXT_SIZE];
73};
74
75struct sw_flow_key {
76 u8 tun_opts[IP_TUNNEL_OPTS_MAX];
77 u8 tun_opts_len;
78 struct ip_tunnel_key tun_key; /* Encapsulating tunnel key. */
79 struct {
80 u32 priority; /* Packet QoS priority. */
81 u32 skb_mark; /* SKB mark. */
82 u16 in_port; /* Input switch port (or DP_MAX_PORTS). */
83 } __packed phy; /* Safe when right after 'tun_key'. */
84 u8 mac_proto; /* MAC layer protocol (e.g. Ethernet). */
85 u8 tun_proto; /* Protocol of encapsulating tunnel. */
86 u32 ovs_flow_hash; /* Datapath computed hash value. */
87 u32 recirc_id; /* Recirculation ID. */
88 struct {
89 u8 src[ETH_ALEN]; /* Ethernet source address. */
90 u8 dst[ETH_ALEN]; /* Ethernet destination address. */
91 struct vlan_head vlan;
92 struct vlan_head cvlan;
93 __be16 type; /* Ethernet frame type. */
94 } eth;
95 /* Filling a hole of two bytes. */
96 u8 ct_state;
97 u8 ct_orig_proto; /* CT original direction tuple IP
98 * protocol.
99 */
100 union {
101 struct {
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_*. */
106 } ip;
107 };
108 u16 ct_zone; /* Conntrack zone. */
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;
114 union {
115 struct {
116 struct {
117 __be32 src; /* IP source address. */
118 __be32 dst; /* IP destination address. */
119 } addr;
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 };
130 } ipv4;
131 struct {
132 struct {
133 struct in6_addr src; /* IPv6 source address. */
134 struct in6_addr dst; /* IPv6 destination address. */
135 } addr;
136 __be32 label; /* IPv6 flow label. */
137 u16 exthdrs; /* IPv6 extension header flags */
138 union {
139 struct {
140 struct in6_addr src;
141 struct in6_addr dst;
142 } ct_orig; /* Conntrack original direction fields. */
143 struct {
144 struct in6_addr target; /* ND target address. */
145 u8 sll[ETH_ALEN]; /* ND source link layer address. */
146 u8 tll[ETH_ALEN]; /* ND target link layer address. */
147 } nd;
148 };
149 } ipv6;
150 struct {
151 u32 num_labels_mask; /* labels present bitmap of effective length MPLS_LABEL_DEPTH */
152 __be32 lse[MPLS_LABEL_DEPTH]; /* label stack entry */
153 } mpls;
154
155 struct ovs_key_nsh nsh; /* network service header */
156 };
157 struct {
158 /* Connection tracking fields not packed above. */
159 struct {
160 __be16 src; /* CT orig tuple tp src port. */
161 __be16 dst; /* CT orig tuple tp dst port. */
162 } orig_tp;
163 u32 mark;
164 struct ovs_key_ct_labels labels;
165 } ct;
166
167} __aligned(BITS_PER_LONG/8); /* Ensure that we can do comparisons as longs. */
168
169static inline bool sw_flow_key_is_nd(const struct sw_flow_key *key)
170{
171 return key->eth.type == htons(ETH_P_IPV6) &&
172 key->ip.proto == NEXTHDR_ICMP &&
173 key->tp.dst == 0 &&
174 (key->tp.src == htons(NDISC_NEIGHBOUR_SOLICITATION) ||
175 key->tp.src == htons(NDISC_NEIGHBOUR_ADVERTISEMENT));
176}
177
178struct sw_flow_key_range {
179 unsigned short int start;
180 unsigned short int end;
181};
182
183struct sw_flow_mask {
184 int ref_count;
185 struct rcu_head rcu;
186 struct sw_flow_key_range range;
187 struct sw_flow_key key;
188};
189
190struct sw_flow_match {
191 struct sw_flow_key *key;
192 struct sw_flow_key_range range;
193 struct sw_flow_mask *mask;
194};
195
196#define MAX_UFID_LENGTH 16 /* 128 bits */
197
198struct sw_flow_id {
199 u32 ufid_len;
200 union {
201 u32 ufid[MAX_UFID_LENGTH / 4];
202 struct sw_flow_key *unmasked_key;
203 };
204};
205
206struct sw_flow_actions {
207 struct rcu_head rcu;
208 size_t orig_len; /* From flow_cmd_new netlink actions size */
209 u32 actions_len;
210 struct nlattr actions[];
211};
212
213struct sw_flow_stats {
214 u64 packet_count; /* Number of packets matched. */
215 u64 byte_count; /* Number of bytes matched. */
216 unsigned long used; /* Last used time (in jiffies). */
217 spinlock_t lock; /* Lock for atomic stats update. */
218 __be16 tcp_flags; /* Union of seen TCP flags. */
219};
220
221struct sw_flow {
222 struct rcu_head rcu;
223 struct {
224 struct hlist_node node[2];
225 u32 hash;
226 } flow_table, ufid_table;
227 int stats_last_writer; /* CPU id of the last writer on
228 * 'stats[0]'.
229 */
230 struct sw_flow_key key;
231 struct sw_flow_id id;
232 struct cpumask *cpu_used_mask;
233 struct sw_flow_mask *mask;
234 struct sw_flow_actions __rcu *sf_acts;
235 struct sw_flow_stats __rcu *stats[]; /* One for each CPU. First one
236 * is allocated at flow creation time,
237 * the rest are allocated on demand
238 * while holding the 'stats[0].lock'.
239 */
240};
241
242struct arp_eth_header {
243 __be16 ar_hrd; /* format of hardware address */
244 __be16 ar_pro; /* format of protocol address */
245 unsigned char ar_hln; /* length of hardware address */
246 unsigned char ar_pln; /* length of protocol address */
247 __be16 ar_op; /* ARP opcode (command) */
248
249 /* Ethernet+IPv4 specific members. */
250 unsigned char ar_sha[ETH_ALEN]; /* sender hardware address */
251 unsigned char ar_sip[4]; /* sender IP address */
252 unsigned char ar_tha[ETH_ALEN]; /* target hardware address */
253 unsigned char ar_tip[4]; /* target IP address */
254} __packed;
255
256static inline u8 ovs_key_mac_proto(const struct sw_flow_key *key)
257{
258 return key->mac_proto & ~SW_FLOW_KEY_INVALID;
259}
260
261static inline u16 __ovs_mac_header_len(u8 mac_proto)
262{
263 return mac_proto == MAC_PROTO_ETHERNET ? ETH_HLEN : 0;
264}
265
266static inline u16 ovs_mac_header_len(const struct sw_flow_key *key)
267{
268 return __ovs_mac_header_len(ovs_key_mac_proto(key));
269}
270
271static inline bool ovs_identifier_is_ufid(const struct sw_flow_id *sfid)
272{
273 return sfid->ufid_len;
274}
275
276static inline bool ovs_identifier_is_key(const struct sw_flow_id *sfid)
277{
278 return !ovs_identifier_is_ufid(sfid);
279}
280
281void ovs_flow_stats_update(struct sw_flow *, __be16 tcp_flags,
282 const struct sk_buff *);
283void ovs_flow_stats_get(const struct sw_flow *, struct ovs_flow_stats *,
284 unsigned long *used, __be16 *tcp_flags);
285void ovs_flow_stats_clear(struct sw_flow *);
286u64 ovs_flow_used_time(unsigned long flow_jiffies);
287
288int ovs_flow_key_update(struct sk_buff *skb, struct sw_flow_key *key);
289int ovs_flow_key_update_l3l4(struct sk_buff *skb, struct sw_flow_key *key);
290int ovs_flow_key_extract(const struct ip_tunnel_info *tun_info,
291 struct sk_buff *skb,
292 struct sw_flow_key *key);
293/* Extract key from packet coming from userspace. */
294int ovs_flow_key_extract_userspace(struct net *net, const struct nlattr *attr,
295 struct sk_buff *skb,
296 struct sw_flow_key *key, bool log);
297
298#endif /* flow.h */