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