sock.h 78.4 KB
Newer Older
1
/* SPDX-License-Identifier: GPL-2.0-or-later */
L
Linus Torvalds 已提交
2 3 4 5 6 7 8 9 10
/*
 * INET		An implementation of the TCP/IP protocol suite for the LINUX
 *		operating system.  INET is implemented using the  BSD Socket
 *		interface as the means of communication with the user level.
 *
 *		Definitions for the AF_INET socket handler.
 *
 * Version:	@(#)sock.h	1.0.4	05/13/93
 *
11
 * Authors:	Ross Biro
L
Linus Torvalds 已提交
12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37
 *		Fred N. van Kempen, <waltje@uWalt.NL.Mugnet.ORG>
 *		Corey Minyard <wf-rch!minyard@relay.EU.net>
 *		Florian La Roche <flla@stud.uni-sb.de>
 *
 * Fixes:
 *		Alan Cox	:	Volatiles in skbuff pointers. See
 *					skbuff comments. May be overdone,
 *					better to prove they can be removed
 *					than the reverse.
 *		Alan Cox	:	Added a zapped field for tcp to note
 *					a socket is reset and must stay shut up
 *		Alan Cox	:	New fields for options
 *	Pauline Middelink	:	identd support
 *		Alan Cox	:	Eliminate low level recv/recvfrom
 *		David S. Miller	:	New socket lookup architecture.
 *              Steve Whitehouse:       Default routines for sock_ops
 *              Arnaldo C. Melo :	removed net_pinfo, tp_pinfo and made
 *              			protinfo be just a void pointer, as the
 *              			protocol specific parts were moved to
 *              			respective headers and ipv4/v6, etc now
 *              			use private slabcaches for its socks
 *              Pedro Hortas	:	New flags field for socket options
 */
#ifndef _SOCK_H
#define _SOCK_H

38
#include <linux/hardirq.h>
39
#include <linux/kernel.h>
L
Linus Torvalds 已提交
40
#include <linux/list.h>
41
#include <linux/list_nulls.h>
L
Linus Torvalds 已提交
42 43
#include <linux/timer.h>
#include <linux/cache.h>
44
#include <linux/bitops.h>
I
Ingo Molnar 已提交
45
#include <linux/lockdep.h>
L
Linus Torvalds 已提交
46 47
#include <linux/netdevice.h>
#include <linux/skbuff.h>	/* struct sk_buff */
A
Al Viro 已提交
48
#include <linux/mm.h>
L
Linus Torvalds 已提交
49
#include <linux/security.h>
50
#include <linux/slab.h>
51
#include <linux/uaccess.h>
52
#include <linux/page_counter.h>
53
#include <linux/memcontrol.h>
54
#include <linux/static_key.h>
A
Al Viro 已提交
55
#include <linux/sched.h>
H
Herbert Xu 已提交
56
#include <linux/wait.h>
57
#include <linux/cgroup-defs.h>
58
#include <linux/rbtree.h>
L
Linus Torvalds 已提交
59
#include <linux/filter.h>
60
#include <linux/rculist_nulls.h>
61
#include <linux/poll.h>
62
#include <linux/sockptr.h>
63
#include <linux/indirect_call_wrapper.h>
E
Eric Dumazet 已提交
64
#include <linux/atomic.h>
65
#include <linux/refcount.h>
L
Linus Torvalds 已提交
66 67
#include <net/dst.h>
#include <net/checksum.h>
E
Eric Dumazet 已提交
68
#include <net/tcp_states.h>
69
#include <linux/net_tstamp.h>
70
#include <net/l3mdev.h>
71
#include <uapi/linux/socket.h>
L
Linus Torvalds 已提交
72 73 74 75 76 77 78 79 80 81 82 83 84

/*
 * This structure really needs to be cleaned up.
 * Most of it is for TCP, and not used by any of
 * the other protocols.
 */

/* Define this to get the SOCK_DBG debugging facility. */
#define SOCK_DEBUGGING
#ifdef SOCK_DEBUGGING
#define SOCK_DEBUG(sk, msg...) do { if ((sk) && sock_flag((sk), SOCK_DBG)) \
					printk(KERN_DEBUG msg); } while (0)
#else
85
/* Validate arguments and do nothing */
86
static inline __printf(2, 3)
E
Eric Dumazet 已提交
87
void SOCK_DEBUG(const struct sock *sk, const char *msg, ...)
88 89
{
}
L
Linus Torvalds 已提交
90 91 92 93 94 95 96 97
#endif

/* This is the per-socket lock.  The spinlock provides a synchronization
 * between user contexts and software interrupt processing, whereas the
 * mini-semaphore synchronizes multiple users amongst themselves.
 */
typedef struct {
	spinlock_t		slock;
98
	int			owned;
L
Linus Torvalds 已提交
99
	wait_queue_head_t	wq;
I
Ingo Molnar 已提交
100 101 102 103 104 105 106 107 108
	/*
	 * We express the mutex-alike socket_lock semantics
	 * to the lock validator by explicitly managing
	 * the slock as a lock variant (in addition to
	 * the slock itself):
	 */
#ifdef CONFIG_DEBUG_LOCK_ALLOC
	struct lockdep_map dep_map;
#endif
L
Linus Torvalds 已提交
109 110 111
} socket_lock_t;

struct sock;
112
struct proto;
113
struct net;
L
Linus Torvalds 已提交
114

115 116 117
typedef __u32 __bitwise __portpair;
typedef __u64 __bitwise __addrpair;

L
Linus Torvalds 已提交
118
/**
119
 *	struct sock_common - minimal network layer representation of sockets
120 121
 *	@skc_daddr: Foreign IPv4 addr
 *	@skc_rcv_saddr: Bound local IPv4 addr
122
 *	@skc_addrpair: 8-byte-aligned __u64 union of @skc_daddr & @skc_rcv_saddr
E
Eric Dumazet 已提交
123
 *	@skc_hash: hash value used with various protocol lookup tables
124
 *	@skc_u16hashes: two u16 hash values used by UDP lookup tables
125 126
 *	@skc_dport: placeholder for inet_dport/tw_dport
 *	@skc_num: placeholder for inet_num/tw_num
127
 *	@skc_portpair: __u32 union of @skc_dport & @skc_num
128 129 130
 *	@skc_family: network address family
 *	@skc_state: Connection state
 *	@skc_reuse: %SO_REUSEADDR setting
T
Tom Herbert 已提交
131
 *	@skc_reuseport: %SO_REUSEPORT setting
132 133
 *	@skc_ipv6only: socket is IPV6 only
 *	@skc_net_refcnt: socket is using net ref counting
134 135
 *	@skc_bound_dev_if: bound device index if != 0
 *	@skc_bind_node: bind hash linkage for various protocol lookup tables
136
 *	@skc_portaddr_node: second hash linkage for UDP/UDP-Lite protocol
137
 *	@skc_prot: protocol handlers inside a network family
138
 *	@skc_net: reference to the network namespace of this socket
139 140 141
 *	@skc_v6_daddr: IPV6 destination address
 *	@skc_v6_rcv_saddr: IPV6 source address
 *	@skc_cookie: socket's cookie value
142 143 144
 *	@skc_node: main hash linkage for various protocol lookup tables
 *	@skc_nulls_node: main hash linkage for TCP/UDP/UDP-Lite protocol
 *	@skc_tx_queue_mapping: tx queue number for this connection
145
 *	@skc_rx_queue_mapping: rx queue number for this connection
146 147 148
 *	@skc_flags: place holder for sk_flags
 *		%SO_LINGER (l_onoff), %SO_BROADCAST, %SO_KEEPALIVE,
 *		%SO_OOBINLINE settings, %SO_TIMESTAMPING settings
149 150 151 152
 *	@skc_listener: connection request listener socket (aka rsk_listener)
 *		[union with @skc_flags]
 *	@skc_tw_dr: (aka tw_dr) ptr to &struct inet_timewait_death_row
 *		[union with @skc_flags]
153
 *	@skc_incoming_cpu: record/match cpu processing incoming packets
154 155 156 157
 *	@skc_rcv_wnd: (aka rsk_rcv_wnd) TCP receive window size (possibly scaled)
 *		[union with @skc_incoming_cpu]
 *	@skc_tw_rcv_nxt: (aka tw_rcv_nxt) TCP window next expected seq number
 *		[union with @skc_incoming_cpu]
158
 *	@skc_refcnt: reference count
159 160
 *
 *	This is the minimal network layer representation of sockets, the header
161 162
 *	for struct sock and struct inet_timewait_sock.
 */
L
Linus Torvalds 已提交
163
struct sock_common {
164
	/* skc_daddr and skc_rcv_saddr must be grouped on a 8 bytes aligned
E
Eric Dumazet 已提交
165
	 * address on 64bit arches : cf INET_MATCH()
E
Eric Dumazet 已提交
166
	 */
167
	union {
168
		__addrpair	skc_addrpair;
169 170 171 172 173
		struct {
			__be32	skc_daddr;
			__be32	skc_rcv_saddr;
		};
	};
174 175 176 177
	union  {
		unsigned int	skc_hash;
		__u16		skc_u16hashes[2];
	};
178 179
	/* skc_dport && skc_num must be grouped as well */
	union {
180
		__portpair	skc_portpair;
181 182 183 184 185 186
		struct {
			__be16	skc_dport;
			__u16	skc_num;
		};
	};

E
Eric Dumazet 已提交
187 188
	unsigned short		skc_family;
	volatile unsigned char	skc_state;
T
Tom Herbert 已提交
189
	unsigned char		skc_reuse:4;
190 191
	unsigned char		skc_reuseport:1;
	unsigned char		skc_ipv6only:1;
192
	unsigned char		skc_net_refcnt:1;
E
Eric Dumazet 已提交
193
	int			skc_bound_dev_if;
194 195
	union {
		struct hlist_node	skc_bind_node;
196
		struct hlist_node	skc_portaddr_node;
197
	};
198
	struct proto		*skc_prot;
199
	possible_net_t		skc_net;
200 201 202 203 204 205

#if IS_ENABLED(CONFIG_IPV6)
	struct in6_addr		skc_v6_daddr;
	struct in6_addr		skc_v6_rcv_saddr;
#endif

E
Eric Dumazet 已提交
206 207
	atomic64_t		skc_cookie;

208 209 210 211 212 213 214 215 216 217
	/* following fields are padding to force
	 * offset(struct sock, sk_refcnt) == 128 on 64bit arches
	 * assuming IPV6 is enabled. We use this padding differently
	 * for different kind of 'sockets'
	 */
	union {
		unsigned long	skc_flags;
		struct sock	*skc_listener; /* request_sock */
		struct inet_timewait_death_row *skc_tw_dr; /* inet_timewait_sock */
	};
218 219 220 221
	/*
	 * fields between dontcopy_begin/dontcopy_end
	 * are not copied in sock_copy()
	 */
222
	/* private: */
223
	int			skc_dontcopy_begin[0];
224
	/* public: */
225 226 227 228
	union {
		struct hlist_node	skc_node;
		struct hlist_nulls_node skc_nulls_node;
	};
229
	unsigned short		skc_tx_queue_mapping;
230
#ifdef CONFIG_SOCK_RX_QUEUE_MAPPING
231 232
	unsigned short		skc_rx_queue_mapping;
#endif
233 234 235
	union {
		int		skc_incoming_cpu;
		u32		skc_rcv_wnd;
236
		u32		skc_tw_rcv_nxt; /* struct tcp_timewait_sock  */
237
	};
238

239
	refcount_t		skc_refcnt;
240
	/* private: */
241
	int                     skc_dontcopy_end[0];
242 243 244
	union {
		u32		skc_rxhash;
		u32		skc_window_clamp;
245
		u32		skc_tw_snd_nxt; /* struct tcp_timewait_sock */
246
	};
247
	/* public: */
L
Linus Torvalds 已提交
248 249
};

250
struct bpf_local_storage;
251

L
Linus Torvalds 已提交
252 253
/**
  *	struct sock - network layer representation of sockets
254
  *	@__sk_common: shared layout with inet_timewait_sock
255 256 257
  *	@sk_shutdown: mask of %SEND_SHUTDOWN and/or %RCV_SHUTDOWN
  *	@sk_userlocks: %SO_SNDBUF and %SO_RCVBUF settings
  *	@sk_lock:	synchronizer
258
  *	@sk_kern_sock: True if sock is using kernel lock classes
259
  *	@sk_rcvbuf: size of receive buffer in bytes
260
  *	@sk_wq: sock wait queue and async head
S
Shawn Bohrer 已提交
261
  *	@sk_rx_dst: receive input route used by early demux
262
  *	@sk_dst_cache: destination cache
263
  *	@sk_dst_pending_confirm: need to confirm neighbour
264
  *	@sk_policy: flow policy
265
  *	@sk_rx_skb_cache: cache copy of recently accessed RX skb
266 267
  *	@sk_receive_queue: incoming packets
  *	@sk_wmem_alloc: transmit queue bytes committed
268
  *	@sk_tsq_flags: TCP Small Queues flags
269 270 271 272
  *	@sk_write_queue: Packet sending queue
  *	@sk_omem_alloc: "o" is "option" or "other"
  *	@sk_wmem_queued: persistent queue size
  *	@sk_forward_alloc: space allocated forward
E
Eliezer Tamir 已提交
273
  *	@sk_napi_id: id of the last napi context to receive data for sk
274
  *	@sk_ll_usec: usecs to busypoll when there is no data
275
  *	@sk_allocation: allocation mode
E
Eric Dumazet 已提交
276
  *	@sk_pacing_rate: Pacing rate (if supported by transport/packet scheduler)
277
  *	@sk_pacing_status: Pacing status (requested, handled by sch_fq)
278
  *	@sk_max_pacing_rate: Maximum pacing rate (%SO_MAX_PACING_RATE)
279
  *	@sk_sndbuf: size of send buffer in bytes
280
  *	@__sk_flags_offset: empty field used to determine location of bitfield
281
  *	@sk_padding: unused element for alignment
282 283
  *	@sk_no_check_tx: %SO_NO_CHECK setting, set checksum in TX packets
  *	@sk_no_check_rx: allow zero checksum in RX packets
284
  *	@sk_route_caps: route capabilities (e.g. %NETIF_F_TSO)
E
Eric Dumazet 已提交
285
  *	@sk_route_nocaps: forbidden route capabilities (e.g NETIF_F_GSO_MASK)
286 287
  *	@sk_route_forced_caps: static, forced route capabilities
  *		(set in tcp_init_sock())
288
  *	@sk_gso_type: GSO type (e.g. %SKB_GSO_TCPV4)
289
  *	@sk_gso_max_size: Maximum GSO segment size to build
290
  *	@sk_gso_max_segs: Maximum number of GSO segments
291
  *	@sk_pacing_shift: scaling factor for TCP Small Queues
292 293 294 295
  *	@sk_lingertime: %SO_LINGER l_linger setting
  *	@sk_backlog: always used with the per-socket spinlock held
  *	@sk_callback_lock: used with the callbacks in the end of this struct
  *	@sk_error_queue: rarely used
W
Wang Chen 已提交
296 297
  *	@sk_prot_creator: sk_prot of original sock creator (see ipv6_setsockopt,
  *			  IPV6_ADDRFORM for instance)
298
  *	@sk_err: last error
W
Wang Chen 已提交
299 300
  *	@sk_err_soft: errors that don't cause failure but are the cause of a
  *		      persistent failure not just 'timed out'
E
Eric Dumazet 已提交
301
  *	@sk_drops: raw/udp drops counter
302 303
  *	@sk_ack_backlog: current listen backlog
  *	@sk_max_ack_backlog: listen backlog set in listen()
304
  *	@sk_uid: user id of owner
305
  *	@sk_prefer_busy_poll: prefer busypolling over softirq processing
306
  *	@sk_busy_poll_budget: napi processing budget when busypolling
307 308 309
  *	@sk_priority: %SO_PRIORITY setting
  *	@sk_type: socket type (%SOCK_STREAM, etc)
  *	@sk_protocol: which protocol this socket belongs in this network family
310 311
  *	@sk_peer_pid: &struct pid for this socket's peer
  *	@sk_peer_cred: %SO_PEERCRED setting
312 313 314
  *	@sk_rcvlowat: %SO_RCVLOWAT setting
  *	@sk_rcvtimeo: %SO_RCVTIMEO setting
  *	@sk_sndtimeo: %SO_SNDTIMEO setting
315
  *	@sk_txhash: computed flow hash for use on transmit
316 317 318
  *	@sk_filter: socket filtering instructions
  *	@sk_timer: sock cleanup timer
  *	@sk_stamp: time stamp of last packet received
319
  *	@sk_stamp_seq: lock for accessing sk_stamp on 32 bit architectures only
320 321 322
  *	@sk_tsflags: SO_TIMESTAMPING flags
  *	@sk_bind_phc: SO_TIMESTAMPING bind PHC index of PTP virtual clock
  *	              for timestamping
323
  *	@sk_tskey: counter to disambiguate concurrent tstamp requests
W
Willem de Bruijn 已提交
324
  *	@sk_zckey: counter to order MSG_ZEROCOPY notifications
325 326
  *	@sk_socket: Identd and reporting IO signals
  *	@sk_user_data: RPC layer private data
327
  *	@sk_frag: cached page frag
328
  *	@sk_peek_off: current peek_offset value
329
  *	@sk_send_head: front of stuff to transmit
330 331
  *	@tcp_rtx_queue: TCP re-transmit queue [union with @sk_send_head]
  *	@sk_tx_skb_cache: cache copy of recently accessed TX skb
332
  *	@sk_security: used by security modules
333
  *	@sk_mark: generic packet mark
334
  *	@sk_cgrp_data: cgroup data for this cgroup
335
  *	@sk_memcg: this socket's memory cgroup association
336 337 338 339 340 341
  *	@sk_write_pending: a write to stream socket waits to start
  *	@sk_state_change: callback to indicate change in the state of the sock
  *	@sk_data_ready: callback to indicate there is data to be processed
  *	@sk_write_space: callback to indicate there is bf sending space available
  *	@sk_error_report: callback to indicate errors (e.g. %MSG_ERRQUEUE)
  *	@sk_backlog_rcv: callback to process the backlog
342
  *	@sk_validate_xmit_skb: ptr to an optional validate function
343
  *	@sk_destruct: called at sock freeing time, i.e. when all refcnt == 0
344
  *	@sk_reuseport_cb: reuseport group container
345
  *	@sk_bpf_storage: ptr to cache and control for bpf_sk_storage
346
  *	@sk_rcu: used during RCU grace period
347 348
  *	@sk_clockid: clockid used by time-based scheduling (SO_TXTIME)
  *	@sk_txtime_deadline_mode: set deadline mode for SO_TXTIME
349
  *	@sk_txtime_report_errors: set report errors mode for SO_TXTIME
350
  *	@sk_txtime_unused: unused txtime flags
351
  */
