blob: ed0dbf034539b97a0c2e465b6131d0ac5ece53cc [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001/*
2 * INET An implementation of the TCP/IP protocol suite for the LINUX
3 * operating system. INET is implemented using the BSD Socket
4 * interface as the means of communication with the user level.
5 *
6 * Definitions for the AF_INET socket handler.
7 *
8 * Version: @(#)sock.h 1.0.4 05/13/93
9 *
Jesper Juhl02c30a82005-05-05 16:16:16 -070010 * Authors: Ross Biro
Linus Torvalds1da177e2005-04-16 15:20:36 -070011 * Fred N. van Kempen, <waltje@uWalt.NL.Mugnet.ORG>
12 * Corey Minyard <wf-rch!minyard@relay.EU.net>
13 * Florian La Roche <flla@stud.uni-sb.de>
14 *
15 * Fixes:
16 * Alan Cox : Volatiles in skbuff pointers. See
17 * skbuff comments. May be overdone,
18 * better to prove they can be removed
19 * than the reverse.
20 * Alan Cox : Added a zapped field for tcp to note
21 * a socket is reset and must stay shut up
22 * Alan Cox : New fields for options
23 * Pauline Middelink : identd support
24 * Alan Cox : Eliminate low level recv/recvfrom
25 * David S. Miller : New socket lookup architecture.
26 * Steve Whitehouse: Default routines for sock_ops
27 * Arnaldo C. Melo : removed net_pinfo, tp_pinfo and made
28 * protinfo be just a void pointer, as the
29 * protocol specific parts were moved to
30 * respective headers and ipv4/v6, etc now
31 * use private slabcaches for its socks
32 * Pedro Hortas : New flags field for socket options
33 *
34 *
35 * This program is free software; you can redistribute it and/or
36 * modify it under the terms of the GNU General Public License
37 * as published by the Free Software Foundation; either version
38 * 2 of the License, or (at your option) any later version.
39 */
40#ifndef _SOCK_H
41#define _SOCK_H
42
Alexey Dobriyana6b7a402011-06-06 10:43:46 +000043#include <linux/hardirq.h>
Ilpo Järvinen172589c2007-08-28 15:50:33 -070044#include <linux/kernel.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070045#include <linux/list.h>
Eric Dumazet88ab1932008-11-16 19:39:21 -080046#include <linux/list_nulls.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070047#include <linux/timer.h>
48#include <linux/cache.h>
Ingo Molnara5b5bb92006-07-03 00:25:35 -070049#include <linux/lockdep.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070050#include <linux/netdevice.h>
51#include <linux/skbuff.h> /* struct sk_buff */
Al Virod7fe0f22006-12-03 23:15:30 -050052#include <linux/mm.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070053#include <linux/security.h>
Tejun Heo5a0e3ad2010-03-24 17:04:11 +090054#include <linux/slab.h>
Tom Herbertc6e1a0d2011-04-04 22:30:30 -070055#include <linux/uaccess.h>
Glauber Costa180d8cd2011-12-11 21:47:02 +000056#include <linux/memcontrol.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070057
58#include <linux/filter.h>
Eric Dumazet88ab1932008-11-16 19:39:21 -080059#include <linux/rculist_nulls.h>
Jiri Olsaa57de0b2009-07-08 12:09:13 +000060#include <linux/poll.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070061
Eric Dumazetc31504d2010-11-15 19:58:26 +000062#include <linux/atomic.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070063#include <net/dst.h>
64#include <net/checksum.h>
65
66/*
67 * This structure really needs to be cleaned up.
68 * Most of it is for TCP, and not used by any of
69 * the other protocols.
70 */
71
72/* Define this to get the SOCK_DBG debugging facility. */
73#define SOCK_DEBUGGING
74#ifdef SOCK_DEBUGGING
75#define SOCK_DEBUG(sk, msg...) do { if ((sk) && sock_flag((sk), SOCK_DBG)) \
76 printk(KERN_DEBUG msg); } while (0)
77#else
Stephen Hemminger4cd90292008-03-21 15:54:53 -070078/* Validate arguments and do nothing */
Joe Perchesb9075fa2011-10-31 17:11:33 -070079static inline __printf(2, 3)
80void SOCK_DEBUG(struct sock *sk, const char *msg, ...)
Stephen Hemminger4cd90292008-03-21 15:54:53 -070081{
82}
Linus Torvalds1da177e2005-04-16 15:20:36 -070083#endif
84
85/* This is the per-socket lock. The spinlock provides a synchronization
86 * between user contexts and software interrupt processing, whereas the
87 * mini-semaphore synchronizes multiple users amongst themselves.
88 */
Linus Torvalds1da177e2005-04-16 15:20:36 -070089typedef struct {
90 spinlock_t slock;
John Heffnerd2e91172007-09-12 10:44:19 +020091 int owned;
Linus Torvalds1da177e2005-04-16 15:20:36 -070092 wait_queue_head_t wq;
Ingo Molnara5b5bb92006-07-03 00:25:35 -070093 /*
94 * We express the mutex-alike socket_lock semantics
95 * to the lock validator by explicitly managing
96 * the slock as a lock variant (in addition to
97 * the slock itself):
98 */
99#ifdef CONFIG_DEBUG_LOCK_ALLOC
100 struct lockdep_map dep_map;
101#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -0700102} socket_lock_t;
103
Linus Torvalds1da177e2005-04-16 15:20:36 -0700104struct sock;
Arnaldo Carvalho de Melo8feaf0c02005-08-09 20:09:30 -0700105struct proto;
Denis V. Lunev0eeb8ff2007-12-04 01:15:45 -0800106struct net;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700107
108/**
Pavel Pisa4dc3b162005-05-01 08:59:25 -0700109 * struct sock_common - minimal network layer representation of sockets
Eric Dumazet68835ab2010-11-30 19:04:07 +0000110 * @skc_daddr: Foreign IPv4 addr
111 * @skc_rcv_saddr: Bound local IPv4 addr
Eric Dumazet4dc6dc72009-07-15 23:13:10 +0000112 * @skc_hash: hash value used with various protocol lookup tables
Eric Dumazetd4cada42009-11-08 10:17:30 +0000113 * @skc_u16hashes: two u16 hash values used by UDP lookup tables
Pavel Pisa4dc3b162005-05-01 08:59:25 -0700114 * @skc_family: network address family
115 * @skc_state: Connection state
116 * @skc_reuse: %SO_REUSEADDR setting
117 * @skc_bound_dev_if: bound device index if != 0
Pavel Pisa4dc3b162005-05-01 08:59:25 -0700118 * @skc_bind_node: bind hash linkage for various protocol lookup tables
Eric Dumazet512615b2009-11-08 10:17:58 +0000119 * @skc_portaddr_node: second hash linkage for UDP/UDP-Lite protocol
Arnaldo Carvalho de Melo8feaf0c02005-08-09 20:09:30 -0700120 * @skc_prot: protocol handlers inside a network family
Eric W. Biederman07feaeb2007-09-12 11:58:02 +0200121 * @skc_net: reference to the network namespace of this socket
Eric Dumazet68835ab2010-11-30 19:04:07 +0000122 * @skc_node: main hash linkage for various protocol lookup tables
123 * @skc_nulls_node: main hash linkage for TCP/UDP/UDP-Lite protocol
124 * @skc_tx_queue_mapping: tx queue number for this connection
125 * @skc_refcnt: reference count
Pavel Pisa4dc3b162005-05-01 08:59:25 -0700126 *
127 * This is the minimal network layer representation of sockets, the header
Arnaldo Carvalho de Melo8feaf0c02005-08-09 20:09:30 -0700128 * for struct sock and struct inet_timewait_sock.
129 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700130struct sock_common {
Eric Dumazet68835ab2010-11-30 19:04:07 +0000131 /* skc_daddr and skc_rcv_saddr must be grouped :
132 * cf INET_MATCH() and INET_TW_MATCH()
Eric Dumazet4dc6dc72009-07-15 23:13:10 +0000133 */
Eric Dumazet68835ab2010-11-30 19:04:07 +0000134 __be32 skc_daddr;
135 __be32 skc_rcv_saddr;
Eric Dumazet4dc6dc72009-07-15 23:13:10 +0000136
Eric Dumazetd4cada42009-11-08 10:17:30 +0000137 union {
138 unsigned int skc_hash;
139 __u16 skc_u16hashes[2];
140 };
Eric Dumazet4dc6dc72009-07-15 23:13:10 +0000141 unsigned short skc_family;
142 volatile unsigned char skc_state;
143 unsigned char skc_reuse;
144 int skc_bound_dev_if;
Eric Dumazet512615b2009-11-08 10:17:58 +0000145 union {
146 struct hlist_node skc_bind_node;
147 struct hlist_nulls_node skc_portaddr_node;
148 };
Arnaldo Carvalho de Melo8feaf0c02005-08-09 20:09:30 -0700149 struct proto *skc_prot;
YOSHIFUJI Hideaki3b1e0a62008-03-26 02:26:21 +0900150#ifdef CONFIG_NET_NS
Eric W. Biederman07feaeb2007-09-12 11:58:02 +0200151 struct net *skc_net;
YOSHIFUJI Hideaki3b1e0a62008-03-26 02:26:21 +0900152#endif
Eric Dumazet68835ab2010-11-30 19:04:07 +0000153 /*
154 * fields between dontcopy_begin/dontcopy_end
155 * are not copied in sock_copy()
156 */
Randy Dunlap928c41e2011-01-08 17:39:21 +0000157 /* private: */
Eric Dumazet68835ab2010-11-30 19:04:07 +0000158 int skc_dontcopy_begin[0];
Randy Dunlap928c41e2011-01-08 17:39:21 +0000159 /* public: */
Eric Dumazet68835ab2010-11-30 19:04:07 +0000160 union {
161 struct hlist_node skc_node;
162 struct hlist_nulls_node skc_nulls_node;
163 };
164 int skc_tx_queue_mapping;
165 atomic_t skc_refcnt;
Randy Dunlap928c41e2011-01-08 17:39:21 +0000166 /* private: */
Eric Dumazet68835ab2010-11-30 19:04:07 +0000167 int skc_dontcopy_end[0];
Randy Dunlap928c41e2011-01-08 17:39:21 +0000168 /* public: */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700169};
170
171/**
172 * struct sock - network layer representation of sockets
Arnaldo Carvalho de Melo8feaf0c02005-08-09 20:09:30 -0700173 * @__sk_common: shared layout with inet_timewait_sock
Pavel Pisa4dc3b162005-05-01 08:59:25 -0700174 * @sk_shutdown: mask of %SEND_SHUTDOWN and/or %RCV_SHUTDOWN
175 * @sk_userlocks: %SO_SNDBUF and %SO_RCVBUF settings
176 * @sk_lock: synchronizer
177 * @sk_rcvbuf: size of receive buffer in bytes
Eric Dumazet43815482010-04-29 11:01:49 +0000178 * @sk_wq: sock wait queue and async head
Pavel Pisa4dc3b162005-05-01 08:59:25 -0700179 * @sk_dst_cache: destination cache
180 * @sk_dst_lock: destination cache lock
181 * @sk_policy: flow policy
Pavel Pisa4dc3b162005-05-01 08:59:25 -0700182 * @sk_receive_queue: incoming packets
183 * @sk_wmem_alloc: transmit queue bytes committed
184 * @sk_write_queue: Packet sending queue
Chris Leech97fc2f02006-05-23 17:55:33 -0700185 * @sk_async_wait_queue: DMA copied packets
Pavel Pisa4dc3b162005-05-01 08:59:25 -0700186 * @sk_omem_alloc: "o" is "option" or "other"
187 * @sk_wmem_queued: persistent queue size
188 * @sk_forward_alloc: space allocated forward
189 * @sk_allocation: allocation mode
190 * @sk_sndbuf: size of send buffer in bytes
Wang Chen33c732c2007-11-13 20:30:01 -0800191 * @sk_flags: %SO_LINGER (l_onoff), %SO_BROADCAST, %SO_KEEPALIVE,
Patrick Ohly20d49472009-02-12 05:03:38 +0000192 * %SO_OOBINLINE settings, %SO_TIMESTAMPING settings
Pavel Pisa4dc3b162005-05-01 08:59:25 -0700193 * @sk_no_check: %SO_NO_CHECK setting, wether or not checkup packets
194 * @sk_route_caps: route capabilities (e.g. %NETIF_F_TSO)
Eric Dumazeta4654192010-05-16 00:36:33 -0700195 * @sk_route_nocaps: forbidden route capabilities (e.g NETIF_F_GSO_MASK)
Herbert Xubcd76112006-06-30 13:36:35 -0700196 * @sk_gso_type: GSO type (e.g. %SKB_GSO_TCPV4)
Peter P Waskiewicz Jr82cc1a72008-03-21 03:43:19 -0700197 * @sk_gso_max_size: Maximum GSO segment size to build
Pavel Pisa4dc3b162005-05-01 08:59:25 -0700198 * @sk_lingertime: %SO_LINGER l_linger setting
Pavel Pisa4dc3b162005-05-01 08:59:25 -0700199 * @sk_backlog: always used with the per-socket spinlock held
200 * @sk_callback_lock: used with the callbacks in the end of this struct
201 * @sk_error_queue: rarely used
Wang Chen33c732c2007-11-13 20:30:01 -0800202 * @sk_prot_creator: sk_prot of original sock creator (see ipv6_setsockopt,
203 * IPV6_ADDRFORM for instance)
Pavel Pisa4dc3b162005-05-01 08:59:25 -0700204 * @sk_err: last error
Wang Chen33c732c2007-11-13 20:30:01 -0800205 * @sk_err_soft: errors that don't cause failure but are the cause of a
206 * persistent failure not just 'timed out'
Eric Dumazetcb61cb92008-06-17 21:04:56 -0700207 * @sk_drops: raw/udp drops counter
Pavel Pisa4dc3b162005-05-01 08:59:25 -0700208 * @sk_ack_backlog: current listen backlog
209 * @sk_max_ack_backlog: listen backlog set in listen()
210 * @sk_priority: %SO_PRIORITY setting
211 * @sk_type: socket type (%SOCK_STREAM, etc)
212 * @sk_protocol: which protocol this socket belongs in this network family
Randy Dunlap53c3fa22010-08-09 13:41:07 +0000213 * @sk_peer_pid: &struct pid for this socket's peer
214 * @sk_peer_cred: %SO_PEERCRED setting
Pavel Pisa4dc3b162005-05-01 08:59:25 -0700215 * @sk_rcvlowat: %SO_RCVLOWAT setting
216 * @sk_rcvtimeo: %SO_RCVTIMEO setting
217 * @sk_sndtimeo: %SO_SNDTIMEO setting
David S. Millerc58dc012010-04-27 15:05:31 -0700218 * @sk_rxhash: flow hash received from netif layer
Pavel Pisa4dc3b162005-05-01 08:59:25 -0700219 * @sk_filter: socket filtering instructions
220 * @sk_protinfo: private area, net family specific, when not using slab
221 * @sk_timer: sock cleanup timer
222 * @sk_stamp: time stamp of last packet received
223 * @sk_socket: Identd and reporting IO signals
224 * @sk_user_data: RPC layer private data
225 * @sk_sndmsg_page: cached page for sendmsg
226 * @sk_sndmsg_off: cached offset for sendmsg
227 * @sk_send_head: front of stuff to transmit
Martin Waitz67be2dd2005-05-01 08:59:26 -0700228 * @sk_security: used by security modules
Randy Dunlap31729362008-02-18 20:52:13 -0800229 * @sk_mark: generic packet mark
Randy Dunlap53c3fa22010-08-09 13:41:07 +0000230 * @sk_classid: this socket's cgroup classid
Pavel Pisa4dc3b162005-05-01 08:59:25 -0700231 * @sk_write_pending: a write to stream socket waits to start
232 * @sk_state_change: callback to indicate change in the state of the sock
233 * @sk_data_ready: callback to indicate there is data to be processed
234 * @sk_write_space: callback to indicate there is bf sending space available
235 * @sk_error_report: callback to indicate errors (e.g. %MSG_ERRQUEUE)
236 * @sk_backlog_rcv: callback to process the backlog
237 * @sk_destruct: called at sock freeing time, i.e. when all refcnt == 0
Linus Torvalds1da177e2005-04-16 15:20:36 -0700238 */
239struct sock {
240 /*
Arnaldo Carvalho de Melo8feaf0c02005-08-09 20:09:30 -0700241 * Now struct inet_timewait_sock also uses sock_common, so please just
Linus Torvalds1da177e2005-04-16 15:20:36 -0700242 * don't add nothing before this first member (__sk_common) --acme
243 */
244 struct sock_common __sk_common;
Eric Dumazet4dc6dc72009-07-15 23:13:10 +0000245#define sk_node __sk_common.skc_node
246#define sk_nulls_node __sk_common.skc_nulls_node
247#define sk_refcnt __sk_common.skc_refcnt
Krishna Kumare022f0b2009-10-19 23:46:20 +0000248#define sk_tx_queue_mapping __sk_common.skc_tx_queue_mapping
Eric Dumazet4dc6dc72009-07-15 23:13:10 +0000249
Eric Dumazet68835ab2010-11-30 19:04:07 +0000250#define sk_dontcopy_begin __sk_common.skc_dontcopy_begin
251#define sk_dontcopy_end __sk_common.skc_dontcopy_end
Eric Dumazet4dc6dc72009-07-15 23:13:10 +0000252#define sk_hash __sk_common.skc_hash
Linus Torvalds1da177e2005-04-16 15:20:36 -0700253#define sk_family __sk_common.skc_family
254#define sk_state __sk_common.skc_state
255#define sk_reuse __sk_common.skc_reuse
256#define sk_bound_dev_if __sk_common.skc_bound_dev_if
Linus Torvalds1da177e2005-04-16 15:20:36 -0700257#define sk_bind_node __sk_common.skc_bind_node
Arnaldo Carvalho de Melo8feaf0c02005-08-09 20:09:30 -0700258#define sk_prot __sk_common.skc_prot
Eric W. Biederman07feaeb2007-09-12 11:58:02 +0200259#define sk_net __sk_common.skc_net
Eric Dumazetb178bb32010-11-16 05:56:04 +0000260 socket_lock_t sk_lock;
261 struct sk_buff_head sk_receive_queue;
262 /*
263 * The backlog queue is special, it is always used with
264 * the per-socket spinlock held and requires low latency
265 * access. Therefore we special case it's implementation.
266 * Note : rmem_alloc is in this structure to fill a hole
267 * on 64bit arches, not because its logically part of
268 * backlog.
269 */
270 struct {
271 atomic_t rmem_alloc;
272 int len;
273 struct sk_buff *head;
274 struct sk_buff *tail;
275 } sk_backlog;
276#define sk_rmem_alloc sk_backlog.rmem_alloc
277 int sk_forward_alloc;
278#ifdef CONFIG_RPS
279 __u32 sk_rxhash;
280#endif
281 atomic_t sk_drops;
282 int sk_rcvbuf;
283
284 struct sk_filter __rcu *sk_filter;
Eric Dumazeteaefd112011-02-18 03:26:36 +0000285 struct socket_wq __rcu *sk_wq;
Eric Dumazetb178bb32010-11-16 05:56:04 +0000286
287#ifdef CONFIG_NET_DMA
288 struct sk_buff_head sk_async_wait_queue;
289#endif
290
291#ifdef CONFIG_XFRM
292 struct xfrm_policy *sk_policy[2];
293#endif
294 unsigned long sk_flags;
295 struct dst_entry *sk_dst_cache;
296 spinlock_t sk_dst_lock;
297 atomic_t sk_wmem_alloc;
298 atomic_t sk_omem_alloc;
299 int sk_sndbuf;
300 struct sk_buff_head sk_write_queue;
Vegard Nossuma98b65a2009-02-26 14:46:57 +0100301 kmemcheck_bitfield_begin(flags);
Eric Dumazet5fdb9972009-10-08 22:50:25 +0000302 unsigned int sk_shutdown : 2,
303 sk_no_check : 2,
304 sk_userlocks : 4,
305 sk_protocol : 8,
306 sk_type : 16;
Vegard Nossuma98b65a2009-02-26 14:46:57 +0100307 kmemcheck_bitfield_end(flags);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700308 int sk_wmem_queued;
Al Viro7d877f32005-10-21 03:20:43 -0400309 gfp_t sk_allocation;
Michał Mirosławc8f44af2011-11-15 15:29:55 +0000310 netdev_features_t sk_route_caps;
311 netdev_features_t sk_route_nocaps;
Herbert Xubcd76112006-06-30 13:36:35 -0700312 int sk_gso_type;
Peter P Waskiewicz Jr82cc1a72008-03-21 03:43:19 -0700313 unsigned int sk_gso_max_size;
David S. Miller9932cf92006-03-24 15:12:37 -0800314 int sk_rcvlowat;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700315 unsigned long sk_lingertime;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700316 struct sk_buff_head sk_error_queue;
Arnaldo Carvalho de Melo476e19c2005-05-05 13:35:15 -0700317 struct proto *sk_prot_creator;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700318 rwlock_t sk_callback_lock;
319 int sk_err,
320 sk_err_soft;
321 unsigned short sk_ack_backlog;
322 unsigned short sk_max_ack_backlog;
323 __u32 sk_priority;
Neil Horman5bc14212011-11-22 05:10:51 +0000324#ifdef CONFIG_CGROUPS
325 __u32 sk_cgrp_prioidx;
326#endif
Eric W. Biederman109f6e32010-06-13 03:30:14 +0000327 struct pid *sk_peer_pid;
328 const struct cred *sk_peer_cred;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700329 long sk_rcvtimeo;
330 long sk_sndtimeo;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700331 void *sk_protinfo;
332 struct timer_list sk_timer;
Eric Dumazetb7aa0bf2007-04-19 16:16:32 -0700333 ktime_t sk_stamp;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700334 struct socket *sk_socket;
335 void *sk_user_data;
336 struct page *sk_sndmsg_page;
337 struct sk_buff *sk_send_head;
338 __u32 sk_sndmsg_off;
339 int sk_write_pending;
Alexey Dobriyand5f64232008-11-04 14:45:58 -0800340#ifdef CONFIG_SECURITY
Linus Torvalds1da177e2005-04-16 15:20:36 -0700341 void *sk_security;
Alexey Dobriyand5f64232008-11-04 14:45:58 -0800342#endif
Laszlo Attila Toth4a19ec52008-01-30 19:08:16 -0800343 __u32 sk_mark;
Herbert Xuf8451722010-05-24 00:12:34 -0700344 u32 sk_classid;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700345 void (*sk_state_change)(struct sock *sk);
346 void (*sk_data_ready)(struct sock *sk, int bytes);
347 void (*sk_write_space)(struct sock *sk);
348 void (*sk_error_report)(struct sock *sk);
349 int (*sk_backlog_rcv)(struct sock *sk,
350 struct sk_buff *skb);
351 void (*sk_destruct)(struct sock *sk);
352};
353
354/*
355 * Hashed lists helper routines
356 */
Li Zefanc41466442010-02-08 23:18:45 +0000357static inline struct sock *sk_entry(const struct hlist_node *node)
358{
359 return hlist_entry(node, struct sock, sk_node);
360}
361
Arnaldo Carvalho de Meloe48c4142005-08-09 20:09:46 -0700362static inline struct sock *__sk_head(const struct hlist_head *head)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700363{
364 return hlist_entry(head->first, struct sock, sk_node);
365}
366
Arnaldo Carvalho de Meloe48c4142005-08-09 20:09:46 -0700367static inline struct sock *sk_head(const struct hlist_head *head)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700368{
369 return hlist_empty(head) ? NULL : __sk_head(head);
370}
371
Eric Dumazet88ab1932008-11-16 19:39:21 -0800372static inline struct sock *__sk_nulls_head(const struct hlist_nulls_head *head)
373{
374 return hlist_nulls_entry(head->first, struct sock, sk_nulls_node);
375}
376
377static inline struct sock *sk_nulls_head(const struct hlist_nulls_head *head)
378{
379 return hlist_nulls_empty(head) ? NULL : __sk_nulls_head(head);
380}
381
Arnaldo Carvalho de Meloe48c4142005-08-09 20:09:46 -0700382static inline struct sock *sk_next(const struct sock *sk)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700383{
384 return sk->sk_node.next ?
385 hlist_entry(sk->sk_node.next, struct sock, sk_node) : NULL;
386}
387
Eric Dumazet88ab1932008-11-16 19:39:21 -0800388static inline struct sock *sk_nulls_next(const struct sock *sk)
389{
390 return (!is_a_nulls(sk->sk_nulls_node.next)) ?
391 hlist_nulls_entry(sk->sk_nulls_node.next,
392 struct sock, sk_nulls_node) :
393 NULL;
394}
395
Arnaldo Carvalho de Meloe48c4142005-08-09 20:09:46 -0700396static inline int sk_unhashed(const struct sock *sk)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700397{
398 return hlist_unhashed(&sk->sk_node);
399}
400
Arnaldo Carvalho de Meloe48c4142005-08-09 20:09:46 -0700401static inline int sk_hashed(const struct sock *sk)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700402{
Akinobu Mitada753be2006-04-28 15:21:23 -0700403 return !sk_unhashed(sk);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700404}
405
406static __inline__ void sk_node_init(struct hlist_node *node)
407{
408 node->pprev = NULL;
409}
410
Eric Dumazet88ab1932008-11-16 19:39:21 -0800411static __inline__ void sk_nulls_node_init(struct hlist_nulls_node *node)
412{
413 node->pprev = NULL;
414}
415
Linus Torvalds1da177e2005-04-16 15:20:36 -0700416static __inline__ void __sk_del_node(struct sock *sk)
417{
418 __hlist_del(&sk->sk_node);
419}
420
stephen hemminger808f5112010-02-22 07:57:18 +0000421/* NB: equivalent to hlist_del_init_rcu */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700422static __inline__ int __sk_del_node_init(struct sock *sk)
423{
424 if (sk_hashed(sk)) {
425 __sk_del_node(sk);
426 sk_node_init(&sk->sk_node);
427 return 1;
428 }
429 return 0;
430}
431
432/* Grab socket reference count. This operation is valid only
433 when sk is ALREADY grabbed f.e. it is found in hash table
434 or a list and the lookup is made under lock preventing hash table
435 modifications.
436 */
437
438static inline void sock_hold(struct sock *sk)
439{
440 atomic_inc(&sk->sk_refcnt);
441}
442
443/* Ungrab socket in the context, which assumes that socket refcnt
444 cannot hit zero, f.e. it is true in context of any socketcall.
445 */
446static inline void __sock_put(struct sock *sk)
447{
448 atomic_dec(&sk->sk_refcnt);
449}
450
451static __inline__ int sk_del_node_init(struct sock *sk)
452{
453 int rc = __sk_del_node_init(sk);
454
455 if (rc) {
456 /* paranoid for a while -acme */
457 WARN_ON(atomic_read(&sk->sk_refcnt) == 1);
458 __sock_put(sk);
459 }
460 return rc;
461}
stephen hemminger808f5112010-02-22 07:57:18 +0000462#define sk_del_node_init_rcu(sk) sk_del_node_init(sk)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700463
Eric Dumazet88ab1932008-11-16 19:39:21 -0800464static __inline__ int __sk_nulls_del_node_init_rcu(struct sock *sk)
Eric Dumazet271b72c2008-10-29 02:11:14 -0700465{
466 if (sk_hashed(sk)) {
Eric Dumazet88ab1932008-11-16 19:39:21 -0800467 hlist_nulls_del_init_rcu(&sk->sk_nulls_node);
Eric Dumazet271b72c2008-10-29 02:11:14 -0700468 return 1;
469 }
470 return 0;
471}
472
Eric Dumazet88ab1932008-11-16 19:39:21 -0800473static __inline__ int sk_nulls_del_node_init_rcu(struct sock *sk)
Eric Dumazet271b72c2008-10-29 02:11:14 -0700474{
Eric Dumazet88ab1932008-11-16 19:39:21 -0800475 int rc = __sk_nulls_del_node_init_rcu(sk);
Eric Dumazet271b72c2008-10-29 02:11:14 -0700476
477 if (rc) {
478 /* paranoid for a while -acme */
479 WARN_ON(atomic_read(&sk->sk_refcnt) == 1);
480 __sock_put(sk);
481 }
482 return rc;
483}
484
Linus Torvalds1da177e2005-04-16 15:20:36 -0700485static __inline__ void __sk_add_node(struct sock *sk, struct hlist_head *list)
486{
487 hlist_add_head(&sk->sk_node, list);
488}
489
490static __inline__ void sk_add_node(struct sock *sk, struct hlist_head *list)
491{
492 sock_hold(sk);
493 __sk_add_node(sk, list);
494}
495
stephen hemminger808f5112010-02-22 07:57:18 +0000496static __inline__ void sk_add_node_rcu(struct sock *sk, struct hlist_head *list)
497{
498 sock_hold(sk);
499 hlist_add_head_rcu(&sk->sk_node, list);
500}
501
Eric Dumazet88ab1932008-11-16 19:39:21 -0800502static __inline__ void __sk_nulls_add_node_rcu(struct sock *sk, struct hlist_nulls_head *list)
Eric Dumazet271b72c2008-10-29 02:11:14 -0700503{
Eric Dumazet88ab1932008-11-16 19:39:21 -0800504 hlist_nulls_add_head_rcu(&sk->sk_nulls_node, list);
Eric Dumazet271b72c2008-10-29 02:11:14 -0700505}
506
Eric Dumazet88ab1932008-11-16 19:39:21 -0800507static __inline__ void sk_nulls_add_node_rcu(struct sock *sk, struct hlist_nulls_head *list)
Eric Dumazet271b72c2008-10-29 02:11:14 -0700508{
509 sock_hold(sk);
Eric Dumazet88ab1932008-11-16 19:39:21 -0800510 __sk_nulls_add_node_rcu(sk, list);
Eric Dumazet271b72c2008-10-29 02:11:14 -0700511}
512
Linus Torvalds1da177e2005-04-16 15:20:36 -0700513static __inline__ void __sk_del_bind_node(struct sock *sk)
514{
515 __hlist_del(&sk->sk_bind_node);
516}
517
518static __inline__ void sk_add_bind_node(struct sock *sk,
519 struct hlist_head *list)
520{
521 hlist_add_head(&sk->sk_bind_node, list);
522}
523
524#define sk_for_each(__sk, node, list) \
525 hlist_for_each_entry(__sk, node, list, sk_node)
stephen hemminger808f5112010-02-22 07:57:18 +0000526#define sk_for_each_rcu(__sk, node, list) \
527 hlist_for_each_entry_rcu(__sk, node, list, sk_node)
Eric Dumazet88ab1932008-11-16 19:39:21 -0800528#define sk_nulls_for_each(__sk, node, list) \
529 hlist_nulls_for_each_entry(__sk, node, list, sk_nulls_node)
530#define sk_nulls_for_each_rcu(__sk, node, list) \
531 hlist_nulls_for_each_entry_rcu(__sk, node, list, sk_nulls_node)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700532#define sk_for_each_from(__sk, node) \
533 if (__sk && ({ node = &(__sk)->sk_node; 1; })) \
534 hlist_for_each_entry_from(__sk, node, sk_node)
Eric Dumazet88ab1932008-11-16 19:39:21 -0800535#define sk_nulls_for_each_from(__sk, node) \
536 if (__sk && ({ node = &(__sk)->sk_nulls_node; 1; })) \
537 hlist_nulls_for_each_entry_from(__sk, node, sk_nulls_node)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700538#define sk_for_each_safe(__sk, node, tmp, list) \
539 hlist_for_each_entry_safe(__sk, node, tmp, list, sk_node)
540#define sk_for_each_bound(__sk, node, list) \
541 hlist_for_each_entry(__sk, node, list, sk_bind_node)
542
543/* Sock flags */
544enum sock_flags {
545 SOCK_DEAD,
546 SOCK_DONE,
547 SOCK_URGINLINE,
548 SOCK_KEEPOPEN,
549 SOCK_LINGER,
550 SOCK_DESTROY,
551 SOCK_BROADCAST,
552 SOCK_TIMESTAMP,
553 SOCK_ZAPPED,
554 SOCK_USE_WRITE_QUEUE, /* whether to call sk->sk_write_space in sock_wfree */
555 SOCK_DBG, /* %SO_DEBUG setting */
556 SOCK_RCVTSTAMP, /* %SO_TIMESTAMP setting */
Eric Dumazet92f37fd2007-03-25 22:14:49 -0700557 SOCK_RCVTSTAMPNS, /* %SO_TIMESTAMPNS setting */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700558 SOCK_LOCALROUTE, /* route locally only, %SO_DONTROUTE setting */
559 SOCK_QUEUE_SHRUNK, /* write queue has been shrunk recently */
Patrick Ohly20d49472009-02-12 05:03:38 +0000560 SOCK_TIMESTAMPING_TX_HARDWARE, /* %SOF_TIMESTAMPING_TX_HARDWARE */
561 SOCK_TIMESTAMPING_TX_SOFTWARE, /* %SOF_TIMESTAMPING_TX_SOFTWARE */
562 SOCK_TIMESTAMPING_RX_HARDWARE, /* %SOF_TIMESTAMPING_RX_HARDWARE */
563 SOCK_TIMESTAMPING_RX_SOFTWARE, /* %SOF_TIMESTAMPING_RX_SOFTWARE */
564 SOCK_TIMESTAMPING_SOFTWARE, /* %SOF_TIMESTAMPING_SOFTWARE */
565 SOCK_TIMESTAMPING_RAW_HARDWARE, /* %SOF_TIMESTAMPING_RAW_HARDWARE */
566 SOCK_TIMESTAMPING_SYS_HARDWARE, /* %SOF_TIMESTAMPING_SYS_HARDWARE */
Eric Dumazetbcdce712009-10-06 17:28:29 -0700567 SOCK_FASYNC, /* fasync() active */
Neil Horman3b885782009-10-12 13:26:31 -0700568 SOCK_RXQ_OVFL,
Shirley Ma1cdebb42011-07-06 12:17:30 +0000569 SOCK_ZEROCOPY, /* buffers from userspace */
Johannes Berg6e3e9392011-11-09 10:15:42 +0100570 SOCK_WIFI_STATUS, /* push wifi status to userspace */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700571};
572
Ralf Baechle53b924b2005-08-23 10:11:30 -0700573static inline void sock_copy_flags(struct sock *nsk, struct sock *osk)
574{
575 nsk->sk_flags = osk->sk_flags;
576}
577
Linus Torvalds1da177e2005-04-16 15:20:36 -0700578static inline void sock_set_flag(struct sock *sk, enum sock_flags flag)
579{
580 __set_bit(flag, &sk->sk_flags);
581}
582
583static inline void sock_reset_flag(struct sock *sk, enum sock_flags flag)
584{
585 __clear_bit(flag, &sk->sk_flags);
586}
587
588static inline int sock_flag(struct sock *sk, enum sock_flags flag)
589{
590 return test_bit(flag, &sk->sk_flags);
591}
592
593static inline void sk_acceptq_removed(struct sock *sk)
594{
595 sk->sk_ack_backlog--;
596}
597
598static inline void sk_acceptq_added(struct sock *sk)
599{
600 sk->sk_ack_backlog++;
601}
602
603static inline int sk_acceptq_is_full(struct sock *sk)
604{
David S. Miller64a14652007-03-06 11:21:05 -0800605 return sk->sk_ack_backlog > sk->sk_max_ack_backlog;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700606}
607
608/*
609 * Compute minimal free write space needed to queue new packets.
610 */
611static inline int sk_stream_min_wspace(struct sock *sk)
612{
Eric Dumazet8df09ea2007-12-21 03:07:41 -0800613 return sk->sk_wmem_queued >> 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700614}
615
616static inline int sk_stream_wspace(struct sock *sk)
617{
618 return sk->sk_sndbuf - sk->sk_wmem_queued;
619}
620
621extern void sk_stream_write_space(struct sock *sk);
622
623static inline int sk_stream_memory_free(struct sock *sk)
624{
625 return sk->sk_wmem_queued < sk->sk_sndbuf;
626}
627
Zhu Yi8eae9392010-03-04 18:01:40 +0000628/* OOB backlog add */
Zhu Yia3a858f2010-03-04 18:01:47 +0000629static inline void __sk_add_backlog(struct sock *sk, struct sk_buff *skb)
Stephen Hemminger9ee6b532005-11-08 09:39:42 -0800630{
Eric Dumazet7fee2262010-05-11 23:19:48 +0000631 /* dont let skb dst not refcounted, we are going to leave rcu lock */
632 skb_dst_force(skb);
633
634 if (!sk->sk_backlog.tail)
635 sk->sk_backlog.head = skb;
636 else
Stephen Hemminger9ee6b532005-11-08 09:39:42 -0800637 sk->sk_backlog.tail->next = skb;
Eric Dumazet7fee2262010-05-11 23:19:48 +0000638
639 sk->sk_backlog.tail = skb;
Stephen Hemminger9ee6b532005-11-08 09:39:42 -0800640 skb->next = NULL;
641}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700642
Eric Dumazetc3774112010-04-27 15:13:20 -0700643/*
644 * Take into account size of receive queue and backlog queue
645 */
646static inline bool sk_rcvqueues_full(const struct sock *sk, const struct sk_buff *skb)
647{
648 unsigned int qsize = sk->sk_backlog.len + atomic_read(&sk->sk_rmem_alloc);
649
650 return qsize + skb->truesize > sk->sk_rcvbuf;
651}
652
Zhu Yi8eae9392010-03-04 18:01:40 +0000653/* The per-socket spinlock must be held here. */
Zhu Yi40456352010-03-07 16:21:39 +0000654static inline __must_check int sk_add_backlog(struct sock *sk, struct sk_buff *skb)
Zhu Yi8eae9392010-03-04 18:01:40 +0000655{
Eric Dumazetc3774112010-04-27 15:13:20 -0700656 if (sk_rcvqueues_full(sk, skb))
Zhu Yi8eae9392010-03-04 18:01:40 +0000657 return -ENOBUFS;
658
Zhu Yia3a858f2010-03-04 18:01:47 +0000659 __sk_add_backlog(sk, skb);
Zhu Yi8eae9392010-03-04 18:01:40 +0000660 sk->sk_backlog.len += skb->truesize;
661 return 0;
662}
663
Peter Zijlstrac57943a2008-10-07 14:18:42 -0700664static inline int sk_backlog_rcv(struct sock *sk, struct sk_buff *skb)
665{
666 return sk->sk_backlog_rcv(sk, skb);
667}
668
David S. Millerc58dc012010-04-27 15:05:31 -0700669static inline void sock_rps_record_flow(const struct sock *sk)
670{
671#ifdef CONFIG_RPS
672 struct rps_sock_flow_table *sock_flow_table;
673
674 rcu_read_lock();
675 sock_flow_table = rcu_dereference(rps_sock_flow_table);
676 rps_record_sock_flow(sock_flow_table, sk->sk_rxhash);
677 rcu_read_unlock();
678#endif
679}
680
681static inline void sock_rps_reset_flow(const struct sock *sk)
682{
683#ifdef CONFIG_RPS
684 struct rps_sock_flow_table *sock_flow_table;
685
686 rcu_read_lock();
687 sock_flow_table = rcu_dereference(rps_sock_flow_table);
688 rps_reset_sock_flow(sock_flow_table, sk->sk_rxhash);
689 rcu_read_unlock();
690#endif
691}
692
Tom Herbertbdeab992011-08-14 19:45:55 +0000693static inline void sock_rps_save_rxhash(struct sock *sk,
694 const struct sk_buff *skb)
David S. Millerc58dc012010-04-27 15:05:31 -0700695{
696#ifdef CONFIG_RPS
Tom Herbertbdeab992011-08-14 19:45:55 +0000697 if (unlikely(sk->sk_rxhash != skb->rxhash)) {
David S. Millerc58dc012010-04-27 15:05:31 -0700698 sock_rps_reset_flow(sk);
Tom Herbertbdeab992011-08-14 19:45:55 +0000699 sk->sk_rxhash = skb->rxhash;
David S. Millerc58dc012010-04-27 15:05:31 -0700700 }
701#endif
702}
703
Tom Herbertbdeab992011-08-14 19:45:55 +0000704static inline void sock_rps_reset_rxhash(struct sock *sk)
705{
706#ifdef CONFIG_RPS
707 sock_rps_reset_flow(sk);
708 sk->sk_rxhash = 0;
709#endif
710}
711
Stephen Hemmingercfcabdc2007-10-09 01:59:42 -0700712#define sk_wait_event(__sk, __timeo, __condition) \
713 ({ int __rc; \
714 release_sock(__sk); \
715 __rc = __condition; \
716 if (!__rc) { \
717 *(__timeo) = schedule_timeout(*(__timeo)); \
718 } \
719 lock_sock(__sk); \
720 __rc = __condition; \
721 __rc; \
722 })
Linus Torvalds1da177e2005-04-16 15:20:36 -0700723
724extern int sk_stream_wait_connect(struct sock *sk, long *timeo_p);
725extern int sk_stream_wait_memory(struct sock *sk, long *timeo_p);
726extern void sk_stream_wait_close(struct sock *sk, long timeo_p);
727extern int sk_stream_error(struct sock *sk, int flags, int err);
728extern void sk_stream_kill_queues(struct sock *sk);
729
730extern int sk_wait_data(struct sock *sk, long *timeo);
731
Arnaldo Carvalho de Melo60236fd2005-06-18 22:47:21 -0700732struct request_sock_ops;
Arnaldo Carvalho de Melo6d6ee432005-12-13 23:25:19 -0800733struct timewait_sock_ops;
Arnaldo Carvalho de Meloab1e0a12008-02-03 04:06:04 -0800734struct inet_hashinfo;
Pavel Emelyanovfc8717b2008-03-22 16:56:51 -0700735struct raw_hashinfo;
Paul Gortmakerde477252011-05-26 13:46:22 -0400736struct module;
Arnaldo Carvalho de Melo2e6599c2005-06-18 22:46:52 -0700737
Linus Torvalds1da177e2005-04-16 15:20:36 -0700738/* Networking protocol blocks we attach to sockets.
739 * socket layer -> transport layer interface
740 * transport -> network interface is defined by struct inet_proto
741 */
742struct proto {
743 void (*close)(struct sock *sk,
744 long timeout);
745 int (*connect)(struct sock *sk,
746 struct sockaddr *uaddr,
747 int addr_len);
748 int (*disconnect)(struct sock *sk, int flags);
749
750 struct sock * (*accept) (struct sock *sk, int flags, int *err);
751
752 int (*ioctl)(struct sock *sk, int cmd,
753 unsigned long arg);
754 int (*init)(struct sock *sk);
Brian Haley7d06b2e2008-06-14 17:04:49 -0700755 void (*destroy)(struct sock *sk);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700756 void (*shutdown)(struct sock *sk, int how);
757 int (*setsockopt)(struct sock *sk, int level,
758 int optname, char __user *optval,
David S. Millerb7058842009-09-30 16:12:20 -0700759 unsigned int optlen);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700760 int (*getsockopt)(struct sock *sk, int level,
761 int optname, char __user *optval,
762 int __user *option);
Alexey Dobriyanaf01d532008-08-28 02:53:51 -0700763#ifdef CONFIG_COMPAT
Dmitry Mishin3fdadf72006-03-20 22:45:21 -0800764 int (*compat_setsockopt)(struct sock *sk,
765 int level,
766 int optname, char __user *optval,
David S. Millerb7058842009-09-30 16:12:20 -0700767 unsigned int optlen);
Dmitry Mishin3fdadf72006-03-20 22:45:21 -0800768 int (*compat_getsockopt)(struct sock *sk,
769 int level,
770 int optname, char __user *optval,
771 int __user *option);
Eric W. Biederman709b46e2011-01-29 16:15:56 +0000772 int (*compat_ioctl)(struct sock *sk,
773 unsigned int cmd, unsigned long arg);
Alexey Dobriyanaf01d532008-08-28 02:53:51 -0700774#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -0700775 int (*sendmsg)(struct kiocb *iocb, struct sock *sk,
776 struct msghdr *msg, size_t len);
777 int (*recvmsg)(struct kiocb *iocb, struct sock *sk,
778 struct msghdr *msg,
779 size_t len, int noblock, int flags,
780 int *addr_len);
781 int (*sendpage)(struct sock *sk, struct page *page,
782 int offset, size_t size, int flags);
783 int (*bind)(struct sock *sk,
784 struct sockaddr *uaddr, int addr_len);
785
786 int (*backlog_rcv) (struct sock *sk,
787 struct sk_buff *skb);
788
789 /* Keeping track of sk's, looking them up, and port selection methods. */
790 void (*hash)(struct sock *sk);
791 void (*unhash)(struct sock *sk);
Eric Dumazet719f8352010-09-08 05:08:44 +0000792 void (*rehash)(struct sock *sk);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700793 int (*get_port)(struct sock *sk, unsigned short snum);
Octavian Purdilafcbdf092010-12-16 14:26:56 -0800794 void (*clear_sk)(struct sock *sk, int size);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700795
Eric Dumazet286ab3d2007-11-05 23:38:39 -0800796 /* Keeping track of sockets in use */
Eric Dumazet65f76512008-01-03 20:46:48 -0800797#ifdef CONFIG_PROC_FS
Pavel Emelyanov13ff3d62008-03-28 16:38:17 -0700798 unsigned int inuse_idx;
Eric Dumazet65f76512008-01-03 20:46:48 -0800799#endif
Arnaldo Carvalho de Meloebb53d72007-11-21 22:08:50 +0800800
Linus Torvalds1da177e2005-04-16 15:20:36 -0700801 /* Memory pressure */
Pavel Emelyanov5c52ba12008-07-16 20:28:10 -0700802 void (*enter_memory_pressure)(struct sock *sk);
Eric Dumazet8d987e52010-11-09 23:24:26 +0000803 atomic_long_t *memory_allocated; /* Current allocated memory. */
Eric Dumazet17483762008-11-25 21:16:35 -0800804 struct percpu_counter *sockets_allocated; /* Current number of sockets. */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700805 /*
806 * Pressure flag: try to collapse.
807 * Technical note: it is used by multiple contexts non atomically.
Hideo Aoki3ab224b2007-12-31 00:11:19 -0800808 * All the __sk_mem_schedule() is of this nature: accounting
Linus Torvalds1da177e2005-04-16 15:20:36 -0700809 * is strict, actions are advisory and have some latency.
810 */
811 int *memory_pressure;
Eric Dumazet8d987e52010-11-09 23:24:26 +0000812 long *sysctl_mem;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700813 int *sysctl_wmem;
814 int *sysctl_rmem;
815 int max_header;
Changli Gao7ba42912010-07-10 20:41:55 +0000816 bool no_autobind;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700817
Eric Dumazet271b72c2008-10-29 02:11:14 -0700818 struct kmem_cache *slab;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700819 unsigned int obj_size;
Eric Dumazet271b72c2008-10-29 02:11:14 -0700820 int slab_flags;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700821
Eric Dumazetdd24c002008-11-25 21:17:14 -0800822 struct percpu_counter *orphan_count;
Arnaldo Carvalho de Melo8feaf0c02005-08-09 20:09:30 -0700823
Arnaldo Carvalho de Melo60236fd2005-06-18 22:47:21 -0700824 struct request_sock_ops *rsk_prot;
Arnaldo Carvalho de Melo6d6ee432005-12-13 23:25:19 -0800825 struct timewait_sock_ops *twsk_prot;
Arnaldo Carvalho de Melo2e6599c2005-06-18 22:46:52 -0700826
Pavel Emelyanov39d8cda2008-03-22 16:50:58 -0700827 union {
828 struct inet_hashinfo *hashinfo;
Eric Dumazet645ca702008-10-29 01:41:45 -0700829 struct udp_table *udp_table;
Pavel Emelyanovfc8717b2008-03-22 16:56:51 -0700830 struct raw_hashinfo *raw_hash;
Pavel Emelyanov39d8cda2008-03-22 16:50:58 -0700831 } h;
Arnaldo Carvalho de Meloab1e0a12008-02-03 04:06:04 -0800832
Linus Torvalds1da177e2005-04-16 15:20:36 -0700833 struct module *owner;
834
835 char name[32];
836
837 struct list_head node;
Arnaldo Carvalho de Meloe6848972005-08-09 19:45:38 -0700838#ifdef SOCK_REFCNT_DEBUG
839 atomic_t socks;
840#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -0700841};
842
843extern int proto_register(struct proto *prot, int alloc_slab);
844extern void proto_unregister(struct proto *prot);
845
Arnaldo Carvalho de Meloe6848972005-08-09 19:45:38 -0700846#ifdef SOCK_REFCNT_DEBUG
847static inline void sk_refcnt_debug_inc(struct sock *sk)
848{
849 atomic_inc(&sk->sk_prot->socks);
850}
851
852static inline void sk_refcnt_debug_dec(struct sock *sk)
853{
854 atomic_dec(&sk->sk_prot->socks);
855 printk(KERN_DEBUG "%s socket %p released, %d are still alive\n",
856 sk->sk_prot->name, sk, atomic_read(&sk->sk_prot->socks));
857}
858
859static inline void sk_refcnt_debug_release(const struct sock *sk)
860{
861 if (atomic_read(&sk->sk_refcnt) != 1)
862 printk(KERN_DEBUG "Destruction of the %s socket %p delayed, refcnt=%d\n",
863 sk->sk_prot->name, sk, atomic_read(&sk->sk_refcnt));
864}
865#else /* SOCK_REFCNT_DEBUG */
866#define sk_refcnt_debug_inc(sk) do { } while (0)
867#define sk_refcnt_debug_dec(sk) do { } while (0)
868#define sk_refcnt_debug_release(sk) do { } while (0)
869#endif /* SOCK_REFCNT_DEBUG */
870
Glauber Costa180d8cd2011-12-11 21:47:02 +0000871static inline bool sk_has_memory_pressure(const struct sock *sk)
872{
873 return sk->sk_prot->memory_pressure != NULL;
874}
875
876static inline bool sk_under_memory_pressure(const struct sock *sk)
877{
878 if (!sk->sk_prot->memory_pressure)
879 return false;
880 return !!*sk->sk_prot->memory_pressure;
881}
882
883static inline void sk_leave_memory_pressure(struct sock *sk)
884{
885 int *memory_pressure = sk->sk_prot->memory_pressure;
886
887 if (memory_pressure && *memory_pressure)
888 *memory_pressure = 0;
889}
890
891static inline void sk_enter_memory_pressure(struct sock *sk)
892{
893 if (sk->sk_prot->enter_memory_pressure)
894 sk->sk_prot->enter_memory_pressure(sk);
895}
896
897static inline long sk_prot_mem_limits(const struct sock *sk, int index)
898{
899 long *prot = sk->sk_prot->sysctl_mem;
900 return prot[index];
901}
902
903static inline long
904sk_memory_allocated(const struct sock *sk)
905{
906 struct proto *prot = sk->sk_prot;
907 return atomic_long_read(prot->memory_allocated);
908}
909
910static inline long
911sk_memory_allocated_add(struct sock *sk, int amt)
912{
913 struct proto *prot = sk->sk_prot;
914 return atomic_long_add_return(amt, prot->memory_allocated);
915}
916
917static inline void
918sk_memory_allocated_sub(struct sock *sk, int amt)
919{
920 struct proto *prot = sk->sk_prot;
921 atomic_long_sub(amt, prot->memory_allocated);
922}
923
924static inline void sk_sockets_allocated_dec(struct sock *sk)
925{
926 struct proto *prot = sk->sk_prot;
927 percpu_counter_dec(prot->sockets_allocated);
928}
929
930static inline void sk_sockets_allocated_inc(struct sock *sk)
931{
932 struct proto *prot = sk->sk_prot;
933 percpu_counter_inc(prot->sockets_allocated);
934}
935
936static inline int
937sk_sockets_allocated_read_positive(struct sock *sk)
938{
939 struct proto *prot = sk->sk_prot;
940
941 return percpu_counter_sum_positive(prot->sockets_allocated);
942}
943
944static inline int
945proto_sockets_allocated_sum_positive(struct proto *prot)
946{
947 return percpu_counter_sum_positive(prot->sockets_allocated);
948}
949
950static inline long
951proto_memory_allocated(struct proto *prot)
952{
953 return atomic_long_read(prot->memory_allocated);
954}
955
956static inline bool
957proto_memory_pressure(struct proto *prot)
958{
959 if (!prot->memory_pressure)
960 return false;
961 return !!*prot->memory_pressure;
962}
963
Eric Dumazet65f76512008-01-03 20:46:48 -0800964
965#ifdef CONFIG_PROC_FS
Linus Torvalds1da177e2005-04-16 15:20:36 -0700966/* Called with local bh disabled */
Pavel Emelyanovc29a0bc2008-03-31 19:41:46 -0700967extern void sock_prot_inuse_add(struct net *net, struct proto *prot, int inc);
968extern int sock_prot_inuse_get(struct net *net, struct proto *proto);
Eric Dumazet65f76512008-01-03 20:46:48 -0800969#else
Pavel Emelyanovc29a0bc2008-03-31 19:41:46 -0700970static void inline sock_prot_inuse_add(struct net *net, struct proto *prot,
971 int inc)
Eric Dumazet65f76512008-01-03 20:46:48 -0800972{
973}
Eric Dumazet65f76512008-01-03 20:46:48 -0800974#endif
975
Linus Torvalds1da177e2005-04-16 15:20:36 -0700976
Arnaldo Carvalho de Melo614c6cb2005-08-09 19:47:37 -0700977/* With per-bucket locks this operation is not-atomic, so that
978 * this version is not worse.
979 */
980static inline void __sk_prot_rehash(struct sock *sk)
981{
982 sk->sk_prot->unhash(sk);
983 sk->sk_prot->hash(sk);
984}
985
Octavian Purdilafcbdf092010-12-16 14:26:56 -0800986void sk_prot_clear_portaddr_nulls(struct sock *sk, int size);
987
Linus Torvalds1da177e2005-04-16 15:20:36 -0700988/* About 10 seconds */
989#define SOCK_DESTROY_TIME (10*HZ)
990
991/* Sockets 0-1023 can't be bound to unless you are superuser */
992#define PROT_SOCK 1024
993
994#define SHUTDOWN_MASK 3
995#define RCV_SHUTDOWN 1
996#define SEND_SHUTDOWN 2
997
998#define SOCK_SNDBUF_LOCK 1
999#define SOCK_RCVBUF_LOCK 2
1000#define SOCK_BINDADDR_LOCK 4
1001#define SOCK_BINDPORT_LOCK 8
1002
1003/* sock_iocb: used to kick off async processing of socket ios */
1004struct sock_iocb {
1005 struct list_head list;
1006
1007 int flags;
1008 int size;
1009 struct socket *sock;
1010 struct sock *sk;
1011 struct scm_cookie *scm;
1012 struct msghdr *msg, async_msg;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001013 struct kiocb *kiocb;
1014};
1015
1016static inline struct sock_iocb *kiocb_to_siocb(struct kiocb *iocb)
1017{
1018 return (struct sock_iocb *)iocb->private;
1019}
1020
1021static inline struct kiocb *siocb_to_kiocb(struct sock_iocb *si)
1022{
1023 return si->kiocb;
1024}
1025
1026struct socket_alloc {
1027 struct socket socket;
1028 struct inode vfs_inode;
1029};
1030
1031static inline struct socket *SOCKET_I(struct inode *inode)
1032{
1033 return &container_of(inode, struct socket_alloc, vfs_inode)->socket;
1034}
1035
1036static inline struct inode *SOCK_INODE(struct socket *socket)
1037{
1038 return &container_of(socket, struct socket_alloc, socket)->vfs_inode;
1039}
1040
Hideo Aoki3ab224b2007-12-31 00:11:19 -08001041/*
1042 * Functions for memory accounting
1043 */
1044extern int __sk_mem_schedule(struct sock *sk, int size, int kind);
1045extern void __sk_mem_reclaim(struct sock *sk);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001046
Hideo Aoki3ab224b2007-12-31 00:11:19 -08001047#define SK_MEM_QUANTUM ((int)PAGE_SIZE)
1048#define SK_MEM_QUANTUM_SHIFT ilog2(SK_MEM_QUANTUM)
1049#define SK_MEM_SEND 0
1050#define SK_MEM_RECV 1
Linus Torvalds1da177e2005-04-16 15:20:36 -07001051
Hideo Aoki3ab224b2007-12-31 00:11:19 -08001052static inline int sk_mem_pages(int amt)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001053{
Hideo Aoki3ab224b2007-12-31 00:11:19 -08001054 return (amt + SK_MEM_QUANTUM - 1) >> SK_MEM_QUANTUM_SHIFT;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001055}
1056
Hideo Aoki3ab224b2007-12-31 00:11:19 -08001057static inline int sk_has_account(struct sock *sk)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001058{
Hideo Aoki3ab224b2007-12-31 00:11:19 -08001059 /* return true if protocol supports memory accounting */
1060 return !!sk->sk_prot->memory_allocated;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001061}
1062
Hideo Aoki3ab224b2007-12-31 00:11:19 -08001063static inline int sk_wmem_schedule(struct sock *sk, int size)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001064{
Hideo Aoki3ab224b2007-12-31 00:11:19 -08001065 if (!sk_has_account(sk))
1066 return 1;
Herbert Xud80d99d62005-09-01 17:48:23 -07001067 return size <= sk->sk_forward_alloc ||
Hideo Aoki3ab224b2007-12-31 00:11:19 -08001068 __sk_mem_schedule(sk, size, SK_MEM_SEND);
1069}
1070
1071static inline int sk_rmem_schedule(struct sock *sk, int size)
1072{
1073 if (!sk_has_account(sk))
1074 return 1;
1075 return size <= sk->sk_forward_alloc ||
1076 __sk_mem_schedule(sk, size, SK_MEM_RECV);
1077}
1078
1079static inline void sk_mem_reclaim(struct sock *sk)
1080{
1081 if (!sk_has_account(sk))
1082 return;
1083 if (sk->sk_forward_alloc >= SK_MEM_QUANTUM)
1084 __sk_mem_reclaim(sk);
1085}
1086
David S. Miller9993e7d2008-01-10 21:56:38 -08001087static inline void sk_mem_reclaim_partial(struct sock *sk)
1088{
1089 if (!sk_has_account(sk))
1090 return;
1091 if (sk->sk_forward_alloc > SK_MEM_QUANTUM)
1092 __sk_mem_reclaim(sk);
1093}
1094
Hideo Aoki3ab224b2007-12-31 00:11:19 -08001095static inline void sk_mem_charge(struct sock *sk, int size)
1096{
1097 if (!sk_has_account(sk))
1098 return;
1099 sk->sk_forward_alloc -= size;
1100}
1101
1102static inline void sk_mem_uncharge(struct sock *sk, int size)
1103{
1104 if (!sk_has_account(sk))
1105 return;
1106 sk->sk_forward_alloc += size;
1107}
1108
1109static inline void sk_wmem_free_skb(struct sock *sk, struct sk_buff *skb)
1110{
Hideo Aoki3ab224b2007-12-31 00:11:19 -08001111 sock_set_flag(sk, SOCK_QUEUE_SHRUNK);
1112 sk->sk_wmem_queued -= skb->truesize;
1113 sk_mem_uncharge(sk, skb->truesize);
1114 __kfree_skb(skb);
Herbert Xud80d99d62005-09-01 17:48:23 -07001115}
1116
Linus Torvalds1da177e2005-04-16 15:20:36 -07001117/* Used by processes to "lock" a socket state, so that
1118 * interrupts and bottom half handlers won't change it
1119 * from under us. It essentially blocks any incoming
1120 * packets, so that we won't get any new data or any
1121 * packets that change the state of the socket.
1122 *
1123 * While locked, BH processing will add new packets to
1124 * the backlog queue. This queue is processed by the
1125 * owner of the socket lock right before it is released.
1126 *
1127 * Since ~2.3.5 it is also exclusive sleep lock serializing
1128 * accesses from user process context.
1129 */
John Heffnerd2e91172007-09-12 10:44:19 +02001130#define sock_owned_by_user(sk) ((sk)->sk_lock.owned)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001131
Peter Zijlstraed075362006-12-06 20:35:24 -08001132/*
1133 * Macro so as to not evaluate some arguments when
1134 * lockdep is not enabled.
1135 *
1136 * Mark both the sk_lock and the sk_lock.slock as a
1137 * per-address-family lock class.
1138 */
1139#define sock_lock_init_class_and_name(sk, sname, skey, name, key) \
1140do { \
Ingo Molnare8f6fbf2008-11-12 01:38:36 +00001141 sk->sk_lock.owned = 0; \
Peter Zijlstraed075362006-12-06 20:35:24 -08001142 init_waitqueue_head(&sk->sk_lock.wq); \
1143 spin_lock_init(&(sk)->sk_lock.slock); \
1144 debug_check_no_locks_freed((void *)&(sk)->sk_lock, \
1145 sizeof((sk)->sk_lock)); \
1146 lockdep_set_class_and_name(&(sk)->sk_lock.slock, \
1147 (skey), (sname)); \
1148 lockdep_init_map(&(sk)->sk_lock.dep_map, (name), (key), 0); \
1149} while (0)
1150
Harvey Harrison41380932007-12-12 10:46:51 -08001151extern void lock_sock_nested(struct sock *sk, int subclass);
Peter Zijlstrafcc70d52006-11-08 22:44:35 -08001152
1153static inline void lock_sock(struct sock *sk)
1154{
1155 lock_sock_nested(sk, 0);
1156}
1157
Harvey Harrison41380932007-12-12 10:46:51 -08001158extern void release_sock(struct sock *sk);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001159
1160/* BH context may only use the following locking interface. */
1161#define bh_lock_sock(__sk) spin_lock(&((__sk)->sk_lock.slock))
Ingo Molnarc6366182006-07-03 00:25:13 -07001162#define bh_lock_sock_nested(__sk) \
1163 spin_lock_nested(&((__sk)->sk_lock.slock), \
1164 SINGLE_DEPTH_NESTING)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001165#define bh_unlock_sock(__sk) spin_unlock(&((__sk)->sk_lock.slock))
1166
Eric Dumazet8a74ad62010-05-26 19:20:18 +00001167extern bool lock_sock_fast(struct sock *sk);
1168/**
1169 * unlock_sock_fast - complement of lock_sock_fast
1170 * @sk: socket
1171 * @slow: slow mode
1172 *
1173 * fast unlock socket for user context.
1174 * If slow mode is on, we call regular release_sock()
1175 */
1176static inline void unlock_sock_fast(struct sock *sk, bool slow)
Eric Dumazet4b0b72f2010-04-28 14:35:48 -07001177{
Eric Dumazet8a74ad62010-05-26 19:20:18 +00001178 if (slow)
1179 release_sock(sk);
1180 else
1181 spin_unlock_bh(&sk->sk_lock.slock);
Eric Dumazet4b0b72f2010-04-28 14:35:48 -07001182}
1183
Eric Dumazet4b0b72f2010-04-28 14:35:48 -07001184
Eric W. Biederman1b8d7ae2007-10-08 23:24:22 -07001185extern struct sock *sk_alloc(struct net *net, int family,
Al Virodd0fc662005-10-07 07:46:04 +01001186 gfp_t priority,
Pavel Emelyanov6257ff22007-11-01 00:39:31 -07001187 struct proto *prot);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001188extern void sk_free(struct sock *sk);
Denis V. Lunevedf02082008-02-29 11:18:32 -08001189extern void sk_release_kernel(struct sock *sk);
Eric Dumazete56c57d2011-11-08 17:07:07 -05001190extern struct sock *sk_clone_lock(const struct sock *sk,
1191 const gfp_t priority);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001192
1193extern struct sk_buff *sock_wmalloc(struct sock *sk,
1194 unsigned long size, int force,
Al Virodd0fc662005-10-07 07:46:04 +01001195 gfp_t priority);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001196extern struct sk_buff *sock_rmalloc(struct sock *sk,
1197 unsigned long size, int force,
Al Virodd0fc662005-10-07 07:46:04 +01001198 gfp_t priority);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001199extern void sock_wfree(struct sk_buff *skb);
1200extern void sock_rfree(struct sk_buff *skb);
1201
1202extern int sock_setsockopt(struct socket *sock, int level,
1203 int op, char __user *optval,
David S. Millerb7058842009-09-30 16:12:20 -07001204 unsigned int optlen);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001205
1206extern int sock_getsockopt(struct socket *sock, int level,
1207 int op, char __user *optval,
1208 int __user *optlen);
1209extern struct sk_buff *sock_alloc_send_skb(struct sock *sk,
1210 unsigned long size,
1211 int noblock,
1212 int *errcode);
Herbert Xu4cc7f682009-02-04 16:55:54 -08001213extern struct sk_buff *sock_alloc_send_pskb(struct sock *sk,
1214 unsigned long header_len,
1215 unsigned long data_len,
1216 int noblock,
1217 int *errcode);
Victor Fusco86a76ca2005-07-08 14:57:47 -07001218extern void *sock_kmalloc(struct sock *sk, int size,
Al Virodd0fc662005-10-07 07:46:04 +01001219 gfp_t priority);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001220extern void sock_kfree_s(struct sock *sk, void *mem, int size);
1221extern void sk_send_sigurg(struct sock *sk);
1222
Herbert Xuf8451722010-05-24 00:12:34 -07001223#ifdef CONFIG_CGROUPS
1224extern void sock_update_classid(struct sock *sk);
1225#else
1226static inline void sock_update_classid(struct sock *sk)
1227{
1228}
1229#endif
1230
Linus Torvalds1da177e2005-04-16 15:20:36 -07001231/*
1232 * Functions to fill in entries in struct proto_ops when a protocol
1233 * does not implement a particular function.
1234 */
1235extern int sock_no_bind(struct socket *,
1236 struct sockaddr *, int);
1237extern int sock_no_connect(struct socket *,
1238 struct sockaddr *, int, int);
1239extern int sock_no_socketpair(struct socket *,
1240 struct socket *);
1241extern int sock_no_accept(struct socket *,
1242 struct socket *, int);
1243extern int sock_no_getname(struct socket *,
1244 struct sockaddr *, int *, int);
1245extern unsigned int sock_no_poll(struct file *, struct socket *,
1246 struct poll_table_struct *);
1247extern int sock_no_ioctl(struct socket *, unsigned int,
1248 unsigned long);
1249extern int sock_no_listen(struct socket *, int);
1250extern int sock_no_shutdown(struct socket *, int);
1251extern int sock_no_getsockopt(struct socket *, int , int,
1252 char __user *, int __user *);
1253extern int sock_no_setsockopt(struct socket *, int, int,
David S. Millerb7058842009-09-30 16:12:20 -07001254 char __user *, unsigned int);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001255extern int sock_no_sendmsg(struct kiocb *, struct socket *,
1256 struct msghdr *, size_t);
1257extern int sock_no_recvmsg(struct kiocb *, struct socket *,
1258 struct msghdr *, size_t, int);
1259extern int sock_no_mmap(struct file *file,
1260 struct socket *sock,
1261 struct vm_area_struct *vma);
1262extern ssize_t sock_no_sendpage(struct socket *sock,
1263 struct page *page,
1264 int offset, size_t size,
1265 int flags);
1266
1267/*
1268 * Functions to fill in entries in struct proto_ops when a protocol
1269 * uses the inet style.
1270 */
1271extern int sock_common_getsockopt(struct socket *sock, int level, int optname,
1272 char __user *optval, int __user *optlen);
1273extern int sock_common_recvmsg(struct kiocb *iocb, struct socket *sock,
1274 struct msghdr *msg, size_t size, int flags);
1275extern int sock_common_setsockopt(struct socket *sock, int level, int optname,
David S. Millerb7058842009-09-30 16:12:20 -07001276 char __user *optval, unsigned int optlen);
Dmitry Mishin3fdadf72006-03-20 22:45:21 -08001277extern int compat_sock_common_getsockopt(struct socket *sock, int level,
1278 int optname, char __user *optval, int __user *optlen);
1279extern int compat_sock_common_setsockopt(struct socket *sock, int level,
David S. Millerb7058842009-09-30 16:12:20 -07001280 int optname, char __user *optval, unsigned int optlen);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001281
1282extern void sk_common_release(struct sock *sk);
1283
1284/*
1285 * Default socket callbacks and setup code
1286 */
1287
1288/* Initialise core socket variables */
1289extern void sock_init_data(struct socket *sock, struct sock *sk);
1290
Eric Dumazet46bcf142010-12-06 09:29:43 -08001291extern void sk_filter_release_rcu(struct rcu_head *rcu);
1292
Linus Torvalds1da177e2005-04-16 15:20:36 -07001293/**
Ben Hutchings1a5778a2010-02-14 22:35:47 -08001294 * sk_filter_release - release a socket filter
Paul Bonserdc9b3342006-11-23 17:56:13 -08001295 * @fp: filter to remove
1296 *
1297 * Remove a filter from a socket and release its resources.
1298 */
1299
Pavel Emelyanov309dd5f2007-10-17 21:21:51 -07001300static inline void sk_filter_release(struct sk_filter *fp)
1301{
1302 if (atomic_dec_and_test(&fp->refcnt))
Eric Dumazet80f8f102011-01-18 07:46:52 +00001303 call_rcu(&fp->rcu, sk_filter_release_rcu);
Pavel Emelyanov309dd5f2007-10-17 21:21:51 -07001304}
1305
1306static inline void sk_filter_uncharge(struct sock *sk, struct sk_filter *fp)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001307{
1308 unsigned int size = sk_filter_len(fp);
1309
1310 atomic_sub(size, &sk->sk_omem_alloc);
Pavel Emelyanov309dd5f2007-10-17 21:21:51 -07001311 sk_filter_release(fp);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001312}
1313
1314static inline void sk_filter_charge(struct sock *sk, struct sk_filter *fp)
1315{
1316 atomic_inc(&fp->refcnt);
1317 atomic_add(sk_filter_len(fp), &sk->sk_omem_alloc);
1318}
1319
1320/*
1321 * Socket reference counting postulates.
1322 *
1323 * * Each user of socket SHOULD hold a reference count.
1324 * * Each access point to socket (an hash table bucket, reference from a list,
1325 * running timer, skb in flight MUST hold a reference count.
1326 * * When reference count hits 0, it means it will never increase back.
1327 * * When reference count hits 0, it means that no references from
1328 * outside exist to this socket and current process on current CPU
1329 * is last user and may/should destroy this socket.
1330 * * sk_free is called from any context: process, BH, IRQ. When
1331 * it is called, socket has no references from outside -> sk_free
1332 * may release descendant resources allocated by the socket, but
1333 * to the time when it is called, socket is NOT referenced by any
1334 * hash tables, lists etc.
1335 * * Packets, delivered from outside (from network or from another process)
1336 * and enqueued on receive/error queues SHOULD NOT grab reference count,
1337 * when they sit in queue. Otherwise, packets will leak to hole, when
1338 * socket is looked up by one cpu and unhasing is made by another CPU.
1339 * It is true for udp/raw, netlink (leak to receive and error queues), tcp
1340 * (leak to backlog). Packet socket does all the processing inside
1341 * BR_NETPROTO_LOCK, so that it has not this race condition. UNIX sockets
1342 * use separate SMP lock, so that they are prone too.
1343 */
1344
1345/* Ungrab socket and destroy it, if it was the last reference. */
1346static inline void sock_put(struct sock *sk)
1347{
1348 if (atomic_dec_and_test(&sk->sk_refcnt))
1349 sk_free(sk);
1350}
1351
Arnaldo Carvalho de Melo58a5a7b2006-11-16 14:06:06 -02001352extern int sk_receive_skb(struct sock *sk, struct sk_buff *skb,
1353 const int nested);
Arnaldo Carvalho de Melo25995ff2005-12-27 02:42:22 -02001354
Krishna Kumare022f0b2009-10-19 23:46:20 +00001355static inline void sk_tx_queue_set(struct sock *sk, int tx_queue)
1356{
1357 sk->sk_tx_queue_mapping = tx_queue;
1358}
1359
1360static inline void sk_tx_queue_clear(struct sock *sk)
1361{
1362 sk->sk_tx_queue_mapping = -1;
1363}
1364
1365static inline int sk_tx_queue_get(const struct sock *sk)
1366{
Tom Herbertb0f77d02010-07-14 20:50:29 -07001367 return sk ? sk->sk_tx_queue_mapping : -1;
Krishna Kumare022f0b2009-10-19 23:46:20 +00001368}
1369
David S. Miller972692e2008-06-17 22:41:38 -07001370static inline void sk_set_socket(struct sock *sk, struct socket *sock)
1371{
Krishna Kumare022f0b2009-10-19 23:46:20 +00001372 sk_tx_queue_clear(sk);
David S. Miller972692e2008-06-17 22:41:38 -07001373 sk->sk_socket = sock;
1374}
1375
Eric Dumazetaa395142010-04-20 13:03:51 +00001376static inline wait_queue_head_t *sk_sleep(struct sock *sk)
1377{
Eric Dumazeteaefd112011-02-18 03:26:36 +00001378 BUILD_BUG_ON(offsetof(struct socket_wq, wait) != 0);
1379 return &rcu_dereference_raw(sk->sk_wq)->wait;
Eric Dumazetaa395142010-04-20 13:03:51 +00001380}
Linus Torvalds1da177e2005-04-16 15:20:36 -07001381/* Detach socket from process context.
1382 * Announce socket dead, detach it from wait queue and inode.
1383 * Note that parent inode held reference count on this struct sock,
1384 * we do not release it in this function, because protocol
1385 * probably wants some additional cleanups or even continuing
1386 * to work with this socket (TCP).
1387 */
1388static inline void sock_orphan(struct sock *sk)
1389{
1390 write_lock_bh(&sk->sk_callback_lock);
1391 sock_set_flag(sk, SOCK_DEAD);
David S. Miller972692e2008-06-17 22:41:38 -07001392 sk_set_socket(sk, NULL);
Eric Dumazet43815482010-04-29 11:01:49 +00001393 sk->sk_wq = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001394 write_unlock_bh(&sk->sk_callback_lock);
1395}
1396
1397static inline void sock_graft(struct sock *sk, struct socket *parent)
1398{
1399 write_lock_bh(&sk->sk_callback_lock);
Eric Dumazeteaefd112011-02-18 03:26:36 +00001400 sk->sk_wq = parent->wq;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001401 parent->sk = sk;
David S. Miller972692e2008-06-17 22:41:38 -07001402 sk_set_socket(sk, parent);
Venkat Yekkirala4237c752006-07-24 23:32:50 -07001403 security_sock_graft(sk, parent);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001404 write_unlock_bh(&sk->sk_callback_lock);
1405}
1406
1407extern int sock_i_uid(struct sock *sk);
1408extern unsigned long sock_i_ino(struct sock *sk);
1409
1410static inline struct dst_entry *
1411__sk_dst_get(struct sock *sk)
1412{
Michal Hockod8bf4ca2011-07-08 14:39:41 +02001413 return rcu_dereference_check(sk->sk_dst_cache, sock_owned_by_user(sk) ||
Eric Dumazetf68c2242010-04-22 16:06:59 -07001414 lockdep_is_held(&sk->sk_lock.slock));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001415}
1416
1417static inline struct dst_entry *
1418sk_dst_get(struct sock *sk)
1419{
1420 struct dst_entry *dst;
1421
Eric Dumazetb6c67122010-04-08 23:03:29 +00001422 rcu_read_lock();
1423 dst = rcu_dereference(sk->sk_dst_cache);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001424 if (dst)
1425 dst_hold(dst);
Eric Dumazetb6c67122010-04-08 23:03:29 +00001426 rcu_read_unlock();
Linus Torvalds1da177e2005-04-16 15:20:36 -07001427 return dst;
1428}
1429
Eric Dumazetb6c67122010-04-08 23:03:29 +00001430extern void sk_reset_txq(struct sock *sk);
1431
1432static inline void dst_negative_advice(struct sock *sk)
1433{
1434 struct dst_entry *ndst, *dst = __sk_dst_get(sk);
1435
1436 if (dst && dst->ops->negative_advice) {
1437 ndst = dst->ops->negative_advice(dst);
1438
1439 if (ndst != dst) {
1440 rcu_assign_pointer(sk->sk_dst_cache, ndst);
1441 sk_reset_txq(sk);
1442 }
1443 }
1444}
1445
Linus Torvalds1da177e2005-04-16 15:20:36 -07001446static inline void
1447__sk_dst_set(struct sock *sk, struct dst_entry *dst)
1448{
1449 struct dst_entry *old_dst;
1450
Krishna Kumare022f0b2009-10-19 23:46:20 +00001451 sk_tx_queue_clear(sk);
Eric Dumazet0b53ff22010-04-26 20:40:43 +00001452 /*
1453 * This can be called while sk is owned by the caller only,
1454 * with no state that can be checked in a rcu_dereference_check() cond
1455 */
1456 old_dst = rcu_dereference_raw(sk->sk_dst_cache);
Eric Dumazetb6c67122010-04-08 23:03:29 +00001457 rcu_assign_pointer(sk->sk_dst_cache, dst);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001458 dst_release(old_dst);
1459}
1460
1461static inline void
1462sk_dst_set(struct sock *sk, struct dst_entry *dst)
1463{
Eric Dumazetb6c67122010-04-08 23:03:29 +00001464 spin_lock(&sk->sk_dst_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001465 __sk_dst_set(sk, dst);
Eric Dumazetb6c67122010-04-08 23:03:29 +00001466 spin_unlock(&sk->sk_dst_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001467}
1468
1469static inline void
1470__sk_dst_reset(struct sock *sk)
1471{
Eric Dumazetb6c67122010-04-08 23:03:29 +00001472 __sk_dst_set(sk, NULL);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001473}
1474
1475static inline void
1476sk_dst_reset(struct sock *sk)
1477{
Eric Dumazetb6c67122010-04-08 23:03:29 +00001478 spin_lock(&sk->sk_dst_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001479 __sk_dst_reset(sk);
Eric Dumazetb6c67122010-04-08 23:03:29 +00001480 spin_unlock(&sk->sk_dst_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001481}
1482
Denis Vlasenkof0088a52006-03-28 01:08:21 -08001483extern struct dst_entry *__sk_dst_check(struct sock *sk, u32 cookie);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001484
Denis Vlasenkof0088a52006-03-28 01:08:21 -08001485extern struct dst_entry *sk_dst_check(struct sock *sk, u32 cookie);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001486
Herbert Xubcd76112006-06-30 13:36:35 -07001487static inline int sk_can_gso(const struct sock *sk)
1488{
1489 return net_gso_ok(sk->sk_route_caps, sk->sk_gso_type);
1490}
1491
Andi Kleen99580892007-04-20 17:12:43 -07001492extern void sk_setup_caps(struct sock *sk, struct dst_entry *dst);
Arnaldo Carvalho de Melo6cbb0df2005-08-09 19:49:02 -07001493
Michał Mirosławc8f44af2011-11-15 15:29:55 +00001494static inline void sk_nocaps_add(struct sock *sk, netdev_features_t flags)
Eric Dumazeta4654192010-05-16 00:36:33 -07001495{
1496 sk->sk_route_nocaps |= flags;
1497 sk->sk_route_caps &= ~flags;
1498}
1499
Tom Herbertc6e1a0d2011-04-04 22:30:30 -07001500static inline int skb_do_copy_data_nocache(struct sock *sk, struct sk_buff *skb,
1501 char __user *from, char *to,
Wei Yongjun912d3982011-04-06 18:40:12 +00001502 int copy, int offset)
Tom Herbertc6e1a0d2011-04-04 22:30:30 -07001503{
1504 if (skb->ip_summed == CHECKSUM_NONE) {
1505 int err = 0;
1506 __wsum csum = csum_and_copy_from_user(from, to, copy, 0, &err);
1507 if (err)
1508 return err;
Wei Yongjun912d3982011-04-06 18:40:12 +00001509 skb->csum = csum_block_add(skb->csum, csum, offset);
Tom Herbertc6e1a0d2011-04-04 22:30:30 -07001510 } else if (sk->sk_route_caps & NETIF_F_NOCACHE_COPY) {
1511 if (!access_ok(VERIFY_READ, from, copy) ||
1512 __copy_from_user_nocache(to, from, copy))
1513 return -EFAULT;
1514 } else if (copy_from_user(to, from, copy))
1515 return -EFAULT;
1516
1517 return 0;
1518}
1519
1520static inline int skb_add_data_nocache(struct sock *sk, struct sk_buff *skb,
1521 char __user *from, int copy)
1522{
Wei Yongjun912d3982011-04-06 18:40:12 +00001523 int err, offset = skb->len;
Tom Herbertc6e1a0d2011-04-04 22:30:30 -07001524
Wei Yongjun912d3982011-04-06 18:40:12 +00001525 err = skb_do_copy_data_nocache(sk, skb, from, skb_put(skb, copy),
1526 copy, offset);
Tom Herbertc6e1a0d2011-04-04 22:30:30 -07001527 if (err)
Wei Yongjun912d3982011-04-06 18:40:12 +00001528 __skb_trim(skb, offset);
Tom Herbertc6e1a0d2011-04-04 22:30:30 -07001529
1530 return err;
1531}
1532
1533static inline int skb_copy_to_page_nocache(struct sock *sk, char __user *from,
1534 struct sk_buff *skb,
1535 struct page *page,
1536 int off, int copy)
1537{
1538 int err;
1539
Wei Yongjun912d3982011-04-06 18:40:12 +00001540 err = skb_do_copy_data_nocache(sk, skb, from, page_address(page) + off,
1541 copy, skb->len);
Tom Herbertc6e1a0d2011-04-04 22:30:30 -07001542 if (err)
1543 return err;
1544
1545 skb->len += copy;
1546 skb->data_len += copy;
1547 skb->truesize += copy;
1548 sk->sk_wmem_queued += copy;
1549 sk_mem_charge(sk, copy);
1550 return 0;
1551}
1552
Linus Torvalds1da177e2005-04-16 15:20:36 -07001553static inline int skb_copy_to_page(struct sock *sk, char __user *from,
1554 struct sk_buff *skb, struct page *page,
1555 int off, int copy)
1556{
1557 if (skb->ip_summed == CHECKSUM_NONE) {
1558 int err = 0;
Al Viro50842052006-11-14 21:36:34 -08001559 __wsum csum = csum_and_copy_from_user(from,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001560 page_address(page) + off,
1561 copy, 0, &err);
1562 if (err)
1563 return err;
1564 skb->csum = csum_block_add(skb->csum, csum, skb->len);
1565 } else if (copy_from_user(page_address(page) + off, from, copy))
1566 return -EFAULT;
1567
1568 skb->len += copy;
1569 skb->data_len += copy;
1570 skb->truesize += copy;
1571 sk->sk_wmem_queued += copy;
Hideo Aoki3ab224b2007-12-31 00:11:19 -08001572 sk_mem_charge(sk, copy);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001573 return 0;
1574}
1575
Eric Dumazetc5640392009-06-16 10:12:03 +00001576/**
1577 * sk_wmem_alloc_get - returns write allocations
1578 * @sk: socket
1579 *
1580 * Returns sk_wmem_alloc minus initial offset of one
1581 */
1582static inline int sk_wmem_alloc_get(const struct sock *sk)
1583{
1584 return atomic_read(&sk->sk_wmem_alloc) - 1;
1585}
1586
1587/**
1588 * sk_rmem_alloc_get - returns read allocations
1589 * @sk: socket
1590 *
1591 * Returns sk_rmem_alloc
1592 */
1593static inline int sk_rmem_alloc_get(const struct sock *sk)
1594{
1595 return atomic_read(&sk->sk_rmem_alloc);
1596}
1597
1598/**
1599 * sk_has_allocations - check if allocations are outstanding
1600 * @sk: socket
1601 *
1602 * Returns true if socket has write or read allocations
1603 */
1604static inline int sk_has_allocations(const struct sock *sk)
1605{
1606 return sk_wmem_alloc_get(sk) || sk_rmem_alloc_get(sk);
1607}
1608
Jiri Olsaa57de0b2009-07-08 12:09:13 +00001609/**
Eric Dumazet43815482010-04-29 11:01:49 +00001610 * wq_has_sleeper - check if there are any waiting processes
Randy Dunlapacfbe962010-05-24 23:54:18 -07001611 * @wq: struct socket_wq
Jiri Olsaa57de0b2009-07-08 12:09:13 +00001612 *
Eric Dumazet43815482010-04-29 11:01:49 +00001613 * Returns true if socket_wq has waiting processes
Jiri Olsaa57de0b2009-07-08 12:09:13 +00001614 *
Eric Dumazet43815482010-04-29 11:01:49 +00001615 * The purpose of the wq_has_sleeper and sock_poll_wait is to wrap the memory
Jiri Olsaa57de0b2009-07-08 12:09:13 +00001616 * barrier call. They were added due to the race found within the tcp code.
1617 *
1618 * Consider following tcp code paths:
1619 *
1620 * CPU1 CPU2
1621 *
1622 * sys_select receive packet
1623 * ... ...
1624 * __add_wait_queue update tp->rcv_nxt
1625 * ... ...
1626 * tp->rcv_nxt check sock_def_readable
1627 * ... {
Eric Dumazet43815482010-04-29 11:01:49 +00001628 * schedule rcu_read_lock();
1629 * wq = rcu_dereference(sk->sk_wq);
1630 * if (wq && waitqueue_active(&wq->wait))
1631 * wake_up_interruptible(&wq->wait)
Jiri Olsaa57de0b2009-07-08 12:09:13 +00001632 * ...
1633 * }
1634 *
1635 * The race for tcp fires when the __add_wait_queue changes done by CPU1 stay
1636 * in its cache, and so does the tp->rcv_nxt update on CPU2 side. The CPU1
1637 * could then endup calling schedule and sleep forever if there are no more
1638 * data on the socket.
Jiri Olsaad462762009-07-08 12:10:31 +00001639 *
Jiri Olsaa57de0b2009-07-08 12:09:13 +00001640 */
Eric Dumazet43815482010-04-29 11:01:49 +00001641static inline bool wq_has_sleeper(struct socket_wq *wq)
Jiri Olsaa57de0b2009-07-08 12:09:13 +00001642{
Eric Dumazet43815482010-04-29 11:01:49 +00001643
Jiri Olsaa57de0b2009-07-08 12:09:13 +00001644 /*
1645 * We need to be sure we are in sync with the
1646 * add_wait_queue modifications to the wait queue.
1647 *
1648 * This memory barrier is paired in the sock_poll_wait.
1649 */
Eric Dumazet43815482010-04-29 11:01:49 +00001650 smp_mb();
1651 return wq && waitqueue_active(&wq->wait);
Jiri Olsaa57de0b2009-07-08 12:09:13 +00001652}
1653
1654/**
1655 * sock_poll_wait - place memory barrier behind the poll_wait call.
1656 * @filp: file
1657 * @wait_address: socket wait queue
1658 * @p: poll_table
1659 *
Eric Dumazet43815482010-04-29 11:01:49 +00001660 * See the comments in the wq_has_sleeper function.
Jiri Olsaa57de0b2009-07-08 12:09:13 +00001661 */
1662static inline void sock_poll_wait(struct file *filp,
1663 wait_queue_head_t *wait_address, poll_table *p)
1664{
1665 if (p && wait_address) {
1666 poll_wait(filp, wait_address, p);
1667 /*
1668 * We need to be sure we are in sync with the
1669 * socket flags modification.
1670 *
Eric Dumazet43815482010-04-29 11:01:49 +00001671 * This memory barrier is paired in the wq_has_sleeper.
Jiri Olsaa57de0b2009-07-08 12:09:13 +00001672 */
1673 smp_mb();
1674 }
1675}
1676
Linus Torvalds1da177e2005-04-16 15:20:36 -07001677/*
1678 * Queue a received datagram if it will fit. Stream and sequenced
1679 * protocols can't normally use this as they need to fit buffers in
1680 * and play with them.
1681 *
1682 * Inlined as it's very short and called for pretty much every
1683 * packet ever received.
1684 */
1685
1686static inline void skb_set_owner_w(struct sk_buff *skb, struct sock *sk)
1687{
Herbert Xud55d87f2009-06-22 02:25:25 +00001688 skb_orphan(skb);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001689 skb->sk = sk;
1690 skb->destructor = sock_wfree;
Eric Dumazet2b85a342009-06-11 02:55:43 -07001691 /*
1692 * We used to take a refcount on sk, but following operation
1693 * is enough to guarantee sk_free() wont free this sock until
1694 * all in-flight packets are completed
1695 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001696 atomic_add(skb->truesize, &sk->sk_wmem_alloc);
1697}
1698
1699static inline void skb_set_owner_r(struct sk_buff *skb, struct sock *sk)
1700{
Herbert Xud55d87f2009-06-22 02:25:25 +00001701 skb_orphan(skb);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001702 skb->sk = sk;
1703 skb->destructor = sock_rfree;
1704 atomic_add(skb->truesize, &sk->sk_rmem_alloc);
Hideo Aoki3ab224b2007-12-31 00:11:19 -08001705 sk_mem_charge(sk, skb->truesize);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001706}
1707
1708extern void sk_reset_timer(struct sock *sk, struct timer_list* timer,
1709 unsigned long expires);
1710
1711extern void sk_stop_timer(struct sock *sk, struct timer_list* timer);
1712
Denis Vlasenkof0088a52006-03-28 01:08:21 -08001713extern int sock_queue_rcv_skb(struct sock *sk, struct sk_buff *skb);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001714
Eric Dumazetb1faf562010-05-31 23:44:05 -07001715extern int sock_queue_err_skb(struct sock *sk, struct sk_buff *skb);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001716
1717/*
1718 * Recover an error report and clear atomically
1719 */
1720
1721static inline int sock_error(struct sock *sk)
1722{
Benjamin LaHaisec1cbe4b2005-12-13 23:22:19 -08001723 int err;
1724 if (likely(!sk->sk_err))
1725 return 0;
1726 err = xchg(&sk->sk_err, 0);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001727 return -err;
1728}
1729
1730static inline unsigned long sock_wspace(struct sock *sk)
1731{
1732 int amt = 0;
1733
1734 if (!(sk->sk_shutdown & SEND_SHUTDOWN)) {
1735 amt = sk->sk_sndbuf - atomic_read(&sk->sk_wmem_alloc);
1736 if (amt < 0)
1737 amt = 0;
1738 }
1739 return amt;
1740}
1741
1742static inline void sk_wake_async(struct sock *sk, int how, int band)
1743{
Eric Dumazetbcdce712009-10-06 17:28:29 -07001744 if (sock_flag(sk, SOCK_FASYNC))
Linus Torvalds1da177e2005-04-16 15:20:36 -07001745 sock_wake_async(sk->sk_socket, how, band);
1746}
1747
1748#define SOCK_MIN_SNDBUF 2048
Eric Dumazet7a91b4342010-09-26 18:53:07 -07001749/*
1750 * Since sk_rmem_alloc sums skb->truesize, even a small frame might need
1751 * sizeof(sk_buff) + MTU + padding, unless net driver perform copybreak
1752 */
1753#define SOCK_MIN_RCVBUF (2048 + sizeof(struct sk_buff))
Linus Torvalds1da177e2005-04-16 15:20:36 -07001754
1755static inline void sk_stream_moderate_sndbuf(struct sock *sk)
1756{
1757 if (!(sk->sk_userlocks & SOCK_SNDBUF_LOCK)) {
Eric Dumazet8df09ea2007-12-21 03:07:41 -08001758 sk->sk_sndbuf = min(sk->sk_sndbuf, sk->sk_wmem_queued >> 1);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001759 sk->sk_sndbuf = max(sk->sk_sndbuf, SOCK_MIN_SNDBUF);
1760 }
1761}
1762
Pavel Emelyanovdf97c702007-11-29 21:22:33 +11001763struct sk_buff *sk_stream_alloc_skb(struct sock *sk, int size, gfp_t gfp);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001764
1765static inline struct page *sk_stream_alloc_page(struct sock *sk)
1766{
1767 struct page *page = NULL;
1768
Herbert Xuef015782005-09-01 17:48:59 -07001769 page = alloc_pages(sk->sk_allocation, 0);
1770 if (!page) {
Glauber Costa180d8cd2011-12-11 21:47:02 +00001771 sk_enter_memory_pressure(sk);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001772 sk_stream_moderate_sndbuf(sk);
1773 }
1774 return page;
1775}
1776
Linus Torvalds1da177e2005-04-16 15:20:36 -07001777/*
1778 * Default write policy as shown to user space via poll/select/SIGIO
1779 */
1780static inline int sock_writeable(const struct sock *sk)
1781{
Eric Dumazet8df09ea2007-12-21 03:07:41 -08001782 return atomic_read(&sk->sk_wmem_alloc) < (sk->sk_sndbuf >> 1);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001783}
1784
Al Virodd0fc662005-10-07 07:46:04 +01001785static inline gfp_t gfp_any(void)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001786{
Andrew Morton99709372009-02-12 16:43:17 -08001787 return in_softirq() ? GFP_ATOMIC : GFP_KERNEL;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001788}
1789
1790static inline long sock_rcvtimeo(const struct sock *sk, int noblock)
1791{
1792 return noblock ? 0 : sk->sk_rcvtimeo;
1793}
1794
1795static inline long sock_sndtimeo(const struct sock *sk, int noblock)
1796{
1797 return noblock ? 0 : sk->sk_sndtimeo;
1798}
1799
1800static inline int sock_rcvlowat(const struct sock *sk, int waitall, int len)
1801{
1802 return (waitall ? len : min_t(int, sk->sk_rcvlowat, len)) ? : 1;
1803}
1804
1805/* Alas, with timeout socket operations are not restartable.
1806 * Compare this to poll().
1807 */
1808static inline int sock_intr_errno(long timeo)
1809{
1810 return timeo == MAX_SCHEDULE_TIMEOUT ? -ERESTARTSYS : -EINTR;
1811}
1812
Eric Dumazet92f37fd2007-03-25 22:14:49 -07001813extern void __sock_recv_timestamp(struct msghdr *msg, struct sock *sk,
1814 struct sk_buff *skb);
Johannes Berg6e3e9392011-11-09 10:15:42 +01001815extern void __sock_recv_wifi_status(struct msghdr *msg, struct sock *sk,
1816 struct sk_buff *skb);
Eric Dumazet92f37fd2007-03-25 22:14:49 -07001817
Linus Torvalds1da177e2005-04-16 15:20:36 -07001818static __inline__ void
1819sock_recv_timestamp(struct msghdr *msg, struct sock *sk, struct sk_buff *skb)
1820{
Eric Dumazetb7aa0bf2007-04-19 16:16:32 -07001821 ktime_t kt = skb->tstamp;
Patrick Ohly20d49472009-02-12 05:03:38 +00001822 struct skb_shared_hwtstamps *hwtstamps = skb_hwtstamps(skb);
Patrick McHardya61bbcf2005-08-14 17:24:31 -07001823
Patrick Ohly20d49472009-02-12 05:03:38 +00001824 /*
1825 * generate control messages if
1826 * - receive time stamping in software requested (SOCK_RCVTSTAMP
1827 * or SOCK_TIMESTAMPING_RX_SOFTWARE)
1828 * - software time stamp available and wanted
1829 * (SOCK_TIMESTAMPING_SOFTWARE)
1830 * - hardware time stamps available and wanted
1831 * (SOCK_TIMESTAMPING_SYS_HARDWARE or
1832 * SOCK_TIMESTAMPING_RAW_HARDWARE)
1833 */
1834 if (sock_flag(sk, SOCK_RCVTSTAMP) ||
1835 sock_flag(sk, SOCK_TIMESTAMPING_RX_SOFTWARE) ||
1836 (kt.tv64 && sock_flag(sk, SOCK_TIMESTAMPING_SOFTWARE)) ||
1837 (hwtstamps->hwtstamp.tv64 &&
1838 sock_flag(sk, SOCK_TIMESTAMPING_RAW_HARDWARE)) ||
1839 (hwtstamps->syststamp.tv64 &&
1840 sock_flag(sk, SOCK_TIMESTAMPING_SYS_HARDWARE)))
Eric Dumazet92f37fd2007-03-25 22:14:49 -07001841 __sock_recv_timestamp(msg, sk, skb);
1842 else
Eric Dumazetb7aa0bf2007-04-19 16:16:32 -07001843 sk->sk_stamp = kt;
Johannes Berg6e3e9392011-11-09 10:15:42 +01001844
1845 if (sock_flag(sk, SOCK_WIFI_STATUS) && skb->wifi_acked_valid)
1846 __sock_recv_wifi_status(msg, sk, skb);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001847}
1848
Eric Dumazet767dd032010-04-28 19:14:43 +00001849extern void __sock_recv_ts_and_drops(struct msghdr *msg, struct sock *sk,
1850 struct sk_buff *skb);
1851
1852static inline void sock_recv_ts_and_drops(struct msghdr *msg, struct sock *sk,
1853 struct sk_buff *skb)
1854{
1855#define FLAGS_TS_OR_DROPS ((1UL << SOCK_RXQ_OVFL) | \
1856 (1UL << SOCK_RCVTSTAMP) | \
1857 (1UL << SOCK_TIMESTAMPING_RX_SOFTWARE) | \
1858 (1UL << SOCK_TIMESTAMPING_SOFTWARE) | \
1859 (1UL << SOCK_TIMESTAMPING_RAW_HARDWARE) | \
1860 (1UL << SOCK_TIMESTAMPING_SYS_HARDWARE))
1861
1862 if (sk->sk_flags & FLAGS_TS_OR_DROPS)
1863 __sock_recv_ts_and_drops(msg, sk, skb);
1864 else
1865 sk->sk_stamp = skb->tstamp;
1866}
Neil Horman3b885782009-10-12 13:26:31 -07001867
Linus Torvalds1da177e2005-04-16 15:20:36 -07001868/**
Patrick Ohly20d49472009-02-12 05:03:38 +00001869 * sock_tx_timestamp - checks whether the outgoing packet is to be time stamped
Patrick Ohly20d49472009-02-12 05:03:38 +00001870 * @sk: socket sending this packet
Oliver Hartkopp2244d072010-08-17 08:59:14 +00001871 * @tx_flags: filled with instructions for time stamping
Patrick Ohly20d49472009-02-12 05:03:38 +00001872 *
1873 * Currently only depends on SOCK_TIMESTAMPING* flags. Returns error code if
1874 * parameters are invalid.
1875 */
Oliver Hartkopp2244d072010-08-17 08:59:14 +00001876extern int sock_tx_timestamp(struct sock *sk, __u8 *tx_flags);
Patrick Ohly20d49472009-02-12 05:03:38 +00001877
1878/**
Linus Torvalds1da177e2005-04-16 15:20:36 -07001879 * sk_eat_skb - Release a skb if it is no longer needed
Pavel Pisa4dc3b162005-05-01 08:59:25 -07001880 * @sk: socket to eat this skb from
1881 * @skb: socket buffer to eat
Randy Dunlapf4b8ea72006-06-22 16:00:11 -07001882 * @copied_early: flag indicating whether DMA operations copied this data early
Linus Torvalds1da177e2005-04-16 15:20:36 -07001883 *
1884 * This routine must be called with interrupts disabled or with the socket
1885 * locked so that the sk_buff queue operation is ok.
1886*/
Chris Leech624d1162006-05-23 18:01:28 -07001887#ifdef CONFIG_NET_DMA
1888static inline void sk_eat_skb(struct sock *sk, struct sk_buff *skb, int copied_early)
1889{
1890 __skb_unlink(skb, &sk->sk_receive_queue);
1891 if (!copied_early)
1892 __kfree_skb(skb);
1893 else
1894 __skb_queue_tail(&sk->sk_async_wait_queue, skb);
1895}
1896#else
1897static inline void sk_eat_skb(struct sock *sk, struct sk_buff *skb, int copied_early)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001898{
1899 __skb_unlink(skb, &sk->sk_receive_queue);
1900 __kfree_skb(skb);
1901}
Chris Leech624d1162006-05-23 18:01:28 -07001902#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -07001903
YOSHIFUJI Hideaki3b1e0a62008-03-26 02:26:21 +09001904static inline
1905struct net *sock_net(const struct sock *sk)
1906{
Eric Dumazetc2d9ba92010-06-01 06:51:19 +00001907 return read_pnet(&sk->sk_net);
YOSHIFUJI Hideaki3b1e0a62008-03-26 02:26:21 +09001908}
1909
1910static inline
Denis V. Lunevf5aa23f2008-03-26 00:48:17 -07001911void sock_net_set(struct sock *sk, struct net *net)
YOSHIFUJI Hideaki3b1e0a62008-03-26 02:26:21 +09001912{
Eric Dumazetc2d9ba92010-06-01 06:51:19 +00001913 write_pnet(&sk->sk_net, net);
YOSHIFUJI Hideaki3b1e0a62008-03-26 02:26:21 +09001914}
1915
Denis V. Lunevedf02082008-02-29 11:18:32 -08001916/*
1917 * Kernel sockets, f.e. rtnl or icmp_socket, are a part of a namespace.
Lucas De Marchi25985ed2011-03-30 22:57:33 -03001918 * They should not hold a reference to a namespace in order to allow
Denis V. Lunevedf02082008-02-29 11:18:32 -08001919 * to stop it.
1920 * Sockets after sk_change_net should be released using sk_release_kernel
1921 */
1922static inline void sk_change_net(struct sock *sk, struct net *net)
1923{
YOSHIFUJI Hideaki3b1e0a62008-03-26 02:26:21 +09001924 put_net(sock_net(sk));
Denis V. Lunev65a18ec2008-04-16 01:59:46 -07001925 sock_net_set(sk, hold_net(net));
Denis V. Lunevedf02082008-02-29 11:18:32 -08001926}
1927
KOVACS Krisztian23542612008-10-07 12:41:01 -07001928static inline struct sock *skb_steal_sock(struct sk_buff *skb)
1929{
1930 if (unlikely(skb->sk)) {
1931 struct sock *sk = skb->sk;
1932
1933 skb->destructor = NULL;
1934 skb->sk = NULL;
1935 return sk;
1936 }
1937 return NULL;
1938}
1939
Patrick Ohly20d49472009-02-12 05:03:38 +00001940extern void sock_enable_timestamp(struct sock *sk, int flag);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001941extern int sock_get_timestamp(struct sock *, struct timeval __user *);
Eric Dumazetae40eb12007-03-18 17:33:16 -07001942extern int sock_get_timestampns(struct sock *, struct timespec __user *);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001943
1944/*
1945 * Enable debug/info messages
1946 */
Stephen Hemmingera2a316f2007-03-08 20:41:08 -08001947extern int net_msg_warn;
1948#define NETDEBUG(fmt, args...) \
1949 do { if (net_msg_warn) printk(fmt,##args); } while (0)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001950
Stephen Hemmingera2a316f2007-03-08 20:41:08 -08001951#define LIMIT_NETDEBUG(fmt, args...) \
1952 do { if (net_msg_warn && net_ratelimit()) printk(fmt,##args); } while(0)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001953
Linus Torvalds1da177e2005-04-16 15:20:36 -07001954extern __u32 sysctl_wmem_max;
1955extern __u32 sysctl_rmem_max;
1956
Arnaldo Carvalho de Melo20380732005-08-16 02:18:02 -03001957extern void sk_init(void);
1958
David S. Miller6baf1f42005-09-05 18:14:11 -07001959extern int sysctl_optmem_max;
1960
Arnaldo Carvalho de Melo20380732005-08-16 02:18:02 -03001961extern __u32 sysctl_wmem_default;
1962extern __u32 sysctl_rmem_default;
Arnaldo Carvalho de Melo20380732005-08-16 02:18:02 -03001963
Linus Torvalds1da177e2005-04-16 15:20:36 -07001964#endif /* _SOCK_H */