sock.h 61.5 KB
Newer Older
Linus Torvalds's avatar
Linus Torvalds committed
1 2 3 4 5 6 7 8 9
/*
 * 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
 *
10
 * Authors:	Ross Biro
Linus Torvalds's avatar
Linus Torvalds committed
11 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 38 39 40 41 42
 *		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
 *
 *
 *		This program is free software; you can redistribute it and/or
 *		modify it under the terms of the GNU General Public License
 *		as published by the Free Software Foundation; either version
 *		2 of the License, or (at your option) any later version.
 */
#ifndef _SOCK_H
#define _SOCK_H

43
#include <linux/hardirq.h>
44
#include <linux/kernel.h>
Linus Torvalds's avatar
Linus Torvalds committed
45
#include <linux/list.h>
46
#include <linux/list_nulls.h>
Linus Torvalds's avatar
Linus Torvalds committed
47 48
#include <linux/timer.h>
#include <linux/cache.h>
49
#include <linux/bitops.h>
50
#include <linux/lockdep.h>
Linus Torvalds's avatar
Linus Torvalds committed
51 52
#include <linux/netdevice.h>
#include <linux/skbuff.h>	/* struct sk_buff */
Al Viro's avatar
Al Viro committed
53
#include <linux/mm.h>
Linus Torvalds's avatar
Linus Torvalds committed
54
#include <linux/security.h>
55
#include <linux/slab.h>
56
#include <linux/uaccess.h>
57
#include <linux/page_counter.h>
58
#include <linux/memcontrol.h>
59
#include <linux/static_key.h>
Al Viro's avatar
Al Viro committed
60
#include <linux/sched.h>
61
#include <linux/wait.h>
62
#include <linux/cgroup-defs.h>
Linus Torvalds's avatar
Linus Torvalds committed
63 64

#include <linux/filter.h>
65
#include <linux/rculist_nulls.h>
66
#include <linux/poll.h>
Linus Torvalds's avatar
Linus Torvalds committed
67

68
#include <linux/atomic.h>
Linus Torvalds's avatar
Linus Torvalds committed
69 70
#include <net/dst.h>
#include <net/checksum.h>
Eric Dumazet's avatar
Eric Dumazet committed
71
#include <net/tcp_states.h>
72
#include <linux/net_tstamp.h>
Linus Torvalds's avatar
Linus Torvalds committed
73 74 75 76 77 78 79 80 81 82 83 84 85

/*
 * 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
86
/* Validate arguments and do nothing */
87
static inline __printf(2, 3)
Eric Dumazet's avatar
Eric Dumazet committed
88
void SOCK_DEBUG(const struct sock *sk, const char *msg, ...)
89 90
{
}
Linus Torvalds's avatar
Linus Torvalds committed
91 92 93 94 95 96 97 98
#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;
99
	int			owned;
Linus Torvalds's avatar
Linus Torvalds committed
100
	wait_queue_head_t	wq;
101 102 103 104 105 106 107 108 109
	/*
	 * 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
Linus Torvalds's avatar
Linus Torvalds committed
110 111 112
} socket_lock_t;

struct sock;
113
struct proto;
114
struct net;
Linus Torvalds's avatar
Linus Torvalds committed
115

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

Linus Torvalds's avatar
Linus Torvalds committed
119
/**
120
 *	struct sock_common - minimal network layer representation of sockets
121 122
 *	@skc_daddr: Foreign IPv4 addr
 *	@skc_rcv_saddr: Bound local IPv4 addr
Eric Dumazet's avatar
Eric Dumazet committed
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 128 129
 *	@skc_family: network address family
 *	@skc_state: Connection state
 *	@skc_reuse: %SO_REUSEADDR setting
Tom Herbert's avatar
Tom Herbert committed
130
 *	@skc_reuseport: %SO_REUSEPORT setting
131 132
 *	@skc_bound_dev_if: bound device index if != 0
 *	@skc_bind_node: bind hash linkage for various protocol lookup tables
133
 *	@skc_portaddr_node: second hash linkage for UDP/UDP-Lite protocol
134
 *	@skc_prot: protocol handlers inside a network family
135
 *	@skc_net: reference to the network namespace of this socket
136 137 138
 *	@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
139 140 141
 *	@skc_flags: place holder for sk_flags
 *		%SO_LINGER (l_onoff), %SO_BROADCAST, %SO_KEEPALIVE,
 *		%SO_OOBINLINE settings, %SO_TIMESTAMPING settings
142
 *	@skc_incoming_cpu: record/match cpu processing incoming packets
143
 *	@skc_refcnt: reference count
144 145
 *
 *	This is the minimal network layer representation of sockets, the header
146 147
 *	for struct sock and struct inet_timewait_sock.
 */
