]> git.proxmox.com Git - mirror_ubuntu-bionic-kernel.git/blame - include/net/sock.h
tcp: tcp_mtu_probe() is likely to exit early
[mirror_ubuntu-bionic-kernel.git] / include / net / sock.h
CommitLineData
1da177e4
LT
1/*
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 *
02c30a84 10 * Authors: Ross Biro
1da177e4
LT
11 * 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
a6b7a407 43#include <linux/hardirq.h>
172589cc 44#include <linux/kernel.h>
1da177e4 45#include <linux/list.h>
88ab1932 46#include <linux/list_nulls.h>
1da177e4
LT
47#include <linux/timer.h>
48#include <linux/cache.h>
3f134619 49#include <linux/bitops.h>
a5b5bb9a 50#include <linux/lockdep.h>
1da177e4
LT
51#include <linux/netdevice.h>
52#include <linux/skbuff.h> /* struct sk_buff */
d7fe0f24 53#include <linux/mm.h>
1da177e4 54#include <linux/security.h>
5a0e3ad6 55#include <linux/slab.h>
c6e1a0d1 56#include <linux/uaccess.h>
3e32cb2e 57#include <linux/page_counter.h>
180d8cd9 58#include <linux/memcontrol.h>
c5905afb 59#include <linux/static_key.h>
40401530 60#include <linux/sched.h>
1ce0bf50 61#include <linux/wait.h>
2a56a1fe 62#include <linux/cgroup-defs.h>
1da177e4
LT
63
64#include <linux/filter.h>
88ab1932 65#include <linux/rculist_nulls.h>
a57de0b4 66#include <linux/poll.h>
1da177e4 67
c31504dc 68#include <linux/atomic.h>
1da177e4
LT
69#include <net/dst.h>
70#include <net/checksum.h>
1d0ab253 71#include <net/tcp_states.h>
b9f40e21 72#include <linux/net_tstamp.h>
1da177e4
LT
73
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
4cd9029d 86/* Validate arguments and do nothing */
b9075fa9 87static inline __printf(2, 3)
dc6b9b78 88void SOCK_DEBUG(const struct sock *sk, const char *msg, ...)
4cd9029d
SH
89{
90}
1da177e4
LT
91#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 */
1da177e4
LT
97typedef struct {
98 spinlock_t slock;
d2e9117c 99 int owned;
1da177e4 100 wait_queue_head_t wq;
a5b5bb9a
IM
101 /*
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
1da177e4
LT
110} socket_lock_t;
111
1da177e4 112struct sock;
8feaf0c0 113struct proto;
0eeb8ffc 114struct net;
1da177e4 115
077b393d
ED
116typedef __u32 __bitwise __portpair;
117typedef __u64 __bitwise __addrpair;
118
1da177e4 119/**
4dc3b16b 120 * struct sock_common - minimal network layer representation of sockets
68835aba
ED
121 * @skc_daddr: Foreign IPv4 addr
122 * @skc_rcv_saddr: Bound local IPv4 addr
4dc6dc71 123 * @skc_hash: hash value used with various protocol lookup tables
d4cada4a 124 * @skc_u16hashes: two u16 hash values used by UDP lookup tables
ce43b03e
ED
125 * @skc_dport: placeholder for inet_dport/tw_dport
126 * @skc_num: placeholder for inet_num/tw_num
4dc3b16b
PP
127 * @skc_family: network address family
128 * @skc_state: Connection state
129 * @skc_reuse: %SO_REUSEADDR setting
055dc21a 130 * @skc_reuseport: %SO_REUSEPORT setting
4dc3b16b 131 * @skc_bound_dev_if: bound device index if != 0
4dc3b16b 132 * @skc_bind_node: bind hash linkage for various protocol lookup tables
512615b6 133 * @skc_portaddr_node: second hash linkage for UDP/UDP-Lite protocol
8feaf0c0 134 * @skc_prot: protocol handlers inside a network family
07feaebf 135 * @skc_net: reference to the network namespace of this socket
68835aba
ED
136 * @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
8e5eb54d
ED
139 * @skc_flags: place holder for sk_flags
140 * %SO_LINGER (l_onoff), %SO_BROADCAST, %SO_KEEPALIVE,
141 * %SO_OOBINLINE settings, %SO_TIMESTAMPING settings
70da268b 142 * @skc_incoming_cpu: record/match cpu processing incoming packets
68835aba 143 * @skc_refcnt: reference count
4dc3b16b
PP
144 *
145 * This is the minimal network layer representation of sockets, the header
8feaf0c0
ACM
146 * for struct sock and struct inet_timewait_sock.
147 */
1da177e4 148struct sock_common {
ce43b03e 149 /* skc_daddr and skc_rcv_saddr must be grouped on a 8 bytes aligned
05dbc7b5 150 * address on 64bit arches : cf INET_MATCH()
4dc6dc71 151 */
ce43b03e 152 union {
077b393d 153 __addrpair skc_addrpair;
ce43b03e
ED
154 struct {
155 __be32 skc_daddr;
156 __be32 skc_rcv_saddr;
157 };
158 };
d4cada4a
ED
159 union {
160 unsigned int skc_hash;
161 __u16 skc_u16hashes[2];
162 };
ce43b03e
ED
163 /* skc_dport && skc_num must be grouped as well */
164 union {
077b393d 165 __portpair skc_portpair;
ce43b03e
ED
166 struct {
167 __be16 skc_dport;
168 __u16 skc_num;
169 };
170 };
171
4dc6dc71
ED
172 unsigned short skc_family;
173 volatile unsigned char skc_state;
055dc21a 174 unsigned char skc_reuse:4;
9fe516ba
ED
175 unsigned char skc_reuseport:1;
176 unsigned char skc_ipv6only:1;
26abe143 177 unsigned char skc_net_refcnt:1;
4dc6dc71 178 int skc_bound_dev_if;
512615b6
ED
179 union {
180 struct hlist_node skc_bind_node;
ca065d0c 181 struct hlist_node skc_portaddr_node;
512615b6 182 };
8feaf0c0 183 struct proto *skc_prot;
0c5c9fb5 184 possible_net_t skc_net;
efe4208f
ED
185
186#if IS_ENABLED(CONFIG_IPV6)
187 struct in6_addr skc_v6_daddr;
188 struct in6_addr skc_v6_rcv_saddr;
189#endif
190
33cf7c90
ED
191 atomic64_t skc_cookie;
192
8e5eb54d
ED
193 /* 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 };
68835aba
ED
203 /*
204 * fields between dontcopy_begin/dontcopy_end
205 * are not copied in sock_copy()
206 */
928c41e7 207 /* private: */
68835aba 208 int skc_dontcopy_begin[0];
928c41e7 209 /* public: */
68835aba
ED
210 union {
211 struct hlist_node skc_node;
212 struct hlist_nulls_node skc_nulls_node;
213 };
214 int skc_tx_queue_mapping;
ed53d0ab
ED
215 union {
216 int skc_incoming_cpu;
217 u32 skc_rcv_wnd;
d475f090 218 u32 skc_tw_rcv_nxt; /* struct tcp_timewait_sock */
ed53d0ab 219 };
70da268b 220
68835aba 221 atomic_t skc_refcnt;
928c41e7 222 /* private: */
68835aba 223 int skc_dontcopy_end[0];
ed53d0ab
ED
224 union {
225 u32 skc_rxhash;
226 u32 skc_window_clamp;
d475f090 227 u32 skc_tw_snd_nxt; /* struct tcp_timewait_sock */
ed53d0ab 228 };
928c41e7 229 /* public: */
1da177e4
LT
230};
231
232/**
233 * struct sock - network layer representation of sockets
8feaf0c0 234 * @__sk_common: shared layout with inet_timewait_sock
4dc3b16b
PP
235 * @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
43815482 239 * @sk_wq: sock wait queue and async head
421b3885 240 * @sk_rx_dst: receive input route used by early demux
4dc3b16b 241 * @sk_dst_cache: destination cache
4dc3b16b 242 * @sk_policy: flow policy
4dc3b16b
PP
243 * @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
06021292 249 * @sk_napi_id: id of the last napi context to receive data for sk
dafcc438 250 * @sk_ll_usec: usecs to busypoll when there is no data
4dc3b16b 251 * @sk_allocation: allocation mode
95bd09eb 252 * @sk_pacing_rate: Pacing rate (if supported by transport/packet scheduler)
c3f40d7c 253 * @sk_max_pacing_rate: Maximum pacing rate (%SO_MAX_PACING_RATE)
4dc3b16b 254 * @sk_sndbuf: size of send buffer in bytes
293de7de 255 * @sk_padding: unused element for alignment
28448b80
TH
256 * @sk_no_check_tx: %SO_NO_CHECK setting, set checksum in TX packets
257 * @sk_no_check_rx: allow zero checksum in RX packets
4dc3b16b 258 * @sk_route_caps: route capabilities (e.g. %NETIF_F_TSO)
a465419b 259 * @sk_route_nocaps: forbidden route capabilities (e.g NETIF_F_GSO_MASK)
bcd76111 260 * @sk_gso_type: GSO type (e.g. %SKB_GSO_TCPV4)
82cc1a7a 261 * @sk_gso_max_size: Maximum GSO segment size to build
1485348d 262 * @sk_gso_max_segs: Maximum number of GSO segments
4dc3b16b 263 * @sk_lingertime: %SO_LINGER l_linger setting
4dc3b16b
PP
264 * @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
33c732c3
WC
267 * @sk_prot_creator: sk_prot of original sock creator (see ipv6_setsockopt,
268 * IPV6_ADDRFORM for instance)
4dc3b16b 269 * @sk_err: last error
33c732c3
WC
270 * @sk_err_soft: errors that don't cause failure but are the cause of a
271 * persistent failure not just 'timed out'
cb61cb9b 272 * @sk_drops: raw/udp drops counter
4dc3b16b
PP
273 * @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
53c3fa20
RD
278 * @sk_peer_pid: &struct pid for this socket's peer
279 * @sk_peer_cred: %SO_PEERCRED setting
4dc3b16b
PP
280 * @sk_rcvlowat: %SO_RCVLOWAT setting
281 * @sk_rcvtimeo: %SO_RCVTIMEO setting
282 * @sk_sndtimeo: %SO_SNDTIMEO setting
b73c3d0e 283 * @sk_txhash: computed flow hash for use on transmit
4dc3b16b 284 * @sk_filter: socket filtering instructions
4dc3b16b
PP
285 * @sk_timer: sock cleanup timer
286 * @sk_stamp: time stamp of last packet received
b9f40e21 287 * @sk_tsflags: SO_TIMESTAMPING socket options
09c2d251 288 * @sk_tskey: counter to disambiguate concurrent tstamp requests
4dc3b16b
PP
289 * @sk_socket: Identd and reporting IO signals
290 * @sk_user_data: RPC layer private data
5640f768 291 * @sk_frag: cached page frag
d3d4f0a0 292 * @sk_peek_off: current peek_offset value
4dc3b16b 293 * @sk_send_head: front of stuff to transmit
67be2dd1 294 * @sk_security: used by security modules
31729363 295 * @sk_mark: generic packet mark
2a56a1fe 296 * @sk_cgrp_data: cgroup data for this cgroup
baac50bb 297 * @sk_memcg: this socket's memory cgroup association
4dc3b16b
PP
298 * @sk_write_pending: a write to stream socket waits to start
299 * @sk_state_change: callback to indicate change in the state of the sock
300 * @sk_data_ready: callback to indicate there is data to be processed
301 * @sk_write_space: callback to indicate there is bf sending space available
302 * @sk_error_report: callback to indicate errors (e.g. %MSG_ERRQUEUE)
303 * @sk_backlog_rcv: callback to process the backlog
304 * @sk_destruct: called at sock freeing time, i.e. when all refcnt == 0
ef456144 305 * @sk_reuseport_cb: reuseport group container
293de7de
SH
306 * @sk_rcu: used during RCU grace period
307 */
1da177e4
LT
308struct sock {
309 /*
8feaf0c0 310 * Now struct inet_timewait_sock also uses sock_common, so please just
1da177e4
LT
311 * don't add nothing before this first member (__sk_common) --acme
312 */
313 struct sock_common __sk_common;
4dc6dc71
ED
314#define sk_node __sk_common.skc_node
315#define sk_nulls_node __sk_common.skc_nulls_node
316#define sk_refcnt __sk_common.skc_refcnt
e022f0b4 317#define sk_tx_queue_mapping __sk_common.skc_tx_queue_mapping
4dc6dc71 318
68835aba
ED
319#define sk_dontcopy_begin __sk_common.skc_dontcopy_begin
320#define sk_dontcopy_end __sk_common.skc_dontcopy_end
4dc6dc71 321#define sk_hash __sk_common.skc_hash
50805466 322#define sk_portpair __sk_common.skc_portpair
05dbc7b5
ED
323#define sk_num __sk_common.skc_num
324#define sk_dport __sk_common.skc_dport
50805466
ED
325#define sk_addrpair __sk_common.skc_addrpair
326#define sk_daddr __sk_common.skc_daddr
327#define sk_rcv_saddr __sk_common.skc_rcv_saddr
1da177e4
LT
328#define sk_family __sk_common.skc_family
329#define sk_state __sk_common.skc_state
330#define sk_reuse __sk_common.skc_reuse
055dc21a 331#define sk_reuseport __sk_common.skc_reuseport
9fe516ba 332#define sk_ipv6only __sk_common.skc_ipv6only
26abe143 333#define sk_net_refcnt __sk_common.skc_net_refcnt
1da177e4 334#define sk_bound_dev_if __sk_common.skc_bound_dev_if
1da177e4 335#define sk_bind_node __sk_common.skc_bind_node
8feaf0c0 336#define sk_prot __sk_common.skc_prot
07feaebf 337#define sk_net __sk_common.skc_net
efe4208f
ED
338#define sk_v6_daddr __sk_common.skc_v6_daddr
339#define sk_v6_rcv_saddr __sk_common.skc_v6_rcv_saddr
33cf7c90 340#define sk_cookie __sk_common.skc_cookie
70da268b 341#define sk_incoming_cpu __sk_common.skc_incoming_cpu
8e5eb54d 342#define sk_flags __sk_common.skc_flags
ed53d0ab 343#define sk_rxhash __sk_common.skc_rxhash
efe4208f 344
1da177e4 345 socket_lock_t sk_lock;
b178bb3d 346 struct sk_buff_head sk_receive_queue;
fa438ccf
ED
347 /*
348 * The backlog queue is special, it is always used with
349 * the per-socket spinlock held and requires low latency
350 * access. Therefore we special case it's implementation.
b178bb3d
ED
351 * Note : rmem_alloc is in this structure to fill a hole
352 * on 64bit arches, not because its logically part of
353 * backlog.
fa438ccf
ED
354 */
355 struct {
b178bb3d
ED
356 atomic_t rmem_alloc;
357 int len;
358 struct sk_buff *head;
359 struct sk_buff *tail;
fa438ccf 360 } sk_backlog;
b178bb3d
ED
361#define sk_rmem_alloc sk_backlog.rmem_alloc
362 int sk_forward_alloc;
2c8c56e1 363
b73c3d0e 364 __u32 sk_txhash;
e0d1095a 365#ifdef CONFIG_NET_RX_BUSY_POLL
06021292 366 unsigned int sk_napi_id;
dafcc438 367 unsigned int sk_ll_usec;
b178bb3d
ED
368#endif
369 atomic_t sk_drops;
370 int sk_rcvbuf;
371
372 struct sk_filter __rcu *sk_filter;
ceb5d58b
ED
373 union {
374 struct socket_wq __rcu *sk_wq;
375 struct socket_wq *sk_wq_raw;
376 };
def8b4fa 377#ifdef CONFIG_XFRM
d188ba86 378 struct xfrm_policy __rcu *sk_policy[2];
def8b4fa 379#endif
deaa5854 380 struct dst_entry *sk_rx_dst;
0e36cbb3 381 struct dst_entry __rcu *sk_dst_cache;
6bd4f355 382 /* Note: 32bit hole on 64bit arches */
1da177e4
LT
383 atomic_t sk_wmem_alloc;
384 atomic_t sk_omem_alloc;
4e07a91c 385 int sk_sndbuf;
1da177e4 386 struct sk_buff_head sk_write_queue;
fc64869c
AR
387
388 /*
389 * Because of non atomicity rules, all
390 * changes are protected by socket lock.
391 */
aa4c1037
DA
392 unsigned int __sk_flags_offset[0];
393#ifdef __BIG_ENDIAN_BITFIELD
394#define SK_FL_PROTO_SHIFT 16
395#define SK_FL_PROTO_MASK 0x00ff0000
396
397#define SK_FL_TYPE_SHIFT 0
398#define SK_FL_TYPE_MASK 0x0000ffff
399#else
400#define SK_FL_PROTO_SHIFT 8
401#define SK_FL_PROTO_MASK 0x0000ff00
402
403#define SK_FL_TYPE_SHIFT 16
404#define SK_FL_TYPE_MASK 0xffff0000
405#endif
406
b178bb3d 407 kmemcheck_bitfield_begin(flags);
fc64869c 408 unsigned int sk_padding : 2,
28448b80
TH
409 sk_no_check_tx : 1,
410 sk_no_check_rx : 1,
b178bb3d
ED
411 sk_userlocks : 4,
412 sk_protocol : 8,
413 sk_type : 16;
7bbadd2d 414#define SK_PROTOCOL_MAX U8_MAX
b178bb3d 415 kmemcheck_bitfield_end(flags);
fc64869c 416
1da177e4 417 int sk_wmem_queued;
7d877f3b 418 gfp_t sk_allocation;
95bd09eb 419 u32 sk_pacing_rate; /* bytes per second */
62748f32 420 u32 sk_max_pacing_rate;
c8f44aff
MM
421 netdev_features_t sk_route_caps;
422 netdev_features_t sk_route_nocaps;
bcd76111 423 int sk_gso_type;
82cc1a7a 424 unsigned int sk_gso_max_size;
1485348d 425 u16 sk_gso_max_segs;
9932cf95 426 int sk_rcvlowat;
1da177e4 427 unsigned long sk_lingertime;
1da177e4 428 struct sk_buff_head sk_error_queue;
476e19cf 429 struct proto *sk_prot_creator;
1da177e4
LT
430 rwlock_t sk_callback_lock;
431 int sk_err,
432 sk_err_soft;
becb74f0
ED
433 u32 sk_ack_backlog;
434 u32 sk_max_ack_backlog;
1da177e4 435 __u32 sk_priority;
297dbde1 436 __u32 sk_mark;
86741ec2 437 kuid_t sk_uid;
109f6e39
EB
438 struct pid *sk_peer_pid;
439 const struct cred *sk_peer_cred;
1da177e4
LT
440 long sk_rcvtimeo;
441 long sk_sndtimeo;
1da177e4 442 struct timer_list sk_timer;
b7aa0bf7 443 ktime_t sk_stamp;
b9f40e21 444 u16 sk_tsflags;
fc64869c 445 u8 sk_shutdown;
09c2d251 446 u32 sk_tskey;
1da177e4
LT
447 struct socket *sk_socket;
448 void *sk_user_data;
5640f768 449 struct page_frag sk_frag;
1da177e4 450 struct sk_buff *sk_send_head;
ef64a54f 451 __s32 sk_peek_off;
1da177e4 452 int sk_write_pending;
d5f64238 453#ifdef CONFIG_SECURITY
1da177e4 454 void *sk_security;
d5f64238 455#endif
2a56a1fe 456 struct sock_cgroup_data sk_cgrp_data;
baac50bb 457 struct mem_cgroup *sk_memcg;
1da177e4 458 void (*sk_state_change)(struct sock *sk);
676d2369 459 void (*sk_data_ready)(struct sock *sk);
1da177e4
LT
460 void (*sk_write_space)(struct sock *sk);
461 void (*sk_error_report)(struct sock *sk);
dc6b9b78
ED
462 int (*sk_backlog_rcv)(struct sock *sk,
463 struct sk_buff *skb);
1da177e4 464 void (*sk_destruct)(struct sock *sk);
ef456144 465 struct sock_reuseport __rcu *sk_reuseport_cb;
a4298e45 466 struct rcu_head sk_rcu;
1da177e4
LT
467};
468
559835ea
PS
469#define __sk_user_data(sk) ((*((void __rcu **)&(sk)->sk_user_data)))
470
471#define rcu_dereference_sk_user_data(sk) rcu_dereference(__sk_user_data((sk)))
472#define rcu_assign_sk_user_data(sk, ptr) rcu_assign_pointer(__sk_user_data((sk)), ptr)
473
4a17fd52
PE
474/*
475 * SK_CAN_REUSE and SK_NO_REUSE on a socket mean that the socket is OK
476 * or not whether his port will be reused by someone else. SK_FORCE_REUSE
477 * on a socket means that the socket will reuse everybody else's port
478 * without looking at the other's sk_reuse value.
479 */
480
481#define SK_NO_REUSE 0
482#define SK_CAN_REUSE 1
483#define SK_FORCE_REUSE 2
484
627d2d6b 485int sk_set_peek_off(struct sock *sk, int val);
486
ef64a54f
PE
487static inline int sk_peek_offset(struct sock *sk, int flags)
488{
b9bb53f3
WB
489 if (unlikely(flags & MSG_PEEK)) {
490 s32 off = READ_ONCE(sk->sk_peek_off);
491 if (off >= 0)
492 return off;
493 }
494
495 return 0;
ef64a54f
PE
496}
497
498static inline void sk_peek_offset_bwd(struct sock *sk, int val)
499{
b9bb53f3
WB
500 s32 off = READ_ONCE(sk->sk_peek_off);
501
502 if (unlikely(off >= 0)) {
503 off = max_t(s32, off - val, 0);
504 WRITE_ONCE(sk->sk_peek_off, off);
ef64a54f
PE
505 }
506}
507
508static inline void sk_peek_offset_fwd(struct sock *sk, int val)
509{
b9bb53f3 510 sk_peek_offset_bwd(sk, -val);
ef64a54f
PE
511}
512
1da177e4
LT
513/*
514 * Hashed lists helper routines
515 */
c4146644
LZ
516static inline struct sock *sk_entry(const struct hlist_node *node)
517{
518 return hlist_entry(node, struct sock, sk_node);
519}
520
e48c414e 521static inline struct sock *__sk_head(const struct hlist_head *head)
1da177e4
LT
522{
523 return hlist_entry(head->first, struct sock, sk_node);
524}
525
e48c414e 526static inline struct sock *sk_head(const struct hlist_head *head)
1da177e4
LT
527{
528 return hlist_empty(head) ? NULL : __sk_head(head);
529}
530
88ab1932
ED
531static inline struct sock *__sk_nulls_head(const struct hlist_nulls_head *head)
532{
533 return hlist_nulls_entry(head->first, struct sock, sk_nulls_node);
534}
535
536static inline struct sock *sk_nulls_head(const struct hlist_nulls_head *head)
537{
538 return hlist_nulls_empty(head) ? NULL : __sk_nulls_head(head);
539}
540
e48c414e 541static inline struct sock *sk_next(const struct sock *sk)
1da177e4
LT
542{
543 return sk->sk_node.next ?
544 hlist_entry(sk->sk_node.next, struct sock, sk_node) : NULL;
545}
546
88ab1932
ED
547static inline struct sock *sk_nulls_next(const struct sock *sk)
548{
549 return (!is_a_nulls(sk->sk_nulls_node.next)) ?
550 hlist_nulls_entry(sk->sk_nulls_node.next,
551 struct sock, sk_nulls_node) :
552 NULL;
553}
554
dc6b9b78 555static inline bool sk_unhashed(const struct sock *sk)
1da177e4
LT
556{
557 return hlist_unhashed(&sk->sk_node);
558}
559
dc6b9b78 560static inline bool sk_hashed(const struct sock *sk)
1da177e4 561{
da753bea 562 return !sk_unhashed(sk);
1da177e4
LT
563}
564
dc6b9b78 565static inline void sk_node_init(struct hlist_node *node)
1da177e4
LT
566{
567 node->pprev = NULL;
568}
569
dc6b9b78 570static inline void sk_nulls_node_init(struct hlist_nulls_node *node)
88ab1932
ED
571{
572 node->pprev = NULL;
573}
574
dc6b9b78 575static inline void __sk_del_node(struct sock *sk)
1da177e4
LT
576{
577 __hlist_del(&sk->sk_node);
578}
579
808f5114 580/* NB: equivalent to hlist_del_init_rcu */
dc6b9b78 581static inline bool __sk_del_node_init(struct sock *sk)
1da177e4
LT
582{
583 if (sk_hashed(sk)) {
584 __sk_del_node(sk);
585 sk_node_init(&sk->sk_node);
dc6b9b78 586 return true;
1da177e4 587 }
dc6b9b78 588 return false;
1da177e4
LT
589}
590
591/* Grab socket reference count. This operation is valid only
592 when sk is ALREADY grabbed f.e. it is found in hash table
593 or a list and the lookup is made under lock preventing hash table
594 modifications.
595 */
596
f9a7cbbf 597static __always_inline void sock_hold(struct sock *sk)
1da177e4
LT
598{
599 atomic_inc(&sk->sk_refcnt);
600}
601
602/* Ungrab socket in the context, which assumes that socket refcnt
603 cannot hit zero, f.e. it is true in context of any socketcall.
604 */
f9a7cbbf 605static __always_inline void __sock_put(struct sock *sk)
1da177e4
LT
606{
607 atomic_dec(&sk->sk_refcnt);
608}
609
dc6b9b78 610static inline bool sk_del_node_init(struct sock *sk)
1da177e4 611{
dc6b9b78 612 bool rc = __sk_del_node_init(sk);
1da177e4
LT
613
614 if (rc) {
615 /* paranoid for a while -acme */
616 WARN_ON(atomic_read(&sk->sk_refcnt) == 1);
617 __sock_put(sk);
618 }
619 return rc;
620}
808f5114 621#define sk_del_node_init_rcu(sk) sk_del_node_init(sk)
1da177e4 622
dc6b9b78 623static inline bool __sk_nulls_del_node_init_rcu(struct sock *sk)
271b72c7
ED
624{
625 if (sk_hashed(sk)) {
88ab1932 626 hlist_nulls_del_init_rcu(&sk->sk_nulls_node);
dc6b9b78 627 return true;
271b72c7 628 }
dc6b9b78 629 return false;
271b72c7
ED
630}
631
dc6b9b78 632static inline bool sk_nulls_del_node_init_rcu(struct sock *sk)
271b72c7 633{
dc6b9b78 634 bool rc = __sk_nulls_del_node_init_rcu(sk);
271b72c7
ED
635
636 if (rc) {
637 /* paranoid for a while -acme */
638 WARN_ON(atomic_read(&sk->sk_refcnt) == 1);
639 __sock_put(sk);
640 }
641 return rc;
642}
643
dc6b9b78 644static inline void __sk_add_node(struct sock *sk, struct hlist_head *list)
1da177e4
LT
645{
646 hlist_add_head(&sk->sk_node, list);
647}
648
dc6b9b78 649static inline void sk_add_node(struct sock *sk, struct hlist_head *list)
1da177e4
LT
650{
651 sock_hold(sk);
652 __sk_add_node(sk, list);
653}
654
dc6b9b78 655static inline void sk_add_node_rcu(struct sock *sk, struct hlist_head *list)
808f5114 656{
657 sock_hold(sk);
d296ba60
CG
658 if (IS_ENABLED(CONFIG_IPV6) && sk->sk_reuseport &&
659 sk->sk_family == AF_INET6)
660 hlist_add_tail_rcu(&sk->sk_node, list);
661 else
662 hlist_add_head_rcu(&sk->sk_node, list);
808f5114 663}
664
dc6b9b78 665static inline void __sk_nulls_add_node_rcu(struct sock *sk, struct hlist_nulls_head *list)
271b72c7 666{
d894ba18
CG
667 if (IS_ENABLED(CONFIG_IPV6) && sk->sk_reuseport &&
668 sk->sk_family == AF_INET6)
669 hlist_nulls_add_tail_rcu(&sk->sk_nulls_node, list);
670 else
671 hlist_nulls_add_head_rcu(&sk->sk_nulls_node, list);
271b72c7
ED
672}
673
dc6b9b78 674static inline void sk_nulls_add_node_rcu(struct sock *sk, struct hlist_nulls_head *list)
271b72c7
ED
675{
676 sock_hold(sk);
88ab1932 677 __sk_nulls_add_node_rcu(sk, list);
271b72c7
ED
678}
679
dc6b9b78 680static inline void __sk_del_bind_node(struct sock *sk)
1da177e4
LT
681{
682 __hlist_del(&sk->sk_bind_node);
683}
684
dc6b9b78 685static inline void sk_add_bind_node(struct sock *sk,
1da177e4
LT
686 struct hlist_head *list)
687{
688 hlist_add_head(&sk->sk_bind_node, list);
689}
690
b67bfe0d
SL
691#define sk_for_each(__sk, list) \
692 hlist_for_each_entry(__sk, list, sk_node)
693#define sk_for_each_rcu(__sk, list) \
694 hlist_for_each_entry_rcu(__sk, list, sk_node)
88ab1932
ED
695#define sk_nulls_for_each(__sk, node, list) \
696 hlist_nulls_for_each_entry(__sk, node, list, sk_nulls_node)
697#define sk_nulls_for_each_rcu(__sk, node, list) \
698 hlist_nulls_for_each_entry_rcu(__sk, node, list, sk_nulls_node)
b67bfe0d
SL
699#define sk_for_each_from(__sk) \
700 hlist_for_each_entry_from(__sk, sk_node)
88ab1932
ED
701#define sk_nulls_for_each_from(__sk, node) \
702 if (__sk && ({ node = &(__sk)->sk_nulls_node; 1; })) \
703 hlist_nulls_for_each_entry_from(__sk, node, sk_nulls_node)
b67bfe0d
SL
704#define sk_for_each_safe(__sk, tmp, list) \
705 hlist_for_each_entry_safe(__sk, tmp, list, sk_node)
706#define sk_for_each_bound(__sk, list) \
707 hlist_for_each_entry(__sk, list, sk_bind_node)
1da177e4 708
2dc41cff 709/**
ca065d0c 710 * sk_for_each_entry_offset_rcu - iterate over a list at a given struct offset
2dc41cff
DH
711 * @tpos: the type * to use as a loop cursor.
712 * @pos: the &struct hlist_node to use as a loop cursor.
713 * @head: the head for your list.
714 * @offset: offset of hlist_node within the struct.
715 *
716 */
ca065d0c
ED
717#define sk_for_each_entry_offset_rcu(tpos, pos, head, offset) \
718 for (pos = rcu_dereference((head)->first); \
719 pos != NULL && \
2dc41cff 720 ({ tpos = (typeof(*tpos) *)((void *)pos - offset); 1;}); \
ca065d0c 721 pos = rcu_dereference(pos->next))
2dc41cff 722
c336d148
EB
723static inline struct user_namespace *sk_user_ns(struct sock *sk)
724{
725 /* Careful only use this in a context where these parameters
726 * can not change and must all be valid, such as recvmsg from
727 * userspace.
728 */
729 return sk->sk_socket->file->f_cred->user_ns;
730}
731
1da177e4
LT
732/* Sock flags */
733enum sock_flags {
734 SOCK_DEAD,
735 SOCK_DONE,
736 SOCK_URGINLINE,
737 SOCK_KEEPOPEN,
738 SOCK_LINGER,
739 SOCK_DESTROY,
740 SOCK_BROADCAST,
741 SOCK_TIMESTAMP,
742 SOCK_ZAPPED,
743 SOCK_USE_WRITE_QUEUE, /* whether to call sk->sk_write_space in sock_wfree */
744 SOCK_DBG, /* %SO_DEBUG setting */
745 SOCK_RCVTSTAMP, /* %SO_TIMESTAMP setting */
92f37fd2 746 SOCK_RCVTSTAMPNS, /* %SO_TIMESTAMPNS setting */
1da177e4
LT
747 SOCK_LOCALROUTE, /* route locally only, %SO_DONTROUTE setting */
748 SOCK_QUEUE_SHRUNK, /* write queue has been shrunk recently */
7cb02404 749 SOCK_MEMALLOC, /* VM depends on this socket for swapping */
20d49473 750 SOCK_TIMESTAMPING_RX_SOFTWARE, /* %SOF_TIMESTAMPING_RX_SOFTWARE */
bcdce719 751 SOCK_FASYNC, /* fasync() active */
3b885787 752 SOCK_RXQ_OVFL,
1cdebb42 753 SOCK_ZEROCOPY, /* buffers from userspace */
6e3e939f 754 SOCK_WIFI_STATUS, /* push wifi status to userspace */
3bdc0eba
BG
755 SOCK_NOFCS, /* Tell NIC not to do the Ethernet FCS.
756 * Will use last 4 bytes of packet sent from
757 * user-space instead.
758 */
d59577b6 759 SOCK_FILTER_LOCKED, /* Filter cannot be changed anymore */
7d4c04fc 760 SOCK_SELECT_ERR_QUEUE, /* Wake select on error queue */
a4298e45 761 SOCK_RCU_FREE, /* wait rcu grace period in sk_destruct() */
1da177e4
LT
762};
763
01ce63c9
MRL
764#define SK_FLAGS_TIMESTAMP ((1UL << SOCK_TIMESTAMP) | (1UL << SOCK_TIMESTAMPING_RX_SOFTWARE))
765
53b924b3
RB
766static inline void sock_copy_flags(struct sock *nsk, struct sock *osk)
767{
768 nsk->sk_flags = osk->sk_flags;
769}
770
1da177e4
LT
771static inline void sock_set_flag(struct sock *sk, enum sock_flags flag)
772{
773 __set_bit(flag, &sk->sk_flags);
774}
775
776static inline void sock_reset_flag(struct sock *sk, enum sock_flags flag)
777{
778 __clear_bit(flag, &sk->sk_flags);
779}
780
1b23a5df 781static inline bool sock_flag(const struct sock *sk, enum sock_flags flag)
1da177e4
LT
782{
783 return test_bit(flag, &sk->sk_flags);
784}
785
c93bdd0e
MG
786#ifdef CONFIG_NET
787extern struct static_key memalloc_socks;
788static inline int sk_memalloc_socks(void)
789{
790 return static_key_false(&memalloc_socks);
791}
792#else
793
794static inline int sk_memalloc_socks(void)
795{
796 return 0;
797}
798
799#endif
800
7450aaf6 801static inline gfp_t sk_gfp_mask(const struct sock *sk, gfp_t gfp_mask)
99a1dec7 802{
7450aaf6 803 return gfp_mask | (sk->sk_allocation & __GFP_MEMALLOC);
99a1dec7
MG
804}
805
1da177e4
LT
806static inline void sk_acceptq_removed(struct sock *sk)
807{
808 sk->sk_ack_backlog--;
809}
810
811static inline void sk_acceptq_added(struct sock *sk)
812{
813 sk->sk_ack_backlog++;
814}
815
dc6b9b78 816static inline bool sk_acceptq_is_full(const struct sock *sk)
1da177e4 817{
64a14651 818 return sk->sk_ack_backlog > sk->sk_max_ack_backlog;
1da177e4
LT
819}
820
821/*
822 * Compute minimal free write space needed to queue new packets.
823 */
dc6b9b78 824static inline int sk_stream_min_wspace(const struct sock *sk)
1da177e4 825{
8df09ea3 826 return sk->sk_wmem_queued >> 1;
1da177e4
LT
827}
828
dc6b9b78 829static inline int sk_stream_wspace(const struct sock *sk)
1da177e4
LT
830{
831 return sk->sk_sndbuf - sk->sk_wmem_queued;
832}
833
69336bd2 834void sk_stream_write_space(struct sock *sk);
1da177e4 835
8eae939f 836/* OOB backlog add */
a3a858ff 837static inline void __sk_add_backlog(struct sock *sk, struct sk_buff *skb)
9ee6b535 838{
7fee226a 839 /* dont let skb dst not refcounted, we are going to leave rcu lock */
5037e9ef 840 skb_dst_force_safe(skb);
7fee226a
ED
841
842 if (!sk->sk_backlog.tail)
843 sk->sk_backlog.head = skb;
844 else
9ee6b535 845 sk->sk_backlog.tail->next = skb;
7fee226a
ED
846
847 sk->sk_backlog.tail = skb;
9ee6b535
SH
848 skb->next = NULL;
849}
1da177e4 850
c377411f
ED
851/*
852 * Take into account size of receive queue and backlog queue
0fd7bac6
ED
853 * Do not take into account this skb truesize,
854 * to allow even a single big packet to come.
c377411f 855 */
274f482d 856static inline bool sk_rcvqueues_full(const struct sock *sk, unsigned int limit)
c377411f
ED
857{
858 unsigned int qsize = sk->sk_backlog.len + atomic_read(&sk->sk_rmem_alloc);
859
f545a38f 860 return qsize > limit;
c377411f
ED
861}
862
8eae939f 863/* The per-socket spinlock must be held here. */
f545a38f
ED
864static inline __must_check int sk_add_backlog(struct sock *sk, struct sk_buff *skb,
865 unsigned int limit)
8eae939f 866{
274f482d 867 if (sk_rcvqueues_full(sk, limit))
8eae939f
ZY
868 return -ENOBUFS;
869
c7c49b8f
ED
870 /*
871 * If the skb was allocated from pfmemalloc reserves, only
872 * allow SOCK_MEMALLOC sockets to use it as this socket is
873 * helping free memory
874 */
875 if (skb_pfmemalloc(skb) && !sock_flag(sk, SOCK_MEMALLOC))
876 return -ENOMEM;
877
a3a858ff 878 __sk_add_backlog(sk, skb);
8eae939f
ZY
879 sk->sk_backlog.len += skb->truesize;
880 return 0;
881}
882
69336bd2 883int __sk_backlog_rcv(struct sock *sk, struct sk_buff *skb);
b4b9e355 884
c57943a1
PZ
885static inline int sk_backlog_rcv(struct sock *sk, struct sk_buff *skb)
886{
b4b9e355
MG
887 if (sk_memalloc_socks() && skb_pfmemalloc(skb))
888 return __sk_backlog_rcv(sk, skb);
889
c57943a1
PZ
890 return sk->sk_backlog_rcv(sk, skb);
891}
892
2c8c56e1
ED
893static inline void sk_incoming_cpu_update(struct sock *sk)
894{
895 sk->sk_incoming_cpu = raw_smp_processor_id();
896}
897
fe477558 898static inline void sock_rps_record_flow_hash(__u32 hash)
c58dc01b
DM
899{
900#ifdef CONFIG_RPS
901 struct rps_sock_flow_table *sock_flow_table;
902
903 rcu_read_lock();
904 sock_flow_table = rcu_dereference(rps_sock_flow_table);
fe477558 905 rps_record_sock_flow(sock_flow_table, hash);
c58dc01b
DM
906 rcu_read_unlock();
907#endif
908}
909
fe477558
TH
910static inline void sock_rps_record_flow(const struct sock *sk)
911{
c9d8ca04 912#ifdef CONFIG_RPS
fe477558 913 sock_rps_record_flow_hash(sk->sk_rxhash);
c9d8ca04 914#endif
fe477558
TH
915}
916
bdeab991
TH
917static inline void sock_rps_save_rxhash(struct sock *sk,
918 const struct sk_buff *skb)
c58dc01b
DM
919{
920#ifdef CONFIG_RPS
567e4b79 921 if (unlikely(sk->sk_rxhash != skb->hash))
61b905da 922 sk->sk_rxhash = skb->hash;
c58dc01b
DM
923#endif
924}
925
bdeab991
TH
926static inline void sock_rps_reset_rxhash(struct sock *sk)
927{
928#ifdef CONFIG_RPS
bdeab991
TH
929 sk->sk_rxhash = 0;
930#endif
931}
932
d9dc8b0f 933#define sk_wait_event(__sk, __timeo, __condition, __wait) \
cfcabdcc
SH
934 ({ int __rc; \
935 release_sock(__sk); \
936 __rc = __condition; \
937 if (!__rc) { \
d9dc8b0f
WC
938 *(__timeo) = wait_woken(__wait, \
939 TASK_INTERRUPTIBLE, \
940 *(__timeo)); \
cfcabdcc 941 } \
d9dc8b0f 942 sched_annotate_sleep(); \
cfcabdcc
SH
943 lock_sock(__sk); \
944 __rc = __condition; \
945 __rc; \
946 })
1da177e4 947
69336bd2
JP
948int sk_stream_wait_connect(struct sock *sk, long *timeo_p);
949int sk_stream_wait_memory(struct sock *sk, long *timeo_p);
950void sk_stream_wait_close(struct sock *sk, long timeo_p);
951int sk_stream_error(struct sock *sk, int flags, int err);
952void sk_stream_kill_queues(struct sock *sk);
953void sk_set_memalloc(struct sock *sk);
954void sk_clear_memalloc(struct sock *sk);
1da177e4 955
d41a69f1
ED
956void __sk_flush_backlog(struct sock *sk);
957
958static inline bool sk_flush_backlog(struct sock *sk)
959{
960 if (unlikely(READ_ONCE(sk->sk_backlog.tail))) {
961 __sk_flush_backlog(sk);
962 return true;
963 }
964 return false;
965}
966
dfbafc99 967int sk_wait_data(struct sock *sk, long *timeo, const struct sk_buff *skb);
1da177e4 968
60236fdd 969struct request_sock_ops;
6d6ee43e 970struct timewait_sock_ops;
ab1e0a13 971struct inet_hashinfo;
fc8717ba 972struct raw_hashinfo;
de477254 973struct module;
2e6599cb 974
f77d6021
ED
975/*
976 * caches using SLAB_DESTROY_BY_RCU should let .next pointer from nulls nodes
977 * un-modified. Special care is taken when initializing object to zero.
978 */
979static inline void sk_prot_clear_nulls(struct sock *sk, int size)
980{
981 if (offsetof(struct sock, sk_node.next) != 0)
982 memset(sk, 0, offsetof(struct sock, sk_node.next));
983 memset(&sk->sk_node.pprev, 0,
984 size - offsetof(struct sock, sk_node.pprev));
985}
986
1da177e4
LT
987/* Networking protocol blocks we attach to sockets.
988 * socket layer -> transport layer interface
1da177e4
LT
989 */
990struct proto {
dc6b9b78 991 void (*close)(struct sock *sk,
1da177e4
LT
992 long timeout);
993 int (*connect)(struct sock *sk,
dc6b9b78 994 struct sockaddr *uaddr,
1da177e4
LT
995 int addr_len);
996 int (*disconnect)(struct sock *sk, int flags);
997
dc6b9b78 998 struct sock * (*accept)(struct sock *sk, int flags, int *err);
1da177e4
LT
999
1000 int (*ioctl)(struct sock *sk, int cmd,
1001 unsigned long arg);
1002 int (*init)(struct sock *sk);
7d06b2e0 1003 void (*destroy)(struct sock *sk);
1da177e4 1004 void (*shutdown)(struct sock *sk, int how);
dc6b9b78 1005 int (*setsockopt)(struct sock *sk, int level,
1da177e4 1006 int optname, char __user *optval,
b7058842 1007 unsigned int optlen);
dc6b9b78
ED
1008 int (*getsockopt)(struct sock *sk, int level,
1009 int optname, char __user *optval,
1010 int __user *option);
af01d537 1011#ifdef CONFIG_COMPAT
3fdadf7d
DM
1012 int (*compat_setsockopt)(struct sock *sk,
1013 int level,
1014 int optname, char __user *optval,
b7058842 1015 unsigned int optlen);
3fdadf7d
DM
1016 int (*compat_getsockopt)(struct sock *sk,
1017 int level,
1018 int optname, char __user *optval,
1019 int __user *option);
709b46e8
EB
1020 int (*compat_ioctl)(struct sock *sk,
1021 unsigned int cmd, unsigned long arg);
af01d537 1022#endif
1b784140
YX
1023 int (*sendmsg)(struct sock *sk, struct msghdr *msg,
1024 size_t len);
1025 int (*recvmsg)(struct sock *sk, struct msghdr *msg,
dc6b9b78
ED
1026 size_t len, int noblock, int flags,
1027 int *addr_len);
1da177e4
LT
1028 int (*sendpage)(struct sock *sk, struct page *page,
1029 int offset, size_t size, int flags);
dc6b9b78 1030 int (*bind)(struct sock *sk,
1da177e4
LT
1031 struct sockaddr *uaddr, int addr_len);
1032
dc6b9b78 1033 int (*backlog_rcv) (struct sock *sk,
1da177e4
LT
1034 struct sk_buff *skb);
1035
46d3ceab
ED
1036 void (*release_cb)(struct sock *sk);
1037
1da177e4 1038 /* Keeping track of sk's, looking them up, and port selection methods. */
086c653f 1039 int (*hash)(struct sock *sk);
1da177e4 1040 void (*unhash)(struct sock *sk);
719f8358 1041 void (*rehash)(struct sock *sk);
1da177e4
LT
1042 int (*get_port)(struct sock *sk, unsigned short snum);
1043
286ab3d4 1044 /* Keeping track of sockets in use */
65f76517 1045#ifdef CONFIG_PROC_FS
13ff3d6f 1046 unsigned int inuse_idx;
65f76517 1047#endif
ebb53d75 1048
c9bee3b7 1049 bool (*stream_memory_free)(const struct sock *sk);
1da177e4 1050 /* Memory pressure */
5c52ba17 1051 void (*enter_memory_pressure)(struct sock *sk);
8d987e5c 1052 atomic_long_t *memory_allocated; /* Current allocated memory. */
1748376b 1053 struct percpu_counter *sockets_allocated; /* Current number of sockets. */
1da177e4
LT
1054 /*
1055 * Pressure flag: try to collapse.
1056 * Technical note: it is used by multiple contexts non atomically.
3ab224be 1057 * All the __sk_mem_schedule() is of this nature: accounting
1da177e4
LT
1058 * is strict, actions are advisory and have some latency.
1059 */
1060 int *memory_pressure;
8d987e5c 1061 long *sysctl_mem;
1da177e4
LT
1062 int *sysctl_wmem;
1063 int *sysctl_rmem;
1064 int max_header;
7ba42910 1065 bool no_autobind;
1da177e4 1066
271b72c7 1067 struct kmem_cache *slab;
1da177e4 1068 unsigned int obj_size;
271b72c7 1069 int slab_flags;
1da177e4 1070
dd24c001 1071 struct percpu_counter *orphan_count;
8feaf0c0 1072
60236fdd 1073 struct request_sock_ops *rsk_prot;
6d6ee43e 1074 struct timewait_sock_ops *twsk_prot;
2e6599cb 1075
39d8cda7
PE
1076 union {
1077 struct inet_hashinfo *hashinfo;
645ca708 1078 struct udp_table *udp_table;
fc8717ba 1079 struct raw_hashinfo *raw_hash;
39d8cda7 1080 } h;
ab1e0a13 1081
1da177e4
LT
1082 struct module *owner;
1083
1084 char name[32];
1085
1086 struct list_head node;
e6848976
ACM
1087#ifdef SOCK_REFCNT_DEBUG
1088 atomic_t socks;
e1aab161 1089#endif
64be0aed 1090 int (*diag_destroy)(struct sock *sk, int err);
e1aab161
GC
1091};
1092
69336bd2
JP
1093int proto_register(struct proto *prot, int alloc_slab);
1094void proto_unregister(struct proto *prot);
1da177e4 1095
e6848976
ACM
1096#ifdef SOCK_REFCNT_DEBUG
1097static inline void sk_refcnt_debug_inc(struct sock *sk)
1098{
1099 atomic_inc(&sk->sk_prot->socks);
1100}
1101
1102static inline void sk_refcnt_debug_dec(struct sock *sk)
1103{
1104 atomic_dec(&sk->sk_prot->socks);
1105 printk(KERN_DEBUG "%s socket %p released, %d are still alive\n",
1106 sk->sk_prot->name, sk, atomic_read(&sk->sk_prot->socks));
1107}
1108
dec34fb0 1109static inline void sk_refcnt_debug_release(const struct sock *sk)
e6848976
ACM
1110{
1111 if (atomic_read(&sk->sk_refcnt) != 1)
1112 printk(KERN_DEBUG "Destruction of the %s socket %p delayed, refcnt=%d\n",
1113 sk->sk_prot->name, sk, atomic_read(&sk->sk_refcnt));
1114}
1115#else /* SOCK_REFCNT_DEBUG */
1116#define sk_refcnt_debug_inc(sk) do { } while (0)
1117#define sk_refcnt_debug_dec(sk) do { } while (0)
1118#define sk_refcnt_debug_release(sk) do { } while (0)
1119#endif /* SOCK_REFCNT_DEBUG */
1120
c9bee3b7
ED
1121static inline bool sk_stream_memory_free(const struct sock *sk)
1122{
1123 if (sk->sk_wmem_queued >= sk->sk_sndbuf)
1124 return false;
1125
1126 return sk->sk_prot->stream_memory_free ?
1127 sk->sk_prot->stream_memory_free(sk) : true;
1128}
1129
64dc6130
ED
1130static inline bool sk_stream_is_writeable(const struct sock *sk)
1131{
c9bee3b7
ED
1132 return sk_stream_wspace(sk) >= sk_stream_min_wspace(sk) &&
1133 sk_stream_memory_free(sk);
64dc6130 1134}
e1aab161 1135
54fd9c2d
DB
1136static inline int sk_under_cgroup_hierarchy(struct sock *sk,
1137 struct cgroup *ancestor)
1138{
1139#ifdef CONFIG_SOCK_CGROUP_DATA
1140 return cgroup_is_descendant(sock_cgroup_ptr(&sk->sk_cgrp_data),
1141 ancestor);
1142#else
1143 return -ENOTSUPP;
1144#endif
1145}
c9bee3b7 1146
180d8cd9
GC
1147static inline bool sk_has_memory_pressure(const struct sock *sk)
1148{
1149 return sk->sk_prot->memory_pressure != NULL;
1150}
1151
1152static inline bool sk_under_memory_pressure(const struct sock *sk)
1153{
1154 if (!sk->sk_prot->memory_pressure)
1155 return false;
e1aab161 1156
baac50bb
JW
1157 if (mem_cgroup_sockets_enabled && sk->sk_memcg &&
1158 mem_cgroup_under_socket_pressure(sk->sk_memcg))
e805605c 1159 return true;
e1aab161 1160
35b87f6c 1161 return !!*sk->sk_prot->memory_pressure;
180d8cd9
GC
1162}
1163
1164static inline void sk_leave_memory_pressure(struct sock *sk)
1165{
1166 int *memory_pressure = sk->sk_prot->memory_pressure;
1167
e1aab161
GC
1168 if (!memory_pressure)
1169 return;
1170
1171 if (*memory_pressure)
180d8cd9
GC
1172 *memory_pressure = 0;
1173}
1174
1175static inline void sk_enter_memory_pressure(struct sock *sk)
1176{
e1aab161
GC
1177 if (!sk->sk_prot->enter_memory_pressure)
1178 return;
1179
e1aab161 1180 sk->sk_prot->enter_memory_pressure(sk);
180d8cd9
GC
1181}
1182
180d8cd9
GC
1183static inline long
1184sk_memory_allocated(const struct sock *sk)
1185{
e805605c 1186 return atomic_long_read(sk->sk_prot->memory_allocated);
180d8cd9
GC
1187}
1188
1189static inline long
e805605c 1190sk_memory_allocated_add(struct sock *sk, int amt)
180d8cd9 1191{
e805605c 1192 return atomic_long_add_return(amt, sk->sk_prot->memory_allocated);
180d8cd9
GC
1193}
1194
1195static inline void
0e90b31f 1196sk_memory_allocated_sub(struct sock *sk, int amt)
180d8cd9 1197{
e805605c 1198 atomic_long_sub(amt, sk->sk_prot->memory_allocated);
180d8cd9
GC
1199}
1200
1201static inline void sk_sockets_allocated_dec(struct sock *sk)
1202{
af95d7df 1203 percpu_counter_dec(sk->sk_prot->sockets_allocated);
180d8cd9
GC
1204}
1205
1206static inline void sk_sockets_allocated_inc(struct sock *sk)
1207{
af95d7df 1208 percpu_counter_inc(sk->sk_prot->sockets_allocated);
180d8cd9
GC
1209}
1210
1211static inline int
1212sk_sockets_allocated_read_positive(struct sock *sk)
1213{
af95d7df 1214 return percpu_counter_read_positive(sk->sk_prot->sockets_allocated);
180d8cd9
GC
1215}
1216
1217static inline int
1218proto_sockets_allocated_sum_positive(struct proto *prot)
1219{
1220 return percpu_counter_sum_positive(prot->sockets_allocated);
1221}
1222
1223static inline long
1224proto_memory_allocated(struct proto *prot)
1225{
1226 return atomic_long_read(prot->memory_allocated);
1227}
1228
1229static inline bool
1230proto_memory_pressure(struct proto *prot)
1231{
1232 if (!prot->memory_pressure)
1233 return false;
1234 return !!*prot->memory_pressure;
1235}
1236
65f76517
ED
1237
1238#ifdef CONFIG_PROC_FS
1da177e4 1239/* Called with local bh disabled */
69336bd2
JP
1240void sock_prot_inuse_add(struct net *net, struct proto *prot, int inc);
1241int sock_prot_inuse_get(struct net *net, struct proto *proto);
65f76517 1242#else
dc6b9b78 1243static inline void sock_prot_inuse_add(struct net *net, struct proto *prot,
c29a0bc4 1244 int inc)
65f76517
ED
1245{
1246}
65f76517
ED
1247#endif
1248
1da177e4 1249
614c6cb4
ACM
1250/* With per-bucket locks this operation is not-atomic, so that
1251 * this version is not worse.
1252 */
086c653f 1253static inline int __sk_prot_rehash(struct sock *sk)
614c6cb4
ACM
1254{
1255 sk->sk_prot->unhash(sk);
086c653f 1256 return sk->sk_prot->hash(sk);
614c6cb4
ACM
1257}
1258
1da177e4
LT
1259/* About 10 seconds */
1260#define SOCK_DESTROY_TIME (10*HZ)
1261
1262/* Sockets 0-1023 can't be bound to unless you are superuser */
1263#define PROT_SOCK 1024
1264
1265#define SHUTDOWN_MASK 3
1266#define RCV_SHUTDOWN 1
1267#define SEND_SHUTDOWN 2
1268
1269#define SOCK_SNDBUF_LOCK 1
1270#define SOCK_RCVBUF_LOCK 2
1271#define SOCK_BINDADDR_LOCK 4
1272#define SOCK_BINDPORT_LOCK 8
1273
1da177e4
LT
1274struct socket_alloc {
1275 struct socket socket;
1276 struct inode vfs_inode;
1277};
1278
1279static inline struct socket *SOCKET_I(struct inode *inode)
1280{
1281 return &container_of(inode, struct socket_alloc, vfs_inode)->socket;
1282}
1283
1284static inline struct inode *SOCK_INODE(struct socket *socket)
1285{
1286 return &container_of(socket, struct socket_alloc, socket)->vfs_inode;
1287}
1288
3ab224be
HA
1289/*
1290 * Functions for memory accounting
1291 */
f8c3bf00 1292int __sk_mem_raise_allocated(struct sock *sk, int size, int amt, int kind);
69336bd2 1293int __sk_mem_schedule(struct sock *sk, int size, int kind);
f8c3bf00 1294void __sk_mem_reduce_allocated(struct sock *sk, int amount);
1a24e04e 1295void __sk_mem_reclaim(struct sock *sk, int amount);
1da177e4 1296
bd68a2a8
ED
1297/* We used to have PAGE_SIZE here, but systems with 64KB pages
1298 * do not necessarily have 16x time more memory than 4KB ones.
1299 */
1300#define SK_MEM_QUANTUM 4096
3ab224be
HA
1301#define SK_MEM_QUANTUM_SHIFT ilog2(SK_MEM_QUANTUM)
1302#define SK_MEM_SEND 0
1303#define SK_MEM_RECV 1
1da177e4 1304
bd68a2a8
ED
1305/* sysctl_mem values are in pages, we convert them in SK_MEM_QUANTUM units */
1306static inline long sk_prot_mem_limits(const struct sock *sk, int index)
1307{
1308 long val = sk->sk_prot->sysctl_mem[index];
1309
1310#if PAGE_SIZE > SK_MEM_QUANTUM
1311 val <<= PAGE_SHIFT - SK_MEM_QUANTUM_SHIFT;
1312#elif PAGE_SIZE < SK_MEM_QUANTUM
1313 val >>= SK_MEM_QUANTUM_SHIFT - PAGE_SHIFT;
1314#endif
1315 return val;
1316}
1317
3ab224be 1318static inline int sk_mem_pages(int amt)
1da177e4 1319{
3ab224be 1320 return (amt + SK_MEM_QUANTUM - 1) >> SK_MEM_QUANTUM_SHIFT;
1da177e4
LT
1321}
1322
dc6b9b78 1323static inline bool sk_has_account(struct sock *sk)
1da177e4 1324{
3ab224be
HA
1325 /* return true if protocol supports memory accounting */
1326 return !!sk->sk_prot->memory_allocated;
1da177e4
LT
1327}
1328
dc6b9b78 1329static inline bool sk_wmem_schedule(struct sock *sk, int size)
1da177e4 1330{
3ab224be 1331 if (!sk_has_account(sk))
dc6b9b78 1332 return true;
3ab224be
HA
1333 return size <= sk->sk_forward_alloc ||
1334 __sk_mem_schedule(sk, size, SK_MEM_SEND);
1da177e4
LT
1335}
1336
c76562b6 1337static inline bool
35c448a8 1338sk_rmem_schedule(struct sock *sk, struct sk_buff *skb, int size)
d80d99d6 1339{
3ab224be 1340 if (!sk_has_account(sk))
dc6b9b78 1341 return true;
c76562b6
MG
1342 return size<= sk->sk_forward_alloc ||
1343 __sk_mem_schedule(sk, size, SK_MEM_RECV) ||
1344 skb_pfmemalloc(skb);
3ab224be
HA
1345}
1346
1347static inline void sk_mem_reclaim(struct sock *sk)
1348{
1349 if (!sk_has_account(sk))
1350 return;
1351 if (sk->sk_forward_alloc >= SK_MEM_QUANTUM)
1a24e04e 1352 __sk_mem_reclaim(sk, sk->sk_forward_alloc);
3ab224be
HA
1353}
1354
9993e7d3
DM
1355static inline void sk_mem_reclaim_partial(struct sock *sk)
1356{
1357 if (!sk_has_account(sk))
1358 return;
1359 if (sk->sk_forward_alloc > SK_MEM_QUANTUM)
1a24e04e 1360 __sk_mem_reclaim(sk, sk->sk_forward_alloc - 1);
9993e7d3
DM
1361}
1362
3ab224be
HA
1363static inline void sk_mem_charge(struct sock *sk, int size)
1364{
1365 if (!sk_has_account(sk))
1366 return;
1367 sk->sk_forward_alloc -= size;
1368}
1369
1370static inline void sk_mem_uncharge(struct sock *sk, int size)
1371{
1372 if (!sk_has_account(sk))
1373 return;
1374 sk->sk_forward_alloc += size;
20c64d5c
ED
1375
1376 /* Avoid a possible overflow.
1377 * TCP send queues can make this happen, if sk_mem_reclaim()
1378 * is not called and more than 2 GBytes are released at once.
1379 *
1380 * If we reach 2 MBytes, reclaim 1 MBytes right now, there is
1381 * no need to hold that much forward allocation anyway.
1382 */
1383 if (unlikely(sk->sk_forward_alloc >= 1 << 21))
1384 __sk_mem_reclaim(sk, 1 << 20);
3ab224be
HA
1385}
1386
1387static inline void sk_wmem_free_skb(struct sock *sk, struct sk_buff *skb)
1388{
3ab224be
HA
1389 sock_set_flag(sk, SOCK_QUEUE_SHRUNK);
1390 sk->sk_wmem_queued -= skb->truesize;
1391 sk_mem_uncharge(sk, skb->truesize);
1392 __kfree_skb(skb);
d80d99d6
HX
1393}
1394
c3f9b018
ED
1395static inline void sock_release_ownership(struct sock *sk)
1396{
61881cfb
HFS
1397 if (sk->sk_lock.owned) {
1398 sk->sk_lock.owned = 0;
1399
1400 /* The sk_lock has mutex_unlock() semantics: */
1401 mutex_release(&sk->sk_lock.dep_map, 1, _RET_IP_);
1402 }
c3f9b018
ED
1403}
1404
ed07536e
PZ
1405/*
1406 * Macro so as to not evaluate some arguments when
1407 * lockdep is not enabled.
1408 *
1409 * Mark both the sk_lock and the sk_lock.slock as a
1410 * per-address-family lock class.
1411 */
dc6b9b78 1412#define sock_lock_init_class_and_name(sk, sname, skey, name, key) \
ed07536e 1413do { \
e8f6fbf6 1414 sk->sk_lock.owned = 0; \
ed07536e
PZ
1415 init_waitqueue_head(&sk->sk_lock.wq); \
1416 spin_lock_init(&(sk)->sk_lock.slock); \
1417 debug_check_no_locks_freed((void *)&(sk)->sk_lock, \
1418 sizeof((sk)->sk_lock)); \
1419 lockdep_set_class_and_name(&(sk)->sk_lock.slock, \
dc6b9b78 1420 (skey), (sname)); \
ed07536e
PZ
1421 lockdep_init_map(&(sk)->sk_lock.dep_map, (name), (key), 0); \
1422} while (0)
1423
b33b0a1b 1424#ifdef CONFIG_LOCKDEP
03be9822 1425static inline bool lockdep_sock_is_held(const struct sock *csk)
1e1d04e6
HFS
1426{
1427 struct sock *sk = (struct sock *)csk;
1428
1429 return lockdep_is_held(&sk->sk_lock) ||
1430 lockdep_is_held(&sk->sk_lock.slock);
1431}
b33b0a1b 1432#endif
1e1d04e6 1433
69336bd2 1434void lock_sock_nested(struct sock *sk, int subclass);
fcc70d5f
PZ
1435
1436static inline void lock_sock(struct sock *sk)
1437{
1438 lock_sock_nested(sk, 0);
1439}
1440
69336bd2 1441void release_sock(struct sock *sk);
1da177e4
LT
1442
1443/* BH context may only use the following locking interface. */
1444#define bh_lock_sock(__sk) spin_lock(&((__sk)->sk_lock.slock))
c6366184
IM
1445#define bh_lock_sock_nested(__sk) \
1446 spin_lock_nested(&((__sk)->sk_lock.slock), \
1447 SINGLE_DEPTH_NESTING)
1da177e4
LT
1448#define bh_unlock_sock(__sk) spin_unlock(&((__sk)->sk_lock.slock))
1449
69336bd2 1450bool lock_sock_fast(struct sock *sk);
8a74ad60
ED
1451/**
1452 * unlock_sock_fast - complement of lock_sock_fast
1453 * @sk: socket
1454 * @slow: slow mode
1455 *
1456 * fast unlock socket for user context.
1457 * If slow mode is on, we call regular release_sock()
1458 */
1459static inline void unlock_sock_fast(struct sock *sk, bool slow)
4b0b72f7 1460{
8a74ad60
ED
1461 if (slow)
1462 release_sock(sk);
1463 else
1464 spin_unlock_bh(&sk->sk_lock.slock);
4b0b72f7
ED
1465}
1466
fafc4e1e
HFS
1467/* Used by processes to "lock" a socket state, so that
1468 * interrupts and bottom half handlers won't change it
1469 * from under us. It essentially blocks any incoming
1470 * packets, so that we won't get any new data or any
1471 * packets that change the state of the socket.
1472 *
1473 * While locked, BH processing will add new packets to
1474 * the backlog queue. This queue is processed by the
1475 * owner of the socket lock right before it is released.
1476 *
1477 * Since ~2.3.5 it is also exclusive sleep lock serializing
1478 * accesses from user process context.
1479 */
1480
46cc6e49 1481static inline void sock_owned_by_me(const struct sock *sk)
fafc4e1e
HFS
1482{
1483#ifdef CONFIG_LOCKDEP
5e91f6ce 1484 WARN_ON_ONCE(!lockdep_sock_is_held(sk) && debug_locks);
fafc4e1e 1485#endif
46cc6e49
ED
1486}
1487
1488static inline bool sock_owned_by_user(const struct sock *sk)
1489{
1490 sock_owned_by_me(sk);
fafc4e1e
HFS
1491 return sk->sk_lock.owned;
1492}
1493
1494/* no reclassification while locks are held */
1495static inline bool sock_allow_reclassification(const struct sock *csk)
1496{
1497 struct sock *sk = (struct sock *)csk;
1498
1499 return !sk->sk_lock.owned && !spin_is_locked(&sk->sk_lock.slock);
1500}
4b0b72f7 1501
69336bd2 1502struct sock *sk_alloc(struct net *net, int family, gfp_t priority,
11aa9c28 1503 struct proto *prot, int kern);
69336bd2 1504void sk_free(struct sock *sk);
eb4cb008 1505void sk_destruct(struct sock *sk);
69336bd2
JP
1506struct sock *sk_clone_lock(const struct sock *sk, const gfp_t priority);
1507
1508struct sk_buff *sock_wmalloc(struct sock *sk, unsigned long size, int force,
1509 gfp_t priority);
1d2077ac 1510void __sock_wfree(struct sk_buff *skb);
69336bd2
JP
1511void sock_wfree(struct sk_buff *skb);
1512void skb_orphan_partial(struct sk_buff *skb);
1513void sock_rfree(struct sk_buff *skb);
62bccb8c 1514void sock_efree(struct sk_buff *skb);
82eabd9e 1515#ifdef CONFIG_INET
69336bd2 1516void sock_edemux(struct sk_buff *skb);
82eabd9e
AD
1517#else
1518#define sock_edemux(skb) sock_efree(skb)
1519#endif
69336bd2
JP
1520
1521int sock_setsockopt(struct socket *sock, int level, int op,
1522 char __user *optval, unsigned int optlen);
1523
1524int sock_getsockopt(struct socket *sock, int level, int op,
1525 char __user *optval, int __user *optlen);
1526struct sk_buff *sock_alloc_send_skb(struct sock *sk, unsigned long size,
1527 int noblock, int *errcode);
1528struct sk_buff *sock_alloc_send_pskb(struct sock *sk, unsigned long header_len,
1529 unsigned long data_len, int noblock,
1530 int *errcode, int max_page_order);
1531void *sock_kmalloc(struct sock *sk, int size, gfp_t priority);
1532void sock_kfree_s(struct sock *sk, void *mem, int size);
79e88659 1533void sock_kzfree_s(struct sock *sk, void *mem, int size);
69336bd2 1534void sk_send_sigurg(struct sock *sk);
1da177e4 1535
f28ea365
EJ
1536struct sockcm_cookie {
1537 u32 mark;
3dd17e63 1538 u16 tsflags;
f28ea365
EJ
1539};
1540
39771b12
WB
1541int __sock_cmsg_send(struct sock *sk, struct msghdr *msg, struct cmsghdr *cmsg,
1542 struct sockcm_cookie *sockc);
f28ea365
EJ
1543int sock_cmsg_send(struct sock *sk, struct msghdr *msg,
1544 struct sockcm_cookie *sockc);
1545
1da177e4
LT
1546/*
1547 * Functions to fill in entries in struct proto_ops when a protocol
1548 * does not implement a particular function.
1549 */
69336bd2
JP
1550int sock_no_bind(struct socket *, struct sockaddr *, int);
1551int sock_no_connect(struct socket *, struct sockaddr *, int, int);
1552int sock_no_socketpair(struct socket *, struct socket *);
1553int sock_no_accept(struct socket *, struct socket *, int);
1554int sock_no_getname(struct socket *, struct sockaddr *, int *, int);
1555unsigned int sock_no_poll(struct file *, struct socket *,
1556 struct poll_table_struct *);
1557int sock_no_ioctl(struct socket *, unsigned int, unsigned long);
1558int sock_no_listen(struct socket *, int);
1559int sock_no_shutdown(struct socket *, int);
1560int sock_no_getsockopt(struct socket *, int , int, char __user *, int __user *);
1561int sock_no_setsockopt(struct socket *, int, int, char __user *, unsigned int);
1b784140
YX
1562int sock_no_sendmsg(struct socket *, struct msghdr *, size_t);
1563int sock_no_recvmsg(struct socket *, struct msghdr *, size_t, int);
69336bd2
JP
1564int sock_no_mmap(struct file *file, struct socket *sock,
1565 struct vm_area_struct *vma);
1566ssize_t sock_no_sendpage(struct socket *sock, struct page *page, int offset,
1567 size_t size, int flags);
1da177e4
LT
1568
1569/*
1570 * Functions to fill in entries in struct proto_ops when a protocol
1571 * uses the inet style.
1572 */
69336bd2 1573int sock_common_getsockopt(struct socket *sock, int level, int optname,
1da177e4 1574 char __user *optval, int __user *optlen);
1b784140
YX
1575int sock_common_recvmsg(struct socket *sock, struct msghdr *msg, size_t size,
1576 int flags);
69336bd2 1577int sock_common_setsockopt(struct socket *sock, int level, int optname,
b7058842 1578 char __user *optval, unsigned int optlen);
69336bd2 1579int compat_sock_common_getsockopt(struct socket *sock, int level,
3fdadf7d 1580 int optname, char __user *optval, int __user *optlen);
69336bd2 1581int compat_sock_common_setsockopt(struct socket *sock, int level,
b7058842 1582 int optname, char __user *optval, unsigned int optlen);
1da177e4 1583
69336bd2 1584void sk_common_release(struct sock *sk);
1da177e4
LT
1585
1586/*
1587 * Default socket callbacks and setup code
1588 */
dc6b9b78 1589
1da177e4 1590/* Initialise core socket variables */
69336bd2 1591void sock_init_data(struct socket *sock, struct sock *sk);
1da177e4 1592
1da177e4
LT
1593/*
1594 * Socket reference counting postulates.
1595 *
1596 * * Each user of socket SHOULD hold a reference count.
1597 * * Each access point to socket (an hash table bucket, reference from a list,
1598 * running timer, skb in flight MUST hold a reference count.
1599 * * When reference count hits 0, it means it will never increase back.
1600 * * When reference count hits 0, it means that no references from
1601 * outside exist to this socket and current process on current CPU
1602 * is last user and may/should destroy this socket.
1603 * * sk_free is called from any context: process, BH, IRQ. When
1604 * it is called, socket has no references from outside -> sk_free
1605 * may release descendant resources allocated by the socket, but
1606 * to the time when it is called, socket is NOT referenced by any
1607 * hash tables, lists etc.
1608 * * Packets, delivered from outside (from network or from another process)
1609 * and enqueued on receive/error queues SHOULD NOT grab reference count,
1610 * when they sit in queue. Otherwise, packets will leak to hole, when
1611 * socket is looked up by one cpu and unhasing is made by another CPU.
1612 * It is true for udp/raw, netlink (leak to receive and error queues), tcp
1613 * (leak to backlog). Packet socket does all the processing inside
1614 * BR_NETPROTO_LOCK, so that it has not this race condition. UNIX sockets
1615 * use separate SMP lock, so that they are prone too.
1616 */
1617
1618/* Ungrab socket and destroy it, if it was the last reference. */
1619static inline void sock_put(struct sock *sk)
1620{
1621 if (atomic_dec_and_test(&sk->sk_refcnt))
1622 sk_free(sk);
1623}
05dbc7b5 1624/* Generic version of sock_put(), dealing with all sockets
41b822c5 1625 * (TCP_TIMEWAIT, TCP_NEW_SYN_RECV, ESTABLISHED...)
05dbc7b5
ED
1626 */
1627void sock_gen_put(struct sock *sk);
1da177e4 1628
4f0c40d9 1629int __sk_receive_skb(struct sock *sk, struct sk_buff *skb, const int nested,
c3f24cfb 1630 unsigned int trim_cap, bool refcounted);
4f0c40d9
WB
1631static inline int sk_receive_skb(struct sock *sk, struct sk_buff *skb,
1632 const int nested)
1633{
c3f24cfb 1634 return __sk_receive_skb(sk, skb, nested, 1, true);
4f0c40d9 1635}
25995ff5 1636
e022f0b4
KK
1637static inline void sk_tx_queue_set(struct sock *sk, int tx_queue)
1638{
1639 sk->sk_tx_queue_mapping = tx_queue;
1640}
1641
1642static inline void sk_tx_queue_clear(struct sock *sk)
1643{
1644 sk->sk_tx_queue_mapping = -1;
1645}
1646
1647static inline int sk_tx_queue_get(const struct sock *sk)
1648{
b0f77d0e 1649 return sk ? sk->sk_tx_queue_mapping : -1;
e022f0b4
KK
1650}
1651
972692e0
DM
1652static inline void sk_set_socket(struct sock *sk, struct socket *sock)
1653{
e022f0b4 1654 sk_tx_queue_clear(sk);
972692e0
DM
1655 sk->sk_socket = sock;
1656}
1657
aa395145
ED
1658static inline wait_queue_head_t *sk_sleep(struct sock *sk)
1659{
eaefd110
ED
1660 BUILD_BUG_ON(offsetof(struct socket_wq, wait) != 0);
1661 return &rcu_dereference_raw(sk->sk_wq)->wait;
aa395145 1662}
1da177e4
LT
1663/* Detach socket from process context.
1664 * Announce socket dead, detach it from wait queue and inode.
1665 * Note that parent inode held reference count on this struct sock,
1666 * we do not release it in this function, because protocol
1667 * probably wants some additional cleanups or even continuing
1668 * to work with this socket (TCP).
1669 */
1670static inline void sock_orphan(struct sock *sk)
1671{
1672 write_lock_bh(&sk->sk_callback_lock);
1673 sock_set_flag(sk, SOCK_DEAD);
972692e0 1674 sk_set_socket(sk, NULL);
43815482 1675 sk->sk_wq = NULL;
1da177e4
LT
1676 write_unlock_bh(&sk->sk_callback_lock);
1677}
1678
1679static inline void sock_graft(struct sock *sk, struct socket *parent)
1680{
1681 write_lock_bh(&sk->sk_callback_lock);
eaefd110 1682 sk->sk_wq = parent->wq;
1da177e4 1683 parent->sk = sk;
972692e0 1684 sk_set_socket(sk, parent);
86741ec2 1685 sk->sk_uid = SOCK_INODE(parent)->i_uid;
4237c75c 1686 security_sock_graft(sk, parent);
1da177e4
LT
1687 write_unlock_bh(&sk->sk_callback_lock);
1688}
1689
69336bd2
JP
1690kuid_t sock_i_uid(struct sock *sk);
1691unsigned long sock_i_ino(struct sock *sk);
1da177e4 1692
86741ec2
LC
1693static inline kuid_t sock_net_uid(const struct net *net, const struct sock *sk)
1694{
1695 return sk ? sk->sk_uid : make_kuid(net->user_ns, 0);
1696}
1697
58d607d3 1698static inline u32 net_tx_rndhash(void)
877d1f62 1699{
58d607d3
ED
1700 u32 v = prandom_u32();
1701
1702 return v ?: 1;
1703}
877d1f62 1704
58d607d3
ED
1705static inline void sk_set_txhash(struct sock *sk)
1706{
1707 sk->sk_txhash = net_tx_rndhash();
877d1f62
TH
1708}
1709
265f94ff
TH
1710static inline void sk_rethink_txhash(struct sock *sk)
1711{
1712 if (sk->sk_txhash)
1713 sk_set_txhash(sk);
1714}
1715
1da177e4
LT
1716static inline struct dst_entry *
1717__sk_dst_get(struct sock *sk)
1718{
1e1d04e6
HFS
1719 return rcu_dereference_check(sk->sk_dst_cache,
1720 lockdep_sock_is_held(sk));
1da177e4
LT
1721}
1722
1723static inline struct dst_entry *
1724sk_dst_get(struct sock *sk)
1725{
1726 struct dst_entry *dst;
1727
b6c6712a
ED
1728 rcu_read_lock();
1729 dst = rcu_dereference(sk->sk_dst_cache);
f8864972
ED
1730 if (dst && !atomic_inc_not_zero(&dst->__refcnt))
1731 dst = NULL;
b6c6712a 1732 rcu_read_unlock();
1da177e4
LT
1733 return dst;
1734}
1735
b6c6712a
ED
1736static inline void dst_negative_advice(struct sock *sk)
1737{
1738 struct dst_entry *ndst, *dst = __sk_dst_get(sk);
1739
265f94ff
TH
1740 sk_rethink_txhash(sk);
1741
b6c6712a
ED
1742 if (dst && dst->ops->negative_advice) {
1743 ndst = dst->ops->negative_advice(dst);
1744
1745 if (ndst != dst) {
1746 rcu_assign_pointer(sk->sk_dst_cache, ndst);
0a6957e7 1747 sk_tx_queue_clear(sk);
b6c6712a
ED
1748 }
1749 }
1750}
1751
1da177e4
LT
1752static inline void
1753__sk_dst_set(struct sock *sk, struct dst_entry *dst)
1754{
1755 struct dst_entry *old_dst;
1756
e022f0b4 1757 sk_tx_queue_clear(sk);
0b53ff2e
ED
1758 /*
1759 * This can be called while sk is owned by the caller only,
1760 * with no state that can be checked in a rcu_dereference_check() cond
1761 */
1762 old_dst = rcu_dereference_raw(sk->sk_dst_cache);
b6c6712a 1763 rcu_assign_pointer(sk->sk_dst_cache, dst);
1da177e4
LT
1764 dst_release(old_dst);
1765}
1766
1767static inline void
1768sk_dst_set(struct sock *sk, struct dst_entry *dst)
1769{
7f502361
ED
1770 struct dst_entry *old_dst;
1771
1772 sk_tx_queue_clear(sk);
5925a055 1773 old_dst = xchg((__force struct dst_entry **)&sk->sk_dst_cache, dst);
7f502361 1774 dst_release(old_dst);
1da177e4
LT
1775}
1776
1777static inline void
1778__sk_dst_reset(struct sock *sk)
1779{
b6c6712a 1780 __sk_dst_set(sk, NULL);
1da177e4
LT
1781}
1782
1783static inline void
1784sk_dst_reset(struct sock *sk)
1785{
7f502361 1786 sk_dst_set(sk, NULL);
1da177e4
LT
1787}
1788
69336bd2 1789struct dst_entry *__sk_dst_check(struct sock *sk, u32 cookie);
1da177e4 1790
69336bd2 1791struct dst_entry *sk_dst_check(struct sock *sk, u32 cookie);
1da177e4 1792
f60e5990 1793bool sk_mc_loop(struct sock *sk);
1794
dc6b9b78 1795static inline bool sk_can_gso(const struct sock *sk)
bcd76111
HX
1796{
1797 return net_gso_ok(sk->sk_route_caps, sk->sk_gso_type);
1798}
1799
69336bd2 1800void sk_setup_caps(struct sock *sk, struct dst_entry *dst);
6cbb0df7 1801
c8f44aff 1802static inline void sk_nocaps_add(struct sock *sk, netdev_features_t flags)
a465419b
ED
1803{
1804 sk->sk_route_nocaps |= flags;
1805 sk->sk_route_caps &= ~flags;
1806}
1807
9a49850d
TH
1808static inline bool sk_check_csum_caps(struct sock *sk)
1809{
1810 return (sk->sk_route_caps & NETIF_F_HW_CSUM) ||
1811 (sk->sk_family == PF_INET &&
1812 (sk->sk_route_caps & NETIF_F_IP_CSUM)) ||
1813 (sk->sk_family == PF_INET6 &&
1814 (sk->sk_route_caps & NETIF_F_IPV6_CSUM));
1815}
1816
c6e1a0d1 1817static inline int skb_do_copy_data_nocache(struct sock *sk, struct sk_buff *skb,
57be5bda 1818 struct iov_iter *from, char *to,
912d398d 1819 int copy, int offset)
c6e1a0d1
TH
1820{
1821 if (skb->ip_summed == CHECKSUM_NONE) {
57be5bda
AV
1822 __wsum csum = 0;
1823 if (csum_and_copy_from_iter(to, copy, &csum, from) != copy)
1824 return -EFAULT;
912d398d 1825 skb->csum = csum_block_add(skb->csum, csum, offset);
c6e1a0d1 1826 } else if (sk->sk_route_caps & NETIF_F_NOCACHE_COPY) {
57be5bda 1827 if (copy_from_iter_nocache(to, copy, from) != copy)
c6e1a0d1 1828 return -EFAULT;
57be5bda 1829 } else if (copy_from_iter(to, copy, from) != copy)
c6e1a0d1
TH
1830 return -EFAULT;
1831
1832 return 0;
1833}
1834
1835static inline int skb_add_data_nocache(struct sock *sk, struct sk_buff *skb,
57be5bda 1836 struct iov_iter *from, int copy)
c6e1a0d1 1837{
912d398d 1838 int err, offset = skb->len;
c6e1a0d1 1839
912d398d
WY
1840 err = skb_do_copy_data_nocache(sk, skb, from, skb_put(skb, copy),
1841 copy, offset);
c6e1a0d1 1842 if (err)
912d398d 1843 __skb_trim(skb, offset);
c6e1a0d1
TH
1844
1845 return err;
1846}
1847
57be5bda 1848static inline int skb_copy_to_page_nocache(struct sock *sk, struct iov_iter *from,
c6e1a0d1
TH
1849 struct sk_buff *skb,
1850 struct page *page,
1851 int off, int copy)
1852{
1853 int err;
1854
912d398d
WY
1855 err = skb_do_copy_data_nocache(sk, skb, from, page_address(page) + off,
1856 copy, skb->len);
c6e1a0d1
TH
1857 if (err)
1858 return err;
1859
1860 skb->len += copy;
1861 skb->data_len += copy;
1862 skb->truesize += copy;
1863 sk->sk_wmem_queued += copy;
1864 sk_mem_charge(sk, copy);
1865 return 0;
1866}
1867
c564039f
ED
1868/**
1869 * sk_wmem_alloc_get - returns write allocations
1870 * @sk: socket
1871 *
1872 * Returns sk_wmem_alloc minus initial offset of one
1873 */
1874static inline int sk_wmem_alloc_get(const struct sock *sk)
1875{
1876 return atomic_read(&sk->sk_wmem_alloc) - 1;
1877}
1878
1879/**
1880 * sk_rmem_alloc_get - returns read allocations
1881 * @sk: socket
1882 *
1883 * Returns sk_rmem_alloc
1884 */
1885static inline int sk_rmem_alloc_get(const struct sock *sk)
1886{
1887 return atomic_read(&sk->sk_rmem_alloc);
1888}
1889
1890/**
1891 * sk_has_allocations - check if allocations are outstanding
1892 * @sk: socket
1893 *
1894 * Returns true if socket has write or read allocations
1895 */
dc6b9b78 1896static inline bool sk_has_allocations(const struct sock *sk)
c564039f
ED
1897{
1898 return sk_wmem_alloc_get(sk) || sk_rmem_alloc_get(sk);
1899}
1900
a57de0b4 1901/**
1ce0bf50 1902 * skwq_has_sleeper - check if there are any waiting processes
acfbe96a 1903 * @wq: struct socket_wq
a57de0b4 1904 *
43815482 1905 * Returns true if socket_wq has waiting processes
a57de0b4 1906 *
1ce0bf50 1907 * The purpose of the skwq_has_sleeper and sock_poll_wait is to wrap the memory
a57de0b4
JO
1908 * barrier call. They were added due to the race found within the tcp code.
1909 *
1910 * Consider following tcp code paths:
1911 *
1912 * CPU1 CPU2
1913 *
1914 * sys_select receive packet
1915 * ... ...
1916 * __add_wait_queue update tp->rcv_nxt
1917 * ... ...
1918 * tp->rcv_nxt check sock_def_readable
1919 * ... {
43815482
ED
1920 * schedule rcu_read_lock();
1921 * wq = rcu_dereference(sk->sk_wq);
1922 * if (wq && waitqueue_active(&wq->wait))
1923 * wake_up_interruptible(&wq->wait)
a57de0b4
JO
1924 * ...
1925 * }
1926 *
1927 * The race for tcp fires when the __add_wait_queue changes done by CPU1 stay
1928 * in its cache, and so does the tp->rcv_nxt update on CPU2 side. The CPU1
1929 * could then endup calling schedule and sleep forever if there are no more
1930 * data on the socket.
ad462769 1931 *
a57de0b4 1932 */
1ce0bf50 1933static inline bool skwq_has_sleeper(struct socket_wq *wq)
a57de0b4 1934{
1ce0bf50 1935 return wq && wq_has_sleeper(&wq->wait);
a57de0b4
JO
1936}
1937
1938/**
1939 * sock_poll_wait - place memory barrier behind the poll_wait call.
1940 * @filp: file
1941 * @wait_address: socket wait queue
1942 * @p: poll_table
1943 *
43815482 1944 * See the comments in the wq_has_sleeper function.
a57de0b4
JO
1945 */
1946static inline void sock_poll_wait(struct file *filp,
1947 wait_queue_head_t *wait_address, poll_table *p)
1948{
626cf236 1949 if (!poll_does_not_wait(p) && wait_address) {
a57de0b4 1950 poll_wait(filp, wait_address, p);
dc6b9b78 1951 /* We need to be sure we are in sync with the
a57de0b4
JO
1952 * socket flags modification.
1953 *
43815482 1954 * This memory barrier is paired in the wq_has_sleeper.
dc6b9b78 1955 */
a57de0b4
JO
1956 smp_mb();
1957 }
1958}
1959
b73c3d0e
TH
1960static inline void skb_set_hash_from_sk(struct sk_buff *skb, struct sock *sk)
1961{
1962 if (sk->sk_txhash) {
1963 skb->l4_hash = 1;
1964 skb->hash = sk->sk_txhash;
1965 }
1966}
1967
9e17f8a4
ED
1968void skb_set_owner_w(struct sk_buff *skb, struct sock *sk);
1969
1da177e4 1970/*
dc6b9b78 1971 * Queue a received datagram if it will fit. Stream and sequenced
1da177e4
LT
1972 * protocols can't normally use this as they need to fit buffers in
1973 * and play with them.
1974 *
dc6b9b78 1975 * Inlined as it's very short and called for pretty much every
1da177e4
LT
1976 * packet ever received.
1977 */
1da177e4
LT
1978static inline void skb_set_owner_r(struct sk_buff *skb, struct sock *sk)
1979{
d55d87fd 1980 skb_orphan(skb);
1da177e4
LT
1981 skb->sk = sk;
1982 skb->destructor = sock_rfree;
1983 atomic_add(skb->truesize, &sk->sk_rmem_alloc);
3ab224be 1984 sk_mem_charge(sk, skb->truesize);
1da177e4
LT
1985}
1986
69336bd2
JP
1987void sk_reset_timer(struct sock *sk, struct timer_list *timer,
1988 unsigned long expires);
1da177e4 1989
69336bd2 1990void sk_stop_timer(struct sock *sk, struct timer_list *timer);
1da177e4 1991
f8c3bf00
PA
1992int __sk_queue_drop_skb(struct sock *sk, struct sk_buff *skb,
1993 unsigned int flags);
e6afc8ac 1994int __sock_queue_rcv_skb(struct sock *sk, struct sk_buff *skb);
69336bd2 1995int sock_queue_rcv_skb(struct sock *sk, struct sk_buff *skb);
1da177e4 1996
69336bd2 1997int sock_queue_err_skb(struct sock *sk, struct sk_buff *skb);
364a9e93 1998struct sk_buff *sock_dequeue_err_skb(struct sock *sk);
1da177e4
LT
1999
2000/*
2001 * Recover an error report and clear atomically
2002 */
dc6b9b78 2003
1da177e4
LT
2004static inline int sock_error(struct sock *sk)
2005{
c1cbe4b7
BL
2006 int err;
2007 if (likely(!sk->sk_err))
2008 return 0;
2009 err = xchg(&sk->sk_err, 0);
1da177e4
LT
2010 return -err;
2011}
2012
2013static inline unsigned long sock_wspace(struct sock *sk)
2014{
2015 int amt = 0;
2016
2017 if (!(sk->sk_shutdown & SEND_SHUTDOWN)) {
2018 amt = sk->sk_sndbuf - atomic_read(&sk->sk_wmem_alloc);
dc6b9b78 2019 if (amt < 0)
1da177e4
LT
2020 amt = 0;
2021 }
2022 return amt;
2023}
2024
ceb5d58b
ED
2025/* Note:
2026 * We use sk->sk_wq_raw, from contexts knowing this
2027 * pointer is not NULL and cannot disappear/change.
2028 */
9cd3e072 2029static inline void sk_set_bit(int nr, struct sock *sk)
1da177e4 2030{
4be73522
ED
2031 if ((nr == SOCKWQ_ASYNC_NOSPACE || nr == SOCKWQ_ASYNC_WAITDATA) &&
2032 !sock_flag(sk, SOCK_FASYNC))
9317bb69
ED
2033 return;
2034
ceb5d58b 2035 set_bit(nr, &sk->sk_wq_raw->flags);
9cd3e072
ED
2036}
2037
2038static inline void sk_clear_bit(int nr, struct sock *sk)
2039{
4be73522
ED
2040 if ((nr == SOCKWQ_ASYNC_NOSPACE || nr == SOCKWQ_ASYNC_WAITDATA) &&
2041 !sock_flag(sk, SOCK_FASYNC))
9317bb69
ED
2042 return;
2043
ceb5d58b 2044 clear_bit(nr, &sk->sk_wq_raw->flags);
9cd3e072
ED
2045}
2046
ceb5d58b 2047static inline void sk_wake_async(const struct sock *sk, int how, int band)
1da177e4 2048{
ceb5d58b
ED
2049 if (sock_flag(sk, SOCK_FASYNC)) {
2050 rcu_read_lock();
2051 sock_wake_async(rcu_dereference(sk->sk_wq), how, band);
2052 rcu_read_unlock();
2053 }
1da177e4
LT
2054}
2055
eea86af6
DB
2056/* Since sk_{r,w}mem_alloc sums skb->truesize, even a small frame might
2057 * need sizeof(sk_buff) + MTU + padding, unless net driver perform copybreak.
2058 * Note: for send buffers, TCP works better if we can build two skbs at
2059 * minimum.
7a91b434 2060 */
9eb5bf83 2061#define TCP_SKB_MIN_TRUESIZE (2048 + SKB_DATA_ALIGN(sizeof(struct sk_buff)))
eea86af6
DB
2062
2063#define SOCK_MIN_SNDBUF (TCP_SKB_MIN_TRUESIZE * 2)
2064#define SOCK_MIN_RCVBUF TCP_SKB_MIN_TRUESIZE
1da177e4
LT
2065
2066static inline void sk_stream_moderate_sndbuf(struct sock *sk)
2067{
2068 if (!(sk->sk_userlocks & SOCK_SNDBUF_LOCK)) {
8df09ea3 2069 sk->sk_sndbuf = min(sk->sk_sndbuf, sk->sk_wmem_queued >> 1);
eea86af6 2070 sk->sk_sndbuf = max_t(u32, sk->sk_sndbuf, SOCK_MIN_SNDBUF);
1da177e4
LT
2071 }
2072}
2073
eb934478
ED
2074struct sk_buff *sk_stream_alloc_skb(struct sock *sk, int size, gfp_t gfp,
2075 bool force_schedule);
1da177e4 2076
5640f768
ED
2077/**
2078 * sk_page_frag - return an appropriate page_frag
2079 * @sk: socket
2080 *
2081 * If socket allocation mode allows current thread to sleep, it means its
2082 * safe to use the per task page_frag instead of the per socket one.
2083 */
2084static inline struct page_frag *sk_page_frag(struct sock *sk)
1da177e4 2085{
d0164adc 2086 if (gfpflags_allow_blocking(sk->sk_allocation))
5640f768 2087 return &current->task_frag;
1da177e4 2088
5640f768 2089 return &sk->sk_frag;
1da177e4
LT
2090}
2091
69336bd2 2092bool sk_page_frag_refill(struct sock *sk, struct page_frag *pfrag);
5640f768 2093
1da177e4
LT
2094/*
2095 * Default write policy as shown to user space via poll/select/SIGIO
2096 */
dc6b9b78 2097static inline bool sock_writeable(const struct sock *sk)
1da177e4 2098{
8df09ea3 2099 return atomic_read(&sk->sk_wmem_alloc) < (sk->sk_sndbuf >> 1);
1da177e4
LT
2100}
2101
dd0fc66f 2102static inline gfp_t gfp_any(void)
1da177e4 2103{
99709372 2104 return in_softirq() ? GFP_ATOMIC : GFP_KERNEL;
1da177e4
LT
2105}
2106
dc6b9b78 2107static inline long sock_rcvtimeo(const struct sock *sk, bool noblock)
1da177e4
LT
2108{
2109 return noblock ? 0 : sk->sk_rcvtimeo;
2110}
2111
dc6b9b78 2112static inline long sock_sndtimeo(const struct sock *sk, bool noblock)
1da177e4
LT
2113{
2114 return noblock ? 0 : sk->sk_sndtimeo;
2115}
2116
2117static inline int sock_rcvlowat(const struct sock *sk, int waitall, int len)
2118{
2119 return (waitall ? len : min_t(int, sk->sk_rcvlowat, len)) ? : 1;
2120}
2121
2122/* Alas, with timeout socket operations are not restartable.
2123 * Compare this to poll().
2124 */
2125static inline int sock_intr_errno(long timeo)
2126{
2127 return timeo == MAX_SCHEDULE_TIMEOUT ? -ERESTARTSYS : -EINTR;
2128}
2129
744d5a3e
EB
2130struct sock_skb_cb {
2131 u32 dropcount;
2132};
2133
2134/* Store sock_skb_cb at the end of skb->cb[] so protocol families
2135 * using skb->cb[] would keep using it directly and utilize its
2136 * alignement guarantee.
2137 */
2138#define SOCK_SKB_CB_OFFSET ((FIELD_SIZEOF(struct sk_buff, cb) - \
2139 sizeof(struct sock_skb_cb)))
2140
2141#define SOCK_SKB_CB(__skb) ((struct sock_skb_cb *)((__skb)->cb + \
2142 SOCK_SKB_CB_OFFSET))
2143
b4772ef8 2144#define sock_skb_cb_check_size(size) \
744d5a3e 2145 BUILD_BUG_ON((size) > SOCK_SKB_CB_OFFSET)
b4772ef8 2146
3bc3b96f
EB
2147static inline void
2148sock_skb_set_dropcount(const struct sock *sk, struct sk_buff *skb)
2149{
744d5a3e 2150 SOCK_SKB_CB(skb)->dropcount = atomic_read(&sk->sk_drops);
3bc3b96f
EB
2151}
2152
532182cd
ED
2153static inline void sk_drops_add(struct sock *sk, const struct sk_buff *skb)
2154{
2155 int segs = max_t(u16, 1, skb_shinfo(skb)->gso_segs);
2156
2157 atomic_add(segs, &sk->sk_drops);
2158}
2159
69336bd2
JP
2160void __sock_recv_timestamp(struct msghdr *msg, struct sock *sk,
2161 struct sk_buff *skb);
2162void __sock_recv_wifi_status(struct msghdr *msg, struct sock *sk,
2163 struct sk_buff *skb);
92f37fd2 2164
dc6b9b78 2165static inline void
1da177e4
LT
2166sock_recv_timestamp(struct msghdr *msg, struct sock *sk, struct sk_buff *skb)
2167{
b7aa0bf7 2168 ktime_t kt = skb->tstamp;
20d49473 2169 struct skb_shared_hwtstamps *hwtstamps = skb_hwtstamps(skb);
a61bbcf2 2170
20d49473
PO
2171 /*
2172 * generate control messages if
b9f40e21 2173 * - receive time stamping in software requested
20d49473 2174 * - software time stamp available and wanted
20d49473 2175 * - hardware time stamps available and wanted
20d49473
PO
2176 */
2177 if (sock_flag(sk, SOCK_RCVTSTAMP) ||
b9f40e21 2178 (sk->sk_tsflags & SOF_TIMESTAMPING_RX_SOFTWARE) ||
c199105d 2179 (kt.tv64 && sk->sk_tsflags & SOF_TIMESTAMPING_SOFTWARE) ||
20d49473 2180 (hwtstamps->hwtstamp.tv64 &&
b9f40e21 2181 (sk->sk_tsflags & SOF_TIMESTAMPING_RAW_HARDWARE)))
92f37fd2
ED
2182 __sock_recv_timestamp(msg, sk, skb);
2183 else
b7aa0bf7 2184 sk->sk_stamp = kt;
6e3e939f
JB
2185
2186 if (sock_flag(sk, SOCK_WIFI_STATUS) && skb->wifi_acked_valid)
2187 __sock_recv_wifi_status(msg, sk, skb);
1da177e4
LT
2188}
2189
69336bd2
JP
2190void __sock_recv_ts_and_drops(struct msghdr *msg, struct sock *sk,
2191 struct sk_buff *skb);
767dd033
ED
2192
2193static inline void sock_recv_ts_and_drops(struct msghdr *msg, struct sock *sk,
2194 struct sk_buff *skb)
2195{
2196#define FLAGS_TS_OR_DROPS ((1UL << SOCK_RXQ_OVFL) | \
b9f40e21
WB
2197 (1UL << SOCK_RCVTSTAMP))
2198#define TSFLAGS_ANY (SOF_TIMESTAMPING_SOFTWARE | \
2199 SOF_TIMESTAMPING_RAW_HARDWARE)
767dd033 2200
b9f40e21 2201 if (sk->sk_flags & FLAGS_TS_OR_DROPS || sk->sk_tsflags & TSFLAGS_ANY)
767dd033
ED
2202 __sock_recv_ts_and_drops(msg, sk, skb);
2203 else
2204 sk->sk_stamp = skb->tstamp;
2205}
3b885787 2206
c14ac945 2207void __sock_tx_timestamp(__u16 tsflags, __u8 *tx_flags);
67cc0d40 2208
20d49473
PO
2209/**
2210 * sock_tx_timestamp - checks whether the outgoing packet is to be time stamped
20d49473 2211 * @sk: socket sending this packet
c14ac945 2212 * @tsflags: timestamping flags to use
140c55d4
ED
2213 * @tx_flags: completed with instructions for time stamping
2214 *
2215 * Note : callers should take care of initial *tx_flags value (usually 0)
20d49473 2216 */
c14ac945
SHY
2217static inline void sock_tx_timestamp(const struct sock *sk, __u16 tsflags,
2218 __u8 *tx_flags)
67cc0d40 2219{
c14ac945
SHY
2220 if (unlikely(tsflags))
2221 __sock_tx_timestamp(tsflags, tx_flags);
67cc0d40
WB
2222 if (unlikely(sock_flag(sk, SOCK_WIFI_STATUS)))
2223 *tx_flags |= SKBTX_WIFI_STATUS;
2224}
20d49473 2225
1da177e4
LT
2226/**
2227 * sk_eat_skb - Release a skb if it is no longer needed
4dc3b16b
PP
2228 * @sk: socket to eat this skb from
2229 * @skb: socket buffer to eat
1da177e4
LT
2230 *
2231 * This routine must be called with interrupts disabled or with the socket
2232 * locked so that the sk_buff queue operation is ok.
2233*/
7bced397 2234static inline void sk_eat_skb(struct sock *sk, struct sk_buff *skb)
1da177e4
LT
2235{
2236 __skb_unlink(skb, &sk->sk_receive_queue);
2237 __kfree_skb(skb);
2238}
2239
3b1e0a65
YH
2240static inline
2241struct net *sock_net(const struct sock *sk)
2242{
c2d9ba9b 2243 return read_pnet(&sk->sk_net);
3b1e0a65
YH
2244}
2245
2246static inline
f5aa23fd 2247void sock_net_set(struct sock *sk, struct net *net)
3b1e0a65 2248{
c2d9ba9b 2249 write_pnet(&sk->sk_net, net);
3b1e0a65
YH
2250}
2251
23542618
KK
2252static inline struct sock *skb_steal_sock(struct sk_buff *skb)
2253{
efc27f8c 2254 if (skb->sk) {
23542618
KK
2255 struct sock *sk = skb->sk;
2256
2257 skb->destructor = NULL;
2258 skb->sk = NULL;
2259 return sk;
2260 }
2261 return NULL;
2262}
2263
1d0ab253
ED
2264/* This helper checks if a socket is a full socket,
2265 * ie _not_ a timewait or request socket.
2266 */
2267static inline bool sk_fullsock(const struct sock *sk)
2268{
2269 return (1 << sk->sk_state) & ~(TCPF_TIME_WAIT | TCPF_NEW_SYN_RECV);
2270}
2271
e446f9df
ED
2272/* This helper checks if a socket is a LISTEN or NEW_SYN_RECV
2273 * SYNACK messages can be attached to either ones (depending on SYNCOOKIE)
2274 */
2275static inline bool sk_listener(const struct sock *sk)
2276{
2277 return (1 << sk->sk_state) & (TCPF_LISTEN | TCPF_NEW_SYN_RECV);
2278}
2279
00fd38d9
ED
2280/**
2281 * sk_state_load - read sk->sk_state for lockless contexts
2282 * @sk: socket pointer
2283 *
2284 * Paired with sk_state_store(). Used in places we do not hold socket lock :
2285 * tcp_diag_get_info(), tcp_get_info(), tcp_poll(), get_tcp4_sock() ...
2286 */
2287static inline int sk_state_load(const struct sock *sk)
2288{
2289 return smp_load_acquire(&sk->sk_state);
2290}
2291
2292/**
2293 * sk_state_store - update sk->sk_state
2294 * @sk: socket pointer
2295 * @newstate: new state
2296 *
2297 * Paired with sk_state_load(). Should be used in contexts where
2298 * state change might impact lockless readers.
2299 */
2300static inline void sk_state_store(struct sock *sk, int newstate)
2301{
2302 smp_store_release(&sk->sk_state, newstate);
2303}
2304
69336bd2
JP
2305void sock_enable_timestamp(struct sock *sk, int flag);
2306int sock_get_timestamp(struct sock *, struct timeval __user *);
2307int sock_get_timestampns(struct sock *, struct timespec __user *);
2308int sock_recv_errqueue(struct sock *sk, struct msghdr *msg, int len, int level,
2309 int type);
1da177e4 2310
a3b299da
EB
2311bool sk_ns_capable(const struct sock *sk,
2312 struct user_namespace *user_ns, int cap);
2313bool sk_capable(const struct sock *sk, int cap);
2314bool sk_net_capable(const struct sock *sk, int cap);
2315
1da177e4
LT
2316extern __u32 sysctl_wmem_max;
2317extern __u32 sysctl_rmem_max;
2318
b245be1f 2319extern int sysctl_tstamp_allow_data;
6baf1f41
DM
2320extern int sysctl_optmem_max;
2321
20380731
ACM
2322extern __u32 sysctl_wmem_default;
2323extern __u32 sysctl_rmem_default;
20380731 2324
1da177e4 2325#endif /* _SOCK_H */