L
Linus Torvalds 已提交
352 353
struct sock {
	/*
354
	 * Now struct inet_timewait_sock also uses sock_common, so please just
L
Linus Torvalds 已提交
355 356 357
	 * don't add nothing before this first member (__sk_common) --acme
	 */
	struct sock_common	__sk_common;
E
Eric Dumazet 已提交
358 359 360
#define sk_node			__sk_common.skc_node
#define sk_nulls_node		__sk_common.skc_nulls_node
#define sk_refcnt		__sk_common.skc_refcnt
K
Krishna Kumar 已提交
361
#define sk_tx_queue_mapping	__sk_common.skc_tx_queue_mapping
362
#ifdef CONFIG_SOCK_RX_QUEUE_MAPPING
363 364
#define sk_rx_queue_mapping	__sk_common.skc_rx_queue_mapping
#endif
E
Eric Dumazet 已提交
365

366 367
#define sk_dontcopy_begin	__sk_common.skc_dontcopy_begin
#define sk_dontcopy_end		__sk_common.skc_dontcopy_end
E
Eric Dumazet 已提交
368
#define sk_hash			__sk_common.skc_hash
E
Eric Dumazet 已提交
369
#define sk_portpair		__sk_common.skc_portpair
E
Eric Dumazet 已提交
370 371
#define sk_num			__sk_common.skc_num
#define sk_dport		__sk_common.skc_dport
E
Eric Dumazet 已提交
372 373 374
#define sk_addrpair		__sk_common.skc_addrpair
#define sk_daddr		__sk_common.skc_daddr
#define sk_rcv_saddr		__sk_common.skc_rcv_saddr
L
Linus Torvalds 已提交
375 376 377
#define sk_family		__sk_common.skc_family
#define sk_state		__sk_common.skc_state
#define sk_reuse		__sk_common.skc_reuse
T
Tom Herbert 已提交
378
#define sk_reuseport		__sk_common.skc_reuseport
379
#define sk_ipv6only		__sk_common.skc_ipv6only
380
#define sk_net_refcnt		__sk_common.skc_net_refcnt
L
Linus Torvalds 已提交
381 382
#define sk_bound_dev_if		__sk_common.skc_bound_dev_if
#define sk_bind_node		__sk_common.skc_bind_node
383
#define sk_prot			__sk_common.skc_prot
384
#define sk_net			__sk_common.skc_net
385 386
#define sk_v6_daddr		__sk_common.skc_v6_daddr
#define sk_v6_rcv_saddr	__sk_common.skc_v6_rcv_saddr
E
Eric Dumazet 已提交
387
#define sk_cookie		__sk_common.skc_cookie
388
#define sk_incoming_cpu		__sk_common.skc_incoming_cpu
389
#define sk_flags		__sk_common.skc_flags
390
#define sk_rxhash		__sk_common.skc_rxhash
391

L
Linus Torvalds 已提交
392
	socket_lock_t		sk_lock;
393 394 395
	atomic_t		sk_drops;
	int			sk_rcvlowat;
	struct sk_buff_head	sk_error_queue;
E
Eric Dumazet 已提交
396
	struct sk_buff		*sk_rx_skb_cache;
E
Eric Dumazet 已提交
397
	struct sk_buff_head	sk_receive_queue;
398 399 400 401
	/*
	 * The backlog queue is special, it is always used with
	 * the per-socket spinlock held and requires low latency
	 * access. Therefore we special case it's implementation.
E
Eric Dumazet 已提交
402 403 404
	 * Note : rmem_alloc is in this structure to fill a hole
	 * on 64bit arches, not because its logically part of
	 * backlog.
405 406
	 */
	struct {
E
Eric Dumazet 已提交
407 408 409 410
		atomic_t	rmem_alloc;
		int		len;
		struct sk_buff	*head;
		struct sk_buff	*tail;
411
	} sk_backlog;
E
Eric Dumazet 已提交
412
#define sk_rmem_alloc sk_backlog.rmem_alloc
E
Eric Dumazet 已提交
413

414
	int			sk_forward_alloc;
415
#ifdef CONFIG_NET_RX_BUSY_POLL
416
	unsigned int		sk_ll_usec;
417 418
	/* ===== mostly read cache line ===== */
	unsigned int		sk_napi_id;
E
Eric Dumazet 已提交
419 420 421 422
#endif
	int			sk_rcvbuf;

	struct sk_filter __rcu	*sk_filter;
423 424
	union {
		struct socket_wq __rcu	*sk_wq;
425
		/* private: */
426
		struct socket_wq	*sk_wq_raw;
427
		/* public: */
428
	};
429
#ifdef CONFIG_XFRM
430
	struct xfrm_policy __rcu *sk_policy[2];
431
#endif
E
Eric Dumazet 已提交
432
	struct dst_entry	*sk_rx_dst;
433
	struct dst_entry __rcu	*sk_dst_cache;
L
Linus Torvalds 已提交
434
	atomic_t		sk_omem_alloc;
435
	int			sk_sndbuf;
436 437 438

	/* ===== cache line for TX ===== */
	int			sk_wmem_queued;
439
	refcount_t		sk_wmem_alloc;
440
	unsigned long		sk_tsq_flags;
441 442 443 444
	union {
		struct sk_buff	*sk_send_head;
		struct rb_root	tcp_rtx_queue;
	};
E
Eric Dumazet 已提交
445
	struct sk_buff		*sk_tx_skb_cache;
L
Linus Torvalds 已提交
446
	struct sk_buff_head	sk_write_queue;
447 448
	__s32			sk_peek_off;
	int			sk_write_pending;
449
	__u32			sk_dst_pending_confirm;
450
	u32			sk_pacing_status; /* see enum sk_pacing */
451 452 453 454
	long			sk_sndtimeo;
	struct timer_list	sk_timer;
	__u32			sk_priority;
	__u32			sk_mark;
455 456
	unsigned long		sk_pacing_rate; /* bytes per second */
	unsigned long		sk_max_pacing_rate;
457 458 459
	struct page_frag	sk_frag;
	netdev_features_t	sk_route_caps;
	netdev_features_t	sk_route_nocaps;
460
	netdev_features_t	sk_route_forced_caps;
461 462 463 464
	int			sk_gso_type;
	unsigned int		sk_gso_max_size;
	gfp_t			sk_allocation;
	__u32			sk_txhash;
465 466 467 468 469

	/*
	 * Because of non atomicity rules, all
	 * changes are protected by socket lock.
	 */
470
	u8			sk_padding : 1,
471
				sk_kern_sock : 1,
472 473
				sk_no_check_tx : 1,
				sk_no_check_rx : 1,
474
				sk_userlocks : 4;
475
	u8			sk_pacing_shift;
476 477 478
	u16			sk_type;
	u16			sk_protocol;
	u16			sk_gso_max_segs;
L
Linus Torvalds 已提交
479
	unsigned long	        sk_lingertime;
480
	struct proto		*sk_prot_creator;
L
Linus Torvalds 已提交
481 482 483
	rwlock_t		sk_callback_lock;
	int			sk_err,
				sk_err_soft;
484 485
	u32			sk_ack_backlog;
	u32			sk_max_ack_backlog;
486
	kuid_t			sk_uid;
487 488
#ifdef CONFIG_NET_RX_BUSY_POLL
	u8			sk_prefer_busy_poll;
489
	u16			sk_busy_poll_budget;
490
#endif
491 492
	struct pid		*sk_peer_pid;
	const struct cred	*sk_peer_cred;
L
Linus Torvalds 已提交
493
	long			sk_rcvtimeo;
494
	ktime_t			sk_stamp;
495 496 497
#if BITS_PER_LONG==32
	seqlock_t		sk_stamp_seq;
#endif
498
	u16			sk_tsflags;
499
	int			sk_bind_phc;
500
	u8			sk_shutdown;
501
	u32			sk_tskey;
W
Willem de Bruijn 已提交
502
	atomic_t		sk_zckey;
503 504 505

	u8			sk_clockid;
	u8			sk_txtime_deadline_mode : 1,
506 507
				sk_txtime_report_errors : 1,
				sk_txtime_unused : 6;
508

L
Linus Torvalds 已提交
509 510
	struct socket		*sk_socket;
	void			*sk_user_data;
A
Alexey Dobriyan 已提交
511
#ifdef CONFIG_SECURITY
L
Linus Torvalds 已提交
512
	void			*sk_security;
A
Alexey Dobriyan 已提交
513
#endif
514
	struct sock_cgroup_data	sk_cgrp_data;
515
	struct mem_cgroup	*sk_memcg;
L
Linus Torvalds 已提交
516
	void			(*sk_state_change)(struct sock *sk);
517
	void			(*sk_data_ready)(struct sock *sk);
L
Linus Torvalds 已提交
518 519
	void			(*sk_write_space)(struct sock *sk);
	void			(*sk_error_report)(struct sock *sk);
E
Eric Dumazet 已提交
520 521
	int			(*sk_backlog_rcv)(struct sock *sk,
						  struct sk_buff *skb);
522 523 524 525 526
#ifdef CONFIG_SOCK_VALIDATE_XMIT
	struct sk_buff*		(*sk_validate_xmit_skb)(struct sock *sk,
							struct net_device *dev,
							struct sk_buff *skb);
#endif
L
Linus Torvalds 已提交
527
	void                    (*sk_destruct)(struct sock *sk);
528
	struct sock_reuseport __rcu	*sk_reuseport_cb;
529
#ifdef CONFIG_BPF_SYSCALL
530
	struct bpf_local_storage __rcu	*sk_bpf_storage;
531
#endif
532
	struct rcu_head		sk_rcu;
L
Linus Torvalds 已提交
533 534
};

535 536 537 538 539 540
enum sk_pacing {
	SK_PACING_NONE		= 0,
	SK_PACING_NEEDED	= 1,
	SK_PACING_FQ		= 2,
};

541 542 543 544 545 546
/* Pointer stored in sk_user_data might not be suitable for copying
 * when cloning the socket. For instance, it can point to a reference
 * counted object. sk_user_data bottom bit is set if pointer must not
 * be copied.
 */
#define SK_USER_DATA_NOCOPY	1UL
547 548
#define SK_USER_DATA_BPF	2UL	/* Managed by BPF */
#define SK_USER_DATA_PTRMASK	~(SK_USER_DATA_NOCOPY | SK_USER_DATA_BPF)
549 550 551 552 553 554 555 556 557 558

/**
 * sk_user_data_is_nocopy - Test if sk_user_data pointer must not be copied
 * @sk: socket
 */
static inline bool sk_user_data_is_nocopy(const struct sock *sk)
{
	return ((uintptr_t)sk->sk_user_data & SK_USER_DATA_NOCOPY);
}

559 560
#define __sk_user_data(sk) ((*((void __rcu **)&(sk)->sk_user_data)))

561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578
#define rcu_dereference_sk_user_data(sk)				\
({									\
	void *__tmp = rcu_dereference(__sk_user_data((sk)));		\
	(void *)((uintptr_t)__tmp & SK_USER_DATA_PTRMASK);		\
})
#define rcu_assign_sk_user_data(sk, ptr)				\
({									\
	uintptr_t __tmp = (uintptr_t)(ptr);				\
	WARN_ON_ONCE(__tmp & ~SK_USER_DATA_PTRMASK);			\
	rcu_assign_pointer(__sk_user_data((sk)), __tmp);		\
})
#define rcu_assign_sk_user_data_nocopy(sk, ptr)				\
({									\
	uintptr_t __tmp = (uintptr_t)(ptr);				\
	WARN_ON_ONCE(__tmp & ~SK_USER_DATA_PTRMASK);			\
	rcu_assign_pointer(__sk_user_data((sk)),			\
			   __tmp | SK_USER_DATA_NOCOPY);		\
})
579

580 581 582 583 584 585 586 587 588 589 590
/*
 * SK_CAN_REUSE and SK_NO_REUSE on a socket mean that the socket is OK
 * or not whether his port will be reused by someone else. SK_FORCE_REUSE
 * on a socket means that the socket will reuse everybody else's port
 * without looking at the other's sk_reuse value.
 */

#define SK_NO_REUSE	0
#define SK_CAN_REUSE	1
#define SK_FORCE_REUSE	2

591 592
int sk_set_peek_off(struct sock *sk, int val);

593 594
static inline int sk_peek_offset(struct sock *sk, int flags)
{
595
	if (unlikely(flags & MSG_PEEK)) {
596
		return READ_ONCE(sk->sk_peek_off);
597 598 599
	}

	return 0;
600 601 602 603
}

static inline void sk_peek_offset_bwd(struct sock *sk, int val)
{
604 605 606 607 608
	s32 off = READ_ONCE(sk->sk_peek_off);

	if (unlikely(off >= 0)) {
		off = max_t(s32, off - val, 0);
		WRITE_ONCE(sk->sk_peek_off, off);
609 610 611 612 613
	}
}

static inline void sk_peek_offset_fwd(struct sock *sk, int val)
{
614
	sk_peek_offset_bwd(sk, -val);
615 616
}

L
Linus Torvalds 已提交
617 618 619
/*
 * Hashed lists helper routines
 */
L
Li Zefan 已提交
620 621 622 623 624
static inline struct sock *sk_entry(const struct hlist_node *node)
{
	return hlist_entry(node, struct sock, sk_node);
}

625
static inline struct sock *__sk_head(const struct hlist_head *head)
L
Linus Torvalds 已提交
626 627 628 629
{
	return hlist_entry(head->first, struct sock, sk_node);
}

630
static inline struct sock *sk_head(const struct hlist_head *head)
L
Linus Torvalds 已提交
631 632 633 634
{
	return hlist_empty(head) ? NULL : __sk_head(head);
}

635 636 637 638 639 640 641 642 643 644
static inline struct sock *__sk_nulls_head(const struct hlist_nulls_head *head)
{
	return hlist_nulls_entry(head->first, struct sock, sk_nulls_node);
}

static inline struct sock *sk_nulls_head(const struct hlist_nulls_head *head)
{
	return hlist_nulls_empty(head) ? NULL : __sk_nulls_head(head);
}

