blob: 5e5997654db6454f82179cc35c4bc22e89d0c06f [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>
Linus Torvalds1da177e2005-04-16 15:20:36 -070069#include <net/dst.h>
70#include <net/checksum.h>
Eric Dumazet1d0ab252015-03-15 21:12:12 -070071#include <net/tcp_states.h>
Willem de Bruijnb9f40e22014-08-04 22:11:46 -040072#include <linux/net_tstamp.h>
Ursula Braunf16a7dd2017-01-09 16:55:26 +010073#include <net/smc.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070074
75/*
76 * This structure really needs to be cleaned up.
77 * Most of it is for TCP, and not used by any of
78 * the other protocols.
79 */
80
81/* Define this to get the SOCK_DBG debugging facility. */
82#define SOCK_DEBUGGING
83#ifdef SOCK_DEBUGGING
84#define SOCK_DEBUG(sk, msg...) do { if ((sk) && sock_flag((sk), SOCK_DBG)) \
85 printk(KERN_DEBUG msg); } while (0)
86#else
Stephen Hemminger4cd90292008-03-21 15:54:53 -070087/* Validate arguments and do nothing */
Joe Perchesb9075fa2011-10-31 17:11:33 -070088static inline __printf(2, 3)
Eric Dumazetdc6b9b72012-05-16 22:48:15 +000089void SOCK_DEBUG(const struct sock *sk, const char *msg, ...)
Stephen Hemminger4cd90292008-03-21 15:54:53 -070090{
91}
Linus Torvalds1da177e2005-04-16 15:20:36 -070092#endif
93
94/* This is the per-socket lock. The spinlock provides a synchronization
95 * between user contexts and software interrupt processing, whereas the
96 * mini-semaphore synchronizes multiple users amongst themselves.
97 */
Linus Torvalds1da177e2005-04-16 15:20:36 -070098typedef struct {
99 spinlock_t slock;
John Heffnerd2e91172007-09-12 10:44:19 +0200100 int owned;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700101 wait_queue_head_t wq;
Ingo Molnara5b5bb92006-07-03 00:25:35 -0700102 /*
103 * We express the mutex-alike socket_lock semantics
104 * to the lock validator by explicitly managing
105 * the slock as a lock variant (in addition to
106 * the slock itself):
107 */
108#ifdef CONFIG_DEBUG_LOCK_ALLOC
109 struct lockdep_map dep_map;
110#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -0700111} socket_lock_t;
112
Linus Torvalds1da177e2005-04-16 15:20:36 -0700113struct sock;
Arnaldo Carvalho de Melo8feaf0c02005-08-09 20:09:30 -0700114struct proto;
Denis V. Lunev0eeb8ff2007-12-04 01:15:45 -0800115struct net;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700116
Eric Dumazet077b3932012-12-02 07:33:10 +0000117typedef __u32 __bitwise __portpair;
118typedef __u64 __bitwise __addrpair;
119
Linus Torvalds1da177e2005-04-16 15:20:36 -0700120/**
Pavel Pisa4dc3b162005-05-01 08:59:25 -0700121 * struct sock_common - minimal network layer representation of sockets
Eric Dumazet68835ab2010-11-30 19:04:07 +0000122 * @skc_daddr: Foreign IPv4 addr
123 * @skc_rcv_saddr: Bound local IPv4 addr
Eric Dumazet4dc6dc72009-07-15 23:13:10 +0000124 * @skc_hash: hash value used with various protocol lookup tables
Eric Dumazetd4cada42009-11-08 10:17:30 +0000125 * @skc_u16hashes: two u16 hash values used by UDP lookup tables
Eric Dumazetce43b032012-11-30 09:49:27 +0000126 * @skc_dport: placeholder for inet_dport/tw_dport
127 * @skc_num: placeholder for inet_num/tw_num
Pavel Pisa4dc3b162005-05-01 08:59:25 -0700128 * @skc_family: network address family
129 * @skc_state: Connection state
130 * @skc_reuse: %SO_REUSEADDR setting
Tom Herbert055dc212013-01-22 09:49:50 +0000131 * @skc_reuseport: %SO_REUSEPORT setting
Pavel Pisa4dc3b162005-05-01 08:59:25 -0700132 * @skc_bound_dev_if: bound device index if != 0
Pavel Pisa4dc3b162005-05-01 08:59:25 -0700133 * @skc_bind_node: bind hash linkage for various protocol lookup tables
Eric Dumazet512615b2009-11-08 10:17:58 +0000134 * @skc_portaddr_node: second hash linkage for UDP/UDP-Lite protocol
Arnaldo Carvalho de Melo8feaf0c02005-08-09 20:09:30 -0700135 * @skc_prot: protocol handlers inside a network family
Eric W. Biederman07feaeb2007-09-12 11:58:02 +0200136 * @skc_net: reference to the network namespace of this socket
Eric Dumazet68835ab2010-11-30 19:04:07 +0000137 * @skc_node: main hash linkage for various protocol lookup tables
138 * @skc_nulls_node: main hash linkage for TCP/UDP/UDP-Lite protocol
139 * @skc_tx_queue_mapping: tx queue number for this connection
Eric Dumazet8e5eb542015-10-08 19:33:22 -0700140 * @skc_flags: place holder for sk_flags
141 * %SO_LINGER (l_onoff), %SO_BROADCAST, %SO_KEEPALIVE,
142 * %SO_OOBINLINE settings, %SO_TIMESTAMPING settings
Eric Dumazet70da2682015-10-08 19:33:21 -0700143 * @skc_incoming_cpu: record/match cpu processing incoming packets
Eric Dumazet68835ab2010-11-30 19:04:07 +0000144 * @skc_refcnt: reference count
Pavel Pisa4dc3b162005-05-01 08:59:25 -0700145 *
146 * This is the minimal network layer representation of sockets, the header
Arnaldo Carvalho de Melo8feaf0c02005-08-09 20:09:30 -0700147 * for struct sock and struct inet_timewait_sock.
148 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700149struct sock_common {
Eric Dumazetce43b032012-11-30 09:49:27 +0000150 /* skc_daddr and skc_rcv_saddr must be grouped on a 8 bytes aligned
Eric Dumazet05dbc7b2013-10-03 00:22:02 -0700151 * address on 64bit arches : cf INET_MATCH()
Eric Dumazet4dc6dc72009-07-15 23:13:10 +0000152 */
Eric Dumazetce43b032012-11-30 09:49:27 +0000153 union {
Eric Dumazet077b3932012-12-02 07:33:10 +0000154 __addrpair skc_addrpair;
Eric Dumazetce43b032012-11-30 09:49:27 +0000155 struct {
156 __be32 skc_daddr;
157 __be32 skc_rcv_saddr;
158 };
159 };
Eric Dumazetd4cada42009-11-08 10:17:30 +0000160 union {
161 unsigned int skc_hash;
162 __u16 skc_u16hashes[2];
163 };
Eric Dumazetce43b032012-11-30 09:49:27 +0000164 /* skc_dport && skc_num must be grouped as well */
165 union {
Eric Dumazet077b3932012-12-02 07:33:10 +0000166 __portpair skc_portpair;
Eric Dumazetce43b032012-11-30 09:49:27 +0000167 struct {
168 __be16 skc_dport;
169 __u16 skc_num;
170 };
171 };
172
Eric Dumazet4dc6dc72009-07-15 23:13:10 +0000173 unsigned short skc_family;
174 volatile unsigned char skc_state;
Tom Herbert055dc212013-01-22 09:49:50 +0000175 unsigned char skc_reuse:4;
Eric Dumazet9fe516b2014-06-27 08:36:16 -0700176 unsigned char skc_reuseport:1;
177 unsigned char skc_ipv6only:1;
Eric W. Biederman26abe142015-05-08 21:10:31 -0500178 unsigned char skc_net_refcnt:1;
Eric Dumazet4dc6dc72009-07-15 23:13:10 +0000179 int skc_bound_dev_if;
Eric Dumazet512615b2009-11-08 10:17:58 +0000180 union {
181 struct hlist_node skc_bind_node;
Eric Dumazetca065d02016-04-01 08:52:13 -0700182 struct hlist_node skc_portaddr_node;
Eric Dumazet512615b2009-11-08 10:17:58 +0000183 };
Arnaldo Carvalho de Melo8feaf0c02005-08-09 20:09:30 -0700184 struct proto *skc_prot;
Eric W. Biederman0c5c9fb2015-03-11 23:06:44 -0500185 possible_net_t skc_net;
Eric Dumazetefe42082013-10-03 15:42:29 -0700186
187#if IS_ENABLED(CONFIG_IPV6)
188 struct in6_addr skc_v6_daddr;
189 struct in6_addr skc_v6_rcv_saddr;
190#endif
191
Eric Dumazet33cf7c92015-03-11 18:53:14 -0700192 atomic64_t skc_cookie;
193
Eric Dumazet8e5eb542015-10-08 19:33:22 -0700194 /* following fields are padding to force
195 * offset(struct sock, sk_refcnt) == 128 on 64bit arches
196 * assuming IPV6 is enabled. We use this padding differently
197 * for different kind of 'sockets'
198 */
199 union {
200 unsigned long skc_flags;
201 struct sock *skc_listener; /* request_sock */
202 struct inet_timewait_death_row *skc_tw_dr; /* inet_timewait_sock */
203 };
Eric Dumazet68835ab2010-11-30 19:04:07 +0000204 /*
205 * fields between dontcopy_begin/dontcopy_end
206 * are not copied in sock_copy()
207 */
Randy Dunlap928c41e2011-01-08 17:39:21 +0000208 /* private: */
Eric Dumazet68835ab2010-11-30 19:04:07 +0000209 int skc_dontcopy_begin[0];
Randy Dunlap928c41e2011-01-08 17:39:21 +0000210 /* public: */
Eric Dumazet68835ab2010-11-30 19:04:07 +0000211 union {
212 struct hlist_node skc_node;
213 struct hlist_nulls_node skc_nulls_node;
214 };
215 int skc_tx_queue_mapping;
Eric Dumazeted53d0a2015-10-08 19:33:23 -0700216 union {
217 int skc_incoming_cpu;
218 u32 skc_rcv_wnd;
Eric Dumazetd475f092015-10-08 19:33:24 -0700219 u32 skc_tw_rcv_nxt; /* struct tcp_timewait_sock */
Eric Dumazeted53d0a2015-10-08 19:33:23 -0700220 };
Eric Dumazet70da2682015-10-08 19:33:21 -0700221
Eric Dumazet68835ab2010-11-30 19:04:07 +0000222 atomic_t skc_refcnt;
Randy Dunlap928c41e2011-01-08 17:39:21 +0000223 /* private: */
Eric Dumazet68835ab2010-11-30 19:04:07 +0000224 int skc_dontcopy_end[0];
Eric Dumazeted53d0a2015-10-08 19:33:23 -0700225 union {
226 u32 skc_rxhash;
227 u32 skc_window_clamp;
Eric Dumazetd475f092015-10-08 19:33:24 -0700228 u32 skc_tw_snd_nxt; /* struct tcp_timewait_sock */
Eric Dumazeted53d0a2015-10-08 19:33:23 -0700229 };
Randy Dunlap928c41e2011-01-08 17:39:21 +0000230 /* public: */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700231};
232
233/**
234 * struct sock - network layer representation of sockets
Arnaldo Carvalho de Melo8feaf0c02005-08-09 20:09:30 -0700235 * @__sk_common: shared layout with inet_timewait_sock
Pavel Pisa4dc3b162005-05-01 08:59:25 -0700236 * @sk_shutdown: mask of %SEND_SHUTDOWN and/or %RCV_SHUTDOWN
237 * @sk_userlocks: %SO_SNDBUF and %SO_RCVBUF settings
238 * @sk_lock: synchronizer
239 * @sk_rcvbuf: size of receive buffer in bytes
Eric Dumazet43815482010-04-29 11:01:49 +0000240 * @sk_wq: sock wait queue and async head
Shawn Bohrer421b3882013-10-07 11:01:39 -0500241 * @sk_rx_dst: receive input route used by early demux
Pavel Pisa4dc3b162005-05-01 08:59:25 -0700242 * @sk_dst_cache: destination cache
Julian Anastasov9b8805a2017-02-06 23:14:11 +0200243 * @sk_dst_pending_confirm: need to confirm neighbour
Pavel Pisa4dc3b162005-05-01 08:59:25 -0700244 * @sk_policy: flow policy
Pavel Pisa4dc3b162005-05-01 08:59:25 -0700245 * @sk_receive_queue: incoming packets
246 * @sk_wmem_alloc: transmit queue bytes committed
247 * @sk_write_queue: Packet sending queue
248 * @sk_omem_alloc: "o" is "option" or "other"
249 * @sk_wmem_queued: persistent queue size
250 * @sk_forward_alloc: space allocated forward
Eliezer Tamir06021292013-06-10 11:39:50 +0300251 * @sk_napi_id: id of the last napi context to receive data for sk
Eliezer Tamirdafcc432013-06-14 16:33:57 +0300252 * @sk_ll_usec: usecs to busypoll when there is no data
Pavel Pisa4dc3b162005-05-01 08:59:25 -0700253 * @sk_allocation: allocation mode
Eric Dumazet95bd09e2013-08-27 05:46:32 -0700254 * @sk_pacing_rate: Pacing rate (if supported by transport/packet scheduler)
Eric Dumazetc3f40d72013-09-29 01:12:40 -0700255 * @sk_max_pacing_rate: Maximum pacing rate (%SO_MAX_PACING_RATE)
Pavel Pisa4dc3b162005-05-01 08:59:25 -0700256 * @sk_sndbuf: size of send buffer in bytes
Stephen Hemminger293de7d2016-10-23 09:28:29 -0700257 * @sk_padding: unused element for alignment
Tom Herbert28448b82014-05-23 08:47:19 -0700258 * @sk_no_check_tx: %SO_NO_CHECK setting, set checksum in TX packets
259 * @sk_no_check_rx: allow zero checksum in RX packets
Pavel Pisa4dc3b162005-05-01 08:59:25 -0700260 * @sk_route_caps: route capabilities (e.g. %NETIF_F_TSO)
Eric Dumazeta4654192010-05-16 00:36:33 -0700261 * @sk_route_nocaps: forbidden route capabilities (e.g NETIF_F_GSO_MASK)
Herbert Xubcd76112006-06-30 13:36:35 -0700262 * @sk_gso_type: GSO type (e.g. %SKB_GSO_TCPV4)
Peter P Waskiewicz Jr82cc1a72008-03-21 03:43:19 -0700263 * @sk_gso_max_size: Maximum GSO segment size to build
Ben Hutchings14853482012-07-30 16:11:42 +0000264 * @sk_gso_max_segs: Maximum number of GSO segments
Pavel Pisa4dc3b162005-05-01 08:59:25 -0700265 * @sk_lingertime: %SO_LINGER l_linger setting
Pavel Pisa4dc3b162005-05-01 08:59:25 -0700266 * @sk_backlog: always used with the per-socket spinlock held
267 * @sk_callback_lock: used with the callbacks in the end of this struct
268 * @sk_error_queue: rarely used
Wang Chen33c732c2007-11-13 20:30:01 -0800269 * @sk_prot_creator: sk_prot of original sock creator (see ipv6_setsockopt,
270 * IPV6_ADDRFORM for instance)
Pavel Pisa4dc3b162005-05-01 08:59:25 -0700271 * @sk_err: last error
Wang Chen33c732c2007-11-13 20:30:01 -0800272 * @sk_err_soft: errors that don't cause failure but are the cause of a
273 * persistent failure not just 'timed out'
Eric Dumazetcb61cb92008-06-17 21:04:56 -0700274 * @sk_drops: raw/udp drops counter
Pavel Pisa4dc3b162005-05-01 08:59:25 -0700275 * @sk_ack_backlog: current listen backlog
276 * @sk_max_ack_backlog: listen backlog set in listen()
277 * @sk_priority: %SO_PRIORITY setting
278 * @sk_type: socket type (%SOCK_STREAM, etc)
279 * @sk_protocol: which protocol this socket belongs in this network family
Randy Dunlap53c3fa22010-08-09 13:41:07 +0000280 * @sk_peer_pid: &struct pid for this socket's peer
281 * @sk_peer_cred: %SO_PEERCRED setting
Pavel Pisa4dc3b162005-05-01 08:59:25 -0700282 * @sk_rcvlowat: %SO_RCVLOWAT setting
283 * @sk_rcvtimeo: %SO_RCVTIMEO setting
284 * @sk_sndtimeo: %SO_SNDTIMEO setting
Tom Herbertb73c3d02014-07-01 21:32:17 -0700285 * @sk_txhash: computed flow hash for use on transmit
Pavel Pisa4dc3b162005-05-01 08:59:25 -0700286 * @sk_filter: socket filtering instructions
Pavel Pisa4dc3b162005-05-01 08:59:25 -0700287 * @sk_timer: sock cleanup timer
288 * @sk_stamp: time stamp of last packet received
Willem de Bruijnb9f40e22014-08-04 22:11:46 -0400289 * @sk_tsflags: SO_TIMESTAMPING socket options
Willem de Bruijn09c2d252014-08-04 22:11:47 -0400290 * @sk_tskey: counter to disambiguate concurrent tstamp requests
Pavel Pisa4dc3b162005-05-01 08:59:25 -0700291 * @sk_socket: Identd and reporting IO signals
292 * @sk_user_data: RPC layer private data
Eric Dumazet5640f762012-09-23 23:04:42 +0000293 * @sk_frag: cached page frag
Randy Dunlapd3d4f0a2012-04-17 14:03:53 +0000294 * @sk_peek_off: current peek_offset value
Pavel Pisa4dc3b162005-05-01 08:59:25 -0700295 * @sk_send_head: front of stuff to transmit
Martin Waitz67be2dd2005-05-01 08:59:26 -0700296 * @sk_security: used by security modules
Randy Dunlap31729362008-02-18 20:52:13 -0800297 * @sk_mark: generic packet mark
Tejun Heo2a56a1f2015-12-07 17:38:52 -0500298 * @sk_cgrp_data: cgroup data for this cgroup
Johannes Weinerbaac50b2016-01-14 15:21:17 -0800299 * @sk_memcg: this socket's memory cgroup association
Pavel Pisa4dc3b162005-05-01 08:59:25 -0700300 * @sk_write_pending: a write to stream socket waits to start
301 * @sk_state_change: callback to indicate change in the state of the sock
302 * @sk_data_ready: callback to indicate there is data to be processed
303 * @sk_write_space: callback to indicate there is bf sending space available
304 * @sk_error_report: callback to indicate errors (e.g. %MSG_ERRQUEUE)
305 * @sk_backlog_rcv: callback to process the backlog
306 * @sk_destruct: called at sock freeing time, i.e. when all refcnt == 0
Craig Gallekef456142016-01-04 17:41:45 -0500307 * @sk_reuseport_cb: reuseport group container
Stephen Hemminger293de7d2016-10-23 09:28:29 -0700308 * @sk_rcu: used during RCU grace period
309 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700310struct sock {
311 /*
Arnaldo Carvalho de Melo8feaf0c02005-08-09 20:09:30 -0700312 * Now struct inet_timewait_sock also uses sock_common, so please just
Linus Torvalds1da177e2005-04-16 15:20:36 -0700313 * don't add nothing before this first member (__sk_common) --acme
314 */
315 struct sock_common __sk_common;
Eric Dumazet4dc6dc72009-07-15 23:13:10 +0000316#define sk_node __sk_common.skc_node
317#define sk_nulls_node __sk_common.skc_nulls_node
318#define sk_refcnt __sk_common.skc_refcnt
Krishna Kumare022f0b2009-10-19 23:46:20 +0000319#define sk_tx_queue_mapping __sk_common.skc_tx_queue_mapping
Eric Dumazet4dc6dc72009-07-15 23:13:10 +0000320
Eric Dumazet68835ab2010-11-30 19:04:07 +0000321#define sk_dontcopy_begin __sk_common.skc_dontcopy_begin
322#define sk_dontcopy_end __sk_common.skc_dontcopy_end
Eric Dumazet4dc6dc72009-07-15 23:13:10 +0000323#define sk_hash __sk_common.skc_hash
Eric Dumazet50805462013-10-02 04:29:50 -0700324#define sk_portpair __sk_common.skc_portpair
Eric Dumazet05dbc7b2013-10-03 00:22:02 -0700325#define sk_num __sk_common.skc_num
326#define sk_dport __sk_common.skc_dport
Eric Dumazet50805462013-10-02 04:29:50 -0700327#define sk_addrpair __sk_common.skc_addrpair
328#define sk_daddr __sk_common.skc_daddr
329#define sk_rcv_saddr __sk_common.skc_rcv_saddr
Linus Torvalds1da177e2005-04-16 15:20:36 -0700330#define sk_family __sk_common.skc_family
331#define sk_state __sk_common.skc_state
332#define sk_reuse __sk_common.skc_reuse
Tom Herbert055dc212013-01-22 09:49:50 +0000333#define sk_reuseport __sk_common.skc_reuseport
Eric Dumazet9fe516b2014-06-27 08:36:16 -0700334#define sk_ipv6only __sk_common.skc_ipv6only
Eric W. Biederman26abe142015-05-08 21:10:31 -0500335#define sk_net_refcnt __sk_common.skc_net_refcnt
Linus Torvalds1da177e2005-04-16 15:20:36 -0700336#define sk_bound_dev_if __sk_common.skc_bound_dev_if
Linus Torvalds1da177e2005-04-16 15:20:36 -0700337#define sk_bind_node __sk_common.skc_bind_node
Arnaldo Carvalho de Melo8feaf0c02005-08-09 20:09:30 -0700338#define sk_prot __sk_common.skc_prot
Eric W. Biederman07feaeb2007-09-12 11:58:02 +0200339#define sk_net __sk_common.skc_net
Eric Dumazetefe42082013-10-03 15:42:29 -0700340#define sk_v6_daddr __sk_common.skc_v6_daddr
341#define sk_v6_rcv_saddr __sk_common.skc_v6_rcv_saddr
Eric Dumazet33cf7c92015-03-11 18:53:14 -0700342#define sk_cookie __sk_common.skc_cookie
Eric Dumazet70da2682015-10-08 19:33:21 -0700343#define sk_incoming_cpu __sk_common.skc_incoming_cpu
Eric Dumazet8e5eb542015-10-08 19:33:22 -0700344#define sk_flags __sk_common.skc_flags
Eric Dumazeted53d0a2015-10-08 19:33:23 -0700345#define sk_rxhash __sk_common.skc_rxhash
Eric Dumazetefe42082013-10-03 15:42:29 -0700346
Eric Dumazetb178bb32010-11-16 05:56:04 +0000347 socket_lock_t sk_lock;
Eric Dumazet9115e8c2016-12-03 11:14:56 -0800348 atomic_t sk_drops;
349 int sk_rcvlowat;
350 struct sk_buff_head sk_error_queue;
Eric Dumazetb178bb32010-11-16 05:56:04 +0000351 struct sk_buff_head sk_receive_queue;
352 /*
353 * The backlog queue is special, it is always used with
354 * the per-socket spinlock held and requires low latency
355 * access. Therefore we special case it's implementation.
356 * Note : rmem_alloc is in this structure to fill a hole
357 * on 64bit arches, not because its logically part of
358 * backlog.
359 */
360 struct {
361 atomic_t rmem_alloc;
362 int len;
363 struct sk_buff *head;
364 struct sk_buff *tail;
365 } sk_backlog;
366#define sk_rmem_alloc sk_backlog.rmem_alloc
Eric Dumazet2c8c56e2014-11-11 05:54:28 -0800367
Eric Dumazet9115e8c2016-12-03 11:14:56 -0800368 int sk_forward_alloc;
Cong Wange0d10952013-08-01 11:10:25 +0800369#ifdef CONFIG_NET_RX_BUSY_POLL
Eliezer Tamirdafcc432013-06-14 16:33:57 +0300370 unsigned int sk_ll_usec;
Eric Dumazet9115e8c2016-12-03 11:14:56 -0800371 /* ===== mostly read cache line ===== */
372 unsigned int sk_napi_id;
Eliezer Tamir06021292013-06-10 11:39:50 +0300373#endif
Eric Dumazetb178bb32010-11-16 05:56:04 +0000374 int sk_rcvbuf;
375
376 struct sk_filter __rcu *sk_filter;
Eric Dumazetceb5d582015-11-29 20:03:11 -0800377 union {
378 struct socket_wq __rcu *sk_wq;
379 struct socket_wq *sk_wq_raw;
380 };
Eric Dumazetb178bb32010-11-16 05:56:04 +0000381#ifdef CONFIG_XFRM
Eric Dumazetd188ba82015-12-08 07:22:02 -0800382 struct xfrm_policy __rcu *sk_policy[2];
Eric Dumazetb178bb32010-11-16 05:56:04 +0000383#endif
Eric Dumazetdeaa5852012-06-24 20:22:49 +0000384 struct dst_entry *sk_rx_dst;
Cong Wang0e36cbb2013-01-22 21:09:51 +0000385 struct dst_entry __rcu *sk_dst_cache;
Eric Dumazetb178bb32010-11-16 05:56:04 +0000386 atomic_t sk_omem_alloc;
387 int sk_sndbuf;
Eric Dumazet9115e8c2016-12-03 11:14:56 -0800388
389 /* ===== cache line for TX ===== */
390 int sk_wmem_queued;
391 atomic_t sk_wmem_alloc;
392 unsigned long sk_tsq_flags;
393 struct sk_buff *sk_send_head;
Eric Dumazetb178bb32010-11-16 05:56:04 +0000394 struct sk_buff_head sk_write_queue;
Eric Dumazet9115e8c2016-12-03 11:14:56 -0800395 __s32 sk_peek_off;
396 int sk_write_pending;
Julian Anastasov9b8805a2017-02-06 23:14:11 +0200397 __u32 sk_dst_pending_confirm;
398 /* Note: 32bit hole on 64bit arches */
Eric Dumazet9115e8c2016-12-03 11:14:56 -0800399 long sk_sndtimeo;
400 struct timer_list sk_timer;
401 __u32 sk_priority;
402 __u32 sk_mark;
403 u32 sk_pacing_rate; /* bytes per second */
404 u32 sk_max_pacing_rate;
405 struct page_frag sk_frag;
406 netdev_features_t sk_route_caps;
407 netdev_features_t sk_route_nocaps;
408 int sk_gso_type;
409 unsigned int sk_gso_max_size;
410 gfp_t sk_allocation;
411 __u32 sk_txhash;
Andrey Ryabininfc648692016-05-18 19:19:27 +0300412
413 /*
414 * Because of non atomicity rules, all
415 * changes are protected by socket lock.
416 */
David Ahernaa4c1032016-12-01 08:48:06 -0800417 unsigned int __sk_flags_offset[0];
418#ifdef __BIG_ENDIAN_BITFIELD
419#define SK_FL_PROTO_SHIFT 16
420#define SK_FL_PROTO_MASK 0x00ff0000
421
422#define SK_FL_TYPE_SHIFT 0
423#define SK_FL_TYPE_MASK 0x0000ffff
424#else
425#define SK_FL_PROTO_SHIFT 8
426#define SK_FL_PROTO_MASK 0x0000ff00
427
428#define SK_FL_TYPE_SHIFT 16
429#define SK_FL_TYPE_MASK 0xffff0000
430#endif
431
Vegard Nossuma98b65a2009-02-26 14:46:57 +0100432 kmemcheck_bitfield_begin(flags);
Andrey Ryabininfc648692016-05-18 19:19:27 +0300433 unsigned int sk_padding : 2,
Tom Herbert28448b82014-05-23 08:47:19 -0700434 sk_no_check_tx : 1,
435 sk_no_check_rx : 1,
Eric Dumazet5fdb9972009-10-08 22:50:25 +0000436 sk_userlocks : 4,
437 sk_protocol : 8,
438 sk_type : 16;
Hannes Frederic Sowa7bbadd22015-12-14 23:30:43 +0100439#define SK_PROTOCOL_MAX U8_MAX
Vegard Nossuma98b65a2009-02-26 14:46:57 +0100440 kmemcheck_bitfield_end(flags);
Andrey Ryabininfc648692016-05-18 19:19:27 +0300441
Ben Hutchings14853482012-07-30 16:11:42 +0000442 u16 sk_gso_max_segs;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700443 unsigned long sk_lingertime;
Arnaldo Carvalho de Melo476e19c2005-05-05 13:35:15 -0700444 struct proto *sk_prot_creator;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700445 rwlock_t sk_callback_lock;
446 int sk_err,
447 sk_err_soft;
Eric Dumazetbecb74f2015-03-19 19:04:21 -0700448 u32 sk_ack_backlog;
449 u32 sk_max_ack_backlog;
Lorenzo Colitti86741ec2016-11-04 02:23:41 +0900450 kuid_t sk_uid;
Eric W. Biederman109f6e32010-06-13 03:30:14 +0000451 struct pid *sk_peer_pid;
452 const struct cred *sk_peer_cred;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700453 long sk_rcvtimeo;
Eric Dumazetb7aa0bf2007-04-19 16:16:32 -0700454 ktime_t sk_stamp;
Willem de Bruijnb9f40e22014-08-04 22:11:46 -0400455 u16 sk_tsflags;
Andrey Ryabininfc648692016-05-18 19:19:27 +0300456 u8 sk_shutdown;
Willem de Bruijn09c2d252014-08-04 22:11:47 -0400457 u32 sk_tskey;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700458 struct socket *sk_socket;
459 void *sk_user_data;
Alexey Dobriyand5f64232008-11-04 14:45:58 -0800460#ifdef CONFIG_SECURITY
Linus Torvalds1da177e2005-04-16 15:20:36 -0700461 void *sk_security;
Alexey Dobriyand5f64232008-11-04 14:45:58 -0800462#endif
Tejun Heo2a56a1f2015-12-07 17:38:52 -0500463 struct sock_cgroup_data sk_cgrp_data;
Johannes Weinerbaac50b2016-01-14 15:21:17 -0800464 struct mem_cgroup *sk_memcg;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700465 void (*sk_state_change)(struct sock *sk);
David S. Miller676d2362014-04-11 16:15:36 -0400466 void (*sk_data_ready)(struct sock *sk);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700467 void (*sk_write_space)(struct sock *sk);
468 void (*sk_error_report)(struct sock *sk);
Eric Dumazetdc6b9b72012-05-16 22:48:15 +0000469 int (*sk_backlog_rcv)(struct sock *sk,
470 struct sk_buff *skb);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700471 void (*sk_destruct)(struct sock *sk);
Craig Gallekef456142016-01-04 17:41:45 -0500472 struct sock_reuseport __rcu *sk_reuseport_cb;
Eric Dumazeta4298e42016-04-01 08:52:12 -0700473 struct rcu_head sk_rcu;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700474};
475
Pravin B Shelar559835ea2013-09-24 10:25:40 -0700476#define __sk_user_data(sk) ((*((void __rcu **)&(sk)->sk_user_data)))
477
478#define rcu_dereference_sk_user_data(sk) rcu_dereference(__sk_user_data((sk)))
479#define rcu_assign_sk_user_data(sk, ptr) rcu_assign_pointer(__sk_user_data((sk)), ptr)
480
Pavel Emelyanov4a17fd52012-04-19 03:39:36 +0000481/*
482 * SK_CAN_REUSE and SK_NO_REUSE on a socket mean that the socket is OK
483 * or not whether his port will be reused by someone else. SK_FORCE_REUSE
484 * on a socket means that the socket will reuse everybody else's port
485 * without looking at the other's sk_reuse value.
486 */
487
488#define SK_NO_REUSE 0
489#define SK_CAN_REUSE 1
490#define SK_FORCE_REUSE 2
491
samanthakumar627d2d62016-04-05 12:41:16 -0400492int sk_set_peek_off(struct sock *sk, int val);
493
Pavel Emelyanovef64a542012-02-21 07:31:34 +0000494static inline int sk_peek_offset(struct sock *sk, int flags)
495{
Willem de Bruijnb9bb53f2016-04-05 12:41:14 -0400496 if (unlikely(flags & MSG_PEEK)) {
497 s32 off = READ_ONCE(sk->sk_peek_off);
498 if (off >= 0)
499 return off;
500 }
501
502 return 0;
Pavel Emelyanovef64a542012-02-21 07:31:34 +0000503}
504
505static inline void sk_peek_offset_bwd(struct sock *sk, int val)
506{
Willem de Bruijnb9bb53f2016-04-05 12:41:14 -0400507 s32 off = READ_ONCE(sk->sk_peek_off);
508
509 if (unlikely(off >= 0)) {
510 off = max_t(s32, off - val, 0);
511 WRITE_ONCE(sk->sk_peek_off, off);
Pavel Emelyanovef64a542012-02-21 07:31:34 +0000512 }
513}
514
515static inline void sk_peek_offset_fwd(struct sock *sk, int val)
516{
Willem de Bruijnb9bb53f2016-04-05 12:41:14 -0400517 sk_peek_offset_bwd(sk, -val);
Pavel Emelyanovef64a542012-02-21 07:31:34 +0000518}
519
Linus Torvalds1da177e2005-04-16 15:20:36 -0700520/*
521 * Hashed lists helper routines
522 */
Li Zefanc4146642010-02-08 23:18:45 +0000523static inline struct sock *sk_entry(const struct hlist_node *node)
524{
525 return hlist_entry(node, struct sock, sk_node);
526}
527
Arnaldo Carvalho de Meloe48c4142005-08-09 20:09:46 -0700528static inline struct sock *__sk_head(const struct hlist_head *head)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700529{
530 return hlist_entry(head->first, struct sock, sk_node);
531}
532
Arnaldo Carvalho de Meloe48c4142005-08-09 20:09:46 -0700533static inline struct sock *sk_head(const struct hlist_head *head)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700534{
535 return hlist_empty(head) ? NULL : __sk_head(head);
536}
537
Eric Dumazet88ab1932008-11-16 19:39:21 -0800538static inline struct sock *__sk_nulls_head(const struct hlist_nulls_head *head)
539{
540 return hlist_nulls_entry(head->first, struct sock, sk_nulls_node);
541}
542
543static inline struct sock *sk_nulls_head(const struct hlist_nulls_head *head)
544{
545 return hlist_nulls_empty(head) ? NULL : __sk_nulls_head(head);
546}
547
Arnaldo Carvalho de Meloe48c4142005-08-09 20:09:46 -0700548static inline struct sock *sk_next(const struct sock *sk)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700549{
Geliang Tang6c59ebd2017-01-20 22:27:04 +0800550 return hlist_entry_safe(sk->sk_node.next, struct sock, sk_node);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700551}
552
Eric Dumazet88ab1932008-11-16 19:39:21 -0800553static inline struct sock *sk_nulls_next(const struct sock *sk)
554{
555 return (!is_a_nulls(sk->sk_nulls_node.next)) ?
556 hlist_nulls_entry(sk->sk_nulls_node.next,
557 struct sock, sk_nulls_node) :
558 NULL;
559}
560
Eric Dumazetdc6b9b72012-05-16 22:48:15 +0000561static inline bool sk_unhashed(const struct sock *sk)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700562{
563 return hlist_unhashed(&sk->sk_node);
564}
565
Eric Dumazetdc6b9b72012-05-16 22:48:15 +0000566static inline bool sk_hashed(const struct sock *sk)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700567{
Akinobu Mitada753be2006-04-28 15:21:23 -0700568 return !sk_unhashed(sk);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700569}
570
Eric Dumazetdc6b9b72012-05-16 22:48:15 +0000571static inline void sk_node_init(struct hlist_node *node)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700572{
573 node->pprev = NULL;
574}
575
Eric Dumazetdc6b9b72012-05-16 22:48:15 +0000576static inline void sk_nulls_node_init(struct hlist_nulls_node *node)
Eric Dumazet88ab1932008-11-16 19:39:21 -0800577{
578 node->pprev = NULL;
579}
580
Eric Dumazetdc6b9b72012-05-16 22:48:15 +0000581static inline void __sk_del_node(struct sock *sk)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700582{
583 __hlist_del(&sk->sk_node);
584}
585
stephen hemminger808f5112010-02-22 07:57:18 +0000586/* NB: equivalent to hlist_del_init_rcu */
Eric Dumazetdc6b9b72012-05-16 22:48:15 +0000587static inline bool __sk_del_node_init(struct sock *sk)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700588{
589 if (sk_hashed(sk)) {
590 __sk_del_node(sk);
591 sk_node_init(&sk->sk_node);
Eric Dumazetdc6b9b72012-05-16 22:48:15 +0000592 return true;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700593 }
Eric Dumazetdc6b9b72012-05-16 22:48:15 +0000594 return false;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700595}
596
597/* Grab socket reference count. This operation is valid only
598 when sk is ALREADY grabbed f.e. it is found in hash table
599 or a list and the lookup is made under lock preventing hash table
600 modifications.
601 */
602
Denys Vlasenkof9a7cbb2016-04-08 17:51:54 +0200603static __always_inline void sock_hold(struct sock *sk)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700604{
605 atomic_inc(&sk->sk_refcnt);
606}
607
608/* Ungrab socket in the context, which assumes that socket refcnt
609 cannot hit zero, f.e. it is true in context of any socketcall.
610 */
Denys Vlasenkof9a7cbb2016-04-08 17:51:54 +0200611static __always_inline void __sock_put(struct sock *sk)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700612{
613 atomic_dec(&sk->sk_refcnt);
614}
615
Eric Dumazetdc6b9b72012-05-16 22:48:15 +0000616static inline bool sk_del_node_init(struct sock *sk)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700617{
Eric Dumazetdc6b9b72012-05-16 22:48:15 +0000618 bool rc = __sk_del_node_init(sk);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700619
620 if (rc) {
621 /* paranoid for a while -acme */
622 WARN_ON(atomic_read(&sk->sk_refcnt) == 1);
623 __sock_put(sk);
624 }
625 return rc;
626}
stephen hemminger808f5112010-02-22 07:57:18 +0000627#define sk_del_node_init_rcu(sk) sk_del_node_init(sk)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700628
Eric Dumazetdc6b9b72012-05-16 22:48:15 +0000629static inline bool __sk_nulls_del_node_init_rcu(struct sock *sk)
Eric Dumazet271b72c2008-10-29 02:11:14 -0700630{
631 if (sk_hashed(sk)) {
Eric Dumazet88ab1932008-11-16 19:39:21 -0800632 hlist_nulls_del_init_rcu(&sk->sk_nulls_node);
Eric Dumazetdc6b9b72012-05-16 22:48:15 +0000633 return true;
Eric Dumazet271b72c2008-10-29 02:11:14 -0700634 }
Eric Dumazetdc6b9b72012-05-16 22:48:15 +0000635 return false;
Eric Dumazet271b72c2008-10-29 02:11:14 -0700636}
637
Eric Dumazetdc6b9b72012-05-16 22:48:15 +0000638static inline bool sk_nulls_del_node_init_rcu(struct sock *sk)
Eric Dumazet271b72c2008-10-29 02:11:14 -0700639{
Eric Dumazetdc6b9b72012-05-16 22:48:15 +0000640 bool rc = __sk_nulls_del_node_init_rcu(sk);
Eric Dumazet271b72c2008-10-29 02:11:14 -0700641
642 if (rc) {
643 /* paranoid for a while -acme */
644 WARN_ON(atomic_read(&sk->sk_refcnt) == 1);
645 __sock_put(sk);
646 }
647 return rc;
648}
649
Eric Dumazetdc6b9b72012-05-16 22:48:15 +0000650static inline void __sk_add_node(struct sock *sk, struct hlist_head *list)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700651{
652 hlist_add_head(&sk->sk_node, list);
653}
654
Eric Dumazetdc6b9b72012-05-16 22:48:15 +0000655static inline void sk_add_node(struct sock *sk, struct hlist_head *list)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700656{
657 sock_hold(sk);
658 __sk_add_node(sk, list);
659}
660
Eric Dumazetdc6b9b72012-05-16 22:48:15 +0000661static inline void sk_add_node_rcu(struct sock *sk, struct hlist_head *list)
stephen hemminger808f5112010-02-22 07:57:18 +0000662{
663 sock_hold(sk);
Craig Gallekd296ba62016-04-25 10:42:12 -0400664 if (IS_ENABLED(CONFIG_IPV6) && sk->sk_reuseport &&
665 sk->sk_family == AF_INET6)
666 hlist_add_tail_rcu(&sk->sk_node, list);
667 else
668 hlist_add_head_rcu(&sk->sk_node, list);
stephen hemminger808f5112010-02-22 07:57:18 +0000669}
670
Eric Dumazetdc6b9b72012-05-16 22:48:15 +0000671static inline void __sk_nulls_add_node_rcu(struct sock *sk, struct hlist_nulls_head *list)
Eric Dumazet271b72c2008-10-29 02:11:14 -0700672{
Craig Gallekd894ba12016-04-12 13:11:25 -0400673 if (IS_ENABLED(CONFIG_IPV6) && sk->sk_reuseport &&
674 sk->sk_family == AF_INET6)
675 hlist_nulls_add_tail_rcu(&sk->sk_nulls_node, list);
676 else
677 hlist_nulls_add_head_rcu(&sk->sk_nulls_node, list);
Eric Dumazet271b72c2008-10-29 02:11:14 -0700678}
679
Eric Dumazetdc6b9b72012-05-16 22:48:15 +0000680static inline void sk_nulls_add_node_rcu(struct sock *sk, struct hlist_nulls_head *list)
Eric Dumazet271b72c2008-10-29 02:11:14 -0700681{
682 sock_hold(sk);
Eric Dumazet88ab1932008-11-16 19:39:21 -0800683 __sk_nulls_add_node_rcu(sk, list);
Eric Dumazet271b72c2008-10-29 02:11:14 -0700684}
685
Eric Dumazetdc6b9b72012-05-16 22:48:15 +0000686static inline void __sk_del_bind_node(struct sock *sk)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700687{
688 __hlist_del(&sk->sk_bind_node);
689}
690
Eric Dumazetdc6b9b72012-05-16 22:48:15 +0000691static inline void sk_add_bind_node(struct sock *sk,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700692 struct hlist_head *list)
693{
694 hlist_add_head(&sk->sk_bind_node, list);
695}
696
Sasha Levinb67bfe02013-02-27 17:06:00 -0800697#define sk_for_each(__sk, list) \
698 hlist_for_each_entry(__sk, list, sk_node)
699#define sk_for_each_rcu(__sk, list) \
700 hlist_for_each_entry_rcu(__sk, list, sk_node)
Eric Dumazet88ab1932008-11-16 19:39:21 -0800701#define sk_nulls_for_each(__sk, node, list) \
702 hlist_nulls_for_each_entry(__sk, node, list, sk_nulls_node)
703#define sk_nulls_for_each_rcu(__sk, node, list) \
704 hlist_nulls_for_each_entry_rcu(__sk, node, list, sk_nulls_node)
Sasha Levinb67bfe02013-02-27 17:06:00 -0800705#define sk_for_each_from(__sk) \
706 hlist_for_each_entry_from(__sk, sk_node)
Eric Dumazet88ab1932008-11-16 19:39:21 -0800707#define sk_nulls_for_each_from(__sk, node) \
708 if (__sk && ({ node = &(__sk)->sk_nulls_node; 1; })) \
709 hlist_nulls_for_each_entry_from(__sk, node, sk_nulls_node)
Sasha Levinb67bfe02013-02-27 17:06:00 -0800710#define sk_for_each_safe(__sk, tmp, list) \
711 hlist_for_each_entry_safe(__sk, tmp, list, sk_node)
712#define sk_for_each_bound(__sk, list) \
713 hlist_for_each_entry(__sk, list, sk_bind_node)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700714
David Held2dc41cf2014-07-15 23:28:32 -0400715/**
Eric Dumazetca065d02016-04-01 08:52:13 -0700716 * sk_for_each_entry_offset_rcu - iterate over a list at a given struct offset
David Held2dc41cf2014-07-15 23:28:32 -0400717 * @tpos: the type * to use as a loop cursor.
718 * @pos: the &struct hlist_node to use as a loop cursor.
719 * @head: the head for your list.
720 * @offset: offset of hlist_node within the struct.
721 *
722 */
Eric Dumazetca065d02016-04-01 08:52:13 -0700723#define sk_for_each_entry_offset_rcu(tpos, pos, head, offset) \
724 for (pos = rcu_dereference((head)->first); \
725 pos != NULL && \
David Held2dc41cf2014-07-15 23:28:32 -0400726 ({ tpos = (typeof(*tpos) *)((void *)pos - offset); 1;}); \
Eric Dumazetca065d02016-04-01 08:52:13 -0700727 pos = rcu_dereference(pos->next))
David Held2dc41cf2014-07-15 23:28:32 -0400728
Eric W. Biedermanc336d142012-05-24 17:56:43 -0600729static inline struct user_namespace *sk_user_ns(struct sock *sk)
730{
731 /* Careful only use this in a context where these parameters
732 * can not change and must all be valid, such as recvmsg from
733 * userspace.
734 */
735 return sk->sk_socket->file->f_cred->user_ns;
736}
737
Linus Torvalds1da177e2005-04-16 15:20:36 -0700738/* Sock flags */
739enum sock_flags {
740 SOCK_DEAD,
741 SOCK_DONE,
742 SOCK_URGINLINE,
743 SOCK_KEEPOPEN,
744 SOCK_LINGER,
745 SOCK_DESTROY,
746 SOCK_BROADCAST,
747 SOCK_TIMESTAMP,
748 SOCK_ZAPPED,
749 SOCK_USE_WRITE_QUEUE, /* whether to call sk->sk_write_space in sock_wfree */
750 SOCK_DBG, /* %SO_DEBUG setting */
751 SOCK_RCVTSTAMP, /* %SO_TIMESTAMP setting */
Eric Dumazet92f37fd2007-03-25 22:14:49 -0700752 SOCK_RCVTSTAMPNS, /* %SO_TIMESTAMPNS setting */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700753 SOCK_LOCALROUTE, /* route locally only, %SO_DONTROUTE setting */
754 SOCK_QUEUE_SHRUNK, /* write queue has been shrunk recently */
Mel Gorman7cb02402012-07-31 16:44:16 -0700755 SOCK_MEMALLOC, /* VM depends on this socket for swapping */
Patrick Ohly20d49472009-02-12 05:03:38 +0000756 SOCK_TIMESTAMPING_RX_SOFTWARE, /* %SOF_TIMESTAMPING_RX_SOFTWARE */
Eric Dumazetbcdce712009-10-06 17:28:29 -0700757 SOCK_FASYNC, /* fasync() active */
Neil Horman3b885782009-10-12 13:26:31 -0700758 SOCK_RXQ_OVFL,
Shirley Ma1cdebb42011-07-06 12:17:30 +0000759 SOCK_ZEROCOPY, /* buffers from userspace */
Johannes Berg6e3e9392011-11-09 10:15:42 +0100760 SOCK_WIFI_STATUS, /* push wifi status to userspace */
Ben Greear3bdc0eb2012-02-11 15:39:30 +0000761 SOCK_NOFCS, /* Tell NIC not to do the Ethernet FCS.
762 * Will use last 4 bytes of packet sent from
763 * user-space instead.
764 */
Vincent Bernatd59577b2013-01-16 22:55:49 +0100765 SOCK_FILTER_LOCKED, /* Filter cannot be changed anymore */
Keller, Jacob E7d4c04f2013-03-28 11:19:25 +0000766 SOCK_SELECT_ERR_QUEUE, /* Wake select on error queue */
Eric Dumazeta4298e42016-04-01 08:52:12 -0700767 SOCK_RCU_FREE, /* wait rcu grace period in sk_destruct() */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700768};
769
Marcelo Ricardo Leitner01ce63c2015-12-04 15:14:04 -0200770#define SK_FLAGS_TIMESTAMP ((1UL << SOCK_TIMESTAMP) | (1UL << SOCK_TIMESTAMPING_RX_SOFTWARE))
771
Ralf Baechle53b924b2005-08-23 10:11:30 -0700772static inline void sock_copy_flags(struct sock *nsk, struct sock *osk)
773{
774 nsk->sk_flags = osk->sk_flags;
775}
776
Linus Torvalds1da177e2005-04-16 15:20:36 -0700777static inline void sock_set_flag(struct sock *sk, enum sock_flags flag)
778{
779 __set_bit(flag, &sk->sk_flags);
780}
781
782static inline void sock_reset_flag(struct sock *sk, enum sock_flags flag)
783{
784 __clear_bit(flag, &sk->sk_flags);
785}
786
Eric Dumazet1b23a5d2012-05-16 05:57:07 +0000787static inline bool sock_flag(const struct sock *sk, enum sock_flags flag)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700788{
789 return test_bit(flag, &sk->sk_flags);
790}
791
Mel Gormanc93bdd02012-07-31 16:44:19 -0700792#ifdef CONFIG_NET
793extern struct static_key memalloc_socks;
794static inline int sk_memalloc_socks(void)
795{
796 return static_key_false(&memalloc_socks);
797}
798#else
799
800static inline int sk_memalloc_socks(void)
801{
802 return 0;
803}
804
805#endif
806
Eric Dumazet7450aaf2015-11-30 08:57:28 -0800807static inline gfp_t sk_gfp_mask(const struct sock *sk, gfp_t gfp_mask)
Mel Gorman99a1dec2012-07-31 16:44:14 -0700808{
Eric Dumazet7450aaf2015-11-30 08:57:28 -0800809 return gfp_mask | (sk->sk_allocation & __GFP_MEMALLOC);
Mel Gorman99a1dec2012-07-31 16:44:14 -0700810}
811
Linus Torvalds1da177e2005-04-16 15:20:36 -0700812static inline void sk_acceptq_removed(struct sock *sk)
813{
814 sk->sk_ack_backlog--;
815}
816
817static inline void sk_acceptq_added(struct sock *sk)
818{
819 sk->sk_ack_backlog++;
820}
821
Eric Dumazetdc6b9b72012-05-16 22:48:15 +0000822static inline bool sk_acceptq_is_full(const struct sock *sk)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700823{
David S. Miller64a14652007-03-06 11:21:05 -0800824 return sk->sk_ack_backlog > sk->sk_max_ack_backlog;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700825}
826
827/*
828 * Compute minimal free write space needed to queue new packets.
829 */
Eric Dumazetdc6b9b72012-05-16 22:48:15 +0000830static inline int sk_stream_min_wspace(const struct sock *sk)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700831{
Eric Dumazet8df09ea2007-12-21 03:07:41 -0800832 return sk->sk_wmem_queued >> 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700833}
834
Eric Dumazetdc6b9b72012-05-16 22:48:15 +0000835static inline int sk_stream_wspace(const struct sock *sk)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700836{
837 return sk->sk_sndbuf - sk->sk_wmem_queued;
838}
839
Joe Perches69336bd2013-09-22 10:32:26 -0700840void sk_stream_write_space(struct sock *sk);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700841
Zhu Yi8eae9392010-03-04 18:01:40 +0000842/* OOB backlog add */
Zhu Yia3a858f2010-03-04 18:01:47 +0000843static inline void __sk_add_backlog(struct sock *sk, struct sk_buff *skb)
Stephen Hemminger9ee6b532005-11-08 09:39:42 -0800844{
Eric Dumazet7fee2262010-05-11 23:19:48 +0000845 /* dont let skb dst not refcounted, we are going to leave rcu lock */
Eric Dumazet5037e9e2015-12-14 14:08:53 -0800846 skb_dst_force_safe(skb);
Eric Dumazet7fee2262010-05-11 23:19:48 +0000847
848 if (!sk->sk_backlog.tail)
849 sk->sk_backlog.head = skb;
850 else
Stephen Hemminger9ee6b532005-11-08 09:39:42 -0800851 sk->sk_backlog.tail->next = skb;
Eric Dumazet7fee2262010-05-11 23:19:48 +0000852
853 sk->sk_backlog.tail = skb;
Stephen Hemminger9ee6b532005-11-08 09:39:42 -0800854 skb->next = NULL;
855}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700856
Eric Dumazetc3774112010-04-27 15:13:20 -0700857/*
858 * Take into account size of receive queue and backlog queue
Eric Dumazet0fd7bac2011-12-21 07:11:44 +0000859 * Do not take into account this skb truesize,
860 * to allow even a single big packet to come.
Eric Dumazetc3774112010-04-27 15:13:20 -0700861 */
Sorin Dumitru274f4822014-07-22 21:16:51 +0300862static inline bool sk_rcvqueues_full(const struct sock *sk, unsigned int limit)
Eric Dumazetc3774112010-04-27 15:13:20 -0700863{
864 unsigned int qsize = sk->sk_backlog.len + atomic_read(&sk->sk_rmem_alloc);
865
Eric Dumazetf545a382012-04-22 23:34:26 +0000866 return qsize > limit;
Eric Dumazetc3774112010-04-27 15:13:20 -0700867}
868
Zhu Yi8eae9392010-03-04 18:01:40 +0000869/* The per-socket spinlock must be held here. */
Eric Dumazetf545a382012-04-22 23:34:26 +0000870static inline __must_check int sk_add_backlog(struct sock *sk, struct sk_buff *skb,
871 unsigned int limit)
Zhu Yi8eae9392010-03-04 18:01:40 +0000872{
Sorin Dumitru274f4822014-07-22 21:16:51 +0300873 if (sk_rcvqueues_full(sk, limit))
Zhu Yi8eae9392010-03-04 18:01:40 +0000874 return -ENOBUFS;
875
Eric Dumazetc7c49b82015-09-29 18:52:25 -0700876 /*
877 * If the skb was allocated from pfmemalloc reserves, only
878 * allow SOCK_MEMALLOC sockets to use it as this socket is
879 * helping free memory
880 */
881 if (skb_pfmemalloc(skb) && !sock_flag(sk, SOCK_MEMALLOC))
882 return -ENOMEM;
883
Zhu Yia3a858f2010-03-04 18:01:47 +0000884 __sk_add_backlog(sk, skb);
Zhu Yi8eae9392010-03-04 18:01:40 +0000885 sk->sk_backlog.len += skb->truesize;
886 return 0;
887}
888
Joe Perches69336bd2013-09-22 10:32:26 -0700889int __sk_backlog_rcv(struct sock *sk, struct sk_buff *skb);
Mel Gormanb4b9e352012-07-31 16:44:26 -0700890
Peter Zijlstrac57943a2008-10-07 14:18:42 -0700891static inline int sk_backlog_rcv(struct sock *sk, struct sk_buff *skb)
892{
Mel Gormanb4b9e352012-07-31 16:44:26 -0700893 if (sk_memalloc_socks() && skb_pfmemalloc(skb))
894 return __sk_backlog_rcv(sk, skb);
895
Peter Zijlstrac57943a2008-10-07 14:18:42 -0700896 return sk->sk_backlog_rcv(sk, skb);
897}
898
Eric Dumazet2c8c56e2014-11-11 05:54:28 -0800899static inline void sk_incoming_cpu_update(struct sock *sk)
900{
901 sk->sk_incoming_cpu = raw_smp_processor_id();
902}
903
Tom Herbertfe477552013-12-22 18:54:31 +0800904static inline void sock_rps_record_flow_hash(__u32 hash)
David S. Millerc58dc012010-04-27 15:05:31 -0700905{
906#ifdef CONFIG_RPS
907 struct rps_sock_flow_table *sock_flow_table;
908
909 rcu_read_lock();
910 sock_flow_table = rcu_dereference(rps_sock_flow_table);
Tom Herbertfe477552013-12-22 18:54:31 +0800911 rps_record_sock_flow(sock_flow_table, hash);
David S. Millerc58dc012010-04-27 15:05:31 -0700912 rcu_read_unlock();
913#endif
914}
915
Tom Herbertfe477552013-12-22 18:54:31 +0800916static inline void sock_rps_record_flow(const struct sock *sk)
917{
Zhi Yong Wuc9d8ca02014-01-01 04:31:01 +0800918#ifdef CONFIG_RPS
Eric Dumazet13bfff22016-12-07 08:29:10 -0800919 if (static_key_false(&rfs_needed)) {
920 /* Reading sk->sk_rxhash might incur an expensive cache line
921 * miss.
922 *
923 * TCP_ESTABLISHED does cover almost all states where RFS
924 * might be useful, and is cheaper [1] than testing :
925 * IPv4: inet_sk(sk)->inet_daddr
926 * IPv6: ipv6_addr_any(&sk->sk_v6_daddr)
927 * OR an additional socket flag
928 * [1] : sk_state and sk_prot are in the same cache line.
929 */
930 if (sk->sk_state == TCP_ESTABLISHED)
931 sock_rps_record_flow_hash(sk->sk_rxhash);
932 }
Zhi Yong Wuc9d8ca02014-01-01 04:31:01 +0800933#endif
Tom Herbertfe477552013-12-22 18:54:31 +0800934}
935
Tom Herbertbdeab992011-08-14 19:45:55 +0000936static inline void sock_rps_save_rxhash(struct sock *sk,
937 const struct sk_buff *skb)
David S. Millerc58dc012010-04-27 15:05:31 -0700938{
939#ifdef CONFIG_RPS
Eric Dumazet567e4b72015-02-06 12:59:01 -0800940 if (unlikely(sk->sk_rxhash != skb->hash))
Tom Herbert61b905d2014-03-24 15:34:47 -0700941 sk->sk_rxhash = skb->hash;
David S. Millerc58dc012010-04-27 15:05:31 -0700942#endif
943}
944
Tom Herbertbdeab992011-08-14 19:45:55 +0000945static inline void sock_rps_reset_rxhash(struct sock *sk)
946{
947#ifdef CONFIG_RPS
Tom Herbertbdeab992011-08-14 19:45:55 +0000948 sk->sk_rxhash = 0;
949#endif
950}
951
WANG Congd9dc8b02016-11-11 10:20:50 -0800952#define sk_wait_event(__sk, __timeo, __condition, __wait) \
Stephen Hemmingercfcabdc2007-10-09 01:59:42 -0700953 ({ int __rc; \
954 release_sock(__sk); \
955 __rc = __condition; \
956 if (!__rc) { \
WANG Congd9dc8b02016-11-11 10:20:50 -0800957 *(__timeo) = wait_woken(__wait, \
958 TASK_INTERRUPTIBLE, \
959 *(__timeo)); \
Stephen Hemmingercfcabdc2007-10-09 01:59:42 -0700960 } \
WANG Congd9dc8b02016-11-11 10:20:50 -0800961 sched_annotate_sleep(); \
Stephen Hemmingercfcabdc2007-10-09 01:59:42 -0700962 lock_sock(__sk); \
963 __rc = __condition; \
964 __rc; \
965 })
Linus Torvalds1da177e2005-04-16 15:20:36 -0700966
Joe Perches69336bd2013-09-22 10:32:26 -0700967int sk_stream_wait_connect(struct sock *sk, long *timeo_p);
968int sk_stream_wait_memory(struct sock *sk, long *timeo_p);
969void sk_stream_wait_close(struct sock *sk, long timeo_p);
970int sk_stream_error(struct sock *sk, int flags, int err);
971void sk_stream_kill_queues(struct sock *sk);
972void sk_set_memalloc(struct sock *sk);
973void sk_clear_memalloc(struct sock *sk);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700974
Eric Dumazetd41a69f2016-04-29 14:16:53 -0700975void __sk_flush_backlog(struct sock *sk);
976
977static inline bool sk_flush_backlog(struct sock *sk)
978{
979 if (unlikely(READ_ONCE(sk->sk_backlog.tail))) {
980 __sk_flush_backlog(sk);
981 return true;
982 }
983 return false;
984}
985
Sabrina Dubrocadfbafc92015-07-24 18:19:25 +0200986int sk_wait_data(struct sock *sk, long *timeo, const struct sk_buff *skb);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700987
Arnaldo Carvalho de Melo60236fd2005-06-18 22:47:21 -0700988struct request_sock_ops;
Arnaldo Carvalho de Melo6d6ee432005-12-13 23:25:19 -0800989struct timewait_sock_ops;
Arnaldo Carvalho de Meloab1e0a12008-02-03 04:06:04 -0800990struct inet_hashinfo;
Pavel Emelyanovfc8717b2008-03-22 16:56:51 -0700991struct raw_hashinfo;
Ursula Braunf16a7dd2017-01-09 16:55:26 +0100992struct smc_hashinfo;
Paul Gortmakerde477252011-05-26 13:46:22 -0400993struct module;
Arnaldo Carvalho de Melo2e6599c2005-06-18 22:46:52 -0700994
Eric Dumazetf77d6022013-05-09 10:28:16 +0000995/*
996 * caches using SLAB_DESTROY_BY_RCU should let .next pointer from nulls nodes
997 * un-modified. Special care is taken when initializing object to zero.
998 */
999static inline void sk_prot_clear_nulls(struct sock *sk, int size)
1000{
1001 if (offsetof(struct sock, sk_node.next) != 0)
1002 memset(sk, 0, offsetof(struct sock, sk_node.next));
1003 memset(&sk->sk_node.pprev, 0,
1004 size - offsetof(struct sock, sk_node.pprev));
1005}
1006
Linus Torvalds1da177e2005-04-16 15:20:36 -07001007/* Networking protocol blocks we attach to sockets.
1008 * socket layer -> transport layer interface
Linus Torvalds1da177e2005-04-16 15:20:36 -07001009 */
1010struct proto {
Eric Dumazetdc6b9b72012-05-16 22:48:15 +00001011 void (*close)(struct sock *sk,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001012 long timeout);
1013 int (*connect)(struct sock *sk,
Eric Dumazetdc6b9b72012-05-16 22:48:15 +00001014 struct sockaddr *uaddr,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001015 int addr_len);
1016 int (*disconnect)(struct sock *sk, int flags);
1017
Eric Dumazetdc6b9b72012-05-16 22:48:15 +00001018 struct sock * (*accept)(struct sock *sk, int flags, int *err);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001019
1020 int (*ioctl)(struct sock *sk, int cmd,
1021 unsigned long arg);
1022 int (*init)(struct sock *sk);
Brian Haley7d06b2e2008-06-14 17:04:49 -07001023 void (*destroy)(struct sock *sk);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001024 void (*shutdown)(struct sock *sk, int how);
Eric Dumazetdc6b9b72012-05-16 22:48:15 +00001025 int (*setsockopt)(struct sock *sk, int level,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001026 int optname, char __user *optval,
David S. Millerb7058842009-09-30 16:12:20 -07001027 unsigned int optlen);
Eric Dumazetdc6b9b72012-05-16 22:48:15 +00001028 int (*getsockopt)(struct sock *sk, int level,
1029 int optname, char __user *optval,
1030 int __user *option);
Ursula Braun4b9d07a2017-01-09 16:55:12 +01001031 void (*keepalive)(struct sock *sk, int valbool);
Alexey Dobriyanaf01d532008-08-28 02:53:51 -07001032#ifdef CONFIG_COMPAT
Dmitry Mishin3fdadf72006-03-20 22:45:21 -08001033 int (*compat_setsockopt)(struct sock *sk,
1034 int level,
1035 int optname, char __user *optval,
David S. Millerb7058842009-09-30 16:12:20 -07001036 unsigned int optlen);
Dmitry Mishin3fdadf72006-03-20 22:45:21 -08001037 int (*compat_getsockopt)(struct sock *sk,
1038 int level,
1039 int optname, char __user *optval,
1040 int __user *option);
Eric W. Biederman709b46e2011-01-29 16:15:56 +00001041 int (*compat_ioctl)(struct sock *sk,
1042 unsigned int cmd, unsigned long arg);
Alexey Dobriyanaf01d532008-08-28 02:53:51 -07001043#endif
Ying Xue1b784142015-03-02 15:37:48 +08001044 int (*sendmsg)(struct sock *sk, struct msghdr *msg,
1045 size_t len);
1046 int (*recvmsg)(struct sock *sk, struct msghdr *msg,
Eric Dumazetdc6b9b72012-05-16 22:48:15 +00001047 size_t len, int noblock, int flags,
1048 int *addr_len);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001049 int (*sendpage)(struct sock *sk, struct page *page,
1050 int offset, size_t size, int flags);
Eric Dumazetdc6b9b72012-05-16 22:48:15 +00001051 int (*bind)(struct sock *sk,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001052 struct sockaddr *uaddr, int addr_len);
1053
Eric Dumazetdc6b9b72012-05-16 22:48:15 +00001054 int (*backlog_rcv) (struct sock *sk,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001055 struct sk_buff *skb);
1056
Eric Dumazet46d3cea2012-07-11 05:50:31 +00001057 void (*release_cb)(struct sock *sk);
1058
Linus Torvalds1da177e2005-04-16 15:20:36 -07001059 /* Keeping track of sk's, looking them up, and port selection methods. */
Craig Gallek086c6532016-02-10 11:50:35 -05001060 int (*hash)(struct sock *sk);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001061 void (*unhash)(struct sock *sk);
Eric Dumazet719f8352010-09-08 05:08:44 +00001062 void (*rehash)(struct sock *sk);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001063 int (*get_port)(struct sock *sk, unsigned short snum);
1064
Eric Dumazet286ab3d2007-11-05 23:38:39 -08001065 /* Keeping track of sockets in use */
Eric Dumazet65f76512008-01-03 20:46:48 -08001066#ifdef CONFIG_PROC_FS
Pavel Emelyanov13ff3d62008-03-28 16:38:17 -07001067 unsigned int inuse_idx;
Eric Dumazet65f76512008-01-03 20:46:48 -08001068#endif
Arnaldo Carvalho de Meloebb53d72007-11-21 22:08:50 +08001069
Eric Dumazetc9bee3b72013-07-22 20:27:07 -07001070 bool (*stream_memory_free)(const struct sock *sk);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001071 /* Memory pressure */
Pavel Emelyanov5c52ba12008-07-16 20:28:10 -07001072 void (*enter_memory_pressure)(struct sock *sk);
Eric Dumazet8d987e52010-11-09 23:24:26 +00001073 atomic_long_t *memory_allocated; /* Current allocated memory. */
Eric Dumazet17483762008-11-25 21:16:35 -08001074 struct percpu_counter *sockets_allocated; /* Current number of sockets. */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001075 /*
1076 * Pressure flag: try to collapse.
1077 * Technical note: it is used by multiple contexts non atomically.
Hideo Aoki3ab224b2007-12-31 00:11:19 -08001078 * All the __sk_mem_schedule() is of this nature: accounting
Linus Torvalds1da177e2005-04-16 15:20:36 -07001079 * is strict, actions are advisory and have some latency.
1080 */
1081 int *memory_pressure;
Eric Dumazet8d987e52010-11-09 23:24:26 +00001082 long *sysctl_mem;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001083 int *sysctl_wmem;
1084 int *sysctl_rmem;
1085 int max_header;
Changli Gao7ba42912010-07-10 20:41:55 +00001086 bool no_autobind;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001087
Eric Dumazet271b72c2008-10-29 02:11:14 -07001088 struct kmem_cache *slab;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001089 unsigned int obj_size;
Eric Dumazet271b72c2008-10-29 02:11:14 -07001090 int slab_flags;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001091
Eric Dumazetdd24c002008-11-25 21:17:14 -08001092 struct percpu_counter *orphan_count;
Arnaldo Carvalho de Melo8feaf0c02005-08-09 20:09:30 -07001093
Arnaldo Carvalho de Melo60236fd2005-06-18 22:47:21 -07001094 struct request_sock_ops *rsk_prot;
Arnaldo Carvalho de Melo6d6ee432005-12-13 23:25:19 -08001095 struct timewait_sock_ops *twsk_prot;
Arnaldo Carvalho de Melo2e6599c2005-06-18 22:46:52 -07001096
Pavel Emelyanov39d8cda2008-03-22 16:50:58 -07001097 union {
1098 struct inet_hashinfo *hashinfo;
Eric Dumazet645ca702008-10-29 01:41:45 -07001099 struct udp_table *udp_table;
Pavel Emelyanovfc8717b2008-03-22 16:56:51 -07001100 struct raw_hashinfo *raw_hash;
Ursula Braunf16a7dd2017-01-09 16:55:26 +01001101 struct smc_hashinfo *smc_hash;
Pavel Emelyanov39d8cda2008-03-22 16:50:58 -07001102 } h;
Arnaldo Carvalho de Meloab1e0a12008-02-03 04:06:04 -08001103
Linus Torvalds1da177e2005-04-16 15:20:36 -07001104 struct module *owner;
1105
1106 char name[32];
1107
1108 struct list_head node;
Arnaldo Carvalho de Meloe6848972005-08-09 19:45:38 -07001109#ifdef SOCK_REFCNT_DEBUG
1110 atomic_t socks;
1111#endif
Lorenzo Colitti64be0ae2015-12-16 12:30:03 +09001112 int (*diag_destroy)(struct sock *sk, int err);
Glauber Costae1aab162011-12-11 21:47:03 +00001113};
1114
Joe Perches69336bd2013-09-22 10:32:26 -07001115int proto_register(struct proto *prot, int alloc_slab);
1116void proto_unregister(struct proto *prot);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001117
Arnaldo Carvalho de Meloe6848972005-08-09 19:45:38 -07001118#ifdef SOCK_REFCNT_DEBUG
1119static inline void sk_refcnt_debug_inc(struct sock *sk)
1120{
1121 atomic_inc(&sk->sk_prot->socks);
1122}
1123
1124static inline void sk_refcnt_debug_dec(struct sock *sk)
1125{
1126 atomic_dec(&sk->sk_prot->socks);
1127 printk(KERN_DEBUG "%s socket %p released, %d are still alive\n",
1128 sk->sk_prot->name, sk, atomic_read(&sk->sk_prot->socks));
1129}
1130
Ying Xuedec34fb2013-02-15 22:28:25 +00001131static inline void sk_refcnt_debug_release(const struct sock *sk)
Arnaldo Carvalho de Meloe6848972005-08-09 19:45:38 -07001132{
1133 if (atomic_read(&sk->sk_refcnt) != 1)
1134 printk(KERN_DEBUG "Destruction of the %s socket %p delayed, refcnt=%d\n",
1135 sk->sk_prot->name, sk, atomic_read(&sk->sk_refcnt));
1136}
1137#else /* SOCK_REFCNT_DEBUG */
1138#define sk_refcnt_debug_inc(sk) do { } while (0)
1139#define sk_refcnt_debug_dec(sk) do { } while (0)
1140#define sk_refcnt_debug_release(sk) do { } while (0)
1141#endif /* SOCK_REFCNT_DEBUG */
1142
Eric Dumazetc9bee3b72013-07-22 20:27:07 -07001143static inline bool sk_stream_memory_free(const struct sock *sk)
1144{
1145 if (sk->sk_wmem_queued >= sk->sk_sndbuf)
1146 return false;
1147
1148 return sk->sk_prot->stream_memory_free ?
1149 sk->sk_prot->stream_memory_free(sk) : true;
1150}
1151
Eric Dumazet64dc6132013-07-22 20:26:31 -07001152static inline bool sk_stream_is_writeable(const struct sock *sk)
1153{
Eric Dumazetc9bee3b72013-07-22 20:27:07 -07001154 return sk_stream_wspace(sk) >= sk_stream_min_wspace(sk) &&
1155 sk_stream_memory_free(sk);
Eric Dumazet64dc6132013-07-22 20:26:31 -07001156}
Glauber Costae1aab162011-12-11 21:47:03 +00001157
Daniel Borkmann54fd9c22016-08-18 01:00:41 +02001158static inline int sk_under_cgroup_hierarchy(struct sock *sk,
1159 struct cgroup *ancestor)
1160{
1161#ifdef CONFIG_SOCK_CGROUP_DATA
1162 return cgroup_is_descendant(sock_cgroup_ptr(&sk->sk_cgrp_data),
1163 ancestor);
1164#else
1165 return -ENOTSUPP;
1166#endif
1167}
Eric Dumazetc9bee3b72013-07-22 20:27:07 -07001168
Glauber Costa180d8cd2011-12-11 21:47:02 +00001169static inline bool sk_has_memory_pressure(const struct sock *sk)
1170{
1171 return sk->sk_prot->memory_pressure != NULL;
1172}
1173
1174static inline bool sk_under_memory_pressure(const struct sock *sk)
1175{
1176 if (!sk->sk_prot->memory_pressure)
1177 return false;
Glauber Costae1aab162011-12-11 21:47:03 +00001178
Johannes Weinerbaac50b2016-01-14 15:21:17 -08001179 if (mem_cgroup_sockets_enabled && sk->sk_memcg &&
1180 mem_cgroup_under_socket_pressure(sk->sk_memcg))
Johannes Weinere8056052016-01-14 15:21:14 -08001181 return true;
Glauber Costae1aab162011-12-11 21:47:03 +00001182
Christoph Paasch35b87f62013-10-23 12:49:21 -07001183 return !!*sk->sk_prot->memory_pressure;
Glauber Costa180d8cd2011-12-11 21:47:02 +00001184}
1185
1186static inline void sk_leave_memory_pressure(struct sock *sk)
1187{
1188 int *memory_pressure = sk->sk_prot->memory_pressure;
1189
Glauber Costae1aab162011-12-11 21:47:03 +00001190 if (!memory_pressure)
1191 return;
1192
1193 if (*memory_pressure)
Glauber Costa180d8cd2011-12-11 21:47:02 +00001194 *memory_pressure = 0;
1195}
1196
1197static inline void sk_enter_memory_pressure(struct sock *sk)
1198{
Glauber Costae1aab162011-12-11 21:47:03 +00001199 if (!sk->sk_prot->enter_memory_pressure)
1200 return;
1201
Glauber Costae1aab162011-12-11 21:47:03 +00001202 sk->sk_prot->enter_memory_pressure(sk);
Glauber Costa180d8cd2011-12-11 21:47:02 +00001203}
1204
Glauber Costa180d8cd2011-12-11 21:47:02 +00001205static inline long
1206sk_memory_allocated(const struct sock *sk)
1207{
Johannes Weinere8056052016-01-14 15:21:14 -08001208 return atomic_long_read(sk->sk_prot->memory_allocated);
Glauber Costa180d8cd2011-12-11 21:47:02 +00001209}
1210
1211static inline long
Johannes Weinere8056052016-01-14 15:21:14 -08001212sk_memory_allocated_add(struct sock *sk, int amt)
Glauber Costa180d8cd2011-12-11 21:47:02 +00001213{
Johannes Weinere8056052016-01-14 15:21:14 -08001214 return atomic_long_add_return(amt, sk->sk_prot->memory_allocated);
Glauber Costa180d8cd2011-12-11 21:47:02 +00001215}
1216
1217static inline void
Glauber Costa0e90b312012-01-20 04:57:16 +00001218sk_memory_allocated_sub(struct sock *sk, int amt)
Glauber Costa180d8cd2011-12-11 21:47:02 +00001219{
Johannes Weinere8056052016-01-14 15:21:14 -08001220 atomic_long_sub(amt, sk->sk_prot->memory_allocated);
Glauber Costa180d8cd2011-12-11 21:47:02 +00001221}
1222
1223static inline void sk_sockets_allocated_dec(struct sock *sk)
1224{
Johannes Weineraf95d7d2016-01-14 15:21:08 -08001225 percpu_counter_dec(sk->sk_prot->sockets_allocated);
Glauber Costa180d8cd2011-12-11 21:47:02 +00001226}
1227
1228static inline void sk_sockets_allocated_inc(struct sock *sk)
1229{
Johannes Weineraf95d7d2016-01-14 15:21:08 -08001230 percpu_counter_inc(sk->sk_prot->sockets_allocated);
Glauber Costa180d8cd2011-12-11 21:47:02 +00001231}
1232
1233static inline int
1234sk_sockets_allocated_read_positive(struct sock *sk)
1235{
Johannes Weineraf95d7d2016-01-14 15:21:08 -08001236 return percpu_counter_read_positive(sk->sk_prot->sockets_allocated);
Glauber Costa180d8cd2011-12-11 21:47:02 +00001237}
1238
1239static inline int
1240proto_sockets_allocated_sum_positive(struct proto *prot)
1241{
1242 return percpu_counter_sum_positive(prot->sockets_allocated);
1243}
1244
1245static inline long
1246proto_memory_allocated(struct proto *prot)
1247{
1248 return atomic_long_read(prot->memory_allocated);
1249}
1250
1251static inline bool
1252proto_memory_pressure(struct proto *prot)
1253{
1254 if (!prot->memory_pressure)
1255 return false;
1256 return !!*prot->memory_pressure;
1257}
1258
Eric Dumazet65f76512008-01-03 20:46:48 -08001259
1260#ifdef CONFIG_PROC_FS
Linus Torvalds1da177e2005-04-16 15:20:36 -07001261/* Called with local bh disabled */
Joe Perches69336bd2013-09-22 10:32:26 -07001262void sock_prot_inuse_add(struct net *net, struct proto *prot, int inc);
1263int sock_prot_inuse_get(struct net *net, struct proto *proto);
Eric Dumazet65f76512008-01-03 20:46:48 -08001264#else
Eric Dumazetdc6b9b72012-05-16 22:48:15 +00001265static inline void sock_prot_inuse_add(struct net *net, struct proto *prot,
Pavel Emelyanovc29a0bc2008-03-31 19:41:46 -07001266 int inc)
Eric Dumazet65f76512008-01-03 20:46:48 -08001267{
1268}
Eric Dumazet65f76512008-01-03 20:46:48 -08001269#endif
1270
Linus Torvalds1da177e2005-04-16 15:20:36 -07001271
Arnaldo Carvalho de Melo614c6cb2005-08-09 19:47:37 -07001272/* With per-bucket locks this operation is not-atomic, so that
1273 * this version is not worse.
1274 */
Craig Gallek086c6532016-02-10 11:50:35 -05001275static inline int __sk_prot_rehash(struct sock *sk)
Arnaldo Carvalho de Melo614c6cb2005-08-09 19:47:37 -07001276{
1277 sk->sk_prot->unhash(sk);
Craig Gallek086c6532016-02-10 11:50:35 -05001278 return sk->sk_prot->hash(sk);
Arnaldo Carvalho de Melo614c6cb2005-08-09 19:47:37 -07001279}
1280
Linus Torvalds1da177e2005-04-16 15:20:36 -07001281/* About 10 seconds */
1282#define SOCK_DESTROY_TIME (10*HZ)
1283
1284/* Sockets 0-1023 can't be bound to unless you are superuser */
1285#define PROT_SOCK 1024
1286
1287#define SHUTDOWN_MASK 3
1288#define RCV_SHUTDOWN 1
1289#define SEND_SHUTDOWN 2
1290
1291#define SOCK_SNDBUF_LOCK 1
1292#define SOCK_RCVBUF_LOCK 2
1293#define SOCK_BINDADDR_LOCK 4
1294#define SOCK_BINDPORT_LOCK 8
1295
Linus Torvalds1da177e2005-04-16 15:20:36 -07001296struct socket_alloc {
1297 struct socket socket;
1298 struct inode vfs_inode;
1299};
1300
1301static inline struct socket *SOCKET_I(struct inode *inode)
1302{
1303 return &container_of(inode, struct socket_alloc, vfs_inode)->socket;
1304}
1305
1306static inline struct inode *SOCK_INODE(struct socket *socket)
1307{
1308 return &container_of(socket, struct socket_alloc, socket)->vfs_inode;
1309}
1310
Hideo Aoki3ab224b2007-12-31 00:11:19 -08001311/*
1312 * Functions for memory accounting
1313 */
Paolo Abenif8c3bf02016-10-21 13:55:45 +02001314int __sk_mem_raise_allocated(struct sock *sk, int size, int amt, int kind);
Joe Perches69336bd2013-09-22 10:32:26 -07001315int __sk_mem_schedule(struct sock *sk, int size, int kind);
Paolo Abenif8c3bf02016-10-21 13:55:45 +02001316void __sk_mem_reduce_allocated(struct sock *sk, int amount);
Eric Dumazet1a24e042015-05-15 12:39:25 -07001317void __sk_mem_reclaim(struct sock *sk, int amount);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001318
Eric Dumazetbd68a2a2016-10-31 13:32:55 -07001319/* We used to have PAGE_SIZE here, but systems with 64KB pages
1320 * do not necessarily have 16x time more memory than 4KB ones.
1321 */
1322#define SK_MEM_QUANTUM 4096
Hideo Aoki3ab224b2007-12-31 00:11:19 -08001323#define SK_MEM_QUANTUM_SHIFT ilog2(SK_MEM_QUANTUM)
1324#define SK_MEM_SEND 0
1325#define SK_MEM_RECV 1
Linus Torvalds1da177e2005-04-16 15:20:36 -07001326
Eric Dumazetbd68a2a2016-10-31 13:32:55 -07001327/* sysctl_mem values are in pages, we convert them in SK_MEM_QUANTUM units */
1328static inline long sk_prot_mem_limits(const struct sock *sk, int index)
1329{
1330 long val = sk->sk_prot->sysctl_mem[index];
1331
1332#if PAGE_SIZE > SK_MEM_QUANTUM
1333 val <<= PAGE_SHIFT - SK_MEM_QUANTUM_SHIFT;
1334#elif PAGE_SIZE < SK_MEM_QUANTUM
1335 val >>= SK_MEM_QUANTUM_SHIFT - PAGE_SHIFT;
1336#endif
1337 return val;
1338}
1339
Hideo Aoki3ab224b2007-12-31 00:11:19 -08001340static inline int sk_mem_pages(int amt)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001341{
Hideo Aoki3ab224b2007-12-31 00:11:19 -08001342 return (amt + SK_MEM_QUANTUM - 1) >> SK_MEM_QUANTUM_SHIFT;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001343}
1344
Eric Dumazetdc6b9b72012-05-16 22:48:15 +00001345static inline bool sk_has_account(struct sock *sk)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001346{
Hideo Aoki3ab224b2007-12-31 00:11:19 -08001347 /* return true if protocol supports memory accounting */
1348 return !!sk->sk_prot->memory_allocated;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001349}
1350
Eric Dumazetdc6b9b72012-05-16 22:48:15 +00001351static inline bool sk_wmem_schedule(struct sock *sk, int size)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001352{
Hideo Aoki3ab224b2007-12-31 00:11:19 -08001353 if (!sk_has_account(sk))
Eric Dumazetdc6b9b72012-05-16 22:48:15 +00001354 return true;
Herbert Xud80d99d2005-09-01 17:48:23 -07001355 return size <= sk->sk_forward_alloc ||
Hideo Aoki3ab224b2007-12-31 00:11:19 -08001356 __sk_mem_schedule(sk, size, SK_MEM_SEND);
1357}
1358
Mel Gormanc76562b2012-07-31 16:44:41 -07001359static inline bool
Chuck Lever35c448a2012-09-17 14:09:11 -07001360sk_rmem_schedule(struct sock *sk, struct sk_buff *skb, int size)
Hideo Aoki3ab224b2007-12-31 00:11:19 -08001361{
1362 if (!sk_has_account(sk))
Eric Dumazetdc6b9b72012-05-16 22:48:15 +00001363 return true;
Mel Gormanc76562b2012-07-31 16:44:41 -07001364 return size<= sk->sk_forward_alloc ||
1365 __sk_mem_schedule(sk, size, SK_MEM_RECV) ||
1366 skb_pfmemalloc(skb);
Hideo Aoki3ab224b2007-12-31 00:11:19 -08001367}
1368
1369static inline void sk_mem_reclaim(struct sock *sk)
1370{
1371 if (!sk_has_account(sk))
1372 return;
1373 if (sk->sk_forward_alloc >= SK_MEM_QUANTUM)
Eric Dumazet1a24e042015-05-15 12:39:25 -07001374 __sk_mem_reclaim(sk, sk->sk_forward_alloc);
Hideo Aoki3ab224b2007-12-31 00:11:19 -08001375}
1376
David S. Miller9993e7d2008-01-10 21:56:38 -08001377static inline void sk_mem_reclaim_partial(struct sock *sk)
1378{
1379 if (!sk_has_account(sk))
1380 return;
1381 if (sk->sk_forward_alloc > SK_MEM_QUANTUM)
Eric Dumazet1a24e042015-05-15 12:39:25 -07001382 __sk_mem_reclaim(sk, sk->sk_forward_alloc - 1);
David S. Miller9993e7d2008-01-10 21:56:38 -08001383}
1384
Hideo Aoki3ab224b2007-12-31 00:11:19 -08001385static inline void sk_mem_charge(struct sock *sk, int size)
1386{
1387 if (!sk_has_account(sk))
1388 return;
1389 sk->sk_forward_alloc -= size;
1390}
1391
1392static inline void sk_mem_uncharge(struct sock *sk, int size)
1393{
1394 if (!sk_has_account(sk))
1395 return;
1396 sk->sk_forward_alloc += size;
Eric Dumazet20c64d52016-09-15 08:48:46 -07001397
1398 /* Avoid a possible overflow.
1399 * TCP send queues can make this happen, if sk_mem_reclaim()
1400 * is not called and more than 2 GBytes are released at once.
1401 *
1402 * If we reach 2 MBytes, reclaim 1 MBytes right now, there is
1403 * no need to hold that much forward allocation anyway.
1404 */
1405 if (unlikely(sk->sk_forward_alloc >= 1 << 21))
1406 __sk_mem_reclaim(sk, 1 << 20);
Hideo Aoki3ab224b2007-12-31 00:11:19 -08001407}
1408
1409static inline void sk_wmem_free_skb(struct sock *sk, struct sk_buff *skb)
1410{
Hideo Aoki3ab224b2007-12-31 00:11:19 -08001411 sock_set_flag(sk, SOCK_QUEUE_SHRUNK);
1412 sk->sk_wmem_queued -= skb->truesize;
1413 sk_mem_uncharge(sk, skb->truesize);
1414 __kfree_skb(skb);
Herbert Xud80d99d2005-09-01 17:48:23 -07001415}
1416
Eric Dumazetc3f9b012014-03-10 09:50:11 -07001417static inline void sock_release_ownership(struct sock *sk)
1418{
Hannes Frederic Sowa61881cf2016-04-05 17:10:14 +02001419 if (sk->sk_lock.owned) {
1420 sk->sk_lock.owned = 0;
1421
1422 /* The sk_lock has mutex_unlock() semantics: */
1423 mutex_release(&sk->sk_lock.dep_map, 1, _RET_IP_);
1424 }
Eric Dumazetc3f9b012014-03-10 09:50:11 -07001425}
1426
Peter Zijlstraed075362006-12-06 20:35:24 -08001427/*
1428 * Macro so as to not evaluate some arguments when
1429 * lockdep is not enabled.
1430 *
1431 * Mark both the sk_lock and the sk_lock.slock as a
1432 * per-address-family lock class.
1433 */
Eric Dumazetdc6b9b72012-05-16 22:48:15 +00001434#define sock_lock_init_class_and_name(sk, sname, skey, name, key) \
Peter Zijlstraed075362006-12-06 20:35:24 -08001435do { \
Ingo Molnare8f6fbf2008-11-12 01:38:36 +00001436 sk->sk_lock.owned = 0; \
Peter Zijlstraed075362006-12-06 20:35:24 -08001437 init_waitqueue_head(&sk->sk_lock.wq); \
1438 spin_lock_init(&(sk)->sk_lock.slock); \
1439 debug_check_no_locks_freed((void *)&(sk)->sk_lock, \
1440 sizeof((sk)->sk_lock)); \
1441 lockdep_set_class_and_name(&(sk)->sk_lock.slock, \
Eric Dumazetdc6b9b72012-05-16 22:48:15 +00001442 (skey), (sname)); \
Peter Zijlstraed075362006-12-06 20:35:24 -08001443 lockdep_init_map(&(sk)->sk_lock.dep_map, (name), (key), 0); \
1444} while (0)
1445
David S. Millerb33b0a12016-04-07 20:40:25 -04001446#ifdef CONFIG_LOCKDEP
Hannes Frederic Sowa03be9822016-04-07 23:53:35 +02001447static inline bool lockdep_sock_is_held(const struct sock *csk)
Hannes Frederic Sowa1e1d04e2016-04-05 17:10:15 +02001448{
1449 struct sock *sk = (struct sock *)csk;
1450
1451 return lockdep_is_held(&sk->sk_lock) ||
1452 lockdep_is_held(&sk->sk_lock.slock);
1453}
David S. Millerb33b0a12016-04-07 20:40:25 -04001454#endif
Hannes Frederic Sowa1e1d04e2016-04-05 17:10:15 +02001455
Joe Perches69336bd2013-09-22 10:32:26 -07001456void lock_sock_nested(struct sock *sk, int subclass);
Peter Zijlstrafcc70d52006-11-08 22:44:35 -08001457
1458static inline void lock_sock(struct sock *sk)
1459{
1460 lock_sock_nested(sk, 0);
1461}
1462
Joe Perches69336bd2013-09-22 10:32:26 -07001463void release_sock(struct sock *sk);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001464
1465/* BH context may only use the following locking interface. */
1466#define bh_lock_sock(__sk) spin_lock(&((__sk)->sk_lock.slock))
Ingo Molnarc6366182006-07-03 00:25:13 -07001467#define bh_lock_sock_nested(__sk) \
1468 spin_lock_nested(&((__sk)->sk_lock.slock), \
1469 SINGLE_DEPTH_NESTING)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001470#define bh_unlock_sock(__sk) spin_unlock(&((__sk)->sk_lock.slock))
1471
Joe Perches69336bd2013-09-22 10:32:26 -07001472bool lock_sock_fast(struct sock *sk);
Eric Dumazet8a74ad62010-05-26 19:20:18 +00001473/**
1474 * unlock_sock_fast - complement of lock_sock_fast
1475 * @sk: socket
1476 * @slow: slow mode
1477 *
1478 * fast unlock socket for user context.
1479 * If slow mode is on, we call regular release_sock()
1480 */
1481static inline void unlock_sock_fast(struct sock *sk, bool slow)
Eric Dumazet4b0b72f2010-04-28 14:35:48 -07001482{
Eric Dumazet8a74ad62010-05-26 19:20:18 +00001483 if (slow)
1484 release_sock(sk);
1485 else
1486 spin_unlock_bh(&sk->sk_lock.slock);
Eric Dumazet4b0b72f2010-04-28 14:35:48 -07001487}
1488
Hannes Frederic Sowafafc4e12016-04-08 15:11:27 +02001489/* Used by processes to "lock" a socket state, so that
1490 * interrupts and bottom half handlers won't change it
1491 * from under us. It essentially blocks any incoming
1492 * packets, so that we won't get any new data or any
1493 * packets that change the state of the socket.
1494 *
1495 * While locked, BH processing will add new packets to
1496 * the backlog queue. This queue is processed by the
1497 * owner of the socket lock right before it is released.
1498 *
1499 * Since ~2.3.5 it is also exclusive sleep lock serializing
1500 * accesses from user process context.
1501 */
1502
Eric Dumazet46cc6e42016-05-03 16:56:03 -07001503static inline void sock_owned_by_me(const struct sock *sk)
Hannes Frederic Sowafafc4e12016-04-08 15:11:27 +02001504{
1505#ifdef CONFIG_LOCKDEP
Eric Dumazet5e91f6c2016-04-25 06:34:09 -07001506 WARN_ON_ONCE(!lockdep_sock_is_held(sk) && debug_locks);
Hannes Frederic Sowafafc4e12016-04-08 15:11:27 +02001507#endif
Eric Dumazet46cc6e42016-05-03 16:56:03 -07001508}
1509
1510static inline bool sock_owned_by_user(const struct sock *sk)
1511{
1512 sock_owned_by_me(sk);
Hannes Frederic Sowafafc4e12016-04-08 15:11:27 +02001513 return sk->sk_lock.owned;
1514}
1515
1516/* no reclassification while locks are held */
1517static inline bool sock_allow_reclassification(const struct sock *csk)
1518{
1519 struct sock *sk = (struct sock *)csk;
1520
1521 return !sk->sk_lock.owned && !spin_is_locked(&sk->sk_lock.slock);
1522}
Eric Dumazet4b0b72f2010-04-28 14:35:48 -07001523
Joe Perches69336bd2013-09-22 10:32:26 -07001524struct sock *sk_alloc(struct net *net, int family, gfp_t priority,
Eric W. Biederman11aa9c22015-05-08 21:09:13 -05001525 struct proto *prot, int kern);
Joe Perches69336bd2013-09-22 10:32:26 -07001526void sk_free(struct sock *sk);
Craig Gallekeb4cb002015-06-15 11:26:18 -04001527void sk_destruct(struct sock *sk);
Joe Perches69336bd2013-09-22 10:32:26 -07001528struct sock *sk_clone_lock(const struct sock *sk, const gfp_t priority);
Arnaldo Carvalho de Melo94352d42017-03-01 16:35:08 -03001529void sk_free_unlock_clone(struct sock *sk);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001530
Joe Perches69336bd2013-09-22 10:32:26 -07001531struct sk_buff *sock_wmalloc(struct sock *sk, unsigned long size, int force,
1532 gfp_t priority);
Eric Dumazet1d2077a2016-05-02 10:56:27 -07001533void __sock_wfree(struct sk_buff *skb);
Joe Perches69336bd2013-09-22 10:32:26 -07001534void sock_wfree(struct sk_buff *skb);
1535void skb_orphan_partial(struct sk_buff *skb);
1536void sock_rfree(struct sk_buff *skb);
Alexander Duyck62bccb82014-09-04 13:31:35 -04001537void sock_efree(struct sk_buff *skb);
Alexander Duyck82eabd92014-09-04 13:32:11 -04001538#ifdef CONFIG_INET
Joe Perches69336bd2013-09-22 10:32:26 -07001539void sock_edemux(struct sk_buff *skb);
Alexander Duyck82eabd92014-09-04 13:32:11 -04001540#else
Eric Dumazet158f3232017-01-27 07:11:27 -08001541#define sock_edemux sock_efree
Alexander Duyck82eabd92014-09-04 13:32:11 -04001542#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -07001543
Joe Perches69336bd2013-09-22 10:32:26 -07001544int sock_setsockopt(struct socket *sock, int level, int op,
1545 char __user *optval, unsigned int optlen);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001546
Joe Perches69336bd2013-09-22 10:32:26 -07001547int sock_getsockopt(struct socket *sock, int level, int op,
1548 char __user *optval, int __user *optlen);
1549struct sk_buff *sock_alloc_send_skb(struct sock *sk, unsigned long size,
1550 int noblock, int *errcode);
1551struct sk_buff *sock_alloc_send_pskb(struct sock *sk, unsigned long header_len,
1552 unsigned long data_len, int noblock,
1553 int *errcode, int max_page_order);
1554void *sock_kmalloc(struct sock *sk, int size, gfp_t priority);
1555void sock_kfree_s(struct sock *sk, void *mem, int size);
Daniel Borkmann79e88652014-11-19 17:13:11 +01001556void sock_kzfree_s(struct sock *sk, void *mem, int size);
Joe Perches69336bd2013-09-22 10:32:26 -07001557void sk_send_sigurg(struct sock *sk);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001558
Edward Jeef28ea362015-10-08 14:56:48 -07001559struct sockcm_cookie {
1560 u32 mark;
Soheil Hassas Yeganeh3dd17e62016-04-02 23:08:09 -04001561 u16 tsflags;
Edward Jeef28ea362015-10-08 14:56:48 -07001562};
1563
Willem de Bruijn39771b12016-04-02 23:08:06 -04001564int __sock_cmsg_send(struct sock *sk, struct msghdr *msg, struct cmsghdr *cmsg,
1565 struct sockcm_cookie *sockc);
Edward Jeef28ea362015-10-08 14:56:48 -07001566int sock_cmsg_send(struct sock *sk, struct msghdr *msg,
1567 struct sockcm_cookie *sockc);
1568
Linus Torvalds1da177e2005-04-16 15:20:36 -07001569/*
1570 * Functions to fill in entries in struct proto_ops when a protocol
1571 * does not implement a particular function.
1572 */
Joe Perches69336bd2013-09-22 10:32:26 -07001573int sock_no_bind(struct socket *, struct sockaddr *, int);
1574int sock_no_connect(struct socket *, struct sockaddr *, int, int);
1575int sock_no_socketpair(struct socket *, struct socket *);
1576int sock_no_accept(struct socket *, struct socket *, int);
1577int sock_no_getname(struct socket *, struct sockaddr *, int *, int);
1578unsigned int sock_no_poll(struct file *, struct socket *,
1579 struct poll_table_struct *);
1580int sock_no_ioctl(struct socket *, unsigned int, unsigned long);
1581int sock_no_listen(struct socket *, int);
1582int sock_no_shutdown(struct socket *, int);
1583int sock_no_getsockopt(struct socket *, int , int, char __user *, int __user *);
1584int sock_no_setsockopt(struct socket *, int, int, char __user *, unsigned int);
Ying Xue1b784142015-03-02 15:37:48 +08001585int sock_no_sendmsg(struct socket *, struct msghdr *, size_t);
1586int sock_no_recvmsg(struct socket *, struct msghdr *, size_t, int);
Joe Perches69336bd2013-09-22 10:32:26 -07001587int sock_no_mmap(struct file *file, struct socket *sock,
1588 struct vm_area_struct *vma);
1589ssize_t sock_no_sendpage(struct socket *sock, struct page *page, int offset,
1590 size_t size, int flags);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001591
1592/*
1593 * Functions to fill in entries in struct proto_ops when a protocol
1594 * uses the inet style.
1595 */
Joe Perches69336bd2013-09-22 10:32:26 -07001596int sock_common_getsockopt(struct socket *sock, int level, int optname,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001597 char __user *optval, int __user *optlen);
Ying Xue1b784142015-03-02 15:37:48 +08001598int sock_common_recvmsg(struct socket *sock, struct msghdr *msg, size_t size,
1599 int flags);
Joe Perches69336bd2013-09-22 10:32:26 -07001600int sock_common_setsockopt(struct socket *sock, int level, int optname,
David S. Millerb7058842009-09-30 16:12:20 -07001601 char __user *optval, unsigned int optlen);
Joe Perches69336bd2013-09-22 10:32:26 -07001602int compat_sock_common_getsockopt(struct socket *sock, int level,
Dmitry Mishin3fdadf72006-03-20 22:45:21 -08001603 int optname, char __user *optval, int __user *optlen);
Joe Perches69336bd2013-09-22 10:32:26 -07001604int compat_sock_common_setsockopt(struct socket *sock, int level,
David S. Millerb7058842009-09-30 16:12:20 -07001605 int optname, char __user *optval, unsigned int optlen);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001606
Joe Perches69336bd2013-09-22 10:32:26 -07001607void sk_common_release(struct sock *sk);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001608
1609/*
1610 * Default socket callbacks and setup code
1611 */
Eric Dumazetdc6b9b72012-05-16 22:48:15 +00001612
Linus Torvalds1da177e2005-04-16 15:20:36 -07001613/* Initialise core socket variables */
Joe Perches69336bd2013-09-22 10:32:26 -07001614void sock_init_data(struct socket *sock, struct sock *sk);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001615
Linus Torvalds1da177e2005-04-16 15:20:36 -07001616/*
1617 * Socket reference counting postulates.
1618 *
1619 * * Each user of socket SHOULD hold a reference count.
1620 * * Each access point to socket (an hash table bucket, reference from a list,
1621 * running timer, skb in flight MUST hold a reference count.
1622 * * When reference count hits 0, it means it will never increase back.
1623 * * When reference count hits 0, it means that no references from
1624 * outside exist to this socket and current process on current CPU
1625 * is last user and may/should destroy this socket.
1626 * * sk_free is called from any context: process, BH, IRQ. When
1627 * it is called, socket has no references from outside -> sk_free
1628 * may release descendant resources allocated by the socket, but
1629 * to the time when it is called, socket is NOT referenced by any
1630 * hash tables, lists etc.
1631 * * Packets, delivered from outside (from network or from another process)
1632 * and enqueued on receive/error queues SHOULD NOT grab reference count,
1633 * when they sit in queue. Otherwise, packets will leak to hole, when
1634 * socket is looked up by one cpu and unhasing is made by another CPU.
1635 * It is true for udp/raw, netlink (leak to receive and error queues), tcp
1636 * (leak to backlog). Packet socket does all the processing inside
1637 * BR_NETPROTO_LOCK, so that it has not this race condition. UNIX sockets
1638 * use separate SMP lock, so that they are prone too.
1639 */
1640
1641/* Ungrab socket and destroy it, if it was the last reference. */
1642static inline void sock_put(struct sock *sk)
1643{
1644 if (atomic_dec_and_test(&sk->sk_refcnt))
1645 sk_free(sk);
1646}
Eric Dumazet05dbc7b2013-10-03 00:22:02 -07001647/* Generic version of sock_put(), dealing with all sockets
Eric Dumazet41b822c2015-03-12 16:44:08 -07001648 * (TCP_TIMEWAIT, TCP_NEW_SYN_RECV, ESTABLISHED...)
Eric Dumazet05dbc7b2013-10-03 00:22:02 -07001649 */
1650void sock_gen_put(struct sock *sk);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001651
Willem de Bruijn4f0c40d92016-07-12 18:18:57 -04001652int __sk_receive_skb(struct sock *sk, struct sk_buff *skb, const int nested,
Eric Dumazetc3f24cf2016-11-02 17:14:41 -07001653 unsigned int trim_cap, bool refcounted);
Willem de Bruijn4f0c40d92016-07-12 18:18:57 -04001654static inline int sk_receive_skb(struct sock *sk, struct sk_buff *skb,
1655 const int nested)
1656{
Eric Dumazetc3f24cf2016-11-02 17:14:41 -07001657 return __sk_receive_skb(sk, skb, nested, 1, true);
Willem de Bruijn4f0c40d92016-07-12 18:18:57 -04001658}
Arnaldo Carvalho de Melo25995ff2005-12-27 02:42:22 -02001659
Krishna Kumare022f0b2009-10-19 23:46:20 +00001660static inline void sk_tx_queue_set(struct sock *sk, int tx_queue)
1661{
1662 sk->sk_tx_queue_mapping = tx_queue;
1663}
1664
1665static inline void sk_tx_queue_clear(struct sock *sk)
1666{
1667 sk->sk_tx_queue_mapping = -1;
1668}
1669
1670static inline int sk_tx_queue_get(const struct sock *sk)
1671{
Tom Herbertb0f77d02010-07-14 20:50:29 -07001672 return sk ? sk->sk_tx_queue_mapping : -1;
Krishna Kumare022f0b2009-10-19 23:46:20 +00001673}
1674
David S. Miller972692e2008-06-17 22:41:38 -07001675static inline void sk_set_socket(struct sock *sk, struct socket *sock)
1676{
Krishna Kumare022f0b2009-10-19 23:46:20 +00001677 sk_tx_queue_clear(sk);
David S. Miller972692e2008-06-17 22:41:38 -07001678 sk->sk_socket = sock;
1679}
1680
Eric Dumazetaa395142010-04-20 13:03:51 +00001681static inline wait_queue_head_t *sk_sleep(struct sock *sk)
1682{
Eric Dumazeteaefd112011-02-18 03:26:36 +00001683 BUILD_BUG_ON(offsetof(struct socket_wq, wait) != 0);
1684 return &rcu_dereference_raw(sk->sk_wq)->wait;
Eric Dumazetaa395142010-04-20 13:03:51 +00001685}
Linus Torvalds1da177e2005-04-16 15:20:36 -07001686/* Detach socket from process context.
1687 * Announce socket dead, detach it from wait queue and inode.
1688 * Note that parent inode held reference count on this struct sock,
1689 * we do not release it in this function, because protocol
1690 * probably wants some additional cleanups or even continuing
1691 * to work with this socket (TCP).
1692 */
1693static inline void sock_orphan(struct sock *sk)
1694{
1695 write_lock_bh(&sk->sk_callback_lock);
1696 sock_set_flag(sk, SOCK_DEAD);
David S. Miller972692e2008-06-17 22:41:38 -07001697 sk_set_socket(sk, NULL);
Eric Dumazet43815482010-04-29 11:01:49 +00001698 sk->sk_wq = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001699 write_unlock_bh(&sk->sk_callback_lock);
1700}
1701
1702static inline void sock_graft(struct sock *sk, struct socket *parent)
1703{
1704 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 Dumazet0b53ff22010-04-26 20:40:43 +00001783 /*
1784 * This can be called while sk is owned by the caller only,
1785 * with no state that can be checked in a rcu_dereference_check() cond
1786 */
1787 old_dst = rcu_dereference_raw(sk->sk_dst_cache);
Eric Dumazetb6c67122010-04-08 23:03:29 +00001788 rcu_assign_pointer(sk->sk_dst_cache, dst);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001789 dst_release(old_dst);
1790}
1791
1792static inline void
1793sk_dst_set(struct sock *sk, struct dst_entry *dst)
1794{
Eric Dumazet7f502362014-06-30 01:26:23 -07001795 struct dst_entry *old_dst;
1796
1797 sk_tx_queue_clear(sk);
Julian Anastasov9b8805a2017-02-06 23:14:11 +02001798 sk->sk_dst_pending_confirm = 0;
Eric Dumazet5925a052014-07-02 02:39:38 -07001799 old_dst = xchg((__force struct dst_entry **)&sk->sk_dst_cache, dst);
Eric Dumazet7f502362014-06-30 01:26:23 -07001800 dst_release(old_dst);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001801}
1802
1803static inline void
1804__sk_dst_reset(struct sock *sk)
1805{
Eric Dumazetb6c67122010-04-08 23:03:29 +00001806 __sk_dst_set(sk, NULL);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001807}
1808
1809static inline void
1810sk_dst_reset(struct sock *sk)
1811{
Eric Dumazet7f502362014-06-30 01:26:23 -07001812 sk_dst_set(sk, NULL);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001813}
1814
Joe Perches69336bd2013-09-22 10:32:26 -07001815struct dst_entry *__sk_dst_check(struct sock *sk, u32 cookie);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001816
Joe Perches69336bd2013-09-22 10:32:26 -07001817struct dst_entry *sk_dst_check(struct sock *sk, u32 cookie);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001818
Julian Anastasov9b8805a2017-02-06 23:14:11 +02001819static inline void sk_dst_confirm(struct sock *sk)
1820{
1821 if (!sk->sk_dst_pending_confirm)
1822 sk->sk_dst_pending_confirm = 1;
1823}
1824
Julian Anastasov4ff06202017-02-06 23:14:12 +02001825static inline void sock_confirm_neigh(struct sk_buff *skb, struct neighbour *n)
1826{
1827 if (skb_get_dst_pending_confirm(skb)) {
1828 struct sock *sk = skb->sk;
1829 unsigned long now = jiffies;
1830
1831 /* avoid dirtying neighbour */
1832 if (n->confirmed != now)
1833 n->confirmed = now;
1834 if (sk && sk->sk_dst_pending_confirm)
1835 sk->sk_dst_pending_confirm = 0;
1836 }
1837}
1838
hannes@stressinduktion.orgf60e5992015-04-01 17:07:44 +02001839bool sk_mc_loop(struct sock *sk);
1840
Eric Dumazetdc6b9b72012-05-16 22:48:15 +00001841static inline bool sk_can_gso(const struct sock *sk)
Herbert Xubcd76112006-06-30 13:36:35 -07001842{
1843 return net_gso_ok(sk->sk_route_caps, sk->sk_gso_type);
1844}
1845
Joe Perches69336bd2013-09-22 10:32:26 -07001846void sk_setup_caps(struct sock *sk, struct dst_entry *dst);
Arnaldo Carvalho de Melo6cbb0df2005-08-09 19:49:02 -07001847
Michał Mirosławc8f44af2011-11-15 15:29:55 +00001848static inline void sk_nocaps_add(struct sock *sk, netdev_features_t flags)
Eric Dumazeta4654192010-05-16 00:36:33 -07001849{
1850 sk->sk_route_nocaps |= flags;
1851 sk->sk_route_caps &= ~flags;
1852}
1853
Tom Herbert9a498502015-12-14 11:19:45 -08001854static inline bool sk_check_csum_caps(struct sock *sk)
1855{
1856 return (sk->sk_route_caps & NETIF_F_HW_CSUM) ||
1857 (sk->sk_family == PF_INET &&
1858 (sk->sk_route_caps & NETIF_F_IP_CSUM)) ||
1859 (sk->sk_family == PF_INET6 &&
1860 (sk->sk_route_caps & NETIF_F_IPV6_CSUM));
1861}
1862
Tom Herbertc6e1a0d2011-04-04 22:30:30 -07001863static inline int skb_do_copy_data_nocache(struct sock *sk, struct sk_buff *skb,
Al Viro57be5bd2014-11-28 13:40:20 -05001864 struct iov_iter *from, char *to,
Wei Yongjun912d3982011-04-06 18:40:12 +00001865 int copy, int offset)
Tom Herbertc6e1a0d2011-04-04 22:30:30 -07001866{
1867 if (skb->ip_summed == CHECKSUM_NONE) {
Al Viro57be5bd2014-11-28 13:40:20 -05001868 __wsum csum = 0;
Al Viro15e6cb42016-11-01 22:42:45 -04001869 if (!csum_and_copy_from_iter_full(to, copy, &csum, from))
Al Viro57be5bd2014-11-28 13:40:20 -05001870 return -EFAULT;
Wei Yongjun912d3982011-04-06 18:40:12 +00001871 skb->csum = csum_block_add(skb->csum, csum, offset);
Tom Herbertc6e1a0d2011-04-04 22:30:30 -07001872 } else if (sk->sk_route_caps & NETIF_F_NOCACHE_COPY) {
Al Viro15e6cb42016-11-01 22:42:45 -04001873 if (!copy_from_iter_full_nocache(to, copy, from))
Tom Herbertc6e1a0d2011-04-04 22:30:30 -07001874 return -EFAULT;
Al Viro15e6cb42016-11-01 22:42:45 -04001875 } else if (!copy_from_iter_full(to, copy, from))
Tom Herbertc6e1a0d2011-04-04 22:30:30 -07001876 return -EFAULT;
1877
1878 return 0;
1879}
1880
1881static inline int skb_add_data_nocache(struct sock *sk, struct sk_buff *skb,
Al Viro57be5bd2014-11-28 13:40:20 -05001882 struct iov_iter *from, int copy)
Tom Herbertc6e1a0d2011-04-04 22:30:30 -07001883{
Wei Yongjun912d3982011-04-06 18:40:12 +00001884 int err, offset = skb->len;
Tom Herbertc6e1a0d2011-04-04 22:30:30 -07001885
Wei Yongjun912d3982011-04-06 18:40:12 +00001886 err = skb_do_copy_data_nocache(sk, skb, from, skb_put(skb, copy),
1887 copy, offset);
Tom Herbertc6e1a0d2011-04-04 22:30:30 -07001888 if (err)
Wei Yongjun912d3982011-04-06 18:40:12 +00001889 __skb_trim(skb, offset);
Tom Herbertc6e1a0d2011-04-04 22:30:30 -07001890
1891 return err;
1892}
1893
Al Viro57be5bd2014-11-28 13:40:20 -05001894static inline int skb_copy_to_page_nocache(struct sock *sk, struct iov_iter *from,
Tom Herbertc6e1a0d2011-04-04 22:30:30 -07001895 struct sk_buff *skb,
1896 struct page *page,
1897 int off, int copy)
1898{
1899 int err;
1900
Wei Yongjun912d3982011-04-06 18:40:12 +00001901 err = skb_do_copy_data_nocache(sk, skb, from, page_address(page) + off,
1902 copy, skb->len);
Tom Herbertc6e1a0d2011-04-04 22:30:30 -07001903 if (err)
1904 return err;
1905
1906 skb->len += copy;
1907 skb->data_len += copy;
1908 skb->truesize += copy;
1909 sk->sk_wmem_queued += copy;
1910 sk_mem_charge(sk, copy);
1911 return 0;
1912}
1913
Eric Dumazetc5640392009-06-16 10:12:03 +00001914/**
1915 * sk_wmem_alloc_get - returns write allocations
1916 * @sk: socket
1917 *
1918 * Returns sk_wmem_alloc minus initial offset of one
1919 */
1920static inline int sk_wmem_alloc_get(const struct sock *sk)
1921{
1922 return atomic_read(&sk->sk_wmem_alloc) - 1;
1923}
1924
1925/**
1926 * sk_rmem_alloc_get - returns read allocations
1927 * @sk: socket
1928 *
1929 * Returns sk_rmem_alloc
1930 */
1931static inline int sk_rmem_alloc_get(const struct sock *sk)
1932{
1933 return atomic_read(&sk->sk_rmem_alloc);
1934}
1935
1936/**
1937 * sk_has_allocations - check if allocations are outstanding
1938 * @sk: socket
1939 *
1940 * Returns true if socket has write or read allocations
1941 */
Eric Dumazetdc6b9b72012-05-16 22:48:15 +00001942static inline bool sk_has_allocations(const struct sock *sk)
Eric Dumazetc5640392009-06-16 10:12:03 +00001943{
1944 return sk_wmem_alloc_get(sk) || sk_rmem_alloc_get(sk);
1945}
1946
Jiri Olsaa57de0b2009-07-08 12:09:13 +00001947/**
Herbert Xu1ce0bf52015-11-26 13:55:39 +08001948 * skwq_has_sleeper - check if there are any waiting processes
Randy Dunlapacfbe962010-05-24 23:54:18 -07001949 * @wq: struct socket_wq
Jiri Olsaa57de0b2009-07-08 12:09:13 +00001950 *
Eric Dumazet43815482010-04-29 11:01:49 +00001951 * Returns true if socket_wq has waiting processes
Jiri Olsaa57de0b2009-07-08 12:09:13 +00001952 *
Herbert Xu1ce0bf52015-11-26 13:55:39 +08001953 * The purpose of the skwq_has_sleeper and sock_poll_wait is to wrap the memory
Jiri Olsaa57de0b2009-07-08 12:09:13 +00001954 * barrier call. They were added due to the race found within the tcp code.
1955 *
1956 * Consider following tcp code paths:
1957 *
1958 * CPU1 CPU2
1959 *
1960 * sys_select receive packet
1961 * ... ...
1962 * __add_wait_queue update tp->rcv_nxt
1963 * ... ...
1964 * tp->rcv_nxt check sock_def_readable
1965 * ... {
Eric Dumazet43815482010-04-29 11:01:49 +00001966 * schedule rcu_read_lock();
1967 * wq = rcu_dereference(sk->sk_wq);
1968 * if (wq && waitqueue_active(&wq->wait))
1969 * wake_up_interruptible(&wq->wait)
Jiri Olsaa57de0b2009-07-08 12:09:13 +00001970 * ...
1971 * }
1972 *
1973 * The race for tcp fires when the __add_wait_queue changes done by CPU1 stay
1974 * in its cache, and so does the tp->rcv_nxt update on CPU2 side. The CPU1
1975 * could then endup calling schedule and sleep forever if there are no more
1976 * data on the socket.
Jiri Olsaad462762009-07-08 12:10:31 +00001977 *
Jiri Olsaa57de0b2009-07-08 12:09:13 +00001978 */
Herbert Xu1ce0bf52015-11-26 13:55:39 +08001979static inline bool skwq_has_sleeper(struct socket_wq *wq)
Jiri Olsaa57de0b2009-07-08 12:09:13 +00001980{
Herbert Xu1ce0bf52015-11-26 13:55:39 +08001981 return wq && wq_has_sleeper(&wq->wait);
Jiri Olsaa57de0b2009-07-08 12:09:13 +00001982}
1983
1984/**
1985 * sock_poll_wait - place memory barrier behind the poll_wait call.
1986 * @filp: file
1987 * @wait_address: socket wait queue
1988 * @p: poll_table
1989 *
Eric Dumazet43815482010-04-29 11:01:49 +00001990 * See the comments in the wq_has_sleeper function.
Jiri Olsaa57de0b2009-07-08 12:09:13 +00001991 */
1992static inline void sock_poll_wait(struct file *filp,
1993 wait_queue_head_t *wait_address, poll_table *p)
1994{
Hans Verkuil626cf232012-03-23 15:02:27 -07001995 if (!poll_does_not_wait(p) && wait_address) {
Jiri Olsaa57de0b2009-07-08 12:09:13 +00001996 poll_wait(filp, wait_address, p);
Eric Dumazetdc6b9b72012-05-16 22:48:15 +00001997 /* We need to be sure we are in sync with the
Jiri Olsaa57de0b2009-07-08 12:09:13 +00001998 * socket flags modification.
1999 *
Eric Dumazet43815482010-04-29 11:01:49 +00002000 * This memory barrier is paired in the wq_has_sleeper.
Eric Dumazetdc6b9b72012-05-16 22:48:15 +00002001 */
Jiri Olsaa57de0b2009-07-08 12:09:13 +00002002 smp_mb();
2003 }
2004}
2005
Tom Herbertb73c3d02014-07-01 21:32:17 -07002006static inline void skb_set_hash_from_sk(struct sk_buff *skb, struct sock *sk)
2007{
2008 if (sk->sk_txhash) {
2009 skb->l4_hash = 1;
2010 skb->hash = sk->sk_txhash;
2011 }
2012}
2013
Eric Dumazet9e17f8a2015-11-01 15:36:55 -08002014void skb_set_owner_w(struct sk_buff *skb, struct sock *sk);
2015
Linus Torvalds1da177e2005-04-16 15:20:36 -07002016/*
Eric Dumazetdc6b9b72012-05-16 22:48:15 +00002017 * Queue a received datagram if it will fit. Stream and sequenced
Linus Torvalds1da177e2005-04-16 15:20:36 -07002018 * protocols can't normally use this as they need to fit buffers in
2019 * and play with them.
2020 *
Eric Dumazetdc6b9b72012-05-16 22:48:15 +00002021 * Inlined as it's very short and called for pretty much every
Linus Torvalds1da177e2005-04-16 15:20:36 -07002022 * packet ever received.
2023 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002024static inline void skb_set_owner_r(struct sk_buff *skb, struct sock *sk)
2025{
Herbert Xud55d87f2009-06-22 02:25:25 +00002026 skb_orphan(skb);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002027 skb->sk = sk;
2028 skb->destructor = sock_rfree;
2029 atomic_add(skb->truesize, &sk->sk_rmem_alloc);
Hideo Aoki3ab224b2007-12-31 00:11:19 -08002030 sk_mem_charge(sk, skb->truesize);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002031}
2032
Joe Perches69336bd2013-09-22 10:32:26 -07002033void sk_reset_timer(struct sock *sk, struct timer_list *timer,
2034 unsigned long expires);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002035
Joe Perches69336bd2013-09-22 10:32:26 -07002036void sk_stop_timer(struct sock *sk, struct timer_list *timer);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002037
Paolo Abenif8c3bf02016-10-21 13:55:45 +02002038int __sk_queue_drop_skb(struct sock *sk, struct sk_buff *skb,
Eric Dumazet69629462017-02-05 09:25:24 -08002039 unsigned int flags,
2040 void (*destructor)(struct sock *sk,
2041 struct sk_buff *skb));
samanthakumare6afc8a2016-04-05 12:41:15 -04002042int __sock_queue_rcv_skb(struct sock *sk, struct sk_buff *skb);
Joe Perches69336bd2013-09-22 10:32:26 -07002043int sock_queue_rcv_skb(struct sock *sk, struct sk_buff *skb);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002044
Joe Perches69336bd2013-09-22 10:32:26 -07002045int sock_queue_err_skb(struct sock *sk, struct sk_buff *skb);
Willem de Bruijn364a9e92014-08-31 21:30:27 -04002046struct sk_buff *sock_dequeue_err_skb(struct sock *sk);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002047
2048/*
2049 * Recover an error report and clear atomically
2050 */
Eric Dumazetdc6b9b72012-05-16 22:48:15 +00002051
Linus Torvalds1da177e2005-04-16 15:20:36 -07002052static inline int sock_error(struct sock *sk)
2053{
Benjamin LaHaisec1cbe4b2005-12-13 23:22:19 -08002054 int err;
2055 if (likely(!sk->sk_err))
2056 return 0;
2057 err = xchg(&sk->sk_err, 0);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002058 return -err;
2059}
2060
2061static inline unsigned long sock_wspace(struct sock *sk)
2062{
2063 int amt = 0;
2064
2065 if (!(sk->sk_shutdown & SEND_SHUTDOWN)) {
2066 amt = sk->sk_sndbuf - atomic_read(&sk->sk_wmem_alloc);
Eric Dumazetdc6b9b72012-05-16 22:48:15 +00002067 if (amt < 0)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002068 amt = 0;
2069 }
2070 return amt;
2071}
2072
Eric Dumazetceb5d582015-11-29 20:03:11 -08002073/* Note:
2074 * We use sk->sk_wq_raw, from contexts knowing this
2075 * pointer is not NULL and cannot disappear/change.
2076 */
Eric Dumazet9cd3e072015-11-29 20:03:10 -08002077static inline void sk_set_bit(int nr, struct sock *sk)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002078{
Eric Dumazet4be73522016-04-25 10:39:34 -07002079 if ((nr == SOCKWQ_ASYNC_NOSPACE || nr == SOCKWQ_ASYNC_WAITDATA) &&
2080 !sock_flag(sk, SOCK_FASYNC))
Eric Dumazet9317bb62016-04-25 10:39:32 -07002081 return;
2082
Eric Dumazetceb5d582015-11-29 20:03:11 -08002083 set_bit(nr, &sk->sk_wq_raw->flags);
Eric Dumazet9cd3e072015-11-29 20:03:10 -08002084}
2085
2086static inline void sk_clear_bit(int nr, struct sock *sk)
2087{
Eric Dumazet4be73522016-04-25 10:39:34 -07002088 if ((nr == SOCKWQ_ASYNC_NOSPACE || nr == SOCKWQ_ASYNC_WAITDATA) &&
2089 !sock_flag(sk, SOCK_FASYNC))
Eric Dumazet9317bb62016-04-25 10:39:32 -07002090 return;
2091
Eric Dumazetceb5d582015-11-29 20:03:11 -08002092 clear_bit(nr, &sk->sk_wq_raw->flags);
Eric Dumazet9cd3e072015-11-29 20:03:10 -08002093}
2094
Eric Dumazetceb5d582015-11-29 20:03:11 -08002095static inline void sk_wake_async(const struct sock *sk, int how, int band)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002096{
Eric Dumazetceb5d582015-11-29 20:03:11 -08002097 if (sock_flag(sk, SOCK_FASYNC)) {
2098 rcu_read_lock();
2099 sock_wake_async(rcu_dereference(sk->sk_wq), how, band);
2100 rcu_read_unlock();
2101 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002102}
2103
Daniel Borkmanneea86af2013-06-19 12:51:20 +02002104/* Since sk_{r,w}mem_alloc sums skb->truesize, even a small frame might
2105 * need sizeof(sk_buff) + MTU + padding, unless net driver perform copybreak.
2106 * Note: for send buffers, TCP works better if we can build two skbs at
2107 * minimum.
Eric Dumazet7a91b4342010-09-26 18:53:07 -07002108 */
Eric Dumazet9eb5bf82013-07-03 05:02:22 -07002109#define TCP_SKB_MIN_TRUESIZE (2048 + SKB_DATA_ALIGN(sizeof(struct sk_buff)))
Daniel Borkmanneea86af2013-06-19 12:51:20 +02002110
2111#define SOCK_MIN_SNDBUF (TCP_SKB_MIN_TRUESIZE * 2)
2112#define SOCK_MIN_RCVBUF TCP_SKB_MIN_TRUESIZE
Linus Torvalds1da177e2005-04-16 15:20:36 -07002113
2114static inline void sk_stream_moderate_sndbuf(struct sock *sk)
2115{
2116 if (!(sk->sk_userlocks & SOCK_SNDBUF_LOCK)) {
Eric Dumazet8df09ea2007-12-21 03:07:41 -08002117 sk->sk_sndbuf = min(sk->sk_sndbuf, sk->sk_wmem_queued >> 1);
Daniel Borkmanneea86af2013-06-19 12:51:20 +02002118 sk->sk_sndbuf = max_t(u32, sk->sk_sndbuf, SOCK_MIN_SNDBUF);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002119 }
2120}
2121
Eric Dumazeteb934472015-05-19 13:26:55 -07002122struct sk_buff *sk_stream_alloc_skb(struct sock *sk, int size, gfp_t gfp,
2123 bool force_schedule);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002124
Eric Dumazet5640f762012-09-23 23:04:42 +00002125/**
2126 * sk_page_frag - return an appropriate page_frag
2127 * @sk: socket
2128 *
2129 * If socket allocation mode allows current thread to sleep, it means its
2130 * safe to use the per task page_frag instead of the per socket one.
2131 */
2132static inline struct page_frag *sk_page_frag(struct sock *sk)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002133{
Mel Gormand0164ad2015-11-06 16:28:21 -08002134 if (gfpflags_allow_blocking(sk->sk_allocation))
Eric Dumazet5640f762012-09-23 23:04:42 +00002135 return &current->task_frag;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002136
Eric Dumazet5640f762012-09-23 23:04:42 +00002137 return &sk->sk_frag;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002138}
2139
Joe Perches69336bd2013-09-22 10:32:26 -07002140bool sk_page_frag_refill(struct sock *sk, struct page_frag *pfrag);
Eric Dumazet5640f762012-09-23 23:04:42 +00002141
Linus Torvalds1da177e2005-04-16 15:20:36 -07002142/*
2143 * Default write policy as shown to user space via poll/select/SIGIO
2144 */
Eric Dumazetdc6b9b72012-05-16 22:48:15 +00002145static inline bool sock_writeable(const struct sock *sk)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002146{
Eric Dumazet8df09ea2007-12-21 03:07:41 -08002147 return atomic_read(&sk->sk_wmem_alloc) < (sk->sk_sndbuf >> 1);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002148}
2149
Al Virodd0fc662005-10-07 07:46:04 +01002150static inline gfp_t gfp_any(void)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002151{
Andrew Morton99709372009-02-12 16:43:17 -08002152 return in_softirq() ? GFP_ATOMIC : GFP_KERNEL;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002153}
2154
Eric Dumazetdc6b9b72012-05-16 22:48:15 +00002155static inline long sock_rcvtimeo(const struct sock *sk, bool noblock)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002156{
2157 return noblock ? 0 : sk->sk_rcvtimeo;
2158}
2159
Eric Dumazetdc6b9b72012-05-16 22:48:15 +00002160static inline long sock_sndtimeo(const struct sock *sk, bool noblock)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002161{
2162 return noblock ? 0 : sk->sk_sndtimeo;
2163}
2164
2165static inline int sock_rcvlowat(const struct sock *sk, int waitall, int len)
2166{
2167 return (waitall ? len : min_t(int, sk->sk_rcvlowat, len)) ? : 1;
2168}
2169
2170/* Alas, with timeout socket operations are not restartable.
2171 * Compare this to poll().
2172 */
2173static inline int sock_intr_errno(long timeo)
2174{
2175 return timeo == MAX_SCHEDULE_TIMEOUT ? -ERESTARTSYS : -EINTR;
2176}
2177
Eyal Birger744d5a32015-03-01 14:58:31 +02002178struct sock_skb_cb {
2179 u32 dropcount;
2180};
2181
2182/* Store sock_skb_cb at the end of skb->cb[] so protocol families
2183 * using skb->cb[] would keep using it directly and utilize its
2184 * alignement guarantee.
2185 */
2186#define SOCK_SKB_CB_OFFSET ((FIELD_SIZEOF(struct sk_buff, cb) - \
2187 sizeof(struct sock_skb_cb)))
2188
2189#define SOCK_SKB_CB(__skb) ((struct sock_skb_cb *)((__skb)->cb + \
2190 SOCK_SKB_CB_OFFSET))
2191
Eyal Birgerb4772ef2015-03-01 14:58:29 +02002192#define sock_skb_cb_check_size(size) \
Eyal Birger744d5a32015-03-01 14:58:31 +02002193 BUILD_BUG_ON((size) > SOCK_SKB_CB_OFFSET)
Eyal Birgerb4772ef2015-03-01 14:58:29 +02002194
Eyal Birger3bc3b962015-03-01 14:58:30 +02002195static inline void
2196sock_skb_set_dropcount(const struct sock *sk, struct sk_buff *skb)
2197{
Eric Dumazet3665f382016-12-07 10:05:36 -08002198 SOCK_SKB_CB(skb)->dropcount = sock_flag(sk, SOCK_RXQ_OVFL) ?
2199 atomic_read(&sk->sk_drops) : 0;
Eyal Birger3bc3b962015-03-01 14:58:30 +02002200}
2201
Eric Dumazet532182c2016-04-01 08:52:19 -07002202static inline void sk_drops_add(struct sock *sk, const struct sk_buff *skb)
2203{
2204 int segs = max_t(u16, 1, skb_shinfo(skb)->gso_segs);
2205
2206 atomic_add(segs, &sk->sk_drops);
2207}
2208
Joe Perches69336bd2013-09-22 10:32:26 -07002209void __sock_recv_timestamp(struct msghdr *msg, struct sock *sk,
2210 struct sk_buff *skb);
2211void __sock_recv_wifi_status(struct msghdr *msg, struct sock *sk,
2212 struct sk_buff *skb);
Eric Dumazet92f37fd2007-03-25 22:14:49 -07002213
Eric Dumazetdc6b9b72012-05-16 22:48:15 +00002214static inline void
Linus Torvalds1da177e2005-04-16 15:20:36 -07002215sock_recv_timestamp(struct msghdr *msg, struct sock *sk, struct sk_buff *skb)
2216{
Eric Dumazetb7aa0bf2007-04-19 16:16:32 -07002217 ktime_t kt = skb->tstamp;
Patrick Ohly20d49472009-02-12 05:03:38 +00002218 struct skb_shared_hwtstamps *hwtstamps = skb_hwtstamps(skb);
Patrick McHardya61bbcf2005-08-14 17:24:31 -07002219
Patrick Ohly20d49472009-02-12 05:03:38 +00002220 /*
2221 * generate control messages if
Willem de Bruijnb9f40e22014-08-04 22:11:46 -04002222 * - receive time stamping in software requested
Patrick Ohly20d49472009-02-12 05:03:38 +00002223 * - software time stamp available and wanted
Patrick Ohly20d49472009-02-12 05:03:38 +00002224 * - hardware time stamps available and wanted
Patrick Ohly20d49472009-02-12 05:03:38 +00002225 */
2226 if (sock_flag(sk, SOCK_RCVTSTAMP) ||
Willem de Bruijnb9f40e22014-08-04 22:11:46 -04002227 (sk->sk_tsflags & SOF_TIMESTAMPING_RX_SOFTWARE) ||
Thomas Gleixner2456e852016-12-25 11:38:40 +01002228 (kt && sk->sk_tsflags & SOF_TIMESTAMPING_SOFTWARE) ||
2229 (hwtstamps->hwtstamp &&
Willem de Bruijnb9f40e22014-08-04 22:11:46 -04002230 (sk->sk_tsflags & SOF_TIMESTAMPING_RAW_HARDWARE)))
Eric Dumazet92f37fd2007-03-25 22:14:49 -07002231 __sock_recv_timestamp(msg, sk, skb);
2232 else
Eric Dumazetb7aa0bf2007-04-19 16:16:32 -07002233 sk->sk_stamp = kt;
Johannes Berg6e3e9392011-11-09 10:15:42 +01002234
2235 if (sock_flag(sk, SOCK_WIFI_STATUS) && skb->wifi_acked_valid)
2236 __sock_recv_wifi_status(msg, sk, skb);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002237}
2238
Joe Perches69336bd2013-09-22 10:32:26 -07002239void __sock_recv_ts_and_drops(struct msghdr *msg, struct sock *sk,
2240 struct sk_buff *skb);
Eric Dumazet767dd032010-04-28 19:14:43 +00002241
2242static inline void sock_recv_ts_and_drops(struct msghdr *msg, struct sock *sk,
2243 struct sk_buff *skb)
2244{
2245#define FLAGS_TS_OR_DROPS ((1UL << SOCK_RXQ_OVFL) | \
Willem de Bruijnb9f40e22014-08-04 22:11:46 -04002246 (1UL << SOCK_RCVTSTAMP))
2247#define TSFLAGS_ANY (SOF_TIMESTAMPING_SOFTWARE | \
2248 SOF_TIMESTAMPING_RAW_HARDWARE)
Eric Dumazet767dd032010-04-28 19:14:43 +00002249
Willem de Bruijnb9f40e22014-08-04 22:11:46 -04002250 if (sk->sk_flags & FLAGS_TS_OR_DROPS || sk->sk_tsflags & TSFLAGS_ANY)
Eric Dumazet767dd032010-04-28 19:14:43 +00002251 __sock_recv_ts_and_drops(msg, sk, skb);
2252 else
2253 sk->sk_stamp = skb->tstamp;
2254}
Neil Horman3b885782009-10-12 13:26:31 -07002255
Soheil Hassas Yeganehc14ac942016-04-02 23:08:12 -04002256void __sock_tx_timestamp(__u16 tsflags, __u8 *tx_flags);
Willem de Bruijn67cc0d42014-09-08 19:58:58 -04002257
Linus Torvalds1da177e2005-04-16 15:20:36 -07002258/**
Patrick Ohly20d49472009-02-12 05:03:38 +00002259 * sock_tx_timestamp - checks whether the outgoing packet is to be time stamped
Patrick Ohly20d49472009-02-12 05:03:38 +00002260 * @sk: socket sending this packet
Soheil Hassas Yeganehc14ac942016-04-02 23:08:12 -04002261 * @tsflags: timestamping flags to use
Eric Dumazet140c55d2014-08-06 11:49:29 +02002262 * @tx_flags: completed with instructions for time stamping
2263 *
2264 * Note : callers should take care of initial *tx_flags value (usually 0)
Patrick Ohly20d49472009-02-12 05:03:38 +00002265 */
Soheil Hassas Yeganehc14ac942016-04-02 23:08:12 -04002266static inline void sock_tx_timestamp(const struct sock *sk, __u16 tsflags,
2267 __u8 *tx_flags)
Willem de Bruijn67cc0d42014-09-08 19:58:58 -04002268{
Soheil Hassas Yeganehc14ac942016-04-02 23:08:12 -04002269 if (unlikely(tsflags))
2270 __sock_tx_timestamp(tsflags, tx_flags);
Willem de Bruijn67cc0d42014-09-08 19:58:58 -04002271 if (unlikely(sock_flag(sk, SOCK_WIFI_STATUS)))
2272 *tx_flags |= SKBTX_WIFI_STATUS;
2273}
Patrick Ohly20d49472009-02-12 05:03:38 +00002274
2275/**
Linus Torvalds1da177e2005-04-16 15:20:36 -07002276 * sk_eat_skb - Release a skb if it is no longer needed
Pavel Pisa4dc3b162005-05-01 08:59:25 -07002277 * @sk: socket to eat this skb from
2278 * @skb: socket buffer to eat
Linus Torvalds1da177e2005-04-16 15:20:36 -07002279 *
2280 * This routine must be called with interrupts disabled or with the socket
2281 * locked so that the sk_buff queue operation is ok.
2282*/
Dan Williams7bced392013-12-30 12:37:29 -08002283static inline void sk_eat_skb(struct sock *sk, struct sk_buff *skb)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002284{
2285 __skb_unlink(skb, &sk->sk_receive_queue);
2286 __kfree_skb(skb);
2287}
2288
YOSHIFUJI Hideaki3b1e0a62008-03-26 02:26:21 +09002289static inline
2290struct net *sock_net(const struct sock *sk)
2291{
Eric Dumazetc2d9ba92010-06-01 06:51:19 +00002292 return read_pnet(&sk->sk_net);
YOSHIFUJI Hideaki3b1e0a62008-03-26 02:26:21 +09002293}
2294
2295static inline
Denis V. Lunevf5aa23f2008-03-26 00:48:17 -07002296void sock_net_set(struct sock *sk, struct net *net)
YOSHIFUJI Hideaki3b1e0a62008-03-26 02:26:21 +09002297{
Eric Dumazetc2d9ba92010-06-01 06:51:19 +00002298 write_pnet(&sk->sk_net, net);
YOSHIFUJI Hideaki3b1e0a62008-03-26 02:26:21 +09002299}
2300
KOVACS Krisztian23542612008-10-07 12:41:01 -07002301static inline struct sock *skb_steal_sock(struct sk_buff *skb)
2302{
Vijay Subramanianefc27f82012-06-24 13:03:07 +00002303 if (skb->sk) {
KOVACS Krisztian23542612008-10-07 12:41:01 -07002304 struct sock *sk = skb->sk;
2305
2306 skb->destructor = NULL;
2307 skb->sk = NULL;
2308 return sk;
2309 }
2310 return NULL;
2311}
2312
Eric Dumazet1d0ab252015-03-15 21:12:12 -07002313/* This helper checks if a socket is a full socket,
2314 * ie _not_ a timewait or request socket.
2315 */
2316static inline bool sk_fullsock(const struct sock *sk)
2317{
2318 return (1 << sk->sk_state) & ~(TCPF_TIME_WAIT | TCPF_NEW_SYN_RECV);
2319}
2320
Eric Dumazete446f9d2015-10-08 05:01:55 -07002321/* This helper checks if a socket is a LISTEN or NEW_SYN_RECV
2322 * SYNACK messages can be attached to either ones (depending on SYNCOOKIE)
2323 */
2324static inline bool sk_listener(const struct sock *sk)
2325{
2326 return (1 << sk->sk_state) & (TCPF_LISTEN | TCPF_NEW_SYN_RECV);
2327}
2328
Eric Dumazet00fd38d2015-11-12 08:43:18 -08002329/**
2330 * sk_state_load - read sk->sk_state for lockless contexts
2331 * @sk: socket pointer
2332 *
2333 * Paired with sk_state_store(). Used in places we do not hold socket lock :
2334 * tcp_diag_get_info(), tcp_get_info(), tcp_poll(), get_tcp4_sock() ...
2335 */
2336static inline int sk_state_load(const struct sock *sk)
2337{
2338 return smp_load_acquire(&sk->sk_state);
2339}
2340
2341/**
2342 * sk_state_store - update sk->sk_state
2343 * @sk: socket pointer
2344 * @newstate: new state
2345 *
2346 * Paired with sk_state_load(). Should be used in contexts where
2347 * state change might impact lockless readers.
2348 */
2349static inline void sk_state_store(struct sock *sk, int newstate)
2350{
2351 smp_store_release(&sk->sk_state, newstate);
2352}
2353
Joe Perches69336bd2013-09-22 10:32:26 -07002354void sock_enable_timestamp(struct sock *sk, int flag);
2355int sock_get_timestamp(struct sock *, struct timeval __user *);
2356int sock_get_timestampns(struct sock *, struct timespec __user *);
2357int sock_recv_errqueue(struct sock *sk, struct msghdr *msg, int len, int level,
2358 int type);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002359
Eric W. Biedermana3b299d2014-04-23 14:26:56 -07002360bool sk_ns_capable(const struct sock *sk,
2361 struct user_namespace *user_ns, int cap);
2362bool sk_capable(const struct sock *sk, int cap);
2363bool sk_net_capable(const struct sock *sk, int cap);
2364
Linus Torvalds1da177e2005-04-16 15:20:36 -07002365extern __u32 sysctl_wmem_max;
2366extern __u32 sysctl_rmem_max;
2367
Willem de Bruijnb245be12015-01-30 13:29:32 -05002368extern int sysctl_tstamp_allow_data;
David S. Miller6baf1f42005-09-05 18:14:11 -07002369extern int sysctl_optmem_max;
2370
Arnaldo Carvalho de Melo20380732005-08-16 02:18:02 -03002371extern __u32 sysctl_wmem_default;
2372extern __u32 sysctl_rmem_default;
Arnaldo Carvalho de Melo20380732005-08-16 02:18:02 -03002373
Linus Torvalds1da177e2005-04-16 15:20:36 -07002374#endif /* _SOCK_H */