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