645
static inline struct sock *sk_next(const struct sock *sk)
L
Linus Torvalds 已提交
646
{
G
Geliang Tang 已提交
647
	return hlist_entry_safe(sk->sk_node.next, struct sock, sk_node);
L
Linus Torvalds 已提交
648 649
}

650 651 652 653 654 655 656 657
static inline struct sock *sk_nulls_next(const struct sock *sk)
{
	return (!is_a_nulls(sk->sk_nulls_node.next)) ?
		hlist_nulls_entry(sk->sk_nulls_node.next,
				  struct sock, sk_nulls_node) :
		NULL;
}

E
Eric Dumazet 已提交
658
static inline bool sk_unhashed(const struct sock *sk)
L
Linus Torvalds 已提交
659 660 661 662
{
	return hlist_unhashed(&sk->sk_node);
}

E
Eric Dumazet 已提交
663
static inline bool sk_hashed(const struct sock *sk)
L
Linus Torvalds 已提交
664
{
A
Akinobu Mita 已提交
665
	return !sk_unhashed(sk);
L
Linus Torvalds 已提交
666 667
}

E
Eric Dumazet 已提交
668
static inline void sk_node_init(struct hlist_node *node)
L
Linus Torvalds 已提交
669 670 671 672
{
	node->pprev = NULL;
}

E
Eric Dumazet 已提交
673
static inline void sk_nulls_node_init(struct hlist_nulls_node *node)
674 675 676 677
{
	node->pprev = NULL;
}

E
Eric Dumazet 已提交
678
static inline void __sk_del_node(struct sock *sk)
L
Linus Torvalds 已提交
679 680 681 682
{
	__hlist_del(&sk->sk_node);
}

683
/* NB: equivalent to hlist_del_init_rcu */
E
Eric Dumazet 已提交
684
static inline bool __sk_del_node_init(struct sock *sk)
L
Linus Torvalds 已提交
685 686 687 688
{
	if (sk_hashed(sk)) {
		__sk_del_node(sk);
		sk_node_init(&sk->sk_node);
E
Eric Dumazet 已提交
689
		return true;
L
Linus Torvalds 已提交
690
	}
E
Eric Dumazet 已提交
691
	return false;
L
Linus Torvalds 已提交
692 693 694 695 696 697 698 699
}

/* Grab socket reference count. This operation is valid only
   when sk is ALREADY grabbed f.e. it is found in hash table
   or a list and the lookup is made under lock preventing hash table
   modifications.
 */

700
static __always_inline void sock_hold(struct sock *sk)
L
Linus Torvalds 已提交
701
{
702
	refcount_inc(&sk->sk_refcnt);
L
Linus Torvalds 已提交
703 704 705 706 707
}

/* Ungrab socket in the context, which assumes that socket refcnt
   cannot hit zero, f.e. it is true in context of any socketcall.
 */
708
static __always_inline void __sock_put(struct sock *sk)
L
Linus Torvalds 已提交
709
{
710
	refcount_dec(&sk->sk_refcnt);
L
Linus Torvalds 已提交
711 712
}

E
Eric Dumazet 已提交
713
static inline bool sk_del_node_init(struct sock *sk)
L
Linus Torvalds 已提交
714
{
E
Eric Dumazet 已提交
715
	bool rc = __sk_del_node_init(sk);
L
Linus Torvalds 已提交
716 717 718

	if (rc) {
		/* paranoid for a while -acme */
719
		WARN_ON(refcount_read(&sk->sk_refcnt) == 1);
L
Linus Torvalds 已提交
720 721 722 723
		__sock_put(sk);
	}
	return rc;
}
724
#define sk_del_node_init_rcu(sk)	sk_del_node_init(sk)
L
Linus Torvalds 已提交
725

E
Eric Dumazet 已提交
726
static inline bool __sk_nulls_del_node_init_rcu(struct sock *sk)
727 728
{
	if (sk_hashed(sk)) {
729
		hlist_nulls_del_init_rcu(&sk->sk_nulls_node);
E
Eric Dumazet 已提交
730
		return true;
731
	}
E
Eric Dumazet 已提交
732
	return false;
733 734
}

E
Eric Dumazet 已提交
735
static inline bool sk_nulls_del_node_init_rcu(struct sock *sk)
736
{
E
Eric Dumazet 已提交
737
	bool rc = __sk_nulls_del_node_init_rcu(sk);
738 739 740

	if (rc) {
		/* paranoid for a while -acme */
741
		WARN_ON(refcount_read(&sk->sk_refcnt) == 1);
742 743 744 745 746
		__sock_put(sk);
	}
	return rc;
}

E
Eric Dumazet 已提交
747
static inline void __sk_add_node(struct sock *sk, struct hlist_head *list)
L
Linus Torvalds 已提交
748 749 750 751
{
	hlist_add_head(&sk->sk_node, list);
}

E
Eric Dumazet 已提交
752
static inline void sk_add_node(struct sock *sk, struct hlist_head *list)
L
Linus Torvalds 已提交
753 754 755 756 757
{
	sock_hold(sk);
	__sk_add_node(sk, list);
}

E
Eric Dumazet 已提交
758
static inline void sk_add_node_rcu(struct sock *sk, struct hlist_head *list)
759 760
{
	sock_hold(sk);
761 762 763 764 765
	if (IS_ENABLED(CONFIG_IPV6) && sk->sk_reuseport &&
	    sk->sk_family == AF_INET6)
		hlist_add_tail_rcu(&sk->sk_node, list);
	else
		hlist_add_head_rcu(&sk->sk_node, list);
766 767
}

768 769 770 771 772 773
static inline void sk_add_node_tail_rcu(struct sock *sk, struct hlist_head *list)
{
	sock_hold(sk);
	hlist_add_tail_rcu(&sk->sk_node, list);
}

E
Eric Dumazet 已提交
774
static inline void __sk_nulls_add_node_rcu(struct sock *sk, struct hlist_nulls_head *list)
775
{
776
	hlist_nulls_add_head_rcu(&sk->sk_nulls_node, list);
777 778
}

779 780 781 782 783
static inline void __sk_nulls_add_node_tail_rcu(struct sock *sk, struct hlist_nulls_head *list)
{
	hlist_nulls_add_tail_rcu(&sk->sk_nulls_node, list);
}

E
Eric Dumazet 已提交
784
static inline void sk_nulls_add_node_rcu(struct sock *sk, struct hlist_nulls_head *list)
785 786
{
	sock_hold(sk);
787
	__sk_nulls_add_node_rcu(sk, list);
788 789
}

E
Eric Dumazet 已提交
790
static inline void __sk_del_bind_node(struct sock *sk)
L
Linus Torvalds 已提交
791 792 793 794
{
	__hlist_del(&sk->sk_bind_node);
}

E
Eric Dumazet 已提交
795
static inline void sk_add_bind_node(struct sock *sk,
L
Linus Torvalds 已提交
796 797 798 799 800
					struct hlist_head *list)
{
	hlist_add_head(&sk->sk_bind_node, list);
}

801 802 803 804
#define sk_for_each(__sk, list) \
	hlist_for_each_entry(__sk, list, sk_node)
#define sk_for_each_rcu(__sk, list) \
	hlist_for_each_entry_rcu(__sk, list, sk_node)
805 806 807 808
#define sk_nulls_for_each(__sk, node, list) \
	hlist_nulls_for_each_entry(__sk, node, list, sk_nulls_node)
#define sk_nulls_for_each_rcu(__sk, node, list) \
	hlist_nulls_for_each_entry_rcu(__sk, node, list, sk_nulls_node)
809 810
#define sk_for_each_from(__sk) \
	hlist_for_each_entry_from(__sk, sk_node)
811 812 813
#define sk_nulls_for_each_from(__sk, node) \
	if (__sk && ({ node = &(__sk)->sk_nulls_node; 1; })) \
		hlist_nulls_for_each_entry_from(__sk, node, sk_nulls_node)
814 815 816 817
#define sk_for_each_safe(__sk, tmp, list) \
	hlist_for_each_entry_safe(__sk, tmp, list, sk_node)
#define sk_for_each_bound(__sk, list) \
	hlist_for_each_entry(__sk, list, sk_bind_node)
L
Linus Torvalds 已提交
818

819
/**
820
 * sk_for_each_entry_offset_rcu - iterate over a list at a given struct offset
821 822 823 824 825 826
 * @tpos:	the type * to use as a loop cursor.
 * @pos:	the &struct hlist_node to use as a loop cursor.
 * @head:	the head for your list.
 * @offset:	offset of hlist_node within the struct.
 *
 */
827
#define sk_for_each_entry_offset_rcu(tpos, pos, head, offset)		       \
828
	for (pos = rcu_dereference(hlist_first_rcu(head));		       \
829
	     pos != NULL &&						       \
830
		({ tpos = (typeof(*tpos) *)((void *)pos - offset); 1;});       \
831
	     pos = rcu_dereference(hlist_next_rcu(pos)))
832

E
Eric W. Biederman 已提交
833 834 835 836 837 838 839 840 841
static inline struct user_namespace *sk_user_ns(struct sock *sk)
{
	/* Careful only use this in a context where these parameters
	 * can not change and must all be valid, such as recvmsg from
	 * userspace.
	 */
	return sk->sk_socket->file->f_cred->user_ns;
}

L
Linus Torvalds 已提交
842 843 844 845 846 847 848 849 850 851 852 853 854 855
/* Sock flags */
enum sock_flags {
	SOCK_DEAD,
	SOCK_DONE,
	SOCK_URGINLINE,
	SOCK_KEEPOPEN,
	SOCK_LINGER,
	SOCK_DESTROY,
	SOCK_BROADCAST,
	SOCK_TIMESTAMP,
	SOCK_ZAPPED,
	SOCK_USE_WRITE_QUEUE, /* whether to call sk->sk_write_space in sock_wfree */
	SOCK_DBG, /* %SO_DEBUG setting */
	SOCK_RCVTSTAMP, /* %SO_TIMESTAMP setting */
856
	SOCK_RCVTSTAMPNS, /* %SO_TIMESTAMPNS setting */
L
Linus Torvalds 已提交
857
	SOCK_LOCALROUTE, /* route locally only, %SO_DONTROUTE setting */
858
	SOCK_MEMALLOC, /* VM depends on this socket for swapping */
859
	SOCK_TIMESTAMPING_RX_SOFTWARE,  /* %SOF_TIMESTAMPING_RX_SOFTWARE */
E
Eric Dumazet 已提交
860
	SOCK_FASYNC, /* fasync() active */
861
	SOCK_RXQ_OVFL,
862
	SOCK_ZEROCOPY, /* buffers from userspace */
863
	SOCK_WIFI_STATUS, /* push wifi status to userspace */
864 865 866 867
	SOCK_NOFCS, /* Tell NIC not to do the Ethernet FCS.
		     * Will use last 4 bytes of packet sent from
		     * user-space instead.
		     */
868
	SOCK_FILTER_LOCKED, /* Filter cannot be changed anymore */
869
	SOCK_SELECT_ERR_QUEUE, /* Wake select on error queue */
870
	SOCK_RCU_FREE, /* wait rcu grace period in sk_destruct() */
871
	SOCK_TXTIME,
J
Jason Wang 已提交
872
	SOCK_XDP, /* XDP is attached */
873
	SOCK_TSTAMP_NEW, /* Indicates 64 bit timestamps always */
L
Linus Torvalds 已提交
874 875
};

876 877
#define SK_FLAGS_TIMESTAMP ((1UL << SOCK_TIMESTAMP) | (1UL << SOCK_TIMESTAMPING_RX_SOFTWARE))

R
Ralf Baechle 已提交
878 879 880 881 882
static inline void sock_copy_flags(struct sock *nsk, struct sock *osk)
{
	nsk->sk_flags = osk->sk_flags;
}

L
Linus Torvalds 已提交
883 884 885 886 887 888 889 890 891 892
static inline void sock_set_flag(struct sock *sk, enum sock_flags flag)
{
	__set_bit(flag, &sk->sk_flags);
}

static inline void sock_reset_flag(struct sock *sk, enum sock_flags flag)
{
	__clear_bit(flag, &sk->sk_flags);
}

893 894 895 896 897 898 899 900 901
static inline void sock_valbool_flag(struct sock *sk, enum sock_flags bit,
				     int valbool)
{
	if (valbool)
		sock_set_flag(sk, bit);
	else
		sock_reset_flag(sk, bit);
}

E
Eric Dumazet 已提交
902
static inline bool sock_flag(const struct sock *sk, enum sock_flags flag)
L
Linus Torvalds 已提交
903 904 905 906
{
	return test_bit(flag, &sk->sk_flags);
}

907
#ifdef CONFIG_NET
908
DECLARE_STATIC_KEY_FALSE(memalloc_socks_key);
909 910
static inline int sk_memalloc_socks(void)
{
911
	return static_branch_unlikely(&memalloc_socks_key);
912
}
913 914

void __receive_sock(struct file *file);
915 916 917 918 919 920 921
#else

static inline int sk_memalloc_socks(void)
{
	return 0;
}

922 923
static inline void __receive_sock(struct file *file)
{ }
924 925
#endif

926
static inline gfp_t sk_gfp_mask(const struct sock *sk, gfp_t gfp_mask)
927
{
928
	return gfp_mask | (sk->sk_allocation & __GFP_MEMALLOC);
929 930
}

L
Linus Torvalds 已提交
931 932
static inline void sk_acceptq_removed(struct sock *sk)
{
933
	WRITE_ONCE(sk->sk_ack_backlog, sk->sk_ack_backlog - 1);
L
Linus Torvalds 已提交
934 935 936 937
}

static inline void sk_acceptq_added(struct sock *sk)
{
938
	WRITE_ONCE(sk->sk_ack_backlog, sk->sk_ack_backlog + 1);
L
Linus Torvalds 已提交
939 940
}

941 942 943 944
/* Note: If you think the test should be:
 *	return READ_ONCE(sk->sk_ack_backlog) >= READ_ONCE(sk->sk_max_ack_backlog);
 * Then please take a look at commit 64a146513f8f ("[NET]: Revert incorrect accept queue backlog changes.")
 */
E
Eric Dumazet 已提交
945
static inline bool sk_acceptq_is_full(const struct sock *sk)
L
Linus Torvalds 已提交
946
{
947
	return READ_ONCE(sk->sk_ack_backlog) > READ_ONCE(sk->sk_max_ack_backlog);
L
Linus Torvalds 已提交
948 949 950 951 952
}

/*
 * Compute minimal free write space needed to queue new packets.
 */
E
Eric Dumazet 已提交
953
static inline int sk_stream_min_wspace(const struct sock *sk)
L
Linus Torvalds 已提交
954
{
955
	return READ_ONCE(sk->sk_wmem_queued) >> 1;
L
Linus Torvalds 已提交
956 957
}

E
Eric Dumazet 已提交
958
static inline int sk_stream_wspace(const struct sock *sk)
L
Linus Torvalds 已提交
959
{
960 961 962 963 964 965
	return READ_ONCE(sk->sk_sndbuf) - READ_ONCE(sk->sk_wmem_queued);
}

static inline void sk_wmem_queued_add(struct sock *sk, int val)
{
	WRITE_ONCE(sk->sk_wmem_queued, sk->sk_wmem_queued + val);
L
Linus Torvalds 已提交
966 967
}

968
void sk_stream_write_space(struct sock *sk);
L
Linus Torvalds 已提交
969

Z
Zhu Yi 已提交
970
/* OOB backlog add */
Z
Zhu Yi 已提交
971
static inline void __sk_add_backlog(struct sock *sk, struct sk_buff *skb)
972
{
E
Eric Dumazet 已提交
973
	/* dont let skb dst not refcounted, we are going to leave rcu lock */
E
Eric Dumazet 已提交
974
	skb_dst_force(skb);
E
Eric Dumazet 已提交
975 976

	if (!sk->sk_backlog.tail)
977
		WRITE_ONCE(sk->sk_backlog.head, skb);
E
Eric Dumazet 已提交
978
	else
979
		sk->sk_backlog.tail->next = skb;
E
Eric Dumazet 已提交
980

981
	WRITE_ONCE(sk->sk_backlog.tail, skb);
982 983
	skb->next = NULL;
}
L
Linus Torvalds 已提交
984

985 986
/*
 * Take into account size of receive queue and backlog queue
E
Eric Dumazet 已提交
987 988
 * Do not take into account this skb truesize,
 * to allow even a single big packet to come.
989
 */
990
static inline bool sk_rcvqueues_full(const struct sock *sk, unsigned int limit)
991 992 993
{
	unsigned int qsize = sk->sk_backlog.len + atomic_read(&sk->sk_rmem_alloc);

994
	return qsize > limit;
995 996
}

