sock.h 63.5 KB
Newer Older
L
Linus Torvalds 已提交
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
L
Linus Torvalds 已提交
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>
L
Linus Torvalds 已提交
45
#include <linux/list.h>
46
#include <linux/list_nulls.h>
L
Linus Torvalds 已提交
47 48
#include <linux/timer.h>
#include <linux/cache.h>
49
#include <linux/bitops.h>
I
Ingo Molnar 已提交
50
#include <linux/lockdep.h>
L
Linus Torvalds 已提交
51 52
#include <linux/netdevice.h>
#include <linux/skbuff.h>	/* struct sk_buff */
A
Al Viro 已提交
53
#include <linux/mm.h>
L
Linus Torvalds 已提交
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>
A
Al Viro 已提交
60
#include <linux/sched.h>
H
Herbert Xu 已提交
61
#include <linux/wait.h>
L
Linus Torvalds 已提交
62 63

#include <linux/filter.h>
64
#include <linux/rculist_nulls.h>
65
#include <linux/poll.h>
L
Linus Torvalds 已提交
66

E
Eric Dumazet 已提交
67
#include <linux/atomic.h>
L
Linus Torvalds 已提交
68 69
#include <net/dst.h>
#include <net/checksum.h>
E
Eric Dumazet 已提交
70
#include <net/tcp_states.h>
71
#include <linux/net_tstamp.h>
L
Linus Torvalds 已提交
72

73 74
struct cgroup;
struct cgroup_subsys;
75
#ifdef CONFIG_NET
76 77
int mem_cgroup_sockets_init(struct mem_cgroup *memcg, struct cgroup_subsys *ss);
void mem_cgroup_sockets_destroy(struct mem_cgroup *memcg);
78 79
#else
static inline
80
int mem_cgroup_sockets_init(struct mem_cgroup *memcg, struct cgroup_subsys *ss)
81 82 83 84
{
	return 0;
}
static inline
85
void mem_cgroup_sockets_destroy(struct mem_cgroup *memcg)
86 87 88
{
}
#endif
L
Linus Torvalds 已提交
89 90 91 92 93 94 95 96 97 98 99 100
/*
 * 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
101
/* Validate arguments and do nothing */
102
static inline __printf(2, 3)
E
Eric Dumazet 已提交
103
void SOCK_DEBUG(const struct sock *sk, const char *msg, ...)
104 105
{
}
L
Linus Torvalds 已提交
106 107 108 109 110 111 112 113
#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;
114
	int			owned;
L
Linus Torvalds 已提交
115
	wait_queue_head_t	wq;
I
Ingo Molnar 已提交
116 117 118 119 120 121 122 123 124
	/*
	 * 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 已提交
125 126 127
} socket_lock_t;

struct sock;
128
struct proto;
129
struct net;
L
Linus Torvalds 已提交
130

131 132 133
typedef __u32 __bitwise __portpair;
typedef __u64 __bitwise __addrpair;

L
Linus Torvalds 已提交
134
/**
135
 *	struct sock_common - minimal network layer representation of sockets
136 137
 *	@skc_daddr: Foreign IPv4 addr
 *	@skc_rcv_saddr: Bound local IPv4 addr
E
Eric Dumazet 已提交
138
 *	@skc_hash: hash value used with various protocol lookup tables
139
 *	@skc_u16hashes: two u16 hash values used by UDP lookup tables
140 141
 *	@skc_dport: placeholder for inet_dport/tw_dport
 *	@skc_num: placeholder for inet_num/tw_num
142 143 144
 *	@skc_family: network address family
 *	@skc_state: Connection state
 *	@skc_reuse: %SO_REUSEADDR setting
T
Tom Herbert 已提交
145
 *	@skc_reuseport: %SO_REUSEPORT setting
146 147
 *	@skc_bound_dev_if: bound device index if != 0
 *	@skc_bind_node: bind hash linkage for various protocol lookup tables
148
 *	@skc_portaddr_node: second hash linkage for UDP/UDP-Lite protocol
149
 *	@skc_prot: protocol handlers inside a network family
150
 *	@skc_net: reference to the network namespace of this socket
151 152 153
 *	@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
154 155 156
 *	@skc_flags: place holder for sk_flags
 *		%SO_LINGER (l_onoff), %SO_BROADCAST, %SO_KEEPALIVE,
 *		%SO_OOBINLINE settings, %SO_TIMESTAMPING settings
157
 *	@skc_incoming_cpu: record/match cpu processing incoming packets
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 196 197
	union {
		struct hlist_node	skc_bind_node;
		struct hlist_nulls_node skc_portaddr_node;
	};
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 229
	union {
		struct hlist_node	skc_node;
		struct hlist_nulls_node skc_nulls_node;
	};
	int			skc_tx_queue_mapping;
230 231 232
	union {
		int		skc_incoming_cpu;
		u32		skc_rcv_wnd;
233
		u32		skc_tw_rcv_nxt; /* struct tcp_timewait_sock  */
234
	};
235

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

G
Glauber Costa 已提交
247
struct cg_proto;
L
Linus Torvalds 已提交
248 249
/**
  *	struct sock - network layer representation of sockets
250
  *	@__sk_common: shared layout with inet_timewait_sock
251 252 253 254
  *	@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
255
  *	@sk_wq: sock wait queue and async head
S
Shawn Bohrer 已提交
256
  *	@sk_rx_dst: receive input route used by early demux
257 258 259 260 261 262 263 264
  *	@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
E
Eliezer Tamir 已提交
265
  *	@sk_napi_id: id of the last napi context to receive data for sk
266
  *	@sk_ll_usec: usecs to busypoll when there is no data
267
  *	@sk_allocation: allocation mode
E
Eric Dumazet 已提交
268
  *	@sk_pacing_rate: Pacing rate (if supported by transport/packet scheduler)
269
  *	@sk_max_pacing_rate: Maximum pacing rate (%SO_MAX_PACING_RATE)
270
  *	@sk_sndbuf: size of send buffer in bytes
271 272
  *	@sk_no_check_tx: %SO_NO_CHECK setting, set checksum in TX packets
  *	@sk_no_check_rx: allow zero checksum in RX packets
273
  *	@sk_route_caps: route capabilities (e.g. %NETIF_F_TSO)
E
Eric Dumazet 已提交
274
  *	@sk_route_nocaps: forbidden route capabilities (e.g NETIF_F_GSO_MASK)
275
  *	@sk_gso_type: GSO type (e.g. %SKB_GSO_TCPV4)
276
  *	@sk_gso_max_size: Maximum GSO segment size to build
277
  *	@sk_gso_max_segs: Maximum number of GSO segments
278 279 280 281
  *	@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 已提交
282 283
  *	@sk_prot_creator: sk_prot of original sock creator (see ipv6_setsockopt,
  *			  IPV6_ADDRFORM for instance)
284
  *	@sk_err: last error
W
Wang Chen 已提交
285 286
  *	@sk_err_soft: errors that don't cause failure but are the cause of a
  *		      persistent failure not just 'timed out'
E
Eric Dumazet 已提交
287
  *	@sk_drops: raw/udp drops counter
288 289 290
  *	@sk_ack_backlog: current listen backlog
  *	@sk_max_ack_backlog: listen backlog set in listen()
  *	@sk_priority: %SO_PRIORITY setting
291
  *	@sk_cgrp_prioidx: socket group's priority map index
292 293
  *	@sk_type: socket type (%SOCK_STREAM, etc)
  *	@sk_protocol: which protocol this socket belongs in this network family
294 295
  *	@sk_peer_pid: &struct pid for this socket's peer
  *	@sk_peer_cred: %SO_PEERCRED setting
296 297 298
  *	@sk_rcvlowat: %SO_RCVLOWAT setting
  *	@sk_rcvtimeo: %SO_RCVTIMEO setting
  *	@sk_sndtimeo: %SO_SNDTIMEO setting
299
  *	@sk_txhash: computed flow hash for use on transmit
300 301 302
  *	@sk_filter: socket filtering instructions
  *	@sk_timer: sock cleanup timer
  *	@sk_stamp: time stamp of last packet received
303
  *	@sk_tsflags: SO_TIMESTAMPING socket options
304
  *	@sk_tskey: counter to disambiguate concurrent tstamp requests
305 306
  *	@sk_socket: Identd and reporting IO signals
  *	@sk_user_data: RPC layer private data
307
  *	@sk_frag: cached page frag
308
  *	@sk_peek_off: current peek_offset value
309
  *	@sk_send_head: front of stuff to transmit
310
  *	@sk_security: used by security modules
311
  *	@sk_mark: generic packet mark
312
  *	@sk_classid: this socket's cgroup classid
G
Glauber Costa 已提交
313
  *	@sk_cgrp: this socket's cgroup-specific proto data
314 315 316 317 318 319 320
  *	@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
L
Linus Torvalds 已提交
321 322 323
 */
