sock.h 80.2 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_rx_dst_ifindex: ifindex for @sk_rx_dst
263
  *	@sk_rx_dst_cookie: cookie for @sk_rx_dst
264
  *	@sk_dst_cache: destination cache
265
  *	@sk_dst_pending_confirm: need to confirm neighbour
266 267 268
  *	@sk_policy: flow policy
  *	@sk_receive_queue: incoming packets
  *	@sk_wmem_alloc: transmit queue bytes committed
269
  *	@sk_tsq_flags: TCP Small Queues flags
270 271 272 273
  *	@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
274
  *	@sk_reserved_mem: space reserved and non-reclaimable for the socket
E
Eliezer Tamir 已提交
275
  *	@sk_napi_id: id of the last napi context to receive data for sk
276
  *	@sk_ll_usec: usecs to busypoll when there is no data
277
  *	@sk_allocation: allocation mode
E
Eric Dumazet 已提交
278
  *	@sk_pacing_rate: Pacing rate (if supported by transport/packet scheduler)
279
  *	@sk_pacing_status: Pacing status (requested, handled by sch_fq)
280
  *	@sk_max_pacing_rate: Maximum pacing rate (%SO_MAX_PACING_RATE)
281
  *	@sk_sndbuf: size of send buffer in bytes
282
  *	@__sk_flags_offset: empty field used to determine location of bitfield
283
  *	@sk_padding: unused element for alignment
284 285
  *	@sk_no_check_tx: %SO_NO_CHECK setting, set checksum in TX packets
  *	@sk_no_check_rx: allow zero checksum in RX packets
286
  *	@sk_route_caps: route capabilities (e.g. %NETIF_F_TSO)
E
Eric Dumazet 已提交
287
  *	@sk_route_nocaps: forbidden route capabilities (e.g NETIF_F_GSO_MASK)
288 289
  *	@sk_route_forced_caps: static, forced route capabilities
  *		(set in tcp_init_sock())
290
  *	@sk_gso_type: GSO type (e.g. %SKB_GSO_TCPV4)
291
  *	@sk_gso_max_size: Maximum GSO segment size to build
292
  *	@sk_gso_max_segs: Maximum number of GSO segments
293
  *	@sk_pacing_shift: scaling factor for TCP Small Queues
294 295 296 297
  *	@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 已提交
298 299
  *	@sk_prot_creator: sk_prot of original sock creator (see ipv6_setsockopt,
  *			  IPV6_ADDRFORM for instance)
300
  *	@sk_err: last error
W
Wang Chen 已提交
301 302
  *	@sk_err_soft: errors that don't cause failure but are the cause of a
  *		      persistent failure not just 'timed out'
E
Eric Dumazet 已提交
303
  *	@sk_drops: raw/udp drops counter
304 305
  *	@sk_ack_backlog: current listen backlog
  *	@sk_max_ack_backlog: listen backlog set in listen()
306
  *	@sk_uid: user id of owner
307
  *	@sk_prefer_busy_poll: prefer busypolling over softirq processing
308
  *	@sk_busy_poll_budget: napi processing budget when busypolling
309 310 311
  *	@sk_priority: %SO_PRIORITY setting
  *	@sk_type: socket type (%SOCK_STREAM, etc)
  *	@sk_protocol: which protocol this socket belongs in this network family
312
  *	@sk_peer_lock: lock protecting @sk_peer_pid and @sk_peer_cred
313 314
  *	@sk_peer_pid: &struct pid for this socket's peer
  *	@sk_peer_cred: %SO_PEERCRED setting
315 316 317
  *	@sk_rcvlowat: %SO_RCVLOWAT setting
  *	@sk_rcvtimeo: %SO_RCVTIMEO setting
  *	@sk_sndtimeo: %SO_SNDTIMEO setting
318
  *	@sk_txhash: computed flow hash for use on transmit
319 320 321
  *	@sk_filter: socket filtering instructions
  *	@sk_timer: sock cleanup timer
  *	@sk_stamp: time stamp of last packet received
322
  *	@sk_stamp_seq: lock for accessing sk_stamp on 32 bit architectures only
323 324 325
  *	@sk_tsflags: SO_TIMESTAMPING flags
  *	@sk_bind_phc: SO_TIMESTAMPING bind PHC index of PTP virtual clock
  *	              for timestamping
326
  *	@sk_tskey: counter to disambiguate concurrent tstamp requests
W
Willem de Bruijn 已提交
327
  *	@sk_zckey: counter to order MSG_ZEROCOPY notifications
328 329
  *	@sk_socket: Identd and reporting IO signals
  *	@sk_user_data: RPC layer private data
330
  *	@sk_frag: cached page frag
331
  *	@sk_peek_off: current peek_offset value
332
  *	@sk_send_head: front of stuff to transmit
333
  *	@tcp_rtx_queue: TCP re-transmit queue [union with @sk_send_head]
334
  *	@sk_security: used by security modules
335
  *	@sk_mark: generic packet mark
336
  *	@sk_cgrp_data: cgroup data for this cgroup
337
  *	@sk_memcg: this socket's memory cgroup association
338 339 340 341 342 343
  *	@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
344
  *	@sk_validate_xmit_skb: ptr to an optional validate function
345
  *	@sk_destruct: called at sock freeing time, i.e. when all refcnt == 0
346
  *	@sk_reuseport_cb: reuseport group container
347
  *	@sk_bpf_storage: ptr to cache and control for bpf_sk_storage
348
  *	@sk_rcu: used during RCU grace period
349 350
  *	@sk_clockid: clockid used by time-based scheduling (SO_TXTIME)
  *	@sk_txtime_deadline_mode: set deadline mode for SO_TXTIME
351
  *	@sk_txtime_report_errors: set report errors mode for SO_TXTIME
352
  *	@sk_txtime_unused: unused txtime flags
353
  */
L
Linus Torvalds 已提交
354 355
struct sock {
	/*
356
	 * Now struct inet_timewait_sock also uses sock_common, so please just
L
Linus Torvalds 已提交
357 358 359
	 * don't add nothing before this first member (__sk_common) --acme
	 */
	struct sock_common	__sk_common;
E
Eric Dumazet 已提交
360 361 362
#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 已提交
363
#define sk_tx_queue_mapping	__sk_common.skc_tx_queue_mapping
364
#ifdef CONFIG_SOCK_RX_QUEUE_MAPPING
365 366
#define sk_rx_queue_mapping	__sk_common.skc_rx_queue_mapping
#endif
E
Eric Dumazet 已提交
367

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

L
Linus Torvalds 已提交
394
	socket_lock_t		sk_lock;
395 396 397
	atomic_t		sk_drops;
	int			sk_rcvlowat;
	struct sk_buff_head	sk_error_queue;
E
Eric Dumazet 已提交
398
	struct sk_buff_head	sk_receive_queue;
399 400 401 402
	/*
	 * 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 已提交
403 404 405
	 * Note : rmem_alloc is in this structure to fill a hole
	 * on 64bit arches, not because its logically part of
	 * backlog.
406 407
	 */
	struct {
E
Eric Dumazet 已提交
408 409 410 411
		atomic_t	rmem_alloc;
		int		len;
		struct sk_buff	*head;
		struct sk_buff	*tail;
412
	} sk_backlog;
E
Eric Dumazet 已提交
413
#define sk_rmem_alloc sk_backlog.rmem_alloc
E
Eric Dumazet 已提交
414

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

	struct sk_filter __rcu	*sk_filter;
425 426
	union {
		struct socket_wq __rcu	*sk_wq;
427
		/* private: */
428
		struct socket_wq	*sk_wq_raw;
429
		/* public: */
430
	};
431
#ifdef CONFIG_XFRM
432
	struct xfrm_policy __rcu *sk_policy[2];
433
#endif
E
Eric Dumazet 已提交
434
	struct dst_entry	*sk_rx_dst;
435
	int			sk_rx_dst_ifindex;
436
	u32			sk_rx_dst_cookie;
437

438
	struct dst_entry __rcu	*sk_dst_cache;
L
Linus Torvalds 已提交
439
	atomic_t		sk_omem_alloc;
440
	int			sk_sndbuf;
441 442 443

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

	/*
	 * Because of non atomicity rules, all
	 * changes are protected by socket lock.
	 */
474
	u8			sk_padding : 1,
475
				sk_kern_sock : 1,
476 477
				sk_no_check_tx : 1,
				sk_no_check_rx : 1,
478
				sk_userlocks : 4;
479
	u8			sk_pacing_shift;
480 481 482
	u16			sk_type;
	u16			sk_protocol;
	u16			sk_gso_max_segs;
L
Linus Torvalds 已提交
483
	unsigned long	        sk_lingertime;
484
	struct proto		*sk_prot_creator;
L
Linus Torvalds 已提交
485 486 487
	rwlock_t		sk_callback_lock;
	int			sk_err,
				sk_err_soft;
488 489
	u32			sk_ack_backlog;
	u32			sk_max_ack_backlog;
490
	kuid_t			sk_uid;
491 492
#ifdef CONFIG_NET_RX_BUSY_POLL
	u8			sk_prefer_busy_poll;
493
	u16			sk_busy_poll_budget;
494
#endif
495
	spinlock_t		sk_peer_lock;
496 497
	struct pid		*sk_peer_pid;
	const struct cred	*sk_peer_cred;
498

L
Linus Torvalds 已提交
499
	long			sk_rcvtimeo;
500
	ktime_t			sk_stamp;
501 502 503
#if BITS_PER_LONG==32
	seqlock_t		sk_stamp_seq;
#endif
504
	u16			sk_tsflags;
505
	int			sk_bind_phc;
506
	u8			sk_shutdown;
507
	u32			sk_tskey;
W
Willem de Bruijn 已提交
508
	atomic_t		sk_zckey;
509 510 511

	u8			sk_clockid;
	u8			sk_txtime_deadline_mode : 1,
512 513
				sk_txtime_report_errors : 1,
				sk_txtime_unused : 6;
514

L
Linus Torvalds 已提交
515 516
	struct socket		*sk_socket;
	void			*sk_user_data;
A
Alexey Dobriyan 已提交
517
#ifdef CONFIG_SECURITY
L
Linus Torvalds 已提交
518
	void			*sk_security;
A
Alexey Dobriyan 已提交
519
#endif
520
	struct sock_cgroup_data	sk_cgrp_data;
521
	struct mem_cgroup	*sk_memcg;
L
Linus Torvalds 已提交
522
	void			(*sk_state_change)(struct sock *sk);
523
	void			(*sk_data_ready)(struct sock *sk);
L
Linus Torvalds 已提交
524 525
	void			(*sk_write_space)(struct sock *sk);
	void			(*sk_error_report)(struct sock *sk);
E
Eric Dumazet 已提交
526 527
	int			(*sk_backlog_rcv)(struct sock *sk,
						  struct sk_buff *skb);
528 529 530 531 532
#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 已提交
533
	void                    (*sk_destruct)(struct sock *sk);
534
	struct sock_reuseport __rcu	*sk_reuseport_cb;
535
#ifdef CONFIG_BPF_SYSCALL
536
	struct bpf_local_storage __rcu	*sk_bpf_storage;
537
#endif
538
	struct rcu_head		sk_rcu;
L
Linus Torvalds 已提交
539 540
};