Z
Zhu Yi 已提交
997
/* The per-socket spinlock must be held here. */
998 999
static inline __must_check int sk_add_backlog(struct sock *sk, struct sk_buff *skb,
					      unsigned int limit)
Z
Zhu Yi 已提交
1000
{
1001
	if (sk_rcvqueues_full(sk, limit))
Z
Zhu Yi 已提交
1002 1003
		return -ENOBUFS;

1004 1005 1006 1007 1008 1009 1010 1011
	/*
	 * If the skb was allocated from pfmemalloc reserves, only
	 * allow SOCK_MEMALLOC sockets to use it as this socket is
	 * helping free memory
	 */
	if (skb_pfmemalloc(skb) && !sock_flag(sk, SOCK_MEMALLOC))
		return -ENOMEM;

Z
Zhu Yi 已提交
1012
	__sk_add_backlog(sk, skb);
Z
Zhu Yi 已提交
1013 1014 1015 1016
	sk->sk_backlog.len += skb->truesize;
	return 0;
}

1017
int __sk_backlog_rcv(struct sock *sk, struct sk_buff *skb);
1018

P
Peter Zijlstra 已提交
1019 1020
static inline int sk_backlog_rcv(struct sock *sk, struct sk_buff *skb)
{
1021 1022 1023
	if (sk_memalloc_socks() && skb_pfmemalloc(skb))
		return __sk_backlog_rcv(sk, skb);

P
Peter Zijlstra 已提交
1024 1025 1026
	return sk->sk_backlog_rcv(sk, skb);
}

E
Eric Dumazet 已提交
1027 1028
static inline void sk_incoming_cpu_update(struct sock *sk)
{
1029 1030
	int cpu = raw_smp_processor_id();

1031 1032
	if (unlikely(READ_ONCE(sk->sk_incoming_cpu) != cpu))
		WRITE_ONCE(sk->sk_incoming_cpu, cpu);
E
Eric Dumazet 已提交
1033 1034
}

1035
static inline void sock_rps_record_flow_hash(__u32 hash)
1036 1037 1038 1039 1040 1041
{
#ifdef CONFIG_RPS
	struct rps_sock_flow_table *sock_flow_table;

	rcu_read_lock();
	sock_flow_table = rcu_dereference(rps_sock_flow_table);
1042
	rps_record_sock_flow(sock_flow_table, hash);
1043 1044 1045 1046
	rcu_read_unlock();
#endif
}

1047 1048
static inline void sock_rps_record_flow(const struct sock *sk)
{
1049
#ifdef CONFIG_RPS
1050
	if (static_branch_unlikely(&rfs_needed)) {
E
Eric Dumazet 已提交
1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063
		/* Reading sk->sk_rxhash might incur an expensive cache line
		 * miss.
		 *
		 * TCP_ESTABLISHED does cover almost all states where RFS
		 * might be useful, and is cheaper [1] than testing :
		 *	IPv4: inet_sk(sk)->inet_daddr
		 * 	IPv6: ipv6_addr_any(&sk->sk_v6_daddr)
		 * OR	an additional socket flag
		 * [1] : sk_state and sk_prot are in the same cache line.
		 */
		if (sk->sk_state == TCP_ESTABLISHED)
			sock_rps_record_flow_hash(sk->sk_rxhash);
	}
1064
#endif
1065 1066
}

1067 1068
static inline void sock_rps_save_rxhash(struct sock *sk,
					const struct sk_buff *skb)
1069 1070
{
#ifdef CONFIG_RPS
1071
	if (unlikely(sk->sk_rxhash != skb->hash))
1072
		sk->sk_rxhash = skb->hash;
1073 1074 1075
#endif
}

1076 1077 1078 1079 1080 1081 1082
static inline void sock_rps_reset_rxhash(struct sock *sk)
{
#ifdef CONFIG_RPS
	sk->sk_rxhash = 0;
#endif
}

W
WANG Cong 已提交
1083
#define sk_wait_event(__sk, __timeo, __condition, __wait)		\
S
Stephen Hemminger 已提交
1084 1085 1086 1087
	({	int __rc;						\
		release_sock(__sk);					\
		__rc = __condition;					\
		if (!__rc) {						\
W
WANG Cong 已提交
1088 1089 1090
			*(__timeo) = wait_woken(__wait,			\
						TASK_INTERRUPTIBLE,	\
						*(__timeo));		\
S
Stephen Hemminger 已提交
1091
		}							\
W
WANG Cong 已提交
1092
		sched_annotate_sleep();					\
S
Stephen Hemminger 已提交
1093 1094 1095 1096
		lock_sock(__sk);					\
		__rc = __condition;					\
		__rc;							\
	})
L
Linus Torvalds 已提交
1097

1098 1099 1100 1101 1102 1103 1104
int sk_stream_wait_connect(struct sock *sk, long *timeo_p);
int sk_stream_wait_memory(struct sock *sk, long *timeo_p);
void sk_stream_wait_close(struct sock *sk, long timeo_p);
int sk_stream_error(struct sock *sk, int flags, int err);
void sk_stream_kill_queues(struct sock *sk);
void sk_set_memalloc(struct sock *sk);
void sk_clear_memalloc(struct sock *sk);
L
Linus Torvalds 已提交
1105

1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116
void __sk_flush_backlog(struct sock *sk);

static inline bool sk_flush_backlog(struct sock *sk)
{
	if (unlikely(READ_ONCE(sk->sk_backlog.tail))) {
		__sk_flush_backlog(sk);
		return true;
	}
	return false;
}

1117
int sk_wait_data(struct sock *sk, long *timeo, const struct sk_buff *skb);
L
Linus Torvalds 已提交
1118

1119
struct request_sock_ops;
1120
struct timewait_sock_ops;
1121
struct inet_hashinfo;
1122
struct raw_hashinfo;
1123
struct smc_hashinfo;
1124
struct module;
1125
struct sk_psock;
1126

E
Eric Dumazet 已提交
1127
/*
1128
 * caches using SLAB_TYPESAFE_BY_RCU should let .next pointer from nulls nodes
E
Eric Dumazet 已提交
1129 1130 1131 1132 1133 1134 1135 1136 1137 1138
 * un-modified. Special care is taken when initializing object to zero.
 */
static inline void sk_prot_clear_nulls(struct sock *sk, int size)
{
	if (offsetof(struct sock, sk_node.next) != 0)
		memset(sk, 0, offsetof(struct sock, sk_node.next));
	memset(&sk->sk_node.pprev, 0,
	       size - offsetof(struct sock, sk_node.pprev));
}

L
Linus Torvalds 已提交
1139 1140 1141 1142
/* Networking protocol blocks we attach to sockets.
 * socket layer -> transport layer interface
 */
struct proto {
E
Eric Dumazet 已提交
1143
	void			(*close)(struct sock *sk,
L
Linus Torvalds 已提交
1144
					long timeout);
A
Andrey Ignatov 已提交
1145 1146 1147
	int			(*pre_connect)(struct sock *sk,
					struct sockaddr *uaddr,
					int addr_len);
L
Linus Torvalds 已提交
1148
	int			(*connect)(struct sock *sk,
E
Eric Dumazet 已提交
1149
					struct sockaddr *uaddr,
L
Linus Torvalds 已提交
1150 1151 1152
					int addr_len);
	int			(*disconnect)(struct sock *sk, int flags);

1153 1154
	struct sock *		(*accept)(struct sock *sk, int flags, int *err,
					  bool kern);
L
Linus Torvalds 已提交
1155 1156 1157 1158

	int			(*ioctl)(struct sock *sk, int cmd,
					 unsigned long arg);
	int			(*init)(struct sock *sk);
1159
	void			(*destroy)(struct sock *sk);
L
Linus Torvalds 已提交
1160
	void			(*shutdown)(struct sock *sk, int how);
E
Eric Dumazet 已提交
1161
	int			(*setsockopt)(struct sock *sk, int level,
1162
					int optname, sockptr_t optval,
1163
					unsigned int optlen);
E
Eric Dumazet 已提交
1164 1165 1166
	int			(*getsockopt)(struct sock *sk, int level,
					int optname, char __user *optval,
					int __user *option);
1167
	void			(*keepalive)(struct sock *sk, int valbool);
A
Alexey Dobriyan 已提交
1168
#ifdef CONFIG_COMPAT
1169 1170
	int			(*compat_ioctl)(struct sock *sk,
					unsigned int cmd, unsigned long arg);
A
Alexey Dobriyan 已提交
1171
#endif
1172 1173 1174
	int			(*sendmsg)(struct sock *sk, struct msghdr *msg,
					   size_t len);
	int			(*recvmsg)(struct sock *sk, struct msghdr *msg,
E
Eric Dumazet 已提交
1175 1176
					   size_t len, int noblock, int flags,
					   int *addr_len);
L
Linus Torvalds 已提交
1177 1178
	int			(*sendpage)(struct sock *sk, struct page *page,
					int offset, size_t size, int flags);
E
Eric Dumazet 已提交
1179
	int			(*bind)(struct sock *sk,
1180 1181 1182
					struct sockaddr *addr, int addr_len);
	int			(*bind_add)(struct sock *sk,
					struct sockaddr *addr, int addr_len);
L
Linus Torvalds 已提交
1183

E
Eric Dumazet 已提交
1184
	int			(*backlog_rcv) (struct sock *sk,
L
Linus Torvalds 已提交
1185
						struct sk_buff *skb);
1186 1187
	bool			(*bpf_bypass_getsockopt)(int level,
							 int optname);
L
Linus Torvalds 已提交
1188

E
Eric Dumazet 已提交
1189 1190
	void		(*release_cb)(struct sock *sk);

L
Linus Torvalds 已提交
1191
	/* Keeping track of sk's, looking them up, and port selection methods. */
1192
	int			(*hash)(struct sock *sk);
L
Linus Torvalds 已提交
1193
	void			(*unhash)(struct sock *sk);
E
Eric Dumazet 已提交
1194
	void			(*rehash)(struct sock *sk);
L
Linus Torvalds 已提交
1195
	int			(*get_port)(struct sock *sk, unsigned short snum);
1196
#ifdef CONFIG_BPF_SYSCALL
1197 1198 1199
	int			(*psock_update_sk_prot)(struct sock *sk,
							struct sk_psock *psock,
							bool restore);
1200
#endif
L
Linus Torvalds 已提交
1201

1202
	/* Keeping track of sockets in use */
1203
#ifdef CONFIG_PROC_FS
1204
	unsigned int		inuse_idx;
1205
#endif
1206

1207
	bool			(*stream_memory_free)(const struct sock *sk, int wake);
1208
	bool			(*stream_memory_read)(const struct sock *sk);
L
Linus Torvalds 已提交
1209
	/* Memory pressure */
1210
	void			(*enter_memory_pressure)(struct sock *sk);
1211
	void			(*leave_memory_pressure)(struct sock *sk);
E
Eric Dumazet 已提交
1212
	atomic_long_t		*memory_allocated;	/* Current allocated memory. */
1213
	struct percpu_counter	*sockets_allocated;	/* Current number of sockets. */
L
Linus Torvalds 已提交
1214 1215 1216
	/*
	 * Pressure flag: try to collapse.
	 * Technical note: it is used by multiple contexts non atomically.
1217
	 * All the __sk_mem_schedule() is of this nature: accounting
L
Linus Torvalds 已提交
1218 1219
	 * is strict, actions are advisory and have some latency.
	 */
1220
	unsigned long		*memory_pressure;
E
Eric Dumazet 已提交
1221
	long			*sysctl_mem;
1222

L
Linus Torvalds 已提交
1223 1224
	int			*sysctl_wmem;
	int			*sysctl_rmem;
1225 1226 1227
	u32			sysctl_wmem_offset;
	u32			sysctl_rmem_offset;

L
Linus Torvalds 已提交
1228
	int			max_header;
1229
	bool			no_autobind;
L
Linus Torvalds 已提交
1230

1231
	struct kmem_cache	*slab;
L
Linus Torvalds 已提交
1232
	unsigned int		obj_size;
1233
	slab_flags_t		slab_flags;
1234 1235
	unsigned int		useroffset;	/* Usercopy region offset */
	unsigned int		usersize;	/* Usercopy region size */
L
Linus Torvalds 已提交
1236

1237
	struct percpu_counter	*orphan_count;
1238

1239
	struct request_sock_ops	*rsk_prot;
1240
	struct timewait_sock_ops *twsk_prot;
1241

1242 1243
	union {
		struct inet_hashinfo	*hashinfo;
1244
		struct udp_table	*udp_table;
1245
		struct raw_hashinfo	*raw_hash;
1246
		struct smc_hashinfo	*smc_hash;
1247
	} h;
1248

L
Linus Torvalds 已提交
1249 1250 1251 1252 1253
	struct module		*owner;

	char			name[32];

	struct list_head	node;
1254 1255
#ifdef SOCK_REFCNT_DEBUG
	atomic_t		socks;
G
Glauber Costa 已提交
1256
#endif
1257
	int			(*diag_destroy)(struct sock *sk, int err);
1258
} __randomize_layout;
G
Glauber Costa 已提交
1259

1260 1261
int proto_register(struct proto *prot, int alloc_slab);
void proto_unregister(struct proto *prot);
1262
int sock_load_diag_module(int family, int protocol);
L
Linus Torvalds 已提交
1263

1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276
#ifdef SOCK_REFCNT_DEBUG
static inline void sk_refcnt_debug_inc(struct sock *sk)
{
	atomic_inc(&sk->sk_prot->socks);
}

static inline void sk_refcnt_debug_dec(struct sock *sk)
{
	atomic_dec(&sk->sk_prot->socks);
	printk(KERN_DEBUG "%s socket %p released, %d are still alive\n",
	       sk->sk_prot->name, sk, atomic_read(&sk->sk_prot->socks));
}

1277
static inline void sk_refcnt_debug_release(const struct sock *sk)
1278
{
1279
	if (refcount_read(&sk->sk_refcnt) != 1)
1280
		printk(KERN_DEBUG "Destruction of the %s socket %p delayed, refcnt=%d\n",
1281
		       sk->sk_prot->name, sk, refcount_read(&sk->sk_refcnt));
1282 1283 1284 1285 1286 1287 1288
}
#else /* SOCK_REFCNT_DEBUG */
#define sk_refcnt_debug_inc(sk) do { } while (0)
#define sk_refcnt_debug_dec(sk) do { } while (0)
#define sk_refcnt_debug_release(sk) do { } while (0)
#endif /* SOCK_REFCNT_DEBUG */

1289 1290
INDIRECT_CALLABLE_DECLARE(bool tcp_stream_memory_free(const struct sock *sk, int wake));

1291
static inline bool __sk_stream_memory_free(const struct sock *sk, int wake)
1292
{
1293
	if (READ_ONCE(sk->sk_wmem_queued) >= READ_ONCE(sk->sk_sndbuf))
1294 1295
		return false;

1296
#ifdef CONFIG_INET
1297
	return sk->sk_prot->stream_memory_free ?
1298 1299 1300
		INDIRECT_CALL_1(sk->sk_prot->stream_memory_free,
			        tcp_stream_memory_free,
				sk, wake) : true;
1301
#else
1302
	return sk->sk_prot->stream_memory_free ?
1303
		sk->sk_prot->stream_memory_free(sk, wake) : true;
1304
#endif
1305 1306
}

1307 1308 1309 1310 1311 1312
static inline bool sk_stream_memory_free(const struct sock *sk)
{
	return __sk_stream_memory_free(sk, 0);
}

static inline bool __sk_stream_is_writeable(const struct sock *sk, int wake)
1313
{
1314
	return sk_stream_wspace(sk) >= sk_stream_min_wspace(sk) &&
1315 1316 1317 1318 1319 1320
	       __sk_stream_memory_free(sk, wake);
}

static inline bool sk_stream_is_writeable(const struct sock *sk)
{
	return __sk_stream_is_writeable(sk, 0);
1321
}
G
Glauber Costa 已提交
1322

1323 1324 1325 1326 1327 1328 1329 1330 1331 1332
static inline int sk_under_cgroup_hierarchy(struct sock *sk,
					    struct cgroup *ancestor)
{
#ifdef CONFIG_SOCK_CGROUP_DATA
	return cgroup_is_descendant(sock_cgroup_ptr(&sk->sk_cgrp_data),
				    ancestor);
#else
	return -ENOTSUPP;
#endif
}
1333

