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