1b4ea29d3943d871932f92b836cf0e2f303d2e2a
[pandora-kernel.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/cache.h>
22
23 #include <linux/atomic.h>
24 #include <asm/types.h>
25 #include <linux/spinlock.h>
26 #include <linux/net.h>
27 #include <linux/textsearch.h>
28 #include <net/checksum.h>
29 #include <linux/rcupdate.h>
30 #include <linux/dmaengine.h>
31 #include <linux/hrtimer.h>
32 #include <linux/dma-mapping.h>
33
34 /* Don't change this without changing skb_csum_unnecessary! */
35 #define CHECKSUM_NONE 0
36 #define CHECKSUM_UNNECESSARY 1
37 #define CHECKSUM_COMPLETE 2
38 #define CHECKSUM_PARTIAL 3
39
40 #define SKB_DATA_ALIGN(X)       (((X) + (SMP_CACHE_BYTES - 1)) & \
41                                  ~(SMP_CACHE_BYTES - 1))
42 #define SKB_WITH_OVERHEAD(X)    \
43         ((X) - SKB_DATA_ALIGN(sizeof(struct skb_shared_info)))
44 #define SKB_MAX_ORDER(X, ORDER) \
45         SKB_WITH_OVERHEAD((PAGE_SIZE << (ORDER)) - (X))
46 #define SKB_MAX_HEAD(X)         (SKB_MAX_ORDER((X), 0))
47 #define SKB_MAX_ALLOC           (SKB_MAX_ORDER(0, 2))
48
49 /* return minimum truesize of one skb containing X bytes of data */
50 #define SKB_TRUESIZE(X) ((X) +                                          \
51                          SKB_DATA_ALIGN(sizeof(struct sk_buff)) +       \
52                          SKB_DATA_ALIGN(sizeof(struct skb_shared_info)))
53
54 /* A. Checksumming of received packets by device.
55  *
56  *      NONE: device failed to checksum this packet.
57  *              skb->csum is undefined.
58  *
59  *      UNNECESSARY: device parsed packet and wouldbe verified checksum.
60  *              skb->csum is undefined.
61  *            It is bad option, but, unfortunately, many of vendors do this.
62  *            Apparently with secret goal to sell you new device, when you
63  *            will add new protocol to your host. F.e. IPv6. 8)
64  *
65  *      COMPLETE: the most generic way. Device supplied checksum of _all_
66  *          the packet as seen by netif_rx in skb->csum.
67  *          NOTE: Even if device supports only some protocols, but
68  *          is able to produce some skb->csum, it MUST use COMPLETE,
69  *          not UNNECESSARY.
70  *
71  *      PARTIAL: identical to the case for output below.  This may occur
72  *          on a packet received directly from another Linux OS, e.g.,
73  *          a virtualised Linux kernel on the same host.  The packet can
74  *          be treated in the same way as UNNECESSARY except that on
75  *          output (i.e., forwarding) the checksum must be filled in
76  *          by the OS or the hardware.
77  *
78  * B. Checksumming on output.
79  *
80  *      NONE: skb is checksummed by protocol or csum is not required.
81  *
82  *      PARTIAL: device is required to csum packet as seen by hard_start_xmit
83  *      from skb->csum_start to the end and to record the checksum
84  *      at skb->csum_start + skb->csum_offset.
85  *
86  *      Device must show its capabilities in dev->features, set
87  *      at device setup time.
88  *      NETIF_F_HW_CSUM - it is clever device, it is able to checksum
89  *                        everything.
90  *      NETIF_F_NO_CSUM - loopback or reliable single hop media.
91  *      NETIF_F_IP_CSUM - device is dumb. It is able to csum only
92  *                        TCP/UDP over IPv4. Sigh. Vendors like this
93  *                        way by an unknown reason. Though, see comment above
94  *                        about CHECKSUM_UNNECESSARY. 8)
95  *      NETIF_F_IPV6_CSUM about as dumb as the last one but does IPv6 instead.
96  *
97  *      Any questions? No questions, good.              --ANK
98  */
99
100 struct net_device;
101 struct scatterlist;
102 struct pipe_inode_info;
103
104 #if defined(CONFIG_NF_CONNTRACK) || defined(CONFIG_NF_CONNTRACK_MODULE)
105 struct nf_conntrack {
106         atomic_t use;
107 };
108 #endif
109
110 #ifdef CONFIG_BRIDGE_NETFILTER
111 struct nf_bridge_info {
112         atomic_t use;
113         struct net_device *physindev;
114         struct net_device *physoutdev;
115         unsigned int mask;
116         unsigned long data[32 / sizeof(unsigned long)];
117 };
118 #endif
119
120 struct sk_buff_head {
121         /* These two members must be first. */
122         struct sk_buff  *next;
123         struct sk_buff  *prev;
124
125         __u32           qlen;
126         spinlock_t      lock;
127 };
128
129 struct sk_buff;
130
131 /* To allow 64K frame to be packed as single skb without frag_list. Since
132  * GRO uses frags we allocate at least 16 regardless of page size.
133  */
134 #if (65536/PAGE_SIZE + 2) < 16
135 #define MAX_SKB_FRAGS 16UL
136 #else
137 #define MAX_SKB_FRAGS (65536/PAGE_SIZE + 2)
138 #endif
139
140 typedef struct skb_frag_struct skb_frag_t;
141
142 struct skb_frag_struct {
143         struct {
144                 struct page *p;
145         } page;
146 #if (BITS_PER_LONG > 32) || (PAGE_SIZE >= 65536)
147         __u32 page_offset;
148         __u32 size;
149 #else
150         __u16 page_offset;
151         __u16 size;
152 #endif
153 };
154
155 static inline unsigned int skb_frag_size(const skb_frag_t *frag)
156 {
157         return frag->size;
158 }
159
160 static inline void skb_frag_size_set(skb_frag_t *frag, unsigned int size)
161 {
162         frag->size = size;
163 }
164
165 static inline void skb_frag_size_add(skb_frag_t *frag, int delta)
166 {
167         frag->size += delta;
168 }
169
170 static inline void skb_frag_size_sub(skb_frag_t *frag, int delta)
171 {
172         frag->size -= delta;
173 }
174
175 #define HAVE_HW_TIME_STAMP
176
177 /**
178  * struct skb_shared_hwtstamps - hardware time stamps
179  * @hwtstamp:   hardware time stamp transformed into duration
180  *              since arbitrary point in time
181  * @syststamp:  hwtstamp transformed to system time base
182  *
183  * Software time stamps generated by ktime_get_real() are stored in
184  * skb->tstamp. The relation between the different kinds of time
185  * stamps is as follows:
186  *
187  * syststamp and tstamp can be compared against each other in
188  * arbitrary combinations.  The accuracy of a
189  * syststamp/tstamp/"syststamp from other device" comparison is
190  * limited by the accuracy of the transformation into system time
191  * base. This depends on the device driver and its underlying
192  * hardware.
193  *
194  * hwtstamps can only be compared against other hwtstamps from
195  * the same device.
196  *
197  * This structure is attached to packets as part of the
198  * &skb_shared_info. Use skb_hwtstamps() to get a pointer.
199  */
200 struct skb_shared_hwtstamps {
201         ktime_t hwtstamp;
202         ktime_t syststamp;
203 };
204
205 /* Definitions for tx_flags in struct skb_shared_info */
206 enum {
207         /* generate hardware time stamp */
208         SKBTX_HW_TSTAMP = 1 << 0,
209
210         /* generate software time stamp */
211         SKBTX_SW_TSTAMP = 1 << 1,
212
213         /* device driver is going to provide hardware time stamp */
214         SKBTX_IN_PROGRESS = 1 << 2,
215
216         /* device driver supports TX zero-copy buffers */
217         SKBTX_DEV_ZEROCOPY = 1 << 3,
218 };
219
220 /*
221  * The callback notifies userspace to release buffers when skb DMA is done in
222  * lower device, the skb last reference should be 0 when calling this.
223  * The desc is used to track userspace buffer index.
224  */
225 struct ubuf_info {
226         void (*callback)(void *);
227         void *arg;
228         unsigned long desc;
229 };
230
231 /* This data is invariant across clones and lives at
232  * the end of the header data, ie. at skb->end.
233  */
234 struct skb_shared_info {
235         unsigned short  nr_frags;
236         unsigned short  gso_size;
237         /* Warning: this field is not always filled in (UFO)! */
238         unsigned short  gso_segs;
239         unsigned short  gso_type;
240         __be32          ip6_frag_id;
241         __u8            tx_flags;
242         struct sk_buff  *frag_list;
243         struct skb_shared_hwtstamps hwtstamps;
244
245         /*
246          * Warning : all fields before dataref are cleared in __alloc_skb()
247          */
248         atomic_t        dataref;
249
250         /* Intermediate layers must ensure that destructor_arg
251          * remains valid until skb destructor */
252         void *          destructor_arg;
253
254         /* must be last field, see pskb_expand_head() */
255         skb_frag_t      frags[MAX_SKB_FRAGS];
256 };
257
258 /* We divide dataref into two halves.  The higher 16 bits hold references
259  * to the payload part of skb->data.  The lower 16 bits hold references to
260  * the entire skb->data.  A clone of a headerless skb holds the length of
261  * the header in skb->hdr_len.
262  *
263  * All users must obey the rule that the skb->data reference count must be
264  * greater than or equal to the payload reference count.
265  *
266  * Holding a reference to the payload part means that the user does not
267  * care about modifications to the header part of skb->data.
268  */
269 #define SKB_DATAREF_SHIFT 16
270 #define SKB_DATAREF_MASK ((1 << SKB_DATAREF_SHIFT) - 1)
271
272
273 enum {
274         SKB_FCLONE_UNAVAILABLE,
275         SKB_FCLONE_ORIG,
276         SKB_FCLONE_CLONE,
277 };
278
279 enum {
280         SKB_GSO_TCPV4 = 1 << 0,
281         SKB_GSO_UDP = 1 << 1,
282
283         /* This indicates the skb is from an untrusted source. */
284         SKB_GSO_DODGY = 1 << 2,
285
286         /* This indicates the tcp segment has CWR set. */
287         SKB_GSO_TCP_ECN = 1 << 3,
288
289         SKB_GSO_TCPV6 = 1 << 4,
290
291         SKB_GSO_FCOE = 1 << 5,
292 };
293
294 #if BITS_PER_LONG > 32
295 #define NET_SKBUFF_DATA_USES_OFFSET 1
296 #endif
297
298 #ifdef NET_SKBUFF_DATA_USES_OFFSET
299 typedef unsigned int sk_buff_data_t;
300 #else
301 typedef unsigned char *sk_buff_data_t;
302 #endif
303
304 #if defined(CONFIG_NF_DEFRAG_IPV4) || defined(CONFIG_NF_DEFRAG_IPV4_MODULE) || \
305     defined(CONFIG_NF_DEFRAG_IPV6) || defined(CONFIG_NF_DEFRAG_IPV6_MODULE)
306 #define NET_SKBUFF_NF_DEFRAG_NEEDED 1
307 #endif
308
309 /** 
310  *      struct sk_buff - socket buffer
311  *      @next: Next buffer in list
312  *      @prev: Previous buffer in list
313  *      @tstamp: Time we arrived
314  *      @sk: Socket we are owned by
315  *      @dev: Device we arrived on/are leaving by
316  *      @cb: Control buffer. Free for use by every layer. Put private vars here
317  *      @_skb_refdst: destination entry (with norefcount bit)
318  *      @sp: the security path, used for xfrm
319  *      @len: Length of actual data
320  *      @data_len: Data length
321  *      @mac_len: Length of link layer header
322  *      @hdr_len: writable header length of cloned skb
323  *      @csum: Checksum (must include start/offset pair)
324  *      @csum_start: Offset from skb->head where checksumming should start
325  *      @csum_offset: Offset from csum_start where checksum should be stored
326  *      @priority: Packet queueing priority
327  *      @local_df: allow local fragmentation
328  *      @cloned: Head may be cloned (check refcnt to be sure)
329  *      @ip_summed: Driver fed us an IP checksum
330  *      @nohdr: Payload reference only, must not modify header
331  *      @nfctinfo: Relationship of this skb to the connection
332  *      @pkt_type: Packet class
333  *      @fclone: skbuff clone status
334  *      @ipvs_property: skbuff is owned by ipvs
335  *      @peeked: this packet has been seen already, so stats have been
336  *              done for it, don't do them again
337  *      @nf_trace: netfilter packet trace flag
338  *      @protocol: Packet protocol from driver
339  *      @destructor: Destruct function
340  *      @nfct: Associated connection, if any
341  *      @nfct_reasm: netfilter conntrack re-assembly pointer
342  *      @nf_bridge: Saved data about a bridged frame - see br_netfilter.c
343  *      @skb_iif: ifindex of device we arrived on
344  *      @tc_index: Traffic control index
345  *      @tc_verd: traffic control verdict
346  *      @rxhash: the packet hash computed on receive
347  *      @queue_mapping: Queue mapping for multiqueue devices
348  *      @ndisc_nodetype: router type (from link layer)
349  *      @ooo_okay: allow the mapping of a socket to a queue to be changed
350  *      @l4_rxhash: indicate rxhash is a canonical 4-tuple hash over transport
351  *              ports.
352  *      @dma_cookie: a cookie to one of several possible DMA operations
353  *              done by skb DMA functions
354  *      @secmark: security marking
355  *      @mark: Generic packet mark
356  *      @dropcount: total number of sk_receive_queue overflows
357  *      @vlan_tci: vlan tag control information
358  *      @transport_header: Transport layer header
359  *      @network_header: Network layer header
360  *      @mac_header: Link layer header
361  *      @tail: Tail pointer
362  *      @end: End pointer
363  *      @head: Head of buffer
364  *      @data: Data head pointer
365  *      @truesize: Buffer size
366  *      @users: User count - see {datagram,tcp}.c
367  */
368
369 struct sk_buff {
370         /* These two members must be first. */
371         struct sk_buff          *next;
372         struct sk_buff          *prev;
373
374         ktime_t                 tstamp;
375
376         struct sock             *sk;
377         struct net_device       *dev;
378
379         /*
380          * This is the control buffer. It is free to use for every
381          * layer. Please put your private variables there. If you
382          * want to keep them across layers you have to do a skb_clone()
383          * first. This is owned by whoever has the skb queued ATM.
384          */
385         char                    cb[48] __aligned(8);
386
387         unsigned long           _skb_refdst;
388 #ifdef CONFIG_XFRM
389         struct  sec_path        *sp;
390 #endif
391         unsigned int            len,
392                                 data_len;
393         __u16                   mac_len,
394                                 hdr_len;
395         union {
396                 __wsum          csum;
397                 struct {
398                         __u16   csum_start;
399                         __u16   csum_offset;
400                 };
401         };
402         __u32                   priority;
403         kmemcheck_bitfield_begin(flags1);
404         __u8                    local_df:1,
405                                 cloned:1,
406                                 ip_summed:2,
407                                 nohdr:1,
408                                 nfctinfo:3;
409         __u8                    pkt_type:3,
410                                 fclone:2,
411                                 ipvs_property:1,
412                                 peeked:1,
413                                 nf_trace:1;
414         kmemcheck_bitfield_end(flags1);
415         __be16                  protocol;
416
417         void                    (*destructor)(struct sk_buff *skb);
418 #if defined(CONFIG_NF_CONNTRACK) || defined(CONFIG_NF_CONNTRACK_MODULE)
419         struct nf_conntrack     *nfct;
420 #endif
421 #ifdef NET_SKBUFF_NF_DEFRAG_NEEDED
422         struct sk_buff          *nfct_reasm;
423 #endif
424 #ifdef CONFIG_BRIDGE_NETFILTER
425         struct nf_bridge_info   *nf_bridge;
426 #endif
427
428         int                     skb_iif;
429 #ifdef CONFIG_NET_SCHED
430         __u16                   tc_index;       /* traffic control index */
431 #ifdef CONFIG_NET_CLS_ACT
432         __u16                   tc_verd;        /* traffic control verdict */
433 #endif
434 #endif
435
436         __u32                   rxhash;
437
438         __u16                   queue_mapping;
439         kmemcheck_bitfield_begin(flags2);
440 #ifdef CONFIG_IPV6_NDISC_NODETYPE
441         __u8                    ndisc_nodetype:2;
442 #endif
443         __u8                    ooo_okay:1;
444         __u8                    l4_rxhash:1;
445         kmemcheck_bitfield_end(flags2);
446
447         /* 0/13 bit hole */
448
449 #ifdef CONFIG_NET_DMA
450         dma_cookie_t            dma_cookie;
451 #endif
452 #ifdef CONFIG_NETWORK_SECMARK
453         __u32                   secmark;
454 #endif
455         union {
456                 __u32           mark;
457                 __u32           dropcount;
458                 __u32           reserved_tailroom;
459         };
460
461         __u16                   vlan_tci;
462
463         sk_buff_data_t          transport_header;
464         sk_buff_data_t          network_header;
465         sk_buff_data_t          mac_header;
466         /* These elements must be at the end, see alloc_skb() for details.  */
467         sk_buff_data_t          tail;
468         sk_buff_data_t          end;
469         unsigned char           *head,
470                                 *data;
471         unsigned int            truesize;
472         atomic_t                users;
473 };
474
475 #ifdef __KERNEL__
476 /*
477  *      Handling routines are only of interest to the kernel
478  */
479 #include <linux/slab.h>
480
481 #include <asm/system.h>
482
483 /*
484  * skb might have a dst pointer attached, refcounted or not.
485  * _skb_refdst low order bit is set if refcount was _not_ taken
486  */
487 #define SKB_DST_NOREF   1UL
488 #define SKB_DST_PTRMASK ~(SKB_DST_NOREF)
489
490 /**
491  * skb_dst - returns skb dst_entry
492  * @skb: buffer
493  *
494  * Returns skb dst_entry, regardless of reference taken or not.
495  */
496 static inline struct dst_entry *skb_dst(const struct sk_buff *skb)
497 {
498         /* If refdst was not refcounted, check we still are in a 
499          * rcu_read_lock section
500          */
501         WARN_ON((skb->_skb_refdst & SKB_DST_NOREF) &&
502                 !rcu_read_lock_held() &&
503                 !rcu_read_lock_bh_held());
504         return (struct dst_entry *)(skb->_skb_refdst & SKB_DST_PTRMASK);
505 }
506
507 /**
508  * skb_dst_set - sets skb dst
509  * @skb: buffer
510  * @dst: dst entry
511  *
512  * Sets skb dst, assuming a reference was taken on dst and should
513  * be released by skb_dst_drop()
514  */
515 static inline void skb_dst_set(struct sk_buff *skb, struct dst_entry *dst)
516 {
517         skb->_skb_refdst = (unsigned long)dst;
518 }
519
520 extern void skb_dst_set_noref(struct sk_buff *skb, struct dst_entry *dst);
521
522 /**
523  * skb_dst_is_noref - Test if skb dst isn't refcounted
524  * @skb: buffer
525  */
526 static inline bool skb_dst_is_noref(const struct sk_buff *skb)
527 {
528         return (skb->_skb_refdst & SKB_DST_NOREF) && skb_dst(skb);
529 }
530
531 static inline struct rtable *skb_rtable(const struct sk_buff *skb)
532 {
533         return (struct rtable *)skb_dst(skb);
534 }
535
536 extern void kfree_skb(struct sk_buff *skb);
537 extern void consume_skb(struct sk_buff *skb);
538 extern void            __kfree_skb(struct sk_buff *skb);
539 extern struct sk_buff *__alloc_skb(unsigned int size,
540                                    gfp_t priority, int fclone, int node);
541 static inline struct sk_buff *alloc_skb(unsigned int size,
542                                         gfp_t priority)
543 {
544         return __alloc_skb(size, priority, 0, NUMA_NO_NODE);
545 }
546
547 static inline struct sk_buff *alloc_skb_fclone(unsigned int size,
548                                                gfp_t priority)
549 {
550         return __alloc_skb(size, priority, 1, NUMA_NO_NODE);
551 }
552
553 extern void skb_recycle(struct sk_buff *skb);
554 extern bool skb_recycle_check(struct sk_buff *skb, int skb_size);
555
556 extern struct sk_buff *skb_morph(struct sk_buff *dst, struct sk_buff *src);
557 extern int skb_copy_ubufs(struct sk_buff *skb, gfp_t gfp_mask);
558 extern struct sk_buff *skb_clone(struct sk_buff *skb,
559                                  gfp_t priority);
560 extern struct sk_buff *skb_copy(const struct sk_buff *skb,
561                                 gfp_t priority);
562 extern struct sk_buff *pskb_copy(struct sk_buff *skb,
563                                  gfp_t gfp_mask);
564 extern int             pskb_expand_head(struct sk_buff *skb,
565                                         int nhead, int ntail,
566                                         gfp_t gfp_mask);
567 extern struct sk_buff *skb_realloc_headroom(struct sk_buff *skb,
568                                             unsigned int headroom);
569 extern struct sk_buff *skb_copy_expand(const struct sk_buff *skb,
570                                        int newheadroom, int newtailroom,
571                                        gfp_t priority);
572 extern int             skb_to_sgvec(struct sk_buff *skb,
573                                     struct scatterlist *sg, int offset,
574                                     int len);
575 extern int             skb_cow_data(struct sk_buff *skb, int tailbits,
576                                     struct sk_buff **trailer);
577 extern int             skb_pad(struct sk_buff *skb, int pad);
578 #define dev_kfree_skb(a)        consume_skb(a)
579
580 extern int skb_append_datato_frags(struct sock *sk, struct sk_buff *skb,
581                         int getfrag(void *from, char *to, int offset,
582                         int len,int odd, struct sk_buff *skb),
583                         void *from, int length);
584
585 struct skb_seq_state {
586         __u32           lower_offset;
587         __u32           upper_offset;
588         __u32           frag_idx;
589         __u32           stepped_offset;
590         struct sk_buff  *root_skb;
591         struct sk_buff  *cur_skb;
592         __u8            *frag_data;
593 };
594
595 extern void           skb_prepare_seq_read(struct sk_buff *skb,
596                                            unsigned int from, unsigned int to,
597                                            struct skb_seq_state *st);
598 extern unsigned int   skb_seq_read(unsigned int consumed, const u8 **data,
599                                    struct skb_seq_state *st);
600 extern void           skb_abort_seq_read(struct skb_seq_state *st);
601
602 extern unsigned int   skb_find_text(struct sk_buff *skb, unsigned int from,
603                                     unsigned int to, struct ts_config *config,
604                                     struct ts_state *state);
605
606 extern void __skb_get_rxhash(struct sk_buff *skb);
607 static inline __u32 skb_get_rxhash(struct sk_buff *skb)
608 {
609         if (!skb->rxhash)
610                 __skb_get_rxhash(skb);
611
612         return skb->rxhash;
613 }
614
615 #ifdef NET_SKBUFF_DATA_USES_OFFSET
616 static inline unsigned char *skb_end_pointer(const struct sk_buff *skb)
617 {
618         return skb->head + skb->end;
619 }
620
621 static inline unsigned int skb_end_offset(const struct sk_buff *skb)
622 {
623         return skb->end;
624 }
625 #else
626 static inline unsigned char *skb_end_pointer(const struct sk_buff *skb)
627 {
628         return skb->end;
629 }
630
631 static inline unsigned int skb_end_offset(const struct sk_buff *skb)
632 {
633         return skb->end - skb->head;
634 }
635 #endif
636
637 /* Internal */
638 #define skb_shinfo(SKB) ((struct skb_shared_info *)(skb_end_pointer(SKB)))
639
640 static inline struct skb_shared_hwtstamps *skb_hwtstamps(struct sk_buff *skb)
641 {
642         return &skb_shinfo(skb)->hwtstamps;
643 }
644
645 /**
646  *      skb_queue_empty - check if a queue is empty
647  *      @list: queue head
648  *
649  *      Returns true if the queue is empty, false otherwise.
650  */
651 static inline int skb_queue_empty(const struct sk_buff_head *list)
652 {
653         return list->next == (struct sk_buff *)list;
654 }
655
656 /**
657  *      skb_queue_is_last - check if skb is the last entry in the queue
658  *      @list: queue head
659  *      @skb: buffer
660  *
661  *      Returns true if @skb is the last buffer on the list.
662  */
663 static inline bool skb_queue_is_last(const struct sk_buff_head *list,
664                                      const struct sk_buff *skb)
665 {
666         return skb->next == (struct sk_buff *)list;
667 }
668
669 /**
670  *      skb_queue_is_first - check if skb is the first entry in the queue
671  *      @list: queue head
672  *      @skb: buffer
673  *
674  *      Returns true if @skb is the first buffer on the list.
675  */
676 static inline bool skb_queue_is_first(const struct sk_buff_head *list,
677                                       const struct sk_buff *skb)
678 {
679         return skb->prev == (struct sk_buff *)list;
680 }
681
682 /**
683  *      skb_queue_next - return the next packet in the queue
684  *      @list: queue head
685  *      @skb: current buffer
686  *
687  *      Return the next packet in @list after @skb.  It is only valid to
688  *      call this if skb_queue_is_last() evaluates to false.
689  */
690 static inline struct sk_buff *skb_queue_next(const struct sk_buff_head *list,
691                                              const struct sk_buff *skb)
692 {
693         /* This BUG_ON may seem severe, but if we just return then we
694          * are going to dereference garbage.
695          */
696         BUG_ON(skb_queue_is_last(list, skb));
697         return skb->next;
698 }
699
700 /**
701  *      skb_queue_prev - return the prev packet in the queue
702  *      @list: queue head
703  *      @skb: current buffer
704  *
705  *      Return the prev packet in @list before @skb.  It is only valid to
706  *      call this if skb_queue_is_first() evaluates to false.
707  */
708 static inline struct sk_buff *skb_queue_prev(const struct sk_buff_head *list,
709                                              const struct sk_buff *skb)
710 {
711         /* This BUG_ON may seem severe, but if we just return then we
712          * are going to dereference garbage.
713          */
714         BUG_ON(skb_queue_is_first(list, skb));
715         return skb->prev;
716 }
717
718 /**
719  *      skb_get - reference buffer
720  *      @skb: buffer to reference
721  *
722  *      Makes another reference to a socket buffer and returns a pointer
723  *      to the buffer.
724  */
725 static inline struct sk_buff *skb_get(struct sk_buff *skb)
726 {
727         atomic_inc(&skb->users);
728         return skb;
729 }
730
731 /*
732  * If users == 1, we are the only owner and are can avoid redundant
733  * atomic change.
734  */
735
736 /**
737  *      skb_cloned - is the buffer a clone
738  *      @skb: buffer to check
739  *
740  *      Returns true if the buffer was generated with skb_clone() and is
741  *      one of multiple shared copies of the buffer. Cloned buffers are
742  *      shared data so must not be written to under normal circumstances.
743  */
744 static inline int skb_cloned(const struct sk_buff *skb)
745 {
746         return skb->cloned &&
747                (atomic_read(&skb_shinfo(skb)->dataref) & SKB_DATAREF_MASK) != 1;
748 }
749
750 static inline int skb_unclone(struct sk_buff *skb, gfp_t pri)
751 {
752         might_sleep_if(pri & __GFP_WAIT);
753
754         if (skb_cloned(skb))
755                 return pskb_expand_head(skb, 0, 0, pri);
756
757         return 0;
758 }
759
760 /**
761  *      skb_header_cloned - is the header a clone
762  *      @skb: buffer to check
763  *
764  *      Returns true if modifying the header part of the buffer requires
765  *      the data to be copied.
766  */
767 static inline int skb_header_cloned(const struct sk_buff *skb)
768 {
769         int dataref;
770
771         if (!skb->cloned)
772                 return 0;
773
774         dataref = atomic_read(&skb_shinfo(skb)->dataref);
775         dataref = (dataref & SKB_DATAREF_MASK) - (dataref >> SKB_DATAREF_SHIFT);
776         return dataref != 1;
777 }
778
779 /**
780  *      skb_header_release - release reference to header
781  *      @skb: buffer to operate on
782  *
783  *      Drop a reference to the header part of the buffer.  This is done
784  *      by acquiring a payload reference.  You must not read from the header
785  *      part of skb->data after this.
786  */
787 static inline void skb_header_release(struct sk_buff *skb)
788 {
789         BUG_ON(skb->nohdr);
790         skb->nohdr = 1;
791         atomic_add(1 << SKB_DATAREF_SHIFT, &skb_shinfo(skb)->dataref);
792 }
793
794 /**
795  *      skb_shared - is the buffer shared
796  *      @skb: buffer to check
797  *
798  *      Returns true if more than one person has a reference to this
799  *      buffer.
800  */
801 static inline int skb_shared(const struct sk_buff *skb)
802 {
803         return atomic_read(&skb->users) != 1;
804 }
805
806 /**
807  *      skb_share_check - check if buffer is shared and if so clone it
808  *      @skb: buffer to check
809  *      @pri: priority for memory allocation
810  *
811  *      If the buffer is shared the buffer is cloned and the old copy
812  *      drops a reference. A new clone with a single reference is returned.
813  *      If the buffer is not shared the original buffer is returned. When
814  *      being called from interrupt status or with spinlocks held pri must
815  *      be GFP_ATOMIC.
816  *
817  *      NULL is returned on a memory allocation failure.
818  */
819 static inline struct sk_buff *skb_share_check(struct sk_buff *skb,
820                                               gfp_t pri)
821 {
822         might_sleep_if(pri & __GFP_WAIT);
823         if (skb_shared(skb)) {
824                 struct sk_buff *nskb = skb_clone(skb, pri);
825                 kfree_skb(skb);
826                 skb = nskb;
827         }
828         return skb;
829 }
830
831 /*
832  *      Copy shared buffers into a new sk_buff. We effectively do COW on
833  *      packets to handle cases where we have a local reader and forward
834  *      and a couple of other messy ones. The normal one is tcpdumping
835  *      a packet thats being forwarded.
836  */
837
838 /**
839  *      skb_unshare - make a copy of a shared buffer
840  *      @skb: buffer to check
841  *      @pri: priority for memory allocation
842  *
843  *      If the socket buffer is a clone then this function creates a new
844  *      copy of the data, drops a reference count on the old copy and returns
845  *      the new copy with the reference count at 1. If the buffer is not a clone
846  *      the original buffer is returned. When called with a spinlock held or
847  *      from interrupt state @pri must be %GFP_ATOMIC
848  *
849  *      %NULL is returned on a memory allocation failure.
850  */
851 static inline struct sk_buff *skb_unshare(struct sk_buff *skb,
852                                           gfp_t pri)
853 {
854         might_sleep_if(pri & __GFP_WAIT);
855         if (skb_cloned(skb)) {
856                 struct sk_buff *nskb = skb_copy(skb, pri);
857                 kfree_skb(skb); /* Free our shared copy */
858                 skb = nskb;
859         }
860         return skb;
861 }
862
863 /**
864  *      skb_peek - peek at the head of an &sk_buff_head
865  *      @list_: list to peek at
866  *
867  *      Peek an &sk_buff. Unlike most other operations you _MUST_
868  *      be careful with this one. A peek leaves the buffer on the
869  *      list and someone else may run off with it. You must hold
870  *      the appropriate locks or have a private queue to do this.
871  *
872  *      Returns %NULL for an empty list or a pointer to the head element.
873  *      The reference count is not incremented and the reference is therefore
874  *      volatile. Use with caution.
875  */
876 static inline struct sk_buff *skb_peek(const struct sk_buff_head *list_)
877 {
878         struct sk_buff *list = ((const struct sk_buff *)list_)->next;
879         if (list == (struct sk_buff *)list_)
880                 list = NULL;
881         return list;
882 }
883
884 /**
885  *      skb_peek_tail - peek at the tail of an &sk_buff_head
886  *      @list_: list to peek at
887  *
888  *      Peek an &sk_buff. Unlike most other operations you _MUST_
889  *      be careful with this one. A peek leaves the buffer on the
890  *      list and someone else may run off with it. You must hold
891  *      the appropriate locks or have a private queue to do this.
892  *
893  *      Returns %NULL for an empty list or a pointer to the tail element.
894  *      The reference count is not incremented and the reference is therefore
895  *      volatile. Use with caution.
896  */
897 static inline struct sk_buff *skb_peek_tail(const struct sk_buff_head *list_)
898 {
899         struct sk_buff *list = ((const struct sk_buff *)list_)->prev;
900         if (list == (struct sk_buff *)list_)
901                 list = NULL;
902         return list;
903 }
904
905 /**
906  *      skb_queue_len   - get queue length
907  *      @list_: list to measure
908  *
909  *      Return the length of an &sk_buff queue.
910  */
911 static inline __u32 skb_queue_len(const struct sk_buff_head *list_)
912 {
913         return list_->qlen;
914 }
915
916 /**
917  *      __skb_queue_head_init - initialize non-spinlock portions of sk_buff_head
918  *      @list: queue to initialize
919  *
920  *      This initializes only the list and queue length aspects of
921  *      an sk_buff_head object.  This allows to initialize the list
922  *      aspects of an sk_buff_head without reinitializing things like
923  *      the spinlock.  It can also be used for on-stack sk_buff_head
924  *      objects where the spinlock is known to not be used.
925  */
926 static inline void __skb_queue_head_init(struct sk_buff_head *list)
927 {
928         list->prev = list->next = (struct sk_buff *)list;
929         list->qlen = 0;
930 }
931
932 /*
933  * This function creates a split out lock class for each invocation;
934  * this is needed for now since a whole lot of users of the skb-queue
935  * infrastructure in drivers have different locking usage (in hardirq)
936  * than the networking core (in softirq only). In the long run either the
937  * network layer or drivers should need annotation to consolidate the
938  * main types of usage into 3 classes.
939  */
940 static inline void skb_queue_head_init(struct sk_buff_head *list)
941 {
942         spin_lock_init(&list->lock);
943         __skb_queue_head_init(list);
944 }
945
946 static inline void skb_queue_head_init_class(struct sk_buff_head *list,
947                 struct lock_class_key *class)
948 {
949         skb_queue_head_init(list);
950         lockdep_set_class(&list->lock, class);
951 }
952
953 /*
954  *      Insert an sk_buff on a list.
955  *
956  *      The "__skb_xxxx()" functions are the non-atomic ones that
957  *      can only be called with interrupts disabled.
958  */
959 extern void        skb_insert(struct sk_buff *old, struct sk_buff *newsk, struct sk_buff_head *list);
960 static inline void __skb_insert(struct sk_buff *newsk,
961                                 struct sk_buff *prev, struct sk_buff *next,
962                                 struct sk_buff_head *list)
963 {
964         newsk->next = next;
965         newsk->prev = prev;
966         next->prev  = prev->next = newsk;
967         list->qlen++;
968 }
969
970 static inline void __skb_queue_splice(const struct sk_buff_head *list,
971                                       struct sk_buff *prev,
972                                       struct sk_buff *next)
973 {
974         struct sk_buff *first = list->next;
975         struct sk_buff *last = list->prev;
976
977         first->prev = prev;
978         prev->next = first;
979
980         last->next = next;
981         next->prev = last;
982 }
983
984 /**
985  *      skb_queue_splice - join two skb lists, this is designed for stacks
986  *      @list: the new list to add
987  *      @head: the place to add it in the first list
988  */
989 static inline void skb_queue_splice(const struct sk_buff_head *list,
990                                     struct sk_buff_head *head)
991 {
992         if (!skb_queue_empty(list)) {
993                 __skb_queue_splice(list, (struct sk_buff *) head, head->next);
994                 head->qlen += list->qlen;
995         }
996 }
997
998 /**
999  *      skb_queue_splice - join two skb lists and reinitialise the emptied list
1000  *      @list: the new list to add
1001  *      @head: the place to add it in the first list
1002  *
1003  *      The list at @list is reinitialised
1004  */
1005 static inline void skb_queue_splice_init(struct sk_buff_head *list,
1006                                          struct sk_buff_head *head)
1007 {
1008         if (!skb_queue_empty(list)) {
1009                 __skb_queue_splice(list, (struct sk_buff *) head, head->next);
1010                 head->qlen += list->qlen;
1011                 __skb_queue_head_init(list);
1012         }
1013 }
1014
1015 /**
1016  *      skb_queue_splice_tail - join two skb lists, each list being a queue
1017  *      @list: the new list to add
1018  *      @head: the place to add it in the first list
1019  */
1020 static inline void skb_queue_splice_tail(const struct sk_buff_head *list,
1021                                          struct sk_buff_head *head)
1022 {
1023         if (!skb_queue_empty(list)) {
1024                 __skb_queue_splice(list, head->prev, (struct sk_buff *) head);
1025                 head->qlen += list->qlen;
1026         }
1027 }
1028
1029 /**
1030  *      skb_queue_splice_tail - join two skb lists and reinitialise the emptied list
1031  *      @list: the new list to add
1032  *      @head: the place to add it in the first list
1033  *
1034  *      Each of the lists is a queue.
1035  *      The list at @list is reinitialised
1036  */
1037 static inline void skb_queue_splice_tail_init(struct sk_buff_head *list,
1038                                               struct sk_buff_head *head)
1039 {
1040         if (!skb_queue_empty(list)) {
1041                 __skb_queue_splice(list, head->prev, (struct sk_buff *) head);
1042                 head->qlen += list->qlen;
1043                 __skb_queue_head_init(list);
1044         }
1045 }
1046
1047 /**
1048  *      __skb_queue_after - queue a buffer at the list head
1049  *      @list: list to use
1050  *      @prev: place after this buffer
1051  *      @newsk: buffer to queue
1052  *
1053  *      Queue a buffer int the middle of a list. This function takes no locks
1054  *      and you must therefore hold required locks before calling it.
1055  *
1056  *      A buffer cannot be placed on two lists at the same time.
1057  */
1058 static inline void __skb_queue_after(struct sk_buff_head *list,
1059                                      struct sk_buff *prev,
1060                                      struct sk_buff *newsk)
1061 {
1062         __skb_insert(newsk, prev, prev->next, list);
1063 }
1064
1065 extern void skb_append(struct sk_buff *old, struct sk_buff *newsk,
1066                        struct sk_buff_head *list);
1067
1068 static inline void __skb_queue_before(struct sk_buff_head *list,
1069                                       struct sk_buff *next,
1070                                       struct sk_buff *newsk)
1071 {
1072         __skb_insert(newsk, next->prev, next, list);
1073 }
1074
1075 /**
1076  *      __skb_queue_head - queue a buffer at the list head
1077  *      @list: list to use
1078  *      @newsk: buffer to queue
1079  *
1080  *      Queue a buffer at the start of a list. This function takes no locks
1081  *      and you must therefore hold required locks before calling it.
1082  *
1083  *      A buffer cannot be placed on two lists at the same time.
1084  */
1085 extern void skb_queue_head(struct sk_buff_head *list, struct sk_buff *newsk);
1086 static inline void __skb_queue_head(struct sk_buff_head *list,
1087                                     struct sk_buff *newsk)
1088 {
1089         __skb_queue_after(list, (struct sk_buff *)list, newsk);
1090 }
1091
1092 /**
1093  *      __skb_queue_tail - queue a buffer at the list tail
1094  *      @list: list to use
1095  *      @newsk: buffer to queue
1096  *
1097  *      Queue a buffer at the end of a list. This function takes no locks
1098  *      and you must therefore hold required locks before calling it.
1099  *
1100  *      A buffer cannot be placed on two lists at the same time.
1101  */
1102 extern void skb_queue_tail(struct sk_buff_head *list, struct sk_buff *newsk);
1103 static inline void __skb_queue_tail(struct sk_buff_head *list,
1104                                    struct sk_buff *newsk)
1105 {
1106         __skb_queue_before(list, (struct sk_buff *)list, newsk);
1107 }
1108
1109 /*
1110  * remove sk_buff from list. _Must_ be called atomically, and with
1111  * the list known..
1112  */
1113 extern void        skb_unlink(struct sk_buff *skb, struct sk_buff_head *list);
1114 static inline void __skb_unlink(struct sk_buff *skb, struct sk_buff_head *list)
1115 {
1116         struct sk_buff *next, *prev;
1117
1118         list->qlen--;
1119         next       = skb->next;
1120         prev       = skb->prev;
1121         skb->next  = skb->prev = NULL;
1122         next->prev = prev;
1123         prev->next = next;
1124 }
1125
1126 /**
1127  *      __skb_dequeue - remove from the head of the queue
1128  *      @list: list to dequeue from
1129  *
1130  *      Remove the head of the list. This function does not take any locks
1131  *      so must be used with appropriate locks held only. The head item is
1132  *      returned or %NULL if the list is empty.
1133  */
1134 extern struct sk_buff *skb_dequeue(struct sk_buff_head *list);
1135 static inline struct sk_buff *__skb_dequeue(struct sk_buff_head *list)
1136 {
1137         struct sk_buff *skb = skb_peek(list);
1138         if (skb)
1139                 __skb_unlink(skb, list);
1140         return skb;
1141 }
1142
1143 /**
1144  *      __skb_dequeue_tail - remove from the tail of the queue
1145  *      @list: list to dequeue from
1146  *
1147  *      Remove the tail of the list. This function does not take any locks
1148  *      so must be used with appropriate locks held only. The tail item is
1149  *      returned or %NULL if the list is empty.
1150  */
1151 extern struct sk_buff *skb_dequeue_tail(struct sk_buff_head *list);
1152 static inline struct sk_buff *__skb_dequeue_tail(struct sk_buff_head *list)
1153 {
1154         struct sk_buff *skb = skb_peek_tail(list);
1155         if (skb)
1156                 __skb_unlink(skb, list);
1157         return skb;
1158 }
1159
1160
1161 static inline int skb_is_nonlinear(const struct sk_buff *skb)
1162 {
1163         return skb->data_len;
1164 }
1165
1166 static inline unsigned int skb_headlen(const struct sk_buff *skb)
1167 {
1168         return skb->len - skb->data_len;
1169 }
1170
1171 static inline int skb_pagelen(const struct sk_buff *skb)
1172 {
1173         int i, len = 0;
1174
1175         for (i = (int)skb_shinfo(skb)->nr_frags - 1; i >= 0; i--)
1176                 len += skb_frag_size(&skb_shinfo(skb)->frags[i]);
1177         return len + skb_headlen(skb);
1178 }
1179
1180 static inline bool skb_has_frags(const struct sk_buff *skb)
1181 {
1182         return skb_shinfo(skb)->nr_frags;
1183 }
1184
1185 /**
1186  * __skb_fill_page_desc - initialise a paged fragment in an skb
1187  * @skb: buffer containing fragment to be initialised
1188  * @i: paged fragment index to initialise
1189  * @page: the page to use for this fragment
1190  * @off: the offset to the data with @page
1191  * @size: the length of the data
1192  *
1193  * Initialises the @i'th fragment of @skb to point to &size bytes at
1194  * offset @off within @page.
1195  *
1196  * Does not take any additional reference on the fragment.
1197  */
1198 static inline void __skb_fill_page_desc(struct sk_buff *skb, int i,
1199                                         struct page *page, int off, int size)
1200 {
1201         skb_frag_t *frag = &skb_shinfo(skb)->frags[i];
1202
1203         frag->page.p              = page;
1204         frag->page_offset         = off;
1205         skb_frag_size_set(frag, size);
1206 }
1207
1208 /**
1209  * skb_fill_page_desc - initialise a paged fragment in an skb
1210  * @skb: buffer containing fragment to be initialised
1211  * @i: paged fragment index to initialise
1212  * @page: the page to use for this fragment
1213  * @off: the offset to the data with @page
1214  * @size: the length of the data
1215  *
1216  * As per __skb_fill_page_desc() -- initialises the @i'th fragment of
1217  * @skb to point to &size bytes at offset @off within @page. In
1218  * addition updates @skb such that @i is the last fragment.
1219  *
1220  * Does not take any additional reference on the fragment.
1221  */
1222 static inline void skb_fill_page_desc(struct sk_buff *skb, int i,
1223                                       struct page *page, int off, int size)
1224 {
1225         __skb_fill_page_desc(skb, i, page, off, size);
1226         skb_shinfo(skb)->nr_frags = i + 1;
1227 }
1228
1229 extern void skb_add_rx_frag(struct sk_buff *skb, int i, struct page *page,
1230                             int off, int size);
1231
1232 #define SKB_PAGE_ASSERT(skb)    BUG_ON(skb_shinfo(skb)->nr_frags)
1233 #define SKB_FRAG_ASSERT(skb)    BUG_ON(skb_has_frag_list(skb))
1234 #define SKB_LINEAR_ASSERT(skb)  BUG_ON(skb_is_nonlinear(skb))
1235
1236 #ifdef NET_SKBUFF_DATA_USES_OFFSET
1237 static inline unsigned char *skb_tail_pointer(const struct sk_buff *skb)
1238 {
1239         return skb->head + skb->tail;
1240 }
1241
1242 static inline void skb_reset_tail_pointer(struct sk_buff *skb)
1243 {
1244         skb->tail = skb->data - skb->head;
1245 }
1246
1247 static inline void skb_set_tail_pointer(struct sk_buff *skb, const int offset)
1248 {
1249         skb_reset_tail_pointer(skb);
1250         skb->tail += offset;
1251 }
1252 #else /* NET_SKBUFF_DATA_USES_OFFSET */
1253 static inline unsigned char *skb_tail_pointer(const struct sk_buff *skb)
1254 {
1255         return skb->tail;
1256 }
1257
1258 static inline void skb_reset_tail_pointer(struct sk_buff *skb)
1259 {
1260         skb->tail = skb->data;
1261 }
1262
1263 static inline void skb_set_tail_pointer(struct sk_buff *skb, const int offset)
1264 {
1265         skb->tail = skb->data + offset;
1266 }
1267
1268 #endif /* NET_SKBUFF_DATA_USES_OFFSET */
1269
1270 /*
1271  *      Add data to an sk_buff
1272  */
1273 extern unsigned char *skb_put(struct sk_buff *skb, unsigned int len);
1274 static inline unsigned char *__skb_put(struct sk_buff *skb, unsigned int len)
1275 {
1276         unsigned char *tmp = skb_tail_pointer(skb);
1277         SKB_LINEAR_ASSERT(skb);
1278         skb->tail += len;
1279         skb->len  += len;
1280         return tmp;
1281 }
1282
1283 extern unsigned char *skb_push(struct sk_buff *skb, unsigned int len);
1284 static inline unsigned char *__skb_push(struct sk_buff *skb, unsigned int len)
1285 {
1286         skb->data -= len;
1287         skb->len  += len;
1288         return skb->data;
1289 }
1290
1291 extern unsigned char *skb_pull(struct sk_buff *skb, unsigned int len);
1292 static inline unsigned char *__skb_pull(struct sk_buff *skb, unsigned int len)
1293 {
1294         skb->len -= len;
1295         BUG_ON(skb->len < skb->data_len);
1296         return skb->data += len;
1297 }
1298
1299 static inline unsigned char *skb_pull_inline(struct sk_buff *skb, unsigned int len)
1300 {
1301         return unlikely(len > skb->len) ? NULL : __skb_pull(skb, len);
1302 }
1303
1304 extern unsigned char *__pskb_pull_tail(struct sk_buff *skb, int delta);
1305
1306 static inline unsigned char *__pskb_pull(struct sk_buff *skb, unsigned int len)
1307 {
1308         if (len > skb_headlen(skb) &&
1309             !__pskb_pull_tail(skb, len - skb_headlen(skb)))
1310                 return NULL;
1311         skb->len -= len;
1312         return skb->data += len;
1313 }
1314
1315 static inline unsigned char *pskb_pull(struct sk_buff *skb, unsigned int len)
1316 {
1317         return unlikely(len > skb->len) ? NULL : __pskb_pull(skb, len);
1318 }
1319
1320 static inline int pskb_may_pull(struct sk_buff *skb, unsigned int len)
1321 {
1322         if (likely(len <= skb_headlen(skb)))
1323                 return 1;
1324         if (unlikely(len > skb->len))
1325                 return 0;
1326         return __pskb_pull_tail(skb, len - skb_headlen(skb)) != NULL;
1327 }
1328
1329 /**
1330  *      skb_headroom - bytes at buffer head
1331  *      @skb: buffer to check
1332  *
1333  *      Return the number of bytes of free space at the head of an &sk_buff.
1334  */
1335 static inline unsigned int skb_headroom(const struct sk_buff *skb)
1336 {
1337         return skb->data - skb->head;
1338 }
1339
1340 /**
1341  *      skb_tailroom - bytes at buffer end
1342  *      @skb: buffer to check
1343  *
1344  *      Return the number of bytes of free space at the tail of an sk_buff
1345  */
1346 static inline int skb_tailroom(const struct sk_buff *skb)
1347 {
1348         return skb_is_nonlinear(skb) ? 0 : skb->end - skb->tail;
1349 }
1350
1351 /**
1352  *      skb_availroom - bytes at buffer end
1353  *      @skb: buffer to check
1354  *
1355  *      Return the number of bytes of free space at the tail of an sk_buff
1356  *      allocated by sk_stream_alloc()
1357  */
1358 static inline int skb_availroom(const struct sk_buff *skb)
1359 {
1360         if (skb_is_nonlinear(skb))
1361                 return 0;
1362
1363         return skb->end - skb->tail - skb->reserved_tailroom;
1364 }
1365
1366 /**
1367  *      skb_reserve - adjust headroom
1368  *      @skb: buffer to alter
1369  *      @len: bytes to move
1370  *
1371  *      Increase the headroom of an empty &sk_buff by reducing the tail
1372  *      room. This is only allowed for an empty buffer.
1373  */
1374 static inline void skb_reserve(struct sk_buff *skb, int len)
1375 {
1376         skb->data += len;
1377         skb->tail += len;
1378 }
1379
1380 static inline void skb_reset_mac_len(struct sk_buff *skb)
1381 {
1382         skb->mac_len = skb->network_header - skb->mac_header;
1383 }
1384
1385 #ifdef NET_SKBUFF_DATA_USES_OFFSET
1386 static inline unsigned char *skb_transport_header(const struct sk_buff *skb)
1387 {
1388         return skb->head + skb->transport_header;
1389 }
1390
1391 static inline void skb_reset_transport_header(struct sk_buff *skb)
1392 {
1393         skb->transport_header = skb->data - skb->head;
1394 }
1395
1396 static inline void skb_set_transport_header(struct sk_buff *skb,
1397                                             const int offset)
1398 {
1399         skb_reset_transport_header(skb);
1400         skb->transport_header += offset;
1401 }
1402
1403 static inline unsigned char *skb_network_header(const struct sk_buff *skb)
1404 {
1405         return skb->head + skb->network_header;
1406 }
1407
1408 static inline void skb_reset_network_header(struct sk_buff *skb)
1409 {
1410         skb->network_header = skb->data - skb->head;
1411 }
1412
1413 static inline void skb_set_network_header(struct sk_buff *skb, const int offset)
1414 {
1415         skb_reset_network_header(skb);
1416         skb->network_header += offset;
1417 }
1418
1419 static inline unsigned char *skb_mac_header(const struct sk_buff *skb)
1420 {
1421         return skb->head + skb->mac_header;
1422 }
1423
1424 static inline int skb_mac_header_was_set(const struct sk_buff *skb)
1425 {
1426         return skb->mac_header != ~0U;
1427 }
1428
1429 static inline void skb_reset_mac_header(struct sk_buff *skb)
1430 {
1431         skb->mac_header = skb->data - skb->head;
1432 }
1433
1434 static inline void skb_set_mac_header(struct sk_buff *skb, const int offset)
1435 {
1436         skb_reset_mac_header(skb);
1437         skb->mac_header += offset;
1438 }
1439
1440 #else /* NET_SKBUFF_DATA_USES_OFFSET */
1441
1442 static inline unsigned char *skb_transport_header(const struct sk_buff *skb)
1443 {
1444         return skb->transport_header;
1445 }
1446
1447 static inline void skb_reset_transport_header(struct sk_buff *skb)
1448 {
1449         skb->transport_header = skb->data;
1450 }
1451
1452 static inline void skb_set_transport_header(struct sk_buff *skb,
1453                                             const int offset)
1454 {
1455         skb->transport_header = skb->data + offset;
1456 }
1457
1458 static inline unsigned char *skb_network_header(const struct sk_buff *skb)
1459 {
1460         return skb->network_header;
1461 }
1462
1463 static inline void skb_reset_network_header(struct sk_buff *skb)
1464 {
1465         skb->network_header = skb->data;
1466 }
1467
1468 static inline void skb_set_network_header(struct sk_buff *skb, const int offset)
1469 {
1470         skb->network_header = skb->data + offset;
1471 }
1472
1473 static inline unsigned char *skb_mac_header(const struct sk_buff *skb)
1474 {
1475         return skb->mac_header;
1476 }
1477
1478 static inline int skb_mac_header_was_set(const struct sk_buff *skb)
1479 {
1480         return skb->mac_header != NULL;
1481 }
1482
1483 static inline void skb_reset_mac_header(struct sk_buff *skb)
1484 {
1485         skb->mac_header = skb->data;
1486 }
1487
1488 static inline void skb_set_mac_header(struct sk_buff *skb, const int offset)
1489 {
1490         skb->mac_header = skb->data + offset;
1491 }
1492 #endif /* NET_SKBUFF_DATA_USES_OFFSET */
1493
1494 static inline void skb_mac_header_rebuild(struct sk_buff *skb)
1495 {
1496         if (skb_mac_header_was_set(skb)) {
1497                 const unsigned char *old_mac = skb_mac_header(skb);
1498
1499                 skb_set_mac_header(skb, -skb->mac_len);
1500                 memmove(skb_mac_header(skb), old_mac, skb->mac_len);
1501         }
1502 }
1503
1504 static inline int skb_checksum_start_offset(const struct sk_buff *skb)
1505 {
1506         return skb->csum_start - skb_headroom(skb);
1507 }
1508
1509 static inline int skb_transport_offset(const struct sk_buff *skb)
1510 {
1511         return skb_transport_header(skb) - skb->data;
1512 }
1513
1514 static inline u32 skb_network_header_len(const struct sk_buff *skb)
1515 {
1516         return skb->transport_header - skb->network_header;
1517 }
1518
1519 static inline int skb_network_offset(const struct sk_buff *skb)
1520 {
1521         return skb_network_header(skb) - skb->data;
1522 }
1523
1524 static inline int pskb_network_may_pull(struct sk_buff *skb, unsigned int len)
1525 {
1526         return pskb_may_pull(skb, skb_network_offset(skb) + len);
1527 }
1528
1529 /*
1530  * CPUs often take a performance hit when accessing unaligned memory
1531  * locations. The actual performance hit varies, it can be small if the
1532  * hardware handles it or large if we have to take an exception and fix it
1533  * in software.
1534  *
1535  * Since an ethernet header is 14 bytes network drivers often end up with
1536  * the IP header at an unaligned offset. The IP header can be aligned by
1537  * shifting the start of the packet by 2 bytes. Drivers should do this
1538  * with:
1539  *
1540  * skb_reserve(skb, NET_IP_ALIGN);
1541  *
1542  * The downside to this alignment of the IP header is that the DMA is now
1543  * unaligned. On some architectures the cost of an unaligned DMA is high
1544  * and this cost outweighs the gains made by aligning the IP header.
1545  *
1546  * Since this trade off varies between architectures, we allow NET_IP_ALIGN
1547  * to be overridden.
1548  */
1549 #ifndef NET_IP_ALIGN
1550 #define NET_IP_ALIGN    2
1551 #endif
1552
1553 /*
1554  * The networking layer reserves some headroom in skb data (via
1555  * dev_alloc_skb). This is used to avoid having to reallocate skb data when
1556  * the header has to grow. In the default case, if the header has to grow
1557  * 32 bytes or less we avoid the reallocation.
1558  *
1559  * Unfortunately this headroom changes the DMA alignment of the resulting
1560  * network packet. As for NET_IP_ALIGN, this unaligned DMA is expensive
1561  * on some architectures. An architecture can override this value,
1562  * perhaps setting it to a cacheline in size (since that will maintain
1563  * cacheline alignment of the DMA). It must be a power of 2.
1564  *
1565  * Various parts of the networking layer expect at least 32 bytes of
1566  * headroom, you should not reduce this.
1567  *
1568  * Using max(32, L1_CACHE_BYTES) makes sense (especially with RPS)
1569  * to reduce average number of cache lines per packet.
1570  * get_rps_cpus() for example only access one 64 bytes aligned block :
1571  * NET_IP_ALIGN(2) + ethernet_header(14) + IP_header(20/40) + ports(8)
1572  */
1573 #ifndef NET_SKB_PAD
1574 #define NET_SKB_PAD     max(32, L1_CACHE_BYTES)
1575 #endif
1576
1577 extern int ___pskb_trim(struct sk_buff *skb, unsigned int len);
1578
1579 static inline void __skb_trim(struct sk_buff *skb, unsigned int len)
1580 {
1581         if (unlikely(skb_is_nonlinear(skb))) {
1582                 WARN_ON(1);
1583                 return;
1584         }
1585         skb->len = len;
1586         skb_set_tail_pointer(skb, len);
1587 }
1588
1589 extern void skb_trim(struct sk_buff *skb, unsigned int len);
1590
1591 static inline int __pskb_trim(struct sk_buff *skb, unsigned int len)
1592 {
1593         if (skb->data_len)
1594                 return ___pskb_trim(skb, len);
1595         __skb_trim(skb, len);
1596         return 0;
1597 }
1598
1599 static inline int pskb_trim(struct sk_buff *skb, unsigned int len)
1600 {
1601         return (len < skb->len) ? __pskb_trim(skb, len) : 0;
1602 }
1603
1604 /**
1605  *      pskb_trim_unique - remove end from a paged unique (not cloned) buffer
1606  *      @skb: buffer to alter
1607  *      @len: new length
1608  *
1609  *      This is identical to pskb_trim except that the caller knows that
1610  *      the skb is not cloned so we should never get an error due to out-
1611  *      of-memory.
1612  */
1613 static inline void pskb_trim_unique(struct sk_buff *skb, unsigned int len)
1614 {
1615         int err = pskb_trim(skb, len);
1616         BUG_ON(err);
1617 }
1618
1619 /**
1620  *      skb_orphan - orphan a buffer
1621  *      @skb: buffer to orphan
1622  *
1623  *      If a buffer currently has an owner then we call the owner's
1624  *      destructor function and make the @skb unowned. The buffer continues
1625  *      to exist but is no longer charged to its former owner.
1626  */
1627 static inline void skb_orphan(struct sk_buff *skb)
1628 {
1629         if (skb->destructor)
1630                 skb->destructor(skb);
1631         skb->destructor = NULL;
1632         skb->sk         = NULL;
1633 }
1634
1635 /**
1636  *      skb_orphan_frags - orphan the frags contained in a buffer
1637  *      @skb: buffer to orphan frags from
1638  *      @gfp_mask: allocation mask for replacement pages
1639  *
1640  *      For each frag in the SKB which needs a destructor (i.e. has an
1641  *      owner) create a copy of that frag and release the original
1642  *      page by calling the destructor.
1643  */
1644 static inline int skb_orphan_frags(struct sk_buff *skb, gfp_t gfp_mask)
1645 {
1646         if (likely(!(skb_shinfo(skb)->tx_flags & SKBTX_DEV_ZEROCOPY)))
1647                 return 0;
1648         return skb_copy_ubufs(skb, gfp_mask);
1649 }
1650
1651 /**
1652  *      __skb_queue_purge - empty a list
1653  *      @list: list to empty
1654  *
1655  *      Delete all buffers on an &sk_buff list. Each buffer is removed from
1656  *      the list and one reference dropped. This function does not take the
1657  *      list lock and the caller must hold the relevant locks to use it.
1658  */
1659 extern void skb_queue_purge(struct sk_buff_head *list);
1660 static inline void __skb_queue_purge(struct sk_buff_head *list)
1661 {
1662         struct sk_buff *skb;
1663         while ((skb = __skb_dequeue(list)) != NULL)
1664                 kfree_skb(skb);
1665 }
1666
1667 /**
1668  *      __dev_alloc_skb - allocate an skbuff for receiving
1669  *      @length: length to allocate
1670  *      @gfp_mask: get_free_pages mask, passed to alloc_skb
1671  *
1672  *      Allocate a new &sk_buff and assign it a usage count of one. The
1673  *      buffer has unspecified headroom built in. Users should allocate
1674  *      the headroom they think they need without accounting for the
1675  *      built in space. The built in space is used for optimisations.
1676  *
1677  *      %NULL is returned if there is no free memory.
1678  */
1679 static inline struct sk_buff *__dev_alloc_skb(unsigned int length,
1680                                               gfp_t gfp_mask)
1681 {
1682         struct sk_buff *skb = alloc_skb(length + NET_SKB_PAD, gfp_mask);
1683         if (likely(skb))
1684                 skb_reserve(skb, NET_SKB_PAD);
1685         return skb;
1686 }
1687
1688 extern struct sk_buff *dev_alloc_skb(unsigned int length);
1689
1690 extern struct sk_buff *__netdev_alloc_skb(struct net_device *dev,
1691                 unsigned int length, gfp_t gfp_mask);
1692
1693 /**
1694  *      netdev_alloc_skb - allocate an skbuff for rx on a specific device
1695  *      @dev: network device to receive on
1696  *      @length: length to allocate
1697  *
1698  *      Allocate a new &sk_buff and assign it a usage count of one. The
1699  *      buffer has unspecified headroom built in. Users should allocate
1700  *      the headroom they think they need without accounting for the
1701  *      built in space. The built in space is used for optimisations.
1702  *
1703  *      %NULL is returned if there is no free memory. Although this function
1704  *      allocates memory it can be called from an interrupt.
1705  */
1706 static inline struct sk_buff *netdev_alloc_skb(struct net_device *dev,
1707                 unsigned int length)
1708 {
1709         return __netdev_alloc_skb(dev, length, GFP_ATOMIC);
1710 }
1711
1712 static inline struct sk_buff *__netdev_alloc_skb_ip_align(struct net_device *dev,
1713                 unsigned int length, gfp_t gfp)
1714 {
1715         struct sk_buff *skb = __netdev_alloc_skb(dev, length + NET_IP_ALIGN, gfp);
1716
1717         if (NET_IP_ALIGN && skb)
1718                 skb_reserve(skb, NET_IP_ALIGN);
1719         return skb;
1720 }
1721
1722 static inline struct sk_buff *netdev_alloc_skb_ip_align(struct net_device *dev,
1723                 unsigned int length)
1724 {
1725         return __netdev_alloc_skb_ip_align(dev, length, GFP_ATOMIC);
1726 }
1727
1728 /**
1729  *      __netdev_alloc_page - allocate a page for ps-rx on a specific device
1730  *      @dev: network device to receive on
1731  *      @gfp_mask: alloc_pages_node mask
1732  *
1733  *      Allocate a new page. dev currently unused.
1734  *
1735  *      %NULL is returned if there is no free memory.
1736  */
1737 static inline struct page *__netdev_alloc_page(struct net_device *dev, gfp_t gfp_mask)
1738 {
1739         return alloc_pages_node(NUMA_NO_NODE, gfp_mask, 0);
1740 }
1741
1742 /**
1743  *      netdev_alloc_page - allocate a page for ps-rx on a specific device
1744  *      @dev: network device to receive on
1745  *
1746  *      Allocate a new page. dev currently unused.
1747  *
1748  *      %NULL is returned if there is no free memory.
1749  */
1750 static inline struct page *netdev_alloc_page(struct net_device *dev)
1751 {
1752         return __netdev_alloc_page(dev, GFP_ATOMIC);
1753 }
1754
1755 static inline void netdev_free_page(struct net_device *dev, struct page *page)
1756 {
1757         __free_page(page);
1758 }
1759
1760 /**
1761  * skb_frag_page - retrieve the page refered to by a paged fragment
1762  * @frag: the paged fragment
1763  *
1764  * Returns the &struct page associated with @frag.
1765  */
1766 static inline struct page *skb_frag_page(const skb_frag_t *frag)
1767 {
1768         return frag->page.p;
1769 }
1770
1771 /**
1772  * __skb_frag_ref - take an addition reference on a paged fragment.
1773  * @frag: the paged fragment
1774  *
1775  * Takes an additional reference on the paged fragment @frag.
1776  */
1777 static inline void __skb_frag_ref(skb_frag_t *frag)
1778 {
1779         get_page(skb_frag_page(frag));
1780 }
1781
1782 /**
1783  * skb_frag_ref - take an addition reference on a paged fragment of an skb.
1784  * @skb: the buffer
1785  * @f: the fragment offset.
1786  *
1787  * Takes an additional reference on the @f'th paged fragment of @skb.
1788  */
1789 static inline void skb_frag_ref(struct sk_buff *skb, int f)
1790 {
1791         __skb_frag_ref(&skb_shinfo(skb)->frags[f]);
1792 }
1793
1794 /**
1795  * __skb_frag_unref - release a reference on a paged fragment.
1796  * @frag: the paged fragment
1797  *
1798  * Releases a reference on the paged fragment @frag.
1799  */
1800 static inline void __skb_frag_unref(skb_frag_t *frag)
1801 {
1802         put_page(skb_frag_page(frag));
1803 }
1804
1805 /**
1806  * skb_frag_unref - release a reference on a paged fragment of an skb.
1807  * @skb: the buffer
1808  * @f: the fragment offset
1809  *
1810  * Releases a reference on the @f'th paged fragment of @skb.
1811  */
1812 static inline void skb_frag_unref(struct sk_buff *skb, int f)
1813 {
1814         __skb_frag_unref(&skb_shinfo(skb)->frags[f]);
1815 }
1816
1817 /**
1818  * skb_frag_address - gets the address of the data contained in a paged fragment
1819  * @frag: the paged fragment buffer
1820  *
1821  * Returns the address of the data within @frag. The page must already
1822  * be mapped.
1823  */
1824 static inline void *skb_frag_address(const skb_frag_t *frag)
1825 {
1826         return page_address(skb_frag_page(frag)) + frag->page_offset;
1827 }
1828
1829 /**
1830  * skb_frag_address_safe - gets the address of the data contained in a paged fragment
1831  * @frag: the paged fragment buffer
1832  *
1833  * Returns the address of the data within @frag. Checks that the page
1834  * is mapped and returns %NULL otherwise.
1835  */
1836 static inline void *skb_frag_address_safe(const skb_frag_t *frag)
1837 {
1838         void *ptr = page_address(skb_frag_page(frag));
1839         if (unlikely(!ptr))
1840                 return NULL;
1841
1842         return ptr + frag->page_offset;
1843 }
1844
1845 /**
1846  * __skb_frag_set_page - sets the page contained in a paged fragment
1847  * @frag: the paged fragment
1848  * @page: the page to set
1849  *
1850  * Sets the fragment @frag to contain @page.
1851  */
1852 static inline void __skb_frag_set_page(skb_frag_t *frag, struct page *page)
1853 {
1854         frag->page.p = page;
1855 }
1856
1857 /**
1858  * skb_frag_set_page - sets the page contained in a paged fragment of an skb
1859  * @skb: the buffer
1860  * @f: the fragment offset
1861  * @page: the page to set
1862  *
1863  * Sets the @f'th fragment of @skb to contain @page.
1864  */
1865 static inline void skb_frag_set_page(struct sk_buff *skb, int f,
1866                                      struct page *page)
1867 {
1868         __skb_frag_set_page(&skb_shinfo(skb)->frags[f], page);
1869 }
1870
1871 /**
1872  * skb_frag_dma_map - maps a paged fragment via the DMA API
1873  * @dev: the device to map the fragment to
1874  * @frag: the paged fragment to map
1875  * @offset: the offset within the fragment (starting at the
1876  *          fragment's own offset)
1877  * @size: the number of bytes to map
1878  * @dir: the direction of the mapping (%PCI_DMA_*)
1879  *
1880  * Maps the page associated with @frag to @device.
1881  */
1882 static inline dma_addr_t skb_frag_dma_map(struct device *dev,
1883                                           const skb_frag_t *frag,
1884                                           size_t offset, size_t size,
1885                                           enum dma_data_direction dir)
1886 {
1887         return dma_map_page(dev, skb_frag_page(frag),
1888                             frag->page_offset + offset, size, dir);
1889 }
1890
1891 /**
1892  *      skb_clone_writable - is the header of a clone writable
1893  *      @skb: buffer to check
1894  *      @len: length up to which to write
1895  *
1896  *      Returns true if modifying the header part of the cloned buffer
1897  *      does not requires the data to be copied.
1898  */
1899 static inline int skb_clone_writable(const struct sk_buff *skb, unsigned int len)
1900 {
1901         return !skb_header_cloned(skb) &&
1902                skb_headroom(skb) + len <= skb->hdr_len;
1903 }
1904
1905 static inline int __skb_cow(struct sk_buff *skb, unsigned int headroom,
1906                             int cloned)
1907 {
1908         int delta = 0;
1909
1910         if (headroom > skb_headroom(skb))
1911                 delta = headroom - skb_headroom(skb);
1912
1913         if (delta || cloned)
1914                 return pskb_expand_head(skb, ALIGN(delta, NET_SKB_PAD), 0,
1915                                         GFP_ATOMIC);
1916         return 0;
1917 }
1918
1919 /**
1920  *      skb_cow - copy header of skb when it is required
1921  *      @skb: buffer to cow
1922  *      @headroom: needed headroom
1923  *
1924  *      If the skb passed lacks sufficient headroom or its data part
1925  *      is shared, data is reallocated. If reallocation fails, an error
1926  *      is returned and original skb is not changed.
1927  *
1928  *      The result is skb with writable area skb->head...skb->tail
1929  *      and at least @headroom of space at head.
1930  */
1931 static inline int skb_cow(struct sk_buff *skb, unsigned int headroom)
1932 {
1933         return __skb_cow(skb, headroom, skb_cloned(skb));
1934 }
1935
1936 /**
1937  *      skb_cow_head - skb_cow but only making the head writable
1938  *      @skb: buffer to cow
1939  *      @headroom: needed headroom
1940  *
1941  *      This function is identical to skb_cow except that we replace the
1942  *      skb_cloned check by skb_header_cloned.  It should be used when
1943  *      you only need to push on some header and do not need to modify
1944  *      the data.
1945  */
1946 static inline int skb_cow_head(struct sk_buff *skb, unsigned int headroom)
1947 {
1948         return __skb_cow(skb, headroom, skb_header_cloned(skb));
1949 }
1950
1951 /**
1952  *      skb_padto       - pad an skbuff up to a minimal size
1953  *      @skb: buffer to pad
1954  *      @len: minimal length
1955  *
1956  *      Pads up a buffer to ensure the trailing bytes exist and are
1957  *      blanked. If the buffer already contains sufficient data it
1958  *      is untouched. Otherwise it is extended. Returns zero on
1959  *      success. The skb is freed on error.
1960  */
1961  
1962 static inline int skb_padto(struct sk_buff *skb, unsigned int len)
1963 {
1964         unsigned int size = skb->len;
1965         if (likely(size >= len))
1966                 return 0;
1967         return skb_pad(skb, len - size);
1968 }
1969
1970 static inline int skb_add_data(struct sk_buff *skb,
1971                                char __user *from, int copy)
1972 {
1973         const int off = skb->len;
1974
1975         if (skb->ip_summed == CHECKSUM_NONE) {
1976                 int err = 0;
1977                 __wsum csum = csum_and_copy_from_user(from, skb_put(skb, copy),
1978                                                             copy, 0, &err);
1979                 if (!err) {
1980                         skb->csum = csum_block_add(skb->csum, csum, off);
1981                         return 0;
1982                 }
1983         } else if (!copy_from_user(skb_put(skb, copy), from, copy))
1984                 return 0;
1985
1986         __skb_trim(skb, off);
1987         return -EFAULT;
1988 }
1989
1990 static inline int skb_can_coalesce(struct sk_buff *skb, int i,
1991                                    const struct page *page, int off)
1992 {
1993         if (i) {
1994                 const struct skb_frag_struct *frag = &skb_shinfo(skb)->frags[i - 1];
1995
1996                 return page == skb_frag_page(frag) &&
1997                        off == frag->page_offset + skb_frag_size(frag);
1998         }
1999         return 0;
2000 }
2001
2002 static inline int __skb_linearize(struct sk_buff *skb)
2003 {
2004         return __pskb_pull_tail(skb, skb->data_len) ? 0 : -ENOMEM;
2005 }
2006
2007 /**
2008  *      skb_linearize - convert paged skb to linear one
2009  *      @skb: buffer to linarize
2010  *
2011  *      If there is no free memory -ENOMEM is returned, otherwise zero
2012  *      is returned and the old skb data released.
2013  */
2014 static inline int skb_linearize(struct sk_buff *skb)
2015 {
2016         return skb_is_nonlinear(skb) ? __skb_linearize(skb) : 0;
2017 }
2018
2019 /**
2020  *      skb_linearize_cow - make sure skb is linear and writable
2021  *      @skb: buffer to process
2022  *
2023  *      If there is no free memory -ENOMEM is returned, otherwise zero
2024  *      is returned and the old skb data released.
2025  */
2026 static inline int skb_linearize_cow(struct sk_buff *skb)
2027 {
2028         return skb_is_nonlinear(skb) || skb_cloned(skb) ?
2029                __skb_linearize(skb) : 0;
2030 }
2031
2032 /**
2033  *      skb_postpull_rcsum - update checksum for received skb after pull
2034  *      @skb: buffer to update
2035  *      @start: start of data before pull
2036  *      @len: length of data pulled
2037  *
2038  *      After doing a pull on a received packet, you need to call this to
2039  *      update the CHECKSUM_COMPLETE checksum, or set ip_summed to
2040  *      CHECKSUM_NONE so that it can be recomputed from scratch.
2041  */
2042
2043 static inline void skb_postpull_rcsum(struct sk_buff *skb,
2044                                       const void *start, unsigned int len)
2045 {
2046         if (skb->ip_summed == CHECKSUM_COMPLETE)
2047                 skb->csum = csum_sub(skb->csum, csum_partial(start, len, 0));
2048 }
2049
2050 unsigned char *skb_pull_rcsum(struct sk_buff *skb, unsigned int len);
2051
2052 /**
2053  *      pskb_trim_rcsum - trim received skb and update checksum
2054  *      @skb: buffer to trim
2055  *      @len: new length
2056  *
2057  *      This is exactly the same as pskb_trim except that it ensures the
2058  *      checksum of received packets are still valid after the operation.
2059  */
2060
2061 static inline int pskb_trim_rcsum(struct sk_buff *skb, unsigned int len)
2062 {
2063         if (likely(len >= skb->len))
2064                 return 0;
2065         if (skb->ip_summed == CHECKSUM_COMPLETE)
2066                 skb->ip_summed = CHECKSUM_NONE;
2067         return __pskb_trim(skb, len);
2068 }
2069
2070 #define skb_queue_walk(queue, skb) \
2071                 for (skb = (queue)->next;                                       \
2072                      skb != (struct sk_buff *)(queue);                          \
2073                      skb = skb->next)
2074
2075 #define skb_queue_walk_safe(queue, skb, tmp)                                    \
2076                 for (skb = (queue)->next, tmp = skb->next;                      \
2077                      skb != (struct sk_buff *)(queue);                          \
2078                      skb = tmp, tmp = skb->next)
2079
2080 #define skb_queue_walk_from(queue, skb)                                         \
2081                 for (; skb != (struct sk_buff *)(queue);                        \
2082                      skb = skb->next)
2083
2084 #define skb_queue_walk_from_safe(queue, skb, tmp)                               \
2085                 for (tmp = skb->next;                                           \
2086                      skb != (struct sk_buff *)(queue);                          \
2087                      skb = tmp, tmp = skb->next)
2088
2089 #define skb_queue_reverse_walk(queue, skb) \
2090                 for (skb = (queue)->prev;                                       \
2091                      skb != (struct sk_buff *)(queue);                          \
2092                      skb = skb->prev)
2093
2094 #define skb_queue_reverse_walk_safe(queue, skb, tmp)                            \
2095                 for (skb = (queue)->prev, tmp = skb->prev;                      \
2096                      skb != (struct sk_buff *)(queue);                          \
2097                      skb = tmp, tmp = skb->prev)
2098
2099 #define skb_queue_reverse_walk_from_safe(queue, skb, tmp)                       \
2100                 for (tmp = skb->prev;                                           \
2101                      skb != (struct sk_buff *)(queue);                          \
2102                      skb = tmp, tmp = skb->prev)
2103
2104 static inline bool skb_has_frag_list(const struct sk_buff *skb)
2105 {
2106         return skb_shinfo(skb)->frag_list != NULL;
2107 }
2108
2109 static inline void skb_frag_list_init(struct sk_buff *skb)
2110 {
2111         skb_shinfo(skb)->frag_list = NULL;
2112 }
2113
2114 static inline void skb_frag_add_head(struct sk_buff *skb, struct sk_buff *frag)
2115 {
2116         frag->next = skb_shinfo(skb)->frag_list;
2117         skb_shinfo(skb)->frag_list = frag;
2118 }
2119
2120 #define skb_walk_frags(skb, iter)       \
2121         for (iter = skb_shinfo(skb)->frag_list; iter; iter = iter->next)
2122
2123 extern struct sk_buff *__skb_recv_datagram(struct sock *sk, unsigned flags,
2124                                            int *peeked, int *err);
2125 extern struct sk_buff *skb_recv_datagram(struct sock *sk, unsigned flags,
2126                                          int noblock, int *err);
2127 extern unsigned int    datagram_poll(struct file *file, struct socket *sock,
2128                                      struct poll_table_struct *wait);
2129 extern int             skb_copy_datagram_iovec(const struct sk_buff *from,
2130                                                int offset, struct iovec *to,
2131                                                int size);
2132 extern int             skb_copy_and_csum_datagram_iovec(struct sk_buff *skb,
2133                                                         int hlen,
2134                                                         struct iovec *iov);
2135 extern int             skb_copy_datagram_from_iovec(struct sk_buff *skb,
2136                                                     int offset,
2137                                                     const struct iovec *from,
2138                                                     int from_offset,
2139                                                     int len);
2140 extern int             skb_copy_datagram_const_iovec(const struct sk_buff *from,
2141                                                      int offset,
2142                                                      const struct iovec *to,
2143                                                      int to_offset,
2144                                                      int size);
2145 extern void            skb_free_datagram(struct sock *sk, struct sk_buff *skb);
2146 extern void            skb_free_datagram_locked(struct sock *sk,
2147                                                 struct sk_buff *skb);
2148 extern int             skb_kill_datagram(struct sock *sk, struct sk_buff *skb,
2149                                          unsigned int flags);
2150 extern __wsum          skb_checksum(const struct sk_buff *skb, int offset,
2151                                     int len, __wsum csum);
2152 extern int             skb_copy_bits(const struct sk_buff *skb, int offset,
2153                                      void *to, int len);
2154 extern int             skb_store_bits(struct sk_buff *skb, int offset,
2155                                       const void *from, int len);
2156 extern __wsum          skb_copy_and_csum_bits(const struct sk_buff *skb,
2157                                               int offset, u8 *to, int len,
2158                                               __wsum csum);
2159 extern int             skb_splice_bits(struct sk_buff *skb,
2160                                                 unsigned int offset,
2161                                                 struct pipe_inode_info *pipe,
2162                                                 unsigned int len,
2163                                                 unsigned int flags);
2164 extern void            skb_copy_and_csum_dev(const struct sk_buff *skb, u8 *to);
2165 extern void            skb_split(struct sk_buff *skb,
2166                                  struct sk_buff *skb1, const u32 len);
2167 extern int             skb_shift(struct sk_buff *tgt, struct sk_buff *skb,
2168                                  int shiftlen);
2169
2170 extern struct sk_buff *skb_segment(struct sk_buff *skb, u32 features);
2171
2172 unsigned int skb_gso_transport_seglen(const struct sk_buff *skb);
2173
2174 static inline void *skb_header_pointer(const struct sk_buff *skb, int offset,
2175                                        int len, void *buffer)
2176 {
2177         int hlen = skb_headlen(skb);
2178
2179         if (hlen - offset >= len)
2180                 return skb->data + offset;
2181
2182         if (skb_copy_bits(skb, offset, buffer, len) < 0)
2183                 return NULL;
2184
2185         return buffer;
2186 }
2187
2188 static inline void skb_copy_from_linear_data(const struct sk_buff *skb,
2189                                              void *to,
2190                                              const unsigned int len)
2191 {
2192         memcpy(to, skb->data, len);
2193 }
2194
2195 static inline void skb_copy_from_linear_data_offset(const struct sk_buff *skb,
2196                                                     const int offset, void *to,
2197                                                     const unsigned int len)
2198 {
2199         memcpy(to, skb->data + offset, len);
2200 }
2201
2202 static inline void skb_copy_to_linear_data(struct sk_buff *skb,
2203                                            const void *from,
2204                                            const unsigned int len)
2205 {
2206         memcpy(skb->data, from, len);
2207 }
2208
2209 static inline void skb_copy_to_linear_data_offset(struct sk_buff *skb,
2210                                                   const int offset,
2211                                                   const void *from,
2212                                                   const unsigned int len)
2213 {
2214         memcpy(skb->data + offset, from, len);
2215 }
2216
2217 extern void skb_init(void);
2218
2219 static inline ktime_t skb_get_ktime(const struct sk_buff *skb)
2220 {
2221         return skb->tstamp;
2222 }
2223
2224 /**
2225  *      skb_get_timestamp - get timestamp from a skb
2226  *      @skb: skb to get stamp from
2227  *      @stamp: pointer to struct timeval to store stamp in
2228  *
2229  *      Timestamps are stored in the skb as offsets to a base timestamp.
2230  *      This function converts the offset back to a struct timeval and stores
2231  *      it in stamp.
2232  */
2233 static inline void skb_get_timestamp(const struct sk_buff *skb,
2234                                      struct timeval *stamp)
2235 {
2236         *stamp = ktime_to_timeval(skb->tstamp);
2237 }
2238
2239 static inline void skb_get_timestampns(const struct sk_buff *skb,
2240                                        struct timespec *stamp)
2241 {
2242         *stamp = ktime_to_timespec(skb->tstamp);
2243 }
2244
2245 static inline void __net_timestamp(struct sk_buff *skb)
2246 {
2247         skb->tstamp = ktime_get_real();
2248 }
2249
2250 static inline ktime_t net_timedelta(ktime_t t)
2251 {
2252         return ktime_sub(ktime_get_real(), t);
2253 }
2254
2255 static inline ktime_t net_invalid_timestamp(void)
2256 {
2257         return ktime_set(0, 0);
2258 }
2259
2260 extern void skb_timestamping_init(void);
2261
2262 #ifdef CONFIG_NETWORK_PHY_TIMESTAMPING
2263
2264 extern void skb_clone_tx_timestamp(struct sk_buff *skb);
2265 extern bool skb_defer_rx_timestamp(struct sk_buff *skb);
2266
2267 #else /* CONFIG_NETWORK_PHY_TIMESTAMPING */
2268
2269 static inline void skb_clone_tx_timestamp(struct sk_buff *skb)
2270 {
2271 }
2272
2273 static inline bool skb_defer_rx_timestamp(struct sk_buff *skb)
2274 {
2275         return false;
2276 }
2277
2278 #endif /* !CONFIG_NETWORK_PHY_TIMESTAMPING */
2279
2280 /**
2281  * skb_complete_tx_timestamp() - deliver cloned skb with tx timestamps
2282  *
2283  * PHY drivers may accept clones of transmitted packets for
2284  * timestamping via their phy_driver.txtstamp method. These drivers
2285  * must call this function to return the skb back to the stack, with
2286  * or without a timestamp.
2287  *
2288  * @skb: clone of the the original outgoing packet
2289  * @hwtstamps: hardware time stamps, may be NULL if not available
2290  *
2291  */
2292 void skb_complete_tx_timestamp(struct sk_buff *skb,
2293                                struct skb_shared_hwtstamps *hwtstamps);
2294
2295 /**
2296  * skb_tstamp_tx - queue clone of skb with send time stamps
2297  * @orig_skb:   the original outgoing packet
2298  * @hwtstamps:  hardware time stamps, may be NULL if not available
2299  *
2300  * If the skb has a socket associated, then this function clones the
2301  * skb (thus sharing the actual data and optional structures), stores
2302  * the optional hardware time stamping information (if non NULL) or
2303  * generates a software time stamp (otherwise), then queues the clone
2304  * to the error queue of the socket.  Errors are silently ignored.
2305  */
2306 extern void skb_tstamp_tx(struct sk_buff *orig_skb,
2307                         struct skb_shared_hwtstamps *hwtstamps);
2308
2309 static inline void sw_tx_timestamp(struct sk_buff *skb)
2310 {
2311         if (skb_shinfo(skb)->tx_flags & SKBTX_SW_TSTAMP &&
2312             !(skb_shinfo(skb)->tx_flags & SKBTX_IN_PROGRESS))
2313                 skb_tstamp_tx(skb, NULL);
2314 }
2315
2316 /**
2317  * skb_tx_timestamp() - Driver hook for transmit timestamping
2318  *
2319  * Ethernet MAC Drivers should call this function in their hard_xmit()
2320  * function immediately before giving the sk_buff to the MAC hardware.
2321  *
2322  * @skb: A socket buffer.
2323  */
2324 static inline void skb_tx_timestamp(struct sk_buff *skb)
2325 {
2326         skb_clone_tx_timestamp(skb);
2327         sw_tx_timestamp(skb);
2328 }
2329
2330 extern __sum16 __skb_checksum_complete_head(struct sk_buff *skb, int len);
2331 extern __sum16 __skb_checksum_complete(struct sk_buff *skb);
2332
2333 static inline int skb_csum_unnecessary(const struct sk_buff *skb)
2334 {
2335         return skb->ip_summed & CHECKSUM_UNNECESSARY;
2336 }
2337
2338 /**
2339  *      skb_checksum_complete - Calculate checksum of an entire packet
2340  *      @skb: packet to process
2341  *
2342  *      This function calculates the checksum over the entire packet plus
2343  *      the value of skb->csum.  The latter can be used to supply the
2344  *      checksum of a pseudo header as used by TCP/UDP.  It returns the
2345  *      checksum.
2346  *
2347  *      For protocols that contain complete checksums such as ICMP/TCP/UDP,
2348  *      this function can be used to verify that checksum on received
2349  *      packets.  In that case the function should return zero if the
2350  *      checksum is correct.  In particular, this function will return zero
2351  *      if skb->ip_summed is CHECKSUM_UNNECESSARY which indicates that the
2352  *      hardware has already verified the correctness of the checksum.
2353  */
2354 static inline __sum16 skb_checksum_complete(struct sk_buff *skb)
2355 {
2356         return skb_csum_unnecessary(skb) ?
2357                0 : __skb_checksum_complete(skb);
2358 }
2359
2360 #if defined(CONFIG_NF_CONNTRACK) || defined(CONFIG_NF_CONNTRACK_MODULE)
2361 extern void nf_conntrack_destroy(struct nf_conntrack *nfct);
2362 static inline void nf_conntrack_put(struct nf_conntrack *nfct)
2363 {
2364         if (nfct && atomic_dec_and_test(&nfct->use))
2365                 nf_conntrack_destroy(nfct);
2366 }
2367 static inline void nf_conntrack_get(struct nf_conntrack *nfct)
2368 {
2369         if (nfct)
2370                 atomic_inc(&nfct->use);
2371 }
2372 #endif
2373 #ifdef NET_SKBUFF_NF_DEFRAG_NEEDED
2374 static inline void nf_conntrack_get_reasm(struct sk_buff *skb)
2375 {
2376         if (skb)
2377                 atomic_inc(&skb->users);
2378 }
2379 static inline void nf_conntrack_put_reasm(struct sk_buff *skb)
2380 {
2381         if (skb)
2382                 kfree_skb(skb);
2383 }
2384 #endif
2385 #ifdef CONFIG_BRIDGE_NETFILTER
2386 static inline void nf_bridge_put(struct nf_bridge_info *nf_bridge)
2387 {
2388         if (nf_bridge && atomic_dec_and_test(&nf_bridge->use))
2389                 kfree(nf_bridge);
2390 }
2391 static inline void nf_bridge_get(struct nf_bridge_info *nf_bridge)
2392 {
2393         if (nf_bridge)
2394                 atomic_inc(&nf_bridge->use);
2395 }
2396 #endif /* CONFIG_BRIDGE_NETFILTER */
2397 static inline void nf_reset(struct sk_buff *skb)
2398 {
2399 #if defined(CONFIG_NF_CONNTRACK) || defined(CONFIG_NF_CONNTRACK_MODULE)
2400         nf_conntrack_put(skb->nfct);
2401         skb->nfct = NULL;
2402 #endif
2403 #ifdef NET_SKBUFF_NF_DEFRAG_NEEDED
2404         nf_conntrack_put_reasm(skb->nfct_reasm);
2405         skb->nfct_reasm = NULL;
2406 #endif
2407 #ifdef CONFIG_BRIDGE_NETFILTER
2408         nf_bridge_put(skb->nf_bridge);
2409         skb->nf_bridge = NULL;
2410 #endif
2411 }
2412
2413 static inline void nf_reset_trace(struct sk_buff *skb)
2414 {
2415 #if IS_ENABLED(CONFIG_NETFILTER_XT_TARGET_TRACE)
2416         skb->nf_trace = 0;
2417 #endif
2418 }
2419
2420 /* Note: This doesn't put any conntrack and bridge info in dst. */
2421 static inline void __nf_copy(struct sk_buff *dst, const struct sk_buff *src)
2422 {
2423 #if defined(CONFIG_NF_CONNTRACK) || defined(CONFIG_NF_CONNTRACK_MODULE)
2424         dst->nfct = src->nfct;
2425         nf_conntrack_get(src->nfct);
2426         dst->nfctinfo = src->nfctinfo;
2427 #endif
2428 #ifdef NET_SKBUFF_NF_DEFRAG_NEEDED
2429         dst->nfct_reasm = src->nfct_reasm;
2430         nf_conntrack_get_reasm(src->nfct_reasm);
2431 #endif
2432 #ifdef CONFIG_BRIDGE_NETFILTER
2433         dst->nf_bridge  = src->nf_bridge;
2434         nf_bridge_get(src->nf_bridge);
2435 #endif
2436 }
2437
2438 static inline void nf_copy(struct sk_buff *dst, const struct sk_buff *src)
2439 {
2440 #if defined(CONFIG_NF_CONNTRACK) || defined(CONFIG_NF_CONNTRACK_MODULE)
2441         nf_conntrack_put(dst->nfct);
2442 #endif
2443 #ifdef NET_SKBUFF_NF_DEFRAG_NEEDED
2444         nf_conntrack_put_reasm(dst->nfct_reasm);
2445 #endif
2446 #ifdef CONFIG_BRIDGE_NETFILTER
2447         nf_bridge_put(dst->nf_bridge);
2448 #endif
2449         __nf_copy(dst, src);
2450 }
2451
2452 #ifdef CONFIG_NETWORK_SECMARK
2453 static inline void skb_copy_secmark(struct sk_buff *to, const struct sk_buff *from)
2454 {
2455         to->secmark = from->secmark;
2456 }
2457
2458 static inline void skb_init_secmark(struct sk_buff *skb)
2459 {
2460         skb->secmark = 0;
2461 }
2462 #else
2463 static inline void skb_copy_secmark(struct sk_buff *to, const struct sk_buff *from)
2464 { }
2465
2466 static inline void skb_init_secmark(struct sk_buff *skb)
2467 { }
2468 #endif
2469
2470 static inline void skb_set_queue_mapping(struct sk_buff *skb, u16 queue_mapping)
2471 {
2472         skb->queue_mapping = queue_mapping;
2473 }
2474
2475 static inline u16 skb_get_queue_mapping(const struct sk_buff *skb)
2476 {
2477         return skb->queue_mapping;
2478 }
2479
2480 static inline void skb_copy_queue_mapping(struct sk_buff *to, const struct sk_buff *from)
2481 {
2482         to->queue_mapping = from->queue_mapping;
2483 }
2484
2485 static inline void skb_record_rx_queue(struct sk_buff *skb, u16 rx_queue)
2486 {
2487         skb->queue_mapping = rx_queue + 1;
2488 }
2489
2490 static inline u16 skb_get_rx_queue(const struct sk_buff *skb)
2491 {
2492         return skb->queue_mapping - 1;
2493 }
2494
2495 static inline bool skb_rx_queue_recorded(const struct sk_buff *skb)
2496 {
2497         return skb->queue_mapping != 0;
2498 }
2499
2500 extern u16 __skb_tx_hash(const struct net_device *dev,
2501                          const struct sk_buff *skb,
2502                          unsigned int num_tx_queues);
2503
2504 #ifdef CONFIG_XFRM
2505 static inline struct sec_path *skb_sec_path(struct sk_buff *skb)
2506 {
2507         return skb->sp;
2508 }
2509 #else
2510 static inline struct sec_path *skb_sec_path(struct sk_buff *skb)
2511 {
2512         return NULL;
2513 }
2514 #endif
2515
2516 static inline int skb_is_gso(const struct sk_buff *skb)
2517 {
2518         return skb_shinfo(skb)->gso_size;
2519 }
2520
2521 static inline int skb_is_gso_v6(const struct sk_buff *skb)
2522 {
2523         return skb_shinfo(skb)->gso_type & SKB_GSO_TCPV6;
2524 }
2525
2526 extern void __skb_warn_lro_forwarding(const struct sk_buff *skb);
2527
2528 static inline bool skb_warn_if_lro(const struct sk_buff *skb)
2529 {
2530         /* LRO sets gso_size but not gso_type, whereas if GSO is really
2531          * wanted then gso_type will be set. */
2532         const struct skb_shared_info *shinfo = skb_shinfo(skb);
2533
2534         if (skb_is_nonlinear(skb) && shinfo->gso_size != 0 &&
2535             unlikely(shinfo->gso_type == 0)) {
2536                 __skb_warn_lro_forwarding(skb);
2537                 return true;
2538         }
2539         return false;
2540 }
2541
2542 static inline void skb_forward_csum(struct sk_buff *skb)
2543 {
2544         /* Unfortunately we don't support this one.  Any brave souls? */
2545         if (skb->ip_summed == CHECKSUM_COMPLETE)
2546                 skb->ip_summed = CHECKSUM_NONE;
2547 }
2548
2549 /**
2550  * skb_checksum_none_assert - make sure skb ip_summed is CHECKSUM_NONE
2551  * @skb: skb to check
2552  *
2553  * fresh skbs have their ip_summed set to CHECKSUM_NONE.
2554  * Instead of forcing ip_summed to CHECKSUM_NONE, we can
2555  * use this helper, to document places where we make this assertion.
2556  */
2557 static inline void skb_checksum_none_assert(const struct sk_buff *skb)
2558 {
2559 #ifdef DEBUG
2560         BUG_ON(skb->ip_summed != CHECKSUM_NONE);
2561 #endif
2562 }
2563
2564 bool skb_partial_csum_set(struct sk_buff *skb, u16 start, u16 off);
2565
2566 static inline bool skb_is_recycleable(const struct sk_buff *skb, int skb_size)
2567 {
2568         if (irqs_disabled())
2569                 return false;
2570
2571         if (skb_shinfo(skb)->tx_flags & SKBTX_DEV_ZEROCOPY)
2572                 return false;
2573
2574         if (skb_is_nonlinear(skb) || skb->fclone != SKB_FCLONE_UNAVAILABLE)
2575                 return false;
2576
2577         skb_size = SKB_DATA_ALIGN(skb_size + NET_SKB_PAD);
2578         if (skb_end_offset(skb) < skb_size)
2579                 return false;
2580
2581         if (skb_shared(skb) || skb_cloned(skb))
2582                 return false;
2583
2584         return true;
2585 }
2586 #endif  /* __KERNEL__ */
2587 #endif  /* _LINUX_SKBUFF_H */