skb: Add inline helper for getting the skb end offset from head
[deliverable/linux.git] / net / core / skbuff.c
CommitLineData
1da177e4
LT
1/*
2 * Routines having to do with the 'struct sk_buff' memory handlers.
3 *
113aa838 4 * Authors: Alan Cox <alan@lxorguk.ukuu.org.uk>
1da177e4
LT
5 * Florian La Roche <rzsfl@rz.uni-sb.de>
6 *
1da177e4
LT
7 * Fixes:
8 * Alan Cox : Fixed the worst of the load
9 * balancer bugs.
10 * Dave Platt : Interrupt stacking fix.
11 * Richard Kooijman : Timestamp fixes.
12 * Alan Cox : Changed buffer format.
13 * Alan Cox : destructor hook for AF_UNIX etc.
14 * Linus Torvalds : Better skb_clone.
15 * Alan Cox : Added skb_copy.
16 * Alan Cox : Added all the changed routines Linus
17 * only put in the headers
18 * Ray VanTassle : Fixed --skb->lock in free
19 * Alan Cox : skb_copy copy arp field
20 * Andi Kleen : slabified it.
21 * Robert Olsson : Removed skb_head_pool
22 *
23 * NOTE:
24 * The __skb_ routines should be called with interrupts
25 * disabled, or you better be *real* sure that the operation is atomic
26 * with respect to whatever list is being frobbed (e.g. via lock_sock()
27 * or via disabling bottom half handlers, etc).
28 *
29 * This program is free software; you can redistribute it and/or
30 * modify it under the terms of the GNU General Public License
31 * as published by the Free Software Foundation; either version
32 * 2 of the License, or (at your option) any later version.
33 */
34
35/*
36 * The functions in this file will not compile correctly with gcc 2.4.x
37 */
38
1da177e4
LT
39#include <linux/module.h>
40#include <linux/types.h>
41#include <linux/kernel.h>
fe55f6d5 42#include <linux/kmemcheck.h>
1da177e4
LT
43#include <linux/mm.h>
44#include <linux/interrupt.h>
45#include <linux/in.h>
46#include <linux/inet.h>
47#include <linux/slab.h>
48#include <linux/netdevice.h>
49#ifdef CONFIG_NET_CLS_ACT
50#include <net/pkt_sched.h>
51#endif
52#include <linux/string.h>
53#include <linux/skbuff.h>
9c55e01c 54#include <linux/splice.h>
1da177e4
LT
55#include <linux/cache.h>
56#include <linux/rtnetlink.h>
57#include <linux/init.h>
716ea3a7 58#include <linux/scatterlist.h>
ac45f602 59#include <linux/errqueue.h>
268bb0ce 60#include <linux/prefetch.h>
1da177e4
LT
61
62#include <net/protocol.h>
63#include <net/dst.h>
64#include <net/sock.h>
65#include <net/checksum.h>
66#include <net/xfrm.h>
67
68#include <asm/uaccess.h>
ad8d75ff 69#include <trace/events/skb.h>
51c56b00 70#include <linux/highmem.h>
a1f8e7f7 71
d7e8883c 72struct kmem_cache *skbuff_head_cache __read_mostly;
e18b890b 73static struct kmem_cache *skbuff_fclone_cache __read_mostly;
1da177e4 74
9c55e01c
JA
75static void sock_pipe_buf_release(struct pipe_inode_info *pipe,
76 struct pipe_buffer *buf)
77{
8b9d3728 78 put_page(buf->page);
9c55e01c
JA
79}
80
81static void sock_pipe_buf_get(struct pipe_inode_info *pipe,
82 struct pipe_buffer *buf)
83{
8b9d3728 84 get_page(buf->page);
9c55e01c
JA
85}
86
87static int sock_pipe_buf_steal(struct pipe_inode_info *pipe,
88 struct pipe_buffer *buf)
89{
90 return 1;
91}
92
93
94/* Pipe buffer operations for a socket. */
28dfef8f 95static const struct pipe_buf_operations sock_pipe_buf_ops = {
9c55e01c
JA
96 .can_merge = 0,
97 .map = generic_pipe_buf_map,
98 .unmap = generic_pipe_buf_unmap,
99 .confirm = generic_pipe_buf_confirm,
100 .release = sock_pipe_buf_release,
101 .steal = sock_pipe_buf_steal,
102 .get = sock_pipe_buf_get,
103};
104
1da177e4
LT
105/*
106 * Keep out-of-line to prevent kernel bloat.
107 * __builtin_return_address is not used because it is not always
108 * reliable.
109 */
110
111/**
112 * skb_over_panic - private function
113 * @skb: buffer
114 * @sz: size
115 * @here: address
116 *
117 * Out of line support code for skb_put(). Not user callable.
118 */
ccb7c773 119static void skb_over_panic(struct sk_buff *skb, int sz, void *here)
1da177e4 120{
26095455 121 printk(KERN_EMERG "skb_over_panic: text:%p len:%d put:%d head:%p "
4305b541 122 "data:%p tail:%#lx end:%#lx dev:%s\n",
27a884dc 123 here, skb->len, sz, skb->head, skb->data,
4305b541 124 (unsigned long)skb->tail, (unsigned long)skb->end,
26095455 125 skb->dev ? skb->dev->name : "<NULL>");
1da177e4
LT
126 BUG();
127}
128
129/**
130 * skb_under_panic - private function
131 * @skb: buffer
132 * @sz: size
133 * @here: address
134 *
135 * Out of line support code for skb_push(). Not user callable.
136 */
137
ccb7c773 138static void skb_under_panic(struct sk_buff *skb, int sz, void *here)
1da177e4 139{
26095455 140 printk(KERN_EMERG "skb_under_panic: text:%p len:%d put:%d head:%p "
4305b541 141 "data:%p tail:%#lx end:%#lx dev:%s\n",
27a884dc 142 here, skb->len, sz, skb->head, skb->data,
4305b541 143 (unsigned long)skb->tail, (unsigned long)skb->end,
26095455 144 skb->dev ? skb->dev->name : "<NULL>");
1da177e4
LT
145 BUG();
146}
147
148/* Allocate a new skbuff. We do this ourselves so we can fill in a few
149 * 'private' fields and also do memory statistics to find all the
150 * [BEEP] leaks.
151 *
152 */
153
154/**
d179cd12 155 * __alloc_skb - allocate a network buffer
1da177e4
LT
156 * @size: size to allocate
157 * @gfp_mask: allocation mask
c83c2486
RD
158 * @fclone: allocate from fclone cache instead of head cache
159 * and allocate a cloned (child) skb
b30973f8 160 * @node: numa node to allocate memory on
1da177e4
LT
161 *
162 * Allocate a new &sk_buff. The returned buffer has no headroom and a
163 * tail room of size bytes. The object has a reference count of one.
164 * The return is the buffer. On a failure the return is %NULL.
165 *
166 * Buffers may only be allocated from interrupts using a @gfp_mask of
167 * %GFP_ATOMIC.
168 */
dd0fc66f 169struct sk_buff *__alloc_skb(unsigned int size, gfp_t gfp_mask,
b30973f8 170 int fclone, int node)
1da177e4 171{
e18b890b 172 struct kmem_cache *cache;
4947d3ef 173 struct skb_shared_info *shinfo;
1da177e4
LT
174 struct sk_buff *skb;
175 u8 *data;
176
8798b3fb
HX
177 cache = fclone ? skbuff_fclone_cache : skbuff_head_cache;
178
1da177e4 179 /* Get the HEAD */
b30973f8 180 skb = kmem_cache_alloc_node(cache, gfp_mask & ~__GFP_DMA, node);
1da177e4
LT
181 if (!skb)
182 goto out;
ec7d2f2c 183 prefetchw(skb);
1da177e4 184
87fb4b7b
ED
185 /* We do our best to align skb_shared_info on a separate cache
186 * line. It usually works because kmalloc(X > SMP_CACHE_BYTES) gives
187 * aligned memory blocks, unless SLUB/SLAB debug is enabled.
188 * Both skb->head and skb_shared_info are cache line aligned.
189 */
bc417e30 190 size = SKB_DATA_ALIGN(size);
87fb4b7b
ED
191 size += SKB_DATA_ALIGN(sizeof(struct skb_shared_info));
192 data = kmalloc_node_track_caller(size, gfp_mask, node);
1da177e4
LT
193 if (!data)
194 goto nodata;
87fb4b7b
ED
195 /* kmalloc(size) might give us more room than requested.
196 * Put skb_shared_info exactly at the end of allocated zone,
197 * to allow max possible filling before reallocation.
198 */
199 size = SKB_WITH_OVERHEAD(ksize(data));
ec7d2f2c 200 prefetchw(data + size);
1da177e4 201
ca0605a7 202 /*
c8005785
JB
203 * Only clear those fields we need to clear, not those that we will
204 * actually initialise below. Hence, don't put any more fields after
205 * the tail pointer in struct sk_buff!
ca0605a7
ACM
206 */
207 memset(skb, 0, offsetof(struct sk_buff, tail));
87fb4b7b
ED
208 /* Account for allocated memory : skb + skb->head */
209 skb->truesize = SKB_TRUESIZE(size);
1da177e4
LT
210 atomic_set(&skb->users, 1);
211 skb->head = data;
212 skb->data = data;
27a884dc 213 skb_reset_tail_pointer(skb);
4305b541 214 skb->end = skb->tail + size;
19633e12
SH
215#ifdef NET_SKBUFF_DATA_USES_OFFSET
216 skb->mac_header = ~0U;
217#endif
218
4947d3ef
BL
219 /* make sure we initialize shinfo sequentially */
220 shinfo = skb_shinfo(skb);
ec7d2f2c 221 memset(shinfo, 0, offsetof(struct skb_shared_info, dataref));
4947d3ef 222 atomic_set(&shinfo->dataref, 1);
c2aa3665 223 kmemcheck_annotate_variable(shinfo->destructor_arg);
4947d3ef 224
d179cd12
DM
225 if (fclone) {
226 struct sk_buff *child = skb + 1;
227 atomic_t *fclone_ref = (atomic_t *) (child + 1);
1da177e4 228
fe55f6d5
VN
229 kmemcheck_annotate_bitfield(child, flags1);
230 kmemcheck_annotate_bitfield(child, flags2);
d179cd12
DM
231 skb->fclone = SKB_FCLONE_ORIG;
232 atomic_set(fclone_ref, 1);
233
234 child->fclone = SKB_FCLONE_UNAVAILABLE;
235 }
1da177e4
LT
236out:
237 return skb;
238nodata:
8798b3fb 239 kmem_cache_free(cache, skb);
1da177e4
LT
240 skb = NULL;
241 goto out;
1da177e4 242}
b4ac530f 243EXPORT_SYMBOL(__alloc_skb);
1da177e4 244
b2b5ce9d
ED
245/**
246 * build_skb - build a network buffer
247 * @data: data buffer provided by caller
d3836f21 248 * @frag_size: size of fragment, or 0 if head was kmalloced
b2b5ce9d
ED
249 *
250 * Allocate a new &sk_buff. Caller provides space holding head and
251 * skb_shared_info. @data must have been allocated by kmalloc()
252 * The return is the new skb buffer.
253 * On a failure the return is %NULL, and @data is not freed.
254 * Notes :
255 * Before IO, driver allocates only data buffer where NIC put incoming frame
256 * Driver should add room at head (NET_SKB_PAD) and
257 * MUST add room at tail (SKB_DATA_ALIGN(skb_shared_info))
258 * After IO, driver calls build_skb(), to allocate sk_buff and populate it
259 * before giving packet to stack.
260 * RX rings only contains data buffers, not full skbs.
261 */
d3836f21 262struct sk_buff *build_skb(void *data, unsigned int frag_size)
b2b5ce9d
ED
263{
264 struct skb_shared_info *shinfo;
265 struct sk_buff *skb;
d3836f21 266 unsigned int size = frag_size ? : ksize(data);
b2b5ce9d
ED
267
268 skb = kmem_cache_alloc(skbuff_head_cache, GFP_ATOMIC);
269 if (!skb)
270 return NULL;
271
d3836f21 272 size -= SKB_DATA_ALIGN(sizeof(struct skb_shared_info));
b2b5ce9d
ED
273
274 memset(skb, 0, offsetof(struct sk_buff, tail));
275 skb->truesize = SKB_TRUESIZE(size);
d3836f21 276 skb->head_frag = frag_size != 0;
b2b5ce9d
ED
277 atomic_set(&skb->users, 1);
278 skb->head = data;
279 skb->data = data;
280 skb_reset_tail_pointer(skb);
281 skb->end = skb->tail + size;
282#ifdef NET_SKBUFF_DATA_USES_OFFSET
283 skb->mac_header = ~0U;
284#endif
285
286 /* make sure we initialize shinfo sequentially */
287 shinfo = skb_shinfo(skb);
288 memset(shinfo, 0, offsetof(struct skb_shared_info, dataref));
289 atomic_set(&shinfo->dataref, 1);
290 kmemcheck_annotate_variable(shinfo->destructor_arg);
291
292 return skb;
293}
294EXPORT_SYMBOL(build_skb);
295
8af27456
CH
296/**
297 * __netdev_alloc_skb - allocate an skbuff for rx on a specific device
298 * @dev: network device to receive on
299 * @length: length to allocate
300 * @gfp_mask: get_free_pages mask, passed to alloc_skb
301 *
302 * Allocate a new &sk_buff and assign it a usage count of one. The
303 * buffer has unspecified headroom built in. Users should allocate
304 * the headroom they think they need without accounting for the
305 * built in space. The built in space is used for optimisations.
306 *
307 * %NULL is returned if there is no free memory.
308 */
309struct sk_buff *__netdev_alloc_skb(struct net_device *dev,
310 unsigned int length, gfp_t gfp_mask)
311{
312 struct sk_buff *skb;
313
564824b0 314 skb = __alloc_skb(length + NET_SKB_PAD, gfp_mask, 0, NUMA_NO_NODE);
7b2e497a 315 if (likely(skb)) {
8af27456 316 skb_reserve(skb, NET_SKB_PAD);
7b2e497a
CH
317 skb->dev = dev;
318 }
8af27456
CH
319 return skb;
320}
b4ac530f 321EXPORT_SYMBOL(__netdev_alloc_skb);
1da177e4 322
654bed16 323void skb_add_rx_frag(struct sk_buff *skb, int i, struct page *page, int off,
50269e19 324 int size, unsigned int truesize)
654bed16
PZ
325{
326 skb_fill_page_desc(skb, i, page, off, size);
327 skb->len += size;
328 skb->data_len += size;
50269e19 329 skb->truesize += truesize;
654bed16
PZ
330}
331EXPORT_SYMBOL(skb_add_rx_frag);
332
f58518e6
IJ
333/**
334 * dev_alloc_skb - allocate an skbuff for receiving
335 * @length: length to allocate
336 *
337 * Allocate a new &sk_buff and assign it a usage count of one. The
338 * buffer has unspecified headroom built in. Users should allocate
339 * the headroom they think they need without accounting for the
340 * built in space. The built in space is used for optimisations.
341 *
342 * %NULL is returned if there is no free memory. Although this function
343 * allocates memory it can be called from an interrupt.
344 */
345struct sk_buff *dev_alloc_skb(unsigned int length)
346{
1483b874
DV
347 /*
348 * There is more code here than it seems:
a0f55e0e 349 * __dev_alloc_skb is an inline
1483b874 350 */
f58518e6
IJ
351 return __dev_alloc_skb(length, GFP_ATOMIC);
352}
353EXPORT_SYMBOL(dev_alloc_skb);
354
27b437c8 355static void skb_drop_list(struct sk_buff **listp)
1da177e4 356{
27b437c8 357 struct sk_buff *list = *listp;
1da177e4 358
27b437c8 359 *listp = NULL;
1da177e4
LT
360
361 do {
362 struct sk_buff *this = list;
363 list = list->next;
364 kfree_skb(this);
365 } while (list);
366}
367
27b437c8
HX
368static inline void skb_drop_fraglist(struct sk_buff *skb)
369{
370 skb_drop_list(&skb_shinfo(skb)->frag_list);
371}
372
1da177e4
LT
373static void skb_clone_fraglist(struct sk_buff *skb)
374{
375 struct sk_buff *list;
376
fbb398a8 377 skb_walk_frags(skb, list)
1da177e4
LT
378 skb_get(list);
379}
380
d3836f21
ED
381static void skb_free_head(struct sk_buff *skb)
382{
383 if (skb->head_frag)
384 put_page(virt_to_head_page(skb->head));
385 else
386 kfree(skb->head);
387}
388
5bba1712 389static void skb_release_data(struct sk_buff *skb)
1da177e4
LT
390{
391 if (!skb->cloned ||
392 !atomic_sub_return(skb->nohdr ? (1 << SKB_DATAREF_SHIFT) + 1 : 1,
393 &skb_shinfo(skb)->dataref)) {
394 if (skb_shinfo(skb)->nr_frags) {
395 int i;
396 for (i = 0; i < skb_shinfo(skb)->nr_frags; i++)
ea2ab693 397 skb_frag_unref(skb, i);
1da177e4
LT
398 }
399
a6686f2f
SM
400 /*
401 * If skb buf is from userspace, we need to notify the caller
402 * the lower device DMA has done;
403 */
404 if (skb_shinfo(skb)->tx_flags & SKBTX_DEV_ZEROCOPY) {
405 struct ubuf_info *uarg;
406
407 uarg = skb_shinfo(skb)->destructor_arg;
408 if (uarg->callback)
409 uarg->callback(uarg);
410 }
411
21dc3301 412 if (skb_has_frag_list(skb))
1da177e4
LT
413 skb_drop_fraglist(skb);
414
d3836f21 415 skb_free_head(skb);
1da177e4
LT
416 }
417}
418
419/*
420 * Free an skbuff by memory without cleaning the state.
421 */
2d4baff8 422static void kfree_skbmem(struct sk_buff *skb)
1da177e4 423{
d179cd12
DM
424 struct sk_buff *other;
425 atomic_t *fclone_ref;
426
d179cd12
DM
427 switch (skb->fclone) {
428 case SKB_FCLONE_UNAVAILABLE:
429 kmem_cache_free(skbuff_head_cache, skb);
430 break;
431
432 case SKB_FCLONE_ORIG:
433 fclone_ref = (atomic_t *) (skb + 2);
434 if (atomic_dec_and_test(fclone_ref))
435 kmem_cache_free(skbuff_fclone_cache, skb);
436 break;
437
438 case SKB_FCLONE_CLONE:
439 fclone_ref = (atomic_t *) (skb + 1);
440 other = skb - 1;
441
442 /* The clone portion is available for
443 * fast-cloning again.
444 */
445 skb->fclone = SKB_FCLONE_UNAVAILABLE;
446
447 if (atomic_dec_and_test(fclone_ref))
448 kmem_cache_free(skbuff_fclone_cache, other);
449 break;
3ff50b79 450 }
1da177e4
LT
451}
452
04a4bb55 453static void skb_release_head_state(struct sk_buff *skb)
1da177e4 454{
adf30907 455 skb_dst_drop(skb);
1da177e4
LT
456#ifdef CONFIG_XFRM
457 secpath_put(skb->sp);
458#endif
9c2b3328
SH
459 if (skb->destructor) {
460 WARN_ON(in_irq());
1da177e4
LT
461 skb->destructor(skb);
462 }
a3bf7ae9 463#if IS_ENABLED(CONFIG_NF_CONNTRACK)
5f79e0f9 464 nf_conntrack_put(skb->nfct);
2fc72c7b
KK
465#endif
466#ifdef NET_SKBUFF_NF_DEFRAG_NEEDED
9fb9cbb1
YK
467 nf_conntrack_put_reasm(skb->nfct_reasm);
468#endif
1da177e4
LT
469#ifdef CONFIG_BRIDGE_NETFILTER
470 nf_bridge_put(skb->nf_bridge);
471#endif
1da177e4
LT
472/* XXX: IS this still necessary? - JHS */
473#ifdef CONFIG_NET_SCHED
474 skb->tc_index = 0;
475#ifdef CONFIG_NET_CLS_ACT
476 skb->tc_verd = 0;
1da177e4
LT
477#endif
478#endif
04a4bb55
LB
479}
480
481/* Free everything but the sk_buff shell. */
482static void skb_release_all(struct sk_buff *skb)
483{
484 skb_release_head_state(skb);
2d4baff8
HX
485 skb_release_data(skb);
486}
487
488/**
489 * __kfree_skb - private function
490 * @skb: buffer
491 *
492 * Free an sk_buff. Release anything attached to the buffer.
493 * Clean the state. This is an internal helper function. Users should
494 * always call kfree_skb
495 */
1da177e4 496
2d4baff8
HX
497void __kfree_skb(struct sk_buff *skb)
498{
499 skb_release_all(skb);
1da177e4
LT
500 kfree_skbmem(skb);
501}
b4ac530f 502EXPORT_SYMBOL(__kfree_skb);
1da177e4 503