sock.h 54.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>
I
Ingo Molnar 已提交
49
#include <linux/lockdep.h>
L
Linus Torvalds 已提交
50 51
#include <linux/netdevice.h>
#include <linux/skbuff.h>	/* struct sk_buff */
A
Al Viro 已提交
52
#include <linux/mm.h>
L
Linus Torvalds 已提交
53
#include <linux/security.h>
54
#include <linux/slab.h>
55
#include <linux/uaccess.h>
56
#include <linux/memcontrol.h>
L
Linus Torvalds 已提交
57 58

#include <linux/filter.h>
59
#include <linux/rculist_nulls.h>
60
#include <linux/poll.h>
L
Linus Torvalds 已提交
61

E
Eric Dumazet 已提交
62
#include <linux/atomic.h>
L
Linus Torvalds 已提交
63 64 65 66 67 68 69 70 71 72 73 74 75 76 77
#include <net/dst.h>
#include <net/checksum.h>

/*
 * 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
78
/* Validate arguments and do nothing */
79 80
static inline __printf(2, 3)
void SOCK_DEBUG(struct sock *sk, const char *msg, ...)
81 82
{
}
L
Linus Torvalds 已提交
83 84 85 86 87 88 89 90
#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;
91
	int			owned;
L
Linus Torvalds 已提交
92
	wait_queue_head_t	wq;
I
Ingo Molnar 已提交
93 94 95 96 97 98 99 100 101
	/*
	 * 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 已提交
102 103 104
} socket_lock_t;

struct sock;
105
struct proto;
106
struct net;
L
Linus Torvalds 已提交
107 108

/**
109
 *	struct sock_common - minimal network layer representation of sockets
110 111
 *	@skc_daddr: Foreign IPv4 addr
 *	@skc_rcv_saddr: Bound local IPv4 addr
E
Eric Dumazet 已提交
112
 *	@skc_hash: hash value used with various protocol lookup tables
113
 *	@skc_u16hashes: two u16 hash values used by UDP lookup tables
114 115 116 117 118
 *	@skc_family: network address family
 *	@skc_state: Connection state
 *	@skc_reuse: %SO_REUSEADDR setting
 *	@skc_bound_dev_if: bound device index if != 0
 *	@skc_bind_node: bind hash linkage for various protocol lookup tables
119
 *	@skc_portaddr_node: second hash linkage for UDP/UDP-Lite protocol
120
 *	@skc_prot: protocol handlers inside a network family
121
 *	@skc_net: reference to the network namespace of this socket
122 123 124 125
 *	@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
126 127
 *
 *	This is the minimal network layer representation of sockets, the header
128 129
 *	for struct sock and struct inet_timewait_sock.
 */
L
Linus Torvalds 已提交
130
struct sock_common {
131 132
	/* skc_daddr and skc_rcv_saddr must be grouped :
	 * cf INET_MATCH() and INET_TW_MATCH()
E
Eric Dumazet 已提交
133
	 */
134 135
	__be32			skc_daddr;
	__be32			skc_rcv_saddr;
E
Eric Dumazet 已提交
136

137 138 139 140
	union  {
		unsigned int	skc_hash;
		__u16		skc_u16hashes[2];
	};
E
Eric Dumazet 已提交
141 142 143 144
	unsigned short		skc_family;
	volatile unsigned char	skc_state;
	unsigned char		skc_reuse;
	int			skc_bound_dev_if;
145 146 147 148
	union {
		struct hlist_node	skc_bind_node;
		struct hlist_nulls_node skc_portaddr_node;
	};
149
	struct proto		*skc_prot;
150
#ifdef CONFIG_NET_NS
151
	struct net	 	*skc_net;
152
#endif
153 154 155 156
	/*
	 * fields between dontcopy_begin/dontcopy_end
	 * are not copied in sock_copy()
	 */
157
	/* private: */
158
	int			skc_dontcopy_begin[0];
159
	/* public: */
160 161 162 163 164 165
	union {
		struct hlist_node	skc_node;
		struct hlist_nulls_node skc_nulls_node;
	};
	int			skc_tx_queue_mapping;
	atomic_t		skc_refcnt;
166
	/* private: */
167
	int                     skc_dontcopy_end[0];
168
	/* public: */
L
Linus Torvalds 已提交
169 170 171 172
};

/**
  *	struct sock - network layer representation of sockets
173
  *	@__sk_common: shared layout with inet_timewait_sock
174 175 176 177
  *	@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
178
  *	@sk_wq: sock wait queue and async head
179 180 181 182 183 184
  *	@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
185
  *	@sk_async_wait_queue: DMA copied packets
186 187 188 189 190
  *	@sk_omem_alloc: "o" is "option" or "other"
  *	@sk_wmem_queued: persistent queue size
  *	@sk_forward_alloc: space allocated forward
  *	@sk_allocation: allocation mode
  *	@sk_sndbuf: size of send buffer in bytes
W
Wang Chen 已提交
191
  *	@sk_flags: %SO_LINGER (l_onoff), %SO_BROADCAST, %SO_KEEPALIVE,
192
  *		   %SO_OOBINLINE settings, %SO_TIMESTAMPING settings
193 194
  *	@sk_no_check: %SO_NO_CHECK setting, wether or not checkup packets
  *	@sk_route_caps: route capabilities (e.g. %NETIF_F_TSO)
E
Eric Dumazet 已提交
195
  *	@sk_route_nocaps: forbidden route capabilities (e.g NETIF_F_GSO_MASK)
196
  *	@sk_gso_type: GSO type (e.g. %SKB_GSO_TCPV4)
197
  *	@sk_gso_max_size: Maximum GSO segment size to build
198 199 200 201
  *	@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 已提交
202 203
  *	@sk_prot_creator: sk_prot of original sock creator (see ipv6_setsockopt,
  *			  IPV6_ADDRFORM for instance)
204
  *	@sk_err: last error
W
Wang Chen 已提交
205 206
  *	@sk_err_soft: errors that don't cause failure but are the cause of a
  *		      persistent failure not just 'timed out'
E
Eric Dumazet 已提交
207
  *	@sk_drops: raw/udp drops counter
208 209 210 211 212
  *	@sk_ack_backlog: current listen backlog
  *	@sk_max_ack_backlog: listen backlog set in listen()
  *	@sk_priority: %SO_PRIORITY setting
  *	@sk_type: socket type (%SOCK_STREAM, etc)
  *	@sk_protocol: which protocol this socket belongs in this network family
213 214
  *	@sk_peer_pid: &struct pid for this socket's peer
  *	@sk_peer_cred: %SO_PEERCRED setting
215 216 217
  *	@sk_rcvlowat: %SO_RCVLOWAT setting
  *	@sk_rcvtimeo: %SO_RCVTIMEO setting
  *	@sk_sndtimeo: %SO_SNDTIMEO setting
218
  *	@sk_rxhash: flow hash received from netif layer
219 220 221 222 223 224 225 226 227
  *	@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
  *	@sk_sndmsg_page: cached page for sendmsg
  *	@sk_sndmsg_off: cached offset for sendmsg
  *	@sk_send_head: front of stuff to transmit
228
  *	@sk_security: used by security modules
229
  *	@sk_mark: generic packet mark
230
  *	@sk_classid: this socket's cgroup classid
231 232 233 234 235 236 237
  *	@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 已提交
238 239 240
 */
