sock.h 63.7 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/memcontrol.h>
G
Glauber Costa 已提交
58
#include <linux/res_counter.h>
59
#include <linux/static_key.h>
A
Al Viro 已提交
60 61
#include <linux/aio.h>
#include <linux/sched.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 70
#include <net/dst.h>
#include <net/checksum.h>

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

struct sock;
126
struct proto;
127
struct net;
L
Linus Torvalds 已提交
128

129 130 131
typedef __u32 __bitwise __portpair;
typedef __u64 __bitwise __addrpair;

L
Linus Torvalds 已提交
132
/**
133
 *	struct sock_common - minimal network layer representation of sockets
134 135
 *	@skc_daddr: Foreign IPv4 addr
 *	@skc_rcv_saddr: Bound local IPv4 addr
E
Eric Dumazet 已提交
136
 *	@skc_hash: hash value used with various protocol lookup tables
137
 *	@skc_u16hashes: two u16 hash values used by UDP lookup tables
138 139
 *	@skc_dport: placeholder for inet_dport/tw_dport
 *	@skc_num: placeholder for inet_num/tw_num
140 141 142
 *	@skc_family: network address family
 *	@skc_state: Connection state
 *	@skc_reuse: %SO_REUSEADDR setting
T
Tom Herbert 已提交
143
 *	@skc_reuseport: %SO_REUSEPORT setting
144 145
 *	@skc_bound_dev_if: bound device index if != 0
 *	@skc_bind_node: bind hash linkage for various protocol lookup tables
146
 *	@skc_portaddr_node: second hash linkage for UDP/UDP-Lite protocol
147
 *	@skc_prot: protocol handlers inside a network family
148
 *	@skc_net: reference to the network namespace of this socket
149 150 151 152
 *	@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
 *	@skc_refcnt: reference count
153 154
 *
 *	This is the minimal network layer representation of sockets, the header
155 156
 *	for struct sock and struct inet_timewait_sock.
 */
L
Linus Torvalds 已提交
157
struct sock_common {
158
	/* skc_daddr and skc_rcv_saddr must be grouped on a 8 bytes aligned
E
Eric Dumazet 已提交
159
	 * address on 64bit arches : cf INET_MATCH()
E
Eric Dumazet 已提交
160
	 */
161
	union {
162
		__addrpair	skc_addrpair;
163 164 165 166 167
		struct {
			__be32	skc_daddr;
			__be32	skc_rcv_saddr;
		};
	};
168 169 170 171
	union  {
		unsigned int	skc_hash;
		__u16		skc_u16hashes[2];
	};
172 173
	/* skc_dport && skc_num must be grouped as well */
	union {
174
		__portpair	skc_portpair;
175 176 177 178 179 180
		struct {
			__be16	skc_dport;
			__u16	skc_num;
		};
	};

E
Eric Dumazet 已提交
181 182
	unsigned short		skc_family;
	volatile unsigned char	skc_state;
T
Tom Herbert 已提交
183 184
	unsigned char		skc_reuse:4;
	unsigned char		skc_reuseport:4;
E
Eric Dumazet 已提交
185
	int			skc_bound_dev_if;
186 187 188 189
	union {
		struct hlist_node	skc_bind_node;
		struct hlist_nulls_node skc_portaddr_node;
	};
190
	struct proto		*skc_prot;
191
#ifdef CONFIG_NET_NS
192
	struct net	 	*skc_net;
193
#endif
194 195 196 197 198 199

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

200 201 202 203
	/*
	 * fields between dontcopy_begin/dontcopy_end
	 * are not copied in sock_copy()
	 */
204
	/* private: */
205
	int			skc_dontcopy_begin[0];
206
	/* public: */
207 208 209 210 211 212
	union {
		struct hlist_node	skc_node;
		struct hlist_nulls_node skc_nulls_node;
	};
	int			skc_tx_queue_mapping;
	atomic_t		skc_refcnt;
213
	/* private: */
214
	int                     skc_dontcopy_end[0];
215
	/* public: */
L
Linus Torvalds 已提交
216 217
};

G
Glauber Costa 已提交
218
struct cg_proto;
L
Linus Torvalds 已提交
219 220
/**
  *	struct sock - network layer representation of sockets
221
  *	@__sk_common: shared layout with inet_timewait_sock
222 223 224 225
  *	@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
226
  *	@sk_wq: sock wait queue and async head
S
Shawn Bohrer 已提交
227
  *	@sk_rx_dst: receive input route used by early demux
228 229 230 231 232 233
  *	@sk_dst_cache: destination cache
  *	@sk_dst_lock: destination cache lock
  *	@sk_policy: flow policy
  *	@sk_receive_queue: incoming packets
  *	@sk_wmem_alloc: transmit queue bytes committed
  *	@sk_write_queue: Packet sending queue
234
  *	@sk_async_wait_queue: DMA copied packets
235 236 237
  *	@sk_omem_alloc: "o" is "option" or "other"
  *	@sk_wmem_queued: persistent queue size
  *	@sk_forward_alloc: space allocated forward
E
Eliezer Tamir 已提交
238
  *	@sk_napi_id: id of the last napi context to receive data for sk
239
  *	@sk_ll_usec: usecs to busypoll when there is no data
240
  *	@sk_allocation: allocation mode
E
Eric Dumazet 已提交
241
  *	@sk_pacing_rate: Pacing rate (if supported by transport/packet scheduler)
242
  *	@sk_max_pacing_rate: Maximum pacing rate (%SO_MAX_PACING_RATE)
243
  *	@sk_sndbuf: size of send buffer in bytes
W
Wang Chen 已提交
244
  *	@sk_flags: %SO_LINGER (l_onoff), %SO_BROADCAST, %SO_KEEPALIVE,
245
  *		   %SO_OOBINLINE settings, %SO_TIMESTAMPING settings
246
  *	@sk_no_check: %SO_NO_CHECK setting, whether or not checkup packets
247
  *	@sk_route_caps: route capabilities (e.g. %NETIF_F_TSO)
E
Eric Dumazet 已提交
248
  *	@sk_route_nocaps: forbidden route capabilities (e.g NETIF_F_GSO_MASK)
249
  *	@sk_gso_type: GSO type (e.g. %SKB_GSO_TCPV4)
250
  *	@sk_gso_max_size: Maximum GSO segment size to build
251
  *	@sk_gso_max_segs: Maximum number of GSO segments
252 253 254 255
  *	@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 已提交
256 257
  *	@sk_prot_creator: sk_prot of original sock creator (see ipv6_setsockopt,
  *			  IPV6_ADDRFORM for instance)
258
  *	@sk_err: last error
W
Wang Chen 已提交
259 260
  *	@sk_err_soft: errors that don't cause failure but are the cause of a
  *		      persistent failure not just 'timed out'
E
Eric Dumazet 已提交
261
  *	@sk_drops: raw/udp drops counter
262 263 264
  *	@sk_ack_backlog: current listen backlog
  *	@sk_max_ack_backlog: listen backlog set in listen()
  *	@sk_priority: %SO_PRIORITY setting
265
  *	@sk_cgrp_prioidx: socket group's priority map index
266 267
  *	@sk_type: socket type (%SOCK_STREAM, etc)
  *	@sk_protocol: which protocol this socket belongs in this network family
268 269
  *	@sk_peer_pid: &struct pid for this socket's peer
  *	@sk_peer_cred: %SO_PEERCRED setting
270 271 272
  *	@sk_rcvlowat: %SO_RCVLOWAT setting
  *	@sk_rcvtimeo: %SO_RCVTIMEO setting
  *	@sk_sndtimeo: %SO_SNDTIMEO setting
273
  *	@sk_rxhash: flow hash received from netif layer
274 275 276 277 278 279
  *	@sk_filter: socket filtering instructions
  *	@sk_protinfo: private area, net family specific, when not using slab
  *	@sk_timer: sock cleanup timer
  *	@sk_stamp: time stamp of last packet received
  *	@sk_socket: Identd and reporting IO signals
  *	@sk_user_data: RPC layer private data
280
  *	@sk_frag: cached page frag
281
  *	@sk_peek_off: current peek_offset value
282
  *	@sk_send_head: front of stuff to transmit
283
  *	@sk_security: used by security modules
284
  *	@sk_mark: generic packet mark
285
  *	@sk_classid: this socket's cgroup classid
G
Glauber Costa 已提交
286
  *	@sk_cgrp: this socket's cgroup-specific proto data
287 288 289 290 291 292 293
  *	@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 已提交
294 295 296
 */