1334 1335 1336 1337 1338 1339 1340 1341 1342
static inline bool sk_has_memory_pressure(const struct sock *sk)
{
	return sk->sk_prot->memory_pressure != NULL;
}

static inline bool sk_under_memory_pressure(const struct sock *sk)
{
	if (!sk->sk_prot->memory_pressure)
		return false;
G
Glauber Costa 已提交
1343

1344 1345
	if (mem_cgroup_sockets_enabled && sk->sk_memcg &&
	    mem_cgroup_under_socket_pressure(sk->sk_memcg))
1346
		return true;
G
Glauber Costa 已提交
1347

1348
	return !!*sk->sk_prot->memory_pressure;
1349 1350 1351 1352 1353
}

static inline long
sk_memory_allocated(const struct sock *sk)
{
1354
	return atomic_long_read(sk->sk_prot->memory_allocated);
1355 1356 1357
}

static inline long
1358
sk_memory_allocated_add(struct sock *sk, int amt)
1359
{
1360
	return atomic_long_add_return(amt, sk->sk_prot->memory_allocated);
1361 1362 1363
}

static inline void
1364
sk_memory_allocated_sub(struct sock *sk, int amt)
1365
{
1366
	atomic_long_sub(amt, sk->sk_prot->memory_allocated);
1367 1368
}

1369 1370
#define SK_ALLOC_PERCPU_COUNTER_BATCH 16

1371 1372
static inline void sk_sockets_allocated_dec(struct sock *sk)
{
1373 1374
	percpu_counter_add_batch(sk->sk_prot->sockets_allocated, -1,
				 SK_ALLOC_PERCPU_COUNTER_BATCH);
1375 1376 1377 1378
}

static inline void sk_sockets_allocated_inc(struct sock *sk)
{
1379 1380
	percpu_counter_add_batch(sk->sk_prot->sockets_allocated, 1,
				 SK_ALLOC_PERCPU_COUNTER_BATCH);
1381 1382
}

1383
static inline u64
1384 1385
sk_sockets_allocated_read_positive(struct sock *sk)
{
1386
	return percpu_counter_read_positive(sk->sk_prot->sockets_allocated);
1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408
}

static inline int
proto_sockets_allocated_sum_positive(struct proto *prot)
{
	return percpu_counter_sum_positive(prot->sockets_allocated);
}

static inline long
proto_memory_allocated(struct proto *prot)
{
	return atomic_long_read(prot->memory_allocated);
}

static inline bool
proto_memory_pressure(struct proto *prot)
{
	if (!prot->memory_pressure)
		return false;
	return !!*prot->memory_pressure;
}

1409 1410

#ifdef CONFIG_PROC_FS
L
Linus Torvalds 已提交
1411
/* Called with local bh disabled */
1412 1413
void sock_prot_inuse_add(struct net *net, struct proto *prot, int inc);
int sock_prot_inuse_get(struct net *net, struct proto *proto);
1414
int sock_inuse_get(struct net *net);
1415
#else
E
Eric Dumazet 已提交
1416
static inline void sock_prot_inuse_add(struct net *net, struct proto *prot,
1417
		int inc)
1418 1419 1420 1421
{
}
#endif

L
Linus Torvalds 已提交
1422

1423 1424 1425
/* With per-bucket locks this operation is not-atomic, so that
 * this version is not worse.
 */
1426
static inline int __sk_prot_rehash(struct sock *sk)
1427 1428
{
	sk->sk_prot->unhash(sk);
1429
	return sk->sk_prot->hash(sk);
1430 1431
}

L
Linus Torvalds 已提交
1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459
/* About 10 seconds */
#define SOCK_DESTROY_TIME (10*HZ)

/* Sockets 0-1023 can't be bound to unless you are superuser */
#define PROT_SOCK	1024

#define SHUTDOWN_MASK	3
#define RCV_SHUTDOWN	1
#define SEND_SHUTDOWN	2

#define SOCK_BINDADDR_LOCK	4
#define SOCK_BINDPORT_LOCK	8

struct socket_alloc {
	struct socket socket;
	struct inode vfs_inode;
};

static inline struct socket *SOCKET_I(struct inode *inode)
{
	return &container_of(inode, struct socket_alloc, vfs_inode)->socket;
}

static inline struct inode *SOCK_INODE(struct socket *socket)
{
	return &container_of(socket, struct socket_alloc, socket)->vfs_inode;
}

1460 1461 1462
/*
 * Functions for memory accounting
 */
1463
int __sk_mem_raise_allocated(struct sock *sk, int size, int amt, int kind);
1464
int __sk_mem_schedule(struct sock *sk, int size, int kind);
1465
void __sk_mem_reduce_allocated(struct sock *sk, int amount);
E
Eric Dumazet 已提交
1466
void __sk_mem_reclaim(struct sock *sk, int amount);
L
Linus Torvalds 已提交
1467

E
Eric Dumazet 已提交
1468 1469 1470 1471
/* We used to have PAGE_SIZE here, but systems with 64KB pages
 * do not necessarily have 16x time more memory than 4KB ones.
 */
#define SK_MEM_QUANTUM 4096
1472 1473 1474
#define SK_MEM_QUANTUM_SHIFT ilog2(SK_MEM_QUANTUM)
#define SK_MEM_SEND	0
#define SK_MEM_RECV	1
L
Linus Torvalds 已提交
1475

E
Eric Dumazet 已提交
1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488
/* sysctl_mem values are in pages, we convert them in SK_MEM_QUANTUM units */
static inline long sk_prot_mem_limits(const struct sock *sk, int index)
{
	long val = sk->sk_prot->sysctl_mem[index];

#if PAGE_SIZE > SK_MEM_QUANTUM
	val <<= PAGE_SHIFT - SK_MEM_QUANTUM_SHIFT;
#elif PAGE_SIZE < SK_MEM_QUANTUM
	val >>= SK_MEM_QUANTUM_SHIFT - PAGE_SHIFT;
#endif
	return val;
}

1489
static inline int sk_mem_pages(int amt)
L
Linus Torvalds 已提交
1490
{
1491
	return (amt + SK_MEM_QUANTUM - 1) >> SK_MEM_QUANTUM_SHIFT;
L
Linus Torvalds 已提交
1492 1493
}

E
Eric Dumazet 已提交
1494
static inline bool sk_has_account(struct sock *sk)
L
Linus Torvalds 已提交
1495
{
1496 1497
	/* return true if protocol supports memory accounting */
	return !!sk->sk_prot->memory_allocated;
L
Linus Torvalds 已提交
1498 1499
}

E
Eric Dumazet 已提交
1500
static inline bool sk_wmem_schedule(struct sock *sk, int size)
L
Linus Torvalds 已提交
1501
{
1502
	if (!sk_has_account(sk))
E
Eric Dumazet 已提交
1503
		return true;
1504 1505
	return size <= sk->sk_forward_alloc ||
		__sk_mem_schedule(sk, size, SK_MEM_SEND);
L
Linus Torvalds 已提交
1506 1507
}

1508
static inline bool
1509
sk_rmem_schedule(struct sock *sk, struct sk_buff *skb, int size)
H
Herbert Xu 已提交
1510
{
1511
	if (!sk_has_account(sk))
E
Eric Dumazet 已提交
1512
		return true;
M
Miaohe Lin 已提交
1513
	return size <= sk->sk_forward_alloc ||
1514 1515
		__sk_mem_schedule(sk, size, SK_MEM_RECV) ||
		skb_pfmemalloc(skb);
1516 1517 1518 1519 1520 1521 1522
}

static inline void sk_mem_reclaim(struct sock *sk)
{
	if (!sk_has_account(sk))
		return;
	if (sk->sk_forward_alloc >= SK_MEM_QUANTUM)
E
Eric Dumazet 已提交
1523
		__sk_mem_reclaim(sk, sk->sk_forward_alloc);
1524 1525
}

1526 1527 1528 1529 1530
static inline void sk_mem_reclaim_partial(struct sock *sk)
{
	if (!sk_has_account(sk))
		return;
	if (sk->sk_forward_alloc > SK_MEM_QUANTUM)
E
Eric Dumazet 已提交
1531
		__sk_mem_reclaim(sk, sk->sk_forward_alloc - 1);
1532 1533
}

1534 1535 1536 1537 1538 1539 1540 1541 1542 1543 1544 1545
static inline void sk_mem_charge(struct sock *sk, int size)
{
	if (!sk_has_account(sk))
		return;
	sk->sk_forward_alloc -= size;
}

static inline void sk_mem_uncharge(struct sock *sk, int size)
{
	if (!sk_has_account(sk))
		return;
	sk->sk_forward_alloc += size;
1546 1547 1548 1549 1550 1551 1552 1553 1554 1555

	/* Avoid a possible overflow.
	 * TCP send queues can make this happen, if sk_mem_reclaim()
	 * is not called and more than 2 GBytes are released at once.
	 *
	 * If we reach 2 MBytes, reclaim 1 MBytes right now, there is
	 * no need to hold that much forward allocation anyway.
	 */
	if (unlikely(sk->sk_forward_alloc >= 1 << 21))
		__sk_mem_reclaim(sk, 1 << 20);
1556 1557
}

E
Eric Dumazet 已提交
1558
DECLARE_STATIC_KEY_FALSE(tcp_tx_skb_cache_key);
1559 1560
static inline void sk_wmem_free_skb(struct sock *sk, struct sk_buff *skb)
{
1561
	sk_wmem_queued_add(sk, -skb->truesize);
1562
	sk_mem_uncharge(sk, skb->truesize);
E
Eric Dumazet 已提交
1563 1564
	if (static_branch_unlikely(&tcp_tx_skb_cache_key) &&
	    !sk->sk_tx_skb_cache && !skb_cloned(skb)) {
P
Paolo Abeni 已提交
1565
		skb_ext_reset(skb);
1566
		skb_zcopy_clear(skb, true);
E
Eric Dumazet 已提交
1567 1568 1569
		sk->sk_tx_skb_cache = skb;
		return;
	}
1570
	__kfree_skb(skb);
H
Herbert Xu 已提交
1571 1572
}

1573 1574
static inline void sock_release_ownership(struct sock *sk)
{
1575 1576 1577 1578
	if (sk->sk_lock.owned) {
		sk->sk_lock.owned = 0;

		/* The sk_lock has mutex_unlock() semantics: */
1579
		mutex_release(&sk->sk_lock.dep_map, _RET_IP_);
1580
	}
1581 1582
}

1583 1584 1585 1586 1587 1588 1589
/*
 * Macro so as to not evaluate some arguments when
 * lockdep is not enabled.
 *
 * Mark both the sk_lock and the sk_lock.slock as a
 * per-address-family lock class.
 */
E
Eric Dumazet 已提交
1590
#define sock_lock_init_class_and_name(sk, sname, skey, name, key)	\
1591
do {									\
1592
	sk->sk_lock.owned = 0;						\
1593 1594 1595 1596 1597
	init_waitqueue_head(&sk->sk_lock.wq);				\
	spin_lock_init(&(sk)->sk_lock.slock);				\
	debug_check_no_locks_freed((void *)&(sk)->sk_lock,		\
			sizeof((sk)->sk_lock));				\
	lockdep_set_class_and_name(&(sk)->sk_lock.slock,		\
E
Eric Dumazet 已提交
1598
				(skey), (sname));				\
1599 1600 1601
	lockdep_init_map(&(sk)->sk_lock.dep_map, (name), (key), 0);	\
} while (0)

1602
static inline bool lockdep_sock_is_held(const struct sock *sk)
1603 1604 1605 1606 1607
{
	return lockdep_is_held(&sk->sk_lock) ||
	       lockdep_is_held(&sk->sk_lock.slock);
}

1608
void lock_sock_nested(struct sock *sk, int subclass);
1609 1610 1611 1612 1613 1614

static inline void lock_sock(struct sock *sk)
{
	lock_sock_nested(sk, 0);
}

1615
void __lock_sock(struct sock *sk);
1616
void __release_sock(struct sock *sk);
1617
void release_sock(struct sock *sk);
L
Linus Torvalds 已提交
1618 1619 1620

/* BH context may only use the following locking interface. */
#define bh_lock_sock(__sk)	spin_lock(&((__sk)->sk_lock.slock))
1621 1622 1623
#define bh_lock_sock_nested(__sk) \
				spin_lock_nested(&((__sk)->sk_lock.slock), \
				SINGLE_DEPTH_NESTING)
L
Linus Torvalds 已提交
1624 1625
#define bh_unlock_sock(__sk)	spin_unlock(&((__sk)->sk_lock.slock))

1626 1627
bool lock_sock_fast(struct sock *sk) __acquires(&sk->sk_lock.slock);

1628 1629 1630 1631 1632 1633 1634 1635 1636
/**
 * unlock_sock_fast - complement of lock_sock_fast
 * @sk: socket
 * @slow: slow mode
 *
 * fast unlock socket for user context.
 * If slow mode is on, we call regular release_sock()
 */
static inline void unlock_sock_fast(struct sock *sk, bool slow)
1637
	__releases(&sk->sk_lock.slock)
E
Eric Dumazet 已提交
1638
{
1639
	if (slow) {
1640
		release_sock(sk);
1641 1642
		__release(&sk->sk_lock.slock);
	} else {
1643
		spin_unlock_bh(&sk->sk_lock.slock);
1644
	}
E
Eric Dumazet 已提交
1645 1646
}

1647 1648 1649 1650 1651 1652 1653 1654 1655 1656 1657 1658 1659 1660
/* Used by processes to "lock" a socket state, so that
 * interrupts and bottom half handlers won't change it
 * from under us. It essentially blocks any incoming
 * packets, so that we won't get any new data or any
 * packets that change the state of the socket.
 *
 * While locked, BH processing will add new packets to
 * the backlog queue.  This queue is processed by the
 * owner of the socket lock right before it is released.
 *
 * Since ~2.3.5 it is also exclusive sleep lock serializing
 * accesses from user process context.
 */

1661
static inline void sock_owned_by_me(const struct sock *sk)
1662 1663
{
#ifdef CONFIG_LOCKDEP
1664
	WARN_ON_ONCE(!lockdep_sock_is_held(sk) && debug_locks);
1665
#endif
1666 1667 1668 1669 1670
}

static inline bool sock_owned_by_user(const struct sock *sk)
{
	sock_owned_by_me(sk);
1671 1672 1673
	return sk->sk_lock.owned;
}

T
Tom Herbert 已提交
1674 1675 1676 1677 1678
static inline bool sock_owned_by_user_nocheck(const struct sock *sk)
{
	return sk->sk_lock.owned;
}

1679 1680 1681 1682 1683 1684 1685
/* no reclassification while locks are held */
static inline bool sock_allow_reclassification(const struct sock *csk)
{
	struct sock *sk = (struct sock *)csk;

	return !sk->sk_lock.owned && !spin_is_locked(&sk->sk_lock.slock);
}
E
Eric Dumazet 已提交
1686

1687
struct sock *sk_alloc(struct net *net, int family, gfp_t priority,
1688
		      struct proto *prot, int kern);
1689
void sk_free(struct sock *sk);
1690
void sk_destruct(struct sock *sk);
1691
struct sock *sk_clone_lock(const struct sock *sk, const gfp_t priority);
1692
void sk_free_unlock_clone(struct sock *sk);
1693 1694 1695

struct sk_buff *sock_wmalloc(struct sock *sk, unsigned long size, int force,
			     gfp_t priority);
E
Eric Dumazet 已提交
1696
void __sock_wfree(struct sk_buff *skb);
1697
void sock_wfree(struct sk_buff *skb);
1698 1699
struct sk_buff *sock_omalloc(struct sock *sk, unsigned long size,
			     gfp_t priority);
1700 1701
void skb_orphan_partial(struct sk_buff *skb);
void sock_rfree(struct sk_buff *skb);
1702
void sock_efree(struct sk_buff *skb);
1703
#ifdef CONFIG_INET
1704
void sock_edemux(struct sk_buff *skb);
J
Joe Stringer 已提交
1705
void sock_pfree(struct sk_buff *skb);
1706
#else
1707
#define sock_edemux sock_efree
1708
#endif
1709 1710

int sock_setsockopt(struct socket *sock, int level, int op,
1711
		    sockptr_t optval, unsigned int optlen);
1712 1713 1714

int sock_getsockopt(struct socket *sock, int level, int op,
		    char __user *optval, int __user *optlen);
1715 1716
int sock_gettstamp(struct socket *sock, void __user *userstamp,
		   bool timeval, bool time32);
