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