net: use kmemcheck bitfields API for skbuff
[GitHub/mt8127/android_kernel_alcatel_ttab.git] / include / linux / skbuff.h
CommitLineData
1da177e4
LT
1/*
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
1da177e4 17#include <linux/kernel.h>
fe55f6d5 18#include <linux/kmemcheck.h>
1da177e4
LT
19#include <linux/compiler.h>
20#include <linux/time.h>
21#include <linux/cache.h>
22
23#include <asm/atomic.h>
24#include <asm/types.h>
25#include <linux/spinlock.h>
1da177e4 26#include <linux/net.h>
3fc7e8a6 27#include <linux/textsearch.h>
1da177e4 28#include <net/checksum.h>
a80958f4 29#include <linux/rcupdate.h>
97fc2f08 30#include <linux/dmaengine.h>
b7aa0bf7 31#include <linux/hrtimer.h>
1da177e4 32
60476372 33/* Don't change this without changing skb_csum_unnecessary! */
1da177e4 34#define CHECKSUM_NONE 0
60476372
HX
35#define CHECKSUM_UNNECESSARY 1
36#define CHECKSUM_COMPLETE 2
37#define CHECKSUM_PARTIAL 3
1da177e4
LT
38
39#define SKB_DATA_ALIGN(X) (((X) + (SMP_CACHE_BYTES - 1)) & \
40 ~(SMP_CACHE_BYTES - 1))
fc910a27 41#define SKB_WITH_OVERHEAD(X) \
deea84b0 42 ((X) - SKB_DATA_ALIGN(sizeof(struct skb_shared_info)))
fc910a27
DM
43#define SKB_MAX_ORDER(X, ORDER) \
44 SKB_WITH_OVERHEAD((PAGE_SIZE << (ORDER)) - (X))
1da177e4
LT
45#define SKB_MAX_HEAD(X) (SKB_MAX_ORDER((X), 0))
46#define SKB_MAX_ALLOC (SKB_MAX_ORDER(0, 2))
47
48/* A. Checksumming of received packets by device.
49 *
50 * NONE: device failed to checksum this packet.
51 * skb->csum is undefined.
52 *
53 * UNNECESSARY: device parsed packet and wouldbe verified checksum.
54 * skb->csum is undefined.
55 * It is bad option, but, unfortunately, many of vendors do this.
56 * Apparently with secret goal to sell you new device, when you
57 * will add new protocol to your host. F.e. IPv6. 8)
58 *
84fa7933 59 * COMPLETE: the most generic way. Device supplied checksum of _all_
1da177e4
LT
60 * the packet as seen by netif_rx in skb->csum.
61 * NOTE: Even if device supports only some protocols, but
84fa7933 62 * is able to produce some skb->csum, it MUST use COMPLETE,
1da177e4
LT
63 * not UNNECESSARY.
64 *
c6c6e3e0
HX
65 * PARTIAL: identical to the case for output below. This may occur
66 * on a packet received directly from another Linux OS, e.g.,
67 * a virtualised Linux kernel on the same host. The packet can
68 * be treated in the same way as UNNECESSARY except that on
69 * output (i.e., forwarding) the checksum must be filled in
70 * by the OS or the hardware.
71 *
1da177e4
LT
72 * B. Checksumming on output.
73 *
74 * NONE: skb is checksummed by protocol or csum is not required.
75 *
84fa7933 76 * PARTIAL: device is required to csum packet as seen by hard_start_xmit
c6c6e3e0
HX
77 * from skb->csum_start to the end and to record the checksum
78 * at skb->csum_start + skb->csum_offset.
1da177e4
LT
79 *
80 * Device must show its capabilities in dev->features, set
81 * at device setup time.
82 * NETIF_F_HW_CSUM - it is clever device, it is able to checksum
83 * everything.
84 * NETIF_F_NO_CSUM - loopback or reliable single hop media.
85 * NETIF_F_IP_CSUM - device is dumb. It is able to csum only
86 * TCP/UDP over IPv4. Sigh. Vendors like this
87 * way by an unknown reason. Though, see comment above
88 * about CHECKSUM_UNNECESSARY. 8)
c6c6e3e0 89 * NETIF_F_IPV6_CSUM about as dumb as the last one but does IPv6 instead.
1da177e4
LT
90 *
91 * Any questions? No questions, good. --ANK
92 */
93
1da177e4 94struct net_device;
716ea3a7 95struct scatterlist;
9c55e01c 96struct pipe_inode_info;
1da177e4 97
5f79e0f9 98#if defined(CONFIG_NF_CONNTRACK) || defined(CONFIG_NF_CONNTRACK_MODULE)
1da177e4
LT
99struct nf_conntrack {
100 atomic_t use;
1da177e4 101};
5f79e0f9 102#endif
1da177e4
LT
103
104#ifdef CONFIG_BRIDGE_NETFILTER
105struct nf_bridge_info {
106 atomic_t use;
107 struct net_device *physindev;
108 struct net_device *physoutdev;
1da177e4
LT
109 unsigned int mask;
110 unsigned long data[32 / sizeof(unsigned long)];
111};
112#endif
113
1da177e4
LT
114struct sk_buff_head {
115 /* These two members must be first. */
116 struct sk_buff *next;
117 struct sk_buff *prev;
118
119 __u32 qlen;
120 spinlock_t lock;
121};
122
123struct sk_buff;
124
125/* To allow 64K frame to be packed as single skb without frag_list */
126#define MAX_SKB_FRAGS (65536/PAGE_SIZE + 2)
127
128typedef struct skb_frag_struct skb_frag_t;
129
130struct skb_frag_struct {
131 struct page *page;
a309bb07
DM
132 __u32 page_offset;
133 __u32 size;
1da177e4
LT
134};
135
ac45f602
PO
136#define HAVE_HW_TIME_STAMP
137
138/**
d3a21be8 139 * struct skb_shared_hwtstamps - hardware time stamps
ac45f602
PO
140 * @hwtstamp: hardware time stamp transformed into duration
141 * since arbitrary point in time
142 * @syststamp: hwtstamp transformed to system time base
143 *
144 * Software time stamps generated by ktime_get_real() are stored in
145 * skb->tstamp. The relation between the different kinds of time
146 * stamps is as follows:
147 *
148 * syststamp and tstamp can be compared against each other in
149 * arbitrary combinations. The accuracy of a
150 * syststamp/tstamp/"syststamp from other device" comparison is
151 * limited by the accuracy of the transformation into system time
152 * base. This depends on the device driver and its underlying
153 * hardware.
154 *
155 * hwtstamps can only be compared against other hwtstamps from
156 * the same device.
157 *
158 * This structure is attached to packets as part of the
159 * &skb_shared_info. Use skb_hwtstamps() to get a pointer.
160 */
161struct skb_shared_hwtstamps {
162 ktime_t hwtstamp;
163 ktime_t syststamp;
164};
165
166/**
d3a21be8 167 * struct skb_shared_tx - instructions for time stamping of outgoing packets
ac45f602
PO
168 * @hardware: generate hardware time stamp
169 * @software: generate software time stamp
170 * @in_progress: device driver is going to provide
171 * hardware time stamp
4b21cd4e 172 * @flags: all shared_tx flags
ac45f602
PO
173 *
174 * These flags are attached to packets as part of the
175 * &skb_shared_info. Use skb_tx() to get a pointer.
176 */
177union skb_shared_tx {
178 struct {
179 __u8 hardware:1,
180 software:1,
181 in_progress:1;
182 };
183 __u8 flags;
184};
185
1da177e4
LT
186/* This data is invariant across clones and lives at
187 * the end of the header data, ie. at skb->end.
188 */
189struct skb_shared_info {
190 atomic_t dataref;
4947d3ef 191 unsigned short nr_frags;
7967168c
HX
192 unsigned short gso_size;
193 /* Warning: this field is not always filled in (UFO)! */
194 unsigned short gso_segs;
195 unsigned short gso_type;
ae08e1f0 196 __be32 ip6_frag_id;
ac45f602 197 union skb_shared_tx tx_flags;
271bff7a
DM
198#ifdef CONFIG_HAS_DMA
199 unsigned int num_dma_maps;
200#endif
1da177e4 201 struct sk_buff *frag_list;
ac45f602 202 struct skb_shared_hwtstamps hwtstamps;
1da177e4 203 skb_frag_t frags[MAX_SKB_FRAGS];
271bff7a
DM
204#ifdef CONFIG_HAS_DMA
205 dma_addr_t dma_maps[MAX_SKB_FRAGS + 1];
206#endif
1da177e4
LT
207};
208
209/* We divide dataref into two halves. The higher 16 bits hold references
210 * to the payload part of skb->data. The lower 16 bits hold references to
334a8132
PM
211 * the entire skb->data. A clone of a headerless skb holds the length of
212 * the header in skb->hdr_len.
1da177e4
LT
213 *
214 * All users must obey the rule that the skb->data reference count must be
215 * greater than or equal to the payload reference count.
216 *
217 * Holding a reference to the payload part means that the user does not
218 * care about modifications to the header part of skb->data.
219 */
220#define SKB_DATAREF_SHIFT 16
221#define SKB_DATAREF_MASK ((1 << SKB_DATAREF_SHIFT) - 1)
222
d179cd12
DM
223
224enum {
225 SKB_FCLONE_UNAVAILABLE,
226 SKB_FCLONE_ORIG,
227 SKB_FCLONE_CLONE,
228};
229
7967168c
HX
230enum {
231 SKB_GSO_TCPV4 = 1 << 0,
f83ef8c0 232 SKB_GSO_UDP = 1 << 1,
576a30eb
HX
233
234 /* This indicates the skb is from an untrusted source. */
235 SKB_GSO_DODGY = 1 << 2,
b0da8537
MC
236
237 /* This indicates the tcp segment has CWR set. */
f83ef8c0
HX
238 SKB_GSO_TCP_ECN = 1 << 3,
239
240 SKB_GSO_TCPV6 = 1 << 4,
01d5b2fc
CL
241
242 SKB_GSO_FCOE = 1 << 5,
7967168c
HX
243};
244
2e07fa9c
ACM
245#if BITS_PER_LONG > 32
246#define NET_SKBUFF_DATA_USES_OFFSET 1
247#endif
248
249#ifdef NET_SKBUFF_DATA_USES_OFFSET
250typedef unsigned int sk_buff_data_t;
251#else
252typedef unsigned char *sk_buff_data_t;
253#endif
254
1da177e4
LT
255/**
256 * struct sk_buff - socket buffer
257 * @next: Next buffer in list
258 * @prev: Previous buffer in list
1da177e4 259 * @sk: Socket we are owned by
325ed823 260 * @tstamp: Time we arrived
1da177e4 261 * @dev: Device we arrived on/are leaving by
be52178b 262 * @transport_header: Transport layer header
b0e380b1
ACM
263 * @network_header: Network layer header
264 * @mac_header: Link layer header
67be2dd1
MW
265 * @dst: destination entry
266 * @sp: the security path, used for xfrm
1da177e4
LT
267 * @cb: Control buffer. Free for use by every layer. Put private vars here
268 * @len: Length of actual data
269 * @data_len: Data length
270 * @mac_len: Length of link layer header
334a8132 271 * @hdr_len: writable header length of cloned skb
663ead3b
HX
272 * @csum: Checksum (must include start/offset pair)
273 * @csum_start: Offset from skb->head where checksumming should start
274 * @csum_offset: Offset from csum_start where checksum should be stored
67be2dd1 275 * @local_df: allow local fragmentation
1da177e4
LT
276 * @cloned: Head may be cloned (check refcnt to be sure)
277 * @nohdr: Payload reference only, must not modify header
278 * @pkt_type: Packet class
c83c2486 279 * @fclone: skbuff clone status
1da177e4
LT
280 * @ip_summed: Driver fed us an IP checksum
281 * @priority: Packet queueing priority
282 * @users: User count - see {datagram,tcp}.c
283 * @protocol: Packet protocol from driver
1da177e4
LT
284 * @truesize: Buffer size
285 * @head: Head of buffer
286 * @data: Data head pointer
287 * @tail: Tail pointer
288 * @end: End pointer
289 * @destructor: Destruct function
82e91ffe 290 * @mark: Generic packet mark
1da177e4 291 * @nfct: Associated connection, if any
c83c2486 292 * @ipvs_property: skbuff is owned by ipvs
31729363
RD
293 * @peeked: this packet has been seen already, so stats have been
294 * done for it, don't do them again
ba9dda3a 295 * @nf_trace: netfilter packet trace flag
1da177e4 296 * @nfctinfo: Relationship of this skb to the connection
461ddf3b 297 * @nfct_reasm: netfilter conntrack re-assembly pointer
1da177e4 298 * @nf_bridge: Saved data about a bridged frame - see br_netfilter.c
f25f4e44
PWJ
299 * @iif: ifindex of device we arrived on
300 * @queue_mapping: Queue mapping for multiqueue devices
1da177e4
LT
301 * @tc_index: Traffic control index
302 * @tc_verd: traffic control verdict
553a5672 303 * @ndisc_nodetype: router type (from link layer)
4a7b61d2 304 * @do_not_encrypt: set to prevent encryption of this frame
8b30b1fe
S
305 * @requeue: set to indicate that the wireless core should attempt
306 * a software retry on this frame if we failed to
307 * receive an ACK for it
f4b8ea78
RD
308 * @dma_cookie: a cookie to one of several possible DMA operations
309 * done by skb DMA functions
984bc16c 310 * @secmark: security marking
6aa895b0 311 * @vlan_tci: vlan tag control information
1da177e4
LT
312 */
313
314struct sk_buff {
315 /* These two members must be first. */
316 struct sk_buff *next;
317 struct sk_buff *prev;
318
1da177e4 319 struct sock *sk;
b7aa0bf7 320 ktime_t tstamp;
1da177e4 321 struct net_device *dev;
1da177e4 322
ee6b9673
ED
323 union {
324 struct dst_entry *dst;
325 struct rtable *rtable;
326 };
def8b4fa 327#ifdef CONFIG_XFRM
1da177e4 328 struct sec_path *sp;
def8b4fa 329#endif
1da177e4
LT
330 /*
331 * This is the control buffer. It is free to use for every
332 * layer. Please put your private variables there. If you
333 * want to keep them across layers you have to do a skb_clone()
334 * first. This is owned by whoever has the skb queued ATM.
335 */
3e3850e9 336 char cb[48];
1da177e4
LT
337
338 unsigned int len,
334a8132
PM
339 data_len;
340 __u16 mac_len,
341 hdr_len;
ff1dcadb
AV
342 union {
343 __wsum csum;
663ead3b
HX
344 struct {
345 __u16 csum_start;
346 __u16 csum_offset;
347 };
ff1dcadb 348 };
1da177e4 349 __u32 priority;
fe55f6d5 350 kmemcheck_bitfield_begin(flags1);
1cbb3380
TG
351 __u8 local_df:1,
352 cloned:1,
353 ip_summed:2,
6869c4d8
HW
354 nohdr:1,
355 nfctinfo:3;
d179cd12 356 __u8 pkt_type:3,
b84f4cc9 357 fclone:2,
ba9dda3a 358 ipvs_property:1,
a59322be 359 peeked:1,
ba9dda3a 360 nf_trace:1;
fe55f6d5 361 kmemcheck_bitfield_end(flags1);
a0d3bea3 362 __be16 protocol;
1da177e4
LT
363
364 void (*destructor)(struct sk_buff *skb);
9fb9cbb1 365#if defined(CONFIG_NF_CONNTRACK) || defined(CONFIG_NF_CONNTRACK_MODULE)
5f79e0f9 366 struct nf_conntrack *nfct;
9fb9cbb1
YK
367 struct sk_buff *nfct_reasm;
368#endif
1da177e4
LT
369#ifdef CONFIG_BRIDGE_NETFILTER
370 struct nf_bridge_info *nf_bridge;
371#endif
f25f4e44
PWJ
372
373 int iif;
374 __u16 queue_mapping;
1da177e4 375#ifdef CONFIG_NET_SCHED
b6b99eb5 376 __u16 tc_index; /* traffic control index */
1da177e4 377#ifdef CONFIG_NET_CLS_ACT
b6b99eb5 378 __u16 tc_verd; /* traffic control verdict */
1da177e4 379#endif
1da177e4 380#endif
fe55f6d5
VN
381
382 kmemcheck_bitfield_begin(flags2);
de357cc0 383#ifdef CONFIG_IPV6_NDISC_NODETYPE
fadf6bf0 384 __u8 ndisc_nodetype:2;
de357cc0 385#endif
d0f09804
JB
386#if defined(CONFIG_MAC80211) || defined(CONFIG_MAC80211_MODULE)
387 __u8 do_not_encrypt:1;
8b30b1fe 388 __u8 requeue:1;
d0f09804 389#endif
fe55f6d5
VN
390 kmemcheck_bitfield_end(flags2);
391
d0f09804 392 /* 0/13/14 bit hole */
f25f4e44 393
97fc2f08
CL
394#ifdef CONFIG_NET_DMA
395 dma_cookie_t dma_cookie;
396#endif
984bc16c
JM
397#ifdef CONFIG_NETWORK_SECMARK
398 __u32 secmark;
399#endif
1da177e4 400
82e91ffe 401 __u32 mark;
1da177e4 402
6aa895b0
PM
403 __u16 vlan_tci;
404
27a884dc
ACM
405 sk_buff_data_t transport_header;
406 sk_buff_data_t network_header;
407 sk_buff_data_t mac_header;
1da177e4 408 /* These elements must be at the end, see alloc_skb() for details. */
27a884dc 409 sk_buff_data_t tail;
4305b541 410 sk_buff_data_t end;
1da177e4 411 unsigned char *head,
4305b541 412 *data;
27a884dc
ACM
413 unsigned int truesize;
414 atomic_t users;
1da177e4
LT
415};
416
417#ifdef __KERNEL__
418/*
419 * Handling routines are only of interest to the kernel
420 */
421#include <linux/slab.h>
422
423#include <asm/system.h>
424
a40c24a1
DM
425#ifdef CONFIG_HAS_DMA
426#include <linux/dma-mapping.h>
427extern int skb_dma_map(struct device *dev, struct sk_buff *skb,
428 enum dma_data_direction dir);
429extern void skb_dma_unmap(struct device *dev, struct sk_buff *skb,
430 enum dma_data_direction dir);
431#endif
432