541 542 543 544 545 546
enum sk_pacing {
	SK_PACING_NONE		= 0,
	SK_PACING_NEEDED	= 1,
	SK_PACING_FQ		= 2,
};

547 548 549 550 551 552
/* 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
553 554
#define SK_USER_DATA_BPF	2UL	/* Managed by BPF */
#define SK_USER_DATA_PTRMASK	~(SK_USER_DATA_NOCOPY | SK_USER_DATA_BPF)
555 556 557 558 559 560 561 562 563 564

/**
 * 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);
}

565 566
#define __sk_user_data(sk) ((*((void __rcu **)&(sk)->sk_user_data)))

567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584
#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);		\
})
585

586 587 588 589 590 591 592 593 594 595 596
/*
 * 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

597 598
int sk_set_peek_off(struct sock *sk, int val);

599 600
static inline int sk_peek_offset(struct sock *sk, int flags)
{
601
	if (unlikely(flags & MSG_PEEK)) {
602
		return READ_ONCE(sk->sk_peek_off);
603 604 605
	}

	return 0;
606 607 608 609
}

static inline void sk_peek_offset_bwd(struct sock *sk, int val)
{
610 611 612 613 614
	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);
615 616 617 618 619
	}
}

static inline void sk_peek_offset_fwd(struct sock *sk, int val)
{
620
	sk_peek_offset_bwd(sk, -val);
621 622
}

L
Linus Torvalds 已提交
623 624 625
/*
 * Hashed lists helper routines
 */
L
Li Zefan 已提交
626 627 628 629 630
static inline struct sock *sk_entry(const struct hlist_node *node)
{
	return hlist_entry(node, struct sock, sk_node);
}

631
static inline struct sock *__sk_head(const struct hlist_head *head)
L
Linus Torvalds 已提交
632 633 634 635
{
	return hlist_entry(head->first, struct sock, sk_node);
}

636
static inline struct sock *sk_head(const struct hlist_head *head)
L
Linus Torvalds 已提交
637 638 639 640
{
	return hlist_empty(head) ? NULL : __sk_head(head);
}

641 642 643 644 645 646 647 648 649 650
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);
}

651
static inline struct sock *sk_next(const struct sock *sk)
L
Linus Torvalds 已提交
652
{
G
Geliang Tang 已提交
653
	return hlist_entry_safe(sk->sk_node.next, struct sock, sk_node);
L
Linus Torvalds 已提交
654 655
}

656 657 658 659 660 661 662 663
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 已提交
664
static inline bool sk_unhashed(const struct sock *sk)
L
Linus Torvalds 已提交
665 666 667 668
{
	return hlist_unhashed(&sk->sk_node);
}

E
Eric Dumazet 已提交
669
static inline bool sk_hashed(const struct sock *sk)
L
Linus Torvalds 已提交
670
{
A
Akinobu Mita 已提交
671
	return !sk_unhashed(sk);
L
Linus Torvalds 已提交
672 673
}

E
Eric Dumazet 已提交
674
static inline void sk_node_init(struct hlist_node *node)
L
Linus Torvalds 已提交
675 676 677 678
{
	node->pprev = NULL;
}

E
Eric Dumazet 已提交
679
static inline void sk_nulls_node_init(struct hlist_nulls_node *node)
680 681 682 683
{
	node->pprev = NULL;
}

E
Eric Dumazet 已提交
684
static inline void __sk_del_node(struct sock *sk)
L
Linus Torvalds 已提交
685 686 687 688
{
	__hlist_del(&sk->sk_node);
}

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

/* 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.
 */

706
static __always_inline void sock_hold(struct sock *sk)
L
Linus Torvalds 已提交
707
{
708
	refcount_inc(&sk->sk_refcnt);
L
Linus Torvalds 已提交
709 710 711 712 713
}

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

E
Eric Dumazet 已提交
719
static inline bool sk_del_node_init(struct sock *sk)
L
Linus Torvalds 已提交
720
{
E
Eric Dumazet 已提交
721
	bool rc = __sk_del_node_init(sk);
L
Linus Torvalds 已提交
722 723 724

	if (rc) {
		/* paranoid for a while -acme */
725
		WARN_ON(refcount_read(&sk->sk_refcnt) == 1);
L
Linus Torvalds 已提交
726 727 728 729
		__sock_put(sk);
	}
	return rc;
}
730
#define sk_del_node_init_rcu(sk)	sk_del_node_init(sk)
L
Linus Torvalds 已提交
731

E
Eric Dumazet 已提交
732
static inline bool __sk_nulls_del_node_init_rcu(struct sock *sk)
733 734
{
	if (sk_hashed(sk)) {
735
		hlist_nulls_del_init_rcu(&sk->sk_nulls_node);
E
Eric Dumazet 已提交
736
		return true;
737
	}
E
Eric Dumazet 已提交
738
	return false;
739 740
}

E
Eric Dumazet 已提交
741
static inline bool sk_nulls_del_node_init_rcu(struct sock *sk)
742
{
E
Eric Dumazet 已提交
743
	bool rc = __sk_nulls_del_node_init_rcu(sk);
744 745 746

	if (rc) {
		/* paranoid for a while -acme */
747
		WARN_ON(refcount_read(&sk->sk_refcnt) == 1);
748 749 750 751 752
		__sock_put(sk);
	}
	return rc;
}

E
Eric Dumazet 已提交
753
static inline void __sk_add_node(struct sock *sk, struct hlist_head *list)
L
Linus Torvalds 已提交
754 755 756 757
{
	hlist_add_head(&sk->sk_node, list);
}

E
Eric Dumazet 已提交
758
static inline void sk_add_node(struct sock *sk, struct hlist_head *list)
L
Linus Torvalds 已提交
759 760 761 762 763
{
	sock_hold(sk);
	__sk_add_node(sk, list);
}

E
Eric Dumazet 已提交
764
static inline void sk_add_node_rcu(struct sock *sk, struct hlist_head *list)
765 766
{
	sock_hold(sk);
767 768 769 770 771
	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);
772 773
}

774 775 776 777 778 779
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 已提交
780
static inline void __sk_nulls_add_node_rcu(struct sock *sk, struct hlist_nulls_head *list)
781
{
782
	hlist_nulls_add_head_rcu(&sk->sk_nulls_node, list);
783 784
}

785 786 787 788 789
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 已提交
790
static inline void sk_nulls_add_node_rcu(struct sock *sk, struct hlist_nulls_head *list)
791 792
{
	sock_hold(sk);
793
	__sk_nulls_add_node_rcu(sk, list);
794 795
}

E
Eric Dumazet 已提交
796
static inline void __sk_del_bind_node(struct sock *sk)
L
Linus Torvalds 已提交
797 798 799 800
{
	__hlist_del(&sk->sk_bind_node);
}

E
Eric Dumazet 已提交
801
static inline void sk_add_bind_node(struct sock *sk,
L
Linus Torvalds 已提交
802 803 804 805 806
					struct hlist_head *list)
{
	hlist_add_head(&sk->sk_bind_node, list);
}

807 808 809 810
#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)
811 812 813 814
#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)
815 816
#define sk_for_each_from(__sk) \
	hlist_for_each_entry_from(__sk, sk_node)
817 818 819
#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)
820 821 822 823
#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 已提交
824

825
/**
826
 * sk_for_each_entry_offset_rcu - iterate over a list at a given struct offset
827 828 829 830 831 832
 * @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.
 *
 */
833
#define sk_for_each_entry_offset_rcu(tpos, pos, head, offset)		       \
834
	for (pos = rcu_dereference(hlist_first_rcu(head));		       \
835
	     pos != NULL &&						       \
836
		({ tpos = (typeof(*tpos) *)((void *)pos - offset); 1;});       \
837
	     pos = rcu_dereference(hlist_next_rcu(pos)))
838

E
Eric W. Biederman 已提交
839 840 841 842 843 844 845 846 847
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 已提交
848 849 850 851 852 853 854 855 856 857 858 859 860 861
/* 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 */
862
	SOCK_RCVTSTAMPNS, /* %SO_TIMESTAMPNS setting */
L
Linus Torvalds 已提交
863
	SOCK_LOCALROUTE, /* route locally only, %SO_DONTROUTE setting */
864
	SOCK_MEMALLOC, /* VM depends on this socket for swapping */
865
	SOCK_TIMESTAMPING_RX_SOFTWARE,  /* %SOF_TIMESTAMPING_RX_SOFTWARE */
E
Eric Dumazet 已提交
866
	SOCK_FASYNC, /* fasync() active */
867
	SOCK_RXQ_OVFL,
868
	SOCK_ZEROCOPY, /* buffers from userspace */
869
	SOCK_WIFI_STATUS, /* push wifi status to userspace */
870 871 872 873
	SOCK_NOFCS, /* Tell NIC not to do the Ethernet FCS.
		     * Will use last 4 bytes of packet sent from
		     * user-space instead.
		     */
874
	SOCK_FILTER_LOCKED, /* Filter cannot be changed anymore */
875
	SOCK_SELECT_ERR_QUEUE, /* Wake select on error queue */
876
	SOCK_RCU_FREE, /* wait rcu grace period in sk_destruct() */
877
	SOCK_TXTIME,
J
Jason Wang 已提交
878
	SOCK_XDP, /* XDP is attached */
879
	SOCK_TSTAMP_NEW, /* Indicates 64 bit timestamps always */
L
Linus Torvalds 已提交
880 881
};

882 883
#define SK_FLAGS_TIMESTAMP ((1UL << SOCK_TIMESTAMP) | (1UL << SOCK_TIMESTAMPING_RX_SOFTWARE))

R
Ralf Baechle 已提交
884 885 886 887 888
static inline void sock_copy_flags(struct sock *nsk, struct sock *osk)
{
	nsk->sk_flags = osk->sk_flags;
}

L
Linus Torvalds 已提交
889 890 891 892 893 894 895 896 897 898
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);
}

899 900 901 902 903 904 905 906 907
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 已提交
908
static inline bool sock_flag(const struct sock *sk, enum sock_flags flag)
L
Linus Torvalds 已提交
909 910 911 912
{
	return test_bit(flag, &sk->sk_flags);
}

913
#ifdef CONFIG_NET
914
DECLARE_STATIC_KEY_FALSE(memalloc_socks_key);
915 916
static inline int sk_memalloc_socks(void)
{
917
	return static_branch_unlikely(&memalloc_socks_key);
918
}
919 920

