blob: 14ec16d2d9ba7bd6254093df7db05a242bb4f7a0 [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>
25#include <linux/mm.h>
26#include <linux/highmem.h>
27#include <linux/poll.h>
28#include <linux/net.h>
Thomas Graf3fc7e8a2005-06-23 21:00:17 -070029#include <linux/textsearch.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070030#include <net/checksum.h>
Chris Leech97fc2f02006-05-23 17:55:33 -070031#include <linux/dmaengine.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070032
33#define HAVE_ALLOC_SKB /* For the drivers to know */
34#define HAVE_ALIGNABLE_SKB /* Ditto 8) */
Linus Torvalds1da177e2005-04-16 15:20:36 -070035
36#define CHECKSUM_NONE 0
Patrick McHardy84fa7932006-08-29 16:44:56 -070037#define CHECKSUM_PARTIAL 1
Linus Torvalds1da177e2005-04-16 15:20:36 -070038#define CHECKSUM_UNNECESSARY 2
Patrick McHardy84fa7932006-08-29 16:44:56 -070039#define CHECKSUM_COMPLETE 3
Linus Torvalds1da177e2005-04-16 15:20:36 -070040
41#define SKB_DATA_ALIGN(X) (((X) + (SMP_CACHE_BYTES - 1)) & \
42 ~(SMP_CACHE_BYTES - 1))
43#define SKB_MAX_ORDER(X, ORDER) (((PAGE_SIZE << (ORDER)) - (X) - \
44 sizeof(struct skb_shared_info)) & \
45 ~(SMP_CACHE_BYTES - 1))
46#define SKB_MAX_HEAD(X) (SKB_MAX_ORDER((X), 0))
47#define SKB_MAX_ALLOC (SKB_MAX_ORDER(0, 2))
48
49/* A. Checksumming of received packets by device.
50 *
51 * NONE: device failed to checksum this packet.
52 * skb->csum is undefined.
53 *
54 * UNNECESSARY: device parsed packet and wouldbe verified checksum.
55 * skb->csum is undefined.
56 * It is bad option, but, unfortunately, many of vendors do this.
57 * Apparently with secret goal to sell you new device, when you
58 * will add new protocol to your host. F.e. IPv6. 8)
59 *
Patrick McHardy84fa7932006-08-29 16:44:56 -070060 * COMPLETE: the most generic way. Device supplied checksum of _all_
Linus Torvalds1da177e2005-04-16 15:20:36 -070061 * the packet as seen by netif_rx in skb->csum.
62 * NOTE: Even if device supports only some protocols, but
Patrick McHardy84fa7932006-08-29 16:44:56 -070063 * is able to produce some skb->csum, it MUST use COMPLETE,
Linus Torvalds1da177e2005-04-16 15:20:36 -070064 * not UNNECESSARY.
65 *
66 * B. Checksumming on output.
67 *
68 * NONE: skb is checksummed by protocol or csum is not required.
69 *
Patrick McHardy84fa7932006-08-29 16:44:56 -070070 * PARTIAL: device is required to csum packet as seen by hard_start_xmit
Linus Torvalds1da177e2005-04-16 15:20:36 -070071 * from skb->h.raw to the end and to record the checksum
72 * at skb->h.raw+skb->csum.
73 *
74 * Device must show its capabilities in dev->features, set
75 * at device setup time.
76 * NETIF_F_HW_CSUM - it is clever device, it is able to checksum
77 * everything.
78 * NETIF_F_NO_CSUM - loopback or reliable single hop media.
79 * NETIF_F_IP_CSUM - device is dumb. It is able to csum only
80 * TCP/UDP over IPv4. Sigh. Vendors like this
81 * way by an unknown reason. Though, see comment above
82 * about CHECKSUM_UNNECESSARY. 8)
83 *
84 * Any questions? No questions, good. --ANK
85 */
86
Linus Torvalds1da177e2005-04-16 15:20:36 -070087struct net_device;
88
89#ifdef CONFIG_NETFILTER
90struct nf_conntrack {
91 atomic_t use;
92 void (*destroy)(struct nf_conntrack *);
93};
94
95#ifdef CONFIG_BRIDGE_NETFILTER
96struct nf_bridge_info {
97 atomic_t use;
98 struct net_device *physindev;
99 struct net_device *physoutdev;
100#if defined(CONFIG_VLAN_8021Q) || defined(CONFIG_VLAN_8021Q_MODULE)
101 struct net_device *netoutdev;
102#endif
103 unsigned int mask;
104 unsigned long data[32 / sizeof(unsigned long)];
105};
106#endif
107
108#endif
109
110struct sk_buff_head {
111 /* These two members must be first. */
112 struct sk_buff *next;
113 struct sk_buff *prev;
114
115 __u32 qlen;
116 spinlock_t lock;
117};
118
119struct sk_buff;
120
121/* To allow 64K frame to be packed as single skb without frag_list */
122#define MAX_SKB_FRAGS (65536/PAGE_SIZE + 2)
123
124typedef struct skb_frag_struct skb_frag_t;
125
126struct skb_frag_struct {
127 struct page *page;
128 __u16 page_offset;
129 __u16 size;
130};
131
132/* This data is invariant across clones and lives at
133 * the end of the header data, ie. at skb->end.
134 */
135struct skb_shared_info {
136 atomic_t dataref;
Benjamin LaHaise4947d3e2006-01-03 14:06:50 -0800137 unsigned short nr_frags;
Herbert Xu79671682006-06-22 02:40:14 -0700138 unsigned short gso_size;
139 /* Warning: this field is not always filled in (UFO)! */
140 unsigned short gso_segs;
141 unsigned short gso_type;
Al Viroae08e1f2006-11-08 00:27:11 -0800142 __be32 ip6_frag_id;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700143 struct sk_buff *frag_list;
144 skb_frag_t frags[MAX_SKB_FRAGS];
145};
146
147/* We divide dataref into two halves. The higher 16 bits hold references
148 * to the payload part of skb->data. The lower 16 bits hold references to
149 * the entire skb->data. It is up to the users of the skb to agree on
150 * where the payload starts.
151 *
152 * All users must obey the rule that the skb->data reference count must be
153 * greater than or equal to the payload reference count.
154 *
155 * Holding a reference to the payload part means that the user does not
156 * care about modifications to the header part of skb->data.
157 */
158#define SKB_DATAREF_SHIFT 16
159#define SKB_DATAREF_MASK ((1 << SKB_DATAREF_SHIFT) - 1)
160
Patrick McHardya61bbcf2005-08-14 17:24:31 -0700161struct skb_timeval {
162 u32 off_sec;
163 u32 off_usec;
164};
165
David S. Millerd179cd12005-08-17 14:57:30 -0700166
167enum {
168 SKB_FCLONE_UNAVAILABLE,
169 SKB_FCLONE_ORIG,
170 SKB_FCLONE_CLONE,
171};
172
Herbert Xu79671682006-06-22 02:40:14 -0700173enum {
174 SKB_GSO_TCPV4 = 1 << 0,
Herbert Xuf83ef8c2006-06-30 13:37:03 -0700175 SKB_GSO_UDP = 1 << 1,
Herbert Xu576a30e2006-06-27 13:22:38 -0700176
177 /* This indicates the skb is from an untrusted source. */
178 SKB_GSO_DODGY = 1 << 2,
Michael Chanb0da85372006-06-29 12:30:00 -0700179
180 /* This indicates the tcp segment has CWR set. */
Herbert Xuf83ef8c2006-06-30 13:37:03 -0700181 SKB_GSO_TCP_ECN = 1 << 3,
182
183 SKB_GSO_TCPV6 = 1 << 4,
Herbert Xu79671682006-06-22 02:40:14 -0700184};
185
Linus Torvalds1da177e2005-04-16 15:20:36 -0700186/**
187 * struct sk_buff - socket buffer
188 * @next: Next buffer in list
189 * @prev: Previous buffer in list
Linus Torvalds1da177e2005-04-16 15:20:36 -0700190 * @sk: Socket we are owned by
Herbert Xu325ed822005-10-03 13:57:23 -0700191 * @tstamp: Time we arrived
Linus Torvalds1da177e2005-04-16 15:20:36 -0700192 * @dev: Device we arrived on/are leaving by
193 * @input_dev: Device we arrived on
Linus Torvalds1da177e2005-04-16 15:20:36 -0700194 * @h: Transport layer header
195 * @nh: Network layer header
196 * @mac: Link layer header
Martin Waitz67be2dd2005-05-01 08:59:26 -0700197 * @dst: destination entry
198 * @sp: the security path, used for xfrm
Linus Torvalds1da177e2005-04-16 15:20:36 -0700199 * @cb: Control buffer. Free for use by every layer. Put private vars here
200 * @len: Length of actual data
201 * @data_len: Data length
202 * @mac_len: Length of link layer header
203 * @csum: Checksum
Martin Waitz67be2dd2005-05-01 08:59:26 -0700204 * @local_df: allow local fragmentation
Linus Torvalds1da177e2005-04-16 15:20:36 -0700205 * @cloned: Head may be cloned (check refcnt to be sure)
206 * @nohdr: Payload reference only, must not modify header
207 * @pkt_type: Packet class
Randy Dunlapc83c2482005-10-18 22:07:41 -0700208 * @fclone: skbuff clone status
Linus Torvalds1da177e2005-04-16 15:20:36 -0700209 * @ip_summed: Driver fed us an IP checksum
210 * @priority: Packet queueing priority
211 * @users: User count - see {datagram,tcp}.c
212 * @protocol: Packet protocol from driver
Linus Torvalds1da177e2005-04-16 15:20:36 -0700213 * @truesize: Buffer size
214 * @head: Head of buffer
215 * @data: Data head pointer
216 * @tail: Tail pointer
217 * @end: End pointer
218 * @destructor: Destruct function
Thomas Graf82e91ff2006-11-09 15:19:14 -0800219 * @mark: Generic packet mark
Linus Torvalds1da177e2005-04-16 15:20:36 -0700220 * @nfct: Associated connection, if any
Randy Dunlapc83c2482005-10-18 22:07:41 -0700221 * @ipvs_property: skbuff is owned by ipvs
Linus Torvalds1da177e2005-04-16 15:20:36 -0700222 * @nfctinfo: Relationship of this skb to the connection
Randy Dunlap461ddf32005-11-20 21:25:15 -0800223 * @nfct_reasm: netfilter conntrack re-assembly pointer
Linus Torvalds1da177e2005-04-16 15:20:36 -0700224 * @nf_bridge: Saved data about a bridged frame - see br_netfilter.c
Linus Torvalds1da177e2005-04-16 15:20:36 -0700225 * @tc_index: Traffic control index
226 * @tc_verd: traffic control verdict
Randy Dunlapf4b8ea72006-06-22 16:00:11 -0700227 * @dma_cookie: a cookie to one of several possible DMA operations
228 * done by skb DMA functions
James Morris984bc162006-06-09 00:29:17 -0700229 * @secmark: security marking
Linus Torvalds1da177e2005-04-16 15:20:36 -0700230 */
231
232struct sk_buff {
233 /* These two members must be first. */
234 struct sk_buff *next;
235 struct sk_buff *prev;
236
Linus Torvalds1da177e2005-04-16 15:20:36 -0700237 struct sock *sk;
Patrick McHardya61bbcf2005-08-14 17:24:31 -0700238 struct skb_timeval tstamp;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700239 struct net_device *dev;
240 struct net_device *input_dev;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700241
242 union {
243 struct tcphdr *th;
244 struct udphdr *uh;
245 struct icmphdr *icmph;
246 struct igmphdr *igmph;
247 struct iphdr *ipiph;
248 struct ipv6hdr *ipv6h;
249 unsigned char *raw;
250 } h;
251
252 union {
253 struct iphdr *iph;
254 struct ipv6hdr *ipv6h;
255 struct arphdr *arph;
256 unsigned char *raw;
257 } nh;
258
259 union {
260 unsigned char *raw;
261 } mac;
262
263 struct dst_entry *dst;
264 struct sec_path *sp;
265
266 /*
267 * This is the control buffer. It is free to use for every
268 * layer. Please put your private variables there. If you
269 * want to keep them across layers you have to do a skb_clone()
270 * first. This is owned by whoever has the skb queued ATM.
271 */
Patrick McHardy3e3850e2006-01-06 23:04:54 -0800272 char cb[48];
Linus Torvalds1da177e2005-04-16 15:20:36 -0700273
274 unsigned int len,
275 data_len,
Al Viro1f61ab52006-11-14 21:44:08 -0800276 mac_len;
Al Viroff1dcad2006-11-20 18:07:29 -0800277 union {
278 __wsum csum;
279 __u32 csum_offset;
280 };
Linus Torvalds1da177e2005-04-16 15:20:36 -0700281 __u32 priority;
Thomas Graf1cbb3382005-07-05 14:13:41 -0700282 __u8 local_df:1,
283 cloned:1,
284 ip_summed:2,
Harald Welte6869c4d2005-08-09 19:24:19 -0700285 nohdr:1,
286 nfctinfo:3;
David S. Millerd179cd12005-08-17 14:57:30 -0700287 __u8 pkt_type:3,
Patrick McHardyb84f4cc2005-11-20 21:19:21 -0800288 fclone:2,
289 ipvs_property:1;
Alexey Dobriyana0d3bea2005-08-11 16:05:50 -0700290 __be16 protocol;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700291
292 void (*destructor)(struct sk_buff *skb);
293#ifdef CONFIG_NETFILTER
Linus Torvalds1da177e2005-04-16 15:20:36 -0700294 struct nf_conntrack *nfct;
Yasuyuki Kozakai9fb9cbb2005-11-09 16:38:16 -0800295#if defined(CONFIG_NF_CONNTRACK) || defined(CONFIG_NF_CONNTRACK_MODULE)
296 struct sk_buff *nfct_reasm;
297#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -0700298#ifdef CONFIG_BRIDGE_NETFILTER
299 struct nf_bridge_info *nf_bridge;
300#endif
301#endif /* CONFIG_NETFILTER */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700302#ifdef CONFIG_NET_SCHED
Patrick McHardyb6b99eb2005-08-09 19:33:51 -0700303 __u16 tc_index; /* traffic control index */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700304#ifdef CONFIG_NET_CLS_ACT
Patrick McHardyb6b99eb2005-08-09 19:33:51 -0700305 __u16 tc_verd; /* traffic control verdict */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700306#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -0700307#endif
Chris Leech97fc2f02006-05-23 17:55:33 -0700308#ifdef CONFIG_NET_DMA
309 dma_cookie_t dma_cookie;
310#endif
James Morris984bc162006-06-09 00:29:17 -0700311#ifdef CONFIG_NETWORK_SECMARK
312 __u32 secmark;
313#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -0700314
Thomas Graf82e91ff2006-11-09 15:19:14 -0800315 __u32 mark;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700316
317 /* These elements must be at the end, see alloc_skb() for details. */
318 unsigned int truesize;
319 atomic_t users;
320 unsigned char *head,
321 *data,
322 *tail,
323 *end;
324};
325
326#ifdef __KERNEL__
327/*
328 * Handling routines are only of interest to the kernel
329 */
330#include <linux/slab.h>
331
332#include <asm/system.h>
333
Jörn Engel231d06a2006-03-20 21:28:35 -0800334extern void kfree_skb(struct sk_buff *skb);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700335extern void __kfree_skb(struct sk_buff *skb);
David S. Millerd179cd12005-08-17 14:57:30 -0700336extern struct sk_buff *__alloc_skb(unsigned int size,
Al Virodd0fc662005-10-07 07:46:04 +0100337 gfp_t priority, int fclone);
David S. Millerd179cd12005-08-17 14:57:30 -0700338static inline struct sk_buff *alloc_skb(unsigned int size,
Al Virodd0fc662005-10-07 07:46:04 +0100339 gfp_t priority)
David S. Millerd179cd12005-08-17 14:57:30 -0700340{
341 return __alloc_skb(size, priority, 0);
342}
343
344static inline struct sk_buff *alloc_skb_fclone(unsigned int size,
Al Virodd0fc662005-10-07 07:46:04 +0100345 gfp_t priority)
David S. Millerd179cd12005-08-17 14:57:30 -0700346{
347 return __alloc_skb(size, priority, 1);
348}
349
Linus Torvalds1da177e2005-04-16 15:20:36 -0700350extern struct sk_buff *alloc_skb_from_cache(kmem_cache_t *cp,
Victor Fusco86a76ca2005-07-08 14:57:47 -0700351 unsigned int size,
Al Virodd0fc662005-10-07 07:46:04 +0100352 gfp_t priority);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700353extern void kfree_skbmem(struct sk_buff *skb);
Victor Fusco86a76ca2005-07-08 14:57:47 -0700354extern struct sk_buff *skb_clone(struct sk_buff *skb,
Al Virodd0fc662005-10-07 07:46:04 +0100355 gfp_t priority);
Victor Fusco86a76ca2005-07-08 14:57:47 -0700356extern struct sk_buff *skb_copy(const struct sk_buff *skb,
Al Virodd0fc662005-10-07 07:46:04 +0100357 gfp_t priority);
Victor Fusco86a76ca2005-07-08 14:57:47 -0700358extern struct sk_buff *pskb_copy(struct sk_buff *skb,
Al Virodd0fc662005-10-07 07:46:04 +0100359 gfp_t gfp_mask);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700360extern int pskb_expand_head(struct sk_buff *skb,
Victor Fusco86a76ca2005-07-08 14:57:47 -0700361 int nhead, int ntail,
Al Virodd0fc662005-10-07 07:46:04 +0100362 gfp_t gfp_mask);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700363extern struct sk_buff *skb_realloc_headroom(struct sk_buff *skb,
364 unsigned int headroom);
365extern struct sk_buff *skb_copy_expand(const struct sk_buff *skb,
366 int newheadroom, int newtailroom,
Al Virodd0fc662005-10-07 07:46:04 +0100367 gfp_t priority);
Herbert Xu5b057c62006-06-23 02:06:41 -0700368extern int skb_pad(struct sk_buff *skb, int pad);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700369#define dev_kfree_skb(a) kfree_skb(a)
370extern void skb_over_panic(struct sk_buff *skb, int len,
371 void *here);
372extern void skb_under_panic(struct sk_buff *skb, int len,
373 void *here);
David S. Millerdc6de332006-04-20 00:10:50 -0700374extern void skb_truesize_bug(struct sk_buff *skb);
375
376static inline void skb_truesize_check(struct sk_buff *skb)
377{
378 if (unlikely((int)skb->truesize < sizeof(struct sk_buff) + skb->len))
379 skb_truesize_bug(skb);
380}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700381
Ananda Rajue89e9cf2005-10-18 15:46:41 -0700382extern int skb_append_datato_frags(struct sock *sk, struct sk_buff *skb,
383 int getfrag(void *from, char *to, int offset,
384 int len,int odd, struct sk_buff *skb),
385 void *from, int length);
386
Thomas Graf677e90e2005-06-23 20:59:51 -0700387struct skb_seq_state
388{
389 __u32 lower_offset;
390 __u32 upper_offset;
391 __u32 frag_idx;
392 __u32 stepped_offset;
393 struct sk_buff *root_skb;
394 struct sk_buff *cur_skb;
395 __u8 *frag_data;
396};
397
398extern void skb_prepare_seq_read(struct sk_buff *skb,
399 unsigned int from, unsigned int to,
400 struct skb_seq_state *st);
401extern unsigned int skb_seq_read(unsigned int consumed, const u8 **data,
402 struct skb_seq_state *st);
403extern void skb_abort_seq_read(struct skb_seq_state *st);
404
Thomas Graf3fc7e8a2005-06-23 21:00:17 -0700405extern unsigned int skb_find_text(struct sk_buff *skb, unsigned int from,
406 unsigned int to, struct ts_config *config,
407 struct ts_state *state);
408
Linus Torvalds1da177e2005-04-16 15:20:36 -0700409/* Internal */
410#define skb_shinfo(SKB) ((struct skb_shared_info *)((SKB)->end))
411
412/**
413 * skb_queue_empty - check if a queue is empty
414 * @list: queue head
415 *
416 * Returns true if the queue is empty, false otherwise.
417 */
418static inline int skb_queue_empty(const struct sk_buff_head *list)
419{
420 return list->next == (struct sk_buff *)list;
421}
422
423/**
424 * skb_get - reference buffer
425 * @skb: buffer to reference
426 *
427 * Makes another reference to a socket buffer and returns a pointer
428 * to the buffer.
429 */
430static inline struct sk_buff *skb_get(struct sk_buff *skb)
431{
432 atomic_inc(&skb->users);
433 return skb;
434}
435
436/*
437 * If users == 1, we are the only owner and are can avoid redundant
438 * atomic change.
439 */
440
441/**
Linus Torvalds1da177e2005-04-16 15:20:36 -0700442 * skb_cloned - is the buffer a clone
443 * @skb: buffer to check
444 *
445 * Returns true if the buffer was generated with skb_clone() and is
446 * one of multiple shared copies of the buffer. Cloned buffers are
447 * shared data so must not be written to under normal circumstances.
448 */
449static inline int skb_cloned(const struct sk_buff *skb)
450{
451 return skb->cloned &&
452 (atomic_read(&skb_shinfo(skb)->dataref) & SKB_DATAREF_MASK) != 1;
453}
454
455/**
456 * skb_header_cloned - is the header a clone
457 * @skb: buffer to check
458 *
459 * Returns true if modifying the header part of the buffer requires
460 * the data to be copied.
461 */
462static inline int skb_header_cloned(const struct sk_buff *skb)
463{
464 int dataref;
465
466 if (!skb->cloned)
467 return 0;
468
469 dataref = atomic_read(&skb_shinfo(skb)->dataref);
470 dataref = (dataref & SKB_DATAREF_MASK) - (dataref >> SKB_DATAREF_SHIFT);
471 return dataref != 1;
472}
473
474/**
475 * skb_header_release - release reference to header
476 * @skb: buffer to operate on
477 *
478 * Drop a reference to the header part of the buffer. This is done
479 * by acquiring a payload reference. You must not read from the header
480 * part of skb->data after this.
481 */
482static inline void skb_header_release(struct sk_buff *skb)
483{
484 BUG_ON(skb->nohdr);
485 skb->nohdr = 1;
486 atomic_add(1 << SKB_DATAREF_SHIFT, &skb_shinfo(skb)->dataref);
487}
488
489/**
490 * skb_shared - is the buffer shared
491 * @skb: buffer to check
492 *
493 * Returns true if more than one person has a reference to this
494 * buffer.
495 */
496static inline int skb_shared(const struct sk_buff *skb)
497{
498 return atomic_read(&skb->users) != 1;
499}
500
501/**
502 * skb_share_check - check if buffer is shared and if so clone it
503 * @skb: buffer to check
504 * @pri: priority for memory allocation
505 *
506 * If the buffer is shared the buffer is cloned and the old copy
507 * drops a reference. A new clone with a single reference is returned.
508 * If the buffer is not shared the original buffer is returned. When
509 * being called from interrupt status or with spinlocks held pri must
510 * be GFP_ATOMIC.
511 *
512 * NULL is returned on a memory allocation failure.
513 */
Victor Fusco86a76ca2005-07-08 14:57:47 -0700514static inline struct sk_buff *skb_share_check(struct sk_buff *skb,
Al Virodd0fc662005-10-07 07:46:04 +0100515 gfp_t pri)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700516{
517 might_sleep_if(pri & __GFP_WAIT);
518 if (skb_shared(skb)) {
519 struct sk_buff *nskb = skb_clone(skb, pri);
520 kfree_skb(skb);
521 skb = nskb;
522 }
523 return skb;
524}
525
526/*
527 * Copy shared buffers into a new sk_buff. We effectively do COW on
528 * packets to handle cases where we have a local reader and forward
529 * and a couple of other messy ones. The normal one is tcpdumping
530 * a packet thats being forwarded.
531 */
532
533/**
534 * skb_unshare - make a copy of a shared buffer
535 * @skb: buffer to check
536 * @pri: priority for memory allocation
537 *
538 * If the socket buffer is a clone then this function creates a new
539 * copy of the data, drops a reference count on the old copy and returns
540 * the new copy with the reference count at 1. If the buffer is not a clone
541 * the original buffer is returned. When called with a spinlock held or
542 * from interrupt state @pri must be %GFP_ATOMIC
543 *
544 * %NULL is returned on a memory allocation failure.
545 */
Victor Fuscoe2bf5212005-07-18 13:36:38 -0700546static inline struct sk_buff *skb_unshare(struct sk_buff *skb,
Al Virodd0fc662005-10-07 07:46:04 +0100547 gfp_t pri)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700548{
549 might_sleep_if(pri & __GFP_WAIT);
550 if (skb_cloned(skb)) {
551 struct sk_buff *nskb = skb_copy(skb, pri);
552 kfree_skb(skb); /* Free our shared copy */
553 skb = nskb;
554 }
555 return skb;
556}
557
558/**
559 * skb_peek
560 * @list_: list to peek at
561 *
562 * Peek an &sk_buff. Unlike most other operations you _MUST_
563 * be careful with this one. A peek leaves the buffer on the
564 * list and someone else may run off with it. You must hold
565 * the appropriate locks or have a private queue to do this.
566 *
567 * Returns %NULL for an empty list or a pointer to the head element.
568 * The reference count is not incremented and the reference is therefore
569 * volatile. Use with caution.
570 */
571static inline struct sk_buff *skb_peek(struct sk_buff_head *list_)
572{
573 struct sk_buff *list = ((struct sk_buff *)list_)->next;
574 if (list == (struct sk_buff *)list_)
575 list = NULL;
576 return list;
577}
578
579/**
580 * skb_peek_tail
581 * @list_: list to peek at
582 *
583 * Peek an &sk_buff. Unlike most other operations you _MUST_
584 * be careful with this one. A peek leaves the buffer on the
585 * list and someone else may run off with it. You must hold
586 * the appropriate locks or have a private queue to do this.
587 *
588 * Returns %NULL for an empty list or a pointer to the tail element.
589 * The reference count is not incremented and the reference is therefore
590 * volatile. Use with caution.
591 */
592static inline struct sk_buff *skb_peek_tail(struct sk_buff_head *list_)
593{
594 struct sk_buff *list = ((struct sk_buff *)list_)->prev;
595 if (list == (struct sk_buff *)list_)
596 list = NULL;
597 return list;
598}
599
600/**
601 * skb_queue_len - get queue length
602 * @list_: list to measure
603 *
604 * Return the length of an &sk_buff queue.
605 */
606static inline __u32 skb_queue_len(const struct sk_buff_head *list_)
607{
608 return list_->qlen;
609}
610
Arjan van de Ven76f10ad2006-08-02 14:06:55 -0700611/*
612 * This function creates a split out lock class for each invocation;
613 * this is needed for now since a whole lot of users of the skb-queue
614 * infrastructure in drivers have different locking usage (in hardirq)
615 * than the networking core (in softirq only). In the long run either the
616 * network layer or drivers should need annotation to consolidate the
617 * main types of usage into 3 classes.
618 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700619static inline void skb_queue_head_init(struct sk_buff_head *list)
620{
621 spin_lock_init(&list->lock);
622 list->prev = list->next = (struct sk_buff *)list;
623 list->qlen = 0;
624}
625
626/*
627 * Insert an sk_buff at the start of a list.
628 *
629 * The "__skb_xxxx()" functions are the non-atomic ones that
630 * can only be called with interrupts disabled.
631 */
632
633/**
Stephen Hemminger300ce172005-10-30 13:47:34 -0800634 * __skb_queue_after - queue a buffer at the list head
635 * @list: list to use
636 * @prev: place after this buffer
637 * @newsk: buffer to queue
638 *
639 * Queue a buffer int the middle of a list. This function takes no locks
640 * and you must therefore hold required locks before calling it.
641 *
642 * A buffer cannot be placed on two lists at the same time.
643 */
644static inline void __skb_queue_after(struct sk_buff_head *list,
645 struct sk_buff *prev,
646 struct sk_buff *newsk)
647{
648 struct sk_buff *next;
649 list->qlen++;
650
651 next = prev->next;
652 newsk->next = next;
653 newsk->prev = prev;
654 next->prev = prev->next = newsk;
655}
656
657/**
Linus Torvalds1da177e2005-04-16 15:20:36 -0700658 * __skb_queue_head - queue a buffer at the list head
659 * @list: list to use
660 * @newsk: buffer to queue
661 *
662 * Queue a buffer at the start of a list. This function takes no locks
663 * and you must therefore hold required locks before calling it.
664 *
665 * A buffer cannot be placed on two lists at the same time.
666 */
667extern void skb_queue_head(struct sk_buff_head *list, struct sk_buff *newsk);
668static inline void __skb_queue_head(struct sk_buff_head *list,
669 struct sk_buff *newsk)
670{
Stephen Hemminger300ce172005-10-30 13:47:34 -0800671 __skb_queue_after(list, (struct sk_buff *)list, newsk);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700672}
673
674/**
675 * __skb_queue_tail - queue a buffer at the list tail
676 * @list: list to use
677 * @newsk: buffer to queue
678 *
679 * Queue a buffer at the end of a list. This function takes no locks
680 * and you must therefore hold required locks before calling it.
681 *
682 * A buffer cannot be placed on two lists at the same time.
683 */
684extern void skb_queue_tail(struct sk_buff_head *list, struct sk_buff *newsk);
685static inline void __skb_queue_tail(struct sk_buff_head *list,
686 struct sk_buff *newsk)
687{
688 struct sk_buff *prev, *next;
689
Linus Torvalds1da177e2005-04-16 15:20:36 -0700690 list->qlen++;
691 next = (struct sk_buff *)list;
692 prev = next->prev;
693 newsk->next = next;
694 newsk->prev = prev;
695 next->prev = prev->next = newsk;
696}
697
698
699/**
700 * __skb_dequeue - remove from the head of the queue
701 * @list: list to dequeue from
702 *
703 * Remove the head of the list. This function does not take any locks
704 * so must be used with appropriate locks held only. The head item is
705 * returned or %NULL if the list is empty.
706 */
707extern struct sk_buff *skb_dequeue(struct sk_buff_head *list);
708static inline struct sk_buff *__skb_dequeue(struct sk_buff_head *list)
709{
710 struct sk_buff *next, *prev, *result;
711
712 prev = (struct sk_buff *) list;
713 next = prev->next;
714 result = NULL;
715 if (next != prev) {
716 result = next;
717 next = next->next;
718 list->qlen--;
719 next->prev = prev;
720 prev->next = next;
721 result->next = result->prev = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700722 }
723 return result;
724}
725
726
727/*
728 * Insert a packet on a list.
729 */
David S. Miller8728b832005-08-09 19:25:21 -0700730extern void skb_insert(struct sk_buff *old, struct sk_buff *newsk, struct sk_buff_head *list);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700731static inline void __skb_insert(struct sk_buff *newsk,
732 struct sk_buff *prev, struct sk_buff *next,
733 struct sk_buff_head *list)
734{
735 newsk->next = next;
736 newsk->prev = prev;
737 next->prev = prev->next = newsk;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700738 list->qlen++;
739}
740
741/*
742 * Place a packet after a given packet in a list.
743 */
David S. Miller8728b832005-08-09 19:25:21 -0700744extern void skb_append(struct sk_buff *old, struct sk_buff *newsk, struct sk_buff_head *list);
745static inline void __skb_append(struct sk_buff *old, struct sk_buff *newsk, struct sk_buff_head *list)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700746{
David S. Miller8728b832005-08-09 19:25:21 -0700747 __skb_insert(newsk, old, old->next, list);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700748}
749
750/*
751 * remove sk_buff from list. _Must_ be called atomically, and with
752 * the list known..
753 */
David S. Miller8728b832005-08-09 19:25:21 -0700754extern void skb_unlink(struct sk_buff *skb, struct sk_buff_head *list);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700755static inline void __skb_unlink(struct sk_buff *skb, struct sk_buff_head *list)
756{
757 struct sk_buff *next, *prev;
758
759 list->qlen--;
760 next = skb->next;
761 prev = skb->prev;
762 skb->next = skb->prev = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700763 next->prev = prev;
764 prev->next = next;
765}
766
767
768/* XXX: more streamlined implementation */
769
770/**
771 * __skb_dequeue_tail - remove from the tail of the queue
772 * @list: list to dequeue from
773 *
774 * Remove the tail of the list. This function does not take any locks
775 * so must be used with appropriate locks held only. The tail item is
776 * returned or %NULL if the list is empty.
777 */
778extern struct sk_buff *skb_dequeue_tail(struct sk_buff_head *list);
779static inline struct sk_buff *__skb_dequeue_tail(struct sk_buff_head *list)
780{
781 struct sk_buff *skb = skb_peek_tail(list);
782 if (skb)
783 __skb_unlink(skb, list);
784 return skb;
785}
786
787
788static inline int skb_is_nonlinear(const struct sk_buff *skb)
789{
790 return skb->data_len;
791}
792
793static inline unsigned int skb_headlen(const struct sk_buff *skb)
794{
795 return skb->len - skb->data_len;
796}
797
798static inline int skb_pagelen(const struct sk_buff *skb)
799{
800 int i, len = 0;
801
802 for (i = (int)skb_shinfo(skb)->nr_frags - 1; i >= 0; i--)
803 len += skb_shinfo(skb)->frags[i].size;
804 return len + skb_headlen(skb);
805}
806
807static inline void skb_fill_page_desc(struct sk_buff *skb, int i,
808 struct page *page, int off, int size)
809{
810 skb_frag_t *frag = &skb_shinfo(skb)->frags[i];
811
812 frag->page = page;
813 frag->page_offset = off;
814 frag->size = size;
815 skb_shinfo(skb)->nr_frags = i + 1;
816}
817
818#define SKB_PAGE_ASSERT(skb) BUG_ON(skb_shinfo(skb)->nr_frags)
819#define SKB_FRAG_ASSERT(skb) BUG_ON(skb_shinfo(skb)->frag_list)
820#define SKB_LINEAR_ASSERT(skb) BUG_ON(skb_is_nonlinear(skb))
821
822/*
823 * Add data to an sk_buff
824 */
825static inline unsigned char *__skb_put(struct sk_buff *skb, unsigned int len)
826{
827 unsigned char *tmp = skb->tail;
828 SKB_LINEAR_ASSERT(skb);
829 skb->tail += len;
830 skb->len += len;
831 return tmp;
832}
833
834/**
835 * skb_put - add data to a buffer
836 * @skb: buffer to use
837 * @len: amount of data to add
838 *
839 * This function extends the used data area of the buffer. If this would
840 * exceed the total buffer size the kernel will panic. A pointer to the
841 * first byte of the extra data is returned.
842 */
843static inline unsigned char *skb_put(struct sk_buff *skb, unsigned int len)
844{
845 unsigned char *tmp = skb->tail;
846 SKB_LINEAR_ASSERT(skb);
847 skb->tail += len;
848 skb->len += len;
849 if (unlikely(skb->tail>skb->end))
850 skb_over_panic(skb, len, current_text_addr());
851 return tmp;
852}
853
854static inline unsigned char *__skb_push(struct sk_buff *skb, unsigned int len)
855{
856 skb->data -= len;
857 skb->len += len;
858 return skb->data;
859}
860
861/**
862 * skb_push - add data to the start of a buffer
863 * @skb: buffer to use
864 * @len: amount of data to add
865 *
866 * This function extends the used data area of the buffer at the buffer
867 * start. If this would exceed the total buffer headroom the kernel will
868 * panic. A pointer to the first byte of the extra data is returned.
869 */
870static inline unsigned char *skb_push(struct sk_buff *skb, unsigned int len)
871{
872 skb->data -= len;
873 skb->len += len;
874 if (unlikely(skb->data<skb->head))
875 skb_under_panic(skb, len, current_text_addr());
876 return skb->data;
877}
878
879static inline unsigned char *__skb_pull(struct sk_buff *skb, unsigned int len)
880{
881 skb->len -= len;
882 BUG_ON(skb->len < skb->data_len);
883 return skb->data += len;
884}
885
886/**
887 * skb_pull - remove data from the start of a buffer
888 * @skb: buffer to use
889 * @len: amount of data to remove
890 *
891 * This function removes data from the start of a buffer, returning
892 * the memory to the headroom. A pointer to the next data in the buffer
893 * is returned. Once the data has been pulled future pushes will overwrite
894 * the old data.
895 */
896static inline unsigned char *skb_pull(struct sk_buff *skb, unsigned int len)
897{
898 return unlikely(len > skb->len) ? NULL : __skb_pull(skb, len);
899}
900
901extern unsigned char *__pskb_pull_tail(struct sk_buff *skb, int delta);
902
903static inline unsigned char *__pskb_pull(struct sk_buff *skb, unsigned int len)
904{
905 if (len > skb_headlen(skb) &&
906 !__pskb_pull_tail(skb, len-skb_headlen(skb)))
907 return NULL;
908 skb->len -= len;
909 return skb->data += len;
910}
911
912static inline unsigned char *pskb_pull(struct sk_buff *skb, unsigned int len)
913{
914 return unlikely(len > skb->len) ? NULL : __pskb_pull(skb, len);
915}
916
917static inline int pskb_may_pull(struct sk_buff *skb, unsigned int len)
918{
919 if (likely(len <= skb_headlen(skb)))
920 return 1;
921 if (unlikely(len > skb->len))
922 return 0;
923 return __pskb_pull_tail(skb, len-skb_headlen(skb)) != NULL;
924}
925
926/**
927 * skb_headroom - bytes at buffer head
928 * @skb: buffer to check
929 *
930 * Return the number of bytes of free space at the head of an &sk_buff.
931 */
932static inline int skb_headroom(const struct sk_buff *skb)
933{
934 return skb->data - skb->head;
935}
936
937/**
938 * skb_tailroom - bytes at buffer end
939 * @skb: buffer to check
940 *
941 * Return the number of bytes of free space at the tail of an sk_buff
942 */
943static inline int skb_tailroom(const struct sk_buff *skb)
944{
945 return skb_is_nonlinear(skb) ? 0 : skb->end - skb->tail;
946}
947
948/**
949 * skb_reserve - adjust headroom
950 * @skb: buffer to alter
951 * @len: bytes to move
952 *
953 * Increase the headroom of an empty &sk_buff by reducing the tail
954 * room. This is only allowed for an empty buffer.
955 */
David S. Miller8243126c2006-01-17 02:54:21 -0800956static inline void skb_reserve(struct sk_buff *skb, int len)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700957{
958 skb->data += len;
959 skb->tail += len;
960}
961
962/*
963 * CPUs often take a performance hit when accessing unaligned memory
964 * locations. The actual performance hit varies, it can be small if the
965 * hardware handles it or large if we have to take an exception and fix it
966 * in software.
967 *
968 * Since an ethernet header is 14 bytes network drivers often end up with
969 * the IP header at an unaligned offset. The IP header can be aligned by
970 * shifting the start of the packet by 2 bytes. Drivers should do this
971 * with:
972 *
973 * skb_reserve(NET_IP_ALIGN);
974 *
975 * The downside to this alignment of the IP header is that the DMA is now
976 * unaligned. On some architectures the cost of an unaligned DMA is high
977 * and this cost outweighs the gains made by aligning the IP header.
978 *
979 * Since this trade off varies between architectures, we allow NET_IP_ALIGN
980 * to be overridden.
981 */
982#ifndef NET_IP_ALIGN
983#define NET_IP_ALIGN 2
984#endif
985
Anton Blanchard025be812006-03-31 02:27:06 -0800986/*
987 * The networking layer reserves some headroom in skb data (via
988 * dev_alloc_skb). This is used to avoid having to reallocate skb data when
989 * the header has to grow. In the default case, if the header has to grow
990 * 16 bytes or less we avoid the reallocation.
991 *
992 * Unfortunately this headroom changes the DMA alignment of the resulting
993 * network packet. As for NET_IP_ALIGN, this unaligned DMA is expensive
994 * on some architectures. An architecture can override this value,
995 * perhaps setting it to a cacheline in size (since that will maintain
996 * cacheline alignment of the DMA). It must be a power of 2.
997 *
998 * Various parts of the networking layer expect at least 16 bytes of
999 * headroom, you should not reduce this.
1000 */
1001#ifndef NET_SKB_PAD
1002#define NET_SKB_PAD 16
1003#endif
1004
Herbert Xu3cc0e872006-06-09 16:13:38 -07001005extern int ___pskb_trim(struct sk_buff *skb, unsigned int len);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001006
1007static inline void __skb_trim(struct sk_buff *skb, unsigned int len)
1008{
Herbert Xu3cc0e872006-06-09 16:13:38 -07001009 if (unlikely(skb->data_len)) {
1010 WARN_ON(1);
1011 return;
1012 }
1013 skb->len = len;
1014 skb->tail = skb->data + len;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001015}
1016
1017/**
1018 * skb_trim - remove end from a buffer
1019 * @skb: buffer to alter
1020 * @len: new length
1021 *
1022 * Cut the length of a buffer down by removing data from the tail. If
1023 * the buffer is already under the length specified it is not modified.
Herbert Xu3cc0e872006-06-09 16:13:38 -07001024 * The skb must be linear.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001025 */
1026static inline void skb_trim(struct sk_buff *skb, unsigned int len)
1027{
1028 if (skb->len > len)
1029 __skb_trim(skb, len);
1030}
1031
1032
1033static inline int __pskb_trim(struct sk_buff *skb, unsigned int len)
1034{
Herbert Xu3cc0e872006-06-09 16:13:38 -07001035 if (skb->data_len)
1036 return ___pskb_trim(skb, len);
1037 __skb_trim(skb, len);
1038 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001039}
1040
1041static inline int pskb_trim(struct sk_buff *skb, unsigned int len)
1042{
1043 return (len < skb->len) ? __pskb_trim(skb, len) : 0;
1044}
1045
1046/**
Herbert Xue9fa4f72006-08-13 20:12:58 -07001047 * pskb_trim_unique - remove end from a paged unique (not cloned) buffer
1048 * @skb: buffer to alter
1049 * @len: new length
1050 *
1051 * This is identical to pskb_trim except that the caller knows that
1052 * the skb is not cloned so we should never get an error due to out-
1053 * of-memory.
1054 */
1055static inline void pskb_trim_unique(struct sk_buff *skb, unsigned int len)
1056{
1057 int err = pskb_trim(skb, len);
1058 BUG_ON(err);
1059}
1060
1061/**
Linus Torvalds1da177e2005-04-16 15:20:36 -07001062 * skb_orphan - orphan a buffer
1063 * @skb: buffer to orphan
1064 *
1065 * If a buffer currently has an owner then we call the owner's
1066 * destructor function and make the @skb unowned. The buffer continues
1067 * to exist but is no longer charged to its former owner.
1068 */
1069static inline void skb_orphan(struct sk_buff *skb)
1070{
1071 if (skb->destructor)
1072 skb->destructor(skb);
1073 skb->destructor = NULL;
1074 skb->sk = NULL;
1075}
1076
1077/**
1078 * __skb_queue_purge - empty a list
1079 * @list: list to empty
1080 *
1081 * Delete all buffers on an &sk_buff list. Each buffer is removed from
1082 * the list and one reference dropped. This function does not take the
1083 * list lock and the caller must hold the relevant locks to use it.
1084 */
1085extern void skb_queue_purge(struct sk_buff_head *list);
1086static inline void __skb_queue_purge(struct sk_buff_head *list)
1087{
1088 struct sk_buff *skb;
1089 while ((skb = __skb_dequeue(list)) != NULL)
1090 kfree_skb(skb);
1091}
1092
1093/**
Christoph Hellwigb4e54de2006-07-24 15:31:14 -07001094 * __dev_alloc_skb - allocate an skbuff for receiving
Linus Torvalds1da177e2005-04-16 15:20:36 -07001095 * @length: length to allocate
1096 * @gfp_mask: get_free_pages mask, passed to alloc_skb
1097 *
1098 * Allocate a new &sk_buff and assign it a usage count of one. The
1099 * buffer has unspecified headroom built in. Users should allocate
1100 * the headroom they think they need without accounting for the
1101 * built in space. The built in space is used for optimisations.
1102 *
Christoph Hellwig766ea8c2006-08-07 15:49:53 -07001103 * %NULL is returned if there is no free memory.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001104 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001105static inline struct sk_buff *__dev_alloc_skb(unsigned int length,
Al Virodd0fc662005-10-07 07:46:04 +01001106 gfp_t gfp_mask)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001107{
Anton Blanchard025be812006-03-31 02:27:06 -08001108 struct sk_buff *skb = alloc_skb(length + NET_SKB_PAD, gfp_mask);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001109 if (likely(skb))
Anton Blanchard025be812006-03-31 02:27:06 -08001110 skb_reserve(skb, NET_SKB_PAD);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001111 return skb;
1112}
Linus Torvalds1da177e2005-04-16 15:20:36 -07001113
1114/**
Christoph Hellwigb4e54de2006-07-24 15:31:14 -07001115 * dev_alloc_skb - allocate an skbuff for receiving
Linus Torvalds1da177e2005-04-16 15:20:36 -07001116 * @length: length to allocate
1117 *
1118 * Allocate a new &sk_buff and assign it a usage count of one. The
1119 * buffer has unspecified headroom built in. Users should allocate
1120 * the headroom they think they need without accounting for the
1121 * built in space. The built in space is used for optimisations.
1122 *
Christoph Hellwig766ea8c2006-08-07 15:49:53 -07001123 * %NULL is returned if there is no free memory. Although this function
Linus Torvalds1da177e2005-04-16 15:20:36 -07001124 * allocates memory it can be called from an interrupt.
1125 */
1126static inline struct sk_buff *dev_alloc_skb(unsigned int length)
1127{
1128 return __dev_alloc_skb(length, GFP_ATOMIC);
1129}
1130
Christoph Hellwig8af27452006-07-31 22:35:23 -07001131extern struct sk_buff *__netdev_alloc_skb(struct net_device *dev,
1132 unsigned int length, gfp_t gfp_mask);
1133
1134/**
1135 * netdev_alloc_skb - allocate an skbuff for rx on a specific device
1136 * @dev: network device to receive on
1137 * @length: length to allocate
1138 *
1139 * Allocate a new &sk_buff and assign it a usage count of one. The
1140 * buffer has unspecified headroom built in. Users should allocate
1141 * the headroom they think they need without accounting for the
1142 * built in space. The built in space is used for optimisations.
1143 *
1144 * %NULL is returned if there is no free memory. Although this function
1145 * allocates memory it can be called from an interrupt.
1146 */
1147static inline struct sk_buff *netdev_alloc_skb(struct net_device *dev,
1148 unsigned int length)
1149{
1150 return __netdev_alloc_skb(dev, length, GFP_ATOMIC);
1151}
1152
Linus Torvalds1da177e2005-04-16 15:20:36 -07001153/**
1154 * skb_cow - copy header of skb when it is required
1155 * @skb: buffer to cow
1156 * @headroom: needed headroom
1157 *
1158 * If the skb passed lacks sufficient headroom or its data part
1159 * is shared, data is reallocated. If reallocation fails, an error
1160 * is returned and original skb is not changed.
1161 *
1162 * The result is skb with writable area skb->head...skb->tail
1163 * and at least @headroom of space at head.
1164 */
1165static inline int skb_cow(struct sk_buff *skb, unsigned int headroom)
1166{
Anton Blanchard025be812006-03-31 02:27:06 -08001167 int delta = (headroom > NET_SKB_PAD ? headroom : NET_SKB_PAD) -
1168 skb_headroom(skb);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001169
1170 if (delta < 0)
1171 delta = 0;
1172
1173 if (delta || skb_cloned(skb))
Anton Blanchard025be812006-03-31 02:27:06 -08001174 return pskb_expand_head(skb, (delta + (NET_SKB_PAD-1)) &
1175 ~(NET_SKB_PAD-1), 0, GFP_ATOMIC);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001176 return 0;
1177}
1178
1179/**
1180 * skb_padto - pad an skbuff up to a minimal size
1181 * @skb: buffer to pad
1182 * @len: minimal length
1183 *
1184 * Pads up a buffer to ensure the trailing bytes exist and are
1185 * blanked. If the buffer already contains sufficient data it
Herbert Xu5b057c62006-06-23 02:06:41 -07001186 * is untouched. Otherwise it is extended. Returns zero on
1187 * success. The skb is freed on error.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001188 */
1189
Herbert Xu5b057c62006-06-23 02:06:41 -07001190static inline int skb_padto(struct sk_buff *skb, unsigned int len)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001191{
1192 unsigned int size = skb->len;
1193 if (likely(size >= len))
Herbert Xu5b057c62006-06-23 02:06:41 -07001194 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001195 return skb_pad(skb, len-size);
1196}
1197
1198static inline int skb_add_data(struct sk_buff *skb,
1199 char __user *from, int copy)
1200{
1201 const int off = skb->len;
1202
1203 if (skb->ip_summed == CHECKSUM_NONE) {
1204 int err = 0;
Al Viro50842052006-11-14 21:36:34 -08001205 __wsum csum = csum_and_copy_from_user(from, skb_put(skb, copy),
Linus Torvalds1da177e2005-04-16 15:20:36 -07001206 copy, 0, &err);
1207 if (!err) {
1208 skb->csum = csum_block_add(skb->csum, csum, off);
1209 return 0;
1210 }
1211 } else if (!copy_from_user(skb_put(skb, copy), from, copy))
1212 return 0;
1213
1214 __skb_trim(skb, off);
1215 return -EFAULT;
1216}
1217
1218static inline int skb_can_coalesce(struct sk_buff *skb, int i,
1219 struct page *page, int off)
1220{
1221 if (i) {
1222 struct skb_frag_struct *frag = &skb_shinfo(skb)->frags[i - 1];
1223
1224 return page == frag->page &&
1225 off == frag->page_offset + frag->size;
1226 }
1227 return 0;
1228}
1229
Herbert Xu364c6ba2006-06-09 16:10:40 -07001230static inline int __skb_linearize(struct sk_buff *skb)
1231{
1232 return __pskb_pull_tail(skb, skb->data_len) ? 0 : -ENOMEM;
1233}
1234
Linus Torvalds1da177e2005-04-16 15:20:36 -07001235/**
1236 * skb_linearize - convert paged skb to linear one
1237 * @skb: buffer to linarize
Linus Torvalds1da177e2005-04-16 15:20:36 -07001238 *
1239 * If there is no free memory -ENOMEM is returned, otherwise zero
1240 * is returned and the old skb data released.
1241 */
Herbert Xu364c6ba2006-06-09 16:10:40 -07001242static inline int skb_linearize(struct sk_buff *skb)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001243{
Herbert Xu364c6ba2006-06-09 16:10:40 -07001244 return skb_is_nonlinear(skb) ? __skb_linearize(skb) : 0;
1245}
1246
1247/**
1248 * skb_linearize_cow - make sure skb is linear and writable
1249 * @skb: buffer to process
1250 *
1251 * If there is no free memory -ENOMEM is returned, otherwise zero
1252 * is returned and the old skb data released.
1253 */
1254static inline int skb_linearize_cow(struct sk_buff *skb)
1255{
1256 return skb_is_nonlinear(skb) || skb_cloned(skb) ?
1257 __skb_linearize(skb) : 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001258}
1259
1260/**
1261 * skb_postpull_rcsum - update checksum for received skb after pull
1262 * @skb: buffer to update
1263 * @start: start of data before pull
1264 * @len: length of data pulled
1265 *
1266 * After doing a pull on a received packet, you need to call this to
Patrick McHardy84fa7932006-08-29 16:44:56 -07001267 * update the CHECKSUM_COMPLETE checksum, or set ip_summed to
1268 * CHECKSUM_NONE so that it can be recomputed from scratch.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001269 */
1270
1271static inline void skb_postpull_rcsum(struct sk_buff *skb,
Herbert Xucbb042f2006-03-20 22:43:56 -08001272 const void *start, unsigned int len)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001273{
Patrick McHardy84fa7932006-08-29 16:44:56 -07001274 if (skb->ip_summed == CHECKSUM_COMPLETE)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001275 skb->csum = csum_sub(skb->csum, csum_partial(start, len, 0));
1276}
1277
Herbert Xucbb042f2006-03-20 22:43:56 -08001278unsigned char *skb_pull_rcsum(struct sk_buff *skb, unsigned int len);
1279
Linus Torvalds1da177e2005-04-16 15:20:36 -07001280/**
1281 * pskb_trim_rcsum - trim received skb and update checksum
1282 * @skb: buffer to trim
1283 * @len: new length
1284 *
1285 * This is exactly the same as pskb_trim except that it ensures the
1286 * checksum of received packets are still valid after the operation.
1287 */
1288
1289static inline int pskb_trim_rcsum(struct sk_buff *skb, unsigned int len)
1290{
Stephen Hemminger0e4e4222005-09-08 12:32:03 -07001291 if (likely(len >= skb->len))
Linus Torvalds1da177e2005-04-16 15:20:36 -07001292 return 0;
Patrick McHardy84fa7932006-08-29 16:44:56 -07001293 if (skb->ip_summed == CHECKSUM_COMPLETE)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001294 skb->ip_summed = CHECKSUM_NONE;
1295 return __pskb_trim(skb, len);
1296}
1297
1298static inline void *kmap_skb_frag(const skb_frag_t *frag)
1299{
1300#ifdef CONFIG_HIGHMEM
1301 BUG_ON(in_irq());
1302
1303 local_bh_disable();
1304#endif
1305 return kmap_atomic(frag->page, KM_SKB_DATA_SOFTIRQ);
1306}
1307
1308static inline void kunmap_skb_frag(void *vaddr)
1309{
1310 kunmap_atomic(vaddr, KM_SKB_DATA_SOFTIRQ);
1311#ifdef CONFIG_HIGHMEM
1312 local_bh_enable();
1313#endif
1314}
1315
1316#define skb_queue_walk(queue, skb) \
1317 for (skb = (queue)->next; \
1318 prefetch(skb->next), (skb != (struct sk_buff *)(queue)); \
1319 skb = skb->next)
1320
Stephen Hemminger300ce172005-10-30 13:47:34 -08001321#define skb_queue_reverse_walk(queue, skb) \
1322 for (skb = (queue)->prev; \
1323 prefetch(skb->prev), (skb != (struct sk_buff *)(queue)); \
1324 skb = skb->prev)
1325
Linus Torvalds1da177e2005-04-16 15:20:36 -07001326
1327extern struct sk_buff *skb_recv_datagram(struct sock *sk, unsigned flags,
1328 int noblock, int *err);
1329extern unsigned int datagram_poll(struct file *file, struct socket *sock,
1330 struct poll_table_struct *wait);
1331extern int skb_copy_datagram_iovec(const struct sk_buff *from,
1332 int offset, struct iovec *to,
1333 int size);
Herbert Xufb286bb2005-11-10 13:01:24 -08001334extern int skb_copy_and_csum_datagram_iovec(struct sk_buff *skb,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001335 int hlen,
1336 struct iovec *iov);
1337extern void skb_free_datagram(struct sock *sk, struct sk_buff *skb);
Herbert Xu3305b802005-12-13 23:16:37 -08001338extern void skb_kill_datagram(struct sock *sk, struct sk_buff *skb,
1339 unsigned int flags);
Al Viro2bbbc862006-11-14 21:37:14 -08001340extern __wsum skb_checksum(const struct sk_buff *skb, int offset,
1341 int len, __wsum csum);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001342extern int skb_copy_bits(const struct sk_buff *skb, int offset,
1343 void *to, int len);
Herbert Xu357b40a2005-04-19 22:30:14 -07001344extern int skb_store_bits(const struct sk_buff *skb, int offset,
1345 void *from, int len);
Al Viro81d77662006-11-14 21:37:33 -08001346extern __wsum skb_copy_and_csum_bits(const struct sk_buff *skb,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001347 int offset, u8 *to, int len,
Al Viro81d77662006-11-14 21:37:33 -08001348 __wsum csum);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001349extern void skb_copy_and_csum_dev(const struct sk_buff *skb, u8 *to);
1350extern void skb_split(struct sk_buff *skb,
1351 struct sk_buff *skb1, const u32 len);
1352
Herbert Xu576a30e2006-06-27 13:22:38 -07001353extern struct sk_buff *skb_segment(struct sk_buff *skb, int features);
Arnaldo Carvalho de Melo20380732005-08-16 02:18:02 -03001354
Linus Torvalds1da177e2005-04-16 15:20:36 -07001355static inline void *skb_header_pointer(const struct sk_buff *skb, int offset,
1356 int len, void *buffer)
1357{
1358 int hlen = skb_headlen(skb);
1359
Patrick McHardy55820ee2005-07-05 14:08:10 -07001360 if (hlen - offset >= len)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001361 return skb->data + offset;
1362
1363 if (skb_copy_bits(skb, offset, buffer, len) < 0)
1364 return NULL;
1365
1366 return buffer;
1367}
1368
1369extern void skb_init(void);
1370extern void skb_add_mtu(int mtu);
1371
Patrick McHardya61bbcf2005-08-14 17:24:31 -07001372/**
1373 * skb_get_timestamp - get timestamp from a skb
1374 * @skb: skb to get stamp from
1375 * @stamp: pointer to struct timeval to store stamp in
1376 *
1377 * Timestamps are stored in the skb as offsets to a base timestamp.
1378 * This function converts the offset back to a struct timeval and stores
1379 * it in stamp.
1380 */
Stephen Hemmingerf2c38392005-09-06 15:48:03 -07001381static inline void skb_get_timestamp(const struct sk_buff *skb, struct timeval *stamp)
Patrick McHardya61bbcf2005-08-14 17:24:31 -07001382{
1383 stamp->tv_sec = skb->tstamp.off_sec;
1384 stamp->tv_usec = skb->tstamp.off_usec;
Patrick McHardya61bbcf2005-08-14 17:24:31 -07001385}
1386
1387/**
1388 * skb_set_timestamp - set timestamp of a skb
1389 * @skb: skb to set stamp of
1390 * @stamp: pointer to struct timeval to get stamp from
1391 *
1392 * Timestamps are stored in the skb as offsets to a base timestamp.
1393 * This function converts a struct timeval to an offset and stores
1394 * it in the skb.
1395 */
Stephen Hemmingerf2c38392005-09-06 15:48:03 -07001396static inline void skb_set_timestamp(struct sk_buff *skb, const struct timeval *stamp)
Patrick McHardya61bbcf2005-08-14 17:24:31 -07001397{
Herbert Xu325ed822005-10-03 13:57:23 -07001398 skb->tstamp.off_sec = stamp->tv_sec;
1399 skb->tstamp.off_usec = stamp->tv_usec;
Patrick McHardya61bbcf2005-08-14 17:24:31 -07001400}
1401
1402extern void __net_timestamp(struct sk_buff *skb);
1403
Al Virob51655b2006-11-14 21:40:42 -08001404extern __sum16 __skb_checksum_complete(struct sk_buff *skb);
Herbert Xufb286bb2005-11-10 13:01:24 -08001405
1406/**
1407 * skb_checksum_complete - Calculate checksum of an entire packet
1408 * @skb: packet to process
1409 *
1410 * This function calculates the checksum over the entire packet plus
1411 * the value of skb->csum. The latter can be used to supply the
1412 * checksum of a pseudo header as used by TCP/UDP. It returns the
1413 * checksum.
1414 *
1415 * For protocols that contain complete checksums such as ICMP/TCP/UDP,
1416 * this function can be used to verify that checksum on received
1417 * packets. In that case the function should return zero if the
1418 * checksum is correct. In particular, this function will return zero
1419 * if skb->ip_summed is CHECKSUM_UNNECESSARY which indicates that the
1420 * hardware has already verified the correctness of the checksum.
1421 */
1422static inline unsigned int skb_checksum_complete(struct sk_buff *skb)
1423{
1424 return skb->ip_summed != CHECKSUM_UNNECESSARY &&
1425 __skb_checksum_complete(skb);
1426}
1427
Linus Torvalds1da177e2005-04-16 15:20:36 -07001428#ifdef CONFIG_NETFILTER
1429static inline void nf_conntrack_put(struct nf_conntrack *nfct)
1430{
1431 if (nfct && atomic_dec_and_test(&nfct->use))
1432 nfct->destroy(nfct);
1433}
1434static inline void nf_conntrack_get(struct nf_conntrack *nfct)
1435{
1436 if (nfct)
1437 atomic_inc(&nfct->use);
1438}
Yasuyuki Kozakai9fb9cbb2005-11-09 16:38:16 -08001439#if defined(CONFIG_NF_CONNTRACK) || defined(CONFIG_NF_CONNTRACK_MODULE)
1440static inline void nf_conntrack_get_reasm(struct sk_buff *skb)
1441{
1442 if (skb)
1443 atomic_inc(&skb->users);
1444}
1445static inline void nf_conntrack_put_reasm(struct sk_buff *skb)
1446{
1447 if (skb)
1448 kfree_skb(skb);
1449}
1450#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -07001451#ifdef CONFIG_BRIDGE_NETFILTER
1452static inline void nf_bridge_put(struct nf_bridge_info *nf_bridge)
1453{
1454 if (nf_bridge && atomic_dec_and_test(&nf_bridge->use))
1455 kfree(nf_bridge);
1456}
1457static inline void nf_bridge_get(struct nf_bridge_info *nf_bridge)
1458{
1459 if (nf_bridge)
1460 atomic_inc(&nf_bridge->use);
1461}
1462#endif /* CONFIG_BRIDGE_NETFILTER */
Patrick McHardya193a4a2006-03-20 19:23:05 -08001463static inline void nf_reset(struct sk_buff *skb)
1464{
1465 nf_conntrack_put(skb->nfct);
1466 skb->nfct = NULL;
1467#if defined(CONFIG_NF_CONNTRACK) || defined(CONFIG_NF_CONNTRACK_MODULE)
1468 nf_conntrack_put_reasm(skb->nfct_reasm);
1469 skb->nfct_reasm = NULL;
1470#endif
1471#ifdef CONFIG_BRIDGE_NETFILTER
1472 nf_bridge_put(skb->nf_bridge);
1473 skb->nf_bridge = NULL;
1474#endif
1475}
1476
Linus Torvalds1da177e2005-04-16 15:20:36 -07001477#else /* CONFIG_NETFILTER */
1478static inline void nf_reset(struct sk_buff *skb) {}
1479#endif /* CONFIG_NETFILTER */
1480
James Morris984bc162006-06-09 00:29:17 -07001481#ifdef CONFIG_NETWORK_SECMARK
1482static inline void skb_copy_secmark(struct sk_buff *to, const struct sk_buff *from)
1483{
1484 to->secmark = from->secmark;
1485}
1486
1487static inline void skb_init_secmark(struct sk_buff *skb)
1488{
1489 skb->secmark = 0;
1490}
1491#else
1492static inline void skb_copy_secmark(struct sk_buff *to, const struct sk_buff *from)
1493{ }
1494
1495static inline void skb_init_secmark(struct sk_buff *skb)
1496{ }
1497#endif
1498
Herbert Xu89114af2006-07-08 13:34:32 -07001499static inline int skb_is_gso(const struct sk_buff *skb)
1500{
1501 return skb_shinfo(skb)->gso_size;
1502}
1503
Linus Torvalds1da177e2005-04-16 15:20:36 -07001504#endif /* __KERNEL__ */
1505#endif /* _LINUX_SKBUFF_H */