blob: 9c0553b9e451aa07eae214f3dac8a00057f1dbe4 [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>
Glauber Costae1aab162011-12-11 21:47:03 +000057#include <linux/res_counter.h>
Glauber Costa9018e932012-01-26 12:09:28 +000058#include <linux/jump_label.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070059
60#include <linux/filter.h>
Eric Dumazet88ab1932008-11-16 19:39:21 -080061#include <linux/rculist_nulls.h>
Jiri Olsaa57de0b2009-07-08 12:09:13 +000062#include <linux/poll.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070063
Eric Dumazetc31504d2010-11-15 19:58:26 +000064#include <linux/atomic.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070065#include <net/dst.h>
66#include <net/checksum.h>
67
Eric Dumazet9f048bf2011-12-13 03:59:08 +000068struct cgroup;
69struct cgroup_subsys;
Glauber Costac607b2e2011-12-16 00:52:00 +000070#ifdef CONFIG_NET
Glauber Costad1a4c0b2011-12-11 21:47:04 +000071int mem_cgroup_sockets_init(struct cgroup *cgrp, struct cgroup_subsys *ss);
72void mem_cgroup_sockets_destroy(struct cgroup *cgrp, struct cgroup_subsys *ss);
Glauber Costac607b2e2011-12-16 00:52:00 +000073#else
74static inline
75int mem_cgroup_sockets_init(struct cgroup *cgrp, struct cgroup_subsys *ss)
76{
77 return 0;
78}
79static inline
80void mem_cgroup_sockets_destroy(struct cgroup *cgrp, struct cgroup_subsys *ss)
81{
82}
83#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -070084/*
85 * This structure really needs to be cleaned up.
86 * Most of it is for TCP, and not used by any of
87 * the other protocols.
88 */
89
90/* Define this to get the SOCK_DBG debugging facility. */
91#define SOCK_DEBUGGING
92#ifdef SOCK_DEBUGGING
93#define SOCK_DEBUG(sk, msg...) do { if ((sk) && sock_flag((sk), SOCK_DBG)) \
94 printk(KERN_DEBUG msg); } while (0)
95#else
Stephen Hemminger4cd90292008-03-21 15:54:53 -070096/* Validate arguments and do nothing */
Joe Perchesb9075fa2011-10-31 17:11:33 -070097static inline __printf(2, 3)
98void SOCK_DEBUG(struct sock *sk, const char *msg, ...)
Stephen Hemminger4cd90292008-03-21 15:54:53 -070099{
100}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700101#endif
102
103/* This is the per-socket lock. The spinlock provides a synchronization
104 * between user contexts and software interrupt processing, whereas the
105 * mini-semaphore synchronizes multiple users amongst themselves.
106 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700107typedef struct {
108 spinlock_t slock;
John Heffnerd2e91172007-09-12 10:44:19 +0200109 int owned;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700110 wait_queue_head_t wq;
Ingo Molnara5b5bb92006-07-03 00:25:35 -0700111 /*
112 * We express the mutex-alike socket_lock semantics
113 * to the lock validator by explicitly managing
114 * the slock as a lock variant (in addition to
115 * the slock itself):
116 */
117#ifdef CONFIG_DEBUG_LOCK_ALLOC
118 struct lockdep_map dep_map;
119#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -0700120} socket_lock_t;
121
Linus Torvalds1da177e2005-04-16 15:20:36 -0700122struct sock;
Arnaldo Carvalho de Melo8feaf0c2005-08-09 20:09:30 -0700123struct proto;
Denis V. Lunev0eeb8ff2007-12-04 01:15:45 -0800124struct net;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700125
126/**
Pavel Pisa4dc3b162005-05-01 08:59:25 -0700127 * struct sock_common - minimal network layer representation of sockets
Eric Dumazet68835ab2010-11-30 19:04:07 +0000128 * @skc_daddr: Foreign IPv4 addr
129 * @skc_rcv_saddr: Bound local IPv4 addr
Eric Dumazet4dc6dc72009-07-15 23:13:10 +0000130 * @skc_hash: hash value used with various protocol lookup tables
Eric Dumazetd4cada42009-11-08 10:17:30 +0000131 * @skc_u16hashes: two u16 hash values used by UDP lookup tables
Pavel Pisa4dc3b162005-05-01 08:59:25 -0700132 * @skc_family: network address family
133 * @skc_state: Connection state
134 * @skc_reuse: %SO_REUSEADDR setting
135 * @skc_bound_dev_if: bound device index if != 0
Pavel Pisa4dc3b162005-05-01 08:59:25 -0700136 * @skc_bind_node: bind hash linkage for various protocol lookup tables
Eric Dumazet512615b2009-11-08 10:17:58 +0000137 * @skc_portaddr_node: second hash linkage for UDP/UDP-Lite protocol
Arnaldo Carvalho de Melo8feaf0c2005-08-09 20:09:30 -0700138 * @skc_prot: protocol handlers inside a network family
Eric W. Biederman07feaeb2007-09-12 11:58:02 +0200139 * @skc_net: reference to the network namespace of this socket
Eric Dumazet68835ab2010-11-30 19:04:07 +0000140 * @skc_node: main hash linkage for various protocol lookup tables
141 * @skc_nulls_node: main hash linkage for TCP/UDP/UDP-Lite protocol
142 * @skc_tx_queue_mapping: tx queue number for this connection
143 * @skc_refcnt: reference count
Pavel Pisa4dc3b162005-05-01 08:59:25 -0700144 *
145 * This is the minimal network layer representation of sockets, the header
Arnaldo Carvalho de Melo8feaf0c2005-08-09 20:09:30 -0700146 * for struct sock and struct inet_timewait_sock.
147 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700148struct sock_common {
Eric Dumazet68835ab2010-11-30 19:04:07 +0000149 /* skc_daddr and skc_rcv_saddr must be grouped :
150 * cf INET_MATCH() and INET_TW_MATCH()
Eric Dumazet4dc6dc72009-07-15 23:13:10 +0000151 */
Eric Dumazet68835ab2010-11-30 19:04:07 +0000152 __be32 skc_daddr;
153 __be32 skc_rcv_saddr;
Eric Dumazet4dc6dc72009-07-15 23:13:10 +0000154
Eric Dumazetd4cada42009-11-08 10:17:30 +0000155 union {
156 unsigned int skc_hash;
157 __u16 skc_u16hashes[2];
158 };
Eric Dumazet4dc6dc72009-07-15 23:13:10 +0000159 unsigned short skc_family;
160 volatile unsigned char skc_state;
161 unsigned char skc_reuse;
162 int skc_bound_dev_if;
Eric Dumazet512615b2009-11-08 10:17:58 +0000163 union {
164 struct hlist_node skc_bind_node;
165 struct hlist_nulls_node skc_portaddr_node;
166 };
Arnaldo Carvalho de Melo8feaf0c2005-08-09 20:09:30 -0700167 struct proto *skc_prot;
YOSHIFUJI Hideaki3b1e0a62008-03-26 02:26:21 +0900168#ifdef CONFIG_NET_NS
Eric W. Biederman07feaeb2007-09-12 11:58:02 +0200169 struct net *skc_net;
YOSHIFUJI Hideaki3b1e0a62008-03-26 02:26:21 +0900170#endif
Eric Dumazet68835ab2010-11-30 19:04:07 +0000171 /*
172 * fields between dontcopy_begin/dontcopy_end
173 * are not copied in sock_copy()
174 */
Randy Dunlap928c41e2011-01-08 17:39:21 +0000175 /* private: */
Eric Dumazet68835ab2010-11-30 19:04:07 +0000176 int skc_dontcopy_begin[0];
Randy Dunlap928c41e2011-01-08 17:39:21 +0000177 /* public: */
Eric Dumazet68835ab2010-11-30 19:04:07 +0000178 union {
179 struct hlist_node skc_node;
180 struct hlist_nulls_node skc_nulls_node;
181 };
182 int skc_tx_queue_mapping;
183 atomic_t skc_refcnt;
Randy Dunlap928c41e2011-01-08 17:39:21 +0000184 /* private: */
Eric Dumazet68835ab2010-11-30 19:04:07 +0000185 int skc_dontcopy_end[0];
Randy Dunlap928c41e2011-01-08 17:39:21 +0000186 /* public: */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700187};
188
Glauber Costae1aab162011-12-11 21:47:03 +0000189struct cg_proto;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700190/**
191 * struct sock - network layer representation of sockets
Arnaldo Carvalho de Melo8feaf0c2005-08-09 20:09:30 -0700192 * @__sk_common: shared layout with inet_timewait_sock
Pavel Pisa4dc3b162005-05-01 08:59:25 -0700193 * @sk_shutdown: mask of %SEND_SHUTDOWN and/or %RCV_SHUTDOWN
194 * @sk_userlocks: %SO_SNDBUF and %SO_RCVBUF settings
195 * @sk_lock: synchronizer
196 * @sk_rcvbuf: size of receive buffer in bytes
Eric Dumazet43815482010-04-29 11:01:49 +0000197 * @sk_wq: sock wait queue and async head
Pavel Pisa4dc3b162005-05-01 08:59:25 -0700198 * @sk_dst_cache: destination cache
199 * @sk_dst_lock: destination cache lock
200 * @sk_policy: flow policy
Pavel Pisa4dc3b162005-05-01 08:59:25 -0700201 * @sk_receive_queue: incoming packets
202 * @sk_wmem_alloc: transmit queue bytes committed
203 * @sk_write_queue: Packet sending queue
Chris Leech97fc2f02006-05-23 17:55:33 -0700204 * @sk_async_wait_queue: DMA copied packets
Pavel Pisa4dc3b162005-05-01 08:59:25 -0700205 * @sk_omem_alloc: "o" is "option" or "other"
206 * @sk_wmem_queued: persistent queue size
207 * @sk_forward_alloc: space allocated forward
208 * @sk_allocation: allocation mode
209 * @sk_sndbuf: size of send buffer in bytes
Wang Chen33c732c2007-11-13 20:30:01 -0800210 * @sk_flags: %SO_LINGER (l_onoff), %SO_BROADCAST, %SO_KEEPALIVE,
Patrick Ohly20d49472009-02-12 05:03:38 +0000211 * %SO_OOBINLINE settings, %SO_TIMESTAMPING settings
Pavel Pisa4dc3b162005-05-01 08:59:25 -0700212 * @sk_no_check: %SO_NO_CHECK setting, wether or not checkup packets
213 * @sk_route_caps: route capabilities (e.g. %NETIF_F_TSO)
Eric Dumazeta4654192010-05-16 00:36:33 -0700214 * @sk_route_nocaps: forbidden route capabilities (e.g NETIF_F_GSO_MASK)
Herbert Xubcd76112006-06-30 13:36:35 -0700215 * @sk_gso_type: GSO type (e.g. %SKB_GSO_TCPV4)
Peter P Waskiewicz Jr82cc1a72008-03-21 03:43:19 -0700216 * @sk_gso_max_size: Maximum GSO segment size to build
Pavel Pisa4dc3b162005-05-01 08:59:25 -0700217 * @sk_lingertime: %SO_LINGER l_linger setting
Pavel Pisa4dc3b162005-05-01 08:59:25 -0700218 * @sk_backlog: always used with the per-socket spinlock held
219 * @sk_callback_lock: used with the callbacks in the end of this struct
220 * @sk_error_queue: rarely used
Wang Chen33c732c2007-11-13 20:30:01 -0800221 * @sk_prot_creator: sk_prot of original sock creator (see ipv6_setsockopt,
222 * IPV6_ADDRFORM for instance)
Pavel Pisa4dc3b162005-05-01 08:59:25 -0700223 * @sk_err: last error
Wang Chen33c732c2007-11-13 20:30:01 -0800224 * @sk_err_soft: errors that don't cause failure but are the cause of a
225 * persistent failure not just 'timed out'
Eric Dumazetcb61cb92008-06-17 21:04:56 -0700226 * @sk_drops: raw/udp drops counter
Pavel Pisa4dc3b162005-05-01 08:59:25 -0700227 * @sk_ack_backlog: current listen backlog
228 * @sk_max_ack_backlog: listen backlog set in listen()
229 * @sk_priority: %SO_PRIORITY setting
Randy Dunlap1a3bc362012-01-21 09:03:10 +0000230 * @sk_cgrp_prioidx: socket group's priority map index
Pavel Pisa4dc3b162005-05-01 08:59:25 -0700231 * @sk_type: socket type (%SOCK_STREAM, etc)
232 * @sk_protocol: which protocol this socket belongs in this network family
Randy Dunlap53c3fa22010-08-09 13:41:07 +0000233 * @sk_peer_pid: &struct pid for this socket's peer
234 * @sk_peer_cred: %SO_PEERCRED setting
Pavel Pisa4dc3b162005-05-01 08:59:25 -0700235 * @sk_rcvlowat: %SO_RCVLOWAT setting
236 * @sk_rcvtimeo: %SO_RCVTIMEO setting
237 * @sk_sndtimeo: %SO_SNDTIMEO setting
David S. Millerc58dc012010-04-27 15:05:31 -0700238 * @sk_rxhash: flow hash received from netif layer
Pavel Pisa4dc3b162005-05-01 08:59:25 -0700239 * @sk_filter: socket filtering instructions
240 * @sk_protinfo: private area, net family specific, when not using slab
241 * @sk_timer: sock cleanup timer
242 * @sk_stamp: time stamp of last packet received
243 * @sk_socket: Identd and reporting IO signals
244 * @sk_user_data: RPC layer private data
245 * @sk_sndmsg_page: cached page for sendmsg
246 * @sk_sndmsg_off: cached offset for sendmsg
247 * @sk_send_head: front of stuff to transmit
Martin Waitz67be2dd2005-05-01 08:59:26 -0700248 * @sk_security: used by security modules
Randy Dunlap31729362008-02-18 20:52:13 -0800249 * @sk_mark: generic packet mark
Randy Dunlap53c3fa22010-08-09 13:41:07 +0000250 * @sk_classid: this socket's cgroup classid
Glauber Costae1aab162011-12-11 21:47:03 +0000251 * @sk_cgrp: this socket's cgroup-specific proto data
Pavel Pisa4dc3b162005-05-01 08:59:25 -0700252 * @sk_write_pending: a write to stream socket waits to start
253 * @sk_state_change: callback to indicate change in the state of the sock
254 * @sk_data_ready: callback to indicate there is data to be processed
255 * @sk_write_space: callback to indicate there is bf sending space available
256 * @sk_error_report: callback to indicate errors (e.g. %MSG_ERRQUEUE)
257 * @sk_backlog_rcv: callback to process the backlog
258 * @sk_destruct: called at sock freeing time, i.e. when all refcnt == 0
Linus Torvalds1da177e2005-04-16 15:20:36 -0700259 */
260struct sock {
261 /*
Arnaldo Carvalho de Melo8feaf0c2005-08-09 20:09:30 -0700262 * Now struct inet_timewait_sock also uses sock_common, so please just
Linus Torvalds1da177e2005-04-16 15:20:36 -0700263 * don't add nothing before this first member (__sk_common) --acme
264 */
265 struct sock_common __sk_common;
Eric Dumazet4dc6dc72009-07-15 23:13:10 +0000266#define sk_node __sk_common.skc_node
267#define sk_nulls_node __sk_common.skc_nulls_node
268#define sk_refcnt __sk_common.skc_refcnt
Krishna Kumare022f0b2009-10-19 23:46:20 +0000269#define sk_tx_queue_mapping __sk_common.skc_tx_queue_mapping
Eric Dumazet4dc6dc72009-07-15 23:13:10 +0000270
Eric Dumazet68835ab2010-11-30 19:04:07 +0000271#define sk_dontcopy_begin __sk_common.skc_dontcopy_begin
272#define sk_dontcopy_end __sk_common.skc_dontcopy_end
Eric Dumazet4dc6dc72009-07-15 23:13:10 +0000273#define sk_hash __sk_common.skc_hash
Linus Torvalds1da177e2005-04-16 15:20:36 -0700274#define sk_family __sk_common.skc_family
275#define sk_state __sk_common.skc_state
276#define sk_reuse __sk_common.skc_reuse
277#define sk_bound_dev_if __sk_common.skc_bound_dev_if
Linus Torvalds1da177e2005-04-16 15:20:36 -0700278#define sk_bind_node __sk_common.skc_bind_node
Arnaldo Carvalho de Melo8feaf0c2005-08-09 20:09:30 -0700279#define sk_prot __sk_common.skc_prot
Eric W. Biederman07feaeb2007-09-12 11:58:02 +0200280#define sk_net __sk_common.skc_net
Eric Dumazetb178bb32010-11-16 05:56:04 +0000281 socket_lock_t sk_lock;
282 struct sk_buff_head sk_receive_queue;
283 /*
284 * The backlog queue is special, it is always used with
285 * the per-socket spinlock held and requires low latency
286 * access. Therefore we special case it's implementation.
287 * Note : rmem_alloc is in this structure to fill a hole
288 * on 64bit arches, not because its logically part of
289 * backlog.
290 */
291 struct {
292 atomic_t rmem_alloc;
293 int len;
294 struct sk_buff *head;
295 struct sk_buff *tail;
296 } sk_backlog;
297#define sk_rmem_alloc sk_backlog.rmem_alloc
298 int sk_forward_alloc;
299#ifdef CONFIG_RPS
300 __u32 sk_rxhash;
301#endif
302 atomic_t sk_drops;
303 int sk_rcvbuf;
304
305 struct sk_filter __rcu *sk_filter;
Eric Dumazeteaefd112011-02-18 03:26:36 +0000306 struct socket_wq __rcu *sk_wq;
Eric Dumazetb178bb32010-11-16 05:56:04 +0000307
308#ifdef CONFIG_NET_DMA
309 struct sk_buff_head sk_async_wait_queue;
310#endif
311
312#ifdef CONFIG_XFRM
313 struct xfrm_policy *sk_policy[2];
314#endif
315 unsigned long sk_flags;
316 struct dst_entry *sk_dst_cache;
317 spinlock_t sk_dst_lock;
318 atomic_t sk_wmem_alloc;
319 atomic_t sk_omem_alloc;
320 int sk_sndbuf;
321 struct sk_buff_head sk_write_queue;
Vegard Nossuma98b65a2009-02-26 14:46:57 +0100322 kmemcheck_bitfield_begin(flags);
Eric Dumazet5fdb9972009-10-08 22:50:25 +0000323 unsigned int sk_shutdown : 2,
324 sk_no_check : 2,
325 sk_userlocks : 4,
326 sk_protocol : 8,
327 sk_type : 16;
Vegard Nossuma98b65a2009-02-26 14:46:57 +0100328 kmemcheck_bitfield_end(flags);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700329 int sk_wmem_queued;
Al Viro7d877f32005-10-21 03:20:43 -0400330 gfp_t sk_allocation;
Michał Mirosławc8f44af2011-11-15 15:29:55 +0000331 netdev_features_t sk_route_caps;
332 netdev_features_t sk_route_nocaps;
Herbert Xubcd76112006-06-30 13:36:35 -0700333 int sk_gso_type;
Peter P Waskiewicz Jr82cc1a72008-03-21 03:43:19 -0700334 unsigned int sk_gso_max_size;
David S. Miller9932cf92006-03-24 15:12:37 -0800335 int sk_rcvlowat;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700336 unsigned long sk_lingertime;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700337 struct sk_buff_head sk_error_queue;
Arnaldo Carvalho de Melo476e19c2005-05-05 13:35:15 -0700338 struct proto *sk_prot_creator;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700339 rwlock_t sk_callback_lock;
340 int sk_err,
341 sk_err_soft;
342 unsigned short sk_ack_backlog;
343 unsigned short sk_max_ack_backlog;
344 __u32 sk_priority;
Neil Horman5bc14212011-11-22 05:10:51 +0000345#ifdef CONFIG_CGROUPS
346 __u32 sk_cgrp_prioidx;
347#endif
Eric W. Biederman109f6e32010-06-13 03:30:14 +0000348 struct pid *sk_peer_pid;
349 const struct cred *sk_peer_cred;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700350 long sk_rcvtimeo;
351 long sk_sndtimeo;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700352 void *sk_protinfo;
353 struct timer_list sk_timer;
Eric Dumazetb7aa0bf2007-04-19 16:16:32 -0700354 ktime_t sk_stamp;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700355 struct socket *sk_socket;
356 void *sk_user_data;
357 struct page *sk_sndmsg_page;
358 struct sk_buff *sk_send_head;
359 __u32 sk_sndmsg_off;
Pavel Emelyanovef64a542012-02-21 07:31:34 +0000360 __s32 sk_peek_off;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700361 int sk_write_pending;
Alexey Dobriyand5f64232008-11-04 14:45:58 -0800362#ifdef CONFIG_SECURITY
Linus Torvalds1da177e2005-04-16 15:20:36 -0700363 void *sk_security;
Alexey Dobriyand5f64232008-11-04 14:45:58 -0800364#endif
Laszlo Attila Toth4a19ec52008-01-30 19:08:16 -0800365 __u32 sk_mark;
Herbert Xuf8451722010-05-24 00:12:34 -0700366 u32 sk_classid;
Glauber Costae1aab162011-12-11 21:47:03 +0000367 struct cg_proto *sk_cgrp;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700368 void (*sk_state_change)(struct sock *sk);
369 void (*sk_data_ready)(struct sock *sk, int bytes);
370 void (*sk_write_space)(struct sock *sk);
371 void (*sk_error_report)(struct sock *sk);
372 int (*sk_backlog_rcv)(struct sock *sk,
373 struct sk_buff *skb);
374 void (*sk_destruct)(struct sock *sk);
375};
376
Pavel Emelyanovef64a542012-02-21 07:31:34 +0000377static inline int sk_peek_offset(struct sock *sk, int flags)
378{
379 if ((flags & MSG_PEEK) && (sk->sk_peek_off >= 0))
380 return sk->sk_peek_off;
381 else
382 return 0;
383}
384
385static inline void sk_peek_offset_bwd(struct sock *sk, int val)
386{
387 if (sk->sk_peek_off >= 0) {
388 if (sk->sk_peek_off >= val)
389 sk->sk_peek_off -= val;
390 else
391 sk->sk_peek_off = 0;
392 }
393}
394
395static inline void sk_peek_offset_fwd(struct sock *sk, int val)
396{
397 if (sk->sk_peek_off >= 0)
398 sk->sk_peek_off += val;
399}
400
Linus Torvalds1da177e2005-04-16 15:20:36 -0700401/*
402 * Hashed lists helper routines
403 */
Li Zefanc4146642010-02-08 23:18:45 +0000404static inline struct sock *sk_entry(const struct hlist_node *node)
405{
406 return hlist_entry(node, struct sock, sk_node);
407}
408
Arnaldo Carvalho de Meloe48c4142005-08-09 20:09:46 -0700409static inline struct sock *__sk_head(const struct hlist_head *head)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700410{
411 return hlist_entry(head->first, struct sock, sk_node);
412}
413
Arnaldo Carvalho de Meloe48c4142005-08-09 20:09:46 -0700414static inline struct sock *sk_head(const struct hlist_head *head)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700415{
416 return hlist_empty(head) ? NULL : __sk_head(head);
417}
418
Eric Dumazet88ab1932008-11-16 19:39:21 -0800419static inline struct sock *__sk_nulls_head(const struct hlist_nulls_head *head)
420{
421 return hlist_nulls_entry(head->first, struct sock, sk_nulls_node);
422}
423
424static inline struct sock *sk_nulls_head(const struct hlist_nulls_head *head)
425{
426 return hlist_nulls_empty(head) ? NULL : __sk_nulls_head(head);
427}
428
Arnaldo Carvalho de Meloe48c4142005-08-09 20:09:46 -0700429static inline struct sock *sk_next(const struct sock *sk)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700430{
431 return sk->sk_node.next ?
432 hlist_entry(sk->sk_node.next, struct sock, sk_node) : NULL;
433}
434
Eric Dumazet88ab1932008-11-16 19:39:21 -0800435static inline struct sock *sk_nulls_next(const struct sock *sk)
436{
437 return (!is_a_nulls(sk->sk_nulls_node.next)) ?
438 hlist_nulls_entry(sk->sk_nulls_node.next,
439 struct sock, sk_nulls_node) :
440 NULL;
441}
442
Arnaldo Carvalho de Meloe48c4142005-08-09 20:09:46 -0700443static inline int sk_unhashed(const struct sock *sk)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700444{
445 return hlist_unhashed(&sk->sk_node);
446}
447
Arnaldo Carvalho de Meloe48c4142005-08-09 20:09:46 -0700448static inline int sk_hashed(const struct sock *sk)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700449{
Akinobu Mitada753be2006-04-28 15:21:23 -0700450 return !sk_unhashed(sk);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700451}
452
453static __inline__ void sk_node_init(struct hlist_node *node)
454{
455 node->pprev = NULL;
456}
457
Eric Dumazet88ab1932008-11-16 19:39:21 -0800458static __inline__ void sk_nulls_node_init(struct hlist_nulls_node *node)
459{
460 node->pprev = NULL;
461}
462
Linus Torvalds1da177e2005-04-16 15:20:36 -0700463static __inline__ void __sk_del_node(struct sock *sk)
464{
465 __hlist_del(&sk->sk_node);
466}
467
stephen hemminger808f5112010-02-22 07:57:18 +0000468/* NB: equivalent to hlist_del_init_rcu */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700469static __inline__ int __sk_del_node_init(struct sock *sk)
470{
471 if (sk_hashed(sk)) {
472 __sk_del_node(sk);
473 sk_node_init(&sk->sk_node);
474 return 1;
475 }
476 return 0;
477}
478
479/* Grab socket reference count. This operation is valid only
480 when sk is ALREADY grabbed f.e. it is found in hash table
481 or a list and the lookup is made under lock preventing hash table
482 modifications.
483 */
484
485static inline void sock_hold(struct sock *sk)
486{
487 atomic_inc(&sk->sk_refcnt);
488}
489
490/* Ungrab socket in the context, which assumes that socket refcnt
491 cannot hit zero, f.e. it is true in context of any socketcall.
492 */
493static inline void __sock_put(struct sock *sk)
494{
495 atomic_dec(&sk->sk_refcnt);
496}
497
498static __inline__ int sk_del_node_init(struct sock *sk)
499{
500 int rc = __sk_del_node_init(sk);
501
502 if (rc) {
503 /* paranoid for a while -acme */
504 WARN_ON(atomic_read(&sk->sk_refcnt) == 1);
505 __sock_put(sk);
506 }
507 return rc;
508}
stephen hemminger808f5112010-02-22 07:57:18 +0000509#define sk_del_node_init_rcu(sk) sk_del_node_init(sk)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700510
Eric Dumazet88ab1932008-11-16 19:39:21 -0800511static __inline__ int __sk_nulls_del_node_init_rcu(struct sock *sk)
Eric Dumazet271b72c2008-10-29 02:11:14 -0700512{
513 if (sk_hashed(sk)) {
Eric Dumazet88ab1932008-11-16 19:39:21 -0800514 hlist_nulls_del_init_rcu(&sk->sk_nulls_node);
Eric Dumazet271b72c2008-10-29 02:11:14 -0700515 return 1;
516 }
517 return 0;
518}
519
Eric Dumazet88ab1932008-11-16 19:39:21 -0800520static __inline__ int sk_nulls_del_node_init_rcu(struct sock *sk)
Eric Dumazet271b72c2008-10-29 02:11:14 -0700521{
Eric Dumazet88ab1932008-11-16 19:39:21 -0800522 int rc = __sk_nulls_del_node_init_rcu(sk);
Eric Dumazet271b72c2008-10-29 02:11:14 -0700523
524 if (rc) {
525 /* paranoid for a while -acme */
526 WARN_ON(atomic_read(&sk->sk_refcnt) == 1);
527 __sock_put(sk);
528 }
529 return rc;
530}
531
Linus Torvalds1da177e2005-04-16 15:20:36 -0700532static __inline__ void __sk_add_node(struct sock *sk, struct hlist_head *list)
533{
534 hlist_add_head(&sk->sk_node, list);
535}
536
537static __inline__ void sk_add_node(struct sock *sk, struct hlist_head *list)
538{
539 sock_hold(sk);
540 __sk_add_node(sk, list);
541}
542
stephen hemminger808f5112010-02-22 07:57:18 +0000543static __inline__ void sk_add_node_rcu(struct sock *sk, struct hlist_head *list)
544{
545 sock_hold(sk);
546 hlist_add_head_rcu(&sk->sk_node, list);
547}
548
Eric Dumazet88ab1932008-11-16 19:39:21 -0800549static __inline__ void __sk_nulls_add_node_rcu(struct sock *sk, struct hlist_nulls_head *list)
Eric Dumazet271b72c2008-10-29 02:11:14 -0700550{
Eric Dumazet88ab1932008-11-16 19:39:21 -0800551 hlist_nulls_add_head_rcu(&sk->sk_nulls_node, list);
Eric Dumazet271b72c2008-10-29 02:11:14 -0700552}
553
Eric Dumazet88ab1932008-11-16 19:39:21 -0800554static __inline__ void sk_nulls_add_node_rcu(struct sock *sk, struct hlist_nulls_head *list)
Eric Dumazet271b72c2008-10-29 02:11:14 -0700555{
556 sock_hold(sk);
Eric Dumazet88ab1932008-11-16 19:39:21 -0800557 __sk_nulls_add_node_rcu(sk, list);
Eric Dumazet271b72c2008-10-29 02:11:14 -0700558}
559
Linus Torvalds1da177e2005-04-16 15:20:36 -0700560static __inline__ void __sk_del_bind_node(struct sock *sk)
561{
562 __hlist_del(&sk->sk_bind_node);
563}
564
565static __inline__ void sk_add_bind_node(struct sock *sk,
566 struct hlist_head *list)
567{
568 hlist_add_head(&sk->sk_bind_node, list);
569}
570
571#define sk_for_each(__sk, node, list) \
572 hlist_for_each_entry(__sk, node, list, sk_node)
stephen hemminger808f5112010-02-22 07:57:18 +0000573#define sk_for_each_rcu(__sk, node, list) \
574 hlist_for_each_entry_rcu(__sk, node, list, sk_node)
Eric Dumazet88ab1932008-11-16 19:39:21 -0800575#define sk_nulls_for_each(__sk, node, list) \
576 hlist_nulls_for_each_entry(__sk, node, list, sk_nulls_node)
577#define sk_nulls_for_each_rcu(__sk, node, list) \
578 hlist_nulls_for_each_entry_rcu(__sk, node, list, sk_nulls_node)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700579#define sk_for_each_from(__sk, node) \
580 if (__sk && ({ node = &(__sk)->sk_node; 1; })) \
581 hlist_for_each_entry_from(__sk, node, sk_node)
Eric Dumazet88ab1932008-11-16 19:39:21 -0800582#define sk_nulls_for_each_from(__sk, node) \
583 if (__sk && ({ node = &(__sk)->sk_nulls_node; 1; })) \
584 hlist_nulls_for_each_entry_from(__sk, node, sk_nulls_node)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700585#define sk_for_each_safe(__sk, node, tmp, list) \
586 hlist_for_each_entry_safe(__sk, node, tmp, list, sk_node)
587#define sk_for_each_bound(__sk, node, list) \
588 hlist_for_each_entry(__sk, node, list, sk_bind_node)
589
590/* Sock flags */
591enum sock_flags {
592 SOCK_DEAD,
593 SOCK_DONE,
594 SOCK_URGINLINE,
595 SOCK_KEEPOPEN,
596 SOCK_LINGER,
597 SOCK_DESTROY,
598 SOCK_BROADCAST,
599 SOCK_TIMESTAMP,
600 SOCK_ZAPPED,
601 SOCK_USE_WRITE_QUEUE, /* whether to call sk->sk_write_space in sock_wfree */
602 SOCK_DBG, /* %SO_DEBUG setting */
603 SOCK_RCVTSTAMP, /* %SO_TIMESTAMP setting */
Eric Dumazet92f37fd2007-03-25 22:14:49 -0700604 SOCK_RCVTSTAMPNS, /* %SO_TIMESTAMPNS setting */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700605 SOCK_LOCALROUTE, /* route locally only, %SO_DONTROUTE setting */
606 SOCK_QUEUE_SHRUNK, /* write queue has been shrunk recently */
Patrick Ohly20d49472009-02-12 05:03:38 +0000607 SOCK_TIMESTAMPING_TX_HARDWARE, /* %SOF_TIMESTAMPING_TX_HARDWARE */
608 SOCK_TIMESTAMPING_TX_SOFTWARE, /* %SOF_TIMESTAMPING_TX_SOFTWARE */
609 SOCK_TIMESTAMPING_RX_HARDWARE, /* %SOF_TIMESTAMPING_RX_HARDWARE */
610 SOCK_TIMESTAMPING_RX_SOFTWARE, /* %SOF_TIMESTAMPING_RX_SOFTWARE */
611 SOCK_TIMESTAMPING_SOFTWARE, /* %SOF_TIMESTAMPING_SOFTWARE */
612 SOCK_TIMESTAMPING_RAW_HARDWARE, /* %SOF_TIMESTAMPING_RAW_HARDWARE */
613 SOCK_TIMESTAMPING_SYS_HARDWARE, /* %SOF_TIMESTAMPING_SYS_HARDWARE */
Eric Dumazetbcdce712009-10-06 17:28:29 -0700614 SOCK_FASYNC, /* fasync() active */
Neil Horman3b885782009-10-12 13:26:31 -0700615 SOCK_RXQ_OVFL,
Shirley Ma1cdebb42011-07-06 12:17:30 +0000616 SOCK_ZEROCOPY, /* buffers from userspace */
Johannes Berg6e3e9392011-11-09 10:15:42 +0100617 SOCK_WIFI_STATUS, /* push wifi status to userspace */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700618};
619
Ralf Baechle53b924b2005-08-23 10:11:30 -0700620static inline void sock_copy_flags(struct sock *nsk, struct sock *osk)
621{
622 nsk->sk_flags = osk->sk_flags;
623}
624
Linus Torvalds1da177e2005-04-16 15:20:36 -0700625static inline void sock_set_flag(struct sock *sk, enum sock_flags flag)
626{
627 __set_bit(flag, &sk->sk_flags);
628}
629
630static inline void sock_reset_flag(struct sock *sk, enum sock_flags flag)
631{
632 __clear_bit(flag, &sk->sk_flags);
633}
634
635static inline int sock_flag(struct sock *sk, enum sock_flags flag)
636{
637 return test_bit(flag, &sk->sk_flags);
638}
639
640static inline void sk_acceptq_removed(struct sock *sk)
641{
642 sk->sk_ack_backlog--;
643}
644
645static inline void sk_acceptq_added(struct sock *sk)
646{
647 sk->sk_ack_backlog++;
648}
649
650static inline int sk_acceptq_is_full(struct sock *sk)
651{
David S. Miller64a14652007-03-06 11:21:05 -0800652 return sk->sk_ack_backlog > sk->sk_max_ack_backlog;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700653}
654
655/*
656 * Compute minimal free write space needed to queue new packets.
657 */
658static inline int sk_stream_min_wspace(struct sock *sk)
659{
Eric Dumazet8df09ea2007-12-21 03:07:41 -0800660 return sk->sk_wmem_queued >> 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700661}
662
663static inline int sk_stream_wspace(struct sock *sk)
664{
665 return sk->sk_sndbuf - sk->sk_wmem_queued;
666}
667
668extern void sk_stream_write_space(struct sock *sk);
669
670static inline int sk_stream_memory_free(struct sock *sk)
671{
672 return sk->sk_wmem_queued < sk->sk_sndbuf;
673}
674
Zhu Yi8eae9392010-03-04 18:01:40 +0000675/* OOB backlog add */
Zhu Yia3a858f2010-03-04 18:01:47 +0000676static inline void __sk_add_backlog(struct sock *sk, struct sk_buff *skb)
Stephen Hemminger9ee6b532005-11-08 09:39:42 -0800677{
Eric Dumazet7fee2262010-05-11 23:19:48 +0000678 /* dont let skb dst not refcounted, we are going to leave rcu lock */
679 skb_dst_force(skb);
680
681 if (!sk->sk_backlog.tail)
682 sk->sk_backlog.head = skb;
683 else
Stephen Hemminger9ee6b532005-11-08 09:39:42 -0800684 sk->sk_backlog.tail->next = skb;
Eric Dumazet7fee2262010-05-11 23:19:48 +0000685
686 sk->sk_backlog.tail = skb;
Stephen Hemminger9ee6b532005-11-08 09:39:42 -0800687 skb->next = NULL;
688}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700689
Eric Dumazetc3774112010-04-27 15:13:20 -0700690/*
691 * Take into account size of receive queue and backlog queue
Eric Dumazet0fd7bac2011-12-21 07:11:44 +0000692 * Do not take into account this skb truesize,
693 * to allow even a single big packet to come.
Eric Dumazetc3774112010-04-27 15:13:20 -0700694 */
695static inline bool sk_rcvqueues_full(const struct sock *sk, const struct sk_buff *skb)
696{
697 unsigned int qsize = sk->sk_backlog.len + atomic_read(&sk->sk_rmem_alloc);
698
Eric Dumazet0fd7bac2011-12-21 07:11:44 +0000699 return qsize > sk->sk_rcvbuf;
Eric Dumazetc3774112010-04-27 15:13:20 -0700700}
701
Zhu Yi8eae9392010-03-04 18:01:40 +0000702/* The per-socket spinlock must be held here. */
Zhu Yi40456352010-03-07 16:21:39 +0000703static inline __must_check int sk_add_backlog(struct sock *sk, struct sk_buff *skb)
Zhu Yi8eae9392010-03-04 18:01:40 +0000704{
Eric Dumazetc3774112010-04-27 15:13:20 -0700705 if (sk_rcvqueues_full(sk, skb))
Zhu Yi8eae9392010-03-04 18:01:40 +0000706 return -ENOBUFS;
707
Zhu Yia3a858f2010-03-04 18:01:47 +0000708 __sk_add_backlog(sk, skb);
Zhu Yi8eae9392010-03-04 18:01:40 +0000709 sk->sk_backlog.len += skb->truesize;
710 return 0;
711}
712
Peter Zijlstrac57943a2008-10-07 14:18:42 -0700713static inline int sk_backlog_rcv(struct sock *sk, struct sk_buff *skb)
714{
715 return sk->sk_backlog_rcv(sk, skb);
716}
717
David S. Millerc58dc012010-04-27 15:05:31 -0700718static inline void sock_rps_record_flow(const struct sock *sk)
719{
720#ifdef CONFIG_RPS
721 struct rps_sock_flow_table *sock_flow_table;
722
723 rcu_read_lock();
724 sock_flow_table = rcu_dereference(rps_sock_flow_table);
725 rps_record_sock_flow(sock_flow_table, sk->sk_rxhash);
726 rcu_read_unlock();
727#endif
728}
729
730static inline void sock_rps_reset_flow(const struct sock *sk)
731{
732#ifdef CONFIG_RPS
733 struct rps_sock_flow_table *sock_flow_table;
734
735 rcu_read_lock();
736 sock_flow_table = rcu_dereference(rps_sock_flow_table);
737 rps_reset_sock_flow(sock_flow_table, sk->sk_rxhash);
738 rcu_read_unlock();
739#endif
740}
741
Tom Herbertbdeab992011-08-14 19:45:55 +0000742static inline void sock_rps_save_rxhash(struct sock *sk,
743 const struct sk_buff *skb)
David S. Millerc58dc012010-04-27 15:05:31 -0700744{
745#ifdef CONFIG_RPS
Tom Herbertbdeab992011-08-14 19:45:55 +0000746 if (unlikely(sk->sk_rxhash != skb->rxhash)) {
David S. Millerc58dc012010-04-27 15:05:31 -0700747 sock_rps_reset_flow(sk);
Tom Herbertbdeab992011-08-14 19:45:55 +0000748 sk->sk_rxhash = skb->rxhash;
David S. Millerc58dc012010-04-27 15:05:31 -0700749 }
750#endif
751}
752
Tom Herbertbdeab992011-08-14 19:45:55 +0000753static inline void sock_rps_reset_rxhash(struct sock *sk)
754{
755#ifdef CONFIG_RPS
756 sock_rps_reset_flow(sk);
757 sk->sk_rxhash = 0;
758#endif
759}
760
Stephen Hemmingercfcabdc2007-10-09 01:59:42 -0700761#define sk_wait_event(__sk, __timeo, __condition) \
762 ({ int __rc; \
763 release_sock(__sk); \
764 __rc = __condition; \
765 if (!__rc) { \
766 *(__timeo) = schedule_timeout(*(__timeo)); \
767 } \
768 lock_sock(__sk); \
769 __rc = __condition; \
770 __rc; \
771 })
Linus Torvalds1da177e2005-04-16 15:20:36 -0700772
773extern int sk_stream_wait_connect(struct sock *sk, long *timeo_p);
774extern int sk_stream_wait_memory(struct sock *sk, long *timeo_p);
775extern void sk_stream_wait_close(struct sock *sk, long timeo_p);
776extern int sk_stream_error(struct sock *sk, int flags, int err);
777extern void sk_stream_kill_queues(struct sock *sk);
778
779extern int sk_wait_data(struct sock *sk, long *timeo);
780
Arnaldo Carvalho de Melo60236fd2005-06-18 22:47:21 -0700781struct request_sock_ops;
Arnaldo Carvalho de Melo6d6ee432005-12-13 23:25:19 -0800782struct timewait_sock_ops;
Arnaldo Carvalho de Meloab1e0a12008-02-03 04:06:04 -0800783struct inet_hashinfo;
Pavel Emelyanovfc8717b2008-03-22 16:56:51 -0700784struct raw_hashinfo;
Paul Gortmakerde477252011-05-26 13:46:22 -0400785struct module;
Arnaldo Carvalho de Melo2e6599c2005-06-18 22:46:52 -0700786
Linus Torvalds1da177e2005-04-16 15:20:36 -0700787/* Networking protocol blocks we attach to sockets.
788 * socket layer -> transport layer interface
789 * transport -> network interface is defined by struct inet_proto
790 */
791struct proto {
792 void (*close)(struct sock *sk,
793 long timeout);
794 int (*connect)(struct sock *sk,
795 struct sockaddr *uaddr,
796 int addr_len);
797 int (*disconnect)(struct sock *sk, int flags);
798
799 struct sock * (*accept) (struct sock *sk, int flags, int *err);
800
801 int (*ioctl)(struct sock *sk, int cmd,
802 unsigned long arg);
803 int (*init)(struct sock *sk);
Brian Haley7d06b2e2008-06-14 17:04:49 -0700804 void (*destroy)(struct sock *sk);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700805 void (*shutdown)(struct sock *sk, int how);
806 int (*setsockopt)(struct sock *sk, int level,
807 int optname, char __user *optval,
David S. Millerb7058842009-09-30 16:12:20 -0700808 unsigned int optlen);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700809 int (*getsockopt)(struct sock *sk, int level,
810 int optname, char __user *optval,
811 int __user *option);
Alexey Dobriyanaf01d532008-08-28 02:53:51 -0700812#ifdef CONFIG_COMPAT
Dmitry Mishin3fdadf72006-03-20 22:45:21 -0800813 int (*compat_setsockopt)(struct sock *sk,
814 int level,
815 int optname, char __user *optval,
David S. Millerb7058842009-09-30 16:12:20 -0700816 unsigned int optlen);
Dmitry Mishin3fdadf72006-03-20 22:45:21 -0800817 int (*compat_getsockopt)(struct sock *sk,
818 int level,
819 int optname, char __user *optval,
820 int __user *option);
Eric W. Biederman709b46e2011-01-29 16:15:56 +0000821 int (*compat_ioctl)(struct sock *sk,
822 unsigned int cmd, unsigned long arg);
Alexey Dobriyanaf01d532008-08-28 02:53:51 -0700823#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -0700824 int (*sendmsg)(struct kiocb *iocb, struct sock *sk,
825 struct msghdr *msg, size_t len);
826 int (*recvmsg)(struct kiocb *iocb, struct sock *sk,
827 struct msghdr *msg,
828 size_t len, int noblock, int flags,
829 int *addr_len);
830 int (*sendpage)(struct sock *sk, struct page *page,
831 int offset, size_t size, int flags);
832 int (*bind)(struct sock *sk,
833 struct sockaddr *uaddr, int addr_len);
834
835 int (*backlog_rcv) (struct sock *sk,
836 struct sk_buff *skb);
837
838 /* Keeping track of sk's, looking them up, and port selection methods. */
839 void (*hash)(struct sock *sk);
840 void (*unhash)(struct sock *sk);
Eric Dumazet719f8352010-09-08 05:08:44 +0000841 void (*rehash)(struct sock *sk);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700842 int (*get_port)(struct sock *sk, unsigned short snum);
Octavian Purdilafcbdf092010-12-16 14:26:56 -0800843 void (*clear_sk)(struct sock *sk, int size);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700844
Eric Dumazet286ab3d2007-11-05 23:38:39 -0800845 /* Keeping track of sockets in use */
Eric Dumazet65f76512008-01-03 20:46:48 -0800846#ifdef CONFIG_PROC_FS
Pavel Emelyanov13ff3d62008-03-28 16:38:17 -0700847 unsigned int inuse_idx;
Eric Dumazet65f76512008-01-03 20:46:48 -0800848#endif
Arnaldo Carvalho de Meloebb53d72007-11-21 22:08:50 +0800849
Linus Torvalds1da177e2005-04-16 15:20:36 -0700850 /* Memory pressure */
Pavel Emelyanov5c52ba12008-07-16 20:28:10 -0700851 void (*enter_memory_pressure)(struct sock *sk);
Eric Dumazet8d987e52010-11-09 23:24:26 +0000852 atomic_long_t *memory_allocated; /* Current allocated memory. */
Eric Dumazet17483762008-11-25 21:16:35 -0800853 struct percpu_counter *sockets_allocated; /* Current number of sockets. */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700854 /*
855 * Pressure flag: try to collapse.
856 * Technical note: it is used by multiple contexts non atomically.
Hideo Aoki3ab224b2007-12-31 00:11:19 -0800857 * All the __sk_mem_schedule() is of this nature: accounting
Linus Torvalds1da177e2005-04-16 15:20:36 -0700858 * is strict, actions are advisory and have some latency.
859 */
860 int *memory_pressure;
Eric Dumazet8d987e52010-11-09 23:24:26 +0000861 long *sysctl_mem;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700862 int *sysctl_wmem;
863 int *sysctl_rmem;
864 int max_header;
Changli Gao7ba42912010-07-10 20:41:55 +0000865 bool no_autobind;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700866
Eric Dumazet271b72c2008-10-29 02:11:14 -0700867 struct kmem_cache *slab;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700868 unsigned int obj_size;
Eric Dumazet271b72c2008-10-29 02:11:14 -0700869 int slab_flags;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700870
Eric Dumazetdd24c002008-11-25 21:17:14 -0800871 struct percpu_counter *orphan_count;
Arnaldo Carvalho de Melo8feaf0c2005-08-09 20:09:30 -0700872
Arnaldo Carvalho de Melo60236fd2005-06-18 22:47:21 -0700873 struct request_sock_ops *rsk_prot;
Arnaldo Carvalho de Melo6d6ee432005-12-13 23:25:19 -0800874 struct timewait_sock_ops *twsk_prot;
Arnaldo Carvalho de Melo2e6599c2005-06-18 22:46:52 -0700875
Pavel Emelyanov39d8cda2008-03-22 16:50:58 -0700876 union {
877 struct inet_hashinfo *hashinfo;
Eric Dumazet645ca702008-10-29 01:41:45 -0700878 struct udp_table *udp_table;
Pavel Emelyanovfc8717b2008-03-22 16:56:51 -0700879 struct raw_hashinfo *raw_hash;
Pavel Emelyanov39d8cda2008-03-22 16:50:58 -0700880 } h;
Arnaldo Carvalho de Meloab1e0a12008-02-03 04:06:04 -0800881
Linus Torvalds1da177e2005-04-16 15:20:36 -0700882 struct module *owner;
883
884 char name[32];
885
886 struct list_head node;
Arnaldo Carvalho de Meloe6848972005-08-09 19:45:38 -0700887#ifdef SOCK_REFCNT_DEBUG
888 atomic_t socks;
889#endif
Glauber Costae1aab162011-12-11 21:47:03 +0000890#ifdef CONFIG_CGROUP_MEM_RES_CTLR_KMEM
891 /*
892 * cgroup specific init/deinit functions. Called once for all
893 * protocols that implement it, from cgroups populate function.
894 * This function has to setup any files the protocol want to
895 * appear in the kmem cgroup filesystem.
896 */
897 int (*init_cgroup)(struct cgroup *cgrp,
898 struct cgroup_subsys *ss);
899 void (*destroy_cgroup)(struct cgroup *cgrp,
900 struct cgroup_subsys *ss);
901 struct cg_proto *(*proto_cgroup)(struct mem_cgroup *memcg);
902#endif
903};
904
905struct cg_proto {
906 void (*enter_memory_pressure)(struct sock *sk);
907 struct res_counter *memory_allocated; /* Current allocated memory. */
908 struct percpu_counter *sockets_allocated; /* Current number of sockets. */
909 int *memory_pressure;
910 long *sysctl_mem;
911 /*
912 * memcg field is used to find which memcg we belong directly
913 * Each memcg struct can hold more than one cg_proto, so container_of
914 * won't really cut.
915 *
916 * The elegant solution would be having an inverse function to
917 * proto_cgroup in struct proto, but that means polluting the structure
918 * for everybody, instead of just for memcg users.
919 */
920 struct mem_cgroup *memcg;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700921};
922
923extern int proto_register(struct proto *prot, int alloc_slab);
924extern void proto_unregister(struct proto *prot);
925
Arnaldo Carvalho de Meloe6848972005-08-09 19:45:38 -0700926#ifdef SOCK_REFCNT_DEBUG
927static inline void sk_refcnt_debug_inc(struct sock *sk)
928{
929 atomic_inc(&sk->sk_prot->socks);
930}
931
932static inline void sk_refcnt_debug_dec(struct sock *sk)
933{
934 atomic_dec(&sk->sk_prot->socks);
935 printk(KERN_DEBUG "%s socket %p released, %d are still alive\n",
936 sk->sk_prot->name, sk, atomic_read(&sk->sk_prot->socks));
937}
938
Glauber Costae1aab162011-12-11 21:47:03 +0000939inline void sk_refcnt_debug_release(const struct sock *sk)
Arnaldo Carvalho de Meloe6848972005-08-09 19:45:38 -0700940{
941 if (atomic_read(&sk->sk_refcnt) != 1)
942 printk(KERN_DEBUG "Destruction of the %s socket %p delayed, refcnt=%d\n",
943 sk->sk_prot->name, sk, atomic_read(&sk->sk_refcnt));
944}
945#else /* SOCK_REFCNT_DEBUG */
946#define sk_refcnt_debug_inc(sk) do { } while (0)
947#define sk_refcnt_debug_dec(sk) do { } while (0)
948#define sk_refcnt_debug_release(sk) do { } while (0)
949#endif /* SOCK_REFCNT_DEBUG */
950
Glauber Costa376be5f2012-01-20 04:57:14 +0000951#if defined(CONFIG_CGROUP_MEM_RES_CTLR_KMEM) && defined(CONFIG_NET)
Glauber Costae1aab162011-12-11 21:47:03 +0000952extern struct jump_label_key memcg_socket_limit_enabled;
953static inline struct cg_proto *parent_cg_proto(struct proto *proto,
954 struct cg_proto *cg_proto)
955{
956 return proto->proto_cgroup(parent_mem_cgroup(cg_proto->memcg));
957}
958#define mem_cgroup_sockets_enabled static_branch(&memcg_socket_limit_enabled)
959#else
960#define mem_cgroup_sockets_enabled 0
961static inline struct cg_proto *parent_cg_proto(struct proto *proto,
962 struct cg_proto *cg_proto)
963{
964 return NULL;
965}
966#endif
967
968
Glauber Costa180d8cd2011-12-11 21:47:02 +0000969static inline bool sk_has_memory_pressure(const struct sock *sk)
970{
971 return sk->sk_prot->memory_pressure != NULL;
972}
973
974static inline bool sk_under_memory_pressure(const struct sock *sk)
975{
976 if (!sk->sk_prot->memory_pressure)
977 return false;
Glauber Costae1aab162011-12-11 21:47:03 +0000978
979 if (mem_cgroup_sockets_enabled && sk->sk_cgrp)
980 return !!*sk->sk_cgrp->memory_pressure;
981
Glauber Costa180d8cd2011-12-11 21:47:02 +0000982 return !!*sk->sk_prot->memory_pressure;
983}
984
985static inline void sk_leave_memory_pressure(struct sock *sk)
986{
987 int *memory_pressure = sk->sk_prot->memory_pressure;
988
Glauber Costae1aab162011-12-11 21:47:03 +0000989 if (!memory_pressure)
990 return;
991
992 if (*memory_pressure)
Glauber Costa180d8cd2011-12-11 21:47:02 +0000993 *memory_pressure = 0;
Glauber Costae1aab162011-12-11 21:47:03 +0000994
995 if (mem_cgroup_sockets_enabled && sk->sk_cgrp) {
996 struct cg_proto *cg_proto = sk->sk_cgrp;
997 struct proto *prot = sk->sk_prot;
998
999 for (; cg_proto; cg_proto = parent_cg_proto(prot, cg_proto))
1000 if (*cg_proto->memory_pressure)
1001 *cg_proto->memory_pressure = 0;
1002 }
1003
Glauber Costa180d8cd2011-12-11 21:47:02 +00001004}
1005
1006static inline void sk_enter_memory_pressure(struct sock *sk)
1007{
Glauber Costae1aab162011-12-11 21:47:03 +00001008 if (!sk->sk_prot->enter_memory_pressure)
1009 return;
1010
1011 if (mem_cgroup_sockets_enabled && sk->sk_cgrp) {
1012 struct cg_proto *cg_proto = sk->sk_cgrp;
1013 struct proto *prot = sk->sk_prot;
1014
1015 for (; cg_proto; cg_proto = parent_cg_proto(prot, cg_proto))
1016 cg_proto->enter_memory_pressure(sk);
1017 }
1018
1019 sk->sk_prot->enter_memory_pressure(sk);
Glauber Costa180d8cd2011-12-11 21:47:02 +00001020}
1021
1022static inline long sk_prot_mem_limits(const struct sock *sk, int index)
1023{
1024 long *prot = sk->sk_prot->sysctl_mem;
Glauber Costae1aab162011-12-11 21:47:03 +00001025 if (mem_cgroup_sockets_enabled && sk->sk_cgrp)
1026 prot = sk->sk_cgrp->sysctl_mem;
Glauber Costa180d8cd2011-12-11 21:47:02 +00001027 return prot[index];
1028}
1029
Glauber Costae1aab162011-12-11 21:47:03 +00001030static inline void memcg_memory_allocated_add(struct cg_proto *prot,
1031 unsigned long amt,
1032 int *parent_status)
1033{
1034 struct res_counter *fail;
1035 int ret;
1036
Glauber Costa0e90b312012-01-20 04:57:16 +00001037 ret = res_counter_charge_nofail(prot->memory_allocated,
1038 amt << PAGE_SHIFT, &fail);
Glauber Costae1aab162011-12-11 21:47:03 +00001039 if (ret < 0)
1040 *parent_status = OVER_LIMIT;
1041}
1042
1043static inline void memcg_memory_allocated_sub(struct cg_proto *prot,
1044 unsigned long amt)
1045{
1046 res_counter_uncharge(prot->memory_allocated, amt << PAGE_SHIFT);
1047}
1048
1049static inline u64 memcg_memory_allocated_read(struct cg_proto *prot)
1050{
1051 u64 ret;
1052 ret = res_counter_read_u64(prot->memory_allocated, RES_USAGE);
1053 return ret >> PAGE_SHIFT;
1054}
1055
Glauber Costa180d8cd2011-12-11 21:47:02 +00001056static inline long
1057sk_memory_allocated(const struct sock *sk)
1058{
1059 struct proto *prot = sk->sk_prot;
Glauber Costae1aab162011-12-11 21:47:03 +00001060 if (mem_cgroup_sockets_enabled && sk->sk_cgrp)
1061 return memcg_memory_allocated_read(sk->sk_cgrp);
1062
Glauber Costa180d8cd2011-12-11 21:47:02 +00001063 return atomic_long_read(prot->memory_allocated);
1064}
1065
1066static inline long
Glauber Costae1aab162011-12-11 21:47:03 +00001067sk_memory_allocated_add(struct sock *sk, int amt, int *parent_status)
Glauber Costa180d8cd2011-12-11 21:47:02 +00001068{
1069 struct proto *prot = sk->sk_prot;
Glauber Costae1aab162011-12-11 21:47:03 +00001070
1071 if (mem_cgroup_sockets_enabled && sk->sk_cgrp) {
1072 memcg_memory_allocated_add(sk->sk_cgrp, amt, parent_status);
1073 /* update the root cgroup regardless */
1074 atomic_long_add_return(amt, prot->memory_allocated);
1075 return memcg_memory_allocated_read(sk->sk_cgrp);
1076 }
1077
Glauber Costa180d8cd2011-12-11 21:47:02 +00001078 return atomic_long_add_return(amt, prot->memory_allocated);
1079}
1080
1081static inline void
Glauber Costa0e90b312012-01-20 04:57:16 +00001082sk_memory_allocated_sub(struct sock *sk, int amt)
Glauber Costa180d8cd2011-12-11 21:47:02 +00001083{
1084 struct proto *prot = sk->sk_prot;
Glauber Costae1aab162011-12-11 21:47:03 +00001085
Glauber Costa0e90b312012-01-20 04:57:16 +00001086 if (mem_cgroup_sockets_enabled && sk->sk_cgrp)
Glauber Costae1aab162011-12-11 21:47:03 +00001087 memcg_memory_allocated_sub(sk->sk_cgrp, amt);
1088
Glauber Costa180d8cd2011-12-11 21:47:02 +00001089 atomic_long_sub(amt, prot->memory_allocated);
1090}
1091
1092static inline void sk_sockets_allocated_dec(struct sock *sk)
1093{
1094 struct proto *prot = sk->sk_prot;
Glauber Costae1aab162011-12-11 21:47:03 +00001095
1096 if (mem_cgroup_sockets_enabled && sk->sk_cgrp) {
1097 struct cg_proto *cg_proto = sk->sk_cgrp;
1098
1099 for (; cg_proto; cg_proto = parent_cg_proto(prot, cg_proto))
1100 percpu_counter_dec(cg_proto->sockets_allocated);
1101 }
1102
Glauber Costa180d8cd2011-12-11 21:47:02 +00001103 percpu_counter_dec(prot->sockets_allocated);
1104}
1105
1106static inline void sk_sockets_allocated_inc(struct sock *sk)
1107{
1108 struct proto *prot = sk->sk_prot;
Glauber Costae1aab162011-12-11 21:47:03 +00001109
1110 if (mem_cgroup_sockets_enabled && sk->sk_cgrp) {
1111 struct cg_proto *cg_proto = sk->sk_cgrp;
1112
1113 for (; cg_proto; cg_proto = parent_cg_proto(prot, cg_proto))
1114 percpu_counter_inc(cg_proto->sockets_allocated);
1115 }
1116
Glauber Costa180d8cd2011-12-11 21:47:02 +00001117 percpu_counter_inc(prot->sockets_allocated);
1118}
1119
1120static inline int
1121sk_sockets_allocated_read_positive(struct sock *sk)
1122{
1123 struct proto *prot = sk->sk_prot;
1124
Glauber Costae1aab162011-12-11 21:47:03 +00001125 if (mem_cgroup_sockets_enabled && sk->sk_cgrp)
1126 return percpu_counter_sum_positive(sk->sk_cgrp->sockets_allocated);
1127
Glauber Costa180d8cd2011-12-11 21:47:02 +00001128 return percpu_counter_sum_positive(prot->sockets_allocated);
1129}
1130
1131static inline int
1132proto_sockets_allocated_sum_positive(struct proto *prot)
1133{
1134 return percpu_counter_sum_positive(prot->sockets_allocated);
1135}
1136
1137static inline long
1138proto_memory_allocated(struct proto *prot)
1139{
1140 return atomic_long_read(prot->memory_allocated);
1141}
1142
1143static inline bool
1144proto_memory_pressure(struct proto *prot)
1145{
1146 if (!prot->memory_pressure)
1147 return false;
1148 return !!*prot->memory_pressure;
1149}
1150
Eric Dumazet65f76512008-01-03 20:46:48 -08001151
1152#ifdef CONFIG_PROC_FS
Linus Torvalds1da177e2005-04-16 15:20:36 -07001153/* Called with local bh disabled */
Pavel Emelyanovc29a0bc2008-03-31 19:41:46 -07001154extern void sock_prot_inuse_add(struct net *net, struct proto *prot, int inc);
1155extern int sock_prot_inuse_get(struct net *net, struct proto *proto);
Eric Dumazet65f76512008-01-03 20:46:48 -08001156#else
Pavel Emelyanovc29a0bc2008-03-31 19:41:46 -07001157static void inline sock_prot_inuse_add(struct net *net, struct proto *prot,
1158 int inc)
Eric Dumazet65f76512008-01-03 20:46:48 -08001159{
1160}
Eric Dumazet65f76512008-01-03 20:46:48 -08001161#endif
1162
Linus Torvalds1da177e2005-04-16 15:20:36 -07001163
Arnaldo Carvalho de Melo614c6cb2005-08-09 19:47:37 -07001164/* With per-bucket locks this operation is not-atomic, so that
1165 * this version is not worse.
1166 */
1167static inline void __sk_prot_rehash(struct sock *sk)
1168{
1169 sk->sk_prot->unhash(sk);
1170 sk->sk_prot->hash(sk);
1171}
1172
Octavian Purdilafcbdf092010-12-16 14:26:56 -08001173void sk_prot_clear_portaddr_nulls(struct sock *sk, int size);
1174
Linus Torvalds1da177e2005-04-16 15:20:36 -07001175/* About 10 seconds */
1176#define SOCK_DESTROY_TIME (10*HZ)
1177
1178/* Sockets 0-1023 can't be bound to unless you are superuser */
1179#define PROT_SOCK 1024
1180
1181#define SHUTDOWN_MASK 3
1182#define RCV_SHUTDOWN 1
1183#define SEND_SHUTDOWN 2
1184
1185#define SOCK_SNDBUF_LOCK 1
1186#define SOCK_RCVBUF_LOCK 2
1187#define SOCK_BINDADDR_LOCK 4
1188#define SOCK_BINDPORT_LOCK 8
1189
1190/* sock_iocb: used to kick off async processing of socket ios */
1191struct sock_iocb {
1192 struct list_head list;
1193
1194 int flags;
1195 int size;
1196 struct socket *sock;
1197 struct sock *sk;
1198 struct scm_cookie *scm;
1199 struct msghdr *msg, async_msg;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001200 struct kiocb *kiocb;
1201};
1202
1203static inline struct sock_iocb *kiocb_to_siocb(struct kiocb *iocb)
1204{
1205 return (struct sock_iocb *)iocb->private;
1206}
1207
1208static inline struct kiocb *siocb_to_kiocb(struct sock_iocb *si)
1209{
1210 return si->kiocb;
1211}
1212
1213struct socket_alloc {
1214 struct socket socket;
1215 struct inode vfs_inode;
1216};
1217
1218static inline struct socket *SOCKET_I(struct inode *inode)
1219{
1220 return &container_of(inode, struct socket_alloc, vfs_inode)->socket;
1221}
1222
1223static inline struct inode *SOCK_INODE(struct socket *socket)
1224{
1225 return &container_of(socket, struct socket_alloc, socket)->vfs_inode;
1226}
1227
Hideo Aoki3ab224b2007-12-31 00:11:19 -08001228/*
1229 * Functions for memory accounting
1230 */
1231extern int __sk_mem_schedule(struct sock *sk, int size, int kind);
1232extern void __sk_mem_reclaim(struct sock *sk);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001233
Hideo Aoki3ab224b2007-12-31 00:11:19 -08001234#define SK_MEM_QUANTUM ((int)PAGE_SIZE)
1235#define SK_MEM_QUANTUM_SHIFT ilog2(SK_MEM_QUANTUM)
1236#define SK_MEM_SEND 0
1237#define SK_MEM_RECV 1
Linus Torvalds1da177e2005-04-16 15:20:36 -07001238
Hideo Aoki3ab224b2007-12-31 00:11:19 -08001239static inline int sk_mem_pages(int amt)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001240{
Hideo Aoki3ab224b2007-12-31 00:11:19 -08001241 return (amt + SK_MEM_QUANTUM - 1) >> SK_MEM_QUANTUM_SHIFT;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001242}
1243
Hideo Aoki3ab224b2007-12-31 00:11:19 -08001244static inline int sk_has_account(struct sock *sk)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001245{
Hideo Aoki3ab224b2007-12-31 00:11:19 -08001246 /* return true if protocol supports memory accounting */
1247 return !!sk->sk_prot->memory_allocated;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001248}
1249
Hideo Aoki3ab224b2007-12-31 00:11:19 -08001250static inline int sk_wmem_schedule(struct sock *sk, int size)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001251{
Hideo Aoki3ab224b2007-12-31 00:11:19 -08001252 if (!sk_has_account(sk))
1253 return 1;
Herbert Xud80d99d2005-09-01 17:48:23 -07001254 return size <= sk->sk_forward_alloc ||
Hideo Aoki3ab224b2007-12-31 00:11:19 -08001255 __sk_mem_schedule(sk, size, SK_MEM_SEND);
1256}
1257
1258static inline int sk_rmem_schedule(struct sock *sk, int size)
1259{
1260 if (!sk_has_account(sk))
1261 return 1;
1262 return size <= sk->sk_forward_alloc ||
1263 __sk_mem_schedule(sk, size, SK_MEM_RECV);
1264}
1265
1266static inline void sk_mem_reclaim(struct sock *sk)
1267{
1268 if (!sk_has_account(sk))
1269 return;
1270 if (sk->sk_forward_alloc >= SK_MEM_QUANTUM)
1271 __sk_mem_reclaim(sk);
1272}
1273
David S. Miller9993e7d2008-01-10 21:56:38 -08001274static inline void sk_mem_reclaim_partial(struct sock *sk)
1275{
1276 if (!sk_has_account(sk))
1277 return;
1278 if (sk->sk_forward_alloc > SK_MEM_QUANTUM)
1279 __sk_mem_reclaim(sk);
1280}
1281
Hideo Aoki3ab224b2007-12-31 00:11:19 -08001282static inline void sk_mem_charge(struct sock *sk, int size)
1283{
1284 if (!sk_has_account(sk))
1285 return;
1286 sk->sk_forward_alloc -= size;
1287}
1288
1289static inline void sk_mem_uncharge(struct sock *sk, int size)
1290{
1291 if (!sk_has_account(sk))
1292 return;
1293 sk->sk_forward_alloc += size;
1294}
1295
1296static inline void sk_wmem_free_skb(struct sock *sk, struct sk_buff *skb)
1297{
Hideo Aoki3ab224b2007-12-31 00:11:19 -08001298 sock_set_flag(sk, SOCK_QUEUE_SHRUNK);
1299 sk->sk_wmem_queued -= skb->truesize;
1300 sk_mem_uncharge(sk, skb->truesize);
1301 __kfree_skb(skb);
Herbert Xud80d99d2005-09-01 17:48:23 -07001302}
1303
Linus Torvalds1da177e2005-04-16 15:20:36 -07001304/* Used by processes to "lock" a socket state, so that
1305 * interrupts and bottom half handlers won't change it
1306 * from under us. It essentially blocks any incoming
1307 * packets, so that we won't get any new data or any
1308 * packets that change the state of the socket.
1309 *
1310 * While locked, BH processing will add new packets to
1311 * the backlog queue. This queue is processed by the
1312 * owner of the socket lock right before it is released.
1313 *
1314 * Since ~2.3.5 it is also exclusive sleep lock serializing
1315 * accesses from user process context.
1316 */
John Heffnerd2e91172007-09-12 10:44:19 +02001317#define sock_owned_by_user(sk) ((sk)->sk_lock.owned)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001318
Peter Zijlstraed075362006-12-06 20:35:24 -08001319/*
1320 * Macro so as to not evaluate some arguments when
1321 * lockdep is not enabled.
1322 *
1323 * Mark both the sk_lock and the sk_lock.slock as a
1324 * per-address-family lock class.
1325 */
1326#define sock_lock_init_class_and_name(sk, sname, skey, name, key) \
1327do { \
Ingo Molnare8f6fbf2008-11-12 01:38:36 +00001328 sk->sk_lock.owned = 0; \
Peter Zijlstraed075362006-12-06 20:35:24 -08001329 init_waitqueue_head(&sk->sk_lock.wq); \
1330 spin_lock_init(&(sk)->sk_lock.slock); \
1331 debug_check_no_locks_freed((void *)&(sk)->sk_lock, \
1332 sizeof((sk)->sk_lock)); \
1333 lockdep_set_class_and_name(&(sk)->sk_lock.slock, \
1334 (skey), (sname)); \
1335 lockdep_init_map(&(sk)->sk_lock.dep_map, (name), (key), 0); \
1336} while (0)
1337
Harvey Harrison41380932007-12-12 10:46:51 -08001338extern void lock_sock_nested(struct sock *sk, int subclass);
Peter Zijlstrafcc70d52006-11-08 22:44:35 -08001339
1340static inline void lock_sock(struct sock *sk)
1341{
1342 lock_sock_nested(sk, 0);
1343}
1344
Harvey Harrison41380932007-12-12 10:46:51 -08001345extern void release_sock(struct sock *sk);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001346
1347/* BH context may only use the following locking interface. */
1348#define bh_lock_sock(__sk) spin_lock(&((__sk)->sk_lock.slock))
Ingo Molnarc6366182006-07-03 00:25:13 -07001349#define bh_lock_sock_nested(__sk) \
1350 spin_lock_nested(&((__sk)->sk_lock.slock), \
1351 SINGLE_DEPTH_NESTING)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001352#define bh_unlock_sock(__sk) spin_unlock(&((__sk)->sk_lock.slock))
1353
Eric Dumazet8a74ad62010-05-26 19:20:18 +00001354extern bool lock_sock_fast(struct sock *sk);
1355/**
1356 * unlock_sock_fast - complement of lock_sock_fast
1357 * @sk: socket
1358 * @slow: slow mode
1359 *
1360 * fast unlock socket for user context.
1361 * If slow mode is on, we call regular release_sock()
1362 */
1363static inline void unlock_sock_fast(struct sock *sk, bool slow)
Eric Dumazet4b0b72f2010-04-28 14:35:48 -07001364{
Eric Dumazet8a74ad62010-05-26 19:20:18 +00001365 if (slow)
1366 release_sock(sk);
1367 else
1368 spin_unlock_bh(&sk->sk_lock.slock);
Eric Dumazet4b0b72f2010-04-28 14:35:48 -07001369}
1370
Eric Dumazet4b0b72f2010-04-28 14:35:48 -07001371
Eric W. Biederman1b8d7ae2007-10-08 23:24:22 -07001372extern struct sock *sk_alloc(struct net *net, int family,
Al Virodd0fc662005-10-07 07:46:04 +01001373 gfp_t priority,
Pavel Emelyanov6257ff22007-11-01 00:39:31 -07001374 struct proto *prot);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001375extern void sk_free(struct sock *sk);
Denis V. Lunevedf02082008-02-29 11:18:32 -08001376extern void sk_release_kernel(struct sock *sk);
Eric Dumazete56c57d2011-11-08 17:07:07 -05001377extern struct sock *sk_clone_lock(const struct sock *sk,
1378 const gfp_t priority);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001379
1380extern struct sk_buff *sock_wmalloc(struct sock *sk,
1381 unsigned long size, int force,
Al Virodd0fc662005-10-07 07:46:04 +01001382 gfp_t priority);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001383extern struct sk_buff *sock_rmalloc(struct sock *sk,
1384 unsigned long size, int force,
Al Virodd0fc662005-10-07 07:46:04 +01001385 gfp_t priority);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001386extern void sock_wfree(struct sk_buff *skb);
1387extern void sock_rfree(struct sk_buff *skb);
1388
1389extern int sock_setsockopt(struct socket *sock, int level,
1390 int op, char __user *optval,
David S. Millerb7058842009-09-30 16:12:20 -07001391 unsigned int optlen);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001392
1393extern int sock_getsockopt(struct socket *sock, int level,
1394 int op, char __user *optval,
1395 int __user *optlen);
1396extern struct sk_buff *sock_alloc_send_skb(struct sock *sk,
1397 unsigned long size,
1398 int noblock,
1399 int *errcode);
Herbert Xu4cc7f682009-02-04 16:55:54 -08001400extern struct sk_buff *sock_alloc_send_pskb(struct sock *sk,
1401 unsigned long header_len,
1402 unsigned long data_len,
1403 int noblock,
1404 int *errcode);
Victor Fusco86a76ca2005-07-08 14:57:47 -07001405extern void *sock_kmalloc(struct sock *sk, int size,
Al Virodd0fc662005-10-07 07:46:04 +01001406 gfp_t priority);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001407extern void sock_kfree_s(struct sock *sk, void *mem, int size);
1408extern void sk_send_sigurg(struct sock *sk);
1409
Herbert Xuf8451722010-05-24 00:12:34 -07001410#ifdef CONFIG_CGROUPS
1411extern void sock_update_classid(struct sock *sk);
1412#else
1413static inline void sock_update_classid(struct sock *sk)
1414{
1415}
1416#endif
1417
Linus Torvalds1da177e2005-04-16 15:20:36 -07001418/*
1419 * Functions to fill in entries in struct proto_ops when a protocol
1420 * does not implement a particular function.
1421 */
1422extern int sock_no_bind(struct socket *,
1423 struct sockaddr *, int);
1424extern int sock_no_connect(struct socket *,
1425 struct sockaddr *, int, int);
1426extern int sock_no_socketpair(struct socket *,
1427 struct socket *);
1428extern int sock_no_accept(struct socket *,
1429 struct socket *, int);
1430extern int sock_no_getname(struct socket *,
1431 struct sockaddr *, int *, int);
1432extern unsigned int sock_no_poll(struct file *, struct socket *,
1433 struct poll_table_struct *);
1434extern int sock_no_ioctl(struct socket *, unsigned int,
1435 unsigned long);
1436extern int sock_no_listen(struct socket *, int);
1437extern int sock_no_shutdown(struct socket *, int);
1438extern int sock_no_getsockopt(struct socket *, int , int,
1439 char __user *, int __user *);
1440extern int sock_no_setsockopt(struct socket *, int, int,
David S. Millerb7058842009-09-30 16:12:20 -07001441 char __user *, unsigned int);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001442extern int sock_no_sendmsg(struct kiocb *, struct socket *,
1443 struct msghdr *, size_t);
1444extern int sock_no_recvmsg(struct kiocb *, struct socket *,
1445 struct msghdr *, size_t, int);
1446extern int sock_no_mmap(struct file *file,
1447 struct socket *sock,
1448 struct vm_area_struct *vma);
1449extern ssize_t sock_no_sendpage(struct socket *sock,
1450 struct page *page,
1451 int offset, size_t size,
1452 int flags);
1453
1454/*
1455 * Functions to fill in entries in struct proto_ops when a protocol
1456 * uses the inet style.
1457 */
1458extern int sock_common_getsockopt(struct socket *sock, int level, int optname,
1459 char __user *optval, int __user *optlen);
1460extern int sock_common_recvmsg(struct kiocb *iocb, struct socket *sock,
1461 struct msghdr *msg, size_t size, int flags);
1462extern int sock_common_setsockopt(struct socket *sock, int level, int optname,
David S. Millerb7058842009-09-30 16:12:20 -07001463 char __user *optval, unsigned int optlen);
Dmitry Mishin3fdadf72006-03-20 22:45:21 -08001464extern int compat_sock_common_getsockopt(struct socket *sock, int level,
1465 int optname, char __user *optval, int __user *optlen);
1466extern int compat_sock_common_setsockopt(struct socket *sock, int level,
David S. Millerb7058842009-09-30 16:12:20 -07001467 int optname, char __user *optval, unsigned int optlen);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001468
1469extern void sk_common_release(struct sock *sk);
1470
1471/*
1472 * Default socket callbacks and setup code
1473 */
1474
1475/* Initialise core socket variables */
1476extern void sock_init_data(struct socket *sock, struct sock *sk);
1477
Eric Dumazet46bcf142010-12-06 09:29:43 -08001478extern void sk_filter_release_rcu(struct rcu_head *rcu);
1479
Linus Torvalds1da177e2005-04-16 15:20:36 -07001480/**
Ben Hutchings1a5778a2010-02-14 22:35:47 -08001481 * sk_filter_release - release a socket filter
Paul Bonserdc9b3342006-11-23 17:56:13 -08001482 * @fp: filter to remove
1483 *
1484 * Remove a filter from a socket and release its resources.
1485 */
1486
Pavel Emelyanov309dd5f2007-10-17 21:21:51 -07001487static inline void sk_filter_release(struct sk_filter *fp)
1488{
1489 if (atomic_dec_and_test(&fp->refcnt))
Eric Dumazet80f8f102011-01-18 07:46:52 +00001490 call_rcu(&fp->rcu, sk_filter_release_rcu);
Pavel Emelyanov309dd5f2007-10-17 21:21:51 -07001491}
1492
1493static inline void sk_filter_uncharge(struct sock *sk, struct sk_filter *fp)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001494{
1495 unsigned int size = sk_filter_len(fp);
1496
1497 atomic_sub(size, &sk->sk_omem_alloc);
Pavel Emelyanov309dd5f2007-10-17 21:21:51 -07001498 sk_filter_release(fp);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001499}
1500
1501static inline void sk_filter_charge(struct sock *sk, struct sk_filter *fp)
1502{
1503 atomic_inc(&fp->refcnt);
1504 atomic_add(sk_filter_len(fp), &sk->sk_omem_alloc);
1505}
1506
1507/*
1508 * Socket reference counting postulates.
1509 *
1510 * * Each user of socket SHOULD hold a reference count.
1511 * * Each access point to socket (an hash table bucket, reference from a list,
1512 * running timer, skb in flight MUST hold a reference count.
1513 * * When reference count hits 0, it means it will never increase back.
1514 * * When reference count hits 0, it means that no references from
1515 * outside exist to this socket and current process on current CPU
1516 * is last user and may/should destroy this socket.
1517 * * sk_free is called from any context: process, BH, IRQ. When
1518 * it is called, socket has no references from outside -> sk_free
1519 * may release descendant resources allocated by the socket, but
1520 * to the time when it is called, socket is NOT referenced by any
1521 * hash tables, lists etc.
1522 * * Packets, delivered from outside (from network or from another process)
1523 * and enqueued on receive/error queues SHOULD NOT grab reference count,
1524 * when they sit in queue. Otherwise, packets will leak to hole, when
1525 * socket is looked up by one cpu and unhasing is made by another CPU.
1526 * It is true for udp/raw, netlink (leak to receive and error queues), tcp
1527 * (leak to backlog). Packet socket does all the processing inside
1528 * BR_NETPROTO_LOCK, so that it has not this race condition. UNIX sockets
1529 * use separate SMP lock, so that they are prone too.
1530 */
1531
1532/* Ungrab socket and destroy it, if it was the last reference. */
1533static inline void sock_put(struct sock *sk)
1534{
1535 if (atomic_dec_and_test(&sk->sk_refcnt))
1536 sk_free(sk);
1537}
1538
Arnaldo Carvalho de Melo58a5a7b2006-11-16 14:06:06 -02001539extern int sk_receive_skb(struct sock *sk, struct sk_buff *skb,
1540 const int nested);
Arnaldo Carvalho de Melo25995ff2005-12-27 02:42:22 -02001541
Krishna Kumare022f0b2009-10-19 23:46:20 +00001542static inline void sk_tx_queue_set(struct sock *sk, int tx_queue)
1543{
1544 sk->sk_tx_queue_mapping = tx_queue;
1545}
1546
1547static inline void sk_tx_queue_clear(struct sock *sk)
1548{
1549 sk->sk_tx_queue_mapping = -1;
1550}
1551
1552static inline int sk_tx_queue_get(const struct sock *sk)
1553{
Tom Herbertb0f77d02010-07-14 20:50:29 -07001554 return sk ? sk->sk_tx_queue_mapping : -1;
Krishna Kumare022f0b2009-10-19 23:46:20 +00001555}
1556
David S. Miller972692e2008-06-17 22:41:38 -07001557static inline void sk_set_socket(struct sock *sk, struct socket *sock)
1558{
Krishna Kumare022f0b2009-10-19 23:46:20 +00001559 sk_tx_queue_clear(sk);
David S. Miller972692e2008-06-17 22:41:38 -07001560 sk->sk_socket = sock;
1561}
1562
Eric Dumazetaa395142010-04-20 13:03:51 +00001563static inline wait_queue_head_t *sk_sleep(struct sock *sk)
1564{
Eric Dumazeteaefd112011-02-18 03:26:36 +00001565 BUILD_BUG_ON(offsetof(struct socket_wq, wait) != 0);
1566 return &rcu_dereference_raw(sk->sk_wq)->wait;
Eric Dumazetaa395142010-04-20 13:03:51 +00001567}
Linus Torvalds1da177e2005-04-16 15:20:36 -07001568/* Detach socket from process context.
1569 * Announce socket dead, detach it from wait queue and inode.
1570 * Note that parent inode held reference count on this struct sock,
1571 * we do not release it in this function, because protocol
1572 * probably wants some additional cleanups or even continuing
1573 * to work with this socket (TCP).
1574 */
1575static inline void sock_orphan(struct sock *sk)
1576{
1577 write_lock_bh(&sk->sk_callback_lock);
1578 sock_set_flag(sk, SOCK_DEAD);
David S. Miller972692e2008-06-17 22:41:38 -07001579 sk_set_socket(sk, NULL);
Eric Dumazet43815482010-04-29 11:01:49 +00001580 sk->sk_wq = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001581 write_unlock_bh(&sk->sk_callback_lock);
1582}
1583
1584static inline void sock_graft(struct sock *sk, struct socket *parent)
1585{
1586 write_lock_bh(&sk->sk_callback_lock);
Eric Dumazeteaefd112011-02-18 03:26:36 +00001587 sk->sk_wq = parent->wq;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001588 parent->sk = sk;
David S. Miller972692e2008-06-17 22:41:38 -07001589 sk_set_socket(sk, parent);
Venkat Yekkirala4237c752006-07-24 23:32:50 -07001590 security_sock_graft(sk, parent);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001591 write_unlock_bh(&sk->sk_callback_lock);
1592}
1593
1594extern int sock_i_uid(struct sock *sk);
1595extern unsigned long sock_i_ino(struct sock *sk);
1596
1597static inline struct dst_entry *
1598__sk_dst_get(struct sock *sk)
1599{
Michal Hockod8bf4ca2011-07-08 14:39:41 +02001600 return rcu_dereference_check(sk->sk_dst_cache, sock_owned_by_user(sk) ||
Eric Dumazetf68c2242010-04-22 16:06:59 -07001601 lockdep_is_held(&sk->sk_lock.slock));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001602}
1603
1604static inline struct dst_entry *
1605sk_dst_get(struct sock *sk)
1606{
1607 struct dst_entry *dst;
1608
Eric Dumazetb6c67122010-04-08 23:03:29 +00001609 rcu_read_lock();
1610 dst = rcu_dereference(sk->sk_dst_cache);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001611 if (dst)
1612 dst_hold(dst);
Eric Dumazetb6c67122010-04-08 23:03:29 +00001613 rcu_read_unlock();
Linus Torvalds1da177e2005-04-16 15:20:36 -07001614 return dst;
1615}
1616
Eric Dumazetb6c67122010-04-08 23:03:29 +00001617extern void sk_reset_txq(struct sock *sk);
1618
1619static inline void dst_negative_advice(struct sock *sk)
1620{
1621 struct dst_entry *ndst, *dst = __sk_dst_get(sk);
1622
1623 if (dst && dst->ops->negative_advice) {
1624 ndst = dst->ops->negative_advice(dst);
1625
1626 if (ndst != dst) {
1627 rcu_assign_pointer(sk->sk_dst_cache, ndst);
1628 sk_reset_txq(sk);
1629 }
1630 }
1631}
1632
Linus Torvalds1da177e2005-04-16 15:20:36 -07001633static inline void
1634__sk_dst_set(struct sock *sk, struct dst_entry *dst)
1635{
1636 struct dst_entry *old_dst;
1637
Krishna Kumare022f0b2009-10-19 23:46:20 +00001638 sk_tx_queue_clear(sk);
Eric Dumazet0b53ff22010-04-26 20:40:43 +00001639 /*
1640 * This can be called while sk is owned by the caller only,
1641 * with no state that can be checked in a rcu_dereference_check() cond
1642 */
1643 old_dst = rcu_dereference_raw(sk->sk_dst_cache);
Eric Dumazetb6c67122010-04-08 23:03:29 +00001644 rcu_assign_pointer(sk->sk_dst_cache, dst);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001645 dst_release(old_dst);
1646}
1647
1648static inline void
1649sk_dst_set(struct sock *sk, struct dst_entry *dst)
1650{
Eric Dumazetb6c67122010-04-08 23:03:29 +00001651 spin_lock(&sk->sk_dst_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001652 __sk_dst_set(sk, dst);
Eric Dumazetb6c67122010-04-08 23:03:29 +00001653 spin_unlock(&sk->sk_dst_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001654}
1655
1656static inline void
1657__sk_dst_reset(struct sock *sk)
1658{
Eric Dumazetb6c67122010-04-08 23:03:29 +00001659 __sk_dst_set(sk, NULL);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001660}
1661
1662static inline void
1663sk_dst_reset(struct sock *sk)
1664{
Eric Dumazetb6c67122010-04-08 23:03:29 +00001665 spin_lock(&sk->sk_dst_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001666 __sk_dst_reset(sk);
Eric Dumazetb6c67122010-04-08 23:03:29 +00001667 spin_unlock(&sk->sk_dst_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001668}
1669
Denis Vlasenkof0088a52006-03-28 01:08:21 -08001670extern struct dst_entry *__sk_dst_check(struct sock *sk, u32 cookie);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001671
Denis Vlasenkof0088a52006-03-28 01:08:21 -08001672extern struct dst_entry *sk_dst_check(struct sock *sk, u32 cookie);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001673
Herbert Xubcd76112006-06-30 13:36:35 -07001674static inline int sk_can_gso(const struct sock *sk)
1675{
1676 return net_gso_ok(sk->sk_route_caps, sk->sk_gso_type);
1677}
1678
Andi Kleen99580892007-04-20 17:12:43 -07001679extern void sk_setup_caps(struct sock *sk, struct dst_entry *dst);
Arnaldo Carvalho de Melo6cbb0df2005-08-09 19:49:02 -07001680
Michał Mirosławc8f44af2011-11-15 15:29:55 +00001681static inline void sk_nocaps_add(struct sock *sk, netdev_features_t flags)
Eric Dumazeta4654192010-05-16 00:36:33 -07001682{
1683 sk->sk_route_nocaps |= flags;
1684 sk->sk_route_caps &= ~flags;
1685}
1686
Tom Herbertc6e1a0d2011-04-04 22:30:30 -07001687static inline int skb_do_copy_data_nocache(struct sock *sk, struct sk_buff *skb,
1688 char __user *from, char *to,
Wei Yongjun912d3982011-04-06 18:40:12 +00001689 int copy, int offset)
Tom Herbertc6e1a0d2011-04-04 22:30:30 -07001690{
1691 if (skb->ip_summed == CHECKSUM_NONE) {
1692 int err = 0;
1693 __wsum csum = csum_and_copy_from_user(from, to, copy, 0, &err);
1694 if (err)
1695 return err;
Wei Yongjun912d3982011-04-06 18:40:12 +00001696 skb->csum = csum_block_add(skb->csum, csum, offset);
Tom Herbertc6e1a0d2011-04-04 22:30:30 -07001697 } else if (sk->sk_route_caps & NETIF_F_NOCACHE_COPY) {
1698 if (!access_ok(VERIFY_READ, from, copy) ||
1699 __copy_from_user_nocache(to, from, copy))
1700 return -EFAULT;
1701 } else if (copy_from_user(to, from, copy))
1702 return -EFAULT;
1703
1704 return 0;
1705}
1706
1707static inline int skb_add_data_nocache(struct sock *sk, struct sk_buff *skb,
1708 char __user *from, int copy)
1709{
Wei Yongjun912d3982011-04-06 18:40:12 +00001710 int err, offset = skb->len;
Tom Herbertc6e1a0d2011-04-04 22:30:30 -07001711
Wei Yongjun912d3982011-04-06 18:40:12 +00001712 err = skb_do_copy_data_nocache(sk, skb, from, skb_put(skb, copy),
1713 copy, offset);
Tom Herbertc6e1a0d2011-04-04 22:30:30 -07001714 if (err)
Wei Yongjun912d3982011-04-06 18:40:12 +00001715 __skb_trim(skb, offset);
Tom Herbertc6e1a0d2011-04-04 22:30:30 -07001716
1717 return err;
1718}
1719
1720static inline int skb_copy_to_page_nocache(struct sock *sk, char __user *from,
1721 struct sk_buff *skb,
1722 struct page *page,
1723 int off, int copy)
1724{
1725 int err;
1726
Wei Yongjun912d3982011-04-06 18:40:12 +00001727 err = skb_do_copy_data_nocache(sk, skb, from, page_address(page) + off,
1728 copy, skb->len);
Tom Herbertc6e1a0d2011-04-04 22:30:30 -07001729 if (err)
1730 return err;
1731
1732 skb->len += copy;
1733 skb->data_len += copy;
1734 skb->truesize += copy;
1735 sk->sk_wmem_queued += copy;
1736 sk_mem_charge(sk, copy);
1737 return 0;
1738}
1739
Linus Torvalds1da177e2005-04-16 15:20:36 -07001740static inline int skb_copy_to_page(struct sock *sk, char __user *from,
1741 struct sk_buff *skb, struct page *page,
1742 int off, int copy)
1743{
1744 if (skb->ip_summed == CHECKSUM_NONE) {
1745 int err = 0;
Al Viro50842052006-11-14 21:36:34 -08001746 __wsum csum = csum_and_copy_from_user(from,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001747 page_address(page) + off,
1748 copy, 0, &err);
1749 if (err)
1750 return err;
1751 skb->csum = csum_block_add(skb->csum, csum, skb->len);
1752 } else if (copy_from_user(page_address(page) + off, from, copy))
1753 return -EFAULT;
1754
1755 skb->len += copy;
1756 skb->data_len += copy;
1757 skb->truesize += copy;
1758 sk->sk_wmem_queued += copy;
Hideo Aoki3ab224b2007-12-31 00:11:19 -08001759 sk_mem_charge(sk, copy);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001760 return 0;
1761}
1762
Eric Dumazetc5640392009-06-16 10:12:03 +00001763/**
1764 * sk_wmem_alloc_get - returns write allocations
1765 * @sk: socket
1766 *
1767 * Returns sk_wmem_alloc minus initial offset of one
1768 */
1769static inline int sk_wmem_alloc_get(const struct sock *sk)
1770{
1771 return atomic_read(&sk->sk_wmem_alloc) - 1;
1772}
1773
1774/**
1775 * sk_rmem_alloc_get - returns read allocations
1776 * @sk: socket
1777 *
1778 * Returns sk_rmem_alloc
1779 */
1780static inline int sk_rmem_alloc_get(const struct sock *sk)
1781{
1782 return atomic_read(&sk->sk_rmem_alloc);
1783}
1784
1785/**
1786 * sk_has_allocations - check if allocations are outstanding
1787 * @sk: socket
1788 *
1789 * Returns true if socket has write or read allocations
1790 */
1791static inline int sk_has_allocations(const struct sock *sk)
1792{
1793 return sk_wmem_alloc_get(sk) || sk_rmem_alloc_get(sk);
1794}
1795
Jiri Olsaa57de0b2009-07-08 12:09:13 +00001796/**
Eric Dumazet43815482010-04-29 11:01:49 +00001797 * wq_has_sleeper - check if there are any waiting processes
Randy Dunlapacfbe962010-05-24 23:54:18 -07001798 * @wq: struct socket_wq
Jiri Olsaa57de0b2009-07-08 12:09:13 +00001799 *
Eric Dumazet43815482010-04-29 11:01:49 +00001800 * Returns true if socket_wq has waiting processes
Jiri Olsaa57de0b2009-07-08 12:09:13 +00001801 *
Eric Dumazet43815482010-04-29 11:01:49 +00001802 * The purpose of the wq_has_sleeper and sock_poll_wait is to wrap the memory
Jiri Olsaa57de0b2009-07-08 12:09:13 +00001803 * barrier call. They were added due to the race found within the tcp code.
1804 *
1805 * Consider following tcp code paths:
1806 *
1807 * CPU1 CPU2
1808 *
1809 * sys_select receive packet
1810 * ... ...
1811 * __add_wait_queue update tp->rcv_nxt
1812 * ... ...
1813 * tp->rcv_nxt check sock_def_readable
1814 * ... {
Eric Dumazet43815482010-04-29 11:01:49 +00001815 * schedule rcu_read_lock();
1816 * wq = rcu_dereference(sk->sk_wq);
1817 * if (wq && waitqueue_active(&wq->wait))
1818 * wake_up_interruptible(&wq->wait)
Jiri Olsaa57de0b2009-07-08 12:09:13 +00001819 * ...
1820 * }
1821 *
1822 * The race for tcp fires when the __add_wait_queue changes done by CPU1 stay
1823 * in its cache, and so does the tp->rcv_nxt update on CPU2 side. The CPU1
1824 * could then endup calling schedule and sleep forever if there are no more
1825 * data on the socket.
Jiri Olsaad462762009-07-08 12:10:31 +00001826 *
Jiri Olsaa57de0b2009-07-08 12:09:13 +00001827 */
Eric Dumazet43815482010-04-29 11:01:49 +00001828static inline bool wq_has_sleeper(struct socket_wq *wq)
Jiri Olsaa57de0b2009-07-08 12:09:13 +00001829{
Eric Dumazet43815482010-04-29 11:01:49 +00001830
Jiri Olsaa57de0b2009-07-08 12:09:13 +00001831 /*
1832 * We need to be sure we are in sync with the
1833 * add_wait_queue modifications to the wait queue.
1834 *
1835 * This memory barrier is paired in the sock_poll_wait.
1836 */
Eric Dumazet43815482010-04-29 11:01:49 +00001837 smp_mb();
1838 return wq && waitqueue_active(&wq->wait);
Jiri Olsaa57de0b2009-07-08 12:09:13 +00001839}
1840
1841/**
1842 * sock_poll_wait - place memory barrier behind the poll_wait call.
1843 * @filp: file
1844 * @wait_address: socket wait queue
1845 * @p: poll_table
1846 *
Eric Dumazet43815482010-04-29 11:01:49 +00001847 * See the comments in the wq_has_sleeper function.
Jiri Olsaa57de0b2009-07-08 12:09:13 +00001848 */
1849static inline void sock_poll_wait(struct file *filp,
1850 wait_queue_head_t *wait_address, poll_table *p)
1851{
1852 if (p && wait_address) {
1853 poll_wait(filp, wait_address, p);
1854 /*
1855 * We need to be sure we are in sync with the
1856 * socket flags modification.
1857 *
Eric Dumazet43815482010-04-29 11:01:49 +00001858 * This memory barrier is paired in the wq_has_sleeper.
Jiri Olsaa57de0b2009-07-08 12:09:13 +00001859 */
1860 smp_mb();
1861 }
1862}
1863
Linus Torvalds1da177e2005-04-16 15:20:36 -07001864/*
1865 * Queue a received datagram if it will fit. Stream and sequenced
1866 * protocols can't normally use this as they need to fit buffers in
1867 * and play with them.
1868 *
1869 * Inlined as it's very short and called for pretty much every
1870 * packet ever received.
1871 */
1872
1873static inline void skb_set_owner_w(struct sk_buff *skb, struct sock *sk)
1874{
Herbert Xud55d87f2009-06-22 02:25:25 +00001875 skb_orphan(skb);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001876 skb->sk = sk;
1877 skb->destructor = sock_wfree;
Eric Dumazet2b85a342009-06-11 02:55:43 -07001878 /*
1879 * We used to take a refcount on sk, but following operation
1880 * is enough to guarantee sk_free() wont free this sock until
1881 * all in-flight packets are completed
1882 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001883 atomic_add(skb->truesize, &sk->sk_wmem_alloc);
1884}
1885
1886static inline void skb_set_owner_r(struct sk_buff *skb, struct sock *sk)
1887{
Herbert Xud55d87f2009-06-22 02:25:25 +00001888 skb_orphan(skb);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001889 skb->sk = sk;
1890 skb->destructor = sock_rfree;
1891 atomic_add(skb->truesize, &sk->sk_rmem_alloc);
Hideo Aoki3ab224b2007-12-31 00:11:19 -08001892 sk_mem_charge(sk, skb->truesize);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001893}
1894
1895extern void sk_reset_timer(struct sock *sk, struct timer_list* timer,
1896 unsigned long expires);
1897
1898extern void sk_stop_timer(struct sock *sk, struct timer_list* timer);
1899
Denis Vlasenkof0088a52006-03-28 01:08:21 -08001900extern int sock_queue_rcv_skb(struct sock *sk, struct sk_buff *skb);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001901
Eric Dumazetb1faf562010-05-31 23:44:05 -07001902extern int sock_queue_err_skb(struct sock *sk, struct sk_buff *skb);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001903
1904/*
1905 * Recover an error report and clear atomically
1906 */
1907
1908static inline int sock_error(struct sock *sk)
1909{
Benjamin LaHaisec1cbe4b2005-12-13 23:22:19 -08001910 int err;
1911 if (likely(!sk->sk_err))
1912 return 0;
1913 err = xchg(&sk->sk_err, 0);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001914 return -err;
1915}
1916
1917static inline unsigned long sock_wspace(struct sock *sk)
1918{
1919 int amt = 0;
1920
1921 if (!(sk->sk_shutdown & SEND_SHUTDOWN)) {
1922 amt = sk->sk_sndbuf - atomic_read(&sk->sk_wmem_alloc);
1923 if (amt < 0)
1924 amt = 0;
1925 }
1926 return amt;
1927}
1928
1929static inline void sk_wake_async(struct sock *sk, int how, int band)
1930{
Eric Dumazetbcdce712009-10-06 17:28:29 -07001931 if (sock_flag(sk, SOCK_FASYNC))
Linus Torvalds1da177e2005-04-16 15:20:36 -07001932 sock_wake_async(sk->sk_socket, how, band);
1933}
1934
1935#define SOCK_MIN_SNDBUF 2048
Eric Dumazet7a91b4342010-09-26 18:53:07 -07001936/*
1937 * Since sk_rmem_alloc sums skb->truesize, even a small frame might need
1938 * sizeof(sk_buff) + MTU + padding, unless net driver perform copybreak
1939 */
1940#define SOCK_MIN_RCVBUF (2048 + sizeof(struct sk_buff))
Linus Torvalds1da177e2005-04-16 15:20:36 -07001941
1942static inline void sk_stream_moderate_sndbuf(struct sock *sk)
1943{
1944 if (!(sk->sk_userlocks & SOCK_SNDBUF_LOCK)) {
Eric Dumazet8df09ea2007-12-21 03:07:41 -08001945 sk->sk_sndbuf = min(sk->sk_sndbuf, sk->sk_wmem_queued >> 1);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001946 sk->sk_sndbuf = max(sk->sk_sndbuf, SOCK_MIN_SNDBUF);
1947 }
1948}
1949
Pavel Emelyanovdf97c702007-11-29 21:22:33 +11001950struct sk_buff *sk_stream_alloc_skb(struct sock *sk, int size, gfp_t gfp);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001951
1952static inline struct page *sk_stream_alloc_page(struct sock *sk)
1953{
1954 struct page *page = NULL;
1955
Herbert Xuef015782005-09-01 17:48:59 -07001956 page = alloc_pages(sk->sk_allocation, 0);
1957 if (!page) {
Glauber Costa180d8cd2011-12-11 21:47:02 +00001958 sk_enter_memory_pressure(sk);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001959 sk_stream_moderate_sndbuf(sk);
1960 }
1961 return page;
1962}
1963
Linus Torvalds1da177e2005-04-16 15:20:36 -07001964/*
1965 * Default write policy as shown to user space via poll/select/SIGIO
1966 */
1967static inline int sock_writeable(const struct sock *sk)
1968{
Eric Dumazet8df09ea2007-12-21 03:07:41 -08001969 return atomic_read(&sk->sk_wmem_alloc) < (sk->sk_sndbuf >> 1);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001970}
1971
Al Virodd0fc662005-10-07 07:46:04 +01001972static inline gfp_t gfp_any(void)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001973{
Andrew Morton99709372009-02-12 16:43:17 -08001974 return in_softirq() ? GFP_ATOMIC : GFP_KERNEL;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001975}
1976
1977static inline long sock_rcvtimeo(const struct sock *sk, int noblock)
1978{
1979 return noblock ? 0 : sk->sk_rcvtimeo;
1980}
1981
1982static inline long sock_sndtimeo(const struct sock *sk, int noblock)
1983{
1984 return noblock ? 0 : sk->sk_sndtimeo;
1985}
1986
1987static inline int sock_rcvlowat(const struct sock *sk, int waitall, int len)
1988{
1989 return (waitall ? len : min_t(int, sk->sk_rcvlowat, len)) ? : 1;
1990}
1991
1992/* Alas, with timeout socket operations are not restartable.
1993 * Compare this to poll().
1994 */
1995static inline int sock_intr_errno(long timeo)
1996{
1997 return timeo == MAX_SCHEDULE_TIMEOUT ? -ERESTARTSYS : -EINTR;
1998}
1999
Eric Dumazet92f37fd2007-03-25 22:14:49 -07002000extern void __sock_recv_timestamp(struct msghdr *msg, struct sock *sk,
2001 struct sk_buff *skb);
Johannes Berg6e3e9392011-11-09 10:15:42 +01002002extern void __sock_recv_wifi_status(struct msghdr *msg, struct sock *sk,
2003 struct sk_buff *skb);
Eric Dumazet92f37fd2007-03-25 22:14:49 -07002004
Linus Torvalds1da177e2005-04-16 15:20:36 -07002005static __inline__ void
2006sock_recv_timestamp(struct msghdr *msg, struct sock *sk, struct sk_buff *skb)
2007{
Eric Dumazetb7aa0bf2007-04-19 16:16:32 -07002008 ktime_t kt = skb->tstamp;
Patrick Ohly20d49472009-02-12 05:03:38 +00002009 struct skb_shared_hwtstamps *hwtstamps = skb_hwtstamps(skb);
Patrick McHardya61bbcf2005-08-14 17:24:31 -07002010
Patrick Ohly20d49472009-02-12 05:03:38 +00002011 /*
2012 * generate control messages if
2013 * - receive time stamping in software requested (SOCK_RCVTSTAMP
2014 * or SOCK_TIMESTAMPING_RX_SOFTWARE)
2015 * - software time stamp available and wanted
2016 * (SOCK_TIMESTAMPING_SOFTWARE)
2017 * - hardware time stamps available and wanted
2018 * (SOCK_TIMESTAMPING_SYS_HARDWARE or
2019 * SOCK_TIMESTAMPING_RAW_HARDWARE)
2020 */
2021 if (sock_flag(sk, SOCK_RCVTSTAMP) ||
2022 sock_flag(sk, SOCK_TIMESTAMPING_RX_SOFTWARE) ||
2023 (kt.tv64 && sock_flag(sk, SOCK_TIMESTAMPING_SOFTWARE)) ||
2024 (hwtstamps->hwtstamp.tv64 &&
2025 sock_flag(sk, SOCK_TIMESTAMPING_RAW_HARDWARE)) ||
2026 (hwtstamps->syststamp.tv64 &&
2027 sock_flag(sk, SOCK_TIMESTAMPING_SYS_HARDWARE)))
Eric Dumazet92f37fd2007-03-25 22:14:49 -07002028 __sock_recv_timestamp(msg, sk, skb);
2029 else
Eric Dumazetb7aa0bf2007-04-19 16:16:32 -07002030 sk->sk_stamp = kt;
Johannes Berg6e3e9392011-11-09 10:15:42 +01002031
2032 if (sock_flag(sk, SOCK_WIFI_STATUS) && skb->wifi_acked_valid)
2033 __sock_recv_wifi_status(msg, sk, skb);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002034}
2035
Eric Dumazet767dd032010-04-28 19:14:43 +00002036extern void __sock_recv_ts_and_drops(struct msghdr *msg, struct sock *sk,
2037 struct sk_buff *skb);
2038
2039static inline void sock_recv_ts_and_drops(struct msghdr *msg, struct sock *sk,
2040 struct sk_buff *skb)
2041{
2042#define FLAGS_TS_OR_DROPS ((1UL << SOCK_RXQ_OVFL) | \
2043 (1UL << SOCK_RCVTSTAMP) | \
2044 (1UL << SOCK_TIMESTAMPING_RX_SOFTWARE) | \
2045 (1UL << SOCK_TIMESTAMPING_SOFTWARE) | \
2046 (1UL << SOCK_TIMESTAMPING_RAW_HARDWARE) | \
2047 (1UL << SOCK_TIMESTAMPING_SYS_HARDWARE))
2048
2049 if (sk->sk_flags & FLAGS_TS_OR_DROPS)
2050 __sock_recv_ts_and_drops(msg, sk, skb);
2051 else
2052 sk->sk_stamp = skb->tstamp;
2053}
Neil Horman3b885782009-10-12 13:26:31 -07002054
Linus Torvalds1da177e2005-04-16 15:20:36 -07002055/**
Patrick Ohly20d49472009-02-12 05:03:38 +00002056 * sock_tx_timestamp - checks whether the outgoing packet is to be time stamped
Patrick Ohly20d49472009-02-12 05:03:38 +00002057 * @sk: socket sending this packet
Oliver Hartkopp2244d072010-08-17 08:59:14 +00002058 * @tx_flags: filled with instructions for time stamping
Patrick Ohly20d49472009-02-12 05:03:38 +00002059 *
2060 * Currently only depends on SOCK_TIMESTAMPING* flags. Returns error code if
2061 * parameters are invalid.
2062 */
Oliver Hartkopp2244d072010-08-17 08:59:14 +00002063extern int sock_tx_timestamp(struct sock *sk, __u8 *tx_flags);
Patrick Ohly20d49472009-02-12 05:03:38 +00002064
2065/**
Linus Torvalds1da177e2005-04-16 15:20:36 -07002066 * sk_eat_skb - Release a skb if it is no longer needed
Pavel Pisa4dc3b162005-05-01 08:59:25 -07002067 * @sk: socket to eat this skb from
2068 * @skb: socket buffer to eat
Randy Dunlapf4b8ea72006-06-22 16:00:11 -07002069 * @copied_early: flag indicating whether DMA operations copied this data early
Linus Torvalds1da177e2005-04-16 15:20:36 -07002070 *
2071 * This routine must be called with interrupts disabled or with the socket
2072 * locked so that the sk_buff queue operation is ok.
2073*/
Chris Leech624d1162006-05-23 18:01:28 -07002074#ifdef CONFIG_NET_DMA
2075static inline void sk_eat_skb(struct sock *sk, struct sk_buff *skb, int copied_early)
2076{
2077 __skb_unlink(skb, &sk->sk_receive_queue);
2078 if (!copied_early)
2079 __kfree_skb(skb);
2080 else
2081 __skb_queue_tail(&sk->sk_async_wait_queue, skb);
2082}
2083#else
2084static inline void sk_eat_skb(struct sock *sk, struct sk_buff *skb, int copied_early)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002085{
2086 __skb_unlink(skb, &sk->sk_receive_queue);
2087 __kfree_skb(skb);
2088}
Chris Leech624d1162006-05-23 18:01:28 -07002089#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -07002090
YOSHIFUJI Hideaki3b1e0a62008-03-26 02:26:21 +09002091static inline
2092struct net *sock_net(const struct sock *sk)
2093{
Eric Dumazetc2d9ba92010-06-01 06:51:19 +00002094 return read_pnet(&sk->sk_net);
YOSHIFUJI Hideaki3b1e0a62008-03-26 02:26:21 +09002095}
2096
2097static inline
Denis V. Lunevf5aa23f2008-03-26 00:48:17 -07002098void sock_net_set(struct sock *sk, struct net *net)
YOSHIFUJI Hideaki3b1e0a62008-03-26 02:26:21 +09002099{
Eric Dumazetc2d9ba92010-06-01 06:51:19 +00002100 write_pnet(&sk->sk_net, net);
YOSHIFUJI Hideaki3b1e0a62008-03-26 02:26:21 +09002101}
2102
Denis V. Lunevedf02082008-02-29 11:18:32 -08002103/*
2104 * Kernel sockets, f.e. rtnl or icmp_socket, are a part of a namespace.
Lucas De Marchi25985ed2011-03-30 22:57:33 -03002105 * They should not hold a reference to a namespace in order to allow
Denis V. Lunevedf02082008-02-29 11:18:32 -08002106 * to stop it.
2107 * Sockets after sk_change_net should be released using sk_release_kernel
2108 */
2109static inline void sk_change_net(struct sock *sk, struct net *net)
2110{
YOSHIFUJI Hideaki3b1e0a62008-03-26 02:26:21 +09002111 put_net(sock_net(sk));
Denis V. Lunev65a18ec2008-04-16 01:59:46 -07002112 sock_net_set(sk, hold_net(net));
Denis V. Lunevedf02082008-02-29 11:18:32 -08002113}
2114
KOVACS Krisztian23542612008-10-07 12:41:01 -07002115static inline struct sock *skb_steal_sock(struct sk_buff *skb)
2116{
2117 if (unlikely(skb->sk)) {
2118 struct sock *sk = skb->sk;
2119
2120 skb->destructor = NULL;
2121 skb->sk = NULL;
2122 return sk;
2123 }
2124 return NULL;
2125}
2126
Patrick Ohly20d49472009-02-12 05:03:38 +00002127extern void sock_enable_timestamp(struct sock *sk, int flag);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002128extern int sock_get_timestamp(struct sock *, struct timeval __user *);
Eric Dumazetae40eb12007-03-18 17:33:16 -07002129extern int sock_get_timestampns(struct sock *, struct timespec __user *);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002130
2131/*
2132 * Enable debug/info messages
2133 */
Stephen Hemmingera2a316f2007-03-08 20:41:08 -08002134extern int net_msg_warn;
2135#define NETDEBUG(fmt, args...) \
2136 do { if (net_msg_warn) printk(fmt,##args); } while (0)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002137
Stephen Hemmingera2a316f2007-03-08 20:41:08 -08002138#define LIMIT_NETDEBUG(fmt, args...) \
2139 do { if (net_msg_warn && net_ratelimit()) printk(fmt,##args); } while(0)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002140
Linus Torvalds1da177e2005-04-16 15:20:36 -07002141extern __u32 sysctl_wmem_max;
2142extern __u32 sysctl_rmem_max;
2143
Arnaldo Carvalho de Melo20380732005-08-16 02:18:02 -03002144extern void sk_init(void);
2145
David S. Miller6baf1f42005-09-05 18:14:11 -07002146extern int sysctl_optmem_max;
2147
Arnaldo Carvalho de Melo20380732005-08-16 02:18:02 -03002148extern __u32 sysctl_wmem_default;
2149extern __u32 sysctl_rmem_default;
Arnaldo Carvalho de Melo20380732005-08-16 02:18:02 -03002150
Linus Torvalds1da177e2005-04-16 15:20:36 -07002151#endif /* _SOCK_H */