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