flow_dissector: fix doc for __skb_get_hash and remove couple of empty lines
[deliverable/linux.git] / net / core / flow_dissector.c
1 #include <linux/skbuff.h>
2 #include <linux/export.h>
3 #include <linux/ip.h>
4 #include <linux/ipv6.h>
5 #include <linux/if_vlan.h>
6 #include <net/ip.h>
7 #include <net/ipv6.h>
8 #include <linux/igmp.h>
9 #include <linux/icmp.h>
10 #include <linux/sctp.h>
11 #include <linux/dccp.h>
12 #include <linux/if_tunnel.h>
13 #include <linux/if_pppox.h>
14 #include <linux/ppp_defs.h>
15 #include <net/flow_dissector.h>
16 #include <scsi/fc/fc_fcoe.h>
17
18 /* copy saddr & daddr, possibly using 64bit load/store
19 * Equivalent to : flow->src = iph->saddr;
20 * flow->dst = iph->daddr;
21 */
22 static void iph_to_flow_copy_addrs(struct flow_keys *flow, const struct iphdr *iph)
23 {
24 BUILD_BUG_ON(offsetof(typeof(*flow), dst) !=
25 offsetof(typeof(*flow), src) + sizeof(flow->src));
26 memcpy(&flow->src, &iph->saddr, sizeof(flow->src) + sizeof(flow->dst));
27 }
28
29 /**
30 * __skb_flow_get_ports - extract the upper layer ports and return them
31 * @skb: sk_buff to extract the ports from
32 * @thoff: transport header offset
33 * @ip_proto: protocol for which to get port offset
34 * @data: raw buffer pointer to the packet, if NULL use skb->data
35 * @hlen: packet header length, if @data is NULL use skb_headlen(skb)
36 *
37 * The function will try to retrieve the ports at offset thoff + poff where poff
38 * is the protocol port offset returned from proto_ports_offset
39 */
40 __be32 __skb_flow_get_ports(const struct sk_buff *skb, int thoff, u8 ip_proto,
41 void *data, int hlen)
42 {
43 int poff = proto_ports_offset(ip_proto);
44
45 if (!data) {
46 data = skb->data;
47 hlen = skb_headlen(skb);
48 }
49
50 if (poff >= 0) {
51 __be32 *ports, _ports;
52
53 ports = __skb_header_pointer(skb, thoff + poff,
54 sizeof(_ports), data, hlen, &_ports);
55 if (ports)
56 return *ports;
57 }
58
59 return 0;
60 }
61 EXPORT_SYMBOL(__skb_flow_get_ports);
62
63 /**
64 * __skb_flow_dissect - extract the flow_keys struct and return it
65 * @skb: sk_buff to extract the flow from, can be NULL if the rest are specified
66 * @data: raw buffer pointer to the packet, if NULL use skb->data
67 * @proto: protocol for which to get the flow, if @data is NULL use skb->protocol
68 * @nhoff: network header offset, if @data is NULL use skb_network_offset(skb)
69 * @hlen: packet header length, if @data is NULL use skb_headlen(skb)
70 *
71 * The function will try to retrieve the struct flow_keys from either the skbuff
72 * or a raw buffer specified by the rest parameters
73 */
74 bool __skb_flow_dissect(const struct sk_buff *skb, struct flow_keys *flow,
75 void *data, __be16 proto, int nhoff, int hlen)
76 {
77 u8 ip_proto;
78
79 if (!data) {
80 data = skb->data;
81 proto = skb->protocol;
82 nhoff = skb_network_offset(skb);
83 hlen = skb_headlen(skb);
84 }
85
86 memset(flow, 0, sizeof(*flow));
87
88 again:
89 switch (proto) {
90 case htons(ETH_P_IP): {
91 const struct iphdr *iph;
92 struct iphdr _iph;
93 ip:
94 iph = __skb_header_pointer(skb, nhoff, sizeof(_iph), data, hlen, &_iph);
95 if (!iph || iph->ihl < 5)
96 return false;
97 nhoff += iph->ihl * 4;
98
99 ip_proto = iph->protocol;
100 if (ip_is_fragment(iph))
101 ip_proto = 0;
102
103 /* skip the address processing if skb is NULL. The assumption
104 * here is that if there is no skb we are not looking for flow
105 * info but lengths and protocols.
106 */
107 if (!skb)
108 break;
109
110 iph_to_flow_copy_addrs(flow, iph);
111 break;
112 }
113 case htons(ETH_P_IPV6): {
114 const struct ipv6hdr *iph;
115 struct ipv6hdr _iph;
116 __be32 flow_label;
117
118 ipv6:
119 iph = __skb_header_pointer(skb, nhoff, sizeof(_iph), data, hlen, &_iph);
120 if (!iph)
121 return false;
122
123 ip_proto = iph->nexthdr;
124 nhoff += sizeof(struct ipv6hdr);
125
126 /* see comment above in IPv4 section */
127 if (!skb)
128 break;
129
130 flow->src = (__force __be32)ipv6_addr_hash(&iph->saddr);
131 flow->dst = (__force __be32)ipv6_addr_hash(&iph->daddr);
132
133 flow_label = ip6_flowlabel(iph);
134 if (flow_label) {
135 /* Awesome, IPv6 packet has a flow label so we can
136 * use that to represent the ports without any
137 * further dissection.
138 */
139 flow->n_proto = proto;
140 flow->ip_proto = ip_proto;
141 flow->ports = flow_label;
142 flow->thoff = (u16)nhoff;
143
144 return true;
145 }
146
147 break;
148 }
149 case htons(ETH_P_8021AD):
150 case htons(ETH_P_8021Q): {
151 const struct vlan_hdr *vlan;
152 struct vlan_hdr _vlan;
153
154 vlan = __skb_header_pointer(skb, nhoff, sizeof(_vlan), data, hlen, &_vlan);
155 if (!vlan)
156 return false;
157
158 proto = vlan->h_vlan_encapsulated_proto;
159 nhoff += sizeof(*vlan);
160 goto again;
161 }
162 case htons(ETH_P_PPP_SES): {
163 struct {
164 struct pppoe_hdr hdr;
165 __be16 proto;
166 } *hdr, _hdr;
167 hdr = __skb_header_pointer(skb, nhoff, sizeof(_hdr), data, hlen, &_hdr);
168 if (!hdr)
169 return false;
170 proto = hdr->proto;
171 nhoff += PPPOE_SES_HLEN;
172 switch (proto) {
173 case htons(PPP_IP):
174 goto ip;
175 case htons(PPP_IPV6):
176 goto ipv6;
177 default:
178 return false;
179 }
180 }
181 case htons(ETH_P_TIPC): {
182 struct {
183 __be32 pre[3];
184 __be32 srcnode;
185 } *hdr, _hdr;
186 hdr = __skb_header_pointer(skb, nhoff, sizeof(_hdr), data, hlen, &_hdr);
187 if (!hdr)
188 return false;
189 flow->src = hdr->srcnode;
190 flow->dst = 0;
191 flow->n_proto = proto;
192 flow->thoff = (u16)nhoff;
193 return true;
194 }
195 case htons(ETH_P_FCOE):
196 flow->thoff = (u16)(nhoff + FCOE_HEADER_LEN);
197 /* fall through */
198 default:
199 return false;
200 }
201
202 switch (ip_proto) {
203 case IPPROTO_GRE: {
204 struct gre_hdr {
205 __be16 flags;
206 __be16 proto;
207 } *hdr, _hdr;
208
209 hdr = __skb_header_pointer(skb, nhoff, sizeof(_hdr), data, hlen, &_hdr);
210 if (!hdr)
211 return false;
212 /*
213 * Only look inside GRE if version zero and no
214 * routing
215 */
216 if (!(hdr->flags & (GRE_VERSION|GRE_ROUTING))) {
217 proto = hdr->proto;
218 nhoff += 4;
219 if (hdr->flags & GRE_CSUM)
220 nhoff += 4;
221 if (hdr->flags & GRE_KEY)
222 nhoff += 4;
223 if (hdr->flags & GRE_SEQ)
224 nhoff += 4;
225 if (proto == htons(ETH_P_TEB)) {
226 const struct ethhdr *eth;
227 struct ethhdr _eth;
228
229 eth = __skb_header_pointer(skb, nhoff,
230 sizeof(_eth),
231 data, hlen, &_eth);
232 if (!eth)
233 return false;
234 proto = eth->h_proto;
235 nhoff += sizeof(*eth);
236 }
237 goto again;
238 }
239 break;
240 }
241 case IPPROTO_IPIP:
242 proto = htons(ETH_P_IP);
243 goto ip;
244 case IPPROTO_IPV6:
245 proto = htons(ETH_P_IPV6);
246 goto ipv6;
247 default:
248 break;
249 }
250
251 flow->n_proto = proto;
252 flow->ip_proto = ip_proto;
253 flow->thoff = (u16) nhoff;
254
255 /* unless skb is set we don't need to record port info */
256 if (skb)
257 flow->ports = __skb_flow_get_ports(skb, nhoff, ip_proto,
258 data, hlen);
259
260 return true;
261 }
262 EXPORT_SYMBOL(__skb_flow_dissect);
263
264 static u32 hashrnd __read_mostly;
265 static __always_inline void __flow_hash_secret_init(void)
266 {
267 net_get_random_once(&hashrnd, sizeof(hashrnd));
268 }
269
270 static __always_inline u32 __flow_hash_3words(u32 a, u32 b, u32 c, u32 keyval)
271 {
272 return jhash_3words(a, b, c, keyval);
273 }
274
275 static inline u32 __flow_hash_from_keys(struct flow_keys *keys, u32 keyval)
276 {
277 u32 hash;
278
279 /* get a consistent hash (same value on both flow directions) */
280 if (((__force u32)keys->dst < (__force u32)keys->src) ||
281 (((__force u32)keys->dst == (__force u32)keys->src) &&
282 ((__force u16)keys->port16[1] < (__force u16)keys->port16[0]))) {
283 swap(keys->dst, keys->src);
284 swap(keys->port16[0], keys->port16[1]);
285 }
286
287 hash = __flow_hash_3words((__force u32)keys->dst,
288 (__force u32)keys->src,
289 (__force u32)keys->ports,
290 keyval);
291 if (!hash)
292 hash = 1;
293
294 return hash;
295 }
296
297 u32 flow_hash_from_keys(struct flow_keys *keys)
298 {
299 __flow_hash_secret_init();
300 return __flow_hash_from_keys(keys, hashrnd);
301 }
302 EXPORT_SYMBOL(flow_hash_from_keys);
303
304 static inline u32 ___skb_get_hash(const struct sk_buff *skb,
305 struct flow_keys *keys, u32 keyval)
306 {
307 if (!skb_flow_dissect(skb, keys))
308 return 0;
309
310 return __flow_hash_from_keys(keys, keyval);
311 }
312
313 struct _flow_keys_digest_data {
314 __be16 n_proto;
315 u8 ip_proto;
316 u8 padding;
317 __be32 ports;
318 __be32 src;
319 __be32 dst;
320 };
321
322 void make_flow_keys_digest(struct flow_keys_digest *digest,
323 const struct flow_keys *flow)
324 {
325 struct _flow_keys_digest_data *data =
326 (struct _flow_keys_digest_data *)digest;
327
328 BUILD_BUG_ON(sizeof(*data) > sizeof(*digest));
329
330 memset(digest, 0, sizeof(*digest));
331
332 data->n_proto = flow->n_proto;
333 data->ip_proto = flow->ip_proto;
334 data->ports = flow->ports;
335 data->src = flow->src;
336 data->dst = flow->dst;
337 }
338 EXPORT_SYMBOL(make_flow_keys_digest);
339
340 /**
341 * __skb_get_hash: calculate a flow hash
342 * @skb: sk_buff to calculate flow hash from
343 *
344 * This function calculates a flow hash based on src/dst addresses
345 * and src/dst port numbers. Sets hash in skb to non-zero hash value
346 * on success, zero indicates no valid hash. Also, sets l4_hash in skb
347 * if hash is a canonical 4-tuple hash over transport ports.
348 */
349 void __skb_get_hash(struct sk_buff *skb)
350 {
351 struct flow_keys keys;
352 u32 hash;
353
354 __flow_hash_secret_init();
355
356 hash = ___skb_get_hash(skb, &keys, hashrnd);
357 if (!hash)
358 return;
359 if (keys.ports)
360 skb->l4_hash = 1;
361 skb->sw_hash = 1;
362 skb->hash = hash;
363 }
364 EXPORT_SYMBOL(__skb_get_hash);
365
366 __u32 skb_get_hash_perturb(const struct sk_buff *skb, u32 perturb)
367 {
368 struct flow_keys keys;
369
370 return ___skb_get_hash(skb, &keys, perturb);
371 }
372 EXPORT_SYMBOL(skb_get_hash_perturb);
373
374 /*
375 * Returns a Tx hash based on the given packet descriptor a Tx queues' number
376 * to be used as a distribution range.
377 */
378 u16 __skb_tx_hash(const struct net_device *dev, struct sk_buff *skb,
379 unsigned int num_tx_queues)
380 {
381 u32 hash;
382 u16 qoffset = 0;
383 u16 qcount = num_tx_queues;
384
385 if (skb_rx_queue_recorded(skb)) {
386 hash = skb_get_rx_queue(skb);
387 while (unlikely(hash >= num_tx_queues))
388 hash -= num_tx_queues;
389 return hash;
390 }
391
392 if (dev->num_tc) {
393 u8 tc = netdev_get_prio_tc_map(dev, skb->priority);
394 qoffset = dev->tc_to_txq[tc].offset;
395 qcount = dev->tc_to_txq[tc].count;
396 }
397
398 return (u16) reciprocal_scale(skb_get_hash(skb), qcount) + qoffset;
399 }
400 EXPORT_SYMBOL(__skb_tx_hash);
401
402 u32 __skb_get_poff(const struct sk_buff *skb, void *data,
403 const struct flow_keys *keys, int hlen)
404 {
405 u32 poff = keys->thoff;
406
407 switch (keys->ip_proto) {
408 case IPPROTO_TCP: {
409 /* access doff as u8 to avoid unaligned access */
410 const u8 *doff;
411 u8 _doff;
412
413 doff = __skb_header_pointer(skb, poff + 12, sizeof(_doff),
414 data, hlen, &_doff);
415 if (!doff)
416 return poff;
417
418 poff += max_t(u32, sizeof(struct tcphdr), (*doff & 0xF0) >> 2);
419 break;
420 }
421 case IPPROTO_UDP:
422 case IPPROTO_UDPLITE:
423 poff += sizeof(struct udphdr);
424 break;
425 /* For the rest, we do not really care about header
426 * extensions at this point for now.
427 */
428 case IPPROTO_ICMP:
429 poff += sizeof(struct icmphdr);
430 break;
431 case IPPROTO_ICMPV6:
432 poff += sizeof(struct icmp6hdr);
433 break;
434 case IPPROTO_IGMP:
435 poff += sizeof(struct igmphdr);
436 break;
437 case IPPROTO_DCCP:
438 poff += sizeof(struct dccp_hdr);
439 break;
440 case IPPROTO_SCTP:
441 poff += sizeof(struct sctphdr);
442 break;
443 }
444
445 return poff;
446 }
447
448 /* skb_get_poff() returns the offset to the payload as far as it could
449 * be dissected. The main user is currently BPF, so that we can dynamically
450 * truncate packets without needing to push actual payload to the user
451 * space and can analyze headers only, instead.
452 */
453 u32 skb_get_poff(const struct sk_buff *skb)
454 {
455 struct flow_keys keys;
456
457 if (!skb_flow_dissect(skb, &keys))
458 return 0;
459
460 return __skb_get_poff(skb, skb->data, &keys, skb_headlen(skb));
461 }
462
463 static inline int get_xps_queue(struct net_device *dev, struct sk_buff *skb)
464 {
465 #ifdef CONFIG_XPS
466 struct xps_dev_maps *dev_maps;
467 struct xps_map *map;
468 int queue_index = -1;
469
470 rcu_read_lock();
471 dev_maps = rcu_dereference(dev->xps_maps);
472 if (dev_maps) {
473 map = rcu_dereference(
474 dev_maps->cpu_map[skb->sender_cpu - 1]);
475 if (map) {
476 if (map->len == 1)
477 queue_index = map->queues[0];
478 else
479 queue_index = map->queues[reciprocal_scale(skb_get_hash(skb),
480 map->len)];
481 if (unlikely(queue_index >= dev->real_num_tx_queues))
482 queue_index = -1;
483 }
484 }
485 rcu_read_unlock();
486
487 return queue_index;
488 #else
489 return -1;
490 #endif
491 }
492
493 static u16 __netdev_pick_tx(struct net_device *dev, struct sk_buff *skb)
494 {
495 struct sock *sk = skb->sk;
496 int queue_index = sk_tx_queue_get(sk);
497
498 if (queue_index < 0 || skb->ooo_okay ||
499 queue_index >= dev->real_num_tx_queues) {
500 int new_index = get_xps_queue(dev, skb);
501 if (new_index < 0)
502 new_index = skb_tx_hash(dev, skb);
503
504 if (queue_index != new_index && sk &&
505 rcu_access_pointer(sk->sk_dst_cache))
506 sk_tx_queue_set(sk, new_index);
507
508 queue_index = new_index;
509 }
510
511 return queue_index;
512 }
513
514 struct netdev_queue *netdev_pick_tx(struct net_device *dev,
515 struct sk_buff *skb,
516 void *accel_priv)
517 {
518 int queue_index = 0;
519
520 #ifdef CONFIG_XPS
521 if (skb->sender_cpu == 0)
522 skb->sender_cpu = raw_smp_processor_id() + 1;
523 #endif
524
525 if (dev->real_num_tx_queues != 1) {
526 const struct net_device_ops *ops = dev->netdev_ops;
527 if (ops->ndo_select_queue)
528 queue_index = ops->ndo_select_queue(dev, skb, accel_priv,
529 __netdev_pick_tx);
530 else
531 queue_index = __netdev_pick_tx(dev, skb);
532
533 if (!accel_priv)
534 queue_index = netdev_cap_txqueue(dev, queue_index);
535 }
536
537 skb_set_queue_mapping(skb, queue_index);
538 return netdev_get_tx_queue(dev, queue_index);
539 }
This page took 0.043259 seconds and 6 git commands to generate.