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