struct sock {
	/*
324
	 * Now struct inet_timewait_sock also uses sock_common, so please just
L
Linus Torvalds 已提交
325 326 327
	 * don't add nothing before this first member (__sk_common) --acme
	 */
	struct sock_common	__sk_common;
E
Eric Dumazet 已提交
328 329 330
#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 已提交
331
#define sk_tx_queue_mapping	__sk_common.skc_tx_queue_mapping
E
Eric Dumazet 已提交
332

333 334
#define sk_dontcopy_begin	__sk_common.skc_dontcopy_begin
#define sk_dontcopy_end		__sk_common.skc_dontcopy_end
E
Eric Dumazet 已提交
335
#define sk_hash			__sk_common.skc_hash
E
Eric Dumazet 已提交
336
#define sk_portpair		__sk_common.skc_portpair
E
Eric Dumazet 已提交
337 338
#define sk_num			__sk_common.skc_num
#define sk_dport		__sk_common.skc_dport
E
Eric Dumazet 已提交
339 340 341
#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 已提交
342 343 344
#define sk_family		__sk_common.skc_family
#define sk_state		__sk_common.skc_state
#define sk_reuse		__sk_common.skc_reuse
T
Tom Herbert 已提交
345
#define sk_reuseport		__sk_common.skc_reuseport
346
#define sk_ipv6only		__sk_common.skc_ipv6only
347
#define sk_net_refcnt		__sk_common.skc_net_refcnt
L
Linus Torvalds 已提交
348 349
#define sk_bound_dev_if		__sk_common.skc_bound_dev_if
#define sk_bind_node		__sk_common.skc_bind_node
350
#define sk_prot			__sk_common.skc_prot
351
#define sk_net			__sk_common.skc_net
352 353
#define sk_v6_daddr		__sk_common.skc_v6_daddr
#define sk_v6_rcv_saddr	__sk_common.skc_v6_rcv_saddr
E
Eric Dumazet 已提交
354
#define sk_cookie		__sk_common.skc_cookie
355
#define sk_incoming_cpu		__sk_common.skc_incoming_cpu
356
#define sk_flags		__sk_common.skc_flags
357
#define sk_rxhash		__sk_common.skc_rxhash
358

L
Linus Torvalds 已提交
359
	socket_lock_t		sk_lock;
E
Eric Dumazet 已提交
360
	struct sk_buff_head	sk_receive_queue;
361 362 363 364
	/*
	 * 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 已提交
365 366 367
	 * Note : rmem_alloc is in this structure to fill a hole
	 * on 64bit arches, not because its logically part of
	 * backlog.
368 369
	 */
	struct {
E
Eric Dumazet 已提交
370 371 372 373
		atomic_t	rmem_alloc;
		int		len;
		struct sk_buff	*head;
		struct sk_buff	*tail;
374
	} sk_backlog;
E
Eric Dumazet 已提交
375 376
#define sk_rmem_alloc sk_backlog.rmem_alloc
	int			sk_forward_alloc;
E
Eric Dumazet 已提交
377

378
	__u32			sk_txhash;
379
#ifdef CONFIG_NET_RX_BUSY_POLL
E
Eliezer Tamir 已提交
380
	unsigned int		sk_napi_id;
381
	unsigned int		sk_ll_usec;
E
Eric Dumazet 已提交
382 383 384 385 386
#endif
	atomic_t		sk_drops;
	int			sk_rcvbuf;

	struct sk_filter __rcu	*sk_filter;
387 388 389 390
	union {
		struct socket_wq __rcu	*sk_wq;
		struct socket_wq	*sk_wq_raw;
	};
391
#ifdef CONFIG_XFRM
L
Linus Torvalds 已提交
392
	struct xfrm_policy	*sk_policy[2];
393
#endif
E
Eric Dumazet 已提交
394
	struct dst_entry	*sk_rx_dst;
395
	struct dst_entry __rcu	*sk_dst_cache;
E
Eric Dumazet 已提交
396
	/* Note: 32bit hole on 64bit arches */
L
Linus Torvalds 已提交
397 398
	atomic_t		sk_wmem_alloc;
	atomic_t		sk_omem_alloc;
399
	int			sk_sndbuf;
L
Linus Torvalds 已提交
400
	struct sk_buff_head	sk_write_queue;
E
Eric Dumazet 已提交
401 402
	kmemcheck_bitfield_begin(flags);
	unsigned int		sk_shutdown  : 2,
403 404
				sk_no_check_tx : 1,
				sk_no_check_rx : 1,
E
Eric Dumazet 已提交
405 406 407 408
				sk_userlocks : 4,
				sk_protocol  : 8,
				sk_type      : 16;
	kmemcheck_bitfield_end(flags);
L
Linus Torvalds 已提交
409
	int			sk_wmem_queued;
A
Al Viro 已提交
410
	gfp_t			sk_allocation;
E
Eric Dumazet 已提交
411
	u32			sk_pacing_rate; /* bytes per second */
E
Eric Dumazet 已提交
412
	u32			sk_max_pacing_rate;
413 414
	netdev_features_t	sk_route_caps;
	netdev_features_t	sk_route_nocaps;
415
	int			sk_gso_type;
416
	unsigned int		sk_gso_max_size;
417
	u16			sk_gso_max_segs;
418
	int			sk_rcvlowat;
L
Linus Torvalds 已提交
419 420
	unsigned long	        sk_lingertime;
	struct sk_buff_head	sk_error_queue;
421
	struct proto		*sk_prot_creator;
L
Linus Torvalds 已提交
422 423 424
	rwlock_t		sk_callback_lock;
	int			sk_err,
				sk_err_soft;
425 426
	u32			sk_ack_backlog;
	u32			sk_max_ack_backlog;
L
Linus Torvalds 已提交
427
	__u32			sk_priority;
428
#if IS_ENABLED(CONFIG_CGROUP_NET_PRIO)
429 430
	__u32			sk_cgrp_prioidx;
#endif
431 432
	struct pid		*sk_peer_pid;
	const struct cred	*sk_peer_cred;
L
Linus Torvalds 已提交
433 434 435
	long			sk_rcvtimeo;
	long			sk_sndtimeo;
	struct timer_list	sk_timer;
436
	ktime_t			sk_stamp;
437
	u16			sk_tsflags;
438
	u32			sk_tskey;
L
Linus Torvalds 已提交
439 440
	struct socket		*sk_socket;
	void			*sk_user_data;
441
	struct page_frag	sk_frag;
L
Linus Torvalds 已提交
442
	struct sk_buff		*sk_send_head;
443
	__s32			sk_peek_off;
L
Linus Torvalds 已提交
444
	int			sk_write_pending;
A
Alexey Dobriyan 已提交
445
#ifdef CONFIG_SECURITY
L
Linus Torvalds 已提交
446
	void			*sk_security;
A
Alexey Dobriyan 已提交
447
#endif
448
	__u32			sk_mark;
449
#ifdef CONFIG_CGROUP_NET_CLASSID
450
	u32			sk_classid;
451
#endif
G
Glauber Costa 已提交
452
	struct cg_proto		*sk_cgrp;
L
Linus Torvalds 已提交
453
	void			(*sk_state_change)(struct sock *sk);
454
	void			(*sk_data_ready)(struct sock *sk);
L
Linus Torvalds 已提交
455 456
	void			(*sk_write_space)(struct sock *sk);
	void			(*sk_error_report)(struct sock *sk);
E
Eric Dumazet 已提交
457 458
	int			(*sk_backlog_rcv)(struct sock *sk,
						  struct sk_buff *skb);
L
Linus Torvalds 已提交
459 460 461
	void                    (*sk_destruct)(struct sock *sk);
};

462 463 464 465 466
#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)

467 468 469 470 471 472 473 474 475 476 477
/*
 * 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

478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501
static inline int sk_peek_offset(struct sock *sk, int flags)
{
	if ((flags & MSG_PEEK) && (sk->sk_peek_off >= 0))
		return sk->sk_peek_off;
	else
		return 0;
}

static inline void sk_peek_offset_bwd(struct sock *sk, int val)
{
	if (sk->sk_peek_off >= 0) {
		if (sk->sk_peek_off >= val)
			sk->sk_peek_off -= val;
		else
			sk->sk_peek_off = 0;
	}
}

static inline void sk_peek_offset_fwd(struct sock *sk, int val)
{
	if (sk->sk_peek_off >= 0)
		sk->sk_peek_off += val;
}

L
Linus Torvalds 已提交
502 503 504
/*
 * Hashed lists helper routines
 */
L
Li Zefan 已提交
505 506 507 508 509
static inline struct sock *sk_entry(const struct hlist_node *node)
{
	return hlist_entry(node, struct sock, sk_node);
}

510
static inline struct sock *__sk_head(const struct hlist_head *head)
L
Linus Torvalds 已提交
511 512 513 514
{
	return hlist_entry(head->first, struct sock, sk_node);
}

515
static inline struct sock *sk_head(const struct hlist_head *head)
L
Linus Torvalds 已提交
516 517 518 519
{
	return hlist_empty(head) ? NULL : __sk_head(head);
}

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

530
static inline struct sock *sk_next(const struct sock *sk)
L
Linus Torvalds 已提交
531 532 533 534 535
{
	return sk->sk_node.next ?
		hlist_entry(sk->sk_node.next, struct sock, sk_node) : NULL;
}

536 537 538 539 540 541 542 543
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 已提交
544
static inline bool sk_unhashed(const struct sock *sk)
L
Linus Torvalds 已提交
545 546 547 548
{
	return hlist_unhashed(&sk->sk_node);
}

E
Eric Dumazet 已提交
549
static inline bool sk_hashed(const struct sock *sk)
L
Linus Torvalds 已提交
550
{
A
Akinobu Mita 已提交
551
	return !sk_unhashed(sk);
L
Linus Torvalds 已提交
552 553
}

E
Eric Dumazet 已提交
554
static inline void sk_node_init(struct hlist_node *node)
L
Linus Torvalds 已提交
555 556 557 558
{
	node->pprev = NULL;
}

E
Eric Dumazet 已提交
559
static inline void sk_nulls_node_init(struct hlist_nulls_node *node)
560 561 562 563
{
	node->pprev = NULL;
}

E
Eric Dumazet 已提交
564
static inline void __sk_del_node(struct sock *sk)
L
Linus Torvalds 已提交
565 566 567 568
{
	__hlist_del(&sk->sk_node);
}

569
/* NB: equivalent to hlist_del_init_rcu */
E
Eric Dumazet 已提交
570
static inline bool __sk_del_node_init(struct sock *sk)
L
Linus Torvalds 已提交
571 572 573 574
{
	if (sk_hashed(sk)) {
		__sk_del_node(sk);
		sk_node_init(&sk->sk_node);
E
Eric Dumazet 已提交
575
		return true;
L
Linus Torvalds 已提交
576
	}
E
Eric Dumazet 已提交
577
	return false;
L
Linus Torvalds 已提交
578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598
}

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

E
Eric Dumazet 已提交
599
static inline bool sk_del_node_init(struct sock *sk)
L
Linus Torvalds 已提交
600
{
E
Eric Dumazet 已提交
601
	bool rc = __sk_del_node_init(sk);
L
Linus Torvalds 已提交
602 603 604 605 606 607 608 609

	if (rc) {
		/* paranoid for a while -acme */
		WARN_ON(atomic_read(&sk->sk_refcnt) == 1);
		__sock_put(sk);
	}
	return rc;
}
610
#define sk_del_node_init_rcu(sk)	sk_del_node_init(sk)
L
Linus Torvalds 已提交
611

E
Eric Dumazet 已提交
612
static inline bool __sk_nulls_del_node_init_rcu(struct sock *sk)
613 614
{
	if (sk_hashed(sk)) {
615
		hlist_nulls_del_init_rcu(&sk->sk_nulls_node);
E
Eric Dumazet 已提交
616
		return true;
617
	}
E
Eric Dumazet 已提交
618
	return false;
619 620
}

