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