blob: 250822cc1e020dc86106e3389af4995ba775629f [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>
Johannes Weiner3e32cb22014-12-10 15:42:31 -080057#include <linux/page_counter.h>
Glauber Costa180d8cd2011-12-11 21:47:02 +000058#include <linux/memcontrol.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>
Willem de Bruijnb9f40e22014-08-04 22:11:46 -040070#include <linux/net_tstamp.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070071
Eric Dumazet9f048bf2011-12-13 03:59:08 +000072struct cgroup;
73struct cgroup_subsys;
Glauber Costac607b2e2011-12-16 00:52:00 +000074#ifdef CONFIG_NET
Glauber Costa1d62e432012-04-09 19:36:33 -030075int mem_cgroup_sockets_init(struct mem_cgroup *memcg, struct cgroup_subsys *ss);
76void mem_cgroup_sockets_destroy(struct mem_cgroup *memcg);
Glauber Costac607b2e2011-12-16 00:52:00 +000077#else
78static inline
Glauber Costa1d62e432012-04-09 19:36:33 -030079int mem_cgroup_sockets_init(struct mem_cgroup *memcg, struct cgroup_subsys *ss)
Glauber Costac607b2e2011-12-16 00:52:00 +000080{
81 return 0;
82}
83static inline
Glauber Costa1d62e432012-04-09 19:36:33 -030084void mem_cgroup_sockets_destroy(struct mem_cgroup *memcg)
Glauber Costac607b2e2011-12-16 00:52:00 +000085{
86}
87#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -070088/*
89 * This structure really needs to be cleaned up.
90 * Most of it is for TCP, and not used by any of
91 * the other protocols.
92 */
93
94/* Define this to get the SOCK_DBG debugging facility. */
95#define SOCK_DEBUGGING
96#ifdef SOCK_DEBUGGING
97#define SOCK_DEBUG(sk, msg...) do { if ((sk) && sock_flag((sk), SOCK_DBG)) \
98 printk(KERN_DEBUG msg); } while (0)
99#else
Stephen Hemminger4cd90292008-03-21 15:54:53 -0700100/* Validate arguments and do nothing */
Joe Perchesb9075fa2011-10-31 17:11:33 -0700101static inline __printf(2, 3)
Eric Dumazetdc6b9b72012-05-16 22:48:15 +0000102void SOCK_DEBUG(const struct sock *sk, const char *msg, ...)
Stephen Hemminger4cd90292008-03-21 15:54:53 -0700103{
104}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700105#endif
106
107/* This is the per-socket lock. The spinlock provides a synchronization
108 * between user contexts and software interrupt processing, whereas the
109 * mini-semaphore synchronizes multiple users amongst themselves.
110 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700111typedef struct {
112 spinlock_t slock;
John Heffnerd2e91172007-09-12 10:44:19 +0200113 int owned;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700114 wait_queue_head_t wq;
Ingo Molnara5b5bb92006-07-03 00:25:35 -0700115 /*
116 * We express the mutex-alike socket_lock semantics
117 * to the lock validator by explicitly managing
118 * the slock as a lock variant (in addition to
119 * the slock itself):
120 */
121#ifdef CONFIG_DEBUG_LOCK_ALLOC
122 struct lockdep_map dep_map;
123#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -0700124} socket_lock_t;
125
Linus Torvalds1da177e2005-04-16 15:20:36 -0700126struct sock;
Arnaldo Carvalho de Melo8feaf0c02005-08-09 20:09:30 -0700127struct proto;
Denis V. Lunev0eeb8ff2007-12-04 01:15:45 -0800128struct net;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700129
Eric Dumazet077b3932012-12-02 07:33:10 +0000130typedef __u32 __bitwise __portpair;
131typedef __u64 __bitwise __addrpair;
132
Linus Torvalds1da177e2005-04-16 15:20:36 -0700133/**
Pavel Pisa4dc3b162005-05-01 08:59:25 -0700134 * struct sock_common - minimal network layer representation of sockets
Eric Dumazet68835ab2010-11-30 19:04:07 +0000135 * @skc_daddr: Foreign IPv4 addr
136 * @skc_rcv_saddr: Bound local IPv4 addr
Eric Dumazet4dc6dc72009-07-15 23:13:10 +0000137 * @skc_hash: hash value used with various protocol lookup tables
Eric Dumazetd4cada42009-11-08 10:17:30 +0000138 * @skc_u16hashes: two u16 hash values used by UDP lookup tables
Eric Dumazetce43b032012-11-30 09:49:27 +0000139 * @skc_dport: placeholder for inet_dport/tw_dport
140 * @skc_num: placeholder for inet_num/tw_num
Pavel Pisa4dc3b162005-05-01 08:59:25 -0700141 * @skc_family: network address family
142 * @skc_state: Connection state
143 * @skc_reuse: %SO_REUSEADDR setting
Tom Herbert055dc212013-01-22 09:49:50 +0000144 * @skc_reuseport: %SO_REUSEPORT setting
Pavel Pisa4dc3b162005-05-01 08:59:25 -0700145 * @skc_bound_dev_if: bound device index if != 0
Pavel Pisa4dc3b162005-05-01 08:59:25 -0700146 * @skc_bind_node: bind hash linkage for various protocol lookup tables
Eric Dumazet512615b2009-11-08 10:17:58 +0000147 * @skc_portaddr_node: second hash linkage for UDP/UDP-Lite protocol
Arnaldo Carvalho de Melo8feaf0c02005-08-09 20:09:30 -0700148 * @skc_prot: protocol handlers inside a network family
Eric W. Biederman07feaeb2007-09-12 11:58:02 +0200149 * @skc_net: reference to the network namespace of this socket
Eric Dumazet68835ab2010-11-30 19:04:07 +0000150 * @skc_node: main hash linkage for various protocol lookup tables
151 * @skc_nulls_node: main hash linkage for TCP/UDP/UDP-Lite protocol
152 * @skc_tx_queue_mapping: tx queue number for this connection
153 * @skc_refcnt: reference count
Pavel Pisa4dc3b162005-05-01 08:59:25 -0700154 *
155 * This is the minimal network layer representation of sockets, the header
Arnaldo Carvalho de Melo8feaf0c02005-08-09 20:09:30 -0700156 * for struct sock and struct inet_timewait_sock.
157 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700158struct sock_common {
Eric Dumazetce43b032012-11-30 09:49:27 +0000159 /* skc_daddr and skc_rcv_saddr must be grouped on a 8 bytes aligned
Eric Dumazet05dbc7b2013-10-03 00:22:02 -0700160 * address on 64bit arches : cf INET_MATCH()
Eric Dumazet4dc6dc72009-07-15 23:13:10 +0000161 */
Eric Dumazetce43b032012-11-30 09:49:27 +0000162 union {
Eric Dumazet077b3932012-12-02 07:33:10 +0000163 __addrpair skc_addrpair;
Eric Dumazetce43b032012-11-30 09:49:27 +0000164 struct {
165 __be32 skc_daddr;
166 __be32 skc_rcv_saddr;
167 };
168 };
Eric Dumazetd4cada42009-11-08 10:17:30 +0000169 union {
170 unsigned int skc_hash;
171 __u16 skc_u16hashes[2];
172 };
Eric Dumazetce43b032012-11-30 09:49:27 +0000173 /* skc_dport && skc_num must be grouped as well */
174 union {
Eric Dumazet077b3932012-12-02 07:33:10 +0000175 __portpair skc_portpair;
Eric Dumazetce43b032012-11-30 09:49:27 +0000176 struct {
177 __be16 skc_dport;
178 __u16 skc_num;
179 };
180 };
181
Eric Dumazet4dc6dc72009-07-15 23:13:10 +0000182 unsigned short skc_family;
183 volatile unsigned char skc_state;
Tom Herbert055dc212013-01-22 09:49:50 +0000184 unsigned char skc_reuse:4;
Eric Dumazet9fe516b2014-06-27 08:36:16 -0700185 unsigned char skc_reuseport:1;
186 unsigned char skc_ipv6only:1;
Eric Dumazet4dc6dc72009-07-15 23:13:10 +0000187 int skc_bound_dev_if;
Eric Dumazet512615b2009-11-08 10:17:58 +0000188 union {
189 struct hlist_node skc_bind_node;
190 struct hlist_nulls_node skc_portaddr_node;
191 };
Arnaldo Carvalho de Melo8feaf0c02005-08-09 20:09:30 -0700192 struct proto *skc_prot;
YOSHIFUJI Hideaki3b1e0a62008-03-26 02:26:21 +0900193#ifdef CONFIG_NET_NS
Eric W. Biederman07feaeb2007-09-12 11:58:02 +0200194 struct net *skc_net;
YOSHIFUJI Hideaki3b1e0a62008-03-26 02:26:21 +0900195#endif
Eric Dumazetefe42082013-10-03 15:42:29 -0700196
197#if IS_ENABLED(CONFIG_IPV6)
198 struct in6_addr skc_v6_daddr;
199 struct in6_addr skc_v6_rcv_saddr;
200#endif
201
Eric Dumazet68835ab2010-11-30 19:04:07 +0000202 /*
203 * fields between dontcopy_begin/dontcopy_end
204 * are not copied in sock_copy()
205 */
Randy Dunlap928c41e2011-01-08 17:39:21 +0000206 /* private: */
Eric Dumazet68835ab2010-11-30 19:04:07 +0000207 int skc_dontcopy_begin[0];
Randy Dunlap928c41e2011-01-08 17:39:21 +0000208 /* public: */
Eric Dumazet68835ab2010-11-30 19:04:07 +0000209 union {
210 struct hlist_node skc_node;
211 struct hlist_nulls_node skc_nulls_node;
212 };
213 int skc_tx_queue_mapping;
214 atomic_t skc_refcnt;
Randy Dunlap928c41e2011-01-08 17:39:21 +0000215 /* private: */
Eric Dumazet68835ab2010-11-30 19:04:07 +0000216 int skc_dontcopy_end[0];
Randy Dunlap928c41e2011-01-08 17:39:21 +0000217 /* public: */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700218};
219
Glauber Costae1aab162011-12-11 21:47:03 +0000220struct cg_proto;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700221/**
222 * struct sock - network layer representation of sockets
Arnaldo Carvalho de Melo8feaf0c02005-08-09 20:09:30 -0700223 * @__sk_common: shared layout with inet_timewait_sock
Pavel Pisa4dc3b162005-05-01 08:59:25 -0700224 * @sk_shutdown: mask of %SEND_SHUTDOWN and/or %RCV_SHUTDOWN
225 * @sk_userlocks: %SO_SNDBUF and %SO_RCVBUF settings
226 * @sk_lock: synchronizer
227 * @sk_rcvbuf: size of receive buffer in bytes
Eric Dumazet43815482010-04-29 11:01:49 +0000228 * @sk_wq: sock wait queue and async head
Shawn Bohrer421b3882013-10-07 11:01:39 -0500229 * @sk_rx_dst: receive input route used by early demux
Pavel Pisa4dc3b162005-05-01 08:59:25 -0700230 * @sk_dst_cache: destination cache
231 * @sk_dst_lock: destination cache lock
232 * @sk_policy: flow policy
Pavel Pisa4dc3b162005-05-01 08:59:25 -0700233 * @sk_receive_queue: incoming packets
234 * @sk_wmem_alloc: transmit queue bytes committed
235 * @sk_write_queue: Packet sending queue
236 * @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
Eric Dumazet2c8c56e2014-11-11 05:54:28 -0800276 * @sk_incoming_cpu: record cpu processing incoming packets
Tom Herbertb73c3d02014-07-01 21:32:17 -0700277 * @sk_txhash: computed flow hash for use on transmit
Pavel Pisa4dc3b162005-05-01 08:59:25 -0700278 * @sk_filter: socket filtering instructions
279 * @sk_protinfo: private area, net family specific, when not using slab
280 * @sk_timer: sock cleanup timer
281 * @sk_stamp: time stamp of last packet received
Willem de Bruijnb9f40e22014-08-04 22:11:46 -0400282 * @sk_tsflags: SO_TIMESTAMPING socket options
Willem de Bruijn09c2d252014-08-04 22:11:47 -0400283 * @sk_tskey: counter to disambiguate concurrent tstamp requests
Pavel Pisa4dc3b162005-05-01 08:59:25 -0700284 * @sk_socket: Identd and reporting IO signals
285 * @sk_user_data: RPC layer private data
Eric Dumazet5640f762012-09-23 23:04:42 +0000286 * @sk_frag: cached page frag
Randy Dunlapd3d4f0a2012-04-17 14:03:53 +0000287 * @sk_peek_off: current peek_offset value
Pavel Pisa4dc3b162005-05-01 08:59:25 -0700288 * @sk_send_head: front of stuff to transmit
Martin Waitz67be2dd2005-05-01 08:59:26 -0700289 * @sk_security: used by security modules
Randy Dunlap31729362008-02-18 20:52:13 -0800290 * @sk_mark: generic packet mark
Randy Dunlap53c3fa22010-08-09 13:41:07 +0000291 * @sk_classid: this socket's cgroup classid
Glauber Costae1aab162011-12-11 21:47:03 +0000292 * @sk_cgrp: this socket's cgroup-specific proto data
Pavel Pisa4dc3b162005-05-01 08:59:25 -0700293 * @sk_write_pending: a write to stream socket waits to start
294 * @sk_state_change: callback to indicate change in the state of the sock
295 * @sk_data_ready: callback to indicate there is data to be processed
296 * @sk_write_space: callback to indicate there is bf sending space available
297 * @sk_error_report: callback to indicate errors (e.g. %MSG_ERRQUEUE)
298 * @sk_backlog_rcv: callback to process the backlog
299 * @sk_destruct: called at sock freeing time, i.e. when all refcnt == 0
Linus Torvalds1da177e2005-04-16 15:20:36 -0700300 */
301struct sock {
302 /*
Arnaldo Carvalho de Melo8feaf0c02005-08-09 20:09:30 -0700303 * Now struct inet_timewait_sock also uses sock_common, so please just
Linus Torvalds1da177e2005-04-16 15:20:36 -0700304 * don't add nothing before this first member (__sk_common) --acme
305 */
306 struct sock_common __sk_common;
Eric Dumazet4dc6dc72009-07-15 23:13:10 +0000307#define sk_node __sk_common.skc_node
308#define sk_nulls_node __sk_common.skc_nulls_node
309#define sk_refcnt __sk_common.skc_refcnt
Krishna Kumare022f0b2009-10-19 23:46:20 +0000310#define sk_tx_queue_mapping __sk_common.skc_tx_queue_mapping
Eric Dumazet4dc6dc72009-07-15 23:13:10 +0000311
Eric Dumazet68835ab2010-11-30 19:04:07 +0000312#define sk_dontcopy_begin __sk_common.skc_dontcopy_begin
313#define sk_dontcopy_end __sk_common.skc_dontcopy_end
Eric Dumazet4dc6dc72009-07-15 23:13:10 +0000314#define sk_hash __sk_common.skc_hash
Eric Dumazet50805462013-10-02 04:29:50 -0700315#define sk_portpair __sk_common.skc_portpair
Eric Dumazet05dbc7b2013-10-03 00:22:02 -0700316#define sk_num __sk_common.skc_num
317#define sk_dport __sk_common.skc_dport
Eric Dumazet50805462013-10-02 04:29:50 -0700318#define sk_addrpair __sk_common.skc_addrpair
319#define sk_daddr __sk_common.skc_daddr
320#define sk_rcv_saddr __sk_common.skc_rcv_saddr
Linus Torvalds1da177e2005-04-16 15:20:36 -0700321#define sk_family __sk_common.skc_family
322#define sk_state __sk_common.skc_state
323#define sk_reuse __sk_common.skc_reuse
Tom Herbert055dc212013-01-22 09:49:50 +0000324#define sk_reuseport __sk_common.skc_reuseport
Eric Dumazet9fe516b2014-06-27 08:36:16 -0700325#define sk_ipv6only __sk_common.skc_ipv6only
Linus Torvalds1da177e2005-04-16 15:20:36 -0700326#define sk_bound_dev_if __sk_common.skc_bound_dev_if
Linus Torvalds1da177e2005-04-16 15:20:36 -0700327#define sk_bind_node __sk_common.skc_bind_node
Arnaldo Carvalho de Melo8feaf0c02005-08-09 20:09:30 -0700328#define sk_prot __sk_common.skc_prot
Eric W. Biederman07feaeb2007-09-12 11:58:02 +0200329#define sk_net __sk_common.skc_net
Eric Dumazetefe42082013-10-03 15:42:29 -0700330#define sk_v6_daddr __sk_common.skc_v6_daddr
331#define sk_v6_rcv_saddr __sk_common.skc_v6_rcv_saddr
332
Eric Dumazetb178bb32010-11-16 05:56:04 +0000333 socket_lock_t sk_lock;
334 struct sk_buff_head sk_receive_queue;
335 /*
336 * The backlog queue is special, it is always used with
337 * the per-socket spinlock held and requires low latency
338 * access. Therefore we special case it's implementation.
339 * Note : rmem_alloc is in this structure to fill a hole
340 * on 64bit arches, not because its logically part of
341 * backlog.
342 */
343 struct {
344 atomic_t rmem_alloc;
345 int len;
346 struct sk_buff *head;
347 struct sk_buff *tail;
348 } sk_backlog;
349#define sk_rmem_alloc sk_backlog.rmem_alloc
350 int sk_forward_alloc;
351#ifdef CONFIG_RPS
352 __u32 sk_rxhash;
353#endif
Eric Dumazet2c8c56e2014-11-11 05:54:28 -0800354 u16 sk_incoming_cpu;
355 /* 16bit hole
356 * Warned : sk_incoming_cpu can be set from softirq,
357 * Do not use this hole without fully understanding possible issues.
358 */
359
Tom Herbertb73c3d02014-07-01 21:32:17 -0700360 __u32 sk_txhash;
Cong Wange0d10952013-08-01 11:10:25 +0800361#ifdef CONFIG_NET_RX_BUSY_POLL
Eliezer Tamir06021292013-06-10 11:39:50 +0300362 unsigned int sk_napi_id;
Eliezer Tamirdafcc432013-06-14 16:33:57 +0300363 unsigned int sk_ll_usec;
Eliezer Tamir06021292013-06-10 11:39:50 +0300364#endif
Eric Dumazetb178bb32010-11-16 05:56:04 +0000365 atomic_t sk_drops;
366 int sk_rcvbuf;
367
368 struct sk_filter __rcu *sk_filter;
Eric Dumazeteaefd112011-02-18 03:26:36 +0000369 struct socket_wq __rcu *sk_wq;
Eric Dumazetb178bb32010-11-16 05:56:04 +0000370
Eric Dumazetb178bb32010-11-16 05:56:04 +0000371#ifdef CONFIG_XFRM
372 struct xfrm_policy *sk_policy[2];
373#endif
374 unsigned long sk_flags;
Eric Dumazetdeaa5852012-06-24 20:22:49 +0000375 struct dst_entry *sk_rx_dst;
Cong Wang0e36cbb2013-01-22 21:09:51 +0000376 struct dst_entry __rcu *sk_dst_cache;
Eric Dumazetb178bb32010-11-16 05:56:04 +0000377 spinlock_t sk_dst_lock;
378 atomic_t sk_wmem_alloc;
379 atomic_t sk_omem_alloc;
380 int sk_sndbuf;
381 struct sk_buff_head sk_write_queue;
Vegard Nossuma98b65a2009-02-26 14:46:57 +0100382 kmemcheck_bitfield_begin(flags);
Eric Dumazet5fdb9972009-10-08 22:50:25 +0000383 unsigned int sk_shutdown : 2,
Tom Herbert28448b82014-05-23 08:47:19 -0700384 sk_no_check_tx : 1,
385 sk_no_check_rx : 1,
Eric Dumazet5fdb9972009-10-08 22:50:25 +0000386 sk_userlocks : 4,
387 sk_protocol : 8,
388 sk_type : 16;
Vegard Nossuma98b65a2009-02-26 14:46:57 +0100389 kmemcheck_bitfield_end(flags);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700390 int sk_wmem_queued;
Al Viro7d877f32005-10-21 03:20:43 -0400391 gfp_t sk_allocation;
Eric Dumazet95bd09e2013-08-27 05:46:32 -0700392 u32 sk_pacing_rate; /* bytes per second */
Eric Dumazet62748f32013-09-24 08:20:52 -0700393 u32 sk_max_pacing_rate;
Michał Mirosławc8f44af2011-11-15 15:29:55 +0000394 netdev_features_t sk_route_caps;
395 netdev_features_t sk_route_nocaps;
Herbert Xubcd76112006-06-30 13:36:35 -0700396 int sk_gso_type;
Peter P Waskiewicz Jr82cc1a72008-03-21 03:43:19 -0700397 unsigned int sk_gso_max_size;
Ben Hutchings14853482012-07-30 16:11:42 +0000398 u16 sk_gso_max_segs;
David S. Miller9932cf92006-03-24 15:12:37 -0800399 int sk_rcvlowat;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700400 unsigned long sk_lingertime;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700401 struct sk_buff_head sk_error_queue;
Arnaldo Carvalho de Melo476e19c2005-05-05 13:35:15 -0700402 struct proto *sk_prot_creator;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700403 rwlock_t sk_callback_lock;
404 int sk_err,
405 sk_err_soft;
406 unsigned short sk_ack_backlog;
407 unsigned short sk_max_ack_backlog;
408 __u32 sk_priority;
Daniel Borkmann86f85152013-12-29 17:27:11 +0100409#if IS_ENABLED(CONFIG_CGROUP_NET_PRIO)
Neil Horman5bc14212011-11-22 05:10:51 +0000410 __u32 sk_cgrp_prioidx;
411#endif
Eric W. Biederman109f6e32010-06-13 03:30:14 +0000412 struct pid *sk_peer_pid;
413 const struct cred *sk_peer_cred;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700414 long sk_rcvtimeo;
415 long sk_sndtimeo;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700416 void *sk_protinfo;
417 struct timer_list sk_timer;
Eric Dumazetb7aa0bf2007-04-19 16:16:32 -0700418 ktime_t sk_stamp;
Willem de Bruijnb9f40e22014-08-04 22:11:46 -0400419 u16 sk_tsflags;
Willem de Bruijn09c2d252014-08-04 22:11:47 -0400420 u32 sk_tskey;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700421 struct socket *sk_socket;
422 void *sk_user_data;
Eric Dumazet5640f762012-09-23 23:04:42 +0000423 struct page_frag sk_frag;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700424 struct sk_buff *sk_send_head;
Pavel Emelyanovef64a542012-02-21 07:31:34 +0000425 __s32 sk_peek_off;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700426 int sk_write_pending;
Alexey Dobriyand5f64232008-11-04 14:45:58 -0800427#ifdef CONFIG_SECURITY
Linus Torvalds1da177e2005-04-16 15:20:36 -0700428 void *sk_security;
Alexey Dobriyand5f64232008-11-04 14:45:58 -0800429#endif
Laszlo Attila Toth4a19ec52008-01-30 19:08:16 -0800430 __u32 sk_mark;
Herbert Xuf8451722010-05-24 00:12:34 -0700431 u32 sk_classid;
Glauber Costae1aab162011-12-11 21:47:03 +0000432 struct cg_proto *sk_cgrp;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700433 void (*sk_state_change)(struct sock *sk);
David S. Miller676d2362014-04-11 16:15:36 -0400434 void (*sk_data_ready)(struct sock *sk);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700435 void (*sk_write_space)(struct sock *sk);
436 void (*sk_error_report)(struct sock *sk);
Eric Dumazetdc6b9b72012-05-16 22:48:15 +0000437 int (*sk_backlog_rcv)(struct sock *sk,
438 struct sk_buff *skb);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700439 void (*sk_destruct)(struct sock *sk);
440};
441
Pravin B Shelar559835ea2013-09-24 10:25:40 -0700442#define __sk_user_data(sk) ((*((void __rcu **)&(sk)->sk_user_data)))
443
444#define rcu_dereference_sk_user_data(sk) rcu_dereference(__sk_user_data((sk)))
445#define rcu_assign_sk_user_data(sk, ptr) rcu_assign_pointer(__sk_user_data((sk)), ptr)
446
Pavel Emelyanov4a17fd52012-04-19 03:39:36 +0000447/*
448 * SK_CAN_REUSE and SK_NO_REUSE on a socket mean that the socket is OK
449 * or not whether his port will be reused by someone else. SK_FORCE_REUSE
450 * on a socket means that the socket will reuse everybody else's port
451 * without looking at the other's sk_reuse value.
452 */
453
454#define SK_NO_REUSE 0
455#define SK_CAN_REUSE 1
456#define SK_FORCE_REUSE 2
457
Pavel Emelyanovef64a542012-02-21 07:31:34 +0000458static inline int sk_peek_offset(struct sock *sk, int flags)
459{
460 if ((flags & MSG_PEEK) && (sk->sk_peek_off >= 0))
461 return sk->sk_peek_off;
462 else
463 return 0;
464}
465
466static inline void sk_peek_offset_bwd(struct sock *sk, int val)
467{
468 if (sk->sk_peek_off >= 0) {
469 if (sk->sk_peek_off >= val)
470 sk->sk_peek_off -= val;
471 else
472 sk->sk_peek_off = 0;
473 }
474}
475
476static inline void sk_peek_offset_fwd(struct sock *sk, int val)
477{
478 if (sk->sk_peek_off >= 0)
479 sk->sk_peek_off += val;
480}
481
Linus Torvalds1da177e2005-04-16 15:20:36 -0700482/*
483 * Hashed lists helper routines
484 */
Li Zefanc4146642010-02-08 23:18:45 +0000485static inline struct sock *sk_entry(const struct hlist_node *node)
486{
487 return hlist_entry(node, struct sock, sk_node);
488}
489
Arnaldo Carvalho de Meloe48c4142005-08-09 20:09:46 -0700490static inline struct sock *__sk_head(const struct hlist_head *head)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700491{
492 return hlist_entry(head->first, struct sock, sk_node);
493}
494
Arnaldo Carvalho de Meloe48c4142005-08-09 20:09:46 -0700495static inline struct sock *sk_head(const struct hlist_head *head)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700496{
497 return hlist_empty(head) ? NULL : __sk_head(head);
498}
499
Eric Dumazet88ab1932008-11-16 19:39:21 -0800500static inline struct sock *__sk_nulls_head(const struct hlist_nulls_head *head)
501{
502 return hlist_nulls_entry(head->first, struct sock, sk_nulls_node);
503}
504
505static inline struct sock *sk_nulls_head(const struct hlist_nulls_head *head)
506{
507 return hlist_nulls_empty(head) ? NULL : __sk_nulls_head(head);
508}
509
Arnaldo Carvalho de Meloe48c4142005-08-09 20:09:46 -0700510static inline struct sock *sk_next(const struct sock *sk)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700511{
512 return sk->sk_node.next ?
513 hlist_entry(sk->sk_node.next, struct sock, sk_node) : NULL;
514}
515
Eric Dumazet88ab1932008-11-16 19:39:21 -0800516static inline struct sock *sk_nulls_next(const struct sock *sk)
517{
518 return (!is_a_nulls(sk->sk_nulls_node.next)) ?
519 hlist_nulls_entry(sk->sk_nulls_node.next,
520 struct sock, sk_nulls_node) :
521 NULL;
522}
523
Eric Dumazetdc6b9b72012-05-16 22:48:15 +0000524static inline bool sk_unhashed(const struct sock *sk)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700525{
526 return hlist_unhashed(&sk->sk_node);
527}
528
Eric Dumazetdc6b9b72012-05-16 22:48:15 +0000529static inline bool sk_hashed(const struct sock *sk)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700530{
Akinobu Mitada753be2006-04-28 15:21:23 -0700531 return !sk_unhashed(sk);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700532}
533
Eric Dumazetdc6b9b72012-05-16 22:48:15 +0000534static inline void sk_node_init(struct hlist_node *node)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700535{
536 node->pprev = NULL;
537}
538
Eric Dumazetdc6b9b72012-05-16 22:48:15 +0000539static inline void sk_nulls_node_init(struct hlist_nulls_node *node)
Eric Dumazet88ab1932008-11-16 19:39:21 -0800540{
541 node->pprev = NULL;
542}
543
Eric Dumazetdc6b9b72012-05-16 22:48:15 +0000544static inline void __sk_del_node(struct sock *sk)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700545{
546 __hlist_del(&sk->sk_node);
547}
548
stephen hemminger808f5112010-02-22 07:57:18 +0000549/* NB: equivalent to hlist_del_init_rcu */
Eric Dumazetdc6b9b72012-05-16 22:48:15 +0000550static inline bool __sk_del_node_init(struct sock *sk)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700551{
552 if (sk_hashed(sk)) {
553 __sk_del_node(sk);
554 sk_node_init(&sk->sk_node);
Eric Dumazetdc6b9b72012-05-16 22:48:15 +0000555 return true;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700556 }
Eric Dumazetdc6b9b72012-05-16 22:48:15 +0000557 return false;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700558}
559
560/* Grab socket reference count. This operation is valid only
561 when sk is ALREADY grabbed f.e. it is found in hash table
562 or a list and the lookup is made under lock preventing hash table
563 modifications.
564 */
565
566static inline void sock_hold(struct sock *sk)
567{
568 atomic_inc(&sk->sk_refcnt);
569}
570
571/* Ungrab socket in the context, which assumes that socket refcnt
572 cannot hit zero, f.e. it is true in context of any socketcall.
573 */
574static inline void __sock_put(struct sock *sk)
575{
576 atomic_dec(&sk->sk_refcnt);
577}
578
Eric Dumazetdc6b9b72012-05-16 22:48:15 +0000579static inline bool sk_del_node_init(struct sock *sk)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700580{
Eric Dumazetdc6b9b72012-05-16 22:48:15 +0000581 bool rc = __sk_del_node_init(sk);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700582
583 if (rc) {
584 /* paranoid for a while -acme */
585 WARN_ON(atomic_read(&sk->sk_refcnt) == 1);
586 __sock_put(sk);
587 }
588 return rc;
589}
stephen hemminger808f5112010-02-22 07:57:18 +0000590#define sk_del_node_init_rcu(sk) sk_del_node_init(sk)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700591
Eric Dumazetdc6b9b72012-05-16 22:48:15 +0000592static inline bool __sk_nulls_del_node_init_rcu(struct sock *sk)
Eric Dumazet271b72c2008-10-29 02:11:14 -0700593{
594 if (sk_hashed(sk)) {
Eric Dumazet88ab1932008-11-16 19:39:21 -0800595 hlist_nulls_del_init_rcu(&sk->sk_nulls_node);
Eric Dumazetdc6b9b72012-05-16 22:48:15 +0000596 return true;
Eric Dumazet271b72c2008-10-29 02:11:14 -0700597 }
Eric Dumazetdc6b9b72012-05-16 22:48:15 +0000598 return false;
Eric Dumazet271b72c2008-10-29 02:11:14 -0700599}
600
Eric Dumazetdc6b9b72012-05-16 22:48:15 +0000601static inline bool sk_nulls_del_node_init_rcu(struct sock *sk)
Eric Dumazet271b72c2008-10-29 02:11:14 -0700602{
Eric Dumazetdc6b9b72012-05-16 22:48:15 +0000603 bool rc = __sk_nulls_del_node_init_rcu(sk);
Eric Dumazet271b72c2008-10-29 02:11:14 -0700604
605 if (rc) {
606 /* paranoid for a while -acme */
607 WARN_ON(atomic_read(&sk->sk_refcnt) == 1);
608 __sock_put(sk);
609 }
610 return rc;
611}
612
Eric Dumazetdc6b9b72012-05-16 22:48:15 +0000613static inline void __sk_add_node(struct sock *sk, struct hlist_head *list)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700614{
615 hlist_add_head(&sk->sk_node, list);
616}
617
Eric Dumazetdc6b9b72012-05-16 22:48:15 +0000618static inline void sk_add_node(struct sock *sk, struct hlist_head *list)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700619{
620 sock_hold(sk);
621 __sk_add_node(sk, list);
622}
623
Eric Dumazetdc6b9b72012-05-16 22:48:15 +0000624static inline void sk_add_node_rcu(struct sock *sk, struct hlist_head *list)
stephen hemminger808f5112010-02-22 07:57:18 +0000625{
626 sock_hold(sk);
627 hlist_add_head_rcu(&sk->sk_node, list);
628}
629
Eric Dumazetdc6b9b72012-05-16 22:48:15 +0000630static inline void __sk_nulls_add_node_rcu(struct sock *sk, struct hlist_nulls_head *list)
Eric Dumazet271b72c2008-10-29 02:11:14 -0700631{
Eric Dumazet88ab1932008-11-16 19:39:21 -0800632 hlist_nulls_add_head_rcu(&sk->sk_nulls_node, list);
Eric Dumazet271b72c2008-10-29 02:11:14 -0700633}
634
Eric Dumazetdc6b9b72012-05-16 22:48:15 +0000635static inline void sk_nulls_add_node_rcu(struct sock *sk, struct hlist_nulls_head *list)
Eric Dumazet271b72c2008-10-29 02:11:14 -0700636{
637 sock_hold(sk);
Eric Dumazet88ab1932008-11-16 19:39:21 -0800638 __sk_nulls_add_node_rcu(sk, list);
Eric Dumazet271b72c2008-10-29 02:11:14 -0700639}
640
Eric Dumazetdc6b9b72012-05-16 22:48:15 +0000641static inline void __sk_del_bind_node(struct sock *sk)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700642{
643 __hlist_del(&sk->sk_bind_node);
644}
645
Eric Dumazetdc6b9b72012-05-16 22:48:15 +0000646static inline void sk_add_bind_node(struct sock *sk,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700647 struct hlist_head *list)
648{
649 hlist_add_head(&sk->sk_bind_node, list);
650}
651
Sasha Levinb67bfe02013-02-27 17:06:00 -0800652#define sk_for_each(__sk, list) \
653 hlist_for_each_entry(__sk, list, sk_node)
654#define sk_for_each_rcu(__sk, list) \
655 hlist_for_each_entry_rcu(__sk, list, sk_node)
Eric Dumazet88ab1932008-11-16 19:39:21 -0800656#define sk_nulls_for_each(__sk, node, list) \
657 hlist_nulls_for_each_entry(__sk, node, list, sk_nulls_node)
658#define sk_nulls_for_each_rcu(__sk, node, list) \
659 hlist_nulls_for_each_entry_rcu(__sk, node, list, sk_nulls_node)
Sasha Levinb67bfe02013-02-27 17:06:00 -0800660#define sk_for_each_from(__sk) \
661 hlist_for_each_entry_from(__sk, sk_node)
Eric Dumazet88ab1932008-11-16 19:39:21 -0800662#define sk_nulls_for_each_from(__sk, node) \
663 if (__sk && ({ node = &(__sk)->sk_nulls_node; 1; })) \
664 hlist_nulls_for_each_entry_from(__sk, node, sk_nulls_node)
Sasha Levinb67bfe02013-02-27 17:06:00 -0800665#define sk_for_each_safe(__sk, tmp, list) \
666 hlist_for_each_entry_safe(__sk, tmp, list, sk_node)
667#define sk_for_each_bound(__sk, list) \
668 hlist_for_each_entry(__sk, list, sk_bind_node)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700669
David Held2dc41cf2014-07-15 23:28:32 -0400670/**
671 * sk_nulls_for_each_entry_offset - iterate over a list at a given struct offset
672 * @tpos: the type * to use as a loop cursor.
673 * @pos: the &struct hlist_node to use as a loop cursor.
674 * @head: the head for your list.
675 * @offset: offset of hlist_node within the struct.
676 *
677 */
678#define sk_nulls_for_each_entry_offset(tpos, pos, head, offset) \
679 for (pos = (head)->first; \
680 (!is_a_nulls(pos)) && \
681 ({ tpos = (typeof(*tpos) *)((void *)pos - offset); 1;}); \
682 pos = pos->next)
683
Eric W. Biedermanc336d142012-05-24 17:56:43 -0600684static inline struct user_namespace *sk_user_ns(struct sock *sk)
685{
686 /* Careful only use this in a context where these parameters
687 * can not change and must all be valid, such as recvmsg from
688 * userspace.
689 */
690 return sk->sk_socket->file->f_cred->user_ns;
691}
692
Linus Torvalds1da177e2005-04-16 15:20:36 -0700693/* Sock flags */
694enum sock_flags {
695 SOCK_DEAD,
696 SOCK_DONE,
697 SOCK_URGINLINE,
698 SOCK_KEEPOPEN,
699 SOCK_LINGER,
700 SOCK_DESTROY,
701 SOCK_BROADCAST,
702 SOCK_TIMESTAMP,
703 SOCK_ZAPPED,
704 SOCK_USE_WRITE_QUEUE, /* whether to call sk->sk_write_space in sock_wfree */
705 SOCK_DBG, /* %SO_DEBUG setting */
706 SOCK_RCVTSTAMP, /* %SO_TIMESTAMP setting */
Eric Dumazet92f37fd2007-03-25 22:14:49 -0700707 SOCK_RCVTSTAMPNS, /* %SO_TIMESTAMPNS setting */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700708 SOCK_LOCALROUTE, /* route locally only, %SO_DONTROUTE setting */
709 SOCK_QUEUE_SHRUNK, /* write queue has been shrunk recently */
Mel Gorman7cb02402012-07-31 16:44:16 -0700710 SOCK_MEMALLOC, /* VM depends on this socket for swapping */
Patrick Ohly20d49472009-02-12 05:03:38 +0000711 SOCK_TIMESTAMPING_RX_SOFTWARE, /* %SOF_TIMESTAMPING_RX_SOFTWARE */
Eric Dumazetbcdce712009-10-06 17:28:29 -0700712 SOCK_FASYNC, /* fasync() active */
Neil Horman3b885782009-10-12 13:26:31 -0700713 SOCK_RXQ_OVFL,
Shirley Ma1cdebb42011-07-06 12:17:30 +0000714 SOCK_ZEROCOPY, /* buffers from userspace */
Johannes Berg6e3e9392011-11-09 10:15:42 +0100715 SOCK_WIFI_STATUS, /* push wifi status to userspace */
Ben Greear3bdc0eb2012-02-11 15:39:30 +0000716 SOCK_NOFCS, /* Tell NIC not to do the Ethernet FCS.
717 * Will use last 4 bytes of packet sent from
718 * user-space instead.
719 */
Vincent Bernatd59577b2013-01-16 22:55:49 +0100720 SOCK_FILTER_LOCKED, /* Filter cannot be changed anymore */
Keller, Jacob E7d4c04f2013-03-28 11:19:25 +0000721 SOCK_SELECT_ERR_QUEUE, /* Wake select on error queue */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700722};
723
Ralf Baechle53b924b2005-08-23 10:11:30 -0700724static inline void sock_copy_flags(struct sock *nsk, struct sock *osk)
725{
726 nsk->sk_flags = osk->sk_flags;
727}
728
Linus Torvalds1da177e2005-04-16 15:20:36 -0700729static inline void sock_set_flag(struct sock *sk, enum sock_flags flag)
730{
731 __set_bit(flag, &sk->sk_flags);
732}
733
734static inline void sock_reset_flag(struct sock *sk, enum sock_flags flag)
735{
736 __clear_bit(flag, &sk->sk_flags);
737}
738
Eric Dumazet1b23a5d2012-05-16 05:57:07 +0000739static inline bool sock_flag(const struct sock *sk, enum sock_flags flag)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700740{
741 return test_bit(flag, &sk->sk_flags);
742}
743
Mel Gormanc93bdd02012-07-31 16:44:19 -0700744#ifdef CONFIG_NET
745extern struct static_key memalloc_socks;
746static inline int sk_memalloc_socks(void)
747{
748 return static_key_false(&memalloc_socks);
749}
750#else
751
752static inline int sk_memalloc_socks(void)
753{
754 return 0;
755}
756
757#endif
758
Mel Gorman99a1dec2012-07-31 16:44:14 -0700759static inline gfp_t sk_gfp_atomic(struct sock *sk, gfp_t gfp_mask)
760{
Mel Gorman7cb02402012-07-31 16:44:16 -0700761 return GFP_ATOMIC | (sk->sk_allocation & __GFP_MEMALLOC);
Mel Gorman99a1dec2012-07-31 16:44:14 -0700762}
763
Linus Torvalds1da177e2005-04-16 15:20:36 -0700764static inline void sk_acceptq_removed(struct sock *sk)
765{
766 sk->sk_ack_backlog--;
767}
768
769static inline void sk_acceptq_added(struct sock *sk)
770{
771 sk->sk_ack_backlog++;
772}
773
Eric Dumazetdc6b9b72012-05-16 22:48:15 +0000774static inline bool sk_acceptq_is_full(const struct sock *sk)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700775{
David S. Miller64a14652007-03-06 11:21:05 -0800776 return sk->sk_ack_backlog > sk->sk_max_ack_backlog;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700777}
778
779/*
780 * Compute minimal free write space needed to queue new packets.
781 */
Eric Dumazetdc6b9b72012-05-16 22:48:15 +0000782static inline int sk_stream_min_wspace(const struct sock *sk)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700783{
Eric Dumazet8df09ea2007-12-21 03:07:41 -0800784 return sk->sk_wmem_queued >> 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700785}
786
Eric Dumazetdc6b9b72012-05-16 22:48:15 +0000787static inline int sk_stream_wspace(const struct sock *sk)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700788{
789 return sk->sk_sndbuf - sk->sk_wmem_queued;
790}
791
Joe Perches69336bd2013-09-22 10:32:26 -0700792void sk_stream_write_space(struct sock *sk);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700793
Zhu Yi8eae9392010-03-04 18:01:40 +0000794/* OOB backlog add */
Zhu Yia3a858f2010-03-04 18:01:47 +0000795static inline void __sk_add_backlog(struct sock *sk, struct sk_buff *skb)
Stephen Hemminger9ee6b532005-11-08 09:39:42 -0800796{
Eric Dumazet7fee2262010-05-11 23:19:48 +0000797 /* dont let skb dst not refcounted, we are going to leave rcu lock */
798 skb_dst_force(skb);
799
800 if (!sk->sk_backlog.tail)
801 sk->sk_backlog.head = skb;
802 else
Stephen Hemminger9ee6b532005-11-08 09:39:42 -0800803 sk->sk_backlog.tail->next = skb;
Eric Dumazet7fee2262010-05-11 23:19:48 +0000804
805 sk->sk_backlog.tail = skb;
Stephen Hemminger9ee6b532005-11-08 09:39:42 -0800806 skb->next = NULL;
807}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700808
Eric Dumazetc3774112010-04-27 15:13:20 -0700809/*
810 * Take into account size of receive queue and backlog queue
Eric Dumazet0fd7bac2011-12-21 07:11:44 +0000811 * Do not take into account this skb truesize,
812 * to allow even a single big packet to come.
Eric Dumazetc3774112010-04-27 15:13:20 -0700813 */
Sorin Dumitru274f4822014-07-22 21:16:51 +0300814static inline bool sk_rcvqueues_full(const struct sock *sk, unsigned int limit)
Eric Dumazetc3774112010-04-27 15:13:20 -0700815{
816 unsigned int qsize = sk->sk_backlog.len + atomic_read(&sk->sk_rmem_alloc);
817
Eric Dumazetf545a382012-04-22 23:34:26 +0000818 return qsize > limit;
Eric Dumazetc3774112010-04-27 15:13:20 -0700819}
820
Zhu Yi8eae9392010-03-04 18:01:40 +0000821/* The per-socket spinlock must be held here. */
Eric Dumazetf545a382012-04-22 23:34:26 +0000822static inline __must_check int sk_add_backlog(struct sock *sk, struct sk_buff *skb,
823 unsigned int limit)
Zhu Yi8eae9392010-03-04 18:01:40 +0000824{
Sorin Dumitru274f4822014-07-22 21:16:51 +0300825 if (sk_rcvqueues_full(sk, limit))
Zhu Yi8eae9392010-03-04 18:01:40 +0000826 return -ENOBUFS;
827
Zhu Yia3a858f2010-03-04 18:01:47 +0000828 __sk_add_backlog(sk, skb);
Zhu Yi8eae9392010-03-04 18:01:40 +0000829 sk->sk_backlog.len += skb->truesize;
830 return 0;
831}
832
Joe Perches69336bd2013-09-22 10:32:26 -0700833int __sk_backlog_rcv(struct sock *sk, struct sk_buff *skb);
Mel Gormanb4b9e352012-07-31 16:44:26 -0700834
Peter Zijlstrac57943a2008-10-07 14:18:42 -0700835static inline int sk_backlog_rcv(struct sock *sk, struct sk_buff *skb)
836{
Mel Gormanb4b9e352012-07-31 16:44:26 -0700837 if (sk_memalloc_socks() && skb_pfmemalloc(skb))
838 return __sk_backlog_rcv(sk, skb);
839
Peter Zijlstrac57943a2008-10-07 14:18:42 -0700840 return sk->sk_backlog_rcv(sk, skb);
841}
842
Eric Dumazet2c8c56e2014-11-11 05:54:28 -0800843static inline void sk_incoming_cpu_update(struct sock *sk)
844{
845 sk->sk_incoming_cpu = raw_smp_processor_id();
846}
847
Tom Herbertfe477552013-12-22 18:54:31 +0800848static inline void sock_rps_record_flow_hash(__u32 hash)
David S. Millerc58dc012010-04-27 15:05:31 -0700849{
850#ifdef CONFIG_RPS
851 struct rps_sock_flow_table *sock_flow_table;
852
853 rcu_read_lock();
854 sock_flow_table = rcu_dereference(rps_sock_flow_table);
Tom Herbertfe477552013-12-22 18:54:31 +0800855 rps_record_sock_flow(sock_flow_table, hash);
David S. Millerc58dc012010-04-27 15:05:31 -0700856 rcu_read_unlock();
857#endif
858}
859
Tom Herbertfe477552013-12-22 18:54:31 +0800860static inline void sock_rps_record_flow(const struct sock *sk)
861{
Zhi Yong Wuc9d8ca02014-01-01 04:31:01 +0800862#ifdef CONFIG_RPS
Tom Herbertfe477552013-12-22 18:54:31 +0800863 sock_rps_record_flow_hash(sk->sk_rxhash);
Zhi Yong Wuc9d8ca02014-01-01 04:31:01 +0800864#endif
Tom Herbertfe477552013-12-22 18:54:31 +0800865}
866
Tom Herbertbdeab992011-08-14 19:45:55 +0000867static inline void sock_rps_save_rxhash(struct sock *sk,
868 const struct sk_buff *skb)
David S. Millerc58dc012010-04-27 15:05:31 -0700869{
870#ifdef CONFIG_RPS
Eric Dumazet567e4b72015-02-06 12:59:01 -0800871 if (unlikely(sk->sk_rxhash != skb->hash))
Tom Herbert61b905d2014-03-24 15:34:47 -0700872 sk->sk_rxhash = skb->hash;
David S. Millerc58dc012010-04-27 15:05:31 -0700873#endif
874}
875
Tom Herbertbdeab992011-08-14 19:45:55 +0000876static inline void sock_rps_reset_rxhash(struct sock *sk)
877{
878#ifdef CONFIG_RPS
Tom Herbertbdeab992011-08-14 19:45:55 +0000879 sk->sk_rxhash = 0;
880#endif
881}
882
Stephen Hemmingercfcabdc2007-10-09 01:59:42 -0700883#define sk_wait_event(__sk, __timeo, __condition) \
884 ({ int __rc; \
885 release_sock(__sk); \
886 __rc = __condition; \
887 if (!__rc) { \
888 *(__timeo) = schedule_timeout(*(__timeo)); \
889 } \
Peter Zijlstra26cabd32014-09-24 10:18:54 +0200890 sched_annotate_sleep(); \
Stephen Hemmingercfcabdc2007-10-09 01:59:42 -0700891 lock_sock(__sk); \
892 __rc = __condition; \
893 __rc; \
894 })
Linus Torvalds1da177e2005-04-16 15:20:36 -0700895
Joe Perches69336bd2013-09-22 10:32:26 -0700896int sk_stream_wait_connect(struct sock *sk, long *timeo_p);
897int sk_stream_wait_memory(struct sock *sk, long *timeo_p);
898void sk_stream_wait_close(struct sock *sk, long timeo_p);
899int sk_stream_error(struct sock *sk, int flags, int err);
900void sk_stream_kill_queues(struct sock *sk);
901void sk_set_memalloc(struct sock *sk);
902void sk_clear_memalloc(struct sock *sk);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700903
Joe Perches69336bd2013-09-22 10:32:26 -0700904int sk_wait_data(struct sock *sk, long *timeo);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700905
Arnaldo Carvalho de Melo60236fd2005-06-18 22:47:21 -0700906struct request_sock_ops;
Arnaldo Carvalho de Melo6d6ee432005-12-13 23:25:19 -0800907struct timewait_sock_ops;
Arnaldo Carvalho de Meloab1e0a12008-02-03 04:06:04 -0800908struct inet_hashinfo;
Pavel Emelyanovfc8717b2008-03-22 16:56:51 -0700909struct raw_hashinfo;
Paul Gortmakerde477252011-05-26 13:46:22 -0400910struct module;
Arnaldo Carvalho de Melo2e6599c2005-06-18 22:46:52 -0700911
Eric Dumazetf77d6022013-05-09 10:28:16 +0000912/*
913 * caches using SLAB_DESTROY_BY_RCU should let .next pointer from nulls nodes
914 * un-modified. Special care is taken when initializing object to zero.
915 */
916static inline void sk_prot_clear_nulls(struct sock *sk, int size)
917{
918 if (offsetof(struct sock, sk_node.next) != 0)
919 memset(sk, 0, offsetof(struct sock, sk_node.next));
920 memset(&sk->sk_node.pprev, 0,
921 size - offsetof(struct sock, sk_node.pprev));
922}
923
Linus Torvalds1da177e2005-04-16 15:20:36 -0700924/* Networking protocol blocks we attach to sockets.
925 * socket layer -> transport layer interface
926 * transport -> network interface is defined by struct inet_proto
927 */
928struct proto {
Eric Dumazetdc6b9b72012-05-16 22:48:15 +0000929 void (*close)(struct sock *sk,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700930 long timeout);
931 int (*connect)(struct sock *sk,
Eric Dumazetdc6b9b72012-05-16 22:48:15 +0000932 struct sockaddr *uaddr,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700933 int addr_len);
934 int (*disconnect)(struct sock *sk, int flags);
935
Eric Dumazetdc6b9b72012-05-16 22:48:15 +0000936 struct sock * (*accept)(struct sock *sk, int flags, int *err);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700937
938 int (*ioctl)(struct sock *sk, int cmd,
939 unsigned long arg);
940 int (*init)(struct sock *sk);
Brian Haley7d06b2e2008-06-14 17:04:49 -0700941 void (*destroy)(struct sock *sk);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700942 void (*shutdown)(struct sock *sk, int how);
Eric Dumazetdc6b9b72012-05-16 22:48:15 +0000943 int (*setsockopt)(struct sock *sk, int level,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700944 int optname, char __user *optval,
David S. Millerb7058842009-09-30 16:12:20 -0700945 unsigned int optlen);
Eric Dumazetdc6b9b72012-05-16 22:48:15 +0000946 int (*getsockopt)(struct sock *sk, int level,
947 int optname, char __user *optval,
948 int __user *option);
Alexey Dobriyanaf01d532008-08-28 02:53:51 -0700949#ifdef CONFIG_COMPAT
Dmitry Mishin3fdadf72006-03-20 22:45:21 -0800950 int (*compat_setsockopt)(struct sock *sk,
951 int level,
952 int optname, char __user *optval,
David S. Millerb7058842009-09-30 16:12:20 -0700953 unsigned int optlen);
Dmitry Mishin3fdadf72006-03-20 22:45:21 -0800954 int (*compat_getsockopt)(struct sock *sk,
955 int level,
956 int optname, char __user *optval,
957 int __user *option);
Eric W. Biederman709b46e2011-01-29 16:15:56 +0000958 int (*compat_ioctl)(struct sock *sk,
959 unsigned int cmd, unsigned long arg);
Alexey Dobriyanaf01d532008-08-28 02:53:51 -0700960#endif
Ying Xue1b784142015-03-02 15:37:48 +0800961 int (*sendmsg)(struct sock *sk, struct msghdr *msg,
962 size_t len);
963 int (*recvmsg)(struct sock *sk, struct msghdr *msg,
Eric Dumazetdc6b9b72012-05-16 22:48:15 +0000964 size_t len, int noblock, int flags,
965 int *addr_len);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700966 int (*sendpage)(struct sock *sk, struct page *page,
967 int offset, size_t size, int flags);
Eric Dumazetdc6b9b72012-05-16 22:48:15 +0000968 int (*bind)(struct sock *sk,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700969 struct sockaddr *uaddr, int addr_len);
970
Eric Dumazetdc6b9b72012-05-16 22:48:15 +0000971 int (*backlog_rcv) (struct sock *sk,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700972 struct sk_buff *skb);
973
Eric Dumazet46d3cea2012-07-11 05:50:31 +0000974 void (*release_cb)(struct sock *sk);
975
Linus Torvalds1da177e2005-04-16 15:20:36 -0700976 /* Keeping track of sk's, looking them up, and port selection methods. */
977 void (*hash)(struct sock *sk);
978 void (*unhash)(struct sock *sk);
Eric Dumazet719f8352010-09-08 05:08:44 +0000979 void (*rehash)(struct sock *sk);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700980 int (*get_port)(struct sock *sk, unsigned short snum);
Octavian Purdilafcbdf092010-12-16 14:26:56 -0800981 void (*clear_sk)(struct sock *sk, int size);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700982
Eric Dumazet286ab3d2007-11-05 23:38:39 -0800983 /* Keeping track of sockets in use */
Eric Dumazet65f76512008-01-03 20:46:48 -0800984#ifdef CONFIG_PROC_FS
Pavel Emelyanov13ff3d62008-03-28 16:38:17 -0700985 unsigned int inuse_idx;
Eric Dumazet65f76512008-01-03 20:46:48 -0800986#endif
Arnaldo Carvalho de Meloebb53d72007-11-21 22:08:50 +0800987
Eric Dumazetc9bee3b72013-07-22 20:27:07 -0700988 bool (*stream_memory_free)(const struct sock *sk);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700989 /* Memory pressure */
Pavel Emelyanov5c52ba12008-07-16 20:28:10 -0700990 void (*enter_memory_pressure)(struct sock *sk);
Eric Dumazet8d987e52010-11-09 23:24:26 +0000991 atomic_long_t *memory_allocated; /* Current allocated memory. */
Eric Dumazet17483762008-11-25 21:16:35 -0800992 struct percpu_counter *sockets_allocated; /* Current number of sockets. */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700993 /*
994 * Pressure flag: try to collapse.
995 * Technical note: it is used by multiple contexts non atomically.
Hideo Aoki3ab224b2007-12-31 00:11:19 -0800996 * All the __sk_mem_schedule() is of this nature: accounting
Linus Torvalds1da177e2005-04-16 15:20:36 -0700997 * is strict, actions are advisory and have some latency.
998 */
999 int *memory_pressure;
Eric Dumazet8d987e52010-11-09 23:24:26 +00001000 long *sysctl_mem;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001001 int *sysctl_wmem;
1002 int *sysctl_rmem;
1003 int max_header;
Changli Gao7ba42912010-07-10 20:41:55 +00001004 bool no_autobind;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001005
Eric Dumazet271b72c2008-10-29 02:11:14 -07001006 struct kmem_cache *slab;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001007 unsigned int obj_size;
Eric Dumazet271b72c2008-10-29 02:11:14 -07001008 int slab_flags;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001009
Eric Dumazetdd24c002008-11-25 21:17:14 -08001010 struct percpu_counter *orphan_count;
Arnaldo Carvalho de Melo8feaf0c02005-08-09 20:09:30 -07001011
Arnaldo Carvalho de Melo60236fd2005-06-18 22:47:21 -07001012 struct request_sock_ops *rsk_prot;
Arnaldo Carvalho de Melo6d6ee432005-12-13 23:25:19 -08001013 struct timewait_sock_ops *twsk_prot;
Arnaldo Carvalho de Melo2e6599c2005-06-18 22:46:52 -07001014
Pavel Emelyanov39d8cda2008-03-22 16:50:58 -07001015 union {
1016 struct inet_hashinfo *hashinfo;
Eric Dumazet645ca702008-10-29 01:41:45 -07001017 struct udp_table *udp_table;
Pavel Emelyanovfc8717b2008-03-22 16:56:51 -07001018 struct raw_hashinfo *raw_hash;
Pavel Emelyanov39d8cda2008-03-22 16:50:58 -07001019 } h;
Arnaldo Carvalho de Meloab1e0a12008-02-03 04:06:04 -08001020
Linus Torvalds1da177e2005-04-16 15:20:36 -07001021 struct module *owner;
1022
1023 char name[32];
1024
1025 struct list_head node;
Arnaldo Carvalho de Meloe6848972005-08-09 19:45:38 -07001026#ifdef SOCK_REFCNT_DEBUG
1027 atomic_t socks;
1028#endif
Andrew Mortonc255a452012-07-31 16:43:02 -07001029#ifdef CONFIG_MEMCG_KMEM
Glauber Costae1aab162011-12-11 21:47:03 +00001030 /*
1031 * cgroup specific init/deinit functions. Called once for all
1032 * protocols that implement it, from cgroups populate function.
1033 * This function has to setup any files the protocol want to
1034 * appear in the kmem cgroup filesystem.
1035 */
Glauber Costa1d62e432012-04-09 19:36:33 -03001036 int (*init_cgroup)(struct mem_cgroup *memcg,
Glauber Costae1aab162011-12-11 21:47:03 +00001037 struct cgroup_subsys *ss);
Glauber Costa1d62e432012-04-09 19:36:33 -03001038 void (*destroy_cgroup)(struct mem_cgroup *memcg);
Glauber Costae1aab162011-12-11 21:47:03 +00001039 struct cg_proto *(*proto_cgroup)(struct mem_cgroup *memcg);
1040#endif
1041};
1042
Glauber Costa3f134612012-05-29 15:07:11 -07001043/*
1044 * Bits in struct cg_proto.flags
1045 */
1046enum cg_proto_flags {
1047 /* Currently active and new sockets should be assigned to cgroups */
1048 MEMCG_SOCK_ACTIVE,
1049 /* It was ever activated; we must disarm static keys on destruction */
1050 MEMCG_SOCK_ACTIVATED,
1051};
1052
Glauber Costae1aab162011-12-11 21:47:03 +00001053struct cg_proto {
Johannes Weiner3e32cb22014-12-10 15:42:31 -08001054 struct page_counter memory_allocated; /* Current allocated memory. */
Eric W. Biederman2e685ca2013-10-19 16:26:19 -07001055 struct percpu_counter sockets_allocated; /* Current number of sockets. */
1056 int memory_pressure;
1057 long sysctl_mem[3];
Glauber Costa3f134612012-05-29 15:07:11 -07001058 unsigned long flags;
Glauber Costae1aab162011-12-11 21:47:03 +00001059 /*
1060 * memcg field is used to find which memcg we belong directly
1061 * Each memcg struct can hold more than one cg_proto, so container_of
1062 * won't really cut.
1063 *
1064 * The elegant solution would be having an inverse function to
1065 * proto_cgroup in struct proto, but that means polluting the structure
1066 * for everybody, instead of just for memcg users.
1067 */
1068 struct mem_cgroup *memcg;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001069};
1070
Joe Perches69336bd2013-09-22 10:32:26 -07001071int proto_register(struct proto *prot, int alloc_slab);
1072void proto_unregister(struct proto *prot);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001073
Glauber Costa3f134612012-05-29 15:07:11 -07001074static inline bool memcg_proto_active(struct cg_proto *cg_proto)
1075{
1076 return test_bit(MEMCG_SOCK_ACTIVE, &cg_proto->flags);
1077}
1078
Arnaldo Carvalho de Meloe6848972005-08-09 19:45:38 -07001079#ifdef SOCK_REFCNT_DEBUG
1080static inline void sk_refcnt_debug_inc(struct sock *sk)
1081{
1082 atomic_inc(&sk->sk_prot->socks);
1083}
1084
1085static inline void sk_refcnt_debug_dec(struct sock *sk)
1086{
1087 atomic_dec(&sk->sk_prot->socks);
1088 printk(KERN_DEBUG "%s socket %p released, %d are still alive\n",
1089 sk->sk_prot->name, sk, atomic_read(&sk->sk_prot->socks));
1090}
1091
Ying Xuedec34fb2013-02-15 22:28:25 +00001092static inline void sk_refcnt_debug_release(const struct sock *sk)
Arnaldo Carvalho de Meloe6848972005-08-09 19:45:38 -07001093{
1094 if (atomic_read(&sk->sk_refcnt) != 1)
1095 printk(KERN_DEBUG "Destruction of the %s socket %p delayed, refcnt=%d\n",
1096 sk->sk_prot->name, sk, atomic_read(&sk->sk_refcnt));
1097}
1098#else /* SOCK_REFCNT_DEBUG */
1099#define sk_refcnt_debug_inc(sk) do { } while (0)
1100#define sk_refcnt_debug_dec(sk) do { } while (0)
1101#define sk_refcnt_debug_release(sk) do { } while (0)
1102#endif /* SOCK_REFCNT_DEBUG */
1103
Andrew Mortonc255a452012-07-31 16:43:02 -07001104#if defined(CONFIG_MEMCG_KMEM) && defined(CONFIG_NET)
Ingo Molnarc5905af2012-02-24 08:31:31 +01001105extern struct static_key memcg_socket_limit_enabled;
Glauber Costae1aab162011-12-11 21:47:03 +00001106static inline struct cg_proto *parent_cg_proto(struct proto *proto,
1107 struct cg_proto *cg_proto)
1108{
1109 return proto->proto_cgroup(parent_mem_cgroup(cg_proto->memcg));
1110}
Ingo Molnarc5905af2012-02-24 08:31:31 +01001111#define mem_cgroup_sockets_enabled static_key_false(&memcg_socket_limit_enabled)
Glauber Costae1aab162011-12-11 21:47:03 +00001112#else
1113#define mem_cgroup_sockets_enabled 0
1114static inline struct cg_proto *parent_cg_proto(struct proto *proto,
1115 struct cg_proto *cg_proto)
1116{
1117 return NULL;
1118}
1119#endif
1120
Eric Dumazetc9bee3b72013-07-22 20:27:07 -07001121static inline bool sk_stream_memory_free(const struct sock *sk)
1122{
1123 if (sk->sk_wmem_queued >= sk->sk_sndbuf)
1124 return false;
1125
1126 return sk->sk_prot->stream_memory_free ?
1127 sk->sk_prot->stream_memory_free(sk) : true;
1128}
1129
Eric Dumazet64dc6132013-07-22 20:26:31 -07001130static inline bool sk_stream_is_writeable(const struct sock *sk)
1131{
Eric Dumazetc9bee3b72013-07-22 20:27:07 -07001132 return sk_stream_wspace(sk) >= sk_stream_min_wspace(sk) &&
1133 sk_stream_memory_free(sk);
Eric Dumazet64dc6132013-07-22 20:26:31 -07001134}
Glauber Costae1aab162011-12-11 21:47:03 +00001135
Eric Dumazetc9bee3b72013-07-22 20:27:07 -07001136
Glauber Costa180d8cd2011-12-11 21:47:02 +00001137static inline bool sk_has_memory_pressure(const struct sock *sk)
1138{
1139 return sk->sk_prot->memory_pressure != NULL;
1140}
1141
1142static inline bool sk_under_memory_pressure(const struct sock *sk)
1143{
1144 if (!sk->sk_prot->memory_pressure)
1145 return false;
Glauber Costae1aab162011-12-11 21:47:03 +00001146
1147 if (mem_cgroup_sockets_enabled && sk->sk_cgrp)
Eric W. Biederman2e685ca2013-10-19 16:26:19 -07001148 return !!sk->sk_cgrp->memory_pressure;
Glauber Costae1aab162011-12-11 21:47:03 +00001149
Christoph Paasch35b87f62013-10-23 12:49:21 -07001150 return !!*sk->sk_prot->memory_pressure;
Glauber Costa180d8cd2011-12-11 21:47:02 +00001151}
1152
1153static inline void sk_leave_memory_pressure(struct sock *sk)
1154{
1155 int *memory_pressure = sk->sk_prot->memory_pressure;
1156
Glauber Costae1aab162011-12-11 21:47:03 +00001157 if (!memory_pressure)
1158 return;
1159
1160 if (*memory_pressure)
Glauber Costa180d8cd2011-12-11 21:47:02 +00001161 *memory_pressure = 0;
Glauber Costae1aab162011-12-11 21:47:03 +00001162
1163 if (mem_cgroup_sockets_enabled && sk->sk_cgrp) {
1164 struct cg_proto *cg_proto = sk->sk_cgrp;
1165 struct proto *prot = sk->sk_prot;
1166
1167 for (; cg_proto; cg_proto = parent_cg_proto(prot, cg_proto))
Eric W. Biederman7f2cbdc2013-12-04 20:12:04 -08001168 cg_proto->memory_pressure = 0;
Glauber Costae1aab162011-12-11 21:47:03 +00001169 }
1170
Glauber Costa180d8cd2011-12-11 21:47:02 +00001171}
1172
1173static inline void sk_enter_memory_pressure(struct sock *sk)
1174{
Glauber Costae1aab162011-12-11 21:47:03 +00001175 if (!sk->sk_prot->enter_memory_pressure)
1176 return;
1177
1178 if (mem_cgroup_sockets_enabled && sk->sk_cgrp) {
1179 struct cg_proto *cg_proto = sk->sk_cgrp;
1180 struct proto *prot = sk->sk_prot;
1181
1182 for (; cg_proto; cg_proto = parent_cg_proto(prot, cg_proto))
Eric W. Biederman7f2cbdc2013-12-04 20:12:04 -08001183 cg_proto->memory_pressure = 1;
Glauber Costae1aab162011-12-11 21:47:03 +00001184 }
1185
1186 sk->sk_prot->enter_memory_pressure(sk);
Glauber Costa180d8cd2011-12-11 21:47:02 +00001187}
1188
1189static inline long sk_prot_mem_limits(const struct sock *sk, int index)
1190{
1191 long *prot = sk->sk_prot->sysctl_mem;
Glauber Costae1aab162011-12-11 21:47:03 +00001192 if (mem_cgroup_sockets_enabled && sk->sk_cgrp)
1193 prot = sk->sk_cgrp->sysctl_mem;
Glauber Costa180d8cd2011-12-11 21:47:02 +00001194 return prot[index];
1195}
1196
Glauber Costae1aab162011-12-11 21:47:03 +00001197static inline void memcg_memory_allocated_add(struct cg_proto *prot,
1198 unsigned long amt,
1199 int *parent_status)
1200{
Johannes Weiner3e32cb22014-12-10 15:42:31 -08001201 page_counter_charge(&prot->memory_allocated, amt);
Glauber Costae1aab162011-12-11 21:47:03 +00001202
Johannes Weiner3e32cb22014-12-10 15:42:31 -08001203 if (page_counter_read(&prot->memory_allocated) >
1204 prot->memory_allocated.limit)
Glauber Costae1aab162011-12-11 21:47:03 +00001205 *parent_status = OVER_LIMIT;
1206}
1207
1208static inline void memcg_memory_allocated_sub(struct cg_proto *prot,
1209 unsigned long amt)
1210{
Johannes Weiner3e32cb22014-12-10 15:42:31 -08001211 page_counter_uncharge(&prot->memory_allocated, amt);
Glauber Costae1aab162011-12-11 21:47:03 +00001212}
1213
Glauber Costa180d8cd2011-12-11 21:47:02 +00001214static inline long
1215sk_memory_allocated(const struct sock *sk)
1216{
1217 struct proto *prot = sk->sk_prot;
Johannes Weiner3e32cb22014-12-10 15:42:31 -08001218
Glauber Costae1aab162011-12-11 21:47:03 +00001219 if (mem_cgroup_sockets_enabled && sk->sk_cgrp)
Johannes Weiner3e32cb22014-12-10 15:42:31 -08001220 return page_counter_read(&sk->sk_cgrp->memory_allocated);
Glauber Costae1aab162011-12-11 21:47:03 +00001221
Glauber Costa180d8cd2011-12-11 21:47:02 +00001222 return atomic_long_read(prot->memory_allocated);
1223}
1224
1225static inline long
Glauber Costae1aab162011-12-11 21:47:03 +00001226sk_memory_allocated_add(struct sock *sk, int amt, int *parent_status)
Glauber Costa180d8cd2011-12-11 21:47:02 +00001227{
1228 struct proto *prot = sk->sk_prot;
Glauber Costae1aab162011-12-11 21:47:03 +00001229
1230 if (mem_cgroup_sockets_enabled && sk->sk_cgrp) {
1231 memcg_memory_allocated_add(sk->sk_cgrp, amt, parent_status);
1232 /* update the root cgroup regardless */
1233 atomic_long_add_return(amt, prot->memory_allocated);
Johannes Weiner3e32cb22014-12-10 15:42:31 -08001234 return page_counter_read(&sk->sk_cgrp->memory_allocated);
Glauber Costae1aab162011-12-11 21:47:03 +00001235 }
1236
Glauber Costa180d8cd2011-12-11 21:47:02 +00001237 return atomic_long_add_return(amt, prot->memory_allocated);
1238}
1239
1240static inline void
Glauber Costa0e90b312012-01-20 04:57:16 +00001241sk_memory_allocated_sub(struct sock *sk, int amt)
Glauber Costa180d8cd2011-12-11 21:47:02 +00001242{
1243 struct proto *prot = sk->sk_prot;
Glauber Costae1aab162011-12-11 21:47:03 +00001244
Glauber Costa0e90b312012-01-20 04:57:16 +00001245 if (mem_cgroup_sockets_enabled && sk->sk_cgrp)
Glauber Costae1aab162011-12-11 21:47:03 +00001246 memcg_memory_allocated_sub(sk->sk_cgrp, amt);
1247
Glauber Costa180d8cd2011-12-11 21:47:02 +00001248 atomic_long_sub(amt, prot->memory_allocated);
1249}
1250
1251static inline void sk_sockets_allocated_dec(struct sock *sk)
1252{
1253 struct proto *prot = sk->sk_prot;
Glauber Costae1aab162011-12-11 21:47:03 +00001254
1255 if (mem_cgroup_sockets_enabled && sk->sk_cgrp) {
1256 struct cg_proto *cg_proto = sk->sk_cgrp;
1257
1258 for (; cg_proto; cg_proto = parent_cg_proto(prot, cg_proto))
Eric W. Biederman2e685ca2013-10-19 16:26:19 -07001259 percpu_counter_dec(&cg_proto->sockets_allocated);
Glauber Costae1aab162011-12-11 21:47:03 +00001260 }
1261
Glauber Costa180d8cd2011-12-11 21:47:02 +00001262 percpu_counter_dec(prot->sockets_allocated);
1263}
1264
1265static inline void sk_sockets_allocated_inc(struct sock *sk)
1266{
1267 struct proto *prot = sk->sk_prot;
Glauber Costae1aab162011-12-11 21:47:03 +00001268
1269 if (mem_cgroup_sockets_enabled && sk->sk_cgrp) {
1270 struct cg_proto *cg_proto = sk->sk_cgrp;
1271
1272 for (; cg_proto; cg_proto = parent_cg_proto(prot, cg_proto))
Eric W. Biederman2e685ca2013-10-19 16:26:19 -07001273 percpu_counter_inc(&cg_proto->sockets_allocated);
Glauber Costae1aab162011-12-11 21:47:03 +00001274 }
1275
Glauber Costa180d8cd2011-12-11 21:47:02 +00001276 percpu_counter_inc(prot->sockets_allocated);
1277}
1278
1279static inline int
1280sk_sockets_allocated_read_positive(struct sock *sk)
1281{
1282 struct proto *prot = sk->sk_prot;
1283
Glauber Costae1aab162011-12-11 21:47:03 +00001284 if (mem_cgroup_sockets_enabled && sk->sk_cgrp)
Eric W. Biederman2e685ca2013-10-19 16:26:19 -07001285 return percpu_counter_read_positive(&sk->sk_cgrp->sockets_allocated);
Glauber Costae1aab162011-12-11 21:47:03 +00001286
Eric Dumazet518fbf92012-04-28 23:21:56 +00001287 return percpu_counter_read_positive(prot->sockets_allocated);
Glauber Costa180d8cd2011-12-11 21:47:02 +00001288}
1289
1290static inline int
1291proto_sockets_allocated_sum_positive(struct proto *prot)
1292{
1293 return percpu_counter_sum_positive(prot->sockets_allocated);
1294}
1295
1296static inline long
1297proto_memory_allocated(struct proto *prot)
1298{
1299 return atomic_long_read(prot->memory_allocated);
1300}
1301
1302static inline bool
1303proto_memory_pressure(struct proto *prot)
1304{
1305 if (!prot->memory_pressure)
1306 return false;
1307 return !!*prot->memory_pressure;
1308}
1309
Eric Dumazet65f76512008-01-03 20:46:48 -08001310
1311#ifdef CONFIG_PROC_FS
Linus Torvalds1da177e2005-04-16 15:20:36 -07001312/* Called with local bh disabled */
Joe Perches69336bd2013-09-22 10:32:26 -07001313void sock_prot_inuse_add(struct net *net, struct proto *prot, int inc);
1314int sock_prot_inuse_get(struct net *net, struct proto *proto);
Eric Dumazet65f76512008-01-03 20:46:48 -08001315#else
Eric Dumazetdc6b9b72012-05-16 22:48:15 +00001316static inline void sock_prot_inuse_add(struct net *net, struct proto *prot,
Pavel Emelyanovc29a0bc2008-03-31 19:41:46 -07001317 int inc)
Eric Dumazet65f76512008-01-03 20:46:48 -08001318{
1319}
Eric Dumazet65f76512008-01-03 20:46:48 -08001320#endif
1321
Linus Torvalds1da177e2005-04-16 15:20:36 -07001322
Arnaldo Carvalho de Melo614c6cb2005-08-09 19:47:37 -07001323/* With per-bucket locks this operation is not-atomic, so that
1324 * this version is not worse.
1325 */
1326static inline void __sk_prot_rehash(struct sock *sk)
1327{
1328 sk->sk_prot->unhash(sk);
1329 sk->sk_prot->hash(sk);
1330}
1331
Octavian Purdilafcbdf092010-12-16 14:26:56 -08001332void sk_prot_clear_portaddr_nulls(struct sock *sk, int size);
1333
Linus Torvalds1da177e2005-04-16 15:20:36 -07001334/* About 10 seconds */
1335#define SOCK_DESTROY_TIME (10*HZ)
1336
1337/* Sockets 0-1023 can't be bound to unless you are superuser */
1338#define PROT_SOCK 1024
1339
1340#define SHUTDOWN_MASK 3
1341#define RCV_SHUTDOWN 1
1342#define SEND_SHUTDOWN 2
1343
1344#define SOCK_SNDBUF_LOCK 1
1345#define SOCK_RCVBUF_LOCK 2
1346#define SOCK_BINDADDR_LOCK 4
1347#define SOCK_BINDPORT_LOCK 8
1348
Linus Torvalds1da177e2005-04-16 15:20:36 -07001349struct socket_alloc {
1350 struct socket socket;
1351 struct inode vfs_inode;
1352};
1353
1354static inline struct socket *SOCKET_I(struct inode *inode)
1355{
1356 return &container_of(inode, struct socket_alloc, vfs_inode)->socket;
1357}
1358
1359static inline struct inode *SOCK_INODE(struct socket *socket)
1360{
1361 return &container_of(socket, struct socket_alloc, socket)->vfs_inode;
1362}
1363
Hideo Aoki3ab224b2007-12-31 00:11:19 -08001364/*
1365 * Functions for memory accounting
1366 */
Joe Perches69336bd2013-09-22 10:32:26 -07001367int __sk_mem_schedule(struct sock *sk, int size, int kind);
1368void __sk_mem_reclaim(struct sock *sk);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001369
Hideo Aoki3ab224b2007-12-31 00:11:19 -08001370#define SK_MEM_QUANTUM ((int)PAGE_SIZE)
1371#define SK_MEM_QUANTUM_SHIFT ilog2(SK_MEM_QUANTUM)
1372#define SK_MEM_SEND 0
1373#define SK_MEM_RECV 1
Linus Torvalds1da177e2005-04-16 15:20:36 -07001374
Hideo Aoki3ab224b2007-12-31 00:11:19 -08001375static inline int sk_mem_pages(int amt)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001376{
Hideo Aoki3ab224b2007-12-31 00:11:19 -08001377 return (amt + SK_MEM_QUANTUM - 1) >> SK_MEM_QUANTUM_SHIFT;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001378}
1379
Eric Dumazetdc6b9b72012-05-16 22:48:15 +00001380static inline bool sk_has_account(struct sock *sk)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001381{
Hideo Aoki3ab224b2007-12-31 00:11:19 -08001382 /* return true if protocol supports memory accounting */
1383 return !!sk->sk_prot->memory_allocated;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001384}
1385
Eric Dumazetdc6b9b72012-05-16 22:48:15 +00001386static inline bool sk_wmem_schedule(struct sock *sk, int size)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001387{
Hideo Aoki3ab224b2007-12-31 00:11:19 -08001388 if (!sk_has_account(sk))
Eric Dumazetdc6b9b72012-05-16 22:48:15 +00001389 return true;
Herbert Xud80d99d2005-09-01 17:48:23 -07001390 return size <= sk->sk_forward_alloc ||
Hideo Aoki3ab224b2007-12-31 00:11:19 -08001391 __sk_mem_schedule(sk, size, SK_MEM_SEND);
1392}
1393
Mel Gormanc76562b2012-07-31 16:44:41 -07001394static inline bool
Chuck Lever35c448a2012-09-17 14:09:11 -07001395sk_rmem_schedule(struct sock *sk, struct sk_buff *skb, int size)
Hideo Aoki3ab224b2007-12-31 00:11:19 -08001396{
1397 if (!sk_has_account(sk))
Eric Dumazetdc6b9b72012-05-16 22:48:15 +00001398 return true;
Mel Gormanc76562b2012-07-31 16:44:41 -07001399 return size<= sk->sk_forward_alloc ||
1400 __sk_mem_schedule(sk, size, SK_MEM_RECV) ||
1401 skb_pfmemalloc(skb);
Hideo Aoki3ab224b2007-12-31 00:11:19 -08001402}
1403
1404static inline void sk_mem_reclaim(struct sock *sk)
1405{
1406 if (!sk_has_account(sk))
1407 return;
1408 if (sk->sk_forward_alloc >= SK_MEM_QUANTUM)
1409 __sk_mem_reclaim(sk);
1410}
1411
David S. Miller9993e7d2008-01-10 21:56:38 -08001412static inline void sk_mem_reclaim_partial(struct sock *sk)
1413{
1414 if (!sk_has_account(sk))
1415 return;
1416 if (sk->sk_forward_alloc > SK_MEM_QUANTUM)
1417 __sk_mem_reclaim(sk);
1418}
1419
Hideo Aoki3ab224b2007-12-31 00:11:19 -08001420static inline void sk_mem_charge(struct sock *sk, int size)
1421{
1422 if (!sk_has_account(sk))
1423 return;
1424 sk->sk_forward_alloc -= size;
1425}
1426
1427static inline void sk_mem_uncharge(struct sock *sk, int size)
1428{
1429 if (!sk_has_account(sk))
1430 return;
1431 sk->sk_forward_alloc += size;
1432}
1433
1434static inline void sk_wmem_free_skb(struct sock *sk, struct sk_buff *skb)
1435{
Hideo Aoki3ab224b2007-12-31 00:11:19 -08001436 sock_set_flag(sk, SOCK_QUEUE_SHRUNK);
1437 sk->sk_wmem_queued -= skb->truesize;
1438 sk_mem_uncharge(sk, skb->truesize);
1439 __kfree_skb(skb);
Herbert Xud80d99d2005-09-01 17:48:23 -07001440}
1441
Linus Torvalds1da177e2005-04-16 15:20:36 -07001442/* Used by processes to "lock" a socket state, so that
1443 * interrupts and bottom half handlers won't change it
1444 * from under us. It essentially blocks any incoming
1445 * packets, so that we won't get any new data or any
1446 * packets that change the state of the socket.
1447 *
1448 * While locked, BH processing will add new packets to
1449 * the backlog queue. This queue is processed by the
1450 * owner of the socket lock right before it is released.
1451 *
1452 * Since ~2.3.5 it is also exclusive sleep lock serializing
1453 * accesses from user process context.
1454 */
John Heffnerd2e91172007-09-12 10:44:19 +02001455#define sock_owned_by_user(sk) ((sk)->sk_lock.owned)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001456
Eric Dumazetc3f9b012014-03-10 09:50:11 -07001457static inline void sock_release_ownership(struct sock *sk)
1458{
1459 sk->sk_lock.owned = 0;
1460}
1461
Peter Zijlstraed075362006-12-06 20:35:24 -08001462/*
1463 * Macro so as to not evaluate some arguments when
1464 * lockdep is not enabled.
1465 *
1466 * Mark both the sk_lock and the sk_lock.slock as a
1467 * per-address-family lock class.
1468 */
Eric Dumazetdc6b9b72012-05-16 22:48:15 +00001469#define sock_lock_init_class_and_name(sk, sname, skey, name, key) \
Peter Zijlstraed075362006-12-06 20:35:24 -08001470do { \
Ingo Molnare8f6fbf2008-11-12 01:38:36 +00001471 sk->sk_lock.owned = 0; \
Peter Zijlstraed075362006-12-06 20:35:24 -08001472 init_waitqueue_head(&sk->sk_lock.wq); \
1473 spin_lock_init(&(sk)->sk_lock.slock); \
1474 debug_check_no_locks_freed((void *)&(sk)->sk_lock, \
1475 sizeof((sk)->sk_lock)); \
1476 lockdep_set_class_and_name(&(sk)->sk_lock.slock, \
Eric Dumazetdc6b9b72012-05-16 22:48:15 +00001477 (skey), (sname)); \
Peter Zijlstraed075362006-12-06 20:35:24 -08001478 lockdep_init_map(&(sk)->sk_lock.dep_map, (name), (key), 0); \
1479} while (0)
1480
Joe Perches69336bd2013-09-22 10:32:26 -07001481void lock_sock_nested(struct sock *sk, int subclass);
Peter Zijlstrafcc70d52006-11-08 22:44:35 -08001482
1483static inline void lock_sock(struct sock *sk)
1484{
1485 lock_sock_nested(sk, 0);
1486}
1487
Joe Perches69336bd2013-09-22 10:32:26 -07001488void release_sock(struct sock *sk);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001489
1490/* BH context may only use the following locking interface. */
1491#define bh_lock_sock(__sk) spin_lock(&((__sk)->sk_lock.slock))
Ingo Molnarc6366182006-07-03 00:25:13 -07001492#define bh_lock_sock_nested(__sk) \
1493 spin_lock_nested(&((__sk)->sk_lock.slock), \
1494 SINGLE_DEPTH_NESTING)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001495#define bh_unlock_sock(__sk) spin_unlock(&((__sk)->sk_lock.slock))
1496
Joe Perches69336bd2013-09-22 10:32:26 -07001497bool lock_sock_fast(struct sock *sk);
Eric Dumazet8a74ad62010-05-26 19:20:18 +00001498/**
1499 * unlock_sock_fast - complement of lock_sock_fast
1500 * @sk: socket
1501 * @slow: slow mode
1502 *
1503 * fast unlock socket for user context.
1504 * If slow mode is on, we call regular release_sock()
1505 */
1506static inline void unlock_sock_fast(struct sock *sk, bool slow)
Eric Dumazet4b0b72f2010-04-28 14:35:48 -07001507{
Eric Dumazet8a74ad62010-05-26 19:20:18 +00001508 if (slow)
1509 release_sock(sk);
1510 else
1511 spin_unlock_bh(&sk->sk_lock.slock);
Eric Dumazet4b0b72f2010-04-28 14:35:48 -07001512}
1513
Eric Dumazet4b0b72f2010-04-28 14:35:48 -07001514
Joe Perches69336bd2013-09-22 10:32:26 -07001515struct sock *sk_alloc(struct net *net, int family, gfp_t priority,
1516 struct proto *prot);
1517void sk_free(struct sock *sk);
1518void sk_release_kernel(struct sock *sk);
1519struct sock *sk_clone_lock(const struct sock *sk, const gfp_t priority);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001520
Joe Perches69336bd2013-09-22 10:32:26 -07001521struct sk_buff *sock_wmalloc(struct sock *sk, unsigned long size, int force,
1522 gfp_t priority);
Joe Perches69336bd2013-09-22 10:32:26 -07001523void sock_wfree(struct sk_buff *skb);
1524void skb_orphan_partial(struct sk_buff *skb);
1525void sock_rfree(struct sk_buff *skb);
Alexander Duyck62bccb82014-09-04 13:31:35 -04001526void sock_efree(struct sk_buff *skb);
Alexander Duyck82eabd92014-09-04 13:32:11 -04001527#ifdef CONFIG_INET
Joe Perches69336bd2013-09-22 10:32:26 -07001528void sock_edemux(struct sk_buff *skb);
Alexander Duyck82eabd92014-09-04 13:32:11 -04001529#else
1530#define sock_edemux(skb) sock_efree(skb)
1531#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -07001532
Joe Perches69336bd2013-09-22 10:32:26 -07001533int sock_setsockopt(struct socket *sock, int level, int op,
1534 char __user *optval, unsigned int optlen);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001535
Joe Perches69336bd2013-09-22 10:32:26 -07001536int sock_getsockopt(struct socket *sock, int level, int op,
1537 char __user *optval, int __user *optlen);
1538struct sk_buff *sock_alloc_send_skb(struct sock *sk, unsigned long size,
1539 int noblock, int *errcode);
1540struct sk_buff *sock_alloc_send_pskb(struct sock *sk, unsigned long header_len,
1541 unsigned long data_len, int noblock,
1542 int *errcode, int max_page_order);
1543void *sock_kmalloc(struct sock *sk, int size, gfp_t priority);
1544void sock_kfree_s(struct sock *sk, void *mem, int size);
Daniel Borkmann79e88652014-11-19 17:13:11 +01001545void sock_kzfree_s(struct sock *sk, void *mem, int size);
Joe Perches69336bd2013-09-22 10:32:26 -07001546void sk_send_sigurg(struct sock *sk);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001547
1548/*
1549 * Functions to fill in entries in struct proto_ops when a protocol
1550 * does not implement a particular function.
1551 */
Joe Perches69336bd2013-09-22 10:32:26 -07001552int sock_no_bind(struct socket *, struct sockaddr *, int);
1553int sock_no_connect(struct socket *, struct sockaddr *, int, int);
1554int sock_no_socketpair(struct socket *, struct socket *);
1555int sock_no_accept(struct socket *, struct socket *, int);
1556int sock_no_getname(struct socket *, struct sockaddr *, int *, int);
1557unsigned int sock_no_poll(struct file *, struct socket *,
1558 struct poll_table_struct *);
1559int sock_no_ioctl(struct socket *, unsigned int, unsigned long);
1560int sock_no_listen(struct socket *, int);
1561int sock_no_shutdown(struct socket *, int);
1562int sock_no_getsockopt(struct socket *, int , int, char __user *, int __user *);
1563int sock_no_setsockopt(struct socket *, int, int, char __user *, unsigned int);
Ying Xue1b784142015-03-02 15:37:48 +08001564int sock_no_sendmsg(struct socket *, struct msghdr *, size_t);
1565int sock_no_recvmsg(struct socket *, struct msghdr *, size_t, int);
Joe Perches69336bd2013-09-22 10:32:26 -07001566int sock_no_mmap(struct file *file, struct socket *sock,
1567 struct vm_area_struct *vma);
1568ssize_t sock_no_sendpage(struct socket *sock, struct page *page, int offset,
1569 size_t size, int flags);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001570
1571/*
1572 * Functions to fill in entries in struct proto_ops when a protocol
1573 * uses the inet style.
1574 */
Joe Perches69336bd2013-09-22 10:32:26 -07001575int sock_common_getsockopt(struct socket *sock, int level, int optname,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001576 char __user *optval, int __user *optlen);
Ying Xue1b784142015-03-02 15:37:48 +08001577int sock_common_recvmsg(struct socket *sock, struct msghdr *msg, size_t size,
1578 int flags);
Joe Perches69336bd2013-09-22 10:32:26 -07001579int sock_common_setsockopt(struct socket *sock, int level, int optname,
David S. Millerb7058842009-09-30 16:12:20 -07001580 char __user *optval, unsigned int optlen);
Joe Perches69336bd2013-09-22 10:32:26 -07001581int compat_sock_common_getsockopt(struct socket *sock, int level,
Dmitry Mishin3fdadf72006-03-20 22:45:21 -08001582 int optname, char __user *optval, int __user *optlen);
Joe Perches69336bd2013-09-22 10:32:26 -07001583int compat_sock_common_setsockopt(struct socket *sock, int level,
David S. Millerb7058842009-09-30 16:12:20 -07001584 int optname, char __user *optval, unsigned int optlen);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001585
Joe Perches69336bd2013-09-22 10:32:26 -07001586void sk_common_release(struct sock *sk);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001587
1588/*
1589 * Default socket callbacks and setup code
1590 */
Eric Dumazetdc6b9b72012-05-16 22:48:15 +00001591
Linus Torvalds1da177e2005-04-16 15:20:36 -07001592/* Initialise core socket variables */
Joe Perches69336bd2013-09-22 10:32:26 -07001593void sock_init_data(struct socket *sock, struct sock *sk);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001594
Linus Torvalds1da177e2005-04-16 15:20:36 -07001595/*
1596 * Socket reference counting postulates.
1597 *
1598 * * Each user of socket SHOULD hold a reference count.
1599 * * Each access point to socket (an hash table bucket, reference from a list,
1600 * running timer, skb in flight MUST hold a reference count.
1601 * * When reference count hits 0, it means it will never increase back.
1602 * * When reference count hits 0, it means that no references from
1603 * outside exist to this socket and current process on current CPU
1604 * is last user and may/should destroy this socket.
1605 * * sk_free is called from any context: process, BH, IRQ. When
1606 * it is called, socket has no references from outside -> sk_free
1607 * may release descendant resources allocated by the socket, but
1608 * to the time when it is called, socket is NOT referenced by any
1609 * hash tables, lists etc.
1610 * * Packets, delivered from outside (from network or from another process)
1611 * and enqueued on receive/error queues SHOULD NOT grab reference count,
1612 * when they sit in queue. Otherwise, packets will leak to hole, when
1613 * socket is looked up by one cpu and unhasing is made by another CPU.
1614 * It is true for udp/raw, netlink (leak to receive and error queues), tcp
1615 * (leak to backlog). Packet socket does all the processing inside
1616 * BR_NETPROTO_LOCK, so that it has not this race condition. UNIX sockets
1617 * use separate SMP lock, so that they are prone too.
1618 */
1619
1620/* Ungrab socket and destroy it, if it was the last reference. */
1621static inline void sock_put(struct sock *sk)
1622{
1623 if (atomic_dec_and_test(&sk->sk_refcnt))
1624 sk_free(sk);
1625}
Eric Dumazet05dbc7b2013-10-03 00:22:02 -07001626/* Generic version of sock_put(), dealing with all sockets
1627 * (TCP_TIMEWAIT, ESTABLISHED...)
1628 */
1629void sock_gen_put(struct sock *sk);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001630
Joe Perches69336bd2013-09-22 10:32:26 -07001631int sk_receive_skb(struct sock *sk, struct sk_buff *skb, const int nested);
Arnaldo Carvalho de Melo25995ff2005-12-27 02:42:22 -02001632
Krishna Kumare022f0b2009-10-19 23:46:20 +00001633static inline void sk_tx_queue_set(struct sock *sk, int tx_queue)
1634{
1635 sk->sk_tx_queue_mapping = tx_queue;
1636}
1637
1638static inline void sk_tx_queue_clear(struct sock *sk)
1639{
1640 sk->sk_tx_queue_mapping = -1;
1641}
1642
1643static inline int sk_tx_queue_get(const struct sock *sk)
1644{
Tom Herbertb0f77d02010-07-14 20:50:29 -07001645 return sk ? sk->sk_tx_queue_mapping : -1;
Krishna Kumare022f0b2009-10-19 23:46:20 +00001646}
1647
David S. Miller972692e2008-06-17 22:41:38 -07001648static inline void sk_set_socket(struct sock *sk, struct socket *sock)
1649{
Krishna Kumare022f0b2009-10-19 23:46:20 +00001650 sk_tx_queue_clear(sk);
David S. Miller972692e2008-06-17 22:41:38 -07001651 sk->sk_socket = sock;
1652}
1653
Eric Dumazetaa395142010-04-20 13:03:51 +00001654static inline wait_queue_head_t *sk_sleep(struct sock *sk)
1655{
Eric Dumazeteaefd112011-02-18 03:26:36 +00001656 BUILD_BUG_ON(offsetof(struct socket_wq, wait) != 0);
1657 return &rcu_dereference_raw(sk->sk_wq)->wait;
Eric Dumazetaa395142010-04-20 13:03:51 +00001658}
Linus Torvalds1da177e2005-04-16 15:20:36 -07001659/* Detach socket from process context.
1660 * Announce socket dead, detach it from wait queue and inode.
1661 * Note that parent inode held reference count on this struct sock,
1662 * we do not release it in this function, because protocol
1663 * probably wants some additional cleanups or even continuing
1664 * to work with this socket (TCP).
1665 */
1666static inline void sock_orphan(struct sock *sk)
1667{
1668 write_lock_bh(&sk->sk_callback_lock);
1669 sock_set_flag(sk, SOCK_DEAD);
David S. Miller972692e2008-06-17 22:41:38 -07001670 sk_set_socket(sk, NULL);
Eric Dumazet43815482010-04-29 11:01:49 +00001671 sk->sk_wq = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001672 write_unlock_bh(&sk->sk_callback_lock);
1673}
1674
1675static inline void sock_graft(struct sock *sk, struct socket *parent)
1676{
1677 write_lock_bh(&sk->sk_callback_lock);
Eric Dumazeteaefd112011-02-18 03:26:36 +00001678 sk->sk_wq = parent->wq;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001679 parent->sk = sk;
David S. Miller972692e2008-06-17 22:41:38 -07001680 sk_set_socket(sk, parent);
Venkat Yekkirala4237c752006-07-24 23:32:50 -07001681 security_sock_graft(sk, parent);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001682 write_unlock_bh(&sk->sk_callback_lock);
1683}
1684
Joe Perches69336bd2013-09-22 10:32:26 -07001685kuid_t sock_i_uid(struct sock *sk);
1686unsigned long sock_i_ino(struct sock *sk);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001687
1688static inline struct dst_entry *
1689__sk_dst_get(struct sock *sk)
1690{
Michal Hockod8bf4ca2011-07-08 14:39:41 +02001691 return rcu_dereference_check(sk->sk_dst_cache, sock_owned_by_user(sk) ||
Eric Dumazetf68c2242010-04-22 16:06:59 -07001692 lockdep_is_held(&sk->sk_lock.slock));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001693}
1694
1695static inline struct dst_entry *
1696sk_dst_get(struct sock *sk)
1697{
1698 struct dst_entry *dst;
1699
Eric Dumazetb6c67122010-04-08 23:03:29 +00001700 rcu_read_lock();
1701 dst = rcu_dereference(sk->sk_dst_cache);
Eric Dumazetf8864972014-06-24 10:05:11 -07001702 if (dst && !atomic_inc_not_zero(&dst->__refcnt))
1703 dst = NULL;
Eric Dumazetb6c67122010-04-08 23:03:29 +00001704 rcu_read_unlock();
Linus Torvalds1da177e2005-04-16 15:20:36 -07001705 return dst;
1706}
1707
Eric Dumazetb6c67122010-04-08 23:03:29 +00001708static inline void dst_negative_advice(struct sock *sk)
1709{
1710 struct dst_entry *ndst, *dst = __sk_dst_get(sk);
1711
1712 if (dst && dst->ops->negative_advice) {
1713 ndst = dst->ops->negative_advice(dst);
1714
1715 if (ndst != dst) {
1716 rcu_assign_pointer(sk->sk_dst_cache, ndst);
ZHAO Gang0a6957e2013-10-22 16:23:38 +08001717 sk_tx_queue_clear(sk);
Eric Dumazetb6c67122010-04-08 23:03:29 +00001718 }
1719 }
1720}
1721
Linus Torvalds1da177e2005-04-16 15:20:36 -07001722static inline void
1723__sk_dst_set(struct sock *sk, struct dst_entry *dst)
1724{
1725 struct dst_entry *old_dst;
1726
Krishna Kumare022f0b2009-10-19 23:46:20 +00001727 sk_tx_queue_clear(sk);
Eric Dumazet0b53ff22010-04-26 20:40:43 +00001728 /*
1729 * This can be called while sk is owned by the caller only,
1730 * with no state that can be checked in a rcu_dereference_check() cond
1731 */
1732 old_dst = rcu_dereference_raw(sk->sk_dst_cache);
Eric Dumazetb6c67122010-04-08 23:03:29 +00001733 rcu_assign_pointer(sk->sk_dst_cache, dst);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001734 dst_release(old_dst);
1735}
1736
1737static inline void
1738sk_dst_set(struct sock *sk, struct dst_entry *dst)
1739{
Eric Dumazet7f502362014-06-30 01:26:23 -07001740 struct dst_entry *old_dst;
1741
1742 sk_tx_queue_clear(sk);
Eric Dumazet5925a052014-07-02 02:39:38 -07001743 old_dst = xchg((__force struct dst_entry **)&sk->sk_dst_cache, dst);
Eric Dumazet7f502362014-06-30 01:26:23 -07001744 dst_release(old_dst);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001745}
1746
1747static inline void
1748__sk_dst_reset(struct sock *sk)
1749{
Eric Dumazetb6c67122010-04-08 23:03:29 +00001750 __sk_dst_set(sk, NULL);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001751}
1752
1753static inline void
1754sk_dst_reset(struct sock *sk)
1755{
Eric Dumazet7f502362014-06-30 01:26:23 -07001756 sk_dst_set(sk, NULL);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001757}
1758
Joe Perches69336bd2013-09-22 10:32:26 -07001759struct dst_entry *__sk_dst_check(struct sock *sk, u32 cookie);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001760
Joe Perches69336bd2013-09-22 10:32:26 -07001761struct dst_entry *sk_dst_check(struct sock *sk, u32 cookie);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001762
Eric Dumazetdc6b9b72012-05-16 22:48:15 +00001763static inline bool sk_can_gso(const struct sock *sk)
Herbert Xubcd76112006-06-30 13:36:35 -07001764{
1765 return net_gso_ok(sk->sk_route_caps, sk->sk_gso_type);
1766}
1767
Joe Perches69336bd2013-09-22 10:32:26 -07001768void sk_setup_caps(struct sock *sk, struct dst_entry *dst);
Arnaldo Carvalho de Melo6cbb0df2005-08-09 19:49:02 -07001769
Michał Mirosławc8f44af2011-11-15 15:29:55 +00001770static inline void sk_nocaps_add(struct sock *sk, netdev_features_t flags)
Eric Dumazeta4654192010-05-16 00:36:33 -07001771{
1772 sk->sk_route_nocaps |= flags;
1773 sk->sk_route_caps &= ~flags;
1774}
1775
Tom Herbertc6e1a0d2011-04-04 22:30:30 -07001776static inline int skb_do_copy_data_nocache(struct sock *sk, struct sk_buff *skb,
Al Viro57be5bd2014-11-28 13:40:20 -05001777 struct iov_iter *from, char *to,
Wei Yongjun912d3982011-04-06 18:40:12 +00001778 int copy, int offset)
Tom Herbertc6e1a0d2011-04-04 22:30:30 -07001779{
1780 if (skb->ip_summed == CHECKSUM_NONE) {
Al Viro57be5bd2014-11-28 13:40:20 -05001781 __wsum csum = 0;
1782 if (csum_and_copy_from_iter(to, copy, &csum, from) != copy)
1783 return -EFAULT;
Wei Yongjun912d3982011-04-06 18:40:12 +00001784 skb->csum = csum_block_add(skb->csum, csum, offset);
Tom Herbertc6e1a0d2011-04-04 22:30:30 -07001785 } else if (sk->sk_route_caps & NETIF_F_NOCACHE_COPY) {
Al Viro57be5bd2014-11-28 13:40:20 -05001786 if (copy_from_iter_nocache(to, copy, from) != copy)
Tom Herbertc6e1a0d2011-04-04 22:30:30 -07001787 return -EFAULT;
Al Viro57be5bd2014-11-28 13:40:20 -05001788 } else if (copy_from_iter(to, copy, from) != copy)
Tom Herbertc6e1a0d2011-04-04 22:30:30 -07001789 return -EFAULT;
1790
1791 return 0;
1792}
1793
1794static inline int skb_add_data_nocache(struct sock *sk, struct sk_buff *skb,
Al Viro57be5bd2014-11-28 13:40:20 -05001795 struct iov_iter *from, int copy)
Tom Herbertc6e1a0d2011-04-04 22:30:30 -07001796{
Wei Yongjun912d3982011-04-06 18:40:12 +00001797 int err, offset = skb->len;
Tom Herbertc6e1a0d2011-04-04 22:30:30 -07001798
Wei Yongjun912d3982011-04-06 18:40:12 +00001799 err = skb_do_copy_data_nocache(sk, skb, from, skb_put(skb, copy),
1800 copy, offset);
Tom Herbertc6e1a0d2011-04-04 22:30:30 -07001801 if (err)
Wei Yongjun912d3982011-04-06 18:40:12 +00001802 __skb_trim(skb, offset);
Tom Herbertc6e1a0d2011-04-04 22:30:30 -07001803
1804 return err;
1805}
1806
Al Viro57be5bd2014-11-28 13:40:20 -05001807static inline int skb_copy_to_page_nocache(struct sock *sk, struct iov_iter *from,
Tom Herbertc6e1a0d2011-04-04 22:30:30 -07001808 struct sk_buff *skb,
1809 struct page *page,
1810 int off, int copy)
1811{
1812 int err;
1813
Wei Yongjun912d3982011-04-06 18:40:12 +00001814 err = skb_do_copy_data_nocache(sk, skb, from, page_address(page) + off,
1815 copy, skb->len);
Tom Herbertc6e1a0d2011-04-04 22:30:30 -07001816 if (err)
1817 return err;
1818
1819 skb->len += copy;
1820 skb->data_len += copy;
1821 skb->truesize += copy;
1822 sk->sk_wmem_queued += copy;
1823 sk_mem_charge(sk, copy);
1824 return 0;
1825}
1826
Eric Dumazetc5640392009-06-16 10:12:03 +00001827/**
1828 * sk_wmem_alloc_get - returns write allocations
1829 * @sk: socket
1830 *
1831 * Returns sk_wmem_alloc minus initial offset of one
1832 */
1833static inline int sk_wmem_alloc_get(const struct sock *sk)
1834{
1835 return atomic_read(&sk->sk_wmem_alloc) - 1;
1836}
1837
1838/**
1839 * sk_rmem_alloc_get - returns read allocations
1840 * @sk: socket
1841 *
1842 * Returns sk_rmem_alloc
1843 */
1844static inline int sk_rmem_alloc_get(const struct sock *sk)
1845{
1846 return atomic_read(&sk->sk_rmem_alloc);
1847}
1848
1849/**
1850 * sk_has_allocations - check if allocations are outstanding
1851 * @sk: socket
1852 *
1853 * Returns true if socket has write or read allocations
1854 */
Eric Dumazetdc6b9b72012-05-16 22:48:15 +00001855static inline bool sk_has_allocations(const struct sock *sk)
Eric Dumazetc5640392009-06-16 10:12:03 +00001856{
1857 return sk_wmem_alloc_get(sk) || sk_rmem_alloc_get(sk);
1858}
1859
Jiri Olsaa57de0b2009-07-08 12:09:13 +00001860/**
Eric Dumazet43815482010-04-29 11:01:49 +00001861 * wq_has_sleeper - check if there are any waiting processes
Randy Dunlapacfbe962010-05-24 23:54:18 -07001862 * @wq: struct socket_wq
Jiri Olsaa57de0b2009-07-08 12:09:13 +00001863 *
Eric Dumazet43815482010-04-29 11:01:49 +00001864 * Returns true if socket_wq has waiting processes
Jiri Olsaa57de0b2009-07-08 12:09:13 +00001865 *
Eric Dumazet43815482010-04-29 11:01:49 +00001866 * The purpose of the wq_has_sleeper and sock_poll_wait is to wrap the memory
Jiri Olsaa57de0b2009-07-08 12:09:13 +00001867 * barrier call. They were added due to the race found within the tcp code.
1868 *
1869 * Consider following tcp code paths:
1870 *
1871 * CPU1 CPU2
1872 *
1873 * sys_select receive packet
1874 * ... ...
1875 * __add_wait_queue update tp->rcv_nxt
1876 * ... ...
1877 * tp->rcv_nxt check sock_def_readable
1878 * ... {
Eric Dumazet43815482010-04-29 11:01:49 +00001879 * schedule rcu_read_lock();
1880 * wq = rcu_dereference(sk->sk_wq);
1881 * if (wq && waitqueue_active(&wq->wait))
1882 * wake_up_interruptible(&wq->wait)
Jiri Olsaa57de0b2009-07-08 12:09:13 +00001883 * ...
1884 * }
1885 *
1886 * The race for tcp fires when the __add_wait_queue changes done by CPU1 stay
1887 * in its cache, and so does the tp->rcv_nxt update on CPU2 side. The CPU1
1888 * could then endup calling schedule and sleep forever if there are no more
1889 * data on the socket.
Jiri Olsaad462762009-07-08 12:10:31 +00001890 *
Jiri Olsaa57de0b2009-07-08 12:09:13 +00001891 */
Eric Dumazet43815482010-04-29 11:01:49 +00001892static inline bool wq_has_sleeper(struct socket_wq *wq)
Jiri Olsaa57de0b2009-07-08 12:09:13 +00001893{
Eric Dumazetdc6b9b72012-05-16 22:48:15 +00001894 /* We need to be sure we are in sync with the
Jiri Olsaa57de0b2009-07-08 12:09:13 +00001895 * add_wait_queue modifications to the wait queue.
1896 *
1897 * This memory barrier is paired in the sock_poll_wait.
1898 */
Eric Dumazet43815482010-04-29 11:01:49 +00001899 smp_mb();
1900 return wq && waitqueue_active(&wq->wait);
Jiri Olsaa57de0b2009-07-08 12:09:13 +00001901}
1902
1903/**
1904 * sock_poll_wait - place memory barrier behind the poll_wait call.
1905 * @filp: file
1906 * @wait_address: socket wait queue
1907 * @p: poll_table
1908 *
Eric Dumazet43815482010-04-29 11:01:49 +00001909 * See the comments in the wq_has_sleeper function.
Jiri Olsaa57de0b2009-07-08 12:09:13 +00001910 */
1911static inline void sock_poll_wait(struct file *filp,
1912 wait_queue_head_t *wait_address, poll_table *p)
1913{
Hans Verkuil626cf232012-03-23 15:02:27 -07001914 if (!poll_does_not_wait(p) && wait_address) {
Jiri Olsaa57de0b2009-07-08 12:09:13 +00001915 poll_wait(filp, wait_address, p);
Eric Dumazetdc6b9b72012-05-16 22:48:15 +00001916 /* We need to be sure we are in sync with the
Jiri Olsaa57de0b2009-07-08 12:09:13 +00001917 * socket flags modification.
1918 *
Eric Dumazet43815482010-04-29 11:01:49 +00001919 * This memory barrier is paired in the wq_has_sleeper.
Eric Dumazetdc6b9b72012-05-16 22:48:15 +00001920 */
Jiri Olsaa57de0b2009-07-08 12:09:13 +00001921 smp_mb();
1922 }
1923}
1924
Tom Herbertb73c3d02014-07-01 21:32:17 -07001925static inline void skb_set_hash_from_sk(struct sk_buff *skb, struct sock *sk)
1926{
1927 if (sk->sk_txhash) {
1928 skb->l4_hash = 1;
1929 skb->hash = sk->sk_txhash;
1930 }
1931}
1932
Linus Torvalds1da177e2005-04-16 15:20:36 -07001933/*
Eric Dumazetdc6b9b72012-05-16 22:48:15 +00001934 * Queue a received datagram if it will fit. Stream and sequenced
Linus Torvalds1da177e2005-04-16 15:20:36 -07001935 * protocols can't normally use this as they need to fit buffers in
1936 * and play with them.
1937 *
Eric Dumazetdc6b9b72012-05-16 22:48:15 +00001938 * Inlined as it's very short and called for pretty much every
Linus Torvalds1da177e2005-04-16 15:20:36 -07001939 * packet ever received.
1940 */
1941
1942static inline void skb_set_owner_w(struct sk_buff *skb, struct sock *sk)
1943{
Herbert Xud55d87f2009-06-22 02:25:25 +00001944 skb_orphan(skb);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001945 skb->sk = sk;
1946 skb->destructor = sock_wfree;
Tom Herbertb73c3d02014-07-01 21:32:17 -07001947 skb_set_hash_from_sk(skb, sk);
Eric Dumazet2b85a342009-06-11 02:55:43 -07001948 /*
1949 * We used to take a refcount on sk, but following operation
1950 * is enough to guarantee sk_free() wont free this sock until
1951 * all in-flight packets are completed
1952 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001953 atomic_add(skb->truesize, &sk->sk_wmem_alloc);
1954}
1955
1956static inline void skb_set_owner_r(struct sk_buff *skb, struct sock *sk)
1957{
Herbert Xud55d87f2009-06-22 02:25:25 +00001958 skb_orphan(skb);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001959 skb->sk = sk;
1960 skb->destructor = sock_rfree;
1961 atomic_add(skb->truesize, &sk->sk_rmem_alloc);
Hideo Aoki3ab224b2007-12-31 00:11:19 -08001962 sk_mem_charge(sk, skb->truesize);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001963}
1964
Joe Perches69336bd2013-09-22 10:32:26 -07001965void sk_reset_timer(struct sock *sk, struct timer_list *timer,
1966 unsigned long expires);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001967
Joe Perches69336bd2013-09-22 10:32:26 -07001968void sk_stop_timer(struct sock *sk, struct timer_list *timer);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001969
Joe Perches69336bd2013-09-22 10:32:26 -07001970int sock_queue_rcv_skb(struct sock *sk, struct sk_buff *skb);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001971
Joe Perches69336bd2013-09-22 10:32:26 -07001972int sock_queue_err_skb(struct sock *sk, struct sk_buff *skb);
Willem de Bruijn364a9e92014-08-31 21:30:27 -04001973struct sk_buff *sock_dequeue_err_skb(struct sock *sk);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001974
1975/*
1976 * Recover an error report and clear atomically
1977 */
Eric Dumazetdc6b9b72012-05-16 22:48:15 +00001978
Linus Torvalds1da177e2005-04-16 15:20:36 -07001979static inline int sock_error(struct sock *sk)
1980{
Benjamin LaHaisec1cbe4b2005-12-13 23:22:19 -08001981 int err;
1982 if (likely(!sk->sk_err))
1983 return 0;
1984 err = xchg(&sk->sk_err, 0);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001985 return -err;
1986}
1987
1988static inline unsigned long sock_wspace(struct sock *sk)
1989{
1990 int amt = 0;
1991
1992 if (!(sk->sk_shutdown & SEND_SHUTDOWN)) {
1993 amt = sk->sk_sndbuf - atomic_read(&sk->sk_wmem_alloc);
Eric Dumazetdc6b9b72012-05-16 22:48:15 +00001994 if (amt < 0)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001995 amt = 0;
1996 }
1997 return amt;
1998}
1999
2000static inline void sk_wake_async(struct sock *sk, int how, int band)
2001{
Eric Dumazetbcdce712009-10-06 17:28:29 -07002002 if (sock_flag(sk, SOCK_FASYNC))
Linus Torvalds1da177e2005-04-16 15:20:36 -07002003 sock_wake_async(sk->sk_socket, how, band);
2004}
2005
Daniel Borkmanneea86af2013-06-19 12:51:20 +02002006/* Since sk_{r,w}mem_alloc sums skb->truesize, even a small frame might
2007 * need sizeof(sk_buff) + MTU + padding, unless net driver perform copybreak.
2008 * Note: for send buffers, TCP works better if we can build two skbs at
2009 * minimum.
Eric Dumazet7a91b4342010-09-26 18:53:07 -07002010 */
Eric Dumazet9eb5bf82013-07-03 05:02:22 -07002011#define TCP_SKB_MIN_TRUESIZE (2048 + SKB_DATA_ALIGN(sizeof(struct sk_buff)))
Daniel Borkmanneea86af2013-06-19 12:51:20 +02002012
2013#define SOCK_MIN_SNDBUF (TCP_SKB_MIN_TRUESIZE * 2)
2014#define SOCK_MIN_RCVBUF TCP_SKB_MIN_TRUESIZE
Linus Torvalds1da177e2005-04-16 15:20:36 -07002015
2016static inline void sk_stream_moderate_sndbuf(struct sock *sk)
2017{
2018 if (!(sk->sk_userlocks & SOCK_SNDBUF_LOCK)) {
Eric Dumazet8df09ea2007-12-21 03:07:41 -08002019 sk->sk_sndbuf = min(sk->sk_sndbuf, sk->sk_wmem_queued >> 1);
Daniel Borkmanneea86af2013-06-19 12:51:20 +02002020 sk->sk_sndbuf = max_t(u32, sk->sk_sndbuf, SOCK_MIN_SNDBUF);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002021 }
2022}
2023
Pavel Emelyanovdf97c702007-11-29 21:22:33 +11002024struct sk_buff *sk_stream_alloc_skb(struct sock *sk, int size, gfp_t gfp);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002025
Eric Dumazet5640f762012-09-23 23:04:42 +00002026/**
2027 * sk_page_frag - return an appropriate page_frag
2028 * @sk: socket
2029 *
2030 * If socket allocation mode allows current thread to sleep, it means its
2031 * safe to use the per task page_frag instead of the per socket one.
2032 */
2033static inline struct page_frag *sk_page_frag(struct sock *sk)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002034{
Eric Dumazet5640f762012-09-23 23:04:42 +00002035 if (sk->sk_allocation & __GFP_WAIT)
2036 return &current->task_frag;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002037
Eric Dumazet5640f762012-09-23 23:04:42 +00002038 return &sk->sk_frag;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002039}
2040
Joe Perches69336bd2013-09-22 10:32:26 -07002041bool sk_page_frag_refill(struct sock *sk, struct page_frag *pfrag);
Eric Dumazet5640f762012-09-23 23:04:42 +00002042
Linus Torvalds1da177e2005-04-16 15:20:36 -07002043/*
2044 * Default write policy as shown to user space via poll/select/SIGIO
2045 */
Eric Dumazetdc6b9b72012-05-16 22:48:15 +00002046static inline bool sock_writeable(const struct sock *sk)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002047{
Eric Dumazet8df09ea2007-12-21 03:07:41 -08002048 return atomic_read(&sk->sk_wmem_alloc) < (sk->sk_sndbuf >> 1);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002049}
2050
Al Virodd0fc662005-10-07 07:46:04 +01002051static inline gfp_t gfp_any(void)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002052{
Andrew Morton99709372009-02-12 16:43:17 -08002053 return in_softirq() ? GFP_ATOMIC : GFP_KERNEL;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002054}
2055
Eric Dumazetdc6b9b72012-05-16 22:48:15 +00002056static inline long sock_rcvtimeo(const struct sock *sk, bool noblock)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002057{
2058 return noblock ? 0 : sk->sk_rcvtimeo;
2059}
2060
Eric Dumazetdc6b9b72012-05-16 22:48:15 +00002061static inline long sock_sndtimeo(const struct sock *sk, bool noblock)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002062{
2063 return noblock ? 0 : sk->sk_sndtimeo;
2064}
2065
2066static inline int sock_rcvlowat(const struct sock *sk, int waitall, int len)
2067{
2068 return (waitall ? len : min_t(int, sk->sk_rcvlowat, len)) ? : 1;
2069}
2070
2071/* Alas, with timeout socket operations are not restartable.
2072 * Compare this to poll().
2073 */
2074static inline int sock_intr_errno(long timeo)
2075{
2076 return timeo == MAX_SCHEDULE_TIMEOUT ? -ERESTARTSYS : -EINTR;
2077}
2078
Eyal Birger744d5a32015-03-01 14:58:31 +02002079struct sock_skb_cb {
2080 u32 dropcount;
2081};
2082
2083/* Store sock_skb_cb at the end of skb->cb[] so protocol families
2084 * using skb->cb[] would keep using it directly and utilize its
2085 * alignement guarantee.
2086 */
2087#define SOCK_SKB_CB_OFFSET ((FIELD_SIZEOF(struct sk_buff, cb) - \
2088 sizeof(struct sock_skb_cb)))
2089
2090#define SOCK_SKB_CB(__skb) ((struct sock_skb_cb *)((__skb)->cb + \
2091 SOCK_SKB_CB_OFFSET))
2092
Eyal Birgerb4772ef2015-03-01 14:58:29 +02002093#define sock_skb_cb_check_size(size) \
Eyal Birger744d5a32015-03-01 14:58:31 +02002094 BUILD_BUG_ON((size) > SOCK_SKB_CB_OFFSET)
Eyal Birgerb4772ef2015-03-01 14:58:29 +02002095
Eyal Birger3bc3b962015-03-01 14:58:30 +02002096static inline void
2097sock_skb_set_dropcount(const struct sock *sk, struct sk_buff *skb)
2098{
Eyal Birger744d5a32015-03-01 14:58:31 +02002099 SOCK_SKB_CB(skb)->dropcount = atomic_read(&sk->sk_drops);
Eyal Birger3bc3b962015-03-01 14:58:30 +02002100}
2101
Joe Perches69336bd2013-09-22 10:32:26 -07002102void __sock_recv_timestamp(struct msghdr *msg, struct sock *sk,
2103 struct sk_buff *skb);
2104void __sock_recv_wifi_status(struct msghdr *msg, struct sock *sk,
2105 struct sk_buff *skb);
Eric Dumazet92f37fd2007-03-25 22:14:49 -07002106
Eric Dumazetdc6b9b72012-05-16 22:48:15 +00002107static inline void
Linus Torvalds1da177e2005-04-16 15:20:36 -07002108sock_recv_timestamp(struct msghdr *msg, struct sock *sk, struct sk_buff *skb)
2109{
Eric Dumazetb7aa0bf2007-04-19 16:16:32 -07002110 ktime_t kt = skb->tstamp;
Patrick Ohly20d49472009-02-12 05:03:38 +00002111 struct skb_shared_hwtstamps *hwtstamps = skb_hwtstamps(skb);
Patrick McHardya61bbcf2005-08-14 17:24:31 -07002112
Patrick Ohly20d49472009-02-12 05:03:38 +00002113 /*
2114 * generate control messages if
Willem de Bruijnb9f40e22014-08-04 22:11:46 -04002115 * - receive time stamping in software requested
Patrick Ohly20d49472009-02-12 05:03:38 +00002116 * - software time stamp available and wanted
Patrick Ohly20d49472009-02-12 05:03:38 +00002117 * - hardware time stamps available and wanted
Patrick Ohly20d49472009-02-12 05:03:38 +00002118 */
2119 if (sock_flag(sk, SOCK_RCVTSTAMP) ||
Willem de Bruijnb9f40e22014-08-04 22:11:46 -04002120 (sk->sk_tsflags & SOF_TIMESTAMPING_RX_SOFTWARE) ||
Willem de Bruijnc1991052014-09-03 12:01:18 -04002121 (kt.tv64 && sk->sk_tsflags & SOF_TIMESTAMPING_SOFTWARE) ||
Patrick Ohly20d49472009-02-12 05:03:38 +00002122 (hwtstamps->hwtstamp.tv64 &&
Willem de Bruijnb9f40e22014-08-04 22:11:46 -04002123 (sk->sk_tsflags & SOF_TIMESTAMPING_RAW_HARDWARE)))
Eric Dumazet92f37fd2007-03-25 22:14:49 -07002124 __sock_recv_timestamp(msg, sk, skb);
2125 else
Eric Dumazetb7aa0bf2007-04-19 16:16:32 -07002126 sk->sk_stamp = kt;
Johannes Berg6e3e9392011-11-09 10:15:42 +01002127
2128 if (sock_flag(sk, SOCK_WIFI_STATUS) && skb->wifi_acked_valid)
2129 __sock_recv_wifi_status(msg, sk, skb);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002130}
2131
Joe Perches69336bd2013-09-22 10:32:26 -07002132void __sock_recv_ts_and_drops(struct msghdr *msg, struct sock *sk,
2133 struct sk_buff *skb);
Eric Dumazet767dd032010-04-28 19:14:43 +00002134
2135static inline void sock_recv_ts_and_drops(struct msghdr *msg, struct sock *sk,
2136 struct sk_buff *skb)
2137{
2138#define FLAGS_TS_OR_DROPS ((1UL << SOCK_RXQ_OVFL) | \
Willem de Bruijnb9f40e22014-08-04 22:11:46 -04002139 (1UL << SOCK_RCVTSTAMP))
2140#define TSFLAGS_ANY (SOF_TIMESTAMPING_SOFTWARE | \
2141 SOF_TIMESTAMPING_RAW_HARDWARE)
Eric Dumazet767dd032010-04-28 19:14:43 +00002142
Willem de Bruijnb9f40e22014-08-04 22:11:46 -04002143 if (sk->sk_flags & FLAGS_TS_OR_DROPS || sk->sk_tsflags & TSFLAGS_ANY)
Eric Dumazet767dd032010-04-28 19:14:43 +00002144 __sock_recv_ts_and_drops(msg, sk, skb);
2145 else
2146 sk->sk_stamp = skb->tstamp;
2147}
Neil Horman3b885782009-10-12 13:26:31 -07002148
Willem de Bruijn67cc0d42014-09-08 19:58:58 -04002149void __sock_tx_timestamp(const struct sock *sk, __u8 *tx_flags);
2150
Linus Torvalds1da177e2005-04-16 15:20:36 -07002151/**
Patrick Ohly20d49472009-02-12 05:03:38 +00002152 * sock_tx_timestamp - checks whether the outgoing packet is to be time stamped
Patrick Ohly20d49472009-02-12 05:03:38 +00002153 * @sk: socket sending this packet
Eric Dumazet140c55d2014-08-06 11:49:29 +02002154 * @tx_flags: completed with instructions for time stamping
2155 *
2156 * Note : callers should take care of initial *tx_flags value (usually 0)
Patrick Ohly20d49472009-02-12 05:03:38 +00002157 */
Willem de Bruijn67cc0d42014-09-08 19:58:58 -04002158static inline void sock_tx_timestamp(const struct sock *sk, __u8 *tx_flags)
2159{
2160 if (unlikely(sk->sk_tsflags))
2161 __sock_tx_timestamp(sk, tx_flags);
2162 if (unlikely(sock_flag(sk, SOCK_WIFI_STATUS)))
2163 *tx_flags |= SKBTX_WIFI_STATUS;
2164}
Patrick Ohly20d49472009-02-12 05:03:38 +00002165
2166/**
Linus Torvalds1da177e2005-04-16 15:20:36 -07002167 * sk_eat_skb - Release a skb if it is no longer needed
Pavel Pisa4dc3b162005-05-01 08:59:25 -07002168 * @sk: socket to eat this skb from
2169 * @skb: socket buffer to eat
Linus Torvalds1da177e2005-04-16 15:20:36 -07002170 *
2171 * This routine must be called with interrupts disabled or with the socket
2172 * locked so that the sk_buff queue operation is ok.
2173*/
Dan Williams7bced392013-12-30 12:37:29 -08002174static inline void sk_eat_skb(struct sock *sk, struct sk_buff *skb)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002175{
2176 __skb_unlink(skb, &sk->sk_receive_queue);
2177 __kfree_skb(skb);
2178}
2179
YOSHIFUJI Hideaki3b1e0a62008-03-26 02:26:21 +09002180static inline
2181struct net *sock_net(const struct sock *sk)
2182{
Eric Dumazetc2d9ba92010-06-01 06:51:19 +00002183 return read_pnet(&sk->sk_net);
YOSHIFUJI Hideaki3b1e0a62008-03-26 02:26:21 +09002184}
2185
2186static inline
Denis V. Lunevf5aa23f2008-03-26 00:48:17 -07002187void sock_net_set(struct sock *sk, struct net *net)
YOSHIFUJI Hideaki3b1e0a62008-03-26 02:26:21 +09002188{
Eric Dumazetc2d9ba92010-06-01 06:51:19 +00002189 write_pnet(&sk->sk_net, net);
YOSHIFUJI Hideaki3b1e0a62008-03-26 02:26:21 +09002190}
2191
Denis V. Lunevedf02082008-02-29 11:18:32 -08002192/*
2193 * Kernel sockets, f.e. rtnl or icmp_socket, are a part of a namespace.
Lucas De Marchi25985ed2011-03-30 22:57:33 -03002194 * They should not hold a reference to a namespace in order to allow
Denis V. Lunevedf02082008-02-29 11:18:32 -08002195 * to stop it.
2196 * Sockets after sk_change_net should be released using sk_release_kernel
2197 */
2198static inline void sk_change_net(struct sock *sk, struct net *net)
2199{
Gu Zheng5812521b2014-03-10 09:57:34 +08002200 struct net *current_net = sock_net(sk);
2201
2202 if (!net_eq(current_net, net)) {
2203 put_net(current_net);
2204 sock_net_set(sk, hold_net(net));
2205 }
Denis V. Lunevedf02082008-02-29 11:18:32 -08002206}
2207
KOVACS Krisztian23542612008-10-07 12:41:01 -07002208static inline struct sock *skb_steal_sock(struct sk_buff *skb)
2209{
Vijay Subramanianefc27f82012-06-24 13:03:07 +00002210 if (skb->sk) {
KOVACS Krisztian23542612008-10-07 12:41:01 -07002211 struct sock *sk = skb->sk;
2212
2213 skb->destructor = NULL;
2214 skb->sk = NULL;
2215 return sk;
2216 }
2217 return NULL;
2218}
2219
Joe Perches69336bd2013-09-22 10:32:26 -07002220void sock_enable_timestamp(struct sock *sk, int flag);
2221int sock_get_timestamp(struct sock *, struct timeval __user *);
2222int sock_get_timestampns(struct sock *, struct timespec __user *);
2223int sock_recv_errqueue(struct sock *sk, struct msghdr *msg, int len, int level,
2224 int type);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002225
Eric W. Biedermana3b299d2014-04-23 14:26:56 -07002226bool sk_ns_capable(const struct sock *sk,
2227 struct user_namespace *user_ns, int cap);
2228bool sk_capable(const struct sock *sk, int cap);
2229bool sk_net_capable(const struct sock *sk, int cap);
2230
Linus Torvalds1da177e2005-04-16 15:20:36 -07002231extern __u32 sysctl_wmem_max;
2232extern __u32 sysctl_rmem_max;
2233
Willem de Bruijnb245be12015-01-30 13:29:32 -05002234extern int sysctl_tstamp_allow_data;
David S. Miller6baf1f42005-09-05 18:14:11 -07002235extern int sysctl_optmem_max;
2236
Arnaldo Carvalho de Melo20380732005-08-16 02:18:02 -03002237extern __u32 sysctl_wmem_default;
2238extern __u32 sysctl_rmem_default;
Arnaldo Carvalho de Melo20380732005-08-16 02:18:02 -03002239
Linus Torvalds1da177e2005-04-16 15:20:36 -07002240#endif /* _SOCK_H */