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