1 // SPDX-License-Identifier: GPL-2.0-only
2 #include <linux/kernel.h>
3 #include <linux/skbuff.h>
4 #include <linux/export.h>
6 #include <linux/ipv6.h>
7 #include <linux/if_vlan.h>
9 #include <net/dst_metadata.h>
15 #include <linux/igmp.h>
16 #include <linux/icmp.h>
17 #include <linux/sctp.h>
18 #include <linux/dccp.h>
19 #include <linux/if_tunnel.h>
20 #include <linux/if_pppox.h>
21 #include <linux/ppp_defs.h>
22 #include <linux/stddef.h>
23 #include <linux/if_ether.h>
24 #include <linux/mpls.h>
25 #include <linux/tcp.h>
26 #include <linux/ptp_classify.h>
27 #include <net/flow_dissector.h>
28 #include <scsi/fc/fc_fcoe.h>
29 #include <uapi/linux/batadv_packet.h>
30 #include <linux/bpf.h>
31 #if IS_ENABLED(CONFIG_NF_CONNTRACK)
32 #include <net/netfilter/nf_conntrack_core.h>
33 #include <net/netfilter/nf_conntrack_labels.h>
35 #include <linux/bpf-netns.h>
37 static void dissector_set_key(struct flow_dissector *flow_dissector,
38 enum flow_dissector_key_id key_id)
40 flow_dissector->used_keys |= (1 << key_id);
43 void skb_flow_dissector_init(struct flow_dissector *flow_dissector,
44 const struct flow_dissector_key *key,
45 unsigned int key_count)
49 memset(flow_dissector, 0, sizeof(*flow_dissector));
51 for (i = 0; i < key_count; i++, key++) {
52 /* User should make sure that every key target offset is within
53 * boundaries of unsigned short.
55 BUG_ON(key->offset > USHRT_MAX);
56 BUG_ON(dissector_uses_key(flow_dissector,
59 dissector_set_key(flow_dissector, key->key_id);
60 flow_dissector->offset[key->key_id] = key->offset;
63 /* Ensure that the dissector always includes control and basic key.
64 * That way we are able to avoid handling lack of these in fast path.
66 BUG_ON(!dissector_uses_key(flow_dissector,
67 FLOW_DISSECTOR_KEY_CONTROL));
68 BUG_ON(!dissector_uses_key(flow_dissector,
69 FLOW_DISSECTOR_KEY_BASIC));
71 EXPORT_SYMBOL(skb_flow_dissector_init);
73 #ifdef CONFIG_BPF_SYSCALL
74 int flow_dissector_bpf_prog_attach_check(struct net *net,
75 struct bpf_prog *prog)
77 enum netns_bpf_attach_type type = NETNS_BPF_FLOW_DISSECTOR;
79 if (net == &init_net) {
80 /* BPF flow dissector in the root namespace overrides
81 * any per-net-namespace one. When attaching to root,
82 * make sure we don't have any BPF program attached
83 * to the non-root namespaces.
90 if (rcu_access_pointer(ns->bpf.run_array[type]))
94 /* Make sure root flow dissector is not attached
95 * when attaching to the non-root namespace.
97 if (rcu_access_pointer(init_net.bpf.run_array[type]))
103 #endif /* CONFIG_BPF_SYSCALL */
106 * __skb_flow_get_ports - extract the upper layer ports and return them
107 * @skb: sk_buff to extract the ports from
108 * @thoff: transport header offset
109 * @ip_proto: protocol for which to get port offset
110 * @data: raw buffer pointer to the packet, if NULL use skb->data
111 * @hlen: packet header length, if @data is NULL use skb_headlen(skb)
113 * The function will try to retrieve the ports at offset thoff + poff where poff
114 * is the protocol port offset returned from proto_ports_offset
116 __be32 __skb_flow_get_ports(const struct sk_buff *skb, int thoff, u8 ip_proto,
117 const void *data, int hlen)
119 int poff = proto_ports_offset(ip_proto);
123 hlen = skb_headlen(skb);
127 __be32 *ports, _ports;
129 ports = __skb_header_pointer(skb, thoff + poff,
130 sizeof(_ports), data, hlen, &_ports);
137 EXPORT_SYMBOL(__skb_flow_get_ports);
139 static bool icmp_has_id(u8 type)
145 case ICMP_TIMESTAMPREPLY:
146 case ICMPV6_ECHO_REQUEST:
147 case ICMPV6_ECHO_REPLY:
155 * skb_flow_get_icmp_tci - extract ICMP(6) Type, Code and Identifier fields
156 * @skb: sk_buff to extract from
157 * @key_icmp: struct flow_dissector_key_icmp to fill
158 * @data: raw buffer pointer to the packet
159 * @thoff: offset to extract at
160 * @hlen: packet header length
162 void skb_flow_get_icmp_tci(const struct sk_buff *skb,
163 struct flow_dissector_key_icmp *key_icmp,
164 const void *data, int thoff, int hlen)
166 struct icmphdr *ih, _ih;
168 ih = __skb_header_pointer(skb, thoff, sizeof(_ih), data, hlen, &_ih);
172 key_icmp->type = ih->type;
173 key_icmp->code = ih->code;
175 /* As we use 0 to signal that the Id field is not present,
176 * avoid confusion with packets without such field
178 if (icmp_has_id(ih->type))
179 key_icmp->id = ih->un.echo.id ? ntohs(ih->un.echo.id) : 1;
183 EXPORT_SYMBOL(skb_flow_get_icmp_tci);
185 /* If FLOW_DISSECTOR_KEY_ICMP is set, dissect an ICMP packet
186 * using skb_flow_get_icmp_tci().
188 static void __skb_flow_dissect_icmp(const struct sk_buff *skb,
189 struct flow_dissector *flow_dissector,
190 void *target_container, const void *data,
193 struct flow_dissector_key_icmp *key_icmp;
195 if (!dissector_uses_key(flow_dissector, FLOW_DISSECTOR_KEY_ICMP))
198 key_icmp = skb_flow_dissector_target(flow_dissector,
199 FLOW_DISSECTOR_KEY_ICMP,
202 skb_flow_get_icmp_tci(skb, key_icmp, data, thoff, hlen);
205 void skb_flow_dissect_meta(const struct sk_buff *skb,
206 struct flow_dissector *flow_dissector,
207 void *target_container)
209 struct flow_dissector_key_meta *meta;
211 if (!dissector_uses_key(flow_dissector, FLOW_DISSECTOR_KEY_META))
214 meta = skb_flow_dissector_target(flow_dissector,
215 FLOW_DISSECTOR_KEY_META,
217 meta->ingress_ifindex = skb->skb_iif;
219 EXPORT_SYMBOL(skb_flow_dissect_meta);
222 skb_flow_dissect_set_enc_addr_type(enum flow_dissector_key_id type,
223 struct flow_dissector *flow_dissector,
224 void *target_container)
226 struct flow_dissector_key_control *ctrl;
228 if (!dissector_uses_key(flow_dissector, FLOW_DISSECTOR_KEY_ENC_CONTROL))
231 ctrl = skb_flow_dissector_target(flow_dissector,
232 FLOW_DISSECTOR_KEY_ENC_CONTROL,
234 ctrl->addr_type = type;
238 skb_flow_dissect_ct(const struct sk_buff *skb,
239 struct flow_dissector *flow_dissector,
240 void *target_container, u16 *ctinfo_map,
241 size_t mapsize, bool post_ct, u16 zone)
243 #if IS_ENABLED(CONFIG_NF_CONNTRACK)
244 struct flow_dissector_key_ct *key;
245 enum ip_conntrack_info ctinfo;
246 struct nf_conn_labels *cl;
249 if (!dissector_uses_key(flow_dissector, FLOW_DISSECTOR_KEY_CT))
252 ct = nf_ct_get(skb, &ctinfo);
256 key = skb_flow_dissector_target(flow_dissector,
257 FLOW_DISSECTOR_KEY_CT,
261 key->ct_state = TCA_FLOWER_KEY_CT_FLAGS_TRACKED |
262 TCA_FLOWER_KEY_CT_FLAGS_INVALID;
267 if (ctinfo < mapsize)
268 key->ct_state = ctinfo_map[ctinfo];
269 #if IS_ENABLED(CONFIG_NF_CONNTRACK_ZONES)
270 key->ct_zone = ct->zone.id;
272 #if IS_ENABLED(CONFIG_NF_CONNTRACK_MARK)
273 key->ct_mark = ct->mark;
276 cl = nf_ct_labels_find(ct);
278 memcpy(key->ct_labels, cl->bits, sizeof(key->ct_labels));
279 #endif /* CONFIG_NF_CONNTRACK */
281 EXPORT_SYMBOL(skb_flow_dissect_ct);
284 skb_flow_dissect_tunnel_info(const struct sk_buff *skb,
285 struct flow_dissector *flow_dissector,
286 void *target_container)
288 struct ip_tunnel_info *info;
289 struct ip_tunnel_key *key;
291 /* A quick check to see if there might be something to do. */
292 if (!dissector_uses_key(flow_dissector,
293 FLOW_DISSECTOR_KEY_ENC_KEYID) &&
294 !dissector_uses_key(flow_dissector,
295 FLOW_DISSECTOR_KEY_ENC_IPV4_ADDRS) &&
296 !dissector_uses_key(flow_dissector,
297 FLOW_DISSECTOR_KEY_ENC_IPV6_ADDRS) &&
298 !dissector_uses_key(flow_dissector,
299 FLOW_DISSECTOR_KEY_ENC_CONTROL) &&
300 !dissector_uses_key(flow_dissector,
301 FLOW_DISSECTOR_KEY_ENC_PORTS) &&
302 !dissector_uses_key(flow_dissector,
303 FLOW_DISSECTOR_KEY_ENC_IP) &&
304 !dissector_uses_key(flow_dissector,
305 FLOW_DISSECTOR_KEY_ENC_OPTS))
308 info = skb_tunnel_info(skb);
314 switch (ip_tunnel_info_af(info)) {
316 skb_flow_dissect_set_enc_addr_type(FLOW_DISSECTOR_KEY_IPV4_ADDRS,
319 if (dissector_uses_key(flow_dissector,
320 FLOW_DISSECTOR_KEY_ENC_IPV4_ADDRS)) {
321 struct flow_dissector_key_ipv4_addrs *ipv4;
323 ipv4 = skb_flow_dissector_target(flow_dissector,
324 FLOW_DISSECTOR_KEY_ENC_IPV4_ADDRS,
326 ipv4->src = key->u.ipv4.src;
327 ipv4->dst = key->u.ipv4.dst;
331 skb_flow_dissect_set_enc_addr_type(FLOW_DISSECTOR_KEY_IPV6_ADDRS,
334 if (dissector_uses_key(flow_dissector,
335 FLOW_DISSECTOR_KEY_ENC_IPV6_ADDRS)) {
336 struct flow_dissector_key_ipv6_addrs *ipv6;
338 ipv6 = skb_flow_dissector_target(flow_dissector,
339 FLOW_DISSECTOR_KEY_ENC_IPV6_ADDRS,
341 ipv6->src = key->u.ipv6.src;
342 ipv6->dst = key->u.ipv6.dst;
347 if (dissector_uses_key(flow_dissector, FLOW_DISSECTOR_KEY_ENC_KEYID)) {
348 struct flow_dissector_key_keyid *keyid;
350 keyid = skb_flow_dissector_target(flow_dissector,
351 FLOW_DISSECTOR_KEY_ENC_KEYID,
353 keyid->keyid = tunnel_id_to_key32(key->tun_id);
356 if (dissector_uses_key(flow_dissector, FLOW_DISSECTOR_KEY_ENC_PORTS)) {
357 struct flow_dissector_key_ports *tp;
359 tp = skb_flow_dissector_target(flow_dissector,
360 FLOW_DISSECTOR_KEY_ENC_PORTS,
362 tp->src = key->tp_src;
363 tp->dst = key->tp_dst;
366 if (dissector_uses_key(flow_dissector, FLOW_DISSECTOR_KEY_ENC_IP)) {
367 struct flow_dissector_key_ip *ip;
369 ip = skb_flow_dissector_target(flow_dissector,
370 FLOW_DISSECTOR_KEY_ENC_IP,
376 if (dissector_uses_key(flow_dissector, FLOW_DISSECTOR_KEY_ENC_OPTS)) {
377 struct flow_dissector_key_enc_opts *enc_opt;
379 enc_opt = skb_flow_dissector_target(flow_dissector,
380 FLOW_DISSECTOR_KEY_ENC_OPTS,
383 if (info->options_len) {
384 enc_opt->len = info->options_len;
385 ip_tunnel_info_opts_get(enc_opt->data, info);
386 enc_opt->dst_opt_type = info->key.tun_flags &
387 TUNNEL_OPTIONS_PRESENT;
391 EXPORT_SYMBOL(skb_flow_dissect_tunnel_info);
393 void skb_flow_dissect_hash(const struct sk_buff *skb,
394 struct flow_dissector *flow_dissector,
395 void *target_container)
397 struct flow_dissector_key_hash *key;
399 if (!dissector_uses_key(flow_dissector, FLOW_DISSECTOR_KEY_HASH))
402 key = skb_flow_dissector_target(flow_dissector,
403 FLOW_DISSECTOR_KEY_HASH,
406 key->hash = skb_get_hash_raw(skb);
408 EXPORT_SYMBOL(skb_flow_dissect_hash);
410 static enum flow_dissect_ret
411 __skb_flow_dissect_mpls(const struct sk_buff *skb,
412 struct flow_dissector *flow_dissector,
413 void *target_container, const void *data, int nhoff,
414 int hlen, int lse_index, bool *entropy_label)
416 struct mpls_label *hdr, _hdr;
417 u32 entry, label, bos;
419 if (!dissector_uses_key(flow_dissector,
420 FLOW_DISSECTOR_KEY_MPLS_ENTROPY) &&
421 !dissector_uses_key(flow_dissector, FLOW_DISSECTOR_KEY_MPLS))
422 return FLOW_DISSECT_RET_OUT_GOOD;
424 if (lse_index >= FLOW_DIS_MPLS_MAX)
425 return FLOW_DISSECT_RET_OUT_GOOD;
427 hdr = __skb_header_pointer(skb, nhoff, sizeof(_hdr), data,
430 return FLOW_DISSECT_RET_OUT_BAD;
432 entry = ntohl(hdr->entry);
433 label = (entry & MPLS_LS_LABEL_MASK) >> MPLS_LS_LABEL_SHIFT;
434 bos = (entry & MPLS_LS_S_MASK) >> MPLS_LS_S_SHIFT;
436 if (dissector_uses_key(flow_dissector, FLOW_DISSECTOR_KEY_MPLS)) {
437 struct flow_dissector_key_mpls *key_mpls;
438 struct flow_dissector_mpls_lse *lse;
440 key_mpls = skb_flow_dissector_target(flow_dissector,
441 FLOW_DISSECTOR_KEY_MPLS,
443 lse = &key_mpls->ls[lse_index];
445 lse->mpls_ttl = (entry & MPLS_LS_TTL_MASK) >> MPLS_LS_TTL_SHIFT;
447 lse->mpls_tc = (entry & MPLS_LS_TC_MASK) >> MPLS_LS_TC_SHIFT;
448 lse->mpls_label = label;
449 dissector_set_mpls_lse(key_mpls, lse_index);
452 if (*entropy_label &&
453 dissector_uses_key(flow_dissector,
454 FLOW_DISSECTOR_KEY_MPLS_ENTROPY)) {
455 struct flow_dissector_key_keyid *key_keyid;
457 key_keyid = skb_flow_dissector_target(flow_dissector,
458 FLOW_DISSECTOR_KEY_MPLS_ENTROPY,
460 key_keyid->keyid = cpu_to_be32(label);
463 *entropy_label = label == MPLS_LABEL_ENTROPY;
465 return bos ? FLOW_DISSECT_RET_OUT_GOOD : FLOW_DISSECT_RET_PROTO_AGAIN;
468 static enum flow_dissect_ret
469 __skb_flow_dissect_arp(const struct sk_buff *skb,
470 struct flow_dissector *flow_dissector,
471 void *target_container, const void *data,
474 struct flow_dissector_key_arp *key_arp;
476 unsigned char ar_sha[ETH_ALEN];
477 unsigned char ar_sip[4];
478 unsigned char ar_tha[ETH_ALEN];
479 unsigned char ar_tip[4];
480 } *arp_eth, _arp_eth;
481 const struct arphdr *arp;
484 if (!dissector_uses_key(flow_dissector, FLOW_DISSECTOR_KEY_ARP))
485 return FLOW_DISSECT_RET_OUT_GOOD;
487 arp = __skb_header_pointer(skb, nhoff, sizeof(_arp), data,
490 return FLOW_DISSECT_RET_OUT_BAD;
492 if (arp->ar_hrd != htons(ARPHRD_ETHER) ||
493 arp->ar_pro != htons(ETH_P_IP) ||
494 arp->ar_hln != ETH_ALEN ||
496 (arp->ar_op != htons(ARPOP_REPLY) &&
497 arp->ar_op != htons(ARPOP_REQUEST)))
498 return FLOW_DISSECT_RET_OUT_BAD;
500 arp_eth = __skb_header_pointer(skb, nhoff + sizeof(_arp),
501 sizeof(_arp_eth), data,
504 return FLOW_DISSECT_RET_OUT_BAD;
506 key_arp = skb_flow_dissector_target(flow_dissector,
507 FLOW_DISSECTOR_KEY_ARP,
510 memcpy(&key_arp->sip, arp_eth->ar_sip, sizeof(key_arp->sip));
511 memcpy(&key_arp->tip, arp_eth->ar_tip, sizeof(key_arp->tip));
513 /* Only store the lower byte of the opcode;
514 * this covers ARPOP_REPLY and ARPOP_REQUEST.
516 key_arp->op = ntohs(arp->ar_op) & 0xff;
518 ether_addr_copy(key_arp->sha, arp_eth->ar_sha);
519 ether_addr_copy(key_arp->tha, arp_eth->ar_tha);
521 return FLOW_DISSECT_RET_OUT_GOOD;
524 static enum flow_dissect_ret
525 __skb_flow_dissect_gre(const struct sk_buff *skb,
526 struct flow_dissector_key_control *key_control,
527 struct flow_dissector *flow_dissector,
528 void *target_container, const void *data,
529 __be16 *p_proto, int *p_nhoff, int *p_hlen,
532 struct flow_dissector_key_keyid *key_keyid;
533 struct gre_base_hdr *hdr, _hdr;
537 hdr = __skb_header_pointer(skb, *p_nhoff, sizeof(_hdr),
538 data, *p_hlen, &_hdr);
540 return FLOW_DISSECT_RET_OUT_BAD;
542 /* Only look inside GRE without routing */
543 if (hdr->flags & GRE_ROUTING)
544 return FLOW_DISSECT_RET_OUT_GOOD;
546 /* Only look inside GRE for version 0 and 1 */
547 gre_ver = ntohs(hdr->flags & GRE_VERSION);
549 return FLOW_DISSECT_RET_OUT_GOOD;
551 *p_proto = hdr->protocol;
553 /* Version1 must be PPTP, and check the flags */
554 if (!(*p_proto == GRE_PROTO_PPP && (hdr->flags & GRE_KEY)))
555 return FLOW_DISSECT_RET_OUT_GOOD;
558 offset += sizeof(struct gre_base_hdr);
560 if (hdr->flags & GRE_CSUM)
561 offset += sizeof_field(struct gre_full_hdr, csum) +
562 sizeof_field(struct gre_full_hdr, reserved1);
564 if (hdr->flags & GRE_KEY) {
568 keyid = __skb_header_pointer(skb, *p_nhoff + offset,
570 data, *p_hlen, &_keyid);
572 return FLOW_DISSECT_RET_OUT_BAD;
574 if (dissector_uses_key(flow_dissector,
575 FLOW_DISSECTOR_KEY_GRE_KEYID)) {
576 key_keyid = skb_flow_dissector_target(flow_dissector,
577 FLOW_DISSECTOR_KEY_GRE_KEYID,
580 key_keyid->keyid = *keyid;
582 key_keyid->keyid = *keyid & GRE_PPTP_KEY_MASK;
584 offset += sizeof_field(struct gre_full_hdr, key);
587 if (hdr->flags & GRE_SEQ)
588 offset += sizeof_field(struct pptp_gre_header, seq);
591 if (*p_proto == htons(ETH_P_TEB)) {
592 const struct ethhdr *eth;
595 eth = __skb_header_pointer(skb, *p_nhoff + offset,
597 data, *p_hlen, &_eth);
599 return FLOW_DISSECT_RET_OUT_BAD;
600 *p_proto = eth->h_proto;
601 offset += sizeof(*eth);
603 /* Cap headers that we access via pointers at the
604 * end of the Ethernet header as our maximum alignment
605 * at that point is only 2 bytes.
608 *p_hlen = *p_nhoff + offset;
610 } else { /* version 1, must be PPTP */
611 u8 _ppp_hdr[PPP_HDRLEN];
614 if (hdr->flags & GRE_ACK)
615 offset += sizeof_field(struct pptp_gre_header, ack);
617 ppp_hdr = __skb_header_pointer(skb, *p_nhoff + offset,
619 data, *p_hlen, _ppp_hdr);
621 return FLOW_DISSECT_RET_OUT_BAD;
623 switch (PPP_PROTOCOL(ppp_hdr)) {
625 *p_proto = htons(ETH_P_IP);
628 *p_proto = htons(ETH_P_IPV6);
631 /* Could probably catch some more like MPLS */
635 offset += PPP_HDRLEN;
639 key_control->flags |= FLOW_DIS_ENCAPSULATION;
640 if (flags & FLOW_DISSECTOR_F_STOP_AT_ENCAP)
641 return FLOW_DISSECT_RET_OUT_GOOD;
643 return FLOW_DISSECT_RET_PROTO_AGAIN;
647 * __skb_flow_dissect_batadv() - dissect batman-adv header
648 * @skb: sk_buff to with the batman-adv header
649 * @key_control: flow dissectors control key
650 * @data: raw buffer pointer to the packet, if NULL use skb->data
651 * @p_proto: pointer used to update the protocol to process next
652 * @p_nhoff: pointer used to update inner network header offset
653 * @hlen: packet header length
654 * @flags: any combination of FLOW_DISSECTOR_F_*
656 * ETH_P_BATMAN packets are tried to be dissected. Only
657 * &struct batadv_unicast packets are actually processed because they contain an
658 * inner ethernet header and are usually followed by actual network header. This
659 * allows the flow dissector to continue processing the packet.
661 * Return: FLOW_DISSECT_RET_PROTO_AGAIN when &struct batadv_unicast was found,
662 * FLOW_DISSECT_RET_OUT_GOOD when dissector should stop after encapsulation,
663 * otherwise FLOW_DISSECT_RET_OUT_BAD
665 static enum flow_dissect_ret
666 __skb_flow_dissect_batadv(const struct sk_buff *skb,
667 struct flow_dissector_key_control *key_control,
668 const void *data, __be16 *p_proto, int *p_nhoff,
669 int hlen, unsigned int flags)
672 struct batadv_unicast_packet batadv_unicast;
676 hdr = __skb_header_pointer(skb, *p_nhoff, sizeof(_hdr), data, hlen,
679 return FLOW_DISSECT_RET_OUT_BAD;
681 if (hdr->batadv_unicast.version != BATADV_COMPAT_VERSION)
682 return FLOW_DISSECT_RET_OUT_BAD;
684 if (hdr->batadv_unicast.packet_type != BATADV_UNICAST)
685 return FLOW_DISSECT_RET_OUT_BAD;
687 *p_proto = hdr->eth.h_proto;
688 *p_nhoff += sizeof(*hdr);
690 key_control->flags |= FLOW_DIS_ENCAPSULATION;
691 if (flags & FLOW_DISSECTOR_F_STOP_AT_ENCAP)
692 return FLOW_DISSECT_RET_OUT_GOOD;
694 return FLOW_DISSECT_RET_PROTO_AGAIN;
698 __skb_flow_dissect_tcp(const struct sk_buff *skb,
699 struct flow_dissector *flow_dissector,
700 void *target_container, const void *data,
703 struct flow_dissector_key_tcp *key_tcp;
704 struct tcphdr *th, _th;
706 if (!dissector_uses_key(flow_dissector, FLOW_DISSECTOR_KEY_TCP))
709 th = __skb_header_pointer(skb, thoff, sizeof(_th), data, hlen, &_th);
713 if (unlikely(__tcp_hdrlen(th) < sizeof(_th)))
716 key_tcp = skb_flow_dissector_target(flow_dissector,
717 FLOW_DISSECTOR_KEY_TCP,
719 key_tcp->flags = (*(__be16 *) &tcp_flag_word(th) & htons(0x0FFF));
723 __skb_flow_dissect_ports(const struct sk_buff *skb,
724 struct flow_dissector *flow_dissector,
725 void *target_container, const void *data,
726 int nhoff, u8 ip_proto, int hlen)
728 enum flow_dissector_key_id dissector_ports = FLOW_DISSECTOR_KEY_MAX;
729 struct flow_dissector_key_ports *key_ports;
731 if (dissector_uses_key(flow_dissector, FLOW_DISSECTOR_KEY_PORTS))
732 dissector_ports = FLOW_DISSECTOR_KEY_PORTS;
733 else if (dissector_uses_key(flow_dissector,
734 FLOW_DISSECTOR_KEY_PORTS_RANGE))
735 dissector_ports = FLOW_DISSECTOR_KEY_PORTS_RANGE;
737 if (dissector_ports == FLOW_DISSECTOR_KEY_MAX)
740 key_ports = skb_flow_dissector_target(flow_dissector,
743 key_ports->ports = __skb_flow_get_ports(skb, nhoff, ip_proto,
748 __skb_flow_dissect_ipv4(const struct sk_buff *skb,
749 struct flow_dissector *flow_dissector,
750 void *target_container, const void *data,
751 const struct iphdr *iph)
753 struct flow_dissector_key_ip *key_ip;
755 if (!dissector_uses_key(flow_dissector, FLOW_DISSECTOR_KEY_IP))
758 key_ip = skb_flow_dissector_target(flow_dissector,
759 FLOW_DISSECTOR_KEY_IP,
761 key_ip->tos = iph->tos;
762 key_ip->ttl = iph->ttl;
766 __skb_flow_dissect_ipv6(const struct sk_buff *skb,
767 struct flow_dissector *flow_dissector,
768 void *target_container, const void *data,
769 const struct ipv6hdr *iph)
771 struct flow_dissector_key_ip *key_ip;
773 if (!dissector_uses_key(flow_dissector, FLOW_DISSECTOR_KEY_IP))
776 key_ip = skb_flow_dissector_target(flow_dissector,
777 FLOW_DISSECTOR_KEY_IP,
779 key_ip->tos = ipv6_get_dsfield(iph);
780 key_ip->ttl = iph->hop_limit;
783 /* Maximum number of protocol headers that can be parsed in
786 #define MAX_FLOW_DISSECT_HDRS 15
788 static bool skb_flow_dissect_allowed(int *num_hdrs)
792 return (*num_hdrs <= MAX_FLOW_DISSECT_HDRS);
795 static void __skb_flow_bpf_to_target(const struct bpf_flow_keys *flow_keys,
796 struct flow_dissector *flow_dissector,
797 void *target_container)
799 struct flow_dissector_key_ports *key_ports = NULL;
800 struct flow_dissector_key_control *key_control;
801 struct flow_dissector_key_basic *key_basic;
802 struct flow_dissector_key_addrs *key_addrs;
803 struct flow_dissector_key_tags *key_tags;
805 key_control = skb_flow_dissector_target(flow_dissector,
806 FLOW_DISSECTOR_KEY_CONTROL,
808 key_control->thoff = flow_keys->thoff;
809 if (flow_keys->is_frag)
810 key_control->flags |= FLOW_DIS_IS_FRAGMENT;
811 if (flow_keys->is_first_frag)
812 key_control->flags |= FLOW_DIS_FIRST_FRAG;
813 if (flow_keys->is_encap)
814 key_control->flags |= FLOW_DIS_ENCAPSULATION;
816 key_basic = skb_flow_dissector_target(flow_dissector,
817 FLOW_DISSECTOR_KEY_BASIC,
819 key_basic->n_proto = flow_keys->n_proto;
820 key_basic->ip_proto = flow_keys->ip_proto;
822 if (flow_keys->addr_proto == ETH_P_IP &&
823 dissector_uses_key(flow_dissector, FLOW_DISSECTOR_KEY_IPV4_ADDRS)) {
824 key_addrs = skb_flow_dissector_target(flow_dissector,
825 FLOW_DISSECTOR_KEY_IPV4_ADDRS,
827 key_addrs->v4addrs.src = flow_keys->ipv4_src;
828 key_addrs->v4addrs.dst = flow_keys->ipv4_dst;
829 key_control->addr_type = FLOW_DISSECTOR_KEY_IPV4_ADDRS;
830 } else if (flow_keys->addr_proto == ETH_P_IPV6 &&
831 dissector_uses_key(flow_dissector,
832 FLOW_DISSECTOR_KEY_IPV6_ADDRS)) {
833 key_addrs = skb_flow_dissector_target(flow_dissector,
834 FLOW_DISSECTOR_KEY_IPV6_ADDRS,
836 memcpy(&key_addrs->v6addrs.src, &flow_keys->ipv6_src,
837 sizeof(key_addrs->v6addrs.src));
838 memcpy(&key_addrs->v6addrs.dst, &flow_keys->ipv6_dst,
839 sizeof(key_addrs->v6addrs.dst));
840 key_control->addr_type = FLOW_DISSECTOR_KEY_IPV6_ADDRS;
843 if (dissector_uses_key(flow_dissector, FLOW_DISSECTOR_KEY_PORTS))
844 key_ports = skb_flow_dissector_target(flow_dissector,
845 FLOW_DISSECTOR_KEY_PORTS,
847 else if (dissector_uses_key(flow_dissector,
848 FLOW_DISSECTOR_KEY_PORTS_RANGE))
849 key_ports = skb_flow_dissector_target(flow_dissector,
850 FLOW_DISSECTOR_KEY_PORTS_RANGE,
854 key_ports->src = flow_keys->sport;
855 key_ports->dst = flow_keys->dport;
858 if (dissector_uses_key(flow_dissector,
859 FLOW_DISSECTOR_KEY_FLOW_LABEL)) {
860 key_tags = skb_flow_dissector_target(flow_dissector,
861 FLOW_DISSECTOR_KEY_FLOW_LABEL,
863 key_tags->flow_label = ntohl(flow_keys->flow_label);
867 bool bpf_flow_dissect(struct bpf_prog *prog, struct bpf_flow_dissector *ctx,
868 __be16 proto, int nhoff, int hlen, unsigned int flags)
870 struct bpf_flow_keys *flow_keys = ctx->flow_keys;
873 /* Pass parameters to the BPF program */
874 memset(flow_keys, 0, sizeof(*flow_keys));
875 flow_keys->n_proto = proto;
876 flow_keys->nhoff = nhoff;
877 flow_keys->thoff = flow_keys->nhoff;
879 BUILD_BUG_ON((int)BPF_FLOW_DISSECTOR_F_PARSE_1ST_FRAG !=
880 (int)FLOW_DISSECTOR_F_PARSE_1ST_FRAG);
881 BUILD_BUG_ON((int)BPF_FLOW_DISSECTOR_F_STOP_AT_FLOW_LABEL !=
882 (int)FLOW_DISSECTOR_F_STOP_AT_FLOW_LABEL);
883 BUILD_BUG_ON((int)BPF_FLOW_DISSECTOR_F_STOP_AT_ENCAP !=
884 (int)FLOW_DISSECTOR_F_STOP_AT_ENCAP);
885 flow_keys->flags = flags;
887 result = bpf_prog_run_pin_on_cpu(prog, ctx);
889 flow_keys->nhoff = clamp_t(u16, flow_keys->nhoff, nhoff, hlen);
890 flow_keys->thoff = clamp_t(u16, flow_keys->thoff,
891 flow_keys->nhoff, hlen);
893 return result == BPF_OK;
897 * __skb_flow_dissect - extract the flow_keys struct and return it
898 * @net: associated network namespace, derived from @skb if NULL
899 * @skb: sk_buff to extract the flow from, can be NULL if the rest are specified
900 * @flow_dissector: list of keys to dissect
901 * @target_container: target structure to put dissected values into
902 * @data: raw buffer pointer to the packet, if NULL use skb->data
903 * @proto: protocol for which to get the flow, if @data is NULL use skb->protocol
904 * @nhoff: network header offset, if @data is NULL use skb_network_offset(skb)
905 * @hlen: packet header length, if @data is NULL use skb_headlen(skb)
906 * @flags: flags that control the dissection process, e.g.
907 * FLOW_DISSECTOR_F_STOP_AT_ENCAP.
909 * The function will try to retrieve individual keys into target specified
910 * by flow_dissector from either the skbuff or a raw buffer specified by the
913 * Caller must take care of zeroing target container memory.
915 bool __skb_flow_dissect(const struct net *net,
916 const struct sk_buff *skb,
917 struct flow_dissector *flow_dissector,
918 void *target_container, const void *data,
919 __be16 proto, int nhoff, int hlen, unsigned int flags)
921 struct flow_dissector_key_control *key_control;
922 struct flow_dissector_key_basic *key_basic;
923 struct flow_dissector_key_addrs *key_addrs;
924 struct flow_dissector_key_tags *key_tags;
925 struct flow_dissector_key_vlan *key_vlan;
926 enum flow_dissect_ret fdret;
927 enum flow_dissector_key_id dissector_vlan = FLOW_DISSECTOR_KEY_MAX;
928 bool mpls_el = false;
936 proto = skb_vlan_tag_present(skb) ?
937 skb->vlan_proto : skb->protocol;
938 nhoff = skb_network_offset(skb);
939 hlen = skb_headlen(skb);
940 #if IS_ENABLED(CONFIG_NET_DSA)
941 if (unlikely(skb->dev && netdev_uses_dsa(skb->dev) &&
942 proto == htons(ETH_P_XDSA))) {
943 const struct dsa_device_ops *ops;
946 ops = skb->dev->dsa_ptr->tag_ops;
947 /* Only DSA header taggers break flow dissection */
948 if (ops->needed_headroom) {
949 if (ops->flow_dissect)
950 ops->flow_dissect(skb, &proto, &offset);
952 dsa_tag_generic_flow_dissect(skb,
962 /* It is ensured by skb_flow_dissector_init() that control key will
965 key_control = skb_flow_dissector_target(flow_dissector,
966 FLOW_DISSECTOR_KEY_CONTROL,
969 /* It is ensured by skb_flow_dissector_init() that basic key will
972 key_basic = skb_flow_dissector_target(flow_dissector,
973 FLOW_DISSECTOR_KEY_BASIC,
979 net = dev_net(skb->dev);
981 net = sock_net(skb->sk);
987 enum netns_bpf_attach_type type = NETNS_BPF_FLOW_DISSECTOR;
988 struct bpf_prog_array *run_array;
991 run_array = rcu_dereference(init_net.bpf.run_array[type]);
993 run_array = rcu_dereference(net->bpf.run_array[type]);
996 struct bpf_flow_keys flow_keys;
997 struct bpf_flow_dissector ctx = {
998 .flow_keys = &flow_keys,
1000 .data_end = data + hlen,
1002 __be16 n_proto = proto;
1003 struct bpf_prog *prog;
1007 /* we can't use 'proto' in the skb case
1008 * because it might be set to skb->vlan_proto
1009 * which has been pulled from the data
1011 n_proto = skb->protocol;
1014 prog = READ_ONCE(run_array->items[0].prog);
1015 ret = bpf_flow_dissect(prog, &ctx, n_proto, nhoff,
1017 __skb_flow_bpf_to_target(&flow_keys, flow_dissector,
1025 if (dissector_uses_key(flow_dissector,
1026 FLOW_DISSECTOR_KEY_ETH_ADDRS)) {
1027 struct ethhdr *eth = eth_hdr(skb);
1028 struct flow_dissector_key_eth_addrs *key_eth_addrs;
1030 key_eth_addrs = skb_flow_dissector_target(flow_dissector,
1031 FLOW_DISSECTOR_KEY_ETH_ADDRS,
1033 memcpy(key_eth_addrs, ð->h_dest, sizeof(*key_eth_addrs));
1037 fdret = FLOW_DISSECT_RET_CONTINUE;
1040 case htons(ETH_P_IP): {
1041 const struct iphdr *iph;
1044 iph = __skb_header_pointer(skb, nhoff, sizeof(_iph), data, hlen, &_iph);
1045 if (!iph || iph->ihl < 5) {
1046 fdret = FLOW_DISSECT_RET_OUT_BAD;
1050 nhoff += iph->ihl * 4;
1052 ip_proto = iph->protocol;
1054 if (dissector_uses_key(flow_dissector,
1055 FLOW_DISSECTOR_KEY_IPV4_ADDRS)) {
1056 key_addrs = skb_flow_dissector_target(flow_dissector,
1057 FLOW_DISSECTOR_KEY_IPV4_ADDRS,
1060 memcpy(&key_addrs->v4addrs.src, &iph->saddr,
1061 sizeof(key_addrs->v4addrs.src));
1062 memcpy(&key_addrs->v4addrs.dst, &iph->daddr,
1063 sizeof(key_addrs->v4addrs.dst));
1064 key_control->addr_type = FLOW_DISSECTOR_KEY_IPV4_ADDRS;
1067 __skb_flow_dissect_ipv4(skb, flow_dissector,
1068 target_container, data, iph);
1070 if (ip_is_fragment(iph)) {
1071 key_control->flags |= FLOW_DIS_IS_FRAGMENT;
1073 if (iph->frag_off & htons(IP_OFFSET)) {
1074 fdret = FLOW_DISSECT_RET_OUT_GOOD;
1077 key_control->flags |= FLOW_DIS_FIRST_FRAG;
1079 FLOW_DISSECTOR_F_PARSE_1ST_FRAG)) {
1080 fdret = FLOW_DISSECT_RET_OUT_GOOD;
1088 case htons(ETH_P_IPV6): {
1089 const struct ipv6hdr *iph;
1090 struct ipv6hdr _iph;
1092 iph = __skb_header_pointer(skb, nhoff, sizeof(_iph), data, hlen, &_iph);
1094 fdret = FLOW_DISSECT_RET_OUT_BAD;
1098 ip_proto = iph->nexthdr;
1099 nhoff += sizeof(struct ipv6hdr);
1101 if (dissector_uses_key(flow_dissector,
1102 FLOW_DISSECTOR_KEY_IPV6_ADDRS)) {
1103 key_addrs = skb_flow_dissector_target(flow_dissector,
1104 FLOW_DISSECTOR_KEY_IPV6_ADDRS,
1107 memcpy(&key_addrs->v6addrs.src, &iph->saddr,
1108 sizeof(key_addrs->v6addrs.src));
1109 memcpy(&key_addrs->v6addrs.dst, &iph->daddr,
1110 sizeof(key_addrs->v6addrs.dst));
1111 key_control->addr_type = FLOW_DISSECTOR_KEY_IPV6_ADDRS;
1114 if ((dissector_uses_key(flow_dissector,
1115 FLOW_DISSECTOR_KEY_FLOW_LABEL) ||
1116 (flags & FLOW_DISSECTOR_F_STOP_AT_FLOW_LABEL)) &&
1117 ip6_flowlabel(iph)) {
1118 __be32 flow_label = ip6_flowlabel(iph);
1120 if (dissector_uses_key(flow_dissector,
1121 FLOW_DISSECTOR_KEY_FLOW_LABEL)) {
1122 key_tags = skb_flow_dissector_target(flow_dissector,
1123 FLOW_DISSECTOR_KEY_FLOW_LABEL,
1125 key_tags->flow_label = ntohl(flow_label);
1127 if (flags & FLOW_DISSECTOR_F_STOP_AT_FLOW_LABEL) {
1128 fdret = FLOW_DISSECT_RET_OUT_GOOD;
1133 __skb_flow_dissect_ipv6(skb, flow_dissector,
1134 target_container, data, iph);
1138 case htons(ETH_P_8021AD):
1139 case htons(ETH_P_8021Q): {
1140 const struct vlan_hdr *vlan = NULL;
1141 struct vlan_hdr _vlan;
1142 __be16 saved_vlan_tpid = proto;
1144 if (dissector_vlan == FLOW_DISSECTOR_KEY_MAX &&
1145 skb && skb_vlan_tag_present(skb)) {
1146 proto = skb->protocol;
1148 vlan = __skb_header_pointer(skb, nhoff, sizeof(_vlan),
1149 data, hlen, &_vlan);
1151 fdret = FLOW_DISSECT_RET_OUT_BAD;
1155 proto = vlan->h_vlan_encapsulated_proto;
1156 nhoff += sizeof(*vlan);
1159 if (dissector_vlan == FLOW_DISSECTOR_KEY_MAX) {
1160 dissector_vlan = FLOW_DISSECTOR_KEY_VLAN;
1161 } else if (dissector_vlan == FLOW_DISSECTOR_KEY_VLAN) {
1162 dissector_vlan = FLOW_DISSECTOR_KEY_CVLAN;
1164 fdret = FLOW_DISSECT_RET_PROTO_AGAIN;
1168 if (dissector_uses_key(flow_dissector, dissector_vlan)) {
1169 key_vlan = skb_flow_dissector_target(flow_dissector,
1174 key_vlan->vlan_id = skb_vlan_tag_get_id(skb);
1175 key_vlan->vlan_priority = skb_vlan_tag_get_prio(skb);
1177 key_vlan->vlan_id = ntohs(vlan->h_vlan_TCI) &
1179 key_vlan->vlan_priority =
1180 (ntohs(vlan->h_vlan_TCI) &
1181 VLAN_PRIO_MASK) >> VLAN_PRIO_SHIFT;
1183 key_vlan->vlan_tpid = saved_vlan_tpid;
1184 key_vlan->vlan_eth_type = proto;
1187 fdret = FLOW_DISSECT_RET_PROTO_AGAIN;
1190 case htons(ETH_P_PPP_SES): {
1192 struct pppoe_hdr hdr;
1195 hdr = __skb_header_pointer(skb, nhoff, sizeof(_hdr), data, hlen, &_hdr);
1197 fdret = FLOW_DISSECT_RET_OUT_BAD;
1202 nhoff += PPPOE_SES_HLEN;
1205 proto = htons(ETH_P_IP);
1206 fdret = FLOW_DISSECT_RET_PROTO_AGAIN;
1208 case htons(PPP_IPV6):
1209 proto = htons(ETH_P_IPV6);
1210 fdret = FLOW_DISSECT_RET_PROTO_AGAIN;
1213 fdret = FLOW_DISSECT_RET_OUT_BAD;
1218 case htons(ETH_P_TIPC): {
1219 struct tipc_basic_hdr *hdr, _hdr;
1221 hdr = __skb_header_pointer(skb, nhoff, sizeof(_hdr),
1224 fdret = FLOW_DISSECT_RET_OUT_BAD;
1228 if (dissector_uses_key(flow_dissector,
1229 FLOW_DISSECTOR_KEY_TIPC)) {
1230 key_addrs = skb_flow_dissector_target(flow_dissector,
1231 FLOW_DISSECTOR_KEY_TIPC,
1233 key_addrs->tipckey.key = tipc_hdr_rps_key(hdr);
1234 key_control->addr_type = FLOW_DISSECTOR_KEY_TIPC;
1236 fdret = FLOW_DISSECT_RET_OUT_GOOD;
1240 case htons(ETH_P_MPLS_UC):
1241 case htons(ETH_P_MPLS_MC):
1242 fdret = __skb_flow_dissect_mpls(skb, flow_dissector,
1243 target_container, data,
1244 nhoff, hlen, mpls_lse,
1246 nhoff += sizeof(struct mpls_label);
1249 case htons(ETH_P_FCOE):
1250 if ((hlen - nhoff) < FCOE_HEADER_LEN) {
1251 fdret = FLOW_DISSECT_RET_OUT_BAD;
1255 nhoff += FCOE_HEADER_LEN;
1256 fdret = FLOW_DISSECT_RET_OUT_GOOD;
1259 case htons(ETH_P_ARP):
1260 case htons(ETH_P_RARP):
1261 fdret = __skb_flow_dissect_arp(skb, flow_dissector,
1262 target_container, data,
1266 case htons(ETH_P_BATMAN):
1267 fdret = __skb_flow_dissect_batadv(skb, key_control, data,
1268 &proto, &nhoff, hlen, flags);
1271 case htons(ETH_P_1588): {
1272 struct ptp_header *hdr, _hdr;
1274 hdr = __skb_header_pointer(skb, nhoff, sizeof(_hdr), data,
1277 fdret = FLOW_DISSECT_RET_OUT_BAD;
1281 nhoff += ntohs(hdr->message_length);
1282 fdret = FLOW_DISSECT_RET_OUT_GOOD;
1287 fdret = FLOW_DISSECT_RET_OUT_BAD;
1291 /* Process result of proto processing */
1293 case FLOW_DISSECT_RET_OUT_GOOD:
1295 case FLOW_DISSECT_RET_PROTO_AGAIN:
1296 if (skb_flow_dissect_allowed(&num_hdrs))
1299 case FLOW_DISSECT_RET_CONTINUE:
1300 case FLOW_DISSECT_RET_IPPROTO_AGAIN:
1302 case FLOW_DISSECT_RET_OUT_BAD:
1308 fdret = FLOW_DISSECT_RET_CONTINUE;
1312 fdret = __skb_flow_dissect_gre(skb, key_control, flow_dissector,
1313 target_container, data,
1314 &proto, &nhoff, &hlen, flags);
1318 case NEXTHDR_ROUTING:
1319 case NEXTHDR_DEST: {
1320 u8 _opthdr[2], *opthdr;
1322 if (proto != htons(ETH_P_IPV6))
1325 opthdr = __skb_header_pointer(skb, nhoff, sizeof(_opthdr),
1326 data, hlen, &_opthdr);
1328 fdret = FLOW_DISSECT_RET_OUT_BAD;
1332 ip_proto = opthdr[0];
1333 nhoff += (opthdr[1] + 1) << 3;
1335 fdret = FLOW_DISSECT_RET_IPPROTO_AGAIN;
1338 case NEXTHDR_FRAGMENT: {
1339 struct frag_hdr _fh, *fh;
1341 if (proto != htons(ETH_P_IPV6))
1344 fh = __skb_header_pointer(skb, nhoff, sizeof(_fh),
1348 fdret = FLOW_DISSECT_RET_OUT_BAD;
1352 key_control->flags |= FLOW_DIS_IS_FRAGMENT;
1354 nhoff += sizeof(_fh);
1355 ip_proto = fh->nexthdr;
1357 if (!(fh->frag_off & htons(IP6_OFFSET))) {
1358 key_control->flags |= FLOW_DIS_FIRST_FRAG;
1359 if (flags & FLOW_DISSECTOR_F_PARSE_1ST_FRAG) {
1360 fdret = FLOW_DISSECT_RET_IPPROTO_AGAIN;
1365 fdret = FLOW_DISSECT_RET_OUT_GOOD;
1369 proto = htons(ETH_P_IP);
1371 key_control->flags |= FLOW_DIS_ENCAPSULATION;
1372 if (flags & FLOW_DISSECTOR_F_STOP_AT_ENCAP) {
1373 fdret = FLOW_DISSECT_RET_OUT_GOOD;
1377 fdret = FLOW_DISSECT_RET_PROTO_AGAIN;
1381 proto = htons(ETH_P_IPV6);
1383 key_control->flags |= FLOW_DIS_ENCAPSULATION;
1384 if (flags & FLOW_DISSECTOR_F_STOP_AT_ENCAP) {
1385 fdret = FLOW_DISSECT_RET_OUT_GOOD;
1389 fdret = FLOW_DISSECT_RET_PROTO_AGAIN;
1394 proto = htons(ETH_P_MPLS_UC);
1395 fdret = FLOW_DISSECT_RET_PROTO_AGAIN;
1399 __skb_flow_dissect_tcp(skb, flow_dissector, target_container,
1404 case IPPROTO_ICMPV6:
1405 __skb_flow_dissect_icmp(skb, flow_dissector, target_container,
1413 if (!(key_control->flags & FLOW_DIS_IS_FRAGMENT))
1414 __skb_flow_dissect_ports(skb, flow_dissector, target_container,
1415 data, nhoff, ip_proto, hlen);
1417 /* Process result of IP proto processing */
1419 case FLOW_DISSECT_RET_PROTO_AGAIN:
1420 if (skb_flow_dissect_allowed(&num_hdrs))
1423 case FLOW_DISSECT_RET_IPPROTO_AGAIN:
1424 if (skb_flow_dissect_allowed(&num_hdrs))
1425 goto ip_proto_again;
1427 case FLOW_DISSECT_RET_OUT_GOOD:
1428 case FLOW_DISSECT_RET_CONTINUE:
1430 case FLOW_DISSECT_RET_OUT_BAD:
1439 key_control->thoff = min_t(u16, nhoff, skb ? skb->len : hlen);
1440 key_basic->n_proto = proto;
1441 key_basic->ip_proto = ip_proto;
1449 EXPORT_SYMBOL(__skb_flow_dissect);
1451 static siphash_key_t hashrnd __read_mostly;
1452 static __always_inline void __flow_hash_secret_init(void)
1454 net_get_random_once(&hashrnd, sizeof(hashrnd));
1457 static const void *flow_keys_hash_start(const struct flow_keys *flow)
1459 BUILD_BUG_ON(FLOW_KEYS_HASH_OFFSET % SIPHASH_ALIGNMENT);
1460 return &flow->FLOW_KEYS_HASH_START_FIELD;
1463 static inline size_t flow_keys_hash_length(const struct flow_keys *flow)
1465 size_t diff = FLOW_KEYS_HASH_OFFSET + sizeof(flow->addrs);
1467 BUILD_BUG_ON((sizeof(*flow) - FLOW_KEYS_HASH_OFFSET) % sizeof(u32));
1469 switch (flow->control.addr_type) {
1470 case FLOW_DISSECTOR_KEY_IPV4_ADDRS:
1471 diff -= sizeof(flow->addrs.v4addrs);
1473 case FLOW_DISSECTOR_KEY_IPV6_ADDRS:
1474 diff -= sizeof(flow->addrs.v6addrs);
1476 case FLOW_DISSECTOR_KEY_TIPC:
1477 diff -= sizeof(flow->addrs.tipckey);
1480 return sizeof(*flow) - diff;
1483 __be32 flow_get_u32_src(const struct flow_keys *flow)
1485 switch (flow->control.addr_type) {
1486 case FLOW_DISSECTOR_KEY_IPV4_ADDRS:
1487 return flow->addrs.v4addrs.src;
1488 case FLOW_DISSECTOR_KEY_IPV6_ADDRS:
1489 return (__force __be32)ipv6_addr_hash(
1490 &flow->addrs.v6addrs.src);
1491 case FLOW_DISSECTOR_KEY_TIPC:
1492 return flow->addrs.tipckey.key;
1497 EXPORT_SYMBOL(flow_get_u32_src);
1499 __be32 flow_get_u32_dst(const struct flow_keys *flow)
1501 switch (flow->control.addr_type) {
1502 case FLOW_DISSECTOR_KEY_IPV4_ADDRS:
1503 return flow->addrs.v4addrs.dst;
1504 case FLOW_DISSECTOR_KEY_IPV6_ADDRS:
1505 return (__force __be32)ipv6_addr_hash(
1506 &flow->addrs.v6addrs.dst);
1511 EXPORT_SYMBOL(flow_get_u32_dst);
1513 /* Sort the source and destination IP and the ports,
1514 * to have consistent hash within the two directions
1516 static inline void __flow_hash_consistentify(struct flow_keys *keys)
1520 switch (keys->control.addr_type) {
1521 case FLOW_DISSECTOR_KEY_IPV4_ADDRS:
1522 addr_diff = (__force u32)keys->addrs.v4addrs.dst -
1523 (__force u32)keys->addrs.v4addrs.src;
1525 swap(keys->addrs.v4addrs.src, keys->addrs.v4addrs.dst);
1527 if ((__force u16)keys->ports.dst <
1528 (__force u16)keys->ports.src) {
1529 swap(keys->ports.src, keys->ports.dst);
1532 case FLOW_DISSECTOR_KEY_IPV6_ADDRS:
1533 addr_diff = memcmp(&keys->addrs.v6addrs.dst,
1534 &keys->addrs.v6addrs.src,
1535 sizeof(keys->addrs.v6addrs.dst));
1536 if (addr_diff < 0) {
1537 for (i = 0; i < 4; i++)
1538 swap(keys->addrs.v6addrs.src.s6_addr32[i],
1539 keys->addrs.v6addrs.dst.s6_addr32[i]);
1541 if ((__force u16)keys->ports.dst <
1542 (__force u16)keys->ports.src) {
1543 swap(keys->ports.src, keys->ports.dst);
1549 static inline u32 __flow_hash_from_keys(struct flow_keys *keys,
1550 const siphash_key_t *keyval)
1554 __flow_hash_consistentify(keys);
1556 hash = siphash(flow_keys_hash_start(keys),
1557 flow_keys_hash_length(keys), keyval);
1564 u32 flow_hash_from_keys(struct flow_keys *keys)
1566 __flow_hash_secret_init();
1567 return __flow_hash_from_keys(keys, &hashrnd);
1569 EXPORT_SYMBOL(flow_hash_from_keys);
1571 static inline u32 ___skb_get_hash(const struct sk_buff *skb,
1572 struct flow_keys *keys,
1573 const siphash_key_t *keyval)
1575 skb_flow_dissect_flow_keys(skb, keys,
1576 FLOW_DISSECTOR_F_STOP_AT_FLOW_LABEL);
1578 return __flow_hash_from_keys(keys, keyval);
1581 struct _flow_keys_digest_data {
1590 void make_flow_keys_digest(struct flow_keys_digest *digest,
1591 const struct flow_keys *flow)
1593 struct _flow_keys_digest_data *data =
1594 (struct _flow_keys_digest_data *)digest;
1596 BUILD_BUG_ON(sizeof(*data) > sizeof(*digest));
1598 memset(digest, 0, sizeof(*digest));
1600 data->n_proto = flow->basic.n_proto;
1601 data->ip_proto = flow->basic.ip_proto;
1602 data->ports = flow->ports.ports;
1603 data->src = flow->addrs.v4addrs.src;
1604 data->dst = flow->addrs.v4addrs.dst;
1606 EXPORT_SYMBOL(make_flow_keys_digest);
1608 static struct flow_dissector flow_keys_dissector_symmetric __read_mostly;
1610 u32 __skb_get_hash_symmetric(const struct sk_buff *skb)
1612 struct flow_keys keys;
1614 __flow_hash_secret_init();
1616 memset(&keys, 0, sizeof(keys));
1617 __skb_flow_dissect(NULL, skb, &flow_keys_dissector_symmetric,
1618 &keys, NULL, 0, 0, 0,
1619 FLOW_DISSECTOR_F_STOP_AT_FLOW_LABEL);
1621 return __flow_hash_from_keys(&keys, &hashrnd);
1623 EXPORT_SYMBOL_GPL(__skb_get_hash_symmetric);
1626 * __skb_get_hash: calculate a flow hash
1627 * @skb: sk_buff to calculate flow hash from
1629 * This function calculates a flow hash based on src/dst addresses
1630 * and src/dst port numbers. Sets hash in skb to non-zero hash value
1631 * on success, zero indicates no valid hash. Also, sets l4_hash in skb
1632 * if hash is a canonical 4-tuple hash over transport ports.
1634 void __skb_get_hash(struct sk_buff *skb)
1636 struct flow_keys keys;
1639 __flow_hash_secret_init();
1641 hash = ___skb_get_hash(skb, &keys, &hashrnd);
1643 __skb_set_sw_hash(skb, hash, flow_keys_have_l4(&keys));
1645 EXPORT_SYMBOL(__skb_get_hash);
1647 __u32 skb_get_hash_perturb(const struct sk_buff *skb,
1648 const siphash_key_t *perturb)
1650 struct flow_keys keys;
1652 return ___skb_get_hash(skb, &keys, perturb);
1654 EXPORT_SYMBOL(skb_get_hash_perturb);
1656 u32 __skb_get_poff(const struct sk_buff *skb, const void *data,
1657 const struct flow_keys_basic *keys, int hlen)
1659 u32 poff = keys->control.thoff;
1661 /* skip L4 headers for fragments after the first */
1662 if ((keys->control.flags & FLOW_DIS_IS_FRAGMENT) &&
1663 !(keys->control.flags & FLOW_DIS_FIRST_FRAG))
1666 switch (keys->basic.ip_proto) {
1668 /* access doff as u8 to avoid unaligned access */
1672 doff = __skb_header_pointer(skb, poff + 12, sizeof(_doff),
1673 data, hlen, &_doff);
1677 poff += max_t(u32, sizeof(struct tcphdr), (*doff & 0xF0) >> 2);
1681 case IPPROTO_UDPLITE:
1682 poff += sizeof(struct udphdr);
1684 /* For the rest, we do not really care about header
1685 * extensions at this point for now.
1688 poff += sizeof(struct icmphdr);
1690 case IPPROTO_ICMPV6:
1691 poff += sizeof(struct icmp6hdr);
1694 poff += sizeof(struct igmphdr);
1697 poff += sizeof(struct dccp_hdr);
1700 poff += sizeof(struct sctphdr);
1708 * skb_get_poff - get the offset to the payload
1709 * @skb: sk_buff to get the payload offset from
1711 * The function will get the offset to the payload as far as it could
1712 * be dissected. The main user is currently BPF, so that we can dynamically
1713 * truncate packets without needing to push actual payload to the user
1714 * space and can analyze headers only, instead.
1716 u32 skb_get_poff(const struct sk_buff *skb)
1718 struct flow_keys_basic keys;
1720 if (!skb_flow_dissect_flow_keys_basic(NULL, skb, &keys,
1724 return __skb_get_poff(skb, skb->data, &keys, skb_headlen(skb));
1727 __u32 __get_hash_from_flowi6(const struct flowi6 *fl6, struct flow_keys *keys)
1729 memset(keys, 0, sizeof(*keys));
1731 memcpy(&keys->addrs.v6addrs.src, &fl6->saddr,
1732 sizeof(keys->addrs.v6addrs.src));
1733 memcpy(&keys->addrs.v6addrs.dst, &fl6->daddr,
1734 sizeof(keys->addrs.v6addrs.dst));
1735 keys->control.addr_type = FLOW_DISSECTOR_KEY_IPV6_ADDRS;
1736 keys->ports.src = fl6->fl6_sport;
1737 keys->ports.dst = fl6->fl6_dport;
1738 keys->keyid.keyid = fl6->fl6_gre_key;
1739 keys->tags.flow_label = (__force u32)flowi6_get_flowlabel(fl6);
1740 keys->basic.ip_proto = fl6->flowi6_proto;
1742 return flow_hash_from_keys(keys);
1744 EXPORT_SYMBOL(__get_hash_from_flowi6);
1746 static const struct flow_dissector_key flow_keys_dissector_keys[] = {
1748 .key_id = FLOW_DISSECTOR_KEY_CONTROL,
1749 .offset = offsetof(struct flow_keys, control),
1752 .key_id = FLOW_DISSECTOR_KEY_BASIC,
1753 .offset = offsetof(struct flow_keys, basic),
1756 .key_id = FLOW_DISSECTOR_KEY_IPV4_ADDRS,
1757 .offset = offsetof(struct flow_keys, addrs.v4addrs),
1760 .key_id = FLOW_DISSECTOR_KEY_IPV6_ADDRS,
1761 .offset = offsetof(struct flow_keys, addrs.v6addrs),
1764 .key_id = FLOW_DISSECTOR_KEY_TIPC,
1765 .offset = offsetof(struct flow_keys, addrs.tipckey),
1768 .key_id = FLOW_DISSECTOR_KEY_PORTS,
1769 .offset = offsetof(struct flow_keys, ports),
1772 .key_id = FLOW_DISSECTOR_KEY_VLAN,
1773 .offset = offsetof(struct flow_keys, vlan),
1776 .key_id = FLOW_DISSECTOR_KEY_FLOW_LABEL,
1777 .offset = offsetof(struct flow_keys, tags),
1780 .key_id = FLOW_DISSECTOR_KEY_GRE_KEYID,
1781 .offset = offsetof(struct flow_keys, keyid),
1785 static const struct flow_dissector_key flow_keys_dissector_symmetric_keys[] = {
1787 .key_id = FLOW_DISSECTOR_KEY_CONTROL,
1788 .offset = offsetof(struct flow_keys, control),
1791 .key_id = FLOW_DISSECTOR_KEY_BASIC,
1792 .offset = offsetof(struct flow_keys, basic),
1795 .key_id = FLOW_DISSECTOR_KEY_IPV4_ADDRS,
1796 .offset = offsetof(struct flow_keys, addrs.v4addrs),
1799 .key_id = FLOW_DISSECTOR_KEY_IPV6_ADDRS,
1800 .offset = offsetof(struct flow_keys, addrs.v6addrs),
1803 .key_id = FLOW_DISSECTOR_KEY_PORTS,
1804 .offset = offsetof(struct flow_keys, ports),
1808 static const struct flow_dissector_key flow_keys_basic_dissector_keys[] = {
1810 .key_id = FLOW_DISSECTOR_KEY_CONTROL,
1811 .offset = offsetof(struct flow_keys, control),
1814 .key_id = FLOW_DISSECTOR_KEY_BASIC,
1815 .offset = offsetof(struct flow_keys, basic),
1819 struct flow_dissector flow_keys_dissector __read_mostly;
1820 EXPORT_SYMBOL(flow_keys_dissector);
1822 struct flow_dissector flow_keys_basic_dissector __read_mostly;
1823 EXPORT_SYMBOL(flow_keys_basic_dissector);
1825 static int __init init_default_flow_dissectors(void)
1827 skb_flow_dissector_init(&flow_keys_dissector,
1828 flow_keys_dissector_keys,
1829 ARRAY_SIZE(flow_keys_dissector_keys));
1830 skb_flow_dissector_init(&flow_keys_dissector_symmetric,
1831 flow_keys_dissector_symmetric_keys,
1832 ARRAY_SIZE(flow_keys_dissector_symmetric_keys));
1833 skb_flow_dissector_init(&flow_keys_basic_dissector,
1834 flow_keys_basic_dissector_keys,
1835 ARRAY_SIZE(flow_keys_basic_dissector_keys));
1838 core_initcall(init_default_flow_dissectors);