struct sock {
	/*
297
	 * Now struct inet_timewait_sock also uses sock_common, so please just
L
Linus Torvalds 已提交
298 299 300
	 * don't add nothing before this first member (__sk_common) --acme
	 */
	struct sock_common	__sk_common;
E
Eric Dumazet 已提交
301 302 303
#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 已提交
304
#define sk_tx_queue_mapping	__sk_common.skc_tx_queue_mapping
E
Eric Dumazet 已提交
305

306 307
#define sk_dontcopy_begin	__sk_common.skc_dontcopy_begin
#define sk_dontcopy_end		__sk_common.skc_dontcopy_end
E
Eric Dumazet 已提交
308
#define sk_hash			__sk_common.skc_hash
E
Eric Dumazet 已提交
309
#define sk_portpair		__sk_common.skc_portpair
E
Eric Dumazet 已提交
310 311
#define sk_num			__sk_common.skc_num
#define sk_dport		__sk_common.skc_dport
E
Eric Dumazet 已提交
312 313 314
#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 已提交
315 316 317
#define sk_family		__sk_common.skc_family
#define sk_state		__sk_common.skc_state
#define sk_reuse		__sk_common.skc_reuse
T
Tom Herbert 已提交
318
#define sk_reuseport		__sk_common.skc_reuseport
L
Linus Torvalds 已提交
319 320
#define sk_bound_dev_if		__sk_common.skc_bound_dev_if
#define sk_bind_node		__sk_common.skc_bind_node
321
#define sk_prot			__sk_common.skc_prot
322
#define sk_net			__sk_common.skc_net
323 324 325
#define sk_v6_daddr		__sk_common.skc_v6_daddr
#define sk_v6_rcv_saddr	__sk_common.skc_v6_rcv_saddr

L
Linus Torvalds 已提交
326
	socket_lock_t		sk_lock;
E
Eric Dumazet 已提交
327
	struct sk_buff_head	sk_receive_queue;
328 329 330 331
	/*
	 * 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 已提交
332 333 334
	 * Note : rmem_alloc is in this structure to fill a hole
	 * on 64bit arches, not because its logically part of
	 * backlog.
335 336
	 */
	struct {
E
Eric Dumazet 已提交
337 338 339 340
		atomic_t	rmem_alloc;
		int		len;
		struct sk_buff	*head;
		struct sk_buff	*tail;
341
	} sk_backlog;
E
Eric Dumazet 已提交
342 343 344 345
#define sk_rmem_alloc sk_backlog.rmem_alloc
	int			sk_forward_alloc;
#ifdef CONFIG_RPS
	__u32			sk_rxhash;
E
Eliezer Tamir 已提交
346
#endif
347
#ifdef CONFIG_NET_RX_BUSY_POLL
E
Eliezer Tamir 已提交
348
	unsigned int		sk_napi_id;
349
	unsigned int		sk_ll_usec;
E
Eric Dumazet 已提交
350 351 352 353 354
#endif
	atomic_t		sk_drops;
	int			sk_rcvbuf;

	struct sk_filter __rcu	*sk_filter;
355
	struct socket_wq __rcu	*sk_wq;
E
Eric Dumazet 已提交
356 357 358 359 360

#ifdef CONFIG_NET_DMA
	struct sk_buff_head	sk_async_wait_queue;
#endif

361
#ifdef CONFIG_XFRM
L
Linus Torvalds 已提交
362
	struct xfrm_policy	*sk_policy[2];
363
#endif
E
Eric Dumazet 已提交
364
	unsigned long 		sk_flags;
E
Eric Dumazet 已提交
365
	struct dst_entry	*sk_rx_dst;
366
	struct dst_entry __rcu	*sk_dst_cache;
E
Eric Dumazet 已提交
367
	spinlock_t		sk_dst_lock;
L
Linus Torvalds 已提交
368 369
	atomic_t		sk_wmem_alloc;
	atomic_t		sk_omem_alloc;
370
	int			sk_sndbuf;
L
Linus Torvalds 已提交
371
	struct sk_buff_head	sk_write_queue;
E
Eric Dumazet 已提交
372 373 374 375 376 377 378
	kmemcheck_bitfield_begin(flags);
	unsigned int		sk_shutdown  : 2,
				sk_no_check  : 2,
				sk_userlocks : 4,
				sk_protocol  : 8,
				sk_type      : 16;
	kmemcheck_bitfield_end(flags);
L
Linus Torvalds 已提交
379
	int			sk_wmem_queued;
A
Al Viro 已提交
380
	gfp_t			sk_allocation;
E
Eric Dumazet 已提交
381
	u32			sk_pacing_rate; /* bytes per second */
E
Eric Dumazet 已提交
382
	u32			sk_max_pacing_rate;
383 384
	netdev_features_t	sk_route_caps;
	netdev_features_t	sk_route_nocaps;
385
	int			sk_gso_type;
386
	unsigned int		sk_gso_max_size;
387
	u16			sk_gso_max_segs;
388
	int			sk_rcvlowat;
L
Linus Torvalds 已提交
389 390
	unsigned long	        sk_lingertime;
	struct sk_buff_head	sk_error_queue;
391
	struct proto		*sk_prot_creator;
L
Linus Torvalds 已提交
392 393 394 395 396 397
	rwlock_t		sk_callback_lock;
	int			sk_err,
				sk_err_soft;
	unsigned short		sk_ack_backlog;
	unsigned short		sk_max_ack_backlog;
	__u32			sk_priority;
398
#if IS_ENABLED(CONFIG_CGROUP_NET_PRIO)
399 400
	__u32			sk_cgrp_prioidx;
#endif
401 402
	struct pid		*sk_peer_pid;
	const struct cred	*sk_peer_cred;
L
Linus Torvalds 已提交
403 404 405 406
	long			sk_rcvtimeo;
	long			sk_sndtimeo;
	void			*sk_protinfo;
	struct timer_list	sk_timer;
407
	ktime_t			sk_stamp;
L
Linus Torvalds 已提交
408 409
	struct socket		*sk_socket;
	void			*sk_user_data;
410
	struct page_frag	sk_frag;
L
Linus Torvalds 已提交
411
	struct sk_buff		*sk_send_head;
412
	__s32			sk_peek_off;
L
Linus Torvalds 已提交
413
	int			sk_write_pending;
A
Alexey Dobriyan 已提交
414
#ifdef CONFIG_SECURITY
L
Linus Torvalds 已提交
415
	void			*sk_security;
A
Alexey Dobriyan 已提交
416
#endif
417
	__u32			sk_mark;
418
	u32			sk_classid;
G
Glauber Costa 已提交
419
	struct cg_proto		*sk_cgrp;
L
Linus Torvalds 已提交
420 421 422 423
	void			(*sk_state_change)(struct sock *sk);
	void			(*sk_data_ready)(struct sock *sk, int bytes);
	void			(*sk_write_space)(struct sock *sk);
	void			(*sk_error_report)(struct sock *sk);
E
Eric Dumazet 已提交
424 425
	int			(*sk_backlog_rcv)(struct sock *sk,
						  struct sk_buff *skb);
L
Linus Torvalds 已提交
426 427 428
	void                    (*sk_destruct)(struct sock *sk);
};

429 430 431 432 433
#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)

434 435 436 437 438 439 440 441 442 443 444
/*
 * 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

445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468
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 已提交
469 470 471
/*
 * Hashed lists helper routines
 */
L
Li Zefan 已提交
472 473 474 475 476
static inline struct sock *sk_entry(const struct hlist_node *node)
{
	return hlist_entry(node, struct sock, sk_node);
}

477
static inline struct sock *__sk_head(const struct hlist_head *head)
L
Linus Torvalds 已提交
478 479 480 481
{
	return hlist_entry(head->first, struct sock, sk_node);
}

482
static inline struct sock *sk_head(const struct hlist_head *head)
L
Linus Torvalds 已提交
483 484 485 486
{
	return hlist_empty(head) ? NULL : __sk_head(head);
}

487 488 489 490 491 492 493 494 495 496
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);
}

497
static inline struct sock *sk_next(const struct sock *sk)
L
Linus Torvalds 已提交
498 499 500 501 502
{
	return sk->sk_node.next ?
		hlist_entry(sk->sk_node.next, struct sock, sk_node) : NULL;
}

503 504 505 506 507 508 509 510
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 已提交
511
static inline bool sk_unhashed(const struct sock *sk)
L
Linus Torvalds 已提交
512 513 514 515
{
	return hlist_unhashed(&sk->sk_node);
}

E
Eric Dumazet 已提交
516
static inline bool sk_hashed(const struct sock *sk)
L
Linus Torvalds 已提交
517
{
A
Akinobu Mita 已提交
518
	return !sk_unhashed(sk);
L
Linus Torvalds 已提交
519 520
}

E
Eric Dumazet 已提交
521
static inline void sk_node_init(struct hlist_node *node)
L
Linus Torvalds 已提交
522 523 524 525
{
	node->pprev = NULL;
}

E
Eric Dumazet 已提交
526
static inline void sk_nulls_node_init(struct hlist_nulls_node *node)
527 528 529 530
{
	node->pprev = NULL;
}

E
Eric Dumazet 已提交
531
static inline void __sk_del_node(struct sock *sk)
L
Linus Torvalds 已提交
532 533 534 535
{
	__hlist_del(&sk->sk_node);
}

536
/* NB: equivalent to hlist_del_init_rcu */
E
Eric Dumazet 已提交
537
static inline bool __sk_del_node_init(struct sock *sk)
L
Linus Torvalds 已提交
538 539 540 541
{
	if (sk_hashed(sk)) {
		__sk_del_node(sk);
		sk_node_init(&sk->sk_node);
E
Eric Dumazet 已提交
542
		return true;
L
Linus Torvalds 已提交
543
	}
E
Eric Dumazet 已提交
544
	return false;
L
Linus Torvalds 已提交
545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565
}

