Revert "net: set SK_MEM_QUANTUM to 4096"
[linux-block.git] / include / net / sock.h
CommitLineData
2874c5fd 1/* SPDX-License-Identifier: GPL-2.0-or-later */
1da177e4
LT
2/*
3 * INET An implementation of the TCP/IP protocol suite for the LINUX
4 * operating system. INET is implemented using the BSD Socket
5 * interface as the means of communication with the user level.
6 *
7 * Definitions for the AF_INET socket handler.
8 *
9 * Version: @(#)sock.h 1.0.4 05/13/93
10 *
02c30a84 11 * Authors: Ross Biro
1da177e4
LT
12 * Fred N. van Kempen, <waltje@uWalt.NL.Mugnet.ORG>
13 * Corey Minyard <wf-rch!minyard@relay.EU.net>
14 * Florian La Roche <flla@stud.uni-sb.de>
15 *
16 * Fixes:
17 * Alan Cox : Volatiles in skbuff pointers. See
18 * skbuff comments. May be overdone,
19 * better to prove they can be removed
20 * than the reverse.
21 * Alan Cox : Added a zapped field for tcp to note
22 * a socket is reset and must stay shut up
23 * Alan Cox : New fields for options
24 * Pauline Middelink : identd support
25 * Alan Cox : Eliminate low level recv/recvfrom
26 * David S. Miller : New socket lookup architecture.
27 * Steve Whitehouse: Default routines for sock_ops
28 * Arnaldo C. Melo : removed net_pinfo, tp_pinfo and made
29 * protinfo be just a void pointer, as the
30 * protocol specific parts were moved to
31 * respective headers and ipv4/v6, etc now
32 * use private slabcaches for its socks
33 * Pedro Hortas : New flags field for socket options
1da177e4
LT
34 */
35#ifndef _SOCK_H
36#define _SOCK_H
37
a6b7a407 38#include <linux/hardirq.h>
172589cc 39#include <linux/kernel.h>
1da177e4 40#include <linux/list.h>
88ab1932 41#include <linux/list_nulls.h>
1da177e4
LT
42#include <linux/timer.h>
43#include <linux/cache.h>
3f134619 44#include <linux/bitops.h>
a5b5bb9a 45#include <linux/lockdep.h>
1da177e4
LT
46#include <linux/netdevice.h>
47#include <linux/skbuff.h> /* struct sk_buff */
d7fe0f24 48#include <linux/mm.h>
1da177e4 49#include <linux/security.h>
5a0e3ad6 50#include <linux/slab.h>
c6e1a0d1 51#include <linux/uaccess.h>
3e32cb2e 52#include <linux/page_counter.h>
180d8cd9 53#include <linux/memcontrol.h>
c5905afb 54#include <linux/static_key.h>
40401530 55#include <linux/sched.h>
1ce0bf50 56#include <linux/wait.h>
2a56a1fe 57#include <linux/cgroup-defs.h>
75c119af 58#include <linux/rbtree.h>
88ab1932 59#include <linux/rculist_nulls.h>
a57de0b4 60#include <linux/poll.h>
c8c1bbb6 61#include <linux/sockptr.h>
1c5f2ced 62#include <linux/indirect_call_wrapper.h>
c31504dc 63#include <linux/atomic.h>
41c6d650 64#include <linux/refcount.h>
f35f8219 65#include <linux/llist.h>
1da177e4
LT
66#include <net/dst.h>
67#include <net/checksum.h>
1d0ab253 68#include <net/tcp_states.h>
b9f40e21 69#include <linux/net_tstamp.h>
54dc3e33 70#include <net/l3mdev.h>
04190bf8 71#include <uapi/linux/socket.h>
1da177e4
LT
72
73/*
74 * This structure really needs to be cleaned up.
75 * Most of it is for TCP, and not used by any of
76 * the other protocols.
77 */
78
79/* Define this to get the SOCK_DBG debugging facility. */
80#define SOCK_DEBUGGING
81#ifdef SOCK_DEBUGGING
82#define SOCK_DEBUG(sk, msg...) do { if ((sk) && sock_flag((sk), SOCK_DBG)) \
83 printk(KERN_DEBUG msg); } while (0)
84#else
4cd9029d 85/* Validate arguments and do nothing */
b9075fa9 86static inline __printf(2, 3)
dc6b9b78 87void SOCK_DEBUG(const struct sock *sk, const char *msg, ...)
4cd9029d
SH
88{
89}
1da177e4
LT
90#endif
91
92/* This is the per-socket lock. The spinlock provides a synchronization
93 * between user contexts and software interrupt processing, whereas the
94 * mini-semaphore synchronizes multiple users amongst themselves.
95 */
1da177e4
LT
96typedef struct {
97 spinlock_t slock;
d2e9117c 98 int owned;
1da177e4 99 wait_queue_head_t wq;
a5b5bb9a
IM
100 /*
101 * We express the mutex-alike socket_lock semantics
102 * to the lock validator by explicitly managing
103 * the slock as a lock variant (in addition to
104 * the slock itself):
105 */
106#ifdef CONFIG_DEBUG_LOCK_ALLOC
107 struct lockdep_map dep_map;
108#endif
1da177e4
LT
109} socket_lock_t;
110
1da177e4 111struct sock;
8feaf0c0 112struct proto;
0eeb8ffc 113struct net;
1da177e4 114
077b393d
ED
115typedef __u32 __bitwise __portpair;
116typedef __u64 __bitwise __addrpair;
117
1da177e4 118/**
4dc3b16b 119 * struct sock_common - minimal network layer representation of sockets
68835aba
ED
120 * @skc_daddr: Foreign IPv4 addr
121 * @skc_rcv_saddr: Bound local IPv4 addr
66256e0b 122 * @skc_addrpair: 8-byte-aligned __u64 union of @skc_daddr & @skc_rcv_saddr
4dc6dc71 123 * @skc_hash: hash value used with various protocol lookup tables
d4cada4a 124 * @skc_u16hashes: two u16 hash values used by UDP lookup tables
ce43b03e
ED
125 * @skc_dport: placeholder for inet_dport/tw_dport
126 * @skc_num: placeholder for inet_num/tw_num
66256e0b 127 * @skc_portpair: __u32 union of @skc_dport & @skc_num
4dc3b16b
PP
128 * @skc_family: network address family
129 * @skc_state: Connection state
130 * @skc_reuse: %SO_REUSEADDR setting
055dc21a 131 * @skc_reuseport: %SO_REUSEPORT setting
66256e0b
RD
132 * @skc_ipv6only: socket is IPV6 only
133 * @skc_net_refcnt: socket is using net ref counting
4dc3b16b 134 * @skc_bound_dev_if: bound device index if != 0
4dc3b16b 135 * @skc_bind_node: bind hash linkage for various protocol lookup tables
512615b6 136 * @skc_portaddr_node: second hash linkage for UDP/UDP-Lite protocol
8feaf0c0 137 * @skc_prot: protocol handlers inside a network family
07feaebf 138 * @skc_net: reference to the network namespace of this socket
66256e0b
RD
139 * @skc_v6_daddr: IPV6 destination address
140 * @skc_v6_rcv_saddr: IPV6 source address
141 * @skc_cookie: socket's cookie value
68835aba
ED
142 * @skc_node: main hash linkage for various protocol lookup tables
143 * @skc_nulls_node: main hash linkage for TCP/UDP/UDP-Lite protocol
144 * @skc_tx_queue_mapping: tx queue number for this connection
c6345ce7 145 * @skc_rx_queue_mapping: rx queue number for this connection
8e5eb54d
ED
146 * @skc_flags: place holder for sk_flags
147 * %SO_LINGER (l_onoff), %SO_BROADCAST, %SO_KEEPALIVE,
148 * %SO_OOBINLINE settings, %SO_TIMESTAMPING settings
66256e0b
RD
149 * @skc_listener: connection request listener socket (aka rsk_listener)
150 * [union with @skc_flags]
151 * @skc_tw_dr: (aka tw_dr) ptr to &struct inet_timewait_death_row
152 * [union with @skc_flags]
70da268b 153 * @skc_incoming_cpu: record/match cpu processing incoming packets
66256e0b
RD
154 * @skc_rcv_wnd: (aka rsk_rcv_wnd) TCP receive window size (possibly scaled)
155 * [union with @skc_incoming_cpu]
156 * @skc_tw_rcv_nxt: (aka tw_rcv_nxt) TCP window next expected seq number
157 * [union with @skc_incoming_cpu]
68835aba 158 * @skc_refcnt: reference count
4dc3b16b
PP
159 *
160 * This is the minimal network layer representation of sockets, the header
8feaf0c0
ACM
161 * for struct sock and struct inet_timewait_sock.
162 */
1da177e4 163struct sock_common {
ce43b03e 164 union {
077b393d 165 __addrpair skc_addrpair;
ce43b03e
ED
166 struct {
167 __be32 skc_daddr;
168 __be32 skc_rcv_saddr;
169 };
170 };
d4cada4a
ED
171 union {
172 unsigned int skc_hash;
173 __u16 skc_u16hashes[2];
174 };
ce43b03e
ED
175 /* skc_dport && skc_num must be grouped as well */
176 union {
077b393d 177 __portpair skc_portpair;
ce43b03e
ED
178 struct {
179 __be16 skc_dport;
180 __u16 skc_num;
181 };
182 };
183
4dc6dc71
ED
184 unsigned short skc_family;
185 volatile unsigned char skc_state;
055dc21a 186 unsigned char skc_reuse:4;
9fe516ba
ED
187 unsigned char skc_reuseport:1;
188 unsigned char skc_ipv6only:1;
26abe143 189 unsigned char skc_net_refcnt:1;
4dc6dc71 190 int skc_bound_dev_if;
512615b6
ED
191 union {
192 struct hlist_node skc_bind_node;
ca065d0c 193 struct hlist_node skc_portaddr_node;
512615b6 194 };
8feaf0c0 195 struct proto *skc_prot;
0c5c9fb5 196 possible_net_t skc_net;
efe4208f
ED
197
198#if IS_ENABLED(CONFIG_IPV6)
199 struct in6_addr skc_v6_daddr;
200 struct in6_addr skc_v6_rcv_saddr;
201#endif
202
33cf7c90
ED
203 atomic64_t skc_cookie;
204
8e5eb54d
ED
205 /* following fields are padding to force
206 * offset(struct sock, sk_refcnt) == 128 on 64bit arches
207 * assuming IPV6 is enabled. We use this padding differently
208 * for different kind of 'sockets'
209 */
210 union {
211 unsigned long skc_flags;
212 struct sock *skc_listener; /* request_sock */
213 struct inet_timewait_death_row *skc_tw_dr; /* inet_timewait_sock */
214 };
68835aba
ED
215 /*
216 * fields between dontcopy_begin/dontcopy_end
217 * are not copied in sock_copy()
218 */
928c41e7 219 /* private: */
68835aba 220 int skc_dontcopy_begin[0];
928c41e7 221 /* public: */
68835aba
ED
222 union {
223 struct hlist_node skc_node;
224 struct hlist_nulls_node skc_nulls_node;
225 };
755c31cd 226 unsigned short skc_tx_queue_mapping;
4e1beecc 227#ifdef CONFIG_SOCK_RX_QUEUE_MAPPING
c6345ce7
AN
228 unsigned short skc_rx_queue_mapping;
229#endif
ed53d0ab
ED
230 union {
231 int skc_incoming_cpu;
232 u32 skc_rcv_wnd;
d475f090 233 u32 skc_tw_rcv_nxt; /* struct tcp_timewait_sock */
ed53d0ab 234 };
70da268b 235
41c6d650 236 refcount_t skc_refcnt;
928c41e7 237 /* private: */
68835aba 238 int skc_dontcopy_end[0];
ed53d0ab
ED
239 union {
240 u32 skc_rxhash;
241 u32 skc_window_clamp;
d475f090 242 u32 skc_tw_snd_nxt; /* struct tcp_timewait_sock */
ed53d0ab 243 };
928c41e7 244 /* public: */
1da177e4
LT
245};
246
1f00d375 247struct bpf_local_storage;
b6459415 248struct sk_filter;
6ac99e8f 249
1da177e4
LT
250/**
251 * struct sock - network layer representation of sockets
8feaf0c0 252 * @__sk_common: shared layout with inet_timewait_sock
4dc3b16b
PP
253 * @sk_shutdown: mask of %SEND_SHUTDOWN and/or %RCV_SHUTDOWN
254 * @sk_userlocks: %SO_SNDBUF and %SO_RCVBUF settings
255 * @sk_lock: synchronizer
cdfbabfb 256 * @sk_kern_sock: True if sock is using kernel lock classes
4dc3b16b 257 * @sk_rcvbuf: size of receive buffer in bytes
43815482 258 * @sk_wq: sock wait queue and async head
421b3885 259 * @sk_rx_dst: receive input route used by early demux
0c0a5ef8 260 * @sk_rx_dst_ifindex: ifindex for @sk_rx_dst
ef57c161 261 * @sk_rx_dst_cookie: cookie for @sk_rx_dst
4dc3b16b 262 * @sk_dst_cache: destination cache
9b8805a3 263 * @sk_dst_pending_confirm: need to confirm neighbour
4dc3b16b 264 * @sk_policy: flow policy
4dc3b16b
PP
265 * @sk_receive_queue: incoming packets
266 * @sk_wmem_alloc: transmit queue bytes committed
771edcaf 267 * @sk_tsq_flags: TCP Small Queues flags
4dc3b16b
PP
268 * @sk_write_queue: Packet sending queue
269 * @sk_omem_alloc: "o" is "option" or "other"
270 * @sk_wmem_queued: persistent queue size
271 * @sk_forward_alloc: space allocated forward
2bb2f5fb 272 * @sk_reserved_mem: space reserved and non-reclaimable for the socket
06021292 273 * @sk_napi_id: id of the last napi context to receive data for sk
dafcc438 274 * @sk_ll_usec: usecs to busypoll when there is no data
4dc3b16b 275 * @sk_allocation: allocation mode
95bd09eb 276 * @sk_pacing_rate: Pacing rate (if supported by transport/packet scheduler)
218af599 277 * @sk_pacing_status: Pacing status (requested, handled by sch_fq)
c3f40d7c 278 * @sk_max_pacing_rate: Maximum pacing rate (%SO_MAX_PACING_RATE)
4dc3b16b 279 * @sk_sndbuf: size of send buffer in bytes
771edcaf 280 * @__sk_flags_offset: empty field used to determine location of bitfield
293de7de 281 * @sk_padding: unused element for alignment
28448b80
TH
282 * @sk_no_check_tx: %SO_NO_CHECK setting, set checksum in TX packets
283 * @sk_no_check_rx: allow zero checksum in RX packets
4dc3b16b 284 * @sk_route_caps: route capabilities (e.g. %NETIF_F_TSO)
aba54656 285 * @sk_gso_disabled: if set, NETIF_F_GSO_MASK is forbidden.
bcd76111 286 * @sk_gso_type: GSO type (e.g. %SKB_GSO_TCPV4)
82cc1a7a 287 * @sk_gso_max_size: Maximum GSO segment size to build
1485348d 288 * @sk_gso_max_segs: Maximum number of GSO segments
3a9b76fd 289 * @sk_pacing_shift: scaling factor for TCP Small Queues
4dc3b16b 290 * @sk_lingertime: %SO_LINGER l_linger setting
4dc3b16b
PP
291 * @sk_backlog: always used with the per-socket spinlock held
292 * @sk_callback_lock: used with the callbacks in the end of this struct
293 * @sk_error_queue: rarely used
33c732c3
WC
294 * @sk_prot_creator: sk_prot of original sock creator (see ipv6_setsockopt,
295 * IPV6_ADDRFORM for instance)
4dc3b16b 296 * @sk_err: last error
33c732c3
WC
297 * @sk_err_soft: errors that don't cause failure but are the cause of a
298 * persistent failure not just 'timed out'
cb61cb9b 299 * @sk_drops: raw/udp drops counter
4dc3b16b
PP
300 * @sk_ack_backlog: current listen backlog
301 * @sk_max_ack_backlog: listen backlog set in listen()
771edcaf 302 * @sk_uid: user id of owner
7fd3253a 303 * @sk_prefer_busy_poll: prefer busypolling over softirq processing
7c951caf 304 * @sk_busy_poll_budget: napi processing budget when busypolling
4dc3b16b
PP
305 * @sk_priority: %SO_PRIORITY setting
306 * @sk_type: socket type (%SOCK_STREAM, etc)
307 * @sk_protocol: which protocol this socket belongs in this network family
5fb14d20 308 * @sk_peer_lock: lock protecting @sk_peer_pid and @sk_peer_cred
53c3fa20
RD
309 * @sk_peer_pid: &struct pid for this socket's peer
310 * @sk_peer_cred: %SO_PEERCRED setting
4dc3b16b
PP
311 * @sk_rcvlowat: %SO_RCVLOWAT setting
312 * @sk_rcvtimeo: %SO_RCVTIMEO setting
313 * @sk_sndtimeo: %SO_SNDTIMEO setting
b73c3d0e 314 * @sk_txhash: computed flow hash for use on transmit
26859240 315 * @sk_txrehash: enable TX hash rethink
4dc3b16b 316 * @sk_filter: socket filtering instructions
4dc3b16b
PP
317 * @sk_timer: sock cleanup timer
318 * @sk_stamp: time stamp of last packet received
3a0ed3e9 319 * @sk_stamp_seq: lock for accessing sk_stamp on 32 bit architectures only
d463126e
YL
320 * @sk_tsflags: SO_TIMESTAMPING flags
321 * @sk_bind_phc: SO_TIMESTAMPING bind PHC index of PTP virtual clock
322 * for timestamping
09c2d251 323 * @sk_tskey: counter to disambiguate concurrent tstamp requests
52267790 324 * @sk_zckey: counter to order MSG_ZEROCOPY notifications
4dc3b16b
PP
325 * @sk_socket: Identd and reporting IO signals
326 * @sk_user_data: RPC layer private data
5640f768 327 * @sk_frag: cached page frag
d3d4f0a0 328 * @sk_peek_off: current peek_offset value
4dc3b16b 329 * @sk_send_head: front of stuff to transmit
66256e0b 330 * @tcp_rtx_queue: TCP re-transmit queue [union with @sk_send_head]
67be2dd1 331 * @sk_security: used by security modules
31729363 332 * @sk_mark: generic packet mark
2a56a1fe 333 * @sk_cgrp_data: cgroup data for this cgroup
baac50bb 334 * @sk_memcg: this socket's memory cgroup association
4dc3b16b
PP
335 * @sk_write_pending: a write to stream socket waits to start
336 * @sk_state_change: callback to indicate change in the state of the sock
337 * @sk_data_ready: callback to indicate there is data to be processed
338 * @sk_write_space: callback to indicate there is bf sending space available
339 * @sk_error_report: callback to indicate errors (e.g. %MSG_ERRQUEUE)
340 * @sk_backlog_rcv: callback to process the backlog
66256e0b 341 * @sk_validate_xmit_skb: ptr to an optional validate function
4dc3b16b 342 * @sk_destruct: called at sock freeing time, i.e. when all refcnt == 0
ef456144 343 * @sk_reuseport_cb: reuseport group container
66256e0b 344 * @sk_bpf_storage: ptr to cache and control for bpf_sk_storage
293de7de 345 * @sk_rcu: used during RCU grace period
80b14dee
RC
346 * @sk_clockid: clockid used by time-based scheduling (SO_TXTIME)
347 * @sk_txtime_deadline_mode: set deadline mode for SO_TXTIME
66256e0b 348 * @sk_txtime_report_errors: set report errors mode for SO_TXTIME
80b14dee 349 * @sk_txtime_unused: unused txtime flags
ffa84b5f 350 * @ns_tracker: tracker for netns reference
d5a42de8 351 * @sk_bind2_node: bind node in the bhash2 table
293de7de 352 */
1da177e4
LT
353struct sock {
354 /*
8feaf0c0 355 * Now struct inet_timewait_sock also uses sock_common, so please just
1da177e4
LT
356 * don't add nothing before this first member (__sk_common) --acme
357 */
358 struct sock_common __sk_common;
4dc6dc71
ED
359#define sk_node __sk_common.skc_node
360#define sk_nulls_node __sk_common.skc_nulls_node
361#define sk_refcnt __sk_common.skc_refcnt
e022f0b4 362#define sk_tx_queue_mapping __sk_common.skc_tx_queue_mapping
4e1beecc 363#ifdef CONFIG_SOCK_RX_QUEUE_MAPPING
c6345ce7
AN
364#define sk_rx_queue_mapping __sk_common.skc_rx_queue_mapping
365#endif
4dc6dc71 366
68835aba
ED
367#define sk_dontcopy_begin __sk_common.skc_dontcopy_begin
368#define sk_dontcopy_end __sk_common.skc_dontcopy_end
4dc6dc71 369#define sk_hash __sk_common.skc_hash
50805466 370#define sk_portpair __sk_common.skc_portpair
05dbc7b5
ED
371#define sk_num __sk_common.skc_num
372#define sk_dport __sk_common.skc_dport
50805466
ED
373#define sk_addrpair __sk_common.skc_addrpair
374#define sk_daddr __sk_common.skc_daddr
375#define sk_rcv_saddr __sk_common.skc_rcv_saddr
1da177e4
LT
376#define sk_family __sk_common.skc_family
377#define sk_state __sk_common.skc_state
378#define sk_reuse __sk_common.skc_reuse
055dc21a 379#define sk_reuseport __sk_common.skc_reuseport
9fe516ba 380#define sk_ipv6only __sk_common.skc_ipv6only
26abe143 381#define sk_net_refcnt __sk_common.skc_net_refcnt
1da177e4 382#define sk_bound_dev_if __sk_common.skc_bound_dev_if
1da177e4 383#define sk_bind_node __sk_common.skc_bind_node
8feaf0c0 384#define sk_prot __sk_common.skc_prot
07feaebf 385#define sk_net __sk_common.skc_net
efe4208f
ED
386#define sk_v6_daddr __sk_common.skc_v6_daddr
387#define sk_v6_rcv_saddr __sk_common.skc_v6_rcv_saddr
33cf7c90 388#define sk_cookie __sk_common.skc_cookie
70da268b 389#define sk_incoming_cpu __sk_common.skc_incoming_cpu
8e5eb54d 390#define sk_flags __sk_common.skc_flags
ed53d0ab 391#define sk_rxhash __sk_common.skc_rxhash
efe4208f 392
43f51df4 393 /* early demux fields */
8b3f9133 394 struct dst_entry __rcu *sk_rx_dst;
43f51df4
ED
395 int sk_rx_dst_ifindex;
396 u32 sk_rx_dst_cookie;
397
1da177e4 398 socket_lock_t sk_lock;
9115e8cd
ED
399 atomic_t sk_drops;
400 int sk_rcvlowat;
401 struct sk_buff_head sk_error_queue;
b178bb3d 402 struct sk_buff_head sk_receive_queue;
fa438ccf
ED
403 /*
404 * The backlog queue is special, it is always used with
405 * the per-socket spinlock held and requires low latency
406 * access. Therefore we special case it's implementation.
b178bb3d
ED
407 * Note : rmem_alloc is in this structure to fill a hole
408 * on 64bit arches, not because its logically part of
409 * backlog.
fa438ccf
ED
410 */
411 struct {
b178bb3d
ED
412 atomic_t rmem_alloc;
413 int len;
414 struct sk_buff *head;
415 struct sk_buff *tail;
fa438ccf 416 } sk_backlog;
f35f8219 417
b178bb3d 418#define sk_rmem_alloc sk_backlog.rmem_alloc
2c8c56e1 419
9115e8cd 420 int sk_forward_alloc;
2bb2f5fb 421 u32 sk_reserved_mem;
e0d1095a 422#ifdef CONFIG_NET_RX_BUSY_POLL
dafcc438 423 unsigned int sk_ll_usec;
9115e8cd
ED
424 /* ===== mostly read cache line ===== */
425 unsigned int sk_napi_id;
b178bb3d 426#endif
b178bb3d
ED
427 int sk_rcvbuf;
428
429 struct sk_filter __rcu *sk_filter;
ceb5d58b
ED
430 union {
431 struct socket_wq __rcu *sk_wq;
66256e0b 432 /* private: */
ceb5d58b 433 struct socket_wq *sk_wq_raw;
66256e0b 434 /* public: */
ceb5d58b 435 };
def8b4fa 436#ifdef CONFIG_XFRM
d188ba86 437 struct xfrm_policy __rcu *sk_policy[2];
def8b4fa 438#endif
0c0a5ef8 439
0e36cbb3 440 struct dst_entry __rcu *sk_dst_cache;
1da177e4 441 atomic_t sk_omem_alloc;
4e07a91c 442 int sk_sndbuf;
9115e8cd
ED
443
444 /* ===== cache line for TX ===== */
445 int sk_wmem_queued;
14afee4b 446 refcount_t sk_wmem_alloc;
9115e8cd 447 unsigned long sk_tsq_flags;
75c119af
ED
448 union {
449 struct sk_buff *sk_send_head;
450 struct rb_root tcp_rtx_queue;
451 };
1da177e4 452 struct sk_buff_head sk_write_queue;
9115e8cd
ED
453 __s32 sk_peek_off;
454 int sk_write_pending;
9b8805a3 455 __u32 sk_dst_pending_confirm;
218af599 456 u32 sk_pacing_status; /* see enum sk_pacing */
9115e8cd
ED
457 long sk_sndtimeo;
458 struct timer_list sk_timer;
459 __u32 sk_priority;
460 __u32 sk_mark;
76a9ebe8
ED
461 unsigned long sk_pacing_rate; /* bytes per second */
462 unsigned long sk_max_pacing_rate;
9115e8cd
ED
463 struct page_frag sk_frag;
464 netdev_features_t sk_route_caps;
9115e8cd
ED
465 int sk_gso_type;
466 unsigned int sk_gso_max_size;
467 gfp_t sk_allocation;
468 __u32 sk_txhash;
fc64869c
AR
469
470 /*
471 * Because of non atomicity rules, all
472 * changes are protected by socket lock.
473 */
aba54656 474 u8 sk_gso_disabled : 1,
cdfbabfb 475 sk_kern_sock : 1,
28448b80
TH
476 sk_no_check_tx : 1,
477 sk_no_check_rx : 1,
bf976514 478 sk_userlocks : 4;
3a9b76fd 479 u8 sk_pacing_shift;
bf976514
MM
480 u16 sk_type;
481 u16 sk_protocol;
482 u16 sk_gso_max_segs;
1da177e4 483 unsigned long sk_lingertime;
476e19cf 484 struct proto *sk_prot_creator;
1da177e4
LT
485 rwlock_t sk_callback_lock;
486 int sk_err,
487 sk_err_soft;
becb74f0
ED
488 u32 sk_ack_backlog;
489 u32 sk_max_ack_backlog;
86741ec2 490 kuid_t sk_uid;
26859240 491 u8 sk_txrehash;
7fd3253a
BT
492#ifdef CONFIG_NET_RX_BUSY_POLL
493 u8 sk_prefer_busy_poll;
7c951caf 494 u16 sk_busy_poll_budget;
7fd3253a 495#endif
35306eb2 496 spinlock_t sk_peer_lock;
1ace2b4d 497 int sk_bind_phc;
109f6e39
EB
498 struct pid *sk_peer_pid;
499 const struct cred *sk_peer_cred;
35306eb2 500
1da177e4 501 long sk_rcvtimeo;
b7aa0bf7 502 ktime_t sk_stamp;
3a0ed3e9
DD
503#if BITS_PER_LONG==32
504 seqlock_t sk_stamp_seq;
505#endif
b9f40e21 506 u16 sk_tsflags;
fc64869c 507 u8 sk_shutdown;
a1cdec57 508 atomic_t sk_tskey;
52267790 509 atomic_t sk_zckey;
80b14dee
RC
510
511 u8 sk_clockid;
512 u8 sk_txtime_deadline_mode : 1,
4b15c707
JSP
513 sk_txtime_report_errors : 1,
514 sk_txtime_unused : 6;
80b14dee 515
1da177e4
LT
516 struct socket *sk_socket;
517 void *sk_user_data;
d5f64238 518#ifdef CONFIG_SECURITY
1da177e4 519 void *sk_security;
d5f64238 520#endif
2a56a1fe 521 struct sock_cgroup_data sk_cgrp_data;
baac50bb 522 struct mem_cgroup *sk_memcg;
1da177e4 523 void (*sk_state_change)(struct sock *sk);
676d2369 524 void (*sk_data_ready)(struct sock *sk);
1da177e4
LT
525 void (*sk_write_space)(struct sock *sk);
526 void (*sk_error_report)(struct sock *sk);
dc6b9b78
ED
527 int (*sk_backlog_rcv)(struct sock *sk,
528 struct sk_buff *skb);
ebf4e808
IL
529#ifdef CONFIG_SOCK_VALIDATE_XMIT
530 struct sk_buff* (*sk_validate_xmit_skb)(struct sock *sk,
531 struct net_device *dev,
532 struct sk_buff *skb);
533#endif
1da177e4 534 void (*sk_destruct)(struct sock *sk);
ef456144 535 struct sock_reuseport __rcu *sk_reuseport_cb;
6ac99e8f 536#ifdef CONFIG_BPF_SYSCALL
1f00d375 537 struct bpf_local_storage __rcu *sk_bpf_storage;
6ac99e8f 538#endif
a4298e45 539 struct rcu_head sk_rcu;
ffa84b5f 540 netns_tracker ns_tracker;
d5a42de8 541 struct hlist_node sk_bind2_node;
1da177e4
LT
542};
543
218af599
ED
544enum sk_pacing {
545 SK_PACING_NONE = 0,
546 SK_PACING_NEEDED = 1,
547 SK_PACING_FQ = 2,
548};
549
f1ff5ce2
JS
550/* Pointer stored in sk_user_data might not be suitable for copying
551 * when cloning the socket. For instance, it can point to a reference
552 * counted object. sk_user_data bottom bit is set if pointer must not
553 * be copied.
554 */
555#define SK_USER_DATA_NOCOPY 1UL
c9a368f1
MKL
556#define SK_USER_DATA_BPF 2UL /* Managed by BPF */
557#define SK_USER_DATA_PTRMASK ~(SK_USER_DATA_NOCOPY | SK_USER_DATA_BPF)
f1ff5ce2
JS
558
559/**
560 * sk_user_data_is_nocopy - Test if sk_user_data pointer must not be copied
561 * @sk: socket
562 */
563static inline bool sk_user_data_is_nocopy(const struct sock *sk)
564{
565 return ((uintptr_t)sk->sk_user_data & SK_USER_DATA_NOCOPY);
566}
567
559835ea
PS
568#define __sk_user_data(sk) ((*((void __rcu **)&(sk)->sk_user_data)))
569
f1ff5ce2
JS
570#define rcu_dereference_sk_user_data(sk) \
571({ \
572 void *__tmp = rcu_dereference(__sk_user_data((sk))); \
573 (void *)((uintptr_t)__tmp & SK_USER_DATA_PTRMASK); \
574})
575#define rcu_assign_sk_user_data(sk, ptr) \
576({ \
577 uintptr_t __tmp = (uintptr_t)(ptr); \
578 WARN_ON_ONCE(__tmp & ~SK_USER_DATA_PTRMASK); \
579 rcu_assign_pointer(__sk_user_data((sk)), __tmp); \
580})
581#define rcu_assign_sk_user_data_nocopy(sk, ptr) \
582({ \
583 uintptr_t __tmp = (uintptr_t)(ptr); \
584 WARN_ON_ONCE(__tmp & ~SK_USER_DATA_PTRMASK); \
585 rcu_assign_pointer(__sk_user_data((sk)), \
586 __tmp | SK_USER_DATA_NOCOPY); \
587})
559835ea 588
e187013a
AK
589static inline
590struct net *sock_net(const struct sock *sk)
591{
592 return read_pnet(&sk->sk_net);
593}
594
595static inline
596void sock_net_set(struct sock *sk, struct net *net)
597{
598 write_pnet(&sk->sk_net, net);
599}
600
4a17fd52
PE
601/*
602 * SK_CAN_REUSE and SK_NO_REUSE on a socket mean that the socket is OK
603 * or not whether his port will be reused by someone else. SK_FORCE_REUSE
604 * on a socket means that the socket will reuse everybody else's port
605 * without looking at the other's sk_reuse value.
606 */
607
608#define SK_NO_REUSE 0
609#define SK_CAN_REUSE 1
610#define SK_FORCE_REUSE 2
611
627d2d6b 612int sk_set_peek_off(struct sock *sk, int val);
613
a84a434b 614static inline int sk_peek_offset(const struct sock *sk, int flags)
ef64a54f 615{
b9bb53f3 616 if (unlikely(flags & MSG_PEEK)) {
a0917e0b 617 return READ_ONCE(sk->sk_peek_off);
b9bb53f3
WB
618 }
619
620 return 0;
ef64a54f
PE
621}
622
623static inline void sk_peek_offset_bwd(struct sock *sk, int val)
624{
b9bb53f3
WB
625 s32 off = READ_ONCE(sk->sk_peek_off);
626
627 if (unlikely(off >= 0)) {
628 off = max_t(s32, off - val, 0);
629 WRITE_ONCE(sk->sk_peek_off, off);
ef64a54f
PE
630 }
631}
632
633static inline void sk_peek_offset_fwd(struct sock *sk, int val)
634{
b9bb53f3 635 sk_peek_offset_bwd(sk, -val);
ef64a54f
PE
636}
637
1da177e4
LT
638/*
639 * Hashed lists helper routines
640 */
c4146644
LZ
641static inline struct sock *sk_entry(const struct hlist_node *node)
642{
643 return hlist_entry(node, struct sock, sk_node);
644}
645
e48c414e 646static inline struct sock *__sk_head(const struct hlist_head *head)
1da177e4
LT
647{
648 return hlist_entry(head->first, struct sock, sk_node);
649}
650
e48c414e 651static inline struct sock *sk_head(const struct hlist_head *head)
1da177e4
LT
652{
653 return hlist_empty(head) ? NULL : __sk_head(head);
654}
655
88ab1932
ED
656static inline struct sock *__sk_nulls_head(const struct hlist_nulls_head *head)
657{
658 return hlist_nulls_entry(head->first, struct sock, sk_nulls_node);
659}
660
661static inline struct sock *sk_nulls_head(const struct hlist_nulls_head *head)
662{
663 return hlist_nulls_empty(head) ? NULL : __sk_nulls_head(head);
664}
665
e48c414e 666static inline struct sock *sk_next(const struct sock *sk)
1da177e4 667{
6c59ebd3 668 return hlist_entry_safe(sk->sk_node.next, struct sock, sk_node);
1da177e4
LT
669}
670
88ab1932
ED
671static inline struct sock *sk_nulls_next(const struct sock *sk)
672{
673 return (!is_a_nulls(sk->sk_nulls_node.next)) ?
674 hlist_nulls_entry(sk->sk_nulls_node.next,
675 struct sock, sk_nulls_node) :
676 NULL;
677}
678
dc6b9b78 679static inline bool sk_unhashed(const struct sock *sk)
1da177e4
LT
680{
681 return hlist_unhashed(&sk->sk_node);
682}
683
dc6b9b78 684static inline bool sk_hashed(const struct sock *sk)
1da177e4 685{
da753bea 686 return !sk_unhashed(sk);
1da177e4
LT
687}
688
dc6b9b78 689static inline void sk_node_init(struct hlist_node *node)
1da177e4
LT
690{
691 node->pprev = NULL;
692}
693
dc6b9b78 694static inline void sk_nulls_node_init(struct hlist_nulls_node *node)
88ab1932
ED
695{
696 node->pprev = NULL;
697}
698
dc6b9b78 699static inline void __sk_del_node(struct sock *sk)
1da177e4
LT
700{
701 __hlist_del(&sk->sk_node);
702}
703
808f5114 704/* NB: equivalent to hlist_del_init_rcu */
dc6b9b78 705static inline bool __sk_del_node_init(struct sock *sk)
1da177e4
LT
706{
707 if (sk_hashed(sk)) {
708 __sk_del_node(sk);
709 sk_node_init(&sk->sk_node);
dc6b9b78 710 return true;
1da177e4 711 }
dc6b9b78 712 return false;
1da177e4
LT
713}
714
715/* Grab socket reference count. This operation is valid only
716 when sk is ALREADY grabbed f.e. it is found in hash table
717 or a list and the lookup is made under lock preventing hash table
718 modifications.
719 */
720
f9a7cbbf 721static __always_inline void sock_hold(struct sock *sk)
1da177e4 722{
41c6d650 723 refcount_inc(&sk->sk_refcnt);
1da177e4
LT
724}
725
726/* Ungrab socket in the context, which assumes that socket refcnt
727 cannot hit zero, f.e. it is true in context of any socketcall.
728 */
f9a7cbbf 729static __always_inline void __sock_put(struct sock *sk)
1da177e4 730{
41c6d650 731 refcount_dec(&sk->sk_refcnt);
1da177e4
LT
732}
733
dc6b9b78 734static inline bool sk_del_node_init(struct sock *sk)
1da177e4 735{
dc6b9b78 736 bool rc = __sk_del_node_init(sk);
1da177e4
LT
737
738 if (rc) {
739 /* paranoid for a while -acme */
41c6d650 740 WARN_ON(refcount_read(&sk->sk_refcnt) == 1);
1da177e4
LT
741 __sock_put(sk);
742 }
743 return rc;
744}
808f5114 745#define sk_del_node_init_rcu(sk) sk_del_node_init(sk)
1da177e4 746
dc6b9b78 747static inline bool __sk_nulls_del_node_init_rcu(struct sock *sk)
271b72c7
ED
748{
749 if (sk_hashed(sk)) {
88ab1932 750 hlist_nulls_del_init_rcu(&sk->sk_nulls_node);
dc6b9b78 751 return true;
271b72c7 752 }
dc6b9b78 753 return false;
271b72c7
ED
754}
755
dc6b9b78 756static inline bool sk_nulls_del_node_init_rcu(struct sock *sk)
271b72c7 757{
dc6b9b78 758 bool rc = __sk_nulls_del_node_init_rcu(sk);
271b72c7
ED
759
760 if (rc) {
761 /* paranoid for a while -acme */
41c6d650 762 WARN_ON(refcount_read(&sk->sk_refcnt) == 1);
271b72c7
ED
763 __sock_put(sk);
764 }
765 return rc;
766}
767
dc6b9b78 768static inline void __sk_add_node(struct sock *sk, struct hlist_head *list)
1da177e4
LT
769{
770 hlist_add_head(&sk->sk_node, list);
771}
772
dc6b9b78 773static inline void sk_add_node(struct sock *sk, struct hlist_head *list)
1da177e4
LT
774{
775 sock_hold(sk);
776 __sk_add_node(sk, list);
777}
778
dc6b9b78 779static inline void sk_add_node_rcu(struct sock *sk, struct hlist_head *list)
808f5114 780{
781 sock_hold(sk);
d296ba60
CG
782 if (IS_ENABLED(CONFIG_IPV6) && sk->sk_reuseport &&
783 sk->sk_family == AF_INET6)
784 hlist_add_tail_rcu(&sk->sk_node, list);
785 else
786 hlist_add_head_rcu(&sk->sk_node, list);
808f5114 787}
788
a4dc6a49
MC
789static inline void sk_add_node_tail_rcu(struct sock *sk, struct hlist_head *list)
790{
791 sock_hold(sk);
792 hlist_add_tail_rcu(&sk->sk_node, list);
793}
794
dc6b9b78 795static inline void __sk_nulls_add_node_rcu(struct sock *sk, struct hlist_nulls_head *list)
271b72c7 796{
d7efc6c1 797 hlist_nulls_add_head_rcu(&sk->sk_nulls_node, list);
271b72c7
ED
798}
799
8dbd76e7
ED
800static inline void __sk_nulls_add_node_tail_rcu(struct sock *sk, struct hlist_nulls_head *list)
801{
802 hlist_nulls_add_tail_rcu(&sk->sk_nulls_node, list);
803}
804
dc6b9b78 805static inline void sk_nulls_add_node_rcu(struct sock *sk, struct hlist_nulls_head *list)
271b72c7
ED
806{
807 sock_hold(sk);
88ab1932 808 __sk_nulls_add_node_rcu(sk, list);
271b72c7
ED
809}
810
dc6b9b78 811static inline void __sk_del_bind_node(struct sock *sk)
1da177e4
LT
812{
813 __hlist_del(&sk->sk_bind_node);
814}
815
dc6b9b78 816static inline void sk_add_bind_node(struct sock *sk,
1da177e4
LT
817 struct hlist_head *list)
818{
819 hlist_add_head(&sk->sk_bind_node, list);
820}
821
d5a42de8
JK
822static inline void __sk_del_bind2_node(struct sock *sk)
823{
824 __hlist_del(&sk->sk_bind2_node);
825}
826
827static inline void sk_add_bind2_node(struct sock *sk, struct hlist_head *list)
828{
829 hlist_add_head(&sk->sk_bind2_node, list);
830}
831
b67bfe0d
SL
832#define sk_for_each(__sk, list) \
833 hlist_for_each_entry(__sk, list, sk_node)
834#define sk_for_each_rcu(__sk, list) \
835 hlist_for_each_entry_rcu(__sk, list, sk_node)
88ab1932
ED
836#define sk_nulls_for_each(__sk, node, list) \
837 hlist_nulls_for_each_entry(__sk, node, list, sk_nulls_node)
838#define sk_nulls_for_each_rcu(__sk, node, list) \
839 hlist_nulls_for_each_entry_rcu(__sk, node, list, sk_nulls_node)
b67bfe0d
SL
840#define sk_for_each_from(__sk) \
841 hlist_for_each_entry_from(__sk, sk_node)
88ab1932
ED
842#define sk_nulls_for_each_from(__sk, node) \
843 if (__sk && ({ node = &(__sk)->sk_nulls_node; 1; })) \
844 hlist_nulls_for_each_entry_from(__sk, node, sk_nulls_node)
b67bfe0d
SL
845#define sk_for_each_safe(__sk, tmp, list) \
846 hlist_for_each_entry_safe(__sk, tmp, list, sk_node)
847#define sk_for_each_bound(__sk, list) \
848 hlist_for_each_entry(__sk, list, sk_bind_node)
d5a42de8
JK
849#define sk_for_each_bound_bhash2(__sk, list) \
850 hlist_for_each_entry(__sk, list, sk_bind2_node)
1da177e4 851
2dc41cff 852/**
ca065d0c 853 * sk_for_each_entry_offset_rcu - iterate over a list at a given struct offset
2dc41cff
DH
854 * @tpos: the type * to use as a loop cursor.
855 * @pos: the &struct hlist_node to use as a loop cursor.
856 * @head: the head for your list.
857 * @offset: offset of hlist_node within the struct.
858 *
859 */
ca065d0c 860#define sk_for_each_entry_offset_rcu(tpos, pos, head, offset) \
b6f4f848 861 for (pos = rcu_dereference(hlist_first_rcu(head)); \
ca065d0c 862 pos != NULL && \
2dc41cff 863 ({ tpos = (typeof(*tpos) *)((void *)pos - offset); 1;}); \
b6f4f848 864 pos = rcu_dereference(hlist_next_rcu(pos)))
2dc41cff 865
a84a434b 866static inline struct user_namespace *sk_user_ns(const struct sock *sk)
c336d148
EB
867{
868 /* Careful only use this in a context where these parameters
869 * can not change and must all be valid, such as recvmsg from
870 * userspace.
871 */
872 return sk->sk_socket->file->f_cred->user_ns;
873}
874
1da177e4
LT
875/* Sock flags */
876enum sock_flags {
877 SOCK_DEAD,
878 SOCK_DONE,
879 SOCK_URGINLINE,
880 SOCK_KEEPOPEN,
881 SOCK_LINGER,
882 SOCK_DESTROY,
883 SOCK_BROADCAST,
884 SOCK_TIMESTAMP,
885 SOCK_ZAPPED,
886 SOCK_USE_WRITE_QUEUE, /* whether to call sk->sk_write_space in sock_wfree */
887 SOCK_DBG, /* %SO_DEBUG setting */
888 SOCK_RCVTSTAMP, /* %SO_TIMESTAMP setting */
92f37fd2 889 SOCK_RCVTSTAMPNS, /* %SO_TIMESTAMPNS setting */
1da177e4 890 SOCK_LOCALROUTE, /* route locally only, %SO_DONTROUTE setting */
7cb02404 891 SOCK_MEMALLOC, /* VM depends on this socket for swapping */
20d49473 892 SOCK_TIMESTAMPING_RX_SOFTWARE, /* %SOF_TIMESTAMPING_RX_SOFTWARE */
bcdce719 893 SOCK_FASYNC, /* fasync() active */
3b885787 894 SOCK_RXQ_OVFL,
1cdebb42 895 SOCK_ZEROCOPY, /* buffers from userspace */
6e3e939f 896 SOCK_WIFI_STATUS, /* push wifi status to userspace */
3bdc0eba
BG
897 SOCK_NOFCS, /* Tell NIC not to do the Ethernet FCS.
898 * Will use last 4 bytes of packet sent from
899 * user-space instead.
900 */
d59577b6 901 SOCK_FILTER_LOCKED, /* Filter cannot be changed anymore */
7d4c04fc 902 SOCK_SELECT_ERR_QUEUE, /* Wake select on error queue */
a4298e45 903 SOCK_RCU_FREE, /* wait rcu grace period in sk_destruct() */
80b14dee 904 SOCK_TXTIME,
e4a2a304 905 SOCK_XDP, /* XDP is attached */
887feae3 906 SOCK_TSTAMP_NEW, /* Indicates 64 bit timestamps always */
6fd1d51c 907 SOCK_RCVMARK, /* Receive SO_MARK ancillary data with packet */
1da177e4
LT
908};
909
01ce63c9
MRL
910#define SK_FLAGS_TIMESTAMP ((1UL << SOCK_TIMESTAMP) | (1UL << SOCK_TIMESTAMPING_RX_SOFTWARE))
911
a84a434b 912static inline void sock_copy_flags(struct sock *nsk, const struct sock *osk)
53b924b3
RB
913{
914 nsk->sk_flags = osk->sk_flags;
915}
916
1da177e4
LT
917static inline void sock_set_flag(struct sock *sk, enum sock_flags flag)
918{
919 __set_bit(flag, &sk->sk_flags);
920}
921
922static inline void sock_reset_flag(struct sock *sk, enum sock_flags flag)
923{
924 __clear_bit(flag, &sk->sk_flags);
925}
926
dfde1d7d
DY
927static inline void sock_valbool_flag(struct sock *sk, enum sock_flags bit,
928 int valbool)
929{
930 if (valbool)
931 sock_set_flag(sk, bit);
932 else
933 sock_reset_flag(sk, bit);
934}
935
1b23a5df 936static inline bool sock_flag(const struct sock *sk, enum sock_flags flag)
1da177e4
LT
937{
938 return test_bit(flag, &sk->sk_flags);
939}
940
c93bdd0e 941#ifdef CONFIG_NET
a7950ae8 942DECLARE_STATIC_KEY_FALSE(memalloc_socks_key);
c93bdd0e
MG
943static inline int sk_memalloc_socks(void)
944{
a7950ae8 945 return static_branch_unlikely(&memalloc_socks_key);
c93bdd0e 946}
d9539752
KC
947
948void __receive_sock(struct file *file);
c93bdd0e
MG
949#else
950
951static inline int sk_memalloc_socks(void)
952{
953 return 0;
954}
955
d9539752
KC
956static inline void __receive_sock(struct file *file)
957{ }
c93bdd0e
MG
958#endif
959
7450aaf6 960static inline gfp_t sk_gfp_mask(const struct sock *sk, gfp_t gfp_mask)
99a1dec7 961{
7450aaf6 962 return gfp_mask | (sk->sk_allocation & __GFP_MEMALLOC);
99a1dec7
MG
963}
964
1da177e4
LT
965static inline void sk_acceptq_removed(struct sock *sk)
966{
288efe86 967 WRITE_ONCE(sk->sk_ack_backlog, sk->sk_ack_backlog - 1);
1da177e4
LT
968}
969
970static inline void sk_acceptq_added(struct sock *sk)
971{
288efe86 972 WRITE_ONCE(sk->sk_ack_backlog, sk->sk_ack_backlog + 1);
1da177e4
LT
973}
974
c609e6aa
ED
975/* Note: If you think the test should be:
976 * return READ_ONCE(sk->sk_ack_backlog) >= READ_ONCE(sk->sk_max_ack_backlog);
977 * Then please take a look at commit 64a146513f8f ("[NET]: Revert incorrect accept queue backlog changes.")
978 */
dc6b9b78 979static inline bool sk_acceptq_is_full(const struct sock *sk)
1da177e4 980{
c609e6aa 981 return READ_ONCE(sk->sk_ack_backlog) > READ_ONCE(sk->sk_max_ack_backlog);
1da177e4
LT
982}
983
984/*
985 * Compute minimal free write space needed to queue new packets.
986 */
dc6b9b78 987static inline int sk_stream_min_wspace(const struct sock *sk)
1da177e4 988{
ab4e846a 989 return READ_ONCE(sk->sk_wmem_queued) >> 1;
1da177e4
LT
990}
991
dc6b9b78 992static inline int sk_stream_wspace(const struct sock *sk)
1da177e4 993{
ab4e846a
ED
994 return READ_ONCE(sk->sk_sndbuf) - READ_ONCE(sk->sk_wmem_queued);
995}
996
997static inline void sk_wmem_queued_add(struct sock *sk, int val)
998{
999 WRITE_ONCE(sk->sk_wmem_queued, sk->sk_wmem_queued + val);
1da177e4
LT
1000}
1001
69336bd2 1002void sk_stream_write_space(struct sock *sk);
1da177e4 1003
8eae939f 1004/* OOB backlog add */
a3a858ff 1005static inline void __sk_add_backlog(struct sock *sk, struct sk_buff *skb)
9ee6b535 1006{
7fee226a 1007 /* dont let skb dst not refcounted, we are going to leave rcu lock */
222d7dbd 1008 skb_dst_force(skb);
7fee226a
ED
1009
1010 if (!sk->sk_backlog.tail)
9ed498c6 1011 WRITE_ONCE(sk->sk_backlog.head, skb);
7fee226a 1012 else
9ee6b535 1013 sk->sk_backlog.tail->next = skb;
7fee226a 1014
9ed498c6 1015 WRITE_ONCE(sk->sk_backlog.tail, skb);
9ee6b535
SH
1016 skb->next = NULL;
1017}
1da177e4 1018
c377411f
ED
1019/*
1020 * Take into account size of receive queue and backlog queue
0fd7bac6
ED
1021 * Do not take into account this skb truesize,
1022 * to allow even a single big packet to come.
c377411f 1023 */
274f482d 1024static inline bool sk_rcvqueues_full(const struct sock *sk, unsigned int limit)
c377411f
ED
1025{
1026 unsigned int qsize = sk->sk_backlog.len + atomic_read(&sk->sk_rmem_alloc);
1027
f545a38f 1028 return qsize > limit;
c377411f
ED
1029}
1030
8eae939f 1031/* The per-socket spinlock must be held here. */
f545a38f
ED
1032static inline __must_check int sk_add_backlog(struct sock *sk, struct sk_buff *skb,
1033 unsigned int limit)
8eae939f 1034{
274f482d 1035 if (sk_rcvqueues_full(sk, limit))
8eae939f
ZY
1036 return -ENOBUFS;
1037
c7c49b8f
ED
1038 /*
1039 * If the skb was allocated from pfmemalloc reserves, only
1040 * allow SOCK_MEMALLOC sockets to use it as this socket is
1041 * helping free memory
1042 */
1043 if (skb_pfmemalloc(skb) && !sock_flag(sk, SOCK_MEMALLOC))
1044 return -ENOMEM;
1045
a3a858ff 1046 __sk_add_backlog(sk, skb);
8eae939f
ZY
1047 sk->sk_backlog.len += skb->truesize;
1048 return 0;
1049}
1050
69336bd2 1051int __sk_backlog_rcv(struct sock *sk, struct sk_buff *skb);
b4b9e355 1052
d2489c7b
ED
1053INDIRECT_CALLABLE_DECLARE(int tcp_v4_do_rcv(struct sock *sk, struct sk_buff *skb));
1054INDIRECT_CALLABLE_DECLARE(int tcp_v6_do_rcv(struct sock *sk, struct sk_buff *skb));
1055
c57943a1
PZ
1056static inline int sk_backlog_rcv(struct sock *sk, struct sk_buff *skb)
1057{
b4b9e355
MG
1058 if (sk_memalloc_socks() && skb_pfmemalloc(skb))
1059 return __sk_backlog_rcv(sk, skb);
1060
d2489c7b
ED
1061 return INDIRECT_CALL_INET(sk->sk_backlog_rcv,
1062 tcp_v6_do_rcv,
1063 tcp_v4_do_rcv,
1064 sk, skb);
c57943a1
PZ
1065}
1066
2c8c56e1
ED
1067static inline void sk_incoming_cpu_update(struct sock *sk)
1068{
34cfb542
PA
1069 int cpu = raw_smp_processor_id();
1070
7170a977
ED
1071 if (unlikely(READ_ONCE(sk->sk_incoming_cpu) != cpu))
1072 WRITE_ONCE(sk->sk_incoming_cpu, cpu);
2c8c56e1
ED
1073}
1074
fe477558 1075static inline void sock_rps_record_flow_hash(__u32 hash)
c58dc01b
DM
1076{
1077#ifdef CONFIG_RPS
1078 struct rps_sock_flow_table *sock_flow_table;
1079
1080 rcu_read_lock();
1081 sock_flow_table = rcu_dereference(rps_sock_flow_table);
fe477558 1082 rps_record_sock_flow(sock_flow_table, hash);
c58dc01b
DM
1083 rcu_read_unlock();
1084#endif
1085}
1086
fe477558
TH
1087static inline void sock_rps_record_flow(const struct sock *sk)
1088{
c9d8ca04 1089#ifdef CONFIG_RPS
dc05360f 1090 if (static_branch_unlikely(&rfs_needed)) {
13bfff25
ED
1091 /* Reading sk->sk_rxhash might incur an expensive cache line
1092 * miss.
1093 *
1094 * TCP_ESTABLISHED does cover almost all states where RFS
1095 * might be useful, and is cheaper [1] than testing :
1096 * IPv4: inet_sk(sk)->inet_daddr
1097 * IPv6: ipv6_addr_any(&sk->sk_v6_daddr)
1098 * OR an additional socket flag
1099 * [1] : sk_state and sk_prot are in the same cache line.
1100 */
1101 if (sk->sk_state == TCP_ESTABLISHED)
1102 sock_rps_record_flow_hash(sk->sk_rxhash);
1103 }
c9d8ca04 1104#endif
fe477558
TH
1105}
1106
bdeab991
TH
1107static inline void sock_rps_save_rxhash(struct sock *sk,
1108 const struct sk_buff *skb)
c58dc01b
DM
1109{
1110#ifdef CONFIG_RPS
567e4b79 1111 if (unlikely(sk->sk_rxhash != skb->hash))
61b905da 1112 sk->sk_rxhash = skb->hash;
c58dc01b
DM
1113#endif
1114}
1115
bdeab991
TH
1116static inline void sock_rps_reset_rxhash(struct sock *sk)
1117{
1118#ifdef CONFIG_RPS
bdeab991
TH
1119 sk->sk_rxhash = 0;
1120#endif
1121}
1122
d9dc8b0f 1123#define sk_wait_event(__sk, __timeo, __condition, __wait) \
cfcabdcc
SH
1124 ({ int __rc; \
1125 release_sock(__sk); \
1126 __rc = __condition; \
1127 if (!__rc) { \
d9dc8b0f
WC
1128 *(__timeo) = wait_woken(__wait, \
1129 TASK_INTERRUPTIBLE, \
1130 *(__timeo)); \
cfcabdcc 1131 } \
d9dc8b0f 1132 sched_annotate_sleep(); \
cfcabdcc
SH
1133 lock_sock(__sk); \
1134 __rc = __condition; \
1135 __rc; \
1136 })
1da177e4 1137
69336bd2
JP
1138int sk_stream_wait_connect(struct sock *sk, long *timeo_p);
1139int sk_stream_wait_memory(struct sock *sk, long *timeo_p);
1140void sk_stream_wait_close(struct sock *sk, long timeo_p);
1141int sk_stream_error(struct sock *sk, int flags, int err);
1142void sk_stream_kill_queues(struct sock *sk);
1143void sk_set_memalloc(struct sock *sk);
1144void sk_clear_memalloc(struct sock *sk);
1da177e4 1145
d41a69f1
ED
1146void __sk_flush_backlog(struct sock *sk);
1147
1148static inline bool sk_flush_backlog(struct sock *sk)
1149{
1150 if (unlikely(READ_ONCE(sk->sk_backlog.tail))) {
1151 __sk_flush_backlog(sk);
1152 return true;
1153 }
1154 return false;
1155}
1156
dfbafc99 1157int sk_wait_data(struct sock *sk, long *timeo, const struct sk_buff *skb);
1da177e4 1158
60236fdd 1159struct request_sock_ops;
6d6ee43e 1160struct timewait_sock_ops;
ab1e0a13 1161struct inet_hashinfo;
fc8717ba 1162struct raw_hashinfo;
f16a7dd5 1163struct smc_hashinfo;
de477254 1164struct module;
51e0158a 1165struct sk_psock;
2e6599cb 1166
f77d6021 1167/*
5f0d5a3a 1168 * caches using SLAB_TYPESAFE_BY_RCU should let .next pointer from nulls nodes
f77d6021
ED
1169 * un-modified. Special care is taken when initializing object to zero.
1170 */
1171static inline void sk_prot_clear_nulls(struct sock *sk, int size)
1172{
1173 if (offsetof(struct sock, sk_node.next) != 0)
1174 memset(sk, 0, offsetof(struct sock, sk_node.next));
1175 memset(&sk->sk_node.pprev, 0,
1176 size - offsetof(struct sock, sk_node.pprev));
1177}
1178
1da177e4
LT
1179/* Networking protocol blocks we attach to sockets.
1180 * socket layer -> transport layer interface
1da177e4
LT
1181 */
1182struct proto {
dc6b9b78 1183 void (*close)(struct sock *sk,
1da177e4 1184 long timeout);
d74bad4e
AI
1185 int (*pre_connect)(struct sock *sk,
1186 struct sockaddr *uaddr,
1187 int addr_len);
1da177e4 1188 int (*connect)(struct sock *sk,
dc6b9b78 1189 struct sockaddr *uaddr,
1da177e4
LT
1190 int addr_len);
1191 int (*disconnect)(struct sock *sk, int flags);
1192
cdfbabfb
DH
1193 struct sock * (*accept)(struct sock *sk, int flags, int *err,
1194 bool kern);
1da177e4
LT
1195
1196 int (*ioctl)(struct sock *sk, int cmd,
1197 unsigned long arg);
1198 int (*init)(struct sock *sk);
7d06b2e0 1199 void (*destroy)(struct sock *sk);
1da177e4 1200 void (*shutdown)(struct sock *sk, int how);
dc6b9b78 1201 int (*setsockopt)(struct sock *sk, int level,
a7b75c5a 1202 int optname, sockptr_t optval,
b7058842 1203 unsigned int optlen);
dc6b9b78
ED
1204 int (*getsockopt)(struct sock *sk, int level,
1205 int optname, char __user *optval,
1206 int __user *option);
4b9d07a4 1207 void (*keepalive)(struct sock *sk, int valbool);
af01d537 1208#ifdef CONFIG_COMPAT
709b46e8
EB
1209 int (*compat_ioctl)(struct sock *sk,
1210 unsigned int cmd, unsigned long arg);
af01d537 1211#endif
1b784140
YX
1212 int (*sendmsg)(struct sock *sk, struct msghdr *msg,
1213 size_t len);
1214 int (*recvmsg)(struct sock *sk, struct msghdr *msg,
ec095263 1215 size_t len, int flags, int *addr_len);
1da177e4
LT
1216 int (*sendpage)(struct sock *sk, struct page *page,
1217 int offset, size_t size, int flags);
dc6b9b78 1218 int (*bind)(struct sock *sk,
c0425a42
CH
1219 struct sockaddr *addr, int addr_len);
1220 int (*bind_add)(struct sock *sk,
1221 struct sockaddr *addr, int addr_len);
1da177e4 1222
dc6b9b78 1223 int (*backlog_rcv) (struct sock *sk,
1da177e4 1224 struct sk_buff *skb);
9cacf81f
SF
1225 bool (*bpf_bypass_getsockopt)(int level,
1226 int optname);
1da177e4 1227
46d3ceab
ED
1228 void (*release_cb)(struct sock *sk);
1229
1da177e4 1230 /* Keeping track of sk's, looking them up, and port selection methods. */
086c653f 1231 int (*hash)(struct sock *sk);
1da177e4 1232 void (*unhash)(struct sock *sk);
719f8358 1233 void (*rehash)(struct sock *sk);
1da177e4 1234 int (*get_port)(struct sock *sk, unsigned short snum);
91a760b2 1235 void (*put_port)(struct sock *sk);
8a59f9d1 1236#ifdef CONFIG_BPF_SYSCALL
51e0158a
CW
1237 int (*psock_update_sk_prot)(struct sock *sk,
1238 struct sk_psock *psock,
1239 bool restore);
8a59f9d1 1240#endif
1da177e4 1241
286ab3d4 1242 /* Keeping track of sockets in use */
65f76517 1243#ifdef CONFIG_PROC_FS
13ff3d6f 1244 unsigned int inuse_idx;
65f76517 1245#endif
ebb53d75 1246
6c302e79 1247#if IS_ENABLED(CONFIG_MPTCP)
292e6077 1248 int (*forward_alloc_get)(const struct sock *sk);
6c302e79 1249#endif
292e6077 1250
a74f0fa0 1251 bool (*stream_memory_free)(const struct sock *sk, int wake);
7b50ecfc 1252 bool (*sock_is_readable)(struct sock *sk);
1da177e4 1253 /* Memory pressure */
5c52ba17 1254 void (*enter_memory_pressure)(struct sock *sk);
06044751 1255 void (*leave_memory_pressure)(struct sock *sk);
8d987e5c 1256 atomic_long_t *memory_allocated; /* Current allocated memory. */
1748376b 1257 struct percpu_counter *sockets_allocated; /* Current number of sockets. */
292e6077 1258
1da177e4
LT
1259 /*
1260 * Pressure flag: try to collapse.
1261 * Technical note: it is used by multiple contexts non atomically.
3ab224be 1262 * All the __sk_mem_schedule() is of this nature: accounting
1da177e4
LT
1263 * is strict, actions are advisory and have some latency.
1264 */
06044751 1265 unsigned long *memory_pressure;
8d987e5c 1266 long *sysctl_mem;
a3dcaf17 1267
1da177e4
LT
1268 int *sysctl_wmem;
1269 int *sysctl_rmem;
a3dcaf17
ED
1270 u32 sysctl_wmem_offset;
1271 u32 sysctl_rmem_offset;
1272
1da177e4 1273 int max_header;
7ba42910 1274 bool no_autobind;
1da177e4 1275
271b72c7 1276 struct kmem_cache *slab;
1da177e4 1277 unsigned int obj_size;
d50112ed 1278 slab_flags_t slab_flags;
7bbdb81e
AD
1279 unsigned int useroffset; /* Usercopy region offset */
1280 unsigned int usersize; /* Usercopy region size */
1da177e4 1281
19757ceb 1282 unsigned int __percpu *orphan_count;
8feaf0c0 1283
60236fdd 1284 struct request_sock_ops *rsk_prot;
6d6ee43e 1285 struct timewait_sock_ops *twsk_prot;
2e6599cb 1286
39d8cda7
PE
1287 union {
1288 struct inet_hashinfo *hashinfo;
645ca708 1289 struct udp_table *udp_table;
fc8717ba 1290 struct raw_hashinfo *raw_hash;
f16a7dd5 1291 struct smc_hashinfo *smc_hash;
39d8cda7 1292 } h;
ab1e0a13 1293
1da177e4
LT
1294 struct module *owner;
1295
1296 char name[32];
1297
1298 struct list_head node;
e6848976
ACM
1299#ifdef SOCK_REFCNT_DEBUG
1300 atomic_t socks;
e1aab161 1301#endif
64be0aed 1302 int (*diag_destroy)(struct sock *sk, int err);
3859a271 1303} __randomize_layout;
e1aab161 1304
69336bd2
JP
1305int proto_register(struct proto *prot, int alloc_slab);
1306void proto_unregister(struct proto *prot);
bf2ae2e4 1307int sock_load_diag_module(int family, int protocol);
1da177e4 1308
e6848976
ACM
1309#ifdef SOCK_REFCNT_DEBUG
1310static inline void sk_refcnt_debug_inc(struct sock *sk)
1311{
1312 atomic_inc(&sk->sk_prot->socks);
1313}
1314
1315static inline void sk_refcnt_debug_dec(struct sock *sk)
1316{
1317 atomic_dec(&sk->sk_prot->socks);
1318 printk(KERN_DEBUG "%s socket %p released, %d are still alive\n",
1319 sk->sk_prot->name, sk, atomic_read(&sk->sk_prot->socks));
1320}
1321
dec34fb0 1322static inline void sk_refcnt_debug_release(const struct sock *sk)
e6848976 1323{
41c6d650 1324 if (refcount_read(&sk->sk_refcnt) != 1)
e6848976 1325 printk(KERN_DEBUG "Destruction of the %s socket %p delayed, refcnt=%d\n",
41c6d650 1326 sk->sk_prot->name, sk, refcount_read(&sk->sk_refcnt));
e6848976
ACM
1327}
1328#else /* SOCK_REFCNT_DEBUG */
1329#define sk_refcnt_debug_inc(sk) do { } while (0)
1330#define sk_refcnt_debug_dec(sk) do { } while (0)
1331#define sk_refcnt_debug_release(sk) do { } while (0)
1332#endif /* SOCK_REFCNT_DEBUG */
1333
1c5f2ced
ED
1334INDIRECT_CALLABLE_DECLARE(bool tcp_stream_memory_free(const struct sock *sk, int wake));
1335
292e6077
PA
1336static inline int sk_forward_alloc_get(const struct sock *sk)
1337{
6c302e79
ED
1338#if IS_ENABLED(CONFIG_MPTCP)
1339 if (sk->sk_prot->forward_alloc_get)
1340 return sk->sk_prot->forward_alloc_get(sk);
1341#endif
1342 return sk->sk_forward_alloc;
292e6077
PA
1343}
1344
a74f0fa0 1345static inline bool __sk_stream_memory_free(const struct sock *sk, int wake)
c9bee3b7 1346{
ab4e846a 1347 if (READ_ONCE(sk->sk_wmem_queued) >= READ_ONCE(sk->sk_sndbuf))
c9bee3b7
ED
1348 return false;
1349
1350 return sk->sk_prot->stream_memory_free ?
a406290a
ED
1351 INDIRECT_CALL_INET_1(sk->sk_prot->stream_memory_free,
1352 tcp_stream_memory_free, sk, wake) : true;
c9bee3b7
ED
1353}
1354
a74f0fa0
ED
1355static inline bool sk_stream_memory_free(const struct sock *sk)
1356{
1357 return __sk_stream_memory_free(sk, 0);
1358}
1359
1360static inline bool __sk_stream_is_writeable(const struct sock *sk, int wake)
64dc6130 1361{
c9bee3b7 1362 return sk_stream_wspace(sk) >= sk_stream_min_wspace(sk) &&
a74f0fa0
ED
1363 __sk_stream_memory_free(sk, wake);
1364}
1365
1366static inline bool sk_stream_is_writeable(const struct sock *sk)
1367{
1368 return __sk_stream_is_writeable(sk, 0);
64dc6130 1369}
e1aab161 1370
54fd9c2d
DB
1371static inline int sk_under_cgroup_hierarchy(struct sock *sk,
1372 struct cgroup *ancestor)
1373{
1374#ifdef CONFIG_SOCK_CGROUP_DATA
1375 return cgroup_is_descendant(sock_cgroup_ptr(&sk->sk_cgrp_data),
1376 ancestor);
1377#else
1378 return -ENOTSUPP;
1379#endif
1380}
c9bee3b7 1381
180d8cd9
GC
1382static inline bool sk_has_memory_pressure(const struct sock *sk)
1383{
1384 return sk->sk_prot->memory_pressure != NULL;
1385}
1386
1387static inline bool sk_under_memory_pressure(const struct sock *sk)
1388{
1389 if (!sk->sk_prot->memory_pressure)
1390 return false;
e1aab161 1391
baac50bb
JW
1392 if (mem_cgroup_sockets_enabled && sk->sk_memcg &&
1393 mem_cgroup_under_socket_pressure(sk->sk_memcg))
e805605c 1394 return true;
e1aab161 1395
35b87f6c 1396 return !!*sk->sk_prot->memory_pressure;
180d8cd9
GC
1397}
1398
180d8cd9
GC
1399static inline long
1400sk_memory_allocated(const struct sock *sk)
1401{
e805605c 1402 return atomic_long_read(sk->sk_prot->memory_allocated);
180d8cd9
GC
1403}
1404
1405static inline long
e805605c 1406sk_memory_allocated_add(struct sock *sk, int amt)
180d8cd9 1407{
e805605c 1408 return atomic_long_add_return(amt, sk->sk_prot->memory_allocated);
180d8cd9
GC
1409}
1410
1411static inline void
0e90b31f 1412sk_memory_allocated_sub(struct sock *sk, int amt)
180d8cd9 1413{
e805605c 1414 atomic_long_sub(amt, sk->sk_prot->memory_allocated);
180d8cd9
GC
1415}
1416
f5a5589c
WW
1417#define SK_ALLOC_PERCPU_COUNTER_BATCH 16
1418
180d8cd9
GC
1419static inline void sk_sockets_allocated_dec(struct sock *sk)
1420{
f5a5589c
WW
1421 percpu_counter_add_batch(sk->sk_prot->sockets_allocated, -1,
1422 SK_ALLOC_PERCPU_COUNTER_BATCH);
180d8cd9
GC
1423}
1424
1425static inline void sk_sockets_allocated_inc(struct sock *sk)
1426{
f5a5589c
WW
1427 percpu_counter_add_batch(sk->sk_prot->sockets_allocated, 1,
1428 SK_ALLOC_PERCPU_COUNTER_BATCH);
180d8cd9
GC
1429}
1430
5bf325a5 1431static inline u64
180d8cd9
GC
1432sk_sockets_allocated_read_positive(struct sock *sk)
1433{
af95d7df 1434 return percpu_counter_read_positive(sk->sk_prot->sockets_allocated);
180d8cd9
GC
1435}
1436
1437static inline int
1438proto_sockets_allocated_sum_positive(struct proto *prot)
1439{
1440 return percpu_counter_sum_positive(prot->sockets_allocated);
1441}
1442
1443static inline long
1444proto_memory_allocated(struct proto *prot)
1445{
1446 return atomic_long_read(prot->memory_allocated);
1447}
1448
1449static inline bool
1450proto_memory_pressure(struct proto *prot)
1451{
1452 if (!prot->memory_pressure)
1453 return false;
1454 return !!*prot->memory_pressure;
1455}
1456
65f76517
ED
1457
1458#ifdef CONFIG_PROC_FS
2a12ae5d
ED
1459#define PROTO_INUSE_NR 64 /* should be enough for the first time */
1460struct prot_inuse {
4199bae1 1461 int all;
2a12ae5d
ED
1462 int val[PROTO_INUSE_NR];
1463};
b3cb764a 1464
2a12ae5d
ED
1465static inline void sock_prot_inuse_add(const struct net *net,
1466 const struct proto *prot, int val)
1467{
b3cb764a 1468 this_cpu_add(net->core.prot_inuse->val[prot->inuse_idx], val);
2a12ae5d 1469}
d477eb90
ED
1470
1471static inline void sock_inuse_add(const struct net *net, int val)
1472{
4199bae1 1473 this_cpu_add(net->core.prot_inuse->all, val);
d477eb90
ED
1474}
1475
69336bd2 1476int sock_prot_inuse_get(struct net *net, struct proto *proto);
648845ab 1477int sock_inuse_get(struct net *net);
65f76517 1478#else
2a12ae5d
ED
1479static inline void sock_prot_inuse_add(const struct net *net,
1480 const struct proto *prot, int val)
65f76517
ED
1481{
1482}
d477eb90
ED
1483
1484static inline void sock_inuse_add(const struct net *net, int val)
1485{
1486}
65f76517
ED
1487#endif
1488
1da177e4 1489
614c6cb4
ACM
1490/* With per-bucket locks this operation is not-atomic, so that
1491 * this version is not worse.
1492 */
086c653f 1493static inline int __sk_prot_rehash(struct sock *sk)
614c6cb4
ACM
1494{
1495 sk->sk_prot->unhash(sk);
086c653f 1496 return sk->sk_prot->hash(sk);
614c6cb4
ACM
1497}
1498
1da177e4
LT
1499/* About 10 seconds */
1500#define SOCK_DESTROY_TIME (10*HZ)
1501
1502/* Sockets 0-1023 can't be bound to unless you are superuser */
1503#define PROT_SOCK 1024
1504
1505#define SHUTDOWN_MASK 3
1506#define RCV_SHUTDOWN 1
1507#define SEND_SHUTDOWN 2
1508
1da177e4
LT
1509#define SOCK_BINDADDR_LOCK 4
1510#define SOCK_BINDPORT_LOCK 8
1511
1da177e4
LT
1512struct socket_alloc {
1513 struct socket socket;
1514 struct inode vfs_inode;
1515};
1516
1517static inline struct socket *SOCKET_I(struct inode *inode)
1518{
1519 return &container_of(inode, struct socket_alloc, vfs_inode)->socket;
1520}
1521
1522static inline struct inode *SOCK_INODE(struct socket *socket)
1523{
1524 return &container_of(socket, struct socket_alloc, socket)->vfs_inode;
1525}
1526
3ab224be
HA
1527/*
1528 * Functions for memory accounting
1529 */
f8c3bf00 1530int __sk_mem_raise_allocated(struct sock *sk, int size, int amt, int kind);
69336bd2 1531int __sk_mem_schedule(struct sock *sk, int size, int kind);
f8c3bf00 1532void __sk_mem_reduce_allocated(struct sock *sk, int amount);
1a24e04e 1533void __sk_mem_reclaim(struct sock *sk, int amount);
1da177e4 1534
e70f3c70 1535#define SK_MEM_QUANTUM ((int)PAGE_SIZE)
3ab224be
HA
1536#define SK_MEM_QUANTUM_SHIFT ilog2(SK_MEM_QUANTUM)
1537#define SK_MEM_SEND 0
1538#define SK_MEM_RECV 1
1da177e4 1539
e70f3c70 1540/* sysctl_mem values are in pages */
bd68a2a8
ED
1541static inline long sk_prot_mem_limits(const struct sock *sk, int index)
1542{
e70f3c70 1543 return sk->sk_prot->sysctl_mem[index];
bd68a2a8
ED
1544}
1545
3ab224be 1546static inline int sk_mem_pages(int amt)
1da177e4 1547{
3ab224be 1548 return (amt + SK_MEM_QUANTUM - 1) >> SK_MEM_QUANTUM_SHIFT;
1da177e4
LT
1549}
1550
dc6b9b78 1551static inline bool sk_has_account(struct sock *sk)
1da177e4 1552{
3ab224be
HA
1553 /* return true if protocol supports memory accounting */
1554 return !!sk->sk_prot->memory_allocated;
1da177e4
LT
1555}
1556
dc6b9b78 1557static inline bool sk_wmem_schedule(struct sock *sk, int size)
1da177e4 1558{
3ab224be 1559 if (!sk_has_account(sk))
dc6b9b78 1560 return true;
3ab224be
HA
1561 return size <= sk->sk_forward_alloc ||
1562 __sk_mem_schedule(sk, size, SK_MEM_SEND);
1da177e4
LT
1563}
1564
c76562b6 1565static inline bool
35c448a8 1566sk_rmem_schedule(struct sock *sk, struct sk_buff *skb, int size)
d80d99d6 1567{
3ab224be 1568 if (!sk_has_account(sk))
dc6b9b78 1569 return true;
5af68891 1570 return size <= sk->sk_forward_alloc ||
c76562b6
MG
1571 __sk_mem_schedule(sk, size, SK_MEM_RECV) ||
1572 skb_pfmemalloc(skb);
3ab224be
HA
1573}
1574
2bb2f5fb
WW
1575static inline int sk_unused_reserved_mem(const struct sock *sk)
1576{
1577 int unused_mem;
1578
1579 if (likely(!sk->sk_reserved_mem))
1580 return 0;
1581
1582 unused_mem = sk->sk_reserved_mem - sk->sk_wmem_queued -
1583 atomic_read(&sk->sk_rmem_alloc);
1584
1585 return unused_mem > 0 ? unused_mem : 0;
1586}
1587
3ab224be
HA
1588static inline void sk_mem_reclaim(struct sock *sk)
1589{
2bb2f5fb
WW
1590 int reclaimable;
1591
3ab224be
HA
1592 if (!sk_has_account(sk))
1593 return;
2bb2f5fb
WW
1594
1595 reclaimable = sk->sk_forward_alloc - sk_unused_reserved_mem(sk);
1596
1597 if (reclaimable >= SK_MEM_QUANTUM)
1598 __sk_mem_reclaim(sk, reclaimable);
1599}
1600
1601static inline void sk_mem_reclaim_final(struct sock *sk)
1602{
1603 sk->sk_reserved_mem = 0;
1604 sk_mem_reclaim(sk);
3ab224be
HA
1605}
1606
9993e7d3
DM
1607static inline void sk_mem_reclaim_partial(struct sock *sk)
1608{
2bb2f5fb
WW
1609 int reclaimable;
1610
9993e7d3
DM
1611 if (!sk_has_account(sk))
1612 return;
2bb2f5fb
WW
1613
1614 reclaimable = sk->sk_forward_alloc - sk_unused_reserved_mem(sk);
1615
1616 if (reclaimable > SK_MEM_QUANTUM)
1617 __sk_mem_reclaim(sk, reclaimable - 1);
9993e7d3
DM
1618}
1619
3ab224be
HA
1620static inline void sk_mem_charge(struct sock *sk, int size)
1621{
1622 if (!sk_has_account(sk))
1623 return;
1624 sk->sk_forward_alloc -= size;
1625}
1626
5823fc96
PA
1627/* the following macros control memory reclaiming in sk_mem_uncharge()
1628 */
1629#define SK_RECLAIM_THRESHOLD (1 << 21)
1630#define SK_RECLAIM_CHUNK (1 << 20)
1631
3ab224be
HA
1632static inline void sk_mem_uncharge(struct sock *sk, int size)
1633{
2bb2f5fb
WW
1634 int reclaimable;
1635
3ab224be
HA
1636 if (!sk_has_account(sk))
1637 return;
1638 sk->sk_forward_alloc += size;
2bb2f5fb 1639 reclaimable = sk->sk_forward_alloc - sk_unused_reserved_mem(sk);
20c64d5c
ED
1640
1641 /* Avoid a possible overflow.
1642 * TCP send queues can make this happen, if sk_mem_reclaim()
1643 * is not called and more than 2 GBytes are released at once.
1644 *
1645 * If we reach 2 MBytes, reclaim 1 MBytes right now, there is
1646 * no need to hold that much forward allocation anyway.
1647 */
5823fc96
PA
1648 if (unlikely(reclaimable >= SK_RECLAIM_THRESHOLD))
1649 __sk_mem_reclaim(sk, SK_RECLAIM_CHUNK);
3ab224be
HA
1650}
1651
ed07536e
PZ
1652/*
1653 * Macro so as to not evaluate some arguments when
1654 * lockdep is not enabled.
1655 *
1656 * Mark both the sk_lock and the sk_lock.slock as a
1657 * per-address-family lock class.
1658 */
dc6b9b78 1659#define sock_lock_init_class_and_name(sk, sname, skey, name, key) \
ed07536e 1660do { \
e8f6fbf6 1661 sk->sk_lock.owned = 0; \
ed07536e
PZ
1662 init_waitqueue_head(&sk->sk_lock.wq); \
1663 spin_lock_init(&(sk)->sk_lock.slock); \
1664 debug_check_no_locks_freed((void *)&(sk)->sk_lock, \
1665 sizeof((sk)->sk_lock)); \
1666 lockdep_set_class_and_name(&(sk)->sk_lock.slock, \
dc6b9b78 1667 (skey), (sname)); \
ed07536e
PZ
1668 lockdep_init_map(&(sk)->sk_lock.dep_map, (name), (key), 0); \
1669} while (0)
1670
05b93801 1671static inline bool lockdep_sock_is_held(const struct sock *sk)
1e1d04e6 1672{
1e1d04e6
HFS
1673 return lockdep_is_held(&sk->sk_lock) ||
1674 lockdep_is_held(&sk->sk_lock.slock);
1675}
1676
69336bd2 1677void lock_sock_nested(struct sock *sk, int subclass);
fcc70d5f
PZ
1678
1679static inline void lock_sock(struct sock *sk)
1680{
1681 lock_sock_nested(sk, 0);
1682}
1683
ad80b0fc 1684void __lock_sock(struct sock *sk);
8873c064 1685void __release_sock(struct sock *sk);
69336bd2 1686void release_sock(struct sock *sk);
1da177e4
LT
1687
1688/* BH context may only use the following locking interface. */
1689#define bh_lock_sock(__sk) spin_lock(&((__sk)->sk_lock.slock))
c6366184
IM
1690#define bh_lock_sock_nested(__sk) \
1691 spin_lock_nested(&((__sk)->sk_lock.slock), \
1692 SINGLE_DEPTH_NESTING)
1da177e4
LT
1693#define bh_unlock_sock(__sk) spin_unlock(&((__sk)->sk_lock.slock))
1694
49054556
PA
1695bool __lock_sock_fast(struct sock *sk) __acquires(&sk->sk_lock.slock);
1696
1697/**
1698 * lock_sock_fast - fast version of lock_sock
1699 * @sk: socket
1700 *
1701 * This version should be used for very small section, where process wont block
1702 * return false if fast path is taken:
1703 *
1704 * sk_lock.slock locked, owned = 0, BH disabled
1705 *
1706 * return true if slow path is taken:
1707 *
1708 * sk_lock.slock unlocked, owned = 1, BH enabled
1709 */
1710static inline bool lock_sock_fast(struct sock *sk)
1711{
1712 /* The sk_lock has mutex_lock() semantics here. */
1713 mutex_acquire(&sk->sk_lock.dep_map, 0, 0, _RET_IP_);
1714
1715 return __lock_sock_fast(sk);
1716}
1717
1718/* fast socket lock variant for caller already holding a [different] socket lock */
1719static inline bool lock_sock_fast_nested(struct sock *sk)
1720{
1721 mutex_acquire(&sk->sk_lock.dep_map, SINGLE_DEPTH_NESTING, 0, _RET_IP_);
1722
1723 return __lock_sock_fast(sk);
1724}
12f4bd86 1725
8a74ad60
ED
1726/**
1727 * unlock_sock_fast - complement of lock_sock_fast
1728 * @sk: socket
1729 * @slow: slow mode
1730 *
1731 * fast unlock socket for user context.
1732 * If slow mode is on, we call regular release_sock()
1733 */
1734static inline void unlock_sock_fast(struct sock *sk, bool slow)
12f4bd86 1735 __releases(&sk->sk_lock.slock)
4b0b72f7 1736{
12f4bd86 1737 if (slow) {
8a74ad60 1738 release_sock(sk);
12f4bd86
PA
1739 __release(&sk->sk_lock.slock);
1740 } else {
2dcb96ba 1741 mutex_release(&sk->sk_lock.dep_map, _RET_IP_);
8a74ad60 1742 spin_unlock_bh(&sk->sk_lock.slock);
12f4bd86 1743 }
4b0b72f7
ED
1744}
1745
fafc4e1e
HFS
1746/* Used by processes to "lock" a socket state, so that
1747 * interrupts and bottom half handlers won't change it
1748 * from under us. It essentially blocks any incoming
1749 * packets, so that we won't get any new data or any
1750 * packets that change the state of the socket.
1751 *
1752 * While locked, BH processing will add new packets to
1753 * the backlog queue. This queue is processed by the
1754 * owner of the socket lock right before it is released.
1755 *
1756 * Since ~2.3.5 it is also exclusive sleep lock serializing
1757 * accesses from user process context.
1758 */
1759
46cc6e49 1760static inline void sock_owned_by_me(const struct sock *sk)
fafc4e1e
HFS
1761{
1762#ifdef CONFIG_LOCKDEP
5e91f6ce 1763 WARN_ON_ONCE(!lockdep_sock_is_held(sk) && debug_locks);
fafc4e1e 1764#endif
46cc6e49
ED
1765}
1766
1767static inline bool sock_owned_by_user(const struct sock *sk)
1768{
1769 sock_owned_by_me(sk);
fafc4e1e
HFS
1770 return sk->sk_lock.owned;
1771}
1772
602f7a27
TH
1773static inline bool sock_owned_by_user_nocheck(const struct sock *sk)
1774{
1775 return sk->sk_lock.owned;
1776}
1777
33d60fbd
KI
1778static inline void sock_release_ownership(struct sock *sk)
1779{
1780 if (sock_owned_by_user_nocheck(sk)) {
1781 sk->sk_lock.owned = 0;
1782
1783 /* The sk_lock has mutex_unlock() semantics: */
1784 mutex_release(&sk->sk_lock.dep_map, _RET_IP_);
1785 }
1786}
1787
fafc4e1e
HFS
1788/* no reclassification while locks are held */
1789static inline bool sock_allow_reclassification(const struct sock *csk)
1790{
1791 struct sock *sk = (struct sock *)csk;
1792
33d60fbd
KI
1793 return !sock_owned_by_user_nocheck(sk) &&
1794 !spin_is_locked(&sk->sk_lock.slock);
fafc4e1e 1795}
4b0b72f7 1796
69336bd2 1797struct sock *sk_alloc(struct net *net, int family, gfp_t priority,
11aa9c28 1798 struct proto *prot, int kern);
69336bd2 1799void sk_free(struct sock *sk);
eb4cb008 1800void sk_destruct(struct sock *sk);
69336bd2 1801struct sock *sk_clone_lock(const struct sock *sk, const gfp_t priority);
94352d45 1802void sk_free_unlock_clone(struct sock *sk);
69336bd2
JP
1803
1804struct sk_buff *sock_wmalloc(struct sock *sk, unsigned long size, int force,
1805 gfp_t priority);
1d2077ac 1806void __sock_wfree(struct sk_buff *skb);
69336bd2 1807void sock_wfree(struct sk_buff *skb);
98ba0bd5
WB
1808struct sk_buff *sock_omalloc(struct sock *sk, unsigned long size,
1809 gfp_t priority);
69336bd2
JP
1810void skb_orphan_partial(struct sk_buff *skb);
1811void sock_rfree(struct sk_buff *skb);
62bccb8c 1812void sock_efree(struct sk_buff *skb);
82eabd9e 1813#ifdef CONFIG_INET
69336bd2 1814void sock_edemux(struct sk_buff *skb);
cf7fbe66 1815void sock_pfree(struct sk_buff *skb);
82eabd9e 1816#else
158f323b 1817#define sock_edemux sock_efree
82eabd9e 1818#endif
69336bd2
JP
1819
1820int sock_setsockopt(struct socket *sock, int level, int op,
c8c1bbb6 1821 sockptr_t optval, unsigned int optlen);
69336bd2
JP
1822
1823int sock_getsockopt(struct socket *sock, int level, int op,
1824 char __user *optval, int __user *optlen);
c7cbdbf2
AB
1825int sock_gettstamp(struct socket *sock, void __user *userstamp,
1826 bool timeval, bool time32);
69336bd2
JP
1827struct sk_buff *sock_alloc_send_pskb(struct sock *sk, unsigned long header_len,
1828 unsigned long data_len, int noblock,
1829 int *errcode, int max_page_order);
de32bc6a
PB
1830
1831static inline struct sk_buff *sock_alloc_send_skb(struct sock *sk,
1832 unsigned long size,
1833 int noblock, int *errcode)
1834{
1835 return sock_alloc_send_pskb(sk, size, 0, noblock, errcode, 0);
1836}
1837
69336bd2
JP
1838void *sock_kmalloc(struct sock *sk, int size, gfp_t priority);
1839void sock_kfree_s(struct sock *sk, void *mem, int size);
79e88659 1840void sock_kzfree_s(struct sock *sk, void *mem, int size);
69336bd2 1841void sk_send_sigurg(struct sock *sk);
1da177e4 1842
f28ea365 1843struct sockcm_cookie {
80b14dee 1844 u64 transmit_time;
f28ea365 1845 u32 mark;
3dd17e63 1846 u16 tsflags;
f28ea365
EJ
1847};
1848
657a0667
WB
1849static inline void sockcm_init(struct sockcm_cookie *sockc,
1850 const struct sock *sk)
1851{
1852 *sockc = (struct sockcm_cookie) { .tsflags = sk->sk_tsflags };
1853}
1854
39771b12
WB
1855int __sock_cmsg_send(struct sock *sk, struct msghdr *msg, struct cmsghdr *cmsg,
1856 struct sockcm_cookie *sockc);
f28ea365
EJ
1857int sock_cmsg_send(struct sock *sk, struct msghdr *msg,
1858 struct sockcm_cookie *sockc);
1859
1da177e4
LT
1860/*
1861 * Functions to fill in entries in struct proto_ops when a protocol
1862 * does not implement a particular function.
1863 */
69336bd2
JP
1864int sock_no_bind(struct socket *, struct sockaddr *, int);
1865int sock_no_connect(struct socket *, struct sockaddr *, int, int);
1866int sock_no_socketpair(struct socket *, struct socket *);
cdfbabfb 1867int sock_no_accept(struct socket *, struct socket *, int, bool);
9b2c45d4 1868int sock_no_getname(struct socket *, struct sockaddr *, int);
69336bd2
JP
1869int sock_no_ioctl(struct socket *, unsigned int, unsigned long);
1870int sock_no_listen(struct socket *, int);
1871int sock_no_shutdown(struct socket *, int);
1b784140 1872int sock_no_sendmsg(struct socket *, struct msghdr *, size_t);
306b13eb 1873int sock_no_sendmsg_locked(struct sock *sk, struct msghdr *msg, size_t len);
1b784140 1874int sock_no_recvmsg(struct socket *, struct msghdr *, size_t, int);
69336bd2
JP
1875int sock_no_mmap(struct file *file, struct socket *sock,
1876 struct vm_area_struct *vma);
1877ssize_t sock_no_sendpage(struct socket *sock, struct page *page, int offset,
1878 size_t size, int flags);
306b13eb
TH
1879ssize_t sock_no_sendpage_locked(struct sock *sk, struct page *page,
1880 int offset, size_t size, int flags);
1da177e4
LT
1881
1882/*
1883 * Functions to fill in entries in struct proto_ops when a protocol
1884 * uses the inet style.
1885 */
69336bd2 1886int sock_common_getsockopt(struct socket *sock, int level, int optname,
1da177e4 1887 char __user *optval, int __user *optlen);
1b784140
YX
1888int sock_common_recvmsg(struct socket *sock, struct msghdr *msg, size_t size,
1889 int flags);
69336bd2 1890int sock_common_setsockopt(struct socket *sock, int level, int optname,
a7b75c5a 1891 sockptr_t optval, unsigned int optlen);
1da177e4 1892
69336bd2 1893void sk_common_release(struct sock *sk);
1da177e4
LT
1894
1895/*
1896 * Default socket callbacks and setup code
1897 */
dc6b9b78 1898
1da177e4 1899/* Initialise core socket variables */
69336bd2 1900void sock_init_data(struct socket *sock, struct sock *sk);
1da177e4 1901
1da177e4
LT
1902/*
1903 * Socket reference counting postulates.
1904 *
1905 * * Each user of socket SHOULD hold a reference count.
1906 * * Each access point to socket (an hash table bucket, reference from a list,
1907 * running timer, skb in flight MUST hold a reference count.
1908 * * When reference count hits 0, it means it will never increase back.
1909 * * When reference count hits 0, it means that no references from
1910 * outside exist to this socket and current process on current CPU
1911 * is last user and may/should destroy this socket.
1912 * * sk_free is called from any context: process, BH, IRQ. When
1913 * it is called, socket has no references from outside -> sk_free
1914 * may release descendant resources allocated by the socket, but
1915 * to the time when it is called, socket is NOT referenced by any
1916 * hash tables, lists etc.
1917 * * Packets, delivered from outside (from network or from another process)
1918 * and enqueued on receive/error queues SHOULD NOT grab reference count,
1919 * when they sit in queue. Otherwise, packets will leak to hole, when
1920 * socket is looked up by one cpu and unhasing is made by another CPU.
1921 * It is true for udp/raw, netlink (leak to receive and error queues), tcp
1922 * (leak to backlog). Packet socket does all the processing inside
1923 * BR_NETPROTO_LOCK, so that it has not this race condition. UNIX sockets
1924 * use separate SMP lock, so that they are prone too.
1925 */
1926
1927/* Ungrab socket and destroy it, if it was the last reference. */
1928static inline void sock_put(struct sock *sk)
1929{
41c6d650 1930 if (refcount_dec_and_test(&sk->sk_refcnt))
1da177e4
LT
1931 sk_free(sk);
1932}
05dbc7b5 1933/* Generic version of sock_put(), dealing with all sockets
41b822c5 1934 * (TCP_TIMEWAIT, TCP_NEW_SYN_RECV, ESTABLISHED...)
05dbc7b5
ED
1935 */
1936void sock_gen_put(struct sock *sk);
1da177e4 1937
4f0c40d9 1938int __sk_receive_skb(struct sock *sk, struct sk_buff *skb, const int nested,
c3f24cfb 1939 unsigned int trim_cap, bool refcounted);
4f0c40d9
WB
1940static inline int sk_receive_skb(struct sock *sk, struct sk_buff *skb,
1941 const int nested)
1942{
c3f24cfb 1943 return __sk_receive_skb(sk, skb, nested, 1, true);
4f0c40d9 1944}
25995ff5 1945
e022f0b4
KK
1946static inline void sk_tx_queue_set(struct sock *sk, int tx_queue)
1947{
755c31cd
AN
1948 /* sk_tx_queue_mapping accept only upto a 16-bit value */
1949 if (WARN_ON_ONCE((unsigned short)tx_queue >= USHRT_MAX))
1950 return;
e022f0b4
KK
1951 sk->sk_tx_queue_mapping = tx_queue;
1952}
1953
755c31cd
AN
1954#define NO_QUEUE_MAPPING USHRT_MAX
1955
e022f0b4
KK
1956static inline void sk_tx_queue_clear(struct sock *sk)
1957{
755c31cd 1958 sk->sk_tx_queue_mapping = NO_QUEUE_MAPPING;
e022f0b4
KK
1959}
1960
1961static inline int sk_tx_queue_get(const struct sock *sk)
1962{
755c31cd
AN
1963 if (sk && sk->sk_tx_queue_mapping != NO_QUEUE_MAPPING)
1964 return sk->sk_tx_queue_mapping;
1965
1966 return -1;
e022f0b4
KK
1967}
1968
a37a0ee4
ED
1969static inline void __sk_rx_queue_set(struct sock *sk,
1970 const struct sk_buff *skb,
1971 bool force_set)
c6345ce7 1972{
4e1beecc 1973#ifdef CONFIG_SOCK_RX_QUEUE_MAPPING
c6345ce7
AN
1974 if (skb_rx_queue_recorded(skb)) {
1975 u16 rx_queue = skb_get_rx_queue(skb);
1976
a37a0ee4
ED
1977 if (force_set ||
1978 unlikely(READ_ONCE(sk->sk_rx_queue_mapping) != rx_queue))
342159ee 1979 WRITE_ONCE(sk->sk_rx_queue_mapping, rx_queue);
c6345ce7
AN
1980 }
1981#endif
1982}
1983
a37a0ee4
ED
1984static inline void sk_rx_queue_set(struct sock *sk, const struct sk_buff *skb)
1985{
1986 __sk_rx_queue_set(sk, skb, true);
1987}
1988
1989static inline void sk_rx_queue_update(struct sock *sk, const struct sk_buff *skb)
1990{
1991 __sk_rx_queue_set(sk, skb, false);
1992}
1993
c6345ce7
AN
1994static inline void sk_rx_queue_clear(struct sock *sk)
1995{
4e1beecc 1996#ifdef CONFIG_SOCK_RX_QUEUE_MAPPING
09b89846 1997 WRITE_ONCE(sk->sk_rx_queue_mapping, NO_QUEUE_MAPPING);
c6345ce7
AN
1998#endif
1999}
2000
fc9bab24
AN
2001static inline int sk_rx_queue_get(const struct sock *sk)
2002{
4e1beecc 2003#ifdef CONFIG_SOCK_RX_QUEUE_MAPPING
09b89846
ED
2004 if (sk) {
2005 int res = READ_ONCE(sk->sk_rx_queue_mapping);
2006
2007 if (res != NO_QUEUE_MAPPING)
2008 return res;
2009 }
4e1beecc 2010#endif
fc9bab24
AN
2011
2012 return -1;
2013}
fc9bab24 2014
972692e0
DM
2015static inline void sk_set_socket(struct sock *sk, struct socket *sock)
2016{
2017 sk->sk_socket = sock;
2018}
2019
aa395145
ED
2020static inline wait_queue_head_t *sk_sleep(struct sock *sk)
2021{
eaefd110
ED
2022 BUILD_BUG_ON(offsetof(struct socket_wq, wait) != 0);
2023 return &rcu_dereference_raw(sk->sk_wq)->wait;
aa395145 2024}
1da177e4
LT
2025/* Detach socket from process context.
2026 * Announce socket dead, detach it from wait queue and inode.
2027 * Note that parent inode held reference count on this struct sock,
2028 * we do not release it in this function, because protocol
2029 * probably wants some additional cleanups or even continuing
2030 * to work with this socket (TCP).
2031 */
2032static inline void sock_orphan(struct sock *sk)
2033{
2034 write_lock_bh(&sk->sk_callback_lock);
2035 sock_set_flag(sk, SOCK_DEAD);
972692e0 2036 sk_set_socket(sk, NULL);
43815482 2037 sk->sk_wq = NULL;
1da177e4
LT
2038 write_unlock_bh(&sk->sk_callback_lock);
2039}
2040
2041static inline void sock_graft(struct sock *sk, struct socket *parent)
2042{
0ffdaf5b 2043 WARN_ON(parent->sk);
1da177e4 2044 write_lock_bh(&sk->sk_callback_lock);
333f7909 2045 rcu_assign_pointer(sk->sk_wq, &parent->wq);
1da177e4 2046 parent->sk = sk;
972692e0 2047 sk_set_socket(sk, parent);
86741ec2 2048 sk->sk_uid = SOCK_INODE(parent)->i_uid;
4237c75c 2049 security_sock_graft(sk, parent);
1da177e4
LT
2050 write_unlock_bh(&sk->sk_callback_lock);
2051}
2052
69336bd2
JP
2053kuid_t sock_i_uid(struct sock *sk);
2054unsigned long sock_i_ino(struct sock *sk);
1da177e4 2055
86741ec2
LC
2056static inline kuid_t sock_net_uid(const struct net *net, const struct sock *sk)
2057{
2058 return sk ? sk->sk_uid : make_kuid(net->user_ns, 0);
2059}
2060
58d607d3 2061static inline u32 net_tx_rndhash(void)
877d1f62 2062{
58d607d3
ED
2063 u32 v = prandom_u32();
2064
2065 return v ?: 1;
2066}
877d1f62 2067
58d607d3
ED
2068static inline void sk_set_txhash(struct sock *sk)
2069{
b71eaed8
ED
2070 /* This pairs with READ_ONCE() in skb_set_hash_from_sk() */
2071 WRITE_ONCE(sk->sk_txhash, net_tx_rndhash());
877d1f62
TH
2072}
2073
9c30ae83 2074static inline bool sk_rethink_txhash(struct sock *sk)
265f94ff 2075{
26859240 2076 if (sk->sk_txhash && sk->sk_txrehash == SOCK_TXREHASH_ENABLED) {
265f94ff 2077 sk_set_txhash(sk);
9c30ae83
YC
2078 return true;
2079 }
2080 return false;
265f94ff
TH
2081}
2082
1da177e4
LT
2083static inline struct dst_entry *
2084__sk_dst_get(struct sock *sk)
2085{
1e1d04e6
HFS
2086 return rcu_dereference_check(sk->sk_dst_cache,
2087 lockdep_sock_is_held(sk));
1da177e4
LT
2088}
2089
2090static inline struct dst_entry *
2091sk_dst_get(struct sock *sk)
2092{
2093 struct dst_entry *dst;
2094
b6c6712a
ED
2095 rcu_read_lock();
2096 dst = rcu_dereference(sk->sk_dst_cache);
f8864972
ED
2097 if (dst && !atomic_inc_not_zero(&dst->__refcnt))
2098 dst = NULL;
b6c6712a 2099 rcu_read_unlock();
1da177e4
LT
2100 return dst;
2101}
2102
9c30ae83 2103static inline void __dst_negative_advice(struct sock *sk)
b6c6712a
ED
2104{
2105 struct dst_entry *ndst, *dst = __sk_dst_get(sk);
2106
2107 if (dst && dst->ops->negative_advice) {
2108 ndst = dst->ops->negative_advice(dst);
2109
2110 if (ndst != dst) {
2111 rcu_assign_pointer(sk->sk_dst_cache, ndst);
0a6957e7 2112 sk_tx_queue_clear(sk);
9b8805a3 2113 sk->sk_dst_pending_confirm = 0;
b6c6712a
ED
2114 }
2115 }
2116}
2117
9c30ae83
YC
2118static inline void dst_negative_advice(struct sock *sk)
2119{
2120 sk_rethink_txhash(sk);
2121 __dst_negative_advice(sk);
2122}
2123
1da177e4
LT
2124static inline void
2125__sk_dst_set(struct sock *sk, struct dst_entry *dst)
2126{
2127 struct dst_entry *old_dst;
2128
e022f0b4 2129 sk_tx_queue_clear(sk);
9b8805a3 2130 sk->sk_dst_pending_confirm = 0;
95964c6d
ED
2131 old_dst = rcu_dereference_protected(sk->sk_dst_cache,
2132 lockdep_sock_is_held(sk));
b6c6712a 2133 rcu_assign_pointer(sk->sk_dst_cache, dst);
1da177e4
LT
2134 dst_release(old_dst);
2135}
2136
2137static inline void
2138sk_dst_set(struct sock *sk, struct dst_entry *dst)
2139{
7f502361
ED
2140 struct dst_entry *old_dst;
2141
2142 sk_tx_queue_clear(sk);
9b8805a3 2143 sk->sk_dst_pending_confirm = 0;
5925a055 2144 old_dst = xchg((__force struct dst_entry **)&sk->sk_dst_cache, dst);
7f502361 2145 dst_release(old_dst);
1da177e4
LT
2146}
2147
2148static inline void
2149__sk_dst_reset(struct sock *sk)
2150{
b6c6712a 2151 __sk_dst_set(sk, NULL);
1da177e4
LT
2152}
2153
2154static inline void
2155sk_dst_reset(struct sock *sk)
2156{
7f502361 2157 sk_dst_set(sk, NULL);
1da177e4
LT
2158}
2159
69336bd2 2160struct dst_entry *__sk_dst_check(struct sock *sk, u32 cookie);
1da177e4 2161
69336bd2 2162struct dst_entry *sk_dst_check(struct sock *sk, u32 cookie);
1da177e4 2163
9b8805a3
JA
2164static inline void sk_dst_confirm(struct sock *sk)
2165{
25c7a6d1
ED
2166 if (!READ_ONCE(sk->sk_dst_pending_confirm))
2167 WRITE_ONCE(sk->sk_dst_pending_confirm, 1);
9b8805a3
JA
2168}
2169
4ff06203
JA
2170static inline void sock_confirm_neigh(struct sk_buff *skb, struct neighbour *n)
2171{
2172 if (skb_get_dst_pending_confirm(skb)) {
2173 struct sock *sk = skb->sk;
4ff06203 2174
25c7a6d1
ED
2175 if (sk && READ_ONCE(sk->sk_dst_pending_confirm))
2176 WRITE_ONCE(sk->sk_dst_pending_confirm, 0);
1e84dc6b 2177 neigh_confirm(n);
4ff06203
JA
2178 }
2179}
2180
f60e5990 2181bool sk_mc_loop(struct sock *sk);
2182
dc6b9b78 2183static inline bool sk_can_gso(const struct sock *sk)
bcd76111
HX
2184{
2185 return net_gso_ok(sk->sk_route_caps, sk->sk_gso_type);
2186}
2187
69336bd2 2188void sk_setup_caps(struct sock *sk, struct dst_entry *dst);
6cbb0df7 2189
aba54656 2190static inline void sk_gso_disable(struct sock *sk)
a465419b 2191{
aba54656
ED
2192 sk->sk_gso_disabled = 1;
2193 sk->sk_route_caps &= ~NETIF_F_GSO_MASK;
a465419b
ED
2194}
2195
c6e1a0d1 2196static inline int skb_do_copy_data_nocache(struct sock *sk, struct sk_buff *skb,
57be5bda 2197 struct iov_iter *from, char *to,
912d398d 2198 int copy, int offset)
c6e1a0d1
TH
2199{
2200 if (skb->ip_summed == CHECKSUM_NONE) {
57be5bda 2201 __wsum csum = 0;
15e6cb46 2202 if (!csum_and_copy_from_iter_full(to, copy, &csum, from))
57be5bda 2203 return -EFAULT;
912d398d 2204 skb->csum = csum_block_add(skb->csum, csum, offset);
c6e1a0d1 2205 } else if (sk->sk_route_caps & NETIF_F_NOCACHE_COPY) {
15e6cb46 2206 if (!copy_from_iter_full_nocache(to, copy, from))
c6e1a0d1 2207 return -EFAULT;
15e6cb46 2208 } else if (!copy_from_iter_full(to, copy, from))
c6e1a0d1
TH
2209 return -EFAULT;
2210
2211 return 0;
2212}
2213
2214static inline int skb_add_data_nocache(struct sock *sk, struct sk_buff *skb,
57be5bda 2215 struct iov_iter *from, int copy)
c6e1a0d1 2216{
912d398d 2217 int err, offset = skb->len;
c6e1a0d1 2218
912d398d
WY
2219 err = skb_do_copy_data_nocache(sk, skb, from, skb_put(skb, copy),
2220 copy, offset);
c6e1a0d1 2221 if (err)
912d398d 2222 __skb_trim(skb, offset);
c6e1a0d1
TH
2223
2224 return err;
2225}
2226
57be5bda 2227static inline int skb_copy_to_page_nocache(struct sock *sk, struct iov_iter *from,
c6e1a0d1
TH
2228 struct sk_buff *skb,
2229 struct page *page,
2230 int off, int copy)
2231{
2232 int err;
2233
912d398d
WY
2234 err = skb_do_copy_data_nocache(sk, skb, from, page_address(page) + off,
2235 copy, skb->len);
c6e1a0d1
TH
2236 if (err)
2237 return err;
2238
2239 skb->len += copy;
2240 skb->data_len += copy;
2241 skb->truesize += copy;
ab4e846a 2242 sk_wmem_queued_add(sk, copy);
c6e1a0d1
TH
2243 sk_mem_charge(sk, copy);
2244 return 0;
2245}
2246
c564039f
ED
2247/**
2248 * sk_wmem_alloc_get - returns write allocations
2249 * @sk: socket
2250 *
66256e0b 2251 * Return: sk_wmem_alloc minus initial offset of one
c564039f
ED
2252 */
2253static inline int sk_wmem_alloc_get(const struct sock *sk)
2254{
14afee4b 2255 return refcount_read(&sk->sk_wmem_alloc) - 1;
c564039f
ED
2256}
2257
2258/**
2259 * sk_rmem_alloc_get - returns read allocations
2260 * @sk: socket
2261 *
66256e0b 2262 * Return: sk_rmem_alloc
c564039f
ED
2263 */
2264static inline int sk_rmem_alloc_get(const struct sock *sk)
2265{
2266 return atomic_read(&sk->sk_rmem_alloc);
2267}
2268
2269/**
2270 * sk_has_allocations - check if allocations are outstanding
2271 * @sk: socket
2272 *
66256e0b 2273 * Return: true if socket has write or read allocations
c564039f 2274 */
dc6b9b78 2275static inline bool sk_has_allocations(const struct sock *sk)
c564039f
ED
2276{
2277 return sk_wmem_alloc_get(sk) || sk_rmem_alloc_get(sk);
2278}
2279
a57de0b4 2280/**
1ce0bf50 2281 * skwq_has_sleeper - check if there are any waiting processes
acfbe96a 2282 * @wq: struct socket_wq
a57de0b4 2283 *
66256e0b 2284 * Return: true if socket_wq has waiting processes
a57de0b4 2285 *
1ce0bf50 2286 * The purpose of the skwq_has_sleeper and sock_poll_wait is to wrap the memory
a57de0b4
JO
2287 * barrier call. They were added due to the race found within the tcp code.
2288 *
d651983d 2289 * Consider following tcp code paths::
a57de0b4 2290 *
d651983d
MCC
2291 * CPU1 CPU2
2292 * sys_select receive packet
a57de0b4
JO
2293 * ... ...
2294 * __add_wait_queue update tp->rcv_nxt
2295 * ... ...
2296 * tp->rcv_nxt check sock_def_readable
2297 * ... {
43815482
ED
2298 * schedule rcu_read_lock();
2299 * wq = rcu_dereference(sk->sk_wq);
2300 * if (wq && waitqueue_active(&wq->wait))
2301 * wake_up_interruptible(&wq->wait)
a57de0b4
JO
2302 * ...
2303 * }
2304 *
2305 * The race for tcp fires when the __add_wait_queue changes done by CPU1 stay
2306 * in its cache, and so does the tp->rcv_nxt update on CPU2 side. The CPU1
2307 * could then endup calling schedule and sleep forever if there are no more
2308 * data on the socket.
ad462769 2309 *
a57de0b4 2310 */
1ce0bf50 2311static inline bool skwq_has_sleeper(struct socket_wq *wq)
a57de0b4 2312{
1ce0bf50 2313 return wq && wq_has_sleeper(&wq->wait);
a57de0b4
JO
2314}
2315
2316/**
2317 * sock_poll_wait - place memory barrier behind the poll_wait call.
2318 * @filp: file
89ab066d 2319 * @sock: socket to wait on
a57de0b4
JO
2320 * @p: poll_table
2321 *
43815482 2322 * See the comments in the wq_has_sleeper function.
a57de0b4 2323 */
89ab066d
KG
2324static inline void sock_poll_wait(struct file *filp, struct socket *sock,
2325 poll_table *p)
a57de0b4 2326{
d8bbd13b 2327 if (!poll_does_not_wait(p)) {
333f7909 2328 poll_wait(filp, &sock->wq.wait, p);
dc6b9b78 2329 /* We need to be sure we are in sync with the
a57de0b4
JO
2330 * socket flags modification.
2331 *
43815482 2332 * This memory barrier is paired in the wq_has_sleeper.
dc6b9b78 2333 */
a57de0b4
JO
2334 smp_mb();
2335 }
2336}
2337
b73c3d0e
TH
2338static inline void skb_set_hash_from_sk(struct sk_buff *skb, struct sock *sk)
2339{
b71eaed8
ED
2340 /* This pairs with WRITE_ONCE() in sk_set_txhash() */
2341 u32 txhash = READ_ONCE(sk->sk_txhash);
2342
2343 if (txhash) {
b73c3d0e 2344 skb->l4_hash = 1;
b71eaed8 2345 skb->hash = txhash;
b73c3d0e
TH
2346 }
2347}
2348
9e17f8a4
ED
2349void skb_set_owner_w(struct sk_buff *skb, struct sock *sk);
2350
1da177e4 2351/*
dc6b9b78 2352 * Queue a received datagram if it will fit. Stream and sequenced
1da177e4
LT
2353 * protocols can't normally use this as they need to fit buffers in
2354 * and play with them.
2355 *
dc6b9b78 2356 * Inlined as it's very short and called for pretty much every
1da177e4
LT
2357 * packet ever received.
2358 */
1da177e4
LT
2359static inline void skb_set_owner_r(struct sk_buff *skb, struct sock *sk)
2360{
d55d87fd 2361 skb_orphan(skb);
1da177e4
LT
2362 skb->sk = sk;
2363 skb->destructor = sock_rfree;
2364 atomic_add(skb->truesize, &sk->sk_rmem_alloc);
3ab224be 2365 sk_mem_charge(sk, skb->truesize);
1da177e4
LT
2366}
2367
098116e7 2368static inline __must_check bool skb_set_owner_sk_safe(struct sk_buff *skb, struct sock *sk)
9adc89af
PA
2369{
2370 if (sk && refcount_inc_not_zero(&sk->sk_refcnt)) {
2371 skb_orphan(skb);
2372 skb->destructor = sock_efree;
2373 skb->sk = sk;
098116e7 2374 return true;
9adc89af 2375 }
098116e7 2376 return false;
9adc89af
PA
2377}
2378
5e10da53
PA
2379static inline void skb_prepare_for_gro(struct sk_buff *skb)
2380{
2381 if (skb->destructor != sock_wfree) {
2382 skb_orphan(skb);
2383 return;
2384 }
2385 skb->slow_gro = 1;
2386}
2387
69336bd2
JP
2388void sk_reset_timer(struct sock *sk, struct timer_list *timer,
2389 unsigned long expires);
1da177e4 2390
69336bd2 2391void sk_stop_timer(struct sock *sk, struct timer_list *timer);
1da177e4 2392
08b81d87
GT
2393void sk_stop_timer_sync(struct sock *sk, struct timer_list *timer);
2394
65101aec
PA
2395int __sk_queue_drop_skb(struct sock *sk, struct sk_buff_head *sk_queue,
2396 struct sk_buff *skb, unsigned int flags,
69629464
ED
2397 void (*destructor)(struct sock *sk,
2398 struct sk_buff *skb));
e6afc8ac 2399int __sock_queue_rcv_skb(struct sock *sk, struct sk_buff *skb);
c1b8a567
MD
2400
2401int sock_queue_rcv_skb_reason(struct sock *sk, struct sk_buff *skb,
2402 enum skb_drop_reason *reason);
2403
2404static inline int sock_queue_rcv_skb(struct sock *sk, struct sk_buff *skb)
2405{
2406 return sock_queue_rcv_skb_reason(sk, skb, NULL);
2407}
1da177e4 2408
69336bd2 2409int sock_queue_err_skb(struct sock *sk, struct sk_buff *skb);
364a9e93 2410struct sk_buff *sock_dequeue_err_skb(struct sock *sk);
1da177e4
LT
2411
2412/*
2413 * Recover an error report and clear atomically
2414 */
dc6b9b78 2415
1da177e4
LT
2416static inline int sock_error(struct sock *sk)
2417{
c1cbe4b7 2418 int err;
f13ef100
ED
2419
2420 /* Avoid an atomic operation for the common case.
2421 * This is racy since another cpu/thread can change sk_err under us.
2422 */
2423 if (likely(data_race(!sk->sk_err)))
c1cbe4b7 2424 return 0;
f13ef100 2425
c1cbe4b7 2426 err = xchg(&sk->sk_err, 0);
1da177e4
LT
2427 return -err;
2428}
2429
e3ae2365
AA
2430void sk_error_report(struct sock *sk);
2431
1da177e4
LT
2432static inline unsigned long sock_wspace(struct sock *sk)
2433{
2434 int amt = 0;
2435
2436 if (!(sk->sk_shutdown & SEND_SHUTDOWN)) {
14afee4b 2437 amt = sk->sk_sndbuf - refcount_read(&sk->sk_wmem_alloc);
dc6b9b78 2438 if (amt < 0)
1da177e4
LT
2439 amt = 0;
2440 }
2441 return amt;
2442}
2443
ceb5d58b
ED
2444/* Note:
2445 * We use sk->sk_wq_raw, from contexts knowing this
2446 * pointer is not NULL and cannot disappear/change.
2447 */
9cd3e072 2448static inline void sk_set_bit(int nr, struct sock *sk)
1da177e4 2449{
4be73522
ED
2450 if ((nr == SOCKWQ_ASYNC_NOSPACE || nr == SOCKWQ_ASYNC_WAITDATA) &&
2451 !sock_flag(sk, SOCK_FASYNC))
9317bb69
ED
2452 return;
2453
ceb5d58b 2454 set_bit(nr, &sk->sk_wq_raw->flags);
9cd3e072
ED
2455}
2456
2457static inline void sk_clear_bit(int nr, struct sock *sk)
2458{
4be73522
ED
2459 if ((nr == SOCKWQ_ASYNC_NOSPACE || nr == SOCKWQ_ASYNC_WAITDATA) &&
2460 !sock_flag(sk, SOCK_FASYNC))
9317bb69
ED
2461 return;
2462
ceb5d58b 2463 clear_bit(nr, &sk->sk_wq_raw->flags);
9cd3e072
ED
2464}
2465
ceb5d58b 2466static inline void sk_wake_async(const struct sock *sk, int how, int band)
1da177e4 2467{
ceb5d58b
ED
2468 if (sock_flag(sk, SOCK_FASYNC)) {
2469 rcu_read_lock();
2470 sock_wake_async(rcu_dereference(sk->sk_wq), how, band);
2471 rcu_read_unlock();
2472 }
1da177e4
LT
2473}
2474
eea86af6
DB
2475/* Since sk_{r,w}mem_alloc sums skb->truesize, even a small frame might
2476 * need sizeof(sk_buff) + MTU + padding, unless net driver perform copybreak.
2477 * Note: for send buffers, TCP works better if we can build two skbs at
2478 * minimum.
7a91b434 2479 */
9eb5bf83 2480#define TCP_SKB_MIN_TRUESIZE (2048 + SKB_DATA_ALIGN(sizeof(struct sk_buff)))
eea86af6
DB
2481
2482#define SOCK_MIN_SNDBUF (TCP_SKB_MIN_TRUESIZE * 2)
2483#define SOCK_MIN_RCVBUF TCP_SKB_MIN_TRUESIZE
1da177e4
LT
2484
2485static inline void sk_stream_moderate_sndbuf(struct sock *sk)
2486{
e292f05e
ED
2487 u32 val;
2488
2489 if (sk->sk_userlocks & SOCK_SNDBUF_LOCK)
2490 return;
2491
2492 val = min(sk->sk_sndbuf, sk->sk_wmem_queued >> 1);
ca057051 2493 val = max_t(u32, val, sk_unused_reserved_mem(sk));
e292f05e
ED
2494
2495 WRITE_ONCE(sk->sk_sndbuf, max_t(u32, val, SOCK_MIN_SNDBUF));
1da177e4
LT
2496}
2497
5640f768
ED
2498/**
2499 * sk_page_frag - return an appropriate page_frag
2500 * @sk: socket
2501 *
20eb4f29 2502 * Use the per task page_frag instead of the per socket one for
dacb5d88 2503 * optimization when we know that we're in process context and own
20eb4f29
TH
2504 * everything that's associated with %current.
2505 *
dacb5d88
PA
2506 * Both direct reclaim and page faults can nest inside other
2507 * socket operations and end up recursing into sk_page_frag()
2508 * while it's already in use: explicitly avoid task page_frag
2509 * usage if the caller is potentially doing any of them.
2510 * This assumes that page fault handlers use the GFP_NOFS flags.
66256e0b
RD
2511 *
2512 * Return: a per task page_frag if context allows that,
2513 * otherwise a per socket one.
5640f768
ED
2514 */
2515static inline struct page_frag *sk_page_frag(struct sock *sk)
1da177e4 2516{
dacb5d88
PA
2517 if ((sk->sk_allocation & (__GFP_DIRECT_RECLAIM | __GFP_MEMALLOC | __GFP_FS)) ==
2518 (__GFP_DIRECT_RECLAIM | __GFP_FS))
5640f768 2519 return &current->task_frag;
1da177e4 2520
5640f768 2521 return &sk->sk_frag;
1da177e4
LT
2522}
2523
69336bd2 2524bool sk_page_frag_refill(struct sock *sk, struct page_frag *pfrag);
5640f768 2525
1da177e4
LT
2526/*
2527 * Default write policy as shown to user space via poll/select/SIGIO
2528 */
dc6b9b78 2529static inline bool sock_writeable(const struct sock *sk)
1da177e4 2530{
e292f05e 2531 return refcount_read(&sk->sk_wmem_alloc) < (READ_ONCE(sk->sk_sndbuf) >> 1);
1da177e4
LT
2532}
2533
dd0fc66f 2534static inline gfp_t gfp_any(void)
1da177e4 2535{
99709372 2536 return in_softirq() ? GFP_ATOMIC : GFP_KERNEL;
1da177e4
LT
2537}
2538
4b1327be
WW
2539static inline gfp_t gfp_memcg_charge(void)
2540{
2541 return in_softirq() ? GFP_NOWAIT : GFP_KERNEL;
2542}
2543
dc6b9b78 2544static inline long sock_rcvtimeo(const struct sock *sk, bool noblock)
1da177e4
LT
2545{
2546 return noblock ? 0 : sk->sk_rcvtimeo;
2547}
2548
dc6b9b78 2549static inline long sock_sndtimeo(const struct sock *sk, bool noblock)
1da177e4
LT
2550{
2551 return noblock ? 0 : sk->sk_sndtimeo;
2552}
2553
2554static inline int sock_rcvlowat(const struct sock *sk, int waitall, int len)
2555{
eac66402
ED
2556 int v = waitall ? len : min_t(int, READ_ONCE(sk->sk_rcvlowat), len);
2557
2558 return v ?: 1;
1da177e4
LT
2559}
2560
2561/* Alas, with timeout socket operations are not restartable.
2562 * Compare this to poll().
2563 */
2564static inline int sock_intr_errno(long timeo)
2565{
2566 return timeo == MAX_SCHEDULE_TIMEOUT ? -ERESTARTSYS : -EINTR;
2567}
2568
744d5a3e
EB
2569struct sock_skb_cb {
2570 u32 dropcount;
2571};
2572
2573/* Store sock_skb_cb at the end of skb->cb[] so protocol families
2574 * using skb->cb[] would keep using it directly and utilize its
2575 * alignement guarantee.
2576 */
c593642c 2577#define SOCK_SKB_CB_OFFSET ((sizeof_field(struct sk_buff, cb) - \
744d5a3e
EB
2578 sizeof(struct sock_skb_cb)))
2579
2580#define SOCK_SKB_CB(__skb) ((struct sock_skb_cb *)((__skb)->cb + \
2581 SOCK_SKB_CB_OFFSET))
2582
b4772ef8 2583#define sock_skb_cb_check_size(size) \
744d5a3e 2584 BUILD_BUG_ON((size) > SOCK_SKB_CB_OFFSET)
b4772ef8 2585
3bc3b96f
EB
2586static inline void
2587sock_skb_set_dropcount(const struct sock *sk, struct sk_buff *skb)
2588{
3665f381
ED
2589 SOCK_SKB_CB(skb)->dropcount = sock_flag(sk, SOCK_RXQ_OVFL) ?
2590 atomic_read(&sk->sk_drops) : 0;
3bc3b96f
EB
2591}
2592
532182cd
ED
2593static inline void sk_drops_add(struct sock *sk, const struct sk_buff *skb)
2594{
2595 int segs = max_t(u16, 1, skb_shinfo(skb)->gso_segs);
2596
2597 atomic_add(segs, &sk->sk_drops);
2598}
2599
3a0ed3e9
DD
2600static inline ktime_t sock_read_timestamp(struct sock *sk)
2601{
2602#if BITS_PER_LONG==32
2603 unsigned int seq;
2604 ktime_t kt;
2605
2606 do {
2607 seq = read_seqbegin(&sk->sk_stamp_seq);
2608 kt = sk->sk_stamp;
2609 } while (read_seqretry(&sk->sk_stamp_seq, seq));
2610
2611 return kt;
2612#else
f75359f3 2613 return READ_ONCE(sk->sk_stamp);
3a0ed3e9
DD
2614#endif
2615}
2616
2617static inline void sock_write_timestamp(struct sock *sk, ktime_t kt)
2618{
2619#if BITS_PER_LONG==32
2620 write_seqlock(&sk->sk_stamp_seq);
2621 sk->sk_stamp = kt;
2622 write_sequnlock(&sk->sk_stamp_seq);
2623#else
f75359f3 2624 WRITE_ONCE(sk->sk_stamp, kt);
3a0ed3e9
DD
2625#endif
2626}
2627
69336bd2
JP
2628void __sock_recv_timestamp(struct msghdr *msg, struct sock *sk,
2629 struct sk_buff *skb);
2630void __sock_recv_wifi_status(struct msghdr *msg, struct sock *sk,
2631 struct sk_buff *skb);
92f37fd2 2632
dc6b9b78 2633static inline void
1da177e4
LT
2634sock_recv_timestamp(struct msghdr *msg, struct sock *sk, struct sk_buff *skb)
2635{
b7aa0bf7 2636 ktime_t kt = skb->tstamp;
20d49473 2637 struct skb_shared_hwtstamps *hwtstamps = skb_hwtstamps(skb);
a61bbcf2 2638
20d49473
PO
2639 /*
2640 * generate control messages if
b9f40e21 2641 * - receive time stamping in software requested
20d49473 2642 * - software time stamp available and wanted
20d49473 2643 * - hardware time stamps available and wanted
20d49473
PO
2644 */
2645 if (sock_flag(sk, SOCK_RCVTSTAMP) ||
b9f40e21 2646 (sk->sk_tsflags & SOF_TIMESTAMPING_RX_SOFTWARE) ||
2456e855
TG
2647 (kt && sk->sk_tsflags & SOF_TIMESTAMPING_SOFTWARE) ||
2648 (hwtstamps->hwtstamp &&
b9f40e21 2649 (sk->sk_tsflags & SOF_TIMESTAMPING_RAW_HARDWARE)))
92f37fd2
ED
2650 __sock_recv_timestamp(msg, sk, skb);
2651 else
3a0ed3e9 2652 sock_write_timestamp(sk, kt);
6e3e939f
JB
2653
2654 if (sock_flag(sk, SOCK_WIFI_STATUS) && skb->wifi_acked_valid)
2655 __sock_recv_wifi_status(msg, sk, skb);
1da177e4
LT
2656}
2657
6fd1d51c
EM
2658void __sock_recv_cmsgs(struct msghdr *msg, struct sock *sk,
2659 struct sk_buff *skb);
767dd033 2660
6c7c98ba 2661#define SK_DEFAULT_STAMP (-1L * NSEC_PER_SEC)
6fd1d51c
EM
2662static inline void sock_recv_cmsgs(struct msghdr *msg, struct sock *sk,
2663 struct sk_buff *skb)
767dd033 2664{
6fd1d51c
EM
2665#define FLAGS_RECV_CMSGS ((1UL << SOCK_RXQ_OVFL) | \
2666 (1UL << SOCK_RCVTSTAMP) | \
2667 (1UL << SOCK_RCVMARK))
b9f40e21
WB
2668#define TSFLAGS_ANY (SOF_TIMESTAMPING_SOFTWARE | \
2669 SOF_TIMESTAMPING_RAW_HARDWARE)
767dd033 2670
6fd1d51c
EM
2671 if (sk->sk_flags & FLAGS_RECV_CMSGS || sk->sk_tsflags & TSFLAGS_ANY)
2672 __sock_recv_cmsgs(msg, sk, skb);
d3fbff30 2673 else if (unlikely(sock_flag(sk, SOCK_TIMESTAMP)))
3a0ed3e9 2674 sock_write_timestamp(sk, skb->tstamp);
6c7c98ba 2675 else if (unlikely(sk->sk_stamp == SK_DEFAULT_STAMP))
3a0ed3e9 2676 sock_write_timestamp(sk, 0);
767dd033 2677}
3b885787 2678
c14ac945 2679void __sock_tx_timestamp(__u16 tsflags, __u8 *tx_flags);
67cc0d40 2680
20d49473 2681/**
8f932f76 2682 * _sock_tx_timestamp - checks whether the outgoing packet is to be time stamped
20d49473 2683 * @sk: socket sending this packet
c14ac945 2684 * @tsflags: timestamping flags to use
140c55d4 2685 * @tx_flags: completed with instructions for time stamping
8f932f76 2686 * @tskey: filled in with next sk_tskey (not for TCP, which uses seqno)
140c55d4 2687 *
d651983d 2688 * Note: callers should take care of initial ``*tx_flags`` value (usually 0)
20d49473 2689 */
8f932f76
WB
2690static inline void _sock_tx_timestamp(struct sock *sk, __u16 tsflags,
2691 __u8 *tx_flags, __u32 *tskey)
67cc0d40 2692{
8f932f76 2693 if (unlikely(tsflags)) {
c14ac945 2694 __sock_tx_timestamp(tsflags, tx_flags);
8f932f76
WB
2695 if (tsflags & SOF_TIMESTAMPING_OPT_ID && tskey &&
2696 tsflags & SOF_TIMESTAMPING_TX_RECORD_MASK)
a1cdec57 2697 *tskey = atomic_inc_return(&sk->sk_tskey) - 1;
8f932f76 2698 }
67cc0d40
WB
2699 if (unlikely(sock_flag(sk, SOCK_WIFI_STATUS)))
2700 *tx_flags |= SKBTX_WIFI_STATUS;
2701}
20d49473 2702
8f932f76
WB
2703static inline void sock_tx_timestamp(struct sock *sk, __u16 tsflags,
2704 __u8 *tx_flags)
2705{
2706 _sock_tx_timestamp(sk, tsflags, tx_flags, NULL);
2707}
2708
2709static inline void skb_setup_tx_timestamp(struct sk_buff *skb, __u16 tsflags)
2710{
2711 _sock_tx_timestamp(skb->sk, tsflags, &skb_shinfo(skb)->tx_flags,
2712 &skb_shinfo(skb)->tskey);
2713}
2714
42f67eea
ED
2715static inline bool sk_is_tcp(const struct sock *sk)
2716{
2717 return sk->sk_type == SOCK_STREAM && sk->sk_protocol == IPPROTO_TCP;
2718}
2719
1da177e4
LT
2720/**
2721 * sk_eat_skb - Release a skb if it is no longer needed
4dc3b16b
PP
2722 * @sk: socket to eat this skb from
2723 * @skb: socket buffer to eat
1da177e4
LT
2724 *
2725 * This routine must be called with interrupts disabled or with the socket
2726 * locked so that the sk_buff queue operation is ok.
2727*/
7bced397 2728static inline void sk_eat_skb(struct sock *sk, struct sk_buff *skb)
1da177e4
LT
2729{
2730 __skb_unlink(skb, &sk->sk_receive_queue);
2731 __kfree_skb(skb);
2732}
2733
cf7fbe66
JS
2734static inline bool
2735skb_sk_is_prefetched(struct sk_buff *skb)
2736{
2737#ifdef CONFIG_INET
2738 return skb->destructor == sock_pfree;
2739#else
2740 return false;
2741#endif /* CONFIG_INET */
2742}
2743
7ae215d2
JS
2744/* This helper checks if a socket is a full socket,
2745 * ie _not_ a timewait or request socket.
2746 */
2747static inline bool sk_fullsock(const struct sock *sk)
2748{
2749 return (1 << sk->sk_state) & ~(TCPF_TIME_WAIT | TCPF_NEW_SYN_RECV);
2750}
2751
2752static inline bool
2753sk_is_refcounted(struct sock *sk)
2754{
2755 /* Only full sockets have sk->sk_flags. */
2756 return !sk_fullsock(sk) || !sock_flag(sk, SOCK_RCU_FREE);
2757}
2758
71489e21 2759/**
045065f0
LR
2760 * skb_steal_sock - steal a socket from an sk_buff
2761 * @skb: sk_buff to steal the socket from
2762 * @refcounted: is set to true if the socket is reference-counted
71489e21
JS
2763 */
2764static inline struct sock *
2765skb_steal_sock(struct sk_buff *skb, bool *refcounted)
23542618 2766{
efc27f8c 2767 if (skb->sk) {
23542618
KK
2768 struct sock *sk = skb->sk;
2769
71489e21 2770 *refcounted = true;
7ae215d2
JS
2771 if (skb_sk_is_prefetched(skb))
2772 *refcounted = sk_is_refcounted(sk);
23542618
KK
2773 skb->destructor = NULL;
2774 skb->sk = NULL;
2775 return sk;
2776 }
71489e21 2777 *refcounted = false;
23542618
KK
2778 return NULL;
2779}
2780
ebf4e808
IL
2781/* Checks if this SKB belongs to an HW offloaded socket
2782 * and whether any SW fallbacks are required based on dev.
41477662 2783 * Check decrypted mark in case skb_orphan() cleared socket.
ebf4e808
IL
2784 */
2785static inline struct sk_buff *sk_validate_xmit_skb(struct sk_buff *skb,
2786 struct net_device *dev)
2787{
2788#ifdef CONFIG_SOCK_VALIDATE_XMIT
2789 struct sock *sk = skb->sk;
2790
41477662 2791 if (sk && sk_fullsock(sk) && sk->sk_validate_xmit_skb) {
ebf4e808 2792 skb = sk->sk_validate_xmit_skb(sk, dev, skb);
41477662
JK
2793#ifdef CONFIG_TLS_DEVICE
2794 } else if (unlikely(skb->decrypted)) {
2795 pr_warn_ratelimited("unencrypted skb with no associated socket - dropping\n");
2796 kfree_skb(skb);
2797 skb = NULL;
2798#endif
2799 }
ebf4e808
IL
2800#endif
2801
2802 return skb;
2803}
2804
e446f9df
ED
2805/* This helper checks if a socket is a LISTEN or NEW_SYN_RECV
2806 * SYNACK messages can be attached to either ones (depending on SYNCOOKIE)
2807 */
2808static inline bool sk_listener(const struct sock *sk)
2809{
2810 return (1 << sk->sk_state) & (TCPF_LISTEN | TCPF_NEW_SYN_RECV);
2811}
2812
193d357d 2813void sock_enable_timestamp(struct sock *sk, enum sock_flags flag);
69336bd2
JP
2814int sock_recv_errqueue(struct sock *sk, struct msghdr *msg, int len, int level,
2815 int type);
1da177e4 2816
a3b299da
EB
2817bool sk_ns_capable(const struct sock *sk,
2818 struct user_namespace *user_ns, int cap);
2819bool sk_capable(const struct sock *sk, int cap);
2820bool sk_net_capable(const struct sock *sk, int cap);
2821
a2d133b1
JH
2822void sk_get_meminfo(const struct sock *sk, u32 *meminfo);
2823
eaa72dc4
ED
2824/* Take into consideration the size of the struct sk_buff overhead in the
2825 * determination of these values, since that is non-constant across
2826 * platforms. This makes socket queueing behavior and performance
2827 * not depend upon such differences.
2828 */
2829#define _SK_MEM_PACKETS 256
2830#define _SK_MEM_OVERHEAD SKB_TRUESIZE(256)
2831#define SK_WMEM_MAX (_SK_MEM_OVERHEAD * _SK_MEM_PACKETS)
2832#define SK_RMEM_MAX (_SK_MEM_OVERHEAD * _SK_MEM_PACKETS)
2833
1da177e4
LT
2834extern __u32 sysctl_wmem_max;
2835extern __u32 sysctl_rmem_max;
2836
b245be1f 2837extern int sysctl_tstamp_allow_data;
6baf1f41
DM
2838extern int sysctl_optmem_max;
2839
20380731
ACM
2840extern __u32 sysctl_wmem_default;
2841extern __u32 sysctl_rmem_default;
20380731 2842
723783d0 2843#define SKB_FRAG_PAGE_ORDER get_order(32768)
ce27ec60
ED
2844DECLARE_STATIC_KEY_FALSE(net_high_order_alloc_disable_key);
2845
a3dcaf17
ED
2846static inline int sk_get_wmem0(const struct sock *sk, const struct proto *proto)
2847{
2848 /* Does this proto have per netns sysctl_wmem ? */
2849 if (proto->sysctl_wmem_offset)
2850 return *(int *)((void *)sock_net(sk) + proto->sysctl_wmem_offset);
2851
2852 return *proto->sysctl_wmem;
2853}
2854
2855static inline int sk_get_rmem0(const struct sock *sk, const struct proto *proto)
2856{
2857 /* Does this proto have per netns sysctl_rmem ? */
2858 if (proto->sysctl_rmem_offset)
2859 return *(int *)((void *)sock_net(sk) + proto->sysctl_rmem_offset);
2860
2861 return *proto->sysctl_rmem;
2862}
2863
c9f1f58d
ED
2864/* Default TCP Small queue budget is ~1 ms of data (1sec >> 10)
2865 * Some wifi drivers need to tweak it to get more chunks.
2866 * They can use this helper from their ndo_start_xmit()
2867 */
2868static inline void sk_pacing_shift_update(struct sock *sk, int val)
2869{
7c68fa2b 2870 if (!sk || !sk_fullsock(sk) || READ_ONCE(sk->sk_pacing_shift) == val)
c9f1f58d 2871 return;
7c68fa2b 2872 WRITE_ONCE(sk->sk_pacing_shift, val);
c9f1f58d
ED
2873}
2874
54dc3e33
DA
2875/* if a socket is bound to a device, check that the given device
2876 * index is either the same or that the socket is bound to an L3
2877 * master device and the given device index is also enslaved to
2878 * that L3 master
2879 */
2880static inline bool sk_dev_equal_l3scope(struct sock *sk, int dif)
2881{
4c971d2f 2882 int bound_dev_if = READ_ONCE(sk->sk_bound_dev_if);
54dc3e33
DA
2883 int mdif;
2884
4c971d2f 2885 if (!bound_dev_if || bound_dev_if == dif)
54dc3e33
DA
2886 return true;
2887
2888 mdif = l3mdev_master_ifindex_by_index(sock_net(sk), dif);
4c971d2f 2889 if (mdif && mdif == bound_dev_if)
54dc3e33
DA
2890 return true;
2891
2892 return false;
2893}
2894
43a825af
BT
2895void sock_def_readable(struct sock *sk);
2896
8ea204c2 2897int sock_bindtoindex(struct sock *sk, int ifindex, bool lock_sk);
371087aa 2898void sock_set_timestamp(struct sock *sk, int optname, bool valbool);
d463126e
YL
2899int sock_set_timestamping(struct sock *sk, int optname,
2900 struct so_timestamping timestamping);
ced122d9 2901
783da70e 2902void sock_enable_timestamps(struct sock *sk);
c433594c 2903void sock_no_linger(struct sock *sk);
ce3d9544 2904void sock_set_keepalive(struct sock *sk);
6e434967 2905void sock_set_priority(struct sock *sk, u32 priority);
26cfabf9 2906void sock_set_rcvbuf(struct sock *sk, int val);
84d1c617 2907void sock_set_mark(struct sock *sk, u32 val);
b58f0e8f 2908void sock_set_reuseaddr(struct sock *sk);
fe31a326 2909void sock_set_reuseport(struct sock *sk);
76ee0785 2910void sock_set_sndtimeo(struct sock *sk, s64 secs);
b58f0e8f 2911
c0425a42
CH
2912int sock_bind_add(struct sock *sk, struct sockaddr *addr, int addr_len);
2913
4c1e34c0
RP
2914int sock_get_timeout(long timeo, void *optval, bool old_timeval);
2915int sock_copy_user_timeval(struct __kernel_sock_timeval *tv,
2916 sockptr_t optval, int optlen, bool old_timeval);
2917
7b50ecfc
CW
2918static inline bool sk_is_readable(struct sock *sk)
2919{
2920 if (sk->sk_prot->sock_is_readable)
2921 return sk->sk_prot->sock_is_readable(sk);
2922 return false;
2923}
1da177e4 2924#endif /* _SOCK_H */