blob: 4c69ac165e6baad080e659b4cbf91f81e80bdcab [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001/*
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 *
Jesper Juhl02c30a82005-05-05 16:16:16 -070010 * Authors: Ross Biro
Linus Torvalds1da177e2005-04-16 15:20:36 -070011 * 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
Alexey Dobriyana6b7a402011-06-06 10:43:46 +000043#include <linux/hardirq.h>
Ilpo Järvinen172589c2007-08-28 15:50:33 -070044#include <linux/kernel.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070045#include <linux/list.h>
Eric Dumazet88ab1932008-11-16 19:39:21 -080046#include <linux/list_nulls.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070047#include <linux/timer.h>
48#include <linux/cache.h>
Ingo Molnara5b5bb92006-07-03 00:25:35 -070049#include <linux/lockdep.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070050#include <linux/netdevice.h>
51#include <linux/skbuff.h> /* struct sk_buff */
Al Virod7fe0f22006-12-03 23:15:30 -050052#include <linux/mm.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070053#include <linux/security.h>
Tejun Heo5a0e3ad2010-03-24 17:04:11 +090054#include <linux/slab.h>
Tom Herbertc6e1a0d2011-04-04 22:30:30 -070055#include <linux/uaccess.h>
Glauber Costa180d8cd2011-12-11 21:47:02 +000056#include <linux/memcontrol.h>
Glauber Costae1aab162011-12-11 21:47:03 +000057#include <linux/res_counter.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070058
59#include <linux/filter.h>
Eric Dumazet88ab1932008-11-16 19:39:21 -080060#include <linux/rculist_nulls.h>
Jiri Olsaa57de0b2009-07-08 12:09:13 +000061#include <linux/poll.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070062
Eric Dumazetc31504d2010-11-15 19:58:26 +000063#include <linux/atomic.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070064#include <net/dst.h>
65#include <net/checksum.h>
66
Eric Dumazet9f048bf2011-12-13 03:59:08 +000067struct cgroup;
68struct cgroup_subsys;
Glauber Costac607b2e2011-12-16 00:52:00 +000069#ifdef CONFIG_NET
Glauber Costad1a4c0b2011-12-11 21:47:04 +000070int mem_cgroup_sockets_init(struct cgroup *cgrp, struct cgroup_subsys *ss);
71void mem_cgroup_sockets_destroy(struct cgroup *cgrp, struct cgroup_subsys *ss);
Glauber Costac607b2e2011-12-16 00:52:00 +000072#else
73static inline
74int mem_cgroup_sockets_init(struct cgroup *cgrp, struct cgroup_subsys *ss)
75{
76 return 0;
77}
78static inline
79void mem_cgroup_sockets_destroy(struct cgroup *cgrp, struct cgroup_subsys *ss)
80{
81}
82#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -070083/*
84 * This structure really needs to be cleaned up.
85 * Most of it is for TCP, and not used by any of
86 * the other protocols.
87 */
88
89/* Define this to get the SOCK_DBG debugging facility. */
90#define SOCK_DEBUGGING
91#ifdef SOCK_DEBUGGING
92#define SOCK_DEBUG(sk, msg...) do { if ((sk) && sock_flag((sk), SOCK_DBG)) \
93 printk(KERN_DEBUG msg); } while (0)
94#else
Stephen Hemminger4cd90292008-03-21 15:54:53 -070095/* Validate arguments and do nothing */
Joe Perchesb9075fa2011-10-31 17:11:33 -070096static inline __printf(2, 3)
97void SOCK_DEBUG(struct sock *sk, const char *msg, ...)
Stephen Hemminger4cd90292008-03-21 15:54:53 -070098{
99}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700100#endif
101
102/* This is the per-socket lock. The spinlock provides a synchronization
103 * between user contexts and software interrupt processing, whereas the
104 * mini-semaphore synchronizes multiple users amongst themselves.
105 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700106typedef struct {
107 spinlock_t slock;
John Heffnerd2e91172007-09-12 10:44:19 +0200108 int owned;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700109 wait_queue_head_t wq;
Ingo Molnara5b5bb92006-07-03 00:25:35 -0700110 /*
111 * We express the mutex-alike socket_lock semantics
112 * to the lock validator by explicitly managing
113 * the slock as a lock variant (in addition to
114 * the slock itself):
115 */
116#ifdef CONFIG_DEBUG_LOCK_ALLOC
117 struct lockdep_map dep_map;
118#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -0700119} socket_lock_t;
120
Linus Torvalds1da177e2005-04-16 15:20:36 -0700121struct sock;
Arnaldo Carvalho de Melo8feaf0c02005-08-09 20:09:30 -0700122struct proto;
Denis V. Lunev0eeb8ff2007-12-04 01:15:45 -0800123struct net;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700124
125/**
Pavel Pisa4dc3b162005-05-01 08:59:25 -0700126 * struct sock_common - minimal network layer representation of sockets
Eric Dumazet68835ab2010-11-30 19:04:07 +0000127 * @skc_daddr: Foreign IPv4 addr
128 * @skc_rcv_saddr: Bound local IPv4 addr
Eric Dumazet4dc6dc72009-07-15 23:13:10 +0000129 * @skc_hash: hash value used with various protocol lookup tables
Eric Dumazetd4cada42009-11-08 10:17:30 +0000130 * @skc_u16hashes: two u16 hash values used by UDP lookup tables
Pavel Pisa4dc3b162005-05-01 08:59:25 -0700131 * @skc_family: network address family
132 * @skc_state: Connection state
133 * @skc_reuse: %SO_REUSEADDR setting
134 * @skc_bound_dev_if: bound device index if != 0
Pavel Pisa4dc3b162005-05-01 08:59:25 -0700135 * @skc_bind_node: bind hash linkage for various protocol lookup tables
Eric Dumazet512615b2009-11-08 10:17:58 +0000136 * @skc_portaddr_node: second hash linkage for UDP/UDP-Lite protocol
Arnaldo Carvalho de Melo8feaf0c02005-08-09 20:09:30 -0700137 * @skc_prot: protocol handlers inside a network family
Eric W. Biederman07feaeb2007-09-12 11:58:02 +0200138 * @skc_net: reference to the network namespace of this socket
Eric Dumazet68835ab2010-11-30 19:04:07 +0000139 * @skc_node: main hash linkage for various protocol lookup tables
140 * @skc_nulls_node: main hash linkage for TCP/UDP/UDP-Lite protocol
141 * @skc_tx_queue_mapping: tx queue number for this connection
142 * @skc_refcnt: reference count
Pavel Pisa4dc3b162005-05-01 08:59:25 -0700143 *
144 * This is the minimal network layer representation of sockets, the header
Arnaldo Carvalho de Melo8feaf0c02005-08-09 20:09:30 -0700145 * for struct sock and struct inet_timewait_sock.
146 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700147struct sock_common {
Eric Dumazet68835ab2010-11-30 19:04:07 +0000148 /* skc_daddr and skc_rcv_saddr must be grouped :
149 * cf INET_MATCH() and INET_TW_MATCH()
Eric Dumazet4dc6dc72009-07-15 23:13:10 +0000150 */
Eric Dumazet68835ab2010-11-30 19:04:07 +0000151 __be32 skc_daddr;
152 __be32 skc_rcv_saddr;
Eric Dumazet4dc6dc72009-07-15 23:13:10 +0000153
Eric Dumazetd4cada42009-11-08 10:17:30 +0000154 union {
155 unsigned int skc_hash;
156 __u16 skc_u16hashes[2];
157 };
Eric Dumazet4dc6dc72009-07-15 23:13:10 +0000158 unsigned short skc_family;
159 volatile unsigned char skc_state;
160 unsigned char skc_reuse;
161 int skc_bound_dev_if;
Eric Dumazet512615b2009-11-08 10:17:58 +0000162 union {
163 struct hlist_node skc_bind_node;
164 struct hlist_nulls_node skc_portaddr_node;
165 };
Arnaldo Carvalho de Melo8feaf0c02005-08-09 20:09:30 -0700166 struct proto *skc_prot;
YOSHIFUJI Hideaki3b1e0a62008-03-26 02:26:21 +0900167#ifdef CONFIG_NET_NS
Eric W. Biederman07feaeb2007-09-12 11:58:02 +0200168 struct net *skc_net;
YOSHIFUJI Hideaki3b1e0a62008-03-26 02:26:21 +0900169#endif
Eric Dumazet68835ab2010-11-30 19:04:07 +0000170 /*
171 * fields between dontcopy_begin/dontcopy_end
172 * are not copied in sock_copy()
173 */
Randy Dunlap928c41e2011-01-08 17:39:21 +0000174 /* private: */
Eric Dumazet68835ab2010-11-30 19:04:07 +0000175 int skc_dontcopy_begin[0];
Randy Dunlap928c41e2011-01-08 17:39:21 +0000176 /* public: */
Eric Dumazet68835ab2010-11-30 19:04:07 +0000177 union {
178 struct hlist_node skc_node;
179 struct hlist_nulls_node skc_nulls_node;
180 };
181 int skc_tx_queue_mapping;
182 atomic_t skc_refcnt;
Randy Dunlap928c41e2011-01-08 17:39:21 +0000183 /* private: */
Eric Dumazet68835ab2010-11-30 19:04:07 +0000184 int skc_dontcopy_end[0];
Randy Dunlap928c41e2011-01-08 17:39:21 +0000185 /* public: */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700186};
187
Glauber Costae1aab162011-12-11 21:47:03 +0000188struct cg_proto;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700189/**
190 * struct sock - network layer representation of sockets
Arnaldo Carvalho de Melo8feaf0c02005-08-09 20:09:30 -0700191 * @__sk_common: shared layout with inet_timewait_sock
Pavel Pisa4dc3b162005-05-01 08:59:25 -0700192 * @sk_shutdown: mask of %SEND_SHUTDOWN and/or %RCV_SHUTDOWN
193 * @sk_userlocks: %SO_SNDBUF and %SO_RCVBUF settings
194 * @sk_lock: synchronizer
195 * @sk_rcvbuf: size of receive buffer in bytes
Eric Dumazet43815482010-04-29 11:01:49 +0000196 * @sk_wq: sock wait queue and async head
Pavel Pisa4dc3b162005-05-01 08:59:25 -0700197 * @sk_dst_cache: destination cache
198 * @sk_dst_lock: destination cache lock
199 * @sk_policy: flow policy
Pavel Pisa4dc3b162005-05-01 08:59:25 -0700200 * @sk_receive_queue: incoming packets
201 * @sk_wmem_alloc: transmit queue bytes committed
202 * @sk_write_queue: Packet sending queue
Chris Leech97fc2f02006-05-23 17:55:33 -0700203 * @sk_async_wait_queue: DMA copied packets
Pavel Pisa4dc3b162005-05-01 08:59:25 -0700204 * @sk_omem_alloc: "o" is "option" or "other"
205 * @sk_wmem_queued: persistent queue size
206 * @sk_forward_alloc: space allocated forward
207 * @sk_allocation: allocation mode
208 * @sk_sndbuf: size of send buffer in bytes
Wang Chen33c732c2007-11-13 20:30:01 -0800209 * @sk_flags: %SO_LINGER (l_onoff), %SO_BROADCAST, %SO_KEEPALIVE,
Patrick Ohly20d49472009-02-12 05:03:38 +0000210 * %SO_OOBINLINE settings, %SO_TIMESTAMPING settings
Pavel Pisa4dc3b162005-05-01 08:59:25 -0700211 * @sk_no_check: %SO_NO_CHECK setting, wether or not checkup packets
212 * @sk_route_caps: route capabilities (e.g. %NETIF_F_TSO)
Eric Dumazeta4654192010-05-16 00:36:33 -0700213 * @sk_route_nocaps: forbidden route capabilities (e.g NETIF_F_GSO_MASK)
Herbert Xubcd76112006-06-30 13:36:35 -0700214 * @sk_gso_type: GSO type (e.g. %SKB_GSO_TCPV4)
Peter P Waskiewicz Jr82cc1a72008-03-21 03:43:19 -0700215 * @sk_gso_max_size: Maximum GSO segment size to build
Pavel Pisa4dc3b162005-05-01 08:59:25 -0700216 * @sk_lingertime: %SO_LINGER l_linger setting
Pavel Pisa4dc3b162005-05-01 08:59:25 -0700217 * @sk_backlog: always used with the per-socket spinlock held
218 * @sk_callback_lock: used with the callbacks in the end of this struct
219 * @sk_error_queue: rarely used
Wang Chen33c732c2007-11-13 20:30:01 -0800220 * @sk_prot_creator: sk_prot of original sock creator (see ipv6_setsockopt,
221 * IPV6_ADDRFORM for instance)
Pavel Pisa4dc3b162005-05-01 08:59:25 -0700222 * @sk_err: last error
Wang Chen33c732c2007-11-13 20:30:01 -0800223 * @sk_err_soft: errors that don't cause failure but are the cause of a
224 * persistent failure not just 'timed out'
Eric Dumazetcb61cb92008-06-17 21:04:56 -0700225 * @sk_drops: raw/udp drops counter
Pavel Pisa4dc3b162005-05-01 08:59:25 -0700226 * @sk_ack_backlog: current listen backlog
227 * @sk_max_ack_backlog: listen backlog set in listen()
228 * @sk_priority: %SO_PRIORITY setting
Randy Dunlap1a3bc362012-01-21 09:03:10 +0000229 * @sk_cgrp_prioidx: socket group's priority map index
Pavel Pisa4dc3b162005-05-01 08:59:25 -0700230 * @sk_type: socket type (%SOCK_STREAM, etc)
231 * @sk_protocol: which protocol this socket belongs in this network family
Randy Dunlap53c3fa22010-08-09 13:41:07 +0000232 * @sk_peer_pid: &struct pid for this socket's peer
233 * @sk_peer_cred: %SO_PEERCRED setting
Pavel Pisa4dc3b162005-05-01 08:59:25 -0700234 * @sk_rcvlowat: %SO_RCVLOWAT setting
235 * @sk_rcvtimeo: %SO_RCVTIMEO setting
236 * @sk_sndtimeo: %SO_SNDTIMEO setting
David S. Millerc58dc012010-04-27 15:05:31 -0700237 * @sk_rxhash: flow hash received from netif layer
Pavel Pisa4dc3b162005-05-01 08:59:25 -0700238 * @sk_filter: socket filtering instructions
239 * @sk_protinfo: private area, net family specific, when not using slab
240 * @sk_timer: sock cleanup timer
241 * @sk_stamp: time stamp of last packet received
242 * @sk_socket: Identd and reporting IO signals
243 * @sk_user_data: RPC layer private data
244 * @sk_sndmsg_page: cached page for sendmsg
245 * @sk_sndmsg_off: cached offset for sendmsg
246 * @sk_send_head: front of stuff to transmit
Martin Waitz67be2dd2005-05-01 08:59:26 -0700247 * @sk_security: used by security modules
Randy Dunlap31729362008-02-18 20:52:13 -0800248 * @sk_mark: generic packet mark
Randy Dunlap53c3fa22010-08-09 13:41:07 +0000249 * @sk_classid: this socket's cgroup classid
Glauber Costae1aab162011-12-11 21:47:03 +0000250 * @sk_cgrp: this socket's cgroup-specific proto data
Pavel Pisa4dc3b162005-05-01 08:59:25 -0700251 * @sk_write_pending: a write to stream socket waits to start
252 * @sk_state_change: callback to indicate change in the state of the sock
253 * @sk_data_ready: callback to indicate there is data to be processed
254 * @sk_write_space: callback to indicate there is bf sending space available
255 * @sk_error_report: callback to indicate errors (e.g. %MSG_ERRQUEUE)
256 * @sk_backlog_rcv: callback to process the backlog
257 * @sk_destruct: called at sock freeing time, i.e. when all refcnt == 0
Linus Torvalds1da177e2005-04-16 15:20:36 -0700258 */
259struct sock {
260 /*
Arnaldo Carvalho de Melo8feaf0c02005-08-09 20:09:30 -0700261 * Now struct inet_timewait_sock also uses sock_common, so please just
Linus Torvalds1da177e2005-04-16 15:20:36 -0700262 * don't add nothing before this first member (__sk_common) --acme
263 */
264 struct sock_common __sk_common;
Eric Dumazet4dc6dc72009-07-15 23:13:10 +0000265#define sk_node __sk_common.skc_node
266#define sk_nulls_node __sk_common.skc_nulls_node
267#define sk_refcnt __sk_common.skc_refcnt
Krishna Kumare022f0b2009-10-19 23:46:20 +0000268#define sk_tx_queue_mapping __sk_common.skc_tx_queue_mapping
Eric Dumazet4dc6dc72009-07-15 23:13:10 +0000269
Eric Dumazet68835ab2010-11-30 19:04:07 +0000270#define sk_dontcopy_begin __sk_common.skc_dontcopy_begin
271#define sk_dontcopy_end __sk_common.skc_dontcopy_end
Eric Dumazet4dc6dc72009-07-15 23:13:10 +0000272#define sk_hash __sk_common.skc_hash
Linus Torvalds1da177e2005-04-16 15:20:36 -0700273#define sk_family __sk_common.skc_family
274#define sk_state __sk_common.skc_state
275#define sk_reuse __sk_common.skc_reuse
276#define sk_bound_dev_if __sk_common.skc_bound_dev_if
Linus Torvalds1da177e2005-04-16 15:20:36 -0700277#define sk_bind_node __sk_common.skc_bind_node
Arnaldo Carvalho de Melo8feaf0c02005-08-09 20:09:30 -0700278#define sk_prot __sk_common.skc_prot
Eric W. Biederman07feaeb2007-09-12 11:58:02 +0200279#define sk_net __sk_common.skc_net
Eric Dumazetb178bb32010-11-16 05:56:04 +0000280 socket_lock_t sk_lock;
281 struct sk_buff_head sk_receive_queue;
282 /*
283 * The backlog queue is special, it is always used with
284 * the per-socket spinlock held and requires low latency
285 * access. Therefore we special case it's implementation.
286 * Note : rmem_alloc is in this structure to fill a hole
287 * on 64bit arches, not because its logically part of
288 * backlog.
289 */
290 struct {
291 atomic_t rmem_alloc;
292 int len;
293 struct sk_buff *head;
294 struct sk_buff *tail;
295 } sk_backlog;
296#define sk_rmem_alloc sk_backlog.rmem_alloc
297 int sk_forward_alloc;
298#ifdef CONFIG_RPS
299 __u32 sk_rxhash;
300#endif
301 atomic_t sk_drops;
302 int sk_rcvbuf;
303
304 struct sk_filter __rcu *sk_filter;
Eric Dumazeteaefd112011-02-18 03:26:36 +0000305 struct socket_wq __rcu *sk_wq;
Eric Dumazetb178bb32010-11-16 05:56:04 +0000306
307#ifdef CONFIG_NET_DMA
308 struct sk_buff_head sk_async_wait_queue;
309#endif
310
311#ifdef CONFIG_XFRM
312 struct xfrm_policy *sk_policy[2];
313#endif
314 unsigned long sk_flags;
315 struct dst_entry *sk_dst_cache;
316 spinlock_t sk_dst_lock;
317 atomic_t sk_wmem_alloc;
318 atomic_t sk_omem_alloc;
319 int sk_sndbuf;
320 struct sk_buff_head sk_write_queue;
Vegard Nossuma98b65a2009-02-26 14:46:57 +0100321 kmemcheck_bitfield_begin(flags);
Eric Dumazet5fdb9972009-10-08 22:50:25 +0000322 unsigned int sk_shutdown : 2,
323 sk_no_check : 2,
324 sk_userlocks : 4,
325 sk_protocol : 8,
326 sk_type : 16;
Vegard Nossuma98b65a2009-02-26 14:46:57 +0100327 kmemcheck_bitfield_end(flags);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700328 int sk_wmem_queued;
Al Viro7d877f32005-10-21 03:20:43 -0400329 gfp_t sk_allocation;
Michał Mirosławc8f44af2011-11-15 15:29:55 +0000330 netdev_features_t sk_route_caps;
331 netdev_features_t sk_route_nocaps;
Herbert Xubcd76112006-06-30 13:36:35 -0700332 int sk_gso_type;
Peter P Waskiewicz Jr82cc1a72008-03-21 03:43:19 -0700333 unsigned int sk_gso_max_size;
David S. Miller9932cf92006-03-24 15:12:37 -0800334 int sk_rcvlowat;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700335 unsigned long sk_lingertime;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700336 struct sk_buff_head sk_error_queue;
Arnaldo Carvalho de Melo476e19c2005-05-05 13:35:15 -0700337 struct proto *sk_prot_creator;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700338 rwlock_t sk_callback_lock;
339 int sk_err,
340 sk_err_soft;
341 unsigned short sk_ack_backlog;
342 unsigned short sk_max_ack_backlog;
343 __u32 sk_priority;
Neil Horman5bc14212011-11-22 05:10:51 +0000344#ifdef CONFIG_CGROUPS
345 __u32 sk_cgrp_prioidx;
346#endif
Eric W. Biederman109f6e32010-06-13 03:30:14 +0000347 struct pid *sk_peer_pid;
348 const struct cred *sk_peer_cred;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700349 long sk_rcvtimeo;
350 long sk_sndtimeo;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700351 void *sk_protinfo;
352 struct timer_list sk_timer;
Eric Dumazetb7aa0bf2007-04-19 16:16:32 -0700353 ktime_t sk_stamp;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700354 struct socket *sk_socket;
355 void *sk_user_data;
356 struct page *sk_sndmsg_page;
357 struct sk_buff *sk_send_head;
358 __u32 sk_sndmsg_off;
359 int sk_write_pending;
Alexey Dobriyand5f64232008-11-04 14:45:58 -0800360#ifdef CONFIG_SECURITY
Linus Torvalds1da177e2005-04-16 15:20:36 -0700361 void *sk_security;
Alexey Dobriyand5f64232008-11-04 14:45:58 -0800362#endif
Laszlo Attila Toth4a19ec52008-01-30 19:08:16 -0800363 __u32 sk_mark;
Herbert Xuf8451722010-05-24 00:12:34 -0700364 u32 sk_classid;
Glauber Costae1aab162011-12-11 21:47:03 +0000365 struct cg_proto *sk_cgrp;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700366 void (*sk_state_change)(struct sock *sk);
367 void (*sk_data_ready)(struct sock *sk, int bytes);
368 void (*sk_write_space)(struct sock *sk);
369 void (*sk_error_report)(struct sock *sk);
370 int (*sk_backlog_rcv)(struct sock *sk,
371 struct sk_buff *skb);
372 void (*sk_destruct)(struct sock *sk);
373};
374
375/*
376 * Hashed lists helper routines
377 */
Li Zefanc4146642010-02-08 23:18:45 +0000378static inline struct sock *sk_entry(const struct hlist_node *node)
379{
380 return hlist_entry(node, struct sock, sk_node);
381}
382
Arnaldo Carvalho de Meloe48c4142005-08-09 20:09:46 -0700383static inline struct sock *__sk_head(const struct hlist_head *head)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700384{
385 return hlist_entry(head->first, struct sock, sk_node);
386}
387
Arnaldo Carvalho de Meloe48c4142005-08-09 20:09:46 -0700388static inline struct sock *sk_head(const struct hlist_head *head)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700389{
390 return hlist_empty(head) ? NULL : __sk_head(head);
391}
392
Eric Dumazet88ab1932008-11-16 19:39:21 -0800393static inline struct sock *__sk_nulls_head(const struct hlist_nulls_head *head)
394{
395 return hlist_nulls_entry(head->first, struct sock, sk_nulls_node);
396}
397
398static inline struct sock *sk_nulls_head(const struct hlist_nulls_head *head)
399{
400 return hlist_nulls_empty(head) ? NULL : __sk_nulls_head(head);
401}
402
Arnaldo Carvalho de Meloe48c4142005-08-09 20:09:46 -0700403static inline struct sock *sk_next(const struct sock *sk)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700404{
405 return sk->sk_node.next ?
406 hlist_entry(sk->sk_node.next, struct sock, sk_node) : NULL;
407}
408
Eric Dumazet88ab1932008-11-16 19:39:21 -0800409static inline struct sock *sk_nulls_next(const struct sock *sk)
410{
411 return (!is_a_nulls(sk->sk_nulls_node.next)) ?
412 hlist_nulls_entry(sk->sk_nulls_node.next,
413 struct sock, sk_nulls_node) :
414 NULL;
415}
416
Arnaldo Carvalho de Meloe48c4142005-08-09 20:09:46 -0700417static inline int sk_unhashed(const struct sock *sk)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700418{
419 return hlist_unhashed(&sk->sk_node);
420}
421
Arnaldo Carvalho de Meloe48c4142005-08-09 20:09:46 -0700422static inline int sk_hashed(const struct sock *sk)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700423{
Akinobu Mitada753be2006-04-28 15:21:23 -0700424 return !sk_unhashed(sk);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700425}
426
427static __inline__ void sk_node_init(struct hlist_node *node)
428{
429 node->pprev = NULL;
430}
431
Eric Dumazet88ab1932008-11-16 19:39:21 -0800432static __inline__ void sk_nulls_node_init(struct hlist_nulls_node *node)
433{
434 node->pprev = NULL;
435}
436
Linus Torvalds1da177e2005-04-16 15:20:36 -0700437static __inline__ void __sk_del_node(struct sock *sk)
438{
439 __hlist_del(&sk->sk_node);
440}
441
stephen hemminger808f5112010-02-22 07:57:18 +0000442/* NB: equivalent to hlist_del_init_rcu */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700443static __inline__ int __sk_del_node_init(struct sock *sk)
444{
445 if (sk_hashed(sk)) {
446 __sk_del_node(sk);
447 sk_node_init(&sk->sk_node);
448 return 1;
449 }
450 return 0;
451}
452
453/* Grab socket reference count. This operation is valid only
454 when sk is ALREADY grabbed f.e. it is found in hash table
455 or a list and the lookup is made under lock preventing hash table
456 modifications.
457 */
458
459static inline void sock_hold(struct sock *sk)
460{
461 atomic_inc(&sk->sk_refcnt);
462}
463
464/* Ungrab socket in the context, which assumes that socket refcnt
465 cannot hit zero, f.e. it is true in context of any socketcall.
466 */
467static inline void __sock_put(struct sock *sk)
468{
469 atomic_dec(&sk->sk_refcnt);
470}
471
472static __inline__ int sk_del_node_init(struct sock *sk)
473{
474 int rc = __sk_del_node_init(sk);
475
476 if (rc) {
477 /* paranoid for a while -acme */
478 WARN_ON(atomic_read(&sk->sk_refcnt) == 1);
479 __sock_put(sk);
480 }
481 return rc;
482}
stephen hemminger808f5112010-02-22 07:57:18 +0000483#define sk_del_node_init_rcu(sk) sk_del_node_init(sk)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700484
Eric Dumazet88ab1932008-11-16 19:39:21 -0800485static __inline__ int __sk_nulls_del_node_init_rcu(struct sock *sk)
Eric Dumazet271b72c2008-10-29 02:11:14 -0700486{
487 if (sk_hashed(sk)) {
Eric Dumazet88ab1932008-11-16 19:39:21 -0800488 hlist_nulls_del_init_rcu(&sk->sk_nulls_node);
Eric Dumazet271b72c2008-10-29 02:11:14 -0700489 return 1;
490 }
491 return 0;
492}
493
Eric Dumazet88ab1932008-11-16 19:39:21 -0800494static __inline__ int sk_nulls_del_node_init_rcu(struct sock *sk)
Eric Dumazet271b72c2008-10-29 02:11:14 -0700495{
Eric Dumazet88ab1932008-11-16 19:39:21 -0800496 int rc = __sk_nulls_del_node_init_rcu(sk);
Eric Dumazet271b72c2008-10-29 02:11:14 -0700497
498 if (rc) {
499 /* paranoid for a while -acme */
500 WARN_ON(atomic_read(&sk->sk_refcnt) == 1);
501 __sock_put(sk);
502 }
503 return rc;
504}
505
Linus Torvalds1da177e2005-04-16 15:20:36 -0700506static __inline__ void __sk_add_node(struct sock *sk, struct hlist_head *list)
507{
508 hlist_add_head(&sk->sk_node, list);
509}
510
511static __inline__ void sk_add_node(struct sock *sk, struct hlist_head *list)
512{
513 sock_hold(sk);
514 __sk_add_node(sk, list);
515}
516
stephen hemminger808f5112010-02-22 07:57:18 +0000517static __inline__ void sk_add_node_rcu(struct sock *sk, struct hlist_head *list)
518{
519 sock_hold(sk);
520 hlist_add_head_rcu(&sk->sk_node, list);
521}
522
Eric Dumazet88ab1932008-11-16 19:39:21 -0800523static __inline__ void __sk_nulls_add_node_rcu(struct sock *sk, struct hlist_nulls_head *list)
Eric Dumazet271b72c2008-10-29 02:11:14 -0700524{
Eric Dumazet88ab1932008-11-16 19:39:21 -0800525 hlist_nulls_add_head_rcu(&sk->sk_nulls_node, list);
Eric Dumazet271b72c2008-10-29 02:11:14 -0700526}
527
Eric Dumazet88ab1932008-11-16 19:39:21 -0800528static __inline__ void sk_nulls_add_node_rcu(struct sock *sk, struct hlist_nulls_head *list)
Eric Dumazet271b72c2008-10-29 02:11:14 -0700529{
530 sock_hold(sk);
Eric Dumazet88ab1932008-11-16 19:39:21 -0800531 __sk_nulls_add_node_rcu(sk, list);
Eric Dumazet271b72c2008-10-29 02:11:14 -0700532}
533
Linus Torvalds1da177e2005-04-16 15:20:36 -0700534static __inline__ void __sk_del_bind_node(struct sock *sk)
535{
536 __hlist_del(&sk->sk_bind_node);
537}
538
539static __inline__ void sk_add_bind_node(struct sock *sk,
540 struct hlist_head *list)
541{
542 hlist_add_head(&sk->sk_bind_node, list);
543}
544
545#define sk_for_each(__sk, node, list) \
546 hlist_for_each_entry(__sk, node, list, sk_node)
stephen hemminger808f5112010-02-22 07:57:18 +0000547#define sk_for_each_rcu(__sk, node, list) \
548 hlist_for_each_entry_rcu(__sk, node, list, sk_node)
Eric Dumazet88ab1932008-11-16 19:39:21 -0800549#define sk_nulls_for_each(__sk, node, list) \
550 hlist_nulls_for_each_entry(__sk, node, list, sk_nulls_node)
551#define sk_nulls_for_each_rcu(__sk, node, list) \
552 hlist_nulls_for_each_entry_rcu(__sk, node, list, sk_nulls_node)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700553#define sk_for_each_from(__sk, node) \
554 if (__sk && ({ node = &(__sk)->sk_node; 1; })) \
555 hlist_for_each_entry_from(__sk, node, sk_node)
Eric Dumazet88ab1932008-11-16 19:39:21 -0800556#define sk_nulls_for_each_from(__sk, node) \
557 if (__sk && ({ node = &(__sk)->sk_nulls_node; 1; })) \
558 hlist_nulls_for_each_entry_from(__sk, node, sk_nulls_node)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700559#define sk_for_each_safe(__sk, node, tmp, list) \
560 hlist_for_each_entry_safe(__sk, node, tmp, list, sk_node)
561#define sk_for_each_bound(__sk, node, list) \
562 hlist_for_each_entry(__sk, node, list, sk_bind_node)
563
564/* Sock flags */
565enum sock_flags {
566 SOCK_DEAD,
567 SOCK_DONE,
568 SOCK_URGINLINE,
569 SOCK_KEEPOPEN,
570 SOCK_LINGER,
571 SOCK_DESTROY,
572 SOCK_BROADCAST,
573 SOCK_TIMESTAMP,
574 SOCK_ZAPPED,
575 SOCK_USE_WRITE_QUEUE, /* whether to call sk->sk_write_space in sock_wfree */
576 SOCK_DBG, /* %SO_DEBUG setting */
577 SOCK_RCVTSTAMP, /* %SO_TIMESTAMP setting */
Eric Dumazet92f37fd2007-03-25 22:14:49 -0700578 SOCK_RCVTSTAMPNS, /* %SO_TIMESTAMPNS setting */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700579 SOCK_LOCALROUTE, /* route locally only, %SO_DONTROUTE setting */
580 SOCK_QUEUE_SHRUNK, /* write queue has been shrunk recently */
Patrick Ohly20d49472009-02-12 05:03:38 +0000581 SOCK_TIMESTAMPING_TX_HARDWARE, /* %SOF_TIMESTAMPING_TX_HARDWARE */
582 SOCK_TIMESTAMPING_TX_SOFTWARE, /* %SOF_TIMESTAMPING_TX_SOFTWARE */
583 SOCK_TIMESTAMPING_RX_HARDWARE, /* %SOF_TIMESTAMPING_RX_HARDWARE */
584 SOCK_TIMESTAMPING_RX_SOFTWARE, /* %SOF_TIMESTAMPING_RX_SOFTWARE */
585 SOCK_TIMESTAMPING_SOFTWARE, /* %SOF_TIMESTAMPING_SOFTWARE */
586 SOCK_TIMESTAMPING_RAW_HARDWARE, /* %SOF_TIMESTAMPING_RAW_HARDWARE */
587 SOCK_TIMESTAMPING_SYS_HARDWARE, /* %SOF_TIMESTAMPING_SYS_HARDWARE */
Eric Dumazetbcdce712009-10-06 17:28:29 -0700588 SOCK_FASYNC, /* fasync() active */
Neil Horman3b885782009-10-12 13:26:31 -0700589 SOCK_RXQ_OVFL,
Shirley Ma1cdebb42011-07-06 12:17:30 +0000590 SOCK_ZEROCOPY, /* buffers from userspace */
Johannes Berg6e3e9392011-11-09 10:15:42 +0100591 SOCK_WIFI_STATUS, /* push wifi status to userspace */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700592};
593
Ralf Baechle53b924b2005-08-23 10:11:30 -0700594static inline void sock_copy_flags(struct sock *nsk, struct sock *osk)
595{
596 nsk->sk_flags = osk->sk_flags;
597}
598
Linus Torvalds1da177e2005-04-16 15:20:36 -0700599static inline void sock_set_flag(struct sock *sk, enum sock_flags flag)
600{
601 __set_bit(flag, &sk->sk_flags);
602}
603
604static inline void sock_reset_flag(struct sock *sk, enum sock_flags flag)
605{
606 __clear_bit(flag, &sk->sk_flags);
607}
608
609static inline int sock_flag(struct sock *sk, enum sock_flags flag)
610{
611 return test_bit(flag, &sk->sk_flags);
612}
613
614static inline void sk_acceptq_removed(struct sock *sk)
615{
616 sk->sk_ack_backlog--;
617}
618
619static inline void sk_acceptq_added(struct sock *sk)
620{
621 sk->sk_ack_backlog++;
622}
623
624static inline int sk_acceptq_is_full(struct sock *sk)
625{
David S. Miller64a14652007-03-06 11:21:05 -0800626 return sk->sk_ack_backlog > sk->sk_max_ack_backlog;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700627}
628
629/*
630 * Compute minimal free write space needed to queue new packets.
631 */
632static inline int sk_stream_min_wspace(struct sock *sk)
633{
Eric Dumazet8df09ea2007-12-21 03:07:41 -0800634 return sk->sk_wmem_queued >> 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700635}
636
637static inline int sk_stream_wspace(struct sock *sk)
638{
639 return sk->sk_sndbuf - sk->sk_wmem_queued;
640}
641
642extern void sk_stream_write_space(struct sock *sk);
643
644static inline int sk_stream_memory_free(struct sock *sk)
645{
646 return sk->sk_wmem_queued < sk->sk_sndbuf;
647}
648
Zhu Yi8eae9392010-03-04 18:01:40 +0000649/* OOB backlog add */
Zhu Yia3a858f2010-03-04 18:01:47 +0000650static inline void __sk_add_backlog(struct sock *sk, struct sk_buff *skb)
Stephen Hemminger9ee6b532005-11-08 09:39:42 -0800651{
Eric Dumazet7fee2262010-05-11 23:19:48 +0000652 /* dont let skb dst not refcounted, we are going to leave rcu lock */
653 skb_dst_force(skb);
654
655 if (!sk->sk_backlog.tail)
656 sk->sk_backlog.head = skb;
657 else
Stephen Hemminger9ee6b532005-11-08 09:39:42 -0800658 sk->sk_backlog.tail->next = skb;
Eric Dumazet7fee2262010-05-11 23:19:48 +0000659
660 sk->sk_backlog.tail = skb;
Stephen Hemminger9ee6b532005-11-08 09:39:42 -0800661 skb->next = NULL;
662}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700663
Eric Dumazetc3774112010-04-27 15:13:20 -0700664/*
665 * Take into account size of receive queue and backlog queue
Eric Dumazet0fd7bac2011-12-21 07:11:44 +0000666 * Do not take into account this skb truesize,
667 * to allow even a single big packet to come.
Eric Dumazetc3774112010-04-27 15:13:20 -0700668 */
669static inline bool sk_rcvqueues_full(const struct sock *sk, const struct sk_buff *skb)
670{
671 unsigned int qsize = sk->sk_backlog.len + atomic_read(&sk->sk_rmem_alloc);
672
Eric Dumazet0fd7bac2011-12-21 07:11:44 +0000673 return qsize > sk->sk_rcvbuf;
Eric Dumazetc3774112010-04-27 15:13:20 -0700674}
675
Zhu Yi8eae9392010-03-04 18:01:40 +0000676/* The per-socket spinlock must be held here. */
Zhu Yi40456352010-03-07 16:21:39 +0000677static inline __must_check int sk_add_backlog(struct sock *sk, struct sk_buff *skb)
Zhu Yi8eae9392010-03-04 18:01:40 +0000678{
Eric Dumazetc3774112010-04-27 15:13:20 -0700679 if (sk_rcvqueues_full(sk, skb))
Zhu Yi8eae9392010-03-04 18:01:40 +0000680 return -ENOBUFS;
681
Zhu Yia3a858f2010-03-04 18:01:47 +0000682 __sk_add_backlog(sk, skb);
Zhu Yi8eae9392010-03-04 18:01:40 +0000683 sk->sk_backlog.len += skb->truesize;
684 return 0;
685}
686
Peter Zijlstrac57943a2008-10-07 14:18:42 -0700687static inline int sk_backlog_rcv(struct sock *sk, struct sk_buff *skb)
688{
689 return sk->sk_backlog_rcv(sk, skb);
690}
691
David S. Millerc58dc012010-04-27 15:05:31 -0700692static inline void sock_rps_record_flow(const struct sock *sk)
693{
694#ifdef CONFIG_RPS
695 struct rps_sock_flow_table *sock_flow_table;
696
697 rcu_read_lock();
698 sock_flow_table = rcu_dereference(rps_sock_flow_table);
699 rps_record_sock_flow(sock_flow_table, sk->sk_rxhash);
700 rcu_read_unlock();
701#endif
702}
703
704static inline void sock_rps_reset_flow(const struct sock *sk)
705{
706#ifdef CONFIG_RPS
707 struct rps_sock_flow_table *sock_flow_table;
708
709 rcu_read_lock();
710 sock_flow_table = rcu_dereference(rps_sock_flow_table);
711 rps_reset_sock_flow(sock_flow_table, sk->sk_rxhash);
712 rcu_read_unlock();
713#endif
714}
715
Tom Herbertbdeab992011-08-14 19:45:55 +0000716static inline void sock_rps_save_rxhash(struct sock *sk,
717 const struct sk_buff *skb)
David S. Millerc58dc012010-04-27 15:05:31 -0700718{
719#ifdef CONFIG_RPS
Tom Herbertbdeab992011-08-14 19:45:55 +0000720 if (unlikely(sk->sk_rxhash != skb->rxhash)) {
David S. Millerc58dc012010-04-27 15:05:31 -0700721 sock_rps_reset_flow(sk);
Tom Herbertbdeab992011-08-14 19:45:55 +0000722 sk->sk_rxhash = skb->rxhash;
David S. Millerc58dc012010-04-27 15:05:31 -0700723 }
724#endif
725}
726
Tom Herbertbdeab992011-08-14 19:45:55 +0000727static inline void sock_rps_reset_rxhash(struct sock *sk)
728{
729#ifdef CONFIG_RPS
730 sock_rps_reset_flow(sk);
731 sk->sk_rxhash = 0;
732#endif
733}
734
Stephen Hemmingercfcabdc2007-10-09 01:59:42 -0700735#define sk_wait_event(__sk, __timeo, __condition) \
736 ({ int __rc; \
737 release_sock(__sk); \
738 __rc = __condition; \
739 if (!__rc) { \
740 *(__timeo) = schedule_timeout(*(__timeo)); \
741 } \
742 lock_sock(__sk); \
743 __rc = __condition; \
744 __rc; \
745 })
Linus Torvalds1da177e2005-04-16 15:20:36 -0700746
747extern int sk_stream_wait_connect(struct sock *sk, long *timeo_p);
748extern int sk_stream_wait_memory(struct sock *sk, long *timeo_p);
749extern void sk_stream_wait_close(struct sock *sk, long timeo_p);
750extern int sk_stream_error(struct sock *sk, int flags, int err);
751extern void sk_stream_kill_queues(struct sock *sk);
752
753extern int sk_wait_data(struct sock *sk, long *timeo);
754
Arnaldo Carvalho de Melo60236fd2005-06-18 22:47:21 -0700755struct request_sock_ops;
Arnaldo Carvalho de Melo6d6ee432005-12-13 23:25:19 -0800756struct timewait_sock_ops;
Arnaldo Carvalho de Meloab1e0a12008-02-03 04:06:04 -0800757struct inet_hashinfo;
Pavel Emelyanovfc8717b2008-03-22 16:56:51 -0700758struct raw_hashinfo;
Paul Gortmakerde477252011-05-26 13:46:22 -0400759struct module;
Arnaldo Carvalho de Melo2e6599c2005-06-18 22:46:52 -0700760
Linus Torvalds1da177e2005-04-16 15:20:36 -0700761/* Networking protocol blocks we attach to sockets.
762 * socket layer -> transport layer interface
763 * transport -> network interface is defined by struct inet_proto
764 */
765struct proto {
766 void (*close)(struct sock *sk,
767 long timeout);
768 int (*connect)(struct sock *sk,
769 struct sockaddr *uaddr,
770 int addr_len);
771 int (*disconnect)(struct sock *sk, int flags);
772
773 struct sock * (*accept) (struct sock *sk, int flags, int *err);
774
775 int (*ioctl)(struct sock *sk, int cmd,
776 unsigned long arg);
777 int (*init)(struct sock *sk);
Brian Haley7d06b2e2008-06-14 17:04:49 -0700778 void (*destroy)(struct sock *sk);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700779 void (*shutdown)(struct sock *sk, int how);
780 int (*setsockopt)(struct sock *sk, int level,
781 int optname, char __user *optval,
David S. Millerb7058842009-09-30 16:12:20 -0700782 unsigned int optlen);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700783 int (*getsockopt)(struct sock *sk, int level,
784 int optname, char __user *optval,
785 int __user *option);
Alexey Dobriyanaf01d532008-08-28 02:53:51 -0700786#ifdef CONFIG_COMPAT
Dmitry Mishin3fdadf72006-03-20 22:45:21 -0800787 int (*compat_setsockopt)(struct sock *sk,
788 int level,
789 int optname, char __user *optval,
David S. Millerb7058842009-09-30 16:12:20 -0700790 unsigned int optlen);
Dmitry Mishin3fdadf72006-03-20 22:45:21 -0800791 int (*compat_getsockopt)(struct sock *sk,
792 int level,
793 int optname, char __user *optval,
794 int __user *option);
Eric W. Biederman709b46e2011-01-29 16:15:56 +0000795 int (*compat_ioctl)(struct sock *sk,
796 unsigned int cmd, unsigned long arg);
Alexey Dobriyanaf01d532008-08-28 02:53:51 -0700797#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -0700798 int (*sendmsg)(struct kiocb *iocb, struct sock *sk,
799 struct msghdr *msg, size_t len);
800 int (*recvmsg)(struct kiocb *iocb, struct sock *sk,
801 struct msghdr *msg,
802 size_t len, int noblock, int flags,
803 int *addr_len);
804 int (*sendpage)(struct sock *sk, struct page *page,
805 int offset, size_t size, int flags);
806 int (*bind)(struct sock *sk,
807 struct sockaddr *uaddr, int addr_len);
808
809 int (*backlog_rcv) (struct sock *sk,
810 struct sk_buff *skb);
811
812 /* Keeping track of sk's, looking them up, and port selection methods. */
813 void (*hash)(struct sock *sk);
814 void (*unhash)(struct sock *sk);
Eric Dumazet719f8352010-09-08 05:08:44 +0000815 void (*rehash)(struct sock *sk);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700816 int (*get_port)(struct sock *sk, unsigned short snum);
Octavian Purdilafcbdf092010-12-16 14:26:56 -0800817 void (*clear_sk)(struct sock *sk, int size);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700818
Eric Dumazet286ab3d2007-11-05 23:38:39 -0800819 /* Keeping track of sockets in use */
Eric Dumazet65f76512008-01-03 20:46:48 -0800820#ifdef CONFIG_PROC_FS
Pavel Emelyanov13ff3d62008-03-28 16:38:17 -0700821 unsigned int inuse_idx;
Eric Dumazet65f76512008-01-03 20:46:48 -0800822#endif
Arnaldo Carvalho de Meloebb53d72007-11-21 22:08:50 +0800823
Linus Torvalds1da177e2005-04-16 15:20:36 -0700824 /* Memory pressure */
Pavel Emelyanov5c52ba12008-07-16 20:28:10 -0700825 void (*enter_memory_pressure)(struct sock *sk);
Eric Dumazet8d987e52010-11-09 23:24:26 +0000826 atomic_long_t *memory_allocated; /* Current allocated memory. */
Eric Dumazet17483762008-11-25 21:16:35 -0800827 struct percpu_counter *sockets_allocated; /* Current number of sockets. */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700828 /*
829 * Pressure flag: try to collapse.
830 * Technical note: it is used by multiple contexts non atomically.
Hideo Aoki3ab224b2007-12-31 00:11:19 -0800831 * All the __sk_mem_schedule() is of this nature: accounting
Linus Torvalds1da177e2005-04-16 15:20:36 -0700832 * is strict, actions are advisory and have some latency.
833 */
834 int *memory_pressure;
Eric Dumazet8d987e52010-11-09 23:24:26 +0000835 long *sysctl_mem;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700836 int *sysctl_wmem;
837 int *sysctl_rmem;
838 int max_header;
Changli Gao7ba42912010-07-10 20:41:55 +0000839 bool no_autobind;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700840
Eric Dumazet271b72c2008-10-29 02:11:14 -0700841 struct kmem_cache *slab;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700842 unsigned int obj_size;
Eric Dumazet271b72c2008-10-29 02:11:14 -0700843 int slab_flags;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700844
Eric Dumazetdd24c002008-11-25 21:17:14 -0800845 struct percpu_counter *orphan_count;
Arnaldo Carvalho de Melo8feaf0c02005-08-09 20:09:30 -0700846
Arnaldo Carvalho de Melo60236fd2005-06-18 22:47:21 -0700847 struct request_sock_ops *rsk_prot;
Arnaldo Carvalho de Melo6d6ee432005-12-13 23:25:19 -0800848 struct timewait_sock_ops *twsk_prot;
Arnaldo Carvalho de Melo2e6599c2005-06-18 22:46:52 -0700849
Pavel Emelyanov39d8cda2008-03-22 16:50:58 -0700850 union {
851 struct inet_hashinfo *hashinfo;
Eric Dumazet645ca702008-10-29 01:41:45 -0700852 struct udp_table *udp_table;
Pavel Emelyanovfc8717b2008-03-22 16:56:51 -0700853 struct raw_hashinfo *raw_hash;
Pavel Emelyanov39d8cda2008-03-22 16:50:58 -0700854 } h;
Arnaldo Carvalho de Meloab1e0a12008-02-03 04:06:04 -0800855
Linus Torvalds1da177e2005-04-16 15:20:36 -0700856 struct module *owner;
857
858 char name[32];
859
860 struct list_head node;
Arnaldo Carvalho de Meloe6848972005-08-09 19:45:38 -0700861#ifdef SOCK_REFCNT_DEBUG
862 atomic_t socks;
863#endif
Glauber Costae1aab162011-12-11 21:47:03 +0000864#ifdef CONFIG_CGROUP_MEM_RES_CTLR_KMEM
865 /*
866 * cgroup specific init/deinit functions. Called once for all
867 * protocols that implement it, from cgroups populate function.
868 * This function has to setup any files the protocol want to
869 * appear in the kmem cgroup filesystem.
870 */
871 int (*init_cgroup)(struct cgroup *cgrp,
872 struct cgroup_subsys *ss);
873 void (*destroy_cgroup)(struct cgroup *cgrp,
874 struct cgroup_subsys *ss);
875 struct cg_proto *(*proto_cgroup)(struct mem_cgroup *memcg);
876#endif
877};
878
879struct cg_proto {
880 void (*enter_memory_pressure)(struct sock *sk);
881 struct res_counter *memory_allocated; /* Current allocated memory. */
882 struct percpu_counter *sockets_allocated; /* Current number of sockets. */
883 int *memory_pressure;
884 long *sysctl_mem;
885 /*
886 * memcg field is used to find which memcg we belong directly
887 * Each memcg struct can hold more than one cg_proto, so container_of
888 * won't really cut.
889 *
890 * The elegant solution would be having an inverse function to
891 * proto_cgroup in struct proto, but that means polluting the structure
892 * for everybody, instead of just for memcg users.
893 */
894 struct mem_cgroup *memcg;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700895};
896
897extern int proto_register(struct proto *prot, int alloc_slab);
898extern void proto_unregister(struct proto *prot);
899
Arnaldo Carvalho de Meloe6848972005-08-09 19:45:38 -0700900#ifdef SOCK_REFCNT_DEBUG
901static inline void sk_refcnt_debug_inc(struct sock *sk)
902{
903 atomic_inc(&sk->sk_prot->socks);
904}
905
906static inline void sk_refcnt_debug_dec(struct sock *sk)
907{
908 atomic_dec(&sk->sk_prot->socks);
909 printk(KERN_DEBUG "%s socket %p released, %d are still alive\n",
910 sk->sk_prot->name, sk, atomic_read(&sk->sk_prot->socks));
911}
912
Glauber Costae1aab162011-12-11 21:47:03 +0000913inline void sk_refcnt_debug_release(const struct sock *sk)
Arnaldo Carvalho de Meloe6848972005-08-09 19:45:38 -0700914{
915 if (atomic_read(&sk->sk_refcnt) != 1)
916 printk(KERN_DEBUG "Destruction of the %s socket %p delayed, refcnt=%d\n",
917 sk->sk_prot->name, sk, atomic_read(&sk->sk_refcnt));
918}
919#else /* SOCK_REFCNT_DEBUG */
920#define sk_refcnt_debug_inc(sk) do { } while (0)
921#define sk_refcnt_debug_dec(sk) do { } while (0)
922#define sk_refcnt_debug_release(sk) do { } while (0)
923#endif /* SOCK_REFCNT_DEBUG */
924
Glauber Costa376be5f2012-01-20 04:57:14 +0000925#if defined(CONFIG_CGROUP_MEM_RES_CTLR_KMEM) && defined(CONFIG_NET)
Glauber Costae1aab162011-12-11 21:47:03 +0000926extern struct jump_label_key memcg_socket_limit_enabled;
927static inline struct cg_proto *parent_cg_proto(struct proto *proto,
928 struct cg_proto *cg_proto)
929{
930 return proto->proto_cgroup(parent_mem_cgroup(cg_proto->memcg));
931}
932#define mem_cgroup_sockets_enabled static_branch(&memcg_socket_limit_enabled)
933#else
934#define mem_cgroup_sockets_enabled 0
935static inline struct cg_proto *parent_cg_proto(struct proto *proto,
936 struct cg_proto *cg_proto)
937{
938 return NULL;
939}
940#endif
941
942
Glauber Costa180d8cd2011-12-11 21:47:02 +0000943static inline bool sk_has_memory_pressure(const struct sock *sk)
944{
945 return sk->sk_prot->memory_pressure != NULL;
946}
947
948static inline bool sk_under_memory_pressure(const struct sock *sk)
949{
950 if (!sk->sk_prot->memory_pressure)
951 return false;
Glauber Costae1aab162011-12-11 21:47:03 +0000952
953 if (mem_cgroup_sockets_enabled && sk->sk_cgrp)
954 return !!*sk->sk_cgrp->memory_pressure;
955
Glauber Costa180d8cd2011-12-11 21:47:02 +0000956 return !!*sk->sk_prot->memory_pressure;
957}
958
959static inline void sk_leave_memory_pressure(struct sock *sk)
960{
961 int *memory_pressure = sk->sk_prot->memory_pressure;
962
Glauber Costae1aab162011-12-11 21:47:03 +0000963 if (!memory_pressure)
964 return;
965
966 if (*memory_pressure)
Glauber Costa180d8cd2011-12-11 21:47:02 +0000967 *memory_pressure = 0;
Glauber Costae1aab162011-12-11 21:47:03 +0000968
969 if (mem_cgroup_sockets_enabled && sk->sk_cgrp) {
970 struct cg_proto *cg_proto = sk->sk_cgrp;
971 struct proto *prot = sk->sk_prot;
972
973 for (; cg_proto; cg_proto = parent_cg_proto(prot, cg_proto))
974 if (*cg_proto->memory_pressure)
975 *cg_proto->memory_pressure = 0;
976 }
977
Glauber Costa180d8cd2011-12-11 21:47:02 +0000978}
979
980static inline void sk_enter_memory_pressure(struct sock *sk)
981{
Glauber Costae1aab162011-12-11 21:47:03 +0000982 if (!sk->sk_prot->enter_memory_pressure)
983 return;
984
985 if (mem_cgroup_sockets_enabled && sk->sk_cgrp) {
986 struct cg_proto *cg_proto = sk->sk_cgrp;
987 struct proto *prot = sk->sk_prot;
988
989 for (; cg_proto; cg_proto = parent_cg_proto(prot, cg_proto))
990 cg_proto->enter_memory_pressure(sk);
991 }
992
993 sk->sk_prot->enter_memory_pressure(sk);
Glauber Costa180d8cd2011-12-11 21:47:02 +0000994}
995
996static inline long sk_prot_mem_limits(const struct sock *sk, int index)
997{
998 long *prot = sk->sk_prot->sysctl_mem;
Glauber Costae1aab162011-12-11 21:47:03 +0000999 if (mem_cgroup_sockets_enabled && sk->sk_cgrp)
1000 prot = sk->sk_cgrp->sysctl_mem;
Glauber Costa180d8cd2011-12-11 21:47:02 +00001001 return prot[index];
1002}
1003
Glauber Costae1aab162011-12-11 21:47:03 +00001004static inline void memcg_memory_allocated_add(struct cg_proto *prot,
1005 unsigned long amt,
1006 int *parent_status)
1007{
1008 struct res_counter *fail;
1009 int ret;
1010
Glauber Costa0e90b312012-01-20 04:57:16 +00001011 ret = res_counter_charge_nofail(prot->memory_allocated,
1012 amt << PAGE_SHIFT, &fail);
Glauber Costae1aab162011-12-11 21:47:03 +00001013 if (ret < 0)
1014 *parent_status = OVER_LIMIT;
1015}
1016
1017static inline void memcg_memory_allocated_sub(struct cg_proto *prot,
1018 unsigned long amt)
1019{
1020 res_counter_uncharge(prot->memory_allocated, amt << PAGE_SHIFT);
1021}
1022
1023static inline u64 memcg_memory_allocated_read(struct cg_proto *prot)
1024{
1025 u64 ret;
1026 ret = res_counter_read_u64(prot->memory_allocated, RES_USAGE);
1027 return ret >> PAGE_SHIFT;
1028}
1029
Glauber Costa180d8cd2011-12-11 21:47:02 +00001030static inline long
1031sk_memory_allocated(const struct sock *sk)
1032{
1033 struct proto *prot = sk->sk_prot;
Glauber Costae1aab162011-12-11 21:47:03 +00001034 if (mem_cgroup_sockets_enabled && sk->sk_cgrp)
1035 return memcg_memory_allocated_read(sk->sk_cgrp);
1036
Glauber Costa180d8cd2011-12-11 21:47:02 +00001037 return atomic_long_read(prot->memory_allocated);
1038}
1039
1040static inline long
Glauber Costae1aab162011-12-11 21:47:03 +00001041sk_memory_allocated_add(struct sock *sk, int amt, int *parent_status)
Glauber Costa180d8cd2011-12-11 21:47:02 +00001042{
1043 struct proto *prot = sk->sk_prot;
Glauber Costae1aab162011-12-11 21:47:03 +00001044
1045 if (mem_cgroup_sockets_enabled && sk->sk_cgrp) {
1046 memcg_memory_allocated_add(sk->sk_cgrp, amt, parent_status);
1047 /* update the root cgroup regardless */
1048 atomic_long_add_return(amt, prot->memory_allocated);
1049 return memcg_memory_allocated_read(sk->sk_cgrp);
1050 }
1051
Glauber Costa180d8cd2011-12-11 21:47:02 +00001052 return atomic_long_add_return(amt, prot->memory_allocated);
1053}
1054
1055static inline void
Glauber Costa0e90b312012-01-20 04:57:16 +00001056sk_memory_allocated_sub(struct sock *sk, int amt)
Glauber Costa180d8cd2011-12-11 21:47:02 +00001057{
1058 struct proto *prot = sk->sk_prot;
Glauber Costae1aab162011-12-11 21:47:03 +00001059
Glauber Costa0e90b312012-01-20 04:57:16 +00001060 if (mem_cgroup_sockets_enabled && sk->sk_cgrp)
Glauber Costae1aab162011-12-11 21:47:03 +00001061 memcg_memory_allocated_sub(sk->sk_cgrp, amt);
1062
Glauber Costa180d8cd2011-12-11 21:47:02 +00001063 atomic_long_sub(amt, prot->memory_allocated);
1064}
1065
1066static inline void sk_sockets_allocated_dec(struct sock *sk)
1067{
1068 struct proto *prot = sk->sk_prot;
Glauber Costae1aab162011-12-11 21:47:03 +00001069
1070 if (mem_cgroup_sockets_enabled && sk->sk_cgrp) {
1071 struct cg_proto *cg_proto = sk->sk_cgrp;
1072
1073 for (; cg_proto; cg_proto = parent_cg_proto(prot, cg_proto))
1074 percpu_counter_dec(cg_proto->sockets_allocated);
1075 }
1076
Glauber Costa180d8cd2011-12-11 21:47:02 +00001077 percpu_counter_dec(prot->sockets_allocated);
1078}
1079
1080static inline void sk_sockets_allocated_inc(struct sock *sk)
1081{
1082 struct proto *prot = sk->sk_prot;
Glauber Costae1aab162011-12-11 21:47:03 +00001083
1084 if (mem_cgroup_sockets_enabled && sk->sk_cgrp) {
1085 struct cg_proto *cg_proto = sk->sk_cgrp;
1086
1087 for (; cg_proto; cg_proto = parent_cg_proto(prot, cg_proto))
1088 percpu_counter_inc(cg_proto->sockets_allocated);
1089 }
1090
Glauber Costa180d8cd2011-12-11 21:47:02 +00001091 percpu_counter_inc(prot->sockets_allocated);
1092}
1093
1094static inline int
1095sk_sockets_allocated_read_positive(struct sock *sk)
1096{
1097 struct proto *prot = sk->sk_prot;
1098
Glauber Costae1aab162011-12-11 21:47:03 +00001099 if (mem_cgroup_sockets_enabled && sk->sk_cgrp)
1100 return percpu_counter_sum_positive(sk->sk_cgrp->sockets_allocated);
1101
Glauber Costa180d8cd2011-12-11 21:47:02 +00001102 return percpu_counter_sum_positive(prot->sockets_allocated);
1103}
1104
1105static inline int
1106proto_sockets_allocated_sum_positive(struct proto *prot)
1107{
1108 return percpu_counter_sum_positive(prot->sockets_allocated);
1109}
1110
1111static inline long
1112proto_memory_allocated(struct proto *prot)
1113{
1114 return atomic_long_read(prot->memory_allocated);
1115}
1116
1117static inline bool
1118proto_memory_pressure(struct proto *prot)
1119{
1120 if (!prot->memory_pressure)
1121 return false;
1122 return !!*prot->memory_pressure;
1123}
1124
Eric Dumazet65f76512008-01-03 20:46:48 -08001125
1126#ifdef CONFIG_PROC_FS
Linus Torvalds1da177e2005-04-16 15:20:36 -07001127/* Called with local bh disabled */
Pavel Emelyanovc29a0bc2008-03-31 19:41:46 -07001128extern void sock_prot_inuse_add(struct net *net, struct proto *prot, int inc);
1129extern int sock_prot_inuse_get(struct net *net, struct proto *proto);
Eric Dumazet65f76512008-01-03 20:46:48 -08001130#else
Pavel Emelyanovc29a0bc2008-03-31 19:41:46 -07001131static void inline sock_prot_inuse_add(struct net *net, struct proto *prot,
1132 int inc)
Eric Dumazet65f76512008-01-03 20:46:48 -08001133{
1134}
Eric Dumazet65f76512008-01-03 20:46:48 -08001135#endif
1136
Linus Torvalds1da177e2005-04-16 15:20:36 -07001137
Arnaldo Carvalho de Melo614c6cb2005-08-09 19:47:37 -07001138/* With per-bucket locks this operation is not-atomic, so that
1139 * this version is not worse.
1140 */
1141static inline void __sk_prot_rehash(struct sock *sk)
1142{
1143 sk->sk_prot->unhash(sk);
1144 sk->sk_prot->hash(sk);
1145}
1146
Octavian Purdilafcbdf092010-12-16 14:26:56 -08001147void sk_prot_clear_portaddr_nulls(struct sock *sk, int size);
1148
Linus Torvalds1da177e2005-04-16 15:20:36 -07001149/* About 10 seconds */
1150#define SOCK_DESTROY_TIME (10*HZ)
1151
1152/* Sockets 0-1023 can't be bound to unless you are superuser */
1153#define PROT_SOCK 1024
1154
1155#define SHUTDOWN_MASK 3
1156#define RCV_SHUTDOWN 1
1157#define SEND_SHUTDOWN 2
1158
1159#define SOCK_SNDBUF_LOCK 1
1160#define SOCK_RCVBUF_LOCK 2
1161#define SOCK_BINDADDR_LOCK 4
1162#define SOCK_BINDPORT_LOCK 8
1163
1164/* sock_iocb: used to kick off async processing of socket ios */
1165struct sock_iocb {
1166 struct list_head list;
1167
1168 int flags;
1169 int size;
1170 struct socket *sock;
1171 struct sock *sk;
1172 struct scm_cookie *scm;
1173 struct msghdr *msg, async_msg;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001174 struct kiocb *kiocb;
1175};
1176
1177static inline struct sock_iocb *kiocb_to_siocb(struct kiocb *iocb)
1178{
1179 return (struct sock_iocb *)iocb->private;
1180}
1181
1182static inline struct kiocb *siocb_to_kiocb(struct sock_iocb *si)
1183{
1184 return si->kiocb;
1185}
1186
1187struct socket_alloc {
1188 struct socket socket;
1189 struct inode vfs_inode;
1190};
1191
1192static inline struct socket *SOCKET_I(struct inode *inode)
1193{
1194 return &container_of(inode, struct socket_alloc, vfs_inode)->socket;
1195}
1196
1197static inline struct inode *SOCK_INODE(struct socket *socket)
1198{
1199 return &container_of(socket, struct socket_alloc, socket)->vfs_inode;
1200}
1201
Hideo Aoki3ab224b2007-12-31 00:11:19 -08001202/*
1203 * Functions for memory accounting
1204 */
1205extern int __sk_mem_schedule(struct sock *sk, int size, int kind);
1206extern void __sk_mem_reclaim(struct sock *sk);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001207
Hideo Aoki3ab224b2007-12-31 00:11:19 -08001208#define SK_MEM_QUANTUM ((int)PAGE_SIZE)
1209#define SK_MEM_QUANTUM_SHIFT ilog2(SK_MEM_QUANTUM)
1210#define SK_MEM_SEND 0
1211#define SK_MEM_RECV 1
Linus Torvalds1da177e2005-04-16 15:20:36 -07001212
Hideo Aoki3ab224b2007-12-31 00:11:19 -08001213static inline int sk_mem_pages(int amt)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001214{
Hideo Aoki3ab224b2007-12-31 00:11:19 -08001215 return (amt + SK_MEM_QUANTUM - 1) >> SK_MEM_QUANTUM_SHIFT;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001216}
1217
Hideo Aoki3ab224b2007-12-31 00:11:19 -08001218static inline int sk_has_account(struct sock *sk)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001219{
Hideo Aoki3ab224b2007-12-31 00:11:19 -08001220 /* return true if protocol supports memory accounting */
1221 return !!sk->sk_prot->memory_allocated;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001222}
1223
Hideo Aoki3ab224b2007-12-31 00:11:19 -08001224static inline int sk_wmem_schedule(struct sock *sk, int size)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001225{
Hideo Aoki3ab224b2007-12-31 00:11:19 -08001226 if (!sk_has_account(sk))
1227 return 1;
Herbert Xud80d99d2005-09-01 17:48:23 -07001228 return size <= sk->sk_forward_alloc ||
Hideo Aoki3ab224b2007-12-31 00:11:19 -08001229 __sk_mem_schedule(sk, size, SK_MEM_SEND);
1230}
1231
1232static inline int sk_rmem_schedule(struct sock *sk, int size)
1233{
1234 if (!sk_has_account(sk))
1235 return 1;
1236 return size <= sk->sk_forward_alloc ||
1237 __sk_mem_schedule(sk, size, SK_MEM_RECV);
1238}
1239
1240static inline void sk_mem_reclaim(struct sock *sk)
1241{
1242 if (!sk_has_account(sk))
1243 return;
1244 if (sk->sk_forward_alloc >= SK_MEM_QUANTUM)
1245 __sk_mem_reclaim(sk);
1246}
1247
David S. Miller9993e7d2008-01-10 21:56:38 -08001248static inline void sk_mem_reclaim_partial(struct sock *sk)
1249{
1250 if (!sk_has_account(sk))
1251 return;
1252 if (sk->sk_forward_alloc > SK_MEM_QUANTUM)
1253 __sk_mem_reclaim(sk);
1254}
1255
Hideo Aoki3ab224b2007-12-31 00:11:19 -08001256static inline void sk_mem_charge(struct sock *sk, int size)
1257{
1258 if (!sk_has_account(sk))
1259 return;
1260 sk->sk_forward_alloc -= size;
1261}
1262
1263static inline void sk_mem_uncharge(struct sock *sk, int size)
1264{
1265 if (!sk_has_account(sk))
1266 return;
1267 sk->sk_forward_alloc += size;
1268}
1269
1270static inline void sk_wmem_free_skb(struct sock *sk, struct sk_buff *skb)
1271{
Hideo Aoki3ab224b2007-12-31 00:11:19 -08001272 sock_set_flag(sk, SOCK_QUEUE_SHRUNK);
1273 sk->sk_wmem_queued -= skb->truesize;
1274 sk_mem_uncharge(sk, skb->truesize);
1275 __kfree_skb(skb);
Herbert Xud80d99d2005-09-01 17:48:23 -07001276}
1277
Linus Torvalds1da177e2005-04-16 15:20:36 -07001278/* Used by processes to "lock" a socket state, so that
1279 * interrupts and bottom half handlers won't change it
1280 * from under us. It essentially blocks any incoming
1281 * packets, so that we won't get any new data or any
1282 * packets that change the state of the socket.
1283 *
1284 * While locked, BH processing will add new packets to
1285 * the backlog queue. This queue is processed by the
1286 * owner of the socket lock right before it is released.
1287 *
1288 * Since ~2.3.5 it is also exclusive sleep lock serializing
1289 * accesses from user process context.
1290 */
John Heffnerd2e91172007-09-12 10:44:19 +02001291#define sock_owned_by_user(sk) ((sk)->sk_lock.owned)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001292
Peter Zijlstraed075362006-12-06 20:35:24 -08001293/*
1294 * Macro so as to not evaluate some arguments when
1295 * lockdep is not enabled.
1296 *
1297 * Mark both the sk_lock and the sk_lock.slock as a
1298 * per-address-family lock class.
1299 */
1300#define sock_lock_init_class_and_name(sk, sname, skey, name, key) \
1301do { \
Ingo Molnare8f6fbf2008-11-12 01:38:36 +00001302 sk->sk_lock.owned = 0; \
Peter Zijlstraed075362006-12-06 20:35:24 -08001303 init_waitqueue_head(&sk->sk_lock.wq); \
1304 spin_lock_init(&(sk)->sk_lock.slock); \
1305 debug_check_no_locks_freed((void *)&(sk)->sk_lock, \
1306 sizeof((sk)->sk_lock)); \
1307 lockdep_set_class_and_name(&(sk)->sk_lock.slock, \
1308 (skey), (sname)); \
1309 lockdep_init_map(&(sk)->sk_lock.dep_map, (name), (key), 0); \
1310} while (0)
1311
Harvey Harrison41380932007-12-12 10:46:51 -08001312extern void lock_sock_nested(struct sock *sk, int subclass);
Peter Zijlstrafcc70d52006-11-08 22:44:35 -08001313
1314static inline void lock_sock(struct sock *sk)
1315{
1316 lock_sock_nested(sk, 0);
1317}
1318
Harvey Harrison41380932007-12-12 10:46:51 -08001319extern void release_sock(struct sock *sk);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001320
1321/* BH context may only use the following locking interface. */
1322#define bh_lock_sock(__sk) spin_lock(&((__sk)->sk_lock.slock))
Ingo Molnarc6366182006-07-03 00:25:13 -07001323#define bh_lock_sock_nested(__sk) \
1324 spin_lock_nested(&((__sk)->sk_lock.slock), \
1325 SINGLE_DEPTH_NESTING)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001326#define bh_unlock_sock(__sk) spin_unlock(&((__sk)->sk_lock.slock))
1327
Eric Dumazet8a74ad62010-05-26 19:20:18 +00001328extern bool lock_sock_fast(struct sock *sk);
1329/**
1330 * unlock_sock_fast - complement of lock_sock_fast
1331 * @sk: socket
1332 * @slow: slow mode
1333 *
1334 * fast unlock socket for user context.
1335 * If slow mode is on, we call regular release_sock()
1336 */
1337static inline void unlock_sock_fast(struct sock *sk, bool slow)
Eric Dumazet4b0b72f2010-04-28 14:35:48 -07001338{
Eric Dumazet8a74ad62010-05-26 19:20:18 +00001339 if (slow)
1340 release_sock(sk);
1341 else
1342 spin_unlock_bh(&sk->sk_lock.slock);
Eric Dumazet4b0b72f2010-04-28 14:35:48 -07001343}
1344
Eric Dumazet4b0b72f2010-04-28 14:35:48 -07001345
Eric W. Biederman1b8d7ae2007-10-08 23:24:22 -07001346extern struct sock *sk_alloc(struct net *net, int family,
Al Virodd0fc662005-10-07 07:46:04 +01001347 gfp_t priority,
Pavel Emelyanov6257ff22007-11-01 00:39:31 -07001348 struct proto *prot);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001349extern void sk_free(struct sock *sk);
Denis V. Lunevedf02082008-02-29 11:18:32 -08001350extern void sk_release_kernel(struct sock *sk);
Eric Dumazete56c57d2011-11-08 17:07:07 -05001351extern struct sock *sk_clone_lock(const struct sock *sk,
1352 const gfp_t priority);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001353
1354extern struct sk_buff *sock_wmalloc(struct sock *sk,
1355 unsigned long size, int force,
Al Virodd0fc662005-10-07 07:46:04 +01001356 gfp_t priority);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001357extern struct sk_buff *sock_rmalloc(struct sock *sk,
1358 unsigned long size, int force,
Al Virodd0fc662005-10-07 07:46:04 +01001359 gfp_t priority);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001360extern void sock_wfree(struct sk_buff *skb);
1361extern void sock_rfree(struct sk_buff *skb);
1362
1363extern int sock_setsockopt(struct socket *sock, int level,
1364 int op, char __user *optval,
David S. Millerb7058842009-09-30 16:12:20 -07001365 unsigned int optlen);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001366
1367extern int sock_getsockopt(struct socket *sock, int level,
1368 int op, char __user *optval,
1369 int __user *optlen);
1370extern struct sk_buff *sock_alloc_send_skb(struct sock *sk,
1371 unsigned long size,
1372 int noblock,
1373 int *errcode);
Herbert Xu4cc7f682009-02-04 16:55:54 -08001374extern struct sk_buff *sock_alloc_send_pskb(struct sock *sk,
1375 unsigned long header_len,
1376 unsigned long data_len,
1377 int noblock,
1378 int *errcode);
Victor Fusco86a76ca2005-07-08 14:57:47 -07001379extern void *sock_kmalloc(struct sock *sk, int size,
Al Virodd0fc662005-10-07 07:46:04 +01001380 gfp_t priority);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001381extern void sock_kfree_s(struct sock *sk, void *mem, int size);
1382extern void sk_send_sigurg(struct sock *sk);
1383
Herbert Xuf8451722010-05-24 00:12:34 -07001384#ifdef CONFIG_CGROUPS
1385extern void sock_update_classid(struct sock *sk);
1386#else
1387static inline void sock_update_classid(struct sock *sk)
1388{
1389}
1390#endif
1391
Linus Torvalds1da177e2005-04-16 15:20:36 -07001392/*
1393 * Functions to fill in entries in struct proto_ops when a protocol
1394 * does not implement a particular function.
1395 */
1396extern int sock_no_bind(struct socket *,
1397 struct sockaddr *, int);
1398extern int sock_no_connect(struct socket *,
1399 struct sockaddr *, int, int);
1400extern int sock_no_socketpair(struct socket *,
1401 struct socket *);
1402extern int sock_no_accept(struct socket *,
1403 struct socket *, int);
1404extern int sock_no_getname(struct socket *,
1405 struct sockaddr *, int *, int);
1406extern unsigned int sock_no_poll(struct file *, struct socket *,
1407 struct poll_table_struct *);
1408extern int sock_no_ioctl(struct socket *, unsigned int,
1409 unsigned long);
1410extern int sock_no_listen(struct socket *, int);
1411extern int sock_no_shutdown(struct socket *, int);
1412extern int sock_no_getsockopt(struct socket *, int , int,
1413 char __user *, int __user *);
1414extern int sock_no_setsockopt(struct socket *, int, int,
David S. Millerb7058842009-09-30 16:12:20 -07001415 char __user *, unsigned int);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001416extern int sock_no_sendmsg(struct kiocb *, struct socket *,
1417 struct msghdr *, size_t);
1418extern int sock_no_recvmsg(struct kiocb *, struct socket *,
1419 struct msghdr *, size_t, int);
1420extern int sock_no_mmap(struct file *file,
1421 struct socket *sock,
1422 struct vm_area_struct *vma);
1423extern ssize_t sock_no_sendpage(struct socket *sock,
1424 struct page *page,
1425 int offset, size_t size,
1426 int flags);
1427
1428/*
1429 * Functions to fill in entries in struct proto_ops when a protocol
1430 * uses the inet style.
1431 */
1432extern int sock_common_getsockopt(struct socket *sock, int level, int optname,
1433 char __user *optval, int __user *optlen);
1434extern int sock_common_recvmsg(struct kiocb *iocb, struct socket *sock,
1435 struct msghdr *msg, size_t size, int flags);
1436extern int sock_common_setsockopt(struct socket *sock, int level, int optname,
David S. Millerb7058842009-09-30 16:12:20 -07001437 char __user *optval, unsigned int optlen);
Dmitry Mishin3fdadf72006-03-20 22:45:21 -08001438extern int compat_sock_common_getsockopt(struct socket *sock, int level,
1439 int optname, char __user *optval, int __user *optlen);
1440extern int compat_sock_common_setsockopt(struct socket *sock, int level,
David S. Millerb7058842009-09-30 16:12:20 -07001441 int optname, char __user *optval, unsigned int optlen);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001442
1443extern void sk_common_release(struct sock *sk);
1444
1445/*
1446 * Default socket callbacks and setup code
1447 */
1448
1449/* Initialise core socket variables */
1450extern void sock_init_data(struct socket *sock, struct sock *sk);
1451
Eric Dumazet46bcf142010-12-06 09:29:43 -08001452extern void sk_filter_release_rcu(struct rcu_head *rcu);
1453
Linus Torvalds1da177e2005-04-16 15:20:36 -07001454/**
Ben Hutchings1a5778a2010-02-14 22:35:47 -08001455 * sk_filter_release - release a socket filter
Paul Bonserdc9b3342006-11-23 17:56:13 -08001456 * @fp: filter to remove
1457 *
1458 * Remove a filter from a socket and release its resources.
1459 */
1460
Pavel Emelyanov309dd5f2007-10-17 21:21:51 -07001461static inline void sk_filter_release(struct sk_filter *fp)
1462{
1463 if (atomic_dec_and_test(&fp->refcnt))
Eric Dumazet80f8f102011-01-18 07:46:52 +00001464 call_rcu(&fp->rcu, sk_filter_release_rcu);
Pavel Emelyanov309dd5f2007-10-17 21:21:51 -07001465}
1466
1467static inline void sk_filter_uncharge(struct sock *sk, struct sk_filter *fp)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001468{
1469 unsigned int size = sk_filter_len(fp);
1470
1471 atomic_sub(size, &sk->sk_omem_alloc);
Pavel Emelyanov309dd5f2007-10-17 21:21:51 -07001472 sk_filter_release(fp);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001473}
1474
1475static inline void sk_filter_charge(struct sock *sk, struct sk_filter *fp)
1476{
1477 atomic_inc(&fp->refcnt);
1478 atomic_add(sk_filter_len(fp), &sk->sk_omem_alloc);
1479}
1480
1481/*
1482 * Socket reference counting postulates.
1483 *
1484 * * Each user of socket SHOULD hold a reference count.
1485 * * Each access point to socket (an hash table bucket, reference from a list,
1486 * running timer, skb in flight MUST hold a reference count.
1487 * * When reference count hits 0, it means it will never increase back.
1488 * * When reference count hits 0, it means that no references from
1489 * outside exist to this socket and current process on current CPU
1490 * is last user and may/should destroy this socket.
1491 * * sk_free is called from any context: process, BH, IRQ. When
1492 * it is called, socket has no references from outside -> sk_free
1493 * may release descendant resources allocated by the socket, but
1494 * to the time when it is called, socket is NOT referenced by any
1495 * hash tables, lists etc.
1496 * * Packets, delivered from outside (from network or from another process)
1497 * and enqueued on receive/error queues SHOULD NOT grab reference count,
1498 * when they sit in queue. Otherwise, packets will leak to hole, when
1499 * socket is looked up by one cpu and unhasing is made by another CPU.
1500 * It is true for udp/raw, netlink (leak to receive and error queues), tcp
1501 * (leak to backlog). Packet socket does all the processing inside
1502 * BR_NETPROTO_LOCK, so that it has not this race condition. UNIX sockets
1503 * use separate SMP lock, so that they are prone too.
1504 */
1505
1506/* Ungrab socket and destroy it, if it was the last reference. */
1507static inline void sock_put(struct sock *sk)
1508{
1509 if (atomic_dec_and_test(&sk->sk_refcnt))
1510 sk_free(sk);
1511}
1512
Arnaldo Carvalho de Melo58a5a7b2006-11-16 14:06:06 -02001513extern int sk_receive_skb(struct sock *sk, struct sk_buff *skb,
1514 const int nested);
Arnaldo Carvalho de Melo25995ff2005-12-27 02:42:22 -02001515
Krishna Kumare022f0b2009-10-19 23:46:20 +00001516static inline void sk_tx_queue_set(struct sock *sk, int tx_queue)
1517{
1518 sk->sk_tx_queue_mapping = tx_queue;
1519}
1520
1521static inline void sk_tx_queue_clear(struct sock *sk)
1522{
1523 sk->sk_tx_queue_mapping = -1;
1524}
1525
1526static inline int sk_tx_queue_get(const struct sock *sk)
1527{
Tom Herbertb0f77d02010-07-14 20:50:29 -07001528 return sk ? sk->sk_tx_queue_mapping : -1;
Krishna Kumare022f0b2009-10-19 23:46:20 +00001529}
1530
David S. Miller972692e2008-06-17 22:41:38 -07001531static inline void sk_set_socket(struct sock *sk, struct socket *sock)
1532{
Krishna Kumare022f0b2009-10-19 23:46:20 +00001533 sk_tx_queue_clear(sk);
David S. Miller972692e2008-06-17 22:41:38 -07001534 sk->sk_socket = sock;
1535}
1536
Eric Dumazetaa395142010-04-20 13:03:51 +00001537static inline wait_queue_head_t *sk_sleep(struct sock *sk)
1538{
Eric Dumazeteaefd112011-02-18 03:26:36 +00001539 BUILD_BUG_ON(offsetof(struct socket_wq, wait) != 0);
1540 return &rcu_dereference_raw(sk->sk_wq)->wait;
Eric Dumazetaa395142010-04-20 13:03:51 +00001541}
Linus Torvalds1da177e2005-04-16 15:20:36 -07001542/* Detach socket from process context.
1543 * Announce socket dead, detach it from wait queue and inode.
1544 * Note that parent inode held reference count on this struct sock,
1545 * we do not release it in this function, because protocol
1546 * probably wants some additional cleanups or even continuing
1547 * to work with this socket (TCP).
1548 */
1549static inline void sock_orphan(struct sock *sk)
1550{
1551 write_lock_bh(&sk->sk_callback_lock);
1552 sock_set_flag(sk, SOCK_DEAD);
David S. Miller972692e2008-06-17 22:41:38 -07001553 sk_set_socket(sk, NULL);
Eric Dumazet43815482010-04-29 11:01:49 +00001554 sk->sk_wq = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001555 write_unlock_bh(&sk->sk_callback_lock);
1556}
1557
1558static inline void sock_graft(struct sock *sk, struct socket *parent)
1559{
1560 write_lock_bh(&sk->sk_callback_lock);
Eric Dumazeteaefd112011-02-18 03:26:36 +00001561 sk->sk_wq = parent->wq;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001562 parent->sk = sk;
David S. Miller972692e2008-06-17 22:41:38 -07001563 sk_set_socket(sk, parent);
Venkat Yekkirala4237c752006-07-24 23:32:50 -07001564 security_sock_graft(sk, parent);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001565 write_unlock_bh(&sk->sk_callback_lock);
1566}
1567
1568extern int sock_i_uid(struct sock *sk);
1569extern unsigned long sock_i_ino(struct sock *sk);
1570
1571static inline struct dst_entry *
1572__sk_dst_get(struct sock *sk)
1573{
Michal Hockod8bf4ca2011-07-08 14:39:41 +02001574 return rcu_dereference_check(sk->sk_dst_cache, sock_owned_by_user(sk) ||
Eric Dumazetf68c2242010-04-22 16:06:59 -07001575 lockdep_is_held(&sk->sk_lock.slock));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001576}
1577
1578static inline struct dst_entry *
1579sk_dst_get(struct sock *sk)
1580{
1581 struct dst_entry *dst;
1582
Eric Dumazetb6c67122010-04-08 23:03:29 +00001583 rcu_read_lock();
1584 dst = rcu_dereference(sk->sk_dst_cache);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001585 if (dst)
1586 dst_hold(dst);
Eric Dumazetb6c67122010-04-08 23:03:29 +00001587 rcu_read_unlock();
Linus Torvalds1da177e2005-04-16 15:20:36 -07001588 return dst;
1589}
1590
Eric Dumazetb6c67122010-04-08 23:03:29 +00001591extern void sk_reset_txq(struct sock *sk);
1592
1593static inline void dst_negative_advice(struct sock *sk)
1594{
1595 struct dst_entry *ndst, *dst = __sk_dst_get(sk);
1596
1597 if (dst && dst->ops->negative_advice) {
1598 ndst = dst->ops->negative_advice(dst);
1599
1600 if (ndst != dst) {
1601 rcu_assign_pointer(sk->sk_dst_cache, ndst);
1602 sk_reset_txq(sk);
1603 }
1604 }
1605}
1606
Linus Torvalds1da177e2005-04-16 15:20:36 -07001607static inline void
1608__sk_dst_set(struct sock *sk, struct dst_entry *dst)
1609{
1610 struct dst_entry *old_dst;
1611
Krishna Kumare022f0b2009-10-19 23:46:20 +00001612 sk_tx_queue_clear(sk);
Eric Dumazet0b53ff22010-04-26 20:40:43 +00001613 /*
1614 * This can be called while sk is owned by the caller only,
1615 * with no state that can be checked in a rcu_dereference_check() cond
1616 */
1617 old_dst = rcu_dereference_raw(sk->sk_dst_cache);
Eric Dumazetb6c67122010-04-08 23:03:29 +00001618 rcu_assign_pointer(sk->sk_dst_cache, dst);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001619 dst_release(old_dst);
1620}
1621
1622static inline void
1623sk_dst_set(struct sock *sk, struct dst_entry *dst)
1624{
Eric Dumazetb6c67122010-04-08 23:03:29 +00001625 spin_lock(&sk->sk_dst_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001626 __sk_dst_set(sk, dst);
Eric Dumazetb6c67122010-04-08 23:03:29 +00001627 spin_unlock(&sk->sk_dst_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001628}
1629
1630static inline void
1631__sk_dst_reset(struct sock *sk)
1632{
Eric Dumazetb6c67122010-04-08 23:03:29 +00001633 __sk_dst_set(sk, NULL);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001634}
1635
1636static inline void
1637sk_dst_reset(struct sock *sk)
1638{
Eric Dumazetb6c67122010-04-08 23:03:29 +00001639 spin_lock(&sk->sk_dst_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001640 __sk_dst_reset(sk);
Eric Dumazetb6c67122010-04-08 23:03:29 +00001641 spin_unlock(&sk->sk_dst_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001642}
1643
Denis Vlasenkof0088a52006-03-28 01:08:21 -08001644extern struct dst_entry *__sk_dst_check(struct sock *sk, u32 cookie);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001645
Denis Vlasenkof0088a52006-03-28 01:08:21 -08001646extern struct dst_entry *sk_dst_check(struct sock *sk, u32 cookie);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001647
Herbert Xubcd76112006-06-30 13:36:35 -07001648static inline int sk_can_gso(const struct sock *sk)
1649{
1650 return net_gso_ok(sk->sk_route_caps, sk->sk_gso_type);
1651}
1652
Andi Kleen99580892007-04-20 17:12:43 -07001653extern void sk_setup_caps(struct sock *sk, struct dst_entry *dst);
Arnaldo Carvalho de Melo6cbb0df2005-08-09 19:49:02 -07001654
Michał Mirosławc8f44af2011-11-15 15:29:55 +00001655static inline void sk_nocaps_add(struct sock *sk, netdev_features_t flags)
Eric Dumazeta4654192010-05-16 00:36:33 -07001656{
1657 sk->sk_route_nocaps |= flags;
1658 sk->sk_route_caps &= ~flags;
1659}
1660
Tom Herbertc6e1a0d2011-04-04 22:30:30 -07001661static inline int skb_do_copy_data_nocache(struct sock *sk, struct sk_buff *skb,
1662 char __user *from, char *to,
Wei Yongjun912d3982011-04-06 18:40:12 +00001663 int copy, int offset)
Tom Herbertc6e1a0d2011-04-04 22:30:30 -07001664{
1665 if (skb->ip_summed == CHECKSUM_NONE) {
1666 int err = 0;
1667 __wsum csum = csum_and_copy_from_user(from, to, copy, 0, &err);
1668 if (err)
1669 return err;
Wei Yongjun912d3982011-04-06 18:40:12 +00001670 skb->csum = csum_block_add(skb->csum, csum, offset);
Tom Herbertc6e1a0d2011-04-04 22:30:30 -07001671 } else if (sk->sk_route_caps & NETIF_F_NOCACHE_COPY) {
1672 if (!access_ok(VERIFY_READ, from, copy) ||
1673 __copy_from_user_nocache(to, from, copy))
1674 return -EFAULT;
1675 } else if (copy_from_user(to, from, copy))
1676 return -EFAULT;
1677
1678 return 0;
1679}
1680
1681static inline int skb_add_data_nocache(struct sock *sk, struct sk_buff *skb,
1682 char __user *from, int copy)
1683{
Wei Yongjun912d3982011-04-06 18:40:12 +00001684 int err, offset = skb->len;
Tom Herbertc6e1a0d2011-04-04 22:30:30 -07001685
Wei Yongjun912d3982011-04-06 18:40:12 +00001686 err = skb_do_copy_data_nocache(sk, skb, from, skb_put(skb, copy),
1687 copy, offset);
Tom Herbertc6e1a0d2011-04-04 22:30:30 -07001688 if (err)
Wei Yongjun912d3982011-04-06 18:40:12 +00001689 __skb_trim(skb, offset);
Tom Herbertc6e1a0d2011-04-04 22:30:30 -07001690
1691 return err;
1692}
1693
1694static inline int skb_copy_to_page_nocache(struct sock *sk, char __user *from,
1695 struct sk_buff *skb,
1696 struct page *page,
1697 int off, int copy)
1698{
1699 int err;
1700
Wei Yongjun912d3982011-04-06 18:40:12 +00001701 err = skb_do_copy_data_nocache(sk, skb, from, page_address(page) + off,
1702 copy, skb->len);
Tom Herbertc6e1a0d2011-04-04 22:30:30 -07001703 if (err)
1704 return err;
1705
1706 skb->len += copy;
1707 skb->data_len += copy;
1708 skb->truesize += copy;
1709 sk->sk_wmem_queued += copy;
1710 sk_mem_charge(sk, copy);
1711 return 0;
1712}
1713
Linus Torvalds1da177e2005-04-16 15:20:36 -07001714static inline int skb_copy_to_page(struct sock *sk, char __user *from,
1715 struct sk_buff *skb, struct page *page,
1716 int off, int copy)
1717{
1718 if (skb->ip_summed == CHECKSUM_NONE) {
1719 int err = 0;
Al Viro50842052006-11-14 21:36:34 -08001720 __wsum csum = csum_and_copy_from_user(from,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001721 page_address(page) + off,
1722 copy, 0, &err);
1723 if (err)
1724 return err;
1725 skb->csum = csum_block_add(skb->csum, csum, skb->len);
1726 } else if (copy_from_user(page_address(page) + off, from, copy))
1727 return -EFAULT;
1728
1729 skb->len += copy;
1730 skb->data_len += copy;
1731 skb->truesize += copy;
1732 sk->sk_wmem_queued += copy;
Hideo Aoki3ab224b2007-12-31 00:11:19 -08001733 sk_mem_charge(sk, copy);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001734 return 0;
1735}
1736
Eric Dumazetc5640392009-06-16 10:12:03 +00001737/**
1738 * sk_wmem_alloc_get - returns write allocations
1739 * @sk: socket
1740 *
1741 * Returns sk_wmem_alloc minus initial offset of one
1742 */
1743static inline int sk_wmem_alloc_get(const struct sock *sk)
1744{
1745 return atomic_read(&sk->sk_wmem_alloc) - 1;
1746}
1747
1748/**
1749 * sk_rmem_alloc_get - returns read allocations
1750 * @sk: socket
1751 *
1752 * Returns sk_rmem_alloc
1753 */
1754static inline int sk_rmem_alloc_get(const struct sock *sk)
1755{
1756 return atomic_read(&sk->sk_rmem_alloc);
1757}
1758
1759/**
1760 * sk_has_allocations - check if allocations are outstanding
1761 * @sk: socket
1762 *
1763 * Returns true if socket has write or read allocations
1764 */
1765static inline int sk_has_allocations(const struct sock *sk)
1766{
1767 return sk_wmem_alloc_get(sk) || sk_rmem_alloc_get(sk);
1768}
1769
Jiri Olsaa57de0b2009-07-08 12:09:13 +00001770/**
Eric Dumazet43815482010-04-29 11:01:49 +00001771 * wq_has_sleeper - check if there are any waiting processes
Randy Dunlapacfbe962010-05-24 23:54:18 -07001772 * @wq: struct socket_wq
Jiri Olsaa57de0b2009-07-08 12:09:13 +00001773 *
Eric Dumazet43815482010-04-29 11:01:49 +00001774 * Returns true if socket_wq has waiting processes
Jiri Olsaa57de0b2009-07-08 12:09:13 +00001775 *
Eric Dumazet43815482010-04-29 11:01:49 +00001776 * The purpose of the wq_has_sleeper and sock_poll_wait is to wrap the memory
Jiri Olsaa57de0b2009-07-08 12:09:13 +00001777 * barrier call. They were added due to the race found within the tcp code.
1778 *
1779 * Consider following tcp code paths:
1780 *
1781 * CPU1 CPU2
1782 *
1783 * sys_select receive packet
1784 * ... ...
1785 * __add_wait_queue update tp->rcv_nxt
1786 * ... ...
1787 * tp->rcv_nxt check sock_def_readable
1788 * ... {
Eric Dumazet43815482010-04-29 11:01:49 +00001789 * schedule rcu_read_lock();
1790 * wq = rcu_dereference(sk->sk_wq);
1791 * if (wq && waitqueue_active(&wq->wait))
1792 * wake_up_interruptible(&wq->wait)
Jiri Olsaa57de0b2009-07-08 12:09:13 +00001793 * ...
1794 * }
1795 *
1796 * The race for tcp fires when the __add_wait_queue changes done by CPU1 stay
1797 * in its cache, and so does the tp->rcv_nxt update on CPU2 side. The CPU1
1798 * could then endup calling schedule and sleep forever if there are no more
1799 * data on the socket.
Jiri Olsaad462762009-07-08 12:10:31 +00001800 *
Jiri Olsaa57de0b2009-07-08 12:09:13 +00001801 */
Eric Dumazet43815482010-04-29 11:01:49 +00001802static inline bool wq_has_sleeper(struct socket_wq *wq)
Jiri Olsaa57de0b2009-07-08 12:09:13 +00001803{
Eric Dumazet43815482010-04-29 11:01:49 +00001804
Jiri Olsaa57de0b2009-07-08 12:09:13 +00001805 /*
1806 * We need to be sure we are in sync with the
1807 * add_wait_queue modifications to the wait queue.
1808 *
1809 * This memory barrier is paired in the sock_poll_wait.
1810 */
Eric Dumazet43815482010-04-29 11:01:49 +00001811 smp_mb();
1812 return wq && waitqueue_active(&wq->wait);
Jiri Olsaa57de0b2009-07-08 12:09:13 +00001813}
1814
1815/**
1816 * sock_poll_wait - place memory barrier behind the poll_wait call.
1817 * @filp: file
1818 * @wait_address: socket wait queue
1819 * @p: poll_table
1820 *
Eric Dumazet43815482010-04-29 11:01:49 +00001821 * See the comments in the wq_has_sleeper function.
Jiri Olsaa57de0b2009-07-08 12:09:13 +00001822 */
1823static inline void sock_poll_wait(struct file *filp,
1824 wait_queue_head_t *wait_address, poll_table *p)
1825{
1826 if (p && wait_address) {
1827 poll_wait(filp, wait_address, p);
1828 /*
1829 * We need to be sure we are in sync with the
1830 * socket flags modification.
1831 *
Eric Dumazet43815482010-04-29 11:01:49 +00001832 * This memory barrier is paired in the wq_has_sleeper.
Jiri Olsaa57de0b2009-07-08 12:09:13 +00001833 */
1834 smp_mb();
1835 }
1836}
1837
Linus Torvalds1da177e2005-04-16 15:20:36 -07001838/*
1839 * Queue a received datagram if it will fit. Stream and sequenced
1840 * protocols can't normally use this as they need to fit buffers in
1841 * and play with them.
1842 *
1843 * Inlined as it's very short and called for pretty much every
1844 * packet ever received.
1845 */
1846
1847static inline void skb_set_owner_w(struct sk_buff *skb, struct sock *sk)
1848{
Herbert Xud55d87f2009-06-22 02:25:25 +00001849 skb_orphan(skb);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001850 skb->sk = sk;
1851 skb->destructor = sock_wfree;
Eric Dumazet2b85a342009-06-11 02:55:43 -07001852 /*
1853 * We used to take a refcount on sk, but following operation
1854 * is enough to guarantee sk_free() wont free this sock until
1855 * all in-flight packets are completed
1856 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001857 atomic_add(skb->truesize, &sk->sk_wmem_alloc);
1858}
1859
1860static inline void skb_set_owner_r(struct sk_buff *skb, struct sock *sk)
1861{
Herbert Xud55d87f2009-06-22 02:25:25 +00001862 skb_orphan(skb);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001863 skb->sk = sk;
1864 skb->destructor = sock_rfree;
1865 atomic_add(skb->truesize, &sk->sk_rmem_alloc);
Hideo Aoki3ab224b2007-12-31 00:11:19 -08001866 sk_mem_charge(sk, skb->truesize);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001867}
1868
1869extern void sk_reset_timer(struct sock *sk, struct timer_list* timer,
1870 unsigned long expires);
1871
1872extern void sk_stop_timer(struct sock *sk, struct timer_list* timer);
1873
Denis Vlasenkof0088a52006-03-28 01:08:21 -08001874extern int sock_queue_rcv_skb(struct sock *sk, struct sk_buff *skb);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001875
Eric Dumazetb1faf562010-05-31 23:44:05 -07001876extern int sock_queue_err_skb(struct sock *sk, struct sk_buff *skb);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001877
1878/*
1879 * Recover an error report and clear atomically
1880 */
1881
1882static inline int sock_error(struct sock *sk)
1883{
Benjamin LaHaisec1cbe4b2005-12-13 23:22:19 -08001884 int err;
1885 if (likely(!sk->sk_err))
1886 return 0;
1887 err = xchg(&sk->sk_err, 0);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001888 return -err;
1889}
1890
1891static inline unsigned long sock_wspace(struct sock *sk)
1892{
1893 int amt = 0;
1894
1895 if (!(sk->sk_shutdown & SEND_SHUTDOWN)) {
1896 amt = sk->sk_sndbuf - atomic_read(&sk->sk_wmem_alloc);
1897 if (amt < 0)
1898 amt = 0;
1899 }
1900 return amt;
1901}
1902
1903static inline void sk_wake_async(struct sock *sk, int how, int band)
1904{
Eric Dumazetbcdce712009-10-06 17:28:29 -07001905 if (sock_flag(sk, SOCK_FASYNC))
Linus Torvalds1da177e2005-04-16 15:20:36 -07001906 sock_wake_async(sk->sk_socket, how, band);
1907}
1908
1909#define SOCK_MIN_SNDBUF 2048
Eric Dumazet7a91b4342010-09-26 18:53:07 -07001910/*
1911 * Since sk_rmem_alloc sums skb->truesize, even a small frame might need
1912 * sizeof(sk_buff) + MTU + padding, unless net driver perform copybreak
1913 */
1914#define SOCK_MIN_RCVBUF (2048 + sizeof(struct sk_buff))
Linus Torvalds1da177e2005-04-16 15:20:36 -07001915
1916static inline void sk_stream_moderate_sndbuf(struct sock *sk)
1917{
1918 if (!(sk->sk_userlocks & SOCK_SNDBUF_LOCK)) {
Eric Dumazet8df09ea2007-12-21 03:07:41 -08001919 sk->sk_sndbuf = min(sk->sk_sndbuf, sk->sk_wmem_queued >> 1);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001920 sk->sk_sndbuf = max(sk->sk_sndbuf, SOCK_MIN_SNDBUF);
1921 }
1922}
1923
Pavel Emelyanovdf97c702007-11-29 21:22:33 +11001924struct sk_buff *sk_stream_alloc_skb(struct sock *sk, int size, gfp_t gfp);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001925
1926static inline struct page *sk_stream_alloc_page(struct sock *sk)
1927{
1928 struct page *page = NULL;
1929
Herbert Xuef015782005-09-01 17:48:59 -07001930 page = alloc_pages(sk->sk_allocation, 0);
1931 if (!page) {
Glauber Costa180d8cd2011-12-11 21:47:02 +00001932 sk_enter_memory_pressure(sk);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001933 sk_stream_moderate_sndbuf(sk);
1934 }
1935 return page;
1936}
1937
Linus Torvalds1da177e2005-04-16 15:20:36 -07001938/*
1939 * Default write policy as shown to user space via poll/select/SIGIO
1940 */
1941static inline int sock_writeable(const struct sock *sk)
1942{
Eric Dumazet8df09ea2007-12-21 03:07:41 -08001943 return atomic_read(&sk->sk_wmem_alloc) < (sk->sk_sndbuf >> 1);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001944}
1945
Al Virodd0fc662005-10-07 07:46:04 +01001946static inline gfp_t gfp_any(void)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001947{
Andrew Morton99709372009-02-12 16:43:17 -08001948 return in_softirq() ? GFP_ATOMIC : GFP_KERNEL;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001949}
1950
1951static inline long sock_rcvtimeo(const struct sock *sk, int noblock)
1952{
1953 return noblock ? 0 : sk->sk_rcvtimeo;
1954}
1955
1956static inline long sock_sndtimeo(const struct sock *sk, int noblock)
1957{
1958 return noblock ? 0 : sk->sk_sndtimeo;
1959}
1960
1961static inline int sock_rcvlowat(const struct sock *sk, int waitall, int len)
1962{
1963 return (waitall ? len : min_t(int, sk->sk_rcvlowat, len)) ? : 1;
1964}
1965
1966/* Alas, with timeout socket operations are not restartable.
1967 * Compare this to poll().
1968 */
1969static inline int sock_intr_errno(long timeo)
1970{
1971 return timeo == MAX_SCHEDULE_TIMEOUT ? -ERESTARTSYS : -EINTR;
1972}
1973
Eric Dumazet92f37fd2007-03-25 22:14:49 -07001974extern void __sock_recv_timestamp(struct msghdr *msg, struct sock *sk,
1975 struct sk_buff *skb);
Johannes Berg6e3e9392011-11-09 10:15:42 +01001976extern void __sock_recv_wifi_status(struct msghdr *msg, struct sock *sk,
1977 struct sk_buff *skb);
Eric Dumazet92f37fd2007-03-25 22:14:49 -07001978
Linus Torvalds1da177e2005-04-16 15:20:36 -07001979static __inline__ void
1980sock_recv_timestamp(struct msghdr *msg, struct sock *sk, struct sk_buff *skb)
1981{
Eric Dumazetb7aa0bf2007-04-19 16:16:32 -07001982 ktime_t kt = skb->tstamp;
Patrick Ohly20d49472009-02-12 05:03:38 +00001983 struct skb_shared_hwtstamps *hwtstamps = skb_hwtstamps(skb);
Patrick McHardya61bbcf2005-08-14 17:24:31 -07001984
Patrick Ohly20d49472009-02-12 05:03:38 +00001985 /*
1986 * generate control messages if
1987 * - receive time stamping in software requested (SOCK_RCVTSTAMP
1988 * or SOCK_TIMESTAMPING_RX_SOFTWARE)
1989 * - software time stamp available and wanted
1990 * (SOCK_TIMESTAMPING_SOFTWARE)
1991 * - hardware time stamps available and wanted
1992 * (SOCK_TIMESTAMPING_SYS_HARDWARE or
1993 * SOCK_TIMESTAMPING_RAW_HARDWARE)
1994 */
1995 if (sock_flag(sk, SOCK_RCVTSTAMP) ||
1996 sock_flag(sk, SOCK_TIMESTAMPING_RX_SOFTWARE) ||
1997 (kt.tv64 && sock_flag(sk, SOCK_TIMESTAMPING_SOFTWARE)) ||
1998 (hwtstamps->hwtstamp.tv64 &&
1999 sock_flag(sk, SOCK_TIMESTAMPING_RAW_HARDWARE)) ||
2000 (hwtstamps->syststamp.tv64 &&
2001 sock_flag(sk, SOCK_TIMESTAMPING_SYS_HARDWARE)))
Eric Dumazet92f37fd2007-03-25 22:14:49 -07002002 __sock_recv_timestamp(msg, sk, skb);
2003 else
Eric Dumazetb7aa0bf2007-04-19 16:16:32 -07002004 sk->sk_stamp = kt;
Johannes Berg6e3e9392011-11-09 10:15:42 +01002005
2006 if (sock_flag(sk, SOCK_WIFI_STATUS) && skb->wifi_acked_valid)
2007 __sock_recv_wifi_status(msg, sk, skb);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002008}
2009
Eric Dumazet767dd032010-04-28 19:14:43 +00002010extern void __sock_recv_ts_and_drops(struct msghdr *msg, struct sock *sk,
2011 struct sk_buff *skb);
2012
2013static inline void sock_recv_ts_and_drops(struct msghdr *msg, struct sock *sk,
2014 struct sk_buff *skb)
2015{
2016#define FLAGS_TS_OR_DROPS ((1UL << SOCK_RXQ_OVFL) | \
2017 (1UL << SOCK_RCVTSTAMP) | \
2018 (1UL << SOCK_TIMESTAMPING_RX_SOFTWARE) | \
2019 (1UL << SOCK_TIMESTAMPING_SOFTWARE) | \
2020 (1UL << SOCK_TIMESTAMPING_RAW_HARDWARE) | \
2021 (1UL << SOCK_TIMESTAMPING_SYS_HARDWARE))
2022
2023 if (sk->sk_flags & FLAGS_TS_OR_DROPS)
2024 __sock_recv_ts_and_drops(msg, sk, skb);
2025 else
2026 sk->sk_stamp = skb->tstamp;
2027}
Neil Horman3b885782009-10-12 13:26:31 -07002028
Linus Torvalds1da177e2005-04-16 15:20:36 -07002029/**
Patrick Ohly20d49472009-02-12 05:03:38 +00002030 * sock_tx_timestamp - checks whether the outgoing packet is to be time stamped
Patrick Ohly20d49472009-02-12 05:03:38 +00002031 * @sk: socket sending this packet
Oliver Hartkopp2244d072010-08-17 08:59:14 +00002032 * @tx_flags: filled with instructions for time stamping
Patrick Ohly20d49472009-02-12 05:03:38 +00002033 *
2034 * Currently only depends on SOCK_TIMESTAMPING* flags. Returns error code if
2035 * parameters are invalid.
2036 */
Oliver Hartkopp2244d072010-08-17 08:59:14 +00002037extern int sock_tx_timestamp(struct sock *sk, __u8 *tx_flags);
Patrick Ohly20d49472009-02-12 05:03:38 +00002038
2039/**
Linus Torvalds1da177e2005-04-16 15:20:36 -07002040 * sk_eat_skb - Release a skb if it is no longer needed
Pavel Pisa4dc3b162005-05-01 08:59:25 -07002041 * @sk: socket to eat this skb from
2042 * @skb: socket buffer to eat
Randy Dunlapf4b8ea72006-06-22 16:00:11 -07002043 * @copied_early: flag indicating whether DMA operations copied this data early
Linus Torvalds1da177e2005-04-16 15:20:36 -07002044 *
2045 * This routine must be called with interrupts disabled or with the socket
2046 * locked so that the sk_buff queue operation is ok.
2047*/
Chris Leech624d1162006-05-23 18:01:28 -07002048#ifdef CONFIG_NET_DMA
2049static inline void sk_eat_skb(struct sock *sk, struct sk_buff *skb, int copied_early)
2050{
2051 __skb_unlink(skb, &sk->sk_receive_queue);
2052 if (!copied_early)
2053 __kfree_skb(skb);
2054 else
2055 __skb_queue_tail(&sk->sk_async_wait_queue, skb);
2056}
2057#else
2058static inline void sk_eat_skb(struct sock *sk, struct sk_buff *skb, int copied_early)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002059{
2060 __skb_unlink(skb, &sk->sk_receive_queue);
2061 __kfree_skb(skb);
2062}
Chris Leech624d1162006-05-23 18:01:28 -07002063#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -07002064
YOSHIFUJI Hideaki3b1e0a62008-03-26 02:26:21 +09002065static inline
2066struct net *sock_net(const struct sock *sk)
2067{
Eric Dumazetc2d9ba92010-06-01 06:51:19 +00002068 return read_pnet(&sk->sk_net);
YOSHIFUJI Hideaki3b1e0a62008-03-26 02:26:21 +09002069}
2070
2071static inline
Denis V. Lunevf5aa23f2008-03-26 00:48:17 -07002072void sock_net_set(struct sock *sk, struct net *net)
YOSHIFUJI Hideaki3b1e0a62008-03-26 02:26:21 +09002073{
Eric Dumazetc2d9ba92010-06-01 06:51:19 +00002074 write_pnet(&sk->sk_net, net);
YOSHIFUJI Hideaki3b1e0a62008-03-26 02:26:21 +09002075}
2076
Denis V. Lunevedf02082008-02-29 11:18:32 -08002077/*
2078 * Kernel sockets, f.e. rtnl or icmp_socket, are a part of a namespace.
Lucas De Marchi25985ed2011-03-30 22:57:33 -03002079 * They should not hold a reference to a namespace in order to allow
Denis V. Lunevedf02082008-02-29 11:18:32 -08002080 * to stop it.
2081 * Sockets after sk_change_net should be released using sk_release_kernel
2082 */
2083static inline void sk_change_net(struct sock *sk, struct net *net)
2084{
YOSHIFUJI Hideaki3b1e0a62008-03-26 02:26:21 +09002085 put_net(sock_net(sk));
Denis V. Lunev65a18ec2008-04-16 01:59:46 -07002086 sock_net_set(sk, hold_net(net));
Denis V. Lunevedf02082008-02-29 11:18:32 -08002087}
2088
KOVACS Krisztian23542612008-10-07 12:41:01 -07002089static inline struct sock *skb_steal_sock(struct sk_buff *skb)
2090{
2091 if (unlikely(skb->sk)) {
2092 struct sock *sk = skb->sk;
2093
2094 skb->destructor = NULL;
2095 skb->sk = NULL;
2096 return sk;
2097 }
2098 return NULL;
2099}
2100
Patrick Ohly20d49472009-02-12 05:03:38 +00002101extern void sock_enable_timestamp(struct sock *sk, int flag);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002102extern int sock_get_timestamp(struct sock *, struct timeval __user *);
Eric Dumazetae40eb12007-03-18 17:33:16 -07002103extern int sock_get_timestampns(struct sock *, struct timespec __user *);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002104
2105/*
2106 * Enable debug/info messages
2107 */
Stephen Hemmingera2a316f2007-03-08 20:41:08 -08002108extern int net_msg_warn;
2109#define NETDEBUG(fmt, args...) \
2110 do { if (net_msg_warn) printk(fmt,##args); } while (0)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002111
Stephen Hemmingera2a316f2007-03-08 20:41:08 -08002112#define LIMIT_NETDEBUG(fmt, args...) \
2113 do { if (net_msg_warn && net_ratelimit()) printk(fmt,##args); } while(0)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002114
Linus Torvalds1da177e2005-04-16 15:20:36 -07002115extern __u32 sysctl_wmem_max;
2116extern __u32 sysctl_rmem_max;
2117
Arnaldo Carvalho de Melo20380732005-08-16 02:18:02 -03002118extern void sk_init(void);
2119
David S. Miller6baf1f42005-09-05 18:14:11 -07002120extern int sysctl_optmem_max;
2121
Arnaldo Carvalho de Melo20380732005-08-16 02:18:02 -03002122extern __u32 sysctl_wmem_default;
2123extern __u32 sysctl_rmem_default;
Arnaldo Carvalho de Melo20380732005-08-16 02:18:02 -03002124
Linus Torvalds1da177e2005-04-16 15:20:36 -07002125#endif /* _SOCK_H */