Linus Torvalds's avatar
Linus Torvalds committed
148
struct sock_common {
149
	/* skc_daddr and skc_rcv_saddr must be grouped on a 8 bytes aligned
Eric Dumazet's avatar
Eric Dumazet committed
150
	 * address on 64bit arches : cf INET_MATCH()
Eric Dumazet's avatar
Eric Dumazet committed
151
	 */
152
	union {
153
		__addrpair	skc_addrpair;
154 155 156 157 158
		struct {
			__be32	skc_daddr;
			__be32	skc_rcv_saddr;
		};
	};
159 160 161 162
	union  {
		unsigned int	skc_hash;
		__u16		skc_u16hashes[2];
	};
163 164
	/* skc_dport && skc_num must be grouped as well */
	union {
165
		__portpair	skc_portpair;
166 167 168 169 170 171
		struct {
			__be16	skc_dport;
			__u16	skc_num;
		};
	};

Eric Dumazet's avatar
Eric Dumazet committed
172 173
	unsigned short		skc_family;
	volatile unsigned char	skc_state;
Tom Herbert's avatar
Tom Herbert committed
174
	unsigned char		skc_reuse:4;
175 176
	unsigned char		skc_reuseport:1;
	unsigned char		skc_ipv6only:1;
177
	unsigned char		skc_net_refcnt:1;
Eric Dumazet's avatar
Eric Dumazet committed
178
	int			skc_bound_dev_if;
179 180
	union {
		struct hlist_node	skc_bind_node;
181
		struct hlist_node	skc_portaddr_node;
182
	};
183
	struct proto		*skc_prot;
184
	possible_net_t		skc_net;
185 186 187 188 189 190

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

Eric Dumazet's avatar
Eric Dumazet committed
191 192
	atomic64_t		skc_cookie;

193 194 195 196 197 198 199 200 201 202
	/* 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 */
	};
203 204 205 206
	/*
	 * fields between dontcopy_begin/dontcopy_end
	 * are not copied in sock_copy()
	 */
207
	/* private: */
208
	int			skc_dontcopy_begin[0];
209
	/* public: */
210 211 212 213 214
	union {
		struct hlist_node	skc_node;
		struct hlist_nulls_node skc_nulls_node;
	};
	int			skc_tx_queue_mapping;
215 216 217
	union {
		int		skc_incoming_cpu;
		u32		skc_rcv_wnd;
218
		u32		skc_tw_rcv_nxt; /* struct tcp_timewait_sock  */
219
	};
220

221
	atomic_t		skc_refcnt;
222
	/* private: */
223
	int                     skc_dontcopy_end[0];
224 225 226
	union {
		u32		skc_rxhash;
		u32		skc_window_clamp;
227
		u32		skc_tw_snd_nxt; /* struct tcp_timewait_sock */
228
	};
229
	/* public: */
Linus Torvalds's avatar
Linus Torvalds committed
230 231 232 233
};

/**
  *	struct sock - network layer representation of sockets
234
  *	@__sk_common: shared layout with inet_timewait_sock
235 236 237 238
  *	@sk_shutdown: mask of %SEND_SHUTDOWN and/or %RCV_SHUTDOWN
  *	@sk_userlocks: %SO_SNDBUF and %SO_RCVBUF settings
  *	@sk_lock:	synchronizer
  *	@sk_rcvbuf: size of receive buffer in bytes
239
  *	@sk_wq: sock wait queue and async head
Shawn Bohrer's avatar
Shawn Bohrer committed
240
  *	@sk_rx_dst: receive input route used by early demux
241 242 243 244 245 246 247 248
  *	@sk_dst_cache: destination cache
  *	@sk_policy: flow policy
  *	@sk_receive_queue: incoming packets
  *	@sk_wmem_alloc: transmit queue bytes committed
  *	@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
249
  *	@sk_napi_id: id of the last napi context to receive data for sk
250
  *	@sk_ll_usec: usecs to busypoll when there is no data
251
  *	@sk_allocation: allocation mode
252
  *	@sk_pacing_rate: Pacing rate (if supported by transport/packet scheduler)
253
  *	@sk_max_pacing_rate: Maximum pacing rate (%SO_MAX_PACING_RATE)
254
  *	@sk_sndbuf: size of send buffer in bytes
255 256
  *	@sk_no_check_tx: %SO_NO_CHECK setting, set checksum in TX packets
  *	@sk_no_check_rx: allow zero checksum in RX packets
257
  *	@sk_route_caps: route capabilities (e.g. %NETIF_F_TSO)
Eric Dumazet's avatar
Eric Dumazet committed
258
  *	@sk_route_nocaps: forbidden route capabilities (e.g NETIF_F_GSO_MASK)
259
  *	@sk_gso_type: GSO type (e.g. %SKB_GSO_TCPV4)
260
  *	@sk_gso_max_size: Maximum GSO segment size to build
261
  *	@sk_gso_max_segs: Maximum number of GSO segments
262 263 264 265
  *	@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
Wang Chen's avatar
Wang Chen committed
266 267
  *	@sk_prot_creator: sk_prot of original sock creator (see ipv6_setsockopt,
  *			  IPV6_ADDRFORM for instance)
268
  *	@sk_err: last error
Wang Chen's avatar
Wang Chen committed
269 270
  *	@sk_err_soft: errors that don't cause failure but are the cause of a
  *		      persistent failure not just 'timed out'
Eric Dumazet's avatar
Eric Dumazet committed
271
  *	@sk_drops: raw/udp drops counter
272 273 274 275 276
  *	@sk_ack_backlog: current listen backlog
  *	@sk_max_ack_backlog: listen backlog set in listen()
  *	@sk_priority: %SO_PRIORITY setting
  *	@sk_type: socket type (%SOCK_STREAM, etc)
  *	@sk_protocol: which protocol this socket belongs in this network family
277 278
  *	@sk_peer_pid: &struct pid for this socket's peer
  *	@sk_peer_cred: %SO_PEERCRED setting
279 280 281
  *	@sk_rcvlowat: %SO_RCVLOWAT setting
  *	@sk_rcvtimeo: %SO_RCVTIMEO setting
  *	@sk_sndtimeo: %SO_SNDTIMEO setting
282
  *	@sk_txhash: computed flow hash for use on transmit
283 284 285
  *	@sk_filter: socket filtering instructions
  *	@sk_timer: sock cleanup timer
  *	@sk_stamp: time stamp of last packet received
286
  *	@sk_tsflags: SO_TIMESTAMPING socket options
287
  *	@sk_tskey: counter to disambiguate concurrent tstamp requests
288 289
  *	@sk_socket: Identd and reporting IO signals
  *	@sk_user_data: RPC layer private data
290
  *	@sk_frag: cached page frag
291
  *	@sk_peek_off: current peek_offset value
292
  *	@sk_send_head: front of stuff to transmit
293
  *	@sk_security: used by security modules
294
  *	@sk_mark: generic packet mark
295
  *	@sk_cgrp_data: cgroup data for this cgroup
296
  *	@sk_memcg: this socket's memory cgroup association
297 298 299 300 301 302 303
  *	@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
  *	@sk_destruct: called at sock freeing time, i.e. when all refcnt == 0
304
  *	@sk_reuseport_cb: reuseport group container
Linus Torvalds's avatar
Linus Torvalds committed
305 306 307
 */