E
Eric Dumazet 已提交
621
static inline bool sk_nulls_del_node_init_rcu(struct sock *sk)
622
{
E
Eric Dumazet 已提交
623
	bool rc = __sk_nulls_del_node_init_rcu(sk);
624 625 626 627 628 629 630 631 632

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

E
Eric Dumazet 已提交
633
static inline void __sk_add_node(struct sock *sk, struct hlist_head *list)
L
Linus Torvalds 已提交
634 635 636 637
{
	hlist_add_head(&sk->sk_node, list);
}

E
Eric Dumazet 已提交
638
static inline void sk_add_node(struct sock *sk, struct hlist_head *list)
L
Linus Torvalds 已提交
639 640 641 642 643
{
	sock_hold(sk);
	__sk_add_node(sk, list);
}

E
Eric Dumazet 已提交
644
static inline void sk_add_node_rcu(struct sock *sk, struct hlist_head *list)
645 646 647 648 649
{
	sock_hold(sk);
	hlist_add_head_rcu(&sk->sk_node, list);
}

E
Eric Dumazet 已提交
650
static inline void __sk_nulls_add_node_rcu(struct sock *sk, struct hlist_nulls_head *list)
651
{
652
	hlist_nulls_add_head_rcu(&sk->sk_nulls_node, list);
653 654
}

E
Eric Dumazet 已提交
655
static inline void sk_nulls_add_node_rcu(struct sock *sk, struct hlist_nulls_head *list)
656 657
{
	sock_hold(sk);
658
	__sk_nulls_add_node_rcu(sk, list);
659 660
}

E
Eric Dumazet 已提交
661
static inline void __sk_del_bind_node(struct sock *sk)
L
Linus Torvalds 已提交
662 663 664 665
{
	__hlist_del(&sk->sk_bind_node);
}

E
Eric Dumazet 已提交
666
static inline void sk_add_bind_node(struct sock *sk,
L
Linus Torvalds 已提交
667 668 669 670 671
					struct hlist_head *list)
{
	hlist_add_head(&sk->sk_bind_node, list);
}

672 673 674 675
#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)
676 677 678 679
#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)
680 681
#define sk_for_each_from(__sk) \
	hlist_for_each_entry_from(__sk, sk_node)
682 683 684
#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)
685 686 687 688
#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 已提交
689

690 691 692 693 694 695 696 697 698 699 700 701 702 703
/**
 * sk_nulls_for_each_entry_offset - iterate over a list at a given struct offset
 * @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.
 *
 */
#define sk_nulls_for_each_entry_offset(tpos, pos, head, offset)		       \
	for (pos = (head)->first;					       \
	     (!is_a_nulls(pos)) &&					       \
		({ tpos = (typeof(*tpos) *)((void *)pos - offset); 1;});       \
	     pos = pos->next)

E
Eric W. Biederman 已提交
704 705 706 707 708 709 710 711 712
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 已提交
713 714 715 716 717 718 719 720 721 722 723 724 725 726
/* 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 */
727
	SOCK_RCVTSTAMPNS, /* %SO_TIMESTAMPNS setting */
L
Linus Torvalds 已提交
728 729
	SOCK_LOCALROUTE, /* route locally only, %SO_DONTROUTE setting */
	SOCK_QUEUE_SHRUNK, /* write queue has been shrunk recently */
730
	SOCK_MEMALLOC, /* VM depends on this socket for swapping */
731
	SOCK_TIMESTAMPING_RX_SOFTWARE,  /* %SOF_TIMESTAMPING_RX_SOFTWARE */
E
Eric Dumazet 已提交
732
	SOCK_FASYNC, /* fasync() active */
733
	SOCK_RXQ_OVFL,
734
	SOCK_ZEROCOPY, /* buffers from userspace */
735
	SOCK_WIFI_STATUS, /* push wifi status to userspace */
736 737 738 739
	SOCK_NOFCS, /* Tell NIC not to do the Ethernet FCS.
		     * Will use last 4 bytes of packet sent from
		     * user-space instead.
		     */
740
	SOCK_FILTER_LOCKED, /* Filter cannot be changed anymore */
741
	SOCK_SELECT_ERR_QUEUE, /* Wake select on error queue */
L
Linus Torvalds 已提交
742 743
};

R
Ralf Baechle 已提交
744 745 746 747 748
static inline void sock_copy_flags(struct sock *nsk, struct sock *osk)
{
	nsk->sk_flags = osk->sk_flags;
}

L
Linus Torvalds 已提交
749 750 751 752 753 754 755 756 757 758
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);
}

E
Eric Dumazet 已提交
759
static inline bool sock_flag(const struct sock *sk, enum sock_flags flag)
L
Linus Torvalds 已提交
760 761 762 763
{
	return test_bit(flag, &sk->sk_flags);
}

764 765 766 767 768 769 770 771 772 773 774 775 776 777 778
#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

779
static inline gfp_t sk_gfp_mask(const struct sock *sk, gfp_t gfp_mask)
780
{
781
	return gfp_mask | (sk->sk_allocation & __GFP_MEMALLOC);
782 783
}

L
Linus Torvalds 已提交
784 785 786 787 788 789 790 791 792 793
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++;
}

E
Eric Dumazet 已提交
794
static inline bool sk_acceptq_is_full(const struct sock *sk)
L
Linus Torvalds 已提交
795
{
796
	return sk->sk_ack_backlog > sk->sk_max_ack_backlog;
L
Linus Torvalds 已提交
797 798 799 800 801
}

/*
 * Compute minimal free write space needed to queue new packets.
 */
E
Eric Dumazet 已提交
802
static inline int sk_stream_min_wspace(const struct sock *sk)
L
Linus Torvalds 已提交
803
{
804
	return sk->sk_wmem_queued >> 1;
L
Linus Torvalds 已提交
805 806
}

E
Eric Dumazet 已提交
807
static inline int sk_stream_wspace(const struct sock *sk)
L
Linus Torvalds 已提交
808 809 810 811
{
	return sk->sk_sndbuf - sk->sk_wmem_queued;
}

812
void sk_stream_write_space(struct sock *sk);
L
Linus Torvalds 已提交
813

Z
Zhu Yi 已提交
814
/* OOB backlog add */
Z
Zhu Yi 已提交
815
static inline void __sk_add_backlog(struct sock *sk, struct sk_buff *skb)
816
{
E
Eric Dumazet 已提交
817 818 819 820 821 822
	/* dont let skb dst not refcounted, we are going to leave rcu lock */
	skb_dst_force(skb);

	if (!sk->sk_backlog.tail)
		sk->sk_backlog.head = skb;
	else
823
		sk->sk_backlog.tail->next = skb;
E
Eric Dumazet 已提交
824 825

	sk->sk_backlog.tail = skb;
826 827
	skb->next = NULL;
}
L
Linus Torvalds 已提交
828

829 830
/*
 * Take into account size of receive queue and backlog queue
E
Eric Dumazet 已提交
831 832
 * Do not take into account this skb truesize,
 * to allow even a single big packet to come.
833
 */
834
static inline bool sk_rcvqueues_full(const struct sock *sk, unsigned int limit)
835 836 837
{
	unsigned int qsize = sk->sk_backlog.len + atomic_read(&sk->sk_rmem_alloc);

838
	return qsize > limit;
839 840
}

Z
Zhu Yi 已提交
841
/* The per-socket spinlock must be held here. */
842 843
static inline __must_check int sk_add_backlog(struct sock *sk, struct sk_buff *skb,
					      unsigned int limit)
