MOXA linux-2.6.x / linux-2.6.9-uc0 from sdlinux-moxaart.tgz
[linux-2.6.9-moxart.git] / include / linux / skbuff.h
blob71fc2bdc0cd6f730d2a756072af6b61f65f38f34
1 /*
2 * Definitions for the 'struct sk_buff' memory handlers.
4 * Authors:
5 * Alan Cox, <gw4pts@gw4pts.ampr.org>
6 * Florian La Roche, <rzsfl@rz.uni-sb.de>
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.
14 #ifndef _LINUX_SKBUFF_H
15 #define _LINUX_SKBUFF_H
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>
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 <net/checksum.h>
32 #define HAVE_ALLOC_SKB /* For the drivers to know */
33 #define HAVE_ALIGNABLE_SKB /* Ditto 8) */
34 #define SLAB_SKB /* Slabified skbuffs */
36 #define CHECKSUM_NONE 0
37 #define CHECKSUM_HW 1
38 #define CHECKSUM_UNNECESSARY 2
40 #define SKB_DATA_ALIGN(X) (((X) + (SMP_CACHE_BYTES - 1)) & \
41 ~(SMP_CACHE_BYTES - 1))
42 #define SKB_MAX_ORDER(X, ORDER) (((PAGE_SIZE << (ORDER)) - (X) - \
43 sizeof(struct skb_shared_info)) & \
44 ~(SMP_CACHE_BYTES - 1))
45 #define SKB_MAX_HEAD(X) (SKB_MAX_ORDER((X), 0))
46 #define SKB_MAX_ALLOC (SKB_MAX_ORDER(0, 2))
48 /* A. Checksumming of received packets by device.
50 * NONE: device failed to checksum this packet.
51 * skb->csum is undefined.
53 * UNNECESSARY: device parsed packet and wouldbe verified checksum.
54 * skb->csum is undefined.
55 * It is bad option, but, unfortunately, many of vendors do this.
56 * Apparently with secret goal to sell you new device, when you
57 * will add new protocol to your host. F.e. IPv6. 8)
59 * HW: the most generic way. Device supplied checksum of _all_
60 * the packet as seen by netif_rx in skb->csum.
61 * NOTE: Even if device supports only some protocols, but
62 * is able to produce some skb->csum, it MUST use HW,
63 * not UNNECESSARY.
65 * B. Checksumming on output.
67 * NONE: skb is checksummed by protocol or csum is not required.
69 * HW: device is required to csum packet as seen by hard_start_xmit
70 * from skb->h.raw to the end and to record the checksum
71 * at skb->h.raw+skb->csum.
73 * Device must show its capabilities in dev->features, set
74 * at device setup time.
75 * NETIF_F_HW_CSUM - it is clever device, it is able to checksum
76 * everything.
77 * NETIF_F_NO_CSUM - loopback or reliable single hop media.
78 * NETIF_F_IP_CSUM - device is dumb. It is able to csum only
79 * TCP/UDP over IPv4. Sigh. Vendors like this
80 * way by an unknown reason. Though, see comment above
81 * about CHECKSUM_UNNECESSARY. 8)
83 * Any questions? No questions, good. --ANK
86 #ifdef __i386__
87 #define NET_CALLER(arg) (*(((void **)&arg) - 1))
88 #else
89 #define NET_CALLER(arg) __builtin_return_address(0)
90 #endif
92 struct net_device;
94 #ifdef CONFIG_NETFILTER
95 struct nf_conntrack {
96 atomic_t use;
97 void (*destroy)(struct nf_conntrack *);
100 #ifdef CONFIG_BRIDGE_NETFILTER
101 struct nf_bridge_info {
102 atomic_t use;
103 struct net_device *physindev;
104 struct net_device *physoutdev;
105 #if defined(CONFIG_VLAN_8021Q) || defined(CONFIG_VLAN_8021Q_MODULE)
106 struct net_device *netoutdev;
107 #endif
108 unsigned int mask;
109 unsigned long data[32 / sizeof(unsigned long)];
111 #endif
113 #endif
115 struct sk_buff_head {
116 /* These two members must be first. */
117 struct sk_buff *next;
118 struct sk_buff *prev;
120 __u32 qlen;
121 spinlock_t lock;
124 struct sk_buff;
126 /* To allow 64K frame to be packed as single skb without frag_list */
127 #define MAX_SKB_FRAGS (65536/PAGE_SIZE + 2)
129 typedef struct skb_frag_struct skb_frag_t;
131 struct skb_frag_struct {
132 struct page *page;
133 __u16 page_offset;
134 __u16 size;
137 /* This data is invariant across clones and lives at
138 * the end of the header data, ie. at skb->end.
140 struct skb_shared_info {
141 atomic_t dataref;
142 unsigned int nr_frags;
143 unsigned short tso_size;
144 unsigned short tso_segs;
145 struct sk_buff *frag_list;
146 skb_frag_t frags[MAX_SKB_FRAGS];
149 /**
150 * struct sk_buff - socket buffer
151 * @next: Next buffer in list
152 * @prev: Previous buffer in list
153 * @list: List we are on
154 * @sk: Socket we are owned by
155 * @stamp: Time we arrived
156 * @dev: Device we arrived on/are leaving by
157 * @input_dev: Device we arrived on
158 * @real_dev: The real device we are using
159 * @h: Transport layer header
160 * @nh: Network layer header
161 * @mac: Link layer header
162 * @dst: FIXME: Describe this field
163 * @cb: Control buffer. Free for use by every layer. Put private vars here
164 * @len: Length of actual data
165 * @data_len: Data length
166 * @mac_len: Length of link layer header
167 * @csum: Checksum
168 * @__unused: Dead field, may be reused
169 * @cloned: Head may be cloned (check refcnt to be sure)
170 * @pkt_type: Packet class
171 * @ip_summed: Driver fed us an IP checksum
172 * @priority: Packet queueing priority
173 * @users: User count - see {datagram,tcp}.c
174 * @protocol: Packet protocol from driver
175 * @security: Security level of packet
176 * @truesize: Buffer size
177 * @head: Head of buffer
178 * @data: Data head pointer
179 * @tail: Tail pointer
180 * @end: End pointer
181 * @destructor: Destruct function
182 * @nfmark: Can be used for communication between hooks
183 * @nfcache: Cache info
184 * @nfct: Associated connection, if any
185 * @nfctinfo: Relationship of this skb to the connection
186 * @nf_debug: Netfilter debugging
187 * @nf_bridge: Saved data about a bridged frame - see br_netfilter.c
188 * @private: Data which is private to the HIPPI implementation
189 * @tc_index: Traffic control index
192 struct sk_buff {
193 /* These two members must be first. */
194 struct sk_buff *next;
195 struct sk_buff *prev;
197 struct sk_buff_head *list;
198 struct sock *sk;
199 struct timeval stamp;
200 struct net_device *dev;
201 struct net_device *input_dev;
202 struct net_device *real_dev;
204 union {
205 struct tcphdr *th;
206 struct udphdr *uh;
207 struct icmphdr *icmph;
208 struct igmphdr *igmph;
209 struct iphdr *ipiph;
210 struct ipv6hdr *ipv6h;
211 unsigned char *raw;
212 } h;
214 union {
215 struct iphdr *iph;
216 struct ipv6hdr *ipv6h;
217 struct arphdr *arph;
218 unsigned char *raw;
219 } nh;
221 union {
222 unsigned char *raw;
223 } mac;
225 struct dst_entry *dst;
226 struct sec_path *sp;
229 * This is the control buffer. It is free to use for every
230 * layer. Please put your private variables there. If you
231 * want to keep them across layers you have to do a skb_clone()
232 * first. This is owned by whoever has the skb queued ATM.
234 char cb[40];
236 unsigned int len,
237 data_len,
238 mac_len,
239 csum;
240 unsigned char local_df,
241 cloned,
242 pkt_type,
243 ip_summed;
244 __u32 priority;
245 unsigned short protocol,
246 security;
248 void (*destructor)(struct sk_buff *skb);
249 #ifdef CONFIG_NETFILTER
250 unsigned long nfmark;
251 __u32 nfcache;
252 __u32 nfctinfo;
253 struct nf_conntrack *nfct;
254 #ifdef CONFIG_NETFILTER_DEBUG
255 unsigned int nf_debug;
256 #endif
257 #ifdef CONFIG_BRIDGE_NETFILTER
258 struct nf_bridge_info *nf_bridge;
259 #endif
260 #endif /* CONFIG_NETFILTER */
261 #if defined(CONFIG_HIPPI)
262 union {
263 __u32 ifield;
264 } private;
265 #endif
266 #ifdef CONFIG_NET_SCHED
267 __u32 tc_index; /* traffic control index */
268 #ifdef CONFIG_NET_CLS_ACT
269 __u32 tc_verd; /* traffic control verdict */
270 __u32 tc_classid; /* traffic control classid */
271 #endif
273 #endif
276 /* These elements must be at the end, see alloc_skb() for details. */
277 unsigned int truesize;
278 atomic_t users;
279 unsigned char *head,
280 *data,
281 *tail,
282 *end;
285 #ifdef __KERNEL__
287 * Handling routines are only of interest to the kernel
289 #include <linux/slab.h>
291 #include <asm/system.h>
293 extern void __kfree_skb(struct sk_buff *skb);
294 extern struct sk_buff *alloc_skb(unsigned int size, int priority);
295 extern void kfree_skbmem(struct sk_buff *skb);
296 extern struct sk_buff *skb_clone(struct sk_buff *skb, int priority);
297 extern struct sk_buff *skb_copy(const struct sk_buff *skb, int priority);
298 extern struct sk_buff *pskb_copy(struct sk_buff *skb, int gfp_mask);
299 extern int pskb_expand_head(struct sk_buff *skb,
300 int nhead, int ntail, int gfp_mask);
301 extern struct sk_buff *skb_realloc_headroom(struct sk_buff *skb,
302 unsigned int headroom);
303 extern struct sk_buff *skb_copy_expand(const struct sk_buff *skb,
304 int newheadroom, int newtailroom,
305 int priority);
306 extern struct sk_buff * skb_pad(struct sk_buff *skb, int pad);
307 #define dev_kfree_skb(a) kfree_skb(a)
308 extern void skb_over_panic(struct sk_buff *skb, int len,
309 void *here);
310 extern void skb_under_panic(struct sk_buff *skb, int len,
311 void *here);
313 /* Internal */
314 #define skb_shinfo(SKB) ((struct skb_shared_info *)((SKB)->end))
317 * skb_queue_empty - check if a queue is empty
318 * @list: queue head
320 * Returns true if the queue is empty, false otherwise.
322 static inline int skb_queue_empty(const struct sk_buff_head *list)
324 return list->next == (struct sk_buff *)list;
328 * skb_get - reference buffer
329 * @skb: buffer to reference
331 * Makes another reference to a socket buffer and returns a pointer
332 * to the buffer.
334 static inline struct sk_buff *skb_get(struct sk_buff *skb)
336 atomic_inc(&skb->users);
337 return skb;
341 * If users == 1, we are the only owner and are can avoid redundant
342 * atomic change.
346 * kfree_skb - free an sk_buff
347 * @skb: buffer to free
349 * Drop a reference to the buffer and free it if the usage count has
350 * hit zero.
352 static inline void kfree_skb(struct sk_buff *skb)
354 if (atomic_read(&skb->users) == 1 || atomic_dec_and_test(&skb->users))
355 __kfree_skb(skb);
358 /* Use this if you didn't touch the skb state [for fast switching] */
359 static inline void kfree_skb_fast(struct sk_buff *skb)
361 if (atomic_read(&skb->users) == 1 || atomic_dec_and_test(&skb->users))
362 kfree_skbmem(skb);
366 * skb_cloned - is the buffer a clone
367 * @skb: buffer to check
369 * Returns true if the buffer was generated with skb_clone() and is
370 * one of multiple shared copies of the buffer. Cloned buffers are
371 * shared data so must not be written to under normal circumstances.
373 static inline int skb_cloned(const struct sk_buff *skb)
375 return skb->cloned && atomic_read(&skb_shinfo(skb)->dataref) != 1;
379 * skb_shared - is the buffer shared
380 * @skb: buffer to check
382 * Returns true if more than one person has a reference to this
383 * buffer.
385 static inline int skb_shared(const struct sk_buff *skb)
387 return atomic_read(&skb->users) != 1;
391 * skb_share_check - check if buffer is shared and if so clone it
392 * @skb: buffer to check
393 * @pri: priority for memory allocation
395 * If the buffer is shared the buffer is cloned and the old copy
396 * drops a reference. A new clone with a single reference is returned.
397 * If the buffer is not shared the original buffer is returned. When
398 * being called from interrupt status or with spinlocks held pri must
399 * be GFP_ATOMIC.
401 * NULL is returned on a memory allocation failure.
403 static inline struct sk_buff *skb_share_check(struct sk_buff *skb, int pri)
405 might_sleep_if(pri & __GFP_WAIT);
406 if (skb_shared(skb)) {
407 struct sk_buff *nskb = skb_clone(skb, pri);
408 kfree_skb(skb);
409 skb = nskb;
411 return skb;
415 * Copy shared buffers into a new sk_buff. We effectively do COW on
416 * packets to handle cases where we have a local reader and forward
417 * and a couple of other messy ones. The normal one is tcpdumping
418 * a packet thats being forwarded.
422 * skb_unshare - make a copy of a shared buffer
423 * @skb: buffer to check
424 * @pri: priority for memory allocation
426 * If the socket buffer is a clone then this function creates a new
427 * copy of the data, drops a reference count on the old copy and returns
428 * the new copy with the reference count at 1. If the buffer is not a clone
429 * the original buffer is returned. When called with a spinlock held or
430 * from interrupt state @pri must be %GFP_ATOMIC
432 * %NULL is returned on a memory allocation failure.
434 static inline struct sk_buff *skb_unshare(struct sk_buff *skb, int pri)
436 might_sleep_if(pri & __GFP_WAIT);
437 if (skb_cloned(skb)) {
438 struct sk_buff *nskb = skb_copy(skb, pri);
439 kfree_skb(skb); /* Free our shared copy */
440 skb = nskb;
442 return skb;
446 * skb_peek
447 * @list_: list to peek at
449 * Peek an &sk_buff. Unlike most other operations you _MUST_
450 * be careful with this one. A peek leaves the buffer on the
451 * list and someone else may run off with it. You must hold
452 * the appropriate locks or have a private queue to do this.
454 * Returns %NULL for an empty list or a pointer to the head element.
455 * The reference count is not incremented and the reference is therefore
456 * volatile. Use with caution.
458 static inline struct sk_buff *skb_peek(struct sk_buff_head *list_)
460 struct sk_buff *list = ((struct sk_buff *)list_)->next;
461 if (list == (struct sk_buff *)list_)
462 list = NULL;
463 return list;
467 * skb_peek_tail
468 * @list_: list to peek at
470 * Peek an &sk_buff. Unlike most other operations you _MUST_
471 * be careful with this one. A peek leaves the buffer on the
472 * list and someone else may run off with it. You must hold
473 * the appropriate locks or have a private queue to do this.
475 * Returns %NULL for an empty list or a pointer to the tail element.
476 * The reference count is not incremented and the reference is therefore
477 * volatile. Use with caution.
479 static inline struct sk_buff *skb_peek_tail(struct sk_buff_head *list_)
481 struct sk_buff *list = ((struct sk_buff *)list_)->prev;
482 if (list == (struct sk_buff *)list_)
483 list = NULL;
484 return list;
488 * skb_queue_len - get queue length
489 * @list_: list to measure
491 * Return the length of an &sk_buff queue.
493 static inline __u32 skb_queue_len(const struct sk_buff_head *list_)
495 return list_->qlen;
498 static inline void skb_queue_head_init(struct sk_buff_head *list)
500 spin_lock_init(&list->lock);
501 list->prev = list->next = (struct sk_buff *)list;
502 list->qlen = 0;
506 * Insert an sk_buff at the start of a list.
508 * The "__skb_xxxx()" functions are the non-atomic ones that
509 * can only be called with interrupts disabled.
513 * __skb_queue_head - queue a buffer at the list head
514 * @list: list to use
515 * @newsk: buffer to queue
517 * Queue a buffer at the start of a list. This function takes no locks
518 * and you must therefore hold required locks before calling it.
520 * A buffer cannot be placed on two lists at the same time.
522 extern void skb_queue_head(struct sk_buff_head *list, struct sk_buff *newsk);
523 static inline void __skb_queue_head(struct sk_buff_head *list,
524 struct sk_buff *newsk)
526 struct sk_buff *prev, *next;
528 newsk->list = list;
529 list->qlen++;
530 prev = (struct sk_buff *)list;
531 next = prev->next;
532 newsk->next = next;
533 newsk->prev = prev;
534 next->prev = prev->next = newsk;
538 * __skb_queue_tail - queue a buffer at the list tail
539 * @list: list to use
540 * @newsk: buffer to queue
542 * Queue a buffer at the end of a list. This function takes no locks
543 * and you must therefore hold required locks before calling it.
545 * A buffer cannot be placed on two lists at the same time.
547 extern void skb_queue_tail(struct sk_buff_head *list, struct sk_buff *newsk);
548 static inline void __skb_queue_tail(struct sk_buff_head *list,
549 struct sk_buff *newsk)
551 struct sk_buff *prev, *next;
553 newsk->list = list;
554 list->qlen++;
555 next = (struct sk_buff *)list;
556 prev = next->prev;
557 newsk->next = next;
558 newsk->prev = prev;
559 next->prev = prev->next = newsk;
564 * __skb_dequeue - remove from the head of the queue
565 * @list: list to dequeue from
567 * Remove the head of the list. This function does not take any locks
568 * so must be used with appropriate locks held only. The head item is
569 * returned or %NULL if the list is empty.
571 extern struct sk_buff *skb_dequeue(struct sk_buff_head *list);
572 static inline struct sk_buff *__skb_dequeue(struct sk_buff_head *list)
574 struct sk_buff *next, *prev, *result;
576 prev = (struct sk_buff *) list;
577 next = prev->next;
578 result = NULL;
579 if (next != prev) {
580 result = next;
581 next = next->next;
582 list->qlen--;
583 next->prev = prev;
584 prev->next = next;
585 result->next = result->prev = NULL;
586 result->list = NULL;
588 return result;
593 * Insert a packet on a list.
595 extern void skb_insert(struct sk_buff *old, struct sk_buff *newsk);
596 static inline void __skb_insert(struct sk_buff *newsk,
597 struct sk_buff *prev, struct sk_buff *next,
598 struct sk_buff_head *list)
600 newsk->next = next;
601 newsk->prev = prev;
602 next->prev = prev->next = newsk;
603 newsk->list = list;
604 list->qlen++;
608 * Place a packet after a given packet in a list.
610 extern void skb_append(struct sk_buff *old, struct sk_buff *newsk);
611 static inline void __skb_append(struct sk_buff *old, struct sk_buff *newsk)
613 __skb_insert(newsk, old, old->next, old->list);
617 * remove sk_buff from list. _Must_ be called atomically, and with
618 * the list known..
620 extern void skb_unlink(struct sk_buff *skb);
621 static inline void __skb_unlink(struct sk_buff *skb, struct sk_buff_head *list)
623 struct sk_buff *next, *prev;
625 list->qlen--;
626 next = skb->next;
627 prev = skb->prev;
628 skb->next = skb->prev = NULL;
629 skb->list = NULL;
630 next->prev = prev;
631 prev->next = next;
635 /* XXX: more streamlined implementation */
638 * __skb_dequeue_tail - remove from the tail of the queue
639 * @list: list to dequeue from
641 * Remove the tail of the list. This function does not take any locks
642 * so must be used with appropriate locks held only. The tail item is
643 * returned or %NULL if the list is empty.
645 extern struct sk_buff *skb_dequeue_tail(struct sk_buff_head *list);
646 static inline struct sk_buff *__skb_dequeue_tail(struct sk_buff_head *list)
648 struct sk_buff *skb = skb_peek_tail(list);
649 if (skb)
650 __skb_unlink(skb, list);
651 return skb;
655 static inline int skb_is_nonlinear(const struct sk_buff *skb)
657 return skb->data_len;
660 static inline unsigned int skb_headlen(const struct sk_buff *skb)
662 return skb->len - skb->data_len;
665 static inline int skb_pagelen(const struct sk_buff *skb)
667 int i, len = 0;
669 for (i = (int)skb_shinfo(skb)->nr_frags - 1; i >= 0; i--)
670 len += skb_shinfo(skb)->frags[i].size;
671 return len + skb_headlen(skb);
674 static inline void skb_fill_page_desc(struct sk_buff *skb, int i,
675 struct page *page, int off, int size)
677 skb_frag_t *frag = &skb_shinfo(skb)->frags[i];
679 frag->page = page;
680 frag->page_offset = off;
681 frag->size = size;
682 skb_shinfo(skb)->nr_frags = i + 1;
685 #define SKB_PAGE_ASSERT(skb) BUG_ON(skb_shinfo(skb)->nr_frags)
686 #define SKB_FRAG_ASSERT(skb) BUG_ON(skb_shinfo(skb)->frag_list)
687 #define SKB_LINEAR_ASSERT(skb) BUG_ON(skb_is_nonlinear(skb))
690 * Add data to an sk_buff
692 static inline unsigned char *__skb_put(struct sk_buff *skb, unsigned int len)
694 unsigned char *tmp = skb->tail;
695 SKB_LINEAR_ASSERT(skb);
696 skb->tail += len;
697 skb->len += len;
698 return tmp;
702 * skb_put - add data to a buffer
703 * @skb: buffer to use
704 * @len: amount of data to add
706 * This function extends the used data area of the buffer. If this would
707 * exceed the total buffer size the kernel will panic. A pointer to the
708 * first byte of the extra data is returned.
710 static inline unsigned char *skb_put(struct sk_buff *skb, unsigned int len)
712 unsigned char *tmp = skb->tail;
713 SKB_LINEAR_ASSERT(skb);
714 skb->tail += len;
715 skb->len += len;
716 if (unlikely(skb->tail>skb->end))
717 skb_over_panic(skb, len, current_text_addr());
718 return tmp;
721 static inline unsigned char *__skb_push(struct sk_buff *skb, unsigned int len)
723 skb->data -= len;
724 skb->len += len;
725 return skb->data;
729 * skb_push - add data to the start of a buffer
730 * @skb: buffer to use
731 * @len: amount of data to add
733 * This function extends the used data area of the buffer at the buffer
734 * start. If this would exceed the total buffer headroom the kernel will
735 * panic. A pointer to the first byte of the extra data is returned.
737 static inline unsigned char *skb_push(struct sk_buff *skb, unsigned int len)
739 skb->data -= len;
740 skb->len += len;
741 if (unlikely(skb->data<skb->head))
742 skb_under_panic(skb, len, current_text_addr());
743 return skb->data;
746 static inline unsigned char *__skb_pull(struct sk_buff *skb, unsigned int len)
748 skb->len -= len;
749 BUG_ON(skb->len < skb->data_len);
750 return skb->data += len;
754 * skb_pull - remove data from the start of a buffer
755 * @skb: buffer to use
756 * @len: amount of data to remove
758 * This function removes data from the start of a buffer, returning
759 * the memory to the headroom. A pointer to the next data in the buffer
760 * is returned. Once the data has been pulled future pushes will overwrite
761 * the old data.
763 static inline unsigned char *skb_pull(struct sk_buff *skb, unsigned int len)
765 return unlikely(len > skb->len) ? NULL : __skb_pull(skb, len);
768 extern unsigned char *__pskb_pull_tail(struct sk_buff *skb, int delta);
770 static inline unsigned char *__pskb_pull(struct sk_buff *skb, unsigned int len)
772 if (len > skb_headlen(skb) &&
773 !__pskb_pull_tail(skb, len-skb_headlen(skb)))
774 return NULL;
775 skb->len -= len;
776 return skb->data += len;
779 static inline unsigned char *pskb_pull(struct sk_buff *skb, unsigned int len)
781 return unlikely(len > skb->len) ? NULL : __pskb_pull(skb, len);
784 static inline int pskb_may_pull(struct sk_buff *skb, unsigned int len)
786 if (likely(len <= skb_headlen(skb)))
787 return 1;
788 if (unlikely(len > skb->len))
789 return 0;
790 return __pskb_pull_tail(skb, len-skb_headlen(skb)) != NULL;
794 * skb_headroom - bytes at buffer head
795 * @skb: buffer to check
797 * Return the number of bytes of free space at the head of an &sk_buff.
799 static inline int skb_headroom(const struct sk_buff *skb)
801 return skb->data - skb->head;
805 * skb_tailroom - bytes at buffer end
806 * @skb: buffer to check
808 * Return the number of bytes of free space at the tail of an sk_buff
810 static inline int skb_tailroom(const struct sk_buff *skb)
812 return skb_is_nonlinear(skb) ? 0 : skb->end - skb->tail;
816 * skb_reserve - adjust headroom
817 * @skb: buffer to alter
818 * @len: bytes to move
820 * Increase the headroom of an empty &sk_buff by reducing the tail
821 * room. This is only allowed for an empty buffer.
823 static inline void skb_reserve(struct sk_buff *skb, unsigned int len)
825 skb->data += len;
826 skb->tail += len;
830 * CPUs often take a performance hit when accessing unaligned memory
831 * locations. The actual performance hit varies, it can be small if the
832 * hardware handles it or large if we have to take an exception and fix it
833 * in software.
835 * Since an ethernet header is 14 bytes network drivers often end up with
836 * the IP header at an unaligned offset. The IP header can be aligned by
837 * shifting the start of the packet by 2 bytes. Drivers should do this
838 * with:
840 * skb_reserve(NET_IP_ALIGN);
842 * The downside to this alignment of the IP header is that the DMA is now
843 * unaligned. On some architectures the cost of an unaligned DMA is high
844 * and this cost outweighs the gains made by aligning the IP header.
846 * Since this trade off varies between architectures, we allow NET_IP_ALIGN
847 * to be overridden.
849 #ifndef NET_IP_ALIGN
850 #define NET_IP_ALIGN 2
851 #endif
853 extern int ___pskb_trim(struct sk_buff *skb, unsigned int len, int realloc);
855 static inline void __skb_trim(struct sk_buff *skb, unsigned int len)
857 if (!skb->data_len) {
858 skb->len = len;
859 skb->tail = skb->data + len;
860 } else
861 ___pskb_trim(skb, len, 0);
865 * skb_trim - remove end from a buffer
866 * @skb: buffer to alter
867 * @len: new length
869 * Cut the length of a buffer down by removing data from the tail. If
870 * the buffer is already under the length specified it is not modified.
872 static inline void skb_trim(struct sk_buff *skb, unsigned int len)
874 if (skb->len > len)
875 __skb_trim(skb, len);
879 static inline int __pskb_trim(struct sk_buff *skb, unsigned int len)
881 if (!skb->data_len) {
882 skb->len = len;
883 skb->tail = skb->data+len;
884 return 0;
886 return ___pskb_trim(skb, len, 1);
889 static inline int pskb_trim(struct sk_buff *skb, unsigned int len)
891 return (len < skb->len) ? __pskb_trim(skb, len) : 0;
895 * skb_orphan - orphan a buffer
896 * @skb: buffer to orphan
898 * If a buffer currently has an owner then we call the owner's
899 * destructor function and make the @skb unowned. The buffer continues
900 * to exist but is no longer charged to its former owner.
902 static inline void skb_orphan(struct sk_buff *skb)
904 if (skb->destructor)
905 skb->destructor(skb);
906 skb->destructor = NULL;
907 skb->sk = NULL;
911 * __skb_queue_purge - empty a list
912 * @list: list to empty
914 * Delete all buffers on an &sk_buff list. Each buffer is removed from
915 * the list and one reference dropped. This function does not take the
916 * list lock and the caller must hold the relevant locks to use it.
918 extern void skb_queue_purge(struct sk_buff_head *list);
919 static inline void __skb_queue_purge(struct sk_buff_head *list)
921 struct sk_buff *skb;
922 while ((skb = __skb_dequeue(list)) != NULL)
923 kfree_skb(skb);
927 * __dev_alloc_skb - allocate an skbuff for sending
928 * @length: length to allocate
929 * @gfp_mask: get_free_pages mask, passed to alloc_skb
931 * Allocate a new &sk_buff and assign it a usage count of one. The
932 * buffer has unspecified headroom built in. Users should allocate
933 * the headroom they think they need without accounting for the
934 * built in space. The built in space is used for optimisations.
936 * %NULL is returned in there is no free memory.
938 static inline struct sk_buff *__dev_alloc_skb(unsigned int length,
939 int gfp_mask)
941 struct sk_buff *skb = alloc_skb(length + 16, gfp_mask);
942 if (likely(skb))
943 skb_reserve(skb, 16);
944 return skb;
948 * dev_alloc_skb - allocate an skbuff for sending
949 * @length: length to allocate
951 * Allocate a new &sk_buff and assign it a usage count of one. The
952 * buffer has unspecified headroom built in. Users should allocate
953 * the headroom they think they need without accounting for the
954 * built in space. The built in space is used for optimisations.
956 * %NULL is returned in there is no free memory. Although this function
957 * allocates memory it can be called from an interrupt.
959 static inline struct sk_buff *dev_alloc_skb(unsigned int length)
961 return __dev_alloc_skb(length, GFP_ATOMIC);
965 * skb_cow - copy header of skb when it is required
966 * @skb: buffer to cow
967 * @headroom: needed headroom
969 * If the skb passed lacks sufficient headroom or its data part
970 * is shared, data is reallocated. If reallocation fails, an error
971 * is returned and original skb is not changed.
973 * The result is skb with writable area skb->head...skb->tail
974 * and at least @headroom of space at head.
976 static inline int skb_cow(struct sk_buff *skb, unsigned int headroom)
978 int delta = (headroom > 16 ? headroom : 16) - skb_headroom(skb);
980 if (delta < 0)
981 delta = 0;
983 if (delta || skb_cloned(skb))
984 return pskb_expand_head(skb, (delta + 15) & ~15, 0, GFP_ATOMIC);
985 return 0;
989 * skb_padto - pad an skbuff up to a minimal size
990 * @skb: buffer to pad
991 * @len: minimal length
993 * Pads up a buffer to ensure the trailing bytes exist and are
994 * blanked. If the buffer already contains sufficient data it
995 * is untouched. Returns the buffer, which may be a replacement
996 * for the original, or NULL for out of memory - in which case
997 * the original buffer is still freed.
1000 static inline struct sk_buff *skb_padto(struct sk_buff *skb, unsigned int len)
1002 unsigned int size = skb->len;
1003 if (likely(size >= len))
1004 return skb;
1005 return skb_pad(skb, len-size);
1008 static inline int skb_add_data(struct sk_buff *skb,
1009 char __user *from, int copy)
1011 const int off = skb->len;
1013 if (skb->ip_summed == CHECKSUM_NONE) {
1014 int err = 0;
1015 unsigned int csum = csum_and_copy_from_user(from,
1016 skb_put(skb, copy),
1017 copy, 0, &err);
1018 if (!err) {
1019 skb->csum = csum_block_add(skb->csum, csum, off);
1020 return 0;
1022 } else if (!copy_from_user(skb_put(skb, copy), from, copy))
1023 return 0;
1025 __skb_trim(skb, off);
1026 return -EFAULT;
1029 static inline int skb_can_coalesce(struct sk_buff *skb, int i,
1030 struct page *page, int off)
1032 if (i) {
1033 struct skb_frag_struct *frag = &skb_shinfo(skb)->frags[i - 1];
1035 return page == frag->page &&
1036 off == frag->page_offset + frag->size;
1038 return 0;
1042 * skb_linearize - convert paged skb to linear one
1043 * @skb: buffer to linarize
1044 * @gfp: allocation mode
1046 * If there is no free memory -ENOMEM is returned, otherwise zero
1047 * is returned and the old skb data released.
1049 extern int __skb_linearize(struct sk_buff *skb, int gfp);
1050 static inline int skb_linearize(struct sk_buff *skb, int gfp)
1052 return __skb_linearize(skb, gfp);
1055 static inline void *kmap_skb_frag(const skb_frag_t *frag)
1057 #ifdef CONFIG_HIGHMEM
1058 BUG_ON(in_irq());
1060 local_bh_disable();
1061 #endif
1062 return kmap_atomic(frag->page, KM_SKB_DATA_SOFTIRQ);
1065 static inline void kunmap_skb_frag(void *vaddr)
1067 kunmap_atomic(vaddr, KM_SKB_DATA_SOFTIRQ);
1068 #ifdef CONFIG_HIGHMEM
1069 local_bh_enable();
1070 #endif
1073 #define skb_queue_walk(queue, skb) \
1074 for (skb = (queue)->next, prefetch(skb->next); \
1075 (skb != (struct sk_buff *)(queue)); \
1076 skb = skb->next, prefetch(skb->next))
1079 extern struct sk_buff *skb_recv_datagram(struct sock *sk, unsigned flags,
1080 int noblock, int *err);
1081 extern unsigned int datagram_poll(struct file *file, struct socket *sock,
1082 struct poll_table_struct *wait);
1083 extern int skb_copy_datagram(const struct sk_buff *from,
1084 int offset, char __user *to, int size);
1085 extern int skb_copy_datagram_iovec(const struct sk_buff *from,
1086 int offset, struct iovec *to,
1087 int size);
1088 extern int skb_copy_and_csum_datagram(const struct sk_buff *skb,
1089 int offset, u8 __user *to,
1090 int len, unsigned int *csump);
1091 extern int skb_copy_and_csum_datagram_iovec(const
1092 struct sk_buff *skb,
1093 int hlen,
1094 struct iovec *iov);
1095 extern void skb_free_datagram(struct sock *sk, struct sk_buff *skb);
1096 extern unsigned int skb_checksum(const struct sk_buff *skb, int offset,
1097 int len, unsigned int csum);
1098 extern int skb_copy_bits(const struct sk_buff *skb, int offset,
1099 void *to, int len);
1100 extern unsigned int skb_copy_and_csum_bits(const struct sk_buff *skb,
1101 int offset, u8 *to, int len,
1102 unsigned int csum);
1103 extern void skb_copy_and_csum_dev(const struct sk_buff *skb, u8 *to);
1104 extern void skb_split(struct sk_buff *skb,
1105 struct sk_buff *skb1, const u32 len);
1107 static inline void *skb_header_pointer(const struct sk_buff *skb, int offset,
1108 int len, void *buffer)
1110 int hlen = skb_headlen(skb);
1112 if (offset + len <= hlen)
1113 return skb->data + offset;
1115 if (skb_copy_bits(skb, offset, buffer, len) < 0)
1116 return NULL;
1118 return buffer;
1121 extern void skb_init(void);
1122 extern void skb_add_mtu(int mtu);
1124 struct skb_iter {
1125 /* Iteration functions set these */
1126 unsigned char *data;
1127 unsigned int len;
1129 /* Private to iteration */
1130 unsigned int nextfrag;
1131 struct sk_buff *fraglist;
1134 /* Keep iterating until skb_iter_next returns false. */
1135 extern void skb_iter_first(const struct sk_buff *skb, struct skb_iter *i);
1136 extern int skb_iter_next(const struct sk_buff *skb, struct skb_iter *i);
1137 /* Call this if aborting loop before !skb_iter_next */
1138 extern void skb_iter_abort(const struct sk_buff *skb, struct skb_iter *i);
1140 #ifdef CONFIG_NETFILTER
1141 static inline void nf_conntrack_put(struct nf_conntrack *nfct)
1143 if (nfct && atomic_dec_and_test(&nfct->use))
1144 nfct->destroy(nfct);
1146 static inline void nf_conntrack_get(struct nf_conntrack *nfct)
1148 if (nfct)
1149 atomic_inc(&nfct->use);
1151 static inline void nf_reset(struct sk_buff *skb)
1153 nf_conntrack_put(skb->nfct);
1154 skb->nfct = NULL;
1155 #ifdef CONFIG_NETFILTER_DEBUG
1156 skb->nf_debug = 0;
1157 #endif
1159 static inline void nf_reset_debug(struct sk_buff *skb)
1161 #ifdef CONFIG_NETFILTER_DEBUG
1162 skb->nf_debug = 0;
1163 #endif
1166 #ifdef CONFIG_BRIDGE_NETFILTER
1167 static inline void nf_bridge_put(struct nf_bridge_info *nf_bridge)
1169 if (nf_bridge && atomic_dec_and_test(&nf_bridge->use))
1170 kfree(nf_bridge);
1172 static inline void nf_bridge_get(struct nf_bridge_info *nf_bridge)
1174 if (nf_bridge)
1175 atomic_inc(&nf_bridge->use);
1177 #endif /* CONFIG_BRIDGE_NETFILTER */
1178 #else /* CONFIG_NETFILTER */
1179 static inline void nf_reset(struct sk_buff *skb) {}
1180 #endif /* CONFIG_NETFILTER */
1182 #endif /* __KERNEL__ */
1183 #endif /* _LINUX_SKBUFF_H */