/* 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 已提交
566
static inline bool sk_del_node_init(struct sock *sk)
L
Linus Torvalds 已提交
567
{
E
Eric Dumazet 已提交
568
	bool rc = __sk_del_node_init(sk);
L
Linus Torvalds 已提交
569 570 571 572 573 574 575 576

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

E
Eric Dumazet 已提交
579
static inline bool __sk_nulls_del_node_init_rcu(struct sock *sk)
580 581
{
	if (sk_hashed(sk)) {
582
		hlist_nulls_del_init_rcu(&sk->sk_nulls_node);
E
Eric Dumazet 已提交
583
		return true;
584
	}
E
Eric Dumazet 已提交
585
	return false;
586 587
}

E
Eric Dumazet 已提交
588
static inline bool sk_nulls_del_node_init_rcu(struct sock *sk)
589
{
E
Eric Dumazet 已提交
590
	bool rc = __sk_nulls_del_node_init_rcu(sk);
591 592 593 594 595 596 597 598 599

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

E
Eric Dumazet 已提交
600
static inline void __sk_add_node(struct sock *sk, struct hlist_head *list)
L
Linus Torvalds 已提交
601 602 603 604
{
	hlist_add_head(&sk->sk_node, list);
}

E
Eric Dumazet 已提交
605
static inline void sk_add_node(struct sock *sk, struct hlist_head *list)
L
Linus Torvalds 已提交
606 607 608 609 610
{
	sock_hold(sk);
	__sk_add_node(sk, list);
}

E
Eric Dumazet 已提交
611
static inline void sk_add_node_rcu(struct sock *sk, struct hlist_head *list)
612 613 614 615 616
{
	sock_hold(sk);
	hlist_add_head_rcu(&sk->sk_node, list);
}

E
Eric Dumazet 已提交
617
static inline void __sk_nulls_add_node_rcu(struct sock *sk, struct hlist_nulls_head *list)
618
{
619
	hlist_nulls_add_head_rcu(&sk->sk_nulls_node, list);
620 621
}

E
Eric Dumazet 已提交
622
static inline void sk_nulls_add_node_rcu(struct sock *sk, struct hlist_nulls_head *list)
623 624
{
	sock_hold(sk);
625
	__sk_nulls_add_node_rcu(sk, list);
626 627
}

E
Eric Dumazet 已提交
628
static inline void __sk_del_bind_node(struct sock *sk)
L
Linus Torvalds 已提交
629 630 631 632
{
	__hlist_del(&sk->sk_bind_node);
}

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

639 640 641 642
#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)
643 644 645 646
#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)
647 648
#define sk_for_each_from(__sk) \
	hlist_for_each_entry_from(__sk, sk_node)
649 650 651
#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)
652 653 654 655
#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 已提交
656

E
Eric W. Biederman 已提交
657 658 659 660 661 662 663 664 665
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 已提交
666 667 668 669 670 671 672 673 674 675 676 677 678 679
/* 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 */
680
	SOCK_RCVTSTAMPNS, /* %SO_TIMESTAMPNS setting */
L
Linus Torvalds 已提交
681 682
	SOCK_LOCALROUTE, /* route locally only, %SO_DONTROUTE setting */
	SOCK_QUEUE_SHRUNK, /* write queue has been shrunk recently */
683
	SOCK_MEMALLOC, /* VM depends on this socket for swapping */
684 685 686 687 688 689 690
	SOCK_TIMESTAMPING_TX_HARDWARE,  /* %SOF_TIMESTAMPING_TX_HARDWARE */
	SOCK_TIMESTAMPING_TX_SOFTWARE,  /* %SOF_TIMESTAMPING_TX_SOFTWARE */
	SOCK_TIMESTAMPING_RX_HARDWARE,  /* %SOF_TIMESTAMPING_RX_HARDWARE */
	SOCK_TIMESTAMPING_RX_SOFTWARE,  /* %SOF_TIMESTAMPING_RX_SOFTWARE */
	SOCK_TIMESTAMPING_SOFTWARE,     /* %SOF_TIMESTAMPING_SOFTWARE */
	SOCK_TIMESTAMPING_RAW_HARDWARE, /* %SOF_TIMESTAMPING_RAW_HARDWARE */
	SOCK_TIMESTAMPING_SYS_HARDWARE, /* %SOF_TIMESTAMPING_SYS_HARDWARE */
E
Eric Dumazet 已提交
691
	SOCK_FASYNC, /* fasync() active */
692
	SOCK_RXQ_OVFL,
693
	SOCK_ZEROCOPY, /* buffers from userspace */
694
	SOCK_WIFI_STATUS, /* push wifi status to userspace */
695 696 697 698
	SOCK_NOFCS, /* Tell NIC not to do the Ethernet FCS.
		     * Will use last 4 bytes of packet sent from
		     * user-space instead.
		     */
699
	SOCK_FILTER_LOCKED, /* Filter cannot be changed anymore */
700
	SOCK_SELECT_ERR_QUEUE, /* Wake select on error queue */
L
Linus Torvalds 已提交
701 702
};

R
Ralf Baechle 已提交
703 704 705 706 707
static inline void sock_copy_flags(struct sock *nsk, struct sock *osk)
{
	nsk->sk_flags = osk->sk_flags;
}

L
Linus Torvalds 已提交
708 709 710 711 712 713 714 715 716 717
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 已提交
718
static inline bool sock_flag(const struct sock *sk, enum sock_flags flag)
L
Linus Torvalds 已提交
719 720 721 722
{
	return test_bit(flag, &sk->sk_flags);
}

723 724 725 726 727 728 729 730 731 732 733 734 735 736 737
#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

738 739
static inline gfp_t sk_gfp_atomic(struct sock *sk, gfp_t gfp_mask)
{
740
	return GFP_ATOMIC | (sk->sk_allocation & __GFP_MEMALLOC);
741 742
}

L
Linus Torvalds 已提交
743 744 745 746 747 748 749 750 751 752
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 已提交
753
static inline bool sk_acceptq_is_full(const struct sock *sk)
L
Linus Torvalds 已提交
754
{
755
	return sk->sk_ack_backlog > sk->sk_max_ack_backlog;
L
Linus Torvalds 已提交
756 757 758 759 760
}

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

E
Eric Dumazet 已提交
766
static inline int sk_stream_wspace(const struct sock *sk)
L
Linus Torvalds 已提交
767 768 769 770
{
	return sk->sk_sndbuf - sk->sk_wmem_queued;
}

771
void sk_stream_write_space(struct sock *sk);
L
Linus Torvalds 已提交
772

