blob: dcde2d9268cd109319f4631eba8b5b6c1af1d92e [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>
Ingo Molnarc5905af2012-02-24 08:31:31 +010058#include <linux/static_key.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070059
60#include <linux/filter.h>
Eric Dumazet88ab1932008-11-16 19:39:21 -080061#include <linux/rculist_nulls.h>
Jiri Olsaa57de0b2009-07-08 12:09:13 +000062#include <linux/poll.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070063
Eric Dumazetc31504d2010-11-15 19:58:26 +000064#include <linux/atomic.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070065#include <net/dst.h>
66#include <net/checksum.h>
67
Eric Dumazet9f048bf2011-12-13 03:59:08 +000068struct cgroup;
69struct cgroup_subsys;
Glauber Costac607b2e2011-12-16 00:52:00 +000070#ifdef CONFIG_NET
Glauber Costad1a4c0b2011-12-11 21:47:04 +000071int mem_cgroup_sockets_init(struct cgroup *cgrp, struct cgroup_subsys *ss);
72void mem_cgroup_sockets_destroy(struct cgroup *cgrp, struct cgroup_subsys *ss);
Glauber Costac607b2e2011-12-16 00:52:00 +000073#else
74static inline
75int mem_cgroup_sockets_init(struct cgroup *cgrp, struct cgroup_subsys *ss)
76{
77 return 0;
78}
79static inline
80void mem_cgroup_sockets_destroy(struct cgroup *cgrp, struct cgroup_subsys *ss)
81{
82}
83#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -070084/*
85 * This structure really needs to be cleaned up.
86 * Most of it is for TCP, and not used by any of
87 * the other protocols.
88 */
89
90/* Define this to get the SOCK_DBG debugging facility. */
91#define SOCK_DEBUGGING
92#ifdef SOCK_DEBUGGING
93#define SOCK_DEBUG(sk, msg...) do { if ((sk) && sock_flag((sk), SOCK_DBG)) \
94 printk(KERN_DEBUG msg); } while (0)
95#else
Stephen Hemminger4cd90292008-03-21 15:54:53 -070096/* Validate arguments and do nothing */
Joe Perchesb9075fa2011-10-31 17:11:33 -070097static inline __printf(2, 3)
98void SOCK_DEBUG(struct sock *sk, const char *msg, ...)
Stephen Hemminger4cd90292008-03-21 15:54:53 -070099{
100}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700101#endif
102
103/* This is the per-socket lock. The spinlock provides a synchronization
104 * between user contexts and software interrupt processing, whereas the
105 * mini-semaphore synchronizes multiple users amongst themselves.
106 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700107typedef struct {
108 spinlock_t slock;
John Heffnerd2e91172007-09-12 10:44:19 +0200109 int owned;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700110 wait_queue_head_t wq;
Ingo Molnara5b5bb92006-07-03 00:25:35 -0700111 /*
112 * We express the mutex-alike socket_lock semantics
113 * to the lock validator by explicitly managing
114 * the slock as a lock variant (in addition to
115 * the slock itself):
116 */
117#ifdef CONFIG_DEBUG_LOCK_ALLOC
118 struct lockdep_map dep_map;
119#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -0700120} socket_lock_t;
121
Linus Torvalds1da177e2005-04-16 15:20:36 -0700122struct sock;
Arnaldo Carvalho de Melo8feaf0c02005-08-09 20:09:30 -0700123struct proto;
Denis V. Lunev0eeb8ff2007-12-04 01:15:45 -0800124struct net;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700125
126/**
Pavel Pisa4dc3b162005-05-01 08:59:25 -0700127 * struct sock_common - minimal network layer representation of sockets
Eric Dumazet68835ab2010-11-30 19:04:07 +0000128 * @skc_daddr: Foreign IPv4 addr
129 * @skc_rcv_saddr: Bound local IPv4 addr
Eric Dumazet4dc6dc72009-07-15 23:13:10 +0000130 * @skc_hash: hash value used with various protocol lookup tables
Eric Dumazetd4cada42009-11-08 10:17:30 +0000131 * @skc_u16hashes: two u16 hash values used by UDP lookup tables
Pavel Pisa4dc3b162005-05-01 08:59:25 -0700132 * @skc_family: network address family
133 * @skc_state: Connection state
134 * @skc_reuse: %SO_REUSEADDR setting
135 * @skc_bound_dev_if: bound device index if != 0
Pavel Pisa4dc3b162005-05-01 08:59:25 -0700136 * @skc_bind_node: bind hash linkage for various protocol lookup tables
Eric Dumazet512615b2009-11-08 10:17:58 +0000137 * @skc_portaddr_node: second hash linkage for UDP/UDP-Lite protocol
Arnaldo Carvalho de Melo8feaf0c02005-08-09 20:09:30 -0700138 * @skc_prot: protocol handlers inside a network family
Eric W. Biederman07feaeb2007-09-12 11:58:02 +0200139 * @skc_net: reference to the network namespace of this socket
Eric Dumazet68835ab2010-11-30 19:04:07 +0000140 * @skc_node: main hash linkage for various protocol lookup tables
141 * @skc_nulls_node: main hash linkage for TCP/UDP/UDP-Lite protocol
142 * @skc_tx_queue_mapping: tx queue number for this connection
143 * @skc_refcnt: reference count
Pavel Pisa4dc3b162005-05-01 08:59:25 -0700144 *
145 * This is the minimal network layer representation of sockets, the header
Arnaldo Carvalho de Melo8feaf0c02005-08-09 20:09:30 -0700146 * for struct sock and struct inet_timewait_sock.
147 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700148struct sock_common {
Eric Dumazet68835ab2010-11-30 19:04:07 +0000149 /* skc_daddr and skc_rcv_saddr must be grouped :
150 * cf INET_MATCH() and INET_TW_MATCH()
Eric Dumazet4dc6dc72009-07-15 23:13:10 +0000151 */
Eric Dumazet68835ab2010-11-30 19:04:07 +0000152 __be32 skc_daddr;
153 __be32 skc_rcv_saddr;
Eric Dumazet4dc6dc72009-07-15 23:13:10 +0000154
Eric Dumazetd4cada42009-11-08 10:17:30 +0000155 union {
156 unsigned int skc_hash;
157 __u16 skc_u16hashes[2];
158 };
Eric Dumazet4dc6dc72009-07-15 23:13:10 +0000159 unsigned short skc_family;
160 volatile unsigned char skc_state;
161 unsigned char skc_reuse;
162 int skc_bound_dev_if;
Eric Dumazet512615b2009-11-08 10:17:58 +0000163 union {
164 struct hlist_node skc_bind_node;
165 struct hlist_nulls_node skc_portaddr_node;
166 };
Arnaldo Carvalho de Melo8feaf0c02005-08-09 20:09:30 -0700167 struct proto *skc_prot;
YOSHIFUJI Hideaki3b1e0a62008-03-26 02:26:21 +0900168#ifdef CONFIG_NET_NS
Eric W. Biederman07feaeb2007-09-12 11:58:02 +0200169 struct net *skc_net;
YOSHIFUJI Hideaki3b1e0a62008-03-26 02:26:21 +0900170#endif
Eric Dumazet68835ab2010-11-30 19:04:07 +0000171 /*
172 * fields between dontcopy_begin/dontcopy_end
173 * are not copied in sock_copy()
174 */
Randy Dunlap928c41e2011-01-08 17:39:21 +0000175 /* private: */
Eric Dumazet68835ab2010-11-30 19:04:07 +0000176 int skc_dontcopy_begin[0];
Randy Dunlap928c41e2011-01-08 17:39:21 +0000177 /* public: */
Eric Dumazet68835ab2010-11-30 19:04:07 +0000178 union {
179 struct hlist_node skc_node;
180 struct hlist_nulls_node skc_nulls_node;
181 };
182 int skc_tx_queue_mapping;
183 atomic_t skc_refcnt;
Randy Dunlap928c41e2011-01-08 17:39:21 +0000184 /* private: */
Eric Dumazet68835ab2010-11-30 19:04:07 +0000185 int skc_dontcopy_end[0];
Randy Dunlap928c41e2011-01-08 17:39:21 +0000186 /* public: */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700187};
188
Glauber Costae1aab162011-12-11 21:47:03 +0000189struct cg_proto;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700190/**
191 * struct sock - network layer representation of sockets
Arnaldo Carvalho de Melo8feaf0c02005-08-09 20:09:30 -0700192 * @__sk_common: shared layout with inet_timewait_sock
Pavel Pisa4dc3b162005-05-01 08:59:25 -0700193 * @sk_shutdown: mask of %SEND_SHUTDOWN and/or %RCV_SHUTDOWN
194 * @sk_userlocks: %SO_SNDBUF and %SO_RCVBUF settings
195 * @sk_lock: synchronizer
196 * @sk_rcvbuf: size of receive buffer in bytes
Eric Dumazet43815482010-04-29 11:01:49 +0000197 * @sk_wq: sock wait queue and async head
Pavel Pisa4dc3b162005-05-01 08:59:25 -0700198 * @sk_dst_cache: destination cache
199 * @sk_dst_lock: destination cache lock
200 * @sk_policy: flow policy
Pavel Pisa4dc3b162005-05-01 08:59:25 -0700201 * @sk_receive_queue: incoming packets
202 * @sk_wmem_alloc: transmit queue bytes committed
203 * @sk_write_queue: Packet sending queue
Chris Leech97fc2f02006-05-23 17:55:33 -0700204 * @sk_async_wait_queue: DMA copied packets
Pavel Pisa4dc3b162005-05-01 08:59:25 -0700205 * @sk_omem_alloc: "o" is "option" or "other"
206 * @sk_wmem_queued: persistent queue size
207 * @sk_forward_alloc: space allocated forward
208 * @sk_allocation: allocation mode
209 * @sk_sndbuf: size of send buffer in bytes
Wang Chen33c732c2007-11-13 20:30:01 -0800210 * @sk_flags: %SO_LINGER (l_onoff), %SO_BROADCAST, %SO_KEEPALIVE,
Patrick Ohly20d49472009-02-12 05:03:38 +0000211 * %SO_OOBINLINE settings, %SO_TIMESTAMPING settings
Pavel Pisa4dc3b162005-05-01 08:59:25 -0700212 * @sk_no_check: %SO_NO_CHECK setting, wether or not checkup packets
213 * @sk_route_caps: route capabilities (e.g. %NETIF_F_TSO)
Eric Dumazeta4654192010-05-16 00:36:33 -0700214 * @sk_route_nocaps: forbidden route capabilities (e.g NETIF_F_GSO_MASK)
Herbert Xubcd76112006-06-30 13:36:35 -0700215 * @sk_gso_type: GSO type (e.g. %SKB_GSO_TCPV4)
Peter P Waskiewicz Jr82cc1a72008-03-21 03:43:19 -0700216 * @sk_gso_max_size: Maximum GSO segment size to build
Pavel Pisa4dc3b162005-05-01 08:59:25 -0700217 * @sk_lingertime: %SO_LINGER l_linger setting
Pavel Pisa4dc3b162005-05-01 08:59:25 -0700218 * @sk_backlog: always used with the per-socket spinlock held
219 * @sk_callback_lock: used with the callbacks in the end of this struct
220 * @sk_error_queue: rarely used
Wang Chen33c732c2007-11-13 20:30:01 -0800221 * @sk_prot_creator: sk_prot of original sock creator (see ipv6_setsockopt,
222 * IPV6_ADDRFORM for instance)
Pavel Pisa4dc3b162005-05-01 08:59:25 -0700223 * @sk_err: last error
Wang Chen33c732c2007-11-13 20:30:01 -0800224 * @sk_err_soft: errors that don't cause failure but are the cause of a
225 * persistent failure not just 'timed out'
Eric Dumazetcb61cb92008-06-17 21:04:56 -0700226 * @sk_drops: raw/udp drops counter
Pavel Pisa4dc3b162005-05-01 08:59:25 -0700227 * @sk_ack_backlog: current listen backlog
228 * @sk_max_ack_backlog: listen backlog set in listen()
229 * @sk_priority: %SO_PRIORITY setting
Randy Dunlap1a3bc362012-01-21 09:03:10 +0000230 * @sk_cgrp_prioidx: socket group's priority map index
Pavel Pisa4dc3b162005-05-01 08:59:25 -0700231 * @sk_type: socket type (%SOCK_STREAM, etc)
232 * @sk_protocol: which protocol this socket belongs in this network family
Randy Dunlap53c3fa22010-08-09 13:41:07 +0000233 * @sk_peer_pid: &struct pid for this socket's peer
234 * @sk_peer_cred: %SO_PEERCRED setting
Pavel Pisa4dc3b162005-05-01 08:59:25 -0700235 * @sk_rcvlowat: %SO_RCVLOWAT setting
236 * @sk_rcvtimeo: %SO_RCVTIMEO setting
237 * @sk_sndtimeo: %SO_SNDTIMEO setting
David S. Millerc58dc012010-04-27 15:05:31 -0700238 * @sk_rxhash: flow hash received from netif layer
Pavel Pisa4dc3b162005-05-01 08:59:25 -0700239 * @sk_filter: socket filtering instructions
240 * @sk_protinfo: private area, net family specific, when not using slab
241 * @sk_timer: sock cleanup timer
242 * @sk_stamp: time stamp of last packet received
243 * @sk_socket: Identd and reporting IO signals
244 * @sk_user_data: RPC layer private data
245 * @sk_sndmsg_page: cached page for sendmsg
246 * @sk_sndmsg_off: cached offset for sendmsg
247 * @sk_send_head: front of stuff to transmit
Martin Waitz67be2dd2005-05-01 08:59:26 -0700248 * @sk_security: used by security modules
Randy Dunlap31729362008-02-18 20:52:13 -0800249 * @sk_mark: generic packet mark
Randy Dunlap53c3fa22010-08-09 13:41:07 +0000250 * @sk_classid: this socket's cgroup classid
Glauber Costae1aab162011-12-11 21:47:03 +0000251 * @sk_cgrp: this socket's cgroup-specific proto data
Pavel Pisa4dc3b162005-05-01 08:59:25 -0700252 * @sk_write_pending: a write to stream socket waits to start
253 * @sk_state_change: callback to indicate change in the state of the sock
254 * @sk_data_ready: callback to indicate there is data to be processed
255 * @sk_write_space: callback to indicate there is bf sending space available
256 * @sk_error_report: callback to indicate errors (e.g. %MSG_ERRQUEUE)
257 * @sk_backlog_rcv: callback to process the backlog
258 * @sk_destruct: called at sock freeing time, i.e. when all refcnt == 0
Linus Torvalds1da177e2005-04-16 15:20:36 -0700259 */
260struct sock {
261 /*
Arnaldo Carvalho de Melo8feaf0c02005-08-09 20:09:30 -0700262 * Now struct inet_timewait_sock also uses sock_common, so please just
Linus Torvalds1da177e2005-04-16 15:20:36 -0700263 * don't add nothing before this first member (__sk_common) --acme
264 */
265 struct sock_common __sk_common;
Eric Dumazet4dc6dc72009-07-15 23:13:10 +0000266#define sk_node __sk_common.skc_node
267#define sk_nulls_node __sk_common.skc_nulls_node
268#define sk_refcnt __sk_common.skc_refcnt
Krishna Kumare022f0b2009-10-19 23:46:20 +0000269#define sk_tx_queue_mapping __sk_common.skc_tx_queue_mapping
Eric Dumazet4dc6dc72009-07-15 23:13:10 +0000270
Eric Dumazet68835ab2010-11-30 19:04:07 +0000271#define sk_dontcopy_begin __sk_common.skc_dontcopy_begin
272#define sk_dontcopy_end __sk_common.skc_dontcopy_end
Eric Dumazet4dc6dc72009-07-15 23:13:10 +0000273#define sk_hash __sk_common.skc_hash
Linus Torvalds1da177e2005-04-16 15:20:36 -0700274#define sk_family __sk_common.skc_family
275#define sk_state __sk_common.skc_state
276#define sk_reuse __sk_common.skc_reuse
277#define sk_bound_dev_if __sk_common.skc_bound_dev_if
Linus Torvalds1da177e2005-04-16 15:20:36 -0700278#define sk_bind_node __sk_common.skc_bind_node
Arnaldo Carvalho de Melo8feaf0c02005-08-09 20:09:30 -0700279#define sk_prot __sk_common.skc_prot
Eric W. Biederman07feaeb2007-09-12 11:58:02 +0200280#define sk_net __sk_common.skc_net
Eric Dumazetb178bb32010-11-16 05:56:04 +0000281 socket_lock_t sk_lock;
282 struct sk_buff_head sk_receive_queue;
283 /*
284 * The backlog queue is special, it is always used with
285 * the per-socket spinlock held and requires low latency
286 * access. Therefore we special case it's implementation.
287 * Note : rmem_alloc is in this structure to fill a hole
288 * on 64bit arches, not because its logically part of
289 * backlog.
290 */
291 struct {
292 atomic_t rmem_alloc;
293 int len;
294 struct sk_buff *head;
295 struct sk_buff *tail;
296 } sk_backlog;
297#define sk_rmem_alloc sk_backlog.rmem_alloc
298 int sk_forward_alloc;
299#ifdef CONFIG_RPS
300 __u32 sk_rxhash;
301#endif
302 atomic_t sk_drops;
303 int sk_rcvbuf;
304
305 struct sk_filter __rcu *sk_filter;
Eric Dumazeteaefd112011-02-18 03:26:36 +0000306 struct socket_wq __rcu *sk_wq;
Eric Dumazetb178bb32010-11-16 05:56:04 +0000307
308#ifdef CONFIG_NET_DMA
309 struct sk_buff_head sk_async_wait_queue;
310#endif
311
312#ifdef CONFIG_XFRM
313 struct xfrm_policy *sk_policy[2];
314#endif
315 unsigned long sk_flags;
316 struct dst_entry *sk_dst_cache;
317 spinlock_t sk_dst_lock;
318 atomic_t sk_wmem_alloc;
319 atomic_t sk_omem_alloc;
320 int sk_sndbuf;
321 struct sk_buff_head sk_write_queue;
Vegard Nossuma98b65a2009-02-26 14:46:57 +0100322 kmemcheck_bitfield_begin(flags);
Eric Dumazet5fdb9972009-10-08 22:50:25 +0000323 unsigned int sk_shutdown : 2,
324 sk_no_check : 2,
325 sk_userlocks : 4,
326 sk_protocol : 8,
327 sk_type : 16;
Vegard Nossuma98b65a2009-02-26 14:46:57 +0100328 kmemcheck_bitfield_end(flags);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700329 int sk_wmem_queued;
Al Viro7d877f32005-10-21 03:20:43 -0400330 gfp_t sk_allocation;
Michał Mirosławc8f44af2011-11-15 15:29:55 +0000331 netdev_features_t sk_route_caps;
332 netdev_features_t sk_route_nocaps;
Herbert Xubcd76112006-06-30 13:36:35 -0700333 int sk_gso_type;
Peter P Waskiewicz Jr82cc1a72008-03-21 03:43:19 -0700334 unsigned int sk_gso_max_size;
David S. Miller9932cf92006-03-24 15:12:37 -0800335 int sk_rcvlowat;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700336 unsigned long sk_lingertime;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700337 struct sk_buff_head sk_error_queue;
Arnaldo Carvalho de Melo476e19c2005-05-05 13:35:15 -0700338 struct proto *sk_prot_creator;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700339 rwlock_t sk_callback_lock;
340 int sk_err,
341 sk_err_soft;
342 unsigned short sk_ack_backlog;
343 unsigned short sk_max_ack_backlog;
344 __u32 sk_priority;
Neil Horman5bc14212011-11-22 05:10:51 +0000345#ifdef CONFIG_CGROUPS
346 __u32 sk_cgrp_prioidx;
347#endif
Eric W. Biederman109f6e32010-06-13 03:30:14 +0000348 struct pid *sk_peer_pid;
349 const struct cred *sk_peer_cred;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700350 long sk_rcvtimeo;
351 long sk_sndtimeo;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700352 void *sk_protinfo;
353 struct timer_list sk_timer;
Eric Dumazetb7aa0bf2007-04-19 16:16:32 -0700354 ktime_t sk_stamp;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700355 struct socket *sk_socket;
356 void *sk_user_data;
357 struct page *sk_sndmsg_page;
358 struct sk_buff *sk_send_head;
359 __u32 sk_sndmsg_off;
360 int sk_write_pending;
Alexey Dobriyand5f64232008-11-04 14:45:58 -0800361#ifdef CONFIG_SECURITY
Linus Torvalds1da177e2005-04-16 15:20:36 -0700362 void *sk_security;
Alexey Dobriyand5f64232008-11-04 14:45:58 -0800363#endif
Laszlo Attila Toth4a19ec52008-01-30 19:08:16 -0800364 __u32 sk_mark;
Herbert Xuf8451722010-05-24 00:12:34 -0700365 u32 sk_classid;
Glauber Costae1aab162011-12-11 21:47:03 +0000366 struct cg_proto *sk_cgrp;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700367 void (*sk_state_change)(struct sock *sk);
368 void (*sk_data_ready)(struct sock *sk, int bytes);
369 void (*sk_write_space)(struct sock *sk);
370 void (*sk_error_report)(struct sock *sk);
371 int (*sk_backlog_rcv)(struct sock *sk,
372 struct sk_buff *skb);
373 void (*sk_destruct)(struct sock *sk);
374};
375
376/*
377 * Hashed lists helper routines
378 */
Li Zefanc4146642010-02-08 23:18:45 +0000379static inline struct sock *sk_entry(const struct hlist_node *node)
380{
381 return hlist_entry(node, struct sock, sk_node);
382}
383
Arnaldo Carvalho de Meloe48c4142005-08-09 20:09:46 -0700384static inline struct sock *__sk_head(const struct hlist_head *head)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700385{
386 return hlist_entry(head->first, struct sock, sk_node);
387}
388
Arnaldo Carvalho de Meloe48c4142005-08-09 20:09:46 -0700389static inline struct sock *sk_head(const struct hlist_head *head)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700390{
391 return hlist_empty(head) ? NULL : __sk_head(head);
392}
393
Eric Dumazet88ab1932008-11-16 19:39:21 -0800394static inline struct sock *__sk_nulls_head(const struct hlist_nulls_head *head)
395{
396 return hlist_nulls_entry(head->first, struct sock, sk_nulls_node);
397}
398
399static inline struct sock *sk_nulls_head(const struct hlist_nulls_head *head)
400{
401 return hlist_nulls_empty(head) ? NULL : __sk_nulls_head(head);
402}
403
Arnaldo Carvalho de Meloe48c4142005-08-09 20:09:46 -0700404static inline struct sock *sk_next(const struct sock *sk)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700405{
406 return sk->sk_node.next ?
407 hlist_entry(sk->sk_node.next, struct sock, sk_node) : NULL;
408}
409
Eric Dumazet88ab1932008-11-16 19:39:21 -0800410static inline struct sock *sk_nulls_next(const struct sock *sk)
411{
412 return (!is_a_nulls(sk->sk_nulls_node.next)) ?
413 hlist_nulls_entry(sk->sk_nulls_node.next,
414 struct sock, sk_nulls_node) :
415 NULL;
416}
417
Arnaldo Carvalho de Meloe48c4142005-08-09 20:09:46 -0700418static inline int sk_unhashed(const struct sock *sk)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700419{
420 return hlist_unhashed(&sk->sk_node);
421}
422
Arnaldo Carvalho de Meloe48c4142005-08-09 20:09:46 -0700423static inline int sk_hashed(const struct sock *sk)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700424{
Akinobu Mitada753be2006-04-28 15:21:23 -0700425 return !sk_unhashed(sk);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700426}
427
428static __inline__ void sk_node_init(struct hlist_node *node)
429{
430 node->pprev = NULL;
431}
432
Eric Dumazet88ab1932008-11-16 19:39:21 -0800433static __inline__ void sk_nulls_node_init(struct hlist_nulls_node *node)
434{
435 node->pprev = NULL;
436}
437
Linus Torvalds1da177e2005-04-16 15:20:36 -0700438static __inline__ void __sk_del_node(struct sock *sk)
439{
440 __hlist_del(&sk->sk_node);
441}
442
stephen hemminger808f5112010-02-22 07:57:18 +0000443/* NB: equivalent to hlist_del_init_rcu */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700444static __inline__ int __sk_del_node_init(struct sock *sk)
445{
446 if (sk_hashed(sk)) {
447 __sk_del_node(sk);
448 sk_node_init(&sk->sk_node);
449 return 1;
450 }
451 return 0;
452}
453
454/* Grab socket reference count. This operation is valid only
455 when sk is ALREADY grabbed f.e. it is found in hash table
456 or a list and the lookup is made under lock preventing hash table
457 modifications.
458 */
459
460static inline void sock_hold(struct sock *sk)
461{
462 atomic_inc(&sk->sk_refcnt);
463}
464
465/* Ungrab socket in the context, which assumes that socket refcnt
466 cannot hit zero, f.e. it is true in context of any socketcall.
467 */
468static inline void __sock_put(struct sock *sk)
469{
470 atomic_dec(&sk->sk_refcnt);
471}
472
473static __inline__ int sk_del_node_init(struct sock *sk)
474{
475 int rc = __sk_del_node_init(sk);
476
477 if (rc) {
478 /* paranoid for a while -acme */
479 WARN_ON(atomic_read(&sk->sk_refcnt) == 1);
480 __sock_put(sk);
481 }
482 return rc;
483}
stephen hemminger808f5112010-02-22 07:57:18 +0000484#define sk_del_node_init_rcu(sk) sk_del_node_init(sk)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700485
Eric Dumazet88ab1932008-11-16 19:39:21 -0800486static __inline__ int __sk_nulls_del_node_init_rcu(struct sock *sk)
Eric Dumazet271b72c2008-10-29 02:11:14 -0700487{
488 if (sk_hashed(sk)) {
Eric Dumazet88ab1932008-11-16 19:39:21 -0800489 hlist_nulls_del_init_rcu(&sk->sk_nulls_node);
Eric Dumazet271b72c2008-10-29 02:11:14 -0700490 return 1;
491 }
492 return 0;
493}
494
Eric Dumazet88ab1932008-11-16 19:39:21 -0800495static __inline__ int sk_nulls_del_node_init_rcu(struct sock *sk)
Eric Dumazet271b72c2008-10-29 02:11:14 -0700496{
Eric Dumazet88ab1932008-11-16 19:39:21 -0800497 int rc = __sk_nulls_del_node_init_rcu(sk);
Eric Dumazet271b72c2008-10-29 02:11:14 -0700498
499 if (rc) {
500 /* paranoid for a while -acme */
501 WARN_ON(atomic_read(&sk->sk_refcnt) == 1);
502 __sock_put(sk);
503 }
504 return rc;
505}
506
Linus Torvalds1da177e2005-04-16 15:20:36 -0700507static __inline__ void __sk_add_node(struct sock *sk, struct hlist_head *list)
508{
509 hlist_add_head(&sk->sk_node, list);
510}
511
512static __inline__ void sk_add_node(struct sock *sk, struct hlist_head *list)
513{
514 sock_hold(sk);
515 __sk_add_node(sk, list);
516}
517
stephen hemminger808f5112010-02-22 07:57:18 +0000518static __inline__ void sk_add_node_rcu(struct sock *sk, struct hlist_head *list)
519{
520 sock_hold(sk);
521 hlist_add_head_rcu(&sk->sk_node, list);
522}
523
Eric Dumazet88ab1932008-11-16 19:39:21 -0800524static __inline__ void __sk_nulls_add_node_rcu(struct sock *sk, struct hlist_nulls_head *list)
Eric Dumazet271b72c2008-10-29 02:11:14 -0700525{
Eric Dumazet88ab1932008-11-16 19:39:21 -0800526 hlist_nulls_add_head_rcu(&sk->sk_nulls_node, list);
Eric Dumazet271b72c2008-10-29 02:11:14 -0700527}
528
Eric Dumazet88ab1932008-11-16 19:39:21 -0800529static __inline__ void sk_nulls_add_node_rcu(struct sock *sk, struct hlist_nulls_head *list)
Eric Dumazet271b72c2008-10-29 02:11:14 -0700530{
531 sock_hold(sk);
Eric Dumazet88ab1932008-11-16 19:39:21 -0800532 __sk_nulls_add_node_rcu(sk, list);
Eric Dumazet271b72c2008-10-29 02:11:14 -0700533}
534
Linus Torvalds1da177e2005-04-16 15:20:36 -0700535static __inline__ void __sk_del_bind_node(struct sock *sk)
536{
537 __hlist_del(&sk->sk_bind_node);
538}
539
540static __inline__ void sk_add_bind_node(struct sock *sk,
541 struct hlist_head *list)
542{
543 hlist_add_head(&sk->sk_bind_node, list);
544}
545
546#define sk_for_each(__sk, node, list) \
547 hlist_for_each_entry(__sk, node, list, sk_node)
stephen hemminger808f5112010-02-22 07:57:18 +0000548#define sk_for_each_rcu(__sk, node, list) \
549 hlist_for_each_entry_rcu(__sk, node, list, sk_node)
Eric Dumazet88ab1932008-11-16 19:39:21 -0800550#define sk_nulls_for_each(__sk, node, list) \
551 hlist_nulls_for_each_entry(__sk, node, list, sk_nulls_node)
552#define sk_nulls_for_each_rcu(__sk, node, list) \
553 hlist_nulls_for_each_entry_rcu(__sk, node, list, sk_nulls_node)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700554#define sk_for_each_from(__sk, node) \
555 if (__sk && ({ node = &(__sk)->sk_node; 1; })) \
556 hlist_for_each_entry_from(__sk, node, sk_node)
Eric Dumazet88ab1932008-11-16 19:39:21 -0800557#define sk_nulls_for_each_from(__sk, node) \
558 if (__sk && ({ node = &(__sk)->sk_nulls_node; 1; })) \
559 hlist_nulls_for_each_entry_from(__sk, node, sk_nulls_node)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700560#define sk_for_each_safe(__sk, node, tmp, list) \
561 hlist_for_each_entry_safe(__sk, node, tmp, list, sk_node)
562#define sk_for_each_bound(__sk, node, list) \
563 hlist_for_each_entry(__sk, node, list, sk_bind_node)
564
565/* Sock flags */
566enum sock_flags {
567 SOCK_DEAD,
568 SOCK_DONE,
569 SOCK_URGINLINE,
570 SOCK_KEEPOPEN,
571 SOCK_LINGER,
572 SOCK_DESTROY,
573 SOCK_BROADCAST,
574 SOCK_TIMESTAMP,
575 SOCK_ZAPPED,
576 SOCK_USE_WRITE_QUEUE, /* whether to call sk->sk_write_space in sock_wfree */
577 SOCK_DBG, /* %SO_DEBUG setting */
578 SOCK_RCVTSTAMP, /* %SO_TIMESTAMP setting */
Eric Dumazet92f37fd2007-03-25 22:14:49 -0700579 SOCK_RCVTSTAMPNS, /* %SO_TIMESTAMPNS setting */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700580 SOCK_LOCALROUTE, /* route locally only, %SO_DONTROUTE setting */
581 SOCK_QUEUE_SHRUNK, /* write queue has been shrunk recently */
Patrick Ohly20d49472009-02-12 05:03:38 +0000582 SOCK_TIMESTAMPING_TX_HARDWARE, /* %SOF_TIMESTAMPING_TX_HARDWARE */
583 SOCK_TIMESTAMPING_TX_SOFTWARE, /* %SOF_TIMESTAMPING_TX_SOFTWARE */
584 SOCK_TIMESTAMPING_RX_HARDWARE, /* %SOF_TIMESTAMPING_RX_HARDWARE */
585 SOCK_TIMESTAMPING_RX_SOFTWARE, /* %SOF_TIMESTAMPING_RX_SOFTWARE */
586 SOCK_TIMESTAMPING_SOFTWARE, /* %SOF_TIMESTAMPING_SOFTWARE */
587 SOCK_TIMESTAMPING_RAW_HARDWARE, /* %SOF_TIMESTAMPING_RAW_HARDWARE */
588 SOCK_TIMESTAMPING_SYS_HARDWARE, /* %SOF_TIMESTAMPING_SYS_HARDWARE */
Eric Dumazetbcdce712009-10-06 17:28:29 -0700589 SOCK_FASYNC, /* fasync() active */
Neil Horman3b885782009-10-12 13:26:31 -0700590 SOCK_RXQ_OVFL,
Shirley Ma1cdebb42011-07-06 12:17:30 +0000591 SOCK_ZEROCOPY, /* buffers from userspace */
Johannes Berg6e3e9392011-11-09 10:15:42 +0100592 SOCK_WIFI_STATUS, /* push wifi status to userspace */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700593};
594
Ralf Baechle53b924b2005-08-23 10:11:30 -0700595static inline void sock_copy_flags(struct sock *nsk, struct sock *osk)
596{
597 nsk->sk_flags = osk->sk_flags;
598}
599
Linus Torvalds1da177e2005-04-16 15:20:36 -0700600static inline void sock_set_flag(struct sock *sk, enum sock_flags flag)
601{
602 __set_bit(flag, &sk->sk_flags);
603}
604
605static inline void sock_reset_flag(struct sock *sk, enum sock_flags flag)
606{
607 __clear_bit(flag, &sk->sk_flags);
608}
609
610static inline int sock_flag(struct sock *sk, enum sock_flags flag)
611{
612 return test_bit(flag, &sk->sk_flags);
613}
614
615static inline void sk_acceptq_removed(struct sock *sk)
616{
617 sk->sk_ack_backlog--;
618}
619
620static inline void sk_acceptq_added(struct sock *sk)
621{
622 sk->sk_ack_backlog++;
623}
624
625static inline int sk_acceptq_is_full(struct sock *sk)
626{
David S. Miller64a14652007-03-06 11:21:05 -0800627 return sk->sk_ack_backlog > sk->sk_max_ack_backlog;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700628}
629
630/*
631 * Compute minimal free write space needed to queue new packets.
632 */
633static inline int sk_stream_min_wspace(struct sock *sk)
634{
Eric Dumazet8df09ea2007-12-21 03:07:41 -0800635 return sk->sk_wmem_queued >> 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700636}
637
638static inline int sk_stream_wspace(struct sock *sk)
639{
640 return sk->sk_sndbuf - sk->sk_wmem_queued;
641}
642
643extern void sk_stream_write_space(struct sock *sk);
644
645static inline int sk_stream_memory_free(struct sock *sk)
646{
647 return sk->sk_wmem_queued < sk->sk_sndbuf;
648}
649
Zhu Yi8eae9392010-03-04 18:01:40 +0000650/* OOB backlog add */
Zhu Yia3a858f2010-03-04 18:01:47 +0000651static inline void __sk_add_backlog(struct sock *sk, struct sk_buff *skb)
Stephen Hemminger9ee6b532005-11-08 09:39:42 -0800652{
Eric Dumazet7fee2262010-05-11 23:19:48 +0000653 /* dont let skb dst not refcounted, we are going to leave rcu lock */
654 skb_dst_force(skb);
655
656 if (!sk->sk_backlog.tail)
657 sk->sk_backlog.head = skb;
658 else
Stephen Hemminger9ee6b532005-11-08 09:39:42 -0800659 sk->sk_backlog.tail->next = skb;
Eric Dumazet7fee2262010-05-11 23:19:48 +0000660
661 sk->sk_backlog.tail = skb;
Stephen Hemminger9ee6b532005-11-08 09:39:42 -0800662 skb->next = NULL;
663}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700664
Eric Dumazetc3774112010-04-27 15:13:20 -0700665/*
666 * Take into account size of receive queue and backlog queue
Eric Dumazet0fd7bac2011-12-21 07:11:44 +0000667 * Do not take into account this skb truesize,
668 * to allow even a single big packet to come.
Eric Dumazetc3774112010-04-27 15:13:20 -0700669 */
670static inline bool sk_rcvqueues_full(const struct sock *sk, const struct sk_buff *skb)
671{
672 unsigned int qsize = sk->sk_backlog.len + atomic_read(&sk->sk_rmem_alloc);
673
Eric Dumazet0fd7bac2011-12-21 07:11:44 +0000674 return qsize > sk->sk_rcvbuf;
Eric Dumazetc3774112010-04-27 15:13:20 -0700675}
676
Zhu Yi8eae9392010-03-04 18:01:40 +0000677/* The per-socket spinlock must be held here. */
Zhu Yi40456352010-03-07 16:21:39 +0000678static inline __must_check int sk_add_backlog(struct sock *sk, struct sk_buff *skb)
Zhu Yi8eae9392010-03-04 18:01:40 +0000679{
Eric Dumazetc3774112010-04-27 15:13:20 -0700680 if (sk_rcvqueues_full(sk, skb))
Zhu Yi8eae9392010-03-04 18:01:40 +0000681 return -ENOBUFS;
682
Zhu Yia3a858f2010-03-04 18:01:47 +0000683 __sk_add_backlog(sk, skb);
Zhu Yi8eae9392010-03-04 18:01:40 +0000684 sk->sk_backlog.len += skb->truesize;
685 return 0;
686}
687
Peter Zijlstrac57943a2008-10-07 14:18:42 -0700688static inline int sk_backlog_rcv(struct sock *sk, struct sk_buff *skb)
689{
690 return sk->sk_backlog_rcv(sk, skb);
691}
692
David S. Millerc58dc012010-04-27 15:05:31 -0700693static inline void sock_rps_record_flow(const struct sock *sk)
694{
695#ifdef CONFIG_RPS
696 struct rps_sock_flow_table *sock_flow_table;
697
698 rcu_read_lock();
699 sock_flow_table = rcu_dereference(rps_sock_flow_table);
700 rps_record_sock_flow(sock_flow_table, sk->sk_rxhash);
701 rcu_read_unlock();
702#endif
703}
704
705static inline void sock_rps_reset_flow(const struct sock *sk)
706{
707#ifdef CONFIG_RPS
708 struct rps_sock_flow_table *sock_flow_table;
709
710 rcu_read_lock();
711 sock_flow_table = rcu_dereference(rps_sock_flow_table);
712 rps_reset_sock_flow(sock_flow_table, sk->sk_rxhash);
713 rcu_read_unlock();
714#endif
715}
716
Tom Herbertbdeab992011-08-14 19:45:55 +0000717static inline void sock_rps_save_rxhash(struct sock *sk,
718 const struct sk_buff *skb)
David S. Millerc58dc012010-04-27 15:05:31 -0700719{
720#ifdef CONFIG_RPS
Tom Herbertbdeab992011-08-14 19:45:55 +0000721 if (unlikely(sk->sk_rxhash != skb->rxhash)) {
David S. Millerc58dc012010-04-27 15:05:31 -0700722 sock_rps_reset_flow(sk);
Tom Herbertbdeab992011-08-14 19:45:55 +0000723 sk->sk_rxhash = skb->rxhash;
David S. Millerc58dc012010-04-27 15:05:31 -0700724 }
725#endif
726}
727
Tom Herbertbdeab992011-08-14 19:45:55 +0000728static inline void sock_rps_reset_rxhash(struct sock *sk)
729{
730#ifdef CONFIG_RPS
731 sock_rps_reset_flow(sk);
732 sk->sk_rxhash = 0;
733#endif
734}
735
Stephen Hemmingercfcabdc2007-10-09 01:59:42 -0700736#define sk_wait_event(__sk, __timeo, __condition) \
737 ({ int __rc; \
738 release_sock(__sk); \
739 __rc = __condition; \
740 if (!__rc) { \
741 *(__timeo) = schedule_timeout(*(__timeo)); \
742 } \
743 lock_sock(__sk); \
744 __rc = __condition; \
745 __rc; \
746 })
Linus Torvalds1da177e2005-04-16 15:20:36 -0700747
748extern int sk_stream_wait_connect(struct sock *sk, long *timeo_p);
749extern int sk_stream_wait_memory(struct sock *sk, long *timeo_p);
750extern void sk_stream_wait_close(struct sock *sk, long timeo_p);
751extern int sk_stream_error(struct sock *sk, int flags, int err);
752extern void sk_stream_kill_queues(struct sock *sk);
753
754extern int sk_wait_data(struct sock *sk, long *timeo);
755
Arnaldo Carvalho de Melo60236fd2005-06-18 22:47:21 -0700756struct request_sock_ops;
Arnaldo Carvalho de Melo6d6ee432005-12-13 23:25:19 -0800757struct timewait_sock_ops;
Arnaldo Carvalho de Meloab1e0a12008-02-03 04:06:04 -0800758struct inet_hashinfo;
Pavel Emelyanovfc8717b2008-03-22 16:56:51 -0700759struct raw_hashinfo;
Paul Gortmakerde477252011-05-26 13:46:22 -0400760struct module;
Arnaldo Carvalho de Melo2e6599c2005-06-18 22:46:52 -0700761
Linus Torvalds1da177e2005-04-16 15:20:36 -0700762/* Networking protocol blocks we attach to sockets.
763 * socket layer -> transport layer interface
764 * transport -> network interface is defined by struct inet_proto
765 */
766struct proto {
767 void (*close)(struct sock *sk,
768 long timeout);
769 int (*connect)(struct sock *sk,
770 struct sockaddr *uaddr,
771 int addr_len);
772 int (*disconnect)(struct sock *sk, int flags);
773
774 struct sock * (*accept) (struct sock *sk, int flags, int *err);
775
776 int (*ioctl)(struct sock *sk, int cmd,
777 unsigned long arg);
778 int (*init)(struct sock *sk);
Brian Haley7d06b2e2008-06-14 17:04:49 -0700779 void (*destroy)(struct sock *sk);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700780 void (*shutdown)(struct sock *sk, int how);
781 int (*setsockopt)(struct sock *sk, int level,
782 int optname, char __user *optval,
David S. Millerb7058842009-09-30 16:12:20 -0700783 unsigned int optlen);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700784 int (*getsockopt)(struct sock *sk, int level,
785 int optname, char __user *optval,
786 int __user *option);
Alexey Dobriyanaf01d532008-08-28 02:53:51 -0700787#ifdef CONFIG_COMPAT
Dmitry Mishin3fdadf72006-03-20 22:45:21 -0800788 int (*compat_setsockopt)(struct sock *sk,
789 int level,
790 int optname, char __user *optval,
David S. Millerb7058842009-09-30 16:12:20 -0700791 unsigned int optlen);
Dmitry Mishin3fdadf72006-03-20 22:45:21 -0800792 int (*compat_getsockopt)(struct sock *sk,
793 int level,
794 int optname, char __user *optval,
795 int __user *option);
Eric W. Biederman709b46e2011-01-29 16:15:56 +0000796 int (*compat_ioctl)(struct sock *sk,
797 unsigned int cmd, unsigned long arg);
Alexey Dobriyanaf01d532008-08-28 02:53:51 -0700798#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -0700799 int (*sendmsg)(struct kiocb *iocb, struct sock *sk,
800 struct msghdr *msg, size_t len);
801 int (*recvmsg)(struct kiocb *iocb, struct sock *sk,
802 struct msghdr *msg,
803 size_t len, int noblock, int flags,
804 int *addr_len);
805 int (*sendpage)(struct sock *sk, struct page *page,
806 int offset, size_t size, int flags);
807 int (*bind)(struct sock *sk,
808 struct sockaddr *uaddr, int addr_len);
809
810 int (*backlog_rcv) (struct sock *sk,
811 struct sk_buff *skb);
812
813 /* Keeping track of sk's, looking them up, and port selection methods. */
814 void (*hash)(struct sock *sk);
815 void (*unhash)(struct sock *sk);
Eric Dumazet719f8352010-09-08 05:08:44 +0000816 void (*rehash)(struct sock *sk);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700817 int (*get_port)(struct sock *sk, unsigned short snum);
Octavian Purdilafcbdf092010-12-16 14:26:56 -0800818 void (*clear_sk)(struct sock *sk, int size);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700819
Eric Dumazet286ab3d2007-11-05 23:38:39 -0800820 /* Keeping track of sockets in use */
Eric Dumazet65f76512008-01-03 20:46:48 -0800821#ifdef CONFIG_PROC_FS
Pavel Emelyanov13ff3d62008-03-28 16:38:17 -0700822 unsigned int inuse_idx;
Eric Dumazet65f76512008-01-03 20:46:48 -0800823#endif
Arnaldo Carvalho de Meloebb53d72007-11-21 22:08:50 +0800824
Linus Torvalds1da177e2005-04-16 15:20:36 -0700825 /* Memory pressure */
Pavel Emelyanov5c52ba12008-07-16 20:28:10 -0700826 void (*enter_memory_pressure)(struct sock *sk);
Eric Dumazet8d987e52010-11-09 23:24:26 +0000827 atomic_long_t *memory_allocated; /* Current allocated memory. */
Eric Dumazet17483762008-11-25 21:16:35 -0800828 struct percpu_counter *sockets_allocated; /* Current number of sockets. */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700829 /*
830 * Pressure flag: try to collapse.
831 * Technical note: it is used by multiple contexts non atomically.
Hideo Aoki3ab224b2007-12-31 00:11:19 -0800832 * All the __sk_mem_schedule() is of this nature: accounting
Linus Torvalds1da177e2005-04-16 15:20:36 -0700833 * is strict, actions are advisory and have some latency.
834 */
835 int *memory_pressure;
Eric Dumazet8d987e52010-11-09 23:24:26 +0000836 long *sysctl_mem;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700837 int *sysctl_wmem;
838 int *sysctl_rmem;
839 int max_header;
Changli Gao7ba42912010-07-10 20:41:55 +0000840 bool no_autobind;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700841
Eric Dumazet271b72c2008-10-29 02:11:14 -0700842 struct kmem_cache *slab;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700843 unsigned int obj_size;
Eric Dumazet271b72c2008-10-29 02:11:14 -0700844 int slab_flags;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700845
Eric Dumazetdd24c002008-11-25 21:17:14 -0800846 struct percpu_counter *orphan_count;
Arnaldo Carvalho de Melo8feaf0c02005-08-09 20:09:30 -0700847
Arnaldo Carvalho de Melo60236fd2005-06-18 22:47:21 -0700848 struct request_sock_ops *rsk_prot;
Arnaldo Carvalho de Melo6d6ee432005-12-13 23:25:19 -0800849 struct timewait_sock_ops *twsk_prot;
Arnaldo Carvalho de Melo2e6599c2005-06-18 22:46:52 -0700850
Pavel Emelyanov39d8cda2008-03-22 16:50:58 -0700851 union {
852 struct inet_hashinfo *hashinfo;
Eric Dumazet645ca702008-10-29 01:41:45 -0700853 struct udp_table *udp_table;
Pavel Emelyanovfc8717b2008-03-22 16:56:51 -0700854 struct raw_hashinfo *raw_hash;
Pavel Emelyanov39d8cda2008-03-22 16:50:58 -0700855 } h;
Arnaldo Carvalho de Meloab1e0a12008-02-03 04:06:04 -0800856
Linus Torvalds1da177e2005-04-16 15:20:36 -0700857 struct module *owner;
858
859 char name[32];
860
861 struct list_head node;
Arnaldo Carvalho de Meloe6848972005-08-09 19:45:38 -0700862#ifdef SOCK_REFCNT_DEBUG
863 atomic_t socks;
864#endif
Glauber Costae1aab162011-12-11 21:47:03 +0000865#ifdef CONFIG_CGROUP_MEM_RES_CTLR_KMEM
866 /*
867 * cgroup specific init/deinit functions. Called once for all
868 * protocols that implement it, from cgroups populate function.
869 * This function has to setup any files the protocol want to
870 * appear in the kmem cgroup filesystem.
871 */
872 int (*init_cgroup)(struct cgroup *cgrp,
873 struct cgroup_subsys *ss);
874 void (*destroy_cgroup)(struct cgroup *cgrp,
875 struct cgroup_subsys *ss);
876 struct cg_proto *(*proto_cgroup)(struct mem_cgroup *memcg);
877#endif
878};
879
880struct cg_proto {
881 void (*enter_memory_pressure)(struct sock *sk);
882 struct res_counter *memory_allocated; /* Current allocated memory. */
883 struct percpu_counter *sockets_allocated; /* Current number of sockets. */
884 int *memory_pressure;
885 long *sysctl_mem;
886 /*
887 * memcg field is used to find which memcg we belong directly
888 * Each memcg struct can hold more than one cg_proto, so container_of
889 * won't really cut.
890 *
891 * The elegant solution would be having an inverse function to
892 * proto_cgroup in struct proto, but that means polluting the structure
893 * for everybody, instead of just for memcg users.
894 */
895 struct mem_cgroup *memcg;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700896};
897
898extern int proto_register(struct proto *prot, int alloc_slab);
899extern void proto_unregister(struct proto *prot);
900
Arnaldo Carvalho de Meloe6848972005-08-09 19:45:38 -0700901#ifdef SOCK_REFCNT_DEBUG
902static inline void sk_refcnt_debug_inc(struct sock *sk)
903{
904 atomic_inc(&sk->sk_prot->socks);
905}
906
907static inline void sk_refcnt_debug_dec(struct sock *sk)
908{
909 atomic_dec(&sk->sk_prot->socks);
910 printk(KERN_DEBUG "%s socket %p released, %d are still alive\n",
911 sk->sk_prot->name, sk, atomic_read(&sk->sk_prot->socks));
912}
913
Glauber Costae1aab162011-12-11 21:47:03 +0000914inline void sk_refcnt_debug_release(const struct sock *sk)
Arnaldo Carvalho de Meloe6848972005-08-09 19:45:38 -0700915{
916 if (atomic_read(&sk->sk_refcnt) != 1)
917 printk(KERN_DEBUG "Destruction of the %s socket %p delayed, refcnt=%d\n",
918 sk->sk_prot->name, sk, atomic_read(&sk->sk_refcnt));
919}
920#else /* SOCK_REFCNT_DEBUG */
921#define sk_refcnt_debug_inc(sk) do { } while (0)
922#define sk_refcnt_debug_dec(sk) do { } while (0)
923#define sk_refcnt_debug_release(sk) do { } while (0)
924#endif /* SOCK_REFCNT_DEBUG */
925
Glauber Costa376be5f2012-01-20 04:57:14 +0000926#if defined(CONFIG_CGROUP_MEM_RES_CTLR_KMEM) && defined(CONFIG_NET)
Ingo Molnarc5905af2012-02-24 08:31:31 +0100927extern struct static_key memcg_socket_limit_enabled;
Glauber Costae1aab162011-12-11 21:47:03 +0000928static inline struct cg_proto *parent_cg_proto(struct proto *proto,
929 struct cg_proto *cg_proto)
930{
931 return proto->proto_cgroup(parent_mem_cgroup(cg_proto->memcg));
932}
Ingo Molnarc5905af2012-02-24 08:31:31 +0100933#define mem_cgroup_sockets_enabled static_key_false(&memcg_socket_limit_enabled)
Glauber Costae1aab162011-12-11 21:47:03 +0000934#else
935#define mem_cgroup_sockets_enabled 0
936static inline struct cg_proto *parent_cg_proto(struct proto *proto,
937 struct cg_proto *cg_proto)
938{
939 return NULL;
940}
941#endif
942
943
Glauber Costa180d8cd2011-12-11 21:47:02 +0000944static inline bool sk_has_memory_pressure(const struct sock *sk)
945{
946 return sk->sk_prot->memory_pressure != NULL;
947}
948
949static inline bool sk_under_memory_pressure(const struct sock *sk)
950{
951 if (!sk->sk_prot->memory_pressure)
952 return false;
Glauber Costae1aab162011-12-11 21:47:03 +0000953
954 if (mem_cgroup_sockets_enabled && sk->sk_cgrp)
955 return !!*sk->sk_cgrp->memory_pressure;
956
Glauber Costa180d8cd2011-12-11 21:47:02 +0000957 return !!*sk->sk_prot->memory_pressure;
958}
959
960static inline void sk_leave_memory_pressure(struct sock *sk)
961{
962 int *memory_pressure = sk->sk_prot->memory_pressure;
963
Glauber Costae1aab162011-12-11 21:47:03 +0000964 if (!memory_pressure)
965 return;
966
967 if (*memory_pressure)
Glauber Costa180d8cd2011-12-11 21:47:02 +0000968 *memory_pressure = 0;
Glauber Costae1aab162011-12-11 21:47:03 +0000969
970 if (mem_cgroup_sockets_enabled && sk->sk_cgrp) {
971 struct cg_proto *cg_proto = sk->sk_cgrp;
972 struct proto *prot = sk->sk_prot;
973
974 for (; cg_proto; cg_proto = parent_cg_proto(prot, cg_proto))
975 if (*cg_proto->memory_pressure)
976 *cg_proto->memory_pressure = 0;
977 }
978
Glauber Costa180d8cd2011-12-11 21:47:02 +0000979}
980
981static inline void sk_enter_memory_pressure(struct sock *sk)
982{
Glauber Costae1aab162011-12-11 21:47:03 +0000983 if (!sk->sk_prot->enter_memory_pressure)
984 return;
985
986 if (mem_cgroup_sockets_enabled && sk->sk_cgrp) {
987 struct cg_proto *cg_proto = sk->sk_cgrp;
988 struct proto *prot = sk->sk_prot;
989
990 for (; cg_proto; cg_proto = parent_cg_proto(prot, cg_proto))
991 cg_proto->enter_memory_pressure(sk);
992 }
993
994 sk->sk_prot->enter_memory_pressure(sk);
Glauber Costa180d8cd2011-12-11 21:47:02 +0000995}
996
997static inline long sk_prot_mem_limits(const struct sock *sk, int index)
998{
999 long *prot = sk->sk_prot->sysctl_mem;
Glauber Costae1aab162011-12-11 21:47:03 +00001000 if (mem_cgroup_sockets_enabled && sk->sk_cgrp)
1001 prot = sk->sk_cgrp->sysctl_mem;
Glauber Costa180d8cd2011-12-11 21:47:02 +00001002 return prot[index];
1003}
1004
Glauber Costae1aab162011-12-11 21:47:03 +00001005static inline void memcg_memory_allocated_add(struct cg_proto *prot,
1006 unsigned long amt,
1007 int *parent_status)
1008{
1009 struct res_counter *fail;
1010 int ret;
1011
Glauber Costa0e90b312012-01-20 04:57:16 +00001012 ret = res_counter_charge_nofail(prot->memory_allocated,
1013 amt << PAGE_SHIFT, &fail);
Glauber Costae1aab162011-12-11 21:47:03 +00001014 if (ret < 0)
1015 *parent_status = OVER_LIMIT;
1016}
1017
1018static inline void memcg_memory_allocated_sub(struct cg_proto *prot,
1019 unsigned long amt)
1020{
1021 res_counter_uncharge(prot->memory_allocated, amt << PAGE_SHIFT);
1022}
1023
1024static inline u64 memcg_memory_allocated_read(struct cg_proto *prot)
1025{
1026 u64 ret;
1027 ret = res_counter_read_u64(prot->memory_allocated, RES_USAGE);
1028 return ret >> PAGE_SHIFT;
1029}
1030
Glauber Costa180d8cd2011-12-11 21:47:02 +00001031static inline long
1032sk_memory_allocated(const struct sock *sk)
1033{
1034 struct proto *prot = sk->sk_prot;
Glauber Costae1aab162011-12-11 21:47:03 +00001035 if (mem_cgroup_sockets_enabled && sk->sk_cgrp)
1036 return memcg_memory_allocated_read(sk->sk_cgrp);
1037
Glauber Costa180d8cd2011-12-11 21:47:02 +00001038 return atomic_long_read(prot->memory_allocated);
1039}
1040
1041static inline long
Glauber Costae1aab162011-12-11 21:47:03 +00001042sk_memory_allocated_add(struct sock *sk, int amt, int *parent_status)
Glauber Costa180d8cd2011-12-11 21:47:02 +00001043{
1044 struct proto *prot = sk->sk_prot;
Glauber Costae1aab162011-12-11 21:47:03 +00001045
1046 if (mem_cgroup_sockets_enabled && sk->sk_cgrp) {
1047 memcg_memory_allocated_add(sk->sk_cgrp, amt, parent_status);
1048 /* update the root cgroup regardless */
1049 atomic_long_add_return(amt, prot->memory_allocated);
1050 return memcg_memory_allocated_read(sk->sk_cgrp);
1051 }
1052
Glauber Costa180d8cd2011-12-11 21:47:02 +00001053 return atomic_long_add_return(amt, prot->memory_allocated);
1054}
1055
1056static inline void
Glauber Costa0e90b312012-01-20 04:57:16 +00001057sk_memory_allocated_sub(struct sock *sk, int amt)
Glauber Costa180d8cd2011-12-11 21:47:02 +00001058{
1059 struct proto *prot = sk->sk_prot;
Glauber Costae1aab162011-12-11 21:47:03 +00001060
Glauber Costa0e90b312012-01-20 04:57:16 +00001061 if (mem_cgroup_sockets_enabled && sk->sk_cgrp)
Glauber Costae1aab162011-12-11 21:47:03 +00001062 memcg_memory_allocated_sub(sk->sk_cgrp, amt);
1063
Glauber Costa180d8cd2011-12-11 21:47:02 +00001064 atomic_long_sub(amt, prot->memory_allocated);
1065}
1066
1067static inline void sk_sockets_allocated_dec(struct sock *sk)
1068{
1069 struct proto *prot = sk->sk_prot;
Glauber Costae1aab162011-12-11 21:47:03 +00001070
1071 if (mem_cgroup_sockets_enabled && sk->sk_cgrp) {
1072 struct cg_proto *cg_proto = sk->sk_cgrp;
1073
1074 for (; cg_proto; cg_proto = parent_cg_proto(prot, cg_proto))
1075 percpu_counter_dec(cg_proto->sockets_allocated);
1076 }
1077
Glauber Costa180d8cd2011-12-11 21:47:02 +00001078 percpu_counter_dec(prot->sockets_allocated);
1079}
1080
1081static inline void sk_sockets_allocated_inc(struct sock *sk)
1082{
1083 struct proto *prot = sk->sk_prot;
Glauber Costae1aab162011-12-11 21:47:03 +00001084
1085 if (mem_cgroup_sockets_enabled && sk->sk_cgrp) {
1086 struct cg_proto *cg_proto = sk->sk_cgrp;
1087
1088 for (; cg_proto; cg_proto = parent_cg_proto(prot, cg_proto))
1089 percpu_counter_inc(cg_proto->sockets_allocated);
1090 }
1091
Glauber Costa180d8cd2011-12-11 21:47:02 +00001092 percpu_counter_inc(prot->sockets_allocated);
1093}
1094
1095static inline int
1096sk_sockets_allocated_read_positive(struct sock *sk)
1097{
1098 struct proto *prot = sk->sk_prot;
1099
Glauber Costae1aab162011-12-11 21:47:03 +00001100 if (mem_cgroup_sockets_enabled && sk->sk_cgrp)
1101 return percpu_counter_sum_positive(sk->sk_cgrp->sockets_allocated);
1102
Glauber Costa180d8cd2011-12-11 21:47:02 +00001103 return percpu_counter_sum_positive(prot->sockets_allocated);
1104}
1105
1106static inline int
1107proto_sockets_allocated_sum_positive(struct proto *prot)
1108{
1109 return percpu_counter_sum_positive(prot->sockets_allocated);
1110}
1111
1112static inline long
1113proto_memory_allocated(struct proto *prot)
1114{
1115 return atomic_long_read(prot->memory_allocated);
1116}
1117
1118static inline bool
1119proto_memory_pressure(struct proto *prot)
1120{
1121 if (!prot->memory_pressure)
1122 return false;
1123 return !!*prot->memory_pressure;
1124}
1125
Eric Dumazet65f76512008-01-03 20:46:48 -08001126
1127#ifdef CONFIG_PROC_FS
Linus Torvalds1da177e2005-04-16 15:20:36 -07001128/* Called with local bh disabled */
Pavel Emelyanovc29a0bc2008-03-31 19:41:46 -07001129extern void sock_prot_inuse_add(struct net *net, struct proto *prot, int inc);
1130extern int sock_prot_inuse_get(struct net *net, struct proto *proto);
Eric Dumazet65f76512008-01-03 20:46:48 -08001131#else
Pavel Emelyanovc29a0bc2008-03-31 19:41:46 -07001132static void inline sock_prot_inuse_add(struct net *net, struct proto *prot,
1133 int inc)
Eric Dumazet65f76512008-01-03 20:46:48 -08001134{
1135}
Eric Dumazet65f76512008-01-03 20:46:48 -08001136#endif
1137
Linus Torvalds1da177e2005-04-16 15:20:36 -07001138
Arnaldo Carvalho de Melo614c6cb2005-08-09 19:47:37 -07001139/* With per-bucket locks this operation is not-atomic, so that
1140 * this version is not worse.
1141 */
1142static inline void __sk_prot_rehash(struct sock *sk)
1143{
1144 sk->sk_prot->unhash(sk);
1145 sk->sk_prot->hash(sk);
1146}
1147
Octavian Purdilafcbdf092010-12-16 14:26:56 -08001148void sk_prot_clear_portaddr_nulls(struct sock *sk, int size);
1149
Linus Torvalds1da177e2005-04-16 15:20:36 -07001150/* About 10 seconds */
1151#define SOCK_DESTROY_TIME (10*HZ)
1152
1153/* Sockets 0-1023 can't be bound to unless you are superuser */
1154#define PROT_SOCK 1024
1155
1156#define SHUTDOWN_MASK 3
1157#define RCV_SHUTDOWN 1
1158#define SEND_SHUTDOWN 2
1159
1160#define SOCK_SNDBUF_LOCK 1
1161#define SOCK_RCVBUF_LOCK 2
1162#define SOCK_BINDADDR_LOCK 4
1163#define SOCK_BINDPORT_LOCK 8
1164
1165/* sock_iocb: used to kick off async processing of socket ios */
1166struct sock_iocb {
1167 struct list_head list;
1168
1169 int flags;
1170 int size;
1171 struct socket *sock;
1172 struct sock *sk;
1173 struct scm_cookie *scm;
1174 struct msghdr *msg, async_msg;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001175 struct kiocb *kiocb;
1176};
1177
1178static inline struct sock_iocb *kiocb_to_siocb(struct kiocb *iocb)
1179{
1180 return (struct sock_iocb *)iocb->private;
1181}
1182
1183static inline struct kiocb *siocb_to_kiocb(struct sock_iocb *si)
1184{
1185 return si->kiocb;
1186}
1187
1188struct socket_alloc {
1189 struct socket socket;
1190 struct inode vfs_inode;
1191};
1192
1193static inline struct socket *SOCKET_I(struct inode *inode)
1194{
1195 return &container_of(inode, struct socket_alloc, vfs_inode)->socket;
1196}
1197
1198static inline struct inode *SOCK_INODE(struct socket *socket)
1199{
1200 return &container_of(socket, struct socket_alloc, socket)->vfs_inode;
1201}
1202
Hideo Aoki3ab224b2007-12-31 00:11:19 -08001203/*
1204 * Functions for memory accounting
1205 */
1206extern int __sk_mem_schedule(struct sock *sk, int size, int kind);
1207extern void __sk_mem_reclaim(struct sock *sk);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001208
Hideo Aoki3ab224b2007-12-31 00:11:19 -08001209#define SK_MEM_QUANTUM ((int)PAGE_SIZE)
1210#define SK_MEM_QUANTUM_SHIFT ilog2(SK_MEM_QUANTUM)
1211#define SK_MEM_SEND 0
1212#define SK_MEM_RECV 1
Linus Torvalds1da177e2005-04-16 15:20:36 -07001213
Hideo Aoki3ab224b2007-12-31 00:11:19 -08001214static inline int sk_mem_pages(int amt)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001215{
Hideo Aoki3ab224b2007-12-31 00:11:19 -08001216 return (amt + SK_MEM_QUANTUM - 1) >> SK_MEM_QUANTUM_SHIFT;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001217}
1218
Hideo Aoki3ab224b2007-12-31 00:11:19 -08001219static inline int sk_has_account(struct sock *sk)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001220{
Hideo Aoki3ab224b2007-12-31 00:11:19 -08001221 /* return true if protocol supports memory accounting */
1222 return !!sk->sk_prot->memory_allocated;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001223}
1224
Hideo Aoki3ab224b2007-12-31 00:11:19 -08001225static inline int sk_wmem_schedule(struct sock *sk, int size)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001226{
Hideo Aoki3ab224b2007-12-31 00:11:19 -08001227 if (!sk_has_account(sk))
1228 return 1;
Herbert Xud80d99d2005-09-01 17:48:23 -07001229 return size <= sk->sk_forward_alloc ||
Hideo Aoki3ab224b2007-12-31 00:11:19 -08001230 __sk_mem_schedule(sk, size, SK_MEM_SEND);
1231}
1232
1233static inline int sk_rmem_schedule(struct sock *sk, int size)
1234{
1235 if (!sk_has_account(sk))
1236 return 1;
1237 return size <= sk->sk_forward_alloc ||
1238 __sk_mem_schedule(sk, size, SK_MEM_RECV);
1239}
1240
1241static inline void sk_mem_reclaim(struct sock *sk)
1242{
1243 if (!sk_has_account(sk))
1244 return;
1245 if (sk->sk_forward_alloc >= SK_MEM_QUANTUM)
1246 __sk_mem_reclaim(sk);
1247}
1248
David S. Miller9993e7d2008-01-10 21:56:38 -08001249static inline void sk_mem_reclaim_partial(struct sock *sk)
1250{
1251 if (!sk_has_account(sk))
1252 return;
1253 if (sk->sk_forward_alloc > SK_MEM_QUANTUM)
1254 __sk_mem_reclaim(sk);
1255}
1256
Hideo Aoki3ab224b2007-12-31 00:11:19 -08001257static inline void sk_mem_charge(struct sock *sk, int size)
1258{
1259 if (!sk_has_account(sk))
1260 return;
1261 sk->sk_forward_alloc -= size;
1262}
1263
1264static inline void sk_mem_uncharge(struct sock *sk, int size)
1265{
1266 if (!sk_has_account(sk))
1267 return;
1268 sk->sk_forward_alloc += size;
1269}
1270
1271static inline void sk_wmem_free_skb(struct sock *sk, struct sk_buff *skb)
1272{
Hideo Aoki3ab224b2007-12-31 00:11:19 -08001273 sock_set_flag(sk, SOCK_QUEUE_SHRUNK);
1274 sk->sk_wmem_queued -= skb->truesize;
1275 sk_mem_uncharge(sk, skb->truesize);
1276 __kfree_skb(skb);
Herbert Xud80d99d2005-09-01 17:48:23 -07001277}
1278
Linus Torvalds1da177e2005-04-16 15:20:36 -07001279/* Used by processes to "lock" a socket state, so that
1280 * interrupts and bottom half handlers won't change it
1281 * from under us. It essentially blocks any incoming
1282 * packets, so that we won't get any new data or any
1283 * packets that change the state of the socket.
1284 *
1285 * While locked, BH processing will add new packets to
1286 * the backlog queue. This queue is processed by the
1287 * owner of the socket lock right before it is released.
1288 *
1289 * Since ~2.3.5 it is also exclusive sleep lock serializing
1290 * accesses from user process context.
1291 */
John Heffnerd2e91172007-09-12 10:44:19 +02001292#define sock_owned_by_user(sk) ((sk)->sk_lock.owned)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001293
Peter Zijlstraed075362006-12-06 20:35:24 -08001294/*
1295 * Macro so as to not evaluate some arguments when
1296 * lockdep is not enabled.
1297 *
1298 * Mark both the sk_lock and the sk_lock.slock as a
1299 * per-address-family lock class.
1300 */
1301#define sock_lock_init_class_and_name(sk, sname, skey, name, key) \
1302do { \
Ingo Molnare8f6fbf2008-11-12 01:38:36 +00001303 sk->sk_lock.owned = 0; \
Peter Zijlstraed075362006-12-06 20:35:24 -08001304 init_waitqueue_head(&sk->sk_lock.wq); \
1305 spin_lock_init(&(sk)->sk_lock.slock); \
1306 debug_check_no_locks_freed((void *)&(sk)->sk_lock, \
1307 sizeof((sk)->sk_lock)); \
1308 lockdep_set_class_and_name(&(sk)->sk_lock.slock, \
1309 (skey), (sname)); \
1310 lockdep_init_map(&(sk)->sk_lock.dep_map, (name), (key), 0); \
1311} while (0)
1312
Harvey Harrison41380932007-12-12 10:46:51 -08001313extern void lock_sock_nested(struct sock *sk, int subclass);
Peter Zijlstrafcc70d52006-11-08 22:44:35 -08001314
1315static inline void lock_sock(struct sock *sk)
1316{
1317 lock_sock_nested(sk, 0);
1318}
1319
Harvey Harrison41380932007-12-12 10:46:51 -08001320extern void release_sock(struct sock *sk);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001321
1322/* BH context may only use the following locking interface. */
1323#define bh_lock_sock(__sk) spin_lock(&((__sk)->sk_lock.slock))
Ingo Molnarc6366182006-07-03 00:25:13 -07001324#define bh_lock_sock_nested(__sk) \
1325 spin_lock_nested(&((__sk)->sk_lock.slock), \
1326 SINGLE_DEPTH_NESTING)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001327#define bh_unlock_sock(__sk) spin_unlock(&((__sk)->sk_lock.slock))
1328
Eric Dumazet8a74ad62010-05-26 19:20:18 +00001329extern bool lock_sock_fast(struct sock *sk);
1330/**
1331 * unlock_sock_fast - complement of lock_sock_fast
1332 * @sk: socket
1333 * @slow: slow mode
1334 *
1335 * fast unlock socket for user context.
1336 * If slow mode is on, we call regular release_sock()
1337 */
1338static inline void unlock_sock_fast(struct sock *sk, bool slow)
Eric Dumazet4b0b72f2010-04-28 14:35:48 -07001339{
Eric Dumazet8a74ad62010-05-26 19:20:18 +00001340 if (slow)
1341 release_sock(sk);
1342 else
1343 spin_unlock_bh(&sk->sk_lock.slock);
Eric Dumazet4b0b72f2010-04-28 14:35:48 -07001344}
1345
Eric Dumazet4b0b72f2010-04-28 14:35:48 -07001346
Eric W. Biederman1b8d7ae2007-10-08 23:24:22 -07001347extern struct sock *sk_alloc(struct net *net, int family,
Al Virodd0fc662005-10-07 07:46:04 +01001348 gfp_t priority,
Pavel Emelyanov6257ff22007-11-01 00:39:31 -07001349 struct proto *prot);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001350extern void sk_free(struct sock *sk);
Denis V. Lunevedf02082008-02-29 11:18:32 -08001351extern void sk_release_kernel(struct sock *sk);
Eric Dumazete56c57d2011-11-08 17:07:07 -05001352extern struct sock *sk_clone_lock(const struct sock *sk,
1353 const gfp_t priority);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001354
1355extern struct sk_buff *sock_wmalloc(struct sock *sk,
1356 unsigned long size, int force,
Al Virodd0fc662005-10-07 07:46:04 +01001357 gfp_t priority);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001358extern struct sk_buff *sock_rmalloc(struct sock *sk,
1359 unsigned long size, int force,
Al Virodd0fc662005-10-07 07:46:04 +01001360 gfp_t priority);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001361extern void sock_wfree(struct sk_buff *skb);
1362extern void sock_rfree(struct sk_buff *skb);
1363
1364extern int sock_setsockopt(struct socket *sock, int level,
1365 int op, char __user *optval,
David S. Millerb7058842009-09-30 16:12:20 -07001366 unsigned int optlen);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001367
1368extern int sock_getsockopt(struct socket *sock, int level,
1369 int op, char __user *optval,
1370 int __user *optlen);
1371extern struct sk_buff *sock_alloc_send_skb(struct sock *sk,
1372 unsigned long size,
1373 int noblock,
1374 int *errcode);
Herbert Xu4cc7f682009-02-04 16:55:54 -08001375extern struct sk_buff *sock_alloc_send_pskb(struct sock *sk,
1376 unsigned long header_len,
1377 unsigned long data_len,
1378 int noblock,
1379 int *errcode);
Victor Fusco86a76ca2005-07-08 14:57:47 -07001380extern void *sock_kmalloc(struct sock *sk, int size,
Al Virodd0fc662005-10-07 07:46:04 +01001381 gfp_t priority);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001382extern void sock_kfree_s(struct sock *sk, void *mem, int size);
1383extern void sk_send_sigurg(struct sock *sk);
1384
Herbert Xuf8451722010-05-24 00:12:34 -07001385#ifdef CONFIG_CGROUPS
1386extern void sock_update_classid(struct sock *sk);
1387#else
1388static inline void sock_update_classid(struct sock *sk)
1389{
1390}
1391#endif
1392
Linus Torvalds1da177e2005-04-16 15:20:36 -07001393/*
1394 * Functions to fill in entries in struct proto_ops when a protocol
1395 * does not implement a particular function.
1396 */
1397extern int sock_no_bind(struct socket *,
1398 struct sockaddr *, int);
1399extern int sock_no_connect(struct socket *,
1400 struct sockaddr *, int, int);
1401extern int sock_no_socketpair(struct socket *,
1402 struct socket *);
1403extern int sock_no_accept(struct socket *,
1404 struct socket *, int);
1405extern int sock_no_getname(struct socket *,
1406 struct sockaddr *, int *, int);
1407extern unsigned int sock_no_poll(struct file *, struct socket *,
1408 struct poll_table_struct *);
1409extern int sock_no_ioctl(struct socket *, unsigned int,
1410 unsigned long);
1411extern int sock_no_listen(struct socket *, int);
1412extern int sock_no_shutdown(struct socket *, int);
1413extern int sock_no_getsockopt(struct socket *, int , int,
1414 char __user *, int __user *);
1415extern int sock_no_setsockopt(struct socket *, int, int,
David S. Millerb7058842009-09-30 16:12:20 -07001416 char __user *, unsigned int);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001417extern int sock_no_sendmsg(struct kiocb *, struct socket *,
1418 struct msghdr *, size_t);
1419extern int sock_no_recvmsg(struct kiocb *, struct socket *,
1420 struct msghdr *, size_t, int);
1421extern int sock_no_mmap(struct file *file,
1422 struct socket *sock,
1423 struct vm_area_struct *vma);
1424extern ssize_t sock_no_sendpage(struct socket *sock,
1425 struct page *page,
1426 int offset, size_t size,
1427 int flags);
1428
1429/*
1430 * Functions to fill in entries in struct proto_ops when a protocol
1431 * uses the inet style.
1432 */
1433extern int sock_common_getsockopt(struct socket *sock, int level, int optname,
1434 char __user *optval, int __user *optlen);
1435extern int sock_common_recvmsg(struct kiocb *iocb, struct socket *sock,
1436 struct msghdr *msg, size_t size, int flags);
1437extern int sock_common_setsockopt(struct socket *sock, int level, int optname,
David S. Millerb7058842009-09-30 16:12:20 -07001438 char __user *optval, unsigned int optlen);
Dmitry Mishin3fdadf72006-03-20 22:45:21 -08001439extern int compat_sock_common_getsockopt(struct socket *sock, int level,
1440 int optname, char __user *optval, int __user *optlen);
1441extern int compat_sock_common_setsockopt(struct socket *sock, int level,
David S. Millerb7058842009-09-30 16:12:20 -07001442 int optname, char __user *optval, unsigned int optlen);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001443
1444extern void sk_common_release(struct sock *sk);
1445
1446/*
1447 * Default socket callbacks and setup code
1448 */
1449
1450/* Initialise core socket variables */
1451extern void sock_init_data(struct socket *sock, struct sock *sk);
1452
Eric Dumazet46bcf142010-12-06 09:29:43 -08001453extern void sk_filter_release_rcu(struct rcu_head *rcu);
1454
Linus Torvalds1da177e2005-04-16 15:20:36 -07001455/**
Ben Hutchings1a5778a2010-02-14 22:35:47 -08001456 * sk_filter_release - release a socket filter
Paul Bonserdc9b3342006-11-23 17:56:13 -08001457 * @fp: filter to remove
1458 *
1459 * Remove a filter from a socket and release its resources.
1460 */
1461
Pavel Emelyanov309dd5f2007-10-17 21:21:51 -07001462static inline void sk_filter_release(struct sk_filter *fp)
1463{
1464 if (atomic_dec_and_test(&fp->refcnt))
Eric Dumazet80f8f102011-01-18 07:46:52 +00001465 call_rcu(&fp->rcu, sk_filter_release_rcu);
Pavel Emelyanov309dd5f2007-10-17 21:21:51 -07001466}
1467
1468static inline void sk_filter_uncharge(struct sock *sk, struct sk_filter *fp)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001469{
1470 unsigned int size = sk_filter_len(fp);
1471
1472 atomic_sub(size, &sk->sk_omem_alloc);
Pavel Emelyanov309dd5f2007-10-17 21:21:51 -07001473 sk_filter_release(fp);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001474}
1475
1476static inline void sk_filter_charge(struct sock *sk, struct sk_filter *fp)
1477{
1478 atomic_inc(&fp->refcnt);
1479 atomic_add(sk_filter_len(fp), &sk->sk_omem_alloc);
1480}
1481
1482/*
1483 * Socket reference counting postulates.
1484 *
1485 * * Each user of socket SHOULD hold a reference count.
1486 * * Each access point to socket (an hash table bucket, reference from a list,
1487 * running timer, skb in flight MUST hold a reference count.
1488 * * When reference count hits 0, it means it will never increase back.
1489 * * When reference count hits 0, it means that no references from
1490 * outside exist to this socket and current process on current CPU
1491 * is last user and may/should destroy this socket.
1492 * * sk_free is called from any context: process, BH, IRQ. When
1493 * it is called, socket has no references from outside -> sk_free
1494 * may release descendant resources allocated by the socket, but
1495 * to the time when it is called, socket is NOT referenced by any
1496 * hash tables, lists etc.
1497 * * Packets, delivered from outside (from network or from another process)
1498 * and enqueued on receive/error queues SHOULD NOT grab reference count,
1499 * when they sit in queue. Otherwise, packets will leak to hole, when
1500 * socket is looked up by one cpu and unhasing is made by another CPU.
1501 * It is true for udp/raw, netlink (leak to receive and error queues), tcp
1502 * (leak to backlog). Packet socket does all the processing inside
1503 * BR_NETPROTO_LOCK, so that it has not this race condition. UNIX sockets
1504 * use separate SMP lock, so that they are prone too.
1505 */
1506
1507/* Ungrab socket and destroy it, if it was the last reference. */
1508static inline void sock_put(struct sock *sk)
1509{
1510 if (atomic_dec_and_test(&sk->sk_refcnt))
1511 sk_free(sk);
1512}
1513
Arnaldo Carvalho de Melo58a5a7b2006-11-16 14:06:06 -02001514extern int sk_receive_skb(struct sock *sk, struct sk_buff *skb,
1515 const int nested);
Arnaldo Carvalho de Melo25995ff2005-12-27 02:42:22 -02001516
Krishna Kumare022f0b2009-10-19 23:46:20 +00001517static inline void sk_tx_queue_set(struct sock *sk, int tx_queue)
1518{
1519 sk->sk_tx_queue_mapping = tx_queue;
1520}
1521
1522static inline void sk_tx_queue_clear(struct sock *sk)
1523{
1524 sk->sk_tx_queue_mapping = -1;
1525}
1526
1527static inline int sk_tx_queue_get(const struct sock *sk)
1528{
Tom Herbertb0f77d02010-07-14 20:50:29 -07001529 return sk ? sk->sk_tx_queue_mapping : -1;
Krishna Kumare022f0b2009-10-19 23:46:20 +00001530}
1531
David S. Miller972692e2008-06-17 22:41:38 -07001532static inline void sk_set_socket(struct sock *sk, struct socket *sock)
1533{
Krishna Kumare022f0b2009-10-19 23:46:20 +00001534 sk_tx_queue_clear(sk);
David S. Miller972692e2008-06-17 22:41:38 -07001535 sk->sk_socket = sock;
1536}
1537
Eric Dumazetaa395142010-04-20 13:03:51 +00001538static inline wait_queue_head_t *sk_sleep(struct sock *sk)
1539{
Eric Dumazeteaefd112011-02-18 03:26:36 +00001540 BUILD_BUG_ON(offsetof(struct socket_wq, wait) != 0);
1541 return &rcu_dereference_raw(sk->sk_wq)->wait;
Eric Dumazetaa395142010-04-20 13:03:51 +00001542}
Linus Torvalds1da177e2005-04-16 15:20:36 -07001543/* Detach socket from process context.
1544 * Announce socket dead, detach it from wait queue and inode.
1545 * Note that parent inode held reference count on this struct sock,
1546 * we do not release it in this function, because protocol
1547 * probably wants some additional cleanups or even continuing
1548 * to work with this socket (TCP).
1549 */
1550static inline void sock_orphan(struct sock *sk)
1551{
1552 write_lock_bh(&sk->sk_callback_lock);
1553 sock_set_flag(sk, SOCK_DEAD);
David S. Miller972692e2008-06-17 22:41:38 -07001554 sk_set_socket(sk, NULL);
Eric Dumazet43815482010-04-29 11:01:49 +00001555 sk->sk_wq = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001556 write_unlock_bh(&sk->sk_callback_lock);
1557}
1558
1559static inline void sock_graft(struct sock *sk, struct socket *parent)
1560{
1561 write_lock_bh(&sk->sk_callback_lock);
Eric Dumazeteaefd112011-02-18 03:26:36 +00001562 sk->sk_wq = parent->wq;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001563 parent->sk = sk;
David S. Miller972692e2008-06-17 22:41:38 -07001564 sk_set_socket(sk, parent);
Venkat Yekkirala4237c752006-07-24 23:32:50 -07001565 security_sock_graft(sk, parent);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001566 write_unlock_bh(&sk->sk_callback_lock);
1567}
1568
1569extern int sock_i_uid(struct sock *sk);
1570extern unsigned long sock_i_ino(struct sock *sk);
1571
1572static inline struct dst_entry *
1573__sk_dst_get(struct sock *sk)
1574{
Michal Hockod8bf4ca2011-07-08 14:39:41 +02001575 return rcu_dereference_check(sk->sk_dst_cache, sock_owned_by_user(sk) ||
Eric Dumazetf68c2242010-04-22 16:06:59 -07001576 lockdep_is_held(&sk->sk_lock.slock));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001577}
1578
1579static inline struct dst_entry *
1580sk_dst_get(struct sock *sk)
1581{
1582 struct dst_entry *dst;
1583
Eric Dumazetb6c67122010-04-08 23:03:29 +00001584 rcu_read_lock();
1585 dst = rcu_dereference(sk->sk_dst_cache);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001586 if (dst)
1587 dst_hold(dst);
Eric Dumazetb6c67122010-04-08 23:03:29 +00001588 rcu_read_unlock();
Linus Torvalds1da177e2005-04-16 15:20:36 -07001589 return dst;
1590}
1591
Eric Dumazetb6c67122010-04-08 23:03:29 +00001592extern void sk_reset_txq(struct sock *sk);
1593
1594static inline void dst_negative_advice(struct sock *sk)
1595{
1596 struct dst_entry *ndst, *dst = __sk_dst_get(sk);
1597
1598 if (dst && dst->ops->negative_advice) {
1599 ndst = dst->ops->negative_advice(dst);
1600
1601 if (ndst != dst) {
1602 rcu_assign_pointer(sk->sk_dst_cache, ndst);
1603 sk_reset_txq(sk);
1604 }
1605 }
1606}
1607
Linus Torvalds1da177e2005-04-16 15:20:36 -07001608static inline void
1609__sk_dst_set(struct sock *sk, struct dst_entry *dst)
1610{
1611 struct dst_entry *old_dst;
1612
Krishna Kumare022f0b2009-10-19 23:46:20 +00001613 sk_tx_queue_clear(sk);
Eric Dumazet0b53ff22010-04-26 20:40:43 +00001614 /*
1615 * This can be called while sk is owned by the caller only,
1616 * with no state that can be checked in a rcu_dereference_check() cond
1617 */
1618 old_dst = rcu_dereference_raw(sk->sk_dst_cache);
Eric Dumazetb6c67122010-04-08 23:03:29 +00001619 rcu_assign_pointer(sk->sk_dst_cache, dst);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001620 dst_release(old_dst);
1621}
1622
1623static inline void
1624sk_dst_set(struct sock *sk, struct dst_entry *dst)
1625{
Eric Dumazetb6c67122010-04-08 23:03:29 +00001626 spin_lock(&sk->sk_dst_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001627 __sk_dst_set(sk, dst);
Eric Dumazetb6c67122010-04-08 23:03:29 +00001628 spin_unlock(&sk->sk_dst_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001629}
1630
1631static inline void
1632__sk_dst_reset(struct sock *sk)
1633{
Eric Dumazetb6c67122010-04-08 23:03:29 +00001634 __sk_dst_set(sk, NULL);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001635}
1636
1637static inline void
1638sk_dst_reset(struct sock *sk)
1639{
Eric Dumazetb6c67122010-04-08 23:03:29 +00001640 spin_lock(&sk->sk_dst_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001641 __sk_dst_reset(sk);
Eric Dumazetb6c67122010-04-08 23:03:29 +00001642 spin_unlock(&sk->sk_dst_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001643}
1644
Denis Vlasenkof0088a52006-03-28 01:08:21 -08001645extern struct dst_entry *__sk_dst_check(struct sock *sk, u32 cookie);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001646
Denis Vlasenkof0088a52006-03-28 01:08:21 -08001647extern struct dst_entry *sk_dst_check(struct sock *sk, u32 cookie);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001648
Herbert Xubcd76112006-06-30 13:36:35 -07001649static inline int sk_can_gso(const struct sock *sk)
1650{
1651 return net_gso_ok(sk->sk_route_caps, sk->sk_gso_type);
1652}
1653
Andi Kleen99580892007-04-20 17:12:43 -07001654extern void sk_setup_caps(struct sock *sk, struct dst_entry *dst);
Arnaldo Carvalho de Melo6cbb0df2005-08-09 19:49:02 -07001655
Michał Mirosławc8f44af2011-11-15 15:29:55 +00001656static inline void sk_nocaps_add(struct sock *sk, netdev_features_t flags)
Eric Dumazeta4654192010-05-16 00:36:33 -07001657{
1658 sk->sk_route_nocaps |= flags;
1659 sk->sk_route_caps &= ~flags;
1660}
1661
Tom Herbertc6e1a0d2011-04-04 22:30:30 -07001662static inline int skb_do_copy_data_nocache(struct sock *sk, struct sk_buff *skb,
1663 char __user *from, char *to,
Wei Yongjun912d3982011-04-06 18:40:12 +00001664 int copy, int offset)
Tom Herbertc6e1a0d2011-04-04 22:30:30 -07001665{
1666 if (skb->ip_summed == CHECKSUM_NONE) {
1667 int err = 0;
1668 __wsum csum = csum_and_copy_from_user(from, to, copy, 0, &err);
1669 if (err)
1670 return err;
Wei Yongjun912d3982011-04-06 18:40:12 +00001671 skb->csum = csum_block_add(skb->csum, csum, offset);
Tom Herbertc6e1a0d2011-04-04 22:30:30 -07001672 } else if (sk->sk_route_caps & NETIF_F_NOCACHE_COPY) {
1673 if (!access_ok(VERIFY_READ, from, copy) ||
1674 __copy_from_user_nocache(to, from, copy))
1675 return -EFAULT;
1676 } else if (copy_from_user(to, from, copy))
1677 return -EFAULT;
1678
1679 return 0;
1680}
1681
1682static inline int skb_add_data_nocache(struct sock *sk, struct sk_buff *skb,
1683 char __user *from, int copy)
1684{
Wei Yongjun912d3982011-04-06 18:40:12 +00001685 int err, offset = skb->len;
Tom Herbertc6e1a0d2011-04-04 22:30:30 -07001686
Wei Yongjun912d3982011-04-06 18:40:12 +00001687 err = skb_do_copy_data_nocache(sk, skb, from, skb_put(skb, copy),
1688 copy, offset);
Tom Herbertc6e1a0d2011-04-04 22:30:30 -07001689 if (err)
Wei Yongjun912d3982011-04-06 18:40:12 +00001690 __skb_trim(skb, offset);
Tom Herbertc6e1a0d2011-04-04 22:30:30 -07001691
1692 return err;
1693}
1694
1695static inline int skb_copy_to_page_nocache(struct sock *sk, char __user *from,
1696 struct sk_buff *skb,
1697 struct page *page,
1698 int off, int copy)
1699{
1700 int err;
1701
Wei Yongjun912d3982011-04-06 18:40:12 +00001702 err = skb_do_copy_data_nocache(sk, skb, from, page_address(page) + off,
1703 copy, skb->len);
Tom Herbertc6e1a0d2011-04-04 22:30:30 -07001704 if (err)
1705 return err;
1706
1707 skb->len += copy;
1708 skb->data_len += copy;
1709 skb->truesize += copy;
1710 sk->sk_wmem_queued += copy;
1711 sk_mem_charge(sk, copy);
1712 return 0;
1713}
1714
Linus Torvalds1da177e2005-04-16 15:20:36 -07001715static inline int skb_copy_to_page(struct sock *sk, char __user *from,
1716 struct sk_buff *skb, struct page *page,
1717 int off, int copy)
1718{
1719 if (skb->ip_summed == CHECKSUM_NONE) {
1720 int err = 0;
Al Viro50842052006-11-14 21:36:34 -08001721 __wsum csum = csum_and_copy_from_user(from,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001722 page_address(page) + off,
1723 copy, 0, &err);
1724 if (err)
1725 return err;
1726 skb->csum = csum_block_add(skb->csum, csum, skb->len);
1727 } else if (copy_from_user(page_address(page) + off, from, copy))
1728 return -EFAULT;
1729
1730 skb->len += copy;
1731 skb->data_len += copy;
1732 skb->truesize += copy;
1733 sk->sk_wmem_queued += copy;
Hideo Aoki3ab224b2007-12-31 00:11:19 -08001734 sk_mem_charge(sk, copy);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001735 return 0;
1736}
1737
Eric Dumazetc5640392009-06-16 10:12:03 +00001738/**
1739 * sk_wmem_alloc_get - returns write allocations
1740 * @sk: socket
1741 *
1742 * Returns sk_wmem_alloc minus initial offset of one
1743 */
1744static inline int sk_wmem_alloc_get(const struct sock *sk)
1745{
1746 return atomic_read(&sk->sk_wmem_alloc) - 1;
1747}
1748
1749/**
1750 * sk_rmem_alloc_get - returns read allocations
1751 * @sk: socket
1752 *
1753 * Returns sk_rmem_alloc
1754 */
1755static inline int sk_rmem_alloc_get(const struct sock *sk)
1756{
1757 return atomic_read(&sk->sk_rmem_alloc);
1758}
1759
1760/**
1761 * sk_has_allocations - check if allocations are outstanding
1762 * @sk: socket
1763 *
1764 * Returns true if socket has write or read allocations
1765 */
1766static inline int sk_has_allocations(const struct sock *sk)
1767{
1768 return sk_wmem_alloc_get(sk) || sk_rmem_alloc_get(sk);
1769}
1770
Jiri Olsaa57de0b2009-07-08 12:09:13 +00001771/**
Eric Dumazet43815482010-04-29 11:01:49 +00001772 * wq_has_sleeper - check if there are any waiting processes
Randy Dunlapacfbe962010-05-24 23:54:18 -07001773 * @wq: struct socket_wq
Jiri Olsaa57de0b2009-07-08 12:09:13 +00001774 *
Eric Dumazet43815482010-04-29 11:01:49 +00001775 * Returns true if socket_wq has waiting processes
Jiri Olsaa57de0b2009-07-08 12:09:13 +00001776 *
Eric Dumazet43815482010-04-29 11:01:49 +00001777 * The purpose of the wq_has_sleeper and sock_poll_wait is to wrap the memory
Jiri Olsaa57de0b2009-07-08 12:09:13 +00001778 * barrier call. They were added due to the race found within the tcp code.
1779 *
1780 * Consider following tcp code paths:
1781 *
1782 * CPU1 CPU2
1783 *
1784 * sys_select receive packet
1785 * ... ...
1786 * __add_wait_queue update tp->rcv_nxt
1787 * ... ...
1788 * tp->rcv_nxt check sock_def_readable
1789 * ... {
Eric Dumazet43815482010-04-29 11:01:49 +00001790 * schedule rcu_read_lock();
1791 * wq = rcu_dereference(sk->sk_wq);
1792 * if (wq && waitqueue_active(&wq->wait))
1793 * wake_up_interruptible(&wq->wait)
Jiri Olsaa57de0b2009-07-08 12:09:13 +00001794 * ...
1795 * }
1796 *
1797 * The race for tcp fires when the __add_wait_queue changes done by CPU1 stay
1798 * in its cache, and so does the tp->rcv_nxt update on CPU2 side. The CPU1
1799 * could then endup calling schedule and sleep forever if there are no more
1800 * data on the socket.
Jiri Olsaad462762009-07-08 12:10:31 +00001801 *
Jiri Olsaa57de0b2009-07-08 12:09:13 +00001802 */
Eric Dumazet43815482010-04-29 11:01:49 +00001803static inline bool wq_has_sleeper(struct socket_wq *wq)
Jiri Olsaa57de0b2009-07-08 12:09:13 +00001804{
Eric Dumazet43815482010-04-29 11:01:49 +00001805
Jiri Olsaa57de0b2009-07-08 12:09:13 +00001806 /*
1807 * We need to be sure we are in sync with the
1808 * add_wait_queue modifications to the wait queue.
1809 *
1810 * This memory barrier is paired in the sock_poll_wait.
1811 */
Eric Dumazet43815482010-04-29 11:01:49 +00001812 smp_mb();
1813 return wq && waitqueue_active(&wq->wait);
Jiri Olsaa57de0b2009-07-08 12:09:13 +00001814}
1815
1816/**
1817 * sock_poll_wait - place memory barrier behind the poll_wait call.
1818 * @filp: file
1819 * @wait_address: socket wait queue
1820 * @p: poll_table
1821 *
Eric Dumazet43815482010-04-29 11:01:49 +00001822 * See the comments in the wq_has_sleeper function.
Jiri Olsaa57de0b2009-07-08 12:09:13 +00001823 */
1824static inline void sock_poll_wait(struct file *filp,
1825 wait_queue_head_t *wait_address, poll_table *p)
1826{
1827 if (p && wait_address) {
1828 poll_wait(filp, wait_address, p);
1829 /*
1830 * We need to be sure we are in sync with the
1831 * socket flags modification.
1832 *
Eric Dumazet43815482010-04-29 11:01:49 +00001833 * This memory barrier is paired in the wq_has_sleeper.
Jiri Olsaa57de0b2009-07-08 12:09:13 +00001834 */
1835 smp_mb();
1836 }
1837}
1838
Linus Torvalds1da177e2005-04-16 15:20:36 -07001839/*
1840 * Queue a received datagram if it will fit. Stream and sequenced
1841 * protocols can't normally use this as they need to fit buffers in
1842 * and play with them.
1843 *
1844 * Inlined as it's very short and called for pretty much every
1845 * packet ever received.
1846 */
1847
1848static inline void skb_set_owner_w(struct sk_buff *skb, struct sock *sk)
1849{
Herbert Xud55d87f2009-06-22 02:25:25 +00001850 skb_orphan(skb);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001851 skb->sk = sk;
1852 skb->destructor = sock_wfree;
Eric Dumazet2b85a342009-06-11 02:55:43 -07001853 /*
1854 * We used to take a refcount on sk, but following operation
1855 * is enough to guarantee sk_free() wont free this sock until
1856 * all in-flight packets are completed
1857 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001858 atomic_add(skb->truesize, &sk->sk_wmem_alloc);
1859}
1860
1861static inline void skb_set_owner_r(struct sk_buff *skb, struct sock *sk)
1862{
Herbert Xud55d87f2009-06-22 02:25:25 +00001863 skb_orphan(skb);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001864 skb->sk = sk;
1865 skb->destructor = sock_rfree;
1866 atomic_add(skb->truesize, &sk->sk_rmem_alloc);
Hideo Aoki3ab224b2007-12-31 00:11:19 -08001867 sk_mem_charge(sk, skb->truesize);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001868}
1869
1870extern void sk_reset_timer(struct sock *sk, struct timer_list* timer,
1871 unsigned long expires);
1872
1873extern void sk_stop_timer(struct sock *sk, struct timer_list* timer);
1874
Denis Vlasenkof0088a52006-03-28 01:08:21 -08001875extern int sock_queue_rcv_skb(struct sock *sk, struct sk_buff *skb);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001876
Eric Dumazetb1faf562010-05-31 23:44:05 -07001877extern int sock_queue_err_skb(struct sock *sk, struct sk_buff *skb);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001878
1879/*
1880 * Recover an error report and clear atomically
1881 */
1882
1883static inline int sock_error(struct sock *sk)
1884{
Benjamin LaHaisec1cbe4b2005-12-13 23:22:19 -08001885 int err;
1886 if (likely(!sk->sk_err))
1887 return 0;
1888 err = xchg(&sk->sk_err, 0);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001889 return -err;
1890}
1891
1892static inline unsigned long sock_wspace(struct sock *sk)
1893{
1894 int amt = 0;
1895
1896 if (!(sk->sk_shutdown & SEND_SHUTDOWN)) {
1897 amt = sk->sk_sndbuf - atomic_read(&sk->sk_wmem_alloc);
1898 if (amt < 0)
1899 amt = 0;
1900 }
1901 return amt;
1902}
1903
1904static inline void sk_wake_async(struct sock *sk, int how, int band)
1905{
Eric Dumazetbcdce712009-10-06 17:28:29 -07001906 if (sock_flag(sk, SOCK_FASYNC))
Linus Torvalds1da177e2005-04-16 15:20:36 -07001907 sock_wake_async(sk->sk_socket, how, band);
1908}
1909
1910#define SOCK_MIN_SNDBUF 2048
Eric Dumazet7a91b4342010-09-26 18:53:07 -07001911/*
1912 * Since sk_rmem_alloc sums skb->truesize, even a small frame might need
1913 * sizeof(sk_buff) + MTU + padding, unless net driver perform copybreak
1914 */
1915#define SOCK_MIN_RCVBUF (2048 + sizeof(struct sk_buff))
Linus Torvalds1da177e2005-04-16 15:20:36 -07001916
1917static inline void sk_stream_moderate_sndbuf(struct sock *sk)
1918{
1919 if (!(sk->sk_userlocks & SOCK_SNDBUF_LOCK)) {
Eric Dumazet8df09ea2007-12-21 03:07:41 -08001920 sk->sk_sndbuf = min(sk->sk_sndbuf, sk->sk_wmem_queued >> 1);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001921 sk->sk_sndbuf = max(sk->sk_sndbuf, SOCK_MIN_SNDBUF);
1922 }
1923}
1924
Pavel Emelyanovdf97c702007-11-29 21:22:33 +11001925struct sk_buff *sk_stream_alloc_skb(struct sock *sk, int size, gfp_t gfp);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001926
1927static inline struct page *sk_stream_alloc_page(struct sock *sk)
1928{
1929 struct page *page = NULL;
1930
Herbert Xuef015782005-09-01 17:48:59 -07001931 page = alloc_pages(sk->sk_allocation, 0);
1932 if (!page) {
Glauber Costa180d8cd2011-12-11 21:47:02 +00001933 sk_enter_memory_pressure(sk);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001934 sk_stream_moderate_sndbuf(sk);
1935 }
1936 return page;
1937}
1938
Linus Torvalds1da177e2005-04-16 15:20:36 -07001939/*
1940 * Default write policy as shown to user space via poll/select/SIGIO
1941 */
1942static inline int sock_writeable(const struct sock *sk)
1943{
Eric Dumazet8df09ea2007-12-21 03:07:41 -08001944 return atomic_read(&sk->sk_wmem_alloc) < (sk->sk_sndbuf >> 1);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001945}
1946
Al Virodd0fc662005-10-07 07:46:04 +01001947static inline gfp_t gfp_any(void)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001948{
Andrew Morton99709372009-02-12 16:43:17 -08001949 return in_softirq() ? GFP_ATOMIC : GFP_KERNEL;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001950}
1951
1952static inline long sock_rcvtimeo(const struct sock *sk, int noblock)
1953{
1954 return noblock ? 0 : sk->sk_rcvtimeo;
1955}
1956
1957static inline long sock_sndtimeo(const struct sock *sk, int noblock)
1958{
1959 return noblock ? 0 : sk->sk_sndtimeo;
1960}
1961
1962static inline int sock_rcvlowat(const struct sock *sk, int waitall, int len)
1963{
1964 return (waitall ? len : min_t(int, sk->sk_rcvlowat, len)) ? : 1;
1965}
1966
1967/* Alas, with timeout socket operations are not restartable.
1968 * Compare this to poll().
1969 */
1970static inline int sock_intr_errno(long timeo)
1971{
1972 return timeo == MAX_SCHEDULE_TIMEOUT ? -ERESTARTSYS : -EINTR;
1973}
1974
Eric Dumazet92f37fd2007-03-25 22:14:49 -07001975extern void __sock_recv_timestamp(struct msghdr *msg, struct sock *sk,
1976 struct sk_buff *skb);
Johannes Berg6e3e9392011-11-09 10:15:42 +01001977extern void __sock_recv_wifi_status(struct msghdr *msg, struct sock *sk,
1978 struct sk_buff *skb);
Eric Dumazet92f37fd2007-03-25 22:14:49 -07001979
Linus Torvalds1da177e2005-04-16 15:20:36 -07001980static __inline__ void
1981sock_recv_timestamp(struct msghdr *msg, struct sock *sk, struct sk_buff *skb)
1982{
Eric Dumazetb7aa0bf2007-04-19 16:16:32 -07001983 ktime_t kt = skb->tstamp;
Patrick Ohly20d49472009-02-12 05:03:38 +00001984 struct skb_shared_hwtstamps *hwtstamps = skb_hwtstamps(skb);
Patrick McHardya61bbcf2005-08-14 17:24:31 -07001985
Patrick Ohly20d49472009-02-12 05:03:38 +00001986 /*
1987 * generate control messages if
1988 * - receive time stamping in software requested (SOCK_RCVTSTAMP
1989 * or SOCK_TIMESTAMPING_RX_SOFTWARE)
1990 * - software time stamp available and wanted
1991 * (SOCK_TIMESTAMPING_SOFTWARE)
1992 * - hardware time stamps available and wanted
1993 * (SOCK_TIMESTAMPING_SYS_HARDWARE or
1994 * SOCK_TIMESTAMPING_RAW_HARDWARE)
1995 */
1996 if (sock_flag(sk, SOCK_RCVTSTAMP) ||
1997 sock_flag(sk, SOCK_TIMESTAMPING_RX_SOFTWARE) ||
1998 (kt.tv64 && sock_flag(sk, SOCK_TIMESTAMPING_SOFTWARE)) ||
1999 (hwtstamps->hwtstamp.tv64 &&
2000 sock_flag(sk, SOCK_TIMESTAMPING_RAW_HARDWARE)) ||
2001 (hwtstamps->syststamp.tv64 &&
2002 sock_flag(sk, SOCK_TIMESTAMPING_SYS_HARDWARE)))
Eric Dumazet92f37fd2007-03-25 22:14:49 -07002003 __sock_recv_timestamp(msg, sk, skb);
2004 else
Eric Dumazetb7aa0bf2007-04-19 16:16:32 -07002005 sk->sk_stamp = kt;
Johannes Berg6e3e9392011-11-09 10:15:42 +01002006
2007 if (sock_flag(sk, SOCK_WIFI_STATUS) && skb->wifi_acked_valid)
2008 __sock_recv_wifi_status(msg, sk, skb);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002009}
2010
Eric Dumazet767dd032010-04-28 19:14:43 +00002011extern void __sock_recv_ts_and_drops(struct msghdr *msg, struct sock *sk,
2012 struct sk_buff *skb);
2013
2014static inline void sock_recv_ts_and_drops(struct msghdr *msg, struct sock *sk,
2015 struct sk_buff *skb)
2016{
2017#define FLAGS_TS_OR_DROPS ((1UL << SOCK_RXQ_OVFL) | \
2018 (1UL << SOCK_RCVTSTAMP) | \
2019 (1UL << SOCK_TIMESTAMPING_RX_SOFTWARE) | \
2020 (1UL << SOCK_TIMESTAMPING_SOFTWARE) | \
2021 (1UL << SOCK_TIMESTAMPING_RAW_HARDWARE) | \
2022 (1UL << SOCK_TIMESTAMPING_SYS_HARDWARE))
2023
2024 if (sk->sk_flags & FLAGS_TS_OR_DROPS)
2025 __sock_recv_ts_and_drops(msg, sk, skb);
2026 else
2027 sk->sk_stamp = skb->tstamp;
2028}
Neil Horman3b885782009-10-12 13:26:31 -07002029
Linus Torvalds1da177e2005-04-16 15:20:36 -07002030/**
Patrick Ohly20d49472009-02-12 05:03:38 +00002031 * sock_tx_timestamp - checks whether the outgoing packet is to be time stamped
Patrick Ohly20d49472009-02-12 05:03:38 +00002032 * @sk: socket sending this packet
Oliver Hartkopp2244d072010-08-17 08:59:14 +00002033 * @tx_flags: filled with instructions for time stamping
Patrick Ohly20d49472009-02-12 05:03:38 +00002034 *
2035 * Currently only depends on SOCK_TIMESTAMPING* flags. Returns error code if
2036 * parameters are invalid.
2037 */
Oliver Hartkopp2244d072010-08-17 08:59:14 +00002038extern int sock_tx_timestamp(struct sock *sk, __u8 *tx_flags);
Patrick Ohly20d49472009-02-12 05:03:38 +00002039
2040/**
Linus Torvalds1da177e2005-04-16 15:20:36 -07002041 * sk_eat_skb - Release a skb if it is no longer needed
Pavel Pisa4dc3b162005-05-01 08:59:25 -07002042 * @sk: socket to eat this skb from
2043 * @skb: socket buffer to eat
Randy Dunlapf4b8ea72006-06-22 16:00:11 -07002044 * @copied_early: flag indicating whether DMA operations copied this data early
Linus Torvalds1da177e2005-04-16 15:20:36 -07002045 *
2046 * This routine must be called with interrupts disabled or with the socket
2047 * locked so that the sk_buff queue operation is ok.
2048*/
Chris Leech624d1162006-05-23 18:01:28 -07002049#ifdef CONFIG_NET_DMA
2050static inline void sk_eat_skb(struct sock *sk, struct sk_buff *skb, int copied_early)
2051{
2052 __skb_unlink(skb, &sk->sk_receive_queue);
2053 if (!copied_early)
2054 __kfree_skb(skb);
2055 else
2056 __skb_queue_tail(&sk->sk_async_wait_queue, skb);
2057}
2058#else
2059static inline void sk_eat_skb(struct sock *sk, struct sk_buff *skb, int copied_early)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002060{
2061 __skb_unlink(skb, &sk->sk_receive_queue);
2062 __kfree_skb(skb);
2063}
Chris Leech624d1162006-05-23 18:01:28 -07002064#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -07002065
YOSHIFUJI Hideaki3b1e0a62008-03-26 02:26:21 +09002066static inline
2067struct net *sock_net(const struct sock *sk)
2068{
Eric Dumazetc2d9ba92010-06-01 06:51:19 +00002069 return read_pnet(&sk->sk_net);
YOSHIFUJI Hideaki3b1e0a62008-03-26 02:26:21 +09002070}
2071
2072static inline
Denis V. Lunevf5aa23f2008-03-26 00:48:17 -07002073void sock_net_set(struct sock *sk, struct net *net)
YOSHIFUJI Hideaki3b1e0a62008-03-26 02:26:21 +09002074{
Eric Dumazetc2d9ba92010-06-01 06:51:19 +00002075 write_pnet(&sk->sk_net, net);
YOSHIFUJI Hideaki3b1e0a62008-03-26 02:26:21 +09002076}
2077
Denis V. Lunevedf02082008-02-29 11:18:32 -08002078/*
2079 * Kernel sockets, f.e. rtnl or icmp_socket, are a part of a namespace.
Lucas De Marchi25985ed2011-03-30 22:57:33 -03002080 * They should not hold a reference to a namespace in order to allow
Denis V. Lunevedf02082008-02-29 11:18:32 -08002081 * to stop it.
2082 * Sockets after sk_change_net should be released using sk_release_kernel
2083 */
2084static inline void sk_change_net(struct sock *sk, struct net *net)
2085{
YOSHIFUJI Hideaki3b1e0a62008-03-26 02:26:21 +09002086 put_net(sock_net(sk));
Denis V. Lunev65a18ec2008-04-16 01:59:46 -07002087 sock_net_set(sk, hold_net(net));
Denis V. Lunevedf02082008-02-29 11:18:32 -08002088}
2089
KOVACS Krisztian23542612008-10-07 12:41:01 -07002090static inline struct sock *skb_steal_sock(struct sk_buff *skb)
2091{
2092 if (unlikely(skb->sk)) {
2093 struct sock *sk = skb->sk;
2094
2095 skb->destructor = NULL;
2096 skb->sk = NULL;
2097 return sk;
2098 }
2099 return NULL;
2100}
2101
Patrick Ohly20d49472009-02-12 05:03:38 +00002102extern void sock_enable_timestamp(struct sock *sk, int flag);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002103extern int sock_get_timestamp(struct sock *, struct timeval __user *);
Eric Dumazetae40eb12007-03-18 17:33:16 -07002104extern int sock_get_timestampns(struct sock *, struct timespec __user *);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002105
2106/*
2107 * Enable debug/info messages
2108 */
Stephen Hemmingera2a316f2007-03-08 20:41:08 -08002109extern int net_msg_warn;
2110#define NETDEBUG(fmt, args...) \
2111 do { if (net_msg_warn) printk(fmt,##args); } while (0)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002112
Stephen Hemmingera2a316f2007-03-08 20:41:08 -08002113#define LIMIT_NETDEBUG(fmt, args...) \
2114 do { if (net_msg_warn && net_ratelimit()) printk(fmt,##args); } while(0)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002115
Linus Torvalds1da177e2005-04-16 15:20:36 -07002116extern __u32 sysctl_wmem_max;
2117extern __u32 sysctl_rmem_max;
2118
Arnaldo Carvalho de Melo20380732005-08-16 02:18:02 -03002119extern void sk_init(void);
2120
David S. Miller6baf1f42005-09-05 18:14:11 -07002121extern int sysctl_optmem_max;
2122
Arnaldo Carvalho de Melo20380732005-08-16 02:18:02 -03002123extern __u32 sysctl_wmem_default;
2124extern __u32 sysctl_rmem_default;
Arnaldo Carvalho de Melo20380732005-08-16 02:18:02 -03002125
Linus Torvalds1da177e2005-04-16 15:20:36 -07002126#endif /* _SOCK_H */