void __receive_sock(struct file *file);
921 922 923 924 925 926 927
#else

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

928 929
static inline void __receive_sock(struct file *file)
{ }
930 931
#endif

932
static inline gfp_t sk_gfp_mask(const struct sock *sk, gfp_t gfp_mask)
933
{
934
	return gfp_mask | (sk->sk_allocation & __GFP_MEMALLOC);
935 936
}

L
Linus Torvalds 已提交
937 938
static inline void sk_acceptq_removed(struct sock *sk)
{
939
	WRITE_ONCE(sk->sk_ack_backlog, sk->sk_ack_backlog - 1);
L
Linus Torvalds 已提交
940 941 942 943
}

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

947 948 949 950
/* 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 已提交
951
static inline bool sk_acceptq_is_full(const struct sock *sk)
L
Linus Torvalds 已提交
952
{
953
	return READ_ONCE(sk->sk_ack_backlog) > READ_ONCE(sk->sk_max_ack_backlog);
L
Linus Torvalds 已提交
954 955 956 957 958
}

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

E
Eric Dumazet 已提交
964
static inline int sk_stream_wspace(const struct sock *sk)
L
Linus Torvalds 已提交
965
{
966 967 968 969 970 971
	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 已提交
972 973
}

974
void sk_stream_write_space(struct sock *sk);
L
Linus Torvalds 已提交
975

Z
Zhu Yi 已提交
976
/* OOB backlog add */
Z
Zhu Yi 已提交
977
static inline void __sk_add_backlog(struct sock *sk, struct sk_buff *skb)
978
{
E
Eric Dumazet 已提交
979
	/* dont let skb dst not refcounted, we are going to leave rcu lock */
E
Eric Dumazet 已提交
980
	skb_dst_force(skb);
E
Eric Dumazet 已提交
981 982

	if (!sk->sk_backlog.tail)
983
		WRITE_ONCE(sk->sk_backlog.head, skb);
E
Eric Dumazet 已提交
984
	else
985
		sk->sk_backlog.tail->next = skb;
E
Eric Dumazet 已提交
986

987
	WRITE_ONCE(sk->sk_backlog.tail, skb);
988 989
	skb->next = NULL;
}
L
Linus Torvalds 已提交
990

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

1000
	return qsize > limit;
1001 1002
}

Z
Zhu Yi 已提交
1003
/* The per-socket spinlock must be held here. */
1004 1005
static inline __must_check int sk_add_backlog(struct sock *sk, struct sk_buff *skb,
					      unsigned int limit)
Z
Zhu Yi 已提交
1006
{
1007
	if (sk_rcvqueues_full(sk, limit))
Z
Zhu Yi 已提交
1008 1009
		return -ENOBUFS;

1010 1011 1012 1013 1014 1015 1016 1017
	/*
	 * 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 已提交
1018
	__sk_add_backlog(sk, skb);
Z
Zhu Yi 已提交
1019 1020 1021 1022
	sk->sk_backlog.len += skb->truesize;
	return 0;
}

1023
int __sk_backlog_rcv(struct sock *sk, struct sk_buff *skb);
1024

P
Peter Zijlstra 已提交
1025 1026
static inline int sk_backlog_rcv(struct sock *sk, struct sk_buff *skb)
{
1027 1028 1029
	if (sk_memalloc_socks() && skb_pfmemalloc(skb))
		return __sk_backlog_rcv(sk, skb);

P
Peter Zijlstra 已提交
1030 1031 1032
	return sk->sk_backlog_rcv(sk, skb);
}

E
Eric Dumazet 已提交
1033 1034
static inline void sk_incoming_cpu_update(struct sock *sk)
{
1035 1036
	int cpu = raw_smp_processor_id();

1037 1038
	if (unlikely(READ_ONCE(sk->sk_incoming_cpu) != cpu))
		WRITE_ONCE(sk->sk_incoming_cpu, cpu);
E
Eric Dumazet 已提交
1039 1040
}

1041
static inline void sock_rps_record_flow_hash(__u32 hash)
1042 1043 1044 1045 1046 1047
{
#ifdef CONFIG_RPS
	struct rps_sock_flow_table *sock_flow_table;

	rcu_read_lock();
	sock_flow_table = rcu_dereference(rps_sock_flow_table);
1048
	rps_record_sock_flow(sock_flow_table, hash);
1049 1050 1051 1052
	rcu_read_unlock();
#endif
}

1053 1054
static inline void sock_rps_record_flow(const struct sock *sk)
{
1055
#ifdef CONFIG_RPS
1056
	if (static_branch_unlikely(&rfs_needed)) {
E
Eric Dumazet 已提交
1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069
		/* 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);
	}
1070
#endif
1071 1072
}

1073 1074
static inline void sock_rps_save_rxhash(struct sock *sk,
					const struct sk_buff *skb)
1075 1076
{
#ifdef CONFIG_RPS
1077
	if (unlikely(sk->sk_rxhash != skb->hash))
1078
		sk->sk_rxhash = skb->hash;
1079 1080 1081
#endif
}

1082 1083 1084 1085 1086 1087 1088
static inline void sock_rps_reset_rxhash(struct sock *sk)
{
#ifdef CONFIG_RPS
	sk->sk_rxhash = 0;
#endif
}

W
WANG Cong 已提交
1089
#define sk_wait_event(__sk, __timeo, __condition, __wait)		\
S
Stephen Hemminger 已提交
1090 1091 1092 1093
	({	int __rc;						\
		release_sock(__sk);					\
		__rc = __condition;					\
		if (!__rc) {						\
W
WANG Cong 已提交
1094 1095 1096
			*(__timeo) = wait_woken(__wait,			\
						TASK_INTERRUPTIBLE,	\
						*(__timeo));		\
S
Stephen Hemminger 已提交
1097
		}							\
W
WANG Cong 已提交
1098
		sched_annotate_sleep();					\
S
Stephen Hemminger 已提交
1099 1100 1101 1102
		lock_sock(__sk);					\
		__rc = __condition;					\
		__rc;							\
	})
L
Linus Torvalds 已提交
1103

1104 1105 1106 1107 1108 1109 1110
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 已提交
1111

1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122
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;
}

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

1125
struct request_sock_ops;
1126
struct timewait_sock_ops;
1127
struct inet_hashinfo;
1128
struct raw_hashinfo;
1129
struct smc_hashinfo;
1130
struct module;
1131
struct sk_psock;
1132

E
Eric Dumazet 已提交
1133
/*
1134
 * caches using SLAB_TYPESAFE_BY_RCU should let .next pointer from nulls nodes
E
Eric Dumazet 已提交
1135 1136 1137 1138 1139 1140 1141 1142 1143 1144
 * 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 已提交
1145 1146 1147 1148
/* Networking protocol blocks we attach to sockets.
 * socket layer -> transport layer interface
 */
struct proto {
E
Eric Dumazet 已提交
1149
	void			(*close)(struct sock *sk,
L
Linus Torvalds 已提交
1150
					long timeout);
A
Andrey Ignatov 已提交
1151 1152 1153
	int			(*pre_connect)(struct sock *sk,
					struct sockaddr *uaddr,
					int addr_len);
L
Linus Torvalds 已提交
1154
	int			(*connect)(struct sock *sk,
E
Eric Dumazet 已提交
1155
					struct sockaddr *uaddr,
L
Linus Torvalds 已提交
1156 1157 1158
					int addr_len);
	int			(*disconnect)(struct sock *sk, int flags);

1159 1160
	struct sock *		(*accept)(struct sock *sk, int flags, int *err,
					  bool kern);
L
Linus Torvalds 已提交
1161 1162 1163 1164

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

E
Eric Dumazet 已提交
1190
	int			(*backlog_rcv) (struct sock *sk,
L
Linus Torvalds 已提交
1191
						struct sk_buff *skb);
1192 1193
	bool			(*bpf_bypass_getsockopt)(int level,
							 int optname);
L
Linus Torvalds 已提交
1194

E
Eric Dumazet 已提交
1195 1196
	void		(*release_cb)(struct sock *sk);

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

1208
	/* Keeping track of sockets in use */
1209
#ifdef CONFIG_PROC_FS
1210
	unsigned int		inuse_idx;
1211
#endif
1212

1213 1214
	int			(*forward_alloc_get)(const struct sock *sk);

1215
	bool			(*stream_memory_free)(const struct sock *sk, int wake);
1216
	bool			(*stream_memory_read)(const struct sock *sk);
L
Linus Torvalds 已提交
1217
	/* Memory pressure */
1218
	void			(*enter_memory_pressure)(struct sock *sk);
1219
	void			(*leave_memory_pressure)(struct sock *sk);
E
Eric Dumazet 已提交
1220
	atomic_long_t		*memory_allocated;	/* Current allocated memory. */
1221
	struct percpu_counter	*sockets_allocated;	/* Current number of sockets. */
1222

L
Linus Torvalds 已提交
1223 1224 1225
	/*
	 * Pressure flag: try to collapse.
	 * Technical note: it is used by multiple contexts non atomically.
1226
	 * All the __sk_mem_schedule() is of this nature: accounting
L
Linus Torvalds 已提交
1227 1228
	 * is strict, actions are advisory and have some latency.
	 */
1229
	unsigned long		*memory_pressure;
E
Eric Dumazet 已提交
1230
	long			*sysctl_mem;
1231

L
Linus Torvalds 已提交
1232 1233
	int			*sysctl_wmem;
	int			*sysctl_rmem;
1234 1235 1236
	u32			sysctl_wmem_offset;
	u32			sysctl_rmem_offset;

L
Linus Torvalds 已提交
1237
	int			max_header;
1238
	bool			no_autobind;
L
Linus Torvalds 已提交
1239

1240
	struct kmem_cache	*slab;
L
Linus Torvalds 已提交
1241
	unsigned int		obj_size;
1242
	slab_flags_t		slab_flags;
1243 1244
	unsigned int		useroffset;	/* Usercopy region offset */
	unsigned int		usersize;	/* Usercopy region size */
L
Linus Torvalds 已提交
1245

1246
	unsigned int __percpu	*orphan_count;
1247

1248
	struct request_sock_ops	*rsk_prot;
1249
	struct timewait_sock_ops *twsk_prot;
1250

1251 1252
	union {
		struct inet_hashinfo	*hashinfo;
1253
		struct udp_table	*udp_table;
1254
		struct raw_hashinfo	*raw_hash;
1255
		struct smc_hashinfo	*smc_hash;
1256
	} h;
1257

L
Linus Torvalds 已提交
1258 1259 1260 1261 1262
	struct module		*owner;

	char			name[32];

	struct list_head	node;
1263 1264
#ifdef SOCK_REFCNT_DEBUG
	atomic_t		socks;
G
Glauber Costa 已提交
1265
#endif
1266
	int			(*diag_destroy)(struct sock *sk, int err);
1267
} __randomize_layout;
G
Glauber Costa 已提交
1268

1269 1270
int proto_register(struct proto *prot, int alloc_slab);
void proto_unregister(struct proto *prot);
1271
int sock_load_diag_module(int family, int protocol);
L
Linus Torvalds 已提交
1272

1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285
#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));
}