Z
Zhu Yi 已提交
773
/* OOB backlog add */
Z
Zhu Yi 已提交
774
static inline void __sk_add_backlog(struct sock *sk, struct sk_buff *skb)
775
{
E
Eric Dumazet 已提交
776 777 778 779 780 781
	/* 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
782
		sk->sk_backlog.tail->next = skb;
E
Eric Dumazet 已提交
783 784

	sk->sk_backlog.tail = skb;
785 786
	skb->next = NULL;
}
L
Linus Torvalds 已提交
787

788 789
/*
 * Take into account size of receive queue and backlog queue
E
Eric Dumazet 已提交
790 791
 * Do not take into account this skb truesize,
 * to allow even a single big packet to come.
792
 */
793 794
static inline bool sk_rcvqueues_full(const struct sock *sk, const struct sk_buff *skb,
				     unsigned int limit)
795 796 797
{
	unsigned int qsize = sk->sk_backlog.len + atomic_read(&sk->sk_rmem_alloc);

798
	return qsize > limit;
799 800
}

Z
Zhu Yi 已提交
801
/* The per-socket spinlock must be held here. */
802 803
static inline __must_check int sk_add_backlog(struct sock *sk, struct sk_buff *skb,
					      unsigned int limit)
Z
Zhu Yi 已提交
804
{
805
	if (sk_rcvqueues_full(sk, skb, limit))
Z
Zhu Yi 已提交
806 807
		return -ENOBUFS;

Z
Zhu Yi 已提交
808
	__sk_add_backlog(sk, skb);
Z
Zhu Yi 已提交
809 810 811 812
	sk->sk_backlog.len += skb->truesize;
	return 0;
}

813
int __sk_backlog_rcv(struct sock *sk, struct sk_buff *skb);
814

P
Peter Zijlstra 已提交
815 816
static inline int sk_backlog_rcv(struct sock *sk, struct sk_buff *skb)
{
817 818 819
	if (sk_memalloc_socks() && skb_pfmemalloc(skb))
		return __sk_backlog_rcv(sk, skb);

P
Peter Zijlstra 已提交
820 821 822
	return sk->sk_backlog_rcv(sk, skb);
}

823
static inline void sock_rps_record_flow_hash(__u32 hash)
824 825 826 827 828 829
{
#ifdef CONFIG_RPS
	struct rps_sock_flow_table *sock_flow_table;

	rcu_read_lock();
	sock_flow_table = rcu_dereference(rps_sock_flow_table);
830
	rps_record_sock_flow(sock_flow_table, hash);
831 832 833 834
	rcu_read_unlock();
#endif
}

835
static inline void sock_rps_reset_flow_hash(__u32 hash)
836 837 838 839 840 841
{
#ifdef CONFIG_RPS
	struct rps_sock_flow_table *sock_flow_table;

	rcu_read_lock();
	sock_flow_table = rcu_dereference(rps_sock_flow_table);
842
	rps_reset_sock_flow(sock_flow_table, hash);
843 844 845 846
	rcu_read_unlock();
#endif
}

847 848
static inline void sock_rps_record_flow(const struct sock *sk)
{
849
#ifdef CONFIG_RPS
850
	sock_rps_record_flow_hash(sk->sk_rxhash);
851
#endif
852 853 854 855
}

static inline void sock_rps_reset_flow(const struct sock *sk)
{
856
#ifdef CONFIG_RPS
857
	sock_rps_reset_flow_hash(sk->sk_rxhash);
858
#endif
859 860
}

861 862
static inline void sock_rps_save_rxhash(struct sock *sk,
					const struct sk_buff *skb)
863 864
{
#ifdef CONFIG_RPS
865
	if (unlikely(sk->sk_rxhash != skb->rxhash)) {
866
		sock_rps_reset_flow(sk);
867
		sk->sk_rxhash = skb->rxhash;
868 869 870 871
	}
#endif
}

872 873 874 875 876 877 878 879
static inline void sock_rps_reset_rxhash(struct sock *sk)
{
#ifdef CONFIG_RPS
	sock_rps_reset_flow(sk);
	sk->sk_rxhash = 0;
#endif
}

S
Stephen Hemminger 已提交
880 881 882 883 884 885 886 887 888 889 890
#define sk_wait_event(__sk, __timeo, __condition)			\
	({	int __rc;						\
		release_sock(__sk);					\
		__rc = __condition;					\
		if (!__rc) {						\
			*(__timeo) = schedule_timeout(*(__timeo));	\
		}							\
		lock_sock(__sk);					\
		__rc = __condition;					\
		__rc;							\
	})
L
Linus Torvalds 已提交
891

892 893 894 895 896 897 898
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 已提交
899

900
int sk_wait_data(struct sock *sk, long *timeo);
L
Linus Torvalds 已提交
901

902
struct request_sock_ops;
903
struct timewait_sock_ops;
904
struct inet_hashinfo;
905
struct raw_hashinfo;
906
struct module;
907

E
Eric Dumazet 已提交
908 909 910 911 912 913 914 915 916 917 918 919
/*
 * 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 已提交
920 921 922 923 924
/* Networking protocol blocks we attach to sockets.
 * socket layer -> transport layer interface
 * transport -> network interface is defined by struct inet_proto
 */
struct proto {
E
Eric Dumazet 已提交
925
	void			(*close)(struct sock *sk,
L
Linus Torvalds 已提交
926 927
					long timeout);
	int			(*connect)(struct sock *sk,
E
Eric Dumazet 已提交
928
					struct sockaddr *uaddr,
L
Linus Torvalds 已提交
929 930 931
					int addr_len);
	int			(*disconnect)(struct sock *sk, int flags);

E
Eric Dumazet 已提交
932
	struct sock *		(*accept)(struct sock *sk, int flags, int *err);
L
Linus Torvalds 已提交
933 934 935 936

	int			(*ioctl)(struct sock *sk, int cmd,
					 unsigned long arg);
	int			(*init)(struct sock *sk);
937
	void			(*destroy)(struct sock *sk);
L
Linus Torvalds 已提交
938
	void			(*shutdown)(struct sock *sk, int how);
E
Eric Dumazet 已提交
939
	int			(*setsockopt)(struct sock *sk, int level,
L
Linus Torvalds 已提交
940
					int optname, char __user *optval,
941
					unsigned int optlen);
E
Eric Dumazet 已提交
942 943 944
	int			(*getsockopt)(struct sock *sk, int level,
					int optname, char __user *optval,
					int __user *option);
A
Alexey Dobriyan 已提交
945
#ifdef CONFIG_COMPAT
946 947 948
	int			(*compat_setsockopt)(struct sock *sk,
					int level,
					int optname, char __user *optval,
949
					unsigned int optlen);
950 951 952 953
	int			(*compat_getsockopt)(struct sock *sk,
					int level,
					int optname, char __user *optval,
					int __user *option);
954 955
	int			(*compat_ioctl)(struct sock *sk,
					unsigned int cmd, unsigned long arg);
A
Alexey Dobriyan 已提交
956
#endif
L
Linus Torvalds 已提交
957 958 959 960
	int			(*sendmsg)(struct kiocb *iocb, struct sock *sk,
					   struct msghdr *msg, size_t len);
	int			(*recvmsg)(struct kiocb *iocb, struct sock *sk,
					   struct msghdr *msg,
E
Eric Dumazet 已提交
961 962
					   size_t len, int noblock, int flags,
					   int *addr_len);
L
Linus Torvalds 已提交
963 964
	int			(*sendpage)(struct sock *sk, struct page *page,
					int offset, size_t size, int flags);
E
Eric Dumazet 已提交
965
	int			(*bind)(struct sock *sk,
L
Linus Torvalds 已提交
966 967
					struct sockaddr *uaddr, int addr_len);

E
Eric Dumazet 已提交
968
	int			(*backlog_rcv) (struct sock *sk,
L
Linus Torvalds 已提交
969 970
						struct sk_buff *skb);

E
Eric Dumazet 已提交
971
	void		(*release_cb)(struct sock *sk);
972
	void		(*mtu_reduced)(struct sock *sk);
E
Eric Dumazet 已提交
973

L
Linus Torvalds 已提交
974 975 976
	/* 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 已提交
977
	void			(*rehash)(struct sock *sk);
L
Linus Torvalds 已提交
978
	int			(*get_port)(struct sock *sk, unsigned short snum);
979
	void			(*clear_sk)(struct sock *sk, int size);
L
Linus Torvalds 已提交
980

981
	/* Keeping track of sockets in use */
982
#ifdef CONFIG_PROC_FS
983
	unsigned int		inuse_idx;
984
#endif
985

986
	bool			(*stream_memory_free)(const struct sock *sk);
L
Linus Torvalds 已提交
987
	/* Memory pressure */
988
	void			(*enter_memory_pressure)(struct sock *sk);
E
Eric Dumazet 已提交
989
	atomic_long_t		*memory_allocated;	/* Current allocated memory. */
990
	struct percpu_counter	*sockets_allocated;	/* Current number of sockets. */
L
Linus Torvalds 已提交
991 992 993
	/*
	 * Pressure flag: try to collapse.
	 * Technical note: it is used by multiple contexts non atomically.
994
	 * All the __sk_mem_schedule() is of this nature: accounting
L
Linus Torvalds 已提交
995 996 997
	 * is strict, actions are advisory and have some latency.
	 */
	int			*memory_pressure;
E
Eric Dumazet 已提交
998
	long			*sysctl_mem;
L
Linus Torvalds 已提交
999 1000 1001
	int			*sysctl_wmem;
	int			*sysctl_rmem;
	int			max_header;
1002
	bool			no_autobind;
L
Linus Torvalds 已提交
1003

1004
	struct kmem_cache	*slab;
L
Linus Torvalds 已提交
1005
	unsigned int		obj_size;
1006
	int			slab_flags;
L
Linus Torvalds 已提交
1007

1008
	struct percpu_counter	*orphan_count;
1009

1010
	struct request_sock_ops	*rsk_prot;
1011
	struct timewait_sock_ops *twsk_prot;
1012

1013 1014
	union {
		struct inet_hashinfo	*hashinfo;
1015
		struct udp_table	*udp_table;
1016
		struct raw_hashinfo	*raw_hash;
1017
	} h;
1018

L
Linus Torvalds 已提交
1019 1020 1021 1022 1023
	struct module		*owner;

	char			name[32];

	struct list_head	node;
1024 1025 1026
#ifdef SOCK_REFCNT_DEBUG
	atomic_t		socks;
#endif
A
Andrew Morton 已提交
1027
#ifdef CONFIG_MEMCG_KMEM
G
Glauber Costa 已提交
1028 1029 1030 1031 1032 1033
	/*
	 * 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.
	 */
1034
	int			(*init_cgroup)(struct mem_cgroup *memcg,
G
Glauber Costa 已提交
1035
					       struct cgroup_subsys *ss);
1036
	void			(*destroy_cgroup)(struct mem_cgroup *memcg);
G
Glauber Costa 已提交
1037 1038 1039 1040
	struct cg_proto		*(*proto_cgroup)(struct mem_cgroup *memcg);
#endif
};

1041 1042 1043 1044 1045 1046 1047 1048 1049 1050
/*
 * Bits in struct cg_proto.flags
 */
enum cg_proto_flags {
	/* Currently active and new sockets should be assigned to cgroups */
	MEMCG_SOCK_ACTIVE,
	/* It was ever activated; we must disarm static keys on destruction */
	MEMCG_SOCK_ACTIVATED,
};

G
Glauber Costa 已提交
1051
struct cg_proto {
1052 1053 1054 1055
	struct res_counter	memory_allocated;	/* Current allocated memory. */
	struct percpu_counter	sockets_allocated;	/* Current number of sockets. */
	int			memory_pressure;
	long			sysctl_mem[3];
1056
	unsigned long		flags;
G
Glauber Costa 已提交
1057 1058 1059 1060 1061 1062 1063 1064 1065 1066
	/*
	 * memcg field is used to find which memcg we belong directly
	 * Each memcg struct can hold more than one cg_proto, so container_of
	 * won't really cut.
	 *
	 * The elegant solution would be having an inverse function to
	 * proto_cgroup in struct proto, but that means polluting the structure
	 * for everybody, instead of just for memcg users.
	 */
	struct mem_cgroup	*memcg;
L
Linus Torvalds 已提交
1067 1068
};

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

1072 1073 1074 1075 1076 1077 1078 1079 1080 1081
static inline bool memcg_proto_active(struct cg_proto *cg_proto)
{
	return test_bit(MEMCG_SOCK_ACTIVE, &cg_proto->flags);
}

static inline bool memcg_proto_activated(struct cg_proto *cg_proto)
{
	return test_bit(MEMCG_SOCK_ACTIVATED, &cg_proto->flags);
}

1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094
#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));
}

