blob: f9441b5f8d13a5d807f7e4eae98c7035706dbe8f [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001/*
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
Linus Torvalds1da177e2005-04-16 15:20:36 -070017#include <linux/kernel.h>
18#include <linux/compiler.h>
19#include <linux/time.h>
20#include <linux/cache.h>
21
22#include <asm/atomic.h>
23#include <asm/types.h>
24#include <linux/spinlock.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070025#include <linux/net.h>
Thomas Graf3fc7e8a2005-06-23 21:00:17 -070026#include <linux/textsearch.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070027#include <net/checksum.h>
Al Viroa80958f2006-12-04 20:41:19 +000028#include <linux/rcupdate.h>
Chris Leech97fc2f02006-05-23 17:55:33 -070029#include <linux/dmaengine.h>
Eric Dumazetb7aa0bf2007-04-19 16:16:32 -070030#include <linux/hrtimer.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070031
32#define HAVE_ALLOC_SKB /* For the drivers to know */
33#define HAVE_ALIGNABLE_SKB /* Ditto 8) */
Linus Torvalds1da177e2005-04-16 15:20:36 -070034
35#define CHECKSUM_NONE 0
Patrick McHardy84fa7932006-08-29 16:44:56 -070036#define CHECKSUM_PARTIAL 1
Linus Torvalds1da177e2005-04-16 15:20:36 -070037#define CHECKSUM_UNNECESSARY 2
Patrick McHardy84fa7932006-08-29 16:44:56 -070038#define CHECKSUM_COMPLETE 3
Linus Torvalds1da177e2005-04-16 15:20:36 -070039
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))
47
48/* A. Checksumming of received packets by device.
49 *
50 * NONE: device failed to checksum this packet.
51 * skb->csum is undefined.
52 *
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)
58 *
Patrick McHardy84fa7932006-08-29 16:44:56 -070059 * COMPLETE: the most generic way. Device supplied checksum of _all_
Linus Torvalds1da177e2005-04-16 15:20:36 -070060 * the packet as seen by netif_rx in skb->csum.
61 * NOTE: Even if device supports only some protocols, but
Patrick McHardy84fa7932006-08-29 16:44:56 -070062 * is able to produce some skb->csum, it MUST use COMPLETE,
Linus Torvalds1da177e2005-04-16 15:20:36 -070063 * not UNNECESSARY.
64 *
65 * B. Checksumming on output.
66 *
67 * NONE: skb is checksummed by protocol or csum is not required.
68 *
Patrick McHardy84fa7932006-08-29 16:44:56 -070069 * PARTIAL: device is required to csum packet as seen by hard_start_xmit
Linus Torvalds1da177e2005-04-16 15:20:36 -070070 * from skb->h.raw to the end and to record the checksum
71 * at skb->h.raw+skb->csum.
72 *
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)
82 *
83 * Any questions? No questions, good. --ANK
84 */
85
Linus Torvalds1da177e2005-04-16 15:20:36 -070086struct net_device;
87
88#ifdef CONFIG_NETFILTER
89struct nf_conntrack {
90 atomic_t use;
91 void (*destroy)(struct nf_conntrack *);
92};
93
94#ifdef CONFIG_BRIDGE_NETFILTER
95struct nf_bridge_info {
96 atomic_t use;
97 struct net_device *physindev;
98 struct net_device *physoutdev;
99#if defined(CONFIG_VLAN_8021Q) || defined(CONFIG_VLAN_8021Q_MODULE)
100 struct net_device *netoutdev;
101#endif
102 unsigned int mask;
103 unsigned long data[32 / sizeof(unsigned long)];
104};
105#endif
106
107#endif
108
109struct sk_buff_head {
110 /* These two members must be first. */
111 struct sk_buff *next;
112 struct sk_buff *prev;
113
114 __u32 qlen;
115 spinlock_t lock;
116};
117
118struct sk_buff;
119
120/* To allow 64K frame to be packed as single skb without frag_list */
121#define MAX_SKB_FRAGS (65536/PAGE_SIZE + 2)
122
123typedef struct skb_frag_struct skb_frag_t;
124
125struct skb_frag_struct {
126 struct page *page;
127 __u16 page_offset;
128 __u16 size;
129};
130
131/* This data is invariant across clones and lives at
132 * the end of the header data, ie. at skb->end.
133 */
134struct skb_shared_info {
135 atomic_t dataref;
Benjamin LaHaise4947d3e2006-01-03 14:06:50 -0800136 unsigned short nr_frags;
Herbert Xu79671682006-06-22 02:40:14 -0700137 unsigned short gso_size;
138 /* Warning: this field is not always filled in (UFO)! */
139 unsigned short gso_segs;
140 unsigned short gso_type;
Al Viroae08e1f2006-11-08 00:27:11 -0800141 __be32 ip6_frag_id;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700142 struct sk_buff *frag_list;
143 skb_frag_t frags[MAX_SKB_FRAGS];
144};
145
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.
150 *
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.
153 *
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.
156 */
157#define SKB_DATAREF_SHIFT 16
158#define SKB_DATAREF_MASK ((1 << SKB_DATAREF_SHIFT) - 1)
159
David S. Millerd179cd12005-08-17 14:57:30 -0700160
161enum {
162 SKB_FCLONE_UNAVAILABLE,
163 SKB_FCLONE_ORIG,
164 SKB_FCLONE_CLONE,
165};
166
Herbert Xu79671682006-06-22 02:40:14 -0700167enum {
168 SKB_GSO_TCPV4 = 1 << 0,
Herbert Xuf83ef8c2006-06-30 13:37:03 -0700169 SKB_GSO_UDP = 1 << 1,
Herbert Xu576a30e2006-06-27 13:22:38 -0700170
171 /* This indicates the skb is from an untrusted source. */
172 SKB_GSO_DODGY = 1 << 2,
Michael Chanb0da85372006-06-29 12:30:00 -0700173
174 /* This indicates the tcp segment has CWR set. */
Herbert Xuf83ef8c2006-06-30 13:37:03 -0700175 SKB_GSO_TCP_ECN = 1 << 3,
176
177 SKB_GSO_TCPV6 = 1 << 4,
Herbert Xu79671682006-06-22 02:40:14 -0700178};
179
Linus Torvalds1da177e2005-04-16 15:20:36 -0700180/**
181 * struct sk_buff - socket buffer
182 * @next: Next buffer in list
183 * @prev: Previous buffer in list
Linus Torvalds1da177e2005-04-16 15:20:36 -0700184 * @sk: Socket we are owned by
Herbert Xu325ed822005-10-03 13:57:23 -0700185 * @tstamp: Time we arrived
Linus Torvalds1da177e2005-04-16 15:20:36 -0700186 * @dev: Device we arrived on/are leaving by
Patrick McHardyc01003c2007-03-29 11:46:52 -0700187 * @iif: ifindex of device we arrived on
Linus Torvalds1da177e2005-04-16 15:20:36 -0700188 * @h: Transport layer header
189 * @nh: Network layer header
190 * @mac: Link layer header
Martin Waitz67be2dd2005-05-01 08:59:26 -0700191 * @dst: destination entry
192 * @sp: the security path, used for xfrm
Linus Torvalds1da177e2005-04-16 15:20:36 -0700193 * @cb: Control buffer. Free for use by every layer. Put private vars here
194 * @len: Length of actual data
195 * @data_len: Data length
196 * @mac_len: Length of link layer header
197 * @csum: Checksum
Martin Waitz67be2dd2005-05-01 08:59:26 -0700198 * @local_df: allow local fragmentation
Linus Torvalds1da177e2005-04-16 15:20:36 -0700199 * @cloned: Head may be cloned (check refcnt to be sure)
200 * @nohdr: Payload reference only, must not modify header
201 * @pkt_type: Packet class
Randy Dunlapc83c2482005-10-18 22:07:41 -0700202 * @fclone: skbuff clone status
Linus Torvalds1da177e2005-04-16 15:20:36 -0700203 * @ip_summed: Driver fed us an IP checksum
204 * @priority: Packet queueing priority
205 * @users: User count - see {datagram,tcp}.c
206 * @protocol: Packet protocol from driver
Linus Torvalds1da177e2005-04-16 15:20:36 -0700207 * @truesize: Buffer size
208 * @head: Head of buffer
209 * @data: Data head pointer
210 * @tail: Tail pointer
211 * @end: End pointer
212 * @destructor: Destruct function
Thomas Graf82e91ff2006-11-09 15:19:14 -0800213 * @mark: Generic packet mark
Linus Torvalds1da177e2005-04-16 15:20:36 -0700214 * @nfct: Associated connection, if any
Randy Dunlapc83c2482005-10-18 22:07:41 -0700215 * @ipvs_property: skbuff is owned by ipvs
Linus Torvalds1da177e2005-04-16 15:20:36 -0700216 * @nfctinfo: Relationship of this skb to the connection
Randy Dunlap461ddf32005-11-20 21:25:15 -0800217 * @nfct_reasm: netfilter conntrack re-assembly pointer
Linus Torvalds1da177e2005-04-16 15:20:36 -0700218 * @nf_bridge: Saved data about a bridged frame - see br_netfilter.c
Linus Torvalds1da177e2005-04-16 15:20:36 -0700219 * @tc_index: Traffic control index
220 * @tc_verd: traffic control verdict
Randy Dunlapf4b8ea72006-06-22 16:00:11 -0700221 * @dma_cookie: a cookie to one of several possible DMA operations
222 * done by skb DMA functions
James Morris984bc162006-06-09 00:29:17 -0700223 * @secmark: security marking
Linus Torvalds1da177e2005-04-16 15:20:36 -0700224 */
225
226struct sk_buff {
227 /* These two members must be first. */
228 struct sk_buff *next;
229 struct sk_buff *prev;
230
Linus Torvalds1da177e2005-04-16 15:20:36 -0700231 struct sock *sk;
Eric Dumazetb7aa0bf2007-04-19 16:16:32 -0700232 ktime_t tstamp;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700233 struct net_device *dev;
Patrick McHardyc01003c2007-03-29 11:46:52 -0700234 int iif;
235 /* 4 byte hole on 64 bit*/
Linus Torvalds1da177e2005-04-16 15:20:36 -0700236
237 union {
238 struct tcphdr *th;
239 struct udphdr *uh;
240 struct icmphdr *icmph;
241 struct igmphdr *igmph;
242 struct iphdr *ipiph;
243 struct ipv6hdr *ipv6h;
244 unsigned char *raw;
245 } h;
246
247 union {
248 struct iphdr *iph;
249 struct ipv6hdr *ipv6h;
250 struct arphdr *arph;
251 unsigned char *raw;
252 } nh;
253
254 union {
255 unsigned char *raw;
256 } mac;
257
258 struct dst_entry *dst;
259 struct sec_path *sp;
260
261 /*
262 * This is the control buffer. It is free to use for every
263 * layer. Please put your private variables there. If you
264 * want to keep them across layers you have to do a skb_clone()
265 * first. This is owned by whoever has the skb queued ATM.
266 */
Patrick McHardy3e3850e2006-01-06 23:04:54 -0800267 char cb[48];
Linus Torvalds1da177e2005-04-16 15:20:36 -0700268
269 unsigned int len,
270 data_len,
Al Viro1f61ab52006-11-14 21:44:08 -0800271 mac_len;
Al Viroff1dcad2006-11-20 18:07:29 -0800272 union {
273 __wsum csum;
274 __u32 csum_offset;
275 };
Linus Torvalds1da177e2005-04-16 15:20:36 -0700276 __u32 priority;
Thomas Graf1cbb3382005-07-05 14:13:41 -0700277 __u8 local_df:1,
278 cloned:1,
279 ip_summed:2,
Harald Welte6869c4d2005-08-09 19:24:19 -0700280 nohdr:1,
281 nfctinfo:3;
David S. Millerd179cd12005-08-17 14:57:30 -0700282 __u8 pkt_type:3,
Patrick McHardyb84f4cc2005-11-20 21:19:21 -0800283 fclone:2,
284 ipvs_property:1;
Alexey Dobriyana0d3bea2005-08-11 16:05:50 -0700285 __be16 protocol;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700286
287 void (*destructor)(struct sk_buff *skb);
288#ifdef CONFIG_NETFILTER
Linus Torvalds1da177e2005-04-16 15:20:36 -0700289 struct nf_conntrack *nfct;
Yasuyuki Kozakai9fb9cbb2005-11-09 16:38:16 -0800290#if defined(CONFIG_NF_CONNTRACK) || defined(CONFIG_NF_CONNTRACK_MODULE)
291 struct sk_buff *nfct_reasm;
292#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -0700293#ifdef CONFIG_BRIDGE_NETFILTER
294 struct nf_bridge_info *nf_bridge;
295#endif
296#endif /* CONFIG_NETFILTER */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700297#ifdef CONFIG_NET_SCHED
Patrick McHardyb6b99eb2005-08-09 19:33:51 -0700298 __u16 tc_index; /* traffic control index */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700299#ifdef CONFIG_NET_CLS_ACT
Patrick McHardyb6b99eb2005-08-09 19:33:51 -0700300 __u16 tc_verd; /* traffic control verdict */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700301#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -0700302#endif
Chris Leech97fc2f02006-05-23 17:55:33 -0700303#ifdef CONFIG_NET_DMA
304 dma_cookie_t dma_cookie;
305#endif
James Morris984bc162006-06-09 00:29:17 -0700306#ifdef CONFIG_NETWORK_SECMARK
307 __u32 secmark;
308#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -0700309
Thomas Graf82e91ff2006-11-09 15:19:14 -0800310 __u32 mark;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700311
312 /* These elements must be at the end, see alloc_skb() for details. */
313 unsigned int truesize;
314 atomic_t users;
315 unsigned char *head,
316 *data,
317 *tail,
318 *end;
319};
320
321#ifdef __KERNEL__
322/*
323 * Handling routines are only of interest to the kernel
324 */
325#include <linux/slab.h>
326
327#include <asm/system.h>
328
Jörn Engel231d06a2006-03-20 21:28:35 -0800329extern void kfree_skb(struct sk_buff *skb);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700330extern void __kfree_skb(struct sk_buff *skb);
David S. Millerd179cd12005-08-17 14:57:30 -0700331extern struct sk_buff *__alloc_skb(unsigned int size,
Christoph Hellwigb30973f2006-12-06 20:32:36 -0800332 gfp_t priority, int fclone, int node);
David S. Millerd179cd12005-08-17 14:57:30 -0700333static inline struct sk_buff *alloc_skb(unsigned int size,
Al Virodd0fc662005-10-07 07:46:04 +0100334 gfp_t priority)
David S. Millerd179cd12005-08-17 14:57:30 -0700335{
Christoph Hellwigb30973f2006-12-06 20:32:36 -0800336 return __alloc_skb(size, priority, 0, -1);
David S. Millerd179cd12005-08-17 14:57:30 -0700337}
338
339static inline struct sk_buff *alloc_skb_fclone(unsigned int size,
Al Virodd0fc662005-10-07 07:46:04 +0100340 gfp_t priority)
David S. Millerd179cd12005-08-17 14:57:30 -0700341{
Christoph Hellwigb30973f2006-12-06 20:32:36 -0800342 return __alloc_skb(size, priority, 1, -1);
David S. Millerd179cd12005-08-17 14:57:30 -0700343}
344
Linus Torvalds1da177e2005-04-16 15:20:36 -0700345extern void kfree_skbmem(struct sk_buff *skb);
Victor Fusco86a76ca2005-07-08 14:57:47 -0700346extern struct sk_buff *skb_clone(struct sk_buff *skb,
Al Virodd0fc662005-10-07 07:46:04 +0100347 gfp_t priority);
Victor Fusco86a76ca2005-07-08 14:57:47 -0700348extern struct sk_buff *skb_copy(const struct sk_buff *skb,
Al Virodd0fc662005-10-07 07:46:04 +0100349 gfp_t priority);
Victor Fusco86a76ca2005-07-08 14:57:47 -0700350extern struct sk_buff *pskb_copy(struct sk_buff *skb,
Al Virodd0fc662005-10-07 07:46:04 +0100351 gfp_t gfp_mask);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700352extern int pskb_expand_head(struct sk_buff *skb,
Victor Fusco86a76ca2005-07-08 14:57:47 -0700353 int nhead, int ntail,
Al Virodd0fc662005-10-07 07:46:04 +0100354 gfp_t gfp_mask);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700355extern struct sk_buff *skb_realloc_headroom(struct sk_buff *skb,
356 unsigned int headroom);
357extern struct sk_buff *skb_copy_expand(const struct sk_buff *skb,
358 int newheadroom, int newtailroom,
Al Virodd0fc662005-10-07 07:46:04 +0100359 gfp_t priority);
Herbert Xu5b057c62006-06-23 02:06:41 -0700360extern int skb_pad(struct sk_buff *skb, int pad);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700361#define dev_kfree_skb(a) kfree_skb(a)
362extern void skb_over_panic(struct sk_buff *skb, int len,
363 void *here);
364extern void skb_under_panic(struct sk_buff *skb, int len,
365 void *here);
David S. Millerdc6de332006-04-20 00:10:50 -0700366extern void skb_truesize_bug(struct sk_buff *skb);
367
368static inline void skb_truesize_check(struct sk_buff *skb)
369{
370 if (unlikely((int)skb->truesize < sizeof(struct sk_buff) + skb->len))
371 skb_truesize_bug(skb);
372}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700373
Ananda Rajue89e9cf2005-10-18 15:46:41 -0700374extern int skb_append_datato_frags(struct sock *sk, struct sk_buff *skb,
375 int getfrag(void *from, char *to, int offset,
376 int len,int odd, struct sk_buff *skb),
377 void *from, int length);
378
Thomas Graf677e90e2005-06-23 20:59:51 -0700379struct skb_seq_state
380{
381 __u32 lower_offset;
382 __u32 upper_offset;
383 __u32 frag_idx;
384 __u32 stepped_offset;
385 struct sk_buff *root_skb;
386 struct sk_buff *cur_skb;
387 __u8 *frag_data;
388};
389
390extern void skb_prepare_seq_read(struct sk_buff *skb,
391 unsigned int from, unsigned int to,
392 struct skb_seq_state *st);
393extern unsigned int skb_seq_read(unsigned int consumed, const u8 **data,
394 struct skb_seq_state *st);
395extern void skb_abort_seq_read(struct skb_seq_state *st);
396
Thomas Graf3fc7e8a2005-06-23 21:00:17 -0700397extern unsigned int skb_find_text(struct sk_buff *skb, unsigned int from,
398 unsigned int to, struct ts_config *config,
399 struct ts_state *state);
400
Linus Torvalds1da177e2005-04-16 15:20:36 -0700401/* Internal */
402#define skb_shinfo(SKB) ((struct skb_shared_info *)((SKB)->end))
403
404/**
405 * skb_queue_empty - check if a queue is empty
406 * @list: queue head
407 *
408 * Returns true if the queue is empty, false otherwise.
409 */
410static inline int skb_queue_empty(const struct sk_buff_head *list)
411{
412 return list->next == (struct sk_buff *)list;
413}
414
415/**
416 * skb_get - reference buffer
417 * @skb: buffer to reference
418 *
419 * Makes another reference to a socket buffer and returns a pointer
420 * to the buffer.
421 */
422static inline struct sk_buff *skb_get(struct sk_buff *skb)
423{
424 atomic_inc(&skb->users);
425 return skb;
426}
427
428/*
429 * If users == 1, we are the only owner and are can avoid redundant
430 * atomic change.
431 */
432
433/**
Linus Torvalds1da177e2005-04-16 15:20:36 -0700434 * skb_cloned - is the buffer a clone
435 * @skb: buffer to check
436 *
437 * Returns true if the buffer was generated with skb_clone() and is
438 * one of multiple shared copies of the buffer. Cloned buffers are
439 * shared data so must not be written to under normal circumstances.
440 */
441static inline int skb_cloned(const struct sk_buff *skb)
442{
443 return skb->cloned &&
444 (atomic_read(&skb_shinfo(skb)->dataref) & SKB_DATAREF_MASK) != 1;
445}
446
447/**
448 * skb_header_cloned - is the header a clone
449 * @skb: buffer to check
450 *
451 * Returns true if modifying the header part of the buffer requires
452 * the data to be copied.
453 */
454static inline int skb_header_cloned(const struct sk_buff *skb)
455{
456 int dataref;
457
458 if (!skb->cloned)
459 return 0;
460
461 dataref = atomic_read(&skb_shinfo(skb)->dataref);
462 dataref = (dataref & SKB_DATAREF_MASK) - (dataref >> SKB_DATAREF_SHIFT);
463 return dataref != 1;
464}
465
466/**
467 * skb_header_release - release reference to header
468 * @skb: buffer to operate on
469 *
470 * Drop a reference to the header part of the buffer. This is done
471 * by acquiring a payload reference. You must not read from the header
472 * part of skb->data after this.
473 */
474static inline void skb_header_release(struct sk_buff *skb)
475{
476 BUG_ON(skb->nohdr);
477 skb->nohdr = 1;
478 atomic_add(1 << SKB_DATAREF_SHIFT, &skb_shinfo(skb)->dataref);
479}
480
481/**
482 * skb_shared - is the buffer shared
483 * @skb: buffer to check
484 *
485 * Returns true if more than one person has a reference to this
486 * buffer.
487 */
488static inline int skb_shared(const struct sk_buff *skb)
489{
490 return atomic_read(&skb->users) != 1;
491}
492
493/**
494 * skb_share_check - check if buffer is shared and if so clone it
495 * @skb: buffer to check
496 * @pri: priority for memory allocation
497 *
498 * If the buffer is shared the buffer is cloned and the old copy
499 * drops a reference. A new clone with a single reference is returned.
500 * If the buffer is not shared the original buffer is returned. When
501 * being called from interrupt status or with spinlocks held pri must
502 * be GFP_ATOMIC.
503 *
504 * NULL is returned on a memory allocation failure.
505 */
Victor Fusco86a76ca2005-07-08 14:57:47 -0700506static inline struct sk_buff *skb_share_check(struct sk_buff *skb,
Al Virodd0fc662005-10-07 07:46:04 +0100507 gfp_t pri)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700508{
509 might_sleep_if(pri & __GFP_WAIT);
510 if (skb_shared(skb)) {
511 struct sk_buff *nskb = skb_clone(skb, pri);
512 kfree_skb(skb);
513 skb = nskb;
514 }
515 return skb;
516}
517
518/*
519 * Copy shared buffers into a new sk_buff. We effectively do COW on
520 * packets to handle cases where we have a local reader and forward
521 * and a couple of other messy ones. The normal one is tcpdumping
522 * a packet thats being forwarded.
523 */
524
525/**
526 * skb_unshare - make a copy of a shared buffer
527 * @skb: buffer to check
528 * @pri: priority for memory allocation
529 *
530 * If the socket buffer is a clone then this function creates a new
531 * copy of the data, drops a reference count on the old copy and returns
532 * the new copy with the reference count at 1. If the buffer is not a clone
533 * the original buffer is returned. When called with a spinlock held or
534 * from interrupt state @pri must be %GFP_ATOMIC
535 *
536 * %NULL is returned on a memory allocation failure.
537 */
Victor Fuscoe2bf5212005-07-18 13:36:38 -0700538static inline struct sk_buff *skb_unshare(struct sk_buff *skb,
Al Virodd0fc662005-10-07 07:46:04 +0100539 gfp_t pri)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700540{
541 might_sleep_if(pri & __GFP_WAIT);
542 if (skb_cloned(skb)) {
543 struct sk_buff *nskb = skb_copy(skb, pri);
544 kfree_skb(skb); /* Free our shared copy */
545 skb = nskb;
546 }
547 return skb;
548}
549
550/**
551 * skb_peek
552 * @list_: list to peek at
553 *
554 * Peek an &sk_buff. Unlike most other operations you _MUST_
555 * be careful with this one. A peek leaves the buffer on the
556 * list and someone else may run off with it. You must hold
557 * the appropriate locks or have a private queue to do this.
558 *
559 * Returns %NULL for an empty list or a pointer to the head element.
560 * The reference count is not incremented and the reference is therefore
561 * volatile. Use with caution.
562 */
563static inline struct sk_buff *skb_peek(struct sk_buff_head *list_)
564{
565 struct sk_buff *list = ((struct sk_buff *)list_)->next;
566 if (list == (struct sk_buff *)list_)
567 list = NULL;
568 return list;
569}
570
571/**
572 * skb_peek_tail
573 * @list_: list to peek at
574 *
575 * Peek an &sk_buff. Unlike most other operations you _MUST_
576 * be careful with this one. A peek leaves the buffer on the
577 * list and someone else may run off with it. You must hold
578 * the appropriate locks or have a private queue to do this.
579 *
580 * Returns %NULL for an empty list or a pointer to the tail element.
581 * The reference count is not incremented and the reference is therefore
582 * volatile. Use with caution.
583 */
584static inline struct sk_buff *skb_peek_tail(struct sk_buff_head *list_)
585{
586 struct sk_buff *list = ((struct sk_buff *)list_)->prev;
587 if (list == (struct sk_buff *)list_)
588 list = NULL;
589 return list;
590}
591
592/**
593 * skb_queue_len - get queue length
594 * @list_: list to measure
595 *
596 * Return the length of an &sk_buff queue.
597 */
598static inline __u32 skb_queue_len(const struct sk_buff_head *list_)
599{
600 return list_->qlen;
601}
602
Arjan van de Ven76f10ad2006-08-02 14:06:55 -0700603/*
604 * This function creates a split out lock class for each invocation;
605 * this is needed for now since a whole lot of users of the skb-queue
606 * infrastructure in drivers have different locking usage (in hardirq)
607 * than the networking core (in softirq only). In the long run either the
608 * network layer or drivers should need annotation to consolidate the
609 * main types of usage into 3 classes.
610 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700611static inline void skb_queue_head_init(struct sk_buff_head *list)
612{
613 spin_lock_init(&list->lock);
614 list->prev = list->next = (struct sk_buff *)list;
615 list->qlen = 0;
616}
617
Pavel Emelianovc2ecba72007-04-17 12:45:31 -0700618static inline void skb_queue_head_init_class(struct sk_buff_head *list,
619 struct lock_class_key *class)
620{
621 skb_queue_head_init(list);
622 lockdep_set_class(&list->lock, class);
623}
624
Linus Torvalds1da177e2005-04-16 15:20:36 -0700625/*
626 * Insert an sk_buff at the start of a list.
627 *
628 * The "__skb_xxxx()" functions are the non-atomic ones that
629 * can only be called with interrupts disabled.
630 */
631
632/**
Stephen Hemminger300ce172005-10-30 13:47:34 -0800633 * __skb_queue_after - queue a buffer at the list head
634 * @list: list to use
635 * @prev: place after this buffer
636 * @newsk: buffer to queue
637 *
638 * Queue a buffer int the middle of a list. This function takes no locks
639 * and you must therefore hold required locks before calling it.
640 *
641 * A buffer cannot be placed on two lists at the same time.
642 */
643static inline void __skb_queue_after(struct sk_buff_head *list,
644 struct sk_buff *prev,
645 struct sk_buff *newsk)
646{
647 struct sk_buff *next;
648 list->qlen++;
649
650 next = prev->next;
651 newsk->next = next;
652 newsk->prev = prev;
653 next->prev = prev->next = newsk;
654}
655
656/**
Linus Torvalds1da177e2005-04-16 15:20:36 -0700657 * __skb_queue_head - queue a buffer at the list head
658 * @list: list to use
659 * @newsk: buffer to queue
660 *
661 * Queue a buffer at the start of a list. This function takes no locks
662 * and you must therefore hold required locks before calling it.
663 *
664 * A buffer cannot be placed on two lists at the same time.
665 */
666extern void skb_queue_head(struct sk_buff_head *list, struct sk_buff *newsk);
667static inline void __skb_queue_head(struct sk_buff_head *list,
668 struct sk_buff *newsk)
669{
Stephen Hemminger300ce172005-10-30 13:47:34 -0800670 __skb_queue_after(list, (struct sk_buff *)list, newsk);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700671}
672
673/**
674 * __skb_queue_tail - queue a buffer at the list tail
675 * @list: list to use
676 * @newsk: buffer to queue
677 *
678 * Queue a buffer at the end of a list. This function takes no locks
679 * and you must therefore hold required locks before calling it.
680 *
681 * A buffer cannot be placed on two lists at the same time.
682 */
683extern void skb_queue_tail(struct sk_buff_head *list, struct sk_buff *newsk);
684static inline void __skb_queue_tail(struct sk_buff_head *list,
685 struct sk_buff *newsk)
686{
687 struct sk_buff *prev, *next;
688
Linus Torvalds1da177e2005-04-16 15:20:36 -0700689 list->qlen++;
690 next = (struct sk_buff *)list;
691 prev = next->prev;
692 newsk->next = next;
693 newsk->prev = prev;
694 next->prev = prev->next = newsk;
695}
696
697
698/**
699 * __skb_dequeue - remove from the head of the queue
700 * @list: list to dequeue from
701 *
702 * Remove the head of the list. This function does not take any locks
703 * so must be used with appropriate locks held only. The head item is
704 * returned or %NULL if the list is empty.
705 */
706extern struct sk_buff *skb_dequeue(struct sk_buff_head *list);
707static inline struct sk_buff *__skb_dequeue(struct sk_buff_head *list)
708{
709 struct sk_buff *next, *prev, *result;
710
711 prev = (struct sk_buff *) list;
712 next = prev->next;
713 result = NULL;
714 if (next != prev) {
715 result = next;
716 next = next->next;
717 list->qlen--;
718 next->prev = prev;
719 prev->next = next;
720 result->next = result->prev = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700721 }
722 return result;
723}
724
725
726/*
727 * Insert a packet on a list.
728 */
David S. Miller8728b832005-08-09 19:25:21 -0700729extern void skb_insert(struct sk_buff *old, struct sk_buff *newsk, struct sk_buff_head *list);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700730static inline void __skb_insert(struct sk_buff *newsk,
731 struct sk_buff *prev, struct sk_buff *next,
732 struct sk_buff_head *list)
733{
734 newsk->next = next;
735 newsk->prev = prev;
736 next->prev = prev->next = newsk;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700737 list->qlen++;
738}
739
740/*
741 * Place a packet after a given packet in a list.
742 */
David S. Miller8728b832005-08-09 19:25:21 -0700743extern void skb_append(struct sk_buff *old, struct sk_buff *newsk, struct sk_buff_head *list);
744static inline void __skb_append(struct sk_buff *old, struct sk_buff *newsk, struct sk_buff_head *list)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700745{
David S. Miller8728b832005-08-09 19:25:21 -0700746 __skb_insert(newsk, old, old->next, list);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700747}
748
749/*
750 * remove sk_buff from list. _Must_ be called atomically, and with
751 * the list known..
752 */
David S. Miller8728b832005-08-09 19:25:21 -0700753extern void skb_unlink(struct sk_buff *skb, struct sk_buff_head *list);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700754static inline void __skb_unlink(struct sk_buff *skb, struct sk_buff_head *list)
755{
756 struct sk_buff *next, *prev;
757
758 list->qlen--;
759 next = skb->next;
760 prev = skb->prev;
761 skb->next = skb->prev = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700762 next->prev = prev;
763 prev->next = next;
764}
765
766
767/* XXX: more streamlined implementation */
768
769/**
770 * __skb_dequeue_tail - remove from the tail of the queue
771 * @list: list to dequeue from
772 *
773 * Remove the tail of the list. This function does not take any locks
774 * so must be used with appropriate locks held only. The tail item is
775 * returned or %NULL if the list is empty.
776 */
777extern struct sk_buff *skb_dequeue_tail(struct sk_buff_head *list);
778static inline struct sk_buff *__skb_dequeue_tail(struct sk_buff_head *list)
779{
780 struct sk_buff *skb = skb_peek_tail(list);
781 if (skb)
782 __skb_unlink(skb, list);
783 return skb;
784}
785
786
787static inline int skb_is_nonlinear(const struct sk_buff *skb)
788{
789 return skb->data_len;
790}
791
792static inline unsigned int skb_headlen(const struct sk_buff *skb)
793{
794 return skb->len - skb->data_len;
795}
796
797static inline int skb_pagelen(const struct sk_buff *skb)
798{
799 int i, len = 0;
800
801 for (i = (int)skb_shinfo(skb)->nr_frags - 1; i >= 0; i--)
802 len += skb_shinfo(skb)->frags[i].size;
803 return len + skb_headlen(skb);
804}
805
806static inline void skb_fill_page_desc(struct sk_buff *skb, int i,
807 struct page *page, int off, int size)
808{
809 skb_frag_t *frag = &skb_shinfo(skb)->frags[i];
810
811 frag->page = page;
812 frag->page_offset = off;
813 frag->size = size;
814 skb_shinfo(skb)->nr_frags = i + 1;
815}
816
817#define SKB_PAGE_ASSERT(skb) BUG_ON(skb_shinfo(skb)->nr_frags)
818#define SKB_FRAG_ASSERT(skb) BUG_ON(skb_shinfo(skb)->frag_list)
819#define SKB_LINEAR_ASSERT(skb) BUG_ON(skb_is_nonlinear(skb))
820
821/*
822 * Add data to an sk_buff
823 */
824static inline unsigned char *__skb_put(struct sk_buff *skb, unsigned int len)
825{
826 unsigned char *tmp = skb->tail;
827 SKB_LINEAR_ASSERT(skb);
828 skb->tail += len;
829 skb->len += len;
830 return tmp;
831}
832
833/**
834 * skb_put - add data to a buffer
835 * @skb: buffer to use
836 * @len: amount of data to add
837 *
838 * This function extends the used data area of the buffer. If this would
839 * exceed the total buffer size the kernel will panic. A pointer to the
840 * first byte of the extra data is returned.
841 */
842static inline unsigned char *skb_put(struct sk_buff *skb, unsigned int len)
843{
844 unsigned char *tmp = skb->tail;
845 SKB_LINEAR_ASSERT(skb);
846 skb->tail += len;
847 skb->len += len;
848 if (unlikely(skb->tail>skb->end))
849 skb_over_panic(skb, len, current_text_addr());
850 return tmp;
851}
852
853static inline unsigned char *__skb_push(struct sk_buff *skb, unsigned int len)
854{
855 skb->data -= len;
856 skb->len += len;
857 return skb->data;
858}
859
860/**
861 * skb_push - add data to the start of a buffer
862 * @skb: buffer to use
863 * @len: amount of data to add
864 *
865 * This function extends the used data area of the buffer at the buffer
866 * start. If this would exceed the total buffer headroom the kernel will
867 * panic. A pointer to the first byte of the extra data is returned.
868 */
869static inline unsigned char *skb_push(struct sk_buff *skb, unsigned int len)
870{
871 skb->data -= len;
872 skb->len += len;
873 if (unlikely(skb->data<skb->head))
874 skb_under_panic(skb, len, current_text_addr());
875 return skb->data;
876}
877
878static inline unsigned char *__skb_pull(struct sk_buff *skb, unsigned int len)
879{
880 skb->len -= len;
881 BUG_ON(skb->len < skb->data_len);
882 return skb->data += len;
883}
884
885/**
886 * skb_pull - remove data from the start of a buffer
887 * @skb: buffer to use
888 * @len: amount of data to remove
889 *
890 * This function removes data from the start of a buffer, returning
891 * the memory to the headroom. A pointer to the next data in the buffer
892 * is returned. Once the data has been pulled future pushes will overwrite
893 * the old data.
894 */
895static inline unsigned char *skb_pull(struct sk_buff *skb, unsigned int len)
896{
897 return unlikely(len > skb->len) ? NULL : __skb_pull(skb, len);
898}
899
900extern unsigned char *__pskb_pull_tail(struct sk_buff *skb, int delta);
901
902static inline unsigned char *__pskb_pull(struct sk_buff *skb, unsigned int len)
903{
904 if (len > skb_headlen(skb) &&
905 !__pskb_pull_tail(skb, len-skb_headlen(skb)))
906 return NULL;
907 skb->len -= len;
908 return skb->data += len;
909}
910
911static inline unsigned char *pskb_pull(struct sk_buff *skb, unsigned int len)
912{
913 return unlikely(len > skb->len) ? NULL : __pskb_pull(skb, len);
914}
915
916static inline int pskb_may_pull(struct sk_buff *skb, unsigned int len)
917{
918 if (likely(len <= skb_headlen(skb)))
919 return 1;
920 if (unlikely(len > skb->len))
921 return 0;
922 return __pskb_pull_tail(skb, len-skb_headlen(skb)) != NULL;
923}
924
925/**
926 * skb_headroom - bytes at buffer head
927 * @skb: buffer to check
928 *
929 * Return the number of bytes of free space at the head of an &sk_buff.
930 */
931static inline int skb_headroom(const struct sk_buff *skb)
932{
933 return skb->data - skb->head;
934}
935
936/**
937 * skb_tailroom - bytes at buffer end
938 * @skb: buffer to check
939 *
940 * Return the number of bytes of free space at the tail of an sk_buff
941 */
942static inline int skb_tailroom(const struct sk_buff *skb)
943{
944 return skb_is_nonlinear(skb) ? 0 : skb->end - skb->tail;
945}
946
947/**
948 * skb_reserve - adjust headroom
949 * @skb: buffer to alter
950 * @len: bytes to move
951 *
952 * Increase the headroom of an empty &sk_buff by reducing the tail
953 * room. This is only allowed for an empty buffer.
954 */
David S. Miller8243126c2006-01-17 02:54:21 -0800955static inline void skb_reserve(struct sk_buff *skb, int len)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700956{
957 skb->data += len;
958 skb->tail += len;
959}
960
961/*
962 * CPUs often take a performance hit when accessing unaligned memory
963 * locations. The actual performance hit varies, it can be small if the
964 * hardware handles it or large if we have to take an exception and fix it
965 * in software.
966 *
967 * Since an ethernet header is 14 bytes network drivers often end up with
968 * the IP header at an unaligned offset. The IP header can be aligned by
969 * shifting the start of the packet by 2 bytes. Drivers should do this
970 * with:
971 *
972 * skb_reserve(NET_IP_ALIGN);
973 *
974 * The downside to this alignment of the IP header is that the DMA is now
975 * unaligned. On some architectures the cost of an unaligned DMA is high
976 * and this cost outweighs the gains made by aligning the IP header.
977 *
978 * Since this trade off varies between architectures, we allow NET_IP_ALIGN
979 * to be overridden.
980 */
981#ifndef NET_IP_ALIGN
982#define NET_IP_ALIGN 2
983#endif
984
Anton Blanchard025be812006-03-31 02:27:06 -0800985/*
986 * The networking layer reserves some headroom in skb data (via
987 * dev_alloc_skb). This is used to avoid having to reallocate skb data when
988 * the header has to grow. In the default case, if the header has to grow
989 * 16 bytes or less we avoid the reallocation.
990 *
991 * Unfortunately this headroom changes the DMA alignment of the resulting
992 * network packet. As for NET_IP_ALIGN, this unaligned DMA is expensive
993 * on some architectures. An architecture can override this value,
994 * perhaps setting it to a cacheline in size (since that will maintain
995 * cacheline alignment of the DMA). It must be a power of 2.
996 *
997 * Various parts of the networking layer expect at least 16 bytes of
998 * headroom, you should not reduce this.
999 */
1000#ifndef NET_SKB_PAD
1001#define NET_SKB_PAD 16
1002#endif
1003
Herbert Xu3cc0e872006-06-09 16:13:38 -07001004extern int ___pskb_trim(struct sk_buff *skb, unsigned int len);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001005
1006static inline void __skb_trim(struct sk_buff *skb, unsigned int len)
1007{
Herbert Xu3cc0e872006-06-09 16:13:38 -07001008 if (unlikely(skb->data_len)) {
1009 WARN_ON(1);
1010 return;
1011 }
1012 skb->len = len;
1013 skb->tail = skb->data + len;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001014}
1015
1016/**
1017 * skb_trim - remove end from a buffer
1018 * @skb: buffer to alter
1019 * @len: new length
1020 *
1021 * Cut the length of a buffer down by removing data from the tail. If
1022 * the buffer is already under the length specified it is not modified.
Herbert Xu3cc0e872006-06-09 16:13:38 -07001023 * The skb must be linear.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001024 */
1025static inline void skb_trim(struct sk_buff *skb, unsigned int len)
1026{
1027 if (skb->len > len)
1028 __skb_trim(skb, len);
1029}
1030
1031
1032static inline int __pskb_trim(struct sk_buff *skb, unsigned int len)
1033{
Herbert Xu3cc0e872006-06-09 16:13:38 -07001034 if (skb->data_len)
1035 return ___pskb_trim(skb, len);
1036 __skb_trim(skb, len);
1037 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001038}
1039
1040static inline int pskb_trim(struct sk_buff *skb, unsigned int len)
1041{
1042 return (len < skb->len) ? __pskb_trim(skb, len) : 0;
1043}
1044
1045/**
Herbert Xue9fa4f72006-08-13 20:12:58 -07001046 * pskb_trim_unique - remove end from a paged unique (not cloned) buffer
1047 * @skb: buffer to alter
1048 * @len: new length
1049 *
1050 * This is identical to pskb_trim except that the caller knows that
1051 * the skb is not cloned so we should never get an error due to out-
1052 * of-memory.
1053 */
1054static inline void pskb_trim_unique(struct sk_buff *skb, unsigned int len)
1055{
1056 int err = pskb_trim(skb, len);
1057 BUG_ON(err);
1058}
1059
1060/**
Linus Torvalds1da177e2005-04-16 15:20:36 -07001061 * skb_orphan - orphan a buffer
1062 * @skb: buffer to orphan
1063 *
1064 * If a buffer currently has an owner then we call the owner's
1065 * destructor function and make the @skb unowned. The buffer continues
1066 * to exist but is no longer charged to its former owner.
1067 */
1068static inline void skb_orphan(struct sk_buff *skb)
1069{
1070 if (skb->destructor)
1071 skb->destructor(skb);
1072 skb->destructor = NULL;
1073 skb->sk = NULL;
1074}
1075
1076/**
1077 * __skb_queue_purge - empty a list
1078 * @list: list to empty
1079 *
1080 * Delete all buffers on an &sk_buff list. Each buffer is removed from
1081 * the list and one reference dropped. This function does not take the
1082 * list lock and the caller must hold the relevant locks to use it.
1083 */
1084extern void skb_queue_purge(struct sk_buff_head *list);
1085static inline void __skb_queue_purge(struct sk_buff_head *list)
1086{
1087 struct sk_buff *skb;
1088 while ((skb = __skb_dequeue(list)) != NULL)
1089 kfree_skb(skb);
1090}
1091
1092/**
Christoph Hellwigb4e54de2006-07-24 15:31:14 -07001093 * __dev_alloc_skb - allocate an skbuff for receiving
Linus Torvalds1da177e2005-04-16 15:20:36 -07001094 * @length: length to allocate
1095 * @gfp_mask: get_free_pages mask, passed to alloc_skb
1096 *
1097 * Allocate a new &sk_buff and assign it a usage count of one. The
1098 * buffer has unspecified headroom built in. Users should allocate
1099 * the headroom they think they need without accounting for the
1100 * built in space. The built in space is used for optimisations.
1101 *
Christoph Hellwig766ea8c2006-08-07 15:49:53 -07001102 * %NULL is returned if there is no free memory.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001103 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001104static inline struct sk_buff *__dev_alloc_skb(unsigned int length,
Al Virodd0fc662005-10-07 07:46:04 +01001105 gfp_t gfp_mask)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001106{
Anton Blanchard025be812006-03-31 02:27:06 -08001107 struct sk_buff *skb = alloc_skb(length + NET_SKB_PAD, gfp_mask);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001108 if (likely(skb))
Anton Blanchard025be812006-03-31 02:27:06 -08001109 skb_reserve(skb, NET_SKB_PAD);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001110 return skb;
1111}
Linus Torvalds1da177e2005-04-16 15:20:36 -07001112
1113/**
Christoph Hellwigb4e54de2006-07-24 15:31:14 -07001114 * dev_alloc_skb - allocate an skbuff for receiving
Linus Torvalds1da177e2005-04-16 15:20:36 -07001115 * @length: length to allocate
1116 *
1117 * Allocate a new &sk_buff and assign it a usage count of one. The
1118 * buffer has unspecified headroom built in. Users should allocate
1119 * the headroom they think they need without accounting for the
1120 * built in space. The built in space is used for optimisations.
1121 *
Christoph Hellwig766ea8c2006-08-07 15:49:53 -07001122 * %NULL is returned if there is no free memory. Although this function
Linus Torvalds1da177e2005-04-16 15:20:36 -07001123 * allocates memory it can be called from an interrupt.
1124 */
1125static inline struct sk_buff *dev_alloc_skb(unsigned int length)
1126{
1127 return __dev_alloc_skb(length, GFP_ATOMIC);
1128}
1129
Christoph Hellwig8af27452006-07-31 22:35:23 -07001130extern struct sk_buff *__netdev_alloc_skb(struct net_device *dev,
1131 unsigned int length, gfp_t gfp_mask);
1132
1133/**
1134 * netdev_alloc_skb - allocate an skbuff for rx on a specific device
1135 * @dev: network device to receive on
1136 * @length: length to allocate
1137 *
1138 * Allocate a new &sk_buff and assign it a usage count of one. The
1139 * buffer has unspecified headroom built in. Users should allocate
1140 * the headroom they think they need without accounting for the
1141 * built in space. The built in space is used for optimisations.
1142 *
1143 * %NULL is returned if there is no free memory. Although this function
1144 * allocates memory it can be called from an interrupt.
1145 */
1146static inline struct sk_buff *netdev_alloc_skb(struct net_device *dev,
1147 unsigned int length)
1148{
1149 return __netdev_alloc_skb(dev, length, GFP_ATOMIC);
1150}
1151
Linus Torvalds1da177e2005-04-16 15:20:36 -07001152/**
1153 * skb_cow - copy header of skb when it is required
1154 * @skb: buffer to cow
1155 * @headroom: needed headroom
1156 *
1157 * If the skb passed lacks sufficient headroom or its data part
1158 * is shared, data is reallocated. If reallocation fails, an error
1159 * is returned and original skb is not changed.
1160 *
1161 * The result is skb with writable area skb->head...skb->tail
1162 * and at least @headroom of space at head.
1163 */
1164static inline int skb_cow(struct sk_buff *skb, unsigned int headroom)
1165{
Anton Blanchard025be812006-03-31 02:27:06 -08001166 int delta = (headroom > NET_SKB_PAD ? headroom : NET_SKB_PAD) -
1167 skb_headroom(skb);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001168
1169 if (delta < 0)
1170 delta = 0;
1171
1172 if (delta || skb_cloned(skb))
Anton Blanchard025be812006-03-31 02:27:06 -08001173 return pskb_expand_head(skb, (delta + (NET_SKB_PAD-1)) &
1174 ~(NET_SKB_PAD-1), 0, GFP_ATOMIC);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001175 return 0;
1176}
1177
1178/**
1179 * skb_padto - pad an skbuff up to a minimal size
1180 * @skb: buffer to pad
1181 * @len: minimal length
1182 *
1183 * Pads up a buffer to ensure the trailing bytes exist and are
1184 * blanked. If the buffer already contains sufficient data it
Herbert Xu5b057c62006-06-23 02:06:41 -07001185 * is untouched. Otherwise it is extended. Returns zero on
1186 * success. The skb is freed on error.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001187 */
1188
Herbert Xu5b057c62006-06-23 02:06:41 -07001189static inline int skb_padto(struct sk_buff *skb, unsigned int len)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001190{
1191 unsigned int size = skb->len;
1192 if (likely(size >= len))
Herbert Xu5b057c62006-06-23 02:06:41 -07001193 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001194 return skb_pad(skb, len-size);
1195}
1196
1197static inline int skb_add_data(struct sk_buff *skb,
1198 char __user *from, int copy)
1199{
1200 const int off = skb->len;
1201
1202 if (skb->ip_summed == CHECKSUM_NONE) {
1203 int err = 0;
Al Viro50842052006-11-14 21:36:34 -08001204 __wsum csum = csum_and_copy_from_user(from, skb_put(skb, copy),
Linus Torvalds1da177e2005-04-16 15:20:36 -07001205 copy, 0, &err);
1206 if (!err) {
1207 skb->csum = csum_block_add(skb->csum, csum, off);
1208 return 0;
1209 }
1210 } else if (!copy_from_user(skb_put(skb, copy), from, copy))
1211 return 0;
1212
1213 __skb_trim(skb, off);
1214 return -EFAULT;
1215}
1216
1217static inline int skb_can_coalesce(struct sk_buff *skb, int i,
1218 struct page *page, int off)
1219{
1220 if (i) {
1221 struct skb_frag_struct *frag = &skb_shinfo(skb)->frags[i - 1];
1222
1223 return page == frag->page &&
1224 off == frag->page_offset + frag->size;
1225 }
1226 return 0;
1227}
1228
Herbert Xu364c6ba2006-06-09 16:10:40 -07001229static inline int __skb_linearize(struct sk_buff *skb)
1230{
1231 return __pskb_pull_tail(skb, skb->data_len) ? 0 : -ENOMEM;
1232}
1233
Linus Torvalds1da177e2005-04-16 15:20:36 -07001234/**
1235 * skb_linearize - convert paged skb to linear one
1236 * @skb: buffer to linarize
Linus Torvalds1da177e2005-04-16 15:20:36 -07001237 *
1238 * If there is no free memory -ENOMEM is returned, otherwise zero
1239 * is returned and the old skb data released.
1240 */
Herbert Xu364c6ba2006-06-09 16:10:40 -07001241static inline int skb_linearize(struct sk_buff *skb)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001242{
Herbert Xu364c6ba2006-06-09 16:10:40 -07001243 return skb_is_nonlinear(skb) ? __skb_linearize(skb) : 0;
1244}
1245
1246/**
1247 * skb_linearize_cow - make sure skb is linear and writable
1248 * @skb: buffer to process
1249 *
1250 * If there is no free memory -ENOMEM is returned, otherwise zero
1251 * is returned and the old skb data released.
1252 */
1253static inline int skb_linearize_cow(struct sk_buff *skb)
1254{
1255 return skb_is_nonlinear(skb) || skb_cloned(skb) ?
1256 __skb_linearize(skb) : 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001257}
1258
1259/**
1260 * skb_postpull_rcsum - update checksum for received skb after pull
1261 * @skb: buffer to update
1262 * @start: start of data before pull
1263 * @len: length of data pulled
1264 *
1265 * After doing a pull on a received packet, you need to call this to
Patrick McHardy84fa7932006-08-29 16:44:56 -07001266 * update the CHECKSUM_COMPLETE checksum, or set ip_summed to
1267 * CHECKSUM_NONE so that it can be recomputed from scratch.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001268 */
1269
1270static inline void skb_postpull_rcsum(struct sk_buff *skb,
Herbert Xucbb042f2006-03-20 22:43:56 -08001271 const void *start, unsigned int len)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001272{
Patrick McHardy84fa7932006-08-29 16:44:56 -07001273 if (skb->ip_summed == CHECKSUM_COMPLETE)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001274 skb->csum = csum_sub(skb->csum, csum_partial(start, len, 0));
1275}
1276
Herbert Xucbb042f2006-03-20 22:43:56 -08001277unsigned char *skb_pull_rcsum(struct sk_buff *skb, unsigned int len);
1278
Linus Torvalds1da177e2005-04-16 15:20:36 -07001279/**
1280 * pskb_trim_rcsum - trim received skb and update checksum
1281 * @skb: buffer to trim
1282 * @len: new length
1283 *
1284 * This is exactly the same as pskb_trim except that it ensures the
1285 * checksum of received packets are still valid after the operation.
1286 */
1287
1288static inline int pskb_trim_rcsum(struct sk_buff *skb, unsigned int len)
1289{
Stephen Hemminger0e4e4222005-09-08 12:32:03 -07001290 if (likely(len >= skb->len))
Linus Torvalds1da177e2005-04-16 15:20:36 -07001291 return 0;
Patrick McHardy84fa7932006-08-29 16:44:56 -07001292 if (skb->ip_summed == CHECKSUM_COMPLETE)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001293 skb->ip_summed = CHECKSUM_NONE;
1294 return __pskb_trim(skb, len);
1295}
1296
Linus Torvalds1da177e2005-04-16 15:20:36 -07001297#define skb_queue_walk(queue, skb) \
1298 for (skb = (queue)->next; \
1299 prefetch(skb->next), (skb != (struct sk_buff *)(queue)); \
1300 skb = skb->next)
1301
Stephen Hemminger300ce172005-10-30 13:47:34 -08001302#define skb_queue_reverse_walk(queue, skb) \
1303 for (skb = (queue)->prev; \
1304 prefetch(skb->prev), (skb != (struct sk_buff *)(queue)); \
1305 skb = skb->prev)
1306
Linus Torvalds1da177e2005-04-16 15:20:36 -07001307
1308extern struct sk_buff *skb_recv_datagram(struct sock *sk, unsigned flags,
1309 int noblock, int *err);
1310extern unsigned int datagram_poll(struct file *file, struct socket *sock,
1311 struct poll_table_struct *wait);
1312extern int skb_copy_datagram_iovec(const struct sk_buff *from,
1313 int offset, struct iovec *to,
1314 int size);
Herbert Xufb286bb2005-11-10 13:01:24 -08001315extern int skb_copy_and_csum_datagram_iovec(struct sk_buff *skb,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001316 int hlen,
1317 struct iovec *iov);
1318extern void skb_free_datagram(struct sock *sk, struct sk_buff *skb);
Herbert Xu3305b802005-12-13 23:16:37 -08001319extern void skb_kill_datagram(struct sock *sk, struct sk_buff *skb,
1320 unsigned int flags);
Al Viro2bbbc862006-11-14 21:37:14 -08001321extern __wsum skb_checksum(const struct sk_buff *skb, int offset,
1322 int len, __wsum csum);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001323extern int skb_copy_bits(const struct sk_buff *skb, int offset,
1324 void *to, int len);
Herbert Xu357b40a2005-04-19 22:30:14 -07001325extern int skb_store_bits(const struct sk_buff *skb, int offset,
1326 void *from, int len);
Al Viro81d77662006-11-14 21:37:33 -08001327extern __wsum skb_copy_and_csum_bits(const struct sk_buff *skb,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001328 int offset, u8 *to, int len,
Al Viro81d77662006-11-14 21:37:33 -08001329 __wsum csum);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001330extern void skb_copy_and_csum_dev(const struct sk_buff *skb, u8 *to);
1331extern void skb_split(struct sk_buff *skb,
1332 struct sk_buff *skb1, const u32 len);
1333
Herbert Xu576a30e2006-06-27 13:22:38 -07001334extern struct sk_buff *skb_segment(struct sk_buff *skb, int features);
Arnaldo Carvalho de Melo20380732005-08-16 02:18:02 -03001335
Linus Torvalds1da177e2005-04-16 15:20:36 -07001336static inline void *skb_header_pointer(const struct sk_buff *skb, int offset,
1337 int len, void *buffer)
1338{
1339 int hlen = skb_headlen(skb);
1340
Patrick McHardy55820ee2005-07-05 14:08:10 -07001341 if (hlen - offset >= len)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001342 return skb->data + offset;
1343
1344 if (skb_copy_bits(skb, offset, buffer, len) < 0)
1345 return NULL;
1346
1347 return buffer;
1348}
1349
1350extern void skb_init(void);
1351extern void skb_add_mtu(int mtu);
1352
Patrick McHardya61bbcf2005-08-14 17:24:31 -07001353/**
1354 * skb_get_timestamp - get timestamp from a skb
1355 * @skb: skb to get stamp from
1356 * @stamp: pointer to struct timeval to store stamp in
1357 *
1358 * Timestamps are stored in the skb as offsets to a base timestamp.
1359 * This function converts the offset back to a struct timeval and stores
1360 * it in stamp.
1361 */
Stephen Hemmingerf2c38392005-09-06 15:48:03 -07001362static inline void skb_get_timestamp(const struct sk_buff *skb, struct timeval *stamp)
Patrick McHardya61bbcf2005-08-14 17:24:31 -07001363{
Eric Dumazetb7aa0bf2007-04-19 16:16:32 -07001364 *stamp = ktime_to_timeval(skb->tstamp);
Patrick McHardya61bbcf2005-08-14 17:24:31 -07001365}
1366
Eric Dumazetb7aa0bf2007-04-19 16:16:32 -07001367static inline void __net_timestamp(struct sk_buff *skb)
Patrick McHardya61bbcf2005-08-14 17:24:31 -07001368{
Eric Dumazetb7aa0bf2007-04-19 16:16:32 -07001369 skb->tstamp = ktime_get_real();
Patrick McHardya61bbcf2005-08-14 17:24:31 -07001370}
1371
Patrick McHardya61bbcf2005-08-14 17:24:31 -07001372
Al Virob51655b2006-11-14 21:40:42 -08001373extern __sum16 __skb_checksum_complete(struct sk_buff *skb);
Herbert Xufb286bb2005-11-10 13:01:24 -08001374
1375/**
1376 * skb_checksum_complete - Calculate checksum of an entire packet
1377 * @skb: packet to process
1378 *
1379 * This function calculates the checksum over the entire packet plus
1380 * the value of skb->csum. The latter can be used to supply the
1381 * checksum of a pseudo header as used by TCP/UDP. It returns the
1382 * checksum.
1383 *
1384 * For protocols that contain complete checksums such as ICMP/TCP/UDP,
1385 * this function can be used to verify that checksum on received
1386 * packets. In that case the function should return zero if the
1387 * checksum is correct. In particular, this function will return zero
1388 * if skb->ip_summed is CHECKSUM_UNNECESSARY which indicates that the
1389 * hardware has already verified the correctness of the checksum.
1390 */
1391static inline unsigned int skb_checksum_complete(struct sk_buff *skb)
1392{
1393 return skb->ip_summed != CHECKSUM_UNNECESSARY &&
1394 __skb_checksum_complete(skb);
1395}
1396
Linus Torvalds1da177e2005-04-16 15:20:36 -07001397#ifdef CONFIG_NETFILTER
1398static inline void nf_conntrack_put(struct nf_conntrack *nfct)
1399{
1400 if (nfct && atomic_dec_and_test(&nfct->use))
1401 nfct->destroy(nfct);
1402}
1403static inline void nf_conntrack_get(struct nf_conntrack *nfct)
1404{
1405 if (nfct)
1406 atomic_inc(&nfct->use);
1407}
Yasuyuki Kozakai9fb9cbb2005-11-09 16:38:16 -08001408#if defined(CONFIG_NF_CONNTRACK) || defined(CONFIG_NF_CONNTRACK_MODULE)
1409static inline void nf_conntrack_get_reasm(struct sk_buff *skb)
1410{
1411 if (skb)
1412 atomic_inc(&skb->users);
1413}
1414static inline void nf_conntrack_put_reasm(struct sk_buff *skb)
1415{
1416 if (skb)
1417 kfree_skb(skb);
1418}
1419#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -07001420#ifdef CONFIG_BRIDGE_NETFILTER
1421static inline void nf_bridge_put(struct nf_bridge_info *nf_bridge)
1422{
1423 if (nf_bridge && atomic_dec_and_test(&nf_bridge->use))
1424 kfree(nf_bridge);
1425}
1426static inline void nf_bridge_get(struct nf_bridge_info *nf_bridge)
1427{
1428 if (nf_bridge)
1429 atomic_inc(&nf_bridge->use);
1430}
1431#endif /* CONFIG_BRIDGE_NETFILTER */
Patrick McHardya193a4a2006-03-20 19:23:05 -08001432static inline void nf_reset(struct sk_buff *skb)
1433{
1434 nf_conntrack_put(skb->nfct);
1435 skb->nfct = NULL;
1436#if defined(CONFIG_NF_CONNTRACK) || defined(CONFIG_NF_CONNTRACK_MODULE)
1437 nf_conntrack_put_reasm(skb->nfct_reasm);
1438 skb->nfct_reasm = NULL;
1439#endif
1440#ifdef CONFIG_BRIDGE_NETFILTER
1441 nf_bridge_put(skb->nf_bridge);
1442 skb->nf_bridge = NULL;
1443#endif
1444}
1445
Linus Torvalds1da177e2005-04-16 15:20:36 -07001446#else /* CONFIG_NETFILTER */
1447static inline void nf_reset(struct sk_buff *skb) {}
1448#endif /* CONFIG_NETFILTER */
1449
James Morris984bc162006-06-09 00:29:17 -07001450#ifdef CONFIG_NETWORK_SECMARK
1451static inline void skb_copy_secmark(struct sk_buff *to, const struct sk_buff *from)
1452{
1453 to->secmark = from->secmark;
1454}
1455
1456static inline void skb_init_secmark(struct sk_buff *skb)
1457{
1458 skb->secmark = 0;
1459}
1460#else
1461static inline void skb_copy_secmark(struct sk_buff *to, const struct sk_buff *from)
1462{ }
1463
1464static inline void skb_init_secmark(struct sk_buff *skb)
1465{ }
1466#endif
1467
Herbert Xu89114af2006-07-08 13:34:32 -07001468static inline int skb_is_gso(const struct sk_buff *skb)
1469{
1470 return skb_shinfo(skb)->gso_size;
1471}
1472
Linus Torvalds1da177e2005-04-16 15:20:36 -07001473#endif /* __KERNEL__ */
1474#endif /* _LINUX_SKBUFF_H */