struct sock {
	/*
241
	 * Now struct inet_timewait_sock also uses sock_common, so please just
L
Linus Torvalds 已提交
242 243 244
	 * don't add nothing before this first member (__sk_common) --acme
	 */
	struct sock_common	__sk_common;
E
Eric Dumazet 已提交
245 246 247
#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 已提交
248
#define sk_tx_queue_mapping	__sk_common.skc_tx_queue_mapping
E
Eric Dumazet 已提交
249

250 251
#define sk_dontcopy_begin	__sk_common.skc_dontcopy_begin
#define sk_dontcopy_end		__sk_common.skc_dontcopy_end
E
Eric Dumazet 已提交
252
#define sk_hash			__sk_common.skc_hash
L
Linus Torvalds 已提交
253 254 255 256 257
#define sk_family		__sk_common.skc_family
#define sk_state		__sk_common.skc_state
#define sk_reuse		__sk_common.skc_reuse
#define sk_bound_dev_if		__sk_common.skc_bound_dev_if
#define sk_bind_node		__sk_common.skc_bind_node
258
#define sk_prot			__sk_common.skc_prot
259
#define sk_net			__sk_common.skc_net
L
Linus Torvalds 已提交
260
	socket_lock_t		sk_lock;
E
Eric Dumazet 已提交
261
	struct sk_buff_head	sk_receive_queue;
262 263 264 265
	/*
	 * 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 已提交
266 267 268
	 * Note : rmem_alloc is in this structure to fill a hole
	 * on 64bit arches, not because its logically part of
	 * backlog.
269 270
	 */
	struct {
E
Eric Dumazet 已提交
271 272 273 274
		atomic_t	rmem_alloc;
		int		len;
		struct sk_buff	*head;
		struct sk_buff	*tail;
275
	} sk_backlog;
E
Eric Dumazet 已提交
276 277 278 279 280 281 282 283 284
#define sk_rmem_alloc sk_backlog.rmem_alloc
	int			sk_forward_alloc;
#ifdef CONFIG_RPS
	__u32			sk_rxhash;
#endif
	atomic_t		sk_drops;
	int			sk_rcvbuf;

	struct sk_filter __rcu	*sk_filter;
285
	struct socket_wq __rcu	*sk_wq;
E
Eric Dumazet 已提交
286 287 288 289 290

#ifdef CONFIG_NET_DMA
	struct sk_buff_head	sk_async_wait_queue;
#endif

291
#ifdef CONFIG_XFRM
L
Linus Torvalds 已提交
292
	struct xfrm_policy	*sk_policy[2];
293
#endif
E
Eric Dumazet 已提交
294 295
	unsigned long 		sk_flags;
	struct dst_entry	*sk_dst_cache;
E
Eric Dumazet 已提交
296
	spinlock_t		sk_dst_lock;
L
Linus Torvalds 已提交
297 298
	atomic_t		sk_wmem_alloc;
	atomic_t		sk_omem_alloc;
299
	int			sk_sndbuf;
L
Linus Torvalds 已提交
300
	struct sk_buff_head	sk_write_queue;
E
Eric Dumazet 已提交
301 302 303 304 305 306 307
	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 已提交
308
	int			sk_wmem_queued;
A
Al Viro 已提交
309
	gfp_t			sk_allocation;
310 311
	netdev_features_t	sk_route_caps;
	netdev_features_t	sk_route_nocaps;
312
	int			sk_gso_type;
313
	unsigned int		sk_gso_max_size;
314
	int			sk_rcvlowat;
L
Linus Torvalds 已提交
315 316
	unsigned long	        sk_lingertime;
	struct sk_buff_head	sk_error_queue;
317
	struct proto		*sk_prot_creator;
L
Linus Torvalds 已提交
318 319 320 321 322 323
	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;
324 325 326
#ifdef CONFIG_CGROUPS
	__u32			sk_cgrp_prioidx;
#endif
327 328
	struct pid		*sk_peer_pid;
	const struct cred	*sk_peer_cred;
L
Linus Torvalds 已提交
329 330 331 332
	long			sk_rcvtimeo;
	long			sk_sndtimeo;
	void			*sk_protinfo;
	struct timer_list	sk_timer;
333
	ktime_t			sk_stamp;
L
Linus Torvalds 已提交
334 335 336 337 338 339
	struct socket		*sk_socket;
	void			*sk_user_data;
	struct page		*sk_sndmsg_page;
	struct sk_buff		*sk_send_head;
	__u32			sk_sndmsg_off;
	int			sk_write_pending;
A
Alexey Dobriyan 已提交
340
#ifdef CONFIG_SECURITY
L
Linus Torvalds 已提交
341
	void			*sk_security;
A
Alexey Dobriyan 已提交
342
#endif
343
	__u32			sk_mark;
344
	u32			sk_classid;
L
Linus Torvalds 已提交
345 346 347 348 349 350 351 352 353 354 355 356
	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);
  	int			(*sk_backlog_rcv)(struct sock *sk,
						  struct sk_buff *skb);  
	void                    (*sk_destruct)(struct sock *sk);
};

/*
 * Hashed lists helper routines
 */
L
Li Zefan 已提交
357 358 359 360 361
static inline struct sock *sk_entry(const struct hlist_node *node)
{
	return hlist_entry(node, struct sock, sk_node);
}

362
static inline struct sock *__sk_head(const struct hlist_head *head)
L
Linus Torvalds 已提交
363 364 365 366
{
	return hlist_entry(head->first, struct sock, sk_node);
}

367
static inline struct sock *sk_head(const struct hlist_head *head)
L
Linus Torvalds 已提交
368 369 370 371
{
	return hlist_empty(head) ? NULL : __sk_head(head);
}

372 373 374 375 376 377 378 379 380 381
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);
}

382
static inline struct sock *sk_next(const struct sock *sk)
L
Linus Torvalds 已提交
383 384 385 386 387
{
	return sk->sk_node.next ?
		hlist_entry(sk->sk_node.next, struct sock, sk_node) : NULL;
}

388 389 390 391 392 393 394 395
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;
}

396
static inline int sk_unhashed(const struct sock *sk)
L
Linus Torvalds 已提交
397 398 399 400
{
	return hlist_unhashed(&sk->sk_node);
}

401
static inline int sk_hashed(const struct sock *sk)
L
Linus Torvalds 已提交
402
{
A
Akinobu Mita 已提交
403
	return !sk_unhashed(sk);
L
Linus Torvalds 已提交
404 405 406 407 408 409 410
}

static __inline__ void sk_node_init(struct hlist_node *node)
{
	node->pprev = NULL;
}

411 412 413 414 415
static __inline__ void sk_nulls_node_init(struct hlist_nulls_node *node)
{
	node->pprev = NULL;
}

L
Linus Torvalds 已提交
416 417 418 419 420
static __inline__ void __sk_del_node(struct sock *sk)
{
	__hlist_del(&sk->sk_node);
}

421
/* NB: equivalent to hlist_del_init_rcu */
L
Linus Torvalds 已提交
422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461
static __inline__ int __sk_del_node_init(struct sock *sk)
{
	if (sk_hashed(sk)) {
		__sk_del_node(sk);
		sk_node_init(&sk->sk_node);
		return 1;
	}
	return 0;
}

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

