2 * Definitions for the 'struct sk_buff' memory handlers.
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>
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 #include <linux/dmaengine.h>
34 #define HAVE_ALLOC_SKB /* For the drivers to know */
35 #define HAVE_ALIGNABLE_SKB /* Ditto 8) */
37 #define CHECKSUM_NONE 0
39 #define CHECKSUM_UNNECESSARY 2
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))
49 /* A. Checksumming of received packets by device.
51 * NONE: device failed to checksum this packet.
52 * skb->csum is undefined.
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)
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,
66 * B. Checksumming on output.
68 * NONE: skb is checksummed by protocol or csum is not required.
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.
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
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)
84 * Any questions? No questions, good. --ANK
89 #ifdef CONFIG_NETFILTER
92 void (*destroy)(struct nf_conntrack *);
95 #ifdef CONFIG_BRIDGE_NETFILTER
96 struct nf_bridge_info {
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;
104 unsigned long data[32 / sizeof(unsigned long)];
110 struct sk_buff_head {
111 /* These two members must be first. */
112 struct sk_buff *next;
113 struct sk_buff *prev;
121 /* To allow 64K frame to be packed as single skb without frag_list */
122 #define MAX_SKB_FRAGS (65536/PAGE_SIZE + 2)
124 typedef struct skb_frag_struct skb_frag_t;
126 struct skb_frag_struct {
132 /* This data is invariant across clones and lives at
133 * the end of the header data, ie. at skb->end.
135 struct skb_shared_info {
137 unsigned short nr_frags;
138 unsigned short tso_size;
139 unsigned short tso_segs;
140 unsigned short ufo_size;
141 unsigned int ip6_frag_id;
142 struct sk_buff *frag_list;
143 skb_frag_t frags[MAX_SKB_FRAGS];
146 /* We divide dataref into two halves. The higher 16 bits hold references
147 * to the payload part of skb->data. The lower 16 bits hold references to
148 * the entire skb->data. It is up to the users of the skb to agree on
149 * where the payload starts.
151 * All users must obey the rule that the skb->data reference count must be
152 * greater than or equal to the payload reference count.
154 * Holding a reference to the payload part means that the user does not
155 * care about modifications to the header part of skb->data.
157 #define SKB_DATAREF_SHIFT 16
158 #define SKB_DATAREF_MASK ((1 << SKB_DATAREF_SHIFT) - 1)
167 SKB_FCLONE_UNAVAILABLE,
173 * struct sk_buff - socket buffer
174 * @next: Next buffer in list
175 * @prev: Previous buffer in list
176 * @sk: Socket we are owned by
177 * @tstamp: Time we arrived
178 * @dev: Device we arrived on/are leaving by
179 * @input_dev: Device we arrived on
180 * @h: Transport layer header
181 * @nh: Network layer header
182 * @mac: Link layer header
183 * @dst: destination entry
184 * @sp: the security path, used for xfrm
185 * @cb: Control buffer. Free for use by every layer. Put private vars here
186 * @len: Length of actual data
187 * @data_len: Data length
188 * @mac_len: Length of link layer header
190 * @local_df: allow local fragmentation
191 * @cloned: Head may be cloned (check refcnt to be sure)
192 * @nohdr: Payload reference only, must not modify header
193 * @pkt_type: Packet class
194 * @fclone: skbuff clone status
195 * @ip_summed: Driver fed us an IP checksum
196 * @priority: Packet queueing priority
197 * @users: User count - see {datagram,tcp}.c
198 * @protocol: Packet protocol from driver
199 * @truesize: Buffer size
200 * @head: Head of buffer
201 * @data: Data head pointer
202 * @tail: Tail pointer
204 * @destructor: Destruct function
205 * @nfmark: Can be used for communication between hooks
206 * @nfct: Associated connection, if any
207 * @ipvs_property: skbuff is owned by ipvs
208 * @nfctinfo: Relationship of this skb to the connection
209 * @nfct_reasm: netfilter conntrack re-assembly pointer
210 * @nf_bridge: Saved data about a bridged frame - see br_netfilter.c
211 * @tc_index: Traffic control index
212 * @tc_verd: traffic control verdict
213 * @secmark: security marking
217 /* These two members must be first. */
218 struct sk_buff *next;
219 struct sk_buff *prev;
222 struct skb_timeval tstamp;
223 struct net_device *dev;
224 struct net_device *input_dev;
229 struct icmphdr *icmph;
230 struct igmphdr *igmph;
232 struct ipv6hdr *ipv6h;
238 struct ipv6hdr *ipv6h;
247 struct dst_entry *dst;
251 * This is the control buffer. It is free to use for every
252 * layer. Please put your private variables there. If you
253 * want to keep them across layers you have to do a skb_clone()
254 * first. This is owned by whoever has the skb queued ATM.
273 void (*destructor)(struct sk_buff *skb);
274 #ifdef CONFIG_NETFILTER
275 struct nf_conntrack *nfct;
276 #if defined(CONFIG_NF_CONNTRACK) || defined(CONFIG_NF_CONNTRACK_MODULE)
277 struct sk_buff *nfct_reasm;
279 #ifdef CONFIG_BRIDGE_NETFILTER
280 struct nf_bridge_info *nf_bridge;
283 #endif /* CONFIG_NETFILTER */
284 #ifdef CONFIG_NET_SCHED
285 __u16 tc_index; /* traffic control index */
286 #ifdef CONFIG_NET_CLS_ACT
287 __u16 tc_verd; /* traffic control verdict */
290 #ifdef CONFIG_NET_DMA
291 dma_cookie_t dma_cookie;
293 #ifdef CONFIG_NETWORK_SECMARK
298 /* These elements must be at the end, see alloc_skb() for details. */
299 unsigned int truesize;
309 * Handling routines are only of interest to the kernel
311 #include <linux/slab.h>
313 #include <asm/system.h>
315 extern void kfree_skb(struct sk_buff *skb);
316 extern void __kfree_skb(struct sk_buff *skb);
317 extern struct sk_buff *__alloc_skb(unsigned int size,
318 gfp_t priority, int fclone);
319 static inline struct sk_buff *alloc_skb(unsigned int size,
322 return __alloc_skb(size, priority, 0);
325 static inline struct sk_buff *alloc_skb_fclone(unsigned int size,
328 return __alloc_skb(size, priority, 1);
331 extern struct sk_buff *alloc_skb_from_cache(kmem_cache_t *cp,
334 extern void kfree_skbmem(struct sk_buff *skb);
335 extern struct sk_buff *skb_clone(struct sk_buff *skb,
337 extern struct sk_buff *skb_copy(const struct sk_buff *skb,
339 extern struct sk_buff *pskb_copy(struct sk_buff *skb,
341 extern int pskb_expand_head(struct sk_buff *skb,
342 int nhead, int ntail,
344 extern struct sk_buff *skb_realloc_headroom(struct sk_buff *skb,
345 unsigned int headroom);
346 extern struct sk_buff *skb_copy_expand(const struct sk_buff *skb,
347 int newheadroom, int newtailroom,
349 extern struct sk_buff * skb_pad(struct sk_buff *skb, int pad);
350 #define dev_kfree_skb(a) kfree_skb(a)
351 extern void skb_over_panic(struct sk_buff *skb, int len,
353 extern void skb_under_panic(struct sk_buff *skb, int len,
355 extern void skb_truesize_bug(struct sk_buff *skb);
357 static inline void skb_truesize_check(struct sk_buff *skb)
359 if (unlikely((int)skb->truesize < sizeof(struct sk_buff) + skb->len))
360 skb_truesize_bug(skb);
363 extern int skb_append_datato_frags(struct sock *sk, struct sk_buff *skb,
364 int getfrag(void *from, char *to, int offset,
365 int len,int odd, struct sk_buff *skb),
366 void *from, int length);
373 __u32 stepped_offset;
374 struct sk_buff *root_skb;
375 struct sk_buff *cur_skb;
379 extern void skb_prepare_seq_read(struct sk_buff *skb,
380 unsigned int from, unsigned int to,
381 struct skb_seq_state *st);
382 extern unsigned int skb_seq_read(unsigned int consumed, const u8 **data,
383 struct skb_seq_state *st);
384 extern void skb_abort_seq_read(struct skb_seq_state *st);
386 extern unsigned int skb_find_text(struct sk_buff *skb, unsigned int from,
387 unsigned int to, struct ts_config *config,
388 struct ts_state *state);
391 #define skb_shinfo(SKB) ((struct skb_shared_info *)((SKB)->end))
394 * skb_queue_empty - check if a queue is empty
397 * Returns true if the queue is empty, false otherwise.
399 static inline int skb_queue_empty(const struct sk_buff_head *list)
401 return list->next == (struct sk_buff *)list;
405 * skb_get - reference buffer
406 * @skb: buffer to reference
408 * Makes another reference to a socket buffer and returns a pointer
411 static inline struct sk_buff *skb_get(struct sk_buff *skb)
413 atomic_inc(&skb->users);
418 * If users == 1, we are the only owner and are can avoid redundant
423 * skb_cloned - is the buffer a clone
424 * @skb: buffer to check
426 * Returns true if the buffer was generated with skb_clone() and is
427 * one of multiple shared copies of the buffer. Cloned buffers are
428 * shared data so must not be written to under normal circumstances.
430 static inline int skb_cloned(const struct sk_buff *skb)
432 return skb->cloned &&
433 (atomic_read(&skb_shinfo(skb)->dataref) & SKB_DATAREF_MASK) != 1;
437 * skb_header_cloned - is the header a clone
438 * @skb: buffer to check
440 * Returns true if modifying the header part of the buffer requires
441 * the data to be copied.
443 static inline int skb_header_cloned(const struct sk_buff *skb)
450 dataref = atomic_read(&skb_shinfo(skb)->dataref);
451 dataref = (dataref & SKB_DATAREF_MASK) - (dataref >> SKB_DATAREF_SHIFT);
456 * skb_header_release - release reference to header
457 * @skb: buffer to operate on
459 * Drop a reference to the header part of the buffer. This is done
460 * by acquiring a payload reference. You must not read from the header
461 * part of skb->data after this.
463 static inline void skb_header_release(struct sk_buff *skb)
467 atomic_add(1 << SKB_DATAREF_SHIFT, &skb_shinfo(skb)->dataref);
471 * skb_shared - is the buffer shared
472 * @skb: buffer to check
474 * Returns true if more than one person has a reference to this
477 static inline int skb_shared(const struct sk_buff *skb)
479 return atomic_read(&skb->users) != 1;
483 * skb_share_check - check if buffer is shared and if so clone it
484 * @skb: buffer to check
485 * @pri: priority for memory allocation
487 * If the buffer is shared the buffer is cloned and the old copy
488 * drops a reference. A new clone with a single reference is returned.
489 * If the buffer is not shared the original buffer is returned. When
490 * being called from interrupt status or with spinlocks held pri must
493 * NULL is returned on a memory allocation failure.
495 static inline struct sk_buff *skb_share_check(struct sk_buff *skb,
498 might_sleep_if(pri & __GFP_WAIT);
499 if (skb_shared(skb)) {
500 struct sk_buff *nskb = skb_clone(skb, pri);
508 * Copy shared buffers into a new sk_buff. We effectively do COW on
509 * packets to handle cases where we have a local reader and forward
510 * and a couple of other messy ones. The normal one is tcpdumping
511 * a packet thats being forwarded.
515 * skb_unshare - make a copy of a shared buffer
516 * @skb: buffer to check
517 * @pri: priority for memory allocation
519 * If the socket buffer is a clone then this function creates a new
520 * copy of the data, drops a reference count on the old copy and returns
521 * the new copy with the reference count at 1. If the buffer is not a clone
522 * the original buffer is returned. When called with a spinlock held or
523 * from interrupt state @pri must be %GFP_ATOMIC
525 * %NULL is returned on a memory allocation failure.
527 static inline struct sk_buff *skb_unshare(struct sk_buff *skb,
530 might_sleep_if(pri & __GFP_WAIT);
531 if (skb_cloned(skb)) {
532 struct sk_buff *nskb = skb_copy(skb, pri);
533 kfree_skb(skb); /* Free our shared copy */
541 * @list_: list to peek at
543 * Peek an &sk_buff. Unlike most other operations you _MUST_
544 * be careful with this one. A peek leaves the buffer on the
545 * list and someone else may run off with it. You must hold
546 * the appropriate locks or have a private queue to do this.
548 * Returns %NULL for an empty list or a pointer to the head element.
549 * The reference count is not incremented and the reference is therefore
550 * volatile. Use with caution.
552 static inline struct sk_buff *skb_peek(struct sk_buff_head *list_)
554 struct sk_buff *list = ((struct sk_buff *)list_)->next;
555 if (list == (struct sk_buff *)list_)
562 * @list_: list to peek at
564 * Peek an &sk_buff. Unlike most other operations you _MUST_
565 * be careful with this one. A peek leaves the buffer on the
566 * list and someone else may run off with it. You must hold
567 * the appropriate locks or have a private queue to do this.
569 * Returns %NULL for an empty list or a pointer to the tail element.
570 * The reference count is not incremented and the reference is therefore
571 * volatile. Use with caution.
573 static inline struct sk_buff *skb_peek_tail(struct sk_buff_head *list_)
575 struct sk_buff *list = ((struct sk_buff *)list_)->prev;
576 if (list == (struct sk_buff *)list_)
582 * skb_queue_len - get queue length
583 * @list_: list to measure
585 * Return the length of an &sk_buff queue.
587 static inline __u32 skb_queue_len(const struct sk_buff_head *list_)
592 static inline void skb_queue_head_init(struct sk_buff_head *list)
594 spin_lock_init(&list->lock);
595 list->prev = list->next = (struct sk_buff *)list;
600 * Insert an sk_buff at the start of a list.
602 * The "__skb_xxxx()" functions are the non-atomic ones that
603 * can only be called with interrupts disabled.
607 * __skb_queue_after - queue a buffer at the list head
609 * @prev: place after this buffer
610 * @newsk: buffer to queue
612 * Queue a buffer int the middle of a list. This function takes no locks
613 * and you must therefore hold required locks before calling it.
615 * A buffer cannot be placed on two lists at the same time.
617 static inline void __skb_queue_after(struct sk_buff_head *list,
618 struct sk_buff *prev,
619 struct sk_buff *newsk)
621 struct sk_buff *next;
627 next->prev = prev->next = newsk;
631 * __skb_queue_head - queue a buffer at the list head
633 * @newsk: buffer to queue
635 * Queue a buffer at the start of a list. This function takes no locks
636 * and you must therefore hold required locks before calling it.
638 * A buffer cannot be placed on two lists at the same time.
640 extern void skb_queue_head(struct sk_buff_head *list, struct sk_buff *newsk);
641 static inline void __skb_queue_head(struct sk_buff_head *list,
642 struct sk_buff *newsk)
644 __skb_queue_after(list, (struct sk_buff *)list, newsk);
648 * __skb_queue_tail - queue a buffer at the list tail
650 * @newsk: buffer to queue
652 * Queue a buffer at the end of a list. This function takes no locks
653 * and you must therefore hold required locks before calling it.
655 * A buffer cannot be placed on two lists at the same time.
657 extern void skb_queue_tail(struct sk_buff_head *list, struct sk_buff *newsk);
658 static inline void __skb_queue_tail(struct sk_buff_head *list,
659 struct sk_buff *newsk)
661 struct sk_buff *prev, *next;
664 next = (struct sk_buff *)list;
668 next->prev = prev->next = newsk;
673 * __skb_dequeue - remove from the head of the queue
674 * @list: list to dequeue from
676 * Remove the head of the list. This function does not take any locks
677 * so must be used with appropriate locks held only. The head item is
678 * returned or %NULL if the list is empty.
680 extern struct sk_buff *skb_dequeue(struct sk_buff_head *list);
681 static inline struct sk_buff *__skb_dequeue(struct sk_buff_head *list)
683 struct sk_buff *next, *prev, *result;
685 prev = (struct sk_buff *) list;
694 result->next = result->prev = NULL;
701 * Insert a packet on a list.
703 extern void skb_insert(struct sk_buff *old, struct sk_buff *newsk, struct sk_buff_head *list);
704 static inline void __skb_insert(struct sk_buff *newsk,
705 struct sk_buff *prev, struct sk_buff *next,
706 struct sk_buff_head *list)
710 next->prev = prev->next = newsk;
715 * Place a packet after a given packet in a list.
717 extern void skb_append(struct sk_buff *old, struct sk_buff *newsk, struct sk_buff_head *list);
718 static inline void __skb_append(struct sk_buff *old, struct sk_buff *newsk, struct sk_buff_head *list)
720 __skb_insert(newsk, old, old->next, list);
724 * remove sk_buff from list. _Must_ be called atomically, and with
727 extern void skb_unlink(struct sk_buff *skb, struct sk_buff_head *list);
728 static inline void __skb_unlink(struct sk_buff *skb, struct sk_buff_head *list)
730 struct sk_buff *next, *prev;
735 skb->next = skb->prev = NULL;
741 /* XXX: more streamlined implementation */
744 * __skb_dequeue_tail - remove from the tail of the queue
745 * @list: list to dequeue from
747 * Remove the tail of the list. This function does not take any locks
748 * so must be used with appropriate locks held only. The tail item is
749 * returned or %NULL if the list is empty.
751 extern struct sk_buff *skb_dequeue_tail(struct sk_buff_head *list);
752 static inline struct sk_buff *__skb_dequeue_tail(struct sk_buff_head *list)
754 struct sk_buff *skb = skb_peek_tail(list);
756 __skb_unlink(skb, list);
761 static inline int skb_is_nonlinear(const struct sk_buff *skb)
763 return skb->data_len;
766 static inline unsigned int skb_headlen(const struct sk_buff *skb)
768 return skb->len - skb->data_len;
771 static inline int skb_pagelen(const struct sk_buff *skb)
775 for (i = (int)skb_shinfo(skb)->nr_frags - 1; i >= 0; i--)
776 len += skb_shinfo(skb)->frags[i].size;
777 return len + skb_headlen(skb);
780 static inline void skb_fill_page_desc(struct sk_buff *skb, int i,
781 struct page *page, int off, int size)
783 skb_frag_t *frag = &skb_shinfo(skb)->frags[i];
786 frag->page_offset = off;
788 skb_shinfo(skb)->nr_frags = i + 1;
791 #define SKB_PAGE_ASSERT(skb) BUG_ON(skb_shinfo(skb)->nr_frags)
792 #define SKB_FRAG_ASSERT(skb) BUG_ON(skb_shinfo(skb)->frag_list)
793 #define SKB_LINEAR_ASSERT(skb) BUG_ON(skb_is_nonlinear(skb))
796 * Add data to an sk_buff
798 static inline unsigned char *__skb_put(struct sk_buff *skb, unsigned int len)
800 unsigned char *tmp = skb->tail;
801 SKB_LINEAR_ASSERT(skb);
808 * skb_put - add data to a buffer
809 * @skb: buffer to use
810 * @len: amount of data to add
812 * This function extends the used data area of the buffer. If this would
813 * exceed the total buffer size the kernel will panic. A pointer to the
814 * first byte of the extra data is returned.
816 static inline unsigned char *skb_put(struct sk_buff *skb, unsigned int len)
818 unsigned char *tmp = skb->tail;
819 SKB_LINEAR_ASSERT(skb);
822 if (unlikely(skb->tail>skb->end))
823 skb_over_panic(skb, len, current_text_addr());
827 static inline unsigned char *__skb_push(struct sk_buff *skb, unsigned int len)
835 * skb_push - add data to the start of a buffer
836 * @skb: buffer to use
837 * @len: amount of data to add
839 * This function extends the used data area of the buffer at the buffer
840 * start. If this would exceed the total buffer headroom the kernel will
841 * panic. A pointer to the first byte of the extra data is returned.
843 static inline unsigned char *skb_push(struct sk_buff *skb, unsigned int len)
847 if (unlikely(skb->data<skb->head))
848 skb_under_panic(skb, len, current_text_addr());
852 static inline unsigned char *__skb_pull(struct sk_buff *skb, unsigned int len)
855 BUG_ON(skb->len < skb->data_len);
856 return skb->data += len;
860 * skb_pull - remove data from the start of a buffer
861 * @skb: buffer to use
862 * @len: amount of data to remove
864 * This function removes data from the start of a buffer, returning
865 * the memory to the headroom. A pointer to the next data in the buffer
866 * is returned. Once the data has been pulled future pushes will overwrite
869 static inline unsigned char *skb_pull(struct sk_buff *skb, unsigned int len)
871 return unlikely(len > skb->len) ? NULL : __skb_pull(skb, len);
874 extern unsigned char *__pskb_pull_tail(struct sk_buff *skb, int delta);
876 static inline unsigned char *__pskb_pull(struct sk_buff *skb, unsigned int len)
878 if (len > skb_headlen(skb) &&
879 !__pskb_pull_tail(skb, len-skb_headlen(skb)))
882 return skb->data += len;
885 static inline unsigned char *pskb_pull(struct sk_buff *skb, unsigned int len)
887 return unlikely(len > skb->len) ? NULL : __pskb_pull(skb, len);
890 static inline int pskb_may_pull(struct sk_buff *skb, unsigned int len)
892 if (likely(len <= skb_headlen(skb)))
894 if (unlikely(len > skb->len))
896 return __pskb_pull_tail(skb, len-skb_headlen(skb)) != NULL;
900 * skb_headroom - bytes at buffer head
901 * @skb: buffer to check
903 * Return the number of bytes of free space at the head of an &sk_buff.
905 static inline int skb_headroom(const struct sk_buff *skb)
907 return skb->data - skb->head;
911 * skb_tailroom - bytes at buffer end
912 * @skb: buffer to check
914 * Return the number of bytes of free space at the tail of an sk_buff
916 static inline int skb_tailroom(const struct sk_buff *skb)
918 return skb_is_nonlinear(skb) ? 0 : skb->end - skb->tail;
922 * skb_reserve - adjust headroom
923 * @skb: buffer to alter
924 * @len: bytes to move
926 * Increase the headroom of an empty &sk_buff by reducing the tail
927 * room. This is only allowed for an empty buffer.
929 static inline void skb_reserve(struct sk_buff *skb, int len)
936 * CPUs often take a performance hit when accessing unaligned memory
937 * locations. The actual performance hit varies, it can be small if the
938 * hardware handles it or large if we have to take an exception and fix it
941 * Since an ethernet header is 14 bytes network drivers often end up with
942 * the IP header at an unaligned offset. The IP header can be aligned by
943 * shifting the start of the packet by 2 bytes. Drivers should do this
946 * skb_reserve(NET_IP_ALIGN);
948 * The downside to this alignment of the IP header is that the DMA is now
949 * unaligned. On some architectures the cost of an unaligned DMA is high
950 * and this cost outweighs the gains made by aligning the IP header.
952 * Since this trade off varies between architectures, we allow NET_IP_ALIGN
956 #define NET_IP_ALIGN 2
960 * The networking layer reserves some headroom in skb data (via
961 * dev_alloc_skb). This is used to avoid having to reallocate skb data when
962 * the header has to grow. In the default case, if the header has to grow
963 * 16 bytes or less we avoid the reallocation.
965 * Unfortunately this headroom changes the DMA alignment of the resulting
966 * network packet. As for NET_IP_ALIGN, this unaligned DMA is expensive
967 * on some architectures. An architecture can override this value,
968 * perhaps setting it to a cacheline in size (since that will maintain
969 * cacheline alignment of the DMA). It must be a power of 2.
971 * Various parts of the networking layer expect at least 16 bytes of
972 * headroom, you should not reduce this.
975 #define NET_SKB_PAD 16
978 extern int ___pskb_trim(struct sk_buff *skb, unsigned int len);
980 static inline void __skb_trim(struct sk_buff *skb, unsigned int len)
982 if (unlikely(skb->data_len)) {
987 skb->tail = skb->data + len;
991 * skb_trim - remove end from a buffer
992 * @skb: buffer to alter
995 * Cut the length of a buffer down by removing data from the tail. If
996 * the buffer is already under the length specified it is not modified.
997 * The skb must be linear.
999 static inline void skb_trim(struct sk_buff *skb, unsigned int len)
1002 __skb_trim(skb, len);
1006 static inline int __pskb_trim(struct sk_buff *skb, unsigned int len)
1009 return ___pskb_trim(skb, len);
1010 __skb_trim(skb, len);
1014 static inline int pskb_trim(struct sk_buff *skb, unsigned int len)
1016 return (len < skb->len) ? __pskb_trim(skb, len) : 0;
1020 * skb_orphan - orphan a buffer
1021 * @skb: buffer to orphan
1023 * If a buffer currently has an owner then we call the owner's
1024 * destructor function and make the @skb unowned. The buffer continues
1025 * to exist but is no longer charged to its former owner.
1027 static inline void skb_orphan(struct sk_buff *skb)
1029 if (skb->destructor)
1030 skb->destructor(skb);
1031 skb->destructor = NULL;
1036 * __skb_queue_purge - empty a list
1037 * @list: list to empty
1039 * Delete all buffers on an &sk_buff list. Each buffer is removed from
1040 * the list and one reference dropped. This function does not take the
1041 * list lock and the caller must hold the relevant locks to use it.
1043 extern void skb_queue_purge(struct sk_buff_head *list);
1044 static inline void __skb_queue_purge(struct sk_buff_head *list)
1046 struct sk_buff *skb;
1047 while ((skb = __skb_dequeue(list)) != NULL)
1051 #ifndef CONFIG_HAVE_ARCH_DEV_ALLOC_SKB
1053 * __dev_alloc_skb - allocate an skbuff for sending
1054 * @length: length to allocate
1055 * @gfp_mask: get_free_pages mask, passed to alloc_skb
1057 * Allocate a new &sk_buff and assign it a usage count of one. The
1058 * buffer has unspecified headroom built in. Users should allocate
1059 * the headroom they think they need without accounting for the
1060 * built in space. The built in space is used for optimisations.
1062 * %NULL is returned in there is no free memory.
1064 static inline struct sk_buff *__dev_alloc_skb(unsigned int length,
1067 struct sk_buff *skb = alloc_skb(length + NET_SKB_PAD, gfp_mask);
1069 skb_reserve(skb, NET_SKB_PAD);
1073 extern struct sk_buff *__dev_alloc_skb(unsigned int length, int gfp_mask);
1077 * dev_alloc_skb - allocate an skbuff for sending
1078 * @length: length to allocate
1080 * Allocate a new &sk_buff and assign it a usage count of one. The
1081 * buffer has unspecified headroom built in. Users should allocate
1082 * the headroom they think they need without accounting for the
1083 * built in space. The built in space is used for optimisations.
1085 * %NULL is returned in there is no free memory. Although this function
1086 * allocates memory it can be called from an interrupt.
1088 static inline struct sk_buff *dev_alloc_skb(unsigned int length)
1090 return __dev_alloc_skb(length, GFP_ATOMIC);
1094 * skb_cow - copy header of skb when it is required
1095 * @skb: buffer to cow
1096 * @headroom: needed headroom
1098 * If the skb passed lacks sufficient headroom or its data part
1099 * is shared, data is reallocated. If reallocation fails, an error
1100 * is returned and original skb is not changed.
1102 * The result is skb with writable area skb->head...skb->tail
1103 * and at least @headroom of space at head.
1105 static inline int skb_cow(struct sk_buff *skb, unsigned int headroom)
1107 int delta = (headroom > NET_SKB_PAD ? headroom : NET_SKB_PAD) -
1113 if (delta || skb_cloned(skb))
1114 return pskb_expand_head(skb, (delta + (NET_SKB_PAD-1)) &
1115 ~(NET_SKB_PAD-1), 0, GFP_ATOMIC);
1120 * skb_padto - pad an skbuff up to a minimal size
1121 * @skb: buffer to pad
1122 * @len: minimal length
1124 * Pads up a buffer to ensure the trailing bytes exist and are
1125 * blanked. If the buffer already contains sufficient data it
1126 * is untouched. Returns the buffer, which may be a replacement
1127 * for the original, or NULL for out of memory - in which case
1128 * the original buffer is still freed.
1131 static inline struct sk_buff *skb_padto(struct sk_buff *skb, unsigned int len)
1133 unsigned int size = skb->len;
1134 if (likely(size >= len))
1136 return skb_pad(skb, len-size);
1139 static inline int skb_add_data(struct sk_buff *skb,
1140 char __user *from, int copy)
1142 const int off = skb->len;
1144 if (skb->ip_summed == CHECKSUM_NONE) {
1146 unsigned int csum = csum_and_copy_from_user(from,
1150 skb->csum = csum_block_add(skb->csum, csum, off);
1153 } else if (!copy_from_user(skb_put(skb, copy), from, copy))
1156 __skb_trim(skb, off);
1160 static inline int skb_can_coalesce(struct sk_buff *skb, int i,
1161 struct page *page, int off)
1164 struct skb_frag_struct *frag = &skb_shinfo(skb)->frags[i - 1];
1166 return page == frag->page &&
1167 off == frag->page_offset + frag->size;
1172 static inline int __skb_linearize(struct sk_buff *skb)
1174 return __pskb_pull_tail(skb, skb->data_len) ? 0 : -ENOMEM;
1178 * skb_linearize - convert paged skb to linear one
1179 * @skb: buffer to linarize
1181 * If there is no free memory -ENOMEM is returned, otherwise zero
1182 * is returned and the old skb data released.
1184 static inline int skb_linearize(struct sk_buff *skb)
1186 return skb_is_nonlinear(skb) ? __skb_linearize(skb) : 0;
1190 * skb_linearize_cow - make sure skb is linear and writable
1191 * @skb: buffer to process
1193 * If there is no free memory -ENOMEM is returned, otherwise zero
1194 * is returned and the old skb data released.
1196 static inline int skb_linearize_cow(struct sk_buff *skb)
1198 return skb_is_nonlinear(skb) || skb_cloned(skb) ?
1199 __skb_linearize(skb) : 0;
1203 * skb_postpull_rcsum - update checksum for received skb after pull
1204 * @skb: buffer to update
1205 * @start: start of data before pull
1206 * @len: length of data pulled
1208 * After doing a pull on a received packet, you need to call this to
1209 * update the CHECKSUM_HW checksum, or set ip_summed to CHECKSUM_NONE
1210 * so that it can be recomputed from scratch.
1213 static inline void skb_postpull_rcsum(struct sk_buff *skb,
1214 const void *start, unsigned int len)
1216 if (skb->ip_summed == CHECKSUM_HW)
1217 skb->csum = csum_sub(skb->csum, csum_partial(start, len, 0));
1220 unsigned char *skb_pull_rcsum(struct sk_buff *skb, unsigned int len);
1223 * pskb_trim_rcsum - trim received skb and update checksum
1224 * @skb: buffer to trim
1227 * This is exactly the same as pskb_trim except that it ensures the
1228 * checksum of received packets are still valid after the operation.
1231 static inline int pskb_trim_rcsum(struct sk_buff *skb, unsigned int len)
1233 if (likely(len >= skb->len))
1235 if (skb->ip_summed == CHECKSUM_HW)
1236 skb->ip_summed = CHECKSUM_NONE;
1237 return __pskb_trim(skb, len);
1240 static inline void *kmap_skb_frag(const skb_frag_t *frag)
1242 #ifdef CONFIG_HIGHMEM
1247 return kmap_atomic(frag->page, KM_SKB_DATA_SOFTIRQ);
1250 static inline void kunmap_skb_frag(void *vaddr)
1252 kunmap_atomic(vaddr, KM_SKB_DATA_SOFTIRQ);
1253 #ifdef CONFIG_HIGHMEM
1258 #define skb_queue_walk(queue, skb) \
1259 for (skb = (queue)->next; \
1260 prefetch(skb->next), (skb != (struct sk_buff *)(queue)); \
1263 #define skb_queue_reverse_walk(queue, skb) \
1264 for (skb = (queue)->prev; \
1265 prefetch(skb->prev), (skb != (struct sk_buff *)(queue)); \
1269 extern struct sk_buff *skb_recv_datagram(struct sock *sk, unsigned flags,
1270 int noblock, int *err);
1271 extern unsigned int datagram_poll(struct file *file, struct socket *sock,
1272 struct poll_table_struct *wait);
1273 extern int skb_copy_datagram_iovec(const struct sk_buff *from,
1274 int offset, struct iovec *to,
1276 extern int skb_copy_and_csum_datagram_iovec(struct sk_buff *skb,
1279 extern void skb_free_datagram(struct sock *sk, struct sk_buff *skb);
1280 extern void skb_kill_datagram(struct sock *sk, struct sk_buff *skb,
1281 unsigned int flags);
1282 extern unsigned int skb_checksum(const struct sk_buff *skb, int offset,
1283 int len, unsigned int csum);
1284 extern int skb_copy_bits(const struct sk_buff *skb, int offset,
1286 extern int skb_store_bits(const struct sk_buff *skb, int offset,
1287 void *from, int len);
1288 extern unsigned int skb_copy_and_csum_bits(const struct sk_buff *skb,
1289 int offset, u8 *to, int len,
1291 extern void skb_copy_and_csum_dev(const struct sk_buff *skb, u8 *to);
1292 extern void skb_split(struct sk_buff *skb,
1293 struct sk_buff *skb1, const u32 len);
1295 extern void skb_release_data(struct sk_buff *skb);
1297 static inline void *skb_header_pointer(const struct sk_buff *skb, int offset,
1298 int len, void *buffer)
1300 int hlen = skb_headlen(skb);
1302 if (hlen - offset >= len)
1303 return skb->data + offset;
1305 if (skb_copy_bits(skb, offset, buffer, len) < 0)
1311 extern void skb_init(void);
1312 extern void skb_add_mtu(int mtu);
1315 * skb_get_timestamp - get timestamp from a skb
1316 * @skb: skb to get stamp from
1317 * @stamp: pointer to struct timeval to store stamp in
1319 * Timestamps are stored in the skb as offsets to a base timestamp.
1320 * This function converts the offset back to a struct timeval and stores
1323 static inline void skb_get_timestamp(const struct sk_buff *skb, struct timeval *stamp)
1325 stamp->tv_sec = skb->tstamp.off_sec;
1326 stamp->tv_usec = skb->tstamp.off_usec;
1330 * skb_set_timestamp - set timestamp of a skb
1331 * @skb: skb to set stamp of
1332 * @stamp: pointer to struct timeval to get stamp from
1334 * Timestamps are stored in the skb as offsets to a base timestamp.
1335 * This function converts a struct timeval to an offset and stores
1338 static inline void skb_set_timestamp(struct sk_buff *skb, const struct timeval *stamp)
1340 skb->tstamp.off_sec = stamp->tv_sec;
1341 skb->tstamp.off_usec = stamp->tv_usec;
1344 extern void __net_timestamp(struct sk_buff *skb);
1346 extern unsigned int __skb_checksum_complete(struct sk_buff *skb);
1349 * skb_checksum_complete - Calculate checksum of an entire packet
1350 * @skb: packet to process
1352 * This function calculates the checksum over the entire packet plus
1353 * the value of skb->csum. The latter can be used to supply the
1354 * checksum of a pseudo header as used by TCP/UDP. It returns the
1357 * For protocols that contain complete checksums such as ICMP/TCP/UDP,
1358 * this function can be used to verify that checksum on received
1359 * packets. In that case the function should return zero if the
1360 * checksum is correct. In particular, this function will return zero
1361 * if skb->ip_summed is CHECKSUM_UNNECESSARY which indicates that the
1362 * hardware has already verified the correctness of the checksum.
1364 static inline unsigned int skb_checksum_complete(struct sk_buff *skb)
1366 return skb->ip_summed != CHECKSUM_UNNECESSARY &&
1367 __skb_checksum_complete(skb);
1370 #ifdef CONFIG_NETFILTER
1371 static inline void nf_conntrack_put(struct nf_conntrack *nfct)
1373 if (nfct && atomic_dec_and_test(&nfct->use))
1374 nfct->destroy(nfct);
1376 static inline void nf_conntrack_get(struct nf_conntrack *nfct)
1379 atomic_inc(&nfct->use);
1381 #if defined(CONFIG_NF_CONNTRACK) || defined(CONFIG_NF_CONNTRACK_MODULE)
1382 static inline void nf_conntrack_get_reasm(struct sk_buff *skb)
1385 atomic_inc(&skb->users);
1387 static inline void nf_conntrack_put_reasm(struct sk_buff *skb)
1393 #ifdef CONFIG_BRIDGE_NETFILTER
1394 static inline void nf_bridge_put(struct nf_bridge_info *nf_bridge)
1396 if (nf_bridge && atomic_dec_and_test(&nf_bridge->use))
1399 static inline void nf_bridge_get(struct nf_bridge_info *nf_bridge)
1402 atomic_inc(&nf_bridge->use);
1404 #endif /* CONFIG_BRIDGE_NETFILTER */
1405 static inline void nf_reset(struct sk_buff *skb)
1407 nf_conntrack_put(skb->nfct);
1409 #if defined(CONFIG_NF_CONNTRACK) || defined(CONFIG_NF_CONNTRACK_MODULE)
1410 nf_conntrack_put_reasm(skb->nfct_reasm);
1411 skb->nfct_reasm = NULL;
1413 #ifdef CONFIG_BRIDGE_NETFILTER
1414 nf_bridge_put(skb->nf_bridge);
1415 skb->nf_bridge = NULL;
1419 #else /* CONFIG_NETFILTER */
1420 static inline void nf_reset(struct sk_buff *skb) {}
1421 #endif /* CONFIG_NETFILTER */
1423 #ifdef CONFIG_NETWORK_SECMARK
1424 static inline void skb_copy_secmark(struct sk_buff *to, const struct sk_buff *from)
1426 to->secmark = from->secmark;
1429 static inline void skb_init_secmark(struct sk_buff *skb)
1434 static inline void skb_copy_secmark(struct sk_buff *to, const struct sk_buff *from)
1437 static inline void skb_init_secmark(struct sk_buff *skb)
1441 #endif /* __KERNEL__ */
1442 #endif /* _LINUX_SKBUFF_H */