1717 1718 1719 1720 1721 1722 1723
struct sk_buff *sock_alloc_send_skb(struct sock *sk, unsigned long size,
				    int noblock, int *errcode);
struct sk_buff *sock_alloc_send_pskb(struct sock *sk, unsigned long header_len,
				     unsigned long data_len, int noblock,
				     int *errcode, int max_page_order);
void *sock_kmalloc(struct sock *sk, int size, gfp_t priority);
void sock_kfree_s(struct sock *sk, void *mem, int size);
1724
void sock_kzfree_s(struct sock *sk, void *mem, int size);
1725
void sk_send_sigurg(struct sock *sk);
L
Linus Torvalds 已提交
1726

E
Edward Jee 已提交
1727
struct sockcm_cookie {
1728
	u64 transmit_time;
E
Edward Jee 已提交
1729
	u32 mark;
1730
	u16 tsflags;
E
Edward Jee 已提交
1731 1732
};

1733 1734 1735 1736 1737 1738
static inline void sockcm_init(struct sockcm_cookie *sockc,
			       const struct sock *sk)
{
	*sockc = (struct sockcm_cookie) { .tsflags = sk->sk_tsflags };
}

1739 1740
int __sock_cmsg_send(struct sock *sk, struct msghdr *msg, struct cmsghdr *cmsg,
		     struct sockcm_cookie *sockc);
E
Edward Jee 已提交
1741 1742 1743
int sock_cmsg_send(struct sock *sk, struct msghdr *msg,
		   struct sockcm_cookie *sockc);

L
Linus Torvalds 已提交
1744 1745 1746 1747
/*
 * Functions to fill in entries in struct proto_ops when a protocol
 * does not implement a particular function.
 */
1748 1749 1750
int sock_no_bind(struct socket *, struct sockaddr *, int);
int sock_no_connect(struct socket *, struct sockaddr *, int, int);
int sock_no_socketpair(struct socket *, struct socket *);
1751
int sock_no_accept(struct socket *, struct socket *, int, bool);
1752
int sock_no_getname(struct socket *, struct sockaddr *, int);
1753 1754 1755
int sock_no_ioctl(struct socket *, unsigned int, unsigned long);
int sock_no_listen(struct socket *, int);
int sock_no_shutdown(struct socket *, int);
1756
int sock_no_sendmsg(struct socket *, struct msghdr *, size_t);
1757
int sock_no_sendmsg_locked(struct sock *sk, struct msghdr *msg, size_t len);
1758
int sock_no_recvmsg(struct socket *, struct msghdr *, size_t, int);
1759 1760 1761 1762
int sock_no_mmap(struct file *file, struct socket *sock,
		 struct vm_area_struct *vma);
ssize_t sock_no_sendpage(struct socket *sock, struct page *page, int offset,
			 size_t size, int flags);
1763 1764
ssize_t sock_no_sendpage_locked(struct sock *sk, struct page *page,
				int offset, size_t size, int flags);
L
Linus Torvalds 已提交
1765 1766 1767 1768 1769

/*
 * Functions to fill in entries in struct proto_ops when a protocol
 * uses the inet style.
 */
1770
int sock_common_getsockopt(struct socket *sock, int level, int optname,
L
Linus Torvalds 已提交
1771
				  char __user *optval, int __user *optlen);
1772 1773
int sock_common_recvmsg(struct socket *sock, struct msghdr *msg, size_t size,
			int flags);
1774
int sock_common_setsockopt(struct socket *sock, int level, int optname,
1775
			   sockptr_t optval, unsigned int optlen);
L
Linus Torvalds 已提交
1776

1777
void sk_common_release(struct sock *sk);
L
Linus Torvalds 已提交
1778 1779 1780 1781

/*
 *	Default socket callbacks and setup code
 */
E
Eric Dumazet 已提交
1782

L
Linus Torvalds 已提交
1783
/* Initialise core socket variables */
1784
void sock_init_data(struct socket *sock, struct sock *sk);
L
Linus Torvalds 已提交
1785 1786 1787 1788 1789 1790 1791 1792 1793 1794 1795 1796 1797 1798 1799 1800 1801 1802 1803 1804 1805 1806 1807 1808 1809 1810 1811 1812 1813

/*
 * Socket reference counting postulates.
 *
 * * Each user of socket SHOULD hold a reference count.
 * * Each access point to socket (an hash table bucket, reference from a list,
 *   running timer, skb in flight MUST hold a reference count.
 * * When reference count hits 0, it means it will never increase back.
 * * When reference count hits 0, it means that no references from
 *   outside exist to this socket and current process on current CPU
 *   is last user and may/should destroy this socket.
 * * sk_free is called from any context: process, BH, IRQ. When
 *   it is called, socket has no references from outside -> sk_free
 *   may release descendant resources allocated by the socket, but
 *   to the time when it is called, socket is NOT referenced by any
 *   hash tables, lists etc.
 * * Packets, delivered from outside (from network or from another process)
 *   and enqueued on receive/error queues SHOULD NOT grab reference count,
 *   when they sit in queue. Otherwise, packets will leak to hole, when
 *   socket is looked up by one cpu and unhasing is made by another CPU.
 *   It is true for udp/raw, netlink (leak to receive and error queues), tcp
 *   (leak to backlog). Packet socket does all the processing inside
 *   BR_NETPROTO_LOCK, so that it has not this race condition. UNIX sockets
 *   use separate SMP lock, so that they are prone too.
 */

/* Ungrab socket and destroy it, if it was the last reference. */
static inline void sock_put(struct sock *sk)
{
1814
	if (refcount_dec_and_test(&sk->sk_refcnt))
L
Linus Torvalds 已提交
1815 1816
		sk_free(sk);
}
E
Eric Dumazet 已提交
1817
/* Generic version of sock_put(), dealing with all sockets
1818
 * (TCP_TIMEWAIT, TCP_NEW_SYN_RECV, ESTABLISHED...)
E
Eric Dumazet 已提交
1819 1820
 */
void sock_gen_put(struct sock *sk);
L
Linus Torvalds 已提交
1821

1822
int __sk_receive_skb(struct sock *sk, struct sk_buff *skb, const int nested,
1823
		     unsigned int trim_cap, bool refcounted);
1824 1825 1826
static inline int sk_receive_skb(struct sock *sk, struct sk_buff *skb,
				 const int nested)
{
1827
	return __sk_receive_skb(sk, skb, nested, 1, true);
1828
}
1829

K
Krishna Kumar 已提交
1830 1831
static inline void sk_tx_queue_set(struct sock *sk, int tx_queue)
{
1832 1833 1834
	/* sk_tx_queue_mapping accept only upto a 16-bit value */
	if (WARN_ON_ONCE((unsigned short)tx_queue >= USHRT_MAX))
		return;
K
Krishna Kumar 已提交
1835 1836 1837
	sk->sk_tx_queue_mapping = tx_queue;
}

1838 1839
#define NO_QUEUE_MAPPING	USHRT_MAX

K
Krishna Kumar 已提交
1840 1841
static inline void sk_tx_queue_clear(struct sock *sk)
{
1842
	sk->sk_tx_queue_mapping = NO_QUEUE_MAPPING;
K
Krishna Kumar 已提交
1843 1844 1845 1846
}

static inline int sk_tx_queue_get(const struct sock *sk)
{
1847 1848 1849 1850
	if (sk && sk->sk_tx_queue_mapping != NO_QUEUE_MAPPING)
		return sk->sk_tx_queue_mapping;

	return -1;
K
Krishna Kumar 已提交
1851 1852
}

1853 1854
static inline void sk_rx_queue_set(struct sock *sk, const struct sk_buff *skb)
{
1855
#ifdef CONFIG_SOCK_RX_QUEUE_MAPPING
1856 1857 1858 1859 1860 1861 1862 1863 1864 1865 1866 1867 1868
	if (skb_rx_queue_recorded(skb)) {
		u16 rx_queue = skb_get_rx_queue(skb);

		if (WARN_ON_ONCE(rx_queue == NO_QUEUE_MAPPING))
			return;

		sk->sk_rx_queue_mapping = rx_queue;
	}
#endif
}

static inline void sk_rx_queue_clear(struct sock *sk)
{
1869
#ifdef CONFIG_SOCK_RX_QUEUE_MAPPING
1870 1871 1872 1873
	sk->sk_rx_queue_mapping = NO_QUEUE_MAPPING;
#endif
}

1874 1875
static inline int sk_rx_queue_get(const struct sock *sk)
{
1876
#ifdef CONFIG_SOCK_RX_QUEUE_MAPPING
1877 1878
	if (sk && sk->sk_rx_queue_mapping != NO_QUEUE_MAPPING)
		return sk->sk_rx_queue_mapping;
1879
#endif
1880 1881 1882 1883

	return -1;
}

1884 1885 1886 1887 1888
static inline void sk_set_socket(struct sock *sk, struct socket *sock)
{
	sk->sk_socket = sock;
}

E
Eric Dumazet 已提交
1889 1890
static inline wait_queue_head_t *sk_sleep(struct sock *sk)
{
1891 1892
	BUILD_BUG_ON(offsetof(struct socket_wq, wait) != 0);
	return &rcu_dereference_raw(sk->sk_wq)->wait;
E
Eric Dumazet 已提交
1893
}
L
Linus Torvalds 已提交
1894 1895 1896 1897 1898 1899 1900 1901 1902 1903 1904
/* Detach socket from process context.
 * Announce socket dead, detach it from wait queue and inode.
 * Note that parent inode held reference count on this struct sock,
 * we do not release it in this function, because protocol
 * probably wants some additional cleanups or even continuing
 * to work with this socket (TCP).
 */
static inline void sock_orphan(struct sock *sk)
{
	write_lock_bh(&sk->sk_callback_lock);
	sock_set_flag(sk, SOCK_DEAD);
1905
	sk_set_socket(sk, NULL);
1906
	sk->sk_wq  = NULL;
L
Linus Torvalds 已提交
1907 1908 1909 1910 1911
	write_unlock_bh(&sk->sk_callback_lock);
}

static inline void sock_graft(struct sock *sk, struct socket *parent)
{
1912
	WARN_ON(parent->sk);
L
Linus Torvalds 已提交
1913
	write_lock_bh(&sk->sk_callback_lock);
1914
	rcu_assign_pointer(sk->sk_wq, &parent->wq);
L
Linus Torvalds 已提交
1915
	parent->sk = sk;
1916
	sk_set_socket(sk, parent);
1917
	sk->sk_uid = SOCK_INODE(parent)->i_uid;
1918
	security_sock_graft(sk, parent);
L
Linus Torvalds 已提交
1919 1920 1921
	write_unlock_bh(&sk->sk_callback_lock);
}

1922 1923
kuid_t sock_i_uid(struct sock *sk);
unsigned long sock_i_ino(struct sock *sk);
L
Linus Torvalds 已提交
1924

1925 1926 1927 1928 1929
static inline kuid_t sock_net_uid(const struct net *net, const struct sock *sk)
{
	return sk ? sk->sk_uid : make_kuid(net->user_ns, 0);
}

1930
static inline u32 net_tx_rndhash(void)
1931
{
1932 1933 1934 1935
	u32 v = prandom_u32();

	return v ?: 1;
}
1936

1937 1938
static inline void sk_set_txhash(struct sock *sk)
{
1939 1940
	/* This pairs with READ_ONCE() in skb_set_hash_from_sk() */
	WRITE_ONCE(sk->sk_txhash, net_tx_rndhash());
1941 1942
}

1943
static inline bool sk_rethink_txhash(struct sock *sk)
1944
{
1945
	if (sk->sk_txhash) {
1946
		sk_set_txhash(sk);
1947 1948 1949
		return true;
	}
	return false;
1950 1951
}

L
Linus Torvalds 已提交
1952 1953 1954
static inline struct dst_entry *
__sk_dst_get(struct sock *sk)
{
1955 1956
	return rcu_dereference_check(sk->sk_dst_cache,
				     lockdep_sock_is_held(sk));
L
Linus Torvalds 已提交
1957 1958 1959 1960 1961 1962 1963
}

static inline struct dst_entry *
sk_dst_get(struct sock *sk)
{
	struct dst_entry *dst;

E
Eric Dumazet 已提交
1964 1965
	rcu_read_lock();
	dst = rcu_dereference(sk->sk_dst_cache);
1966 1967
	if (dst && !atomic_inc_not_zero(&dst->__refcnt))
		dst = NULL;
E
Eric Dumazet 已提交
1968
	rcu_read_unlock();
L
Linus Torvalds 已提交
1969 1970 1971
	return dst;
}

1972
static inline void __dst_negative_advice(struct sock *sk)
E
Eric Dumazet 已提交
1973 1974 1975 1976 1977 1978 1979 1980
{
	struct dst_entry *ndst, *dst = __sk_dst_get(sk);

	if (dst && dst->ops->negative_advice) {
		ndst = dst->ops->negative_advice(dst);

		if (ndst != dst) {
			rcu_assign_pointer(sk->sk_dst_cache, ndst);
Z
ZHAO Gang 已提交
1981
			sk_tx_queue_clear(sk);
1982
			sk->sk_dst_pending_confirm = 0;
E
Eric Dumazet 已提交
1983 1984 1985 1986
		}
	}
}

1987 1988 1989 1990 1991 1992
static inline void dst_negative_advice(struct sock *sk)
{
	sk_rethink_txhash(sk);
	__dst_negative_advice(sk);
}

L
Linus Torvalds 已提交
1993 1994 1995 1996 1997
static inline void
__sk_dst_set(struct sock *sk, struct dst_entry *dst)
{
	struct dst_entry *old_dst;

K
Krishna Kumar 已提交
1998
	sk_tx_queue_clear(sk);
1999
	sk->sk_dst_pending_confirm = 0;
2000 2001
	old_dst = rcu_dereference_protected(sk->sk_dst_cache,
					    lockdep_sock_is_held(sk));
E
Eric Dumazet 已提交
2002
	rcu_assign_pointer(sk->sk_dst_cache, dst);
L
Linus Torvalds 已提交
2003 2004 2005 2006 2007 2008
	dst_release(old_dst);
}

static inline void
sk_dst_set(struct sock *sk, struct dst_entry *dst)
{
2009 2010 2011
	struct dst_entry *old_dst;

	sk_tx_queue_clear(sk);
2012
	sk->sk_dst_pending_confirm = 0;
2013
	old_dst = xchg((__force struct dst_entry **)&sk->sk_dst_cache, dst);
2014
	dst_release(old_dst);
L
Linus Torvalds 已提交
2015 2016 2017 2018 2019
}

static inline void
__sk_dst_reset(struct sock *sk)
{
E
Eric Dumazet 已提交
2020
	__sk_dst_set(sk, NULL);
L
Linus Torvalds 已提交
2021 2022 2023 2024 2025
}

static inline void
sk_dst_reset(struct sock *sk)
{
2026
	sk_dst_set(sk, NULL);
L
Linus Torvalds 已提交
2027 2028
}

2029
struct dst_entry *__sk_dst_check(struct sock *sk, u32 cookie);
L
Linus Torvalds 已提交
2030

2031
struct dst_entry *sk_dst_check(struct sock *sk, u32 cookie);
L
Linus Torvalds 已提交
2032

2033 2034
static inline void sk_dst_confirm(struct sock *sk)
{
2035 2036
	if (!READ_ONCE(sk->sk_dst_pending_confirm))
		WRITE_ONCE(sk->sk_dst_pending_confirm, 1);
2037 2038
}

2039 2040 2041 2042 2043 2044 2045
static inline void sock_confirm_neigh(struct sk_buff *skb, struct neighbour *n)
{
	if (skb_get_dst_pending_confirm(skb)) {
		struct sock *sk = skb->sk;
		unsigned long now = jiffies;

		/* avoid dirtying neighbour */
2046 2047 2048 2049
		if (READ_ONCE(n->confirmed) != now)
			WRITE_ONCE(n->confirmed, now);
		if (sk && READ_ONCE(sk->sk_dst_pending_confirm))
			WRITE_ONCE(sk->sk_dst_pending_confirm, 0);
2050 2051 2052
	}
}

2053 2054
bool sk_mc_loop(struct sock *sk);

E
Eric Dumazet 已提交
2055
static inline bool sk_can_gso(const struct sock *sk)
2056 2057 2058 2059
{
	return net_gso_ok(sk->sk_route_caps, sk->sk_gso_type);
}

2060
void sk_setup_caps(struct sock *sk, struct dst_entry *dst);
2061