static __inline__ int sk_del_node_init(struct sock *sk)
{
	int rc = __sk_del_node_init(sk);

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

464
static __inline__ int __sk_nulls_del_node_init_rcu(struct sock *sk)
465 466
{
	if (sk_hashed(sk)) {
467
		hlist_nulls_del_init_rcu(&sk->sk_nulls_node);
468 469 470 471 472
		return 1;
	}
	return 0;
}

473
static __inline__ int sk_nulls_del_node_init_rcu(struct sock *sk)
474
{
475
	int rc = __sk_nulls_del_node_init_rcu(sk);
476 477 478 479 480 481 482 483 484

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

L
Linus Torvalds 已提交
485 486 487 488 489 490 491 492 493 494 495
static __inline__ void __sk_add_node(struct sock *sk, struct hlist_head *list)
{
	hlist_add_head(&sk->sk_node, list);
}

static __inline__ void sk_add_node(struct sock *sk, struct hlist_head *list)
{
	sock_hold(sk);
	__sk_add_node(sk, list);
}

496 497 498 499 500 501
static __inline__ void sk_add_node_rcu(struct sock *sk, struct hlist_head *list)
{
	sock_hold(sk);
	hlist_add_head_rcu(&sk->sk_node, list);
}

502
static __inline__ void __sk_nulls_add_node_rcu(struct sock *sk, struct hlist_nulls_head *list)
503
{
504
	hlist_nulls_add_head_rcu(&sk->sk_nulls_node, list);
505 506
}

507
static __inline__ void sk_nulls_add_node_rcu(struct sock *sk, struct hlist_nulls_head *list)
508 509
{
	sock_hold(sk);
510
	__sk_nulls_add_node_rcu(sk, list);
511 512
}

L
Linus Torvalds 已提交
513 514 515 516 517 518 519 520 521 522 523 524 525
static __inline__ void __sk_del_bind_node(struct sock *sk)
{
	__hlist_del(&sk->sk_bind_node);
}

static __inline__ void sk_add_bind_node(struct sock *sk,
					struct hlist_head *list)
{
	hlist_add_head(&sk->sk_bind_node, list);
}

#define sk_for_each(__sk, node, list) \
	hlist_for_each_entry(__sk, node, list, sk_node)
526 527
#define sk_for_each_rcu(__sk, node, list) \
	hlist_for_each_entry_rcu(__sk, node, list, sk_node)
528 529 530 531
#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)
L
Linus Torvalds 已提交
532 533 534
#define sk_for_each_from(__sk, node) \
	if (__sk && ({ node = &(__sk)->sk_node; 1; })) \
		hlist_for_each_entry_from(__sk, node, sk_node)
535 536 537
#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)
L
Linus Torvalds 已提交
538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556
#define sk_for_each_safe(__sk, node, tmp, list) \
	hlist_for_each_entry_safe(__sk, node, tmp, list, sk_node)
#define sk_for_each_bound(__sk, node, list) \
	hlist_for_each_entry(__sk, node, list, sk_bind_node)

/* 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 */
557
	SOCK_RCVTSTAMPNS, /* %SO_TIMESTAMPNS setting */
L
Linus Torvalds 已提交
558 559
	SOCK_LOCALROUTE, /* route locally only, %SO_DONTROUTE setting */
	SOCK_QUEUE_SHRUNK, /* write queue has been shrunk recently */
560 561 562 563 564 565 566
	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 已提交
567
	SOCK_FASYNC, /* fasync() active */
568
	SOCK_RXQ_OVFL,
569
	SOCK_ZEROCOPY, /* buffers from userspace */
570
	SOCK_WIFI_STATUS, /* push wifi status to userspace */
L
Linus Torvalds 已提交
571 572
};

R
Ralf Baechle 已提交
573 574 575 576 577
static inline void sock_copy_flags(struct sock *nsk, struct sock *osk)
{
	nsk->sk_flags = osk->sk_flags;
}

L
Linus Torvalds 已提交
578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604
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);
}

static inline int sock_flag(struct sock *sk, enum sock_flags flag)
{
	return test_bit(flag, &sk->sk_flags);
}

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

static inline int sk_acceptq_is_full(struct sock *sk)
{
605
	return sk->sk_ack_backlog > sk->sk_max_ack_backlog;
L
Linus Torvalds 已提交
606 607 608 609 610 611 612
}

/*
 * Compute minimal free write space needed to queue new packets.
 */
static inline int sk_stream_min_wspace(struct sock *sk)
{
613
	return sk->sk_wmem_queued >> 1;
L
Linus Torvalds 已提交
614 615 616 617 618 619 620 621 622 623 624 625 626 627
}

static inline int sk_stream_wspace(struct sock *sk)
{
	return sk->sk_sndbuf - sk->sk_wmem_queued;
}

extern void sk_stream_write_space(struct sock *sk);

static inline int sk_stream_memory_free(struct sock *sk)
{
	return sk->sk_wmem_queued < sk->sk_sndbuf;
}

