blob: 7c1f1756e482dd587f00ea2237afd86f9b8e292a [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001/*
2 * Definitions for the 'struct sk_buff' memory handlers.
3 *
4 * Authors:
5 * Alan Cox, <gw4pts@gw4pts.ampr.org>
6 * Florian La Roche, <rzsfl@rz.uni-sb.de>
7 *
8 * This program is free software; you can redistribute it and/or
9 * modify it under the terms of the GNU General Public License
10 * as published by the Free Software Foundation; either version
11 * 2 of the License, or (at your option) any later version.
12 */
13
14#ifndef _LINUX_SKBUFF_H
15#define _LINUX_SKBUFF_H
16
Linus Torvalds1da177e2005-04-16 15:20:36 -070017#include <linux/kernel.h>
18#include <linux/compiler.h>
19#include <linux/time.h>
20#include <linux/cache.h>
21
22#include <asm/atomic.h>
23#include <asm/types.h>
24#include <linux/spinlock.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070025#include <linux/net.h>
Thomas Graf3fc7e8a2005-06-23 21:00:17 -070026#include <linux/textsearch.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070027#include <net/checksum.h>
Al Viroa80958f2006-12-04 20:41:19 +000028#include <linux/rcupdate.h>
Chris Leech97fc2f02006-05-23 17:55:33 -070029#include <linux/dmaengine.h>
Eric Dumazetb7aa0bf2007-04-19 16:16:32 -070030#include <linux/hrtimer.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070031
32#define HAVE_ALLOC_SKB /* For the drivers to know */
33#define HAVE_ALIGNABLE_SKB /* Ditto 8) */
Linus Torvalds1da177e2005-04-16 15:20:36 -070034
35#define CHECKSUM_NONE 0
Patrick McHardy84fa7932006-08-29 16:44:56 -070036#define CHECKSUM_PARTIAL 1
Linus Torvalds1da177e2005-04-16 15:20:36 -070037#define CHECKSUM_UNNECESSARY 2
Patrick McHardy84fa7932006-08-29 16:44:56 -070038#define CHECKSUM_COMPLETE 3
Linus Torvalds1da177e2005-04-16 15:20:36 -070039
40#define SKB_DATA_ALIGN(X) (((X) + (SMP_CACHE_BYTES - 1)) & \
41 ~(SMP_CACHE_BYTES - 1))
David S. Millerfc910a22007-03-25 20:27:59 -070042#define SKB_WITH_OVERHEAD(X) \
43 (((X) - sizeof(struct skb_shared_info)) & \
44 ~(SMP_CACHE_BYTES - 1))
45#define SKB_MAX_ORDER(X, ORDER) \
46 SKB_WITH_OVERHEAD((PAGE_SIZE << (ORDER)) - (X))
Linus Torvalds1da177e2005-04-16 15:20:36 -070047#define SKB_MAX_HEAD(X) (SKB_MAX_ORDER((X), 0))
48#define SKB_MAX_ALLOC (SKB_MAX_ORDER(0, 2))
49
50/* A. Checksumming of received packets by device.
51 *
52 * NONE: device failed to checksum this packet.
53 * skb->csum is undefined.
54 *
55 * UNNECESSARY: device parsed packet and wouldbe verified checksum.
56 * skb->csum is undefined.
57 * It is bad option, but, unfortunately, many of vendors do this.
58 * Apparently with secret goal to sell you new device, when you
59 * will add new protocol to your host. F.e. IPv6. 8)
60 *
Patrick McHardy84fa7932006-08-29 16:44:56 -070061 * COMPLETE: the most generic way. Device supplied checksum of _all_
Linus Torvalds1da177e2005-04-16 15:20:36 -070062 * the packet as seen by netif_rx in skb->csum.
63 * NOTE: Even if device supports only some protocols, but
Patrick McHardy84fa7932006-08-29 16:44:56 -070064 * is able to produce some skb->csum, it MUST use COMPLETE,
Linus Torvalds1da177e2005-04-16 15:20:36 -070065 * not UNNECESSARY.
66 *
67 * B. Checksumming on output.
68 *
69 * NONE: skb is checksummed by protocol or csum is not required.
70 *
Patrick McHardy84fa7932006-08-29 16:44:56 -070071 * PARTIAL: device is required to csum packet as seen by hard_start_xmit
Linus Torvalds1da177e2005-04-16 15:20:36 -070072 * from skb->h.raw to the end and to record the checksum
73 * at skb->h.raw+skb->csum.
74 *
75 * Device must show its capabilities in dev->features, set
76 * at device setup time.
77 * NETIF_F_HW_CSUM - it is clever device, it is able to checksum
78 * everything.
79 * NETIF_F_NO_CSUM - loopback or reliable single hop media.
80 * NETIF_F_IP_CSUM - device is dumb. It is able to csum only
81 * TCP/UDP over IPv4. Sigh. Vendors like this
82 * way by an unknown reason. Though, see comment above
83 * about CHECKSUM_UNNECESSARY. 8)
84 *
85 * Any questions? No questions, good. --ANK
86 */
87
Linus Torvalds1da177e2005-04-16 15:20:36 -070088struct net_device;
89
90#ifdef CONFIG_NETFILTER
91struct nf_conntrack {
92 atomic_t use;
93 void (*destroy)(struct nf_conntrack *);
94};
95
96#ifdef CONFIG_BRIDGE_NETFILTER
97struct nf_bridge_info {
98 atomic_t use;
99 struct net_device *physindev;
100 struct net_device *physoutdev;
101#if defined(CONFIG_VLAN_8021Q) || defined(CONFIG_VLAN_8021Q_MODULE)
102 struct net_device *netoutdev;
103#endif
104 unsigned int mask;
105 unsigned long data[32 / sizeof(unsigned long)];
106};
107#endif
108
109#endif
110
111struct sk_buff_head {
112 /* These two members must be first. */
113 struct sk_buff *next;
114 struct sk_buff *prev;
115
116 __u32 qlen;
117 spinlock_t lock;
118};
119
120struct sk_buff;
121
122/* To allow 64K frame to be packed as single skb without frag_list */
123#define MAX_SKB_FRAGS (65536/PAGE_SIZE + 2)
124
125typedef struct skb_frag_struct skb_frag_t;
126
127struct skb_frag_struct {
128 struct page *page;
129 __u16 page_offset;
130 __u16 size;
131};
132
133/* This data is invariant across clones and lives at
134 * the end of the header data, ie. at skb->end.
135 */
136struct skb_shared_info {
137 atomic_t dataref;
Benjamin LaHaise4947d3e2006-01-03 14:06:50 -0800138 unsigned short nr_frags;
Herbert Xu79671682006-06-22 02:40:14 -0700139 unsigned short gso_size;
140 /* Warning: this field is not always filled in (UFO)! */
141 unsigned short gso_segs;
142 unsigned short gso_type;
Al Viroae08e1f2006-11-08 00:27:11 -0800143 __be32 ip6_frag_id;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700144 struct sk_buff *frag_list;
145 skb_frag_t frags[MAX_SKB_FRAGS];
146};
147
148/* We divide dataref into two halves. The higher 16 bits hold references
149 * to the payload part of skb->data. The lower 16 bits hold references to
150 * the entire skb->data. It is up to the users of the skb to agree on
151 * where the payload starts.
152 *
153 * All users must obey the rule that the skb->data reference count must be
154 * greater than or equal to the payload reference count.
155 *
156 * Holding a reference to the payload part means that the user does not
157 * care about modifications to the header part of skb->data.
158 */
159#define SKB_DATAREF_SHIFT 16
160#define SKB_DATAREF_MASK ((1 << SKB_DATAREF_SHIFT) - 1)
161
David S. Millerd179cd12005-08-17 14:57:30 -0700162
163enum {
164 SKB_FCLONE_UNAVAILABLE,
165 SKB_FCLONE_ORIG,
166 SKB_FCLONE_CLONE,
167};
168
Herbert Xu79671682006-06-22 02:40:14 -0700169enum {
170 SKB_GSO_TCPV4 = 1 << 0,
Herbert Xuf83ef8c2006-06-30 13:37:03 -0700171 SKB_GSO_UDP = 1 << 1,
Herbert Xu576a30e2006-06-27 13:22:38 -0700172
173 /* This indicates the skb is from an untrusted source. */
174 SKB_GSO_DODGY = 1 << 2,
Michael Chanb0da85372006-06-29 12:30:00 -0700175
176 /* This indicates the tcp segment has CWR set. */
Herbert Xuf83ef8c2006-06-30 13:37:03 -0700177 SKB_GSO_TCP_ECN = 1 << 3,
178
179 SKB_GSO_TCPV6 = 1 << 4,
Herbert Xu79671682006-06-22 02:40:14 -0700180};
181
Linus Torvalds1da177e2005-04-16 15:20:36 -0700182/**
183 * struct sk_buff - socket buffer
184 * @next: Next buffer in list
185 * @prev: Previous buffer in list
Linus Torvalds1da177e2005-04-16 15:20:36 -0700186 * @sk: Socket we are owned by
Herbert Xu325ed822005-10-03 13:57:23 -0700187 * @tstamp: Time we arrived
Linus Torvalds1da177e2005-04-16 15:20:36 -0700188 * @dev: Device we arrived on/are leaving by
Patrick McHardyc01003c2007-03-29 11:46:52 -0700189 * @iif: ifindex of device we arrived on
Linus Torvalds1da177e2005-04-16 15:20:36 -0700190 * @h: Transport layer header
191 * @nh: Network layer header
192 * @mac: Link layer header
Martin Waitz67be2dd2005-05-01 08:59:26 -0700193 * @dst: destination entry
194 * @sp: the security path, used for xfrm
Linus Torvalds1da177e2005-04-16 15:20:36 -0700195 * @cb: Control buffer. Free for use by every layer. Put private vars here
196 * @len: Length of actual data
197 * @data_len: Data length
198 * @mac_len: Length of link layer header
199 * @csum: Checksum
Martin Waitz67be2dd2005-05-01 08:59:26 -0700200 * @local_df: allow local fragmentation
Linus Torvalds1da177e2005-04-16 15:20:36 -0700201 * @cloned: Head may be cloned (check refcnt to be sure)
202 * @nohdr: Payload reference only, must not modify header
203 * @pkt_type: Packet class
Randy Dunlapc83c2482005-10-18 22:07:41 -0700204 * @fclone: skbuff clone status
Linus Torvalds1da177e2005-04-16 15:20:36 -0700205 * @ip_summed: Driver fed us an IP checksum
206 * @priority: Packet queueing priority
207 * @users: User count - see {datagram,tcp}.c
208 * @protocol: Packet protocol from driver
Linus Torvalds1da177e2005-04-16 15:20:36 -0700209 * @truesize: Buffer size
210 * @head: Head of buffer
211 * @data: Data head pointer
212 * @tail: Tail pointer
213 * @end: End pointer
214 * @destructor: Destruct function
Thomas Graf82e91ff2006-11-09 15:19:14 -0800215 * @mark: Generic packet mark
Linus Torvalds1da177e2005-04-16 15:20:36 -0700216 * @nfct: Associated connection, if any
Randy Dunlapc83c2482005-10-18 22:07:41 -0700217 * @ipvs_property: skbuff is owned by ipvs
Linus Torvalds1da177e2005-04-16 15:20:36 -0700218 * @nfctinfo: Relationship of this skb to the connection
Randy Dunlap461ddf32005-11-20 21:25:15 -0800219 * @nfct_reasm: netfilter conntrack re-assembly pointer
Linus Torvalds1da177e2005-04-16 15:20:36 -0700220 * @nf_bridge: Saved data about a bridged frame - see br_netfilter.c
Linus Torvalds1da177e2005-04-16 15:20:36 -0700221 * @tc_index: Traffic control index
222 * @tc_verd: traffic control verdict
Randy Dunlapf4b8ea72006-06-22 16:00:11 -0700223 * @dma_cookie: a cookie to one of several possible DMA operations
224 * done by skb DMA functions
James Morris984bc162006-06-09 00:29:17 -0700225 * @secmark: security marking
Linus Torvalds1da177e2005-04-16 15:20:36 -0700226 */
227
228struct sk_buff {
229 /* These two members must be first. */
230 struct sk_buff *next;
231 struct sk_buff *prev;
232
Linus Torvalds1da177e2005-04-16 15:20:36 -0700233 struct sock *sk;
Eric Dumazetb7aa0bf2007-04-19 16:16:32 -0700234 ktime_t tstamp;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700235 struct net_device *dev;
Patrick McHardyc01003c2007-03-29 11:46:52 -0700236 int iif;
237 /* 4 byte hole on 64 bit*/
Linus Torvalds1da177e2005-04-16 15:20:36 -0700238
239 union {
240 struct tcphdr *th;
241 struct udphdr *uh;
242 struct icmphdr *icmph;
243 struct igmphdr *igmph;
244 struct iphdr *ipiph;
245 struct ipv6hdr *ipv6h;
246 unsigned char *raw;
247 } h;
248
249 union {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700250 unsigned char *raw;
251 } nh;
252
253 union {
254 unsigned char *raw;
255 } mac;
256
257 struct dst_entry *dst;
258 struct sec_path *sp;
259
260 /*
261 * This is the control buffer. It is free to use for every
262 * layer. Please put your private variables there. If you
263 * want to keep them across layers you have to do a skb_clone()
264 * first. This is owned by whoever has the skb queued ATM.
265 */
Patrick McHardy3e3850e2006-01-06 23:04:54 -0800266 char cb[48];
Linus Torvalds1da177e2005-04-16 15:20:36 -0700267
268 unsigned int len,
269 data_len,
Al Viro1f61ab52006-11-14 21:44:08 -0800270 mac_len;
Al Viroff1dcad2006-11-20 18:07:29 -0800271 union {
272 __wsum csum;
273 __u32 csum_offset;
274 };
Linus Torvalds1da177e2005-04-16 15:20:36 -0700275 __u32 priority;
Thomas Graf1cbb3382005-07-05 14:13:41 -0700276 __u8 local_df:1,
277 cloned:1,
278 ip_summed:2,
Harald Welte6869c4d2005-08-09 19:24:19 -0700279 nohdr:1,
280 nfctinfo:3;
David S. Millerd179cd12005-08-17 14:57:30 -0700281 __u8 pkt_type:3,
Patrick McHardyb84f4cc2005-11-20 21:19:21 -0800282 fclone:2,
283 ipvs_property:1;
Alexey Dobriyana0d3bea2005-08-11 16:05:50 -0700284 __be16 protocol;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700285
286 void (*destructor)(struct sk_buff *skb);
287#ifdef CONFIG_NETFILTER
Linus Torvalds1da177e2005-04-16 15:20:36 -0700288 struct nf_conntrack *nfct;
Yasuyuki Kozakai9fb9cbb2005-11-09 16:38:16 -0800289#if defined(CONFIG_NF_CONNTRACK) || defined(CONFIG_NF_CONNTRACK_MODULE)
290 struct sk_buff *nfct_reasm;
291#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -0700292#ifdef CONFIG_BRIDGE_NETFILTER
293 struct nf_bridge_info *nf_bridge;
294#endif
295#endif /* CONFIG_NETFILTER */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700296#ifdef CONFIG_NET_SCHED
Patrick McHardyb6b99eb2005-08-09 19:33:51 -0700297 __u16 tc_index; /* traffic control index */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700298#ifdef CONFIG_NET_CLS_ACT
Patrick McHardyb6b99eb2005-08-09 19:33:51 -0700299 __u16 tc_verd; /* traffic control verdict */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700300#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -0700301#endif
Chris Leech97fc2f02006-05-23 17:55:33 -0700302#ifdef CONFIG_NET_DMA
303 dma_cookie_t dma_cookie;
304#endif
James Morris984bc162006-06-09 00:29:17 -0700305#ifdef CONFIG_NETWORK_SECMARK
306 __u32 secmark;
307#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -0700308
Thomas Graf82e91ff2006-11-09 15:19:14 -0800309 __u32 mark;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700310
311 /* These elements must be at the end, see alloc_skb() for details. */
312 unsigned int truesize;
313 atomic_t users;
314 unsigned char *head,
315 *data,
316 *tail,
317 *end;
318};
319
320#ifdef __KERNEL__
321/*
322 * Handling routines are only of interest to the kernel
323 */
324#include <linux/slab.h>
325
326#include <asm/system.h>
327
Jörn Engel231d06a2006-03-20 21:28:35 -0800328extern void kfree_skb(struct sk_buff *skb);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700329extern void __kfree_skb(struct sk_buff *skb);
David S. Millerd179cd12005-08-17 14:57:30 -0700330extern struct sk_buff *__alloc_skb(unsigned int size,
Christoph Hellwigb30973f2006-12-06 20:32:36 -0800331 gfp_t priority, int fclone, int node);
David S. Millerd179cd12005-08-17 14:57:30 -0700332static inline struct sk_buff *alloc_skb(unsigned int size,
Al Virodd0fc662005-10-07 07:46:04 +0100333 gfp_t priority)
David S. Millerd179cd12005-08-17 14:57:30 -0700334{
Christoph Hellwigb30973f2006-12-06 20:32:36 -0800335 return __alloc_skb(size, priority, 0, -1);
David S. Millerd179cd12005-08-17 14:57:30 -0700336}
337
338static inline struct sk_buff *alloc_skb_fclone(unsigned int size,
Al Virodd0fc662005-10-07 07:46:04 +0100339 gfp_t priority)
David S. Millerd179cd12005-08-17 14:57:30 -0700340{
Christoph Hellwigb30973f2006-12-06 20:32:36 -0800341 return __alloc_skb(size, priority, 1, -1);
David S. Millerd179cd12005-08-17 14:57:30 -0700342}
343
Linus Torvalds1da177e2005-04-16 15:20:36 -0700344extern void kfree_skbmem(struct sk_buff *skb);
Victor Fusco86a76ca2005-07-08 14:57:47 -0700345extern struct sk_buff *skb_clone(struct sk_buff *skb,
Al Virodd0fc662005-10-07 07:46:04 +0100346 gfp_t priority);
Victor Fusco86a76ca2005-07-08 14:57:47 -0700347extern struct sk_buff *skb_copy(const struct sk_buff *skb,
Al Virodd0fc662005-10-07 07:46:04 +0100348 gfp_t priority);
Victor Fusco86a76ca2005-07-08 14:57:47 -0700349extern struct sk_buff *pskb_copy(struct sk_buff *skb,
Al Virodd0fc662005-10-07 07:46:04 +0100350 gfp_t gfp_mask);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700351extern int pskb_expand_head(struct sk_buff *skb,
Victor Fusco86a76ca2005-07-08 14:57:47 -0700352 int nhead, int ntail,
Al Virodd0fc662005-10-07 07:46:04 +0100353 gfp_t gfp_mask);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700354extern struct sk_buff *skb_realloc_headroom(struct sk_buff *skb,
355 unsigned int headroom);
356extern struct sk_buff *skb_copy_expand(const struct sk_buff *skb,
357 int newheadroom, int newtailroom,
Al Virodd0fc662005-10-07 07:46:04 +0100358 gfp_t priority);
Herbert Xu5b057c62006-06-23 02:06:41 -0700359extern int skb_pad(struct sk_buff *skb, int pad);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700360#define dev_kfree_skb(a) kfree_skb(a)
361extern void skb_over_panic(struct sk_buff *skb, int len,
362 void *here);
363extern void skb_under_panic(struct sk_buff *skb, int len,
364 void *here);
David S. Millerdc6de332006-04-20 00:10:50 -0700365extern void skb_truesize_bug(struct sk_buff *skb);
366
367static inline void skb_truesize_check(struct sk_buff *skb)
368{
369 if (unlikely((int)skb->truesize < sizeof(struct sk_buff) + skb->len))
370 skb_truesize_bug(skb);
371}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700372
Ananda Rajue89e9cf2005-10-18 15:46:41 -0700373extern int skb_append_datato_frags(struct sock *sk, struct sk_buff *skb,
374 int getfrag(void *from, char *to, int offset,
375 int len,int odd, struct sk_buff *skb),
376 void *from, int length);
377
Thomas Graf677e90e2005-06-23 20:59:51 -0700378struct skb_seq_state
379{
380 __u32 lower_offset;
381 __u32 upper_offset;
382 __u32 frag_idx;
383 __u32 stepped_offset;
384 struct sk_buff *root_skb;
385 struct sk_buff *cur_skb;
386 __u8 *frag_data;
387};
388
389extern void skb_prepare_seq_read(struct sk_buff *skb,
390 unsigned int from, unsigned int to,
391 struct skb_seq_state *st);
392extern unsigned int skb_seq_read(unsigned int consumed, const u8 **data,
393 struct skb_seq_state *st);
394extern void skb_abort_seq_read(struct skb_seq_state *st);
395
Thomas Graf3fc7e8a2005-06-23 21:00:17 -0700396extern unsigned int skb_find_text(struct sk_buff *skb, unsigned int from,
397 unsigned int to, struct ts_config *config,
398 struct ts_state *state);
399
Linus Torvalds1da177e2005-04-16 15:20:36 -0700400/* Internal */
401#define skb_shinfo(SKB) ((struct skb_shared_info *)((SKB)->end))
402
403/**
404 * skb_queue_empty - check if a queue is empty
405 * @list: queue head
406 *
407 * Returns true if the queue is empty, false otherwise.
408 */
409static inline int skb_queue_empty(const struct sk_buff_head *list)
410{
411 return list->next == (struct sk_buff *)list;
412}
413
414/**
415 * skb_get - reference buffer
416 * @skb: buffer to reference
417 *
418 * Makes another reference to a socket buffer and returns a pointer
419 * to the buffer.
420 */
421static inline struct sk_buff *skb_get(struct sk_buff *skb)
422{
423 atomic_inc(&skb->users);
424 return skb;
425}
426
427/*
428 * If users == 1, we are the only owner and are can avoid redundant
429 * atomic change.
430 */
431
432/**
Linus Torvalds1da177e2005-04-16 15:20:36 -0700433 * skb_cloned - is the buffer a clone
434 * @skb: buffer to check
435 *
436 * Returns true if the buffer was generated with skb_clone() and is
437 * one of multiple shared copies of the buffer. Cloned buffers are
438 * shared data so must not be written to under normal circumstances.
439 */
440static inline int skb_cloned(const struct sk_buff *skb)
441{
442 return skb->cloned &&
443 (atomic_read(&skb_shinfo(skb)->dataref) & SKB_DATAREF_MASK) != 1;
444}
445
446/**
447 * skb_header_cloned - is the header a clone
448 * @skb: buffer to check
449 *
450 * Returns true if modifying the header part of the buffer requires
451 * the data to be copied.
452 */
453static inline int skb_header_cloned(const struct sk_buff *skb)
454{
455 int dataref;
456
457 if (!skb->cloned)
458 return 0;
459
460 dataref = atomic_read(&skb_shinfo(skb)->dataref);
461 dataref = (dataref & SKB_DATAREF_MASK) - (dataref >> SKB_DATAREF_SHIFT);
462 return dataref != 1;
463}
464
465/**
466 * skb_header_release - release reference to header
467 * @skb: buffer to operate on
468 *
469 * Drop a reference to the header part of the buffer. This is done
470 * by acquiring a payload reference. You must not read from the header
471 * part of skb->data after this.
472 */
473static inline void skb_header_release(struct sk_buff *skb)
474{
475 BUG_ON(skb->nohdr);
476 skb->nohdr = 1;
477 atomic_add(1 << SKB_DATAREF_SHIFT, &skb_shinfo(skb)->dataref);
478}
479
480/**
481 * skb_shared - is the buffer shared
482 * @skb: buffer to check
483 *
484 * Returns true if more than one person has a reference to this
485 * buffer.
486 */
487static inline int skb_shared(const struct sk_buff *skb)
488{
489 return atomic_read(&skb->users) != 1;
490}
491
492/**
493 * skb_share_check - check if buffer is shared and if so clone it
494 * @skb: buffer to check
495 * @pri: priority for memory allocation
496 *
497 * If the buffer is shared the buffer is cloned and the old copy
498 * drops a reference. A new clone with a single reference is returned.
499 * If the buffer is not shared the original buffer is returned. When
500 * being called from interrupt status or with spinlocks held pri must
501 * be GFP_ATOMIC.
502 *
503 * NULL is returned on a memory allocation failure.
504 */
Victor Fusco86a76ca2005-07-08 14:57:47 -0700505static inline struct sk_buff *skb_share_check(struct sk_buff *skb,
Al Virodd0fc662005-10-07 07:46:04 +0100506 gfp_t pri)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700507{
508 might_sleep_if(pri & __GFP_WAIT);
509 if (skb_shared(skb)) {
510 struct sk_buff *nskb = skb_clone(skb, pri);
511 kfree_skb(skb);
512 skb = nskb;
513 }
514 return skb;
515}
516
517/*
518 * Copy shared buffers into a new sk_buff. We effectively do COW on
519 * packets to handle cases where we have a local reader and forward
520 * and a couple of other messy ones. The normal one is tcpdumping
521 * a packet thats being forwarded.
522 */
523
524/**
525 * skb_unshare - make a copy of a shared buffer
526 * @skb: buffer to check
527 * @pri: priority for memory allocation
528 *
529 * If the socket buffer is a clone then this function creates a new
530 * copy of the data, drops a reference count on the old copy and returns
531 * the new copy with the reference count at 1. If the buffer is not a clone
532 * the original buffer is returned. When called with a spinlock held or
533 * from interrupt state @pri must be %GFP_ATOMIC
534 *
535 * %NULL is returned on a memory allocation failure.
536 */
Victor Fuscoe2bf5212005-07-18 13:36:38 -0700537static inline struct sk_buff *skb_unshare(struct sk_buff *skb,
Al Virodd0fc662005-10-07 07:46:04 +0100538 gfp_t pri)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700539{
540 might_sleep_if(pri & __GFP_WAIT);
541 if (skb_cloned(skb)) {
542 struct sk_buff *nskb = skb_copy(skb, pri);
543 kfree_skb(skb); /* Free our shared copy */
544 skb = nskb;
545 }
546 return skb;
547}
548
549/**
550 * skb_peek
551 * @list_: list to peek at
552 *
553 * Peek an &sk_buff. Unlike most other operations you _MUST_
554 * be careful with this one. A peek leaves the buffer on the
555 * list and someone else may run off with it. You must hold
556 * the appropriate locks or have a private queue to do this.
557 *
558 * Returns %NULL for an empty list or a pointer to the head element.
559 * The reference count is not incremented and the reference is therefore
560 * volatile. Use with caution.
561 */
562static inline struct sk_buff *skb_peek(struct sk_buff_head *list_)
563{
564 struct sk_buff *list = ((struct sk_buff *)list_)->next;
565 if (list == (struct sk_buff *)list_)
566 list = NULL;
567 return list;
568}
569
570/**
571 * skb_peek_tail
572 * @list_: list to peek at
573 *
574 * Peek an &sk_buff. Unlike most other operations you _MUST_
575 * be careful with this one. A peek leaves the buffer on the
576 * list and someone else may run off with it. You must hold
577 * the appropriate locks or have a private queue to do this.
578 *
579 * Returns %NULL for an empty list or a pointer to the tail element.
580 * The reference count is not incremented and the reference is therefore
581 * volatile. Use with caution.
582 */
583static inline struct sk_buff *skb_peek_tail(struct sk_buff_head *list_)
584{
585 struct sk_buff *list = ((struct sk_buff *)list_)->prev;
586 if (list == (struct sk_buff *)list_)
587 list = NULL;
588 return list;
589}
590
591/**
592 * skb_queue_len - get queue length
593 * @list_: list to measure
594 *
595 * Return the length of an &sk_buff queue.
596 */
597static inline __u32 skb_queue_len(const struct sk_buff_head *list_)
598{
599 return list_->qlen;
600}
601
Arjan van de Ven76f10ad2006-08-02 14:06:55 -0700602/*
603 * This function creates a split out lock class for each invocation;
604 * this is needed for now since a whole lot of users of the skb-queue
605 * infrastructure in drivers have different locking usage (in hardirq)
606 * than the networking core (in softirq only). In the long run either the
607 * network layer or drivers should need annotation to consolidate the
608 * main types of usage into 3 classes.
609 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700610static inline void skb_queue_head_init(struct sk_buff_head *list)
611{
612 spin_lock_init(&list->lock);
613 list->prev = list->next = (struct sk_buff *)list;
614 list->qlen = 0;
615}
616
Pavel Emelianovc2ecba72007-04-17 12:45:31 -0700617static inline void skb_queue_head_init_class(struct sk_buff_head *list,
618 struct lock_class_key *class)
619{
620 skb_queue_head_init(list);
621 lockdep_set_class(&list->lock, class);
622}
623
Linus Torvalds1da177e2005-04-16 15:20:36 -0700624/*
625 * Insert an sk_buff at the start of a list.
626 *
627 * The "__skb_xxxx()" functions are the non-atomic ones that
628 * can only be called with interrupts disabled.
629 */
630
631/**
Stephen Hemminger300ce172005-10-30 13:47:34 -0800632 * __skb_queue_after - queue a buffer at the list head
633 * @list: list to use
634 * @prev: place after this buffer
635 * @newsk: buffer to queue
636 *
637 * Queue a buffer int the middle of a list. This function takes no locks
638 * and you must therefore hold required locks before calling it.
639 *
640 * A buffer cannot be placed on two lists at the same time.
641 */
642static inline void __skb_queue_after(struct sk_buff_head *list,
643 struct sk_buff *prev,
644 struct sk_buff *newsk)
645{
646 struct sk_buff *next;
647 list->qlen++;
648
649 next = prev->next;
650 newsk->next = next;
651 newsk->prev = prev;
652 next->prev = prev->next = newsk;
653}
654
655/**
Linus Torvalds1da177e2005-04-16 15:20:36 -0700656 * __skb_queue_head - queue a buffer at the list head
657 * @list: list to use
658 * @newsk: buffer to queue
659 *
660 * Queue a buffer at the start of a list. This function takes no locks
661 * and you must therefore hold required locks before calling it.
662 *
663 * A buffer cannot be placed on two lists at the same time.
664 */
665extern void skb_queue_head(struct sk_buff_head *list, struct sk_buff *newsk);
666static inline void __skb_queue_head(struct sk_buff_head *list,
667 struct sk_buff *newsk)
668{
Stephen Hemminger300ce172005-10-30 13:47:34 -0800669 __skb_queue_after(list, (struct sk_buff *)list, newsk);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700670}
671
672/**
673 * __skb_queue_tail - queue a buffer at the list tail
674 * @list: list to use
675 * @newsk: buffer to queue
676 *
677 * Queue a buffer at the end of a list. This function takes no locks
678 * and you must therefore hold required locks before calling it.
679 *
680 * A buffer cannot be placed on two lists at the same time.
681 */
682extern void skb_queue_tail(struct sk_buff_head *list, struct sk_buff *newsk);
683static inline void __skb_queue_tail(struct sk_buff_head *list,
684 struct sk_buff *newsk)
685{
686 struct sk_buff *prev, *next;
687
Linus Torvalds1da177e2005-04-16 15:20:36 -0700688 list->qlen++;
689 next = (struct sk_buff *)list;
690 prev = next->prev;
691 newsk->next = next;
692 newsk->prev = prev;
693 next->prev = prev->next = newsk;
694}
695
696
697/**
698 * __skb_dequeue - remove from the head of the queue
699 * @list: list to dequeue from
700 *
701 * Remove the head of the list. This function does not take any locks
702 * so must be used with appropriate locks held only. The head item is
703 * returned or %NULL if the list is empty.
704 */
705extern struct sk_buff *skb_dequeue(struct sk_buff_head *list);
706static inline struct sk_buff *__skb_dequeue(struct sk_buff_head *list)
707{
708 struct sk_buff *next, *prev, *result;
709
710 prev = (struct sk_buff *) list;
711 next = prev->next;
712 result = NULL;
713 if (next != prev) {
714 result = next;
715 next = next->next;
716 list->qlen--;
717 next->prev = prev;
718 prev->next = next;
719 result->next = result->prev = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700720 }
721 return result;
722}
723
724
725/*
726 * Insert a packet on a list.
727 */
David S. Miller8728b832005-08-09 19:25:21 -0700728extern void skb_insert(struct sk_buff *old, struct sk_buff *newsk, struct sk_buff_head *list);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700729static inline void __skb_insert(struct sk_buff *newsk,
730 struct sk_buff *prev, struct sk_buff *next,
731 struct sk_buff_head *list)
732{
733 newsk->next = next;
734 newsk->prev = prev;
735 next->prev = prev->next = newsk;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700736 list->qlen++;
737}
738
739/*
740 * Place a packet after a given packet in a list.
741 */
David S. Miller8728b832005-08-09 19:25:21 -0700742extern void skb_append(struct sk_buff *old, struct sk_buff *newsk, struct sk_buff_head *list);
743static inline void __skb_append(struct sk_buff *old, struct sk_buff *newsk, struct sk_buff_head *list)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700744{
David S. Miller8728b832005-08-09 19:25:21 -0700745 __skb_insert(newsk, old, old->next, list);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700746}
747
748/*
749 * remove sk_buff from list. _Must_ be called atomically, and with
750 * the list known..
751 */
David S. Miller8728b832005-08-09 19:25:21 -0700752extern void skb_unlink(struct sk_buff *skb, struct sk_buff_head *list);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700753static inline void __skb_unlink(struct sk_buff *skb, struct sk_buff_head *list)
754{
755 struct sk_buff *next, *prev;
756
757 list->qlen--;
758 next = skb->next;
759 prev = skb->prev;
760 skb->next = skb->prev = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700761 next->prev = prev;
762 prev->next = next;
763}
764
765
766/* XXX: more streamlined implementation */
767
768/**
769 * __skb_dequeue_tail - remove from the tail of the queue
770 * @list: list to dequeue from
771 *
772 * Remove the tail of the list. This function does not take any locks
773 * so must be used with appropriate locks held only. The tail item is
774 * returned or %NULL if the list is empty.
775 */
776extern struct sk_buff *skb_dequeue_tail(struct sk_buff_head *list);
777static inline struct sk_buff *__skb_dequeue_tail(struct sk_buff_head *list)
778{
779 struct sk_buff *skb = skb_peek_tail(list);
780 if (skb)
781 __skb_unlink(skb, list);
782 return skb;
783}
784
785
786static inline int skb_is_nonlinear(const struct sk_buff *skb)
787{
788 return skb->data_len;
789}
790
791static inline unsigned int skb_headlen(const struct sk_buff *skb)
792{
793 return skb->len - skb->data_len;
794}
795
796static inline int skb_pagelen(const struct sk_buff *skb)
797{
798 int i, len = 0;
799
800 for (i = (int)skb_shinfo(skb)->nr_frags - 1; i >= 0; i--)
801 len += skb_shinfo(skb)->frags[i].size;
802 return len + skb_headlen(skb);
803}
804
805static inline void skb_fill_page_desc(struct sk_buff *skb, int i,
806 struct page *page, int off, int size)
807{
808 skb_frag_t *frag = &skb_shinfo(skb)->frags[i];
809
810 frag->page = page;
811 frag->page_offset = off;
812 frag->size = size;
813 skb_shinfo(skb)->nr_frags = i + 1;
814}
815
816#define SKB_PAGE_ASSERT(skb) BUG_ON(skb_shinfo(skb)->nr_frags)
817#define SKB_FRAG_ASSERT(skb) BUG_ON(skb_shinfo(skb)->frag_list)
818#define SKB_LINEAR_ASSERT(skb) BUG_ON(skb_is_nonlinear(skb))
819
820/*
821 * Add data to an sk_buff
822 */
823static inline unsigned char *__skb_put(struct sk_buff *skb, unsigned int len)
824{
825 unsigned char *tmp = skb->tail;
826 SKB_LINEAR_ASSERT(skb);
827 skb->tail += len;
828 skb->len += len;
829 return tmp;
830}
831
832/**
833 * skb_put - add data to a buffer
834 * @skb: buffer to use
835 * @len: amount of data to add
836 *
837 * This function extends the used data area of the buffer. If this would
838 * exceed the total buffer size the kernel will panic. A pointer to the
839 * first byte of the extra data is returned.
840 */
841static inline unsigned char *skb_put(struct sk_buff *skb, unsigned int len)
842{
843 unsigned char *tmp = skb->tail;
844 SKB_LINEAR_ASSERT(skb);
845 skb->tail += len;
846 skb->len += len;
847 if (unlikely(skb->tail>skb->end))
848 skb_over_panic(skb, len, current_text_addr());
849 return tmp;
850}
851
852static inline unsigned char *__skb_push(struct sk_buff *skb, unsigned int len)
853{
854 skb->data -= len;
855 skb->len += len;
856 return skb->data;
857}
858
859/**
860 * skb_push - add data to the start of a buffer
861 * @skb: buffer to use
862 * @len: amount of data to add
863 *
864 * This function extends the used data area of the buffer at the buffer
865 * start. If this would exceed the total buffer headroom the kernel will
866 * panic. A pointer to the first byte of the extra data is returned.
867 */
868static inline unsigned char *skb_push(struct sk_buff *skb, unsigned int len)
869{
870 skb->data -= len;
871 skb->len += len;
872 if (unlikely(skb->data<skb->head))
873 skb_under_panic(skb, len, current_text_addr());
874 return skb->data;
875}
876
877static inline unsigned char *__skb_pull(struct sk_buff *skb, unsigned int len)
878{
879 skb->len -= len;
880 BUG_ON(skb->len < skb->data_len);
881 return skb->data += len;
882}
883
884/**
885 * skb_pull - remove data from the start of a buffer
886 * @skb: buffer to use
887 * @len: amount of data to remove
888 *
889 * This function removes data from the start of a buffer, returning
890 * the memory to the headroom. A pointer to the next data in the buffer
891 * is returned. Once the data has been pulled future pushes will overwrite
892 * the old data.
893 */
894static inline unsigned char *skb_pull(struct sk_buff *skb, unsigned int len)
895{
896 return unlikely(len > skb->len) ? NULL : __skb_pull(skb, len);
897}
898
899extern unsigned char *__pskb_pull_tail(struct sk_buff *skb, int delta);
900
901static inline unsigned char *__pskb_pull(struct sk_buff *skb, unsigned int len)
902{
903 if (len > skb_headlen(skb) &&
904 !__pskb_pull_tail(skb, len-skb_headlen(skb)))
905 return NULL;
906 skb->len -= len;
907 return skb->data += len;
908}
909
910static inline unsigned char *pskb_pull(struct sk_buff *skb, unsigned int len)
911{
912 return unlikely(len > skb->len) ? NULL : __pskb_pull(skb, len);
913}
914
915static inline int pskb_may_pull(struct sk_buff *skb, unsigned int len)
916{
917 if (likely(len <= skb_headlen(skb)))
918 return 1;
919 if (unlikely(len > skb->len))
920 return 0;
921 return __pskb_pull_tail(skb, len-skb_headlen(skb)) != NULL;
922}
923
924/**
925 * skb_headroom - bytes at buffer head
926 * @skb: buffer to check
927 *
928 * Return the number of bytes of free space at the head of an &sk_buff.
929 */
930static inline int skb_headroom(const struct sk_buff *skb)
931{
932 return skb->data - skb->head;
933}
934
935/**
936 * skb_tailroom - bytes at buffer end
937 * @skb: buffer to check
938 *
939 * Return the number of bytes of free space at the tail of an sk_buff
940 */
941static inline int skb_tailroom(const struct sk_buff *skb)
942{
943 return skb_is_nonlinear(skb) ? 0 : skb->end - skb->tail;
944}
945
946/**
947 * skb_reserve - adjust headroom
948 * @skb: buffer to alter
949 * @len: bytes to move
950 *
951 * Increase the headroom of an empty &sk_buff by reducing the tail
952 * room. This is only allowed for an empty buffer.
953 */
David S. Miller8243126c2006-01-17 02:54:21 -0800954static inline void skb_reserve(struct sk_buff *skb, int len)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700955{
956 skb->data += len;
957 skb->tail += len;
958}
959
Arnaldo Carvalho de Melobadff6d2007-03-13 13:06:52 -0300960static inline void skb_reset_transport_header(struct sk_buff *skb)
961{
962 skb->h.raw = skb->data;
963}
964
Arnaldo Carvalho de Melod56f90a2007-04-10 20:50:43 -0700965static inline unsigned char *skb_network_header(const struct sk_buff *skb)
966{
967 return skb->nh.raw;
968}
969
Arnaldo Carvalho de Meloc1d2bbe2007-04-10 20:45:18 -0700970static inline void skb_reset_network_header(struct sk_buff *skb)
971{
972 skb->nh.raw = skb->data;
973}
974
Arnaldo Carvalho de Meloc14d2452007-03-11 22:39:41 -0300975static inline void skb_set_network_header(struct sk_buff *skb, const int offset)
976{
977 skb->nh.raw = skb->data + offset;
978}
979
Arnaldo Carvalho de Melobbe735e2007-03-10 22:16:10 -0300980static inline int skb_network_offset(const struct sk_buff *skb)
981{
982 return skb->nh.raw - skb->data;
983}
984
Arnaldo Carvalho de Melo98e399f2007-03-19 15:33:04 -0700985static inline unsigned char *skb_mac_header(const struct sk_buff *skb)
986{
987 return skb->mac.raw;
988}
989
990static inline int skb_mac_header_was_set(const struct sk_buff *skb)
991{
992 return skb->mac.raw != NULL;
993}
994
Arnaldo Carvalho de Melo459a98e2007-03-19 15:30:44 -0700995static inline void skb_reset_mac_header(struct sk_buff *skb)
996{
997 skb->mac.raw = skb->data;
998}
999
Arnaldo Carvalho de Melo48d49d0c2007-03-10 12:30:58 -03001000static inline void skb_set_mac_header(struct sk_buff *skb, const int offset)
1001{
1002 skb->mac.raw = skb->data + offset;
1003}
1004
Linus Torvalds1da177e2005-04-16 15:20:36 -07001005/*
1006 * CPUs often take a performance hit when accessing unaligned memory
1007 * locations. The actual performance hit varies, it can be small if the
1008 * hardware handles it or large if we have to take an exception and fix it
1009 * in software.
1010 *
1011 * Since an ethernet header is 14 bytes network drivers often end up with
1012 * the IP header at an unaligned offset. The IP header can be aligned by
1013 * shifting the start of the packet by 2 bytes. Drivers should do this
1014 * with:
1015 *
1016 * skb_reserve(NET_IP_ALIGN);
1017 *
1018 * The downside to this alignment of the IP header is that the DMA is now
1019 * unaligned. On some architectures the cost of an unaligned DMA is high
1020 * and this cost outweighs the gains made by aligning the IP header.
1021 *
1022 * Since this trade off varies between architectures, we allow NET_IP_ALIGN
1023 * to be overridden.
1024 */
1025#ifndef NET_IP_ALIGN
1026#define NET_IP_ALIGN 2
1027#endif
1028
Anton Blanchard025be812006-03-31 02:27:06 -08001029/*
1030 * The networking layer reserves some headroom in skb data (via
1031 * dev_alloc_skb). This is used to avoid having to reallocate skb data when
1032 * the header has to grow. In the default case, if the header has to grow
1033 * 16 bytes or less we avoid the reallocation.
1034 *
1035 * Unfortunately this headroom changes the DMA alignment of the resulting
1036 * network packet. As for NET_IP_ALIGN, this unaligned DMA is expensive
1037 * on some architectures. An architecture can override this value,
1038 * perhaps setting it to a cacheline in size (since that will maintain
1039 * cacheline alignment of the DMA). It must be a power of 2.
1040 *
1041 * Various parts of the networking layer expect at least 16 bytes of
1042 * headroom, you should not reduce this.
1043 */
1044#ifndef NET_SKB_PAD
1045#define NET_SKB_PAD 16
1046#endif
1047
Herbert Xu3cc0e872006-06-09 16:13:38 -07001048extern int ___pskb_trim(struct sk_buff *skb, unsigned int len);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001049
1050static inline void __skb_trim(struct sk_buff *skb, unsigned int len)
1051{
Herbert Xu3cc0e872006-06-09 16:13:38 -07001052 if (unlikely(skb->data_len)) {
1053 WARN_ON(1);
1054 return;
1055 }
1056 skb->len = len;
1057 skb->tail = skb->data + len;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001058}
1059
1060/**
1061 * skb_trim - remove end from a buffer
1062 * @skb: buffer to alter
1063 * @len: new length
1064 *
1065 * Cut the length of a buffer down by removing data from the tail. If
1066 * the buffer is already under the length specified it is not modified.
Herbert Xu3cc0e872006-06-09 16:13:38 -07001067 * The skb must be linear.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001068 */
1069static inline void skb_trim(struct sk_buff *skb, unsigned int len)
1070{
1071 if (skb->len > len)
1072 __skb_trim(skb, len);
1073}
1074
1075
1076static inline int __pskb_trim(struct sk_buff *skb, unsigned int len)
1077{
Herbert Xu3cc0e872006-06-09 16:13:38 -07001078 if (skb->data_len)
1079 return ___pskb_trim(skb, len);
1080 __skb_trim(skb, len);
1081 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001082}
1083
1084static inline int pskb_trim(struct sk_buff *skb, unsigned int len)
1085{
1086 return (len < skb->len) ? __pskb_trim(skb, len) : 0;
1087}
1088
1089/**
Herbert Xue9fa4f72006-08-13 20:12:58 -07001090 * pskb_trim_unique - remove end from a paged unique (not cloned) buffer
1091 * @skb: buffer to alter
1092 * @len: new length
1093 *
1094 * This is identical to pskb_trim except that the caller knows that
1095 * the skb is not cloned so we should never get an error due to out-
1096 * of-memory.
1097 */
1098static inline void pskb_trim_unique(struct sk_buff *skb, unsigned int len)
1099{
1100 int err = pskb_trim(skb, len);
1101 BUG_ON(err);
1102}
1103
1104/**
Linus Torvalds1da177e2005-04-16 15:20:36 -07001105 * skb_orphan - orphan a buffer
1106 * @skb: buffer to orphan
1107 *
1108 * If a buffer currently has an owner then we call the owner's
1109 * destructor function and make the @skb unowned. The buffer continues
1110 * to exist but is no longer charged to its former owner.
1111 */
1112static inline void skb_orphan(struct sk_buff *skb)
1113{
1114 if (skb->destructor)
1115 skb->destructor(skb);
1116 skb->destructor = NULL;
1117 skb->sk = NULL;
1118}
1119
1120/**
1121 * __skb_queue_purge - empty a list
1122 * @list: list to empty
1123 *
1124 * Delete all buffers on an &sk_buff list. Each buffer is removed from
1125 * the list and one reference dropped. This function does not take the
1126 * list lock and the caller must hold the relevant locks to use it.
1127 */
1128extern void skb_queue_purge(struct sk_buff_head *list);
1129static inline void __skb_queue_purge(struct sk_buff_head *list)
1130{
1131 struct sk_buff *skb;
1132 while ((skb = __skb_dequeue(list)) != NULL)
1133 kfree_skb(skb);
1134}
1135
1136/**
Christoph Hellwigb4e54de2006-07-24 15:31:14 -07001137 * __dev_alloc_skb - allocate an skbuff for receiving
Linus Torvalds1da177e2005-04-16 15:20:36 -07001138 * @length: length to allocate
1139 * @gfp_mask: get_free_pages mask, passed to alloc_skb
1140 *
1141 * Allocate a new &sk_buff and assign it a usage count of one. The
1142 * buffer has unspecified headroom built in. Users should allocate
1143 * the headroom they think they need without accounting for the
1144 * built in space. The built in space is used for optimisations.
1145 *
Christoph Hellwig766ea8c2006-08-07 15:49:53 -07001146 * %NULL is returned if there is no free memory.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001147 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001148static inline struct sk_buff *__dev_alloc_skb(unsigned int length,
Al Virodd0fc662005-10-07 07:46:04 +01001149 gfp_t gfp_mask)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001150{
Anton Blanchard025be812006-03-31 02:27:06 -08001151 struct sk_buff *skb = alloc_skb(length + NET_SKB_PAD, gfp_mask);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001152 if (likely(skb))
Anton Blanchard025be812006-03-31 02:27:06 -08001153 skb_reserve(skb, NET_SKB_PAD);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001154 return skb;
1155}
Linus Torvalds1da177e2005-04-16 15:20:36 -07001156
1157/**
Christoph Hellwigb4e54de2006-07-24 15:31:14 -07001158 * dev_alloc_skb - allocate an skbuff for receiving
Linus Torvalds1da177e2005-04-16 15:20:36 -07001159 * @length: length to allocate
1160 *
1161 * Allocate a new &sk_buff and assign it a usage count of one. The
1162 * buffer has unspecified headroom built in. Users should allocate
1163 * the headroom they think they need without accounting for the
1164 * built in space. The built in space is used for optimisations.
1165 *
Christoph Hellwig766ea8c2006-08-07 15:49:53 -07001166 * %NULL is returned if there is no free memory. Although this function
Linus Torvalds1da177e2005-04-16 15:20:36 -07001167 * allocates memory it can be called from an interrupt.
1168 */
1169static inline struct sk_buff *dev_alloc_skb(unsigned int length)
1170{
1171 return __dev_alloc_skb(length, GFP_ATOMIC);
1172}
1173
Christoph Hellwig8af27452006-07-31 22:35:23 -07001174extern struct sk_buff *__netdev_alloc_skb(struct net_device *dev,
1175 unsigned int length, gfp_t gfp_mask);
1176
1177/**
1178 * netdev_alloc_skb - allocate an skbuff for rx on a specific device
1179 * @dev: network device to receive on
1180 * @length: length to allocate
1181 *
1182 * Allocate a new &sk_buff and assign it a usage count of one. The
1183 * buffer has unspecified headroom built in. Users should allocate
1184 * the headroom they think they need without accounting for the
1185 * built in space. The built in space is used for optimisations.
1186 *
1187 * %NULL is returned if there is no free memory. Although this function
1188 * allocates memory it can be called from an interrupt.
1189 */
1190static inline struct sk_buff *netdev_alloc_skb(struct net_device *dev,
1191 unsigned int length)
1192{
1193 return __netdev_alloc_skb(dev, length, GFP_ATOMIC);
1194}
1195
Linus Torvalds1da177e2005-04-16 15:20:36 -07001196/**
1197 * skb_cow - copy header of skb when it is required
1198 * @skb: buffer to cow
1199 * @headroom: needed headroom
1200 *
1201 * If the skb passed lacks sufficient headroom or its data part
1202 * is shared, data is reallocated. If reallocation fails, an error
1203 * is returned and original skb is not changed.
1204 *
1205 * The result is skb with writable area skb->head...skb->tail
1206 * and at least @headroom of space at head.
1207 */
1208static inline int skb_cow(struct sk_buff *skb, unsigned int headroom)
1209{
Anton Blanchard025be812006-03-31 02:27:06 -08001210 int delta = (headroom > NET_SKB_PAD ? headroom : NET_SKB_PAD) -
1211 skb_headroom(skb);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001212
1213 if (delta < 0)
1214 delta = 0;
1215
1216 if (delta || skb_cloned(skb))
Anton Blanchard025be812006-03-31 02:27:06 -08001217 return pskb_expand_head(skb, (delta + (NET_SKB_PAD-1)) &
1218 ~(NET_SKB_PAD-1), 0, GFP_ATOMIC);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001219 return 0;
1220}
1221
1222/**
1223 * skb_padto - pad an skbuff up to a minimal size
1224 * @skb: buffer to pad
1225 * @len: minimal length
1226 *
1227 * Pads up a buffer to ensure the trailing bytes exist and are
1228 * blanked. If the buffer already contains sufficient data it
Herbert Xu5b057c62006-06-23 02:06:41 -07001229 * is untouched. Otherwise it is extended. Returns zero on
1230 * success. The skb is freed on error.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001231 */
1232
Herbert Xu5b057c62006-06-23 02:06:41 -07001233static inline int skb_padto(struct sk_buff *skb, unsigned int len)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001234{
1235 unsigned int size = skb->len;
1236 if (likely(size >= len))
Herbert Xu5b057c62006-06-23 02:06:41 -07001237 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001238 return skb_pad(skb, len-size);
1239}
1240
1241static inline int skb_add_data(struct sk_buff *skb,
1242 char __user *from, int copy)
1243{
1244 const int off = skb->len;
1245
1246 if (skb->ip_summed == CHECKSUM_NONE) {
1247 int err = 0;
Al Viro50842052006-11-14 21:36:34 -08001248 __wsum csum = csum_and_copy_from_user(from, skb_put(skb, copy),
Linus Torvalds1da177e2005-04-16 15:20:36 -07001249 copy, 0, &err);
1250 if (!err) {
1251 skb->csum = csum_block_add(skb->csum, csum, off);
1252 return 0;
1253 }
1254 } else if (!copy_from_user(skb_put(skb, copy), from, copy))
1255 return 0;
1256
1257 __skb_trim(skb, off);
1258 return -EFAULT;
1259}
1260
1261static inline int skb_can_coalesce(struct sk_buff *skb, int i,
1262 struct page *page, int off)
1263{
1264 if (i) {
1265 struct skb_frag_struct *frag = &skb_shinfo(skb)->frags[i - 1];
1266
1267 return page == frag->page &&
1268 off == frag->page_offset + frag->size;
1269 }
1270 return 0;
1271}
1272
Herbert Xu364c6ba2006-06-09 16:10:40 -07001273static inline int __skb_linearize(struct sk_buff *skb)
1274{
1275 return __pskb_pull_tail(skb, skb->data_len) ? 0 : -ENOMEM;
1276}
1277
Linus Torvalds1da177e2005-04-16 15:20:36 -07001278/**
1279 * skb_linearize - convert paged skb to linear one
1280 * @skb: buffer to linarize
Linus Torvalds1da177e2005-04-16 15:20:36 -07001281 *
1282 * If there is no free memory -ENOMEM is returned, otherwise zero
1283 * is returned and the old skb data released.
1284 */
Herbert Xu364c6ba2006-06-09 16:10:40 -07001285static inline int skb_linearize(struct sk_buff *skb)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001286{
Herbert Xu364c6ba2006-06-09 16:10:40 -07001287 return skb_is_nonlinear(skb) ? __skb_linearize(skb) : 0;
1288}
1289
1290/**
1291 * skb_linearize_cow - make sure skb is linear and writable
1292 * @skb: buffer to process
1293 *
1294 * If there is no free memory -ENOMEM is returned, otherwise zero
1295 * is returned and the old skb data released.
1296 */
1297static inline int skb_linearize_cow(struct sk_buff *skb)
1298{
1299 return skb_is_nonlinear(skb) || skb_cloned(skb) ?
1300 __skb_linearize(skb) : 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001301}
1302
1303/**
1304 * skb_postpull_rcsum - update checksum for received skb after pull
1305 * @skb: buffer to update
1306 * @start: start of data before pull
1307 * @len: length of data pulled
1308 *
1309 * After doing a pull on a received packet, you need to call this to
Patrick McHardy84fa7932006-08-29 16:44:56 -07001310 * update the CHECKSUM_COMPLETE checksum, or set ip_summed to
1311 * CHECKSUM_NONE so that it can be recomputed from scratch.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001312 */
1313
1314static inline void skb_postpull_rcsum(struct sk_buff *skb,
Herbert Xucbb042f2006-03-20 22:43:56 -08001315 const void *start, unsigned int len)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001316{
Patrick McHardy84fa7932006-08-29 16:44:56 -07001317 if (skb->ip_summed == CHECKSUM_COMPLETE)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001318 skb->csum = csum_sub(skb->csum, csum_partial(start, len, 0));
1319}
1320
Herbert Xucbb042f2006-03-20 22:43:56 -08001321unsigned char *skb_pull_rcsum(struct sk_buff *skb, unsigned int len);
1322
Linus Torvalds1da177e2005-04-16 15:20:36 -07001323/**
1324 * pskb_trim_rcsum - trim received skb and update checksum
1325 * @skb: buffer to trim
1326 * @len: new length
1327 *
1328 * This is exactly the same as pskb_trim except that it ensures the
1329 * checksum of received packets are still valid after the operation.
1330 */
1331
1332static inline int pskb_trim_rcsum(struct sk_buff *skb, unsigned int len)
1333{
Stephen Hemminger0e4e4222005-09-08 12:32:03 -07001334 if (likely(len >= skb->len))
Linus Torvalds1da177e2005-04-16 15:20:36 -07001335 return 0;
Patrick McHardy84fa7932006-08-29 16:44:56 -07001336 if (skb->ip_summed == CHECKSUM_COMPLETE)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001337 skb->ip_summed = CHECKSUM_NONE;
1338 return __pskb_trim(skb, len);
1339}
1340
Linus Torvalds1da177e2005-04-16 15:20:36 -07001341#define skb_queue_walk(queue, skb) \
1342 for (skb = (queue)->next; \
1343 prefetch(skb->next), (skb != (struct sk_buff *)(queue)); \
1344 skb = skb->next)
1345
Stephen Hemminger300ce172005-10-30 13:47:34 -08001346#define skb_queue_reverse_walk(queue, skb) \
1347 for (skb = (queue)->prev; \
1348 prefetch(skb->prev), (skb != (struct sk_buff *)(queue)); \
1349 skb = skb->prev)
1350
Linus Torvalds1da177e2005-04-16 15:20:36 -07001351
1352extern struct sk_buff *skb_recv_datagram(struct sock *sk, unsigned flags,
1353 int noblock, int *err);
1354extern unsigned int datagram_poll(struct file *file, struct socket *sock,
1355 struct poll_table_struct *wait);
1356extern int skb_copy_datagram_iovec(const struct sk_buff *from,
1357 int offset, struct iovec *to,
1358 int size);
Herbert Xufb286bb2005-11-10 13:01:24 -08001359extern int skb_copy_and_csum_datagram_iovec(struct sk_buff *skb,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001360 int hlen,
1361 struct iovec *iov);
1362extern void skb_free_datagram(struct sock *sk, struct sk_buff *skb);
Herbert Xu3305b802005-12-13 23:16:37 -08001363extern void skb_kill_datagram(struct sock *sk, struct sk_buff *skb,
1364 unsigned int flags);
Al Viro2bbbc862006-11-14 21:37:14 -08001365extern __wsum skb_checksum(const struct sk_buff *skb, int offset,
1366 int len, __wsum csum);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001367extern int skb_copy_bits(const struct sk_buff *skb, int offset,
1368 void *to, int len);
Herbert Xu357b40a2005-04-19 22:30:14 -07001369extern int skb_store_bits(const struct sk_buff *skb, int offset,
1370 void *from, int len);
Al Viro81d77662006-11-14 21:37:33 -08001371extern __wsum skb_copy_and_csum_bits(const struct sk_buff *skb,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001372 int offset, u8 *to, int len,
Al Viro81d77662006-11-14 21:37:33 -08001373 __wsum csum);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001374extern void skb_copy_and_csum_dev(const struct sk_buff *skb, u8 *to);
1375extern void skb_split(struct sk_buff *skb,
1376 struct sk_buff *skb1, const u32 len);
1377
Herbert Xu576a30e2006-06-27 13:22:38 -07001378extern struct sk_buff *skb_segment(struct sk_buff *skb, int features);
Arnaldo Carvalho de Melo20380732005-08-16 02:18:02 -03001379
Linus Torvalds1da177e2005-04-16 15:20:36 -07001380static inline void *skb_header_pointer(const struct sk_buff *skb, int offset,
1381 int len, void *buffer)
1382{
1383 int hlen = skb_headlen(skb);
1384
Patrick McHardy55820ee2005-07-05 14:08:10 -07001385 if (hlen - offset >= len)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001386 return skb->data + offset;
1387
1388 if (skb_copy_bits(skb, offset, buffer, len) < 0)
1389 return NULL;
1390
1391 return buffer;
1392}
1393
1394extern void skb_init(void);
1395extern void skb_add_mtu(int mtu);
1396
Patrick McHardya61bbcf2005-08-14 17:24:31 -07001397/**
1398 * skb_get_timestamp - get timestamp from a skb
1399 * @skb: skb to get stamp from
1400 * @stamp: pointer to struct timeval to store stamp in
1401 *
1402 * Timestamps are stored in the skb as offsets to a base timestamp.
1403 * This function converts the offset back to a struct timeval and stores
1404 * it in stamp.
1405 */
Stephen Hemmingerf2c38392005-09-06 15:48:03 -07001406static inline void skb_get_timestamp(const struct sk_buff *skb, struct timeval *stamp)
Patrick McHardya61bbcf2005-08-14 17:24:31 -07001407{
Eric Dumazetb7aa0bf2007-04-19 16:16:32 -07001408 *stamp = ktime_to_timeval(skb->tstamp);
Patrick McHardya61bbcf2005-08-14 17:24:31 -07001409}
1410
Eric Dumazetb7aa0bf2007-04-19 16:16:32 -07001411static inline void __net_timestamp(struct sk_buff *skb)
Patrick McHardya61bbcf2005-08-14 17:24:31 -07001412{
Eric Dumazetb7aa0bf2007-04-19 16:16:32 -07001413 skb->tstamp = ktime_get_real();
Patrick McHardya61bbcf2005-08-14 17:24:31 -07001414}
1415
Patrick McHardya61bbcf2005-08-14 17:24:31 -07001416
Herbert Xu759e5d02007-03-25 20:10:56 -07001417extern __sum16 __skb_checksum_complete_head(struct sk_buff *skb, int len);
Al Virob51655b2006-11-14 21:40:42 -08001418extern __sum16 __skb_checksum_complete(struct sk_buff *skb);
Herbert Xufb286bb2005-11-10 13:01:24 -08001419
1420/**
1421 * skb_checksum_complete - Calculate checksum of an entire packet
1422 * @skb: packet to process
1423 *
1424 * This function calculates the checksum over the entire packet plus
1425 * the value of skb->csum. The latter can be used to supply the
1426 * checksum of a pseudo header as used by TCP/UDP. It returns the
1427 * checksum.
1428 *
1429 * For protocols that contain complete checksums such as ICMP/TCP/UDP,
1430 * this function can be used to verify that checksum on received
1431 * packets. In that case the function should return zero if the
1432 * checksum is correct. In particular, this function will return zero
1433 * if skb->ip_summed is CHECKSUM_UNNECESSARY which indicates that the
1434 * hardware has already verified the correctness of the checksum.
1435 */
1436static inline unsigned int skb_checksum_complete(struct sk_buff *skb)
1437{
1438 return skb->ip_summed != CHECKSUM_UNNECESSARY &&
1439 __skb_checksum_complete(skb);
1440}
1441
Linus Torvalds1da177e2005-04-16 15:20:36 -07001442#ifdef CONFIG_NETFILTER
1443static inline void nf_conntrack_put(struct nf_conntrack *nfct)
1444{
1445 if (nfct && atomic_dec_and_test(&nfct->use))
1446 nfct->destroy(nfct);
1447}
1448static inline void nf_conntrack_get(struct nf_conntrack *nfct)
1449{
1450 if (nfct)
1451 atomic_inc(&nfct->use);
1452}
Yasuyuki Kozakai9fb9cbb2005-11-09 16:38:16 -08001453#if defined(CONFIG_NF_CONNTRACK) || defined(CONFIG_NF_CONNTRACK_MODULE)
1454static inline void nf_conntrack_get_reasm(struct sk_buff *skb)
1455{
1456 if (skb)
1457 atomic_inc(&skb->users);
1458}
1459static inline void nf_conntrack_put_reasm(struct sk_buff *skb)
1460{
1461 if (skb)
1462 kfree_skb(skb);
1463}
1464#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -07001465#ifdef CONFIG_BRIDGE_NETFILTER
1466static inline void nf_bridge_put(struct nf_bridge_info *nf_bridge)
1467{
1468 if (nf_bridge && atomic_dec_and_test(&nf_bridge->use))
1469 kfree(nf_bridge);
1470}
1471static inline void nf_bridge_get(struct nf_bridge_info *nf_bridge)
1472{
1473 if (nf_bridge)
1474 atomic_inc(&nf_bridge->use);
1475}
1476#endif /* CONFIG_BRIDGE_NETFILTER */
Patrick McHardya193a4a2006-03-20 19:23:05 -08001477static inline void nf_reset(struct sk_buff *skb)
1478{
1479 nf_conntrack_put(skb->nfct);
1480 skb->nfct = NULL;
1481#if defined(CONFIG_NF_CONNTRACK) || defined(CONFIG_NF_CONNTRACK_MODULE)
1482 nf_conntrack_put_reasm(skb->nfct_reasm);
1483 skb->nfct_reasm = NULL;
1484#endif
1485#ifdef CONFIG_BRIDGE_NETFILTER
1486 nf_bridge_put(skb->nf_bridge);
1487 skb->nf_bridge = NULL;
1488#endif
1489}
1490
Linus Torvalds1da177e2005-04-16 15:20:36 -07001491#else /* CONFIG_NETFILTER */
1492static inline void nf_reset(struct sk_buff *skb) {}
1493#endif /* CONFIG_NETFILTER */
1494
James Morris984bc162006-06-09 00:29:17 -07001495#ifdef CONFIG_NETWORK_SECMARK
1496static inline void skb_copy_secmark(struct sk_buff *to, const struct sk_buff *from)
1497{
1498 to->secmark = from->secmark;
1499}
1500
1501static inline void skb_init_secmark(struct sk_buff *skb)
1502{
1503 skb->secmark = 0;
1504}
1505#else
1506static inline void skb_copy_secmark(struct sk_buff *to, const struct sk_buff *from)
1507{ }
1508
1509static inline void skb_init_secmark(struct sk_buff *skb)
1510{ }
1511#endif
1512
Herbert Xu89114af2006-07-08 13:34:32 -07001513static inline int skb_is_gso(const struct sk_buff *skb)
1514{
1515 return skb_shinfo(skb)->gso_size;
1516}
1517
Linus Torvalds1da177e2005-04-16 15:20:36 -07001518#endif /* __KERNEL__ */
1519#endif /* _LINUX_SKBUFF_H */