GNU Linux-libre 4.14.328-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 void skb_copy_header(struct sk_buff *new, const struct sk_buff *old);
1029 struct sk_buff *skb_copy(const struct sk_buff *skb, gfp_t priority);
1030 struct sk_buff *__pskb_copy_fclone(struct sk_buff *skb, int headroom,
1031                                    gfp_t gfp_mask, bool fclone);
1032 static inline struct sk_buff *__pskb_copy(struct sk_buff *skb, int headroom,
1033                                           gfp_t gfp_mask)
1034 {
1035         return __pskb_copy_fclone(skb, headroom, gfp_mask, false);
1036 }
1037
1038 int pskb_expand_head(struct sk_buff *skb, int nhead, int ntail, gfp_t gfp_mask);
1039 struct sk_buff *skb_realloc_headroom(struct sk_buff *skb,
1040                                      unsigned int headroom);
1041 struct sk_buff *skb_copy_expand(const struct sk_buff *skb, int newheadroom,
1042                                 int newtailroom, gfp_t priority);
1043 int __must_check skb_to_sgvec_nomark(struct sk_buff *skb, struct scatterlist *sg,
1044                                      int offset, int len);
1045 int __must_check skb_to_sgvec(struct sk_buff *skb, struct scatterlist *sg,
1046                               int offset, int len);
1047 int skb_cow_data(struct sk_buff *skb, int tailbits, struct sk_buff **trailer);
1048 int __skb_pad(struct sk_buff *skb, int pad, bool free_on_error);
1049
1050 /**
1051  *      skb_pad                 -       zero pad the tail of an skb
1052  *      @skb: buffer to pad
1053  *      @pad: space to pad
1054  *
1055  *      Ensure that a buffer is followed by a padding area that is zero
1056  *      filled. Used by network drivers which may DMA or transfer data
1057  *      beyond the buffer end onto the wire.
1058  *
1059  *      May return error in out of memory cases. The skb is freed on error.
1060  */
1061 static inline int skb_pad(struct sk_buff *skb, int pad)
1062 {
1063         return __skb_pad(skb, pad, true);
1064 }
1065 #define dev_kfree_skb(a)        consume_skb(a)
1066
1067 int skb_append_datato_frags(struct sock *sk, struct sk_buff *skb,
1068                             int getfrag(void *from, char *to, int offset,
1069                                         int len, int odd, struct sk_buff *skb),
1070                             void *from, int length);
1071
1072 int skb_append_pagefrags(struct sk_buff *skb, struct page *page,
1073                          int offset, size_t size);
1074
1075 struct skb_seq_state {
1076         __u32           lower_offset;
1077         __u32           upper_offset;
1078         __u32           frag_idx;
1079         __u32           stepped_offset;
1080         struct sk_buff  *root_skb;
1081         struct sk_buff  *cur_skb;
1082         __u8            *frag_data;
1083 };
1084
1085 void skb_prepare_seq_read(struct sk_buff *skb, unsigned int from,
1086                           unsigned int to, struct skb_seq_state *st);
1087 unsigned int skb_seq_read(unsigned int consumed, const u8 **data,
1088                           struct skb_seq_state *st);
1089 void skb_abort_seq_read(struct skb_seq_state *st);
1090
1091 unsigned int skb_find_text(struct sk_buff *skb, unsigned int from,
1092                            unsigned int to, struct ts_config *config);
1093
1094 /*
1095  * Packet hash types specify the type of hash in skb_set_hash.
1096  *
1097  * Hash types refer to the protocol layer addresses which are used to
1098  * construct a packet's hash. The hashes are used to differentiate or identify
1099  * flows of the protocol layer for the hash type. Hash types are either
1100  * layer-2 (L2), layer-3 (L3), or layer-4 (L4).
1101  *
1102  * Properties of hashes:
1103  *
1104  * 1) Two packets in different flows have different hash values
1105  * 2) Two packets in the same flow should have the same hash value
1106  *
1107  * A hash at a higher layer is considered to be more specific. A driver should
1108  * set the most specific hash possible.
1109  *
1110  * A driver cannot indicate a more specific hash than the layer at which a hash
1111  * was computed. For instance an L3 hash cannot be set as an L4 hash.
1112  *
1113  * A driver may indicate a hash level which is less specific than the
1114  * actual layer the hash was computed on. For instance, a hash computed
1115  * at L4 may be considered an L3 hash. This should only be done if the
1116  * driver can't unambiguously determine that the HW computed the hash at
1117  * the higher layer. Note that the "should" in the second property above
1118  * permits this.
1119  */
1120 enum pkt_hash_types {
1121         PKT_HASH_TYPE_NONE,     /* Undefined type */
1122         PKT_HASH_TYPE_L2,       /* Input: src_MAC, dest_MAC */
1123         PKT_HASH_TYPE_L3,       /* Input: src_IP, dst_IP */
1124         PKT_HASH_TYPE_L4,       /* Input: src_IP, dst_IP, src_port, dst_port */
1125 };
1126
1127 static inline void skb_clear_hash(struct sk_buff *skb)
1128 {
1129         skb->hash = 0;
1130         skb->sw_hash = 0;
1131         skb->l4_hash = 0;
1132 }
1133
1134 static inline void skb_clear_hash_if_not_l4(struct sk_buff *skb)
1135 {
1136         if (!skb->l4_hash)
1137                 skb_clear_hash(skb);
1138 }
1139
1140 static inline void
1141 __skb_set_hash(struct sk_buff *skb, __u32 hash, bool is_sw, bool is_l4)
1142 {
1143         skb->l4_hash = is_l4;
1144         skb->sw_hash = is_sw;
1145         skb->hash = hash;
1146 }
1147
1148 static inline void
1149 skb_set_hash(struct sk_buff *skb, __u32 hash, enum pkt_hash_types type)
1150 {
1151         /* Used by drivers to set hash from HW */
1152         __skb_set_hash(skb, hash, false, type == PKT_HASH_TYPE_L4);
1153 }
1154
1155 static inline void
1156 __skb_set_sw_hash(struct sk_buff *skb, __u32 hash, bool is_l4)
1157 {
1158         __skb_set_hash(skb, hash, true, is_l4);
1159 }
1160
1161 void __skb_get_hash(struct sk_buff *skb);
1162 u32 __skb_get_hash_symmetric(const struct sk_buff *skb);
1163 u32 skb_get_poff(const struct sk_buff *skb);
1164 u32 __skb_get_poff(const struct sk_buff *skb, void *data,
1165                    const struct flow_keys *keys, int hlen);
1166 __be32 __skb_flow_get_ports(const struct sk_buff *skb, int thoff, u8 ip_proto,
1167                             void *data, int hlen_proto);
1168
1169 static inline __be32 skb_flow_get_ports(const struct sk_buff *skb,
1170                                         int thoff, u8 ip_proto)
1171 {
1172         return __skb_flow_get_ports(skb, thoff, ip_proto, NULL, 0);
1173 }
1174
1175 void skb_flow_dissector_init(struct flow_dissector *flow_dissector,
1176                              const struct flow_dissector_key *key,
1177                              unsigned int key_count);
1178
1179 bool __skb_flow_dissect(const struct sk_buff *skb,
1180                         struct flow_dissector *flow_dissector,
1181                         void *target_container,
1182                         void *data, __be16 proto, int nhoff, int hlen,
1183                         unsigned int flags);
1184
1185 static inline bool skb_flow_dissect(const struct sk_buff *skb,
1186                                     struct flow_dissector *flow_dissector,
1187                                     void *target_container, unsigned int flags)
1188 {
1189         return __skb_flow_dissect(skb, flow_dissector, target_container,
1190                                   NULL, 0, 0, 0, flags);
1191 }
1192
1193 static inline bool skb_flow_dissect_flow_keys(const struct sk_buff *skb,
1194                                               struct flow_keys *flow,
1195                                               unsigned int flags)
1196 {
1197         memset(flow, 0, sizeof(*flow));
1198         return __skb_flow_dissect(skb, &flow_keys_dissector, flow,
1199                                   NULL, 0, 0, 0, flags);
1200 }
1201
1202 static inline bool skb_flow_dissect_flow_keys_buf(struct flow_keys *flow,
1203                                                   void *data, __be16 proto,
1204                                                   int nhoff, int hlen,
1205                                                   unsigned int flags)
1206 {
1207         memset(flow, 0, sizeof(*flow));
1208         return __skb_flow_dissect(NULL, &flow_keys_buf_dissector, flow,
1209                                   data, proto, nhoff, hlen, flags);
1210 }
1211
1212 static inline __u32 skb_get_hash(struct sk_buff *skb)
1213 {
1214         if (!skb->l4_hash && !skb->sw_hash)
1215                 __skb_get_hash(skb);
1216
1217         return skb->hash;
1218 }
1219
1220 static inline __u32 skb_get_hash_flowi6(struct sk_buff *skb, const struct flowi6 *fl6)
1221 {
1222         if (!skb->l4_hash && !skb->sw_hash) {
1223                 struct flow_keys keys;
1224                 __u32 hash = __get_hash_from_flowi6(fl6, &keys);
1225
1226                 __skb_set_sw_hash(skb, hash, flow_keys_have_l4(&keys));
1227         }
1228
1229         return skb->hash;
1230 }
1231
1232 __u32 skb_get_hash_perturb(const struct sk_buff *skb,
1233                            const siphash_key_t *perturb);
1234
1235 static inline __u32 skb_get_hash_raw(const struct sk_buff *skb)
1236 {
1237         return skb->hash;
1238 }
1239
1240 static inline void skb_copy_hash(struct sk_buff *to, const struct sk_buff *from)
1241 {
1242         to->hash = from->hash;
1243         to->sw_hash = from->sw_hash;
1244         to->l4_hash = from->l4_hash;
1245 };
1246
1247 #ifdef NET_SKBUFF_DATA_USES_OFFSET
1248 static inline unsigned char *skb_end_pointer(const struct sk_buff *skb)
1249 {
1250         return skb->head + skb->end;
1251 }
1252
1253 static inline unsigned int skb_end_offset(const struct sk_buff *skb)
1254 {
1255         return skb->end;
1256 }
1257 #else
1258 static inline unsigned char *skb_end_pointer(const struct sk_buff *skb)
1259 {
1260         return skb->end;
1261 }
1262
1263 static inline unsigned int skb_end_offset(const struct sk_buff *skb)
1264 {
1265         return skb->end - skb->head;
1266 }
1267 #endif
1268
1269 /* Internal */
1270 #define skb_shinfo(SKB) ((struct skb_shared_info *)(skb_end_pointer(SKB)))
1271
1272 static inline struct skb_shared_hwtstamps *skb_hwtstamps(struct sk_buff *skb)
1273 {
1274         return &skb_shinfo(skb)->hwtstamps;
1275 }
1276
1277 static inline struct ubuf_info *skb_zcopy(struct sk_buff *skb)
1278 {
1279         bool is_zcopy = skb && skb_shinfo(skb)->tx_flags & SKBTX_DEV_ZEROCOPY;
1280
1281         return is_zcopy ? skb_uarg(skb) : NULL;
1282 }
1283
1284 static inline void skb_zcopy_set(struct sk_buff *skb, struct ubuf_info *uarg)
1285 {
1286         if (skb && uarg && !skb_zcopy(skb)) {
1287                 sock_zerocopy_get(uarg);
1288                 skb_shinfo(skb)->destructor_arg = uarg;
1289                 skb_shinfo(skb)->tx_flags |= SKBTX_ZEROCOPY_FRAG;
1290         }
1291 }
1292
1293 static inline void skb_zcopy_set_nouarg(struct sk_buff *skb, void *val)
1294 {
1295         skb_shinfo(skb)->destructor_arg = (void *)((uintptr_t) val | 0x1UL);
1296         skb_shinfo(skb)->tx_flags |= SKBTX_ZEROCOPY_FRAG;
1297 }
1298
1299 static inline bool skb_zcopy_is_nouarg(struct sk_buff *skb)
1300 {
1301         return (uintptr_t) skb_shinfo(skb)->destructor_arg & 0x1UL;
1302 }
1303
1304 static inline void *skb_zcopy_get_nouarg(struct sk_buff *skb)
1305 {
1306         return (void *)((uintptr_t) skb_shinfo(skb)->destructor_arg & ~0x1UL);
1307 }
1308
1309 /* Release a reference on a zerocopy structure */
1310 static inline void skb_zcopy_clear(struct sk_buff *skb, bool zerocopy)
1311 {
1312         struct ubuf_info *uarg = skb_zcopy(skb);
1313
1314         if (uarg) {
1315                 if (skb_zcopy_is_nouarg(skb)) {
1316                         /* no notification callback */
1317                 } else if (uarg->callback == sock_zerocopy_callback) {
1318                         uarg->zerocopy = uarg->zerocopy && zerocopy;
1319                         sock_zerocopy_put(uarg);
1320                 } else {
1321                         uarg->callback(uarg, zerocopy);
1322                 }
1323
1324                 skb_shinfo(skb)->tx_flags &= ~SKBTX_ZEROCOPY_FRAG;
1325         }
1326 }
1327
1328 /* Abort a zerocopy operation and revert zckey on error in send syscall */
1329 static inline void skb_zcopy_abort(struct sk_buff *skb)
1330 {
1331         struct ubuf_info *uarg = skb_zcopy(skb);
1332
1333         if (uarg) {
1334                 sock_zerocopy_put_abort(uarg);
1335                 skb_shinfo(skb)->tx_flags &= ~SKBTX_ZEROCOPY_FRAG;
1336         }
1337 }
1338
1339 static inline void skb_mark_not_on_list(struct sk_buff *skb)
1340 {
1341         skb->next = NULL;
1342 }
1343
1344 /* Iterate through singly-linked GSO fragments of an skb. */
1345 #define skb_list_walk_safe(first, skb, next_skb)                               \
1346         for ((skb) = (first), (next_skb) = (skb) ? (skb)->next : NULL; (skb);  \
1347              (skb) = (next_skb), (next_skb) = (skb) ? (skb)->next : NULL)
1348
1349 static inline void skb_list_del_init(struct sk_buff *skb)
1350 {
1351         __list_del_entry(&skb->list);
1352         skb_mark_not_on_list(skb);
1353 }
1354
1355 /**
1356  *      skb_queue_empty - check if a queue is empty
1357  *      @list: queue head
1358  *
1359  *      Returns true if the queue is empty, false otherwise.
1360  */
1361 static inline int skb_queue_empty(const struct sk_buff_head *list)
1362 {
1363         return list->next == (const struct sk_buff *) list;
1364 }
1365
1366 /**
1367  *      skb_queue_empty_lockless - check if a queue is empty
1368  *      @list: queue head
1369  *
1370  *      Returns true if the queue is empty, false otherwise.
1371  *      This variant can be used in lockless contexts.
1372  */
1373 static inline bool skb_queue_empty_lockless(const struct sk_buff_head *list)
1374 {
1375         return READ_ONCE(list->next) == (const struct sk_buff *) list;
1376 }
1377
1378
1379 /**
1380  *      skb_queue_is_last - check if skb is the last entry in the queue
1381  *      @list: queue head
1382  *      @skb: buffer
1383  *
1384  *      Returns true if @skb is the last buffer on the list.
1385  */
1386 static inline bool skb_queue_is_last(const struct sk_buff_head *list,
1387                                      const struct sk_buff *skb)
1388 {
1389         return skb->next == (const struct sk_buff *) list;
1390 }
1391
1392 /**
1393  *      skb_queue_is_first - check if skb is the first entry in the queue
1394  *      @list: queue head
1395  *      @skb: buffer
1396  *
1397  *      Returns true if @skb is the first buffer on the list.
1398  */
1399 static inline bool skb_queue_is_first(const struct sk_buff_head *list,
1400                                       const struct sk_buff *skb)
1401 {
1402         return skb->prev == (const struct sk_buff *) list;
1403 }
1404
1405 /**
1406  *      skb_queue_next - return the next packet in the queue
1407  *      @list: queue head
1408  *      @skb: current buffer
1409  *
1410  *      Return the next packet in @list after @skb.  It is only valid to
1411  *      call this if skb_queue_is_last() evaluates to false.
1412  */
1413 static inline struct sk_buff *skb_queue_next(const struct sk_buff_head *list,
1414                                              const struct sk_buff *skb)
1415 {
1416         /* This BUG_ON may seem severe, but if we just return then we
1417          * are going to dereference garbage.
1418          */
1419         BUG_ON(skb_queue_is_last(list, skb));
1420         return skb->next;
1421 }
1422
1423 /**
1424  *      skb_queue_prev - return the prev packet in the queue
1425  *      @list: queue head
1426  *      @skb: current buffer
1427  *
1428  *      Return the prev packet in @list before @skb.  It is only valid to
1429  *      call this if skb_queue_is_first() evaluates to false.
1430  */
1431 static inline struct sk_buff *skb_queue_prev(const struct sk_buff_head *list,
1432                                              const struct sk_buff *skb)
1433 {
1434         /* This BUG_ON may seem severe, but if we just return then we
1435          * are going to dereference garbage.
1436          */
1437         BUG_ON(skb_queue_is_first(list, skb));
1438         return skb->prev;
1439 }
1440
1441 /**
1442  *      skb_get - reference buffer
1443  *      @skb: buffer to reference
1444  *
1445  *      Makes another reference to a socket buffer and returns a pointer
1446  *      to the buffer.
1447  */
1448 static inline struct sk_buff *skb_get(struct sk_buff *skb)
1449 {
1450         refcount_inc(&skb->users);
1451         return skb;
1452 }
1453
1454 /*
1455  * If users == 1, we are the only owner and are can avoid redundant
1456  * atomic change.
1457  */
1458
1459 /**
1460  *      skb_cloned - is the buffer a clone
1461  *      @skb: buffer to check
1462  *
1463  *      Returns true if the buffer was generated with skb_clone() and is
1464  *      one of multiple shared copies of the buffer. Cloned buffers are
1465  *      shared data so must not be written to under normal circumstances.
1466  */
1467 static inline int skb_cloned(const struct sk_buff *skb)
1468 {
1469         return skb->cloned &&
1470                (atomic_read(&skb_shinfo(skb)->dataref) & SKB_DATAREF_MASK) != 1;
1471 }
1472
1473 static inline int skb_unclone(struct sk_buff *skb, gfp_t pri)
1474 {
1475         might_sleep_if(gfpflags_allow_blocking(pri));
1476
1477         if (skb_cloned(skb))
1478                 return pskb_expand_head(skb, 0, 0, pri);
1479
1480         return 0;
1481 }
1482
1483 /**
1484  *      skb_header_cloned - is the header a clone
1485  *      @skb: buffer to check
1486  *
1487  *      Returns true if modifying the header part of the buffer requires
1488  *      the data to be copied.
1489  */
1490 static inline int skb_header_cloned(const struct sk_buff *skb)
1491 {
1492         int dataref;
1493
1494         if (!skb->cloned)
1495                 return 0;
1496
1497         dataref = atomic_read(&skb_shinfo(skb)->dataref);
1498         dataref = (dataref & SKB_DATAREF_MASK) - (dataref >> SKB_DATAREF_SHIFT);
1499         return dataref != 1;
1500 }
1501
1502 static inline int skb_header_unclone(struct sk_buff *skb, gfp_t pri)
1503 {
1504         might_sleep_if(gfpflags_allow_blocking(pri));
1505
1506         if (skb_header_cloned(skb))
1507                 return pskb_expand_head(skb, 0, 0, pri);
1508
1509         return 0;
1510 }
1511
1512 /**
1513  *      skb_header_release - release reference to header
1514  *      @skb: buffer to operate on
1515  *
1516  *      Drop a reference to the header part of the buffer.  This is done
1517  *      by acquiring a payload reference.  You must not read from the header
1518  *      part of skb->data after this.
1519  *      Note : Check if you can use __skb_header_release() instead.
1520  */
1521 static inline void skb_header_release(struct sk_buff *skb)
1522 {
1523         BUG_ON(skb->nohdr);
1524         skb->nohdr = 1;
1525         atomic_add(1 << SKB_DATAREF_SHIFT, &skb_shinfo(skb)->dataref);
1526 }
1527
1528 /**
1529  *      __skb_header_release - release reference to header
1530  *      @skb: buffer to operate on
1531  *
1532  *      Variant of skb_header_release() assuming skb is private to caller.
1533  *      We can avoid one atomic operation.
1534  */
1535 static inline void __skb_header_release(struct sk_buff *skb)
1536 {
1537         skb->nohdr = 1;
1538         atomic_set(&skb_shinfo(skb)->dataref, 1 + (1 << SKB_DATAREF_SHIFT));
1539 }
1540
1541
1542 /**
1543  *      skb_shared - is the buffer shared
1544  *      @skb: buffer to check
1545  *
1546  *      Returns true if more than one person has a reference to this
1547  *      buffer.
1548  */
1549 static inline int skb_shared(const struct sk_buff *skb)
1550 {
1551         return refcount_read(&skb->users) != 1;
1552 }
1553
1554 /**
1555  *      skb_share_check - check if buffer is shared and if so clone it
1556  *      @skb: buffer to check
1557  *      @pri: priority for memory allocation
1558  *
1559  *      If the buffer is shared the buffer is cloned and the old copy
1560  *      drops a reference. A new clone with a single reference is returned.
1561  *      If the buffer is not shared the original buffer is returned. When
1562  *      being called from interrupt status or with spinlocks held pri must
1563  *      be GFP_ATOMIC.
1564  *
1565  *      NULL is returned on a memory allocation failure.
1566  */
1567 static inline struct sk_buff *skb_share_check(struct sk_buff *skb, gfp_t pri)
1568 {
1569         might_sleep_if(gfpflags_allow_blocking(pri));
1570         if (skb_shared(skb)) {
1571                 struct sk_buff *nskb = skb_clone(skb, pri);
1572
1573                 if (likely(nskb))
1574                         consume_skb(skb);
1575                 else
1576                         kfree_skb(skb);
1577                 skb = nskb;
1578         }
1579         return skb;
1580 }
1581
1582 /*
1583  *      Copy shared buffers into a new sk_buff. We effectively do COW on
1584  *      packets to handle cases where we have a local reader and forward
1585  *      and a couple of other messy ones. The normal one is tcpdumping
1586  *      a packet thats being forwarded.
1587  */
1588
1589 /**
1590  *      skb_unshare - make a copy of a shared buffer
1591  *      @skb: buffer to check
1592  *      @pri: priority for memory allocation
1593  *
1594  *      If the socket buffer is a clone then this function creates a new
1595  *      copy of the data, drops a reference count on the old copy and returns
1596  *      the new copy with the reference count at 1. If the buffer is not a clone
1597  *      the original buffer is returned. When called with a spinlock held or
1598  *      from interrupt state @pri must be %GFP_ATOMIC
1599  *
1600  *      %NULL is returned on a memory allocation failure.
1601  */
1602 static inline struct sk_buff *skb_unshare(struct sk_buff *skb,
1603                                           gfp_t pri)
1604 {
1605         might_sleep_if(gfpflags_allow_blocking(pri));
1606         if (skb_cloned(skb)) {
1607                 struct sk_buff *nskb = skb_copy(skb, pri);
1608
1609                 /* Free our shared copy */
1610                 if (likely(nskb))
1611                         consume_skb(skb);
1612                 else
1613                         kfree_skb(skb);
1614                 skb = nskb;
1615         }
1616         return skb;
1617 }
1618
1619 /**
1620  *      skb_peek - peek at the head of an &sk_buff_head
1621  *      @list_: list to peek at
1622  *
1623  *      Peek an &sk_buff. Unlike most other operations you _MUST_
1624  *      be careful with this one. A peek leaves the buffer on the
1625  *      list and someone else may run off with it. You must hold
1626  *      the appropriate locks or have a private queue to do this.
1627  *
1628  *      Returns %NULL for an empty list or a pointer to the head element.
1629  *      The reference count is not incremented and the reference is therefore
1630  *      volatile. Use with caution.
1631  */
1632 static inline struct sk_buff *skb_peek(const struct sk_buff_head *list_)
1633 {
1634         struct sk_buff *skb = list_->next;
1635
1636         if (skb == (struct sk_buff *)list_)
1637                 skb = NULL;
1638         return skb;
1639 }
1640
1641 /**
1642  *      skb_peek_next - peek skb following the given one from a queue
1643  *      @skb: skb to start from
1644  *      @list_: list to peek at
1645  *
1646  *      Returns %NULL when the end of the list is met or a pointer to the
1647  *      next element. The reference count is not incremented and the
1648  *      reference is therefore volatile. Use with caution.
1649  */
1650 static inline struct sk_buff *skb_peek_next(struct sk_buff *skb,
1651                 const struct sk_buff_head *list_)
1652 {
1653         struct sk_buff *next = skb->next;
1654
1655         if (next == (struct sk_buff *)list_)
1656                 next = NULL;
1657         return next;
1658 }
1659
1660 /**
1661  *      skb_peek_tail - peek at the tail of an &sk_buff_head
1662  *      @list_: list to peek at
1663  *
1664  *      Peek an &sk_buff. Unlike most other operations you _MUST_
1665  *      be careful with this one. A peek leaves the buffer on the
1666  *      list and someone else may run off with it. You must hold
1667  *      the appropriate locks or have a private queue to do this.
1668  *
1669  *      Returns %NULL for an empty list or a pointer to the tail element.
1670  *      The reference count is not incremented and the reference is therefore
1671  *      volatile. Use with caution.
1672  */
1673 static inline struct sk_buff *skb_peek_tail(const struct sk_buff_head *list_)
1674 {
1675         struct sk_buff *skb = READ_ONCE(list_->prev);
1676
1677         if (skb == (struct sk_buff *)list_)
1678                 skb = NULL;
1679         return skb;
1680
1681 }
1682
1683 /**
1684  *      skb_queue_len   - get queue length
1685  *      @list_: list to measure
1686  *
1687  *      Return the length of an &sk_buff queue.
1688  */
1689 static inline __u32 skb_queue_len(const struct sk_buff_head *list_)
1690 {
1691         return list_->qlen;
1692 }
1693
1694 /**
1695  *      skb_queue_len_lockless  - get queue length
1696  *      @list_: list to measure
1697  *
1698  *      Return the length of an &sk_buff queue.
1699  *      This variant can be used in lockless contexts.
1700  */
1701 static inline __u32 skb_queue_len_lockless(const struct sk_buff_head *list_)
1702 {
1703         return READ_ONCE(list_->qlen);
1704 }
1705
1706 /**
1707  *      __skb_queue_head_init - initialize non-spinlock portions of sk_buff_head
1708  *      @list: queue to initialize
1709  *
1710  *      This initializes only the list and queue length aspects of
1711  *      an sk_buff_head object.  This allows to initialize the list
1712  *      aspects of an sk_buff_head without reinitializing things like
1713  *      the spinlock.  It can also be used for on-stack sk_buff_head
1714  *      objects where the spinlock is known to not be used.
1715  */
1716 static inline void __skb_queue_head_init(struct sk_buff_head *list)
1717 {
1718         list->prev = list->next = (struct sk_buff *)list;
1719         list->qlen = 0;
1720 }
1721
1722 /*
1723  * This function creates a split out lock class for each invocation;
1724  * this is needed for now since a whole lot of users of the skb-queue
1725  * infrastructure in drivers have different locking usage (in hardirq)
1726  * than the networking core (in softirq only). In the long run either the
1727  * network layer or drivers should need annotation to consolidate the
1728  * main types of usage into 3 classes.
1729  */
1730 static inline void skb_queue_head_init(struct sk_buff_head *list)
1731 {
1732         spin_lock_init(&list->lock);
1733         __skb_queue_head_init(list);
1734 }
1735
1736 static inline void skb_queue_head_init_class(struct sk_buff_head *list,
1737                 struct lock_class_key *class)
1738 {
1739         skb_queue_head_init(list);
1740         lockdep_set_class(&list->lock, class);
1741 }
1742
1743 /*
1744  *      Insert an sk_buff on a list.
1745  *
1746  *      The "__skb_xxxx()" functions are the non-atomic ones that
1747  *      can only be called with interrupts disabled.
1748  */
1749 void skb_insert(struct sk_buff *old, struct sk_buff *newsk,
1750                 struct sk_buff_head *list);
1751 static inline void __skb_insert(struct sk_buff *newsk,
1752                                 struct sk_buff *prev, struct sk_buff *next,
1753                                 struct sk_buff_head *list)
1754 {
1755         /* See skb_queue_empty_lockless() and skb_peek_tail()
1756          * for the opposite READ_ONCE()
1757          */
1758         WRITE_ONCE(newsk->next, next);
1759         WRITE_ONCE(newsk->prev, prev);
1760         WRITE_ONCE(next->prev, newsk);
1761         WRITE_ONCE(prev->next, newsk);
1762         WRITE_ONCE(list->qlen, list->qlen + 1);
1763 }
1764
1765 static inline void __skb_queue_splice(const struct sk_buff_head *list,
1766                                       struct sk_buff *prev,
1767                                       struct sk_buff *next)
1768 {
1769         struct sk_buff *first = list->next;
1770         struct sk_buff *last = list->prev;
1771
1772         WRITE_ONCE(first->prev, prev);
1773         WRITE_ONCE(prev->next, first);
1774
1775         WRITE_ONCE(last->next, next);
1776         WRITE_ONCE(next->prev, last);
1777 }
1778
1779 /**
1780  *      skb_queue_splice - join two skb lists, this is designed for stacks
1781  *      @list: the new list to add
1782  *      @head: the place to add it in the first list
1783  */
1784 static inline void skb_queue_splice(const struct sk_buff_head *list,
1785                                     struct sk_buff_head *head)
1786 {
1787         if (!skb_queue_empty(list)) {
1788                 __skb_queue_splice(list, (struct sk_buff *) head, head->next);
1789                 head->qlen += list->qlen;
1790         }
1791 }
1792
1793 /**
1794  *      skb_queue_splice_init - join two skb lists and reinitialise the emptied list
1795  *      @list: the new list to add
1796  *      @head: the place to add it in the first list
1797  *
1798  *      The list at @list is reinitialised
1799  */
1800 static inline void skb_queue_splice_init(struct sk_buff_head *list,
1801                                          struct sk_buff_head *head)
1802 {
1803         if (!skb_queue_empty(list)) {
1804                 __skb_queue_splice(list, (struct sk_buff *) head, head->next);
1805                 head->qlen += list->qlen;
1806                 __skb_queue_head_init(list);
1807         }
1808 }
1809
1810 /**
1811  *      skb_queue_splice_tail - join two skb lists, each list being a queue
1812  *      @list: the new list to add
1813  *      @head: the place to add it in the first list
1814  */
1815 static inline void skb_queue_splice_tail(const struct sk_buff_head *list,
1816                                          struct sk_buff_head *head)
1817 {
1818         if (!skb_queue_empty(list)) {
1819                 __skb_queue_splice(list, head->prev, (struct sk_buff *) head);
1820                 head->qlen += list->qlen;
1821         }
1822 }
1823
1824 /**
1825  *      skb_queue_splice_tail_init - join two skb lists and reinitialise the emptied list
1826  *      @list: the new list to add
1827  *      @head: the place to add it in the first list
1828  *
1829  *      Each of the lists is a queue.
1830  *      The list at @list is reinitialised
1831  */
1832 static inline void skb_queue_splice_tail_init(struct sk_buff_head *list,
1833                                               struct sk_buff_head *head)
1834 {
1835         if (!skb_queue_empty(list)) {
1836                 __skb_queue_splice(list, head->prev, (struct sk_buff *) head);
1837                 head->qlen += list->qlen;
1838                 __skb_queue_head_init(list);
1839         }
1840 }
1841
1842 /**
1843  *      __skb_queue_after - queue a buffer at the list head
1844  *      @list: list to use
1845  *      @prev: place after this buffer
1846  *      @newsk: buffer to queue
1847  *
1848  *      Queue a buffer int the middle of a list. This function takes no locks
1849  *      and you must therefore hold required locks before calling it.
1850  *
1851  *      A buffer cannot be placed on two lists at the same time.
1852  */
1853 static inline void __skb_queue_after(struct sk_buff_head *list,
1854                                      struct sk_buff *prev,
1855                                      struct sk_buff *newsk)
1856 {
1857         __skb_insert(newsk, prev, prev->next, list);
1858 }
1859
1860 void skb_append(struct sk_buff *old, struct sk_buff *newsk,
1861                 struct sk_buff_head *list);
1862
1863 static inline void __skb_queue_before(struct sk_buff_head *list,
1864                                       struct sk_buff *next,
1865                                       struct sk_buff *newsk)
1866 {
1867         __skb_insert(newsk, next->prev, next, list);
1868 }
1869
1870 /**
1871  *      __skb_queue_head - queue a buffer at the list head
1872  *      @list: list to use
1873  *      @newsk: buffer to queue
1874  *
1875  *      Queue a buffer at the start of a list. This function takes no locks
1876  *      and you must therefore hold required locks before calling it.
1877  *
1878  *      A buffer cannot be placed on two lists at the same time.
1879  */
1880 void skb_queue_head(struct sk_buff_head *list, struct sk_buff *newsk);
1881 static inline void __skb_queue_head(struct sk_buff_head *list,
1882                                     struct sk_buff *newsk)
1883 {
1884         __skb_queue_after(list, (struct sk_buff *)list, newsk);
1885 }
1886
1887 /**
1888  *      __skb_queue_tail - queue a buffer at the list tail
1889  *      @list: list to use
1890  *      @newsk: buffer to queue
1891  *
1892  *      Queue a buffer at the end of a list. This function takes no locks
1893  *      and you must therefore hold required locks before calling it.
1894  *
1895  *      A buffer cannot be placed on two lists at the same time.
1896  */
1897 void skb_queue_tail(struct sk_buff_head *list, struct sk_buff *newsk);
1898 static inline void __skb_queue_tail(struct sk_buff_head *list,
1899                                    struct sk_buff *newsk)
1900 {
1901         __skb_queue_before(list, (struct sk_buff *)list, newsk);
1902 }
1903
1904 /*
1905  * remove sk_buff from list. _Must_ be called atomically, and with
1906  * the list known..
1907  */
1908 void skb_unlink(struct sk_buff *skb, struct sk_buff_head *list);
1909 static inline void __skb_unlink(struct sk_buff *skb, struct sk_buff_head *list)
1910 {
1911         struct sk_buff *next, *prev;
1912
1913         WRITE_ONCE(list->qlen, list->qlen - 1);
1914         next       = skb->next;
1915         prev       = skb->prev;
1916         skb->next  = skb->prev = NULL;
1917         WRITE_ONCE(next->prev, prev);
1918         WRITE_ONCE(prev->next, next);
1919 }
1920
1921 /**
1922  *      __skb_dequeue - remove from the head of the queue
1923  *      @list: list to dequeue from
1924  *
1925  *      Remove the head of the list. This function does not take any locks
1926  *      so must be used with appropriate locks held only. The head item is
1927  *      returned or %NULL if the list is empty.
1928  */
1929 struct sk_buff *skb_dequeue(struct sk_buff_head *list);
1930 static inline struct sk_buff *__skb_dequeue(struct sk_buff_head *list)
1931 {
1932         struct sk_buff *skb = skb_peek(list);
1933         if (skb)
1934                 __skb_unlink(skb, list);
1935         return skb;
1936 }
1937
1938 /**
1939  *      __skb_dequeue_tail - remove from the tail of the queue
1940  *      @list: list to dequeue from
1941  *
1942  *      Remove the tail of the list. This function does not take any locks
1943  *      so must be used with appropriate locks held only. The tail item is
1944  *      returned or %NULL if the list is empty.
1945  */
1946 struct sk_buff *skb_dequeue_tail(struct sk_buff_head *list);
1947 static inline struct sk_buff *__skb_dequeue_tail(struct sk_buff_head *list)
1948 {
1949         struct sk_buff *skb = skb_peek_tail(list);
1950         if (skb)
1951                 __skb_unlink(skb, list);
1952         return skb;
1953 }
1954
1955
1956 static inline bool skb_is_nonlinear(const struct sk_buff *skb)
1957 {
1958         return skb->data_len;
1959 }
1960
1961 static inline unsigned int skb_headlen(const struct sk_buff *skb)
1962 {
1963         return skb->len - skb->data_len;
1964 }
1965
1966 static inline unsigned int __skb_pagelen(const struct sk_buff *skb)
1967 {
1968         unsigned int i, len = 0;
1969
1970         for (i = skb_shinfo(skb)->nr_frags - 1; (int)i >= 0; i--)
1971                 len += skb_frag_size(&skb_shinfo(skb)->frags[i]);
1972         return len;
1973 }
1974
1975 static inline unsigned int skb_pagelen(const struct sk_buff *skb)
1976 {
1977         return skb_headlen(skb) + __skb_pagelen(skb);
1978 }
1979
1980 /**
1981  * __skb_fill_page_desc - initialise a paged fragment in an skb
1982  * @skb: buffer containing fragment to be initialised
1983  * @i: paged fragment index to initialise
1984  * @page: the page to use for this fragment
1985  * @off: the offset to the data with @page
1986  * @size: the length of the data
1987  *
1988  * Initialises the @i'th fragment of @skb to point to &size bytes at
1989  * offset @off within @page.
1990  *
1991  * Does not take any additional reference on the fragment.
1992  */
1993 static inline void __skb_fill_page_desc(struct sk_buff *skb, int i,
1994                                         struct page *page, int off, int size)
1995 {
1996         skb_frag_t *frag = &skb_shinfo(skb)->frags[i];
1997
1998         /*
1999          * Propagate page pfmemalloc to the skb if we can. The problem is
2000          * that not all callers have unique ownership of the page but rely
2001          * on page_is_pfmemalloc doing the right thing(tm).
2002          */
2003         frag->page.p              = page;
2004         frag->page_offset         = off;
2005         skb_frag_size_set(frag, size);
2006
2007         page = compound_head(page);
2008         if (page_is_pfmemalloc(page))
2009                 skb->pfmemalloc = true;
2010 }
2011
2012 /**
2013  * skb_fill_page_desc - initialise a paged fragment in an skb
2014  * @skb: buffer containing fragment to be initialised
2015  * @i: paged fragment index to initialise
2016  * @page: the page to use for this fragment
2017  * @off: the offset to the data with @page
2018  * @size: the length of the data
2019  *
2020  * As per __skb_fill_page_desc() -- initialises the @i'th fragment of
2021  * @skb to point to @size bytes at offset @off within @page. In
2022  * addition updates @skb such that @i is the last fragment.
2023  *
2024  * Does not take any additional reference on the fragment.
2025  */
2026 static inline void skb_fill_page_desc(struct sk_buff *skb, int i,
2027                                       struct page *page, int off, int size)
2028 {
2029         __skb_fill_page_desc(skb, i, page, off, size);
2030         skb_shinfo(skb)->nr_frags = i + 1;
2031 }
2032
2033 void skb_add_rx_frag(struct sk_buff *skb, int i, struct page *page, int off,
2034                      int size, unsigned int truesize);
2035
2036 void skb_coalesce_rx_frag(struct sk_buff *skb, int i, int size,
2037                           unsigned int truesize);
2038
2039 #define SKB_PAGE_ASSERT(skb)    BUG_ON(skb_shinfo(skb)->nr_frags)
2040 #define SKB_FRAG_ASSERT(skb)    BUG_ON(skb_has_frag_list(skb))
2041 #define SKB_LINEAR_ASSERT(skb)  BUG_ON(skb_is_nonlinear(skb))
2042
2043 #ifdef NET_SKBUFF_DATA_USES_OFFSET
2044 static inline unsigned char *skb_tail_pointer(const struct sk_buff *skb)
2045 {
2046         return skb->head + skb->tail;
2047 }
2048
2049 static inline void skb_reset_tail_pointer(struct sk_buff *skb)
2050 {
2051         skb->tail = skb->data - skb->head;
2052 }
2053
2054 static inline void skb_set_tail_pointer(struct sk_buff *skb, const int offset)
2055 {
2056         skb_reset_tail_pointer(skb);
2057         skb->tail += offset;
2058 }
2059
2060 #else /* NET_SKBUFF_DATA_USES_OFFSET */
2061 static inline unsigned char *skb_tail_pointer(const struct sk_buff *skb)
2062 {
2063         return skb->tail;
2064 }
2065
2066 static inline void skb_reset_tail_pointer(struct sk_buff *skb)
2067 {
2068         skb->tail = skb->data;
2069 }
2070
2071 static inline void skb_set_tail_pointer(struct sk_buff *skb, const int offset)
2072 {
2073         skb->tail = skb->data + offset;
2074 }
2075
2076 #endif /* NET_SKBUFF_DATA_USES_OFFSET */
2077
2078 /*
2079  *      Add data to an sk_buff
2080  */
2081 void *pskb_put(struct sk_buff *skb, struct sk_buff *tail, int len);
2082 void *skb_put(struct sk_buff *skb, unsigned int len);
2083 static inline void *__skb_put(struct sk_buff *skb, unsigned int len)
2084 {
2085         void *tmp = skb_tail_pointer(skb);
2086         SKB_LINEAR_ASSERT(skb);
2087         skb->tail += len;
2088         skb->len  += len;
2089         return tmp;
2090 }
2091
2092 static inline void *__skb_put_zero(struct sk_buff *skb, unsigned int len)
2093 {
2094         void *tmp = __skb_put(skb, len);
2095
2096         memset(tmp, 0, len);
2097         return tmp;
2098 }
2099
2100 static inline void *__skb_put_data(struct sk_buff *skb, const void *data,
2101                                    unsigned int len)
2102 {
2103         void *tmp = __skb_put(skb, len);
2104
2105         memcpy(tmp, data, len);
2106         return tmp;
2107 }
2108
2109 static inline void __skb_put_u8(struct sk_buff *skb, u8 val)
2110 {
2111         *(u8 *)__skb_put(skb, 1) = val;
2112 }
2113
2114 static inline void *skb_put_zero(struct sk_buff *skb, unsigned int len)
2115 {
2116         void *tmp = skb_put(skb, len);
2117
2118         memset(tmp, 0, len);
2119
2120         return tmp;
2121 }
2122
2123 static inline void *skb_put_data(struct sk_buff *skb, const void *data,
2124                                  unsigned int len)
2125 {
2126         void *tmp = skb_put(skb, len);
2127
2128         memcpy(tmp, data, len);
2129
2130         return tmp;
2131 }
2132
2133 static inline void skb_put_u8(struct sk_buff *skb, u8 val)
2134 {
2135         *(u8 *)skb_put(skb, 1) = val;
2136 }
2137
2138 void *skb_push(struct sk_buff *skb, unsigned int len);
2139 static inline void *__skb_push(struct sk_buff *skb, unsigned int len)
2140 {
2141         skb->data -= len;
2142         skb->len  += len;
2143         return skb->data;
2144 }
2145
2146 void *skb_pull(struct sk_buff *skb, unsigned int len);
2147 static inline void *__skb_pull(struct sk_buff *skb, unsigned int len)
2148 {
2149         skb->len -= len;
2150         BUG_ON(skb->len < skb->data_len);
2151         return skb->data += len;
2152 }
2153
2154 static inline void *skb_pull_inline(struct sk_buff *skb, unsigned int len)
2155 {
2156         return unlikely(len > skb->len) ? NULL : __skb_pull(skb, len);
2157 }
2158
2159 void *__pskb_pull_tail(struct sk_buff *skb, int delta);
2160
2161 static inline void *__pskb_pull(struct sk_buff *skb, unsigned int len)
2162 {
2163         if (len > skb_headlen(skb) &&
2164             !__pskb_pull_tail(skb, len - skb_headlen(skb)))
2165                 return NULL;
2166         skb->len -= len;
2167         return skb->data += len;
2168 }
2169
2170 static inline void *pskb_pull(struct sk_buff *skb, unsigned int len)
2171 {
2172         return unlikely(len > skb->len) ? NULL : __pskb_pull(skb, len);
2173 }
2174
2175 static inline int pskb_may_pull(struct sk_buff *skb, unsigned int len)
2176 {
2177         if (likely(len <= skb_headlen(skb)))
2178                 return 1;
2179         if (unlikely(len > skb->len))
2180                 return 0;
2181         return __pskb_pull_tail(skb, len - skb_headlen(skb)) != NULL;
2182 }
2183
2184 void skb_condense(struct sk_buff *skb);
2185
2186 /**
2187  *      skb_headroom - bytes at buffer head
2188  *      @skb: buffer to check
2189  *
2190  *      Return the number of bytes of free space at the head of an &sk_buff.
2191  */
2192 static inline unsigned int skb_headroom(const struct sk_buff *skb)
2193 {
2194         return skb->data - skb->head;
2195 }
2196
2197 /**
2198  *      skb_tailroom - bytes at buffer end
2199  *      @skb: buffer to check
2200  *
2201  *      Return the number of bytes of free space at the tail of an sk_buff
2202  */
2203 static inline int skb_tailroom(const struct sk_buff *skb)
2204 {
2205         return skb_is_nonlinear(skb) ? 0 : skb->end - skb->tail;
2206 }
2207
2208 /**
2209  *      skb_availroom - bytes at buffer end
2210  *      @skb: buffer to check
2211  *
2212  *      Return the number of bytes of free space at the tail of an sk_buff
2213  *      allocated by sk_stream_alloc()
2214  */
2215 static inline int skb_availroom(const struct sk_buff *skb)
2216 {
2217         if (skb_is_nonlinear(skb))
2218                 return 0;
2219
2220         return skb->end - skb->tail - skb->reserved_tailroom;
2221 }
2222
2223 /**
2224  *      skb_reserve - adjust headroom
2225  *      @skb: buffer to alter
2226  *      @len: bytes to move
2227  *
2228  *      Increase the headroom of an empty &sk_buff by reducing the tail
2229  *      room. This is only allowed for an empty buffer.
2230  */
2231 static inline void skb_reserve(struct sk_buff *skb, int len)
2232 {
2233         skb->data += len;
2234         skb->tail += len;
2235 }
2236
2237 /**
2238  *      skb_tailroom_reserve - adjust reserved_tailroom
2239  *      @skb: buffer to alter
2240  *      @mtu: maximum amount of headlen permitted
2241  *      @needed_tailroom: minimum amount of reserved_tailroom
2242  *
2243  *      Set reserved_tailroom so that headlen can be as large as possible but
2244  *      not larger than mtu and tailroom cannot be smaller than
2245  *      needed_tailroom.
2246  *      The required headroom should already have been reserved before using
2247  *      this function.
2248  */
2249 static inline void skb_tailroom_reserve(struct sk_buff *skb, unsigned int mtu,
2250                                         unsigned int needed_tailroom)
2251 {
2252         SKB_LINEAR_ASSERT(skb);
2253         if (mtu < skb_tailroom(skb) - needed_tailroom)
2254                 /* use at most mtu */
2255                 skb->reserved_tailroom = skb_tailroom(skb) - mtu;
2256         else
2257                 /* use up to all available space */
2258                 skb->reserved_tailroom = needed_tailroom;
2259 }
2260
2261 #define ENCAP_TYPE_ETHER        0
2262 #define ENCAP_TYPE_IPPROTO      1
2263
2264 static inline void skb_set_inner_protocol(struct sk_buff *skb,
2265                                           __be16 protocol)
2266 {
2267         skb->inner_protocol = protocol;
2268         skb->inner_protocol_type = ENCAP_TYPE_ETHER;
2269 }
2270
2271 static inline void skb_set_inner_ipproto(struct sk_buff *skb,
2272                                          __u8 ipproto)
2273 {
2274         skb->inner_ipproto = ipproto;
2275         skb->inner_protocol_type = ENCAP_TYPE_IPPROTO;
2276 }
2277
2278 static inline void skb_reset_inner_headers(struct sk_buff *skb)
2279 {
2280         skb->inner_mac_header = skb->mac_header;
2281         skb->inner_network_header = skb->network_header;
2282         skb->inner_transport_header = skb->transport_header;
2283 }
2284
2285 static inline void skb_reset_mac_len(struct sk_buff *skb)
2286 {
2287         skb->mac_len = skb->network_header - skb->mac_header;
2288 }
2289
2290 static inline unsigned char *skb_inner_transport_header(const struct sk_buff
2291                                                         *skb)
2292 {
2293         return skb->head + skb->inner_transport_header;
2294 }
2295
2296 static inline int skb_inner_transport_offset(const struct sk_buff *skb)
2297 {
2298         return skb_inner_transport_header(skb) - skb->data;
2299 }
2300
2301 static inline void skb_reset_inner_transport_header(struct sk_buff *skb)
2302 {
2303         skb->inner_transport_header = skb->data - skb->head;
2304 }
2305
2306 static inline void skb_set_inner_transport_header(struct sk_buff *skb,
2307                                                    const int offset)
2308 {
2309         skb_reset_inner_transport_header(skb);
2310         skb->inner_transport_header += offset;
2311 }
2312
2313 static inline unsigned char *skb_inner_network_header(const struct sk_buff *skb)
2314 {
2315         return skb->head + skb->inner_network_header;
2316 }
2317
2318 static inline void skb_reset_inner_network_header(struct sk_buff *skb)
2319 {
2320         skb->inner_network_header = skb->data - skb->head;
2321 }
2322
2323 static inline void skb_set_inner_network_header(struct sk_buff *skb,
2324                                                 const int offset)
2325 {
2326         skb_reset_inner_network_header(skb);
2327         skb->inner_network_header += offset;
2328 }
2329
2330 static inline unsigned char *skb_inner_mac_header(const struct sk_buff *skb)
2331 {
2332         return skb->head + skb->inner_mac_header;
2333 }
2334
2335 static inline void skb_reset_inner_mac_header(struct sk_buff *skb)
2336 {
2337         skb->inner_mac_header = skb->data - skb->head;
2338 }
2339
2340 static inline void skb_set_inner_mac_header(struct sk_buff *skb,
2341                                             const int offset)
2342 {
2343         skb_reset_inner_mac_header(skb);
2344         skb->inner_mac_header += offset;
2345 }
2346 static inline bool skb_transport_header_was_set(const struct sk_buff *skb)
2347 {
2348         return skb->transport_header != (typeof(skb->transport_header))~0U;
2349 }
2350
2351 static inline unsigned char *skb_transport_header(const struct sk_buff *skb)
2352 {
2353         return skb->head + skb->transport_header;
2354 }
2355
2356 static inline void skb_reset_transport_header(struct sk_buff *skb)
2357 {
2358         skb->transport_header = skb->data - skb->head;
2359 }
2360
2361 static inline void skb_set_transport_header(struct sk_buff *skb,
2362                                             const int offset)
2363 {
2364         skb_reset_transport_header(skb);
2365         skb->transport_header += offset;
2366 }
2367
2368 static inline unsigned char *skb_network_header(const struct sk_buff *skb)
2369 {
2370         return skb->head + skb->network_header;
2371 }
2372
2373 static inline void skb_reset_network_header(struct sk_buff *skb)
2374 {
2375         skb->network_header = skb->data - skb->head;
2376 }
2377
2378 static inline void skb_set_network_header(struct sk_buff *skb, const int offset)
2379 {
2380         skb_reset_network_header(skb);
2381         skb->network_header += offset;
2382 }
2383
2384 static inline unsigned char *skb_mac_header(const struct sk_buff *skb)
2385 {
2386         return skb->head + skb->mac_header;
2387 }
2388
2389 static inline int skb_mac_offset(const struct sk_buff *skb)
2390 {
2391         return skb_mac_header(skb) - skb->data;
2392 }
2393
2394 static inline u32 skb_mac_header_len(const struct sk_buff *skb)
2395 {
2396         return skb->network_header - skb->mac_header;
2397 }
2398
2399 static inline int skb_mac_header_was_set(const struct sk_buff *skb)
2400 {
2401         return skb->mac_header != (typeof(skb->mac_header))~0U;
2402 }
2403
2404 static inline void skb_reset_mac_header(struct sk_buff *skb)
2405 {
2406         skb->mac_header = skb->data - skb->head;
2407 }
2408
2409 static inline void skb_set_mac_header(struct sk_buff *skb, const int offset)
2410 {
2411         skb_reset_mac_header(skb);
2412         skb->mac_header += offset;
2413 }
2414
2415 static inline void skb_pop_mac_header(struct sk_buff *skb)
2416 {
2417         skb->mac_header = skb->network_header;
2418 }
2419
2420 static inline void skb_probe_transport_header(struct sk_buff *skb,
2421                                               const int offset_hint)
2422 {
2423         struct flow_keys keys;
2424
2425         if (skb_transport_header_was_set(skb))
2426                 return;
2427         else if (skb_flow_dissect_flow_keys(skb, &keys, 0))
2428                 skb_set_transport_header(skb, keys.control.thoff);
2429         else if (offset_hint >= 0)
2430                 skb_set_transport_header(skb, offset_hint);
2431 }
2432
2433 static inline void skb_mac_header_rebuild(struct sk_buff *skb)
2434 {
2435         if (skb_mac_header_was_set(skb)) {
2436                 const unsigned char *old_mac = skb_mac_header(skb);
2437
2438                 skb_set_mac_header(skb, -skb->mac_len);
2439                 memmove(skb_mac_header(skb), old_mac, skb->mac_len);
2440         }
2441 }
2442
2443 static inline int skb_checksum_start_offset(const struct sk_buff *skb)
2444 {
2445         return skb->csum_start - skb_headroom(skb);
2446 }
2447
2448 static inline unsigned char *skb_checksum_start(const struct sk_buff *skb)
2449 {
2450         return skb->head + skb->csum_start;
2451 }
2452
2453 static inline int skb_transport_offset(const struct sk_buff *skb)
2454 {
2455         return skb_transport_header(skb) - skb->data;
2456 }
2457
2458 static inline u32 skb_network_header_len(const struct sk_buff *skb)
2459 {
2460         return skb->transport_header - skb->network_header;
2461 }
2462
2463 static inline u32 skb_inner_network_header_len(const struct sk_buff *skb)
2464 {
2465         return skb->inner_transport_header - skb->inner_network_header;
2466 }
2467
2468 static inline int skb_network_offset(const struct sk_buff *skb)
2469 {
2470         return skb_network_header(skb) - skb->data;
2471 }
2472
2473 static inline int skb_inner_network_offset(const struct sk_buff *skb)
2474 {
2475         return skb_inner_network_header(skb) - skb->data;
2476 }
2477
2478 static inline int pskb_network_may_pull(struct sk_buff *skb, unsigned int len)
2479 {
2480         return pskb_may_pull(skb, skb_network_offset(skb) + len);
2481 }
2482
2483 /*
2484  * CPUs often take a performance hit when accessing unaligned memory
2485  * locations. The actual performance hit varies, it can be small if the
2486  * hardware handles it or large if we have to take an exception and fix it
2487  * in software.
2488  *
2489  * Since an ethernet header is 14 bytes network drivers often end up with
2490  * the IP header at an unaligned offset. The IP header can be aligned by
2491  * shifting the start of the packet by 2 bytes. Drivers should do this
2492  * with:
2493  *
2494  * skb_reserve(skb, NET_IP_ALIGN);
2495  *
2496  * The downside to this alignment of the IP header is that the DMA is now
2497  * unaligned. On some architectures the cost of an unaligned DMA is high
2498  * and this cost outweighs the gains made by aligning the IP header.
2499  *
2500  * Since this trade off varies between architectures, we allow NET_IP_ALIGN
2501  * to be overridden.
2502  */
2503 #ifndef NET_IP_ALIGN
2504 #define NET_IP_ALIGN    2
2505 #endif
2506
2507 /*
2508  * The networking layer reserves some headroom in skb data (via
2509  * dev_alloc_skb). This is used to avoid having to reallocate skb data when
2510  * the header has to grow. In the default case, if the header has to grow
2511  * 32 bytes or less we avoid the reallocation.
2512  *
2513  * Unfortunately this headroom changes the DMA alignment of the resulting
2514  * network packet. As for NET_IP_ALIGN, this unaligned DMA is expensive
2515  * on some architectures. An architecture can override this value,
2516  * perhaps setting it to a cacheline in size (since that will maintain
2517  * cacheline alignment of the DMA). It must be a power of 2.
2518  *
2519  * Various parts of the networking layer expect at least 32 bytes of
2520  * headroom, you should not reduce this.
2521  *
2522  * Using max(32, L1_CACHE_BYTES) makes sense (especially with RPS)
2523  * to reduce average number of cache lines per packet.
2524  * get_rps_cpus() for example only access one 64 bytes aligned block :
2525  * NET_IP_ALIGN(2) + ethernet_header(14) + IP_header(20/40) + ports(8)
2526  */
2527 #ifndef NET_SKB_PAD
2528 #define NET_SKB_PAD     max(32, L1_CACHE_BYTES)
2529 #endif
2530
2531 int ___pskb_trim(struct sk_buff *skb, unsigned int len);
2532
2533 static inline void __skb_set_length(struct sk_buff *skb, unsigned int len)
2534 {
2535         if (unlikely(skb_is_nonlinear(skb))) {
2536                 WARN_ON(1);
2537                 return;
2538         }
2539         skb->len = len;
2540         skb_set_tail_pointer(skb, len);
2541 }
2542
2543 static inline void __skb_trim(struct sk_buff *skb, unsigned int len)
2544 {
2545         __skb_set_length(skb, len);
2546 }
2547
2548 void skb_trim(struct sk_buff *skb, unsigned int len);
2549
2550 static inline int __pskb_trim(struct sk_buff *skb, unsigned int len)
2551 {
2552         if (skb->data_len)
2553                 return ___pskb_trim(skb, len);
2554         __skb_trim(skb, len);
2555         return 0;
2556 }
2557
2558 static inline int pskb_trim(struct sk_buff *skb, unsigned int len)
2559 {
2560         return (len < skb->len) ? __pskb_trim(skb, len) : 0;
2561 }
2562
2563 /**
2564  *      pskb_trim_unique - remove end from a paged unique (not cloned) buffer
2565  *      @skb: buffer to alter
2566  *      @len: new length
2567  *
2568  *      This is identical to pskb_trim except that the caller knows that
2569  *      the skb is not cloned so we should never get an error due to out-
2570  *      of-memory.
2571  */
2572 static inline void pskb_trim_unique(struct sk_buff *skb, unsigned int len)
2573 {
2574         int err = pskb_trim(skb, len);
2575         BUG_ON(err);
2576 }
2577
2578 static inline int __skb_grow(struct sk_buff *skb, unsigned int len)
2579 {
2580         unsigned int diff = len - skb->len;
2581
2582         if (skb_tailroom(skb) < diff) {
2583                 int ret = pskb_expand_head(skb, 0, diff - skb_tailroom(skb),
2584                                            GFP_ATOMIC);
2585                 if (ret)
2586                         return ret;
2587         }
2588         __skb_set_length(skb, len);
2589         return 0;
2590 }
2591
2592 /**
2593  *      skb_orphan - orphan a buffer
2594  *      @skb: buffer to orphan
2595  *
2596  *      If a buffer currently has an owner then we call the owner's
2597  *      destructor function and make the @skb unowned. The buffer continues
2598  *      to exist but is no longer charged to its former owner.
2599  */
2600 static inline void skb_orphan(struct sk_buff *skb)
2601 {
2602         if (skb->destructor) {
2603                 skb->destructor(skb);
2604                 skb->destructor = NULL;
2605                 skb->sk         = NULL;
2606         } else {
2607                 BUG_ON(skb->sk);
2608         }
2609 }
2610
2611 /**
2612  *      skb_orphan_frags - orphan the frags contained in a buffer
2613  *      @skb: buffer to orphan frags from
2614  *      @gfp_mask: allocation mask for replacement pages
2615  *
2616  *      For each frag in the SKB which needs a destructor (i.e. has an
2617  *      owner) create a copy of that frag and release the original
2618  *      page by calling the destructor.
2619  */
2620 static inline int skb_orphan_frags(struct sk_buff *skb, gfp_t gfp_mask)
2621 {
2622         if (likely(!skb_zcopy(skb)))
2623                 return 0;
2624         if (!skb_zcopy_is_nouarg(skb) &&
2625             skb_uarg(skb)->callback == sock_zerocopy_callback)
2626                 return 0;
2627         return skb_copy_ubufs(skb, gfp_mask);
2628 }
2629
2630 /* Frags must be orphaned, even if refcounted, if skb might loop to rx path */
2631 static inline int skb_orphan_frags_rx(struct sk_buff *skb, gfp_t gfp_mask)
2632 {
2633         if (likely(!skb_zcopy(skb)))
2634                 return 0;
2635         return skb_copy_ubufs(skb, gfp_mask);
2636 }
2637
2638 /**
2639  *      __skb_queue_purge - empty a list
2640  *      @list: list to empty
2641  *
2642  *      Delete all buffers on an &sk_buff list. Each buffer is removed from
2643  *      the list and one reference dropped. This function does not take the
2644  *      list lock and the caller must hold the relevant locks to use it.
2645  */
2646 void skb_queue_purge(struct sk_buff_head *list);
2647 static inline void __skb_queue_purge(struct sk_buff_head *list)
2648 {
2649         struct sk_buff *skb;
2650         while ((skb = __skb_dequeue(list)) != NULL)
2651                 kfree_skb(skb);
2652 }
2653
2654 unsigned int skb_rbtree_purge(struct rb_root *root);
2655
2656 void *netdev_alloc_frag(unsigned int fragsz);
2657
2658 struct sk_buff *__netdev_alloc_skb(struct net_device *dev, unsigned int length,
2659                                    gfp_t gfp_mask);
2660
2661 /**
2662  *      netdev_alloc_skb - allocate an skbuff for rx on a specific device
2663  *      @dev: network device to receive on
2664  *      @length: length to allocate
2665  *
2666  *      Allocate a new &sk_buff and assign it a usage count of one. The
2667  *      buffer has unspecified headroom built in. Users should allocate
2668  *      the headroom they think they need without accounting for the
2669  *      built in space. The built in space is used for optimisations.
2670  *
2671  *      %NULL is returned if there is no free memory. Although this function
2672  *      allocates memory it can be called from an interrupt.
2673  */
2674 static inline struct sk_buff *netdev_alloc_skb(struct net_device *dev,
2675                                                unsigned int length)
2676 {
2677         return __netdev_alloc_skb(dev, length, GFP_ATOMIC);
2678 }
2679
2680 /* legacy helper around __netdev_alloc_skb() */
2681 static inline struct sk_buff *__dev_alloc_skb(unsigned int length,
2682                                               gfp_t gfp_mask)
2683 {
2684         return __netdev_alloc_skb(NULL, length, gfp_mask);
2685 }
2686
2687 /* legacy helper around netdev_alloc_skb() */
2688 static inline struct sk_buff *dev_alloc_skb(unsigned int length)
2689 {
2690         return netdev_alloc_skb(NULL, length);
2691 }
2692
2693
2694 static inline struct sk_buff *__netdev_alloc_skb_ip_align(struct net_device *dev,
2695                 unsigned int length, gfp_t gfp)
2696 {
2697         struct sk_buff *skb = __netdev_alloc_skb(dev, length + NET_IP_ALIGN, gfp);
2698
2699         if (NET_IP_ALIGN && skb)
2700                 skb_reserve(skb, NET_IP_ALIGN);
2701         return skb;
2702 }
2703
2704 static inline struct sk_buff *netdev_alloc_skb_ip_align(struct net_device *dev,
2705                 unsigned int length)
2706 {
2707         return __netdev_alloc_skb_ip_align(dev, length, GFP_ATOMIC);
2708 }
2709
2710 static inline void skb_free_frag(void *addr)
2711 {
2712         page_frag_free(addr);
2713 }
2714
2715 void *napi_alloc_frag(unsigned int fragsz);
2716 struct sk_buff *__napi_alloc_skb(struct napi_struct *napi,
2717                                  unsigned int length, gfp_t gfp_mask);
2718 static inline struct sk_buff *napi_alloc_skb(struct napi_struct *napi,
2719                                              unsigned int length)
2720 {
2721         return __napi_alloc_skb(napi, length, GFP_ATOMIC);
2722 }
2723 void napi_consume_skb(struct sk_buff *skb, int budget);
2724
2725 void __kfree_skb_flush(void);
2726 void __kfree_skb_defer(struct sk_buff *skb);
2727
2728 /**
2729  * __dev_alloc_pages - allocate page for network Rx
2730  * @gfp_mask: allocation priority. Set __GFP_NOMEMALLOC if not for network Rx
2731  * @order: size of the allocation
2732  *
2733  * Allocate a new page.
2734  *
2735  * %NULL is returned if there is no free memory.
2736 */
2737 static inline struct page *__dev_alloc_pages(gfp_t gfp_mask,
2738                                              unsigned int order)
2739 {
2740         /* This piece of code contains several assumptions.
2741          * 1.  This is for device Rx, therefor a cold page is preferred.
2742          * 2.  The expectation is the user wants a compound page.
2743          * 3.  If requesting a order 0 page it will not be compound
2744          *     due to the check to see if order has a value in prep_new_page
2745          * 4.  __GFP_MEMALLOC is ignored if __GFP_NOMEMALLOC is set due to
2746          *     code in gfp_to_alloc_flags that should be enforcing this.
2747          */
2748         gfp_mask |= __GFP_COLD | __GFP_COMP | __GFP_MEMALLOC;
2749
2750         return alloc_pages_node(NUMA_NO_NODE, gfp_mask, order);
2751 }
2752
2753 static inline struct page *dev_alloc_pages(unsigned int order)
2754 {
2755         return __dev_alloc_pages(GFP_ATOMIC | __GFP_NOWARN, order);
2756 }
2757
2758 /**
2759  * __dev_alloc_page - allocate a page for network Rx
2760  * @gfp_mask: allocation priority. Set __GFP_NOMEMALLOC if not for network Rx
2761  *
2762  * Allocate a new page.
2763  *
2764  * %NULL is returned if there is no free memory.
2765  */
2766 static inline struct page *__dev_alloc_page(gfp_t gfp_mask)
2767 {
2768         return __dev_alloc_pages(gfp_mask, 0);
2769 }
2770
2771 static inline struct page *dev_alloc_page(void)
2772 {
2773         return dev_alloc_pages(0);
2774 }
2775
2776 /**
2777  *      skb_propagate_pfmemalloc - Propagate pfmemalloc if skb is allocated after RX page
2778  *      @page: The page that was allocated from skb_alloc_page
2779  *      @skb: The skb that may need pfmemalloc set
2780  */
2781 static inline void skb_propagate_pfmemalloc(struct page *page,
2782                                              struct sk_buff *skb)
2783 {
2784         if (page_is_pfmemalloc(page))
2785                 skb->pfmemalloc = true;
2786 }
2787
2788 /**
2789  * skb_frag_off() - Returns the offset of a skb fragment
2790  * @frag: the paged fragment
2791  */
2792 static inline unsigned int skb_frag_off(const skb_frag_t *frag)
2793 {
2794         return frag->page_offset;
2795 }
2796
2797 /**
2798  * skb_frag_page - retrieve the page referred to by a paged fragment
2799  * @frag: the paged fragment
2800  *
2801  * Returns the &struct page associated with @frag.
2802  */
2803 static inline struct page *skb_frag_page(const skb_frag_t *frag)
2804 {
2805         return frag->page.p;
2806 }
2807
2808 /**
2809  * __skb_frag_ref - take an addition reference on a paged fragment.
2810  * @frag: the paged fragment
2811  *
2812  * Takes an additional reference on the paged fragment @frag.
2813  */
2814 static inline void __skb_frag_ref(skb_frag_t *frag)
2815 {
2816         get_page(skb_frag_page(frag));
2817 }
2818
2819 /**
2820  * skb_frag_ref - take an addition reference on a paged fragment of an skb.
2821  * @skb: the buffer
2822  * @f: the fragment offset.
2823  *
2824  * Takes an additional reference on the @f'th paged fragment of @skb.
2825  */
2826 static inline void skb_frag_ref(struct sk_buff *skb, int f)
2827 {
2828         __skb_frag_ref(&skb_shinfo(skb)->frags[f]);
2829 }
2830
2831 /**
2832  * __skb_frag_unref - release a reference on a paged fragment.
2833  * @frag: the paged fragment
2834  *
2835  * Releases a reference on the paged fragment @frag.
2836  */
2837 static inline void __skb_frag_unref(skb_frag_t *frag)
2838 {
2839         put_page(skb_frag_page(frag));
2840 }
2841
2842 /**
2843  * skb_frag_unref - release a reference on a paged fragment of an skb.
2844  * @skb: the buffer
2845  * @f: the fragment offset
2846  *
2847  * Releases a reference on the @f'th paged fragment of @skb.
2848  */
2849 static inline void skb_frag_unref(struct sk_buff *skb, int f)
2850 {
2851         __skb_frag_unref(&skb_shinfo(skb)->frags[f]);
2852 }
2853
2854 /**
2855  * skb_frag_address - gets the address of the data contained in a paged fragment
2856  * @frag: the paged fragment buffer
2857  *
2858  * Returns the address of the data within @frag. The page must already
2859  * be mapped.
2860  */
2861 static inline void *skb_frag_address(const skb_frag_t *frag)
2862 {
2863         return page_address(skb_frag_page(frag)) + frag->page_offset;
2864 }
2865
2866 /**
2867  * skb_frag_address_safe - gets the address of the data contained in a paged fragment
2868  * @frag: the paged fragment buffer
2869  *
2870  * Returns the address of the data within @frag. Checks that the page
2871  * is mapped and returns %NULL otherwise.
2872  */
2873 static inline void *skb_frag_address_safe(const skb_frag_t *frag)
2874 {
2875         void *ptr = page_address(skb_frag_page(frag));
2876         if (unlikely(!ptr))
2877                 return NULL;
2878
2879         return ptr + frag->page_offset;
2880 }
2881
2882 /**
2883  * __skb_frag_set_page - sets the page contained in a paged fragment
2884  * @frag: the paged fragment
2885  * @page: the page to set
2886  *
2887  * Sets the fragment @frag to contain @page.
2888  */
2889 static inline void __skb_frag_set_page(skb_frag_t *frag, struct page *page)
2890 {
2891         frag->page.p = page;
2892 }
2893
2894 /**
2895  * skb_frag_set_page - sets the page contained in a paged fragment of an skb
2896  * @skb: the buffer
2897  * @f: the fragment offset
2898  * @page: the page to set
2899  *
2900  * Sets the @f'th fragment of @skb to contain @page.
2901  */
2902 static inline void skb_frag_set_page(struct sk_buff *skb, int f,
2903                                      struct page *page)
2904 {
2905         __skb_frag_set_page(&skb_shinfo(skb)->frags[f], page);
2906 }
2907
2908 bool skb_page_frag_refill(unsigned int sz, struct page_frag *pfrag, gfp_t prio);
2909
2910 /**
2911  * skb_frag_dma_map - maps a paged fragment via the DMA API
2912  * @dev: the device to map the fragment to
2913  * @frag: the paged fragment to map
2914  * @offset: the offset within the fragment (starting at the
2915  *          fragment's own offset)
2916  * @size: the number of bytes to map
2917  * @dir: the direction of the mapping (``PCI_DMA_*``)
2918  *
2919  * Maps the page associated with @frag to @device.
2920  */
2921 static inline dma_addr_t skb_frag_dma_map(struct device *dev,
2922                                           const skb_frag_t *frag,
2923                                           size_t offset, size_t size,
2924                                           enum dma_data_direction dir)
2925 {
2926         return dma_map_page(dev, skb_frag_page(frag),
2927                             frag->page_offset + offset, size, dir);
2928 }
2929
2930 static inline struct sk_buff *pskb_copy(struct sk_buff *skb,
2931                                         gfp_t gfp_mask)
2932 {
2933         return __pskb_copy(skb, skb_headroom(skb), gfp_mask);
2934 }
2935
2936
2937 static inline struct sk_buff *pskb_copy_for_clone(struct sk_buff *skb,
2938                                                   gfp_t gfp_mask)
2939 {
2940         return __pskb_copy_fclone(skb, skb_headroom(skb), gfp_mask, true);
2941 }
2942
2943
2944 /**
2945  *      skb_clone_writable - is the header of a clone writable
2946  *      @skb: buffer to check
2947  *      @len: length up to which to write
2948  *
2949  *      Returns true if modifying the header part of the cloned buffer
2950  *      does not requires the data to be copied.
2951  */
2952 static inline int skb_clone_writable(const struct sk_buff *skb, unsigned int len)
2953 {
2954         return !skb_header_cloned(skb) &&
2955                skb_headroom(skb) + len <= skb->hdr_len;
2956 }
2957
2958 static inline int skb_try_make_writable(struct sk_buff *skb,
2959                                         unsigned int write_len)
2960 {
2961         return skb_cloned(skb) && !skb_clone_writable(skb, write_len) &&
2962                pskb_expand_head(skb, 0, 0, GFP_ATOMIC);
2963 }
2964
2965 static inline int __skb_cow(struct sk_buff *skb, unsigned int headroom,
2966                             int cloned)
2967 {
2968         int delta = 0;
2969
2970         if (headroom > skb_headroom(skb))
2971                 delta = headroom - skb_headroom(skb);
2972
2973         if (delta || cloned)
2974                 return pskb_expand_head(skb, ALIGN(delta, NET_SKB_PAD), 0,
2975                                         GFP_ATOMIC);
2976         return 0;
2977 }
2978
2979 /**
2980  *      skb_cow - copy header of skb when it is required
2981  *      @skb: buffer to cow
2982  *      @headroom: needed headroom
2983  *
2984  *      If the skb passed lacks sufficient headroom or its data part
2985  *      is shared, data is reallocated. If reallocation fails, an error
2986  *      is returned and original skb is not changed.
2987  *
2988  *      The result is skb with writable area skb->head...skb->tail
2989  *      and at least @headroom of space at head.
2990  */
2991 static inline int skb_cow(struct sk_buff *skb, unsigned int headroom)
2992 {
2993         return __skb_cow(skb, headroom, skb_cloned(skb));
2994 }
2995
2996 /**
2997  *      skb_cow_head - skb_cow but only making the head writable
2998  *      @skb: buffer to cow
2999  *      @headroom: needed headroom
3000  *
3001  *      This function is identical to skb_cow except that we replace the
3002  *      skb_cloned check by skb_header_cloned.  It should be used when
3003  *      you only need to push on some header and do not need to modify
3004  *      the data.
3005  */
3006 static inline int skb_cow_head(struct sk_buff *skb, unsigned int headroom)
3007 {
3008         return __skb_cow(skb, headroom, skb_header_cloned(skb));
3009 }
3010
3011 /**
3012  *      skb_padto       - pad an skbuff up to a minimal size
3013  *      @skb: buffer to pad
3014  *      @len: minimal length
3015  *
3016  *      Pads up a buffer to ensure the trailing bytes exist and are
3017  *      blanked. If the buffer already contains sufficient data it
3018  *      is untouched. Otherwise it is extended. Returns zero on
3019  *      success. The skb is freed on error.
3020  */
3021 static inline int skb_padto(struct sk_buff *skb, unsigned int len)
3022 {
3023         unsigned int size = skb->len;
3024         if (likely(size >= len))
3025                 return 0;
3026         return skb_pad(skb, len - size);
3027 }
3028
3029 /**
3030  *      skb_put_padto - increase size and pad an skbuff up to a minimal size
3031  *      @skb: buffer to pad
3032  *      @len: minimal length
3033  *      @free_on_error: free buffer on error
3034  *
3035  *      Pads up a buffer to ensure the trailing bytes exist and are
3036  *      blanked. If the buffer already contains sufficient data it
3037  *      is untouched. Otherwise it is extended. Returns zero on
3038  *      success. The skb is freed on error if @free_on_error is true.
3039  */
3040 static inline int __must_check __skb_put_padto(struct sk_buff *skb,
3041                                                unsigned int len,
3042                                                bool free_on_error)
3043 {
3044         unsigned int size = skb->len;
3045
3046         if (unlikely(size < len)) {
3047                 len -= size;
3048                 if (__skb_pad(skb, len, free_on_error))
3049                         return -ENOMEM;
3050                 __skb_put(skb, len);
3051         }
3052         return 0;
3053 }
3054
3055 /**
3056  *      skb_put_padto - increase size and pad an skbuff up to a minimal size
3057  *      @skb: buffer to pad
3058  *      @len: minimal length
3059  *
3060  *      Pads up a buffer to ensure the trailing bytes exist and are
3061  *      blanked. If the buffer already contains sufficient data it
3062  *      is untouched. Otherwise it is extended. Returns zero on
3063  *      success. The skb is freed on error.
3064  */
3065 static inline int __must_check skb_put_padto(struct sk_buff *skb, unsigned int len)
3066 {
3067         return __skb_put_padto(skb, len, true);
3068 }
3069
3070 static inline int skb_add_data(struct sk_buff *skb,
3071                                struct iov_iter *from, int copy)
3072 {
3073         const int off = skb->len;
3074
3075         if (skb->ip_summed == CHECKSUM_NONE) {
3076                 __wsum csum = 0;
3077                 if (csum_and_copy_from_iter_full(skb_put(skb, copy), copy,
3078                                                  &csum, from)) {
3079                         skb->csum = csum_block_add(skb->csum, csum, off);
3080                         return 0;
3081                 }
3082         } else if (copy_from_iter_full(skb_put(skb, copy), copy, from))
3083                 return 0;
3084
3085         __skb_trim(skb, off);
3086         return -EFAULT;
3087 }
3088
3089 static inline bool skb_can_coalesce(struct sk_buff *skb, int i,
3090                                     const struct page *page, int off)
3091 {
3092         if (skb_zcopy(skb))
3093                 return false;
3094         if (i) {
3095                 const struct skb_frag_struct *frag = &skb_shinfo(skb)->frags[i - 1];
3096
3097                 return page == skb_frag_page(frag) &&
3098                        off == frag->page_offset + skb_frag_size(frag);
3099         }
3100         return false;
3101 }
3102
3103 static inline int __skb_linearize(struct sk_buff *skb)
3104 {
3105         return __pskb_pull_tail(skb, skb->data_len) ? 0 : -ENOMEM;
3106 }
3107
3108 /**
3109  *      skb_linearize - convert paged skb to linear one
3110  *      @skb: buffer to linarize
3111  *
3112  *      If there is no free memory -ENOMEM is returned, otherwise zero
3113  *      is returned and the old skb data released.
3114  */
3115 static inline int skb_linearize(struct sk_buff *skb)
3116 {
3117         return skb_is_nonlinear(skb) ? __skb_linearize(skb) : 0;
3118 }
3119
3120 /**
3121  * skb_has_shared_frag - can any frag be overwritten
3122  * @skb: buffer to test
3123  *
3124  * Return true if the skb has at least one frag that might be modified
3125  * by an external entity (as in vmsplice()/sendfile())
3126  */
3127 static inline bool skb_has_shared_frag(const struct sk_buff *skb)
3128 {
3129         return skb_is_nonlinear(skb) &&
3130                skb_shinfo(skb)->tx_flags & SKBTX_SHARED_FRAG;
3131 }
3132
3133 /**
3134  *      skb_linearize_cow - make sure skb is linear and writable
3135  *      @skb: buffer to process
3136  *
3137  *      If there is no free memory -ENOMEM is returned, otherwise zero
3138  *      is returned and the old skb data released.
3139  */
3140 static inline int skb_linearize_cow(struct sk_buff *skb)
3141 {
3142         return skb_is_nonlinear(skb) || skb_cloned(skb) ?
3143                __skb_linearize(skb) : 0;
3144 }
3145
3146 static __always_inline void
3147 __skb_postpull_rcsum(struct sk_buff *skb, const void *start, unsigned int len,
3148                      unsigned int off)
3149 {
3150         if (skb->ip_summed == CHECKSUM_COMPLETE)
3151                 skb->csum = csum_block_sub(skb->csum,
3152                                            csum_partial(start, len, 0), off);
3153         else if (skb->ip_summed == CHECKSUM_PARTIAL &&
3154                  skb_checksum_start_offset(skb) < 0)
3155                 skb->ip_summed = CHECKSUM_NONE;
3156 }
3157
3158 /**
3159  *      skb_postpull_rcsum - update checksum for received skb after pull
3160  *      @skb: buffer to update
3161  *      @start: start of data before pull
3162  *      @len: length of data pulled
3163  *
3164  *      After doing a pull on a received packet, you need to call this to
3165  *      update the CHECKSUM_COMPLETE checksum, or set ip_summed to
3166  *      CHECKSUM_NONE so that it can be recomputed from scratch.
3167  */
3168 static inline void skb_postpull_rcsum(struct sk_buff *skb,
3169                                       const void *start, unsigned int len)
3170 {
3171         __skb_postpull_rcsum(skb, start, len, 0);
3172 }
3173
3174 static __always_inline void
3175 __skb_postpush_rcsum(struct sk_buff *skb, const void *start, unsigned int len,
3176                      unsigned int off)
3177 {
3178         if (skb->ip_summed == CHECKSUM_COMPLETE)
3179                 skb->csum = csum_block_add(skb->csum,
3180                                            csum_partial(start, len, 0), off);
3181 }
3182
3183 /**
3184  *      skb_postpush_rcsum - update checksum for received skb after push
3185  *      @skb: buffer to update
3186  *      @start: start of data after push
3187  *      @len: length of data pushed
3188  *
3189  *      After doing a push on a received packet, you need to call this to
3190  *      update the CHECKSUM_COMPLETE checksum.
3191  */
3192 static inline void skb_postpush_rcsum(struct sk_buff *skb,
3193                                       const void *start, unsigned int len)
3194 {
3195         __skb_postpush_rcsum(skb, start, len, 0);
3196 }
3197
3198 void *skb_pull_rcsum(struct sk_buff *skb, unsigned int len);
3199
3200 /**
3201  *      skb_push_rcsum - push skb and update receive checksum
3202  *      @skb: buffer to update
3203  *      @len: length of data pulled
3204  *
3205  *      This function performs an skb_push on the packet and updates
3206  *      the CHECKSUM_COMPLETE checksum.  It should be used on
3207  *      receive path processing instead of skb_push unless you know
3208  *      that the checksum difference is zero (e.g., a valid IP header)
3209  *      or you are setting ip_summed to CHECKSUM_NONE.
3210  */
3211 static inline void *skb_push_rcsum(struct sk_buff *skb, unsigned int len)
3212 {
3213         skb_push(skb, len);
3214         skb_postpush_rcsum(skb, skb->data, len);
3215         return skb->data;
3216 }
3217
3218 int pskb_trim_rcsum_slow(struct sk_buff *skb, unsigned int len);
3219 /**
3220  *      pskb_trim_rcsum - trim received skb and update checksum
3221  *      @skb: buffer to trim
3222  *      @len: new length
3223  *
3224  *      This is exactly the same as pskb_trim except that it ensures the
3225  *      checksum of received packets are still valid after the operation.
3226  *      It can change skb pointers.
3227  */
3228
3229 static inline int pskb_trim_rcsum(struct sk_buff *skb, unsigned int len)
3230 {
3231         if (likely(len >= skb->len))
3232                 return 0;
3233         return pskb_trim_rcsum_slow(skb, len);
3234 }
3235
3236 static inline int __skb_trim_rcsum(struct sk_buff *skb, unsigned int len)
3237 {
3238         if (skb->ip_summed == CHECKSUM_COMPLETE)
3239                 skb->ip_summed = CHECKSUM_NONE;
3240         __skb_trim(skb, len);
3241         return 0;
3242 }
3243
3244 static inline int __skb_grow_rcsum(struct sk_buff *skb, unsigned int len)
3245 {
3246         if (skb->ip_summed == CHECKSUM_COMPLETE)
3247                 skb->ip_summed = CHECKSUM_NONE;
3248         return __skb_grow(skb, len);
3249 }
3250
3251 #define rb_to_skb(rb) rb_entry_safe(rb, struct sk_buff, rbnode)
3252
3253 #define rb_to_skb(rb) rb_entry_safe(rb, struct sk_buff, rbnode)
3254 #define skb_rb_first(root) rb_to_skb(rb_first(root))
3255 #define skb_rb_last(root)  rb_to_skb(rb_last(root))
3256 #define skb_rb_next(skb)   rb_to_skb(rb_next(&(skb)->rbnode))
3257 #define skb_rb_prev(skb)   rb_to_skb(rb_prev(&(skb)->rbnode))
3258
3259 #define skb_queue_walk(queue, skb) \
3260                 for (skb = (queue)->next;                                       \
3261                      skb != (struct sk_buff *)(queue);                          \
3262                      skb = skb->next)
3263
3264 #define skb_queue_walk_safe(queue, skb, tmp)                                    \
3265                 for (skb = (queue)->next, tmp = skb->next;                      \
3266                      skb != (struct sk_buff *)(queue);                          \
3267                      skb = tmp, tmp = skb->next)
3268
3269 #define skb_queue_walk_from(queue, skb)                                         \
3270                 for (; skb != (struct sk_buff *)(queue);                        \
3271                      skb = skb->next)
3272
3273 #define skb_rbtree_walk(skb, root)                                              \
3274                 for (skb = skb_rb_first(root); skb != NULL;                     \
3275                      skb = skb_rb_next(skb))
3276
3277 #define skb_rbtree_walk_from(skb)                                               \
3278                 for (; skb != NULL;                                             \
3279                      skb = skb_rb_next(skb))
3280
3281 #define skb_rbtree_walk_from_safe(skb, tmp)                                     \
3282                 for (; tmp = skb ? skb_rb_next(skb) : NULL, (skb != NULL);      \
3283                      skb = tmp)
3284
3285 #define skb_queue_walk_from_safe(queue, skb, tmp)                               \
3286                 for (tmp = skb->next;                                           \
3287                      skb != (struct sk_buff *)(queue);                          \
3288                      skb = tmp, tmp = skb->next)
3289
3290 #define skb_queue_reverse_walk(queue, skb) \
3291                 for (skb = (queue)->prev;                                       \
3292                      skb != (struct sk_buff *)(queue);                          \
3293                      skb = skb->prev)
3294
3295 #define skb_queue_reverse_walk_safe(queue, skb, tmp)                            \
3296                 for (skb = (queue)->prev, tmp = skb->prev;                      \
3297                      skb != (struct sk_buff *)(queue);                          \
3298                      skb = tmp, tmp = skb->prev)
3299
3300 #define skb_queue_reverse_walk_from_safe(queue, skb, tmp)                       \
3301                 for (tmp = skb->prev;                                           \
3302                      skb != (struct sk_buff *)(queue);                          \
3303                      skb = tmp, tmp = skb->prev)
3304
3305 static inline bool skb_has_frag_list(const struct sk_buff *skb)
3306 {
3307         return skb_shinfo(skb)->frag_list != NULL;
3308 }
3309
3310 static inline void skb_frag_list_init(struct sk_buff *skb)
3311 {
3312         skb_shinfo(skb)->frag_list = NULL;
3313 }
3314
3315 #define skb_walk_frags(skb, iter)       \
3316         for (iter = skb_shinfo(skb)->frag_list; iter; iter = iter->next)
3317
3318
3319 int __skb_wait_for_more_packets(struct sock *sk, int *err, long *timeo_p,
3320                                 const struct sk_buff *skb);
3321 struct sk_buff *__skb_try_recv_from_queue(struct sock *sk,
3322                                           struct sk_buff_head *queue,
3323                                           unsigned int flags,
3324                                           void (*destructor)(struct sock *sk,
3325                                                            struct sk_buff *skb),
3326                                           int *peeked, int *off, int *err,
3327                                           struct sk_buff **last);
3328 struct sk_buff *__skb_try_recv_datagram(struct sock *sk, unsigned flags,
3329                                         void (*destructor)(struct sock *sk,
3330                                                            struct sk_buff *skb),
3331                                         int *peeked, int *off, int *err,
3332                                         struct sk_buff **last);
3333 struct sk_buff *__skb_recv_datagram(struct sock *sk, unsigned flags,
3334                                     void (*destructor)(struct sock *sk,
3335                                                        struct sk_buff *skb),
3336                                     int *peeked, int *off, int *err);
3337 struct sk_buff *skb_recv_datagram(struct sock *sk, unsigned flags, int noblock,
3338                                   int *err);
3339 unsigned int datagram_poll(struct file *file, struct socket *sock,
3340                            struct poll_table_struct *wait);
3341 int skb_copy_datagram_iter(const struct sk_buff *from, int offset,
3342                            struct iov_iter *to, int size);
3343 static inline int skb_copy_datagram_msg(const struct sk_buff *from, int offset,
3344                                         struct msghdr *msg, int size)
3345 {
3346         return skb_copy_datagram_iter(from, offset, &msg->msg_iter, size);
3347 }
3348 int skb_copy_and_csum_datagram_msg(struct sk_buff *skb, int hlen,
3349                                    struct msghdr *msg);
3350 int skb_copy_datagram_from_iter(struct sk_buff *skb, int offset,
3351                                  struct iov_iter *from, int len);
3352 int zerocopy_sg_from_iter(struct sk_buff *skb, struct iov_iter *frm);
3353 void skb_free_datagram(struct sock *sk, struct sk_buff *skb);
3354 void __skb_free_datagram_locked(struct sock *sk, struct sk_buff *skb, int len);
3355 static inline void skb_free_datagram_locked(struct sock *sk,
3356                                             struct sk_buff *skb)
3357 {
3358         __skb_free_datagram_locked(sk, skb, 0);
3359 }
3360 int skb_kill_datagram(struct sock *sk, struct sk_buff *skb, unsigned int flags);
3361 int skb_copy_bits(const struct sk_buff *skb, int offset, void *to, int len);
3362 int skb_store_bits(struct sk_buff *skb, int offset, const void *from, int len);
3363 __wsum skb_copy_and_csum_bits(const struct sk_buff *skb, int offset, u8 *to,
3364                               int len, __wsum csum);
3365 int skb_splice_bits(struct sk_buff *skb, struct sock *sk, unsigned int offset,
3366                     struct pipe_inode_info *pipe, unsigned int len,
3367                     unsigned int flags);
3368 int skb_send_sock_locked(struct sock *sk, struct sk_buff *skb, int offset,
3369                          int len);
3370 int skb_send_sock(struct sock *sk, struct sk_buff *skb, int offset, int len);
3371 void skb_copy_and_csum_dev(const struct sk_buff *skb, u8 *to);
3372 unsigned int skb_zerocopy_headlen(const struct sk_buff *from);
3373 int skb_zerocopy(struct sk_buff *to, struct sk_buff *from,
3374                  int len, int hlen);
3375 void skb_split(struct sk_buff *skb, struct sk_buff *skb1, const u32 len);
3376 int skb_shift(struct sk_buff *tgt, struct sk_buff *skb, int shiftlen);
3377 void skb_scrub_packet(struct sk_buff *skb, bool xnet);
3378 unsigned int skb_gso_transport_seglen(const struct sk_buff *skb);
3379 bool skb_gso_validate_mtu(const struct sk_buff *skb, unsigned int mtu);
3380 bool skb_gso_validate_mac_len(const struct sk_buff *skb, unsigned int len);
3381 struct sk_buff *skb_segment(struct sk_buff *skb, netdev_features_t features);
3382 struct sk_buff *skb_vlan_untag(struct sk_buff *skb);
3383 int skb_ensure_writable(struct sk_buff *skb, int write_len);
3384 int __skb_vlan_pop(struct sk_buff *skb, u16 *vlan_tci);
3385 int skb_vlan_pop(struct sk_buff *skb);
3386 int skb_vlan_push(struct sk_buff *skb, __be16 vlan_proto, u16 vlan_tci);
3387 struct sk_buff *pskb_extract(struct sk_buff *skb, int off, int to_copy,
3388                              gfp_t gfp);
3389
3390 static inline int memcpy_from_msg(void *data, struct msghdr *msg, int len)
3391 {
3392         return copy_from_iter_full(data, len, &msg->msg_iter) ? 0 : -EFAULT;
3393 }
3394
3395 static inline int memcpy_to_msg(struct msghdr *msg, void *data, int len)
3396 {
3397         return copy_to_iter(data, len, &msg->msg_iter) == len ? 0 : -EFAULT;
3398 }
3399
3400 struct skb_checksum_ops {
3401         __wsum (*update)(const void *mem, int len, __wsum wsum);
3402         __wsum (*combine)(__wsum csum, __wsum csum2, int offset, int len);
3403 };
3404
3405 extern const struct skb_checksum_ops *crc32c_csum_stub __read_mostly;
3406
3407 __wsum __skb_checksum(const struct sk_buff *skb, int offset, int len,
3408                       __wsum csum, const struct skb_checksum_ops *ops);
3409 __wsum skb_checksum(const struct sk_buff *skb, int offset, int len,
3410                     __wsum csum);
3411
3412 static inline void * __must_check
3413 __skb_header_pointer(const struct sk_buff *skb, int offset,
3414                      int len, void *data, int hlen, void *buffer)
3415 {
3416         if (hlen - offset >= len)
3417                 return data + offset;
3418
3419         if (!skb ||
3420             skb_copy_bits(skb, offset, buffer, len) < 0)
3421                 return NULL;
3422
3423         return buffer;
3424 }
3425
3426 static inline void * __must_check
3427 skb_header_pointer(const struct sk_buff *skb, int offset, int len, void *buffer)
3428 {
3429         return __skb_header_pointer(skb, offset, len, skb->data,
3430                                     skb_headlen(skb), buffer);
3431 }
3432
3433 /**
3434  *      skb_needs_linearize - check if we need to linearize a given skb
3435  *                            depending on the given device features.
3436  *      @skb: socket buffer to check
3437  *      @features: net device features
3438  *
3439  *      Returns true if either:
3440  *      1. skb has frag_list and the device doesn't support FRAGLIST, or
3441  *      2. skb is fragmented and the device does not support SG.
3442  */
3443 static inline bool skb_needs_linearize(struct sk_buff *skb,
3444                                        netdev_features_t features)
3445 {
3446         return skb_is_nonlinear(skb) &&
3447                ((skb_has_frag_list(skb) && !(features & NETIF_F_FRAGLIST)) ||
3448                 (skb_shinfo(skb)->nr_frags && !(features & NETIF_F_SG)));
3449 }
3450
3451 static inline void skb_copy_from_linear_data(const struct sk_buff *skb,
3452                                              void *to,
3453                                              const unsigned int len)
3454 {
3455         memcpy(to, skb->data, len);
3456 }
3457
3458 static inline void skb_copy_from_linear_data_offset(const struct sk_buff *skb,
3459                                                     const int offset, void *to,
3460                                                     const unsigned int len)
3461 {
3462         memcpy(to, skb->data + offset, len);
3463 }
3464
3465 static inline void skb_copy_to_linear_data(struct sk_buff *skb,
3466                                            const void *from,
3467                                            const unsigned int len)
3468 {
3469         memcpy(skb->data, from, len);
3470 }
3471
3472 static inline void skb_copy_to_linear_data_offset(struct sk_buff *skb,
3473                                                   const int offset,
3474                                                   const void *from,
3475                                                   const unsigned int len)
3476 {
3477         memcpy(skb->data + offset, from, len);
3478 }
3479
3480 void skb_init(void);
3481
3482 static inline ktime_t skb_get_ktime(const struct sk_buff *skb)
3483 {
3484         return skb->tstamp;
3485 }
3486
3487 /**
3488  *      skb_get_timestamp - get timestamp from a skb
3489  *      @skb: skb to get stamp from
3490  *      @stamp: pointer to struct timeval to store stamp in
3491  *
3492  *      Timestamps are stored in the skb as offsets to a base timestamp.
3493  *      This function converts the offset back to a struct timeval and stores
3494  *      it in stamp.
3495  */
3496 static inline void skb_get_timestamp(const struct sk_buff *skb,
3497                                      struct timeval *stamp)
3498 {
3499         *stamp = ktime_to_timeval(skb->tstamp);
3500 }
3501
3502 static inline void skb_get_timestampns(const struct sk_buff *skb,
3503                                        struct timespec *stamp)
3504 {
3505         *stamp = ktime_to_timespec(skb->tstamp);
3506 }
3507
3508 static inline void __net_timestamp(struct sk_buff *skb)
3509 {
3510         skb->tstamp = ktime_get_real();
3511 }
3512
3513 static inline ktime_t net_timedelta(ktime_t t)
3514 {
3515         return ktime_sub(ktime_get_real(), t);
3516 }
3517
3518 static inline ktime_t net_invalid_timestamp(void)
3519 {
3520         return 0;
3521 }
3522
3523 struct sk_buff *skb_clone_sk(struct sk_buff *skb);
3524
3525 #ifdef CONFIG_NETWORK_PHY_TIMESTAMPING
3526
3527 void skb_clone_tx_timestamp(struct sk_buff *skb);
3528 bool skb_defer_rx_timestamp(struct sk_buff *skb);
3529
3530 #else /* CONFIG_NETWORK_PHY_TIMESTAMPING */
3531
3532 static inline void skb_clone_tx_timestamp(struct sk_buff *skb)
3533 {
3534 }
3535
3536 static inline bool skb_defer_rx_timestamp(struct sk_buff *skb)
3537 {
3538         return false;
3539 }
3540
3541 #endif /* !CONFIG_NETWORK_PHY_TIMESTAMPING */
3542
3543 /**
3544  * skb_complete_tx_timestamp() - deliver cloned skb with tx timestamps
3545  *
3546  * PHY drivers may accept clones of transmitted packets for
3547  * timestamping via their phy_driver.txtstamp method. These drivers
3548  * must call this function to return the skb back to the stack with a
3549  * timestamp.
3550  *
3551  * @skb: clone of the the original outgoing packet
3552  * @hwtstamps: hardware time stamps
3553  *
3554  */
3555 void skb_complete_tx_timestamp(struct sk_buff *skb,
3556                                struct skb_shared_hwtstamps *hwtstamps);
3557
3558 void __skb_tstamp_tx(struct sk_buff *orig_skb,
3559                      struct skb_shared_hwtstamps *hwtstamps,
3560                      struct sock *sk, int tstype);
3561
3562 /**
3563  * skb_tstamp_tx - queue clone of skb with send time stamps
3564  * @orig_skb:   the original outgoing packet
3565  * @hwtstamps:  hardware time stamps, may be NULL if not available
3566  *
3567  * If the skb has a socket associated, then this function clones the
3568  * skb (thus sharing the actual data and optional structures), stores
3569  * the optional hardware time stamping information (if non NULL) or
3570  * generates a software time stamp (otherwise), then queues the clone
3571  * to the error queue of the socket.  Errors are silently ignored.
3572  */
3573 void skb_tstamp_tx(struct sk_buff *orig_skb,
3574                    struct skb_shared_hwtstamps *hwtstamps);
3575
3576 /**
3577  * skb_tx_timestamp() - Driver hook for transmit timestamping
3578  *
3579  * Ethernet MAC Drivers should call this function in their hard_xmit()
3580  * function immediately before giving the sk_buff to the MAC hardware.
3581  *
3582  * Specifically, one should make absolutely sure that this function is
3583  * called before TX completion of this packet can trigger.  Otherwise
3584  * the packet could potentially already be freed.
3585  *
3586  * @skb: A socket buffer.
3587  */
3588 static inline void skb_tx_timestamp(struct sk_buff *skb)
3589 {
3590         skb_clone_tx_timestamp(skb);
3591         if (skb_shinfo(skb)->tx_flags & SKBTX_SW_TSTAMP)
3592                 skb_tstamp_tx(skb, NULL);
3593 }
3594
3595 /**
3596  * skb_complete_wifi_ack - deliver skb with wifi status
3597  *
3598  * @skb: the original outgoing packet
3599  * @acked: ack status
3600  *
3601  */
3602 void skb_complete_wifi_ack(struct sk_buff *skb, bool acked);
3603
3604 __sum16 __skb_checksum_complete_head(struct sk_buff *skb, int len);
3605 __sum16 __skb_checksum_complete(struct sk_buff *skb);
3606
3607 static inline int skb_csum_unnecessary(const struct sk_buff *skb)
3608 {
3609         return ((skb->ip_summed == CHECKSUM_UNNECESSARY) ||
3610                 skb->csum_valid ||
3611                 (skb->ip_summed == CHECKSUM_PARTIAL &&
3612                  skb_checksum_start_offset(skb) >= 0));
3613 }
3614
3615 /**
3616  *      skb_checksum_complete - Calculate checksum of an entire packet
3617  *      @skb: packet to process
3618  *
3619  *      This function calculates the checksum over the entire packet plus
3620  *      the value of skb->csum.  The latter can be used to supply the
3621  *      checksum of a pseudo header as used by TCP/UDP.  It returns the
3622  *      checksum.
3623  *
3624  *      For protocols that contain complete checksums such as ICMP/TCP/UDP,
3625  *      this function can be used to verify that checksum on received
3626  *      packets.  In that case the function should return zero if the
3627  *      checksum is correct.  In particular, this function will return zero
3628  *      if skb->ip_summed is CHECKSUM_UNNECESSARY which indicates that the
3629  *      hardware has already verified the correctness of the checksum.
3630  */
3631 static inline __sum16 skb_checksum_complete(struct sk_buff *skb)
3632 {
3633         return skb_csum_unnecessary(skb) ?
3634                0 : __skb_checksum_complete(skb);
3635 }
3636
3637 static inline void __skb_decr_checksum_unnecessary(struct sk_buff *skb)
3638 {
3639         if (skb->ip_summed == CHECKSUM_UNNECESSARY) {
3640                 if (skb->csum_level == 0)
3641                         skb->ip_summed = CHECKSUM_NONE;
3642                 else
3643                         skb->csum_level--;
3644         }
3645 }
3646
3647 static inline void __skb_incr_checksum_unnecessary(struct sk_buff *skb)
3648 {
3649         if (skb->ip_summed == CHECKSUM_UNNECESSARY) {
3650                 if (skb->csum_level < SKB_MAX_CSUM_LEVEL)
3651                         skb->csum_level++;
3652         } else if (skb->ip_summed == CHECKSUM_NONE) {
3653                 skb->ip_summed = CHECKSUM_UNNECESSARY;
3654                 skb->csum_level = 0;
3655         }
3656 }
3657
3658 /* Check if we need to perform checksum complete validation.
3659  *
3660  * Returns true if checksum complete is needed, false otherwise
3661  * (either checksum is unnecessary or zero checksum is allowed).
3662  */
3663 static inline bool __skb_checksum_validate_needed(struct sk_buff *skb,
3664                                                   bool zero_okay,
3665                                                   __sum16 check)
3666 {
3667         if (skb_csum_unnecessary(skb) || (zero_okay && !check)) {
3668                 skb->csum_valid = 1;
3669                 __skb_decr_checksum_unnecessary(skb);
3670                 return false;
3671         }
3672
3673         return true;
3674 }
3675
3676 /* For small packets <= CHECKSUM_BREAK peform checksum complete directly
3677  * in checksum_init.
3678  */
3679 #define CHECKSUM_BREAK 76
3680
3681 /* Unset checksum-complete
3682  *
3683  * Unset checksum complete can be done when packet is being modified
3684  * (uncompressed for instance) and checksum-complete value is
3685  * invalidated.
3686  */
3687 static inline void skb_checksum_complete_unset(struct sk_buff *skb)
3688 {
3689         if (skb->ip_summed == CHECKSUM_COMPLETE)
3690                 skb->ip_summed = CHECKSUM_NONE;
3691 }
3692
3693 /* Validate (init) checksum based on checksum complete.
3694  *
3695  * Return values:
3696  *   0: checksum is validated or try to in skb_checksum_complete. In the latter
3697  *      case the ip_summed will not be CHECKSUM_UNNECESSARY and the pseudo
3698  *      checksum is stored in skb->csum for use in __skb_checksum_complete
3699  *   non-zero: value of invalid checksum
3700  *
3701  */
3702 static inline __sum16 __skb_checksum_validate_complete(struct sk_buff *skb,
3703                                                        bool complete,
3704                                                        __wsum psum)
3705 {
3706         if (skb->ip_summed == CHECKSUM_COMPLETE) {
3707                 if (!csum_fold(csum_add(psum, skb->csum))) {
3708                         skb->csum_valid = 1;
3709                         return 0;
3710                 }
3711         }
3712
3713         skb->csum = psum;
3714
3715         if (complete || skb->len <= CHECKSUM_BREAK) {
3716                 __sum16 csum;
3717
3718                 csum = __skb_checksum_complete(skb);
3719                 skb->csum_valid = !csum;
3720                 return csum;
3721         }
3722
3723         return 0;
3724 }
3725
3726 static inline __wsum null_compute_pseudo(struct sk_buff *skb, int proto)
3727 {
3728         return 0;
3729 }
3730
3731 /* Perform checksum validate (init). Note that this is a macro since we only
3732  * want to calculate the pseudo header which is an input function if necessary.
3733  * First we try to validate without any computation (checksum unnecessary) and
3734  * then calculate based on checksum complete calling the function to compute
3735  * pseudo header.
3736  *
3737  * Return values:
3738  *   0: checksum is validated or try to in skb_checksum_complete
3739  *   non-zero: value of invalid checksum
3740  */
3741 #define __skb_checksum_validate(skb, proto, complete,                   \
3742                                 zero_okay, check, compute_pseudo)       \
3743 ({                                                                      \
3744         __sum16 __ret = 0;                                              \
3745         skb->csum_valid = 0;                                            \
3746         if (__skb_checksum_validate_needed(skb, zero_okay, check))      \
3747                 __ret = __skb_checksum_validate_complete(skb,           \
3748                                 complete, compute_pseudo(skb, proto));  \
3749         __ret;                                                          \
3750 })
3751
3752 #define skb_checksum_init(skb, proto, compute_pseudo)                   \
3753         __skb_checksum_validate(skb, proto, false, false, 0, compute_pseudo)
3754
3755 #define skb_checksum_init_zero_check(skb, proto, check, compute_pseudo) \
3756         __skb_checksum_validate(skb, proto, false, true, check, compute_pseudo)
3757
3758 #define skb_checksum_validate(skb, proto, compute_pseudo)               \
3759         __skb_checksum_validate(skb, proto, true, false, 0, compute_pseudo)
3760
3761 #define skb_checksum_validate_zero_check(skb, proto, check,             \
3762                                          compute_pseudo)                \
3763         __skb_checksum_validate(skb, proto, true, true, check, compute_pseudo)
3764
3765 #define skb_checksum_simple_validate(skb)                               \
3766         __skb_checksum_validate(skb, 0, true, false, 0, null_compute_pseudo)
3767
3768 static inline bool __skb_checksum_convert_check(struct sk_buff *skb)
3769 {
3770         return (skb->ip_summed == CHECKSUM_NONE && skb->csum_valid);
3771 }
3772
3773 static inline void __skb_checksum_convert(struct sk_buff *skb,
3774                                           __sum16 check, __wsum pseudo)
3775 {
3776         skb->csum = ~pseudo;
3777         skb->ip_summed = CHECKSUM_COMPLETE;
3778 }
3779
3780 #define skb_checksum_try_convert(skb, proto, check, compute_pseudo)     \
3781 do {                                                                    \
3782         if (__skb_checksum_convert_check(skb))                          \
3783                 __skb_checksum_convert(skb, check,                      \
3784                                        compute_pseudo(skb, proto));     \
3785 } while (0)
3786
3787 static inline void skb_remcsum_adjust_partial(struct sk_buff *skb, void *ptr,
3788                                               u16 start, u16 offset)
3789 {
3790         skb->ip_summed = CHECKSUM_PARTIAL;
3791         skb->csum_start = ((unsigned char *)ptr + start) - skb->head;
3792         skb->csum_offset = offset - start;
3793 }
3794
3795 /* Update skbuf and packet to reflect the remote checksum offload operation.
3796  * When called, ptr indicates the starting point for skb->csum when
3797  * ip_summed is CHECKSUM_COMPLETE. If we need create checksum complete
3798  * here, skb_postpull_rcsum is done so skb->csum start is ptr.
3799  */
3800 static inline void skb_remcsum_process(struct sk_buff *skb, void *ptr,
3801                                        int start, int offset, bool nopartial)
3802 {
3803         __wsum delta;
3804
3805         if (!nopartial) {
3806                 skb_remcsum_adjust_partial(skb, ptr, start, offset);
3807                 return;
3808         }
3809
3810          if (unlikely(skb->ip_summed != CHECKSUM_COMPLETE)) {
3811                 __skb_checksum_complete(skb);
3812                 skb_postpull_rcsum(skb, skb->data, ptr - (void *)skb->data);
3813         }
3814
3815         delta = remcsum_adjust(ptr, skb->csum, start, offset);
3816
3817         /* Adjust skb->csum since we changed the packet */
3818         skb->csum = csum_add(skb->csum, delta);
3819 }
3820
3821 static inline struct nf_conntrack *skb_nfct(const struct sk_buff *skb)
3822 {
3823 #if IS_ENABLED(CONFIG_NF_CONNTRACK)
3824         return (void *)(skb->_nfct & SKB_NFCT_PTRMASK);
3825 #else
3826         return NULL;
3827 #endif
3828 }
3829
3830 #if defined(CONFIG_NF_CONNTRACK) || defined(CONFIG_NF_CONNTRACK_MODULE)
3831 void nf_conntrack_destroy(struct nf_conntrack *nfct);
3832 static inline void nf_conntrack_put(struct nf_conntrack *nfct)
3833 {
3834         if (nfct && atomic_dec_and_test(&nfct->use))
3835                 nf_conntrack_destroy(nfct);
3836 }
3837 static inline void nf_conntrack_get(struct nf_conntrack *nfct)
3838 {
3839         if (nfct)
3840                 atomic_inc(&nfct->use);
3841 }
3842 #endif
3843 #if IS_ENABLED(CONFIG_BRIDGE_NETFILTER)
3844 static inline void nf_bridge_put(struct nf_bridge_info *nf_bridge)
3845 {
3846         if (nf_bridge && refcount_dec_and_test(&nf_bridge->use))
3847                 kfree(nf_bridge);
3848 }
3849 static inline void nf_bridge_get(struct nf_bridge_info *nf_bridge)
3850 {
3851         if (nf_bridge)
3852                 refcount_inc(&nf_bridge->use);
3853 }
3854 #endif /* CONFIG_BRIDGE_NETFILTER */
3855 static inline void nf_reset(struct sk_buff *skb)
3856 {
3857 #if defined(CONFIG_NF_CONNTRACK) || defined(CONFIG_NF_CONNTRACK_MODULE)
3858         nf_conntrack_put(skb_nfct(skb));
3859         skb->_nfct = 0;
3860 #endif
3861 #if IS_ENABLED(CONFIG_BRIDGE_NETFILTER)
3862         nf_bridge_put(skb->nf_bridge);
3863         skb->nf_bridge = NULL;
3864 #endif
3865 }
3866
3867 static inline void nf_reset_trace(struct sk_buff *skb)
3868 {
3869 #if IS_ENABLED(CONFIG_NETFILTER_XT_TARGET_TRACE) || defined(CONFIG_NF_TABLES)
3870         skb->nf_trace = 0;
3871 #endif
3872 }
3873
3874 static inline void ipvs_reset(struct sk_buff *skb)
3875 {
3876 #if IS_ENABLED(CONFIG_IP_VS)
3877         skb->ipvs_property = 0;
3878 #endif
3879 }
3880
3881 /* Note: This doesn't put any conntrack and bridge info in dst. */
3882 static inline void __nf_copy(struct sk_buff *dst, const struct sk_buff *src,
3883                              bool copy)
3884 {
3885 #if defined(CONFIG_NF_CONNTRACK) || defined(CONFIG_NF_CONNTRACK_MODULE)
3886         dst->_nfct = src->_nfct;
3887         nf_conntrack_get(skb_nfct(src));
3888 #endif
3889 #if IS_ENABLED(CONFIG_BRIDGE_NETFILTER)
3890         dst->nf_bridge  = src->nf_bridge;
3891         nf_bridge_get(src->nf_bridge);
3892 #endif
3893 #if IS_ENABLED(CONFIG_NETFILTER_XT_TARGET_TRACE) || defined(CONFIG_NF_TABLES)
3894         if (copy)
3895                 dst->nf_trace = src->nf_trace;
3896 #endif
3897 }
3898
3899 static inline void nf_copy(struct sk_buff *dst, const struct sk_buff *src)
3900 {
3901 #if defined(CONFIG_NF_CONNTRACK) || defined(CONFIG_NF_CONNTRACK_MODULE)
3902         nf_conntrack_put(skb_nfct(dst));
3903 #endif
3904 #if IS_ENABLED(CONFIG_BRIDGE_NETFILTER)
3905         nf_bridge_put(dst->nf_bridge);
3906 #endif
3907         __nf_copy(dst, src, true);
3908 }
3909
3910 #ifdef CONFIG_NETWORK_SECMARK
3911 static inline void skb_copy_secmark(struct sk_buff *to, const struct sk_buff *from)
3912 {
3913         to->secmark = from->secmark;
3914 }
3915
3916 static inline void skb_init_secmark(struct sk_buff *skb)
3917 {
3918         skb->secmark = 0;
3919 }
3920 #else
3921 static inline void skb_copy_secmark(struct sk_buff *to, const struct sk_buff *from)
3922 { }
3923
3924 static inline void skb_init_secmark(struct sk_buff *skb)
3925 { }
3926 #endif
3927
3928 static inline bool skb_irq_freeable(const struct sk_buff *skb)
3929 {
3930         return !skb->destructor &&
3931 #if IS_ENABLED(CONFIG_XFRM)
3932                 !skb->sp &&
3933 #endif
3934                 !skb_nfct(skb) &&
3935                 !skb->_skb_refdst &&
3936                 !skb_has_frag_list(skb);
3937 }
3938
3939 static inline void skb_set_queue_mapping(struct sk_buff *skb, u16 queue_mapping)
3940 {
3941         skb->queue_mapping = queue_mapping;
3942 }
3943
3944 static inline u16 skb_get_queue_mapping(const struct sk_buff *skb)
3945 {
3946         return skb->queue_mapping;
3947 }
3948
3949 static inline void skb_copy_queue_mapping(struct sk_buff *to, const struct sk_buff *from)
3950 {
3951         to->queue_mapping = from->queue_mapping;
3952 }
3953
3954 static inline void skb_record_rx_queue(struct sk_buff *skb, u16 rx_queue)
3955 {
3956         skb->queue_mapping = rx_queue + 1;
3957 }
3958
3959 static inline u16 skb_get_rx_queue(const struct sk_buff *skb)
3960 {
3961         return skb->queue_mapping - 1;
3962 }
3963
3964 static inline bool skb_rx_queue_recorded(const struct sk_buff *skb)
3965 {
3966         return skb->queue_mapping != 0;
3967 }
3968
3969 static inline void skb_set_dst_pending_confirm(struct sk_buff *skb, u32 val)
3970 {
3971         skb->dst_pending_confirm = val;
3972 }
3973
3974 static inline bool skb_get_dst_pending_confirm(const struct sk_buff *skb)
3975 {
3976         return skb->dst_pending_confirm != 0;
3977 }
3978
3979 static inline struct sec_path *skb_sec_path(struct sk_buff *skb)
3980 {
3981 #ifdef CONFIG_XFRM
3982         return skb->sp;
3983 #else
3984         return NULL;
3985 #endif
3986 }
3987
3988 /* Keeps track of mac header offset relative to skb->head.
3989  * It is useful for TSO of Tunneling protocol. e.g. GRE.
3990  * For non-tunnel skb it points to skb_mac_header() and for
3991  * tunnel skb it points to outer mac header.
3992  * Keeps track of level of encapsulation of network headers.
3993  */
3994 struct skb_gso_cb {
3995         union {
3996                 int     mac_offset;
3997                 int     data_offset;
3998         };
3999         int     encap_level;
4000         __wsum  csum;
4001         __u16   csum_start;
4002 };
4003 #define SKB_SGO_CB_OFFSET       32
4004 #define SKB_GSO_CB(skb) ((struct skb_gso_cb *)((skb)->cb + SKB_SGO_CB_OFFSET))
4005
4006 static inline int skb_tnl_header_len(const struct sk_buff *inner_skb)
4007 {
4008         return (skb_mac_header(inner_skb) - inner_skb->head) -
4009                 SKB_GSO_CB(inner_skb)->mac_offset;
4010 }
4011
4012 static inline int gso_pskb_expand_head(struct sk_buff *skb, int extra)
4013 {
4014         int new_headroom, headroom;
4015         int ret;
4016
4017         headroom = skb_headroom(skb);
4018         ret = pskb_expand_head(skb, extra, 0, GFP_ATOMIC);
4019         if (ret)
4020                 return ret;
4021
4022         new_headroom = skb_headroom(skb);
4023         SKB_GSO_CB(skb)->mac_offset += (new_headroom - headroom);
4024         return 0;
4025 }
4026
4027 static inline void gso_reset_checksum(struct sk_buff *skb, __wsum res)
4028 {
4029         /* Do not update partial checksums if remote checksum is enabled. */
4030         if (skb->remcsum_offload)
4031                 return;
4032
4033         SKB_GSO_CB(skb)->csum = res;
4034         SKB_GSO_CB(skb)->csum_start = skb_checksum_start(skb) - skb->head;
4035 }
4036
4037 /* Compute the checksum for a gso segment. First compute the checksum value
4038  * from the start of transport header to SKB_GSO_CB(skb)->csum_start, and
4039  * then add in skb->csum (checksum from csum_start to end of packet).
4040  * skb->csum and csum_start are then updated to reflect the checksum of the
4041  * resultant packet starting from the transport header-- the resultant checksum
4042  * is in the res argument (i.e. normally zero or ~ of checksum of a pseudo
4043  * header.
4044  */
4045 static inline __sum16 gso_make_checksum(struct sk_buff *skb, __wsum res)
4046 {
4047         unsigned char *csum_start = skb_transport_header(skb);
4048         int plen = (skb->head + SKB_GSO_CB(skb)->csum_start) - csum_start;
4049         __wsum partial = SKB_GSO_CB(skb)->csum;
4050
4051         SKB_GSO_CB(skb)->csum = res;
4052         SKB_GSO_CB(skb)->csum_start = csum_start - skb->head;
4053
4054         return csum_fold(csum_partial(csum_start, plen, partial));
4055 }
4056
4057 static inline bool skb_is_gso(const struct sk_buff *skb)
4058 {
4059         return skb_shinfo(skb)->gso_size;
4060 }
4061
4062 /* Note: Should be called only if skb_is_gso(skb) is true */
4063 static inline bool skb_is_gso_v6(const struct sk_buff *skb)
4064 {
4065         return skb_shinfo(skb)->gso_type & SKB_GSO_TCPV6;
4066 }
4067
4068 static inline void skb_gso_reset(struct sk_buff *skb)
4069 {
4070         skb_shinfo(skb)->gso_size = 0;
4071         skb_shinfo(skb)->gso_segs = 0;
4072         skb_shinfo(skb)->gso_type = 0;
4073 }
4074
4075 void __skb_warn_lro_forwarding(const struct sk_buff *skb);
4076
4077 static inline bool skb_warn_if_lro(const struct sk_buff *skb)
4078 {
4079         /* LRO sets gso_size but not gso_type, whereas if GSO is really
4080          * wanted then gso_type will be set. */
4081         const struct skb_shared_info *shinfo = skb_shinfo(skb);
4082
4083         if (skb_is_nonlinear(skb) && shinfo->gso_size != 0 &&
4084             unlikely(shinfo->gso_type == 0)) {
4085                 __skb_warn_lro_forwarding(skb);
4086                 return true;
4087         }
4088         return false;
4089 }
4090
4091 static inline void skb_forward_csum(struct sk_buff *skb)
4092 {
4093         /* Unfortunately we don't support this one.  Any brave souls? */
4094         if (skb->ip_summed == CHECKSUM_COMPLETE)
4095                 skb->ip_summed = CHECKSUM_NONE;
4096 }
4097
4098 /**
4099  * skb_checksum_none_assert - make sure skb ip_summed is CHECKSUM_NONE
4100  * @skb: skb to check
4101  *
4102  * fresh skbs have their ip_summed set to CHECKSUM_NONE.
4103  * Instead of forcing ip_summed to CHECKSUM_NONE, we can
4104  * use this helper, to document places where we make this assertion.
4105  */
4106 static inline void skb_checksum_none_assert(const struct sk_buff *skb)
4107 {
4108 #ifdef DEBUG
4109         BUG_ON(skb->ip_summed != CHECKSUM_NONE);
4110 #endif
4111 }
4112
4113 bool skb_partial_csum_set(struct sk_buff *skb, u16 start, u16 off);
4114
4115 int skb_checksum_setup(struct sk_buff *skb, bool recalculate);
4116 struct sk_buff *skb_checksum_trimmed(struct sk_buff *skb,
4117                                      unsigned int transport_len,
4118                                      __sum16(*skb_chkf)(struct sk_buff *skb));
4119
4120 /**
4121  * skb_head_is_locked - Determine if the skb->head is locked down
4122  * @skb: skb to check
4123  *
4124  * The head on skbs build around a head frag can be removed if they are
4125  * not cloned.  This function returns true if the skb head is locked down
4126  * due to either being allocated via kmalloc, or by being a clone with
4127  * multiple references to the head.
4128  */
4129 static inline bool skb_head_is_locked(const struct sk_buff *skb)
4130 {
4131         return !skb->head_frag || skb_cloned(skb);
4132 }
4133
4134 /**
4135  * skb_gso_network_seglen - Return length of individual segments of a gso packet
4136  *
4137  * @skb: GSO skb
4138  *
4139  * skb_gso_network_seglen is used to determine the real size of the
4140  * individual segments, including Layer3 (IP, IPv6) and L4 headers (TCP/UDP).
4141  *
4142  * The MAC/L2 header is not accounted for.
4143  */
4144 static inline unsigned int skb_gso_network_seglen(const struct sk_buff *skb)
4145 {
4146         unsigned int hdr_len = skb_transport_header(skb) -
4147                                skb_network_header(skb);
4148         return hdr_len + skb_gso_transport_seglen(skb);
4149 }
4150
4151 /**
4152  * skb_gso_mac_seglen - Return length of individual segments of a gso packet
4153  *
4154  * @skb: GSO skb
4155  *
4156  * skb_gso_mac_seglen is used to determine the real size of the
4157  * individual segments, including MAC/L2, Layer3 (IP, IPv6) and L4
4158  * headers (TCP/UDP).
4159  */
4160 static inline unsigned int skb_gso_mac_seglen(const struct sk_buff *skb)
4161 {
4162         unsigned int hdr_len = skb_transport_header(skb) - skb_mac_header(skb);
4163         return hdr_len + skb_gso_transport_seglen(skb);
4164 }
4165
4166 /* Local Checksum Offload.
4167  * Compute outer checksum based on the assumption that the
4168  * inner checksum will be offloaded later.
4169  * See Documentation/networking/checksum-offloads.txt for
4170  * explanation of how this works.
4171  * Fill in outer checksum adjustment (e.g. with sum of outer
4172  * pseudo-header) before calling.
4173  * Also ensure that inner checksum is in linear data area.
4174  */
4175 static inline __wsum lco_csum(struct sk_buff *skb)
4176 {
4177         unsigned char *csum_start = skb_checksum_start(skb);
4178         unsigned char *l4_hdr = skb_transport_header(skb);
4179         __wsum partial;
4180
4181         /* Start with complement of inner checksum adjustment */
4182         partial = ~csum_unfold(*(__force __sum16 *)(csum_start +
4183                                                     skb->csum_offset));
4184
4185         /* Add in checksum of our headers (incl. outer checksum
4186          * adjustment filled in by caller) and return result.
4187          */
4188         return csum_partial(l4_hdr, csum_start - l4_hdr, partial);
4189 }
4190
4191 #endif  /* __KERNEL__ */
4192 #endif  /* _LINUX_SKBUFF_H */