Z
Zhu Yi 已提交
628
/* OOB backlog add */
Z
Zhu Yi 已提交
629
static inline void __sk_add_backlog(struct sock *sk, struct sk_buff *skb)
630
{
E
Eric Dumazet 已提交
631 632 633 634 635 636
	/* 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
637
		sk->sk_backlog.tail->next = skb;
E
Eric Dumazet 已提交
638 639

	sk->sk_backlog.tail = skb;
640 641
	skb->next = NULL;
}
L
Linus Torvalds 已提交
642

643 644 645 646 647 648 649 650 651 652
/*
 * Take into account size of receive queue and backlog queue
 */
static inline bool sk_rcvqueues_full(const struct sock *sk, const struct sk_buff *skb)
{
	unsigned int qsize = sk->sk_backlog.len + atomic_read(&sk->sk_rmem_alloc);

	return qsize + skb->truesize > sk->sk_rcvbuf;
}

Z
Zhu Yi 已提交
653
/* The per-socket spinlock must be held here. */
Z
Zhu Yi 已提交
654
static inline __must_check int sk_add_backlog(struct sock *sk, struct sk_buff *skb)
Z
Zhu Yi 已提交
655
{
656
	if (sk_rcvqueues_full(sk, skb))
Z
Zhu Yi 已提交
657 658
		return -ENOBUFS;

Z
Zhu Yi 已提交
659
	__sk_add_backlog(sk, skb);
Z
Zhu Yi 已提交
660 661 662 663
	sk->sk_backlog.len += skb->truesize;
	return 0;
}

P
Peter Zijlstra 已提交
664 665 666 667 668
static inline int sk_backlog_rcv(struct sock *sk, struct sk_buff *skb)
{
	return sk->sk_backlog_rcv(sk, skb);
}

669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692
static inline void sock_rps_record_flow(const struct sock *sk)
{
#ifdef CONFIG_RPS
	struct rps_sock_flow_table *sock_flow_table;

	rcu_read_lock();
	sock_flow_table = rcu_dereference(rps_sock_flow_table);
	rps_record_sock_flow(sock_flow_table, sk->sk_rxhash);
	rcu_read_unlock();
#endif
}

static inline void sock_rps_reset_flow(const struct sock *sk)
{
#ifdef CONFIG_RPS
	struct rps_sock_flow_table *sock_flow_table;

	rcu_read_lock();
	sock_flow_table = rcu_dereference(rps_sock_flow_table);
	rps_reset_sock_flow(sock_flow_table, sk->sk_rxhash);
	rcu_read_unlock();
#endif
}

693 694
static inline void sock_rps_save_rxhash(struct sock *sk,
					const struct sk_buff *skb)
695 696
{
#ifdef CONFIG_RPS
697
	if (unlikely(sk->sk_rxhash != skb->rxhash)) {
698
		sock_rps_reset_flow(sk);
699
		sk->sk_rxhash = skb->rxhash;
700 701 702 703
	}
#endif
}

704 705 706 707 708 709 710 711
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 已提交
712 713 714 715 716 717 718 719 720 721 722
#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 已提交
723 724 725 726 727 728 729 730 731

extern int sk_stream_wait_connect(struct sock *sk, long *timeo_p);
extern int sk_stream_wait_memory(struct sock *sk, long *timeo_p);
extern void sk_stream_wait_close(struct sock *sk, long timeo_p);
extern int sk_stream_error(struct sock *sk, int flags, int err);
extern void sk_stream_kill_queues(struct sock *sk);

extern int sk_wait_data(struct sock *sk, long *timeo);

732
struct request_sock_ops;
733
struct timewait_sock_ops;
734
struct inet_hashinfo;
735
struct raw_hashinfo;
736
struct module;
737

L
Linus Torvalds 已提交
738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754
/* Networking protocol blocks we attach to sockets.
 * socket layer -> transport layer interface
 * transport -> network interface is defined by struct inet_proto
 */
struct proto {
	void			(*close)(struct sock *sk, 
					long timeout);
	int			(*connect)(struct sock *sk,
				        struct sockaddr *uaddr, 
					int addr_len);
	int			(*disconnect)(struct sock *sk, int flags);

	struct sock *		(*accept) (struct sock *sk, int flags, int *err);

	int			(*ioctl)(struct sock *sk, int cmd,
					 unsigned long arg);
	int			(*init)(struct sock *sk);
755
	void			(*destroy)(struct sock *sk);
L
Linus Torvalds 已提交
756 757 758
	void			(*shutdown)(struct sock *sk, int how);
	int			(*setsockopt)(struct sock *sk, int level, 
					int optname, char __user *optval,
759
					unsigned int optlen);
L
Linus Torvalds 已提交
760 761 762
	int			(*getsockopt)(struct sock *sk, int level, 
					int optname, char __user *optval, 
					int __user *option);  	 
A
Alexey Dobriyan 已提交
763
#ifdef CONFIG_COMPAT
764 765 766
	int			(*compat_setsockopt)(struct sock *sk,
					int level,
					int optname, char __user *optval,
767
					unsigned int optlen);
768 769 770 771
	int			(*compat_getsockopt)(struct sock *sk,
					int level,
					int optname, char __user *optval,
					int __user *option);
772 773
	int			(*compat_ioctl)(struct sock *sk,
					unsigned int cmd, unsigned long arg);
A
Alexey Dobriyan 已提交
774
#endif
L
Linus Torvalds 已提交
775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791
	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,
					size_t len, int noblock, int flags, 
					int *addr_len);
	int			(*sendpage)(struct sock *sk, struct page *page,
					int offset, size_t size, int flags);
	int			(*bind)(struct sock *sk, 
					struct sockaddr *uaddr, int addr_len);

	int			(*backlog_rcv) (struct sock *sk, 
						struct sk_buff *skb);

	/* 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 已提交
792
	void			(*rehash)(struct sock *sk);
L
Linus Torvalds 已提交
793
	int			(*get_port)(struct sock *sk, unsigned short snum);
794
	void			(*clear_sk)(struct sock *sk, int size);
L
Linus Torvalds 已提交
795

796
	/* Keeping track of sockets in use */
797
#ifdef CONFIG_PROC_FS
798
	unsigned int		inuse_idx;
799
#endif
800

L
Linus Torvalds 已提交
801
	/* Memory pressure */
802
	void			(*enter_memory_pressure)(struct sock *sk);
E
Eric Dumazet 已提交
803
	atomic_long_t		*memory_allocated;	/* Current allocated memory. */
804
	struct percpu_counter	*sockets_allocated;	/* Current number of sockets. */
L
Linus Torvalds 已提交
805 806 807
	/*
	 * Pressure flag: try to collapse.
	 * Technical note: it is used by multiple contexts non atomically.
808
	 * All the __sk_mem_schedule() is of this nature: accounting
L
Linus Torvalds 已提交
809 810 811
	 * is strict, actions are advisory and have some latency.
	 */
	int			*memory_pressure;
E
Eric Dumazet 已提交
812
	long			*sysctl_mem;
L
Linus Torvalds 已提交
813 814 815
	int			*sysctl_wmem;
	int			*sysctl_rmem;
	int			max_header;
816
	bool			no_autobind;
L
Linus Torvalds 已提交
817

818
	struct kmem_cache	*slab;
L
Linus Torvalds 已提交
819
	unsigned int		obj_size;
820
	int			slab_flags;
L
Linus Torvalds 已提交
821

822
	struct percpu_counter	*orphan_count;
823

824
	struct request_sock_ops	*rsk_prot;
825
	struct timewait_sock_ops *twsk_prot;
826

827 828
	union {
		struct inet_hashinfo	*hashinfo;
829
		struct udp_table	*udp_table;
830
		struct raw_hashinfo	*raw_hash;
831
	} h;
832

L
Linus Torvalds 已提交
833 834 835 836 837
	struct module		*owner;

	char			name[32];

	struct list_head	node;
838 839 840
#ifdef SOCK_REFCNT_DEBUG
	atomic_t		socks;
#endif
L
Linus Torvalds 已提交
841 842 843 844 845
};

extern int proto_register(struct proto *prot, int alloc_slab);
extern void proto_unregister(struct proto *prot);

846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870
#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));
}

static inline void sk_refcnt_debug_release(const struct sock *sk)
{
	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 */

871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963
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;
	return !!*sk->sk_prot->memory_pressure;
}

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

	if (memory_pressure && *memory_pressure)
		*memory_pressure = 0;
}

static inline void sk_enter_memory_pressure(struct sock *sk)
{
	if (sk->sk_prot->enter_memory_pressure)
		sk->sk_prot->enter_memory_pressure(sk);
}

static inline long sk_prot_mem_limits(const struct sock *sk, int index)
{
	long *prot = sk->sk_prot->sysctl_mem;
	return prot[index];
}

static inline long
sk_memory_allocated(const struct sock *sk)
{
	struct proto *prot = sk->sk_prot;
	return atomic_long_read(prot->memory_allocated);
}

static inline long
sk_memory_allocated_add(struct sock *sk, int amt)
{
	struct proto *prot = sk->sk_prot;
	return atomic_long_add_return(amt, prot->memory_allocated);
}

static inline void
sk_memory_allocated_sub(struct sock *sk, int amt)
{
	struct proto *prot = sk->sk_prot;
	atomic_long_sub(amt, prot->memory_allocated);
}

static inline void sk_sockets_allocated_dec(struct sock *sk)
{
	struct proto *prot = sk->sk_prot;
	percpu_counter_dec(prot->sockets_allocated);
}

static inline void sk_sockets_allocated_inc(struct sock *sk)
{
	struct proto *prot = sk->sk_prot;
	percpu_counter_inc(prot->sockets_allocated);
}

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

	return percpu_counter_sum_positive(prot->sockets_allocated);
}

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

964 965

#ifdef CONFIG_PROC_FS
L
Linus Torvalds 已提交
966
/* Called with local bh disabled */
967 968
extern void sock_prot_inuse_add(struct net *net, struct proto *prot, int inc);
extern int sock_prot_inuse_get(struct net *net, struct proto *proto);
969
#else
970 971
static void inline sock_prot_inuse_add(struct net *net, struct proto *prot,
		int inc)
