blob: 27508f07eada4def1198d224a1be776335c50f38 [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>
Glauber Costa9018e932012-01-26 12:09:28 +000058#include <linux/jump_label.h>
Al Viro40401532012-02-13 03:58:52 +000059#include <linux/aio.h>
60#include <linux/sched.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070061
62#include <linux/filter.h>
Eric Dumazet88ab1932008-11-16 19:39:21 -080063#include <linux/rculist_nulls.h>
Jiri Olsaa57de0b2009-07-08 12:09:13 +000064#include <linux/poll.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070065
Eric Dumazetc31504d2010-11-15 19:58:26 +000066#include <linux/atomic.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070067#include <net/dst.h>
68#include <net/checksum.h>
69
Eric Dumazet9f048bf2011-12-13 03:59:08 +000070struct cgroup;
71struct cgroup_subsys;
Glauber Costac607b2e2011-12-16 00:52:00 +000072#ifdef CONFIG_NET
Glauber Costad1a4c0b2011-12-11 21:47:04 +000073int mem_cgroup_sockets_init(struct cgroup *cgrp, struct cgroup_subsys *ss);
74void mem_cgroup_sockets_destroy(struct cgroup *cgrp, struct cgroup_subsys *ss);
Glauber Costac607b2e2011-12-16 00:52:00 +000075#else
76static inline
77int mem_cgroup_sockets_init(struct cgroup *cgrp, struct cgroup_subsys *ss)
78{
79 return 0;
80}
81static inline
82void mem_cgroup_sockets_destroy(struct cgroup *cgrp, struct cgroup_subsys *ss)
83{
84}
85#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -070086/*
87 * This structure really needs to be cleaned up.
88 * Most of it is for TCP, and not used by any of
89 * the other protocols.
90 */
91
92/* Define this to get the SOCK_DBG debugging facility. */
93#define SOCK_DEBUGGING
94#ifdef SOCK_DEBUGGING
95#define SOCK_DEBUG(sk, msg...) do { if ((sk) && sock_flag((sk), SOCK_DBG)) \
96 printk(KERN_DEBUG msg); } while (0)
97#else
Stephen Hemminger4cd90292008-03-21 15:54:53 -070098/* Validate arguments and do nothing */
Joe Perchesb9075fa2011-10-31 17:11:33 -070099static inline __printf(2, 3)
100void SOCK_DEBUG(struct sock *sk, const char *msg, ...)
Stephen Hemminger4cd90292008-03-21 15:54:53 -0700101{
102}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700103#endif
104
105/* This is the per-socket lock. The spinlock provides a synchronization
106 * between user contexts and software interrupt processing, whereas the
107 * mini-semaphore synchronizes multiple users amongst themselves.
108 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700109typedef struct {
110 spinlock_t slock;
John Heffnerd2e91172007-09-12 10:44:19 +0200111 int owned;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700112 wait_queue_head_t wq;
Ingo Molnara5b5bb92006-07-03 00:25:35 -0700113 /*
114 * We express the mutex-alike socket_lock semantics
115 * to the lock validator by explicitly managing
116 * the slock as a lock variant (in addition to
117 * the slock itself):
118 */
119#ifdef CONFIG_DEBUG_LOCK_ALLOC
120 struct lockdep_map dep_map;
121#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -0700122} socket_lock_t;
123
Linus Torvalds1da177e2005-04-16 15:20:36 -0700124struct sock;
Arnaldo Carvalho de Melo8feaf0c2005-08-09 20:09:30 -0700125struct proto;
Denis V. Lunev0eeb8ff2007-12-04 01:15:45 -0800126struct net;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700127
128/**
Pavel Pisa4dc3b162005-05-01 08:59:25 -0700129 * struct sock_common - minimal network layer representation of sockets
Eric Dumazet68835ab2010-11-30 19:04:07 +0000130 * @skc_daddr: Foreign IPv4 addr
131 * @skc_rcv_saddr: Bound local IPv4 addr
Eric Dumazet4dc6dc72009-07-15 23:13:10 +0000132 * @skc_hash: hash value used with various protocol lookup tables
Eric Dumazetd4cada42009-11-08 10:17:30 +0000133 * @skc_u16hashes: two u16 hash values used by UDP lookup tables
Pavel Pisa4dc3b162005-05-01 08:59:25 -0700134 * @skc_family: network address family
135 * @skc_state: Connection state
136 * @skc_reuse: %SO_REUSEADDR setting
137 * @skc_bound_dev_if: bound device index if != 0
Pavel Pisa4dc3b162005-05-01 08:59:25 -0700138 * @skc_bind_node: bind hash linkage for various protocol lookup tables
Eric Dumazet512615b2009-11-08 10:17:58 +0000139 * @skc_portaddr_node: second hash linkage for UDP/UDP-Lite protocol
Arnaldo Carvalho de Melo8feaf0c2005-08-09 20:09:30 -0700140 * @skc_prot: protocol handlers inside a network family
Eric W. Biederman07feaeb2007-09-12 11:58:02 +0200141 * @skc_net: reference to the network namespace of this socket
Eric Dumazet68835ab2010-11-30 19:04:07 +0000142 * @skc_node: main hash linkage for various protocol lookup tables
143 * @skc_nulls_node: main hash linkage for TCP/UDP/UDP-Lite protocol
144 * @skc_tx_queue_mapping: tx queue number for this connection
145 * @skc_refcnt: reference count
Pavel Pisa4dc3b162005-05-01 08:59:25 -0700146 *
147 * This is the minimal network layer representation of sockets, the header
Arnaldo Carvalho de Melo8feaf0c2005-08-09 20:09:30 -0700148 * for struct sock and struct inet_timewait_sock.
149 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700150struct sock_common {
Eric Dumazet68835ab2010-11-30 19:04:07 +0000151 /* skc_daddr and skc_rcv_saddr must be grouped :
152 * cf INET_MATCH() and INET_TW_MATCH()
Eric Dumazet4dc6dc72009-07-15 23:13:10 +0000153 */
Eric Dumazet68835ab2010-11-30 19:04:07 +0000154 __be32 skc_daddr;
155 __be32 skc_rcv_saddr;
Eric Dumazet4dc6dc72009-07-15 23:13:10 +0000156
Eric Dumazetd4cada42009-11-08 10:17:30 +0000157 union {
158 unsigned int skc_hash;
159 __u16 skc_u16hashes[2];
160 };
Eric Dumazet4dc6dc72009-07-15 23:13:10 +0000161 unsigned short skc_family;
162 volatile unsigned char skc_state;
163 unsigned char skc_reuse;
164 int skc_bound_dev_if;
Eric Dumazet512615b2009-11-08 10:17:58 +0000165 union {
166 struct hlist_node skc_bind_node;
167 struct hlist_nulls_node skc_portaddr_node;
168 };
Arnaldo Carvalho de Melo8feaf0c2005-08-09 20:09:30 -0700169 struct proto *skc_prot;
YOSHIFUJI Hideaki3b1e0a62008-03-26 02:26:21 +0900170#ifdef CONFIG_NET_NS
Eric W. Biederman07feaeb2007-09-12 11:58:02 +0200171 struct net *skc_net;
YOSHIFUJI Hideaki3b1e0a62008-03-26 02:26:21 +0900172#endif
Eric Dumazet68835ab2010-11-30 19:04:07 +0000173 /*
174 * fields between dontcopy_begin/dontcopy_end
175 * are not copied in sock_copy()
176 */
Randy Dunlap928c41e2011-01-08 17:39:21 +0000177 /* private: */
Eric Dumazet68835ab2010-11-30 19:04:07 +0000178 int skc_dontcopy_begin[0];
Randy Dunlap928c41e2011-01-08 17:39:21 +0000179 /* public: */
Eric Dumazet68835ab2010-11-30 19:04:07 +0000180 union {
181 struct hlist_node skc_node;
182 struct hlist_nulls_node skc_nulls_node;
183 };
184 int skc_tx_queue_mapping;
185 atomic_t skc_refcnt;
Randy Dunlap928c41e2011-01-08 17:39:21 +0000186 /* private: */
Eric Dumazet68835ab2010-11-30 19:04:07 +0000187 int skc_dontcopy_end[0];
Randy Dunlap928c41e2011-01-08 17:39:21 +0000188 /* public: */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700189};
190
Glauber Costae1aab162011-12-11 21:47:03 +0000191struct cg_proto;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700192/**
193 * struct sock - network layer representation of sockets
Arnaldo Carvalho de Melo8feaf0c2005-08-09 20:09:30 -0700194 * @__sk_common: shared layout with inet_timewait_sock
Pavel Pisa4dc3b162005-05-01 08:59:25 -0700195 * @sk_shutdown: mask of %SEND_SHUTDOWN and/or %RCV_SHUTDOWN
196 * @sk_userlocks: %SO_SNDBUF and %SO_RCVBUF settings
197 * @sk_lock: synchronizer
198 * @sk_rcvbuf: size of receive buffer in bytes
Eric Dumazet43815482010-04-29 11:01:49 +0000199 * @sk_wq: sock wait queue and async head
Pavel Pisa4dc3b162005-05-01 08:59:25 -0700200 * @sk_dst_cache: destination cache
201 * @sk_dst_lock: destination cache lock
202 * @sk_policy: flow policy
Pavel Pisa4dc3b162005-05-01 08:59:25 -0700203 * @sk_receive_queue: incoming packets
204 * @sk_wmem_alloc: transmit queue bytes committed
205 * @sk_write_queue: Packet sending queue
Chris Leech97fc2f02006-05-23 17:55:33 -0700206 * @sk_async_wait_queue: DMA copied packets
Pavel Pisa4dc3b162005-05-01 08:59:25 -0700207 * @sk_omem_alloc: "o" is "option" or "other"
208 * @sk_wmem_queued: persistent queue size
209 * @sk_forward_alloc: space allocated forward
210 * @sk_allocation: allocation mode
211 * @sk_sndbuf: size of send buffer in bytes
Wang Chen33c732c2007-11-13 20:30:01 -0800212 * @sk_flags: %SO_LINGER (l_onoff), %SO_BROADCAST, %SO_KEEPALIVE,
Patrick Ohly20d49472009-02-12 05:03:38 +0000213 * %SO_OOBINLINE settings, %SO_TIMESTAMPING settings
Pavel Pisa4dc3b162005-05-01 08:59:25 -0700214 * @sk_no_check: %SO_NO_CHECK setting, wether or not checkup packets
215 * @sk_route_caps: route capabilities (e.g. %NETIF_F_TSO)
Eric Dumazeta4654192010-05-16 00:36:33 -0700216 * @sk_route_nocaps: forbidden route capabilities (e.g NETIF_F_GSO_MASK)
Herbert Xubcd76112006-06-30 13:36:35 -0700217 * @sk_gso_type: GSO type (e.g. %SKB_GSO_TCPV4)
Peter P Waskiewicz Jr82cc1a72008-03-21 03:43:19 -0700218 * @sk_gso_max_size: Maximum GSO segment size to build
Pavel Pisa4dc3b162005-05-01 08:59:25 -0700219 * @sk_lingertime: %SO_LINGER l_linger setting
Pavel Pisa4dc3b162005-05-01 08:59:25 -0700220 * @sk_backlog: always used with the per-socket spinlock held
221 * @sk_callback_lock: used with the callbacks in the end of this struct
222 * @sk_error_queue: rarely used
Wang Chen33c732c2007-11-13 20:30:01 -0800223 * @sk_prot_creator: sk_prot of original sock creator (see ipv6_setsockopt,
224 * IPV6_ADDRFORM for instance)
Pavel Pisa4dc3b162005-05-01 08:59:25 -0700225 * @sk_err: last error
Wang Chen33c732c2007-11-13 20:30:01 -0800226 * @sk_err_soft: errors that don't cause failure but are the cause of a
227 * persistent failure not just 'timed out'
Eric Dumazetcb61cb92008-06-17 21:04:56 -0700228 * @sk_drops: raw/udp drops counter
Pavel Pisa4dc3b162005-05-01 08:59:25 -0700229 * @sk_ack_backlog: current listen backlog
230 * @sk_max_ack_backlog: listen backlog set in listen()
231 * @sk_priority: %SO_PRIORITY setting
Randy Dunlap1a3bc362012-01-21 09:03:10 +0000232 * @sk_cgrp_prioidx: socket group's priority map index
Pavel Pisa4dc3b162005-05-01 08:59:25 -0700233 * @sk_type: socket type (%SOCK_STREAM, etc)
234 * @sk_protocol: which protocol this socket belongs in this network family
Randy Dunlap53c3fa22010-08-09 13:41:07 +0000235 * @sk_peer_pid: &struct pid for this socket's peer
236 * @sk_peer_cred: %SO_PEERCRED setting
Pavel Pisa4dc3b162005-05-01 08:59:25 -0700237 * @sk_rcvlowat: %SO_RCVLOWAT setting
238 * @sk_rcvtimeo: %SO_RCVTIMEO setting
239 * @sk_sndtimeo: %SO_SNDTIMEO setting
David S. Millerc58dc012010-04-27 15:05:31 -0700240 * @sk_rxhash: flow hash received from netif layer
Pavel Pisa4dc3b162005-05-01 08:59:25 -0700241 * @sk_filter: socket filtering instructions
242 * @sk_protinfo: private area, net family specific, when not using slab
243 * @sk_timer: sock cleanup timer
244 * @sk_stamp: time stamp of last packet received
245 * @sk_socket: Identd and reporting IO signals
246 * @sk_user_data: RPC layer private data
247 * @sk_sndmsg_page: cached page for sendmsg
248 * @sk_sndmsg_off: cached offset for sendmsg
249 * @sk_send_head: front of stuff to transmit
Martin Waitz67be2dd2005-05-01 08:59:26 -0700250 * @sk_security: used by security modules
Randy Dunlap31729362008-02-18 20:52:13 -0800251 * @sk_mark: generic packet mark
Randy Dunlap53c3fa22010-08-09 13:41:07 +0000252 * @sk_classid: this socket's cgroup classid
Glauber Costae1aab162011-12-11 21:47:03 +0000253 * @sk_cgrp: this socket's cgroup-specific proto data
Pavel Pisa4dc3b162005-05-01 08:59:25 -0700254 * @sk_write_pending: a write to stream socket waits to start
255 * @sk_state_change: callback to indicate change in the state of the sock
256 * @sk_data_ready: callback to indicate there is data to be processed
257 * @sk_write_space: callback to indicate there is bf sending space available
258 * @sk_error_report: callback to indicate errors (e.g. %MSG_ERRQUEUE)
259 * @sk_backlog_rcv: callback to process the backlog
260 * @sk_destruct: called at sock freeing time, i.e. when all refcnt == 0
Linus Torvalds1da177e2005-04-16 15:20:36 -0700261 */
262struct sock {
263 /*
Arnaldo Carvalho de Melo8feaf0c2005-08-09 20:09:30 -0700264 * Now struct inet_timewait_sock also uses sock_common, so please just
Linus Torvalds1da177e2005-04-16 15:20:36 -0700265 * don't add nothing before this first member (__sk_common) --acme
266 */
267 struct sock_common __sk_common;
Eric Dumazet4dc6dc72009-07-15 23:13:10 +0000268#define sk_node __sk_common.skc_node
269#define sk_nulls_node __sk_common.skc_nulls_node
270#define sk_refcnt __sk_common.skc_refcnt
Krishna Kumare022f0b2009-10-19 23:46:20 +0000271#define sk_tx_queue_mapping __sk_common.skc_tx_queue_mapping
Eric Dumazet4dc6dc72009-07-15 23:13:10 +0000272
Eric Dumazet68835ab2010-11-30 19:04:07 +0000273#define sk_dontcopy_begin __sk_common.skc_dontcopy_begin
274#define sk_dontcopy_end __sk_common.skc_dontcopy_end
Eric Dumazet4dc6dc72009-07-15 23:13:10 +0000275#define sk_hash __sk_common.skc_hash
Linus Torvalds1da177e2005-04-16 15:20:36 -0700276#define sk_family __sk_common.skc_family
277#define sk_state __sk_common.skc_state
278#define sk_reuse __sk_common.skc_reuse
279#define sk_bound_dev_if __sk_common.skc_bound_dev_if
Linus Torvalds1da177e2005-04-16 15:20:36 -0700280#define sk_bind_node __sk_common.skc_bind_node
Arnaldo Carvalho de Melo8feaf0c2005-08-09 20:09:30 -0700281#define sk_prot __sk_common.skc_prot
Eric W. Biederman07feaeb2007-09-12 11:58:02 +0200282#define sk_net __sk_common.skc_net
Eric Dumazetb178bb32010-11-16 05:56:04 +0000283 socket_lock_t sk_lock;
284 struct sk_buff_head sk_receive_queue;
285 /*
286 * The backlog queue is special, it is always used with
287 * the per-socket spinlock held and requires low latency
288 * access. Therefore we special case it's implementation.
289 * Note : rmem_alloc is in this structure to fill a hole
290 * on 64bit arches, not because its logically part of
291 * backlog.
292 */
293 struct {
294 atomic_t rmem_alloc;
295 int len;
296 struct sk_buff *head;
297 struct sk_buff *tail;
298 } sk_backlog;
299#define sk_rmem_alloc sk_backlog.rmem_alloc
300 int sk_forward_alloc;
301#ifdef CONFIG_RPS
302 __u32 sk_rxhash;
303#endif
304 atomic_t sk_drops;
305 int sk_rcvbuf;
306
307 struct sk_filter __rcu *sk_filter;
Eric Dumazeteaefd112011-02-18 03:26:36 +0000308 struct socket_wq __rcu *sk_wq;
Eric Dumazetb178bb32010-11-16 05:56:04 +0000309
310#ifdef CONFIG_NET_DMA
311 struct sk_buff_head sk_async_wait_queue;
312#endif
313
314#ifdef CONFIG_XFRM
315 struct xfrm_policy *sk_policy[2];
316#endif
317 unsigned long sk_flags;
318 struct dst_entry *sk_dst_cache;
319 spinlock_t sk_dst_lock;
320 atomic_t sk_wmem_alloc;
321 atomic_t sk_omem_alloc;
322 int sk_sndbuf;
323 struct sk_buff_head sk_write_queue;
Vegard Nossuma98b65a2009-02-26 14:46:57 +0100324 kmemcheck_bitfield_begin(flags);
Eric Dumazet5fdb9972009-10-08 22:50:25 +0000325 unsigned int sk_shutdown : 2,
326 sk_no_check : 2,
327 sk_userlocks : 4,
328 sk_protocol : 8,
329 sk_type : 16;
Vegard Nossuma98b65a2009-02-26 14:46:57 +0100330 kmemcheck_bitfield_end(flags);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700331 int sk_wmem_queued;
Al Viro7d877f32005-10-21 03:20:43 -0400332 gfp_t sk_allocation;
Michał Mirosławc8f44af2011-11-15 15:29:55 +0000333 netdev_features_t sk_route_caps;
334 netdev_features_t sk_route_nocaps;
Herbert Xubcd76112006-06-30 13:36:35 -0700335 int sk_gso_type;
Peter P Waskiewicz Jr82cc1a72008-03-21 03:43:19 -0700336 unsigned int sk_gso_max_size;
David S. Miller9932cf92006-03-24 15:12:37 -0800337 int sk_rcvlowat;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700338 unsigned long sk_lingertime;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700339 struct sk_buff_head sk_error_queue;
Arnaldo Carvalho de Melo476e19c2005-05-05 13:35:15 -0700340 struct proto *sk_prot_creator;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700341 rwlock_t sk_callback_lock;
342 int sk_err,
343 sk_err_soft;
344 unsigned short sk_ack_backlog;
345 unsigned short sk_max_ack_backlog;
346 __u32 sk_priority;
Neil Horman5bc14212011-11-22 05:10:51 +0000347#ifdef CONFIG_CGROUPS
348 __u32 sk_cgrp_prioidx;
349#endif
Eric W. Biederman109f6e32010-06-13 03:30:14 +0000350 struct pid *sk_peer_pid;
351 const struct cred *sk_peer_cred;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700352 long sk_rcvtimeo;
353 long sk_sndtimeo;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700354 void *sk_protinfo;
355 struct timer_list sk_timer;
Eric Dumazetb7aa0bf2007-04-19 16:16:32 -0700356 ktime_t sk_stamp;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700357 struct socket *sk_socket;
358 void *sk_user_data;
359 struct page *sk_sndmsg_page;
360 struct sk_buff *sk_send_head;
361 __u32 sk_sndmsg_off;
362 int sk_write_pending;
Alexey Dobriyand5f64232008-11-04 14:45:58 -0800363#ifdef CONFIG_SECURITY
Linus Torvalds1da177e2005-04-16 15:20:36 -0700364 void *sk_security;
Alexey Dobriyand5f64232008-11-04 14:45:58 -0800365#endif
Laszlo Attila Toth4a19ec52008-01-30 19:08:16 -0800366 __u32 sk_mark;
Herbert Xuf8451722010-05-24 00:12:34 -0700367 u32 sk_classid;
Glauber Costae1aab162011-12-11 21:47:03 +0000368 struct cg_proto *sk_cgrp;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700369 void (*sk_state_change)(struct sock *sk);
370 void (*sk_data_ready)(struct sock *sk, int bytes);
371 void (*sk_write_space)(struct sock *sk);
372 void (*sk_error_report)(struct sock *sk);
373 int (*sk_backlog_rcv)(struct sock *sk,
374 struct sk_buff *skb);
375 void (*sk_destruct)(struct sock *sk);
376};
377
378/*
379 * Hashed lists helper routines
380 */
Li Zefanc4146642010-02-08 23:18:45 +0000381static inline struct sock *sk_entry(const struct hlist_node *node)
382{
383 return hlist_entry(node, struct sock, sk_node);
384}
385
Arnaldo Carvalho de Meloe48c4142005-08-09 20:09:46 -0700386static inline struct sock *__sk_head(const struct hlist_head *head)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700387{
388 return hlist_entry(head->first, struct sock, sk_node);
389}
390
Arnaldo Carvalho de Meloe48c4142005-08-09 20:09:46 -0700391static inline struct sock *sk_head(const struct hlist_head *head)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700392{
393 return hlist_empty(head) ? NULL : __sk_head(head);
394}
395
Eric Dumazet88ab1932008-11-16 19:39:21 -0800396static inline struct sock *__sk_nulls_head(const struct hlist_nulls_head *head)
397{
398 return hlist_nulls_entry(head->first, struct sock, sk_nulls_node);
399}
400
401static inline struct sock *sk_nulls_head(const struct hlist_nulls_head *head)
402{
403 return hlist_nulls_empty(head) ? NULL : __sk_nulls_head(head);
404}
405
Arnaldo Carvalho de Meloe48c4142005-08-09 20:09:46 -0700406static inline struct sock *sk_next(const struct sock *sk)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700407{
408 return sk->sk_node.next ?
409 hlist_entry(sk->sk_node.next, struct sock, sk_node) : NULL;
410}
411
Eric Dumazet88ab1932008-11-16 19:39:21 -0800412static inline struct sock *sk_nulls_next(const struct sock *sk)
413{
414 return (!is_a_nulls(sk->sk_nulls_node.next)) ?
415 hlist_nulls_entry(sk->sk_nulls_node.next,
416 struct sock, sk_nulls_node) :
417 NULL;
418}
419
Arnaldo Carvalho de Meloe48c4142005-08-09 20:09:46 -0700420static inline int sk_unhashed(const struct sock *sk)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700421{
422 return hlist_unhashed(&sk->sk_node);
423}
424
Arnaldo Carvalho de Meloe48c4142005-08-09 20:09:46 -0700425static inline int sk_hashed(const struct sock *sk)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700426{
Akinobu Mitada753be2006-04-28 15:21:23 -0700427 return !sk_unhashed(sk);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700428}
429
430static __inline__ void sk_node_init(struct hlist_node *node)
431{
432 node->pprev = NULL;
433}
434
Eric Dumazet88ab1932008-11-16 19:39:21 -0800435static __inline__ void sk_nulls_node_init(struct hlist_nulls_node *node)
436{
437 node->pprev = NULL;
438}
439
Linus Torvalds1da177e2005-04-16 15:20:36 -0700440static __inline__ void __sk_del_node(struct sock *sk)
441{
442 __hlist_del(&sk->sk_node);
443}
444
stephen hemminger808f5112010-02-22 07:57:18 +0000445/* NB: equivalent to hlist_del_init_rcu */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700446static __inline__ int __sk_del_node_init(struct sock *sk)
447{
448 if (sk_hashed(sk)) {
449 __sk_del_node(sk);
450 sk_node_init(&sk->sk_node);
451 return 1;
452 }
453 return 0;
454}
455
456/* Grab socket reference count. This operation is valid only
457 when sk is ALREADY grabbed f.e. it is found in hash table
458 or a list and the lookup is made under lock preventing hash table
459 modifications.
460 */
461
462static inline void sock_hold(struct sock *sk)
463{
464 atomic_inc(&sk->sk_refcnt);
465}
466
467/* Ungrab socket in the context, which assumes that socket refcnt
468 cannot hit zero, f.e. it is true in context of any socketcall.
469 */
470static inline void __sock_put(struct sock *sk)
471{
472 atomic_dec(&sk->sk_refcnt);
473}
474
475static __inline__ int sk_del_node_init(struct sock *sk)
476{
477 int rc = __sk_del_node_init(sk);
478
479 if (rc) {
480 /* paranoid for a while -acme */
481 WARN_ON(atomic_read(&sk->sk_refcnt) == 1);
482 __sock_put(sk);
483 }
484 return rc;
485}
stephen hemminger808f5112010-02-22 07:57:18 +0000486#define sk_del_node_init_rcu(sk) sk_del_node_init(sk)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700487
Eric Dumazet88ab1932008-11-16 19:39:21 -0800488static __inline__ int __sk_nulls_del_node_init_rcu(struct sock *sk)
Eric Dumazet271b72c2008-10-29 02:11:14 -0700489{
490 if (sk_hashed(sk)) {
Eric Dumazet88ab1932008-11-16 19:39:21 -0800491 hlist_nulls_del_init_rcu(&sk->sk_nulls_node);
Eric Dumazet271b72c2008-10-29 02:11:14 -0700492 return 1;
493 }
494 return 0;
495}
496
Eric Dumazet88ab1932008-11-16 19:39:21 -0800497static __inline__ int sk_nulls_del_node_init_rcu(struct sock *sk)
Eric Dumazet271b72c2008-10-29 02:11:14 -0700498{
Eric Dumazet88ab1932008-11-16 19:39:21 -0800499 int rc = __sk_nulls_del_node_init_rcu(sk);
Eric Dumazet271b72c2008-10-29 02:11:14 -0700500
501 if (rc) {
502 /* paranoid for a while -acme */
503 WARN_ON(atomic_read(&sk->sk_refcnt) == 1);
504 __sock_put(sk);
505 }
506 return rc;
507}
508
Linus Torvalds1da177e2005-04-16 15:20:36 -0700509static __inline__ void __sk_add_node(struct sock *sk, struct hlist_head *list)
510{
511 hlist_add_head(&sk->sk_node, list);
512}
513
514static __inline__ void sk_add_node(struct sock *sk, struct hlist_head *list)
515{
516 sock_hold(sk);
517 __sk_add_node(sk, list);
518}
519
stephen hemminger808f5112010-02-22 07:57:18 +0000520static __inline__ void sk_add_node_rcu(struct sock *sk, struct hlist_head *list)
521{
522 sock_hold(sk);
523 hlist_add_head_rcu(&sk->sk_node, list);
524}
525
Eric Dumazet88ab1932008-11-16 19:39:21 -0800526static __inline__ void __sk_nulls_add_node_rcu(struct sock *sk, struct hlist_nulls_head *list)
Eric Dumazet271b72c2008-10-29 02:11:14 -0700527{
Eric Dumazet88ab1932008-11-16 19:39:21 -0800528 hlist_nulls_add_head_rcu(&sk->sk_nulls_node, list);
Eric Dumazet271b72c2008-10-29 02:11:14 -0700529}
530
Eric Dumazet88ab1932008-11-16 19:39:21 -0800531static __inline__ void sk_nulls_add_node_rcu(struct sock *sk, struct hlist_nulls_head *list)
Eric Dumazet271b72c2008-10-29 02:11:14 -0700532{
533 sock_hold(sk);
Eric Dumazet88ab1932008-11-16 19:39:21 -0800534 __sk_nulls_add_node_rcu(sk, list);
Eric Dumazet271b72c2008-10-29 02:11:14 -0700535}
536
Linus Torvalds1da177e2005-04-16 15:20:36 -0700537static __inline__ void __sk_del_bind_node(struct sock *sk)
538{
539 __hlist_del(&sk->sk_bind_node);
540}
541
542static __inline__ void sk_add_bind_node(struct sock *sk,
543 struct hlist_head *list)
544{
545 hlist_add_head(&sk->sk_bind_node, list);
546}
547
548#define sk_for_each(__sk, node, list) \
549 hlist_for_each_entry(__sk, node, list, sk_node)
stephen hemminger808f5112010-02-22 07:57:18 +0000550#define sk_for_each_rcu(__sk, node, list) \
551 hlist_for_each_entry_rcu(__sk, node, list, sk_node)
Eric Dumazet88ab1932008-11-16 19:39:21 -0800552#define sk_nulls_for_each(__sk, node, list) \
553 hlist_nulls_for_each_entry(__sk, node, list, sk_nulls_node)
554#define sk_nulls_for_each_rcu(__sk, node, list) \
555 hlist_nulls_for_each_entry_rcu(__sk, node, list, sk_nulls_node)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700556#define sk_for_each_from(__sk, node) \
557 if (__sk && ({ node = &(__sk)->sk_node; 1; })) \
558 hlist_for_each_entry_from(__sk, node, sk_node)
Eric Dumazet88ab1932008-11-16 19:39:21 -0800559#define sk_nulls_for_each_from(__sk, node) \
560 if (__sk && ({ node = &(__sk)->sk_nulls_node; 1; })) \
561 hlist_nulls_for_each_entry_from(__sk, node, sk_nulls_node)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700562#define sk_for_each_safe(__sk, node, tmp, list) \
563 hlist_for_each_entry_safe(__sk, node, tmp, list, sk_node)
564#define sk_for_each_bound(__sk, node, list) \
565 hlist_for_each_entry(__sk, node, list, sk_bind_node)
566
567/* Sock flags */
568enum sock_flags {
569 SOCK_DEAD,
570 SOCK_DONE,
571 SOCK_URGINLINE,
572 SOCK_KEEPOPEN,
573 SOCK_LINGER,
574 SOCK_DESTROY,
575 SOCK_BROADCAST,
576 SOCK_TIMESTAMP,
577 SOCK_ZAPPED,
578 SOCK_USE_WRITE_QUEUE, /* whether to call sk->sk_write_space in sock_wfree */
579 SOCK_DBG, /* %SO_DEBUG setting */
580 SOCK_RCVTSTAMP, /* %SO_TIMESTAMP setting */
Eric Dumazet92f37fd2007-03-25 22:14:49 -0700581 SOCK_RCVTSTAMPNS, /* %SO_TIMESTAMPNS setting */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700582 SOCK_LOCALROUTE, /* route locally only, %SO_DONTROUTE setting */
583 SOCK_QUEUE_SHRUNK, /* write queue has been shrunk recently */
Patrick Ohly20d49472009-02-12 05:03:38 +0000584 SOCK_TIMESTAMPING_TX_HARDWARE, /* %SOF_TIMESTAMPING_TX_HARDWARE */
585 SOCK_TIMESTAMPING_TX_SOFTWARE, /* %SOF_TIMESTAMPING_TX_SOFTWARE */
586 SOCK_TIMESTAMPING_RX_HARDWARE, /* %SOF_TIMESTAMPING_RX_HARDWARE */
587 SOCK_TIMESTAMPING_RX_SOFTWARE, /* %SOF_TIMESTAMPING_RX_SOFTWARE */
588 SOCK_TIMESTAMPING_SOFTWARE, /* %SOF_TIMESTAMPING_SOFTWARE */
589 SOCK_TIMESTAMPING_RAW_HARDWARE, /* %SOF_TIMESTAMPING_RAW_HARDWARE */
590 SOCK_TIMESTAMPING_SYS_HARDWARE, /* %SOF_TIMESTAMPING_SYS_HARDWARE */
Eric Dumazetbcdce712009-10-06 17:28:29 -0700591 SOCK_FASYNC, /* fasync() active */
Neil Horman3b885782009-10-12 13:26:31 -0700592 SOCK_RXQ_OVFL,
Shirley Ma1cdebb42011-07-06 12:17:30 +0000593 SOCK_ZEROCOPY, /* buffers from userspace */
Johannes Berg6e3e9392011-11-09 10:15:42 +0100594 SOCK_WIFI_STATUS, /* push wifi status to userspace */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700595};
596
Ralf Baechle53b924b2005-08-23 10:11:30 -0700597static inline void sock_copy_flags(struct sock *nsk, struct sock *osk)
598{
599 nsk->sk_flags = osk->sk_flags;
600}
601
Linus Torvalds1da177e2005-04-16 15:20:36 -0700602static inline void sock_set_flag(struct sock *sk, enum sock_flags flag)
603{
604 __set_bit(flag, &sk->sk_flags);
605}
606
607static inline void sock_reset_flag(struct sock *sk, enum sock_flags flag)
608{
609 __clear_bit(flag, &sk->sk_flags);
610}
611
612static inline int sock_flag(struct sock *sk, enum sock_flags flag)
613{
614 return test_bit(flag, &sk->sk_flags);
615}
616
617static inline void sk_acceptq_removed(struct sock *sk)
618{
619 sk->sk_ack_backlog--;
620}
621
622static inline void sk_acceptq_added(struct sock *sk)
623{
624 sk->sk_ack_backlog++;
625}
626
627static inline int sk_acceptq_is_full(struct sock *sk)
628{
David S. Miller64a14652007-03-06 11:21:05 -0800629 return sk->sk_ack_backlog > sk->sk_max_ack_backlog;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700630}
631
632/*
633 * Compute minimal free write space needed to queue new packets.
634 */
635static inline int sk_stream_min_wspace(struct sock *sk)
636{
Eric Dumazet8df09ea2007-12-21 03:07:41 -0800637 return sk->sk_wmem_queued >> 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700638}
639
640static inline int sk_stream_wspace(struct sock *sk)
641{
642 return sk->sk_sndbuf - sk->sk_wmem_queued;
643}
644
645extern void sk_stream_write_space(struct sock *sk);
646
647static inline int sk_stream_memory_free(struct sock *sk)
648{
649 return sk->sk_wmem_queued < sk->sk_sndbuf;
650}
651
Zhu Yi8eae9392010-03-04 18:01:40 +0000652/* OOB backlog add */
Zhu Yia3a858f2010-03-04 18:01:47 +0000653static inline void __sk_add_backlog(struct sock *sk, struct sk_buff *skb)
Stephen Hemminger9ee6b532005-11-08 09:39:42 -0800654{
Eric Dumazet7fee2262010-05-11 23:19:48 +0000655 /* dont let skb dst not refcounted, we are going to leave rcu lock */
656 skb_dst_force(skb);
657
658 if (!sk->sk_backlog.tail)
659 sk->sk_backlog.head = skb;
660 else
Stephen Hemminger9ee6b532005-11-08 09:39:42 -0800661 sk->sk_backlog.tail->next = skb;
Eric Dumazet7fee2262010-05-11 23:19:48 +0000662
663 sk->sk_backlog.tail = skb;
Stephen Hemminger9ee6b532005-11-08 09:39:42 -0800664 skb->next = NULL;
665}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700666
Eric Dumazetc3774112010-04-27 15:13:20 -0700667/*
668 * Take into account size of receive queue and backlog queue
Eric Dumazet0fd7bac2011-12-21 07:11:44 +0000669 * Do not take into account this skb truesize,
670 * to allow even a single big packet to come.
Eric Dumazetc3774112010-04-27 15:13:20 -0700671 */
672static inline bool sk_rcvqueues_full(const struct sock *sk, const struct sk_buff *skb)
673{
674 unsigned int qsize = sk->sk_backlog.len + atomic_read(&sk->sk_rmem_alloc);
675
Eric Dumazet0fd7bac2011-12-21 07:11:44 +0000676 return qsize > sk->sk_rcvbuf;
Eric Dumazetc3774112010-04-27 15:13:20 -0700677}
678
Zhu Yi8eae9392010-03-04 18:01:40 +0000679/* The per-socket spinlock must be held here. */
Zhu Yi40456352010-03-07 16:21:39 +0000680static inline __must_check int sk_add_backlog(struct sock *sk, struct sk_buff *skb)
Zhu Yi8eae9392010-03-04 18:01:40 +0000681{
Eric Dumazetc3774112010-04-27 15:13:20 -0700682 if (sk_rcvqueues_full(sk, skb))
Zhu Yi8eae9392010-03-04 18:01:40 +0000683 return -ENOBUFS;
684
Zhu Yia3a858f2010-03-04 18:01:47 +0000685 __sk_add_backlog(sk, skb);
Zhu Yi8eae9392010-03-04 18:01:40 +0000686 sk->sk_backlog.len += skb->truesize;
687 return 0;
688}
689
Peter Zijlstrac57943a2008-10-07 14:18:42 -0700690static inline int sk_backlog_rcv(struct sock *sk, struct sk_buff *skb)
691{
692 return sk->sk_backlog_rcv(sk, skb);
693}
694
David S. Millerc58dc012010-04-27 15:05:31 -0700695static inline void sock_rps_record_flow(const struct sock *sk)
696{
697#ifdef CONFIG_RPS
698 struct rps_sock_flow_table *sock_flow_table;
699
700 rcu_read_lock();
701 sock_flow_table = rcu_dereference(rps_sock_flow_table);
702 rps_record_sock_flow(sock_flow_table, sk->sk_rxhash);
703 rcu_read_unlock();
704#endif
705}
706
707static inline void sock_rps_reset_flow(const struct sock *sk)
708{
709#ifdef CONFIG_RPS
710 struct rps_sock_flow_table *sock_flow_table;
711
712 rcu_read_lock();
713 sock_flow_table = rcu_dereference(rps_sock_flow_table);
714 rps_reset_sock_flow(sock_flow_table, sk->sk_rxhash);
715 rcu_read_unlock();
716#endif
717}
718
Tom Herbertbdeab992011-08-14 19:45:55 +0000719static inline void sock_rps_save_rxhash(struct sock *sk,
720 const struct sk_buff *skb)
David S. Millerc58dc012010-04-27 15:05:31 -0700721{
722#ifdef CONFIG_RPS
Tom Herbertbdeab992011-08-14 19:45:55 +0000723 if (unlikely(sk->sk_rxhash != skb->rxhash)) {
David S. Millerc58dc012010-04-27 15:05:31 -0700724 sock_rps_reset_flow(sk);
Tom Herbertbdeab992011-08-14 19:45:55 +0000725 sk->sk_rxhash = skb->rxhash;
David S. Millerc58dc012010-04-27 15:05:31 -0700726 }
727#endif
728}
729
Tom Herbertbdeab992011-08-14 19:45:55 +0000730static inline void sock_rps_reset_rxhash(struct sock *sk)
731{
732#ifdef CONFIG_RPS
733 sock_rps_reset_flow(sk);
734 sk->sk_rxhash = 0;
735#endif
736}
737
Stephen Hemmingercfcabdc2007-10-09 01:59:42 -0700738#define sk_wait_event(__sk, __timeo, __condition) \
739 ({ int __rc; \
740 release_sock(__sk); \
741 __rc = __condition; \
742 if (!__rc) { \
743 *(__timeo) = schedule_timeout(*(__timeo)); \
744 } \
745 lock_sock(__sk); \
746 __rc = __condition; \
747 __rc; \
748 })
Linus Torvalds1da177e2005-04-16 15:20:36 -0700749
750extern int sk_stream_wait_connect(struct sock *sk, long *timeo_p);
751extern int sk_stream_wait_memory(struct sock *sk, long *timeo_p);
752extern void sk_stream_wait_close(struct sock *sk, long timeo_p);
753extern int sk_stream_error(struct sock *sk, int flags, int err);
754extern void sk_stream_kill_queues(struct sock *sk);
755
756extern int sk_wait_data(struct sock *sk, long *timeo);
757
Arnaldo Carvalho de Melo60236fd2005-06-18 22:47:21 -0700758struct request_sock_ops;
Arnaldo Carvalho de Melo6d6ee432005-12-13 23:25:19 -0800759struct timewait_sock_ops;
Arnaldo Carvalho de Meloab1e0a12008-02-03 04:06:04 -0800760struct inet_hashinfo;
Pavel Emelyanovfc8717b2008-03-22 16:56:51 -0700761struct raw_hashinfo;
Paul Gortmakerde477252011-05-26 13:46:22 -0400762struct module;
Arnaldo Carvalho de Melo2e6599c2005-06-18 22:46:52 -0700763
Linus Torvalds1da177e2005-04-16 15:20:36 -0700764/* Networking protocol blocks we attach to sockets.
765 * socket layer -> transport layer interface
766 * transport -> network interface is defined by struct inet_proto
767 */
768struct proto {
769 void (*close)(struct sock *sk,
770 long timeout);
771 int (*connect)(struct sock *sk,
772 struct sockaddr *uaddr,
773 int addr_len);
774 int (*disconnect)(struct sock *sk, int flags);
775
776 struct sock * (*accept) (struct sock *sk, int flags, int *err);
777
778 int (*ioctl)(struct sock *sk, int cmd,
779 unsigned long arg);
780 int (*init)(struct sock *sk);
Brian Haley7d06b2e2008-06-14 17:04:49 -0700781 void (*destroy)(struct sock *sk);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700782 void (*shutdown)(struct sock *sk, int how);
783 int (*setsockopt)(struct sock *sk, int level,
784 int optname, char __user *optval,
David S. Millerb7058842009-09-30 16:12:20 -0700785 unsigned int optlen);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700786 int (*getsockopt)(struct sock *sk, int level,
787 int optname, char __user *optval,
788 int __user *option);
Alexey Dobriyanaf01d532008-08-28 02:53:51 -0700789#ifdef CONFIG_COMPAT
Dmitry Mishin3fdadf72006-03-20 22:45:21 -0800790 int (*compat_setsockopt)(struct sock *sk,
791 int level,
792 int optname, char __user *optval,
David S. Millerb7058842009-09-30 16:12:20 -0700793 unsigned int optlen);
Dmitry Mishin3fdadf72006-03-20 22:45:21 -0800794 int (*compat_getsockopt)(struct sock *sk,
795 int level,
796 int optname, char __user *optval,
797 int __user *option);
Eric W. Biederman709b46e2011-01-29 16:15:56 +0000798 int (*compat_ioctl)(struct sock *sk,
799 unsigned int cmd, unsigned long arg);
Alexey Dobriyanaf01d532008-08-28 02:53:51 -0700800#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -0700801 int (*sendmsg)(struct kiocb *iocb, struct sock *sk,
802 struct msghdr *msg, size_t len);
803 int (*recvmsg)(struct kiocb *iocb, struct sock *sk,
804 struct msghdr *msg,
805 size_t len, int noblock, int flags,
806 int *addr_len);
807 int (*sendpage)(struct sock *sk, struct page *page,
808 int offset, size_t size, int flags);
809 int (*bind)(struct sock *sk,
810 struct sockaddr *uaddr, int addr_len);
811
812 int (*backlog_rcv) (struct sock *sk,
813 struct sk_buff *skb);
814
815 /* Keeping track of sk's, looking them up, and port selection methods. */
816 void (*hash)(struct sock *sk);
817 void (*unhash)(struct sock *sk);
Eric Dumazet719f8352010-09-08 05:08:44 +0000818 void (*rehash)(struct sock *sk);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700819 int (*get_port)(struct sock *sk, unsigned short snum);
Octavian Purdilafcbdf092010-12-16 14:26:56 -0800820 void (*clear_sk)(struct sock *sk, int size);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700821
Eric Dumazet286ab3d2007-11-05 23:38:39 -0800822 /* Keeping track of sockets in use */
Eric Dumazet65f76512008-01-03 20:46:48 -0800823#ifdef CONFIG_PROC_FS
Pavel Emelyanov13ff3d62008-03-28 16:38:17 -0700824 unsigned int inuse_idx;
Eric Dumazet65f76512008-01-03 20:46:48 -0800825#endif
Arnaldo Carvalho de Meloebb53d72007-11-21 22:08:50 +0800826
Linus Torvalds1da177e2005-04-16 15:20:36 -0700827 /* Memory pressure */
Pavel Emelyanov5c52ba12008-07-16 20:28:10 -0700828 void (*enter_memory_pressure)(struct sock *sk);
Eric Dumazet8d987e52010-11-09 23:24:26 +0000829 atomic_long_t *memory_allocated; /* Current allocated memory. */
Eric Dumazet17483762008-11-25 21:16:35 -0800830 struct percpu_counter *sockets_allocated; /* Current number of sockets. */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700831 /*
832 * Pressure flag: try to collapse.
833 * Technical note: it is used by multiple contexts non atomically.
Hideo Aoki3ab224b2007-12-31 00:11:19 -0800834 * All the __sk_mem_schedule() is of this nature: accounting
Linus Torvalds1da177e2005-04-16 15:20:36 -0700835 * is strict, actions are advisory and have some latency.
836 */
837 int *memory_pressure;
Eric Dumazet8d987e52010-11-09 23:24:26 +0000838 long *sysctl_mem;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700839 int *sysctl_wmem;
840 int *sysctl_rmem;
841 int max_header;
Changli Gao7ba42912010-07-10 20:41:55 +0000842 bool no_autobind;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700843
Eric Dumazet271b72c2008-10-29 02:11:14 -0700844 struct kmem_cache *slab;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700845 unsigned int obj_size;
Eric Dumazet271b72c2008-10-29 02:11:14 -0700846 int slab_flags;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700847
Eric Dumazetdd24c002008-11-25 21:17:14 -0800848 struct percpu_counter *orphan_count;
Arnaldo Carvalho de Melo8feaf0c2005-08-09 20:09:30 -0700849
Arnaldo Carvalho de Melo60236fd2005-06-18 22:47:21 -0700850 struct request_sock_ops *rsk_prot;
Arnaldo Carvalho de Melo6d6ee432005-12-13 23:25:19 -0800851 struct timewait_sock_ops *twsk_prot;
Arnaldo Carvalho de Melo2e6599c2005-06-18 22:46:52 -0700852
Pavel Emelyanov39d8cda2008-03-22 16:50:58 -0700853 union {
854 struct inet_hashinfo *hashinfo;
Eric Dumazet645ca702008-10-29 01:41:45 -0700855 struct udp_table *udp_table;
Pavel Emelyanovfc8717b2008-03-22 16:56:51 -0700856 struct raw_hashinfo *raw_hash;
Pavel Emelyanov39d8cda2008-03-22 16:50:58 -0700857 } h;
Arnaldo Carvalho de Meloab1e0a12008-02-03 04:06:04 -0800858
Linus Torvalds1da177e2005-04-16 15:20:36 -0700859 struct module *owner;
860
861 char name[32];
862
863 struct list_head node;
Arnaldo Carvalho de Meloe6848972005-08-09 19:45:38 -0700864#ifdef SOCK_REFCNT_DEBUG
865 atomic_t socks;
866#endif
Glauber Costae1aab162011-12-11 21:47:03 +0000867#ifdef CONFIG_CGROUP_MEM_RES_CTLR_KMEM
868 /*
869 * cgroup specific init/deinit functions. Called once for all
870 * protocols that implement it, from cgroups populate function.
871 * This function has to setup any files the protocol want to
872 * appear in the kmem cgroup filesystem.
873 */
874 int (*init_cgroup)(struct cgroup *cgrp,
875 struct cgroup_subsys *ss);
876 void (*destroy_cgroup)(struct cgroup *cgrp,
877 struct cgroup_subsys *ss);
878 struct cg_proto *(*proto_cgroup)(struct mem_cgroup *memcg);
879#endif
880};
881
882struct cg_proto {
883 void (*enter_memory_pressure)(struct sock *sk);
884 struct res_counter *memory_allocated; /* Current allocated memory. */
885 struct percpu_counter *sockets_allocated; /* Current number of sockets. */
886 int *memory_pressure;
887 long *sysctl_mem;
888 /*
889 * memcg field is used to find which memcg we belong directly
890 * Each memcg struct can hold more than one cg_proto, so container_of
891 * won't really cut.
892 *
893 * The elegant solution would be having an inverse function to
894 * proto_cgroup in struct proto, but that means polluting the structure
895 * for everybody, instead of just for memcg users.
896 */
897 struct mem_cgroup *memcg;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700898};
899
900extern int proto_register(struct proto *prot, int alloc_slab);
901extern void proto_unregister(struct proto *prot);
902
Arnaldo Carvalho de Meloe6848972005-08-09 19:45:38 -0700903#ifdef SOCK_REFCNT_DEBUG
904static inline void sk_refcnt_debug_inc(struct sock *sk)
905{
906 atomic_inc(&sk->sk_prot->socks);
907}
908
909static inline void sk_refcnt_debug_dec(struct sock *sk)
910{
911 atomic_dec(&sk->sk_prot->socks);
912 printk(KERN_DEBUG "%s socket %p released, %d are still alive\n",
913 sk->sk_prot->name, sk, atomic_read(&sk->sk_prot->socks));
914}
915
Glauber Costae1aab162011-12-11 21:47:03 +0000916inline void sk_refcnt_debug_release(const struct sock *sk)
Arnaldo Carvalho de Meloe6848972005-08-09 19:45:38 -0700917{
918 if (atomic_read(&sk->sk_refcnt) != 1)
919 printk(KERN_DEBUG "Destruction of the %s socket %p delayed, refcnt=%d\n",
920 sk->sk_prot->name, sk, atomic_read(&sk->sk_refcnt));
921}
922#else /* SOCK_REFCNT_DEBUG */
923#define sk_refcnt_debug_inc(sk) do { } while (0)
924#define sk_refcnt_debug_dec(sk) do { } while (0)
925#define sk_refcnt_debug_release(sk) do { } while (0)
926#endif /* SOCK_REFCNT_DEBUG */
927
Glauber Costa376be5f2012-01-20 04:57:14 +0000928#if defined(CONFIG_CGROUP_MEM_RES_CTLR_KMEM) && defined(CONFIG_NET)
Glauber Costae1aab162011-12-11 21:47:03 +0000929extern struct jump_label_key memcg_socket_limit_enabled;
930static inline struct cg_proto *parent_cg_proto(struct proto *proto,
931 struct cg_proto *cg_proto)
932{
933 return proto->proto_cgroup(parent_mem_cgroup(cg_proto->memcg));
934}
935#define mem_cgroup_sockets_enabled static_branch(&memcg_socket_limit_enabled)
936#else
937#define mem_cgroup_sockets_enabled 0
938static inline struct cg_proto *parent_cg_proto(struct proto *proto,
939 struct cg_proto *cg_proto)
940{
941 return NULL;
942}
943#endif
944
945
Glauber Costa180d8cd2011-12-11 21:47:02 +0000946static inline bool sk_has_memory_pressure(const struct sock *sk)
947{
948 return sk->sk_prot->memory_pressure != NULL;
949}
950
951static inline bool sk_under_memory_pressure(const struct sock *sk)
952{
953 if (!sk->sk_prot->memory_pressure)
954 return false;
Glauber Costae1aab162011-12-11 21:47:03 +0000955
956 if (mem_cgroup_sockets_enabled && sk->sk_cgrp)
957 return !!*sk->sk_cgrp->memory_pressure;
958
Glauber Costa180d8cd2011-12-11 21:47:02 +0000959 return !!*sk->sk_prot->memory_pressure;
960}
961
962static inline void sk_leave_memory_pressure(struct sock *sk)
963{
964 int *memory_pressure = sk->sk_prot->memory_pressure;
965
Glauber Costae1aab162011-12-11 21:47:03 +0000966 if (!memory_pressure)
967 return;
968
969 if (*memory_pressure)
Glauber Costa180d8cd2011-12-11 21:47:02 +0000970 *memory_pressure = 0;
Glauber Costae1aab162011-12-11 21:47:03 +0000971
972 if (mem_cgroup_sockets_enabled && sk->sk_cgrp) {
973 struct cg_proto *cg_proto = sk->sk_cgrp;
974 struct proto *prot = sk->sk_prot;
975
976 for (; cg_proto; cg_proto = parent_cg_proto(prot, cg_proto))
977 if (*cg_proto->memory_pressure)
978 *cg_proto->memory_pressure = 0;
979 }
980
Glauber Costa180d8cd2011-12-11 21:47:02 +0000981}
982
983static inline void sk_enter_memory_pressure(struct sock *sk)
984{
Glauber Costae1aab162011-12-11 21:47:03 +0000985 if (!sk->sk_prot->enter_memory_pressure)
986 return;
987
988 if (mem_cgroup_sockets_enabled && sk->sk_cgrp) {
989 struct cg_proto *cg_proto = sk->sk_cgrp;
990 struct proto *prot = sk->sk_prot;
991
992 for (; cg_proto; cg_proto = parent_cg_proto(prot, cg_proto))
993 cg_proto->enter_memory_pressure(sk);
994 }
995
996 sk->sk_prot->enter_memory_pressure(sk);
Glauber Costa180d8cd2011-12-11 21:47:02 +0000997}
998
999static inline long sk_prot_mem_limits(const struct sock *sk, int index)
1000{
1001 long *prot = sk->sk_prot->sysctl_mem;
Glauber Costae1aab162011-12-11 21:47:03 +00001002 if (mem_cgroup_sockets_enabled && sk->sk_cgrp)
1003 prot = sk->sk_cgrp->sysctl_mem;
Glauber Costa180d8cd2011-12-11 21:47:02 +00001004 return prot[index];
1005}
1006
Glauber Costae1aab162011-12-11 21:47:03 +00001007static inline void memcg_memory_allocated_add(struct cg_proto *prot,
1008 unsigned long amt,
1009 int *parent_status)
1010{
1011 struct res_counter *fail;
1012 int ret;
1013
Glauber Costa0e90b312012-01-20 04:57:16 +00001014 ret = res_counter_charge_nofail(prot->memory_allocated,
1015 amt << PAGE_SHIFT, &fail);
Glauber Costae1aab162011-12-11 21:47:03 +00001016 if (ret < 0)
1017 *parent_status = OVER_LIMIT;
1018}
1019
1020static inline void memcg_memory_allocated_sub(struct cg_proto *prot,
1021 unsigned long amt)
1022{
1023 res_counter_uncharge(prot->memory_allocated, amt << PAGE_SHIFT);
1024}
1025
1026static inline u64 memcg_memory_allocated_read(struct cg_proto *prot)
1027{
1028 u64 ret;
1029 ret = res_counter_read_u64(prot->memory_allocated, RES_USAGE);
1030 return ret >> PAGE_SHIFT;
1031}
1032
Glauber Costa180d8cd2011-12-11 21:47:02 +00001033static inline long
1034sk_memory_allocated(const struct sock *sk)
1035{
1036 struct proto *prot = sk->sk_prot;
Glauber Costae1aab162011-12-11 21:47:03 +00001037 if (mem_cgroup_sockets_enabled && sk->sk_cgrp)
1038 return memcg_memory_allocated_read(sk->sk_cgrp);
1039
Glauber Costa180d8cd2011-12-11 21:47:02 +00001040 return atomic_long_read(prot->memory_allocated);
1041}
1042
1043static inline long
Glauber Costae1aab162011-12-11 21:47:03 +00001044sk_memory_allocated_add(struct sock *sk, int amt, int *parent_status)
Glauber Costa180d8cd2011-12-11 21:47:02 +00001045{
1046 struct proto *prot = sk->sk_prot;
Glauber Costae1aab162011-12-11 21:47:03 +00001047
1048 if (mem_cgroup_sockets_enabled && sk->sk_cgrp) {
1049 memcg_memory_allocated_add(sk->sk_cgrp, amt, parent_status);
1050 /* update the root cgroup regardless */
1051 atomic_long_add_return(amt, prot->memory_allocated);
1052 return memcg_memory_allocated_read(sk->sk_cgrp);
1053 }
1054
Glauber Costa180d8cd2011-12-11 21:47:02 +00001055 return atomic_long_add_return(amt, prot->memory_allocated);
1056}
1057
1058static inline void
Glauber Costa0e90b312012-01-20 04:57:16 +00001059sk_memory_allocated_sub(struct sock *sk, int amt)
Glauber Costa180d8cd2011-12-11 21:47:02 +00001060{
1061 struct proto *prot = sk->sk_prot;
Glauber Costae1aab162011-12-11 21:47:03 +00001062
Glauber Costa0e90b312012-01-20 04:57:16 +00001063 if (mem_cgroup_sockets_enabled && sk->sk_cgrp)
Glauber Costae1aab162011-12-11 21:47:03 +00001064 memcg_memory_allocated_sub(sk->sk_cgrp, amt);
1065
Glauber Costa180d8cd2011-12-11 21:47:02 +00001066 atomic_long_sub(amt, prot->memory_allocated);
1067}
1068
1069static inline void sk_sockets_allocated_dec(struct sock *sk)
1070{
1071 struct proto *prot = sk->sk_prot;
Glauber Costae1aab162011-12-11 21:47:03 +00001072
1073 if (mem_cgroup_sockets_enabled && sk->sk_cgrp) {
1074 struct cg_proto *cg_proto = sk->sk_cgrp;
1075
1076 for (; cg_proto; cg_proto = parent_cg_proto(prot, cg_proto))
1077 percpu_counter_dec(cg_proto->sockets_allocated);
1078 }
1079
Glauber Costa180d8cd2011-12-11 21:47:02 +00001080 percpu_counter_dec(prot->sockets_allocated);
1081}
1082
1083static inline void sk_sockets_allocated_inc(struct sock *sk)
1084{
1085 struct proto *prot = sk->sk_prot;
Glauber Costae1aab162011-12-11 21:47:03 +00001086
1087 if (mem_cgroup_sockets_enabled && sk->sk_cgrp) {
1088 struct cg_proto *cg_proto = sk->sk_cgrp;
1089
1090 for (; cg_proto; cg_proto = parent_cg_proto(prot, cg_proto))
1091 percpu_counter_inc(cg_proto->sockets_allocated);
1092 }
1093
Glauber Costa180d8cd2011-12-11 21:47:02 +00001094 percpu_counter_inc(prot->sockets_allocated);
1095}
1096
1097static inline int
1098sk_sockets_allocated_read_positive(struct sock *sk)
1099{
1100 struct proto *prot = sk->sk_prot;
1101
Glauber Costae1aab162011-12-11 21:47:03 +00001102 if (mem_cgroup_sockets_enabled && sk->sk_cgrp)
1103 return percpu_counter_sum_positive(sk->sk_cgrp->sockets_allocated);
1104
Glauber Costa180d8cd2011-12-11 21:47:02 +00001105 return percpu_counter_sum_positive(prot->sockets_allocated);
1106}
1107
1108static inline int
1109proto_sockets_allocated_sum_positive(struct proto *prot)
1110{
1111 return percpu_counter_sum_positive(prot->sockets_allocated);
1112}
1113
1114static inline long
1115proto_memory_allocated(struct proto *prot)
1116{
1117 return atomic_long_read(prot->memory_allocated);
1118}
1119
1120static inline bool
1121proto_memory_pressure(struct proto *prot)
1122{
1123 if (!prot->memory_pressure)
1124 return false;
1125 return !!*prot->memory_pressure;
1126}
1127
Eric Dumazet65f76512008-01-03 20:46:48 -08001128
1129#ifdef CONFIG_PROC_FS
Linus Torvalds1da177e2005-04-16 15:20:36 -07001130/* Called with local bh disabled */
Pavel Emelyanovc29a0bc2008-03-31 19:41:46 -07001131extern void sock_prot_inuse_add(struct net *net, struct proto *prot, int inc);
1132extern int sock_prot_inuse_get(struct net *net, struct proto *proto);
Eric Dumazet65f76512008-01-03 20:46:48 -08001133#else
Pavel Emelyanovc29a0bc2008-03-31 19:41:46 -07001134static void inline sock_prot_inuse_add(struct net *net, struct proto *prot,
1135 int inc)
Eric Dumazet65f76512008-01-03 20:46:48 -08001136{
1137}
Eric Dumazet65f76512008-01-03 20:46:48 -08001138#endif
1139
Linus Torvalds1da177e2005-04-16 15:20:36 -07001140
Arnaldo Carvalho de Melo614c6cb2005-08-09 19:47:37 -07001141/* With per-bucket locks this operation is not-atomic, so that
1142 * this version is not worse.
1143 */
1144static inline void __sk_prot_rehash(struct sock *sk)
1145{
1146 sk->sk_prot->unhash(sk);
1147 sk->sk_prot->hash(sk);
1148}
1149
Octavian Purdilafcbdf092010-12-16 14:26:56 -08001150void sk_prot_clear_portaddr_nulls(struct sock *sk, int size);
1151
Linus Torvalds1da177e2005-04-16 15:20:36 -07001152/* About 10 seconds */
1153#define SOCK_DESTROY_TIME (10*HZ)
1154
1155/* Sockets 0-1023 can't be bound to unless you are superuser */
1156#define PROT_SOCK 1024
1157
1158#define SHUTDOWN_MASK 3
1159#define RCV_SHUTDOWN 1
1160#define SEND_SHUTDOWN 2
1161
1162#define SOCK_SNDBUF_LOCK 1
1163#define SOCK_RCVBUF_LOCK 2
1164#define SOCK_BINDADDR_LOCK 4
1165#define SOCK_BINDPORT_LOCK 8
1166
1167/* sock_iocb: used to kick off async processing of socket ios */
1168struct sock_iocb {
1169 struct list_head list;
1170
1171 int flags;
1172 int size;
1173 struct socket *sock;
1174 struct sock *sk;
1175 struct scm_cookie *scm;
1176 struct msghdr *msg, async_msg;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001177 struct kiocb *kiocb;
1178};
1179
1180static inline struct sock_iocb *kiocb_to_siocb(struct kiocb *iocb)
1181{
1182 return (struct sock_iocb *)iocb->private;
1183}
1184
1185static inline struct kiocb *siocb_to_kiocb(struct sock_iocb *si)
1186{
1187 return si->kiocb;
1188}
1189
1190struct socket_alloc {
1191 struct socket socket;
1192 struct inode vfs_inode;
1193};
1194
1195static inline struct socket *SOCKET_I(struct inode *inode)
1196{
1197 return &container_of(inode, struct socket_alloc, vfs_inode)->socket;
1198}
1199
1200static inline struct inode *SOCK_INODE(struct socket *socket)
1201{
1202 return &container_of(socket, struct socket_alloc, socket)->vfs_inode;
1203}
1204
Hideo Aoki3ab224b2007-12-31 00:11:19 -08001205/*
1206 * Functions for memory accounting
1207 */
1208extern int __sk_mem_schedule(struct sock *sk, int size, int kind);
1209extern void __sk_mem_reclaim(struct sock *sk);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001210
Hideo Aoki3ab224b2007-12-31 00:11:19 -08001211#define SK_MEM_QUANTUM ((int)PAGE_SIZE)
1212#define SK_MEM_QUANTUM_SHIFT ilog2(SK_MEM_QUANTUM)
1213#define SK_MEM_SEND 0
1214#define SK_MEM_RECV 1
Linus Torvalds1da177e2005-04-16 15:20:36 -07001215
Hideo Aoki3ab224b2007-12-31 00:11:19 -08001216static inline int sk_mem_pages(int amt)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001217{
Hideo Aoki3ab224b2007-12-31 00:11:19 -08001218 return (amt + SK_MEM_QUANTUM - 1) >> SK_MEM_QUANTUM_SHIFT;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001219}
1220
Hideo Aoki3ab224b2007-12-31 00:11:19 -08001221static inline int sk_has_account(struct sock *sk)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001222{
Hideo Aoki3ab224b2007-12-31 00:11:19 -08001223 /* return true if protocol supports memory accounting */
1224 return !!sk->sk_prot->memory_allocated;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001225}
1226
Hideo Aoki3ab224b2007-12-31 00:11:19 -08001227static inline int sk_wmem_schedule(struct sock *sk, int size)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001228{
Hideo Aoki3ab224b2007-12-31 00:11:19 -08001229 if (!sk_has_account(sk))
1230 return 1;
Herbert Xud80d99d2005-09-01 17:48:23 -07001231 return size <= sk->sk_forward_alloc ||
Hideo Aoki3ab224b2007-12-31 00:11:19 -08001232 __sk_mem_schedule(sk, size, SK_MEM_SEND);
1233}
1234
1235static inline int sk_rmem_schedule(struct sock *sk, int size)
1236{
1237 if (!sk_has_account(sk))
1238 return 1;
1239 return size <= sk->sk_forward_alloc ||
1240 __sk_mem_schedule(sk, size, SK_MEM_RECV);
1241}
1242
1243static inline void sk_mem_reclaim(struct sock *sk)
1244{
1245 if (!sk_has_account(sk))
1246 return;
1247 if (sk->sk_forward_alloc >= SK_MEM_QUANTUM)
1248 __sk_mem_reclaim(sk);
1249}
1250
David S. Miller9993e7d2008-01-10 21:56:38 -08001251static inline void sk_mem_reclaim_partial(struct sock *sk)
1252{
1253 if (!sk_has_account(sk))
1254 return;
1255 if (sk->sk_forward_alloc > SK_MEM_QUANTUM)
1256 __sk_mem_reclaim(sk);
1257}
1258
Hideo Aoki3ab224b2007-12-31 00:11:19 -08001259static inline void sk_mem_charge(struct sock *sk, int size)
1260{
1261 if (!sk_has_account(sk))
1262 return;
1263 sk->sk_forward_alloc -= size;
1264}
1265
1266static inline void sk_mem_uncharge(struct sock *sk, int size)
1267{
1268 if (!sk_has_account(sk))
1269 return;
1270 sk->sk_forward_alloc += size;
1271}
1272
1273static inline void sk_wmem_free_skb(struct sock *sk, struct sk_buff *skb)
1274{
Hideo Aoki3ab224b2007-12-31 00:11:19 -08001275 sock_set_flag(sk, SOCK_QUEUE_SHRUNK);
1276 sk->sk_wmem_queued -= skb->truesize;
1277 sk_mem_uncharge(sk, skb->truesize);
1278 __kfree_skb(skb);
Herbert Xud80d99d2005-09-01 17:48:23 -07001279}
1280
Linus Torvalds1da177e2005-04-16 15:20:36 -07001281/* Used by processes to "lock" a socket state, so that
1282 * interrupts and bottom half handlers won't change it
1283 * from under us. It essentially blocks any incoming
1284 * packets, so that we won't get any new data or any
1285 * packets that change the state of the socket.
1286 *
1287 * While locked, BH processing will add new packets to
1288 * the backlog queue. This queue is processed by the
1289 * owner of the socket lock right before it is released.
1290 *
1291 * Since ~2.3.5 it is also exclusive sleep lock serializing
1292 * accesses from user process context.
1293 */
John Heffnerd2e91172007-09-12 10:44:19 +02001294#define sock_owned_by_user(sk) ((sk)->sk_lock.owned)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001295
Peter Zijlstraed075362006-12-06 20:35:24 -08001296/*
1297 * Macro so as to not evaluate some arguments when
1298 * lockdep is not enabled.
1299 *
1300 * Mark both the sk_lock and the sk_lock.slock as a
1301 * per-address-family lock class.
1302 */
1303#define sock_lock_init_class_and_name(sk, sname, skey, name, key) \
1304do { \
Ingo Molnare8f6fbf2008-11-12 01:38:36 +00001305 sk->sk_lock.owned = 0; \
Peter Zijlstraed075362006-12-06 20:35:24 -08001306 init_waitqueue_head(&sk->sk_lock.wq); \
1307 spin_lock_init(&(sk)->sk_lock.slock); \
1308 debug_check_no_locks_freed((void *)&(sk)->sk_lock, \
1309 sizeof((sk)->sk_lock)); \
1310 lockdep_set_class_and_name(&(sk)->sk_lock.slock, \
1311 (skey), (sname)); \
1312 lockdep_init_map(&(sk)->sk_lock.dep_map, (name), (key), 0); \
1313} while (0)
1314
Harvey Harrison41380932007-12-12 10:46:51 -08001315extern void lock_sock_nested(struct sock *sk, int subclass);
Peter Zijlstrafcc70d52006-11-08 22:44:35 -08001316
1317static inline void lock_sock(struct sock *sk)
1318{
1319 lock_sock_nested(sk, 0);
1320}
1321
Harvey Harrison41380932007-12-12 10:46:51 -08001322extern void release_sock(struct sock *sk);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001323
1324/* BH context may only use the following locking interface. */
1325#define bh_lock_sock(__sk) spin_lock(&((__sk)->sk_lock.slock))
Ingo Molnarc6366182006-07-03 00:25:13 -07001326#define bh_lock_sock_nested(__sk) \
1327 spin_lock_nested(&((__sk)->sk_lock.slock), \
1328 SINGLE_DEPTH_NESTING)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001329#define bh_unlock_sock(__sk) spin_unlock(&((__sk)->sk_lock.slock))
1330
Eric Dumazet8a74ad62010-05-26 19:20:18 +00001331extern bool lock_sock_fast(struct sock *sk);
1332/**
1333 * unlock_sock_fast - complement of lock_sock_fast
1334 * @sk: socket
1335 * @slow: slow mode
1336 *
1337 * fast unlock socket for user context.
1338 * If slow mode is on, we call regular release_sock()
1339 */
1340static inline void unlock_sock_fast(struct sock *sk, bool slow)
Eric Dumazet4b0b72f2010-04-28 14:35:48 -07001341{
Eric Dumazet8a74ad62010-05-26 19:20:18 +00001342 if (slow)
1343 release_sock(sk);
1344 else
1345 spin_unlock_bh(&sk->sk_lock.slock);
Eric Dumazet4b0b72f2010-04-28 14:35:48 -07001346}
1347
Eric Dumazet4b0b72f2010-04-28 14:35:48 -07001348
Eric W. Biederman1b8d7ae2007-10-08 23:24:22 -07001349extern struct sock *sk_alloc(struct net *net, int family,
Al Virodd0fc662005-10-07 07:46:04 +01001350 gfp_t priority,
Pavel Emelyanov6257ff22007-11-01 00:39:31 -07001351 struct proto *prot);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001352extern void sk_free(struct sock *sk);
Denis V. Lunevedf02082008-02-29 11:18:32 -08001353extern void sk_release_kernel(struct sock *sk);
Eric Dumazete56c57d2011-11-08 17:07:07 -05001354extern struct sock *sk_clone_lock(const struct sock *sk,
1355 const gfp_t priority);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001356
1357extern struct sk_buff *sock_wmalloc(struct sock *sk,
1358 unsigned long size, int force,
Al Virodd0fc662005-10-07 07:46:04 +01001359 gfp_t priority);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001360extern struct sk_buff *sock_rmalloc(struct sock *sk,
1361 unsigned long size, int force,
Al Virodd0fc662005-10-07 07:46:04 +01001362 gfp_t priority);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001363extern void sock_wfree(struct sk_buff *skb);
1364extern void sock_rfree(struct sk_buff *skb);
1365
1366extern int sock_setsockopt(struct socket *sock, int level,
1367 int op, char __user *optval,
David S. Millerb7058842009-09-30 16:12:20 -07001368 unsigned int optlen);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001369
1370extern int sock_getsockopt(struct socket *sock, int level,
1371 int op, char __user *optval,
1372 int __user *optlen);
1373extern struct sk_buff *sock_alloc_send_skb(struct sock *sk,
1374 unsigned long size,
1375 int noblock,
1376 int *errcode);
Herbert Xu4cc7f682009-02-04 16:55:54 -08001377extern struct sk_buff *sock_alloc_send_pskb(struct sock *sk,
1378 unsigned long header_len,
1379 unsigned long data_len,
1380 int noblock,
1381 int *errcode);
Victor Fusco86a76ca2005-07-08 14:57:47 -07001382extern void *sock_kmalloc(struct sock *sk, int size,
Al Virodd0fc662005-10-07 07:46:04 +01001383 gfp_t priority);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001384extern void sock_kfree_s(struct sock *sk, void *mem, int size);
1385extern void sk_send_sigurg(struct sock *sk);
1386
Herbert Xuf8451722010-05-24 00:12:34 -07001387#ifdef CONFIG_CGROUPS
1388extern void sock_update_classid(struct sock *sk);
1389#else
1390static inline void sock_update_classid(struct sock *sk)
1391{
1392}
1393#endif
1394
Linus Torvalds1da177e2005-04-16 15:20:36 -07001395/*
1396 * Functions to fill in entries in struct proto_ops when a protocol
1397 * does not implement a particular function.
1398 */
1399extern int sock_no_bind(struct socket *,
1400 struct sockaddr *, int);
1401extern int sock_no_connect(struct socket *,
1402 struct sockaddr *, int, int);
1403extern int sock_no_socketpair(struct socket *,
1404 struct socket *);
1405extern int sock_no_accept(struct socket *,
1406 struct socket *, int);
1407extern int sock_no_getname(struct socket *,
1408 struct sockaddr *, int *, int);
1409extern unsigned int sock_no_poll(struct file *, struct socket *,
1410 struct poll_table_struct *);
1411extern int sock_no_ioctl(struct socket *, unsigned int,
1412 unsigned long);
1413extern int sock_no_listen(struct socket *, int);
1414extern int sock_no_shutdown(struct socket *, int);
1415extern int sock_no_getsockopt(struct socket *, int , int,
1416 char __user *, int __user *);
1417extern int sock_no_setsockopt(struct socket *, int, int,
David S. Millerb7058842009-09-30 16:12:20 -07001418 char __user *, unsigned int);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001419extern int sock_no_sendmsg(struct kiocb *, struct socket *,
1420 struct msghdr *, size_t);
1421extern int sock_no_recvmsg(struct kiocb *, struct socket *,
1422 struct msghdr *, size_t, int);
1423extern int sock_no_mmap(struct file *file,
1424 struct socket *sock,
1425 struct vm_area_struct *vma);
1426extern ssize_t sock_no_sendpage(struct socket *sock,
1427 struct page *page,
1428 int offset, size_t size,
1429 int flags);
1430
1431/*
1432 * Functions to fill in entries in struct proto_ops when a protocol
1433 * uses the inet style.
1434 */
1435extern int sock_common_getsockopt(struct socket *sock, int level, int optname,
1436 char __user *optval, int __user *optlen);
1437extern int sock_common_recvmsg(struct kiocb *iocb, struct socket *sock,
1438 struct msghdr *msg, size_t size, int flags);
1439extern int sock_common_setsockopt(struct socket *sock, int level, int optname,
David S. Millerb7058842009-09-30 16:12:20 -07001440 char __user *optval, unsigned int optlen);
Dmitry Mishin3fdadf72006-03-20 22:45:21 -08001441extern int compat_sock_common_getsockopt(struct socket *sock, int level,
1442 int optname, char __user *optval, int __user *optlen);
1443extern int compat_sock_common_setsockopt(struct socket *sock, int level,
David S. Millerb7058842009-09-30 16:12:20 -07001444 int optname, char __user *optval, unsigned int optlen);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001445
1446extern void sk_common_release(struct sock *sk);
1447
1448/*
1449 * Default socket callbacks and setup code
1450 */
1451
1452/* Initialise core socket variables */
1453extern void sock_init_data(struct socket *sock, struct sock *sk);
1454
Eric Dumazet46bcf142010-12-06 09:29:43 -08001455extern void sk_filter_release_rcu(struct rcu_head *rcu);
1456
Linus Torvalds1da177e2005-04-16 15:20:36 -07001457/**
Ben Hutchings1a5778a2010-02-14 22:35:47 -08001458 * sk_filter_release - release a socket filter
Paul Bonserdc9b3342006-11-23 17:56:13 -08001459 * @fp: filter to remove
1460 *
1461 * Remove a filter from a socket and release its resources.
1462 */
1463
Pavel Emelyanov309dd5f2007-10-17 21:21:51 -07001464static inline void sk_filter_release(struct sk_filter *fp)
1465{
1466 if (atomic_dec_and_test(&fp->refcnt))
Eric Dumazet80f8f102011-01-18 07:46:52 +00001467 call_rcu(&fp->rcu, sk_filter_release_rcu);
Pavel Emelyanov309dd5f2007-10-17 21:21:51 -07001468}
1469
1470static inline void sk_filter_uncharge(struct sock *sk, struct sk_filter *fp)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001471{
1472 unsigned int size = sk_filter_len(fp);
1473
1474 atomic_sub(size, &sk->sk_omem_alloc);
Pavel Emelyanov309dd5f2007-10-17 21:21:51 -07001475 sk_filter_release(fp);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001476}
1477
1478static inline void sk_filter_charge(struct sock *sk, struct sk_filter *fp)
1479{
1480 atomic_inc(&fp->refcnt);
1481 atomic_add(sk_filter_len(fp), &sk->sk_omem_alloc);
1482}
1483
1484/*
1485 * Socket reference counting postulates.
1486 *
1487 * * Each user of socket SHOULD hold a reference count.
1488 * * Each access point to socket (an hash table bucket, reference from a list,
1489 * running timer, skb in flight MUST hold a reference count.
1490 * * When reference count hits 0, it means it will never increase back.
1491 * * When reference count hits 0, it means that no references from
1492 * outside exist to this socket and current process on current CPU
1493 * is last user and may/should destroy this socket.
1494 * * sk_free is called from any context: process, BH, IRQ. When
1495 * it is called, socket has no references from outside -> sk_free
1496 * may release descendant resources allocated by the socket, but
1497 * to the time when it is called, socket is NOT referenced by any
1498 * hash tables, lists etc.
1499 * * Packets, delivered from outside (from network or from another process)
1500 * and enqueued on receive/error queues SHOULD NOT grab reference count,
1501 * when they sit in queue. Otherwise, packets will leak to hole, when
1502 * socket is looked up by one cpu and unhasing is made by another CPU.
1503 * It is true for udp/raw, netlink (leak to receive and error queues), tcp
1504 * (leak to backlog). Packet socket does all the processing inside
1505 * BR_NETPROTO_LOCK, so that it has not this race condition. UNIX sockets
1506 * use separate SMP lock, so that they are prone too.
1507 */
1508
1509/* Ungrab socket and destroy it, if it was the last reference. */
1510static inline void sock_put(struct sock *sk)
1511{
1512 if (atomic_dec_and_test(&sk->sk_refcnt))
1513 sk_free(sk);
1514}
1515
Arnaldo Carvalho de Melo58a5a7b2006-11-16 14:06:06 -02001516extern int sk_receive_skb(struct sock *sk, struct sk_buff *skb,
1517 const int nested);
Arnaldo Carvalho de Melo25995ff2005-12-27 02:42:22 -02001518
Krishna Kumare022f0b2009-10-19 23:46:20 +00001519static inline void sk_tx_queue_set(struct sock *sk, int tx_queue)
1520{
1521 sk->sk_tx_queue_mapping = tx_queue;
1522}
1523
1524static inline void sk_tx_queue_clear(struct sock *sk)
1525{
1526 sk->sk_tx_queue_mapping = -1;
1527}
1528
1529static inline int sk_tx_queue_get(const struct sock *sk)
1530{
Tom Herbertb0f77d02010-07-14 20:50:29 -07001531 return sk ? sk->sk_tx_queue_mapping : -1;
Krishna Kumare022f0b2009-10-19 23:46:20 +00001532}
1533
David S. Miller972692e2008-06-17 22:41:38 -07001534static inline void sk_set_socket(struct sock *sk, struct socket *sock)
1535{
Krishna Kumare022f0b2009-10-19 23:46:20 +00001536 sk_tx_queue_clear(sk);
David S. Miller972692e2008-06-17 22:41:38 -07001537 sk->sk_socket = sock;
1538}
1539
Eric Dumazetaa395142010-04-20 13:03:51 +00001540static inline wait_queue_head_t *sk_sleep(struct sock *sk)
1541{
Eric Dumazeteaefd112011-02-18 03:26:36 +00001542 BUILD_BUG_ON(offsetof(struct socket_wq, wait) != 0);
1543 return &rcu_dereference_raw(sk->sk_wq)->wait;
Eric Dumazetaa395142010-04-20 13:03:51 +00001544}
Linus Torvalds1da177e2005-04-16 15:20:36 -07001545/* Detach socket from process context.
1546 * Announce socket dead, detach it from wait queue and inode.
1547 * Note that parent inode held reference count on this struct sock,
1548 * we do not release it in this function, because protocol
1549 * probably wants some additional cleanups or even continuing
1550 * to work with this socket (TCP).
1551 */
1552static inline void sock_orphan(struct sock *sk)
1553{
1554 write_lock_bh(&sk->sk_callback_lock);
1555 sock_set_flag(sk, SOCK_DEAD);
David S. Miller972692e2008-06-17 22:41:38 -07001556 sk_set_socket(sk, NULL);
Eric Dumazet43815482010-04-29 11:01:49 +00001557 sk->sk_wq = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001558 write_unlock_bh(&sk->sk_callback_lock);
1559}
1560
1561static inline void sock_graft(struct sock *sk, struct socket *parent)
1562{
1563 write_lock_bh(&sk->sk_callback_lock);
Eric Dumazeteaefd112011-02-18 03:26:36 +00001564 sk->sk_wq = parent->wq;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001565 parent->sk = sk;
David S. Miller972692e2008-06-17 22:41:38 -07001566 sk_set_socket(sk, parent);
Venkat Yekkirala4237c752006-07-24 23:32:50 -07001567 security_sock_graft(sk, parent);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001568 write_unlock_bh(&sk->sk_callback_lock);
1569}
1570
1571extern int sock_i_uid(struct sock *sk);
1572extern unsigned long sock_i_ino(struct sock *sk);
1573
1574static inline struct dst_entry *
1575__sk_dst_get(struct sock *sk)
1576{
Michal Hockod8bf4ca2011-07-08 14:39:41 +02001577 return rcu_dereference_check(sk->sk_dst_cache, sock_owned_by_user(sk) ||
Eric Dumazetf68c2242010-04-22 16:06:59 -07001578 lockdep_is_held(&sk->sk_lock.slock));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001579}
1580
1581static inline struct dst_entry *
1582sk_dst_get(struct sock *sk)
1583{
1584 struct dst_entry *dst;
1585
Eric Dumazetb6c67122010-04-08 23:03:29 +00001586 rcu_read_lock();
1587 dst = rcu_dereference(sk->sk_dst_cache);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001588 if (dst)
1589 dst_hold(dst);
Eric Dumazetb6c67122010-04-08 23:03:29 +00001590 rcu_read_unlock();
Linus Torvalds1da177e2005-04-16 15:20:36 -07001591 return dst;
1592}
1593
Eric Dumazetb6c67122010-04-08 23:03:29 +00001594extern void sk_reset_txq(struct sock *sk);
1595
1596static inline void dst_negative_advice(struct sock *sk)
1597{
1598 struct dst_entry *ndst, *dst = __sk_dst_get(sk);
1599
1600 if (dst && dst->ops->negative_advice) {
1601 ndst = dst->ops->negative_advice(dst);
1602
1603 if (ndst != dst) {
1604 rcu_assign_pointer(sk->sk_dst_cache, ndst);
1605 sk_reset_txq(sk);
1606 }
1607 }
1608}
1609
Linus Torvalds1da177e2005-04-16 15:20:36 -07001610static inline void
1611__sk_dst_set(struct sock *sk, struct dst_entry *dst)
1612{
1613 struct dst_entry *old_dst;
1614
Krishna Kumare022f0b2009-10-19 23:46:20 +00001615 sk_tx_queue_clear(sk);
Eric Dumazet0b53ff22010-04-26 20:40:43 +00001616 /*
1617 * This can be called while sk is owned by the caller only,
1618 * with no state that can be checked in a rcu_dereference_check() cond
1619 */
1620 old_dst = rcu_dereference_raw(sk->sk_dst_cache);
Eric Dumazetb6c67122010-04-08 23:03:29 +00001621 rcu_assign_pointer(sk->sk_dst_cache, dst);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001622 dst_release(old_dst);
1623}
1624
1625static inline void
1626sk_dst_set(struct sock *sk, struct dst_entry *dst)
1627{
Eric Dumazetb6c67122010-04-08 23:03:29 +00001628 spin_lock(&sk->sk_dst_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001629 __sk_dst_set(sk, dst);
Eric Dumazetb6c67122010-04-08 23:03:29 +00001630 spin_unlock(&sk->sk_dst_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001631}
1632
1633static inline void
1634__sk_dst_reset(struct sock *sk)
1635{
Eric Dumazetb6c67122010-04-08 23:03:29 +00001636 __sk_dst_set(sk, NULL);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001637}
1638
1639static inline void
1640sk_dst_reset(struct sock *sk)
1641{
Eric Dumazetb6c67122010-04-08 23:03:29 +00001642 spin_lock(&sk->sk_dst_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001643 __sk_dst_reset(sk);
Eric Dumazetb6c67122010-04-08 23:03:29 +00001644 spin_unlock(&sk->sk_dst_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001645}
1646
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
Denis Vlasenkof0088a52006-03-28 01:08:21 -08001649extern struct dst_entry *sk_dst_check(struct sock *sk, u32 cookie);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001650
Herbert Xubcd76112006-06-30 13:36:35 -07001651static inline int sk_can_gso(const struct sock *sk)
1652{
1653 return net_gso_ok(sk->sk_route_caps, sk->sk_gso_type);
1654}
1655
Andi Kleen99580892007-04-20 17:12:43 -07001656extern void sk_setup_caps(struct sock *sk, struct dst_entry *dst);
Arnaldo Carvalho de Melo6cbb0df2005-08-09 19:49:02 -07001657
Michał Mirosławc8f44af2011-11-15 15:29:55 +00001658static inline void sk_nocaps_add(struct sock *sk, netdev_features_t flags)
Eric Dumazeta4654192010-05-16 00:36:33 -07001659{
1660 sk->sk_route_nocaps |= flags;
1661 sk->sk_route_caps &= ~flags;
1662}
1663
Tom Herbertc6e1a0d2011-04-04 22:30:30 -07001664static inline int skb_do_copy_data_nocache(struct sock *sk, struct sk_buff *skb,
1665 char __user *from, char *to,
Wei Yongjun912d3982011-04-06 18:40:12 +00001666 int copy, int offset)
Tom Herbertc6e1a0d2011-04-04 22:30:30 -07001667{
1668 if (skb->ip_summed == CHECKSUM_NONE) {
1669 int err = 0;
1670 __wsum csum = csum_and_copy_from_user(from, to, copy, 0, &err);
1671 if (err)
1672 return err;
Wei Yongjun912d3982011-04-06 18:40:12 +00001673 skb->csum = csum_block_add(skb->csum, csum, offset);
Tom Herbertc6e1a0d2011-04-04 22:30:30 -07001674 } else if (sk->sk_route_caps & NETIF_F_NOCACHE_COPY) {
1675 if (!access_ok(VERIFY_READ, from, copy) ||
1676 __copy_from_user_nocache(to, from, copy))
1677 return -EFAULT;
1678 } else if (copy_from_user(to, from, copy))
1679 return -EFAULT;
1680
1681 return 0;
1682}
1683
1684static inline int skb_add_data_nocache(struct sock *sk, struct sk_buff *skb,
1685 char __user *from, int copy)
1686{
Wei Yongjun912d3982011-04-06 18:40:12 +00001687 int err, offset = skb->len;
Tom Herbertc6e1a0d2011-04-04 22:30:30 -07001688
Wei Yongjun912d3982011-04-06 18:40:12 +00001689 err = skb_do_copy_data_nocache(sk, skb, from, skb_put(skb, copy),
1690 copy, offset);
Tom Herbertc6e1a0d2011-04-04 22:30:30 -07001691 if (err)
Wei Yongjun912d3982011-04-06 18:40:12 +00001692 __skb_trim(skb, offset);
Tom Herbertc6e1a0d2011-04-04 22:30:30 -07001693
1694 return err;
1695}
1696
1697static inline int skb_copy_to_page_nocache(struct sock *sk, char __user *from,
1698 struct sk_buff *skb,
1699 struct page *page,
1700 int off, int copy)
1701{
1702 int err;
1703
Wei Yongjun912d3982011-04-06 18:40:12 +00001704 err = skb_do_copy_data_nocache(sk, skb, from, page_address(page) + off,
1705 copy, skb->len);
Tom Herbertc6e1a0d2011-04-04 22:30:30 -07001706 if (err)
1707 return err;
1708
1709 skb->len += copy;
1710 skb->data_len += copy;
1711 skb->truesize += copy;
1712 sk->sk_wmem_queued += copy;
1713 sk_mem_charge(sk, copy);
1714 return 0;
1715}
1716
Linus Torvalds1da177e2005-04-16 15:20:36 -07001717static inline int skb_copy_to_page(struct sock *sk, char __user *from,
1718 struct sk_buff *skb, struct page *page,
1719 int off, int copy)
1720{
1721 if (skb->ip_summed == CHECKSUM_NONE) {
1722 int err = 0;
Al Viro50842052006-11-14 21:36:34 -08001723 __wsum csum = csum_and_copy_from_user(from,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001724 page_address(page) + off,
1725 copy, 0, &err);
1726 if (err)
1727 return err;
1728 skb->csum = csum_block_add(skb->csum, csum, skb->len);
1729 } else if (copy_from_user(page_address(page) + off, from, copy))
1730 return -EFAULT;
1731
1732 skb->len += copy;
1733 skb->data_len += copy;
1734 skb->truesize += copy;
1735 sk->sk_wmem_queued += copy;
Hideo Aoki3ab224b2007-12-31 00:11:19 -08001736 sk_mem_charge(sk, copy);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001737 return 0;
1738}
1739
Eric Dumazetc5640392009-06-16 10:12:03 +00001740/**
1741 * sk_wmem_alloc_get - returns write allocations
1742 * @sk: socket
1743 *
1744 * Returns sk_wmem_alloc minus initial offset of one
1745 */
1746static inline int sk_wmem_alloc_get(const struct sock *sk)
1747{
1748 return atomic_read(&sk->sk_wmem_alloc) - 1;
1749}
1750
1751/**
1752 * sk_rmem_alloc_get - returns read allocations
1753 * @sk: socket
1754 *
1755 * Returns sk_rmem_alloc
1756 */
1757static inline int sk_rmem_alloc_get(const struct sock *sk)
1758{
1759 return atomic_read(&sk->sk_rmem_alloc);
1760}
1761
1762/**
1763 * sk_has_allocations - check if allocations are outstanding
1764 * @sk: socket
1765 *
1766 * Returns true if socket has write or read allocations
1767 */
1768static inline int sk_has_allocations(const struct sock *sk)
1769{
1770 return sk_wmem_alloc_get(sk) || sk_rmem_alloc_get(sk);
1771}
1772
Jiri Olsaa57de0b2009-07-08 12:09:13 +00001773/**
Eric Dumazet43815482010-04-29 11:01:49 +00001774 * wq_has_sleeper - check if there are any waiting processes
Randy Dunlapacfbe962010-05-24 23:54:18 -07001775 * @wq: struct socket_wq
Jiri Olsaa57de0b2009-07-08 12:09:13 +00001776 *
Eric Dumazet43815482010-04-29 11:01:49 +00001777 * Returns true if socket_wq has waiting processes
Jiri Olsaa57de0b2009-07-08 12:09:13 +00001778 *
Eric Dumazet43815482010-04-29 11:01:49 +00001779 * The purpose of the wq_has_sleeper and sock_poll_wait is to wrap the memory
Jiri Olsaa57de0b2009-07-08 12:09:13 +00001780 * barrier call. They were added due to the race found within the tcp code.
1781 *
1782 * Consider following tcp code paths:
1783 *
1784 * CPU1 CPU2
1785 *
1786 * sys_select receive packet
1787 * ... ...
1788 * __add_wait_queue update tp->rcv_nxt
1789 * ... ...
1790 * tp->rcv_nxt check sock_def_readable
1791 * ... {
Eric Dumazet43815482010-04-29 11:01:49 +00001792 * schedule rcu_read_lock();
1793 * wq = rcu_dereference(sk->sk_wq);
1794 * if (wq && waitqueue_active(&wq->wait))
1795 * wake_up_interruptible(&wq->wait)
Jiri Olsaa57de0b2009-07-08 12:09:13 +00001796 * ...
1797 * }
1798 *
1799 * The race for tcp fires when the __add_wait_queue changes done by CPU1 stay
1800 * in its cache, and so does the tp->rcv_nxt update on CPU2 side. The CPU1
1801 * could then endup calling schedule and sleep forever if there are no more
1802 * data on the socket.
Jiri Olsaad462762009-07-08 12:10:31 +00001803 *
Jiri Olsaa57de0b2009-07-08 12:09:13 +00001804 */
Eric Dumazet43815482010-04-29 11:01:49 +00001805static inline bool wq_has_sleeper(struct socket_wq *wq)
Jiri Olsaa57de0b2009-07-08 12:09:13 +00001806{
Eric Dumazet43815482010-04-29 11:01:49 +00001807
Jiri Olsaa57de0b2009-07-08 12:09:13 +00001808 /*
1809 * We need to be sure we are in sync with the
1810 * add_wait_queue modifications to the wait queue.
1811 *
1812 * This memory barrier is paired in the sock_poll_wait.
1813 */
Eric Dumazet43815482010-04-29 11:01:49 +00001814 smp_mb();
1815 return wq && waitqueue_active(&wq->wait);
Jiri Olsaa57de0b2009-07-08 12:09:13 +00001816}
1817
1818/**
1819 * sock_poll_wait - place memory barrier behind the poll_wait call.
1820 * @filp: file
1821 * @wait_address: socket wait queue
1822 * @p: poll_table
1823 *
Eric Dumazet43815482010-04-29 11:01:49 +00001824 * See the comments in the wq_has_sleeper function.
Jiri Olsaa57de0b2009-07-08 12:09:13 +00001825 */
1826static inline void sock_poll_wait(struct file *filp,
1827 wait_queue_head_t *wait_address, poll_table *p)
1828{
1829 if (p && wait_address) {
1830 poll_wait(filp, wait_address, p);
1831 /*
1832 * We need to be sure we are in sync with the
1833 * socket flags modification.
1834 *
Eric Dumazet43815482010-04-29 11:01:49 +00001835 * This memory barrier is paired in the wq_has_sleeper.
Jiri Olsaa57de0b2009-07-08 12:09:13 +00001836 */
1837 smp_mb();
1838 }
1839}
1840
Linus Torvalds1da177e2005-04-16 15:20:36 -07001841/*
1842 * Queue a received datagram if it will fit. Stream and sequenced
1843 * protocols can't normally use this as they need to fit buffers in
1844 * and play with them.
1845 *
1846 * Inlined as it's very short and called for pretty much every
1847 * packet ever received.
1848 */
1849
1850static inline void skb_set_owner_w(struct sk_buff *skb, struct sock *sk)
1851{
Herbert Xud55d87f2009-06-22 02:25:25 +00001852 skb_orphan(skb);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001853 skb->sk = sk;
1854 skb->destructor = sock_wfree;
Eric Dumazet2b85a342009-06-11 02:55:43 -07001855 /*
1856 * We used to take a refcount on sk, but following operation
1857 * is enough to guarantee sk_free() wont free this sock until
1858 * all in-flight packets are completed
1859 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001860 atomic_add(skb->truesize, &sk->sk_wmem_alloc);
1861}
1862
1863static inline void skb_set_owner_r(struct sk_buff *skb, struct sock *sk)
1864{
Herbert Xud55d87f2009-06-22 02:25:25 +00001865 skb_orphan(skb);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001866 skb->sk = sk;
1867 skb->destructor = sock_rfree;
1868 atomic_add(skb->truesize, &sk->sk_rmem_alloc);
Hideo Aoki3ab224b2007-12-31 00:11:19 -08001869 sk_mem_charge(sk, skb->truesize);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001870}
1871
1872extern void sk_reset_timer(struct sock *sk, struct timer_list* timer,
1873 unsigned long expires);
1874
1875extern void sk_stop_timer(struct sock *sk, struct timer_list* timer);
1876
Denis Vlasenkof0088a52006-03-28 01:08:21 -08001877extern int sock_queue_rcv_skb(struct sock *sk, struct sk_buff *skb);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001878
Eric Dumazetb1faf562010-05-31 23:44:05 -07001879extern int sock_queue_err_skb(struct sock *sk, struct sk_buff *skb);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001880
1881/*
1882 * Recover an error report and clear atomically
1883 */
1884
1885static inline int sock_error(struct sock *sk)
1886{
Benjamin LaHaisec1cbe4b2005-12-13 23:22:19 -08001887 int err;
1888 if (likely(!sk->sk_err))
1889 return 0;
1890 err = xchg(&sk->sk_err, 0);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001891 return -err;
1892}
1893
1894static inline unsigned long sock_wspace(struct sock *sk)
1895{
1896 int amt = 0;
1897
1898 if (!(sk->sk_shutdown & SEND_SHUTDOWN)) {
1899 amt = sk->sk_sndbuf - atomic_read(&sk->sk_wmem_alloc);
1900 if (amt < 0)
1901 amt = 0;
1902 }
1903 return amt;
1904}
1905
1906static inline void sk_wake_async(struct sock *sk, int how, int band)
1907{
Eric Dumazetbcdce712009-10-06 17:28:29 -07001908 if (sock_flag(sk, SOCK_FASYNC))
Linus Torvalds1da177e2005-04-16 15:20:36 -07001909 sock_wake_async(sk->sk_socket, how, band);
1910}
1911
1912#define SOCK_MIN_SNDBUF 2048
Eric Dumazet7a91b4342010-09-26 18:53:07 -07001913/*
1914 * Since sk_rmem_alloc sums skb->truesize, even a small frame might need
1915 * sizeof(sk_buff) + MTU + padding, unless net driver perform copybreak
1916 */
1917#define SOCK_MIN_RCVBUF (2048 + sizeof(struct sk_buff))
Linus Torvalds1da177e2005-04-16 15:20:36 -07001918
1919static inline void sk_stream_moderate_sndbuf(struct sock *sk)
1920{
1921 if (!(sk->sk_userlocks & SOCK_SNDBUF_LOCK)) {
Eric Dumazet8df09ea2007-12-21 03:07:41 -08001922 sk->sk_sndbuf = min(sk->sk_sndbuf, sk->sk_wmem_queued >> 1);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001923 sk->sk_sndbuf = max(sk->sk_sndbuf, SOCK_MIN_SNDBUF);
1924 }
1925}
1926
Pavel Emelyanovdf97c702007-11-29 21:22:33 +11001927struct sk_buff *sk_stream_alloc_skb(struct sock *sk, int size, gfp_t gfp);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001928
1929static inline struct page *sk_stream_alloc_page(struct sock *sk)
1930{
1931 struct page *page = NULL;
1932
Herbert Xuef015782005-09-01 17:48:59 -07001933 page = alloc_pages(sk->sk_allocation, 0);
1934 if (!page) {
Glauber Costa180d8cd2011-12-11 21:47:02 +00001935 sk_enter_memory_pressure(sk);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001936 sk_stream_moderate_sndbuf(sk);
1937 }
1938 return page;
1939}
1940
Linus Torvalds1da177e2005-04-16 15:20:36 -07001941/*
1942 * Default write policy as shown to user space via poll/select/SIGIO
1943 */
1944static inline int sock_writeable(const struct sock *sk)
1945{
Eric Dumazet8df09ea2007-12-21 03:07:41 -08001946 return atomic_read(&sk->sk_wmem_alloc) < (sk->sk_sndbuf >> 1);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001947}
1948
Al Virodd0fc662005-10-07 07:46:04 +01001949static inline gfp_t gfp_any(void)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001950{
Andrew Morton99709372009-02-12 16:43:17 -08001951 return in_softirq() ? GFP_ATOMIC : GFP_KERNEL;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001952}
1953
1954static inline long sock_rcvtimeo(const struct sock *sk, int noblock)
1955{
1956 return noblock ? 0 : sk->sk_rcvtimeo;
1957}
1958
1959static inline long sock_sndtimeo(const struct sock *sk, int noblock)
1960{
1961 return noblock ? 0 : sk->sk_sndtimeo;
1962}
1963
1964static inline int sock_rcvlowat(const struct sock *sk, int waitall, int len)
1965{
1966 return (waitall ? len : min_t(int, sk->sk_rcvlowat, len)) ? : 1;
1967}
1968
1969/* Alas, with timeout socket operations are not restartable.
1970 * Compare this to poll().
1971 */
1972static inline int sock_intr_errno(long timeo)
1973{
1974 return timeo == MAX_SCHEDULE_TIMEOUT ? -ERESTARTSYS : -EINTR;
1975}
1976
Eric Dumazet92f37fd2007-03-25 22:14:49 -07001977extern void __sock_recv_timestamp(struct msghdr *msg, struct sock *sk,
1978 struct sk_buff *skb);
Johannes Berg6e3e9392011-11-09 10:15:42 +01001979extern void __sock_recv_wifi_status(struct msghdr *msg, struct sock *sk,
1980 struct sk_buff *skb);
Eric Dumazet92f37fd2007-03-25 22:14:49 -07001981
Linus Torvalds1da177e2005-04-16 15:20:36 -07001982static __inline__ void
1983sock_recv_timestamp(struct msghdr *msg, struct sock *sk, struct sk_buff *skb)
1984{
Eric Dumazetb7aa0bf2007-04-19 16:16:32 -07001985 ktime_t kt = skb->tstamp;
Patrick Ohly20d49472009-02-12 05:03:38 +00001986 struct skb_shared_hwtstamps *hwtstamps = skb_hwtstamps(skb);
Patrick McHardya61bbcf2005-08-14 17:24:31 -07001987
Patrick Ohly20d49472009-02-12 05:03:38 +00001988 /*
1989 * generate control messages if
1990 * - receive time stamping in software requested (SOCK_RCVTSTAMP
1991 * or SOCK_TIMESTAMPING_RX_SOFTWARE)
1992 * - software time stamp available and wanted
1993 * (SOCK_TIMESTAMPING_SOFTWARE)
1994 * - hardware time stamps available and wanted
1995 * (SOCK_TIMESTAMPING_SYS_HARDWARE or
1996 * SOCK_TIMESTAMPING_RAW_HARDWARE)
1997 */
1998 if (sock_flag(sk, SOCK_RCVTSTAMP) ||
1999 sock_flag(sk, SOCK_TIMESTAMPING_RX_SOFTWARE) ||
2000 (kt.tv64 && sock_flag(sk, SOCK_TIMESTAMPING_SOFTWARE)) ||
2001 (hwtstamps->hwtstamp.tv64 &&
2002 sock_flag(sk, SOCK_TIMESTAMPING_RAW_HARDWARE)) ||
2003 (hwtstamps->syststamp.tv64 &&
2004 sock_flag(sk, SOCK_TIMESTAMPING_SYS_HARDWARE)))
Eric Dumazet92f37fd2007-03-25 22:14:49 -07002005 __sock_recv_timestamp(msg, sk, skb);
2006 else
Eric Dumazetb7aa0bf2007-04-19 16:16:32 -07002007 sk->sk_stamp = kt;
Johannes Berg6e3e9392011-11-09 10:15:42 +01002008
2009 if (sock_flag(sk, SOCK_WIFI_STATUS) && skb->wifi_acked_valid)
2010 __sock_recv_wifi_status(msg, sk, skb);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002011}
2012
Eric Dumazet767dd032010-04-28 19:14:43 +00002013extern void __sock_recv_ts_and_drops(struct msghdr *msg, struct sock *sk,
2014 struct sk_buff *skb);
2015
2016static inline void sock_recv_ts_and_drops(struct msghdr *msg, struct sock *sk,
2017 struct sk_buff *skb)
2018{
2019#define FLAGS_TS_OR_DROPS ((1UL << SOCK_RXQ_OVFL) | \
2020 (1UL << SOCK_RCVTSTAMP) | \
2021 (1UL << SOCK_TIMESTAMPING_RX_SOFTWARE) | \
2022 (1UL << SOCK_TIMESTAMPING_SOFTWARE) | \
2023 (1UL << SOCK_TIMESTAMPING_RAW_HARDWARE) | \
2024 (1UL << SOCK_TIMESTAMPING_SYS_HARDWARE))
2025
2026 if (sk->sk_flags & FLAGS_TS_OR_DROPS)
2027 __sock_recv_ts_and_drops(msg, sk, skb);
2028 else
2029 sk->sk_stamp = skb->tstamp;
2030}
Neil Horman3b885782009-10-12 13:26:31 -07002031
Linus Torvalds1da177e2005-04-16 15:20:36 -07002032/**
Patrick Ohly20d49472009-02-12 05:03:38 +00002033 * sock_tx_timestamp - checks whether the outgoing packet is to be time stamped
Patrick Ohly20d49472009-02-12 05:03:38 +00002034 * @sk: socket sending this packet
Oliver Hartkopp2244d072010-08-17 08:59:14 +00002035 * @tx_flags: filled with instructions for time stamping
Patrick Ohly20d49472009-02-12 05:03:38 +00002036 *
2037 * Currently only depends on SOCK_TIMESTAMPING* flags. Returns error code if
2038 * parameters are invalid.
2039 */
Oliver Hartkopp2244d072010-08-17 08:59:14 +00002040extern int sock_tx_timestamp(struct sock *sk, __u8 *tx_flags);
Patrick Ohly20d49472009-02-12 05:03:38 +00002041
2042/**
Linus Torvalds1da177e2005-04-16 15:20:36 -07002043 * sk_eat_skb - Release a skb if it is no longer needed
Pavel Pisa4dc3b162005-05-01 08:59:25 -07002044 * @sk: socket to eat this skb from
2045 * @skb: socket buffer to eat
Randy Dunlapf4b8ea72006-06-22 16:00:11 -07002046 * @copied_early: flag indicating whether DMA operations copied this data early
Linus Torvalds1da177e2005-04-16 15:20:36 -07002047 *
2048 * This routine must be called with interrupts disabled or with the socket
2049 * locked so that the sk_buff queue operation is ok.
2050*/
Chris Leech624d1162006-05-23 18:01:28 -07002051#ifdef CONFIG_NET_DMA
2052static inline void sk_eat_skb(struct sock *sk, struct sk_buff *skb, int copied_early)
2053{
2054 __skb_unlink(skb, &sk->sk_receive_queue);
2055 if (!copied_early)
2056 __kfree_skb(skb);
2057 else
2058 __skb_queue_tail(&sk->sk_async_wait_queue, skb);
2059}
2060#else
2061static inline void sk_eat_skb(struct sock *sk, struct sk_buff *skb, int copied_early)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002062{
2063 __skb_unlink(skb, &sk->sk_receive_queue);
2064 __kfree_skb(skb);
2065}
Chris Leech624d1162006-05-23 18:01:28 -07002066#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -07002067
YOSHIFUJI Hideaki3b1e0a62008-03-26 02:26:21 +09002068static inline
2069struct net *sock_net(const struct sock *sk)
2070{
Eric Dumazetc2d9ba92010-06-01 06:51:19 +00002071 return read_pnet(&sk->sk_net);
YOSHIFUJI Hideaki3b1e0a62008-03-26 02:26:21 +09002072}
2073
2074static inline
Denis V. Lunevf5aa23f2008-03-26 00:48:17 -07002075void sock_net_set(struct sock *sk, struct net *net)
YOSHIFUJI Hideaki3b1e0a62008-03-26 02:26:21 +09002076{
Eric Dumazetc2d9ba92010-06-01 06:51:19 +00002077 write_pnet(&sk->sk_net, net);
YOSHIFUJI Hideaki3b1e0a62008-03-26 02:26:21 +09002078}
2079
Denis V. Lunevedf02082008-02-29 11:18:32 -08002080/*
2081 * Kernel sockets, f.e. rtnl or icmp_socket, are a part of a namespace.
Lucas De Marchi25985ed2011-03-30 22:57:33 -03002082 * They should not hold a reference to a namespace in order to allow
Denis V. Lunevedf02082008-02-29 11:18:32 -08002083 * to stop it.
2084 * Sockets after sk_change_net should be released using sk_release_kernel
2085 */
2086static inline void sk_change_net(struct sock *sk, struct net *net)
2087{
YOSHIFUJI Hideaki3b1e0a62008-03-26 02:26:21 +09002088 put_net(sock_net(sk));
Denis V. Lunev65a18ec2008-04-16 01:59:46 -07002089 sock_net_set(sk, hold_net(net));
Denis V. Lunevedf02082008-02-29 11:18:32 -08002090}
2091
KOVACS Krisztian23542612008-10-07 12:41:01 -07002092static inline struct sock *skb_steal_sock(struct sk_buff *skb)
2093{
2094 if (unlikely(skb->sk)) {
2095 struct sock *sk = skb->sk;
2096
2097 skb->destructor = NULL;
2098 skb->sk = NULL;
2099 return sk;
2100 }
2101 return NULL;
2102}
2103
Patrick Ohly20d49472009-02-12 05:03:38 +00002104extern void sock_enable_timestamp(struct sock *sk, int flag);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002105extern int sock_get_timestamp(struct sock *, struct timeval __user *);
Eric Dumazetae40eb12007-03-18 17:33:16 -07002106extern int sock_get_timestampns(struct sock *, struct timespec __user *);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002107
2108/*
2109 * Enable debug/info messages
2110 */
Stephen Hemmingera2a316f2007-03-08 20:41:08 -08002111extern int net_msg_warn;
2112#define NETDEBUG(fmt, args...) \
2113 do { if (net_msg_warn) printk(fmt,##args); } while (0)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002114
Stephen Hemmingera2a316f2007-03-08 20:41:08 -08002115#define LIMIT_NETDEBUG(fmt, args...) \
2116 do { if (net_msg_warn && net_ratelimit()) printk(fmt,##args); } while(0)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002117
Linus Torvalds1da177e2005-04-16 15:20:36 -07002118extern __u32 sysctl_wmem_max;
2119extern __u32 sysctl_rmem_max;
2120
Arnaldo Carvalho de Melo20380732005-08-16 02:18:02 -03002121extern void sk_init(void);
2122
David S. Miller6baf1f42005-09-05 18:14:11 -07002123extern int sysctl_optmem_max;
2124
Arnaldo Carvalho de Melo20380732005-08-16 02:18:02 -03002125extern __u32 sysctl_wmem_default;
2126extern __u32 sysctl_rmem_default;
Arnaldo Carvalho de Melo20380732005-08-16 02:18:02 -03002127
Linus Torvalds1da177e2005-04-16 15:20:36 -07002128#endif /* _SOCK_H */