]> bbs.cooldavid.org Git - net-next-2.6.git/blob - include/linux/skbuff.h
[NET]: Reduce tc_index/tc_verd to u16
[net-next-2.6.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/config.h>
18 #include <linux/kernel.h>
19 #include <linux/compiler.h>
20 #include <linux/time.h>
21 #include <linux/cache.h>
22
23 #include <asm/atomic.h>
24 #include <asm/types.h>
25 #include <linux/spinlock.h>
26 #include <linux/mm.h>
27 #include <linux/highmem.h>
28 #include <linux/poll.h>
29 #include <linux/net.h>
30 #include <linux/textsearch.h>
31 #include <net/checksum.h>
32
33 #define HAVE_ALLOC_SKB          /* For the drivers to know */
34 #define HAVE_ALIGNABLE_SKB      /* Ditto 8)                */
35 #define SLAB_SKB                /* Slabified skbuffs       */
36
37 #define CHECKSUM_NONE 0
38 #define CHECKSUM_HW 1
39 #define CHECKSUM_UNNECESSARY 2
40
41 #define SKB_DATA_ALIGN(X)       (((X) + (SMP_CACHE_BYTES - 1)) & \
42                                  ~(SMP_CACHE_BYTES - 1))
43 #define SKB_MAX_ORDER(X, ORDER) (((PAGE_SIZE << (ORDER)) - (X) - \
44                                   sizeof(struct skb_shared_info)) & \
45                                   ~(SMP_CACHE_BYTES - 1))
46 #define SKB_MAX_HEAD(X)         (SKB_MAX_ORDER((X), 0))
47 #define SKB_MAX_ALLOC           (SKB_MAX_ORDER(0, 2))
48
49 /* A. Checksumming of received packets by device.
50  *
51  *      NONE: device failed to checksum this packet.
52  *              skb->csum is undefined.
53  *
54  *      UNNECESSARY: device parsed packet and wouldbe verified checksum.
55  *              skb->csum is undefined.
56  *            It is bad option, but, unfortunately, many of vendors do this.
57  *            Apparently with secret goal to sell you new device, when you
58  *            will add new protocol to your host. F.e. IPv6. 8)
59  *
60  *      HW: the most generic way. Device supplied checksum of _all_
61  *          the packet as seen by netif_rx in skb->csum.
62  *          NOTE: Even if device supports only some protocols, but
63  *          is able to produce some skb->csum, it MUST use HW,
64  *          not UNNECESSARY.
65  *
66  * B. Checksumming on output.
67  *
68  *      NONE: skb is checksummed by protocol or csum is not required.
69  *
70  *      HW: device is required to csum packet as seen by hard_start_xmit
71  *      from skb->h.raw to the end and to record the checksum
72  *      at skb->h.raw+skb->csum.
73  *
74  *      Device must show its capabilities in dev->features, set
75  *      at device setup time.
76  *      NETIF_F_HW_CSUM - it is clever device, it is able to checksum
77  *                        everything.
78  *      NETIF_F_NO_CSUM - loopback or reliable single hop media.
79  *      NETIF_F_IP_CSUM - device is dumb. It is able to csum only
80  *                        TCP/UDP over IPv4. Sigh. Vendors like this
81  *                        way by an unknown reason. Though, see comment above
82  *                        about CHECKSUM_UNNECESSARY. 8)
83  *
84  *      Any questions? No questions, good.              --ANK
85  */
86
87 struct net_device;
88
89 #ifdef CONFIG_NETFILTER
90 struct nf_conntrack {
91         atomic_t use;
92         void (*destroy)(struct nf_conntrack *);
93 };
94
95 #ifdef CONFIG_BRIDGE_NETFILTER
96 struct nf_bridge_info {
97         atomic_t use;
98         struct net_device *physindev;
99         struct net_device *physoutdev;
100 #if defined(CONFIG_VLAN_8021Q) || defined(CONFIG_VLAN_8021Q_MODULE)
101         struct net_device *netoutdev;
102 #endif
103         unsigned int mask;
104         unsigned long data[32 / sizeof(unsigned long)];
105 };
106 #endif
107
108 #endif
109
110 struct sk_buff_head {
111         /* These two members must be first. */
112         struct sk_buff  *next;
113         struct sk_buff  *prev;
114
115         __u32           qlen;
116         spinlock_t      lock;
117 };
118
119 struct sk_buff;
120
121 /* To allow 64K frame to be packed as single skb without frag_list */
122 #define MAX_SKB_FRAGS (65536/PAGE_SIZE + 2)
123
124 typedef struct skb_frag_struct skb_frag_t;
125
126 struct skb_frag_struct {
127         struct page *page;
128         __u16 page_offset;
129         __u16 size;
130 };
131
132 /* This data is invariant across clones and lives at
133  * the end of the header data, ie. at skb->end.
134  */
135 struct skb_shared_info {
136         atomic_t        dataref;
137         unsigned int    nr_frags;
138         unsigned short  tso_size;
139         unsigned short  tso_segs;
140         struct sk_buff  *frag_list;
141         skb_frag_t      frags[MAX_SKB_FRAGS];
142 };
143
144 /* We divide dataref into two halves.  The higher 16 bits hold references
145  * to the payload part of skb->data.  The lower 16 bits hold references to
146  * the entire skb->data.  It is up to the users of the skb to agree on
147  * where the payload starts.
148  *
149  * All users must obey the rule that the skb->data reference count must be
150  * greater than or equal to the payload reference count.
151  *
152  * Holding a reference to the payload part means that the user does not
153  * care about modifications to the header part of skb->data.
154  */
155 #define SKB_DATAREF_SHIFT 16
156 #define SKB_DATAREF_MASK ((1 << SKB_DATAREF_SHIFT) - 1)
157
158 /** 
159  *      struct sk_buff - socket buffer
160  *      @next: Next buffer in list
161  *      @prev: Previous buffer in list
162  *      @list: List we are on
163  *      @sk: Socket we are owned by
164  *      @stamp: Time we arrived
165  *      @dev: Device we arrived on/are leaving by
166  *      @input_dev: Device we arrived on
167  *      @real_dev: The real device we are using
168  *      @h: Transport layer header
169  *      @nh: Network layer header
170  *      @mac: Link layer header
171  *      @dst: destination entry
172  *      @sp: the security path, used for xfrm
173  *      @cb: Control buffer. Free for use by every layer. Put private vars here
174  *      @len: Length of actual data
175  *      @data_len: Data length
176  *      @mac_len: Length of link layer header
177  *      @csum: Checksum
178  *      @local_df: allow local fragmentation
179  *      @cloned: Head may be cloned (check refcnt to be sure)
180  *      @nohdr: Payload reference only, must not modify header
181  *      @pkt_type: Packet class
182  *      @ip_summed: Driver fed us an IP checksum
183  *      @priority: Packet queueing priority
184  *      @users: User count - see {datagram,tcp}.c
185  *      @protocol: Packet protocol from driver
186  *      @truesize: Buffer size 
187  *      @head: Head of buffer
188  *      @data: Data head pointer
189  *      @tail: Tail pointer
190  *      @end: End pointer
191  *      @destructor: Destruct function
192  *      @nfmark: Can be used for communication between hooks
193  *      @nfct: Associated connection, if any
194  *      @nfctinfo: Relationship of this skb to the connection
195  *      @nf_bridge: Saved data about a bridged frame - see br_netfilter.c
196  *      @tc_index: Traffic control index
197  *      @tc_verd: traffic control verdict
198  */
199
200 struct sk_buff {
201         /* These two members must be first. */
202         struct sk_buff          *next;
203         struct sk_buff          *prev;
204
205         struct sock             *sk;
206         struct timeval          stamp;
207         struct net_device       *dev;
208         struct net_device       *input_dev;
209         struct net_device       *real_dev;
210
211         union {
212                 struct tcphdr   *th;
213                 struct udphdr   *uh;
214                 struct icmphdr  *icmph;
215                 struct igmphdr  *igmph;
216                 struct iphdr    *ipiph;
217                 struct ipv6hdr  *ipv6h;
218                 unsigned char   *raw;
219         } h;
220
221         union {
222                 struct iphdr    *iph;
223                 struct ipv6hdr  *ipv6h;
224                 struct arphdr   *arph;
225                 unsigned char   *raw;
226         } nh;
227
228         union {
229                 unsigned char   *raw;
230         } mac;
231
232         struct  dst_entry       *dst;
233         struct  sec_path        *sp;
234
235         /*
236          * This is the control buffer. It is free to use for every
237          * layer. Please put your private variables there. If you
238          * want to keep them across layers you have to do a skb_clone()
239          * first. This is owned by whoever has the skb queued ATM.
240          */
241         char                    cb[40];
242
243         unsigned int            len,
244                                 data_len,
245                                 mac_len,
246                                 csum;
247         __u32                   priority;
248         __u8                    local_df:1,
249                                 cloned:1,
250                                 ip_summed:2,
251                                 nohdr:1,
252                                 nfctinfo:3;
253         __u8                    pkt_type;
254         __be16                  protocol;
255
256         void                    (*destructor)(struct sk_buff *skb);
257 #ifdef CONFIG_NETFILTER
258         __u32                   nfmark;
259         struct nf_conntrack     *nfct;
260 #if defined(CONFIG_IP_VS) || defined(CONFIG_IP_VS_MODULE)
261         __u8                    ipvs_property:1;
262 #endif
263 #ifdef CONFIG_BRIDGE_NETFILTER
264         struct nf_bridge_info   *nf_bridge;
265 #endif
266 #endif /* CONFIG_NETFILTER */
267 #ifdef CONFIG_NET_SCHED
268         __u16                   tc_index;       /* traffic control index */
269 #ifdef CONFIG_NET_CLS_ACT
270         __u16                   tc_verd;        /* traffic control verdict */
271 #endif
272 #endif
273
274
275         /* These elements must be at the end, see alloc_skb() for details.  */
276         unsigned int            truesize;
277         atomic_t                users;
278         unsigned char           *head,
279                                 *data,
280                                 *tail,
281                                 *end;
282 };
283
284 #ifdef __KERNEL__
285 /*
286  *      Handling routines are only of interest to the kernel
287  */
288 #include <linux/slab.h>
289
290 #include <asm/system.h>
291
292 extern void            __kfree_skb(struct sk_buff *skb);
293 extern struct sk_buff *alloc_skb(unsigned int size,
294                                  unsigned int __nocast priority);
295 extern struct sk_buff *alloc_skb_from_cache(kmem_cache_t *cp,
296                                             unsigned int size,
297                                             unsigned int __nocast priority);
298 extern void            kfree_skbmem(struct sk_buff *skb);
299 extern struct sk_buff *skb_clone(struct sk_buff *skb,
300                                  unsigned int __nocast priority);
301 extern struct sk_buff *skb_copy(const struct sk_buff *skb,
302                                 unsigned int __nocast priority);
303 extern struct sk_buff *pskb_copy(struct sk_buff *skb,
304                                  unsigned int __nocast gfp_mask);
305 extern int             pskb_expand_head(struct sk_buff *skb,
306                                         int nhead, int ntail,
307                                         unsigned int __nocast gfp_mask);
308 extern struct sk_buff *skb_realloc_headroom(struct sk_buff *skb,
309                                             unsigned int headroom);
310 extern struct sk_buff *skb_copy_expand(const struct sk_buff *skb,
311                                        int newheadroom, int newtailroom,
312                                        unsigned int __nocast priority);
313 extern struct sk_buff *         skb_pad(struct sk_buff *skb, int pad);
314 #define dev_kfree_skb(a)        kfree_skb(a)
315 extern void           skb_over_panic(struct sk_buff *skb, int len,
316                                      void *here);
317 extern void           skb_under_panic(struct sk_buff *skb, int len,
318                                       void *here);
319
320 struct skb_seq_state
321 {
322         __u32           lower_offset;
323         __u32           upper_offset;
324         __u32           frag_idx;
325         __u32           stepped_offset;
326         struct sk_buff  *root_skb;
327         struct sk_buff  *cur_skb;
328         __u8            *frag_data;
329 };
330
331 extern void           skb_prepare_seq_read(struct sk_buff *skb,
332                                            unsigned int from, unsigned int to,
333                                            struct skb_seq_state *st);
334 extern unsigned int   skb_seq_read(unsigned int consumed, const u8 **data,
335                                    struct skb_seq_state *st);
336 extern void           skb_abort_seq_read(struct skb_seq_state *st);
337
338 extern unsigned int   skb_find_text(struct sk_buff *skb, unsigned int from,
339                                     unsigned int to, struct ts_config *config,
340                                     struct ts_state *state);
341
342 /* Internal */
343 #define skb_shinfo(SKB)         ((struct skb_shared_info *)((SKB)->end))
344
345 /**
346  *      skb_queue_empty - check if a queue is empty
347  *      @list: queue head
348  *
349  *      Returns true if the queue is empty, false otherwise.
350  */
351 static inline int skb_queue_empty(const struct sk_buff_head *list)
352 {
353         return list->next == (struct sk_buff *)list;
354 }
355
356 /**
357  *      skb_get - reference buffer
358  *      @skb: buffer to reference
359  *
360  *      Makes another reference to a socket buffer and returns a pointer
361  *      to the buffer.
362  */
363 static inline struct sk_buff *skb_get(struct sk_buff *skb)
364 {
365         atomic_inc(&skb->users);
366         return skb;
367 }
368
369 /*
370  * If users == 1, we are the only owner and are can avoid redundant
371  * atomic change.
372  */
373
374 /**
375  *      kfree_skb - free an sk_buff
376  *      @skb: buffer to free
377  *
378  *      Drop a reference to the buffer and free it if the usage count has
379  *      hit zero.
380  */
381 static inline void kfree_skb(struct sk_buff *skb)
382 {
383         if (likely(atomic_read(&skb->users) == 1))
384                 smp_rmb();
385         else if (likely(!atomic_dec_and_test(&skb->users)))
386                 return;
387         __kfree_skb(skb);
388 }
389
390 /**
391  *      skb_cloned - is the buffer a clone
392  *      @skb: buffer to check
393  *
394  *      Returns true if the buffer was generated with skb_clone() and is
395  *      one of multiple shared copies of the buffer. Cloned buffers are
396  *      shared data so must not be written to under normal circumstances.
397  */
398 static inline int skb_cloned(const struct sk_buff *skb)
399 {
400         return skb->cloned &&
401                (atomic_read(&skb_shinfo(skb)->dataref) & SKB_DATAREF_MASK) != 1;
402 }
403
404 /**
405  *      skb_header_cloned - is the header a clone
406  *      @skb: buffer to check
407  *
408  *      Returns true if modifying the header part of the buffer requires
409  *      the data to be copied.
410  */
411 static inline int skb_header_cloned(const struct sk_buff *skb)
412 {
413         int dataref;
414
415         if (!skb->cloned)
416                 return 0;
417
418         dataref = atomic_read(&skb_shinfo(skb)->dataref);
419         dataref = (dataref & SKB_DATAREF_MASK) - (dataref >> SKB_DATAREF_SHIFT);
420         return dataref != 1;
421 }
422
423 /**
424  *      skb_header_release - release reference to header
425  *      @skb: buffer to operate on
426  *
427  *      Drop a reference to the header part of the buffer.  This is done
428  *      by acquiring a payload reference.  You must not read from the header
429  *      part of skb->data after this.
430  */
431 static inline void skb_header_release(struct sk_buff *skb)
432 {
433         BUG_ON(skb->nohdr);
434         skb->nohdr = 1;
435         atomic_add(1 << SKB_DATAREF_SHIFT, &skb_shinfo(skb)->dataref);
436 }
437
438 /**
439  *      skb_shared - is the buffer shared
440  *      @skb: buffer to check
441  *
442  *      Returns true if more than one person has a reference to this
443  *      buffer.
444  */
445 static inline int skb_shared(const struct sk_buff *skb)
446 {
447         return atomic_read(&skb->users) != 1;
448 }
449
450 /**
451  *      skb_share_check - check if buffer is shared and if so clone it
452  *      @skb: buffer to check
453  *      @pri: priority for memory allocation
454  *
455  *      If the buffer is shared the buffer is cloned and the old copy
456  *      drops a reference. A new clone with a single reference is returned.
457  *      If the buffer is not shared the original buffer is returned. When
458  *      being called from interrupt status or with spinlocks held pri must
459  *      be GFP_ATOMIC.
460  *
461  *      NULL is returned on a memory allocation failure.
462  */
463 static inline struct sk_buff *skb_share_check(struct sk_buff *skb,
464                                               unsigned int __nocast pri)
465 {
466         might_sleep_if(pri & __GFP_WAIT);
467         if (skb_shared(skb)) {
468                 struct sk_buff *nskb = skb_clone(skb, pri);
469                 kfree_skb(skb);
470                 skb = nskb;
471         }
472         return skb;
473 }
474
475 /*
476  *      Copy shared buffers into a new sk_buff. We effectively do COW on
477  *      packets to handle cases where we have a local reader and forward
478  *      and a couple of other messy ones. The normal one is tcpdumping
479  *      a packet thats being forwarded.
480  */
481
482 /**
483  *      skb_unshare - make a copy of a shared buffer
484  *      @skb: buffer to check
485  *      @pri: priority for memory allocation
486  *
487  *      If the socket buffer is a clone then this function creates a new
488  *      copy of the data, drops a reference count on the old copy and returns
489  *      the new copy with the reference count at 1. If the buffer is not a clone
490  *      the original buffer is returned. When called with a spinlock held or
491  *      from interrupt state @pri must be %GFP_ATOMIC
492  *
493  *      %NULL is returned on a memory allocation failure.
494  */
495 static inline struct sk_buff *skb_unshare(struct sk_buff *skb,
496                                           unsigned int __nocast pri)
497 {
498         might_sleep_if(pri & __GFP_WAIT);
499         if (skb_cloned(skb)) {
500                 struct sk_buff *nskb = skb_copy(skb, pri);
501                 kfree_skb(skb); /* Free our shared copy */
502                 skb = nskb;
503         }
504         return skb;
505 }
506
507 /**
508  *      skb_peek
509  *      @list_: list to peek at
510  *
511  *      Peek an &sk_buff. Unlike most other operations you _MUST_
512  *      be careful with this one. A peek leaves the buffer on the
513  *      list and someone else may run off with it. You must hold
514  *      the appropriate locks or have a private queue to do this.
515  *
516  *      Returns %NULL for an empty list or a pointer to the head element.
517  *      The reference count is not incremented and the reference is therefore
518  *      volatile. Use with caution.
519  */
520 static inline struct sk_buff *skb_peek(struct sk_buff_head *list_)
521 {
522         struct sk_buff *list = ((struct sk_buff *)list_)->next;
523         if (list == (struct sk_buff *)list_)
524                 list = NULL;
525         return list;
526 }
527
528 /**
529  *      skb_peek_tail
530  *      @list_: list to peek at
531  *
532  *      Peek an &sk_buff. Unlike most other operations you _MUST_
533  *      be careful with this one. A peek leaves the buffer on the
534  *      list and someone else may run off with it. You must hold
535  *      the appropriate locks or have a private queue to do this.
536  *
537  *      Returns %NULL for an empty list or a pointer to the tail element.
538  *      The reference count is not incremented and the reference is therefore
539  *      volatile. Use with caution.
540  */
541 static inline struct sk_buff *skb_peek_tail(struct sk_buff_head *list_)
542 {
543         struct sk_buff *list = ((struct sk_buff *)list_)->prev;
544         if (list == (struct sk_buff *)list_)
545                 list = NULL;
546         return list;
547 }
548
549 /**
550  *      skb_queue_len   - get queue length
551  *      @list_: list to measure
552  *
553  *      Return the length of an &sk_buff queue.
554  */
555 static inline __u32 skb_queue_len(const struct sk_buff_head *list_)
556 {
557         return list_->qlen;
558 }
559
560 static inline void skb_queue_head_init(struct sk_buff_head *list)
561 {
562         spin_lock_init(&list->lock);
563         list->prev = list->next = (struct sk_buff *)list;
564         list->qlen = 0;
565 }
566
567 /*
568  *      Insert an sk_buff at the start of a list.
569  *
570  *      The "__skb_xxxx()" functions are the non-atomic ones that
571  *      can only be called with interrupts disabled.
572  */
573
574 /**
575  *      __skb_queue_head - queue a buffer at the list head
576  *      @list: list to use
577  *      @newsk: buffer to queue
578  *
579  *      Queue a buffer at the start of a list. This function takes no locks
580  *      and you must therefore hold required locks before calling it.
581  *
582  *      A buffer cannot be placed on two lists at the same time.
583  */
584 extern void skb_queue_head(struct sk_buff_head *list, struct sk_buff *newsk);
585 static inline void __skb_queue_head(struct sk_buff_head *list,
586                                     struct sk_buff *newsk)
587 {
588         struct sk_buff *prev, *next;
589
590         list->qlen++;
591         prev = (struct sk_buff *)list;
592         next = prev->next;
593         newsk->next = next;
594         newsk->prev = prev;
595         next->prev  = prev->next = newsk;
596 }
597
598 /**
599  *      __skb_queue_tail - queue a buffer at the list tail
600  *      @list: list to use
601  *      @newsk: buffer to queue
602  *
603  *      Queue a buffer at the end of a list. This function takes no locks
604  *      and you must therefore hold required locks before calling it.
605  *
606  *      A buffer cannot be placed on two lists at the same time.
607  */
608 extern void skb_queue_tail(struct sk_buff_head *list, struct sk_buff *newsk);
609 static inline void __skb_queue_tail(struct sk_buff_head *list,
610                                    struct sk_buff *newsk)
611 {
612         struct sk_buff *prev, *next;
613
614         list->qlen++;
615         next = (struct sk_buff *)list;
616         prev = next->prev;
617         newsk->next = next;
618         newsk->prev = prev;
619         next->prev  = prev->next = newsk;
620 }
621
622
623 /**
624  *      __skb_dequeue - remove from the head of the queue
625  *      @list: list to dequeue from
626  *
627  *      Remove the head of the list. This function does not take any locks
628  *      so must be used with appropriate locks held only. The head item is
629  *      returned or %NULL if the list is empty.
630  */
631 extern struct sk_buff *skb_dequeue(struct sk_buff_head *list);
632 static inline struct sk_buff *__skb_dequeue(struct sk_buff_head *list)
633 {
634         struct sk_buff *next, *prev, *result;
635
636         prev = (struct sk_buff *) list;
637         next = prev->next;
638         result = NULL;
639         if (next != prev) {
640                 result       = next;
641                 next         = next->next;
642                 list->qlen--;
643                 next->prev   = prev;
644                 prev->next   = next;
645                 result->next = result->prev = NULL;
646         }
647         return result;
648 }
649
650
651 /*
652  *      Insert a packet on a list.
653  */
654 extern void        skb_insert(struct sk_buff *old, struct sk_buff *newsk, struct sk_buff_head *list);
655 static inline void __skb_insert(struct sk_buff *newsk,
656                                 struct sk_buff *prev, struct sk_buff *next,
657                                 struct sk_buff_head *list)
658 {
659         newsk->next = next;
660         newsk->prev = prev;
661         next->prev  = prev->next = newsk;
662         list->qlen++;
663 }
664
665 /*
666  *      Place a packet after a given packet in a list.
667  */
668 extern void        skb_append(struct sk_buff *old, struct sk_buff *newsk, struct sk_buff_head *list);
669 static inline void __skb_append(struct sk_buff *old, struct sk_buff *newsk, struct sk_buff_head *list)
670 {
671         __skb_insert(newsk, old, old->next, list);
672 }
673
674 /*
675  * remove sk_buff from list. _Must_ be called atomically, and with
676  * the list known..
677  */
678 extern void        skb_unlink(struct sk_buff *skb, struct sk_buff_head *list);
679 static inline void __skb_unlink(struct sk_buff *skb, struct sk_buff_head *list)
680 {
681         struct sk_buff *next, *prev;
682
683         list->qlen--;
684         next       = skb->next;
685         prev       = skb->prev;
686         skb->next  = skb->prev = NULL;
687         next->prev = prev;
688         prev->next = next;
689 }
690
691
692 /* XXX: more streamlined implementation */
693
694 /**
695  *      __skb_dequeue_tail - remove from the tail of the queue
696  *      @list: list to dequeue from
697  *
698  *      Remove the tail of the list. This function does not take any locks
699  *      so must be used with appropriate locks held only. The tail item is
700  *      returned or %NULL if the list is empty.
701  */
702 extern struct sk_buff *skb_dequeue_tail(struct sk_buff_head *list);
703 static inline struct sk_buff *__skb_dequeue_tail(struct sk_buff_head *list)
704 {
705         struct sk_buff *skb = skb_peek_tail(list);
706         if (skb)
707                 __skb_unlink(skb, list);
708         return skb;
709 }
710
711
712 static inline int skb_is_nonlinear(const struct sk_buff *skb)
713 {
714         return skb->data_len;
715 }
716
717 static inline unsigned int skb_headlen(const struct sk_buff *skb)
718 {
719         return skb->len - skb->data_len;
720 }
721
722 static inline int skb_pagelen(const struct sk_buff *skb)
723 {
724         int i, len = 0;
725
726         for (i = (int)skb_shinfo(skb)->nr_frags - 1; i >= 0; i--)
727                 len += skb_shinfo(skb)->frags[i].size;
728         return len + skb_headlen(skb);
729 }
730
731 static inline void skb_fill_page_desc(struct sk_buff *skb, int i,
732                                       struct page *page, int off, int size)
733 {
734         skb_frag_t *frag = &skb_shinfo(skb)->frags[i];
735
736         frag->page                = page;
737         frag->page_offset         = off;
738         frag->size                = size;
739         skb_shinfo(skb)->nr_frags = i + 1;
740 }
741
742 #define SKB_PAGE_ASSERT(skb)    BUG_ON(skb_shinfo(skb)->nr_frags)
743 #define SKB_FRAG_ASSERT(skb)    BUG_ON(skb_shinfo(skb)->frag_list)
744 #define SKB_LINEAR_ASSERT(skb)  BUG_ON(skb_is_nonlinear(skb))
745
746 /*
747  *      Add data to an sk_buff
748  */
749 static inline unsigned char *__skb_put(struct sk_buff *skb, unsigned int len)
750 {
751         unsigned char *tmp = skb->tail;
752         SKB_LINEAR_ASSERT(skb);
753         skb->tail += len;
754         skb->len  += len;
755         return tmp;
756 }
757
758 /**
759  *      skb_put - add data to a buffer
760  *      @skb: buffer to use
761  *      @len: amount of data to add
762  *
763  *      This function extends the used data area of the buffer. If this would
764  *      exceed the total buffer size the kernel will panic. A pointer to the
765  *      first byte of the extra data is returned.
766  */
767 static inline unsigned char *skb_put(struct sk_buff *skb, unsigned int len)
768 {
769         unsigned char *tmp = skb->tail;
770         SKB_LINEAR_ASSERT(skb);
771         skb->tail += len;
772         skb->len  += len;
773         if (unlikely(skb->tail>skb->end))
774                 skb_over_panic(skb, len, current_text_addr());
775         return tmp;
776 }
777
778 static inline unsigned char *__skb_push(struct sk_buff *skb, unsigned int len)
779 {
780         skb->data -= len;
781         skb->len  += len;
782         return skb->data;
783 }
784
785 /**
786  *      skb_push - add data to the start of a buffer
787  *      @skb: buffer to use
788  *      @len: amount of data to add
789  *
790  *      This function extends the used data area of the buffer at the buffer
791  *      start. If this would exceed the total buffer headroom the kernel will
792  *      panic. A pointer to the first byte of the extra data is returned.
793  */
794 static inline unsigned char *skb_push(struct sk_buff *skb, unsigned int len)
795 {
796         skb->data -= len;
797         skb->len  += len;
798         if (unlikely(skb->data<skb->head))
799                 skb_under_panic(skb, len, current_text_addr());
800         return skb->data;
801 }
802
803 static inline unsigned char *__skb_pull(struct sk_buff *skb, unsigned int len)
804 {
805         skb->len -= len;
806         BUG_ON(skb->len < skb->data_len);
807         return skb->data += len;
808 }
809
810 /**
811  *      skb_pull - remove data from the start of a buffer
812  *      @skb: buffer to use
813  *      @len: amount of data to remove
814  *
815  *      This function removes data from the start of a buffer, returning
816  *      the memory to the headroom. A pointer to the next data in the buffer
817  *      is returned. Once the data has been pulled future pushes will overwrite
818  *      the old data.
819  */
820 static inline unsigned char *skb_pull(struct sk_buff *skb, unsigned int len)
821 {
822         return unlikely(len > skb->len) ? NULL : __skb_pull(skb, len);
823 }
824
825 extern unsigned char *__pskb_pull_tail(struct sk_buff *skb, int delta);
826
827 static inline unsigned char *__pskb_pull(struct sk_buff *skb, unsigned int len)
828 {
829         if (len > skb_headlen(skb) &&
830             !__pskb_pull_tail(skb, len-skb_headlen(skb)))
831                 return NULL;
832         skb->len -= len;
833         return skb->data += len;
834 }
835
836 static inline unsigned char *pskb_pull(struct sk_buff *skb, unsigned int len)
837 {
838         return unlikely(len > skb->len) ? NULL : __pskb_pull(skb, len);
839 }
840
841 static inline int pskb_may_pull(struct sk_buff *skb, unsigned int len)
842 {
843         if (likely(len <= skb_headlen(skb)))
844                 return 1;
845         if (unlikely(len > skb->len))
846                 return 0;
847         return __pskb_pull_tail(skb, len-skb_headlen(skb)) != NULL;
848 }
849
850 /**
851  *      skb_headroom - bytes at buffer head
852  *      @skb: buffer to check
853  *
854  *      Return the number of bytes of free space at the head of an &sk_buff.
855  */
856 static inline int skb_headroom(const struct sk_buff *skb)
857 {
858         return skb->data - skb->head;
859 }
860
861 /**
862  *      skb_tailroom - bytes at buffer end
863  *      @skb: buffer to check
864  *
865  *      Return the number of bytes of free space at the tail of an sk_buff
866  */
867 static inline int skb_tailroom(const struct sk_buff *skb)
868 {
869         return skb_is_nonlinear(skb) ? 0 : skb->end - skb->tail;
870 }
871
872 /**
873  *      skb_reserve - adjust headroom
874  *      @skb: buffer to alter
875  *      @len: bytes to move
876  *
877  *      Increase the headroom of an empty &sk_buff by reducing the tail
878  *      room. This is only allowed for an empty buffer.
879  */
880 static inline void skb_reserve(struct sk_buff *skb, unsigned int len)
881 {
882         skb->data += len;
883         skb->tail += len;
884 }
885
886 /*
887  * CPUs often take a performance hit when accessing unaligned memory
888  * locations. The actual performance hit varies, it can be small if the
889  * hardware handles it or large if we have to take an exception and fix it
890  * in software.
891  *
892  * Since an ethernet header is 14 bytes network drivers often end up with
893  * the IP header at an unaligned offset. The IP header can be aligned by
894  * shifting the start of the packet by 2 bytes. Drivers should do this
895  * with:
896  *
897  * skb_reserve(NET_IP_ALIGN);
898  *
899  * The downside to this alignment of the IP header is that the DMA is now
900  * unaligned. On some architectures the cost of an unaligned DMA is high
901  * and this cost outweighs the gains made by aligning the IP header.
902  * 
903  * Since this trade off varies between architectures, we allow NET_IP_ALIGN
904  * to be overridden.
905  */
906 #ifndef NET_IP_ALIGN
907 #define NET_IP_ALIGN    2
908 #endif
909
910 extern int ___pskb_trim(struct sk_buff *skb, unsigned int len, int realloc);
911
912 static inline void __skb_trim(struct sk_buff *skb, unsigned int len)
913 {
914         if (!skb->data_len) {
915                 skb->len  = len;
916                 skb->tail = skb->data + len;
917         } else
918                 ___pskb_trim(skb, len, 0);
919 }
920
921 /**
922  *      skb_trim - remove end from a buffer
923  *      @skb: buffer to alter
924  *      @len: new length
925  *
926  *      Cut the length of a buffer down by removing data from the tail. If
927  *      the buffer is already under the length specified it is not modified.
928  */
929 static inline void skb_trim(struct sk_buff *skb, unsigned int len)
930 {
931         if (skb->len > len)
932                 __skb_trim(skb, len);
933 }
934
935
936 static inline int __pskb_trim(struct sk_buff *skb, unsigned int len)
937 {
938         if (!skb->data_len) {
939                 skb->len  = len;
940                 skb->tail = skb->data+len;
941                 return 0;
942         }
943         return ___pskb_trim(skb, len, 1);
944 }
945
946 static inline int pskb_trim(struct sk_buff *skb, unsigned int len)
947 {
948         return (len < skb->len) ? __pskb_trim(skb, len) : 0;
949 }
950
951 /**
952  *      skb_orphan - orphan a buffer
953  *      @skb: buffer to orphan
954  *
955  *      If a buffer currently has an owner then we call the owner's
956  *      destructor function and make the @skb unowned. The buffer continues
957  *      to exist but is no longer charged to its former owner.
958  */
959 static inline void skb_orphan(struct sk_buff *skb)
960 {
961         if (skb->destructor)
962                 skb->destructor(skb);
963         skb->destructor = NULL;
964         skb->sk         = NULL;
965 }
966
967 /**
968  *      __skb_queue_purge - empty a list
969  *      @list: list to empty
970  *
971  *      Delete all buffers on an &sk_buff list. Each buffer is removed from
972  *      the list and one reference dropped. This function does not take the
973  *      list lock and the caller must hold the relevant locks to use it.
974  */
975 extern void skb_queue_purge(struct sk_buff_head *list);
976 static inline void __skb_queue_purge(struct sk_buff_head *list)
977 {
978         struct sk_buff *skb;
979         while ((skb = __skb_dequeue(list)) != NULL)
980                 kfree_skb(skb);
981 }
982
983 #ifndef CONFIG_HAVE_ARCH_DEV_ALLOC_SKB
984 /**
985  *      __dev_alloc_skb - allocate an skbuff for sending
986  *      @length: length to allocate
987  *      @gfp_mask: get_free_pages mask, passed to alloc_skb
988  *
989  *      Allocate a new &sk_buff and assign it a usage count of one. The
990  *      buffer has unspecified headroom built in. Users should allocate
991  *      the headroom they think they need without accounting for the
992  *      built in space. The built in space is used for optimisations.
993  *
994  *      %NULL is returned in there is no free memory.
995  */
996 static inline struct sk_buff *__dev_alloc_skb(unsigned int length,
997                                               unsigned int __nocast gfp_mask)
998 {
999         struct sk_buff *skb = alloc_skb(length + 16, gfp_mask);
1000         if (likely(skb))
1001                 skb_reserve(skb, 16);
1002         return skb;
1003 }
1004 #else
1005 extern struct sk_buff *__dev_alloc_skb(unsigned int length, int gfp_mask);
1006 #endif
1007
1008 /**
1009  *      dev_alloc_skb - allocate an skbuff for sending
1010  *      @length: length to allocate
1011  *
1012  *      Allocate a new &sk_buff and assign it a usage count of one. The
1013  *      buffer has unspecified headroom built in. Users should allocate
1014  *      the headroom they think they need without accounting for the
1015  *      built in space. The built in space is used for optimisations.
1016  *
1017  *      %NULL is returned in there is no free memory. Although this function
1018  *      allocates memory it can be called from an interrupt.
1019  */
1020 static inline struct sk_buff *dev_alloc_skb(unsigned int length)
1021 {
1022         return __dev_alloc_skb(length, GFP_ATOMIC);
1023 }
1024
1025 /**
1026  *      skb_cow - copy header of skb when it is required
1027  *      @skb: buffer to cow
1028  *      @headroom: needed headroom
1029  *
1030  *      If the skb passed lacks sufficient headroom or its data part
1031  *      is shared, data is reallocated. If reallocation fails, an error
1032  *      is returned and original skb is not changed.
1033  *
1034  *      The result is skb with writable area skb->head...skb->tail
1035  *      and at least @headroom of space at head.
1036  */
1037 static inline int skb_cow(struct sk_buff *skb, unsigned int headroom)
1038 {
1039         int delta = (headroom > 16 ? headroom : 16) - skb_headroom(skb);
1040
1041         if (delta < 0)
1042                 delta = 0;
1043
1044         if (delta || skb_cloned(skb))
1045                 return pskb_expand_head(skb, (delta + 15) & ~15, 0, GFP_ATOMIC);
1046         return 0;
1047 }
1048
1049 /**
1050  *      skb_padto       - pad an skbuff up to a minimal size
1051  *      @skb: buffer to pad
1052  *      @len: minimal length
1053  *
1054  *      Pads up a buffer to ensure the trailing bytes exist and are
1055  *      blanked. If the buffer already contains sufficient data it
1056  *      is untouched. Returns the buffer, which may be a replacement
1057  *      for the original, or NULL for out of memory - in which case
1058  *      the original buffer is still freed.
1059  */
1060  
1061 static inline struct sk_buff *skb_padto(struct sk_buff *skb, unsigned int len)
1062 {
1063         unsigned int size = skb->len;
1064         if (likely(size >= len))
1065                 return skb;
1066         return skb_pad(skb, len-size);
1067 }
1068
1069 static inline int skb_add_data(struct sk_buff *skb,
1070                                char __user *from, int copy)
1071 {
1072         const int off = skb->len;
1073
1074         if (skb->ip_summed == CHECKSUM_NONE) {
1075                 int err = 0;
1076                 unsigned int csum = csum_and_copy_from_user(from,
1077                                                             skb_put(skb, copy),
1078                                                             copy, 0, &err);
1079                 if (!err) {
1080                         skb->csum = csum_block_add(skb->csum, csum, off);
1081                         return 0;
1082                 }
1083         } else if (!copy_from_user(skb_put(skb, copy), from, copy))
1084                 return 0;
1085
1086         __skb_trim(skb, off);
1087         return -EFAULT;
1088 }
1089
1090 static inline int skb_can_coalesce(struct sk_buff *skb, int i,
1091                                    struct page *page, int off)
1092 {
1093         if (i) {
1094                 struct skb_frag_struct *frag = &skb_shinfo(skb)->frags[i - 1];
1095
1096                 return page == frag->page &&
1097                        off == frag->page_offset + frag->size;
1098         }
1099         return 0;
1100 }
1101
1102 /**
1103  *      skb_linearize - convert paged skb to linear one
1104  *      @skb: buffer to linarize
1105  *      @gfp: allocation mode
1106  *
1107  *      If there is no free memory -ENOMEM is returned, otherwise zero
1108  *      is returned and the old skb data released.
1109  */
1110 extern int __skb_linearize(struct sk_buff *skb, unsigned int __nocast gfp);
1111 static inline int skb_linearize(struct sk_buff *skb, unsigned int __nocast gfp)
1112 {
1113         return __skb_linearize(skb, gfp);
1114 }
1115
1116 /**
1117  *      skb_postpull_rcsum - update checksum for received skb after pull
1118  *      @skb: buffer to update
1119  *      @start: start of data before pull
1120  *      @len: length of data pulled
1121  *
1122  *      After doing a pull on a received packet, you need to call this to
1123  *      update the CHECKSUM_HW checksum, or set ip_summed to CHECKSUM_NONE
1124  *      so that it can be recomputed from scratch.
1125  */
1126
1127 static inline void skb_postpull_rcsum(struct sk_buff *skb,
1128                                          const void *start, int len)
1129 {
1130         if (skb->ip_summed == CHECKSUM_HW)
1131                 skb->csum = csum_sub(skb->csum, csum_partial(start, len, 0));
1132 }
1133
1134 /**
1135  *      pskb_trim_rcsum - trim received skb and update checksum
1136  *      @skb: buffer to trim
1137  *      @len: new length
1138  *
1139  *      This is exactly the same as pskb_trim except that it ensures the
1140  *      checksum of received packets are still valid after the operation.
1141  */
1142
1143 static inline int pskb_trim_rcsum(struct sk_buff *skb, unsigned int len)
1144 {
1145         if (len >= skb->len)
1146                 return 0;
1147         if (skb->ip_summed == CHECKSUM_HW)
1148                 skb->ip_summed = CHECKSUM_NONE;
1149         return __pskb_trim(skb, len);
1150 }
1151
1152 static inline void *kmap_skb_frag(const skb_frag_t *frag)
1153 {
1154 #ifdef CONFIG_HIGHMEM
1155         BUG_ON(in_irq());
1156
1157         local_bh_disable();
1158 #endif
1159         return kmap_atomic(frag->page, KM_SKB_DATA_SOFTIRQ);
1160 }
1161
1162 static inline void kunmap_skb_frag(void *vaddr)
1163 {
1164         kunmap_atomic(vaddr, KM_SKB_DATA_SOFTIRQ);
1165 #ifdef CONFIG_HIGHMEM
1166         local_bh_enable();
1167 #endif
1168 }
1169
1170 #define skb_queue_walk(queue, skb) \
1171                 for (skb = (queue)->next;                                       \
1172                      prefetch(skb->next), (skb != (struct sk_buff *)(queue));   \
1173                      skb = skb->next)
1174
1175
1176 extern struct sk_buff *skb_recv_datagram(struct sock *sk, unsigned flags,
1177                                          int noblock, int *err);
1178 extern unsigned int    datagram_poll(struct file *file, struct socket *sock,
1179                                      struct poll_table_struct *wait);
1180 extern int             skb_copy_datagram_iovec(const struct sk_buff *from,
1181                                                int offset, struct iovec *to,
1182                                                int size);
1183 extern int             skb_copy_and_csum_datagram_iovec(const
1184                                                         struct sk_buff *skb,
1185                                                         int hlen,
1186                                                         struct iovec *iov);
1187 extern void            skb_free_datagram(struct sock *sk, struct sk_buff *skb);
1188 extern unsigned int    skb_checksum(const struct sk_buff *skb, int offset,
1189                                     int len, unsigned int csum);
1190 extern int             skb_copy_bits(const struct sk_buff *skb, int offset,
1191                                      void *to, int len);
1192 extern int             skb_store_bits(const struct sk_buff *skb, int offset,
1193                                       void *from, int len);
1194 extern unsigned int    skb_copy_and_csum_bits(const struct sk_buff *skb,
1195                                               int offset, u8 *to, int len,
1196                                               unsigned int csum);
1197 extern void            skb_copy_and_csum_dev(const struct sk_buff *skb, u8 *to);
1198 extern void            skb_split(struct sk_buff *skb,
1199                                  struct sk_buff *skb1, const u32 len);
1200
1201 static inline void *skb_header_pointer(const struct sk_buff *skb, int offset,
1202                                        int len, void *buffer)
1203 {
1204         int hlen = skb_headlen(skb);
1205
1206         if (hlen - offset >= len)
1207                 return skb->data + offset;
1208
1209         if (skb_copy_bits(skb, offset, buffer, len) < 0)
1210                 return NULL;
1211
1212         return buffer;
1213 }
1214
1215 extern void skb_init(void);
1216 extern void skb_add_mtu(int mtu);
1217
1218 #ifdef CONFIG_NETFILTER
1219 static inline void nf_conntrack_put(struct nf_conntrack *nfct)
1220 {
1221         if (nfct && atomic_dec_and_test(&nfct->use))
1222                 nfct->destroy(nfct);
1223 }
1224 static inline void nf_conntrack_get(struct nf_conntrack *nfct)
1225 {
1226         if (nfct)
1227                 atomic_inc(&nfct->use);
1228 }
1229 static inline void nf_reset(struct sk_buff *skb)
1230 {
1231         nf_conntrack_put(skb->nfct);
1232         skb->nfct = NULL;
1233 }
1234
1235 #ifdef CONFIG_BRIDGE_NETFILTER
1236 static inline void nf_bridge_put(struct nf_bridge_info *nf_bridge)
1237 {
1238         if (nf_bridge && atomic_dec_and_test(&nf_bridge->use))
1239                 kfree(nf_bridge);
1240 }
1241 static inline void nf_bridge_get(struct nf_bridge_info *nf_bridge)
1242 {
1243         if (nf_bridge)
1244                 atomic_inc(&nf_bridge->use);
1245 }
1246 #endif /* CONFIG_BRIDGE_NETFILTER */
1247 #else /* CONFIG_NETFILTER */
1248 static inline void nf_reset(struct sk_buff *skb) {}
1249 #endif /* CONFIG_NETFILTER */
1250
1251 #endif  /* __KERNEL__ */
1252 #endif  /* _LINUX_SKBUFF_H */