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