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