Commit | Line | Data |
---|---|---|
b2441318 | 1 | /* SPDX-License-Identifier: GPL-2.0 */ |
1bd758eb JP |
2 | #ifndef _NET_FLOW_DISSECTOR_H |
3 | #define _NET_FLOW_DISSECTOR_H | |
0744dd00 | 4 | |
c3f8eaeb | 5 | #include <linux/types.h> |
b924933c | 6 | #include <linux/in6.h> |
55667441 | 7 | #include <linux/siphash.h> |
8a9093c7 | 8 | #include <linux/string.h> |
67a900cc | 9 | #include <uapi/linux/if_ether.h> |
c3f8eaeb | 10 | |
b27f7bb5 JS |
11 | struct bpf_prog; |
12 | struct net; | |
5dec597e MC |
13 | struct sk_buff; |
14 | ||
42aecaa9 TH |
15 | /** |
16 | * struct flow_dissector_key_control: | |
17 | * @thoff: Transport header offset | |
18 | */ | |
19 | struct flow_dissector_key_control { | |
20 | u16 thoff; | |
c3f83241 | 21 | u16 addr_type; |
4b36993d | 22 | u32 flags; |
42aecaa9 TH |
23 | }; |
24 | ||
4b36993d DM |
25 | #define FLOW_DIS_IS_FRAGMENT BIT(0) |
26 | #define FLOW_DIS_FIRST_FRAG BIT(1) | |
27 | #define FLOW_DIS_ENCAPSULATION BIT(2) | |
28 | ||
3a1214e8 TH |
29 | enum flow_dissect_ret { |
30 | FLOW_DISSECT_RET_OUT_GOOD, | |
31 | FLOW_DISSECT_RET_OUT_BAD, | |
32 | FLOW_DISSECT_RET_PROTO_AGAIN, | |
33 | FLOW_DISSECT_RET_IPPROTO_AGAIN, | |
34 | FLOW_DISSECT_RET_CONTINUE, | |
35 | }; | |
36 | ||
fbff949e JP |
37 | /** |
38 | * struct flow_dissector_key_basic: | |
fbff949e JP |
39 | * @n_proto: Network header protocol (eg. IPv4/IPv6) |
40 | * @ip_proto: Transport header protocol (eg. TCP/UDP) | |
41 | */ | |
42 | struct flow_dissector_key_basic { | |
fbff949e JP |
43 | __be16 n_proto; |
44 | u8 ip_proto; | |
42aecaa9 | 45 | u8 padding; |
fbff949e JP |
46 | }; |
47 | ||
d34af823 | 48 | struct flow_dissector_key_tags { |
f6a66927 HHZ |
49 | u32 flow_label; |
50 | }; | |
51 | ||
52 | struct flow_dissector_key_vlan { | |
a82055af | 53 | union { |
d1746d1e PM |
54 | struct { |
55 | u16 vlan_id:12, | |
56 | vlan_dei:1, | |
57 | vlan_priority:3; | |
58 | }; | |
a82055af PNA |
59 | __be16 vlan_tci; |
60 | }; | |
2064c3d4 | 61 | __be16 vlan_tpid; |
d34af823 TH |
62 | }; |
63 | ||
58cff782 | 64 | struct flow_dissector_mpls_lse { |
029c1ecb BL |
65 | u32 mpls_ttl:8, |
66 | mpls_bos:1, | |
67 | mpls_tc:3, | |
68 | mpls_label:20; | |
69 | }; | |
70 | ||
58cff782 GN |
71 | #define FLOW_DIS_MPLS_MAX 7 |
72 | struct flow_dissector_key_mpls { | |
73 | struct flow_dissector_mpls_lse ls[FLOW_DIS_MPLS_MAX]; /* Label Stack */ | |
74 | u8 used_lses; /* One bit set for each Label Stack Entry in use */ | |
75 | }; | |
76 | ||
77 | static inline void dissector_set_mpls_lse(struct flow_dissector_key_mpls *mpls, | |
78 | int lse_index) | |
79 | { | |
80 | mpls->used_lses |= 1 << lse_index; | |
81 | } | |
82 | ||
92e2c405 SH |
83 | #define FLOW_DIS_TUN_OPTS_MAX 255 |
84 | /** | |
85 | * struct flow_dissector_key_enc_opts: | |
86 | * @data: tunnel option data | |
87 | * @len: length of tunnel option data | |
88 | * @dst_opt_type: tunnel option type | |
89 | */ | |
90 | struct flow_dissector_key_enc_opts { | |
91 | u8 data[FLOW_DIS_TUN_OPTS_MAX]; /* Using IP_TUNNEL_OPTS_MAX is desired | |
92 | * here but seems difficult to #include | |
93 | */ | |
94 | u8 len; | |
95 | __be16 dst_opt_type; | |
96 | }; | |
97 | ||
1fdd512c TH |
98 | struct flow_dissector_key_keyid { |
99 | __be32 keyid; | |
100 | }; | |
101 | ||
fbff949e | 102 | /** |
c3f83241 TH |
103 | * struct flow_dissector_key_ipv4_addrs: |
104 | * @src: source ip address | |
105 | * @dst: destination ip address | |
fbff949e | 106 | */ |
c3f83241 | 107 | struct flow_dissector_key_ipv4_addrs { |
fbff949e JP |
108 | /* (src,dst) must be grouped, in the same way than in IP header */ |
109 | __be32 src; | |
110 | __be32 dst; | |
111 | }; | |
112 | ||
c3f83241 TH |
113 | /** |
114 | * struct flow_dissector_key_ipv6_addrs: | |
115 | * @src: source ip address | |
116 | * @dst: destination ip address | |
117 | */ | |
118 | struct flow_dissector_key_ipv6_addrs { | |
119 | /* (src,dst) must be grouped, in the same way than in IP header */ | |
120 | struct in6_addr src; | |
121 | struct in6_addr dst; | |
122 | }; | |
123 | ||
9f249089 | 124 | /** |
8d6e79d3 JM |
125 | * struct flow_dissector_key_tipc: |
126 | * @key: source node address combined with selector | |
9f249089 | 127 | */ |
8d6e79d3 JM |
128 | struct flow_dissector_key_tipc { |
129 | __be32 key; | |
9f249089 TH |
130 | }; |
131 | ||
c3f83241 TH |
132 | /** |
133 | * struct flow_dissector_key_addrs: | |
134 | * @v4addrs: IPv4 addresses | |
135 | * @v6addrs: IPv6 addresses | |
136 | */ | |
137 | struct flow_dissector_key_addrs { | |
138 | union { | |
139 | struct flow_dissector_key_ipv4_addrs v4addrs; | |
140 | struct flow_dissector_key_ipv6_addrs v6addrs; | |
8d6e79d3 | 141 | struct flow_dissector_key_tipc tipckey; |
c3f83241 TH |
142 | }; |
143 | }; | |
144 | ||
55733350 SH |
145 | /** |
146 | * flow_dissector_key_arp: | |
147 | * @ports: Operation, source and target addresses for an ARP header | |
148 | * for Ethernet hardware addresses and IPv4 protocol addresses | |
149 | * sip: Sender IP address | |
150 | * tip: Target IP address | |
151 | * op: Operation | |
152 | * sha: Sender hardware address | |
153 | * tpa: Target hardware address | |
154 | */ | |
155 | struct flow_dissector_key_arp { | |
156 | __u32 sip; | |
157 | __u32 tip; | |
158 | __u8 op; | |
159 | unsigned char sha[ETH_ALEN]; | |
160 | unsigned char tha[ETH_ALEN]; | |
161 | }; | |
162 | ||
fbff949e JP |
163 | /** |
164 | * flow_dissector_key_tp_ports: | |
165 | * @ports: port numbers of Transport header | |
59346afe JP |
166 | * src: source port number |
167 | * dst: destination port number | |
fbff949e JP |
168 | */ |
169 | struct flow_dissector_key_ports { | |
170 | union { | |
171 | __be32 ports; | |
59346afe JP |
172 | struct { |
173 | __be16 src; | |
174 | __be16 dst; | |
175 | }; | |
fbff949e JP |
176 | }; |
177 | }; | |
178 | ||
972d3876 SH |
179 | /** |
180 | * flow_dissector_key_icmp: | |
972d3876 SH |
181 | * type: ICMP type |
182 | * code: ICMP code | |
5dec597e | 183 | * id: session identifier |
972d3876 SH |
184 | */ |
185 | struct flow_dissector_key_icmp { | |
5dec597e MC |
186 | struct { |
187 | u8 type; | |
188 | u8 code; | |
972d3876 | 189 | }; |
5dec597e | 190 | u16 id; |
972d3876 | 191 | }; |
b924933c | 192 | |
67a900cc JP |
193 | /** |
194 | * struct flow_dissector_key_eth_addrs: | |
195 | * @src: source Ethernet address | |
196 | * @dst: destination Ethernet address | |
197 | */ | |
198 | struct flow_dissector_key_eth_addrs { | |
199 | /* (dst,src) must be grouped, in the same way than in ETH header */ | |
200 | unsigned char dst[ETH_ALEN]; | |
201 | unsigned char src[ETH_ALEN]; | |
202 | }; | |
203 | ||
ac4bb5de JP |
204 | /** |
205 | * struct flow_dissector_key_tcp: | |
206 | * @flags: flags | |
207 | */ | |
208 | struct flow_dissector_key_tcp { | |
209 | __be16 flags; | |
210 | }; | |
211 | ||
518d8a2e OG |
212 | /** |
213 | * struct flow_dissector_key_ip: | |
214 | * @tos: tos | |
215 | * @ttl: ttl | |
216 | */ | |
217 | struct flow_dissector_key_ip { | |
218 | __u8 tos; | |
219 | __u8 ttl; | |
220 | }; | |
221 | ||
82828b88 JP |
222 | /** |
223 | * struct flow_dissector_key_meta: | |
224 | * @ingress_ifindex: ingress ifindex | |
8819efc9 | 225 | * @ingress_iftype: ingress interface type |
82828b88 JP |
226 | */ |
227 | struct flow_dissector_key_meta { | |
228 | int ingress_ifindex; | |
8819efc9 | 229 | u16 ingress_iftype; |
82828b88 JP |
230 | }; |
231 | ||
75a56758 PB |
232 | /** |
233 | * struct flow_dissector_key_ct: | |
234 | * @ct_state: conntrack state after converting with map | |
235 | * @ct_mark: conttrack mark | |
236 | * @ct_zone: conntrack zone | |
237 | * @ct_labels: conntrack labels | |
238 | */ | |
239 | struct flow_dissector_key_ct { | |
240 | u16 ct_state; | |
241 | u16 ct_zone; | |
242 | u32 ct_mark; | |
243 | u32 ct_labels[4]; | |
244 | }; | |
245 | ||
0cb09aff AL |
246 | /** |
247 | * struct flow_dissector_key_hash: | |
248 | * @hash: hash value | |
249 | */ | |
250 | struct flow_dissector_key_hash { | |
251 | u32 hash; | |
252 | }; | |
253 | ||
fbff949e | 254 | enum flow_dissector_key_id { |
42aecaa9 | 255 | FLOW_DISSECTOR_KEY_CONTROL, /* struct flow_dissector_key_control */ |
fbff949e | 256 | FLOW_DISSECTOR_KEY_BASIC, /* struct flow_dissector_key_basic */ |
c3f83241 TH |
257 | FLOW_DISSECTOR_KEY_IPV4_ADDRS, /* struct flow_dissector_key_ipv4_addrs */ |
258 | FLOW_DISSECTOR_KEY_IPV6_ADDRS, /* struct flow_dissector_key_ipv6_addrs */ | |
fbff949e | 259 | FLOW_DISSECTOR_KEY_PORTS, /* struct flow_dissector_key_ports */ |
8ffb055b | 260 | FLOW_DISSECTOR_KEY_PORTS_RANGE, /* struct flow_dissector_key_ports */ |
972d3876 | 261 | FLOW_DISSECTOR_KEY_ICMP, /* struct flow_dissector_key_icmp */ |
67a900cc | 262 | FLOW_DISSECTOR_KEY_ETH_ADDRS, /* struct flow_dissector_key_eth_addrs */ |
8d6e79d3 | 263 | FLOW_DISSECTOR_KEY_TIPC, /* struct flow_dissector_key_tipc */ |
55733350 | 264 | FLOW_DISSECTOR_KEY_ARP, /* struct flow_dissector_key_arp */ |
91c45956 EC |
265 | FLOW_DISSECTOR_KEY_VLAN, /* struct flow_dissector_key_vlan */ |
266 | FLOW_DISSECTOR_KEY_FLOW_LABEL, /* struct flow_dissector_key_tags */ | |
1fdd512c | 267 | FLOW_DISSECTOR_KEY_GRE_KEYID, /* struct flow_dissector_key_keyid */ |
b3baa0fb | 268 | FLOW_DISSECTOR_KEY_MPLS_ENTROPY, /* struct flow_dissector_key_keyid */ |
9ba6a9a9 HHZ |
269 | FLOW_DISSECTOR_KEY_ENC_KEYID, /* struct flow_dissector_key_keyid */ |
270 | FLOW_DISSECTOR_KEY_ENC_IPV4_ADDRS, /* struct flow_dissector_key_ipv4_addrs */ | |
271 | FLOW_DISSECTOR_KEY_ENC_IPV6_ADDRS, /* struct flow_dissector_key_ipv6_addrs */ | |
272 | FLOW_DISSECTOR_KEY_ENC_CONTROL, /* struct flow_dissector_key_control */ | |
f4d997fd | 273 | FLOW_DISSECTOR_KEY_ENC_PORTS, /* struct flow_dissector_key_ports */ |
029c1ecb | 274 | FLOW_DISSECTOR_KEY_MPLS, /* struct flow_dissector_key_mpls */ |
ac4bb5de | 275 | FLOW_DISSECTOR_KEY_TCP, /* struct flow_dissector_key_tcp */ |
518d8a2e | 276 | FLOW_DISSECTOR_KEY_IP, /* struct flow_dissector_key_ip */ |
91c45956 | 277 | FLOW_DISSECTOR_KEY_CVLAN, /* struct flow_dissector_key_vlan */ |
5544adb9 | 278 | FLOW_DISSECTOR_KEY_ENC_IP, /* struct flow_dissector_key_ip */ |
92e2c405 | 279 | FLOW_DISSECTOR_KEY_ENC_OPTS, /* struct flow_dissector_key_enc_opts */ |
82828b88 | 280 | FLOW_DISSECTOR_KEY_META, /* struct flow_dissector_key_meta */ |
75a56758 | 281 | FLOW_DISSECTOR_KEY_CT, /* struct flow_dissector_key_ct */ |
0cb09aff | 282 | FLOW_DISSECTOR_KEY_HASH, /* struct flow_dissector_key_hash */ |
92e2c405 | 283 | |
fbff949e JP |
284 | FLOW_DISSECTOR_KEY_MAX, |
285 | }; | |
286 | ||
807e165d | 287 | #define FLOW_DISSECTOR_F_PARSE_1ST_FRAG BIT(0) |
1cc26450 SF |
288 | #define FLOW_DISSECTOR_F_STOP_AT_FLOW_LABEL BIT(1) |
289 | #define FLOW_DISSECTOR_F_STOP_AT_ENCAP BIT(2) | |
6de6e46d | 290 | #define FLOW_DISSECTOR_F_STOP_BEFORE_ENCAP BIT(3) |
807e165d | 291 | |
fbff949e JP |
292 | struct flow_dissector_key { |
293 | enum flow_dissector_key_id key_id; | |
294 | size_t offset; /* offset of struct flow_dissector_key_* | |
295 | in target the struct */ | |
296 | }; | |
297 | ||
298 | struct flow_dissector { | |
299 | unsigned int used_keys; /* each bit repesents presence of one key id */ | |
300 | unsigned short int offset[FLOW_DISSECTOR_KEY_MAX]; | |
301 | }; | |
302 | ||
72a338bc PA |
303 | struct flow_keys_basic { |
304 | struct flow_dissector_key_control control; | |
305 | struct flow_dissector_key_basic basic; | |
306 | }; | |
307 | ||
06635a35 | 308 | struct flow_keys { |
42aecaa9 TH |
309 | struct flow_dissector_key_control control; |
310 | #define FLOW_KEYS_HASH_START_FIELD basic | |
55667441 | 311 | struct flow_dissector_key_basic basic __aligned(SIPHASH_ALIGNMENT); |
d34af823 | 312 | struct flow_dissector_key_tags tags; |
f6a66927 | 313 | struct flow_dissector_key_vlan vlan; |
24c590e3 | 314 | struct flow_dissector_key_vlan cvlan; |
1fdd512c | 315 | struct flow_dissector_key_keyid keyid; |
42aecaa9 | 316 | struct flow_dissector_key_ports ports; |
5dec597e | 317 | struct flow_dissector_key_icmp icmp; |
98298e6c | 318 | /* 'addrs' must be the last member */ |
42aecaa9 | 319 | struct flow_dissector_key_addrs addrs; |
06635a35 JP |
320 | }; |
321 | ||
42aecaa9 TH |
322 | #define FLOW_KEYS_HASH_OFFSET \ |
323 | offsetof(struct flow_keys, FLOW_KEYS_HASH_START_FIELD) | |
324 | ||
c3f83241 TH |
325 | __be32 flow_get_u32_src(const struct flow_keys *flow); |
326 | __be32 flow_get_u32_dst(const struct flow_keys *flow); | |
327 | ||
06635a35 | 328 | extern struct flow_dissector flow_keys_dissector; |
72a338bc | 329 | extern struct flow_dissector flow_keys_basic_dissector; |
06635a35 | 330 | |
2f59e1eb TH |
331 | /* struct flow_keys_digest: |
332 | * | |
333 | * This structure is used to hold a digest of the full flow keys. This is a | |
334 | * larger "hash" of a flow to allow definitively matching specific flows where | |
335 | * the 32 bit skb->hash is not large enough. The size is limited to 16 bytes so | |
53bc017f | 336 | * that it can be used in CB of skb (see sch_choke for an example). |
2f59e1eb TH |
337 | */ |
338 | #define FLOW_KEYS_DIGEST_LEN 16 | |
339 | struct flow_keys_digest { | |
340 | u8 data[FLOW_KEYS_DIGEST_LEN]; | |
341 | }; | |
342 | ||
343 | void make_flow_keys_digest(struct flow_keys_digest *digest, | |
344 | const struct flow_keys *flow); | |
345 | ||
66fdd05e | 346 | static inline bool flow_keys_have_l4(const struct flow_keys *keys) |
bcc83839 TH |
347 | { |
348 | return (keys->ports.ports || keys->tags.flow_label); | |
349 | } | |
350 | ||
c6cc1ca7 | 351 | u32 flow_hash_from_keys(struct flow_keys *keys); |
5dec597e MC |
352 | void skb_flow_get_icmp_tci(const struct sk_buff *skb, |
353 | struct flow_dissector_key_icmp *key_icmp, | |
f96533cd | 354 | const void *data, int thoff, int hlen); |
c6cc1ca7 | 355 | |
8de2d793 AV |
356 | static inline bool dissector_uses_key(const struct flow_dissector *flow_dissector, |
357 | enum flow_dissector_key_id key_id) | |
358 | { | |
359 | return flow_dissector->used_keys & (1 << key_id); | |
360 | } | |
361 | ||
362 | static inline void *skb_flow_dissector_target(struct flow_dissector *flow_dissector, | |
363 | enum flow_dissector_key_id key_id, | |
364 | void *target_container) | |
365 | { | |
366 | return ((char *)target_container) + flow_dissector->offset[key_id]; | |
367 | } | |
368 | ||
089b19a9 SF |
369 | struct bpf_flow_dissector { |
370 | struct bpf_flow_keys *flow_keys; | |
371 | const struct sk_buff *skb; | |
dac06b32 AL |
372 | const void *data; |
373 | const void *data_end; | |
089b19a9 SF |
374 | }; |
375 | ||
8a9093c7 JB |
376 | static inline void |
377 | flow_dissector_init_keys(struct flow_dissector_key_control *key_control, | |
378 | struct flow_dissector_key_basic *key_basic) | |
379 | { | |
380 | memset(key_control, 0, sizeof(*key_control)); | |
381 | memset(key_basic, 0, sizeof(*key_basic)); | |
382 | } | |
383 | ||
b27f7bb5 | 384 | #ifdef CONFIG_BPF_SYSCALL |
3b701699 JS |
385 | int flow_dissector_bpf_prog_attach_check(struct net *net, |
386 | struct bpf_prog *prog); | |
b27f7bb5 JS |
387 | #endif /* CONFIG_BPF_SYSCALL */ |
388 | ||
0744dd00 | 389 | #endif |