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