struct sock {
	/*
308
	 * Now struct inet_timewait_sock also uses sock_common, so please just
Linus Torvalds's avatar
Linus Torvalds committed
309 310 311
	 * don't add nothing before this first member (__sk_common) --acme
	 */
	struct sock_common	__sk_common;
Eric Dumazet's avatar
Eric Dumazet committed
312 313 314
#define sk_node			__sk_common.skc_node
#define sk_nulls_node		__sk_common.skc_nulls_node
#define sk_refcnt		__sk_common.skc_refcnt
315
#define sk_tx_queue_mapping	__sk_common.skc_tx_queue_mapping
Eric Dumazet's avatar
Eric Dumazet committed
316

317 318
#define sk_dontcopy_begin	__sk_common.skc_dontcopy_begin
#define sk_dontcopy_end		__sk_common.skc_dontcopy_end
Eric Dumazet's avatar
Eric Dumazet committed
319
#define sk_hash			__sk_common.skc_hash
Eric Dumazet's avatar
Eric Dumazet committed
320
#define sk_portpair		__sk_common.skc_portpair
Eric Dumazet's avatar
Eric Dumazet committed
321 322
#define sk_num			__sk_common.skc_num
#define sk_dport		__sk_common.skc_dport
Eric Dumazet's avatar
Eric Dumazet committed
323 324 325
#define sk_addrpair		__sk_common.skc_addrpair
#define sk_daddr		__sk_common.skc_daddr
#define sk_rcv_saddr		__sk_common.skc_rcv_saddr
Linus Torvalds's avatar
Linus Torvalds committed
326 327 328
#define sk_family		__sk_common.skc_family
#define sk_state		__sk_common.skc_state
#define sk_reuse		__sk_common.skc_reuse
Tom Herbert's avatar
Tom Herbert committed
329
#define sk_reuseport		__sk_common.skc_reuseport
330
#define sk_ipv6only		__sk_common.skc_ipv6only
331
#define sk_net_refcnt		__sk_common.skc_net_refcnt
Linus Torvalds's avatar
Linus Torvalds committed
332 333
#define sk_bound_dev_if		__sk_common.skc_bound_dev_if
#define sk_bind_node		__sk_common.skc_bind_node
334
#define sk_prot			__sk_common.skc_prot
335
#define sk_net			__sk_common.skc_net
336 337
#define sk_v6_daddr		__sk_common.skc_v6_daddr
#define sk_v6_rcv_saddr	__sk_common.skc_v6_rcv_saddr
Eric Dumazet's avatar
Eric Dumazet committed
338
#define sk_cookie		__sk_common.skc_cookie
339
#define sk_incoming_cpu		__sk_common.skc_incoming_cpu
340
#define sk_flags		__sk_common.skc_flags
341
#define sk_rxhash		__sk_common.skc_rxhash
342

Linus Torvalds's avatar
Linus Torvalds committed
343
	socket_lock_t		sk_lock;
Eric Dumazet's avatar
Eric Dumazet committed
344
	struct sk_buff_head	sk_receive_queue;
345 346 347 348
	/*
	 * 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.
Eric Dumazet's avatar
Eric Dumazet committed
349 350 351
	 * Note : rmem_alloc is in this structure to fill a hole
	 * on 64bit arches, not because its logically part of
	 * backlog.
352 353
	 */
	struct {
Eric Dumazet's avatar
Eric Dumazet committed
354 355 356 357
		atomic_t	rmem_alloc;
		int		len;
		struct sk_buff	*head;
		struct sk_buff	*tail;
358
	} sk_backlog;
Eric Dumazet's avatar
Eric Dumazet committed
359 360
#define sk_rmem_alloc sk_backlog.rmem_alloc
	int			sk_forward_alloc;
Eric Dumazet's avatar
Eric Dumazet committed
361

362
	__u32			sk_txhash;
363
#ifdef CONFIG_NET_RX_BUSY_POLL
364
	unsigned int		sk_napi_id;
365
	unsigned int		sk_ll_usec;
Eric Dumazet's avatar
Eric Dumazet committed
366 367 368 369 370
#endif
	atomic_t		sk_drops;
	int			sk_rcvbuf;

