writeback: safer lock nesting
[linux/fpc-iii.git] / include / net / sock.h
blob9bd5d68076d9f84fa053bf41a3f343670f7efda9
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.
6 * Definitions for the AF_INET socket handler.
8 * Version: @(#)sock.h 1.0.4 05/13/93
10 * Authors: Ross Biro
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>
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
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.
40 #ifndef _SOCK_H
41 #define _SOCK_H
43 #include <linux/hardirq.h>
44 #include <linux/kernel.h>
45 #include <linux/list.h>
46 #include <linux/list_nulls.h>
47 #include <linux/timer.h>
48 #include <linux/cache.h>
49 #include <linux/bitops.h>
50 #include <linux/lockdep.h>
51 #include <linux/netdevice.h>
52 #include <linux/skbuff.h> /* struct sk_buff */
53 #include <linux/mm.h>
54 #include <linux/security.h>
55 #include <linux/slab.h>
56 #include <linux/uaccess.h>
57 #include <linux/page_counter.h>
58 #include <linux/memcontrol.h>
59 #include <linux/static_key.h>
60 #include <linux/sched.h>
61 #include <linux/wait.h>
62 #include <linux/cgroup-defs.h>
64 #include <linux/filter.h>
65 #include <linux/rculist_nulls.h>
66 #include <linux/poll.h>
68 #include <linux/atomic.h>
69 #include <linux/refcount.h>
70 #include <net/dst.h>
71 #include <net/checksum.h>
72 #include <net/tcp_states.h>
73 #include <linux/net_tstamp.h>
74 #include <net/smc.h>
77 * This structure really needs to be cleaned up.
78 * Most of it is for TCP, and not used by any of
79 * the other protocols.
82 /* Define this to get the SOCK_DBG debugging facility. */
83 #define SOCK_DEBUGGING
84 #ifdef SOCK_DEBUGGING
85 #define SOCK_DEBUG(sk, msg...) do { if ((sk) && sock_flag((sk), SOCK_DBG)) \
86 printk(KERN_DEBUG msg); } while (0)
87 #else
88 /* Validate arguments and do nothing */
89 static inline __printf(2, 3)
90 void SOCK_DEBUG(const struct sock *sk, const char *msg, ...)
93 #endif
95 /* This is the per-socket lock. The spinlock provides a synchronization
96 * between user contexts and software interrupt processing, whereas the
97 * mini-semaphore synchronizes multiple users amongst themselves.
99 typedef struct {
100 spinlock_t slock;
101 int owned;
102 wait_queue_head_t wq;
104 * We express the mutex-alike socket_lock semantics
105 * to the lock validator by explicitly managing
106 * the slock as a lock variant (in addition to
107 * the slock itself):
109 #ifdef CONFIG_DEBUG_LOCK_ALLOC
110 struct lockdep_map dep_map;
111 #endif
112 } socket_lock_t;
114 struct sock;
115 struct proto;
116 struct net;
118 typedef __u32 __bitwise __portpair;
119 typedef __u64 __bitwise __addrpair;
122 * struct sock_common - minimal network layer representation of sockets
123 * @skc_daddr: Foreign IPv4 addr
124 * @skc_rcv_saddr: Bound local IPv4 addr
125 * @skc_hash: hash value used with various protocol lookup tables
126 * @skc_u16hashes: two u16 hash values used by UDP lookup tables
127 * @skc_dport: placeholder for inet_dport/tw_dport
128 * @skc_num: placeholder for inet_num/tw_num
129 * @skc_family: network address family
130 * @skc_state: Connection state
131 * @skc_reuse: %SO_REUSEADDR setting
132 * @skc_reuseport: %SO_REUSEPORT setting
133 * @skc_bound_dev_if: bound device index if != 0
134 * @skc_bind_node: bind hash linkage for various protocol lookup tables
135 * @skc_portaddr_node: second hash linkage for UDP/UDP-Lite protocol
136 * @skc_prot: protocol handlers inside a network family
137 * @skc_net: reference to the network namespace of this socket
138 * @skc_node: main hash linkage for various protocol lookup tables
139 * @skc_nulls_node: main hash linkage for TCP/UDP/UDP-Lite protocol
140 * @skc_tx_queue_mapping: tx queue number for this connection
141 * @skc_flags: place holder for sk_flags
142 * %SO_LINGER (l_onoff), %SO_BROADCAST, %SO_KEEPALIVE,
143 * %SO_OOBINLINE settings, %SO_TIMESTAMPING settings
144 * @skc_incoming_cpu: record/match cpu processing incoming packets
145 * @skc_refcnt: reference count
147 * This is the minimal network layer representation of sockets, the header
148 * for struct sock and struct inet_timewait_sock.
150 struct sock_common {
151 /* skc_daddr and skc_rcv_saddr must be grouped on a 8 bytes aligned
152 * address on 64bit arches : cf INET_MATCH()
154 union {
155 __addrpair skc_addrpair;
156 struct {
157 __be32 skc_daddr;
158 __be32 skc_rcv_saddr;
161 union {
162 unsigned int skc_hash;
163 __u16 skc_u16hashes[2];
165 /* skc_dport && skc_num must be grouped as well */
166 union {
167 __portpair skc_portpair;
168 struct {
169 __be16 skc_dport;
170 __u16 skc_num;
174 unsigned short skc_family;
175 volatile unsigned char skc_state;
176 unsigned char skc_reuse:4;
177 unsigned char skc_reuseport:1;
178 unsigned char skc_ipv6only:1;
179 unsigned char skc_net_refcnt:1;
180 int skc_bound_dev_if;
181 union {
182 struct hlist_node skc_bind_node;
183 struct hlist_node skc_portaddr_node;
185 struct proto *skc_prot;
186 possible_net_t skc_net;
188 #if IS_ENABLED(CONFIG_IPV6)
189 struct in6_addr skc_v6_daddr;
190 struct in6_addr skc_v6_rcv_saddr;
191 #endif
193 atomic64_t skc_cookie;
195 /* following fields are padding to force
196 * offset(struct sock, sk_refcnt) == 128 on 64bit arches
197 * assuming IPV6 is enabled. We use this padding differently
198 * for different kind of 'sockets'
200 union {
201 unsigned long skc_flags;
202 struct sock *skc_listener; /* request_sock */
203 struct inet_timewait_death_row *skc_tw_dr; /* inet_timewait_sock */
206 * fields between dontcopy_begin/dontcopy_end
207 * are not copied in sock_copy()
209 /* private: */
210 int skc_dontcopy_begin[0];
211 /* public: */
212 union {
213 struct hlist_node skc_node;
214 struct hlist_nulls_node skc_nulls_node;
216 int skc_tx_queue_mapping;
217 union {
218 int skc_incoming_cpu;
219 u32 skc_rcv_wnd;
220 u32 skc_tw_rcv_nxt; /* struct tcp_timewait_sock */
223 refcount_t skc_refcnt;
224 /* private: */
225 int skc_dontcopy_end[0];
226 union {
227 u32 skc_rxhash;
228 u32 skc_window_clamp;
229 u32 skc_tw_snd_nxt; /* struct tcp_timewait_sock */
231 /* public: */
235 * struct sock - network layer representation of sockets
236 * @__sk_common: shared layout with inet_timewait_sock
237 * @sk_shutdown: mask of %SEND_SHUTDOWN and/or %RCV_SHUTDOWN
238 * @sk_userlocks: %SO_SNDBUF and %SO_RCVBUF settings
239 * @sk_lock: synchronizer
240 * @sk_kern_sock: True if sock is using kernel lock classes
241 * @sk_rcvbuf: size of receive buffer in bytes
242 * @sk_wq: sock wait queue and async head
243 * @sk_rx_dst: receive input route used by early demux
244 * @sk_dst_cache: destination cache
245 * @sk_dst_pending_confirm: need to confirm neighbour
246 * @sk_policy: flow policy
247 * @sk_receive_queue: incoming packets
248 * @sk_wmem_alloc: transmit queue bytes committed
249 * @sk_tsq_flags: TCP Small Queues flags
250 * @sk_write_queue: Packet sending queue
251 * @sk_omem_alloc: "o" is "option" or "other"
252 * @sk_wmem_queued: persistent queue size
253 * @sk_forward_alloc: space allocated forward
254 * @sk_napi_id: id of the last napi context to receive data for sk
255 * @sk_ll_usec: usecs to busypoll when there is no data
256 * @sk_allocation: allocation mode
257 * @sk_pacing_rate: Pacing rate (if supported by transport/packet scheduler)
258 * @sk_pacing_status: Pacing status (requested, handled by sch_fq)
259 * @sk_max_pacing_rate: Maximum pacing rate (%SO_MAX_PACING_RATE)
260 * @sk_sndbuf: size of send buffer in bytes
261 * @__sk_flags_offset: empty field used to determine location of bitfield
262 * @sk_padding: unused element for alignment
263 * @sk_no_check_tx: %SO_NO_CHECK setting, set checksum in TX packets
264 * @sk_no_check_rx: allow zero checksum in RX packets
265 * @sk_route_caps: route capabilities (e.g. %NETIF_F_TSO)
266 * @sk_route_nocaps: forbidden route capabilities (e.g NETIF_F_GSO_MASK)
267 * @sk_gso_type: GSO type (e.g. %SKB_GSO_TCPV4)
268 * @sk_gso_max_size: Maximum GSO segment size to build
269 * @sk_gso_max_segs: Maximum number of GSO segments
270 * @sk_lingertime: %SO_LINGER l_linger setting
271 * @sk_backlog: always used with the per-socket spinlock held
272 * @sk_callback_lock: used with the callbacks in the end of this struct
273 * @sk_error_queue: rarely used
274 * @sk_prot_creator: sk_prot of original sock creator (see ipv6_setsockopt,
275 * IPV6_ADDRFORM for instance)
276 * @sk_err: last error
277 * @sk_err_soft: errors that don't cause failure but are the cause of a
278 * persistent failure not just 'timed out'
279 * @sk_drops: raw/udp drops counter
280 * @sk_ack_backlog: current listen backlog
281 * @sk_max_ack_backlog: listen backlog set in listen()
282 * @sk_uid: user id of owner
283 * @sk_priority: %SO_PRIORITY setting
284 * @sk_type: socket type (%SOCK_STREAM, etc)
285 * @sk_protocol: which protocol this socket belongs in this network family
286 * @sk_peer_pid: &struct pid for this socket's peer
287 * @sk_peer_cred: %SO_PEERCRED setting
288 * @sk_rcvlowat: %SO_RCVLOWAT setting
289 * @sk_rcvtimeo: %SO_RCVTIMEO setting
290 * @sk_sndtimeo: %SO_SNDTIMEO setting
291 * @sk_txhash: computed flow hash for use on transmit
292 * @sk_filter: socket filtering instructions
293 * @sk_timer: sock cleanup timer
294 * @sk_stamp: time stamp of last packet received
295 * @sk_tsflags: SO_TIMESTAMPING socket options
296 * @sk_tskey: counter to disambiguate concurrent tstamp requests
297 * @sk_zckey: counter to order MSG_ZEROCOPY notifications
298 * @sk_socket: Identd and reporting IO signals
299 * @sk_user_data: RPC layer private data
300 * @sk_frag: cached page frag
301 * @sk_peek_off: current peek_offset value
302 * @sk_send_head: front of stuff to transmit
303 * @sk_security: used by security modules
304 * @sk_mark: generic packet mark
305 * @sk_cgrp_data: cgroup data for this cgroup
306 * @sk_memcg: this socket's memory cgroup association
307 * @sk_write_pending: a write to stream socket waits to start
308 * @sk_state_change: callback to indicate change in the state of the sock
309 * @sk_data_ready: callback to indicate there is data to be processed
310 * @sk_write_space: callback to indicate there is bf sending space available
311 * @sk_error_report: callback to indicate errors (e.g. %MSG_ERRQUEUE)
312 * @sk_backlog_rcv: callback to process the backlog
313 * @sk_destruct: called at sock freeing time, i.e. when all refcnt == 0
314 * @sk_reuseport_cb: reuseport group container
315 * @sk_rcu: used during RCU grace period
317 struct sock {
319 * Now struct inet_timewait_sock also uses sock_common, so please just
320 * don't add nothing before this first member (__sk_common) --acme
322 struct sock_common __sk_common;
323 #define sk_node __sk_common.skc_node
324 #define sk_nulls_node __sk_common.skc_nulls_node
325 #define sk_refcnt __sk_common.skc_refcnt
326 #define sk_tx_queue_mapping __sk_common.skc_tx_queue_mapping
328 #define sk_dontcopy_begin __sk_common.skc_dontcopy_begin
329 #define sk_dontcopy_end __sk_common.skc_dontcopy_end
330 #define sk_hash __sk_common.skc_hash
331 #define sk_portpair __sk_common.skc_portpair
332 #define sk_num __sk_common.skc_num
333 #define sk_dport __sk_common.skc_dport
334 #define sk_addrpair __sk_common.skc_addrpair
335 #define sk_daddr __sk_common.skc_daddr
336 #define sk_rcv_saddr __sk_common.skc_rcv_saddr
337 #define sk_family __sk_common.skc_family
338 #define sk_state __sk_common.skc_state
339 #define sk_reuse __sk_common.skc_reuse
340 #define sk_reuseport __sk_common.skc_reuseport
341 #define sk_ipv6only __sk_common.skc_ipv6only
342 #define sk_net_refcnt __sk_common.skc_net_refcnt
343 #define sk_bound_dev_if __sk_common.skc_bound_dev_if
344 #define sk_bind_node __sk_common.skc_bind_node
345 #define sk_prot __sk_common.skc_prot
346 #define sk_net __sk_common.skc_net
347 #define sk_v6_daddr __sk_common.skc_v6_daddr
348 #define sk_v6_rcv_saddr __sk_common.skc_v6_rcv_saddr
349 #define sk_cookie __sk_common.skc_cookie
350 #define sk_incoming_cpu __sk_common.skc_incoming_cpu
351 #define sk_flags __sk_common.skc_flags
352 #define sk_rxhash __sk_common.skc_rxhash
354 socket_lock_t sk_lock;
355 atomic_t sk_drops;
356 int sk_rcvlowat;
357 struct sk_buff_head sk_error_queue;
358 struct sk_buff_head sk_receive_queue;
360 * The backlog queue is special, it is always used with
361 * the per-socket spinlock held and requires low latency
362 * access. Therefore we special case it's implementation.
363 * Note : rmem_alloc is in this structure to fill a hole
364 * on 64bit arches, not because its logically part of
365 * backlog.
367 struct {
368 atomic_t rmem_alloc;
369 int len;
370 struct sk_buff *head;
371 struct sk_buff *tail;
372 } sk_backlog;
373 #define sk_rmem_alloc sk_backlog.rmem_alloc
375 int sk_forward_alloc;
376 #ifdef CONFIG_NET_RX_BUSY_POLL
377 unsigned int sk_ll_usec;
378 /* ===== mostly read cache line ===== */
379 unsigned int sk_napi_id;
380 #endif
381 int sk_rcvbuf;
383 struct sk_filter __rcu *sk_filter;
384 union {
385 struct socket_wq __rcu *sk_wq;
386 struct socket_wq *sk_wq_raw;
388 #ifdef CONFIG_XFRM
389 struct xfrm_policy __rcu *sk_policy[2];
390 #endif
391 struct dst_entry *sk_rx_dst;
392 struct dst_entry __rcu *sk_dst_cache;
393 atomic_t sk_omem_alloc;
394 int sk_sndbuf;
396 /* ===== cache line for TX ===== */
397 int sk_wmem_queued;
398 refcount_t sk_wmem_alloc;
399 unsigned long sk_tsq_flags;
400 struct sk_buff *sk_send_head;
401 struct sk_buff_head sk_write_queue;
402 __s32 sk_peek_off;
403 int sk_write_pending;
404 __u32 sk_dst_pending_confirm;
405 u32 sk_pacing_status; /* see enum sk_pacing */
406 long sk_sndtimeo;
407 struct timer_list sk_timer;
408 __u32 sk_priority;
409 __u32 sk_mark;
410 u32 sk_pacing_rate; /* bytes per second */
411 u32 sk_max_pacing_rate;
412 struct page_frag sk_frag;
413 netdev_features_t sk_route_caps;
414 netdev_features_t sk_route_nocaps;
415 int sk_gso_type;
416 unsigned int sk_gso_max_size;
417 gfp_t sk_allocation;
418 __u32 sk_txhash;
421 * Because of non atomicity rules, all
422 * changes are protected by socket lock.
424 unsigned int __sk_flags_offset[0];
425 #ifdef __BIG_ENDIAN_BITFIELD
426 #define SK_FL_PROTO_SHIFT 16
427 #define SK_FL_PROTO_MASK 0x00ff0000
429 #define SK_FL_TYPE_SHIFT 0
430 #define SK_FL_TYPE_MASK 0x0000ffff
431 #else
432 #define SK_FL_PROTO_SHIFT 8
433 #define SK_FL_PROTO_MASK 0x0000ff00
435 #define SK_FL_TYPE_SHIFT 16
436 #define SK_FL_TYPE_MASK 0xffff0000
437 #endif
439 unsigned int sk_padding : 1,
440 sk_kern_sock : 1,
441 sk_no_check_tx : 1,
442 sk_no_check_rx : 1,
443 sk_userlocks : 4,
444 sk_protocol : 8,
445 sk_type : 16;
446 #define SK_PROTOCOL_MAX U8_MAX
447 u16 sk_gso_max_segs;
448 unsigned long sk_lingertime;
449 struct proto *sk_prot_creator;
450 rwlock_t sk_callback_lock;
451 int sk_err,
452 sk_err_soft;
453 u32 sk_ack_backlog;
454 u32 sk_max_ack_backlog;
455 kuid_t sk_uid;
456 struct pid *sk_peer_pid;
457 const struct cred *sk_peer_cred;
458 long sk_rcvtimeo;
459 ktime_t sk_stamp;
460 u16 sk_tsflags;
461 u8 sk_shutdown;
462 u32 sk_tskey;
463 atomic_t sk_zckey;
464 struct socket *sk_socket;
465 void *sk_user_data;
466 #ifdef CONFIG_SECURITY
467 void *sk_security;
468 #endif
469 struct sock_cgroup_data sk_cgrp_data;
470 struct mem_cgroup *sk_memcg;
471 void (*sk_state_change)(struct sock *sk);
472 void (*sk_data_ready)(struct sock *sk);
473 void (*sk_write_space)(struct sock *sk);
474 void (*sk_error_report)(struct sock *sk);
475 int (*sk_backlog_rcv)(struct sock *sk,
476 struct sk_buff *skb);
477 void (*sk_destruct)(struct sock *sk);
478 struct sock_reuseport __rcu *sk_reuseport_cb;
479 struct rcu_head sk_rcu;
482 enum sk_pacing {
483 SK_PACING_NONE = 0,
484 SK_PACING_NEEDED = 1,
485 SK_PACING_FQ = 2,
488 #define __sk_user_data(sk) ((*((void __rcu **)&(sk)->sk_user_data)))
490 #define rcu_dereference_sk_user_data(sk) rcu_dereference(__sk_user_data((sk)))
491 #define rcu_assign_sk_user_data(sk, ptr) rcu_assign_pointer(__sk_user_data((sk)), ptr)
494 * SK_CAN_REUSE and SK_NO_REUSE on a socket mean that the socket is OK
495 * or not whether his port will be reused by someone else. SK_FORCE_REUSE
496 * on a socket means that the socket will reuse everybody else's port
497 * without looking at the other's sk_reuse value.
500 #define SK_NO_REUSE 0
501 #define SK_CAN_REUSE 1
502 #define SK_FORCE_REUSE 2
504 int sk_set_peek_off(struct sock *sk, int val);
506 static inline int sk_peek_offset(struct sock *sk, int flags)
508 if (unlikely(flags & MSG_PEEK)) {
509 return READ_ONCE(sk->sk_peek_off);
512 return 0;
515 static inline void sk_peek_offset_bwd(struct sock *sk, int val)
517 s32 off = READ_ONCE(sk->sk_peek_off);
519 if (unlikely(off >= 0)) {
520 off = max_t(s32, off - val, 0);
521 WRITE_ONCE(sk->sk_peek_off, off);
525 static inline void sk_peek_offset_fwd(struct sock *sk, int val)
527 sk_peek_offset_bwd(sk, -val);
531 * Hashed lists helper routines
533 static inline struct sock *sk_entry(const struct hlist_node *node)
535 return hlist_entry(node, struct sock, sk_node);
538 static inline struct sock *__sk_head(const struct hlist_head *head)
540 return hlist_entry(head->first, struct sock, sk_node);
543 static inline struct sock *sk_head(const struct hlist_head *head)
545 return hlist_empty(head) ? NULL : __sk_head(head);
548 static inline struct sock *__sk_nulls_head(const struct hlist_nulls_head *head)
550 return hlist_nulls_entry(head->first, struct sock, sk_nulls_node);
553 static inline struct sock *sk_nulls_head(const struct hlist_nulls_head *head)
555 return hlist_nulls_empty(head) ? NULL : __sk_nulls_head(head);
558 static inline struct sock *sk_next(const struct sock *sk)
560 return hlist_entry_safe(sk->sk_node.next, struct sock, sk_node);
563 static inline struct sock *sk_nulls_next(const struct sock *sk)
565 return (!is_a_nulls(sk->sk_nulls_node.next)) ?
566 hlist_nulls_entry(sk->sk_nulls_node.next,
567 struct sock, sk_nulls_node) :
568 NULL;
571 static inline bool sk_unhashed(const struct sock *sk)
573 return hlist_unhashed(&sk->sk_node);
576 static inline bool sk_hashed(const struct sock *sk)
578 return !sk_unhashed(sk);
581 static inline void sk_node_init(struct hlist_node *node)
583 node->pprev = NULL;
586 static inline void sk_nulls_node_init(struct hlist_nulls_node *node)
588 node->pprev = NULL;
591 static inline void __sk_del_node(struct sock *sk)
593 __hlist_del(&sk->sk_node);
596 /* NB: equivalent to hlist_del_init_rcu */
597 static inline bool __sk_del_node_init(struct sock *sk)
599 if (sk_hashed(sk)) {
600 __sk_del_node(sk);
601 sk_node_init(&sk->sk_node);
602 return true;
604 return false;
607 /* Grab socket reference count. This operation is valid only
608 when sk is ALREADY grabbed f.e. it is found in hash table
609 or a list and the lookup is made under lock preventing hash table
610 modifications.
613 static __always_inline void sock_hold(struct sock *sk)
615 refcount_inc(&sk->sk_refcnt);
618 /* Ungrab socket in the context, which assumes that socket refcnt
619 cannot hit zero, f.e. it is true in context of any socketcall.
621 static __always_inline void __sock_put(struct sock *sk)
623 refcount_dec(&sk->sk_refcnt);
626 static inline bool sk_del_node_init(struct sock *sk)
628 bool rc = __sk_del_node_init(sk);
630 if (rc) {
631 /* paranoid for a while -acme */
632 WARN_ON(refcount_read(&sk->sk_refcnt) == 1);
633 __sock_put(sk);
635 return rc;
637 #define sk_del_node_init_rcu(sk) sk_del_node_init(sk)
639 static inline bool __sk_nulls_del_node_init_rcu(struct sock *sk)
641 if (sk_hashed(sk)) {
642 hlist_nulls_del_init_rcu(&sk->sk_nulls_node);
643 return true;
645 return false;
648 static inline bool sk_nulls_del_node_init_rcu(struct sock *sk)
650 bool rc = __sk_nulls_del_node_init_rcu(sk);
652 if (rc) {
653 /* paranoid for a while -acme */
654 WARN_ON(refcount_read(&sk->sk_refcnt) == 1);
655 __sock_put(sk);
657 return rc;
660 static inline void __sk_add_node(struct sock *sk, struct hlist_head *list)
662 hlist_add_head(&sk->sk_node, list);
665 static inline void sk_add_node(struct sock *sk, struct hlist_head *list)
667 sock_hold(sk);
668 __sk_add_node(sk, list);
671 static inline void sk_add_node_rcu(struct sock *sk, struct hlist_head *list)
673 sock_hold(sk);
674 if (IS_ENABLED(CONFIG_IPV6) && sk->sk_reuseport &&
675 sk->sk_family == AF_INET6)
676 hlist_add_tail_rcu(&sk->sk_node, list);
677 else
678 hlist_add_head_rcu(&sk->sk_node, list);
681 static inline void __sk_nulls_add_node_rcu(struct sock *sk, struct hlist_nulls_head *list)
683 hlist_nulls_add_head_rcu(&sk->sk_nulls_node, list);
686 static inline void sk_nulls_add_node_rcu(struct sock *sk, struct hlist_nulls_head *list)
688 sock_hold(sk);
689 __sk_nulls_add_node_rcu(sk, list);
692 static inline void __sk_del_bind_node(struct sock *sk)
694 __hlist_del(&sk->sk_bind_node);
697 static inline void sk_add_bind_node(struct sock *sk,
698 struct hlist_head *list)
700 hlist_add_head(&sk->sk_bind_node, list);
703 #define sk_for_each(__sk, list) \
704 hlist_for_each_entry(__sk, list, sk_node)
705 #define sk_for_each_rcu(__sk, list) \
706 hlist_for_each_entry_rcu(__sk, list, sk_node)
707 #define sk_nulls_for_each(__sk, node, list) \
708 hlist_nulls_for_each_entry(__sk, node, list, sk_nulls_node)
709 #define sk_nulls_for_each_rcu(__sk, node, list) \
710 hlist_nulls_for_each_entry_rcu(__sk, node, list, sk_nulls_node)
711 #define sk_for_each_from(__sk) \
712 hlist_for_each_entry_from(__sk, sk_node)
713 #define sk_nulls_for_each_from(__sk, node) \
714 if (__sk && ({ node = &(__sk)->sk_nulls_node; 1; })) \
715 hlist_nulls_for_each_entry_from(__sk, node, sk_nulls_node)
716 #define sk_for_each_safe(__sk, tmp, list) \
717 hlist_for_each_entry_safe(__sk, tmp, list, sk_node)
718 #define sk_for_each_bound(__sk, list) \
719 hlist_for_each_entry(__sk, list, sk_bind_node)
722 * sk_for_each_entry_offset_rcu - iterate over a list at a given struct offset
723 * @tpos: the type * to use as a loop cursor.
724 * @pos: the &struct hlist_node to use as a loop cursor.
725 * @head: the head for your list.
726 * @offset: offset of hlist_node within the struct.
729 #define sk_for_each_entry_offset_rcu(tpos, pos, head, offset) \
730 for (pos = rcu_dereference((head)->first); \
731 pos != NULL && \
732 ({ tpos = (typeof(*tpos) *)((void *)pos - offset); 1;}); \
733 pos = rcu_dereference(pos->next))
735 static inline struct user_namespace *sk_user_ns(struct sock *sk)
737 /* Careful only use this in a context where these parameters
738 * can not change and must all be valid, such as recvmsg from
739 * userspace.
741 return sk->sk_socket->file->f_cred->user_ns;
744 /* Sock flags */
745 enum sock_flags {
746 SOCK_DEAD,
747 SOCK_DONE,
748 SOCK_URGINLINE,
749 SOCK_KEEPOPEN,
750 SOCK_LINGER,
751 SOCK_DESTROY,
752 SOCK_BROADCAST,
753 SOCK_TIMESTAMP,
754 SOCK_ZAPPED,
755 SOCK_USE_WRITE_QUEUE, /* whether to call sk->sk_write_space in sock_wfree */
756 SOCK_DBG, /* %SO_DEBUG setting */
757 SOCK_RCVTSTAMP, /* %SO_TIMESTAMP setting */
758 SOCK_RCVTSTAMPNS, /* %SO_TIMESTAMPNS setting */
759 SOCK_LOCALROUTE, /* route locally only, %SO_DONTROUTE setting */
760 SOCK_QUEUE_SHRUNK, /* write queue has been shrunk recently */
761 SOCK_MEMALLOC, /* VM depends on this socket for swapping */
762 SOCK_TIMESTAMPING_RX_SOFTWARE, /* %SOF_TIMESTAMPING_RX_SOFTWARE */
763 SOCK_FASYNC, /* fasync() active */
764 SOCK_RXQ_OVFL,
765 SOCK_ZEROCOPY, /* buffers from userspace */
766 SOCK_WIFI_STATUS, /* push wifi status to userspace */
767 SOCK_NOFCS, /* Tell NIC not to do the Ethernet FCS.
768 * Will use last 4 bytes of packet sent from
769 * user-space instead.
771 SOCK_FILTER_LOCKED, /* Filter cannot be changed anymore */
772 SOCK_SELECT_ERR_QUEUE, /* Wake select on error queue */
773 SOCK_RCU_FREE, /* wait rcu grace period in sk_destruct() */
776 #define SK_FLAGS_TIMESTAMP ((1UL << SOCK_TIMESTAMP) | (1UL << SOCK_TIMESTAMPING_RX_SOFTWARE))
778 static inline void sock_copy_flags(struct sock *nsk, struct sock *osk)
780 nsk->sk_flags = osk->sk_flags;
783 static inline void sock_set_flag(struct sock *sk, enum sock_flags flag)
785 __set_bit(flag, &sk->sk_flags);
788 static inline void sock_reset_flag(struct sock *sk, enum sock_flags flag)
790 __clear_bit(flag, &sk->sk_flags);
793 static inline bool sock_flag(const struct sock *sk, enum sock_flags flag)
795 return test_bit(flag, &sk->sk_flags);
798 #ifdef CONFIG_NET
799 extern struct static_key memalloc_socks;
800 static inline int sk_memalloc_socks(void)
802 return static_key_false(&memalloc_socks);
804 #else
806 static inline int sk_memalloc_socks(void)
808 return 0;
811 #endif
813 static inline gfp_t sk_gfp_mask(const struct sock *sk, gfp_t gfp_mask)
815 return gfp_mask | (sk->sk_allocation & __GFP_MEMALLOC);
818 static inline void sk_acceptq_removed(struct sock *sk)
820 sk->sk_ack_backlog--;
823 static inline void sk_acceptq_added(struct sock *sk)
825 sk->sk_ack_backlog++;
828 static inline bool sk_acceptq_is_full(const struct sock *sk)
830 return sk->sk_ack_backlog > sk->sk_max_ack_backlog;
834 * Compute minimal free write space needed to queue new packets.
836 static inline int sk_stream_min_wspace(const struct sock *sk)
838 return sk->sk_wmem_queued >> 1;
841 static inline int sk_stream_wspace(const struct sock *sk)
843 return sk->sk_sndbuf - sk->sk_wmem_queued;
846 void sk_stream_write_space(struct sock *sk);
848 /* OOB backlog add */
849 static inline void __sk_add_backlog(struct sock *sk, struct sk_buff *skb)
851 /* dont let skb dst not refcounted, we are going to leave rcu lock */
852 skb_dst_force(skb);
854 if (!sk->sk_backlog.tail)
855 sk->sk_backlog.head = skb;
856 else
857 sk->sk_backlog.tail->next = skb;
859 sk->sk_backlog.tail = skb;
860 skb->next = NULL;
864 * Take into account size of receive queue and backlog queue
865 * Do not take into account this skb truesize,
866 * to allow even a single big packet to come.
868 static inline bool sk_rcvqueues_full(const struct sock *sk, unsigned int limit)
870 unsigned int qsize = sk->sk_backlog.len + atomic_read(&sk->sk_rmem_alloc);
872 return qsize > limit;
875 /* The per-socket spinlock must be held here. */
876 static inline __must_check int sk_add_backlog(struct sock *sk, struct sk_buff *skb,
877 unsigned int limit)
879 if (sk_rcvqueues_full(sk, limit))
880 return -ENOBUFS;
883 * If the skb was allocated from pfmemalloc reserves, only
884 * allow SOCK_MEMALLOC sockets to use it as this socket is
885 * helping free memory
887 if (skb_pfmemalloc(skb) && !sock_flag(sk, SOCK_MEMALLOC))
888 return -ENOMEM;
890 __sk_add_backlog(sk, skb);
891 sk->sk_backlog.len += skb->truesize;
892 return 0;
895 int __sk_backlog_rcv(struct sock *sk, struct sk_buff *skb);
897 static inline int sk_backlog_rcv(struct sock *sk, struct sk_buff *skb)
899 if (sk_memalloc_socks() && skb_pfmemalloc(skb))
900 return __sk_backlog_rcv(sk, skb);
902 return sk->sk_backlog_rcv(sk, skb);
905 static inline void sk_incoming_cpu_update(struct sock *sk)
907 int cpu = raw_smp_processor_id();
909 if (unlikely(sk->sk_incoming_cpu != cpu))
910 sk->sk_incoming_cpu = cpu;
913 static inline void sock_rps_record_flow_hash(__u32 hash)
915 #ifdef CONFIG_RPS
916 struct rps_sock_flow_table *sock_flow_table;
918 rcu_read_lock();
919 sock_flow_table = rcu_dereference(rps_sock_flow_table);
920 rps_record_sock_flow(sock_flow_table, hash);
921 rcu_read_unlock();
922 #endif
925 static inline void sock_rps_record_flow(const struct sock *sk)
927 #ifdef CONFIG_RPS
928 if (static_key_false(&rfs_needed)) {
929 /* Reading sk->sk_rxhash might incur an expensive cache line
930 * miss.
932 * TCP_ESTABLISHED does cover almost all states where RFS
933 * might be useful, and is cheaper [1] than testing :
934 * IPv4: inet_sk(sk)->inet_daddr
935 * IPv6: ipv6_addr_any(&sk->sk_v6_daddr)
936 * OR an additional socket flag
937 * [1] : sk_state and sk_prot are in the same cache line.
939 if (sk->sk_state == TCP_ESTABLISHED)
940 sock_rps_record_flow_hash(sk->sk_rxhash);
942 #endif
945 static inline void sock_rps_save_rxhash(struct sock *sk,
946 const struct sk_buff *skb)
948 #ifdef CONFIG_RPS
949 if (unlikely(sk->sk_rxhash != skb->hash))
950 sk->sk_rxhash = skb->hash;
951 #endif
954 static inline void sock_rps_reset_rxhash(struct sock *sk)
956 #ifdef CONFIG_RPS
957 sk->sk_rxhash = 0;
958 #endif
961 #define sk_wait_event(__sk, __timeo, __condition, __wait) \
962 ({ int __rc; \
963 release_sock(__sk); \
964 __rc = __condition; \
965 if (!__rc) { \
966 *(__timeo) = wait_woken(__wait, \
967 TASK_INTERRUPTIBLE, \
968 *(__timeo)); \
970 sched_annotate_sleep(); \
971 lock_sock(__sk); \
972 __rc = __condition; \
973 __rc; \
976 int sk_stream_wait_connect(struct sock *sk, long *timeo_p);
977 int sk_stream_wait_memory(struct sock *sk, long *timeo_p);
978 void sk_stream_wait_close(struct sock *sk, long timeo_p);
979 int sk_stream_error(struct sock *sk, int flags, int err);
980 void sk_stream_kill_queues(struct sock *sk);
981 void sk_set_memalloc(struct sock *sk);
982 void sk_clear_memalloc(struct sock *sk);
984 void __sk_flush_backlog(struct sock *sk);
986 static inline bool sk_flush_backlog(struct sock *sk)
988 if (unlikely(READ_ONCE(sk->sk_backlog.tail))) {
989 __sk_flush_backlog(sk);
990 return true;
992 return false;
995 int sk_wait_data(struct sock *sk, long *timeo, const struct sk_buff *skb);
997 struct request_sock_ops;
998 struct timewait_sock_ops;
999 struct inet_hashinfo;
1000 struct raw_hashinfo;
1001 struct smc_hashinfo;
1002 struct module;
1005 * caches using SLAB_TYPESAFE_BY_RCU should let .next pointer from nulls nodes
1006 * un-modified. Special care is taken when initializing object to zero.
1008 static inline void sk_prot_clear_nulls(struct sock *sk, int size)
1010 if (offsetof(struct sock, sk_node.next) != 0)
1011 memset(sk, 0, offsetof(struct sock, sk_node.next));
1012 memset(&sk->sk_node.pprev, 0,
1013 size - offsetof(struct sock, sk_node.pprev));
1016 /* Networking protocol blocks we attach to sockets.
1017 * socket layer -> transport layer interface
1019 struct proto {
1020 void (*close)(struct sock *sk,
1021 long timeout);
1022 int (*connect)(struct sock *sk,
1023 struct sockaddr *uaddr,
1024 int addr_len);
1025 int (*disconnect)(struct sock *sk, int flags);
1027 struct sock * (*accept)(struct sock *sk, int flags, int *err,
1028 bool kern);
1030 int (*ioctl)(struct sock *sk, int cmd,
1031 unsigned long arg);
1032 int (*init)(struct sock *sk);
1033 void (*destroy)(struct sock *sk);
1034 void (*shutdown)(struct sock *sk, int how);
1035 int (*setsockopt)(struct sock *sk, int level,
1036 int optname, char __user *optval,
1037 unsigned int optlen);
1038 int (*getsockopt)(struct sock *sk, int level,
1039 int optname, char __user *optval,
1040 int __user *option);
1041 void (*keepalive)(struct sock *sk, int valbool);
1042 #ifdef CONFIG_COMPAT
1043 int (*compat_setsockopt)(struct sock *sk,
1044 int level,
1045 int optname, char __user *optval,
1046 unsigned int optlen);
1047 int (*compat_getsockopt)(struct sock *sk,
1048 int level,
1049 int optname, char __user *optval,
1050 int __user *option);
1051 int (*compat_ioctl)(struct sock *sk,
1052 unsigned int cmd, unsigned long arg);
1053 #endif
1054 int (*sendmsg)(struct sock *sk, struct msghdr *msg,
1055 size_t len);
1056 int (*recvmsg)(struct sock *sk, struct msghdr *msg,
1057 size_t len, int noblock, int flags,
1058 int *addr_len);
1059 int (*sendpage)(struct sock *sk, struct page *page,
1060 int offset, size_t size, int flags);
1061 int (*bind)(struct sock *sk,
1062 struct sockaddr *uaddr, int addr_len);
1064 int (*backlog_rcv) (struct sock *sk,
1065 struct sk_buff *skb);
1067 void (*release_cb)(struct sock *sk);
1069 /* Keeping track of sk's, looking them up, and port selection methods. */
1070 int (*hash)(struct sock *sk);
1071 void (*unhash)(struct sock *sk);
1072 void (*rehash)(struct sock *sk);
1073 int (*get_port)(struct sock *sk, unsigned short snum);
1075 /* Keeping track of sockets in use */
1076 #ifdef CONFIG_PROC_FS
1077 unsigned int inuse_idx;
1078 #endif
1080 bool (*stream_memory_free)(const struct sock *sk);
1081 /* Memory pressure */
1082 void (*enter_memory_pressure)(struct sock *sk);
1083 void (*leave_memory_pressure)(struct sock *sk);
1084 atomic_long_t *memory_allocated; /* Current allocated memory. */
1085 struct percpu_counter *sockets_allocated; /* Current number of sockets. */
1087 * Pressure flag: try to collapse.
1088 * Technical note: it is used by multiple contexts non atomically.
1089 * All the __sk_mem_schedule() is of this nature: accounting
1090 * is strict, actions are advisory and have some latency.
1092 unsigned long *memory_pressure;
1093 long *sysctl_mem;
1094 int *sysctl_wmem;
1095 int *sysctl_rmem;
1096 int max_header;
1097 bool no_autobind;
1099 struct kmem_cache *slab;
1100 unsigned int obj_size;
1101 int slab_flags;
1103 struct percpu_counter *orphan_count;
1105 struct request_sock_ops *rsk_prot;
1106 struct timewait_sock_ops *twsk_prot;
1108 union {
1109 struct inet_hashinfo *hashinfo;
1110 struct udp_table *udp_table;
1111 struct raw_hashinfo *raw_hash;
1112 struct smc_hashinfo *smc_hash;
1113 } h;
1115 struct module *owner;
1117 char name[32];
1119 struct list_head node;
1120 #ifdef SOCK_REFCNT_DEBUG
1121 atomic_t socks;
1122 #endif
1123 int (*diag_destroy)(struct sock *sk, int err);
1124 } __randomize_layout;
1126 int proto_register(struct proto *prot, int alloc_slab);
1127 void proto_unregister(struct proto *prot);
1129 #ifdef SOCK_REFCNT_DEBUG
1130 static inline void sk_refcnt_debug_inc(struct sock *sk)
1132 atomic_inc(&sk->sk_prot->socks);
1135 static inline void sk_refcnt_debug_dec(struct sock *sk)
1137 atomic_dec(&sk->sk_prot->socks);
1138 printk(KERN_DEBUG "%s socket %p released, %d are still alive\n",
1139 sk->sk_prot->name, sk, atomic_read(&sk->sk_prot->socks));
1142 static inline void sk_refcnt_debug_release(const struct sock *sk)
1144 if (refcount_read(&sk->sk_refcnt) != 1)
1145 printk(KERN_DEBUG "Destruction of the %s socket %p delayed, refcnt=%d\n",
1146 sk->sk_prot->name, sk, refcount_read(&sk->sk_refcnt));
1148 #else /* SOCK_REFCNT_DEBUG */
1149 #define sk_refcnt_debug_inc(sk) do { } while (0)
1150 #define sk_refcnt_debug_dec(sk) do { } while (0)
1151 #define sk_refcnt_debug_release(sk) do { } while (0)
1152 #endif /* SOCK_REFCNT_DEBUG */
1154 static inline bool sk_stream_memory_free(const struct sock *sk)
1156 if (sk->sk_wmem_queued >= sk->sk_sndbuf)
1157 return false;
1159 return sk->sk_prot->stream_memory_free ?
1160 sk->sk_prot->stream_memory_free(sk) : true;
1163 static inline bool sk_stream_is_writeable(const struct sock *sk)
1165 return sk_stream_wspace(sk) >= sk_stream_min_wspace(sk) &&
1166 sk_stream_memory_free(sk);
1169 static inline int sk_under_cgroup_hierarchy(struct sock *sk,
1170 struct cgroup *ancestor)
1172 #ifdef CONFIG_SOCK_CGROUP_DATA
1173 return cgroup_is_descendant(sock_cgroup_ptr(&sk->sk_cgrp_data),
1174 ancestor);
1175 #else
1176 return -ENOTSUPP;
1177 #endif
1180 static inline bool sk_has_memory_pressure(const struct sock *sk)
1182 return sk->sk_prot->memory_pressure != NULL;
1185 static inline bool sk_under_memory_pressure(const struct sock *sk)
1187 if (!sk->sk_prot->memory_pressure)
1188 return false;
1190 if (mem_cgroup_sockets_enabled && sk->sk_memcg &&
1191 mem_cgroup_under_socket_pressure(sk->sk_memcg))
1192 return true;
1194 return !!*sk->sk_prot->memory_pressure;
1197 static inline long
1198 sk_memory_allocated(const struct sock *sk)
1200 return atomic_long_read(sk->sk_prot->memory_allocated);
1203 static inline long
1204 sk_memory_allocated_add(struct sock *sk, int amt)
1206 return atomic_long_add_return(amt, sk->sk_prot->memory_allocated);
1209 static inline void
1210 sk_memory_allocated_sub(struct sock *sk, int amt)
1212 atomic_long_sub(amt, sk->sk_prot->memory_allocated);
1215 static inline void sk_sockets_allocated_dec(struct sock *sk)
1217 percpu_counter_dec(sk->sk_prot->sockets_allocated);
1220 static inline void sk_sockets_allocated_inc(struct sock *sk)
1222 percpu_counter_inc(sk->sk_prot->sockets_allocated);
1225 static inline int
1226 sk_sockets_allocated_read_positive(struct sock *sk)
1228 return percpu_counter_read_positive(sk->sk_prot->sockets_allocated);
1231 static inline int
1232 proto_sockets_allocated_sum_positive(struct proto *prot)
1234 return percpu_counter_sum_positive(prot->sockets_allocated);
1237 static inline long
1238 proto_memory_allocated(struct proto *prot)
1240 return atomic_long_read(prot->memory_allocated);
1243 static inline bool
1244 proto_memory_pressure(struct proto *prot)
1246 if (!prot->memory_pressure)
1247 return false;
1248 return !!*prot->memory_pressure;
1252 #ifdef CONFIG_PROC_FS
1253 /* Called with local bh disabled */
1254 void sock_prot_inuse_add(struct net *net, struct proto *prot, int inc);
1255 int sock_prot_inuse_get(struct net *net, struct proto *proto);
1256 #else
1257 static inline void sock_prot_inuse_add(struct net *net, struct proto *prot,
1258 int inc)
1261 #endif
1264 /* With per-bucket locks this operation is not-atomic, so that
1265 * this version is not worse.
1267 static inline int __sk_prot_rehash(struct sock *sk)
1269 sk->sk_prot->unhash(sk);
1270 return sk->sk_prot->hash(sk);
1273 /* About 10 seconds */
1274 #define SOCK_DESTROY_TIME (10*HZ)
1276 /* Sockets 0-1023 can't be bound to unless you are superuser */
1277 #define PROT_SOCK 1024
1279 #define SHUTDOWN_MASK 3
1280 #define RCV_SHUTDOWN 1
1281 #define SEND_SHUTDOWN 2
1283 #define SOCK_SNDBUF_LOCK 1
1284 #define SOCK_RCVBUF_LOCK 2
1285 #define SOCK_BINDADDR_LOCK 4
1286 #define SOCK_BINDPORT_LOCK 8
1288 struct socket_alloc {
1289 struct socket socket;
1290 struct inode vfs_inode;
1293 static inline struct socket *SOCKET_I(struct inode *inode)
1295 return &container_of(inode, struct socket_alloc, vfs_inode)->socket;
1298 static inline struct inode *SOCK_INODE(struct socket *socket)
1300 return &container_of(socket, struct socket_alloc, socket)->vfs_inode;
1304 * Functions for memory accounting
1306 int __sk_mem_raise_allocated(struct sock *sk, int size, int amt, int kind);
1307 int __sk_mem_schedule(struct sock *sk, int size, int kind);
1308 void __sk_mem_reduce_allocated(struct sock *sk, int amount);
1309 void __sk_mem_reclaim(struct sock *sk, int amount);
1311 /* We used to have PAGE_SIZE here, but systems with 64KB pages
1312 * do not necessarily have 16x time more memory than 4KB ones.
1314 #define SK_MEM_QUANTUM 4096
1315 #define SK_MEM_QUANTUM_SHIFT ilog2(SK_MEM_QUANTUM)
1316 #define SK_MEM_SEND 0
1317 #define SK_MEM_RECV 1
1319 /* sysctl_mem values are in pages, we convert them in SK_MEM_QUANTUM units */
1320 static inline long sk_prot_mem_limits(const struct sock *sk, int index)
1322 long val = sk->sk_prot->sysctl_mem[index];
1324 #if PAGE_SIZE > SK_MEM_QUANTUM
1325 val <<= PAGE_SHIFT - SK_MEM_QUANTUM_SHIFT;
1326 #elif PAGE_SIZE < SK_MEM_QUANTUM
1327 val >>= SK_MEM_QUANTUM_SHIFT - PAGE_SHIFT;
1328 #endif
1329 return val;
1332 static inline int sk_mem_pages(int amt)
1334 return (amt + SK_MEM_QUANTUM - 1) >> SK_MEM_QUANTUM_SHIFT;
1337 static inline bool sk_has_account(struct sock *sk)
1339 /* return true if protocol supports memory accounting */
1340 return !!sk->sk_prot->memory_allocated;
1343 static inline bool sk_wmem_schedule(struct sock *sk, int size)
1345 if (!sk_has_account(sk))
1346 return true;
1347 return size <= sk->sk_forward_alloc ||
1348 __sk_mem_schedule(sk, size, SK_MEM_SEND);
1351 static inline bool
1352 sk_rmem_schedule(struct sock *sk, struct sk_buff *skb, int size)
1354 if (!sk_has_account(sk))
1355 return true;
1356 return size<= sk->sk_forward_alloc ||
1357 __sk_mem_schedule(sk, size, SK_MEM_RECV) ||
1358 skb_pfmemalloc(skb);
1361 static inline void sk_mem_reclaim(struct sock *sk)
1363 if (!sk_has_account(sk))
1364 return;
1365 if (sk->sk_forward_alloc >= SK_MEM_QUANTUM)
1366 __sk_mem_reclaim(sk, sk->sk_forward_alloc);
1369 static inline void sk_mem_reclaim_partial(struct sock *sk)
1371 if (!sk_has_account(sk))
1372 return;
1373 if (sk->sk_forward_alloc > SK_MEM_QUANTUM)
1374 __sk_mem_reclaim(sk, sk->sk_forward_alloc - 1);
1377 static inline void sk_mem_charge(struct sock *sk, int size)
1379 if (!sk_has_account(sk))
1380 return;
1381 sk->sk_forward_alloc -= size;
1384 static inline void sk_mem_uncharge(struct sock *sk, int size)
1386 if (!sk_has_account(sk))
1387 return;
1388 sk->sk_forward_alloc += size;
1390 /* Avoid a possible overflow.
1391 * TCP send queues can make this happen, if sk_mem_reclaim()
1392 * is not called and more than 2 GBytes are released at once.
1394 * If we reach 2 MBytes, reclaim 1 MBytes right now, there is
1395 * no need to hold that much forward allocation anyway.
1397 if (unlikely(sk->sk_forward_alloc >= 1 << 21))
1398 __sk_mem_reclaim(sk, 1 << 20);
1401 static inline void sk_wmem_free_skb(struct sock *sk, struct sk_buff *skb)
1403 sock_set_flag(sk, SOCK_QUEUE_SHRUNK);
1404 sk->sk_wmem_queued -= skb->truesize;
1405 sk_mem_uncharge(sk, skb->truesize);
1406 __kfree_skb(skb);
1409 static inline void sock_release_ownership(struct sock *sk)
1411 if (sk->sk_lock.owned) {
1412 sk->sk_lock.owned = 0;
1414 /* The sk_lock has mutex_unlock() semantics: */
1415 mutex_release(&sk->sk_lock.dep_map, 1, _RET_IP_);
1420 * Macro so as to not evaluate some arguments when
1421 * lockdep is not enabled.
1423 * Mark both the sk_lock and the sk_lock.slock as a
1424 * per-address-family lock class.
1426 #define sock_lock_init_class_and_name(sk, sname, skey, name, key) \
1427 do { \
1428 sk->sk_lock.owned = 0; \
1429 init_waitqueue_head(&sk->sk_lock.wq); \
1430 spin_lock_init(&(sk)->sk_lock.slock); \
1431 debug_check_no_locks_freed((void *)&(sk)->sk_lock, \
1432 sizeof((sk)->sk_lock)); \
1433 lockdep_set_class_and_name(&(sk)->sk_lock.slock, \
1434 (skey), (sname)); \
1435 lockdep_init_map(&(sk)->sk_lock.dep_map, (name), (key), 0); \
1436 } while (0)
1438 #ifdef CONFIG_LOCKDEP
1439 static inline bool lockdep_sock_is_held(const struct sock *csk)
1441 struct sock *sk = (struct sock *)csk;
1443 return lockdep_is_held(&sk->sk_lock) ||
1444 lockdep_is_held(&sk->sk_lock.slock);
1446 #endif
1448 void lock_sock_nested(struct sock *sk, int subclass);
1450 static inline void lock_sock(struct sock *sk)
1452 lock_sock_nested(sk, 0);
1455 void release_sock(struct sock *sk);
1457 /* BH context may only use the following locking interface. */
1458 #define bh_lock_sock(__sk) spin_lock(&((__sk)->sk_lock.slock))
1459 #define bh_lock_sock_nested(__sk) \
1460 spin_lock_nested(&((__sk)->sk_lock.slock), \
1461 SINGLE_DEPTH_NESTING)
1462 #define bh_unlock_sock(__sk) spin_unlock(&((__sk)->sk_lock.slock))
1464 bool lock_sock_fast(struct sock *sk);
1466 * unlock_sock_fast - complement of lock_sock_fast
1467 * @sk: socket
1468 * @slow: slow mode
1470 * fast unlock socket for user context.
1471 * If slow mode is on, we call regular release_sock()
1473 static inline void unlock_sock_fast(struct sock *sk, bool slow)
1475 if (slow)
1476 release_sock(sk);
1477 else
1478 spin_unlock_bh(&sk->sk_lock.slock);
1481 /* Used by processes to "lock" a socket state, so that
1482 * interrupts and bottom half handlers won't change it
1483 * from under us. It essentially blocks any incoming
1484 * packets, so that we won't get any new data or any
1485 * packets that change the state of the socket.
1487 * While locked, BH processing will add new packets to
1488 * the backlog queue. This queue is processed by the
1489 * owner of the socket lock right before it is released.
1491 * Since ~2.3.5 it is also exclusive sleep lock serializing
1492 * accesses from user process context.
1495 static inline void sock_owned_by_me(const struct sock *sk)
1497 #ifdef CONFIG_LOCKDEP
1498 WARN_ON_ONCE(!lockdep_sock_is_held(sk) && debug_locks);
1499 #endif
1502 static inline bool sock_owned_by_user(const struct sock *sk)
1504 sock_owned_by_me(sk);
1505 return sk->sk_lock.owned;
1508 /* no reclassification while locks are held */
1509 static inline bool sock_allow_reclassification(const struct sock *csk)
1511 struct sock *sk = (struct sock *)csk;
1513 return !sk->sk_lock.owned && !spin_is_locked(&sk->sk_lock.slock);
1516 struct sock *sk_alloc(struct net *net, int family, gfp_t priority,
1517 struct proto *prot, int kern);
1518 void sk_free(struct sock *sk);
1519 void sk_destruct(struct sock *sk);
1520 struct sock *sk_clone_lock(const struct sock *sk, const gfp_t priority);
1521 void sk_free_unlock_clone(struct sock *sk);
1523 struct sk_buff *sock_wmalloc(struct sock *sk, unsigned long size, int force,
1524 gfp_t priority);
1525 void __sock_wfree(struct sk_buff *skb);
1526 void sock_wfree(struct sk_buff *skb);
1527 struct sk_buff *sock_omalloc(struct sock *sk, unsigned long size,
1528 gfp_t priority);
1529 void skb_orphan_partial(struct sk_buff *skb);
1530 void sock_rfree(struct sk_buff *skb);
1531 void sock_efree(struct sk_buff *skb);
1532 #ifdef CONFIG_INET
1533 void sock_edemux(struct sk_buff *skb);
1534 #else
1535 #define sock_edemux sock_efree
1536 #endif
1538 int sock_setsockopt(struct socket *sock, int level, int op,
1539 char __user *optval, unsigned int optlen);
1541 int sock_getsockopt(struct socket *sock, int level, int op,
1542 char __user *optval, int __user *optlen);
1543 struct sk_buff *sock_alloc_send_skb(struct sock *sk, unsigned long size,
1544 int noblock, int *errcode);
1545 struct sk_buff *sock_alloc_send_pskb(struct sock *sk, unsigned long header_len,
1546 unsigned long data_len, int noblock,
1547 int *errcode, int max_page_order);
1548 void *sock_kmalloc(struct sock *sk, int size, gfp_t priority);
1549 void sock_kfree_s(struct sock *sk, void *mem, int size);
1550 void sock_kzfree_s(struct sock *sk, void *mem, int size);
1551 void sk_send_sigurg(struct sock *sk);
1553 struct sockcm_cookie {
1554 u32 mark;
1555 u16 tsflags;
1558 int __sock_cmsg_send(struct sock *sk, struct msghdr *msg, struct cmsghdr *cmsg,
1559 struct sockcm_cookie *sockc);
1560 int sock_cmsg_send(struct sock *sk, struct msghdr *msg,
1561 struct sockcm_cookie *sockc);
1564 * Functions to fill in entries in struct proto_ops when a protocol
1565 * does not implement a particular function.
1567 int sock_no_bind(struct socket *, struct sockaddr *, int);
1568 int sock_no_connect(struct socket *, struct sockaddr *, int, int);
1569 int sock_no_socketpair(struct socket *, struct socket *);
1570 int sock_no_accept(struct socket *, struct socket *, int, bool);
1571 int sock_no_getname(struct socket *, struct sockaddr *, int *, int);
1572 unsigned int sock_no_poll(struct file *, struct socket *,
1573 struct poll_table_struct *);
1574 int sock_no_ioctl(struct socket *, unsigned int, unsigned long);
1575 int sock_no_listen(struct socket *, int);
1576 int sock_no_shutdown(struct socket *, int);
1577 int sock_no_getsockopt(struct socket *, int , int, char __user *, int __user *);
1578 int sock_no_setsockopt(struct socket *, int, int, char __user *, unsigned int);
1579 int sock_no_sendmsg(struct socket *, struct msghdr *, size_t);
1580 int sock_no_sendmsg_locked(struct sock *sk, struct msghdr *msg, size_t len);
1581 int sock_no_recvmsg(struct socket *, struct msghdr *, size_t, int);
1582 int sock_no_mmap(struct file *file, struct socket *sock,
1583 struct vm_area_struct *vma);
1584 ssize_t sock_no_sendpage(struct socket *sock, struct page *page, int offset,
1585 size_t size, int flags);
1586 ssize_t sock_no_sendpage_locked(struct sock *sk, struct page *page,
1587 int offset, size_t size, int flags);
1590 * Functions to fill in entries in struct proto_ops when a protocol
1591 * uses the inet style.
1593 int sock_common_getsockopt(struct socket *sock, int level, int optname,
1594 char __user *optval, int __user *optlen);
1595 int sock_common_recvmsg(struct socket *sock, struct msghdr *msg, size_t size,
1596 int flags);
1597 int sock_common_setsockopt(struct socket *sock, int level, int optname,
1598 char __user *optval, unsigned int optlen);
1599 int compat_sock_common_getsockopt(struct socket *sock, int level,
1600 int optname, char __user *optval, int __user *optlen);
1601 int compat_sock_common_setsockopt(struct socket *sock, int level,
1602 int optname, char __user *optval, unsigned int optlen);
1604 void sk_common_release(struct sock *sk);
1607 * Default socket callbacks and setup code
1610 /* Initialise core socket variables */
1611 void sock_init_data(struct socket *sock, struct sock *sk);
1614 * Socket reference counting postulates.
1616 * * Each user of socket SHOULD hold a reference count.
1617 * * Each access point to socket (an hash table bucket, reference from a list,
1618 * running timer, skb in flight MUST hold a reference count.
1619 * * When reference count hits 0, it means it will never increase back.
1620 * * When reference count hits 0, it means that no references from
1621 * outside exist to this socket and current process on current CPU
1622 * is last user and may/should destroy this socket.
1623 * * sk_free is called from any context: process, BH, IRQ. When
1624 * it is called, socket has no references from outside -> sk_free
1625 * may release descendant resources allocated by the socket, but
1626 * to the time when it is called, socket is NOT referenced by any
1627 * hash tables, lists etc.
1628 * * Packets, delivered from outside (from network or from another process)
1629 * and enqueued on receive/error queues SHOULD NOT grab reference count,
1630 * when they sit in queue. Otherwise, packets will leak to hole, when
1631 * socket is looked up by one cpu and unhasing is made by another CPU.
1632 * It is true for udp/raw, netlink (leak to receive and error queues), tcp
1633 * (leak to backlog). Packet socket does all the processing inside
1634 * BR_NETPROTO_LOCK, so that it has not this race condition. UNIX sockets
1635 * use separate SMP lock, so that they are prone too.
1638 /* Ungrab socket and destroy it, if it was the last reference. */
1639 static inline void sock_put(struct sock *sk)
1641 if (refcount_dec_and_test(&sk->sk_refcnt))
1642 sk_free(sk);
1644 /* Generic version of sock_put(), dealing with all sockets
1645 * (TCP_TIMEWAIT, TCP_NEW_SYN_RECV, ESTABLISHED...)
1647 void sock_gen_put(struct sock *sk);
1649 int __sk_receive_skb(struct sock *sk, struct sk_buff *skb, const int nested,
1650 unsigned int trim_cap, bool refcounted);
1651 static inline int sk_receive_skb(struct sock *sk, struct sk_buff *skb,
1652 const int nested)
1654 return __sk_receive_skb(sk, skb, nested, 1, true);
1657 static inline void sk_tx_queue_set(struct sock *sk, int tx_queue)
1659 sk->sk_tx_queue_mapping = tx_queue;
1662 static inline void sk_tx_queue_clear(struct sock *sk)
1664 sk->sk_tx_queue_mapping = -1;
1667 static inline int sk_tx_queue_get(const struct sock *sk)
1669 return sk ? sk->sk_tx_queue_mapping : -1;
1672 static inline void sk_set_socket(struct sock *sk, struct socket *sock)
1674 sk_tx_queue_clear(sk);
1675 sk->sk_socket = sock;
1678 static inline wait_queue_head_t *sk_sleep(struct sock *sk)
1680 BUILD_BUG_ON(offsetof(struct socket_wq, wait) != 0);
1681 return &rcu_dereference_raw(sk->sk_wq)->wait;
1683 /* Detach socket from process context.
1684 * Announce socket dead, detach it from wait queue and inode.
1685 * Note that parent inode held reference count on this struct sock,
1686 * we do not release it in this function, because protocol
1687 * probably wants some additional cleanups or even continuing
1688 * to work with this socket (TCP).
1690 static inline void sock_orphan(struct sock *sk)
1692 write_lock_bh(&sk->sk_callback_lock);
1693 sock_set_flag(sk, SOCK_DEAD);
1694 sk_set_socket(sk, NULL);
1695 sk->sk_wq = NULL;
1696 write_unlock_bh(&sk->sk_callback_lock);
1699 static inline void sock_graft(struct sock *sk, struct socket *parent)
1701 WARN_ON(parent->sk);
1702 write_lock_bh(&sk->sk_callback_lock);
1703 sk->sk_wq = parent->wq;
1704 parent->sk = sk;
1705 sk_set_socket(sk, parent);
1706 sk->sk_uid = SOCK_INODE(parent)->i_uid;
1707 security_sock_graft(sk, parent);
1708 write_unlock_bh(&sk->sk_callback_lock);
1711 kuid_t sock_i_uid(struct sock *sk);
1712 unsigned long sock_i_ino(struct sock *sk);
1714 static inline kuid_t sock_net_uid(const struct net *net, const struct sock *sk)
1716 return sk ? sk->sk_uid : make_kuid(net->user_ns, 0);
1719 static inline u32 net_tx_rndhash(void)
1721 u32 v = prandom_u32();
1723 return v ?: 1;
1726 static inline void sk_set_txhash(struct sock *sk)
1728 sk->sk_txhash = net_tx_rndhash();
1731 static inline void sk_rethink_txhash(struct sock *sk)
1733 if (sk->sk_txhash)
1734 sk_set_txhash(sk);
1737 static inline struct dst_entry *
1738 __sk_dst_get(struct sock *sk)
1740 return rcu_dereference_check(sk->sk_dst_cache,
1741 lockdep_sock_is_held(sk));
1744 static inline struct dst_entry *
1745 sk_dst_get(struct sock *sk)
1747 struct dst_entry *dst;
1749 rcu_read_lock();
1750 dst = rcu_dereference(sk->sk_dst_cache);
1751 if (dst && !atomic_inc_not_zero(&dst->__refcnt))
1752 dst = NULL;
1753 rcu_read_unlock();
1754 return dst;
1757 static inline void dst_negative_advice(struct sock *sk)
1759 struct dst_entry *ndst, *dst = __sk_dst_get(sk);
1761 sk_rethink_txhash(sk);
1763 if (dst && dst->ops->negative_advice) {
1764 ndst = dst->ops->negative_advice(dst);
1766 if (ndst != dst) {
1767 rcu_assign_pointer(sk->sk_dst_cache, ndst);
1768 sk_tx_queue_clear(sk);
1769 sk->sk_dst_pending_confirm = 0;
1774 static inline void
1775 __sk_dst_set(struct sock *sk, struct dst_entry *dst)
1777 struct dst_entry *old_dst;
1779 sk_tx_queue_clear(sk);
1780 sk->sk_dst_pending_confirm = 0;
1781 old_dst = rcu_dereference_protected(sk->sk_dst_cache,
1782 lockdep_sock_is_held(sk));
1783 rcu_assign_pointer(sk->sk_dst_cache, dst);
1784 dst_release(old_dst);
1787 static inline void
1788 sk_dst_set(struct sock *sk, struct dst_entry *dst)
1790 struct dst_entry *old_dst;
1792 sk_tx_queue_clear(sk);
1793 sk->sk_dst_pending_confirm = 0;
1794 old_dst = xchg((__force struct dst_entry **)&sk->sk_dst_cache, dst);
1795 dst_release(old_dst);
1798 static inline void
1799 __sk_dst_reset(struct sock *sk)
1801 __sk_dst_set(sk, NULL);
1804 static inline void
1805 sk_dst_reset(struct sock *sk)
1807 sk_dst_set(sk, NULL);
1810 struct dst_entry *__sk_dst_check(struct sock *sk, u32 cookie);
1812 struct dst_entry *sk_dst_check(struct sock *sk, u32 cookie);
1814 static inline void sk_dst_confirm(struct sock *sk)
1816 if (!sk->sk_dst_pending_confirm)
1817 sk->sk_dst_pending_confirm = 1;
1820 static inline void sock_confirm_neigh(struct sk_buff *skb, struct neighbour *n)
1822 if (skb_get_dst_pending_confirm(skb)) {
1823 struct sock *sk = skb->sk;
1824 unsigned long now = jiffies;
1826 /* avoid dirtying neighbour */
1827 if (n->confirmed != now)
1828 n->confirmed = now;
1829 if (sk && sk->sk_dst_pending_confirm)
1830 sk->sk_dst_pending_confirm = 0;
1834 bool sk_mc_loop(struct sock *sk);
1836 static inline bool sk_can_gso(const struct sock *sk)
1838 return net_gso_ok(sk->sk_route_caps, sk->sk_gso_type);
1841 void sk_setup_caps(struct sock *sk, struct dst_entry *dst);
1843 static inline void sk_nocaps_add(struct sock *sk, netdev_features_t flags)
1845 sk->sk_route_nocaps |= flags;
1846 sk->sk_route_caps &= ~flags;
1849 static inline bool sk_check_csum_caps(struct sock *sk)
1851 return (sk->sk_route_caps & NETIF_F_HW_CSUM) ||
1852 (sk->sk_family == PF_INET &&
1853 (sk->sk_route_caps & NETIF_F_IP_CSUM)) ||
1854 (sk->sk_family == PF_INET6 &&
1855 (sk->sk_route_caps & NETIF_F_IPV6_CSUM));
1858 static inline int skb_do_copy_data_nocache(struct sock *sk, struct sk_buff *skb,
1859 struct iov_iter *from, char *to,
1860 int copy, int offset)
1862 if (skb->ip_summed == CHECKSUM_NONE) {
1863 __wsum csum = 0;
1864 if (!csum_and_copy_from_iter_full(to, copy, &csum, from))
1865 return -EFAULT;
1866 skb->csum = csum_block_add(skb->csum, csum, offset);
1867 } else if (sk->sk_route_caps & NETIF_F_NOCACHE_COPY) {
1868 if (!copy_from_iter_full_nocache(to, copy, from))
1869 return -EFAULT;
1870 } else if (!copy_from_iter_full(to, copy, from))
1871 return -EFAULT;
1873 return 0;
1876 static inline int skb_add_data_nocache(struct sock *sk, struct sk_buff *skb,
1877 struct iov_iter *from, int copy)
1879 int err, offset = skb->len;
1881 err = skb_do_copy_data_nocache(sk, skb, from, skb_put(skb, copy),
1882 copy, offset);
1883 if (err)
1884 __skb_trim(skb, offset);
1886 return err;
1889 static inline int skb_copy_to_page_nocache(struct sock *sk, struct iov_iter *from,
1890 struct sk_buff *skb,
1891 struct page *page,
1892 int off, int copy)
1894 int err;
1896 err = skb_do_copy_data_nocache(sk, skb, from, page_address(page) + off,
1897 copy, skb->len);
1898 if (err)
1899 return err;
1901 skb->len += copy;
1902 skb->data_len += copy;
1903 skb->truesize += copy;
1904 sk->sk_wmem_queued += copy;
1905 sk_mem_charge(sk, copy);
1906 return 0;
1910 * sk_wmem_alloc_get - returns write allocations
1911 * @sk: socket
1913 * Returns sk_wmem_alloc minus initial offset of one
1915 static inline int sk_wmem_alloc_get(const struct sock *sk)
1917 return refcount_read(&sk->sk_wmem_alloc) - 1;
1921 * sk_rmem_alloc_get - returns read allocations
1922 * @sk: socket
1924 * Returns sk_rmem_alloc
1926 static inline int sk_rmem_alloc_get(const struct sock *sk)
1928 return atomic_read(&sk->sk_rmem_alloc);
1932 * sk_has_allocations - check if allocations are outstanding
1933 * @sk: socket
1935 * Returns true if socket has write or read allocations
1937 static inline bool sk_has_allocations(const struct sock *sk)
1939 return sk_wmem_alloc_get(sk) || sk_rmem_alloc_get(sk);
1943 * skwq_has_sleeper - check if there are any waiting processes
1944 * @wq: struct socket_wq
1946 * Returns true if socket_wq has waiting processes
1948 * The purpose of the skwq_has_sleeper and sock_poll_wait is to wrap the memory
1949 * barrier call. They were added due to the race found within the tcp code.
1951 * Consider following tcp code paths::
1953 * CPU1 CPU2
1954 * sys_select receive packet
1955 * ... ...
1956 * __add_wait_queue update tp->rcv_nxt
1957 * ... ...
1958 * tp->rcv_nxt check sock_def_readable
1959 * ... {
1960 * schedule rcu_read_lock();
1961 * wq = rcu_dereference(sk->sk_wq);
1962 * if (wq && waitqueue_active(&wq->wait))
1963 * wake_up_interruptible(&wq->wait)
1964 * ...
1967 * The race for tcp fires when the __add_wait_queue changes done by CPU1 stay
1968 * in its cache, and so does the tp->rcv_nxt update on CPU2 side. The CPU1
1969 * could then endup calling schedule and sleep forever if there are no more
1970 * data on the socket.
1973 static inline bool skwq_has_sleeper(struct socket_wq *wq)
1975 return wq && wq_has_sleeper(&wq->wait);
1979 * sock_poll_wait - place memory barrier behind the poll_wait call.
1980 * @filp: file
1981 * @wait_address: socket wait queue
1982 * @p: poll_table
1984 * See the comments in the wq_has_sleeper function.
1986 static inline void sock_poll_wait(struct file *filp,
1987 wait_queue_head_t *wait_address, poll_table *p)
1989 if (!poll_does_not_wait(p) && wait_address) {
1990 poll_wait(filp, wait_address, p);
1991 /* We need to be sure we are in sync with the
1992 * socket flags modification.
1994 * This memory barrier is paired in the wq_has_sleeper.
1996 smp_mb();
2000 static inline void skb_set_hash_from_sk(struct sk_buff *skb, struct sock *sk)
2002 if (sk->sk_txhash) {
2003 skb->l4_hash = 1;
2004 skb->hash = sk->sk_txhash;
2008 void skb_set_owner_w(struct sk_buff *skb, struct sock *sk);
2011 * Queue a received datagram if it will fit. Stream and sequenced
2012 * protocols can't normally use this as they need to fit buffers in
2013 * and play with them.
2015 * Inlined as it's very short and called for pretty much every
2016 * packet ever received.
2018 static inline void skb_set_owner_r(struct sk_buff *skb, struct sock *sk)
2020 skb_orphan(skb);
2021 skb->sk = sk;
2022 skb->destructor = sock_rfree;
2023 atomic_add(skb->truesize, &sk->sk_rmem_alloc);
2024 sk_mem_charge(sk, skb->truesize);
2027 void sk_reset_timer(struct sock *sk, struct timer_list *timer,
2028 unsigned long expires);
2030 void sk_stop_timer(struct sock *sk, struct timer_list *timer);
2032 int __sk_queue_drop_skb(struct sock *sk, struct sk_buff_head *sk_queue,
2033 struct sk_buff *skb, unsigned int flags,
2034 void (*destructor)(struct sock *sk,
2035 struct sk_buff *skb));
2036 int __sock_queue_rcv_skb(struct sock *sk, struct sk_buff *skb);
2037 int sock_queue_rcv_skb(struct sock *sk, struct sk_buff *skb);
2039 int sock_queue_err_skb(struct sock *sk, struct sk_buff *skb);
2040 struct sk_buff *sock_dequeue_err_skb(struct sock *sk);
2043 * Recover an error report and clear atomically
2046 static inline int sock_error(struct sock *sk)
2048 int err;
2049 if (likely(!sk->sk_err))
2050 return 0;
2051 err = xchg(&sk->sk_err, 0);
2052 return -err;
2055 static inline unsigned long sock_wspace(struct sock *sk)
2057 int amt = 0;
2059 if (!(sk->sk_shutdown & SEND_SHUTDOWN)) {
2060 amt = sk->sk_sndbuf - refcount_read(&sk->sk_wmem_alloc);
2061 if (amt < 0)
2062 amt = 0;
2064 return amt;
2067 /* Note:
2068 * We use sk->sk_wq_raw, from contexts knowing this
2069 * pointer is not NULL and cannot disappear/change.
2071 static inline void sk_set_bit(int nr, struct sock *sk)
2073 if ((nr == SOCKWQ_ASYNC_NOSPACE || nr == SOCKWQ_ASYNC_WAITDATA) &&
2074 !sock_flag(sk, SOCK_FASYNC))
2075 return;
2077 set_bit(nr, &sk->sk_wq_raw->flags);
2080 static inline void sk_clear_bit(int nr, struct sock *sk)
2082 if ((nr == SOCKWQ_ASYNC_NOSPACE || nr == SOCKWQ_ASYNC_WAITDATA) &&
2083 !sock_flag(sk, SOCK_FASYNC))
2084 return;
2086 clear_bit(nr, &sk->sk_wq_raw->flags);
2089 static inline void sk_wake_async(const struct sock *sk, int how, int band)
2091 if (sock_flag(sk, SOCK_FASYNC)) {
2092 rcu_read_lock();
2093 sock_wake_async(rcu_dereference(sk->sk_wq), how, band);
2094 rcu_read_unlock();
2098 /* Since sk_{r,w}mem_alloc sums skb->truesize, even a small frame might
2099 * need sizeof(sk_buff) + MTU + padding, unless net driver perform copybreak.
2100 * Note: for send buffers, TCP works better if we can build two skbs at
2101 * minimum.
2103 #define TCP_SKB_MIN_TRUESIZE (2048 + SKB_DATA_ALIGN(sizeof(struct sk_buff)))
2105 #define SOCK_MIN_SNDBUF (TCP_SKB_MIN_TRUESIZE * 2)
2106 #define SOCK_MIN_RCVBUF TCP_SKB_MIN_TRUESIZE
2108 static inline void sk_stream_moderate_sndbuf(struct sock *sk)
2110 if (!(sk->sk_userlocks & SOCK_SNDBUF_LOCK)) {
2111 sk->sk_sndbuf = min(sk->sk_sndbuf, sk->sk_wmem_queued >> 1);
2112 sk->sk_sndbuf = max_t(u32, sk->sk_sndbuf, SOCK_MIN_SNDBUF);
2116 struct sk_buff *sk_stream_alloc_skb(struct sock *sk, int size, gfp_t gfp,
2117 bool force_schedule);
2120 * sk_page_frag - return an appropriate page_frag
2121 * @sk: socket
2123 * If socket allocation mode allows current thread to sleep, it means its
2124 * safe to use the per task page_frag instead of the per socket one.
2126 static inline struct page_frag *sk_page_frag(struct sock *sk)
2128 if (gfpflags_allow_blocking(sk->sk_allocation))
2129 return &current->task_frag;
2131 return &sk->sk_frag;
2134 bool sk_page_frag_refill(struct sock *sk, struct page_frag *pfrag);
2137 * Default write policy as shown to user space via poll/select/SIGIO
2139 static inline bool sock_writeable(const struct sock *sk)
2141 return refcount_read(&sk->sk_wmem_alloc) < (sk->sk_sndbuf >> 1);
2144 static inline gfp_t gfp_any(void)
2146 return in_softirq() ? GFP_ATOMIC : GFP_KERNEL;
2149 static inline long sock_rcvtimeo(const struct sock *sk, bool noblock)
2151 return noblock ? 0 : sk->sk_rcvtimeo;
2154 static inline long sock_sndtimeo(const struct sock *sk, bool noblock)
2156 return noblock ? 0 : sk->sk_sndtimeo;
2159 static inline int sock_rcvlowat(const struct sock *sk, int waitall, int len)
2161 return (waitall ? len : min_t(int, sk->sk_rcvlowat, len)) ? : 1;
2164 /* Alas, with timeout socket operations are not restartable.
2165 * Compare this to poll().
2167 static inline int sock_intr_errno(long timeo)
2169 return timeo == MAX_SCHEDULE_TIMEOUT ? -ERESTARTSYS : -EINTR;
2172 struct sock_skb_cb {
2173 u32 dropcount;
2176 /* Store sock_skb_cb at the end of skb->cb[] so protocol families
2177 * using skb->cb[] would keep using it directly and utilize its
2178 * alignement guarantee.
2180 #define SOCK_SKB_CB_OFFSET ((FIELD_SIZEOF(struct sk_buff, cb) - \
2181 sizeof(struct sock_skb_cb)))
2183 #define SOCK_SKB_CB(__skb) ((struct sock_skb_cb *)((__skb)->cb + \
2184 SOCK_SKB_CB_OFFSET))
2186 #define sock_skb_cb_check_size(size) \
2187 BUILD_BUG_ON((size) > SOCK_SKB_CB_OFFSET)
2189 static inline void
2190 sock_skb_set_dropcount(const struct sock *sk, struct sk_buff *skb)
2192 SOCK_SKB_CB(skb)->dropcount = sock_flag(sk, SOCK_RXQ_OVFL) ?
2193 atomic_read(&sk->sk_drops) : 0;
2196 static inline void sk_drops_add(struct sock *sk, const struct sk_buff *skb)
2198 int segs = max_t(u16, 1, skb_shinfo(skb)->gso_segs);
2200 atomic_add(segs, &sk->sk_drops);
2203 void __sock_recv_timestamp(struct msghdr *msg, struct sock *sk,
2204 struct sk_buff *skb);
2205 void __sock_recv_wifi_status(struct msghdr *msg, struct sock *sk,
2206 struct sk_buff *skb);
2208 static inline void
2209 sock_recv_timestamp(struct msghdr *msg, struct sock *sk, struct sk_buff *skb)
2211 ktime_t kt = skb->tstamp;
2212 struct skb_shared_hwtstamps *hwtstamps = skb_hwtstamps(skb);
2215 * generate control messages if
2216 * - receive time stamping in software requested
2217 * - software time stamp available and wanted
2218 * - hardware time stamps available and wanted
2220 if (sock_flag(sk, SOCK_RCVTSTAMP) ||
2221 (sk->sk_tsflags & SOF_TIMESTAMPING_RX_SOFTWARE) ||
2222 (kt && sk->sk_tsflags & SOF_TIMESTAMPING_SOFTWARE) ||
2223 (hwtstamps->hwtstamp &&
2224 (sk->sk_tsflags & SOF_TIMESTAMPING_RAW_HARDWARE)))
2225 __sock_recv_timestamp(msg, sk, skb);
2226 else
2227 sk->sk_stamp = kt;
2229 if (sock_flag(sk, SOCK_WIFI_STATUS) && skb->wifi_acked_valid)
2230 __sock_recv_wifi_status(msg, sk, skb);
2233 void __sock_recv_ts_and_drops(struct msghdr *msg, struct sock *sk,
2234 struct sk_buff *skb);
2236 #define SK_DEFAULT_STAMP (-1L * NSEC_PER_SEC)
2237 static inline void sock_recv_ts_and_drops(struct msghdr *msg, struct sock *sk,
2238 struct sk_buff *skb)
2240 #define FLAGS_TS_OR_DROPS ((1UL << SOCK_RXQ_OVFL) | \
2241 (1UL << SOCK_RCVTSTAMP))
2242 #define TSFLAGS_ANY (SOF_TIMESTAMPING_SOFTWARE | \
2243 SOF_TIMESTAMPING_RAW_HARDWARE)
2245 if (sk->sk_flags & FLAGS_TS_OR_DROPS || sk->sk_tsflags & TSFLAGS_ANY)
2246 __sock_recv_ts_and_drops(msg, sk, skb);
2247 else if (unlikely(sock_flag(sk, SOCK_TIMESTAMP)))
2248 sk->sk_stamp = skb->tstamp;
2249 else if (unlikely(sk->sk_stamp == SK_DEFAULT_STAMP))
2250 sk->sk_stamp = 0;
2253 void __sock_tx_timestamp(__u16 tsflags, __u8 *tx_flags);
2256 * sock_tx_timestamp - checks whether the outgoing packet is to be time stamped
2257 * @sk: socket sending this packet
2258 * @tsflags: timestamping flags to use
2259 * @tx_flags: completed with instructions for time stamping
2261 * Note: callers should take care of initial ``*tx_flags`` value (usually 0)
2263 static inline void sock_tx_timestamp(const struct sock *sk, __u16 tsflags,
2264 __u8 *tx_flags)
2266 if (unlikely(tsflags))
2267 __sock_tx_timestamp(tsflags, tx_flags);
2268 if (unlikely(sock_flag(sk, SOCK_WIFI_STATUS)))
2269 *tx_flags |= SKBTX_WIFI_STATUS;
2273 * sk_eat_skb - Release a skb if it is no longer needed
2274 * @sk: socket to eat this skb from
2275 * @skb: socket buffer to eat
2277 * This routine must be called with interrupts disabled or with the socket
2278 * locked so that the sk_buff queue operation is ok.
2280 static inline void sk_eat_skb(struct sock *sk, struct sk_buff *skb)
2282 __skb_unlink(skb, &sk->sk_receive_queue);
2283 __kfree_skb(skb);
2286 static inline
2287 struct net *sock_net(const struct sock *sk)
2289 return read_pnet(&sk->sk_net);
2292 static inline
2293 void sock_net_set(struct sock *sk, struct net *net)
2295 write_pnet(&sk->sk_net, net);
2298 static inline struct sock *skb_steal_sock(struct sk_buff *skb)
2300 if (skb->sk) {
2301 struct sock *sk = skb->sk;
2303 skb->destructor = NULL;
2304 skb->sk = NULL;
2305 return sk;
2307 return NULL;
2310 /* This helper checks if a socket is a full socket,
2311 * ie _not_ a timewait or request socket.
2313 static inline bool sk_fullsock(const struct sock *sk)
2315 return (1 << sk->sk_state) & ~(TCPF_TIME_WAIT | TCPF_NEW_SYN_RECV);
2318 /* This helper checks if a socket is a LISTEN or NEW_SYN_RECV
2319 * SYNACK messages can be attached to either ones (depending on SYNCOOKIE)
2321 static inline bool sk_listener(const struct sock *sk)
2323 return (1 << sk->sk_state) & (TCPF_LISTEN | TCPF_NEW_SYN_RECV);
2327 * sk_state_load - read sk->sk_state for lockless contexts
2328 * @sk: socket pointer
2330 * Paired with sk_state_store(). Used in places we do not hold socket lock :
2331 * tcp_diag_get_info(), tcp_get_info(), tcp_poll(), get_tcp4_sock() ...
2333 static inline int sk_state_load(const struct sock *sk)
2335 return smp_load_acquire(&sk->sk_state);
2339 * sk_state_store - update sk->sk_state
2340 * @sk: socket pointer
2341 * @newstate: new state
2343 * Paired with sk_state_load(). Should be used in contexts where
2344 * state change might impact lockless readers.
2346 static inline void sk_state_store(struct sock *sk, int newstate)
2348 smp_store_release(&sk->sk_state, newstate);
2351 void sock_enable_timestamp(struct sock *sk, int flag);
2352 int sock_get_timestamp(struct sock *, struct timeval __user *);
2353 int sock_get_timestampns(struct sock *, struct timespec __user *);
2354 int sock_recv_errqueue(struct sock *sk, struct msghdr *msg, int len, int level,
2355 int type);
2357 bool sk_ns_capable(const struct sock *sk,
2358 struct user_namespace *user_ns, int cap);
2359 bool sk_capable(const struct sock *sk, int cap);
2360 bool sk_net_capable(const struct sock *sk, int cap);
2362 void sk_get_meminfo(const struct sock *sk, u32 *meminfo);
2364 /* Take into consideration the size of the struct sk_buff overhead in the
2365 * determination of these values, since that is non-constant across
2366 * platforms. This makes socket queueing behavior and performance
2367 * not depend upon such differences.
2369 #define _SK_MEM_PACKETS 256
2370 #define _SK_MEM_OVERHEAD SKB_TRUESIZE(256)
2371 #define SK_WMEM_MAX (_SK_MEM_OVERHEAD * _SK_MEM_PACKETS)
2372 #define SK_RMEM_MAX (_SK_MEM_OVERHEAD * _SK_MEM_PACKETS)
2374 extern __u32 sysctl_wmem_max;
2375 extern __u32 sysctl_rmem_max;
2377 extern int sysctl_tstamp_allow_data;
2378 extern int sysctl_optmem_max;
2380 extern __u32 sysctl_wmem_default;
2381 extern __u32 sysctl_rmem_default;
2383 #endif /* _SOCK_H */