972 973 974 975
{
}
#endif

L
Linus Torvalds 已提交
976

977 978 979 980 981 982 983 984 985
/* 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);
}

986 987
void sk_prot_clear_portaddr_nulls(struct sock *sk, int size);

L
Linus Torvalds 已提交
988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040
/* 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;
}

1041 1042 1043 1044 1045
/*
 * Functions for memory accounting
 */
extern int __sk_mem_schedule(struct sock *sk, int size, int kind);
extern void __sk_mem_reclaim(struct sock *sk);
L
Linus Torvalds 已提交
1046

1047 1048 1049 1050
#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 已提交
1051

1052
static inline int sk_mem_pages(int amt)
L
Linus Torvalds 已提交
1053
{
1054
	return (amt + SK_MEM_QUANTUM - 1) >> SK_MEM_QUANTUM_SHIFT;
L
Linus Torvalds 已提交
1055 1056
}

1057
static inline int sk_has_account(struct sock *sk)
L
Linus Torvalds 已提交
1058
{
1059 1060
	/* return true if protocol supports memory accounting */
	return !!sk->sk_prot->memory_allocated;
L
Linus Torvalds 已提交
1061 1062
}

1063
static inline int sk_wmem_schedule(struct sock *sk, int size)
L
Linus Torvalds 已提交
1064
{
1065 1066 1067 1068
	if (!sk_has_account(sk))
		return 1;
	return size <= sk->sk_forward_alloc ||
		__sk_mem_schedule(sk, size, SK_MEM_SEND);
L
Linus Torvalds 已提交
1069 1070
}

1071
static inline int sk_rmem_schedule(struct sock *sk, int size)
H
Herbert Xu 已提交
1072
{
1073 1074
	if (!sk_has_account(sk))
		return 1;
H
Herbert Xu 已提交
1075
	return size <= sk->sk_forward_alloc ||
1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086
		__sk_mem_schedule(sk, size, SK_MEM_RECV);
}

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

1087 1088 1089 1090 1091 1092 1093 1094
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);
}

1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114
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 已提交
1115 1116
}

L
Linus Torvalds 已提交
1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129
/* 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.
 */
1130
#define sock_owned_by_user(sk)	((sk)->sk_lock.owned)
L
Linus Torvalds 已提交
1131

1132 1133 1134 1135 1136 1137 1138 1139 1140
/*
 * 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.
 */
#define sock_lock_init_class_and_name(sk, sname, skey, name, key) 	\
do {									\
1141
	sk->sk_lock.owned = 0;						\
1142 1143 1144 1145 1146 1147 1148 1149 1150
	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,		\
		       	(skey), (sname));				\
	lockdep_init_map(&(sk)->sk_lock.dep_map, (name), (key), 0);	\
} while (0)

H
Harvey Harrison 已提交
1151
extern void lock_sock_nested(struct sock *sk, int subclass);
1152 1153 1154 1155 1156 1157

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

H
Harvey Harrison 已提交
1158
extern void release_sock(struct sock *sk);
L
Linus Torvalds 已提交
1159 1160 1161

/* BH context may only use the following locking interface. */
#define bh_lock_sock(__sk)	spin_lock(&((__sk)->sk_lock.slock))
1162 1163 1164
#define bh_lock_sock_nested(__sk) \
				spin_lock_nested(&((__sk)->sk_lock.slock), \
				SINGLE_DEPTH_NESTING)
L
Linus Torvalds 已提交
1165 1166
#define bh_unlock_sock(__sk)	spin_unlock(&((__sk)->sk_lock.slock))

1167 1168 1169 1170 1171 1172 1173 1174 1175 1176
extern bool lock_sock_fast(struct sock *sk);
/**
 * 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 已提交
1177
{
1178 1179 1180 1181
	if (slow)
		release_sock(sk);
	else
		spin_unlock_bh(&sk->sk_lock.slock);
E
Eric Dumazet 已提交
1182 1183 1184
}


1185
extern struct sock		*sk_alloc(struct net *net, int family,
A
Al Viro 已提交
1186
					  gfp_t priority,
1187
					  struct proto *prot);
L
Linus Torvalds 已提交
1188
extern void			sk_free(struct sock *sk);
1189
extern void			sk_release_kernel(struct sock *sk);
1190 1191
extern struct sock		*sk_clone_lock(const struct sock *sk,
					       const gfp_t priority);
L
Linus Torvalds 已提交
1192 1193 1194

extern struct sk_buff		*sock_wmalloc(struct sock *sk,
					      unsigned long size, int force,
A
Al Viro 已提交
1195
					      gfp_t priority);
L
Linus Torvalds 已提交
1196 1197
extern struct sk_buff		*sock_rmalloc(struct sock *sk,
					      unsigned long size, int force,
A
Al Viro 已提交
1198
					      gfp_t priority);
L
Linus Torvalds 已提交
1199 1200 1201 1202 1203
extern void			sock_wfree(struct sk_buff *skb);
extern void			sock_rfree(struct sk_buff *skb);

extern int			sock_setsockopt(struct socket *sock, int level,
						int op, char __user *optval,
1204
						unsigned int optlen);
L
Linus Torvalds 已提交
1205 1206 1207 1208 1209 1210 1211 1212

extern int			sock_getsockopt(struct socket *sock, int level,
						int op, char __user *optval, 
						int __user *optlen);
extern struct sk_buff 		*sock_alloc_send_skb(struct sock *sk,
						     unsigned long size,
						     int noblock,
						     int *errcode);
H
Herbert Xu 已提交
1213 1214 1215 1216 1217
extern struct sk_buff 		*sock_alloc_send_pskb(struct sock *sk,
						      unsigned long header_len,
						      unsigned long data_len,
						      int noblock,
						      int *errcode);
V
Victor Fusco 已提交
1218
extern void *sock_kmalloc(struct sock *sk, int size,
A
Al Viro 已提交
1219
			  gfp_t priority);
L
Linus Torvalds 已提交
1220 1221 1222
extern void sock_kfree_s(struct sock *sk, void *mem, int size);
extern void sk_send_sigurg(struct sock *sk);

1223 1224 1225 1226 1227 1228 1229 1230
#ifdef CONFIG_CGROUPS
extern void sock_update_classid(struct sock *sk);
#else
static inline void sock_update_classid(struct sock *sk)
{
}
#endif

L
Linus Torvalds 已提交
1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253
/*
 * Functions to fill in entries in struct proto_ops when a protocol
 * does not implement a particular function.
 */
extern int                      sock_no_bind(struct socket *, 
					     struct sockaddr *, int);
extern int                      sock_no_connect(struct socket *,
						struct sockaddr *, int, int);
extern int                      sock_no_socketpair(struct socket *,
						   struct socket *);
extern int                      sock_no_accept(struct socket *,
					       struct socket *, int);
extern int                      sock_no_getname(struct socket *,
						struct sockaddr *, int *, int);
extern unsigned int             sock_no_poll(struct file *, struct socket *,
					     struct poll_table_struct *);
extern int                      sock_no_ioctl(struct socket *, unsigned int,
					      unsigned long);
extern int			sock_no_listen(struct socket *, int);
extern int                      sock_no_shutdown(struct socket *, int);
extern int			sock_no_getsockopt(struct socket *, int , int,
						   char __user *, int __user *);