	struct sk_filter __rcu	*sk_filter;
371 372 373 374
	union {
		struct socket_wq __rcu	*sk_wq;
		struct socket_wq	*sk_wq_raw;
	};
375
#ifdef CONFIG_XFRM
376
	struct xfrm_policy __rcu *sk_policy[2];
377
#endif
Eric Dumazet's avatar
Eric Dumazet committed
378
	struct dst_entry	*sk_rx_dst;
379
	struct dst_entry __rcu	*sk_dst_cache;
Eric Dumazet's avatar
Eric Dumazet committed
380
	/* Note: 32bit hole on 64bit arches */
Linus Torvalds's avatar
Linus Torvalds committed
381 382
	atomic_t		sk_wmem_alloc;
	atomic_t		sk_omem_alloc;
383
	int			sk_sndbuf;
Linus Torvalds's avatar
Linus Torvalds committed
384
	struct sk_buff_head	sk_write_queue;
Eric Dumazet's avatar
Eric Dumazet committed
385 386
	kmemcheck_bitfield_begin(flags);
	unsigned int		sk_shutdown  : 2,
387 388
				sk_no_check_tx : 1,
				sk_no_check_rx : 1,
Eric Dumazet's avatar
Eric Dumazet committed
389 390 391
				sk_userlocks : 4,
				sk_protocol  : 8,
				sk_type      : 16;
392
#define SK_PROTOCOL_MAX U8_MAX
Eric Dumazet's avatar
Eric Dumazet committed
393
	kmemcheck_bitfield_end(flags);
Linus Torvalds's avatar
Linus Torvalds committed
394
	int			sk_wmem_queued;
Al Viro's avatar
Al Viro committed
395
	gfp_t			sk_allocation;
396
	u32			sk_pacing_rate; /* bytes per second */
397
	u32			sk_max_pacing_rate;
398 399
	netdev_features_t	sk_route_caps;
	netdev_features_t	sk_route_nocaps;
400
	int			sk_gso_type;
401
	unsigned int		sk_gso_max_size;
402
	u16			sk_gso_max_segs;
403
	int			sk_rcvlowat;
Linus Torvalds's avatar
Linus Torvalds committed
404 405
	unsigned long	        sk_lingertime;
	struct sk_buff_head	sk_error_queue;
406
	struct proto		*sk_prot_creator;
Linus Torvalds's avatar
Linus Torvalds committed
407 408 409
	rwlock_t		sk_callback_lock;
	int			sk_err,
				sk_err_soft;
410 411
	u32			sk_ack_backlog;
	u32			sk_max_ack_backlog;
Linus Torvalds's avatar
Linus Torvalds committed
412
	__u32			sk_priority;
413
	__u32			sk_mark;
414 415
	struct pid		*sk_peer_pid;
	const struct cred	*sk_peer_cred;
Linus Torvalds's avatar
Linus Torvalds committed
416 417 418
	long			sk_rcvtimeo;
	long			sk_sndtimeo;
	struct timer_list	sk_timer;
419
	ktime_t			sk_stamp;
420
	u16			sk_tsflags;
421
	u32			sk_tskey;
Linus Torvalds's avatar
Linus Torvalds committed
422 423
	struct socket		*sk_socket;
	void			*sk_user_data;
424
	struct page_frag	sk_frag;
Linus Torvalds's avatar
Linus Torvalds committed
425
	struct sk_buff		*sk_send_head;
426
	__s32			sk_peek_off;
Linus Torvalds's avatar
Linus Torvalds committed
427
	int			sk_write_pending;
Alexey Dobriyan's avatar
Alexey Dobriyan committed
428
#ifdef CONFIG_SECURITY
Linus Torvalds's avatar
Linus Torvalds committed
429
	void			*sk_security;
Alexey Dobriyan's avatar
Alexey Dobriyan committed
430
#endif
431
	struct sock_cgroup_data	sk_cgrp_data;
432
	struct mem_cgroup	*sk_memcg;
Linus Torvalds's avatar
Linus Torvalds committed
433
	void			(*sk_state_change)(struct sock *sk);
434
	void			(*sk_data_ready)(struct sock *sk);
Linus Torvalds's avatar
Linus Torvalds committed
435 436
	void			(*sk_write_space)(struct sock *sk);
	void			(*sk_error_report)(struct sock *sk);
Eric Dumazet's avatar
Eric Dumazet committed
437 438
	int			(*sk_backlog_rcv)(struct sock *sk,
						  struct sk_buff *skb);
Linus Torvalds's avatar
Linus Torvalds committed
439
	void                    (*sk_destruct)(struct sock *sk);
440
	struct sock_reuseport __rcu	*sk_reuseport_cb;
441
	struct rcu_head		sk_rcu;
Linus Torvalds's avatar
Linus Torvalds committed
442 443
};