1095
static inline void sk_refcnt_debug_release(const struct sock *sk)
1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106
{
	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 已提交
1107
#if defined(CONFIG_MEMCG_KMEM) && defined(CONFIG_NET)
1108
extern struct static_key memcg_socket_limit_enabled;
G
Glauber Costa 已提交
1109 1110 1111 1112 1113
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));
}
1114
#define mem_cgroup_sockets_enabled static_key_false(&memcg_socket_limit_enabled)
G
Glauber Costa 已提交
1115 1116 1117 1118 1119 1120 1121 1122 1123
#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

1124 1125 1126 1127 1128 1129 1130 1131 1132
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;
}

1133 1134
static inline bool sk_stream_is_writeable(const struct sock *sk)
{
1135 1136
	return sk_stream_wspace(sk) >= sk_stream_min_wspace(sk) &&
	       sk_stream_memory_free(sk);
1137
}
G
Glauber Costa 已提交
1138

1139

1140 1141 1142 1143 1144 1145 1146 1147 1148
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 已提交
1149 1150

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

1153
	return !!*sk->sk_prot->memory_pressure;
1154 1155 1156 1157 1158 1159
}

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

G
Glauber Costa 已提交
1160 1161 1162 1163
	if (!memory_pressure)
		return;

	if (*memory_pressure)
1164
		*memory_pressure = 0;
G
Glauber Costa 已提交
1165 1166 1167 1168 1169 1170

	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))
1171
			cg_proto->memory_pressure = 0;
G
Glauber Costa 已提交
1172 1173
	}

1174 1175 1176 1177
}

static inline void sk_enter_memory_pressure(struct sock *sk)
{
G
Glauber Costa 已提交
1178 1179 1180 1181 1182 1183 1184 1185
	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))
1186
			cg_proto->memory_pressure = 1;
G
Glauber Costa 已提交
1187 1188 1189
	}

	sk->sk_prot->enter_memory_pressure(sk);
1190 1191 1192 1193 1194
}

static inline long sk_prot_mem_limits(const struct sock *sk, int index)
{
	long *prot = sk->sk_prot->sysctl_mem;
G
Glauber Costa 已提交
1195 1196
	if (mem_cgroup_sockets_enabled && sk->sk_cgrp)
		prot = sk->sk_cgrp->sysctl_mem;
1197 1198 1199
	return prot[index];
}

G
Glauber Costa 已提交
1200 1201 1202 1203 1204 1205 1206
static inline void memcg_memory_allocated_add(struct cg_proto *prot,
					      unsigned long amt,
					      int *parent_status)
{
	struct res_counter *fail;
	int ret;

1207
	ret = res_counter_charge_nofail(&prot->memory_allocated,
1208
					amt << PAGE_SHIFT, &fail);
G
Glauber Costa 已提交
1209 1210 1211 1212 1213 1214 1215
	if (ret < 0)
		*parent_status = OVER_LIMIT;
}

static inline void memcg_memory_allocated_sub(struct cg_proto *prot,
					      unsigned long amt)
{
1216
	res_counter_uncharge(&prot->memory_allocated, amt << PAGE_SHIFT);
G
Glauber Costa 已提交
1217 1218 1219 1220 1221
}

static inline u64 memcg_memory_allocated_read(struct cg_proto *prot)
{
	u64 ret;
1222
	ret = res_counter_read_u64(&prot->memory_allocated, RES_USAGE);
G
Glauber Costa 已提交
1223 1224 1225
	return ret >> PAGE_SHIFT;
}

1226 1227 1228 1229
static inline long
sk_memory_allocated(const struct sock *sk)
{
	struct proto *prot = sk->sk_prot;
G
Glauber Costa 已提交
1230 1231 1232
	if (mem_cgroup_sockets_enabled && sk->sk_cgrp)
		return memcg_memory_allocated_read(sk->sk_cgrp);

1233 1234 1235 1236
	return atomic_long_read(prot->memory_allocated);
}

static inline long
G
Glauber Costa 已提交
1237
sk_memory_allocated_add(struct sock *sk, int amt, int *parent_status)
1238 1239
{
	struct proto *prot = sk->sk_prot;
G
Glauber Costa 已提交
1240 1241 1242 1243 1244 1245 1246 1247

	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);
		return memcg_memory_allocated_read(sk->sk_cgrp);
	}

1248 1249 1250 1251
	return atomic_long_add_return(amt, prot->memory_allocated);
}

static inline void
1252
sk_memory_allocated_sub(struct sock *sk, int amt)
1253 1254
{
	struct proto *prot = sk->sk_prot;
G
Glauber Costa 已提交
1255

1256
	if (mem_cgroup_sockets_enabled && sk->sk_cgrp)
G
Glauber Costa 已提交
1257 1258
		memcg_memory_allocated_sub(sk->sk_cgrp, amt);

1259 1260 1261 1262 1263 1264
	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 已提交
1265 1266 1267 1268 1269

	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))
1270
			percpu_counter_dec(&cg_proto->sockets_allocated);
G
Glauber Costa 已提交
1271 1272
	}

1273 1274 1275 1276 1277 1278
	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 已提交
1279 1280 1281 1282 1283

	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))
1284
			percpu_counter_inc(&cg_proto->sockets_allocated);
G
Glauber Costa 已提交
1285 1286
	}

1287 1288 1289 1290 1291 1292 1293 1294
	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 已提交
1295
	if (mem_cgroup_sockets_enabled && sk->sk_cgrp)
1296
		return percpu_counter_read_positive(&sk->sk_cgrp->sockets_allocated);
G
Glauber Costa 已提交
1297

1298
	return percpu_counter_read_positive(prot->sockets_allocated);
1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320
}

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

1321 1322

#ifdef CONFIG_PROC_FS
L
Linus Torvalds 已提交
1323
/* Called with local bh disabled */
1324 1325
void sock_prot_inuse_add(struct net *net, struct proto *prot, int inc);
int sock_prot_inuse_get(struct net *net, struct proto *proto);
1326
#else
E
Eric Dumazet 已提交
1327
static inline void sock_prot_inuse_add(struct net *net, struct proto *prot,
1328
		int inc)
1329 1330 1331 1332
{
}
#endif

L
Linus Torvalds 已提交
1333

1334 1335 1336 1337 1338 1339 1340 1341 1342
/* 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);
}

1343 1344
void sk_prot_clear_portaddr_nulls(struct sock *sk, int size);

L
Linus Torvalds 已提交
1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397
/* 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

/* sock_iocb: used to kick off async processing of socket ios */
struct sock_iocb {
	struct list_head	list;

	int			flags;
	int			size;
	struct socket		*sock;
	struct sock		*sk;
	struct scm_cookie	*scm;
	struct msghdr		*msg, async_msg;
	struct kiocb		*kiocb;
};

static inline struct sock_iocb *kiocb_to_siocb(struct kiocb *iocb)
{
	return (struct sock_iocb *)iocb->private;
}

static inline struct kiocb *siocb_to_kiocb(struct sock_iocb *si)
{
	return si->kiocb;
}

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

1398 1399 1400
/*
 * Functions for memory accounting
 */
1401 1402
int __sk_mem_schedule(struct sock *sk, int size, int kind);
void __sk_mem_reclaim(struct sock *sk);
L
Linus Torvalds 已提交
1403

1404 1405 1406 1407
#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 已提交
1408

1409
static inline int sk_mem_pages(int amt)
L
Linus Torvalds 已提交
1410
{
1411
	return (amt + SK_MEM_QUANTUM - 1) >> SK_MEM_QUANTUM_SHIFT;
L
Linus Torvalds 已提交
1412 1413
}

E
Eric Dumazet 已提交
1414
static inline bool sk_has_account(struct sock *sk)
L
Linus Torvalds 已提交
1415
{
1416 1417
	/* return true if protocol supports memory accounting */
	return !!sk->sk_prot->memory_allocated;
L
Linus Torvalds 已提交
1418 1419
}

E
Eric Dumazet 已提交
1420
static inline bool sk_wmem_schedule(struct sock *sk, int size)
L
Linus Torvalds 已提交
1421
{
1422
	if (!sk_has_account(sk))
E
Eric Dumazet 已提交
1423
		return true;
1424 1425
	return size <= sk->sk_forward_alloc ||
		__sk_mem_schedule(sk, size, SK_MEM_SEND);
L
Linus Torvalds 已提交
1426 1427
}

1428
static inline bool
1429
sk_rmem_schedule(struct sock *sk, struct sk_buff *skb, int size)
H
Herbert Xu 已提交
1430
{
1431
	if (!sk_has_account(sk))
E
Eric Dumazet 已提交
1432
		return true;
1433 1434 1435
	return size<= sk->sk_forward_alloc ||
		__sk_mem_schedule(sk, size, SK_MEM_RECV) ||
		skb_pfmemalloc(skb);
1436 1437 1438 1439 1440 1441 1442 1443 1444 1445
}

static inline void sk_mem_reclaim(struct sock *sk)
{
	if (!sk_has_account(sk))
		return;
	if (sk->sk_forward_alloc >= SK_MEM_QUANTUM)
		__sk_mem_reclaim(sk);
}

1446 1447 1448 1449 1450 1451 1452 1453
static inline void sk_mem_reclaim_partial(struct sock *sk)
{
	if (!sk_has_account(sk))
		return;
	if (sk->sk_forward_alloc > SK_MEM_QUANTUM)
		__sk_mem_reclaim(sk);
}

1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473
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 已提交
1474 1475
}

L
Linus Torvalds 已提交
1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488
/* 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.
 */
