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