444 445 446 447 448
#define __sk_user_data(sk) ((*((void __rcu **)&(sk)->sk_user_data)))

#define rcu_dereference_sk_user_data(sk)	rcu_dereference(__sk_user_data((sk)))
#define rcu_assign_sk_user_data(sk, ptr)	rcu_assign_pointer(__sk_user_data((sk)), ptr)

449 450 451 452 453 454 455 456 457 458 459
/*
 * 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

460 461
int sk_set_peek_off(struct sock *sk, int val);

462 463
static inline int sk_peek_offset(struct sock *sk, int flags)
{
464 465 466 467 468 469 470
	if (unlikely(flags & MSG_PEEK)) {
		s32 off = READ_ONCE(sk->sk_peek_off);
		if (off >= 0)
			return off;
	}

	return 0;
471 472 473 474
}

static inline void sk_peek_offset_bwd(struct sock *sk, int val)
{
475 476 477 478 479
	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);
480 481 482 483 484
	}
}

static inline void sk_peek_offset_fwd(struct sock *sk, int val)
{
485
	sk_peek_offset_bwd(sk, -val);
486 487
}

Linus Torvalds's avatar
Linus Torvalds committed
488 489 490
/*
 * Hashed lists helper routines
 */
Li Zefan's avatar
Li Zefan committed
491 492 493 494 495
static inline struct sock *sk_entry(const struct hlist_node *node)
{
	return hlist_entry(node, struct sock, sk_node);
}

496
static inline struct sock *__sk_head(const struct hlist_head *head)
Linus Torvalds's avatar
Linus Torvalds committed
497 498 499 500
{
	return hlist_entry(head->first, struct sock, sk_node);
}

501
static inline struct sock *sk_head(const struct hlist_head *head)
Linus Torvalds's avatar
Linus Torvalds committed
502 503 504 505
{
	return hlist_empty(head) ? NULL : __sk_head(head);
}

506 507 508 509 510 511 512 513 514 515
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);
}

516
static inline struct sock *sk_next(const struct sock *sk)
Linus Torvalds's avatar
Linus Torvalds committed
517 518 519 520 521
{
	return sk->sk_node.next ?
		hlist_entry(sk->sk_node.next, struct sock, sk_node) : NULL;
}

522 523 524 525 526 527 528 529
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;
}

Eric Dumazet's avatar
Eric Dumazet committed
530
static inline bool sk_unhashed(const struct sock *sk)
Linus Torvalds's avatar
Linus Torvalds committed
531 532 533 534
{
	return hlist_unhashed(&sk->sk_node);
}

Eric Dumazet's avatar
Eric Dumazet committed
535
static inline bool sk_hashed(const struct sock *sk)
Linus Torvalds's avatar
Linus Torvalds committed
536
{
Akinobu Mita's avatar
Akinobu Mita committed
537
	return !sk_unhashed(sk);
Linus Torvalds's avatar
Linus Torvalds committed
538 539
}

Eric Dumazet's avatar
Eric Dumazet committed
540
static inline void sk_node_init(struct hlist_node *node)
Linus Torvalds's avatar
Linus Torvalds committed
541 542 543 544
{
	node->pprev = NULL;
}

Eric Dumazet's avatar
Eric Dumazet committed
545
static inline void sk_nulls_node_init(struct hlist_nulls_node *node)
546 547 548 549
{
	node->pprev = NULL;
}

Eric Dumazet's avatar
Eric Dumazet committed
550
static inline void __sk_del_node(struct sock *sk)
Linus Torvalds's avatar
Linus Torvalds committed
551 552 553 554
{
	__hlist_del(&sk->sk_node);
}

555
/* NB: equivalent to hlist_del_init_rcu */
Eric Dumazet's avatar
Eric Dumazet committed
556
static inline bool __sk_del_node_init(struct sock *sk)
Linus Torvalds's avatar
Linus Torvalds committed
557 558 559 560
{
	if (sk_hashed(sk)) {
		__sk_del_node(sk);
		sk_node_init(&sk->sk_node);
Eric Dumazet's avatar
Eric Dumazet committed
561
		return true;
Linus Torvalds's avatar
Linus Torvalds committed
562
	}
Eric Dumazet's avatar
Eric Dumazet committed
563
	return false;
Linus Torvalds's avatar
Linus Torvalds committed
564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584
}

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

static inline void sock_hold(struct sock *sk)
{
	atomic_inc(&sk->sk_refcnt);
}

/* Ungrab socket in the context, which assumes that socket refcnt
   cannot hit zero, f.e. it is true in context of any socketcall.
 */
static inline void __sock_put(struct sock *sk)
{
	atomic_dec(&sk->sk_refcnt);
}

