blob: 19cfe1fc911ccf13b8298e73dfd789024065b9a7 [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>
Glauber Costa3f134612012-05-29 15:07:11 -070049#include <linux/bitops.h>
Ingo Molnara5b5bb92006-07-03 00:25:35 -070050#include <linux/lockdep.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070051#include <linux/netdevice.h>
52#include <linux/skbuff.h> /* struct sk_buff */
Al Virod7fe0f22006-12-03 23:15:30 -050053#include <linux/mm.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070054#include <linux/security.h>
Tejun Heo5a0e3ad2010-03-24 17:04:11 +090055#include <linux/slab.h>
Tom Herbertc6e1a0d2011-04-04 22:30:30 -070056#include <linux/uaccess.h>
Johannes Weiner3e32cb22014-12-10 15:42:31 -080057#include <linux/page_counter.h>
Glauber Costa180d8cd2011-12-11 21:47:02 +000058#include <linux/memcontrol.h>
Ingo Molnarc5905af2012-02-24 08:31:31 +010059#include <linux/static_key.h>
Al Viro40401532012-02-13 03:58:52 +000060#include <linux/sched.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070061
62#include <linux/filter.h>
Eric Dumazet88ab1932008-11-16 19:39:21 -080063#include <linux/rculist_nulls.h>
Jiri Olsaa57de0b2009-07-08 12:09:13 +000064#include <linux/poll.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070065
Eric Dumazetc31504d2010-11-15 19:58:26 +000066#include <linux/atomic.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070067#include <net/dst.h>
68#include <net/checksum.h>
Eric Dumazet1d0ab252015-03-15 21:12:12 -070069#include <net/tcp_states.h>
Willem de Bruijnb9f40e22014-08-04 22:11:46 -040070#include <linux/net_tstamp.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070071
Eric Dumazet9f048bf2011-12-13 03:59:08 +000072struct cgroup;
73struct cgroup_subsys;
Glauber Costac607b2e2011-12-16 00:52:00 +000074#ifdef CONFIG_NET
Glauber Costa1d62e432012-04-09 19:36:33 -030075int mem_cgroup_sockets_init(struct mem_cgroup *memcg, struct cgroup_subsys *ss);
76void mem_cgroup_sockets_destroy(struct mem_cgroup *memcg);
Glauber Costac607b2e2011-12-16 00:52:00 +000077#else
78static inline
Glauber Costa1d62e432012-04-09 19:36:33 -030079int mem_cgroup_sockets_init(struct mem_cgroup *memcg, struct cgroup_subsys *ss)
Glauber Costac607b2e2011-12-16 00:52:00 +000080{
81 return 0;
82}
83static inline
Glauber Costa1d62e432012-04-09 19:36:33 -030084void mem_cgroup_sockets_destroy(struct mem_cgroup *memcg)
Glauber Costac607b2e2011-12-16 00:52:00 +000085{
86}
87#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -070088/*
89 * This structure really needs to be cleaned up.
90 * Most of it is for TCP, and not used by any of
91 * the other protocols.
92 */
93
94/* Define this to get the SOCK_DBG debugging facility. */
95#define SOCK_DEBUGGING
96#ifdef SOCK_DEBUGGING
97#define SOCK_DEBUG(sk, msg...) do { if ((sk) && sock_flag((sk), SOCK_DBG)) \
98 printk(KERN_DEBUG msg); } while (0)
99#else
Stephen Hemminger4cd90292008-03-21 15:54:53 -0700100/* Validate arguments and do nothing */
Joe Perchesb9075fa2011-10-31 17:11:33 -0700101static inline __printf(2, 3)
Eric Dumazetdc6b9b72012-05-16 22:48:15 +0000102void SOCK_DEBUG(const struct sock *sk, const char *msg, ...)
Stephen Hemminger4cd90292008-03-21 15:54:53 -0700103{
104}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700105#endif
106
107/* This is the per-socket lock. The spinlock provides a synchronization
108 * between user contexts and software interrupt processing, whereas the
109 * mini-semaphore synchronizes multiple users amongst themselves.
110 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700111typedef struct {
112 spinlock_t slock;
John Heffnerd2e91172007-09-12 10:44:19 +0200113 int owned;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700114 wait_queue_head_t wq;
Ingo Molnara5b5bb92006-07-03 00:25:35 -0700115 /*
116 * We express the mutex-alike socket_lock semantics
117 * to the lock validator by explicitly managing
118 * the slock as a lock variant (in addition to
119 * the slock itself):
120 */
121#ifdef CONFIG_DEBUG_LOCK_ALLOC
122 struct lockdep_map dep_map;
123#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -0700124} socket_lock_t;
125
Linus Torvalds1da177e2005-04-16 15:20:36 -0700126struct sock;
Arnaldo Carvalho de Melo8feaf0c02005-08-09 20:09:30 -0700127struct proto;
Denis V. Lunev0eeb8ff2007-12-04 01:15:45 -0800128struct net;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700129
Eric Dumazet077b3932012-12-02 07:33:10 +0000130typedef __u32 __bitwise __portpair;
131typedef __u64 __bitwise __addrpair;
132
Linus Torvalds1da177e2005-04-16 15:20:36 -0700133/**
Pavel Pisa4dc3b162005-05-01 08:59:25 -0700134 * struct sock_common - minimal network layer representation of sockets
Eric Dumazet68835ab2010-11-30 19:04:07 +0000135 * @skc_daddr: Foreign IPv4 addr
136 * @skc_rcv_saddr: Bound local IPv4 addr
Eric Dumazet4dc6dc72009-07-15 23:13:10 +0000137 * @skc_hash: hash value used with various protocol lookup tables
Eric Dumazetd4cada42009-11-08 10:17:30 +0000138 * @skc_u16hashes: two u16 hash values used by UDP lookup tables
Eric Dumazetce43b032012-11-30 09:49:27 +0000139 * @skc_dport: placeholder for inet_dport/tw_dport
140 * @skc_num: placeholder for inet_num/tw_num
Pavel Pisa4dc3b162005-05-01 08:59:25 -0700141 * @skc_family: network address family
142 * @skc_state: Connection state
143 * @skc_reuse: %SO_REUSEADDR setting
Tom Herbert055dc212013-01-22 09:49:50 +0000144 * @skc_reuseport: %SO_REUSEPORT setting
Pavel Pisa4dc3b162005-05-01 08:59:25 -0700145 * @skc_bound_dev_if: bound device index if != 0
Pavel Pisa4dc3b162005-05-01 08:59:25 -0700146 * @skc_bind_node: bind hash linkage for various protocol lookup tables
Eric Dumazet512615b2009-11-08 10:17:58 +0000147 * @skc_portaddr_node: second hash linkage for UDP/UDP-Lite protocol
Arnaldo Carvalho de Melo8feaf0c02005-08-09 20:09:30 -0700148 * @skc_prot: protocol handlers inside a network family
Eric W. Biederman07feaeb2007-09-12 11:58:02 +0200149 * @skc_net: reference to the network namespace of this socket
Eric Dumazet68835ab2010-11-30 19:04:07 +0000150 * @skc_node: main hash linkage for various protocol lookup tables
151 * @skc_nulls_node: main hash linkage for TCP/UDP/UDP-Lite protocol
152 * @skc_tx_queue_mapping: tx queue number for this connection
Eric Dumazet8e5eb542015-10-08 19:33:22 -0700153 * @skc_flags: place holder for sk_flags
154 * %SO_LINGER (l_onoff), %SO_BROADCAST, %SO_KEEPALIVE,
155 * %SO_OOBINLINE settings, %SO_TIMESTAMPING settings
Eric Dumazet70da2682015-10-08 19:33:21 -0700156 * @skc_incoming_cpu: record/match cpu processing incoming packets
Eric Dumazet68835ab2010-11-30 19:04:07 +0000157 * @skc_refcnt: reference count
Pavel Pisa4dc3b162005-05-01 08:59:25 -0700158 *
159 * This is the minimal network layer representation of sockets, the header
Arnaldo Carvalho de Melo8feaf0c02005-08-09 20:09:30 -0700160 * for struct sock and struct inet_timewait_sock.
161 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700162struct sock_common {
Eric Dumazetce43b032012-11-30 09:49:27 +0000163 /* skc_daddr and skc_rcv_saddr must be grouped on a 8 bytes aligned
Eric Dumazet05dbc7b2013-10-03 00:22:02 -0700164 * address on 64bit arches : cf INET_MATCH()
Eric Dumazet4dc6dc72009-07-15 23:13:10 +0000165 */
Eric Dumazetce43b032012-11-30 09:49:27 +0000166 union {
Eric Dumazet077b3932012-12-02 07:33:10 +0000167 __addrpair skc_addrpair;
Eric Dumazetce43b032012-11-30 09:49:27 +0000168 struct {
169 __be32 skc_daddr;
170 __be32 skc_rcv_saddr;
171 };
172 };
Eric Dumazetd4cada42009-11-08 10:17:30 +0000173 union {
174 unsigned int skc_hash;
175 __u16 skc_u16hashes[2];
176 };
Eric Dumazetce43b032012-11-30 09:49:27 +0000177 /* skc_dport && skc_num must be grouped as well */
178 union {
Eric Dumazet077b3932012-12-02 07:33:10 +0000179 __portpair skc_portpair;
Eric Dumazetce43b032012-11-30 09:49:27 +0000180 struct {
181 __be16 skc_dport;
182 __u16 skc_num;
183 };
184 };
185
Eric Dumazet4dc6dc72009-07-15 23:13:10 +0000186 unsigned short skc_family;
187 volatile unsigned char skc_state;
Tom Herbert055dc212013-01-22 09:49:50 +0000188 unsigned char skc_reuse:4;
Eric Dumazet9fe516b2014-06-27 08:36:16 -0700189 unsigned char skc_reuseport:1;
190 unsigned char skc_ipv6only:1;
Eric W. Biederman26abe142015-05-08 21:10:31 -0500191 unsigned char skc_net_refcnt:1;
Eric Dumazet4dc6dc72009-07-15 23:13:10 +0000192 int skc_bound_dev_if;
Eric Dumazet512615b2009-11-08 10:17:58 +0000193 union {
194 struct hlist_node skc_bind_node;
195 struct hlist_nulls_node skc_portaddr_node;
196 };
Arnaldo Carvalho de Melo8feaf0c02005-08-09 20:09:30 -0700197 struct proto *skc_prot;
Eric W. Biederman0c5c9fb2015-03-11 23:06:44 -0500198 possible_net_t skc_net;
Eric Dumazetefe42082013-10-03 15:42:29 -0700199
200#if IS_ENABLED(CONFIG_IPV6)
201 struct in6_addr skc_v6_daddr;
202 struct in6_addr skc_v6_rcv_saddr;
203#endif
204
Eric Dumazet33cf7c92015-03-11 18:53:14 -0700205 atomic64_t skc_cookie;
206
Eric Dumazet8e5eb542015-10-08 19:33:22 -0700207 /* following fields are padding to force
208 * offset(struct sock, sk_refcnt) == 128 on 64bit arches
209 * assuming IPV6 is enabled. We use this padding differently
210 * for different kind of 'sockets'
211 */
212 union {
213 unsigned long skc_flags;
214 struct sock *skc_listener; /* request_sock */
215 struct inet_timewait_death_row *skc_tw_dr; /* inet_timewait_sock */
216 };
Eric Dumazet68835ab2010-11-30 19:04:07 +0000217 /*
218 * fields between dontcopy_begin/dontcopy_end
219 * are not copied in sock_copy()
220 */
Randy Dunlap928c41e2011-01-08 17:39:21 +0000221 /* private: */
Eric Dumazet68835ab2010-11-30 19:04:07 +0000222 int skc_dontcopy_begin[0];
Randy Dunlap928c41e2011-01-08 17:39:21 +0000223 /* public: */
Eric Dumazet68835ab2010-11-30 19:04:07 +0000224 union {
225 struct hlist_node skc_node;
226 struct hlist_nulls_node skc_nulls_node;
227 };
228 int skc_tx_queue_mapping;
Eric Dumazeted53d0a2015-10-08 19:33:23 -0700229 union {
230 int skc_incoming_cpu;
231 u32 skc_rcv_wnd;
232 };
Eric Dumazet70da2682015-10-08 19:33:21 -0700233
Eric Dumazet68835ab2010-11-30 19:04:07 +0000234 atomic_t skc_refcnt;
Randy Dunlap928c41e2011-01-08 17:39:21 +0000235 /* private: */
Eric Dumazet68835ab2010-11-30 19:04:07 +0000236 int skc_dontcopy_end[0];
Eric Dumazeted53d0a2015-10-08 19:33:23 -0700237 union {
238 u32 skc_rxhash;
239 u32 skc_window_clamp;
240 };
Randy Dunlap928c41e2011-01-08 17:39:21 +0000241 /* public: */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700242};
243
Glauber Costae1aab162011-12-11 21:47:03 +0000244struct cg_proto;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700245/**
246 * struct sock - network layer representation of sockets
Arnaldo Carvalho de Melo8feaf0c02005-08-09 20:09:30 -0700247 * @__sk_common: shared layout with inet_timewait_sock
Pavel Pisa4dc3b162005-05-01 08:59:25 -0700248 * @sk_shutdown: mask of %SEND_SHUTDOWN and/or %RCV_SHUTDOWN
249 * @sk_userlocks: %SO_SNDBUF and %SO_RCVBUF settings
250 * @sk_lock: synchronizer
251 * @sk_rcvbuf: size of receive buffer in bytes
Eric Dumazet43815482010-04-29 11:01:49 +0000252 * @sk_wq: sock wait queue and async head
Shawn Bohrer421b3882013-10-07 11:01:39 -0500253 * @sk_rx_dst: receive input route used by early demux
Pavel Pisa4dc3b162005-05-01 08:59:25 -0700254 * @sk_dst_cache: destination cache
255 * @sk_dst_lock: destination cache lock
256 * @sk_policy: flow policy
Pavel Pisa4dc3b162005-05-01 08:59:25 -0700257 * @sk_receive_queue: incoming packets
258 * @sk_wmem_alloc: transmit queue bytes committed
259 * @sk_write_queue: Packet sending queue
260 * @sk_omem_alloc: "o" is "option" or "other"
261 * @sk_wmem_queued: persistent queue size
262 * @sk_forward_alloc: space allocated forward
Eliezer Tamir06021292013-06-10 11:39:50 +0300263 * @sk_napi_id: id of the last napi context to receive data for sk
Eliezer Tamirdafcc432013-06-14 16:33:57 +0300264 * @sk_ll_usec: usecs to busypoll when there is no data
Pavel Pisa4dc3b162005-05-01 08:59:25 -0700265 * @sk_allocation: allocation mode
Eric Dumazet95bd09e2013-08-27 05:46:32 -0700266 * @sk_pacing_rate: Pacing rate (if supported by transport/packet scheduler)
Eric Dumazetc3f40d72013-09-29 01:12:40 -0700267 * @sk_max_pacing_rate: Maximum pacing rate (%SO_MAX_PACING_RATE)
Pavel Pisa4dc3b162005-05-01 08:59:25 -0700268 * @sk_sndbuf: size of send buffer in bytes
Tom Herbert28448b82014-05-23 08:47:19 -0700269 * @sk_no_check_tx: %SO_NO_CHECK setting, set checksum in TX packets
270 * @sk_no_check_rx: allow zero checksum in RX packets
Pavel Pisa4dc3b162005-05-01 08:59:25 -0700271 * @sk_route_caps: route capabilities (e.g. %NETIF_F_TSO)
Eric Dumazeta4654192010-05-16 00:36:33 -0700272 * @sk_route_nocaps: forbidden route capabilities (e.g NETIF_F_GSO_MASK)
Herbert Xubcd76112006-06-30 13:36:35 -0700273 * @sk_gso_type: GSO type (e.g. %SKB_GSO_TCPV4)
Peter P Waskiewicz Jr82cc1a72008-03-21 03:43:19 -0700274 * @sk_gso_max_size: Maximum GSO segment size to build
Ben Hutchings14853482012-07-30 16:11:42 +0000275 * @sk_gso_max_segs: Maximum number of GSO segments
Pavel Pisa4dc3b162005-05-01 08:59:25 -0700276 * @sk_lingertime: %SO_LINGER l_linger setting
Pavel Pisa4dc3b162005-05-01 08:59:25 -0700277 * @sk_backlog: always used with the per-socket spinlock held
278 * @sk_callback_lock: used with the callbacks in the end of this struct
279 * @sk_error_queue: rarely used
Wang Chen33c732c2007-11-13 20:30:01 -0800280 * @sk_prot_creator: sk_prot of original sock creator (see ipv6_setsockopt,
281 * IPV6_ADDRFORM for instance)
Pavel Pisa4dc3b162005-05-01 08:59:25 -0700282 * @sk_err: last error
Wang Chen33c732c2007-11-13 20:30:01 -0800283 * @sk_err_soft: errors that don't cause failure but are the cause of a
284 * persistent failure not just 'timed out'
Eric Dumazetcb61cb92008-06-17 21:04:56 -0700285 * @sk_drops: raw/udp drops counter
Pavel Pisa4dc3b162005-05-01 08:59:25 -0700286 * @sk_ack_backlog: current listen backlog
287 * @sk_max_ack_backlog: listen backlog set in listen()
288 * @sk_priority: %SO_PRIORITY setting
Randy Dunlap1a3bc362012-01-21 09:03:10 +0000289 * @sk_cgrp_prioidx: socket group's priority map index
Pavel Pisa4dc3b162005-05-01 08:59:25 -0700290 * @sk_type: socket type (%SOCK_STREAM, etc)
291 * @sk_protocol: which protocol this socket belongs in this network family
Randy Dunlap53c3fa22010-08-09 13:41:07 +0000292 * @sk_peer_pid: &struct pid for this socket's peer
293 * @sk_peer_cred: %SO_PEERCRED setting
Pavel Pisa4dc3b162005-05-01 08:59:25 -0700294 * @sk_rcvlowat: %SO_RCVLOWAT setting
295 * @sk_rcvtimeo: %SO_RCVTIMEO setting
296 * @sk_sndtimeo: %SO_SNDTIMEO setting
Tom Herbertb73c3d02014-07-01 21:32:17 -0700297 * @sk_txhash: computed flow hash for use on transmit
Pavel Pisa4dc3b162005-05-01 08:59:25 -0700298 * @sk_filter: socket filtering instructions
Pavel Pisa4dc3b162005-05-01 08:59:25 -0700299 * @sk_timer: sock cleanup timer
300 * @sk_stamp: time stamp of last packet received
Willem de Bruijnb9f40e22014-08-04 22:11:46 -0400301 * @sk_tsflags: SO_TIMESTAMPING socket options
Willem de Bruijn09c2d252014-08-04 22:11:47 -0400302 * @sk_tskey: counter to disambiguate concurrent tstamp requests
Pavel Pisa4dc3b162005-05-01 08:59:25 -0700303 * @sk_socket: Identd and reporting IO signals
304 * @sk_user_data: RPC layer private data
Eric Dumazet5640f762012-09-23 23:04:42 +0000305 * @sk_frag: cached page frag
Randy Dunlapd3d4f0a2012-04-17 14:03:53 +0000306 * @sk_peek_off: current peek_offset value
Pavel Pisa4dc3b162005-05-01 08:59:25 -0700307 * @sk_send_head: front of stuff to transmit
Martin Waitz67be2dd2005-05-01 08:59:26 -0700308 * @sk_security: used by security modules
Randy Dunlap31729362008-02-18 20:52:13 -0800309 * @sk_mark: generic packet mark
Randy Dunlap53c3fa22010-08-09 13:41:07 +0000310 * @sk_classid: this socket's cgroup classid
Glauber Costae1aab162011-12-11 21:47:03 +0000311 * @sk_cgrp: this socket's cgroup-specific proto data
Pavel Pisa4dc3b162005-05-01 08:59:25 -0700312 * @sk_write_pending: a write to stream socket waits to start
313 * @sk_state_change: callback to indicate change in the state of the sock
314 * @sk_data_ready: callback to indicate there is data to be processed
315 * @sk_write_space: callback to indicate there is bf sending space available
316 * @sk_error_report: callback to indicate errors (e.g. %MSG_ERRQUEUE)
317 * @sk_backlog_rcv: callback to process the backlog
318 * @sk_destruct: called at sock freeing time, i.e. when all refcnt == 0
Linus Torvalds1da177e2005-04-16 15:20:36 -0700319 */
320struct sock {
321 /*
Arnaldo Carvalho de Melo8feaf0c02005-08-09 20:09:30 -0700322 * Now struct inet_timewait_sock also uses sock_common, so please just
Linus Torvalds1da177e2005-04-16 15:20:36 -0700323 * don't add nothing before this first member (__sk_common) --acme
324 */
325 struct sock_common __sk_common;
Eric Dumazet4dc6dc72009-07-15 23:13:10 +0000326#define sk_node __sk_common.skc_node
327#define sk_nulls_node __sk_common.skc_nulls_node
328#define sk_refcnt __sk_common.skc_refcnt
Krishna Kumare022f0b2009-10-19 23:46:20 +0000329#define sk_tx_queue_mapping __sk_common.skc_tx_queue_mapping
Eric Dumazet4dc6dc72009-07-15 23:13:10 +0000330
Eric Dumazet68835ab2010-11-30 19:04:07 +0000331#define sk_dontcopy_begin __sk_common.skc_dontcopy_begin
332#define sk_dontcopy_end __sk_common.skc_dontcopy_end
Eric Dumazet4dc6dc72009-07-15 23:13:10 +0000333#define sk_hash __sk_common.skc_hash
Eric Dumazet50805462013-10-02 04:29:50 -0700334#define sk_portpair __sk_common.skc_portpair
Eric Dumazet05dbc7b2013-10-03 00:22:02 -0700335#define sk_num __sk_common.skc_num
336#define sk_dport __sk_common.skc_dport
Eric Dumazet50805462013-10-02 04:29:50 -0700337#define sk_addrpair __sk_common.skc_addrpair
338#define sk_daddr __sk_common.skc_daddr
339#define sk_rcv_saddr __sk_common.skc_rcv_saddr
Linus Torvalds1da177e2005-04-16 15:20:36 -0700340#define sk_family __sk_common.skc_family
341#define sk_state __sk_common.skc_state
342#define sk_reuse __sk_common.skc_reuse
Tom Herbert055dc212013-01-22 09:49:50 +0000343#define sk_reuseport __sk_common.skc_reuseport
Eric Dumazet9fe516b2014-06-27 08:36:16 -0700344#define sk_ipv6only __sk_common.skc_ipv6only
Eric W. Biederman26abe142015-05-08 21:10:31 -0500345#define sk_net_refcnt __sk_common.skc_net_refcnt
Linus Torvalds1da177e2005-04-16 15:20:36 -0700346#define sk_bound_dev_if __sk_common.skc_bound_dev_if
Linus Torvalds1da177e2005-04-16 15:20:36 -0700347#define sk_bind_node __sk_common.skc_bind_node
Arnaldo Carvalho de Melo8feaf0c02005-08-09 20:09:30 -0700348#define sk_prot __sk_common.skc_prot
Eric W. Biederman07feaeb2007-09-12 11:58:02 +0200349#define sk_net __sk_common.skc_net
Eric Dumazetefe42082013-10-03 15:42:29 -0700350#define sk_v6_daddr __sk_common.skc_v6_daddr
351#define sk_v6_rcv_saddr __sk_common.skc_v6_rcv_saddr
Eric Dumazet33cf7c92015-03-11 18:53:14 -0700352#define sk_cookie __sk_common.skc_cookie
Eric Dumazet70da2682015-10-08 19:33:21 -0700353#define sk_incoming_cpu __sk_common.skc_incoming_cpu
Eric Dumazet8e5eb542015-10-08 19:33:22 -0700354#define sk_flags __sk_common.skc_flags
Eric Dumazeted53d0a2015-10-08 19:33:23 -0700355#define sk_rxhash __sk_common.skc_rxhash
Eric Dumazetefe42082013-10-03 15:42:29 -0700356
Eric Dumazetb178bb32010-11-16 05:56:04 +0000357 socket_lock_t sk_lock;
358 struct sk_buff_head sk_receive_queue;
359 /*
360 * The backlog queue is special, it is always used with
361 * the per-socket spinlock held and requires low latency
362 * access. Therefore we special case it's implementation.
363 * Note : rmem_alloc is in this structure to fill a hole
364 * on 64bit arches, not because its logically part of
365 * backlog.
366 */
367 struct {
368 atomic_t rmem_alloc;
369 int len;
370 struct sk_buff *head;
371 struct sk_buff *tail;
372 } sk_backlog;
373#define sk_rmem_alloc sk_backlog.rmem_alloc
374 int sk_forward_alloc;
Eric Dumazet2c8c56e2014-11-11 05:54:28 -0800375
Tom Herbertb73c3d02014-07-01 21:32:17 -0700376 __u32 sk_txhash;
Cong Wange0d10952013-08-01 11:10:25 +0800377#ifdef CONFIG_NET_RX_BUSY_POLL
Eliezer Tamir06021292013-06-10 11:39:50 +0300378 unsigned int sk_napi_id;
Eliezer Tamirdafcc432013-06-14 16:33:57 +0300379 unsigned int sk_ll_usec;
Eliezer Tamir06021292013-06-10 11:39:50 +0300380#endif
Eric Dumazetb178bb32010-11-16 05:56:04 +0000381 atomic_t sk_drops;
382 int sk_rcvbuf;
383
384 struct sk_filter __rcu *sk_filter;
Eric Dumazeteaefd112011-02-18 03:26:36 +0000385 struct socket_wq __rcu *sk_wq;
Eric Dumazetb178bb32010-11-16 05:56:04 +0000386
Eric Dumazetb178bb32010-11-16 05:56:04 +0000387#ifdef CONFIG_XFRM
388 struct xfrm_policy *sk_policy[2];
389#endif
Eric Dumazetdeaa5852012-06-24 20:22:49 +0000390 struct dst_entry *sk_rx_dst;
Cong Wang0e36cbb2013-01-22 21:09:51 +0000391 struct dst_entry __rcu *sk_dst_cache;
Eric Dumazetb178bb32010-11-16 05:56:04 +0000392 spinlock_t sk_dst_lock;
393 atomic_t sk_wmem_alloc;
394 atomic_t sk_omem_alloc;
395 int sk_sndbuf;
396 struct sk_buff_head sk_write_queue;
Vegard Nossuma98b65a2009-02-26 14:46:57 +0100397 kmemcheck_bitfield_begin(flags);
Eric Dumazet5fdb9972009-10-08 22:50:25 +0000398 unsigned int sk_shutdown : 2,
Tom Herbert28448b82014-05-23 08:47:19 -0700399 sk_no_check_tx : 1,
400 sk_no_check_rx : 1,
Eric Dumazet5fdb9972009-10-08 22:50:25 +0000401 sk_userlocks : 4,
402 sk_protocol : 8,
403 sk_type : 16;
Vegard Nossuma98b65a2009-02-26 14:46:57 +0100404 kmemcheck_bitfield_end(flags);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700405 int sk_wmem_queued;
Al Viro7d877f32005-10-21 03:20:43 -0400406 gfp_t sk_allocation;
Eric Dumazet95bd09e2013-08-27 05:46:32 -0700407 u32 sk_pacing_rate; /* bytes per second */
Eric Dumazet62748f32013-09-24 08:20:52 -0700408 u32 sk_max_pacing_rate;
Michał Mirosławc8f44af2011-11-15 15:29:55 +0000409 netdev_features_t sk_route_caps;
410 netdev_features_t sk_route_nocaps;
Herbert Xubcd76112006-06-30 13:36:35 -0700411 int sk_gso_type;
Peter P Waskiewicz Jr82cc1a72008-03-21 03:43:19 -0700412 unsigned int sk_gso_max_size;
Ben Hutchings14853482012-07-30 16:11:42 +0000413 u16 sk_gso_max_segs;
David S. Miller9932cf92006-03-24 15:12:37 -0800414 int sk_rcvlowat;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700415 unsigned long sk_lingertime;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700416 struct sk_buff_head sk_error_queue;
Arnaldo Carvalho de Melo476e19c2005-05-05 13:35:15 -0700417 struct proto *sk_prot_creator;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700418 rwlock_t sk_callback_lock;
419 int sk_err,
420 sk_err_soft;
Eric Dumazetbecb74f2015-03-19 19:04:21 -0700421 u32 sk_ack_backlog;
422 u32 sk_max_ack_backlog;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700423 __u32 sk_priority;
Daniel Borkmann86f85152013-12-29 17:27:11 +0100424#if IS_ENABLED(CONFIG_CGROUP_NET_PRIO)
Neil Horman5bc14212011-11-22 05:10:51 +0000425 __u32 sk_cgrp_prioidx;
426#endif
Eric W. Biederman109f6e32010-06-13 03:30:14 +0000427 struct pid *sk_peer_pid;
428 const struct cred *sk_peer_cred;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700429 long sk_rcvtimeo;
430 long sk_sndtimeo;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700431 struct timer_list sk_timer;
Eric Dumazetb7aa0bf2007-04-19 16:16:32 -0700432 ktime_t sk_stamp;
Willem de Bruijnb9f40e22014-08-04 22:11:46 -0400433 u16 sk_tsflags;
Willem de Bruijn09c2d252014-08-04 22:11:47 -0400434 u32 sk_tskey;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700435 struct socket *sk_socket;
436 void *sk_user_data;
Eric Dumazet5640f762012-09-23 23:04:42 +0000437 struct page_frag sk_frag;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700438 struct sk_buff *sk_send_head;
Pavel Emelyanovef64a542012-02-21 07:31:34 +0000439 __s32 sk_peek_off;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700440 int sk_write_pending;
Alexey Dobriyand5f64232008-11-04 14:45:58 -0800441#ifdef CONFIG_SECURITY
Linus Torvalds1da177e2005-04-16 15:20:36 -0700442 void *sk_security;
Alexey Dobriyand5f64232008-11-04 14:45:58 -0800443#endif
Laszlo Attila Toth4a19ec52008-01-30 19:08:16 -0800444 __u32 sk_mark;
Mathias Krausee181a542015-07-19 22:21:13 +0200445#ifdef CONFIG_CGROUP_NET_CLASSID
Herbert Xuf8451722010-05-24 00:12:34 -0700446 u32 sk_classid;
Mathias Krausee181a542015-07-19 22:21:13 +0200447#endif
Glauber Costae1aab162011-12-11 21:47:03 +0000448 struct cg_proto *sk_cgrp;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700449 void (*sk_state_change)(struct sock *sk);
David S. Miller676d2362014-04-11 16:15:36 -0400450 void (*sk_data_ready)(struct sock *sk);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700451 void (*sk_write_space)(struct sock *sk);
452 void (*sk_error_report)(struct sock *sk);
Eric Dumazetdc6b9b72012-05-16 22:48:15 +0000453 int (*sk_backlog_rcv)(struct sock *sk,
454 struct sk_buff *skb);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700455 void (*sk_destruct)(struct sock *sk);
456};
457
Pravin B Shelar559835ea2013-09-24 10:25:40 -0700458#define __sk_user_data(sk) ((*((void __rcu **)&(sk)->sk_user_data)))
459
460#define rcu_dereference_sk_user_data(sk) rcu_dereference(__sk_user_data((sk)))
461#define rcu_assign_sk_user_data(sk, ptr) rcu_assign_pointer(__sk_user_data((sk)), ptr)
462
Pavel Emelyanov4a17fd52012-04-19 03:39:36 +0000463/*
464 * SK_CAN_REUSE and SK_NO_REUSE on a socket mean that the socket is OK
465 * or not whether his port will be reused by someone else. SK_FORCE_REUSE
466 * on a socket means that the socket will reuse everybody else's port
467 * without looking at the other's sk_reuse value.
468 */
469
470#define SK_NO_REUSE 0
471#define SK_CAN_REUSE 1
472#define SK_FORCE_REUSE 2
473
Pavel Emelyanovef64a542012-02-21 07:31:34 +0000474static inline int sk_peek_offset(struct sock *sk, int flags)
475{
476 if ((flags & MSG_PEEK) && (sk->sk_peek_off >= 0))
477 return sk->sk_peek_off;
478 else
479 return 0;
480}
481
482static inline void sk_peek_offset_bwd(struct sock *sk, int val)
483{
484 if (sk->sk_peek_off >= 0) {
485 if (sk->sk_peek_off >= val)
486 sk->sk_peek_off -= val;
487 else
488 sk->sk_peek_off = 0;
489 }
490}
491
492static inline void sk_peek_offset_fwd(struct sock *sk, int val)
493{
494 if (sk->sk_peek_off >= 0)
495 sk->sk_peek_off += val;
496}
497
Linus Torvalds1da177e2005-04-16 15:20:36 -0700498/*
499 * Hashed lists helper routines
500 */
Li Zefanc4146642010-02-08 23:18:45 +0000501static inline struct sock *sk_entry(const struct hlist_node *node)
502{
503 return hlist_entry(node, struct sock, sk_node);
504}
505
Arnaldo Carvalho de Meloe48c4142005-08-09 20:09:46 -0700506static inline struct sock *__sk_head(const struct hlist_head *head)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700507{
508 return hlist_entry(head->first, struct sock, sk_node);
509}
510
Arnaldo Carvalho de Meloe48c4142005-08-09 20:09:46 -0700511static inline struct sock *sk_head(const struct hlist_head *head)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700512{
513 return hlist_empty(head) ? NULL : __sk_head(head);
514}
515
Eric Dumazet88ab1932008-11-16 19:39:21 -0800516static inline struct sock *__sk_nulls_head(const struct hlist_nulls_head *head)
517{
518 return hlist_nulls_entry(head->first, struct sock, sk_nulls_node);
519}
520
521static inline struct sock *sk_nulls_head(const struct hlist_nulls_head *head)
522{
523 return hlist_nulls_empty(head) ? NULL : __sk_nulls_head(head);
524}
525
Arnaldo Carvalho de Meloe48c4142005-08-09 20:09:46 -0700526static inline struct sock *sk_next(const struct sock *sk)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700527{
528 return sk->sk_node.next ?
529 hlist_entry(sk->sk_node.next, struct sock, sk_node) : NULL;
530}
531
Eric Dumazet88ab1932008-11-16 19:39:21 -0800532static inline struct sock *sk_nulls_next(const struct sock *sk)
533{
534 return (!is_a_nulls(sk->sk_nulls_node.next)) ?
535 hlist_nulls_entry(sk->sk_nulls_node.next,
536 struct sock, sk_nulls_node) :
537 NULL;
538}
539
Eric Dumazetdc6b9b72012-05-16 22:48:15 +0000540static inline bool sk_unhashed(const struct sock *sk)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700541{
542 return hlist_unhashed(&sk->sk_node);
543}
544
Eric Dumazetdc6b9b72012-05-16 22:48:15 +0000545static inline bool sk_hashed(const struct sock *sk)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700546{
Akinobu Mitada753be2006-04-28 15:21:23 -0700547 return !sk_unhashed(sk);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700548}
549
Eric Dumazetdc6b9b72012-05-16 22:48:15 +0000550static inline void sk_node_init(struct hlist_node *node)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700551{
552 node->pprev = NULL;
553}
554
Eric Dumazetdc6b9b72012-05-16 22:48:15 +0000555static inline void sk_nulls_node_init(struct hlist_nulls_node *node)
Eric Dumazet88ab1932008-11-16 19:39:21 -0800556{
557 node->pprev = NULL;
558}
559
Eric Dumazetdc6b9b72012-05-16 22:48:15 +0000560static inline void __sk_del_node(struct sock *sk)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700561{
562 __hlist_del(&sk->sk_node);
563}
564
stephen hemminger808f5112010-02-22 07:57:18 +0000565/* NB: equivalent to hlist_del_init_rcu */
Eric Dumazetdc6b9b72012-05-16 22:48:15 +0000566static inline bool __sk_del_node_init(struct sock *sk)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700567{
568 if (sk_hashed(sk)) {
569 __sk_del_node(sk);
570 sk_node_init(&sk->sk_node);
Eric Dumazetdc6b9b72012-05-16 22:48:15 +0000571 return true;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700572 }
Eric Dumazetdc6b9b72012-05-16 22:48:15 +0000573 return false;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700574}
575
576/* Grab socket reference count. This operation is valid only
577 when sk is ALREADY grabbed f.e. it is found in hash table
578 or a list and the lookup is made under lock preventing hash table
579 modifications.
580 */
581
582static inline void sock_hold(struct sock *sk)
583{
584 atomic_inc(&sk->sk_refcnt);
585}
586
587/* Ungrab socket in the context, which assumes that socket refcnt
588 cannot hit zero, f.e. it is true in context of any socketcall.
589 */
590static inline void __sock_put(struct sock *sk)
591{
592 atomic_dec(&sk->sk_refcnt);
593}
594
Eric Dumazetdc6b9b72012-05-16 22:48:15 +0000595static inline bool sk_del_node_init(struct sock *sk)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700596{
Eric Dumazetdc6b9b72012-05-16 22:48:15 +0000597 bool rc = __sk_del_node_init(sk);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700598
599 if (rc) {
600 /* paranoid for a while -acme */
601 WARN_ON(atomic_read(&sk->sk_refcnt) == 1);
602 __sock_put(sk);
603 }
604 return rc;
605}
stephen hemminger808f5112010-02-22 07:57:18 +0000606#define sk_del_node_init_rcu(sk) sk_del_node_init(sk)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700607
Eric Dumazetdc6b9b72012-05-16 22:48:15 +0000608static inline bool __sk_nulls_del_node_init_rcu(struct sock *sk)
Eric Dumazet271b72c2008-10-29 02:11:14 -0700609{
610 if (sk_hashed(sk)) {
Eric Dumazet88ab1932008-11-16 19:39:21 -0800611 hlist_nulls_del_init_rcu(&sk->sk_nulls_node);
Eric Dumazetdc6b9b72012-05-16 22:48:15 +0000612 return true;
Eric Dumazet271b72c2008-10-29 02:11:14 -0700613 }
Eric Dumazetdc6b9b72012-05-16 22:48:15 +0000614 return false;
Eric Dumazet271b72c2008-10-29 02:11:14 -0700615}
616
Eric Dumazetdc6b9b72012-05-16 22:48:15 +0000617static inline bool sk_nulls_del_node_init_rcu(struct sock *sk)
Eric Dumazet271b72c2008-10-29 02:11:14 -0700618{
Eric Dumazetdc6b9b72012-05-16 22:48:15 +0000619 bool rc = __sk_nulls_del_node_init_rcu(sk);
Eric Dumazet271b72c2008-10-29 02:11:14 -0700620
621 if (rc) {
622 /* paranoid for a while -acme */
623 WARN_ON(atomic_read(&sk->sk_refcnt) == 1);
624 __sock_put(sk);
625 }
626 return rc;
627}
628
Eric Dumazetdc6b9b72012-05-16 22:48:15 +0000629static inline void __sk_add_node(struct sock *sk, struct hlist_head *list)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700630{
631 hlist_add_head(&sk->sk_node, list);
632}
633
Eric Dumazetdc6b9b72012-05-16 22:48:15 +0000634static inline void sk_add_node(struct sock *sk, struct hlist_head *list)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700635{
636 sock_hold(sk);
637 __sk_add_node(sk, list);
638}
639
Eric Dumazetdc6b9b72012-05-16 22:48:15 +0000640static inline void sk_add_node_rcu(struct sock *sk, struct hlist_head *list)
stephen hemminger808f5112010-02-22 07:57:18 +0000641{
642 sock_hold(sk);
643 hlist_add_head_rcu(&sk->sk_node, list);
644}
645
Eric Dumazetdc6b9b72012-05-16 22:48:15 +0000646static inline void __sk_nulls_add_node_rcu(struct sock *sk, struct hlist_nulls_head *list)
Eric Dumazet271b72c2008-10-29 02:11:14 -0700647{
Eric Dumazet88ab1932008-11-16 19:39:21 -0800648 hlist_nulls_add_head_rcu(&sk->sk_nulls_node, list);
Eric Dumazet271b72c2008-10-29 02:11:14 -0700649}
650
Eric Dumazetdc6b9b72012-05-16 22:48:15 +0000651static inline void sk_nulls_add_node_rcu(struct sock *sk, struct hlist_nulls_head *list)
Eric Dumazet271b72c2008-10-29 02:11:14 -0700652{
653 sock_hold(sk);
Eric Dumazet88ab1932008-11-16 19:39:21 -0800654 __sk_nulls_add_node_rcu(sk, list);
Eric Dumazet271b72c2008-10-29 02:11:14 -0700655}
656
Eric Dumazetdc6b9b72012-05-16 22:48:15 +0000657static inline void __sk_del_bind_node(struct sock *sk)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700658{
659 __hlist_del(&sk->sk_bind_node);
660}
661
Eric Dumazetdc6b9b72012-05-16 22:48:15 +0000662static inline void sk_add_bind_node(struct sock *sk,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700663 struct hlist_head *list)
664{
665 hlist_add_head(&sk->sk_bind_node, list);
666}
667
Sasha Levinb67bfe02013-02-27 17:06:00 -0800668#define sk_for_each(__sk, list) \
669 hlist_for_each_entry(__sk, list, sk_node)
670#define sk_for_each_rcu(__sk, list) \
671 hlist_for_each_entry_rcu(__sk, list, sk_node)
Eric Dumazet88ab1932008-11-16 19:39:21 -0800672#define sk_nulls_for_each(__sk, node, list) \
673 hlist_nulls_for_each_entry(__sk, node, list, sk_nulls_node)
674#define sk_nulls_for_each_rcu(__sk, node, list) \
675 hlist_nulls_for_each_entry_rcu(__sk, node, list, sk_nulls_node)
Sasha Levinb67bfe02013-02-27 17:06:00 -0800676#define sk_for_each_from(__sk) \
677 hlist_for_each_entry_from(__sk, sk_node)
Eric Dumazet88ab1932008-11-16 19:39:21 -0800678#define sk_nulls_for_each_from(__sk, node) \
679 if (__sk && ({ node = &(__sk)->sk_nulls_node; 1; })) \
680 hlist_nulls_for_each_entry_from(__sk, node, sk_nulls_node)
Sasha Levinb67bfe02013-02-27 17:06:00 -0800681#define sk_for_each_safe(__sk, tmp, list) \
682 hlist_for_each_entry_safe(__sk, tmp, list, sk_node)
683#define sk_for_each_bound(__sk, list) \
684 hlist_for_each_entry(__sk, list, sk_bind_node)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700685
David Held2dc41cf2014-07-15 23:28:32 -0400686/**
687 * sk_nulls_for_each_entry_offset - iterate over a list at a given struct offset
688 * @tpos: the type * to use as a loop cursor.
689 * @pos: the &struct hlist_node to use as a loop cursor.
690 * @head: the head for your list.
691 * @offset: offset of hlist_node within the struct.
692 *
693 */
694#define sk_nulls_for_each_entry_offset(tpos, pos, head, offset) \
695 for (pos = (head)->first; \
696 (!is_a_nulls(pos)) && \
697 ({ tpos = (typeof(*tpos) *)((void *)pos - offset); 1;}); \
698 pos = pos->next)
699
Eric W. Biedermanc336d142012-05-24 17:56:43 -0600700static inline struct user_namespace *sk_user_ns(struct sock *sk)
701{
702 /* Careful only use this in a context where these parameters
703 * can not change and must all be valid, such as recvmsg from
704 * userspace.
705 */
706 return sk->sk_socket->file->f_cred->user_ns;
707}
708
Linus Torvalds1da177e2005-04-16 15:20:36 -0700709/* Sock flags */
710enum sock_flags {
711 SOCK_DEAD,
712 SOCK_DONE,
713 SOCK_URGINLINE,
714 SOCK_KEEPOPEN,
715 SOCK_LINGER,
716 SOCK_DESTROY,
717 SOCK_BROADCAST,
718 SOCK_TIMESTAMP,
719 SOCK_ZAPPED,
720 SOCK_USE_WRITE_QUEUE, /* whether to call sk->sk_write_space in sock_wfree */
721 SOCK_DBG, /* %SO_DEBUG setting */
722 SOCK_RCVTSTAMP, /* %SO_TIMESTAMP setting */
Eric Dumazet92f37fd2007-03-25 22:14:49 -0700723 SOCK_RCVTSTAMPNS, /* %SO_TIMESTAMPNS setting */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700724 SOCK_LOCALROUTE, /* route locally only, %SO_DONTROUTE setting */
725 SOCK_QUEUE_SHRUNK, /* write queue has been shrunk recently */
Mel Gorman7cb02402012-07-31 16:44:16 -0700726 SOCK_MEMALLOC, /* VM depends on this socket for swapping */
Patrick Ohly20d49472009-02-12 05:03:38 +0000727 SOCK_TIMESTAMPING_RX_SOFTWARE, /* %SOF_TIMESTAMPING_RX_SOFTWARE */
Eric Dumazetbcdce712009-10-06 17:28:29 -0700728 SOCK_FASYNC, /* fasync() active */
Neil Horman3b885782009-10-12 13:26:31 -0700729 SOCK_RXQ_OVFL,
Shirley Ma1cdebb42011-07-06 12:17:30 +0000730 SOCK_ZEROCOPY, /* buffers from userspace */
Johannes Berg6e3e9392011-11-09 10:15:42 +0100731 SOCK_WIFI_STATUS, /* push wifi status to userspace */
Ben Greear3bdc0eb2012-02-11 15:39:30 +0000732 SOCK_NOFCS, /* Tell NIC not to do the Ethernet FCS.
733 * Will use last 4 bytes of packet sent from
734 * user-space instead.
735 */
Vincent Bernatd59577b2013-01-16 22:55:49 +0100736 SOCK_FILTER_LOCKED, /* Filter cannot be changed anymore */
Keller, Jacob E7d4c04f2013-03-28 11:19:25 +0000737 SOCK_SELECT_ERR_QUEUE, /* Wake select on error queue */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700738};
739
Ralf Baechle53b924b2005-08-23 10:11:30 -0700740static inline void sock_copy_flags(struct sock *nsk, struct sock *osk)
741{
742 nsk->sk_flags = osk->sk_flags;
743}
744
Linus Torvalds1da177e2005-04-16 15:20:36 -0700745static inline void sock_set_flag(struct sock *sk, enum sock_flags flag)
746{
747 __set_bit(flag, &sk->sk_flags);
748}
749
750static inline void sock_reset_flag(struct sock *sk, enum sock_flags flag)
751{
752 __clear_bit(flag, &sk->sk_flags);
753}
754
Eric Dumazet1b23a5d2012-05-16 05:57:07 +0000755static inline bool sock_flag(const struct sock *sk, enum sock_flags flag)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700756{
757 return test_bit(flag, &sk->sk_flags);
758}
759
Mel Gormanc93bdd02012-07-31 16:44:19 -0700760#ifdef CONFIG_NET
761extern struct static_key memalloc_socks;
762static inline int sk_memalloc_socks(void)
763{
764 return static_key_false(&memalloc_socks);
765}
766#else
767
768static inline int sk_memalloc_socks(void)
769{
770 return 0;
771}
772
773#endif
774
Eric Dumazet87e002b2015-09-29 07:42:45 -0700775static inline gfp_t sk_gfp_atomic(const struct sock *sk, gfp_t gfp_mask)
Mel Gorman99a1dec2012-07-31 16:44:14 -0700776{
Mel Gorman7cb02402012-07-31 16:44:16 -0700777 return GFP_ATOMIC | (sk->sk_allocation & __GFP_MEMALLOC);
Mel Gorman99a1dec2012-07-31 16:44:14 -0700778}
779
Linus Torvalds1da177e2005-04-16 15:20:36 -0700780static inline void sk_acceptq_removed(struct sock *sk)
781{
782 sk->sk_ack_backlog--;
783}
784
785static inline void sk_acceptq_added(struct sock *sk)
786{
787 sk->sk_ack_backlog++;
788}
789
Eric Dumazetdc6b9b72012-05-16 22:48:15 +0000790static inline bool sk_acceptq_is_full(const struct sock *sk)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700791{
David S. Miller64a14652007-03-06 11:21:05 -0800792 return sk->sk_ack_backlog > sk->sk_max_ack_backlog;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700793}
794
795/*
796 * Compute minimal free write space needed to queue new packets.
797 */
Eric Dumazetdc6b9b72012-05-16 22:48:15 +0000798static inline int sk_stream_min_wspace(const struct sock *sk)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700799{
Eric Dumazet8df09ea2007-12-21 03:07:41 -0800800 return sk->sk_wmem_queued >> 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700801}
802
Eric Dumazetdc6b9b72012-05-16 22:48:15 +0000803static inline int sk_stream_wspace(const struct sock *sk)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700804{
805 return sk->sk_sndbuf - sk->sk_wmem_queued;
806}
807
Joe Perches69336bd2013-09-22 10:32:26 -0700808void sk_stream_write_space(struct sock *sk);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700809
Zhu Yi8eae9392010-03-04 18:01:40 +0000810/* OOB backlog add */
Zhu Yia3a858f2010-03-04 18:01:47 +0000811static inline void __sk_add_backlog(struct sock *sk, struct sk_buff *skb)
Stephen Hemminger9ee6b532005-11-08 09:39:42 -0800812{
Eric Dumazet7fee2262010-05-11 23:19:48 +0000813 /* dont let skb dst not refcounted, we are going to leave rcu lock */
814 skb_dst_force(skb);
815
816 if (!sk->sk_backlog.tail)
817 sk->sk_backlog.head = skb;
818 else
Stephen Hemminger9ee6b532005-11-08 09:39:42 -0800819 sk->sk_backlog.tail->next = skb;
Eric Dumazet7fee2262010-05-11 23:19:48 +0000820
821 sk->sk_backlog.tail = skb;
Stephen Hemminger9ee6b532005-11-08 09:39:42 -0800822 skb->next = NULL;
823}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700824
Eric Dumazetc3774112010-04-27 15:13:20 -0700825/*
826 * Take into account size of receive queue and backlog queue
Eric Dumazet0fd7bac2011-12-21 07:11:44 +0000827 * Do not take into account this skb truesize,
828 * to allow even a single big packet to come.
Eric Dumazetc3774112010-04-27 15:13:20 -0700829 */
Sorin Dumitru274f4822014-07-22 21:16:51 +0300830static inline bool sk_rcvqueues_full(const struct sock *sk, unsigned int limit)
Eric Dumazetc3774112010-04-27 15:13:20 -0700831{
832 unsigned int qsize = sk->sk_backlog.len + atomic_read(&sk->sk_rmem_alloc);
833
Eric Dumazetf545a382012-04-22 23:34:26 +0000834 return qsize > limit;
Eric Dumazetc3774112010-04-27 15:13:20 -0700835}
836
Zhu Yi8eae9392010-03-04 18:01:40 +0000837/* The per-socket spinlock must be held here. */
Eric Dumazetf545a382012-04-22 23:34:26 +0000838static inline __must_check int sk_add_backlog(struct sock *sk, struct sk_buff *skb,
839 unsigned int limit)
Zhu Yi8eae9392010-03-04 18:01:40 +0000840{
Sorin Dumitru274f4822014-07-22 21:16:51 +0300841 if (sk_rcvqueues_full(sk, limit))
Zhu Yi8eae9392010-03-04 18:01:40 +0000842 return -ENOBUFS;
843
Zhu Yia3a858f2010-03-04 18:01:47 +0000844 __sk_add_backlog(sk, skb);
Zhu Yi8eae9392010-03-04 18:01:40 +0000845 sk->sk_backlog.len += skb->truesize;
846 return 0;
847}
848
Joe Perches69336bd2013-09-22 10:32:26 -0700849int __sk_backlog_rcv(struct sock *sk, struct sk_buff *skb);
Mel Gormanb4b9e352012-07-31 16:44:26 -0700850
Peter Zijlstrac57943a2008-10-07 14:18:42 -0700851static inline int sk_backlog_rcv(struct sock *sk, struct sk_buff *skb)
852{
Mel Gormanb4b9e352012-07-31 16:44:26 -0700853 if (sk_memalloc_socks() && skb_pfmemalloc(skb))
854 return __sk_backlog_rcv(sk, skb);
855
Peter Zijlstrac57943a2008-10-07 14:18:42 -0700856 return sk->sk_backlog_rcv(sk, skb);
857}
858
Eric Dumazet2c8c56e2014-11-11 05:54:28 -0800859static inline void sk_incoming_cpu_update(struct sock *sk)
860{
861 sk->sk_incoming_cpu = raw_smp_processor_id();
862}
863
Tom Herbertfe477552013-12-22 18:54:31 +0800864static inline void sock_rps_record_flow_hash(__u32 hash)
David S. Millerc58dc012010-04-27 15:05:31 -0700865{
866#ifdef CONFIG_RPS
867 struct rps_sock_flow_table *sock_flow_table;
868
869 rcu_read_lock();
870 sock_flow_table = rcu_dereference(rps_sock_flow_table);
Tom Herbertfe477552013-12-22 18:54:31 +0800871 rps_record_sock_flow(sock_flow_table, hash);
David S. Millerc58dc012010-04-27 15:05:31 -0700872 rcu_read_unlock();
873#endif
874}
875
Tom Herbertfe477552013-12-22 18:54:31 +0800876static inline void sock_rps_record_flow(const struct sock *sk)
877{
Zhi Yong Wuc9d8ca02014-01-01 04:31:01 +0800878#ifdef CONFIG_RPS
Tom Herbertfe477552013-12-22 18:54:31 +0800879 sock_rps_record_flow_hash(sk->sk_rxhash);
Zhi Yong Wuc9d8ca02014-01-01 04:31:01 +0800880#endif
Tom Herbertfe477552013-12-22 18:54:31 +0800881}
882
Tom Herbertbdeab992011-08-14 19:45:55 +0000883static inline void sock_rps_save_rxhash(struct sock *sk,
884 const struct sk_buff *skb)
David S. Millerc58dc012010-04-27 15:05:31 -0700885{
886#ifdef CONFIG_RPS
Eric Dumazet567e4b72015-02-06 12:59:01 -0800887 if (unlikely(sk->sk_rxhash != skb->hash))
Tom Herbert61b905d2014-03-24 15:34:47 -0700888 sk->sk_rxhash = skb->hash;
David S. Millerc58dc012010-04-27 15:05:31 -0700889#endif
890}
891
Tom Herbertbdeab992011-08-14 19:45:55 +0000892static inline void sock_rps_reset_rxhash(struct sock *sk)
893{
894#ifdef CONFIG_RPS
Tom Herbertbdeab992011-08-14 19:45:55 +0000895 sk->sk_rxhash = 0;
896#endif
897}
898
Stephen Hemmingercfcabdc2007-10-09 01:59:42 -0700899#define sk_wait_event(__sk, __timeo, __condition) \
900 ({ int __rc; \
901 release_sock(__sk); \
902 __rc = __condition; \
903 if (!__rc) { \
904 *(__timeo) = schedule_timeout(*(__timeo)); \
905 } \
Peter Zijlstra26cabd32014-09-24 10:18:54 +0200906 sched_annotate_sleep(); \
Stephen Hemmingercfcabdc2007-10-09 01:59:42 -0700907 lock_sock(__sk); \
908 __rc = __condition; \
909 __rc; \
910 })
Linus Torvalds1da177e2005-04-16 15:20:36 -0700911
Joe Perches69336bd2013-09-22 10:32:26 -0700912int sk_stream_wait_connect(struct sock *sk, long *timeo_p);
913int sk_stream_wait_memory(struct sock *sk, long *timeo_p);
914void sk_stream_wait_close(struct sock *sk, long timeo_p);
915int sk_stream_error(struct sock *sk, int flags, int err);
916void sk_stream_kill_queues(struct sock *sk);
917void sk_set_memalloc(struct sock *sk);
918void sk_clear_memalloc(struct sock *sk);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700919
Sabrina Dubrocadfbafc92015-07-24 18:19:25 +0200920int sk_wait_data(struct sock *sk, long *timeo, const struct sk_buff *skb);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700921
Arnaldo Carvalho de Melo60236fd2005-06-18 22:47:21 -0700922struct request_sock_ops;
Arnaldo Carvalho de Melo6d6ee432005-12-13 23:25:19 -0800923struct timewait_sock_ops;
Arnaldo Carvalho de Meloab1e0a12008-02-03 04:06:04 -0800924struct inet_hashinfo;
Pavel Emelyanovfc8717b2008-03-22 16:56:51 -0700925struct raw_hashinfo;
Paul Gortmakerde477252011-05-26 13:46:22 -0400926struct module;
Arnaldo Carvalho de Melo2e6599c2005-06-18 22:46:52 -0700927
Eric Dumazetf77d6022013-05-09 10:28:16 +0000928/*
929 * caches using SLAB_DESTROY_BY_RCU should let .next pointer from nulls nodes
930 * un-modified. Special care is taken when initializing object to zero.
931 */
932static inline void sk_prot_clear_nulls(struct sock *sk, int size)
933{
934 if (offsetof(struct sock, sk_node.next) != 0)
935 memset(sk, 0, offsetof(struct sock, sk_node.next));
936 memset(&sk->sk_node.pprev, 0,
937 size - offsetof(struct sock, sk_node.pprev));
938}
939
Linus Torvalds1da177e2005-04-16 15:20:36 -0700940/* Networking protocol blocks we attach to sockets.
941 * socket layer -> transport layer interface
Linus Torvalds1da177e2005-04-16 15:20:36 -0700942 */
943struct proto {
Eric Dumazetdc6b9b72012-05-16 22:48:15 +0000944 void (*close)(struct sock *sk,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700945 long timeout);
946 int (*connect)(struct sock *sk,
Eric Dumazetdc6b9b72012-05-16 22:48:15 +0000947 struct sockaddr *uaddr,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700948 int addr_len);
949 int (*disconnect)(struct sock *sk, int flags);
950
Eric Dumazetdc6b9b72012-05-16 22:48:15 +0000951 struct sock * (*accept)(struct sock *sk, int flags, int *err);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700952
953 int (*ioctl)(struct sock *sk, int cmd,
954 unsigned long arg);
955 int (*init)(struct sock *sk);
Brian Haley7d06b2e2008-06-14 17:04:49 -0700956 void (*destroy)(struct sock *sk);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700957 void (*shutdown)(struct sock *sk, int how);
Eric Dumazetdc6b9b72012-05-16 22:48:15 +0000958 int (*setsockopt)(struct sock *sk, int level,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700959 int optname, char __user *optval,
David S. Millerb7058842009-09-30 16:12:20 -0700960 unsigned int optlen);
Eric Dumazetdc6b9b72012-05-16 22:48:15 +0000961 int (*getsockopt)(struct sock *sk, int level,
962 int optname, char __user *optval,
963 int __user *option);
Alexey Dobriyanaf01d532008-08-28 02:53:51 -0700964#ifdef CONFIG_COMPAT
Dmitry Mishin3fdadf72006-03-20 22:45:21 -0800965 int (*compat_setsockopt)(struct sock *sk,
966 int level,
967 int optname, char __user *optval,
David S. Millerb7058842009-09-30 16:12:20 -0700968 unsigned int optlen);
Dmitry Mishin3fdadf72006-03-20 22:45:21 -0800969 int (*compat_getsockopt)(struct sock *sk,
970 int level,
971 int optname, char __user *optval,
972 int __user *option);
Eric W. Biederman709b46e2011-01-29 16:15:56 +0000973 int (*compat_ioctl)(struct sock *sk,
974 unsigned int cmd, unsigned long arg);
Alexey Dobriyanaf01d532008-08-28 02:53:51 -0700975#endif
Ying Xue1b784142015-03-02 15:37:48 +0800976 int (*sendmsg)(struct sock *sk, struct msghdr *msg,
977 size_t len);
978 int (*recvmsg)(struct sock *sk, struct msghdr *msg,
Eric Dumazetdc6b9b72012-05-16 22:48:15 +0000979 size_t len, int noblock, int flags,
980 int *addr_len);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700981 int (*sendpage)(struct sock *sk, struct page *page,
982 int offset, size_t size, int flags);
Eric Dumazetdc6b9b72012-05-16 22:48:15 +0000983 int (*bind)(struct sock *sk,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700984 struct sockaddr *uaddr, int addr_len);
985
Eric Dumazetdc6b9b72012-05-16 22:48:15 +0000986 int (*backlog_rcv) (struct sock *sk,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700987 struct sk_buff *skb);
988
Eric Dumazet46d3cea2012-07-11 05:50:31 +0000989 void (*release_cb)(struct sock *sk);
990
Linus Torvalds1da177e2005-04-16 15:20:36 -0700991 /* Keeping track of sk's, looking them up, and port selection methods. */
992 void (*hash)(struct sock *sk);
993 void (*unhash)(struct sock *sk);
Eric Dumazet719f8352010-09-08 05:08:44 +0000994 void (*rehash)(struct sock *sk);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700995 int (*get_port)(struct sock *sk, unsigned short snum);
Octavian Purdilafcbdf092010-12-16 14:26:56 -0800996 void (*clear_sk)(struct sock *sk, int size);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700997
Eric Dumazet286ab3d2007-11-05 23:38:39 -0800998 /* Keeping track of sockets in use */
Eric Dumazet65f76512008-01-03 20:46:48 -0800999#ifdef CONFIG_PROC_FS
Pavel Emelyanov13ff3d62008-03-28 16:38:17 -07001000 unsigned int inuse_idx;
Eric Dumazet65f76512008-01-03 20:46:48 -08001001#endif
Arnaldo Carvalho de Meloebb53d72007-11-21 22:08:50 +08001002
Eric Dumazetc9bee3b72013-07-22 20:27:07 -07001003 bool (*stream_memory_free)(const struct sock *sk);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001004 /* Memory pressure */
Pavel Emelyanov5c52ba12008-07-16 20:28:10 -07001005 void (*enter_memory_pressure)(struct sock *sk);
Eric Dumazet8d987e52010-11-09 23:24:26 +00001006 atomic_long_t *memory_allocated; /* Current allocated memory. */
Eric Dumazet17483762008-11-25 21:16:35 -08001007 struct percpu_counter *sockets_allocated; /* Current number of sockets. */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001008 /*
1009 * Pressure flag: try to collapse.
1010 * Technical note: it is used by multiple contexts non atomically.
Hideo Aoki3ab224b2007-12-31 00:11:19 -08001011 * All the __sk_mem_schedule() is of this nature: accounting
Linus Torvalds1da177e2005-04-16 15:20:36 -07001012 * is strict, actions are advisory and have some latency.
1013 */
1014 int *memory_pressure;
Eric Dumazet8d987e52010-11-09 23:24:26 +00001015 long *sysctl_mem;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001016 int *sysctl_wmem;
1017 int *sysctl_rmem;
1018 int max_header;
Changli Gao7ba42912010-07-10 20:41:55 +00001019 bool no_autobind;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001020
Eric Dumazet271b72c2008-10-29 02:11:14 -07001021 struct kmem_cache *slab;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001022 unsigned int obj_size;
Eric Dumazet271b72c2008-10-29 02:11:14 -07001023 int slab_flags;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001024
Eric Dumazetdd24c002008-11-25 21:17:14 -08001025 struct percpu_counter *orphan_count;
Arnaldo Carvalho de Melo8feaf0c02005-08-09 20:09:30 -07001026
Arnaldo Carvalho de Melo60236fd2005-06-18 22:47:21 -07001027 struct request_sock_ops *rsk_prot;
Arnaldo Carvalho de Melo6d6ee432005-12-13 23:25:19 -08001028 struct timewait_sock_ops *twsk_prot;
Arnaldo Carvalho de Melo2e6599c2005-06-18 22:46:52 -07001029
Pavel Emelyanov39d8cda2008-03-22 16:50:58 -07001030 union {
1031 struct inet_hashinfo *hashinfo;
Eric Dumazet645ca702008-10-29 01:41:45 -07001032 struct udp_table *udp_table;
Pavel Emelyanovfc8717b2008-03-22 16:56:51 -07001033 struct raw_hashinfo *raw_hash;
Pavel Emelyanov39d8cda2008-03-22 16:50:58 -07001034 } h;
Arnaldo Carvalho de Meloab1e0a12008-02-03 04:06:04 -08001035
Linus Torvalds1da177e2005-04-16 15:20:36 -07001036 struct module *owner;
1037
1038 char name[32];
1039
1040 struct list_head node;
Arnaldo Carvalho de Meloe6848972005-08-09 19:45:38 -07001041#ifdef SOCK_REFCNT_DEBUG
1042 atomic_t socks;
1043#endif
Andrew Mortonc255a452012-07-31 16:43:02 -07001044#ifdef CONFIG_MEMCG_KMEM
Glauber Costae1aab162011-12-11 21:47:03 +00001045 /*
1046 * cgroup specific init/deinit functions. Called once for all
1047 * protocols that implement it, from cgroups populate function.
1048 * This function has to setup any files the protocol want to
1049 * appear in the kmem cgroup filesystem.
1050 */
Glauber Costa1d62e432012-04-09 19:36:33 -03001051 int (*init_cgroup)(struct mem_cgroup *memcg,
Glauber Costae1aab162011-12-11 21:47:03 +00001052 struct cgroup_subsys *ss);
Glauber Costa1d62e432012-04-09 19:36:33 -03001053 void (*destroy_cgroup)(struct mem_cgroup *memcg);
Glauber Costae1aab162011-12-11 21:47:03 +00001054 struct cg_proto *(*proto_cgroup)(struct mem_cgroup *memcg);
1055#endif
1056};
1057
Joe Perches69336bd2013-09-22 10:32:26 -07001058int proto_register(struct proto *prot, int alloc_slab);
1059void proto_unregister(struct proto *prot);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001060
Arnaldo Carvalho de Meloe6848972005-08-09 19:45:38 -07001061#ifdef SOCK_REFCNT_DEBUG
1062static inline void sk_refcnt_debug_inc(struct sock *sk)
1063{
1064 atomic_inc(&sk->sk_prot->socks);
1065}
1066
1067static inline void sk_refcnt_debug_dec(struct sock *sk)
1068{
1069 atomic_dec(&sk->sk_prot->socks);
1070 printk(KERN_DEBUG "%s socket %p released, %d are still alive\n",
1071 sk->sk_prot->name, sk, atomic_read(&sk->sk_prot->socks));
1072}
1073
Ying Xuedec34fb2013-02-15 22:28:25 +00001074static inline void sk_refcnt_debug_release(const struct sock *sk)
Arnaldo Carvalho de Meloe6848972005-08-09 19:45:38 -07001075{
1076 if (atomic_read(&sk->sk_refcnt) != 1)
1077 printk(KERN_DEBUG "Destruction of the %s socket %p delayed, refcnt=%d\n",
1078 sk->sk_prot->name, sk, atomic_read(&sk->sk_refcnt));
1079}
1080#else /* SOCK_REFCNT_DEBUG */
1081#define sk_refcnt_debug_inc(sk) do { } while (0)
1082#define sk_refcnt_debug_dec(sk) do { } while (0)
1083#define sk_refcnt_debug_release(sk) do { } while (0)
1084#endif /* SOCK_REFCNT_DEBUG */
1085
Andrew Mortonc255a452012-07-31 16:43:02 -07001086#if defined(CONFIG_MEMCG_KMEM) && defined(CONFIG_NET)
Ingo Molnarc5905af2012-02-24 08:31:31 +01001087extern struct static_key memcg_socket_limit_enabled;
Glauber Costae1aab162011-12-11 21:47:03 +00001088static inline struct cg_proto *parent_cg_proto(struct proto *proto,
1089 struct cg_proto *cg_proto)
1090{
1091 return proto->proto_cgroup(parent_mem_cgroup(cg_proto->memcg));
1092}
Ingo Molnarc5905af2012-02-24 08:31:31 +01001093#define mem_cgroup_sockets_enabled static_key_false(&memcg_socket_limit_enabled)
Glauber Costae1aab162011-12-11 21:47:03 +00001094#else
1095#define mem_cgroup_sockets_enabled 0
1096static inline struct cg_proto *parent_cg_proto(struct proto *proto,
1097 struct cg_proto *cg_proto)
1098{
1099 return NULL;
1100}
1101#endif
1102
Eric Dumazetc9bee3b72013-07-22 20:27:07 -07001103static inline bool sk_stream_memory_free(const struct sock *sk)
1104{
1105 if (sk->sk_wmem_queued >= sk->sk_sndbuf)
1106 return false;
1107
1108 return sk->sk_prot->stream_memory_free ?
1109 sk->sk_prot->stream_memory_free(sk) : true;
1110}
1111
Eric Dumazet64dc6132013-07-22 20:26:31 -07001112static inline bool sk_stream_is_writeable(const struct sock *sk)
1113{
Eric Dumazetc9bee3b72013-07-22 20:27:07 -07001114 return sk_stream_wspace(sk) >= sk_stream_min_wspace(sk) &&
1115 sk_stream_memory_free(sk);
Eric Dumazet64dc6132013-07-22 20:26:31 -07001116}
Glauber Costae1aab162011-12-11 21:47:03 +00001117
Eric Dumazetc9bee3b72013-07-22 20:27:07 -07001118
Glauber Costa180d8cd2011-12-11 21:47:02 +00001119static inline bool sk_has_memory_pressure(const struct sock *sk)
1120{
1121 return sk->sk_prot->memory_pressure != NULL;
1122}
1123
1124static inline bool sk_under_memory_pressure(const struct sock *sk)
1125{
1126 if (!sk->sk_prot->memory_pressure)
1127 return false;
Glauber Costae1aab162011-12-11 21:47:03 +00001128
1129 if (mem_cgroup_sockets_enabled && sk->sk_cgrp)
Eric W. Biederman2e685ca2013-10-19 16:26:19 -07001130 return !!sk->sk_cgrp->memory_pressure;
Glauber Costae1aab162011-12-11 21:47:03 +00001131
Christoph Paasch35b87f62013-10-23 12:49:21 -07001132 return !!*sk->sk_prot->memory_pressure;
Glauber Costa180d8cd2011-12-11 21:47:02 +00001133}
1134
1135static inline void sk_leave_memory_pressure(struct sock *sk)
1136{
1137 int *memory_pressure = sk->sk_prot->memory_pressure;
1138
Glauber Costae1aab162011-12-11 21:47:03 +00001139 if (!memory_pressure)
1140 return;
1141
1142 if (*memory_pressure)
Glauber Costa180d8cd2011-12-11 21:47:02 +00001143 *memory_pressure = 0;
Glauber Costae1aab162011-12-11 21:47:03 +00001144
1145 if (mem_cgroup_sockets_enabled && sk->sk_cgrp) {
1146 struct cg_proto *cg_proto = sk->sk_cgrp;
1147 struct proto *prot = sk->sk_prot;
1148
1149 for (; cg_proto; cg_proto = parent_cg_proto(prot, cg_proto))
Eric W. Biederman7f2cbdc2013-12-04 20:12:04 -08001150 cg_proto->memory_pressure = 0;
Glauber Costae1aab162011-12-11 21:47:03 +00001151 }
1152
Glauber Costa180d8cd2011-12-11 21:47:02 +00001153}
1154
1155static inline void sk_enter_memory_pressure(struct sock *sk)
1156{
Glauber Costae1aab162011-12-11 21:47:03 +00001157 if (!sk->sk_prot->enter_memory_pressure)
1158 return;
1159
1160 if (mem_cgroup_sockets_enabled && sk->sk_cgrp) {
1161 struct cg_proto *cg_proto = sk->sk_cgrp;
1162 struct proto *prot = sk->sk_prot;
1163
1164 for (; cg_proto; cg_proto = parent_cg_proto(prot, cg_proto))
Eric W. Biederman7f2cbdc2013-12-04 20:12:04 -08001165 cg_proto->memory_pressure = 1;
Glauber Costae1aab162011-12-11 21:47:03 +00001166 }
1167
1168 sk->sk_prot->enter_memory_pressure(sk);
Glauber Costa180d8cd2011-12-11 21:47:02 +00001169}
1170
1171static inline long sk_prot_mem_limits(const struct sock *sk, int index)
1172{
1173 long *prot = sk->sk_prot->sysctl_mem;
Glauber Costae1aab162011-12-11 21:47:03 +00001174 if (mem_cgroup_sockets_enabled && sk->sk_cgrp)
1175 prot = sk->sk_cgrp->sysctl_mem;
Glauber Costa180d8cd2011-12-11 21:47:02 +00001176 return prot[index];
1177}
1178
Glauber Costae1aab162011-12-11 21:47:03 +00001179static inline void memcg_memory_allocated_add(struct cg_proto *prot,
1180 unsigned long amt,
1181 int *parent_status)
1182{
Johannes Weiner3e32cb22014-12-10 15:42:31 -08001183 page_counter_charge(&prot->memory_allocated, amt);
Glauber Costae1aab162011-12-11 21:47:03 +00001184
Johannes Weiner3e32cb22014-12-10 15:42:31 -08001185 if (page_counter_read(&prot->memory_allocated) >
1186 prot->memory_allocated.limit)
Glauber Costae1aab162011-12-11 21:47:03 +00001187 *parent_status = OVER_LIMIT;
1188}
1189
1190static inline void memcg_memory_allocated_sub(struct cg_proto *prot,
1191 unsigned long amt)
1192{
Johannes Weiner3e32cb22014-12-10 15:42:31 -08001193 page_counter_uncharge(&prot->memory_allocated, amt);
Glauber Costae1aab162011-12-11 21:47:03 +00001194}
1195
Glauber Costa180d8cd2011-12-11 21:47:02 +00001196static inline long
1197sk_memory_allocated(const struct sock *sk)
1198{
1199 struct proto *prot = sk->sk_prot;
Johannes Weiner3e32cb22014-12-10 15:42:31 -08001200
Glauber Costae1aab162011-12-11 21:47:03 +00001201 if (mem_cgroup_sockets_enabled && sk->sk_cgrp)
Johannes Weiner3e32cb22014-12-10 15:42:31 -08001202 return page_counter_read(&sk->sk_cgrp->memory_allocated);
Glauber Costae1aab162011-12-11 21:47:03 +00001203
Glauber Costa180d8cd2011-12-11 21:47:02 +00001204 return atomic_long_read(prot->memory_allocated);
1205}
1206
1207static inline long
Glauber Costae1aab162011-12-11 21:47:03 +00001208sk_memory_allocated_add(struct sock *sk, int amt, int *parent_status)
Glauber Costa180d8cd2011-12-11 21:47:02 +00001209{
1210 struct proto *prot = sk->sk_prot;
Glauber Costae1aab162011-12-11 21:47:03 +00001211
1212 if (mem_cgroup_sockets_enabled && sk->sk_cgrp) {
1213 memcg_memory_allocated_add(sk->sk_cgrp, amt, parent_status);
1214 /* update the root cgroup regardless */
1215 atomic_long_add_return(amt, prot->memory_allocated);
Johannes Weiner3e32cb22014-12-10 15:42:31 -08001216 return page_counter_read(&sk->sk_cgrp->memory_allocated);
Glauber Costae1aab162011-12-11 21:47:03 +00001217 }
1218
Glauber Costa180d8cd2011-12-11 21:47:02 +00001219 return atomic_long_add_return(amt, prot->memory_allocated);
1220}
1221
1222static inline void
Glauber Costa0e90b312012-01-20 04:57:16 +00001223sk_memory_allocated_sub(struct sock *sk, int amt)
Glauber Costa180d8cd2011-12-11 21:47:02 +00001224{
1225 struct proto *prot = sk->sk_prot;
Glauber Costae1aab162011-12-11 21:47:03 +00001226
Glauber Costa0e90b312012-01-20 04:57:16 +00001227 if (mem_cgroup_sockets_enabled && sk->sk_cgrp)
Glauber Costae1aab162011-12-11 21:47:03 +00001228 memcg_memory_allocated_sub(sk->sk_cgrp, amt);
1229
Glauber Costa180d8cd2011-12-11 21:47:02 +00001230 atomic_long_sub(amt, prot->memory_allocated);
1231}
1232
1233static inline void sk_sockets_allocated_dec(struct sock *sk)
1234{
1235 struct proto *prot = sk->sk_prot;
Glauber Costae1aab162011-12-11 21:47:03 +00001236
1237 if (mem_cgroup_sockets_enabled && sk->sk_cgrp) {
1238 struct cg_proto *cg_proto = sk->sk_cgrp;
1239
1240 for (; cg_proto; cg_proto = parent_cg_proto(prot, cg_proto))
Eric W. Biederman2e685ca2013-10-19 16:26:19 -07001241 percpu_counter_dec(&cg_proto->sockets_allocated);
Glauber Costae1aab162011-12-11 21:47:03 +00001242 }
1243
Glauber Costa180d8cd2011-12-11 21:47:02 +00001244 percpu_counter_dec(prot->sockets_allocated);
1245}
1246
1247static inline void sk_sockets_allocated_inc(struct sock *sk)
1248{
1249 struct proto *prot = sk->sk_prot;
Glauber Costae1aab162011-12-11 21:47:03 +00001250
1251 if (mem_cgroup_sockets_enabled && sk->sk_cgrp) {
1252 struct cg_proto *cg_proto = sk->sk_cgrp;
1253
1254 for (; cg_proto; cg_proto = parent_cg_proto(prot, cg_proto))
Eric W. Biederman2e685ca2013-10-19 16:26:19 -07001255 percpu_counter_inc(&cg_proto->sockets_allocated);
Glauber Costae1aab162011-12-11 21:47:03 +00001256 }
1257
Glauber Costa180d8cd2011-12-11 21:47:02 +00001258 percpu_counter_inc(prot->sockets_allocated);
1259}
1260
1261static inline int
1262sk_sockets_allocated_read_positive(struct sock *sk)
1263{
1264 struct proto *prot = sk->sk_prot;
1265
Glauber Costae1aab162011-12-11 21:47:03 +00001266 if (mem_cgroup_sockets_enabled && sk->sk_cgrp)
Eric W. Biederman2e685ca2013-10-19 16:26:19 -07001267 return percpu_counter_read_positive(&sk->sk_cgrp->sockets_allocated);
Glauber Costae1aab162011-12-11 21:47:03 +00001268
Eric Dumazet518fbf92012-04-28 23:21:56 +00001269 return percpu_counter_read_positive(prot->sockets_allocated);
Glauber Costa180d8cd2011-12-11 21:47:02 +00001270}
1271
1272static inline int
1273proto_sockets_allocated_sum_positive(struct proto *prot)
1274{
1275 return percpu_counter_sum_positive(prot->sockets_allocated);
1276}
1277
1278static inline long
1279proto_memory_allocated(struct proto *prot)
1280{
1281 return atomic_long_read(prot->memory_allocated);
1282}
1283
1284static inline bool
1285proto_memory_pressure(struct proto *prot)
1286{
1287 if (!prot->memory_pressure)
1288 return false;
1289 return !!*prot->memory_pressure;
1290}
1291
Eric Dumazet65f76512008-01-03 20:46:48 -08001292
1293#ifdef CONFIG_PROC_FS
Linus Torvalds1da177e2005-04-16 15:20:36 -07001294/* Called with local bh disabled */
Joe Perches69336bd2013-09-22 10:32:26 -07001295void sock_prot_inuse_add(struct net *net, struct proto *prot, int inc);
1296int sock_prot_inuse_get(struct net *net, struct proto *proto);
Eric Dumazet65f76512008-01-03 20:46:48 -08001297#else
Eric Dumazetdc6b9b72012-05-16 22:48:15 +00001298static inline void sock_prot_inuse_add(struct net *net, struct proto *prot,
Pavel Emelyanovc29a0bc2008-03-31 19:41:46 -07001299 int inc)
Eric Dumazet65f76512008-01-03 20:46:48 -08001300{
1301}
Eric Dumazet65f76512008-01-03 20:46:48 -08001302#endif
1303
Linus Torvalds1da177e2005-04-16 15:20:36 -07001304
Arnaldo Carvalho de Melo614c6cb2005-08-09 19:47:37 -07001305/* With per-bucket locks this operation is not-atomic, so that
1306 * this version is not worse.
1307 */
1308static inline void __sk_prot_rehash(struct sock *sk)
1309{
1310 sk->sk_prot->unhash(sk);
1311 sk->sk_prot->hash(sk);
1312}
1313
Octavian Purdilafcbdf092010-12-16 14:26:56 -08001314void sk_prot_clear_portaddr_nulls(struct sock *sk, int size);
1315
Linus Torvalds1da177e2005-04-16 15:20:36 -07001316/* About 10 seconds */
1317#define SOCK_DESTROY_TIME (10*HZ)
1318
1319/* Sockets 0-1023 can't be bound to unless you are superuser */
1320#define PROT_SOCK 1024
1321
1322#define SHUTDOWN_MASK 3
1323#define RCV_SHUTDOWN 1
1324#define SEND_SHUTDOWN 2
1325
1326#define SOCK_SNDBUF_LOCK 1
1327#define SOCK_RCVBUF_LOCK 2
1328#define SOCK_BINDADDR_LOCK 4
1329#define SOCK_BINDPORT_LOCK 8
1330
Linus Torvalds1da177e2005-04-16 15:20:36 -07001331struct socket_alloc {
1332 struct socket socket;
1333 struct inode vfs_inode;
1334};
1335
1336static inline struct socket *SOCKET_I(struct inode *inode)
1337{
1338 return &container_of(inode, struct socket_alloc, vfs_inode)->socket;
1339}
1340
1341static inline struct inode *SOCK_INODE(struct socket *socket)
1342{
1343 return &container_of(socket, struct socket_alloc, socket)->vfs_inode;
1344}
1345
Hideo Aoki3ab224b2007-12-31 00:11:19 -08001346/*
1347 * Functions for memory accounting
1348 */
Joe Perches69336bd2013-09-22 10:32:26 -07001349int __sk_mem_schedule(struct sock *sk, int size, int kind);
Eric Dumazet1a24e042015-05-15 12:39:25 -07001350void __sk_mem_reclaim(struct sock *sk, int amount);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001351
Hideo Aoki3ab224b2007-12-31 00:11:19 -08001352#define SK_MEM_QUANTUM ((int)PAGE_SIZE)
1353#define SK_MEM_QUANTUM_SHIFT ilog2(SK_MEM_QUANTUM)
1354#define SK_MEM_SEND 0
1355#define SK_MEM_RECV 1
Linus Torvalds1da177e2005-04-16 15:20:36 -07001356
Hideo Aoki3ab224b2007-12-31 00:11:19 -08001357static inline int sk_mem_pages(int amt)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001358{
Hideo Aoki3ab224b2007-12-31 00:11:19 -08001359 return (amt + SK_MEM_QUANTUM - 1) >> SK_MEM_QUANTUM_SHIFT;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001360}
1361
Eric Dumazetdc6b9b72012-05-16 22:48:15 +00001362static inline bool sk_has_account(struct sock *sk)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001363{
Hideo Aoki3ab224b2007-12-31 00:11:19 -08001364 /* return true if protocol supports memory accounting */
1365 return !!sk->sk_prot->memory_allocated;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001366}
1367
Eric Dumazetdc6b9b72012-05-16 22:48:15 +00001368static inline bool sk_wmem_schedule(struct sock *sk, int size)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001369{
Hideo Aoki3ab224b2007-12-31 00:11:19 -08001370 if (!sk_has_account(sk))
Eric Dumazetdc6b9b72012-05-16 22:48:15 +00001371 return true;
Herbert Xud80d99d2005-09-01 17:48:23 -07001372 return size <= sk->sk_forward_alloc ||
Hideo Aoki3ab224b2007-12-31 00:11:19 -08001373 __sk_mem_schedule(sk, size, SK_MEM_SEND);
1374}
1375
Mel Gormanc76562b2012-07-31 16:44:41 -07001376static inline bool
Chuck Lever35c448a2012-09-17 14:09:11 -07001377sk_rmem_schedule(struct sock *sk, struct sk_buff *skb, int size)
Hideo Aoki3ab224b2007-12-31 00:11:19 -08001378{
1379 if (!sk_has_account(sk))
Eric Dumazetdc6b9b72012-05-16 22:48:15 +00001380 return true;
Mel Gormanc76562b2012-07-31 16:44:41 -07001381 return size<= sk->sk_forward_alloc ||
1382 __sk_mem_schedule(sk, size, SK_MEM_RECV) ||
1383 skb_pfmemalloc(skb);
Hideo Aoki3ab224b2007-12-31 00:11:19 -08001384}
1385
1386static inline void sk_mem_reclaim(struct sock *sk)
1387{
1388 if (!sk_has_account(sk))
1389 return;
1390 if (sk->sk_forward_alloc >= SK_MEM_QUANTUM)
Eric Dumazet1a24e042015-05-15 12:39:25 -07001391 __sk_mem_reclaim(sk, sk->sk_forward_alloc);
Hideo Aoki3ab224b2007-12-31 00:11:19 -08001392}
1393
David S. Miller9993e7d2008-01-10 21:56:38 -08001394static inline void sk_mem_reclaim_partial(struct sock *sk)
1395{
1396 if (!sk_has_account(sk))
1397 return;
1398 if (sk->sk_forward_alloc > SK_MEM_QUANTUM)
Eric Dumazet1a24e042015-05-15 12:39:25 -07001399 __sk_mem_reclaim(sk, sk->sk_forward_alloc - 1);
David S. Miller9993e7d2008-01-10 21:56:38 -08001400}
1401
Hideo Aoki3ab224b2007-12-31 00:11:19 -08001402static inline void sk_mem_charge(struct sock *sk, int size)
1403{
1404 if (!sk_has_account(sk))
1405 return;
1406 sk->sk_forward_alloc -= size;
1407}
1408
1409static inline void sk_mem_uncharge(struct sock *sk, int size)
1410{
1411 if (!sk_has_account(sk))
1412 return;
1413 sk->sk_forward_alloc += size;
1414}
1415
1416static inline void sk_wmem_free_skb(struct sock *sk, struct sk_buff *skb)
1417{
Hideo Aoki3ab224b2007-12-31 00:11:19 -08001418 sock_set_flag(sk, SOCK_QUEUE_SHRUNK);
1419 sk->sk_wmem_queued -= skb->truesize;
1420 sk_mem_uncharge(sk, skb->truesize);
1421 __kfree_skb(skb);
Herbert Xud80d99d2005-09-01 17:48:23 -07001422}
1423
Linus Torvalds1da177e2005-04-16 15:20:36 -07001424/* Used by processes to "lock" a socket state, so that
1425 * interrupts and bottom half handlers won't change it
1426 * from under us. It essentially blocks any incoming
1427 * packets, so that we won't get any new data or any
1428 * packets that change the state of the socket.
1429 *
1430 * While locked, BH processing will add new packets to
1431 * the backlog queue. This queue is processed by the
1432 * owner of the socket lock right before it is released.
1433 *
1434 * Since ~2.3.5 it is also exclusive sleep lock serializing
1435 * accesses from user process context.
1436 */
John Heffnerd2e91172007-09-12 10:44:19 +02001437#define sock_owned_by_user(sk) ((sk)->sk_lock.owned)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001438
Eric Dumazetc3f9b012014-03-10 09:50:11 -07001439static inline void sock_release_ownership(struct sock *sk)
1440{
1441 sk->sk_lock.owned = 0;
1442}
1443
Peter Zijlstraed075362006-12-06 20:35:24 -08001444/*
1445 * Macro so as to not evaluate some arguments when
1446 * lockdep is not enabled.
1447 *
1448 * Mark both the sk_lock and the sk_lock.slock as a
1449 * per-address-family lock class.
1450 */
Eric Dumazetdc6b9b72012-05-16 22:48:15 +00001451#define sock_lock_init_class_and_name(sk, sname, skey, name, key) \
Peter Zijlstraed075362006-12-06 20:35:24 -08001452do { \
Ingo Molnare8f6fbf2008-11-12 01:38:36 +00001453 sk->sk_lock.owned = 0; \
Peter Zijlstraed075362006-12-06 20:35:24 -08001454 init_waitqueue_head(&sk->sk_lock.wq); \
1455 spin_lock_init(&(sk)->sk_lock.slock); \
1456 debug_check_no_locks_freed((void *)&(sk)->sk_lock, \
1457 sizeof((sk)->sk_lock)); \
1458 lockdep_set_class_and_name(&(sk)->sk_lock.slock, \
Eric Dumazetdc6b9b72012-05-16 22:48:15 +00001459 (skey), (sname)); \
Peter Zijlstraed075362006-12-06 20:35:24 -08001460 lockdep_init_map(&(sk)->sk_lock.dep_map, (name), (key), 0); \
1461} while (0)
1462
Joe Perches69336bd2013-09-22 10:32:26 -07001463void lock_sock_nested(struct sock *sk, int subclass);
Peter Zijlstrafcc70d52006-11-08 22:44:35 -08001464
1465static inline void lock_sock(struct sock *sk)
1466{
1467 lock_sock_nested(sk, 0);
1468}
1469
Joe Perches69336bd2013-09-22 10:32:26 -07001470void release_sock(struct sock *sk);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001471
1472/* BH context may only use the following locking interface. */
1473#define bh_lock_sock(__sk) spin_lock(&((__sk)->sk_lock.slock))
Ingo Molnarc6366182006-07-03 00:25:13 -07001474#define bh_lock_sock_nested(__sk) \
1475 spin_lock_nested(&((__sk)->sk_lock.slock), \
1476 SINGLE_DEPTH_NESTING)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001477#define bh_unlock_sock(__sk) spin_unlock(&((__sk)->sk_lock.slock))
1478
Joe Perches69336bd2013-09-22 10:32:26 -07001479bool lock_sock_fast(struct sock *sk);
Eric Dumazet8a74ad62010-05-26 19:20:18 +00001480/**
1481 * unlock_sock_fast - complement of lock_sock_fast
1482 * @sk: socket
1483 * @slow: slow mode
1484 *
1485 * fast unlock socket for user context.
1486 * If slow mode is on, we call regular release_sock()
1487 */
1488static inline void unlock_sock_fast(struct sock *sk, bool slow)
Eric Dumazet4b0b72f2010-04-28 14:35:48 -07001489{
Eric Dumazet8a74ad62010-05-26 19:20:18 +00001490 if (slow)
1491 release_sock(sk);
1492 else
1493 spin_unlock_bh(&sk->sk_lock.slock);
Eric Dumazet4b0b72f2010-04-28 14:35:48 -07001494}
1495
Eric Dumazet4b0b72f2010-04-28 14:35:48 -07001496
Joe Perches69336bd2013-09-22 10:32:26 -07001497struct sock *sk_alloc(struct net *net, int family, gfp_t priority,
Eric W. Biederman11aa9c22015-05-08 21:09:13 -05001498 struct proto *prot, int kern);
Joe Perches69336bd2013-09-22 10:32:26 -07001499void sk_free(struct sock *sk);
Craig Gallekeb4cb002015-06-15 11:26:18 -04001500void sk_destruct(struct sock *sk);
Joe Perches69336bd2013-09-22 10:32:26 -07001501struct sock *sk_clone_lock(const struct sock *sk, const gfp_t priority);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001502
Joe Perches69336bd2013-09-22 10:32:26 -07001503struct sk_buff *sock_wmalloc(struct sock *sk, unsigned long size, int force,
1504 gfp_t priority);
Joe Perches69336bd2013-09-22 10:32:26 -07001505void sock_wfree(struct sk_buff *skb);
1506void skb_orphan_partial(struct sk_buff *skb);
1507void sock_rfree(struct sk_buff *skb);
Alexander Duyck62bccb82014-09-04 13:31:35 -04001508void sock_efree(struct sk_buff *skb);
Alexander Duyck82eabd92014-09-04 13:32:11 -04001509#ifdef CONFIG_INET
Joe Perches69336bd2013-09-22 10:32:26 -07001510void sock_edemux(struct sk_buff *skb);
Alexander Duyck82eabd92014-09-04 13:32:11 -04001511#else
1512#define sock_edemux(skb) sock_efree(skb)
1513#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -07001514
Joe Perches69336bd2013-09-22 10:32:26 -07001515int sock_setsockopt(struct socket *sock, int level, int op,
1516 char __user *optval, unsigned int optlen);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001517
Joe Perches69336bd2013-09-22 10:32:26 -07001518int sock_getsockopt(struct socket *sock, int level, int op,
1519 char __user *optval, int __user *optlen);
1520struct sk_buff *sock_alloc_send_skb(struct sock *sk, unsigned long size,
1521 int noblock, int *errcode);
1522struct sk_buff *sock_alloc_send_pskb(struct sock *sk, unsigned long header_len,
1523 unsigned long data_len, int noblock,
1524 int *errcode, int max_page_order);
1525void *sock_kmalloc(struct sock *sk, int size, gfp_t priority);
1526void sock_kfree_s(struct sock *sk, void *mem, int size);
Daniel Borkmann79e88652014-11-19 17:13:11 +01001527void sock_kzfree_s(struct sock *sk, void *mem, int size);
Joe Perches69336bd2013-09-22 10:32:26 -07001528void sk_send_sigurg(struct sock *sk);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001529
Edward Jeef28ea362015-10-08 14:56:48 -07001530struct sockcm_cookie {
1531 u32 mark;
1532};
1533
1534int sock_cmsg_send(struct sock *sk, struct msghdr *msg,
1535 struct sockcm_cookie *sockc);
1536
Linus Torvalds1da177e2005-04-16 15:20:36 -07001537/*
1538 * Functions to fill in entries in struct proto_ops when a protocol
1539 * does not implement a particular function.
1540 */
Joe Perches69336bd2013-09-22 10:32:26 -07001541int sock_no_bind(struct socket *, struct sockaddr *, int);
1542int sock_no_connect(struct socket *, struct sockaddr *, int, int);
1543int sock_no_socketpair(struct socket *, struct socket *);
1544int sock_no_accept(struct socket *, struct socket *, int);
1545int sock_no_getname(struct socket *, struct sockaddr *, int *, int);
1546unsigned int sock_no_poll(struct file *, struct socket *,
1547 struct poll_table_struct *);
1548int sock_no_ioctl(struct socket *, unsigned int, unsigned long);
1549int sock_no_listen(struct socket *, int);
1550int sock_no_shutdown(struct socket *, int);
1551int sock_no_getsockopt(struct socket *, int , int, char __user *, int __user *);
1552int sock_no_setsockopt(struct socket *, int, int, char __user *, unsigned int);
Ying Xue1b784142015-03-02 15:37:48 +08001553int sock_no_sendmsg(struct socket *, struct msghdr *, size_t);
1554int sock_no_recvmsg(struct socket *, struct msghdr *, size_t, int);
Joe Perches69336bd2013-09-22 10:32:26 -07001555int sock_no_mmap(struct file *file, struct socket *sock,
1556 struct vm_area_struct *vma);
1557ssize_t sock_no_sendpage(struct socket *sock, struct page *page, int offset,
1558 size_t size, int flags);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001559
1560/*
1561 * Functions to fill in entries in struct proto_ops when a protocol
1562 * uses the inet style.
1563 */
Joe Perches69336bd2013-09-22 10:32:26 -07001564int sock_common_getsockopt(struct socket *sock, int level, int optname,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001565 char __user *optval, int __user *optlen);
Ying Xue1b784142015-03-02 15:37:48 +08001566int sock_common_recvmsg(struct socket *sock, struct msghdr *msg, size_t size,
1567 int flags);
Joe Perches69336bd2013-09-22 10:32:26 -07001568int sock_common_setsockopt(struct socket *sock, int level, int optname,
David S. Millerb7058842009-09-30 16:12:20 -07001569 char __user *optval, unsigned int optlen);
Joe Perches69336bd2013-09-22 10:32:26 -07001570int compat_sock_common_getsockopt(struct socket *sock, int level,
Dmitry Mishin3fdadf72006-03-20 22:45:21 -08001571 int optname, char __user *optval, int __user *optlen);
Joe Perches69336bd2013-09-22 10:32:26 -07001572int compat_sock_common_setsockopt(struct socket *sock, int level,
David S. Millerb7058842009-09-30 16:12:20 -07001573 int optname, char __user *optval, unsigned int optlen);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001574
Joe Perches69336bd2013-09-22 10:32:26 -07001575void sk_common_release(struct sock *sk);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001576
1577/*
1578 * Default socket callbacks and setup code
1579 */
Eric Dumazetdc6b9b72012-05-16 22:48:15 +00001580
Linus Torvalds1da177e2005-04-16 15:20:36 -07001581/* Initialise core socket variables */
Joe Perches69336bd2013-09-22 10:32:26 -07001582void sock_init_data(struct socket *sock, struct sock *sk);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001583
Linus Torvalds1da177e2005-04-16 15:20:36 -07001584/*
1585 * Socket reference counting postulates.
1586 *
1587 * * Each user of socket SHOULD hold a reference count.
1588 * * Each access point to socket (an hash table bucket, reference from a list,
1589 * running timer, skb in flight MUST hold a reference count.
1590 * * When reference count hits 0, it means it will never increase back.
1591 * * When reference count hits 0, it means that no references from
1592 * outside exist to this socket and current process on current CPU
1593 * is last user and may/should destroy this socket.
1594 * * sk_free is called from any context: process, BH, IRQ. When
1595 * it is called, socket has no references from outside -> sk_free
1596 * may release descendant resources allocated by the socket, but
1597 * to the time when it is called, socket is NOT referenced by any
1598 * hash tables, lists etc.
1599 * * Packets, delivered from outside (from network or from another process)
1600 * and enqueued on receive/error queues SHOULD NOT grab reference count,
1601 * when they sit in queue. Otherwise, packets will leak to hole, when
1602 * socket is looked up by one cpu and unhasing is made by another CPU.
1603 * It is true for udp/raw, netlink (leak to receive and error queues), tcp
1604 * (leak to backlog). Packet socket does all the processing inside
1605 * BR_NETPROTO_LOCK, so that it has not this race condition. UNIX sockets
1606 * use separate SMP lock, so that they are prone too.
1607 */
1608
1609/* Ungrab socket and destroy it, if it was the last reference. */
1610static inline void sock_put(struct sock *sk)
1611{
1612 if (atomic_dec_and_test(&sk->sk_refcnt))
1613 sk_free(sk);
1614}
Eric Dumazet05dbc7b2013-10-03 00:22:02 -07001615/* Generic version of sock_put(), dealing with all sockets
Eric Dumazet41b822c2015-03-12 16:44:08 -07001616 * (TCP_TIMEWAIT, TCP_NEW_SYN_RECV, ESTABLISHED...)
Eric Dumazet05dbc7b2013-10-03 00:22:02 -07001617 */
1618void sock_gen_put(struct sock *sk);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001619
Joe Perches69336bd2013-09-22 10:32:26 -07001620int sk_receive_skb(struct sock *sk, struct sk_buff *skb, const int nested);
Arnaldo Carvalho de Melo25995ff2005-12-27 02:42:22 -02001621
Krishna Kumare022f0b2009-10-19 23:46:20 +00001622static inline void sk_tx_queue_set(struct sock *sk, int tx_queue)
1623{
1624 sk->sk_tx_queue_mapping = tx_queue;
1625}
1626
1627static inline void sk_tx_queue_clear(struct sock *sk)
1628{
1629 sk->sk_tx_queue_mapping = -1;
1630}
1631
1632static inline int sk_tx_queue_get(const struct sock *sk)
1633{
Tom Herbertb0f77d02010-07-14 20:50:29 -07001634 return sk ? sk->sk_tx_queue_mapping : -1;
Krishna Kumare022f0b2009-10-19 23:46:20 +00001635}
1636
David S. Miller972692e2008-06-17 22:41:38 -07001637static inline void sk_set_socket(struct sock *sk, struct socket *sock)
1638{
Krishna Kumare022f0b2009-10-19 23:46:20 +00001639 sk_tx_queue_clear(sk);
David S. Miller972692e2008-06-17 22:41:38 -07001640 sk->sk_socket = sock;
1641}
1642
Eric Dumazetaa395142010-04-20 13:03:51 +00001643static inline wait_queue_head_t *sk_sleep(struct sock *sk)
1644{
Eric Dumazeteaefd112011-02-18 03:26:36 +00001645 BUILD_BUG_ON(offsetof(struct socket_wq, wait) != 0);
1646 return &rcu_dereference_raw(sk->sk_wq)->wait;
Eric Dumazetaa395142010-04-20 13:03:51 +00001647}
Linus Torvalds1da177e2005-04-16 15:20:36 -07001648/* Detach socket from process context.
1649 * Announce socket dead, detach it from wait queue and inode.
1650 * Note that parent inode held reference count on this struct sock,
1651 * we do not release it in this function, because protocol
1652 * probably wants some additional cleanups or even continuing
1653 * to work with this socket (TCP).
1654 */
1655static inline void sock_orphan(struct sock *sk)
1656{
1657 write_lock_bh(&sk->sk_callback_lock);
1658 sock_set_flag(sk, SOCK_DEAD);
David S. Miller972692e2008-06-17 22:41:38 -07001659 sk_set_socket(sk, NULL);
Eric Dumazet43815482010-04-29 11:01:49 +00001660 sk->sk_wq = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001661 write_unlock_bh(&sk->sk_callback_lock);
1662}
1663
1664static inline void sock_graft(struct sock *sk, struct socket *parent)
1665{
1666 write_lock_bh(&sk->sk_callback_lock);
Eric Dumazeteaefd112011-02-18 03:26:36 +00001667 sk->sk_wq = parent->wq;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001668 parent->sk = sk;
David S. Miller972692e2008-06-17 22:41:38 -07001669 sk_set_socket(sk, parent);
Venkat Yekkirala4237c752006-07-24 23:32:50 -07001670 security_sock_graft(sk, parent);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001671 write_unlock_bh(&sk->sk_callback_lock);
1672}
1673
Joe Perches69336bd2013-09-22 10:32:26 -07001674kuid_t sock_i_uid(struct sock *sk);
1675unsigned long sock_i_ino(struct sock *sk);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001676
Eric Dumazet58d607d2015-09-15 15:24:20 -07001677static inline u32 net_tx_rndhash(void)
1678{
1679 u32 v = prandom_u32();
1680
1681 return v ?: 1;
1682}
1683
Tom Herbert877d1f62015-07-28 16:02:05 -07001684static inline void sk_set_txhash(struct sock *sk)
1685{
Eric Dumazet58d607d2015-09-15 15:24:20 -07001686 sk->sk_txhash = net_tx_rndhash();
Tom Herbert877d1f62015-07-28 16:02:05 -07001687}
1688
Tom Herbert265f94f2015-07-28 16:02:06 -07001689static inline void sk_rethink_txhash(struct sock *sk)
1690{
1691 if (sk->sk_txhash)
1692 sk_set_txhash(sk);
1693}
1694
Linus Torvalds1da177e2005-04-16 15:20:36 -07001695static inline struct dst_entry *
1696__sk_dst_get(struct sock *sk)
1697{
Michal Hockod8bf4ca2011-07-08 14:39:41 +02001698 return rcu_dereference_check(sk->sk_dst_cache, sock_owned_by_user(sk) ||
Eric Dumazetf68c2242010-04-22 16:06:59 -07001699 lockdep_is_held(&sk->sk_lock.slock));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001700}
1701
1702static inline struct dst_entry *
1703sk_dst_get(struct sock *sk)
1704{
1705 struct dst_entry *dst;
1706
Eric Dumazetb6c67122010-04-08 23:03:29 +00001707 rcu_read_lock();
1708 dst = rcu_dereference(sk->sk_dst_cache);
Eric Dumazetf8864972014-06-24 10:05:11 -07001709 if (dst && !atomic_inc_not_zero(&dst->__refcnt))
1710 dst = NULL;
Eric Dumazetb6c67122010-04-08 23:03:29 +00001711 rcu_read_unlock();
Linus Torvalds1da177e2005-04-16 15:20:36 -07001712 return dst;
1713}
1714
Eric Dumazetb6c67122010-04-08 23:03:29 +00001715static inline void dst_negative_advice(struct sock *sk)
1716{
1717 struct dst_entry *ndst, *dst = __sk_dst_get(sk);
1718
Tom Herbert265f94f2015-07-28 16:02:06 -07001719 sk_rethink_txhash(sk);
1720
Eric Dumazetb6c67122010-04-08 23:03:29 +00001721 if (dst && dst->ops->negative_advice) {
1722 ndst = dst->ops->negative_advice(dst);
1723
1724 if (ndst != dst) {
1725 rcu_assign_pointer(sk->sk_dst_cache, ndst);
ZHAO Gang0a6957e2013-10-22 16:23:38 +08001726 sk_tx_queue_clear(sk);
Eric Dumazetb6c67122010-04-08 23:03:29 +00001727 }
1728 }
1729}
1730
Linus Torvalds1da177e2005-04-16 15:20:36 -07001731static inline void
1732__sk_dst_set(struct sock *sk, struct dst_entry *dst)
1733{
1734 struct dst_entry *old_dst;
1735
Krishna Kumare022f0b2009-10-19 23:46:20 +00001736 sk_tx_queue_clear(sk);
Eric Dumazet0b53ff22010-04-26 20:40:43 +00001737 /*
1738 * This can be called while sk is owned by the caller only,
1739 * with no state that can be checked in a rcu_dereference_check() cond
1740 */
1741 old_dst = rcu_dereference_raw(sk->sk_dst_cache);
Eric Dumazetb6c67122010-04-08 23:03:29 +00001742 rcu_assign_pointer(sk->sk_dst_cache, dst);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001743 dst_release(old_dst);
1744}
1745
1746static inline void
1747sk_dst_set(struct sock *sk, struct dst_entry *dst)
1748{
Eric Dumazet7f502362014-06-30 01:26:23 -07001749 struct dst_entry *old_dst;
1750
1751 sk_tx_queue_clear(sk);
Eric Dumazet5925a052014-07-02 02:39:38 -07001752 old_dst = xchg((__force struct dst_entry **)&sk->sk_dst_cache, dst);
Eric Dumazet7f502362014-06-30 01:26:23 -07001753 dst_release(old_dst);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001754}
1755
1756static inline void
1757__sk_dst_reset(struct sock *sk)
1758{
Eric Dumazetb6c67122010-04-08 23:03:29 +00001759 __sk_dst_set(sk, NULL);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001760}
1761
1762static inline void
1763sk_dst_reset(struct sock *sk)
1764{
Eric Dumazet7f502362014-06-30 01:26:23 -07001765 sk_dst_set(sk, NULL);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001766}
1767
Joe Perches69336bd2013-09-22 10:32:26 -07001768struct dst_entry *__sk_dst_check(struct sock *sk, u32 cookie);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001769
Joe Perches69336bd2013-09-22 10:32:26 -07001770struct dst_entry *sk_dst_check(struct sock *sk, u32 cookie);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001771
hannes@stressinduktion.orgf60e5992015-04-01 17:07:44 +02001772bool sk_mc_loop(struct sock *sk);
1773
Eric Dumazetdc6b9b72012-05-16 22:48:15 +00001774static inline bool sk_can_gso(const struct sock *sk)
Herbert Xubcd76112006-06-30 13:36:35 -07001775{
1776 return net_gso_ok(sk->sk_route_caps, sk->sk_gso_type);
1777}
1778
Joe Perches69336bd2013-09-22 10:32:26 -07001779void sk_setup_caps(struct sock *sk, struct dst_entry *dst);
Arnaldo Carvalho de Melo6cbb0df2005-08-09 19:49:02 -07001780
Michał Mirosławc8f44af2011-11-15 15:29:55 +00001781static inline void sk_nocaps_add(struct sock *sk, netdev_features_t flags)
Eric Dumazeta4654192010-05-16 00:36:33 -07001782{
1783 sk->sk_route_nocaps |= flags;
1784 sk->sk_route_caps &= ~flags;
1785}
1786
Tom Herbertc6e1a0d2011-04-04 22:30:30 -07001787static inline int skb_do_copy_data_nocache(struct sock *sk, struct sk_buff *skb,
Al Viro57be5bd2014-11-28 13:40:20 -05001788 struct iov_iter *from, char *to,
Wei Yongjun912d3982011-04-06 18:40:12 +00001789 int copy, int offset)
Tom Herbertc6e1a0d2011-04-04 22:30:30 -07001790{
1791 if (skb->ip_summed == CHECKSUM_NONE) {
Al Viro57be5bd2014-11-28 13:40:20 -05001792 __wsum csum = 0;
1793 if (csum_and_copy_from_iter(to, copy, &csum, from) != copy)
1794 return -EFAULT;
Wei Yongjun912d3982011-04-06 18:40:12 +00001795 skb->csum = csum_block_add(skb->csum, csum, offset);
Tom Herbertc6e1a0d2011-04-04 22:30:30 -07001796 } else if (sk->sk_route_caps & NETIF_F_NOCACHE_COPY) {
Al Viro57be5bd2014-11-28 13:40:20 -05001797 if (copy_from_iter_nocache(to, copy, from) != copy)
Tom Herbertc6e1a0d2011-04-04 22:30:30 -07001798 return -EFAULT;
Al Viro57be5bd2014-11-28 13:40:20 -05001799 } else if (copy_from_iter(to, copy, from) != copy)
Tom Herbertc6e1a0d2011-04-04 22:30:30 -07001800 return -EFAULT;
1801
1802 return 0;
1803}
1804
1805static inline int skb_add_data_nocache(struct sock *sk, struct sk_buff *skb,
Al Viro57be5bd2014-11-28 13:40:20 -05001806 struct iov_iter *from, int copy)
Tom Herbertc6e1a0d2011-04-04 22:30:30 -07001807{
Wei Yongjun912d3982011-04-06 18:40:12 +00001808 int err, offset = skb->len;
Tom Herbertc6e1a0d2011-04-04 22:30:30 -07001809
Wei Yongjun912d3982011-04-06 18:40:12 +00001810 err = skb_do_copy_data_nocache(sk, skb, from, skb_put(skb, copy),
1811 copy, offset);
Tom Herbertc6e1a0d2011-04-04 22:30:30 -07001812 if (err)
Wei Yongjun912d3982011-04-06 18:40:12 +00001813 __skb_trim(skb, offset);
Tom Herbertc6e1a0d2011-04-04 22:30:30 -07001814
1815 return err;
1816}
1817
Al Viro57be5bd2014-11-28 13:40:20 -05001818static inline int skb_copy_to_page_nocache(struct sock *sk, struct iov_iter *from,
Tom Herbertc6e1a0d2011-04-04 22:30:30 -07001819 struct sk_buff *skb,
1820 struct page *page,
1821 int off, int copy)
1822{
1823 int err;
1824
Wei Yongjun912d3982011-04-06 18:40:12 +00001825 err = skb_do_copy_data_nocache(sk, skb, from, page_address(page) + off,
1826 copy, skb->len);
Tom Herbertc6e1a0d2011-04-04 22:30:30 -07001827 if (err)
1828 return err;
1829
1830 skb->len += copy;
1831 skb->data_len += copy;
1832 skb->truesize += copy;
1833 sk->sk_wmem_queued += copy;
1834 sk_mem_charge(sk, copy);
1835 return 0;
1836}
1837
Eric Dumazetc5640392009-06-16 10:12:03 +00001838/**
1839 * sk_wmem_alloc_get - returns write allocations
1840 * @sk: socket
1841 *
1842 * Returns sk_wmem_alloc minus initial offset of one
1843 */
1844static inline int sk_wmem_alloc_get(const struct sock *sk)
1845{
1846 return atomic_read(&sk->sk_wmem_alloc) - 1;
1847}
1848
1849/**
1850 * sk_rmem_alloc_get - returns read allocations
1851 * @sk: socket
1852 *
1853 * Returns sk_rmem_alloc
1854 */
1855static inline int sk_rmem_alloc_get(const struct sock *sk)
1856{
1857 return atomic_read(&sk->sk_rmem_alloc);
1858}
1859
1860/**
1861 * sk_has_allocations - check if allocations are outstanding
1862 * @sk: socket
1863 *
1864 * Returns true if socket has write or read allocations
1865 */
Eric Dumazetdc6b9b72012-05-16 22:48:15 +00001866static inline bool sk_has_allocations(const struct sock *sk)
Eric Dumazetc5640392009-06-16 10:12:03 +00001867{
1868 return sk_wmem_alloc_get(sk) || sk_rmem_alloc_get(sk);
1869}
1870
Jiri Olsaa57de0b2009-07-08 12:09:13 +00001871/**
Eric Dumazet43815482010-04-29 11:01:49 +00001872 * wq_has_sleeper - check if there are any waiting processes
Randy Dunlapacfbe962010-05-24 23:54:18 -07001873 * @wq: struct socket_wq
Jiri Olsaa57de0b2009-07-08 12:09:13 +00001874 *
Eric Dumazet43815482010-04-29 11:01:49 +00001875 * Returns true if socket_wq has waiting processes
Jiri Olsaa57de0b2009-07-08 12:09:13 +00001876 *
Eric Dumazet43815482010-04-29 11:01:49 +00001877 * The purpose of the wq_has_sleeper and sock_poll_wait is to wrap the memory
Jiri Olsaa57de0b2009-07-08 12:09:13 +00001878 * barrier call. They were added due to the race found within the tcp code.
1879 *
1880 * Consider following tcp code paths:
1881 *
1882 * CPU1 CPU2
1883 *
1884 * sys_select receive packet
1885 * ... ...
1886 * __add_wait_queue update tp->rcv_nxt
1887 * ... ...
1888 * tp->rcv_nxt check sock_def_readable
1889 * ... {
Eric Dumazet43815482010-04-29 11:01:49 +00001890 * schedule rcu_read_lock();
1891 * wq = rcu_dereference(sk->sk_wq);
1892 * if (wq && waitqueue_active(&wq->wait))
1893 * wake_up_interruptible(&wq->wait)
Jiri Olsaa57de0b2009-07-08 12:09:13 +00001894 * ...
1895 * }
1896 *
1897 * The race for tcp fires when the __add_wait_queue changes done by CPU1 stay
1898 * in its cache, and so does the tp->rcv_nxt update on CPU2 side. The CPU1
1899 * could then endup calling schedule and sleep forever if there are no more
1900 * data on the socket.
Jiri Olsaad462762009-07-08 12:10:31 +00001901 *
Jiri Olsaa57de0b2009-07-08 12:09:13 +00001902 */
Eric Dumazet43815482010-04-29 11:01:49 +00001903static inline bool wq_has_sleeper(struct socket_wq *wq)
Jiri Olsaa57de0b2009-07-08 12:09:13 +00001904{
Eric Dumazetdc6b9b72012-05-16 22:48:15 +00001905 /* We need to be sure we are in sync with the
Jiri Olsaa57de0b2009-07-08 12:09:13 +00001906 * add_wait_queue modifications to the wait queue.
1907 *
1908 * This memory barrier is paired in the sock_poll_wait.
1909 */
Eric Dumazet43815482010-04-29 11:01:49 +00001910 smp_mb();
1911 return wq && waitqueue_active(&wq->wait);
Jiri Olsaa57de0b2009-07-08 12:09:13 +00001912}
1913
1914/**
1915 * sock_poll_wait - place memory barrier behind the poll_wait call.
1916 * @filp: file
1917 * @wait_address: socket wait queue
1918 * @p: poll_table
1919 *
Eric Dumazet43815482010-04-29 11:01:49 +00001920 * See the comments in the wq_has_sleeper function.
Jiri Olsaa57de0b2009-07-08 12:09:13 +00001921 */
1922static inline void sock_poll_wait(struct file *filp,
1923 wait_queue_head_t *wait_address, poll_table *p)
1924{
Hans Verkuil626cf232012-03-23 15:02:27 -07001925 if (!poll_does_not_wait(p) && wait_address) {
Jiri Olsaa57de0b2009-07-08 12:09:13 +00001926 poll_wait(filp, wait_address, p);
Eric Dumazetdc6b9b72012-05-16 22:48:15 +00001927 /* We need to be sure we are in sync with the
Jiri Olsaa57de0b2009-07-08 12:09:13 +00001928 * socket flags modification.
1929 *
Eric Dumazet43815482010-04-29 11:01:49 +00001930 * This memory barrier is paired in the wq_has_sleeper.
Eric Dumazetdc6b9b72012-05-16 22:48:15 +00001931 */
Jiri Olsaa57de0b2009-07-08 12:09:13 +00001932 smp_mb();
1933 }
1934}
1935
Tom Herbertb73c3d02014-07-01 21:32:17 -07001936static inline void skb_set_hash_from_sk(struct sk_buff *skb, struct sock *sk)
1937{
1938 if (sk->sk_txhash) {
1939 skb->l4_hash = 1;
1940 skb->hash = sk->sk_txhash;
1941 }
1942}
1943
Linus Torvalds1da177e2005-04-16 15:20:36 -07001944/*
Eric Dumazetdc6b9b72012-05-16 22:48:15 +00001945 * Queue a received datagram if it will fit. Stream and sequenced
Linus Torvalds1da177e2005-04-16 15:20:36 -07001946 * protocols can't normally use this as they need to fit buffers in
1947 * and play with them.
1948 *
Eric Dumazetdc6b9b72012-05-16 22:48:15 +00001949 * Inlined as it's very short and called for pretty much every
Linus Torvalds1da177e2005-04-16 15:20:36 -07001950 * packet ever received.
1951 */
1952
1953static inline void skb_set_owner_w(struct sk_buff *skb, struct sock *sk)
1954{
Herbert Xud55d87f2009-06-22 02:25:25 +00001955 skb_orphan(skb);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001956 skb->sk = sk;
1957 skb->destructor = sock_wfree;
Tom Herbertb73c3d02014-07-01 21:32:17 -07001958 skb_set_hash_from_sk(skb, sk);
Eric Dumazet2b85a342009-06-11 02:55:43 -07001959 /*
1960 * We used to take a refcount on sk, but following operation
1961 * is enough to guarantee sk_free() wont free this sock until
1962 * all in-flight packets are completed
1963 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001964 atomic_add(skb->truesize, &sk->sk_wmem_alloc);
1965}
1966
1967static inline void skb_set_owner_r(struct sk_buff *skb, struct sock *sk)
1968{
Herbert Xud55d87f2009-06-22 02:25:25 +00001969 skb_orphan(skb);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001970 skb->sk = sk;
1971 skb->destructor = sock_rfree;
1972 atomic_add(skb->truesize, &sk->sk_rmem_alloc);
Hideo Aoki3ab224b2007-12-31 00:11:19 -08001973 sk_mem_charge(sk, skb->truesize);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001974}
1975
Joe Perches69336bd2013-09-22 10:32:26 -07001976void sk_reset_timer(struct sock *sk, struct timer_list *timer,
1977 unsigned long expires);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001978
Joe Perches69336bd2013-09-22 10:32:26 -07001979void sk_stop_timer(struct sock *sk, struct timer_list *timer);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001980
Joe Perches69336bd2013-09-22 10:32:26 -07001981int sock_queue_rcv_skb(struct sock *sk, struct sk_buff *skb);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001982
Joe Perches69336bd2013-09-22 10:32:26 -07001983int sock_queue_err_skb(struct sock *sk, struct sk_buff *skb);
Willem de Bruijn364a9e92014-08-31 21:30:27 -04001984struct sk_buff *sock_dequeue_err_skb(struct sock *sk);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001985
1986/*
1987 * Recover an error report and clear atomically
1988 */
Eric Dumazetdc6b9b72012-05-16 22:48:15 +00001989
Linus Torvalds1da177e2005-04-16 15:20:36 -07001990static inline int sock_error(struct sock *sk)
1991{
Benjamin LaHaisec1cbe4b2005-12-13 23:22:19 -08001992 int err;
1993 if (likely(!sk->sk_err))
1994 return 0;
1995 err = xchg(&sk->sk_err, 0);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001996 return -err;
1997}
1998
1999static inline unsigned long sock_wspace(struct sock *sk)
2000{
2001 int amt = 0;
2002
2003 if (!(sk->sk_shutdown & SEND_SHUTDOWN)) {
2004 amt = sk->sk_sndbuf - atomic_read(&sk->sk_wmem_alloc);
Eric Dumazetdc6b9b72012-05-16 22:48:15 +00002005 if (amt < 0)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002006 amt = 0;
2007 }
2008 return amt;
2009}
2010
2011static inline void sk_wake_async(struct sock *sk, int how, int band)
2012{
Eric Dumazetbcdce712009-10-06 17:28:29 -07002013 if (sock_flag(sk, SOCK_FASYNC))
Linus Torvalds1da177e2005-04-16 15:20:36 -07002014 sock_wake_async(sk->sk_socket, how, band);
2015}
2016
Daniel Borkmanneea86af2013-06-19 12:51:20 +02002017/* Since sk_{r,w}mem_alloc sums skb->truesize, even a small frame might
2018 * need sizeof(sk_buff) + MTU + padding, unless net driver perform copybreak.
2019 * Note: for send buffers, TCP works better if we can build two skbs at
2020 * minimum.
Eric Dumazet7a91b4342010-09-26 18:53:07 -07002021 */
Eric Dumazet9eb5bf82013-07-03 05:02:22 -07002022#define TCP_SKB_MIN_TRUESIZE (2048 + SKB_DATA_ALIGN(sizeof(struct sk_buff)))
Daniel Borkmanneea86af2013-06-19 12:51:20 +02002023
2024#define SOCK_MIN_SNDBUF (TCP_SKB_MIN_TRUESIZE * 2)
2025#define SOCK_MIN_RCVBUF TCP_SKB_MIN_TRUESIZE
Linus Torvalds1da177e2005-04-16 15:20:36 -07002026
2027static inline void sk_stream_moderate_sndbuf(struct sock *sk)
2028{
2029 if (!(sk->sk_userlocks & SOCK_SNDBUF_LOCK)) {
Eric Dumazet8df09ea2007-12-21 03:07:41 -08002030 sk->sk_sndbuf = min(sk->sk_sndbuf, sk->sk_wmem_queued >> 1);
Daniel Borkmanneea86af2013-06-19 12:51:20 +02002031 sk->sk_sndbuf = max_t(u32, sk->sk_sndbuf, SOCK_MIN_SNDBUF);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002032 }
2033}
2034
Eric Dumazeteb934472015-05-19 13:26:55 -07002035struct sk_buff *sk_stream_alloc_skb(struct sock *sk, int size, gfp_t gfp,
2036 bool force_schedule);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002037
Eric Dumazet5640f762012-09-23 23:04:42 +00002038/**
2039 * sk_page_frag - return an appropriate page_frag
2040 * @sk: socket
2041 *
2042 * If socket allocation mode allows current thread to sleep, it means its
2043 * safe to use the per task page_frag instead of the per socket one.
2044 */
2045static inline struct page_frag *sk_page_frag(struct sock *sk)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002046{
Eric Dumazet5640f762012-09-23 23:04:42 +00002047 if (sk->sk_allocation & __GFP_WAIT)
2048 return &current->task_frag;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002049
Eric Dumazet5640f762012-09-23 23:04:42 +00002050 return &sk->sk_frag;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002051}
2052
Joe Perches69336bd2013-09-22 10:32:26 -07002053bool sk_page_frag_refill(struct sock *sk, struct page_frag *pfrag);
Eric Dumazet5640f762012-09-23 23:04:42 +00002054
Linus Torvalds1da177e2005-04-16 15:20:36 -07002055/*
2056 * Default write policy as shown to user space via poll/select/SIGIO
2057 */
Eric Dumazetdc6b9b72012-05-16 22:48:15 +00002058static inline bool sock_writeable(const struct sock *sk)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002059{
Eric Dumazet8df09ea2007-12-21 03:07:41 -08002060 return atomic_read(&sk->sk_wmem_alloc) < (sk->sk_sndbuf >> 1);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002061}
2062
Al Virodd0fc662005-10-07 07:46:04 +01002063static inline gfp_t gfp_any(void)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002064{
Andrew Morton99709372009-02-12 16:43:17 -08002065 return in_softirq() ? GFP_ATOMIC : GFP_KERNEL;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002066}
2067
Eric Dumazetdc6b9b72012-05-16 22:48:15 +00002068static inline long sock_rcvtimeo(const struct sock *sk, bool noblock)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002069{
2070 return noblock ? 0 : sk->sk_rcvtimeo;
2071}
2072
Eric Dumazetdc6b9b72012-05-16 22:48:15 +00002073static inline long sock_sndtimeo(const struct sock *sk, bool noblock)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002074{
2075 return noblock ? 0 : sk->sk_sndtimeo;
2076}
2077
2078static inline int sock_rcvlowat(const struct sock *sk, int waitall, int len)
2079{
2080 return (waitall ? len : min_t(int, sk->sk_rcvlowat, len)) ? : 1;
2081}
2082
2083/* Alas, with timeout socket operations are not restartable.
2084 * Compare this to poll().
2085 */
2086static inline int sock_intr_errno(long timeo)
2087{
2088 return timeo == MAX_SCHEDULE_TIMEOUT ? -ERESTARTSYS : -EINTR;
2089}
2090
Eyal Birger744d5a32015-03-01 14:58:31 +02002091struct sock_skb_cb {
2092 u32 dropcount;
2093};
2094
2095/* Store sock_skb_cb at the end of skb->cb[] so protocol families
2096 * using skb->cb[] would keep using it directly and utilize its
2097 * alignement guarantee.
2098 */
2099#define SOCK_SKB_CB_OFFSET ((FIELD_SIZEOF(struct sk_buff, cb) - \
2100 sizeof(struct sock_skb_cb)))
2101
2102#define SOCK_SKB_CB(__skb) ((struct sock_skb_cb *)((__skb)->cb + \
2103 SOCK_SKB_CB_OFFSET))
2104
Eyal Birgerb4772ef2015-03-01 14:58:29 +02002105#define sock_skb_cb_check_size(size) \
Eyal Birger744d5a32015-03-01 14:58:31 +02002106 BUILD_BUG_ON((size) > SOCK_SKB_CB_OFFSET)
Eyal Birgerb4772ef2015-03-01 14:58:29 +02002107
Eyal Birger3bc3b962015-03-01 14:58:30 +02002108static inline void
2109sock_skb_set_dropcount(const struct sock *sk, struct sk_buff *skb)
2110{
Eyal Birger744d5a32015-03-01 14:58:31 +02002111 SOCK_SKB_CB(skb)->dropcount = atomic_read(&sk->sk_drops);
Eyal Birger3bc3b962015-03-01 14:58:30 +02002112}
2113
Joe Perches69336bd2013-09-22 10:32:26 -07002114void __sock_recv_timestamp(struct msghdr *msg, struct sock *sk,
2115 struct sk_buff *skb);
2116void __sock_recv_wifi_status(struct msghdr *msg, struct sock *sk,
2117 struct sk_buff *skb);
Eric Dumazet92f37fd2007-03-25 22:14:49 -07002118
Eric Dumazetdc6b9b72012-05-16 22:48:15 +00002119static inline void
Linus Torvalds1da177e2005-04-16 15:20:36 -07002120sock_recv_timestamp(struct msghdr *msg, struct sock *sk, struct sk_buff *skb)
2121{
Eric Dumazetb7aa0bf2007-04-19 16:16:32 -07002122 ktime_t kt = skb->tstamp;
Patrick Ohly20d49472009-02-12 05:03:38 +00002123 struct skb_shared_hwtstamps *hwtstamps = skb_hwtstamps(skb);
Patrick McHardya61bbcf2005-08-14 17:24:31 -07002124
Patrick Ohly20d49472009-02-12 05:03:38 +00002125 /*
2126 * generate control messages if
Willem de Bruijnb9f40e22014-08-04 22:11:46 -04002127 * - receive time stamping in software requested
Patrick Ohly20d49472009-02-12 05:03:38 +00002128 * - software time stamp available and wanted
Patrick Ohly20d49472009-02-12 05:03:38 +00002129 * - hardware time stamps available and wanted
Patrick Ohly20d49472009-02-12 05:03:38 +00002130 */
2131 if (sock_flag(sk, SOCK_RCVTSTAMP) ||
Willem de Bruijnb9f40e22014-08-04 22:11:46 -04002132 (sk->sk_tsflags & SOF_TIMESTAMPING_RX_SOFTWARE) ||
Willem de Bruijnc1991052014-09-03 12:01:18 -04002133 (kt.tv64 && sk->sk_tsflags & SOF_TIMESTAMPING_SOFTWARE) ||
Patrick Ohly20d49472009-02-12 05:03:38 +00002134 (hwtstamps->hwtstamp.tv64 &&
Willem de Bruijnb9f40e22014-08-04 22:11:46 -04002135 (sk->sk_tsflags & SOF_TIMESTAMPING_RAW_HARDWARE)))
Eric Dumazet92f37fd2007-03-25 22:14:49 -07002136 __sock_recv_timestamp(msg, sk, skb);
2137 else
Eric Dumazetb7aa0bf2007-04-19 16:16:32 -07002138 sk->sk_stamp = kt;
Johannes Berg6e3e9392011-11-09 10:15:42 +01002139
2140 if (sock_flag(sk, SOCK_WIFI_STATUS) && skb->wifi_acked_valid)
2141 __sock_recv_wifi_status(msg, sk, skb);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002142}
2143
Joe Perches69336bd2013-09-22 10:32:26 -07002144void __sock_recv_ts_and_drops(struct msghdr *msg, struct sock *sk,
2145 struct sk_buff *skb);
Eric Dumazet767dd032010-04-28 19:14:43 +00002146
2147static inline void sock_recv_ts_and_drops(struct msghdr *msg, struct sock *sk,
2148 struct sk_buff *skb)
2149{
2150#define FLAGS_TS_OR_DROPS ((1UL << SOCK_RXQ_OVFL) | \
Willem de Bruijnb9f40e22014-08-04 22:11:46 -04002151 (1UL << SOCK_RCVTSTAMP))
2152#define TSFLAGS_ANY (SOF_TIMESTAMPING_SOFTWARE | \
2153 SOF_TIMESTAMPING_RAW_HARDWARE)
Eric Dumazet767dd032010-04-28 19:14:43 +00002154
Willem de Bruijnb9f40e22014-08-04 22:11:46 -04002155 if (sk->sk_flags & FLAGS_TS_OR_DROPS || sk->sk_tsflags & TSFLAGS_ANY)
Eric Dumazet767dd032010-04-28 19:14:43 +00002156 __sock_recv_ts_and_drops(msg, sk, skb);
2157 else
2158 sk->sk_stamp = skb->tstamp;
2159}
Neil Horman3b885782009-10-12 13:26:31 -07002160
Willem de Bruijn67cc0d42014-09-08 19:58:58 -04002161void __sock_tx_timestamp(const struct sock *sk, __u8 *tx_flags);
2162
Linus Torvalds1da177e2005-04-16 15:20:36 -07002163/**
Patrick Ohly20d49472009-02-12 05:03:38 +00002164 * sock_tx_timestamp - checks whether the outgoing packet is to be time stamped
Patrick Ohly20d49472009-02-12 05:03:38 +00002165 * @sk: socket sending this packet
Eric Dumazet140c55d2014-08-06 11:49:29 +02002166 * @tx_flags: completed with instructions for time stamping
2167 *
2168 * Note : callers should take care of initial *tx_flags value (usually 0)
Patrick Ohly20d49472009-02-12 05:03:38 +00002169 */
Willem de Bruijn67cc0d42014-09-08 19:58:58 -04002170static inline void sock_tx_timestamp(const struct sock *sk, __u8 *tx_flags)
2171{
2172 if (unlikely(sk->sk_tsflags))
2173 __sock_tx_timestamp(sk, tx_flags);
2174 if (unlikely(sock_flag(sk, SOCK_WIFI_STATUS)))
2175 *tx_flags |= SKBTX_WIFI_STATUS;
2176}
Patrick Ohly20d49472009-02-12 05:03:38 +00002177
2178/**
Linus Torvalds1da177e2005-04-16 15:20:36 -07002179 * sk_eat_skb - Release a skb if it is no longer needed
Pavel Pisa4dc3b162005-05-01 08:59:25 -07002180 * @sk: socket to eat this skb from
2181 * @skb: socket buffer to eat
Linus Torvalds1da177e2005-04-16 15:20:36 -07002182 *
2183 * This routine must be called with interrupts disabled or with the socket
2184 * locked so that the sk_buff queue operation is ok.
2185*/
Dan Williams7bced392013-12-30 12:37:29 -08002186static inline void sk_eat_skb(struct sock *sk, struct sk_buff *skb)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002187{
2188 __skb_unlink(skb, &sk->sk_receive_queue);
2189 __kfree_skb(skb);
2190}
2191
YOSHIFUJI Hideaki3b1e0a62008-03-26 02:26:21 +09002192static inline
2193struct net *sock_net(const struct sock *sk)
2194{
Eric Dumazetc2d9ba92010-06-01 06:51:19 +00002195 return read_pnet(&sk->sk_net);
YOSHIFUJI Hideaki3b1e0a62008-03-26 02:26:21 +09002196}
2197
2198static inline
Denis V. Lunevf5aa23f2008-03-26 00:48:17 -07002199void sock_net_set(struct sock *sk, struct net *net)
YOSHIFUJI Hideaki3b1e0a62008-03-26 02:26:21 +09002200{
Eric Dumazetc2d9ba92010-06-01 06:51:19 +00002201 write_pnet(&sk->sk_net, net);
YOSHIFUJI Hideaki3b1e0a62008-03-26 02:26:21 +09002202}
2203
KOVACS Krisztian23542612008-10-07 12:41:01 -07002204static inline struct sock *skb_steal_sock(struct sk_buff *skb)
2205{
Vijay Subramanianefc27f82012-06-24 13:03:07 +00002206 if (skb->sk) {
KOVACS Krisztian23542612008-10-07 12:41:01 -07002207 struct sock *sk = skb->sk;
2208
2209 skb->destructor = NULL;
2210 skb->sk = NULL;
2211 return sk;
2212 }
2213 return NULL;
2214}
2215
Eric Dumazet1d0ab252015-03-15 21:12:12 -07002216/* This helper checks if a socket is a full socket,
2217 * ie _not_ a timewait or request socket.
2218 */
2219static inline bool sk_fullsock(const struct sock *sk)
2220{
2221 return (1 << sk->sk_state) & ~(TCPF_TIME_WAIT | TCPF_NEW_SYN_RECV);
2222}
2223
Eric Dumazete446f9d2015-10-08 05:01:55 -07002224/* This helper checks if a socket is a LISTEN or NEW_SYN_RECV
2225 * SYNACK messages can be attached to either ones (depending on SYNCOOKIE)
2226 */
2227static inline bool sk_listener(const struct sock *sk)
2228{
2229 return (1 << sk->sk_state) & (TCPF_LISTEN | TCPF_NEW_SYN_RECV);
2230}
2231
Joe Perches69336bd2013-09-22 10:32:26 -07002232void sock_enable_timestamp(struct sock *sk, int flag);
2233int sock_get_timestamp(struct sock *, struct timeval __user *);
2234int sock_get_timestampns(struct sock *, struct timespec __user *);
2235int sock_recv_errqueue(struct sock *sk, struct msghdr *msg, int len, int level,
2236 int type);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002237
Eric W. Biedermana3b299d2014-04-23 14:26:56 -07002238bool sk_ns_capable(const struct sock *sk,
2239 struct user_namespace *user_ns, int cap);
2240bool sk_capable(const struct sock *sk, int cap);
2241bool sk_net_capable(const struct sock *sk, int cap);
2242
Linus Torvalds1da177e2005-04-16 15:20:36 -07002243extern __u32 sysctl_wmem_max;
2244extern __u32 sysctl_rmem_max;
2245
Willem de Bruijnb245be12015-01-30 13:29:32 -05002246extern int sysctl_tstamp_allow_data;
David S. Miller6baf1f42005-09-05 18:14:11 -07002247extern int sysctl_optmem_max;
2248
Arnaldo Carvalho de Melo20380732005-08-16 02:18:02 -03002249extern __u32 sysctl_wmem_default;
2250extern __u32 sysctl_rmem_default;
Arnaldo Carvalho de Melo20380732005-08-16 02:18:02 -03002251
Linus Torvalds1da177e2005-04-16 15:20:36 -07002252#endif /* _SOCK_H */