1 /* SPDX-License-Identifier: GPL-2.0 */
2 #ifndef _NET_FLOW_DISSECTOR_H
3 #define _NET_FLOW_DISSECTOR_H
5 #include <linux/types.h>
7 #include <linux/siphash.h>
8 #include <linux/string.h>
9 #include <uapi/linux/if_ether.h>
16 * struct flow_dissector_key_control:
17 * @thoff: Transport header offset
19 struct flow_dissector_key_control {
25 #define FLOW_DIS_IS_FRAGMENT BIT(0)
26 #define FLOW_DIS_FIRST_FRAG BIT(1)
27 #define FLOW_DIS_ENCAPSULATION BIT(2)
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,
38 * struct flow_dissector_key_basic:
39 * @n_proto: Network header protocol (eg. IPv4/IPv6)
40 * @ip_proto: Transport header protocol (eg. TCP/UDP)
42 struct flow_dissector_key_basic {
48 struct flow_dissector_key_tags {
52 struct flow_dissector_key_vlan {
66 struct flow_dissector_mpls_lse {
73 #define FLOW_DIS_MPLS_MAX 7
74 struct flow_dissector_key_mpls {
75 struct flow_dissector_mpls_lse ls[FLOW_DIS_MPLS_MAX]; /* Label Stack */
76 u8 used_lses; /* One bit set for each Label Stack Entry in use */
79 static inline void dissector_set_mpls_lse(struct flow_dissector_key_mpls *mpls,
82 mpls->used_lses |= 1 << lse_index;
85 #define FLOW_DIS_TUN_OPTS_MAX 255
87 * struct flow_dissector_key_enc_opts:
88 * @data: tunnel option data
89 * @len: length of tunnel option data
90 * @dst_opt_type: tunnel option type
92 struct flow_dissector_key_enc_opts {
93 u8 data[FLOW_DIS_TUN_OPTS_MAX]; /* Using IP_TUNNEL_OPTS_MAX is desired
94 * here but seems difficult to #include
100 struct flow_dissector_key_keyid {
105 * struct flow_dissector_key_ipv4_addrs:
106 * @src: source ip address
107 * @dst: destination ip address
109 struct flow_dissector_key_ipv4_addrs {
110 /* (src,dst) must be grouped, in the same way than in IP header */
116 * struct flow_dissector_key_ipv6_addrs:
117 * @src: source ip address
118 * @dst: destination ip address
120 struct flow_dissector_key_ipv6_addrs {
121 /* (src,dst) must be grouped, in the same way than in IP header */
127 * struct flow_dissector_key_tipc:
128 * @key: source node address combined with selector
130 struct flow_dissector_key_tipc {
135 * struct flow_dissector_key_addrs:
136 * @v4addrs: IPv4 addresses
137 * @v6addrs: IPv6 addresses
139 struct flow_dissector_key_addrs {
141 struct flow_dissector_key_ipv4_addrs v4addrs;
142 struct flow_dissector_key_ipv6_addrs v6addrs;
143 struct flow_dissector_key_tipc tipckey;
148 * flow_dissector_key_arp:
149 * @ports: Operation, source and target addresses for an ARP header
150 * for Ethernet hardware addresses and IPv4 protocol addresses
151 * sip: Sender IP address
152 * tip: Target IP address
154 * sha: Sender hardware address
155 * tpa: Target hardware address
157 struct flow_dissector_key_arp {
161 unsigned char sha[ETH_ALEN];
162 unsigned char tha[ETH_ALEN];
166 * flow_dissector_key_tp_ports:
167 * @ports: port numbers of Transport header
168 * src: source port number
169 * dst: destination port number
171 struct flow_dissector_key_ports {
182 * struct flow_dissector_key_ports_range
183 * @tp: port number from packet
184 * @tp_min: min port number in range
185 * @tp_max: max port number in range
187 struct flow_dissector_key_ports_range {
189 struct flow_dissector_key_ports tp;
191 struct flow_dissector_key_ports tp_min;
192 struct flow_dissector_key_ports tp_max;
198 * flow_dissector_key_icmp:
201 * id: session identifier
203 struct flow_dissector_key_icmp {
212 * struct flow_dissector_key_eth_addrs:
213 * @src: source Ethernet address
214 * @dst: destination Ethernet address
216 struct flow_dissector_key_eth_addrs {
217 /* (dst,src) must be grouped, in the same way than in ETH header */
218 unsigned char dst[ETH_ALEN];
219 unsigned char src[ETH_ALEN];
223 * struct flow_dissector_key_tcp:
226 struct flow_dissector_key_tcp {
231 * struct flow_dissector_key_ip:
235 struct flow_dissector_key_ip {
241 * struct flow_dissector_key_meta:
242 * @ingress_ifindex: ingress ifindex
243 * @ingress_iftype: ingress interface type
245 struct flow_dissector_key_meta {
251 * struct flow_dissector_key_ct:
252 * @ct_state: conntrack state after converting with map
253 * @ct_mark: conttrack mark
254 * @ct_zone: conntrack zone
255 * @ct_labels: conntrack labels
257 struct flow_dissector_key_ct {
265 * struct flow_dissector_key_hash:
268 struct flow_dissector_key_hash {
273 * struct flow_dissector_key_num_of_vlans:
274 * @num_of_vlans: num_of_vlans value
276 struct flow_dissector_key_num_of_vlans {
281 * struct flow_dissector_key_pppoe:
282 * @session_id: pppoe session id
283 * @ppp_proto: ppp protocol
284 * @type: pppoe eth type
286 struct flow_dissector_key_pppoe {
293 * struct flow_dissector_key_l2tpv3:
294 * @session_id: identifier for a l2tp session
296 struct flow_dissector_key_l2tpv3 {
300 enum flow_dissector_key_id {
301 FLOW_DISSECTOR_KEY_CONTROL, /* struct flow_dissector_key_control */
302 FLOW_DISSECTOR_KEY_BASIC, /* struct flow_dissector_key_basic */
303 FLOW_DISSECTOR_KEY_IPV4_ADDRS, /* struct flow_dissector_key_ipv4_addrs */
304 FLOW_DISSECTOR_KEY_IPV6_ADDRS, /* struct flow_dissector_key_ipv6_addrs */
305 FLOW_DISSECTOR_KEY_PORTS, /* struct flow_dissector_key_ports */
306 FLOW_DISSECTOR_KEY_PORTS_RANGE, /* struct flow_dissector_key_ports */
307 FLOW_DISSECTOR_KEY_ICMP, /* struct flow_dissector_key_icmp */
308 FLOW_DISSECTOR_KEY_ETH_ADDRS, /* struct flow_dissector_key_eth_addrs */
309 FLOW_DISSECTOR_KEY_TIPC, /* struct flow_dissector_key_tipc */
310 FLOW_DISSECTOR_KEY_ARP, /* struct flow_dissector_key_arp */
311 FLOW_DISSECTOR_KEY_VLAN, /* struct flow_dissector_key_vlan */
312 FLOW_DISSECTOR_KEY_FLOW_LABEL, /* struct flow_dissector_key_tags */
313 FLOW_DISSECTOR_KEY_GRE_KEYID, /* struct flow_dissector_key_keyid */
314 FLOW_DISSECTOR_KEY_MPLS_ENTROPY, /* struct flow_dissector_key_keyid */
315 FLOW_DISSECTOR_KEY_ENC_KEYID, /* struct flow_dissector_key_keyid */
316 FLOW_DISSECTOR_KEY_ENC_IPV4_ADDRS, /* struct flow_dissector_key_ipv4_addrs */
317 FLOW_DISSECTOR_KEY_ENC_IPV6_ADDRS, /* struct flow_dissector_key_ipv6_addrs */
318 FLOW_DISSECTOR_KEY_ENC_CONTROL, /* struct flow_dissector_key_control */
319 FLOW_DISSECTOR_KEY_ENC_PORTS, /* struct flow_dissector_key_ports */
320 FLOW_DISSECTOR_KEY_MPLS, /* struct flow_dissector_key_mpls */
321 FLOW_DISSECTOR_KEY_TCP, /* struct flow_dissector_key_tcp */
322 FLOW_DISSECTOR_KEY_IP, /* struct flow_dissector_key_ip */
323 FLOW_DISSECTOR_KEY_CVLAN, /* struct flow_dissector_key_vlan */
324 FLOW_DISSECTOR_KEY_ENC_IP, /* struct flow_dissector_key_ip */
325 FLOW_DISSECTOR_KEY_ENC_OPTS, /* struct flow_dissector_key_enc_opts */
326 FLOW_DISSECTOR_KEY_META, /* struct flow_dissector_key_meta */
327 FLOW_DISSECTOR_KEY_CT, /* struct flow_dissector_key_ct */
328 FLOW_DISSECTOR_KEY_HASH, /* struct flow_dissector_key_hash */
329 FLOW_DISSECTOR_KEY_NUM_OF_VLANS, /* struct flow_dissector_key_num_of_vlans */
330 FLOW_DISSECTOR_KEY_PPPOE, /* struct flow_dissector_key_pppoe */
331 FLOW_DISSECTOR_KEY_L2TPV3, /* struct flow_dissector_key_l2tpv3 */
333 FLOW_DISSECTOR_KEY_MAX,
336 #define FLOW_DISSECTOR_F_PARSE_1ST_FRAG BIT(0)
337 #define FLOW_DISSECTOR_F_STOP_AT_FLOW_LABEL BIT(1)
338 #define FLOW_DISSECTOR_F_STOP_AT_ENCAP BIT(2)
339 #define FLOW_DISSECTOR_F_STOP_BEFORE_ENCAP BIT(3)
341 struct flow_dissector_key {
342 enum flow_dissector_key_id key_id;
343 size_t offset; /* offset of struct flow_dissector_key_*
344 in target the struct */
347 struct flow_dissector {
348 unsigned int used_keys; /* each bit repesents presence of one key id */
349 unsigned short int offset[FLOW_DISSECTOR_KEY_MAX];
352 struct flow_keys_basic {
353 struct flow_dissector_key_control control;
354 struct flow_dissector_key_basic basic;
358 struct flow_dissector_key_control control;
359 #define FLOW_KEYS_HASH_START_FIELD basic
360 struct flow_dissector_key_basic basic __aligned(SIPHASH_ALIGNMENT);
361 struct flow_dissector_key_tags tags;
362 struct flow_dissector_key_vlan vlan;
363 struct flow_dissector_key_vlan cvlan;
364 struct flow_dissector_key_keyid keyid;
365 struct flow_dissector_key_ports ports;
366 struct flow_dissector_key_icmp icmp;
367 /* 'addrs' must be the last member */
368 struct flow_dissector_key_addrs addrs;
371 #define FLOW_KEYS_HASH_OFFSET \
372 offsetof(struct flow_keys, FLOW_KEYS_HASH_START_FIELD)
374 __be32 flow_get_u32_src(const struct flow_keys *flow);
375 __be32 flow_get_u32_dst(const struct flow_keys *flow);
377 extern struct flow_dissector flow_keys_dissector;
378 extern struct flow_dissector flow_keys_basic_dissector;
380 /* struct flow_keys_digest:
382 * This structure is used to hold a digest of the full flow keys. This is a
383 * larger "hash" of a flow to allow definitively matching specific flows where
384 * the 32 bit skb->hash is not large enough. The size is limited to 16 bytes so
385 * that it can be used in CB of skb (see sch_choke for an example).
387 #define FLOW_KEYS_DIGEST_LEN 16
388 struct flow_keys_digest {
389 u8 data[FLOW_KEYS_DIGEST_LEN];
392 void make_flow_keys_digest(struct flow_keys_digest *digest,
393 const struct flow_keys *flow);
395 static inline bool flow_keys_have_l4(const struct flow_keys *keys)
397 return (keys->ports.ports || keys->tags.flow_label);
400 u32 flow_hash_from_keys(struct flow_keys *keys);
401 void skb_flow_get_icmp_tci(const struct sk_buff *skb,
402 struct flow_dissector_key_icmp *key_icmp,
403 const void *data, int thoff, int hlen);
405 static inline bool dissector_uses_key(const struct flow_dissector *flow_dissector,
406 enum flow_dissector_key_id key_id)
408 return flow_dissector->used_keys & (1 << key_id);
411 static inline void *skb_flow_dissector_target(struct flow_dissector *flow_dissector,
412 enum flow_dissector_key_id key_id,
413 void *target_container)
415 return ((char *)target_container) + flow_dissector->offset[key_id];
418 struct bpf_flow_dissector {
419 struct bpf_flow_keys *flow_keys;
420 const struct sk_buff *skb;
422 const void *data_end;
426 flow_dissector_init_keys(struct flow_dissector_key_control *key_control,
427 struct flow_dissector_key_basic *key_basic)
429 memset(key_control, 0, sizeof(*key_control));
430 memset(key_basic, 0, sizeof(*key_basic));
433 #ifdef CONFIG_BPF_SYSCALL
434 int flow_dissector_bpf_prog_attach_check(struct net *net,
435 struct bpf_prog *prog);
436 #endif /* CONFIG_BPF_SYSCALL */