Eric Dumazet's avatar
Eric Dumazet committed
585
static inline bool sk_del_node_init(struct sock *sk)
Linus Torvalds's avatar
Linus Torvalds committed
586
{
Eric Dumazet's avatar
Eric Dumazet committed
587
	bool rc = __sk_del_node_init(sk);
Linus Torvalds's avatar
Linus Torvalds committed
588 589 590 591 592 593 594 595

	if (rc) {
		/* paranoid for a while -acme */
		WARN_ON(atomic_read(&sk->sk_refcnt) == 1);
		__sock_put(sk);
	}
	return rc;
}
596
#define sk_del_node_init_rcu(sk)	sk_del_node_init(sk)
Linus Torvalds's avatar
Linus Torvalds committed
597

Eric Dumazet's avatar
Eric Dumazet committed
598
static inline bool __sk_nulls_del_node_init_rcu(struct sock *sk)
599 600
{
	if (sk_hashed(sk)) {
601
		hlist_nulls_del_init_rcu(&sk->sk_nulls_node);
Eric Dumazet's avatar
Eric Dumazet committed
602
		return true;
603
	}
Eric Dumazet's avatar
Eric Dumazet committed
604
	return false;
605 606
}

Eric Dumazet's avatar
Eric Dumazet committed
607
static inline bool sk_nulls_del_node_init_rcu(struct sock *sk)
608
{
Eric Dumazet's avatar
Eric Dumazet committed
609
	bool rc = __sk_nulls_del_node_init_rcu(sk);
610 611 612 613 614 615 616 617 618

	if (rc) {
		/* paranoid for a while -acme */
		WARN_ON(atomic_read(&sk->sk_refcnt) == 1);
		__sock_put(sk);
	}
	return rc;
}

Eric Dumazet's avatar
Eric Dumazet committed
619
static inline void __sk_add_node(struct sock *sk, struct hlist_head *list)
Linus Torvalds's avatar
Linus Torvalds committed
620 621 622 623
{
	hlist_add_head(&sk->sk_node, list);
}

Eric Dumazet's avatar
Eric Dumazet committed
624
static inline void sk_add_node(struct sock *sk, struct hlist_head *list)
Linus Torvalds's avatar
Linus Torvalds committed
625 626 627 628 629
{
	sock_hold(sk);
	__sk_add_node(sk, list);
}

Eric Dumazet's avatar
Eric Dumazet committed
630
static inline void sk_add_node_rcu(struct sock *sk, struct hlist_head *list)
631 632 633 634 635
{
	sock_hold(sk);
	hlist_add_head_rcu(&sk->sk_node, list);
}

Eric Dumazet's avatar
Eric Dumazet committed
636
static inline void __sk_nulls_add_node_rcu(struct sock *sk, struct hlist_nulls_head *list)
637
{
638
	hlist_nulls_add_head_rcu(&sk->sk_nulls_node, list);
639 640
}

Eric Dumazet's avatar
Eric Dumazet committed
641
static inline void sk_nulls_add_node_rcu(struct sock *sk, struct hlist_nulls_head *list)
642 643
{
	sock_hold(sk);
644
	__sk_nulls_add_node_rcu(sk, list);
645 646
}

Eric Dumazet's avatar
Eric Dumazet committed
647
static inline void __sk_del_bind_node(struct sock *sk)
Linus Torvalds's avatar
Linus Torvalds committed
648 649 650 651
{
	__hlist_del(&sk->sk_bind_node);
}

Eric Dumazet's avatar
Eric Dumazet committed
652
static inline void sk_add_bind_node(struct sock *sk,
Linus Torvalds's avatar
Linus Torvalds committed
653 654 655 656 657
					struct hlist_head *list)
{
	hlist_add_head(&sk->sk_bind_node, list);
}

658 659 660 661
#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)
662 663 664 665
#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)
666 667
#define sk_for_each_from(__sk) \
	hlist_for_each_entry_from(__sk, sk_node)
668 669 670
#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)
671 672 673 674
#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)
Linus Torvalds's avatar
Linus Torvalds committed
675

676
/**
677
 * sk_for_each_entry_offset_rcu - iterate over a list at a given struct offset
678 679 680 681 682 683
 * @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.
 *
 */
684 685 686
#define sk_for_each_entry_offset_rcu(tpos, pos, head, offset)		       \
	for (pos = rcu_dereference((head)->first);			       \
	     pos != NULL &&						       \
687
		({ tpos = (typeof(*tpos) *)((void *)pos - offset); 1;});       \
688
	     pos = rcu_dereference(pos->next))
689

690 691 692 693 694 695 696 697 698
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;
}

Linus Torvalds's avatar
Linus Torvalds committed
699 700 701 702 703 704 705 706 707 708 709 710 711 712
/* 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 */
713
	SOCK_RCVTSTAMPNS, /* %SO_TIMESTAMPNS setting */
Linus Torvalds's avatar
Linus Torvalds committed
714 715
	SOCK_LOCALROUTE, /* route locally only, %SO_DONTROUTE setting */
	SOCK_QUEUE_SHRUNK, /* write queue has been shrunk recently */
716
	SOCK_MEMALLOC, /* VM depends on this socket for swapping */
717
	SOCK_TIMESTAMPING_RX_SOFTWARE,  /* %SOF_TIMESTAMPING_RX_SOFTWARE */
Eric Dumazet's avatar
Eric Dumazet committed
718
	SOCK_FASYNC, /* fasync() active */
719
	SOCK_RXQ_OVFL,
720
	SOCK_ZEROCOPY, /* buffers from userspace */
