blob: 720773304a85d45b28e3a3b3ffff1a7e998247c5 [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>
Glauber Costa3f134612012-05-29 15:07:11 -070049#include <linux/bitops.h>
Ingo Molnara5b5bb92006-07-03 00:25:35 -070050#include <linux/lockdep.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070051#include <linux/netdevice.h>
52#include <linux/skbuff.h> /* struct sk_buff */
Al Virod7fe0f22006-12-03 23:15:30 -050053#include <linux/mm.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070054#include <linux/security.h>
Tejun Heo5a0e3ad2010-03-24 17:04:11 +090055#include <linux/slab.h>
Tom Herbertc6e1a0d2011-04-04 22:30:30 -070056#include <linux/uaccess.h>
Glauber Costa180d8cd2011-12-11 21:47:02 +000057#include <linux/memcontrol.h>
Glauber Costae1aab162011-12-11 21:47:03 +000058#include <linux/res_counter.h>
Ingo Molnarc5905af2012-02-24 08:31:31 +010059#include <linux/static_key.h>
Al Viro40401532012-02-13 03:58:52 +000060#include <linux/aio.h>
61#include <linux/sched.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070062
63#include <linux/filter.h>
Eric Dumazet88ab1932008-11-16 19:39:21 -080064#include <linux/rculist_nulls.h>
Jiri Olsaa57de0b2009-07-08 12:09:13 +000065#include <linux/poll.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070066
Eric Dumazetc31504d2010-11-15 19:58:26 +000067#include <linux/atomic.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070068#include <net/dst.h>
69#include <net/checksum.h>
70
Eric Dumazet9f048bf2011-12-13 03:59:08 +000071struct cgroup;
72struct cgroup_subsys;
Glauber Costac607b2e2011-12-16 00:52:00 +000073#ifdef CONFIG_NET
Glauber Costa1d62e432012-04-09 19:36:33 -030074int mem_cgroup_sockets_init(struct mem_cgroup *memcg, struct cgroup_subsys *ss);
75void mem_cgroup_sockets_destroy(struct mem_cgroup *memcg);
Glauber Costac607b2e2011-12-16 00:52:00 +000076#else
77static inline
Glauber Costa1d62e432012-04-09 19:36:33 -030078int mem_cgroup_sockets_init(struct mem_cgroup *memcg, struct cgroup_subsys *ss)
Glauber Costac607b2e2011-12-16 00:52:00 +000079{
80 return 0;
81}
82static inline
Glauber Costa1d62e432012-04-09 19:36:33 -030083void mem_cgroup_sockets_destroy(struct mem_cgroup *memcg)
Glauber Costac607b2e2011-12-16 00:52:00 +000084{
85}
86#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -070087/*
88 * This structure really needs to be cleaned up.
89 * Most of it is for TCP, and not used by any of
90 * the other protocols.
91 */
92
93/* Define this to get the SOCK_DBG debugging facility. */
94#define SOCK_DEBUGGING
95#ifdef SOCK_DEBUGGING
96#define SOCK_DEBUG(sk, msg...) do { if ((sk) && sock_flag((sk), SOCK_DBG)) \
97 printk(KERN_DEBUG msg); } while (0)
98#else
Stephen Hemminger4cd90292008-03-21 15:54:53 -070099/* Validate arguments and do nothing */
Joe Perchesb9075fa2011-10-31 17:11:33 -0700100static inline __printf(2, 3)
Eric Dumazetdc6b9b72012-05-16 22:48:15 +0000101void SOCK_DEBUG(const struct sock *sk, const char *msg, ...)
Stephen Hemminger4cd90292008-03-21 15:54:53 -0700102{
103}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700104#endif
105
106/* This is the per-socket lock. The spinlock provides a synchronization
107 * between user contexts and software interrupt processing, whereas the
108 * mini-semaphore synchronizes multiple users amongst themselves.
109 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700110typedef struct {
111 spinlock_t slock;
John Heffnerd2e91172007-09-12 10:44:19 +0200112 int owned;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700113 wait_queue_head_t wq;
Ingo Molnara5b5bb92006-07-03 00:25:35 -0700114 /*
115 * We express the mutex-alike socket_lock semantics
116 * to the lock validator by explicitly managing
117 * the slock as a lock variant (in addition to
118 * the slock itself):
119 */
120#ifdef CONFIG_DEBUG_LOCK_ALLOC
121 struct lockdep_map dep_map;
122#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -0700123} socket_lock_t;
124
Linus Torvalds1da177e2005-04-16 15:20:36 -0700125struct sock;
Arnaldo Carvalho de Melo8feaf0c02005-08-09 20:09:30 -0700126struct proto;
Denis V. Lunev0eeb8ff2007-12-04 01:15:45 -0800127struct net;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700128
Eric Dumazet077b3932012-12-02 07:33:10 +0000129typedef __u32 __bitwise __portpair;
130typedef __u64 __bitwise __addrpair;
131
Linus Torvalds1da177e2005-04-16 15:20:36 -0700132/**
Pavel Pisa4dc3b162005-05-01 08:59:25 -0700133 * struct sock_common - minimal network layer representation of sockets
Eric Dumazet68835ab2010-11-30 19:04:07 +0000134 * @skc_daddr: Foreign IPv4 addr
135 * @skc_rcv_saddr: Bound local IPv4 addr
Eric Dumazet4dc6dc72009-07-15 23:13:10 +0000136 * @skc_hash: hash value used with various protocol lookup tables
Eric Dumazetd4cada42009-11-08 10:17:30 +0000137 * @skc_u16hashes: two u16 hash values used by UDP lookup tables
Eric Dumazetce43b032012-11-30 09:49:27 +0000138 * @skc_dport: placeholder for inet_dport/tw_dport
139 * @skc_num: placeholder for inet_num/tw_num
Pavel Pisa4dc3b162005-05-01 08:59:25 -0700140 * @skc_family: network address family
141 * @skc_state: Connection state
142 * @skc_reuse: %SO_REUSEADDR setting
Tom Herbert055dc212013-01-22 09:49:50 +0000143 * @skc_reuseport: %SO_REUSEPORT setting
Pavel Pisa4dc3b162005-05-01 08:59:25 -0700144 * @skc_bound_dev_if: bound device index if != 0
Pavel Pisa4dc3b162005-05-01 08:59:25 -0700145 * @skc_bind_node: bind hash linkage for various protocol lookup tables
Eric Dumazet512615b2009-11-08 10:17:58 +0000146 * @skc_portaddr_node: second hash linkage for UDP/UDP-Lite protocol
Arnaldo Carvalho de Melo8feaf0c02005-08-09 20:09:30 -0700147 * @skc_prot: protocol handlers inside a network family
Eric W. Biederman07feaeb2007-09-12 11:58:02 +0200148 * @skc_net: reference to the network namespace of this socket
Eric Dumazet68835ab2010-11-30 19:04:07 +0000149 * @skc_node: main hash linkage for various protocol lookup tables
150 * @skc_nulls_node: main hash linkage for TCP/UDP/UDP-Lite protocol
151 * @skc_tx_queue_mapping: tx queue number for this connection
152 * @skc_refcnt: reference count
Pavel Pisa4dc3b162005-05-01 08:59:25 -0700153 *
154 * This is the minimal network layer representation of sockets, the header
Arnaldo Carvalho de Melo8feaf0c02005-08-09 20:09:30 -0700155 * for struct sock and struct inet_timewait_sock.
156 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700157struct sock_common {
Eric Dumazetce43b032012-11-30 09:49:27 +0000158 /* skc_daddr and skc_rcv_saddr must be grouped on a 8 bytes aligned
Eric Dumazet05dbc7b2013-10-03 00:22:02 -0700159 * address on 64bit arches : cf INET_MATCH()
Eric Dumazet4dc6dc72009-07-15 23:13:10 +0000160 */
Eric Dumazetce43b032012-11-30 09:49:27 +0000161 union {
Eric Dumazet077b3932012-12-02 07:33:10 +0000162 __addrpair skc_addrpair;
Eric Dumazetce43b032012-11-30 09:49:27 +0000163 struct {
164 __be32 skc_daddr;
165 __be32 skc_rcv_saddr;
166 };
167 };
Eric Dumazetd4cada42009-11-08 10:17:30 +0000168 union {
169 unsigned int skc_hash;
170 __u16 skc_u16hashes[2];
171 };
Eric Dumazetce43b032012-11-30 09:49:27 +0000172 /* skc_dport && skc_num must be grouped as well */
173 union {
Eric Dumazet077b3932012-12-02 07:33:10 +0000174 __portpair skc_portpair;
Eric Dumazetce43b032012-11-30 09:49:27 +0000175 struct {
176 __be16 skc_dport;
177 __u16 skc_num;
178 };
179 };
180
Eric Dumazet4dc6dc72009-07-15 23:13:10 +0000181 unsigned short skc_family;
182 volatile unsigned char skc_state;
Tom Herbert055dc212013-01-22 09:49:50 +0000183 unsigned char skc_reuse:4;
Eric Dumazet9fe516b2014-06-27 08:36:16 -0700184 unsigned char skc_reuseport:1;
185 unsigned char skc_ipv6only:1;
Eric Dumazet4dc6dc72009-07-15 23:13:10 +0000186 int skc_bound_dev_if;
Eric Dumazet512615b2009-11-08 10:17:58 +0000187 union {
188 struct hlist_node skc_bind_node;
189 struct hlist_nulls_node skc_portaddr_node;
190 };
Arnaldo Carvalho de Melo8feaf0c02005-08-09 20:09:30 -0700191 struct proto *skc_prot;
YOSHIFUJI Hideaki3b1e0a62008-03-26 02:26:21 +0900192#ifdef CONFIG_NET_NS
Eric W. Biederman07feaeb2007-09-12 11:58:02 +0200193 struct net *skc_net;
YOSHIFUJI Hideaki3b1e0a62008-03-26 02:26:21 +0900194#endif
Eric Dumazetefe42082013-10-03 15:42:29 -0700195
196#if IS_ENABLED(CONFIG_IPV6)
197 struct in6_addr skc_v6_daddr;
198 struct in6_addr skc_v6_rcv_saddr;
199#endif
200
Eric Dumazet68835ab2010-11-30 19:04:07 +0000201 /*
202 * fields between dontcopy_begin/dontcopy_end
203 * are not copied in sock_copy()
204 */
Randy Dunlap928c41e2011-01-08 17:39:21 +0000205 /* private: */
Eric Dumazet68835ab2010-11-30 19:04:07 +0000206 int skc_dontcopy_begin[0];
Randy Dunlap928c41e2011-01-08 17:39:21 +0000207 /* public: */
Eric Dumazet68835ab2010-11-30 19:04:07 +0000208 union {
209 struct hlist_node skc_node;
210 struct hlist_nulls_node skc_nulls_node;
211 };
212 int skc_tx_queue_mapping;
213 atomic_t skc_refcnt;
Randy Dunlap928c41e2011-01-08 17:39:21 +0000214 /* private: */
Eric Dumazet68835ab2010-11-30 19:04:07 +0000215 int skc_dontcopy_end[0];
Randy Dunlap928c41e2011-01-08 17:39:21 +0000216 /* public: */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700217};
218
Glauber Costae1aab162011-12-11 21:47:03 +0000219struct cg_proto;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700220/**
221 * struct sock - network layer representation of sockets
Arnaldo Carvalho de Melo8feaf0c02005-08-09 20:09:30 -0700222 * @__sk_common: shared layout with inet_timewait_sock
Pavel Pisa4dc3b162005-05-01 08:59:25 -0700223 * @sk_shutdown: mask of %SEND_SHUTDOWN and/or %RCV_SHUTDOWN
224 * @sk_userlocks: %SO_SNDBUF and %SO_RCVBUF settings
225 * @sk_lock: synchronizer
226 * @sk_rcvbuf: size of receive buffer in bytes
Eric Dumazet43815482010-04-29 11:01:49 +0000227 * @sk_wq: sock wait queue and async head
Shawn Bohrer421b3882013-10-07 11:01:39 -0500228 * @sk_rx_dst: receive input route used by early demux
Pavel Pisa4dc3b162005-05-01 08:59:25 -0700229 * @sk_dst_cache: destination cache
230 * @sk_dst_lock: destination cache lock
231 * @sk_policy: flow policy
Pavel Pisa4dc3b162005-05-01 08:59:25 -0700232 * @sk_receive_queue: incoming packets
233 * @sk_wmem_alloc: transmit queue bytes committed
234 * @sk_write_queue: Packet sending queue
Chris Leech97fc2f02006-05-23 17:55:33 -0700235 * @sk_async_wait_queue: DMA copied packets
Pavel Pisa4dc3b162005-05-01 08:59:25 -0700236 * @sk_omem_alloc: "o" is "option" or "other"
237 * @sk_wmem_queued: persistent queue size
238 * @sk_forward_alloc: space allocated forward
Eliezer Tamir06021292013-06-10 11:39:50 +0300239 * @sk_napi_id: id of the last napi context to receive data for sk
Eliezer Tamirdafcc432013-06-14 16:33:57 +0300240 * @sk_ll_usec: usecs to busypoll when there is no data
Pavel Pisa4dc3b162005-05-01 08:59:25 -0700241 * @sk_allocation: allocation mode
Eric Dumazet95bd09e2013-08-27 05:46:32 -0700242 * @sk_pacing_rate: Pacing rate (if supported by transport/packet scheduler)
Eric Dumazetc3f40d72013-09-29 01:12:40 -0700243 * @sk_max_pacing_rate: Maximum pacing rate (%SO_MAX_PACING_RATE)
Pavel Pisa4dc3b162005-05-01 08:59:25 -0700244 * @sk_sndbuf: size of send buffer in bytes
Wang Chen33c732c2007-11-13 20:30:01 -0800245 * @sk_flags: %SO_LINGER (l_onoff), %SO_BROADCAST, %SO_KEEPALIVE,
Patrick Ohly20d49472009-02-12 05:03:38 +0000246 * %SO_OOBINLINE settings, %SO_TIMESTAMPING settings
Tom Herbert28448b82014-05-23 08:47:19 -0700247 * @sk_no_check_tx: %SO_NO_CHECK setting, set checksum in TX packets
248 * @sk_no_check_rx: allow zero checksum in RX packets
Pavel Pisa4dc3b162005-05-01 08:59:25 -0700249 * @sk_route_caps: route capabilities (e.g. %NETIF_F_TSO)
Eric Dumazeta4654192010-05-16 00:36:33 -0700250 * @sk_route_nocaps: forbidden route capabilities (e.g NETIF_F_GSO_MASK)
Herbert Xubcd76112006-06-30 13:36:35 -0700251 * @sk_gso_type: GSO type (e.g. %SKB_GSO_TCPV4)
Peter P Waskiewicz Jr82cc1a72008-03-21 03:43:19 -0700252 * @sk_gso_max_size: Maximum GSO segment size to build
Ben Hutchings14853482012-07-30 16:11:42 +0000253 * @sk_gso_max_segs: Maximum number of GSO segments
Pavel Pisa4dc3b162005-05-01 08:59:25 -0700254 * @sk_lingertime: %SO_LINGER l_linger setting
Pavel Pisa4dc3b162005-05-01 08:59:25 -0700255 * @sk_backlog: always used with the per-socket spinlock held
256 * @sk_callback_lock: used with the callbacks in the end of this struct
257 * @sk_error_queue: rarely used
Wang Chen33c732c2007-11-13 20:30:01 -0800258 * @sk_prot_creator: sk_prot of original sock creator (see ipv6_setsockopt,
259 * IPV6_ADDRFORM for instance)
Pavel Pisa4dc3b162005-05-01 08:59:25 -0700260 * @sk_err: last error
Wang Chen33c732c2007-11-13 20:30:01 -0800261 * @sk_err_soft: errors that don't cause failure but are the cause of a
262 * persistent failure not just 'timed out'
Eric Dumazetcb61cb92008-06-17 21:04:56 -0700263 * @sk_drops: raw/udp drops counter
Pavel Pisa4dc3b162005-05-01 08:59:25 -0700264 * @sk_ack_backlog: current listen backlog
265 * @sk_max_ack_backlog: listen backlog set in listen()
266 * @sk_priority: %SO_PRIORITY setting
Randy Dunlap1a3bc362012-01-21 09:03:10 +0000267 * @sk_cgrp_prioidx: socket group's priority map index
Pavel Pisa4dc3b162005-05-01 08:59:25 -0700268 * @sk_type: socket type (%SOCK_STREAM, etc)
269 * @sk_protocol: which protocol this socket belongs in this network family
Randy Dunlap53c3fa22010-08-09 13:41:07 +0000270 * @sk_peer_pid: &struct pid for this socket's peer
271 * @sk_peer_cred: %SO_PEERCRED setting
Pavel Pisa4dc3b162005-05-01 08:59:25 -0700272 * @sk_rcvlowat: %SO_RCVLOWAT setting
273 * @sk_rcvtimeo: %SO_RCVTIMEO setting
274 * @sk_sndtimeo: %SO_SNDTIMEO setting
David S. Millerc58dc012010-04-27 15:05:31 -0700275 * @sk_rxhash: flow hash received from netif layer
Tom Herbertb73c3d02014-07-01 21:32:17 -0700276 * @sk_txhash: computed flow hash for use on transmit
Pavel Pisa4dc3b162005-05-01 08:59:25 -0700277 * @sk_filter: socket filtering instructions
278 * @sk_protinfo: private area, net family specific, when not using slab
279 * @sk_timer: sock cleanup timer
280 * @sk_stamp: time stamp of last packet received
281 * @sk_socket: Identd and reporting IO signals
282 * @sk_user_data: RPC layer private data
Eric Dumazet5640f762012-09-23 23:04:42 +0000283 * @sk_frag: cached page frag
Randy Dunlapd3d4f0a2012-04-17 14:03:53 +0000284 * @sk_peek_off: current peek_offset value
Pavel Pisa4dc3b162005-05-01 08:59:25 -0700285 * @sk_send_head: front of stuff to transmit
Martin Waitz67be2dd2005-05-01 08:59:26 -0700286 * @sk_security: used by security modules
Randy Dunlap31729362008-02-18 20:52:13 -0800287 * @sk_mark: generic packet mark
Randy Dunlap53c3fa22010-08-09 13:41:07 +0000288 * @sk_classid: this socket's cgroup classid
Glauber Costae1aab162011-12-11 21:47:03 +0000289 * @sk_cgrp: this socket's cgroup-specific proto data
Pavel Pisa4dc3b162005-05-01 08:59:25 -0700290 * @sk_write_pending: a write to stream socket waits to start
291 * @sk_state_change: callback to indicate change in the state of the sock
292 * @sk_data_ready: callback to indicate there is data to be processed
293 * @sk_write_space: callback to indicate there is bf sending space available
294 * @sk_error_report: callback to indicate errors (e.g. %MSG_ERRQUEUE)
295 * @sk_backlog_rcv: callback to process the backlog
296 * @sk_destruct: called at sock freeing time, i.e. when all refcnt == 0
Linus Torvalds1da177e2005-04-16 15:20:36 -0700297 */
298struct sock {
299 /*
Arnaldo Carvalho de Melo8feaf0c02005-08-09 20:09:30 -0700300 * Now struct inet_timewait_sock also uses sock_common, so please just
Linus Torvalds1da177e2005-04-16 15:20:36 -0700301 * don't add nothing before this first member (__sk_common) --acme
302 */
303 struct sock_common __sk_common;
Eric Dumazet4dc6dc72009-07-15 23:13:10 +0000304#define sk_node __sk_common.skc_node
305#define sk_nulls_node __sk_common.skc_nulls_node
306#define sk_refcnt __sk_common.skc_refcnt
Krishna Kumare022f0b2009-10-19 23:46:20 +0000307#define sk_tx_queue_mapping __sk_common.skc_tx_queue_mapping
Eric Dumazet4dc6dc72009-07-15 23:13:10 +0000308
Eric Dumazet68835ab2010-11-30 19:04:07 +0000309#define sk_dontcopy_begin __sk_common.skc_dontcopy_begin
310#define sk_dontcopy_end __sk_common.skc_dontcopy_end
Eric Dumazet4dc6dc72009-07-15 23:13:10 +0000311#define sk_hash __sk_common.skc_hash
Eric Dumazet50805462013-10-02 04:29:50 -0700312#define sk_portpair __sk_common.skc_portpair
Eric Dumazet05dbc7b2013-10-03 00:22:02 -0700313#define sk_num __sk_common.skc_num
314#define sk_dport __sk_common.skc_dport
Eric Dumazet50805462013-10-02 04:29:50 -0700315#define sk_addrpair __sk_common.skc_addrpair
316#define sk_daddr __sk_common.skc_daddr
317#define sk_rcv_saddr __sk_common.skc_rcv_saddr
Linus Torvalds1da177e2005-04-16 15:20:36 -0700318#define sk_family __sk_common.skc_family
319#define sk_state __sk_common.skc_state
320#define sk_reuse __sk_common.skc_reuse
Tom Herbert055dc212013-01-22 09:49:50 +0000321#define sk_reuseport __sk_common.skc_reuseport
Eric Dumazet9fe516b2014-06-27 08:36:16 -0700322#define sk_ipv6only __sk_common.skc_ipv6only
Linus Torvalds1da177e2005-04-16 15:20:36 -0700323#define sk_bound_dev_if __sk_common.skc_bound_dev_if
Linus Torvalds1da177e2005-04-16 15:20:36 -0700324#define sk_bind_node __sk_common.skc_bind_node
Arnaldo Carvalho de Melo8feaf0c02005-08-09 20:09:30 -0700325#define sk_prot __sk_common.skc_prot
Eric W. Biederman07feaeb2007-09-12 11:58:02 +0200326#define sk_net __sk_common.skc_net
Eric Dumazetefe42082013-10-03 15:42:29 -0700327#define sk_v6_daddr __sk_common.skc_v6_daddr
328#define sk_v6_rcv_saddr __sk_common.skc_v6_rcv_saddr
329
Eric Dumazetb178bb32010-11-16 05:56:04 +0000330 socket_lock_t sk_lock;
331 struct sk_buff_head sk_receive_queue;
332 /*
333 * The backlog queue is special, it is always used with
334 * the per-socket spinlock held and requires low latency
335 * access. Therefore we special case it's implementation.
336 * Note : rmem_alloc is in this structure to fill a hole
337 * on 64bit arches, not because its logically part of
338 * backlog.
339 */
340 struct {
341 atomic_t rmem_alloc;
342 int len;
343 struct sk_buff *head;
344 struct sk_buff *tail;
345 } sk_backlog;
346#define sk_rmem_alloc sk_backlog.rmem_alloc
347 int sk_forward_alloc;
348#ifdef CONFIG_RPS
349 __u32 sk_rxhash;
350#endif
Tom Herbertb73c3d02014-07-01 21:32:17 -0700351 __u32 sk_txhash;
Cong Wange0d10952013-08-01 11:10:25 +0800352#ifdef CONFIG_NET_RX_BUSY_POLL
Eliezer Tamir06021292013-06-10 11:39:50 +0300353 unsigned int sk_napi_id;
Eliezer Tamirdafcc432013-06-14 16:33:57 +0300354 unsigned int sk_ll_usec;
Eliezer Tamir06021292013-06-10 11:39:50 +0300355#endif
Eric Dumazetb178bb32010-11-16 05:56:04 +0000356 atomic_t sk_drops;
357 int sk_rcvbuf;
358
359 struct sk_filter __rcu *sk_filter;
Eric Dumazeteaefd112011-02-18 03:26:36 +0000360 struct socket_wq __rcu *sk_wq;
Eric Dumazetb178bb32010-11-16 05:56:04 +0000361
362#ifdef CONFIG_NET_DMA
363 struct sk_buff_head sk_async_wait_queue;
364#endif
365
366#ifdef CONFIG_XFRM
367 struct xfrm_policy *sk_policy[2];
368#endif
369 unsigned long sk_flags;
Eric Dumazetdeaa5852012-06-24 20:22:49 +0000370 struct dst_entry *sk_rx_dst;
Cong Wang0e36cbb2013-01-22 21:09:51 +0000371 struct dst_entry __rcu *sk_dst_cache;
Eric Dumazetb178bb32010-11-16 05:56:04 +0000372 spinlock_t sk_dst_lock;
373 atomic_t sk_wmem_alloc;
374 atomic_t sk_omem_alloc;
375 int sk_sndbuf;
376 struct sk_buff_head sk_write_queue;
Vegard Nossuma98b65a2009-02-26 14:46:57 +0100377 kmemcheck_bitfield_begin(flags);
Eric Dumazet5fdb9972009-10-08 22:50:25 +0000378 unsigned int sk_shutdown : 2,
Tom Herbert28448b82014-05-23 08:47:19 -0700379 sk_no_check_tx : 1,
380 sk_no_check_rx : 1,
Eric Dumazet5fdb9972009-10-08 22:50:25 +0000381 sk_userlocks : 4,
382 sk_protocol : 8,
383 sk_type : 16;
Vegard Nossuma98b65a2009-02-26 14:46:57 +0100384 kmemcheck_bitfield_end(flags);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700385 int sk_wmem_queued;
Al Viro7d877f32005-10-21 03:20:43 -0400386 gfp_t sk_allocation;
Eric Dumazet95bd09e2013-08-27 05:46:32 -0700387 u32 sk_pacing_rate; /* bytes per second */
Eric Dumazet62748f32013-09-24 08:20:52 -0700388 u32 sk_max_pacing_rate;
Michał Mirosławc8f44af2011-11-15 15:29:55 +0000389 netdev_features_t sk_route_caps;
390 netdev_features_t sk_route_nocaps;
Herbert Xubcd76112006-06-30 13:36:35 -0700391 int sk_gso_type;
Peter P Waskiewicz Jr82cc1a72008-03-21 03:43:19 -0700392 unsigned int sk_gso_max_size;
Ben Hutchings14853482012-07-30 16:11:42 +0000393 u16 sk_gso_max_segs;
David S. Miller9932cf92006-03-24 15:12:37 -0800394 int sk_rcvlowat;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700395 unsigned long sk_lingertime;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700396 struct sk_buff_head sk_error_queue;
Arnaldo Carvalho de Melo476e19c2005-05-05 13:35:15 -0700397 struct proto *sk_prot_creator;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700398 rwlock_t sk_callback_lock;
399 int sk_err,
400 sk_err_soft;
401 unsigned short sk_ack_backlog;
402 unsigned short sk_max_ack_backlog;
403 __u32 sk_priority;
Daniel Borkmann86f85152013-12-29 17:27:11 +0100404#if IS_ENABLED(CONFIG_CGROUP_NET_PRIO)
Neil Horman5bc14212011-11-22 05:10:51 +0000405 __u32 sk_cgrp_prioidx;
406#endif
Eric W. Biederman109f6e32010-06-13 03:30:14 +0000407 struct pid *sk_peer_pid;
408 const struct cred *sk_peer_cred;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700409 long sk_rcvtimeo;
410 long sk_sndtimeo;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700411 void *sk_protinfo;
412 struct timer_list sk_timer;
Eric Dumazetb7aa0bf2007-04-19 16:16:32 -0700413 ktime_t sk_stamp;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700414 struct socket *sk_socket;
415 void *sk_user_data;
Eric Dumazet5640f762012-09-23 23:04:42 +0000416 struct page_frag sk_frag;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700417 struct sk_buff *sk_send_head;
Pavel Emelyanovef64a542012-02-21 07:31:34 +0000418 __s32 sk_peek_off;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700419 int sk_write_pending;
Alexey Dobriyand5f64232008-11-04 14:45:58 -0800420#ifdef CONFIG_SECURITY
Linus Torvalds1da177e2005-04-16 15:20:36 -0700421 void *sk_security;
Alexey Dobriyand5f64232008-11-04 14:45:58 -0800422#endif
Laszlo Attila Toth4a19ec52008-01-30 19:08:16 -0800423 __u32 sk_mark;
Herbert Xuf8451722010-05-24 00:12:34 -0700424 u32 sk_classid;
Glauber Costae1aab162011-12-11 21:47:03 +0000425 struct cg_proto *sk_cgrp;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700426 void (*sk_state_change)(struct sock *sk);
David S. Miller676d2362014-04-11 16:15:36 -0400427 void (*sk_data_ready)(struct sock *sk);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700428 void (*sk_write_space)(struct sock *sk);
429 void (*sk_error_report)(struct sock *sk);
Eric Dumazetdc6b9b72012-05-16 22:48:15 +0000430 int (*sk_backlog_rcv)(struct sock *sk,
431 struct sk_buff *skb);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700432 void (*sk_destruct)(struct sock *sk);
433};
434
Pravin B Shelar559835ea2013-09-24 10:25:40 -0700435#define __sk_user_data(sk) ((*((void __rcu **)&(sk)->sk_user_data)))
436
437#define rcu_dereference_sk_user_data(sk) rcu_dereference(__sk_user_data((sk)))
438#define rcu_assign_sk_user_data(sk, ptr) rcu_assign_pointer(__sk_user_data((sk)), ptr)
439
Pavel Emelyanov4a17fd52012-04-19 03:39:36 +0000440/*
441 * SK_CAN_REUSE and SK_NO_REUSE on a socket mean that the socket is OK
442 * or not whether his port will be reused by someone else. SK_FORCE_REUSE
443 * on a socket means that the socket will reuse everybody else's port
444 * without looking at the other's sk_reuse value.
445 */
446
447#define SK_NO_REUSE 0
448#define SK_CAN_REUSE 1
449#define SK_FORCE_REUSE 2
450
Pavel Emelyanovef64a542012-02-21 07:31:34 +0000451static inline int sk_peek_offset(struct sock *sk, int flags)
452{
453 if ((flags & MSG_PEEK) && (sk->sk_peek_off >= 0))
454 return sk->sk_peek_off;
455 else
456 return 0;
457}
458
459static inline void sk_peek_offset_bwd(struct sock *sk, int val)
460{
461 if (sk->sk_peek_off >= 0) {
462 if (sk->sk_peek_off >= val)
463 sk->sk_peek_off -= val;
464 else
465 sk->sk_peek_off = 0;
466 }
467}
468
469static inline void sk_peek_offset_fwd(struct sock *sk, int val)
470{
471 if (sk->sk_peek_off >= 0)
472 sk->sk_peek_off += val;
473}
474
Linus Torvalds1da177e2005-04-16 15:20:36 -0700475/*
476 * Hashed lists helper routines
477 */
Li Zefanc4146642010-02-08 23:18:45 +0000478static inline struct sock *sk_entry(const struct hlist_node *node)
479{
480 return hlist_entry(node, struct sock, sk_node);
481}
482
Arnaldo Carvalho de Meloe48c4142005-08-09 20:09:46 -0700483static inline struct sock *__sk_head(const struct hlist_head *head)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700484{
485 return hlist_entry(head->first, struct sock, sk_node);
486}
487
Arnaldo Carvalho de Meloe48c4142005-08-09 20:09:46 -0700488static inline struct sock *sk_head(const struct hlist_head *head)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700489{
490 return hlist_empty(head) ? NULL : __sk_head(head);
491}
492
Eric Dumazet88ab1932008-11-16 19:39:21 -0800493static inline struct sock *__sk_nulls_head(const struct hlist_nulls_head *head)
494{
495 return hlist_nulls_entry(head->first, struct sock, sk_nulls_node);
496}
497
498static inline struct sock *sk_nulls_head(const struct hlist_nulls_head *head)
499{
500 return hlist_nulls_empty(head) ? NULL : __sk_nulls_head(head);
501}
502
Arnaldo Carvalho de Meloe48c4142005-08-09 20:09:46 -0700503static inline struct sock *sk_next(const struct sock *sk)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700504{
505 return sk->sk_node.next ?
506 hlist_entry(sk->sk_node.next, struct sock, sk_node) : NULL;
507}
508
Eric Dumazet88ab1932008-11-16 19:39:21 -0800509static inline struct sock *sk_nulls_next(const struct sock *sk)
510{
511 return (!is_a_nulls(sk->sk_nulls_node.next)) ?
512 hlist_nulls_entry(sk->sk_nulls_node.next,
513 struct sock, sk_nulls_node) :
514 NULL;
515}
516
Eric Dumazetdc6b9b72012-05-16 22:48:15 +0000517static inline bool sk_unhashed(const struct sock *sk)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700518{
519 return hlist_unhashed(&sk->sk_node);
520}
521
Eric Dumazetdc6b9b72012-05-16 22:48:15 +0000522static inline bool sk_hashed(const struct sock *sk)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700523{
Akinobu Mitada753be2006-04-28 15:21:23 -0700524 return !sk_unhashed(sk);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700525}
526
Eric Dumazetdc6b9b72012-05-16 22:48:15 +0000527static inline void sk_node_init(struct hlist_node *node)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700528{
529 node->pprev = NULL;
530}
531
Eric Dumazetdc6b9b72012-05-16 22:48:15 +0000532static inline void sk_nulls_node_init(struct hlist_nulls_node *node)
Eric Dumazet88ab1932008-11-16 19:39:21 -0800533{
534 node->pprev = NULL;
535}
536
Eric Dumazetdc6b9b72012-05-16 22:48:15 +0000537static inline void __sk_del_node(struct sock *sk)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700538{
539 __hlist_del(&sk->sk_node);
540}
541
stephen hemminger808f5112010-02-22 07:57:18 +0000542/* NB: equivalent to hlist_del_init_rcu */
Eric Dumazetdc6b9b72012-05-16 22:48:15 +0000543static inline bool __sk_del_node_init(struct sock *sk)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700544{
545 if (sk_hashed(sk)) {
546 __sk_del_node(sk);
547 sk_node_init(&sk->sk_node);
Eric Dumazetdc6b9b72012-05-16 22:48:15 +0000548 return true;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700549 }
Eric Dumazetdc6b9b72012-05-16 22:48:15 +0000550 return false;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700551}
552
553/* Grab socket reference count. This operation is valid only
554 when sk is ALREADY grabbed f.e. it is found in hash table
555 or a list and the lookup is made under lock preventing hash table
556 modifications.
557 */
558
559static inline void sock_hold(struct sock *sk)
560{
561 atomic_inc(&sk->sk_refcnt);
562}
563
564/* Ungrab socket in the context, which assumes that socket refcnt
565 cannot hit zero, f.e. it is true in context of any socketcall.
566 */
567static inline void __sock_put(struct sock *sk)
568{
569 atomic_dec(&sk->sk_refcnt);
570}
571
Eric Dumazetdc6b9b72012-05-16 22:48:15 +0000572static inline bool sk_del_node_init(struct sock *sk)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700573{
Eric Dumazetdc6b9b72012-05-16 22:48:15 +0000574 bool rc = __sk_del_node_init(sk);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700575
576 if (rc) {
577 /* paranoid for a while -acme */
578 WARN_ON(atomic_read(&sk->sk_refcnt) == 1);
579 __sock_put(sk);
580 }
581 return rc;
582}
stephen hemminger808f5112010-02-22 07:57:18 +0000583#define sk_del_node_init_rcu(sk) sk_del_node_init(sk)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700584
Eric Dumazetdc6b9b72012-05-16 22:48:15 +0000585static inline bool __sk_nulls_del_node_init_rcu(struct sock *sk)
Eric Dumazet271b72c2008-10-29 02:11:14 -0700586{
587 if (sk_hashed(sk)) {
Eric Dumazet88ab1932008-11-16 19:39:21 -0800588 hlist_nulls_del_init_rcu(&sk->sk_nulls_node);
Eric Dumazetdc6b9b72012-05-16 22:48:15 +0000589 return true;
Eric Dumazet271b72c2008-10-29 02:11:14 -0700590 }
Eric Dumazetdc6b9b72012-05-16 22:48:15 +0000591 return false;
Eric Dumazet271b72c2008-10-29 02:11:14 -0700592}
593
Eric Dumazetdc6b9b72012-05-16 22:48:15 +0000594static inline bool sk_nulls_del_node_init_rcu(struct sock *sk)
Eric Dumazet271b72c2008-10-29 02:11:14 -0700595{
Eric Dumazetdc6b9b72012-05-16 22:48:15 +0000596 bool rc = __sk_nulls_del_node_init_rcu(sk);
Eric Dumazet271b72c2008-10-29 02:11:14 -0700597
598 if (rc) {
599 /* paranoid for a while -acme */
600 WARN_ON(atomic_read(&sk->sk_refcnt) == 1);
601 __sock_put(sk);
602 }
603 return rc;
604}
605
Eric Dumazetdc6b9b72012-05-16 22:48:15 +0000606static inline void __sk_add_node(struct sock *sk, struct hlist_head *list)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700607{
608 hlist_add_head(&sk->sk_node, list);
609}
610
Eric Dumazetdc6b9b72012-05-16 22:48:15 +0000611static inline void sk_add_node(struct sock *sk, struct hlist_head *list)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700612{
613 sock_hold(sk);
614 __sk_add_node(sk, list);
615}
616
Eric Dumazetdc6b9b72012-05-16 22:48:15 +0000617static inline void sk_add_node_rcu(struct sock *sk, struct hlist_head *list)
stephen hemminger808f5112010-02-22 07:57:18 +0000618{
619 sock_hold(sk);
620 hlist_add_head_rcu(&sk->sk_node, list);
621}
622
Eric Dumazetdc6b9b72012-05-16 22:48:15 +0000623static inline void __sk_nulls_add_node_rcu(struct sock *sk, struct hlist_nulls_head *list)
Eric Dumazet271b72c2008-10-29 02:11:14 -0700624{
Eric Dumazet88ab1932008-11-16 19:39:21 -0800625 hlist_nulls_add_head_rcu(&sk->sk_nulls_node, list);
Eric Dumazet271b72c2008-10-29 02:11:14 -0700626}
627
Eric Dumazetdc6b9b72012-05-16 22:48:15 +0000628static inline void sk_nulls_add_node_rcu(struct sock *sk, struct hlist_nulls_head *list)
Eric Dumazet271b72c2008-10-29 02:11:14 -0700629{
630 sock_hold(sk);
Eric Dumazet88ab1932008-11-16 19:39:21 -0800631 __sk_nulls_add_node_rcu(sk, list);
Eric Dumazet271b72c2008-10-29 02:11:14 -0700632}
633
Eric Dumazetdc6b9b72012-05-16 22:48:15 +0000634static inline void __sk_del_bind_node(struct sock *sk)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700635{
636 __hlist_del(&sk->sk_bind_node);
637}
638
Eric Dumazetdc6b9b72012-05-16 22:48:15 +0000639static inline void sk_add_bind_node(struct sock *sk,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700640 struct hlist_head *list)
641{
642 hlist_add_head(&sk->sk_bind_node, list);
643}
644
Sasha Levinb67bfe02013-02-27 17:06:00 -0800645#define sk_for_each(__sk, list) \
646 hlist_for_each_entry(__sk, list, sk_node)
647#define sk_for_each_rcu(__sk, list) \
648 hlist_for_each_entry_rcu(__sk, list, sk_node)
Eric Dumazet88ab1932008-11-16 19:39:21 -0800649#define sk_nulls_for_each(__sk, node, list) \
650 hlist_nulls_for_each_entry(__sk, node, list, sk_nulls_node)
651#define sk_nulls_for_each_rcu(__sk, node, list) \
652 hlist_nulls_for_each_entry_rcu(__sk, node, list, sk_nulls_node)
Sasha Levinb67bfe02013-02-27 17:06:00 -0800653#define sk_for_each_from(__sk) \
654 hlist_for_each_entry_from(__sk, sk_node)
Eric Dumazet88ab1932008-11-16 19:39:21 -0800655#define sk_nulls_for_each_from(__sk, node) \
656 if (__sk && ({ node = &(__sk)->sk_nulls_node; 1; })) \
657 hlist_nulls_for_each_entry_from(__sk, node, sk_nulls_node)
Sasha Levinb67bfe02013-02-27 17:06:00 -0800658#define sk_for_each_safe(__sk, tmp, list) \
659 hlist_for_each_entry_safe(__sk, tmp, list, sk_node)
660#define sk_for_each_bound(__sk, list) \
661 hlist_for_each_entry(__sk, list, sk_bind_node)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700662
David Held2dc41cf2014-07-15 23:28:32 -0400663/**
664 * sk_nulls_for_each_entry_offset - iterate over a list at a given struct offset
665 * @tpos: the type * to use as a loop cursor.
666 * @pos: the &struct hlist_node to use as a loop cursor.
667 * @head: the head for your list.
668 * @offset: offset of hlist_node within the struct.
669 *
670 */
671#define sk_nulls_for_each_entry_offset(tpos, pos, head, offset) \
672 for (pos = (head)->first; \
673 (!is_a_nulls(pos)) && \
674 ({ tpos = (typeof(*tpos) *)((void *)pos - offset); 1;}); \
675 pos = pos->next)
676
Eric W. Biedermanc336d142012-05-24 17:56:43 -0600677static inline struct user_namespace *sk_user_ns(struct sock *sk)
678{
679 /* Careful only use this in a context where these parameters
680 * can not change and must all be valid, such as recvmsg from
681 * userspace.
682 */
683 return sk->sk_socket->file->f_cred->user_ns;
684}
685
Linus Torvalds1da177e2005-04-16 15:20:36 -0700686/* Sock flags */
687enum sock_flags {
688 SOCK_DEAD,
689 SOCK_DONE,
690 SOCK_URGINLINE,
691 SOCK_KEEPOPEN,
692 SOCK_LINGER,
693 SOCK_DESTROY,
694 SOCK_BROADCAST,
695 SOCK_TIMESTAMP,
696 SOCK_ZAPPED,
697 SOCK_USE_WRITE_QUEUE, /* whether to call sk->sk_write_space in sock_wfree */
698 SOCK_DBG, /* %SO_DEBUG setting */
699 SOCK_RCVTSTAMP, /* %SO_TIMESTAMP setting */
Eric Dumazet92f37fd2007-03-25 22:14:49 -0700700 SOCK_RCVTSTAMPNS, /* %SO_TIMESTAMPNS setting */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700701 SOCK_LOCALROUTE, /* route locally only, %SO_DONTROUTE setting */
702 SOCK_QUEUE_SHRUNK, /* write queue has been shrunk recently */
Mel Gorman7cb02402012-07-31 16:44:16 -0700703 SOCK_MEMALLOC, /* VM depends on this socket for swapping */
Patrick Ohly20d49472009-02-12 05:03:38 +0000704 SOCK_TIMESTAMPING_TX_HARDWARE, /* %SOF_TIMESTAMPING_TX_HARDWARE */
705 SOCK_TIMESTAMPING_TX_SOFTWARE, /* %SOF_TIMESTAMPING_TX_SOFTWARE */
706 SOCK_TIMESTAMPING_RX_HARDWARE, /* %SOF_TIMESTAMPING_RX_HARDWARE */
707 SOCK_TIMESTAMPING_RX_SOFTWARE, /* %SOF_TIMESTAMPING_RX_SOFTWARE */
708 SOCK_TIMESTAMPING_SOFTWARE, /* %SOF_TIMESTAMPING_SOFTWARE */
709 SOCK_TIMESTAMPING_RAW_HARDWARE, /* %SOF_TIMESTAMPING_RAW_HARDWARE */
710 SOCK_TIMESTAMPING_SYS_HARDWARE, /* %SOF_TIMESTAMPING_SYS_HARDWARE */
Eric Dumazetbcdce712009-10-06 17:28:29 -0700711 SOCK_FASYNC, /* fasync() active */
Neil Horman3b885782009-10-12 13:26:31 -0700712 SOCK_RXQ_OVFL,
Shirley Ma1cdebb42011-07-06 12:17:30 +0000713 SOCK_ZEROCOPY, /* buffers from userspace */
Johannes Berg6e3e9392011-11-09 10:15:42 +0100714 SOCK_WIFI_STATUS, /* push wifi status to userspace */
Ben Greear3bdc0eb2012-02-11 15:39:30 +0000715 SOCK_NOFCS, /* Tell NIC not to do the Ethernet FCS.
716 * Will use last 4 bytes of packet sent from
717 * user-space instead.
718 */
Vincent Bernatd59577b2013-01-16 22:55:49 +0100719 SOCK_FILTER_LOCKED, /* Filter cannot be changed anymore */
Keller, Jacob E7d4c04f2013-03-28 11:19:25 +0000720 SOCK_SELECT_ERR_QUEUE, /* Wake select on error queue */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700721};
722
Ralf Baechle53b924b2005-08-23 10:11:30 -0700723static inline void sock_copy_flags(struct sock *nsk, struct sock *osk)
724{
725 nsk->sk_flags = osk->sk_flags;
726}
727
Linus Torvalds1da177e2005-04-16 15:20:36 -0700728static inline void sock_set_flag(struct sock *sk, enum sock_flags flag)
729{
730 __set_bit(flag, &sk->sk_flags);
731}
732
733static inline void sock_reset_flag(struct sock *sk, enum sock_flags flag)
734{
735 __clear_bit(flag, &sk->sk_flags);
736}
737
Eric Dumazet1b23a5d2012-05-16 05:57:07 +0000738static inline bool sock_flag(const struct sock *sk, enum sock_flags flag)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700739{
740 return test_bit(flag, &sk->sk_flags);
741}
742
Mel Gormanc93bdd02012-07-31 16:44:19 -0700743#ifdef CONFIG_NET
744extern struct static_key memalloc_socks;
745static inline int sk_memalloc_socks(void)
746{
747 return static_key_false(&memalloc_socks);
748}
749#else
750
751static inline int sk_memalloc_socks(void)
752{
753 return 0;
754}
755
756#endif
757
Mel Gorman99a1dec2012-07-31 16:44:14 -0700758static inline gfp_t sk_gfp_atomic(struct sock *sk, gfp_t gfp_mask)
759{
Mel Gorman7cb02402012-07-31 16:44:16 -0700760 return GFP_ATOMIC | (sk->sk_allocation & __GFP_MEMALLOC);
Mel Gorman99a1dec2012-07-31 16:44:14 -0700761}
762
Linus Torvalds1da177e2005-04-16 15:20:36 -0700763static inline void sk_acceptq_removed(struct sock *sk)
764{
765 sk->sk_ack_backlog--;
766}
767
768static inline void sk_acceptq_added(struct sock *sk)
769{
770 sk->sk_ack_backlog++;
771}
772
Eric Dumazetdc6b9b72012-05-16 22:48:15 +0000773static inline bool sk_acceptq_is_full(const struct sock *sk)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700774{
David S. Miller64a14652007-03-06 11:21:05 -0800775 return sk->sk_ack_backlog > sk->sk_max_ack_backlog;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700776}
777
778/*
779 * Compute minimal free write space needed to queue new packets.
780 */
Eric Dumazetdc6b9b72012-05-16 22:48:15 +0000781static inline int sk_stream_min_wspace(const struct sock *sk)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700782{
Eric Dumazet8df09ea2007-12-21 03:07:41 -0800783 return sk->sk_wmem_queued >> 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700784}
785
Eric Dumazetdc6b9b72012-05-16 22:48:15 +0000786static inline int sk_stream_wspace(const struct sock *sk)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700787{
788 return sk->sk_sndbuf - sk->sk_wmem_queued;
789}
790
Joe Perches69336bd2013-09-22 10:32:26 -0700791void sk_stream_write_space(struct sock *sk);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700792
Zhu Yi8eae9392010-03-04 18:01:40 +0000793/* OOB backlog add */
Zhu Yia3a858f2010-03-04 18:01:47 +0000794static inline void __sk_add_backlog(struct sock *sk, struct sk_buff *skb)
Stephen Hemminger9ee6b532005-11-08 09:39:42 -0800795{
Eric Dumazet7fee2262010-05-11 23:19:48 +0000796 /* dont let skb dst not refcounted, we are going to leave rcu lock */
797 skb_dst_force(skb);
798
799 if (!sk->sk_backlog.tail)
800 sk->sk_backlog.head = skb;
801 else
Stephen Hemminger9ee6b532005-11-08 09:39:42 -0800802 sk->sk_backlog.tail->next = skb;
Eric Dumazet7fee2262010-05-11 23:19:48 +0000803
804 sk->sk_backlog.tail = skb;
Stephen Hemminger9ee6b532005-11-08 09:39:42 -0800805 skb->next = NULL;
806}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700807
Eric Dumazetc3774112010-04-27 15:13:20 -0700808/*
809 * Take into account size of receive queue and backlog queue
Eric Dumazet0fd7bac2011-12-21 07:11:44 +0000810 * Do not take into account this skb truesize,
811 * to allow even a single big packet to come.
Eric Dumazetc3774112010-04-27 15:13:20 -0700812 */
Sorin Dumitru274f4822014-07-22 21:16:51 +0300813static inline bool sk_rcvqueues_full(const struct sock *sk, unsigned int limit)
Eric Dumazetc3774112010-04-27 15:13:20 -0700814{
815 unsigned int qsize = sk->sk_backlog.len + atomic_read(&sk->sk_rmem_alloc);
816
Eric Dumazetf545a382012-04-22 23:34:26 +0000817 return qsize > limit;
Eric Dumazetc3774112010-04-27 15:13:20 -0700818}
819
Zhu Yi8eae9392010-03-04 18:01:40 +0000820/* The per-socket spinlock must be held here. */
Eric Dumazetf545a382012-04-22 23:34:26 +0000821static inline __must_check int sk_add_backlog(struct sock *sk, struct sk_buff *skb,
822 unsigned int limit)
Zhu Yi8eae9392010-03-04 18:01:40 +0000823{
Sorin Dumitru274f4822014-07-22 21:16:51 +0300824 if (sk_rcvqueues_full(sk, limit))
Zhu Yi8eae9392010-03-04 18:01:40 +0000825 return -ENOBUFS;
826
Zhu Yia3a858f2010-03-04 18:01:47 +0000827 __sk_add_backlog(sk, skb);
Zhu Yi8eae9392010-03-04 18:01:40 +0000828 sk->sk_backlog.len += skb->truesize;
829 return 0;
830}
831
Joe Perches69336bd2013-09-22 10:32:26 -0700832int __sk_backlog_rcv(struct sock *sk, struct sk_buff *skb);
Mel Gormanb4b9e352012-07-31 16:44:26 -0700833
Peter Zijlstrac57943a2008-10-07 14:18:42 -0700834static inline int sk_backlog_rcv(struct sock *sk, struct sk_buff *skb)
835{
Mel Gormanb4b9e352012-07-31 16:44:26 -0700836 if (sk_memalloc_socks() && skb_pfmemalloc(skb))
837 return __sk_backlog_rcv(sk, skb);
838
Peter Zijlstrac57943a2008-10-07 14:18:42 -0700839 return sk->sk_backlog_rcv(sk, skb);
840}
841
Tom Herbertfe477552013-12-22 18:54:31 +0800842static inline void sock_rps_record_flow_hash(__u32 hash)
David S. Millerc58dc012010-04-27 15:05:31 -0700843{
844#ifdef CONFIG_RPS
845 struct rps_sock_flow_table *sock_flow_table;
846
847 rcu_read_lock();
848 sock_flow_table = rcu_dereference(rps_sock_flow_table);
Tom Herbertfe477552013-12-22 18:54:31 +0800849 rps_record_sock_flow(sock_flow_table, hash);
David S. Millerc58dc012010-04-27 15:05:31 -0700850 rcu_read_unlock();
851#endif
852}
853
Tom Herbertfe477552013-12-22 18:54:31 +0800854static inline void sock_rps_reset_flow_hash(__u32 hash)
David S. Millerc58dc012010-04-27 15:05:31 -0700855{
856#ifdef CONFIG_RPS
857 struct rps_sock_flow_table *sock_flow_table;
858
859 rcu_read_lock();
860 sock_flow_table = rcu_dereference(rps_sock_flow_table);
Tom Herbertfe477552013-12-22 18:54:31 +0800861 rps_reset_sock_flow(sock_flow_table, hash);
David S. Millerc58dc012010-04-27 15:05:31 -0700862 rcu_read_unlock();
863#endif
864}
865
Tom Herbertfe477552013-12-22 18:54:31 +0800866static inline void sock_rps_record_flow(const struct sock *sk)
867{
Zhi Yong Wuc9d8ca02014-01-01 04:31:01 +0800868#ifdef CONFIG_RPS
Tom Herbertfe477552013-12-22 18:54:31 +0800869 sock_rps_record_flow_hash(sk->sk_rxhash);
Zhi Yong Wuc9d8ca02014-01-01 04:31:01 +0800870#endif
Tom Herbertfe477552013-12-22 18:54:31 +0800871}
872
873static inline void sock_rps_reset_flow(const struct sock *sk)
874{
Zhi Yong Wuc9d8ca02014-01-01 04:31:01 +0800875#ifdef CONFIG_RPS
Tom Herbertfe477552013-12-22 18:54:31 +0800876 sock_rps_reset_flow_hash(sk->sk_rxhash);
Zhi Yong Wuc9d8ca02014-01-01 04:31:01 +0800877#endif
Tom Herbertfe477552013-12-22 18:54:31 +0800878}
879
Tom Herbertbdeab992011-08-14 19:45:55 +0000880static inline void sock_rps_save_rxhash(struct sock *sk,
881 const struct sk_buff *skb)
David S. Millerc58dc012010-04-27 15:05:31 -0700882{
883#ifdef CONFIG_RPS
Tom Herbert61b905d2014-03-24 15:34:47 -0700884 if (unlikely(sk->sk_rxhash != skb->hash)) {
David S. Millerc58dc012010-04-27 15:05:31 -0700885 sock_rps_reset_flow(sk);
Tom Herbert61b905d2014-03-24 15:34:47 -0700886 sk->sk_rxhash = skb->hash;
David S. Millerc58dc012010-04-27 15:05:31 -0700887 }
888#endif
889}
890
Tom Herbertbdeab992011-08-14 19:45:55 +0000891static inline void sock_rps_reset_rxhash(struct sock *sk)
892{
893#ifdef CONFIG_RPS
894 sock_rps_reset_flow(sk);
895 sk->sk_rxhash = 0;
896#endif
897}
898
Stephen Hemmingercfcabdc2007-10-09 01:59:42 -0700899#define sk_wait_event(__sk, __timeo, __condition) \
900 ({ int __rc; \
901 release_sock(__sk); \
902 __rc = __condition; \
903 if (!__rc) { \
904 *(__timeo) = schedule_timeout(*(__timeo)); \
905 } \
906 lock_sock(__sk); \
907 __rc = __condition; \
908 __rc; \
909 })
Linus Torvalds1da177e2005-04-16 15:20:36 -0700910
Joe Perches69336bd2013-09-22 10:32:26 -0700911int sk_stream_wait_connect(struct sock *sk, long *timeo_p);
912int sk_stream_wait_memory(struct sock *sk, long *timeo_p);
913void sk_stream_wait_close(struct sock *sk, long timeo_p);
914int sk_stream_error(struct sock *sk, int flags, int err);
915void sk_stream_kill_queues(struct sock *sk);
916void sk_set_memalloc(struct sock *sk);
917void sk_clear_memalloc(struct sock *sk);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700918
Joe Perches69336bd2013-09-22 10:32:26 -0700919int sk_wait_data(struct sock *sk, long *timeo);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700920
Arnaldo Carvalho de Melo60236fd2005-06-18 22:47:21 -0700921struct request_sock_ops;
Arnaldo Carvalho de Melo6d6ee432005-12-13 23:25:19 -0800922struct timewait_sock_ops;
Arnaldo Carvalho de Meloab1e0a12008-02-03 04:06:04 -0800923struct inet_hashinfo;
Pavel Emelyanovfc8717b2008-03-22 16:56:51 -0700924struct raw_hashinfo;
Paul Gortmakerde477252011-05-26 13:46:22 -0400925struct module;
Arnaldo Carvalho de Melo2e6599c2005-06-18 22:46:52 -0700926
Eric Dumazetf77d6022013-05-09 10:28:16 +0000927/*
928 * caches using SLAB_DESTROY_BY_RCU should let .next pointer from nulls nodes
929 * un-modified. Special care is taken when initializing object to zero.
930 */
931static inline void sk_prot_clear_nulls(struct sock *sk, int size)
932{
933 if (offsetof(struct sock, sk_node.next) != 0)
934 memset(sk, 0, offsetof(struct sock, sk_node.next));
935 memset(&sk->sk_node.pprev, 0,
936 size - offsetof(struct sock, sk_node.pprev));
937}
938
Linus Torvalds1da177e2005-04-16 15:20:36 -0700939/* Networking protocol blocks we attach to sockets.
940 * socket layer -> transport layer interface
941 * transport -> network interface is defined by struct inet_proto
942 */
943struct proto {
Eric Dumazetdc6b9b72012-05-16 22:48:15 +0000944 void (*close)(struct sock *sk,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700945 long timeout);
946 int (*connect)(struct sock *sk,
Eric Dumazetdc6b9b72012-05-16 22:48:15 +0000947 struct sockaddr *uaddr,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700948 int addr_len);
949 int (*disconnect)(struct sock *sk, int flags);
950
Eric Dumazetdc6b9b72012-05-16 22:48:15 +0000951 struct sock * (*accept)(struct sock *sk, int flags, int *err);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700952
953 int (*ioctl)(struct sock *sk, int cmd,
954 unsigned long arg);
955 int (*init)(struct sock *sk);
Brian Haley7d06b2e2008-06-14 17:04:49 -0700956 void (*destroy)(struct sock *sk);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700957 void (*shutdown)(struct sock *sk, int how);
Eric Dumazetdc6b9b72012-05-16 22:48:15 +0000958 int (*setsockopt)(struct sock *sk, int level,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700959 int optname, char __user *optval,
David S. Millerb7058842009-09-30 16:12:20 -0700960 unsigned int optlen);
Eric Dumazetdc6b9b72012-05-16 22:48:15 +0000961 int (*getsockopt)(struct sock *sk, int level,
962 int optname, char __user *optval,
963 int __user *option);
Alexey Dobriyanaf01d532008-08-28 02:53:51 -0700964#ifdef CONFIG_COMPAT
Dmitry Mishin3fdadf72006-03-20 22:45:21 -0800965 int (*compat_setsockopt)(struct sock *sk,
966 int level,
967 int optname, char __user *optval,
David S. Millerb7058842009-09-30 16:12:20 -0700968 unsigned int optlen);
Dmitry Mishin3fdadf72006-03-20 22:45:21 -0800969 int (*compat_getsockopt)(struct sock *sk,
970 int level,
971 int optname, char __user *optval,
972 int __user *option);
Eric W. Biederman709b46e2011-01-29 16:15:56 +0000973 int (*compat_ioctl)(struct sock *sk,
974 unsigned int cmd, unsigned long arg);
Alexey Dobriyanaf01d532008-08-28 02:53:51 -0700975#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -0700976 int (*sendmsg)(struct kiocb *iocb, struct sock *sk,
977 struct msghdr *msg, size_t len);
978 int (*recvmsg)(struct kiocb *iocb, struct sock *sk,
979 struct msghdr *msg,
Eric Dumazetdc6b9b72012-05-16 22:48:15 +0000980 size_t len, int noblock, int flags,
981 int *addr_len);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700982 int (*sendpage)(struct sock *sk, struct page *page,
983 int offset, size_t size, int flags);
Eric Dumazetdc6b9b72012-05-16 22:48:15 +0000984 int (*bind)(struct sock *sk,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700985 struct sockaddr *uaddr, int addr_len);
986
Eric Dumazetdc6b9b72012-05-16 22:48:15 +0000987 int (*backlog_rcv) (struct sock *sk,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700988 struct sk_buff *skb);
989
Eric Dumazet46d3cea2012-07-11 05:50:31 +0000990 void (*release_cb)(struct sock *sk);
Eric Dumazet563d34d2012-07-23 09:48:52 +0200991 void (*mtu_reduced)(struct sock *sk);
Eric Dumazet46d3cea2012-07-11 05:50:31 +0000992
Linus Torvalds1da177e2005-04-16 15:20:36 -0700993 /* Keeping track of sk's, looking them up, and port selection methods. */
994 void (*hash)(struct sock *sk);
995 void (*unhash)(struct sock *sk);
Eric Dumazet719f8352010-09-08 05:08:44 +0000996 void (*rehash)(struct sock *sk);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700997 int (*get_port)(struct sock *sk, unsigned short snum);
Octavian Purdilafcbdf092010-12-16 14:26:56 -0800998 void (*clear_sk)(struct sock *sk, int size);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700999
Eric Dumazet286ab3d2007-11-05 23:38:39 -08001000 /* Keeping track of sockets in use */
Eric Dumazet65f76512008-01-03 20:46:48 -08001001#ifdef CONFIG_PROC_FS
Pavel Emelyanov13ff3d62008-03-28 16:38:17 -07001002 unsigned int inuse_idx;
Eric Dumazet65f76512008-01-03 20:46:48 -08001003#endif
Arnaldo Carvalho de Meloebb53d72007-11-21 22:08:50 +08001004
Eric Dumazetc9bee3b72013-07-22 20:27:07 -07001005 bool (*stream_memory_free)(const struct sock *sk);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001006 /* Memory pressure */
Pavel Emelyanov5c52ba12008-07-16 20:28:10 -07001007 void (*enter_memory_pressure)(struct sock *sk);
Eric Dumazet8d987e52010-11-09 23:24:26 +00001008 atomic_long_t *memory_allocated; /* Current allocated memory. */
Eric Dumazet17483762008-11-25 21:16:35 -08001009 struct percpu_counter *sockets_allocated; /* Current number of sockets. */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001010 /*
1011 * Pressure flag: try to collapse.
1012 * Technical note: it is used by multiple contexts non atomically.
Hideo Aoki3ab224b2007-12-31 00:11:19 -08001013 * All the __sk_mem_schedule() is of this nature: accounting
Linus Torvalds1da177e2005-04-16 15:20:36 -07001014 * is strict, actions are advisory and have some latency.
1015 */
1016 int *memory_pressure;
Eric Dumazet8d987e52010-11-09 23:24:26 +00001017 long *sysctl_mem;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001018 int *sysctl_wmem;
1019 int *sysctl_rmem;
1020 int max_header;
Changli Gao7ba42912010-07-10 20:41:55 +00001021 bool no_autobind;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001022
Eric Dumazet271b72c2008-10-29 02:11:14 -07001023 struct kmem_cache *slab;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001024 unsigned int obj_size;
Eric Dumazet271b72c2008-10-29 02:11:14 -07001025 int slab_flags;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001026
Eric Dumazetdd24c002008-11-25 21:17:14 -08001027 struct percpu_counter *orphan_count;
Arnaldo Carvalho de Melo8feaf0c02005-08-09 20:09:30 -07001028
Arnaldo Carvalho de Melo60236fd2005-06-18 22:47:21 -07001029 struct request_sock_ops *rsk_prot;
Arnaldo Carvalho de Melo6d6ee432005-12-13 23:25:19 -08001030 struct timewait_sock_ops *twsk_prot;
Arnaldo Carvalho de Melo2e6599c2005-06-18 22:46:52 -07001031
Pavel Emelyanov39d8cda2008-03-22 16:50:58 -07001032 union {
1033 struct inet_hashinfo *hashinfo;
Eric Dumazet645ca702008-10-29 01:41:45 -07001034 struct udp_table *udp_table;
Pavel Emelyanovfc8717b2008-03-22 16:56:51 -07001035 struct raw_hashinfo *raw_hash;
Pavel Emelyanov39d8cda2008-03-22 16:50:58 -07001036 } h;
Arnaldo Carvalho de Meloab1e0a12008-02-03 04:06:04 -08001037
Linus Torvalds1da177e2005-04-16 15:20:36 -07001038 struct module *owner;
1039
1040 char name[32];
1041
1042 struct list_head node;
Arnaldo Carvalho de Meloe6848972005-08-09 19:45:38 -07001043#ifdef SOCK_REFCNT_DEBUG
1044 atomic_t socks;
1045#endif
Andrew Mortonc255a452012-07-31 16:43:02 -07001046#ifdef CONFIG_MEMCG_KMEM
Glauber Costae1aab162011-12-11 21:47:03 +00001047 /*
1048 * cgroup specific init/deinit functions. Called once for all
1049 * protocols that implement it, from cgroups populate function.
1050 * This function has to setup any files the protocol want to
1051 * appear in the kmem cgroup filesystem.
1052 */
Glauber Costa1d62e432012-04-09 19:36:33 -03001053 int (*init_cgroup)(struct mem_cgroup *memcg,
Glauber Costae1aab162011-12-11 21:47:03 +00001054 struct cgroup_subsys *ss);
Glauber Costa1d62e432012-04-09 19:36:33 -03001055 void (*destroy_cgroup)(struct mem_cgroup *memcg);
Glauber Costae1aab162011-12-11 21:47:03 +00001056 struct cg_proto *(*proto_cgroup)(struct mem_cgroup *memcg);
1057#endif
1058};
1059
Glauber Costa3f134612012-05-29 15:07:11 -07001060/*
1061 * Bits in struct cg_proto.flags
1062 */
1063enum cg_proto_flags {
1064 /* Currently active and new sockets should be assigned to cgroups */
1065 MEMCG_SOCK_ACTIVE,
1066 /* It was ever activated; we must disarm static keys on destruction */
1067 MEMCG_SOCK_ACTIVATED,
1068};
1069
Glauber Costae1aab162011-12-11 21:47:03 +00001070struct cg_proto {
Eric W. Biederman2e685ca2013-10-19 16:26:19 -07001071 struct res_counter memory_allocated; /* Current allocated memory. */
1072 struct percpu_counter sockets_allocated; /* Current number of sockets. */
1073 int memory_pressure;
1074 long sysctl_mem[3];
Glauber Costa3f134612012-05-29 15:07:11 -07001075 unsigned long flags;
Glauber Costae1aab162011-12-11 21:47:03 +00001076 /*
1077 * memcg field is used to find which memcg we belong directly
1078 * Each memcg struct can hold more than one cg_proto, so container_of
1079 * won't really cut.
1080 *
1081 * The elegant solution would be having an inverse function to
1082 * proto_cgroup in struct proto, but that means polluting the structure
1083 * for everybody, instead of just for memcg users.
1084 */
1085 struct mem_cgroup *memcg;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001086};
1087
Joe Perches69336bd2013-09-22 10:32:26 -07001088int proto_register(struct proto *prot, int alloc_slab);
1089void proto_unregister(struct proto *prot);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001090
Glauber Costa3f134612012-05-29 15:07:11 -07001091static inline bool memcg_proto_active(struct cg_proto *cg_proto)
1092{
1093 return test_bit(MEMCG_SOCK_ACTIVE, &cg_proto->flags);
1094}
1095
1096static inline bool memcg_proto_activated(struct cg_proto *cg_proto)
1097{
1098 return test_bit(MEMCG_SOCK_ACTIVATED, &cg_proto->flags);
1099}
1100
Arnaldo Carvalho de Meloe6848972005-08-09 19:45:38 -07001101#ifdef SOCK_REFCNT_DEBUG
1102static inline void sk_refcnt_debug_inc(struct sock *sk)
1103{
1104 atomic_inc(&sk->sk_prot->socks);
1105}
1106
1107static inline void sk_refcnt_debug_dec(struct sock *sk)
1108{
1109 atomic_dec(&sk->sk_prot->socks);
1110 printk(KERN_DEBUG "%s socket %p released, %d are still alive\n",
1111 sk->sk_prot->name, sk, atomic_read(&sk->sk_prot->socks));
1112}
1113
Ying Xuedec34fb2013-02-15 22:28:25 +00001114static inline void sk_refcnt_debug_release(const struct sock *sk)
Arnaldo Carvalho de Meloe6848972005-08-09 19:45:38 -07001115{
1116 if (atomic_read(&sk->sk_refcnt) != 1)
1117 printk(KERN_DEBUG "Destruction of the %s socket %p delayed, refcnt=%d\n",
1118 sk->sk_prot->name, sk, atomic_read(&sk->sk_refcnt));
1119}
1120#else /* SOCK_REFCNT_DEBUG */
1121#define sk_refcnt_debug_inc(sk) do { } while (0)
1122#define sk_refcnt_debug_dec(sk) do { } while (0)
1123#define sk_refcnt_debug_release(sk) do { } while (0)
1124#endif /* SOCK_REFCNT_DEBUG */
1125
Andrew Mortonc255a452012-07-31 16:43:02 -07001126#if defined(CONFIG_MEMCG_KMEM) && defined(CONFIG_NET)
Ingo Molnarc5905af2012-02-24 08:31:31 +01001127extern struct static_key memcg_socket_limit_enabled;
Glauber Costae1aab162011-12-11 21:47:03 +00001128static inline struct cg_proto *parent_cg_proto(struct proto *proto,
1129 struct cg_proto *cg_proto)
1130{
1131 return proto->proto_cgroup(parent_mem_cgroup(cg_proto->memcg));
1132}
Ingo Molnarc5905af2012-02-24 08:31:31 +01001133#define mem_cgroup_sockets_enabled static_key_false(&memcg_socket_limit_enabled)
Glauber Costae1aab162011-12-11 21:47:03 +00001134#else
1135#define mem_cgroup_sockets_enabled 0
1136static inline struct cg_proto *parent_cg_proto(struct proto *proto,
1137 struct cg_proto *cg_proto)
1138{
1139 return NULL;
1140}
1141#endif
1142
Eric Dumazetc9bee3b72013-07-22 20:27:07 -07001143static inline bool sk_stream_memory_free(const struct sock *sk)
1144{
1145 if (sk->sk_wmem_queued >= sk->sk_sndbuf)
1146 return false;
1147
1148 return sk->sk_prot->stream_memory_free ?
1149 sk->sk_prot->stream_memory_free(sk) : true;
1150}
1151
Eric Dumazet64dc6132013-07-22 20:26:31 -07001152static inline bool sk_stream_is_writeable(const struct sock *sk)
1153{
Eric Dumazetc9bee3b72013-07-22 20:27:07 -07001154 return sk_stream_wspace(sk) >= sk_stream_min_wspace(sk) &&
1155 sk_stream_memory_free(sk);
Eric Dumazet64dc6132013-07-22 20:26:31 -07001156}
Glauber Costae1aab162011-12-11 21:47:03 +00001157
Eric Dumazetc9bee3b72013-07-22 20:27:07 -07001158
Glauber Costa180d8cd2011-12-11 21:47:02 +00001159static inline bool sk_has_memory_pressure(const struct sock *sk)
1160{
1161 return sk->sk_prot->memory_pressure != NULL;
1162}
1163
1164static inline bool sk_under_memory_pressure(const struct sock *sk)
1165{
1166 if (!sk->sk_prot->memory_pressure)
1167 return false;
Glauber Costae1aab162011-12-11 21:47:03 +00001168
1169 if (mem_cgroup_sockets_enabled && sk->sk_cgrp)
Eric W. Biederman2e685ca2013-10-19 16:26:19 -07001170 return !!sk->sk_cgrp->memory_pressure;
Glauber Costae1aab162011-12-11 21:47:03 +00001171
Christoph Paasch35b87f62013-10-23 12:49:21 -07001172 return !!*sk->sk_prot->memory_pressure;
Glauber Costa180d8cd2011-12-11 21:47:02 +00001173}
1174
1175static inline void sk_leave_memory_pressure(struct sock *sk)
1176{
1177 int *memory_pressure = sk->sk_prot->memory_pressure;
1178
Glauber Costae1aab162011-12-11 21:47:03 +00001179 if (!memory_pressure)
1180 return;
1181
1182 if (*memory_pressure)
Glauber Costa180d8cd2011-12-11 21:47:02 +00001183 *memory_pressure = 0;
Glauber Costae1aab162011-12-11 21:47:03 +00001184
1185 if (mem_cgroup_sockets_enabled && sk->sk_cgrp) {
1186 struct cg_proto *cg_proto = sk->sk_cgrp;
1187 struct proto *prot = sk->sk_prot;
1188
1189 for (; cg_proto; cg_proto = parent_cg_proto(prot, cg_proto))
Eric W. Biederman7f2cbdc2013-12-04 20:12:04 -08001190 cg_proto->memory_pressure = 0;
Glauber Costae1aab162011-12-11 21:47:03 +00001191 }
1192
Glauber Costa180d8cd2011-12-11 21:47:02 +00001193}
1194
1195static inline void sk_enter_memory_pressure(struct sock *sk)
1196{
Glauber Costae1aab162011-12-11 21:47:03 +00001197 if (!sk->sk_prot->enter_memory_pressure)
1198 return;
1199
1200 if (mem_cgroup_sockets_enabled && sk->sk_cgrp) {
1201 struct cg_proto *cg_proto = sk->sk_cgrp;
1202 struct proto *prot = sk->sk_prot;
1203
1204 for (; cg_proto; cg_proto = parent_cg_proto(prot, cg_proto))
Eric W. Biederman7f2cbdc2013-12-04 20:12:04 -08001205 cg_proto->memory_pressure = 1;
Glauber Costae1aab162011-12-11 21:47:03 +00001206 }
1207
1208 sk->sk_prot->enter_memory_pressure(sk);
Glauber Costa180d8cd2011-12-11 21:47:02 +00001209}
1210
1211static inline long sk_prot_mem_limits(const struct sock *sk, int index)
1212{
1213 long *prot = sk->sk_prot->sysctl_mem;
Glauber Costae1aab162011-12-11 21:47:03 +00001214 if (mem_cgroup_sockets_enabled && sk->sk_cgrp)
1215 prot = sk->sk_cgrp->sysctl_mem;
Glauber Costa180d8cd2011-12-11 21:47:02 +00001216 return prot[index];
1217}
1218
Glauber Costae1aab162011-12-11 21:47:03 +00001219static inline void memcg_memory_allocated_add(struct cg_proto *prot,
1220 unsigned long amt,
1221 int *parent_status)
1222{
1223 struct res_counter *fail;
1224 int ret;
1225
Eric W. Biederman2e685ca2013-10-19 16:26:19 -07001226 ret = res_counter_charge_nofail(&prot->memory_allocated,
Glauber Costa0e90b312012-01-20 04:57:16 +00001227 amt << PAGE_SHIFT, &fail);
Glauber Costae1aab162011-12-11 21:47:03 +00001228 if (ret < 0)
1229 *parent_status = OVER_LIMIT;
1230}
1231
1232static inline void memcg_memory_allocated_sub(struct cg_proto *prot,
1233 unsigned long amt)
1234{
Eric W. Biederman2e685ca2013-10-19 16:26:19 -07001235 res_counter_uncharge(&prot->memory_allocated, amt << PAGE_SHIFT);
Glauber Costae1aab162011-12-11 21:47:03 +00001236}
1237
1238static inline u64 memcg_memory_allocated_read(struct cg_proto *prot)
1239{
1240 u64 ret;
Eric W. Biederman2e685ca2013-10-19 16:26:19 -07001241 ret = res_counter_read_u64(&prot->memory_allocated, RES_USAGE);
Glauber Costae1aab162011-12-11 21:47:03 +00001242 return ret >> PAGE_SHIFT;
1243}
1244
Glauber Costa180d8cd2011-12-11 21:47:02 +00001245static inline long
1246sk_memory_allocated(const struct sock *sk)
1247{
1248 struct proto *prot = sk->sk_prot;
Glauber Costae1aab162011-12-11 21:47:03 +00001249 if (mem_cgroup_sockets_enabled && sk->sk_cgrp)
1250 return memcg_memory_allocated_read(sk->sk_cgrp);
1251
Glauber Costa180d8cd2011-12-11 21:47:02 +00001252 return atomic_long_read(prot->memory_allocated);
1253}
1254
1255static inline long
Glauber Costae1aab162011-12-11 21:47:03 +00001256sk_memory_allocated_add(struct sock *sk, int amt, int *parent_status)
Glauber Costa180d8cd2011-12-11 21:47:02 +00001257{
1258 struct proto *prot = sk->sk_prot;
Glauber Costae1aab162011-12-11 21:47:03 +00001259
1260 if (mem_cgroup_sockets_enabled && sk->sk_cgrp) {
1261 memcg_memory_allocated_add(sk->sk_cgrp, amt, parent_status);
1262 /* update the root cgroup regardless */
1263 atomic_long_add_return(amt, prot->memory_allocated);
1264 return memcg_memory_allocated_read(sk->sk_cgrp);
1265 }
1266
Glauber Costa180d8cd2011-12-11 21:47:02 +00001267 return atomic_long_add_return(amt, prot->memory_allocated);
1268}
1269
1270static inline void
Glauber Costa0e90b312012-01-20 04:57:16 +00001271sk_memory_allocated_sub(struct sock *sk, int amt)
Glauber Costa180d8cd2011-12-11 21:47:02 +00001272{
1273 struct proto *prot = sk->sk_prot;
Glauber Costae1aab162011-12-11 21:47:03 +00001274
Glauber Costa0e90b312012-01-20 04:57:16 +00001275 if (mem_cgroup_sockets_enabled && sk->sk_cgrp)
Glauber Costae1aab162011-12-11 21:47:03 +00001276 memcg_memory_allocated_sub(sk->sk_cgrp, amt);
1277
Glauber Costa180d8cd2011-12-11 21:47:02 +00001278 atomic_long_sub(amt, prot->memory_allocated);
1279}
1280
1281static inline void sk_sockets_allocated_dec(struct sock *sk)
1282{
1283 struct proto *prot = sk->sk_prot;
Glauber Costae1aab162011-12-11 21:47:03 +00001284
1285 if (mem_cgroup_sockets_enabled && sk->sk_cgrp) {
1286 struct cg_proto *cg_proto = sk->sk_cgrp;
1287
1288 for (; cg_proto; cg_proto = parent_cg_proto(prot, cg_proto))
Eric W. Biederman2e685ca2013-10-19 16:26:19 -07001289 percpu_counter_dec(&cg_proto->sockets_allocated);
Glauber Costae1aab162011-12-11 21:47:03 +00001290 }
1291
Glauber Costa180d8cd2011-12-11 21:47:02 +00001292 percpu_counter_dec(prot->sockets_allocated);
1293}
1294
1295static inline void sk_sockets_allocated_inc(struct sock *sk)
1296{
1297 struct proto *prot = sk->sk_prot;
Glauber Costae1aab162011-12-11 21:47:03 +00001298
1299 if (mem_cgroup_sockets_enabled && sk->sk_cgrp) {
1300 struct cg_proto *cg_proto = sk->sk_cgrp;
1301
1302 for (; cg_proto; cg_proto = parent_cg_proto(prot, cg_proto))
Eric W. Biederman2e685ca2013-10-19 16:26:19 -07001303 percpu_counter_inc(&cg_proto->sockets_allocated);
Glauber Costae1aab162011-12-11 21:47:03 +00001304 }
1305
Glauber Costa180d8cd2011-12-11 21:47:02 +00001306 percpu_counter_inc(prot->sockets_allocated);
1307}
1308
1309static inline int
1310sk_sockets_allocated_read_positive(struct sock *sk)
1311{
1312 struct proto *prot = sk->sk_prot;
1313
Glauber Costae1aab162011-12-11 21:47:03 +00001314 if (mem_cgroup_sockets_enabled && sk->sk_cgrp)
Eric W. Biederman2e685ca2013-10-19 16:26:19 -07001315 return percpu_counter_read_positive(&sk->sk_cgrp->sockets_allocated);
Glauber Costae1aab162011-12-11 21:47:03 +00001316
Eric Dumazet518fbf92012-04-28 23:21:56 +00001317 return percpu_counter_read_positive(prot->sockets_allocated);
Glauber Costa180d8cd2011-12-11 21:47:02 +00001318}
1319
1320static inline int
1321proto_sockets_allocated_sum_positive(struct proto *prot)
1322{
1323 return percpu_counter_sum_positive(prot->sockets_allocated);
1324}
1325
1326static inline long
1327proto_memory_allocated(struct proto *prot)
1328{
1329 return atomic_long_read(prot->memory_allocated);
1330}
1331
1332static inline bool
1333proto_memory_pressure(struct proto *prot)
1334{
1335 if (!prot->memory_pressure)
1336 return false;
1337 return !!*prot->memory_pressure;
1338}
1339
Eric Dumazet65f76512008-01-03 20:46:48 -08001340
1341#ifdef CONFIG_PROC_FS
Linus Torvalds1da177e2005-04-16 15:20:36 -07001342/* Called with local bh disabled */
Joe Perches69336bd2013-09-22 10:32:26 -07001343void sock_prot_inuse_add(struct net *net, struct proto *prot, int inc);
1344int sock_prot_inuse_get(struct net *net, struct proto *proto);
Eric Dumazet65f76512008-01-03 20:46:48 -08001345#else
Eric Dumazetdc6b9b72012-05-16 22:48:15 +00001346static inline void sock_prot_inuse_add(struct net *net, struct proto *prot,
Pavel Emelyanovc29a0bc2008-03-31 19:41:46 -07001347 int inc)
Eric Dumazet65f76512008-01-03 20:46:48 -08001348{
1349}
Eric Dumazet65f76512008-01-03 20:46:48 -08001350#endif
1351
Linus Torvalds1da177e2005-04-16 15:20:36 -07001352
Arnaldo Carvalho de Melo614c6cb2005-08-09 19:47:37 -07001353/* With per-bucket locks this operation is not-atomic, so that
1354 * this version is not worse.
1355 */
1356static inline void __sk_prot_rehash(struct sock *sk)
1357{
1358 sk->sk_prot->unhash(sk);
1359 sk->sk_prot->hash(sk);
1360}
1361
Octavian Purdilafcbdf092010-12-16 14:26:56 -08001362void sk_prot_clear_portaddr_nulls(struct sock *sk, int size);
1363
Linus Torvalds1da177e2005-04-16 15:20:36 -07001364/* About 10 seconds */
1365#define SOCK_DESTROY_TIME (10*HZ)
1366
1367/* Sockets 0-1023 can't be bound to unless you are superuser */
1368#define PROT_SOCK 1024
1369
1370#define SHUTDOWN_MASK 3
1371#define RCV_SHUTDOWN 1
1372#define SEND_SHUTDOWN 2
1373
1374#define SOCK_SNDBUF_LOCK 1
1375#define SOCK_RCVBUF_LOCK 2
1376#define SOCK_BINDADDR_LOCK 4
1377#define SOCK_BINDPORT_LOCK 8
1378
1379/* sock_iocb: used to kick off async processing of socket ios */
1380struct sock_iocb {
1381 struct list_head list;
1382
1383 int flags;
1384 int size;
1385 struct socket *sock;
1386 struct sock *sk;
1387 struct scm_cookie *scm;
1388 struct msghdr *msg, async_msg;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001389 struct kiocb *kiocb;
1390};
1391
1392static inline struct sock_iocb *kiocb_to_siocb(struct kiocb *iocb)
1393{
1394 return (struct sock_iocb *)iocb->private;
1395}
1396
1397static inline struct kiocb *siocb_to_kiocb(struct sock_iocb *si)
1398{
1399 return si->kiocb;
1400}
1401
1402struct socket_alloc {
1403 struct socket socket;
1404 struct inode vfs_inode;
1405};
1406
1407static inline struct socket *SOCKET_I(struct inode *inode)
1408{
1409 return &container_of(inode, struct socket_alloc, vfs_inode)->socket;
1410}
1411
1412static inline struct inode *SOCK_INODE(struct socket *socket)
1413{
1414 return &container_of(socket, struct socket_alloc, socket)->vfs_inode;
1415}
1416
Hideo Aoki3ab224b2007-12-31 00:11:19 -08001417/*
1418 * Functions for memory accounting
1419 */
Joe Perches69336bd2013-09-22 10:32:26 -07001420int __sk_mem_schedule(struct sock *sk, int size, int kind);
1421void __sk_mem_reclaim(struct sock *sk);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001422
Hideo Aoki3ab224b2007-12-31 00:11:19 -08001423#define SK_MEM_QUANTUM ((int)PAGE_SIZE)
1424#define SK_MEM_QUANTUM_SHIFT ilog2(SK_MEM_QUANTUM)
1425#define SK_MEM_SEND 0
1426#define SK_MEM_RECV 1
Linus Torvalds1da177e2005-04-16 15:20:36 -07001427
Hideo Aoki3ab224b2007-12-31 00:11:19 -08001428static inline int sk_mem_pages(int amt)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001429{
Hideo Aoki3ab224b2007-12-31 00:11:19 -08001430 return (amt + SK_MEM_QUANTUM - 1) >> SK_MEM_QUANTUM_SHIFT;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001431}
1432
Eric Dumazetdc6b9b72012-05-16 22:48:15 +00001433static inline bool sk_has_account(struct sock *sk)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001434{
Hideo Aoki3ab224b2007-12-31 00:11:19 -08001435 /* return true if protocol supports memory accounting */
1436 return !!sk->sk_prot->memory_allocated;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001437}
1438
Eric Dumazetdc6b9b72012-05-16 22:48:15 +00001439static inline bool sk_wmem_schedule(struct sock *sk, int size)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001440{
Hideo Aoki3ab224b2007-12-31 00:11:19 -08001441 if (!sk_has_account(sk))
Eric Dumazetdc6b9b72012-05-16 22:48:15 +00001442 return true;
Herbert Xud80d99d2005-09-01 17:48:23 -07001443 return size <= sk->sk_forward_alloc ||
Hideo Aoki3ab224b2007-12-31 00:11:19 -08001444 __sk_mem_schedule(sk, size, SK_MEM_SEND);
1445}
1446
Mel Gormanc76562b2012-07-31 16:44:41 -07001447static inline bool
Chuck Lever35c448a2012-09-17 14:09:11 -07001448sk_rmem_schedule(struct sock *sk, struct sk_buff *skb, int size)
Hideo Aoki3ab224b2007-12-31 00:11:19 -08001449{
1450 if (!sk_has_account(sk))
Eric Dumazetdc6b9b72012-05-16 22:48:15 +00001451 return true;
Mel Gormanc76562b2012-07-31 16:44:41 -07001452 return size<= sk->sk_forward_alloc ||
1453 __sk_mem_schedule(sk, size, SK_MEM_RECV) ||
1454 skb_pfmemalloc(skb);
Hideo Aoki3ab224b2007-12-31 00:11:19 -08001455}
1456
1457static inline void sk_mem_reclaim(struct sock *sk)
1458{
1459 if (!sk_has_account(sk))
1460 return;
1461 if (sk->sk_forward_alloc >= SK_MEM_QUANTUM)
1462 __sk_mem_reclaim(sk);
1463}
1464
David S. Miller9993e7d2008-01-10 21:56:38 -08001465static inline void sk_mem_reclaim_partial(struct sock *sk)
1466{
1467 if (!sk_has_account(sk))
1468 return;
1469 if (sk->sk_forward_alloc > SK_MEM_QUANTUM)
1470 __sk_mem_reclaim(sk);
1471}
1472
Hideo Aoki3ab224b2007-12-31 00:11:19 -08001473static inline void sk_mem_charge(struct sock *sk, int size)
1474{
1475 if (!sk_has_account(sk))
1476 return;
1477 sk->sk_forward_alloc -= size;
1478}
1479
1480static inline void sk_mem_uncharge(struct sock *sk, int size)
1481{
1482 if (!sk_has_account(sk))
1483 return;
1484 sk->sk_forward_alloc += size;
1485}
1486
1487static inline void sk_wmem_free_skb(struct sock *sk, struct sk_buff *skb)
1488{
Hideo Aoki3ab224b2007-12-31 00:11:19 -08001489 sock_set_flag(sk, SOCK_QUEUE_SHRUNK);
1490 sk->sk_wmem_queued -= skb->truesize;
1491 sk_mem_uncharge(sk, skb->truesize);
1492 __kfree_skb(skb);
Herbert Xud80d99d2005-09-01 17:48:23 -07001493}
1494
Linus Torvalds1da177e2005-04-16 15:20:36 -07001495/* Used by processes to "lock" a socket state, so that
1496 * interrupts and bottom half handlers won't change it
1497 * from under us. It essentially blocks any incoming
1498 * packets, so that we won't get any new data or any
1499 * packets that change the state of the socket.
1500 *
1501 * While locked, BH processing will add new packets to
1502 * the backlog queue. This queue is processed by the
1503 * owner of the socket lock right before it is released.
1504 *
1505 * Since ~2.3.5 it is also exclusive sleep lock serializing
1506 * accesses from user process context.
1507 */
John Heffnerd2e91172007-09-12 10:44:19 +02001508#define sock_owned_by_user(sk) ((sk)->sk_lock.owned)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001509
Eric Dumazetc3f9b012014-03-10 09:50:11 -07001510static inline void sock_release_ownership(struct sock *sk)
1511{
1512 sk->sk_lock.owned = 0;
1513}
1514
Peter Zijlstraed075362006-12-06 20:35:24 -08001515/*
1516 * Macro so as to not evaluate some arguments when
1517 * lockdep is not enabled.
1518 *
1519 * Mark both the sk_lock and the sk_lock.slock as a
1520 * per-address-family lock class.
1521 */
Eric Dumazetdc6b9b72012-05-16 22:48:15 +00001522#define sock_lock_init_class_and_name(sk, sname, skey, name, key) \
Peter Zijlstraed075362006-12-06 20:35:24 -08001523do { \
Ingo Molnare8f6fbf2008-11-12 01:38:36 +00001524 sk->sk_lock.owned = 0; \
Peter Zijlstraed075362006-12-06 20:35:24 -08001525 init_waitqueue_head(&sk->sk_lock.wq); \
1526 spin_lock_init(&(sk)->sk_lock.slock); \
1527 debug_check_no_locks_freed((void *)&(sk)->sk_lock, \
1528 sizeof((sk)->sk_lock)); \
1529 lockdep_set_class_and_name(&(sk)->sk_lock.slock, \
Eric Dumazetdc6b9b72012-05-16 22:48:15 +00001530 (skey), (sname)); \
Peter Zijlstraed075362006-12-06 20:35:24 -08001531 lockdep_init_map(&(sk)->sk_lock.dep_map, (name), (key), 0); \
1532} while (0)
1533
Joe Perches69336bd2013-09-22 10:32:26 -07001534void lock_sock_nested(struct sock *sk, int subclass);
Peter Zijlstrafcc70d52006-11-08 22:44:35 -08001535
1536static inline void lock_sock(struct sock *sk)
1537{
1538 lock_sock_nested(sk, 0);
1539}
1540
Joe Perches69336bd2013-09-22 10:32:26 -07001541void release_sock(struct sock *sk);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001542
1543/* BH context may only use the following locking interface. */
1544#define bh_lock_sock(__sk) spin_lock(&((__sk)->sk_lock.slock))
Ingo Molnarc6366182006-07-03 00:25:13 -07001545#define bh_lock_sock_nested(__sk) \
1546 spin_lock_nested(&((__sk)->sk_lock.slock), \
1547 SINGLE_DEPTH_NESTING)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001548#define bh_unlock_sock(__sk) spin_unlock(&((__sk)->sk_lock.slock))
1549
Joe Perches69336bd2013-09-22 10:32:26 -07001550bool lock_sock_fast(struct sock *sk);
Eric Dumazet8a74ad62010-05-26 19:20:18 +00001551/**
1552 * unlock_sock_fast - complement of lock_sock_fast
1553 * @sk: socket
1554 * @slow: slow mode
1555 *
1556 * fast unlock socket for user context.
1557 * If slow mode is on, we call regular release_sock()
1558 */
1559static inline void unlock_sock_fast(struct sock *sk, bool slow)
Eric Dumazet4b0b72f2010-04-28 14:35:48 -07001560{
Eric Dumazet8a74ad62010-05-26 19:20:18 +00001561 if (slow)
1562 release_sock(sk);
1563 else
1564 spin_unlock_bh(&sk->sk_lock.slock);
Eric Dumazet4b0b72f2010-04-28 14:35:48 -07001565}
1566
Eric Dumazet4b0b72f2010-04-28 14:35:48 -07001567
Joe Perches69336bd2013-09-22 10:32:26 -07001568struct sock *sk_alloc(struct net *net, int family, gfp_t priority,
1569 struct proto *prot);
1570void sk_free(struct sock *sk);
1571void sk_release_kernel(struct sock *sk);
1572struct sock *sk_clone_lock(const struct sock *sk, const gfp_t priority);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001573
Joe Perches69336bd2013-09-22 10:32:26 -07001574struct sk_buff *sock_wmalloc(struct sock *sk, unsigned long size, int force,
1575 gfp_t priority);
Joe Perches69336bd2013-09-22 10:32:26 -07001576void sock_wfree(struct sk_buff *skb);
1577void skb_orphan_partial(struct sk_buff *skb);
1578void sock_rfree(struct sk_buff *skb);
1579void sock_edemux(struct sk_buff *skb);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001580
Joe Perches69336bd2013-09-22 10:32:26 -07001581int sock_setsockopt(struct socket *sock, int level, int op,
1582 char __user *optval, unsigned int optlen);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001583
Joe Perches69336bd2013-09-22 10:32:26 -07001584int sock_getsockopt(struct socket *sock, int level, int op,
1585 char __user *optval, int __user *optlen);
1586struct sk_buff *sock_alloc_send_skb(struct sock *sk, unsigned long size,
1587 int noblock, int *errcode);
1588struct sk_buff *sock_alloc_send_pskb(struct sock *sk, unsigned long header_len,
1589 unsigned long data_len, int noblock,
1590 int *errcode, int max_page_order);
1591void *sock_kmalloc(struct sock *sk, int size, gfp_t priority);
1592void sock_kfree_s(struct sock *sk, void *mem, int size);
1593void sk_send_sigurg(struct sock *sk);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001594
1595/*
1596 * Functions to fill in entries in struct proto_ops when a protocol
1597 * does not implement a particular function.
1598 */
Joe Perches69336bd2013-09-22 10:32:26 -07001599int sock_no_bind(struct socket *, struct sockaddr *, int);
1600int sock_no_connect(struct socket *, struct sockaddr *, int, int);
1601int sock_no_socketpair(struct socket *, struct socket *);
1602int sock_no_accept(struct socket *, struct socket *, int);
1603int sock_no_getname(struct socket *, struct sockaddr *, int *, int);
1604unsigned int sock_no_poll(struct file *, struct socket *,
1605 struct poll_table_struct *);
1606int sock_no_ioctl(struct socket *, unsigned int, unsigned long);
1607int sock_no_listen(struct socket *, int);
1608int sock_no_shutdown(struct socket *, int);
1609int sock_no_getsockopt(struct socket *, int , int, char __user *, int __user *);
1610int sock_no_setsockopt(struct socket *, int, int, char __user *, unsigned int);
1611int sock_no_sendmsg(struct kiocb *, struct socket *, struct msghdr *, size_t);
1612int sock_no_recvmsg(struct kiocb *, struct socket *, struct msghdr *, size_t,
1613 int);
1614int sock_no_mmap(struct file *file, struct socket *sock,
1615 struct vm_area_struct *vma);
1616ssize_t sock_no_sendpage(struct socket *sock, struct page *page, int offset,
1617 size_t size, int flags);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001618
1619/*
1620 * Functions to fill in entries in struct proto_ops when a protocol
1621 * uses the inet style.
1622 */
Joe Perches69336bd2013-09-22 10:32:26 -07001623int sock_common_getsockopt(struct socket *sock, int level, int optname,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001624 char __user *optval, int __user *optlen);
Joe Perches69336bd2013-09-22 10:32:26 -07001625int sock_common_recvmsg(struct kiocb *iocb, struct socket *sock,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001626 struct msghdr *msg, size_t size, int flags);
Joe Perches69336bd2013-09-22 10:32:26 -07001627int sock_common_setsockopt(struct socket *sock, int level, int optname,
David S. Millerb7058842009-09-30 16:12:20 -07001628 char __user *optval, unsigned int optlen);
Joe Perches69336bd2013-09-22 10:32:26 -07001629int compat_sock_common_getsockopt(struct socket *sock, int level,
Dmitry Mishin3fdadf72006-03-20 22:45:21 -08001630 int optname, char __user *optval, int __user *optlen);
Joe Perches69336bd2013-09-22 10:32:26 -07001631int compat_sock_common_setsockopt(struct socket *sock, int level,
David S. Millerb7058842009-09-30 16:12:20 -07001632 int optname, char __user *optval, unsigned int optlen);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001633
Joe Perches69336bd2013-09-22 10:32:26 -07001634void sk_common_release(struct sock *sk);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001635
1636/*
1637 * Default socket callbacks and setup code
1638 */
Eric Dumazetdc6b9b72012-05-16 22:48:15 +00001639
Linus Torvalds1da177e2005-04-16 15:20:36 -07001640/* Initialise core socket variables */
Joe Perches69336bd2013-09-22 10:32:26 -07001641void sock_init_data(struct socket *sock, struct sock *sk);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001642
Linus Torvalds1da177e2005-04-16 15:20:36 -07001643/*
1644 * Socket reference counting postulates.
1645 *
1646 * * Each user of socket SHOULD hold a reference count.
1647 * * Each access point to socket (an hash table bucket, reference from a list,
1648 * running timer, skb in flight MUST hold a reference count.
1649 * * When reference count hits 0, it means it will never increase back.
1650 * * When reference count hits 0, it means that no references from
1651 * outside exist to this socket and current process on current CPU
1652 * is last user and may/should destroy this socket.
1653 * * sk_free is called from any context: process, BH, IRQ. When
1654 * it is called, socket has no references from outside -> sk_free
1655 * may release descendant resources allocated by the socket, but
1656 * to the time when it is called, socket is NOT referenced by any
1657 * hash tables, lists etc.
1658 * * Packets, delivered from outside (from network or from another process)
1659 * and enqueued on receive/error queues SHOULD NOT grab reference count,
1660 * when they sit in queue. Otherwise, packets will leak to hole, when
1661 * socket is looked up by one cpu and unhasing is made by another CPU.
1662 * It is true for udp/raw, netlink (leak to receive and error queues), tcp
1663 * (leak to backlog). Packet socket does all the processing inside
1664 * BR_NETPROTO_LOCK, so that it has not this race condition. UNIX sockets
1665 * use separate SMP lock, so that they are prone too.
1666 */
1667
1668/* Ungrab socket and destroy it, if it was the last reference. */
1669static inline void sock_put(struct sock *sk)
1670{
1671 if (atomic_dec_and_test(&sk->sk_refcnt))
1672 sk_free(sk);
1673}
Eric Dumazet05dbc7b2013-10-03 00:22:02 -07001674/* Generic version of sock_put(), dealing with all sockets
1675 * (TCP_TIMEWAIT, ESTABLISHED...)
1676 */
1677void sock_gen_put(struct sock *sk);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001678
Joe Perches69336bd2013-09-22 10:32:26 -07001679int sk_receive_skb(struct sock *sk, struct sk_buff *skb, const int nested);
Arnaldo Carvalho de Melo25995ff2005-12-27 02:42:22 -02001680
Krishna Kumare022f0b2009-10-19 23:46:20 +00001681static inline void sk_tx_queue_set(struct sock *sk, int tx_queue)
1682{
1683 sk->sk_tx_queue_mapping = tx_queue;
1684}
1685
1686static inline void sk_tx_queue_clear(struct sock *sk)
1687{
1688 sk->sk_tx_queue_mapping = -1;
1689}
1690
1691static inline int sk_tx_queue_get(const struct sock *sk)
1692{
Tom Herbertb0f77d02010-07-14 20:50:29 -07001693 return sk ? sk->sk_tx_queue_mapping : -1;
Krishna Kumare022f0b2009-10-19 23:46:20 +00001694}
1695
David S. Miller972692e2008-06-17 22:41:38 -07001696static inline void sk_set_socket(struct sock *sk, struct socket *sock)
1697{
Krishna Kumare022f0b2009-10-19 23:46:20 +00001698 sk_tx_queue_clear(sk);
David S. Miller972692e2008-06-17 22:41:38 -07001699 sk->sk_socket = sock;
1700}
1701
Eric Dumazetaa395142010-04-20 13:03:51 +00001702static inline wait_queue_head_t *sk_sleep(struct sock *sk)
1703{
Eric Dumazeteaefd112011-02-18 03:26:36 +00001704 BUILD_BUG_ON(offsetof(struct socket_wq, wait) != 0);
1705 return &rcu_dereference_raw(sk->sk_wq)->wait;
Eric Dumazetaa395142010-04-20 13:03:51 +00001706}
Linus Torvalds1da177e2005-04-16 15:20:36 -07001707/* Detach socket from process context.
1708 * Announce socket dead, detach it from wait queue and inode.
1709 * Note that parent inode held reference count on this struct sock,
1710 * we do not release it in this function, because protocol
1711 * probably wants some additional cleanups or even continuing
1712 * to work with this socket (TCP).
1713 */
1714static inline void sock_orphan(struct sock *sk)
1715{
1716 write_lock_bh(&sk->sk_callback_lock);
1717 sock_set_flag(sk, SOCK_DEAD);
David S. Miller972692e2008-06-17 22:41:38 -07001718 sk_set_socket(sk, NULL);
Eric Dumazet43815482010-04-29 11:01:49 +00001719 sk->sk_wq = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001720 write_unlock_bh(&sk->sk_callback_lock);
1721}
1722
1723static inline void sock_graft(struct sock *sk, struct socket *parent)
1724{
1725 write_lock_bh(&sk->sk_callback_lock);
Eric Dumazeteaefd112011-02-18 03:26:36 +00001726 sk->sk_wq = parent->wq;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001727 parent->sk = sk;
David S. Miller972692e2008-06-17 22:41:38 -07001728 sk_set_socket(sk, parent);
Venkat Yekkirala4237c752006-07-24 23:32:50 -07001729 security_sock_graft(sk, parent);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001730 write_unlock_bh(&sk->sk_callback_lock);
1731}
1732
Joe Perches69336bd2013-09-22 10:32:26 -07001733kuid_t sock_i_uid(struct sock *sk);
1734unsigned long sock_i_ino(struct sock *sk);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001735
1736static inline struct dst_entry *
1737__sk_dst_get(struct sock *sk)
1738{
Michal Hockod8bf4ca2011-07-08 14:39:41 +02001739 return rcu_dereference_check(sk->sk_dst_cache, sock_owned_by_user(sk) ||
Eric Dumazetf68c2242010-04-22 16:06:59 -07001740 lockdep_is_held(&sk->sk_lock.slock));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001741}
1742
1743static inline struct dst_entry *
1744sk_dst_get(struct sock *sk)
1745{
1746 struct dst_entry *dst;
1747
Eric Dumazetb6c67122010-04-08 23:03:29 +00001748 rcu_read_lock();
1749 dst = rcu_dereference(sk->sk_dst_cache);
Eric Dumazetf8864972014-06-24 10:05:11 -07001750 if (dst && !atomic_inc_not_zero(&dst->__refcnt))
1751 dst = NULL;
Eric Dumazetb6c67122010-04-08 23:03:29 +00001752 rcu_read_unlock();
Linus Torvalds1da177e2005-04-16 15:20:36 -07001753 return dst;
1754}
1755
Eric Dumazetb6c67122010-04-08 23:03:29 +00001756static inline void dst_negative_advice(struct sock *sk)
1757{
1758 struct dst_entry *ndst, *dst = __sk_dst_get(sk);
1759
1760 if (dst && dst->ops->negative_advice) {
1761 ndst = dst->ops->negative_advice(dst);
1762
1763 if (ndst != dst) {
1764 rcu_assign_pointer(sk->sk_dst_cache, ndst);
ZHAO Gang0a6957e2013-10-22 16:23:38 +08001765 sk_tx_queue_clear(sk);
Eric Dumazetb6c67122010-04-08 23:03:29 +00001766 }
1767 }
1768}
1769
Linus Torvalds1da177e2005-04-16 15:20:36 -07001770static inline void
1771__sk_dst_set(struct sock *sk, struct dst_entry *dst)
1772{
1773 struct dst_entry *old_dst;
1774
Krishna Kumare022f0b2009-10-19 23:46:20 +00001775 sk_tx_queue_clear(sk);
Eric Dumazet0b53ff22010-04-26 20:40:43 +00001776 /*
1777 * This can be called while sk is owned by the caller only,
1778 * with no state that can be checked in a rcu_dereference_check() cond
1779 */
1780 old_dst = rcu_dereference_raw(sk->sk_dst_cache);
Eric Dumazetb6c67122010-04-08 23:03:29 +00001781 rcu_assign_pointer(sk->sk_dst_cache, dst);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001782 dst_release(old_dst);
1783}
1784
1785static inline void
1786sk_dst_set(struct sock *sk, struct dst_entry *dst)
1787{
Eric Dumazet7f502362014-06-30 01:26:23 -07001788 struct dst_entry *old_dst;
1789
1790 sk_tx_queue_clear(sk);
Eric Dumazet5925a052014-07-02 02:39:38 -07001791 old_dst = xchg((__force struct dst_entry **)&sk->sk_dst_cache, dst);
Eric Dumazet7f502362014-06-30 01:26:23 -07001792 dst_release(old_dst);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001793}
1794
1795static inline void
1796__sk_dst_reset(struct sock *sk)
1797{
Eric Dumazetb6c67122010-04-08 23:03:29 +00001798 __sk_dst_set(sk, NULL);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001799}
1800
1801static inline void
1802sk_dst_reset(struct sock *sk)
1803{
Eric Dumazet7f502362014-06-30 01:26:23 -07001804 sk_dst_set(sk, NULL);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001805}
1806
Joe Perches69336bd2013-09-22 10:32:26 -07001807struct dst_entry *__sk_dst_check(struct sock *sk, u32 cookie);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001808
Joe Perches69336bd2013-09-22 10:32:26 -07001809struct dst_entry *sk_dst_check(struct sock *sk, u32 cookie);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001810
Eric Dumazetdc6b9b72012-05-16 22:48:15 +00001811static inline bool sk_can_gso(const struct sock *sk)
Herbert Xubcd76112006-06-30 13:36:35 -07001812{
1813 return net_gso_ok(sk->sk_route_caps, sk->sk_gso_type);
1814}
1815
Joe Perches69336bd2013-09-22 10:32:26 -07001816void sk_setup_caps(struct sock *sk, struct dst_entry *dst);
Arnaldo Carvalho de Melo6cbb0df2005-08-09 19:49:02 -07001817
Michał Mirosławc8f44af2011-11-15 15:29:55 +00001818static inline void sk_nocaps_add(struct sock *sk, netdev_features_t flags)
Eric Dumazeta4654192010-05-16 00:36:33 -07001819{
1820 sk->sk_route_nocaps |= flags;
1821 sk->sk_route_caps &= ~flags;
1822}
1823
Tom Herbertc6e1a0d2011-04-04 22:30:30 -07001824static inline int skb_do_copy_data_nocache(struct sock *sk, struct sk_buff *skb,
1825 char __user *from, char *to,
Wei Yongjun912d3982011-04-06 18:40:12 +00001826 int copy, int offset)
Tom Herbertc6e1a0d2011-04-04 22:30:30 -07001827{
1828 if (skb->ip_summed == CHECKSUM_NONE) {
1829 int err = 0;
1830 __wsum csum = csum_and_copy_from_user(from, to, copy, 0, &err);
1831 if (err)
1832 return err;
Wei Yongjun912d3982011-04-06 18:40:12 +00001833 skb->csum = csum_block_add(skb->csum, csum, offset);
Tom Herbertc6e1a0d2011-04-04 22:30:30 -07001834 } else if (sk->sk_route_caps & NETIF_F_NOCACHE_COPY) {
1835 if (!access_ok(VERIFY_READ, from, copy) ||
1836 __copy_from_user_nocache(to, from, copy))
1837 return -EFAULT;
1838 } else if (copy_from_user(to, from, copy))
1839 return -EFAULT;
1840
1841 return 0;
1842}
1843
1844static inline int skb_add_data_nocache(struct sock *sk, struct sk_buff *skb,
1845 char __user *from, int copy)
1846{
Wei Yongjun912d3982011-04-06 18:40:12 +00001847 int err, offset = skb->len;
Tom Herbertc6e1a0d2011-04-04 22:30:30 -07001848
Wei Yongjun912d3982011-04-06 18:40:12 +00001849 err = skb_do_copy_data_nocache(sk, skb, from, skb_put(skb, copy),
1850 copy, offset);
Tom Herbertc6e1a0d2011-04-04 22:30:30 -07001851 if (err)
Wei Yongjun912d3982011-04-06 18:40:12 +00001852 __skb_trim(skb, offset);
Tom Herbertc6e1a0d2011-04-04 22:30:30 -07001853
1854 return err;
1855}
1856
1857static inline int skb_copy_to_page_nocache(struct sock *sk, char __user *from,
1858 struct sk_buff *skb,
1859 struct page *page,
1860 int off, int copy)
1861{
1862 int err;
1863
Wei Yongjun912d3982011-04-06 18:40:12 +00001864 err = skb_do_copy_data_nocache(sk, skb, from, page_address(page) + off,
1865 copy, skb->len);
Tom Herbertc6e1a0d2011-04-04 22:30:30 -07001866 if (err)
1867 return err;
1868
1869 skb->len += copy;
1870 skb->data_len += copy;
1871 skb->truesize += copy;
1872 sk->sk_wmem_queued += copy;
1873 sk_mem_charge(sk, copy);
1874 return 0;
1875}
1876
Linus Torvalds1da177e2005-04-16 15:20:36 -07001877static inline int skb_copy_to_page(struct sock *sk, char __user *from,
1878 struct sk_buff *skb, struct page *page,
1879 int off, int copy)
1880{
1881 if (skb->ip_summed == CHECKSUM_NONE) {
1882 int err = 0;
Al Viro50842052006-11-14 21:36:34 -08001883 __wsum csum = csum_and_copy_from_user(from,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001884 page_address(page) + off,
1885 copy, 0, &err);
1886 if (err)
1887 return err;
1888 skb->csum = csum_block_add(skb->csum, csum, skb->len);
1889 } else if (copy_from_user(page_address(page) + off, from, copy))
1890 return -EFAULT;
1891
1892 skb->len += copy;
1893 skb->data_len += copy;
1894 skb->truesize += copy;
1895 sk->sk_wmem_queued += copy;
Hideo Aoki3ab224b2007-12-31 00:11:19 -08001896 sk_mem_charge(sk, copy);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001897 return 0;
1898}
1899
Eric Dumazetc5640392009-06-16 10:12:03 +00001900/**
1901 * sk_wmem_alloc_get - returns write allocations
1902 * @sk: socket
1903 *
1904 * Returns sk_wmem_alloc minus initial offset of one
1905 */
1906static inline int sk_wmem_alloc_get(const struct sock *sk)
1907{
1908 return atomic_read(&sk->sk_wmem_alloc) - 1;
1909}
1910
1911/**
1912 * sk_rmem_alloc_get - returns read allocations
1913 * @sk: socket
1914 *
1915 * Returns sk_rmem_alloc
1916 */
1917static inline int sk_rmem_alloc_get(const struct sock *sk)
1918{
1919 return atomic_read(&sk->sk_rmem_alloc);
1920}
1921
1922/**
1923 * sk_has_allocations - check if allocations are outstanding
1924 * @sk: socket
1925 *
1926 * Returns true if socket has write or read allocations
1927 */
Eric Dumazetdc6b9b72012-05-16 22:48:15 +00001928static inline bool sk_has_allocations(const struct sock *sk)
Eric Dumazetc5640392009-06-16 10:12:03 +00001929{
1930 return sk_wmem_alloc_get(sk) || sk_rmem_alloc_get(sk);
1931}
1932
Jiri Olsaa57de0b2009-07-08 12:09:13 +00001933/**
Eric Dumazet43815482010-04-29 11:01:49 +00001934 * wq_has_sleeper - check if there are any waiting processes
Randy Dunlapacfbe962010-05-24 23:54:18 -07001935 * @wq: struct socket_wq
Jiri Olsaa57de0b2009-07-08 12:09:13 +00001936 *
Eric Dumazet43815482010-04-29 11:01:49 +00001937 * Returns true if socket_wq has waiting processes
Jiri Olsaa57de0b2009-07-08 12:09:13 +00001938 *
Eric Dumazet43815482010-04-29 11:01:49 +00001939 * The purpose of the wq_has_sleeper and sock_poll_wait is to wrap the memory
Jiri Olsaa57de0b2009-07-08 12:09:13 +00001940 * barrier call. They were added due to the race found within the tcp code.
1941 *
1942 * Consider following tcp code paths:
1943 *
1944 * CPU1 CPU2
1945 *
1946 * sys_select receive packet
1947 * ... ...
1948 * __add_wait_queue update tp->rcv_nxt
1949 * ... ...
1950 * tp->rcv_nxt check sock_def_readable
1951 * ... {
Eric Dumazet43815482010-04-29 11:01:49 +00001952 * schedule rcu_read_lock();
1953 * wq = rcu_dereference(sk->sk_wq);
1954 * if (wq && waitqueue_active(&wq->wait))
1955 * wake_up_interruptible(&wq->wait)
Jiri Olsaa57de0b2009-07-08 12:09:13 +00001956 * ...
1957 * }
1958 *
1959 * The race for tcp fires when the __add_wait_queue changes done by CPU1 stay
1960 * in its cache, and so does the tp->rcv_nxt update on CPU2 side. The CPU1
1961 * could then endup calling schedule and sleep forever if there are no more
1962 * data on the socket.
Jiri Olsaad462762009-07-08 12:10:31 +00001963 *
Jiri Olsaa57de0b2009-07-08 12:09:13 +00001964 */
Eric Dumazet43815482010-04-29 11:01:49 +00001965static inline bool wq_has_sleeper(struct socket_wq *wq)
Jiri Olsaa57de0b2009-07-08 12:09:13 +00001966{
Eric Dumazetdc6b9b72012-05-16 22:48:15 +00001967 /* We need to be sure we are in sync with the
Jiri Olsaa57de0b2009-07-08 12:09:13 +00001968 * add_wait_queue modifications to the wait queue.
1969 *
1970 * This memory barrier is paired in the sock_poll_wait.
1971 */
Eric Dumazet43815482010-04-29 11:01:49 +00001972 smp_mb();
1973 return wq && waitqueue_active(&wq->wait);
Jiri Olsaa57de0b2009-07-08 12:09:13 +00001974}
1975
1976/**
1977 * sock_poll_wait - place memory barrier behind the poll_wait call.
1978 * @filp: file
1979 * @wait_address: socket wait queue
1980 * @p: poll_table
1981 *
Eric Dumazet43815482010-04-29 11:01:49 +00001982 * See the comments in the wq_has_sleeper function.
Jiri Olsaa57de0b2009-07-08 12:09:13 +00001983 */
1984static inline void sock_poll_wait(struct file *filp,
1985 wait_queue_head_t *wait_address, poll_table *p)
1986{
Hans Verkuil626cf232012-03-23 15:02:27 -07001987 if (!poll_does_not_wait(p) && wait_address) {
Jiri Olsaa57de0b2009-07-08 12:09:13 +00001988 poll_wait(filp, wait_address, p);
Eric Dumazetdc6b9b72012-05-16 22:48:15 +00001989 /* We need to be sure we are in sync with the
Jiri Olsaa57de0b2009-07-08 12:09:13 +00001990 * socket flags modification.
1991 *
Eric Dumazet43815482010-04-29 11:01:49 +00001992 * This memory barrier is paired in the wq_has_sleeper.
Eric Dumazetdc6b9b72012-05-16 22:48:15 +00001993 */
Jiri Olsaa57de0b2009-07-08 12:09:13 +00001994 smp_mb();
1995 }
1996}
1997
Tom Herbertb73c3d02014-07-01 21:32:17 -07001998static inline void skb_set_hash_from_sk(struct sk_buff *skb, struct sock *sk)
1999{
2000 if (sk->sk_txhash) {
2001 skb->l4_hash = 1;
2002 skb->hash = sk->sk_txhash;
2003 }
2004}
2005
Linus Torvalds1da177e2005-04-16 15:20:36 -07002006/*
Eric Dumazetdc6b9b72012-05-16 22:48:15 +00002007 * Queue a received datagram if it will fit. Stream and sequenced
Linus Torvalds1da177e2005-04-16 15:20:36 -07002008 * protocols can't normally use this as they need to fit buffers in
2009 * and play with them.
2010 *
Eric Dumazetdc6b9b72012-05-16 22:48:15 +00002011 * Inlined as it's very short and called for pretty much every
Linus Torvalds1da177e2005-04-16 15:20:36 -07002012 * packet ever received.
2013 */
2014
2015static inline void skb_set_owner_w(struct sk_buff *skb, struct sock *sk)
2016{
Herbert Xud55d87f2009-06-22 02:25:25 +00002017 skb_orphan(skb);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002018 skb->sk = sk;
2019 skb->destructor = sock_wfree;
Tom Herbertb73c3d02014-07-01 21:32:17 -07002020 skb_set_hash_from_sk(skb, sk);
Eric Dumazet2b85a342009-06-11 02:55:43 -07002021 /*
2022 * We used to take a refcount on sk, but following operation
2023 * is enough to guarantee sk_free() wont free this sock until
2024 * all in-flight packets are completed
2025 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002026 atomic_add(skb->truesize, &sk->sk_wmem_alloc);
2027}
2028
2029static inline void skb_set_owner_r(struct sk_buff *skb, struct sock *sk)
2030{
Herbert Xud55d87f2009-06-22 02:25:25 +00002031 skb_orphan(skb);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002032 skb->sk = sk;
2033 skb->destructor = sock_rfree;
2034 atomic_add(skb->truesize, &sk->sk_rmem_alloc);
Hideo Aoki3ab224b2007-12-31 00:11:19 -08002035 sk_mem_charge(sk, skb->truesize);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002036}
2037
Joe Perches69336bd2013-09-22 10:32:26 -07002038void sk_reset_timer(struct sock *sk, struct timer_list *timer,
2039 unsigned long expires);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002040
Joe Perches69336bd2013-09-22 10:32:26 -07002041void sk_stop_timer(struct sock *sk, struct timer_list *timer);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002042
Joe Perches69336bd2013-09-22 10:32:26 -07002043int sock_queue_rcv_skb(struct sock *sk, struct sk_buff *skb);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002044
Joe Perches69336bd2013-09-22 10:32:26 -07002045int sock_queue_err_skb(struct sock *sk, struct sk_buff *skb);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002046
2047/*
2048 * Recover an error report and clear atomically
2049 */
Eric Dumazetdc6b9b72012-05-16 22:48:15 +00002050
Linus Torvalds1da177e2005-04-16 15:20:36 -07002051static inline int sock_error(struct sock *sk)
2052{
Benjamin LaHaisec1cbe4b2005-12-13 23:22:19 -08002053 int err;
2054 if (likely(!sk->sk_err))
2055 return 0;
2056 err = xchg(&sk->sk_err, 0);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002057 return -err;
2058}
2059
2060static inline unsigned long sock_wspace(struct sock *sk)
2061{
2062 int amt = 0;
2063
2064 if (!(sk->sk_shutdown & SEND_SHUTDOWN)) {
2065 amt = sk->sk_sndbuf - atomic_read(&sk->sk_wmem_alloc);
Eric Dumazetdc6b9b72012-05-16 22:48:15 +00002066 if (amt < 0)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002067 amt = 0;
2068 }
2069 return amt;
2070}
2071
2072static inline void sk_wake_async(struct sock *sk, int how, int band)
2073{
Eric Dumazetbcdce712009-10-06 17:28:29 -07002074 if (sock_flag(sk, SOCK_FASYNC))
Linus Torvalds1da177e2005-04-16 15:20:36 -07002075 sock_wake_async(sk->sk_socket, how, band);
2076}
2077
Daniel Borkmanneea86af2013-06-19 12:51:20 +02002078/* Since sk_{r,w}mem_alloc sums skb->truesize, even a small frame might
2079 * need sizeof(sk_buff) + MTU + padding, unless net driver perform copybreak.
2080 * Note: for send buffers, TCP works better if we can build two skbs at
2081 * minimum.
Eric Dumazet7a91b4342010-09-26 18:53:07 -07002082 */
Eric Dumazet9eb5bf82013-07-03 05:02:22 -07002083#define TCP_SKB_MIN_TRUESIZE (2048 + SKB_DATA_ALIGN(sizeof(struct sk_buff)))
Daniel Borkmanneea86af2013-06-19 12:51:20 +02002084
2085#define SOCK_MIN_SNDBUF (TCP_SKB_MIN_TRUESIZE * 2)
2086#define SOCK_MIN_RCVBUF TCP_SKB_MIN_TRUESIZE
Linus Torvalds1da177e2005-04-16 15:20:36 -07002087
2088static inline void sk_stream_moderate_sndbuf(struct sock *sk)
2089{
2090 if (!(sk->sk_userlocks & SOCK_SNDBUF_LOCK)) {
Eric Dumazet8df09ea2007-12-21 03:07:41 -08002091 sk->sk_sndbuf = min(sk->sk_sndbuf, sk->sk_wmem_queued >> 1);
Daniel Borkmanneea86af2013-06-19 12:51:20 +02002092 sk->sk_sndbuf = max_t(u32, sk->sk_sndbuf, SOCK_MIN_SNDBUF);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002093 }
2094}
2095
Pavel Emelyanovdf97c702007-11-29 21:22:33 +11002096struct sk_buff *sk_stream_alloc_skb(struct sock *sk, int size, gfp_t gfp);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002097
Eric Dumazet5640f762012-09-23 23:04:42 +00002098/**
2099 * sk_page_frag - return an appropriate page_frag
2100 * @sk: socket
2101 *
2102 * If socket allocation mode allows current thread to sleep, it means its
2103 * safe to use the per task page_frag instead of the per socket one.
2104 */
2105static inline struct page_frag *sk_page_frag(struct sock *sk)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002106{
Eric Dumazet5640f762012-09-23 23:04:42 +00002107 if (sk->sk_allocation & __GFP_WAIT)
2108 return &current->task_frag;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002109
Eric Dumazet5640f762012-09-23 23:04:42 +00002110 return &sk->sk_frag;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002111}
2112
Joe Perches69336bd2013-09-22 10:32:26 -07002113bool sk_page_frag_refill(struct sock *sk, struct page_frag *pfrag);
Eric Dumazet5640f762012-09-23 23:04:42 +00002114
Linus Torvalds1da177e2005-04-16 15:20:36 -07002115/*
2116 * Default write policy as shown to user space via poll/select/SIGIO
2117 */
Eric Dumazetdc6b9b72012-05-16 22:48:15 +00002118static inline bool sock_writeable(const struct sock *sk)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002119{
Eric Dumazet8df09ea2007-12-21 03:07:41 -08002120 return atomic_read(&sk->sk_wmem_alloc) < (sk->sk_sndbuf >> 1);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002121}
2122
Al Virodd0fc662005-10-07 07:46:04 +01002123static inline gfp_t gfp_any(void)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002124{
Andrew Morton99709372009-02-12 16:43:17 -08002125 return in_softirq() ? GFP_ATOMIC : GFP_KERNEL;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002126}
2127
Eric Dumazetdc6b9b72012-05-16 22:48:15 +00002128static inline long sock_rcvtimeo(const struct sock *sk, bool noblock)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002129{
2130 return noblock ? 0 : sk->sk_rcvtimeo;
2131}
2132
Eric Dumazetdc6b9b72012-05-16 22:48:15 +00002133static inline long sock_sndtimeo(const struct sock *sk, bool noblock)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002134{
2135 return noblock ? 0 : sk->sk_sndtimeo;
2136}
2137
2138static inline int sock_rcvlowat(const struct sock *sk, int waitall, int len)
2139{
2140 return (waitall ? len : min_t(int, sk->sk_rcvlowat, len)) ? : 1;
2141}
2142
2143/* Alas, with timeout socket operations are not restartable.
2144 * Compare this to poll().
2145 */
2146static inline int sock_intr_errno(long timeo)
2147{
2148 return timeo == MAX_SCHEDULE_TIMEOUT ? -ERESTARTSYS : -EINTR;
2149}
2150
Joe Perches69336bd2013-09-22 10:32:26 -07002151void __sock_recv_timestamp(struct msghdr *msg, struct sock *sk,
2152 struct sk_buff *skb);
2153void __sock_recv_wifi_status(struct msghdr *msg, struct sock *sk,
2154 struct sk_buff *skb);
Eric Dumazet92f37fd2007-03-25 22:14:49 -07002155
Eric Dumazetdc6b9b72012-05-16 22:48:15 +00002156static inline void
Linus Torvalds1da177e2005-04-16 15:20:36 -07002157sock_recv_timestamp(struct msghdr *msg, struct sock *sk, struct sk_buff *skb)
2158{
Eric Dumazetb7aa0bf2007-04-19 16:16:32 -07002159 ktime_t kt = skb->tstamp;
Patrick Ohly20d49472009-02-12 05:03:38 +00002160 struct skb_shared_hwtstamps *hwtstamps = skb_hwtstamps(skb);
Patrick McHardya61bbcf2005-08-14 17:24:31 -07002161
Patrick Ohly20d49472009-02-12 05:03:38 +00002162 /*
2163 * generate control messages if
2164 * - receive time stamping in software requested (SOCK_RCVTSTAMP
2165 * or SOCK_TIMESTAMPING_RX_SOFTWARE)
2166 * - software time stamp available and wanted
2167 * (SOCK_TIMESTAMPING_SOFTWARE)
2168 * - hardware time stamps available and wanted
2169 * (SOCK_TIMESTAMPING_SYS_HARDWARE or
2170 * SOCK_TIMESTAMPING_RAW_HARDWARE)
2171 */
2172 if (sock_flag(sk, SOCK_RCVTSTAMP) ||
2173 sock_flag(sk, SOCK_TIMESTAMPING_RX_SOFTWARE) ||
2174 (kt.tv64 && sock_flag(sk, SOCK_TIMESTAMPING_SOFTWARE)) ||
2175 (hwtstamps->hwtstamp.tv64 &&
2176 sock_flag(sk, SOCK_TIMESTAMPING_RAW_HARDWARE)) ||
2177 (hwtstamps->syststamp.tv64 &&
2178 sock_flag(sk, SOCK_TIMESTAMPING_SYS_HARDWARE)))
Eric Dumazet92f37fd2007-03-25 22:14:49 -07002179 __sock_recv_timestamp(msg, sk, skb);
2180 else
Eric Dumazetb7aa0bf2007-04-19 16:16:32 -07002181 sk->sk_stamp = kt;
Johannes Berg6e3e9392011-11-09 10:15:42 +01002182
2183 if (sock_flag(sk, SOCK_WIFI_STATUS) && skb->wifi_acked_valid)
2184 __sock_recv_wifi_status(msg, sk, skb);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002185}
2186
Joe Perches69336bd2013-09-22 10:32:26 -07002187void __sock_recv_ts_and_drops(struct msghdr *msg, struct sock *sk,
2188 struct sk_buff *skb);
Eric Dumazet767dd032010-04-28 19:14:43 +00002189
2190static inline void sock_recv_ts_and_drops(struct msghdr *msg, struct sock *sk,
2191 struct sk_buff *skb)
2192{
2193#define FLAGS_TS_OR_DROPS ((1UL << SOCK_RXQ_OVFL) | \
2194 (1UL << SOCK_RCVTSTAMP) | \
Eric Dumazet767dd032010-04-28 19:14:43 +00002195 (1UL << SOCK_TIMESTAMPING_SOFTWARE) | \
Eric Dumazetdc6b9b72012-05-16 22:48:15 +00002196 (1UL << SOCK_TIMESTAMPING_RAW_HARDWARE) | \
Eric Dumazet767dd032010-04-28 19:14:43 +00002197 (1UL << SOCK_TIMESTAMPING_SYS_HARDWARE))
2198
2199 if (sk->sk_flags & FLAGS_TS_OR_DROPS)
2200 __sock_recv_ts_and_drops(msg, sk, skb);
2201 else
2202 sk->sk_stamp = skb->tstamp;
2203}
Neil Horman3b885782009-10-12 13:26:31 -07002204
Linus Torvalds1da177e2005-04-16 15:20:36 -07002205/**
Patrick Ohly20d49472009-02-12 05:03:38 +00002206 * sock_tx_timestamp - checks whether the outgoing packet is to be time stamped
Patrick Ohly20d49472009-02-12 05:03:38 +00002207 * @sk: socket sending this packet
Oliver Hartkopp2244d072010-08-17 08:59:14 +00002208 * @tx_flags: filled with instructions for time stamping
Patrick Ohly20d49472009-02-12 05:03:38 +00002209 *
Daniel Borkmannbf84a012013-04-14 08:08:13 +00002210 * Currently only depends on SOCK_TIMESTAMPING* flags.
Patrick Ohly20d49472009-02-12 05:03:38 +00002211 */
Joe Perches69336bd2013-09-22 10:32:26 -07002212void sock_tx_timestamp(struct sock *sk, __u8 *tx_flags);
Patrick Ohly20d49472009-02-12 05:03:38 +00002213
2214/**
Linus Torvalds1da177e2005-04-16 15:20:36 -07002215 * sk_eat_skb - Release a skb if it is no longer needed
Pavel Pisa4dc3b162005-05-01 08:59:25 -07002216 * @sk: socket to eat this skb from
2217 * @skb: socket buffer to eat
Randy Dunlapf4b8ea72006-06-22 16:00:11 -07002218 * @copied_early: flag indicating whether DMA operations copied this data early
Linus Torvalds1da177e2005-04-16 15:20:36 -07002219 *
2220 * This routine must be called with interrupts disabled or with the socket
2221 * locked so that the sk_buff queue operation is ok.
2222*/
Chris Leech624d1162006-05-23 18:01:28 -07002223#ifdef CONFIG_NET_DMA
Eric Dumazetdc6b9b72012-05-16 22:48:15 +00002224static inline void sk_eat_skb(struct sock *sk, struct sk_buff *skb, bool copied_early)
Chris Leech624d1162006-05-23 18:01:28 -07002225{
2226 __skb_unlink(skb, &sk->sk_receive_queue);
2227 if (!copied_early)
2228 __kfree_skb(skb);
2229 else
2230 __skb_queue_tail(&sk->sk_async_wait_queue, skb);
2231}
2232#else
Eric Dumazetdc6b9b72012-05-16 22:48:15 +00002233static inline void sk_eat_skb(struct sock *sk, struct sk_buff *skb, bool copied_early)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002234{
2235 __skb_unlink(skb, &sk->sk_receive_queue);
2236 __kfree_skb(skb);
2237}
Chris Leech624d1162006-05-23 18:01:28 -07002238#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -07002239
YOSHIFUJI Hideaki3b1e0a62008-03-26 02:26:21 +09002240static inline
2241struct net *sock_net(const struct sock *sk)
2242{
Eric Dumazetc2d9ba92010-06-01 06:51:19 +00002243 return read_pnet(&sk->sk_net);
YOSHIFUJI Hideaki3b1e0a62008-03-26 02:26:21 +09002244}
2245
2246static inline
Denis V. Lunevf5aa23f2008-03-26 00:48:17 -07002247void sock_net_set(struct sock *sk, struct net *net)
YOSHIFUJI Hideaki3b1e0a62008-03-26 02:26:21 +09002248{
Eric Dumazetc2d9ba92010-06-01 06:51:19 +00002249 write_pnet(&sk->sk_net, net);
YOSHIFUJI Hideaki3b1e0a62008-03-26 02:26:21 +09002250}
2251
Denis V. Lunevedf02082008-02-29 11:18:32 -08002252/*
2253 * Kernel sockets, f.e. rtnl or icmp_socket, are a part of a namespace.
Lucas De Marchi25985ed2011-03-30 22:57:33 -03002254 * They should not hold a reference to a namespace in order to allow
Denis V. Lunevedf02082008-02-29 11:18:32 -08002255 * to stop it.
2256 * Sockets after sk_change_net should be released using sk_release_kernel
2257 */
2258static inline void sk_change_net(struct sock *sk, struct net *net)
2259{
Gu Zheng5812521b2014-03-10 09:57:34 +08002260 struct net *current_net = sock_net(sk);
2261
2262 if (!net_eq(current_net, net)) {
2263 put_net(current_net);
2264 sock_net_set(sk, hold_net(net));
2265 }
Denis V. Lunevedf02082008-02-29 11:18:32 -08002266}
2267
KOVACS Krisztian23542612008-10-07 12:41:01 -07002268static inline struct sock *skb_steal_sock(struct sk_buff *skb)
2269{
Vijay Subramanianefc27f82012-06-24 13:03:07 +00002270 if (skb->sk) {
KOVACS Krisztian23542612008-10-07 12:41:01 -07002271 struct sock *sk = skb->sk;
2272
2273 skb->destructor = NULL;
2274 skb->sk = NULL;
2275 return sk;
2276 }
2277 return NULL;
2278}
2279
Joe Perches69336bd2013-09-22 10:32:26 -07002280void sock_enable_timestamp(struct sock *sk, int flag);
2281int sock_get_timestamp(struct sock *, struct timeval __user *);
2282int sock_get_timestampns(struct sock *, struct timespec __user *);
2283int sock_recv_errqueue(struct sock *sk, struct msghdr *msg, int len, int level,
2284 int type);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002285
Eric W. Biedermana3b299d2014-04-23 14:26:56 -07002286bool sk_ns_capable(const struct sock *sk,
2287 struct user_namespace *user_ns, int cap);
2288bool sk_capable(const struct sock *sk, int cap);
2289bool sk_net_capable(const struct sock *sk, int cap);
2290
Eric Dumazetdc6b9b72012-05-16 22:48:15 +00002291/*
2292 * Enable debug/info messages
Linus Torvalds1da177e2005-04-16 15:20:36 -07002293 */
Stephen Hemmingera2a316f2007-03-08 20:41:08 -08002294extern int net_msg_warn;
2295#define NETDEBUG(fmt, args...) \
2296 do { if (net_msg_warn) printk(fmt,##args); } while (0)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002297
Stephen Hemmingera2a316f2007-03-08 20:41:08 -08002298#define LIMIT_NETDEBUG(fmt, args...) \
2299 do { if (net_msg_warn && net_ratelimit()) printk(fmt,##args); } while(0)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002300
Linus Torvalds1da177e2005-04-16 15:20:36 -07002301extern __u32 sysctl_wmem_max;
2302extern __u32 sysctl_rmem_max;
2303
David S. Miller6baf1f42005-09-05 18:14:11 -07002304extern int sysctl_optmem_max;
2305
Arnaldo Carvalho de Melo20380732005-08-16 02:18:02 -03002306extern __u32 sysctl_wmem_default;
2307extern __u32 sysctl_rmem_default;
Arnaldo Carvalho de Melo20380732005-08-16 02:18:02 -03002308
Linus Torvalds1da177e2005-04-16 15:20:36 -07002309#endif /* _SOCK_H */