1489
#define sock_owned_by_user(sk)	((sk)->sk_lock.owned)
L
Linus Torvalds 已提交
1490

1491 1492 1493 1494 1495 1496 1497
/*
 * 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 已提交
1498
#define sock_lock_init_class_and_name(sk, sname, skey, name, key)	\
1499
do {									\
1500
	sk->sk_lock.owned = 0;						\
1501 1502 1503 1504 1505
	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 已提交
1506
				(skey), (sname));				\
1507 1508 1509
	lockdep_init_map(&(sk)->sk_lock.dep_map, (name), (key), 0);	\
} while (0)

1510
void lock_sock_nested(struct sock *sk, int subclass);
1511 1512 1513 1514 1515 1516

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

1517
void release_sock(struct sock *sk);
L
Linus Torvalds 已提交
1518 1519 1520

/* BH context may only use the following locking interface. */
#define bh_lock_sock(__sk)	spin_lock(&((__sk)->sk_lock.slock))
1521 1522 1523
#define bh_lock_sock_nested(__sk) \
				spin_lock_nested(&((__sk)->sk_lock.slock), \
				SINGLE_DEPTH_NESTING)
L
Linus Torvalds 已提交
1524 1525
#define bh_unlock_sock(__sk)	spin_unlock(&((__sk)->sk_lock.slock))

1526
bool lock_sock_fast(struct sock *sk);
1527 1528 1529 1530 1531 1532 1533 1534 1535
/**
 * 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 已提交
1536
{
1537 1538 1539 1540
	if (slow)
		release_sock(sk);
	else
		spin_unlock_bh(&sk->sk_lock.slock);
E
Eric Dumazet 已提交
1541 1542 1543
}


1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 1564 1565 1566 1567 1568 1569
struct sock *sk_alloc(struct net *net, int family, gfp_t priority,
		      struct proto *prot);
void sk_free(struct sock *sk);
void sk_release_kernel(struct sock *sk);
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);
void sock_edemux(struct sk_buff *skb);

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);
void sk_send_sigurg(struct sock *sk);
L
Linus Torvalds 已提交
1570 1571 1572 1573 1574

/*
 * Functions to fill in entries in struct proto_ops when a protocol
 * does not implement a particular function.
 */
1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 1585 1586 1587 1588 1589 1590 1591 1592 1593
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);
int sock_no_sendmsg(struct kiocb *, struct socket *, struct msghdr *, size_t);
int sock_no_recvmsg(struct kiocb *, struct socket *, struct msghdr *, size_t,
		    int);
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 已提交
1594 1595 1596 1597 1598

/*
 * Functions to fill in entries in struct proto_ops when a protocol
 * uses the inet style.
 */
1599
int sock_common_getsockopt(struct socket *sock, int level, int optname,
L
Linus Torvalds 已提交
1600
				  char __user *optval, int __user *optlen);
1601
int sock_common_recvmsg(struct kiocb *iocb, struct socket *sock,
L
Linus Torvalds 已提交
1602
			       struct msghdr *msg, size_t size, int flags);
1603
int sock_common_setsockopt(struct socket *sock, int level, int optname,
1604
				  char __user *optval, unsigned int optlen);
1605
int compat_sock_common_getsockopt(struct socket *sock, int level,
1606
		int optname, char __user *optval, int __user *optlen);
1607
int compat_sock_common_setsockopt(struct socket *sock, int level,
1608
		int optname, char __user *optval, unsigned int optlen);
L
Linus Torvalds 已提交
1609

1610
void sk_common_release(struct sock *sk);
L
Linus Torvalds 已提交
1611 1612 1613 1614

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

L
Linus Torvalds 已提交
1616
/* Initialise core socket variables */
1617
void sock_init_data(struct socket *sock, struct sock *sk);
L
Linus Torvalds 已提交
1618

1619
void sk_filter_release_rcu(struct rcu_head *rcu);
E
Eric Dumazet 已提交
1620

1621
/**
1622
 *	sk_filter_release - release a socket filter
1623 1624 1625 1626 1627
 *	@fp: filter to remove
 *
 *	Remove a filter from a socket and release its resources.
 */

1628 1629 1630
static inline void sk_filter_release(struct sk_filter *fp)
{
	if (atomic_dec_and_test(&fp->refcnt))
1631
		call_rcu(&fp->rcu, sk_filter_release_rcu);
1632 1633 1634
}

static inline void sk_filter_uncharge(struct sock *sk, struct sk_filter *fp)
L
Linus Torvalds 已提交
1635
{
1636
	atomic_sub(sk_filter_size(fp->len), &sk->sk_omem_alloc);
1637
	sk_filter_release(fp);
L
Linus Torvalds 已提交
1638 1639 1640 1641 1642
}

static inline void sk_filter_charge(struct sock *sk, struct sk_filter *fp)
{
	atomic_inc(&fp->refcnt);
1643
	atomic_add(sk_filter_size(fp->len), &sk->sk_omem_alloc);
L
Linus Torvalds 已提交
1644 1645 1646 1647 1648 1649 1650 1651 1652 1653 1654 1655 1656 1657 1658 1659 1660 1661 1662 1663 1664 1665 1666 1667 1668 1669 1670 1671 1672 1673 1674 1675 1676
}

/*
 * 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 已提交
1677 1678 1679 1680
/* Generic version of sock_put(), dealing with all sockets
 * (TCP_TIMEWAIT, ESTABLISHED...)
 */
void sock_gen_put(struct sock *sk);
L
Linus Torvalds 已提交
1681

1682
int sk_receive_skb(struct sock *sk, struct sk_buff *skb, const int nested);
1683

K
Krishna Kumar 已提交
1684 1685 1686 1687 1688 1689 1690 1691 1692 1693 1694 1695
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)
{
1696
	return sk ? sk->sk_tx_queue_mapping : -1;
K
Krishna Kumar 已提交
1697 1698
}

1699 1700
static inline void sk_set_socket(struct sock *sk, struct socket *sock)
{
K
Krishna Kumar 已提交
1701
	sk_tx_queue_clear(sk);
1702 1703 1704
	sk->sk_socket = sock;
}