721
	SOCK_WIFI_STATUS, /* push wifi status to userspace */
722 723 724 725
	SOCK_NOFCS, /* Tell NIC not to do the Ethernet FCS.
		     * Will use last 4 bytes of packet sent from
		     * user-space instead.
		     */
726
	SOCK_FILTER_LOCKED, /* Filter cannot be changed anymore */
727
	SOCK_SELECT_ERR_QUEUE, /* Wake select on error queue */
728
	SOCK_RCU_FREE, /* wait rcu grace period in sk_destruct() */
Linus Torvalds's avatar
Linus Torvalds committed
729 730
};

731 732
#define SK_FLAGS_TIMESTAMP ((1UL << SOCK_TIMESTAMP) | (1UL << SOCK_TIMESTAMPING_RX_SOFTWARE))

Ralf Baechle's avatar
Ralf Baechle committed
733 734 735 736 737
static inline void sock_copy_flags(struct sock *nsk, struct sock *osk)
{
	nsk->sk_flags = osk->sk_flags;
}

Linus Torvalds's avatar
Linus Torvalds committed
738 739 740 741 742 743 744 745 746 747
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);
}

Eric Dumazet's avatar
Eric Dumazet committed
748
static inline bool sock_flag(const struct sock *sk, enum sock_flags flag)
Linus Torvalds's avatar
Linus Torvalds committed
749 750 751 752
{
	return test_bit(flag, &sk->sk_flags);
}

753 754 755 756 757 758 759 760 761 762 763 764 765 766 767
#ifdef CONFIG_NET
extern struct static_key memalloc_socks;
static inline int sk_memalloc_socks(void)
{
	return static_key_false(&memalloc_socks);
}
#else

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

#endif

768
static inline gfp_t sk_gfp_mask(const struct sock *sk, gfp_t gfp_mask)
769
{
770
	return gfp_mask | (sk->sk_allocation & __GFP_MEMALLOC);
771 772
}

Linus Torvalds's avatar
Linus Torvalds committed
773 774 775 776 777 778 779 780 781 782
static inline void sk_acceptq_removed(struct sock *sk)
{
	sk->sk_ack_backlog--;
}

static inline void sk_acceptq_added(struct sock *sk)
{
	sk->sk_ack_backlog++;
}

Eric Dumazet's avatar
Eric Dumazet committed
783
static inline bool sk_acceptq_is_full(const struct sock *sk)
Linus Torvalds's avatar
Linus Torvalds committed
784
{
785
	return sk->sk_ack_backlog > sk->sk_max_ack_backlog;
Linus Torvalds's avatar
Linus Torvalds committed
786 787 788 789 790
}

/*
 * Compute minimal free write space needed to queue new packets.
 */
Eric Dumazet's avatar
Eric Dumazet committed
791
static inline int sk_stream_min_wspace(const struct sock *sk)
Linus Torvalds's avatar
Linus Torvalds committed
792
{
793
	return sk->sk_wmem_queued >> 1;
Linus Torvalds's avatar
Linus Torvalds committed
794 795
}

Eric Dumazet's avatar
Eric Dumazet committed
796
static inline int sk_stream_wspace(const struct sock *sk)
Linus Torvalds's avatar
Linus Torvalds committed
797 798 799 800
{
	return sk->sk_sndbuf - sk->sk_wmem_queued;
}

801
void sk_stream_write_space(struct sock *sk);
Linus Torvalds's avatar
Linus Torvalds committed
802

Zhu Yi's avatar
Zhu Yi committed
803
/* OOB backlog add */
Zhu Yi's avatar
Zhu Yi committed
804
static inline void __sk_add_backlog(struct sock *sk, struct sk_buff *skb)
805
{
Eric Dumazet's avatar
Eric Dumazet committed
806
	/* dont let skb dst not refcounted, we are going to leave rcu lock */
Eric Dumazet's avatar
Eric Dumazet committed
807
	skb_dst_force_safe(skb);
Eric Dumazet's avatar
Eric Dumazet committed
808 809 810 811

	if (!sk->sk_backlog.tail)
		sk->sk_backlog.head = skb;
	else
812
		sk->sk_backlog.tail->next = skb;
Eric Dumazet's avatar
Eric Dumazet committed
813 814

	sk->sk_backlog.tail = skb;
815 816
	skb->next = NULL;
}
Linus Torvalds's avatar
Linus Torvalds committed
817

818 819
/*
 * Take into account size of receive queue and backlog queue
Eric Dumazet's avatar
Eric Dumazet committed
820 821
 * Do not take into account this skb truesize,
 * to allow even a single big packet to come.
822
 */
823
static inline bool sk_rcvqueues_full(const struct sock *sk, unsigned int limit)
824 825 826
{
	unsigned int qsize = sk->sk_backlog.len + atomic_read(&sk->sk_rmem_alloc);

827
	return qsize > limit;
828 829
}

Zhu Yi's avatar
Zhu Yi committed
830
/* The per-socket spinlock must be held here. */
831 832
static inline __must_check int sk_add_backlog(struct sock *sk, struct sk_buff *skb,
					      unsigned int limit)
