GNU Linux-libre 4.14.251-gnu1
[releases.git] / include / linux / skbuff.h
1 /*
2  *      Definitions for the 'struct sk_buff' memory handlers.
3  *
4  *      Authors:
5  *              Alan Cox, <gw4pts@gw4pts.ampr.org>
6  *              Florian La Roche, <rzsfl@rz.uni-sb.de>
7  *
8  *      This program is free software; you can redistribute it and/or
9  *      modify it under the terms of the GNU General Public License
10  *      as published by the Free Software Foundation; either version
11  *      2 of the License, or (at your option) any later version.
12  */
13
14 #ifndef _LINUX_SKBUFF_H
15 #define _LINUX_SKBUFF_H
16
17 #include <linux/kernel.h>
18 #include <linux/compiler.h>
19 #include <linux/time.h>
20 #include <linux/bug.h>
21 #include <linux/cache.h>
22 #include <linux/rbtree.h>
23 #include <linux/socket.h>
24 #include <linux/refcount.h>
25
26 #include <linux/atomic.h>
27 #include <asm/types.h>
28 #include <linux/spinlock.h>
29 #include <linux/net.h>
30 #include <linux/textsearch.h>
31 #include <net/checksum.h>
32 #include <linux/rcupdate.h>
33 #include <linux/hrtimer.h>
34 #include <linux/dma-mapping.h>
35 #include <linux/netdev_features.h>
36 #include <linux/sched.h>
37 #include <linux/sched/clock.h>
38 #include <net/flow_dissector.h>
39 #include <linux/splice.h>
40 #include <linux/in6.h>
41 #include <linux/if_packet.h>
42 #include <net/flow.h>
43
44 /* The interface for checksum offload between the stack and networking drivers
45  * is as follows...
46  *
47  * A. IP checksum related features
48  *
49  * Drivers advertise checksum offload capabilities in the features of a device.
50  * From the stack's point of view these are capabilities offered by the driver,
51  * a driver typically only advertises features that it is capable of offloading
52  * to its device.
53  *
54  * The checksum related features are:
55  *
56  *      NETIF_F_HW_CSUM - The driver (or its device) is able to compute one
57  *                        IP (one's complement) checksum for any combination
58  *                        of protocols or protocol layering. The checksum is
59  *                        computed and set in a packet per the CHECKSUM_PARTIAL
60  *                        interface (see below).
61  *
62  *      NETIF_F_IP_CSUM - Driver (device) is only able to checksum plain
63  *                        TCP or UDP packets over IPv4. These are specifically
64  *                        unencapsulated packets of the form IPv4|TCP or
65  *                        IPv4|UDP where the Protocol field in the IPv4 header
66  *                        is TCP or UDP. The IPv4 header may contain IP options
67  *                        This feature cannot be set in features for a device
68  *                        with NETIF_F_HW_CSUM also set. This feature is being
69  *                        DEPRECATED (see below).
70  *
71  *      NETIF_F_IPV6_CSUM - Driver (device) is only able to checksum plain
72  *                        TCP or UDP packets over IPv6. These are specifically
73  *                        unencapsulated packets of the form IPv6|TCP or
74  *                        IPv4|UDP where the Next Header field in the IPv6
75  *                        header is either TCP or UDP. IPv6 extension headers
76  *                        are not supported with this feature. This feature
77  *                        cannot be set in features for a device with
78  *                        NETIF_F_HW_CSUM also set. This feature is being
79  *                        DEPRECATED (see below).
80  *
81  *      NETIF_F_RXCSUM - Driver (device) performs receive checksum offload.
82  *                       This flag is used only used to disable the RX checksum
83  *                       feature for a device. The stack will accept receive
84  *                       checksum indication in packets received on a device
85  *                       regardless of whether NETIF_F_RXCSUM is set.
86  *
87  * B. Checksumming of received packets by device. Indication of checksum
88  *    verification is in set skb->ip_summed. Possible values are:
89  *
90  * CHECKSUM_NONE:
91  *
92  *   Device did not checksum this packet e.g. due to lack of capabilities.
93  *   The packet contains full (though not verified) checksum in packet but
94  *   not in skb->csum. Thus, skb->csum is undefined in this case.
95  *
96  * CHECKSUM_UNNECESSARY:
97  *
98  *   The hardware you're dealing with doesn't calculate the full checksum
99  *   (as in CHECKSUM_COMPLETE), but it does parse headers and verify checksums
100  *   for specific protocols. For such packets it will set CHECKSUM_UNNECESSARY
101  *   if their checksums are okay. skb->csum is still undefined in this case
102  *   though. A driver or device must never modify the checksum field in the
103  *   packet even if checksum is verified.
104  *
105  *   CHECKSUM_UNNECESSARY is applicable to following protocols:
106  *     TCP: IPv6 and IPv4.
107  *     UDP: IPv4 and IPv6. A device may apply CHECKSUM_UNNECESSARY to a
108  *       zero UDP checksum for either IPv4 or IPv6, the networking stack
109  *       may perform further validation in this case.
110  *     GRE: only if the checksum is present in the header.
111  *     SCTP: indicates the CRC in SCTP header has been validated.
112  *     FCOE: indicates the CRC in FC frame has been validated.
113  *
114  *   skb->csum_level indicates the number of consecutive checksums found in
115  *   the packet minus one that have been verified as CHECKSUM_UNNECESSARY.
116  *   For instance if a device receives an IPv6->UDP->GRE->IPv4->TCP packet
117  *   and a device is able to verify the checksums for UDP (possibly zero),
118  *   GRE (checksum flag is set), and TCP-- skb->csum_level would be set to
119  *   two. If the device were only able to verify the UDP checksum and not
120  *   GRE, either because it doesn't support GRE checksum of because GRE
121  *   checksum is bad, skb->csum_level would be set to zero (TCP checksum is
122  *   not considered in this case).
123  *
124  * CHECKSUM_COMPLETE:
125  *
126  *   This is the most generic way. The device supplied checksum of the _whole_
127  *   packet as seen by netif_rx() and fills out in skb->csum. Meaning, the
128  *   hardware doesn't need to parse L3/L4 headers to implement this.
129  *
130  *   Notes:
131  *   - Even if device supports only some protocols, but is able to produce
132  *     skb->csum, it MUST use CHECKSUM_COMPLETE, not CHECKSUM_UNNECESSARY.
133  *   - CHECKSUM_COMPLETE is not applicable to SCTP and FCoE protocols.
134  *
135  * CHECKSUM_PARTIAL:
136  *
137  *   A checksum is set up to be offloaded to a device as described in the
138  *   output description for CHECKSUM_PARTIAL. This may occur on a packet
139  *   received directly from another Linux OS, e.g., a virtualized Linux kernel
140  *   on the same host, or it may be set in the input path in GRO or remote
141  *   checksum offload. For the purposes of checksum verification, the checksum
142  *   referred to by skb->csum_start + skb->csum_offset and any preceding
143  *   checksums in the packet are considered verified. Any checksums in the
144  *   packet that are after the checksum being offloaded are not considered to
145  *   be verified.
146  *
147  * C. Checksumming on transmit for non-GSO. The stack requests checksum offload
148  *    in the skb->ip_summed for a packet. Values are:
149  *
150  * CHECKSUM_PARTIAL:
151  *
152  *   The driver is required to checksum the packet as seen by hard_start_xmit()
153  *   from skb->csum_start up to the end, and to record/write the checksum at
154  *   offset skb->csum_start + skb->csum_offset. A driver may verify that the
155  *   csum_start and csum_offset values are valid values given the length and
156  *   offset of the packet, however they should not attempt to validate that the
157  *   checksum refers to a legitimate transport layer checksum-- it is the
158  *   purview of the stack to validate that csum_start and csum_offset are set
159  *   correctly.
160  *
161  *   When the stack requests checksum offload for a packet, the driver MUST
162  *   ensure that the checksum is set correctly. A driver can either offload the
163  *   checksum calculation to the device, or call skb_checksum_help (in the case
164  *   that the device does not support offload for a particular checksum).
165  *
166  *   NETIF_F_IP_CSUM and NETIF_F_IPV6_CSUM are being deprecated in favor of
167  *   NETIF_F_HW_CSUM. New devices should use NETIF_F_HW_CSUM to indicate
168  *   checksum offload capability.
169  *   skb_csum_hwoffload_help() can be called to resolve CHECKSUM_PARTIAL based
170  *   on network device checksumming capabilities: if a packet does not match
171  *   them, skb_checksum_help or skb_crc32c_help (depending on the value of
172  *   csum_not_inet, see item D.) is called to resolve the checksum.
173  *
174  * CHECKSUM_NONE:
175  *
176  *   The skb was already checksummed by the protocol, or a checksum is not
177  *   required.
178  *
179  * CHECKSUM_UNNECESSARY:
180  *
181  *   This has the same meaning on as CHECKSUM_NONE for checksum offload on
182  *   output.
183  *
184  * CHECKSUM_COMPLETE:
185  *   Not used in checksum output. If a driver observes a packet with this value
186  *   set in skbuff, if should treat as CHECKSUM_NONE being set.
187  *
188  * D. Non-IP checksum (CRC) offloads
189  *
190  *   NETIF_F_SCTP_CRC - This feature indicates that a device is capable of
191  *     offloading the SCTP CRC in a packet. To perform this offload the stack
192  *     will set set csum_start and csum_offset accordingly, set ip_summed to
193  *     CHECKSUM_PARTIAL and set csum_not_inet to 1, to provide an indication in
194  *     the skbuff that the CHECKSUM_PARTIAL refers to CRC32c.
195  *     A driver that supports both IP checksum offload and SCTP CRC32c offload
196  *     must verify which offload is configured for a packet by testing the
197  *     value of skb->csum_not_inet; skb_crc32c_csum_help is provided to resolve
198  *     CHECKSUM_PARTIAL on skbs where csum_not_inet is set to 1.
199  *
200  *   NETIF_F_FCOE_CRC - This feature indicates that a device is capable of
201  *     offloading the FCOE CRC in a packet. To perform this offload the stack
202  *     will set ip_summed to CHECKSUM_PARTIAL and set csum_start and csum_offset
203  *     accordingly. Note the there is no indication in the skbuff that the
204  *     CHECKSUM_PARTIAL refers to an FCOE checksum, a driver that supports
205  *     both IP checksum offload and FCOE CRC offload must verify which offload
206  *     is configured for a packet presumably by inspecting packet headers.
207  *
208  * E. Checksumming on output with GSO.
209  *
210  * In the case of a GSO packet (skb_is_gso(skb) is true), checksum offload
211  * is implied by the SKB_GSO_* flags in gso_type. Most obviously, if the
212  * gso_type is SKB_GSO_TCPV4 or SKB_GSO_TCPV6, TCP checksum offload as
213  * part of the GSO operation is implied. If a checksum is being offloaded
214  * with GSO then ip_summed is CHECKSUM_PARTIAL, csum_start and csum_offset
215  * are set to refer to the outermost checksum being offload (two offloaded
216  * checksums are possible with UDP encapsulation).
217  */
218
219 /* Don't change this without changing skb_csum_unnecessary! */
220 #define CHECKSUM_NONE           0
221 #define CHECKSUM_UNNECESSARY    1
222 #define CHECKSUM_COMPLETE       2
223 #define CHECKSUM_PARTIAL        3
224
225 /* Maximum value in skb->csum_level */
226 #define SKB_MAX_CSUM_LEVEL      3
227
228 #define SKB_DATA_ALIGN(X)       ALIGN(X, SMP_CACHE_BYTES)
229 #define SKB_WITH_OVERHEAD(X)    \
230         ((X) - SKB_DATA_ALIGN(sizeof(struct skb_shared_info)))
231 #define SKB_MAX_ORDER(X, ORDER) \
232         SKB_WITH_OVERHEAD((PAGE_SIZE << (ORDER)) - (X))
233 #define SKB_MAX_HEAD(X)         (SKB_MAX_ORDER((X), 0))
234 #define SKB_MAX_ALLOC           (SKB_MAX_ORDER(0, 2))
235
236 /* return minimum truesize of one skb containing X bytes of data */
237 #define SKB_TRUESIZE(X) ((X) +                                          \
238                          SKB_DATA_ALIGN(sizeof(struct sk_buff)) +       \
239                          SKB_DATA_ALIGN(sizeof(struct skb_shared_info)))
240
241 struct net_device;
242 struct scatterlist;
243 struct pipe_inode_info;
244 struct iov_iter;
245 struct napi_struct;
246
247 #if defined(CONFIG_NF_CONNTRACK) || defined(CONFIG_NF_CONNTRACK_MODULE)
248 struct nf_conntrack {
249         atomic_t use;
250 };
251 #endif
252
253 #if IS_ENABLED(CONFIG_BRIDGE_NETFILTER)
254 struct nf_bridge_info {
255         refcount_t              use;
256         enum {
257                 BRNF_PROTO_UNCHANGED,
258                 BRNF_PROTO_8021Q,
259                 BRNF_PROTO_PPPOE
260         } orig_proto:8;
261         u8                      pkt_otherhost:1;
262         u8                      in_prerouting:1;
263         u8                      bridged_dnat:1;
264         __u16                   frag_max_size;
265         struct net_device       *physindev;
266
267         /* always valid & non-NULL from FORWARD on, for physdev match */
268         struct net_device       *physoutdev;
269         union {
270                 /* prerouting: detect dnat in orig/reply direction */
271                 __be32          ipv4_daddr;
272                 struct in6_addr ipv6_daddr;
273
274                 /* after prerouting + nat detected: store original source
275                  * mac since neigh resolution overwrites it, only used while
276                  * skb is out in neigh layer.
277                  */
278                 char neigh_header[8];
279         };
280 };
281 #endif
282
283 struct sk_buff_head {
284         /* These two members must be first. */
285         struct sk_buff  *next;
286         struct sk_buff  *prev;
287
288         __u32           qlen;
289         spinlock_t      lock;
290 };
291
292 struct sk_buff;
293
294 /* To allow 64K frame to be packed as single skb without frag_list we
295  * require 64K/PAGE_SIZE pages plus 1 additional page to allow for
296  * buffers which do not start on a page boundary.
297  *
298  * Since GRO uses frags we allocate at least 16 regardless of page
299  * size.
300  */
301 #if (65536/PAGE_SIZE + 1) < 16
302 #define MAX_SKB_FRAGS 16UL
303 #else
304 #define MAX_SKB_FRAGS (65536/PAGE_SIZE + 1)
305 #endif
306 extern int sysctl_max_skb_frags;
307
308 /* Set skb_shinfo(skb)->gso_size to this in case you want skb_segment to
309  * segment using its current segmentation instead.
310  */
311 #define GSO_BY_FRAGS    0xFFFF
312
313 typedef struct skb_frag_struct skb_frag_t;
314
315 struct skb_frag_struct {
316         struct {
317                 struct page *p;
318         } page;
319 #if (BITS_PER_LONG > 32) || (PAGE_SIZE >= 65536)
320         __u32 page_offset;
321         __u32 size;
322 #else
323         __u16 page_offset;
324         __u16 size;
325 #endif
326 };
327
328 static inline unsigned int skb_frag_size(const skb_frag_t *frag)
329 {
330         return frag->size;
331 }
332
333 static inline void skb_frag_size_set(skb_frag_t *frag, unsigned int size)
334 {
335         frag->size = size;
336 }
337
338 static inline void skb_frag_size_add(skb_frag_t *frag, int delta)
339 {
340         frag->size += delta;
341 }
342
343 static inline void skb_frag_size_sub(skb_frag_t *frag, int delta)
344 {
345         frag->size -= delta;
346 }
347
348 static inline bool skb_frag_must_loop(struct page *p)
349 {
350 #if defined(CONFIG_HIGHMEM)
351         if (PageHighMem(p))
352                 return true;
353 #endif
354         return false;
355 }
356
357 /**
358  *      skb_frag_foreach_page - loop over pages in a fragment
359  *
360  *      @f:             skb frag to operate on
361  *      @f_off:         offset from start of f->page.p
362  *      @f_len:         length from f_off to loop over
363  *      @p:             (temp var) current page
364  *      @p_off:         (temp var) offset from start of current page,
365  *                                 non-zero only on first page.
366  *      @p_len:         (temp var) length in current page,
367  *                                 < PAGE_SIZE only on first and last page.
368  *      @copied:        (temp var) length so far, excluding current p_len.
369  *
370  *      A fragment can hold a compound page, in which case per-page
371  *      operations, notably kmap_atomic, must be called for each
372  *      regular page.
373  */
374 #define skb_frag_foreach_page(f, f_off, f_len, p, p_off, p_len, copied) \
375         for (p = skb_frag_page(f) + ((f_off) >> PAGE_SHIFT),            \
376              p_off = (f_off) & (PAGE_SIZE - 1),                         \
377              p_len = skb_frag_must_loop(p) ?                            \
378              min_t(u32, f_len, PAGE_SIZE - p_off) : f_len,              \
379              copied = 0;                                                \
380              copied < f_len;                                            \
381              copied += p_len, p++, p_off = 0,                           \
382              p_len = min_t(u32, f_len - copied, PAGE_SIZE))             \
383
384 #define HAVE_HW_TIME_STAMP
385
386 /**
387  * struct skb_shared_hwtstamps - hardware time stamps
388  * @hwtstamp:   hardware time stamp transformed into duration
389  *              since arbitrary point in time
390  *
391  * Software time stamps generated by ktime_get_real() are stored in
392  * skb->tstamp.
393  *
394  * hwtstamps can only be compared against other hwtstamps from
395  * the same device.
396  *
397  * This structure is attached to packets as part of the
398  * &skb_shared_info. Use skb_hwtstamps() to get a pointer.
399  */
400 struct skb_shared_hwtstamps {
401         ktime_t hwtstamp;
402 };
403
404 /* Definitions for tx_flags in struct skb_shared_info */
405 enum {
406         /* generate hardware time stamp */
407         SKBTX_HW_TSTAMP = 1 << 0,
408
409         /* generate software time stamp when queueing packet to NIC */
410         SKBTX_SW_TSTAMP = 1 << 1,
411
412         /* device driver is going to provide hardware time stamp */
413         SKBTX_IN_PROGRESS = 1 << 2,
414
415         /* device driver supports TX zero-copy buffers */
416         SKBTX_DEV_ZEROCOPY = 1 << 3,
417
418         /* generate wifi status information (where possible) */
419         SKBTX_WIFI_STATUS = 1 << 4,
420
421         /* This indicates at least one fragment might be overwritten
422          * (as in vmsplice(), sendfile() ...)
423          * If we need to compute a TX checksum, we'll need to copy
424          * all frags to avoid possible bad checksum
425          */
426         SKBTX_SHARED_FRAG = 1 << 5,
427
428         /* generate software time stamp when entering packet scheduling */
429         SKBTX_SCHED_TSTAMP = 1 << 6,
430 };
431
432 #define SKBTX_ZEROCOPY_FRAG     (SKBTX_DEV_ZEROCOPY | SKBTX_SHARED_FRAG)
433 #define SKBTX_ANY_SW_TSTAMP     (SKBTX_SW_TSTAMP    | \
434                                  SKBTX_SCHED_TSTAMP)
435 #define SKBTX_ANY_TSTAMP        (SKBTX_HW_TSTAMP | SKBTX_ANY_SW_TSTAMP)
436
437 /*
438  * The callback notifies userspace to release buffers when skb DMA is done in
439  * lower device, the skb last reference should be 0 when calling this.
440  * The zerocopy_success argument is true if zero copy transmit occurred,
441  * false on data copy or out of memory error caused by data copy attempt.
442  * The ctx field is used to track device context.
443  * The desc field is used to track userspace buffer index.
444  */
445 struct ubuf_info {
446         void (*callback)(struct ubuf_info *, bool zerocopy_success);
447         union {
448                 struct {
449                         unsigned long desc;
450                         void *ctx;
451                 };
452                 struct {
453                         u32 id;
454                         u16 len;
455                         u16 zerocopy:1;
456                         u32 bytelen;
457                 };
458         };
459         refcount_t refcnt;
460
461         struct mmpin {
462                 struct user_struct *user;
463                 unsigned int num_pg;
464         } mmp;
465 };
466
467 #define skb_uarg(SKB)   ((struct ubuf_info *)(skb_shinfo(SKB)->destructor_arg))
468
469 struct ubuf_info *sock_zerocopy_alloc(struct sock *sk, size_t size);
470 struct ubuf_info *sock_zerocopy_realloc(struct sock *sk, size_t size,
471                                         struct ubuf_info *uarg);
472
473 static inline void sock_zerocopy_get(struct ubuf_info *uarg)
474 {
475         refcount_inc(&uarg->refcnt);
476 }
477
478 void sock_zerocopy_put(struct ubuf_info *uarg);
479 void sock_zerocopy_put_abort(struct ubuf_info *uarg);
480
481 void sock_zerocopy_callback(struct ubuf_info *uarg, bool success);
482
483 int skb_zerocopy_iter_stream(struct sock *sk, struct sk_buff *skb,
484                              struct msghdr *msg, int len,
485                              struct ubuf_info *uarg);
486
487 /* This data is invariant across clones and lives at
488  * the end of the header data, ie. at skb->end.
489  */
490 struct skb_shared_info {
491         unsigned short  _unused;
492         unsigned char   nr_frags;
493         __u8            tx_flags;
494         unsigned short  gso_size;
495         /* Warning: this field is not always filled in (UFO)! */
496         unsigned short  gso_segs;
497         struct sk_buff  *frag_list;
498         struct skb_shared_hwtstamps hwtstamps;
499         unsigned int    gso_type;
500         u32             tskey;
501         __be32          ip6_frag_id;
502
503         /*
504          * Warning : all fields before dataref are cleared in __alloc_skb()
505          */
506         atomic_t        dataref;
507
508         /* Intermediate layers must ensure that destructor_arg
509          * remains valid until skb destructor */
510         void *          destructor_arg;
511
512         /* must be last field, see pskb_expand_head() */
513         skb_frag_t      frags[MAX_SKB_FRAGS];
514 };
515
516 /* We divide dataref into two halves.  The higher 16 bits hold references
517  * to the payload part of skb->data.  The lower 16 bits hold references to
518  * the entire skb->data.  A clone of a headerless skb holds the length of
519  * the header in skb->hdr_len.
520  *
521  * All users must obey the rule that the skb->data reference count must be
522  * greater than or equal to the payload reference count.
523  *
524  * Holding a reference to the payload part means that the user does not
525  * care about modifications to the header part of skb->data.
526  */
527 #define SKB_DATAREF_SHIFT 16
528 #define SKB_DATAREF_MASK ((1 << SKB_DATAREF_SHIFT) - 1)
529
530
531 enum {
532         SKB_FCLONE_UNAVAILABLE, /* skb has no fclone (from head_cache) */
533         SKB_FCLONE_ORIG,        /* orig skb (from fclone_cache) */
534         SKB_FCLONE_CLONE,       /* companion fclone skb (from fclone_cache) */
535 };
536
537 enum {
538         SKB_GSO_TCPV4 = 1 << 0,
539
540         /* This indicates the skb is from an untrusted source. */
541         SKB_GSO_DODGY = 1 << 1,
542
543         /* This indicates the tcp segment has CWR set. */
544         SKB_GSO_TCP_ECN = 1 << 2,
545
546         SKB_GSO_TCP_FIXEDID = 1 << 3,
547
548         SKB_GSO_TCPV6 = 1 << 4,
549
550         SKB_GSO_FCOE = 1 << 5,
551
552         SKB_GSO_GRE = 1 << 6,
553
554         SKB_GSO_GRE_CSUM = 1 << 7,
555
556         SKB_GSO_IPXIP4 = 1 << 8,
557
558         SKB_GSO_IPXIP6 = 1 << 9,
559
560         SKB_GSO_UDP_TUNNEL = 1 << 10,
561
562         SKB_GSO_UDP_TUNNEL_CSUM = 1 << 11,
563
564         SKB_GSO_PARTIAL = 1 << 12,
565
566         SKB_GSO_TUNNEL_REMCSUM = 1 << 13,
567
568         SKB_GSO_SCTP = 1 << 14,
569
570         SKB_GSO_ESP = 1 << 15,
571
572         SKB_GSO_UDP = 1 << 16,
573 };
574
575 #if BITS_PER_LONG > 32
576 #define NET_SKBUFF_DATA_USES_OFFSET 1
577 #endif
578
579 #ifdef NET_SKBUFF_DATA_USES_OFFSET
580 typedef unsigned int sk_buff_data_t;
581 #else
582 typedef unsigned char *sk_buff_data_t;
583 #endif
584
585 /** 
586  *      struct sk_buff - socket buffer
587  *      @next: Next buffer in list
588  *      @prev: Previous buffer in list
589  *      @tstamp: Time we arrived/left
590  *      @rbnode: RB tree node, alternative to next/prev for netem/tcp
591  *      @sk: Socket we are owned by
592  *      @dev: Device we arrived on/are leaving by
593  *      @cb: Control buffer. Free for use by every layer. Put private vars here
594  *      @_skb_refdst: destination entry (with norefcount bit)
595  *      @sp: the security path, used for xfrm
596  *      @len: Length of actual data
597  *      @data_len: Data length
598  *      @mac_len: Length of link layer header
599  *      @hdr_len: writable header length of cloned skb
600  *      @csum: Checksum (must include start/offset pair)
601  *      @csum_start: Offset from skb->head where checksumming should start
602  *      @csum_offset: Offset from csum_start where checksum should be stored
603  *      @priority: Packet queueing priority
604  *      @ignore_df: allow local fragmentation
605  *      @cloned: Head may be cloned (check refcnt to be sure)
606  *      @ip_summed: Driver fed us an IP checksum
607  *      @nohdr: Payload reference only, must not modify header
608  *      @pkt_type: Packet class
609  *      @fclone: skbuff clone status
610  *      @ipvs_property: skbuff is owned by ipvs
611  *      @tc_skip_classify: do not classify packet. set by IFB device
612  *      @tc_at_ingress: used within tc_classify to distinguish in/egress
613  *      @tc_redirected: packet was redirected by a tc action
614  *      @tc_from_ingress: if tc_redirected, tc_at_ingress at time of redirect
615  *      @peeked: this packet has been seen already, so stats have been
616  *              done for it, don't do them again
617  *      @nf_trace: netfilter packet trace flag
618  *      @protocol: Packet protocol from driver
619  *      @destructor: Destruct function
620  *      @_nfct: Associated connection, if any (with nfctinfo bits)
621  *      @nf_bridge: Saved data about a bridged frame - see br_netfilter.c
622  *      @skb_iif: ifindex of device we arrived on
623  *      @tc_index: Traffic control index
624  *      @hash: the packet hash
625  *      @queue_mapping: Queue mapping for multiqueue devices
626  *      @xmit_more: More SKBs are pending for this queue
627  *      @pfmemalloc: skbuff was allocated from PFMEMALLOC reserves
628  *      @ndisc_nodetype: router type (from link layer)
629  *      @ooo_okay: allow the mapping of a socket to a queue to be changed
630  *      @l4_hash: indicate hash is a canonical 4-tuple hash over transport
631  *              ports.
632  *      @sw_hash: indicates hash was computed in software stack
633  *      @wifi_acked_valid: wifi_acked was set
634  *      @wifi_acked: whether frame was acked on wifi or not
635  *      @no_fcs:  Request NIC to treat last 4 bytes as Ethernet FCS
636  *      @csum_not_inet: use CRC32c to resolve CHECKSUM_PARTIAL
637  *      @dst_pending_confirm: need to confirm neighbour
638   *     @napi_id: id of the NAPI struct this skb came from
639  *      @secmark: security marking
640  *      @mark: Generic packet mark
641  *      @vlan_proto: vlan encapsulation protocol
642  *      @vlan_tci: vlan tag control information
643  *      @inner_protocol: Protocol (encapsulation)
644  *      @inner_transport_header: Inner transport layer header (encapsulation)
645  *      @inner_network_header: Network layer header (encapsulation)
646  *      @inner_mac_header: Link layer header (encapsulation)
647  *      @transport_header: Transport layer header
648  *      @network_header: Network layer header
649  *      @mac_header: Link layer header
650  *      @tail: Tail pointer
651  *      @end: End pointer
652  *      @head: Head of buffer
653  *      @data: Data head pointer
654  *      @truesize: Buffer size
655  *      @users: User count - see {datagram,tcp}.c
656  */
657
658 struct sk_buff {
659         union {
660                 struct {
661                         /* These two members must be first. */
662                         struct sk_buff          *next;
663                         struct sk_buff          *prev;
664
665                         union {
666                                 struct net_device       *dev;
667                                 /* Some protocols might use this space to store information,
668                                  * while device pointer would be NULL.
669                                  * UDP receive path is one user.
670                                  */
671                                 unsigned long           dev_scratch;
672                         };
673                 };
674                 struct rb_node          rbnode; /* used in netem, ip4 defrag, and tcp stack */
675                 struct list_head        list;
676         };
677
678         union {
679                 struct sock             *sk;
680                 int                     ip_defrag_offset;
681         };
682
683         union {
684                 ktime_t         tstamp;
685                 u64             skb_mstamp;
686         };
687         /*
688          * This is the control buffer. It is free to use for every
689          * layer. Please put your private variables there. If you
690          * want to keep them across layers you have to do a skb_clone()
691          * first. This is owned by whoever has the skb queued ATM.
692          */
693         char                    cb[48] __aligned(8);
694
695         unsigned long           _skb_refdst;
696         void                    (*destructor)(struct sk_buff *skb);
697 #ifdef CONFIG_XFRM
698         struct  sec_path        *sp;
699 #endif
700 #if defined(CONFIG_NF_CONNTRACK) || defined(CONFIG_NF_CONNTRACK_MODULE)
701         unsigned long            _nfct;
702 #endif
703 #if IS_ENABLED(CONFIG_BRIDGE_NETFILTER)
704         struct nf_bridge_info   *nf_bridge;
705 #endif
706         unsigned int            len,
707                                 data_len;
708         __u16                   mac_len,
709                                 hdr_len;
710
711         /* Following fields are _not_ copied in __copy_skb_header()
712          * Note that queue_mapping is here mostly to fill a hole.
713          */
714         __u16                   queue_mapping;
715
716 /* if you move cloned around you also must adapt those constants */
717 #ifdef __BIG_ENDIAN_BITFIELD
718 #define CLONED_MASK     (1 << 7)
719 #else
720 #define CLONED_MASK     1
721 #endif
722 #define CLONED_OFFSET()         offsetof(struct sk_buff, __cloned_offset)
723
724         __u8                    __cloned_offset[0];
725         __u8                    cloned:1,
726                                 nohdr:1,
727                                 fclone:2,
728                                 peeked:1,
729                                 head_frag:1,
730                                 xmit_more:1,
731                                 pfmemalloc:1;
732
733         /* fields enclosed in headers_start/headers_end are copied
734          * using a single memcpy() in __copy_skb_header()
735          */
736         /* private: */
737         __u32                   headers_start[0];
738         /* public: */
739
740 /* if you move pkt_type around you also must adapt those constants */
741 #ifdef __BIG_ENDIAN_BITFIELD
742 #define PKT_TYPE_MAX    (7 << 5)
743 #else
744 #define PKT_TYPE_MAX    7
745 #endif
746 #define PKT_TYPE_OFFSET()       offsetof(struct sk_buff, __pkt_type_offset)
747
748         __u8                    __pkt_type_offset[0];
749         __u8                    pkt_type:3;
750         __u8                    ignore_df:1;
751         __u8                    nf_trace:1;
752         __u8                    ip_summed:2;
753         __u8                    ooo_okay:1;
754
755         __u8                    l4_hash:1;
756         __u8                    sw_hash:1;
757         __u8                    wifi_acked_valid:1;
758         __u8                    wifi_acked:1;
759         __u8                    no_fcs:1;
760         /* Indicates the inner headers are valid in the skbuff. */
761         __u8                    encapsulation:1;
762         __u8                    encap_hdr_csum:1;
763         __u8                    csum_valid:1;
764
765         __u8                    csum_complete_sw:1;
766         __u8                    csum_level:2;
767         __u8                    csum_not_inet:1;
768         __u8                    dst_pending_confirm:1;
769 #ifdef CONFIG_IPV6_NDISC_NODETYPE
770         __u8                    ndisc_nodetype:2;
771 #endif
772         __u8                    ipvs_property:1;
773
774         __u8                    inner_protocol_type:1;
775         __u8                    remcsum_offload:1;
776 #ifdef CONFIG_NET_SWITCHDEV
777         __u8                    offload_fwd_mark:1;
778 #endif
779 #ifdef CONFIG_NET_CLS_ACT
780         __u8                    tc_skip_classify:1;
781         __u8                    tc_at_ingress:1;
782         __u8                    tc_redirected:1;
783         __u8                    tc_from_ingress:1;
784 #endif
785
786 #ifdef CONFIG_NET_SCHED
787         __u16                   tc_index;       /* traffic control index */
788 #endif
789
790         union {
791                 __wsum          csum;
792                 struct {
793                         __u16   csum_start;
794                         __u16   csum_offset;
795                 };
796         };
797         __u32                   priority;
798         int                     skb_iif;
799         __u32                   hash;
800         __be16                  vlan_proto;
801         __u16                   vlan_tci;
802 #if defined(CONFIG_NET_RX_BUSY_POLL) || defined(CONFIG_XPS)
803         union {
804                 unsigned int    napi_id;
805                 unsigned int    sender_cpu;
806         };
807 #endif
808 #ifdef CONFIG_NETWORK_SECMARK
809         __u32           secmark;
810 #endif
811
812         union {
813                 __u32           mark;
814                 __u32           reserved_tailroom;
815         };
816
817         union {
818                 __be16          inner_protocol;
819                 __u8            inner_ipproto;
820         };
821
822         __u16                   inner_transport_header;
823         __u16                   inner_network_header;
824         __u16                   inner_mac_header;
825
826         __be16                  protocol;
827         __u16                   transport_header;
828         __u16                   network_header;
829         __u16                   mac_header;
830
831         /* private: */
832         __u32                   headers_end[0];
833         /* public: */
834
835         /* These elements must be at the end, see alloc_skb() for details.  */
836         sk_buff_data_t          tail;
837         sk_buff_data_t          end;
838         unsigned char           *head,
839                                 *data;
840         unsigned int            truesize;
841         refcount_t              users;
842 };
843
844 #ifdef __KERNEL__
845 /*
846  *      Handling routines are only of interest to the kernel
847  */
848 #include <linux/slab.h>
849
850
851 #define SKB_ALLOC_FCLONE        0x01
852 #define SKB_ALLOC_RX            0x02
853 #define SKB_ALLOC_NAPI          0x04
854
855 /* Returns true if the skb was allocated from PFMEMALLOC reserves */
856 static inline bool skb_pfmemalloc(const struct sk_buff *skb)
857 {
858         return unlikely(skb->pfmemalloc);
859 }
860
861 /*
862  * skb might have a dst pointer attached, refcounted or not.
863  * _skb_refdst low order bit is set if refcount was _not_ taken
864  */
865 #define SKB_DST_NOREF   1UL
866 #define SKB_DST_PTRMASK ~(SKB_DST_NOREF)
867
868 #define SKB_NFCT_PTRMASK        ~(7UL)
869 /**
870  * skb_dst - returns skb dst_entry
871  * @skb: buffer
872  *
873  * Returns skb dst_entry, regardless of reference taken or not.
874  */
875 static inline struct dst_entry *skb_dst(const struct sk_buff *skb)
876 {
877         /* If refdst was not refcounted, check we still are in a 
878          * rcu_read_lock section
879          */
880         WARN_ON((skb->_skb_refdst & SKB_DST_NOREF) &&
881                 !rcu_read_lock_held() &&
882                 !rcu_read_lock_bh_held());
883         return (struct dst_entry *)(skb->_skb_refdst & SKB_DST_PTRMASK);
884 }
885
886 /**
887  * skb_dst_set - sets skb dst
888  * @skb: buffer
889  * @dst: dst entry
890  *
891  * Sets skb dst, assuming a reference was taken on dst and should
892  * be released by skb_dst_drop()
893  */
894 static inline void skb_dst_set(struct sk_buff *skb, struct dst_entry *dst)
895 {
896         skb->_skb_refdst = (unsigned long)dst;
897 }
898
899 /**
900  * skb_dst_set_noref - sets skb dst, hopefully, without taking reference
901  * @skb: buffer
902  * @dst: dst entry
903  *
904  * Sets skb dst, assuming a reference was not taken on dst.
905  * If dst entry is cached, we do not take reference and dst_release
906  * will be avoided by refdst_drop. If dst entry is not cached, we take
907  * reference, so that last dst_release can destroy the dst immediately.
908  */
909 static inline void skb_dst_set_noref(struct sk_buff *skb, struct dst_entry *dst)
910 {
911         WARN_ON(!rcu_read_lock_held() && !rcu_read_lock_bh_held());
912         skb->_skb_refdst = (unsigned long)dst | SKB_DST_NOREF;
913 }
914
915 /**
916  * skb_dst_is_noref - Test if skb dst isn't refcounted
917  * @skb: buffer
918  */
919 static inline bool skb_dst_is_noref(const struct sk_buff *skb)
920 {
921         return (skb->_skb_refdst & SKB_DST_NOREF) && skb_dst(skb);
922 }
923
924 static inline struct rtable *skb_rtable(const struct sk_buff *skb)
925 {
926         return (struct rtable *)skb_dst(skb);
927 }
928
929 /* For mangling skb->pkt_type from user space side from applications
930  * such as nft, tc, etc, we only allow a conservative subset of
931  * possible pkt_types to be set.
932 */
933 static inline bool skb_pkt_type_ok(u32 ptype)
934 {
935         return ptype <= PACKET_OTHERHOST;
936 }
937
938 static inline unsigned int skb_napi_id(const struct sk_buff *skb)
939 {
940 #ifdef CONFIG_NET_RX_BUSY_POLL
941         return skb->napi_id;
942 #else
943         return 0;
944 #endif
945 }
946
947 /* decrement the reference count and return true if we can free the skb */
948 static inline bool skb_unref(struct sk_buff *skb)
949 {
950         if (unlikely(!skb))
951                 return false;
952         if (likely(refcount_read(&skb->users) == 1))
953                 smp_rmb();
954         else if (likely(!refcount_dec_and_test(&skb->users)))
955                 return false;
956
957         return true;
958 }
959
960 void skb_release_head_state(struct sk_buff *skb);
961 void kfree_skb(struct sk_buff *skb);
962 void kfree_skb_list(struct sk_buff *segs);
963 void skb_tx_error(struct sk_buff *skb);
964 void consume_skb(struct sk_buff *skb);
965 void __consume_stateless_skb(struct sk_buff *skb);
966 void  __kfree_skb(struct sk_buff *skb);
967 extern struct kmem_cache *skbuff_head_cache;
968
969 void kfree_skb_partial(struct sk_buff *skb, bool head_stolen);
970 bool skb_try_coalesce(struct sk_buff *to, struct sk_buff *from,
971                       bool *fragstolen, int *delta_truesize);
972
973 struct sk_buff *__alloc_skb(unsigned int size, gfp_t priority, int flags,
974                             int node);
975 struct sk_buff *__build_skb(void *data, unsigned int frag_size);
976 struct sk_buff *build_skb(void *data, unsigned int frag_size);
977 static inline struct sk_buff *alloc_skb(unsigned int size,
978                                         gfp_t priority)
979 {
980         return __alloc_skb(size, priority, 0, NUMA_NO_NODE);
981 }
982
983 struct sk_buff *alloc_skb_with_frags(unsigned long header_len,
984                                      unsigned long data_len,
985                                      int max_page_order,
986                                      int *errcode,
987                                      gfp_t gfp_mask);
988
989 /* Layout of fast clones : [skb1][skb2][fclone_ref] */
990 struct sk_buff_fclones {
991         struct sk_buff  skb1;
992
993         struct sk_buff  skb2;
994
995         refcount_t      fclone_ref;
996 };
997
998 /**
999  *      skb_fclone_busy - check if fclone is busy
1000  *      @sk: socket
1001  *      @skb: buffer
1002  *
1003  * Returns true if skb is a fast clone, and its clone is not freed.
1004  * Some drivers call skb_orphan() in their ndo_start_xmit(),
1005  * so we also check that this didnt happen.
1006  */
1007 static inline bool skb_fclone_busy(const struct sock *sk,
1008                                    const struct sk_buff *skb)
1009 {
1010         const struct sk_buff_fclones *fclones;
1011
1012         fclones = container_of(skb, struct sk_buff_fclones, skb1);
1013
1014         return skb->fclone == SKB_FCLONE_ORIG &&
1015                refcount_read(&fclones->fclone_ref) > 1 &&
1016                fclones->skb2.sk == sk;
1017 }
1018
1019 static inline struct sk_buff *alloc_skb_fclone(unsigned int size,
1020                                                gfp_t priority)
1021 {
1022         return __alloc_skb(size, priority, SKB_ALLOC_FCLONE, NUMA_NO_NODE);
1023 }
1024
1025 struct sk_buff *skb_morph(struct sk_buff *dst, struct sk_buff *src);
1026 int skb_copy_ubufs(struct sk_buff *skb, gfp_t gfp_mask);
1027 struct sk_buff *skb_clone(struct sk_buff *skb, gfp_t priority);
1028 struct sk_buff *skb_copy(const struct sk_buff *skb, gfp_t priority);
1029 struct sk_buff *__pskb_copy_fclone(struct sk_buff *skb, int headroom,
1030                                    gfp_t gfp_mask, bool fclone);
1031 static inline struct sk_buff *__pskb_copy(struct sk_buff *skb, int headroom,
1032                                           gfp_t gfp_mask)
1033 {
1034         return __pskb_copy_fclone(skb, headroom, gfp_mask, false);
1035 }
1036
1037 int pskb_expand_head(struct sk_buff *skb, int nhead, int ntail, gfp_t gfp_mask);
1038 struct sk_buff *skb_realloc_headroom(struct sk_buff *skb,
1039                                      unsigned int headroom);
1040 struct sk_buff *skb_copy_expand(const struct sk_buff *skb, int newheadroom,
1041                                 int newtailroom, gfp_t priority);
1042 int __must_check skb_to_sgvec_nomark(struct sk_buff *skb, struct scatterlist *sg,
1043                                      int offset, int len);
1044 int __must_check skb_to_sgvec(struct sk_buff *skb, struct scatterlist *sg,
1045                               int offset, int len);
1046 int skb_cow_data(struct sk_buff *skb, int tailbits, struct sk_buff **trailer);
1047 int __skb_pad(struct sk_buff *skb, int pad, bool free_on_error);
1048
1049 /**
1050  *      skb_pad                 -       zero pad the tail of an skb
1051  *      @skb: buffer to pad
1052  *      @pad: space to pad
1053  *
1054  *      Ensure that a buffer is followed by a padding area that is zero
1055  *      filled. Used by network drivers which may DMA or transfer data
1056  *      beyond the buffer end onto the wire.
1057  *
1058  *      May return error in out of memory cases. The skb is freed on error.
1059  */
1060 static inline int skb_pad(struct sk_buff *skb, int pad)
1061 {
1062         return __skb_pad(skb, pad, true);
1063 }
1064 #define dev_kfree_skb(a)        consume_skb(a)
1065
1066 int skb_append_datato_frags(struct sock *sk, struct sk_buff *skb,
1067                             int getfrag(void *from, char *to, int offset,
1068                                         int len, int odd, struct sk_buff *skb),
1069                             void *from, int length);
1070
1071 int skb_append_pagefrags(struct sk_buff *skb, struct page *page,
1072                          int offset, size_t size);
1073
1074 struct skb_seq_state {
1075         __u32           lower_offset;
1076         __u32           upper_offset;
1077         __u32           frag_idx;
1078         __u32           stepped_offset;
1079         struct sk_buff  *root_skb;
1080         struct sk_buff  *cur_skb;
1081         __u8            *frag_data;
1082 };
1083
1084 void skb_prepare_seq_read(struct sk_buff *skb, unsigned int from,
1085                           unsigned int to, struct skb_seq_state *st);
1086 unsigned int skb_seq_read(unsigned int consumed, const u8 **data,
1087                           struct skb_seq_state *st);
1088 void skb_abort_seq_read(struct skb_seq_state *st);
1089
1090 unsigned int skb_find_text(struct sk_buff *skb, unsigned int from,
1091                            unsigned int to, struct ts_config *config);
1092
1093 /*
1094  * Packet hash types specify the type of hash in skb_set_hash.
1095  *
1096  * Hash types refer to the protocol layer addresses which are used to
1097  * construct a packet's hash. The hashes are used to differentiate or identify
1098  * flows of the protocol layer for the hash type. Hash types are either
1099  * layer-2 (L2), layer-3 (L3), or layer-4 (L4).
1100  *
1101  * Properties of hashes:
1102  *
1103  * 1) Two packets in different flows have different hash values
1104  * 2) Two packets in the same flow should have the same hash value
1105  *
1106  * A hash at a higher layer is considered to be more specific. A driver should
1107  * set the most specific hash possible.
1108  *
1109  * A driver cannot indicate a more specific hash than the layer at which a hash
1110  * was computed. For instance an L3 hash cannot be set as an L4 hash.
1111  *
1112  * A driver may indicate a hash level which is less specific than the
1113  * actual layer the hash was computed on. For instance, a hash computed
1114  * at L4 may be considered an L3 hash. This should only be done if the
1115  * driver can't unambiguously determine that the HW computed the hash at
1116  * the higher layer. Note that the "should" in the second property above
1117  * permits this.
1118  */
1119 enum pkt_hash_types {
1120         PKT_HASH_TYPE_NONE,     /* Undefined type */
1121         PKT_HASH_TYPE_L2,       /* Input: src_MAC, dest_MAC */
1122         PKT_HASH_TYPE_L3,       /* Input: src_IP, dst_IP */
1123         PKT_HASH_TYPE_L4,       /* Input: src_IP, dst_IP, src_port, dst_port */
1124 };
1125
1126 static inline void skb_clear_hash(struct sk_buff *skb)
1127 {
1128         skb->hash = 0;
1129         skb->sw_hash = 0;
1130         skb->l4_hash = 0;
1131 }
1132
1133 static inline void skb_clear_hash_if_not_l4(struct sk_buff *skb)
1134 {
1135         if (!skb->l4_hash)
1136                 skb_clear_hash(skb);
1137 }
1138
1139 static inline void
1140 __skb_set_hash(struct sk_buff *skb, __u32 hash, bool is_sw, bool is_l4)
1141 {
1142         skb->l4_hash = is_l4;
1143         skb->sw_hash = is_sw;
1144         skb->hash = hash;
1145 }
1146
1147 static inline void
1148 skb_set_hash(struct sk_buff *skb, __u32 hash, enum pkt_hash_types type)
1149 {
1150         /* Used by drivers to set hash from HW */
1151         __skb_set_hash(skb, hash, false, type == PKT_HASH_TYPE_L4);
1152 }
1153
1154 static inline void
1155 __skb_set_sw_hash(struct sk_buff *skb, __u32 hash, bool is_l4)
1156 {
1157         __skb_set_hash(skb, hash, true, is_l4);
1158 }
1159
1160 void __skb_get_hash(struct sk_buff *skb);
1161 u32 __skb_get_hash_symmetric(const struct sk_buff *skb);
1162 u32 skb_get_poff(const struct sk_buff *skb);
1163 u32 __skb_get_poff(const struct sk_buff *skb, void *data,
1164                    const struct flow_keys *keys, int hlen);
1165 __be32 __skb_flow_get_ports(const struct sk_buff *skb, int thoff, u8 ip_proto,
1166                             void *data, int hlen_proto);
1167
1168 static inline __be32 skb_flow_get_ports(const struct sk_buff *skb,
1169                                         int thoff, u8 ip_proto)
1170 {
1171         return __skb_flow_get_ports(skb, thoff, ip_proto, NULL, 0);
1172 }
1173
1174 void skb_flow_dissector_init(struct flow_dissector *flow_dissector,
1175                              const struct flow_dissector_key *key,
1176                              unsigned int key_count);
1177
1178 bool __skb_flow_dissect(const struct sk_buff *skb,
1179                         struct flow_dissector *flow_dissector,
1180                         void *target_container,
1181                         void *data, __be16 proto, int nhoff, int hlen,
1182                         unsigned int flags);
1183
1184 static inline bool skb_flow_dissect(const struct sk_buff *skb,
1185                                     struct flow_dissector *flow_dissector,
1186                                     void *target_container, unsigned int flags)
1187 {
1188         return __skb_flow_dissect(skb, flow_dissector, target_container,
1189                                   NULL, 0, 0, 0, flags);
1190 }
1191
1192 static inline bool skb_flow_dissect_flow_keys(const struct sk_buff *skb,
1193                                               struct flow_keys *flow,
1194                                               unsigned int flags)
1195 {
1196         memset(flow, 0, sizeof(*flow));
1197         return __skb_flow_dissect(skb, &flow_keys_dissector, flow,
1198                                   NULL, 0, 0, 0, flags);
1199 }
1200
1201 static inline bool skb_flow_dissect_flow_keys_buf(struct flow_keys *flow,
1202                                                   void *data, __be16 proto,
1203                                                   int nhoff, int hlen,
1204                                                   unsigned int flags)
1205 {
1206         memset(flow, 0, sizeof(*flow));
1207         return __skb_flow_dissect(NULL, &flow_keys_buf_dissector, flow,
1208                                   data, proto, nhoff, hlen, flags);
1209 }
1210
1211 static inline __u32 skb_get_hash(struct sk_buff *skb)
1212 {
1213         if (!skb->l4_hash && !skb->sw_hash)
1214                 __skb_get_hash(skb);
1215
1216         return skb->hash;
1217 }
1218
1219 static inline __u32 skb_get_hash_flowi6(struct sk_buff *skb, const struct flowi6 *fl6)
1220 {
1221         if (!skb->l4_hash && !skb->sw_hash) {
1222                 struct flow_keys keys;
1223                 __u32 hash = __get_hash_from_flowi6(fl6, &keys);
1224
1225                 __skb_set_sw_hash(skb, hash, flow_keys_have_l4(&keys));
1226         }
1227
1228         return skb->hash;
1229 }
1230
1231 __u32 skb_get_hash_perturb(const struct sk_buff *skb,
1232                            const siphash_key_t *perturb);
1233
1234 static inline __u32 skb_get_hash_raw(const struct sk_buff *skb)
1235 {
1236         return skb->hash;
1237 }
1238
1239 static inline void skb_copy_hash(struct sk_buff *to, const struct sk_buff *from)
1240 {
1241         to->hash = from->hash;
1242         to->sw_hash = from->sw_hash;
1243         to->l4_hash = from->l4_hash;
1244 };
1245
1246 #ifdef NET_SKBUFF_DATA_USES_OFFSET
1247 static inline unsigned char *skb_end_pointer(const struct sk_buff *skb)
1248 {
1249         return skb->head + skb->end;
1250 }
1251
1252 static inline unsigned int skb_end_offset(const struct sk_buff *skb)
1253 {
1254         return skb->end;
1255 }
1256 #else
1257 static inline unsigned char *skb_end_pointer(const struct sk_buff *skb)
1258 {
1259         return skb->end;
1260 }
1261
1262 static inline unsigned int skb_end_offset(const struct sk_buff *skb)
1263 {
1264         return skb->end - skb->head;
1265 }
1266 #endif
1267
1268 /* Internal */
1269 #define skb_shinfo(SKB) ((struct skb_shared_info *)(skb_end_pointer(SKB)))
1270
1271 static inline struct skb_shared_hwtstamps *skb_hwtstamps(struct sk_buff *skb)
1272 {
1273         return &skb_shinfo(skb)->hwtstamps;
1274 }
1275
1276 static inline struct ubuf_info *skb_zcopy(struct sk_buff *skb)
1277 {
1278         bool is_zcopy = skb && skb_shinfo(skb)->tx_flags & SKBTX_DEV_ZEROCOPY;
1279
1280         return is_zcopy ? skb_uarg(skb) : NULL;
1281 }
1282
1283 static inline void skb_zcopy_set(struct sk_buff *skb, struct ubuf_info *uarg)
1284 {
1285         if (skb && uarg && !skb_zcopy(skb)) {
1286                 sock_zerocopy_get(uarg);
1287                 skb_shinfo(skb)->destructor_arg = uarg;
1288                 skb_shinfo(skb)->tx_flags |= SKBTX_ZEROCOPY_FRAG;
1289         }
1290 }
1291
1292 static inline void skb_zcopy_set_nouarg(struct sk_buff *skb, void *val)
1293 {
1294         skb_shinfo(skb)->destructor_arg = (void *)((uintptr_t) val | 0x1UL);
1295         skb_shinfo(skb)->tx_flags |= SKBTX_ZEROCOPY_FRAG;
1296 }
1297
1298 static inline bool skb_zcopy_is_nouarg(struct sk_buff *skb)
1299 {
1300         return (uintptr_t) skb_shinfo(skb)->destructor_arg & 0x1UL;
1301 }
1302
1303 static inline void *skb_zcopy_get_nouarg(struct sk_buff *skb)
1304 {
1305         return (void *)((uintptr_t) skb_shinfo(skb)->destructor_arg & ~0x1UL);
1306 }
1307
1308 /* Release a reference on a zerocopy structure */
1309 static inline void skb_zcopy_clear(struct sk_buff *skb, bool zerocopy)
1310 {
1311         struct ubuf_info *uarg = skb_zcopy(skb);
1312
1313         if (uarg) {
1314                 if (skb_zcopy_is_nouarg(skb)) {
1315                         /* no notification callback */
1316                 } else if (uarg->callback == sock_zerocopy_callback) {
1317                         uarg->zerocopy = uarg->zerocopy && zerocopy;
1318                         sock_zerocopy_put(uarg);
1319                 } else {
1320                         uarg->callback(uarg, zerocopy);
1321                 }
1322
1323                 skb_shinfo(skb)->tx_flags &= ~SKBTX_ZEROCOPY_FRAG;
1324         }
1325 }
1326
1327 /* Abort a zerocopy operation and revert zckey on error in send syscall */
1328 static inline void skb_zcopy_abort(struct sk_buff *skb)
1329 {
1330         struct ubuf_info *uarg = skb_zcopy(skb);
1331
1332         if (uarg) {
1333                 sock_zerocopy_put_abort(uarg);
1334                 skb_shinfo(skb)->tx_flags &= ~SKBTX_ZEROCOPY_FRAG;
1335         }
1336 }
1337
1338 static inline void skb_mark_not_on_list(struct sk_buff *skb)
1339 {
1340         skb->next = NULL;
1341 }
1342
1343 /* Iterate through singly-linked GSO fragments of an skb. */
1344 #define skb_list_walk_safe(first, skb, next_skb)                               \
1345         for ((skb) = (first), (next_skb) = (skb) ? (skb)->next : NULL; (skb);  \
1346              (skb) = (next_skb), (next_skb) = (skb) ? (skb)->next : NULL)
1347
1348 static inline void skb_list_del_init(struct sk_buff *skb)
1349 {
1350         __list_del_entry(&skb->list);
1351         skb_mark_not_on_list(skb);
1352 }
1353
1354 /**
1355  *      skb_queue_empty - check if a queue is empty
1356  *      @list: queue head
1357  *
1358  *      Returns true if the queue is empty, false otherwise.
1359  */
1360 static inline int skb_queue_empty(const struct sk_buff_head *list)
1361 {
1362         return list->next == (const struct sk_buff *) list;
1363 }
1364
1365 /**
1366  *      skb_queue_empty_lockless - check if a queue is empty
1367  *      @list: queue head
1368  *
1369  *      Returns true if the queue is empty, false otherwise.
1370  *      This variant can be used in lockless contexts.
1371  */
1372 static inline bool skb_queue_empty_lockless(const struct sk_buff_head *list)
1373 {
1374         return READ_ONCE(list->next) == (const struct sk_buff *) list;
1375 }
1376
1377
1378 /**
1379  *      skb_queue_is_last - check if skb is the last entry in the queue
1380  *      @list: queue head
1381  *      @skb: buffer
1382  *
1383  *      Returns true if @skb is the last buffer on the list.
1384  */
1385 static inline bool skb_queue_is_last(const struct sk_buff_head *list,
1386                                      const struct sk_buff *skb)
1387 {
1388         return skb->next == (const struct sk_buff *) list;
1389 }
1390
1391 /**
1392  *      skb_queue_is_first - check if skb is the first entry in the queue
1393  *      @list: queue head
1394  *      @skb: buffer
1395  *
1396  *      Returns true if @skb is the first buffer on the list.
1397  */
1398 static inline bool skb_queue_is_first(const struct sk_buff_head *list,
1399                                       const struct sk_buff *skb)
1400 {
1401         return skb->prev == (const struct sk_buff *) list;
1402 }
1403
1404 /**
1405  *      skb_queue_next - return the next packet in the queue
1406  *      @list: queue head
1407  *      @skb: current buffer
1408  *
1409  *      Return the next packet in @list after @skb.  It is only valid to
1410  *      call this if skb_queue_is_last() evaluates to false.
1411  */
1412 static inline struct sk_buff *skb_queue_next(const struct sk_buff_head *list,
1413                                              const struct sk_buff *skb)
1414 {
1415         /* This BUG_ON may seem severe, but if we just return then we
1416          * are going to dereference garbage.
1417          */
1418         BUG_ON(skb_queue_is_last(list, skb));
1419         return skb->next;
1420 }
1421
1422 /**
1423  *      skb_queue_prev - return the prev packet in the queue
1424  *      @list: queue head
1425  *      @skb: current buffer
1426  *
1427  *      Return the prev packet in @list before @skb.  It is only valid to
1428  *      call this if skb_queue_is_first() evaluates to false.
1429  */
1430 static inline struct sk_buff *skb_queue_prev(const struct sk_buff_head *list,
1431                                              const struct sk_buff *skb)
1432 {
1433         /* This BUG_ON may seem severe, but if we just return then we
1434          * are going to dereference garbage.
1435          */
1436         BUG_ON(skb_queue_is_first(list, skb));
1437         return skb->prev;
1438 }
1439
1440 /**
1441  *      skb_get - reference buffer
1442  *      @skb: buffer to reference
1443  *
1444  *      Makes another reference to a socket buffer and returns a pointer
1445  *      to the buffer.
1446  */
1447 static inline struct sk_buff *skb_get(struct sk_buff *skb)
1448 {
1449         refcount_inc(&skb->users);
1450         return skb;
1451 }
1452
1453 /*
1454  * If users == 1, we are the only owner and are can avoid redundant
1455  * atomic change.
1456  */
1457
1458 /**
1459  *      skb_cloned - is the buffer a clone
1460  *      @skb: buffer to check
1461  *
1462  *      Returns true if the buffer was generated with skb_clone() and is
1463  *      one of multiple shared copies of the buffer. Cloned buffers are
1464  *      shared data so must not be written to under normal circumstances.
1465  */
1466 static inline int skb_cloned(const struct sk_buff *skb)
1467 {
1468         return skb->cloned &&
1469                (atomic_read(&skb_shinfo(skb)->dataref) & SKB_DATAREF_MASK) != 1;
1470 }
1471
1472 static inline int skb_unclone(struct sk_buff *skb, gfp_t pri)
1473 {
1474         might_sleep_if(gfpflags_allow_blocking(pri));
1475
1476         if (skb_cloned(skb))
1477                 return pskb_expand_head(skb, 0, 0, pri);
1478
1479         return 0;
1480 }
1481
1482 /**
1483  *      skb_header_cloned - is the header a clone
1484  *      @skb: buffer to check
1485  *
1486  *      Returns true if modifying the header part of the buffer requires
1487  *      the data to be copied.
1488  */
1489 static inline int skb_header_cloned(const struct sk_buff *skb)
1490 {
1491         int dataref;
1492
1493         if (!skb->cloned)
1494                 return 0;
1495
1496         dataref = atomic_read(&skb_shinfo(skb)->dataref);
1497         dataref = (dataref & SKB_DATAREF_MASK) - (dataref >> SKB_DATAREF_SHIFT);
1498         return dataref != 1;
1499 }
1500
1501 static inline int skb_header_unclone(struct sk_buff *skb, gfp_t pri)
1502 {
1503         might_sleep_if(gfpflags_allow_blocking(pri));
1504
1505         if (skb_header_cloned(skb))
1506                 return pskb_expand_head(skb, 0, 0, pri);
1507
1508         return 0;
1509 }
1510
1511 /**
1512  *      skb_header_release - release reference to header
1513  *      @skb: buffer to operate on
1514  *
1515  *      Drop a reference to the header part of the buffer.  This is done
1516  *      by acquiring a payload reference.  You must not read from the header
1517  *      part of skb->data after this.
1518  *      Note : Check if you can use __skb_header_release() instead.
1519  */
1520 static inline void skb_header_release(struct sk_buff *skb)
1521 {
1522         BUG_ON(skb->nohdr);
1523         skb->nohdr = 1;
1524         atomic_add(1 << SKB_DATAREF_SHIFT, &skb_shinfo(skb)->dataref);
1525 }
1526
1527 /**
1528  *      __skb_header_release - release reference to header
1529  *      @skb: buffer to operate on
1530  *
1531  *      Variant of skb_header_release() assuming skb is private to caller.
1532  *      We can avoid one atomic operation.
1533  */
1534 static inline void __skb_header_release(struct sk_buff *skb)
1535 {
1536         skb->nohdr = 1;
1537         atomic_set(&skb_shinfo(skb)->dataref, 1 + (1 << SKB_DATAREF_SHIFT));
1538 }
1539
1540
1541 /**
1542  *      skb_shared - is the buffer shared
1543  *      @skb: buffer to check
1544  *
1545  *      Returns true if more than one person has a reference to this
1546  *      buffer.
1547  */
1548 static inline int skb_shared(const struct sk_buff *skb)
1549 {
1550         return refcount_read(&skb->users) != 1;
1551 }
1552
1553 /**
1554  *      skb_share_check - check if buffer is shared and if so clone it
1555  *      @skb: buffer to check
1556  *      @pri: priority for memory allocation
1557  *
1558  *      If the buffer is shared the buffer is cloned and the old copy
1559  *      drops a reference. A new clone with a single reference is returned.
1560  *      If the buffer is not shared the original buffer is returned. When
1561  *      being called from interrupt status or with spinlocks held pri must
1562  *      be GFP_ATOMIC.
1563  *
1564  *      NULL is returned on a memory allocation failure.
1565  */
1566 static inline struct sk_buff *skb_share_check(struct sk_buff *skb, gfp_t pri)
1567 {
1568         might_sleep_if(gfpflags_allow_blocking(pri));
1569         if (skb_shared(skb)) {
1570                 struct sk_buff *nskb = skb_clone(skb, pri);
1571
1572                 if (likely(nskb))
1573                         consume_skb(skb);
1574                 else
1575                         kfree_skb(skb);
1576                 skb = nskb;
1577         }
1578         return skb;
1579 }
1580
1581 /*
1582  *      Copy shared buffers into a new sk_buff. We effectively do COW on
1583  *      packets to handle cases where we have a local reader and forward
1584  *      and a couple of other messy ones. The normal one is tcpdumping
1585  *      a packet thats being forwarded.
1586  */
1587
1588 /**
1589  *      skb_unshare - make a copy of a shared buffer
1590  *      @skb: buffer to check
1591  *      @pri: priority for memory allocation
1592  *
1593  *      If the socket buffer is a clone then this function creates a new
1594  *      copy of the data, drops a reference count on the old copy and returns
1595  *      the new copy with the reference count at 1. If the buffer is not a clone
1596  *      the original buffer is returned. When called with a spinlock held or
1597  *      from interrupt state @pri must be %GFP_ATOMIC
1598  *
1599  *      %NULL is returned on a memory allocation failure.
1600  */
1601 static inline struct sk_buff *skb_unshare(struct sk_buff *skb,
1602                                           gfp_t pri)
1603 {
1604         might_sleep_if(gfpflags_allow_blocking(pri));
1605         if (skb_cloned(skb)) {
1606                 struct sk_buff *nskb = skb_copy(skb, pri);
1607
1608                 /* Free our shared copy */
1609                 if (likely(nskb))
1610                         consume_skb(skb);
1611                 else
1612                         kfree_skb(skb);
1613                 skb = nskb;
1614         }
1615         return skb;
1616 }
1617
1618 /**
1619  *      skb_peek - peek at the head of an &sk_buff_head
1620  *      @list_: list to peek at
1621  *
1622  *      Peek an &sk_buff. Unlike most other operations you _MUST_
1623  *      be careful with this one. A peek leaves the buffer on the
1624  *      list and someone else may run off with it. You must hold
1625  *      the appropriate locks or have a private queue to do this.
1626  *
1627  *      Returns %NULL for an empty list or a pointer to the head element.
1628  *      The reference count is not incremented and the reference is therefore
1629  *      volatile. Use with caution.
1630  */
1631 static inline struct sk_buff *skb_peek(const struct sk_buff_head *list_)
1632 {
1633         struct sk_buff *skb = list_->next;
1634
1635         if (skb == (struct sk_buff *)list_)
1636                 skb = NULL;
1637         return skb;
1638 }
1639
1640 /**
1641  *      skb_peek_next - peek skb following the given one from a queue
1642  *      @skb: skb to start from
1643  *      @list_: list to peek at
1644  *
1645  *      Returns %NULL when the end of the list is met or a pointer to the
1646  *      next element. The reference count is not incremented and the
1647  *      reference is therefore volatile. Use with caution.
1648  */
1649 static inline struct sk_buff *skb_peek_next(struct sk_buff *skb,
1650                 const struct sk_buff_head *list_)
1651 {
1652         struct sk_buff *next = skb->next;
1653
1654         if (next == (struct sk_buff *)list_)
1655                 next = NULL;
1656         return next;
1657 }
1658
1659 /**
1660  *      skb_peek_tail - peek at the tail of an &sk_buff_head
1661  *      @list_: list to peek at
1662  *
1663  *      Peek an &sk_buff. Unlike most other operations you _MUST_
1664  *      be careful with this one. A peek leaves the buffer on the
1665  *      list and someone else may run off with it. You must hold
1666  *      the appropriate locks or have a private queue to do this.
1667  *
1668  *      Returns %NULL for an empty list or a pointer to the tail element.
1669  *      The reference count is not incremented and the reference is therefore
1670  *      volatile. Use with caution.
1671  */
1672 static inline struct sk_buff *skb_peek_tail(const struct sk_buff_head *list_)
1673 {
1674         struct sk_buff *skb = READ_ONCE(list_->prev);
1675
1676         if (skb == (struct sk_buff *)list_)
1677                 skb = NULL;
1678         return skb;
1679
1680 }
1681
1682 /**
1683  *      skb_queue_len   - get queue length
1684  *      @list_: list to measure
1685  *
1686  *      Return the length of an &sk_buff queue.
1687  */
1688 static inline __u32 skb_queue_len(const struct sk_buff_head *list_)
1689 {
1690         return list_->qlen;
1691 }
1692
1693 /**
1694  *      skb_queue_len_lockless  - get queue length
1695  *      @list_: list to measure
1696  *
1697  *      Return the length of an &sk_buff queue.
1698  *      This variant can be used in lockless contexts.
1699  */
1700 static inline __u32 skb_queue_len_lockless(const struct sk_buff_head *list_)
1701 {
1702         return READ_ONCE(list_->qlen);
1703 }
1704
1705 /**
1706  *      __skb_queue_head_init - initialize non-spinlock portions of sk_buff_head
1707  *      @list: queue to initialize
1708  *
1709  *      This initializes only the list and queue length aspects of
1710  *      an sk_buff_head object.  This allows to initialize the list
1711  *      aspects of an sk_buff_head without reinitializing things like
1712  *      the spinlock.  It can also be used for on-stack sk_buff_head
1713  *      objects where the spinlock is known to not be used.
1714  */
1715 static inline void __skb_queue_head_init(struct sk_buff_head *list)
1716 {
1717         list->prev = list->next = (struct sk_buff *)list;
1718         list->qlen = 0;
1719 }
1720
1721 /*
1722  * This function creates a split out lock class for each invocation;
1723  * this is needed for now since a whole lot of users of the skb-queue
1724  * infrastructure in drivers have different locking usage (in hardirq)
1725  * than the networking core (in softirq only). In the long run either the
1726  * network layer or drivers should need annotation to consolidate the
1727  * main types of usage into 3 classes.
1728  */
1729 static inline void skb_queue_head_init(struct sk_buff_head *list)
1730 {
1731         spin_lock_init(&list->lock);
1732         __skb_queue_head_init(list);
1733 }
1734
1735 static inline void skb_queue_head_init_class(struct sk_buff_head *list,
1736                 struct lock_class_key *class)
1737 {
1738         skb_queue_head_init(list);
1739         lockdep_set_class(&list->lock, class);
1740 }
1741
1742 /*
1743  *      Insert an sk_buff on a list.
1744  *
1745  *      The "__skb_xxxx()" functions are the non-atomic ones that
1746  *      can only be called with interrupts disabled.
1747  */
1748 void skb_insert(struct sk_buff *old, struct sk_buff *newsk,
1749                 struct sk_buff_head *list);
1750 static inline void __skb_insert(struct sk_buff *newsk,
1751                                 struct sk_buff *prev, struct sk_buff *next,
1752                                 struct sk_buff_head *list)
1753 {
1754         /* See skb_queue_empty_lockless() and skb_peek_tail()
1755          * for the opposite READ_ONCE()
1756          */
1757         WRITE_ONCE(newsk->next, next);
1758         WRITE_ONCE(newsk->prev, prev);
1759         WRITE_ONCE(next->prev, newsk);
1760         WRITE_ONCE(prev->next, newsk);
1761         WRITE_ONCE(list->qlen, list->qlen + 1);
1762 }
1763
1764 static inline void __skb_queue_splice(const struct sk_buff_head *list,
1765                                       struct sk_buff *prev,
1766                                       struct sk_buff *next)
1767 {
1768         struct sk_buff *first = list->next;
1769         struct sk_buff *last = list->prev;
1770
1771         WRITE_ONCE(first->prev, prev);
1772         WRITE_ONCE(prev->next, first);
1773
1774         WRITE_ONCE(last->next, next);
1775         WRITE_ONCE(next->prev, last);
1776 }
1777
1778 /**
1779  *      skb_queue_splice - join two skb lists, this is designed for stacks
1780  *      @list: the new list to add
1781  *      @head: the place to add it in the first list
1782  */
1783 static inline void skb_queue_splice(const struct sk_buff_head *list,
1784                                     struct sk_buff_head *head)
1785 {
1786         if (!skb_queue_empty(list)) {
1787                 __skb_queue_splice(list, (struct sk_buff *) head, head->next);
1788                 head->qlen += list->qlen;
1789         }
1790 }
1791
1792 /**
1793  *      skb_queue_splice_init - join two skb lists and reinitialise the emptied list
1794  *      @list: the new list to add
1795  *      @head: the place to add it in the first list
1796  *
1797  *      The list at @list is reinitialised
1798  */
1799 static inline void skb_queue_splice_init(struct sk_buff_head *list,
1800                                          struct sk_buff_head *head)
1801 {
1802         if (!skb_queue_empty(list)) {
1803                 __skb_queue_splice(list, (struct sk_buff *) head, head->next);
1804                 head->qlen += list->qlen;
1805                 __skb_queue_head_init(list);
1806         }
1807 }
1808
1809 /**
1810  *      skb_queue_splice_tail - join two skb lists, each list being a queue
1811  *      @list: the new list to add
1812  *      @head: the place to add it in the first list
1813  */
1814 static inline void skb_queue_splice_tail(const struct sk_buff_head *list,
1815                                          struct sk_buff_head *head)
1816 {
1817         if (!skb_queue_empty(list)) {
1818                 __skb_queue_splice(list, head->prev, (struct sk_buff *) head);
1819                 head->qlen += list->qlen;
1820         }
1821 }
1822
1823 /**
1824  *      skb_queue_splice_tail_init - join two skb lists and reinitialise the emptied list
1825  *      @list: the new list to add
1826  *      @head: the place to add it in the first list
1827  *
1828  *      Each of the lists is a queue.
1829  *      The list at @list is reinitialised
1830  */
1831 static inline void skb_queue_splice_tail_init(struct sk_buff_head *list,
1832                                               struct sk_buff_head *head)
1833 {
1834         if (!skb_queue_empty(list)) {
1835                 __skb_queue_splice(list, head->prev, (struct sk_buff *) head);
1836                 head->qlen += list->qlen;
1837                 __skb_queue_head_init(list);
1838         }
1839 }
1840
1841 /**
1842  *      __skb_queue_after - queue a buffer at the list head
1843  *      @list: list to use
1844  *      @prev: place after this buffer
1845  *      @newsk: buffer to queue
1846  *
1847  *      Queue a buffer int the middle of a list. This function takes no locks
1848  *      and you must therefore hold required locks before calling it.
1849  *
1850  *      A buffer cannot be placed on two lists at the same time.
1851  */
1852 static inline void __skb_queue_after(struct sk_buff_head *list,
1853                                      struct sk_buff *prev,
1854                                      struct sk_buff *newsk)
1855 {
1856         __skb_insert(newsk, prev, prev->next, list);
1857 }
1858
1859 void skb_append(struct sk_buff *old, struct sk_buff *newsk,
1860                 struct sk_buff_head *list);
1861
1862 static inline void __skb_queue_before(struct sk_buff_head *list,
1863                                       struct sk_buff *next,
1864                                       struct sk_buff *newsk)
1865 {
1866         __skb_insert(newsk, next->prev, next, list);
1867 }
1868
1869 /**
1870  *      __skb_queue_head - queue a buffer at the list head
1871  *      @list: list to use
1872  *      @newsk: buffer to queue
1873  *
1874  *      Queue a buffer at the start of a list. This function takes no locks
1875  *      and you must therefore hold required locks before calling it.
1876  *
1877  *      A buffer cannot be placed on two lists at the same time.
1878  */
1879 void skb_queue_head(struct sk_buff_head *list, struct sk_buff *newsk);
1880 static inline void __skb_queue_head(struct sk_buff_head *list,
1881                                     struct sk_buff *newsk)
1882 {
1883         __skb_queue_after(list, (struct sk_buff *)list, newsk);
1884 }
1885
1886 /**
1887  *      __skb_queue_tail - queue a buffer at the list tail
1888  *      @list: list to use
1889  *      @newsk: buffer to queue
1890  *
1891  *      Queue a buffer at the end of a list. This function takes no locks
1892  *      and you must therefore hold required locks before calling it.
1893  *
1894  *      A buffer cannot be placed on two lists at the same time.
1895  */
1896 void skb_queue_tail(struct sk_buff_head *list, struct sk_buff *newsk);
1897 static inline void __skb_queue_tail(struct sk_buff_head *list,
1898                                    struct sk_buff *newsk)
1899 {
1900         __skb_queue_before(list, (struct sk_buff *)list, newsk);
1901 }
1902
1903 /*
1904  * remove sk_buff from list. _Must_ be called atomically, and with
1905  * the list known..
1906  */
1907 void skb_unlink(struct sk_buff *skb, struct sk_buff_head *list);
1908 static inline void __skb_unlink(struct sk_buff *skb, struct sk_buff_head *list)
1909 {
1910         struct sk_buff *next, *prev;
1911
1912         WRITE_ONCE(list->qlen, list->qlen - 1);
1913         next       = skb->next;
1914         prev       = skb->prev;
1915         skb->next  = skb->prev = NULL;
1916         WRITE_ONCE(next->prev, prev);
1917         WRITE_ONCE(prev->next, next);
1918 }
1919
1920 /**
1921  *      __skb_dequeue - remove from the head of the queue
1922  *      @list: list to dequeue from
1923  *
1924  *      Remove the head of the list. This function does not take any locks
1925  *      so must be used with appropriate locks held only. The head item is
1926  *      returned or %NULL if the list is empty.
1927  */
1928 struct sk_buff *skb_dequeue(struct sk_buff_head *list);
1929 static inline struct sk_buff *__skb_dequeue(struct sk_buff_head *list)
1930 {
1931         struct sk_buff *skb = skb_peek(list);
1932         if (skb)
1933                 __skb_unlink(skb, list);
1934         return skb;
1935 }
1936
1937 /**
1938  *      __skb_dequeue_tail - remove from the tail of the queue
1939  *      @list: list to dequeue from
1940  *
1941  *      Remove the tail of the list. This function does not take any locks
1942  *      so must be used with appropriate locks held only. The tail item is
1943  *      returned or %NULL if the list is empty.
1944  */
1945 struct sk_buff *skb_dequeue_tail(struct sk_buff_head *list);
1946 static inline struct sk_buff *__skb_dequeue_tail(struct sk_buff_head *list)
1947 {
1948         struct sk_buff *skb = skb_peek_tail(list);
1949         if (skb)
1950                 __skb_unlink(skb, list);
1951         return skb;
1952 }
1953
1954
1955 static inline bool skb_is_nonlinear(const struct sk_buff *skb)
1956 {
1957         return skb->data_len;
1958 }
1959
1960 static inline unsigned int skb_headlen(const struct sk_buff *skb)
1961 {
1962         return skb->len - skb->data_len;
1963 }
1964
1965 static inline unsigned int __skb_pagelen(const struct sk_buff *skb)
1966 {
1967         unsigned int i, len = 0;
1968
1969         for (i = skb_shinfo(skb)->nr_frags - 1; (int)i >= 0; i--)
1970                 len += skb_frag_size(&skb_shinfo(skb)->frags[i]);
1971         return len;
1972 }
1973
1974 static inline unsigned int skb_pagelen(const struct sk_buff *skb)
1975 {
1976         return skb_headlen(skb) + __skb_pagelen(skb);
1977 }
1978
1979 /**
1980  * __skb_fill_page_desc - initialise a paged fragment in an skb
1981  * @skb: buffer containing fragment to be initialised
1982  * @i: paged fragment index to initialise
1983  * @page: the page to use for this fragment
1984  * @off: the offset to the data with @page
1985  * @size: the length of the data
1986  *
1987  * Initialises the @i'th fragment of @skb to point to &size bytes at
1988  * offset @off within @page.
1989  *
1990  * Does not take any additional reference on the fragment.
1991  */
1992 static inline void __skb_fill_page_desc(struct sk_buff *skb, int i,
1993                                         struct page *page, int off, int size)
1994 {
1995         skb_frag_t *frag = &skb_shinfo(skb)->frags[i];
1996
1997         /*
1998          * Propagate page pfmemalloc to the skb if we can. The problem is
1999          * that not all callers have unique ownership of the page but rely
2000          * on page_is_pfmemalloc doing the right thing(tm).
2001          */
2002         frag->page.p              = page;
2003         frag->page_offset         = off;
2004         skb_frag_size_set(frag, size);
2005
2006         page = compound_head(page);
2007         if (page_is_pfmemalloc(page))
2008                 skb->pfmemalloc = true;
2009 }
2010
2011 /**
2012  * skb_fill_page_desc - initialise a paged fragment in an skb
2013  * @skb: buffer containing fragment to be initialised
2014  * @i: paged fragment index to initialise
2015  * @page: the page to use for this fragment
2016  * @off: the offset to the data with @page
2017  * @size: the length of the data
2018  *
2019  * As per __skb_fill_page_desc() -- initialises the @i'th fragment of
2020  * @skb to point to @size bytes at offset @off within @page. In
2021  * addition updates @skb such that @i is the last fragment.
2022  *
2023  * Does not take any additional reference on the fragment.
2024  */
2025 static inline void skb_fill_page_desc(struct sk_buff *skb, int i,
2026                                       struct page *page, int off, int size)
2027 {
2028         __skb_fill_page_desc(skb, i, page, off, size);
2029         skb_shinfo(skb)->nr_frags = i + 1;
2030 }
2031
2032 void skb_add_rx_frag(struct sk_buff *skb, int i, struct page *page, int off,
2033                      int size, unsigned int truesize);
2034
2035 void skb_coalesce_rx_frag(struct sk_buff *skb, int i, int size,
2036                           unsigned int truesize);
2037
2038 #define SKB_PAGE_ASSERT(skb)    BUG_ON(skb_shinfo(skb)->nr_frags)
2039 #define SKB_FRAG_ASSERT(skb)    BUG_ON(skb_has_frag_list(skb))
2040 #define SKB_LINEAR_ASSERT(skb)  BUG_ON(skb_is_nonlinear(skb))
2041
2042 #ifdef NET_SKBUFF_DATA_USES_OFFSET
2043 static inline unsigned char *skb_tail_pointer(const struct sk_buff *skb)
2044 {
2045         return skb->head + skb->tail;
2046 }
2047
2048 static inline void skb_reset_tail_pointer(struct sk_buff *skb)
2049 {
2050         skb->tail = skb->data - skb->head;
2051 }
2052
2053 static inline void skb_set_tail_pointer(struct sk_buff *skb, const int offset)
2054 {
2055         skb_reset_tail_pointer(skb);
2056         skb->tail += offset;
2057 }
2058
2059 #else /* NET_SKBUFF_DATA_USES_OFFSET */
2060 static inline unsigned char *skb_tail_pointer(const struct sk_buff *skb)
2061 {
2062         return skb->tail;
2063 }
2064
2065 static inline void skb_reset_tail_pointer(struct sk_buff *skb)
2066 {
2067         skb->tail = skb->data;
2068 }
2069
2070 static inline void skb_set_tail_pointer(struct sk_buff *skb, const int offset)
2071 {
2072         skb->tail = skb->data + offset;
2073 }
2074
2075 #endif /* NET_SKBUFF_DATA_USES_OFFSET */
2076
2077 /*
2078  *      Add data to an sk_buff
2079  */
2080 void *pskb_put(struct sk_buff *skb, struct sk_buff *tail, int len);
2081 void *skb_put(struct sk_buff *skb, unsigned int len);
2082 static inline void *__skb_put(struct sk_buff *skb, unsigned int len)
2083 {
2084         void *tmp = skb_tail_pointer(skb);
2085         SKB_LINEAR_ASSERT(skb);
2086         skb->tail += len;
2087         skb->len  += len;
2088         return tmp;
2089 }
2090
2091 static inline void *__skb_put_zero(struct sk_buff *skb, unsigned int len)
2092 {
2093         void *tmp = __skb_put(skb, len);
2094
2095         memset(tmp, 0, len);
2096         return tmp;
2097 }
2098
2099 static inline void *__skb_put_data(struct sk_buff *skb, const void *data,
2100                                    unsigned int len)
2101 {
2102         void *tmp = __skb_put(skb, len);
2103
2104         memcpy(tmp, data, len);
2105         return tmp;
2106 }
2107
2108 static inline void __skb_put_u8(struct sk_buff *skb, u8 val)
2109 {
2110         *(u8 *)__skb_put(skb, 1) = val;
2111 }
2112
2113 static inline void *skb_put_zero(struct sk_buff *skb, unsigned int len)
2114 {
2115         void *tmp = skb_put(skb, len);
2116
2117         memset(tmp, 0, len);
2118
2119         return tmp;
2120 }
2121
2122 static inline void *skb_put_data(struct sk_buff *skb, const void *data,
2123                                  unsigned int len)
2124 {
2125         void *tmp = skb_put(skb, len);
2126
2127         memcpy(tmp, data, len);
2128
2129         return tmp;
2130 }
2131
2132 static inline void skb_put_u8(struct sk_buff *skb, u8 val)
2133 {
2134         *(u8 *)skb_put(skb, 1) = val;
2135 }
2136
2137 void *skb_push(struct sk_buff *skb, unsigned int len);
2138 static inline void *__skb_push(struct sk_buff *skb, unsigned int len)
2139 {
2140         skb->data -= len;
2141         skb->len  += len;
2142         return skb->data;
2143 }
2144
2145 void *skb_pull(struct sk_buff *skb, unsigned int len);
2146 static inline void *__skb_pull(struct sk_buff *skb, unsigned int len)
2147 {
2148         skb->len -= len;
2149         BUG_ON(skb->len < skb->data_len);
2150         return skb->data += len;
2151 }
2152
2153 static inline void *skb_pull_inline(struct sk_buff *skb, unsigned int len)
2154 {
2155         return unlikely(len > skb->len) ? NULL : __skb_pull(skb, len);
2156 }
2157
2158 void *__pskb_pull_tail(struct sk_buff *skb, int delta);
2159
2160 static inline void *__pskb_pull(struct sk_buff *skb, unsigned int len)
2161 {
2162         if (len > skb_headlen(skb) &&
2163             !__pskb_pull_tail(skb, len - skb_headlen(skb)))
2164                 return NULL;
2165         skb->len -= len;
2166         return skb->data += len;
2167 }
2168
2169 static inline void *pskb_pull(struct sk_buff *skb, unsigned int len)
2170 {
2171         return unlikely(len > skb->len) ? NULL : __pskb_pull(skb, len);
2172 }
2173
2174 static inline int pskb_may_pull(struct sk_buff *skb, unsigned int len)
2175 {
2176         if (likely(len <= skb_headlen(skb)))
2177                 return 1;
2178         if (unlikely(len > skb->len))
2179                 return 0;
2180         return __pskb_pull_tail(skb, len - skb_headlen(skb)) != NULL;
2181 }
2182
2183 void skb_condense(struct sk_buff *skb);
2184
2185 /**
2186  *      skb_headroom - bytes at buffer head
2187  *      @skb: buffer to check
2188  *
2189  *      Return the number of bytes of free space at the head of an &sk_buff.
2190  */
2191 static inline unsigned int skb_headroom(const struct sk_buff *skb)
2192 {
2193         return skb->data - skb->head;
2194 }
2195
2196 /**
2197  *      skb_tailroom - bytes at buffer end
2198  *      @skb: buffer to check
2199  *
2200  *      Return the number of bytes of free space at the tail of an sk_buff
2201  */
2202 static inline int skb_tailroom(const struct sk_buff *skb)
2203 {
2204         return skb_is_nonlinear(skb) ? 0 : skb->end - skb->tail;
2205 }
2206
2207 /**
2208  *      skb_availroom - bytes at buffer end
2209  *      @skb: buffer to check
2210  *
2211  *      Return the number of bytes of free space at the tail of an sk_buff
2212  *      allocated by sk_stream_alloc()
2213  */
2214 static inline int skb_availroom(const struct sk_buff *skb)
2215 {
2216         if (skb_is_nonlinear(skb))
2217                 return 0;
2218
2219         return skb->end - skb->tail - skb->reserved_tailroom;
2220 }
2221
2222 /**
2223  *      skb_reserve - adjust headroom
2224  *      @skb: buffer to alter
2225  *      @len: bytes to move
2226  *
2227  *      Increase the headroom of an empty &sk_buff by reducing the tail
2228  *      room. This is only allowed for an empty buffer.
2229  */
2230 static inline void skb_reserve(struct sk_buff *skb, int len)
2231 {
2232         skb->data += len;
2233         skb->tail += len;
2234 }
2235
2236 /**
2237  *      skb_tailroom_reserve - adjust reserved_tailroom
2238  *      @skb: buffer to alter
2239  *      @mtu: maximum amount of headlen permitted
2240  *      @needed_tailroom: minimum amount of reserved_tailroom
2241  *
2242  *      Set reserved_tailroom so that headlen can be as large as possible but
2243  *      not larger than mtu and tailroom cannot be smaller than
2244  *      needed_tailroom.
2245  *      The required headroom should already have been reserved before using
2246  *      this function.
2247  */
2248 static inline void skb_tailroom_reserve(struct sk_buff *skb, unsigned int mtu,
2249                                         unsigned int needed_tailroom)
2250 {
2251         SKB_LINEAR_ASSERT(skb);
2252         if (mtu < skb_tailroom(skb) - needed_tailroom)
2253                 /* use at most mtu */
2254                 skb->reserved_tailroom = skb_tailroom(skb) - mtu;
2255         else
2256                 /* use up to all available space */
2257                 skb->reserved_tailroom = needed_tailroom;
2258 }
2259
2260 #define ENCAP_TYPE_ETHER        0
2261 #define ENCAP_TYPE_IPPROTO      1
2262
2263 static inline void skb_set_inner_protocol(struct sk_buff *skb,
2264                                           __be16 protocol)
2265 {
2266         skb->inner_protocol = protocol;
2267         skb->inner_protocol_type = ENCAP_TYPE_ETHER;
2268 }
2269
2270 static inline void skb_set_inner_ipproto(struct sk_buff *skb,
2271                                          __u8 ipproto)
2272 {
2273         skb->inner_ipproto = ipproto;
2274         skb->inner_protocol_type = ENCAP_TYPE_IPPROTO;
2275 }
2276
2277 static inline void skb_reset_inner_headers(struct sk_buff *skb)
2278 {
2279         skb->inner_mac_header = skb->mac_header;
2280         skb->inner_network_header = skb->network_header;
2281         skb->inner_transport_header = skb->transport_header;
2282 }
2283
2284 static inline void skb_reset_mac_len(struct sk_buff *skb)
2285 {
2286         skb->mac_len = skb->network_header - skb->mac_header;
2287 }
2288
2289 static inline unsigned char *skb_inner_transport_header(const struct sk_buff
2290                                                         *skb)
2291 {
2292         return skb->head + skb->inner_transport_header;
2293 }
2294
2295 static inline int skb_inner_transport_offset(const struct sk_buff *skb)
2296 {
2297         return skb_inner_transport_header(skb) - skb->data;
2298 }
2299
2300 static inline void skb_reset_inner_transport_header(struct sk_buff *skb)
2301 {
2302         skb->inner_transport_header = skb->data - skb->head;
2303 }
2304
2305 static inline void skb_set_inner_transport_header(struct sk_buff *skb,
2306                                                    const int offset)
2307 {
2308         skb_reset_inner_transport_header(skb);
2309         skb->inner_transport_header += offset;
2310 }
2311
2312 static inline unsigned char *skb_inner_network_header(const struct sk_buff *skb)
2313 {
2314         return skb->head + skb->inner_network_header;
2315 }
2316
2317 static inline void skb_reset_inner_network_header(struct sk_buff *skb)
2318 {
2319         skb->inner_network_header = skb->data - skb->head;
2320 }
2321
2322 static inline void skb_set_inner_network_header(struct sk_buff *skb,
2323                                                 const int offset)
2324 {
2325         skb_reset_inner_network_header(skb);
2326         skb->inner_network_header += offset;
2327 }
2328
2329 static inline unsigned char *skb_inner_mac_header(const struct sk_buff *skb)
2330 {
2331         return skb->head + skb->inner_mac_header;
2332 }
2333
2334 static inline void skb_reset_inner_mac_header(struct sk_buff *skb)
2335 {
2336         skb->inner_mac_header = skb->data - skb->head;
2337 }
2338
2339 static inline void skb_set_inner_mac_header(struct sk_buff *skb,
2340                                             const int offset)
2341 {
2342         skb_reset_inner_mac_header(skb);
2343         skb->inner_mac_header += offset;
2344 }
2345 static inline bool skb_transport_header_was_set(const struct sk_buff *skb)
2346 {
2347         return skb->transport_header != (typeof(skb->transport_header))~0U;
2348 }
2349
2350 static inline unsigned char *skb_transport_header(const struct sk_buff *skb)
2351 {
2352         return skb->head + skb->transport_header;
2353 }
2354
2355 static inline void skb_reset_transport_header(struct sk_buff *skb)
2356 {
2357         skb->transport_header = skb->data - skb->head;
2358 }
2359
2360 static inline void skb_set_transport_header(struct sk_buff *skb,
2361                                             const int offset)
2362 {
2363         skb_reset_transport_header(skb);
2364         skb->transport_header += offset;
2365 }
2366
2367 static inline unsigned char *skb_network_header(const struct sk_buff *skb)
2368 {
2369         return skb->head + skb->network_header;
2370 }
2371
2372 static inline void skb_reset_network_header(struct sk_buff *skb)
2373 {
2374         skb->network_header = skb->data - skb->head;
2375 }
2376
2377 static inline void skb_set_network_header(struct sk_buff *skb, const int offset)
2378 {
2379         skb_reset_network_header(skb);
2380         skb->network_header += offset;
2381 }
2382
2383 static inline unsigned char *skb_mac_header(const struct sk_buff *skb)
2384 {
2385         return skb->head + skb->mac_header;
2386 }
2387
2388 static inline int skb_mac_offset(const struct sk_buff *skb)
2389 {
2390         return skb_mac_header(skb) - skb->data;
2391 }
2392
2393 static inline u32 skb_mac_header_len(const struct sk_buff *skb)
2394 {
2395         return skb->network_header - skb->mac_header;
2396 }
2397
2398 static inline int skb_mac_header_was_set(const struct sk_buff *skb)
2399 {
2400         return skb->mac_header != (typeof(skb->mac_header))~0U;
2401 }
2402
2403 static inline void skb_reset_mac_header(struct sk_buff *skb)
2404 {
2405         skb->mac_header = skb->data - skb->head;
2406 }
2407
2408 static inline void skb_set_mac_header(struct sk_buff *skb, const int offset)
2409 {
2410         skb_reset_mac_header(skb);
2411         skb->mac_header += offset;
2412 }
2413
2414 static inline void skb_pop_mac_header(struct sk_buff *skb)
2415 {
2416         skb->mac_header = skb->network_header;
2417 }
2418
2419 static inline void skb_probe_transport_header(struct sk_buff *skb,
2420                                               const int offset_hint)
2421 {
2422         struct flow_keys keys;
2423
2424         if (skb_transport_header_was_set(skb))
2425                 return;
2426         else if (skb_flow_dissect_flow_keys(skb, &keys, 0))
2427                 skb_set_transport_header(skb, keys.control.thoff);
2428         else if (offset_hint >= 0)
2429                 skb_set_transport_header(skb, offset_hint);
2430 }
2431
2432 static inline void skb_mac_header_rebuild(struct sk_buff *skb)
2433 {
2434         if (skb_mac_header_was_set(skb)) {
2435                 const unsigned char *old_mac = skb_mac_header(skb);
2436
2437                 skb_set_mac_header(skb, -skb->mac_len);
2438                 memmove(skb_mac_header(skb), old_mac, skb->mac_len);
2439         }
2440 }
2441
2442 static inline int skb_checksum_start_offset(const struct sk_buff *skb)
2443 {
2444         return skb->csum_start - skb_headroom(skb);
2445 }
2446
2447 static inline unsigned char *skb_checksum_start(const struct sk_buff *skb)
2448 {
2449         return skb->head + skb->csum_start;
2450 }
2451
2452 static inline int skb_transport_offset(const struct sk_buff *skb)
2453 {
2454         return skb_transport_header(skb) - skb->data;
2455 }
2456
2457 static inline u32 skb_network_header_len(const struct sk_buff *skb)
2458 {
2459         return skb->transport_header - skb->network_header;
2460 }
2461
2462 static inline u32 skb_inner_network_header_len(const struct sk_buff *skb)
2463 {
2464         return skb->inner_transport_header - skb->inner_network_header;
2465 }
2466
2467 static inline int skb_network_offset(const struct sk_buff *skb)
2468 {
2469         return skb_network_header(skb) - skb->data;
2470 }
2471
2472 static inline int skb_inner_network_offset(const struct sk_buff *skb)
2473 {
2474         return skb_inner_network_header(skb) - skb->data;
2475 }
2476
2477 static inline int pskb_network_may_pull(struct sk_buff *skb, unsigned int len)
2478 {
2479         return pskb_may_pull(skb, skb_network_offset(skb) + len);
2480 }
2481
2482 /*
2483  * CPUs often take a performance hit when accessing unaligned memory
2484  * locations. The actual performance hit varies, it can be small if the
2485  * hardware handles it or large if we have to take an exception and fix it
2486  * in software.
2487  *
2488  * Since an ethernet header is 14 bytes network drivers often end up with
2489  * the IP header at an unaligned offset. The IP header can be aligned by
2490  * shifting the start of the packet by 2 bytes. Drivers should do this
2491  * with:
2492  *
2493  * skb_reserve(skb, NET_IP_ALIGN);
2494  *
2495  * The downside to this alignment of the IP header is that the DMA is now
2496  * unaligned. On some architectures the cost of an unaligned DMA is high
2497  * and this cost outweighs the gains made by aligning the IP header.
2498  *
2499  * Since this trade off varies between architectures, we allow NET_IP_ALIGN
2500  * to be overridden.
2501  */
2502 #ifndef NET_IP_ALIGN
2503 #define NET_IP_ALIGN    2
2504 #endif
2505
2506 /*
2507  * The networking layer reserves some headroom in skb data (via
2508  * dev_alloc_skb). This is used to avoid having to reallocate skb data when
2509  * the header has to grow. In the default case, if the header has to grow
2510  * 32 bytes or less we avoid the reallocation.
2511  *
2512  * Unfortunately this headroom changes the DMA alignment of the resulting
2513  * network packet. As for NET_IP_ALIGN, this unaligned DMA is expensive
2514  * on some architectures. An architecture can override this value,
2515  * perhaps setting it to a cacheline in size (since that will maintain
2516  * cacheline alignment of the DMA). It must be a power of 2.
2517  *
2518  * Various parts of the networking layer expect at least 32 bytes of
2519  * headroom, you should not reduce this.
2520  *
2521  * Using max(32, L1_CACHE_BYTES) makes sense (especially with RPS)
2522  * to reduce average number of cache lines per packet.
2523  * get_rps_cpus() for example only access one 64 bytes aligned block :
2524  * NET_IP_ALIGN(2) + ethernet_header(14) + IP_header(20/40) + ports(8)
2525  */
2526 #ifndef NET_SKB_PAD
2527 #define NET_SKB_PAD     max(32, L1_CACHE_BYTES)
2528 #endif
2529
2530 int ___pskb_trim(struct sk_buff *skb, unsigned int len);
2531
2532 static inline void __skb_set_length(struct sk_buff *skb, unsigned int len)
2533 {
2534         if (unlikely(skb_is_nonlinear(skb))) {
2535                 WARN_ON(1);
2536                 return;
2537         }
2538         skb->len = len;
2539         skb_set_tail_pointer(skb, len);
2540 }
2541
2542 static inline void __skb_trim(struct sk_buff *skb, unsigned int len)
2543 {
2544         __skb_set_length(skb, len);
2545 }
2546
2547 void skb_trim(struct sk_buff *skb, unsigned int len);
2548
2549 static inline int __pskb_trim(struct sk_buff *skb, unsigned int len)
2550 {
2551         if (skb->data_len)
2552                 return ___pskb_trim(skb, len);
2553         __skb_trim(skb, len);
2554         return 0;
2555 }
2556
2557 static inline int pskb_trim(struct sk_buff *skb, unsigned int len)
2558 {
2559         return (len < skb->len) ? __pskb_trim(skb, len) : 0;
2560 }
2561
2562 /**
2563  *      pskb_trim_unique - remove end from a paged unique (not cloned) buffer
2564  *      @skb: buffer to alter
2565  *      @len: new length
2566  *
2567  *      This is identical to pskb_trim except that the caller knows that
2568  *      the skb is not cloned so we should never get an error due to out-
2569  *      of-memory.
2570  */
2571 static inline void pskb_trim_unique(struct sk_buff *skb, unsigned int len)
2572 {
2573         int err = pskb_trim(skb, len);
2574         BUG_ON(err);
2575 }
2576
2577 static inline int __skb_grow(struct sk_buff *skb, unsigned int len)
2578 {
2579         unsigned int diff = len - skb->len;
2580
2581         if (skb_tailroom(skb) < diff) {
2582                 int ret = pskb_expand_head(skb, 0, diff - skb_tailroom(skb),
2583                                            GFP_ATOMIC);
2584                 if (ret)
2585                         return ret;
2586         }
2587         __skb_set_length(skb, len);
2588         return 0;
2589 }
2590
2591 /**
2592  *      skb_orphan - orphan a buffer
2593  *      @skb: buffer to orphan
2594  *
2595  *      If a buffer currently has an owner then we call the owner's
2596  *      destructor function and make the @skb unowned. The buffer continues
2597  *      to exist but is no longer charged to its former owner.
2598  */
2599 static inline void skb_orphan(struct sk_buff *skb)
2600 {
2601         if (skb->destructor) {
2602                 skb->destructor(skb);
2603                 skb->destructor = NULL;
2604                 skb->sk         = NULL;
2605         } else {
2606                 BUG_ON(skb->sk);
2607         }
2608 }
2609
2610 /**
2611  *      skb_orphan_frags - orphan the frags contained in a buffer
2612  *      @skb: buffer to orphan frags from
2613  *      @gfp_mask: allocation mask for replacement pages
2614  *
2615  *      For each frag in the SKB which needs a destructor (i.e. has an
2616  *      owner) create a copy of that frag and release the original
2617  *      page by calling the destructor.
2618  */
2619 static inline int skb_orphan_frags(struct sk_buff *skb, gfp_t gfp_mask)
2620 {
2621         if (likely(!skb_zcopy(skb)))
2622                 return 0;
2623         if (!skb_zcopy_is_nouarg(skb) &&
2624             skb_uarg(skb)->callback == sock_zerocopy_callback)
2625                 return 0;
2626         return skb_copy_ubufs(skb, gfp_mask);
2627 }
2628
2629 /* Frags must be orphaned, even if refcounted, if skb might loop to rx path */
2630 static inline int skb_orphan_frags_rx(struct sk_buff *skb, gfp_t gfp_mask)
2631 {
2632         if (likely(!skb_zcopy(skb)))
2633                 return 0;
2634         return skb_copy_ubufs(skb, gfp_mask);
2635 }
2636
2637 /**
2638  *      __skb_queue_purge - empty a list
2639  *      @list: list to empty
2640  *
2641  *      Delete all buffers on an &sk_buff list. Each buffer is removed from
2642  *      the list and one reference dropped. This function does not take the
2643  *      list lock and the caller must hold the relevant locks to use it.
2644  */
2645 void skb_queue_purge(struct sk_buff_head *list);
2646 static inline void __skb_queue_purge(struct sk_buff_head *list)
2647 {
2648         struct sk_buff *skb;
2649         while ((skb = __skb_dequeue(list)) != NULL)
2650                 kfree_skb(skb);
2651 }
2652
2653 unsigned int skb_rbtree_purge(struct rb_root *root);
2654
2655 void *netdev_alloc_frag(unsigned int fragsz);
2656
2657 struct sk_buff *__netdev_alloc_skb(struct net_device *dev, unsigned int length,
2658                                    gfp_t gfp_mask);
2659
2660 /**
2661  *      netdev_alloc_skb - allocate an skbuff for rx on a specific device
2662  *      @dev: network device to receive on
2663  *      @length: length to allocate
2664  *
2665  *      Allocate a new &sk_buff and assign it a usage count of one. The
2666  *      buffer has unspecified headroom built in. Users should allocate
2667  *      the headroom they think they need without accounting for the
2668  *      built in space. The built in space is used for optimisations.
2669  *
2670  *      %NULL is returned if there is no free memory. Although this function
2671  *      allocates memory it can be called from an interrupt.
2672  */
2673 static inline struct sk_buff *netdev_alloc_skb(struct net_device *dev,
2674                                                unsigned int length)
2675 {
2676         return __netdev_alloc_skb(dev, length, GFP_ATOMIC);
2677 }
2678
2679 /* legacy helper around __netdev_alloc_skb() */
2680 static inline struct sk_buff *__dev_alloc_skb(unsigned int length,
2681                                               gfp_t gfp_mask)
2682 {
2683         return __netdev_alloc_skb(NULL, length, gfp_mask);
2684 }
2685
2686 /* legacy helper around netdev_alloc_skb() */
2687 static inline struct sk_buff *dev_alloc_skb(unsigned int length)
2688 {
2689         return netdev_alloc_skb(NULL, length);
2690 }
2691
2692
2693 static inline struct sk_buff *__netdev_alloc_skb_ip_align(struct net_device *dev,
2694                 unsigned int length, gfp_t gfp)
2695 {
2696         struct sk_buff *skb = __netdev_alloc_skb(dev, length + NET_IP_ALIGN, gfp);
2697
2698         if (NET_IP_ALIGN && skb)
2699                 skb_reserve(skb, NET_IP_ALIGN);
2700         return skb;
2701 }
2702
2703 static inline struct sk_buff *netdev_alloc_skb_ip_align(struct net_device *dev,
2704                 unsigned int length)
2705 {
2706         return __netdev_alloc_skb_ip_align(dev, length, GFP_ATOMIC);
2707 }
2708
2709 static inline void skb_free_frag(void *addr)
2710 {
2711         page_frag_free(addr);
2712 }
2713
2714 void *napi_alloc_frag(unsigned int fragsz);
2715 struct sk_buff *__napi_alloc_skb(struct napi_struct *napi,
2716                                  unsigned int length, gfp_t gfp_mask);
2717 static inline struct sk_buff *napi_alloc_skb(struct napi_struct *napi,
2718                                              unsigned int length)
2719 {
2720         return __napi_alloc_skb(napi, length, GFP_ATOMIC);
2721 }
2722 void napi_consume_skb(struct sk_buff *skb, int budget);
2723
2724 void __kfree_skb_flush(void);
2725 void __kfree_skb_defer(struct sk_buff *skb);
2726
2727 /**
2728  * __dev_alloc_pages - allocate page for network Rx
2729  * @gfp_mask: allocation priority. Set __GFP_NOMEMALLOC if not for network Rx
2730  * @order: size of the allocation
2731  *
2732  * Allocate a new page.
2733  *
2734  * %NULL is returned if there is no free memory.
2735 */
2736 static inline struct page *__dev_alloc_pages(gfp_t gfp_mask,
2737                                              unsigned int order)
2738 {
2739         /* This piece of code contains several assumptions.
2740          * 1.  This is for device Rx, therefor a cold page is preferred.
2741          * 2.  The expectation is the user wants a compound page.
2742          * 3.  If requesting a order 0 page it will not be compound
2743          *     due to the check to see if order has a value in prep_new_page
2744          * 4.  __GFP_MEMALLOC is ignored if __GFP_NOMEMALLOC is set due to
2745          *     code in gfp_to_alloc_flags that should be enforcing this.
2746          */
2747         gfp_mask |= __GFP_COLD | __GFP_COMP | __GFP_MEMALLOC;
2748
2749         return alloc_pages_node(NUMA_NO_NODE, gfp_mask, order);
2750 }
2751
2752 static inline struct page *dev_alloc_pages(unsigned int order)
2753 {
2754         return __dev_alloc_pages(GFP_ATOMIC | __GFP_NOWARN, order);
2755 }
2756
2757 /**
2758  * __dev_alloc_page - allocate a page for network Rx
2759  * @gfp_mask: allocation priority. Set __GFP_NOMEMALLOC if not for network Rx
2760  *
2761  * Allocate a new page.
2762  *
2763  * %NULL is returned if there is no free memory.
2764  */
2765 static inline struct page *__dev_alloc_page(gfp_t gfp_mask)
2766 {
2767         return __dev_alloc_pages(gfp_mask, 0);
2768 }
2769
2770 static inline struct page *dev_alloc_page(void)
2771 {
2772         return dev_alloc_pages(0);
2773 }
2774
2775 /**
2776  *      skb_propagate_pfmemalloc - Propagate pfmemalloc if skb is allocated after RX page
2777  *      @page: The page that was allocated from skb_alloc_page
2778  *      @skb: The skb that may need pfmemalloc set
2779  */
2780 static inline void skb_propagate_pfmemalloc(struct page *page,
2781                                              struct sk_buff *skb)
2782 {
2783         if (page_is_pfmemalloc(page))
2784                 skb->pfmemalloc = true;
2785 }
2786
2787 /**
2788  * skb_frag_off() - Returns the offset of a skb fragment
2789  * @frag: the paged fragment
2790  */
2791 static inline unsigned int skb_frag_off(const skb_frag_t *frag)
2792 {
2793         return frag->page_offset;
2794 }
2795
2796 /**
2797  * skb_frag_page - retrieve the page referred to by a paged fragment
2798  * @frag: the paged fragment
2799  *
2800  * Returns the &struct page associated with @frag.
2801  */
2802 static inline struct page *skb_frag_page(const skb_frag_t *frag)
2803 {
2804         return frag->page.p;
2805 }
2806
2807 /**
2808  * __skb_frag_ref - take an addition reference on a paged fragment.
2809  * @frag: the paged fragment
2810  *
2811  * Takes an additional reference on the paged fragment @frag.
2812  */
2813 static inline void __skb_frag_ref(skb_frag_t *frag)
2814 {
2815         get_page(skb_frag_page(frag));
2816 }
2817
2818 /**
2819  * skb_frag_ref - take an addition reference on a paged fragment of an skb.
2820  * @skb: the buffer
2821  * @f: the fragment offset.
2822  *
2823  * Takes an additional reference on the @f'th paged fragment of @skb.
2824  */
2825 static inline void skb_frag_ref(struct sk_buff *skb, int f)
2826 {
2827         __skb_frag_ref(&skb_shinfo(skb)->frags[f]);
2828 }
2829
2830 /**
2831  * __skb_frag_unref - release a reference on a paged fragment.
2832  * @frag: the paged fragment
2833  *
2834  * Releases a reference on the paged fragment @frag.
2835  */
2836 static inline void __skb_frag_unref(skb_frag_t *frag)
2837 {
2838         put_page(skb_frag_page(frag));
2839 }
2840
2841 /**
2842  * skb_frag_unref - release a reference on a paged fragment of an skb.
2843  * @skb: the buffer
2844  * @f: the fragment offset
2845  *
2846  * Releases a reference on the @f'th paged fragment of @skb.
2847  */
2848 static inline void skb_frag_unref(struct sk_buff *skb, int f)
2849 {
2850         __skb_frag_unref(&skb_shinfo(skb)->frags[f]);
2851 }
2852
2853 /**
2854  * skb_frag_address - gets the address of the data contained in a paged fragment
2855  * @frag: the paged fragment buffer
2856  *
2857  * Returns the address of the data within @frag. The page must already
2858  * be mapped.
2859  */
2860 static inline void *skb_frag_address(const skb_frag_t *frag)
2861 {
2862         return page_address(skb_frag_page(frag)) + frag->page_offset;
2863 }
2864
2865 /**
2866  * skb_frag_address_safe - gets the address of the data contained in a paged fragment
2867  * @frag: the paged fragment buffer
2868  *
2869  * Returns the address of the data within @frag. Checks that the page
2870  * is mapped and returns %NULL otherwise.
2871  */
2872 static inline void *skb_frag_address_safe(const skb_frag_t *frag)
2873 {
2874         void *ptr = page_address(skb_frag_page(frag));
2875         if (unlikely(!ptr))
2876                 return NULL;
2877
2878         return ptr + frag->page_offset;
2879 }
2880
2881 /**
2882  * __skb_frag_set_page - sets the page contained in a paged fragment
2883  * @frag: the paged fragment
2884  * @page: the page to set
2885  *
2886  * Sets the fragment @frag to contain @page.
2887  */
2888 static inline void __skb_frag_set_page(skb_frag_t *frag, struct page *page)
2889 {
2890         frag->page.p = page;
2891 }
2892
2893 /**
2894  * skb_frag_set_page - sets the page contained in a paged fragment of an skb
2895  * @skb: the buffer
2896  * @f: the fragment offset
2897  * @page: the page to set
2898  *
2899  * Sets the @f'th fragment of @skb to contain @page.
2900  */
2901 static inline void skb_frag_set_page(struct sk_buff *skb, int f,
2902                                      struct page *page)
2903 {
2904         __skb_frag_set_page(&skb_shinfo(skb)->frags[f], page);
2905 }
2906
2907 bool skb_page_frag_refill(unsigned int sz, struct page_frag *pfrag, gfp_t prio);
2908
2909 /**
2910  * skb_frag_dma_map - maps a paged fragment via the DMA API
2911  * @dev: the device to map the fragment to
2912  * @frag: the paged fragment to map
2913  * @offset: the offset within the fragment (starting at the
2914  *          fragment's own offset)
2915  * @size: the number of bytes to map
2916  * @dir: the direction of the mapping (``PCI_DMA_*``)
2917  *
2918  * Maps the page associated with @frag to @device.
2919  */
2920 static inline dma_addr_t skb_frag_dma_map(struct device *dev,
2921                                           const skb_frag_t *frag,
2922                                           size_t offset, size_t size,
2923                                           enum dma_data_direction dir)
2924 {
2925         return dma_map_page(dev, skb_frag_page(frag),
2926                             frag->page_offset + offset, size, dir);
2927 }
2928
2929 static inline struct sk_buff *pskb_copy(struct sk_buff *skb,
2930                                         gfp_t gfp_mask)
2931 {
2932         return __pskb_copy(skb, skb_headroom(skb), gfp_mask);
2933 }
2934
2935
2936 static inline struct sk_buff *pskb_copy_for_clone(struct sk_buff *skb,
2937                                                   gfp_t gfp_mask)
2938 {
2939         return __pskb_copy_fclone(skb, skb_headroom(skb), gfp_mask, true);
2940 }
2941
2942
2943 /**
2944  *      skb_clone_writable - is the header of a clone writable
2945  *      @skb: buffer to check
2946  *      @len: length up to which to write
2947  *
2948  *      Returns true if modifying the header part of the cloned buffer
2949  *      does not requires the data to be copied.
2950  */
2951 static inline int skb_clone_writable(const struct sk_buff *skb, unsigned int len)
2952 {
2953         return !skb_header_cloned(skb) &&
2954                skb_headroom(skb) + len <= skb->hdr_len;
2955 }
2956
2957 static inline int skb_try_make_writable(struct sk_buff *skb,
2958                                         unsigned int write_len)
2959 {
2960         return skb_cloned(skb) && !skb_clone_writable(skb, write_len) &&
2961                pskb_expand_head(skb, 0, 0, GFP_ATOMIC);
2962 }
2963
2964 static inline int __skb_cow(struct sk_buff *skb, unsigned int headroom,
2965                             int cloned)
2966 {
2967         int delta = 0;
2968
2969         if (headroom > skb_headroom(skb))
2970                 delta = headroom - skb_headroom(skb);
2971
2972         if (delta || cloned)
2973                 return pskb_expand_head(skb, ALIGN(delta, NET_SKB_PAD), 0,
2974                                         GFP_ATOMIC);
2975         return 0;
2976 }
2977
2978 /**
2979  *      skb_cow - copy header of skb when it is required
2980  *      @skb: buffer to cow
2981  *      @headroom: needed headroom
2982  *
2983  *      If the skb passed lacks sufficient headroom or its data part
2984  *      is shared, data is reallocated. If reallocation fails, an error
2985  *      is returned and original skb is not changed.
2986  *
2987  *      The result is skb with writable area skb->head...skb->tail
2988  *      and at least @headroom of space at head.
2989  */
2990 static inline int skb_cow(struct sk_buff *skb, unsigned int headroom)
2991 {
2992         return __skb_cow(skb, headroom, skb_cloned(skb));
2993 }
2994
2995 /**
2996  *      skb_cow_head - skb_cow but only making the head writable
2997  *      @skb: buffer to cow
2998  *      @headroom: needed headroom
2999  *
3000  *      This function is identical to skb_cow except that we replace the
3001  *      skb_cloned check by skb_header_cloned.  It should be used when
3002  *      you only need to push on some header and do not need to modify
3003  *      the data.
3004  */
3005 static inline int skb_cow_head(struct sk_buff *skb, unsigned int headroom)
3006 {
3007         return __skb_cow(skb, headroom, skb_header_cloned(skb));
3008 }
3009
3010 /**
3011  *      skb_padto       - pad an skbuff up to a minimal size
3012  *      @skb: buffer to pad
3013  *      @len: minimal length
3014  *
3015  *      Pads up a buffer to ensure the trailing bytes exist and are
3016  *      blanked. If the buffer already contains sufficient data it
3017  *      is untouched. Otherwise it is extended. Returns zero on
3018  *      success. The skb is freed on error.
3019  */
3020 static inline int skb_padto(struct sk_buff *skb, unsigned int len)
3021 {
3022         unsigned int size = skb->len;
3023         if (likely(size >= len))
3024                 return 0;
3025         return skb_pad(skb, len - size);
3026 }
3027
3028 /**
3029  *      skb_put_padto - increase size and pad an skbuff up to a minimal size
3030  *      @skb: buffer to pad
3031  *      @len: minimal length
3032  *      @free_on_error: free buffer on error
3033  *
3034  *      Pads up a buffer to ensure the trailing bytes exist and are
3035  *      blanked. If the buffer already contains sufficient data it
3036  *      is untouched. Otherwise it is extended. Returns zero on
3037  *      success. The skb is freed on error if @free_on_error is true.
3038  */
3039 static inline int __must_check __skb_put_padto(struct sk_buff *skb,
3040                                                unsigned int len,
3041                                                bool free_on_error)
3042 {
3043         unsigned int size = skb->len;
3044
3045         if (unlikely(size < len)) {
3046                 len -= size;
3047                 if (__skb_pad(skb, len, free_on_error))
3048                         return -ENOMEM;
3049                 __skb_put(skb, len);
3050         }
3051         return 0;
3052 }
3053
3054 /**
3055  *      skb_put_padto - increase size and pad an skbuff up to a minimal size
3056  *      @skb: buffer to pad
3057  *      @len: minimal length
3058  *
3059  *      Pads up a buffer to ensure the trailing bytes exist and are
3060  *      blanked. If the buffer already contains sufficient data it
3061  *      is untouched. Otherwise it is extended. Returns zero on
3062  *      success. The skb is freed on error.
3063  */
3064 static inline int __must_check skb_put_padto(struct sk_buff *skb, unsigned int len)
3065 {
3066         return __skb_put_padto(skb, len, true);
3067 }
3068
3069 static inline int skb_add_data(struct sk_buff *skb,
3070                                struct iov_iter *from, int copy)
3071 {
3072         const int off = skb->len;
3073
3074         if (skb->ip_summed == CHECKSUM_NONE) {
3075                 __wsum csum = 0;
3076                 if (csum_and_copy_from_iter_full(skb_put(skb, copy), copy,
3077                                                  &csum, from)) {
3078                         skb->csum = csum_block_add(skb->csum, csum, off);
3079                         return 0;
3080                 }
3081         } else if (copy_from_iter_full(skb_put(skb, copy), copy, from))
3082                 return 0;
3083
3084         __skb_trim(skb, off);
3085         return -EFAULT;
3086 }
3087
3088 static inline bool skb_can_coalesce(struct sk_buff *skb, int i,
3089                                     const struct page *page, int off)
3090 {
3091         if (skb_zcopy(skb))
3092                 return false;
3093         if (i) {
3094                 const struct skb_frag_struct *frag = &skb_shinfo(skb)->frags[i - 1];
3095
3096                 return page == skb_frag_page(frag) &&
3097                        off == frag->page_offset + skb_frag_size(frag);
3098         }
3099         return false;
3100 }
3101
3102 static inline int __skb_linearize(struct sk_buff *skb)
3103 {
3104         return __pskb_pull_tail(skb, skb->data_len) ? 0 : -ENOMEM;
3105 }
3106
3107 /**
3108  *      skb_linearize - convert paged skb to linear one
3109  *      @skb: buffer to linarize
3110  *
3111  *      If there is no free memory -ENOMEM is returned, otherwise zero
3112  *      is returned and the old skb data released.
3113  */
3114 static inline int skb_linearize(struct sk_buff *skb)
3115 {
3116         return skb_is_nonlinear(skb) ? __skb_linearize(skb) : 0;
3117 }
3118
3119 /**
3120  * skb_has_shared_frag - can any frag be overwritten
3121  * @skb: buffer to test
3122  *
3123  * Return true if the skb has at least one frag that might be modified
3124  * by an external entity (as in vmsplice()/sendfile())
3125  */
3126 static inline bool skb_has_shared_frag(const struct sk_buff *skb)
3127 {
3128         return skb_is_nonlinear(skb) &&
3129                skb_shinfo(skb)->tx_flags & SKBTX_SHARED_FRAG;
3130 }
3131
3132 /**
3133  *      skb_linearize_cow - make sure skb is linear and writable
3134  *      @skb: buffer to process
3135  *
3136  *      If there is no free memory -ENOMEM is returned, otherwise zero
3137  *      is returned and the old skb data released.
3138  */
3139 static inline int skb_linearize_cow(struct sk_buff *skb)
3140 {
3141         return skb_is_nonlinear(skb) || skb_cloned(skb) ?
3142                __skb_linearize(skb) : 0;
3143 }
3144
3145 static __always_inline void
3146 __skb_postpull_rcsum(struct sk_buff *skb, const void *start, unsigned int len,
3147                      unsigned int off)
3148 {
3149         if (skb->ip_summed == CHECKSUM_COMPLETE)
3150                 skb->csum = csum_block_sub(skb->csum,
3151                                            csum_partial(start, len, 0), off);
3152         else if (skb->ip_summed == CHECKSUM_PARTIAL &&
3153                  skb_checksum_start_offset(skb) < 0)
3154                 skb->ip_summed = CHECKSUM_NONE;
3155 }
3156
3157 /**
3158  *      skb_postpull_rcsum - update checksum for received skb after pull
3159  *      @skb: buffer to update
3160  *      @start: start of data before pull
3161  *      @len: length of data pulled
3162  *
3163  *      After doing a pull on a received packet, you need to call this to
3164  *      update the CHECKSUM_COMPLETE checksum, or set ip_summed to
3165  *      CHECKSUM_NONE so that it can be recomputed from scratch.
3166  */
3167 static inline void skb_postpull_rcsum(struct sk_buff *skb,
3168                                       const void *start, unsigned int len)
3169 {
3170         __skb_postpull_rcsum(skb, start, len, 0);
3171 }
3172
3173 static __always_inline void
3174 __skb_postpush_rcsum(struct sk_buff *skb, const void *start, unsigned int len,
3175                      unsigned int off)
3176 {
3177         if (skb->ip_summed == CHECKSUM_COMPLETE)
3178                 skb->csum = csum_block_add(skb->csum,
3179                                            csum_partial(start, len, 0), off);
3180 }
3181
3182 /**
3183  *      skb_postpush_rcsum - update checksum for received skb after push
3184  *      @skb: buffer to update
3185  *      @start: start of data after push
3186  *      @len: length of data pushed
3187  *
3188  *      After doing a push on a received packet, you need to call this to
3189  *      update the CHECKSUM_COMPLETE checksum.
3190  */
3191 static inline void skb_postpush_rcsum(struct sk_buff *skb,
3192                                       const void *start, unsigned int len)
3193 {
3194         __skb_postpush_rcsum(skb, start, len, 0);
3195 }
3196
3197 void *skb_pull_rcsum(struct sk_buff *skb, unsigned int len);
3198
3199 /**
3200  *      skb_push_rcsum - push skb and update receive checksum
3201  *      @skb: buffer to update
3202  *      @len: length of data pulled
3203  *
3204  *      This function performs an skb_push on the packet and updates
3205  *      the CHECKSUM_COMPLETE checksum.  It should be used on
3206  *      receive path processing instead of skb_push unless you know
3207  *      that the checksum difference is zero (e.g., a valid IP header)
3208  *      or you are setting ip_summed to CHECKSUM_NONE.
3209  */
3210 static inline void *skb_push_rcsum(struct sk_buff *skb, unsigned int len)
3211 {
3212         skb_push(skb, len);
3213         skb_postpush_rcsum(skb, skb->data, len);
3214         return skb->data;
3215 }
3216
3217 int pskb_trim_rcsum_slow(struct sk_buff *skb, unsigned int len);
3218 /**
3219  *      pskb_trim_rcsum - trim received skb and update checksum
3220  *      @skb: buffer to trim
3221  *      @len: new length
3222  *
3223  *      This is exactly the same as pskb_trim except that it ensures the
3224  *      checksum of received packets are still valid after the operation.
3225  *      It can change skb pointers.
3226  */
3227
3228 static inline int pskb_trim_rcsum(struct sk_buff *skb, unsigned int len)
3229 {
3230         if (likely(len >= skb->len))
3231                 return 0;
3232         return pskb_trim_rcsum_slow(skb, len);
3233 }
3234
3235 static inline int __skb_trim_rcsum(struct sk_buff *skb, unsigned int len)
3236 {
3237         if (skb->ip_summed == CHECKSUM_COMPLETE)
3238                 skb->ip_summed = CHECKSUM_NONE;
3239         __skb_trim(skb, len);
3240         return 0;
3241 }
3242
3243 static inline int __skb_grow_rcsum(struct sk_buff *skb, unsigned int len)
3244 {
3245         if (skb->ip_summed == CHECKSUM_COMPLETE)
3246                 skb->ip_summed = CHECKSUM_NONE;
3247         return __skb_grow(skb, len);
3248 }
3249
3250 #define rb_to_skb(rb) rb_entry_safe(rb, struct sk_buff, rbnode)
3251
3252 #define rb_to_skb(rb) rb_entry_safe(rb, struct sk_buff, rbnode)
3253 #define skb_rb_first(root) rb_to_skb(rb_first(root))
3254 #define skb_rb_last(root)  rb_to_skb(rb_last(root))
3255 #define skb_rb_next(skb)   rb_to_skb(rb_next(&(skb)->rbnode))
3256 #define skb_rb_prev(skb)   rb_to_skb(rb_prev(&(skb)->rbnode))
3257
3258 #define skb_queue_walk(queue, skb) \
3259                 for (skb = (queue)->next;                                       \
3260                      skb != (struct sk_buff *)(queue);                          \
3261                      skb = skb->next)
3262
3263 #define skb_queue_walk_safe(queue, skb, tmp)                                    \
3264                 for (skb = (queue)->next, tmp = skb->next;                      \
3265                      skb != (struct sk_buff *)(queue);                          \
3266                      skb = tmp, tmp = skb->next)
3267
3268 #define skb_queue_walk_from(queue, skb)                                         \
3269                 for (; skb != (struct sk_buff *)(queue);                        \
3270                      skb = skb->next)
3271
3272 #define skb_rbtree_walk(skb, root)                                              \
3273                 for (skb = skb_rb_first(root); skb != NULL;                     \
3274                      skb = skb_rb_next(skb))
3275
3276 #define skb_rbtree_walk_from(skb)                                               \
3277                 for (; skb != NULL;                                             \
3278                      skb = skb_rb_next(skb))
3279
3280 #define skb_rbtree_walk_from_safe(skb, tmp)                                     \
3281                 for (; tmp = skb ? skb_rb_next(skb) : NULL, (skb != NULL);      \
3282                      skb = tmp)
3283
3284 #define skb_queue_walk_from_safe(queue, skb, tmp)                               \
3285                 for (tmp = skb->next;                                           \
3286                      skb != (struct sk_buff *)(queue);                          \
3287                      skb = tmp, tmp = skb->next)
3288
3289 #define skb_queue_reverse_walk(queue, skb) \
3290                 for (skb = (queue)->prev;                                       \
3291                      skb != (struct sk_buff *)(queue);                          \
3292                      skb = skb->prev)
3293
3294 #define skb_queue_reverse_walk_safe(queue, skb, tmp)                            \
3295                 for (skb = (queue)->prev, tmp = skb->prev;                      \
3296                      skb != (struct sk_buff *)(queue);                          \
3297                      skb = tmp, tmp = skb->prev)
3298
3299 #define skb_queue_reverse_walk_from_safe(queue, skb, tmp)                       \
3300                 for (tmp = skb->prev;                                           \
3301                      skb != (struct sk_buff *)(queue);                          \
3302                      skb = tmp, tmp = skb->prev)
3303
3304 static inline bool skb_has_frag_list(const struct sk_buff *skb)
3305 {
3306         return skb_shinfo(skb)->frag_list != NULL;
3307 }
3308
3309 static inline void skb_frag_list_init(struct sk_buff *skb)
3310 {
3311         skb_shinfo(skb)->frag_list = NULL;
3312 }
3313
3314 #define skb_walk_frags(skb, iter)       \
3315         for (iter = skb_shinfo(skb)->frag_list; iter; iter = iter->next)
3316
3317
3318 int __skb_wait_for_more_packets(struct sock *sk, int *err, long *timeo_p,
3319                                 const struct sk_buff *skb);
3320 struct sk_buff *__skb_try_recv_from_queue(struct sock *sk,
3321                                           struct sk_buff_head *queue,
3322                                           unsigned int flags,
3323                                           void (*destructor)(struct sock *sk,
3324                                                            struct sk_buff *skb),
3325                                           int *peeked, int *off, int *err,
3326                                           struct sk_buff **last);
3327 struct sk_buff *__skb_try_recv_datagram(struct sock *sk, unsigned flags,
3328                                         void (*destructor)(struct sock *sk,
3329                                                            struct sk_buff *skb),
3330                                         int *peeked, int *off, int *err,
3331                                         struct sk_buff **last);
3332 struct sk_buff *__skb_recv_datagram(struct sock *sk, unsigned flags,
3333                                     void (*destructor)(struct sock *sk,
3334                                                        struct sk_buff *skb),
3335                                     int *peeked, int *off, int *err);
3336 struct sk_buff *skb_recv_datagram(struct sock *sk, unsigned flags, int noblock,
3337                                   int *err);
3338 unsigned int datagram_poll(struct file *file, struct socket *sock,
3339                            struct poll_table_struct *wait);
3340 int skb_copy_datagram_iter(const struct sk_buff *from, int offset,
3341                            struct iov_iter *to, int size);
3342 static inline int skb_copy_datagram_msg(const struct sk_buff *from, int offset,
3343                                         struct msghdr *msg, int size)
3344 {
3345         return skb_copy_datagram_iter(from, offset, &msg->msg_iter, size);
3346 }
3347 int skb_copy_and_csum_datagram_msg(struct sk_buff *skb, int hlen,
3348                                    struct msghdr *msg);
3349 int skb_copy_datagram_from_iter(struct sk_buff *skb, int offset,
3350                                  struct iov_iter *from, int len);
3351 int zerocopy_sg_from_iter(struct sk_buff *skb, struct iov_iter *frm);
3352 void skb_free_datagram(struct sock *sk, struct sk_buff *skb);
3353 void __skb_free_datagram_locked(struct sock *sk, struct sk_buff *skb, int len);
3354 static inline void skb_free_datagram_locked(struct sock *sk,
3355                                             struct sk_buff *skb)
3356 {
3357         __skb_free_datagram_locked(sk, skb, 0);
3358 }
3359 int skb_kill_datagram(struct sock *sk, struct sk_buff *skb, unsigned int flags);
3360 int skb_copy_bits(const struct sk_buff *skb, int offset, void *to, int len);
3361 int skb_store_bits(struct sk_buff *skb, int offset, const void *from, int len);
3362 __wsum skb_copy_and_csum_bits(const struct sk_buff *skb, int offset, u8 *to,
3363                               int len, __wsum csum);
3364 int skb_splice_bits(struct sk_buff *skb, struct sock *sk, unsigned int offset,
3365                     struct pipe_inode_info *pipe, unsigned int len,
3366                     unsigned int flags);
3367 int skb_send_sock_locked(struct sock *sk, struct sk_buff *skb, int offset,
3368                          int len);
3369 int skb_send_sock(struct sock *sk, struct sk_buff *skb, int offset, int len);
3370 void skb_copy_and_csum_dev(const struct sk_buff *skb, u8 *to);
3371 unsigned int skb_zerocopy_headlen(const struct sk_buff *from);
3372 int skb_zerocopy(struct sk_buff *to, struct sk_buff *from,
3373                  int len, int hlen);
3374 void skb_split(struct sk_buff *skb, struct sk_buff *skb1, const u32 len);
3375 int skb_shift(struct sk_buff *tgt, struct sk_buff *skb, int shiftlen);
3376 void skb_scrub_packet(struct sk_buff *skb, bool xnet);
3377 unsigned int skb_gso_transport_seglen(const struct sk_buff *skb);
3378 bool skb_gso_validate_mtu(const struct sk_buff *skb, unsigned int mtu);
3379 bool skb_gso_validate_mac_len(const struct sk_buff *skb, unsigned int len);
3380 struct sk_buff *skb_segment(struct sk_buff *skb, netdev_features_t features);
3381 struct sk_buff *skb_vlan_untag(struct sk_buff *skb);
3382 int skb_ensure_writable(struct sk_buff *skb, int write_len);
3383 int __skb_vlan_pop(struct sk_buff *skb, u16 *vlan_tci);
3384 int skb_vlan_pop(struct sk_buff *skb);
3385 int skb_vlan_push(struct sk_buff *skb, __be16 vlan_proto, u16 vlan_tci);
3386 struct sk_buff *pskb_extract(struct sk_buff *skb, int off, int to_copy,
3387                              gfp_t gfp);
3388
3389 static inline int memcpy_from_msg(void *data, struct msghdr *msg, int len)
3390 {
3391         return copy_from_iter_full(data, len, &msg->msg_iter) ? 0 : -EFAULT;
3392 }
3393
3394 static inline int memcpy_to_msg(struct msghdr *msg, void *data, int len)
3395 {
3396         return copy_to_iter(data, len, &msg->msg_iter) == len ? 0 : -EFAULT;
3397 }
3398
3399 struct skb_checksum_ops {
3400         __wsum (*update)(const void *mem, int len, __wsum wsum);
3401         __wsum (*combine)(__wsum csum, __wsum csum2, int offset, int len);
3402 };
3403
3404 extern const struct skb_checksum_ops *crc32c_csum_stub __read_mostly;
3405
3406 __wsum __skb_checksum(const struct sk_buff *skb, int offset, int len,
3407                       __wsum csum, const struct skb_checksum_ops *ops);
3408 __wsum skb_checksum(const struct sk_buff *skb, int offset, int len,
3409                     __wsum csum);
3410
3411 static inline void * __must_check
3412 __skb_header_pointer(const struct sk_buff *skb, int offset,
3413                      int len, void *data, int hlen, void *buffer)
3414 {
3415         if (hlen - offset >= len)
3416                 return data + offset;
3417
3418         if (!skb ||
3419             skb_copy_bits(skb, offset, buffer, len) < 0)
3420                 return NULL;
3421
3422         return buffer;
3423 }
3424
3425 static inline void * __must_check
3426 skb_header_pointer(const struct sk_buff *skb, int offset, int len, void *buffer)
3427 {
3428         return __skb_header_pointer(skb, offset, len, skb->data,
3429                                     skb_headlen(skb), buffer);
3430 }
3431
3432 /**
3433  *      skb_needs_linearize - check if we need to linearize a given skb
3434  *                            depending on the given device features.
3435  *      @skb: socket buffer to check
3436  *      @features: net device features
3437  *
3438  *      Returns true if either:
3439  *      1. skb has frag_list and the device doesn't support FRAGLIST, or
3440  *      2. skb is fragmented and the device does not support SG.
3441  */
3442 static inline bool skb_needs_linearize(struct sk_buff *skb,
3443                                        netdev_features_t features)
3444 {
3445         return skb_is_nonlinear(skb) &&
3446                ((skb_has_frag_list(skb) && !(features & NETIF_F_FRAGLIST)) ||
3447                 (skb_shinfo(skb)->nr_frags && !(features & NETIF_F_SG)));
3448 }
3449
3450 static inline void skb_copy_from_linear_data(const struct sk_buff *skb,
3451                                              void *to,
3452                                              const unsigned int len)
3453 {
3454         memcpy(to, skb->data, len);
3455 }
3456
3457 static inline void skb_copy_from_linear_data_offset(const struct sk_buff *skb,
3458                                                     const int offset, void *to,
3459                                                     const unsigned int len)
3460 {
3461         memcpy(to, skb->data + offset, len);
3462 }
3463
3464 static inline void skb_copy_to_linear_data(struct sk_buff *skb,
3465                                            const void *from,
3466                                            const unsigned int len)
3467 {
3468         memcpy(skb->data, from, len);
3469 }
3470
3471 static inline void skb_copy_to_linear_data_offset(struct sk_buff *skb,
3472                                                   const int offset,
3473                                                   const void *from,
3474                                                   const unsigned int len)
3475 {
3476         memcpy(skb->data + offset, from, len);
3477 }
3478
3479 void skb_init(void);
3480
3481 static inline ktime_t skb_get_ktime(const struct sk_buff *skb)
3482 {
3483         return skb->tstamp;
3484 }
3485
3486 /**
3487  *      skb_get_timestamp - get timestamp from a skb
3488  *      @skb: skb to get stamp from
3489  *      @stamp: pointer to struct timeval to store stamp in
3490  *
3491  *      Timestamps are stored in the skb as offsets to a base timestamp.
3492  *      This function converts the offset back to a struct timeval and stores
3493  *      it in stamp.
3494  */
3495 static inline void skb_get_timestamp(const struct sk_buff *skb,
3496                                      struct timeval *stamp)
3497 {
3498         *stamp = ktime_to_timeval(skb->tstamp);
3499 }
3500
3501 static inline void skb_get_timestampns(const struct sk_buff *skb,
3502                                        struct timespec *stamp)
3503 {
3504         *stamp = ktime_to_timespec(skb->tstamp);
3505 }
3506
3507 static inline void __net_timestamp(struct sk_buff *skb)
3508 {
3509         skb->tstamp = ktime_get_real();
3510 }
3511
3512 static inline ktime_t net_timedelta(ktime_t t)
3513 {
3514         return ktime_sub(ktime_get_real(), t);
3515 }
3516
3517 static inline ktime_t net_invalid_timestamp(void)
3518 {
3519         return 0;
3520 }
3521
3522 struct sk_buff *skb_clone_sk(struct sk_buff *skb);
3523
3524 #ifdef CONFIG_NETWORK_PHY_TIMESTAMPING
3525
3526 void skb_clone_tx_timestamp(struct sk_buff *skb);
3527 bool skb_defer_rx_timestamp(struct sk_buff *skb);
3528
3529 #else /* CONFIG_NETWORK_PHY_TIMESTAMPING */
3530
3531 static inline void skb_clone_tx_timestamp(struct sk_buff *skb)
3532 {
3533 }
3534
3535 static inline bool skb_defer_rx_timestamp(struct sk_buff *skb)
3536 {
3537         return false;
3538 }
3539
3540 #endif /* !CONFIG_NETWORK_PHY_TIMESTAMPING */
3541
3542 /**
3543  * skb_complete_tx_timestamp() - deliver cloned skb with tx timestamps
3544  *
3545  * PHY drivers may accept clones of transmitted packets for
3546  * timestamping via their phy_driver.txtstamp method. These drivers
3547  * must call this function to return the skb back to the stack with a
3548  * timestamp.
3549  *
3550  * @skb: clone of the the original outgoing packet
3551  * @hwtstamps: hardware time stamps
3552  *
3553  */
3554 void skb_complete_tx_timestamp(struct sk_buff *skb,
3555                                struct skb_shared_hwtstamps *hwtstamps);
3556
3557 void __skb_tstamp_tx(struct sk_buff *orig_skb,
3558                      struct skb_shared_hwtstamps *hwtstamps,
3559                      struct sock *sk, int tstype);
3560
3561 /**
3562  * skb_tstamp_tx - queue clone of skb with send time stamps
3563  * @orig_skb:   the original outgoing packet
3564  * @hwtstamps:  hardware time stamps, may be NULL if not available
3565  *
3566  * If the skb has a socket associated, then this function clones the
3567  * skb (thus sharing the actual data and optional structures), stores
3568  * the optional hardware time stamping information (if non NULL) or
3569  * generates a software time stamp (otherwise), then queues the clone
3570  * to the error queue of the socket.  Errors are silently ignored.
3571  */
3572 void skb_tstamp_tx(struct sk_buff *orig_skb,
3573                    struct skb_shared_hwtstamps *hwtstamps);
3574
3575 /**
3576  * skb_tx_timestamp() - Driver hook for transmit timestamping
3577  *
3578  * Ethernet MAC Drivers should call this function in their hard_xmit()
3579  * function immediately before giving the sk_buff to the MAC hardware.
3580  *
3581  * Specifically, one should make absolutely sure that this function is
3582  * called before TX completion of this packet can trigger.  Otherwise
3583  * the packet could potentially already be freed.
3584  *
3585  * @skb: A socket buffer.
3586  */
3587 static inline void skb_tx_timestamp(struct sk_buff *skb)
3588 {
3589         skb_clone_tx_timestamp(skb);
3590         if (skb_shinfo(skb)->tx_flags & SKBTX_SW_TSTAMP)
3591                 skb_tstamp_tx(skb, NULL);
3592 }
3593
3594 /**
3595  * skb_complete_wifi_ack - deliver skb with wifi status
3596  *
3597  * @skb: the original outgoing packet
3598  * @acked: ack status
3599  *
3600  */
3601 void skb_complete_wifi_ack(struct sk_buff *skb, bool acked);
3602
3603 __sum16 __skb_checksum_complete_head(struct sk_buff *skb, int len);
3604 __sum16 __skb_checksum_complete(struct sk_buff *skb);
3605
3606 static inline int skb_csum_unnecessary(const struct sk_buff *skb)
3607 {
3608         return ((skb->ip_summed == CHECKSUM_UNNECESSARY) ||
3609                 skb->csum_valid ||
3610                 (skb->ip_summed == CHECKSUM_PARTIAL &&
3611                  skb_checksum_start_offset(skb) >= 0));
3612 }
3613
3614 /**
3615  *      skb_checksum_complete - Calculate checksum of an entire packet
3616  *      @skb: packet to process
3617  *
3618  *      This function calculates the checksum over the entire packet plus
3619  *      the value of skb->csum.  The latter can be used to supply the
3620  *      checksum of a pseudo header as used by TCP/UDP.  It returns the
3621  *      checksum.
3622  *
3623  *      For protocols that contain complete checksums such as ICMP/TCP/UDP,
3624  *      this function can be used to verify that checksum on received
3625  *      packets.  In that case the function should return zero if the
3626  *      checksum is correct.  In particular, this function will return zero
3627  *      if skb->ip_summed is CHECKSUM_UNNECESSARY which indicates that the
3628  *      hardware has already verified the correctness of the checksum.
3629  */
3630 static inline __sum16 skb_checksum_complete(struct sk_buff *skb)
3631 {
3632         return skb_csum_unnecessary(skb) ?
3633                0 : __skb_checksum_complete(skb);
3634 }
3635
3636 static inline void __skb_decr_checksum_unnecessary(struct sk_buff *skb)
3637 {
3638         if (skb->ip_summed == CHECKSUM_UNNECESSARY) {
3639                 if (skb->csum_level == 0)
3640                         skb->ip_summed = CHECKSUM_NONE;
3641                 else
3642                         skb->csum_level--;
3643         }
3644 }
3645
3646 static inline void __skb_incr_checksum_unnecessary(struct sk_buff *skb)
3647 {
3648         if (skb->ip_summed == CHECKSUM_UNNECESSARY) {
3649                 if (skb->csum_level < SKB_MAX_CSUM_LEVEL)
3650                         skb->csum_level++;
3651         } else if (skb->ip_summed == CHECKSUM_NONE) {
3652                 skb->ip_summed = CHECKSUM_UNNECESSARY;
3653                 skb->csum_level = 0;
3654         }
3655 }
3656
3657 /* Check if we need to perform checksum complete validation.
3658  *
3659  * Returns true if checksum complete is needed, false otherwise
3660  * (either checksum is unnecessary or zero checksum is allowed).
3661  */
3662 static inline bool __skb_checksum_validate_needed(struct sk_buff *skb,
3663                                                   bool zero_okay,
3664                                                   __sum16 check)
3665 {
3666         if (skb_csum_unnecessary(skb) || (zero_okay && !check)) {
3667                 skb->csum_valid = 1;
3668                 __skb_decr_checksum_unnecessary(skb);
3669                 return false;
3670         }
3671
3672         return true;
3673 }
3674
3675 /* For small packets <= CHECKSUM_BREAK peform checksum complete directly
3676  * in checksum_init.
3677  */
3678 #define CHECKSUM_BREAK 76
3679
3680 /* Unset checksum-complete
3681  *
3682  * Unset checksum complete can be done when packet is being modified
3683  * (uncompressed for instance) and checksum-complete value is
3684  * invalidated.
3685  */
3686 static inline void skb_checksum_complete_unset(struct sk_buff *skb)
3687 {
3688         if (skb->ip_summed == CHECKSUM_COMPLETE)
3689                 skb->ip_summed = CHECKSUM_NONE;
3690 }
3691
3692 /* Validate (init) checksum based on checksum complete.
3693  *
3694  * Return values:
3695  *   0: checksum is validated or try to in skb_checksum_complete. In the latter
3696  *      case the ip_summed will not be CHECKSUM_UNNECESSARY and the pseudo
3697  *      checksum is stored in skb->csum for use in __skb_checksum_complete
3698  *   non-zero: value of invalid checksum
3699  *
3700  */
3701 static inline __sum16 __skb_checksum_validate_complete(struct sk_buff *skb,
3702                                                        bool complete,
3703                                                        __wsum psum)
3704 {
3705         if (skb->ip_summed == CHECKSUM_COMPLETE) {
3706                 if (!csum_fold(csum_add(psum, skb->csum))) {
3707                         skb->csum_valid = 1;
3708                         return 0;
3709                 }
3710         }
3711
3712         skb->csum = psum;
3713
3714         if (complete || skb->len <= CHECKSUM_BREAK) {
3715                 __sum16 csum;
3716
3717                 csum = __skb_checksum_complete(skb);
3718                 skb->csum_valid = !csum;
3719                 return csum;
3720         }
3721
3722         return 0;
3723 }
3724
3725 static inline __wsum null_compute_pseudo(struct sk_buff *skb, int proto)
3726 {
3727         return 0;
3728 }
3729
3730 /* Perform checksum validate (init). Note that this is a macro since we only
3731  * want to calculate the pseudo header which is an input function if necessary.
3732  * First we try to validate without any computation (checksum unnecessary) and
3733  * then calculate based on checksum complete calling the function to compute
3734  * pseudo header.
3735  *
3736  * Return values:
3737  *   0: checksum is validated or try to in skb_checksum_complete
3738  *   non-zero: value of invalid checksum
3739  */
3740 #define __skb_checksum_validate(skb, proto, complete,                   \
3741                                 zero_okay, check, compute_pseudo)       \
3742 ({                                                                      \
3743         __sum16 __ret = 0;                                              \
3744         skb->csum_valid = 0;                                            \
3745         if (__skb_checksum_validate_needed(skb, zero_okay, check))      \
3746                 __ret = __skb_checksum_validate_complete(skb,           \
3747                                 complete, compute_pseudo(skb, proto));  \
3748         __ret;                                                          \
3749 })
3750
3751 #define skb_checksum_init(skb, proto, compute_pseudo)                   \
3752         __skb_checksum_validate(skb, proto, false, false, 0, compute_pseudo)
3753
3754 #define skb_checksum_init_zero_check(skb, proto, check, compute_pseudo) \
3755         __skb_checksum_validate(skb, proto, false, true, check, compute_pseudo)
3756
3757 #define skb_checksum_validate(skb, proto, compute_pseudo)               \
3758         __skb_checksum_validate(skb, proto, true, false, 0, compute_pseudo)
3759
3760 #define skb_checksum_validate_zero_check(skb, proto, check,             \
3761                                          compute_pseudo)                \
3762         __skb_checksum_validate(skb, proto, true, true, check, compute_pseudo)
3763
3764 #define skb_checksum_simple_validate(skb)                               \
3765         __skb_checksum_validate(skb, 0, true, false, 0, null_compute_pseudo)
3766
3767 static inline bool __skb_checksum_convert_check(struct sk_buff *skb)
3768 {
3769         return (skb->ip_summed == CHECKSUM_NONE && skb->csum_valid);
3770 }
3771
3772 static inline void __skb_checksum_convert(struct sk_buff *skb,
3773                                           __sum16 check, __wsum pseudo)
3774 {
3775         skb->csum = ~pseudo;
3776         skb->ip_summed = CHECKSUM_COMPLETE;
3777 }
3778
3779 #define skb_checksum_try_convert(skb, proto, check, compute_pseudo)     \
3780 do {                                                                    \
3781         if (__skb_checksum_convert_check(skb))                          \
3782                 __skb_checksum_convert(skb, check,                      \
3783                                        compute_pseudo(skb, proto));     \
3784 } while (0)
3785
3786 static inline void skb_remcsum_adjust_partial(struct sk_buff *skb, void *ptr,
3787                                               u16 start, u16 offset)
3788 {
3789         skb->ip_summed = CHECKSUM_PARTIAL;
3790         skb->csum_start = ((unsigned char *)ptr + start) - skb->head;
3791         skb->csum_offset = offset - start;
3792 }
3793
3794 /* Update skbuf and packet to reflect the remote checksum offload operation.
3795  * When called, ptr indicates the starting point for skb->csum when
3796  * ip_summed is CHECKSUM_COMPLETE. If we need create checksum complete
3797  * here, skb_postpull_rcsum is done so skb->csum start is ptr.
3798  */
3799 static inline void skb_remcsum_process(struct sk_buff *skb, void *ptr,
3800                                        int start, int offset, bool nopartial)
3801 {
3802         __wsum delta;
3803
3804         if (!nopartial) {
3805                 skb_remcsum_adjust_partial(skb, ptr, start, offset);
3806                 return;
3807         }
3808
3809          if (unlikely(skb->ip_summed != CHECKSUM_COMPLETE)) {
3810                 __skb_checksum_complete(skb);
3811                 skb_postpull_rcsum(skb, skb->data, ptr - (void *)skb->data);
3812         }
3813
3814         delta = remcsum_adjust(ptr, skb->csum, start, offset);
3815
3816         /* Adjust skb->csum since we changed the packet */
3817         skb->csum = csum_add(skb->csum, delta);
3818 }
3819
3820 static inline struct nf_conntrack *skb_nfct(const struct sk_buff *skb)
3821 {
3822 #if IS_ENABLED(CONFIG_NF_CONNTRACK)
3823         return (void *)(skb->_nfct & SKB_NFCT_PTRMASK);
3824 #else
3825         return NULL;
3826 #endif
3827 }
3828
3829 #if defined(CONFIG_NF_CONNTRACK) || defined(CONFIG_NF_CONNTRACK_MODULE)
3830 void nf_conntrack_destroy(struct nf_conntrack *nfct);
3831 static inline void nf_conntrack_put(struct nf_conntrack *nfct)
3832 {
3833         if (nfct && atomic_dec_and_test(&nfct->use))
3834                 nf_conntrack_destroy(nfct);
3835 }
3836 static inline void nf_conntrack_get(struct nf_conntrack *nfct)
3837 {
3838         if (nfct)
3839                 atomic_inc(&nfct->use);
3840 }
3841 #endif
3842 #if IS_ENABLED(CONFIG_BRIDGE_NETFILTER)
3843 static inline void nf_bridge_put(struct nf_bridge_info *nf_bridge)
3844 {
3845         if (nf_bridge && refcount_dec_and_test(&nf_bridge->use))
3846                 kfree(nf_bridge);
3847 }
3848 static inline void nf_bridge_get(struct nf_bridge_info *nf_bridge)
3849 {
3850         if (nf_bridge)
3851                 refcount_inc(&nf_bridge->use);
3852 }
3853 #endif /* CONFIG_BRIDGE_NETFILTER */
3854 static inline void nf_reset(struct sk_buff *skb)
3855 {
3856 #if defined(CONFIG_NF_CONNTRACK) || defined(CONFIG_NF_CONNTRACK_MODULE)
3857         nf_conntrack_put(skb_nfct(skb));
3858         skb->_nfct = 0;
3859 #endif
3860 #if IS_ENABLED(CONFIG_BRIDGE_NETFILTER)
3861         nf_bridge_put(skb->nf_bridge);
3862         skb->nf_bridge = NULL;
3863 #endif
3864 }
3865
3866 static inline void nf_reset_trace(struct sk_buff *skb)
3867 {
3868 #if IS_ENABLED(CONFIG_NETFILTER_XT_TARGET_TRACE) || defined(CONFIG_NF_TABLES)
3869         skb->nf_trace = 0;
3870 #endif
3871 }
3872
3873 static inline void ipvs_reset(struct sk_buff *skb)
3874 {
3875 #if IS_ENABLED(CONFIG_IP_VS)
3876         skb->ipvs_property = 0;
3877 #endif
3878 }
3879
3880 /* Note: This doesn't put any conntrack and bridge info in dst. */
3881 static inline void __nf_copy(struct sk_buff *dst, const struct sk_buff *src,
3882                              bool copy)
3883 {
3884 #if defined(CONFIG_NF_CONNTRACK) || defined(CONFIG_NF_CONNTRACK_MODULE)
3885         dst->_nfct = src->_nfct;
3886         nf_conntrack_get(skb_nfct(src));
3887 #endif
3888 #if IS_ENABLED(CONFIG_BRIDGE_NETFILTER)
3889         dst->nf_bridge  = src->nf_bridge;
3890         nf_bridge_get(src->nf_bridge);
3891 #endif
3892 #if IS_ENABLED(CONFIG_NETFILTER_XT_TARGET_TRACE) || defined(CONFIG_NF_TABLES)
3893         if (copy)
3894                 dst->nf_trace = src->nf_trace;
3895 #endif
3896 }
3897
3898 static inline void nf_copy(struct sk_buff *dst, const struct sk_buff *src)
3899 {
3900 #if defined(CONFIG_NF_CONNTRACK) || defined(CONFIG_NF_CONNTRACK_MODULE)
3901         nf_conntrack_put(skb_nfct(dst));
3902 #endif
3903 #if IS_ENABLED(CONFIG_BRIDGE_NETFILTER)
3904         nf_bridge_put(dst->nf_bridge);
3905 #endif
3906         __nf_copy(dst, src, true);
3907 }
3908
3909 #ifdef CONFIG_NETWORK_SECMARK
3910 static inline void skb_copy_secmark(struct sk_buff *to, const struct sk_buff *from)
3911 {
3912         to->secmark = from->secmark;
3913 }
3914
3915 static inline void skb_init_secmark(struct sk_buff *skb)
3916 {
3917         skb->secmark = 0;
3918 }
3919 #else
3920 static inline void skb_copy_secmark(struct sk_buff *to, const struct sk_buff *from)
3921 { }
3922
3923 static inline void skb_init_secmark(struct sk_buff *skb)
3924 { }
3925 #endif
3926
3927 static inline bool skb_irq_freeable(const struct sk_buff *skb)
3928 {
3929         return !skb->destructor &&
3930 #if IS_ENABLED(CONFIG_XFRM)
3931                 !skb->sp &&
3932 #endif
3933                 !skb_nfct(skb) &&
3934                 !skb->_skb_refdst &&
3935                 !skb_has_frag_list(skb);
3936 }
3937
3938 static inline void skb_set_queue_mapping(struct sk_buff *skb, u16 queue_mapping)
3939 {
3940         skb->queue_mapping = queue_mapping;
3941 }
3942
3943 static inline u16 skb_get_queue_mapping(const struct sk_buff *skb)
3944 {
3945         return skb->queue_mapping;
3946 }
3947
3948 static inline void skb_copy_queue_mapping(struct sk_buff *to, const struct sk_buff *from)
3949 {
3950         to->queue_mapping = from->queue_mapping;
3951 }
3952
3953 static inline void skb_record_rx_queue(struct sk_buff *skb, u16 rx_queue)
3954 {
3955         skb->queue_mapping = rx_queue + 1;
3956 }
3957
3958 static inline u16 skb_get_rx_queue(const struct sk_buff *skb)
3959 {
3960         return skb->queue_mapping - 1;
3961 }
3962
3963 static inline bool skb_rx_queue_recorded(const struct sk_buff *skb)
3964 {
3965         return skb->queue_mapping != 0;
3966 }
3967
3968 static inline void skb_set_dst_pending_confirm(struct sk_buff *skb, u32 val)
3969 {
3970         skb->dst_pending_confirm = val;
3971 }
3972
3973 static inline bool skb_get_dst_pending_confirm(const struct sk_buff *skb)
3974 {
3975         return skb->dst_pending_confirm != 0;
3976 }
3977
3978 static inline struct sec_path *skb_sec_path(struct sk_buff *skb)
3979 {
3980 #ifdef CONFIG_XFRM
3981         return skb->sp;
3982 #else
3983         return NULL;
3984 #endif
3985 }
3986
3987 /* Keeps track of mac header offset relative to skb->head.
3988  * It is useful for TSO of Tunneling protocol. e.g. GRE.
3989  * For non-tunnel skb it points to skb_mac_header() and for
3990  * tunnel skb it points to outer mac header.
3991  * Keeps track of level of encapsulation of network headers.
3992  */
3993 struct skb_gso_cb {
3994         union {
3995                 int     mac_offset;
3996                 int     data_offset;
3997         };
3998         int     encap_level;
3999         __wsum  csum;
4000         __u16   csum_start;
4001 };
4002 #define SKB_SGO_CB_OFFSET       32
4003 #define SKB_GSO_CB(skb) ((struct skb_gso_cb *)((skb)->cb + SKB_SGO_CB_OFFSET))
4004
4005 static inline int skb_tnl_header_len(const struct sk_buff *inner_skb)
4006 {
4007         return (skb_mac_header(inner_skb) - inner_skb->head) -
4008                 SKB_GSO_CB(inner_skb)->mac_offset;
4009 }
4010
4011 static inline int gso_pskb_expand_head(struct sk_buff *skb, int extra)
4012 {
4013         int new_headroom, headroom;
4014         int ret;
4015
4016         headroom = skb_headroom(skb);
4017         ret = pskb_expand_head(skb, extra, 0, GFP_ATOMIC);
4018         if (ret)
4019                 return ret;
4020
4021         new_headroom = skb_headroom(skb);
4022         SKB_GSO_CB(skb)->mac_offset += (new_headroom - headroom);
4023         return 0;
4024 }
4025
4026 static inline void gso_reset_checksum(struct sk_buff *skb, __wsum res)
4027 {
4028         /* Do not update partial checksums if remote checksum is enabled. */
4029         if (skb->remcsum_offload)
4030                 return;
4031
4032         SKB_GSO_CB(skb)->csum = res;
4033         SKB_GSO_CB(skb)->csum_start = skb_checksum_start(skb) - skb->head;
4034 }
4035
4036 /* Compute the checksum for a gso segment. First compute the checksum value
4037  * from the start of transport header to SKB_GSO_CB(skb)->csum_start, and
4038  * then add in skb->csum (checksum from csum_start to end of packet).
4039  * skb->csum and csum_start are then updated to reflect the checksum of the
4040  * resultant packet starting from the transport header-- the resultant checksum
4041  * is in the res argument (i.e. normally zero or ~ of checksum of a pseudo
4042  * header.
4043  */
4044 static inline __sum16 gso_make_checksum(struct sk_buff *skb, __wsum res)
4045 {
4046         unsigned char *csum_start = skb_transport_header(skb);
4047         int plen = (skb->head + SKB_GSO_CB(skb)->csum_start) - csum_start;
4048         __wsum partial = SKB_GSO_CB(skb)->csum;
4049
4050         SKB_GSO_CB(skb)->csum = res;
4051         SKB_GSO_CB(skb)->csum_start = csum_start - skb->head;
4052
4053         return csum_fold(csum_partial(csum_start, plen, partial));
4054 }
4055
4056 static inline bool skb_is_gso(const struct sk_buff *skb)
4057 {
4058         return skb_shinfo(skb)->gso_size;
4059 }
4060
4061 /* Note: Should be called only if skb_is_gso(skb) is true */
4062 static inline bool skb_is_gso_v6(const struct sk_buff *skb)
4063 {
4064         return skb_shinfo(skb)->gso_type & SKB_GSO_TCPV6;
4065 }
4066
4067 static inline void skb_gso_reset(struct sk_buff *skb)
4068 {
4069         skb_shinfo(skb)->gso_size = 0;
4070         skb_shinfo(skb)->gso_segs = 0;
4071         skb_shinfo(skb)->gso_type = 0;
4072 }
4073
4074 void __skb_warn_lro_forwarding(const struct sk_buff *skb);
4075
4076 static inline bool skb_warn_if_lro(const struct sk_buff *skb)
4077 {
4078         /* LRO sets gso_size but not gso_type, whereas if GSO is really
4079          * wanted then gso_type will be set. */
4080         const struct skb_shared_info *shinfo = skb_shinfo(skb);
4081
4082         if (skb_is_nonlinear(skb) && shinfo->gso_size != 0 &&
4083             unlikely(shinfo->gso_type == 0)) {
4084                 __skb_warn_lro_forwarding(skb);
4085                 return true;
4086         }
4087         return false;
4088 }
4089
4090 static inline void skb_forward_csum(struct sk_buff *skb)
4091 {
4092         /* Unfortunately we don't support this one.  Any brave souls? */
4093         if (skb->ip_summed == CHECKSUM_COMPLETE)
4094                 skb->ip_summed = CHECKSUM_NONE;
4095 }
4096
4097 /**
4098  * skb_checksum_none_assert - make sure skb ip_summed is CHECKSUM_NONE
4099  * @skb: skb to check
4100  *
4101  * fresh skbs have their ip_summed set to CHECKSUM_NONE.
4102  * Instead of forcing ip_summed to CHECKSUM_NONE, we can
4103  * use this helper, to document places where we make this assertion.
4104  */
4105 static inline void skb_checksum_none_assert(const struct sk_buff *skb)
4106 {
4107 #ifdef DEBUG
4108         BUG_ON(skb->ip_summed != CHECKSUM_NONE);
4109 #endif
4110 }
4111
4112 bool skb_partial_csum_set(struct sk_buff *skb, u16 start, u16 off);
4113
4114 int skb_checksum_setup(struct sk_buff *skb, bool recalculate);
4115 struct sk_buff *skb_checksum_trimmed(struct sk_buff *skb,
4116                                      unsigned int transport_len,
4117                                      __sum16(*skb_chkf)(struct sk_buff *skb));
4118
4119 /**
4120  * skb_head_is_locked - Determine if the skb->head is locked down
4121  * @skb: skb to check
4122  *
4123  * The head on skbs build around a head frag can be removed if they are
4124  * not cloned.  This function returns true if the skb head is locked down
4125  * due to either being allocated via kmalloc, or by being a clone with
4126  * multiple references to the head.
4127  */
4128 static inline bool skb_head_is_locked(const struct sk_buff *skb)
4129 {
4130         return !skb->head_frag || skb_cloned(skb);
4131 }
4132
4133 /**
4134  * skb_gso_network_seglen - Return length of individual segments of a gso packet
4135  *
4136  * @skb: GSO skb
4137  *
4138  * skb_gso_network_seglen is used to determine the real size of the
4139  * individual segments, including Layer3 (IP, IPv6) and L4 headers (TCP/UDP).
4140  *
4141  * The MAC/L2 header is not accounted for.
4142  */
4143 static inline unsigned int skb_gso_network_seglen(const struct sk_buff *skb)
4144 {
4145         unsigned int hdr_len = skb_transport_header(skb) -
4146                                skb_network_header(skb);
4147         return hdr_len + skb_gso_transport_seglen(skb);
4148 }
4149
4150 /**
4151  * skb_gso_mac_seglen - Return length of individual segments of a gso packet
4152  *
4153  * @skb: GSO skb
4154  *
4155  * skb_gso_mac_seglen is used to determine the real size of the
4156  * individual segments, including MAC/L2, Layer3 (IP, IPv6) and L4
4157  * headers (TCP/UDP).
4158  */
4159 static inline unsigned int skb_gso_mac_seglen(const struct sk_buff *skb)
4160 {
4161         unsigned int hdr_len = skb_transport_header(skb) - skb_mac_header(skb);
4162         return hdr_len + skb_gso_transport_seglen(skb);
4163 }
4164
4165 /* Local Checksum Offload.
4166  * Compute outer checksum based on the assumption that the
4167  * inner checksum will be offloaded later.
4168  * See Documentation/networking/checksum-offloads.txt for
4169  * explanation of how this works.
4170  * Fill in outer checksum adjustment (e.g. with sum of outer
4171  * pseudo-header) before calling.
4172  * Also ensure that inner checksum is in linear data area.
4173  */
4174 static inline __wsum lco_csum(struct sk_buff *skb)
4175 {
4176         unsigned char *csum_start = skb_checksum_start(skb);
4177         unsigned char *l4_hdr = skb_transport_header(skb);
4178         __wsum partial;
4179
4180         /* Start with complement of inner checksum adjustment */
4181         partial = ~csum_unfold(*(__force __sum16 *)(csum_start +
4182                                                     skb->csum_offset));
4183
4184         /* Add in checksum of our headers (incl. outer checksum
4185          * adjustment filled in by caller) and return result.
4186          */
4187         return csum_partial(l4_hdr, csum_start - l4_hdr, partial);
4188 }
4189
4190 #endif  /* __KERNEL__ */
4191 #endif  /* _LINUX_SKBUFF_H */