Commit | Line | Data |
---|---|---|
1da177e4 LT |
1 | /* |
2 | * INET An implementation of the TCP/IP protocol suite for the LINUX | |
3 | * operating system. INET is implemented using the BSD Socket | |
4 | * interface as the means of communication with the user level. | |
5 | * | |
6 | * Definitions for the AF_INET socket handler. | |
7 | * | |
8 | * Version: @(#)sock.h 1.0.4 05/13/93 | |
9 | * | |
02c30a84 | 10 | * Authors: Ross Biro |
1da177e4 LT |
11 | * Fred N. van Kempen, <waltje@uWalt.NL.Mugnet.ORG> |
12 | * Corey Minyard <wf-rch!minyard@relay.EU.net> | |
13 | * Florian La Roche <flla@stud.uni-sb.de> | |
14 | * | |
15 | * Fixes: | |
16 | * Alan Cox : Volatiles in skbuff pointers. See | |
17 | * skbuff comments. May be overdone, | |
18 | * better to prove they can be removed | |
19 | * than the reverse. | |
20 | * Alan Cox : Added a zapped field for tcp to note | |
21 | * a socket is reset and must stay shut up | |
22 | * Alan Cox : New fields for options | |
23 | * Pauline Middelink : identd support | |
24 | * Alan Cox : Eliminate low level recv/recvfrom | |
25 | * David S. Miller : New socket lookup architecture. | |
26 | * Steve Whitehouse: Default routines for sock_ops | |
27 | * Arnaldo C. Melo : removed net_pinfo, tp_pinfo and made | |
28 | * protinfo be just a void pointer, as the | |
29 | * protocol specific parts were moved to | |
30 | * respective headers and ipv4/v6, etc now | |
31 | * use private slabcaches for its socks | |
32 | * Pedro Hortas : New flags field for socket options | |
33 | * | |
34 | * | |
35 | * This program is free software; you can redistribute it and/or | |
36 | * modify it under the terms of the GNU General Public License | |
37 | * as published by the Free Software Foundation; either version | |
38 | * 2 of the License, or (at your option) any later version. | |
39 | */ | |
40 | #ifndef _SOCK_H | |
41 | #define _SOCK_H | |
42 | ||
172589cc | 43 | #include <linux/kernel.h> |
1da177e4 | 44 | #include <linux/list.h> |
88ab1932 | 45 | #include <linux/list_nulls.h> |
1da177e4 LT |
46 | #include <linux/timer.h> |
47 | #include <linux/cache.h> | |
48 | #include <linux/module.h> | |
a5b5bb9a | 49 | #include <linux/lockdep.h> |
1da177e4 LT |
50 | #include <linux/netdevice.h> |
51 | #include <linux/skbuff.h> /* struct sk_buff */ | |
d7fe0f24 | 52 | #include <linux/mm.h> |
1da177e4 LT |
53 | #include <linux/security.h> |
54 | ||
55 | #include <linux/filter.h> | |
88ab1932 | 56 | #include <linux/rculist_nulls.h> |
1da177e4 LT |
57 | |
58 | #include <asm/atomic.h> | |
59 | #include <net/dst.h> | |
60 | #include <net/checksum.h> | |
61 | ||
62 | /* | |
63 | * This structure really needs to be cleaned up. | |
64 | * Most of it is for TCP, and not used by any of | |
65 | * the other protocols. | |
66 | */ | |
67 | ||
68 | /* Define this to get the SOCK_DBG debugging facility. */ | |
69 | #define SOCK_DEBUGGING | |
70 | #ifdef SOCK_DEBUGGING | |
71 | #define SOCK_DEBUG(sk, msg...) do { if ((sk) && sock_flag((sk), SOCK_DBG)) \ | |
72 | printk(KERN_DEBUG msg); } while (0) | |
73 | #else | |
4cd9029d SH |
74 | /* Validate arguments and do nothing */ |
75 | static void inline int __attribute__ ((format (printf, 2, 3))) | |
76 | SOCK_DEBUG(struct sock *sk, const char *msg, ...) | |
77 | { | |
78 | } | |
1da177e4 LT |
79 | #endif |
80 | ||
81 | /* This is the per-socket lock. The spinlock provides a synchronization | |
82 | * between user contexts and software interrupt processing, whereas the | |
83 | * mini-semaphore synchronizes multiple users amongst themselves. | |
84 | */ | |
1da177e4 LT |
85 | typedef struct { |
86 | spinlock_t slock; | |
d2e9117c | 87 | int owned; |
1da177e4 | 88 | wait_queue_head_t wq; |
a5b5bb9a IM |
89 | /* |
90 | * We express the mutex-alike socket_lock semantics | |
91 | * to the lock validator by explicitly managing | |
92 | * the slock as a lock variant (in addition to | |
93 | * the slock itself): | |
94 | */ | |
95 | #ifdef CONFIG_DEBUG_LOCK_ALLOC | |
96 | struct lockdep_map dep_map; | |
97 | #endif | |
1da177e4 LT |
98 | } socket_lock_t; |
99 | ||
1da177e4 | 100 | struct sock; |
8feaf0c0 | 101 | struct proto; |
0eeb8ffc | 102 | struct net; |
1da177e4 LT |
103 | |
104 | /** | |
4dc3b16b PP |
105 | * struct sock_common - minimal network layer representation of sockets |
106 | * @skc_family: network address family | |
107 | * @skc_state: Connection state | |
108 | * @skc_reuse: %SO_REUSEADDR setting | |
109 | * @skc_bound_dev_if: bound device index if != 0 | |
110 | * @skc_node: main hash linkage for various protocol lookup tables | |
88ab1932 | 111 | * @skc_nulls_node: main hash linkage for UDP/UDP-Lite protocol |
4dc3b16b PP |
112 | * @skc_bind_node: bind hash linkage for various protocol lookup tables |
113 | * @skc_refcnt: reference count | |
81c3d547 | 114 | * @skc_hash: hash value used with various protocol lookup tables |
8feaf0c0 | 115 | * @skc_prot: protocol handlers inside a network family |
07feaebf | 116 | * @skc_net: reference to the network namespace of this socket |
4dc3b16b PP |
117 | * |
118 | * This is the minimal network layer representation of sockets, the header | |
8feaf0c0 ACM |
119 | * for struct sock and struct inet_timewait_sock. |
120 | */ | |
1da177e4 LT |
121 | struct sock_common { |
122 | unsigned short skc_family; | |
123 | volatile unsigned char skc_state; | |
124 | unsigned char skc_reuse; | |
125 | int skc_bound_dev_if; | |
88ab1932 ED |
126 | union { |
127 | struct hlist_node skc_node; | |
128 | struct hlist_nulls_node skc_nulls_node; | |
129 | }; | |
1da177e4 LT |
130 | struct hlist_node skc_bind_node; |
131 | atomic_t skc_refcnt; | |
81c3d547 | 132 | unsigned int skc_hash; |
8feaf0c0 | 133 | struct proto *skc_prot; |
3b1e0a65 | 134 | #ifdef CONFIG_NET_NS |
07feaebf | 135 | struct net *skc_net; |
3b1e0a65 | 136 | #endif |
1da177e4 LT |
137 | }; |
138 | ||
139 | /** | |
140 | * struct sock - network layer representation of sockets | |
8feaf0c0 | 141 | * @__sk_common: shared layout with inet_timewait_sock |
4dc3b16b PP |
142 | * @sk_shutdown: mask of %SEND_SHUTDOWN and/or %RCV_SHUTDOWN |
143 | * @sk_userlocks: %SO_SNDBUF and %SO_RCVBUF settings | |
144 | * @sk_lock: synchronizer | |
145 | * @sk_rcvbuf: size of receive buffer in bytes | |
146 | * @sk_sleep: sock wait queue | |
147 | * @sk_dst_cache: destination cache | |
148 | * @sk_dst_lock: destination cache lock | |
149 | * @sk_policy: flow policy | |
150 | * @sk_rmem_alloc: receive queue bytes committed | |
151 | * @sk_receive_queue: incoming packets | |
152 | * @sk_wmem_alloc: transmit queue bytes committed | |
153 | * @sk_write_queue: Packet sending queue | |
97fc2f08 | 154 | * @sk_async_wait_queue: DMA copied packets |
4dc3b16b PP |
155 | * @sk_omem_alloc: "o" is "option" or "other" |
156 | * @sk_wmem_queued: persistent queue size | |
157 | * @sk_forward_alloc: space allocated forward | |
158 | * @sk_allocation: allocation mode | |
159 | * @sk_sndbuf: size of send buffer in bytes | |
33c732c3 WC |
160 | * @sk_flags: %SO_LINGER (l_onoff), %SO_BROADCAST, %SO_KEEPALIVE, |
161 | * %SO_OOBINLINE settings | |
4dc3b16b PP |
162 | * @sk_no_check: %SO_NO_CHECK setting, wether or not checkup packets |
163 | * @sk_route_caps: route capabilities (e.g. %NETIF_F_TSO) | |
bcd76111 | 164 | * @sk_gso_type: GSO type (e.g. %SKB_GSO_TCPV4) |
82cc1a7a | 165 | * @sk_gso_max_size: Maximum GSO segment size to build |
4dc3b16b | 166 | * @sk_lingertime: %SO_LINGER l_linger setting |
4dc3b16b PP |
167 | * @sk_backlog: always used with the per-socket spinlock held |
168 | * @sk_callback_lock: used with the callbacks in the end of this struct | |
169 | * @sk_error_queue: rarely used | |
33c732c3 WC |
170 | * @sk_prot_creator: sk_prot of original sock creator (see ipv6_setsockopt, |
171 | * IPV6_ADDRFORM for instance) | |
4dc3b16b | 172 | * @sk_err: last error |
33c732c3 WC |
173 | * @sk_err_soft: errors that don't cause failure but are the cause of a |
174 | * persistent failure not just 'timed out' | |
cb61cb9b | 175 | * @sk_drops: raw/udp drops counter |
4dc3b16b PP |
176 | * @sk_ack_backlog: current listen backlog |
177 | * @sk_max_ack_backlog: listen backlog set in listen() | |
178 | * @sk_priority: %SO_PRIORITY setting | |
179 | * @sk_type: socket type (%SOCK_STREAM, etc) | |
180 | * @sk_protocol: which protocol this socket belongs in this network family | |
181 | * @sk_peercred: %SO_PEERCRED setting | |
182 | * @sk_rcvlowat: %SO_RCVLOWAT setting | |
183 | * @sk_rcvtimeo: %SO_RCVTIMEO setting | |
184 | * @sk_sndtimeo: %SO_SNDTIMEO setting | |
185 | * @sk_filter: socket filtering instructions | |
186 | * @sk_protinfo: private area, net family specific, when not using slab | |
187 | * @sk_timer: sock cleanup timer | |
188 | * @sk_stamp: time stamp of last packet received | |
189 | * @sk_socket: Identd and reporting IO signals | |
190 | * @sk_user_data: RPC layer private data | |
191 | * @sk_sndmsg_page: cached page for sendmsg | |
192 | * @sk_sndmsg_off: cached offset for sendmsg | |
193 | * @sk_send_head: front of stuff to transmit | |
67be2dd1 | 194 | * @sk_security: used by security modules |
31729363 | 195 | * @sk_mark: generic packet mark |
4dc3b16b PP |
196 | * @sk_write_pending: a write to stream socket waits to start |
197 | * @sk_state_change: callback to indicate change in the state of the sock | |
198 | * @sk_data_ready: callback to indicate there is data to be processed | |
199 | * @sk_write_space: callback to indicate there is bf sending space available | |
200 | * @sk_error_report: callback to indicate errors (e.g. %MSG_ERRQUEUE) | |
201 | * @sk_backlog_rcv: callback to process the backlog | |
202 | * @sk_destruct: called at sock freeing time, i.e. when all refcnt == 0 | |
1da177e4 LT |
203 | */ |
204 | struct sock { | |
205 | /* | |
8feaf0c0 | 206 | * Now struct inet_timewait_sock also uses sock_common, so please just |
1da177e4 LT |
207 | * don't add nothing before this first member (__sk_common) --acme |
208 | */ | |
209 | struct sock_common __sk_common; | |
210 | #define sk_family __sk_common.skc_family | |
211 | #define sk_state __sk_common.skc_state | |
212 | #define sk_reuse __sk_common.skc_reuse | |
213 | #define sk_bound_dev_if __sk_common.skc_bound_dev_if | |
214 | #define sk_node __sk_common.skc_node | |
88ab1932 | 215 | #define sk_nulls_node __sk_common.skc_nulls_node |
1da177e4 LT |
216 | #define sk_bind_node __sk_common.skc_bind_node |
217 | #define sk_refcnt __sk_common.skc_refcnt | |
81c3d547 | 218 | #define sk_hash __sk_common.skc_hash |
8feaf0c0 | 219 | #define sk_prot __sk_common.skc_prot |
07feaebf | 220 | #define sk_net __sk_common.skc_net |
1da177e4 LT |
221 | unsigned char sk_shutdown : 2, |
222 | sk_no_check : 2, | |
223 | sk_userlocks : 4; | |
224 | unsigned char sk_protocol; | |
225 | unsigned short sk_type; | |
226 | int sk_rcvbuf; | |
227 | socket_lock_t sk_lock; | |
fa438ccf ED |
228 | /* |
229 | * The backlog queue is special, it is always used with | |
230 | * the per-socket spinlock held and requires low latency | |
231 | * access. Therefore we special case it's implementation. | |
232 | */ | |
233 | struct { | |
234 | struct sk_buff *head; | |
235 | struct sk_buff *tail; | |
236 | } sk_backlog; | |
1da177e4 LT |
237 | wait_queue_head_t *sk_sleep; |
238 | struct dst_entry *sk_dst_cache; | |
def8b4fa | 239 | #ifdef CONFIG_XFRM |
1da177e4 | 240 | struct xfrm_policy *sk_policy[2]; |
def8b4fa | 241 | #endif |
1da177e4 LT |
242 | rwlock_t sk_dst_lock; |
243 | atomic_t sk_rmem_alloc; | |
244 | atomic_t sk_wmem_alloc; | |
245 | atomic_t sk_omem_alloc; | |
4e07a91c | 246 | int sk_sndbuf; |
1da177e4 LT |
247 | struct sk_buff_head sk_receive_queue; |
248 | struct sk_buff_head sk_write_queue; | |
23789824 | 249 | #ifdef CONFIG_NET_DMA |
97fc2f08 | 250 | struct sk_buff_head sk_async_wait_queue; |
23789824 | 251 | #endif |
1da177e4 LT |
252 | int sk_wmem_queued; |
253 | int sk_forward_alloc; | |
7d877f3b | 254 | gfp_t sk_allocation; |
1da177e4 | 255 | int sk_route_caps; |
bcd76111 | 256 | int sk_gso_type; |
82cc1a7a | 257 | unsigned int sk_gso_max_size; |
9932cf95 | 258 | int sk_rcvlowat; |
1da177e4 LT |
259 | unsigned long sk_flags; |
260 | unsigned long sk_lingertime; | |
1da177e4 | 261 | struct sk_buff_head sk_error_queue; |
476e19cf | 262 | struct proto *sk_prot_creator; |
1da177e4 LT |
263 | rwlock_t sk_callback_lock; |
264 | int sk_err, | |
265 | sk_err_soft; | |
33c732c3 | 266 | atomic_t sk_drops; |
1da177e4 LT |
267 | unsigned short sk_ack_backlog; |
268 | unsigned short sk_max_ack_backlog; | |
269 | __u32 sk_priority; | |
270 | struct ucred sk_peercred; | |
1da177e4 LT |
271 | long sk_rcvtimeo; |
272 | long sk_sndtimeo; | |
273 | struct sk_filter *sk_filter; | |
274 | void *sk_protinfo; | |
275 | struct timer_list sk_timer; | |
b7aa0bf7 | 276 | ktime_t sk_stamp; |
1da177e4 LT |
277 | struct socket *sk_socket; |
278 | void *sk_user_data; | |
279 | struct page *sk_sndmsg_page; | |
280 | struct sk_buff *sk_send_head; | |
281 | __u32 sk_sndmsg_off; | |
282 | int sk_write_pending; | |
d5f64238 | 283 | #ifdef CONFIG_SECURITY |
1da177e4 | 284 | void *sk_security; |
d5f64238 | 285 | #endif |
4a19ec58 LAT |
286 | __u32 sk_mark; |
287 | /* XXX 4 bytes hole on 64 bit */ | |
1da177e4 LT |
288 | void (*sk_state_change)(struct sock *sk); |
289 | void (*sk_data_ready)(struct sock *sk, int bytes); | |
290 | void (*sk_write_space)(struct sock *sk); | |
291 | void (*sk_error_report)(struct sock *sk); | |
292 | int (*sk_backlog_rcv)(struct sock *sk, | |
293 | struct sk_buff *skb); | |
294 | void (*sk_destruct)(struct sock *sk); | |
295 | }; | |
296 | ||
297 | /* | |
298 | * Hashed lists helper routines | |
299 | */ | |
e48c414e | 300 | static inline struct sock *__sk_head(const struct hlist_head *head) |
1da177e4 LT |
301 | { |
302 | return hlist_entry(head->first, struct sock, sk_node); | |
303 | } | |
304 | ||
e48c414e | 305 | static inline struct sock *sk_head(const struct hlist_head *head) |
1da177e4 LT |
306 | { |
307 | return hlist_empty(head) ? NULL : __sk_head(head); | |
308 | } | |
309 | ||
88ab1932 ED |
310 | static inline struct sock *__sk_nulls_head(const struct hlist_nulls_head *head) |
311 | { | |
312 | return hlist_nulls_entry(head->first, struct sock, sk_nulls_node); | |
313 | } | |
314 | ||
315 | static inline struct sock *sk_nulls_head(const struct hlist_nulls_head *head) | |
316 | { | |
317 | return hlist_nulls_empty(head) ? NULL : __sk_nulls_head(head); | |
318 | } | |
319 | ||
e48c414e | 320 | static inline struct sock *sk_next(const struct sock *sk) |
1da177e4 LT |
321 | { |
322 | return sk->sk_node.next ? | |
323 | hlist_entry(sk->sk_node.next, struct sock, sk_node) : NULL; | |
324 | } | |
325 | ||
88ab1932 ED |
326 | static inline struct sock *sk_nulls_next(const struct sock *sk) |
327 | { | |
328 | return (!is_a_nulls(sk->sk_nulls_node.next)) ? | |
329 | hlist_nulls_entry(sk->sk_nulls_node.next, | |
330 | struct sock, sk_nulls_node) : | |
331 | NULL; | |
332 | } | |
333 | ||
e48c414e | 334 | static inline int sk_unhashed(const struct sock *sk) |
1da177e4 LT |
335 | { |
336 | return hlist_unhashed(&sk->sk_node); | |
337 | } | |
338 | ||
e48c414e | 339 | static inline int sk_hashed(const struct sock *sk) |
1da177e4 | 340 | { |
da753bea | 341 | return !sk_unhashed(sk); |
1da177e4 LT |
342 | } |
343 | ||
344 | static __inline__ void sk_node_init(struct hlist_node *node) | |
345 | { | |
346 | node->pprev = NULL; | |
347 | } | |
348 | ||
88ab1932 ED |
349 | static __inline__ void sk_nulls_node_init(struct hlist_nulls_node *node) |
350 | { | |
351 | node->pprev = NULL; | |
352 | } | |
353 | ||
1da177e4 LT |
354 | static __inline__ void __sk_del_node(struct sock *sk) |
355 | { | |
356 | __hlist_del(&sk->sk_node); | |
357 | } | |
358 | ||
359 | static __inline__ int __sk_del_node_init(struct sock *sk) | |
360 | { | |
361 | if (sk_hashed(sk)) { | |
362 | __sk_del_node(sk); | |
363 | sk_node_init(&sk->sk_node); | |
364 | return 1; | |
365 | } | |
366 | return 0; | |
367 | } | |
368 | ||
369 | /* Grab socket reference count. This operation is valid only | |
370 | when sk is ALREADY grabbed f.e. it is found in hash table | |
371 | or a list and the lookup is made under lock preventing hash table | |
372 | modifications. | |
373 | */ | |
374 | ||
375 | static inline void sock_hold(struct sock *sk) | |
376 | { | |
377 | atomic_inc(&sk->sk_refcnt); | |
378 | } | |
379 | ||
380 | /* Ungrab socket in the context, which assumes that socket refcnt | |
381 | cannot hit zero, f.e. it is true in context of any socketcall. | |
382 | */ | |
383 | static inline void __sock_put(struct sock *sk) | |
384 | { | |
385 | atomic_dec(&sk->sk_refcnt); | |
386 | } | |
387 | ||
388 | static __inline__ int sk_del_node_init(struct sock *sk) | |
389 | { | |
390 | int rc = __sk_del_node_init(sk); | |
391 | ||
392 | if (rc) { | |
393 | /* paranoid for a while -acme */ | |
394 | WARN_ON(atomic_read(&sk->sk_refcnt) == 1); | |
395 | __sock_put(sk); | |
396 | } | |
397 | return rc; | |
398 | } | |
399 | ||
88ab1932 | 400 | static __inline__ int __sk_nulls_del_node_init_rcu(struct sock *sk) |
271b72c7 ED |
401 | { |
402 | if (sk_hashed(sk)) { | |
88ab1932 | 403 | hlist_nulls_del_init_rcu(&sk->sk_nulls_node); |
271b72c7 ED |
404 | return 1; |
405 | } | |
406 | return 0; | |
407 | } | |
408 | ||
88ab1932 | 409 | static __inline__ int sk_nulls_del_node_init_rcu(struct sock *sk) |
271b72c7 | 410 | { |
88ab1932 | 411 | int rc = __sk_nulls_del_node_init_rcu(sk); |
271b72c7 ED |
412 | |
413 | if (rc) { | |
414 | /* paranoid for a while -acme */ | |
415 | WARN_ON(atomic_read(&sk->sk_refcnt) == 1); | |
416 | __sock_put(sk); | |
417 | } | |
418 | return rc; | |
419 | } | |
420 | ||
1da177e4 LT |
421 | static __inline__ void __sk_add_node(struct sock *sk, struct hlist_head *list) |
422 | { | |
423 | hlist_add_head(&sk->sk_node, list); | |
424 | } | |
425 | ||
426 | static __inline__ void sk_add_node(struct sock *sk, struct hlist_head *list) | |
427 | { | |
428 | sock_hold(sk); | |
429 | __sk_add_node(sk, list); | |
430 | } | |
431 | ||
88ab1932 | 432 | static __inline__ void __sk_nulls_add_node_rcu(struct sock *sk, struct hlist_nulls_head *list) |
271b72c7 | 433 | { |
88ab1932 | 434 | hlist_nulls_add_head_rcu(&sk->sk_nulls_node, list); |
271b72c7 ED |
435 | } |
436 | ||
88ab1932 | 437 | static __inline__ void sk_nulls_add_node_rcu(struct sock *sk, struct hlist_nulls_head *list) |
271b72c7 ED |
438 | { |
439 | sock_hold(sk); | |
88ab1932 | 440 | __sk_nulls_add_node_rcu(sk, list); |
271b72c7 ED |
441 | } |
442 | ||
1da177e4 LT |
443 | static __inline__ void __sk_del_bind_node(struct sock *sk) |
444 | { | |
445 | __hlist_del(&sk->sk_bind_node); | |
446 | } | |
447 | ||
448 | static __inline__ void sk_add_bind_node(struct sock *sk, | |
449 | struct hlist_head *list) | |
450 | { | |
451 | hlist_add_head(&sk->sk_bind_node, list); | |
452 | } | |
453 | ||
454 | #define sk_for_each(__sk, node, list) \ | |
455 | hlist_for_each_entry(__sk, node, list, sk_node) | |
88ab1932 ED |
456 | #define sk_nulls_for_each(__sk, node, list) \ |
457 | hlist_nulls_for_each_entry(__sk, node, list, sk_nulls_node) | |
458 | #define sk_nulls_for_each_rcu(__sk, node, list) \ | |
459 | hlist_nulls_for_each_entry_rcu(__sk, node, list, sk_nulls_node) | |
1da177e4 LT |
460 | #define sk_for_each_from(__sk, node) \ |
461 | if (__sk && ({ node = &(__sk)->sk_node; 1; })) \ | |
462 | hlist_for_each_entry_from(__sk, node, sk_node) | |
88ab1932 ED |
463 | #define sk_nulls_for_each_from(__sk, node) \ |
464 | if (__sk && ({ node = &(__sk)->sk_nulls_node; 1; })) \ | |
465 | hlist_nulls_for_each_entry_from(__sk, node, sk_nulls_node) | |
1da177e4 LT |
466 | #define sk_for_each_continue(__sk, node) \ |
467 | if (__sk && ({ node = &(__sk)->sk_node; 1; })) \ | |
468 | hlist_for_each_entry_continue(__sk, node, sk_node) | |
469 | #define sk_for_each_safe(__sk, node, tmp, list) \ | |
470 | hlist_for_each_entry_safe(__sk, node, tmp, list, sk_node) | |
471 | #define sk_for_each_bound(__sk, node, list) \ | |
472 | hlist_for_each_entry(__sk, node, list, sk_bind_node) | |
473 | ||
474 | /* Sock flags */ | |
475 | enum sock_flags { | |
476 | SOCK_DEAD, | |
477 | SOCK_DONE, | |
478 | SOCK_URGINLINE, | |
479 | SOCK_KEEPOPEN, | |
480 | SOCK_LINGER, | |
481 | SOCK_DESTROY, | |
482 | SOCK_BROADCAST, | |
483 | SOCK_TIMESTAMP, | |
484 | SOCK_ZAPPED, | |
485 | SOCK_USE_WRITE_QUEUE, /* whether to call sk->sk_write_space in sock_wfree */ | |
486 | SOCK_DBG, /* %SO_DEBUG setting */ | |
487 | SOCK_RCVTSTAMP, /* %SO_TIMESTAMP setting */ | |
92f37fd2 | 488 | SOCK_RCVTSTAMPNS, /* %SO_TIMESTAMPNS setting */ |
1da177e4 LT |
489 | SOCK_LOCALROUTE, /* route locally only, %SO_DONTROUTE setting */ |
490 | SOCK_QUEUE_SHRUNK, /* write queue has been shrunk recently */ | |
491 | }; | |
492 | ||
53b924b3 RB |
493 | static inline void sock_copy_flags(struct sock *nsk, struct sock *osk) |
494 | { | |
495 | nsk->sk_flags = osk->sk_flags; | |
496 | } | |
497 | ||
1da177e4 LT |
498 | static inline void sock_set_flag(struct sock *sk, enum sock_flags flag) |
499 | { | |
500 | __set_bit(flag, &sk->sk_flags); | |
501 | } | |
502 | ||
503 | static inline void sock_reset_flag(struct sock *sk, enum sock_flags flag) | |
504 | { | |
505 | __clear_bit(flag, &sk->sk_flags); | |
506 | } | |
507 | ||
508 | static inline int sock_flag(struct sock *sk, enum sock_flags flag) | |
509 | { | |
510 | return test_bit(flag, &sk->sk_flags); | |
511 | } | |
512 | ||
513 | static inline void sk_acceptq_removed(struct sock *sk) | |
514 | { | |
515 | sk->sk_ack_backlog--; | |
516 | } | |
517 | ||
518 | static inline void sk_acceptq_added(struct sock *sk) | |
519 | { | |
520 | sk->sk_ack_backlog++; | |
521 | } | |
522 | ||
523 | static inline int sk_acceptq_is_full(struct sock *sk) | |
524 | { | |
64a14651 | 525 | return sk->sk_ack_backlog > sk->sk_max_ack_backlog; |
1da177e4 LT |
526 | } |
527 | ||
528 | /* | |
529 | * Compute minimal free write space needed to queue new packets. | |
530 | */ | |
531 | static inline int sk_stream_min_wspace(struct sock *sk) | |
532 | { | |
8df09ea3 | 533 | return sk->sk_wmem_queued >> 1; |
1da177e4 LT |
534 | } |
535 | ||
536 | static inline int sk_stream_wspace(struct sock *sk) | |
537 | { | |
538 | return sk->sk_sndbuf - sk->sk_wmem_queued; | |
539 | } | |
540 | ||
541 | extern void sk_stream_write_space(struct sock *sk); | |
542 | ||
543 | static inline int sk_stream_memory_free(struct sock *sk) | |
544 | { | |
545 | return sk->sk_wmem_queued < sk->sk_sndbuf; | |
546 | } | |
547 | ||
1da177e4 | 548 | /* The per-socket spinlock must be held here. */ |
9ee6b535 SH |
549 | static inline void sk_add_backlog(struct sock *sk, struct sk_buff *skb) |
550 | { | |
551 | if (!sk->sk_backlog.tail) { | |
552 | sk->sk_backlog.head = sk->sk_backlog.tail = skb; | |
553 | } else { | |
554 | sk->sk_backlog.tail->next = skb; | |
555 | sk->sk_backlog.tail = skb; | |
556 | } | |
557 | skb->next = NULL; | |
558 | } | |
1da177e4 | 559 | |
c57943a1 PZ |
560 | static inline int sk_backlog_rcv(struct sock *sk, struct sk_buff *skb) |
561 | { | |
562 | return sk->sk_backlog_rcv(sk, skb); | |
563 | } | |
564 | ||
cfcabdcc SH |
565 | #define sk_wait_event(__sk, __timeo, __condition) \ |
566 | ({ int __rc; \ | |
567 | release_sock(__sk); \ | |
568 | __rc = __condition; \ | |
569 | if (!__rc) { \ | |
570 | *(__timeo) = schedule_timeout(*(__timeo)); \ | |
571 | } \ | |
572 | lock_sock(__sk); \ | |
573 | __rc = __condition; \ | |
574 | __rc; \ | |
575 | }) | |
1da177e4 LT |
576 | |
577 | extern int sk_stream_wait_connect(struct sock *sk, long *timeo_p); | |
578 | extern int sk_stream_wait_memory(struct sock *sk, long *timeo_p); | |
579 | extern void sk_stream_wait_close(struct sock *sk, long timeo_p); | |
580 | extern int sk_stream_error(struct sock *sk, int flags, int err); | |
581 | extern void sk_stream_kill_queues(struct sock *sk); | |
582 | ||
583 | extern int sk_wait_data(struct sock *sk, long *timeo); | |
584 | ||
60236fdd | 585 | struct request_sock_ops; |
6d6ee43e | 586 | struct timewait_sock_ops; |
ab1e0a13 | 587 | struct inet_hashinfo; |
fc8717ba | 588 | struct raw_hashinfo; |
2e6599cb | 589 | |
1da177e4 LT |
590 | /* Networking protocol blocks we attach to sockets. |
591 | * socket layer -> transport layer interface | |
592 | * transport -> network interface is defined by struct inet_proto | |
593 | */ | |
594 | struct proto { | |
595 | void (*close)(struct sock *sk, | |
596 | long timeout); | |
597 | int (*connect)(struct sock *sk, | |
598 | struct sockaddr *uaddr, | |
599 | int addr_len); | |
600 | int (*disconnect)(struct sock *sk, int flags); | |
601 | ||
602 | struct sock * (*accept) (struct sock *sk, int flags, int *err); | |
603 | ||
604 | int (*ioctl)(struct sock *sk, int cmd, | |
605 | unsigned long arg); | |
606 | int (*init)(struct sock *sk); | |
7d06b2e0 | 607 | void (*destroy)(struct sock *sk); |
1da177e4 LT |
608 | void (*shutdown)(struct sock *sk, int how); |
609 | int (*setsockopt)(struct sock *sk, int level, | |
610 | int optname, char __user *optval, | |
611 | int optlen); | |
612 | int (*getsockopt)(struct sock *sk, int level, | |
613 | int optname, char __user *optval, | |
614 | int __user *option); | |
af01d537 | 615 | #ifdef CONFIG_COMPAT |
3fdadf7d DM |
616 | int (*compat_setsockopt)(struct sock *sk, |
617 | int level, | |
618 | int optname, char __user *optval, | |
619 | int optlen); | |
620 | int (*compat_getsockopt)(struct sock *sk, | |
621 | int level, | |
622 | int optname, char __user *optval, | |
623 | int __user *option); | |
af01d537 | 624 | #endif |
1da177e4 LT |
625 | int (*sendmsg)(struct kiocb *iocb, struct sock *sk, |
626 | struct msghdr *msg, size_t len); | |
627 | int (*recvmsg)(struct kiocb *iocb, struct sock *sk, | |
628 | struct msghdr *msg, | |
629 | size_t len, int noblock, int flags, | |
630 | int *addr_len); | |
631 | int (*sendpage)(struct sock *sk, struct page *page, | |
632 | int offset, size_t size, int flags); | |
633 | int (*bind)(struct sock *sk, | |
634 | struct sockaddr *uaddr, int addr_len); | |
635 | ||
636 | int (*backlog_rcv) (struct sock *sk, | |
637 | struct sk_buff *skb); | |
638 | ||
639 | /* Keeping track of sk's, looking them up, and port selection methods. */ | |
640 | void (*hash)(struct sock *sk); | |
641 | void (*unhash)(struct sock *sk); | |
642 | int (*get_port)(struct sock *sk, unsigned short snum); | |
643 | ||
286ab3d4 | 644 | /* Keeping track of sockets in use */ |
65f76517 | 645 | #ifdef CONFIG_PROC_FS |
13ff3d6f | 646 | unsigned int inuse_idx; |
65f76517 | 647 | #endif |
ebb53d75 | 648 | |
1da177e4 | 649 | /* Memory pressure */ |
5c52ba17 | 650 | void (*enter_memory_pressure)(struct sock *sk); |
1da177e4 | 651 | atomic_t *memory_allocated; /* Current allocated memory. */ |
1748376b | 652 | struct percpu_counter *sockets_allocated; /* Current number of sockets. */ |
1da177e4 LT |
653 | /* |
654 | * Pressure flag: try to collapse. | |
655 | * Technical note: it is used by multiple contexts non atomically. | |
3ab224be | 656 | * All the __sk_mem_schedule() is of this nature: accounting |
1da177e4 LT |
657 | * is strict, actions are advisory and have some latency. |
658 | */ | |
659 | int *memory_pressure; | |
660 | int *sysctl_mem; | |
661 | int *sysctl_wmem; | |
662 | int *sysctl_rmem; | |
663 | int max_header; | |
664 | ||
271b72c7 | 665 | struct kmem_cache *slab; |
1da177e4 | 666 | unsigned int obj_size; |
271b72c7 | 667 | int slab_flags; |
1da177e4 | 668 | |
dd24c001 | 669 | struct percpu_counter *orphan_count; |
8feaf0c0 | 670 | |
60236fdd | 671 | struct request_sock_ops *rsk_prot; |
6d6ee43e | 672 | struct timewait_sock_ops *twsk_prot; |
2e6599cb | 673 | |
39d8cda7 PE |
674 | union { |
675 | struct inet_hashinfo *hashinfo; | |
645ca708 | 676 | struct udp_table *udp_table; |
fc8717ba | 677 | struct raw_hashinfo *raw_hash; |
39d8cda7 | 678 | } h; |
ab1e0a13 | 679 | |
1da177e4 LT |
680 | struct module *owner; |
681 | ||
682 | char name[32]; | |
683 | ||
684 | struct list_head node; | |
e6848976 ACM |
685 | #ifdef SOCK_REFCNT_DEBUG |
686 | atomic_t socks; | |
687 | #endif | |
1da177e4 LT |
688 | }; |
689 | ||
690 | extern int proto_register(struct proto *prot, int alloc_slab); | |
691 | extern void proto_unregister(struct proto *prot); | |
692 | ||
e6848976 ACM |
693 | #ifdef SOCK_REFCNT_DEBUG |
694 | static inline void sk_refcnt_debug_inc(struct sock *sk) | |
695 | { | |
696 | atomic_inc(&sk->sk_prot->socks); | |
697 | } | |
698 | ||
699 | static inline void sk_refcnt_debug_dec(struct sock *sk) | |
700 | { | |
701 | atomic_dec(&sk->sk_prot->socks); | |
702 | printk(KERN_DEBUG "%s socket %p released, %d are still alive\n", | |
703 | sk->sk_prot->name, sk, atomic_read(&sk->sk_prot->socks)); | |
704 | } | |
705 | ||
706 | static inline void sk_refcnt_debug_release(const struct sock *sk) | |
707 | { | |
708 | if (atomic_read(&sk->sk_refcnt) != 1) | |
709 | printk(KERN_DEBUG "Destruction of the %s socket %p delayed, refcnt=%d\n", | |
710 | sk->sk_prot->name, sk, atomic_read(&sk->sk_refcnt)); | |
711 | } | |
712 | #else /* SOCK_REFCNT_DEBUG */ | |
713 | #define sk_refcnt_debug_inc(sk) do { } while (0) | |
714 | #define sk_refcnt_debug_dec(sk) do { } while (0) | |
715 | #define sk_refcnt_debug_release(sk) do { } while (0) | |
716 | #endif /* SOCK_REFCNT_DEBUG */ | |
717 | ||
65f76517 ED |
718 | |
719 | #ifdef CONFIG_PROC_FS | |
1da177e4 | 720 | /* Called with local bh disabled */ |
c29a0bc4 PE |
721 | extern void sock_prot_inuse_add(struct net *net, struct proto *prot, int inc); |
722 | extern int sock_prot_inuse_get(struct net *net, struct proto *proto); | |
65f76517 | 723 | #else |
c29a0bc4 PE |
724 | static void inline sock_prot_inuse_add(struct net *net, struct proto *prot, |
725 | int inc) | |
65f76517 ED |
726 | { |
727 | } | |
65f76517 ED |
728 | #endif |
729 | ||
1da177e4 | 730 | |
614c6cb4 ACM |
731 | /* With per-bucket locks this operation is not-atomic, so that |
732 | * this version is not worse. | |
733 | */ | |
734 | static inline void __sk_prot_rehash(struct sock *sk) | |
735 | { | |
736 | sk->sk_prot->unhash(sk); | |
737 | sk->sk_prot->hash(sk); | |
738 | } | |
739 | ||
1da177e4 LT |
740 | /* About 10 seconds */ |
741 | #define SOCK_DESTROY_TIME (10*HZ) | |
742 | ||
743 | /* Sockets 0-1023 can't be bound to unless you are superuser */ | |
744 | #define PROT_SOCK 1024 | |
745 | ||
746 | #define SHUTDOWN_MASK 3 | |
747 | #define RCV_SHUTDOWN 1 | |
748 | #define SEND_SHUTDOWN 2 | |
749 | ||
750 | #define SOCK_SNDBUF_LOCK 1 | |
751 | #define SOCK_RCVBUF_LOCK 2 | |
752 | #define SOCK_BINDADDR_LOCK 4 | |
753 | #define SOCK_BINDPORT_LOCK 8 | |
754 | ||
755 | /* sock_iocb: used to kick off async processing of socket ios */ | |
756 | struct sock_iocb { | |
757 | struct list_head list; | |
758 | ||
759 | int flags; | |
760 | int size; | |
761 | struct socket *sock; | |
762 | struct sock *sk; | |
763 | struct scm_cookie *scm; | |
764 | struct msghdr *msg, async_msg; | |
1da177e4 LT |
765 | struct kiocb *kiocb; |
766 | }; | |
767 | ||
768 | static inline struct sock_iocb *kiocb_to_siocb(struct kiocb *iocb) | |
769 | { | |
770 | return (struct sock_iocb *)iocb->private; | |
771 | } | |
772 | ||
773 | static inline struct kiocb *siocb_to_kiocb(struct sock_iocb *si) | |
774 | { | |
775 | return si->kiocb; | |
776 | } | |
777 | ||
778 | struct socket_alloc { | |
779 | struct socket socket; | |
780 | struct inode vfs_inode; | |
781 | }; | |
782 | ||
783 | static inline struct socket *SOCKET_I(struct inode *inode) | |
784 | { | |
785 | return &container_of(inode, struct socket_alloc, vfs_inode)->socket; | |
786 | } | |
787 | ||
788 | static inline struct inode *SOCK_INODE(struct socket *socket) | |
789 | { | |
790 | return &container_of(socket, struct socket_alloc, socket)->vfs_inode; | |
791 | } | |
792 | ||
3ab224be HA |
793 | /* |
794 | * Functions for memory accounting | |
795 | */ | |
796 | extern int __sk_mem_schedule(struct sock *sk, int size, int kind); | |
797 | extern void __sk_mem_reclaim(struct sock *sk); | |
1da177e4 | 798 | |
3ab224be HA |
799 | #define SK_MEM_QUANTUM ((int)PAGE_SIZE) |
800 | #define SK_MEM_QUANTUM_SHIFT ilog2(SK_MEM_QUANTUM) | |
801 | #define SK_MEM_SEND 0 | |
802 | #define SK_MEM_RECV 1 | |
1da177e4 | 803 | |
3ab224be | 804 | static inline int sk_mem_pages(int amt) |
1da177e4 | 805 | { |
3ab224be | 806 | return (amt + SK_MEM_QUANTUM - 1) >> SK_MEM_QUANTUM_SHIFT; |
1da177e4 LT |
807 | } |
808 | ||
3ab224be | 809 | static inline int sk_has_account(struct sock *sk) |
1da177e4 | 810 | { |
3ab224be HA |
811 | /* return true if protocol supports memory accounting */ |
812 | return !!sk->sk_prot->memory_allocated; | |
1da177e4 LT |
813 | } |
814 | ||
3ab224be | 815 | static inline int sk_wmem_schedule(struct sock *sk, int size) |
1da177e4 | 816 | { |
3ab224be HA |
817 | if (!sk_has_account(sk)) |
818 | return 1; | |
819 | return size <= sk->sk_forward_alloc || | |
820 | __sk_mem_schedule(sk, size, SK_MEM_SEND); | |
1da177e4 LT |
821 | } |
822 | ||
3ab224be | 823 | static inline int sk_rmem_schedule(struct sock *sk, int size) |
d80d99d6 | 824 | { |
3ab224be HA |
825 | if (!sk_has_account(sk)) |
826 | return 1; | |
d80d99d6 | 827 | return size <= sk->sk_forward_alloc || |
3ab224be HA |
828 | __sk_mem_schedule(sk, size, SK_MEM_RECV); |
829 | } | |
830 | ||
831 | static inline void sk_mem_reclaim(struct sock *sk) | |
832 | { | |
833 | if (!sk_has_account(sk)) | |
834 | return; | |
835 | if (sk->sk_forward_alloc >= SK_MEM_QUANTUM) | |
836 | __sk_mem_reclaim(sk); | |
837 | } | |
838 | ||
9993e7d3 DM |
839 | static inline void sk_mem_reclaim_partial(struct sock *sk) |
840 | { | |
841 | if (!sk_has_account(sk)) | |
842 | return; | |
843 | if (sk->sk_forward_alloc > SK_MEM_QUANTUM) | |
844 | __sk_mem_reclaim(sk); | |
845 | } | |
846 | ||
3ab224be HA |
847 | static inline void sk_mem_charge(struct sock *sk, int size) |
848 | { | |
849 | if (!sk_has_account(sk)) | |
850 | return; | |
851 | sk->sk_forward_alloc -= size; | |
852 | } | |
853 | ||
854 | static inline void sk_mem_uncharge(struct sock *sk, int size) | |
855 | { | |
856 | if (!sk_has_account(sk)) | |
857 | return; | |
858 | sk->sk_forward_alloc += size; | |
859 | } | |
860 | ||
861 | static inline void sk_wmem_free_skb(struct sock *sk, struct sk_buff *skb) | |
862 | { | |
863 | skb_truesize_check(skb); | |
864 | sock_set_flag(sk, SOCK_QUEUE_SHRUNK); | |
865 | sk->sk_wmem_queued -= skb->truesize; | |
866 | sk_mem_uncharge(sk, skb->truesize); | |
867 | __kfree_skb(skb); | |
d80d99d6 HX |
868 | } |
869 | ||
1da177e4 LT |
870 | /* Used by processes to "lock" a socket state, so that |
871 | * interrupts and bottom half handlers won't change it | |
872 | * from under us. It essentially blocks any incoming | |
873 | * packets, so that we won't get any new data or any | |
874 | * packets that change the state of the socket. | |
875 | * | |
876 | * While locked, BH processing will add new packets to | |
877 | * the backlog queue. This queue is processed by the | |
878 | * owner of the socket lock right before it is released. | |
879 | * | |
880 | * Since ~2.3.5 it is also exclusive sleep lock serializing | |
881 | * accesses from user process context. | |
882 | */ | |
d2e9117c | 883 | #define sock_owned_by_user(sk) ((sk)->sk_lock.owned) |
1da177e4 | 884 | |
ed07536e PZ |
885 | /* |
886 | * Macro so as to not evaluate some arguments when | |
887 | * lockdep is not enabled. | |
888 | * | |
889 | * Mark both the sk_lock and the sk_lock.slock as a | |
890 | * per-address-family lock class. | |
891 | */ | |
892 | #define sock_lock_init_class_and_name(sk, sname, skey, name, key) \ | |
893 | do { \ | |
e8f6fbf6 | 894 | sk->sk_lock.owned = 0; \ |
ed07536e PZ |
895 | init_waitqueue_head(&sk->sk_lock.wq); \ |
896 | spin_lock_init(&(sk)->sk_lock.slock); \ | |
897 | debug_check_no_locks_freed((void *)&(sk)->sk_lock, \ | |
898 | sizeof((sk)->sk_lock)); \ | |
899 | lockdep_set_class_and_name(&(sk)->sk_lock.slock, \ | |
900 | (skey), (sname)); \ | |
901 | lockdep_init_map(&(sk)->sk_lock.dep_map, (name), (key), 0); \ | |
902 | } while (0) | |
903 | ||
41380930 | 904 | extern void lock_sock_nested(struct sock *sk, int subclass); |
fcc70d5f PZ |
905 | |
906 | static inline void lock_sock(struct sock *sk) | |
907 | { | |
908 | lock_sock_nested(sk, 0); | |
909 | } | |
910 | ||
41380930 | 911 | extern void release_sock(struct sock *sk); |
1da177e4 LT |
912 | |
913 | /* BH context may only use the following locking interface. */ | |
914 | #define bh_lock_sock(__sk) spin_lock(&((__sk)->sk_lock.slock)) | |
c6366184 IM |
915 | #define bh_lock_sock_nested(__sk) \ |
916 | spin_lock_nested(&((__sk)->sk_lock.slock), \ | |
917 | SINGLE_DEPTH_NESTING) | |
1da177e4 LT |
918 | #define bh_unlock_sock(__sk) spin_unlock(&((__sk)->sk_lock.slock)) |
919 | ||
1b8d7ae4 | 920 | extern struct sock *sk_alloc(struct net *net, int family, |
dd0fc66f | 921 | gfp_t priority, |
6257ff21 | 922 | struct proto *prot); |
1da177e4 | 923 | extern void sk_free(struct sock *sk); |
edf02087 | 924 | extern void sk_release_kernel(struct sock *sk); |
87d11ceb | 925 | extern struct sock *sk_clone(const struct sock *sk, |
dd0fc66f | 926 | const gfp_t priority); |
1da177e4 LT |
927 | |
928 | extern struct sk_buff *sock_wmalloc(struct sock *sk, | |
929 | unsigned long size, int force, | |
dd0fc66f | 930 | gfp_t priority); |
1da177e4 LT |
931 | extern struct sk_buff *sock_rmalloc(struct sock *sk, |
932 | unsigned long size, int force, | |
dd0fc66f | 933 | gfp_t priority); |
1da177e4 LT |
934 | extern void sock_wfree(struct sk_buff *skb); |
935 | extern void sock_rfree(struct sk_buff *skb); | |
936 | ||
937 | extern int sock_setsockopt(struct socket *sock, int level, | |
938 | int op, char __user *optval, | |
939 | int optlen); | |
940 | ||
941 | extern int sock_getsockopt(struct socket *sock, int level, | |
942 | int op, char __user *optval, | |
943 | int __user *optlen); | |
944 | extern struct sk_buff *sock_alloc_send_skb(struct sock *sk, | |
945 | unsigned long size, | |
946 | int noblock, | |
947 | int *errcode); | |
86a76caf | 948 | extern void *sock_kmalloc(struct sock *sk, int size, |
dd0fc66f | 949 | gfp_t priority); |
1da177e4 LT |
950 | extern void sock_kfree_s(struct sock *sk, void *mem, int size); |
951 | extern void sk_send_sigurg(struct sock *sk); | |
952 | ||
953 | /* | |
954 | * Functions to fill in entries in struct proto_ops when a protocol | |
955 | * does not implement a particular function. | |
956 | */ | |
957 | extern int sock_no_bind(struct socket *, | |
958 | struct sockaddr *, int); | |
959 | extern int sock_no_connect(struct socket *, | |
960 | struct sockaddr *, int, int); | |
961 | extern int sock_no_socketpair(struct socket *, | |
962 | struct socket *); | |
963 | extern int sock_no_accept(struct socket *, | |
964 | struct socket *, int); | |
965 | extern int sock_no_getname(struct socket *, | |
966 | struct sockaddr *, int *, int); | |
967 | extern unsigned int sock_no_poll(struct file *, struct socket *, | |
968 | struct poll_table_struct *); | |
969 | extern int sock_no_ioctl(struct socket *, unsigned int, | |
970 | unsigned long); | |
971 | extern int sock_no_listen(struct socket *, int); | |
972 | extern int sock_no_shutdown(struct socket *, int); | |
973 | extern int sock_no_getsockopt(struct socket *, int , int, | |
974 | char __user *, int __user *); | |
975 | extern int sock_no_setsockopt(struct socket *, int, int, | |
976 | char __user *, int); | |
977 | extern int sock_no_sendmsg(struct kiocb *, struct socket *, | |
978 | struct msghdr *, size_t); | |
979 | extern int sock_no_recvmsg(struct kiocb *, struct socket *, | |
980 | struct msghdr *, size_t, int); | |
981 | extern int sock_no_mmap(struct file *file, | |
982 | struct socket *sock, | |
983 | struct vm_area_struct *vma); | |
984 | extern ssize_t sock_no_sendpage(struct socket *sock, | |
985 | struct page *page, | |
986 | int offset, size_t size, | |
987 | int flags); | |
988 | ||
989 | /* | |
990 | * Functions to fill in entries in struct proto_ops when a protocol | |
991 | * uses the inet style. | |
992 | */ | |
993 | extern int sock_common_getsockopt(struct socket *sock, int level, int optname, | |
994 | char __user *optval, int __user *optlen); | |
995 | extern int sock_common_recvmsg(struct kiocb *iocb, struct socket *sock, | |
996 | struct msghdr *msg, size_t size, int flags); | |
997 | extern int sock_common_setsockopt(struct socket *sock, int level, int optname, | |
998 | char __user *optval, int optlen); | |
3fdadf7d DM |
999 | extern int compat_sock_common_getsockopt(struct socket *sock, int level, |
1000 | int optname, char __user *optval, int __user *optlen); | |
1001 | extern int compat_sock_common_setsockopt(struct socket *sock, int level, | |
1002 | int optname, char __user *optval, int optlen); | |
1da177e4 LT |
1003 | |
1004 | extern void sk_common_release(struct sock *sk); | |
1005 | ||
1006 | /* | |
1007 | * Default socket callbacks and setup code | |
1008 | */ | |
1009 | ||
1010 | /* Initialise core socket variables */ | |
1011 | extern void sock_init_data(struct socket *sock, struct sock *sk); | |
1012 | ||
dc9b3346 PB |
1013 | /** |
1014 | * sk_filter_release: Release a socket filter | |
dc9b3346 PB |
1015 | * @fp: filter to remove |
1016 | * | |
1017 | * Remove a filter from a socket and release its resources. | |
1018 | */ | |
1019 | ||
309dd5fc PE |
1020 | static inline void sk_filter_release(struct sk_filter *fp) |
1021 | { | |
1022 | if (atomic_dec_and_test(&fp->refcnt)) | |
47e958ea | 1023 | kfree(fp); |
309dd5fc PE |
1024 | } |
1025 | ||
1026 | static inline void sk_filter_uncharge(struct sock *sk, struct sk_filter *fp) | |
1da177e4 LT |
1027 | { |
1028 | unsigned int size = sk_filter_len(fp); | |
1029 | ||
1030 | atomic_sub(size, &sk->sk_omem_alloc); | |
309dd5fc | 1031 | sk_filter_release(fp); |
1da177e4 LT |
1032 | } |
1033 | ||
1034 | static inline void sk_filter_charge(struct sock *sk, struct sk_filter *fp) | |
1035 | { | |
1036 | atomic_inc(&fp->refcnt); | |
1037 | atomic_add(sk_filter_len(fp), &sk->sk_omem_alloc); | |
1038 | } | |
1039 | ||
1040 | /* | |
1041 | * Socket reference counting postulates. | |
1042 | * | |
1043 | * * Each user of socket SHOULD hold a reference count. | |
1044 | * * Each access point to socket (an hash table bucket, reference from a list, | |
1045 | * running timer, skb in flight MUST hold a reference count. | |
1046 | * * When reference count hits 0, it means it will never increase back. | |
1047 | * * When reference count hits 0, it means that no references from | |
1048 | * outside exist to this socket and current process on current CPU | |
1049 | * is last user and may/should destroy this socket. | |
1050 | * * sk_free is called from any context: process, BH, IRQ. When | |
1051 | * it is called, socket has no references from outside -> sk_free | |
1052 | * may release descendant resources allocated by the socket, but | |
1053 | * to the time when it is called, socket is NOT referenced by any | |
1054 | * hash tables, lists etc. | |
1055 | * * Packets, delivered from outside (from network or from another process) | |
1056 | * and enqueued on receive/error queues SHOULD NOT grab reference count, | |
1057 | * when they sit in queue. Otherwise, packets will leak to hole, when | |
1058 | * socket is looked up by one cpu and unhasing is made by another CPU. | |
1059 | * It is true for udp/raw, netlink (leak to receive and error queues), tcp | |
1060 | * (leak to backlog). Packet socket does all the processing inside | |
1061 | * BR_NETPROTO_LOCK, so that it has not this race condition. UNIX sockets | |
1062 | * use separate SMP lock, so that they are prone too. | |
1063 | */ | |
1064 | ||
1065 | /* Ungrab socket and destroy it, if it was the last reference. */ | |
1066 | static inline void sock_put(struct sock *sk) | |
1067 | { | |
1068 | if (atomic_dec_and_test(&sk->sk_refcnt)) | |
1069 | sk_free(sk); | |
1070 | } | |
1071 | ||
58a5a7b9 ACM |
1072 | extern int sk_receive_skb(struct sock *sk, struct sk_buff *skb, |
1073 | const int nested); | |
25995ff5 | 1074 | |
972692e0 DM |
1075 | static inline void sk_set_socket(struct sock *sk, struct socket *sock) |
1076 | { | |
1077 | sk->sk_socket = sock; | |
1078 | } | |
1079 | ||
1da177e4 LT |
1080 | /* Detach socket from process context. |
1081 | * Announce socket dead, detach it from wait queue and inode. | |
1082 | * Note that parent inode held reference count on this struct sock, | |
1083 | * we do not release it in this function, because protocol | |
1084 | * probably wants some additional cleanups or even continuing | |
1085 | * to work with this socket (TCP). | |
1086 | */ | |
1087 | static inline void sock_orphan(struct sock *sk) | |
1088 | { | |
1089 | write_lock_bh(&sk->sk_callback_lock); | |
1090 | sock_set_flag(sk, SOCK_DEAD); | |
972692e0 | 1091 | sk_set_socket(sk, NULL); |
1da177e4 LT |
1092 | sk->sk_sleep = NULL; |
1093 | write_unlock_bh(&sk->sk_callback_lock); | |
1094 | } | |
1095 | ||
1096 | static inline void sock_graft(struct sock *sk, struct socket *parent) | |
1097 | { | |
1098 | write_lock_bh(&sk->sk_callback_lock); | |
1099 | sk->sk_sleep = &parent->wait; | |
1100 | parent->sk = sk; | |
972692e0 | 1101 | sk_set_socket(sk, parent); |
4237c75c | 1102 | security_sock_graft(sk, parent); |
1da177e4 LT |
1103 | write_unlock_bh(&sk->sk_callback_lock); |
1104 | } | |
1105 | ||
1106 | extern int sock_i_uid(struct sock *sk); | |
1107 | extern unsigned long sock_i_ino(struct sock *sk); | |
1108 | ||
1109 | static inline struct dst_entry * | |
1110 | __sk_dst_get(struct sock *sk) | |
1111 | { | |
1112 | return sk->sk_dst_cache; | |
1113 | } | |
1114 | ||
1115 | static inline struct dst_entry * | |
1116 | sk_dst_get(struct sock *sk) | |
1117 | { | |
1118 | struct dst_entry *dst; | |
1119 | ||
1120 | read_lock(&sk->sk_dst_lock); | |
1121 | dst = sk->sk_dst_cache; | |
1122 | if (dst) | |
1123 | dst_hold(dst); | |
1124 | read_unlock(&sk->sk_dst_lock); | |
1125 | return dst; | |
1126 | } | |
1127 | ||
1128 | static inline void | |
1129 | __sk_dst_set(struct sock *sk, struct dst_entry *dst) | |
1130 | { | |
1131 | struct dst_entry *old_dst; | |
1132 | ||
1133 | old_dst = sk->sk_dst_cache; | |
1134 | sk->sk_dst_cache = dst; | |
1135 | dst_release(old_dst); | |
1136 | } | |
1137 | ||
1138 | static inline void | |
1139 | sk_dst_set(struct sock *sk, struct dst_entry *dst) | |
1140 | { | |
1141 | write_lock(&sk->sk_dst_lock); | |
1142 | __sk_dst_set(sk, dst); | |
1143 | write_unlock(&sk->sk_dst_lock); | |
1144 | } | |
1145 | ||
1146 | static inline void | |
1147 | __sk_dst_reset(struct sock *sk) | |
1148 | { | |
1149 | struct dst_entry *old_dst; | |
1150 | ||
1151 | old_dst = sk->sk_dst_cache; | |
1152 | sk->sk_dst_cache = NULL; | |
1153 | dst_release(old_dst); | |
1154 | } | |
1155 | ||
1156 | static inline void | |
1157 | sk_dst_reset(struct sock *sk) | |
1158 | { | |
1159 | write_lock(&sk->sk_dst_lock); | |
1160 | __sk_dst_reset(sk); | |
1161 | write_unlock(&sk->sk_dst_lock); | |
1162 | } | |
1163 | ||
f0088a50 | 1164 | extern struct dst_entry *__sk_dst_check(struct sock *sk, u32 cookie); |
1da177e4 | 1165 | |
f0088a50 | 1166 | extern struct dst_entry *sk_dst_check(struct sock *sk, u32 cookie); |
1da177e4 | 1167 | |
bcd76111 HX |
1168 | static inline int sk_can_gso(const struct sock *sk) |
1169 | { | |
1170 | return net_gso_ok(sk->sk_route_caps, sk->sk_gso_type); | |
1171 | } | |
1172 | ||
9958089a | 1173 | extern void sk_setup_caps(struct sock *sk, struct dst_entry *dst); |
6cbb0df7 | 1174 | |
1da177e4 LT |
1175 | static inline int skb_copy_to_page(struct sock *sk, char __user *from, |
1176 | struct sk_buff *skb, struct page *page, | |
1177 | int off, int copy) | |
1178 | { | |
1179 | if (skb->ip_summed == CHECKSUM_NONE) { | |
1180 | int err = 0; | |
5084205f | 1181 | __wsum csum = csum_and_copy_from_user(from, |
1da177e4 LT |
1182 | page_address(page) + off, |
1183 | copy, 0, &err); | |
1184 | if (err) | |
1185 | return err; | |
1186 | skb->csum = csum_block_add(skb->csum, csum, skb->len); | |
1187 | } else if (copy_from_user(page_address(page) + off, from, copy)) | |
1188 | return -EFAULT; | |
1189 | ||
1190 | skb->len += copy; | |
1191 | skb->data_len += copy; | |
1192 | skb->truesize += copy; | |
1193 | sk->sk_wmem_queued += copy; | |
3ab224be | 1194 | sk_mem_charge(sk, copy); |
1da177e4 LT |
1195 | return 0; |
1196 | } | |
1197 | ||
1198 | /* | |
1199 | * Queue a received datagram if it will fit. Stream and sequenced | |
1200 | * protocols can't normally use this as they need to fit buffers in | |
1201 | * and play with them. | |
1202 | * | |
1203 | * Inlined as it's very short and called for pretty much every | |
1204 | * packet ever received. | |
1205 | */ | |
1206 | ||
1207 | static inline void skb_set_owner_w(struct sk_buff *skb, struct sock *sk) | |
1208 | { | |
1209 | sock_hold(sk); | |
1210 | skb->sk = sk; | |
1211 | skb->destructor = sock_wfree; | |
1212 | atomic_add(skb->truesize, &sk->sk_wmem_alloc); | |
1213 | } | |
1214 | ||
1215 | static inline void skb_set_owner_r(struct sk_buff *skb, struct sock *sk) | |
1216 | { | |
1217 | skb->sk = sk; | |
1218 | skb->destructor = sock_rfree; | |
1219 | atomic_add(skb->truesize, &sk->sk_rmem_alloc); | |
3ab224be | 1220 | sk_mem_charge(sk, skb->truesize); |
1da177e4 LT |
1221 | } |
1222 | ||
1223 | extern void sk_reset_timer(struct sock *sk, struct timer_list* timer, | |
1224 | unsigned long expires); | |
1225 | ||
1226 | extern void sk_stop_timer(struct sock *sk, struct timer_list* timer); | |
1227 | ||
f0088a50 | 1228 | extern int sock_queue_rcv_skb(struct sock *sk, struct sk_buff *skb); |
1da177e4 LT |
1229 | |
1230 | static inline int sock_queue_err_skb(struct sock *sk, struct sk_buff *skb) | |
1231 | { | |
1232 | /* Cast skb->rcvbuf to unsigned... It's pointless, but reduces | |
1233 | number of warnings when compiling with -W --ANK | |
1234 | */ | |
1235 | if (atomic_read(&sk->sk_rmem_alloc) + skb->truesize >= | |
1236 | (unsigned)sk->sk_rcvbuf) | |
1237 | return -ENOMEM; | |
1238 | skb_set_owner_r(skb, sk); | |
1239 | skb_queue_tail(&sk->sk_error_queue, skb); | |
1240 | if (!sock_flag(sk, SOCK_DEAD)) | |
1241 | sk->sk_data_ready(sk, skb->len); | |
1242 | return 0; | |
1243 | } | |
1244 | ||
1245 | /* | |
1246 | * Recover an error report and clear atomically | |
1247 | */ | |
1248 | ||
1249 | static inline int sock_error(struct sock *sk) | |
1250 | { | |
c1cbe4b7 BL |
1251 | int err; |
1252 | if (likely(!sk->sk_err)) | |
1253 | return 0; | |
1254 | err = xchg(&sk->sk_err, 0); | |
1da177e4 LT |
1255 | return -err; |
1256 | } | |
1257 | ||
1258 | static inline unsigned long sock_wspace(struct sock *sk) | |
1259 | { | |
1260 | int amt = 0; | |
1261 | ||
1262 | if (!(sk->sk_shutdown & SEND_SHUTDOWN)) { | |
1263 | amt = sk->sk_sndbuf - atomic_read(&sk->sk_wmem_alloc); | |
1264 | if (amt < 0) | |
1265 | amt = 0; | |
1266 | } | |
1267 | return amt; | |
1268 | } | |
1269 | ||
1270 | static inline void sk_wake_async(struct sock *sk, int how, int band) | |
1271 | { | |
1272 | if (sk->sk_socket && sk->sk_socket->fasync_list) | |
1273 | sock_wake_async(sk->sk_socket, how, band); | |
1274 | } | |
1275 | ||
1276 | #define SOCK_MIN_SNDBUF 2048 | |
1277 | #define SOCK_MIN_RCVBUF 256 | |
1278 | ||
1279 | static inline void sk_stream_moderate_sndbuf(struct sock *sk) | |
1280 | { | |
1281 | if (!(sk->sk_userlocks & SOCK_SNDBUF_LOCK)) { | |
8df09ea3 | 1282 | sk->sk_sndbuf = min(sk->sk_sndbuf, sk->sk_wmem_queued >> 1); |
1da177e4 LT |
1283 | sk->sk_sndbuf = max(sk->sk_sndbuf, SOCK_MIN_SNDBUF); |
1284 | } | |
1285 | } | |
1286 | ||
df97c708 | 1287 | struct sk_buff *sk_stream_alloc_skb(struct sock *sk, int size, gfp_t gfp); |
1da177e4 LT |
1288 | |
1289 | static inline struct page *sk_stream_alloc_page(struct sock *sk) | |
1290 | { | |
1291 | struct page *page = NULL; | |
1292 | ||
ef015786 HX |
1293 | page = alloc_pages(sk->sk_allocation, 0); |
1294 | if (!page) { | |
5c52ba17 | 1295 | sk->sk_prot->enter_memory_pressure(sk); |
1da177e4 LT |
1296 | sk_stream_moderate_sndbuf(sk); |
1297 | } | |
1298 | return page; | |
1299 | } | |
1300 | ||
1da177e4 LT |
1301 | /* |
1302 | * Default write policy as shown to user space via poll/select/SIGIO | |
1303 | */ | |
1304 | static inline int sock_writeable(const struct sock *sk) | |
1305 | { | |
8df09ea3 | 1306 | return atomic_read(&sk->sk_wmem_alloc) < (sk->sk_sndbuf >> 1); |
1da177e4 LT |
1307 | } |
1308 | ||
dd0fc66f | 1309 | static inline gfp_t gfp_any(void) |
1da177e4 | 1310 | { |
4498121c | 1311 | return in_atomic() ? GFP_ATOMIC : GFP_KERNEL; |
1da177e4 LT |
1312 | } |
1313 | ||
1314 | static inline long sock_rcvtimeo(const struct sock *sk, int noblock) | |
1315 | { | |
1316 | return noblock ? 0 : sk->sk_rcvtimeo; | |
1317 | } | |
1318 | ||
1319 | static inline long sock_sndtimeo(const struct sock *sk, int noblock) | |
1320 | { | |
1321 | return noblock ? 0 : sk->sk_sndtimeo; | |
1322 | } | |
1323 | ||
1324 | static inline int sock_rcvlowat(const struct sock *sk, int waitall, int len) | |
1325 | { | |
1326 | return (waitall ? len : min_t(int, sk->sk_rcvlowat, len)) ? : 1; | |
1327 | } | |
1328 | ||
1329 | /* Alas, with timeout socket operations are not restartable. | |
1330 | * Compare this to poll(). | |
1331 | */ | |
1332 | static inline int sock_intr_errno(long timeo) | |
1333 | { | |
1334 | return timeo == MAX_SCHEDULE_TIMEOUT ? -ERESTARTSYS : -EINTR; | |
1335 | } | |
1336 | ||
92f37fd2 ED |
1337 | extern void __sock_recv_timestamp(struct msghdr *msg, struct sock *sk, |
1338 | struct sk_buff *skb); | |
1339 | ||
1da177e4 LT |
1340 | static __inline__ void |
1341 | sock_recv_timestamp(struct msghdr *msg, struct sock *sk, struct sk_buff *skb) | |
1342 | { | |
b7aa0bf7 | 1343 | ktime_t kt = skb->tstamp; |
a61bbcf2 | 1344 | |
92f37fd2 ED |
1345 | if (sock_flag(sk, SOCK_RCVTSTAMP)) |
1346 | __sock_recv_timestamp(msg, sk, skb); | |
1347 | else | |
b7aa0bf7 | 1348 | sk->sk_stamp = kt; |
1da177e4 LT |
1349 | } |
1350 | ||
1351 | /** | |
1352 | * sk_eat_skb - Release a skb if it is no longer needed | |
4dc3b16b PP |
1353 | * @sk: socket to eat this skb from |
1354 | * @skb: socket buffer to eat | |
f4b8ea78 | 1355 | * @copied_early: flag indicating whether DMA operations copied this data early |
1da177e4 LT |
1356 | * |
1357 | * This routine must be called with interrupts disabled or with the socket | |
1358 | * locked so that the sk_buff queue operation is ok. | |
1359 | */ | |
624d1164 CL |
1360 | #ifdef CONFIG_NET_DMA |
1361 | static inline void sk_eat_skb(struct sock *sk, struct sk_buff *skb, int copied_early) | |
1362 | { | |
1363 | __skb_unlink(skb, &sk->sk_receive_queue); | |
1364 | if (!copied_early) | |
1365 | __kfree_skb(skb); | |
1366 | else | |
1367 | __skb_queue_tail(&sk->sk_async_wait_queue, skb); | |
1368 | } | |
1369 | #else | |
1370 | static inline void sk_eat_skb(struct sock *sk, struct sk_buff *skb, int copied_early) | |
1da177e4 LT |
1371 | { |
1372 | __skb_unlink(skb, &sk->sk_receive_queue); | |
1373 | __kfree_skb(skb); | |
1374 | } | |
624d1164 | 1375 | #endif |
1da177e4 | 1376 | |
3b1e0a65 YH |
1377 | static inline |
1378 | struct net *sock_net(const struct sock *sk) | |
1379 | { | |
1380 | #ifdef CONFIG_NET_NS | |
1381 | return sk->sk_net; | |
1382 | #else | |
1383 | return &init_net; | |
1384 | #endif | |
1385 | } | |
1386 | ||
1387 | static inline | |
f5aa23fd | 1388 | void sock_net_set(struct sock *sk, struct net *net) |
3b1e0a65 YH |
1389 | { |
1390 | #ifdef CONFIG_NET_NS | |
1391 | sk->sk_net = net; | |
1392 | #endif | |
1393 | } | |
1394 | ||
edf02087 DL |
1395 | /* |
1396 | * Kernel sockets, f.e. rtnl or icmp_socket, are a part of a namespace. | |
1397 | * They should not hold a referrence to a namespace in order to allow | |
1398 | * to stop it. | |
1399 | * Sockets after sk_change_net should be released using sk_release_kernel | |
1400 | */ | |
1401 | static inline void sk_change_net(struct sock *sk, struct net *net) | |
1402 | { | |
3b1e0a65 | 1403 | put_net(sock_net(sk)); |
65a18ec5 | 1404 | sock_net_set(sk, hold_net(net)); |
edf02087 DL |
1405 | } |
1406 | ||
23542618 KK |
1407 | static inline struct sock *skb_steal_sock(struct sk_buff *skb) |
1408 | { | |
1409 | if (unlikely(skb->sk)) { | |
1410 | struct sock *sk = skb->sk; | |
1411 | ||
1412 | skb->destructor = NULL; | |
1413 | skb->sk = NULL; | |
1414 | return sk; | |
1415 | } | |
1416 | return NULL; | |
1417 | } | |
1418 | ||
1da177e4 LT |
1419 | extern void sock_enable_timestamp(struct sock *sk); |
1420 | extern int sock_get_timestamp(struct sock *, struct timeval __user *); | |
ae40eb1e | 1421 | extern int sock_get_timestampns(struct sock *, struct timespec __user *); |
1da177e4 LT |
1422 | |
1423 | /* | |
1424 | * Enable debug/info messages | |
1425 | */ | |
a2a316fd SH |
1426 | extern int net_msg_warn; |
1427 | #define NETDEBUG(fmt, args...) \ | |
1428 | do { if (net_msg_warn) printk(fmt,##args); } while (0) | |
1da177e4 | 1429 | |
a2a316fd SH |
1430 | #define LIMIT_NETDEBUG(fmt, args...) \ |
1431 | do { if (net_msg_warn && net_ratelimit()) printk(fmt,##args); } while(0) | |
1da177e4 | 1432 | |
1da177e4 LT |
1433 | extern __u32 sysctl_wmem_max; |
1434 | extern __u32 sysctl_rmem_max; | |
1435 | ||
20380731 ACM |
1436 | extern void sk_init(void); |
1437 | ||
6baf1f41 DM |
1438 | extern int sysctl_optmem_max; |
1439 | ||
20380731 ACM |
1440 | extern __u32 sysctl_wmem_default; |
1441 | extern __u32 sysctl_rmem_default; | |
20380731 | 1442 | |
1da177e4 | 1443 | #endif /* _SOCK_H */ |