Zhu Yi's avatar
Zhu Yi committed
833
{
834
	if (sk_rcvqueues_full(sk, limit))
Zhu Yi's avatar
Zhu Yi committed
835 836
		return -ENOBUFS;

837 838 839 840 841 842 843 844
	/*
	 * 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;

Zhu Yi's avatar
Zhu Yi committed
845
	__sk_add_backlog(sk, skb);
Zhu Yi's avatar
Zhu Yi committed
846 847 848 849
	sk->sk_backlog.len += skb->truesize;
	return 0;
}

850
int __sk_backlog_rcv(struct sock *sk, struct sk_buff *skb);
851

852 853
static inline int sk_backlog_rcv(struct sock *sk, struct sk_buff *skb)
{
854 855 856
	if (sk_memalloc_socks() && skb_pfmemalloc(skb))
		return __sk_backlog_rcv(sk, skb);

857 858 859
	return sk->sk_backlog_rcv(sk, skb);
}

Eric Dumazet's avatar
Eric Dumazet committed
860 861 862 863 864
static inline void sk_incoming_cpu_update(struct sock *sk)
{
	sk->sk_incoming_cpu = raw_smp_processor_id();
}

865
static inline void sock_rps_record_flow_hash(__u32 hash)
866 867 868 869 870 871
{
#ifdef CONFIG_RPS
	struct rps_sock_flow_table *sock_flow_table;

	rcu_read_lock();
	sock_flow_table = rcu_dereference(rps_sock_flow_table);
872
	rps_record_sock_flow(sock_flow_table, hash);
873 874 875 876
	rcu_read_unlock();
#endif
}

877 878
static inline void sock_rps_record_flow(const struct sock *sk)
{
879
#ifdef CONFIG_RPS
880
	sock_rps_record_flow_hash(sk->sk_rxhash);
881
#endif
882 883
}

884 885
static inline void sock_rps_save_rxhash(struct sock *sk,
					const struct sk_buff *skb)
886 887
{
#ifdef CONFIG_RPS
888
	if (unlikely(sk->sk_rxhash != skb->hash))
889
		sk->sk_rxhash = skb->hash;
890 891 892
#endif
}

893 894 895 896 897 898 899
static inline void sock_rps_reset_rxhash(struct sock *sk)
{
#ifdef CONFIG_RPS
	sk->sk_rxhash = 0;
#endif
}

900 901 902 903 904 905 906
#define sk_wait_event(__sk, __timeo, __condition)			\
	({	int __rc;						\
		release_sock(__sk);					\
		__rc = __condition;					\
		if (!__rc) {						\
			*(__timeo) = schedule_timeout(*(__timeo));	\
		}							\
907
		sched_annotate_sleep();						\
908 909 910 911
		lock_sock(__sk);					\
		__rc = __condition;					\
		__rc;							\
	})
Linus Torvalds's avatar
Linus Torvalds committed
912

913 914 915 916 917 918 919
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);
Linus Torvalds's avatar
Linus Torvalds committed
920

921
int sk_wait_data(struct sock *sk, long *timeo, const struct sk_buff *skb);
Linus Torvalds's avatar
Linus Torvalds committed
922

923
struct request_sock_ops;
924
struct timewait_sock_ops;
925
struct inet_hashinfo;
926
struct raw_hashinfo;
927
struct module;
928

Eric Dumazet's avatar
Eric Dumazet committed
929 930 931 932 933 934 935 936 937 938 939 940
/*
 * caches using SLAB_DESTROY_BY_RCU should let .next pointer from nulls nodes
 * 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));
}

Linus Torvalds's avatar
Linus Torvalds committed
941 942 943 944
/* Networking protocol blocks we attach to sockets.
 * socket layer -> transport layer interface
 */
struct proto {
Eric Dumazet's avatar
Eric Dumazet committed
945
	void			(*close)(struct sock *sk,
Linus Torvalds's avatar
Linus Torvalds committed
946 947
					long timeout);
	int			(*connect)(struct sock *sk,
Eric Dumazet's avatar
Eric Dumazet committed
948
					struct sockaddr *uaddr,
Linus Torvalds's avatar
Linus Torvalds committed
949 950 951
					int addr_len);
	int			(*disconnect)(struct sock *sk, int flags);

Eric Dumazet's avatar
Eric Dumazet committed
952
	struct sock *		(*accept)(struct sock *sk, int flags, int *err);
Linus Torvalds's avatar
Linus Torvalds committed
953 954 955 956

	int			(*ioctl)(struct sock *sk, int cmd,
					 unsigned long arg);
	int			(*init)(struct sock *sk);
957
	void			(*destroy)(struct sock *sk);
Linus Torvalds's avatar
Linus Torvalds committed
958
	void			(*shutdown)(struct sock *sk, int how);
Eric Dumazet's avatar
Eric Dumazet committed
959
	int			(*setsockopt)(struct sock *sk, int level,
Linus Torvalds's avatar
Linus Torvalds committed
960
					int optname, char __user *optval,
961
					unsigned int optlen);
Eric Dumazet's avatar
Eric Dumazet committed
962 963 964
	int			(*getsockopt)(struct sock *sk, int level,
					int optname, char __user *optval,
					int __user *option);
965
#ifdef CONFIG_COMPAT
966 967 968
	int