1286
static inline void sk_refcnt_debug_release(const struct sock *sk)
1287
{
1288
	if (refcount_read(&sk->sk_refcnt) != 1)
1289
		printk(KERN_DEBUG "Destruction of the %s socket %p delayed, refcnt=%d\n",
1290
		       sk->sk_prot->name, sk, refcount_read(&sk->sk_refcnt));
1291 1292 1293 1294 1295 1296 1297
}
#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 */

1298 1299
INDIRECT_CALLABLE_DECLARE(bool tcp_stream_memory_free(const struct sock *sk, int wake));

1300 1301 1302 1303 1304 1305 1306 1307
static inline int sk_forward_alloc_get(const struct sock *sk)
{
	if (!sk->sk_prot->forward_alloc_get)
		return sk->sk_forward_alloc;

	return sk->sk_prot->forward_alloc_get(sk);
}

1308
static inline bool __sk_stream_memory_free(const struct sock *sk, int wake)
1309
{
1310
	if (READ_ONCE(sk->sk_wmem_queued) >= READ_ONCE(sk->sk_sndbuf))
1311 1312
		return false;

1313
#ifdef CONFIG_INET
1314
	return sk->sk_prot->stream_memory_free ?
1315 1316 1317
		INDIRECT_CALL_1(sk->sk_prot->stream_memory_free,
			        tcp_stream_memory_free,
				sk, wake) : true;
1318
#else
1319
	return sk->sk_prot->stream_memory_free ?
1320
		sk->sk_prot->stream_memory_free(sk, wake) : true;
1321
#endif
1322 1323
}

1324 1325 1326 1327 1328 1329
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)
1330
{
1331
	return sk_stream_wspace(sk) >= sk_stream_min_wspace(sk) &&
1332 1333 1334 1335 1336 1337
	       __sk_stream_memory_free(sk, wake);
}

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

1340 1341 1342 1343 1344 1345 1346 1347 1348 1349
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
}
1350

1351 1352 1353 1354 1355 1356 1357 1358 1359
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 已提交
1360

1361 1362
	if (mem_cgroup_sockets_enabled && sk->sk_memcg &&
	    mem_cgroup_under_socket_pressure(sk->sk_memcg))
1363
		return true;
G
Glauber Costa 已提交
1364

1365
	return !!*sk->sk_prot->memory_pressure;
1366 1367 1368 1369 1370
}

static inline long
sk_memory_allocated(const struct sock *sk)
{
1371
	return atomic_long_read(sk->sk_prot->memory_allocated);
1372 1373 1374
}

static inline long
1375
sk_memory_allocated_add(struct sock *sk, int amt)
1376
{
1377
	return atomic_long_add_return(amt, sk->sk_prot->memory_allocated);
1378 1379 1380
}

static inline void
1381
sk_memory_allocated_sub(struct sock *sk, int amt)
1382
{
1383
	atomic_long_sub(amt, sk->sk_prot->memory_allocated);
1384 1385
}

1386 1387
#define SK_ALLOC_PERCPU_COUNTER_BATCH 16

1388 1389
static inline void sk_sockets_allocated_dec(struct sock *sk)
{
1390 1391
	percpu_counter_add_batch(sk->sk_prot->sockets_allocated, -1,
				 SK_ALLOC_PERCPU_COUNTER_BATCH);
1392 1393 1394 1395
}

static inline void sk_sockets_allocated_inc(struct sock *sk)
{
1396 1397
	percpu_counter_add_batch(sk->sk_prot->sockets_allocated, 1,
				 SK_ALLOC_PERCPU_COUNTER_BATCH);
1398 1399
}

1400
static inline u64
1401 1402
sk_sockets_allocated_read_positive(struct sock *sk)
{
1403
	return percpu_counter_read_positive(sk->sk_prot->sockets_allocated);
1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425
}

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;
}

1426 1427

#ifdef CONFIG_PROC_FS
L
Linus Torvalds 已提交
1428
/* Called with local bh disabled */
1429 1430
void sock_prot_inuse_add(struct net *net, struct proto *prot, int inc);
int sock_prot_inuse_get(struct net *net, struct proto *proto);
1431
int sock_inuse_get(struct net *net);
1432
#else
E
Eric Dumazet 已提交
1433
static inline void sock_prot_inuse_add(struct net *net, struct proto *prot,
1434
		int inc)
1435 1436 1437 1438
{
}
#endif

L
Linus Torvalds 已提交
1439

1440 1441 1442
/* With per-bucket locks this operation is not-atomic, so that
 * this version is not worse.
 */
1443
static inline int __sk_prot_rehash(struct sock *sk)
1444 1445
{
	sk->sk_prot->unhash(sk);
1446
	return sk->sk_prot->hash(sk);
1447 1448
}

L
Linus Torvalds 已提交
1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476
/* 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;
}

1477 1478 1479
/*
 * Functions for memory accounting
 */
1480
int __sk_mem_raise_allocated(struct sock *sk, int size, int amt, int kind);
1481
int __sk_mem_schedule(struct sock *sk, int size, int kind);
1482
void __sk_mem_reduce_allocated(struct sock *sk, int amount);
E
Eric Dumazet 已提交
1483
void __sk_mem_reclaim(struct sock *sk, int amount);
L
Linus Torvalds 已提交
1484

E
Eric Dumazet 已提交
1485 1486 1487 1488
/* 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
1489 1490 1491
#define SK_MEM_QUANTUM_SHIFT ilog2(SK_MEM_QUANTUM)
#define SK_MEM_SEND	0
#define SK_MEM_RECV	1
L
Linus Torvalds 已提交
1492

E
Eric Dumazet 已提交
1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505
/* 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;
}

1506
static inline int sk_mem_pages(int amt)
L
Linus Torvalds 已提交
1507
{
1508
	return (amt + SK_MEM_QUANTUM - 1) >> SK_MEM_QUANTUM_SHIFT;
L
Linus Torvalds 已提交
1509 1510
}

E
Eric Dumazet 已提交
1511
static inline bool sk_has_account(struct sock *sk)
L
Linus Torvalds 已提交
1512
{
1513 1514
	/* return true if protocol supports memory accounting */
	return !!sk->sk_prot->memory_allocated;
L
Linus Torvalds 已提交
1515 1516
}

E
Eric Dumazet 已提交
1517
static inline bool sk_wmem_schedule(struct sock *sk, int size)
L
Linus Torvalds 已提交
1518
{
1519
	if (!sk_has_account(sk))
E
Eric Dumazet 已提交
1520
		return true;
1521 1522
	return size <= sk->sk_forward_alloc ||
		__sk_mem_schedule(sk, size, SK_MEM_SEND);
L
Linus Torvalds 已提交
1523 1524
}

1525
static inline bool
1526
sk_rmem_schedule(struct sock *sk, struct sk_buff *skb, int size)
H
Herbert Xu 已提交
1527
{
1528
	if (!sk_has_account(sk))
E
Eric Dumazet 已提交
1529
		return true;
M
Miaohe Lin 已提交
1530
	return size <= sk->sk_forward_alloc ||
1531 1532
		__sk_mem_schedule(sk, size, SK_MEM_RECV) ||
		skb_pfmemalloc(skb);
1533 1534
}

1535 1536 1537 1538 1539 1540 1541 1542 1543 1544 1545 1546 1547
static inline int sk_unused_reserved_mem(const struct sock *sk)
{
	int unused_mem;

	if (likely(!sk->sk_reserved_mem))
		return 0;

	unused_mem = sk->sk_reserved_mem - sk->sk_wmem_queued -
			atomic_read(&sk->sk_rmem_alloc);

	return unused_mem > 0 ? unused_mem : 0;
}

1548 1549
static inline void sk_mem_reclaim(struct sock *sk)
{
1550 1551
	int reclaimable;

1552 1553
	if (!sk_has_account(sk))
		return;
1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 1564

	reclaimable = sk->sk_forward_alloc - sk_unused_reserved_mem(sk);

	if (reclaimable >= SK_MEM_QUANTUM)
		__sk_mem_reclaim(sk, reclaimable);
}

static inline void sk_mem_reclaim_final(struct sock *sk)
{
	sk->sk_reserved_mem = 0;
	sk_mem_reclaim(sk);
1565 1566
}

1567 1568
static inline void sk_mem_reclaim_partial(struct sock *sk)
{
1569 1570
	int reclaimable;

1571 1572
	if (!sk_has_account(sk))
		return;
1573 1574 1575 1576 1577

	reclaimable = sk->sk_forward_alloc - sk_unused_reserved_mem(sk);

	if (reclaimable > SK_MEM_QUANTUM)
		__sk_mem_reclaim(sk, reclaimable - 1);
1578 1579
}

1580 1581 1582 1583 1584 1585 1586
static inline void sk_mem_charge(struct sock *sk, int size)
{
	if (!sk_has_account(sk))
		return;
	sk->sk_forward_alloc -= size;
}

1587 1588 1589 1590 1591
/* the following macros control memory reclaiming in sk_mem_uncharge()
 */
#define SK_RECLAIM_THRESHOLD	(1 << 21)
#define SK_RECLAIM_CHUNK	(1 << 20)

1592 1593
static inline void sk_mem_uncharge(struct sock *sk, int size)
{
1594 1595
	int reclaimable;

1596 1597 1598
	if (!sk_has_account(sk))
		return;
	sk->sk_forward_alloc += size;
1599
	reclaimable = sk->sk_forward_alloc - sk_unused_reserved_mem(sk);
1600 1601 1602 1603 1604 1605 1606 1607

	/* 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.
	 */
1608 1609
	if (unlikely(reclaimable >= SK_RECLAIM_THRESHOLD))
		__sk_mem_reclaim(sk, SK_RECLAIM_CHUNK);
1610 1611 1612 1613
}

static inline void sk_wmem_free_skb(struct sock *sk, struct sk_buff *skb)
{
1614
	sk_wmem_queued_add(sk, -skb->truesize);
1615
	sk_mem_uncharge(sk, skb->truesize);
1616
	__kfree_skb(skb);
H
Herbert Xu 已提交
1617 1618
}

1619 1620
static inline void sock_release_ownership(struct sock *sk)
{
1621 1622 1623 1624
	if (sk->sk_lock.owned) {
		sk->sk_lock.owned = 0;

		/* The sk_lock has mutex_unlock() semantics: */
1625
		mutex_release(&sk->sk_lock.dep_map, _RET_IP_);
1626
	}
1627 1628
}

