net: Introduce __inet_bind() and __inet6_bind
[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);
1da177e4 484 void (*sk_destruct)(struct sock *sk);
ef456144 485 struct sock_reuseport __rcu *sk_reuseport_cb;
a4298e45 486 struct rcu_head sk_rcu;
1da177e4
LT
487};
488
218af599
ED
489enum sk_pacing {
490 SK_PACING_NONE = 0,
491 SK_PACING_NEEDED = 1,
492 SK_PACING_FQ = 2,
493};
494
559835ea
PS
495#define __sk_user_data(sk) ((*((void __rcu **)&(sk)->sk_user_data)))
496
497#define rcu_dereference_sk_user_data(sk) rcu_dereference(__sk_user_data((sk)))
498#define rcu_assign_sk_user_data(sk, ptr) rcu_assign_pointer(__sk_user_data((sk)), ptr)
499
4a17fd52
PE
500/*
501 * SK_CAN_REUSE and SK_NO_REUSE on a socket mean that the socket is OK
502 * or not whether his port will be reused by someone else. SK_FORCE_REUSE
503 * on a socket means that the socket will reuse everybody else's port
504 * without looking at the other's sk_reuse value.
505 */
506
507#define SK_NO_REUSE 0
508#define SK_CAN_REUSE 1
509#define SK_FORCE_REUSE 2
510
627d2d6b 511int sk_set_peek_off(struct sock *sk, int val);
512
ef64a54f
PE
513static inline int sk_peek_offset(struct sock *sk, int flags)
514{
b9bb53f3 515 if (unlikely(flags & MSG_PEEK)) {
a0917e0b 516 return READ_ONCE(sk->sk_peek_off);
b9bb53f3
WB
517 }
518
519 return 0;
ef64a54f
PE
520}
521
522static inline void sk_peek_offset_bwd(struct sock *sk, int val)
523{
b9bb53f3
WB
524 s32 off = READ_ONCE(sk->sk_peek_off);
525
526 if (unlikely(off >= 0)) {
527 off = max_t(s32, off - val, 0);
528 WRITE_ONCE(sk->sk_peek_off, off);
ef64a54f
PE
529 }
530}
531
532static inline void sk_peek_offset_fwd(struct sock *sk, int val)
533{
b9bb53f3 534 sk_peek_offset_bwd(sk, -val);
ef64a54f
PE
535}
536
1da177e4
LT
537/*
538 * Hashed lists helper routines
539 */
c4146644
LZ
540static inline struct sock *sk_entry(const struct hlist_node *node)
541{
542 return hlist_entry(node, struct sock, sk_node);
543}
544
e48c414e 545static inline struct sock *__sk_head(const struct hlist_head *head)
1da177e4
LT
546{
547 return hlist_entry(head->first, struct sock, sk_node);
548}
549
e48c414e 550static inline struct sock *sk_head(const struct hlist_head *head)
1da177e4
LT
551{
552 return hlist_empty(head) ? NULL : __sk_head(head);
553}
554
88ab1932
ED
555static inline struct sock *__sk_nulls_head(const struct hlist_nulls_head *head)
556{
557 return hlist_nulls_entry(head->first, struct sock, sk_nulls_node);
558}
559
560static inline struct sock *sk_nulls_head(const struct hlist_nulls_head *head)
561{
562 return hlist_nulls_empty(head) ? NULL : __sk_nulls_head(head);
563}
564
e48c414e 565static inline struct sock *sk_next(const struct sock *sk)
1da177e4 566{
6c59ebd3 567 return hlist_entry_safe(sk->sk_node.next, struct sock, sk_node);
1da177e4
LT
568}
569
88ab1932
ED
570static inline struct sock *sk_nulls_next(const struct sock *sk)
571{
572 return (!is_a_nulls(sk->sk_nulls_node.next)) ?
573 hlist_nulls_entry(sk->sk_nulls_node.next,
574 struct sock, sk_nulls_node) :
575 NULL;
576}
577
dc6b9b78 578static inline bool sk_unhashed(const struct sock *sk)
1da177e4
LT
579{
580 return hlist_unhashed(&sk->sk_node);
581}
582
dc6b9b78 583static inline bool sk_hashed(const struct sock *sk)
1da177e4 584{
da753bea 585 return !sk_unhashed(sk);
1da177e4
LT
586}
587
dc6b9b78 588static inline void sk_node_init(struct hlist_node *node)
1da177e4
LT
589{
590 node->pprev = NULL;
591}
592
dc6b9b78 593static inline void sk_nulls_node_init(struct hlist_nulls_node *node)
88ab1932
ED
594{
595 node->pprev = NULL;
596}
597
dc6b9b78 598static inline void __sk_del_node(struct sock *sk)
1da177e4
LT
599{
600 __hlist_del(&sk->sk_node);
601}
602
808f5114 603/* NB: equivalent to hlist_del_init_rcu */
dc6b9b78 604static inline bool __sk_del_node_init(struct sock *sk)
1da177e4
LT
605{
606 if (sk_hashed(sk)) {
607 __sk_del_node(sk);
608 sk_node_init(&sk->sk_node);
dc6b9b78 609 return true;
1da177e4 610 }
dc6b9b78 611 return false;
1da177e4
LT
612}
613
614/* Grab socket reference count. This operation is valid only
615 when sk is ALREADY grabbed f.e. it is found in hash table
616 or a list and the lookup is made under lock preventing hash table
617 modifications.
618 */
619
f9a7cbbf 620static __always_inline void sock_hold(struct sock *sk)
1da177e4 621{
41c6d650 622 refcount_inc(&sk->sk_refcnt);
1da177e4
LT
623}
624
625/* Ungrab socket in the context, which assumes that socket refcnt
626 cannot hit zero, f.e. it is true in context of any socketcall.
627 */
f9a7cbbf 628static __always_inline void __sock_put(struct sock *sk)
1da177e4 629{
41c6d650 630 refcount_dec(&sk->sk_refcnt);
1da177e4
LT
631}
632
dc6b9b78 633static inline bool sk_del_node_init(struct sock *sk)
1da177e4 634{
dc6b9b78 635 bool rc = __sk_del_node_init(sk);
1da177e4
LT
636
637 if (rc) {
638 /* paranoid for a while -acme */
41c6d650 639 WARN_ON(refcount_read(&sk->sk_refcnt) == 1);
1da177e4
LT
640 __sock_put(sk);
641 }
642 return rc;
643}
808f5114 644#define sk_del_node_init_rcu(sk) sk_del_node_init(sk)
1da177e4 645
dc6b9b78 646static inline bool __sk_nulls_del_node_init_rcu(struct sock *sk)
271b72c7
ED
647{
648 if (sk_hashed(sk)) {
88ab1932 649 hlist_nulls_del_init_rcu(&sk->sk_nulls_node);
dc6b9b78 650 return true;
271b72c7 651 }
dc6b9b78 652 return false;
271b72c7
ED
653}
654
dc6b9b78 655static inline bool sk_nulls_del_node_init_rcu(struct sock *sk)
271b72c7 656{
dc6b9b78 657 bool rc = __sk_nulls_del_node_init_rcu(sk);
271b72c7
ED
658
659 if (rc) {
660 /* paranoid for a while -acme */
41c6d650 661 WARN_ON(refcount_read(&sk->sk_refcnt) == 1);
271b72c7
ED
662 __sock_put(sk);
663 }
664 return rc;
665}
666
dc6b9b78 667static inline void __sk_add_node(struct sock *sk, struct hlist_head *list)
1da177e4
LT
668{
669 hlist_add_head(&sk->sk_node, list);
670}
671
dc6b9b78 672static inline void sk_add_node(struct sock *sk, struct hlist_head *list)
1da177e4
LT
673{
674 sock_hold(sk);
675 __sk_add_node(sk, list);
676}
677
dc6b9b78 678static inline void sk_add_node_rcu(struct sock *sk, struct hlist_head *list)
808f5114 679{
680 sock_hold(sk);
d296ba60
CG
681 if (IS_ENABLED(CONFIG_IPV6) && sk->sk_reuseport &&
682 sk->sk_family == AF_INET6)
683 hlist_add_tail_rcu(&sk->sk_node, list);
684 else
685 hlist_add_head_rcu(&sk->sk_node, list);
808f5114 686}
687
dc6b9b78 688static inline void __sk_nulls_add_node_rcu(struct sock *sk, struct hlist_nulls_head *list)
271b72c7 689{
d7efc6c1 690 hlist_nulls_add_head_rcu(&sk->sk_nulls_node, list);
271b72c7
ED
691}
692
dc6b9b78 693static inline void sk_nulls_add_node_rcu(struct sock *sk, struct hlist_nulls_head *list)
271b72c7
ED
694{
695 sock_hold(sk);
88ab1932 696 __sk_nulls_add_node_rcu(sk, list);
271b72c7
ED
697}
698
dc6b9b78 699static inline void __sk_del_bind_node(struct sock *sk)
1da177e4
LT
700{
701 __hlist_del(&sk->sk_bind_node);
702}
703
dc6b9b78 704static inline void sk_add_bind_node(struct sock *sk,
1da177e4
LT
705 struct hlist_head *list)
706{
707 hlist_add_head(&sk->sk_bind_node, list);
708}
709
b67bfe0d
SL
710#define sk_for_each(__sk, list) \
711 hlist_for_each_entry(__sk, list, sk_node)
712#define sk_for_each_rcu(__sk, list) \
713 hlist_for_each_entry_rcu(__sk, list, sk_node)
88ab1932
ED
714#define sk_nulls_for_each(__sk, node, list) \
715 hlist_nulls_for_each_entry(__sk, node, list, sk_nulls_node)
716#define sk_nulls_for_each_rcu(__sk, node, list) \
717 hlist_nulls_for_each_entry_rcu(__sk, node, list, sk_nulls_node)
b67bfe0d
SL
718#define sk_for_each_from(__sk) \
719 hlist_for_each_entry_from(__sk, sk_node)
88ab1932
ED
720#define sk_nulls_for_each_from(__sk, node) \
721 if (__sk && ({ node = &(__sk)->sk_nulls_node; 1; })) \
722 hlist_nulls_for_each_entry_from(__sk, node, sk_nulls_node)
b67bfe0d
SL
723#define sk_for_each_safe(__sk, tmp, list) \
724 hlist_for_each_entry_safe(__sk, tmp, list, sk_node)
725#define sk_for_each_bound(__sk, list) \
726 hlist_for_each_entry(__sk, list, sk_bind_node)
1da177e4 727
2dc41cff 728/**
ca065d0c 729 * sk_for_each_entry_offset_rcu - iterate over a list at a given struct offset
2dc41cff
DH
730 * @tpos: the type * to use as a loop cursor.
731 * @pos: the &struct hlist_node to use as a loop cursor.
732 * @head: the head for your list.
733 * @offset: offset of hlist_node within the struct.
734 *
735 */
ca065d0c 736#define sk_for_each_entry_offset_rcu(tpos, pos, head, offset) \
b6f4f848 737 for (pos = rcu_dereference(hlist_first_rcu(head)); \
ca065d0c 738 pos != NULL && \
2dc41cff 739 ({ tpos = (typeof(*tpos) *)((void *)pos - offset); 1;}); \
b6f4f848 740 pos = rcu_dereference(hlist_next_rcu(pos)))
2dc41cff 741
c336d148
EB
742static inline struct user_namespace *sk_user_ns(struct sock *sk)
743{
744 /* Careful only use this in a context where these parameters
745 * can not change and must all be valid, such as recvmsg from
746 * userspace.
747 */
748 return sk->sk_socket->file->f_cred->user_ns;
749}
750
1da177e4
LT
751/* Sock flags */
752enum sock_flags {
753 SOCK_DEAD,
754 SOCK_DONE,
755 SOCK_URGINLINE,
756 SOCK_KEEPOPEN,
757 SOCK_LINGER,
758 SOCK_DESTROY,
759 SOCK_BROADCAST,
760 SOCK_TIMESTAMP,
761 SOCK_ZAPPED,
762 SOCK_USE_WRITE_QUEUE, /* whether to call sk->sk_write_space in sock_wfree */
763 SOCK_DBG, /* %SO_DEBUG setting */
764 SOCK_RCVTSTAMP, /* %SO_TIMESTAMP setting */
92f37fd2 765 SOCK_RCVTSTAMPNS, /* %SO_TIMESTAMPNS setting */
1da177e4
LT
766 SOCK_LOCALROUTE, /* route locally only, %SO_DONTROUTE setting */
767 SOCK_QUEUE_SHRUNK, /* write queue has been shrunk recently */
7cb02404 768 SOCK_MEMALLOC, /* VM depends on this socket for swapping */
20d49473 769 SOCK_TIMESTAMPING_RX_SOFTWARE, /* %SOF_TIMESTAMPING_RX_SOFTWARE */
bcdce719 770 SOCK_FASYNC, /* fasync() active */
3b885787 771 SOCK_RXQ_OVFL,
1cdebb42 772 SOCK_ZEROCOPY, /* buffers from userspace */
6e3e939f 773 SOCK_WIFI_STATUS, /* push wifi status to userspace */
3bdc0eba
BG
774 SOCK_NOFCS, /* Tell NIC not to do the Ethernet FCS.
775 * Will use last 4 bytes of packet sent from
776 * user-space instead.
777 */
d59577b6 778 SOCK_FILTER_LOCKED, /* Filter cannot be changed anymore */
7d4c04fc 779 SOCK_SELECT_ERR_QUEUE, /* Wake select on error queue */
a4298e45 780 SOCK_RCU_FREE, /* wait rcu grace period in sk_destruct() */
1da177e4
LT
781};
782
01ce63c9
MRL
783#define SK_FLAGS_TIMESTAMP ((1UL << SOCK_TIMESTAMP) | (1UL << SOCK_TIMESTAMPING_RX_SOFTWARE))
784
53b924b3
RB
785static inline void sock_copy_flags(struct sock *nsk, struct sock *osk)
786{
787 nsk->sk_flags = osk->sk_flags;
788}
789
1da177e4
LT
790static inline void sock_set_flag(struct sock *sk, enum sock_flags flag)
791{
792 __set_bit(flag, &sk->sk_flags);
793}
794
795static inline void sock_reset_flag(struct sock *sk, enum sock_flags flag)
796{
797 __clear_bit(flag, &sk->sk_flags);
798}
799
1b23a5df 800static inline bool sock_flag(const struct sock *sk, enum sock_flags flag)
1da177e4
LT
801{
802 return test_bit(flag, &sk->sk_flags);
803}
804
c93bdd0e
MG
805#ifdef CONFIG_NET
806extern struct static_key memalloc_socks;
807static inline int sk_memalloc_socks(void)
808{
809 return static_key_false(&memalloc_socks);
810}
811#else
812
813static inline int sk_memalloc_socks(void)
814{
815 return 0;
816}
817
818#endif
819
7450aaf6 820static inline gfp_t sk_gfp_mask(const struct sock *sk, gfp_t gfp_mask)
99a1dec7 821{
7450aaf6 822 return gfp_mask | (sk->sk_allocation & __GFP_MEMALLOC);
99a1dec7
MG
823}
824
1da177e4
LT
825static inline void sk_acceptq_removed(struct sock *sk)
826{
827 sk->sk_ack_backlog--;
828}
829
830static inline void sk_acceptq_added(struct sock *sk)
831{
832 sk->sk_ack_backlog++;
833}
834
dc6b9b78 835static inline bool sk_acceptq_is_full(const struct sock *sk)
1da177e4 836{
64a14651 837 return sk->sk_ack_backlog > sk->sk_max_ack_backlog;
1da177e4
LT
838}
839
840/*
841 * Compute minimal free write space needed to queue new packets.
842 */
dc6b9b78 843static inline int sk_stream_min_wspace(const struct sock *sk)
1da177e4 844{
8df09ea3 845 return sk->sk_wmem_queued >> 1;
1da177e4
LT
846}
847
dc6b9b78 848static inline int sk_stream_wspace(const struct sock *sk)
1da177e4
LT
849{
850 return sk->sk_sndbuf - sk->sk_wmem_queued;
851}
852
69336bd2 853void sk_stream_write_space(struct sock *sk);
1da177e4 854
8eae939f 855/* OOB backlog add */
a3a858ff 856static inline void __sk_add_backlog(struct sock *sk, struct sk_buff *skb)
9ee6b535 857{
7fee226a 858 /* dont let skb dst not refcounted, we are going to leave rcu lock */
222d7dbd 859 skb_dst_force(skb);
7fee226a
ED
860
861 if (!sk->sk_backlog.tail)
862 sk->sk_backlog.head = skb;
863 else
9ee6b535 864 sk->sk_backlog.tail->next = skb;
7fee226a
ED
865
866 sk->sk_backlog.tail = skb;
9ee6b535
SH
867 skb->next = NULL;
868}
1da177e4 869
c377411f
ED
870/*
871 * Take into account size of receive queue and backlog queue
0fd7bac6
ED
872 * Do not take into account this skb truesize,
873 * to allow even a single big packet to come.
c377411f 874 */
274f482d 875static inline bool sk_rcvqueues_full(const struct sock *sk, unsigned int limit)
c377411f
ED
876{
877 unsigned int qsize = sk->sk_backlog.len + atomic_read(&sk->sk_rmem_alloc);
878
f545a38f 879 return qsize > limit;
c377411f
ED
880}
881
8eae939f 882/* The per-socket spinlock must be held here. */
f545a38f
ED
883static inline __must_check int sk_add_backlog(struct sock *sk, struct sk_buff *skb,
884 unsigned int limit)
8eae939f 885{
274f482d 886 if (sk_rcvqueues_full(sk, limit))
8eae939f
ZY
887 return -ENOBUFS;
888
c7c49b8f
ED
889 /*
890 * If the skb was allocated from pfmemalloc reserves, only
891 * allow SOCK_MEMALLOC sockets to use it as this socket is
892 * helping free memory
893 */
894 if (skb_pfmemalloc(skb) && !sock_flag(sk, SOCK_MEMALLOC))
895 return -ENOMEM;
896
a3a858ff 897 __sk_add_backlog(sk, skb);
8eae939f
ZY
898 sk->sk_backlog.len += skb->truesize;
899 return 0;
900}
901
69336bd2 902int __sk_backlog_rcv(struct sock *sk, struct sk_buff *skb);
b4b9e355 903
c57943a1
PZ
904static inline int sk_backlog_rcv(struct sock *sk, struct sk_buff *skb)
905{
b4b9e355
MG
906 if (sk_memalloc_socks() && skb_pfmemalloc(skb))
907 return __sk_backlog_rcv(sk, skb);
908
c57943a1
PZ
909 return sk->sk_backlog_rcv(sk, skb);
910}
911
2c8c56e1
ED
912static inline void sk_incoming_cpu_update(struct sock *sk)
913{
34cfb542
PA
914 int cpu = raw_smp_processor_id();
915
916 if (unlikely(sk->sk_incoming_cpu != cpu))
917 sk->sk_incoming_cpu = cpu;
2c8c56e1
ED
918}
919
fe477558 920static inline void sock_rps_record_flow_hash(__u32 hash)
c58dc01b
DM
921{
922#ifdef CONFIG_RPS
923 struct rps_sock_flow_table *sock_flow_table;
924
925 rcu_read_lock();
926 sock_flow_table = rcu_dereference(rps_sock_flow_table);
fe477558 927 rps_record_sock_flow(sock_flow_table, hash);
c58dc01b
DM
928 rcu_read_unlock();
929#endif
930}
931
fe477558
TH
932static inline void sock_rps_record_flow(const struct sock *sk)
933{
c9d8ca04 934#ifdef CONFIG_RPS
13bfff25
ED
935 if (static_key_false(&rfs_needed)) {
936 /* Reading sk->sk_rxhash might incur an expensive cache line
937 * miss.
938 *
939 * TCP_ESTABLISHED does cover almost all states where RFS
940 * might be useful, and is cheaper [1] than testing :
941 * IPv4: inet_sk(sk)->inet_daddr
942 * IPv6: ipv6_addr_any(&sk->sk_v6_daddr)
943 * OR an additional socket flag
944 * [1] : sk_state and sk_prot are in the same cache line.
945 */
946 if (sk->sk_state == TCP_ESTABLISHED)
947 sock_rps_record_flow_hash(sk->sk_rxhash);
948 }
c9d8ca04 949#endif
fe477558
TH
950}
951
bdeab991
TH
952static inline void sock_rps_save_rxhash(struct sock *sk,
953 const struct sk_buff *skb)
c58dc01b
DM
954{
955#ifdef CONFIG_RPS
567e4b79 956 if (unlikely(sk->sk_rxhash != skb->hash))
61b905da 957 sk->sk_rxhash = skb->hash;
c58dc01b
DM
958#endif
959}
960
bdeab991
TH
961static inline void sock_rps_reset_rxhash(struct sock *sk)
962{
963#ifdef CONFIG_RPS
bdeab991
TH
964 sk->sk_rxhash = 0;
965#endif
966}
967
d9dc8b0f 968#define sk_wait_event(__sk, __timeo, __condition, __wait) \
cfcabdcc
SH
969 ({ int __rc; \
970 release_sock(__sk); \
971 __rc = __condition; \
972 if (!__rc) { \
d9dc8b0f
WC
973 *(__timeo) = wait_woken(__wait, \
974 TASK_INTERRUPTIBLE, \
975 *(__timeo)); \
cfcabdcc 976 } \
d9dc8b0f 977 sched_annotate_sleep(); \
cfcabdcc
SH
978 lock_sock(__sk); \
979 __rc = __condition; \
980 __rc; \
981 })
1da177e4 982
69336bd2
JP
983int sk_stream_wait_connect(struct sock *sk, long *timeo_p);
984int sk_stream_wait_memory(struct sock *sk, long *timeo_p);
985void sk_stream_wait_close(struct sock *sk, long timeo_p);
986int sk_stream_error(struct sock *sk, int flags, int err);
987void sk_stream_kill_queues(struct sock *sk);
988void sk_set_memalloc(struct sock *sk);
989void sk_clear_memalloc(struct sock *sk);
1da177e4 990
d41a69f1
ED
991void __sk_flush_backlog(struct sock *sk);
992
993static inline bool sk_flush_backlog(struct sock *sk)
994{
995 if (unlikely(READ_ONCE(sk->sk_backlog.tail))) {
996 __sk_flush_backlog(sk);
997 return true;
998 }
999 return false;
1000}
1001
dfbafc99 1002int sk_wait_data(struct sock *sk, long *timeo, const struct sk_buff *skb);
1da177e4 1003
60236fdd 1004struct request_sock_ops;
6d6ee43e 1005struct timewait_sock_ops;
ab1e0a13 1006struct inet_hashinfo;
fc8717ba 1007struct raw_hashinfo;
f16a7dd5 1008struct smc_hashinfo;
de477254 1009struct module;
2e6599cb 1010
f77d6021 1011/*
5f0d5a3a 1012 * caches using SLAB_TYPESAFE_BY_RCU should let .next pointer from nulls nodes
f77d6021
ED
1013 * un-modified. Special care is taken when initializing object to zero.
1014 */
1015static inline void sk_prot_clear_nulls(struct sock *sk, int size)
1016{
1017 if (offsetof(struct sock, sk_node.next) != 0)
1018 memset(sk, 0, offsetof(struct sock, sk_node.next));
1019 memset(&sk->sk_node.pprev, 0,
1020 size - offsetof(struct sock, sk_node.pprev));
1021}
1022
1da177e4
LT
1023/* Networking protocol blocks we attach to sockets.
1024 * socket layer -> transport layer interface
1da177e4
LT
1025 */
1026struct proto {
dc6b9b78 1027 void (*close)(struct sock *sk,
1da177e4
LT
1028 long timeout);
1029 int (*connect)(struct sock *sk,
dc6b9b78 1030 struct sockaddr *uaddr,
1da177e4
LT
1031 int addr_len);
1032 int (*disconnect)(struct sock *sk, int flags);
1033
cdfbabfb
DH
1034 struct sock * (*accept)(struct sock *sk, int flags, int *err,
1035 bool kern);
1da177e4
LT
1036
1037 int (*ioctl)(struct sock *sk, int cmd,
1038 unsigned long arg);
1039 int (*init)(struct sock *sk);
7d06b2e0 1040 void (*destroy)(struct sock *sk);
1da177e4 1041 void (*shutdown)(struct sock *sk, int how);
dc6b9b78 1042 int (*setsockopt)(struct sock *sk, int level,
1da177e4 1043 int optname, char __user *optval,
b7058842 1044 unsigned int optlen);
dc6b9b78
ED
1045 int (*getsockopt)(struct sock *sk, int level,
1046 int optname, char __user *optval,
1047 int __user *option);
4b9d07a4 1048 void (*keepalive)(struct sock *sk, int valbool);
af01d537 1049#ifdef CONFIG_COMPAT
3fdadf7d
DM
1050 int (*compat_setsockopt)(struct sock *sk,
1051 int level,
1052 int optname, char __user *optval,
b7058842 1053 unsigned int optlen);
3fdadf7d
DM
1054 int (*compat_getsockopt)(struct sock *sk,
1055 int level,
1056 int optname, char __user *optval,
1057 int __user *option);
709b46e8
EB
1058 int (*compat_ioctl)(struct sock *sk,
1059 unsigned int cmd, unsigned long arg);
af01d537 1060#endif
1b784140
YX
1061 int (*sendmsg)(struct sock *sk, struct msghdr *msg,
1062 size_t len);
1063 int (*recvmsg)(struct sock *sk, struct msghdr *msg,
dc6b9b78
ED
1064 size_t len, int noblock, int flags,
1065 int *addr_len);
1da177e4
LT
1066 int (*sendpage)(struct sock *sk, struct page *page,
1067 int offset, size_t size, int flags);
dc6b9b78 1068 int (*bind)(struct sock *sk,
1da177e4
LT
1069 struct sockaddr *uaddr, int addr_len);
1070
dc6b9b78 1071 int (*backlog_rcv) (struct sock *sk,
1da177e4
LT
1072 struct sk_buff *skb);
1073
46d3ceab
ED
1074 void (*release_cb)(struct sock *sk);
1075
1da177e4 1076 /* Keeping track of sk's, looking them up, and port selection methods. */
086c653f 1077 int (*hash)(struct sock *sk);
1da177e4 1078 void (*unhash)(struct sock *sk);
719f8358 1079 void (*rehash)(struct sock *sk);
1da177e4
LT
1080 int (*get_port)(struct sock *sk, unsigned short snum);
1081
286ab3d4 1082 /* Keeping track of sockets in use */
65f76517 1083#ifdef CONFIG_PROC_FS
13ff3d6f 1084 unsigned int inuse_idx;
65f76517 1085#endif
ebb53d75 1086
c9bee3b7 1087 bool (*stream_memory_free)(const struct sock *sk);
8934ce2f 1088 bool (*stream_memory_read)(const struct sock *sk);
1da177e4 1089 /* Memory pressure */
5c52ba17 1090 void (*enter_memory_pressure)(struct sock *sk);
06044751 1091 void (*leave_memory_pressure)(struct sock *sk);
8d987e5c 1092 atomic_long_t *memory_allocated; /* Current allocated memory. */
1748376b 1093 struct percpu_counter *sockets_allocated; /* Current number of sockets. */
1da177e4
LT
1094 /*
1095 * Pressure flag: try to collapse.
1096 * Technical note: it is used by multiple contexts non atomically.
3ab224be 1097 * All the __sk_mem_schedule() is of this nature: accounting
1da177e4
LT
1098 * is strict, actions are advisory and have some latency.
1099 */
06044751 1100 unsigned long *memory_pressure;
8d987e5c 1101 long *sysctl_mem;
a3dcaf17 1102
1da177e4
LT
1103 int *sysctl_wmem;
1104 int *sysctl_rmem;
a3dcaf17
ED
1105 u32 sysctl_wmem_offset;
1106 u32 sysctl_rmem_offset;
1107
1da177e4 1108 int max_header;
7ba42910 1109 bool no_autobind;
1da177e4 1110
271b72c7 1111 struct kmem_cache *slab;
1da177e4 1112 unsigned int obj_size;
d50112ed 1113 slab_flags_t slab_flags;
30c2c9f1
DW
1114 size_t useroffset; /* Usercopy region offset */
1115 size_t usersize; /* Usercopy region size */
1da177e4 1116
dd24c001 1117 struct percpu_counter *orphan_count;
8feaf0c0 1118
60236fdd 1119 struct request_sock_ops *rsk_prot;
6d6ee43e 1120 struct timewait_sock_ops *twsk_prot;
2e6599cb 1121
39d8cda7
PE
1122 union {
1123 struct inet_hashinfo *hashinfo;
645ca708 1124 struct udp_table *udp_table;
fc8717ba 1125 struct raw_hashinfo *raw_hash;
f16a7dd5 1126 struct smc_hashinfo *smc_hash;
39d8cda7 1127 } h;
ab1e0a13 1128
1da177e4
LT
1129 struct module *owner;
1130
1131 char name[32];
1132
1133 struct list_head node;
e6848976
ACM
1134#ifdef SOCK_REFCNT_DEBUG
1135 atomic_t socks;
e1aab161 1136#endif
64be0aed 1137 int (*diag_destroy)(struct sock *sk, int err);
3859a271 1138} __randomize_layout;
e1aab161 1139
69336bd2
JP
1140int proto_register(struct proto *prot, int alloc_slab);
1141void proto_unregister(struct proto *prot);
bf2ae2e4 1142int sock_load_diag_module(int family, int protocol);
1da177e4 1143
e6848976
ACM
1144#ifdef SOCK_REFCNT_DEBUG
1145static inline void sk_refcnt_debug_inc(struct sock *sk)
1146{
1147 atomic_inc(&sk->sk_prot->socks);
1148}
1149
1150static inline void sk_refcnt_debug_dec(struct sock *sk)
1151{
1152 atomic_dec(&sk->sk_prot->socks);
1153 printk(KERN_DEBUG "%s socket %p released, %d are still alive\n",
1154 sk->sk_prot->name, sk, atomic_read(&sk->sk_prot->socks));
1155}
1156
dec34fb0 1157static inline void sk_refcnt_debug_release(const struct sock *sk)
e6848976 1158{
41c6d650 1159 if (refcount_read(&sk->sk_refcnt) != 1)
e6848976 1160 printk(KERN_DEBUG "Destruction of the %s socket %p delayed, refcnt=%d\n",
41c6d650 1161 sk->sk_prot->name, sk, refcount_read(&sk->sk_refcnt));
e6848976
ACM
1162}
1163#else /* SOCK_REFCNT_DEBUG */
1164#define sk_refcnt_debug_inc(sk) do { } while (0)
1165#define sk_refcnt_debug_dec(sk) do { } while (0)
1166#define sk_refcnt_debug_release(sk) do { } while (0)
1167#endif /* SOCK_REFCNT_DEBUG */
1168
c9bee3b7
ED
1169static inline bool sk_stream_memory_free(const struct sock *sk)
1170{
1171 if (sk->sk_wmem_queued >= sk->sk_sndbuf)
1172 return false;
1173
1174 return sk->sk_prot->stream_memory_free ?
1175 sk->sk_prot->stream_memory_free(sk) : true;
1176}
1177
64dc6130
ED
1178static inline bool sk_stream_is_writeable(const struct sock *sk)
1179{
c9bee3b7
ED
1180 return sk_stream_wspace(sk) >= sk_stream_min_wspace(sk) &&
1181 sk_stream_memory_free(sk);
64dc6130 1182}
e1aab161 1183
54fd9c2d
DB
1184static inline int sk_under_cgroup_hierarchy(struct sock *sk,
1185 struct cgroup *ancestor)
1186{
1187#ifdef CONFIG_SOCK_CGROUP_DATA
1188 return cgroup_is_descendant(sock_cgroup_ptr(&sk->sk_cgrp_data),
1189 ancestor);
1190#else
1191 return -ENOTSUPP;
1192#endif
1193}
c9bee3b7 1194
180d8cd9
GC
1195static inline bool sk_has_memory_pressure(const struct sock *sk)
1196{
1197 return sk->sk_prot->memory_pressure != NULL;
1198}
1199
1200static inline bool sk_under_memory_pressure(const struct sock *sk)
1201{
1202 if (!sk->sk_prot->memory_pressure)
1203 return false;
e1aab161 1204
baac50bb
JW
1205 if (mem_cgroup_sockets_enabled && sk->sk_memcg &&
1206 mem_cgroup_under_socket_pressure(sk->sk_memcg))
e805605c 1207 return true;
e1aab161 1208
35b87f6c 1209 return !!*sk->sk_prot->memory_pressure;
180d8cd9
GC
1210}
1211
180d8cd9
GC
1212static inline long
1213sk_memory_allocated(const struct sock *sk)
1214{
e805605c 1215 return atomic_long_read(sk->sk_prot->memory_allocated);
180d8cd9
GC
1216}
1217
1218static inline long
e805605c 1219sk_memory_allocated_add(struct sock *sk, int amt)
180d8cd9 1220{
e805605c 1221 return atomic_long_add_return(amt, sk->sk_prot->memory_allocated);
180d8cd9
GC
1222}
1223
1224static inline void
0e90b31f 1225sk_memory_allocated_sub(struct sock *sk, int amt)
180d8cd9 1226{
e805605c 1227 atomic_long_sub(amt, sk->sk_prot->memory_allocated);
180d8cd9
GC
1228}
1229
1230static inline void sk_sockets_allocated_dec(struct sock *sk)
1231{
af95d7df 1232 percpu_counter_dec(sk->sk_prot->sockets_allocated);
180d8cd9
GC
1233}
1234
1235static inline void sk_sockets_allocated_inc(struct sock *sk)
1236{
af95d7df 1237 percpu_counter_inc(sk->sk_prot->sockets_allocated);
180d8cd9
GC
1238}
1239
1240static inline int
1241sk_sockets_allocated_read_positive(struct sock *sk)
1242{
af95d7df 1243 return percpu_counter_read_positive(sk->sk_prot->sockets_allocated);
180d8cd9
GC
1244}
1245
1246static inline int
1247proto_sockets_allocated_sum_positive(struct proto *prot)
1248{
1249 return percpu_counter_sum_positive(prot->sockets_allocated);
1250}
1251
1252static inline long
1253proto_memory_allocated(struct proto *prot)
1254{
1255 return atomic_long_read(prot->memory_allocated);
1256}
1257
1258static inline bool
1259proto_memory_pressure(struct proto *prot)
1260{
1261 if (!prot->memory_pressure)
1262 return false;
1263 return !!*prot->memory_pressure;
1264}
1265
65f76517
ED
1266
1267#ifdef CONFIG_PROC_FS
1da177e4 1268/* Called with local bh disabled */
69336bd2
JP
1269void sock_prot_inuse_add(struct net *net, struct proto *prot, int inc);
1270int sock_prot_inuse_get(struct net *net, struct proto *proto);
648845ab 1271int sock_inuse_get(struct net *net);
65f76517 1272#else
dc6b9b78 1273static inline void sock_prot_inuse_add(struct net *net, struct proto *prot,
c29a0bc4 1274 int inc)
65f76517
ED
1275{
1276}
65f76517
ED
1277#endif
1278
1da177e4 1279
614c6cb4
ACM
1280/* With per-bucket locks this operation is not-atomic, so that
1281 * this version is not worse.
1282 */
086c653f 1283static inline int __sk_prot_rehash(struct sock *sk)
614c6cb4
ACM
1284{
1285 sk->sk_prot->unhash(sk);
086c653f 1286 return sk->sk_prot->hash(sk);
614c6cb4
ACM
1287}
1288
1da177e4
LT
1289/* About 10 seconds */
1290#define SOCK_DESTROY_TIME (10*HZ)
1291
1292/* Sockets 0-1023 can't be bound to unless you are superuser */
1293#define PROT_SOCK 1024
1294
1295#define SHUTDOWN_MASK 3
1296#define RCV_SHUTDOWN 1
1297#define SEND_SHUTDOWN 2
1298
1299#define SOCK_SNDBUF_LOCK 1
1300#define SOCK_RCVBUF_LOCK 2
1301#define SOCK_BINDADDR_LOCK 4
1302#define SOCK_BINDPORT_LOCK 8
1303
1da177e4
LT
1304struct socket_alloc {
1305 struct socket socket;
1306 struct inode vfs_inode;
1307};
1308
1309static inline struct socket *SOCKET_I(struct inode *inode)
1310{
1311 return &container_of(inode, struct socket_alloc, vfs_inode)->socket;
1312}
1313
1314static inline struct inode *SOCK_INODE(struct socket *socket)
1315{
1316 return &container_of(socket, struct socket_alloc, socket)->vfs_inode;
1317}
1318
3ab224be
HA
1319/*
1320 * Functions for memory accounting
1321 */
f8c3bf00 1322int __sk_mem_raise_allocated(struct sock *sk, int size, int amt, int kind);
69336bd2 1323int __sk_mem_schedule(struct sock *sk, int size, int kind);
f8c3bf00 1324void __sk_mem_reduce_allocated(struct sock *sk, int amount);
1a24e04e 1325void __sk_mem_reclaim(struct sock *sk, int amount);
1da177e4 1326
bd68a2a8
ED
1327/* We used to have PAGE_SIZE here, but systems with 64KB pages
1328 * do not necessarily have 16x time more memory than 4KB ones.
1329 */
1330#define SK_MEM_QUANTUM 4096
3ab224be
HA
1331#define SK_MEM_QUANTUM_SHIFT ilog2(SK_MEM_QUANTUM)
1332#define SK_MEM_SEND 0
1333#define SK_MEM_RECV 1
1da177e4 1334
bd68a2a8
ED
1335/* sysctl_mem values are in pages, we convert them in SK_MEM_QUANTUM units */
1336static inline long sk_prot_mem_limits(const struct sock *sk, int index)
1337{
1338 long val = sk->sk_prot->sysctl_mem[index];
1339
1340#if PAGE_SIZE > SK_MEM_QUANTUM
1341 val <<= PAGE_SHIFT - SK_MEM_QUANTUM_SHIFT;
1342#elif PAGE_SIZE < SK_MEM_QUANTUM
1343 val >>= SK_MEM_QUANTUM_SHIFT - PAGE_SHIFT;
1344#endif
1345 return val;
1346}
1347
3ab224be 1348static inline int sk_mem_pages(int amt)
1da177e4 1349{
3ab224be 1350 return (amt + SK_MEM_QUANTUM - 1) >> SK_MEM_QUANTUM_SHIFT;
1da177e4
LT
1351}
1352
dc6b9b78 1353static inline bool sk_has_account(struct sock *sk)
1da177e4 1354{
3ab224be
HA
1355 /* return true if protocol supports memory accounting */
1356 return !!sk->sk_prot->memory_allocated;
1da177e4
LT
1357}
1358
dc6b9b78 1359static inline bool sk_wmem_schedule(struct sock *sk, int size)
1da177e4 1360{
3ab224be 1361 if (!sk_has_account(sk))
dc6b9b78 1362 return true;
3ab224be
HA
1363 return size <= sk->sk_forward_alloc ||
1364 __sk_mem_schedule(sk, size, SK_MEM_SEND);
1da177e4
LT
1365}
1366
c76562b6 1367static inline bool
35c448a8 1368sk_rmem_schedule(struct sock *sk, struct sk_buff *skb, int size)
d80d99d6 1369{
3ab224be 1370 if (!sk_has_account(sk))
dc6b9b78 1371 return true;
c76562b6
MG
1372 return size<= sk->sk_forward_alloc ||
1373 __sk_mem_schedule(sk, size, SK_MEM_RECV) ||
1374 skb_pfmemalloc(skb);
3ab224be
HA
1375}
1376
1377static inline void sk_mem_reclaim(struct sock *sk)
1378{
1379 if (!sk_has_account(sk))
1380 return;
1381 if (sk->sk_forward_alloc >= SK_MEM_QUANTUM)
1a24e04e 1382 __sk_mem_reclaim(sk, sk->sk_forward_alloc);
3ab224be
HA
1383}
1384
9993e7d3
DM
1385static inline void sk_mem_reclaim_partial(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 - 1);
9993e7d3
DM
1391}
1392
3ab224be
HA
1393static inline void sk_mem_charge(struct sock *sk, int size)
1394{
1395 if (!sk_has_account(sk))
1396 return;
1397 sk->sk_forward_alloc -= size;
1398}
1399
1400static inline void sk_mem_uncharge(struct sock *sk, int size)
1401{
1402 if (!sk_has_account(sk))
1403 return;
1404 sk->sk_forward_alloc += size;
20c64d5c
ED
1405
1406 /* Avoid a possible overflow.
1407 * TCP send queues can make this happen, if sk_mem_reclaim()
1408 * is not called and more than 2 GBytes are released at once.
1409 *
1410 * If we reach 2 MBytes, reclaim 1 MBytes right now, there is
1411 * no need to hold that much forward allocation anyway.
1412 */
1413 if (unlikely(sk->sk_forward_alloc >= 1 << 21))
1414 __sk_mem_reclaim(sk, 1 << 20);
3ab224be
HA
1415}
1416
1417static inline void sk_wmem_free_skb(struct sock *sk, struct sk_buff *skb)
1418{
3ab224be
HA
1419 sock_set_flag(sk, SOCK_QUEUE_SHRUNK);
1420 sk->sk_wmem_queued -= skb->truesize;
1421 sk_mem_uncharge(sk, skb->truesize);
1422 __kfree_skb(skb);
d80d99d6
HX
1423}
1424
c3f9b018
ED
1425static inline void sock_release_ownership(struct sock *sk)
1426{
61881cfb
HFS
1427 if (sk->sk_lock.owned) {
1428 sk->sk_lock.owned = 0;
1429
1430 /* The sk_lock has mutex_unlock() semantics: */
1431 mutex_release(&sk->sk_lock.dep_map, 1, _RET_IP_);
1432 }
c3f9b018
ED
1433}
1434
ed07536e
PZ
1435/*
1436 * Macro so as to not evaluate some arguments when
1437 * lockdep is not enabled.
1438 *
1439 * Mark both the sk_lock and the sk_lock.slock as a
1440 * per-address-family lock class.
1441 */
dc6b9b78 1442#define sock_lock_init_class_and_name(sk, sname, skey, name, key) \
ed07536e 1443do { \
e8f6fbf6 1444 sk->sk_lock.owned = 0; \
ed07536e
PZ
1445 init_waitqueue_head(&sk->sk_lock.wq); \
1446 spin_lock_init(&(sk)->sk_lock.slock); \
1447 debug_check_no_locks_freed((void *)&(sk)->sk_lock, \
1448 sizeof((sk)->sk_lock)); \
1449 lockdep_set_class_and_name(&(sk)->sk_lock.slock, \
dc6b9b78 1450 (skey), (sname)); \
ed07536e
PZ
1451 lockdep_init_map(&(sk)->sk_lock.dep_map, (name), (key), 0); \
1452} while (0)
1453
b33b0a1b 1454#ifdef CONFIG_LOCKDEP
05b93801 1455static inline bool lockdep_sock_is_held(const struct sock *sk)
1e1d04e6 1456{
1e1d04e6
HFS
1457 return lockdep_is_held(&sk->sk_lock) ||
1458 lockdep_is_held(&sk->sk_lock.slock);
1459}
b33b0a1b 1460#endif
1e1d04e6 1461
69336bd2 1462void lock_sock_nested(struct sock *sk, int subclass);
fcc70d5f
PZ
1463
1464static inline void lock_sock(struct sock *sk)
1465{
1466 lock_sock_nested(sk, 0);
1467}
1468
69336bd2 1469void release_sock(struct sock *sk);
1da177e4
LT
1470
1471/* BH context may only use the following locking interface. */
1472#define bh_lock_sock(__sk) spin_lock(&((__sk)->sk_lock.slock))
c6366184
IM
1473#define bh_lock_sock_nested(__sk) \
1474 spin_lock_nested(&((__sk)->sk_lock.slock), \
1475 SINGLE_DEPTH_NESTING)
1da177e4
LT
1476#define bh_unlock_sock(__sk) spin_unlock(&((__sk)->sk_lock.slock))
1477
69336bd2 1478bool lock_sock_fast(struct sock *sk);
8a74ad60
ED
1479/**
1480 * unlock_sock_fast - complement of lock_sock_fast
1481 * @sk: socket
1482 * @slow: slow mode
1483 *
1484 * fast unlock socket for user context.
1485 * If slow mode is on, we call regular release_sock()
1486 */
1487static inline void unlock_sock_fast(struct sock *sk, bool slow)
4b0b72f7 1488{
8a74ad60
ED
1489 if (slow)
1490 release_sock(sk);
1491 else
1492 spin_unlock_bh(&sk->sk_lock.slock);
4b0b72f7
ED
1493}
1494
fafc4e1e
HFS
1495/* Used by processes to "lock" a socket state, so that
1496 * interrupts and bottom half handlers won't change it
1497 * from under us. It essentially blocks any incoming
1498 * packets, so that we won't get any new data or any
1499 * packets that change the state of the socket.
1500 *
1501 * While locked, BH processing will add new packets to
1502 * the backlog queue. This queue is processed by the
1503 * owner of the socket lock right before it is released.
1504 *
1505 * Since ~2.3.5 it is also exclusive sleep lock serializing
1506 * accesses from user process context.
1507 */
1508
46cc6e49 1509static inline void sock_owned_by_me(const struct sock *sk)
fafc4e1e
HFS
1510{
1511#ifdef CONFIG_LOCKDEP
5e91f6ce 1512 WARN_ON_ONCE(!lockdep_sock_is_held(sk) && debug_locks);
fafc4e1e 1513#endif
46cc6e49
ED
1514}
1515
1516static inline bool sock_owned_by_user(const struct sock *sk)
1517{
1518 sock_owned_by_me(sk);
fafc4e1e
HFS
1519 return sk->sk_lock.owned;
1520}
1521
602f7a27
TH
1522static inline bool sock_owned_by_user_nocheck(const struct sock *sk)
1523{
1524 return sk->sk_lock.owned;
1525}
1526
fafc4e1e
HFS
1527/* no reclassification while locks are held */
1528static inline bool sock_allow_reclassification(const struct sock *csk)
1529{
1530 struct sock *sk = (struct sock *)csk;
1531
1532 return !sk->sk_lock.owned && !spin_is_locked(&sk->sk_lock.slock);
1533}
4b0b72f7 1534
69336bd2 1535struct sock *sk_alloc(struct net *net, int family, gfp_t priority,
11aa9c28 1536 struct proto *prot, int kern);
69336bd2 1537void sk_free(struct sock *sk);
eb4cb008 1538void sk_destruct(struct sock *sk);
69336bd2 1539struct sock *sk_clone_lock(const struct sock *sk, const gfp_t priority);
94352d45 1540void sk_free_unlock_clone(struct sock *sk);
69336bd2
JP
1541
1542struct sk_buff *sock_wmalloc(struct sock *sk, unsigned long size, int force,
1543 gfp_t priority);
1d2077ac 1544void __sock_wfree(struct sk_buff *skb);
69336bd2 1545void sock_wfree(struct sk_buff *skb);
98ba0bd5
WB
1546struct sk_buff *sock_omalloc(struct sock *sk, unsigned long size,
1547 gfp_t priority);
69336bd2
JP
1548void skb_orphan_partial(struct sk_buff *skb);
1549void sock_rfree(struct sk_buff *skb);
62bccb8c 1550void sock_efree(struct sk_buff *skb);
82eabd9e 1551#ifdef CONFIG_INET
69336bd2 1552void sock_edemux(struct sk_buff *skb);
82eabd9e 1553#else
158f323b 1554#define sock_edemux sock_efree
82eabd9e 1555#endif
69336bd2
JP
1556
1557int sock_setsockopt(struct socket *sock, int level, int op,
1558 char __user *optval, unsigned int optlen);
1559
1560int sock_getsockopt(struct socket *sock, int level, int op,
1561 char __user *optval, int __user *optlen);
1562struct sk_buff *sock_alloc_send_skb(struct sock *sk, unsigned long size,
1563 int noblock, int *errcode);
1564struct sk_buff *sock_alloc_send_pskb(struct sock *sk, unsigned long header_len,
1565 unsigned long data_len, int noblock,
1566 int *errcode, int max_page_order);
1567void *sock_kmalloc(struct sock *sk, int size, gfp_t priority);
1568void sock_kfree_s(struct sock *sk, void *mem, int size);
79e88659 1569void sock_kzfree_s(struct sock *sk, void *mem, int size);
69336bd2 1570void sk_send_sigurg(struct sock *sk);
1da177e4 1571
f28ea365
EJ
1572struct sockcm_cookie {
1573 u32 mark;
3dd17e63 1574 u16 tsflags;
f28ea365
EJ
1575};
1576
39771b12
WB
1577int __sock_cmsg_send(struct sock *sk, struct msghdr *msg, struct cmsghdr *cmsg,
1578 struct sockcm_cookie *sockc);
f28ea365
EJ
1579int sock_cmsg_send(struct sock *sk, struct msghdr *msg,
1580 struct sockcm_cookie *sockc);
1581
1da177e4
LT
1582/*
1583 * Functions to fill in entries in struct proto_ops when a protocol
1584 * does not implement a particular function.
1585 */
69336bd2
JP
1586int sock_no_bind(struct socket *, struct sockaddr *, int);
1587int sock_no_connect(struct socket *, struct sockaddr *, int, int);
1588int sock_no_socketpair(struct socket *, struct socket *);
cdfbabfb 1589int sock_no_accept(struct socket *, struct socket *, int, bool);
9b2c45d4 1590int sock_no_getname(struct socket *, struct sockaddr *, int);
ade994f4 1591__poll_t sock_no_poll(struct file *, struct socket *,
69336bd2
JP
1592 struct poll_table_struct *);
1593int sock_no_ioctl(struct socket *, unsigned int, unsigned long);
1594int sock_no_listen(struct socket *, int);
1595int sock_no_shutdown(struct socket *, int);
1596int sock_no_getsockopt(struct socket *, int , int, char __user *, int __user *);
1597int sock_no_setsockopt(struct socket *, int, int, char __user *, unsigned int);
1b784140 1598int sock_no_sendmsg(struct socket *, struct msghdr *, size_t);
306b13eb 1599int sock_no_sendmsg_locked(struct sock *sk, struct msghdr *msg, size_t len);
1b784140 1600int sock_no_recvmsg(struct socket *, struct msghdr *, size_t, int);
69336bd2
JP
1601int sock_no_mmap(struct file *file, struct socket *sock,
1602 struct vm_area_struct *vma);
1603ssize_t sock_no_sendpage(struct socket *sock, struct page *page, int offset,
1604 size_t size, int flags);
306b13eb
TH
1605ssize_t sock_no_sendpage_locked(struct sock *sk, struct page *page,
1606 int offset, size_t size, int flags);
1da177e4
LT
1607
1608/*
1609 * Functions to fill in entries in struct proto_ops when a protocol
1610 * uses the inet style.
1611 */
69336bd2 1612int sock_common_getsockopt(struct socket *sock, int level, int optname,
1da177e4 1613 char __user *optval, int __user *optlen);
1b784140
YX
1614int sock_common_recvmsg(struct socket *sock, struct msghdr *msg, size_t size,
1615 int flags);
69336bd2 1616int sock_common_setsockopt(struct socket *sock, int level, int optname,
b7058842 1617 char __user *optval, unsigned int optlen);
69336bd2 1618int compat_sock_common_getsockopt(struct socket *sock, int level,
3fdadf7d 1619 int optname, char __user *optval, int __user *optlen);
69336bd2 1620int compat_sock_common_setsockopt(struct socket *sock, int level,
b7058842 1621 int optname, char __user *optval, unsigned int optlen);
1da177e4 1622
69336bd2 1623void sk_common_release(struct sock *sk);
1da177e4
LT
1624
1625/*
1626 * Default socket callbacks and setup code
1627 */
dc6b9b78 1628
1da177e4 1629/* Initialise core socket variables */
69336bd2 1630void sock_init_data(struct socket *sock, struct sock *sk);
1da177e4 1631
1da177e4
LT
1632/*
1633 * Socket reference counting postulates.
1634 *
1635 * * Each user of socket SHOULD hold a reference count.
1636 * * Each access point to socket (an hash table bucket, reference from a list,
1637 * running timer, skb in flight MUST hold a reference count.
1638 * * When reference count hits 0, it means it will never increase back.
1639 * * When reference count hits 0, it means that no references from
1640 * outside exist to this socket and current process on current CPU
1641 * is last user and may/should destroy this socket.
1642 * * sk_free is called from any context: process, BH, IRQ. When
1643 * it is called, socket has no references from outside -> sk_free
1644 * may release descendant resources allocated by the socket, but
1645 * to the time when it is called, socket is NOT referenced by any
1646 * hash tables, lists etc.
1647 * * Packets, delivered from outside (from network or from another process)
1648 * and enqueued on receive/error queues SHOULD NOT grab reference count,
1649 * when they sit in queue. Otherwise, packets will leak to hole, when
1650 * socket is looked up by one cpu and unhasing is made by another CPU.
1651 * It is true for udp/raw, netlink (leak to receive and error queues), tcp
1652 * (leak to backlog). Packet socket does all the processing inside
1653 * BR_NETPROTO_LOCK, so that it has not this race condition. UNIX sockets
1654 * use separate SMP lock, so that they are prone too.
1655 */
1656
1657/* Ungrab socket and destroy it, if it was the last reference. */
1658static inline void sock_put(struct sock *sk)
1659{
41c6d650 1660 if (refcount_dec_and_test(&sk->sk_refcnt))
1da177e4
LT
1661 sk_free(sk);
1662}
05dbc7b5 1663/* Generic version of sock_put(), dealing with all sockets
41b822c5 1664 * (TCP_TIMEWAIT, TCP_NEW_SYN_RECV, ESTABLISHED...)
05dbc7b5
ED
1665 */
1666void sock_gen_put(struct sock *sk);
1da177e4 1667
4f0c40d9 1668int __sk_receive_skb(struct sock *sk, struct sk_buff *skb, const int nested,
c3f24cfb 1669 unsigned int trim_cap, bool refcounted);
4f0c40d9
WB
1670static inline int sk_receive_skb(struct sock *sk, struct sk_buff *skb,
1671 const int nested)
1672{
c3f24cfb 1673 return __sk_receive_skb(sk, skb, nested, 1, true);
4f0c40d9 1674}
25995ff5 1675
e022f0b4
KK
1676static inline void sk_tx_queue_set(struct sock *sk, int tx_queue)
1677{
1678 sk->sk_tx_queue_mapping = tx_queue;
1679}
1680
1681static inline void sk_tx_queue_clear(struct sock *sk)
1682{
1683 sk->sk_tx_queue_mapping = -1;
1684}
1685
1686static inline int sk_tx_queue_get(const struct sock *sk)
1687{
b0f77d0e 1688 return sk ? sk->sk_tx_queue_mapping : -1;
e022f0b4
KK
1689}
1690
972692e0
DM
1691static inline void sk_set_socket(struct sock *sk, struct socket *sock)
1692{
e022f0b4 1693 sk_tx_queue_clear(sk);
972692e0
DM
1694 sk->sk_socket = sock;
1695}
1696
aa395145
ED
1697static inline wait_queue_head_t *sk_sleep(struct sock *sk)
1698{
eaefd110
ED
1699 BUILD_BUG_ON(offsetof(struct socket_wq, wait) != 0);
1700 return &rcu_dereference_raw(sk->sk_wq)->wait;
aa395145 1701}
1da177e4
LT
1702/* Detach socket from process context.
1703 * Announce socket dead, detach it from wait queue and inode.
1704 * Note that parent inode held reference count on this struct sock,
1705 * we do not release it in this function, because protocol
1706 * probably wants some additional cleanups or even continuing
1707 * to work with this socket (TCP).
1708 */
1709static inline void sock_orphan(struct sock *sk)
1710{
1711 write_lock_bh(&sk->sk_callback_lock);
1712 sock_set_flag(sk, SOCK_DEAD);
972692e0 1713 sk_set_socket(sk, NULL);
43815482 1714 sk->sk_wq = NULL;
1da177e4
LT
1715 write_unlock_bh(&sk->sk_callback_lock);
1716}
1717
1718static inline void sock_graft(struct sock *sk, struct socket *parent)
1719{
0ffdaf5b 1720 WARN_ON(parent->sk);
1da177e4 1721 write_lock_bh(&sk->sk_callback_lock);
eaefd110 1722 sk->sk_wq = parent->wq;
1da177e4 1723 parent->sk = sk;
972692e0 1724 sk_set_socket(sk, parent);
86741ec2 1725 sk->sk_uid = SOCK_INODE(parent)->i_uid;
4237c75c 1726 security_sock_graft(sk, parent);
1da177e4
LT
1727 write_unlock_bh(&sk->sk_callback_lock);
1728}
1729
69336bd2
JP
1730kuid_t sock_i_uid(struct sock *sk);
1731unsigned long sock_i_ino(struct sock *sk);
1da177e4 1732
86741ec2
LC
1733static inline kuid_t sock_net_uid(const struct net *net, const struct sock *sk)
1734{
1735 return sk ? sk->sk_uid : make_kuid(net->user_ns, 0);
1736}
1737
58d607d3 1738static inline u32 net_tx_rndhash(void)
877d1f62 1739{
58d607d3
ED
1740 u32 v = prandom_u32();
1741
1742 return v ?: 1;
1743}
877d1f62 1744
58d607d3
ED
1745static inline void sk_set_txhash(struct sock *sk)
1746{
1747 sk->sk_txhash = net_tx_rndhash();
877d1f62
TH
1748}
1749
265f94ff
TH
1750static inline void sk_rethink_txhash(struct sock *sk)
1751{
1752 if (sk->sk_txhash)
1753 sk_set_txhash(sk);
1754}
1755
1da177e4
LT
1756static inline struct dst_entry *
1757__sk_dst_get(struct sock *sk)
1758{
1e1d04e6
HFS
1759 return rcu_dereference_check(sk->sk_dst_cache,
1760 lockdep_sock_is_held(sk));
1da177e4
LT
1761}
1762
1763static inline struct dst_entry *
1764sk_dst_get(struct sock *sk)
1765{
1766 struct dst_entry *dst;
1767
b6c6712a
ED
1768 rcu_read_lock();
1769 dst = rcu_dereference(sk->sk_dst_cache);
f8864972
ED
1770 if (dst && !atomic_inc_not_zero(&dst->__refcnt))
1771 dst = NULL;
b6c6712a 1772 rcu_read_unlock();
1da177e4
LT
1773 return dst;
1774}
1775
b6c6712a
ED
1776static inline void dst_negative_advice(struct sock *sk)
1777{
1778 struct dst_entry *ndst, *dst = __sk_dst_get(sk);
1779
265f94ff
TH
1780 sk_rethink_txhash(sk);
1781
b6c6712a
ED
1782 if (dst && dst->ops->negative_advice) {
1783 ndst = dst->ops->negative_advice(dst);
1784
1785 if (ndst != dst) {
1786 rcu_assign_pointer(sk->sk_dst_cache, ndst);
0a6957e7 1787 sk_tx_queue_clear(sk);
9b8805a3 1788 sk->sk_dst_pending_confirm = 0;
b6c6712a
ED
1789 }
1790 }
1791}
1792
1da177e4
LT
1793static inline void
1794__sk_dst_set(struct sock *sk, struct dst_entry *dst)
1795{
1796 struct dst_entry *old_dst;
1797
e022f0b4 1798 sk_tx_queue_clear(sk);
9b8805a3 1799 sk->sk_dst_pending_confirm = 0;
95964c6d
ED
1800 old_dst = rcu_dereference_protected(sk->sk_dst_cache,
1801 lockdep_sock_is_held(sk));
b6c6712a 1802 rcu_assign_pointer(sk->sk_dst_cache, dst);
1da177e4
LT
1803 dst_release(old_dst);
1804}
1805
1806static inline void
1807sk_dst_set(struct sock *sk, struct dst_entry *dst)
1808{
7f502361
ED
1809 struct dst_entry *old_dst;
1810
1811 sk_tx_queue_clear(sk);
9b8805a3 1812 sk->sk_dst_pending_confirm = 0;
5925a055 1813 old_dst = xchg((__force struct dst_entry **)&sk->sk_dst_cache, dst);
7f502361 1814 dst_release(old_dst);
1da177e4
LT
1815}
1816
1817static inline void
1818__sk_dst_reset(struct sock *sk)
1819{
b6c6712a 1820 __sk_dst_set(sk, NULL);
1da177e4
LT
1821}
1822
1823static inline void
1824sk_dst_reset(struct sock *sk)
1825{
7f502361 1826 sk_dst_set(sk, NULL);
1da177e4
LT
1827}
1828
69336bd2 1829struct dst_entry *__sk_dst_check(struct sock *sk, u32 cookie);
1da177e4 1830
69336bd2 1831struct dst_entry *sk_dst_check(struct sock *sk, u32 cookie);
1da177e4 1832
9b8805a3
JA
1833static inline void sk_dst_confirm(struct sock *sk)
1834{
1835 if (!sk->sk_dst_pending_confirm)
1836 sk->sk_dst_pending_confirm = 1;
1837}
1838
4ff06203
JA
1839static inline void sock_confirm_neigh(struct sk_buff *skb, struct neighbour *n)
1840{
1841 if (skb_get_dst_pending_confirm(skb)) {
1842 struct sock *sk = skb->sk;
1843 unsigned long now = jiffies;
1844
1845 /* avoid dirtying neighbour */
1846 if (n->confirmed != now)
1847 n->confirmed = now;
1848 if (sk && sk->sk_dst_pending_confirm)
1849 sk->sk_dst_pending_confirm = 0;
1850 }
1851}
1852
f60e5990 1853bool sk_mc_loop(struct sock *sk);
1854
dc6b9b78 1855static inline bool sk_can_gso(const struct sock *sk)
bcd76111
HX
1856{
1857 return net_gso_ok(sk->sk_route_caps, sk->sk_gso_type);
1858}
1859
69336bd2 1860void sk_setup_caps(struct sock *sk, struct dst_entry *dst);
6cbb0df7 1861
c8f44aff 1862static inline void sk_nocaps_add(struct sock *sk, netdev_features_t flags)
a465419b
ED
1863{
1864 sk->sk_route_nocaps |= flags;
1865 sk->sk_route_caps &= ~flags;
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
2c3682f0 2146int sk_alloc_sg(struct sock *sk, int len, struct scatterlist *sg,
8c05dbf0 2147 int sg_start, int *sg_curr, unsigned int *sg_size,
2c3682f0
JF
2148 int first_coalesce);
2149
1da177e4
LT
2150/*
2151 * Default write policy as shown to user space via poll/select/SIGIO
2152 */
dc6b9b78 2153static inline bool sock_writeable(const struct sock *sk)
1da177e4 2154{
14afee4b 2155 return refcount_read(&sk->sk_wmem_alloc) < (sk->sk_sndbuf >> 1);
1da177e4
LT
2156}
2157
dd0fc66f 2158static inline gfp_t gfp_any(void)
1da177e4 2159{
99709372 2160 return in_softirq() ? GFP_ATOMIC : GFP_KERNEL;
1da177e4
LT
2161}
2162
dc6b9b78 2163static inline long sock_rcvtimeo(const struct sock *sk, bool noblock)
1da177e4
LT
2164{
2165 return noblock ? 0 : sk->sk_rcvtimeo;
2166}
2167
dc6b9b78 2168static inline long sock_sndtimeo(const struct sock *sk, bool noblock)
1da177e4
LT
2169{
2170 return noblock ? 0 : sk->sk_sndtimeo;
2171}
2172
2173static inline int sock_rcvlowat(const struct sock *sk, int waitall, int len)
2174{
2175 return (waitall ? len : min_t(int, sk->sk_rcvlowat, len)) ? : 1;
2176}
2177
2178/* Alas, with timeout socket operations are not restartable.
2179 * Compare this to poll().
2180 */
2181static inline int sock_intr_errno(long timeo)
2182{
2183 return timeo == MAX_SCHEDULE_TIMEOUT ? -ERESTARTSYS : -EINTR;
2184}
2185
744d5a3e
EB
2186struct sock_skb_cb {
2187 u32 dropcount;
2188};
2189
2190/* Store sock_skb_cb at the end of skb->cb[] so protocol families
2191 * using skb->cb[] would keep using it directly and utilize its
2192 * alignement guarantee.
2193 */
2194#define SOCK_SKB_CB_OFFSET ((FIELD_SIZEOF(struct sk_buff, cb) - \
2195 sizeof(struct sock_skb_cb)))
2196
2197#define SOCK_SKB_CB(__skb) ((struct sock_skb_cb *)((__skb)->cb + \
2198 SOCK_SKB_CB_OFFSET))
2199
b4772ef8 2200#define sock_skb_cb_check_size(size) \
744d5a3e 2201 BUILD_BUG_ON((size) > SOCK_SKB_CB_OFFSET)
b4772ef8 2202
3bc3b96f
EB
2203static inline void
2204sock_skb_set_dropcount(const struct sock *sk, struct sk_buff *skb)
2205{
3665f381
ED
2206 SOCK_SKB_CB(skb)->dropcount = sock_flag(sk, SOCK_RXQ_OVFL) ?
2207 atomic_read(&sk->sk_drops) : 0;
3bc3b96f
EB
2208}
2209
532182cd
ED
2210static inline void sk_drops_add(struct sock *sk, const struct sk_buff *skb)
2211{
2212 int segs = max_t(u16, 1, skb_shinfo(skb)->gso_segs);
2213
2214 atomic_add(segs, &sk->sk_drops);
2215}
2216
69336bd2
JP
2217void __sock_recv_timestamp(struct msghdr *msg, struct sock *sk,
2218 struct sk_buff *skb);
2219void __sock_recv_wifi_status(struct msghdr *msg, struct sock *sk,
2220 struct sk_buff *skb);
92f37fd2 2221
dc6b9b78 2222static inline void
1da177e4
LT
2223sock_recv_timestamp(struct msghdr *msg, struct sock *sk, struct sk_buff *skb)
2224{
b7aa0bf7 2225 ktime_t kt = skb->tstamp;
20d49473 2226 struct skb_shared_hwtstamps *hwtstamps = skb_hwtstamps(skb);
a61bbcf2 2227
20d49473
PO
2228 /*
2229 * generate control messages if
b9f40e21 2230 * - receive time stamping in software requested
20d49473 2231 * - software time stamp available and wanted
20d49473 2232 * - hardware time stamps available and wanted
20d49473
PO
2233 */
2234 if (sock_flag(sk, SOCK_RCVTSTAMP) ||
b9f40e21 2235 (sk->sk_tsflags & SOF_TIMESTAMPING_RX_SOFTWARE) ||
2456e855
TG
2236 (kt && sk->sk_tsflags & SOF_TIMESTAMPING_SOFTWARE) ||
2237 (hwtstamps->hwtstamp &&
b9f40e21 2238 (sk->sk_tsflags & SOF_TIMESTAMPING_RAW_HARDWARE)))
92f37fd2
ED
2239 __sock_recv_timestamp(msg, sk, skb);
2240 else
b7aa0bf7 2241 sk->sk_stamp = kt;
6e3e939f
JB
2242
2243 if (sock_flag(sk, SOCK_WIFI_STATUS) && skb->wifi_acked_valid)
2244 __sock_recv_wifi_status(msg, sk, skb);
1da177e4
LT
2245}
2246
69336bd2
JP
2247void __sock_recv_ts_and_drops(struct msghdr *msg, struct sock *sk,
2248 struct sk_buff *skb);
767dd033 2249
6c7c98ba 2250#define SK_DEFAULT_STAMP (-1L * NSEC_PER_SEC)
767dd033
ED
2251static inline void sock_recv_ts_and_drops(struct msghdr *msg, struct sock *sk,
2252 struct sk_buff *skb)
2253{
2254#define FLAGS_TS_OR_DROPS ((1UL << SOCK_RXQ_OVFL) | \
b9f40e21
WB
2255 (1UL << SOCK_RCVTSTAMP))
2256#define TSFLAGS_ANY (SOF_TIMESTAMPING_SOFTWARE | \
2257 SOF_TIMESTAMPING_RAW_HARDWARE)
767dd033 2258
b9f40e21 2259 if (sk->sk_flags & FLAGS_TS_OR_DROPS || sk->sk_tsflags & TSFLAGS_ANY)
767dd033 2260 __sock_recv_ts_and_drops(msg, sk, skb);
d3fbff30 2261 else if (unlikely(sock_flag(sk, SOCK_TIMESTAMP)))
767dd033 2262 sk->sk_stamp = skb->tstamp;
6c7c98ba
PA
2263 else if (unlikely(sk->sk_stamp == SK_DEFAULT_STAMP))
2264 sk->sk_stamp = 0;
767dd033 2265}
3b885787 2266
c14ac945 2267void __sock_tx_timestamp(__u16 tsflags, __u8 *tx_flags);
67cc0d40 2268
20d49473
PO
2269/**
2270 * sock_tx_timestamp - checks whether the outgoing packet is to be time stamped
20d49473 2271 * @sk: socket sending this packet
c14ac945 2272 * @tsflags: timestamping flags to use
140c55d4
ED
2273 * @tx_flags: completed with instructions for time stamping
2274 *
d651983d 2275 * Note: callers should take care of initial ``*tx_flags`` value (usually 0)
20d49473 2276 */
c14ac945
SHY
2277static inline void sock_tx_timestamp(const struct sock *sk, __u16 tsflags,
2278 __u8 *tx_flags)
67cc0d40 2279{
c14ac945
SHY
2280 if (unlikely(tsflags))
2281 __sock_tx_timestamp(tsflags, tx_flags);
67cc0d40
WB
2282 if (unlikely(sock_flag(sk, SOCK_WIFI_STATUS)))
2283 *tx_flags |= SKBTX_WIFI_STATUS;
2284}
20d49473 2285
1da177e4
LT
2286/**
2287 * sk_eat_skb - Release a skb if it is no longer needed
4dc3b16b
PP
2288 * @sk: socket to eat this skb from
2289 * @skb: socket buffer to eat
1da177e4
LT
2290 *
2291 * This routine must be called with interrupts disabled or with the socket
2292 * locked so that the sk_buff queue operation is ok.
2293*/
7bced397 2294static inline void sk_eat_skb(struct sock *sk, struct sk_buff *skb)
1da177e4
LT
2295{
2296 __skb_unlink(skb, &sk->sk_receive_queue);
2297 __kfree_skb(skb);
2298}
2299
3b1e0a65
YH
2300static inline
2301struct net *sock_net(const struct sock *sk)
2302{
c2d9ba9b 2303 return read_pnet(&sk->sk_net);
3b1e0a65
YH
2304}
2305
2306static inline
f5aa23fd 2307void sock_net_set(struct sock *sk, struct net *net)
3b1e0a65 2308{
c2d9ba9b 2309 write_pnet(&sk->sk_net, net);
3b1e0a65
YH
2310}
2311
23542618
KK
2312static inline struct sock *skb_steal_sock(struct sk_buff *skb)
2313{
efc27f8c 2314 if (skb->sk) {
23542618
KK
2315 struct sock *sk = skb->sk;
2316
2317 skb->destructor = NULL;
2318 skb->sk = NULL;
2319 return sk;
2320 }
2321 return NULL;
2322}
2323
1d0ab253
ED
2324/* This helper checks if a socket is a full socket,
2325 * ie _not_ a timewait or request socket.
2326 */
2327static inline bool sk_fullsock(const struct sock *sk)
2328{
2329 return (1 << sk->sk_state) & ~(TCPF_TIME_WAIT | TCPF_NEW_SYN_RECV);
2330}
2331
e446f9df
ED
2332/* This helper checks if a socket is a LISTEN or NEW_SYN_RECV
2333 * SYNACK messages can be attached to either ones (depending on SYNCOOKIE)
2334 */
2335static inline bool sk_listener(const struct sock *sk)
2336{
2337 return (1 << sk->sk_state) & (TCPF_LISTEN | TCPF_NEW_SYN_RECV);
2338}
2339
69336bd2
JP
2340void sock_enable_timestamp(struct sock *sk, int flag);
2341int sock_get_timestamp(struct sock *, struct timeval __user *);
2342int sock_get_timestampns(struct sock *, struct timespec __user *);
2343int sock_recv_errqueue(struct sock *sk, struct msghdr *msg, int len, int level,
2344 int type);
1da177e4 2345
a3b299da
EB
2346bool sk_ns_capable(const struct sock *sk,
2347 struct user_namespace *user_ns, int cap);
2348bool sk_capable(const struct sock *sk, int cap);
2349bool sk_net_capable(const struct sock *sk, int cap);
2350
a2d133b1
JH
2351void sk_get_meminfo(const struct sock *sk, u32 *meminfo);
2352
eaa72dc4
ED
2353/* Take into consideration the size of the struct sk_buff overhead in the
2354 * determination of these values, since that is non-constant across
2355 * platforms. This makes socket queueing behavior and performance
2356 * not depend upon such differences.
2357 */
2358#define _SK_MEM_PACKETS 256
2359#define _SK_MEM_OVERHEAD SKB_TRUESIZE(256)
2360#define SK_WMEM_MAX (_SK_MEM_OVERHEAD * _SK_MEM_PACKETS)
2361#define SK_RMEM_MAX (_SK_MEM_OVERHEAD * _SK_MEM_PACKETS)
2362
1da177e4
LT
2363extern __u32 sysctl_wmem_max;
2364extern __u32 sysctl_rmem_max;
2365
b245be1f 2366extern int sysctl_tstamp_allow_data;
6baf1f41
DM
2367extern int sysctl_optmem_max;
2368
20380731
ACM
2369extern __u32 sysctl_wmem_default;
2370extern __u32 sysctl_rmem_default;
20380731 2371
a3dcaf17
ED
2372static inline int sk_get_wmem0(const struct sock *sk, const struct proto *proto)
2373{
2374 /* Does this proto have per netns sysctl_wmem ? */
2375 if (proto->sysctl_wmem_offset)
2376 return *(int *)((void *)sock_net(sk) + proto->sysctl_wmem_offset);
2377
2378 return *proto->sysctl_wmem;
2379}
2380
2381static inline int sk_get_rmem0(const struct sock *sk, const struct proto *proto)
2382{
2383 /* Does this proto have per netns sysctl_rmem ? */
2384 if (proto->sysctl_rmem_offset)
2385 return *(int *)((void *)sock_net(sk) + proto->sysctl_rmem_offset);
2386
2387 return *proto->sysctl_rmem;
2388}
2389
c9f1f58d
ED
2390/* Default TCP Small queue budget is ~1 ms of data (1sec >> 10)
2391 * Some wifi drivers need to tweak it to get more chunks.
2392 * They can use this helper from their ndo_start_xmit()
2393 */
2394static inline void sk_pacing_shift_update(struct sock *sk, int val)
2395{
2396 if (!sk || !sk_fullsock(sk) || sk->sk_pacing_shift == val)
2397 return;
2398 sk->sk_pacing_shift = val;
2399}
2400
54dc3e33
DA
2401/* if a socket is bound to a device, check that the given device
2402 * index is either the same or that the socket is bound to an L3
2403 * master device and the given device index is also enslaved to
2404 * that L3 master
2405 */
2406static inline bool sk_dev_equal_l3scope(struct sock *sk, int dif)
2407{
2408 int mdif;
2409
2410 if (!sk->sk_bound_dev_if || sk->sk_bound_dev_if == dif)
2411 return true;
2412
2413 mdif = l3mdev_master_ifindex_by_index(sock_net(sk), dif);
2414 if (mdif && mdif == sk->sk_bound_dev_if)
2415 return true;
2416
2417 return false;
2418}
2419
1da177e4 2420#endif /* _SOCK_H */