blob: 78c292f15ffc1c8764106c092833b4858113d920 [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>
Herbert Xu1ce0bf52015-11-26 13:55:39 +080061#include <linux/wait.h>
Tejun Heo2a56a1f2015-12-07 17:38:52 -050062#include <linux/cgroup-defs.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070063
64#include <linux/filter.h>
Eric Dumazet88ab1932008-11-16 19:39:21 -080065#include <linux/rculist_nulls.h>
Jiri Olsaa57de0b2009-07-08 12:09:13 +000066#include <linux/poll.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070067
Eric Dumazetc31504d2010-11-15 19:58:26 +000068#include <linux/atomic.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070069#include <net/dst.h>
70#include <net/checksum.h>
Eric Dumazet1d0ab252015-03-15 21:12:12 -070071#include <net/tcp_states.h>
Willem de Bruijnb9f40e22014-08-04 22:11:46 -040072#include <linux/net_tstamp.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070073
74/*
75 * This structure really needs to be cleaned up.
76 * Most of it is for TCP, and not used by any of
77 * the other protocols.
78 */
79
80/* Define this to get the SOCK_DBG debugging facility. */
81#define SOCK_DEBUGGING
82#ifdef SOCK_DEBUGGING
83#define SOCK_DEBUG(sk, msg...) do { if ((sk) && sock_flag((sk), SOCK_DBG)) \
84 printk(KERN_DEBUG msg); } while (0)
85#else
Stephen Hemminger4cd90292008-03-21 15:54:53 -070086/* Validate arguments and do nothing */
Joe Perchesb9075fa2011-10-31 17:11:33 -070087static inline __printf(2, 3)
Eric Dumazetdc6b9b72012-05-16 22:48:15 +000088void SOCK_DEBUG(const struct sock *sk, const char *msg, ...)
Stephen Hemminger4cd90292008-03-21 15:54:53 -070089{
90}
Linus Torvalds1da177e2005-04-16 15:20:36 -070091#endif
92
93/* This is the per-socket lock. The spinlock provides a synchronization
94 * between user contexts and software interrupt processing, whereas the
95 * mini-semaphore synchronizes multiple users amongst themselves.
96 */
Linus Torvalds1da177e2005-04-16 15:20:36 -070097typedef struct {
98 spinlock_t slock;
John Heffnerd2e91172007-09-12 10:44:19 +020099 int owned;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700100 wait_queue_head_t wq;
Ingo Molnara5b5bb92006-07-03 00:25:35 -0700101 /*
102 * We express the mutex-alike socket_lock semantics
103 * to the lock validator by explicitly managing
104 * the slock as a lock variant (in addition to
105 * the slock itself):
106 */
107#ifdef CONFIG_DEBUG_LOCK_ALLOC
108 struct lockdep_map dep_map;
109#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -0700110} socket_lock_t;
111
Linus Torvalds1da177e2005-04-16 15:20:36 -0700112struct sock;
Arnaldo Carvalho de Melo8feaf0c02005-08-09 20:09:30 -0700113struct proto;
Denis V. Lunev0eeb8ff2007-12-04 01:15:45 -0800114struct net;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700115
Eric Dumazet077b3932012-12-02 07:33:10 +0000116typedef __u32 __bitwise __portpair;
117typedef __u64 __bitwise __addrpair;
118
Linus Torvalds1da177e2005-04-16 15:20:36 -0700119/**
Pavel Pisa4dc3b162005-05-01 08:59:25 -0700120 * struct sock_common - minimal network layer representation of sockets
Eric Dumazet68835ab2010-11-30 19:04:07 +0000121 * @skc_daddr: Foreign IPv4 addr
122 * @skc_rcv_saddr: Bound local IPv4 addr
Eric Dumazet4dc6dc72009-07-15 23:13:10 +0000123 * @skc_hash: hash value used with various protocol lookup tables
Eric Dumazetd4cada42009-11-08 10:17:30 +0000124 * @skc_u16hashes: two u16 hash values used by UDP lookup tables
Eric Dumazetce43b032012-11-30 09:49:27 +0000125 * @skc_dport: placeholder for inet_dport/tw_dport
126 * @skc_num: placeholder for inet_num/tw_num
Pavel Pisa4dc3b162005-05-01 08:59:25 -0700127 * @skc_family: network address family
128 * @skc_state: Connection state
129 * @skc_reuse: %SO_REUSEADDR setting
Tom Herbert055dc212013-01-22 09:49:50 +0000130 * @skc_reuseport: %SO_REUSEPORT setting
Pavel Pisa4dc3b162005-05-01 08:59:25 -0700131 * @skc_bound_dev_if: bound device index if != 0
Pavel Pisa4dc3b162005-05-01 08:59:25 -0700132 * @skc_bind_node: bind hash linkage for various protocol lookup tables
Eric Dumazet512615b2009-11-08 10:17:58 +0000133 * @skc_portaddr_node: second hash linkage for UDP/UDP-Lite protocol
Arnaldo Carvalho de Melo8feaf0c02005-08-09 20:09:30 -0700134 * @skc_prot: protocol handlers inside a network family
Eric W. Biederman07feaeb2007-09-12 11:58:02 +0200135 * @skc_net: reference to the network namespace of this socket
Eric Dumazet68835ab2010-11-30 19:04:07 +0000136 * @skc_node: main hash linkage for various protocol lookup tables
137 * @skc_nulls_node: main hash linkage for TCP/UDP/UDP-Lite protocol
138 * @skc_tx_queue_mapping: tx queue number for this connection
Eric Dumazet8e5eb542015-10-08 19:33:22 -0700139 * @skc_flags: place holder for sk_flags
140 * %SO_LINGER (l_onoff), %SO_BROADCAST, %SO_KEEPALIVE,
141 * %SO_OOBINLINE settings, %SO_TIMESTAMPING settings
Eric Dumazet70da2682015-10-08 19:33:21 -0700142 * @skc_incoming_cpu: record/match cpu processing incoming packets
Eric Dumazet68835ab2010-11-30 19:04:07 +0000143 * @skc_refcnt: reference count
Pavel Pisa4dc3b162005-05-01 08:59:25 -0700144 *
145 * This is the minimal network layer representation of sockets, the header
Arnaldo Carvalho de Melo8feaf0c02005-08-09 20:09:30 -0700146 * for struct sock and struct inet_timewait_sock.
147 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700148struct sock_common {
Eric Dumazetce43b032012-11-30 09:49:27 +0000149 /* skc_daddr and skc_rcv_saddr must be grouped on a 8 bytes aligned
Eric Dumazet05dbc7b2013-10-03 00:22:02 -0700150 * address on 64bit arches : cf INET_MATCH()
Eric Dumazet4dc6dc72009-07-15 23:13:10 +0000151 */
Eric Dumazetce43b032012-11-30 09:49:27 +0000152 union {
Eric Dumazet077b3932012-12-02 07:33:10 +0000153 __addrpair skc_addrpair;
Eric Dumazetce43b032012-11-30 09:49:27 +0000154 struct {
155 __be32 skc_daddr;
156 __be32 skc_rcv_saddr;
157 };
158 };
Eric Dumazetd4cada42009-11-08 10:17:30 +0000159 union {
160 unsigned int skc_hash;
161 __u16 skc_u16hashes[2];
162 };
Eric Dumazetce43b032012-11-30 09:49:27 +0000163 /* skc_dport && skc_num must be grouped as well */
164 union {
Eric Dumazet077b3932012-12-02 07:33:10 +0000165 __portpair skc_portpair;
Eric Dumazetce43b032012-11-30 09:49:27 +0000166 struct {
167 __be16 skc_dport;
168 __u16 skc_num;
169 };
170 };
171
Eric Dumazet4dc6dc72009-07-15 23:13:10 +0000172 unsigned short skc_family;
173 volatile unsigned char skc_state;
Tom Herbert055dc212013-01-22 09:49:50 +0000174 unsigned char skc_reuse:4;
Eric Dumazet9fe516b2014-06-27 08:36:16 -0700175 unsigned char skc_reuseport:1;
176 unsigned char skc_ipv6only:1;
Eric W. Biederman26abe142015-05-08 21:10:31 -0500177 unsigned char skc_net_refcnt:1;
Eric Dumazet4dc6dc72009-07-15 23:13:10 +0000178 int skc_bound_dev_if;
Eric Dumazet512615b2009-11-08 10:17:58 +0000179 union {
180 struct hlist_node skc_bind_node;
Eric Dumazetca065d02016-04-01 08:52:13 -0700181 struct hlist_node skc_portaddr_node;
Eric Dumazet512615b2009-11-08 10:17:58 +0000182 };
Arnaldo Carvalho de Melo8feaf0c02005-08-09 20:09:30 -0700183 struct proto *skc_prot;
Eric W. Biederman0c5c9fb2015-03-11 23:06:44 -0500184 possible_net_t skc_net;
Eric Dumazetefe42082013-10-03 15:42:29 -0700185
186#if IS_ENABLED(CONFIG_IPV6)
187 struct in6_addr skc_v6_daddr;
188 struct in6_addr skc_v6_rcv_saddr;
189#endif
190
Eric Dumazet33cf7c92015-03-11 18:53:14 -0700191 atomic64_t skc_cookie;
192
Eric Dumazet8e5eb542015-10-08 19:33:22 -0700193 /* following fields are padding to force
194 * offset(struct sock, sk_refcnt) == 128 on 64bit arches
195 * assuming IPV6 is enabled. We use this padding differently
196 * for different kind of 'sockets'
197 */
198 union {
199 unsigned long skc_flags;
200 struct sock *skc_listener; /* request_sock */
201 struct inet_timewait_death_row *skc_tw_dr; /* inet_timewait_sock */
202 };
Eric Dumazet68835ab2010-11-30 19:04:07 +0000203 /*
204 * fields between dontcopy_begin/dontcopy_end
205 * are not copied in sock_copy()
206 */
Randy Dunlap928c41e2011-01-08 17:39:21 +0000207 /* private: */
Eric Dumazet68835ab2010-11-30 19:04:07 +0000208 int skc_dontcopy_begin[0];
Randy Dunlap928c41e2011-01-08 17:39:21 +0000209 /* public: */
Eric Dumazet68835ab2010-11-30 19:04:07 +0000210 union {
211 struct hlist_node skc_node;
212 struct hlist_nulls_node skc_nulls_node;
213 };
214 int skc_tx_queue_mapping;
Eric Dumazeted53d0a2015-10-08 19:33:23 -0700215 union {
216 int skc_incoming_cpu;
217 u32 skc_rcv_wnd;
Eric Dumazetd475f092015-10-08 19:33:24 -0700218 u32 skc_tw_rcv_nxt; /* struct tcp_timewait_sock */
Eric Dumazeted53d0a2015-10-08 19:33:23 -0700219 };
Eric Dumazet70da2682015-10-08 19:33:21 -0700220
Eric Dumazet68835ab2010-11-30 19:04:07 +0000221 atomic_t skc_refcnt;
Randy Dunlap928c41e2011-01-08 17:39:21 +0000222 /* private: */
Eric Dumazet68835ab2010-11-30 19:04:07 +0000223 int skc_dontcopy_end[0];
Eric Dumazeted53d0a2015-10-08 19:33:23 -0700224 union {
225 u32 skc_rxhash;
226 u32 skc_window_clamp;
Eric Dumazetd475f092015-10-08 19:33:24 -0700227 u32 skc_tw_snd_nxt; /* struct tcp_timewait_sock */
Eric Dumazeted53d0a2015-10-08 19:33:23 -0700228 };
Randy Dunlap928c41e2011-01-08 17:39:21 +0000229 /* public: */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700230};
231
232/**
233 * struct sock - network layer representation of sockets
Arnaldo Carvalho de Melo8feaf0c02005-08-09 20:09:30 -0700234 * @__sk_common: shared layout with inet_timewait_sock
Pavel Pisa4dc3b162005-05-01 08:59:25 -0700235 * @sk_shutdown: mask of %SEND_SHUTDOWN and/or %RCV_SHUTDOWN
236 * @sk_userlocks: %SO_SNDBUF and %SO_RCVBUF settings
237 * @sk_lock: synchronizer
238 * @sk_rcvbuf: size of receive buffer in bytes
Eric Dumazet43815482010-04-29 11:01:49 +0000239 * @sk_wq: sock wait queue and async head
Shawn Bohrer421b3882013-10-07 11:01:39 -0500240 * @sk_rx_dst: receive input route used by early demux
Pavel Pisa4dc3b162005-05-01 08:59:25 -0700241 * @sk_dst_cache: destination cache
Pavel Pisa4dc3b162005-05-01 08:59:25 -0700242 * @sk_policy: flow policy
Pavel Pisa4dc3b162005-05-01 08:59:25 -0700243 * @sk_receive_queue: incoming packets
244 * @sk_wmem_alloc: transmit queue bytes committed
245 * @sk_write_queue: Packet sending queue
246 * @sk_omem_alloc: "o" is "option" or "other"
247 * @sk_wmem_queued: persistent queue size
248 * @sk_forward_alloc: space allocated forward
Eliezer Tamir06021292013-06-10 11:39:50 +0300249 * @sk_napi_id: id of the last napi context to receive data for sk
Eliezer Tamirdafcc432013-06-14 16:33:57 +0300250 * @sk_ll_usec: usecs to busypoll when there is no data
Pavel Pisa4dc3b162005-05-01 08:59:25 -0700251 * @sk_allocation: allocation mode
Eric Dumazet95bd09e2013-08-27 05:46:32 -0700252 * @sk_pacing_rate: Pacing rate (if supported by transport/packet scheduler)
Eric Dumazetc3f40d72013-09-29 01:12:40 -0700253 * @sk_max_pacing_rate: Maximum pacing rate (%SO_MAX_PACING_RATE)
Pavel Pisa4dc3b162005-05-01 08:59:25 -0700254 * @sk_sndbuf: size of send buffer in bytes
Stephen Hemminger293de7d2016-10-23 09:28:29 -0700255 * @sk_padding: unused element for alignment
Tom Herbert28448b82014-05-23 08:47:19 -0700256 * @sk_no_check_tx: %SO_NO_CHECK setting, set checksum in TX packets
257 * @sk_no_check_rx: allow zero checksum in RX packets
Pavel Pisa4dc3b162005-05-01 08:59:25 -0700258 * @sk_route_caps: route capabilities (e.g. %NETIF_F_TSO)
Eric Dumazeta4654192010-05-16 00:36:33 -0700259 * @sk_route_nocaps: forbidden route capabilities (e.g NETIF_F_GSO_MASK)
Herbert Xubcd76112006-06-30 13:36:35 -0700260 * @sk_gso_type: GSO type (e.g. %SKB_GSO_TCPV4)
Peter P Waskiewicz Jr82cc1a72008-03-21 03:43:19 -0700261 * @sk_gso_max_size: Maximum GSO segment size to build
Ben Hutchings14853482012-07-30 16:11:42 +0000262 * @sk_gso_max_segs: Maximum number of GSO segments
Pavel Pisa4dc3b162005-05-01 08:59:25 -0700263 * @sk_lingertime: %SO_LINGER l_linger setting
Pavel Pisa4dc3b162005-05-01 08:59:25 -0700264 * @sk_backlog: always used with the per-socket spinlock held
265 * @sk_callback_lock: used with the callbacks in the end of this struct
266 * @sk_error_queue: rarely used
Wang Chen33c732c2007-11-13 20:30:01 -0800267 * @sk_prot_creator: sk_prot of original sock creator (see ipv6_setsockopt,
268 * IPV6_ADDRFORM for instance)
Pavel Pisa4dc3b162005-05-01 08:59:25 -0700269 * @sk_err: last error
Wang Chen33c732c2007-11-13 20:30:01 -0800270 * @sk_err_soft: errors that don't cause failure but are the cause of a
271 * persistent failure not just 'timed out'
Eric Dumazetcb61cb92008-06-17 21:04:56 -0700272 * @sk_drops: raw/udp drops counter
Pavel Pisa4dc3b162005-05-01 08:59:25 -0700273 * @sk_ack_backlog: current listen backlog
274 * @sk_max_ack_backlog: listen backlog set in listen()
275 * @sk_priority: %SO_PRIORITY setting
276 * @sk_type: socket type (%SOCK_STREAM, etc)
277 * @sk_protocol: which protocol this socket belongs in this network family
Randy Dunlap53c3fa22010-08-09 13:41:07 +0000278 * @sk_peer_pid: &struct pid for this socket's peer
279 * @sk_peer_cred: %SO_PEERCRED setting
Pavel Pisa4dc3b162005-05-01 08:59:25 -0700280 * @sk_rcvlowat: %SO_RCVLOWAT setting
281 * @sk_rcvtimeo: %SO_RCVTIMEO setting
282 * @sk_sndtimeo: %SO_SNDTIMEO setting
Tom Herbertb73c3d02014-07-01 21:32:17 -0700283 * @sk_txhash: computed flow hash for use on transmit
Pavel Pisa4dc3b162005-05-01 08:59:25 -0700284 * @sk_filter: socket filtering instructions
Pavel Pisa4dc3b162005-05-01 08:59:25 -0700285 * @sk_timer: sock cleanup timer
286 * @sk_stamp: time stamp of last packet received
Deepa Dinamani7abb7f72018-12-27 18:55:09 -0800287 * @sk_stamp_seq: lock for accessing sk_stamp on 32 bit architectures only
Willem de Bruijnb9f40e22014-08-04 22:11:46 -0400288 * @sk_tsflags: SO_TIMESTAMPING socket options
Willem de Bruijn09c2d252014-08-04 22:11:47 -0400289 * @sk_tskey: counter to disambiguate concurrent tstamp requests
Pavel Pisa4dc3b162005-05-01 08:59:25 -0700290 * @sk_socket: Identd and reporting IO signals
291 * @sk_user_data: RPC layer private data
Eric Dumazet5640f762012-09-23 23:04:42 +0000292 * @sk_frag: cached page frag
Randy Dunlapd3d4f0a2012-04-17 14:03:53 +0000293 * @sk_peek_off: current peek_offset value
Pavel Pisa4dc3b162005-05-01 08:59:25 -0700294 * @sk_send_head: front of stuff to transmit
Martin Waitz67be2dd2005-05-01 08:59:26 -0700295 * @sk_security: used by security modules
Randy Dunlap31729362008-02-18 20:52:13 -0800296 * @sk_mark: generic packet mark
Tejun Heo2a56a1f2015-12-07 17:38:52 -0500297 * @sk_cgrp_data: cgroup data for this cgroup
Johannes Weinerbaac50b2016-01-14 15:21:17 -0800298 * @sk_memcg: this socket's memory cgroup association
Pavel Pisa4dc3b162005-05-01 08:59:25 -0700299 * @sk_write_pending: a write to stream socket waits to start
300 * @sk_state_change: callback to indicate change in the state of the sock
301 * @sk_data_ready: callback to indicate there is data to be processed
302 * @sk_write_space: callback to indicate there is bf sending space available
303 * @sk_error_report: callback to indicate errors (e.g. %MSG_ERRQUEUE)
304 * @sk_backlog_rcv: callback to process the backlog
305 * @sk_destruct: called at sock freeing time, i.e. when all refcnt == 0
Craig Gallekef456142016-01-04 17:41:45 -0500306 * @sk_reuseport_cb: reuseport group container
Stephen Hemminger293de7d2016-10-23 09:28:29 -0700307 * @sk_rcu: used during RCU grace period
308 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700309struct sock {
310 /*
Arnaldo Carvalho de Melo8feaf0c02005-08-09 20:09:30 -0700311 * Now struct inet_timewait_sock also uses sock_common, so please just
Linus Torvalds1da177e2005-04-16 15:20:36 -0700312 * don't add nothing before this first member (__sk_common) --acme
313 */
314 struct sock_common __sk_common;
Eric Dumazet4dc6dc72009-07-15 23:13:10 +0000315#define sk_node __sk_common.skc_node
316#define sk_nulls_node __sk_common.skc_nulls_node
317#define sk_refcnt __sk_common.skc_refcnt
Krishna Kumare022f0b2009-10-19 23:46:20 +0000318#define sk_tx_queue_mapping __sk_common.skc_tx_queue_mapping
Eric Dumazet4dc6dc72009-07-15 23:13:10 +0000319
Eric Dumazet68835ab2010-11-30 19:04:07 +0000320#define sk_dontcopy_begin __sk_common.skc_dontcopy_begin
321#define sk_dontcopy_end __sk_common.skc_dontcopy_end
Eric Dumazet4dc6dc72009-07-15 23:13:10 +0000322#define sk_hash __sk_common.skc_hash
Eric Dumazet50805462013-10-02 04:29:50 -0700323#define sk_portpair __sk_common.skc_portpair
Eric Dumazet05dbc7b2013-10-03 00:22:02 -0700324#define sk_num __sk_common.skc_num
325#define sk_dport __sk_common.skc_dport
Eric Dumazet50805462013-10-02 04:29:50 -0700326#define sk_addrpair __sk_common.skc_addrpair
327#define sk_daddr __sk_common.skc_daddr
328#define sk_rcv_saddr __sk_common.skc_rcv_saddr
Linus Torvalds1da177e2005-04-16 15:20:36 -0700329#define sk_family __sk_common.skc_family
330#define sk_state __sk_common.skc_state
331#define sk_reuse __sk_common.skc_reuse
Tom Herbert055dc212013-01-22 09:49:50 +0000332#define sk_reuseport __sk_common.skc_reuseport
Eric Dumazet9fe516b2014-06-27 08:36:16 -0700333#define sk_ipv6only __sk_common.skc_ipv6only
Eric W. Biederman26abe142015-05-08 21:10:31 -0500334#define sk_net_refcnt __sk_common.skc_net_refcnt
Linus Torvalds1da177e2005-04-16 15:20:36 -0700335#define sk_bound_dev_if __sk_common.skc_bound_dev_if
Linus Torvalds1da177e2005-04-16 15:20:36 -0700336#define sk_bind_node __sk_common.skc_bind_node
Arnaldo Carvalho de Melo8feaf0c02005-08-09 20:09:30 -0700337#define sk_prot __sk_common.skc_prot
Eric W. Biederman07feaeb2007-09-12 11:58:02 +0200338#define sk_net __sk_common.skc_net
Eric Dumazetefe42082013-10-03 15:42:29 -0700339#define sk_v6_daddr __sk_common.skc_v6_daddr
340#define sk_v6_rcv_saddr __sk_common.skc_v6_rcv_saddr
Eric Dumazet33cf7c92015-03-11 18:53:14 -0700341#define sk_cookie __sk_common.skc_cookie
Eric Dumazet70da2682015-10-08 19:33:21 -0700342#define sk_incoming_cpu __sk_common.skc_incoming_cpu
Eric Dumazet8e5eb542015-10-08 19:33:22 -0700343#define sk_flags __sk_common.skc_flags
Eric Dumazeted53d0a2015-10-08 19:33:23 -0700344#define sk_rxhash __sk_common.skc_rxhash
Eric Dumazetefe42082013-10-03 15:42:29 -0700345
Eric Dumazetb178bb32010-11-16 05:56:04 +0000346 socket_lock_t sk_lock;
347 struct sk_buff_head sk_receive_queue;
348 /*
349 * The backlog queue is special, it is always used with
350 * the per-socket spinlock held and requires low latency
351 * access. Therefore we special case it's implementation.
352 * Note : rmem_alloc is in this structure to fill a hole
353 * on 64bit arches, not because its logically part of
354 * backlog.
355 */
356 struct {
357 atomic_t rmem_alloc;
358 int len;
359 struct sk_buff *head;
360 struct sk_buff *tail;
361 } sk_backlog;
362#define sk_rmem_alloc sk_backlog.rmem_alloc
363 int sk_forward_alloc;
Eric Dumazet2c8c56e2014-11-11 05:54:28 -0800364
Tom Herbertb73c3d02014-07-01 21:32:17 -0700365 __u32 sk_txhash;
Cong Wange0d10952013-08-01 11:10:25 +0800366#ifdef CONFIG_NET_RX_BUSY_POLL
Eliezer Tamir06021292013-06-10 11:39:50 +0300367 unsigned int sk_napi_id;
Eliezer Tamirdafcc432013-06-14 16:33:57 +0300368 unsigned int sk_ll_usec;
Eliezer Tamir06021292013-06-10 11:39:50 +0300369#endif
Eric Dumazetb178bb32010-11-16 05:56:04 +0000370 atomic_t sk_drops;
371 int sk_rcvbuf;
372
373 struct sk_filter __rcu *sk_filter;
Eric Dumazetceb5d582015-11-29 20:03:11 -0800374 union {
375 struct socket_wq __rcu *sk_wq;
376 struct socket_wq *sk_wq_raw;
377 };
Eric Dumazetb178bb32010-11-16 05:56:04 +0000378#ifdef CONFIG_XFRM
Eric Dumazetd188ba82015-12-08 07:22:02 -0800379 struct xfrm_policy __rcu *sk_policy[2];
Eric Dumazetb178bb32010-11-16 05:56:04 +0000380#endif
Eric Dumazetdeaa5852012-06-24 20:22:49 +0000381 struct dst_entry *sk_rx_dst;
Cong Wang0e36cbb2013-01-22 21:09:51 +0000382 struct dst_entry __rcu *sk_dst_cache;
Eric Dumazet6bd4f352015-12-02 21:53:57 -0800383 /* Note: 32bit hole on 64bit arches */
Eric Dumazetb178bb32010-11-16 05:56:04 +0000384 atomic_t sk_wmem_alloc;
385 atomic_t sk_omem_alloc;
386 int sk_sndbuf;
387 struct sk_buff_head sk_write_queue;
Andrey Ryabininfc648692016-05-18 19:19:27 +0300388
389 /*
390 * Because of non atomicity rules, all
391 * changes are protected by socket lock.
392 */
Vegard Nossuma98b65a2009-02-26 14:46:57 +0100393 kmemcheck_bitfield_begin(flags);
Andrey Ryabininfc648692016-05-18 19:19:27 +0300394 unsigned int sk_padding : 2,
Tom Herbert28448b82014-05-23 08:47:19 -0700395 sk_no_check_tx : 1,
396 sk_no_check_rx : 1,
Eric Dumazet5fdb9972009-10-08 22:50:25 +0000397 sk_userlocks : 4,
398 sk_protocol : 8,
399 sk_type : 16;
Hannes Frederic Sowa7bbadd22015-12-14 23:30:43 +0100400#define SK_PROTOCOL_MAX U8_MAX
Vegard Nossuma98b65a2009-02-26 14:46:57 +0100401 kmemcheck_bitfield_end(flags);
Andrey Ryabininfc648692016-05-18 19:19:27 +0300402
Linus Torvalds1da177e2005-04-16 15:20:36 -0700403 int sk_wmem_queued;
Al Viro7d877f32005-10-21 03:20:43 -0400404 gfp_t sk_allocation;
Eric Dumazet95bd09e2013-08-27 05:46:32 -0700405 u32 sk_pacing_rate; /* bytes per second */
Eric Dumazet62748f32013-09-24 08:20:52 -0700406 u32 sk_max_pacing_rate;
Michał Mirosławc8f44af2011-11-15 15:29:55 +0000407 netdev_features_t sk_route_caps;
408 netdev_features_t sk_route_nocaps;
Herbert Xubcd76112006-06-30 13:36:35 -0700409 int sk_gso_type;
Peter P Waskiewicz Jr82cc1a72008-03-21 03:43:19 -0700410 unsigned int sk_gso_max_size;
Ben Hutchings14853482012-07-30 16:11:42 +0000411 u16 sk_gso_max_segs;
David S. Miller9932cf92006-03-24 15:12:37 -0800412 int sk_rcvlowat;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700413 unsigned long sk_lingertime;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700414 struct sk_buff_head sk_error_queue;
Arnaldo Carvalho de Melo476e19c2005-05-05 13:35:15 -0700415 struct proto *sk_prot_creator;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700416 rwlock_t sk_callback_lock;
417 int sk_err,
418 sk_err_soft;
Eric Dumazetbecb74f2015-03-19 19:04:21 -0700419 u32 sk_ack_backlog;
420 u32 sk_max_ack_backlog;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700421 __u32 sk_priority;
Tejun Heo297dbde2015-12-07 17:38:51 -0500422 __u32 sk_mark;
Eric Dumazet09818f62021-09-29 15:57:50 -0700423 spinlock_t sk_peer_lock;
Eric W. Biederman109f6e32010-06-13 03:30:14 +0000424 struct pid *sk_peer_pid;
425 const struct cred *sk_peer_cred;
Eric Dumazet09818f62021-09-29 15:57:50 -0700426
Linus Torvalds1da177e2005-04-16 15:20:36 -0700427 long sk_rcvtimeo;
428 long sk_sndtimeo;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700429 struct timer_list sk_timer;
Eric Dumazetb7aa0bf2007-04-19 16:16:32 -0700430 ktime_t sk_stamp;
Deepa Dinamani7abb7f72018-12-27 18:55:09 -0800431#if BITS_PER_LONG==32
432 seqlock_t sk_stamp_seq;
433#endif
Willem de Bruijnb9f40e22014-08-04 22:11:46 -0400434 u16 sk_tsflags;
Andrey Ryabininfc648692016-05-18 19:19:27 +0300435 u8 sk_shutdown;
Willem de Bruijn09c2d252014-08-04 22:11:47 -0400436 u32 sk_tskey;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700437 struct socket *sk_socket;
438 void *sk_user_data;
Eric Dumazet5640f762012-09-23 23:04:42 +0000439 struct page_frag sk_frag;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700440 struct sk_buff *sk_send_head;
Pavel Emelyanovef64a542012-02-21 07:31:34 +0000441 __s32 sk_peek_off;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700442 int sk_write_pending;
Alexey Dobriyand5f64232008-11-04 14:45:58 -0800443#ifdef CONFIG_SECURITY
Linus Torvalds1da177e2005-04-16 15:20:36 -0700444 void *sk_security;
Alexey Dobriyand5f64232008-11-04 14:45:58 -0800445#endif
Tejun Heo2a56a1f2015-12-07 17:38:52 -0500446 struct sock_cgroup_data sk_cgrp_data;
Johannes Weinerbaac50b2016-01-14 15:21:17 -0800447 struct mem_cgroup *sk_memcg;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700448 void (*sk_state_change)(struct sock *sk);
David S. Miller676d2362014-04-11 16:15:36 -0400449 void (*sk_data_ready)(struct sock *sk);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700450 void (*sk_write_space)(struct sock *sk);
451 void (*sk_error_report)(struct sock *sk);
Eric Dumazetdc6b9b72012-05-16 22:48:15 +0000452 int (*sk_backlog_rcv)(struct sock *sk,
453 struct sk_buff *skb);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700454 void (*sk_destruct)(struct sock *sk);
Craig Gallekef456142016-01-04 17:41:45 -0500455 struct sock_reuseport __rcu *sk_reuseport_cb;
Eric Dumazeta4298e42016-04-01 08:52:12 -0700456 struct rcu_head sk_rcu;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700457};
458
Pravin B Shelar559835ea2013-09-24 10:25:40 -0700459#define __sk_user_data(sk) ((*((void __rcu **)&(sk)->sk_user_data)))
460
461#define rcu_dereference_sk_user_data(sk) rcu_dereference(__sk_user_data((sk)))
462#define rcu_assign_sk_user_data(sk, ptr) rcu_assign_pointer(__sk_user_data((sk)), ptr)
463
Pavel Emelyanov4a17fd52012-04-19 03:39:36 +0000464/*
465 * SK_CAN_REUSE and SK_NO_REUSE on a socket mean that the socket is OK
466 * or not whether his port will be reused by someone else. SK_FORCE_REUSE
467 * on a socket means that the socket will reuse everybody else's port
468 * without looking at the other's sk_reuse value.
469 */
470
471#define SK_NO_REUSE 0
472#define SK_CAN_REUSE 1
473#define SK_FORCE_REUSE 2
474
samanthakumar627d2d62016-04-05 12:41:16 -0400475int sk_set_peek_off(struct sock *sk, int val);
476
Pavel Emelyanovef64a542012-02-21 07:31:34 +0000477static inline int sk_peek_offset(struct sock *sk, int flags)
478{
Willem de Bruijnb9bb53f2016-04-05 12:41:14 -0400479 if (unlikely(flags & MSG_PEEK)) {
480 s32 off = READ_ONCE(sk->sk_peek_off);
481 if (off >= 0)
482 return off;
483 }
484
485 return 0;
Pavel Emelyanovef64a542012-02-21 07:31:34 +0000486}
487
488static inline void sk_peek_offset_bwd(struct sock *sk, int val)
489{
Willem de Bruijnb9bb53f2016-04-05 12:41:14 -0400490 s32 off = READ_ONCE(sk->sk_peek_off);
491
492 if (unlikely(off >= 0)) {
493 off = max_t(s32, off - val, 0);
494 WRITE_ONCE(sk->sk_peek_off, off);
Pavel Emelyanovef64a542012-02-21 07:31:34 +0000495 }
496}
497
498static inline void sk_peek_offset_fwd(struct sock *sk, int val)
499{
Willem de Bruijnb9bb53f2016-04-05 12:41:14 -0400500 sk_peek_offset_bwd(sk, -val);
Pavel Emelyanovef64a542012-02-21 07:31:34 +0000501}
502
Linus Torvalds1da177e2005-04-16 15:20:36 -0700503/*
504 * Hashed lists helper routines
505 */
Li Zefanc4146642010-02-08 23:18:45 +0000506static inline struct sock *sk_entry(const struct hlist_node *node)
507{
508 return hlist_entry(node, 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_entry(head->first, struct sock, sk_node);
514}
515
Arnaldo Carvalho de Meloe48c4142005-08-09 20:09:46 -0700516static inline struct sock *sk_head(const struct hlist_head *head)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700517{
518 return hlist_empty(head) ? NULL : __sk_head(head);
519}
520
Eric Dumazet88ab1932008-11-16 19:39:21 -0800521static inline struct sock *__sk_nulls_head(const struct hlist_nulls_head *head)
522{
523 return hlist_nulls_entry(head->first, struct sock, sk_nulls_node);
524}
525
526static inline struct sock *sk_nulls_head(const struct hlist_nulls_head *head)
527{
528 return hlist_nulls_empty(head) ? NULL : __sk_nulls_head(head);
529}
530
Arnaldo Carvalho de Meloe48c4142005-08-09 20:09:46 -0700531static inline struct sock *sk_next(const struct sock *sk)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700532{
533 return sk->sk_node.next ?
534 hlist_entry(sk->sk_node.next, struct sock, sk_node) : NULL;
535}
536
Eric Dumazet88ab1932008-11-16 19:39:21 -0800537static inline struct sock *sk_nulls_next(const struct sock *sk)
538{
539 return (!is_a_nulls(sk->sk_nulls_node.next)) ?
540 hlist_nulls_entry(sk->sk_nulls_node.next,
541 struct sock, sk_nulls_node) :
542 NULL;
543}
544
Eric Dumazetdc6b9b72012-05-16 22:48:15 +0000545static inline bool sk_unhashed(const struct sock *sk)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700546{
547 return hlist_unhashed(&sk->sk_node);
548}
549
Eric Dumazetdc6b9b72012-05-16 22:48:15 +0000550static inline bool sk_hashed(const struct sock *sk)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700551{
Akinobu Mitada753be2006-04-28 15:21:23 -0700552 return !sk_unhashed(sk);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700553}
554
Eric Dumazetdc6b9b72012-05-16 22:48:15 +0000555static inline void sk_node_init(struct hlist_node *node)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700556{
557 node->pprev = NULL;
558}
559
Eric Dumazetdc6b9b72012-05-16 22:48:15 +0000560static inline void sk_nulls_node_init(struct hlist_nulls_node *node)
Eric Dumazet88ab1932008-11-16 19:39:21 -0800561{
562 node->pprev = NULL;
563}
564
Eric Dumazetdc6b9b72012-05-16 22:48:15 +0000565static inline void __sk_del_node(struct sock *sk)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700566{
567 __hlist_del(&sk->sk_node);
568}
569
stephen hemminger808f5112010-02-22 07:57:18 +0000570/* NB: equivalent to hlist_del_init_rcu */
Eric Dumazetdc6b9b72012-05-16 22:48:15 +0000571static inline bool __sk_del_node_init(struct sock *sk)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700572{
573 if (sk_hashed(sk)) {
574 __sk_del_node(sk);
575 sk_node_init(&sk->sk_node);
Eric Dumazetdc6b9b72012-05-16 22:48:15 +0000576 return true;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700577 }
Eric Dumazetdc6b9b72012-05-16 22:48:15 +0000578 return false;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700579}
580
581/* Grab socket reference count. This operation is valid only
582 when sk is ALREADY grabbed f.e. it is found in hash table
583 or a list and the lookup is made under lock preventing hash table
584 modifications.
585 */
586
Denys Vlasenkof9a7cbb2016-04-08 17:51:54 +0200587static __always_inline void sock_hold(struct sock *sk)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700588{
589 atomic_inc(&sk->sk_refcnt);
590}
591
592/* Ungrab socket in the context, which assumes that socket refcnt
593 cannot hit zero, f.e. it is true in context of any socketcall.
594 */
Denys Vlasenkof9a7cbb2016-04-08 17:51:54 +0200595static __always_inline void __sock_put(struct sock *sk)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700596{
597 atomic_dec(&sk->sk_refcnt);
598}
599
Eric Dumazetdc6b9b72012-05-16 22:48:15 +0000600static inline bool sk_del_node_init(struct sock *sk)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700601{
Eric Dumazetdc6b9b72012-05-16 22:48:15 +0000602 bool rc = __sk_del_node_init(sk);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700603
604 if (rc) {
605 /* paranoid for a while -acme */
606 WARN_ON(atomic_read(&sk->sk_refcnt) == 1);
607 __sock_put(sk);
608 }
609 return rc;
610}
stephen hemminger808f5112010-02-22 07:57:18 +0000611#define sk_del_node_init_rcu(sk) sk_del_node_init(sk)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700612
Eric Dumazetdc6b9b72012-05-16 22:48:15 +0000613static inline bool __sk_nulls_del_node_init_rcu(struct sock *sk)
Eric Dumazet271b72c2008-10-29 02:11:14 -0700614{
615 if (sk_hashed(sk)) {
Eric Dumazet88ab1932008-11-16 19:39:21 -0800616 hlist_nulls_del_init_rcu(&sk->sk_nulls_node);
Eric Dumazetdc6b9b72012-05-16 22:48:15 +0000617 return true;
Eric Dumazet271b72c2008-10-29 02:11:14 -0700618 }
Eric Dumazetdc6b9b72012-05-16 22:48:15 +0000619 return false;
Eric Dumazet271b72c2008-10-29 02:11:14 -0700620}
621
Eric Dumazetdc6b9b72012-05-16 22:48:15 +0000622static inline bool sk_nulls_del_node_init_rcu(struct sock *sk)
Eric Dumazet271b72c2008-10-29 02:11:14 -0700623{
Eric Dumazetdc6b9b72012-05-16 22:48:15 +0000624 bool rc = __sk_nulls_del_node_init_rcu(sk);
Eric Dumazet271b72c2008-10-29 02:11:14 -0700625
626 if (rc) {
627 /* paranoid for a while -acme */
628 WARN_ON(atomic_read(&sk->sk_refcnt) == 1);
629 __sock_put(sk);
630 }
631 return rc;
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 hlist_add_head(&sk->sk_node, list);
637}
638
Eric Dumazetdc6b9b72012-05-16 22:48:15 +0000639static inline void sk_add_node(struct sock *sk, struct hlist_head *list)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700640{
641 sock_hold(sk);
642 __sk_add_node(sk, list);
643}
644
Eric Dumazetdc6b9b72012-05-16 22:48:15 +0000645static inline void sk_add_node_rcu(struct sock *sk, struct hlist_head *list)
stephen hemminger808f5112010-02-22 07:57:18 +0000646{
647 sock_hold(sk);
Craig Gallekd296ba62016-04-25 10:42:12 -0400648 if (IS_ENABLED(CONFIG_IPV6) && sk->sk_reuseport &&
649 sk->sk_family == AF_INET6)
650 hlist_add_tail_rcu(&sk->sk_node, list);
651 else
652 hlist_add_head_rcu(&sk->sk_node, list);
stephen hemminger808f5112010-02-22 07:57:18 +0000653}
654
Maxime Chevallier936a9182019-03-16 14:41:30 +0100655static inline void sk_add_node_tail_rcu(struct sock *sk, struct hlist_head *list)
656{
657 sock_hold(sk);
658 hlist_add_tail_rcu(&sk->sk_node, list);
659}
660
Eric Dumazetdc6b9b72012-05-16 22:48:15 +0000661static inline void __sk_nulls_add_node_rcu(struct sock *sk, struct hlist_nulls_head *list)
Eric Dumazet271b72c2008-10-29 02:11:14 -0700662{
Eric Dumazet564fe3e2017-12-05 12:45:56 -0800663 hlist_nulls_add_head_rcu(&sk->sk_nulls_node, list);
Eric Dumazet271b72c2008-10-29 02:11:14 -0700664}
665
Eric Dumazet792365b2019-12-13 18:20:41 -0800666static inline void __sk_nulls_add_node_tail_rcu(struct sock *sk, struct hlist_nulls_head *list)
667{
668 hlist_nulls_add_tail_rcu(&sk->sk_nulls_node, list);
669}
670
Eric Dumazetdc6b9b72012-05-16 22:48:15 +0000671static inline void sk_nulls_add_node_rcu(struct sock *sk, struct hlist_nulls_head *list)
Eric Dumazet271b72c2008-10-29 02:11:14 -0700672{
673 sock_hold(sk);
Eric Dumazet88ab1932008-11-16 19:39:21 -0800674 __sk_nulls_add_node_rcu(sk, list);
Eric Dumazet271b72c2008-10-29 02:11:14 -0700675}
676
Eric Dumazetdc6b9b72012-05-16 22:48:15 +0000677static inline void __sk_del_bind_node(struct sock *sk)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700678{
679 __hlist_del(&sk->sk_bind_node);
680}
681
Eric Dumazetdc6b9b72012-05-16 22:48:15 +0000682static inline void sk_add_bind_node(struct sock *sk,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700683 struct hlist_head *list)
684{
685 hlist_add_head(&sk->sk_bind_node, list);
686}
687
Sasha Levinb67bfe02013-02-27 17:06:00 -0800688#define sk_for_each(__sk, list) \
689 hlist_for_each_entry(__sk, list, sk_node)
690#define sk_for_each_rcu(__sk, list) \
691 hlist_for_each_entry_rcu(__sk, list, sk_node)
Eric Dumazet88ab1932008-11-16 19:39:21 -0800692#define sk_nulls_for_each(__sk, node, list) \
693 hlist_nulls_for_each_entry(__sk, node, list, sk_nulls_node)
694#define sk_nulls_for_each_rcu(__sk, node, list) \
695 hlist_nulls_for_each_entry_rcu(__sk, node, list, sk_nulls_node)
Sasha Levinb67bfe02013-02-27 17:06:00 -0800696#define sk_for_each_from(__sk) \
697 hlist_for_each_entry_from(__sk, sk_node)
Eric Dumazet88ab1932008-11-16 19:39:21 -0800698#define sk_nulls_for_each_from(__sk, node) \
699 if (__sk && ({ node = &(__sk)->sk_nulls_node; 1; })) \
700 hlist_nulls_for_each_entry_from(__sk, node, sk_nulls_node)
Sasha Levinb67bfe02013-02-27 17:06:00 -0800701#define sk_for_each_safe(__sk, tmp, list) \
702 hlist_for_each_entry_safe(__sk, tmp, list, sk_node)
703#define sk_for_each_bound(__sk, list) \
704 hlist_for_each_entry(__sk, list, sk_bind_node)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700705
David Held2dc41cf2014-07-15 23:28:32 -0400706/**
Eric Dumazetca065d02016-04-01 08:52:13 -0700707 * sk_for_each_entry_offset_rcu - iterate over a list at a given struct offset
David Held2dc41cf2014-07-15 23:28:32 -0400708 * @tpos: the type * to use as a loop cursor.
709 * @pos: the &struct hlist_node to use as a loop cursor.
710 * @head: the head for your list.
711 * @offset: offset of hlist_node within the struct.
712 *
713 */
Eric Dumazetca065d02016-04-01 08:52:13 -0700714#define sk_for_each_entry_offset_rcu(tpos, pos, head, offset) \
715 for (pos = rcu_dereference((head)->first); \
716 pos != NULL && \
David Held2dc41cf2014-07-15 23:28:32 -0400717 ({ tpos = (typeof(*tpos) *)((void *)pos - offset); 1;}); \
Eric Dumazetca065d02016-04-01 08:52:13 -0700718 pos = rcu_dereference(pos->next))
David Held2dc41cf2014-07-15 23:28:32 -0400719
Eric W. Biedermanc336d142012-05-24 17:56:43 -0600720static inline struct user_namespace *sk_user_ns(struct sock *sk)
721{
722 /* Careful only use this in a context where these parameters
723 * can not change and must all be valid, such as recvmsg from
724 * userspace.
725 */
726 return sk->sk_socket->file->f_cred->user_ns;
727}
728
Linus Torvalds1da177e2005-04-16 15:20:36 -0700729/* Sock flags */
730enum sock_flags {
731 SOCK_DEAD,
732 SOCK_DONE,
733 SOCK_URGINLINE,
734 SOCK_KEEPOPEN,
735 SOCK_LINGER,
736 SOCK_DESTROY,
737 SOCK_BROADCAST,
738 SOCK_TIMESTAMP,
739 SOCK_ZAPPED,
740 SOCK_USE_WRITE_QUEUE, /* whether to call sk->sk_write_space in sock_wfree */
741 SOCK_DBG, /* %SO_DEBUG setting */
742 SOCK_RCVTSTAMP, /* %SO_TIMESTAMP setting */
Eric Dumazet92f37fd2007-03-25 22:14:49 -0700743 SOCK_RCVTSTAMPNS, /* %SO_TIMESTAMPNS setting */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700744 SOCK_LOCALROUTE, /* route locally only, %SO_DONTROUTE setting */
745 SOCK_QUEUE_SHRUNK, /* write queue has been shrunk recently */
Mel Gorman7cb02402012-07-31 16:44:16 -0700746 SOCK_MEMALLOC, /* VM depends on this socket for swapping */
Patrick Ohly20d49472009-02-12 05:03:38 +0000747 SOCK_TIMESTAMPING_RX_SOFTWARE, /* %SOF_TIMESTAMPING_RX_SOFTWARE */
Eric Dumazetbcdce712009-10-06 17:28:29 -0700748 SOCK_FASYNC, /* fasync() active */
Neil Horman3b885782009-10-12 13:26:31 -0700749 SOCK_RXQ_OVFL,
Shirley Ma1cdebb42011-07-06 12:17:30 +0000750 SOCK_ZEROCOPY, /* buffers from userspace */
Johannes Berg6e3e9392011-11-09 10:15:42 +0100751 SOCK_WIFI_STATUS, /* push wifi status to userspace */
Ben Greear3bdc0eb2012-02-11 15:39:30 +0000752 SOCK_NOFCS, /* Tell NIC not to do the Ethernet FCS.
753 * Will use last 4 bytes of packet sent from
754 * user-space instead.
755 */
Vincent Bernatd59577b2013-01-16 22:55:49 +0100756 SOCK_FILTER_LOCKED, /* Filter cannot be changed anymore */
Keller, Jacob E7d4c04f2013-03-28 11:19:25 +0000757 SOCK_SELECT_ERR_QUEUE, /* Wake select on error queue */
Eric Dumazeta4298e42016-04-01 08:52:12 -0700758 SOCK_RCU_FREE, /* wait rcu grace period in sk_destruct() */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700759};
760
Marcelo Ricardo Leitner01ce63c2015-12-04 15:14:04 -0200761#define SK_FLAGS_TIMESTAMP ((1UL << SOCK_TIMESTAMP) | (1UL << SOCK_TIMESTAMPING_RX_SOFTWARE))
762
Ralf Baechle53b924b2005-08-23 10:11:30 -0700763static inline void sock_copy_flags(struct sock *nsk, struct sock *osk)
764{
765 nsk->sk_flags = osk->sk_flags;
766}
767
Linus Torvalds1da177e2005-04-16 15:20:36 -0700768static inline void sock_set_flag(struct sock *sk, enum sock_flags flag)
769{
770 __set_bit(flag, &sk->sk_flags);
771}
772
773static inline void sock_reset_flag(struct sock *sk, enum sock_flags flag)
774{
775 __clear_bit(flag, &sk->sk_flags);
776}
777
Eric Dumazet1b23a5d2012-05-16 05:57:07 +0000778static inline bool sock_flag(const struct sock *sk, enum sock_flags flag)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700779{
780 return test_bit(flag, &sk->sk_flags);
781}
782
Mel Gormanc93bdd02012-07-31 16:44:19 -0700783#ifdef CONFIG_NET
784extern struct static_key memalloc_socks;
785static inline int sk_memalloc_socks(void)
786{
787 return static_key_false(&memalloc_socks);
788}
Kees Cook538f5782020-06-09 16:11:29 -0700789
790void __receive_sock(struct file *file);
Mel Gormanc93bdd02012-07-31 16:44:19 -0700791#else
792
793static inline int sk_memalloc_socks(void)
794{
795 return 0;
796}
797
Kees Cook538f5782020-06-09 16:11:29 -0700798static inline void __receive_sock(struct file *file)
799{ }
Mel Gormanc93bdd02012-07-31 16:44:19 -0700800#endif
801
Eric Dumazet7450aaf2015-11-30 08:57:28 -0800802static inline gfp_t sk_gfp_mask(const struct sock *sk, gfp_t gfp_mask)
Mel Gorman99a1dec2012-07-31 16:44:14 -0700803{
Eric Dumazet7450aaf2015-11-30 08:57:28 -0800804 return gfp_mask | (sk->sk_allocation & __GFP_MEMALLOC);
Mel Gorman99a1dec2012-07-31 16:44:14 -0700805}
806
Linus Torvalds1da177e2005-04-16 15:20:36 -0700807static inline void sk_acceptq_removed(struct sock *sk)
808{
809 sk->sk_ack_backlog--;
810}
811
812static inline void sk_acceptq_added(struct sock *sk)
813{
814 sk->sk_ack_backlog++;
815}
816
Eric Dumazetdc6b9b72012-05-16 22:48:15 +0000817static inline bool sk_acceptq_is_full(const struct sock *sk)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700818{
David S. Miller64a14652007-03-06 11:21:05 -0800819 return sk->sk_ack_backlog > sk->sk_max_ack_backlog;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700820}
821
822/*
823 * Compute minimal free write space needed to queue new packets.
824 */
Eric Dumazetdc6b9b72012-05-16 22:48:15 +0000825static inline int sk_stream_min_wspace(const struct sock *sk)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700826{
Eric Dumazet8df09ea2007-12-21 03:07:41 -0800827 return sk->sk_wmem_queued >> 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700828}
829
Eric Dumazetdc6b9b72012-05-16 22:48:15 +0000830static inline int sk_stream_wspace(const struct sock *sk)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700831{
832 return sk->sk_sndbuf - sk->sk_wmem_queued;
833}
834
Joe Perches69336bd2013-09-22 10:32:26 -0700835void sk_stream_write_space(struct sock *sk);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700836
Zhu Yi8eae9392010-03-04 18:01:40 +0000837/* OOB backlog add */
Zhu Yia3a858f2010-03-04 18:01:47 +0000838static inline void __sk_add_backlog(struct sock *sk, struct sk_buff *skb)
Stephen Hemminger9ee6b532005-11-08 09:39:42 -0800839{
Eric Dumazet7fee2262010-05-11 23:19:48 +0000840 /* dont let skb dst not refcounted, we are going to leave rcu lock */
Eric Dumazet5037e9e2015-12-14 14:08:53 -0800841 skb_dst_force_safe(skb);
Eric Dumazet7fee2262010-05-11 23:19:48 +0000842
843 if (!sk->sk_backlog.tail)
844 sk->sk_backlog.head = skb;
845 else
Stephen Hemminger9ee6b532005-11-08 09:39:42 -0800846 sk->sk_backlog.tail->next = skb;
Eric Dumazet7fee2262010-05-11 23:19:48 +0000847
848 sk->sk_backlog.tail = skb;
Stephen Hemminger9ee6b532005-11-08 09:39:42 -0800849 skb->next = NULL;
850}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700851
Eric Dumazetc3774112010-04-27 15:13:20 -0700852/*
853 * Take into account size of receive queue and backlog queue
Eric Dumazet0fd7bac2011-12-21 07:11:44 +0000854 * Do not take into account this skb truesize,
855 * to allow even a single big packet to come.
Eric Dumazetc3774112010-04-27 15:13:20 -0700856 */
Sorin Dumitru274f4822014-07-22 21:16:51 +0300857static inline bool sk_rcvqueues_full(const struct sock *sk, unsigned int limit)
Eric Dumazetc3774112010-04-27 15:13:20 -0700858{
859 unsigned int qsize = sk->sk_backlog.len + atomic_read(&sk->sk_rmem_alloc);
860
Eric Dumazetf545a382012-04-22 23:34:26 +0000861 return qsize > limit;
Eric Dumazetc3774112010-04-27 15:13:20 -0700862}
863
Zhu Yi8eae9392010-03-04 18:01:40 +0000864/* The per-socket spinlock must be held here. */
Eric Dumazetf545a382012-04-22 23:34:26 +0000865static inline __must_check int sk_add_backlog(struct sock *sk, struct sk_buff *skb,
866 unsigned int limit)
Zhu Yi8eae9392010-03-04 18:01:40 +0000867{
Sorin Dumitru274f4822014-07-22 21:16:51 +0300868 if (sk_rcvqueues_full(sk, limit))
Zhu Yi8eae9392010-03-04 18:01:40 +0000869 return -ENOBUFS;
870
Eric Dumazetc7c49b82015-09-29 18:52:25 -0700871 /*
872 * If the skb was allocated from pfmemalloc reserves, only
873 * allow SOCK_MEMALLOC sockets to use it as this socket is
874 * helping free memory
875 */
876 if (skb_pfmemalloc(skb) && !sock_flag(sk, SOCK_MEMALLOC))
877 return -ENOMEM;
878
Zhu Yia3a858f2010-03-04 18:01:47 +0000879 __sk_add_backlog(sk, skb);
Zhu Yi8eae9392010-03-04 18:01:40 +0000880 sk->sk_backlog.len += skb->truesize;
881 return 0;
882}
883
Joe Perches69336bd2013-09-22 10:32:26 -0700884int __sk_backlog_rcv(struct sock *sk, struct sk_buff *skb);
Mel Gormanb4b9e352012-07-31 16:44:26 -0700885
Peter Zijlstrac57943a2008-10-07 14:18:42 -0700886static inline int sk_backlog_rcv(struct sock *sk, struct sk_buff *skb)
887{
Mel Gormanb4b9e352012-07-31 16:44:26 -0700888 if (sk_memalloc_socks() && skb_pfmemalloc(skb))
889 return __sk_backlog_rcv(sk, skb);
890
Peter Zijlstrac57943a2008-10-07 14:18:42 -0700891 return sk->sk_backlog_rcv(sk, skb);
892}
893
Eric Dumazet2c8c56e2014-11-11 05:54:28 -0800894static inline void sk_incoming_cpu_update(struct sock *sk)
895{
896 sk->sk_incoming_cpu = raw_smp_processor_id();
897}
898
Tom Herbertfe477552013-12-22 18:54:31 +0800899static inline void sock_rps_record_flow_hash(__u32 hash)
David S. Millerc58dc012010-04-27 15:05:31 -0700900{
901#ifdef CONFIG_RPS
902 struct rps_sock_flow_table *sock_flow_table;
903
904 rcu_read_lock();
905 sock_flow_table = rcu_dereference(rps_sock_flow_table);
Tom Herbertfe477552013-12-22 18:54:31 +0800906 rps_record_sock_flow(sock_flow_table, hash);
David S. Millerc58dc012010-04-27 15:05:31 -0700907 rcu_read_unlock();
908#endif
909}
910
Tom Herbertfe477552013-12-22 18:54:31 +0800911static inline void sock_rps_record_flow(const struct sock *sk)
912{
Zhi Yong Wuc9d8ca02014-01-01 04:31:01 +0800913#ifdef CONFIG_RPS
Tom Herbertfe477552013-12-22 18:54:31 +0800914 sock_rps_record_flow_hash(sk->sk_rxhash);
Zhi Yong Wuc9d8ca02014-01-01 04:31:01 +0800915#endif
Tom Herbertfe477552013-12-22 18:54:31 +0800916}
917
Tom Herbertbdeab992011-08-14 19:45:55 +0000918static inline void sock_rps_save_rxhash(struct sock *sk,
919 const struct sk_buff *skb)
David S. Millerc58dc012010-04-27 15:05:31 -0700920{
921#ifdef CONFIG_RPS
Eric Dumazet567e4b72015-02-06 12:59:01 -0800922 if (unlikely(sk->sk_rxhash != skb->hash))
Tom Herbert61b905d2014-03-24 15:34:47 -0700923 sk->sk_rxhash = skb->hash;
David S. Millerc58dc012010-04-27 15:05:31 -0700924#endif
925}
926
Tom Herbertbdeab992011-08-14 19:45:55 +0000927static inline void sock_rps_reset_rxhash(struct sock *sk)
928{
929#ifdef CONFIG_RPS
Tom Herbertbdeab992011-08-14 19:45:55 +0000930 sk->sk_rxhash = 0;
931#endif
932}
933
Stephen Hemmingercfcabdc2007-10-09 01:59:42 -0700934#define sk_wait_event(__sk, __timeo, __condition) \
935 ({ int __rc; \
936 release_sock(__sk); \
937 __rc = __condition; \
938 if (!__rc) { \
939 *(__timeo) = schedule_timeout(*(__timeo)); \
940 } \
Peter Zijlstra26cabd32014-09-24 10:18:54 +0200941 sched_annotate_sleep(); \
Stephen Hemmingercfcabdc2007-10-09 01:59:42 -0700942 lock_sock(__sk); \
943 __rc = __condition; \
944 __rc; \
945 })
Linus Torvalds1da177e2005-04-16 15:20:36 -0700946
Joe Perches69336bd2013-09-22 10:32:26 -0700947int sk_stream_wait_connect(struct sock *sk, long *timeo_p);
948int sk_stream_wait_memory(struct sock *sk, long *timeo_p);
949void sk_stream_wait_close(struct sock *sk, long timeo_p);
950int sk_stream_error(struct sock *sk, int flags, int err);
951void sk_stream_kill_queues(struct sock *sk);
952void sk_set_memalloc(struct sock *sk);
953void sk_clear_memalloc(struct sock *sk);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700954
Eric Dumazetd41a69f2016-04-29 14:16:53 -0700955void __sk_flush_backlog(struct sock *sk);
956
957static inline bool sk_flush_backlog(struct sock *sk)
958{
959 if (unlikely(READ_ONCE(sk->sk_backlog.tail))) {
960 __sk_flush_backlog(sk);
961 return true;
962 }
963 return false;
964}
965
Sabrina Dubrocadfbafc92015-07-24 18:19:25 +0200966int sk_wait_data(struct sock *sk, long *timeo, const struct sk_buff *skb);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700967
Arnaldo Carvalho de Melo60236fd2005-06-18 22:47:21 -0700968struct request_sock_ops;
Arnaldo Carvalho de Melo6d6ee432005-12-13 23:25:19 -0800969struct timewait_sock_ops;
Arnaldo Carvalho de Meloab1e0a12008-02-03 04:06:04 -0800970struct inet_hashinfo;
Pavel Emelyanovfc8717b2008-03-22 16:56:51 -0700971struct raw_hashinfo;
Paul Gortmakerde477252011-05-26 13:46:22 -0400972struct module;
Arnaldo Carvalho de Melo2e6599c2005-06-18 22:46:52 -0700973
Eric Dumazetf77d6022013-05-09 10:28:16 +0000974/*
975 * caches using SLAB_DESTROY_BY_RCU should let .next pointer from nulls nodes
976 * un-modified. Special care is taken when initializing object to zero.
977 */
978static inline void sk_prot_clear_nulls(struct sock *sk, int size)
979{
980 if (offsetof(struct sock, sk_node.next) != 0)
981 memset(sk, 0, offsetof(struct sock, sk_node.next));
982 memset(&sk->sk_node.pprev, 0,
983 size - offsetof(struct sock, sk_node.pprev));
984}
985
Linus Torvalds1da177e2005-04-16 15:20:36 -0700986/* Networking protocol blocks we attach to sockets.
987 * socket layer -> transport layer interface
Linus Torvalds1da177e2005-04-16 15:20:36 -0700988 */
989struct proto {
Eric Dumazetdc6b9b72012-05-16 22:48:15 +0000990 void (*close)(struct sock *sk,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700991 long timeout);
992 int (*connect)(struct sock *sk,
Eric Dumazetdc6b9b72012-05-16 22:48:15 +0000993 struct sockaddr *uaddr,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700994 int addr_len);
995 int (*disconnect)(struct sock *sk, int flags);
996
Eric Dumazetdc6b9b72012-05-16 22:48:15 +0000997 struct sock * (*accept)(struct sock *sk, int flags, int *err);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700998
999 int (*ioctl)(struct sock *sk, int cmd,
1000 unsigned long arg);
1001 int (*init)(struct sock *sk);
Brian Haley7d06b2e2008-06-14 17:04:49 -07001002 void (*destroy)(struct sock *sk);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001003 void (*shutdown)(struct sock *sk, int how);
Eric Dumazetdc6b9b72012-05-16 22:48:15 +00001004 int (*setsockopt)(struct sock *sk, int level,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001005 int optname, char __user *optval,
David S. Millerb7058842009-09-30 16:12:20 -07001006 unsigned int optlen);
Eric Dumazetdc6b9b72012-05-16 22:48:15 +00001007 int (*getsockopt)(struct sock *sk, int level,
1008 int optname, char __user *optval,
1009 int __user *option);
Alexey Dobriyanaf01d532008-08-28 02:53:51 -07001010#ifdef CONFIG_COMPAT
Dmitry Mishin3fdadf72006-03-20 22:45:21 -08001011 int (*compat_setsockopt)(struct sock *sk,
1012 int level,
1013 int optname, char __user *optval,
David S. Millerb7058842009-09-30 16:12:20 -07001014 unsigned int optlen);
Dmitry Mishin3fdadf72006-03-20 22:45:21 -08001015 int (*compat_getsockopt)(struct sock *sk,
1016 int level,
1017 int optname, char __user *optval,
1018 int __user *option);
Eric W. Biederman709b46e2011-01-29 16:15:56 +00001019 int (*compat_ioctl)(struct sock *sk,
1020 unsigned int cmd, unsigned long arg);
Alexey Dobriyanaf01d532008-08-28 02:53:51 -07001021#endif
Ying Xue1b784142015-03-02 15:37:48 +08001022 int (*sendmsg)(struct sock *sk, struct msghdr *msg,
1023 size_t len);
1024 int (*recvmsg)(struct sock *sk, struct msghdr *msg,
Eric Dumazetdc6b9b72012-05-16 22:48:15 +00001025 size_t len, int noblock, int flags,
1026 int *addr_len);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001027 int (*sendpage)(struct sock *sk, struct page *page,
1028 int offset, size_t size, int flags);
Eric Dumazetdc6b9b72012-05-16 22:48:15 +00001029 int (*bind)(struct sock *sk,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001030 struct sockaddr *uaddr, int addr_len);
1031
Eric Dumazetdc6b9b72012-05-16 22:48:15 +00001032 int (*backlog_rcv) (struct sock *sk,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001033 struct sk_buff *skb);
1034
Eric Dumazet46d3cea2012-07-11 05:50:31 +00001035 void (*release_cb)(struct sock *sk);
1036
Linus Torvalds1da177e2005-04-16 15:20:36 -07001037 /* Keeping track of sk's, looking them up, and port selection methods. */
Craig Gallek086c6532016-02-10 11:50:35 -05001038 int (*hash)(struct sock *sk);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001039 void (*unhash)(struct sock *sk);
Eric Dumazet719f8352010-09-08 05:08:44 +00001040 void (*rehash)(struct sock *sk);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001041 int (*get_port)(struct sock *sk, unsigned short snum);
1042
Eric Dumazet286ab3d2007-11-05 23:38:39 -08001043 /* Keeping track of sockets in use */
Eric Dumazet65f76512008-01-03 20:46:48 -08001044#ifdef CONFIG_PROC_FS
Pavel Emelyanov13ff3d62008-03-28 16:38:17 -07001045 unsigned int inuse_idx;
Eric Dumazet65f76512008-01-03 20:46:48 -08001046#endif
Arnaldo Carvalho de Meloebb53d72007-11-21 22:08:50 +08001047
Eric Dumazetc9bee3b2013-07-22 20:27:07 -07001048 bool (*stream_memory_free)(const struct sock *sk);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001049 /* Memory pressure */
Pavel Emelyanov5c52ba12008-07-16 20:28:10 -07001050 void (*enter_memory_pressure)(struct sock *sk);
Eric Dumazet8d987e52010-11-09 23:24:26 +00001051 atomic_long_t *memory_allocated; /* Current allocated memory. */
Eric Dumazet17483762008-11-25 21:16:35 -08001052 struct percpu_counter *sockets_allocated; /* Current number of sockets. */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001053 /*
1054 * Pressure flag: try to collapse.
1055 * Technical note: it is used by multiple contexts non atomically.
Hideo Aoki3ab224b2007-12-31 00:11:19 -08001056 * All the __sk_mem_schedule() is of this nature: accounting
Linus Torvalds1da177e2005-04-16 15:20:36 -07001057 * is strict, actions are advisory and have some latency.
1058 */
1059 int *memory_pressure;
Eric Dumazet8d987e52010-11-09 23:24:26 +00001060 long *sysctl_mem;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001061 int *sysctl_wmem;
1062 int *sysctl_rmem;
1063 int max_header;
Changli Gao7ba42912010-07-10 20:41:55 +00001064 bool no_autobind;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001065
Eric Dumazet271b72c2008-10-29 02:11:14 -07001066 struct kmem_cache *slab;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001067 unsigned int obj_size;
Eric Dumazet271b72c2008-10-29 02:11:14 -07001068 int slab_flags;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001069
Eric Dumazetdd24c002008-11-25 21:17:14 -08001070 struct percpu_counter *orphan_count;
Arnaldo Carvalho de Melo8feaf0c02005-08-09 20:09:30 -07001071
Arnaldo Carvalho de Melo60236fd2005-06-18 22:47:21 -07001072 struct request_sock_ops *rsk_prot;
Arnaldo Carvalho de Melo6d6ee432005-12-13 23:25:19 -08001073 struct timewait_sock_ops *twsk_prot;
Arnaldo Carvalho de Melo2e6599c2005-06-18 22:46:52 -07001074
Pavel Emelyanov39d8cda2008-03-22 16:50:58 -07001075 union {
1076 struct inet_hashinfo *hashinfo;
Eric Dumazet645ca702008-10-29 01:41:45 -07001077 struct udp_table *udp_table;
Pavel Emelyanovfc8717b2008-03-22 16:56:51 -07001078 struct raw_hashinfo *raw_hash;
Pavel Emelyanov39d8cda2008-03-22 16:50:58 -07001079 } h;
Arnaldo Carvalho de Meloab1e0a12008-02-03 04:06:04 -08001080
Linus Torvalds1da177e2005-04-16 15:20:36 -07001081 struct module *owner;
1082
1083 char name[32];
1084
1085 struct list_head node;
Arnaldo Carvalho de Meloe6848972005-08-09 19:45:38 -07001086#ifdef SOCK_REFCNT_DEBUG
1087 atomic_t socks;
1088#endif
Lorenzo Colitti64be0ae2015-12-16 12:30:03 +09001089 int (*diag_destroy)(struct sock *sk, int err);
Glauber Costae1aab162011-12-11 21:47:03 +00001090};
1091
Joe Perches69336bd2013-09-22 10:32:26 -07001092int proto_register(struct proto *prot, int alloc_slab);
1093void proto_unregister(struct proto *prot);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001094
Arnaldo Carvalho de Meloe6848972005-08-09 19:45:38 -07001095#ifdef SOCK_REFCNT_DEBUG
1096static inline void sk_refcnt_debug_inc(struct sock *sk)
1097{
1098 atomic_inc(&sk->sk_prot->socks);
1099}
1100
1101static inline void sk_refcnt_debug_dec(struct sock *sk)
1102{
1103 atomic_dec(&sk->sk_prot->socks);
1104 printk(KERN_DEBUG "%s socket %p released, %d are still alive\n",
1105 sk->sk_prot->name, sk, atomic_read(&sk->sk_prot->socks));
1106}
1107
Ying Xuedec34fb2013-02-15 22:28:25 +00001108static inline void sk_refcnt_debug_release(const struct sock *sk)
Arnaldo Carvalho de Meloe6848972005-08-09 19:45:38 -07001109{
1110 if (atomic_read(&sk->sk_refcnt) != 1)
1111 printk(KERN_DEBUG "Destruction of the %s socket %p delayed, refcnt=%d\n",
1112 sk->sk_prot->name, sk, atomic_read(&sk->sk_refcnt));
1113}
1114#else /* SOCK_REFCNT_DEBUG */
1115#define sk_refcnt_debug_inc(sk) do { } while (0)
1116#define sk_refcnt_debug_dec(sk) do { } while (0)
1117#define sk_refcnt_debug_release(sk) do { } while (0)
1118#endif /* SOCK_REFCNT_DEBUG */
1119
Eric Dumazetc9bee3b2013-07-22 20:27:07 -07001120static inline bool sk_stream_memory_free(const struct sock *sk)
1121{
1122 if (sk->sk_wmem_queued >= sk->sk_sndbuf)
1123 return false;
1124
1125 return sk->sk_prot->stream_memory_free ?
1126 sk->sk_prot->stream_memory_free(sk) : true;
1127}
1128
Eric Dumazet64dc6132013-07-22 20:26:31 -07001129static inline bool sk_stream_is_writeable(const struct sock *sk)
1130{
Eric Dumazetc9bee3b2013-07-22 20:27:07 -07001131 return sk_stream_wspace(sk) >= sk_stream_min_wspace(sk) &&
1132 sk_stream_memory_free(sk);
Eric Dumazet64dc6132013-07-22 20:26:31 -07001133}
Glauber Costae1aab162011-12-11 21:47:03 +00001134
Daniel Borkmann54fd9c22016-08-18 01:00:41 +02001135static inline int sk_under_cgroup_hierarchy(struct sock *sk,
1136 struct cgroup *ancestor)
1137{
1138#ifdef CONFIG_SOCK_CGROUP_DATA
1139 return cgroup_is_descendant(sock_cgroup_ptr(&sk->sk_cgrp_data),
1140 ancestor);
1141#else
1142 return -ENOTSUPP;
1143#endif
1144}
Eric Dumazetc9bee3b2013-07-22 20:27:07 -07001145
Glauber Costa180d8cd2011-12-11 21:47:02 +00001146static inline bool sk_has_memory_pressure(const struct sock *sk)
1147{
1148 return sk->sk_prot->memory_pressure != NULL;
1149}
1150
1151static inline bool sk_under_memory_pressure(const struct sock *sk)
1152{
1153 if (!sk->sk_prot->memory_pressure)
1154 return false;
Glauber Costae1aab162011-12-11 21:47:03 +00001155
Johannes Weinerbaac50b2016-01-14 15:21:17 -08001156 if (mem_cgroup_sockets_enabled && sk->sk_memcg &&
1157 mem_cgroup_under_socket_pressure(sk->sk_memcg))
Johannes Weinere8056052016-01-14 15:21:14 -08001158 return true;
Glauber Costae1aab162011-12-11 21:47:03 +00001159
Christoph Paasch35b87f62013-10-23 12:49:21 -07001160 return !!*sk->sk_prot->memory_pressure;
Glauber Costa180d8cd2011-12-11 21:47:02 +00001161}
1162
1163static inline void sk_leave_memory_pressure(struct sock *sk)
1164{
1165 int *memory_pressure = sk->sk_prot->memory_pressure;
1166
Glauber Costae1aab162011-12-11 21:47:03 +00001167 if (!memory_pressure)
1168 return;
1169
1170 if (*memory_pressure)
Glauber Costa180d8cd2011-12-11 21:47:02 +00001171 *memory_pressure = 0;
1172}
1173
1174static inline void sk_enter_memory_pressure(struct sock *sk)
1175{
Glauber Costae1aab162011-12-11 21:47:03 +00001176 if (!sk->sk_prot->enter_memory_pressure)
1177 return;
1178
Glauber Costae1aab162011-12-11 21:47:03 +00001179 sk->sk_prot->enter_memory_pressure(sk);
Glauber Costa180d8cd2011-12-11 21:47:02 +00001180}
1181
1182static inline long sk_prot_mem_limits(const struct sock *sk, int index)
1183{
Johannes Weinere8056052016-01-14 15:21:14 -08001184 return sk->sk_prot->sysctl_mem[index];
Glauber Costae1aab162011-12-11 21:47:03 +00001185}
1186
Glauber Costa180d8cd2011-12-11 21:47:02 +00001187static inline long
1188sk_memory_allocated(const struct sock *sk)
1189{
Johannes Weinere8056052016-01-14 15:21:14 -08001190 return atomic_long_read(sk->sk_prot->memory_allocated);
Glauber Costa180d8cd2011-12-11 21:47:02 +00001191}
1192
1193static inline long
Johannes Weinere8056052016-01-14 15:21:14 -08001194sk_memory_allocated_add(struct sock *sk, int amt)
Glauber Costa180d8cd2011-12-11 21:47:02 +00001195{
Johannes Weinere8056052016-01-14 15:21:14 -08001196 return atomic_long_add_return(amt, sk->sk_prot->memory_allocated);
Glauber Costa180d8cd2011-12-11 21:47:02 +00001197}
1198
1199static inline void
Glauber Costa0e90b312012-01-20 04:57:16 +00001200sk_memory_allocated_sub(struct sock *sk, int amt)
Glauber Costa180d8cd2011-12-11 21:47:02 +00001201{
Johannes Weinere8056052016-01-14 15:21:14 -08001202 atomic_long_sub(amt, sk->sk_prot->memory_allocated);
Glauber Costa180d8cd2011-12-11 21:47:02 +00001203}
1204
1205static inline void sk_sockets_allocated_dec(struct sock *sk)
1206{
Johannes Weineraf95d7d2016-01-14 15:21:08 -08001207 percpu_counter_dec(sk->sk_prot->sockets_allocated);
Glauber Costa180d8cd2011-12-11 21:47:02 +00001208}
1209
1210static inline void sk_sockets_allocated_inc(struct sock *sk)
1211{
Johannes Weineraf95d7d2016-01-14 15:21:08 -08001212 percpu_counter_inc(sk->sk_prot->sockets_allocated);
Glauber Costa180d8cd2011-12-11 21:47:02 +00001213}
1214
Eric Dumazet9d3fcde2019-02-12 12:26:27 -08001215static inline u64
Glauber Costa180d8cd2011-12-11 21:47:02 +00001216sk_sockets_allocated_read_positive(struct sock *sk)
1217{
Johannes Weineraf95d7d2016-01-14 15:21:08 -08001218 return percpu_counter_read_positive(sk->sk_prot->sockets_allocated);
Glauber Costa180d8cd2011-12-11 21:47:02 +00001219}
1220
1221static inline int
1222proto_sockets_allocated_sum_positive(struct proto *prot)
1223{
1224 return percpu_counter_sum_positive(prot->sockets_allocated);
1225}
1226
1227static inline long
1228proto_memory_allocated(struct proto *prot)
1229{
1230 return atomic_long_read(prot->memory_allocated);
1231}
1232
1233static inline bool
1234proto_memory_pressure(struct proto *prot)
1235{
1236 if (!prot->memory_pressure)
1237 return false;
1238 return !!*prot->memory_pressure;
1239}
1240
Eric Dumazet65f76512008-01-03 20:46:48 -08001241
1242#ifdef CONFIG_PROC_FS
Linus Torvalds1da177e2005-04-16 15:20:36 -07001243/* Called with local bh disabled */
Joe Perches69336bd2013-09-22 10:32:26 -07001244void sock_prot_inuse_add(struct net *net, struct proto *prot, int inc);
1245int sock_prot_inuse_get(struct net *net, struct proto *proto);
Eric Dumazet65f76512008-01-03 20:46:48 -08001246#else
Eric Dumazetdc6b9b72012-05-16 22:48:15 +00001247static inline void sock_prot_inuse_add(struct net *net, struct proto *prot,
Pavel Emelyanovc29a0bc2008-03-31 19:41:46 -07001248 int inc)
Eric Dumazet65f76512008-01-03 20:46:48 -08001249{
1250}
Eric Dumazet65f76512008-01-03 20:46:48 -08001251#endif
1252
Linus Torvalds1da177e2005-04-16 15:20:36 -07001253
Arnaldo Carvalho de Melo614c6cb2005-08-09 19:47:37 -07001254/* With per-bucket locks this operation is not-atomic, so that
1255 * this version is not worse.
1256 */
Craig Gallek086c6532016-02-10 11:50:35 -05001257static inline int __sk_prot_rehash(struct sock *sk)
Arnaldo Carvalho de Melo614c6cb2005-08-09 19:47:37 -07001258{
1259 sk->sk_prot->unhash(sk);
Craig Gallek086c6532016-02-10 11:50:35 -05001260 return sk->sk_prot->hash(sk);
Arnaldo Carvalho de Melo614c6cb2005-08-09 19:47:37 -07001261}
1262
Linus Torvalds1da177e2005-04-16 15:20:36 -07001263/* About 10 seconds */
1264#define SOCK_DESTROY_TIME (10*HZ)
1265
1266/* Sockets 0-1023 can't be bound to unless you are superuser */
1267#define PROT_SOCK 1024
1268
1269#define SHUTDOWN_MASK 3
1270#define RCV_SHUTDOWN 1
1271#define SEND_SHUTDOWN 2
1272
1273#define SOCK_SNDBUF_LOCK 1
1274#define SOCK_RCVBUF_LOCK 2
1275#define SOCK_BINDADDR_LOCK 4
1276#define SOCK_BINDPORT_LOCK 8
1277
Linus Torvalds1da177e2005-04-16 15:20:36 -07001278struct socket_alloc {
1279 struct socket socket;
1280 struct inode vfs_inode;
1281};
1282
1283static inline struct socket *SOCKET_I(struct inode *inode)
1284{
1285 return &container_of(inode, struct socket_alloc, vfs_inode)->socket;
1286}
1287
1288static inline struct inode *SOCK_INODE(struct socket *socket)
1289{
1290 return &container_of(socket, struct socket_alloc, socket)->vfs_inode;
1291}
1292
Hideo Aoki3ab224b2007-12-31 00:11:19 -08001293/*
1294 * Functions for memory accounting
1295 */
Joe Perches69336bd2013-09-22 10:32:26 -07001296int __sk_mem_schedule(struct sock *sk, int size, int kind);
Eric Dumazet1a24e042015-05-15 12:39:25 -07001297void __sk_mem_reclaim(struct sock *sk, int amount);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001298
Hideo Aoki3ab224b2007-12-31 00:11:19 -08001299#define SK_MEM_QUANTUM ((int)PAGE_SIZE)
1300#define SK_MEM_QUANTUM_SHIFT ilog2(SK_MEM_QUANTUM)
1301#define SK_MEM_SEND 0
1302#define SK_MEM_RECV 1
Linus Torvalds1da177e2005-04-16 15:20:36 -07001303
Hideo Aoki3ab224b2007-12-31 00:11:19 -08001304static inline int sk_mem_pages(int amt)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001305{
Hideo Aoki3ab224b2007-12-31 00:11:19 -08001306 return (amt + SK_MEM_QUANTUM - 1) >> SK_MEM_QUANTUM_SHIFT;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001307}
1308
Eric Dumazetdc6b9b72012-05-16 22:48:15 +00001309static inline bool sk_has_account(struct sock *sk)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001310{
Hideo Aoki3ab224b2007-12-31 00:11:19 -08001311 /* return true if protocol supports memory accounting */
1312 return !!sk->sk_prot->memory_allocated;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001313}
1314
Eric Dumazetdc6b9b72012-05-16 22:48:15 +00001315static inline bool sk_wmem_schedule(struct sock *sk, int size)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001316{
Hideo Aoki3ab224b2007-12-31 00:11:19 -08001317 if (!sk_has_account(sk))
Eric Dumazetdc6b9b72012-05-16 22:48:15 +00001318 return true;
Herbert Xud80d99d2005-09-01 17:48:23 -07001319 return size <= sk->sk_forward_alloc ||
Hideo Aoki3ab224b2007-12-31 00:11:19 -08001320 __sk_mem_schedule(sk, size, SK_MEM_SEND);
1321}
1322
Mel Gormanc76562b2012-07-31 16:44:41 -07001323static inline bool
Chuck Lever35c448a2012-09-17 14:09:11 -07001324sk_rmem_schedule(struct sock *sk, struct sk_buff *skb, int size)
Hideo Aoki3ab224b2007-12-31 00:11:19 -08001325{
1326 if (!sk_has_account(sk))
Eric Dumazetdc6b9b72012-05-16 22:48:15 +00001327 return true;
Mel Gormanc76562b2012-07-31 16:44:41 -07001328 return size<= sk->sk_forward_alloc ||
1329 __sk_mem_schedule(sk, size, SK_MEM_RECV) ||
1330 skb_pfmemalloc(skb);
Hideo Aoki3ab224b2007-12-31 00:11:19 -08001331}
1332
1333static inline void sk_mem_reclaim(struct sock *sk)
1334{
1335 if (!sk_has_account(sk))
1336 return;
1337 if (sk->sk_forward_alloc >= SK_MEM_QUANTUM)
Eric Dumazet1a24e042015-05-15 12:39:25 -07001338 __sk_mem_reclaim(sk, sk->sk_forward_alloc);
Hideo Aoki3ab224b2007-12-31 00:11:19 -08001339}
1340
David S. Miller9993e7d2008-01-10 21:56:38 -08001341static inline void sk_mem_reclaim_partial(struct sock *sk)
1342{
1343 if (!sk_has_account(sk))
1344 return;
1345 if (sk->sk_forward_alloc > SK_MEM_QUANTUM)
Eric Dumazet1a24e042015-05-15 12:39:25 -07001346 __sk_mem_reclaim(sk, sk->sk_forward_alloc - 1);
David S. Miller9993e7d2008-01-10 21:56:38 -08001347}
1348
Hideo Aoki3ab224b2007-12-31 00:11:19 -08001349static inline void sk_mem_charge(struct sock *sk, int size)
1350{
1351 if (!sk_has_account(sk))
1352 return;
1353 sk->sk_forward_alloc -= size;
1354}
1355
1356static inline void sk_mem_uncharge(struct sock *sk, int size)
1357{
1358 if (!sk_has_account(sk))
1359 return;
1360 sk->sk_forward_alloc += size;
Eric Dumazet20c64d52016-09-15 08:48:46 -07001361
1362 /* Avoid a possible overflow.
1363 * TCP send queues can make this happen, if sk_mem_reclaim()
1364 * is not called and more than 2 GBytes are released at once.
1365 *
1366 * If we reach 2 MBytes, reclaim 1 MBytes right now, there is
1367 * no need to hold that much forward allocation anyway.
1368 */
1369 if (unlikely(sk->sk_forward_alloc >= 1 << 21))
1370 __sk_mem_reclaim(sk, 1 << 20);
Hideo Aoki3ab224b2007-12-31 00:11:19 -08001371}
1372
1373static inline void sk_wmem_free_skb(struct sock *sk, struct sk_buff *skb)
1374{
Hideo Aoki3ab224b2007-12-31 00:11:19 -08001375 sock_set_flag(sk, SOCK_QUEUE_SHRUNK);
1376 sk->sk_wmem_queued -= skb->truesize;
1377 sk_mem_uncharge(sk, skb->truesize);
1378 __kfree_skb(skb);
Herbert Xud80d99d2005-09-01 17:48:23 -07001379}
1380
Eric Dumazetc3f9b012014-03-10 09:50:11 -07001381static inline void sock_release_ownership(struct sock *sk)
1382{
Hannes Frederic Sowa61881cf2016-04-05 17:10:14 +02001383 if (sk->sk_lock.owned) {
1384 sk->sk_lock.owned = 0;
1385
1386 /* The sk_lock has mutex_unlock() semantics: */
1387 mutex_release(&sk->sk_lock.dep_map, 1, _RET_IP_);
1388 }
Eric Dumazetc3f9b012014-03-10 09:50:11 -07001389}
1390
Peter Zijlstraed075362006-12-06 20:35:24 -08001391/*
1392 * Macro so as to not evaluate some arguments when
1393 * lockdep is not enabled.
1394 *
1395 * Mark both the sk_lock and the sk_lock.slock as a
1396 * per-address-family lock class.
1397 */
Eric Dumazetdc6b9b72012-05-16 22:48:15 +00001398#define sock_lock_init_class_and_name(sk, sname, skey, name, key) \
Peter Zijlstraed075362006-12-06 20:35:24 -08001399do { \
Ingo Molnare8f6fbf2008-11-12 01:38:36 +00001400 sk->sk_lock.owned = 0; \
Peter Zijlstraed075362006-12-06 20:35:24 -08001401 init_waitqueue_head(&sk->sk_lock.wq); \
1402 spin_lock_init(&(sk)->sk_lock.slock); \
1403 debug_check_no_locks_freed((void *)&(sk)->sk_lock, \
1404 sizeof((sk)->sk_lock)); \
1405 lockdep_set_class_and_name(&(sk)->sk_lock.slock, \
Eric Dumazetdc6b9b72012-05-16 22:48:15 +00001406 (skey), (sname)); \
Peter Zijlstraed075362006-12-06 20:35:24 -08001407 lockdep_init_map(&(sk)->sk_lock.dep_map, (name), (key), 0); \
1408} while (0)
1409
David S. Millerb33b0a12016-04-07 20:40:25 -04001410#ifdef CONFIG_LOCKDEP
Hannes Frederic Sowa03be9822016-04-07 23:53:35 +02001411static inline bool lockdep_sock_is_held(const struct sock *csk)
Hannes Frederic Sowa1e1d04e2016-04-05 17:10:15 +02001412{
1413 struct sock *sk = (struct sock *)csk;
1414
1415 return lockdep_is_held(&sk->sk_lock) ||
1416 lockdep_is_held(&sk->sk_lock.slock);
1417}
David S. Millerb33b0a12016-04-07 20:40:25 -04001418#endif
Hannes Frederic Sowa1e1d04e2016-04-05 17:10:15 +02001419
Joe Perches69336bd2013-09-22 10:32:26 -07001420void lock_sock_nested(struct sock *sk, int subclass);
Peter Zijlstrafcc70d52006-11-08 22:44:35 -08001421
1422static inline void lock_sock(struct sock *sk)
1423{
1424 lock_sock_nested(sk, 0);
1425}
1426
Joe Perches69336bd2013-09-22 10:32:26 -07001427void release_sock(struct sock *sk);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001428
1429/* BH context may only use the following locking interface. */
1430#define bh_lock_sock(__sk) spin_lock(&((__sk)->sk_lock.slock))
Ingo Molnarc6366182006-07-03 00:25:13 -07001431#define bh_lock_sock_nested(__sk) \
1432 spin_lock_nested(&((__sk)->sk_lock.slock), \
1433 SINGLE_DEPTH_NESTING)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001434#define bh_unlock_sock(__sk) spin_unlock(&((__sk)->sk_lock.slock))
1435
Joe Perches69336bd2013-09-22 10:32:26 -07001436bool lock_sock_fast(struct sock *sk);
Eric Dumazet8a74ad62010-05-26 19:20:18 +00001437/**
1438 * unlock_sock_fast - complement of lock_sock_fast
1439 * @sk: socket
1440 * @slow: slow mode
1441 *
1442 * fast unlock socket for user context.
1443 * If slow mode is on, we call regular release_sock()
1444 */
1445static inline void unlock_sock_fast(struct sock *sk, bool slow)
Eric Dumazet4b0b72f2010-04-28 14:35:48 -07001446{
Eric Dumazet8a74ad62010-05-26 19:20:18 +00001447 if (slow)
1448 release_sock(sk);
1449 else
1450 spin_unlock_bh(&sk->sk_lock.slock);
Eric Dumazet4b0b72f2010-04-28 14:35:48 -07001451}
1452
Hannes Frederic Sowafafc4e12016-04-08 15:11:27 +02001453/* Used by processes to "lock" a socket state, so that
1454 * interrupts and bottom half handlers won't change it
1455 * from under us. It essentially blocks any incoming
1456 * packets, so that we won't get any new data or any
1457 * packets that change the state of the socket.
1458 *
1459 * While locked, BH processing will add new packets to
1460 * the backlog queue. This queue is processed by the
1461 * owner of the socket lock right before it is released.
1462 *
1463 * Since ~2.3.5 it is also exclusive sleep lock serializing
1464 * accesses from user process context.
1465 */
1466
Eric Dumazet46cc6e42016-05-03 16:56:03 -07001467static inline void sock_owned_by_me(const struct sock *sk)
Hannes Frederic Sowafafc4e12016-04-08 15:11:27 +02001468{
1469#ifdef CONFIG_LOCKDEP
Eric Dumazet5e91f6c2016-04-25 06:34:09 -07001470 WARN_ON_ONCE(!lockdep_sock_is_held(sk) && debug_locks);
Hannes Frederic Sowafafc4e12016-04-08 15:11:27 +02001471#endif
Eric Dumazet46cc6e42016-05-03 16:56:03 -07001472}
1473
1474static inline bool sock_owned_by_user(const struct sock *sk)
1475{
1476 sock_owned_by_me(sk);
Hannes Frederic Sowafafc4e12016-04-08 15:11:27 +02001477 return sk->sk_lock.owned;
1478}
1479
1480/* no reclassification while locks are held */
1481static inline bool sock_allow_reclassification(const struct sock *csk)
1482{
1483 struct sock *sk = (struct sock *)csk;
1484
1485 return !sk->sk_lock.owned && !spin_is_locked(&sk->sk_lock.slock);
1486}
Eric Dumazet4b0b72f2010-04-28 14:35:48 -07001487
Joe Perches69336bd2013-09-22 10:32:26 -07001488struct sock *sk_alloc(struct net *net, int family, gfp_t priority,
Eric W. Biederman11aa9c22015-05-08 21:09:13 -05001489 struct proto *prot, int kern);
Joe Perches69336bd2013-09-22 10:32:26 -07001490void sk_free(struct sock *sk);
Craig Gallekeb4cb002015-06-15 11:26:18 -04001491void sk_destruct(struct sock *sk);
Joe Perches69336bd2013-09-22 10:32:26 -07001492struct sock *sk_clone_lock(const struct sock *sk, const gfp_t priority);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001493
Joe Perches69336bd2013-09-22 10:32:26 -07001494struct sk_buff *sock_wmalloc(struct sock *sk, unsigned long size, int force,
1495 gfp_t priority);
Eric Dumazet1d2077a2016-05-02 10:56:27 -07001496void __sock_wfree(struct sk_buff *skb);
Joe Perches69336bd2013-09-22 10:32:26 -07001497void sock_wfree(struct sk_buff *skb);
1498void skb_orphan_partial(struct sk_buff *skb);
1499void sock_rfree(struct sk_buff *skb);
Alexander Duyck62bccb82014-09-04 13:31:35 -04001500void sock_efree(struct sk_buff *skb);
Alexander Duyck82eabd92014-09-04 13:32:11 -04001501#ifdef CONFIG_INET
Joe Perches69336bd2013-09-22 10:32:26 -07001502void sock_edemux(struct sk_buff *skb);
Alexander Duyck82eabd92014-09-04 13:32:11 -04001503#else
1504#define sock_edemux(skb) sock_efree(skb)
1505#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -07001506
Joe Perches69336bd2013-09-22 10:32:26 -07001507int sock_setsockopt(struct socket *sock, int level, int op,
1508 char __user *optval, unsigned int optlen);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001509
Joe Perches69336bd2013-09-22 10:32:26 -07001510int sock_getsockopt(struct socket *sock, int level, int op,
1511 char __user *optval, int __user *optlen);
1512struct sk_buff *sock_alloc_send_skb(struct sock *sk, unsigned long size,
1513 int noblock, int *errcode);
1514struct sk_buff *sock_alloc_send_pskb(struct sock *sk, unsigned long header_len,
1515 unsigned long data_len, int noblock,
1516 int *errcode, int max_page_order);
1517void *sock_kmalloc(struct sock *sk, int size, gfp_t priority);
1518void sock_kfree_s(struct sock *sk, void *mem, int size);
Daniel Borkmann79e88652014-11-19 17:13:11 +01001519void sock_kzfree_s(struct sock *sk, void *mem, int size);
Joe Perches69336bd2013-09-22 10:32:26 -07001520void sk_send_sigurg(struct sock *sk);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001521
Edward Jeef28ea362015-10-08 14:56:48 -07001522struct sockcm_cookie {
1523 u32 mark;
Soheil Hassas Yeganeh3dd17e62016-04-02 23:08:09 -04001524 u16 tsflags;
Edward Jeef28ea362015-10-08 14:56:48 -07001525};
1526
Willem de Bruijn39771b12016-04-02 23:08:06 -04001527int __sock_cmsg_send(struct sock *sk, struct msghdr *msg, struct cmsghdr *cmsg,
1528 struct sockcm_cookie *sockc);
Edward Jeef28ea362015-10-08 14:56:48 -07001529int sock_cmsg_send(struct sock *sk, struct msghdr *msg,
1530 struct sockcm_cookie *sockc);
1531
Linus Torvalds1da177e2005-04-16 15:20:36 -07001532/*
1533 * Functions to fill in entries in struct proto_ops when a protocol
1534 * does not implement a particular function.
1535 */
Joe Perches69336bd2013-09-22 10:32:26 -07001536int sock_no_bind(struct socket *, struct sockaddr *, int);
1537int sock_no_connect(struct socket *, struct sockaddr *, int, int);
1538int sock_no_socketpair(struct socket *, struct socket *);
1539int sock_no_accept(struct socket *, struct socket *, int);
1540int sock_no_getname(struct socket *, struct sockaddr *, int *, int);
1541unsigned int sock_no_poll(struct file *, struct socket *,
1542 struct poll_table_struct *);
1543int sock_no_ioctl(struct socket *, unsigned int, unsigned long);
1544int sock_no_listen(struct socket *, int);
1545int sock_no_shutdown(struct socket *, int);
1546int sock_no_getsockopt(struct socket *, int , int, char __user *, int __user *);
1547int sock_no_setsockopt(struct socket *, int, int, char __user *, unsigned int);
Ying Xue1b784142015-03-02 15:37:48 +08001548int sock_no_sendmsg(struct socket *, struct msghdr *, size_t);
1549int sock_no_recvmsg(struct socket *, struct msghdr *, size_t, int);
Joe Perches69336bd2013-09-22 10:32:26 -07001550int sock_no_mmap(struct file *file, struct socket *sock,
1551 struct vm_area_struct *vma);
1552ssize_t sock_no_sendpage(struct socket *sock, struct page *page, int offset,
1553 size_t size, int flags);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001554
1555/*
1556 * Functions to fill in entries in struct proto_ops when a protocol
1557 * uses the inet style.
1558 */
Joe Perches69336bd2013-09-22 10:32:26 -07001559int sock_common_getsockopt(struct socket *sock, int level, int optname,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001560 char __user *optval, int __user *optlen);
Ying Xue1b784142015-03-02 15:37:48 +08001561int sock_common_recvmsg(struct socket *sock, struct msghdr *msg, size_t size,
1562 int flags);
Joe Perches69336bd2013-09-22 10:32:26 -07001563int sock_common_setsockopt(struct socket *sock, int level, int optname,
David S. Millerb7058842009-09-30 16:12:20 -07001564 char __user *optval, unsigned int optlen);
Joe Perches69336bd2013-09-22 10:32:26 -07001565int compat_sock_common_getsockopt(struct socket *sock, int level,
Dmitry Mishin3fdadf72006-03-20 22:45:21 -08001566 int optname, char __user *optval, int __user *optlen);
Joe Perches69336bd2013-09-22 10:32:26 -07001567int compat_sock_common_setsockopt(struct socket *sock, int level,
David S. Millerb7058842009-09-30 16:12:20 -07001568 int optname, char __user *optval, unsigned int optlen);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001569
Joe Perches69336bd2013-09-22 10:32:26 -07001570void sk_common_release(struct sock *sk);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001571
1572/*
1573 * Default socket callbacks and setup code
1574 */
Eric Dumazetdc6b9b72012-05-16 22:48:15 +00001575
Linus Torvalds1da177e2005-04-16 15:20:36 -07001576/* Initialise core socket variables */
Joe Perches69336bd2013-09-22 10:32:26 -07001577void sock_init_data(struct socket *sock, struct sock *sk);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001578
Linus Torvalds1da177e2005-04-16 15:20:36 -07001579/*
1580 * Socket reference counting postulates.
1581 *
1582 * * Each user of socket SHOULD hold a reference count.
1583 * * Each access point to socket (an hash table bucket, reference from a list,
1584 * running timer, skb in flight MUST hold a reference count.
1585 * * When reference count hits 0, it means it will never increase back.
1586 * * When reference count hits 0, it means that no references from
1587 * outside exist to this socket and current process on current CPU
1588 * is last user and may/should destroy this socket.
1589 * * sk_free is called from any context: process, BH, IRQ. When
1590 * it is called, socket has no references from outside -> sk_free
1591 * may release descendant resources allocated by the socket, but
1592 * to the time when it is called, socket is NOT referenced by any
1593 * hash tables, lists etc.
1594 * * Packets, delivered from outside (from network or from another process)
1595 * and enqueued on receive/error queues SHOULD NOT grab reference count,
1596 * when they sit in queue. Otherwise, packets will leak to hole, when
1597 * socket is looked up by one cpu and unhasing is made by another CPU.
1598 * It is true for udp/raw, netlink (leak to receive and error queues), tcp
1599 * (leak to backlog). Packet socket does all the processing inside
1600 * BR_NETPROTO_LOCK, so that it has not this race condition. UNIX sockets
1601 * use separate SMP lock, so that they are prone too.
1602 */
1603
1604/* Ungrab socket and destroy it, if it was the last reference. */
1605static inline void sock_put(struct sock *sk)
1606{
1607 if (atomic_dec_and_test(&sk->sk_refcnt))
1608 sk_free(sk);
1609}
Eric Dumazet05dbc7b2013-10-03 00:22:02 -07001610/* Generic version of sock_put(), dealing with all sockets
Eric Dumazet41b822c2015-03-12 16:44:08 -07001611 * (TCP_TIMEWAIT, TCP_NEW_SYN_RECV, ESTABLISHED...)
Eric Dumazet05dbc7b2013-10-03 00:22:02 -07001612 */
1613void sock_gen_put(struct sock *sk);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001614
Willem de Bruijn4f0c40d92016-07-12 18:18:57 -04001615int __sk_receive_skb(struct sock *sk, struct sk_buff *skb, const int nested,
Eric Dumazetc3f24cf2016-11-02 17:14:41 -07001616 unsigned int trim_cap, bool refcounted);
Willem de Bruijn4f0c40d92016-07-12 18:18:57 -04001617static inline int sk_receive_skb(struct sock *sk, struct sk_buff *skb,
1618 const int nested)
1619{
Eric Dumazetc3f24cf2016-11-02 17:14:41 -07001620 return __sk_receive_skb(sk, skb, nested, 1, true);
Willem de Bruijn4f0c40d92016-07-12 18:18:57 -04001621}
Arnaldo Carvalho de Melo25995ff2005-12-27 02:42:22 -02001622
Krishna Kumare022f0b2009-10-19 23:46:20 +00001623static inline void sk_tx_queue_set(struct sock *sk, int tx_queue)
1624{
1625 sk->sk_tx_queue_mapping = tx_queue;
1626}
1627
1628static inline void sk_tx_queue_clear(struct sock *sk)
1629{
1630 sk->sk_tx_queue_mapping = -1;
1631}
1632
1633static inline int sk_tx_queue_get(const struct sock *sk)
1634{
Tom Herbertb0f77d02010-07-14 20:50:29 -07001635 return sk ? sk->sk_tx_queue_mapping : -1;
Krishna Kumare022f0b2009-10-19 23:46:20 +00001636}
1637
David S. Miller972692e2008-06-17 22:41:38 -07001638static inline void sk_set_socket(struct sock *sk, struct socket *sock)
1639{
1640 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 Dumazet7a442d42021-06-10 07:44:11 -07001686 /* This pairs with READ_ONCE() in skb_set_hash_from_sk() */
1687 WRITE_ONCE(sk->sk_txhash, net_tx_rndhash());
Tom Herbert877d1f62015-07-28 16:02:05 -07001688}
1689
Tom Herbert265f94f2015-07-28 16:02:06 -07001690static inline void sk_rethink_txhash(struct sock *sk)
1691{
1692 if (sk->sk_txhash)
1693 sk_set_txhash(sk);
1694}
1695
Linus Torvalds1da177e2005-04-16 15:20:36 -07001696static inline struct dst_entry *
1697__sk_dst_get(struct sock *sk)
1698{
Hannes Frederic Sowa1e1d04e2016-04-05 17:10:15 +02001699 return rcu_dereference_check(sk->sk_dst_cache,
1700 lockdep_sock_is_held(sk));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001701}
1702
1703static inline struct dst_entry *
1704sk_dst_get(struct sock *sk)
1705{
1706 struct dst_entry *dst;
1707
Eric Dumazetb6c67122010-04-08 23:03:29 +00001708 rcu_read_lock();
1709 dst = rcu_dereference(sk->sk_dst_cache);
Eric Dumazetf8864972014-06-24 10:05:11 -07001710 if (dst && !atomic_inc_not_zero(&dst->__refcnt))
1711 dst = NULL;
Eric Dumazetb6c67122010-04-08 23:03:29 +00001712 rcu_read_unlock();
Linus Torvalds1da177e2005-04-16 15:20:36 -07001713 return dst;
1714}
1715
Eric Dumazetb6c67122010-04-08 23:03:29 +00001716static inline void dst_negative_advice(struct sock *sk)
1717{
1718 struct dst_entry *ndst, *dst = __sk_dst_get(sk);
1719
Tom Herbert265f94f2015-07-28 16:02:06 -07001720 sk_rethink_txhash(sk);
1721
Eric Dumazetb6c67122010-04-08 23:03:29 +00001722 if (dst && dst->ops->negative_advice) {
1723 ndst = dst->ops->negative_advice(dst);
1724
1725 if (ndst != dst) {
1726 rcu_assign_pointer(sk->sk_dst_cache, ndst);
ZHAO Gang0a6957e2013-10-22 16:23:38 +08001727 sk_tx_queue_clear(sk);
Eric Dumazetb6c67122010-04-08 23:03:29 +00001728 }
1729 }
1730}
1731
Linus Torvalds1da177e2005-04-16 15:20:36 -07001732static inline void
1733__sk_dst_set(struct sock *sk, struct dst_entry *dst)
1734{
1735 struct dst_entry *old_dst;
1736
Krishna Kumare022f0b2009-10-19 23:46:20 +00001737 sk_tx_queue_clear(sk);
Eric Dumazet0b53ff22010-04-26 20:40:43 +00001738 /*
1739 * This can be called while sk is owned by the caller only,
1740 * with no state that can be checked in a rcu_dereference_check() cond
1741 */
1742 old_dst = rcu_dereference_raw(sk->sk_dst_cache);
Eric Dumazetb6c67122010-04-08 23:03:29 +00001743 rcu_assign_pointer(sk->sk_dst_cache, dst);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001744 dst_release(old_dst);
1745}
1746
1747static inline void
1748sk_dst_set(struct sock *sk, struct dst_entry *dst)
1749{
Eric Dumazet7f502362014-06-30 01:26:23 -07001750 struct dst_entry *old_dst;
1751
1752 sk_tx_queue_clear(sk);
Eric Dumazet5925a052014-07-02 02:39:38 -07001753 old_dst = xchg((__force struct dst_entry **)&sk->sk_dst_cache, dst);
Eric Dumazet7f502362014-06-30 01:26:23 -07001754 dst_release(old_dst);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001755}
1756
1757static inline void
1758__sk_dst_reset(struct sock *sk)
1759{
Eric Dumazetb6c67122010-04-08 23:03:29 +00001760 __sk_dst_set(sk, NULL);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001761}
1762
1763static inline void
1764sk_dst_reset(struct sock *sk)
1765{
Eric Dumazet7f502362014-06-30 01:26:23 -07001766 sk_dst_set(sk, NULL);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001767}
1768
Joe Perches69336bd2013-09-22 10:32:26 -07001769struct dst_entry *__sk_dst_check(struct sock *sk, u32 cookie);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001770
Joe Perches69336bd2013-09-22 10:32:26 -07001771struct dst_entry *sk_dst_check(struct sock *sk, u32 cookie);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001772
hannes@stressinduktion.orgf60e5992015-04-01 17:07:44 +02001773bool sk_mc_loop(struct sock *sk);
1774
Eric Dumazetdc6b9b72012-05-16 22:48:15 +00001775static inline bool sk_can_gso(const struct sock *sk)
Herbert Xubcd76112006-06-30 13:36:35 -07001776{
1777 return net_gso_ok(sk->sk_route_caps, sk->sk_gso_type);
1778}
1779
Joe Perches69336bd2013-09-22 10:32:26 -07001780void sk_setup_caps(struct sock *sk, struct dst_entry *dst);
Arnaldo Carvalho de Melo6cbb0df2005-08-09 19:49:02 -07001781
Michał Mirosławc8f44af2011-11-15 15:29:55 +00001782static inline void sk_nocaps_add(struct sock *sk, netdev_features_t flags)
Eric Dumazeta4654192010-05-16 00:36:33 -07001783{
1784 sk->sk_route_nocaps |= flags;
1785 sk->sk_route_caps &= ~flags;
1786}
1787
Tom Herbert9a498502015-12-14 11:19:45 -08001788static inline bool sk_check_csum_caps(struct sock *sk)
1789{
1790 return (sk->sk_route_caps & NETIF_F_HW_CSUM) ||
1791 (sk->sk_family == PF_INET &&
1792 (sk->sk_route_caps & NETIF_F_IP_CSUM)) ||
1793 (sk->sk_family == PF_INET6 &&
1794 (sk->sk_route_caps & NETIF_F_IPV6_CSUM));
1795}
1796
Tom Herbertc6e1a0d2011-04-04 22:30:30 -07001797static inline int skb_do_copy_data_nocache(struct sock *sk, struct sk_buff *skb,
Al Viro57be5bd2014-11-28 13:40:20 -05001798 struct iov_iter *from, char *to,
Wei Yongjun912d3982011-04-06 18:40:12 +00001799 int copy, int offset)
Tom Herbertc6e1a0d2011-04-04 22:30:30 -07001800{
1801 if (skb->ip_summed == CHECKSUM_NONE) {
Al Viro57be5bd2014-11-28 13:40:20 -05001802 __wsum csum = 0;
1803 if (csum_and_copy_from_iter(to, copy, &csum, from) != copy)
1804 return -EFAULT;
Wei Yongjun912d3982011-04-06 18:40:12 +00001805 skb->csum = csum_block_add(skb->csum, csum, offset);
Tom Herbertc6e1a0d2011-04-04 22:30:30 -07001806 } else if (sk->sk_route_caps & NETIF_F_NOCACHE_COPY) {
Al Viro57be5bd2014-11-28 13:40:20 -05001807 if (copy_from_iter_nocache(to, copy, from) != copy)
Tom Herbertc6e1a0d2011-04-04 22:30:30 -07001808 return -EFAULT;
Al Viro57be5bd2014-11-28 13:40:20 -05001809 } else if (copy_from_iter(to, copy, from) != copy)
Tom Herbertc6e1a0d2011-04-04 22:30:30 -07001810 return -EFAULT;
1811
1812 return 0;
1813}
1814
1815static inline int skb_add_data_nocache(struct sock *sk, struct sk_buff *skb,
Al Viro57be5bd2014-11-28 13:40:20 -05001816 struct iov_iter *from, int copy)
Tom Herbertc6e1a0d2011-04-04 22:30:30 -07001817{
Wei Yongjun912d3982011-04-06 18:40:12 +00001818 int err, offset = skb->len;
Tom Herbertc6e1a0d2011-04-04 22:30:30 -07001819
Wei Yongjun912d3982011-04-06 18:40:12 +00001820 err = skb_do_copy_data_nocache(sk, skb, from, skb_put(skb, copy),
1821 copy, offset);
Tom Herbertc6e1a0d2011-04-04 22:30:30 -07001822 if (err)
Wei Yongjun912d3982011-04-06 18:40:12 +00001823 __skb_trim(skb, offset);
Tom Herbertc6e1a0d2011-04-04 22:30:30 -07001824
1825 return err;
1826}
1827
Al Viro57be5bd2014-11-28 13:40:20 -05001828static inline int skb_copy_to_page_nocache(struct sock *sk, struct iov_iter *from,
Tom Herbertc6e1a0d2011-04-04 22:30:30 -07001829 struct sk_buff *skb,
1830 struct page *page,
1831 int off, int copy)
1832{
1833 int err;
1834
Wei Yongjun912d3982011-04-06 18:40:12 +00001835 err = skb_do_copy_data_nocache(sk, skb, from, page_address(page) + off,
1836 copy, skb->len);
Tom Herbertc6e1a0d2011-04-04 22:30:30 -07001837 if (err)
1838 return err;
1839
1840 skb->len += copy;
1841 skb->data_len += copy;
1842 skb->truesize += copy;
1843 sk->sk_wmem_queued += copy;
1844 sk_mem_charge(sk, copy);
1845 return 0;
1846}
1847
Eric Dumazetc5640392009-06-16 10:12:03 +00001848/**
1849 * sk_wmem_alloc_get - returns write allocations
1850 * @sk: socket
1851 *
1852 * Returns sk_wmem_alloc minus initial offset of one
1853 */
1854static inline int sk_wmem_alloc_get(const struct sock *sk)
1855{
1856 return atomic_read(&sk->sk_wmem_alloc) - 1;
1857}
1858
1859/**
1860 * sk_rmem_alloc_get - returns read allocations
1861 * @sk: socket
1862 *
1863 * Returns sk_rmem_alloc
1864 */
1865static inline int sk_rmem_alloc_get(const struct sock *sk)
1866{
1867 return atomic_read(&sk->sk_rmem_alloc);
1868}
1869
1870/**
1871 * sk_has_allocations - check if allocations are outstanding
1872 * @sk: socket
1873 *
1874 * Returns true if socket has write or read allocations
1875 */
Eric Dumazetdc6b9b72012-05-16 22:48:15 +00001876static inline bool sk_has_allocations(const struct sock *sk)
Eric Dumazetc5640392009-06-16 10:12:03 +00001877{
1878 return sk_wmem_alloc_get(sk) || sk_rmem_alloc_get(sk);
1879}
1880
Jiri Olsaa57de0b2009-07-08 12:09:13 +00001881/**
Herbert Xu1ce0bf52015-11-26 13:55:39 +08001882 * skwq_has_sleeper - check if there are any waiting processes
Randy Dunlapacfbe962010-05-24 23:54:18 -07001883 * @wq: struct socket_wq
Jiri Olsaa57de0b2009-07-08 12:09:13 +00001884 *
Eric Dumazet43815482010-04-29 11:01:49 +00001885 * Returns true if socket_wq has waiting processes
Jiri Olsaa57de0b2009-07-08 12:09:13 +00001886 *
Herbert Xu1ce0bf52015-11-26 13:55:39 +08001887 * The purpose of the skwq_has_sleeper and sock_poll_wait is to wrap the memory
Jiri Olsaa57de0b2009-07-08 12:09:13 +00001888 * barrier call. They were added due to the race found within the tcp code.
1889 *
1890 * Consider following tcp code paths:
1891 *
1892 * CPU1 CPU2
1893 *
1894 * sys_select receive packet
1895 * ... ...
1896 * __add_wait_queue update tp->rcv_nxt
1897 * ... ...
1898 * tp->rcv_nxt check sock_def_readable
1899 * ... {
Eric Dumazet43815482010-04-29 11:01:49 +00001900 * schedule rcu_read_lock();
1901 * wq = rcu_dereference(sk->sk_wq);
1902 * if (wq && waitqueue_active(&wq->wait))
1903 * wake_up_interruptible(&wq->wait)
Jiri Olsaa57de0b2009-07-08 12:09:13 +00001904 * ...
1905 * }
1906 *
1907 * The race for tcp fires when the __add_wait_queue changes done by CPU1 stay
1908 * in its cache, and so does the tp->rcv_nxt update on CPU2 side. The CPU1
1909 * could then endup calling schedule and sleep forever if there are no more
1910 * data on the socket.
Jiri Olsaad462762009-07-08 12:10:31 +00001911 *
Jiri Olsaa57de0b2009-07-08 12:09:13 +00001912 */
Herbert Xu1ce0bf52015-11-26 13:55:39 +08001913static inline bool skwq_has_sleeper(struct socket_wq *wq)
Jiri Olsaa57de0b2009-07-08 12:09:13 +00001914{
Herbert Xu1ce0bf52015-11-26 13:55:39 +08001915 return wq && wq_has_sleeper(&wq->wait);
Jiri Olsaa57de0b2009-07-08 12:09:13 +00001916}
1917
1918/**
1919 * sock_poll_wait - place memory barrier behind the poll_wait call.
1920 * @filp: file
1921 * @wait_address: socket wait queue
1922 * @p: poll_table
1923 *
Eric Dumazet43815482010-04-29 11:01:49 +00001924 * See the comments in the wq_has_sleeper function.
Jiri Olsaa57de0b2009-07-08 12:09:13 +00001925 */
1926static inline void sock_poll_wait(struct file *filp,
1927 wait_queue_head_t *wait_address, poll_table *p)
1928{
Hans Verkuil626cf232012-03-23 15:02:27 -07001929 if (!poll_does_not_wait(p) && wait_address) {
Jiri Olsaa57de0b2009-07-08 12:09:13 +00001930 poll_wait(filp, wait_address, p);
Eric Dumazetdc6b9b72012-05-16 22:48:15 +00001931 /* We need to be sure we are in sync with the
Jiri Olsaa57de0b2009-07-08 12:09:13 +00001932 * socket flags modification.
1933 *
Eric Dumazet43815482010-04-29 11:01:49 +00001934 * This memory barrier is paired in the wq_has_sleeper.
Eric Dumazetdc6b9b72012-05-16 22:48:15 +00001935 */
Jiri Olsaa57de0b2009-07-08 12:09:13 +00001936 smp_mb();
1937 }
1938}
1939
Tom Herbertb73c3d02014-07-01 21:32:17 -07001940static inline void skb_set_hash_from_sk(struct sk_buff *skb, struct sock *sk)
1941{
Eric Dumazet7a442d42021-06-10 07:44:11 -07001942 /* This pairs with WRITE_ONCE() in sk_set_txhash() */
1943 u32 txhash = READ_ONCE(sk->sk_txhash);
1944
1945 if (txhash) {
Tom Herbertb73c3d02014-07-01 21:32:17 -07001946 skb->l4_hash = 1;
Eric Dumazet7a442d42021-06-10 07:44:11 -07001947 skb->hash = txhash;
Tom Herbertb73c3d02014-07-01 21:32:17 -07001948 }
1949}
1950
Eric Dumazet9e17f8a2015-11-01 15:36:55 -08001951void skb_set_owner_w(struct sk_buff *skb, struct sock *sk);
1952
Linus Torvalds1da177e2005-04-16 15:20:36 -07001953/*
Eric Dumazetdc6b9b72012-05-16 22:48:15 +00001954 * Queue a received datagram if it will fit. Stream and sequenced
Linus Torvalds1da177e2005-04-16 15:20:36 -07001955 * protocols can't normally use this as they need to fit buffers in
1956 * and play with them.
1957 *
Eric Dumazetdc6b9b72012-05-16 22:48:15 +00001958 * Inlined as it's very short and called for pretty much every
Linus Torvalds1da177e2005-04-16 15:20:36 -07001959 * packet ever received.
1960 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001961static inline void skb_set_owner_r(struct sk_buff *skb, struct sock *sk)
1962{
Herbert Xud55d87f2009-06-22 02:25:25 +00001963 skb_orphan(skb);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001964 skb->sk = sk;
1965 skb->destructor = sock_rfree;
1966 atomic_add(skb->truesize, &sk->sk_rmem_alloc);
Hideo Aoki3ab224b2007-12-31 00:11:19 -08001967 sk_mem_charge(sk, skb->truesize);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001968}
1969
Joe Perches69336bd2013-09-22 10:32:26 -07001970void sk_reset_timer(struct sock *sk, struct timer_list *timer,
1971 unsigned long expires);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001972
Joe Perches69336bd2013-09-22 10:32:26 -07001973void sk_stop_timer(struct sock *sk, struct timer_list *timer);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001974
samanthakumare6afc8a2016-04-05 12:41:15 -04001975int __sock_queue_rcv_skb(struct sock *sk, struct sk_buff *skb);
Joe Perches69336bd2013-09-22 10:32:26 -07001976int sock_queue_rcv_skb(struct sock *sk, struct sk_buff *skb);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001977
Joe Perches69336bd2013-09-22 10:32:26 -07001978int sock_queue_err_skb(struct sock *sk, struct sk_buff *skb);
Willem de Bruijn364a9e92014-08-31 21:30:27 -04001979struct sk_buff *sock_dequeue_err_skb(struct sock *sk);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001980
1981/*
1982 * Recover an error report and clear atomically
1983 */
Eric Dumazetdc6b9b72012-05-16 22:48:15 +00001984
Linus Torvalds1da177e2005-04-16 15:20:36 -07001985static inline int sock_error(struct sock *sk)
1986{
Benjamin LaHaisec1cbe4b2005-12-13 23:22:19 -08001987 int err;
1988 if (likely(!sk->sk_err))
1989 return 0;
1990 err = xchg(&sk->sk_err, 0);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001991 return -err;
1992}
1993
1994static inline unsigned long sock_wspace(struct sock *sk)
1995{
1996 int amt = 0;
1997
1998 if (!(sk->sk_shutdown & SEND_SHUTDOWN)) {
1999 amt = sk->sk_sndbuf - atomic_read(&sk->sk_wmem_alloc);
Eric Dumazetdc6b9b72012-05-16 22:48:15 +00002000 if (amt < 0)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002001 amt = 0;
2002 }
2003 return amt;
2004}
2005
Eric Dumazetceb5d582015-11-29 20:03:11 -08002006/* Note:
2007 * We use sk->sk_wq_raw, from contexts knowing this
2008 * pointer is not NULL and cannot disappear/change.
2009 */
Eric Dumazet9cd3e072015-11-29 20:03:10 -08002010static inline void sk_set_bit(int nr, struct sock *sk)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002011{
Eric Dumazet4be73522016-04-25 10:39:34 -07002012 if ((nr == SOCKWQ_ASYNC_NOSPACE || nr == SOCKWQ_ASYNC_WAITDATA) &&
2013 !sock_flag(sk, SOCK_FASYNC))
Eric Dumazet9317bb62016-04-25 10:39:32 -07002014 return;
2015
Eric Dumazetceb5d582015-11-29 20:03:11 -08002016 set_bit(nr, &sk->sk_wq_raw->flags);
Eric Dumazet9cd3e072015-11-29 20:03:10 -08002017}
2018
2019static inline void sk_clear_bit(int nr, struct sock *sk)
2020{
Eric Dumazet4be73522016-04-25 10:39:34 -07002021 if ((nr == SOCKWQ_ASYNC_NOSPACE || nr == SOCKWQ_ASYNC_WAITDATA) &&
2022 !sock_flag(sk, SOCK_FASYNC))
Eric Dumazet9317bb62016-04-25 10:39:32 -07002023 return;
2024
Eric Dumazetceb5d582015-11-29 20:03:11 -08002025 clear_bit(nr, &sk->sk_wq_raw->flags);
Eric Dumazet9cd3e072015-11-29 20:03:10 -08002026}
2027
Eric Dumazetceb5d582015-11-29 20:03:11 -08002028static inline void sk_wake_async(const struct sock *sk, int how, int band)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002029{
Eric Dumazetceb5d582015-11-29 20:03:11 -08002030 if (sock_flag(sk, SOCK_FASYNC)) {
2031 rcu_read_lock();
2032 sock_wake_async(rcu_dereference(sk->sk_wq), how, band);
2033 rcu_read_unlock();
2034 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002035}
2036
Daniel Borkmanneea86af2013-06-19 12:51:20 +02002037/* Since sk_{r,w}mem_alloc sums skb->truesize, even a small frame might
2038 * need sizeof(sk_buff) + MTU + padding, unless net driver perform copybreak.
2039 * Note: for send buffers, TCP works better if we can build two skbs at
2040 * minimum.
Eric Dumazet7a91b4342010-09-26 18:53:07 -07002041 */
Eric Dumazet9eb5bf82013-07-03 05:02:22 -07002042#define TCP_SKB_MIN_TRUESIZE (2048 + SKB_DATA_ALIGN(sizeof(struct sk_buff)))
Daniel Borkmanneea86af2013-06-19 12:51:20 +02002043
2044#define SOCK_MIN_SNDBUF (TCP_SKB_MIN_TRUESIZE * 2)
2045#define SOCK_MIN_RCVBUF TCP_SKB_MIN_TRUESIZE
Linus Torvalds1da177e2005-04-16 15:20:36 -07002046
2047static inline void sk_stream_moderate_sndbuf(struct sock *sk)
2048{
2049 if (!(sk->sk_userlocks & SOCK_SNDBUF_LOCK)) {
Eric Dumazet8df09ea2007-12-21 03:07:41 -08002050 sk->sk_sndbuf = min(sk->sk_sndbuf, sk->sk_wmem_queued >> 1);
Daniel Borkmanneea86af2013-06-19 12:51:20 +02002051 sk->sk_sndbuf = max_t(u32, sk->sk_sndbuf, SOCK_MIN_SNDBUF);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002052 }
2053}
2054
Eric Dumazeteb934472015-05-19 13:26:55 -07002055struct sk_buff *sk_stream_alloc_skb(struct sock *sk, int size, gfp_t gfp,
2056 bool force_schedule);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002057
Eric Dumazet5640f762012-09-23 23:04:42 +00002058/**
2059 * sk_page_frag - return an appropriate page_frag
2060 * @sk: socket
2061 *
Tejun Heo37d6ef42019-10-24 13:50:27 -07002062 * Use the per task page_frag instead of the per socket one for
2063 * optimization when we know that we're in the normal context and owns
2064 * everything that's associated with %current.
2065 *
2066 * gfpflags_allow_blocking() isn't enough here as direct reclaim may nest
2067 * inside other socket operations and end up recursing into sk_page_frag()
2068 * while it's already in use.
Eric Dumazet5640f762012-09-23 23:04:42 +00002069 */
2070static inline struct page_frag *sk_page_frag(struct sock *sk)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002071{
Tejun Heo37d6ef42019-10-24 13:50:27 -07002072 if (gfpflags_normal_context(sk->sk_allocation))
Eric Dumazet5640f762012-09-23 23:04:42 +00002073 return &current->task_frag;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002074
Eric Dumazet5640f762012-09-23 23:04:42 +00002075 return &sk->sk_frag;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002076}
2077
Joe Perches69336bd2013-09-22 10:32:26 -07002078bool sk_page_frag_refill(struct sock *sk, struct page_frag *pfrag);
Eric Dumazet5640f762012-09-23 23:04:42 +00002079
Linus Torvalds1da177e2005-04-16 15:20:36 -07002080/*
2081 * Default write policy as shown to user space via poll/select/SIGIO
2082 */
Eric Dumazetdc6b9b72012-05-16 22:48:15 +00002083static inline bool sock_writeable(const struct sock *sk)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002084{
Eric Dumazet8df09ea2007-12-21 03:07:41 -08002085 return atomic_read(&sk->sk_wmem_alloc) < (sk->sk_sndbuf >> 1);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002086}
2087
Al Virodd0fc662005-10-07 07:46:04 +01002088static inline gfp_t gfp_any(void)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002089{
Andrew Morton99709372009-02-12 16:43:17 -08002090 return in_softirq() ? GFP_ATOMIC : GFP_KERNEL;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002091}
2092
Eric Dumazetdc6b9b72012-05-16 22:48:15 +00002093static inline long sock_rcvtimeo(const struct sock *sk, bool noblock)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002094{
2095 return noblock ? 0 : sk->sk_rcvtimeo;
2096}
2097
Eric Dumazetdc6b9b72012-05-16 22:48:15 +00002098static inline long sock_sndtimeo(const struct sock *sk, bool noblock)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002099{
2100 return noblock ? 0 : sk->sk_sndtimeo;
2101}
2102
2103static inline int sock_rcvlowat(const struct sock *sk, int waitall, int len)
2104{
2105 return (waitall ? len : min_t(int, sk->sk_rcvlowat, len)) ? : 1;
2106}
2107
2108/* Alas, with timeout socket operations are not restartable.
2109 * Compare this to poll().
2110 */
2111static inline int sock_intr_errno(long timeo)
2112{
2113 return timeo == MAX_SCHEDULE_TIMEOUT ? -ERESTARTSYS : -EINTR;
2114}
2115
Eyal Birger744d5a32015-03-01 14:58:31 +02002116struct sock_skb_cb {
2117 u32 dropcount;
2118};
2119
2120/* Store sock_skb_cb at the end of skb->cb[] so protocol families
2121 * using skb->cb[] would keep using it directly and utilize its
2122 * alignement guarantee.
2123 */
2124#define SOCK_SKB_CB_OFFSET ((FIELD_SIZEOF(struct sk_buff, cb) - \
2125 sizeof(struct sock_skb_cb)))
2126
2127#define SOCK_SKB_CB(__skb) ((struct sock_skb_cb *)((__skb)->cb + \
2128 SOCK_SKB_CB_OFFSET))
2129
Eyal Birgerb4772ef2015-03-01 14:58:29 +02002130#define sock_skb_cb_check_size(size) \
Eyal Birger744d5a32015-03-01 14:58:31 +02002131 BUILD_BUG_ON((size) > SOCK_SKB_CB_OFFSET)
Eyal Birgerb4772ef2015-03-01 14:58:29 +02002132
Eyal Birger3bc3b962015-03-01 14:58:30 +02002133static inline void
2134sock_skb_set_dropcount(const struct sock *sk, struct sk_buff *skb)
2135{
Eyal Birger744d5a32015-03-01 14:58:31 +02002136 SOCK_SKB_CB(skb)->dropcount = atomic_read(&sk->sk_drops);
Eyal Birger3bc3b962015-03-01 14:58:30 +02002137}
2138
Eric Dumazet532182c2016-04-01 08:52:19 -07002139static inline void sk_drops_add(struct sock *sk, const struct sk_buff *skb)
2140{
2141 int segs = max_t(u16, 1, skb_shinfo(skb)->gso_segs);
2142
2143 atomic_add(segs, &sk->sk_drops);
2144}
2145
Deepa Dinamani7abb7f72018-12-27 18:55:09 -08002146static inline ktime_t sock_read_timestamp(struct sock *sk)
2147{
2148#if BITS_PER_LONG==32
2149 unsigned int seq;
2150 ktime_t kt;
2151
2152 do {
2153 seq = read_seqbegin(&sk->sk_stamp_seq);
2154 kt = sk->sk_stamp;
2155 } while (read_seqretry(&sk->sk_stamp_seq, seq));
2156
2157 return kt;
2158#else
Eric Dumazet4e8e9fd2019-11-04 21:38:43 -08002159 return READ_ONCE(sk->sk_stamp);
Deepa Dinamani7abb7f72018-12-27 18:55:09 -08002160#endif
2161}
2162
2163static inline void sock_write_timestamp(struct sock *sk, ktime_t kt)
2164{
2165#if BITS_PER_LONG==32
2166 write_seqlock(&sk->sk_stamp_seq);
2167 sk->sk_stamp = kt;
2168 write_sequnlock(&sk->sk_stamp_seq);
2169#else
Eric Dumazet4e8e9fd2019-11-04 21:38:43 -08002170 WRITE_ONCE(sk->sk_stamp, kt);
Deepa Dinamani7abb7f72018-12-27 18:55:09 -08002171#endif
2172}
2173
Joe Perches69336bd2013-09-22 10:32:26 -07002174void __sock_recv_timestamp(struct msghdr *msg, struct sock *sk,
2175 struct sk_buff *skb);
2176void __sock_recv_wifi_status(struct msghdr *msg, struct sock *sk,
2177 struct sk_buff *skb);
Eric Dumazet92f37fd2007-03-25 22:14:49 -07002178
Eric Dumazetdc6b9b72012-05-16 22:48:15 +00002179static inline void
Linus Torvalds1da177e2005-04-16 15:20:36 -07002180sock_recv_timestamp(struct msghdr *msg, struct sock *sk, struct sk_buff *skb)
2181{
Eric Dumazetb7aa0bf2007-04-19 16:16:32 -07002182 ktime_t kt = skb->tstamp;
Patrick Ohly20d49472009-02-12 05:03:38 +00002183 struct skb_shared_hwtstamps *hwtstamps = skb_hwtstamps(skb);
Patrick McHardya61bbcf2005-08-14 17:24:31 -07002184
Patrick Ohly20d49472009-02-12 05:03:38 +00002185 /*
2186 * generate control messages if
Willem de Bruijnb9f40e22014-08-04 22:11:46 -04002187 * - receive time stamping in software requested
Patrick Ohly20d49472009-02-12 05:03:38 +00002188 * - software time stamp available and wanted
Patrick Ohly20d49472009-02-12 05:03:38 +00002189 * - hardware time stamps available and wanted
Patrick Ohly20d49472009-02-12 05:03:38 +00002190 */
2191 if (sock_flag(sk, SOCK_RCVTSTAMP) ||
Willem de Bruijnb9f40e22014-08-04 22:11:46 -04002192 (sk->sk_tsflags & SOF_TIMESTAMPING_RX_SOFTWARE) ||
Willem de Bruijnc1991052014-09-03 12:01:18 -04002193 (kt.tv64 && sk->sk_tsflags & SOF_TIMESTAMPING_SOFTWARE) ||
Patrick Ohly20d49472009-02-12 05:03:38 +00002194 (hwtstamps->hwtstamp.tv64 &&
Willem de Bruijnb9f40e22014-08-04 22:11:46 -04002195 (sk->sk_tsflags & SOF_TIMESTAMPING_RAW_HARDWARE)))
Eric Dumazet92f37fd2007-03-25 22:14:49 -07002196 __sock_recv_timestamp(msg, sk, skb);
2197 else
Deepa Dinamani7abb7f72018-12-27 18:55:09 -08002198 sock_write_timestamp(sk, kt);
Johannes Berg6e3e9392011-11-09 10:15:42 +01002199
2200 if (sock_flag(sk, SOCK_WIFI_STATUS) && skb->wifi_acked_valid)
2201 __sock_recv_wifi_status(msg, sk, skb);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002202}
2203
Joe Perches69336bd2013-09-22 10:32:26 -07002204void __sock_recv_ts_and_drops(struct msghdr *msg, struct sock *sk,
2205 struct sk_buff *skb);
Eric Dumazet767dd032010-04-28 19:14:43 +00002206
2207static inline void sock_recv_ts_and_drops(struct msghdr *msg, struct sock *sk,
2208 struct sk_buff *skb)
2209{
2210#define FLAGS_TS_OR_DROPS ((1UL << SOCK_RXQ_OVFL) | \
Willem de Bruijnb9f40e22014-08-04 22:11:46 -04002211 (1UL << SOCK_RCVTSTAMP))
2212#define TSFLAGS_ANY (SOF_TIMESTAMPING_SOFTWARE | \
2213 SOF_TIMESTAMPING_RAW_HARDWARE)
Eric Dumazet767dd032010-04-28 19:14:43 +00002214
Willem de Bruijnb9f40e22014-08-04 22:11:46 -04002215 if (sk->sk_flags & FLAGS_TS_OR_DROPS || sk->sk_tsflags & TSFLAGS_ANY)
Eric Dumazet767dd032010-04-28 19:14:43 +00002216 __sock_recv_ts_and_drops(msg, sk, skb);
2217 else
Deepa Dinamani7abb7f72018-12-27 18:55:09 -08002218 sock_write_timestamp(sk, skb->tstamp);
Eric Dumazet767dd032010-04-28 19:14:43 +00002219}
Neil Horman3b885782009-10-12 13:26:31 -07002220
Soheil Hassas Yeganehc14ac942016-04-02 23:08:12 -04002221void __sock_tx_timestamp(__u16 tsflags, __u8 *tx_flags);
Willem de Bruijn67cc0d42014-09-08 19:58:58 -04002222
Linus Torvalds1da177e2005-04-16 15:20:36 -07002223/**
Patrick Ohly20d49472009-02-12 05:03:38 +00002224 * sock_tx_timestamp - checks whether the outgoing packet is to be time stamped
Patrick Ohly20d49472009-02-12 05:03:38 +00002225 * @sk: socket sending this packet
Soheil Hassas Yeganehc14ac942016-04-02 23:08:12 -04002226 * @tsflags: timestamping flags to use
Eric Dumazet140c55d2014-08-06 11:49:29 +02002227 * @tx_flags: completed with instructions for time stamping
2228 *
2229 * Note : callers should take care of initial *tx_flags value (usually 0)
Patrick Ohly20d49472009-02-12 05:03:38 +00002230 */
Soheil Hassas Yeganehc14ac942016-04-02 23:08:12 -04002231static inline void sock_tx_timestamp(const struct sock *sk, __u16 tsflags,
2232 __u8 *tx_flags)
Willem de Bruijn67cc0d42014-09-08 19:58:58 -04002233{
Soheil Hassas Yeganehc14ac942016-04-02 23:08:12 -04002234 if (unlikely(tsflags))
2235 __sock_tx_timestamp(tsflags, tx_flags);
Willem de Bruijn67cc0d42014-09-08 19:58:58 -04002236 if (unlikely(sock_flag(sk, SOCK_WIFI_STATUS)))
2237 *tx_flags |= SKBTX_WIFI_STATUS;
2238}
Patrick Ohly20d49472009-02-12 05:03:38 +00002239
2240/**
Linus Torvalds1da177e2005-04-16 15:20:36 -07002241 * sk_eat_skb - Release a skb if it is no longer needed
Pavel Pisa4dc3b162005-05-01 08:59:25 -07002242 * @sk: socket to eat this skb from
2243 * @skb: socket buffer to eat
Linus Torvalds1da177e2005-04-16 15:20:36 -07002244 *
2245 * This routine must be called with interrupts disabled or with the socket
2246 * locked so that the sk_buff queue operation is ok.
2247*/
Dan Williams7bced392013-12-30 12:37:29 -08002248static inline void sk_eat_skb(struct sock *sk, struct sk_buff *skb)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002249{
2250 __skb_unlink(skb, &sk->sk_receive_queue);
2251 __kfree_skb(skb);
2252}
2253
YOSHIFUJI Hideaki3b1e0a62008-03-26 02:26:21 +09002254static inline
2255struct net *sock_net(const struct sock *sk)
2256{
Eric Dumazetc2d9ba92010-06-01 06:51:19 +00002257 return read_pnet(&sk->sk_net);
YOSHIFUJI Hideaki3b1e0a62008-03-26 02:26:21 +09002258}
2259
2260static inline
Denis V. Lunevf5aa23f2008-03-26 00:48:17 -07002261void sock_net_set(struct sock *sk, struct net *net)
YOSHIFUJI Hideaki3b1e0a62008-03-26 02:26:21 +09002262{
Eric Dumazetc2d9ba92010-06-01 06:51:19 +00002263 write_pnet(&sk->sk_net, net);
YOSHIFUJI Hideaki3b1e0a62008-03-26 02:26:21 +09002264}
2265
KOVACS Krisztian23542612008-10-07 12:41:01 -07002266static inline struct sock *skb_steal_sock(struct sk_buff *skb)
2267{
Vijay Subramanianefc27f82012-06-24 13:03:07 +00002268 if (skb->sk) {
KOVACS Krisztian23542612008-10-07 12:41:01 -07002269 struct sock *sk = skb->sk;
2270
2271 skb->destructor = NULL;
2272 skb->sk = NULL;
2273 return sk;
2274 }
2275 return NULL;
2276}
2277
Eric Dumazet1d0ab252015-03-15 21:12:12 -07002278/* This helper checks if a socket is a full socket,
2279 * ie _not_ a timewait or request socket.
2280 */
2281static inline bool sk_fullsock(const struct sock *sk)
2282{
2283 return (1 << sk->sk_state) & ~(TCPF_TIME_WAIT | TCPF_NEW_SYN_RECV);
2284}
2285
Eric Dumazete446f9d2015-10-08 05:01:55 -07002286/* This helper checks if a socket is a LISTEN or NEW_SYN_RECV
2287 * SYNACK messages can be attached to either ones (depending on SYNCOOKIE)
2288 */
2289static inline bool sk_listener(const struct sock *sk)
2290{
2291 return (1 << sk->sk_state) & (TCPF_LISTEN | TCPF_NEW_SYN_RECV);
2292}
2293
Eric Dumazet00fd38d2015-11-12 08:43:18 -08002294/**
2295 * sk_state_load - read sk->sk_state for lockless contexts
2296 * @sk: socket pointer
2297 *
2298 * Paired with sk_state_store(). Used in places we do not hold socket lock :
2299 * tcp_diag_get_info(), tcp_get_info(), tcp_poll(), get_tcp4_sock() ...
2300 */
2301static inline int sk_state_load(const struct sock *sk)
2302{
2303 return smp_load_acquire(&sk->sk_state);
2304}
2305
2306/**
2307 * sk_state_store - update sk->sk_state
2308 * @sk: socket pointer
2309 * @newstate: new state
2310 *
2311 * Paired with sk_state_load(). Should be used in contexts where
2312 * state change might impact lockless readers.
2313 */
2314static inline void sk_state_store(struct sock *sk, int newstate)
2315{
2316 smp_store_release(&sk->sk_state, newstate);
2317}
2318
Joe Perches69336bd2013-09-22 10:32:26 -07002319void sock_enable_timestamp(struct sock *sk, int flag);
2320int sock_get_timestamp(struct sock *, struct timeval __user *);
2321int sock_get_timestampns(struct sock *, struct timespec __user *);
2322int sock_recv_errqueue(struct sock *sk, struct msghdr *msg, int len, int level,
2323 int type);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002324
Eric W. Biedermana3b299d2014-04-23 14:26:56 -07002325bool sk_ns_capable(const struct sock *sk,
2326 struct user_namespace *user_ns, int cap);
2327bool sk_capable(const struct sock *sk, int cap);
2328bool sk_net_capable(const struct sock *sk, int cap);
2329
Linus Torvalds1da177e2005-04-16 15:20:36 -07002330extern __u32 sysctl_wmem_max;
2331extern __u32 sysctl_rmem_max;
2332
Willem de Bruijnb245be12015-01-30 13:29:32 -05002333extern int sysctl_tstamp_allow_data;
David S. Miller6baf1f42005-09-05 18:14:11 -07002334extern int sysctl_optmem_max;
2335
Arnaldo Carvalho de Melo20380732005-08-16 02:18:02 -03002336extern __u32 sysctl_wmem_default;
2337extern __u32 sysctl_rmem_default;
Arnaldo Carvalho de Melo20380732005-08-16 02:18:02 -03002338
Linus Torvalds1da177e2005-04-16 15:20:36 -07002339#endif /* _SOCK_H */