extern int			sock_no_setsockopt(struct socket *, int, int,
1254
						   char __user *, unsigned int);
L
Linus Torvalds 已提交
1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275
extern int                      sock_no_sendmsg(struct kiocb *, struct socket *,
						struct msghdr *, size_t);
extern int                      sock_no_recvmsg(struct kiocb *, struct socket *,
						struct msghdr *, size_t, int);
extern int			sock_no_mmap(struct file *file,
					     struct socket *sock,
					     struct vm_area_struct *vma);
extern ssize_t			sock_no_sendpage(struct socket *sock,
						struct page *page,
						int offset, size_t size, 
						int flags);

/*
 * Functions to fill in entries in struct proto_ops when a protocol
 * uses the inet style.
 */
extern int sock_common_getsockopt(struct socket *sock, int level, int optname,
				  char __user *optval, int __user *optlen);
extern int sock_common_recvmsg(struct kiocb *iocb, struct socket *sock,
			       struct msghdr *msg, size_t size, int flags);
extern int sock_common_setsockopt(struct socket *sock, int level, int optname,
1276
				  char __user *optval, unsigned int optlen);
1277 1278 1279
extern int compat_sock_common_getsockopt(struct socket *sock, int level,
		int optname, char __user *optval, int __user *optlen);
extern int compat_sock_common_setsockopt(struct socket *sock, int level,
1280
		int optname, char __user *optval, unsigned int optlen);
L
Linus Torvalds 已提交
1281 1282 1283 1284 1285 1286 1287 1288 1289 1290

extern void sk_common_release(struct sock *sk);

/*
 *	Default socket callbacks and setup code
 */
 
/* Initialise core socket variables */
extern void sock_init_data(struct socket *sock, struct sock *sk);

E
Eric Dumazet 已提交
1291 1292
extern void sk_filter_release_rcu(struct rcu_head *rcu);

1293
/**
1294
 *	sk_filter_release - release a socket filter
1295 1296 1297 1298 1299
 *	@fp: filter to remove
 *
 *	Remove a filter from a socket and release its resources.
 */

1300 1301 1302
static inline void sk_filter_release(struct sk_filter *fp)
{
	if (atomic_dec_and_test(&fp->refcnt))
1303
		call_rcu(&fp->rcu, sk_filter_release_rcu);
1304 1305 1306
}

static inline void sk_filter_uncharge(struct sock *sk, struct sk_filter *fp)
L
Linus Torvalds 已提交
1307 1308 1309 1310
{
	unsigned int size = sk_filter_len(fp);

	atomic_sub(size, &sk->sk_omem_alloc);
1311
	sk_filter_release(fp);
L
Linus Torvalds 已提交
1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351
}

static inline void sk_filter_charge(struct sock *sk, struct sk_filter *fp)
{
	atomic_inc(&fp->refcnt);
	atomic_add(sk_filter_len(fp), &sk->sk_omem_alloc);
}

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

1352 1353
extern int sk_receive_skb(struct sock *sk, struct sk_buff *skb,
			  const int nested);
1354

K
Krishna Kumar 已提交
1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366
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)
{
1367
	return sk ? sk->sk_tx_queue_mapping : -1;
K
Krishna Kumar 已提交
1368 1369
}

1370 1371
static inline void sk_set_socket(struct sock *sk, struct socket *sock)
{
K
Krishna Kumar 已提交
1372
	sk_tx_queue_clear(sk);
1373 1374 1375
	sk->sk_socket = sock;
}

E
Eric Dumazet 已提交
1376 1377
static inline wait_queue_head_t *sk_sleep(struct sock *sk)
{
1378 1379
	BUILD_BUG_ON(offsetof(struct socket_wq, wait) != 0);
	return &rcu_dereference_raw(sk->sk_wq)->wait;
E
Eric Dumazet 已提交
1380
}
L
Linus Torvalds 已提交
1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391
/* 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);
1392
	sk_set_socket(sk, NULL);
1393
	sk->sk_wq  = NULL;
L
Linus Torvalds 已提交
1394 1395 1396 1397 1398 1399
	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);
1400
	sk->sk_wq = parent->wq;
L
Linus Torvalds 已提交
1401
	parent->sk = sk;
1402
	sk_set_socket(sk, parent);
1403
	security_sock_graft(sk, parent);
L
Linus Torvalds 已提交
1404 1405 1406 1407 1408 1409 1410 1411 1412
	write_unlock_bh(&sk->sk_callback_lock);
}

extern int sock_i_uid(struct sock *sk);
extern unsigned long sock_i_ino(struct sock *sk);

static inline struct dst_entry *
__sk_dst_get(struct sock *sk)
{
1413
	return rcu_dereference_check(sk->sk_dst_cache, sock_owned_by_user(sk) ||
E
Eric Dumazet 已提交
1414
						       lockdep_is_held(&sk->sk_lock.slock));
L
Linus Torvalds 已提交
1415 1416 1417 1418 1419 1420 1421
}

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

E
Eric Dumazet 已提交
1422 1423
	rcu_read_lock();
	dst = rcu_dereference(sk->sk_dst_cache);
L
Linus Torvalds 已提交
1424 1425
	if (dst)
		dst_hold(dst);
E
Eric Dumazet 已提交
1426
	rcu_read_unlock();
L
Linus Torvalds 已提交
1427 1428 1429
	return dst;
}

E
Eric Dumazet 已提交
1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445
extern void sk_reset_txq(struct sock *sk);

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);
			sk_reset_txq(sk);
		}
	}
}

L
Linus Torvalds 已提交
1446 1447 1448 1449 1450
static inline void
__sk_dst_set(struct sock *sk, struct dst_entry *dst)
{
	struct dst_entry *old_dst;

K
Krishna Kumar 已提交
1451
	sk_tx_queue_clear(sk);
1452 1453 1454 1455 1456
	/*
	 * 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 已提交
1457
	rcu_assign_pointer(sk->sk_dst_cache, dst);
L
Linus Torvalds 已提交
1458 1459 1460 1461 1462 1463
	dst_release(old_dst);
}

static inline void
sk_dst_set(struct sock *sk, struct dst_entry *dst)
{
E
Eric Dumazet 已提交
1464
	spin_lock(&sk->sk_dst_lock);
L
Linus Torvalds 已提交
1465
	__sk_dst_set(sk, dst);
E
Eric Dumazet 已提交
1466
	spin_unlock(&sk->sk_dst_lock);
L
Linus Torvalds 已提交
1467 1468 1469 1470 1471
}

static inline void
__sk_dst_reset(struct sock *sk)
{
E
Eric Dumazet 已提交
1472
	__sk_dst_set(sk, NULL);
L
Linus Torvalds 已提交
1473 1474 1475 1476 1477
}

static inline void
sk_dst_reset(struct sock *sk)
{
E
Eric Dumazet 已提交
1478
	spin_lock(&sk->sk_dst_lock);
L
Linus Torvalds 已提交
1479
	__sk_dst_reset(sk);
E
Eric Dumazet 已提交
1480
	spin_unlock(&sk->sk_dst_lock);
L
Linus Torvalds 已提交
1481 1482
}

1483
extern struct dst_entry *__sk_dst_check(struct sock *sk, u32 cookie);
L
Linus Torvalds 已提交
1484

1485
extern struct dst_entry *sk_dst_check(struct sock *sk, u32 cookie);
L
Linus Torvalds 已提交
1486

1487 1488 1489 1490 1491
static inline int sk_can_gso(const struct sock *sk)
{
	return net_gso_ok(sk->sk_route_caps, sk->sk_gso_type);
}

1492
extern void sk_setup_caps(struct sock *sk, struct dst_entry *dst);
1493

1494
static inline void sk_nocaps_add(struct sock *sk, netdev_features_t flags)
E
Eric Dumazet 已提交
1495 1496 1497 1498 1499
{
	sk->sk_route_nocaps |= flags;
	sk->sk_route_caps &= ~flags;
}

1500 1501
static inline int skb_do_copy_data_nocache(struct sock *sk, struct sk_buff *skb,
					   char __user *from, char *to,
1502
					   int copy, int offset)
1503 1504 1505 1506 1507 1508
{
	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;
1509
		skb->csum = csum_block_add(skb->csum, csum, offset);
1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522
	} 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)
{
1523
	int err, offset = skb->len;
1524

1525 1526
	err = skb_do_copy_data_nocache(sk, skb, from, skb_put(skb, copy),
				       copy, offset);
1527
	if (err)
1528
		__skb_trim(skb, offset);
1529 1530 1531 1532 1533 1534 1535 1536 1537 1538 1539

	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;

1540 1541
	err = skb_do_copy_data_nocache(sk, skb, from, page_address(page) + off,
				       copy, skb->len);
1542 1543 1544 1545 1546 1547 1548 1549 1550 1551 1552
	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 已提交
1553 1554 1555 1556 1557 1558
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;
1559
		__wsum csum = csum_and_copy_from_user(from,
L
Linus Torvalds 已提交
1560 1561 1562 1563 1564 1565 1566 1567 1568 1569 1570 1571
						     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;
1572
	sk_mem_charge(sk, copy);
L
Linus Torvalds 已提交
1573 1574 1575
	return 0;
}

1576 1577 1578 1579 1580 1581 1582 1583 1584 1585 1586 1587 1588 1589 1590 1591 1592 1593 1594 1595 1596 1597 1598 1599 1600 1601 1602 1603 1604 1605 1606 1607 1608
/**
 * 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
 */
