]>
Commit | Line | Data |
---|---|---|
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> | |
25 | #include <linux/mm.h> | |
26 | #include <linux/highmem.h> | |
27 | #include <linux/poll.h> | |
28 | #include <linux/net.h> | |
3fc7e8a6 | 29 | #include <linux/textsearch.h> |
1da177e4 | 30 | #include <net/checksum.h> |
97fc2f08 | 31 | #include <linux/dmaengine.h> |
1da177e4 LT |
32 | |
33 | #define HAVE_ALLOC_SKB /* For the drivers to know */ | |
34 | #define HAVE_ALIGNABLE_SKB /* Ditto 8) */ | |
1da177e4 LT |
35 | |
36 | #define CHECKSUM_NONE 0 | |
37 | #define CHECKSUM_HW 1 | |
38 | #define CHECKSUM_UNNECESSARY 2 | |
39 | ||
40 | #define SKB_DATA_ALIGN(X) (((X) + (SMP_CACHE_BYTES - 1)) & \ | |
41 | ~(SMP_CACHE_BYTES - 1)) | |
42 | #define SKB_MAX_ORDER(X, ORDER) (((PAGE_SIZE << (ORDER)) - (X) - \ | |
43 | sizeof(struct skb_shared_info)) & \ | |
44 | ~(SMP_CACHE_BYTES - 1)) | |
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 | * | |
59 | * HW: the most generic way. Device supplied checksum of _all_ | |
60 | * the packet as seen by netif_rx in skb->csum. | |
61 | * NOTE: Even if device supports only some protocols, but | |
62 | * is able to produce some skb->csum, it MUST use HW, | |
63 | * not UNNECESSARY. | |
64 | * | |
65 | * B. Checksumming on output. | |
66 | * | |
67 | * NONE: skb is checksummed by protocol or csum is not required. | |
68 | * | |
69 | * HW: device is required to csum packet as seen by hard_start_xmit | |
70 | * from skb->h.raw to the end and to record the checksum | |
71 | * at skb->h.raw+skb->csum. | |
72 | * | |
73 | * Device must show its capabilities in dev->features, set | |
74 | * at device setup time. | |
75 | * NETIF_F_HW_CSUM - it is clever device, it is able to checksum | |
76 | * everything. | |
77 | * NETIF_F_NO_CSUM - loopback or reliable single hop media. | |
78 | * NETIF_F_IP_CSUM - device is dumb. It is able to csum only | |
79 | * TCP/UDP over IPv4. Sigh. Vendors like this | |
80 | * way by an unknown reason. Though, see comment above | |
81 | * about CHECKSUM_UNNECESSARY. 8) | |
82 | * | |
83 | * Any questions? No questions, good. --ANK | |
84 | */ | |
85 | ||
1da177e4 LT |
86 | struct net_device; |
87 | ||
88 | #ifdef CONFIG_NETFILTER | |
89 | struct nf_conntrack { | |
90 | atomic_t use; | |
91 | void (*destroy)(struct nf_conntrack *); | |
92 | }; | |
93 | ||
94 | #ifdef CONFIG_BRIDGE_NETFILTER | |
95 | struct nf_bridge_info { | |
96 | atomic_t use; | |
97 | struct net_device *physindev; | |
98 | struct net_device *physoutdev; | |
99 | #if defined(CONFIG_VLAN_8021Q) || defined(CONFIG_VLAN_8021Q_MODULE) | |
100 | struct net_device *netoutdev; | |
101 | #endif | |
102 | unsigned int mask; | |
103 | unsigned long data[32 / sizeof(unsigned long)]; | |
104 | }; | |
105 | #endif | |
106 | ||
107 | #endif | |
108 | ||
109 | struct sk_buff_head { | |
110 | /* These two members must be first. */ | |
111 | struct sk_buff *next; | |
112 | struct sk_buff *prev; | |
113 | ||
114 | __u32 qlen; | |
115 | spinlock_t lock; | |
116 | }; | |
117 | ||
118 | struct sk_buff; | |
119 | ||
120 | /* To allow 64K frame to be packed as single skb without frag_list */ | |
121 | #define MAX_SKB_FRAGS (65536/PAGE_SIZE + 2) | |
122 | ||
123 | typedef struct skb_frag_struct skb_frag_t; | |
124 | ||
125 | struct skb_frag_struct { | |
126 | struct page *page; | |
127 | __u16 page_offset; | |
128 | __u16 size; | |
129 | }; | |
130 | ||
131 | /* This data is invariant across clones and lives at | |
132 | * the end of the header data, ie. at skb->end. | |
133 | */ | |
134 | struct skb_shared_info { | |
135 | atomic_t dataref; | |
4947d3ef | 136 | unsigned short nr_frags; |
7967168c HX |
137 | unsigned short gso_size; |
138 | /* Warning: this field is not always filled in (UFO)! */ | |
139 | unsigned short gso_segs; | |
140 | unsigned short gso_type; | |
e89e9cf5 | 141 | unsigned int ip6_frag_id; |
1da177e4 LT |
142 | struct sk_buff *frag_list; |
143 | skb_frag_t frags[MAX_SKB_FRAGS]; | |
144 | }; | |
145 | ||
146 | /* We divide dataref into two halves. The higher 16 bits hold references | |
147 | * to the payload part of skb->data. The lower 16 bits hold references to | |
148 | * the entire skb->data. It is up to the users of the skb to agree on | |
149 | * where the payload starts. | |
150 | * | |
151 | * All users must obey the rule that the skb->data reference count must be | |
152 | * greater than or equal to the payload reference count. | |
153 | * | |
154 | * Holding a reference to the payload part means that the user does not | |
155 | * care about modifications to the header part of skb->data. | |
156 | */ | |
157 | #define SKB_DATAREF_SHIFT 16 | |
158 | #define SKB_DATAREF_MASK ((1 << SKB_DATAREF_SHIFT) - 1) | |
159 | ||
a61bbcf2 PM |
160 | struct skb_timeval { |
161 | u32 off_sec; | |
162 | u32 off_usec; | |
163 | }; | |
164 | ||
d179cd12 DM |
165 | |
166 | enum { | |
167 | SKB_FCLONE_UNAVAILABLE, | |
168 | SKB_FCLONE_ORIG, | |
169 | SKB_FCLONE_CLONE, | |
170 | }; | |
171 | ||
7967168c HX |
172 | enum { |
173 | SKB_GSO_TCPV4 = 1 << 0, | |
f83ef8c0 | 174 | SKB_GSO_UDP = 1 << 1, |
576a30eb HX |
175 | |
176 | /* This indicates the skb is from an untrusted source. */ | |
177 | SKB_GSO_DODGY = 1 << 2, | |
b0da8537 MC |
178 | |
179 | /* This indicates the tcp segment has CWR set. */ | |
f83ef8c0 HX |
180 | SKB_GSO_TCP_ECN = 1 << 3, |
181 | ||
182 | SKB_GSO_TCPV6 = 1 << 4, | |
7967168c HX |
183 | }; |
184 | ||
1da177e4 LT |
185 | /** |
186 | * struct sk_buff - socket buffer | |
187 | * @next: Next buffer in list | |
188 | * @prev: Previous buffer in list | |
1da177e4 | 189 | * @sk: Socket we are owned by |
325ed823 | 190 | * @tstamp: Time we arrived |
1da177e4 LT |
191 | * @dev: Device we arrived on/are leaving by |
192 | * @input_dev: Device we arrived on | |
1da177e4 LT |
193 | * @h: Transport layer header |
194 | * @nh: Network layer header | |
195 | * @mac: Link layer header | |
67be2dd1 MW |
196 | * @dst: destination entry |
197 | * @sp: the security path, used for xfrm | |
1da177e4 LT |
198 | * @cb: Control buffer. Free for use by every layer. Put private vars here |
199 | * @len: Length of actual data | |
200 | * @data_len: Data length | |
201 | * @mac_len: Length of link layer header | |
202 | * @csum: Checksum | |
67be2dd1 | 203 | * @local_df: allow local fragmentation |
1da177e4 LT |
204 | * @cloned: Head may be cloned (check refcnt to be sure) |
205 | * @nohdr: Payload reference only, must not modify header | |
206 | * @pkt_type: Packet class | |
c83c2486 | 207 | * @fclone: skbuff clone status |
1da177e4 LT |
208 | * @ip_summed: Driver fed us an IP checksum |
209 | * @priority: Packet queueing priority | |
210 | * @users: User count - see {datagram,tcp}.c | |
211 | * @protocol: Packet protocol from driver | |
1da177e4 LT |
212 | * @truesize: Buffer size |
213 | * @head: Head of buffer | |
214 | * @data: Data head pointer | |
215 | * @tail: Tail pointer | |
216 | * @end: End pointer | |
217 | * @destructor: Destruct function | |
218 | * @nfmark: Can be used for communication between hooks | |
1da177e4 | 219 | * @nfct: Associated connection, if any |
c83c2486 | 220 | * @ipvs_property: skbuff is owned by ipvs |
1da177e4 | 221 | * @nfctinfo: Relationship of this skb to the connection |
461ddf3b | 222 | * @nfct_reasm: netfilter conntrack re-assembly pointer |
1da177e4 | 223 | * @nf_bridge: Saved data about a bridged frame - see br_netfilter.c |
1da177e4 LT |
224 | * @tc_index: Traffic control index |
225 | * @tc_verd: traffic control verdict | |
f4b8ea78 RD |
226 | * @dma_cookie: a cookie to one of several possible DMA operations |
227 | * done by skb DMA functions | |
984bc16c | 228 | * @secmark: security marking |
1da177e4 LT |
229 | */ |
230 | ||
231 | struct sk_buff { | |
232 | /* These two members must be first. */ | |
233 | struct sk_buff *next; | |
234 | struct sk_buff *prev; | |
235 | ||
1da177e4 | 236 | struct sock *sk; |
a61bbcf2 | 237 | struct skb_timeval tstamp; |
1da177e4 LT |
238 | struct net_device *dev; |
239 | struct net_device *input_dev; | |
1da177e4 LT |
240 | |
241 | union { | |
242 | struct tcphdr *th; | |
243 | struct udphdr *uh; | |
244 | struct icmphdr *icmph; | |
245 | struct igmphdr *igmph; | |
246 | struct iphdr *ipiph; | |
247 | struct ipv6hdr *ipv6h; | |
248 | unsigned char *raw; | |
249 | } h; | |
250 | ||
251 | union { | |
252 | struct iphdr *iph; | |
253 | struct ipv6hdr *ipv6h; | |
254 | struct arphdr *arph; | |
255 | unsigned char *raw; | |
256 | } nh; | |
257 | ||
258 | union { | |
259 | unsigned char *raw; | |
260 | } mac; | |
261 | ||
262 | struct dst_entry *dst; | |
263 | struct sec_path *sp; | |
264 | ||
265 | /* | |
266 | * This is the control buffer. It is free to use for every | |
267 | * layer. Please put your private variables there. If you | |
268 | * want to keep them across layers you have to do a skb_clone() | |
269 | * first. This is owned by whoever has the skb queued ATM. | |
270 | */ | |
3e3850e9 | 271 | char cb[48]; |
1da177e4 LT |
272 | |
273 | unsigned int len, | |
274 | data_len, | |
275 | mac_len, | |
276 | csum; | |
1da177e4 | 277 | __u32 priority; |
1cbb3380 TG |
278 | __u8 local_df:1, |
279 | cloned:1, | |
280 | ip_summed:2, | |
6869c4d8 HW |
281 | nohdr:1, |
282 | nfctinfo:3; | |
d179cd12 | 283 | __u8 pkt_type:3, |
b84f4cc9 PM |
284 | fclone:2, |
285 | ipvs_property:1; | |
a0d3bea3 | 286 | __be16 protocol; |
1da177e4 LT |
287 | |
288 | void (*destructor)(struct sk_buff *skb); | |
289 | #ifdef CONFIG_NETFILTER | |
1da177e4 | 290 | struct nf_conntrack *nfct; |
9fb9cbb1 YK |
291 | #if defined(CONFIG_NF_CONNTRACK) || defined(CONFIG_NF_CONNTRACK_MODULE) |
292 | struct sk_buff *nfct_reasm; | |
293 | #endif | |
1da177e4 LT |
294 | #ifdef CONFIG_BRIDGE_NETFILTER |
295 | struct nf_bridge_info *nf_bridge; | |
296 | #endif | |
77d2ca35 | 297 | __u32 nfmark; |
1da177e4 | 298 | #endif /* CONFIG_NETFILTER */ |
1da177e4 | 299 | #ifdef CONFIG_NET_SCHED |
b6b99eb5 | 300 | __u16 tc_index; /* traffic control index */ |
1da177e4 | 301 | #ifdef CONFIG_NET_CLS_ACT |
b6b99eb5 | 302 | __u16 tc_verd; /* traffic control verdict */ |
1da177e4 | 303 | #endif |
1da177e4 | 304 | #endif |
97fc2f08 CL |
305 | #ifdef CONFIG_NET_DMA |
306 | dma_cookie_t dma_cookie; | |
307 | #endif | |
984bc16c JM |
308 | #ifdef CONFIG_NETWORK_SECMARK |
309 | __u32 secmark; | |
310 | #endif | |
1da177e4 LT |
311 | |
312 | ||
313 | /* These elements must be at the end, see alloc_skb() for details. */ | |
314 | unsigned int truesize; | |
315 | atomic_t users; | |
316 | unsigned char *head, | |
317 | *data, | |
318 | *tail, | |
319 | *end; | |
320 | }; | |
321 | ||
322 | #ifdef __KERNEL__ | |
323 | /* | |
324 | * Handling routines are only of interest to the kernel | |
325 | */ | |
326 | #include <linux/slab.h> | |
327 | ||
328 | #include <asm/system.h> | |
329 | ||