tcp: must unclone packets before mangling them
[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 #else
621 static inline unsigned char *skb_end_pointer(const struct sk_buff *skb)
622 {
623         return skb->end;
624 }
625 #endif
626
627 /* Internal */
628 #define skb_shinfo(SKB) ((struct skb_shared_info *)(skb_end_pointer(SKB)))
629
630 static inline struct skb_shared_hwtstamps *skb_hwtstamps(struct sk_buff *skb)
631 {
632         return &skb_shinfo(skb)->hwtstamps;
633 }
634
635 /**
636  *      skb_queue_empty - check if a queue is empty
637  *      @list: queue head
638  *
639  *      Returns true if the queue is empty, false otherwise.
640  */
641 static inline int skb_queue_empty(const struct sk_buff_head *list)
642 {
643         return list->next == (struct sk_buff *)list;
644 }
645
646 /**
647  *      skb_queue_is_last - check if skb is the last entry in the queue
648  *      @list: queue head
649  *      @skb: buffer
650  *
651  *      Returns true if @skb is the last buffer on the list.
652  */
653 static inline bool skb_queue_is_last(const struct sk_buff_head *list,
654                                      const struct sk_buff *skb)
655 {
656         return skb->next == (struct sk_buff *)list;
657 }
658
659 /**
660  *      skb_queue_is_first - check if skb is the first entry in the queue
661  *      @list: queue head
662  *      @skb: buffer
663  *
664  *      Returns true if @skb is the first buffer on the list.
665  */
666 static inline bool skb_queue_is_first(const struct sk_buff_head *list,
667                                       const struct sk_buff *skb)
668 {
669         return skb->prev == (struct sk_buff *)list;
670 }
671
672 /**
673  *      skb_queue_next - return the next packet in the queue
674  *      @list: queue head
675  *      @skb: current buffer
676  *
677  *      Return the next packet in @list after @skb.  It is only valid to
678  *      call this if skb_queue_is_last() evaluates to false.
679  */
680 static inline struct sk_buff *skb_queue_next(const struct sk_buff_head *list,
681                                              const struct sk_buff *skb)
682 {
683         /* This BUG_ON may seem severe, but if we just return then we
684          * are going to dereference garbage.
685          */
686         BUG_ON(skb_queue_is_last(list, skb));
687         return skb->next;
688 }
689
690 /**
691  *      skb_queue_prev - return the prev packet in the queue
692  *      @list: queue head
693  *      @skb: current buffer
694  *
695  *      Return the prev packet in @list before @skb.  It is only valid to
696  *      call this if skb_queue_is_first() evaluates to false.
697  */
698 static inline struct sk_buff *skb_queue_prev(const struct sk_buff_head *list,
699                                              const struct sk_buff *skb)
700 {
701         /* This BUG_ON may seem severe, but if we just return then we
702          * are going to dereference garbage.
703          */
704         BUG_ON(skb_queue_is_first(list, skb));
705         return skb->prev;
706 }
707
708 /**
709  *      skb_get - reference buffer
710  *      @skb: buffer to reference
711  *
712  *      Makes another reference to a socket buffer and returns a pointer
713  *      to the buffer.
714  */
715 static inline struct sk_buff *skb_get(struct sk_buff *skb)
716 {
717         atomic_inc(&skb->users);
718         return skb;
719 }
720
721 /*
722  * If users == 1, we are the only owner and are can avoid redundant
723  * atomic change.
724  */
725
726 /**
727  *      skb_cloned - is the buffer a clone
728  *      @skb: buffer to check
729  *
730  *      Returns true if the buffer was generated with skb_clone() and is
731  *      one of multiple shared copies of the buffer. Cloned buffers are
732  *      shared data so must not be written to under normal circumstances.
733  */
734 static inline int skb_cloned(const struct sk_buff *skb)
735 {
736         return skb->cloned &&
737                (atomic_read(&skb_shinfo(skb)->dataref) & SKB_DATAREF_MASK) != 1;
738 }
739
740 static inline int skb_unclone(struct sk_buff *skb, gfp_t pri)
741 {
742         might_sleep_if(pri & __GFP_WAIT);
743
744         if (skb_cloned(skb))
745                 return pskb_expand_head(skb, 0, 0, pri);
746
747         return 0;
748 }
749
750 /**
751  *      skb_header_cloned - is the header a clone
752  *      @skb: buffer to check
753  *
754  *      Returns true if modifying the header part of the buffer requires
755  *      the data to be copied.
756  */
757 static inline int skb_header_cloned(const struct sk_buff *skb)
758 {
759         int dataref;
760
761         if (!skb->cloned)
762                 return 0;
763
764         dataref = atomic_read(&skb_shinfo(skb)->dataref);
765         dataref = (dataref & SKB_DATAREF_MASK) - (dataref >> SKB_DATAREF_SHIFT);
766         return dataref != 1;
767 }
768
769 /**
770  *      skb_header_release - release reference to header
771  *      @skb: buffer to operate on
772  *
773  *      Drop a reference to the header part of the buffer.  This is done
774  *      by acquiring a payload reference.  You must not read from the header
775  *      part of skb->data after this.
776  */
777 static inline void skb_header_release(struct sk_buff *skb)
778 {
779         BUG_ON(skb->nohdr);
780         skb->nohdr = 1;
781         atomic_add(1 << SKB_DATAREF_SHIFT, &skb_shinfo(skb)->dataref);
782 }
783
784 /**
785  *      skb_shared - is the buffer shared
786  *      @skb: buffer to check
787  *
788  *      Returns true if more than one person has a reference to this
789  *      buffer.
790  */
791 static inline int skb_shared(const struct sk_buff *skb)
792 {
793         return atomic_read(&skb->users) != 1;
794 }
795
796 /**
797  *      skb_share_check - check if buffer is shared and if so clone it
798  *      @skb: buffer to check
799  *      @pri: priority for memory allocation
800  *
801  *      If the buffer is shared the buffer is cloned and the old copy
802  *      drops a reference. A new clone with a single reference is returned.
803  *      If the buffer is not shared the original buffer is returned. When
804  *      being called from interrupt status or with spinlocks held pri must
805  *      be GFP_ATOMIC.
806  *
807  *      NULL is returned on a memory allocation failure.
808  */
809 static inline struct sk_buff *skb_share_check(struct sk_buff *skb,
810                                               gfp_t pri)
811 {
812         might_sleep_if(pri & __GFP_WAIT);
813         if (skb_shared(skb)) {
814                 struct sk_buff *nskb = skb_clone(skb, pri);
815                 kfree_skb(skb);
816                 skb = nskb;
817         }
818         return skb;
819 }
820
821 /*
822  *      Copy shared buffers into a new sk_buff. We effectively do COW on
823  *      packets to handle cases where we have a local reader and forward
824  *      and a couple of other messy ones. The normal one is tcpdumping
825  *      a packet thats being forwarded.
826  */
827
828 /**
829  *      skb_unshare - make a copy of a shared buffer
830  *      @skb: buffer to check
831  *      @pri: priority for memory allocation
832  *
833  *      If the socket buffer is a clone then this function creates a new
834  *      copy of the data, drops a reference count on the old copy and returns
835  *      the new copy with the reference count at 1. If the buffer is not a clone
836  *      the original buffer is returned. When called with a spinlock held or
837  *      from interrupt state @pri must be %GFP_ATOMIC
838  *
839  *      %NULL is returned on a memory allocation failure.
840  */
841 static inline struct sk_buff *skb_unshare(struct sk_buff *skb,
842                                           gfp_t pri)
843 {
844         might_sleep_if(pri & __GFP_WAIT);
845         if (skb_cloned(skb)) {
846                 struct sk_buff *nskb = skb_copy(skb, pri);
847                 kfree_skb(skb); /* Free our shared copy */
848                 skb = nskb;
849         }
850         return skb;
851 }
852
853 /**
854  *      skb_peek - peek at the head of an &sk_buff_head
855  *      @list_: list to peek at
856  *
857  *      Peek an &sk_buff. Unlike most other operations you _MUST_
858  *      be careful with this one. A peek leaves the buffer on the
859  *      list and someone else may run off with it. You must hold
860  *      the appropriate locks or have a private queue to do this.
861  *
862  *      Returns %NULL for an empty list or a pointer to the head element.
863  *      The reference count is not incremented and the reference is therefore
864  *      volatile. Use with caution.
865  */
866 static inline struct sk_buff *skb_peek(const struct sk_buff_head *list_)
867 {
868         struct sk_buff *list = ((const struct sk_buff *)list_)->next;
869         if (list == (struct sk_buff *)list_)
870                 list = NULL;
871         return list;
872 }
873
874 /**
875  *      skb_peek_tail - peek at the tail of an &sk_buff_head
876  *      @list_: list to peek at
877  *
878  *      Peek an &sk_buff. Unlike most other operations you _MUST_
879  *      be careful with this one. A peek leaves the buffer on the
880  *      list and someone else may run off with it. You must hold
881  *      the appropriate locks or have a private queue to do this.
882  *
883  *      Returns %NULL for an empty list or a pointer to the tail element.
884  *      The reference count is not incremented and the reference is therefore
885  *      volatile. Use with caution.
886  */
887 static inline struct sk_buff *skb_peek_tail(const struct sk_buff_head *list_)
888 {
889         struct sk_buff *list = ((const struct sk_buff *)list_)->prev;
890         if (list == (struct sk_buff *)list_)
891                 list = NULL;
892         return list;
893 }
894
895 /**
896  *      skb_queue_len   - get queue length
897  *      @list_: list to measure
898  *
899  *      Return the length of an &sk_buff queue.
900  */
901 static inline __u32 skb_queue_len(const struct sk_buff_head *list_)
902 {
903         return list_->qlen;
904 }
905
906 /**
907  *      __skb_queue_head_init - initialize non-spinlock portions of sk_buff_head
908  *      @list: queue to initialize
909  *
910  *      This initializes only the list and queue length aspects of
911  *      an sk_buff_head object.  This allows to initialize the list
912  *      aspects of an sk_buff_head without reinitializing things like
913  *      the spinlock.  It can also be used for on-stack sk_buff_head
914  *      objects where the spinlock is known to not be used.
915  */
916 static inline void __skb_queue_head_init(struct sk_buff_head *list)
917 {
918         list->prev = list->next = (struct sk_buff *)list;
919         list->qlen = 0;
920 }
921
922 /*
923  * This function creates a split out lock class for each invocation;
924  * this is needed for now since a whole lot of users of the skb-queue
925  * infrastructure in drivers have different locking usage (in hardirq)
926  * than the networking core (in softirq only). In the long run either the
927  * network layer or drivers should need annotation to consolidate the
928  * main types of usage into 3 classes.
929  */
930 static inline void skb_queue_head_init(struct sk_buff_head *list)
931 {
932         spin_lock_init(&list->lock);
933         __skb_queue_head_init(list);
934 }
935
936 static inline void skb_queue_head_init_class(struct sk_buff_head *list,
937                 struct lock_class_key *class)
938 {
939         skb_queue_head_init(list);
940         lockdep_set_class(&list->lock, class);
941 }
942
943 /*
944  *      Insert an sk_buff on a list.
945  *
946  *      The "__skb_xxxx()" functions are the non-atomic ones that
947  *      can only be called with interrupts disabled.
948  */
949 extern void        skb_insert(struct sk_buff *old, struct sk_buff *newsk, struct sk_buff_head *list);
950 static inline void __skb_insert(struct sk_buff *newsk,
951                                 struct sk_buff *prev, struct sk_buff *next,
952                                 struct sk_buff_head *list)
953 {
954         newsk->next = next;
955         newsk->prev = prev;
956         next->prev  = prev->next = newsk;
957         list->qlen++;
958 }
959
960 static inline void __skb_queue_splice(const struct sk_buff_head *list,
961                                       struct sk_buff *prev,
962                                       struct sk_buff *next)
963 {
964         struct sk_buff *first = list->next;
965         struct sk_buff *last = list->prev;
966
967         first->prev = prev;
968         prev->next = first;
969
970         last->next = next;
971         next->prev = last;
972 }
973
974 /**
975  *      skb_queue_splice - join two skb lists, this is designed for stacks
976  *      @list: the new list to add
977  *      @head: the place to add it in the first list
978  */
979 static inline void skb_queue_splice(const struct sk_buff_head *list,
980                                     struct sk_buff_head *head)
981 {
982         if (!skb_queue_empty(list)) {
983                 __skb_queue_splice(list, (struct sk_buff *) head, head->next);
984                 head->qlen += list->qlen;
985         }
986 }
987
988 /**
989  *      skb_queue_splice - join two skb lists and reinitialise the emptied list
990  *      @list: the new list to add
991  *      @head: the place to add it in the first list
992  *
993  *      The list at @list is reinitialised
994  */
995 static inline void skb_queue_splice_init(struct sk_buff_head *list,
996                                          struct sk_buff_head *head)
997 {
998         if (!skb_queue_empty(list)) {
999                 __skb_queue_splice(list, (struct sk_buff *) head, head->next);
1000                 head->qlen += list->qlen;
1001                 __skb_queue_head_init(list);
1002         }
1003 }
1004
1005 /**
1006  *      skb_queue_splice_tail - join two skb lists, each list being a queue
1007  *      @list: the new list to add
1008  *      @head: the place to add it in the first list
1009  */
1010 static inline void skb_queue_splice_tail(const struct sk_buff_head *list,
1011                                          struct sk_buff_head *head)
1012 {
1013         if (!skb_queue_empty(list)) {
1014                 __skb_queue_splice(list, head->prev, (struct sk_buff *) head);
1015                 head->qlen += list->qlen;
1016         }
1017 }
1018
1019 /**
1020  *      skb_queue_splice_tail - join two skb lists and reinitialise the emptied list
1021  *      @list: the new list to add
1022  *      @head: the place to add it in the first list
1023  *
1024  *      Each of the lists is a queue.
1025  *      The list at @list is reinitialised
1026  */
1027 static inline void skb_queue_splice_tail_init(struct sk_buff_head *list,
1028                                               struct sk_buff_head *head)
1029 {
1030         if (!skb_queue_empty(list)) {
1031                 __skb_queue_splice(list, head->prev, (struct sk_buff *) head);
1032                 head->qlen += list->qlen;
1033                 __skb_queue_head_init(list);
1034         }
1035 }
1036
1037 /**
1038  *      __skb_queue_after - queue a buffer at the list head
1039  *      @list: list to use
1040  *      @prev: place after this buffer
1041  *      @newsk: buffer to queue
1042  *
1043  *      Queue a buffer int the middle of a list. This function takes no locks
1044  *      and you must therefore hold required locks before calling it.
1045  *
1046  *      A buffer cannot be placed on two lists at the same time.
1047  */
1048 static inline void __skb_queue_after(struct sk_buff_head *list,
1049                                      struct sk_buff *prev,
1050                                      struct sk_buff *newsk)
1051 {
1052         __skb_insert(newsk, prev, prev->next, list);
1053 }
1054
1055 extern void skb_append(struct sk_buff *old, struct sk_buff *newsk,
1056                        struct sk_buff_head *list);
1057
1058 static inline void __skb_queue_before(struct sk_buff_head *list,
1059                                       struct sk_buff *next,
1060                                       struct sk_buff *newsk)
1061 {
1062         __skb_insert(newsk, next->prev, next, list);
1063 }
1064
1065 /**
1066  *      __skb_queue_head - queue a buffer at the list head
1067  *      @list: list to use
1068  *      @newsk: buffer to queue
1069  *
1070  *      Queue a buffer at the start of a list. This function takes no locks
1071  *      and you must therefore hold required locks before calling it.
1072  *
1073  *      A buffer cannot be placed on two lists at the same time.
1074  */
1075 extern void skb_queue_head(struct sk_buff_head *list, struct sk_buff *newsk);
1076 static inline void __skb_queue_head(struct sk_buff_head *list,
1077                                     struct sk_buff *newsk)
1078 {
1079         __skb_queue_after(list, (struct sk_buff *)list, newsk);
1080 }
1081
1082 /**
1083  *      __skb_queue_tail - queue a buffer at the list tail
1084  *      @list: list to use
1085  *      @newsk: buffer to queue
1086  *
1087  *      Queue a buffer at the end of a list. This function takes no locks
1088  *      and you must therefore hold required locks before calling it.
1089  *
1090  *      A buffer cannot be placed on two lists at the same time.
1091  */
1092 extern void skb_queue_tail(struct sk_buff_head *list, struct sk_buff *newsk);
1093 static inline void __skb_queue_tail(struct sk_buff_head *list,
1094                                    struct sk_buff *newsk)
1095 {
1096         __skb_queue_before(list, (struct sk_buff *)list, newsk);
1097 }
1098
1099 /*
1100  * remove sk_buff from list. _Must_ be called atomically, and with
1101  * the list known..
1102  */
1103 extern void        skb_unlink(struct sk_buff *skb, struct sk_buff_head *list);
1104 static inline void __skb_unlink(struct sk_buff *skb, struct sk_buff_head *list)
1105 {
1106         struct sk_buff *next, *prev;
1107
1108         list->qlen--;
1109         next       = skb->next;
1110         prev       = skb->prev;
1111         skb->next  = skb->prev = NULL;
1112         next->prev = prev;
1113         prev->next = next;
1114 }
1115
1116 /**
1117  *      __skb_dequeue - remove from the head of the queue
1118  *      @list: list to dequeue from
1119  *
1120  *      Remove the head of the list. This function does not take any locks
1121  *      so must be used with appropriate locks held only. The head item is
1122  *      returned or %NULL if the list is empty.
1123  */
1124 extern struct sk_buff *skb_dequeue(struct sk_buff_head *list);
1125 static inline struct sk_buff *__skb_dequeue(struct sk_buff_head *list)
1126 {
1127         struct sk_buff *skb = skb_peek(list);
1128         if (skb)
1129                 __skb_unlink(skb, list);
1130         return skb;
1131 }
1132
1133 /**
1134  *      __skb_dequeue_tail - remove from the tail of the queue
1135  *      @list: list to dequeue from
1136  *
1137  *      Remove the tail of the list. This function does not take any locks
1138  *      so must be used with appropriate locks held only. The tail item is
1139  *      returned or %NULL if the list is empty.
1140  */
1141 extern struct sk_buff *skb_dequeue_tail(struct sk_buff_head *list);
1142 static inline struct sk_buff *__skb_dequeue_tail(struct sk_buff_head *list)
1143 {
1144         struct sk_buff *skb = skb_peek_tail(list);
1145         if (skb)
1146                 __skb_unlink(skb, list);
1147         return skb;
1148 }
1149
1150
1151 static inline int skb_is_nonlinear(const struct sk_buff *skb)
1152 {
1153         return skb->data_len;
1154 }
1155
1156 static inline unsigned int skb_headlen(const struct sk_buff *skb)
1157 {
1158         return skb->len - skb->data_len;
1159 }
1160
1161 static inline int skb_pagelen(const struct sk_buff *skb)
1162 {
1163         int i, len = 0;
1164
1165         for (i = (int)skb_shinfo(skb)->nr_frags - 1; i >= 0; i--)
1166                 len += skb_frag_size(&skb_shinfo(skb)->frags[i]);
1167         return len + skb_headlen(skb);
1168 }
1169
1170 /**
1171  * __skb_fill_page_desc - initialise a paged fragment in an skb
1172  * @skb: buffer containing fragment to be initialised
1173  * @i: paged fragment index to initialise
1174  * @page: the page to use for this fragment
1175  * @off: the offset to the data with @page
1176  * @size: the length of the data
1177  *
1178  * Initialises the @i'th fragment of @skb to point to &size bytes at
1179  * offset @off within @page.
1180  *
1181  * Does not take any additional reference on the fragment.
1182  */
1183 static inline void __skb_fill_page_desc(struct sk_buff *skb, int i,
1184                                         struct page *page, int off, int size)
1185 {
1186         skb_frag_t *frag = &skb_shinfo(skb)->frags[i];
1187
1188         frag->page.p              = page;
1189         frag->page_offset         = off;
1190         skb_frag_size_set(frag, size);
1191 }
1192
1193 /**
1194  * skb_fill_page_desc - initialise a paged fragment in an skb
1195  * @skb: buffer containing fragment to be initialised
1196  * @i: paged fragment index to initialise
1197  * @page: the page to use for this fragment
1198  * @off: the offset to the data with @page
1199  * @size: the length of the data
1200  *
1201  * As per __skb_fill_page_desc() -- initialises the @i'th fragment of
1202  * @skb to point to &size bytes at offset @off within @page. In
1203  * addition updates @skb such that @i is the last fragment.
1204  *
1205  * Does not take any additional reference on the fragment.
1206  */
1207 static inline void skb_fill_page_desc(struct sk_buff *skb, int i,
1208                                       struct page *page, int off, int size)
1209 {
1210         __skb_fill_page_desc(skb, i, page, off, size);
1211         skb_shinfo(skb)->nr_frags = i + 1;
1212 }
1213
1214 extern void skb_add_rx_frag(struct sk_buff *skb, int i, struct page *page,
1215                             int off, int size);
1216
1217 #define SKB_PAGE_ASSERT(skb)    BUG_ON(skb_shinfo(skb)->nr_frags)
1218 #define SKB_FRAG_ASSERT(skb)    BUG_ON(skb_has_frag_list(skb))
1219 #define SKB_LINEAR_ASSERT(skb)  BUG_ON(skb_is_nonlinear(skb))
1220
1221 #ifdef NET_SKBUFF_DATA_USES_OFFSET
1222 static inline unsigned char *skb_tail_pointer(const struct sk_buff *skb)
1223 {
1224         return skb->head + skb->tail;
1225 }
1226
1227 static inline void skb_reset_tail_pointer(struct sk_buff *skb)
1228 {
1229         skb->tail = skb->data - skb->head;
1230 }
1231
1232 static inline void skb_set_tail_pointer(struct sk_buff *skb, const int offset)
1233 {
1234         skb_reset_tail_pointer(skb);
1235         skb->tail += offset;
1236 }
1237 #else /* NET_SKBUFF_DATA_USES_OFFSET */
1238 static inline unsigned char *skb_tail_pointer(const struct sk_buff *skb)
1239 {
1240         return skb->tail;
1241 }
1242
1243 static inline void skb_reset_tail_pointer(struct sk_buff *skb)
1244 {
1245         skb->tail = skb->data;
1246 }
1247
1248 static inline void skb_set_tail_pointer(struct sk_buff *skb, const int offset)
1249 {
1250         skb->tail = skb->data + offset;
1251 }
1252
1253 #endif /* NET_SKBUFF_DATA_USES_OFFSET */
1254
1255 /*
1256  *      Add data to an sk_buff
1257  */
1258 extern unsigned char *skb_put(struct sk_buff *skb, unsigned int len);
1259 static inline unsigned char *__skb_put(struct sk_buff *skb, unsigned int len)
1260 {
1261         unsigned char *tmp = skb_tail_pointer(skb);
1262         SKB_LINEAR_ASSERT(skb);
1263         skb->tail += len;
1264         skb->len  += len;
1265         return tmp;
1266 }
1267
1268 extern unsigned char *skb_push(struct sk_buff *skb, unsigned int len);
1269 static inline unsigned char *__skb_push(struct sk_buff *skb, unsigned int len)
1270 {
1271         skb->data -= len;
1272         skb->len  += len;
1273         return skb->data;
1274 }
1275
1276 extern unsigned char *skb_pull(struct sk_buff *skb, unsigned int len);
1277 static inline unsigned char *__skb_pull(struct sk_buff *skb, unsigned int len)
1278 {
1279         skb->len -= len;
1280         BUG_ON(skb->len < skb->data_len);
1281         return skb->data += len;
1282 }
1283
1284 static inline unsigned char *skb_pull_inline(struct sk_buff *skb, unsigned int len)
1285 {
1286         return unlikely(len > skb->len) ? NULL : __skb_pull(skb, len);
1287 }
1288
1289 extern unsigned char *__pskb_pull_tail(struct sk_buff *skb, int delta);
1290
1291 static inline unsigned char *__pskb_pull(struct sk_buff *skb, unsigned int len)
1292 {
1293         if (len > skb_headlen(skb) &&
1294             !__pskb_pull_tail(skb, len - skb_headlen(skb)))
1295                 return NULL;
1296         skb->len -= len;
1297         return skb->data += len;
1298 }
1299
1300 static inline unsigned char *pskb_pull(struct sk_buff *skb, unsigned int len)
1301 {
1302         return unlikely(len > skb->len) ? NULL : __pskb_pull(skb, len);
1303 }
1304
1305 static inline int pskb_may_pull(struct sk_buff *skb, unsigned int len)
1306 {
1307         if (likely(len <= skb_headlen(skb)))
1308                 return 1;
1309         if (unlikely(len > skb->len))
1310                 return 0;
1311         return __pskb_pull_tail(skb, len - skb_headlen(skb)) != NULL;
1312 }
1313
1314 /**
1315  *      skb_headroom - bytes at buffer head
1316  *      @skb: buffer to check
1317  *
1318  *      Return the number of bytes of free space at the head of an &sk_buff.
1319  */
1320 static inline unsigned int skb_headroom(const struct sk_buff *skb)
1321 {
1322         return skb->data - skb->head;
1323 }
1324
1325 /**
1326  *      skb_tailroom - bytes at buffer end
1327  *      @skb: buffer to check
1328  *
1329  *      Return the number of bytes of free space at the tail of an sk_buff
1330  */
1331 static inline int skb_tailroom(const struct sk_buff *skb)
1332 {
1333         return skb_is_nonlinear(skb) ? 0 : skb->end - skb->tail;
1334 }
1335
1336 /**
1337  *      skb_availroom - bytes at buffer end
1338  *      @skb: buffer to check
1339  *
1340  *      Return the number of bytes of free space at the tail of an sk_buff
1341  *      allocated by sk_stream_alloc()
1342  */
1343 static inline int skb_availroom(const struct sk_buff *skb)
1344 {
1345         if (skb_is_nonlinear(skb))
1346                 return 0;
1347
1348         return skb->end - skb->tail - skb->reserved_tailroom;
1349 }
1350
1351 /**
1352  *      skb_reserve - adjust headroom
1353  *      @skb: buffer to alter
1354  *      @len: bytes to move
1355  *
1356  *      Increase the headroom of an empty &sk_buff by reducing the tail
1357  *      room. This is only allowed for an empty buffer.
1358  */
1359 static inline void skb_reserve(struct sk_buff *skb, int len)
1360 {
1361         skb->data += len;
1362         skb->tail += len;
1363 }
1364
1365 static inline void skb_reset_mac_len(struct sk_buff *skb)
1366 {
1367         skb->mac_len = skb->network_header - skb->mac_header;
1368 }
1369
1370 #ifdef NET_SKBUFF_DATA_USES_OFFSET
1371 static inline unsigned char *skb_transport_header(const struct sk_buff *skb)
1372 {
1373         return skb->head + skb->transport_header;
1374 }
1375
1376 static inline void skb_reset_transport_header(struct sk_buff *skb)
1377 {
1378         skb->transport_header = skb->data - skb->head;
1379 }
1380
1381 static inline void skb_set_transport_header(struct sk_buff *skb,
1382                                             const int offset)
1383 {
1384         skb_reset_transport_header(skb);
1385         skb->transport_header += offset;
1386 }
1387
1388 static inline unsigned char *skb_network_header(const struct sk_buff *skb)
1389 {
1390         return skb->head + skb->network_header;
1391 }
1392
1393 static inline void skb_reset_network_header(struct sk_buff *skb)
1394 {
1395         skb->network_header = skb->data - skb->head;
1396 }
1397
1398 static inline void skb_set_network_header(struct sk_buff *skb, const int offset)
1399 {
1400         skb_reset_network_header(skb);
1401         skb->network_header += offset;
1402 }
1403
1404 static inline unsigned char *skb_mac_header(const struct sk_buff *skb)
1405 {
1406         return skb->head + skb->mac_header;
1407 }
1408
1409 static inline int skb_mac_header_was_set(const struct sk_buff *skb)
1410 {
1411         return skb->mac_header != ~0U;
1412 }
1413
1414 static inline void skb_reset_mac_header(struct sk_buff *skb)
1415 {
1416         skb->mac_header = skb->data - skb->head;
1417 }
1418
1419 static inline void skb_set_mac_header(struct sk_buff *skb, const int offset)
1420 {
1421         skb_reset_mac_header(skb);
1422         skb->mac_header += offset;
1423 }
1424
1425 #else /* NET_SKBUFF_DATA_USES_OFFSET */
1426
1427 static inline unsigned char *skb_transport_header(const struct sk_buff *skb)
1428 {
1429         return skb->transport_header;
1430 }
1431
1432 static inline void skb_reset_transport_header(struct sk_buff *skb)
1433 {
1434         skb->transport_header = skb->data;
1435 }
1436
1437 static inline void skb_set_transport_header(struct sk_buff *skb,
1438                                             const int offset)
1439 {
1440         skb->transport_header = skb->data + offset;
1441 }
1442
1443 static inline unsigned char *skb_network_header(const struct sk_buff *skb)
1444 {
1445         return skb->network_header;
1446 }
1447
1448 static inline void skb_reset_network_header(struct sk_buff *skb)
1449 {
1450         skb->network_header = skb->data;
1451 }
1452
1453 static inline void skb_set_network_header(struct sk_buff *skb, const int offset)
1454 {
1455         skb->network_header = skb->data + offset;
1456 }
1457
1458 static inline unsigned char *skb_mac_header(const struct sk_buff *skb)
1459 {
1460         return skb->mac_header;
1461 }
1462
1463 static inline int skb_mac_header_was_set(const struct sk_buff *skb)
1464 {
1465         return skb->mac_header != NULL;
1466 }
1467
1468 static inline void skb_reset_mac_header(struct sk_buff *skb)
1469 {
1470         skb->mac_header = skb->data;
1471 }
1472
1473 static inline void skb_set_mac_header(struct sk_buff *skb, const int offset)
1474 {
1475         skb->mac_header = skb->data + offset;
1476 }
1477 #endif /* NET_SKBUFF_DATA_USES_OFFSET */
1478
1479 static inline void skb_mac_header_rebuild(struct sk_buff *skb)
1480 {
1481         if (skb_mac_header_was_set(skb)) {
1482                 const unsigned char *old_mac = skb_mac_header(skb);
1483
1484                 skb_set_mac_header(skb, -skb->mac_len);
1485                 memmove(skb_mac_header(skb), old_mac, skb->mac_len);
1486         }
1487 }
1488
1489 static inline int skb_checksum_start_offset(const struct sk_buff *skb)
1490 {
1491         return skb->csum_start - skb_headroom(skb);
1492 }
1493
1494 static inline int skb_transport_offset(const struct sk_buff *skb)
1495 {
1496         return skb_transport_header(skb) - skb->data;
1497 }
1498
1499 static inline u32 skb_network_header_len(const struct sk_buff *skb)
1500 {
1501         return skb->transport_header - skb->network_header;
1502 }
1503
1504 static inline int skb_network_offset(const struct sk_buff *skb)
1505 {
1506         return skb_network_header(skb) - skb->data;
1507 }
1508
1509 static inline int pskb_network_may_pull(struct sk_buff *skb, unsigned int len)
1510 {
1511         return pskb_may_pull(skb, skb_network_offset(skb) + len);
1512 }
1513
1514 /*
1515  * CPUs often take a performance hit when accessing unaligned memory
1516  * locations. The actual performance hit varies, it can be small if the
1517  * hardware handles it or large if we have to take an exception and fix it
1518  * in software.
1519  *
1520  * Since an ethernet header is 14 bytes network drivers often end up with
1521  * the IP header at an unaligned offset. The IP header can be aligned by
1522  * shifting the start of the packet by 2 bytes. Drivers should do this
1523  * with:
1524  *
1525  * skb_reserve(skb, NET_IP_ALIGN);
1526  *
1527  * The downside to this alignment of the IP header is that the DMA is now
1528  * unaligned. On some architectures the cost of an unaligned DMA is high
1529  * and this cost outweighs the gains made by aligning the IP header.
1530  *
1531  * Since this trade off varies between architectures, we allow NET_IP_ALIGN
1532  * to be overridden.
1533  */
1534 #ifndef NET_IP_ALIGN
1535 #define NET_IP_ALIGN    2
1536 #endif
1537
1538 /*
1539  * The networking layer reserves some headroom in skb data (via
1540  * dev_alloc_skb). This is used to avoid having to reallocate skb data when
1541  * the header has to grow. In the default case, if the header has to grow
1542  * 32 bytes or less we avoid the reallocation.
1543  *
1544  * Unfortunately this headroom changes the DMA alignment of the resulting
1545  * network packet. As for NET_IP_ALIGN, this unaligned DMA is expensive
1546  * on some architectures. An architecture can override this value,
1547  * perhaps setting it to a cacheline in size (since that will maintain
1548  * cacheline alignment of the DMA). It must be a power of 2.
1549  *
1550  * Various parts of the networking layer expect at least 32 bytes of
1551  * headroom, you should not reduce this.
1552  *
1553  * Using max(32, L1_CACHE_BYTES) makes sense (especially with RPS)
1554  * to reduce average number of cache lines per packet.
1555  * get_rps_cpus() for example only access one 64 bytes aligned block :
1556  * NET_IP_ALIGN(2) + ethernet_header(14) + IP_header(20/40) + ports(8)
1557  */
1558 #ifndef NET_SKB_PAD
1559 #define NET_SKB_PAD     max(32, L1_CACHE_BYTES)
1560 #endif
1561
1562 extern int ___pskb_trim(struct sk_buff *skb, unsigned int len);
1563
1564 static inline void __skb_trim(struct sk_buff *skb, unsigned int len)
1565 {
1566         if (unlikely(skb_is_nonlinear(skb))) {
1567                 WARN_ON(1);
1568                 return;
1569         }
1570         skb->len = len;
1571         skb_set_tail_pointer(skb, len);
1572 }
1573
1574 extern void skb_trim(struct sk_buff *skb, unsigned int len);
1575
1576 static inline int __pskb_trim(struct sk_buff *skb, unsigned int len)
1577 {
1578         if (skb->data_len)
1579                 return ___pskb_trim(skb, len);
1580         __skb_trim(skb, len);
1581         return 0;
1582 }
1583
1584 static inline int pskb_trim(struct sk_buff *skb, unsigned int len)
1585 {
1586         return (len < skb->len) ? __pskb_trim(skb, len) : 0;
1587 }
1588
1589 /**
1590  *      pskb_trim_unique - remove end from a paged unique (not cloned) buffer
1591  *      @skb: buffer to alter
1592  *      @len: new length
1593  *
1594  *      This is identical to pskb_trim except that the caller knows that
1595  *      the skb is not cloned so we should never get an error due to out-
1596  *      of-memory.
1597  */
1598 static inline void pskb_trim_unique(struct sk_buff *skb, unsigned int len)
1599 {
1600         int err = pskb_trim(skb, len);
1601         BUG_ON(err);
1602 }
1603
1604 /**
1605  *      skb_orphan - orphan a buffer
1606  *      @skb: buffer to orphan
1607  *
1608  *      If a buffer currently has an owner then we call the owner's
1609  *      destructor function and make the @skb unowned. The buffer continues
1610  *      to exist but is no longer charged to its former owner.
1611  */
1612 static inline void skb_orphan(struct sk_buff *skb)
1613 {
1614         if (skb->destructor)
1615                 skb->destructor(skb);
1616         skb->destructor = NULL;
1617         skb->sk         = NULL;
1618 }
1619
1620 /**
1621  *      __skb_queue_purge - empty a list
1622  *      @list: list to empty
1623  *
1624  *      Delete all buffers on an &sk_buff list. Each buffer is removed from
1625  *      the list and one reference dropped. This function does not take the
1626  *      list lock and the caller must hold the relevant locks to use it.
1627  */
1628 extern void skb_queue_purge(struct sk_buff_head *list);
1629 static inline void __skb_queue_purge(struct sk_buff_head *list)
1630 {
1631         struct sk_buff *skb;
1632         while ((skb = __skb_dequeue(list)) != NULL)
1633                 kfree_skb(skb);
1634 }
1635
1636 /**
1637  *      __dev_alloc_skb - allocate an skbuff for receiving
1638  *      @length: length to allocate
1639  *      @gfp_mask: get_free_pages mask, passed to alloc_skb
1640  *
1641  *      Allocate a new &sk_buff and assign it a usage count of one. The
1642  *      buffer has unspecified headroom built in. Users should allocate
1643  *      the headroom they think they need without accounting for the
1644  *      built in space. The built in space is used for optimisations.
1645  *
1646  *      %NULL is returned if there is no free memory.
1647  */
1648 static inline struct sk_buff *__dev_alloc_skb(unsigned int length,
1649                                               gfp_t gfp_mask)
1650 {
1651         struct sk_buff *skb = alloc_skb(length + NET_SKB_PAD, gfp_mask);
1652         if (likely(skb))
1653                 skb_reserve(skb, NET_SKB_PAD);
1654         return skb;
1655 }
1656
1657 extern struct sk_buff *dev_alloc_skb(unsigned int length);
1658
1659 extern struct sk_buff *__netdev_alloc_skb(struct net_device *dev,
1660                 unsigned int length, gfp_t gfp_mask);
1661
1662 /**
1663  *      netdev_alloc_skb - allocate an skbuff for rx on a specific device
1664  *      @dev: network device to receive on
1665  *      @length: length to allocate
1666  *
1667  *      Allocate a new &sk_buff and assign it a usage count of one. The
1668  *      buffer has unspecified headroom built in. Users should allocate
1669  *      the headroom they think they need without accounting for the
1670  *      built in space. The built in space is used for optimisations.
1671  *
1672  *      %NULL is returned if there is no free memory. Although this function
1673  *      allocates memory it can be called from an interrupt.
1674  */
1675 static inline struct sk_buff *netdev_alloc_skb(struct net_device *dev,
1676                 unsigned int length)
1677 {
1678         return __netdev_alloc_skb(dev, length, GFP_ATOMIC);
1679 }
1680
1681 static inline struct sk_buff *__netdev_alloc_skb_ip_align(struct net_device *dev,
1682                 unsigned int length, gfp_t gfp)
1683 {
1684         struct sk_buff *skb = __netdev_alloc_skb(dev, length + NET_IP_ALIGN, gfp);
1685
1686         if (NET_IP_ALIGN && skb)
1687                 skb_reserve(skb, NET_IP_ALIGN);
1688         return skb;
1689 }
1690
1691 static inline struct sk_buff *netdev_alloc_skb_ip_align(struct net_device *dev,
1692                 unsigned int length)
1693 {
1694         return __netdev_alloc_skb_ip_align(dev, length, GFP_ATOMIC);
1695 }
1696
1697 /**
1698  *      __netdev_alloc_page - allocate a page for ps-rx on a specific device
1699  *      @dev: network device to receive on
1700  *      @gfp_mask: alloc_pages_node mask
1701  *
1702  *      Allocate a new page. dev currently unused.
1703  *
1704  *      %NULL is returned if there is no free memory.
1705  */
1706 static inline struct page *__netdev_alloc_page(struct net_device *dev, gfp_t gfp_mask)
1707 {
1708         return alloc_pages_node(NUMA_NO_NODE, gfp_mask, 0);
1709 }
1710
1711 /**
1712  *      netdev_alloc_page - allocate a page for ps-rx on a specific device
1713  *      @dev: network device to receive on
1714  *
1715  *      Allocate a new page. dev currently unused.
1716  *
1717  *      %NULL is returned if there is no free memory.
1718  */
1719 static inline struct page *netdev_alloc_page(struct net_device *dev)
1720 {
1721         return __netdev_alloc_page(dev, GFP_ATOMIC);
1722 }
1723
1724 static inline void netdev_free_page(struct net_device *dev, struct page *page)
1725 {
1726         __free_page(page);
1727 }
1728
1729 /**
1730  * skb_frag_page - retrieve the page refered to by a paged fragment
1731  * @frag: the paged fragment
1732  *
1733  * Returns the &struct page associated with @frag.
1734  */
1735 static inline struct page *skb_frag_page(const skb_frag_t *frag)
1736 {
1737         return frag->page.p;
1738 }
1739
1740 /**
1741  * __skb_frag_ref - take an addition reference on a paged fragment.
1742  * @frag: the paged fragment
1743  *
1744  * Takes an additional reference on the paged fragment @frag.
1745  */
1746 static inline void __skb_frag_ref(skb_frag_t *frag)
1747 {
1748         get_page(skb_frag_page(frag));
1749 }
1750
1751 /**
1752  * skb_frag_ref - take an addition reference on a paged fragment of an skb.
1753  * @skb: the buffer
1754  * @f: the fragment offset.
1755  *
1756  * Takes an additional reference on the @f'th paged fragment of @skb.
1757  */
1758 static inline void skb_frag_ref(struct sk_buff *skb, int f)
1759 {
1760         __skb_frag_ref(&skb_shinfo(skb)->frags[f]);
1761 }
1762
1763 /**
1764  * __skb_frag_unref - release a reference on a paged fragment.
1765  * @frag: the paged fragment
1766  *
1767  * Releases a reference on the paged fragment @frag.
1768  */
1769 static inline void __skb_frag_unref(skb_frag_t *frag)
1770 {
1771         put_page(skb_frag_page(frag));
1772 }
1773
1774 /**
1775  * skb_frag_unref - release a reference on a paged fragment of an skb.
1776  * @skb: the buffer
1777  * @f: the fragment offset
1778  *
1779  * Releases a reference on the @f'th paged fragment of @skb.
1780  */
1781 static inline void skb_frag_unref(struct sk_buff *skb, int f)
1782 {
1783         __skb_frag_unref(&skb_shinfo(skb)->frags[f]);
1784 }
1785
1786 /**
1787  * skb_frag_address - gets the address of the data contained in a paged fragment
1788  * @frag: the paged fragment buffer
1789  *
1790  * Returns the address of the data within @frag. The page must already
1791  * be mapped.
1792  */
1793 static inline void *skb_frag_address(const skb_frag_t *frag)
1794 {
1795         return page_address(skb_frag_page(frag)) + frag->page_offset;
1796 }
1797
1798 /**
1799  * skb_frag_address_safe - gets the address of the data contained in a paged fragment
1800  * @frag: the paged fragment buffer
1801  *
1802  * Returns the address of the data within @frag. Checks that the page
1803  * is mapped and returns %NULL otherwise.
1804  */
1805 static inline void *skb_frag_address_safe(const skb_frag_t *frag)
1806 {
1807         void *ptr = page_address(skb_frag_page(frag));
1808         if (unlikely(!ptr))
1809                 return NULL;
1810
1811         return ptr + frag->page_offset;
1812 }
1813
1814 /**
1815  * __skb_frag_set_page - sets the page contained in a paged fragment
1816  * @frag: the paged fragment
1817  * @page: the page to set
1818  *
1819  * Sets the fragment @frag to contain @page.
1820  */
1821 static inline void __skb_frag_set_page(skb_frag_t *frag, struct page *page)
1822 {
1823         frag->page.p = page;
1824 }
1825
1826 /**
1827  * skb_frag_set_page - sets the page contained in a paged fragment of an skb
1828  * @skb: the buffer
1829  * @f: the fragment offset
1830  * @page: the page to set
1831  *
1832  * Sets the @f'th fragment of @skb to contain @page.
1833  */
1834 static inline void skb_frag_set_page(struct sk_buff *skb, int f,
1835                                      struct page *page)
1836 {
1837         __skb_frag_set_page(&skb_shinfo(skb)->frags[f], page);
1838 }
1839
1840 /**
1841  * skb_frag_dma_map - maps a paged fragment via the DMA API
1842  * @dev: the device to map the fragment to
1843  * @frag: the paged fragment to map
1844  * @offset: the offset within the fragment (starting at the
1845  *          fragment's own offset)
1846  * @size: the number of bytes to map
1847  * @dir: the direction of the mapping (%PCI_DMA_*)
1848  *
1849  * Maps the page associated with @frag to @device.
1850  */
1851 static inline dma_addr_t skb_frag_dma_map(struct device *dev,
1852                                           const skb_frag_t *frag,
1853                                           size_t offset, size_t size,
1854                                           enum dma_data_direction dir)
1855 {
1856         return dma_map_page(dev, skb_frag_page(frag),
1857                             frag->page_offset + offset, size, dir);
1858 }
1859
1860 /**
1861  *      skb_clone_writable - is the header of a clone writable
1862  *      @skb: buffer to check
1863  *      @len: length up to which to write
1864  *
1865  *      Returns true if modifying the header part of the cloned buffer
1866  *      does not requires the data to be copied.
1867  */
1868 static inline int skb_clone_writable(const struct sk_buff *skb, unsigned int len)
1869 {
1870         return !skb_header_cloned(skb) &&
1871                skb_headroom(skb) + len <= skb->hdr_len;
1872 }
1873
1874 static inline int __skb_cow(struct sk_buff *skb, unsigned int headroom,
1875                             int cloned)
1876 {
1877         int delta = 0;
1878
1879         if (headroom > skb_headroom(skb))
1880                 delta = headroom - skb_headroom(skb);
1881
1882         if (delta || cloned)
1883                 return pskb_expand_head(skb, ALIGN(delta, NET_SKB_PAD), 0,
1884                                         GFP_ATOMIC);
1885         return 0;
1886 }
1887
1888 /**
1889  *      skb_cow - copy header of skb when it is required
1890  *      @skb: buffer to cow
1891  *      @headroom: needed headroom
1892  *
1893  *      If the skb passed lacks sufficient headroom or its data part
1894  *      is shared, data is reallocated. If reallocation fails, an error
1895  *      is returned and original skb is not changed.
1896  *
1897  *      The result is skb with writable area skb->head...skb->tail
1898  *      and at least @headroom of space at head.
1899  */
1900 static inline int skb_cow(struct sk_buff *skb, unsigned int headroom)
1901 {
1902         return __skb_cow(skb, headroom, skb_cloned(skb));
1903 }
1904
1905 /**
1906  *      skb_cow_head - skb_cow but only making the head writable
1907  *      @skb: buffer to cow
1908  *      @headroom: needed headroom
1909  *
1910  *      This function is identical to skb_cow except that we replace the
1911  *      skb_cloned check by skb_header_cloned.  It should be used when
1912  *      you only need to push on some header and do not need to modify
1913  *      the data.
1914  */
1915 static inline int skb_cow_head(struct sk_buff *skb, unsigned int headroom)
1916 {
1917         return __skb_cow(skb, headroom, skb_header_cloned(skb));
1918 }
1919
1920 /**
1921  *      skb_padto       - pad an skbuff up to a minimal size
1922  *      @skb: buffer to pad
1923  *      @len: minimal length
1924  *
1925  *      Pads up a buffer to ensure the trailing bytes exist and are
1926  *      blanked. If the buffer already contains sufficient data it
1927  *      is untouched. Otherwise it is extended. Returns zero on
1928  *      success. The skb is freed on error.
1929  */
1930  
1931 static inline int skb_padto(struct sk_buff *skb, unsigned int len)
1932 {
1933         unsigned int size = skb->len;
1934         if (likely(size >= len))
1935                 return 0;
1936         return skb_pad(skb, len - size);
1937 }
1938
1939 static inline int skb_add_data(struct sk_buff *skb,
1940                                char __user *from, int copy)
1941 {
1942         const int off = skb->len;
1943
1944         if (skb->ip_summed == CHECKSUM_NONE) {
1945                 int err = 0;
1946                 __wsum csum = csum_and_copy_from_user(from, skb_put(skb, copy),
1947                                                             copy, 0, &err);
1948                 if (!err) {
1949                         skb->csum = csum_block_add(skb->csum, csum, off);
1950                         return 0;
1951                 }
1952         } else if (!copy_from_user(skb_put(skb, copy), from, copy))
1953                 return 0;
1954
1955         __skb_trim(skb, off);
1956         return -EFAULT;
1957 }
1958
1959 static inline int skb_can_coalesce(struct sk_buff *skb, int i,
1960                                    const struct page *page, int off)
1961 {
1962         if (i) {
1963                 const struct skb_frag_struct *frag = &skb_shinfo(skb)->frags[i - 1];
1964
1965                 return page == skb_frag_page(frag) &&
1966                        off == frag->page_offset + skb_frag_size(frag);
1967         }
1968         return 0;
1969 }
1970
1971 static inline int __skb_linearize(struct sk_buff *skb)
1972 {
1973         return __pskb_pull_tail(skb, skb->data_len) ? 0 : -ENOMEM;
1974 }
1975
1976 /**
1977  *      skb_linearize - convert paged skb to linear one
1978  *      @skb: buffer to linarize
1979  *
1980  *      If there is no free memory -ENOMEM is returned, otherwise zero
1981  *      is returned and the old skb data released.
1982  */
1983 static inline int skb_linearize(struct sk_buff *skb)
1984 {
1985         return skb_is_nonlinear(skb) ? __skb_linearize(skb) : 0;
1986 }
1987
1988 /**
1989  *      skb_linearize_cow - make sure skb is linear and writable
1990  *      @skb: buffer to process
1991  *
1992  *      If there is no free memory -ENOMEM is returned, otherwise zero
1993  *      is returned and the old skb data released.
1994  */
1995 static inline int skb_linearize_cow(struct sk_buff *skb)
1996 {
1997         return skb_is_nonlinear(skb) || skb_cloned(skb) ?
1998                __skb_linearize(skb) : 0;
1999 }
2000
2001 /**
2002  *      skb_postpull_rcsum - update checksum for received skb after pull
2003  *      @skb: buffer to update
2004  *      @start: start of data before pull
2005  *      @len: length of data pulled
2006  *
2007  *      After doing a pull on a received packet, you need to call this to
2008  *      update the CHECKSUM_COMPLETE checksum, or set ip_summed to
2009  *      CHECKSUM_NONE so that it can be recomputed from scratch.
2010  */
2011
2012 static inline void skb_postpull_rcsum(struct sk_buff *skb,
2013                                       const void *start, unsigned int len)
2014 {
2015         if (skb->ip_summed == CHECKSUM_COMPLETE)
2016                 skb->csum = csum_sub(skb->csum, csum_partial(start, len, 0));
2017 }
2018
2019 unsigned char *skb_pull_rcsum(struct sk_buff *skb, unsigned int len);
2020
2021 /**
2022  *      pskb_trim_rcsum - trim received skb and update checksum
2023  *      @skb: buffer to trim
2024  *      @len: new length
2025  *
2026  *      This is exactly the same as pskb_trim except that it ensures the
2027  *      checksum of received packets are still valid after the operation.
2028  */
2029
2030 static inline int pskb_trim_rcsum(struct sk_buff *skb, unsigned int len)
2031 {
2032         if (likely(len >= skb->len))
2033                 return 0;
2034         if (skb->ip_summed == CHECKSUM_COMPLETE)
2035                 skb->ip_summed = CHECKSUM_NONE;
2036         return __pskb_trim(skb, len);
2037 }
2038
2039 #define skb_queue_walk(queue, skb) \
2040                 for (skb = (queue)->next;                                       \
2041                      skb != (struct sk_buff *)(queue);                          \
2042                      skb = skb->next)
2043
2044 #define skb_queue_walk_safe(queue, skb, tmp)                                    \
2045                 for (skb = (queue)->next, tmp = skb->next;                      \
2046                      skb != (struct sk_buff *)(queue);                          \
2047                      skb = tmp, tmp = skb->next)
2048
2049 #define skb_queue_walk_from(queue, skb)                                         \
2050                 for (; skb != (struct sk_buff *)(queue);                        \
2051                      skb = skb->next)
2052
2053 #define skb_queue_walk_from_safe(queue, skb, tmp)                               \
2054                 for (tmp = skb->next;                                           \
2055                      skb != (struct sk_buff *)(queue);                          \
2056                      skb = tmp, tmp = skb->next)
2057
2058 #define skb_queue_reverse_walk(queue, skb) \
2059                 for (skb = (queue)->prev;                                       \
2060                      skb != (struct sk_buff *)(queue);                          \
2061                      skb = skb->prev)
2062
2063 #define skb_queue_reverse_walk_safe(queue, skb, tmp)                            \
2064                 for (skb = (queue)->prev, tmp = skb->prev;                      \
2065                      skb != (struct sk_buff *)(queue);                          \
2066                      skb = tmp, tmp = skb->prev)
2067
2068 #define skb_queue_reverse_walk_from_safe(queue, skb, tmp)                       \
2069                 for (tmp = skb->prev;                                           \
2070                      skb != (struct sk_buff *)(queue);                          \
2071                      skb = tmp, tmp = skb->prev)
2072
2073 static inline bool skb_has_frag_list(const struct sk_buff *skb)
2074 {
2075         return skb_shinfo(skb)->frag_list != NULL;
2076 }
2077
2078 static inline void skb_frag_list_init(struct sk_buff *skb)
2079 {
2080         skb_shinfo(skb)->frag_list = NULL;
2081 }
2082
2083 static inline void skb_frag_add_head(struct sk_buff *skb, struct sk_buff *frag)
2084 {
2085         frag->next = skb_shinfo(skb)->frag_list;
2086         skb_shinfo(skb)->frag_list = frag;
2087 }
2088
2089 #define skb_walk_frags(skb, iter)       \
2090         for (iter = skb_shinfo(skb)->frag_list; iter; iter = iter->next)
2091
2092 extern struct sk_buff *__skb_recv_datagram(struct sock *sk, unsigned flags,
2093                                            int *peeked, int *err);
2094 extern struct sk_buff *skb_recv_datagram(struct sock *sk, unsigned flags,
2095                                          int noblock, int *err);
2096 extern unsigned int    datagram_poll(struct file *file, struct socket *sock,
2097                                      struct poll_table_struct *wait);
2098 extern int             skb_copy_datagram_iovec(const struct sk_buff *from,
2099                                                int offset, struct iovec *to,
2100                                                int size);
2101 extern int             skb_copy_and_csum_datagram_iovec(struct sk_buff *skb,
2102                                                         int hlen,
2103                                                         struct iovec *iov);
2104 extern int             skb_copy_datagram_from_iovec(struct sk_buff *skb,
2105                                                     int offset,
2106                                                     const struct iovec *from,
2107                                                     int from_offset,
2108                                                     int len);
2109 extern int             skb_copy_datagram_const_iovec(const struct sk_buff *from,
2110                                                      int offset,
2111                                                      const struct iovec *to,
2112                                                      int to_offset,
2113                                                      int size);
2114 extern void            skb_free_datagram(struct sock *sk, struct sk_buff *skb);
2115 extern void            skb_free_datagram_locked(struct sock *sk,
2116                                                 struct sk_buff *skb);
2117 extern int             skb_kill_datagram(struct sock *sk, struct sk_buff *skb,
2118                                          unsigned int flags);
2119 extern __wsum          skb_checksum(const struct sk_buff *skb, int offset,
2120                                     int len, __wsum csum);
2121 extern int             skb_copy_bits(const struct sk_buff *skb, int offset,
2122                                      void *to, int len);
2123 extern int             skb_store_bits(struct sk_buff *skb, int offset,
2124                                       const void *from, int len);
2125 extern __wsum          skb_copy_and_csum_bits(const struct sk_buff *skb,
2126                                               int offset, u8 *to, int len,
2127                                               __wsum csum);
2128 extern int             skb_splice_bits(struct sk_buff *skb,
2129                                                 unsigned int offset,
2130                                                 struct pipe_inode_info *pipe,
2131                                                 unsigned int len,
2132                                                 unsigned int flags);
2133 extern void            skb_copy_and_csum_dev(const struct sk_buff *skb, u8 *to);
2134 extern void            skb_split(struct sk_buff *skb,
2135                                  struct sk_buff *skb1, const u32 len);
2136 extern int             skb_shift(struct sk_buff *tgt, struct sk_buff *skb,
2137                                  int shiftlen);
2138
2139 extern struct sk_buff *skb_segment(struct sk_buff *skb, u32 features);
2140
2141 static inline void *skb_header_pointer(const struct sk_buff *skb, int offset,
2142                                        int len, void *buffer)
2143 {
2144         int hlen = skb_headlen(skb);
2145
2146         if (hlen - offset >= len)
2147                 return skb->data + offset;
2148
2149         if (skb_copy_bits(skb, offset, buffer, len) < 0)
2150                 return NULL;
2151
2152         return buffer;
2153 }
2154
2155 static inline void skb_copy_from_linear_data(const struct sk_buff *skb,
2156                                              void *to,
2157                                              const unsigned int len)
2158 {
2159         memcpy(to, skb->data, len);
2160 }
2161
2162 static inline void skb_copy_from_linear_data_offset(const struct sk_buff *skb,
2163                                                     const int offset, void *to,
2164                                                     const unsigned int len)
2165 {
2166         memcpy(to, skb->data + offset, len);
2167 }
2168
2169 static inline void skb_copy_to_linear_data(struct sk_buff *skb,
2170                                            const void *from,
2171                                            const unsigned int len)
2172 {
2173         memcpy(skb->data, from, len);
2174 }
2175
2176 static inline void skb_copy_to_linear_data_offset(struct sk_buff *skb,
2177                                                   const int offset,
2178                                                   const void *from,
2179                                                   const unsigned int len)
2180 {
2181         memcpy(skb->data + offset, from, len);
2182 }
2183
2184 extern void skb_init(void);
2185
2186 static inline ktime_t skb_get_ktime(const struct sk_buff *skb)
2187 {
2188         return skb->tstamp;
2189 }
2190
2191 /**
2192  *      skb_get_timestamp - get timestamp from a skb
2193  *      @skb: skb to get stamp from
2194  *      @stamp: pointer to struct timeval to store stamp in
2195  *
2196  *      Timestamps are stored in the skb as offsets to a base timestamp.
2197  *      This function converts the offset back to a struct timeval and stores
2198  *      it in stamp.
2199  */
2200 static inline void skb_get_timestamp(const struct sk_buff *skb,
2201                                      struct timeval *stamp)
2202 {
2203         *stamp = ktime_to_timeval(skb->tstamp);
2204 }
2205
2206 static inline void skb_get_timestampns(const struct sk_buff *skb,
2207                                        struct timespec *stamp)
2208 {
2209         *stamp = ktime_to_timespec(skb->tstamp);
2210 }
2211
2212 static inline void __net_timestamp(struct sk_buff *skb)
2213 {
2214         skb->tstamp = ktime_get_real();
2215 }
2216
2217 static inline ktime_t net_timedelta(ktime_t t)
2218 {
2219         return ktime_sub(ktime_get_real(), t);
2220 }
2221
2222 static inline ktime_t net_invalid_timestamp(void)
2223 {
2224         return ktime_set(0, 0);
2225 }
2226
2227 extern void skb_timestamping_init(void);
2228
2229 #ifdef CONFIG_NETWORK_PHY_TIMESTAMPING
2230
2231 extern void skb_clone_tx_timestamp(struct sk_buff *skb);
2232 extern bool skb_defer_rx_timestamp(struct sk_buff *skb);
2233
2234 #else /* CONFIG_NETWORK_PHY_TIMESTAMPING */
2235
2236 static inline void skb_clone_tx_timestamp(struct sk_buff *skb)
2237 {
2238 }
2239
2240 static inline bool skb_defer_rx_timestamp(struct sk_buff *skb)
2241 {
2242         return false;
2243 }
2244
2245 #endif /* !CONFIG_NETWORK_PHY_TIMESTAMPING */
2246
2247 /**
2248  * skb_complete_tx_timestamp() - deliver cloned skb with tx timestamps
2249  *
2250  * PHY drivers may accept clones of transmitted packets for
2251  * timestamping via their phy_driver.txtstamp method. These drivers
2252  * must call this function to return the skb back to the stack, with
2253  * or without a timestamp.
2254  *
2255  * @skb: clone of the the original outgoing packet
2256  * @hwtstamps: hardware time stamps, may be NULL if not available
2257  *
2258  */
2259 void skb_complete_tx_timestamp(struct sk_buff *skb,
2260                                struct skb_shared_hwtstamps *hwtstamps);
2261
2262 /**
2263  * skb_tstamp_tx - queue clone of skb with send time stamps
2264  * @orig_skb:   the original outgoing packet
2265  * @hwtstamps:  hardware time stamps, may be NULL if not available
2266  *
2267  * If the skb has a socket associated, then this function clones the
2268  * skb (thus sharing the actual data and optional structures), stores
2269  * the optional hardware time stamping information (if non NULL) or
2270  * generates a software time stamp (otherwise), then queues the clone
2271  * to the error queue of the socket.  Errors are silently ignored.
2272  */
2273 extern void skb_tstamp_tx(struct sk_buff *orig_skb,
2274                         struct skb_shared_hwtstamps *hwtstamps);
2275
2276 static inline void sw_tx_timestamp(struct sk_buff *skb)
2277 {
2278         if (skb_shinfo(skb)->tx_flags & SKBTX_SW_TSTAMP &&
2279             !(skb_shinfo(skb)->tx_flags & SKBTX_IN_PROGRESS))
2280                 skb_tstamp_tx(skb, NULL);
2281 }
2282
2283 /**
2284  * skb_tx_timestamp() - Driver hook for transmit timestamping
2285  *
2286  * Ethernet MAC Drivers should call this function in their hard_xmit()
2287  * function immediately before giving the sk_buff to the MAC hardware.
2288  *
2289  * @skb: A socket buffer.
2290  */
2291 static inline void skb_tx_timestamp(struct sk_buff *skb)
2292 {
2293         skb_clone_tx_timestamp(skb);
2294         sw_tx_timestamp(skb);
2295 }
2296
2297 extern __sum16 __skb_checksum_complete_head(struct sk_buff *skb, int len);
2298 extern __sum16 __skb_checksum_complete(struct sk_buff *skb);
2299
2300 static inline int skb_csum_unnecessary(const struct sk_buff *skb)
2301 {
2302         return skb->ip_summed & CHECKSUM_UNNECESSARY;
2303 }
2304
2305 /**
2306  *      skb_checksum_complete - Calculate checksum of an entire packet
2307  *      @skb: packet to process
2308  *
2309  *      This function calculates the checksum over the entire packet plus
2310  *      the value of skb->csum.  The latter can be used to supply the
2311  *      checksum of a pseudo header as used by TCP/UDP.  It returns the
2312  *      checksum.
2313  *
2314  *      For protocols that contain complete checksums such as ICMP/TCP/UDP,
2315  *      this function can be used to verify that checksum on received
2316  *      packets.  In that case the function should return zero if the
2317  *      checksum is correct.  In particular, this function will return zero
2318  *      if skb->ip_summed is CHECKSUM_UNNECESSARY which indicates that the
2319  *      hardware has already verified the correctness of the checksum.
2320  */
2321 static inline __sum16 skb_checksum_complete(struct sk_buff *skb)
2322 {
2323         return skb_csum_unnecessary(skb) ?
2324                0 : __skb_checksum_complete(skb);
2325 }
2326
2327 #if defined(CONFIG_NF_CONNTRACK) || defined(CONFIG_NF_CONNTRACK_MODULE)
2328 extern void nf_conntrack_destroy(struct nf_conntrack *nfct);
2329 static inline void nf_conntrack_put(struct nf_conntrack *nfct)
2330 {
2331         if (nfct && atomic_dec_and_test(&nfct->use))
2332                 nf_conntrack_destroy(nfct);
2333 }
2334 static inline void nf_conntrack_get(struct nf_conntrack *nfct)
2335 {
2336         if (nfct)
2337                 atomic_inc(&nfct->use);
2338 }
2339 #endif
2340 #ifdef NET_SKBUFF_NF_DEFRAG_NEEDED
2341 static inline void nf_conntrack_get_reasm(struct sk_buff *skb)
2342 {
2343         if (skb)
2344                 atomic_inc(&skb->users);
2345 }
2346 static inline void nf_conntrack_put_reasm(struct sk_buff *skb)
2347 {
2348         if (skb)
2349                 kfree_skb(skb);
2350 }
2351 #endif
2352 #ifdef CONFIG_BRIDGE_NETFILTER
2353 static inline void nf_bridge_put(struct nf_bridge_info *nf_bridge)
2354 {
2355         if (nf_bridge && atomic_dec_and_test(&nf_bridge->use))
2356                 kfree(nf_bridge);
2357 }
2358 static inline void nf_bridge_get(struct nf_bridge_info *nf_bridge)
2359 {
2360         if (nf_bridge)
2361                 atomic_inc(&nf_bridge->use);
2362 }
2363 #endif /* CONFIG_BRIDGE_NETFILTER */
2364 static inline void nf_reset(struct sk_buff *skb)
2365 {
2366 #if defined(CONFIG_NF_CONNTRACK) || defined(CONFIG_NF_CONNTRACK_MODULE)
2367         nf_conntrack_put(skb->nfct);
2368         skb->nfct = NULL;
2369 #endif
2370 #ifdef NET_SKBUFF_NF_DEFRAG_NEEDED
2371         nf_conntrack_put_reasm(skb->nfct_reasm);
2372         skb->nfct_reasm = NULL;
2373 #endif
2374 #ifdef CONFIG_BRIDGE_NETFILTER
2375         nf_bridge_put(skb->nf_bridge);
2376         skb->nf_bridge = NULL;
2377 #endif
2378 }
2379
2380 static inline void nf_reset_trace(struct sk_buff *skb)
2381 {
2382 #if IS_ENABLED(CONFIG_NETFILTER_XT_TARGET_TRACE)
2383         skb->nf_trace = 0;
2384 #endif
2385 }
2386
2387 /* Note: This doesn't put any conntrack and bridge info in dst. */
2388 static inline void __nf_copy(struct sk_buff *dst, const struct sk_buff *src)
2389 {
2390 #if defined(CONFIG_NF_CONNTRACK) || defined(CONFIG_NF_CONNTRACK_MODULE)
2391         dst->nfct = src->nfct;
2392         nf_conntrack_get(src->nfct);
2393         dst->nfctinfo = src->nfctinfo;
2394 #endif
2395 #ifdef NET_SKBUFF_NF_DEFRAG_NEEDED
2396         dst->nfct_reasm = src->nfct_reasm;
2397         nf_conntrack_get_reasm(src->nfct_reasm);
2398 #endif
2399 #ifdef CONFIG_BRIDGE_NETFILTER
2400         dst->nf_bridge  = src->nf_bridge;
2401         nf_bridge_get(src->nf_bridge);
2402 #endif
2403 }
2404
2405 static inline void nf_copy(struct sk_buff *dst, const struct sk_buff *src)
2406 {
2407 #if defined(CONFIG_NF_CONNTRACK) || defined(CONFIG_NF_CONNTRACK_MODULE)
2408         nf_conntrack_put(dst->nfct);
2409 #endif
2410 #ifdef NET_SKBUFF_NF_DEFRAG_NEEDED
2411         nf_conntrack_put_reasm(dst->nfct_reasm);
2412 #endif
2413 #ifdef CONFIG_BRIDGE_NETFILTER
2414         nf_bridge_put(dst->nf_bridge);
2415 #endif
2416         __nf_copy(dst, src);
2417 }
2418
2419 #ifdef CONFIG_NETWORK_SECMARK
2420 static inline void skb_copy_secmark(struct sk_buff *to, const struct sk_buff *from)
2421 {
2422         to->secmark = from->secmark;
2423 }
2424
2425 static inline void skb_init_secmark(struct sk_buff *skb)
2426 {
2427         skb->secmark = 0;
2428 }
2429 #else
2430 static inline void skb_copy_secmark(struct sk_buff *to, const struct sk_buff *from)
2431 { }
2432
2433 static inline void skb_init_secmark(struct sk_buff *skb)
2434 { }
2435 #endif
2436
2437 static inline void skb_set_queue_mapping(struct sk_buff *skb, u16 queue_mapping)
2438 {
2439         skb->queue_mapping = queue_mapping;
2440 }
2441
2442 static inline u16 skb_get_queue_mapping(const struct sk_buff *skb)
2443 {
2444         return skb->queue_mapping;
2445 }
2446
2447 static inline void skb_copy_queue_mapping(struct sk_buff *to, const struct sk_buff *from)
2448 {
2449         to->queue_mapping = from->queue_mapping;
2450 }
2451
2452 static inline void skb_record_rx_queue(struct sk_buff *skb, u16 rx_queue)
2453 {
2454         skb->queue_mapping = rx_queue + 1;
2455 }
2456
2457 static inline u16 skb_get_rx_queue(const struct sk_buff *skb)
2458 {
2459         return skb->queue_mapping - 1;
2460 }
2461
2462 static inline bool skb_rx_queue_recorded(const struct sk_buff *skb)
2463 {
2464         return skb->queue_mapping != 0;
2465 }
2466
2467 extern u16 __skb_tx_hash(const struct net_device *dev,
2468                          const struct sk_buff *skb,
2469                          unsigned int num_tx_queues);
2470
2471 #ifdef CONFIG_XFRM
2472 static inline struct sec_path *skb_sec_path(struct sk_buff *skb)
2473 {
2474         return skb->sp;
2475 }
2476 #else
2477 static inline struct sec_path *skb_sec_path(struct sk_buff *skb)
2478 {
2479         return NULL;
2480 }
2481 #endif
2482
2483 static inline int skb_is_gso(const struct sk_buff *skb)
2484 {
2485         return skb_shinfo(skb)->gso_size;
2486 }
2487
2488 static inline int skb_is_gso_v6(const struct sk_buff *skb)
2489 {
2490         return skb_shinfo(skb)->gso_type & SKB_GSO_TCPV6;
2491 }
2492
2493 extern void __skb_warn_lro_forwarding(const struct sk_buff *skb);
2494
2495 static inline bool skb_warn_if_lro(const struct sk_buff *skb)
2496 {
2497         /* LRO sets gso_size but not gso_type, whereas if GSO is really
2498          * wanted then gso_type will be set. */
2499         const struct skb_shared_info *shinfo = skb_shinfo(skb);
2500
2501         if (skb_is_nonlinear(skb) && shinfo->gso_size != 0 &&
2502             unlikely(shinfo->gso_type == 0)) {
2503                 __skb_warn_lro_forwarding(skb);
2504                 return true;
2505         }
2506         return false;
2507 }
2508
2509 static inline void skb_forward_csum(struct sk_buff *skb)
2510 {
2511         /* Unfortunately we don't support this one.  Any brave souls? */
2512         if (skb->ip_summed == CHECKSUM_COMPLETE)
2513                 skb->ip_summed = CHECKSUM_NONE;
2514 }
2515
2516 /**
2517  * skb_checksum_none_assert - make sure skb ip_summed is CHECKSUM_NONE
2518  * @skb: skb to check
2519  *
2520  * fresh skbs have their ip_summed set to CHECKSUM_NONE.
2521  * Instead of forcing ip_summed to CHECKSUM_NONE, we can
2522  * use this helper, to document places where we make this assertion.
2523  */
2524 static inline void skb_checksum_none_assert(const struct sk_buff *skb)
2525 {
2526 #ifdef DEBUG
2527         BUG_ON(skb->ip_summed != CHECKSUM_NONE);
2528 #endif
2529 }
2530
2531 bool skb_partial_csum_set(struct sk_buff *skb, u16 start, u16 off);
2532
2533 static inline bool skb_is_recycleable(const struct sk_buff *skb, int skb_size)
2534 {
2535         if (irqs_disabled())
2536                 return false;
2537
2538         if (skb_shinfo(skb)->tx_flags & SKBTX_DEV_ZEROCOPY)
2539                 return false;
2540
2541         if (skb_is_nonlinear(skb) || skb->fclone != SKB_FCLONE_UNAVAILABLE)
2542                 return false;
2543
2544         skb_size = SKB_DATA_ALIGN(skb_size + NET_SKB_PAD);
2545         if (skb_end_pointer(skb) - skb->head < skb_size)
2546                 return false;
2547
2548         if (skb_shared(skb) || skb_cloned(skb))
2549                 return false;
2550
2551         return true;
2552 }
2553 #endif  /* __KERNEL__ */
2554 #endif  /* _LINUX_SKBUFF_H */