blob: 7c0632c7e87043ca18fe5d32d7d55792f75ca6e8 [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>
Herbert Xu1ce0bf52015-11-26 13:55:39 +080061#include <linux/wait.h>
Tejun Heo2a56a1f2015-12-07 17:38:52 -050062#include <linux/cgroup-defs.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070063
64#include <linux/filter.h>
Eric Dumazet88ab1932008-11-16 19:39:21 -080065#include <linux/rculist_nulls.h>
Jiri Olsaa57de0b2009-07-08 12:09:13 +000066#include <linux/poll.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070067
Eric Dumazetc31504d2010-11-15 19:58:26 +000068#include <linux/atomic.h>
Reshetova, Elena41c6d652017-06-30 13:08:01 +030069#include <linux/refcount.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070070#include <net/dst.h>
71#include <net/checksum.h>
Eric Dumazet1d0ab252015-03-15 21:12:12 -070072#include <net/tcp_states.h>
Willem de Bruijnb9f40e22014-08-04 22:11:46 -040073#include <linux/net_tstamp.h>
Ursula Braunf16a7dd2017-01-09 16:55:26 +010074#include <net/smc.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070075
76/*
77 * This structure really needs to be cleaned up.
78 * Most of it is for TCP, and not used by any of
79 * the other protocols.
80 */
81
82/* Define this to get the SOCK_DBG debugging facility. */
83#define SOCK_DEBUGGING
84#ifdef SOCK_DEBUGGING
85#define SOCK_DEBUG(sk, msg...) do { if ((sk) && sock_flag((sk), SOCK_DBG)) \
86 printk(KERN_DEBUG msg); } while (0)
87#else
Stephen Hemminger4cd90292008-03-21 15:54:53 -070088/* Validate arguments and do nothing */
Joe Perchesb9075fa2011-10-31 17:11:33 -070089static inline __printf(2, 3)
Eric Dumazetdc6b9b72012-05-16 22:48:15 +000090void SOCK_DEBUG(const struct sock *sk, const char *msg, ...)
Stephen Hemminger4cd90292008-03-21 15:54:53 -070091{
92}
Linus Torvalds1da177e2005-04-16 15:20:36 -070093#endif
94
95/* This is the per-socket lock. The spinlock provides a synchronization
96 * between user contexts and software interrupt processing, whereas the
97 * mini-semaphore synchronizes multiple users amongst themselves.
98 */
Linus Torvalds1da177e2005-04-16 15:20:36 -070099typedef struct {
100 spinlock_t slock;
John Heffnerd2e91172007-09-12 10:44:19 +0200101 int owned;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700102 wait_queue_head_t wq;
Ingo Molnara5b5bb92006-07-03 00:25:35 -0700103 /*
104 * We express the mutex-alike socket_lock semantics
105 * to the lock validator by explicitly managing
106 * the slock as a lock variant (in addition to
107 * the slock itself):
108 */
109#ifdef CONFIG_DEBUG_LOCK_ALLOC
110 struct lockdep_map dep_map;
111#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -0700112} socket_lock_t;
113
Linus Torvalds1da177e2005-04-16 15:20:36 -0700114struct sock;
Arnaldo Carvalho de Melo8feaf0c02005-08-09 20:09:30 -0700115struct proto;
Denis V. Lunev0eeb8ff2007-12-04 01:15:45 -0800116struct net;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700117
Eric Dumazet077b3932012-12-02 07:33:10 +0000118typedef __u32 __bitwise __portpair;
119typedef __u64 __bitwise __addrpair;
120
Linus Torvalds1da177e2005-04-16 15:20:36 -0700121/**
Pavel Pisa4dc3b162005-05-01 08:59:25 -0700122 * struct sock_common - minimal network layer representation of sockets
Eric Dumazet68835ab2010-11-30 19:04:07 +0000123 * @skc_daddr: Foreign IPv4 addr
124 * @skc_rcv_saddr: Bound local IPv4 addr
Eric Dumazet4dc6dc72009-07-15 23:13:10 +0000125 * @skc_hash: hash value used with various protocol lookup tables
Eric Dumazetd4cada42009-11-08 10:17:30 +0000126 * @skc_u16hashes: two u16 hash values used by UDP lookup tables
Eric Dumazetce43b032012-11-30 09:49:27 +0000127 * @skc_dport: placeholder for inet_dport/tw_dport
128 * @skc_num: placeholder for inet_num/tw_num
Pavel Pisa4dc3b162005-05-01 08:59:25 -0700129 * @skc_family: network address family
130 * @skc_state: Connection state
131 * @skc_reuse: %SO_REUSEADDR setting
Tom Herbert055dc212013-01-22 09:49:50 +0000132 * @skc_reuseport: %SO_REUSEPORT setting
Pavel Pisa4dc3b162005-05-01 08:59:25 -0700133 * @skc_bound_dev_if: bound device index if != 0
Pavel Pisa4dc3b162005-05-01 08:59:25 -0700134 * @skc_bind_node: bind hash linkage for various protocol lookup tables
Eric Dumazet512615b2009-11-08 10:17:58 +0000135 * @skc_portaddr_node: second hash linkage for UDP/UDP-Lite protocol
Arnaldo Carvalho de Melo8feaf0c02005-08-09 20:09:30 -0700136 * @skc_prot: protocol handlers inside a network family
Eric W. Biederman07feaeb2007-09-12 11:58:02 +0200137 * @skc_net: reference to the network namespace of this socket
Eric Dumazet68835ab2010-11-30 19:04:07 +0000138 * @skc_node: main hash linkage for various protocol lookup tables
139 * @skc_nulls_node: main hash linkage for TCP/UDP/UDP-Lite protocol
140 * @skc_tx_queue_mapping: tx queue number for this connection
Eric Dumazet8e5eb542015-10-08 19:33:22 -0700141 * @skc_flags: place holder for sk_flags
142 * %SO_LINGER (l_onoff), %SO_BROADCAST, %SO_KEEPALIVE,
143 * %SO_OOBINLINE settings, %SO_TIMESTAMPING settings
Eric Dumazet70da2682015-10-08 19:33:21 -0700144 * @skc_incoming_cpu: record/match cpu processing incoming packets
Eric Dumazet68835ab2010-11-30 19:04:07 +0000145 * @skc_refcnt: reference count
Pavel Pisa4dc3b162005-05-01 08:59:25 -0700146 *
147 * This is the minimal network layer representation of sockets, the header
Arnaldo Carvalho de Melo8feaf0c02005-08-09 20:09:30 -0700148 * for struct sock and struct inet_timewait_sock.
149 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700150struct sock_common {
Eric Dumazetce43b032012-11-30 09:49:27 +0000151 /* skc_daddr and skc_rcv_saddr must be grouped on a 8 bytes aligned
Eric Dumazet05dbc7b2013-10-03 00:22:02 -0700152 * address on 64bit arches : cf INET_MATCH()
Eric Dumazet4dc6dc72009-07-15 23:13:10 +0000153 */
Eric Dumazetce43b032012-11-30 09:49:27 +0000154 union {
Eric Dumazet077b3932012-12-02 07:33:10 +0000155 __addrpair skc_addrpair;
Eric Dumazetce43b032012-11-30 09:49:27 +0000156 struct {
157 __be32 skc_daddr;
158 __be32 skc_rcv_saddr;
159 };
160 };
Eric Dumazetd4cada42009-11-08 10:17:30 +0000161 union {
162 unsigned int skc_hash;
163 __u16 skc_u16hashes[2];
164 };
Eric Dumazetce43b032012-11-30 09:49:27 +0000165 /* skc_dport && skc_num must be grouped as well */
166 union {
Eric Dumazet077b3932012-12-02 07:33:10 +0000167 __portpair skc_portpair;
Eric Dumazetce43b032012-11-30 09:49:27 +0000168 struct {
169 __be16 skc_dport;
170 __u16 skc_num;
171 };
172 };
173
Eric Dumazet4dc6dc72009-07-15 23:13:10 +0000174 unsigned short skc_family;
175 volatile unsigned char skc_state;
Tom Herbert055dc212013-01-22 09:49:50 +0000176 unsigned char skc_reuse:4;
Eric Dumazet9fe516b2014-06-27 08:36:16 -0700177 unsigned char skc_reuseport:1;
178 unsigned char skc_ipv6only:1;
Eric W. Biederman26abe142015-05-08 21:10:31 -0500179 unsigned char skc_net_refcnt:1;
Eric Dumazet4dc6dc72009-07-15 23:13:10 +0000180 int skc_bound_dev_if;
Eric Dumazet512615b2009-11-08 10:17:58 +0000181 union {
182 struct hlist_node skc_bind_node;
Eric Dumazetca065d02016-04-01 08:52:13 -0700183 struct hlist_node skc_portaddr_node;
Eric Dumazet512615b2009-11-08 10:17:58 +0000184 };
Arnaldo Carvalho de Melo8feaf0c02005-08-09 20:09:30 -0700185 struct proto *skc_prot;
Eric W. Biederman0c5c9fb2015-03-11 23:06:44 -0500186 possible_net_t skc_net;
Eric Dumazetefe42082013-10-03 15:42:29 -0700187
188#if IS_ENABLED(CONFIG_IPV6)
189 struct in6_addr skc_v6_daddr;
190 struct in6_addr skc_v6_rcv_saddr;
191#endif
192
Eric Dumazet33cf7c92015-03-11 18:53:14 -0700193 atomic64_t skc_cookie;
194
Eric Dumazet8e5eb542015-10-08 19:33:22 -0700195 /* following fields are padding to force
196 * offset(struct sock, sk_refcnt) == 128 on 64bit arches
197 * assuming IPV6 is enabled. We use this padding differently
198 * for different kind of 'sockets'
199 */
200 union {
201 unsigned long skc_flags;
202 struct sock *skc_listener; /* request_sock */
203 struct inet_timewait_death_row *skc_tw_dr; /* inet_timewait_sock */
204 };
Eric Dumazet68835ab2010-11-30 19:04:07 +0000205 /*
206 * fields between dontcopy_begin/dontcopy_end
207 * are not copied in sock_copy()
208 */
Randy Dunlap928c41e2011-01-08 17:39:21 +0000209 /* private: */
Eric Dumazet68835ab2010-11-30 19:04:07 +0000210 int skc_dontcopy_begin[0];
Randy Dunlap928c41e2011-01-08 17:39:21 +0000211 /* public: */
Eric Dumazet68835ab2010-11-30 19:04:07 +0000212 union {
213 struct hlist_node skc_node;
214 struct hlist_nulls_node skc_nulls_node;
215 };
216 int skc_tx_queue_mapping;
Eric Dumazeted53d0a2015-10-08 19:33:23 -0700217 union {
218 int skc_incoming_cpu;
219 u32 skc_rcv_wnd;
Eric Dumazetd475f092015-10-08 19:33:24 -0700220 u32 skc_tw_rcv_nxt; /* struct tcp_timewait_sock */
Eric Dumazeted53d0a2015-10-08 19:33:23 -0700221 };
Eric Dumazet70da2682015-10-08 19:33:21 -0700222
Reshetova, Elena41c6d652017-06-30 13:08:01 +0300223 refcount_t skc_refcnt;
Randy Dunlap928c41e2011-01-08 17:39:21 +0000224 /* private: */
Eric Dumazet68835ab2010-11-30 19:04:07 +0000225 int skc_dontcopy_end[0];
Eric Dumazeted53d0a2015-10-08 19:33:23 -0700226 union {
227 u32 skc_rxhash;
228 u32 skc_window_clamp;
Eric Dumazetd475f092015-10-08 19:33:24 -0700229 u32 skc_tw_snd_nxt; /* struct tcp_timewait_sock */
Eric Dumazeted53d0a2015-10-08 19:33:23 -0700230 };
Randy Dunlap928c41e2011-01-08 17:39:21 +0000231 /* public: */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700232};
233
234/**
235 * struct sock - network layer representation of sockets
Arnaldo Carvalho de Melo8feaf0c02005-08-09 20:09:30 -0700236 * @__sk_common: shared layout with inet_timewait_sock
Pavel Pisa4dc3b162005-05-01 08:59:25 -0700237 * @sk_shutdown: mask of %SEND_SHUTDOWN and/or %RCV_SHUTDOWN
238 * @sk_userlocks: %SO_SNDBUF and %SO_RCVBUF settings
239 * @sk_lock: synchronizer
David Howellscdfbabf2017-03-09 08:09:05 +0000240 * @sk_kern_sock: True if sock is using kernel lock classes
Pavel Pisa4dc3b162005-05-01 08:59:25 -0700241 * @sk_rcvbuf: size of receive buffer in bytes
Eric Dumazet43815482010-04-29 11:01:49 +0000242 * @sk_wq: sock wait queue and async head
Shawn Bohrer421b3882013-10-07 11:01:39 -0500243 * @sk_rx_dst: receive input route used by early demux
Pavel Pisa4dc3b162005-05-01 08:59:25 -0700244 * @sk_dst_cache: destination cache
Julian Anastasov9b8805a2017-02-06 23:14:11 +0200245 * @sk_dst_pending_confirm: need to confirm neighbour
Pavel Pisa4dc3b162005-05-01 08:59:25 -0700246 * @sk_policy: flow policy
Pavel Pisa4dc3b162005-05-01 08:59:25 -0700247 * @sk_receive_queue: incoming packets
248 * @sk_wmem_alloc: transmit queue bytes committed
stephen hemminger771edca2017-07-12 09:29:06 -0700249 * @sk_tsq_flags: TCP Small Queues flags
Pavel Pisa4dc3b162005-05-01 08:59:25 -0700250 * @sk_write_queue: Packet sending queue
251 * @sk_omem_alloc: "o" is "option" or "other"
252 * @sk_wmem_queued: persistent queue size
253 * @sk_forward_alloc: space allocated forward
Eliezer Tamir06021292013-06-10 11:39:50 +0300254 * @sk_napi_id: id of the last napi context to receive data for sk
Eliezer Tamirdafcc432013-06-14 16:33:57 +0300255 * @sk_ll_usec: usecs to busypoll when there is no data
Pavel Pisa4dc3b162005-05-01 08:59:25 -0700256 * @sk_allocation: allocation mode
Eric Dumazet95bd09e2013-08-27 05:46:32 -0700257 * @sk_pacing_rate: Pacing rate (if supported by transport/packet scheduler)
Eric Dumazet218af592017-05-16 04:24:36 -0700258 * @sk_pacing_status: Pacing status (requested, handled by sch_fq)
Eric Dumazetc3f40d72013-09-29 01:12:40 -0700259 * @sk_max_pacing_rate: Maximum pacing rate (%SO_MAX_PACING_RATE)
Pavel Pisa4dc3b162005-05-01 08:59:25 -0700260 * @sk_sndbuf: size of send buffer in bytes
stephen hemminger771edca2017-07-12 09:29:06 -0700261 * @__sk_flags_offset: empty field used to determine location of bitfield
Stephen Hemminger293de7d2016-10-23 09:28:29 -0700262 * @sk_padding: unused element for alignment
Tom Herbert28448b82014-05-23 08:47:19 -0700263 * @sk_no_check_tx: %SO_NO_CHECK setting, set checksum in TX packets
264 * @sk_no_check_rx: allow zero checksum in RX packets
Pavel Pisa4dc3b162005-05-01 08:59:25 -0700265 * @sk_route_caps: route capabilities (e.g. %NETIF_F_TSO)
Eric Dumazeta4654192010-05-16 00:36:33 -0700266 * @sk_route_nocaps: forbidden route capabilities (e.g NETIF_F_GSO_MASK)
Herbert Xubcd76112006-06-30 13:36:35 -0700267 * @sk_gso_type: GSO type (e.g. %SKB_GSO_TCPV4)
Peter P Waskiewicz Jr82cc1a72008-03-21 03:43:19 -0700268 * @sk_gso_max_size: Maximum GSO segment size to build
Ben Hutchings14853482012-07-30 16:11:42 +0000269 * @sk_gso_max_segs: Maximum number of GSO segments
Pavel Pisa4dc3b162005-05-01 08:59:25 -0700270 * @sk_lingertime: %SO_LINGER l_linger setting
Pavel Pisa4dc3b162005-05-01 08:59:25 -0700271 * @sk_backlog: always used with the per-socket spinlock held
272 * @sk_callback_lock: used with the callbacks in the end of this struct
273 * @sk_error_queue: rarely used
Wang Chen33c732c2007-11-13 20:30:01 -0800274 * @sk_prot_creator: sk_prot of original sock creator (see ipv6_setsockopt,
275 * IPV6_ADDRFORM for instance)
Pavel Pisa4dc3b162005-05-01 08:59:25 -0700276 * @sk_err: last error
Wang Chen33c732c2007-11-13 20:30:01 -0800277 * @sk_err_soft: errors that don't cause failure but are the cause of a
278 * persistent failure not just 'timed out'
Eric Dumazetcb61cb92008-06-17 21:04:56 -0700279 * @sk_drops: raw/udp drops counter
Pavel Pisa4dc3b162005-05-01 08:59:25 -0700280 * @sk_ack_backlog: current listen backlog
281 * @sk_max_ack_backlog: listen backlog set in listen()
stephen hemminger771edca2017-07-12 09:29:06 -0700282 * @sk_uid: user id of owner
Pavel Pisa4dc3b162005-05-01 08:59:25 -0700283 * @sk_priority: %SO_PRIORITY setting
284 * @sk_type: socket type (%SOCK_STREAM, etc)
285 * @sk_protocol: which protocol this socket belongs in this network family
Randy Dunlap53c3fa22010-08-09 13:41:07 +0000286 * @sk_peer_pid: &struct pid for this socket's peer
287 * @sk_peer_cred: %SO_PEERCRED setting
Pavel Pisa4dc3b162005-05-01 08:59:25 -0700288 * @sk_rcvlowat: %SO_RCVLOWAT setting
289 * @sk_rcvtimeo: %SO_RCVTIMEO setting
290 * @sk_sndtimeo: %SO_SNDTIMEO setting
Tom Herbertb73c3d02014-07-01 21:32:17 -0700291 * @sk_txhash: computed flow hash for use on transmit
Pavel Pisa4dc3b162005-05-01 08:59:25 -0700292 * @sk_filter: socket filtering instructions
Pavel Pisa4dc3b162005-05-01 08:59:25 -0700293 * @sk_timer: sock cleanup timer
294 * @sk_stamp: time stamp of last packet received
Willem de Bruijnb9f40e22014-08-04 22:11:46 -0400295 * @sk_tsflags: SO_TIMESTAMPING socket options
Willem de Bruijn09c2d252014-08-04 22:11:47 -0400296 * @sk_tskey: counter to disambiguate concurrent tstamp requests
Pavel Pisa4dc3b162005-05-01 08:59:25 -0700297 * @sk_socket: Identd and reporting IO signals
298 * @sk_user_data: RPC layer private data
Eric Dumazet5640f762012-09-23 23:04:42 +0000299 * @sk_frag: cached page frag
Randy Dunlapd3d4f0a2012-04-17 14:03:53 +0000300 * @sk_peek_off: current peek_offset value
Pavel Pisa4dc3b162005-05-01 08:59:25 -0700301 * @sk_send_head: front of stuff to transmit
Martin Waitz67be2dd2005-05-01 08:59:26 -0700302 * @sk_security: used by security modules
Randy Dunlap31729362008-02-18 20:52:13 -0800303 * @sk_mark: generic packet mark
Tejun Heo2a56a1f2015-12-07 17:38:52 -0500304 * @sk_cgrp_data: cgroup data for this cgroup
Johannes Weinerbaac50b2016-01-14 15:21:17 -0800305 * @sk_memcg: this socket's memory cgroup association
Pavel Pisa4dc3b162005-05-01 08:59:25 -0700306 * @sk_write_pending: a write to stream socket waits to start
307 * @sk_state_change: callback to indicate change in the state of the sock
308 * @sk_data_ready: callback to indicate there is data to be processed
309 * @sk_write_space: callback to indicate there is bf sending space available
310 * @sk_error_report: callback to indicate errors (e.g. %MSG_ERRQUEUE)
311 * @sk_backlog_rcv: callback to process the backlog
312 * @sk_destruct: called at sock freeing time, i.e. when all refcnt == 0
Craig Gallekef456142016-01-04 17:41:45 -0500313 * @sk_reuseport_cb: reuseport group container
Stephen Hemminger293de7d2016-10-23 09:28:29 -0700314 * @sk_rcu: used during RCU grace period
315 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700316struct sock {
317 /*
Arnaldo Carvalho de Melo8feaf0c02005-08-09 20:09:30 -0700318 * Now struct inet_timewait_sock also uses sock_common, so please just
Linus Torvalds1da177e2005-04-16 15:20:36 -0700319 * don't add nothing before this first member (__sk_common) --acme
320 */
321 struct sock_common __sk_common;
Eric Dumazet4dc6dc72009-07-15 23:13:10 +0000322#define sk_node __sk_common.skc_node
323#define sk_nulls_node __sk_common.skc_nulls_node
324#define sk_refcnt __sk_common.skc_refcnt
Krishna Kumare022f0b2009-10-19 23:46:20 +0000325#define sk_tx_queue_mapping __sk_common.skc_tx_queue_mapping
Eric Dumazet4dc6dc72009-07-15 23:13:10 +0000326
Eric Dumazet68835ab2010-11-30 19:04:07 +0000327#define sk_dontcopy_begin __sk_common.skc_dontcopy_begin
328#define sk_dontcopy_end __sk_common.skc_dontcopy_end
Eric Dumazet4dc6dc72009-07-15 23:13:10 +0000329#define sk_hash __sk_common.skc_hash
Eric Dumazet50805462013-10-02 04:29:50 -0700330#define sk_portpair __sk_common.skc_portpair
Eric Dumazet05dbc7b2013-10-03 00:22:02 -0700331#define sk_num __sk_common.skc_num
332#define sk_dport __sk_common.skc_dport
Eric Dumazet50805462013-10-02 04:29:50 -0700333#define sk_addrpair __sk_common.skc_addrpair
334#define sk_daddr __sk_common.skc_daddr
335#define sk_rcv_saddr __sk_common.skc_rcv_saddr
Linus Torvalds1da177e2005-04-16 15:20:36 -0700336#define sk_family __sk_common.skc_family
337#define sk_state __sk_common.skc_state
338#define sk_reuse __sk_common.skc_reuse
Tom Herbert055dc212013-01-22 09:49:50 +0000339#define sk_reuseport __sk_common.skc_reuseport
Eric Dumazet9fe516b2014-06-27 08:36:16 -0700340#define sk_ipv6only __sk_common.skc_ipv6only
Eric W. Biederman26abe142015-05-08 21:10:31 -0500341#define sk_net_refcnt __sk_common.skc_net_refcnt
Linus Torvalds1da177e2005-04-16 15:20:36 -0700342#define sk_bound_dev_if __sk_common.skc_bound_dev_if
Linus Torvalds1da177e2005-04-16 15:20:36 -0700343#define sk_bind_node __sk_common.skc_bind_node
Arnaldo Carvalho de Melo8feaf0c02005-08-09 20:09:30 -0700344#define sk_prot __sk_common.skc_prot
Eric W. Biederman07feaeb2007-09-12 11:58:02 +0200345#define sk_net __sk_common.skc_net
Eric Dumazetefe42082013-10-03 15:42:29 -0700346#define sk_v6_daddr __sk_common.skc_v6_daddr
347#define sk_v6_rcv_saddr __sk_common.skc_v6_rcv_saddr
Eric Dumazet33cf7c92015-03-11 18:53:14 -0700348#define sk_cookie __sk_common.skc_cookie
Eric Dumazet70da2682015-10-08 19:33:21 -0700349#define sk_incoming_cpu __sk_common.skc_incoming_cpu
Eric Dumazet8e5eb542015-10-08 19:33:22 -0700350#define sk_flags __sk_common.skc_flags
Eric Dumazeted53d0a2015-10-08 19:33:23 -0700351#define sk_rxhash __sk_common.skc_rxhash
Eric Dumazetefe42082013-10-03 15:42:29 -0700352
Eric Dumazetb178bb32010-11-16 05:56:04 +0000353 socket_lock_t sk_lock;
Eric Dumazet9115e8c2016-12-03 11:14:56 -0800354 atomic_t sk_drops;
355 int sk_rcvlowat;
356 struct sk_buff_head sk_error_queue;
Eric Dumazetb178bb32010-11-16 05:56:04 +0000357 struct sk_buff_head sk_receive_queue;
358 /*
359 * The backlog queue is special, it is always used with
360 * the per-socket spinlock held and requires low latency
361 * access. Therefore we special case it's implementation.
362 * Note : rmem_alloc is in this structure to fill a hole
363 * on 64bit arches, not because its logically part of
364 * backlog.
365 */
366 struct {
367 atomic_t rmem_alloc;
368 int len;
369 struct sk_buff *head;
370 struct sk_buff *tail;
371 } sk_backlog;
372#define sk_rmem_alloc sk_backlog.rmem_alloc
Eric Dumazet2c8c56e2014-11-11 05:54:28 -0800373
Eric Dumazet9115e8c2016-12-03 11:14:56 -0800374 int sk_forward_alloc;
Cong Wange0d10952013-08-01 11:10:25 +0800375#ifdef CONFIG_NET_RX_BUSY_POLL
Eliezer Tamirdafcc432013-06-14 16:33:57 +0300376 unsigned int sk_ll_usec;
Eric Dumazet9115e8c2016-12-03 11:14:56 -0800377 /* ===== mostly read cache line ===== */
378 unsigned int sk_napi_id;
Eliezer Tamir06021292013-06-10 11:39:50 +0300379#endif
Eric Dumazetb178bb32010-11-16 05:56:04 +0000380 int sk_rcvbuf;
381
382 struct sk_filter __rcu *sk_filter;
Eric Dumazetceb5d582015-11-29 20:03:11 -0800383 union {
384 struct socket_wq __rcu *sk_wq;
385 struct socket_wq *sk_wq_raw;
386 };
Eric Dumazetb178bb32010-11-16 05:56:04 +0000387#ifdef CONFIG_XFRM
Eric Dumazetd188ba82015-12-08 07:22:02 -0800388 struct xfrm_policy __rcu *sk_policy[2];
Eric Dumazetb178bb32010-11-16 05:56:04 +0000389#endif
Eric Dumazetdeaa5852012-06-24 20:22:49 +0000390 struct dst_entry *sk_rx_dst;
Cong Wang0e36cbb2013-01-22 21:09:51 +0000391 struct dst_entry __rcu *sk_dst_cache;
Eric Dumazetb178bb32010-11-16 05:56:04 +0000392 atomic_t sk_omem_alloc;
393 int sk_sndbuf;
Eric Dumazet9115e8c2016-12-03 11:14:56 -0800394
395 /* ===== cache line for TX ===== */
396 int sk_wmem_queued;
Reshetova, Elena14afee42017-06-30 13:08:00 +0300397 refcount_t sk_wmem_alloc;
Eric Dumazet9115e8c2016-12-03 11:14:56 -0800398 unsigned long sk_tsq_flags;
399 struct sk_buff *sk_send_head;
Eric Dumazetb178bb32010-11-16 05:56:04 +0000400 struct sk_buff_head sk_write_queue;
Eric Dumazet9115e8c2016-12-03 11:14:56 -0800401 __s32 sk_peek_off;
402 int sk_write_pending;
Julian Anastasov9b8805a2017-02-06 23:14:11 +0200403 __u32 sk_dst_pending_confirm;
Eric Dumazet218af592017-05-16 04:24:36 -0700404 u32 sk_pacing_status; /* see enum sk_pacing */
Eric Dumazet9115e8c2016-12-03 11:14:56 -0800405 long sk_sndtimeo;
406 struct timer_list sk_timer;
407 __u32 sk_priority;
408 __u32 sk_mark;
409 u32 sk_pacing_rate; /* bytes per second */
410 u32 sk_max_pacing_rate;
411 struct page_frag sk_frag;
412 netdev_features_t sk_route_caps;
413 netdev_features_t sk_route_nocaps;
414 int sk_gso_type;
415 unsigned int sk_gso_max_size;
416 gfp_t sk_allocation;
417 __u32 sk_txhash;
Andrey Ryabininfc648692016-05-18 19:19:27 +0300418
419 /*
420 * Because of non atomicity rules, all
421 * changes are protected by socket lock.
422 */
David Ahernaa4c1032016-12-01 08:48:06 -0800423 unsigned int __sk_flags_offset[0];
424#ifdef __BIG_ENDIAN_BITFIELD
425#define SK_FL_PROTO_SHIFT 16
426#define SK_FL_PROTO_MASK 0x00ff0000
427
428#define SK_FL_TYPE_SHIFT 0
429#define SK_FL_TYPE_MASK 0x0000ffff
430#else
431#define SK_FL_PROTO_SHIFT 8
432#define SK_FL_PROTO_MASK 0x0000ff00
433
434#define SK_FL_TYPE_SHIFT 16
435#define SK_FL_TYPE_MASK 0xffff0000
436#endif
437
Vegard Nossuma98b65a2009-02-26 14:46:57 +0100438 kmemcheck_bitfield_begin(flags);
David Howellscdfbabf2017-03-09 08:09:05 +0000439 unsigned int sk_padding : 1,
440 sk_kern_sock : 1,
Tom Herbert28448b82014-05-23 08:47:19 -0700441 sk_no_check_tx : 1,
442 sk_no_check_rx : 1,
Eric Dumazet5fdb9972009-10-08 22:50:25 +0000443 sk_userlocks : 4,
444 sk_protocol : 8,
445 sk_type : 16;
Hannes Frederic Sowa7bbadd22015-12-14 23:30:43 +0100446#define SK_PROTOCOL_MAX U8_MAX
Vegard Nossuma98b65a2009-02-26 14:46:57 +0100447 kmemcheck_bitfield_end(flags);
Andrey Ryabininfc648692016-05-18 19:19:27 +0300448
Ben Hutchings14853482012-07-30 16:11:42 +0000449 u16 sk_gso_max_segs;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700450 unsigned long sk_lingertime;
Arnaldo Carvalho de Melo476e19c2005-05-05 13:35:15 -0700451 struct proto *sk_prot_creator;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700452 rwlock_t sk_callback_lock;
453 int sk_err,
454 sk_err_soft;
Eric Dumazetbecb74f2015-03-19 19:04:21 -0700455 u32 sk_ack_backlog;
456 u32 sk_max_ack_backlog;
Lorenzo Colitti86741ec2016-11-04 02:23:41 +0900457 kuid_t sk_uid;
Eric W. Biederman109f6e32010-06-13 03:30:14 +0000458 struct pid *sk_peer_pid;
459 const struct cred *sk_peer_cred;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700460 long sk_rcvtimeo;
Eric Dumazetb7aa0bf2007-04-19 16:16:32 -0700461 ktime_t sk_stamp;
Willem de Bruijnb9f40e22014-08-04 22:11:46 -0400462 u16 sk_tsflags;
Andrey Ryabininfc648692016-05-18 19:19:27 +0300463 u8 sk_shutdown;
Willem de Bruijn09c2d252014-08-04 22:11:47 -0400464 u32 sk_tskey;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700465 struct socket *sk_socket;
466 void *sk_user_data;
Alexey Dobriyand5f64232008-11-04 14:45:58 -0800467#ifdef CONFIG_SECURITY
Linus Torvalds1da177e2005-04-16 15:20:36 -0700468 void *sk_security;
Alexey Dobriyand5f64232008-11-04 14:45:58 -0800469#endif
Tejun Heo2a56a1f2015-12-07 17:38:52 -0500470 struct sock_cgroup_data sk_cgrp_data;
Johannes Weinerbaac50b2016-01-14 15:21:17 -0800471 struct mem_cgroup *sk_memcg;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700472 void (*sk_state_change)(struct sock *sk);
David S. Miller676d2362014-04-11 16:15:36 -0400473 void (*sk_data_ready)(struct sock *sk);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700474 void (*sk_write_space)(struct sock *sk);
475 void (*sk_error_report)(struct sock *sk);
Eric Dumazetdc6b9b72012-05-16 22:48:15 +0000476 int (*sk_backlog_rcv)(struct sock *sk,
477 struct sk_buff *skb);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700478 void (*sk_destruct)(struct sock *sk);
Craig Gallekef456142016-01-04 17:41:45 -0500479 struct sock_reuseport __rcu *sk_reuseport_cb;
Eric Dumazeta4298e42016-04-01 08:52:12 -0700480 struct rcu_head sk_rcu;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700481};
482
Eric Dumazet218af592017-05-16 04:24:36 -0700483enum sk_pacing {
484 SK_PACING_NONE = 0,
485 SK_PACING_NEEDED = 1,
486 SK_PACING_FQ = 2,
487};
488
Pravin B Shelar559835ea2013-09-24 10:25:40 -0700489#define __sk_user_data(sk) ((*((void __rcu **)&(sk)->sk_user_data)))
490
491#define rcu_dereference_sk_user_data(sk) rcu_dereference(__sk_user_data((sk)))
492#define rcu_assign_sk_user_data(sk, ptr) rcu_assign_pointer(__sk_user_data((sk)), ptr)
493
Pavel Emelyanov4a17fd52012-04-19 03:39:36 +0000494/*
495 * SK_CAN_REUSE and SK_NO_REUSE on a socket mean that the socket is OK
496 * or not whether his port will be reused by someone else. SK_FORCE_REUSE
497 * on a socket means that the socket will reuse everybody else's port
498 * without looking at the other's sk_reuse value.
499 */
500
501#define SK_NO_REUSE 0
502#define SK_CAN_REUSE 1
503#define SK_FORCE_REUSE 2
504
samanthakumar627d2d62016-04-05 12:41:16 -0400505int sk_set_peek_off(struct sock *sk, int val);
506
Pavel Emelyanovef64a542012-02-21 07:31:34 +0000507static inline int sk_peek_offset(struct sock *sk, int flags)
508{
Willem de Bruijnb9bb53f2016-04-05 12:41:14 -0400509 if (unlikely(flags & MSG_PEEK)) {
510 s32 off = READ_ONCE(sk->sk_peek_off);
511 if (off >= 0)
512 return off;
513 }
514
515 return 0;
Pavel Emelyanovef64a542012-02-21 07:31:34 +0000516}
517
518static inline void sk_peek_offset_bwd(struct sock *sk, int val)
519{
Willem de Bruijnb9bb53f2016-04-05 12:41:14 -0400520 s32 off = READ_ONCE(sk->sk_peek_off);
521
522 if (unlikely(off >= 0)) {
523 off = max_t(s32, off - val, 0);
524 WRITE_ONCE(sk->sk_peek_off, off);
Pavel Emelyanovef64a542012-02-21 07:31:34 +0000525 }
526}
527
528static inline void sk_peek_offset_fwd(struct sock *sk, int val)
529{
Willem de Bruijnb9bb53f2016-04-05 12:41:14 -0400530 sk_peek_offset_bwd(sk, -val);
Pavel Emelyanovef64a542012-02-21 07:31:34 +0000531}
532
Linus Torvalds1da177e2005-04-16 15:20:36 -0700533/*
534 * Hashed lists helper routines
535 */
Li Zefanc41466442010-02-08 23:18:45 +0000536static inline struct sock *sk_entry(const struct hlist_node *node)
537{
538 return hlist_entry(node, struct sock, sk_node);
539}
540
Arnaldo Carvalho de Meloe48c4142005-08-09 20:09:46 -0700541static inline struct sock *__sk_head(const struct hlist_head *head)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700542{
543 return hlist_entry(head->first, struct sock, sk_node);
544}
545
Arnaldo Carvalho de Meloe48c4142005-08-09 20:09:46 -0700546static inline struct sock *sk_head(const struct hlist_head *head)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700547{
548 return hlist_empty(head) ? NULL : __sk_head(head);
549}
550
Eric Dumazet88ab1932008-11-16 19:39:21 -0800551static inline struct sock *__sk_nulls_head(const struct hlist_nulls_head *head)
552{
553 return hlist_nulls_entry(head->first, struct sock, sk_nulls_node);
554}
555
556static inline struct sock *sk_nulls_head(const struct hlist_nulls_head *head)
557{
558 return hlist_nulls_empty(head) ? NULL : __sk_nulls_head(head);
559}
560
Arnaldo Carvalho de Meloe48c4142005-08-09 20:09:46 -0700561static inline struct sock *sk_next(const struct sock *sk)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700562{
Geliang Tang6c59ebd2017-01-20 22:27:04 +0800563 return hlist_entry_safe(sk->sk_node.next, struct sock, sk_node);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700564}
565
Eric Dumazet88ab1932008-11-16 19:39:21 -0800566static inline struct sock *sk_nulls_next(const struct sock *sk)
567{
568 return (!is_a_nulls(sk->sk_nulls_node.next)) ?
569 hlist_nulls_entry(sk->sk_nulls_node.next,
570 struct sock, sk_nulls_node) :
571 NULL;
572}
573
Eric Dumazetdc6b9b72012-05-16 22:48:15 +0000574static inline bool sk_unhashed(const struct sock *sk)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700575{
576 return hlist_unhashed(&sk->sk_node);
577}
578
Eric Dumazetdc6b9b72012-05-16 22:48:15 +0000579static inline bool sk_hashed(const struct sock *sk)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700580{
Akinobu Mitada753be2006-04-28 15:21:23 -0700581 return !sk_unhashed(sk);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700582}
583
Eric Dumazetdc6b9b72012-05-16 22:48:15 +0000584static inline void sk_node_init(struct hlist_node *node)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700585{
586 node->pprev = NULL;
587}
588
Eric Dumazetdc6b9b72012-05-16 22:48:15 +0000589static inline void sk_nulls_node_init(struct hlist_nulls_node *node)
Eric Dumazet88ab1932008-11-16 19:39:21 -0800590{
591 node->pprev = NULL;
592}
593
Eric Dumazetdc6b9b72012-05-16 22:48:15 +0000594static inline void __sk_del_node(struct sock *sk)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700595{
596 __hlist_del(&sk->sk_node);
597}
598
stephen hemminger808f5112010-02-22 07:57:18 +0000599/* NB: equivalent to hlist_del_init_rcu */
Eric Dumazetdc6b9b72012-05-16 22:48:15 +0000600static inline bool __sk_del_node_init(struct sock *sk)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700601{
602 if (sk_hashed(sk)) {
603 __sk_del_node(sk);
604 sk_node_init(&sk->sk_node);
Eric Dumazetdc6b9b72012-05-16 22:48:15 +0000605 return true;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700606 }
Eric Dumazetdc6b9b72012-05-16 22:48:15 +0000607 return false;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700608}
609
610/* Grab socket reference count. This operation is valid only
611 when sk is ALREADY grabbed f.e. it is found in hash table
612 or a list and the lookup is made under lock preventing hash table
613 modifications.
614 */
615
Denys Vlasenkof9a7cbb2016-04-08 17:51:54 +0200616static __always_inline void sock_hold(struct sock *sk)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700617{
Reshetova, Elena41c6d652017-06-30 13:08:01 +0300618 refcount_inc(&sk->sk_refcnt);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700619}
620
621/* Ungrab socket in the context, which assumes that socket refcnt
622 cannot hit zero, f.e. it is true in context of any socketcall.
623 */
Denys Vlasenkof9a7cbb2016-04-08 17:51:54 +0200624static __always_inline void __sock_put(struct sock *sk)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700625{
Reshetova, Elena41c6d652017-06-30 13:08:01 +0300626 refcount_dec(&sk->sk_refcnt);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700627}
628
Eric Dumazetdc6b9b72012-05-16 22:48:15 +0000629static inline bool sk_del_node_init(struct sock *sk)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700630{
Eric Dumazetdc6b9b72012-05-16 22:48:15 +0000631 bool rc = __sk_del_node_init(sk);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700632
633 if (rc) {
634 /* paranoid for a while -acme */
Reshetova, Elena41c6d652017-06-30 13:08:01 +0300635 WARN_ON(refcount_read(&sk->sk_refcnt) == 1);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700636 __sock_put(sk);
637 }
638 return rc;
639}
stephen hemminger808f5112010-02-22 07:57:18 +0000640#define sk_del_node_init_rcu(sk) sk_del_node_init(sk)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700641
Eric Dumazetdc6b9b72012-05-16 22:48:15 +0000642static inline bool __sk_nulls_del_node_init_rcu(struct sock *sk)
Eric Dumazet271b72c2008-10-29 02:11:14 -0700643{
644 if (sk_hashed(sk)) {
Eric Dumazet88ab1932008-11-16 19:39:21 -0800645 hlist_nulls_del_init_rcu(&sk->sk_nulls_node);
Eric Dumazetdc6b9b72012-05-16 22:48:15 +0000646 return true;
Eric Dumazet271b72c2008-10-29 02:11:14 -0700647 }
Eric Dumazetdc6b9b72012-05-16 22:48:15 +0000648 return false;
Eric Dumazet271b72c2008-10-29 02:11:14 -0700649}
650
Eric Dumazetdc6b9b72012-05-16 22:48:15 +0000651static inline bool sk_nulls_del_node_init_rcu(struct sock *sk)
Eric Dumazet271b72c2008-10-29 02:11:14 -0700652{
Eric Dumazetdc6b9b72012-05-16 22:48:15 +0000653 bool rc = __sk_nulls_del_node_init_rcu(sk);
Eric Dumazet271b72c2008-10-29 02:11:14 -0700654
655 if (rc) {
656 /* paranoid for a while -acme */
Reshetova, Elena41c6d652017-06-30 13:08:01 +0300657 WARN_ON(refcount_read(&sk->sk_refcnt) == 1);
Eric Dumazet271b72c2008-10-29 02:11:14 -0700658 __sock_put(sk);
659 }
660 return rc;
661}
662
Eric Dumazetdc6b9b72012-05-16 22:48:15 +0000663static inline void __sk_add_node(struct sock *sk, struct hlist_head *list)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700664{
665 hlist_add_head(&sk->sk_node, list);
666}
667
Eric Dumazetdc6b9b72012-05-16 22:48:15 +0000668static inline void sk_add_node(struct sock *sk, struct hlist_head *list)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700669{
670 sock_hold(sk);
671 __sk_add_node(sk, list);
672}
673
Eric Dumazetdc6b9b72012-05-16 22:48:15 +0000674static inline void sk_add_node_rcu(struct sock *sk, struct hlist_head *list)
stephen hemminger808f5112010-02-22 07:57:18 +0000675{
676 sock_hold(sk);
Craig Gallekd296ba62016-04-25 10:42:12 -0400677 if (IS_ENABLED(CONFIG_IPV6) && sk->sk_reuseport &&
678 sk->sk_family == AF_INET6)
679 hlist_add_tail_rcu(&sk->sk_node, list);
680 else
681 hlist_add_head_rcu(&sk->sk_node, list);
stephen hemminger808f5112010-02-22 07:57:18 +0000682}
683
Eric Dumazetdc6b9b72012-05-16 22:48:15 +0000684static inline void __sk_nulls_add_node_rcu(struct sock *sk, struct hlist_nulls_head *list)
Eric Dumazet271b72c2008-10-29 02:11:14 -0700685{
Craig Gallekd894ba12016-04-12 13:11:25 -0400686 if (IS_ENABLED(CONFIG_IPV6) && sk->sk_reuseport &&
687 sk->sk_family == AF_INET6)
688 hlist_nulls_add_tail_rcu(&sk->sk_nulls_node, list);
689 else
690 hlist_nulls_add_head_rcu(&sk->sk_nulls_node, list);
Eric Dumazet271b72c2008-10-29 02:11:14 -0700691}
692
Eric Dumazetdc6b9b72012-05-16 22:48:15 +0000693static inline void sk_nulls_add_node_rcu(struct sock *sk, struct hlist_nulls_head *list)
Eric Dumazet271b72c2008-10-29 02:11:14 -0700694{
695 sock_hold(sk);
Eric Dumazet88ab1932008-11-16 19:39:21 -0800696 __sk_nulls_add_node_rcu(sk, list);
Eric Dumazet271b72c2008-10-29 02:11:14 -0700697}
698
Eric Dumazetdc6b9b72012-05-16 22:48:15 +0000699static inline void __sk_del_bind_node(struct sock *sk)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700700{
701 __hlist_del(&sk->sk_bind_node);
702}
703
Eric Dumazetdc6b9b72012-05-16 22:48:15 +0000704static inline void sk_add_bind_node(struct sock *sk,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700705 struct hlist_head *list)
706{
707 hlist_add_head(&sk->sk_bind_node, list);
708}
709
Sasha Levinb67bfe02013-02-27 17:06:00 -0800710#define sk_for_each(__sk, list) \
711 hlist_for_each_entry(__sk, list, sk_node)
712#define sk_for_each_rcu(__sk, list) \
713 hlist_for_each_entry_rcu(__sk, list, sk_node)
Eric Dumazet88ab1932008-11-16 19:39:21 -0800714#define sk_nulls_for_each(__sk, node, list) \
715 hlist_nulls_for_each_entry(__sk, node, list, sk_nulls_node)
716#define sk_nulls_for_each_rcu(__sk, node, list) \
717 hlist_nulls_for_each_entry_rcu(__sk, node, list, sk_nulls_node)
Sasha Levinb67bfe02013-02-27 17:06:00 -0800718#define sk_for_each_from(__sk) \
719 hlist_for_each_entry_from(__sk, sk_node)
Eric Dumazet88ab1932008-11-16 19:39:21 -0800720#define sk_nulls_for_each_from(__sk, node) \
721 if (__sk && ({ node = &(__sk)->sk_nulls_node; 1; })) \
722 hlist_nulls_for_each_entry_from(__sk, node, sk_nulls_node)
Sasha Levinb67bfe02013-02-27 17:06:00 -0800723#define sk_for_each_safe(__sk, tmp, list) \
724 hlist_for_each_entry_safe(__sk, tmp, list, sk_node)
725#define sk_for_each_bound(__sk, list) \
726 hlist_for_each_entry(__sk, list, sk_bind_node)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700727
David Held2dc41cf2014-07-15 23:28:32 -0400728/**
Eric Dumazetca065d02016-04-01 08:52:13 -0700729 * sk_for_each_entry_offset_rcu - iterate over a list at a given struct offset
David Held2dc41cf2014-07-15 23:28:32 -0400730 * @tpos: the type * to use as a loop cursor.
731 * @pos: the &struct hlist_node to use as a loop cursor.
732 * @head: the head for your list.
733 * @offset: offset of hlist_node within the struct.
734 *
735 */
Eric Dumazetca065d02016-04-01 08:52:13 -0700736#define sk_for_each_entry_offset_rcu(tpos, pos, head, offset) \
737 for (pos = rcu_dereference((head)->first); \
738 pos != NULL && \
David Held2dc41cf2014-07-15 23:28:32 -0400739 ({ tpos = (typeof(*tpos) *)((void *)pos - offset); 1;}); \
Eric Dumazetca065d02016-04-01 08:52:13 -0700740 pos = rcu_dereference(pos->next))
David Held2dc41cf2014-07-15 23:28:32 -0400741
Eric W. Biedermanc336d142012-05-24 17:56:43 -0600742static inline struct user_namespace *sk_user_ns(struct sock *sk)
743{
744 /* Careful only use this in a context where these parameters
745 * can not change and must all be valid, such as recvmsg from
746 * userspace.
747 */
748 return sk->sk_socket->file->f_cred->user_ns;
749}
750
Linus Torvalds1da177e2005-04-16 15:20:36 -0700751/* Sock flags */
752enum sock_flags {
753 SOCK_DEAD,
754 SOCK_DONE,
755 SOCK_URGINLINE,
756 SOCK_KEEPOPEN,
757 SOCK_LINGER,
758 SOCK_DESTROY,
759 SOCK_BROADCAST,
760 SOCK_TIMESTAMP,
761 SOCK_ZAPPED,
762 SOCK_USE_WRITE_QUEUE, /* whether to call sk->sk_write_space in sock_wfree */
763 SOCK_DBG, /* %SO_DEBUG setting */
764 SOCK_RCVTSTAMP, /* %SO_TIMESTAMP setting */
Eric Dumazet92f37fd2007-03-25 22:14:49 -0700765 SOCK_RCVTSTAMPNS, /* %SO_TIMESTAMPNS setting */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700766 SOCK_LOCALROUTE, /* route locally only, %SO_DONTROUTE setting */
767 SOCK_QUEUE_SHRUNK, /* write queue has been shrunk recently */
Mel Gorman7cb02402012-07-31 16:44:16 -0700768 SOCK_MEMALLOC, /* VM depends on this socket for swapping */
Patrick Ohly20d49472009-02-12 05:03:38 +0000769 SOCK_TIMESTAMPING_RX_SOFTWARE, /* %SOF_TIMESTAMPING_RX_SOFTWARE */
Eric Dumazetbcdce712009-10-06 17:28:29 -0700770 SOCK_FASYNC, /* fasync() active */
Neil Horman3b885782009-10-12 13:26:31 -0700771 SOCK_RXQ_OVFL,
Shirley Ma1cdebb42011-07-06 12:17:30 +0000772 SOCK_ZEROCOPY, /* buffers from userspace */
Johannes Berg6e3e9392011-11-09 10:15:42 +0100773 SOCK_WIFI_STATUS, /* push wifi status to userspace */
Ben Greear3bdc0eb2012-02-11 15:39:30 +0000774 SOCK_NOFCS, /* Tell NIC not to do the Ethernet FCS.
775 * Will use last 4 bytes of packet sent from
776 * user-space instead.
777 */
Vincent Bernatd59577b2013-01-16 22:55:49 +0100778 SOCK_FILTER_LOCKED, /* Filter cannot be changed anymore */
Keller, Jacob E7d4c04f2013-03-28 11:19:25 +0000779 SOCK_SELECT_ERR_QUEUE, /* Wake select on error queue */
Eric Dumazeta4298e42016-04-01 08:52:12 -0700780 SOCK_RCU_FREE, /* wait rcu grace period in sk_destruct() */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700781};
782
Marcelo Ricardo Leitner01ce63c2015-12-04 15:14:04 -0200783#define SK_FLAGS_TIMESTAMP ((1UL << SOCK_TIMESTAMP) | (1UL << SOCK_TIMESTAMPING_RX_SOFTWARE))
784
Ralf Baechle53b924b2005-08-23 10:11:30 -0700785static inline void sock_copy_flags(struct sock *nsk, struct sock *osk)
786{
787 nsk->sk_flags = osk->sk_flags;
788}
789
Linus Torvalds1da177e2005-04-16 15:20:36 -0700790static inline void sock_set_flag(struct sock *sk, enum sock_flags flag)
791{
792 __set_bit(flag, &sk->sk_flags);
793}
794
795static inline void sock_reset_flag(struct sock *sk, enum sock_flags flag)
796{
797 __clear_bit(flag, &sk->sk_flags);
798}
799
Eric Dumazet1b23a5d2012-05-16 05:57:07 +0000800static inline bool sock_flag(const struct sock *sk, enum sock_flags flag)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700801{
802 return test_bit(flag, &sk->sk_flags);
803}
804
Mel Gormanc93bdd02012-07-31 16:44:19 -0700805#ifdef CONFIG_NET
806extern struct static_key memalloc_socks;
807static inline int sk_memalloc_socks(void)
808{
809 return static_key_false(&memalloc_socks);
810}
811#else
812
813static inline int sk_memalloc_socks(void)
814{
815 return 0;
816}
817
818#endif
819
Eric Dumazet7450aaf2015-11-30 08:57:28 -0800820static inline gfp_t sk_gfp_mask(const struct sock *sk, gfp_t gfp_mask)
Mel Gorman99a1dec2012-07-31 16:44:14 -0700821{
Eric Dumazet7450aaf2015-11-30 08:57:28 -0800822 return gfp_mask | (sk->sk_allocation & __GFP_MEMALLOC);
Mel Gorman99a1dec2012-07-31 16:44:14 -0700823}
824
Linus Torvalds1da177e2005-04-16 15:20:36 -0700825static inline void sk_acceptq_removed(struct sock *sk)
826{
827 sk->sk_ack_backlog--;
828}
829
830static inline void sk_acceptq_added(struct sock *sk)
831{
832 sk->sk_ack_backlog++;
833}
834
Eric Dumazetdc6b9b72012-05-16 22:48:15 +0000835static inline bool sk_acceptq_is_full(const struct sock *sk)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700836{
David S. Miller64a14652007-03-06 11:21:05 -0800837 return sk->sk_ack_backlog > sk->sk_max_ack_backlog;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700838}
839
840/*
841 * Compute minimal free write space needed to queue new packets.
842 */
Eric Dumazetdc6b9b72012-05-16 22:48:15 +0000843static inline int sk_stream_min_wspace(const struct sock *sk)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700844{
Eric Dumazet8df09ea2007-12-21 03:07:41 -0800845 return sk->sk_wmem_queued >> 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700846}
847
Eric Dumazetdc6b9b72012-05-16 22:48:15 +0000848static inline int sk_stream_wspace(const struct sock *sk)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700849{
850 return sk->sk_sndbuf - sk->sk_wmem_queued;
851}
852
Joe Perches69336bd2013-09-22 10:32:26 -0700853void sk_stream_write_space(struct sock *sk);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700854
Zhu Yi8eae9392010-03-04 18:01:40 +0000855/* OOB backlog add */
Zhu Yia3a858f2010-03-04 18:01:47 +0000856static inline void __sk_add_backlog(struct sock *sk, struct sk_buff *skb)
Stephen Hemminger9ee6b532005-11-08 09:39:42 -0800857{
Eric Dumazet7fee2262010-05-11 23:19:48 +0000858 /* dont let skb dst not refcounted, we are going to leave rcu lock */
Eric Dumazet5037e9e2015-12-14 14:08:53 -0800859 skb_dst_force_safe(skb);
Eric Dumazet7fee2262010-05-11 23:19:48 +0000860
861 if (!sk->sk_backlog.tail)
862 sk->sk_backlog.head = skb;
863 else
Stephen Hemminger9ee6b532005-11-08 09:39:42 -0800864 sk->sk_backlog.tail->next = skb;
Eric Dumazet7fee2262010-05-11 23:19:48 +0000865
866 sk->sk_backlog.tail = skb;
Stephen Hemminger9ee6b532005-11-08 09:39:42 -0800867 skb->next = NULL;
868}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700869
Eric Dumazetc3774112010-04-27 15:13:20 -0700870/*
871 * Take into account size of receive queue and backlog queue
Eric Dumazet0fd7bac2011-12-21 07:11:44 +0000872 * Do not take into account this skb truesize,
873 * to allow even a single big packet to come.
Eric Dumazetc3774112010-04-27 15:13:20 -0700874 */
Sorin Dumitru274f4822014-07-22 21:16:51 +0300875static inline bool sk_rcvqueues_full(const struct sock *sk, unsigned int limit)
Eric Dumazetc3774112010-04-27 15:13:20 -0700876{
877 unsigned int qsize = sk->sk_backlog.len + atomic_read(&sk->sk_rmem_alloc);
878
Eric Dumazetf545a382012-04-22 23:34:26 +0000879 return qsize > limit;
Eric Dumazetc3774112010-04-27 15:13:20 -0700880}
881
Zhu Yi8eae9392010-03-04 18:01:40 +0000882/* The per-socket spinlock must be held here. */
Eric Dumazetf545a382012-04-22 23:34:26 +0000883static inline __must_check int sk_add_backlog(struct sock *sk, struct sk_buff *skb,
884 unsigned int limit)
Zhu Yi8eae9392010-03-04 18:01:40 +0000885{
Sorin Dumitru274f4822014-07-22 21:16:51 +0300886 if (sk_rcvqueues_full(sk, limit))
Zhu Yi8eae9392010-03-04 18:01:40 +0000887 return -ENOBUFS;
888
Eric Dumazetc7c49b82015-09-29 18:52:25 -0700889 /*
890 * If the skb was allocated from pfmemalloc reserves, only
891 * allow SOCK_MEMALLOC sockets to use it as this socket is
892 * helping free memory
893 */
894 if (skb_pfmemalloc(skb) && !sock_flag(sk, SOCK_MEMALLOC))
895 return -ENOMEM;
896
Zhu Yia3a858f2010-03-04 18:01:47 +0000897 __sk_add_backlog(sk, skb);
Zhu Yi8eae9392010-03-04 18:01:40 +0000898 sk->sk_backlog.len += skb->truesize;
899 return 0;
900}
901
Joe Perches69336bd2013-09-22 10:32:26 -0700902int __sk_backlog_rcv(struct sock *sk, struct sk_buff *skb);
Mel Gormanb4b9e352012-07-31 16:44:26 -0700903
Peter Zijlstrac57943a2008-10-07 14:18:42 -0700904static inline int sk_backlog_rcv(struct sock *sk, struct sk_buff *skb)
905{
Mel Gormanb4b9e352012-07-31 16:44:26 -0700906 if (sk_memalloc_socks() && skb_pfmemalloc(skb))
907 return __sk_backlog_rcv(sk, skb);
908
Peter Zijlstrac57943a2008-10-07 14:18:42 -0700909 return sk->sk_backlog_rcv(sk, skb);
910}
911
Eric Dumazet2c8c56e2014-11-11 05:54:28 -0800912static inline void sk_incoming_cpu_update(struct sock *sk)
913{
Paolo Abeni34cfb542017-06-21 11:45:31 +0200914 int cpu = raw_smp_processor_id();
915
916 if (unlikely(sk->sk_incoming_cpu != cpu))
917 sk->sk_incoming_cpu = cpu;
Eric Dumazet2c8c56e2014-11-11 05:54:28 -0800918}
919
Tom Herbertfe477552013-12-22 18:54:31 +0800920static inline void sock_rps_record_flow_hash(__u32 hash)
David S. Millerc58dc012010-04-27 15:05:31 -0700921{
922#ifdef CONFIG_RPS
923 struct rps_sock_flow_table *sock_flow_table;
924
925 rcu_read_lock();
926 sock_flow_table = rcu_dereference(rps_sock_flow_table);
Tom Herbertfe477552013-12-22 18:54:31 +0800927 rps_record_sock_flow(sock_flow_table, hash);
David S. Millerc58dc012010-04-27 15:05:31 -0700928 rcu_read_unlock();
929#endif
930}
931
Tom Herbertfe477552013-12-22 18:54:31 +0800932static inline void sock_rps_record_flow(const struct sock *sk)
933{
Zhi Yong Wuc9d8ca02014-01-01 04:31:01 +0800934#ifdef CONFIG_RPS
Eric Dumazet13bfff22016-12-07 08:29:10 -0800935 if (static_key_false(&rfs_needed)) {
936 /* Reading sk->sk_rxhash might incur an expensive cache line
937 * miss.
938 *
939 * TCP_ESTABLISHED does cover almost all states where RFS
940 * might be useful, and is cheaper [1] than testing :
941 * IPv4: inet_sk(sk)->inet_daddr
942 * IPv6: ipv6_addr_any(&sk->sk_v6_daddr)
943 * OR an additional socket flag
944 * [1] : sk_state and sk_prot are in the same cache line.
945 */
946 if (sk->sk_state == TCP_ESTABLISHED)
947 sock_rps_record_flow_hash(sk->sk_rxhash);
948 }
Zhi Yong Wuc9d8ca02014-01-01 04:31:01 +0800949#endif
Tom Herbertfe477552013-12-22 18:54:31 +0800950}
951
Tom Herbertbdeab992011-08-14 19:45:55 +0000952static inline void sock_rps_save_rxhash(struct sock *sk,
953 const struct sk_buff *skb)
David S. Millerc58dc012010-04-27 15:05:31 -0700954{
955#ifdef CONFIG_RPS
Eric Dumazet567e4b72015-02-06 12:59:01 -0800956 if (unlikely(sk->sk_rxhash != skb->hash))
Tom Herbert61b905d2014-03-24 15:34:47 -0700957 sk->sk_rxhash = skb->hash;
David S. Millerc58dc012010-04-27 15:05:31 -0700958#endif
959}
960
Tom Herbertbdeab992011-08-14 19:45:55 +0000961static inline void sock_rps_reset_rxhash(struct sock *sk)
962{
963#ifdef CONFIG_RPS
Tom Herbertbdeab992011-08-14 19:45:55 +0000964 sk->sk_rxhash = 0;
965#endif
966}
967
WANG Congd9dc8b02016-11-11 10:20:50 -0800968#define sk_wait_event(__sk, __timeo, __condition, __wait) \
Stephen Hemmingercfcabdc2007-10-09 01:59:42 -0700969 ({ int __rc; \
970 release_sock(__sk); \
971 __rc = __condition; \
972 if (!__rc) { \
WANG Congd9dc8b02016-11-11 10:20:50 -0800973 *(__timeo) = wait_woken(__wait, \
974 TASK_INTERRUPTIBLE, \
975 *(__timeo)); \
Stephen Hemmingercfcabdc2007-10-09 01:59:42 -0700976 } \
WANG Congd9dc8b02016-11-11 10:20:50 -0800977 sched_annotate_sleep(); \
Stephen Hemmingercfcabdc2007-10-09 01:59:42 -0700978 lock_sock(__sk); \
979 __rc = __condition; \
980 __rc; \
981 })
Linus Torvalds1da177e2005-04-16 15:20:36 -0700982
Joe Perches69336bd2013-09-22 10:32:26 -0700983int sk_stream_wait_connect(struct sock *sk, long *timeo_p);
984int sk_stream_wait_memory(struct sock *sk, long *timeo_p);
985void sk_stream_wait_close(struct sock *sk, long timeo_p);
986int sk_stream_error(struct sock *sk, int flags, int err);
987void sk_stream_kill_queues(struct sock *sk);
988void sk_set_memalloc(struct sock *sk);
989void sk_clear_memalloc(struct sock *sk);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700990
Eric Dumazetd41a69f2016-04-29 14:16:53 -0700991void __sk_flush_backlog(struct sock *sk);
992
993static inline bool sk_flush_backlog(struct sock *sk)
994{
995 if (unlikely(READ_ONCE(sk->sk_backlog.tail))) {
996 __sk_flush_backlog(sk);
997 return true;
998 }
999 return false;
1000}
1001
Sabrina Dubrocadfbafc92015-07-24 18:19:25 +02001002int sk_wait_data(struct sock *sk, long *timeo, const struct sk_buff *skb);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001003
Arnaldo Carvalho de Melo60236fd2005-06-18 22:47:21 -07001004struct request_sock_ops;
Arnaldo Carvalho de Melo6d6ee432005-12-13 23:25:19 -08001005struct timewait_sock_ops;
Arnaldo Carvalho de Meloab1e0a12008-02-03 04:06:04 -08001006struct inet_hashinfo;
Pavel Emelyanovfc8717b2008-03-22 16:56:51 -07001007struct raw_hashinfo;
Ursula Braunf16a7dd2017-01-09 16:55:26 +01001008struct smc_hashinfo;
Paul Gortmakerde477252011-05-26 13:46:22 -04001009struct module;
Arnaldo Carvalho de Melo2e6599c2005-06-18 22:46:52 -07001010
Eric Dumazetf77d6022013-05-09 10:28:16 +00001011/*
Paul E. McKenney5f0d5a32017-01-18 02:53:44 -08001012 * caches using SLAB_TYPESAFE_BY_RCU should let .next pointer from nulls nodes
Eric Dumazetf77d6022013-05-09 10:28:16 +00001013 * un-modified. Special care is taken when initializing object to zero.
1014 */
1015static inline void sk_prot_clear_nulls(struct sock *sk, int size)
1016{
1017 if (offsetof(struct sock, sk_node.next) != 0)
1018 memset(sk, 0, offsetof(struct sock, sk_node.next));
1019 memset(&sk->sk_node.pprev, 0,
1020 size - offsetof(struct sock, sk_node.pprev));
1021}
1022
Linus Torvalds1da177e2005-04-16 15:20:36 -07001023/* Networking protocol blocks we attach to sockets.
1024 * socket layer -> transport layer interface
Linus Torvalds1da177e2005-04-16 15:20:36 -07001025 */
1026struct proto {
Eric Dumazetdc6b9b72012-05-16 22:48:15 +00001027 void (*close)(struct sock *sk,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001028 long timeout);
1029 int (*connect)(struct sock *sk,
Eric Dumazetdc6b9b72012-05-16 22:48:15 +00001030 struct sockaddr *uaddr,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001031 int addr_len);
1032 int (*disconnect)(struct sock *sk, int flags);
1033
David Howellscdfbabf2017-03-09 08:09:05 +00001034 struct sock * (*accept)(struct sock *sk, int flags, int *err,
1035 bool kern);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001036
1037 int (*ioctl)(struct sock *sk, int cmd,
1038 unsigned long arg);
1039 int (*init)(struct sock *sk);
Brian Haley7d06b2e2008-06-14 17:04:49 -07001040 void (*destroy)(struct sock *sk);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001041 void (*shutdown)(struct sock *sk, int how);
Eric Dumazetdc6b9b72012-05-16 22:48:15 +00001042 int (*setsockopt)(struct sock *sk, int level,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001043 int optname, char __user *optval,
David S. Millerb7058842009-09-30 16:12:20 -07001044 unsigned int optlen);
Eric Dumazetdc6b9b72012-05-16 22:48:15 +00001045 int (*getsockopt)(struct sock *sk, int level,
1046 int optname, char __user *optval,
1047 int __user *option);
Ursula Braun4b9d07a2017-01-09 16:55:12 +01001048 void (*keepalive)(struct sock *sk, int valbool);
Alexey Dobriyanaf01d532008-08-28 02:53:51 -07001049#ifdef CONFIG_COMPAT
Dmitry Mishin3fdadf72006-03-20 22:45:21 -08001050 int (*compat_setsockopt)(struct sock *sk,
1051 int level,
1052 int optname, char __user *optval,
David S. Millerb7058842009-09-30 16:12:20 -07001053 unsigned int optlen);
Dmitry Mishin3fdadf72006-03-20 22:45:21 -08001054 int (*compat_getsockopt)(struct sock *sk,
1055 int level,
1056 int optname, char __user *optval,
1057 int __user *option);
Eric W. Biederman709b46e2011-01-29 16:15:56 +00001058 int (*compat_ioctl)(struct sock *sk,
1059 unsigned int cmd, unsigned long arg);
Alexey Dobriyanaf01d532008-08-28 02:53:51 -07001060#endif
Ying Xue1b784142015-03-02 15:37:48 +08001061 int (*sendmsg)(struct sock *sk, struct msghdr *msg,
1062 size_t len);
1063 int (*recvmsg)(struct sock *sk, struct msghdr *msg,
Eric Dumazetdc6b9b72012-05-16 22:48:15 +00001064 size_t len, int noblock, int flags,
1065 int *addr_len);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001066 int (*sendpage)(struct sock *sk, struct page *page,
1067 int offset, size_t size, int flags);
Eric Dumazetdc6b9b72012-05-16 22:48:15 +00001068 int (*bind)(struct sock *sk,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001069 struct sockaddr *uaddr, int addr_len);
1070
Eric Dumazetdc6b9b72012-05-16 22:48:15 +00001071 int (*backlog_rcv) (struct sock *sk,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001072 struct sk_buff *skb);
1073
Eric Dumazet46d3cea2012-07-11 05:50:31 +00001074 void (*release_cb)(struct sock *sk);
1075
Linus Torvalds1da177e2005-04-16 15:20:36 -07001076 /* Keeping track of sk's, looking them up, and port selection methods. */
Craig Gallek086c6532016-02-10 11:50:35 -05001077 int (*hash)(struct sock *sk);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001078 void (*unhash)(struct sock *sk);
Eric Dumazet719f8352010-09-08 05:08:44 +00001079 void (*rehash)(struct sock *sk);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001080 int (*get_port)(struct sock *sk, unsigned short snum);
1081
Eric Dumazet286ab3d2007-11-05 23:38:39 -08001082 /* Keeping track of sockets in use */
Eric Dumazet65f76512008-01-03 20:46:48 -08001083#ifdef CONFIG_PROC_FS
Pavel Emelyanov13ff3d62008-03-28 16:38:17 -07001084 unsigned int inuse_idx;
Eric Dumazet65f76512008-01-03 20:46:48 -08001085#endif
Arnaldo Carvalho de Meloebb53d72007-11-21 22:08:50 +08001086
Eric Dumazetc9bee3b72013-07-22 20:27:07 -07001087 bool (*stream_memory_free)(const struct sock *sk);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001088 /* Memory pressure */
Pavel Emelyanov5c52ba12008-07-16 20:28:10 -07001089 void (*enter_memory_pressure)(struct sock *sk);
Eric Dumazet06044752017-06-07 13:29:12 -07001090 void (*leave_memory_pressure)(struct sock *sk);
Eric Dumazet8d987e52010-11-09 23:24:26 +00001091 atomic_long_t *memory_allocated; /* Current allocated memory. */
Eric Dumazet17483762008-11-25 21:16:35 -08001092 struct percpu_counter *sockets_allocated; /* Current number of sockets. */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001093 /*
1094 * Pressure flag: try to collapse.
1095 * Technical note: it is used by multiple contexts non atomically.
Hideo Aoki3ab224b2007-12-31 00:11:19 -08001096 * All the __sk_mem_schedule() is of this nature: accounting
Linus Torvalds1da177e2005-04-16 15:20:36 -07001097 * is strict, actions are advisory and have some latency.
1098 */
Eric Dumazet06044752017-06-07 13:29:12 -07001099 unsigned long *memory_pressure;
Eric Dumazet8d987e52010-11-09 23:24:26 +00001100 long *sysctl_mem;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001101 int *sysctl_wmem;
1102 int *sysctl_rmem;
1103 int max_header;
Changli Gao7ba42912010-07-10 20:41:55 +00001104 bool no_autobind;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001105
Eric Dumazet271b72c2008-10-29 02:11:14 -07001106 struct kmem_cache *slab;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001107 unsigned int obj_size;
Eric Dumazet271b72c2008-10-29 02:11:14 -07001108 int slab_flags;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001109
Eric Dumazetdd24c002008-11-25 21:17:14 -08001110 struct percpu_counter *orphan_count;
Arnaldo Carvalho de Melo8feaf0c02005-08-09 20:09:30 -07001111
Arnaldo Carvalho de Melo60236fd2005-06-18 22:47:21 -07001112 struct request_sock_ops *rsk_prot;
Arnaldo Carvalho de Melo6d6ee432005-12-13 23:25:19 -08001113 struct timewait_sock_ops *twsk_prot;
Arnaldo Carvalho de Melo2e6599c2005-06-18 22:46:52 -07001114
Pavel Emelyanov39d8cda2008-03-22 16:50:58 -07001115 union {
1116 struct inet_hashinfo *hashinfo;
Eric Dumazet645ca702008-10-29 01:41:45 -07001117 struct udp_table *udp_table;
Pavel Emelyanovfc8717b2008-03-22 16:56:51 -07001118 struct raw_hashinfo *raw_hash;
Ursula Braunf16a7dd2017-01-09 16:55:26 +01001119 struct smc_hashinfo *smc_hash;
Pavel Emelyanov39d8cda2008-03-22 16:50:58 -07001120 } h;
Arnaldo Carvalho de Meloab1e0a12008-02-03 04:06:04 -08001121
Linus Torvalds1da177e2005-04-16 15:20:36 -07001122 struct module *owner;
1123
1124 char name[32];
1125
1126 struct list_head node;
Arnaldo Carvalho de Meloe6848972005-08-09 19:45:38 -07001127#ifdef SOCK_REFCNT_DEBUG
1128 atomic_t socks;
1129#endif
Lorenzo Colitti64be0ae2015-12-16 12:30:03 +09001130 int (*diag_destroy)(struct sock *sk, int err);
Kees Cook3859a272016-10-28 01:22:25 -07001131} __randomize_layout;
Glauber Costae1aab162011-12-11 21:47:03 +00001132
Joe Perches69336bd2013-09-22 10:32:26 -07001133int proto_register(struct proto *prot, int alloc_slab);
1134void proto_unregister(struct proto *prot);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001135
Arnaldo Carvalho de Meloe6848972005-08-09 19:45:38 -07001136#ifdef SOCK_REFCNT_DEBUG
1137static inline void sk_refcnt_debug_inc(struct sock *sk)
1138{
1139 atomic_inc(&sk->sk_prot->socks);
1140}
1141
1142static inline void sk_refcnt_debug_dec(struct sock *sk)
1143{
1144 atomic_dec(&sk->sk_prot->socks);
1145 printk(KERN_DEBUG "%s socket %p released, %d are still alive\n",
1146 sk->sk_prot->name, sk, atomic_read(&sk->sk_prot->socks));
1147}
1148
Ying Xuedec34fb2013-02-15 22:28:25 +00001149static inline void sk_refcnt_debug_release(const struct sock *sk)
Arnaldo Carvalho de Meloe6848972005-08-09 19:45:38 -07001150{
Reshetova, Elena41c6d652017-06-30 13:08:01 +03001151 if (refcount_read(&sk->sk_refcnt) != 1)
Arnaldo Carvalho de Meloe6848972005-08-09 19:45:38 -07001152 printk(KERN_DEBUG "Destruction of the %s socket %p delayed, refcnt=%d\n",
Reshetova, Elena41c6d652017-06-30 13:08:01 +03001153 sk->sk_prot->name, sk, refcount_read(&sk->sk_refcnt));
Arnaldo Carvalho de Meloe6848972005-08-09 19:45:38 -07001154}
1155#else /* SOCK_REFCNT_DEBUG */
1156#define sk_refcnt_debug_inc(sk) do { } while (0)
1157#define sk_refcnt_debug_dec(sk) do { } while (0)
1158#define sk_refcnt_debug_release(sk) do { } while (0)
1159#endif /* SOCK_REFCNT_DEBUG */
1160
Eric Dumazetc9bee3b72013-07-22 20:27:07 -07001161static inline bool sk_stream_memory_free(const struct sock *sk)
1162{
1163 if (sk->sk_wmem_queued >= sk->sk_sndbuf)
1164 return false;
1165
1166 return sk->sk_prot->stream_memory_free ?
1167 sk->sk_prot->stream_memory_free(sk) : true;
1168}
1169
Eric Dumazet64dc6132013-07-22 20:26:31 -07001170static inline bool sk_stream_is_writeable(const struct sock *sk)
1171{
Eric Dumazetc9bee3b72013-07-22 20:27:07 -07001172 return sk_stream_wspace(sk) >= sk_stream_min_wspace(sk) &&
1173 sk_stream_memory_free(sk);
Eric Dumazet64dc6132013-07-22 20:26:31 -07001174}
Glauber Costae1aab162011-12-11 21:47:03 +00001175
Daniel Borkmann54fd9c22016-08-18 01:00:41 +02001176static inline int sk_under_cgroup_hierarchy(struct sock *sk,
1177 struct cgroup *ancestor)
1178{
1179#ifdef CONFIG_SOCK_CGROUP_DATA
1180 return cgroup_is_descendant(sock_cgroup_ptr(&sk->sk_cgrp_data),
1181 ancestor);
1182#else
1183 return -ENOTSUPP;
1184#endif
1185}
Eric Dumazetc9bee3b72013-07-22 20:27:07 -07001186
Glauber Costa180d8cd2011-12-11 21:47:02 +00001187static inline bool sk_has_memory_pressure(const struct sock *sk)
1188{
1189 return sk->sk_prot->memory_pressure != NULL;
1190}
1191
1192static inline bool sk_under_memory_pressure(const struct sock *sk)
1193{
1194 if (!sk->sk_prot->memory_pressure)
1195 return false;
Glauber Costae1aab162011-12-11 21:47:03 +00001196
Johannes Weinerbaac50b2016-01-14 15:21:17 -08001197 if (mem_cgroup_sockets_enabled && sk->sk_memcg &&
1198 mem_cgroup_under_socket_pressure(sk->sk_memcg))
Johannes Weinere8056052016-01-14 15:21:14 -08001199 return true;
Glauber Costae1aab162011-12-11 21:47:03 +00001200
Christoph Paasch35b87f62013-10-23 12:49:21 -07001201 return !!*sk->sk_prot->memory_pressure;
Glauber Costa180d8cd2011-12-11 21:47:02 +00001202}
1203
Glauber Costa180d8cd2011-12-11 21:47:02 +00001204static inline long
1205sk_memory_allocated(const struct sock *sk)
1206{
Johannes Weinere8056052016-01-14 15:21:14 -08001207 return atomic_long_read(sk->sk_prot->memory_allocated);
Glauber Costa180d8cd2011-12-11 21:47:02 +00001208}
1209
1210static inline long
Johannes Weinere8056052016-01-14 15:21:14 -08001211sk_memory_allocated_add(struct sock *sk, int amt)
Glauber Costa180d8cd2011-12-11 21:47:02 +00001212{
Johannes Weinere8056052016-01-14 15:21:14 -08001213 return atomic_long_add_return(amt, sk->sk_prot->memory_allocated);
Glauber Costa180d8cd2011-12-11 21:47:02 +00001214}
1215
1216static inline void
Glauber Costa0e90b312012-01-20 04:57:16 +00001217sk_memory_allocated_sub(struct sock *sk, int amt)
Glauber Costa180d8cd2011-12-11 21:47:02 +00001218{
Johannes Weinere8056052016-01-14 15:21:14 -08001219 atomic_long_sub(amt, sk->sk_prot->memory_allocated);
Glauber Costa180d8cd2011-12-11 21:47:02 +00001220}
1221
1222static inline void sk_sockets_allocated_dec(struct sock *sk)
1223{
Johannes Weineraf95d7d2016-01-14 15:21:08 -08001224 percpu_counter_dec(sk->sk_prot->sockets_allocated);
Glauber Costa180d8cd2011-12-11 21:47:02 +00001225}
1226
1227static inline void sk_sockets_allocated_inc(struct sock *sk)
1228{
Johannes Weineraf95d7d2016-01-14 15:21:08 -08001229 percpu_counter_inc(sk->sk_prot->sockets_allocated);
Glauber Costa180d8cd2011-12-11 21:47:02 +00001230}
1231
1232static inline int
1233sk_sockets_allocated_read_positive(struct sock *sk)
1234{
Johannes Weineraf95d7d2016-01-14 15:21:08 -08001235 return percpu_counter_read_positive(sk->sk_prot->sockets_allocated);
Glauber Costa180d8cd2011-12-11 21:47:02 +00001236}
1237
1238static inline int
1239proto_sockets_allocated_sum_positive(struct proto *prot)
1240{
1241 return percpu_counter_sum_positive(prot->sockets_allocated);
1242}
1243
1244static inline long
1245proto_memory_allocated(struct proto *prot)
1246{
1247 return atomic_long_read(prot->memory_allocated);
1248}
1249
1250static inline bool
1251proto_memory_pressure(struct proto *prot)
1252{
1253 if (!prot->memory_pressure)
1254 return false;
1255 return !!*prot->memory_pressure;
1256}
1257
Eric Dumazet65f76512008-01-03 20:46:48 -08001258
1259#ifdef CONFIG_PROC_FS
Linus Torvalds1da177e2005-04-16 15:20:36 -07001260/* Called with local bh disabled */
Joe Perches69336bd2013-09-22 10:32:26 -07001261void sock_prot_inuse_add(struct net *net, struct proto *prot, int inc);
1262int sock_prot_inuse_get(struct net *net, struct proto *proto);
Eric Dumazet65f76512008-01-03 20:46:48 -08001263#else
Eric Dumazetdc6b9b72012-05-16 22:48:15 +00001264static inline void sock_prot_inuse_add(struct net *net, struct proto *prot,
Pavel Emelyanovc29a0bc2008-03-31 19:41:46 -07001265 int inc)
Eric Dumazet65f76512008-01-03 20:46:48 -08001266{
1267}
Eric Dumazet65f76512008-01-03 20:46:48 -08001268#endif
1269
Linus Torvalds1da177e2005-04-16 15:20:36 -07001270
Arnaldo Carvalho de Melo614c6cb2005-08-09 19:47:37 -07001271/* With per-bucket locks this operation is not-atomic, so that
1272 * this version is not worse.
1273 */
Craig Gallek086c6532016-02-10 11:50:35 -05001274static inline int __sk_prot_rehash(struct sock *sk)
Arnaldo Carvalho de Melo614c6cb2005-08-09 19:47:37 -07001275{
1276 sk->sk_prot->unhash(sk);
Craig Gallek086c6532016-02-10 11:50:35 -05001277 return sk->sk_prot->hash(sk);
Arnaldo Carvalho de Melo614c6cb2005-08-09 19:47:37 -07001278}
1279
Linus Torvalds1da177e2005-04-16 15:20:36 -07001280/* About 10 seconds */
1281#define SOCK_DESTROY_TIME (10*HZ)
1282
1283/* Sockets 0-1023 can't be bound to unless you are superuser */
1284#define PROT_SOCK 1024
1285
1286#define SHUTDOWN_MASK 3
1287#define RCV_SHUTDOWN 1
1288#define SEND_SHUTDOWN 2
1289
1290#define SOCK_SNDBUF_LOCK 1
1291#define SOCK_RCVBUF_LOCK 2
1292#define SOCK_BINDADDR_LOCK 4
1293#define SOCK_BINDPORT_LOCK 8
1294
Linus Torvalds1da177e2005-04-16 15:20:36 -07001295struct socket_alloc {
1296 struct socket socket;
1297 struct inode vfs_inode;
1298};
1299
1300static inline struct socket *SOCKET_I(struct inode *inode)
1301{
1302 return &container_of(inode, struct socket_alloc, vfs_inode)->socket;
1303}
1304
1305static inline struct inode *SOCK_INODE(struct socket *socket)
1306{
1307 return &container_of(socket, struct socket_alloc, socket)->vfs_inode;
1308}
1309
Hideo Aoki3ab224b2007-12-31 00:11:19 -08001310/*
1311 * Functions for memory accounting
1312 */
Paolo Abenif8c3bf02016-10-21 13:55:45 +02001313int __sk_mem_raise_allocated(struct sock *sk, int size, int amt, int kind);
Joe Perches69336bd2013-09-22 10:32:26 -07001314int __sk_mem_schedule(struct sock *sk, int size, int kind);
Paolo Abenif8c3bf02016-10-21 13:55:45 +02001315void __sk_mem_reduce_allocated(struct sock *sk, int amount);
Eric Dumazet1a24e042015-05-15 12:39:25 -07001316void __sk_mem_reclaim(struct sock *sk, int amount);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001317
Eric Dumazetbd68a2a2016-10-31 13:32:55 -07001318/* We used to have PAGE_SIZE here, but systems with 64KB pages
1319 * do not necessarily have 16x time more memory than 4KB ones.
1320 */
1321#define SK_MEM_QUANTUM 4096
Hideo Aoki3ab224b2007-12-31 00:11:19 -08001322#define SK_MEM_QUANTUM_SHIFT ilog2(SK_MEM_QUANTUM)
1323#define SK_MEM_SEND 0
1324#define SK_MEM_RECV 1
Linus Torvalds1da177e2005-04-16 15:20:36 -07001325
Eric Dumazetbd68a2a2016-10-31 13:32:55 -07001326/* sysctl_mem values are in pages, we convert them in SK_MEM_QUANTUM units */
1327static inline long sk_prot_mem_limits(const struct sock *sk, int index)
1328{
1329 long val = sk->sk_prot->sysctl_mem[index];
1330
1331#if PAGE_SIZE > SK_MEM_QUANTUM
1332 val <<= PAGE_SHIFT - SK_MEM_QUANTUM_SHIFT;
1333#elif PAGE_SIZE < SK_MEM_QUANTUM
1334 val >>= SK_MEM_QUANTUM_SHIFT - PAGE_SHIFT;
1335#endif
1336 return val;
1337}
1338
Hideo Aoki3ab224b2007-12-31 00:11:19 -08001339static inline int sk_mem_pages(int amt)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001340{
Hideo Aoki3ab224b2007-12-31 00:11:19 -08001341 return (amt + SK_MEM_QUANTUM - 1) >> SK_MEM_QUANTUM_SHIFT;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001342}
1343
Eric Dumazetdc6b9b72012-05-16 22:48:15 +00001344static inline bool sk_has_account(struct sock *sk)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001345{
Hideo Aoki3ab224b2007-12-31 00:11:19 -08001346 /* return true if protocol supports memory accounting */
1347 return !!sk->sk_prot->memory_allocated;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001348}
1349
Eric Dumazetdc6b9b72012-05-16 22:48:15 +00001350static inline bool sk_wmem_schedule(struct sock *sk, int size)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001351{
Hideo Aoki3ab224b2007-12-31 00:11:19 -08001352 if (!sk_has_account(sk))
Eric Dumazetdc6b9b72012-05-16 22:48:15 +00001353 return true;
Herbert Xud80d99d62005-09-01 17:48:23 -07001354 return size <= sk->sk_forward_alloc ||
Hideo Aoki3ab224b2007-12-31 00:11:19 -08001355 __sk_mem_schedule(sk, size, SK_MEM_SEND);
1356}
1357
Mel Gormanc76562b2012-07-31 16:44:41 -07001358static inline bool
Chuck Lever35c448a2012-09-17 14:09:11 -07001359sk_rmem_schedule(struct sock *sk, struct sk_buff *skb, int size)
Hideo Aoki3ab224b2007-12-31 00:11:19 -08001360{
1361 if (!sk_has_account(sk))
Eric Dumazetdc6b9b72012-05-16 22:48:15 +00001362 return true;
Mel Gormanc76562b2012-07-31 16:44:41 -07001363 return size<= sk->sk_forward_alloc ||
1364 __sk_mem_schedule(sk, size, SK_MEM_RECV) ||
1365 skb_pfmemalloc(skb);
Hideo Aoki3ab224b2007-12-31 00:11:19 -08001366}
1367
1368static inline void sk_mem_reclaim(struct sock *sk)
1369{
1370 if (!sk_has_account(sk))
1371 return;
1372 if (sk->sk_forward_alloc >= SK_MEM_QUANTUM)
Eric Dumazet1a24e042015-05-15 12:39:25 -07001373 __sk_mem_reclaim(sk, sk->sk_forward_alloc);
Hideo Aoki3ab224b2007-12-31 00:11:19 -08001374}
1375
David S. Miller9993e7d2008-01-10 21:56:38 -08001376static inline void sk_mem_reclaim_partial(struct sock *sk)
1377{
1378 if (!sk_has_account(sk))
1379 return;
1380 if (sk->sk_forward_alloc > SK_MEM_QUANTUM)
Eric Dumazet1a24e042015-05-15 12:39:25 -07001381 __sk_mem_reclaim(sk, sk->sk_forward_alloc - 1);
David S. Miller9993e7d2008-01-10 21:56:38 -08001382}
1383
Hideo Aoki3ab224b2007-12-31 00:11:19 -08001384static inline void sk_mem_charge(struct sock *sk, int size)
1385{
1386 if (!sk_has_account(sk))
1387 return;
1388 sk->sk_forward_alloc -= size;
1389}
1390
1391static inline void sk_mem_uncharge(struct sock *sk, int size)
1392{
1393 if (!sk_has_account(sk))
1394 return;
1395 sk->sk_forward_alloc += size;
Eric Dumazet20c64d52016-09-15 08:48:46 -07001396
1397 /* Avoid a possible overflow.
1398 * TCP send queues can make this happen, if sk_mem_reclaim()
1399 * is not called and more than 2 GBytes are released at once.
1400 *
1401 * If we reach 2 MBytes, reclaim 1 MBytes right now, there is
1402 * no need to hold that much forward allocation anyway.
1403 */
1404 if (unlikely(sk->sk_forward_alloc >= 1 << 21))
1405 __sk_mem_reclaim(sk, 1 << 20);
Hideo Aoki3ab224b2007-12-31 00:11:19 -08001406}
1407
1408static inline void sk_wmem_free_skb(struct sock *sk, struct sk_buff *skb)
1409{
Hideo Aoki3ab224b2007-12-31 00:11:19 -08001410 sock_set_flag(sk, SOCK_QUEUE_SHRUNK);
1411 sk->sk_wmem_queued -= skb->truesize;
1412 sk_mem_uncharge(sk, skb->truesize);
1413 __kfree_skb(skb);
Herbert Xud80d99d62005-09-01 17:48:23 -07001414}
1415
Eric Dumazetc3f9b012014-03-10 09:50:11 -07001416static inline void sock_release_ownership(struct sock *sk)
1417{
Hannes Frederic Sowa61881cf2016-04-05 17:10:14 +02001418 if (sk->sk_lock.owned) {
1419 sk->sk_lock.owned = 0;
1420
1421 /* The sk_lock has mutex_unlock() semantics: */
1422 mutex_release(&sk->sk_lock.dep_map, 1, _RET_IP_);
1423 }
Eric Dumazetc3f9b012014-03-10 09:50:11 -07001424}
1425
Peter Zijlstraed075362006-12-06 20:35:24 -08001426/*
1427 * Macro so as to not evaluate some arguments when
1428 * lockdep is not enabled.
1429 *
1430 * Mark both the sk_lock and the sk_lock.slock as a
1431 * per-address-family lock class.
1432 */
Eric Dumazetdc6b9b72012-05-16 22:48:15 +00001433#define sock_lock_init_class_and_name(sk, sname, skey, name, key) \
Peter Zijlstraed075362006-12-06 20:35:24 -08001434do { \
Ingo Molnare8f6fbf2008-11-12 01:38:36 +00001435 sk->sk_lock.owned = 0; \
Peter Zijlstraed075362006-12-06 20:35:24 -08001436 init_waitqueue_head(&sk->sk_lock.wq); \
1437 spin_lock_init(&(sk)->sk_lock.slock); \
1438 debug_check_no_locks_freed((void *)&(sk)->sk_lock, \
1439 sizeof((sk)->sk_lock)); \
1440 lockdep_set_class_and_name(&(sk)->sk_lock.slock, \
Eric Dumazetdc6b9b72012-05-16 22:48:15 +00001441 (skey), (sname)); \
Peter Zijlstraed075362006-12-06 20:35:24 -08001442 lockdep_init_map(&(sk)->sk_lock.dep_map, (name), (key), 0); \
1443} while (0)
1444
David S. Millerb33b0a12016-04-07 20:40:25 -04001445#ifdef CONFIG_LOCKDEP
Hannes Frederic Sowa03be9822016-04-07 23:53:35 +02001446static inline bool lockdep_sock_is_held(const struct sock *csk)
Hannes Frederic Sowa1e1d04e2016-04-05 17:10:15 +02001447{
1448 struct sock *sk = (struct sock *)csk;
1449
1450 return lockdep_is_held(&sk->sk_lock) ||
1451 lockdep_is_held(&sk->sk_lock.slock);
1452}
David S. Millerb33b0a12016-04-07 20:40:25 -04001453#endif
Hannes Frederic Sowa1e1d04e2016-04-05 17:10:15 +02001454
Joe Perches69336bd2013-09-22 10:32:26 -07001455void lock_sock_nested(struct sock *sk, int subclass);
Peter Zijlstrafcc70d52006-11-08 22:44:35 -08001456
1457static inline void lock_sock(struct sock *sk)
1458{
1459 lock_sock_nested(sk, 0);
1460}
1461
Joe Perches69336bd2013-09-22 10:32:26 -07001462void release_sock(struct sock *sk);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001463
1464/* BH context may only use the following locking interface. */
1465#define bh_lock_sock(__sk) spin_lock(&((__sk)->sk_lock.slock))
Ingo Molnarc6366182006-07-03 00:25:13 -07001466#define bh_lock_sock_nested(__sk) \
1467 spin_lock_nested(&((__sk)->sk_lock.slock), \
1468 SINGLE_DEPTH_NESTING)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001469#define bh_unlock_sock(__sk) spin_unlock(&((__sk)->sk_lock.slock))
1470
Joe Perches69336bd2013-09-22 10:32:26 -07001471bool lock_sock_fast(struct sock *sk);
Eric Dumazet8a74ad62010-05-26 19:20:18 +00001472/**
1473 * unlock_sock_fast - complement of lock_sock_fast
1474 * @sk: socket
1475 * @slow: slow mode
1476 *
1477 * fast unlock socket for user context.
1478 * If slow mode is on, we call regular release_sock()
1479 */
1480static inline void unlock_sock_fast(struct sock *sk, bool slow)
Eric Dumazet4b0b72f2010-04-28 14:35:48 -07001481{
Eric Dumazet8a74ad62010-05-26 19:20:18 +00001482 if (slow)
1483 release_sock(sk);
1484 else
1485 spin_unlock_bh(&sk->sk_lock.slock);
Eric Dumazet4b0b72f2010-04-28 14:35:48 -07001486}
1487
Hannes Frederic Sowafafc4e12016-04-08 15:11:27 +02001488/* Used by processes to "lock" a socket state, so that
1489 * interrupts and bottom half handlers won't change it
1490 * from under us. It essentially blocks any incoming
1491 * packets, so that we won't get any new data or any
1492 * packets that change the state of the socket.
1493 *
1494 * While locked, BH processing will add new packets to
1495 * the backlog queue. This queue is processed by the
1496 * owner of the socket lock right before it is released.
1497 *
1498 * Since ~2.3.5 it is also exclusive sleep lock serializing
1499 * accesses from user process context.
1500 */
1501
Eric Dumazet46cc6e42016-05-03 16:56:03 -07001502static inline void sock_owned_by_me(const struct sock *sk)
Hannes Frederic Sowafafc4e12016-04-08 15:11:27 +02001503{
1504#ifdef CONFIG_LOCKDEP
Eric Dumazet5e91f6c2016-04-25 06:34:09 -07001505 WARN_ON_ONCE(!lockdep_sock_is_held(sk) && debug_locks);
Hannes Frederic Sowafafc4e12016-04-08 15:11:27 +02001506#endif
Eric Dumazet46cc6e42016-05-03 16:56:03 -07001507}
1508
1509static inline bool sock_owned_by_user(const struct sock *sk)
1510{
1511 sock_owned_by_me(sk);
Hannes Frederic Sowafafc4e12016-04-08 15:11:27 +02001512 return sk->sk_lock.owned;
1513}
1514
1515/* no reclassification while locks are held */
1516static inline bool sock_allow_reclassification(const struct sock *csk)
1517{
1518 struct sock *sk = (struct sock *)csk;
1519
1520 return !sk->sk_lock.owned && !spin_is_locked(&sk->sk_lock.slock);
1521}
Eric Dumazet4b0b72f2010-04-28 14:35:48 -07001522
Joe Perches69336bd2013-09-22 10:32:26 -07001523struct sock *sk_alloc(struct net *net, int family, gfp_t priority,
Eric W. Biederman11aa9c22015-05-08 21:09:13 -05001524 struct proto *prot, int kern);
Joe Perches69336bd2013-09-22 10:32:26 -07001525void sk_free(struct sock *sk);
Craig Gallekeb4cb002015-06-15 11:26:18 -04001526void sk_destruct(struct sock *sk);
Joe Perches69336bd2013-09-22 10:32:26 -07001527struct sock *sk_clone_lock(const struct sock *sk, const gfp_t priority);
Arnaldo Carvalho de Melo94352d42017-03-01 16:35:08 -03001528void sk_free_unlock_clone(struct sock *sk);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001529
Joe Perches69336bd2013-09-22 10:32:26 -07001530struct sk_buff *sock_wmalloc(struct sock *sk, unsigned long size, int force,
1531 gfp_t priority);
Eric Dumazet1d2077a2016-05-02 10:56:27 -07001532void __sock_wfree(struct sk_buff *skb);
Joe Perches69336bd2013-09-22 10:32:26 -07001533void sock_wfree(struct sk_buff *skb);
1534void skb_orphan_partial(struct sk_buff *skb);
1535void sock_rfree(struct sk_buff *skb);
Alexander Duyck62bccb82014-09-04 13:31:35 -04001536void sock_efree(struct sk_buff *skb);
Alexander Duyck82eabd92014-09-04 13:32:11 -04001537#ifdef CONFIG_INET
Joe Perches69336bd2013-09-22 10:32:26 -07001538void sock_edemux(struct sk_buff *skb);
Alexander Duyck82eabd92014-09-04 13:32:11 -04001539#else
Eric Dumazet158f3232017-01-27 07:11:27 -08001540#define sock_edemux sock_efree
Alexander Duyck82eabd92014-09-04 13:32:11 -04001541#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -07001542
Joe Perches69336bd2013-09-22 10:32:26 -07001543int sock_setsockopt(struct socket *sock, int level, int op,
1544 char __user *optval, unsigned int optlen);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001545
Joe Perches69336bd2013-09-22 10:32:26 -07001546int sock_getsockopt(struct socket *sock, int level, int op,
1547 char __user *optval, int __user *optlen);
1548struct sk_buff *sock_alloc_send_skb(struct sock *sk, unsigned long size,
1549 int noblock, int *errcode);
1550struct sk_buff *sock_alloc_send_pskb(struct sock *sk, unsigned long header_len,
1551 unsigned long data_len, int noblock,
1552 int *errcode, int max_page_order);
1553void *sock_kmalloc(struct sock *sk, int size, gfp_t priority);
1554void sock_kfree_s(struct sock *sk, void *mem, int size);
Daniel Borkmann79e88652014-11-19 17:13:11 +01001555void sock_kzfree_s(struct sock *sk, void *mem, int size);
Joe Perches69336bd2013-09-22 10:32:26 -07001556void sk_send_sigurg(struct sock *sk);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001557
Edward Jeef28ea362015-10-08 14:56:48 -07001558struct sockcm_cookie {
1559 u32 mark;
Soheil Hassas Yeganeh3dd17e62016-04-02 23:08:09 -04001560 u16 tsflags;
Edward Jeef28ea362015-10-08 14:56:48 -07001561};
1562
Willem de Bruijn39771b12016-04-02 23:08:06 -04001563int __sock_cmsg_send(struct sock *sk, struct msghdr *msg, struct cmsghdr *cmsg,
1564 struct sockcm_cookie *sockc);
Edward Jeef28ea362015-10-08 14:56:48 -07001565int sock_cmsg_send(struct sock *sk, struct msghdr *msg,
1566 struct sockcm_cookie *sockc);
1567
Linus Torvalds1da177e2005-04-16 15:20:36 -07001568/*
1569 * Functions to fill in entries in struct proto_ops when a protocol
1570 * does not implement a particular function.
1571 */
Joe Perches69336bd2013-09-22 10:32:26 -07001572int sock_no_bind(struct socket *, struct sockaddr *, int);
1573int sock_no_connect(struct socket *, struct sockaddr *, int, int);
1574int sock_no_socketpair(struct socket *, struct socket *);
David Howellscdfbabf2017-03-09 08:09:05 +00001575int sock_no_accept(struct socket *, struct socket *, int, bool);
Joe Perches69336bd2013-09-22 10:32:26 -07001576int sock_no_getname(struct socket *, struct sockaddr *, int *, int);
1577unsigned int sock_no_poll(struct file *, struct socket *,
1578 struct poll_table_struct *);
1579int sock_no_ioctl(struct socket *, unsigned int, unsigned long);
1580int sock_no_listen(struct socket *, int);
1581int sock_no_shutdown(struct socket *, int);
1582int sock_no_getsockopt(struct socket *, int , int, char __user *, int __user *);
1583int sock_no_setsockopt(struct socket *, int, int, char __user *, unsigned int);
Ying Xue1b784142015-03-02 15:37:48 +08001584int sock_no_sendmsg(struct socket *, struct msghdr *, size_t);
1585int sock_no_recvmsg(struct socket *, struct msghdr *, size_t, int);
Joe Perches69336bd2013-09-22 10:32:26 -07001586int sock_no_mmap(struct file *file, struct socket *sock,
1587 struct vm_area_struct *vma);
1588ssize_t sock_no_sendpage(struct socket *sock, struct page *page, int offset,
1589 size_t size, int flags);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001590
1591/*
1592 * Functions to fill in entries in struct proto_ops when a protocol
1593 * uses the inet style.
1594 */
Joe Perches69336bd2013-09-22 10:32:26 -07001595int sock_common_getsockopt(struct socket *sock, int level, int optname,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001596 char __user *optval, int __user *optlen);
Ying Xue1b784142015-03-02 15:37:48 +08001597int sock_common_recvmsg(struct socket *sock, struct msghdr *msg, size_t size,
1598 int flags);
Joe Perches69336bd2013-09-22 10:32:26 -07001599int sock_common_setsockopt(struct socket *sock, int level, int optname,
David S. Millerb7058842009-09-30 16:12:20 -07001600 char __user *optval, unsigned int optlen);
Joe Perches69336bd2013-09-22 10:32:26 -07001601int compat_sock_common_getsockopt(struct socket *sock, int level,
Dmitry Mishin3fdadf72006-03-20 22:45:21 -08001602 int optname, char __user *optval, int __user *optlen);
Joe Perches69336bd2013-09-22 10:32:26 -07001603int compat_sock_common_setsockopt(struct socket *sock, int level,
David S. Millerb7058842009-09-30 16:12:20 -07001604 int optname, char __user *optval, unsigned int optlen);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001605
Joe Perches69336bd2013-09-22 10:32:26 -07001606void sk_common_release(struct sock *sk);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001607
1608/*
1609 * Default socket callbacks and setup code
1610 */
Eric Dumazetdc6b9b72012-05-16 22:48:15 +00001611
Linus Torvalds1da177e2005-04-16 15:20:36 -07001612/* Initialise core socket variables */
Joe Perches69336bd2013-09-22 10:32:26 -07001613void sock_init_data(struct socket *sock, struct sock *sk);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001614
Linus Torvalds1da177e2005-04-16 15:20:36 -07001615/*
1616 * Socket reference counting postulates.
1617 *
1618 * * Each user of socket SHOULD hold a reference count.
1619 * * Each access point to socket (an hash table bucket, reference from a list,
1620 * running timer, skb in flight MUST hold a reference count.
1621 * * When reference count hits 0, it means it will never increase back.
1622 * * When reference count hits 0, it means that no references from
1623 * outside exist to this socket and current process on current CPU
1624 * is last user and may/should destroy this socket.
1625 * * sk_free is called from any context: process, BH, IRQ. When
1626 * it is called, socket has no references from outside -> sk_free
1627 * may release descendant resources allocated by the socket, but
1628 * to the time when it is called, socket is NOT referenced by any
1629 * hash tables, lists etc.
1630 * * Packets, delivered from outside (from network or from another process)
1631 * and enqueued on receive/error queues SHOULD NOT grab reference count,
1632 * when they sit in queue. Otherwise, packets will leak to hole, when
1633 * socket is looked up by one cpu and unhasing is made by another CPU.
1634 * It is true for udp/raw, netlink (leak to receive and error queues), tcp
1635 * (leak to backlog). Packet socket does all the processing inside
1636 * BR_NETPROTO_LOCK, so that it has not this race condition. UNIX sockets
1637 * use separate SMP lock, so that they are prone too.
1638 */
1639
1640/* Ungrab socket and destroy it, if it was the last reference. */
1641static inline void sock_put(struct sock *sk)
1642{
Reshetova, Elena41c6d652017-06-30 13:08:01 +03001643 if (refcount_dec_and_test(&sk->sk_refcnt))
Linus Torvalds1da177e2005-04-16 15:20:36 -07001644 sk_free(sk);
1645}
Eric Dumazet05dbc7b2013-10-03 00:22:02 -07001646/* Generic version of sock_put(), dealing with all sockets
Eric Dumazet41b822c2015-03-12 16:44:08 -07001647 * (TCP_TIMEWAIT, TCP_NEW_SYN_RECV, ESTABLISHED...)
Eric Dumazet05dbc7b2013-10-03 00:22:02 -07001648 */
1649void sock_gen_put(struct sock *sk);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001650
Willem de Bruijn4f0c40d92016-07-12 18:18:57 -04001651int __sk_receive_skb(struct sock *sk, struct sk_buff *skb, const int nested,
Eric Dumazetc3f24cf2016-11-02 17:14:41 -07001652 unsigned int trim_cap, bool refcounted);
Willem de Bruijn4f0c40d92016-07-12 18:18:57 -04001653static inline int sk_receive_skb(struct sock *sk, struct sk_buff *skb,
1654 const int nested)
1655{
Eric Dumazetc3f24cf2016-11-02 17:14:41 -07001656 return __sk_receive_skb(sk, skb, nested, 1, true);
Willem de Bruijn4f0c40d92016-07-12 18:18:57 -04001657}
Arnaldo Carvalho de Melo25995ff2005-12-27 02:42:22 -02001658
Krishna Kumare022f0b2009-10-19 23:46:20 +00001659static inline void sk_tx_queue_set(struct sock *sk, int tx_queue)
1660{
1661 sk->sk_tx_queue_mapping = tx_queue;
1662}
1663
1664static inline void sk_tx_queue_clear(struct sock *sk)
1665{
1666 sk->sk_tx_queue_mapping = -1;
1667}
1668
1669static inline int sk_tx_queue_get(const struct sock *sk)
1670{
Tom Herbertb0f77d02010-07-14 20:50:29 -07001671 return sk ? sk->sk_tx_queue_mapping : -1;
Krishna Kumare022f0b2009-10-19 23:46:20 +00001672}
1673
David S. Miller972692e2008-06-17 22:41:38 -07001674static inline void sk_set_socket(struct sock *sk, struct socket *sock)
1675{
Krishna Kumare022f0b2009-10-19 23:46:20 +00001676 sk_tx_queue_clear(sk);
David S. Miller972692e2008-06-17 22:41:38 -07001677 sk->sk_socket = sock;
1678}
1679
Eric Dumazetaa395142010-04-20 13:03:51 +00001680static inline wait_queue_head_t *sk_sleep(struct sock *sk)
1681{
Eric Dumazeteaefd112011-02-18 03:26:36 +00001682 BUILD_BUG_ON(offsetof(struct socket_wq, wait) != 0);
1683 return &rcu_dereference_raw(sk->sk_wq)->wait;
Eric Dumazetaa395142010-04-20 13:03:51 +00001684}
Linus Torvalds1da177e2005-04-16 15:20:36 -07001685/* Detach socket from process context.
1686 * Announce socket dead, detach it from wait queue and inode.
1687 * Note that parent inode held reference count on this struct sock,
1688 * we do not release it in this function, because protocol
1689 * probably wants some additional cleanups or even continuing
1690 * to work with this socket (TCP).
1691 */
1692static inline void sock_orphan(struct sock *sk)
1693{
1694 write_lock_bh(&sk->sk_callback_lock);
1695 sock_set_flag(sk, SOCK_DEAD);
David S. Miller972692e2008-06-17 22:41:38 -07001696 sk_set_socket(sk, NULL);
Eric Dumazet43815482010-04-29 11:01:49 +00001697 sk->sk_wq = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001698 write_unlock_bh(&sk->sk_callback_lock);
1699}
1700
1701static inline void sock_graft(struct sock *sk, struct socket *parent)
1702{
Sowmini Varadhan0ffdaf52017-07-06 08:15:07 -07001703 WARN_ON(parent->sk);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001704 write_lock_bh(&sk->sk_callback_lock);
Eric Dumazeteaefd112011-02-18 03:26:36 +00001705 sk->sk_wq = parent->wq;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001706 parent->sk = sk;
David S. Miller972692e2008-06-17 22:41:38 -07001707 sk_set_socket(sk, parent);
Lorenzo Colitti86741ec2016-11-04 02:23:41 +09001708 sk->sk_uid = SOCK_INODE(parent)->i_uid;
Venkat Yekkirala4237c752006-07-24 23:32:50 -07001709 security_sock_graft(sk, parent);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001710 write_unlock_bh(&sk->sk_callback_lock);
1711}
1712
Joe Perches69336bd2013-09-22 10:32:26 -07001713kuid_t sock_i_uid(struct sock *sk);
1714unsigned long sock_i_ino(struct sock *sk);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001715
Lorenzo Colitti86741ec2016-11-04 02:23:41 +09001716static inline kuid_t sock_net_uid(const struct net *net, const struct sock *sk)
1717{
1718 return sk ? sk->sk_uid : make_kuid(net->user_ns, 0);
1719}
1720
Eric Dumazet58d607d2015-09-15 15:24:20 -07001721static inline u32 net_tx_rndhash(void)
1722{
1723 u32 v = prandom_u32();
1724
1725 return v ?: 1;
1726}
1727
Tom Herbert877d1f62015-07-28 16:02:05 -07001728static inline void sk_set_txhash(struct sock *sk)
1729{
Eric Dumazet58d607d2015-09-15 15:24:20 -07001730 sk->sk_txhash = net_tx_rndhash();
Tom Herbert877d1f62015-07-28 16:02:05 -07001731}
1732
Tom Herbert265f94f2015-07-28 16:02:06 -07001733static inline void sk_rethink_txhash(struct sock *sk)
1734{
1735 if (sk->sk_txhash)
1736 sk_set_txhash(sk);
1737}
1738
Linus Torvalds1da177e2005-04-16 15:20:36 -07001739static inline struct dst_entry *
1740__sk_dst_get(struct sock *sk)
1741{
Hannes Frederic Sowa1e1d04e2016-04-05 17:10:15 +02001742 return rcu_dereference_check(sk->sk_dst_cache,
1743 lockdep_sock_is_held(sk));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001744}
1745
1746static inline struct dst_entry *
1747sk_dst_get(struct sock *sk)
1748{
1749 struct dst_entry *dst;
1750
Eric Dumazetb6c67122010-04-08 23:03:29 +00001751 rcu_read_lock();
1752 dst = rcu_dereference(sk->sk_dst_cache);
Eric Dumazetf8864972014-06-24 10:05:11 -07001753 if (dst && !atomic_inc_not_zero(&dst->__refcnt))
1754 dst = NULL;
Eric Dumazetb6c67122010-04-08 23:03:29 +00001755 rcu_read_unlock();
Linus Torvalds1da177e2005-04-16 15:20:36 -07001756 return dst;
1757}
1758
Eric Dumazetb6c67122010-04-08 23:03:29 +00001759static inline void dst_negative_advice(struct sock *sk)
1760{
1761 struct dst_entry *ndst, *dst = __sk_dst_get(sk);
1762
Tom Herbert265f94f2015-07-28 16:02:06 -07001763 sk_rethink_txhash(sk);
1764
Eric Dumazetb6c67122010-04-08 23:03:29 +00001765 if (dst && dst->ops->negative_advice) {
1766 ndst = dst->ops->negative_advice(dst);
1767
1768 if (ndst != dst) {
1769 rcu_assign_pointer(sk->sk_dst_cache, ndst);
ZHAO Gang0a6957e2013-10-22 16:23:38 +08001770 sk_tx_queue_clear(sk);
Julian Anastasov9b8805a2017-02-06 23:14:11 +02001771 sk->sk_dst_pending_confirm = 0;
Eric Dumazetb6c67122010-04-08 23:03:29 +00001772 }
1773 }
1774}
1775
Linus Torvalds1da177e2005-04-16 15:20:36 -07001776static inline void
1777__sk_dst_set(struct sock *sk, struct dst_entry *dst)
1778{
1779 struct dst_entry *old_dst;
1780
Krishna Kumare022f0b2009-10-19 23:46:20 +00001781 sk_tx_queue_clear(sk);
Julian Anastasov9b8805a2017-02-06 23:14:11 +02001782 sk->sk_dst_pending_confirm = 0;
Eric Dumazet95964c62017-03-06 11:23:55 -08001783 old_dst = rcu_dereference_protected(sk->sk_dst_cache,
1784 lockdep_sock_is_held(sk));
Eric Dumazetb6c67122010-04-08 23:03:29 +00001785 rcu_assign_pointer(sk->sk_dst_cache, dst);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001786 dst_release(old_dst);
1787}
1788
1789static inline void
1790sk_dst_set(struct sock *sk, struct dst_entry *dst)
1791{
Eric Dumazet7f502362014-06-30 01:26:23 -07001792 struct dst_entry *old_dst;
1793
1794 sk_tx_queue_clear(sk);
Julian Anastasov9b8805a2017-02-06 23:14:11 +02001795 sk->sk_dst_pending_confirm = 0;
Eric Dumazet5925a052014-07-02 02:39:38 -07001796 old_dst = xchg((__force struct dst_entry **)&sk->sk_dst_cache, dst);
Eric Dumazet7f502362014-06-30 01:26:23 -07001797 dst_release(old_dst);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001798}
1799
1800static inline void
1801__sk_dst_reset(struct sock *sk)
1802{
Eric Dumazetb6c67122010-04-08 23:03:29 +00001803 __sk_dst_set(sk, NULL);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001804}
1805
1806static inline void
1807sk_dst_reset(struct sock *sk)
1808{
Eric Dumazet7f502362014-06-30 01:26:23 -07001809 sk_dst_set(sk, NULL);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001810}
1811
Joe Perches69336bd2013-09-22 10:32:26 -07001812struct dst_entry *__sk_dst_check(struct sock *sk, u32 cookie);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001813
Joe Perches69336bd2013-09-22 10:32:26 -07001814struct dst_entry *sk_dst_check(struct sock *sk, u32 cookie);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001815
Julian Anastasov9b8805a2017-02-06 23:14:11 +02001816static inline void sk_dst_confirm(struct sock *sk)
1817{
1818 if (!sk->sk_dst_pending_confirm)
1819 sk->sk_dst_pending_confirm = 1;
1820}
1821
Julian Anastasov4ff06202017-02-06 23:14:12 +02001822static inline void sock_confirm_neigh(struct sk_buff *skb, struct neighbour *n)
1823{
1824 if (skb_get_dst_pending_confirm(skb)) {
1825 struct sock *sk = skb->sk;
1826 unsigned long now = jiffies;
1827
1828 /* avoid dirtying neighbour */
1829 if (n->confirmed != now)
1830 n->confirmed = now;
1831 if (sk && sk->sk_dst_pending_confirm)
1832 sk->sk_dst_pending_confirm = 0;
1833 }
1834}
1835
hannes@stressinduktion.orgf60e5992015-04-01 17:07:44 +02001836bool sk_mc_loop(struct sock *sk);
1837
Eric Dumazetdc6b9b72012-05-16 22:48:15 +00001838static inline bool sk_can_gso(const struct sock *sk)
Herbert Xubcd76112006-06-30 13:36:35 -07001839{
1840 return net_gso_ok(sk->sk_route_caps, sk->sk_gso_type);
1841}
1842
Joe Perches69336bd2013-09-22 10:32:26 -07001843void sk_setup_caps(struct sock *sk, struct dst_entry *dst);
Arnaldo Carvalho de Melo6cbb0df2005-08-09 19:49:02 -07001844
Michał Mirosławc8f44af2011-11-15 15:29:55 +00001845static inline void sk_nocaps_add(struct sock *sk, netdev_features_t flags)
Eric Dumazeta4654192010-05-16 00:36:33 -07001846{
1847 sk->sk_route_nocaps |= flags;
1848 sk->sk_route_caps &= ~flags;
1849}
1850
Tom Herbert9a498502015-12-14 11:19:45 -08001851static inline bool sk_check_csum_caps(struct sock *sk)
1852{
1853 return (sk->sk_route_caps & NETIF_F_HW_CSUM) ||
1854 (sk->sk_family == PF_INET &&
1855 (sk->sk_route_caps & NETIF_F_IP_CSUM)) ||
1856 (sk->sk_family == PF_INET6 &&
1857 (sk->sk_route_caps & NETIF_F_IPV6_CSUM));
1858}
1859
Tom Herbertc6e1a0d2011-04-04 22:30:30 -07001860static inline int skb_do_copy_data_nocache(struct sock *sk, struct sk_buff *skb,
Al Viro57be5bd2014-11-28 13:40:20 -05001861 struct iov_iter *from, char *to,
Wei Yongjun912d3982011-04-06 18:40:12 +00001862 int copy, int offset)
Tom Herbertc6e1a0d2011-04-04 22:30:30 -07001863{
1864 if (skb->ip_summed == CHECKSUM_NONE) {
Al Viro57be5bd2014-11-28 13:40:20 -05001865 __wsum csum = 0;
Al Viro15e6cb42016-11-01 22:42:45 -04001866 if (!csum_and_copy_from_iter_full(to, copy, &csum, from))
Al Viro57be5bd2014-11-28 13:40:20 -05001867 return -EFAULT;
Wei Yongjun912d3982011-04-06 18:40:12 +00001868 skb->csum = csum_block_add(skb->csum, csum, offset);
Tom Herbertc6e1a0d2011-04-04 22:30:30 -07001869 } else if (sk->sk_route_caps & NETIF_F_NOCACHE_COPY) {
Al Viro15e6cb42016-11-01 22:42:45 -04001870 if (!copy_from_iter_full_nocache(to, copy, from))
Tom Herbertc6e1a0d2011-04-04 22:30:30 -07001871 return -EFAULT;
Al Viro15e6cb42016-11-01 22:42:45 -04001872 } else if (!copy_from_iter_full(to, copy, from))
Tom Herbertc6e1a0d2011-04-04 22:30:30 -07001873 return -EFAULT;
1874
1875 return 0;
1876}
1877
1878static inline int skb_add_data_nocache(struct sock *sk, struct sk_buff *skb,
Al Viro57be5bd2014-11-28 13:40:20 -05001879 struct iov_iter *from, int copy)
Tom Herbertc6e1a0d2011-04-04 22:30:30 -07001880{
Wei Yongjun912d3982011-04-06 18:40:12 +00001881 int err, offset = skb->len;
Tom Herbertc6e1a0d2011-04-04 22:30:30 -07001882
Wei Yongjun912d3982011-04-06 18:40:12 +00001883 err = skb_do_copy_data_nocache(sk, skb, from, skb_put(skb, copy),
1884 copy, offset);
Tom Herbertc6e1a0d2011-04-04 22:30:30 -07001885 if (err)
Wei Yongjun912d3982011-04-06 18:40:12 +00001886 __skb_trim(skb, offset);
Tom Herbertc6e1a0d2011-04-04 22:30:30 -07001887
1888 return err;
1889}
1890
Al Viro57be5bd2014-11-28 13:40:20 -05001891static inline int skb_copy_to_page_nocache(struct sock *sk, struct iov_iter *from,
Tom Herbertc6e1a0d2011-04-04 22:30:30 -07001892 struct sk_buff *skb,
1893 struct page *page,
1894 int off, int copy)
1895{
1896 int err;
1897
Wei Yongjun912d3982011-04-06 18:40:12 +00001898 err = skb_do_copy_data_nocache(sk, skb, from, page_address(page) + off,
1899 copy, skb->len);
Tom Herbertc6e1a0d2011-04-04 22:30:30 -07001900 if (err)
1901 return err;
1902
1903 skb->len += copy;
1904 skb->data_len += copy;
1905 skb->truesize += copy;
1906 sk->sk_wmem_queued += copy;
1907 sk_mem_charge(sk, copy);
1908 return 0;
1909}
1910
Eric Dumazetc5640392009-06-16 10:12:03 +00001911/**
1912 * sk_wmem_alloc_get - returns write allocations
1913 * @sk: socket
1914 *
1915 * Returns sk_wmem_alloc minus initial offset of one
1916 */
1917static inline int sk_wmem_alloc_get(const struct sock *sk)
1918{
Reshetova, Elena14afee42017-06-30 13:08:00 +03001919 return refcount_read(&sk->sk_wmem_alloc) - 1;
Eric Dumazetc5640392009-06-16 10:12:03 +00001920}
1921
1922/**
1923 * sk_rmem_alloc_get - returns read allocations
1924 * @sk: socket
1925 *
1926 * Returns sk_rmem_alloc
1927 */
1928static inline int sk_rmem_alloc_get(const struct sock *sk)
1929{
1930 return atomic_read(&sk->sk_rmem_alloc);
1931}
1932
1933/**
1934 * sk_has_allocations - check if allocations are outstanding
1935 * @sk: socket
1936 *
1937 * Returns true if socket has write or read allocations
1938 */
Eric Dumazetdc6b9b72012-05-16 22:48:15 +00001939static inline bool sk_has_allocations(const struct sock *sk)
Eric Dumazetc5640392009-06-16 10:12:03 +00001940{
1941 return sk_wmem_alloc_get(sk) || sk_rmem_alloc_get(sk);
1942}
1943
Jiri Olsaa57de0b2009-07-08 12:09:13 +00001944/**
Herbert Xu1ce0bf52015-11-26 13:55:39 +08001945 * skwq_has_sleeper - check if there are any waiting processes
Randy Dunlapacfbe962010-05-24 23:54:18 -07001946 * @wq: struct socket_wq
Jiri Olsaa57de0b2009-07-08 12:09:13 +00001947 *
Eric Dumazet43815482010-04-29 11:01:49 +00001948 * Returns true if socket_wq has waiting processes
Jiri Olsaa57de0b2009-07-08 12:09:13 +00001949 *
Herbert Xu1ce0bf52015-11-26 13:55:39 +08001950 * The purpose of the skwq_has_sleeper and sock_poll_wait is to wrap the memory
Jiri Olsaa57de0b2009-07-08 12:09:13 +00001951 * barrier call. They were added due to the race found within the tcp code.
1952 *
Mauro Carvalho Chehabd6519832017-05-12 09:35:46 -03001953 * Consider following tcp code paths::
Jiri Olsaa57de0b2009-07-08 12:09:13 +00001954 *
Mauro Carvalho Chehabd6519832017-05-12 09:35:46 -03001955 * CPU1 CPU2
1956 * sys_select receive packet
Jiri Olsaa57de0b2009-07-08 12:09:13 +00001957 * ... ...
1958 * __add_wait_queue update tp->rcv_nxt
1959 * ... ...
1960 * tp->rcv_nxt check sock_def_readable
1961 * ... {
Eric Dumazet43815482010-04-29 11:01:49 +00001962 * schedule rcu_read_lock();
1963 * wq = rcu_dereference(sk->sk_wq);
1964 * if (wq && waitqueue_active(&wq->wait))
1965 * wake_up_interruptible(&wq->wait)
Jiri Olsaa57de0b2009-07-08 12:09:13 +00001966 * ...
1967 * }
1968 *
1969 * The race for tcp fires when the __add_wait_queue changes done by CPU1 stay
1970 * in its cache, and so does the tp->rcv_nxt update on CPU2 side. The CPU1
1971 * could then endup calling schedule and sleep forever if there are no more
1972 * data on the socket.
Jiri Olsaad462762009-07-08 12:10:31 +00001973 *
Jiri Olsaa57de0b2009-07-08 12:09:13 +00001974 */
Herbert Xu1ce0bf52015-11-26 13:55:39 +08001975static inline bool skwq_has_sleeper(struct socket_wq *wq)
Jiri Olsaa57de0b2009-07-08 12:09:13 +00001976{
Herbert Xu1ce0bf52015-11-26 13:55:39 +08001977 return wq && wq_has_sleeper(&wq->wait);
Jiri Olsaa57de0b2009-07-08 12:09:13 +00001978}
1979
1980/**
1981 * sock_poll_wait - place memory barrier behind the poll_wait call.
1982 * @filp: file
1983 * @wait_address: socket wait queue
1984 * @p: poll_table
1985 *
Eric Dumazet43815482010-04-29 11:01:49 +00001986 * See the comments in the wq_has_sleeper function.
Jiri Olsaa57de0b2009-07-08 12:09:13 +00001987 */
1988static inline void sock_poll_wait(struct file *filp,
1989 wait_queue_head_t *wait_address, poll_table *p)
1990{
Hans Verkuil626cf232012-03-23 15:02:27 -07001991 if (!poll_does_not_wait(p) && wait_address) {
Jiri Olsaa57de0b2009-07-08 12:09:13 +00001992 poll_wait(filp, wait_address, p);
Eric Dumazetdc6b9b72012-05-16 22:48:15 +00001993 /* We need to be sure we are in sync with the
Jiri Olsaa57de0b2009-07-08 12:09:13 +00001994 * socket flags modification.
1995 *
Eric Dumazet43815482010-04-29 11:01:49 +00001996 * This memory barrier is paired in the wq_has_sleeper.
Eric Dumazetdc6b9b72012-05-16 22:48:15 +00001997 */
Jiri Olsaa57de0b2009-07-08 12:09:13 +00001998 smp_mb();
1999 }
2000}
2001
Tom Herbertb73c3d02014-07-01 21:32:17 -07002002static inline void skb_set_hash_from_sk(struct sk_buff *skb, struct sock *sk)
2003{
2004 if (sk->sk_txhash) {
2005 skb->l4_hash = 1;
2006 skb->hash = sk->sk_txhash;
2007 }
2008}
2009
Eric Dumazet9e17f8a2015-11-01 15:36:55 -08002010void skb_set_owner_w(struct sk_buff *skb, struct sock *sk);
2011
Linus Torvalds1da177e2005-04-16 15:20:36 -07002012/*
Eric Dumazetdc6b9b72012-05-16 22:48:15 +00002013 * Queue a received datagram if it will fit. Stream and sequenced
Linus Torvalds1da177e2005-04-16 15:20:36 -07002014 * protocols can't normally use this as they need to fit buffers in
2015 * and play with them.
2016 *
Eric Dumazetdc6b9b72012-05-16 22:48:15 +00002017 * Inlined as it's very short and called for pretty much every
Linus Torvalds1da177e2005-04-16 15:20:36 -07002018 * packet ever received.
2019 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002020static inline void skb_set_owner_r(struct sk_buff *skb, struct sock *sk)
2021{
Herbert Xud55d87f2009-06-22 02:25:25 +00002022 skb_orphan(skb);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002023 skb->sk = sk;
2024 skb->destructor = sock_rfree;
2025 atomic_add(skb->truesize, &sk->sk_rmem_alloc);
Hideo Aoki3ab224b2007-12-31 00:11:19 -08002026 sk_mem_charge(sk, skb->truesize);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002027}
2028
Joe Perches69336bd2013-09-22 10:32:26 -07002029void sk_reset_timer(struct sock *sk, struct timer_list *timer,
2030 unsigned long expires);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002031
Joe Perches69336bd2013-09-22 10:32:26 -07002032void sk_stop_timer(struct sock *sk, struct timer_list *timer);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002033
Paolo Abeni65101ae2017-05-16 11:20:13 +02002034int __sk_queue_drop_skb(struct sock *sk, struct sk_buff_head *sk_queue,
2035 struct sk_buff *skb, unsigned int flags,
Eric Dumazet69629462017-02-05 09:25:24 -08002036 void (*destructor)(struct sock *sk,
2037 struct sk_buff *skb));
samanthakumare6afc8a2016-04-05 12:41:15 -04002038int __sock_queue_rcv_skb(struct sock *sk, struct sk_buff *skb);
Joe Perches69336bd2013-09-22 10:32:26 -07002039int sock_queue_rcv_skb(struct sock *sk, struct sk_buff *skb);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002040
Joe Perches69336bd2013-09-22 10:32:26 -07002041int sock_queue_err_skb(struct sock *sk, struct sk_buff *skb);
Willem de Bruijn364a9e92014-08-31 21:30:27 -04002042struct sk_buff *sock_dequeue_err_skb(struct sock *sk);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002043
2044/*
2045 * Recover an error report and clear atomically
2046 */
Eric Dumazetdc6b9b72012-05-16 22:48:15 +00002047
Linus Torvalds1da177e2005-04-16 15:20:36 -07002048static inline int sock_error(struct sock *sk)
2049{
Benjamin LaHaisec1cbe4b2005-12-13 23:22:19 -08002050 int err;
2051 if (likely(!sk->sk_err))
2052 return 0;
2053 err = xchg(&sk->sk_err, 0);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002054 return -err;
2055}
2056
2057static inline unsigned long sock_wspace(struct sock *sk)
2058{
2059 int amt = 0;
2060
2061 if (!(sk->sk_shutdown & SEND_SHUTDOWN)) {
Reshetova, Elena14afee42017-06-30 13:08:00 +03002062 amt = sk->sk_sndbuf - refcount_read(&sk->sk_wmem_alloc);
Eric Dumazetdc6b9b72012-05-16 22:48:15 +00002063 if (amt < 0)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002064 amt = 0;
2065 }
2066 return amt;
2067}
2068
Eric Dumazetceb5d582015-11-29 20:03:11 -08002069/* Note:
2070 * We use sk->sk_wq_raw, from contexts knowing this
2071 * pointer is not NULL and cannot disappear/change.
2072 */
Eric Dumazet9cd3e072015-11-29 20:03:10 -08002073static inline void sk_set_bit(int nr, struct sock *sk)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002074{
Eric Dumazet4be73522016-04-25 10:39:34 -07002075 if ((nr == SOCKWQ_ASYNC_NOSPACE || nr == SOCKWQ_ASYNC_WAITDATA) &&
2076 !sock_flag(sk, SOCK_FASYNC))
Eric Dumazet9317bb62016-04-25 10:39:32 -07002077 return;
2078
Eric Dumazetceb5d582015-11-29 20:03:11 -08002079 set_bit(nr, &sk->sk_wq_raw->flags);
Eric Dumazet9cd3e072015-11-29 20:03:10 -08002080}
2081
2082static inline void sk_clear_bit(int nr, struct sock *sk)
2083{
Eric Dumazet4be73522016-04-25 10:39:34 -07002084 if ((nr == SOCKWQ_ASYNC_NOSPACE || nr == SOCKWQ_ASYNC_WAITDATA) &&
2085 !sock_flag(sk, SOCK_FASYNC))
Eric Dumazet9317bb62016-04-25 10:39:32 -07002086 return;
2087
Eric Dumazetceb5d582015-11-29 20:03:11 -08002088 clear_bit(nr, &sk->sk_wq_raw->flags);
Eric Dumazet9cd3e072015-11-29 20:03:10 -08002089}
2090
Eric Dumazetceb5d582015-11-29 20:03:11 -08002091static inline void sk_wake_async(const struct sock *sk, int how, int band)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002092{
Eric Dumazetceb5d582015-11-29 20:03:11 -08002093 if (sock_flag(sk, SOCK_FASYNC)) {
2094 rcu_read_lock();
2095 sock_wake_async(rcu_dereference(sk->sk_wq), how, band);
2096 rcu_read_unlock();
2097 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002098}
2099
Daniel Borkmanneea86af2013-06-19 12:51:20 +02002100/* Since sk_{r,w}mem_alloc sums skb->truesize, even a small frame might
2101 * need sizeof(sk_buff) + MTU + padding, unless net driver perform copybreak.
2102 * Note: for send buffers, TCP works better if we can build two skbs at
2103 * minimum.
Eric Dumazet7a91b4342010-09-26 18:53:07 -07002104 */
Eric Dumazet9eb5bf82013-07-03 05:02:22 -07002105#define TCP_SKB_MIN_TRUESIZE (2048 + SKB_DATA_ALIGN(sizeof(struct sk_buff)))
Daniel Borkmanneea86af2013-06-19 12:51:20 +02002106
2107#define SOCK_MIN_SNDBUF (TCP_SKB_MIN_TRUESIZE * 2)
2108#define SOCK_MIN_RCVBUF TCP_SKB_MIN_TRUESIZE
Linus Torvalds1da177e2005-04-16 15:20:36 -07002109
2110static inline void sk_stream_moderate_sndbuf(struct sock *sk)
2111{
2112 if (!(sk->sk_userlocks & SOCK_SNDBUF_LOCK)) {
Eric Dumazet8df09ea2007-12-21 03:07:41 -08002113 sk->sk_sndbuf = min(sk->sk_sndbuf, sk->sk_wmem_queued >> 1);
Daniel Borkmanneea86af2013-06-19 12:51:20 +02002114 sk->sk_sndbuf = max_t(u32, sk->sk_sndbuf, SOCK_MIN_SNDBUF);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002115 }
2116}
2117
Eric Dumazeteb934472015-05-19 13:26:55 -07002118struct sk_buff *sk_stream_alloc_skb(struct sock *sk, int size, gfp_t gfp,
2119 bool force_schedule);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002120
Eric Dumazet5640f762012-09-23 23:04:42 +00002121/**
2122 * sk_page_frag - return an appropriate page_frag
2123 * @sk: socket
2124 *
2125 * If socket allocation mode allows current thread to sleep, it means its
2126 * safe to use the per task page_frag instead of the per socket one.
2127 */
2128static inline struct page_frag *sk_page_frag(struct sock *sk)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002129{
Mel Gormand0164ad2015-11-06 16:28:21 -08002130 if (gfpflags_allow_blocking(sk->sk_allocation))
Eric Dumazet5640f762012-09-23 23:04:42 +00002131 return &current->task_frag;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002132
Eric Dumazet5640f762012-09-23 23:04:42 +00002133 return &sk->sk_frag;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002134}
2135
Joe Perches69336bd2013-09-22 10:32:26 -07002136bool sk_page_frag_refill(struct sock *sk, struct page_frag *pfrag);
Eric Dumazet5640f762012-09-23 23:04:42 +00002137
Linus Torvalds1da177e2005-04-16 15:20:36 -07002138/*
2139 * Default write policy as shown to user space via poll/select/SIGIO
2140 */
Eric Dumazetdc6b9b72012-05-16 22:48:15 +00002141static inline bool sock_writeable(const struct sock *sk)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002142{
Reshetova, Elena14afee42017-06-30 13:08:00 +03002143 return refcount_read(&sk->sk_wmem_alloc) < (sk->sk_sndbuf >> 1);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002144}
2145
Al Virodd0fc662005-10-07 07:46:04 +01002146static inline gfp_t gfp_any(void)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002147{
Andrew Morton99709372009-02-12 16:43:17 -08002148 return in_softirq() ? GFP_ATOMIC : GFP_KERNEL;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002149}
2150
Eric Dumazetdc6b9b72012-05-16 22:48:15 +00002151static inline long sock_rcvtimeo(const struct sock *sk, bool noblock)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002152{
2153 return noblock ? 0 : sk->sk_rcvtimeo;
2154}
2155
Eric Dumazetdc6b9b72012-05-16 22:48:15 +00002156static inline long sock_sndtimeo(const struct sock *sk, bool noblock)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002157{
2158 return noblock ? 0 : sk->sk_sndtimeo;
2159}
2160
2161static inline int sock_rcvlowat(const struct sock *sk, int waitall, int len)
2162{
2163 return (waitall ? len : min_t(int, sk->sk_rcvlowat, len)) ? : 1;
2164}
2165
2166/* Alas, with timeout socket operations are not restartable.
2167 * Compare this to poll().
2168 */
2169static inline int sock_intr_errno(long timeo)
2170{
2171 return timeo == MAX_SCHEDULE_TIMEOUT ? -ERESTARTSYS : -EINTR;
2172}
2173
Eyal Birger744d5a32015-03-01 14:58:31 +02002174struct sock_skb_cb {
2175 u32 dropcount;
2176};
2177
2178/* Store sock_skb_cb at the end of skb->cb[] so protocol families
2179 * using skb->cb[] would keep using it directly and utilize its
2180 * alignement guarantee.
2181 */
2182#define SOCK_SKB_CB_OFFSET ((FIELD_SIZEOF(struct sk_buff, cb) - \
2183 sizeof(struct sock_skb_cb)))
2184
2185#define SOCK_SKB_CB(__skb) ((struct sock_skb_cb *)((__skb)->cb + \
2186 SOCK_SKB_CB_OFFSET))
2187
Eyal Birgerb4772ef2015-03-01 14:58:29 +02002188#define sock_skb_cb_check_size(size) \
Eyal Birger744d5a32015-03-01 14:58:31 +02002189 BUILD_BUG_ON((size) > SOCK_SKB_CB_OFFSET)
Eyal Birgerb4772ef2015-03-01 14:58:29 +02002190
Eyal Birger3bc3b962015-03-01 14:58:30 +02002191static inline void
2192sock_skb_set_dropcount(const struct sock *sk, struct sk_buff *skb)
2193{
Eric Dumazet3665f382016-12-07 10:05:36 -08002194 SOCK_SKB_CB(skb)->dropcount = sock_flag(sk, SOCK_RXQ_OVFL) ?
2195 atomic_read(&sk->sk_drops) : 0;
Eyal Birger3bc3b962015-03-01 14:58:30 +02002196}
2197
Eric Dumazet532182c2016-04-01 08:52:19 -07002198static inline void sk_drops_add(struct sock *sk, const struct sk_buff *skb)
2199{
2200 int segs = max_t(u16, 1, skb_shinfo(skb)->gso_segs);
2201
2202 atomic_add(segs, &sk->sk_drops);
2203}
2204
Joe Perches69336bd2013-09-22 10:32:26 -07002205void __sock_recv_timestamp(struct msghdr *msg, struct sock *sk,
2206 struct sk_buff *skb);
2207void __sock_recv_wifi_status(struct msghdr *msg, struct sock *sk,
2208 struct sk_buff *skb);
Eric Dumazet92f37fd2007-03-25 22:14:49 -07002209
Eric Dumazetdc6b9b72012-05-16 22:48:15 +00002210static inline void
Linus Torvalds1da177e2005-04-16 15:20:36 -07002211sock_recv_timestamp(struct msghdr *msg, struct sock *sk, struct sk_buff *skb)
2212{
Eric Dumazetb7aa0bf2007-04-19 16:16:32 -07002213 ktime_t kt = skb->tstamp;
Patrick Ohly20d49472009-02-12 05:03:38 +00002214 struct skb_shared_hwtstamps *hwtstamps = skb_hwtstamps(skb);
Patrick McHardya61bbcf2005-08-14 17:24:31 -07002215
Patrick Ohly20d49472009-02-12 05:03:38 +00002216 /*
2217 * generate control messages if
Willem de Bruijnb9f40e22014-08-04 22:11:46 -04002218 * - receive time stamping in software requested
Patrick Ohly20d49472009-02-12 05:03:38 +00002219 * - software time stamp available and wanted
Patrick Ohly20d49472009-02-12 05:03:38 +00002220 * - hardware time stamps available and wanted
Patrick Ohly20d49472009-02-12 05:03:38 +00002221 */
2222 if (sock_flag(sk, SOCK_RCVTSTAMP) ||
Willem de Bruijnb9f40e22014-08-04 22:11:46 -04002223 (sk->sk_tsflags & SOF_TIMESTAMPING_RX_SOFTWARE) ||
Thomas Gleixner2456e852016-12-25 11:38:40 +01002224 (kt && sk->sk_tsflags & SOF_TIMESTAMPING_SOFTWARE) ||
2225 (hwtstamps->hwtstamp &&
Willem de Bruijnb9f40e22014-08-04 22:11:46 -04002226 (sk->sk_tsflags & SOF_TIMESTAMPING_RAW_HARDWARE)))
Eric Dumazet92f37fd2007-03-25 22:14:49 -07002227 __sock_recv_timestamp(msg, sk, skb);
2228 else
Eric Dumazetb7aa0bf2007-04-19 16:16:32 -07002229 sk->sk_stamp = kt;
Johannes Berg6e3e9392011-11-09 10:15:42 +01002230
2231 if (sock_flag(sk, SOCK_WIFI_STATUS) && skb->wifi_acked_valid)
2232 __sock_recv_wifi_status(msg, sk, skb);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002233}
2234
Joe Perches69336bd2013-09-22 10:32:26 -07002235void __sock_recv_ts_and_drops(struct msghdr *msg, struct sock *sk,
2236 struct sk_buff *skb);
Eric Dumazet767dd032010-04-28 19:14:43 +00002237
Paolo Abeni6c7c98b2017-03-30 14:03:06 +02002238#define SK_DEFAULT_STAMP (-1L * NSEC_PER_SEC)
Eric Dumazet767dd032010-04-28 19:14:43 +00002239static inline void sock_recv_ts_and_drops(struct msghdr *msg, struct sock *sk,
2240 struct sk_buff *skb)
2241{
2242#define FLAGS_TS_OR_DROPS ((1UL << SOCK_RXQ_OVFL) | \
Willem de Bruijnb9f40e22014-08-04 22:11:46 -04002243 (1UL << SOCK_RCVTSTAMP))
2244#define TSFLAGS_ANY (SOF_TIMESTAMPING_SOFTWARE | \
2245 SOF_TIMESTAMPING_RAW_HARDWARE)
Eric Dumazet767dd032010-04-28 19:14:43 +00002246
Willem de Bruijnb9f40e22014-08-04 22:11:46 -04002247 if (sk->sk_flags & FLAGS_TS_OR_DROPS || sk->sk_tsflags & TSFLAGS_ANY)
Eric Dumazet767dd032010-04-28 19:14:43 +00002248 __sock_recv_ts_and_drops(msg, sk, skb);
Eric Dumazetd3fbff32017-03-31 14:59:25 -07002249 else if (unlikely(sock_flag(sk, SOCK_TIMESTAMP)))
Eric Dumazet767dd032010-04-28 19:14:43 +00002250 sk->sk_stamp = skb->tstamp;
Paolo Abeni6c7c98b2017-03-30 14:03:06 +02002251 else if (unlikely(sk->sk_stamp == SK_DEFAULT_STAMP))
2252 sk->sk_stamp = 0;
Eric Dumazet767dd032010-04-28 19:14:43 +00002253}
Neil Horman3b885782009-10-12 13:26:31 -07002254
Soheil Hassas Yeganehc14ac942016-04-02 23:08:12 -04002255void __sock_tx_timestamp(__u16 tsflags, __u8 *tx_flags);
Willem de Bruijn67cc0d42014-09-08 19:58:58 -04002256
Linus Torvalds1da177e2005-04-16 15:20:36 -07002257/**
Patrick Ohly20d49472009-02-12 05:03:38 +00002258 * sock_tx_timestamp - checks whether the outgoing packet is to be time stamped
Patrick Ohly20d49472009-02-12 05:03:38 +00002259 * @sk: socket sending this packet
Soheil Hassas Yeganehc14ac942016-04-02 23:08:12 -04002260 * @tsflags: timestamping flags to use
Eric Dumazet140c55d2014-08-06 11:49:29 +02002261 * @tx_flags: completed with instructions for time stamping
2262 *
Mauro Carvalho Chehabd6519832017-05-12 09:35:46 -03002263 * Note: callers should take care of initial ``*tx_flags`` value (usually 0)
Patrick Ohly20d49472009-02-12 05:03:38 +00002264 */
Soheil Hassas Yeganehc14ac942016-04-02 23:08:12 -04002265static inline void sock_tx_timestamp(const struct sock *sk, __u16 tsflags,
2266 __u8 *tx_flags)
Willem de Bruijn67cc0d42014-09-08 19:58:58 -04002267{
Soheil Hassas Yeganehc14ac942016-04-02 23:08:12 -04002268 if (unlikely(tsflags))
2269 __sock_tx_timestamp(tsflags, tx_flags);
Willem de Bruijn67cc0d42014-09-08 19:58:58 -04002270 if (unlikely(sock_flag(sk, SOCK_WIFI_STATUS)))
2271 *tx_flags |= SKBTX_WIFI_STATUS;
2272}
Patrick Ohly20d49472009-02-12 05:03:38 +00002273
2274/**
Linus Torvalds1da177e2005-04-16 15:20:36 -07002275 * sk_eat_skb - Release a skb if it is no longer needed
Pavel Pisa4dc3b162005-05-01 08:59:25 -07002276 * @sk: socket to eat this skb from
2277 * @skb: socket buffer to eat
Linus Torvalds1da177e2005-04-16 15:20:36 -07002278 *
2279 * This routine must be called with interrupts disabled or with the socket
2280 * locked so that the sk_buff queue operation is ok.
2281*/
Dan Williams7bced392013-12-30 12:37:29 -08002282static inline void sk_eat_skb(struct sock *sk, struct sk_buff *skb)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002283{
2284 __skb_unlink(skb, &sk->sk_receive_queue);
2285 __kfree_skb(skb);
2286}
2287
YOSHIFUJI Hideaki3b1e0a62008-03-26 02:26:21 +09002288static inline
2289struct net *sock_net(const struct sock *sk)
2290{
Eric Dumazetc2d9ba92010-06-01 06:51:19 +00002291 return read_pnet(&sk->sk_net);
YOSHIFUJI Hideaki3b1e0a62008-03-26 02:26:21 +09002292}
2293
2294static inline
Denis V. Lunevf5aa23f2008-03-26 00:48:17 -07002295void sock_net_set(struct sock *sk, struct net *net)
YOSHIFUJI Hideaki3b1e0a62008-03-26 02:26:21 +09002296{
Eric Dumazetc2d9ba92010-06-01 06:51:19 +00002297 write_pnet(&sk->sk_net, net);
YOSHIFUJI Hideaki3b1e0a62008-03-26 02:26:21 +09002298}
2299
KOVACS Krisztian23542612008-10-07 12:41:01 -07002300static inline struct sock *skb_steal_sock(struct sk_buff *skb)
2301{
Vijay Subramanianefc27f82012-06-24 13:03:07 +00002302 if (skb->sk) {
KOVACS Krisztian23542612008-10-07 12:41:01 -07002303 struct sock *sk = skb->sk;
2304
2305 skb->destructor = NULL;
2306 skb->sk = NULL;
2307 return sk;
2308 }
2309 return NULL;
2310}
2311
Eric Dumazet1d0ab252015-03-15 21:12:12 -07002312/* This helper checks if a socket is a full socket,
2313 * ie _not_ a timewait or request socket.
2314 */
2315static inline bool sk_fullsock(const struct sock *sk)
2316{
2317 return (1 << sk->sk_state) & ~(TCPF_TIME_WAIT | TCPF_NEW_SYN_RECV);
2318}
2319
Eric Dumazete446f9d2015-10-08 05:01:55 -07002320/* This helper checks if a socket is a LISTEN or NEW_SYN_RECV
2321 * SYNACK messages can be attached to either ones (depending on SYNCOOKIE)
2322 */
2323static inline bool sk_listener(const struct sock *sk)
2324{
2325 return (1 << sk->sk_state) & (TCPF_LISTEN | TCPF_NEW_SYN_RECV);
2326}
2327
Eric Dumazet00fd38d2015-11-12 08:43:18 -08002328/**
2329 * sk_state_load - read sk->sk_state for lockless contexts
2330 * @sk: socket pointer
2331 *
2332 * Paired with sk_state_store(). Used in places we do not hold socket lock :
2333 * tcp_diag_get_info(), tcp_get_info(), tcp_poll(), get_tcp4_sock() ...
2334 */
2335static inline int sk_state_load(const struct sock *sk)
2336{
2337 return smp_load_acquire(&sk->sk_state);
2338}
2339
2340/**
2341 * sk_state_store - update sk->sk_state
2342 * @sk: socket pointer
2343 * @newstate: new state
2344 *
2345 * Paired with sk_state_load(). Should be used in contexts where
2346 * state change might impact lockless readers.
2347 */
2348static inline void sk_state_store(struct sock *sk, int newstate)
2349{
2350 smp_store_release(&sk->sk_state, newstate);
2351}
2352
Joe Perches69336bd2013-09-22 10:32:26 -07002353void sock_enable_timestamp(struct sock *sk, int flag);
2354int sock_get_timestamp(struct sock *, struct timeval __user *);
2355int sock_get_timestampns(struct sock *, struct timespec __user *);
2356int sock_recv_errqueue(struct sock *sk, struct msghdr *msg, int len, int level,
2357 int type);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002358
Eric W. Biedermana3b299d2014-04-23 14:26:56 -07002359bool sk_ns_capable(const struct sock *sk,
2360 struct user_namespace *user_ns, int cap);
2361bool sk_capable(const struct sock *sk, int cap);
2362bool sk_net_capable(const struct sock *sk, int cap);
2363
Josh Hunta2d133b2017-03-20 15:22:03 -04002364void sk_get_meminfo(const struct sock *sk, u32 *meminfo);
2365
Linus Torvalds1da177e2005-04-16 15:20:36 -07002366extern __u32 sysctl_wmem_max;
2367extern __u32 sysctl_rmem_max;
2368
Willem de Bruijnb245be12015-01-30 13:29:32 -05002369extern int sysctl_tstamp_allow_data;
David S. Miller6baf1f42005-09-05 18:14:11 -07002370extern int sysctl_optmem_max;
2371
Arnaldo Carvalho de Melo20380732005-08-16 02:18:02 -03002372extern __u32 sysctl_wmem_default;
2373extern __u32 sysctl_rmem_default;
Arnaldo Carvalho de Melo20380732005-08-16 02:18:02 -03002374
Linus Torvalds1da177e2005-04-16 15:20:36 -07002375#endif /* _SOCK_H */