blob: 64a75458d22cc2fc4e972601972cf9ff9cf0a57a [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/sched.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070061
62#include <linux/filter.h>
Eric Dumazet88ab1932008-11-16 19:39:21 -080063#include <linux/rculist_nulls.h>
Jiri Olsaa57de0b2009-07-08 12:09:13 +000064#include <linux/poll.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070065
Eric Dumazetc31504d2010-11-15 19:58:26 +000066#include <linux/atomic.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070067#include <net/dst.h>
68#include <net/checksum.h>
Eric Dumazet1d0ab252015-03-15 21:12:12 -070069#include <net/tcp_states.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
Eric Dumazet8e5eb542015-10-08 19:33:22 -0700153 * @skc_flags: place holder for sk_flags
154 * %SO_LINGER (l_onoff), %SO_BROADCAST, %SO_KEEPALIVE,
155 * %SO_OOBINLINE settings, %SO_TIMESTAMPING settings
Eric Dumazet70da2682015-10-08 19:33:21 -0700156 * @skc_incoming_cpu: record/match cpu processing incoming packets
Eric Dumazet68835ab2010-11-30 19:04:07 +0000157 * @skc_refcnt: reference count
Pavel Pisa4dc3b162005-05-01 08:59:25 -0700158 *
159 * This is the minimal network layer representation of sockets, the header
Arnaldo Carvalho de Melo8feaf0c02005-08-09 20:09:30 -0700160 * for struct sock and struct inet_timewait_sock.
161 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700162struct sock_common {
Eric Dumazetce43b032012-11-30 09:49:27 +0000163 /* skc_daddr and skc_rcv_saddr must be grouped on a 8 bytes aligned
Eric Dumazet05dbc7b2013-10-03 00:22:02 -0700164 * address on 64bit arches : cf INET_MATCH()
Eric Dumazet4dc6dc72009-07-15 23:13:10 +0000165 */
Eric Dumazetce43b032012-11-30 09:49:27 +0000166 union {
Eric Dumazet077b3932012-12-02 07:33:10 +0000167 __addrpair skc_addrpair;
Eric Dumazetce43b032012-11-30 09:49:27 +0000168 struct {
169 __be32 skc_daddr;
170 __be32 skc_rcv_saddr;
171 };
172 };
Eric Dumazetd4cada42009-11-08 10:17:30 +0000173 union {
174 unsigned int skc_hash;
175 __u16 skc_u16hashes[2];
176 };
Eric Dumazetce43b032012-11-30 09:49:27 +0000177 /* skc_dport && skc_num must be grouped as well */
178 union {
Eric Dumazet077b3932012-12-02 07:33:10 +0000179 __portpair skc_portpair;
Eric Dumazetce43b032012-11-30 09:49:27 +0000180 struct {
181 __be16 skc_dport;
182 __u16 skc_num;
183 };
184 };
185
Eric Dumazet4dc6dc72009-07-15 23:13:10 +0000186 unsigned short skc_family;
187 volatile unsigned char skc_state;
Tom Herbert055dc212013-01-22 09:49:50 +0000188 unsigned char skc_reuse:4;
Eric Dumazet9fe516b2014-06-27 08:36:16 -0700189 unsigned char skc_reuseport:1;
190 unsigned char skc_ipv6only:1;
Eric W. Biederman26abe142015-05-08 21:10:31 -0500191 unsigned char skc_net_refcnt:1;
Eric Dumazet4dc6dc72009-07-15 23:13:10 +0000192 int skc_bound_dev_if;
Eric Dumazet512615b2009-11-08 10:17:58 +0000193 union {
194 struct hlist_node skc_bind_node;
195 struct hlist_nulls_node skc_portaddr_node;
196 };
Arnaldo Carvalho de Melo8feaf0c02005-08-09 20:09:30 -0700197 struct proto *skc_prot;
Eric W. Biederman0c5c9fb2015-03-11 23:06:44 -0500198 possible_net_t skc_net;
Eric Dumazetefe42082013-10-03 15:42:29 -0700199
200#if IS_ENABLED(CONFIG_IPV6)
201 struct in6_addr skc_v6_daddr;
202 struct in6_addr skc_v6_rcv_saddr;
203#endif
204
Eric Dumazet33cf7c92015-03-11 18:53:14 -0700205 atomic64_t skc_cookie;
206
Eric Dumazet8e5eb542015-10-08 19:33:22 -0700207 /* following fields are padding to force
208 * offset(struct sock, sk_refcnt) == 128 on 64bit arches
209 * assuming IPV6 is enabled. We use this padding differently
210 * for different kind of 'sockets'
211 */
212 union {
213 unsigned long skc_flags;
214 struct sock *skc_listener; /* request_sock */
215 struct inet_timewait_death_row *skc_tw_dr; /* inet_timewait_sock */
216 };
Eric Dumazet68835ab2010-11-30 19:04:07 +0000217 /*
218 * fields between dontcopy_begin/dontcopy_end
219 * are not copied in sock_copy()
220 */
Randy Dunlap928c41e2011-01-08 17:39:21 +0000221 /* private: */
Eric Dumazet68835ab2010-11-30 19:04:07 +0000222 int skc_dontcopy_begin[0];
Randy Dunlap928c41e2011-01-08 17:39:21 +0000223 /* public: */
Eric Dumazet68835ab2010-11-30 19:04:07 +0000224 union {
225 struct hlist_node skc_node;
226 struct hlist_nulls_node skc_nulls_node;
227 };
228 int skc_tx_queue_mapping;
Eric Dumazeted53d0a2015-10-08 19:33:23 -0700229 union {
230 int skc_incoming_cpu;
231 u32 skc_rcv_wnd;
Eric Dumazetd475f092015-10-08 19:33:24 -0700232 u32 skc_tw_rcv_nxt; /* struct tcp_timewait_sock */
Eric Dumazeted53d0a2015-10-08 19:33:23 -0700233 };
Eric Dumazet70da2682015-10-08 19:33:21 -0700234
Eric Dumazet68835ab2010-11-30 19:04:07 +0000235 atomic_t skc_refcnt;
Randy Dunlap928c41e2011-01-08 17:39:21 +0000236 /* private: */
Eric Dumazet68835ab2010-11-30 19:04:07 +0000237 int skc_dontcopy_end[0];
Eric Dumazeted53d0a2015-10-08 19:33:23 -0700238 union {
239 u32 skc_rxhash;
240 u32 skc_window_clamp;
Eric Dumazetd475f092015-10-08 19:33:24 -0700241 u32 skc_tw_snd_nxt; /* struct tcp_timewait_sock */
Eric Dumazeted53d0a2015-10-08 19:33:23 -0700242 };
Randy Dunlap928c41e2011-01-08 17:39:21 +0000243 /* public: */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700244};
245
Glauber Costae1aab162011-12-11 21:47:03 +0000246struct cg_proto;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700247/**
248 * struct sock - network layer representation of sockets
Arnaldo Carvalho de Melo8feaf0c02005-08-09 20:09:30 -0700249 * @__sk_common: shared layout with inet_timewait_sock
Pavel Pisa4dc3b162005-05-01 08:59:25 -0700250 * @sk_shutdown: mask of %SEND_SHUTDOWN and/or %RCV_SHUTDOWN
251 * @sk_userlocks: %SO_SNDBUF and %SO_RCVBUF settings
252 * @sk_lock: synchronizer
253 * @sk_rcvbuf: size of receive buffer in bytes
Eric Dumazet43815482010-04-29 11:01:49 +0000254 * @sk_wq: sock wait queue and async head
Shawn Bohrer421b3882013-10-07 11:01:39 -0500255 * @sk_rx_dst: receive input route used by early demux
Pavel Pisa4dc3b162005-05-01 08:59:25 -0700256 * @sk_dst_cache: destination cache
257 * @sk_dst_lock: destination cache lock
258 * @sk_policy: flow policy
Pavel Pisa4dc3b162005-05-01 08:59:25 -0700259 * @sk_receive_queue: incoming packets
260 * @sk_wmem_alloc: transmit queue bytes committed
261 * @sk_write_queue: Packet sending queue
262 * @sk_omem_alloc: "o" is "option" or "other"
263 * @sk_wmem_queued: persistent queue size
264 * @sk_forward_alloc: space allocated forward
Eliezer Tamir06021292013-06-10 11:39:50 +0300265 * @sk_napi_id: id of the last napi context to receive data for sk
Eliezer Tamirdafcc432013-06-14 16:33:57 +0300266 * @sk_ll_usec: usecs to busypoll when there is no data
Pavel Pisa4dc3b162005-05-01 08:59:25 -0700267 * @sk_allocation: allocation mode
Eric Dumazet95bd09e2013-08-27 05:46:32 -0700268 * @sk_pacing_rate: Pacing rate (if supported by transport/packet scheduler)
Eric Dumazetc3f40d72013-09-29 01:12:40 -0700269 * @sk_max_pacing_rate: Maximum pacing rate (%SO_MAX_PACING_RATE)
Pavel Pisa4dc3b162005-05-01 08:59:25 -0700270 * @sk_sndbuf: size of send buffer in bytes
Tom Herbert28448b82014-05-23 08:47:19 -0700271 * @sk_no_check_tx: %SO_NO_CHECK setting, set checksum in TX packets
272 * @sk_no_check_rx: allow zero checksum in RX packets
Pavel Pisa4dc3b162005-05-01 08:59:25 -0700273 * @sk_route_caps: route capabilities (e.g. %NETIF_F_TSO)
Eric Dumazeta4654192010-05-16 00:36:33 -0700274 * @sk_route_nocaps: forbidden route capabilities (e.g NETIF_F_GSO_MASK)
Herbert Xubcd76112006-06-30 13:36:35 -0700275 * @sk_gso_type: GSO type (e.g. %SKB_GSO_TCPV4)
Peter P Waskiewicz Jr82cc1a72008-03-21 03:43:19 -0700276 * @sk_gso_max_size: Maximum GSO segment size to build
Ben Hutchings14853482012-07-30 16:11:42 +0000277 * @sk_gso_max_segs: Maximum number of GSO segments
Pavel Pisa4dc3b162005-05-01 08:59:25 -0700278 * @sk_lingertime: %SO_LINGER l_linger setting
Pavel Pisa4dc3b162005-05-01 08:59:25 -0700279 * @sk_backlog: always used with the per-socket spinlock held
280 * @sk_callback_lock: used with the callbacks in the end of this struct
281 * @sk_error_queue: rarely used
Wang Chen33c732c2007-11-13 20:30:01 -0800282 * @sk_prot_creator: sk_prot of original sock creator (see ipv6_setsockopt,
283 * IPV6_ADDRFORM for instance)
Pavel Pisa4dc3b162005-05-01 08:59:25 -0700284 * @sk_err: last error
Wang Chen33c732c2007-11-13 20:30:01 -0800285 * @sk_err_soft: errors that don't cause failure but are the cause of a
286 * persistent failure not just 'timed out'
Eric Dumazetcb61cb92008-06-17 21:04:56 -0700287 * @sk_drops: raw/udp drops counter
Pavel Pisa4dc3b162005-05-01 08:59:25 -0700288 * @sk_ack_backlog: current listen backlog
289 * @sk_max_ack_backlog: listen backlog set in listen()
290 * @sk_priority: %SO_PRIORITY setting
Randy Dunlap1a3bc362012-01-21 09:03:10 +0000291 * @sk_cgrp_prioidx: socket group's priority map index
Pavel Pisa4dc3b162005-05-01 08:59:25 -0700292 * @sk_type: socket type (%SOCK_STREAM, etc)
293 * @sk_protocol: which protocol this socket belongs in this network family
Randy Dunlap53c3fa22010-08-09 13:41:07 +0000294 * @sk_peer_pid: &struct pid for this socket's peer
295 * @sk_peer_cred: %SO_PEERCRED setting
Pavel Pisa4dc3b162005-05-01 08:59:25 -0700296 * @sk_rcvlowat: %SO_RCVLOWAT setting
297 * @sk_rcvtimeo: %SO_RCVTIMEO setting
298 * @sk_sndtimeo: %SO_SNDTIMEO setting
Tom Herbertb73c3d02014-07-01 21:32:17 -0700299 * @sk_txhash: computed flow hash for use on transmit
Pavel Pisa4dc3b162005-05-01 08:59:25 -0700300 * @sk_filter: socket filtering instructions
Pavel Pisa4dc3b162005-05-01 08:59:25 -0700301 * @sk_timer: sock cleanup timer
302 * @sk_stamp: time stamp of last packet received
Willem de Bruijnb9f40e22014-08-04 22:11:46 -0400303 * @sk_tsflags: SO_TIMESTAMPING socket options
Willem de Bruijn09c2d252014-08-04 22:11:47 -0400304 * @sk_tskey: counter to disambiguate concurrent tstamp requests
Pavel Pisa4dc3b162005-05-01 08:59:25 -0700305 * @sk_socket: Identd and reporting IO signals
306 * @sk_user_data: RPC layer private data
Eric Dumazet5640f762012-09-23 23:04:42 +0000307 * @sk_frag: cached page frag
Randy Dunlapd3d4f0a2012-04-17 14:03:53 +0000308 * @sk_peek_off: current peek_offset value
Pavel Pisa4dc3b162005-05-01 08:59:25 -0700309 * @sk_send_head: front of stuff to transmit
Martin Waitz67be2dd2005-05-01 08:59:26 -0700310 * @sk_security: used by security modules
Randy Dunlap31729362008-02-18 20:52:13 -0800311 * @sk_mark: generic packet mark
Randy Dunlap53c3fa22010-08-09 13:41:07 +0000312 * @sk_classid: this socket's cgroup classid
Glauber Costae1aab162011-12-11 21:47:03 +0000313 * @sk_cgrp: this socket's cgroup-specific proto data
Pavel Pisa4dc3b162005-05-01 08:59:25 -0700314 * @sk_write_pending: a write to stream socket waits to start
315 * @sk_state_change: callback to indicate change in the state of the sock
316 * @sk_data_ready: callback to indicate there is data to be processed
317 * @sk_write_space: callback to indicate there is bf sending space available
318 * @sk_error_report: callback to indicate errors (e.g. %MSG_ERRQUEUE)
319 * @sk_backlog_rcv: callback to process the backlog
320 * @sk_destruct: called at sock freeing time, i.e. when all refcnt == 0
Linus Torvalds1da177e2005-04-16 15:20:36 -0700321 */
322struct sock {
323 /*
Arnaldo Carvalho de Melo8feaf0c02005-08-09 20:09:30 -0700324 * Now struct inet_timewait_sock also uses sock_common, so please just
Linus Torvalds1da177e2005-04-16 15:20:36 -0700325 * don't add nothing before this first member (__sk_common) --acme
326 */
327 struct sock_common __sk_common;
Eric Dumazet4dc6dc72009-07-15 23:13:10 +0000328#define sk_node __sk_common.skc_node
329#define sk_nulls_node __sk_common.skc_nulls_node
330#define sk_refcnt __sk_common.skc_refcnt
Krishna Kumare022f0b2009-10-19 23:46:20 +0000331#define sk_tx_queue_mapping __sk_common.skc_tx_queue_mapping
Eric Dumazet4dc6dc72009-07-15 23:13:10 +0000332
Eric Dumazet68835ab2010-11-30 19:04:07 +0000333#define sk_dontcopy_begin __sk_common.skc_dontcopy_begin
334#define sk_dontcopy_end __sk_common.skc_dontcopy_end
Eric Dumazet4dc6dc72009-07-15 23:13:10 +0000335#define sk_hash __sk_common.skc_hash
Eric Dumazet50805462013-10-02 04:29:50 -0700336#define sk_portpair __sk_common.skc_portpair
Eric Dumazet05dbc7b2013-10-03 00:22:02 -0700337#define sk_num __sk_common.skc_num
338#define sk_dport __sk_common.skc_dport
Eric Dumazet50805462013-10-02 04:29:50 -0700339#define sk_addrpair __sk_common.skc_addrpair
340#define sk_daddr __sk_common.skc_daddr
341#define sk_rcv_saddr __sk_common.skc_rcv_saddr
Linus Torvalds1da177e2005-04-16 15:20:36 -0700342#define sk_family __sk_common.skc_family
343#define sk_state __sk_common.skc_state
344#define sk_reuse __sk_common.skc_reuse
Tom Herbert055dc212013-01-22 09:49:50 +0000345#define sk_reuseport __sk_common.skc_reuseport
Eric Dumazet9fe516b2014-06-27 08:36:16 -0700346#define sk_ipv6only __sk_common.skc_ipv6only
Eric W. Biederman26abe142015-05-08 21:10:31 -0500347#define sk_net_refcnt __sk_common.skc_net_refcnt
Linus Torvalds1da177e2005-04-16 15:20:36 -0700348#define sk_bound_dev_if __sk_common.skc_bound_dev_if
Linus Torvalds1da177e2005-04-16 15:20:36 -0700349#define sk_bind_node __sk_common.skc_bind_node
Arnaldo Carvalho de Melo8feaf0c02005-08-09 20:09:30 -0700350#define sk_prot __sk_common.skc_prot
Eric W. Biederman07feaeb2007-09-12 11:58:02 +0200351#define sk_net __sk_common.skc_net
Eric Dumazetefe42082013-10-03 15:42:29 -0700352#define sk_v6_daddr __sk_common.skc_v6_daddr
353#define sk_v6_rcv_saddr __sk_common.skc_v6_rcv_saddr
Eric Dumazet33cf7c92015-03-11 18:53:14 -0700354#define sk_cookie __sk_common.skc_cookie
Eric Dumazet70da2682015-10-08 19:33:21 -0700355#define sk_incoming_cpu __sk_common.skc_incoming_cpu
Eric Dumazet8e5eb542015-10-08 19:33:22 -0700356#define sk_flags __sk_common.skc_flags
Eric Dumazeted53d0a2015-10-08 19:33:23 -0700357#define sk_rxhash __sk_common.skc_rxhash
Eric Dumazetefe42082013-10-03 15:42:29 -0700358
Eric Dumazetb178bb32010-11-16 05:56:04 +0000359 socket_lock_t sk_lock;
360 struct sk_buff_head sk_receive_queue;
361 /*
362 * The backlog queue is special, it is always used with
363 * the per-socket spinlock held and requires low latency
364 * access. Therefore we special case it's implementation.
365 * Note : rmem_alloc is in this structure to fill a hole
366 * on 64bit arches, not because its logically part of
367 * backlog.
368 */
369 struct {
370 atomic_t rmem_alloc;
371 int len;
372 struct sk_buff *head;
373 struct sk_buff *tail;
374 } sk_backlog;
375#define sk_rmem_alloc sk_backlog.rmem_alloc
376 int sk_forward_alloc;
Eric Dumazet2c8c56e2014-11-11 05:54:28 -0800377
Tom Herbertb73c3d02014-07-01 21:32:17 -0700378 __u32 sk_txhash;
Cong Wange0d10952013-08-01 11:10:25 +0800379#ifdef CONFIG_NET_RX_BUSY_POLL
Eliezer Tamir06021292013-06-10 11:39:50 +0300380 unsigned int sk_napi_id;
Eliezer Tamirdafcc432013-06-14 16:33:57 +0300381 unsigned int sk_ll_usec;
Eliezer Tamir06021292013-06-10 11:39:50 +0300382#endif
Eric Dumazetb178bb32010-11-16 05:56:04 +0000383 atomic_t sk_drops;
384 int sk_rcvbuf;
385
386 struct sk_filter __rcu *sk_filter;
Eric Dumazeteaefd112011-02-18 03:26:36 +0000387 struct socket_wq __rcu *sk_wq;
Eric Dumazetb178bb32010-11-16 05:56:04 +0000388
Eric Dumazetb178bb32010-11-16 05:56:04 +0000389#ifdef CONFIG_XFRM
390 struct xfrm_policy *sk_policy[2];
391#endif
Eric Dumazetdeaa5852012-06-24 20:22:49 +0000392 struct dst_entry *sk_rx_dst;
Cong Wang0e36cbb2013-01-22 21:09:51 +0000393 struct dst_entry __rcu *sk_dst_cache;
Eric Dumazetb178bb32010-11-16 05:56:04 +0000394 spinlock_t sk_dst_lock;
395 atomic_t sk_wmem_alloc;
396 atomic_t sk_omem_alloc;
397 int sk_sndbuf;
398 struct sk_buff_head sk_write_queue;
Vegard Nossuma98b65a2009-02-26 14:46:57 +0100399 kmemcheck_bitfield_begin(flags);
Eric Dumazet5fdb9972009-10-08 22:50:25 +0000400 unsigned int sk_shutdown : 2,
Tom Herbert28448b82014-05-23 08:47:19 -0700401 sk_no_check_tx : 1,
402 sk_no_check_rx : 1,
Eric Dumazet5fdb9972009-10-08 22:50:25 +0000403 sk_userlocks : 4,
404 sk_protocol : 8,
405 sk_type : 16;
Vegard Nossuma98b65a2009-02-26 14:46:57 +0100406 kmemcheck_bitfield_end(flags);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700407 int sk_wmem_queued;
Al Viro7d877f32005-10-21 03:20:43 -0400408 gfp_t sk_allocation;
Eric Dumazet95bd09e2013-08-27 05:46:32 -0700409 u32 sk_pacing_rate; /* bytes per second */
Eric Dumazet62748f32013-09-24 08:20:52 -0700410 u32 sk_max_pacing_rate;
Michał Mirosławc8f44af2011-11-15 15:29:55 +0000411 netdev_features_t sk_route_caps;
412 netdev_features_t sk_route_nocaps;
Herbert Xubcd76112006-06-30 13:36:35 -0700413 int sk_gso_type;
Peter P Waskiewicz Jr82cc1a72008-03-21 03:43:19 -0700414 unsigned int sk_gso_max_size;
Ben Hutchings14853482012-07-30 16:11:42 +0000415 u16 sk_gso_max_segs;
David S. Miller9932cf92006-03-24 15:12:37 -0800416 int sk_rcvlowat;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700417 unsigned long sk_lingertime;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700418 struct sk_buff_head sk_error_queue;
Arnaldo Carvalho de Melo476e19c2005-05-05 13:35:15 -0700419 struct proto *sk_prot_creator;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700420 rwlock_t sk_callback_lock;
421 int sk_err,
422 sk_err_soft;
Eric Dumazetbecb74f2015-03-19 19:04:21 -0700423 u32 sk_ack_backlog;
424 u32 sk_max_ack_backlog;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700425 __u32 sk_priority;
Daniel Borkmann86f85152013-12-29 17:27:11 +0100426#if IS_ENABLED(CONFIG_CGROUP_NET_PRIO)
Neil Horman5bc14212011-11-22 05:10:51 +0000427 __u32 sk_cgrp_prioidx;
428#endif
Eric W. Biederman109f6e32010-06-13 03:30:14 +0000429 struct pid *sk_peer_pid;
430 const struct cred *sk_peer_cred;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700431 long sk_rcvtimeo;
432 long sk_sndtimeo;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700433 struct timer_list sk_timer;
Eric Dumazetb7aa0bf2007-04-19 16:16:32 -0700434 ktime_t sk_stamp;
Willem de Bruijnb9f40e22014-08-04 22:11:46 -0400435 u16 sk_tsflags;
Willem de Bruijn09c2d252014-08-04 22:11:47 -0400436 u32 sk_tskey;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700437 struct socket *sk_socket;
438 void *sk_user_data;
Eric Dumazet5640f762012-09-23 23:04:42 +0000439 struct page_frag sk_frag;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700440 struct sk_buff *sk_send_head;
Pavel Emelyanovef64a542012-02-21 07:31:34 +0000441 __s32 sk_peek_off;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700442 int sk_write_pending;
Alexey Dobriyand5f64232008-11-04 14:45:58 -0800443#ifdef CONFIG_SECURITY
Linus Torvalds1da177e2005-04-16 15:20:36 -0700444 void *sk_security;
Alexey Dobriyand5f64232008-11-04 14:45:58 -0800445#endif
Laszlo Attila Toth4a19ec52008-01-30 19:08:16 -0800446 __u32 sk_mark;
Mathias Krausee181a542015-07-19 22:21:13 +0200447#ifdef CONFIG_CGROUP_NET_CLASSID
Herbert Xuf8451722010-05-24 00:12:34 -0700448 u32 sk_classid;
Mathias Krausee181a542015-07-19 22:21:13 +0200449#endif
Glauber Costae1aab162011-12-11 21:47:03 +0000450 struct cg_proto *sk_cgrp;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700451 void (*sk_state_change)(struct sock *sk);
David S. Miller676d2362014-04-11 16:15:36 -0400452 void (*sk_data_ready)(struct sock *sk);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700453 void (*sk_write_space)(struct sock *sk);
454 void (*sk_error_report)(struct sock *sk);
Eric Dumazetdc6b9b72012-05-16 22:48:15 +0000455 int (*sk_backlog_rcv)(struct sock *sk,
456 struct sk_buff *skb);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700457 void (*sk_destruct)(struct sock *sk);
458};
459
Pravin B Shelar559835ea2013-09-24 10:25:40 -0700460#define __sk_user_data(sk) ((*((void __rcu **)&(sk)->sk_user_data)))
461
462#define rcu_dereference_sk_user_data(sk) rcu_dereference(__sk_user_data((sk)))
463#define rcu_assign_sk_user_data(sk, ptr) rcu_assign_pointer(__sk_user_data((sk)), ptr)
464
Pavel Emelyanov4a17fd52012-04-19 03:39:36 +0000465/*
466 * SK_CAN_REUSE and SK_NO_REUSE on a socket mean that the socket is OK
467 * or not whether his port will be reused by someone else. SK_FORCE_REUSE
468 * on a socket means that the socket will reuse everybody else's port
469 * without looking at the other's sk_reuse value.
470 */
471
472#define SK_NO_REUSE 0
473#define SK_CAN_REUSE 1
474#define SK_FORCE_REUSE 2
475
Pavel Emelyanovef64a542012-02-21 07:31:34 +0000476static inline int sk_peek_offset(struct sock *sk, int flags)
477{
478 if ((flags & MSG_PEEK) && (sk->sk_peek_off >= 0))
479 return sk->sk_peek_off;
480 else
481 return 0;
482}
483
484static inline void sk_peek_offset_bwd(struct sock *sk, int val)
485{
486 if (sk->sk_peek_off >= 0) {
487 if (sk->sk_peek_off >= val)
488 sk->sk_peek_off -= val;
489 else
490 sk->sk_peek_off = 0;
491 }
492}
493
494static inline void sk_peek_offset_fwd(struct sock *sk, int val)
495{
496 if (sk->sk_peek_off >= 0)
497 sk->sk_peek_off += val;
498}
499
Linus Torvalds1da177e2005-04-16 15:20:36 -0700500/*
501 * Hashed lists helper routines
502 */
Li Zefanc4146642010-02-08 23:18:45 +0000503static inline struct sock *sk_entry(const struct hlist_node *node)
504{
505 return hlist_entry(node, struct sock, sk_node);
506}
507
Arnaldo Carvalho de Meloe48c4142005-08-09 20:09:46 -0700508static inline struct sock *__sk_head(const struct hlist_head *head)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700509{
510 return hlist_entry(head->first, struct sock, sk_node);
511}
512
Arnaldo Carvalho de Meloe48c4142005-08-09 20:09:46 -0700513static inline struct sock *sk_head(const struct hlist_head *head)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700514{
515 return hlist_empty(head) ? NULL : __sk_head(head);
516}
517
Eric Dumazet88ab1932008-11-16 19:39:21 -0800518static inline struct sock *__sk_nulls_head(const struct hlist_nulls_head *head)
519{
520 return hlist_nulls_entry(head->first, struct sock, sk_nulls_node);
521}
522
523static inline struct sock *sk_nulls_head(const struct hlist_nulls_head *head)
524{
525 return hlist_nulls_empty(head) ? NULL : __sk_nulls_head(head);
526}
527
Arnaldo Carvalho de Meloe48c4142005-08-09 20:09:46 -0700528static inline struct sock *sk_next(const struct sock *sk)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700529{
530 return sk->sk_node.next ?
531 hlist_entry(sk->sk_node.next, struct sock, sk_node) : NULL;
532}
533
Eric Dumazet88ab1932008-11-16 19:39:21 -0800534static inline struct sock *sk_nulls_next(const struct sock *sk)
535{
536 return (!is_a_nulls(sk->sk_nulls_node.next)) ?
537 hlist_nulls_entry(sk->sk_nulls_node.next,
538 struct sock, sk_nulls_node) :
539 NULL;
540}
541
Eric Dumazetdc6b9b72012-05-16 22:48:15 +0000542static inline bool sk_unhashed(const struct sock *sk)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700543{
544 return hlist_unhashed(&sk->sk_node);
545}
546
Eric Dumazetdc6b9b72012-05-16 22:48:15 +0000547static inline bool sk_hashed(const struct sock *sk)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700548{
Akinobu Mitada753be2006-04-28 15:21:23 -0700549 return !sk_unhashed(sk);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700550}
551
Eric Dumazetdc6b9b72012-05-16 22:48:15 +0000552static inline void sk_node_init(struct hlist_node *node)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700553{
554 node->pprev = NULL;
555}
556
Eric Dumazetdc6b9b72012-05-16 22:48:15 +0000557static inline void sk_nulls_node_init(struct hlist_nulls_node *node)
Eric Dumazet88ab1932008-11-16 19:39:21 -0800558{
559 node->pprev = NULL;
560}
561
Eric Dumazetdc6b9b72012-05-16 22:48:15 +0000562static inline void __sk_del_node(struct sock *sk)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700563{
564 __hlist_del(&sk->sk_node);
565}
566
stephen hemminger808f5112010-02-22 07:57:18 +0000567/* NB: equivalent to hlist_del_init_rcu */
Eric Dumazetdc6b9b72012-05-16 22:48:15 +0000568static inline bool __sk_del_node_init(struct sock *sk)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700569{
570 if (sk_hashed(sk)) {
571 __sk_del_node(sk);
572 sk_node_init(&sk->sk_node);
Eric Dumazetdc6b9b72012-05-16 22:48:15 +0000573 return true;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700574 }
Eric Dumazetdc6b9b72012-05-16 22:48:15 +0000575 return false;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700576}
577
578/* Grab socket reference count. This operation is valid only
579 when sk is ALREADY grabbed f.e. it is found in hash table
580 or a list and the lookup is made under lock preventing hash table
581 modifications.
582 */
583
584static inline void sock_hold(struct sock *sk)
585{
586 atomic_inc(&sk->sk_refcnt);
587}
588
589/* Ungrab socket in the context, which assumes that socket refcnt
590 cannot hit zero, f.e. it is true in context of any socketcall.
591 */
592static inline void __sock_put(struct sock *sk)
593{
594 atomic_dec(&sk->sk_refcnt);
595}
596
Eric Dumazetdc6b9b72012-05-16 22:48:15 +0000597static inline bool sk_del_node_init(struct sock *sk)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700598{
Eric Dumazetdc6b9b72012-05-16 22:48:15 +0000599 bool rc = __sk_del_node_init(sk);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700600
601 if (rc) {
602 /* paranoid for a while -acme */
603 WARN_ON(atomic_read(&sk->sk_refcnt) == 1);
604 __sock_put(sk);
605 }
606 return rc;
607}
stephen hemminger808f5112010-02-22 07:57:18 +0000608#define sk_del_node_init_rcu(sk) sk_del_node_init(sk)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700609
Eric Dumazetdc6b9b72012-05-16 22:48:15 +0000610static inline bool __sk_nulls_del_node_init_rcu(struct sock *sk)
Eric Dumazet271b72c2008-10-29 02:11:14 -0700611{
612 if (sk_hashed(sk)) {
Eric Dumazet88ab1932008-11-16 19:39:21 -0800613 hlist_nulls_del_init_rcu(&sk->sk_nulls_node);
Eric Dumazetdc6b9b72012-05-16 22:48:15 +0000614 return true;
Eric Dumazet271b72c2008-10-29 02:11:14 -0700615 }
Eric Dumazetdc6b9b72012-05-16 22:48:15 +0000616 return false;
Eric Dumazet271b72c2008-10-29 02:11:14 -0700617}
618
Eric Dumazetdc6b9b72012-05-16 22:48:15 +0000619static inline bool sk_nulls_del_node_init_rcu(struct sock *sk)
Eric Dumazet271b72c2008-10-29 02:11:14 -0700620{
Eric Dumazetdc6b9b72012-05-16 22:48:15 +0000621 bool rc = __sk_nulls_del_node_init_rcu(sk);
Eric Dumazet271b72c2008-10-29 02:11:14 -0700622
623 if (rc) {
624 /* paranoid for a while -acme */
625 WARN_ON(atomic_read(&sk->sk_refcnt) == 1);
626 __sock_put(sk);
627 }
628 return rc;
629}
630
Eric Dumazetdc6b9b72012-05-16 22:48:15 +0000631static inline void __sk_add_node(struct sock *sk, struct hlist_head *list)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700632{
633 hlist_add_head(&sk->sk_node, list);
634}
635
Eric Dumazetdc6b9b72012-05-16 22:48:15 +0000636static inline void sk_add_node(struct sock *sk, struct hlist_head *list)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700637{
638 sock_hold(sk);
639 __sk_add_node(sk, list);
640}
641
Eric Dumazetdc6b9b72012-05-16 22:48:15 +0000642static inline void sk_add_node_rcu(struct sock *sk, struct hlist_head *list)
stephen hemminger808f5112010-02-22 07:57:18 +0000643{
644 sock_hold(sk);
645 hlist_add_head_rcu(&sk->sk_node, list);
646}
647
Eric Dumazetdc6b9b72012-05-16 22:48:15 +0000648static inline void __sk_nulls_add_node_rcu(struct sock *sk, struct hlist_nulls_head *list)
Eric Dumazet271b72c2008-10-29 02:11:14 -0700649{
Eric Dumazet88ab1932008-11-16 19:39:21 -0800650 hlist_nulls_add_head_rcu(&sk->sk_nulls_node, list);
Eric Dumazet271b72c2008-10-29 02:11:14 -0700651}
652
Eric Dumazetdc6b9b72012-05-16 22:48:15 +0000653static inline void sk_nulls_add_node_rcu(struct sock *sk, struct hlist_nulls_head *list)
Eric Dumazet271b72c2008-10-29 02:11:14 -0700654{
655 sock_hold(sk);
Eric Dumazet88ab1932008-11-16 19:39:21 -0800656 __sk_nulls_add_node_rcu(sk, list);
Eric Dumazet271b72c2008-10-29 02:11:14 -0700657}
658
Eric Dumazetdc6b9b72012-05-16 22:48:15 +0000659static inline void __sk_del_bind_node(struct sock *sk)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700660{
661 __hlist_del(&sk->sk_bind_node);
662}
663
Eric Dumazetdc6b9b72012-05-16 22:48:15 +0000664static inline void sk_add_bind_node(struct sock *sk,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700665 struct hlist_head *list)
666{
667 hlist_add_head(&sk->sk_bind_node, list);
668}
669
Sasha Levinb67bfe02013-02-27 17:06:00 -0800670#define sk_for_each(__sk, list) \
671 hlist_for_each_entry(__sk, list, sk_node)
672#define sk_for_each_rcu(__sk, list) \
673 hlist_for_each_entry_rcu(__sk, list, sk_node)
Eric Dumazet88ab1932008-11-16 19:39:21 -0800674#define sk_nulls_for_each(__sk, node, list) \
675 hlist_nulls_for_each_entry(__sk, node, list, sk_nulls_node)
676#define sk_nulls_for_each_rcu(__sk, node, list) \
677 hlist_nulls_for_each_entry_rcu(__sk, node, list, sk_nulls_node)
Sasha Levinb67bfe02013-02-27 17:06:00 -0800678#define sk_for_each_from(__sk) \
679 hlist_for_each_entry_from(__sk, sk_node)
Eric Dumazet88ab1932008-11-16 19:39:21 -0800680#define sk_nulls_for_each_from(__sk, node) \
681 if (__sk && ({ node = &(__sk)->sk_nulls_node; 1; })) \
682 hlist_nulls_for_each_entry_from(__sk, node, sk_nulls_node)
Sasha Levinb67bfe02013-02-27 17:06:00 -0800683#define sk_for_each_safe(__sk, tmp, list) \
684 hlist_for_each_entry_safe(__sk, tmp, list, sk_node)
685#define sk_for_each_bound(__sk, list) \
686 hlist_for_each_entry(__sk, list, sk_bind_node)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700687
David Held2dc41cf2014-07-15 23:28:32 -0400688/**
689 * sk_nulls_for_each_entry_offset - iterate over a list at a given struct offset
690 * @tpos: the type * to use as a loop cursor.
691 * @pos: the &struct hlist_node to use as a loop cursor.
692 * @head: the head for your list.
693 * @offset: offset of hlist_node within the struct.
694 *
695 */
696#define sk_nulls_for_each_entry_offset(tpos, pos, head, offset) \
697 for (pos = (head)->first; \
698 (!is_a_nulls(pos)) && \
699 ({ tpos = (typeof(*tpos) *)((void *)pos - offset); 1;}); \
700 pos = pos->next)
701
Eric W. Biedermanc336d142012-05-24 17:56:43 -0600702static inline struct user_namespace *sk_user_ns(struct sock *sk)
703{
704 /* Careful only use this in a context where these parameters
705 * can not change and must all be valid, such as recvmsg from
706 * userspace.
707 */
708 return sk->sk_socket->file->f_cred->user_ns;
709}
710
Linus Torvalds1da177e2005-04-16 15:20:36 -0700711/* Sock flags */
712enum sock_flags {
713 SOCK_DEAD,
714 SOCK_DONE,
715 SOCK_URGINLINE,
716 SOCK_KEEPOPEN,
717 SOCK_LINGER,
718 SOCK_DESTROY,
719 SOCK_BROADCAST,
720 SOCK_TIMESTAMP,
721 SOCK_ZAPPED,
722 SOCK_USE_WRITE_QUEUE, /* whether to call sk->sk_write_space in sock_wfree */
723 SOCK_DBG, /* %SO_DEBUG setting */
724 SOCK_RCVTSTAMP, /* %SO_TIMESTAMP setting */
Eric Dumazet92f37fd2007-03-25 22:14:49 -0700725 SOCK_RCVTSTAMPNS, /* %SO_TIMESTAMPNS setting */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700726 SOCK_LOCALROUTE, /* route locally only, %SO_DONTROUTE setting */
727 SOCK_QUEUE_SHRUNK, /* write queue has been shrunk recently */
Mel Gorman7cb02402012-07-31 16:44:16 -0700728 SOCK_MEMALLOC, /* VM depends on this socket for swapping */
Patrick Ohly20d49472009-02-12 05:03:38 +0000729 SOCK_TIMESTAMPING_RX_SOFTWARE, /* %SOF_TIMESTAMPING_RX_SOFTWARE */
Eric Dumazetbcdce712009-10-06 17:28:29 -0700730 SOCK_FASYNC, /* fasync() active */
Neil Horman3b885782009-10-12 13:26:31 -0700731 SOCK_RXQ_OVFL,
Shirley Ma1cdebb42011-07-06 12:17:30 +0000732 SOCK_ZEROCOPY, /* buffers from userspace */
Johannes Berg6e3e9392011-11-09 10:15:42 +0100733 SOCK_WIFI_STATUS, /* push wifi status to userspace */
Ben Greear3bdc0eb2012-02-11 15:39:30 +0000734 SOCK_NOFCS, /* Tell NIC not to do the Ethernet FCS.
735 * Will use last 4 bytes of packet sent from
736 * user-space instead.
737 */
Vincent Bernatd59577b2013-01-16 22:55:49 +0100738 SOCK_FILTER_LOCKED, /* Filter cannot be changed anymore */
Keller, Jacob E7d4c04f2013-03-28 11:19:25 +0000739 SOCK_SELECT_ERR_QUEUE, /* Wake select on error queue */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700740};
741
Ralf Baechle53b924b2005-08-23 10:11:30 -0700742static inline void sock_copy_flags(struct sock *nsk, struct sock *osk)
743{
744 nsk->sk_flags = osk->sk_flags;
745}
746
Linus Torvalds1da177e2005-04-16 15:20:36 -0700747static inline void sock_set_flag(struct sock *sk, enum sock_flags flag)
748{
749 __set_bit(flag, &sk->sk_flags);
750}
751
752static inline void sock_reset_flag(struct sock *sk, enum sock_flags flag)
753{
754 __clear_bit(flag, &sk->sk_flags);
755}
756
Eric Dumazet1b23a5d2012-05-16 05:57:07 +0000757static inline bool sock_flag(const struct sock *sk, enum sock_flags flag)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700758{
759 return test_bit(flag, &sk->sk_flags);
760}
761
Mel Gormanc93bdd02012-07-31 16:44:19 -0700762#ifdef CONFIG_NET
763extern struct static_key memalloc_socks;
764static inline int sk_memalloc_socks(void)
765{
766 return static_key_false(&memalloc_socks);
767}
768#else
769
770static inline int sk_memalloc_socks(void)
771{
772 return 0;
773}
774
775#endif
776
Eric Dumazet87e002b2015-09-29 07:42:45 -0700777static inline gfp_t sk_gfp_atomic(const struct sock *sk, gfp_t gfp_mask)
Mel Gorman99a1dec2012-07-31 16:44:14 -0700778{
Mel Gorman7cb02402012-07-31 16:44:16 -0700779 return GFP_ATOMIC | (sk->sk_allocation & __GFP_MEMALLOC);
Mel Gorman99a1dec2012-07-31 16:44:14 -0700780}
781
Linus Torvalds1da177e2005-04-16 15:20:36 -0700782static inline void sk_acceptq_removed(struct sock *sk)
783{
784 sk->sk_ack_backlog--;
785}
786
787static inline void sk_acceptq_added(struct sock *sk)
788{
789 sk->sk_ack_backlog++;
790}
791
Eric Dumazetdc6b9b72012-05-16 22:48:15 +0000792static inline bool sk_acceptq_is_full(const struct sock *sk)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700793{
David S. Miller64a14652007-03-06 11:21:05 -0800794 return sk->sk_ack_backlog > sk->sk_max_ack_backlog;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700795}
796
797/*
798 * Compute minimal free write space needed to queue new packets.
799 */
Eric Dumazetdc6b9b72012-05-16 22:48:15 +0000800static inline int sk_stream_min_wspace(const struct sock *sk)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700801{
Eric Dumazet8df09ea2007-12-21 03:07:41 -0800802 return sk->sk_wmem_queued >> 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700803}
804
Eric Dumazetdc6b9b72012-05-16 22:48:15 +0000805static inline int sk_stream_wspace(const struct sock *sk)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700806{
807 return sk->sk_sndbuf - sk->sk_wmem_queued;
808}
809
Joe Perches69336bd2013-09-22 10:32:26 -0700810void sk_stream_write_space(struct sock *sk);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700811
Zhu Yi8eae9392010-03-04 18:01:40 +0000812/* OOB backlog add */
Zhu Yia3a858f2010-03-04 18:01:47 +0000813static inline void __sk_add_backlog(struct sock *sk, struct sk_buff *skb)
Stephen Hemminger9ee6b532005-11-08 09:39:42 -0800814{
Eric Dumazet7fee2262010-05-11 23:19:48 +0000815 /* dont let skb dst not refcounted, we are going to leave rcu lock */
816 skb_dst_force(skb);
817
818 if (!sk->sk_backlog.tail)
819 sk->sk_backlog.head = skb;
820 else
Stephen Hemminger9ee6b532005-11-08 09:39:42 -0800821 sk->sk_backlog.tail->next = skb;
Eric Dumazet7fee2262010-05-11 23:19:48 +0000822
823 sk->sk_backlog.tail = skb;
Stephen Hemminger9ee6b532005-11-08 09:39:42 -0800824 skb->next = NULL;
825}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700826
Eric Dumazetc3774112010-04-27 15:13:20 -0700827/*
828 * Take into account size of receive queue and backlog queue
Eric Dumazet0fd7bac2011-12-21 07:11:44 +0000829 * Do not take into account this skb truesize,
830 * to allow even a single big packet to come.
Eric Dumazetc3774112010-04-27 15:13:20 -0700831 */
Sorin Dumitru274f4822014-07-22 21:16:51 +0300832static inline bool sk_rcvqueues_full(const struct sock *sk, unsigned int limit)
Eric Dumazetc3774112010-04-27 15:13:20 -0700833{
834 unsigned int qsize = sk->sk_backlog.len + atomic_read(&sk->sk_rmem_alloc);
835
Eric Dumazetf545a382012-04-22 23:34:26 +0000836 return qsize > limit;
Eric Dumazetc3774112010-04-27 15:13:20 -0700837}
838
Zhu Yi8eae9392010-03-04 18:01:40 +0000839/* The per-socket spinlock must be held here. */
Eric Dumazetf545a382012-04-22 23:34:26 +0000840static inline __must_check int sk_add_backlog(struct sock *sk, struct sk_buff *skb,
841 unsigned int limit)
Zhu Yi8eae9392010-03-04 18:01:40 +0000842{
Sorin Dumitru274f4822014-07-22 21:16:51 +0300843 if (sk_rcvqueues_full(sk, limit))
Zhu Yi8eae9392010-03-04 18:01:40 +0000844 return -ENOBUFS;
845
Zhu Yia3a858f2010-03-04 18:01:47 +0000846 __sk_add_backlog(sk, skb);
Zhu Yi8eae9392010-03-04 18:01:40 +0000847 sk->sk_backlog.len += skb->truesize;
848 return 0;
849}
850
Joe Perches69336bd2013-09-22 10:32:26 -0700851int __sk_backlog_rcv(struct sock *sk, struct sk_buff *skb);
Mel Gormanb4b9e352012-07-31 16:44:26 -0700852
Peter Zijlstrac57943a2008-10-07 14:18:42 -0700853static inline int sk_backlog_rcv(struct sock *sk, struct sk_buff *skb)
854{
Mel Gormanb4b9e352012-07-31 16:44:26 -0700855 if (sk_memalloc_socks() && skb_pfmemalloc(skb))
856 return __sk_backlog_rcv(sk, skb);
857
Peter Zijlstrac57943a2008-10-07 14:18:42 -0700858 return sk->sk_backlog_rcv(sk, skb);
859}
860
Eric Dumazet2c8c56e2014-11-11 05:54:28 -0800861static inline void sk_incoming_cpu_update(struct sock *sk)
862{
863 sk->sk_incoming_cpu = raw_smp_processor_id();
864}
865
Tom Herbertfe477552013-12-22 18:54:31 +0800866static inline void sock_rps_record_flow_hash(__u32 hash)
David S. Millerc58dc012010-04-27 15:05:31 -0700867{
868#ifdef CONFIG_RPS
869 struct rps_sock_flow_table *sock_flow_table;
870
871 rcu_read_lock();
872 sock_flow_table = rcu_dereference(rps_sock_flow_table);
Tom Herbertfe477552013-12-22 18:54:31 +0800873 rps_record_sock_flow(sock_flow_table, hash);
David S. Millerc58dc012010-04-27 15:05:31 -0700874 rcu_read_unlock();
875#endif
876}
877
Tom Herbertfe477552013-12-22 18:54:31 +0800878static inline void sock_rps_record_flow(const struct sock *sk)
879{
Zhi Yong Wuc9d8ca02014-01-01 04:31:01 +0800880#ifdef CONFIG_RPS
Tom Herbertfe477552013-12-22 18:54:31 +0800881 sock_rps_record_flow_hash(sk->sk_rxhash);
Zhi Yong Wuc9d8ca02014-01-01 04:31:01 +0800882#endif
Tom Herbertfe477552013-12-22 18:54:31 +0800883}
884
Tom Herbertbdeab992011-08-14 19:45:55 +0000885static inline void sock_rps_save_rxhash(struct sock *sk,
886 const struct sk_buff *skb)
David S. Millerc58dc012010-04-27 15:05:31 -0700887{
888#ifdef CONFIG_RPS
Eric Dumazet567e4b72015-02-06 12:59:01 -0800889 if (unlikely(sk->sk_rxhash != skb->hash))
Tom Herbert61b905d2014-03-24 15:34:47 -0700890 sk->sk_rxhash = skb->hash;
David S. Millerc58dc012010-04-27 15:05:31 -0700891#endif
892}
893
Tom Herbertbdeab992011-08-14 19:45:55 +0000894static inline void sock_rps_reset_rxhash(struct sock *sk)
895{
896#ifdef CONFIG_RPS
Tom Herbertbdeab992011-08-14 19:45:55 +0000897 sk->sk_rxhash = 0;
898#endif
899}
900
Stephen Hemmingercfcabdc2007-10-09 01:59:42 -0700901#define sk_wait_event(__sk, __timeo, __condition) \
902 ({ int __rc; \
903 release_sock(__sk); \
904 __rc = __condition; \
905 if (!__rc) { \
906 *(__timeo) = schedule_timeout(*(__timeo)); \
907 } \
Peter Zijlstra26cabd32014-09-24 10:18:54 +0200908 sched_annotate_sleep(); \
Stephen Hemmingercfcabdc2007-10-09 01:59:42 -0700909 lock_sock(__sk); \
910 __rc = __condition; \
911 __rc; \
912 })
Linus Torvalds1da177e2005-04-16 15:20:36 -0700913
Joe Perches69336bd2013-09-22 10:32:26 -0700914int sk_stream_wait_connect(struct sock *sk, long *timeo_p);
915int sk_stream_wait_memory(struct sock *sk, long *timeo_p);
916void sk_stream_wait_close(struct sock *sk, long timeo_p);
917int sk_stream_error(struct sock *sk, int flags, int err);
918void sk_stream_kill_queues(struct sock *sk);
919void sk_set_memalloc(struct sock *sk);
920void sk_clear_memalloc(struct sock *sk);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700921
Sabrina Dubrocadfbafc92015-07-24 18:19:25 +0200922int sk_wait_data(struct sock *sk, long *timeo, const struct sk_buff *skb);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700923
Arnaldo Carvalho de Melo60236fd2005-06-18 22:47:21 -0700924struct request_sock_ops;
Arnaldo Carvalho de Melo6d6ee432005-12-13 23:25:19 -0800925struct timewait_sock_ops;
Arnaldo Carvalho de Meloab1e0a12008-02-03 04:06:04 -0800926struct inet_hashinfo;
Pavel Emelyanovfc8717b2008-03-22 16:56:51 -0700927struct raw_hashinfo;
Paul Gortmakerde477252011-05-26 13:46:22 -0400928struct module;
Arnaldo Carvalho de Melo2e6599c2005-06-18 22:46:52 -0700929
Eric Dumazetf77d6022013-05-09 10:28:16 +0000930/*
931 * caches using SLAB_DESTROY_BY_RCU should let .next pointer from nulls nodes
932 * un-modified. Special care is taken when initializing object to zero.
933 */
934static inline void sk_prot_clear_nulls(struct sock *sk, int size)
935{
936 if (offsetof(struct sock, sk_node.next) != 0)
937 memset(sk, 0, offsetof(struct sock, sk_node.next));
938 memset(&sk->sk_node.pprev, 0,
939 size - offsetof(struct sock, sk_node.pprev));
940}
941
Linus Torvalds1da177e2005-04-16 15:20:36 -0700942/* Networking protocol blocks we attach to sockets.
943 * socket layer -> transport layer interface
Linus Torvalds1da177e2005-04-16 15:20:36 -0700944 */
945struct proto {
Eric Dumazetdc6b9b72012-05-16 22:48:15 +0000946 void (*close)(struct sock *sk,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700947 long timeout);
948 int (*connect)(struct sock *sk,
Eric Dumazetdc6b9b72012-05-16 22:48:15 +0000949 struct sockaddr *uaddr,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700950 int addr_len);
951 int (*disconnect)(struct sock *sk, int flags);
952
Eric Dumazetdc6b9b72012-05-16 22:48:15 +0000953 struct sock * (*accept)(struct sock *sk, int flags, int *err);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700954
955 int (*ioctl)(struct sock *sk, int cmd,
956 unsigned long arg);
957 int (*init)(struct sock *sk);
Brian Haley7d06b2e2008-06-14 17:04:49 -0700958 void (*destroy)(struct sock *sk);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700959 void (*shutdown)(struct sock *sk, int how);
Eric Dumazetdc6b9b72012-05-16 22:48:15 +0000960 int (*setsockopt)(struct sock *sk, int level,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700961 int optname, char __user *optval,
David S. Millerb7058842009-09-30 16:12:20 -0700962 unsigned int optlen);
Eric Dumazetdc6b9b72012-05-16 22:48:15 +0000963 int (*getsockopt)(struct sock *sk, int level,
964 int optname, char __user *optval,
965 int __user *option);
Alexey Dobriyanaf01d532008-08-28 02:53:51 -0700966#ifdef CONFIG_COMPAT
Dmitry Mishin3fdadf72006-03-20 22:45:21 -0800967 int (*compat_setsockopt)(struct sock *sk,
968 int level,
969 int optname, char __user *optval,
David S. Millerb7058842009-09-30 16:12:20 -0700970 unsigned int optlen);
Dmitry Mishin3fdadf72006-03-20 22:45:21 -0800971 int (*compat_getsockopt)(struct sock *sk,
972 int level,
973 int optname, char __user *optval,
974 int __user *option);
Eric W. Biederman709b46e2011-01-29 16:15:56 +0000975 int (*compat_ioctl)(struct sock *sk,
976 unsigned int cmd, unsigned long arg);
Alexey Dobriyanaf01d532008-08-28 02:53:51 -0700977#endif
Ying Xue1b784142015-03-02 15:37:48 +0800978 int (*sendmsg)(struct sock *sk, struct msghdr *msg,
979 size_t len);
980 int (*recvmsg)(struct sock *sk, struct msghdr *msg,
Eric Dumazetdc6b9b72012-05-16 22:48:15 +0000981 size_t len, int noblock, int flags,
982 int *addr_len);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700983 int (*sendpage)(struct sock *sk, struct page *page,
984 int offset, size_t size, int flags);
Eric Dumazetdc6b9b72012-05-16 22:48:15 +0000985 int (*bind)(struct sock *sk,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700986 struct sockaddr *uaddr, int addr_len);
987
Eric Dumazetdc6b9b72012-05-16 22:48:15 +0000988 int (*backlog_rcv) (struct sock *sk,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700989 struct sk_buff *skb);
990
Eric Dumazet46d3cea2012-07-11 05:50:31 +0000991 void (*release_cb)(struct sock *sk);
992
Linus Torvalds1da177e2005-04-16 15:20:36 -0700993 /* Keeping track of sk's, looking them up, and port selection methods. */
994 void (*hash)(struct sock *sk);
995 void (*unhash)(struct sock *sk);
Eric Dumazet719f8352010-09-08 05:08:44 +0000996 void (*rehash)(struct sock *sk);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700997 int (*get_port)(struct sock *sk, unsigned short snum);
Octavian Purdilafcbdf092010-12-16 14:26:56 -0800998 void (*clear_sk)(struct sock *sk, int size);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700999
Eric Dumazet286ab3d2007-11-05 23:38:39 -08001000 /* Keeping track of sockets in use */
Eric Dumazet65f76512008-01-03 20:46:48 -08001001#ifdef CONFIG_PROC_FS
Pavel Emelyanov13ff3d62008-03-28 16:38:17 -07001002 unsigned int inuse_idx;
Eric Dumazet65f76512008-01-03 20:46:48 -08001003#endif
Arnaldo Carvalho de Meloebb53d72007-11-21 22:08:50 +08001004
Eric Dumazetc9bee3b72013-07-22 20:27:07 -07001005 bool (*stream_memory_free)(const struct sock *sk);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001006 /* Memory pressure */
Pavel Emelyanov5c52ba12008-07-16 20:28:10 -07001007 void (*enter_memory_pressure)(struct sock *sk);
Eric Dumazet8d987e52010-11-09 23:24:26 +00001008 atomic_long_t *memory_allocated; /* Current allocated memory. */
Eric Dumazet17483762008-11-25 21:16:35 -08001009 struct percpu_counter *sockets_allocated; /* Current number of sockets. */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001010 /*
1011 * Pressure flag: try to collapse.
1012 * Technical note: it is used by multiple contexts non atomically.
Hideo Aoki3ab224b2007-12-31 00:11:19 -08001013 * All the __sk_mem_schedule() is of this nature: accounting
Linus Torvalds1da177e2005-04-16 15:20:36 -07001014 * is strict, actions are advisory and have some latency.
1015 */
1016 int *memory_pressure;
Eric Dumazet8d987e52010-11-09 23:24:26 +00001017 long *sysctl_mem;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001018 int *sysctl_wmem;
1019 int *sysctl_rmem;
1020 int max_header;
Changli Gao7ba42912010-07-10 20:41:55 +00001021 bool no_autobind;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001022
Eric Dumazet271b72c2008-10-29 02:11:14 -07001023 struct kmem_cache *slab;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001024 unsigned int obj_size;
Eric Dumazet271b72c2008-10-29 02:11:14 -07001025 int slab_flags;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001026
Eric Dumazetdd24c002008-11-25 21:17:14 -08001027 struct percpu_counter *orphan_count;
Arnaldo Carvalho de Melo8feaf0c02005-08-09 20:09:30 -07001028
Arnaldo Carvalho de Melo60236fd2005-06-18 22:47:21 -07001029 struct request_sock_ops *rsk_prot;
Arnaldo Carvalho de Melo6d6ee432005-12-13 23:25:19 -08001030 struct timewait_sock_ops *twsk_prot;
Arnaldo Carvalho de Melo2e6599c2005-06-18 22:46:52 -07001031
Pavel Emelyanov39d8cda2008-03-22 16:50:58 -07001032 union {
1033 struct inet_hashinfo *hashinfo;
Eric Dumazet645ca702008-10-29 01:41:45 -07001034 struct udp_table *udp_table;
Pavel Emelyanovfc8717b2008-03-22 16:56:51 -07001035 struct raw_hashinfo *raw_hash;
Pavel Emelyanov39d8cda2008-03-22 16:50:58 -07001036 } h;
Arnaldo Carvalho de Meloab1e0a12008-02-03 04:06:04 -08001037
Linus Torvalds1da177e2005-04-16 15:20:36 -07001038 struct module *owner;
1039
1040 char name[32];
1041
1042 struct list_head node;
Arnaldo Carvalho de Meloe6848972005-08-09 19:45:38 -07001043#ifdef SOCK_REFCNT_DEBUG
1044 atomic_t socks;
1045#endif
Andrew Mortonc255a452012-07-31 16:43:02 -07001046#ifdef CONFIG_MEMCG_KMEM
Glauber Costae1aab162011-12-11 21:47:03 +00001047 /*
1048 * cgroup specific init/deinit functions. Called once for all
1049 * protocols that implement it, from cgroups populate function.
1050 * This function has to setup any files the protocol want to
1051 * appear in the kmem cgroup filesystem.
1052 */
Glauber Costa1d62e432012-04-09 19:36:33 -03001053 int (*init_cgroup)(struct mem_cgroup *memcg,
Glauber Costae1aab162011-12-11 21:47:03 +00001054 struct cgroup_subsys *ss);
Glauber Costa1d62e432012-04-09 19:36:33 -03001055 void (*destroy_cgroup)(struct mem_cgroup *memcg);
Glauber Costae1aab162011-12-11 21:47:03 +00001056 struct cg_proto *(*proto_cgroup)(struct mem_cgroup *memcg);
1057#endif
1058};
1059
Joe Perches69336bd2013-09-22 10:32:26 -07001060int proto_register(struct proto *prot, int alloc_slab);
1061void proto_unregister(struct proto *prot);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001062
Arnaldo Carvalho de Meloe6848972005-08-09 19:45:38 -07001063#ifdef SOCK_REFCNT_DEBUG
1064static inline void sk_refcnt_debug_inc(struct sock *sk)
1065{
1066 atomic_inc(&sk->sk_prot->socks);
1067}
1068
1069static inline void sk_refcnt_debug_dec(struct sock *sk)
1070{
1071 atomic_dec(&sk->sk_prot->socks);
1072 printk(KERN_DEBUG "%s socket %p released, %d are still alive\n",
1073 sk->sk_prot->name, sk, atomic_read(&sk->sk_prot->socks));
1074}
1075
Ying Xuedec34fb2013-02-15 22:28:25 +00001076static inline void sk_refcnt_debug_release(const struct sock *sk)
Arnaldo Carvalho de Meloe6848972005-08-09 19:45:38 -07001077{
1078 if (atomic_read(&sk->sk_refcnt) != 1)
1079 printk(KERN_DEBUG "Destruction of the %s socket %p delayed, refcnt=%d\n",
1080 sk->sk_prot->name, sk, atomic_read(&sk->sk_refcnt));
1081}
1082#else /* SOCK_REFCNT_DEBUG */
1083#define sk_refcnt_debug_inc(sk) do { } while (0)
1084#define sk_refcnt_debug_dec(sk) do { } while (0)
1085#define sk_refcnt_debug_release(sk) do { } while (0)
1086#endif /* SOCK_REFCNT_DEBUG */
1087
Andrew Mortonc255a452012-07-31 16:43:02 -07001088#if defined(CONFIG_MEMCG_KMEM) && defined(CONFIG_NET)
Ingo Molnarc5905af2012-02-24 08:31:31 +01001089extern struct static_key memcg_socket_limit_enabled;
Glauber Costae1aab162011-12-11 21:47:03 +00001090static inline struct cg_proto *parent_cg_proto(struct proto *proto,
1091 struct cg_proto *cg_proto)
1092{
1093 return proto->proto_cgroup(parent_mem_cgroup(cg_proto->memcg));
1094}
Ingo Molnarc5905af2012-02-24 08:31:31 +01001095#define mem_cgroup_sockets_enabled static_key_false(&memcg_socket_limit_enabled)
Glauber Costae1aab162011-12-11 21:47:03 +00001096#else
1097#define mem_cgroup_sockets_enabled 0
1098static inline struct cg_proto *parent_cg_proto(struct proto *proto,
1099 struct cg_proto *cg_proto)
1100{
1101 return NULL;
1102}
1103#endif
1104
Eric Dumazetc9bee3b72013-07-22 20:27:07 -07001105static inline bool sk_stream_memory_free(const struct sock *sk)
1106{
1107 if (sk->sk_wmem_queued >= sk->sk_sndbuf)
1108 return false;
1109
1110 return sk->sk_prot->stream_memory_free ?
1111 sk->sk_prot->stream_memory_free(sk) : true;
1112}
1113
Eric Dumazet64dc6132013-07-22 20:26:31 -07001114static inline bool sk_stream_is_writeable(const struct sock *sk)
1115{
Eric Dumazetc9bee3b72013-07-22 20:27:07 -07001116 return sk_stream_wspace(sk) >= sk_stream_min_wspace(sk) &&
1117 sk_stream_memory_free(sk);
Eric Dumazet64dc6132013-07-22 20:26:31 -07001118}
Glauber Costae1aab162011-12-11 21:47:03 +00001119
Eric Dumazetc9bee3b72013-07-22 20:27:07 -07001120
Glauber Costa180d8cd2011-12-11 21:47:02 +00001121static inline bool sk_has_memory_pressure(const struct sock *sk)
1122{
1123 return sk->sk_prot->memory_pressure != NULL;
1124}
1125
1126static inline bool sk_under_memory_pressure(const struct sock *sk)
1127{
1128 if (!sk->sk_prot->memory_pressure)
1129 return false;
Glauber Costae1aab162011-12-11 21:47:03 +00001130
1131 if (mem_cgroup_sockets_enabled && sk->sk_cgrp)
Eric W. Biederman2e685ca2013-10-19 16:26:19 -07001132 return !!sk->sk_cgrp->memory_pressure;
Glauber Costae1aab162011-12-11 21:47:03 +00001133
Christoph Paasch35b87f62013-10-23 12:49:21 -07001134 return !!*sk->sk_prot->memory_pressure;
Glauber Costa180d8cd2011-12-11 21:47:02 +00001135}
1136
1137static inline void sk_leave_memory_pressure(struct sock *sk)
1138{
1139 int *memory_pressure = sk->sk_prot->memory_pressure;
1140
Glauber Costae1aab162011-12-11 21:47:03 +00001141 if (!memory_pressure)
1142 return;
1143
1144 if (*memory_pressure)
Glauber Costa180d8cd2011-12-11 21:47:02 +00001145 *memory_pressure = 0;
Glauber Costae1aab162011-12-11 21:47:03 +00001146
1147 if (mem_cgroup_sockets_enabled && sk->sk_cgrp) {
1148 struct cg_proto *cg_proto = sk->sk_cgrp;
1149 struct proto *prot = sk->sk_prot;
1150
1151 for (; cg_proto; cg_proto = parent_cg_proto(prot, cg_proto))
Eric W. Biederman7f2cbdc2013-12-04 20:12:04 -08001152 cg_proto->memory_pressure = 0;
Glauber Costae1aab162011-12-11 21:47:03 +00001153 }
1154
Glauber Costa180d8cd2011-12-11 21:47:02 +00001155}
1156
1157static inline void sk_enter_memory_pressure(struct sock *sk)
1158{
Glauber Costae1aab162011-12-11 21:47:03 +00001159 if (!sk->sk_prot->enter_memory_pressure)
1160 return;
1161
1162 if (mem_cgroup_sockets_enabled && sk->sk_cgrp) {
1163 struct cg_proto *cg_proto = sk->sk_cgrp;
1164 struct proto *prot = sk->sk_prot;
1165
1166 for (; cg_proto; cg_proto = parent_cg_proto(prot, cg_proto))
Eric W. Biederman7f2cbdc2013-12-04 20:12:04 -08001167 cg_proto->memory_pressure = 1;
Glauber Costae1aab162011-12-11 21:47:03 +00001168 }
1169
1170 sk->sk_prot->enter_memory_pressure(sk);
Glauber Costa180d8cd2011-12-11 21:47:02 +00001171}
1172
1173static inline long sk_prot_mem_limits(const struct sock *sk, int index)
1174{
1175 long *prot = sk->sk_prot->sysctl_mem;
Glauber Costae1aab162011-12-11 21:47:03 +00001176 if (mem_cgroup_sockets_enabled && sk->sk_cgrp)
1177 prot = sk->sk_cgrp->sysctl_mem;
Glauber Costa180d8cd2011-12-11 21:47:02 +00001178 return prot[index];
1179}
1180
Glauber Costae1aab162011-12-11 21:47:03 +00001181static inline void memcg_memory_allocated_add(struct cg_proto *prot,
1182 unsigned long amt,
1183 int *parent_status)
1184{
Johannes Weiner3e32cb22014-12-10 15:42:31 -08001185 page_counter_charge(&prot->memory_allocated, amt);
Glauber Costae1aab162011-12-11 21:47:03 +00001186
Johannes Weiner3e32cb22014-12-10 15:42:31 -08001187 if (page_counter_read(&prot->memory_allocated) >
1188 prot->memory_allocated.limit)
Glauber Costae1aab162011-12-11 21:47:03 +00001189 *parent_status = OVER_LIMIT;
1190}
1191
1192static inline void memcg_memory_allocated_sub(struct cg_proto *prot,
1193 unsigned long amt)
1194{
Johannes Weiner3e32cb22014-12-10 15:42:31 -08001195 page_counter_uncharge(&prot->memory_allocated, amt);
Glauber Costae1aab162011-12-11 21:47:03 +00001196}
1197
Glauber Costa180d8cd2011-12-11 21:47:02 +00001198static inline long
1199sk_memory_allocated(const struct sock *sk)
1200{
1201 struct proto *prot = sk->sk_prot;
Johannes Weiner3e32cb22014-12-10 15:42:31 -08001202
Glauber Costae1aab162011-12-11 21:47:03 +00001203 if (mem_cgroup_sockets_enabled && sk->sk_cgrp)
Johannes Weiner3e32cb22014-12-10 15:42:31 -08001204 return page_counter_read(&sk->sk_cgrp->memory_allocated);
Glauber Costae1aab162011-12-11 21:47:03 +00001205
Glauber Costa180d8cd2011-12-11 21:47:02 +00001206 return atomic_long_read(prot->memory_allocated);
1207}
1208
1209static inline long
Glauber Costae1aab162011-12-11 21:47:03 +00001210sk_memory_allocated_add(struct sock *sk, int amt, int *parent_status)
Glauber Costa180d8cd2011-12-11 21:47:02 +00001211{
1212 struct proto *prot = sk->sk_prot;
Glauber Costae1aab162011-12-11 21:47:03 +00001213
1214 if (mem_cgroup_sockets_enabled && sk->sk_cgrp) {
1215 memcg_memory_allocated_add(sk->sk_cgrp, amt, parent_status);
1216 /* update the root cgroup regardless */
1217 atomic_long_add_return(amt, prot->memory_allocated);
Johannes Weiner3e32cb22014-12-10 15:42:31 -08001218 return page_counter_read(&sk->sk_cgrp->memory_allocated);
Glauber Costae1aab162011-12-11 21:47:03 +00001219 }
1220
Glauber Costa180d8cd2011-12-11 21:47:02 +00001221 return atomic_long_add_return(amt, prot->memory_allocated);
1222}
1223
1224static inline void
Glauber Costa0e90b312012-01-20 04:57:16 +00001225sk_memory_allocated_sub(struct sock *sk, int amt)
Glauber Costa180d8cd2011-12-11 21:47:02 +00001226{
1227 struct proto *prot = sk->sk_prot;
Glauber Costae1aab162011-12-11 21:47:03 +00001228
Glauber Costa0e90b312012-01-20 04:57:16 +00001229 if (mem_cgroup_sockets_enabled && sk->sk_cgrp)
Glauber Costae1aab162011-12-11 21:47:03 +00001230 memcg_memory_allocated_sub(sk->sk_cgrp, amt);
1231
Glauber Costa180d8cd2011-12-11 21:47:02 +00001232 atomic_long_sub(amt, prot->memory_allocated);
1233}
1234
1235static inline void sk_sockets_allocated_dec(struct sock *sk)
1236{
1237 struct proto *prot = sk->sk_prot;
Glauber Costae1aab162011-12-11 21:47:03 +00001238
1239 if (mem_cgroup_sockets_enabled && sk->sk_cgrp) {
1240 struct cg_proto *cg_proto = sk->sk_cgrp;
1241
1242 for (; cg_proto; cg_proto = parent_cg_proto(prot, cg_proto))
Eric W. Biederman2e685ca2013-10-19 16:26:19 -07001243 percpu_counter_dec(&cg_proto->sockets_allocated);
Glauber Costae1aab162011-12-11 21:47:03 +00001244 }
1245
Glauber Costa180d8cd2011-12-11 21:47:02 +00001246 percpu_counter_dec(prot->sockets_allocated);
1247}
1248
1249static inline void sk_sockets_allocated_inc(struct sock *sk)
1250{
1251 struct proto *prot = sk->sk_prot;
Glauber Costae1aab162011-12-11 21:47:03 +00001252
1253 if (mem_cgroup_sockets_enabled && sk->sk_cgrp) {
1254 struct cg_proto *cg_proto = sk->sk_cgrp;
1255
1256 for (; cg_proto; cg_proto = parent_cg_proto(prot, cg_proto))
Eric W. Biederman2e685ca2013-10-19 16:26:19 -07001257 percpu_counter_inc(&cg_proto->sockets_allocated);
Glauber Costae1aab162011-12-11 21:47:03 +00001258 }
1259
Glauber Costa180d8cd2011-12-11 21:47:02 +00001260 percpu_counter_inc(prot->sockets_allocated);
1261}
1262
1263static inline int
1264sk_sockets_allocated_read_positive(struct sock *sk)
1265{
1266 struct proto *prot = sk->sk_prot;
1267
Glauber Costae1aab162011-12-11 21:47:03 +00001268 if (mem_cgroup_sockets_enabled && sk->sk_cgrp)
Eric W. Biederman2e685ca2013-10-19 16:26:19 -07001269 return percpu_counter_read_positive(&sk->sk_cgrp->sockets_allocated);
Glauber Costae1aab162011-12-11 21:47:03 +00001270
Eric Dumazet518fbf92012-04-28 23:21:56 +00001271 return percpu_counter_read_positive(prot->sockets_allocated);
Glauber Costa180d8cd2011-12-11 21:47:02 +00001272}
1273
1274static inline int
1275proto_sockets_allocated_sum_positive(struct proto *prot)
1276{
1277 return percpu_counter_sum_positive(prot->sockets_allocated);
1278}
1279
1280static inline long
1281proto_memory_allocated(struct proto *prot)
1282{
1283 return atomic_long_read(prot->memory_allocated);
1284}
1285
1286static inline bool
1287proto_memory_pressure(struct proto *prot)
1288{
1289 if (!prot->memory_pressure)
1290 return false;
1291 return !!*prot->memory_pressure;
1292}
1293
Eric Dumazet65f76512008-01-03 20:46:48 -08001294
1295#ifdef CONFIG_PROC_FS
Linus Torvalds1da177e2005-04-16 15:20:36 -07001296/* Called with local bh disabled */
Joe Perches69336bd2013-09-22 10:32:26 -07001297void sock_prot_inuse_add(struct net *net, struct proto *prot, int inc);
1298int sock_prot_inuse_get(struct net *net, struct proto *proto);
Eric Dumazet65f76512008-01-03 20:46:48 -08001299#else
Eric Dumazetdc6b9b72012-05-16 22:48:15 +00001300static inline void sock_prot_inuse_add(struct net *net, struct proto *prot,
Pavel Emelyanovc29a0bc2008-03-31 19:41:46 -07001301 int inc)
Eric Dumazet65f76512008-01-03 20:46:48 -08001302{
1303}
Eric Dumazet65f76512008-01-03 20:46:48 -08001304#endif
1305
Linus Torvalds1da177e2005-04-16 15:20:36 -07001306
Arnaldo Carvalho de Melo614c6cb2005-08-09 19:47:37 -07001307/* With per-bucket locks this operation is not-atomic, so that
1308 * this version is not worse.
1309 */
1310static inline void __sk_prot_rehash(struct sock *sk)
1311{
1312 sk->sk_prot->unhash(sk);
1313 sk->sk_prot->hash(sk);
1314}
1315
Octavian Purdilafcbdf092010-12-16 14:26:56 -08001316void sk_prot_clear_portaddr_nulls(struct sock *sk, int size);
1317
Linus Torvalds1da177e2005-04-16 15:20:36 -07001318/* About 10 seconds */
1319#define SOCK_DESTROY_TIME (10*HZ)
1320
1321/* Sockets 0-1023 can't be bound to unless you are superuser */
1322#define PROT_SOCK 1024
1323
1324#define SHUTDOWN_MASK 3
1325#define RCV_SHUTDOWN 1
1326#define SEND_SHUTDOWN 2
1327
1328#define SOCK_SNDBUF_LOCK 1
1329#define SOCK_RCVBUF_LOCK 2
1330#define SOCK_BINDADDR_LOCK 4
1331#define SOCK_BINDPORT_LOCK 8
1332
Linus Torvalds1da177e2005-04-16 15:20:36 -07001333struct socket_alloc {
1334 struct socket socket;
1335 struct inode vfs_inode;
1336};
1337
1338static inline struct socket *SOCKET_I(struct inode *inode)
1339{
1340 return &container_of(inode, struct socket_alloc, vfs_inode)->socket;
1341}
1342
1343static inline struct inode *SOCK_INODE(struct socket *socket)
1344{
1345 return &container_of(socket, struct socket_alloc, socket)->vfs_inode;
1346}
1347
Hideo Aoki3ab224b2007-12-31 00:11:19 -08001348/*
1349 * Functions for memory accounting
1350 */
Joe Perches69336bd2013-09-22 10:32:26 -07001351int __sk_mem_schedule(struct sock *sk, int size, int kind);
Eric Dumazet1a24e042015-05-15 12:39:25 -07001352void __sk_mem_reclaim(struct sock *sk, int amount);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001353
Hideo Aoki3ab224b2007-12-31 00:11:19 -08001354#define SK_MEM_QUANTUM ((int)PAGE_SIZE)
1355#define SK_MEM_QUANTUM_SHIFT ilog2(SK_MEM_QUANTUM)
1356#define SK_MEM_SEND 0
1357#define SK_MEM_RECV 1
Linus Torvalds1da177e2005-04-16 15:20:36 -07001358
Hideo Aoki3ab224b2007-12-31 00:11:19 -08001359static inline int sk_mem_pages(int amt)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001360{
Hideo Aoki3ab224b2007-12-31 00:11:19 -08001361 return (amt + SK_MEM_QUANTUM - 1) >> SK_MEM_QUANTUM_SHIFT;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001362}
1363
Eric Dumazetdc6b9b72012-05-16 22:48:15 +00001364static inline bool sk_has_account(struct sock *sk)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001365{
Hideo Aoki3ab224b2007-12-31 00:11:19 -08001366 /* return true if protocol supports memory accounting */
1367 return !!sk->sk_prot->memory_allocated;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001368}
1369
Eric Dumazetdc6b9b72012-05-16 22:48:15 +00001370static inline bool sk_wmem_schedule(struct sock *sk, int size)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001371{
Hideo Aoki3ab224b2007-12-31 00:11:19 -08001372 if (!sk_has_account(sk))
Eric Dumazetdc6b9b72012-05-16 22:48:15 +00001373 return true;
Herbert Xud80d99d2005-09-01 17:48:23 -07001374 return size <= sk->sk_forward_alloc ||
Hideo Aoki3ab224b2007-12-31 00:11:19 -08001375 __sk_mem_schedule(sk, size, SK_MEM_SEND);
1376}
1377
Mel Gormanc76562b2012-07-31 16:44:41 -07001378static inline bool
Chuck Lever35c448a2012-09-17 14:09:11 -07001379sk_rmem_schedule(struct sock *sk, struct sk_buff *skb, int size)
Hideo Aoki3ab224b2007-12-31 00:11:19 -08001380{
1381 if (!sk_has_account(sk))
Eric Dumazetdc6b9b72012-05-16 22:48:15 +00001382 return true;
Mel Gormanc76562b2012-07-31 16:44:41 -07001383 return size<= sk->sk_forward_alloc ||
1384 __sk_mem_schedule(sk, size, SK_MEM_RECV) ||
1385 skb_pfmemalloc(skb);
Hideo Aoki3ab224b2007-12-31 00:11:19 -08001386}
1387
1388static inline void sk_mem_reclaim(struct sock *sk)
1389{
1390 if (!sk_has_account(sk))
1391 return;
1392 if (sk->sk_forward_alloc >= SK_MEM_QUANTUM)
Eric Dumazet1a24e042015-05-15 12:39:25 -07001393 __sk_mem_reclaim(sk, sk->sk_forward_alloc);
Hideo Aoki3ab224b2007-12-31 00:11:19 -08001394}
1395
David S. Miller9993e7d2008-01-10 21:56:38 -08001396static inline void sk_mem_reclaim_partial(struct sock *sk)
1397{
1398 if (!sk_has_account(sk))
1399 return;
1400 if (sk->sk_forward_alloc > SK_MEM_QUANTUM)
Eric Dumazet1a24e042015-05-15 12:39:25 -07001401 __sk_mem_reclaim(sk, sk->sk_forward_alloc - 1);
David S. Miller9993e7d2008-01-10 21:56:38 -08001402}
1403
Hideo Aoki3ab224b2007-12-31 00:11:19 -08001404static inline void sk_mem_charge(struct sock *sk, int size)
1405{
1406 if (!sk_has_account(sk))
1407 return;
1408 sk->sk_forward_alloc -= size;
1409}
1410
1411static inline void sk_mem_uncharge(struct sock *sk, int size)
1412{
1413 if (!sk_has_account(sk))
1414 return;
1415 sk->sk_forward_alloc += size;
1416}
1417
1418static inline void sk_wmem_free_skb(struct sock *sk, struct sk_buff *skb)
1419{
Hideo Aoki3ab224b2007-12-31 00:11:19 -08001420 sock_set_flag(sk, SOCK_QUEUE_SHRUNK);
1421 sk->sk_wmem_queued -= skb->truesize;
1422 sk_mem_uncharge(sk, skb->truesize);
1423 __kfree_skb(skb);
Herbert Xud80d99d2005-09-01 17:48:23 -07001424}
1425
Linus Torvalds1da177e2005-04-16 15:20:36 -07001426/* Used by processes to "lock" a socket state, so that
1427 * interrupts and bottom half handlers won't change it
1428 * from under us. It essentially blocks any incoming
1429 * packets, so that we won't get any new data or any
1430 * packets that change the state of the socket.
1431 *
1432 * While locked, BH processing will add new packets to
1433 * the backlog queue. This queue is processed by the
1434 * owner of the socket lock right before it is released.
1435 *
1436 * Since ~2.3.5 it is also exclusive sleep lock serializing
1437 * accesses from user process context.
1438 */
John Heffnerd2e91172007-09-12 10:44:19 +02001439#define sock_owned_by_user(sk) ((sk)->sk_lock.owned)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001440
Eric Dumazetc3f9b012014-03-10 09:50:11 -07001441static inline void sock_release_ownership(struct sock *sk)
1442{
1443 sk->sk_lock.owned = 0;
1444}
1445
Peter Zijlstraed075362006-12-06 20:35:24 -08001446/*
1447 * Macro so as to not evaluate some arguments when
1448 * lockdep is not enabled.
1449 *
1450 * Mark both the sk_lock and the sk_lock.slock as a
1451 * per-address-family lock class.
1452 */
Eric Dumazetdc6b9b72012-05-16 22:48:15 +00001453#define sock_lock_init_class_and_name(sk, sname, skey, name, key) \
Peter Zijlstraed075362006-12-06 20:35:24 -08001454do { \
Ingo Molnare8f6fbf2008-11-12 01:38:36 +00001455 sk->sk_lock.owned = 0; \
Peter Zijlstraed075362006-12-06 20:35:24 -08001456 init_waitqueue_head(&sk->sk_lock.wq); \
1457 spin_lock_init(&(sk)->sk_lock.slock); \
1458 debug_check_no_locks_freed((void *)&(sk)->sk_lock, \
1459 sizeof((sk)->sk_lock)); \
1460 lockdep_set_class_and_name(&(sk)->sk_lock.slock, \
Eric Dumazetdc6b9b72012-05-16 22:48:15 +00001461 (skey), (sname)); \
Peter Zijlstraed075362006-12-06 20:35:24 -08001462 lockdep_init_map(&(sk)->sk_lock.dep_map, (name), (key), 0); \
1463} while (0)
1464
Joe Perches69336bd2013-09-22 10:32:26 -07001465void lock_sock_nested(struct sock *sk, int subclass);
Peter Zijlstrafcc70d52006-11-08 22:44:35 -08001466
1467static inline void lock_sock(struct sock *sk)
1468{
1469 lock_sock_nested(sk, 0);
1470}
1471
Joe Perches69336bd2013-09-22 10:32:26 -07001472void release_sock(struct sock *sk);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001473
1474/* BH context may only use the following locking interface. */
1475#define bh_lock_sock(__sk) spin_lock(&((__sk)->sk_lock.slock))
Ingo Molnarc6366182006-07-03 00:25:13 -07001476#define bh_lock_sock_nested(__sk) \
1477 spin_lock_nested(&((__sk)->sk_lock.slock), \
1478 SINGLE_DEPTH_NESTING)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001479#define bh_unlock_sock(__sk) spin_unlock(&((__sk)->sk_lock.slock))
1480
Joe Perches69336bd2013-09-22 10:32:26 -07001481bool lock_sock_fast(struct sock *sk);
Eric Dumazet8a74ad62010-05-26 19:20:18 +00001482/**
1483 * unlock_sock_fast - complement of lock_sock_fast
1484 * @sk: socket
1485 * @slow: slow mode
1486 *
1487 * fast unlock socket for user context.
1488 * If slow mode is on, we call regular release_sock()
1489 */
1490static inline void unlock_sock_fast(struct sock *sk, bool slow)
Eric Dumazet4b0b72f2010-04-28 14:35:48 -07001491{
Eric Dumazet8a74ad62010-05-26 19:20:18 +00001492 if (slow)
1493 release_sock(sk);
1494 else
1495 spin_unlock_bh(&sk->sk_lock.slock);
Eric Dumazet4b0b72f2010-04-28 14:35:48 -07001496}
1497
Eric Dumazet4b0b72f2010-04-28 14:35:48 -07001498
Joe Perches69336bd2013-09-22 10:32:26 -07001499struct sock *sk_alloc(struct net *net, int family, gfp_t priority,
Eric W. Biederman11aa9c22015-05-08 21:09:13 -05001500 struct proto *prot, int kern);
Joe Perches69336bd2013-09-22 10:32:26 -07001501void sk_free(struct sock *sk);
Craig Gallekeb4cb002015-06-15 11:26:18 -04001502void sk_destruct(struct sock *sk);
Joe Perches69336bd2013-09-22 10:32:26 -07001503struct sock *sk_clone_lock(const struct sock *sk, const gfp_t priority);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001504
Joe Perches69336bd2013-09-22 10:32:26 -07001505struct sk_buff *sock_wmalloc(struct sock *sk, unsigned long size, int force,
1506 gfp_t priority);
Joe Perches69336bd2013-09-22 10:32:26 -07001507void sock_wfree(struct sk_buff *skb);
1508void skb_orphan_partial(struct sk_buff *skb);
1509void sock_rfree(struct sk_buff *skb);
Alexander Duyck62bccb82014-09-04 13:31:35 -04001510void sock_efree(struct sk_buff *skb);
Alexander Duyck82eabd92014-09-04 13:32:11 -04001511#ifdef CONFIG_INET
Joe Perches69336bd2013-09-22 10:32:26 -07001512void sock_edemux(struct sk_buff *skb);
Alexander Duyck82eabd92014-09-04 13:32:11 -04001513#else
1514#define sock_edemux(skb) sock_efree(skb)
1515#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -07001516
Joe Perches69336bd2013-09-22 10:32:26 -07001517int sock_setsockopt(struct socket *sock, int level, int op,
1518 char __user *optval, unsigned int optlen);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001519
Joe Perches69336bd2013-09-22 10:32:26 -07001520int sock_getsockopt(struct socket *sock, int level, int op,
1521 char __user *optval, int __user *optlen);
1522struct sk_buff *sock_alloc_send_skb(struct sock *sk, unsigned long size,
1523 int noblock, int *errcode);
1524struct sk_buff *sock_alloc_send_pskb(struct sock *sk, unsigned long header_len,
1525 unsigned long data_len, int noblock,
1526 int *errcode, int max_page_order);
1527void *sock_kmalloc(struct sock *sk, int size, gfp_t priority);
1528void sock_kfree_s(struct sock *sk, void *mem, int size);
Daniel Borkmann79e88652014-11-19 17:13:11 +01001529void sock_kzfree_s(struct sock *sk, void *mem, int size);
Joe Perches69336bd2013-09-22 10:32:26 -07001530void sk_send_sigurg(struct sock *sk);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001531
Edward Jeef28ea362015-10-08 14:56:48 -07001532struct sockcm_cookie {
1533 u32 mark;
1534};
1535
1536int sock_cmsg_send(struct sock *sk, struct msghdr *msg,
1537 struct sockcm_cookie *sockc);
1538
Linus Torvalds1da177e2005-04-16 15:20:36 -07001539/*
1540 * Functions to fill in entries in struct proto_ops when a protocol
1541 * does not implement a particular function.
1542 */
Joe Perches69336bd2013-09-22 10:32:26 -07001543int sock_no_bind(struct socket *, struct sockaddr *, int);
1544int sock_no_connect(struct socket *, struct sockaddr *, int, int);
1545int sock_no_socketpair(struct socket *, struct socket *);
1546int sock_no_accept(struct socket *, struct socket *, int);
1547int sock_no_getname(struct socket *, struct sockaddr *, int *, int);
1548unsigned int sock_no_poll(struct file *, struct socket *,
1549 struct poll_table_struct *);
1550int sock_no_ioctl(struct socket *, unsigned int, unsigned long);
1551int sock_no_listen(struct socket *, int);
1552int sock_no_shutdown(struct socket *, int);
1553int sock_no_getsockopt(struct socket *, int , int, char __user *, int __user *);
1554int sock_no_setsockopt(struct socket *, int, int, char __user *, unsigned int);
Ying Xue1b784142015-03-02 15:37:48 +08001555int sock_no_sendmsg(struct socket *, struct msghdr *, size_t);
1556int sock_no_recvmsg(struct socket *, struct msghdr *, size_t, int);
Joe Perches69336bd2013-09-22 10:32:26 -07001557int sock_no_mmap(struct file *file, struct socket *sock,
1558 struct vm_area_struct *vma);
1559ssize_t sock_no_sendpage(struct socket *sock, struct page *page, int offset,
1560 size_t size, int flags);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001561
1562/*
1563 * Functions to fill in entries in struct proto_ops when a protocol
1564 * uses the inet style.
1565 */
Joe Perches69336bd2013-09-22 10:32:26 -07001566int sock_common_getsockopt(struct socket *sock, int level, int optname,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001567 char __user *optval, int __user *optlen);
Ying Xue1b784142015-03-02 15:37:48 +08001568int sock_common_recvmsg(struct socket *sock, struct msghdr *msg, size_t size,
1569 int flags);
Joe Perches69336bd2013-09-22 10:32:26 -07001570int sock_common_setsockopt(struct socket *sock, int level, int optname,
David S. Millerb7058842009-09-30 16:12:20 -07001571 char __user *optval, unsigned int optlen);
Joe Perches69336bd2013-09-22 10:32:26 -07001572int compat_sock_common_getsockopt(struct socket *sock, int level,
Dmitry Mishin3fdadf72006-03-20 22:45:21 -08001573 int optname, char __user *optval, int __user *optlen);
Joe Perches69336bd2013-09-22 10:32:26 -07001574int compat_sock_common_setsockopt(struct socket *sock, int level,
David S. Millerb7058842009-09-30 16:12:20 -07001575 int optname, char __user *optval, unsigned int optlen);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001576
Joe Perches69336bd2013-09-22 10:32:26 -07001577void sk_common_release(struct sock *sk);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001578
1579/*
1580 * Default socket callbacks and setup code
1581 */
Eric Dumazetdc6b9b72012-05-16 22:48:15 +00001582
Linus Torvalds1da177e2005-04-16 15:20:36 -07001583/* Initialise core socket variables */
Joe Perches69336bd2013-09-22 10:32:26 -07001584void sock_init_data(struct socket *sock, struct sock *sk);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001585
Linus Torvalds1da177e2005-04-16 15:20:36 -07001586/*
1587 * Socket reference counting postulates.
1588 *
1589 * * Each user of socket SHOULD hold a reference count.
1590 * * Each access point to socket (an hash table bucket, reference from a list,
1591 * running timer, skb in flight MUST hold a reference count.
1592 * * When reference count hits 0, it means it will never increase back.
1593 * * When reference count hits 0, it means that no references from
1594 * outside exist to this socket and current process on current CPU
1595 * is last user and may/should destroy this socket.
1596 * * sk_free is called from any context: process, BH, IRQ. When
1597 * it is called, socket has no references from outside -> sk_free
1598 * may release descendant resources allocated by the socket, but
1599 * to the time when it is called, socket is NOT referenced by any
1600 * hash tables, lists etc.
1601 * * Packets, delivered from outside (from network or from another process)
1602 * and enqueued on receive/error queues SHOULD NOT grab reference count,
1603 * when they sit in queue. Otherwise, packets will leak to hole, when
1604 * socket is looked up by one cpu and unhasing is made by another CPU.
1605 * It is true for udp/raw, netlink (leak to receive and error queues), tcp
1606 * (leak to backlog). Packet socket does all the processing inside
1607 * BR_NETPROTO_LOCK, so that it has not this race condition. UNIX sockets
1608 * use separate SMP lock, so that they are prone too.
1609 */
1610
1611/* Ungrab socket and destroy it, if it was the last reference. */
1612static inline void sock_put(struct sock *sk)
1613{
1614 if (atomic_dec_and_test(&sk->sk_refcnt))
1615 sk_free(sk);
1616}
Eric Dumazet05dbc7b2013-10-03 00:22:02 -07001617/* Generic version of sock_put(), dealing with all sockets
Eric Dumazet41b822c2015-03-12 16:44:08 -07001618 * (TCP_TIMEWAIT, TCP_NEW_SYN_RECV, ESTABLISHED...)
Eric Dumazet05dbc7b2013-10-03 00:22:02 -07001619 */
1620void sock_gen_put(struct sock *sk);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001621
Joe Perches69336bd2013-09-22 10:32:26 -07001622int sk_receive_skb(struct sock *sk, struct sk_buff *skb, const int nested);
Arnaldo Carvalho de Melo25995ff2005-12-27 02:42:22 -02001623
Krishna Kumare022f0b2009-10-19 23:46:20 +00001624static inline void sk_tx_queue_set(struct sock *sk, int tx_queue)
1625{
1626 sk->sk_tx_queue_mapping = tx_queue;
1627}
1628
1629static inline void sk_tx_queue_clear(struct sock *sk)
1630{
1631 sk->sk_tx_queue_mapping = -1;
1632}
1633
1634static inline int sk_tx_queue_get(const struct sock *sk)
1635{
Tom Herbertb0f77d02010-07-14 20:50:29 -07001636 return sk ? sk->sk_tx_queue_mapping : -1;
Krishna Kumare022f0b2009-10-19 23:46:20 +00001637}
1638
David S. Miller972692e2008-06-17 22:41:38 -07001639static inline void sk_set_socket(struct sock *sk, struct socket *sock)
1640{
Krishna Kumare022f0b2009-10-19 23:46:20 +00001641 sk_tx_queue_clear(sk);
David S. Miller972692e2008-06-17 22:41:38 -07001642 sk->sk_socket = sock;
1643}
1644
Eric Dumazetaa395142010-04-20 13:03:51 +00001645static inline wait_queue_head_t *sk_sleep(struct sock *sk)
1646{
Eric Dumazeteaefd112011-02-18 03:26:36 +00001647 BUILD_BUG_ON(offsetof(struct socket_wq, wait) != 0);
1648 return &rcu_dereference_raw(sk->sk_wq)->wait;
Eric Dumazetaa395142010-04-20 13:03:51 +00001649}
Linus Torvalds1da177e2005-04-16 15:20:36 -07001650/* Detach socket from process context.
1651 * Announce socket dead, detach it from wait queue and inode.
1652 * Note that parent inode held reference count on this struct sock,
1653 * we do not release it in this function, because protocol
1654 * probably wants some additional cleanups or even continuing
1655 * to work with this socket (TCP).
1656 */
1657static inline void sock_orphan(struct sock *sk)
1658{
1659 write_lock_bh(&sk->sk_callback_lock);
1660 sock_set_flag(sk, SOCK_DEAD);
David S. Miller972692e2008-06-17 22:41:38 -07001661 sk_set_socket(sk, NULL);
Eric Dumazet43815482010-04-29 11:01:49 +00001662 sk->sk_wq = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001663 write_unlock_bh(&sk->sk_callback_lock);
1664}
1665
1666static inline void sock_graft(struct sock *sk, struct socket *parent)
1667{
1668 write_lock_bh(&sk->sk_callback_lock);
Eric Dumazeteaefd112011-02-18 03:26:36 +00001669 sk->sk_wq = parent->wq;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001670 parent->sk = sk;
David S. Miller972692e2008-06-17 22:41:38 -07001671 sk_set_socket(sk, parent);
Venkat Yekkirala4237c752006-07-24 23:32:50 -07001672 security_sock_graft(sk, parent);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001673 write_unlock_bh(&sk->sk_callback_lock);
1674}
1675
Joe Perches69336bd2013-09-22 10:32:26 -07001676kuid_t sock_i_uid(struct sock *sk);
1677unsigned long sock_i_ino(struct sock *sk);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001678
Eric Dumazet58d607d2015-09-15 15:24:20 -07001679static inline u32 net_tx_rndhash(void)
1680{
1681 u32 v = prandom_u32();
1682
1683 return v ?: 1;
1684}
1685
Tom Herbert877d1f62015-07-28 16:02:05 -07001686static inline void sk_set_txhash(struct sock *sk)
1687{
Eric Dumazet58d607d2015-09-15 15:24:20 -07001688 sk->sk_txhash = net_tx_rndhash();
Tom Herbert877d1f62015-07-28 16:02:05 -07001689}
1690
Tom Herbert265f94f2015-07-28 16:02:06 -07001691static inline void sk_rethink_txhash(struct sock *sk)
1692{
1693 if (sk->sk_txhash)
1694 sk_set_txhash(sk);
1695}
1696
Linus Torvalds1da177e2005-04-16 15:20:36 -07001697static inline struct dst_entry *
1698__sk_dst_get(struct sock *sk)
1699{
Michal Hockod8bf4ca2011-07-08 14:39:41 +02001700 return rcu_dereference_check(sk->sk_dst_cache, sock_owned_by_user(sk) ||
Eric Dumazetf68c2242010-04-22 16:06:59 -07001701 lockdep_is_held(&sk->sk_lock.slock));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001702}
1703
1704static inline struct dst_entry *
1705sk_dst_get(struct sock *sk)
1706{
1707 struct dst_entry *dst;
1708
Eric Dumazetb6c67122010-04-08 23:03:29 +00001709 rcu_read_lock();
1710 dst = rcu_dereference(sk->sk_dst_cache);
Eric Dumazetf8864972014-06-24 10:05:11 -07001711 if (dst && !atomic_inc_not_zero(&dst->__refcnt))
1712 dst = NULL;
Eric Dumazetb6c67122010-04-08 23:03:29 +00001713 rcu_read_unlock();
Linus Torvalds1da177e2005-04-16 15:20:36 -07001714 return dst;
1715}
1716
Eric Dumazetb6c67122010-04-08 23:03:29 +00001717static inline void dst_negative_advice(struct sock *sk)
1718{
1719 struct dst_entry *ndst, *dst = __sk_dst_get(sk);
1720
Tom Herbert265f94f2015-07-28 16:02:06 -07001721 sk_rethink_txhash(sk);
1722
Eric Dumazetb6c67122010-04-08 23:03:29 +00001723 if (dst && dst->ops->negative_advice) {
1724 ndst = dst->ops->negative_advice(dst);
1725
1726 if (ndst != dst) {
1727 rcu_assign_pointer(sk->sk_dst_cache, ndst);
ZHAO Gang0a6957e2013-10-22 16:23:38 +08001728 sk_tx_queue_clear(sk);
Eric Dumazetb6c67122010-04-08 23:03:29 +00001729 }
1730 }
1731}
1732
Linus Torvalds1da177e2005-04-16 15:20:36 -07001733static inline void
1734__sk_dst_set(struct sock *sk, struct dst_entry *dst)
1735{
1736 struct dst_entry *old_dst;
1737
Krishna Kumare022f0b2009-10-19 23:46:20 +00001738 sk_tx_queue_clear(sk);
Eric Dumazet0b53ff22010-04-26 20:40:43 +00001739 /*
1740 * This can be called while sk is owned by the caller only,
1741 * with no state that can be checked in a rcu_dereference_check() cond
1742 */
1743 old_dst = rcu_dereference_raw(sk->sk_dst_cache);
Eric Dumazetb6c67122010-04-08 23:03:29 +00001744 rcu_assign_pointer(sk->sk_dst_cache, dst);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001745 dst_release(old_dst);
1746}
1747
1748static inline void
1749sk_dst_set(struct sock *sk, struct dst_entry *dst)
1750{
Eric Dumazet7f502362014-06-30 01:26:23 -07001751 struct dst_entry *old_dst;
1752
1753 sk_tx_queue_clear(sk);
Eric Dumazet5925a052014-07-02 02:39:38 -07001754 old_dst = xchg((__force struct dst_entry **)&sk->sk_dst_cache, dst);
Eric Dumazet7f502362014-06-30 01:26:23 -07001755 dst_release(old_dst);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001756}
1757
1758static inline void
1759__sk_dst_reset(struct sock *sk)
1760{
Eric Dumazetb6c67122010-04-08 23:03:29 +00001761 __sk_dst_set(sk, NULL);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001762}
1763
1764static inline void
1765sk_dst_reset(struct sock *sk)
1766{
Eric Dumazet7f502362014-06-30 01:26:23 -07001767 sk_dst_set(sk, NULL);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001768}
1769
Joe Perches69336bd2013-09-22 10:32:26 -07001770struct dst_entry *__sk_dst_check(struct sock *sk, u32 cookie);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001771
Joe Perches69336bd2013-09-22 10:32:26 -07001772struct dst_entry *sk_dst_check(struct sock *sk, u32 cookie);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001773
hannes@stressinduktion.orgf60e5992015-04-01 17:07:44 +02001774bool sk_mc_loop(struct sock *sk);
1775
Eric Dumazetdc6b9b72012-05-16 22:48:15 +00001776static inline bool sk_can_gso(const struct sock *sk)
Herbert Xubcd76112006-06-30 13:36:35 -07001777{
1778 return net_gso_ok(sk->sk_route_caps, sk->sk_gso_type);
1779}
1780
Joe Perches69336bd2013-09-22 10:32:26 -07001781void sk_setup_caps(struct sock *sk, struct dst_entry *dst);
Arnaldo Carvalho de Melo6cbb0df2005-08-09 19:49:02 -07001782
Michał Mirosławc8f44af2011-11-15 15:29:55 +00001783static inline void sk_nocaps_add(struct sock *sk, netdev_features_t flags)
Eric Dumazeta4654192010-05-16 00:36:33 -07001784{
1785 sk->sk_route_nocaps |= flags;
1786 sk->sk_route_caps &= ~flags;
1787}
1788
Tom Herbertc6e1a0d2011-04-04 22:30:30 -07001789static inline int skb_do_copy_data_nocache(struct sock *sk, struct sk_buff *skb,
Al Viro57be5bd2014-11-28 13:40:20 -05001790 struct iov_iter *from, char *to,
Wei Yongjun912d3982011-04-06 18:40:12 +00001791 int copy, int offset)
Tom Herbertc6e1a0d2011-04-04 22:30:30 -07001792{
1793 if (skb->ip_summed == CHECKSUM_NONE) {
Al Viro57be5bd2014-11-28 13:40:20 -05001794 __wsum csum = 0;
1795 if (csum_and_copy_from_iter(to, copy, &csum, from) != copy)
1796 return -EFAULT;
Wei Yongjun912d3982011-04-06 18:40:12 +00001797 skb->csum = csum_block_add(skb->csum, csum, offset);
Tom Herbertc6e1a0d2011-04-04 22:30:30 -07001798 } else if (sk->sk_route_caps & NETIF_F_NOCACHE_COPY) {
Al Viro57be5bd2014-11-28 13:40:20 -05001799 if (copy_from_iter_nocache(to, copy, from) != copy)
Tom Herbertc6e1a0d2011-04-04 22:30:30 -07001800 return -EFAULT;
Al Viro57be5bd2014-11-28 13:40:20 -05001801 } else if (copy_from_iter(to, copy, from) != copy)
Tom Herbertc6e1a0d2011-04-04 22:30:30 -07001802 return -EFAULT;
1803
1804 return 0;
1805}
1806
1807static inline int skb_add_data_nocache(struct sock *sk, struct sk_buff *skb,
Al Viro57be5bd2014-11-28 13:40:20 -05001808 struct iov_iter *from, int copy)
Tom Herbertc6e1a0d2011-04-04 22:30:30 -07001809{
Wei Yongjun912d3982011-04-06 18:40:12 +00001810 int err, offset = skb->len;
Tom Herbertc6e1a0d2011-04-04 22:30:30 -07001811
Wei Yongjun912d3982011-04-06 18:40:12 +00001812 err = skb_do_copy_data_nocache(sk, skb, from, skb_put(skb, copy),
1813 copy, offset);
Tom Herbertc6e1a0d2011-04-04 22:30:30 -07001814 if (err)
Wei Yongjun912d3982011-04-06 18:40:12 +00001815 __skb_trim(skb, offset);
Tom Herbertc6e1a0d2011-04-04 22:30:30 -07001816
1817 return err;
1818}
1819
Al Viro57be5bd2014-11-28 13:40:20 -05001820static inline int skb_copy_to_page_nocache(struct sock *sk, struct iov_iter *from,
Tom Herbertc6e1a0d2011-04-04 22:30:30 -07001821 struct sk_buff *skb,
1822 struct page *page,
1823 int off, int copy)
1824{
1825 int err;
1826
Wei Yongjun912d3982011-04-06 18:40:12 +00001827 err = skb_do_copy_data_nocache(sk, skb, from, page_address(page) + off,
1828 copy, skb->len);
Tom Herbertc6e1a0d2011-04-04 22:30:30 -07001829 if (err)
1830 return err;
1831
1832 skb->len += copy;
1833 skb->data_len += copy;
1834 skb->truesize += copy;
1835 sk->sk_wmem_queued += copy;
1836 sk_mem_charge(sk, copy);
1837 return 0;
1838}
1839
Eric Dumazetc5640392009-06-16 10:12:03 +00001840/**
1841 * sk_wmem_alloc_get - returns write allocations
1842 * @sk: socket
1843 *
1844 * Returns sk_wmem_alloc minus initial offset of one
1845 */
1846static inline int sk_wmem_alloc_get(const struct sock *sk)
1847{
1848 return atomic_read(&sk->sk_wmem_alloc) - 1;
1849}
1850
1851/**
1852 * sk_rmem_alloc_get - returns read allocations
1853 * @sk: socket
1854 *
1855 * Returns sk_rmem_alloc
1856 */
1857static inline int sk_rmem_alloc_get(const struct sock *sk)
1858{
1859 return atomic_read(&sk->sk_rmem_alloc);
1860}
1861
1862/**
1863 * sk_has_allocations - check if allocations are outstanding
1864 * @sk: socket
1865 *
1866 * Returns true if socket has write or read allocations
1867 */
Eric Dumazetdc6b9b72012-05-16 22:48:15 +00001868static inline bool sk_has_allocations(const struct sock *sk)
Eric Dumazetc5640392009-06-16 10:12:03 +00001869{
1870 return sk_wmem_alloc_get(sk) || sk_rmem_alloc_get(sk);
1871}
1872
Jiri Olsaa57de0b2009-07-08 12:09:13 +00001873/**
Eric Dumazet43815482010-04-29 11:01:49 +00001874 * wq_has_sleeper - check if there are any waiting processes
Randy Dunlapacfbe962010-05-24 23:54:18 -07001875 * @wq: struct socket_wq
Jiri Olsaa57de0b2009-07-08 12:09:13 +00001876 *
Eric Dumazet43815482010-04-29 11:01:49 +00001877 * Returns true if socket_wq has waiting processes
Jiri Olsaa57de0b2009-07-08 12:09:13 +00001878 *
Eric Dumazet43815482010-04-29 11:01:49 +00001879 * The purpose of the wq_has_sleeper and sock_poll_wait is to wrap the memory
Jiri Olsaa57de0b2009-07-08 12:09:13 +00001880 * barrier call. They were added due to the race found within the tcp code.
1881 *
1882 * Consider following tcp code paths:
1883 *
1884 * CPU1 CPU2
1885 *
1886 * sys_select receive packet
1887 * ... ...
1888 * __add_wait_queue update tp->rcv_nxt
1889 * ... ...
1890 * tp->rcv_nxt check sock_def_readable
1891 * ... {
Eric Dumazet43815482010-04-29 11:01:49 +00001892 * schedule rcu_read_lock();
1893 * wq = rcu_dereference(sk->sk_wq);
1894 * if (wq && waitqueue_active(&wq->wait))
1895 * wake_up_interruptible(&wq->wait)
Jiri Olsaa57de0b2009-07-08 12:09:13 +00001896 * ...
1897 * }
1898 *
1899 * The race for tcp fires when the __add_wait_queue changes done by CPU1 stay
1900 * in its cache, and so does the tp->rcv_nxt update on CPU2 side. The CPU1
1901 * could then endup calling schedule and sleep forever if there are no more
1902 * data on the socket.
Jiri Olsaad462762009-07-08 12:10:31 +00001903 *
Jiri Olsaa57de0b2009-07-08 12:09:13 +00001904 */
Eric Dumazet43815482010-04-29 11:01:49 +00001905static inline bool wq_has_sleeper(struct socket_wq *wq)
Jiri Olsaa57de0b2009-07-08 12:09:13 +00001906{
Eric Dumazetdc6b9b72012-05-16 22:48:15 +00001907 /* We need to be sure we are in sync with the
Jiri Olsaa57de0b2009-07-08 12:09:13 +00001908 * add_wait_queue modifications to the wait queue.
1909 *
1910 * This memory barrier is paired in the sock_poll_wait.
1911 */
Eric Dumazet43815482010-04-29 11:01:49 +00001912 smp_mb();
1913 return wq && waitqueue_active(&wq->wait);
Jiri Olsaa57de0b2009-07-08 12:09:13 +00001914}
1915
1916/**
1917 * sock_poll_wait - place memory barrier behind the poll_wait call.
1918 * @filp: file
1919 * @wait_address: socket wait queue
1920 * @p: poll_table
1921 *
Eric Dumazet43815482010-04-29 11:01:49 +00001922 * See the comments in the wq_has_sleeper function.
Jiri Olsaa57de0b2009-07-08 12:09:13 +00001923 */
1924static inline void sock_poll_wait(struct file *filp,
1925 wait_queue_head_t *wait_address, poll_table *p)
1926{
Hans Verkuil626cf232012-03-23 15:02:27 -07001927 if (!poll_does_not_wait(p) && wait_address) {
Jiri Olsaa57de0b2009-07-08 12:09:13 +00001928 poll_wait(filp, wait_address, p);
Eric Dumazetdc6b9b72012-05-16 22:48:15 +00001929 /* We need to be sure we are in sync with the
Jiri Olsaa57de0b2009-07-08 12:09:13 +00001930 * socket flags modification.
1931 *
Eric Dumazet43815482010-04-29 11:01:49 +00001932 * This memory barrier is paired in the wq_has_sleeper.
Eric Dumazetdc6b9b72012-05-16 22:48:15 +00001933 */
Jiri Olsaa57de0b2009-07-08 12:09:13 +00001934 smp_mb();
1935 }
1936}
1937
Tom Herbertb73c3d02014-07-01 21:32:17 -07001938static inline void skb_set_hash_from_sk(struct sk_buff *skb, struct sock *sk)
1939{
1940 if (sk->sk_txhash) {
1941 skb->l4_hash = 1;
1942 skb->hash = sk->sk_txhash;
1943 }
1944}
1945
Linus Torvalds1da177e2005-04-16 15:20:36 -07001946/*
Eric Dumazetdc6b9b72012-05-16 22:48:15 +00001947 * Queue a received datagram if it will fit. Stream and sequenced
Linus Torvalds1da177e2005-04-16 15:20:36 -07001948 * protocols can't normally use this as they need to fit buffers in
1949 * and play with them.
1950 *
Eric Dumazetdc6b9b72012-05-16 22:48:15 +00001951 * Inlined as it's very short and called for pretty much every
Linus Torvalds1da177e2005-04-16 15:20:36 -07001952 * packet ever received.
1953 */
1954
1955static inline void skb_set_owner_w(struct sk_buff *skb, struct sock *sk)
1956{
Herbert Xud55d87f2009-06-22 02:25:25 +00001957 skb_orphan(skb);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001958 skb->sk = sk;
1959 skb->destructor = sock_wfree;
Tom Herbertb73c3d02014-07-01 21:32:17 -07001960 skb_set_hash_from_sk(skb, sk);
Eric Dumazet2b85a342009-06-11 02:55:43 -07001961 /*
1962 * We used to take a refcount on sk, but following operation
1963 * is enough to guarantee sk_free() wont free this sock until
1964 * all in-flight packets are completed
1965 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001966 atomic_add(skb->truesize, &sk->sk_wmem_alloc);
1967}
1968
1969static inline void skb_set_owner_r(struct sk_buff *skb, struct sock *sk)
1970{
Herbert Xud55d87f2009-06-22 02:25:25 +00001971 skb_orphan(skb);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001972 skb->sk = sk;
1973 skb->destructor = sock_rfree;
1974 atomic_add(skb->truesize, &sk->sk_rmem_alloc);
Hideo Aoki3ab224b2007-12-31 00:11:19 -08001975 sk_mem_charge(sk, skb->truesize);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001976}
1977
Joe Perches69336bd2013-09-22 10:32:26 -07001978void sk_reset_timer(struct sock *sk, struct timer_list *timer,
1979 unsigned long expires);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001980
Joe Perches69336bd2013-09-22 10:32:26 -07001981void sk_stop_timer(struct sock *sk, struct timer_list *timer);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001982
Joe Perches69336bd2013-09-22 10:32:26 -07001983int sock_queue_rcv_skb(struct sock *sk, struct sk_buff *skb);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001984
Joe Perches69336bd2013-09-22 10:32:26 -07001985int sock_queue_err_skb(struct sock *sk, struct sk_buff *skb);
Willem de Bruijn364a9e92014-08-31 21:30:27 -04001986struct sk_buff *sock_dequeue_err_skb(struct sock *sk);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001987
1988/*
1989 * Recover an error report and clear atomically
1990 */
Eric Dumazetdc6b9b72012-05-16 22:48:15 +00001991
Linus Torvalds1da177e2005-04-16 15:20:36 -07001992static inline int sock_error(struct sock *sk)
1993{
Benjamin LaHaisec1cbe4b2005-12-13 23:22:19 -08001994 int err;
1995 if (likely(!sk->sk_err))
1996 return 0;
1997 err = xchg(&sk->sk_err, 0);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001998 return -err;
1999}
2000
2001static inline unsigned long sock_wspace(struct sock *sk)
2002{
2003 int amt = 0;
2004
2005 if (!(sk->sk_shutdown & SEND_SHUTDOWN)) {
2006 amt = sk->sk_sndbuf - atomic_read(&sk->sk_wmem_alloc);
Eric Dumazetdc6b9b72012-05-16 22:48:15 +00002007 if (amt < 0)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002008 amt = 0;
2009 }
2010 return amt;
2011}
2012
2013static inline void sk_wake_async(struct sock *sk, int how, int band)
2014{
Eric Dumazetbcdce712009-10-06 17:28:29 -07002015 if (sock_flag(sk, SOCK_FASYNC))
Linus Torvalds1da177e2005-04-16 15:20:36 -07002016 sock_wake_async(sk->sk_socket, how, band);
2017}
2018
Daniel Borkmanneea86af2013-06-19 12:51:20 +02002019/* Since sk_{r,w}mem_alloc sums skb->truesize, even a small frame might
2020 * need sizeof(sk_buff) + MTU + padding, unless net driver perform copybreak.
2021 * Note: for send buffers, TCP works better if we can build two skbs at
2022 * minimum.
Eric Dumazet7a91b4342010-09-26 18:53:07 -07002023 */
Eric Dumazet9eb5bf82013-07-03 05:02:22 -07002024#define TCP_SKB_MIN_TRUESIZE (2048 + SKB_DATA_ALIGN(sizeof(struct sk_buff)))
Daniel Borkmanneea86af2013-06-19 12:51:20 +02002025
2026#define SOCK_MIN_SNDBUF (TCP_SKB_MIN_TRUESIZE * 2)
2027#define SOCK_MIN_RCVBUF TCP_SKB_MIN_TRUESIZE
Linus Torvalds1da177e2005-04-16 15:20:36 -07002028
2029static inline void sk_stream_moderate_sndbuf(struct sock *sk)
2030{
2031 if (!(sk->sk_userlocks & SOCK_SNDBUF_LOCK)) {
Eric Dumazet8df09ea2007-12-21 03:07:41 -08002032 sk->sk_sndbuf = min(sk->sk_sndbuf, sk->sk_wmem_queued >> 1);
Daniel Borkmanneea86af2013-06-19 12:51:20 +02002033 sk->sk_sndbuf = max_t(u32, sk->sk_sndbuf, SOCK_MIN_SNDBUF);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002034 }
2035}
2036
Eric Dumazeteb934472015-05-19 13:26:55 -07002037struct sk_buff *sk_stream_alloc_skb(struct sock *sk, int size, gfp_t gfp,
2038 bool force_schedule);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002039
Eric Dumazet5640f762012-09-23 23:04:42 +00002040/**
2041 * sk_page_frag - return an appropriate page_frag
2042 * @sk: socket
2043 *
2044 * If socket allocation mode allows current thread to sleep, it means its
2045 * safe to use the per task page_frag instead of the per socket one.
2046 */
2047static inline struct page_frag *sk_page_frag(struct sock *sk)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002048{
Eric Dumazet5640f762012-09-23 23:04:42 +00002049 if (sk->sk_allocation & __GFP_WAIT)
2050 return &current->task_frag;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002051
Eric Dumazet5640f762012-09-23 23:04:42 +00002052 return &sk->sk_frag;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002053}
2054
Joe Perches69336bd2013-09-22 10:32:26 -07002055bool sk_page_frag_refill(struct sock *sk, struct page_frag *pfrag);
Eric Dumazet5640f762012-09-23 23:04:42 +00002056
Linus Torvalds1da177e2005-04-16 15:20:36 -07002057/*
2058 * Default write policy as shown to user space via poll/select/SIGIO
2059 */
Eric Dumazetdc6b9b72012-05-16 22:48:15 +00002060static inline bool sock_writeable(const struct sock *sk)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002061{
Eric Dumazet8df09ea2007-12-21 03:07:41 -08002062 return atomic_read(&sk->sk_wmem_alloc) < (sk->sk_sndbuf >> 1);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002063}
2064
Al Virodd0fc662005-10-07 07:46:04 +01002065static inline gfp_t gfp_any(void)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002066{
Andrew Morton99709372009-02-12 16:43:17 -08002067 return in_softirq() ? GFP_ATOMIC : GFP_KERNEL;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002068}
2069
Eric Dumazetdc6b9b72012-05-16 22:48:15 +00002070static inline long sock_rcvtimeo(const struct sock *sk, bool noblock)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002071{
2072 return noblock ? 0 : sk->sk_rcvtimeo;
2073}
2074
Eric Dumazetdc6b9b72012-05-16 22:48:15 +00002075static inline long sock_sndtimeo(const struct sock *sk, bool noblock)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002076{
2077 return noblock ? 0 : sk->sk_sndtimeo;
2078}
2079
2080static inline int sock_rcvlowat(const struct sock *sk, int waitall, int len)
2081{
2082 return (waitall ? len : min_t(int, sk->sk_rcvlowat, len)) ? : 1;
2083}
2084
2085/* Alas, with timeout socket operations are not restartable.
2086 * Compare this to poll().
2087 */
2088static inline int sock_intr_errno(long timeo)
2089{
2090 return timeo == MAX_SCHEDULE_TIMEOUT ? -ERESTARTSYS : -EINTR;
2091}
2092
Eyal Birger744d5a32015-03-01 14:58:31 +02002093struct sock_skb_cb {
2094 u32 dropcount;
2095};
2096
2097/* Store sock_skb_cb at the end of skb->cb[] so protocol families
2098 * using skb->cb[] would keep using it directly and utilize its
2099 * alignement guarantee.
2100 */
2101#define SOCK_SKB_CB_OFFSET ((FIELD_SIZEOF(struct sk_buff, cb) - \
2102 sizeof(struct sock_skb_cb)))
2103
2104#define SOCK_SKB_CB(__skb) ((struct sock_skb_cb *)((__skb)->cb + \
2105 SOCK_SKB_CB_OFFSET))
2106
Eyal Birgerb4772ef2015-03-01 14:58:29 +02002107#define sock_skb_cb_check_size(size) \
Eyal Birger744d5a32015-03-01 14:58:31 +02002108 BUILD_BUG_ON((size) > SOCK_SKB_CB_OFFSET)
Eyal Birgerb4772ef2015-03-01 14:58:29 +02002109
Eyal Birger3bc3b962015-03-01 14:58:30 +02002110static inline void
2111sock_skb_set_dropcount(const struct sock *sk, struct sk_buff *skb)
2112{
Eyal Birger744d5a32015-03-01 14:58:31 +02002113 SOCK_SKB_CB(skb)->dropcount = atomic_read(&sk->sk_drops);
Eyal Birger3bc3b962015-03-01 14:58:30 +02002114}
2115
Joe Perches69336bd2013-09-22 10:32:26 -07002116void __sock_recv_timestamp(struct msghdr *msg, struct sock *sk,
2117 struct sk_buff *skb);
2118void __sock_recv_wifi_status(struct msghdr *msg, struct sock *sk,
2119 struct sk_buff *skb);
Eric Dumazet92f37fd2007-03-25 22:14:49 -07002120
Eric Dumazetdc6b9b72012-05-16 22:48:15 +00002121static inline void
Linus Torvalds1da177e2005-04-16 15:20:36 -07002122sock_recv_timestamp(struct msghdr *msg, struct sock *sk, struct sk_buff *skb)
2123{
Eric Dumazetb7aa0bf2007-04-19 16:16:32 -07002124 ktime_t kt = skb->tstamp;
Patrick Ohly20d49472009-02-12 05:03:38 +00002125 struct skb_shared_hwtstamps *hwtstamps = skb_hwtstamps(skb);
Patrick McHardya61bbcf2005-08-14 17:24:31 -07002126
Patrick Ohly20d49472009-02-12 05:03:38 +00002127 /*
2128 * generate control messages if
Willem de Bruijnb9f40e22014-08-04 22:11:46 -04002129 * - receive time stamping in software requested
Patrick Ohly20d49472009-02-12 05:03:38 +00002130 * - software time stamp available and wanted
Patrick Ohly20d49472009-02-12 05:03:38 +00002131 * - hardware time stamps available and wanted
Patrick Ohly20d49472009-02-12 05:03:38 +00002132 */
2133 if (sock_flag(sk, SOCK_RCVTSTAMP) ||
Willem de Bruijnb9f40e22014-08-04 22:11:46 -04002134 (sk->sk_tsflags & SOF_TIMESTAMPING_RX_SOFTWARE) ||
Willem de Bruijnc1991052014-09-03 12:01:18 -04002135 (kt.tv64 && sk->sk_tsflags & SOF_TIMESTAMPING_SOFTWARE) ||
Patrick Ohly20d49472009-02-12 05:03:38 +00002136 (hwtstamps->hwtstamp.tv64 &&
Willem de Bruijnb9f40e22014-08-04 22:11:46 -04002137 (sk->sk_tsflags & SOF_TIMESTAMPING_RAW_HARDWARE)))
Eric Dumazet92f37fd2007-03-25 22:14:49 -07002138 __sock_recv_timestamp(msg, sk, skb);
2139 else
Eric Dumazetb7aa0bf2007-04-19 16:16:32 -07002140 sk->sk_stamp = kt;
Johannes Berg6e3e9392011-11-09 10:15:42 +01002141
2142 if (sock_flag(sk, SOCK_WIFI_STATUS) && skb->wifi_acked_valid)
2143 __sock_recv_wifi_status(msg, sk, skb);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002144}
2145
Joe Perches69336bd2013-09-22 10:32:26 -07002146void __sock_recv_ts_and_drops(struct msghdr *msg, struct sock *sk,
2147 struct sk_buff *skb);
Eric Dumazet767dd032010-04-28 19:14:43 +00002148
2149static inline void sock_recv_ts_and_drops(struct msghdr *msg, struct sock *sk,
2150 struct sk_buff *skb)
2151{
2152#define FLAGS_TS_OR_DROPS ((1UL << SOCK_RXQ_OVFL) | \
Willem de Bruijnb9f40e22014-08-04 22:11:46 -04002153 (1UL << SOCK_RCVTSTAMP))
2154#define TSFLAGS_ANY (SOF_TIMESTAMPING_SOFTWARE | \
2155 SOF_TIMESTAMPING_RAW_HARDWARE)
Eric Dumazet767dd032010-04-28 19:14:43 +00002156
Willem de Bruijnb9f40e22014-08-04 22:11:46 -04002157 if (sk->sk_flags & FLAGS_TS_OR_DROPS || sk->sk_tsflags & TSFLAGS_ANY)
Eric Dumazet767dd032010-04-28 19:14:43 +00002158 __sock_recv_ts_and_drops(msg, sk, skb);
2159 else
2160 sk->sk_stamp = skb->tstamp;
2161}
Neil Horman3b885782009-10-12 13:26:31 -07002162
Willem de Bruijn67cc0d42014-09-08 19:58:58 -04002163void __sock_tx_timestamp(const struct sock *sk, __u8 *tx_flags);
2164
Linus Torvalds1da177e2005-04-16 15:20:36 -07002165/**
Patrick Ohly20d49472009-02-12 05:03:38 +00002166 * sock_tx_timestamp - checks whether the outgoing packet is to be time stamped
Patrick Ohly20d49472009-02-12 05:03:38 +00002167 * @sk: socket sending this packet
Eric Dumazet140c55d2014-08-06 11:49:29 +02002168 * @tx_flags: completed with instructions for time stamping
2169 *
2170 * Note : callers should take care of initial *tx_flags value (usually 0)
Patrick Ohly20d49472009-02-12 05:03:38 +00002171 */
Willem de Bruijn67cc0d42014-09-08 19:58:58 -04002172static inline void sock_tx_timestamp(const struct sock *sk, __u8 *tx_flags)
2173{
2174 if (unlikely(sk->sk_tsflags))
2175 __sock_tx_timestamp(sk, tx_flags);
2176 if (unlikely(sock_flag(sk, SOCK_WIFI_STATUS)))
2177 *tx_flags |= SKBTX_WIFI_STATUS;
2178}
Patrick Ohly20d49472009-02-12 05:03:38 +00002179
2180/**
Linus Torvalds1da177e2005-04-16 15:20:36 -07002181 * sk_eat_skb - Release a skb if it is no longer needed
Pavel Pisa4dc3b162005-05-01 08:59:25 -07002182 * @sk: socket to eat this skb from
2183 * @skb: socket buffer to eat
Linus Torvalds1da177e2005-04-16 15:20:36 -07002184 *
2185 * This routine must be called with interrupts disabled or with the socket
2186 * locked so that the sk_buff queue operation is ok.
2187*/
Dan Williams7bced392013-12-30 12:37:29 -08002188static inline void sk_eat_skb(struct sock *sk, struct sk_buff *skb)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002189{
2190 __skb_unlink(skb, &sk->sk_receive_queue);
2191 __kfree_skb(skb);
2192}
2193
YOSHIFUJI Hideaki3b1e0a62008-03-26 02:26:21 +09002194static inline
2195struct net *sock_net(const struct sock *sk)
2196{
Eric Dumazetc2d9ba92010-06-01 06:51:19 +00002197 return read_pnet(&sk->sk_net);
YOSHIFUJI Hideaki3b1e0a62008-03-26 02:26:21 +09002198}
2199
2200static inline
Denis V. Lunevf5aa23f2008-03-26 00:48:17 -07002201void sock_net_set(struct sock *sk, struct net *net)
YOSHIFUJI Hideaki3b1e0a62008-03-26 02:26:21 +09002202{
Eric Dumazetc2d9ba92010-06-01 06:51:19 +00002203 write_pnet(&sk->sk_net, net);
YOSHIFUJI Hideaki3b1e0a62008-03-26 02:26:21 +09002204}
2205
KOVACS Krisztian23542612008-10-07 12:41:01 -07002206static inline struct sock *skb_steal_sock(struct sk_buff *skb)
2207{
Vijay Subramanianefc27f82012-06-24 13:03:07 +00002208 if (skb->sk) {
KOVACS Krisztian23542612008-10-07 12:41:01 -07002209 struct sock *sk = skb->sk;
2210
2211 skb->destructor = NULL;
2212 skb->sk = NULL;
2213 return sk;
2214 }
2215 return NULL;
2216}
2217
Eric Dumazet1d0ab252015-03-15 21:12:12 -07002218/* This helper checks if a socket is a full socket,
2219 * ie _not_ a timewait or request socket.
2220 */
2221static inline bool sk_fullsock(const struct sock *sk)
2222{
2223 return (1 << sk->sk_state) & ~(TCPF_TIME_WAIT | TCPF_NEW_SYN_RECV);
2224}
2225
Eric Dumazete446f9d2015-10-08 05:01:55 -07002226/* This helper checks if a socket is a LISTEN or NEW_SYN_RECV
2227 * SYNACK messages can be attached to either ones (depending on SYNCOOKIE)
2228 */
2229static inline bool sk_listener(const struct sock *sk)
2230{
2231 return (1 << sk->sk_state) & (TCPF_LISTEN | TCPF_NEW_SYN_RECV);
2232}
2233
Joe Perches69336bd2013-09-22 10:32:26 -07002234void sock_enable_timestamp(struct sock *sk, int flag);
2235int sock_get_timestamp(struct sock *, struct timeval __user *);
2236int sock_get_timestampns(struct sock *, struct timespec __user *);
2237int sock_recv_errqueue(struct sock *sk, struct msghdr *msg, int len, int level,
2238 int type);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002239
Eric W. Biedermana3b299d2014-04-23 14:26:56 -07002240bool sk_ns_capable(const struct sock *sk,
2241 struct user_namespace *user_ns, int cap);
2242bool sk_capable(const struct sock *sk, int cap);
2243bool sk_net_capable(const struct sock *sk, int cap);
2244
Linus Torvalds1da177e2005-04-16 15:20:36 -07002245extern __u32 sysctl_wmem_max;
2246extern __u32 sysctl_rmem_max;
2247
Willem de Bruijnb245be12015-01-30 13:29:32 -05002248extern int sysctl_tstamp_allow_data;
David S. Miller6baf1f42005-09-05 18:14:11 -07002249extern int sysctl_optmem_max;
2250
Arnaldo Carvalho de Melo20380732005-08-16 02:18:02 -03002251extern __u32 sysctl_wmem_default;
2252extern __u32 sysctl_rmem_default;
Arnaldo Carvalho de Melo20380732005-08-16 02:18:02 -03002253
Linus Torvalds1da177e2005-04-16 15:20:36 -07002254#endif /* _SOCK_H */