1629 1630 1631 1632 1633 1634 1635
/*
 * 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 已提交
1636
#define sock_lock_init_class_and_name(sk, sname, skey, name, key)	\
1637
do {									\
1638
	sk->sk_lock.owned = 0;						\
1639 1640 1641 1642 1643
	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 已提交
1644
				(skey), (sname));				\
1645 1646 1647
	lockdep_init_map(&(sk)->sk_lock.dep_map, (name), (key), 0);	\
} while (0)

1648
static inline bool lockdep_sock_is_held(const struct sock *sk)
1649 1650 1651 1652 1653
{
	return lockdep_is_held(&sk->sk_lock) ||
	       lockdep_is_held(&sk->sk_lock.slock);
}

1654
void lock_sock_nested(struct sock *sk, int subclass);
1655 1656 1657 1658 1659 1660

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

1661
void __lock_sock(struct sock *sk);
1662
void __release_sock(struct sock *sk);
1663
void release_sock(struct sock *sk);
L
Linus Torvalds 已提交
1664 1665 1666

/* BH context may only use the following locking interface. */
#define bh_lock_sock(__sk)	spin_lock(&((__sk)->sk_lock.slock))
1667 1668 1669
#define bh_lock_sock_nested(__sk) \
				spin_lock_nested(&((__sk)->sk_lock.slock), \
				SINGLE_DEPTH_NESTING)
L
Linus Torvalds 已提交
1670 1671
#define bh_unlock_sock(__sk)	spin_unlock(&((__sk)->sk_lock.slock))

1672 1673 1674 1675 1676 1677 1678 1679 1680 1681 1682 1683 1684 1685 1686 1687 1688 1689 1690 1691 1692 1693 1694 1695 1696 1697 1698 1699 1700 1701
bool __lock_sock_fast(struct sock *sk) __acquires(&sk->sk_lock.slock);

/**
 * lock_sock_fast - fast version of lock_sock
 * @sk: socket
 *
 * This version should be used for very small section, where process wont block
 * return false if fast path is taken:
 *
 *   sk_lock.slock locked, owned = 0, BH disabled
 *
 * return true if slow path is taken:
 *
 *   sk_lock.slock unlocked, owned = 1, BH enabled
 */
static inline bool lock_sock_fast(struct sock *sk)
{
	/* The sk_lock has mutex_lock() semantics here. */
	mutex_acquire(&sk->sk_lock.dep_map, 0, 0, _RET_IP_);

	return __lock_sock_fast(sk);
}

/* fast socket lock variant for caller already holding a [different] socket lock */
static inline bool lock_sock_fast_nested(struct sock *sk)
{
	mutex_acquire(&sk->sk_lock.dep_map, SINGLE_DEPTH_NESTING, 0, _RET_IP_);

	return __lock_sock_fast(sk);
}
1702

1703 1704 1705 1706 1707 1708 1709 1710 1711
/**
 * 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)
1712
	__releases(&sk->sk_lock.slock)
E
Eric Dumazet 已提交
1713
{
1714
	if (slow) {
1715
		release_sock(sk);
1716 1717
		__release(&sk->sk_lock.slock);
	} else {
1718
		mutex_release(&sk->sk_lock.dep_map, _RET_IP_);
1719
		spin_unlock_bh(&sk->sk_lock.slock);
1720
	}
E
Eric Dumazet 已提交
1721 1722
}

1723 1724 1725 1726 1727 1728 1729 1730 1731 1732 1733 1734 1735 1736
/* 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.
 */

1737
static inline void sock_owned_by_me(const struct sock *sk)
1738 1739
{
#ifdef CONFIG_LOCKDEP
1740
	WARN_ON_ONCE(!lockdep_sock_is_held(sk) && debug_locks);
1741
#endif
1742 1743 1744 1745 1746
}

static inline bool sock_owned_by_user(const struct sock *sk)
{
	sock_owned_by_me(sk);
1747 1748 1749
	return sk->sk_lock.owned;
}

T
Tom Herbert 已提交
1750 1751 1752 1753 1754
static inline bool sock_owned_by_user_nocheck(const struct sock *sk)
{
	return sk->sk_lock.owned;
}

1755 1756 1757 1758 1759 1760 1761
/* 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 已提交
1762

1763
struct sock *sk_alloc(struct net *net, int family, gfp_t priority,
1764
		      struct proto *prot, int kern);
1765
void sk_free(struct sock *sk);
1766
void sk_destruct(struct sock *sk);
1767
struct sock *sk_clone_lock(const struct sock *sk, const gfp_t priority);
1768
void sk_free_unlock_clone(struct sock *sk);
1769 1770 1771

struct sk_buff *sock_wmalloc(struct sock *sk, unsigned long size, int force,
			     gfp_t priority);
E
Eric Dumazet 已提交
1772
void __sock_wfree(struct sk_buff *skb);
1773
void sock_wfree(struct sk_buff *skb);
1774 1775
struct sk_buff *sock_omalloc(struct sock *sk, unsigned long size,
			     gfp_t priority);
1776 1777
void skb_orphan_partial(struct sk_buff *skb);
void sock_rfree(struct sk_buff *skb);
1778
void sock_efree(struct sk_buff *skb);
1779
#ifdef CONFIG_INET
1780
void sock_edemux(struct sk_buff *skb);
J
Joe Stringer 已提交
1781
void sock_pfree(struct sk_buff *skb);
1782
#else
1783
#define sock_edemux sock_efree
1784
#endif
1785 1786

int sock_setsockopt(struct socket *sock, int level, int op,
1787
		    sockptr_t optval, unsigned int optlen);
1788 1789 1790

int sock_getsockopt(struct socket *sock, int level, int op,
		    char __user *optval, int __user *optlen);
1791 1792
int sock_gettstamp(struct socket *sock, void __user *userstamp,
		   bool timeval, bool time32);
1793 1794 1795 1796 1797 1798 1799
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);
1800
void sock_kzfree_s(struct sock *sk, void *mem, int size);
1801
void sk_send_sigurg(struct sock *sk);
L
Linus Torvalds 已提交
1802

E
Edward Jee 已提交
1803
struct sockcm_cookie {
1804
	u64 transmit_time;
E
Edward Jee 已提交
1805
	u32 mark;
1806
	u16 tsflags;
E
Edward Jee 已提交
1807 1808
};

1809 1810 1811 1812 1813 1814
static inline void sockcm_init(struct sockcm_cookie *sockc,
			       const struct sock *sk)
{
	*sockc = (struct sockcm_cookie) { .tsflags = sk->sk_tsflags };
}

1815 1816
int __sock_cmsg_send(struct sock *sk, struct msghdr *msg, struct cmsghdr *cmsg,
		     struct sockcm_cookie *sockc);
E
Edward Jee 已提交
1817 1818 1819
int sock_cmsg_send(struct sock *sk, struct msghdr *msg,
		   struct sockcm_cookie *sockc);

L
Linus Torvalds 已提交
1820 1821 1822 1823
/*
 * Functions to fill in entries in struct proto_ops when a protocol
 * does not implement a particular function.
 */
1824 1825 1826
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 *);
1827
int sock_no_accept(struct socket *, struct socket *, int, bool);
1828
int sock_no_getname(struct socket *, struct sockaddr *, int);
1829 1830 1831
int sock_no_ioctl(struct socket *, unsigned int, unsigned long);
int sock_no_listen(struct socket *, int);
int sock_no_shutdown(struct socket *, int);
1832
int sock_no_sendmsg(struct socket *, struct msghdr *, size_t);
1833
int sock_no_sendmsg_locked(struct sock *sk, struct msghdr *msg, size_t len);
1834
int sock_no_recvmsg(struct socket *, struct msghdr *, size_t, int);
1835 1836 1837 1838
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);
1839 1840
ssize_t sock_no_sendpage_locked(struct sock *sk, struct page *page,
				int offset, size_t size, int flags);
L
Linus Torvalds 已提交
1841 1842 1843 1844 1845

/*
 * Functions to fill in entries in struct proto_ops when a protocol
 * uses the inet style.
 */
1846
int sock_common_getsockopt(struct socket *sock, int level, int optname,
L
Linus Torvalds 已提交
1847
				  char __user *optval, int __user *optlen);
1848 1849
int sock_common_recvmsg(struct socket *sock, struct msghdr *msg, size_t size,
			int flags);
1850
int sock_common_setsockopt(struct socket *sock, int level, int optname,
1851
			   sockptr_t optval, unsigned int optlen);
L
Linus Torvalds 已提交
1852

1853
void sk_common_release(struct sock *sk);
L
Linus Torvalds 已提交
1854 1855 1856 1857

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

L
Linus Torvalds 已提交
1859
/* Initialise core socket variables */
1860
void sock_init_data(struct socket *sock, struct sock *sk);
L
Linus Torvalds 已提交
1861 1862 1863 1864 1865 1866 1867 1868 1869 1870 1871 1872 1873 1874 1875 1876 1877 1878 1879 1880 1881 1882 1883 1884 1885 1886 1887 1888 1889

/*
 * 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)
{
1890
	if (refcount_dec_and_test(&sk->sk_refcnt))
L
Linus Torvalds 已提交
1891 1892
		sk_free(sk);
}
E
Eric Dumazet 已提交
1893
/* Generic version of sock_put(), dealing with all sockets
1894
 * (TCP_TIMEWAIT, TCP_NEW_SYN_RECV, ESTABLISHED...)
E
Eric Dumazet 已提交
1895 1896
 */
void sock_gen_put(struct sock *sk);
L
Linus Torvalds 已提交
1897

1898
int __sk_receive_skb(struct sock *sk, struct sk_buff *skb, const int nested,
1899
		     unsigned int trim_cap, bool refcounted);
1900 1901 1902
static inline int sk_receive_skb(struct sock *sk, struct sk_buff *skb,
				 const int nested)
{
1903
	return __sk_receive_skb(sk, skb, nested, 1, true);
1904
}
1905