Z
Zhu Yi 已提交
844
{
845
	if (sk_rcvqueues_full(sk, limit))
Z
Zhu Yi 已提交
846 847
		return -ENOBUFS;

848 849 850 851 852 853 854 855
	/*
	 * 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 已提交
856
	__sk_add_backlog(sk, skb);
Z
Zhu Yi 已提交
857 858 859 860
	sk->sk_backlog.len += skb->truesize;
	return 0;
}

861
int __sk_backlog_rcv(struct sock *sk, struct sk_buff *skb);
862

P
Peter Zijlstra 已提交
863 864
static inline int sk_backlog_rcv(struct sock *sk, struct sk_buff *skb)
{
865 866 867
	if (sk_memalloc_socks() && skb_pfmemalloc(skb))
		return __sk_backlog_rcv(sk, skb);

P
Peter Zijlstra 已提交
868 869 870
	return sk->sk_backlog_rcv(sk, skb);
}

E
Eric Dumazet 已提交
871 872 873 874 875
static inline void sk_incoming_cpu_update(struct sock *sk)
{
	sk->sk_incoming_cpu = raw_smp_processor_id();
}

876
static inline void sock_rps_record_flow_hash(__u32 hash)
877 878 879 880 881 882
{
#ifdef CONFIG_RPS
	struct rps_sock_flow_table *sock_flow_table;

	rcu_read_lock();
	sock_flow_table = rcu_dereference(rps_sock_flow_table);
883
	rps_record_sock_flow(sock_flow_table, hash);
884 885 886 887
	rcu_read_unlock();
#endif
}

888 889
static inline void sock_rps_record_flow(const struct sock *sk)
{
890
#ifdef CONFIG_RPS
891
	sock_rps_record_flow_hash(sk->sk_rxhash);
892
#endif
893 894
}

895 896
static inline void sock_rps_save_rxhash(struct sock *sk,
					const struct sk_buff *skb)
897 898
{
#ifdef CONFIG_RPS
899
	if (unlikely(sk->sk_rxhash != skb->hash))
900
		sk->sk_rxhash = skb->hash;
901 902 903
#endif
}

904 905 906 907 908 909 910
static inline void sock_rps_reset_rxhash(struct sock *sk)
{
#ifdef CONFIG_RPS
	sk->sk_rxhash = 0;
#endif
}

S
Stephen Hemminger 已提交
911 912 913 914 915 916 917
#define sk_wait_event(__sk, __timeo, __condition)			\
	({	int __rc;						\
		release_sock(__sk);					\
		__rc = __condition;					\
		if (!__rc) {						\
			*(__timeo) = schedule_timeout(*(__timeo));	\
		}							\
918
		sched_annotate_sleep();						\
S
Stephen Hemminger 已提交
919 920 921 922
		lock_sock(__sk);					\
		__rc = __condition;					\
		__rc;							\
	})
L
Linus Torvalds 已提交
923

924 925 926 927 928 929 930
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 已提交
931

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

934
struct request_sock_ops;
935
struct timewait_sock_ops;
936
struct inet_hashinfo;
937
struct raw_hashinfo;
938
struct module;
939

E
Eric Dumazet 已提交
940 941 942 943 944 945 946 947 948 949 950 951
/*
 * 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));
}

L
Linus Torvalds 已提交
952 953 954 955
/* Networking protocol blocks we attach to sockets.
 * socket layer -> transport layer interface
 */
struct proto {
E
Eric Dumazet 已提交
956
	void			(*close)(struct sock *sk,
L
Linus Torvalds 已提交
957 958
					long timeout);
	int			(*connect)(struct sock *sk,
E
Eric Dumazet 已提交
959
					struct sockaddr *uaddr,
L
Linus Torvalds 已提交
960 961 962
					int addr_len);
	int			(*disconnect)(struct sock *sk, int flags);

E
Eric Dumazet 已提交
963
	struct sock *		(*accept)(struct sock *sk, int flags, int *err);
L
Linus Torvalds 已提交
964 965 966 967

	int			(*ioctl)(struct sock *sk, int cmd,
					 unsigned long arg);
	int			(*init)(struct sock *sk);
968
	void			(*destroy)(struct sock *sk);
L
Linus Torvalds 已提交
969
	void			(*shutdown)(struct sock *sk, int how);
E
Eric Dumazet 已提交
970
	int			(*setsockopt)(struct sock *sk, int level,
L
Linus Torvalds 已提交
971
					int optname, char __user *optval,
972
					unsigned int optlen);
E
Eric Dumazet 已提交
973 974 975
	int			(*getsockopt)(struct sock *sk, int level,
					int optname, char __user *optval,
					int __user *option);
A
Alexey Dobriyan 已提交
976
#ifdef CONFIG_COMPAT
977 978 979
	int			(*compat_setsockopt)(struct sock *sk,
					int level,
					int optname, char __user *optval,
980
					unsigned int optlen);
981 982 983 984
	int			(*compat_getsockopt)(struct sock *sk,
					int level,
					int optname, char __user *optval,
					int __user *option);
985 986
	int			(*compat_ioctl)(struct sock *sk,
					unsigned int cmd, unsigned long arg);
A
Alexey Dobriyan 已提交
987
#endif
988 989 990
	int			(*sendmsg)(struct sock *sk, struct msghdr *msg,
					   size_t len);
	int			(*recvmsg)(struct sock *sk, struct msghdr *msg,
E
Eric Dumazet 已提交
991 992
					   size_t len, int noblock, int flags,
					   int *addr_len);
L
Linus Torvalds 已提交
993 994
	int			(*sendpage)(struct sock *sk, struct page *page,
					int offset, size_t size, int flags);
E
Eric Dumazet 已提交
995
	int			(*bind)(struct sock *sk,
L
Linus Torvalds 已提交
996 997
					struct sockaddr *uaddr, int addr_len);

E
Eric Dumazet 已提交
998
	int			(*backlog_rcv) (struct sock *sk,
L
Linus Torvalds 已提交
999 1000
						struct sk_buff *skb);

E
Eric Dumazet 已提交
1001 1002
	void		(*release_cb)(struct sock *sk);

L
Linus Torvalds 已提交
1003 1004 1005
	/* Keeping track of sk's, looking them up, and port selection methods. */
	void			(*hash)(struct sock *sk);
	void			(*unhash)(struct sock *sk);
E
Eric Dumazet 已提交
1006
	void			(*rehash)(struct sock *sk);
L
Linus Torvalds 已提交
1007
	int			(*get_port)(struct sock *sk, unsigned short snum);
1008
	void			(*clear_sk)(struct sock *sk, int size);
L
Linus Torvalds 已提交
1009

1010
	/* Keeping track of sockets in use */
1011
#ifdef CONFIG_PROC_FS
1012
	unsigned int		inuse_idx;
1013
#endif
1014

1015
	bool			(*stream_memory_free)(const struct sock *sk);
L
Linus Torvalds 已提交
1016
	/* Memory pressure */
1017
	void			(*enter_memory_pressure)(struct sock *sk);
E
Eric Dumazet 已提交
1018
	atomic_long_t		*memory_allocated;	/* Current allocated memory. */
1019
	struct percpu_counter	*sockets_allocated;	/* Current number of sockets. */
L
Linus Torvalds 已提交
1020 1021 1022
	/*
	 * Pressure flag: try to collapse.
	 * Technical note: it is used by multiple contexts non atomically.
1023
	 * All the __sk_mem_schedule() is of this nature: accounting
L
Linus Torvalds 已提交
1024 1025 1026
	 * is strict, actions are advisory and have some latency.
	 */
	int			*memory_pressure;
E
Eric Dumazet 已提交
1027
	long			*sysctl_mem;
L
Linus Torvalds 已提交
1028 1029 1030
	int			*sysctl_wmem;
	int			*sysctl_rmem;
	int			max_header;
1031
	bool			no_autobind;
L
Linus Torvalds 已提交
1032

1033
	struct kmem_cache	*slab;
L
Linus Torvalds 已提交
1034
	unsigned int		obj_size;
1035
	int			slab_flags;
L
Linus Torvalds 已提交
1036

1037
	struct percpu_counter	*orphan_count;
1038

1039
	struct request_sock_ops	*rsk_prot;
1040
	struct timewait_sock_ops *twsk_prot;
1041

1042 1043
	union {
		struct inet_hashinfo	*hashinfo;
1044
		struct udp_table	*udp_table;
1045
		struct raw_hashinfo	*raw_hash;
1046
	} h;
1047

L
Linus Torvalds 已提交
1048 1049 1050 1051 1052
	struct module		*owner;

	char			name[32];

	struct list_head	node;
1053 1054 1055
#ifdef SOCK_REFCNT_DEBUG
	atomic_t		socks;
#endif
A
Andrew Morton 已提交
1056
#ifdef CONFIG_MEMCG_KMEM
G
Glauber Costa 已提交
1057 1058 1059 1060 1061 1062
	/*
	 * cgroup specific init/deinit functions. Called once for all
	 * protocols that implement it, from cgroups populate function.
	 * This function has to setup any files the protocol want to
	 * appear in the kmem cgroup filesystem.
	 */
1063
	int			(*init_cgroup)(struct mem_cgroup *memcg,
G
Glauber Costa 已提交
1064
					       struct cgroup_subsys *ss);
1065
	void			(*destroy_cgroup)(struct mem_cgroup *memcg);
G
Glauber Costa 已提交
1066 1067 1068 1069
	struct cg_proto		*(*proto_cgroup)(struct mem_cgroup *memcg);
#endif
};

1070 1071
int proto_register(struct proto *prot, int alloc_slab);
void proto_unregister(struct proto *prot);
L
Linus Torvalds 已提交
1072

1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085
#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));
}

1086
static inline void sk_refcnt_debug_release(const struct sock *sk)
1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097
{
	if (atomic_read(&sk->sk_refcnt) != 1)
		printk(KERN_DEBUG "Destruction of the %s socket %p delayed, refcnt=%d\n",
		       sk->sk_prot->name, sk, atomic_read(&sk->sk_refcnt));
}
#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 */

A
Andrew Morton 已提交
1098
#if defined(CONFIG_MEMCG_KMEM) && defined(CONFIG_NET)
1099
extern struct static_key memcg_socket_limit_enabled;
G
Glauber Costa 已提交
1100 1101 1102 1103 1104
static inline struct cg_proto *parent_cg_proto(struct proto *proto,
					       struct cg_proto *cg_proto)
{
	return proto->proto_cgroup(parent_mem_cgroup(cg_proto->memcg));
}
1105
#define mem_cgroup_sockets_enabled static_key_false(&memcg_socket_limit_enabled)
G
Glauber Costa 已提交
1106 1107 1108 1109 1110 1111 1112 1113 1114
#else
#define mem_cgroup_sockets_enabled 0
static inline struct cg_proto *parent_cg_proto(struct proto *proto,
					       struct cg_proto *cg_proto)
{
	return NULL;
}
#endif

1115 1116 1117 1118 1119 1120 1121 1122 1123
static inline bool sk_stream_memory_free(const struct sock *sk)
{
	if (sk->sk_wmem_queued >= sk->sk_sndbuf)
		return false;

	return sk->sk_prot->stream_memory_free ?
		sk->sk_prot->stream_memory_free(sk) : true;
}

1124 1125
static inline bool sk_stream_is_writeable(const struct sock *sk)
{
1126 1127
	return sk_stream_wspace(sk) >= sk_stream_min_wspace(sk) &&
	       sk_stream_memory_free(sk);
1128
}
G
Glauber Costa 已提交
1129

1130

1131 1132 1133 1134 1135 1136 1137 1138 1139
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 已提交
1140 1141

	if (mem_cgroup_sockets_enabled && sk->sk_cgrp)
1142
		return !!sk->sk_cgrp->memory_pressure;
G
Glauber Costa 已提交
1143

1144
	return !!*sk->sk_prot->memory_pressure;
1145 1146 1147 1148 1149 1150
}

static inline void sk_leave_memory_pressure(struct sock *sk)
{
	int *memory_pressure = sk->sk_prot->memory_pressure;

G
Glauber Costa 已提交
1151 1152 1153 1154
	if (!memory_pressure)
		return;

	if (*memory_pressure)
1155
		*memory_pressure = 0;
G
Glauber Costa 已提交
1156 1157 1158 1159 1160 1161

	if (mem_cgroup_sockets_enabled && sk->sk_cgrp) {
		struct cg_proto *cg_proto = sk->sk_cgrp;
		struct proto *prot = sk->sk_prot;

		for (; cg_proto; cg_proto = parent_cg_proto(prot, cg_proto))
1162
			cg_proto->memory_pressure = 0;
G
Glauber Costa 已提交
1163 1164
	}

1165 1166 1167 1168
}

