blob: f10832ca2e90a77b8dd0d340e567b12b981c96f2 [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;
Eric W. Biederman0c5c9fb2015-03-11 23:06:44 -0500193 possible_net_t skc_net;
Eric Dumazetefe42082013-10-03 15:42:29 -0700194
195#if IS_ENABLED(CONFIG_IPV6)
196 struct in6_addr skc_v6_daddr;
197 struct in6_addr skc_v6_rcv_saddr;
198#endif
199
Eric Dumazet33cf7c92015-03-11 18:53:14 -0700200 atomic64_t skc_cookie;
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
Eric Dumazet33cf7c92015-03-11 18:53:14 -0700332#define sk_cookie __sk_common.skc_cookie
Eric Dumazetefe42082013-10-03 15:42:29 -0700333
Eric Dumazetb178bb32010-11-16 05:56:04 +0000334 socket_lock_t sk_lock;
335 struct sk_buff_head sk_receive_queue;
336 /*
337 * The backlog queue is special, it is always used with
338 * the per-socket spinlock held and requires low latency
339 * access. Therefore we special case it's implementation.
340 * Note : rmem_alloc is in this structure to fill a hole
341 * on 64bit arches, not because its logically part of
342 * backlog.
343 */
344 struct {
345 atomic_t rmem_alloc;
346 int len;
347 struct sk_buff *head;
348 struct sk_buff *tail;
349 } sk_backlog;
350#define sk_rmem_alloc sk_backlog.rmem_alloc
351 int sk_forward_alloc;
352#ifdef CONFIG_RPS
353 __u32 sk_rxhash;
354#endif
Eric Dumazet2c8c56e2014-11-11 05:54:28 -0800355 u16 sk_incoming_cpu;
356 /* 16bit hole
357 * Warned : sk_incoming_cpu can be set from softirq,
358 * Do not use this hole without fully understanding possible issues.
359 */
360
Tom Herbertb73c3d02014-07-01 21:32:17 -0700361 __u32 sk_txhash;
Cong Wange0d10952013-08-01 11:10:25 +0800362#ifdef CONFIG_NET_RX_BUSY_POLL
Eliezer Tamir06021292013-06-10 11:39:50 +0300363 unsigned int sk_napi_id;
Eliezer Tamirdafcc432013-06-14 16:33:57 +0300364 unsigned int sk_ll_usec;
Eliezer Tamir06021292013-06-10 11:39:50 +0300365#endif
Eric Dumazetb178bb32010-11-16 05:56:04 +0000366 atomic_t sk_drops;
367 int sk_rcvbuf;
368
369 struct sk_filter __rcu *sk_filter;
Eric Dumazeteaefd112011-02-18 03:26:36 +0000370 struct socket_wq __rcu *sk_wq;
Eric Dumazetb178bb32010-11-16 05:56:04 +0000371
Eric Dumazetb178bb32010-11-16 05:56:04 +0000372#ifdef CONFIG_XFRM
373 struct xfrm_policy *sk_policy[2];
374#endif
375 unsigned long sk_flags;
Eric Dumazetdeaa5852012-06-24 20:22:49 +0000376 struct dst_entry *sk_rx_dst;
Cong Wang0e36cbb2013-01-22 21:09:51 +0000377 struct dst_entry __rcu *sk_dst_cache;
Eric Dumazetb178bb32010-11-16 05:56:04 +0000378 spinlock_t sk_dst_lock;
379 atomic_t sk_wmem_alloc;
380 atomic_t sk_omem_alloc;
381 int sk_sndbuf;
382 struct sk_buff_head sk_write_queue;
Vegard Nossuma98b65a2009-02-26 14:46:57 +0100383 kmemcheck_bitfield_begin(flags);
Eric Dumazet5fdb9972009-10-08 22:50:25 +0000384 unsigned int sk_shutdown : 2,
Tom Herbert28448b82014-05-23 08:47:19 -0700385 sk_no_check_tx : 1,
386 sk_no_check_rx : 1,
Eric Dumazet5fdb9972009-10-08 22:50:25 +0000387 sk_userlocks : 4,
388 sk_protocol : 8,
389 sk_type : 16;
Vegard Nossuma98b65a2009-02-26 14:46:57 +0100390 kmemcheck_bitfield_end(flags);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700391 int sk_wmem_queued;
Al Viro7d877f32005-10-21 03:20:43 -0400392 gfp_t sk_allocation;
Eric Dumazet95bd09e2013-08-27 05:46:32 -0700393 u32 sk_pacing_rate; /* bytes per second */
Eric Dumazet62748f32013-09-24 08:20:52 -0700394 u32 sk_max_pacing_rate;
Michał Mirosławc8f44af2011-11-15 15:29:55 +0000395 netdev_features_t sk_route_caps;
396 netdev_features_t sk_route_nocaps;
Herbert Xubcd76112006-06-30 13:36:35 -0700397 int sk_gso_type;
Peter P Waskiewicz Jr82cc1a72008-03-21 03:43:19 -0700398 unsigned int sk_gso_max_size;
Ben Hutchings14853482012-07-30 16:11:42 +0000399 u16 sk_gso_max_segs;
David S. Miller9932cf92006-03-24 15:12:37 -0800400 int sk_rcvlowat;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700401 unsigned long sk_lingertime;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700402 struct sk_buff_head sk_error_queue;
Arnaldo Carvalho de Melo476e19c2005-05-05 13:35:15 -0700403 struct proto *sk_prot_creator;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700404 rwlock_t sk_callback_lock;
405 int sk_err,
406 sk_err_soft;
407 unsigned short sk_ack_backlog;
408 unsigned short sk_max_ack_backlog;
409 __u32 sk_priority;
Daniel Borkmann86f85152013-12-29 17:27:11 +0100410#if IS_ENABLED(CONFIG_CGROUP_NET_PRIO)
Neil Horman5bc14212011-11-22 05:10:51 +0000411 __u32 sk_cgrp_prioidx;
412#endif
Eric W. Biederman109f6e32010-06-13 03:30:14 +0000413 struct pid *sk_peer_pid;
414 const struct cred *sk_peer_cred;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700415 long sk_rcvtimeo;
416 long sk_sndtimeo;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700417 void *sk_protinfo;
418 struct timer_list sk_timer;
Eric Dumazetb7aa0bf2007-04-19 16:16:32 -0700419 ktime_t sk_stamp;
Willem de Bruijnb9f40e22014-08-04 22:11:46 -0400420 u16 sk_tsflags;
Willem de Bruijn09c2d252014-08-04 22:11:47 -0400421 u32 sk_tskey;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700422 struct socket *sk_socket;
423 void *sk_user_data;
Eric Dumazet5640f762012-09-23 23:04:42 +0000424 struct page_frag sk_frag;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700425 struct sk_buff *sk_send_head;
Pavel Emelyanovef64a542012-02-21 07:31:34 +0000426 __s32 sk_peek_off;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700427 int sk_write_pending;
Alexey Dobriyand5f64232008-11-04 14:45:58 -0800428#ifdef CONFIG_SECURITY
Linus Torvalds1da177e2005-04-16 15:20:36 -0700429 void *sk_security;
Alexey Dobriyand5f64232008-11-04 14:45:58 -0800430#endif
Laszlo Attila Toth4a19ec52008-01-30 19:08:16 -0800431 __u32 sk_mark;
Herbert Xuf8451722010-05-24 00:12:34 -0700432 u32 sk_classid;
Glauber Costae1aab162011-12-11 21:47:03 +0000433 struct cg_proto *sk_cgrp;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700434 void (*sk_state_change)(struct sock *sk);
David S. Miller676d2362014-04-11 16:15:36 -0400435 void (*sk_data_ready)(struct sock *sk);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700436 void (*sk_write_space)(struct sock *sk);
437 void (*sk_error_report)(struct sock *sk);
Eric Dumazetdc6b9b72012-05-16 22:48:15 +0000438 int (*sk_backlog_rcv)(struct sock *sk,
439 struct sk_buff *skb);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700440 void (*sk_destruct)(struct sock *sk);
441};
442
Pravin B Shelar559835ea2013-09-24 10:25:40 -0700443#define __sk_user_data(sk) ((*((void __rcu **)&(sk)->sk_user_data)))
444
445#define rcu_dereference_sk_user_data(sk) rcu_dereference(__sk_user_data((sk)))
446#define rcu_assign_sk_user_data(sk, ptr) rcu_assign_pointer(__sk_user_data((sk)), ptr)
447
Pavel Emelyanov4a17fd52012-04-19 03:39:36 +0000448/*
449 * SK_CAN_REUSE and SK_NO_REUSE on a socket mean that the socket is OK
450 * or not whether his port will be reused by someone else. SK_FORCE_REUSE
451 * on a socket means that the socket will reuse everybody else's port
452 * without looking at the other's sk_reuse value.
453 */
454
455#define SK_NO_REUSE 0
456#define SK_CAN_REUSE 1
457#define SK_FORCE_REUSE 2
458
Pavel Emelyanovef64a542012-02-21 07:31:34 +0000459static inline int sk_peek_offset(struct sock *sk, int flags)
460{
461 if ((flags & MSG_PEEK) && (sk->sk_peek_off >= 0))
462 return sk->sk_peek_off;
463 else
464 return 0;
465}
466
467static inline void sk_peek_offset_bwd(struct sock *sk, int val)
468{
469 if (sk->sk_peek_off >= 0) {
470 if (sk->sk_peek_off >= val)
471 sk->sk_peek_off -= val;
472 else
473 sk->sk_peek_off = 0;
474 }
475}
476
477static inline void sk_peek_offset_fwd(struct sock *sk, int val)
478{
479 if (sk->sk_peek_off >= 0)
480 sk->sk_peek_off += val;
481}
482
Linus Torvalds1da177e2005-04-16 15:20:36 -0700483/*
484 * Hashed lists helper routines
485 */
Li Zefanc4146642010-02-08 23:18:45 +0000486static inline struct sock *sk_entry(const struct hlist_node *node)
487{
488 return hlist_entry(node, struct sock, sk_node);
489}
490
Arnaldo Carvalho de Meloe48c4142005-08-09 20:09:46 -0700491static inline struct sock *__sk_head(const struct hlist_head *head)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700492{
493 return hlist_entry(head->first, struct sock, sk_node);
494}
495
Arnaldo Carvalho de Meloe48c4142005-08-09 20:09:46 -0700496static inline struct sock *sk_head(const struct hlist_head *head)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700497{
498 return hlist_empty(head) ? NULL : __sk_head(head);
499}
500
Eric Dumazet88ab1932008-11-16 19:39:21 -0800501static inline struct sock *__sk_nulls_head(const struct hlist_nulls_head *head)
502{
503 return hlist_nulls_entry(head->first, struct sock, sk_nulls_node);
504}
505
506static inline struct sock *sk_nulls_head(const struct hlist_nulls_head *head)
507{
508 return hlist_nulls_empty(head) ? NULL : __sk_nulls_head(head);
509}
510
Arnaldo Carvalho de Meloe48c4142005-08-09 20:09:46 -0700511static inline struct sock *sk_next(const struct sock *sk)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700512{
513 return sk->sk_node.next ?
514 hlist_entry(sk->sk_node.next, struct sock, sk_node) : NULL;
515}
516
Eric Dumazet88ab1932008-11-16 19:39:21 -0800517static inline struct sock *sk_nulls_next(const struct sock *sk)
518{
519 return (!is_a_nulls(sk->sk_nulls_node.next)) ?
520 hlist_nulls_entry(sk->sk_nulls_node.next,
521 struct sock, sk_nulls_node) :
522 NULL;
523}
524
Eric Dumazetdc6b9b72012-05-16 22:48:15 +0000525static inline bool sk_unhashed(const struct sock *sk)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700526{
527 return hlist_unhashed(&sk->sk_node);
528}
529
Eric Dumazetdc6b9b72012-05-16 22:48:15 +0000530static inline bool sk_hashed(const struct sock *sk)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700531{
Akinobu Mitada753be2006-04-28 15:21:23 -0700532 return !sk_unhashed(sk);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700533}
534
Eric Dumazetdc6b9b72012-05-16 22:48:15 +0000535static inline void sk_node_init(struct hlist_node *node)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700536{
537 node->pprev = NULL;
538}
539
Eric Dumazetdc6b9b72012-05-16 22:48:15 +0000540static inline void sk_nulls_node_init(struct hlist_nulls_node *node)
Eric Dumazet88ab1932008-11-16 19:39:21 -0800541{
542 node->pprev = NULL;
543}
544
Eric Dumazetdc6b9b72012-05-16 22:48:15 +0000545static inline void __sk_del_node(struct sock *sk)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700546{
547 __hlist_del(&sk->sk_node);
548}
549
stephen hemminger808f5112010-02-22 07:57:18 +0000550/* NB: equivalent to hlist_del_init_rcu */
Eric Dumazetdc6b9b72012-05-16 22:48:15 +0000551static inline bool __sk_del_node_init(struct sock *sk)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700552{
553 if (sk_hashed(sk)) {
554 __sk_del_node(sk);
555 sk_node_init(&sk->sk_node);
Eric Dumazetdc6b9b72012-05-16 22:48:15 +0000556 return true;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700557 }
Eric Dumazetdc6b9b72012-05-16 22:48:15 +0000558 return false;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700559}
560
561/* Grab socket reference count. This operation is valid only
562 when sk is ALREADY grabbed f.e. it is found in hash table
563 or a list and the lookup is made under lock preventing hash table
564 modifications.
565 */
566
567static inline void sock_hold(struct sock *sk)
568{
569 atomic_inc(&sk->sk_refcnt);
570}
571
572/* Ungrab socket in the context, which assumes that socket refcnt
573 cannot hit zero, f.e. it is true in context of any socketcall.
574 */
575static inline void __sock_put(struct sock *sk)
576{
577 atomic_dec(&sk->sk_refcnt);
578}
579
Eric Dumazetdc6b9b72012-05-16 22:48:15 +0000580static inline bool sk_del_node_init(struct sock *sk)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700581{
Eric Dumazetdc6b9b72012-05-16 22:48:15 +0000582 bool rc = __sk_del_node_init(sk);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700583
584 if (rc) {
585 /* paranoid for a while -acme */
586 WARN_ON(atomic_read(&sk->sk_refcnt) == 1);
587 __sock_put(sk);
588 }
589 return rc;
590}
stephen hemminger808f5112010-02-22 07:57:18 +0000591#define sk_del_node_init_rcu(sk) sk_del_node_init(sk)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700592
Eric Dumazetdc6b9b72012-05-16 22:48:15 +0000593static inline bool __sk_nulls_del_node_init_rcu(struct sock *sk)
Eric Dumazet271b72c2008-10-29 02:11:14 -0700594{
595 if (sk_hashed(sk)) {
Eric Dumazet88ab1932008-11-16 19:39:21 -0800596 hlist_nulls_del_init_rcu(&sk->sk_nulls_node);
Eric Dumazetdc6b9b72012-05-16 22:48:15 +0000597 return true;
Eric Dumazet271b72c2008-10-29 02:11:14 -0700598 }
Eric Dumazetdc6b9b72012-05-16 22:48:15 +0000599 return false;
Eric Dumazet271b72c2008-10-29 02:11:14 -0700600}
601
Eric Dumazetdc6b9b72012-05-16 22:48:15 +0000602static inline bool sk_nulls_del_node_init_rcu(struct sock *sk)
Eric Dumazet271b72c2008-10-29 02:11:14 -0700603{
Eric Dumazetdc6b9b72012-05-16 22:48:15 +0000604 bool rc = __sk_nulls_del_node_init_rcu(sk);
Eric Dumazet271b72c2008-10-29 02:11:14 -0700605
606 if (rc) {
607 /* paranoid for a while -acme */
608 WARN_ON(atomic_read(&sk->sk_refcnt) == 1);
609 __sock_put(sk);
610 }
611 return rc;
612}
613
Eric Dumazetdc6b9b72012-05-16 22:48:15 +0000614static inline void __sk_add_node(struct sock *sk, struct hlist_head *list)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700615{
616 hlist_add_head(&sk->sk_node, list);
617}
618
Eric Dumazetdc6b9b72012-05-16 22:48:15 +0000619static inline void sk_add_node(struct sock *sk, struct hlist_head *list)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700620{
621 sock_hold(sk);
622 __sk_add_node(sk, list);
623}
624
Eric Dumazetdc6b9b72012-05-16 22:48:15 +0000625static inline void sk_add_node_rcu(struct sock *sk, struct hlist_head *list)
stephen hemminger808f5112010-02-22 07:57:18 +0000626{
627 sock_hold(sk);
628 hlist_add_head_rcu(&sk->sk_node, list);
629}
630
Eric Dumazetdc6b9b72012-05-16 22:48:15 +0000631static inline void __sk_nulls_add_node_rcu(struct sock *sk, struct hlist_nulls_head *list)
Eric Dumazet271b72c2008-10-29 02:11:14 -0700632{
Eric Dumazet88ab1932008-11-16 19:39:21 -0800633 hlist_nulls_add_head_rcu(&sk->sk_nulls_node, list);
Eric Dumazet271b72c2008-10-29 02:11:14 -0700634}
635
Eric Dumazetdc6b9b72012-05-16 22:48:15 +0000636static inline void sk_nulls_add_node_rcu(struct sock *sk, struct hlist_nulls_head *list)
Eric Dumazet271b72c2008-10-29 02:11:14 -0700637{
638 sock_hold(sk);
Eric Dumazet88ab1932008-11-16 19:39:21 -0800639 __sk_nulls_add_node_rcu(sk, list);
Eric Dumazet271b72c2008-10-29 02:11:14 -0700640}
641
Eric Dumazetdc6b9b72012-05-16 22:48:15 +0000642static inline void __sk_del_bind_node(struct sock *sk)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700643{
644 __hlist_del(&sk->sk_bind_node);
645}
646
Eric Dumazetdc6b9b72012-05-16 22:48:15 +0000647static inline void sk_add_bind_node(struct sock *sk,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700648 struct hlist_head *list)
649{
650 hlist_add_head(&sk->sk_bind_node, list);
651}
652
Sasha Levinb67bfe02013-02-27 17:06:00 -0800653#define sk_for_each(__sk, list) \
654 hlist_for_each_entry(__sk, list, sk_node)
655#define sk_for_each_rcu(__sk, list) \
656 hlist_for_each_entry_rcu(__sk, list, sk_node)
Eric Dumazet88ab1932008-11-16 19:39:21 -0800657#define sk_nulls_for_each(__sk, node, list) \
658 hlist_nulls_for_each_entry(__sk, node, list, sk_nulls_node)
659#define sk_nulls_for_each_rcu(__sk, node, list) \
660 hlist_nulls_for_each_entry_rcu(__sk, node, list, sk_nulls_node)
Sasha Levinb67bfe02013-02-27 17:06:00 -0800661#define sk_for_each_from(__sk) \
662 hlist_for_each_entry_from(__sk, sk_node)
Eric Dumazet88ab1932008-11-16 19:39:21 -0800663#define sk_nulls_for_each_from(__sk, node) \
664 if (__sk && ({ node = &(__sk)->sk_nulls_node; 1; })) \
665 hlist_nulls_for_each_entry_from(__sk, node, sk_nulls_node)
Sasha Levinb67bfe02013-02-27 17:06:00 -0800666#define sk_for_each_safe(__sk, tmp, list) \
667 hlist_for_each_entry_safe(__sk, tmp, list, sk_node)
668#define sk_for_each_bound(__sk, list) \
669 hlist_for_each_entry(__sk, list, sk_bind_node)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700670
David Held2dc41cf2014-07-15 23:28:32 -0400671/**
672 * sk_nulls_for_each_entry_offset - iterate over a list at a given struct offset
673 * @tpos: the type * to use as a loop cursor.
674 * @pos: the &struct hlist_node to use as a loop cursor.
675 * @head: the head for your list.
676 * @offset: offset of hlist_node within the struct.
677 *
678 */
679#define sk_nulls_for_each_entry_offset(tpos, pos, head, offset) \
680 for (pos = (head)->first; \
681 (!is_a_nulls(pos)) && \
682 ({ tpos = (typeof(*tpos) *)((void *)pos - offset); 1;}); \
683 pos = pos->next)
684
Eric W. Biedermanc336d142012-05-24 17:56:43 -0600685static inline struct user_namespace *sk_user_ns(struct sock *sk)
686{
687 /* Careful only use this in a context where these parameters
688 * can not change and must all be valid, such as recvmsg from
689 * userspace.
690 */
691 return sk->sk_socket->file->f_cred->user_ns;
692}
693
Linus Torvalds1da177e2005-04-16 15:20:36 -0700694/* Sock flags */
695enum sock_flags {
696 SOCK_DEAD,
697 SOCK_DONE,
698 SOCK_URGINLINE,
699 SOCK_KEEPOPEN,
700 SOCK_LINGER,
701 SOCK_DESTROY,
702 SOCK_BROADCAST,
703 SOCK_TIMESTAMP,
704 SOCK_ZAPPED,
705 SOCK_USE_WRITE_QUEUE, /* whether to call sk->sk_write_space in sock_wfree */
706 SOCK_DBG, /* %SO_DEBUG setting */
707 SOCK_RCVTSTAMP, /* %SO_TIMESTAMP setting */
Eric Dumazet92f37fd2007-03-25 22:14:49 -0700708 SOCK_RCVTSTAMPNS, /* %SO_TIMESTAMPNS setting */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700709 SOCK_LOCALROUTE, /* route locally only, %SO_DONTROUTE setting */
710 SOCK_QUEUE_SHRUNK, /* write queue has been shrunk recently */
Mel Gorman7cb02402012-07-31 16:44:16 -0700711 SOCK_MEMALLOC, /* VM depends on this socket for swapping */
Patrick Ohly20d49472009-02-12 05:03:38 +0000712 SOCK_TIMESTAMPING_RX_SOFTWARE, /* %SOF_TIMESTAMPING_RX_SOFTWARE */
Eric Dumazetbcdce712009-10-06 17:28:29 -0700713 SOCK_FASYNC, /* fasync() active */
Neil Horman3b885782009-10-12 13:26:31 -0700714 SOCK_RXQ_OVFL,
Shirley Ma1cdebb42011-07-06 12:17:30 +0000715 SOCK_ZEROCOPY, /* buffers from userspace */
Johannes Berg6e3e9392011-11-09 10:15:42 +0100716 SOCK_WIFI_STATUS, /* push wifi status to userspace */
Ben Greear3bdc0eb2012-02-11 15:39:30 +0000717 SOCK_NOFCS, /* Tell NIC not to do the Ethernet FCS.
718 * Will use last 4 bytes of packet sent from
719 * user-space instead.
720 */
Vincent Bernatd59577b2013-01-16 22:55:49 +0100721 SOCK_FILTER_LOCKED, /* Filter cannot be changed anymore */
Keller, Jacob E7d4c04f2013-03-28 11:19:25 +0000722 SOCK_SELECT_ERR_QUEUE, /* Wake select on error queue */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700723};
724
Ralf Baechle53b924b2005-08-23 10:11:30 -0700725static inline void sock_copy_flags(struct sock *nsk, struct sock *osk)
726{
727 nsk->sk_flags = osk->sk_flags;
728}
729
Linus Torvalds1da177e2005-04-16 15:20:36 -0700730static inline void sock_set_flag(struct sock *sk, enum sock_flags flag)
731{
732 __set_bit(flag, &sk->sk_flags);
733}
734
735static inline void sock_reset_flag(struct sock *sk, enum sock_flags flag)
736{
737 __clear_bit(flag, &sk->sk_flags);
738}
739
Eric Dumazet1b23a5d2012-05-16 05:57:07 +0000740static inline bool sock_flag(const struct sock *sk, enum sock_flags flag)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700741{
742 return test_bit(flag, &sk->sk_flags);
743}
744
Mel Gormanc93bdd02012-07-31 16:44:19 -0700745#ifdef CONFIG_NET
746extern struct static_key memalloc_socks;
747static inline int sk_memalloc_socks(void)
748{
749 return static_key_false(&memalloc_socks);
750}
751#else
752
753static inline int sk_memalloc_socks(void)
754{
755 return 0;
756}
757
758#endif
759
Mel Gorman99a1dec2012-07-31 16:44:14 -0700760static inline gfp_t sk_gfp_atomic(struct sock *sk, gfp_t gfp_mask)
761{
Mel Gorman7cb02402012-07-31 16:44:16 -0700762 return GFP_ATOMIC | (sk->sk_allocation & __GFP_MEMALLOC);
Mel Gorman99a1dec2012-07-31 16:44:14 -0700763}
764
Linus Torvalds1da177e2005-04-16 15:20:36 -0700765static inline void sk_acceptq_removed(struct sock *sk)
766{
767 sk->sk_ack_backlog--;
768}
769
770static inline void sk_acceptq_added(struct sock *sk)
771{
772 sk->sk_ack_backlog++;
773}
774
Eric Dumazetdc6b9b72012-05-16 22:48:15 +0000775static inline bool sk_acceptq_is_full(const struct sock *sk)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700776{
David S. Miller64a14652007-03-06 11:21:05 -0800777 return sk->sk_ack_backlog > sk->sk_max_ack_backlog;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700778}
779
780/*
781 * Compute minimal free write space needed to queue new packets.
782 */
Eric Dumazetdc6b9b72012-05-16 22:48:15 +0000783static inline int sk_stream_min_wspace(const struct sock *sk)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700784{
Eric Dumazet8df09ea2007-12-21 03:07:41 -0800785 return sk->sk_wmem_queued >> 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700786}
787
Eric Dumazetdc6b9b72012-05-16 22:48:15 +0000788static inline int sk_stream_wspace(const struct sock *sk)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700789{
790 return sk->sk_sndbuf - sk->sk_wmem_queued;
791}
792
Joe Perches69336bd2013-09-22 10:32:26 -0700793void sk_stream_write_space(struct sock *sk);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700794
Zhu Yi8eae9392010-03-04 18:01:40 +0000795/* OOB backlog add */
Zhu Yia3a858f2010-03-04 18:01:47 +0000796static inline void __sk_add_backlog(struct sock *sk, struct sk_buff *skb)
Stephen Hemminger9ee6b532005-11-08 09:39:42 -0800797{
Eric Dumazet7fee2262010-05-11 23:19:48 +0000798 /* dont let skb dst not refcounted, we are going to leave rcu lock */
799 skb_dst_force(skb);
800
801 if (!sk->sk_backlog.tail)
802 sk->sk_backlog.head = skb;
803 else
Stephen Hemminger9ee6b532005-11-08 09:39:42 -0800804 sk->sk_backlog.tail->next = skb;
Eric Dumazet7fee2262010-05-11 23:19:48 +0000805
806 sk->sk_backlog.tail = skb;
Stephen Hemminger9ee6b532005-11-08 09:39:42 -0800807 skb->next = NULL;
808}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700809
Eric Dumazetc3774112010-04-27 15:13:20 -0700810/*
811 * Take into account size of receive queue and backlog queue
Eric Dumazet0fd7bac2011-12-21 07:11:44 +0000812 * Do not take into account this skb truesize,
813 * to allow even a single big packet to come.
Eric Dumazetc3774112010-04-27 15:13:20 -0700814 */
Sorin Dumitru274f4822014-07-22 21:16:51 +0300815static inline bool sk_rcvqueues_full(const struct sock *sk, unsigned int limit)
Eric Dumazetc3774112010-04-27 15:13:20 -0700816{
817 unsigned int qsize = sk->sk_backlog.len + atomic_read(&sk->sk_rmem_alloc);
818
Eric Dumazetf545a382012-04-22 23:34:26 +0000819 return qsize > limit;
Eric Dumazetc3774112010-04-27 15:13:20 -0700820}
821
Zhu Yi8eae9392010-03-04 18:01:40 +0000822/* The per-socket spinlock must be held here. */
Eric Dumazetf545a382012-04-22 23:34:26 +0000823static inline __must_check int sk_add_backlog(struct sock *sk, struct sk_buff *skb,
824 unsigned int limit)
Zhu Yi8eae9392010-03-04 18:01:40 +0000825{
Sorin Dumitru274f4822014-07-22 21:16:51 +0300826 if (sk_rcvqueues_full(sk, limit))
Zhu Yi8eae9392010-03-04 18:01:40 +0000827 return -ENOBUFS;
828
Zhu Yia3a858f2010-03-04 18:01:47 +0000829 __sk_add_backlog(sk, skb);
Zhu Yi8eae9392010-03-04 18:01:40 +0000830 sk->sk_backlog.len += skb->truesize;
831 return 0;
832}
833
Joe Perches69336bd2013-09-22 10:32:26 -0700834int __sk_backlog_rcv(struct sock *sk, struct sk_buff *skb);
Mel Gormanb4b9e352012-07-31 16:44:26 -0700835
Peter Zijlstrac57943a2008-10-07 14:18:42 -0700836static inline int sk_backlog_rcv(struct sock *sk, struct sk_buff *skb)
837{
Mel Gormanb4b9e352012-07-31 16:44:26 -0700838 if (sk_memalloc_socks() && skb_pfmemalloc(skb))
839 return __sk_backlog_rcv(sk, skb);
840
Peter Zijlstrac57943a2008-10-07 14:18:42 -0700841 return sk->sk_backlog_rcv(sk, skb);
842}
843
Eric Dumazet2c8c56e2014-11-11 05:54:28 -0800844static inline void sk_incoming_cpu_update(struct sock *sk)
845{
846 sk->sk_incoming_cpu = raw_smp_processor_id();
847}
848
Tom Herbertfe477552013-12-22 18:54:31 +0800849static inline void sock_rps_record_flow_hash(__u32 hash)
David S. Millerc58dc012010-04-27 15:05:31 -0700850{
851#ifdef CONFIG_RPS
852 struct rps_sock_flow_table *sock_flow_table;
853
854 rcu_read_lock();
855 sock_flow_table = rcu_dereference(rps_sock_flow_table);
Tom Herbertfe477552013-12-22 18:54:31 +0800856 rps_record_sock_flow(sock_flow_table, hash);
David S. Millerc58dc012010-04-27 15:05:31 -0700857 rcu_read_unlock();
858#endif
859}
860
Tom Herbertfe477552013-12-22 18:54:31 +0800861static inline void sock_rps_record_flow(const struct sock *sk)
862{
Zhi Yong Wuc9d8ca02014-01-01 04:31:01 +0800863#ifdef CONFIG_RPS
Tom Herbertfe477552013-12-22 18:54:31 +0800864 sock_rps_record_flow_hash(sk->sk_rxhash);
Zhi Yong Wuc9d8ca02014-01-01 04:31:01 +0800865#endif
Tom Herbertfe477552013-12-22 18:54:31 +0800866}
867
Tom Herbertbdeab992011-08-14 19:45:55 +0000868static inline void sock_rps_save_rxhash(struct sock *sk,
869 const struct sk_buff *skb)
David S. Millerc58dc012010-04-27 15:05:31 -0700870{
871#ifdef CONFIG_RPS
Eric Dumazet567e4b72015-02-06 12:59:01 -0800872 if (unlikely(sk->sk_rxhash != skb->hash))
Tom Herbert61b905d2014-03-24 15:34:47 -0700873 sk->sk_rxhash = skb->hash;
David S. Millerc58dc012010-04-27 15:05:31 -0700874#endif
875}
876
Tom Herbertbdeab992011-08-14 19:45:55 +0000877static inline void sock_rps_reset_rxhash(struct sock *sk)
878{
879#ifdef CONFIG_RPS
Tom Herbertbdeab992011-08-14 19:45:55 +0000880 sk->sk_rxhash = 0;
881#endif
882}
883
Stephen Hemmingercfcabdc2007-10-09 01:59:42 -0700884#define sk_wait_event(__sk, __timeo, __condition) \
885 ({ int __rc; \
886 release_sock(__sk); \
887 __rc = __condition; \
888 if (!__rc) { \
889 *(__timeo) = schedule_timeout(*(__timeo)); \
890 } \
Peter Zijlstra26cabd32014-09-24 10:18:54 +0200891 sched_annotate_sleep(); \
Stephen Hemmingercfcabdc2007-10-09 01:59:42 -0700892 lock_sock(__sk); \
893 __rc = __condition; \
894 __rc; \
895 })
Linus Torvalds1da177e2005-04-16 15:20:36 -0700896
Joe Perches69336bd2013-09-22 10:32:26 -0700897int sk_stream_wait_connect(struct sock *sk, long *timeo_p);
898int sk_stream_wait_memory(struct sock *sk, long *timeo_p);
899void sk_stream_wait_close(struct sock *sk, long timeo_p);
900int sk_stream_error(struct sock *sk, int flags, int err);
901void sk_stream_kill_queues(struct sock *sk);
902void sk_set_memalloc(struct sock *sk);
903void sk_clear_memalloc(struct sock *sk);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700904
Joe Perches69336bd2013-09-22 10:32:26 -0700905int sk_wait_data(struct sock *sk, long *timeo);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700906
Arnaldo Carvalho de Melo60236fd2005-06-18 22:47:21 -0700907struct request_sock_ops;
Arnaldo Carvalho de Melo6d6ee432005-12-13 23:25:19 -0800908struct timewait_sock_ops;
Arnaldo Carvalho de Meloab1e0a12008-02-03 04:06:04 -0800909struct inet_hashinfo;
Pavel Emelyanovfc8717b2008-03-22 16:56:51 -0700910struct raw_hashinfo;
Paul Gortmakerde477252011-05-26 13:46:22 -0400911struct module;
Arnaldo Carvalho de Melo2e6599c2005-06-18 22:46:52 -0700912
Eric Dumazetf77d6022013-05-09 10:28:16 +0000913/*
914 * caches using SLAB_DESTROY_BY_RCU should let .next pointer from nulls nodes
915 * un-modified. Special care is taken when initializing object to zero.
916 */
917static inline void sk_prot_clear_nulls(struct sock *sk, int size)
918{
919 if (offsetof(struct sock, sk_node.next) != 0)
920 memset(sk, 0, offsetof(struct sock, sk_node.next));
921 memset(&sk->sk_node.pprev, 0,
922 size - offsetof(struct sock, sk_node.pprev));
923}
924
Linus Torvalds1da177e2005-04-16 15:20:36 -0700925/* Networking protocol blocks we attach to sockets.
926 * socket layer -> transport layer interface
927 * transport -> network interface is defined by struct inet_proto
928 */
929struct proto {
Eric Dumazetdc6b9b72012-05-16 22:48:15 +0000930 void (*close)(struct sock *sk,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700931 long timeout);
932 int (*connect)(struct sock *sk,
Eric Dumazetdc6b9b72012-05-16 22:48:15 +0000933 struct sockaddr *uaddr,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700934 int addr_len);
935 int (*disconnect)(struct sock *sk, int flags);
936
Eric Dumazetdc6b9b72012-05-16 22:48:15 +0000937 struct sock * (*accept)(struct sock *sk, int flags, int *err);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700938
939 int (*ioctl)(struct sock *sk, int cmd,
940 unsigned long arg);
941 int (*init)(struct sock *sk);
Brian Haley7d06b2e2008-06-14 17:04:49 -0700942 void (*destroy)(struct sock *sk);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700943 void (*shutdown)(struct sock *sk, int how);
Eric Dumazetdc6b9b72012-05-16 22:48:15 +0000944 int (*setsockopt)(struct sock *sk, int level,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700945 int optname, char __user *optval,
David S. Millerb7058842009-09-30 16:12:20 -0700946 unsigned int optlen);
Eric Dumazetdc6b9b72012-05-16 22:48:15 +0000947 int (*getsockopt)(struct sock *sk, int level,
948 int optname, char __user *optval,
949 int __user *option);
Alexey Dobriyanaf01d532008-08-28 02:53:51 -0700950#ifdef CONFIG_COMPAT
Dmitry Mishin3fdadf72006-03-20 22:45:21 -0800951 int (*compat_setsockopt)(struct sock *sk,
952 int level,
953 int optname, char __user *optval,
David S. Millerb7058842009-09-30 16:12:20 -0700954 unsigned int optlen);
Dmitry Mishin3fdadf72006-03-20 22:45:21 -0800955 int (*compat_getsockopt)(struct sock *sk,
956 int level,
957 int optname, char __user *optval,
958 int __user *option);
Eric W. Biederman709b46e2011-01-29 16:15:56 +0000959 int (*compat_ioctl)(struct sock *sk,
960 unsigned int cmd, unsigned long arg);
Alexey Dobriyanaf01d532008-08-28 02:53:51 -0700961#endif
Ying Xue1b784142015-03-02 15:37:48 +0800962 int (*sendmsg)(struct sock *sk, struct msghdr *msg,
963 size_t len);
964 int (*recvmsg)(struct sock *sk, struct msghdr *msg,
Eric Dumazetdc6b9b72012-05-16 22:48:15 +0000965 size_t len, int noblock, int flags,
966 int *addr_len);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700967 int (*sendpage)(struct sock *sk, struct page *page,
968 int offset, size_t size, int flags);
Eric Dumazetdc6b9b72012-05-16 22:48:15 +0000969 int (*bind)(struct sock *sk,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700970 struct sockaddr *uaddr, int addr_len);
971
Eric Dumazetdc6b9b72012-05-16 22:48:15 +0000972 int (*backlog_rcv) (struct sock *sk,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700973 struct sk_buff *skb);
974
Eric Dumazet46d3cea2012-07-11 05:50:31 +0000975 void (*release_cb)(struct sock *sk);
976
Linus Torvalds1da177e2005-04-16 15:20:36 -0700977 /* Keeping track of sk's, looking them up, and port selection methods. */
978 void (*hash)(struct sock *sk);
979 void (*unhash)(struct sock *sk);
Eric Dumazet719f8352010-09-08 05:08:44 +0000980 void (*rehash)(struct sock *sk);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700981 int (*get_port)(struct sock *sk, unsigned short snum);
Octavian Purdilafcbdf092010-12-16 14:26:56 -0800982 void (*clear_sk)(struct sock *sk, int size);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700983
Eric Dumazet286ab3d2007-11-05 23:38:39 -0800984 /* Keeping track of sockets in use */
Eric Dumazet65f76512008-01-03 20:46:48 -0800985#ifdef CONFIG_PROC_FS
Pavel Emelyanov13ff3d62008-03-28 16:38:17 -0700986 unsigned int inuse_idx;
Eric Dumazet65f76512008-01-03 20:46:48 -0800987#endif
Arnaldo Carvalho de Meloebb53d72007-11-21 22:08:50 +0800988
Eric Dumazetc9bee3b72013-07-22 20:27:07 -0700989 bool (*stream_memory_free)(const struct sock *sk);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700990 /* Memory pressure */
Pavel Emelyanov5c52ba12008-07-16 20:28:10 -0700991 void (*enter_memory_pressure)(struct sock *sk);
Eric Dumazet8d987e52010-11-09 23:24:26 +0000992 atomic_long_t *memory_allocated; /* Current allocated memory. */
Eric Dumazet17483762008-11-25 21:16:35 -0800993 struct percpu_counter *sockets_allocated; /* Current number of sockets. */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700994 /*
995 * Pressure flag: try to collapse.
996 * Technical note: it is used by multiple contexts non atomically.
Hideo Aoki3ab224b2007-12-31 00:11:19 -0800997 * All the __sk_mem_schedule() is of this nature: accounting
Linus Torvalds1da177e2005-04-16 15:20:36 -0700998 * is strict, actions are advisory and have some latency.
999 */
1000 int *memory_pressure;
Eric Dumazet8d987e52010-11-09 23:24:26 +00001001 long *sysctl_mem;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001002 int *sysctl_wmem;
1003 int *sysctl_rmem;
1004 int max_header;
Changli Gao7ba42912010-07-10 20:41:55 +00001005 bool no_autobind;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001006
Eric Dumazet271b72c2008-10-29 02:11:14 -07001007 struct kmem_cache *slab;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001008 unsigned int obj_size;
Eric Dumazet271b72c2008-10-29 02:11:14 -07001009 int slab_flags;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001010
Eric Dumazetdd24c002008-11-25 21:17:14 -08001011 struct percpu_counter *orphan_count;
Arnaldo Carvalho de Melo8feaf0c02005-08-09 20:09:30 -07001012
Arnaldo Carvalho de Melo60236fd2005-06-18 22:47:21 -07001013 struct request_sock_ops *rsk_prot;
Arnaldo Carvalho de Melo6d6ee432005-12-13 23:25:19 -08001014 struct timewait_sock_ops *twsk_prot;
Arnaldo Carvalho de Melo2e6599c2005-06-18 22:46:52 -07001015
Pavel Emelyanov39d8cda2008-03-22 16:50:58 -07001016 union {
1017 struct inet_hashinfo *hashinfo;
Eric Dumazet645ca702008-10-29 01:41:45 -07001018 struct udp_table *udp_table;
Pavel Emelyanovfc8717b2008-03-22 16:56:51 -07001019 struct raw_hashinfo *raw_hash;
Pavel Emelyanov39d8cda2008-03-22 16:50:58 -07001020 } h;
Arnaldo Carvalho de Meloab1e0a12008-02-03 04:06:04 -08001021
Linus Torvalds1da177e2005-04-16 15:20:36 -07001022 struct module *owner;
1023
1024 char name[32];
1025
1026 struct list_head node;
Arnaldo Carvalho de Meloe6848972005-08-09 19:45:38 -07001027#ifdef SOCK_REFCNT_DEBUG
1028 atomic_t socks;
1029#endif
Andrew Mortonc255a452012-07-31 16:43:02 -07001030#ifdef CONFIG_MEMCG_KMEM
Glauber Costae1aab162011-12-11 21:47:03 +00001031 /*
1032 * cgroup specific init/deinit functions. Called once for all
1033 * protocols that implement it, from cgroups populate function.
1034 * This function has to setup any files the protocol want to
1035 * appear in the kmem cgroup filesystem.
1036 */
Glauber Costa1d62e432012-04-09 19:36:33 -03001037 int (*init_cgroup)(struct mem_cgroup *memcg,
Glauber Costae1aab162011-12-11 21:47:03 +00001038 struct cgroup_subsys *ss);
Glauber Costa1d62e432012-04-09 19:36:33 -03001039 void (*destroy_cgroup)(struct mem_cgroup *memcg);
Glauber Costae1aab162011-12-11 21:47:03 +00001040 struct cg_proto *(*proto_cgroup)(struct mem_cgroup *memcg);
1041#endif
1042};
1043
Glauber Costa3f134612012-05-29 15:07:11 -07001044/*
1045 * Bits in struct cg_proto.flags
1046 */
1047enum cg_proto_flags {
1048 /* Currently active and new sockets should be assigned to cgroups */
1049 MEMCG_SOCK_ACTIVE,
1050 /* It was ever activated; we must disarm static keys on destruction */
1051 MEMCG_SOCK_ACTIVATED,
1052};
1053
Glauber Costae1aab162011-12-11 21:47:03 +00001054struct cg_proto {
Johannes Weiner3e32cb22014-12-10 15:42:31 -08001055 struct page_counter memory_allocated; /* Current allocated memory. */
Eric W. Biederman2e685ca2013-10-19 16:26:19 -07001056 struct percpu_counter sockets_allocated; /* Current number of sockets. */
1057 int memory_pressure;
1058 long sysctl_mem[3];
Glauber Costa3f134612012-05-29 15:07:11 -07001059 unsigned long flags;
Glauber Costae1aab162011-12-11 21:47:03 +00001060 /*
1061 * memcg field is used to find which memcg we belong directly
1062 * Each memcg struct can hold more than one cg_proto, so container_of
1063 * won't really cut.
1064 *
1065 * The elegant solution would be having an inverse function to
1066 * proto_cgroup in struct proto, but that means polluting the structure
1067 * for everybody, instead of just for memcg users.
1068 */
1069 struct mem_cgroup *memcg;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001070};
1071
Joe Perches69336bd2013-09-22 10:32:26 -07001072int proto_register(struct proto *prot, int alloc_slab);
1073void proto_unregister(struct proto *prot);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001074
Glauber Costa3f134612012-05-29 15:07:11 -07001075static inline bool memcg_proto_active(struct cg_proto *cg_proto)
1076{
1077 return test_bit(MEMCG_SOCK_ACTIVE, &cg_proto->flags);
1078}
1079
Arnaldo Carvalho de Meloe6848972005-08-09 19:45:38 -07001080#ifdef SOCK_REFCNT_DEBUG
1081static inline void sk_refcnt_debug_inc(struct sock *sk)
1082{
1083 atomic_inc(&sk->sk_prot->socks);
1084}
1085
1086static inline void sk_refcnt_debug_dec(struct sock *sk)
1087{
1088 atomic_dec(&sk->sk_prot->socks);
1089 printk(KERN_DEBUG "%s socket %p released, %d are still alive\n",
1090 sk->sk_prot->name, sk, atomic_read(&sk->sk_prot->socks));
1091}
1092
Ying Xuedec34fb2013-02-15 22:28:25 +00001093static inline void sk_refcnt_debug_release(const struct sock *sk)
Arnaldo Carvalho de Meloe6848972005-08-09 19:45:38 -07001094{
1095 if (atomic_read(&sk->sk_refcnt) != 1)
1096 printk(KERN_DEBUG "Destruction of the %s socket %p delayed, refcnt=%d\n",
1097 sk->sk_prot->name, sk, atomic_read(&sk->sk_refcnt));
1098}
1099#else /* SOCK_REFCNT_DEBUG */
1100#define sk_refcnt_debug_inc(sk) do { } while (0)
1101#define sk_refcnt_debug_dec(sk) do { } while (0)
1102#define sk_refcnt_debug_release(sk) do { } while (0)
1103#endif /* SOCK_REFCNT_DEBUG */
1104
Andrew Mortonc255a452012-07-31 16:43:02 -07001105#if defined(CONFIG_MEMCG_KMEM) && defined(CONFIG_NET)
Ingo Molnarc5905af2012-02-24 08:31:31 +01001106extern struct static_key memcg_socket_limit_enabled;
Glauber Costae1aab162011-12-11 21:47:03 +00001107static inline struct cg_proto *parent_cg_proto(struct proto *proto,
1108 struct cg_proto *cg_proto)
1109{
1110 return proto->proto_cgroup(parent_mem_cgroup(cg_proto->memcg));
1111}
Ingo Molnarc5905af2012-02-24 08:31:31 +01001112#define mem_cgroup_sockets_enabled static_key_false(&memcg_socket_limit_enabled)
Glauber Costae1aab162011-12-11 21:47:03 +00001113#else
1114#define mem_cgroup_sockets_enabled 0
1115static inline struct cg_proto *parent_cg_proto(struct proto *proto,
1116 struct cg_proto *cg_proto)
1117{
1118 return NULL;
1119}
1120#endif
1121
Eric Dumazetc9bee3b72013-07-22 20:27:07 -07001122static inline bool sk_stream_memory_free(const struct sock *sk)
1123{
1124 if (sk->sk_wmem_queued >= sk->sk_sndbuf)
1125 return false;
1126
1127 return sk->sk_prot->stream_memory_free ?
1128 sk->sk_prot->stream_memory_free(sk) : true;
1129}
1130
Eric Dumazet64dc6132013-07-22 20:26:31 -07001131static inline bool sk_stream_is_writeable(const struct sock *sk)
1132{
Eric Dumazetc9bee3b72013-07-22 20:27:07 -07001133 return sk_stream_wspace(sk) >= sk_stream_min_wspace(sk) &&
1134 sk_stream_memory_free(sk);
Eric Dumazet64dc6132013-07-22 20:26:31 -07001135}
Glauber Costae1aab162011-12-11 21:47:03 +00001136
Eric Dumazetc9bee3b72013-07-22 20:27:07 -07001137
Glauber Costa180d8cd2011-12-11 21:47:02 +00001138static inline bool sk_has_memory_pressure(const struct sock *sk)
1139{
1140 return sk->sk_prot->memory_pressure != NULL;
1141}
1142
1143static inline bool sk_under_memory_pressure(const struct sock *sk)
1144{
1145 if (!sk->sk_prot->memory_pressure)
1146 return false;
Glauber Costae1aab162011-12-11 21:47:03 +00001147
1148 if (mem_cgroup_sockets_enabled && sk->sk_cgrp)
Eric W. Biederman2e685ca2013-10-19 16:26:19 -07001149 return !!sk->sk_cgrp->memory_pressure;
Glauber Costae1aab162011-12-11 21:47:03 +00001150
Christoph Paasch35b87f62013-10-23 12:49:21 -07001151 return !!*sk->sk_prot->memory_pressure;
Glauber Costa180d8cd2011-12-11 21:47:02 +00001152}
1153
1154static inline void sk_leave_memory_pressure(struct sock *sk)
1155{
1156 int *memory_pressure = sk->sk_prot->memory_pressure;
1157
Glauber Costae1aab162011-12-11 21:47:03 +00001158 if (!memory_pressure)
1159 return;
1160
1161 if (*memory_pressure)
Glauber Costa180d8cd2011-12-11 21:47:02 +00001162 *memory_pressure = 0;
Glauber Costae1aab162011-12-11 21:47:03 +00001163
1164 if (mem_cgroup_sockets_enabled && sk->sk_cgrp) {
1165 struct cg_proto *cg_proto = sk->sk_cgrp;
1166 struct proto *prot = sk->sk_prot;
1167
1168 for (; cg_proto; cg_proto = parent_cg_proto(prot, cg_proto))
Eric W. Biederman7f2cbdc2013-12-04 20:12:04 -08001169 cg_proto->memory_pressure = 0;
Glauber Costae1aab162011-12-11 21:47:03 +00001170 }
1171
Glauber Costa180d8cd2011-12-11 21:47:02 +00001172}
1173
1174static inline void sk_enter_memory_pressure(struct sock *sk)
1175{
Glauber Costae1aab162011-12-11 21:47:03 +00001176 if (!sk->sk_prot->enter_memory_pressure)
1177 return;
1178
1179 if (mem_cgroup_sockets_enabled && sk->sk_cgrp) {
1180 struct cg_proto *cg_proto = sk->sk_cgrp;
1181 struct proto *prot = sk->sk_prot;
1182
1183 for (; cg_proto; cg_proto = parent_cg_proto(prot, cg_proto))
Eric W. Biederman7f2cbdc2013-12-04 20:12:04 -08001184 cg_proto->memory_pressure = 1;
Glauber Costae1aab162011-12-11 21:47:03 +00001185 }
1186
1187 sk->sk_prot->enter_memory_pressure(sk);
Glauber Costa180d8cd2011-12-11 21:47:02 +00001188}
1189
1190static inline long sk_prot_mem_limits(const struct sock *sk, int index)
1191{
1192 long *prot = sk->sk_prot->sysctl_mem;
Glauber Costae1aab162011-12-11 21:47:03 +00001193 if (mem_cgroup_sockets_enabled && sk->sk_cgrp)
1194 prot = sk->sk_cgrp->sysctl_mem;
Glauber Costa180d8cd2011-12-11 21:47:02 +00001195 return prot[index];
1196}
1197
Glauber Costae1aab162011-12-11 21:47:03 +00001198static inline void memcg_memory_allocated_add(struct cg_proto *prot,
1199 unsigned long amt,
1200 int *parent_status)
1201{
Johannes Weiner3e32cb22014-12-10 15:42:31 -08001202 page_counter_charge(&prot->memory_allocated, amt);
Glauber Costae1aab162011-12-11 21:47:03 +00001203
Johannes Weiner3e32cb22014-12-10 15:42:31 -08001204 if (page_counter_read(&prot->memory_allocated) >
1205 prot->memory_allocated.limit)
Glauber Costae1aab162011-12-11 21:47:03 +00001206 *parent_status = OVER_LIMIT;
1207}
1208
1209static inline void memcg_memory_allocated_sub(struct cg_proto *prot,
1210 unsigned long amt)
1211{
Johannes Weiner3e32cb22014-12-10 15:42:31 -08001212 page_counter_uncharge(&prot->memory_allocated, amt);
Glauber Costae1aab162011-12-11 21:47:03 +00001213}
1214
Glauber Costa180d8cd2011-12-11 21:47:02 +00001215static inline long
1216sk_memory_allocated(const struct sock *sk)
1217{
1218 struct proto *prot = sk->sk_prot;
Johannes Weiner3e32cb22014-12-10 15:42:31 -08001219
Glauber Costae1aab162011-12-11 21:47:03 +00001220 if (mem_cgroup_sockets_enabled && sk->sk_cgrp)
Johannes Weiner3e32cb22014-12-10 15:42:31 -08001221 return page_counter_read(&sk->sk_cgrp->memory_allocated);
Glauber Costae1aab162011-12-11 21:47:03 +00001222
Glauber Costa180d8cd2011-12-11 21:47:02 +00001223 return atomic_long_read(prot->memory_allocated);
1224}
1225
1226static inline long
Glauber Costae1aab162011-12-11 21:47:03 +00001227sk_memory_allocated_add(struct sock *sk, int amt, int *parent_status)
Glauber Costa180d8cd2011-12-11 21:47:02 +00001228{
1229 struct proto *prot = sk->sk_prot;
Glauber Costae1aab162011-12-11 21:47:03 +00001230
1231 if (mem_cgroup_sockets_enabled && sk->sk_cgrp) {
1232 memcg_memory_allocated_add(sk->sk_cgrp, amt, parent_status);
1233 /* update the root cgroup regardless */
1234 atomic_long_add_return(amt, prot->memory_allocated);
Johannes Weiner3e32cb22014-12-10 15:42:31 -08001235 return page_counter_read(&sk->sk_cgrp->memory_allocated);
Glauber Costae1aab162011-12-11 21:47:03 +00001236 }
1237
Glauber Costa180d8cd2011-12-11 21:47:02 +00001238 return atomic_long_add_return(amt, prot->memory_allocated);
1239}
1240
1241static inline void
Glauber Costa0e90b312012-01-20 04:57:16 +00001242sk_memory_allocated_sub(struct sock *sk, int amt)
Glauber Costa180d8cd2011-12-11 21:47:02 +00001243{
1244 struct proto *prot = sk->sk_prot;
Glauber Costae1aab162011-12-11 21:47:03 +00001245
Glauber Costa0e90b312012-01-20 04:57:16 +00001246 if (mem_cgroup_sockets_enabled && sk->sk_cgrp)
Glauber Costae1aab162011-12-11 21:47:03 +00001247 memcg_memory_allocated_sub(sk->sk_cgrp, amt);
1248
Glauber Costa180d8cd2011-12-11 21:47:02 +00001249 atomic_long_sub(amt, prot->memory_allocated);
1250}
1251
1252static inline void sk_sockets_allocated_dec(struct sock *sk)
1253{
1254 struct proto *prot = sk->sk_prot;
Glauber Costae1aab162011-12-11 21:47:03 +00001255
1256 if (mem_cgroup_sockets_enabled && sk->sk_cgrp) {
1257 struct cg_proto *cg_proto = sk->sk_cgrp;
1258
1259 for (; cg_proto; cg_proto = parent_cg_proto(prot, cg_proto))
Eric W. Biederman2e685ca2013-10-19 16:26:19 -07001260 percpu_counter_dec(&cg_proto->sockets_allocated);
Glauber Costae1aab162011-12-11 21:47:03 +00001261 }
1262
Glauber Costa180d8cd2011-12-11 21:47:02 +00001263 percpu_counter_dec(prot->sockets_allocated);
1264}
1265
1266static inline void sk_sockets_allocated_inc(struct sock *sk)
1267{
1268 struct proto *prot = sk->sk_prot;
Glauber Costae1aab162011-12-11 21:47:03 +00001269
1270 if (mem_cgroup_sockets_enabled && sk->sk_cgrp) {
1271 struct cg_proto *cg_proto = sk->sk_cgrp;
1272
1273 for (; cg_proto; cg_proto = parent_cg_proto(prot, cg_proto))
Eric W. Biederman2e685ca2013-10-19 16:26:19 -07001274 percpu_counter_inc(&cg_proto->sockets_allocated);
Glauber Costae1aab162011-12-11 21:47:03 +00001275 }
1276
Glauber Costa180d8cd2011-12-11 21:47:02 +00001277 percpu_counter_inc(prot->sockets_allocated);
1278}
1279
1280static inline int
1281sk_sockets_allocated_read_positive(struct sock *sk)
1282{
1283 struct proto *prot = sk->sk_prot;
1284
Glauber Costae1aab162011-12-11 21:47:03 +00001285 if (mem_cgroup_sockets_enabled && sk->sk_cgrp)
Eric W. Biederman2e685ca2013-10-19 16:26:19 -07001286 return percpu_counter_read_positive(&sk->sk_cgrp->sockets_allocated);
Glauber Costae1aab162011-12-11 21:47:03 +00001287
Eric Dumazet518fbf92012-04-28 23:21:56 +00001288 return percpu_counter_read_positive(prot->sockets_allocated);
Glauber Costa180d8cd2011-12-11 21:47:02 +00001289}
1290
1291static inline int
1292proto_sockets_allocated_sum_positive(struct proto *prot)
1293{
1294 return percpu_counter_sum_positive(prot->sockets_allocated);
1295}
1296
1297static inline long
1298proto_memory_allocated(struct proto *prot)
1299{
1300 return atomic_long_read(prot->memory_allocated);
1301}
1302
1303static inline bool
1304proto_memory_pressure(struct proto *prot)
1305{
1306 if (!prot->memory_pressure)
1307 return false;
1308 return !!*prot->memory_pressure;
1309}
1310
Eric Dumazet65f76512008-01-03 20:46:48 -08001311
1312#ifdef CONFIG_PROC_FS
Linus Torvalds1da177e2005-04-16 15:20:36 -07001313/* Called with local bh disabled */
Joe Perches69336bd2013-09-22 10:32:26 -07001314void sock_prot_inuse_add(struct net *net, struct proto *prot, int inc);
1315int sock_prot_inuse_get(struct net *net, struct proto *proto);
Eric Dumazet65f76512008-01-03 20:46:48 -08001316#else
Eric Dumazetdc6b9b72012-05-16 22:48:15 +00001317static inline void sock_prot_inuse_add(struct net *net, struct proto *prot,
Pavel Emelyanovc29a0bc2008-03-31 19:41:46 -07001318 int inc)
Eric Dumazet65f76512008-01-03 20:46:48 -08001319{
1320}
Eric Dumazet65f76512008-01-03 20:46:48 -08001321#endif
1322
Linus Torvalds1da177e2005-04-16 15:20:36 -07001323
Arnaldo Carvalho de Melo614c6cb2005-08-09 19:47:37 -07001324/* With per-bucket locks this operation is not-atomic, so that
1325 * this version is not worse.
1326 */
1327static inline void __sk_prot_rehash(struct sock *sk)
1328{
1329 sk->sk_prot->unhash(sk);
1330 sk->sk_prot->hash(sk);
1331}
1332
Octavian Purdilafcbdf092010-12-16 14:26:56 -08001333void sk_prot_clear_portaddr_nulls(struct sock *sk, int size);
1334
Linus Torvalds1da177e2005-04-16 15:20:36 -07001335/* About 10 seconds */
1336#define SOCK_DESTROY_TIME (10*HZ)
1337
1338/* Sockets 0-1023 can't be bound to unless you are superuser */
1339#define PROT_SOCK 1024
1340
1341#define SHUTDOWN_MASK 3
1342#define RCV_SHUTDOWN 1
1343#define SEND_SHUTDOWN 2
1344
1345#define SOCK_SNDBUF_LOCK 1
1346#define SOCK_RCVBUF_LOCK 2
1347#define SOCK_BINDADDR_LOCK 4
1348#define SOCK_BINDPORT_LOCK 8
1349
Linus Torvalds1da177e2005-04-16 15:20:36 -07001350struct socket_alloc {
1351 struct socket socket;
1352 struct inode vfs_inode;
1353};
1354
1355static inline struct socket *SOCKET_I(struct inode *inode)
1356{
1357 return &container_of(inode, struct socket_alloc, vfs_inode)->socket;
1358}
1359
1360static inline struct inode *SOCK_INODE(struct socket *socket)
1361{
1362 return &container_of(socket, struct socket_alloc, socket)->vfs_inode;
1363}
1364
Hideo Aoki3ab224b2007-12-31 00:11:19 -08001365/*
1366 * Functions for memory accounting
1367 */
Joe Perches69336bd2013-09-22 10:32:26 -07001368int __sk_mem_schedule(struct sock *sk, int size, int kind);
1369void __sk_mem_reclaim(struct sock *sk);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001370
Hideo Aoki3ab224b2007-12-31 00:11:19 -08001371#define SK_MEM_QUANTUM ((int)PAGE_SIZE)
1372#define SK_MEM_QUANTUM_SHIFT ilog2(SK_MEM_QUANTUM)
1373#define SK_MEM_SEND 0
1374#define SK_MEM_RECV 1
Linus Torvalds1da177e2005-04-16 15:20:36 -07001375
Hideo Aoki3ab224b2007-12-31 00:11:19 -08001376static inline int sk_mem_pages(int amt)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001377{
Hideo Aoki3ab224b2007-12-31 00:11:19 -08001378 return (amt + SK_MEM_QUANTUM - 1) >> SK_MEM_QUANTUM_SHIFT;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001379}
1380
Eric Dumazetdc6b9b72012-05-16 22:48:15 +00001381static inline bool sk_has_account(struct sock *sk)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001382{
Hideo Aoki3ab224b2007-12-31 00:11:19 -08001383 /* return true if protocol supports memory accounting */
1384 return !!sk->sk_prot->memory_allocated;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001385}
1386
Eric Dumazetdc6b9b72012-05-16 22:48:15 +00001387static inline bool sk_wmem_schedule(struct sock *sk, int size)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001388{
Hideo Aoki3ab224b2007-12-31 00:11:19 -08001389 if (!sk_has_account(sk))
Eric Dumazetdc6b9b72012-05-16 22:48:15 +00001390 return true;
Herbert Xud80d99d2005-09-01 17:48:23 -07001391 return size <= sk->sk_forward_alloc ||
Hideo Aoki3ab224b2007-12-31 00:11:19 -08001392 __sk_mem_schedule(sk, size, SK_MEM_SEND);
1393}
1394
Mel Gormanc76562b2012-07-31 16:44:41 -07001395static inline bool
Chuck Lever35c448a2012-09-17 14:09:11 -07001396sk_rmem_schedule(struct sock *sk, struct sk_buff *skb, int size)
Hideo Aoki3ab224b2007-12-31 00:11:19 -08001397{
1398 if (!sk_has_account(sk))
Eric Dumazetdc6b9b72012-05-16 22:48:15 +00001399 return true;
Mel Gormanc76562b2012-07-31 16:44:41 -07001400 return size<= sk->sk_forward_alloc ||
1401 __sk_mem_schedule(sk, size, SK_MEM_RECV) ||
1402 skb_pfmemalloc(skb);
Hideo Aoki3ab224b2007-12-31 00:11:19 -08001403}
1404
1405static inline void sk_mem_reclaim(struct sock *sk)
1406{
1407 if (!sk_has_account(sk))
1408 return;
1409 if (sk->sk_forward_alloc >= SK_MEM_QUANTUM)
1410 __sk_mem_reclaim(sk);
1411}
1412
David S. Miller9993e7d2008-01-10 21:56:38 -08001413static inline void sk_mem_reclaim_partial(struct sock *sk)
1414{
1415 if (!sk_has_account(sk))
1416 return;
1417 if (sk->sk_forward_alloc > SK_MEM_QUANTUM)
1418 __sk_mem_reclaim(sk);
1419}
1420
Hideo Aoki3ab224b2007-12-31 00:11:19 -08001421static inline void sk_mem_charge(struct sock *sk, int size)
1422{
1423 if (!sk_has_account(sk))
1424 return;
1425 sk->sk_forward_alloc -= size;
1426}
1427
1428static inline void sk_mem_uncharge(struct sock *sk, int size)
1429{
1430 if (!sk_has_account(sk))
1431 return;
1432 sk->sk_forward_alloc += size;
1433}
1434
1435static inline void sk_wmem_free_skb(struct sock *sk, struct sk_buff *skb)
1436{
Hideo Aoki3ab224b2007-12-31 00:11:19 -08001437 sock_set_flag(sk, SOCK_QUEUE_SHRUNK);
1438 sk->sk_wmem_queued -= skb->truesize;
1439 sk_mem_uncharge(sk, skb->truesize);
1440 __kfree_skb(skb);
Herbert Xud80d99d2005-09-01 17:48:23 -07001441}
1442
Linus Torvalds1da177e2005-04-16 15:20:36 -07001443/* Used by processes to "lock" a socket state, so that
1444 * interrupts and bottom half handlers won't change it
1445 * from under us. It essentially blocks any incoming
1446 * packets, so that we won't get any new data or any
1447 * packets that change the state of the socket.
1448 *
1449 * While locked, BH processing will add new packets to
1450 * the backlog queue. This queue is processed by the
1451 * owner of the socket lock right before it is released.
1452 *
1453 * Since ~2.3.5 it is also exclusive sleep lock serializing
1454 * accesses from user process context.
1455 */
John Heffnerd2e91172007-09-12 10:44:19 +02001456#define sock_owned_by_user(sk) ((sk)->sk_lock.owned)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001457
Eric Dumazetc3f9b012014-03-10 09:50:11 -07001458static inline void sock_release_ownership(struct sock *sk)
1459{
1460 sk->sk_lock.owned = 0;
1461}
1462
Peter Zijlstraed075362006-12-06 20:35:24 -08001463/*
1464 * Macro so as to not evaluate some arguments when
1465 * lockdep is not enabled.
1466 *
1467 * Mark both the sk_lock and the sk_lock.slock as a
1468 * per-address-family lock class.
1469 */
Eric Dumazetdc6b9b72012-05-16 22:48:15 +00001470#define sock_lock_init_class_and_name(sk, sname, skey, name, key) \
Peter Zijlstraed075362006-12-06 20:35:24 -08001471do { \
Ingo Molnare8f6fbf2008-11-12 01:38:36 +00001472 sk->sk_lock.owned = 0; \
Peter Zijlstraed075362006-12-06 20:35:24 -08001473 init_waitqueue_head(&sk->sk_lock.wq); \
1474 spin_lock_init(&(sk)->sk_lock.slock); \
1475 debug_check_no_locks_freed((void *)&(sk)->sk_lock, \
1476 sizeof((sk)->sk_lock)); \
1477 lockdep_set_class_and_name(&(sk)->sk_lock.slock, \
Eric Dumazetdc6b9b72012-05-16 22:48:15 +00001478 (skey), (sname)); \
Peter Zijlstraed075362006-12-06 20:35:24 -08001479 lockdep_init_map(&(sk)->sk_lock.dep_map, (name), (key), 0); \
1480} while (0)
1481
Joe Perches69336bd2013-09-22 10:32:26 -07001482void lock_sock_nested(struct sock *sk, int subclass);
Peter Zijlstrafcc70d52006-11-08 22:44:35 -08001483
1484static inline void lock_sock(struct sock *sk)
1485{
1486 lock_sock_nested(sk, 0);
1487}
1488
Joe Perches69336bd2013-09-22 10:32:26 -07001489void release_sock(struct sock *sk);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001490
1491/* BH context may only use the following locking interface. */
1492#define bh_lock_sock(__sk) spin_lock(&((__sk)->sk_lock.slock))
Ingo Molnarc6366182006-07-03 00:25:13 -07001493#define bh_lock_sock_nested(__sk) \
1494 spin_lock_nested(&((__sk)->sk_lock.slock), \
1495 SINGLE_DEPTH_NESTING)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001496#define bh_unlock_sock(__sk) spin_unlock(&((__sk)->sk_lock.slock))
1497
Joe Perches69336bd2013-09-22 10:32:26 -07001498bool lock_sock_fast(struct sock *sk);
Eric Dumazet8a74ad62010-05-26 19:20:18 +00001499/**
1500 * unlock_sock_fast - complement of lock_sock_fast
1501 * @sk: socket
1502 * @slow: slow mode
1503 *
1504 * fast unlock socket for user context.
1505 * If slow mode is on, we call regular release_sock()
1506 */
1507static inline void unlock_sock_fast(struct sock *sk, bool slow)
Eric Dumazet4b0b72f2010-04-28 14:35:48 -07001508{
Eric Dumazet8a74ad62010-05-26 19:20:18 +00001509 if (slow)
1510 release_sock(sk);
1511 else
1512 spin_unlock_bh(&sk->sk_lock.slock);
Eric Dumazet4b0b72f2010-04-28 14:35:48 -07001513}
1514
Eric Dumazet4b0b72f2010-04-28 14:35:48 -07001515
Joe Perches69336bd2013-09-22 10:32:26 -07001516struct sock *sk_alloc(struct net *net, int family, gfp_t priority,
1517 struct proto *prot);
1518void sk_free(struct sock *sk);
1519void sk_release_kernel(struct sock *sk);
1520struct sock *sk_clone_lock(const struct sock *sk, const gfp_t priority);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001521
Joe Perches69336bd2013-09-22 10:32:26 -07001522struct sk_buff *sock_wmalloc(struct sock *sk, unsigned long size, int force,
1523 gfp_t priority);
Joe Perches69336bd2013-09-22 10:32:26 -07001524void sock_wfree(struct sk_buff *skb);
1525void skb_orphan_partial(struct sk_buff *skb);
1526void sock_rfree(struct sk_buff *skb);
Alexander Duyck62bccb82014-09-04 13:31:35 -04001527void sock_efree(struct sk_buff *skb);
Alexander Duyck82eabd92014-09-04 13:32:11 -04001528#ifdef CONFIG_INET
Joe Perches69336bd2013-09-22 10:32:26 -07001529void sock_edemux(struct sk_buff *skb);
Alexander Duyck82eabd92014-09-04 13:32:11 -04001530#else
1531#define sock_edemux(skb) sock_efree(skb)
1532#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -07001533
Joe Perches69336bd2013-09-22 10:32:26 -07001534int sock_setsockopt(struct socket *sock, int level, int op,
1535 char __user *optval, unsigned int optlen);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001536
Joe Perches69336bd2013-09-22 10:32:26 -07001537int sock_getsockopt(struct socket *sock, int level, int op,
1538 char __user *optval, int __user *optlen);
1539struct sk_buff *sock_alloc_send_skb(struct sock *sk, unsigned long size,
1540 int noblock, int *errcode);
1541struct sk_buff *sock_alloc_send_pskb(struct sock *sk, unsigned long header_len,
1542 unsigned long data_len, int noblock,
1543 int *errcode, int max_page_order);
1544void *sock_kmalloc(struct sock *sk, int size, gfp_t priority);
1545void sock_kfree_s(struct sock *sk, void *mem, int size);
Daniel Borkmann79e88652014-11-19 17:13:11 +01001546void sock_kzfree_s(struct sock *sk, void *mem, int size);
Joe Perches69336bd2013-09-22 10:32:26 -07001547void sk_send_sigurg(struct sock *sk);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001548
1549/*
1550 * Functions to fill in entries in struct proto_ops when a protocol
1551 * does not implement a particular function.
1552 */
Joe Perches69336bd2013-09-22 10:32:26 -07001553int sock_no_bind(struct socket *, struct sockaddr *, int);
1554int sock_no_connect(struct socket *, struct sockaddr *, int, int);
1555int sock_no_socketpair(struct socket *, struct socket *);
1556int sock_no_accept(struct socket *, struct socket *, int);
1557int sock_no_getname(struct socket *, struct sockaddr *, int *, int);
1558unsigned int sock_no_poll(struct file *, struct socket *,
1559 struct poll_table_struct *);
1560int sock_no_ioctl(struct socket *, unsigned int, unsigned long);
1561int sock_no_listen(struct socket *, int);
1562int sock_no_shutdown(struct socket *, int);
1563int sock_no_getsockopt(struct socket *, int , int, char __user *, int __user *);
1564int sock_no_setsockopt(struct socket *, int, int, char __user *, unsigned int);
Ying Xue1b784142015-03-02 15:37:48 +08001565int sock_no_sendmsg(struct socket *, struct msghdr *, size_t);
1566int sock_no_recvmsg(struct socket *, struct msghdr *, size_t, int);
Joe Perches69336bd2013-09-22 10:32:26 -07001567int sock_no_mmap(struct file *file, struct socket *sock,
1568 struct vm_area_struct *vma);
1569ssize_t sock_no_sendpage(struct socket *sock, struct page *page, int offset,
1570 size_t size, int flags);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001571
1572/*
1573 * Functions to fill in entries in struct proto_ops when a protocol
1574 * uses the inet style.
1575 */
Joe Perches69336bd2013-09-22 10:32:26 -07001576int sock_common_getsockopt(struct socket *sock, int level, int optname,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001577 char __user *optval, int __user *optlen);
Ying Xue1b784142015-03-02 15:37:48 +08001578int sock_common_recvmsg(struct socket *sock, struct msghdr *msg, size_t size,
1579 int flags);
Joe Perches69336bd2013-09-22 10:32:26 -07001580int sock_common_setsockopt(struct socket *sock, int level, int optname,
David S. Millerb7058842009-09-30 16:12:20 -07001581 char __user *optval, unsigned int optlen);
Joe Perches69336bd2013-09-22 10:32:26 -07001582int compat_sock_common_getsockopt(struct socket *sock, int level,
Dmitry Mishin3fdadf72006-03-20 22:45:21 -08001583 int optname, char __user *optval, int __user *optlen);
Joe Perches69336bd2013-09-22 10:32:26 -07001584int compat_sock_common_setsockopt(struct socket *sock, int level,
David S. Millerb7058842009-09-30 16:12:20 -07001585 int optname, char __user *optval, unsigned int optlen);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001586
Joe Perches69336bd2013-09-22 10:32:26 -07001587void sk_common_release(struct sock *sk);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001588
1589/*
1590 * Default socket callbacks and setup code
1591 */
Eric Dumazetdc6b9b72012-05-16 22:48:15 +00001592
Linus Torvalds1da177e2005-04-16 15:20:36 -07001593/* Initialise core socket variables */
Joe Perches69336bd2013-09-22 10:32:26 -07001594void sock_init_data(struct socket *sock, struct sock *sk);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001595
Linus Torvalds1da177e2005-04-16 15:20:36 -07001596/*
1597 * Socket reference counting postulates.
1598 *
1599 * * Each user of socket SHOULD hold a reference count.
1600 * * Each access point to socket (an hash table bucket, reference from a list,
1601 * running timer, skb in flight MUST hold a reference count.
1602 * * When reference count hits 0, it means it will never increase back.
1603 * * When reference count hits 0, it means that no references from
1604 * outside exist to this socket and current process on current CPU
1605 * is last user and may/should destroy this socket.
1606 * * sk_free is called from any context: process, BH, IRQ. When
1607 * it is called, socket has no references from outside -> sk_free
1608 * may release descendant resources allocated by the socket, but
1609 * to the time when it is called, socket is NOT referenced by any
1610 * hash tables, lists etc.
1611 * * Packets, delivered from outside (from network or from another process)
1612 * and enqueued on receive/error queues SHOULD NOT grab reference count,
1613 * when they sit in queue. Otherwise, packets will leak to hole, when
1614 * socket is looked up by one cpu and unhasing is made by another CPU.
1615 * It is true for udp/raw, netlink (leak to receive and error queues), tcp
1616 * (leak to backlog). Packet socket does all the processing inside
1617 * BR_NETPROTO_LOCK, so that it has not this race condition. UNIX sockets
1618 * use separate SMP lock, so that they are prone too.
1619 */
1620
1621/* Ungrab socket and destroy it, if it was the last reference. */
1622static inline void sock_put(struct sock *sk)
1623{
1624 if (atomic_dec_and_test(&sk->sk_refcnt))
1625 sk_free(sk);
1626}
Eric Dumazet05dbc7b2013-10-03 00:22:02 -07001627/* Generic version of sock_put(), dealing with all sockets
Eric Dumazet41b822c2015-03-12 16:44:08 -07001628 * (TCP_TIMEWAIT, TCP_NEW_SYN_RECV, ESTABLISHED...)
Eric Dumazet05dbc7b2013-10-03 00:22:02 -07001629 */
1630void sock_gen_put(struct sock *sk);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001631
Joe Perches69336bd2013-09-22 10:32:26 -07001632int sk_receive_skb(struct sock *sk, struct sk_buff *skb, const int nested);
Arnaldo Carvalho de Melo25995ff2005-12-27 02:42:22 -02001633
Krishna Kumare022f0b2009-10-19 23:46:20 +00001634static inline void sk_tx_queue_set(struct sock *sk, int tx_queue)
1635{
1636 sk->sk_tx_queue_mapping = tx_queue;
1637}
1638
1639static inline void sk_tx_queue_clear(struct sock *sk)
1640{
1641 sk->sk_tx_queue_mapping = -1;
1642}
1643
1644static inline int sk_tx_queue_get(const struct sock *sk)
1645{
Tom Herbertb0f77d02010-07-14 20:50:29 -07001646 return sk ? sk->sk_tx_queue_mapping : -1;
Krishna Kumare022f0b2009-10-19 23:46:20 +00001647}
1648
David S. Miller972692e2008-06-17 22:41:38 -07001649static inline void sk_set_socket(struct sock *sk, struct socket *sock)
1650{
Krishna Kumare022f0b2009-10-19 23:46:20 +00001651 sk_tx_queue_clear(sk);
David S. Miller972692e2008-06-17 22:41:38 -07001652 sk->sk_socket = sock;
1653}
1654
Eric Dumazetaa395142010-04-20 13:03:51 +00001655static inline wait_queue_head_t *sk_sleep(struct sock *sk)
1656{
Eric Dumazeteaefd112011-02-18 03:26:36 +00001657 BUILD_BUG_ON(offsetof(struct socket_wq, wait) != 0);
1658 return &rcu_dereference_raw(sk->sk_wq)->wait;
Eric Dumazetaa395142010-04-20 13:03:51 +00001659}
Linus Torvalds1da177e2005-04-16 15:20:36 -07001660/* Detach socket from process context.
1661 * Announce socket dead, detach it from wait queue and inode.
1662 * Note that parent inode held reference count on this struct sock,
1663 * we do not release it in this function, because protocol
1664 * probably wants some additional cleanups or even continuing
1665 * to work with this socket (TCP).
1666 */
1667static inline void sock_orphan(struct sock *sk)
1668{
1669 write_lock_bh(&sk->sk_callback_lock);
1670 sock_set_flag(sk, SOCK_DEAD);
David S. Miller972692e2008-06-17 22:41:38 -07001671 sk_set_socket(sk, NULL);
Eric Dumazet43815482010-04-29 11:01:49 +00001672 sk->sk_wq = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001673 write_unlock_bh(&sk->sk_callback_lock);
1674}
1675
1676static inline void sock_graft(struct sock *sk, struct socket *parent)
1677{
1678 write_lock_bh(&sk->sk_callback_lock);
Eric Dumazeteaefd112011-02-18 03:26:36 +00001679 sk->sk_wq = parent->wq;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001680 parent->sk = sk;
David S. Miller972692e2008-06-17 22:41:38 -07001681 sk_set_socket(sk, parent);
Venkat Yekkirala4237c752006-07-24 23:32:50 -07001682 security_sock_graft(sk, parent);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001683 write_unlock_bh(&sk->sk_callback_lock);
1684}
1685
Joe Perches69336bd2013-09-22 10:32:26 -07001686kuid_t sock_i_uid(struct sock *sk);
1687unsigned long sock_i_ino(struct sock *sk);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001688
1689static inline struct dst_entry *
1690__sk_dst_get(struct sock *sk)
1691{
Michal Hockod8bf4ca2011-07-08 14:39:41 +02001692 return rcu_dereference_check(sk->sk_dst_cache, sock_owned_by_user(sk) ||
Eric Dumazetf68c2242010-04-22 16:06:59 -07001693 lockdep_is_held(&sk->sk_lock.slock));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001694}
1695
1696static inline struct dst_entry *
1697sk_dst_get(struct sock *sk)
1698{
1699 struct dst_entry *dst;
1700
Eric Dumazetb6c67122010-04-08 23:03:29 +00001701 rcu_read_lock();
1702 dst = rcu_dereference(sk->sk_dst_cache);
Eric Dumazetf8864972014-06-24 10:05:11 -07001703 if (dst && !atomic_inc_not_zero(&dst->__refcnt))
1704 dst = NULL;
Eric Dumazetb6c67122010-04-08 23:03:29 +00001705 rcu_read_unlock();
Linus Torvalds1da177e2005-04-16 15:20:36 -07001706 return dst;
1707}
1708
Eric Dumazetb6c67122010-04-08 23:03:29 +00001709static inline void dst_negative_advice(struct sock *sk)
1710{
1711 struct dst_entry *ndst, *dst = __sk_dst_get(sk);
1712
1713 if (dst && dst->ops->negative_advice) {
1714 ndst = dst->ops->negative_advice(dst);
1715
1716 if (ndst != dst) {
1717 rcu_assign_pointer(sk->sk_dst_cache, ndst);
ZHAO Gang0a6957e2013-10-22 16:23:38 +08001718 sk_tx_queue_clear(sk);
Eric Dumazetb6c67122010-04-08 23:03:29 +00001719 }
1720 }
1721}
1722
Linus Torvalds1da177e2005-04-16 15:20:36 -07001723static inline void
1724__sk_dst_set(struct sock *sk, struct dst_entry *dst)
1725{
1726 struct dst_entry *old_dst;
1727
Krishna Kumare022f0b2009-10-19 23:46:20 +00001728 sk_tx_queue_clear(sk);
Eric Dumazet0b53ff22010-04-26 20:40:43 +00001729 /*
1730 * This can be called while sk is owned by the caller only,
1731 * with no state that can be checked in a rcu_dereference_check() cond
1732 */
1733 old_dst = rcu_dereference_raw(sk->sk_dst_cache);
Eric Dumazetb6c67122010-04-08 23:03:29 +00001734 rcu_assign_pointer(sk->sk_dst_cache, dst);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001735 dst_release(old_dst);
1736}
1737
1738static inline void
1739sk_dst_set(struct sock *sk, struct dst_entry *dst)
1740{
Eric Dumazet7f502362014-06-30 01:26:23 -07001741 struct dst_entry *old_dst;
1742
1743 sk_tx_queue_clear(sk);
Eric Dumazet5925a052014-07-02 02:39:38 -07001744 old_dst = xchg((__force struct dst_entry **)&sk->sk_dst_cache, dst);
Eric Dumazet7f502362014-06-30 01:26:23 -07001745 dst_release(old_dst);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001746}
1747
1748static inline void
1749__sk_dst_reset(struct sock *sk)
1750{
Eric Dumazetb6c67122010-04-08 23:03:29 +00001751 __sk_dst_set(sk, NULL);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001752}
1753
1754static inline void
1755sk_dst_reset(struct sock *sk)
1756{
Eric Dumazet7f502362014-06-30 01:26:23 -07001757 sk_dst_set(sk, NULL);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001758}
1759
Joe Perches69336bd2013-09-22 10:32:26 -07001760struct dst_entry *__sk_dst_check(struct sock *sk, u32 cookie);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001761
Joe Perches69336bd2013-09-22 10:32:26 -07001762struct dst_entry *sk_dst_check(struct sock *sk, u32 cookie);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001763
Eric Dumazetdc6b9b72012-05-16 22:48:15 +00001764static inline bool sk_can_gso(const struct sock *sk)
Herbert Xubcd76112006-06-30 13:36:35 -07001765{
1766 return net_gso_ok(sk->sk_route_caps, sk->sk_gso_type);
1767}
1768
Joe Perches69336bd2013-09-22 10:32:26 -07001769void sk_setup_caps(struct sock *sk, struct dst_entry *dst);
Arnaldo Carvalho de Melo6cbb0df2005-08-09 19:49:02 -07001770
Michał Mirosławc8f44af2011-11-15 15:29:55 +00001771static inline void sk_nocaps_add(struct sock *sk, netdev_features_t flags)
Eric Dumazeta4654192010-05-16 00:36:33 -07001772{
1773 sk->sk_route_nocaps |= flags;
1774 sk->sk_route_caps &= ~flags;
1775}
1776
Tom Herbertc6e1a0d2011-04-04 22:30:30 -07001777static inline int skb_do_copy_data_nocache(struct sock *sk, struct sk_buff *skb,
Al Viro57be5bd2014-11-28 13:40:20 -05001778 struct iov_iter *from, char *to,
Wei Yongjun912d3982011-04-06 18:40:12 +00001779 int copy, int offset)
Tom Herbertc6e1a0d2011-04-04 22:30:30 -07001780{
1781 if (skb->ip_summed == CHECKSUM_NONE) {
Al Viro57be5bd2014-11-28 13:40:20 -05001782 __wsum csum = 0;
1783 if (csum_and_copy_from_iter(to, copy, &csum, from) != copy)
1784 return -EFAULT;
Wei Yongjun912d3982011-04-06 18:40:12 +00001785 skb->csum = csum_block_add(skb->csum, csum, offset);
Tom Herbertc6e1a0d2011-04-04 22:30:30 -07001786 } else if (sk->sk_route_caps & NETIF_F_NOCACHE_COPY) {
Al Viro57be5bd2014-11-28 13:40:20 -05001787 if (copy_from_iter_nocache(to, copy, from) != copy)
Tom Herbertc6e1a0d2011-04-04 22:30:30 -07001788 return -EFAULT;
Al Viro57be5bd2014-11-28 13:40:20 -05001789 } else if (copy_from_iter(to, copy, from) != copy)
Tom Herbertc6e1a0d2011-04-04 22:30:30 -07001790 return -EFAULT;
1791
1792 return 0;
1793}
1794
1795static inline int skb_add_data_nocache(struct sock *sk, struct sk_buff *skb,
Al Viro57be5bd2014-11-28 13:40:20 -05001796 struct iov_iter *from, int copy)
Tom Herbertc6e1a0d2011-04-04 22:30:30 -07001797{
Wei Yongjun912d3982011-04-06 18:40:12 +00001798 int err, offset = skb->len;
Tom Herbertc6e1a0d2011-04-04 22:30:30 -07001799
Wei Yongjun912d3982011-04-06 18:40:12 +00001800 err = skb_do_copy_data_nocache(sk, skb, from, skb_put(skb, copy),
1801 copy, offset);
Tom Herbertc6e1a0d2011-04-04 22:30:30 -07001802 if (err)
Wei Yongjun912d3982011-04-06 18:40:12 +00001803 __skb_trim(skb, offset);
Tom Herbertc6e1a0d2011-04-04 22:30:30 -07001804
1805 return err;
1806}
1807
Al Viro57be5bd2014-11-28 13:40:20 -05001808static inline int skb_copy_to_page_nocache(struct sock *sk, struct iov_iter *from,
Tom Herbertc6e1a0d2011-04-04 22:30:30 -07001809 struct sk_buff *skb,
1810 struct page *page,
1811 int off, int copy)
1812{
1813 int err;
1814
Wei Yongjun912d3982011-04-06 18:40:12 +00001815 err = skb_do_copy_data_nocache(sk, skb, from, page_address(page) + off,
1816 copy, skb->len);
Tom Herbertc6e1a0d2011-04-04 22:30:30 -07001817 if (err)
1818 return err;
1819
1820 skb->len += copy;
1821 skb->data_len += copy;
1822 skb->truesize += copy;
1823 sk->sk_wmem_queued += copy;
1824 sk_mem_charge(sk, copy);
1825 return 0;
1826}
1827
Eric Dumazetc5640392009-06-16 10:12:03 +00001828/**
1829 * sk_wmem_alloc_get - returns write allocations
1830 * @sk: socket
1831 *
1832 * Returns sk_wmem_alloc minus initial offset of one
1833 */
1834static inline int sk_wmem_alloc_get(const struct sock *sk)
1835{
1836 return atomic_read(&sk->sk_wmem_alloc) - 1;
1837}
1838
1839/**
1840 * sk_rmem_alloc_get - returns read allocations
1841 * @sk: socket
1842 *
1843 * Returns sk_rmem_alloc
1844 */
1845static inline int sk_rmem_alloc_get(const struct sock *sk)
1846{
1847 return atomic_read(&sk->sk_rmem_alloc);
1848}
1849
1850/**
1851 * sk_has_allocations - check if allocations are outstanding
1852 * @sk: socket
1853 *
1854 * Returns true if socket has write or read allocations
1855 */
Eric Dumazetdc6b9b72012-05-16 22:48:15 +00001856static inline bool sk_has_allocations(const struct sock *sk)
Eric Dumazetc5640392009-06-16 10:12:03 +00001857{
1858 return sk_wmem_alloc_get(sk) || sk_rmem_alloc_get(sk);
1859}
1860
Jiri Olsaa57de0b2009-07-08 12:09:13 +00001861/**
Eric Dumazet43815482010-04-29 11:01:49 +00001862 * wq_has_sleeper - check if there are any waiting processes
Randy Dunlapacfbe962010-05-24 23:54:18 -07001863 * @wq: struct socket_wq
Jiri Olsaa57de0b2009-07-08 12:09:13 +00001864 *
Eric Dumazet43815482010-04-29 11:01:49 +00001865 * Returns true if socket_wq has waiting processes
Jiri Olsaa57de0b2009-07-08 12:09:13 +00001866 *
Eric Dumazet43815482010-04-29 11:01:49 +00001867 * The purpose of the wq_has_sleeper and sock_poll_wait is to wrap the memory
Jiri Olsaa57de0b2009-07-08 12:09:13 +00001868 * barrier call. They were added due to the race found within the tcp code.
1869 *
1870 * Consider following tcp code paths:
1871 *
1872 * CPU1 CPU2
1873 *
1874 * sys_select receive packet
1875 * ... ...
1876 * __add_wait_queue update tp->rcv_nxt
1877 * ... ...
1878 * tp->rcv_nxt check sock_def_readable
1879 * ... {
Eric Dumazet43815482010-04-29 11:01:49 +00001880 * schedule rcu_read_lock();
1881 * wq = rcu_dereference(sk->sk_wq);
1882 * if (wq && waitqueue_active(&wq->wait))
1883 * wake_up_interruptible(&wq->wait)
Jiri Olsaa57de0b2009-07-08 12:09:13 +00001884 * ...
1885 * }
1886 *
1887 * The race for tcp fires when the __add_wait_queue changes done by CPU1 stay
1888 * in its cache, and so does the tp->rcv_nxt update on CPU2 side. The CPU1
1889 * could then endup calling schedule and sleep forever if there are no more
1890 * data on the socket.
Jiri Olsaad462762009-07-08 12:10:31 +00001891 *
Jiri Olsaa57de0b2009-07-08 12:09:13 +00001892 */
Eric Dumazet43815482010-04-29 11:01:49 +00001893static inline bool wq_has_sleeper(struct socket_wq *wq)
Jiri Olsaa57de0b2009-07-08 12:09:13 +00001894{
Eric Dumazetdc6b9b72012-05-16 22:48:15 +00001895 /* We need to be sure we are in sync with the
Jiri Olsaa57de0b2009-07-08 12:09:13 +00001896 * add_wait_queue modifications to the wait queue.
1897 *
1898 * This memory barrier is paired in the sock_poll_wait.
1899 */
Eric Dumazet43815482010-04-29 11:01:49 +00001900 smp_mb();
1901 return wq && waitqueue_active(&wq->wait);
Jiri Olsaa57de0b2009-07-08 12:09:13 +00001902}
1903
1904/**
1905 * sock_poll_wait - place memory barrier behind the poll_wait call.
1906 * @filp: file
1907 * @wait_address: socket wait queue
1908 * @p: poll_table
1909 *
Eric Dumazet43815482010-04-29 11:01:49 +00001910 * See the comments in the wq_has_sleeper function.
Jiri Olsaa57de0b2009-07-08 12:09:13 +00001911 */
1912static inline void sock_poll_wait(struct file *filp,
1913 wait_queue_head_t *wait_address, poll_table *p)
1914{
Hans Verkuil626cf232012-03-23 15:02:27 -07001915 if (!poll_does_not_wait(p) && wait_address) {
Jiri Olsaa57de0b2009-07-08 12:09:13 +00001916 poll_wait(filp, wait_address, p);
Eric Dumazetdc6b9b72012-05-16 22:48:15 +00001917 /* We need to be sure we are in sync with the
Jiri Olsaa57de0b2009-07-08 12:09:13 +00001918 * socket flags modification.
1919 *
Eric Dumazet43815482010-04-29 11:01:49 +00001920 * This memory barrier is paired in the wq_has_sleeper.
Eric Dumazetdc6b9b72012-05-16 22:48:15 +00001921 */
Jiri Olsaa57de0b2009-07-08 12:09:13 +00001922 smp_mb();
1923 }
1924}
1925
Tom Herbertb73c3d02014-07-01 21:32:17 -07001926static inline void skb_set_hash_from_sk(struct sk_buff *skb, struct sock *sk)
1927{
1928 if (sk->sk_txhash) {
1929 skb->l4_hash = 1;
1930 skb->hash = sk->sk_txhash;
1931 }
1932}
1933
Linus Torvalds1da177e2005-04-16 15:20:36 -07001934/*
Eric Dumazetdc6b9b72012-05-16 22:48:15 +00001935 * Queue a received datagram if it will fit. Stream and sequenced
Linus Torvalds1da177e2005-04-16 15:20:36 -07001936 * protocols can't normally use this as they need to fit buffers in
1937 * and play with them.
1938 *
Eric Dumazetdc6b9b72012-05-16 22:48:15 +00001939 * Inlined as it's very short and called for pretty much every
Linus Torvalds1da177e2005-04-16 15:20:36 -07001940 * packet ever received.
1941 */
1942
1943static inline void skb_set_owner_w(struct sk_buff *skb, struct sock *sk)
1944{
Herbert Xud55d87f2009-06-22 02:25:25 +00001945 skb_orphan(skb);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001946 skb->sk = sk;
1947 skb->destructor = sock_wfree;
Tom Herbertb73c3d02014-07-01 21:32:17 -07001948 skb_set_hash_from_sk(skb, sk);
Eric Dumazet2b85a342009-06-11 02:55:43 -07001949 /*
1950 * We used to take a refcount on sk, but following operation
1951 * is enough to guarantee sk_free() wont free this sock until
1952 * all in-flight packets are completed
1953 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001954 atomic_add(skb->truesize, &sk->sk_wmem_alloc);
1955}
1956
1957static inline void skb_set_owner_r(struct sk_buff *skb, struct sock *sk)
1958{
Herbert Xud55d87f2009-06-22 02:25:25 +00001959 skb_orphan(skb);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001960 skb->sk = sk;
1961 skb->destructor = sock_rfree;
1962 atomic_add(skb->truesize, &sk->sk_rmem_alloc);
Hideo Aoki3ab224b2007-12-31 00:11:19 -08001963 sk_mem_charge(sk, skb->truesize);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001964}
1965
Joe Perches69336bd2013-09-22 10:32:26 -07001966void sk_reset_timer(struct sock *sk, struct timer_list *timer,
1967 unsigned long expires);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001968
Joe Perches69336bd2013-09-22 10:32:26 -07001969void sk_stop_timer(struct sock *sk, struct timer_list *timer);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001970
Joe Perches69336bd2013-09-22 10:32:26 -07001971int sock_queue_rcv_skb(struct sock *sk, struct sk_buff *skb);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001972
Joe Perches69336bd2013-09-22 10:32:26 -07001973int sock_queue_err_skb(struct sock *sk, struct sk_buff *skb);
Willem de Bruijn364a9e92014-08-31 21:30:27 -04001974struct sk_buff *sock_dequeue_err_skb(struct sock *sk);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001975
1976/*
1977 * Recover an error report and clear atomically
1978 */
Eric Dumazetdc6b9b72012-05-16 22:48:15 +00001979
Linus Torvalds1da177e2005-04-16 15:20:36 -07001980static inline int sock_error(struct sock *sk)
1981{
Benjamin LaHaisec1cbe4b2005-12-13 23:22:19 -08001982 int err;
1983 if (likely(!sk->sk_err))
1984 return 0;
1985 err = xchg(&sk->sk_err, 0);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001986 return -err;
1987}
1988
1989static inline unsigned long sock_wspace(struct sock *sk)
1990{
1991 int amt = 0;
1992
1993 if (!(sk->sk_shutdown & SEND_SHUTDOWN)) {
1994 amt = sk->sk_sndbuf - atomic_read(&sk->sk_wmem_alloc);
Eric Dumazetdc6b9b72012-05-16 22:48:15 +00001995 if (amt < 0)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001996 amt = 0;
1997 }
1998 return amt;
1999}
2000
2001static inline void sk_wake_async(struct sock *sk, int how, int band)
2002{
Eric Dumazetbcdce712009-10-06 17:28:29 -07002003 if (sock_flag(sk, SOCK_FASYNC))
Linus Torvalds1da177e2005-04-16 15:20:36 -07002004 sock_wake_async(sk->sk_socket, how, band);
2005}
2006
Daniel Borkmanneea86af2013-06-19 12:51:20 +02002007/* Since sk_{r,w}mem_alloc sums skb->truesize, even a small frame might
2008 * need sizeof(sk_buff) + MTU + padding, unless net driver perform copybreak.
2009 * Note: for send buffers, TCP works better if we can build two skbs at
2010 * minimum.
Eric Dumazet7a91b4342010-09-26 18:53:07 -07002011 */
Eric Dumazet9eb5bf82013-07-03 05:02:22 -07002012#define TCP_SKB_MIN_TRUESIZE (2048 + SKB_DATA_ALIGN(sizeof(struct sk_buff)))
Daniel Borkmanneea86af2013-06-19 12:51:20 +02002013
2014#define SOCK_MIN_SNDBUF (TCP_SKB_MIN_TRUESIZE * 2)
2015#define SOCK_MIN_RCVBUF TCP_SKB_MIN_TRUESIZE
Linus Torvalds1da177e2005-04-16 15:20:36 -07002016
2017static inline void sk_stream_moderate_sndbuf(struct sock *sk)
2018{
2019 if (!(sk->sk_userlocks & SOCK_SNDBUF_LOCK)) {
Eric Dumazet8df09ea2007-12-21 03:07:41 -08002020 sk->sk_sndbuf = min(sk->sk_sndbuf, sk->sk_wmem_queued >> 1);
Daniel Borkmanneea86af2013-06-19 12:51:20 +02002021 sk->sk_sndbuf = max_t(u32, sk->sk_sndbuf, SOCK_MIN_SNDBUF);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002022 }
2023}
2024
Pavel Emelyanovdf97c702007-11-29 21:22:33 +11002025struct sk_buff *sk_stream_alloc_skb(struct sock *sk, int size, gfp_t gfp);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002026
Eric Dumazet5640f762012-09-23 23:04:42 +00002027/**
2028 * sk_page_frag - return an appropriate page_frag
2029 * @sk: socket
2030 *
2031 * If socket allocation mode allows current thread to sleep, it means its
2032 * safe to use the per task page_frag instead of the per socket one.
2033 */
2034static inline struct page_frag *sk_page_frag(struct sock *sk)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002035{
Eric Dumazet5640f762012-09-23 23:04:42 +00002036 if (sk->sk_allocation & __GFP_WAIT)
2037 return &current->task_frag;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002038
Eric Dumazet5640f762012-09-23 23:04:42 +00002039 return &sk->sk_frag;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002040}
2041
Joe Perches69336bd2013-09-22 10:32:26 -07002042bool sk_page_frag_refill(struct sock *sk, struct page_frag *pfrag);
Eric Dumazet5640f762012-09-23 23:04:42 +00002043
Linus Torvalds1da177e2005-04-16 15:20:36 -07002044/*
2045 * Default write policy as shown to user space via poll/select/SIGIO
2046 */
Eric Dumazetdc6b9b72012-05-16 22:48:15 +00002047static inline bool sock_writeable(const struct sock *sk)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002048{
Eric Dumazet8df09ea2007-12-21 03:07:41 -08002049 return atomic_read(&sk->sk_wmem_alloc) < (sk->sk_sndbuf >> 1);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002050}
2051
Al Virodd0fc662005-10-07 07:46:04 +01002052static inline gfp_t gfp_any(void)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002053{
Andrew Morton99709372009-02-12 16:43:17 -08002054 return in_softirq() ? GFP_ATOMIC : GFP_KERNEL;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002055}
2056
Eric Dumazetdc6b9b72012-05-16 22:48:15 +00002057static inline long sock_rcvtimeo(const struct sock *sk, bool noblock)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002058{
2059 return noblock ? 0 : sk->sk_rcvtimeo;
2060}
2061
Eric Dumazetdc6b9b72012-05-16 22:48:15 +00002062static inline long sock_sndtimeo(const struct sock *sk, bool noblock)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002063{
2064 return noblock ? 0 : sk->sk_sndtimeo;
2065}
2066
2067static inline int sock_rcvlowat(const struct sock *sk, int waitall, int len)
2068{
2069 return (waitall ? len : min_t(int, sk->sk_rcvlowat, len)) ? : 1;
2070}
2071
2072/* Alas, with timeout socket operations are not restartable.
2073 * Compare this to poll().
2074 */
2075static inline int sock_intr_errno(long timeo)
2076{
2077 return timeo == MAX_SCHEDULE_TIMEOUT ? -ERESTARTSYS : -EINTR;
2078}
2079
Eyal Birger744d5a32015-03-01 14:58:31 +02002080struct sock_skb_cb {
2081 u32 dropcount;
2082};
2083
2084/* Store sock_skb_cb at the end of skb->cb[] so protocol families
2085 * using skb->cb[] would keep using it directly and utilize its
2086 * alignement guarantee.
2087 */
2088#define SOCK_SKB_CB_OFFSET ((FIELD_SIZEOF(struct sk_buff, cb) - \
2089 sizeof(struct sock_skb_cb)))
2090
2091#define SOCK_SKB_CB(__skb) ((struct sock_skb_cb *)((__skb)->cb + \
2092 SOCK_SKB_CB_OFFSET))
2093
Eyal Birgerb4772ef2015-03-01 14:58:29 +02002094#define sock_skb_cb_check_size(size) \
Eyal Birger744d5a32015-03-01 14:58:31 +02002095 BUILD_BUG_ON((size) > SOCK_SKB_CB_OFFSET)
Eyal Birgerb4772ef2015-03-01 14:58:29 +02002096
Eyal Birger3bc3b962015-03-01 14:58:30 +02002097static inline void
2098sock_skb_set_dropcount(const struct sock *sk, struct sk_buff *skb)
2099{
Eyal Birger744d5a32015-03-01 14:58:31 +02002100 SOCK_SKB_CB(skb)->dropcount = atomic_read(&sk->sk_drops);
Eyal Birger3bc3b962015-03-01 14:58:30 +02002101}
2102
Joe Perches69336bd2013-09-22 10:32:26 -07002103void __sock_recv_timestamp(struct msghdr *msg, struct sock *sk,
2104 struct sk_buff *skb);
2105void __sock_recv_wifi_status(struct msghdr *msg, struct sock *sk,
2106 struct sk_buff *skb);
Eric Dumazet92f37fd2007-03-25 22:14:49 -07002107
Eric Dumazetdc6b9b72012-05-16 22:48:15 +00002108static inline void
Linus Torvalds1da177e2005-04-16 15:20:36 -07002109sock_recv_timestamp(struct msghdr *msg, struct sock *sk, struct sk_buff *skb)
2110{
Eric Dumazetb7aa0bf2007-04-19 16:16:32 -07002111 ktime_t kt = skb->tstamp;
Patrick Ohly20d49472009-02-12 05:03:38 +00002112 struct skb_shared_hwtstamps *hwtstamps = skb_hwtstamps(skb);
Patrick McHardya61bbcf2005-08-14 17:24:31 -07002113
Patrick Ohly20d49472009-02-12 05:03:38 +00002114 /*
2115 * generate control messages if
Willem de Bruijnb9f40e22014-08-04 22:11:46 -04002116 * - receive time stamping in software requested
Patrick Ohly20d49472009-02-12 05:03:38 +00002117 * - software time stamp available and wanted
Patrick Ohly20d49472009-02-12 05:03:38 +00002118 * - hardware time stamps available and wanted
Patrick Ohly20d49472009-02-12 05:03:38 +00002119 */
2120 if (sock_flag(sk, SOCK_RCVTSTAMP) ||
Willem de Bruijnb9f40e22014-08-04 22:11:46 -04002121 (sk->sk_tsflags & SOF_TIMESTAMPING_RX_SOFTWARE) ||
Willem de Bruijnc1991052014-09-03 12:01:18 -04002122 (kt.tv64 && sk->sk_tsflags & SOF_TIMESTAMPING_SOFTWARE) ||
Patrick Ohly20d49472009-02-12 05:03:38 +00002123 (hwtstamps->hwtstamp.tv64 &&
Willem de Bruijnb9f40e22014-08-04 22:11:46 -04002124 (sk->sk_tsflags & SOF_TIMESTAMPING_RAW_HARDWARE)))
Eric Dumazet92f37fd2007-03-25 22:14:49 -07002125 __sock_recv_timestamp(msg, sk, skb);
2126 else
Eric Dumazetb7aa0bf2007-04-19 16:16:32 -07002127 sk->sk_stamp = kt;
Johannes Berg6e3e9392011-11-09 10:15:42 +01002128
2129 if (sock_flag(sk, SOCK_WIFI_STATUS) && skb->wifi_acked_valid)
2130 __sock_recv_wifi_status(msg, sk, skb);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002131}
2132
Joe Perches69336bd2013-09-22 10:32:26 -07002133void __sock_recv_ts_and_drops(struct msghdr *msg, struct sock *sk,
2134 struct sk_buff *skb);
Eric Dumazet767dd032010-04-28 19:14:43 +00002135
2136static inline void sock_recv_ts_and_drops(struct msghdr *msg, struct sock *sk,
2137 struct sk_buff *skb)
2138{
2139#define FLAGS_TS_OR_DROPS ((1UL << SOCK_RXQ_OVFL) | \
Willem de Bruijnb9f40e22014-08-04 22:11:46 -04002140 (1UL << SOCK_RCVTSTAMP))
2141#define TSFLAGS_ANY (SOF_TIMESTAMPING_SOFTWARE | \
2142 SOF_TIMESTAMPING_RAW_HARDWARE)
Eric Dumazet767dd032010-04-28 19:14:43 +00002143
Willem de Bruijnb9f40e22014-08-04 22:11:46 -04002144 if (sk->sk_flags & FLAGS_TS_OR_DROPS || sk->sk_tsflags & TSFLAGS_ANY)
Eric Dumazet767dd032010-04-28 19:14:43 +00002145 __sock_recv_ts_and_drops(msg, sk, skb);
2146 else
2147 sk->sk_stamp = skb->tstamp;
2148}
Neil Horman3b885782009-10-12 13:26:31 -07002149
Willem de Bruijn67cc0d42014-09-08 19:58:58 -04002150void __sock_tx_timestamp(const struct sock *sk, __u8 *tx_flags);
2151
Linus Torvalds1da177e2005-04-16 15:20:36 -07002152/**
Patrick Ohly20d49472009-02-12 05:03:38 +00002153 * sock_tx_timestamp - checks whether the outgoing packet is to be time stamped
Patrick Ohly20d49472009-02-12 05:03:38 +00002154 * @sk: socket sending this packet
Eric Dumazet140c55d2014-08-06 11:49:29 +02002155 * @tx_flags: completed with instructions for time stamping
2156 *
2157 * Note : callers should take care of initial *tx_flags value (usually 0)
Patrick Ohly20d49472009-02-12 05:03:38 +00002158 */
Willem de Bruijn67cc0d42014-09-08 19:58:58 -04002159static inline void sock_tx_timestamp(const struct sock *sk, __u8 *tx_flags)
2160{
2161 if (unlikely(sk->sk_tsflags))
2162 __sock_tx_timestamp(sk, tx_flags);
2163 if (unlikely(sock_flag(sk, SOCK_WIFI_STATUS)))
2164 *tx_flags |= SKBTX_WIFI_STATUS;
2165}
Patrick Ohly20d49472009-02-12 05:03:38 +00002166
2167/**
Linus Torvalds1da177e2005-04-16 15:20:36 -07002168 * sk_eat_skb - Release a skb if it is no longer needed
Pavel Pisa4dc3b162005-05-01 08:59:25 -07002169 * @sk: socket to eat this skb from
2170 * @skb: socket buffer to eat
Linus Torvalds1da177e2005-04-16 15:20:36 -07002171 *
2172 * This routine must be called with interrupts disabled or with the socket
2173 * locked so that the sk_buff queue operation is ok.
2174*/
Dan Williams7bced392013-12-30 12:37:29 -08002175static inline void sk_eat_skb(struct sock *sk, struct sk_buff *skb)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002176{
2177 __skb_unlink(skb, &sk->sk_receive_queue);
2178 __kfree_skb(skb);
2179}
2180
YOSHIFUJI Hideaki3b1e0a62008-03-26 02:26:21 +09002181static inline
2182struct net *sock_net(const struct sock *sk)
2183{
Eric Dumazetc2d9ba92010-06-01 06:51:19 +00002184 return read_pnet(&sk->sk_net);
YOSHIFUJI Hideaki3b1e0a62008-03-26 02:26:21 +09002185}
2186
2187static inline
Denis V. Lunevf5aa23f2008-03-26 00:48:17 -07002188void sock_net_set(struct sock *sk, struct net *net)
YOSHIFUJI Hideaki3b1e0a62008-03-26 02:26:21 +09002189{
Eric Dumazetc2d9ba92010-06-01 06:51:19 +00002190 write_pnet(&sk->sk_net, net);
YOSHIFUJI Hideaki3b1e0a62008-03-26 02:26:21 +09002191}
2192
Denis V. Lunevedf02082008-02-29 11:18:32 -08002193/*
2194 * Kernel sockets, f.e. rtnl or icmp_socket, are a part of a namespace.
Lucas De Marchi25985ed2011-03-30 22:57:33 -03002195 * They should not hold a reference to a namespace in order to allow
Denis V. Lunevedf02082008-02-29 11:18:32 -08002196 * to stop it.
2197 * Sockets after sk_change_net should be released using sk_release_kernel
2198 */
2199static inline void sk_change_net(struct sock *sk, struct net *net)
2200{
Gu Zheng5812521b2014-03-10 09:57:34 +08002201 struct net *current_net = sock_net(sk);
2202
2203 if (!net_eq(current_net, net)) {
2204 put_net(current_net);
Eric W. Biedermanefd7ef12015-03-11 23:04:08 -05002205 sock_net_set(sk, net);
Gu Zheng5812521b2014-03-10 09:57:34 +08002206 }
Denis V. Lunevedf02082008-02-29 11:18:32 -08002207}
2208
KOVACS Krisztian23542612008-10-07 12:41:01 -07002209static inline struct sock *skb_steal_sock(struct sk_buff *skb)
2210{
Vijay Subramanianefc27f82012-06-24 13:03:07 +00002211 if (skb->sk) {
KOVACS Krisztian23542612008-10-07 12:41:01 -07002212 struct sock *sk = skb->sk;
2213
2214 skb->destructor = NULL;
2215 skb->sk = NULL;
2216 return sk;
2217 }
2218 return NULL;
2219}
2220
Joe Perches69336bd2013-09-22 10:32:26 -07002221void sock_enable_timestamp(struct sock *sk, int flag);
2222int sock_get_timestamp(struct sock *, struct timeval __user *);
2223int sock_get_timestampns(struct sock *, struct timespec __user *);
2224int sock_recv_errqueue(struct sock *sk, struct msghdr *msg, int len, int level,
2225 int type);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002226
Eric W. Biedermana3b299d2014-04-23 14:26:56 -07002227bool sk_ns_capable(const struct sock *sk,
2228 struct user_namespace *user_ns, int cap);
2229bool sk_capable(const struct sock *sk, int cap);
2230bool sk_net_capable(const struct sock *sk, int cap);
2231
Linus Torvalds1da177e2005-04-16 15:20:36 -07002232extern __u32 sysctl_wmem_max;
2233extern __u32 sysctl_rmem_max;
2234
Willem de Bruijnb245be12015-01-30 13:29:32 -05002235extern int sysctl_tstamp_allow_data;
David S. Miller6baf1f42005-09-05 18:14:11 -07002236extern int sysctl_optmem_max;
2237
Arnaldo Carvalho de Melo20380732005-08-16 02:18:02 -03002238extern __u32 sysctl_wmem_default;
2239extern __u32 sysctl_rmem_default;
Arnaldo Carvalho de Melo20380732005-08-16 02:18:02 -03002240
Linus Torvalds1da177e2005-04-16 15:20:36 -07002241#endif /* _SOCK_H */