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