static inline void sk_enter_memory_pressure(struct sock *sk)
{
G
Glauber Costa 已提交
1169 1170 1171 1172 1173 1174 1175 1176
	if (!sk->sk_prot->enter_memory_pressure)
		return;

	if (mem_cgroup_sockets_enabled && sk->sk_cgrp) {
		struct cg_proto *cg_proto = sk->sk_cgrp;
		struct proto *prot = sk->sk_prot;

		for (; cg_proto; cg_proto = parent_cg_proto(prot, cg_proto))
1177
			cg_proto->memory_pressure = 1;
G
Glauber Costa 已提交
1178 1179 1180
	}

	sk->sk_prot->enter_memory_pressure(sk);
1181 1182 1183 1184 1185
}

static inline long sk_prot_mem_limits(const struct sock *sk, int index)
{
	long *prot = sk->sk_prot->sysctl_mem;
G
Glauber Costa 已提交
1186 1187
	if (mem_cgroup_sockets_enabled && sk->sk_cgrp)
		prot = sk->sk_cgrp->sysctl_mem;
1188 1189 1190
	return prot[index];
}

G
Glauber Costa 已提交
1191 1192 1193 1194
static inline void memcg_memory_allocated_add(struct cg_proto *prot,
					      unsigned long amt,
					      int *parent_status)
{
1195
	page_counter_charge(&prot->memory_allocated, amt);
G
Glauber Costa 已提交
1196

1197 1198
	if (page_counter_read(&prot->memory_allocated) >
	    prot->memory_allocated.limit)
G
Glauber Costa 已提交
1199 1200 1201 1202 1203 1204
		*parent_status = OVER_LIMIT;
}

static inline void memcg_memory_allocated_sub(struct cg_proto *prot,
					      unsigned long amt)
{
1205
	page_counter_uncharge(&prot->memory_allocated, amt);
G
Glauber Costa 已提交
1206 1207
}

1208 1209 1210 1211
static inline long
sk_memory_allocated(const struct sock *sk)
{
	struct proto *prot = sk->sk_prot;
1212

G
Glauber Costa 已提交
1213
	if (mem_cgroup_sockets_enabled && sk->sk_cgrp)
1214
		return page_counter_read(&sk->sk_cgrp->memory_allocated);
G
Glauber Costa 已提交
1215

1216 1217 1218 1219
	return atomic_long_read(prot->memory_allocated);
}

static inline long
G
Glauber Costa 已提交
1220
sk_memory_allocated_add(struct sock *sk, int amt, int *parent_status)
1221 1222
{
	struct proto *prot = sk->sk_prot;
G
Glauber Costa 已提交
1223 1224 1225 1226 1227

	if (mem_cgroup_sockets_enabled && sk->sk_cgrp) {
		memcg_memory_allocated_add(sk->sk_cgrp, amt, parent_status);
		/* update the root cgroup regardless */
		atomic_long_add_return(amt, prot->memory_allocated);
1228
		return page_counter_read(&sk->sk_cgrp->memory_allocated);
G
Glauber Costa 已提交
1229 1230
	}

1231 1232 1233 1234
	return atomic_long_add_return(amt, prot->memory_allocated);
}

static inline void
1235
sk_memory_allocated_sub(struct sock *sk, int amt)
1236 1237
{
	struct proto *prot = sk->sk_prot;
G
Glauber Costa 已提交
1238

1239
	if (mem_cgroup_sockets_enabled && sk->sk_cgrp)
G
Glauber Costa 已提交
1240 1241
		memcg_memory_allocated_sub(sk->sk_cgrp, amt);

1242 1243 1244 1245 1246 1247
	atomic_long_sub(amt, prot->memory_allocated);
}

static inline void sk_sockets_allocated_dec(struct sock *sk)
{
	struct proto *prot = sk->sk_prot;
G
Glauber Costa 已提交
1248 1249 1250 1251 1252

	if (mem_cgroup_sockets_enabled && sk->sk_cgrp) {
		struct cg_proto *cg_proto = sk->sk_cgrp;

		for (; cg_proto; cg_proto = parent_cg_proto(prot, cg_proto))
1253
			percpu_counter_dec(&cg_proto->sockets_allocated);
G
Glauber Costa 已提交
1254 1255
	}

1256 1257 1258 1259 1260 1261
	percpu_counter_dec(prot->sockets_allocated);
}

static inline void sk_sockets_allocated_inc(struct sock *sk)
{
	struct proto *prot = sk->sk_prot;
G
Glauber Costa 已提交
1262 1263 1264 1265 1266

	if (mem_cgroup_sockets_enabled && sk->sk_cgrp) {
		struct cg_proto *cg_proto = sk->sk_cgrp;

		for (; cg_proto; cg_proto = parent_cg_proto(prot, cg_proto))
1267
			percpu_counter_inc(&cg_proto->sockets_allocated);
G
Glauber Costa 已提交
1268 1269
	}

1270 1271 1272 1273 1274 1275 1276 1277
	percpu_counter_inc(prot->sockets_allocated);
}

static inline int
sk_sockets_allocated_read_positive(struct sock *sk)
{
	struct proto *prot = sk->sk_prot;

G
Glauber Costa 已提交
1278
	if (mem_cgroup_sockets_enabled && sk->sk_cgrp)
1279
		return percpu_counter_read_positive(&sk->sk_cgrp->sockets_allocated);
G
Glauber Costa 已提交
1280

1281
	return percpu_counter_read_positive(prot->sockets_allocated);
1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303
}

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

1304 1305

#ifdef CONFIG_PROC_FS
L
Linus Torvalds 已提交
1306
/* Called with local bh disabled */
1307 1308
void sock_prot_inuse_add(struct net *net, struct proto *prot, int inc);
int sock_prot_inuse_get(struct net *net, struct proto *proto);
1309
#else
E
Eric Dumazet 已提交
1310
static inline void sock_prot_inuse_add(struct net *net, struct proto *prot,
1311
		int inc)
1312 1313 1314 1315
{
}
#endif

L
Linus Torvalds 已提交
1316

1317 1318 1319 1320 1321 1322 1323 1324 1325
/* With per-bucket locks this operation is not-atomic, so that
 * this version is not worse.
 */
static inline void __sk_prot_rehash(struct sock *sk)
{
	sk->sk_prot->unhash(sk);
	sk->sk_prot->hash(sk);
}

1326 1327
void sk_prot_clear_portaddr_nulls(struct sock *sk, int size);

L
Linus Torvalds 已提交
1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357
/* 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_SNDBUF_LOCK	1
#define SOCK_RCVBUF_LOCK	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;
}

1358 1359 1360
/*
 * Functions for memory accounting
 */
1361
int __sk_mem_schedule(struct sock *sk, int size, int kind);
E
Eric Dumazet 已提交
1362
void __sk_mem_reclaim(struct sock *sk, int amount);
L
Linus Torvalds 已提交
1363

1364 1365 1366 1367
#define SK_MEM_QUANTUM ((int)PAGE_SIZE)
#define SK_MEM_QUANTUM_SHIFT ilog2(SK_MEM_QUANTUM)
#define SK_MEM_SEND	0
#define SK_MEM_RECV	1
L
Linus Torvalds 已提交
1368

1369
static inline int sk_mem_pages(int amt)
L
Linus Torvalds 已提交
1370
{
1371
	return (amt + SK_MEM_QUANTUM - 1) >> SK_MEM_QUANTUM_SHIFT;
L
Linus Torvalds 已提交
1372 1373
}

E
Eric Dumazet 已提交
1374
static inline bool sk_has_account(struct sock *sk)
L
Linus Torvalds 已提交
1375
{
1376 1377
	/* return true if protocol supports memory accounting */
	return !!sk->sk_prot->memory_allocated;
L
Linus Torvalds 已提交
1378 1379
}

E
Eric Dumazet 已提交
1380
static inline bool sk_wmem_schedule(struct sock *sk, int size)
L
Linus Torvalds 已提交
1381
{
1382
	if (!sk_has_account(sk))
E
Eric Dumazet 已提交
1383
		return true;
1384 1385
	return size <= sk->sk_forward_alloc ||
		__sk_mem_schedule(sk, size, SK_MEM_SEND);
L
Linus Torvalds 已提交
1386 1387
}

1388
static inline bool
1389
sk_rmem_schedule(struct sock *sk, struct sk_buff *skb, int size)
H
Herbert Xu 已提交
1390
{
1391
	if (!sk_has_account(sk))
E
Eric Dumazet 已提交
1392
		return true;
1393 1394 1395
	return size<= sk->sk_forward_alloc ||
		__sk_mem_schedule(sk, size, SK_MEM_RECV) ||
		skb_pfmemalloc(skb);
1396 1397 1398 1399 1400 1401 1402
}

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

1406 1407 1408 1409 1410
static inline void sk_mem_reclaim_partial(struct sock *sk)
{
	if (!sk_has_account(sk))
		return;
	if (sk->sk_forward_alloc > SK_MEM_QUANTUM)
E
Eric Dumazet 已提交
1411
		__sk_mem_reclaim(sk, sk->sk_forward_alloc - 1);
1412 1413
}

1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433
static inline void sk_mem_charge(struct sock *sk, int size)
{
	if (!sk_has_account(sk))
		return;
	sk->sk_forward_alloc -= size;
}

static inline void sk_mem_uncharge(struct sock *sk, int size)
{
	if (!sk_has_account(sk))
		return;
	sk->sk_forward_alloc += size;
}

static inline void sk_wmem_free_skb(struct sock *sk, struct sk_buff *skb)
{
	sock_set_flag(sk, SOCK_QUEUE_SHRUNK);
	sk->sk_wmem_queued -= skb->truesize;
	sk_mem_uncharge(sk, skb->truesize);
	__kfree_skb(skb);
H
Herbert Xu 已提交
1434 1435
}

L
Linus Torvalds 已提交
1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448
/* 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.
 */
1449
#define sock_owned_by_user(sk)	((sk)->sk_lock.owned)
L
Linus Torvalds 已提交
1450

1451 1452 1453 1454 1455
static inline void sock_release_ownership(struct sock *sk)
{
	sk->sk_lock.owned = 0;
}