E
Eric Dumazet 已提交
1705 1706
static inline wait_queue_head_t *sk_sleep(struct sock *sk)
{
1707 1708
	BUILD_BUG_ON(offsetof(struct socket_wq, wait) != 0);
	return &rcu_dereference_raw(sk->sk_wq)->wait;
E
Eric Dumazet 已提交
1709
}
L
Linus Torvalds 已提交
1710 1711 1712 1713 1714 1715 1716 1717 1718 1719 1720
/* 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);
1721
	sk_set_socket(sk, NULL);
1722
	sk->sk_wq  = NULL;
L
Linus Torvalds 已提交
1723 1724 1725 1726 1727 1728
	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);
1729
	sk->sk_wq = parent->wq;
L
Linus Torvalds 已提交
1730
	parent->sk = sk;
1731
	sk_set_socket(sk, parent);
1732
	security_sock_graft(sk, parent);
L
Linus Torvalds 已提交
1733 1734 1735
	write_unlock_bh(&sk->sk_callback_lock);
}

1736 1737
kuid_t sock_i_uid(struct sock *sk);
unsigned long sock_i_ino(struct sock *sk);
L
Linus Torvalds 已提交
1738 1739 1740 1741

static inline struct dst_entry *
__sk_dst_get(struct sock *sk)
{
1742
	return rcu_dereference_check(sk->sk_dst_cache, sock_owned_by_user(sk) ||
E
Eric Dumazet 已提交
1743
						       lockdep_is_held(&sk->sk_lock.slock));
L
Linus Torvalds 已提交
1744 1745 1746 1747 1748 1749 1750
}

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

E
Eric Dumazet 已提交
1751 1752
	rcu_read_lock();
	dst = rcu_dereference(sk->sk_dst_cache);
L
Linus Torvalds 已提交
1753 1754
	if (dst)
		dst_hold(dst);
E
Eric Dumazet 已提交
1755
	rcu_read_unlock();
L
Linus Torvalds 已提交
1756 1757 1758
	return dst;
}

E
Eric Dumazet 已提交
1759 1760 1761 1762 1763 1764 1765 1766 1767
static inline void dst_negative_advice(struct sock *sk)
{
	struct dst_entry *ndst, *dst = __sk_dst_get(sk);

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

		if (ndst != dst) {
			rcu_assign_pointer(sk->sk_dst_cache, ndst);
Z
ZHAO Gang 已提交
1768
			sk_tx_queue_clear(sk);
E
Eric Dumazet 已提交
1769 1770 1771 1772
		}
	}
}

L
Linus Torvalds 已提交
1773 1774 1775 1776 1777
static inline void
__sk_dst_set(struct sock *sk, struct dst_entry *dst)
{
	struct dst_entry *old_dst;

K
Krishna Kumar 已提交
1778
	sk_tx_queue_clear(sk);
1779 1780 1781 1782 1783
	/*
	 * 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 已提交
1784
	rcu_assign_pointer(sk->sk_dst_cache, dst);
L
Linus Torvalds 已提交
1785 1786 1787 1788 1789 1790
	dst_release(old_dst);
}

static inline void
sk_dst_set(struct sock *sk, struct dst_entry *dst)
{
E
Eric Dumazet 已提交
1791
	spin_lock(&sk->sk_dst_lock);
L
Linus Torvalds 已提交
1792
	__sk_dst_set(sk, dst);
E
Eric Dumazet 已提交
1793
	spin_unlock(&sk->sk_dst_lock);
L
Linus Torvalds 已提交
1794 1795 1796 1797 1798
}

static inline void
__sk_dst_reset(struct sock *sk)
{
E
Eric Dumazet 已提交
1799
	__sk_dst_set(sk, NULL);
L
Linus Torvalds 已提交
1800 1801 1802 1803 1804
}

static inline void
sk_dst_reset(struct sock *sk)
{
E
Eric Dumazet 已提交
1805
	spin_lock(&sk->sk_dst_lock);
L
Linus Torvalds 已提交
1806
	__sk_dst_reset(sk);
E
Eric Dumazet 已提交
1807
	spin_unlock(&sk->sk_dst_lock);
L
Linus Torvalds 已提交
1808 1809
}

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

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

E
Eric Dumazet 已提交
1814
static inline bool sk_can_gso(const struct sock *sk)
1815 1816 1817 1818
{
	return net_gso_ok(sk->sk_route_caps, sk->sk_gso_type);
}

1819
void sk_setup_caps(struct sock *sk, struct dst_entry *dst);
1820

1821
static inline void sk_nocaps_add(struct sock *sk, netdev_features_t flags)
E
Eric Dumazet 已提交
1822 1823 1824 1825 1826
{
	sk->sk_route_nocaps |= flags;
	sk->sk_route_caps &= ~flags;
}

1827 1828
static inline int skb_do_copy_data_nocache(struct sock *sk, struct sk_buff *skb,
					   char __user *from, char *to,
1829
					   int copy, int offset)
1830 1831 1832 1833 1834 1835
{
	if (skb->ip_summed == CHECKSUM_NONE) {
		int err = 0;
		__wsum csum = csum_and_copy_from_user(from, to, copy, 0, &err);
		if (err)
			return err;
1836
		skb->csum = csum_block_add(skb->csum, csum, offset);
1837 1838 1839 1840 1841 1842 1843 1844 1845 1846 1847 1848 1849
	} else if (sk->sk_route_caps & NETIF_F_NOCACHE_COPY) {
		if (!access_ok(VERIFY_READ, from, copy) ||
		    __copy_from_user_nocache(to, from, copy))
			return -EFAULT;
	} else if (copy_from_user(to, from, copy))
		return -EFAULT;

	return 0;
}

static inline int skb_add_data_nocache(struct sock *sk, struct sk_buff *skb,
				       char __user *from, int copy)
{
1850
	int err, offset = skb->len;
1851

1852 1853
	err = skb_do_copy_data_nocache(sk, skb, from, skb_put(skb, copy),
				       copy, offset);
1854
	if (err)
1855
		__skb_trim(skb, offset);
1856 1857 1858 1859 1860 1861 1862 1863 1864 1865 1866

	return err;
}

static inline int skb_copy_to_page_nocache(struct sock *sk, char __user *from,
					   struct sk_buff *skb,
					   struct page *page,
					   int off, int copy)
{
	int err;

1867 1868
	err = skb_do_copy_data_nocache(sk, skb, from, page_address(page) + off,
				       copy, skb->len);
1869 1870 1871 1872 1873 1874 1875 1876 1877 1878 1879
	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;
}

L
Linus Torvalds 已提交
1880 1881 1882 1883 1884 1885
static inline int skb_copy_to_page(struct sock *sk, char __user *from,
				   struct sk_buff *skb, struct page *page,
				   int off, int copy)
{
	if (skb->ip_summed == CHECKSUM_NONE) {
		int err = 0;
1886
		__wsum csum = csum_and_copy_from_user(from,
L
Linus Torvalds 已提交
1887 1888 1889 1890 1891 1892 1893 1894 1895 1896 1897 1898
						     page_address(page) + off,
							    copy, 0, &err);
		if (err)
			return err;
		skb->csum = csum_block_add(skb->csum, csum, skb->len);
	} else if (copy_from_user(page_address(page) + off, from, copy))
		return -EFAULT;

	skb->len	     += copy;
	skb->data_len	     += copy;
	skb->truesize	     += copy;
	sk->sk_wmem_queued   += copy;
1899
	sk_mem_charge(sk, copy);
L
Linus Torvalds 已提交
1900 1901 1902
	return 0;
}

1903 1904 1905 1906 1907 1908 1909 1910 1911 1912 1913 1914 1915 1916 1917 1918 1919 1920 1921 1922 1923 1924 1925 1926 1927 1928 1929 1930
/**
 * 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 已提交
1931
static inline bool sk_has_allocations(const struct sock *sk)
1932 1933 1934 1935
{
	return sk_wmem_alloc_get(sk) || sk_rmem_alloc_get(sk);
}

1936
/**
1937
 * wq_has_sleeper - check if there are any waiting processes
R
Randy Dunlap 已提交
1938
 * @wq: struct socket_wq
1939
 *
1940
 * Returns true if socket_wq has waiting processes
1941
 *
1942
 * The purpose of the wq_has_sleeper and sock_poll_wait is to wrap the memory
1943 1944 1945 1946 1947 1948 1949 1950 1951 1952 1953 1954
 * 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
 *   ...                 {
1955 1956 1957 1958
 *   schedule               rcu_read_lock();
 *                          wq = rcu_dereference(sk->sk_wq);
 *                          if (wq && waitqueue_active(&wq->wait))
 *                              wake_up_interruptible(&wq->wait)
1959 1960 1961 1962 1963 1964 1965
 *                          ...
 *                       }
 *
 * 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.
1966
 *
1967
 */
1968
static inline bool wq_has_sleeper(struct socket_wq *wq)
1969
{
E
Eric Dumazet 已提交
1970
	/* We need to be sure we are in sync with the
1971 1972 1973 1974
	 * add_wait_queue modifications to the wait queue.
	 *
	 * This memory barrier is paired in the sock_poll_wait.
	 */
1975 1976
	smp_mb();
	return wq && waitqueue_active(&wq->wait);
1977 1978 1979 1980 1981 1982 1983 1984
}

/**
 * sock_poll_wait - place memory barrier behind the poll_wait call.
 * @filp:           file
 * @wait_address:   socket wait queue
 * @p:              poll_table
 *
1985
 * See the comments in the wq_has_sleeper function.
1986 1987 1988 1989
 */
static inline void sock_poll_wait(struct file *filp,
		wait_queue_head_t *wait_address, poll_table *p)
{
1990
	if (!poll_does_not_wait(p) && wait_address) {
1991
		poll_wait(filp, wait_address, p);
E
Eric Dumazet 已提交
1992
		/* We need to be sure we are in sync with the
1993 1994
		 * socket flags modification.
		 *
1995
		 * This memory barrier is paired in the wq_has_sleeper.
E
Eric Dumazet 已提交
1996
		 */
1997 1998 1999 2000
		smp_mb();
	}
}

L
Linus Torvalds 已提交
2001
/*
E
Eric Dumazet 已提交
2002
 *	Queue a received datagram if it will fit. Stream and sequenced
L
Linus Torvalds 已提交
2003 2004 2005
 *	protocols can't normally use this as they need to fit buffers in
 *	and play with them.
 *
E
Eric Dumazet 已提交
2006
 *	Inlined as it's very short and called for pretty much every
L
Linus Torvalds 已提交
2007 2008 2009 2010 2011
 *	packet ever received.
 */

static inline void skb_set_owner_w(struct sk_buff *skb, struct sock *sk)
{
2012
	skb_orphan(skb);
L
Linus Torvalds 已提交
2013 2014
	skb->sk = sk;
	skb->destructor = sock_wfree;
2015 2016 2017 2018 2019
	/*
	 * We used to take a refcount on sk, but following operation
	 * is enough to guarantee sk_free() wont free this sock until
	 * all in-flight packets are completed
	 */
L
Linus Torvalds 已提交
2020 2021 2022 2023 2024
	atomic_add(skb->truesize, &sk->sk_wmem_alloc);
}

static inline void skb_set_owner_r(struct sk_buff *skb, struct sock *sk)
{
2025
	skb_orphan(skb);
L
Linus Torvalds 已提交
2026 2027 2028
	skb->sk = sk;
	skb->destructor = sock_rfree;
	atomic_add(skb->truesize, &sk->sk_rmem_alloc);
2029
	sk_mem_charge(sk, skb->truesize);
L
Linus Torvalds 已提交
2030 2031
}

2032 2033
void sk_reset_timer(struct sock *sk, struct timer_list *timer,
		    unsigned long expires);
L
Linus Torvalds 已提交
2034

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

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

2039
int sock_queue_err_skb(struct sock *sk, struct sk_buff *skb);
L
Linus Torvalds 已提交
2040 2041 2042 2043

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

L
Linus Torvalds 已提交
2045 2046
static inline int sock_error(struct sock *sk)
{
2047 2048 2049 2050
	int err;
	if (likely(!sk->sk_err))
		return 0;
	err = xchg(&sk->sk_err, 0);
L
Linus Torvalds 已提交
2051 2052 2053 2054 2055 2056 2057 2058 2059
	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 已提交
2060
		if (amt < 0)
L
Linus Torvalds 已提交
2061 2062 2063 2064 2065 2066 2067
			amt = 0;
	}
	return amt;
}

static inline void sk_wake_async(struct sock *sk, int how, int band)
{
E
Eric Dumazet 已提交
2068
	if (sock_flag(sk, SOCK_FASYNC))
L
Linus Torvalds 已提交
2069 2070 2071
		sock_wake_async(sk->sk_socket, how, band);
}