2062
static inline void sk_nocaps_add(struct sock *sk, netdev_features_t flags)
E
Eric Dumazet 已提交
2063 2064 2065 2066 2067
{
	sk->sk_route_nocaps |= flags;
	sk->sk_route_caps &= ~flags;
}

2068
static inline int skb_do_copy_data_nocache(struct sock *sk, struct sk_buff *skb,
2069
					   struct iov_iter *from, char *to,
2070
					   int copy, int offset)
2071 2072
{
	if (skb->ip_summed == CHECKSUM_NONE) {
2073
		__wsum csum = 0;
2074
		if (!csum_and_copy_from_iter_full(to, copy, &csum, from))
2075
			return -EFAULT;
2076
		skb->csum = csum_block_add(skb->csum, csum, offset);
2077
	} else if (sk->sk_route_caps & NETIF_F_NOCACHE_COPY) {
2078
		if (!copy_from_iter_full_nocache(to, copy, from))
2079
			return -EFAULT;
2080
	} else if (!copy_from_iter_full(to, copy, from))
2081 2082 2083 2084 2085 2086
		return -EFAULT;

	return 0;
}

static inline int skb_add_data_nocache(struct sock *sk, struct sk_buff *skb,
2087
				       struct iov_iter *from, int copy)
2088
{
2089
	int err, offset = skb->len;
2090

2091 2092
	err = skb_do_copy_data_nocache(sk, skb, from, skb_put(skb, copy),
				       copy, offset);
2093
	if (err)
2094
		__skb_trim(skb, offset);
2095 2096 2097 2098

	return err;
}

2099
static inline int skb_copy_to_page_nocache(struct sock *sk, struct iov_iter *from,
2100 2101 2102 2103 2104 2105
					   struct sk_buff *skb,
					   struct page *page,
					   int off, int copy)
{
	int err;

2106 2107
	err = skb_do_copy_data_nocache(sk, skb, from, page_address(page) + off,
				       copy, skb->len);
2108 2109 2110 2111 2112 2113
	if (err)
		return err;

	skb->len	     += copy;
	skb->data_len	     += copy;
	skb->truesize	     += copy;
2114
	sk_wmem_queued_add(sk, copy);
2115 2116 2117 2118
	sk_mem_charge(sk, copy);
	return 0;
}

2119 2120 2121 2122
/**
 * sk_wmem_alloc_get - returns write allocations
 * @sk: socket
 *
2123
 * Return: sk_wmem_alloc minus initial offset of one
2124 2125 2126
 */
static inline int sk_wmem_alloc_get(const struct sock *sk)
{
2127
	return refcount_read(&sk->sk_wmem_alloc) - 1;
2128 2129 2130 2131 2132 2133
}

/**
 * sk_rmem_alloc_get - returns read allocations
 * @sk: socket
 *
2134
 * Return: sk_rmem_alloc
2135 2136 2137 2138 2139 2140 2141 2142 2143 2144
 */
static inline int sk_rmem_alloc_get(const struct sock *sk)
{
	return atomic_read(&sk->sk_rmem_alloc);
}

/**
 * sk_has_allocations - check if allocations are outstanding
 * @sk: socket
 *
2145
 * Return: true if socket has write or read allocations
2146
 */
E
Eric Dumazet 已提交
2147
static inline bool sk_has_allocations(const struct sock *sk)
2148 2149 2150 2151
{
	return sk_wmem_alloc_get(sk) || sk_rmem_alloc_get(sk);
}

2152
/**
H
Herbert Xu 已提交
2153
 * skwq_has_sleeper - check if there are any waiting processes
R
Randy Dunlap 已提交
2154
 * @wq: struct socket_wq
2155
 *
2156
 * Return: true if socket_wq has waiting processes
2157
 *
H
Herbert Xu 已提交
2158
 * The purpose of the skwq_has_sleeper and sock_poll_wait is to wrap the memory
2159 2160
 * barrier call. They were added due to the race found within the tcp code.
 *
2161
 * Consider following tcp code paths::
2162
 *
2163 2164
 *   CPU1                CPU2
 *   sys_select          receive packet
2165 2166 2167 2168 2169
 *   ...                 ...
 *   __add_wait_queue    update tp->rcv_nxt
 *   ...                 ...
 *   tp->rcv_nxt check   sock_def_readable
 *   ...                 {
2170 2171 2172 2173
 *   schedule               rcu_read_lock();
 *                          wq = rcu_dereference(sk->sk_wq);
 *                          if (wq && waitqueue_active(&wq->wait))
 *                              wake_up_interruptible(&wq->wait)
2174 2175 2176 2177 2178 2179 2180
 *                          ...
 *                       }
 *
 * The race for tcp fires when the __add_wait_queue changes done by CPU1 stay
 * in its cache, and so does the tp->rcv_nxt update on CPU2 side.  The CPU1
 * could then endup calling schedule and sleep forever if there are no more
 * data on the socket.
2181
 *
2182
 */
H
Herbert Xu 已提交
2183
static inline bool skwq_has_sleeper(struct socket_wq *wq)
2184
{
H
Herbert Xu 已提交
2185
	return wq && wq_has_sleeper(&wq->wait);
2186 2187 2188 2189 2190
}

/**
 * sock_poll_wait - place memory barrier behind the poll_wait call.
 * @filp:           file
2191
 * @sock:           socket to wait on
2192 2193
 * @p:              poll_table
 *
2194
 * See the comments in the wq_has_sleeper function.
2195
 */
2196 2197
static inline void sock_poll_wait(struct file *filp, struct socket *sock,
				  poll_table *p)
2198
{
2199
	if (!poll_does_not_wait(p)) {
2200
		poll_wait(filp, &sock->wq.wait, p);
E
Eric Dumazet 已提交
2201
		/* We need to be sure we are in sync with the
2202 2203
		 * socket flags modification.
		 *
2204
		 * This memory barrier is paired in the wq_has_sleeper.
E
Eric Dumazet 已提交
2205
		 */
2206 2207 2208 2209
		smp_mb();
	}
}

2210 2211
static inline void skb_set_hash_from_sk(struct sk_buff *skb, struct sock *sk)
{
2212 2213 2214 2215
	/* This pairs with WRITE_ONCE() in sk_set_txhash() */
	u32 txhash = READ_ONCE(sk->sk_txhash);

	if (txhash) {
2216
		skb->l4_hash = 1;
2217
		skb->hash = txhash;
2218 2219 2220
	}
}

2221 2222
void skb_set_owner_w(struct sk_buff *skb, struct sock *sk);

L
Linus Torvalds 已提交
2223
/*
E
Eric Dumazet 已提交
2224
 *	Queue a received datagram if it will fit. Stream and sequenced
L
Linus Torvalds 已提交
2225 2226 2227
 *	protocols can't normally use this as they need to fit buffers in
 *	and play with them.
 *
E
Eric Dumazet 已提交
2228
 *	Inlined as it's very short and called for pretty much every
L
Linus Torvalds 已提交
2229 2230 2231 2232
 *	packet ever received.
 */
static inline void skb_set_owner_r(struct sk_buff *skb, struct sock *sk)
{
2233
	skb_orphan(skb);
L
Linus Torvalds 已提交
2234 2235 2236
	skb->sk = sk;
	skb->destructor = sock_rfree;
	atomic_add(skb->truesize, &sk->sk_rmem_alloc);
2237
	sk_mem_charge(sk, skb->truesize);
L
Linus Torvalds 已提交
2238 2239
}

2240
static inline __must_check bool skb_set_owner_sk_safe(struct sk_buff *skb, struct sock *sk)
2241 2242 2243 2244 2245
{
	if (sk && refcount_inc_not_zero(&sk->sk_refcnt)) {
		skb_orphan(skb);
		skb->destructor = sock_efree;
		skb->sk = sk;
2246
		return true;
2247
	}
2248
	return false;
2249 2250
}

2251 2252 2253 2254 2255 2256 2257 2258 2259
static inline void skb_prepare_for_gro(struct sk_buff *skb)
{
	if (skb->destructor != sock_wfree) {
		skb_orphan(skb);
		return;
	}
	skb->slow_gro = 1;
}

2260 2261
void sk_reset_timer(struct sock *sk, struct timer_list *timer,
		    unsigned long expires);
L
Linus Torvalds 已提交
2262

2263
void sk_stop_timer(struct sock *sk, struct timer_list *timer);
L
Linus Torvalds 已提交
2264

2265 2266
void sk_stop_timer_sync(struct sock *sk, struct timer_list *timer);

2267 2268
int __sk_queue_drop_skb(struct sock *sk, struct sk_buff_head *sk_queue,
			struct sk_buff *skb, unsigned int flags,
2269 2270
			void (*destructor)(struct sock *sk,
					   struct sk_buff *skb));
2271
int __sock_queue_rcv_skb(struct sock *sk, struct sk_buff *skb);
2272
int sock_queue_rcv_skb(struct sock *sk, struct sk_buff *skb);
L
Linus Torvalds 已提交
2273

2274
int sock_queue_err_skb(struct sock *sk, struct sk_buff *skb);
2275
struct sk_buff *sock_dequeue_err_skb(struct sock *sk);
L
Linus Torvalds 已提交
2276 2277 2278 2279

/*
 *	Recover an error report and clear atomically
 */
E
Eric Dumazet 已提交
2280

L
Linus Torvalds 已提交
2281 2282
static inline int sock_error(struct sock *sk)
{
2283
	int err;
2284 2285 2286 2287 2288

	/* Avoid an atomic operation for the common case.
	 * This is racy since another cpu/thread can change sk_err under us.
	 */
	if (likely(data_race(!sk->sk_err)))
2289
		return 0;
2290

2291
	err = xchg(&sk->sk_err, 0);
L
Linus Torvalds 已提交
2292 2293 2294
	return -err;
}

2295 2296
void sk_error_report(struct sock *sk);

L
Linus Torvalds 已提交
2297 2298 2299 2300 2301
static inline unsigned long sock_wspace(struct sock *sk)
{
	int amt = 0;

	if (!(sk->sk_shutdown & SEND_SHUTDOWN)) {
2302
		amt = sk->sk_sndbuf - refcount_read(&sk->sk_wmem_alloc);
E
Eric Dumazet 已提交
2303
		if (amt < 0)
L
Linus Torvalds 已提交
2304 2305 2306 2307 2308
			amt = 0;
	}
	return amt;
}

2309 2310 2311 2312
/* Note:
 *  We use sk->sk_wq_raw, from contexts knowing this
 *  pointer is not NULL and cannot disappear/change.
 */
2313
static inline void sk_set_bit(int nr, struct sock *sk)
L
Linus Torvalds 已提交
2314
{
2315 2316
	if ((nr == SOCKWQ_ASYNC_NOSPACE || nr == SOCKWQ_ASYNC_WAITDATA) &&
	    !sock_flag(sk, SOCK_FASYNC))
2317 2318
		return;

2319
	set_bit(nr, &sk->sk_wq_raw->flags);
2320 2321 2322 2323
}

static inline void sk_clear_bit(int nr, struct sock *sk)
{
2324 2325
	if ((nr == SOCKWQ_ASYNC_NOSPACE || nr == SOCKWQ_ASYNC_WAITDATA) &&
	    !sock_flag(sk, SOCK_FASYNC))
2326 2327
		return;

2328
	clear_bit(nr, &sk->sk_wq_raw->flags);
2329 2330
}

2331
static inline void sk_wake_async(const struct sock *sk, int how, int band)
L
Linus Torvalds 已提交
2332
{
2333 2334 2335 2336 2337
	if (sock_flag(sk, SOCK_FASYNC)) {
		rcu_read_lock();
		sock_wake_async(rcu_dereference(sk->sk_wq), how, band);
		rcu_read_unlock();
	}
L
Linus Torvalds 已提交
2338 2339
}

2340 2341 2342 2343
/* Since sk_{r,w}mem_alloc sums skb->truesize, even a small frame might
 * need sizeof(sk_buff) + MTU + padding, unless net driver perform copybreak.
 * Note: for send buffers, TCP works better if we can build two skbs at
 * minimum.
E
Eric Dumazet 已提交
2344
 */
2345
#define TCP_SKB_MIN_TRUESIZE	(2048 + SKB_DATA_ALIGN(sizeof(struct sk_buff)))
2346 2347 2348

#define SOCK_MIN_SNDBUF		(TCP_SKB_MIN_TRUESIZE * 2)
#define SOCK_MIN_RCVBUF		 TCP_SKB_MIN_TRUESIZE
L
Linus Torvalds 已提交
2349 2350 2351

static inline void sk_stream_moderate_sndbuf(struct sock *sk)
{
2352 2353 2354 2355 2356 2357 2358 2359
	u32 val;

	if (sk->sk_userlocks & SOCK_SNDBUF_LOCK)
		return;

	val = min(sk->sk_sndbuf, sk->sk_wmem_queued >> 1);

	WRITE_ONCE(sk->sk_sndbuf, max_t(u32, val, SOCK_MIN_SNDBUF));
L
Linus Torvalds 已提交
2360 2361
}

2362 2363
struct sk_buff *sk_stream_alloc_skb(struct sock *sk, int size, gfp_t gfp,
				    bool force_schedule);
L
Linus Torvalds 已提交
2364

2365 2366 2367 2368
/**
 * sk_page_frag - return an appropriate page_frag
 * @sk: socket
 *
2369 2370 2371 2372 2373 2374 2375
 * Use the per task page_frag instead of the per socket one for
 * optimization when we know that we're in the normal context and owns
 * everything that's associated with %current.
 *
 * gfpflags_allow_blocking() isn't enough here as direct reclaim may nest
 * inside other socket operations and end up recursing into sk_page_frag()
 * while it's already in use.
2376 2377 2378
 *
 * Return: a per task page_frag if context allows that,
 * otherwise a per socket one.
2379 2380
 */
static inline struct page_frag *sk_page_frag(struct sock *sk)
L
Linus Torvalds 已提交
2381
{
2382
	if (gfpflags_normal_context(sk->sk_allocation))
2383
		return &current->task_frag;
L
Linus Torvalds 已提交
2384

2385
	return &sk->sk_frag;
L
Linus Torvalds 已提交
2386 2387
}

2388
bool sk_page_frag_refill(struct sock *sk, struct page_frag *pfrag);
2389

L
Linus Torvalds 已提交
2390 2391 2392
/*
 *	Default write policy as shown to user space via poll/select/SIGIO
 */
E
Eric Dumazet 已提交
2393
static inline bool sock_writeable(const struct sock *sk)
L
Linus Torvalds 已提交
2394
{
2395
	return refcount_read(&sk->sk_wmem_alloc) < (READ_ONCE(sk->sk_sndbuf) >> 1);
L
Linus Torvalds 已提交
2396 2397
}

A
Al Viro 已提交
2398
static inline gfp_t gfp_any(void)
L
Linus Torvalds 已提交
2399
{
2400
	return in_softirq() ? GFP_ATOMIC : GFP_KERNEL;
L
Linus Torvalds 已提交
2401 2402
}

E
Eric Dumazet 已提交
2403
static inline long sock_rcvtimeo(const struct sock *sk, bool noblock)
L
Linus Torvalds 已提交
2404 2405 2406 2407
{
	return noblock ? 0 : sk->sk_rcvtimeo;
}

E
Eric Dumazet 已提交
2408
static inline long sock_sndtimeo(const struct sock *sk, bool noblock)
L
Linus Torvalds 已提交
2409 2410 2411 2412 2413 2414
{
	return noblock ? 0 : sk->sk_sndtimeo;
}

static inline int sock_rcvlowat(const struct sock *sk, int waitall, int len)
{
2415 2416 2417
	int v = waitall ? len : min_t(int, READ_ONCE(sk->sk_rcvlowat), len);

	return v ?: 1;
L
Linus Torvalds 已提交
2418 2419 2420 2421 2422 2423 2424 2425 2426 2427
}

/* Alas, with timeout socket operations are not restartable.
 * Compare this to poll().
 */
static inline int sock_intr_errno(long timeo)
{
	return timeo == MAX_SCHEDULE_TIMEOUT ? -ERESTARTSYS : -EINTR;
}

2428 2429 2430 2431 2432 2433 2434 2435
struct sock_skb_cb {
	u32 dropcount;
};

/* Store sock_skb_cb at the end of skb->cb[] so protocol families
 * using skb->cb[] would keep using it directly and utilize its
 * alignement guarantee.
 */
2436
#define SOCK_SKB_CB_OFFSET ((sizeof_field(struct sk_buff, cb) - \
2437 2438 2439 2440 2441
			    sizeof(struct sock_skb_cb)))