1456 1457 1458 1459 1460 1461 1462
/*
 * 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 已提交
1463
#define sock_lock_init_class_and_name(sk, sname, skey, name, key)	\
1464
do {									\
1465
	sk->sk_lock.owned = 0;						\
1466 1467 1468 1469 1470
	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 已提交
1471
				(skey), (sname));				\
1472 1473 1474
	lockdep_init_map(&(sk)->sk_lock.dep_map, (name), (key), 0);	\
} while (0)

1475
void lock_sock_nested(struct sock *sk, int subclass);
1476 1477 1478 1479 1480 1481

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

1482
void release_sock(struct sock *sk);
L
Linus Torvalds 已提交
1483 1484 1485

/* BH context may only use the following locking interface. */
#define bh_lock_sock(__sk)	spin_lock(&((__sk)->sk_lock.slock))
1486 1487 1488
#define bh_lock_sock_nested(__sk) \
				spin_lock_nested(&((__sk)->sk_lock.slock), \
				SINGLE_DEPTH_NESTING)
L
Linus Torvalds 已提交
1489 1490
#define bh_unlock_sock(__sk)	spin_unlock(&((__sk)->sk_lock.slock))

1491
bool lock_sock_fast(struct sock *sk);
1492 1493 1494 1495 1496 1497 1498 1499 1500
/**
 * 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)
E
Eric Dumazet 已提交
1501
{
1502 1503 1504 1505
	if (slow)
		release_sock(sk);
	else
		spin_unlock_bh(&sk->sk_lock.slock);
E
Eric Dumazet 已提交
1506 1507 1508
}


1509
struct sock *sk_alloc(struct net *net, int family, gfp_t priority,
1510
		      struct proto *prot, int kern);
1511
void sk_free(struct sock *sk);
1512
void sk_destruct(struct sock *sk);
1513 1514 1515 1516 1517 1518 1519
struct sock *sk_clone_lock(const struct sock *sk, const gfp_t priority);

struct sk_buff *sock_wmalloc(struct sock *sk, unsigned long size, int force,
			     gfp_t priority);
void sock_wfree(struct sk_buff *skb);
void skb_orphan_partial(struct sk_buff *skb);
void sock_rfree(struct sk_buff *skb);
1520
void sock_efree(struct sk_buff *skb);
1521
#ifdef CONFIG_INET
1522
void sock_edemux(struct sk_buff *skb);
1523 1524 1525
#else
#define sock_edemux(skb) sock_efree(skb)
#endif
1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537 1538

int sock_setsockopt(struct socket *sock, int level, int op,
		    char __user *optval, unsigned int optlen);

int sock_getsockopt(struct socket *sock, int level, int op,
		    char __user *optval, int __user *optlen);
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);
1539
void sock_kzfree_s(struct sock *sk, void *mem, int size);
1540
void sk_send_sigurg(struct sock *sk);
L
Linus Torvalds 已提交
1541

E
Edward Jee 已提交
1542 1543 1544 1545 1546 1547 1548
struct sockcm_cookie {
	u32 mark;
};

int sock_cmsg_send(struct sock *sk, struct msghdr *msg,
		   struct sockcm_cookie *sockc);

L
Linus Torvalds 已提交
1549 1550 1551 1552
/*
 * Functions to fill in entries in struct proto_ops when a protocol
 * does not implement a particular function.
 */
1553 1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 1564
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 *);
int sock_no_accept(struct socket *, struct socket *, int);
int sock_no_getname(struct socket *, struct sockaddr *, int *, int);
unsigned int sock_no_poll(struct file *, struct socket *,
			  struct poll_table_struct *);
int sock_no_ioctl(struct socket *, unsigned int, unsigned long);
int sock_no_listen(struct socket *, int);
int sock_no_shutdown(struct socket *, int);
int sock_no_getsockopt(struct socket *, int , int, char __user *, int __user *);
int sock_no_setsockopt(struct socket *, int, int, char __user *, unsigned int);
1565 1566
int sock_no_sendmsg(struct socket *, struct msghdr *, size_t);
int sock_no_recvmsg(struct socket *, struct msghdr *, size_t, int);
1567 1568 1569 1570
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);
L
Linus Torvalds 已提交
1571 1572 1573 1574 1575

/*
 * Functions to fill in entries in struct proto_ops when a protocol
 * uses the inet style.
 */
1576
int sock_common_getsockopt(struct socket *sock, int level, int optname,
L
Linus Torvalds 已提交
1577
				  char __user *optval, int __user *optlen);
1578 1579
int sock_common_recvmsg(struct socket *sock, struct msghdr *msg, size_t size,
			int flags);
1580
int sock_common_setsockopt(struct socket *sock, int level, int optname,
1581
				  char __user *optval, unsigned int optlen);
1582
int compat_sock_common_getsockopt(struct socket *sock, int level,
1583
		int optname, char __user *optval, int __user *optlen);
1584
int compat_sock_common_setsockopt(struct socket *sock, int level,
1585
		int optname, char __user *optval, unsigned int optlen);
L
Linus Torvalds 已提交
1586

1587
void sk_common_release(struct sock *sk);
L
Linus Torvalds 已提交
1588 1589 1590 1591

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

L
Linus Torvalds 已提交
1593
/* Initialise core socket variables */
1594
void sock_init_data(struct socket *sock, struct sock *sk);
L
Linus Torvalds 已提交
1595 1596 1597 1598 1599 1600 1601 1602 1603 1604 1605 1606 1607 1608 1609 1610 1611 1612 1613 1614 1615 1616 1617 1618 1619 1620 1621 1622 1623 1624 1625 1626

/*
 * 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)
{
	if (atomic_dec_and_test(&sk->sk_refcnt))
		sk_free(sk);
}
E
Eric Dumazet 已提交
1627
/* Generic version of sock_put(), dealing with all sockets
1628
 * (TCP_TIMEWAIT, TCP_NEW_SYN_RECV, ESTABLISHED...)
E
Eric Dumazet 已提交
1629 1630
 */
void sock_gen_put(struct sock *sk);
L
Linus Torvalds 已提交
1631

1632
int sk_receive_skb(struct sock *sk, struct sk_buff *skb, const int nested);
1633

K
Krishna Kumar 已提交
1634 1635 1636 1637 1638 1639 1640 1641 1642 1643 1644 1645
static inline void sk_tx_queue_set(struct sock *sk, int tx_queue)
{
	sk->sk_tx_queue_mapping = tx_queue;
}

static inline void sk_tx_queue_clear(struct sock *sk)
{
	sk->sk_tx_queue_mapping = -1;
}

static inline int sk_tx_queue_get(const struct sock *sk)
{
1646
	return sk ? sk->sk_tx_queue_mapping : -1;
K
Krishna Kumar 已提交
1647 1648
}

1649 1650
static inline void sk_set_socket(struct sock *sk, struct socket *sock)
{
K
Krishna Kumar 已提交
1651
	sk_tx_queue_clear(sk);
1652 1653 1654
	sk->sk_socket = sock;
}

E
Eric Dumazet 已提交
1655 1656
static inline wait_queue_head_t *sk_sleep(struct sock *sk)
{
1657 1658
	BUILD_BUG_ON(offsetof(struct socket_wq, wait) != 0);
	return &rcu_dereference_raw(sk->sk_wq)->wait;
E
Eric Dumazet 已提交
1659
}
L
Linus Torvalds 已提交
1660 1661 1662 1663 1664 1665 1666 1667 1668 1669 1670
/* 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);
1671
	sk_set_socket(sk, NULL);
1672
	sk->sk_wq  = NULL;
L
Linus Torvalds 已提交
1673 1674 1675 1676 1677 1678
	write_unlock_bh(&sk->sk_callback_lock);
}

static inline void sock_graft(struct sock *sk, struct socket *parent)
{
	write_lock_bh(&sk->sk_callback_lock);
1679
	sk->sk_wq = parent->wq;
L
Linus Torvalds 已提交
1680
	parent->sk = sk;
1681
	sk_set_socket(sk, parent);
1682
	security_sock_graft(sk, parent);
L
Linus Torvalds 已提交
1683 1684 1685
	write_unlock_bh(&sk->sk_callback_lock);
}

1686 1687
kuid_t sock_i_uid(struct sock *sk);
unsigned long sock_i_ino(struct sock *sk);
L
Linus Torvalds 已提交
1688

1689
static inline u32 net_tx_rndhash(void)
1690
{
1691 1692 1693 1694
	u32 v = prandom_u32();

	return v ?: 1;
}
1695

1696 1697 1698
static inline void sk_set_txhash(struct sock *sk)
{
	sk->sk_txhash = net_tx_rndhash();
1699 1700
}

1701 1702 1703 1704 1705 1706
static inline void sk_rethink_txhash(struct sock *sk)
{
	if (sk->sk_txhash)
		sk_set_txhash(sk);
}

L
Linus Torvalds 已提交
1707 1708 1709
static inline struct dst_entry *
__sk_dst_get(struct sock *sk)
{
1710
	return rcu_dereference_check(sk->sk_dst_cache, sock_owned_by_user(sk) ||
E
Eric Dumazet 已提交
1711
						       lockdep_is_held(&sk->sk_lock.slock));
L
Linus Torvalds 已提交
1712 1713 1714 1715 1716 1717 1718
}

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

E
Eric Dumazet 已提交
1719 1720
	rcu_read_lock();
	dst = rcu_dereference(sk->sk_dst_cache);
1721 1722
	if (dst && !atomic_inc_not_zero(&dst->__refcnt))
		dst = NULL;
E
Eric Dumazet 已提交
1723
	rcu_read_unlock();
L
Linus Torvalds 已提交
1724 1725 1726
	return dst;
}

E
Eric Dumazet 已提交
1727 1728 1729 1730
static inline void dst_negative_advice(struct sock *sk)
{
	struct dst_entry *ndst, *dst = __sk_dst_get(sk);

1731 1732
	sk_rethink_txhash(sk);

E
Eric Dumazet 已提交
1733 1734 1735 1736 1737
	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 已提交
1738
			sk_tx_queue_clear(sk);
E
Eric Dumazet 已提交
1739 1740 1741 1742
		}
	}
}

L
Linus Torvalds 已提交
1743 1744 1745 1746 1747
static inline void
__sk_dst_set(struct sock *sk, struct dst_entry *dst)
{
	struct dst_entry *old_dst;

K
Krishna Kumar 已提交
1748
	sk_tx_queue_clear(sk);
1749 1750 1751 1752 1753
	/*
	 * This can be called while sk is owned by the caller only,
	 * with no state that can be checked in a rcu_dereference_check() cond
	 */
	old_dst = rcu_dereference_raw(sk->sk_dst_cache);