2072 2073 2074 2075
/* 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 已提交
2076
 */
2077
#define TCP_SKB_MIN_TRUESIZE	(2048 + SKB_DATA_ALIGN(sizeof(struct sk_buff)))
2078 2079 2080

#define SOCK_MIN_SNDBUF		(TCP_SKB_MIN_TRUESIZE * 2)
#define SOCK_MIN_RCVBUF		 TCP_SKB_MIN_TRUESIZE
L
Linus Torvalds 已提交
2081 2082 2083 2084

static inline void sk_stream_moderate_sndbuf(struct sock *sk)
{
	if (!(sk->sk_userlocks & SOCK_SNDBUF_LOCK)) {
2085
		sk->sk_sndbuf = min(sk->sk_sndbuf, sk->sk_wmem_queued >> 1);
2086
		sk->sk_sndbuf = max_t(u32, sk->sk_sndbuf, SOCK_MIN_SNDBUF);
L
Linus Torvalds 已提交
2087 2088 2089
	}
}

2090
struct sk_buff *sk_stream_alloc_skb(struct sock *sk, int size, gfp_t gfp);
L
Linus Torvalds 已提交
2091

2092 2093 2094 2095 2096 2097 2098 2099
/**
 * 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 已提交
2100
{
2101 2102
	if (sk->sk_allocation & __GFP_WAIT)
		return &current->task_frag;
L
Linus Torvalds 已提交
2103

2104
	return &sk->sk_frag;
L
Linus Torvalds 已提交
2105 2106
}

2107
bool sk_page_frag_refill(struct sock *sk, struct page_frag *pfrag);
2108

L
Linus Torvalds 已提交
2109 2110 2111
/*
 *	Default write policy as shown to user space via poll/select/SIGIO
 */
E
Eric Dumazet 已提交
2112
static inline bool sock_writeable(const struct sock *sk)
L
Linus Torvalds 已提交
2113
{
2114
	return atomic_read(&sk->sk_wmem_alloc) < (sk->sk_sndbuf >> 1);
L
Linus Torvalds 已提交
2115 2116
}

A
Al Viro 已提交
2117
static inline gfp_t gfp_any(void)
L
Linus Torvalds 已提交
2118
{
2119
	return in_softirq() ? GFP_ATOMIC : GFP_KERNEL;
L
Linus Torvalds 已提交
2120 2121
}

E
Eric Dumazet 已提交
2122
static inline long sock_rcvtimeo(const struct sock *sk, bool noblock)
L
Linus Torvalds 已提交
2123 2124 2125 2126
{
	return noblock ? 0 : sk->sk_rcvtimeo;
}

E
Eric Dumazet 已提交
2127
static inline long sock_sndtimeo(const struct sock *sk, bool noblock)
L
Linus Torvalds 已提交
2128 2129 2130 2131 2132 2133 2134 2135 2136 2137 2138 2139 2140 2141 2142 2143 2144
{
	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;
}

2145 2146 2147 2148
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);
2149

E
Eric Dumazet 已提交
2150
static inline void
L
Linus Torvalds 已提交
2151 2152
sock_recv_timestamp(struct msghdr *msg, struct sock *sk, struct sk_buff *skb)
{
2153
	ktime_t kt = skb->tstamp;
2154
	struct skb_shared_hwtstamps *hwtstamps = skb_hwtstamps(skb);
2155

2156 2157 2158 2159 2160 2161 2162 2163 2164 2165 2166 2167 2168 2169 2170 2171 2172
	/*
	 * generate control messages if
	 * - receive time stamping in software requested (SOCK_RCVTSTAMP
	 *   or SOCK_TIMESTAMPING_RX_SOFTWARE)
	 * - software time stamp available and wanted
	 *   (SOCK_TIMESTAMPING_SOFTWARE)
	 * - hardware time stamps available and wanted
	 *   (SOCK_TIMESTAMPING_SYS_HARDWARE or
	 *   SOCK_TIMESTAMPING_RAW_HARDWARE)
	 */
	if (sock_flag(sk, SOCK_RCVTSTAMP) ||
	    sock_flag(sk, SOCK_TIMESTAMPING_RX_SOFTWARE) ||
	    (kt.tv64 && sock_flag(sk, SOCK_TIMESTAMPING_SOFTWARE)) ||
	    (hwtstamps->hwtstamp.tv64 &&
	     sock_flag(sk, SOCK_TIMESTAMPING_RAW_HARDWARE)) ||
	    (hwtstamps->syststamp.tv64 &&
	     sock_flag(sk, SOCK_TIMESTAMPING_SYS_HARDWARE)))
2173 2174
		__sock_recv_timestamp(msg, sk, skb);
	else
2175
		sk->sk_stamp = kt;
2176 2177 2178

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

2181 2182
void __sock_recv_ts_and_drops(struct msghdr *msg, struct sock *sk,
			      struct sk_buff *skb);
2183 2184 2185 2186 2187 2188 2189 2190

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)			| \
			   (1UL << SOCK_RCVTSTAMP)			| \
			   (1UL << SOCK_TIMESTAMPING_RX_SOFTWARE)	| \
			   (1UL << SOCK_TIMESTAMPING_SOFTWARE)		| \
E
Eric Dumazet 已提交
2191
			   (1UL << SOCK_TIMESTAMPING_RAW_HARDWARE)	| \
2192 2193 2194 2195 2196 2197 2198
			   (1UL << SOCK_TIMESTAMPING_SYS_HARDWARE))

	if (sk->sk_flags & FLAGS_TS_OR_DROPS)
		__sock_recv_ts_and_drops(msg, sk, skb);
	else
		sk->sk_stamp = skb->tstamp;
}
2199

2200 2201 2202
/**
 * sock_tx_timestamp - checks whether the outgoing packet is to be time stamped
 * @sk:		socket sending this packet
2203
 * @tx_flags:	filled with instructions for time stamping
2204
 *
2205
 * Currently only depends on SOCK_TIMESTAMPING* flags.
2206
 */
2207
void sock_tx_timestamp(struct sock *sk, __u8 *tx_flags);
2208

L
Linus Torvalds 已提交
2209 2210
/**
 * sk_eat_skb - Release a skb if it is no longer needed
2211 2212
 * @sk: socket to eat this skb from
 * @skb: socket buffer to eat
R
Randy Dunlap 已提交
2213
 * @copied_early: flag indicating whether DMA operations copied this data early
L
Linus Torvalds 已提交
2214 2215 2216 2217
 *
 * This routine must be called with interrupts disabled or with the socket
 * locked so that the sk_buff queue operation is ok.
*/
2218
#ifdef CONFIG_NET_DMA
E
Eric Dumazet 已提交
2219
static inline void sk_eat_skb(struct sock *sk, struct sk_buff *skb, bool copied_early)
2220 2221 2222 2223 2224 2225 2226 2227
{
	__skb_unlink(skb, &sk->sk_receive_queue);
	if (!copied_early)
		__kfree_skb(skb);
	else
		__skb_queue_tail(&sk->sk_async_wait_queue, skb);
}
#else
E
Eric Dumazet 已提交
2228
static inline void sk_eat_skb(struct sock *sk, struct sk_buff *skb, bool copied_early)
L
Linus Torvalds 已提交
2229 2230 2231 2232
{
	__skb_unlink(skb, &sk->sk_receive_queue);
	__kfree_skb(skb);
}
2233
#endif
L
Linus Torvalds 已提交
2234

2235 2236 2237
static inline
struct net *sock_net(const struct sock *sk)
{
E
Eric Dumazet 已提交
2238
	return read_pnet(&sk->sk_net);
2239 2240 2241
}

static inline
2242
void sock_net_set(struct sock *sk, struct net *net)
2243
{
E
Eric Dumazet 已提交
2244
	write_pnet(&sk->sk_net, net);
2245 2246
}

2247 2248
/*
 * Kernel sockets, f.e. rtnl or icmp_socket, are a part of a namespace.
L
Lucas De Marchi 已提交
2249
 * They should not hold a reference to a namespace in order to allow
2250 2251 2252 2253 2254
 * to stop it.
 * Sockets after sk_change_net should be released using sk_release_kernel
 */
static inline void sk_change_net(struct sock *sk, struct net *net)
{
2255
	put_net(sock_net(sk));
2256
	sock_net_set(sk, hold_net(net));
2257 2258
}

2259 2260
static inline struct sock *skb_steal_sock(struct sk_buff *skb)
{
2261
	if (skb->sk) {
2262 2263 2264 2265 2266 2267 2268 2269 2270
		struct sock *sk = skb->sk;

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

2271 2272 2273 2274 2275
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 已提交
2276

E
Eric Dumazet 已提交
2277 2278
/*
 *	Enable debug/info messages
L
Linus Torvalds 已提交
2279
 */
2280 2281 2282
extern int net_msg_warn;
#define NETDEBUG(fmt, args...) \
	do { if (net_msg_warn) printk(fmt,##args); } while (0)
L
Linus Torvalds 已提交
2283

2284 2285
#define LIMIT_NETDEBUG(fmt, args...) \
	do { if (net_msg_warn && net_ratelimit()) printk(fmt,##args); } while(0)
L
Linus Torvalds 已提交
2286 2287 2288 2289

extern __u32 sysctl_wmem_max;
extern __u32 sysctl_rmem_max;

2290 2291
extern int sysctl_optmem_max;

2292 2293 2294
extern __u32 sysctl_wmem_default;
extern __u32 sysctl_rmem_default;

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