static inline int sk_has_allocations(const struct sock *sk)
{
	return sk_wmem_alloc_get(sk) || sk_rmem_alloc_get(sk);
}

1609
/**
1610
 * wq_has_sleeper - check if there are any waiting processes
R
Randy Dunlap 已提交
1611
 * @wq: struct socket_wq
1612
 *
1613
 * Returns true if socket_wq has waiting processes
1614
 *
1615
 * The purpose of the wq_has_sleeper and sock_poll_wait is to wrap the memory
1616 1617 1618 1619 1620 1621 1622 1623 1624 1625 1626 1627
 * 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
 *   ...                 {
1628 1629 1630 1631
 *   schedule               rcu_read_lock();
 *                          wq = rcu_dereference(sk->sk_wq);
 *                          if (wq && waitqueue_active(&wq->wait))
 *                              wake_up_interruptible(&wq->wait)
1632 1633 1634 1635 1636 1637 1638
 *                          ...
 *                       }
 *
 * 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.
1639
 *
1640
 */
1641
static inline bool wq_has_sleeper(struct socket_wq *wq)
1642
{
1643

1644 1645 1646 1647 1648 1649
	/*
	 * We need to be sure we are in sync with the
	 * add_wait_queue modifications to the wait queue.
	 *
	 * This memory barrier is paired in the sock_poll_wait.
	 */
1650 1651
	smp_mb();
	return wq && waitqueue_active(&wq->wait);
1652 1653 1654 1655 1656 1657 1658 1659
}

/**
 * sock_poll_wait - place memory barrier behind the poll_wait call.
 * @filp:           file
 * @wait_address:   socket wait queue
 * @p:              poll_table
 *
1660
 * See the comments in the wq_has_sleeper function.
1661 1662 1663 1664 1665 1666 1667 1668 1669 1670
 */
static inline void sock_poll_wait(struct file *filp,
		wait_queue_head_t *wait_address, poll_table *p)
{
	if (p && wait_address) {
		poll_wait(filp, wait_address, p);
		/*
		 * We need to be sure we are in sync with the
		 * socket flags modification.
		 *
1671
		 * This memory barrier is paired in the wq_has_sleeper.
1672 1673 1674 1675 1676
		*/
		smp_mb();
	}
}

L
Linus Torvalds 已提交
1677 1678 1679 1680 1681 1682 1683 1684 1685 1686 1687
/*
 * 	Queue a received datagram if it will fit. Stream and sequenced
 *	protocols can't normally use this as they need to fit buffers in
 *	and play with them.
 *
 * 	Inlined as it's very short and called for pretty much every
 *	packet ever received.
 */

static inline void skb_set_owner_w(struct sk_buff *skb, struct sock *sk)
{
1688
	skb_orphan(skb);
L
Linus Torvalds 已提交
1689 1690
	skb->sk = sk;
	skb->destructor = sock_wfree;
1691 1692 1693 1694 1695
	/*
	 * 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 已提交
1696 1697 1698 1699 1700
	atomic_add(skb->truesize, &sk->sk_wmem_alloc);
}

static inline void skb_set_owner_r(struct sk_buff *skb, struct sock *sk)
{
1701
	skb_orphan(skb);
L
Linus Torvalds 已提交
1702 1703 1704
	skb->sk = sk;
	skb->destructor = sock_rfree;
	atomic_add(skb->truesize, &sk->sk_rmem_alloc);
1705
	sk_mem_charge(sk, skb->truesize);
L
Linus Torvalds 已提交
1706 1707 1708 1709 1710 1711 1712
}

extern void sk_reset_timer(struct sock *sk, struct timer_list* timer,
			   unsigned long expires);

extern void sk_stop_timer(struct sock *sk, struct timer_list* timer);

1713
extern int sock_queue_rcv_skb(struct sock *sk, struct sk_buff *skb);
L
Linus Torvalds 已提交
1714

1715
extern int sock_queue_err_skb(struct sock *sk, struct sk_buff *skb);
L
Linus Torvalds 已提交
1716 1717 1718 1719 1720 1721 1722

/*
 *	Recover an error report and clear atomically
 */
 
static inline int sock_error(struct sock *sk)
{
1723 1724 1725 1726
	int err;
	if (likely(!sk->sk_err))
		return 0;
	err = xchg(&sk->sk_err, 0);
L
Linus Torvalds 已提交
1727 1728 1729 1730 1731 1732 1733 1734 1735 1736 1737 1738 1739 1740 1741 1742 1743
	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);
		if (amt < 0) 
			amt = 0;
	}
	return amt;
}

static inline void sk_wake_async(struct sock *sk, int how, int band)
{
E
Eric Dumazet 已提交
1744
	if (sock_flag(sk, SOCK_FASYNC))
L
Linus Torvalds 已提交
1745 1746 1747 1748
		sock_wake_async(sk->sk_socket, how, band);
}

#define SOCK_MIN_SNDBUF 2048
E
Eric Dumazet 已提交
1749 1750 1751 1752 1753
/*
 * Since sk_rmem_alloc sums skb->truesize, even a small frame might need
 * sizeof(sk_buff) + MTU + padding, unless net driver perform copybreak
 */
#define SOCK_MIN_RCVBUF (2048 + sizeof(struct sk_buff))
L
Linus Torvalds 已提交
1754 1755 1756 1757