E
Eric Dumazet 已提交
1754
	rcu_assign_pointer(sk->sk_dst_cache, dst);
L
Linus Torvalds 已提交
1755 1756 1757 1758 1759 1760
	dst_release(old_dst);
}

static inline void
sk_dst_set(struct sock *sk, struct dst_entry *dst)
{
1761 1762 1763
	struct dst_entry *old_dst;

	sk_tx_queue_clear(sk);
1764
	old_dst = xchg((__force struct dst_entry **)&sk->sk_dst_cache, dst);
1765
	dst_release(old_dst);
L
Linus Torvalds 已提交
1766 1767 1768 1769 1770
}

static inline void
__sk_dst_reset(struct sock *sk)
{
E
Eric Dumazet 已提交
1771
	__sk_dst_set(sk, NULL);
L
Linus Torvalds 已提交
1772 1773 1774 1775 1776
}

static inline void
sk_dst_reset(struct sock *sk)
{
1777
	sk_dst_set(sk, NULL);
L
Linus Torvalds 已提交
1778 1779
}

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

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

1784 1785
bool sk_mc_loop(struct sock *sk);

E
Eric Dumazet 已提交
1786
static inline bool sk_can_gso(const struct sock *sk)
1787 1788 1789 1790
{
	return net_gso_ok(sk->sk_route_caps, sk->sk_gso_type);
}

1791
void sk_setup_caps(struct sock *sk, struct dst_entry *dst);
1792

1793
static inline void sk_nocaps_add(struct sock *sk, netdev_features_t flags)
E
Eric Dumazet 已提交
1794 1795 1796 1797 1798
{
	sk->sk_route_nocaps |= flags;
	sk->sk_route_caps &= ~flags;
}

1799
static inline int skb_do_copy_data_nocache(struct sock *sk, struct sk_buff *skb,
1800
					   struct iov_iter *from, char *to,
1801
					   int copy, int offset)
1802 1803
{
	if (skb->ip_summed == CHECKSUM_NONE) {
1804 1805 1806
		__wsum csum = 0;
		if (csum_and_copy_from_iter(to, copy, &csum, from) != copy)
			return -EFAULT;
1807
		skb->csum = csum_block_add(skb->csum, csum, offset);
1808
	} else if (sk->sk_route_caps & NETIF_F_NOCACHE_COPY) {
1809
		if (copy_from_iter_nocache(to, copy, from) != copy)
1810
			return -EFAULT;
1811
	} else if (copy_from_iter(to, copy, from) != copy)
1812 1813 1814 1815 1816 1817
		return -EFAULT;

	return 0;
}

static inline int skb_add_data_nocache(struct sock *sk, struct sk_buff *skb,
1818
				       struct iov_iter *from, int copy)
1819
{
1820
	int err, offset = skb->len;
1821

1822 1823
	err = skb_do_copy_data_nocache(sk, skb, from, skb_put(skb, copy),
				       copy, offset);
1824
	if (err)
1825
		__skb_trim(skb, offset);
1826 1827 1828 1829

	return err;
}

1830
static inline int skb_copy_to_page_nocache(struct sock *sk, struct iov_iter *from,
1831 1832 1833 1834 1835 1836
					   struct sk_buff *skb,
					   struct page *page,
					   int off, int copy)
{
	int err;

1837 1838
	err = skb_do_copy_data_nocache(sk, skb, from, page_address(page) + off,
				       copy, skb->len);
1839 1840 1841 1842 1843 1844 1845 1846 1847 1848 1849
	if (err)
		return err;

	skb->len	     += copy;
	skb->data_len	     += copy;
	skb->truesize	     += copy;
	sk->sk_wmem_queued   += copy;
	sk_mem_charge(sk, copy);
	return 0;
}

1850 1851 1852 1853 1854 1855 1856 1857 1858 1859 1860 1861 1862 1863 1864 1865 1866 1867 1868 1869 1870 1871 1872 1873 1874 1875 1876 1877
/**
 * sk_wmem_alloc_get - returns write allocations
 * @sk: socket
 *
 * Returns sk_wmem_alloc minus initial offset of one
 */
static inline int sk_wmem_alloc_get(const struct sock *sk)
{
	return atomic_read(&sk->sk_wmem_alloc) - 1;
}

/**
 * sk_rmem_alloc_get - returns read allocations
 * @sk: socket
 *
 * Returns sk_rmem_alloc
 */
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
 *
 * Returns true if socket has write or read allocations
 */
E
Eric Dumazet 已提交
1878
static inline bool sk_has_allocations(const struct sock *sk)
1879 1880 1881 1882
{
	return sk_wmem_alloc_get(sk) || sk_rmem_alloc_get(sk);
}

1883
/**
H
Herbert Xu 已提交
1884
 * skwq_has_sleeper - check if there are any waiting processes
R
Randy Dunlap 已提交
1885
 * @wq: struct socket_wq
1886
 *
1887
 * Returns true if socket_wq has waiting processes
1888
 *
H
Herbert Xu 已提交
1889
 * The purpose of the skwq_has_sleeper and sock_poll_wait is to wrap the memory
1890 1891 1892 1893 1894 1895 1896 1897 1898 1899 1900 1901
 * barrier call. They were added due to the race found within the tcp code.
 *
 * Consider following tcp code paths:
 *
 * CPU1                  CPU2
 *
 * sys_select            receive packet
 *   ...                 ...
 *   __add_wait_queue    update tp->rcv_nxt
 *   ...                 ...
 *   tp->rcv_nxt check   sock_def_readable
 *   ...                 {
1902 1903 1904 1905
 *   schedule               rcu_read_lock();
 *                          wq = rcu_dereference(sk->sk_wq);
 *                          if (wq && waitqueue_active(&wq->wait))
 *                              wake_up_interruptible(&wq->wait)
1906 1907 1908 1909 1910 1911 1912
 *                          ...
 *                       }
 *
 * 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.
1913
 *
1914
 */
H
Herbert Xu 已提交
1915
static inline bool skwq_has_sleeper(struct socket_wq *wq)
1916
{
H
Herbert Xu 已提交
1917
	return wq && wq_has_sleeper(&wq->wait);
1918 1919 1920 1921 1922 1923 1924 1925
}

/**
 * sock_poll_wait - place memory barrier behind the poll_wait call.
 * @filp:           file
 * @wait_address:   socket wait queue
 * @p:              poll_table
 *
1926
 * See the comments in the wq_has_sleeper function.
1927 1928 1929 1930
 */
static inline void sock_poll_wait(struct file *filp,
		wait_queue_head_t *wait_address, poll_table *p)
{
1931
	if (!poll_does_not_wait(p) && wait_address) {
1932
		poll_wait(filp, wait_address, p);
E
Eric Dumazet 已提交
1933
		/* We need to be sure we are in sync with the
1934 1935
		 * socket flags modification.
		 *
1936
		 * This memory barrier is paired in the wq_has_sleeper.
E
Eric Dumazet 已提交
1937
		 */
1938 1939 1940 1941
		smp_mb();
	}
}

1942 1943 1944 1945 1946 1947 1948 1949
static inline void skb_set_hash_from_sk(struct sk_buff *skb, struct sock *sk)
{
	if (sk->sk_txhash) {
		skb->l4_hash = 1;
		skb->hash = sk->sk_txhash;
	}
}

1950 1951
void skb_set_owner_w(struct sk_buff *skb, struct sock *sk);

L
Linus Torvalds 已提交
1952
/*
E
Eric Dumazet 已提交
1953
 *	Queue a received datagram if it will fit. Stream and sequenced
L
Linus Torvalds 已提交
1954 1955 1956
 *	protocols can't normally use this as they need to fit buffers in
 *	and play with them.
 *
E
Eric Dumazet 已提交
1957
 *	Inlined as it's very short and called for pretty much every
L
Linus Torvalds 已提交
1958 1959 1960 1961
 *	packet ever received.
 */
static inline void skb_set_owner_r(struct sk_buff *skb, struct sock *sk)
{
1962
	skb_orphan(skb);
L
Linus Torvalds 已提交
1963 1964 1965
	skb->sk = sk;
	skb->destructor = sock_rfree;
	atomic_add(skb->truesize, &sk->sk_rmem_alloc);
1966
	sk_mem_charge(sk, skb->truesize);
L
Linus Torvalds 已提交
1967 1968
}

1969 1970
void sk_reset_timer(struct sock *sk, struct timer_list *timer,
		    unsigned long expires);
L
Linus Torvalds 已提交
1971

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

1974
int sock_queue_rcv_skb(struct sock *sk, struct sk_buff *skb);
L
Linus Torvalds 已提交
1975

1976
int sock_queue_err_skb(struct sock *sk, struct sk_buff *skb);
1977
struct sk_buff *sock_dequeue_err_skb(struct sock *sk);
L
Linus Torvalds 已提交
1978 1979 1980 1981

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

L
Linus Torvalds 已提交
1983 1984
static inline int sock_error(struct sock *sk)
{
1985 1986 1987 1988
	int err;
	if (likely(!sk->sk_err))
		return 0;
	err = xchg(&sk->sk_err, 0);
L
Linus Torvalds 已提交
1989 1990 1991 1992 1993 1994 1995 1996 1997
	return -err;
}

static inline unsigned long sock_wspace(struct sock *sk)
{
	int amt = 0;

	if (!(sk->sk_shutdown & SEND_SHUTDOWN)) {
		amt = sk->sk_sndbuf - atomic_read(&sk->sk_wmem_alloc);
E
Eric Dumazet 已提交
1998
		if (amt < 0)
L
Linus Torvalds 已提交
1999 2000 2001 2002 2003
			amt = 0;
	}
	return amt;
}

2004 2005 2006 2007
/* Note:
 *  We use sk->sk_wq_raw, from contexts knowing this
 *  pointer is not NULL and cannot disappear/change.
 */
2008
static inline void sk_set_bit(int nr, struct sock *sk)
L
Linus Torvalds 已提交
2009
{
2010
	set_bit(nr, &sk->sk_wq_raw->flags);
2011 2012 2013 2014
}

static inline void sk_clear_bit(int nr, struct sock *sk)
{
2015
	clear_bit(nr, &sk->sk_wq_raw->flags);
2016 2017
}

