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