K
Krishna Kumar 已提交
1906 1907
static inline void sk_tx_queue_set(struct sock *sk, int tx_queue)
{
1908 1909 1910
	/* 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 已提交
1911 1912 1913
	sk->sk_tx_queue_mapping = tx_queue;
}

1914 1915
#define NO_QUEUE_MAPPING	USHRT_MAX

K
Krishna Kumar 已提交
1916 1917
static inline void sk_tx_queue_clear(struct sock *sk)
{
1918
	sk->sk_tx_queue_mapping = NO_QUEUE_MAPPING;
K
Krishna Kumar 已提交
1919 1920 1921 1922
}

static inline int sk_tx_queue_get(const struct sock *sk)
{
1923 1924 1925 1926
	if (sk && sk->sk_tx_queue_mapping != NO_QUEUE_MAPPING)
		return sk->sk_tx_queue_mapping;

	return -1;
K
Krishna Kumar 已提交
1927 1928
}

1929 1930
static inline void sk_rx_queue_set(struct sock *sk, const struct sk_buff *skb)
{
1931
#ifdef CONFIG_SOCK_RX_QUEUE_MAPPING
1932 1933 1934
	if (skb_rx_queue_recorded(skb)) {
		u16 rx_queue = skb_get_rx_queue(skb);

1935 1936
		if (unlikely(READ_ONCE(sk->sk_rx_queue_mapping) != rx_queue))
			WRITE_ONCE(sk->sk_rx_queue_mapping, rx_queue);
1937 1938 1939 1940 1941 1942
	}
#endif
}

static inline void sk_rx_queue_clear(struct sock *sk)
{
1943
#ifdef CONFIG_SOCK_RX_QUEUE_MAPPING
1944
	WRITE_ONCE(sk->sk_rx_queue_mapping, NO_QUEUE_MAPPING);
1945 1946 1947
#endif
}

1948 1949
static inline int sk_rx_queue_get(const struct sock *sk)
{
1950
#ifdef CONFIG_SOCK_RX_QUEUE_MAPPING
1951 1952 1953 1954 1955 1956
	if (sk) {
		int res = READ_ONCE(sk->sk_rx_queue_mapping);

		if (res != NO_QUEUE_MAPPING)
			return res;
	}
1957
#endif
1958 1959 1960 1961

	return -1;
}

1962 1963 1964 1965 1966
static inline void sk_set_socket(struct sock *sk, struct socket *sock)
{
	sk->sk_socket = sock;
}

E
Eric Dumazet 已提交
1967 1968
static inline wait_queue_head_t *sk_sleep(struct sock *sk)
{
1969 1970
	BUILD_BUG_ON(offsetof(struct socket_wq, wait) != 0);
	return &rcu_dereference_raw(sk->sk_wq)->wait;
E
Eric Dumazet 已提交
1971
}
L
Linus Torvalds 已提交
1972 1973 1974 1975 1976 1977 1978 1979 1980 1981 1982
/* 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);
1983
	sk_set_socket(sk, NULL);
1984
	sk->sk_wq  = NULL;
L
Linus Torvalds 已提交
1985 1986 1987 1988 1989
	write_unlock_bh(&sk->sk_callback_lock);
}

static inline void sock_graft(struct sock *sk, struct socket *parent)
{
1990
	WARN_ON(parent->sk);
L
Linus Torvalds 已提交
1991
	write_lock_bh(&sk->sk_callback_lock);
1992
	rcu_assign_pointer(sk->sk_wq, &parent->wq);
L
Linus Torvalds 已提交
1993
	parent->sk = sk;
1994
	sk_set_socket(sk, parent);
1995
	sk->sk_uid = SOCK_INODE(parent)->i_uid;
1996
	security_sock_graft(sk, parent);
L
Linus Torvalds 已提交
1997 1998 1999
	write_unlock_bh(&sk->sk_callback_lock);
}

2000 2001
kuid_t sock_i_uid(struct sock *sk);
unsigned long sock_i_ino(struct sock *sk);
L
Linus Torvalds 已提交
2002

2003 2004 2005 2006 2007
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);
}

2008
static inline u32 net_tx_rndhash(void)
2009
{
2010 2011 2012 2013
	u32 v = prandom_u32();

	return v ?: 1;
}
2014

2015 2016
static inline void sk_set_txhash(struct sock *sk)
{
2017 2018
	/* This pairs with READ_ONCE() in skb_set_hash_from_sk() */
	WRITE_ONCE(sk->sk_txhash, net_tx_rndhash());
2019 2020
}

2021
static inline bool sk_rethink_txhash(struct sock *sk)
2022
{
2023
	if (sk->sk_txhash) {
2024
		sk_set_txhash(sk);
2025 2026 2027
		return true;
	}
	return false;
2028 2029
}

L
Linus Torvalds 已提交
2030 2031 2032
static inline struct dst_entry *
__sk_dst_get(struct sock *sk)
{
2033 2034
	return rcu_dereference_check(sk->sk_dst_cache,
				     lockdep_sock_is_held(sk));
L
Linus Torvalds 已提交
2035 2036 2037 2038 2039 2040 2041
}

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

E
Eric Dumazet 已提交
2042 2043
	rcu_read_lock();
	dst = rcu_dereference(sk->sk_dst_cache);
2044 2045
	if (dst && !atomic_inc_not_zero(&dst->__refcnt))
		dst = NULL;
E
Eric Dumazet 已提交
2046
	rcu_read_unlock();
L
Linus Torvalds 已提交
2047 2048 2049
	return dst;
}

2050
static inline void __dst_negative_advice(struct sock *sk)
E
Eric Dumazet 已提交
2051 2052 2053 2054 2055 2056 2057 2058
{
	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 已提交
2059
			sk_tx_queue_clear(sk);
2060
			sk->sk_dst_pending_confirm = 0;
E
Eric Dumazet 已提交
2061 2062 2063 2064
		}
	}
}

2065 2066 2067 2068 2069 2070
static inline void dst_negative_advice(struct sock *sk)
{
	sk_rethink_txhash(sk);
	__dst_negative_advice(sk);
}

L
Linus Torvalds 已提交
2071 2072 2073 2074 2075
static inline void
__sk_dst_set(struct sock *sk, struct dst_entry *dst)
{
	struct dst_entry *old_dst;

K
Krishna Kumar 已提交
2076
	sk_tx_queue_clear(sk);
2077
	sk->sk_dst_pending_confirm = 0;
2078 2079
	old_dst = rcu_dereference_protected(sk->sk_dst_cache,
					    lockdep_sock_is_held(sk));
E
Eric Dumazet 已提交
2080
	rcu_assign_pointer(sk->sk_dst_cache, dst);
L
Linus Torvalds 已提交
2081 2082 2083 2084 2085 2086
	dst_release(old_dst);
}

static inline void
sk_dst_set(struct sock *sk, struct dst_entry *dst)
{
2087 2088 2089
	struct dst_entry *old_dst;

	sk_tx_queue_clear(sk);
2090
	sk->sk_dst_pending_confirm = 0;
2091
	old_dst = xchg((__force struct dst_entry **)&sk->sk_dst_cache, dst);
2092
	dst_release(old_dst);
L
Linus Torvalds 已提交
2093 2094 2095 2096 2097
}

static inline void
__sk_dst_reset(struct sock *sk)
{
E
Eric Dumazet 已提交
2098
	__sk_dst_set(sk, NULL);
L
Linus Torvalds 已提交
2099 2100 2101 2102 2103
}

static inline void
sk_dst_reset(struct sock *sk)
{
2104
	sk_dst_set(sk, NULL);
L
Linus Torvalds 已提交
2105 2106
}

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

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

2111 2112
static inline void sk_dst_confirm(struct sock *sk)
{
2113 2114
	if (!READ_ONCE(sk->sk_dst_pending_confirm))
		WRITE_ONCE(sk->sk_dst_pending_confirm, 1);
2115 2116
}

2117 2118 2119 2120 2121 2122 2123
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 */
2124 2125 2126 2127
		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);
2128 2129 2130
	}
}

2131 2132
bool sk_mc_loop(struct sock *sk);

E
Eric Dumazet 已提交
2133
static inline bool sk_can_gso(const struct sock *sk)
2134 2135 2136 2137
{
	return net_gso_ok(sk->sk_route_caps, sk->sk_gso_type);
}

2138
void sk_setup_caps(struct sock *sk, struct dst_entry *dst);
2139

2140
static inline void sk_nocaps_add(struct sock *sk, netdev_features_t flags)
E
Eric Dumazet 已提交
2141 2142 2143 2144 2145
{
	sk->sk_route_nocaps |= flags;
	sk->sk_route_caps &= ~flags;
}

2146
static inline int skb_do_copy_data_nocache(struct sock *sk, struct sk_buff *skb,
2147
					   struct iov_iter *from, char *to,
2148
					   int copy, int offset)
2149 2150
{
	if (skb->ip_summed == CHECKSUM_NONE) {
2151
		__wsum csum = 0;
2152
		if (!csum_and_copy_from_iter_full(to, copy, &csum, from))
2153
			return -EFAULT;
2154
		skb->csum = csum_block_add(skb->csum, csum, offset);
2155
	} else if (sk->sk_route_caps & NETIF_F_NOCACHE_COPY) {
2156
		if (!copy_from_iter_full_nocache(to, copy, from))
2157
			return -EFAULT;
2158
	} else if (!copy_from_iter_full(to, copy, from))
2159 2160 2161 2162 2163 2164
		return -EFAULT;

	return 0;
}

static inline int skb_add_data_nocache(struct sock *sk, struct sk_buff *skb,
2165
				       struct iov_iter *from, int copy)
2166
{
2167
	int err, offset = skb->len;
2168

2169 2170
	err = skb_do_copy_data_nocache(sk, skb, from, skb_put(skb, copy),
				       copy, offset);
2171
	if (err)
2172
		__skb_trim(skb, offset);
2173 2174 2175 2176

	return err;
}

2177
static inline int skb_copy_to_page_nocache(struct sock *sk, struct iov_iter *from,
2178 2179 2180 2181 2182 2183
					   struct sk_buff *skb,
					   struct page *page,
					   int off, int copy)
{
	int err;

2184 2185
	err = skb_do_copy_data_nocache(sk, skb, from, page_address(page) + off,
				       copy, skb->len);
2186 2187 2188 2189 2190 2191
	if (err)
		return err;

	skb->len	     += copy;
	skb->data_len	     += copy;
	skb->truesize	     += copy;
2192
	sk_wmem_queued_add(sk, copy);
2193 2194 2195 2196
	sk_mem_charge(sk, copy);
	return 0;
}

2197 2198 2199 2200
/**
 * sk_wmem_alloc_get - returns write allocations
 * @sk: socket
 *
2201
 * Return: sk_wmem_alloc minus initial offset of one
2202 2203 2204
 */
static inline int sk_wmem_alloc_get(const struct sock *sk)
{
2205
	return refcount_read(&sk->sk_wmem_alloc) - 1;
2206 2207 2208 2209 2210 2211
}

/**
 * sk_rmem_alloc_get - returns read allocations
 * @sk: socket
 *
2212
 * Return: sk_rmem_alloc
2213 2214 2215 2216 2217 2218 2219 2220 2221 2222
 */
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
 *
2223
 * Return: true if socket has write or read allocations
2224
 */
E
Eric Dumazet 已提交
2225
static inline bool sk_has_allocations(const struct sock *sk)
2226 2227 2228 2229
{
	return sk_wmem_alloc_get(sk) || sk_rmem_alloc_get(sk);
}