2018
static inline void sk_wake_async(const struct sock *sk, int how, int band)
L
Linus Torvalds 已提交
2019
{
2020 2021 2022 2023 2024
	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 已提交
2025 2026
}

2027 2028 2029 2030
/* 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 已提交
2031
 */
2032
#define TCP_SKB_MIN_TRUESIZE	(2048 + SKB_DATA_ALIGN(sizeof(struct sk_buff)))
2033 2034 2035

#define SOCK_MIN_SNDBUF		(TCP_SKB_MIN_TRUESIZE * 2)
#define SOCK_MIN_RCVBUF		 TCP_SKB_MIN_TRUESIZE
L
Linus Torvalds 已提交
2036 2037 2038 2039

static inline void sk_stream_moderate_sndbuf(struct sock *sk)
{
	if (!(sk->sk_userlocks & SOCK_SNDBUF_LOCK)) {
2040
		sk->sk_sndbuf = min(sk->sk_sndbuf, sk->sk_wmem_queued >> 1);
2041
		sk->sk_sndbuf = max_t(u32, sk->sk_sndbuf, SOCK_MIN_SNDBUF);
L
Linus Torvalds 已提交
2042 2043 2044
	}
}

2045 2046
struct sk_buff *sk_stream_alloc_skb(struct sock *sk, int size, gfp_t gfp,
				    bool force_schedule);
L
Linus Torvalds 已提交
2047

2048 2049 2050 2051 2052 2053 2054 2055
/**
 * sk_page_frag - return an appropriate page_frag
 * @sk: socket
 *
 * If socket allocation mode allows current thread to sleep, it means its
 * safe to use the per task page_frag instead of the per socket one.
 */
static inline struct page_frag *sk_page_frag(struct sock *sk)
L
Linus Torvalds 已提交
2056
{
2057
	if (gfpflags_allow_blocking(sk->sk_allocation))
2058
		return &current->task_frag;
L
Linus Torvalds 已提交
2059

2060
	return &sk->sk_frag;
L
Linus Torvalds 已提交
2061 2062
}

2063
bool sk_page_frag_refill(struct sock *sk, struct page_frag *pfrag);
2064

L
Linus Torvalds 已提交
2065 2066 2067
/*
 *	Default write policy as shown to user space via poll/select/SIGIO
 */
E
Eric Dumazet 已提交
2068
static inline bool sock_writeable(const struct sock *sk)
L
Linus Torvalds 已提交
2069
{
2070
	return atomic_read(&sk->sk_wmem_alloc) < (sk->sk_sndbuf >> 1);
L
Linus Torvalds 已提交
2071 2072
}

A
Al Viro 已提交
2073
static inline gfp_t gfp_any(void)
L
Linus Torvalds 已提交
2074
{
2075
	return in_softirq() ? GFP_ATOMIC : GFP_KERNEL;
L
Linus Torvalds 已提交
2076 2077
}

E
Eric Dumazet 已提交
2078
static inline long sock_rcvtimeo(const struct sock *sk, bool noblock)
L
Linus Torvalds 已提交
2079 2080 2081 2082
{
	return noblock ? 0 : sk->sk_rcvtimeo;
}

E
Eric Dumazet 已提交
2083
static inline long sock_sndtimeo(const struct sock *sk, bool noblock)
L
Linus Torvalds 已提交
2084 2085 2086 2087 2088 2089 2090 2091 2092 2093 2094 2095 2096 2097 2098 2099 2100
{
	return noblock ? 0 : sk->sk_sndtimeo;
}

static inline int sock_rcvlowat(const struct sock *sk, int waitall, int len)
{
	return (waitall ? len : min_t(int, sk->sk_rcvlowat, len)) ? : 1;
}

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

2101 2102 2103 2104 2105 2106 2107 2108 2109 2110 2111 2112 2113 2114
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.
 */
#define SOCK_SKB_CB_OFFSET ((FIELD_SIZEOF(struct sk_buff, cb) - \
			    sizeof(struct sock_skb_cb)))

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

2115
#define sock_skb_cb_check_size(size) \
2116
	BUILD_BUG_ON((size) > SOCK_SKB_CB_OFFSET)
2117

2118 2119 2120
static inline void
sock_skb_set_dropcount(const struct sock *sk, struct sk_buff *skb)
{
2121
	SOCK_SKB_CB(skb)->dropcount = atomic_read(&sk->sk_drops);
2122 2123
}

2124 2125 2126 2127
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);
2128

E
Eric Dumazet 已提交
2129
static inline void
L
Linus Torvalds 已提交
2130 2131
sock_recv_timestamp(struct msghdr *msg, struct sock *sk, struct sk_buff *skb)
{
2132
	ktime_t kt = skb->tstamp;
2133
	struct skb_shared_hwtstamps *hwtstamps = skb_hwtstamps(skb);
2134

2135 2136
	/*
	 * generate control messages if
2137
	 * - receive time stamping in software requested
2138 2139 2140 2141
	 * - software time stamp available and wanted
	 * - hardware time stamps available and wanted
	 */
	if (sock_flag(sk, SOCK_RCVTSTAMP) ||
2142
	    (sk->sk_tsflags & SOF_TIMESTAMPING_RX_SOFTWARE) ||
2143
	    (kt.tv64 && sk->sk_tsflags & SOF_TIMESTAMPING_SOFTWARE) ||
2144
	    (hwtstamps->hwtstamp.tv64 &&
2145
	     (sk->sk_tsflags & SOF_TIMESTAMPING_RAW_HARDWARE)))
2146 2147
		__sock_recv_timestamp(msg, sk, skb);
	else
2148
		sk->sk_stamp = kt;
2149 2150 2151

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

2154 2155
void __sock_recv_ts_and_drops(struct msghdr *msg, struct sock *sk,
			      struct sk_buff *skb);
2156 2157 2158 2159 2160

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)			| \
2161 2162 2163
			   (1UL << SOCK_RCVTSTAMP))
#define TSFLAGS_ANY	  (SOF_TIMESTAMPING_SOFTWARE			| \
			   SOF_TIMESTAMPING_RAW_HARDWARE)
2164

2165
	if (sk->sk_flags & FLAGS_TS_OR_DROPS || sk->sk_tsflags & TSFLAGS_ANY)
2166 2167 2168 2169
		__sock_recv_ts_and_drops(msg, sk, skb);
	else
		sk->sk_stamp = skb->tstamp;
}
2170

2171 2172
void __sock_tx_timestamp(const struct sock *sk, __u8 *tx_flags);

2173 2174 2175
/**
 * sock_tx_timestamp - checks whether the outgoing packet is to be time stamped
 * @sk:		socket sending this packet
2176 2177 2178
 * @tx_flags:	completed with instructions for time stamping
 *
 * Note : callers should take care of initial *tx_flags value (usually 0)
2179
 */
2180 2181 2182 2183 2184 2185 2186
static inline void sock_tx_timestamp(const struct sock *sk, __u8 *tx_flags)
{
	if (unlikely(sk->sk_tsflags))
		__sock_tx_timestamp(sk, tx_flags);
	if (unlikely(sock_flag(sk, SOCK_WIFI_STATUS)))
		*tx_flags |= SKBTX_WIFI_STATUS;
}
2187

L
Linus Torvalds 已提交
2188 2189
/**
 * sk_eat_skb - Release a skb if it is no longer needed
2190 2191
 * @sk: socket to eat this skb from
 * @skb: socket buffer to eat
L
Linus Torvalds 已提交
2192 2193 2194 2195
 *
 * 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 已提交
2196
static inline void sk_eat_skb(struct sock *sk, struct sk_buff *skb)
L
Linus Torvalds 已提交
2197 2198 2199 2200 2201
{
	__skb_unlink(skb, &sk->sk_receive_queue);
	__kfree_skb(skb);
}

2202 2203 2204
static inline
struct net *sock_net(const struct sock *sk)
{
E
Eric Dumazet 已提交
2205
	return read_pnet(&sk->sk_net);
2206 2207 2208
}

static inline
2209
void sock_net_set(struct sock *sk, struct net *net)
2210
{
E
Eric Dumazet 已提交
2211
	write_pnet(&sk->sk_net, net);
2212 2213
}

2214 2215
static inline struct sock *skb_steal_sock(struct sk_buff *skb)
{
2216
	if (skb->sk) {
2217 2218 2219 2220 2221 2222 2223 2224 2225
		struct sock *sk = skb->sk;

		skb->destructor = NULL;
		skb->sk = NULL;
		return sk;
	}
	return NULL;
}

E
Eric Dumazet 已提交
2226 2227 2228 2229 2230 2231 2232 2233
/* 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);
}

2234 2235 2236 2237 2238 2239 2240 2241
/* 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);
}

2242 2243 2244 2245 2246 2247 2248 2249 2250 2251 2252 2253 2254 2255 2256 2257 2258 2259 2260 2261 2262 2263 2264 2265 2266
/**
 * sk_state_load - read sk->sk_state for lockless contexts
 * @sk: socket pointer
 *
 * Paired with sk_state_store(). Used in places we do not hold socket lock :
 * tcp_diag_get_info(), tcp_get_info(), tcp_poll(), get_tcp4_sock() ...
 */
static inline int sk_state_load(const struct sock *sk)
{
	return smp_load_acquire(&sk->sk_state);
}

/**
 * sk_state_store - update sk->sk_state
 * @sk: socket pointer
 * @newstate: new state
 *
 * Paired with sk_state_load(). Should be used in contexts where
 * state change might impact lockless readers.
 */
static inline void sk_state_store(struct sock *sk, int newstate)
{
	smp_store_release(&sk->sk_state, newstate);
}

2267 2268 2269 2270 2271
void sock_enable_timestamp(struct sock *sk, int flag);
int sock_get_timestamp(struct sock *, struct timeval __user *);
int sock_get_timestampns(struct sock *, struct timespec __user *);
int sock_recv_errqueue(struct sock *sk, struct msghdr *msg, int len, int level,
		       int type);
L
Linus Torvalds 已提交
2272

2273 2274 2275 2276 2277
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);

L
Linus Torvalds 已提交
2278 2279 2280
extern __u32 sysctl_wmem_max;
extern __u32 sysctl_rmem_max;

2281
extern int sysctl_tstamp_allow_data;
2282 2283
extern int sysctl_optmem_max;

2284 2285 2286
extern __u32 sysctl_wmem_default;
extern __u32 sysctl_rmem_default;

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