#define SOCK_SKB_CB(__skb) ((struct sock_skb_cb *)((__skb)->cb + \
			    SOCK_SKB_CB_OFFSET))

2442
#define sock_skb_cb_check_size(size) \
2443
	BUILD_BUG_ON((size) > SOCK_SKB_CB_OFFSET)
2444

2445 2446 2447
static inline void
sock_skb_set_dropcount(const struct sock *sk, struct sk_buff *skb)
{
2448 2449
	SOCK_SKB_CB(skb)->dropcount = sock_flag(sk, SOCK_RXQ_OVFL) ?
						atomic_read(&sk->sk_drops) : 0;
2450 2451
}

2452 2453 2454 2455 2456 2457 2458
static inline void sk_drops_add(struct sock *sk, const struct sk_buff *skb)
{
	int segs = max_t(u16, 1, skb_shinfo(skb)->gso_segs);

	atomic_add(segs, &sk->sk_drops);
}

2459 2460 2461 2462 2463 2464 2465 2466 2467 2468 2469 2470 2471
static inline ktime_t sock_read_timestamp(struct sock *sk)
{
#if BITS_PER_LONG==32
	unsigned int seq;
	ktime_t kt;

	do {
		seq = read_seqbegin(&sk->sk_stamp_seq);
		kt = sk->sk_stamp;
	} while (read_seqretry(&sk->sk_stamp_seq, seq));

	return kt;
#else
2472
	return READ_ONCE(sk->sk_stamp);
2473 2474 2475 2476 2477 2478 2479 2480 2481 2482
#endif
}

static inline void sock_write_timestamp(struct sock *sk, ktime_t kt)
{
#if BITS_PER_LONG==32
	write_seqlock(&sk->sk_stamp_seq);
	sk->sk_stamp = kt;
	write_sequnlock(&sk->sk_stamp_seq);
#else
2483
	WRITE_ONCE(sk->sk_stamp, kt);
2484 2485 2486
#endif
}

2487 2488 2489 2490
void __sock_recv_timestamp(struct msghdr *msg, struct sock *sk,
			   struct sk_buff *skb);
void __sock_recv_wifi_status(struct msghdr *msg, struct sock *sk,
			     struct sk_buff *skb);
2491

E
Eric Dumazet 已提交
2492
static inline void
L
Linus Torvalds 已提交
2493 2494
sock_recv_timestamp(struct msghdr *msg, struct sock *sk, struct sk_buff *skb)
{
2495
	ktime_t kt = skb->tstamp;
2496
	struct skb_shared_hwtstamps *hwtstamps = skb_hwtstamps(skb);
2497

2498 2499
	/*
	 * generate control messages if
2500
	 * - receive time stamping in software requested
2501 2502 2503 2504
	 * - software time stamp available and wanted
	 * - hardware time stamps available and wanted
	 */
	if (sock_flag(sk, SOCK_RCVTSTAMP) ||
2505
	    (sk->sk_tsflags & SOF_TIMESTAMPING_RX_SOFTWARE) ||
T
Thomas Gleixner 已提交
2506 2507
	    (kt && sk->sk_tsflags & SOF_TIMESTAMPING_SOFTWARE) ||
	    (hwtstamps->hwtstamp &&
2508
	     (sk->sk_tsflags & SOF_TIMESTAMPING_RAW_HARDWARE)))
2509 2510
		__sock_recv_timestamp(msg, sk, skb);
	else
2511
		sock_write_timestamp(sk, kt);
2512 2513 2514

	if (sock_flag(sk, SOCK_WIFI_STATUS) && skb->wifi_acked_valid)
		__sock_recv_wifi_status(msg, sk, skb);
L
Linus Torvalds 已提交
2515 2516
}

2517 2518
void __sock_recv_ts_and_drops(struct msghdr *msg, struct sock *sk,
			      struct sk_buff *skb);
2519

2520
#define SK_DEFAULT_STAMP (-1L * NSEC_PER_SEC)
2521 2522 2523 2524
static inline void sock_recv_ts_and_drops(struct msghdr *msg, struct sock *sk,
					  struct sk_buff *skb)
{
#define FLAGS_TS_OR_DROPS ((1UL << SOCK_RXQ_OVFL)			| \
2525 2526 2527
			   (1UL << SOCK_RCVTSTAMP))
#define TSFLAGS_ANY	  (SOF_TIMESTAMPING_SOFTWARE			| \
			   SOF_TIMESTAMPING_RAW_HARDWARE)
2528

2529
	if (sk->sk_flags & FLAGS_TS_OR_DROPS || sk->sk_tsflags & TSFLAGS_ANY)
2530
		__sock_recv_ts_and_drops(msg, sk, skb);
2531
	else if (unlikely(sock_flag(sk, SOCK_TIMESTAMP)))
2532
		sock_write_timestamp(sk, skb->tstamp);
2533
	else if (unlikely(sk->sk_stamp == SK_DEFAULT_STAMP))
2534
		sock_write_timestamp(sk, 0);
2535
}
2536

2537
void __sock_tx_timestamp(__u16 tsflags, __u8 *tx_flags);
2538

2539
/**
2540
 * _sock_tx_timestamp - checks whether the outgoing packet is to be time stamped
2541
 * @sk:		socket sending this packet
2542
 * @tsflags:	timestamping flags to use
2543
 * @tx_flags:	completed with instructions for time stamping
2544
 * @tskey:      filled in with next sk_tskey (not for TCP, which uses seqno)
2545
 *
2546
 * Note: callers should take care of initial ``*tx_flags`` value (usually 0)
2547
 */
2548 2549
static inline void _sock_tx_timestamp(struct sock *sk, __u16 tsflags,
				      __u8 *tx_flags, __u32 *tskey)
2550
{
2551
	if (unlikely(tsflags)) {
2552
		__sock_tx_timestamp(tsflags, tx_flags);
2553 2554 2555 2556
		if (tsflags & SOF_TIMESTAMPING_OPT_ID && tskey &&
		    tsflags & SOF_TIMESTAMPING_TX_RECORD_MASK)
			*tskey = sk->sk_tskey++;
	}
2557 2558 2559
	if (unlikely(sock_flag(sk, SOCK_WIFI_STATUS)))
		*tx_flags |= SKBTX_WIFI_STATUS;
}
2560

2561 2562 2563 2564 2565 2566 2567 2568 2569 2570 2571 2572
static inline void sock_tx_timestamp(struct sock *sk, __u16 tsflags,
				     __u8 *tx_flags)
{
	_sock_tx_timestamp(sk, tsflags, tx_flags, NULL);
}

static inline void skb_setup_tx_timestamp(struct sk_buff *skb, __u16 tsflags)
{
	_sock_tx_timestamp(skb->sk, tsflags, &skb_shinfo(skb)->tx_flags,
			   &skb_shinfo(skb)->tskey);
}

2573
DECLARE_STATIC_KEY_FALSE(tcp_rx_skb_cache_key);
L
Linus Torvalds 已提交
2574 2575
/**
 * sk_eat_skb - Release a skb if it is no longer needed
2576 2577
 * @sk: socket to eat this skb from
 * @skb: socket buffer to eat
L
Linus Torvalds 已提交
2578 2579 2580 2581
 *
 * This routine must be called with interrupts disabled or with the socket
 * locked so that the sk_buff queue operation is ok.
*/
D
Dan Williams 已提交
2582
static inline void sk_eat_skb(struct sock *sk, struct sk_buff *skb)
L
Linus Torvalds 已提交
2583 2584
{
	__skb_unlink(skb, &sk->sk_receive_queue);
E
Eric Dumazet 已提交
2585
	if (static_branch_unlikely(&tcp_rx_skb_cache_key) &&
E
Eric Dumazet 已提交
2586 2587 2588 2589 2590
	    !sk->sk_rx_skb_cache) {
		sk->sk_rx_skb_cache = skb;
		skb_orphan(skb);
		return;
	}
L
Linus Torvalds 已提交
2591 2592 2593
	__kfree_skb(skb);
}

2594 2595 2596
static inline
struct net *sock_net(const struct sock *sk)
{
E
Eric Dumazet 已提交
2597
	return read_pnet(&sk->sk_net);
2598 2599 2600
}

static inline
2601
void sock_net_set(struct sock *sk, struct net *net)
2602
{
E
Eric Dumazet 已提交
2603
	write_pnet(&sk->sk_net, net);
2604 2605
}

J
Joe Stringer 已提交
2606 2607 2608 2609 2610 2611 2612 2613 2614 2615
static inline bool
skb_sk_is_prefetched(struct sk_buff *skb)
{
#ifdef CONFIG_INET
	return skb->destructor == sock_pfree;
#else
	return false;
#endif /* CONFIG_INET */
}

2616 2617 2618 2619 2620 2621 2622 2623 2624 2625 2626 2627 2628 2629 2630
/* This helper checks if a socket is a full socket,
 * ie _not_ a timewait or request socket.
 */
static inline bool sk_fullsock(const struct sock *sk)
{
	return (1 << sk->sk_state) & ~(TCPF_TIME_WAIT | TCPF_NEW_SYN_RECV);
}

static inline bool
sk_is_refcounted(struct sock *sk)
{
	/* Only full sockets have sk->sk_flags. */
	return !sk_fullsock(sk) || !sock_flag(sk, SOCK_RCU_FREE);
}

2631
/**
2632 2633 2634
 * skb_steal_sock - steal a socket from an sk_buff
 * @skb: sk_buff to steal the socket from
 * @refcounted: is set to true if the socket is reference-counted
2635 2636 2637
 */
static inline struct sock *
skb_steal_sock(struct sk_buff *skb, bool *refcounted)
2638
{
2639
	if (skb->sk) {
2640 2641
		struct sock *sk = skb->sk;

2642
		*refcounted = true;
2643 2644
		if (skb_sk_is_prefetched(skb))
			*refcounted = sk_is_refcounted(sk);
2645 2646 2647 2648
		skb->destructor = NULL;
		skb->sk = NULL;
		return sk;
	}
2649
	*refcounted = false;
2650 2651 2652
	return NULL;
}

2653 2654
/* Checks if this SKB belongs to an HW offloaded socket
 * and whether any SW fallbacks are required based on dev.
2655
 * Check decrypted mark in case skb_orphan() cleared socket.
2656 2657 2658 2659 2660 2661 2662
 */
static inline struct sk_buff *sk_validate_xmit_skb(struct sk_buff *skb,
						   struct net_device *dev)
{
#ifdef CONFIG_SOCK_VALIDATE_XMIT
	struct sock *sk = skb->sk;

2663
	if (sk && sk_fullsock(sk) && sk->sk_validate_xmit_skb) {
2664
		skb = sk->sk_validate_xmit_skb(sk, dev, skb);
2665 2666 2667 2668 2669 2670 2671
#ifdef CONFIG_TLS_DEVICE
	} else if (unlikely(skb->decrypted)) {
		pr_warn_ratelimited("unencrypted skb with no associated socket - dropping\n");
		kfree_skb(skb);
		skb = NULL;
#endif
	}
2672 2673 2674 2675 2676
#endif

	return skb;
}

2677 2678 2679 2680 2681 2682 2683 2684
/* This helper checks if a socket is a LISTEN or NEW_SYN_RECV
 * SYNACK messages can be attached to either ones (depending on SYNCOOKIE)
 */
static inline bool sk_listener(const struct sock *sk)
{
	return (1 << sk->sk_state) & (TCPF_LISTEN | TCPF_NEW_SYN_RECV);
}

A
Alexey Dobriyan 已提交
2685
void sock_enable_timestamp(struct sock *sk, enum sock_flags flag);
2686 2687
int sock_recv_errqueue(struct sock *sk, struct msghdr *msg, int len, int level,
		       int type);
L
Linus Torvalds 已提交
2688

2689 2690 2691 2692 2693
bool sk_ns_capable(const struct sock *sk,
		   struct user_namespace *user_ns, int cap);
bool sk_capable(const struct sock *sk, int cap);
bool sk_net_capable(const struct sock *sk, int cap);

2694 2695
void sk_get_meminfo(const struct sock *sk, u32 *meminfo);

2696 2697 2698 2699 2700 2701 2702 2703 2704 2705
/* Take into consideration the size of the struct sk_buff overhead in the
 * determination of these values, since that is non-constant across
 * platforms.  This makes socket queueing behavior and performance
 * not depend upon such differences.
 */
#define _SK_MEM_PACKETS		256
#define _SK_MEM_OVERHEAD	SKB_TRUESIZE(256)
#define SK_WMEM_MAX		(_SK_MEM_OVERHEAD * _SK_MEM_PACKETS)
#define SK_RMEM_MAX		(_SK_MEM_OVERHEAD * _SK_MEM_PACKETS)

L
Linus Torvalds 已提交
2706 2707 2708
extern __u32 sysctl_wmem_max;
extern __u32 sysctl_rmem_max;

2709
extern int sysctl_tstamp_allow_data;
2710 2711
extern int sysctl_optmem_max;

2712 2713 2714
extern __u32 sysctl_wmem_default;
extern __u32 sysctl_rmem_default;

2715 2716
DECLARE_STATIC_KEY_FALSE(net_high_order_alloc_disable_key);

2717 2718 2719 2720 2721 2722 2723 2724 2725 2726 2727 2728 2729 2730 2731 2732 2733 2734
static inline int sk_get_wmem0(const struct sock *sk, const struct proto *proto)
{
	/* Does this proto have per netns sysctl_wmem ? */
	if (proto->sysctl_wmem_offset)
		return *(int *)((void *)sock_net(sk) + proto->sysctl_wmem_offset);

	return *proto->sysctl_wmem;
}

static inline int sk_get_rmem0(const struct sock *sk, const struct proto *proto)
{
	/* Does this proto have per netns sysctl_rmem ? */
	if (proto->sysctl_rmem_offset)
		return *(int *)((void *)sock_net(sk) + proto->sysctl_rmem_offset);

	return *proto->sysctl_rmem;
}

2735 2736 2737 2738 2739 2740
/* Default TCP Small queue budget is ~1 ms of data (1sec >> 10)
 * Some wifi drivers need to tweak it to get more chunks.
 * They can use this helper from their ndo_start_xmit()
 */
static inline void sk_pacing_shift_update(struct sock *sk, int val)
{
2741
	if (!sk || !sk_fullsock(sk) || READ_ONCE(sk->sk_pacing_shift) == val)
2742
		return;
2743
	WRITE_ONCE(sk->sk_pacing_shift, val);
2744 2745
}

2746 2747 2748 2749 2750 2751 2752 2753 2754 2755 2756 2757 2758 2759 2760 2761 2762 2763 2764
/* if a socket is bound to a device, check that the given device
 * index is either the same or that the socket is bound to an L3
 * master device and the given device index is also enslaved to
 * that L3 master
 */
static inline bool sk_dev_equal_l3scope(struct sock *sk, int dif)
{
	int mdif;

	if (!sk->sk_bound_dev_if || sk->sk_bound_dev_if == dif)
		return true;

	mdif = l3mdev_master_ifindex_by_index(sock_net(sk), dif);
	if (mdif && mdif == sk->sk_bound_dev_if)
		return true;

	return false;
}

2765 2766
void sock_def_readable(struct sock *sk);

2767
int sock_bindtoindex(struct sock *sk, int ifindex, bool lock_sk);
2768
void sock_set_timestamp(struct sock *sk, int optname, bool valbool);
2769 2770
int sock_set_timestamping(struct sock *sk, int optname,
			  struct so_timestamping timestamping);
2771

2772
void sock_enable_timestamps(struct sock *sk);
C
Christoph Hellwig 已提交
2773
void sock_no_linger(struct sock *sk);
C
Christoph Hellwig 已提交
2774
void sock_set_keepalive(struct sock *sk);
C
Christoph Hellwig 已提交
2775
void sock_set_priority(struct sock *sk, u32 priority);
C
Christoph Hellwig 已提交
2776
void sock_set_rcvbuf(struct sock *sk, int val);
A
Alexander Aring 已提交
2777
void sock_set_mark(struct sock *sk, u32 val);
C
Christoph Hellwig 已提交
2778
void sock_set_reuseaddr(struct sock *sk);
C
Christoph Hellwig 已提交
2779
void sock_set_reuseport(struct sock *sk);
C
Christoph Hellwig 已提交
2780
void sock_set_sndtimeo(struct sock *sk, s64 secs);
C
Christoph Hellwig 已提交
2781

2782 2783
int sock_bind_add(struct sock *sk, struct sockaddr *addr, int addr_len);

L
Linus Torvalds 已提交
2784
#endif	/* _SOCK_H */