blob: 64fa7f4c702dbb373254af88e5d15915ccf8ce40 [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,
276 mac_len,
277 csum;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700278 __u32 priority;
Thomas Graf1cbb3382005-07-05 14:13:41 -0700279 __u8 local_df:1,
280 cloned:1,
281 ip_summed:2,
Harald Welte6869c4d2005-08-09 19:24:19 -0700282 nohdr:1,
283 nfctinfo:3;
David S. Millerd179cd12005-08-17 14:57:30 -0700284 __u8 pkt_type:3,
Patrick McHardyb84f4cc2005-11-20 21:19:21 -0800285 fclone:2,
286 ipvs_property:1;
Alexey Dobriyana0d3bea2005-08-11 16:05:50 -0700287 __be16 protocol;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700288
289 void (*destructor)(struct sk_buff *skb);
290#ifdef CONFIG_NETFILTER
Linus Torvalds1da177e2005-04-16 15:20:36 -0700291 struct nf_conntrack *nfct;
Yasuyuki Kozakai9fb9cbb2005-11-09 16:38:16 -0800292#if defined(CONFIG_NF_CONNTRACK) || defined(CONFIG_NF_CONNTRACK_MODULE)
293 struct sk_buff *nfct_reasm;
294#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -0700295#ifdef CONFIG_BRIDGE_NETFILTER
296 struct nf_bridge_info *nf_bridge;
297#endif
298#endif /* CONFIG_NETFILTER */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700299#ifdef CONFIG_NET_SCHED
Patrick McHardyb6b99eb2005-08-09 19:33:51 -0700300 __u16 tc_index; /* traffic control index */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700301#ifdef CONFIG_NET_CLS_ACT
Patrick McHardyb6b99eb2005-08-09 19:33:51 -0700302 __u16 tc_verd; /* traffic control verdict */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700303#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -0700304#endif
Chris Leech97fc2f02006-05-23 17:55:33 -0700305#ifdef CONFIG_NET_DMA
306 dma_cookie_t dma_cookie;
307#endif
James Morris984bc162006-06-09 00:29:17 -0700308#ifdef CONFIG_NETWORK_SECMARK
309 __u32 secmark;
310#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -0700311
Thomas Graf82e91ff2006-11-09 15:19:14 -0800312 __u32 mark;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700313
314 /* These elements must be at the end, see alloc_skb() for details. */
315 unsigned int truesize;
316 atomic_t users;
317 unsigned char *head,
318 *data,
319 *tail,
320 *end;
321};
322
323#ifdef __KERNEL__
324/*
325 * Handling routines are only of interest to the kernel
326 */
327#include <linux/slab.h>
328
329#include <asm/system.h>
330
Jörn Engel231d06a2006-03-20 21:28:35 -0800331extern void kfree_skb(struct sk_buff *skb);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700332extern void __kfree_skb(struct sk_buff *skb);
David S. Millerd179cd12005-08-17 14:57:30 -0700333extern struct sk_buff *__alloc_skb(unsigned int size,
Al Virodd0fc662005-10-07 07:46:04 +0100334 gfp_t priority, int fclone);
David S. Millerd179cd12005-08-17 14:57:30 -0700335static inline struct sk_buff *alloc_skb(unsigned int size,
Al Virodd0fc662005-10-07 07:46:04 +0100336 gfp_t priority)
David S. Millerd179cd12005-08-17 14:57:30 -0700337{
338 return __alloc_skb(size, priority, 0);
339}
340
341static inline struct sk_buff *alloc_skb_fclone(unsigned int size,
Al Virodd0fc662005-10-07 07:46:04 +0100342 gfp_t priority)
David S. Millerd179cd12005-08-17 14:57:30 -0700343{
344 return __alloc_skb(size, priority, 1);
345}
346
Linus Torvalds1da177e2005-04-16 15:20:36 -0700347extern struct sk_buff *alloc_skb_from_cache(kmem_cache_t *cp,
Victor Fusco86a76ca2005-07-08 14:57:47 -0700348 unsigned int size,
Al Virodd0fc662005-10-07 07:46:04 +0100349 gfp_t priority);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700350extern void kfree_skbmem(struct sk_buff *skb);
Victor Fusco86a76ca2005-07-08 14:57:47 -0700351extern struct sk_buff *skb_clone(struct sk_buff *skb,
Al Virodd0fc662005-10-07 07:46:04 +0100352 gfp_t priority);
Victor Fusco86a76ca2005-07-08 14:57:47 -0700353extern struct sk_buff *skb_copy(const struct sk_buff *skb,
Al Virodd0fc662005-10-07 07:46:04 +0100354 gfp_t priority);
Victor Fusco86a76ca2005-07-08 14:57:47 -0700355extern struct sk_buff *pskb_copy(struct sk_buff *skb,
Al Virodd0fc662005-10-07 07:46:04 +0100356 gfp_t gfp_mask);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700357extern int pskb_expand_head(struct sk_buff *skb,
Victor Fusco86a76ca2005-07-08 14:57:47 -0700358 int nhead, int ntail,
Al Virodd0fc662005-10-07 07:46:04 +0100359 gfp_t gfp_mask);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700360extern struct sk_buff *skb_realloc_headroom(struct sk_buff *skb,
361 unsigned int headroom);
362extern struct sk_buff *skb_copy_expand(const struct sk_buff *skb,
363 int newheadroom, int newtailroom,
Al Virodd0fc662005-10-07 07:46:04 +0100364 gfp_t priority);
Herbert Xu5b057c62006-06-23 02:06:41 -0700365extern int skb_pad(struct sk_buff *skb, int pad);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700366#define dev_kfree_skb(a) kfree_skb(a)
367extern void skb_over_panic(struct sk_buff *skb, int len,
368 void *here);
369extern void skb_under_panic(struct sk_buff *skb, int len,
370 void *here);
David S. Millerdc6de332006-04-20 00:10:50 -0700371extern void skb_truesize_bug(struct sk_buff *skb);
372
373static inline void skb_truesize_check(struct sk_buff *skb)
374{
375 if (unlikely((int)skb->truesize < sizeof(struct sk_buff) + skb->len))
376 skb_truesize_bug(skb);
377}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700378
Ananda Rajue89e9cf2005-10-18 15:46:41 -0700379extern int skb_append_datato_frags(struct sock *sk, struct sk_buff *skb,
380 int getfrag(void *from, char *to, int offset,
381 int len,int odd, struct sk_buff *skb),
382 void *from, int length);
383
Thomas Graf677e90e2005-06-23 20:59:51 -0700384struct skb_seq_state
385{
386 __u32 lower_offset;
387 __u32 upper_offset;
388 __u32 frag_idx;
389 __u32 stepped_offset;
390 struct sk_buff *root_skb;
391 struct sk_buff *cur_skb;
392 __u8 *frag_data;
393};
394
395extern void skb_prepare_seq_read(struct sk_buff *skb,
396 unsigned int from, unsigned int to,
397 struct skb_seq_state *st);
398extern unsigned int skb_seq_read(unsigned int consumed, const u8 **data,
399 struct skb_seq_state *st);
400extern void skb_abort_seq_read(struct skb_seq_state *st);
401
Thomas Graf3fc7e8a2005-06-23 21:00:17 -0700402extern unsigned int skb_find_text(struct sk_buff *skb, unsigned int from,
403 unsigned int to, struct ts_config *config,
404 struct ts_state *state);
405
Linus Torvalds1da177e2005-04-16 15:20:36 -0700406/* Internal */
407#define skb_shinfo(SKB) ((struct skb_shared_info *)((SKB)->end))
408
409/**
410 * skb_queue_empty - check if a queue is empty
411 * @list: queue head
412 *
413 * Returns true if the queue is empty, false otherwise.
414 */
415static inline int skb_queue_empty(const struct sk_buff_head *list)
416{
417 return list->next == (struct sk_buff *)list;
418}
419
420/**
421 * skb_get - reference buffer
422 * @skb: buffer to reference
423 *
424 * Makes another reference to a socket buffer and returns a pointer
425 * to the buffer.
426 */
427static inline struct sk_buff *skb_get(struct sk_buff *skb)
428{
429 atomic_inc(&skb->users);
430 return skb;
431}
432
433/*
434 * If users == 1, we are the only owner and are can avoid redundant
435 * atomic change.
436 */
437
438/**
Linus Torvalds1da177e2005-04-16 15:20:36 -0700439 * skb_cloned - is the buffer a clone
440 * @skb: buffer to check
441 *
442 * Returns true if the buffer was generated with skb_clone() and is
443 * one of multiple shared copies of the buffer. Cloned buffers are
444 * shared data so must not be written to under normal circumstances.
445 */
446static inline int skb_cloned(const struct sk_buff *skb)
447{
448 return skb->cloned &&
449 (atomic_read(&skb_shinfo(skb)->dataref) & SKB_DATAREF_MASK) != 1;
450}
451
452/**
453 * skb_header_cloned - is the header a clone
454 * @skb: buffer to check
455 *
456 * Returns true if modifying the header part of the buffer requires
457 * the data to be copied.
458 */
459static inline int skb_header_cloned(const struct sk_buff *skb)
460{
461 int dataref;
462
463 if (!skb->cloned)
464 return 0;
465
466 dataref = atomic_read(&skb_shinfo(skb)->dataref);
467 dataref = (dataref & SKB_DATAREF_MASK) - (dataref >> SKB_DATAREF_SHIFT);
468 return dataref != 1;
469}
470
471/**
472 * skb_header_release - release reference to header
473 * @skb: buffer to operate on
474 *
475 * Drop a reference to the header part of the buffer. This is done
476 * by acquiring a payload reference. You must not read from the header
477 * part of skb->data after this.
478 */
479static inline void skb_header_release(struct sk_buff *skb)
480{
481 BUG_ON(skb->nohdr);
482 skb->nohdr = 1;
483 atomic_add(1 << SKB_DATAREF_SHIFT, &skb_shinfo(skb)->dataref);
484}
485
486/**
487 * skb_shared - is the buffer shared
488 * @skb: buffer to check
489 *
490 * Returns true if more than one person has a reference to this
491 * buffer.
492 */
493static inline int skb_shared(const struct sk_buff *skb)
494{
495 return atomic_read(&skb->users) != 1;
496}
497
498/**
499 * skb_share_check - check if buffer is shared and if so clone it
500 * @skb: buffer to check
501 * @pri: priority for memory allocation
502 *
503 * If the buffer is shared the buffer is cloned and the old copy
504 * drops a reference. A new clone with a single reference is returned.
505 * If the buffer is not shared the original buffer is returned. When
506 * being called from interrupt status or with spinlocks held pri must
507 * be GFP_ATOMIC.
508 *
509 * NULL is returned on a memory allocation failure.
510 */
Victor Fusco86a76ca2005-07-08 14:57:47 -0700511static inline struct sk_buff *skb_share_check(struct sk_buff *skb,
Al Virodd0fc662005-10-07 07:46:04 +0100512 gfp_t pri)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700513{
514 might_sleep_if(pri & __GFP_WAIT);
515 if (skb_shared(skb)) {
516 struct sk_buff *nskb = skb_clone(skb, pri);
517 kfree_skb(skb);
518 skb = nskb;
519 }
520 return skb;
521}
522
523/*
524 * Copy shared buffers into a new sk_buff. We effectively do COW on
525 * packets to handle cases where we have a local reader and forward
526 * and a couple of other messy ones. The normal one is tcpdumping
527 * a packet thats being forwarded.
528 */
529
530/**
531 * skb_unshare - make a copy of a shared buffer
532 * @skb: buffer to check
533 * @pri: priority for memory allocation
534 *
535 * If the socket buffer is a clone then this function creates a new
536 * copy of the data, drops a reference count on the old copy and returns
537 * the new copy with the reference count at 1. If the buffer is not a clone
538 * the original buffer is returned. When called with a spinlock held or
539 * from interrupt state @pri must be %GFP_ATOMIC
540 *
541 * %NULL is returned on a memory allocation failure.
542 */
Victor Fuscoe2bf5212005-07-18 13:36:38 -0700543static inline struct sk_buff *skb_unshare(struct sk_buff *skb,
Al Virodd0fc662005-10-07 07:46:04 +0100544 gfp_t pri)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700545{
546 might_sleep_if(pri & __GFP_WAIT);
547 if (skb_cloned(skb)) {
548 struct sk_buff *nskb = skb_copy(skb, pri);
549 kfree_skb(skb); /* Free our shared copy */
550 skb = nskb;
551 }
552 return skb;
553}
554
555/**
556 * skb_peek
557 * @list_: list to peek at
558 *
559 * Peek an &sk_buff. Unlike most other operations you _MUST_
560 * be careful with this one. A peek leaves the buffer on the
561 * list and someone else may run off with it. You must hold
562 * the appropriate locks or have a private queue to do this.
563 *
564 * Returns %NULL for an empty list or a pointer to the head element.
565 * The reference count is not incremented and the reference is therefore
566 * volatile. Use with caution.
567 */
568static inline struct sk_buff *skb_peek(struct sk_buff_head *list_)
569{
570 struct sk_buff *list = ((struct sk_buff *)list_)->next;
571 if (list == (struct sk_buff *)list_)
572 list = NULL;
573 return list;
574}
575
576/**
577 * skb_peek_tail
578 * @list_: list to peek at
579 *
580 * Peek an &sk_buff. Unlike most other operations you _MUST_
581 * be careful with this one. A peek leaves the buffer on the
582 * list and someone else may run off with it. You must hold
583 * the appropriate locks or have a private queue to do this.
584 *
585 * Returns %NULL for an empty list or a pointer to the tail element.
586 * The reference count is not incremented and the reference is therefore
587 * volatile. Use with caution.
588 */
589static inline struct sk_buff *skb_peek_tail(struct sk_buff_head *list_)
590{
591 struct sk_buff *list = ((struct sk_buff *)list_)->prev;
592 if (list == (struct sk_buff *)list_)
593 list = NULL;
594 return list;
595}
596
597/**
598 * skb_queue_len - get queue length
599 * @list_: list to measure
600 *
601 * Return the length of an &sk_buff queue.
602 */
603static inline __u32 skb_queue_len(const struct sk_buff_head *list_)
604{
605 return list_->qlen;
606}
607
Arjan van de Ven76f10ad2006-08-02 14:06:55 -0700608/*
609 * This function creates a split out lock class for each invocation;
610 * this is needed for now since a whole lot of users of the skb-queue
611 * infrastructure in drivers have different locking usage (in hardirq)
612 * than the networking core (in softirq only). In the long run either the
613 * network layer or drivers should need annotation to consolidate the
614 * main types of usage into 3 classes.
615 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700616static inline void skb_queue_head_init(struct sk_buff_head *list)
617{
618 spin_lock_init(&list->lock);
619 list->prev = list->next = (struct sk_buff *)list;
620 list->qlen = 0;
621}
622
623/*
624 * Insert an sk_buff at the start of a list.
625 *
626 * The "__skb_xxxx()" functions are the non-atomic ones that
627 * can only be called with interrupts disabled.
628 */
629
630/**
Stephen Hemminger300ce172005-10-30 13:47:34 -0800631 * __skb_queue_after - queue a buffer at the list head
632 * @list: list to use
633 * @prev: place after this buffer
634 * @newsk: buffer to queue
635 *
636 * Queue a buffer int the middle of a list. This function takes no locks
637 * and you must therefore hold required locks before calling it.
638 *
639 * A buffer cannot be placed on two lists at the same time.
640 */
641static inline void __skb_queue_after(struct sk_buff_head *list,
642 struct sk_buff *prev,
643 struct sk_buff *newsk)
644{
645 struct sk_buff *next;
646 list->qlen++;
647
648 next = prev->next;
649 newsk->next = next;
650 newsk->prev = prev;
651 next->prev = prev->next = newsk;
652}
653
654/**
Linus Torvalds1da177e2005-04-16 15:20:36 -0700655 * __skb_queue_head - queue a buffer at the list head
656 * @list: list to use
657 * @newsk: buffer to queue
658 *
659 * Queue a buffer at the start of a list. This function takes no locks
660 * and you must therefore hold required locks before calling it.
661 *
662 * A buffer cannot be placed on two lists at the same time.
663 */
664extern void skb_queue_head(struct sk_buff_head *list, struct sk_buff *newsk);
665static inline void __skb_queue_head(struct sk_buff_head *list,
666 struct sk_buff *newsk)
667{
Stephen Hemminger300ce172005-10-30 13:47:34 -0800668 __skb_queue_after(list, (struct sk_buff *)list, newsk);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700669}
670
671/**
672 * __skb_queue_tail - queue a buffer at the list tail
673 * @list: list to use
674 * @newsk: buffer to queue
675 *
676 * Queue a buffer at the end of a list. This function takes no locks
677 * and you must therefore hold required locks before calling it.
678 *
679 * A buffer cannot be placed on two lists at the same time.
680 */
681extern void skb_queue_tail(struct sk_buff_head *list, struct sk_buff *newsk);
682static inline void __skb_queue_tail(struct sk_buff_head *list,
683 struct sk_buff *newsk)
684{
685 struct sk_buff *prev, *next;
686
Linus Torvalds1da177e2005-04-16 15:20:36 -0700687 list->qlen++;
688 next = (struct sk_buff *)list;
689 prev = next->prev;
690 newsk->next = next;
691 newsk->prev = prev;
692 next->prev = prev->next = newsk;
693}
694
695
696/**
697 * __skb_dequeue - remove from the head of the queue
698 * @list: list to dequeue from
699 *
700 * Remove the head of the list. This function does not take any locks
701 * so must be used with appropriate locks held only. The head item is
702 * returned or %NULL if the list is empty.
703 */
704extern struct sk_buff *skb_dequeue(struct sk_buff_head *list);
705static inline struct sk_buff *__skb_dequeue(struct sk_buff_head *list)
706{
707 struct sk_buff *next, *prev, *result;
708
709 prev = (struct sk_buff *) list;
710 next = prev->next;
711 result = NULL;
712 if (next != prev) {
713 result = next;
714 next = next->next;
715 list->qlen--;
716 next->prev = prev;
717 prev->next = next;
718 result->next = result->prev = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700719 }
720 return result;
721}
722
723
724/*
725 * Insert a packet on a list.
726 */
David S. Miller8728b832005-08-09 19:25:21 -0700727extern void skb_insert(struct sk_buff *old, struct sk_buff *newsk, struct sk_buff_head *list);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700728static inline void __skb_insert(struct sk_buff *newsk,
729 struct sk_buff *prev, struct sk_buff *next,
730 struct sk_buff_head *list)
731{
732 newsk->next = next;
733 newsk->prev = prev;
734 next->prev = prev->next = newsk;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700735 list->qlen++;
736}
737
738/*
739 * Place a packet after a given packet in a list.
740 */
David S. Miller8728b832005-08-09 19:25:21 -0700741extern void skb_append(struct sk_buff *old, struct sk_buff *newsk, struct sk_buff_head *list);
742static inline void __skb_append(struct sk_buff *old, struct sk_buff *newsk, struct sk_buff_head *list)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700743{
David S. Miller8728b832005-08-09 19:25:21 -0700744 __skb_insert(newsk, old, old->next, list);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700745}
746
747/*
748 * remove sk_buff from list. _Must_ be called atomically, and with
749 * the list known..
750 */
David S. Miller8728b832005-08-09 19:25:21 -0700751extern void skb_unlink(struct sk_buff *skb, struct sk_buff_head *list);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700752static inline void __skb_unlink(struct sk_buff *skb, struct sk_buff_head *list)
753{
754 struct sk_buff *next, *prev;
755
756 list->qlen--;
757 next = skb->next;
758 prev = skb->prev;
759 skb->next = skb->prev = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700760 next->prev = prev;
761 prev->next = next;
762}
763
764
765/* XXX: more streamlined implementation */
766
767/**
768 * __skb_dequeue_tail - remove from the tail of the queue
769 * @list: list to dequeue from
770 *
771 * Remove the tail of the list. This function does not take any locks
772 * so must be used with appropriate locks held only. The tail item is
773 * returned or %NULL if the list is empty.
774 */
775extern struct sk_buff *skb_dequeue_tail(struct sk_buff_head *list);
776static inline struct sk_buff *__skb_dequeue_tail(struct sk_buff_head *list)
777{
778 struct sk_buff *skb = skb_peek_tail(list);
779 if (skb)
780 __skb_unlink(skb, list);
781 return skb;
782}
783
784
785static inline int skb_is_nonlinear(const struct sk_buff *skb)
786{
787 return skb->data_len;
788}
789
790static inline unsigned int skb_headlen(const struct sk_buff *skb)
791{
792 return skb->len - skb->data_len;
793}
794
795static inline int skb_pagelen(const struct sk_buff *skb)
796{
797 int i, len = 0;
798
799 for (i = (int)skb_shinfo(skb)->nr_frags - 1; i >= 0; i--)
800 len += skb_shinfo(skb)->frags[i].size;
801 return len + skb_headlen(skb);
802}
803
804static inline void skb_fill_page_desc(struct sk_buff *skb, int i,
805 struct page *page, int off, int size)
806{
807 skb_frag_t *frag = &skb_shinfo(skb)->frags[i];
808
809 frag->page = page;
810 frag->page_offset = off;
811 frag->size = size;
812 skb_shinfo(skb)->nr_frags = i + 1;
813}
814
815#define SKB_PAGE_ASSERT(skb) BUG_ON(skb_shinfo(skb)->nr_frags)
816#define SKB_FRAG_ASSERT(skb) BUG_ON(skb_shinfo(skb)->frag_list)
817#define SKB_LINEAR_ASSERT(skb) BUG_ON(skb_is_nonlinear(skb))
818
819/*
820 * Add data to an sk_buff
821 */
822static inline unsigned char *__skb_put(struct sk_buff *skb, unsigned int len)
823{
824 unsigned char *tmp = skb->tail;
825 SKB_LINEAR_ASSERT(skb);
826 skb->tail += len;
827 skb->len += len;
828 return tmp;
829}
830
831/**
832 * skb_put - add data to a buffer
833 * @skb: buffer to use
834 * @len: amount of data to add
835 *
836 * This function extends the used data area of the buffer. If this would
837 * exceed the total buffer size the kernel will panic. A pointer to the
838 * first byte of the extra data is returned.
839 */
840static inline unsigned char *skb_put(struct sk_buff *skb, unsigned int len)
841{
842 unsigned char *tmp = skb->tail;
843 SKB_LINEAR_ASSERT(skb);
844 skb->tail += len;
845 skb->len += len;
846 if (unlikely(skb->tail>skb->end))
847 skb_over_panic(skb, len, current_text_addr());
848 return tmp;
849}
850
851static inline unsigned char *__skb_push(struct sk_buff *skb, unsigned int len)
852{
853 skb->data -= len;
854 skb->len += len;
855 return skb->data;
856}
857
858/**
859 * skb_push - add data to the start of a buffer
860 * @skb: buffer to use
861 * @len: amount of data to add
862 *
863 * This function extends the used data area of the buffer at the buffer
864 * start. If this would exceed the total buffer headroom the kernel will
865 * panic. A pointer to the first byte of the extra data is returned.
866 */
867static inline unsigned char *skb_push(struct sk_buff *skb, unsigned int len)
868{
869 skb->data -= len;
870 skb->len += len;
871 if (unlikely(skb->data<skb->head))
872 skb_under_panic(skb, len, current_text_addr());
873 return skb->data;
874}
875
876static inline unsigned char *__skb_pull(struct sk_buff *skb, unsigned int len)
877{
878 skb->len -= len;
879 BUG_ON(skb->len < skb->data_len);
880 return skb->data += len;
881}
882
883/**
884 * skb_pull - remove data from the start of a buffer
885 * @skb: buffer to use
886 * @len: amount of data to remove
887 *
888 * This function removes data from the start of a buffer, returning
889 * the memory to the headroom. A pointer to the next data in the buffer
890 * is returned. Once the data has been pulled future pushes will overwrite
891 * the old data.
892 */
893static inline unsigned char *skb_pull(struct sk_buff *skb, unsigned int len)
894{
895 return unlikely(len > skb->len) ? NULL : __skb_pull(skb, len);
896}
897
898extern unsigned char *__pskb_pull_tail(struct sk_buff *skb, int delta);
899
900static inline unsigned char *__pskb_pull(struct sk_buff *skb, unsigned int len)
901{
902 if (len > skb_headlen(skb) &&
903 !__pskb_pull_tail(skb, len-skb_headlen(skb)))
904 return NULL;
905 skb->len -= len;
906 return skb->data += len;
907}
908
909static inline unsigned char *pskb_pull(struct sk_buff *skb, unsigned int len)
910{
911 return unlikely(len > skb->len) ? NULL : __pskb_pull(skb, len);
912}
913
914static inline int pskb_may_pull(struct sk_buff *skb, unsigned int len)
915{
916 if (likely(len <= skb_headlen(skb)))
917 return 1;
918 if (unlikely(len > skb->len))
919 return 0;
920 return __pskb_pull_tail(skb, len-skb_headlen(skb)) != NULL;
921}
922
923/**
924 * skb_headroom - bytes at buffer head
925 * @skb: buffer to check
926 *
927 * Return the number of bytes of free space at the head of an &sk_buff.
928 */
929static inline int skb_headroom(const struct sk_buff *skb)
930{
931 return skb->data - skb->head;
932}
933
934/**
935 * skb_tailroom - bytes at buffer end
936 * @skb: buffer to check
937 *
938 * Return the number of bytes of free space at the tail of an sk_buff
939 */
940static inline int skb_tailroom(const struct sk_buff *skb)
941{
942 return skb_is_nonlinear(skb) ? 0 : skb->end - skb->tail;
943}
944
945/**
946 * skb_reserve - adjust headroom
947 * @skb: buffer to alter
948 * @len: bytes to move
949 *
950 * Increase the headroom of an empty &sk_buff by reducing the tail
951 * room. This is only allowed for an empty buffer.
952 */
David S. Miller8243126c2006-01-17 02:54:21 -0800953static inline void skb_reserve(struct sk_buff *skb, int len)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700954{
955 skb->data += len;
956 skb->tail += len;
957}
958
959/*
960 * CPUs often take a performance hit when accessing unaligned memory
961 * locations. The actual performance hit varies, it can be small if the
962 * hardware handles it or large if we have to take an exception and fix it
963 * in software.
964 *
965 * Since an ethernet header is 14 bytes network drivers often end up with
966 * the IP header at an unaligned offset. The IP header can be aligned by
967 * shifting the start of the packet by 2 bytes. Drivers should do this
968 * with:
969 *
970 * skb_reserve(NET_IP_ALIGN);
971 *
972 * The downside to this alignment of the IP header is that the DMA is now
973 * unaligned. On some architectures the cost of an unaligned DMA is high
974 * and this cost outweighs the gains made by aligning the IP header.
975 *
976 * Since this trade off varies between architectures, we allow NET_IP_ALIGN
977 * to be overridden.
978 */
979#ifndef NET_IP_ALIGN
980#define NET_IP_ALIGN 2
981#endif
982
Anton Blanchard025be812006-03-31 02:27:06 -0800983/*
984 * The networking layer reserves some headroom in skb data (via
985 * dev_alloc_skb). This is used to avoid having to reallocate skb data when
986 * the header has to grow. In the default case, if the header has to grow
987 * 16 bytes or less we avoid the reallocation.
988 *
989 * Unfortunately this headroom changes the DMA alignment of the resulting
990 * network packet. As for NET_IP_ALIGN, this unaligned DMA is expensive
991 * on some architectures. An architecture can override this value,
992 * perhaps setting it to a cacheline in size (since that will maintain
993 * cacheline alignment of the DMA). It must be a power of 2.
994 *
995 * Various parts of the networking layer expect at least 16 bytes of
996 * headroom, you should not reduce this.
997 */
998#ifndef NET_SKB_PAD
999#define NET_SKB_PAD 16
1000#endif
1001
Herbert Xu3cc0e872006-06-09 16:13:38 -07001002extern int ___pskb_trim(struct sk_buff *skb, unsigned int len);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001003
1004static inline void __skb_trim(struct sk_buff *skb, unsigned int len)
1005{
Herbert Xu3cc0e872006-06-09 16:13:38 -07001006 if (unlikely(skb->data_len)) {
1007 WARN_ON(1);
1008 return;
1009 }
1010 skb->len = len;
1011 skb->tail = skb->data + len;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001012}
1013
1014/**
1015 * skb_trim - remove end from a buffer
1016 * @skb: buffer to alter
1017 * @len: new length
1018 *
1019 * Cut the length of a buffer down by removing data from the tail. If
1020 * the buffer is already under the length specified it is not modified.
Herbert Xu3cc0e872006-06-09 16:13:38 -07001021 * The skb must be linear.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001022 */
1023static inline void skb_trim(struct sk_buff *skb, unsigned int len)
1024{
1025 if (skb->len > len)
1026 __skb_trim(skb, len);
1027}
1028
1029
1030static inline int __pskb_trim(struct sk_buff *skb, unsigned int len)
1031{
Herbert Xu3cc0e872006-06-09 16:13:38 -07001032 if (skb->data_len)
1033 return ___pskb_trim(skb, len);
1034 __skb_trim(skb, len);
1035 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001036}
1037
1038static inline int pskb_trim(struct sk_buff *skb, unsigned int len)
1039{
1040 return (len < skb->len) ? __pskb_trim(skb, len) : 0;
1041}
1042
1043/**
Herbert Xue9fa4f72006-08-13 20:12:58 -07001044 * pskb_trim_unique - remove end from a paged unique (not cloned) buffer
1045 * @skb: buffer to alter
1046 * @len: new length
1047 *
1048 * This is identical to pskb_trim except that the caller knows that
1049 * the skb is not cloned so we should never get an error due to out-
1050 * of-memory.
1051 */
1052static inline void pskb_trim_unique(struct sk_buff *skb, unsigned int len)
1053{
1054 int err = pskb_trim(skb, len);
1055 BUG_ON(err);
1056}
1057
1058/**
Linus Torvalds1da177e2005-04-16 15:20:36 -07001059 * skb_orphan - orphan a buffer
1060 * @skb: buffer to orphan
1061 *
1062 * If a buffer currently has an owner then we call the owner's
1063 * destructor function and make the @skb unowned. The buffer continues
1064 * to exist but is no longer charged to its former owner.
1065 */
1066static inline void skb_orphan(struct sk_buff *skb)
1067{
1068 if (skb->destructor)
1069 skb->destructor(skb);
1070 skb->destructor = NULL;
1071 skb->sk = NULL;
1072}
1073
1074/**
1075 * __skb_queue_purge - empty a list
1076 * @list: list to empty
1077 *
1078 * Delete all buffers on an &sk_buff list. Each buffer is removed from
1079 * the list and one reference dropped. This function does not take the
1080 * list lock and the caller must hold the relevant locks to use it.
1081 */
1082extern void skb_queue_purge(struct sk_buff_head *list);
1083static inline void __skb_queue_purge(struct sk_buff_head *list)
1084{
1085 struct sk_buff *skb;
1086 while ((skb = __skb_dequeue(list)) != NULL)
1087 kfree_skb(skb);
1088}
1089
1090/**
Christoph Hellwigb4e54de2006-07-24 15:31:14 -07001091 * __dev_alloc_skb - allocate an skbuff for receiving
Linus Torvalds1da177e2005-04-16 15:20:36 -07001092 * @length: length to allocate
1093 * @gfp_mask: get_free_pages mask, passed to alloc_skb
1094 *
1095 * Allocate a new &sk_buff and assign it a usage count of one. The
1096 * buffer has unspecified headroom built in. Users should allocate
1097 * the headroom they think they need without accounting for the
1098 * built in space. The built in space is used for optimisations.
1099 *
Christoph Hellwig766ea8c2006-08-07 15:49:53 -07001100 * %NULL is returned if there is no free memory.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001101 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001102static inline struct sk_buff *__dev_alloc_skb(unsigned int length,
Al Virodd0fc662005-10-07 07:46:04 +01001103 gfp_t gfp_mask)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001104{
Anton Blanchard025be812006-03-31 02:27:06 -08001105 struct sk_buff *skb = alloc_skb(length + NET_SKB_PAD, gfp_mask);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001106 if (likely(skb))
Anton Blanchard025be812006-03-31 02:27:06 -08001107 skb_reserve(skb, NET_SKB_PAD);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001108 return skb;
1109}
Linus Torvalds1da177e2005-04-16 15:20:36 -07001110
1111/**
Christoph Hellwigb4e54de2006-07-24 15:31:14 -07001112 * dev_alloc_skb - allocate an skbuff for receiving
Linus Torvalds1da177e2005-04-16 15:20:36 -07001113 * @length: length to allocate
1114 *
1115 * Allocate a new &sk_buff and assign it a usage count of one. The
1116 * buffer has unspecified headroom built in. Users should allocate
1117 * the headroom they think they need without accounting for the
1118 * built in space. The built in space is used for optimisations.
1119 *
Christoph Hellwig766ea8c2006-08-07 15:49:53 -07001120 * %NULL is returned if there is no free memory. Although this function
Linus Torvalds1da177e2005-04-16 15:20:36 -07001121 * allocates memory it can be called from an interrupt.
1122 */
1123static inline struct sk_buff *dev_alloc_skb(unsigned int length)
1124{
1125 return __dev_alloc_skb(length, GFP_ATOMIC);
1126}
1127
Christoph Hellwig8af27452006-07-31 22:35:23 -07001128extern struct sk_buff *__netdev_alloc_skb(struct net_device *dev,
1129 unsigned int length, gfp_t gfp_mask);
1130
1131/**
1132 * netdev_alloc_skb - allocate an skbuff for rx on a specific device
1133 * @dev: network device to receive on
1134 * @length: length to allocate
1135 *
1136 * Allocate a new &sk_buff and assign it a usage count of one. The
1137 * buffer has unspecified headroom built in. Users should allocate
1138 * the headroom they think they need without accounting for the
1139 * built in space. The built in space is used for optimisations.
1140 *
1141 * %NULL is returned if there is no free memory. Although this function
1142 * allocates memory it can be called from an interrupt.
1143 */
1144static inline struct sk_buff *netdev_alloc_skb(struct net_device *dev,
1145 unsigned int length)
1146{
1147 return __netdev_alloc_skb(dev, length, GFP_ATOMIC);
1148}
1149
Linus Torvalds1da177e2005-04-16 15:20:36 -07001150/**
1151 * skb_cow - copy header of skb when it is required
1152 * @skb: buffer to cow
1153 * @headroom: needed headroom
1154 *
1155 * If the skb passed lacks sufficient headroom or its data part
1156 * is shared, data is reallocated. If reallocation fails, an error
1157 * is returned and original skb is not changed.
1158 *
1159 * The result is skb with writable area skb->head...skb->tail
1160 * and at least @headroom of space at head.
1161 */
1162static inline int skb_cow(struct sk_buff *skb, unsigned int headroom)
1163{
Anton Blanchard025be812006-03-31 02:27:06 -08001164 int delta = (headroom > NET_SKB_PAD ? headroom : NET_SKB_PAD) -
1165 skb_headroom(skb);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001166
1167 if (delta < 0)
1168 delta = 0;
1169
1170 if (delta || skb_cloned(skb))
Anton Blanchard025be812006-03-31 02:27:06 -08001171 return pskb_expand_head(skb, (delta + (NET_SKB_PAD-1)) &
1172 ~(NET_SKB_PAD-1), 0, GFP_ATOMIC);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001173 return 0;
1174}
1175
1176/**
1177 * skb_padto - pad an skbuff up to a minimal size
1178 * @skb: buffer to pad
1179 * @len: minimal length
1180 *
1181 * Pads up a buffer to ensure the trailing bytes exist and are
1182 * blanked. If the buffer already contains sufficient data it
Herbert Xu5b057c62006-06-23 02:06:41 -07001183 * is untouched. Otherwise it is extended. Returns zero on
1184 * success. The skb is freed on error.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001185 */
1186
Herbert Xu5b057c62006-06-23 02:06:41 -07001187static inline int skb_padto(struct sk_buff *skb, unsigned int len)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001188{
1189 unsigned int size = skb->len;
1190 if (likely(size >= len))
Herbert Xu5b057c62006-06-23 02:06:41 -07001191 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001192 return skb_pad(skb, len-size);
1193}
1194
1195static inline int skb_add_data(struct sk_buff *skb,
1196 char __user *from, int copy)
1197{
1198 const int off = skb->len;
1199
1200 if (skb->ip_summed == CHECKSUM_NONE) {
1201 int err = 0;
Al Viro50842052006-11-14 21:36:34 -08001202 __wsum csum = csum_and_copy_from_user(from, skb_put(skb, copy),
Linus Torvalds1da177e2005-04-16 15:20:36 -07001203 copy, 0, &err);
1204 if (!err) {
1205 skb->csum = csum_block_add(skb->csum, csum, off);
1206 return 0;
1207 }
1208 } else if (!copy_from_user(skb_put(skb, copy), from, copy))
1209 return 0;
1210
1211 __skb_trim(skb, off);
1212 return -EFAULT;
1213}
1214
1215static inline int skb_can_coalesce(struct sk_buff *skb, int i,
1216 struct page *page, int off)
1217{
1218 if (i) {
1219 struct skb_frag_struct *frag = &skb_shinfo(skb)->frags[i - 1];
1220
1221 return page == frag->page &&
1222 off == frag->page_offset + frag->size;
1223 }
1224 return 0;
1225}
1226
Herbert Xu364c6ba2006-06-09 16:10:40 -07001227static inline int __skb_linearize(struct sk_buff *skb)
1228{
1229 return __pskb_pull_tail(skb, skb->data_len) ? 0 : -ENOMEM;
1230}
1231
Linus Torvalds1da177e2005-04-16 15:20:36 -07001232/**
1233 * skb_linearize - convert paged skb to linear one
1234 * @skb: buffer to linarize
Linus Torvalds1da177e2005-04-16 15:20:36 -07001235 *
1236 * If there is no free memory -ENOMEM is returned, otherwise zero
1237 * is returned and the old skb data released.
1238 */
Herbert Xu364c6ba2006-06-09 16:10:40 -07001239static inline int skb_linearize(struct sk_buff *skb)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001240{
Herbert Xu364c6ba2006-06-09 16:10:40 -07001241 return skb_is_nonlinear(skb) ? __skb_linearize(skb) : 0;
1242}
1243
1244/**
1245 * skb_linearize_cow - make sure skb is linear and writable
1246 * @skb: buffer to process
1247 *
1248 * If there is no free memory -ENOMEM is returned, otherwise zero
1249 * is returned and the old skb data released.
1250 */
1251static inline int skb_linearize_cow(struct sk_buff *skb)
1252{
1253 return skb_is_nonlinear(skb) || skb_cloned(skb) ?
1254 __skb_linearize(skb) : 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001255}
1256
1257/**
1258 * skb_postpull_rcsum - update checksum for received skb after pull
1259 * @skb: buffer to update
1260 * @start: start of data before pull
1261 * @len: length of data pulled
1262 *
1263 * After doing a pull on a received packet, you need to call this to
Patrick McHardy84fa7932006-08-29 16:44:56 -07001264 * update the CHECKSUM_COMPLETE checksum, or set ip_summed to
1265 * CHECKSUM_NONE so that it can be recomputed from scratch.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001266 */
1267
1268static inline void skb_postpull_rcsum(struct sk_buff *skb,
Herbert Xucbb042f92006-03-20 22:43:56 -08001269 const void *start, unsigned int len)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001270{
Patrick McHardy84fa7932006-08-29 16:44:56 -07001271 if (skb->ip_summed == CHECKSUM_COMPLETE)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001272 skb->csum = csum_sub(skb->csum, csum_partial(start, len, 0));
1273}
1274
Herbert Xucbb042f92006-03-20 22:43:56 -08001275unsigned char *skb_pull_rcsum(struct sk_buff *skb, unsigned int len);
1276
Linus Torvalds1da177e2005-04-16 15:20:36 -07001277/**
1278 * pskb_trim_rcsum - trim received skb and update checksum
1279 * @skb: buffer to trim
1280 * @len: new length
1281 *
1282 * This is exactly the same as pskb_trim except that it ensures the
1283 * checksum of received packets are still valid after the operation.
1284 */
1285
1286static inline int pskb_trim_rcsum(struct sk_buff *skb, unsigned int len)
1287{
Stephen Hemminger0e4e4222005-09-08 12:32:03 -07001288 if (likely(len >= skb->len))
Linus Torvalds1da177e2005-04-16 15:20:36 -07001289 return 0;
Patrick McHardy84fa7932006-08-29 16:44:56 -07001290 if (skb->ip_summed == CHECKSUM_COMPLETE)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001291 skb->ip_summed = CHECKSUM_NONE;
1292 return __pskb_trim(skb, len);
1293}
1294
1295static inline void *kmap_skb_frag(const skb_frag_t *frag)
1296{
1297#ifdef CONFIG_HIGHMEM
1298 BUG_ON(in_irq());
1299
1300 local_bh_disable();
1301#endif
1302 return kmap_atomic(frag->page, KM_SKB_DATA_SOFTIRQ);
1303}
1304
1305static inline void kunmap_skb_frag(void *vaddr)
1306{
1307 kunmap_atomic(vaddr, KM_SKB_DATA_SOFTIRQ);
1308#ifdef CONFIG_HIGHMEM
1309 local_bh_enable();
1310#endif
1311}
1312
1313#define skb_queue_walk(queue, skb) \
1314 for (skb = (queue)->next; \
1315 prefetch(skb->next), (skb != (struct sk_buff *)(queue)); \
1316 skb = skb->next)
1317
Stephen Hemminger300ce172005-10-30 13:47:34 -08001318#define skb_queue_reverse_walk(queue, skb) \
1319 for (skb = (queue)->prev; \
1320 prefetch(skb->prev), (skb != (struct sk_buff *)(queue)); \
1321 skb = skb->prev)
1322
Linus Torvalds1da177e2005-04-16 15:20:36 -07001323
1324extern struct sk_buff *skb_recv_datagram(struct sock *sk, unsigned flags,
1325 int noblock, int *err);
1326extern unsigned int datagram_poll(struct file *file, struct socket *sock,
1327 struct poll_table_struct *wait);
1328extern int skb_copy_datagram_iovec(const struct sk_buff *from,
1329 int offset, struct iovec *to,
1330 int size);
Herbert Xufb286bb2005-11-10 13:01:24 -08001331extern int skb_copy_and_csum_datagram_iovec(struct sk_buff *skb,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001332 int hlen,
1333 struct iovec *iov);
1334extern void skb_free_datagram(struct sock *sk, struct sk_buff *skb);
Herbert Xu3305b802005-12-13 23:16:37 -08001335extern void skb_kill_datagram(struct sock *sk, struct sk_buff *skb,
1336 unsigned int flags);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001337extern unsigned int skb_checksum(const struct sk_buff *skb, int offset,
1338 int len, unsigned int csum);
1339extern int skb_copy_bits(const struct sk_buff *skb, int offset,
1340 void *to, int len);
Herbert Xu357b40a2005-04-19 22:30:14 -07001341extern int skb_store_bits(const struct sk_buff *skb, int offset,
1342 void *from, int len);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001343extern unsigned int skb_copy_and_csum_bits(const struct sk_buff *skb,
1344 int offset, u8 *to, int len,
1345 unsigned int csum);
1346extern void skb_copy_and_csum_dev(const struct sk_buff *skb, u8 *to);
1347extern void skb_split(struct sk_buff *skb,
1348 struct sk_buff *skb1, const u32 len);
1349
Herbert Xu576a30e2006-06-27 13:22:38 -07001350extern struct sk_buff *skb_segment(struct sk_buff *skb, int features);
Arnaldo Carvalho de Melo20380732005-08-16 02:18:02 -03001351
Linus Torvalds1da177e2005-04-16 15:20:36 -07001352static inline void *skb_header_pointer(const struct sk_buff *skb, int offset,
1353 int len, void *buffer)
1354{
1355 int hlen = skb_headlen(skb);
1356
Patrick McHardy55820ee2005-07-05 14:08:10 -07001357 if (hlen - offset >= len)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001358 return skb->data + offset;
1359
1360 if (skb_copy_bits(skb, offset, buffer, len) < 0)
1361 return NULL;
1362
1363 return buffer;
1364}
1365
1366extern void skb_init(void);
1367extern void skb_add_mtu(int mtu);
1368
Patrick McHardya61bbcf2005-08-14 17:24:31 -07001369/**
1370 * skb_get_timestamp - get timestamp from a skb
1371 * @skb: skb to get stamp from
1372 * @stamp: pointer to struct timeval to store stamp in
1373 *
1374 * Timestamps are stored in the skb as offsets to a base timestamp.
1375 * This function converts the offset back to a struct timeval and stores
1376 * it in stamp.
1377 */
Stephen Hemmingerf2c38392005-09-06 15:48:03 -07001378static inline void skb_get_timestamp(const struct sk_buff *skb, struct timeval *stamp)
Patrick McHardya61bbcf2005-08-14 17:24:31 -07001379{
1380 stamp->tv_sec = skb->tstamp.off_sec;
1381 stamp->tv_usec = skb->tstamp.off_usec;
Patrick McHardya61bbcf2005-08-14 17:24:31 -07001382}
1383
1384/**
1385 * skb_set_timestamp - set timestamp of a skb
1386 * @skb: skb to set stamp of
1387 * @stamp: pointer to struct timeval to get stamp from
1388 *
1389 * Timestamps are stored in the skb as offsets to a base timestamp.
1390 * This function converts a struct timeval to an offset and stores
1391 * it in the skb.
1392 */
Stephen Hemmingerf2c38392005-09-06 15:48:03 -07001393static inline void skb_set_timestamp(struct sk_buff *skb, const struct timeval *stamp)
Patrick McHardya61bbcf2005-08-14 17:24:31 -07001394{
Herbert Xu325ed822005-10-03 13:57:23 -07001395 skb->tstamp.off_sec = stamp->tv_sec;
1396 skb->tstamp.off_usec = stamp->tv_usec;
Patrick McHardya61bbcf2005-08-14 17:24:31 -07001397}
1398
1399extern void __net_timestamp(struct sk_buff *skb);
1400
Herbert Xufb286bb2005-11-10 13:01:24 -08001401extern unsigned int __skb_checksum_complete(struct sk_buff *skb);
1402
1403/**
1404 * skb_checksum_complete - Calculate checksum of an entire packet
1405 * @skb: packet to process
1406 *
1407 * This function calculates the checksum over the entire packet plus
1408 * the value of skb->csum. The latter can be used to supply the
1409 * checksum of a pseudo header as used by TCP/UDP. It returns the
1410 * checksum.
1411 *
1412 * For protocols that contain complete checksums such as ICMP/TCP/UDP,
1413 * this function can be used to verify that checksum on received
1414 * packets. In that case the function should return zero if the
1415 * checksum is correct. In particular, this function will return zero
1416 * if skb->ip_summed is CHECKSUM_UNNECESSARY which indicates that the
1417 * hardware has already verified the correctness of the checksum.
1418 */
1419static inline unsigned int skb_checksum_complete(struct sk_buff *skb)
1420{
1421 return skb->ip_summed != CHECKSUM_UNNECESSARY &&
1422 __skb_checksum_complete(skb);
1423}
1424
Linus Torvalds1da177e2005-04-16 15:20:36 -07001425#ifdef CONFIG_NETFILTER
1426static inline void nf_conntrack_put(struct nf_conntrack *nfct)
1427{
1428 if (nfct && atomic_dec_and_test(&nfct->use))
1429 nfct->destroy(nfct);
1430}
1431static inline void nf_conntrack_get(struct nf_conntrack *nfct)
1432{
1433 if (nfct)
1434 atomic_inc(&nfct->use);
1435}
Yasuyuki Kozakai9fb9cbb2005-11-09 16:38:16 -08001436#if defined(CONFIG_NF_CONNTRACK) || defined(CONFIG_NF_CONNTRACK_MODULE)
1437static inline void nf_conntrack_get_reasm(struct sk_buff *skb)
1438{
1439 if (skb)
1440 atomic_inc(&skb->users);
1441}
1442static inline void nf_conntrack_put_reasm(struct sk_buff *skb)
1443{
1444 if (skb)
1445 kfree_skb(skb);
1446}
1447#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -07001448#ifdef CONFIG_BRIDGE_NETFILTER
1449static inline void nf_bridge_put(struct nf_bridge_info *nf_bridge)
1450{
1451 if (nf_bridge && atomic_dec_and_test(&nf_bridge->use))
1452 kfree(nf_bridge);
1453}
1454static inline void nf_bridge_get(struct nf_bridge_info *nf_bridge)
1455{
1456 if (nf_bridge)
1457 atomic_inc(&nf_bridge->use);
1458}
1459#endif /* CONFIG_BRIDGE_NETFILTER */
Patrick McHardya193a4a2006-03-20 19:23:05 -08001460static inline void nf_reset(struct sk_buff *skb)
1461{
1462 nf_conntrack_put(skb->nfct);
1463 skb->nfct = NULL;
1464#if defined(CONFIG_NF_CONNTRACK) || defined(CONFIG_NF_CONNTRACK_MODULE)
1465 nf_conntrack_put_reasm(skb->nfct_reasm);
1466 skb->nfct_reasm = NULL;
1467#endif
1468#ifdef CONFIG_BRIDGE_NETFILTER
1469 nf_bridge_put(skb->nf_bridge);
1470 skb->nf_bridge = NULL;
1471#endif
1472}
1473
Linus Torvalds1da177e2005-04-16 15:20:36 -07001474#else /* CONFIG_NETFILTER */
1475static inline void nf_reset(struct sk_buff *skb) {}
1476#endif /* CONFIG_NETFILTER */
1477
James Morris984bc162006-06-09 00:29:17 -07001478#ifdef CONFIG_NETWORK_SECMARK
1479static inline void skb_copy_secmark(struct sk_buff *to, const struct sk_buff *from)
1480{
1481 to->secmark = from->secmark;
1482}
1483
1484static inline void skb_init_secmark(struct sk_buff *skb)
1485{
1486 skb->secmark = 0;
1487}
1488#else
1489static inline void skb_copy_secmark(struct sk_buff *to, const struct sk_buff *from)
1490{ }
1491
1492static inline void skb_init_secmark(struct sk_buff *skb)
1493{ }
1494#endif
1495
Herbert Xu89114af2006-07-08 13:34:32 -07001496static inline int skb_is_gso(const struct sk_buff *skb)
1497{
1498 return skb_shinfo(skb)->gso_size;
1499}
1500
Linus Torvalds1da177e2005-04-16 15:20:36 -07001501#endif /* __KERNEL__ */
1502#endif /* _LINUX_SKBUFF_H */