2230
/**
H
Herbert Xu 已提交
2231
 * skwq_has_sleeper - check if there are any waiting processes
R
Randy Dunlap 已提交
2232
 * @wq: struct socket_wq
2233
 *
2234
 * Return: true if socket_wq has waiting processes
2235
 *
H
Herbert Xu 已提交
2236
 * The purpose of the skwq_has_sleeper and sock_poll_wait is to wrap the memory
2237 2238
 * barrier call. They were added due to the race found within the tcp code.
 *
2239
 * Consider following tcp code paths::
2240
 *
2241 2242
 *   CPU1                CPU2
 *   sys_select          receive packet
2243 2244 2245 2246 2247
 *   ...                 ...
 *   __add_wait_queue    update tp->rcv_nxt
 *   ...                 ...
 *   tp->rcv_nxt check   sock_def_readable
 *   ...                 {
2248 2249 2250 2251
 *   schedule               rcu_read_lock();
 *                          wq = rcu_dereference(sk->sk_wq);
 *                          if (wq && waitqueue_active(&wq->wait))
 *                              wake_up_interruptible(&wq->wait)
2252 2253 2254 2255 2256 2257 2258
 *                          ...
 *                       }
 *
 * 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.
2259
 *
2260
 */
H
Herbert Xu 已提交
2261
static inline bool skwq_has_sleeper(struct socket_wq *wq)
2262
{
H
Herbert Xu 已提交
2263
	return wq && wq_has_sleeper(&wq->wait);
2264 2265 2266 2267 2268
}

/**
 * sock_poll_wait - place memory barrier behind the poll_wait call.
 * @filp:           file
2269
 * @sock:           socket to wait on
2270 2271
 * @p:              poll_table
 *
2272
 * See the comments in the wq_has_sleeper function.
2273
 */
2274 2275
static inline void sock_poll_wait(struct file *filp, struct socket *sock,
				  poll_table *p)
2276
{
2277
	if (!poll_does_not_wait(p)) {
2278
		poll_wait(filp, &sock->wq.wait, p);
E
Eric Dumazet 已提交
2279
		/* We need to be sure we are in sync with the
2280 2281
		 * socket flags modification.
		 *
2282
		 * This memory barrier is paired in the wq_has_sleeper.
E
Eric Dumazet 已提交
2283
		 */
2284 2285 2286 2287
		smp_mb();
	}
}

2288 2289
static inline void skb_set_hash_from_sk(struct sk_buff *skb, struct sock *sk)
{
2290 2291 2292 2293
	/* This pairs with WRITE_ONCE() in sk_set_txhash() */
	u32 txhash = READ_ONCE(sk->sk_txhash);

	if (txhash) {
2294
		skb->l4_hash = 1;
2295
		skb->hash = txhash;
2296 2297 2298
	}
}

2299 2300
void skb_set_owner_w(struct sk_buff *skb, struct sock *sk);

L
Linus Torvalds 已提交
2301
/*
E
Eric Dumazet 已提交
2302
 *	Queue a received datagram if it will fit. Stream and sequenced
L
Linus Torvalds 已提交
2303 2304 2305
 *	protocols can't normally use this as they need to fit buffers in
 *	and play with them.
 *
E
Eric Dumazet 已提交
2306
 *	Inlined as it's very short and called for pretty much every
L
Linus Torvalds 已提交
2307 2308 2309 2310
 *	packet ever received.
 */
static inline void skb_set_owner_r(struct sk_buff *skb, struct sock *sk)
{
2311
	skb_orphan(skb);
L
Linus Torvalds 已提交
2312 2313 2314
	skb->sk = sk;
	skb->destructor = sock_rfree;
	atomic_add(skb->truesize, &sk->sk_rmem_alloc);
2315
	sk_mem_charge(sk, skb->truesize);
L
Linus Torvalds 已提交
2316 2317
}

2318
static inline __must_check bool skb_set_owner_sk_safe(struct sk_buff *skb, struct sock *sk)
2319 2320 2321 2322 2323
{
	if (sk && refcount_inc_not_zero(&sk->sk_refcnt)) {
		skb_orphan(skb);
		skb->destructor = sock_efree;
		skb->sk = sk;
2324
		return true;
2325
	}
2326
	return false;
2327 2328
}

2329 2330 2331 2332 2333 2334 2335 2336 2337
static inline void skb_prepare_for_gro(struct sk_buff *skb)
{
	if (skb->destructor != sock_wfree) {
		skb_orphan(skb);
		return;
	}
	skb->slow_gro = 1;
}

2338 2339
void sk_reset_timer(struct sock *sk, struct timer_list *timer,
		    unsigned long expires);
L
Linus Torvalds 已提交
2340

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

2343 2344
void sk_stop_timer_sync(struct sock *sk, struct timer_list *timer);

2345 2346
int __sk_queue_drop_skb(struct sock *sk, struct sk_buff_head *sk_queue,
			struct sk_buff *skb, unsigned int flags,
2347 2348
			void (*destructor)(struct sock *sk,
					   struct sk_buff *skb));
2349
int __sock_queue_rcv_skb(struct sock *sk, struct sk_buff *skb);
2350
int sock_queue_rcv_skb(struct sock *sk, struct sk_buff *skb);
L
Linus Torvalds 已提交
2351

2352
int sock_queue_err_skb(struct sock *sk, struct sk_buff *skb);
2353
struct sk_buff *sock_dequeue_err_skb(struct sock *sk);
L
Linus Torvalds 已提交
2354 2355 2356 2357

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

L
Linus Torvalds 已提交
2359 2360
static inline int sock_error(struct sock *sk)
{
2361
	int err;
2362 2363 2364 2365 2366

	/* 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)))
2367
		return 0;
2368

2369
	err = xchg(&sk->sk_err, 0);
L
Linus Torvalds 已提交
2370 2371 2372
	return -err;
}

2373 2374
void sk_error_report(struct sock *sk);

L
Linus Torvalds 已提交
2375 2376 2377 2378 2379
static inline unsigned long sock_wspace(struct sock *sk)
{
	int amt = 0;

	if (!(sk->sk_shutdown & SEND_SHUTDOWN)) {
2380
		amt = sk->sk_sndbuf - refcount_read(&sk->sk_wmem_alloc);
E
Eric Dumazet 已提交
2381
		if (amt < 0)
L
Linus Torvalds 已提交
2382 2383 2384 2385 2386
			amt = 0;
	}
	return amt;
}

2387 2388 2389 2390
/* Note:
 *  We use sk->sk_wq_raw, from contexts knowing this
 *  pointer is not NULL and cannot disappear/change.
 */
2391
static inline void sk_set_bit(int nr, struct sock *sk)
L
Linus Torvalds 已提交
2392
{
2393 2394
	if ((nr == SOCKWQ_ASYNC_NOSPACE || nr == SOCKWQ_ASYNC_WAITDATA) &&
	    !sock_flag(sk, SOCK_FASYNC))
2395 2396
		return;

2397
	set_bit(nr, &sk->sk_wq_raw->flags);
2398 2399 2400 2401
}

static inline void sk_clear_bit(int nr, struct sock *sk)
{
2402 2403
	if ((nr == SOCKWQ_ASYNC_NOSPACE || nr == SOCKWQ_ASYNC_WAITDATA) &&
	    !sock_flag(sk, SOCK_FASYNC))
2404 2405
		return;

2406
	clear_bit(nr, &sk->sk_wq_raw->flags);
2407 2408
}

2409
static inline void sk_wake_async(const struct sock *sk, int how, int band)
L
Linus Torvalds 已提交
2410
{
2411 2412 2413 2414 2415
	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 已提交
2416 2417
}

2418 2419 2420 2421
/* 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 已提交
2422
 */
2423
#define TCP_SKB_MIN_TRUESIZE	(2048 + SKB_DATA_ALIGN(sizeof(struct sk_buff)))
2424 2425 2426

#define SOCK_MIN_SNDBUF		(TCP_SKB_MIN_TRUESIZE * 2)
#define SOCK_MIN_RCVBUF		 TCP_SKB_MIN_TRUESIZE
L
Linus Torvalds 已提交
2427 2428 2429

static inline void sk_stream_moderate_sndbuf(struct sock *sk)
{
2430 2431 2432 2433 2434 2435
	u32 val;

	if (sk->sk_userlocks & SOCK_SNDBUF_LOCK)
		return;

	val = min(sk->sk_sndbuf, sk->sk_wmem_queued >> 1);
2436
	val = max_t(u32, val, sk_unused_reserved_mem(sk));
2437 2438

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

2441 2442 2443 2444
/**
 * sk_page_frag - return an appropriate page_frag
 * @sk: socket
 *
2445 2446 2447 2448 2449 2450 2451
 * 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.
2452 2453 2454
 *
 * Return: a per task page_frag if context allows that,
 * otherwise a per socket one.
2455 2456
 */
static inline struct page_frag *sk_page_frag(struct sock *sk)
L
Linus Torvalds 已提交
2457
{
2458
	if (gfpflags_normal_context(sk->sk_allocation))
2459
		return &current->task_frag;
L
Linus Torvalds 已提交
2460

2461
	return &sk->sk_frag;
L
Linus Torvalds 已提交
2462 2463
}

2464
bool sk_page_frag_refill(struct sock *sk, struct page_frag *pfrag);
2465

L
Linus Torvalds 已提交
2466 2467 2468
/*
 *	Default write policy as shown to user space via poll/select/SIGIO
 */
E
Eric Dumazet 已提交
2469
static inline bool sock_writeable(const struct sock *sk)
L
Linus Torvalds 已提交
2470
{
2471
	return refcount_read(&sk->sk_wmem_alloc) < (READ_ONCE(sk->sk_sndbuf) >> 1);
L
Linus Torvalds 已提交
2472 2473
}

A
Al Viro 已提交
2474
static inline gfp_t gfp_any(void)
L
Linus Torvalds 已提交
2475
{
2476
	return in_softirq() ? GFP_ATOMIC : GFP_KERNEL;
L
Linus Torvalds 已提交
2477 2478
}

2479 2480 2481 2482 2483
static inline gfp_t gfp_memcg_charge(void)
{
	return in_softirq() ? GFP_NOWAIT : GFP_KERNEL;
}

E
Eric Dumazet 已提交
2484
static inline long sock_rcvtimeo(const struct sock *sk, bool noblock)
L
Linus Torvalds 已提交
2485 2486 2487 2488
{
	return noblock ? 0 : sk->sk_rcvtimeo;
}

E
Eric Dumazet 已提交
2489
static inline long sock_sndtimeo(const struct sock *sk, bool noblock)
L
Linus Torvalds 已提交
2490 2491 2492 2493 2494 2495
{
	return noblock ? 0 : sk->sk_sndtimeo;
}

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

	return v ?: 1;
L
Linus Torvalds 已提交
2499 2500 2501 2502 2503 2504 2505 2506 2507 2508
}

/* 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;
}

2509 2510 2511 2512 2513 2514 2515 2516
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.
 */
2517
#define SOCK_SKB_CB_OFFSET ((sizeof_field(struct sk_buff, cb) - \
2518 2519 2520 2521 2522
			    sizeof(struct sock_skb_cb)))

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

