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