static inline void sk_stream_moderate_sndbuf(struct sock *sk)
{
	if (!(sk->sk_userlocks & SOCK_SNDBUF_LOCK)) {
1758
		sk->sk_sndbuf = min(sk->sk_sndbuf, sk->sk_wmem_queued >> 1);
L
Linus Torvalds 已提交
1759 1760 1761 1762
		sk->sk_sndbuf = max(sk->sk_sndbuf, SOCK_MIN_SNDBUF);
	}
}

1763
struct sk_buff *sk_stream_alloc_skb(struct sock *sk, int size, gfp_t gfp);
L
Linus Torvalds 已提交
1764 1765 1766 1767 1768

static inline struct page *sk_stream_alloc_page(struct sock *sk)
{
	struct page *page = NULL;

1769 1770
	page = alloc_pages(sk->sk_allocation, 0);
	if (!page) {
1771
		sk_enter_memory_pressure(sk);
L
Linus Torvalds 已提交
1772 1773 1774 1775 1776 1777 1778 1779 1780 1781
		sk_stream_moderate_sndbuf(sk);
	}
	return page;
}

/*
 *	Default write policy as shown to user space via poll/select/SIGIO
 */
static inline int sock_writeable(const struct sock *sk) 
{
1782
	return atomic_read(&sk->sk_wmem_alloc) < (sk->sk_sndbuf >> 1);
L
Linus Torvalds 已提交
1783 1784
}

A
Al Viro 已提交
1785
static inline gfp_t gfp_any(void)
L
Linus Torvalds 已提交
1786
{
1787
	return in_softirq() ? GFP_ATOMIC : GFP_KERNEL;
L
Linus Torvalds 已提交
1788 1789 1790 1791 1792 1793 1794 1795 1796 1797 1798 1799 1800 1801 1802 1803 1804 1805 1806 1807 1808 1809 1810 1811 1812
}

static inline long sock_rcvtimeo(const struct sock *sk, int noblock)
{
	return noblock ? 0 : sk->sk_rcvtimeo;
}

static inline long sock_sndtimeo(const struct sock *sk, int noblock)
{
	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;
}

1813 1814
extern void __sock_recv_timestamp(struct msghdr *msg, struct sock *sk,
	struct sk_buff *skb);
1815 1816
extern void __sock_recv_wifi_status(struct msghdr *msg, struct sock *sk,
	struct sk_buff *skb);
1817

L
Linus Torvalds 已提交
1818 1819 1820
static __inline__ void
sock_recv_timestamp(struct msghdr *msg, struct sock *sk, struct sk_buff *skb)
{
1821
	ktime_t kt = skb->tstamp;
1822
	struct skb_shared_hwtstamps *hwtstamps = skb_hwtstamps(skb);
1823

1824 1825 1826 1827 1828 1829 1830 1831 1832 1833 1834 1835 1836 1837 1838 1839 1840
	/*
	 * 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)))
1841 1842
		__sock_recv_timestamp(msg, sk, skb);
	else
1843
		sk->sk_stamp = kt;
1844 1845 1846

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

1849 1850 1851 1852 1853 1854 1855 1856 1857 1858 1859 1860 1861 1862 1863 1864 1865 1866
extern void __sock_recv_ts_and_drops(struct msghdr *msg, struct sock *sk,
				     struct sk_buff *skb);

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)		| \
			   (1UL << SOCK_TIMESTAMPING_RAW_HARDWARE) 	| \
			   (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;
}
1867

1868 1869 1870
/**
 * sock_tx_timestamp - checks whether the outgoing packet is to be time stamped
 * @sk:		socket sending this packet
1871
 * @tx_flags:	filled with instructions for time stamping
1872 1873 1874 1875
 *
 * Currently only depends on SOCK_TIMESTAMPING* flags. Returns error code if
 * parameters are invalid.
 */
1876
extern int sock_tx_timestamp(struct sock *sk, __u8 *tx_flags);
1877

L
Linus Torvalds 已提交
1878 1879
/**
 * sk_eat_skb - Release a skb if it is no longer needed
1880 1881
 * @sk: socket to eat this skb from
 * @skb: socket buffer to eat
R
Randy Dunlap 已提交
1882
 * @copied_early: flag indicating whether DMA operations copied this data early
L
Linus Torvalds 已提交
1883 1884 1885 1886
 *
 * This routine must be called with interrupts disabled or with the socket
 * locked so that the sk_buff queue operation is ok.
*/
1887 1888 1889 1890 1891 1892 1893 1894 1895 1896 1897
#ifdef CONFIG_NET_DMA
static inline void sk_eat_skb(struct sock *sk, struct sk_buff *skb, int copied_early)
{
	__skb_unlink(skb, &sk->sk_receive_queue);
	if (!copied_early)
		__kfree_skb(skb);
	else
		__skb_queue_tail(&sk->sk_async_wait_queue, skb);
}
#else
static inline void sk_eat_skb(struct sock *sk, struct sk_buff *skb, int copied_early)
L
Linus Torvalds 已提交
1898 1899 1900 1901
{
	__skb_unlink(skb, &sk->sk_receive_queue);
	__kfree_skb(skb);
}
1902
#endif
L
Linus Torvalds 已提交
1903

1904 1905 1906
static inline
struct net *sock_net(const struct sock *sk)
{
E
Eric Dumazet 已提交
1907
	return read_pnet(&sk->sk_net);
1908 1909 1910
}

static inline
1911
void sock_net_set(struct sock *sk, struct net *net)
1912
{
E
Eric Dumazet 已提交
1913
	write_pnet(&sk->sk_net, net);
1914 1915
}

1916 1917
/*
 * Kernel sockets, f.e. rtnl or icmp_socket, are a part of a namespace.
L
Lucas De Marchi 已提交
1918
 * They should not hold a reference to a namespace in order to allow
1919 1920 1921 1922 1923
 * 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)
{
1924
	put_net(sock_net(sk));
1925
	sock_net_set(sk, hold_net(net));
1926 1927
}

1928 1929 1930 1931 1932 1933 1934 1935 1936 1937 1938 1939
static inline struct sock *skb_steal_sock(struct sk_buff *skb)
{
	if (unlikely(skb->sk)) {
		struct sock *sk = skb->sk;

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

1940
extern void sock_enable_timestamp(struct sock *sk, int flag);
L
Linus Torvalds 已提交
1941
extern int sock_get_timestamp(struct sock *, struct timeval __user *);
1942
extern int sock_get_timestampns(struct sock *, struct timespec __user *);
L
Linus Torvalds 已提交
1943 1944 1945 1946

/* 
 *	Enable debug/info messages 
 */
1947 1948 1949
extern int net_msg_warn;
#define NETDEBUG(fmt, args...) \
	do { if (net_msg_warn) printk(fmt,##args); } while (0)
L
Linus Torvalds 已提交
1950

1951 1952
#define LIMIT_NETDEBUG(fmt, args...) \
	do { if (net_msg_warn && net_ratelimit()) printk(fmt,##args); } while(0)
L
Linus Torvalds 已提交
1953 1954 1955 1956

extern __u32 sysctl_wmem_max;
extern __u32 sysctl_rmem_max;

1957 1958
extern void sk_init(void);

1959 1960
extern int sysctl_optmem_max;

1961 1962 1963
extern __u32 sysctl_wmem_default;
extern __u32 sysctl_rmem_default;

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