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