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