2523
#define sock_skb_cb_check_size(size) \
2524
	BUILD_BUG_ON((size) > SOCK_SKB_CB_OFFSET)
2525

2526 2527 2528
static inline void
sock_skb_set_dropcount(const struct sock *sk, struct sk_buff *skb)
{
2529 2530
	SOCK_SKB_CB(skb)->dropcount = sock_flag(sk, SOCK_RXQ_OVFL) ?
						atomic_read(&sk->sk_drops) : 0;
2531 2532
}

2533 2534 2535 2536 2537 2538 2539
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);
}

2540 2541 2542 2543 2544 2545 2546 2547 2548 2549 2550 2551 2552
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
2553
	return READ_ONCE(sk->sk_stamp);
2554 2555 2556 2557 2558 2559 2560 2561 2562 2563
#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
2564
	WRITE_ONCE(sk->sk_stamp, kt);
2565 2566 2567
#endif
}

2568 2569 2570 2571
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);
2572

E
Eric Dumazet 已提交
2573
static inline void
L
Linus Torvalds 已提交
2574 2575
sock_recv_timestamp(struct msghdr *msg, struct sock *sk, struct sk_buff *skb)
{
2576
	ktime_t kt = skb->tstamp;
2577
	struct skb_shared_hwtstamps *hwtstamps = skb_hwtstamps(skb);
2578

2579 2580
	/*
	 * generate control messages if
2581
	 * - receive time stamping in software requested
2582 2583 2584 2585
	 * - software time stamp available and wanted
	 * - hardware time stamps available and wanted
	 */
	if (sock_flag(sk, SOCK_RCVTSTAMP) ||
2586
	    (sk->sk_tsflags & SOF_TIMESTAMPING_RX_SOFTWARE) ||
T
Thomas Gleixner 已提交
2587 2588
	    (kt && sk->sk_tsflags & SOF_TIMESTAMPING_SOFTWARE) ||
	    (hwtstamps->hwtstamp &&
2589
	     (sk->sk_tsflags & SOF_TIMESTAMPING_RAW_HARDWARE)))
2590 2591
		__sock_recv_timestamp(msg, sk, skb);
	else
2592
		sock_write_timestamp(sk, kt);
2593 2594 2595

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

2598 2599
void __sock_recv_ts_and_drops(struct msghdr *msg, struct sock *sk,
			      struct sk_buff *skb);
2600

2601
#define SK_DEFAULT_STAMP (-1L * NSEC_PER_SEC)
2602 2603 2604 2605
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)			| \
2606 2607 2608
			   (1UL << SOCK_RCVTSTAMP))
#define TSFLAGS_ANY	  (SOF_TIMESTAMPING_SOFTWARE			| \
			   SOF_TIMESTAMPING_RAW_HARDWARE)
2609

2610
	if (sk->sk_flags & FLAGS_TS_OR_DROPS || sk->sk_tsflags & TSFLAGS_ANY)
2611
		__sock_recv_ts_and_drops(msg, sk, skb);
2612
	else if (unlikely(sock_flag(sk, SOCK_TIMESTAMP)))
2613
		sock_write_timestamp(sk, skb->tstamp);
2614
	else if (unlikely(sk->sk_stamp == SK_DEFAULT_STAMP))
2615
		sock_write_timestamp(sk, 0);
2616
}
2617

2618
void __sock_tx_timestamp(__u16 tsflags, __u8 *tx_flags);
2619

2620
/**
2621
 * _sock_tx_timestamp - checks whether the outgoing packet is to be time stamped
2622
 * @sk:		socket sending this packet
2623
 * @tsflags:	timestamping flags to use
2624
 * @tx_flags:	completed with instructions for time stamping
2625
 * @tskey:      filled in with next sk_tskey (not for TCP, which uses seqno)
2626
 *
2627
 * Note: callers should take care of initial ``*tx_flags`` value (usually 0)
2628
 */
2629 2630
static inline void _sock_tx_timestamp(struct sock *sk, __u16 tsflags,
				      __u8 *tx_flags, __u32 *tskey)
2631
{
2632
	if (unlikely(tsflags)) {
2633
		__sock_tx_timestamp(tsflags, tx_flags);
2634 2635 2636 2637
		if (tsflags & SOF_TIMESTAMPING_OPT_ID && tskey &&
		    tsflags & SOF_TIMESTAMPING_TX_RECORD_MASK)
			*tskey = sk->sk_tskey++;
	}
2638 2639 2640
	if (unlikely(sock_flag(sk, SOCK_WIFI_STATUS)))
		*tx_flags |= SKBTX_WIFI_STATUS;
}
2641

2642 2643 2644 2645 2646 2647 2648 2649 2650 2651 2652 2653
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);
}

L
Linus Torvalds 已提交
2654 2655
/**
 * sk_eat_skb - Release a skb if it is no longer needed
2656 2657
 * @sk: socket to eat this skb from
 * @skb: socket buffer to eat
L
Linus Torvalds 已提交
2658 2659 2660 2661
 *
 * 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 已提交
2662
static inline void sk_eat_skb(struct sock *sk, struct sk_buff *skb)
L
Linus Torvalds 已提交
2663 2664 2665 2666 2667
{
	__skb_unlink(skb, &sk->sk_receive_queue);
	__kfree_skb(skb);
}

2668 2669 2670
static inline
struct net *sock_net(const struct sock *sk)
{
E
Eric Dumazet 已提交
2671
	return read_pnet(&sk->sk_net);
2672 2673 2674
}

static inline
2675
void sock_net_set(struct sock *sk, struct net *net)
2676
{
E
Eric Dumazet 已提交
2677
	write_pnet(&sk->sk_net, net);
2678 2679
}

J
Joe Stringer 已提交
2680 2681 2682 2683 2684 2685 2686 2687 2688 2689
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 */
}

2690 2691 2692 2693 2694 2695 2696 2697 2698 2699 2700 2701 2702 2703 2704
/* 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);
}

2705
/**
2706 2707 2708
 * 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
2709 2710 2711
 */
static inline struct sock *
skb_steal_sock(struct sk_buff *skb, bool *refcounted)
2712
{
2713
	if (skb->sk) {
2714 2715
		struct sock *sk = skb->sk;

2716
		*refcounted = true;
2717 2718
		if (skb_sk_is_prefetched(skb))
			*refcounted = sk_is_refcounted(sk);
2719 2720 2721 2722
		skb->destructor = NULL;
		skb->sk = NULL;
		return sk;
	}
2723
	*refcounted = false;
2724 2725 2726
	return NULL;
}

2727 2728
/* Checks if this SKB belongs to an HW offloaded socket
 * and whether any SW fallbacks are required based on dev.
2729
 * Check decrypted mark in case skb_orphan() cleared socket.
2730 2731 2732 2733 2734 2735 2736
 */
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;

2737
	if (sk && sk_fullsock(sk) && sk->sk_validate_xmit_skb) {
2738
		skb = sk->sk_validate_xmit_skb(sk, dev, skb);
2739 2740 2741 2742 2743 2744 2745
#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
	}
2746 2747 2748 2749 2750
#endif

	return skb;
}

2751 2752 2753 2754 2755 2756 2757 2758
/* 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 已提交
2759
void sock_enable_timestamp(struct sock *sk, enum sock_flags flag);
2760 2761
int sock_recv_errqueue(struct sock *sk, struct msghdr *msg, int len, int level,
		       int type);
L
Linus Torvalds 已提交
2762

2763 2764 2765 2766 2767
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);

2768 2769
void sk_get_meminfo(const struct sock *sk, u32 *meminfo);

2770 2771 2772 2773 2774 2775 2776 2777 2778 2779
/* 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 已提交
2780 2781 2782
extern __u32 sysctl_wmem_max;
extern __u32 sysctl_rmem_max;

2783
extern int sysctl_tstamp_allow_data;
2784 2785
extern int sysctl_optmem_max;

2786 2787 2788
extern __u32 sysctl_wmem_default;
extern __u32 sysctl_rmem_default;

2789
#define SKB_FRAG_PAGE_ORDER	get_order(32768)
2790 2791
DECLARE_STATIC_KEY_FALSE(net_high_order_alloc_disable_key);

2792 2793 2794 2795 2796 2797 2798 2799 2800 2801 2802 2803 2804 2805 2806 2807 2808 2809
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;
}

2810 2811 2812 2813 2814 2815
/* 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)
{
2816
	if (!sk || !sk_fullsock(sk) || READ_ONCE(sk->sk_pacing_shift) == val)
2817
		return;
2818
	WRITE_ONCE(sk->sk_pacing_shift, val);
2819 2820
}

2821 2822 2823 2824 2825 2826 2827 2828 2829 2830 2831 2832 2833 2834 2835 2836 2837 2838 2839
/* 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;
}

2840 2841
void sock_def_readable(struct sock *sk);

2842
int sock_bindtoindex(struct sock *sk, int ifindex, bool lock_sk);
2843
void sock_set_timestamp(struct sock *sk, int optname, bool valbool);
2844 2845
int sock_set_timestamping(struct sock *sk, int optname,
			  struct so_timestamping timestamping);
2846

2847
void sock_enable_timestamps(struct sock *sk);
C
Christoph Hellwig 已提交
2848
void sock_no_linger(struct sock *sk);
C
Christoph Hellwig 已提交
2849
void sock_set_keepalive(struct sock *sk);
C
Christoph Hellwig 已提交
2850
void sock_set_priority(struct sock *sk, u32 priority);
C
Christoph Hellwig 已提交
2851
void sock_set_rcvbuf(struct sock *sk, int val);
A
Alexander Aring 已提交
2852
void sock_set_mark(struct sock *sk, u32 val);
C
Christoph Hellwig 已提交
2853
void sock_set_reuseaddr(struct sock *sk);
C
Christoph Hellwig 已提交
2854
void sock_set_reuseport(struct sock *sk);
C
Christoph Hellwig 已提交
2855
void sock_set_sndtimeo(struct sock *sk, s64 secs);
C
Christoph Hellwig 已提交
2856

2857 2858
int sock_bind_add(struct sock *sk, struct sockaddr *addr, int addr_len);

2859 2860 2861 2862
int sock_get_timeout(long timeo, void *optval, bool old_timeval);
int sock_copy_user_timeval(struct __kernel_sock_timeval *tv,
			   sockptr_t optval, int optlen, bool old_timeval);

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