tcp: deny tcp_disconnect() when threads are waiting
[platform/kernel/linux-starfive.git] / include / net / sock.h
1 /* SPDX-License-Identifier: GPL-2.0-or-later */
2 /*
3  * INET         An implementation of the TCP/IP protocol suite for the LINUX
4  *              operating system.  INET is implemented using the  BSD Socket
5  *              interface as the means of communication with the user level.
6  *
7  *              Definitions for the AF_INET socket handler.
8  *
9  * Version:     @(#)sock.h      1.0.4   05/13/93
10  *
11  * Authors:     Ross Biro
12  *              Fred N. van Kempen, <waltje@uWalt.NL.Mugnet.ORG>
13  *              Corey Minyard <wf-rch!minyard@relay.EU.net>
14  *              Florian La Roche <flla@stud.uni-sb.de>
15  *
16  * Fixes:
17  *              Alan Cox        :       Volatiles in skbuff pointers. See
18  *                                      skbuff comments. May be overdone,
19  *                                      better to prove they can be removed
20  *                                      than the reverse.
21  *              Alan Cox        :       Added a zapped field for tcp to note
22  *                                      a socket is reset and must stay shut up
23  *              Alan Cox        :       New fields for options
24  *      Pauline Middelink       :       identd support
25  *              Alan Cox        :       Eliminate low level recv/recvfrom
26  *              David S. Miller :       New socket lookup architecture.
27  *              Steve Whitehouse:       Default routines for sock_ops
28  *              Arnaldo C. Melo :       removed net_pinfo, tp_pinfo and made
29  *                                      protinfo be just a void pointer, as the
30  *                                      protocol specific parts were moved to
31  *                                      respective headers and ipv4/v6, etc now
32  *                                      use private slabcaches for its socks
33  *              Pedro Hortas    :       New flags field for socket options
34  */
35 #ifndef _SOCK_H
36 #define _SOCK_H
37
38 #include <linux/hardirq.h>
39 #include <linux/kernel.h>
40 #include <linux/list.h>
41 #include <linux/list_nulls.h>
42 #include <linux/timer.h>
43 #include <linux/cache.h>
44 #include <linux/bitops.h>
45 #include <linux/lockdep.h>
46 #include <linux/netdevice.h>
47 #include <linux/skbuff.h>       /* struct sk_buff */
48 #include <linux/mm.h>
49 #include <linux/security.h>
50 #include <linux/slab.h>
51 #include <linux/uaccess.h>
52 #include <linux/page_counter.h>
53 #include <linux/memcontrol.h>
54 #include <linux/static_key.h>
55 #include <linux/sched.h>
56 #include <linux/wait.h>
57 #include <linux/cgroup-defs.h>
58 #include <linux/rbtree.h>
59 #include <linux/rculist_nulls.h>
60 #include <linux/poll.h>
61 #include <linux/sockptr.h>
62 #include <linux/indirect_call_wrapper.h>
63 #include <linux/atomic.h>
64 #include <linux/refcount.h>
65 #include <linux/llist.h>
66 #include <net/dst.h>
67 #include <net/checksum.h>
68 #include <net/tcp_states.h>
69 #include <linux/net_tstamp.h>
70 #include <net/l3mdev.h>
71 #include <uapi/linux/socket.h>
72
73 /*
74  * This structure really needs to be cleaned up.
75  * Most of it is for TCP, and not used by any of
76  * the other protocols.
77  */
78
79 /* Define this to get the SOCK_DBG debugging facility. */
80 #define SOCK_DEBUGGING
81 #ifdef SOCK_DEBUGGING
82 #define SOCK_DEBUG(sk, msg...) do { if ((sk) && sock_flag((sk), SOCK_DBG)) \
83                                         printk(KERN_DEBUG msg); } while (0)
84 #else
85 /* Validate arguments and do nothing */
86 static inline __printf(2, 3)
87 void SOCK_DEBUG(const struct sock *sk, const char *msg, ...)
88 {
89 }
90 #endif
91
92 /* This is the per-socket lock.  The spinlock provides a synchronization
93  * between user contexts and software interrupt processing, whereas the
94  * mini-semaphore synchronizes multiple users amongst themselves.
95  */
96 typedef struct {
97         spinlock_t              slock;
98         int                     owned;
99         wait_queue_head_t       wq;
100         /*
101          * We express the mutex-alike socket_lock semantics
102          * to the lock validator by explicitly managing
103          * the slock as a lock variant (in addition to
104          * the slock itself):
105          */
106 #ifdef CONFIG_DEBUG_LOCK_ALLOC
107         struct lockdep_map dep_map;
108 #endif
109 } socket_lock_t;
110
111 struct sock;
112 struct proto;
113 struct net;
114
115 typedef __u32 __bitwise __portpair;
116 typedef __u64 __bitwise __addrpair;
117
118 /**
119  *      struct sock_common - minimal network layer representation of sockets
120  *      @skc_daddr: Foreign IPv4 addr
121  *      @skc_rcv_saddr: Bound local IPv4 addr
122  *      @skc_addrpair: 8-byte-aligned __u64 union of @skc_daddr & @skc_rcv_saddr
123  *      @skc_hash: hash value used with various protocol lookup tables
124  *      @skc_u16hashes: two u16 hash values used by UDP lookup tables
125  *      @skc_dport: placeholder for inet_dport/tw_dport
126  *      @skc_num: placeholder for inet_num/tw_num
127  *      @skc_portpair: __u32 union of @skc_dport & @skc_num
128  *      @skc_family: network address family
129  *      @skc_state: Connection state
130  *      @skc_reuse: %SO_REUSEADDR setting
131  *      @skc_reuseport: %SO_REUSEPORT setting
132  *      @skc_ipv6only: socket is IPV6 only
133  *      @skc_net_refcnt: socket is using net ref counting
134  *      @skc_bound_dev_if: bound device index if != 0
135  *      @skc_bind_node: bind hash linkage for various protocol lookup tables
136  *      @skc_portaddr_node: second hash linkage for UDP/UDP-Lite protocol
137  *      @skc_prot: protocol handlers inside a network family
138  *      @skc_net: reference to the network namespace of this socket
139  *      @skc_v6_daddr: IPV6 destination address
140  *      @skc_v6_rcv_saddr: IPV6 source address
141  *      @skc_cookie: socket's cookie value
142  *      @skc_node: main hash linkage for various protocol lookup tables
143  *      @skc_nulls_node: main hash linkage for TCP/UDP/UDP-Lite protocol
144  *      @skc_tx_queue_mapping: tx queue number for this connection
145  *      @skc_rx_queue_mapping: rx queue number for this connection
146  *      @skc_flags: place holder for sk_flags
147  *              %SO_LINGER (l_onoff), %SO_BROADCAST, %SO_KEEPALIVE,
148  *              %SO_OOBINLINE settings, %SO_TIMESTAMPING settings
149  *      @skc_listener: connection request listener socket (aka rsk_listener)
150  *              [union with @skc_flags]
151  *      @skc_tw_dr: (aka tw_dr) ptr to &struct inet_timewait_death_row
152  *              [union with @skc_flags]
153  *      @skc_incoming_cpu: record/match cpu processing incoming packets
154  *      @skc_rcv_wnd: (aka rsk_rcv_wnd) TCP receive window size (possibly scaled)
155  *              [union with @skc_incoming_cpu]
156  *      @skc_tw_rcv_nxt: (aka tw_rcv_nxt) TCP window next expected seq number
157  *              [union with @skc_incoming_cpu]
158  *      @skc_refcnt: reference count
159  *
160  *      This is the minimal network layer representation of sockets, the header
161  *      for struct sock and struct inet_timewait_sock.
162  */
163 struct sock_common {
164         union {
165                 __addrpair      skc_addrpair;
166                 struct {
167                         __be32  skc_daddr;
168                         __be32  skc_rcv_saddr;
169                 };
170         };
171         union  {
172                 unsigned int    skc_hash;
173                 __u16           skc_u16hashes[2];
174         };
175         /* skc_dport && skc_num must be grouped as well */
176         union {
177                 __portpair      skc_portpair;
178                 struct {
179                         __be16  skc_dport;
180                         __u16   skc_num;
181                 };
182         };
183
184         unsigned short          skc_family;
185         volatile unsigned char  skc_state;
186         unsigned char           skc_reuse:4;
187         unsigned char           skc_reuseport:1;
188         unsigned char           skc_ipv6only:1;
189         unsigned char           skc_net_refcnt:1;
190         int                     skc_bound_dev_if;
191         union {
192                 struct hlist_node       skc_bind_node;
193                 struct hlist_node       skc_portaddr_node;
194         };
195         struct proto            *skc_prot;
196         possible_net_t          skc_net;
197
198 #if IS_ENABLED(CONFIG_IPV6)
199         struct in6_addr         skc_v6_daddr;
200         struct in6_addr         skc_v6_rcv_saddr;
201 #endif
202
203         atomic64_t              skc_cookie;
204
205         /* following fields are padding to force
206          * offset(struct sock, sk_refcnt) == 128 on 64bit arches
207          * assuming IPV6 is enabled. We use this padding differently
208          * for different kind of 'sockets'
209          */
210         union {
211                 unsigned long   skc_flags;
212                 struct sock     *skc_listener; /* request_sock */
213                 struct inet_timewait_death_row *skc_tw_dr; /* inet_timewait_sock */
214         };
215         /*
216          * fields between dontcopy_begin/dontcopy_end
217          * are not copied in sock_copy()
218          */
219         /* private: */
220         int                     skc_dontcopy_begin[0];
221         /* public: */
222         union {
223                 struct hlist_node       skc_node;
224                 struct hlist_nulls_node skc_nulls_node;
225         };
226         unsigned short          skc_tx_queue_mapping;
227 #ifdef CONFIG_SOCK_RX_QUEUE_MAPPING
228         unsigned short          skc_rx_queue_mapping;
229 #endif
230         union {
231                 int             skc_incoming_cpu;
232                 u32             skc_rcv_wnd;
233                 u32             skc_tw_rcv_nxt; /* struct tcp_timewait_sock  */
234         };
235
236         refcount_t              skc_refcnt;
237         /* private: */
238         int                     skc_dontcopy_end[0];
239         union {
240                 u32             skc_rxhash;
241                 u32             skc_window_clamp;
242                 u32             skc_tw_snd_nxt; /* struct tcp_timewait_sock */
243         };
244         /* public: */
245 };
246
247 struct bpf_local_storage;
248 struct sk_filter;
249
250 /**
251   *     struct sock - network layer representation of sockets
252   *     @__sk_common: shared layout with inet_timewait_sock
253   *     @sk_shutdown: mask of %SEND_SHUTDOWN and/or %RCV_SHUTDOWN
254   *     @sk_userlocks: %SO_SNDBUF and %SO_RCVBUF settings
255   *     @sk_lock:       synchronizer
256   *     @sk_kern_sock: True if sock is using kernel lock classes
257   *     @sk_rcvbuf: size of receive buffer in bytes
258   *     @sk_wq: sock wait queue and async head
259   *     @sk_rx_dst: receive input route used by early demux
260   *     @sk_rx_dst_ifindex: ifindex for @sk_rx_dst
261   *     @sk_rx_dst_cookie: cookie for @sk_rx_dst
262   *     @sk_dst_cache: destination cache
263   *     @sk_dst_pending_confirm: need to confirm neighbour
264   *     @sk_policy: flow policy
265   *     @sk_receive_queue: incoming packets
266   *     @sk_wmem_alloc: transmit queue bytes committed
267   *     @sk_tsq_flags: TCP Small Queues flags
268   *     @sk_write_queue: Packet sending queue
269   *     @sk_omem_alloc: "o" is "option" or "other"
270   *     @sk_wmem_queued: persistent queue size
271   *     @sk_forward_alloc: space allocated forward
272   *     @sk_reserved_mem: space reserved and non-reclaimable for the socket
273   *     @sk_napi_id: id of the last napi context to receive data for sk
274   *     @sk_ll_usec: usecs to busypoll when there is no data
275   *     @sk_allocation: allocation mode
276   *     @sk_pacing_rate: Pacing rate (if supported by transport/packet scheduler)
277   *     @sk_pacing_status: Pacing status (requested, handled by sch_fq)
278   *     @sk_max_pacing_rate: Maximum pacing rate (%SO_MAX_PACING_RATE)
279   *     @sk_sndbuf: size of send buffer in bytes
280   *     @__sk_flags_offset: empty field used to determine location of bitfield
281   *     @sk_padding: unused element for alignment
282   *     @sk_no_check_tx: %SO_NO_CHECK setting, set checksum in TX packets
283   *     @sk_no_check_rx: allow zero checksum in RX packets
284   *     @sk_route_caps: route capabilities (e.g. %NETIF_F_TSO)
285   *     @sk_gso_disabled: if set, NETIF_F_GSO_MASK is forbidden.
286   *     @sk_gso_type: GSO type (e.g. %SKB_GSO_TCPV4)
287   *     @sk_gso_max_size: Maximum GSO segment size to build
288   *     @sk_gso_max_segs: Maximum number of GSO segments
289   *     @sk_pacing_shift: scaling factor for TCP Small Queues
290   *     @sk_lingertime: %SO_LINGER l_linger setting
291   *     @sk_backlog: always used with the per-socket spinlock held
292   *     @sk_callback_lock: used with the callbacks in the end of this struct
293   *     @sk_error_queue: rarely used
294   *     @sk_prot_creator: sk_prot of original sock creator (see ipv6_setsockopt,
295   *                       IPV6_ADDRFORM for instance)
296   *     @sk_err: last error
297   *     @sk_err_soft: errors that don't cause failure but are the cause of a
298   *                   persistent failure not just 'timed out'
299   *     @sk_drops: raw/udp drops counter
300   *     @sk_ack_backlog: current listen backlog
301   *     @sk_max_ack_backlog: listen backlog set in listen()
302   *     @sk_uid: user id of owner
303   *     @sk_prefer_busy_poll: prefer busypolling over softirq processing
304   *     @sk_busy_poll_budget: napi processing budget when busypolling
305   *     @sk_priority: %SO_PRIORITY setting
306   *     @sk_type: socket type (%SOCK_STREAM, etc)
307   *     @sk_protocol: which protocol this socket belongs in this network family
308   *     @sk_peer_lock: lock protecting @sk_peer_pid and @sk_peer_cred
309   *     @sk_peer_pid: &struct pid for this socket's peer
310   *     @sk_peer_cred: %SO_PEERCRED setting
311   *     @sk_rcvlowat: %SO_RCVLOWAT setting
312   *     @sk_rcvtimeo: %SO_RCVTIMEO setting
313   *     @sk_sndtimeo: %SO_SNDTIMEO setting
314   *     @sk_txhash: computed flow hash for use on transmit
315   *     @sk_txrehash: enable TX hash rethink
316   *     @sk_filter: socket filtering instructions
317   *     @sk_timer: sock cleanup timer
318   *     @sk_stamp: time stamp of last packet received
319   *     @sk_stamp_seq: lock for accessing sk_stamp on 32 bit architectures only
320   *     @sk_tsflags: SO_TIMESTAMPING flags
321   *     @sk_bind_phc: SO_TIMESTAMPING bind PHC index of PTP virtual clock
322   *                   for timestamping
323   *     @sk_tskey: counter to disambiguate concurrent tstamp requests
324   *     @sk_zckey: counter to order MSG_ZEROCOPY notifications
325   *     @sk_socket: Identd and reporting IO signals
326   *     @sk_user_data: RPC layer private data. Write-protected by @sk_callback_lock.
327   *     @sk_frag: cached page frag
328   *     @sk_peek_off: current peek_offset value
329   *     @sk_send_head: front of stuff to transmit
330   *     @tcp_rtx_queue: TCP re-transmit queue [union with @sk_send_head]
331   *     @sk_security: used by security modules
332   *     @sk_mark: generic packet mark
333   *     @sk_cgrp_data: cgroup data for this cgroup
334   *     @sk_memcg: this socket's memory cgroup association
335   *     @sk_write_pending: a write to stream socket waits to start
336   *     @sk_wait_pending: number of threads blocked on this socket
337   *     @sk_state_change: callback to indicate change in the state of the sock
338   *     @sk_data_ready: callback to indicate there is data to be processed
339   *     @sk_write_space: callback to indicate there is bf sending space available
340   *     @sk_error_report: callback to indicate errors (e.g. %MSG_ERRQUEUE)
341   *     @sk_backlog_rcv: callback to process the backlog
342   *     @sk_validate_xmit_skb: ptr to an optional validate function
343   *     @sk_destruct: called at sock freeing time, i.e. when all refcnt == 0
344   *     @sk_reuseport_cb: reuseport group container
345   *     @sk_bpf_storage: ptr to cache and control for bpf_sk_storage
346   *     @sk_rcu: used during RCU grace period
347   *     @sk_clockid: clockid used by time-based scheduling (SO_TXTIME)
348   *     @sk_txtime_deadline_mode: set deadline mode for SO_TXTIME
349   *     @sk_txtime_report_errors: set report errors mode for SO_TXTIME
350   *     @sk_txtime_unused: unused txtime flags
351   *     @ns_tracker: tracker for netns reference
352   *     @sk_bind2_node: bind node in the bhash2 table
353   */
354 struct sock {
355         /*
356          * Now struct inet_timewait_sock also uses sock_common, so please just
357          * don't add nothing before this first member (__sk_common) --acme
358          */
359         struct sock_common      __sk_common;
360 #define sk_node                 __sk_common.skc_node
361 #define sk_nulls_node           __sk_common.skc_nulls_node
362 #define sk_refcnt               __sk_common.skc_refcnt
363 #define sk_tx_queue_mapping     __sk_common.skc_tx_queue_mapping
364 #ifdef CONFIG_SOCK_RX_QUEUE_MAPPING
365 #define sk_rx_queue_mapping     __sk_common.skc_rx_queue_mapping
366 #endif
367
368 #define sk_dontcopy_begin       __sk_common.skc_dontcopy_begin
369 #define sk_dontcopy_end         __sk_common.skc_dontcopy_end
370 #define sk_hash                 __sk_common.skc_hash
371 #define sk_portpair             __sk_common.skc_portpair
372 #define sk_num                  __sk_common.skc_num
373 #define sk_dport                __sk_common.skc_dport
374 #define sk_addrpair             __sk_common.skc_addrpair
375 #define sk_daddr                __sk_common.skc_daddr
376 #define sk_rcv_saddr            __sk_common.skc_rcv_saddr
377 #define sk_family               __sk_common.skc_family
378 #define sk_state                __sk_common.skc_state
379 #define sk_reuse                __sk_common.skc_reuse
380 #define sk_reuseport            __sk_common.skc_reuseport
381 #define sk_ipv6only             __sk_common.skc_ipv6only
382 #define sk_net_refcnt           __sk_common.skc_net_refcnt
383 #define sk_bound_dev_if         __sk_common.skc_bound_dev_if
384 #define sk_bind_node            __sk_common.skc_bind_node
385 #define sk_prot                 __sk_common.skc_prot
386 #define sk_net                  __sk_common.skc_net
387 #define sk_v6_daddr             __sk_common.skc_v6_daddr
388 #define sk_v6_rcv_saddr __sk_common.skc_v6_rcv_saddr
389 #define sk_cookie               __sk_common.skc_cookie
390 #define sk_incoming_cpu         __sk_common.skc_incoming_cpu
391 #define sk_flags                __sk_common.skc_flags
392 #define sk_rxhash               __sk_common.skc_rxhash
393
394         /* early demux fields */
395         struct dst_entry __rcu  *sk_rx_dst;
396         int                     sk_rx_dst_ifindex;
397         u32                     sk_rx_dst_cookie;
398
399         socket_lock_t           sk_lock;
400         atomic_t                sk_drops;
401         int                     sk_rcvlowat;
402         struct sk_buff_head     sk_error_queue;
403         struct sk_buff_head     sk_receive_queue;
404         /*
405          * The backlog queue is special, it is always used with
406          * the per-socket spinlock held and requires low latency
407          * access. Therefore we special case it's implementation.
408          * Note : rmem_alloc is in this structure to fill a hole
409          * on 64bit arches, not because its logically part of
410          * backlog.
411          */
412         struct {
413                 atomic_t        rmem_alloc;
414                 int             len;
415                 struct sk_buff  *head;
416                 struct sk_buff  *tail;
417         } sk_backlog;
418
419 #define sk_rmem_alloc sk_backlog.rmem_alloc
420
421         int                     sk_forward_alloc;
422         u32                     sk_reserved_mem;
423 #ifdef CONFIG_NET_RX_BUSY_POLL
424         unsigned int            sk_ll_usec;
425         /* ===== mostly read cache line ===== */
426         unsigned int            sk_napi_id;
427 #endif
428         int                     sk_rcvbuf;
429         int                     sk_wait_pending;
430
431         struct sk_filter __rcu  *sk_filter;
432         union {
433                 struct socket_wq __rcu  *sk_wq;
434                 /* private: */
435                 struct socket_wq        *sk_wq_raw;
436                 /* public: */
437         };
438 #ifdef CONFIG_XFRM
439         struct xfrm_policy __rcu *sk_policy[2];
440 #endif
441
442         struct dst_entry __rcu  *sk_dst_cache;
443         atomic_t                sk_omem_alloc;
444         int                     sk_sndbuf;
445
446         /* ===== cache line for TX ===== */
447         int                     sk_wmem_queued;
448         refcount_t              sk_wmem_alloc;
449         unsigned long           sk_tsq_flags;
450         union {
451                 struct sk_buff  *sk_send_head;
452                 struct rb_root  tcp_rtx_queue;
453         };
454         struct sk_buff_head     sk_write_queue;
455         __s32                   sk_peek_off;
456         int                     sk_write_pending;
457         __u32                   sk_dst_pending_confirm;
458         u32                     sk_pacing_status; /* see enum sk_pacing */
459         long                    sk_sndtimeo;
460         struct timer_list       sk_timer;
461         __u32                   sk_priority;
462         __u32                   sk_mark;
463         unsigned long           sk_pacing_rate; /* bytes per second */
464         unsigned long           sk_max_pacing_rate;
465         struct page_frag        sk_frag;
466         netdev_features_t       sk_route_caps;
467         int                     sk_gso_type;
468         unsigned int            sk_gso_max_size;
469         gfp_t                   sk_allocation;
470         __u32                   sk_txhash;
471
472         /*
473          * Because of non atomicity rules, all
474          * changes are protected by socket lock.
475          */
476         u8                      sk_gso_disabled : 1,
477                                 sk_kern_sock : 1,
478                                 sk_no_check_tx : 1,
479                                 sk_no_check_rx : 1,
480                                 sk_userlocks : 4;
481         u8                      sk_pacing_shift;
482         u16                     sk_type;
483         u16                     sk_protocol;
484         u16                     sk_gso_max_segs;
485         unsigned long           sk_lingertime;
486         struct proto            *sk_prot_creator;
487         rwlock_t                sk_callback_lock;
488         int                     sk_err,
489                                 sk_err_soft;
490         u32                     sk_ack_backlog;
491         u32                     sk_max_ack_backlog;
492         kuid_t                  sk_uid;
493         u8                      sk_txrehash;
494 #ifdef CONFIG_NET_RX_BUSY_POLL
495         u8                      sk_prefer_busy_poll;
496         u16                     sk_busy_poll_budget;
497 #endif
498         spinlock_t              sk_peer_lock;
499         int                     sk_bind_phc;
500         struct pid              *sk_peer_pid;
501         const struct cred       *sk_peer_cred;
502
503         long                    sk_rcvtimeo;
504         ktime_t                 sk_stamp;
505 #if BITS_PER_LONG==32
506         seqlock_t               sk_stamp_seq;
507 #endif
508         u16                     sk_tsflags;
509         u8                      sk_shutdown;
510         atomic_t                sk_tskey;
511         atomic_t                sk_zckey;
512
513         u8                      sk_clockid;
514         u8                      sk_txtime_deadline_mode : 1,
515                                 sk_txtime_report_errors : 1,
516                                 sk_txtime_unused : 6;
517
518         struct socket           *sk_socket;
519         void                    *sk_user_data;
520 #ifdef CONFIG_SECURITY
521         void                    *sk_security;
522 #endif
523         struct sock_cgroup_data sk_cgrp_data;
524         struct mem_cgroup       *sk_memcg;
525         void                    (*sk_state_change)(struct sock *sk);
526         void                    (*sk_data_ready)(struct sock *sk);
527         void                    (*sk_write_space)(struct sock *sk);
528         void                    (*sk_error_report)(struct sock *sk);
529         int                     (*sk_backlog_rcv)(struct sock *sk,
530                                                   struct sk_buff *skb);
531 #ifdef CONFIG_SOCK_VALIDATE_XMIT
532         struct sk_buff*         (*sk_validate_xmit_skb)(struct sock *sk,
533                                                         struct net_device *dev,
534                                                         struct sk_buff *skb);
535 #endif
536         void                    (*sk_destruct)(struct sock *sk);
537         struct sock_reuseport __rcu     *sk_reuseport_cb;
538 #ifdef CONFIG_BPF_SYSCALL
539         struct bpf_local_storage __rcu  *sk_bpf_storage;
540 #endif
541         struct rcu_head         sk_rcu;
542         netns_tracker           ns_tracker;
543         struct hlist_node       sk_bind2_node;
544 };
545
546 enum sk_pacing {
547         SK_PACING_NONE          = 0,
548         SK_PACING_NEEDED        = 1,
549         SK_PACING_FQ            = 2,
550 };
551
552 /* flag bits in sk_user_data
553  *
554  * - SK_USER_DATA_NOCOPY:      Pointer stored in sk_user_data might
555  *   not be suitable for copying when cloning the socket. For instance,
556  *   it can point to a reference counted object. sk_user_data bottom
557  *   bit is set if pointer must not be copied.
558  *
559  * - SK_USER_DATA_BPF:         Mark whether sk_user_data field is
560  *   managed/owned by a BPF reuseport array. This bit should be set
561  *   when sk_user_data's sk is added to the bpf's reuseport_array.
562  *
563  * - SK_USER_DATA_PSOCK:       Mark whether pointer stored in
564  *   sk_user_data points to psock type. This bit should be set
565  *   when sk_user_data is assigned to a psock object.
566  */
567 #define SK_USER_DATA_NOCOPY     1UL
568 #define SK_USER_DATA_BPF        2UL
569 #define SK_USER_DATA_PSOCK      4UL
570 #define SK_USER_DATA_PTRMASK    ~(SK_USER_DATA_NOCOPY | SK_USER_DATA_BPF |\
571                                   SK_USER_DATA_PSOCK)
572
573 /**
574  * sk_user_data_is_nocopy - Test if sk_user_data pointer must not be copied
575  * @sk: socket
576  */
577 static inline bool sk_user_data_is_nocopy(const struct sock *sk)
578 {
579         return ((uintptr_t)sk->sk_user_data & SK_USER_DATA_NOCOPY);
580 }
581
582 #define __sk_user_data(sk) ((*((void __rcu **)&(sk)->sk_user_data)))
583
584 /**
585  * __locked_read_sk_user_data_with_flags - return the pointer
586  * only if argument flags all has been set in sk_user_data. Otherwise
587  * return NULL
588  *
589  * @sk: socket
590  * @flags: flag bits
591  *
592  * The caller must be holding sk->sk_callback_lock.
593  */
594 static inline void *
595 __locked_read_sk_user_data_with_flags(const struct sock *sk,
596                                       uintptr_t flags)
597 {
598         uintptr_t sk_user_data =
599                 (uintptr_t)rcu_dereference_check(__sk_user_data(sk),
600                                                  lockdep_is_held(&sk->sk_callback_lock));
601
602         WARN_ON_ONCE(flags & SK_USER_DATA_PTRMASK);
603
604         if ((sk_user_data & flags) == flags)
605                 return (void *)(sk_user_data & SK_USER_DATA_PTRMASK);
606         return NULL;
607 }
608
609 /**
610  * __rcu_dereference_sk_user_data_with_flags - return the pointer
611  * only if argument flags all has been set in sk_user_data. Otherwise
612  * return NULL
613  *
614  * @sk: socket
615  * @flags: flag bits
616  */
617 static inline void *
618 __rcu_dereference_sk_user_data_with_flags(const struct sock *sk,
619                                           uintptr_t flags)
620 {
621         uintptr_t sk_user_data = (uintptr_t)rcu_dereference(__sk_user_data(sk));
622
623         WARN_ON_ONCE(flags & SK_USER_DATA_PTRMASK);
624
625         if ((sk_user_data & flags) == flags)
626                 return (void *)(sk_user_data & SK_USER_DATA_PTRMASK);
627         return NULL;
628 }
629
630 #define rcu_dereference_sk_user_data(sk)                                \
631         __rcu_dereference_sk_user_data_with_flags(sk, 0)
632 #define __rcu_assign_sk_user_data_with_flags(sk, ptr, flags)            \
633 ({                                                                      \
634         uintptr_t __tmp1 = (uintptr_t)(ptr),                            \
635                   __tmp2 = (uintptr_t)(flags);                          \
636         WARN_ON_ONCE(__tmp1 & ~SK_USER_DATA_PTRMASK);                   \
637         WARN_ON_ONCE(__tmp2 & SK_USER_DATA_PTRMASK);                    \
638         rcu_assign_pointer(__sk_user_data((sk)),                        \
639                            __tmp1 | __tmp2);                            \
640 })
641 #define rcu_assign_sk_user_data(sk, ptr)                                \
642         __rcu_assign_sk_user_data_with_flags(sk, ptr, 0)
643
644 static inline
645 struct net *sock_net(const struct sock *sk)
646 {
647         return read_pnet(&sk->sk_net);
648 }
649
650 static inline
651 void sock_net_set(struct sock *sk, struct net *net)
652 {
653         write_pnet(&sk->sk_net, net);
654 }
655
656 /*
657  * SK_CAN_REUSE and SK_NO_REUSE on a socket mean that the socket is OK
658  * or not whether his port will be reused by someone else. SK_FORCE_REUSE
659  * on a socket means that the socket will reuse everybody else's port
660  * without looking at the other's sk_reuse value.
661  */
662
663 #define SK_NO_REUSE     0
664 #define SK_CAN_REUSE    1
665 #define SK_FORCE_REUSE  2
666
667 int sk_set_peek_off(struct sock *sk, int val);
668
669 static inline int sk_peek_offset(const struct sock *sk, int flags)
670 {
671         if (unlikely(flags & MSG_PEEK)) {
672                 return READ_ONCE(sk->sk_peek_off);
673         }
674
675         return 0;
676 }
677
678 static inline void sk_peek_offset_bwd(struct sock *sk, int val)
679 {
680         s32 off = READ_ONCE(sk->sk_peek_off);
681
682         if (unlikely(off >= 0)) {
683                 off = max_t(s32, off - val, 0);
684                 WRITE_ONCE(sk->sk_peek_off, off);
685         }
686 }
687
688 static inline void sk_peek_offset_fwd(struct sock *sk, int val)
689 {
690         sk_peek_offset_bwd(sk, -val);
691 }
692
693 /*
694  * Hashed lists helper routines
695  */
696 static inline struct sock *sk_entry(const struct hlist_node *node)
697 {
698         return hlist_entry(node, struct sock, sk_node);
699 }
700
701 static inline struct sock *__sk_head(const struct hlist_head *head)
702 {
703         return hlist_entry(head->first, struct sock, sk_node);
704 }
705
706 static inline struct sock *sk_head(const struct hlist_head *head)
707 {
708         return hlist_empty(head) ? NULL : __sk_head(head);
709 }
710
711 static inline struct sock *__sk_nulls_head(const struct hlist_nulls_head *head)
712 {
713         return hlist_nulls_entry(head->first, struct sock, sk_nulls_node);
714 }
715
716 static inline struct sock *sk_nulls_head(const struct hlist_nulls_head *head)
717 {
718         return hlist_nulls_empty(head) ? NULL : __sk_nulls_head(head);
719 }
720
721 static inline struct sock *sk_next(const struct sock *sk)
722 {
723         return hlist_entry_safe(sk->sk_node.next, struct sock, sk_node);
724 }
725
726 static inline struct sock *sk_nulls_next(const struct sock *sk)
727 {
728         return (!is_a_nulls(sk->sk_nulls_node.next)) ?
729                 hlist_nulls_entry(sk->sk_nulls_node.next,
730                                   struct sock, sk_nulls_node) :
731                 NULL;
732 }
733
734 static inline bool sk_unhashed(const struct sock *sk)
735 {
736         return hlist_unhashed(&sk->sk_node);
737 }
738
739 static inline bool sk_hashed(const struct sock *sk)
740 {
741         return !sk_unhashed(sk);
742 }
743
744 static inline void sk_node_init(struct hlist_node *node)
745 {
746         node->pprev = NULL;
747 }
748
749 static inline void __sk_del_node(struct sock *sk)
750 {
751         __hlist_del(&sk->sk_node);
752 }
753
754 /* NB: equivalent to hlist_del_init_rcu */
755 static inline bool __sk_del_node_init(struct sock *sk)
756 {
757         if (sk_hashed(sk)) {
758                 __sk_del_node(sk);
759                 sk_node_init(&sk->sk_node);
760                 return true;
761         }
762         return false;
763 }
764
765 /* Grab socket reference count. This operation is valid only
766    when sk is ALREADY grabbed f.e. it is found in hash table
767    or a list and the lookup is made under lock preventing hash table
768    modifications.
769  */
770
771 static __always_inline void sock_hold(struct sock *sk)
772 {
773         refcount_inc(&sk->sk_refcnt);
774 }
775
776 /* Ungrab socket in the context, which assumes that socket refcnt
777    cannot hit zero, f.e. it is true in context of any socketcall.
778  */
779 static __always_inline void __sock_put(struct sock *sk)
780 {
781         refcount_dec(&sk->sk_refcnt);
782 }
783
784 static inline bool sk_del_node_init(struct sock *sk)
785 {
786         bool rc = __sk_del_node_init(sk);
787
788         if (rc) {
789                 /* paranoid for a while -acme */
790                 WARN_ON(refcount_read(&sk->sk_refcnt) == 1);
791                 __sock_put(sk);
792         }
793         return rc;
794 }
795 #define sk_del_node_init_rcu(sk)        sk_del_node_init(sk)
796
797 static inline bool __sk_nulls_del_node_init_rcu(struct sock *sk)
798 {
799         if (sk_hashed(sk)) {
800                 hlist_nulls_del_init_rcu(&sk->sk_nulls_node);
801                 return true;
802         }
803         return false;
804 }
805
806 static inline bool sk_nulls_del_node_init_rcu(struct sock *sk)
807 {
808         bool rc = __sk_nulls_del_node_init_rcu(sk);
809
810         if (rc) {
811                 /* paranoid for a while -acme */
812                 WARN_ON(refcount_read(&sk->sk_refcnt) == 1);
813                 __sock_put(sk);
814         }
815         return rc;
816 }
817
818 static inline void __sk_add_node(struct sock *sk, struct hlist_head *list)
819 {
820         hlist_add_head(&sk->sk_node, list);
821 }
822
823 static inline void sk_add_node(struct sock *sk, struct hlist_head *list)
824 {
825         sock_hold(sk);
826         __sk_add_node(sk, list);
827 }
828
829 static inline void sk_add_node_rcu(struct sock *sk, struct hlist_head *list)
830 {
831         sock_hold(sk);
832         if (IS_ENABLED(CONFIG_IPV6) && sk->sk_reuseport &&
833             sk->sk_family == AF_INET6)
834                 hlist_add_tail_rcu(&sk->sk_node, list);
835         else
836                 hlist_add_head_rcu(&sk->sk_node, list);
837 }
838
839 static inline void sk_add_node_tail_rcu(struct sock *sk, struct hlist_head *list)
840 {
841         sock_hold(sk);
842         hlist_add_tail_rcu(&sk->sk_node, list);
843 }
844
845 static inline void __sk_nulls_add_node_rcu(struct sock *sk, struct hlist_nulls_head *list)
846 {
847         hlist_nulls_add_head_rcu(&sk->sk_nulls_node, list);
848 }
849
850 static inline void __sk_nulls_add_node_tail_rcu(struct sock *sk, struct hlist_nulls_head *list)
851 {
852         hlist_nulls_add_tail_rcu(&sk->sk_nulls_node, list);
853 }
854
855 static inline void sk_nulls_add_node_rcu(struct sock *sk, struct hlist_nulls_head *list)
856 {
857         sock_hold(sk);
858         __sk_nulls_add_node_rcu(sk, list);
859 }
860
861 static inline void __sk_del_bind_node(struct sock *sk)
862 {
863         __hlist_del(&sk->sk_bind_node);
864 }
865
866 static inline void sk_add_bind_node(struct sock *sk,
867                                         struct hlist_head *list)
868 {
869         hlist_add_head(&sk->sk_bind_node, list);
870 }
871
872 static inline void __sk_del_bind2_node(struct sock *sk)
873 {
874         __hlist_del(&sk->sk_bind2_node);
875 }
876
877 static inline void sk_add_bind2_node(struct sock *sk, struct hlist_head *list)
878 {
879         hlist_add_head(&sk->sk_bind2_node, list);
880 }
881
882 #define sk_for_each(__sk, list) \
883         hlist_for_each_entry(__sk, list, sk_node)
884 #define sk_for_each_rcu(__sk, list) \
885         hlist_for_each_entry_rcu(__sk, list, sk_node)
886 #define sk_nulls_for_each(__sk, node, list) \
887         hlist_nulls_for_each_entry(__sk, node, list, sk_nulls_node)
888 #define sk_nulls_for_each_rcu(__sk, node, list) \
889         hlist_nulls_for_each_entry_rcu(__sk, node, list, sk_nulls_node)
890 #define sk_for_each_from(__sk) \
891         hlist_for_each_entry_from(__sk, sk_node)
892 #define sk_nulls_for_each_from(__sk, node) \
893         if (__sk && ({ node = &(__sk)->sk_nulls_node; 1; })) \
894                 hlist_nulls_for_each_entry_from(__sk, node, sk_nulls_node)
895 #define sk_for_each_safe(__sk, tmp, list) \
896         hlist_for_each_entry_safe(__sk, tmp, list, sk_node)
897 #define sk_for_each_bound(__sk, list) \
898         hlist_for_each_entry(__sk, list, sk_bind_node)
899 #define sk_for_each_bound_bhash2(__sk, list) \
900         hlist_for_each_entry(__sk, list, sk_bind2_node)
901
902 /**
903  * sk_for_each_entry_offset_rcu - iterate over a list at a given struct offset
904  * @tpos:       the type * to use as a loop cursor.
905  * @pos:        the &struct hlist_node to use as a loop cursor.
906  * @head:       the head for your list.
907  * @offset:     offset of hlist_node within the struct.
908  *
909  */
910 #define sk_for_each_entry_offset_rcu(tpos, pos, head, offset)                  \
911         for (pos = rcu_dereference(hlist_first_rcu(head));                     \
912              pos != NULL &&                                                    \
913                 ({ tpos = (typeof(*tpos) *)((void *)pos - offset); 1;});       \
914              pos = rcu_dereference(hlist_next_rcu(pos)))
915
916 static inline struct user_namespace *sk_user_ns(const struct sock *sk)
917 {
918         /* Careful only use this in a context where these parameters
919          * can not change and must all be valid, such as recvmsg from
920          * userspace.
921          */
922         return sk->sk_socket->file->f_cred->user_ns;
923 }
924
925 /* Sock flags */
926 enum sock_flags {
927         SOCK_DEAD,
928         SOCK_DONE,
929         SOCK_URGINLINE,
930         SOCK_KEEPOPEN,
931         SOCK_LINGER,
932         SOCK_DESTROY,
933         SOCK_BROADCAST,
934         SOCK_TIMESTAMP,
935         SOCK_ZAPPED,
936         SOCK_USE_WRITE_QUEUE, /* whether to call sk->sk_write_space in sock_wfree */
937         SOCK_DBG, /* %SO_DEBUG setting */
938         SOCK_RCVTSTAMP, /* %SO_TIMESTAMP setting */
939         SOCK_RCVTSTAMPNS, /* %SO_TIMESTAMPNS setting */
940         SOCK_LOCALROUTE, /* route locally only, %SO_DONTROUTE setting */
941         SOCK_MEMALLOC, /* VM depends on this socket for swapping */
942         SOCK_TIMESTAMPING_RX_SOFTWARE,  /* %SOF_TIMESTAMPING_RX_SOFTWARE */
943         SOCK_FASYNC, /* fasync() active */
944         SOCK_RXQ_OVFL,
945         SOCK_ZEROCOPY, /* buffers from userspace */
946         SOCK_WIFI_STATUS, /* push wifi status to userspace */
947         SOCK_NOFCS, /* Tell NIC not to do the Ethernet FCS.
948                      * Will use last 4 bytes of packet sent from
949                      * user-space instead.
950                      */
951         SOCK_FILTER_LOCKED, /* Filter cannot be changed anymore */
952         SOCK_SELECT_ERR_QUEUE, /* Wake select on error queue */
953         SOCK_RCU_FREE, /* wait rcu grace period in sk_destruct() */
954         SOCK_TXTIME,
955         SOCK_XDP, /* XDP is attached */
956         SOCK_TSTAMP_NEW, /* Indicates 64 bit timestamps always */
957         SOCK_RCVMARK, /* Receive SO_MARK  ancillary data with packet */
958 };
959
960 #define SK_FLAGS_TIMESTAMP ((1UL << SOCK_TIMESTAMP) | (1UL << SOCK_TIMESTAMPING_RX_SOFTWARE))
961
962 static inline void sock_copy_flags(struct sock *nsk, const struct sock *osk)
963 {
964         nsk->sk_flags = osk->sk_flags;
965 }
966
967 static inline void sock_set_flag(struct sock *sk, enum sock_flags flag)
968 {
969         __set_bit(flag, &sk->sk_flags);
970 }
971
972 static inline void sock_reset_flag(struct sock *sk, enum sock_flags flag)
973 {
974         __clear_bit(flag, &sk->sk_flags);
975 }
976
977 static inline void sock_valbool_flag(struct sock *sk, enum sock_flags bit,
978                                      int valbool)
979 {
980         if (valbool)
981                 sock_set_flag(sk, bit);
982         else
983                 sock_reset_flag(sk, bit);
984 }
985
986 static inline bool sock_flag(const struct sock *sk, enum sock_flags flag)
987 {
988         return test_bit(flag, &sk->sk_flags);
989 }
990
991 #ifdef CONFIG_NET
992 DECLARE_STATIC_KEY_FALSE(memalloc_socks_key);
993 static inline int sk_memalloc_socks(void)
994 {
995         return static_branch_unlikely(&memalloc_socks_key);
996 }
997
998 void __receive_sock(struct file *file);
999 #else
1000
1001 static inline int sk_memalloc_socks(void)
1002 {
1003         return 0;
1004 }
1005
1006 static inline void __receive_sock(struct file *file)
1007 { }
1008 #endif
1009
1010 static inline gfp_t sk_gfp_mask(const struct sock *sk, gfp_t gfp_mask)
1011 {
1012         return gfp_mask | (sk->sk_allocation & __GFP_MEMALLOC);
1013 }
1014
1015 static inline void sk_acceptq_removed(struct sock *sk)
1016 {
1017         WRITE_ONCE(sk->sk_ack_backlog, sk->sk_ack_backlog - 1);
1018 }
1019
1020 static inline void sk_acceptq_added(struct sock *sk)
1021 {
1022         WRITE_ONCE(sk->sk_ack_backlog, sk->sk_ack_backlog + 1);
1023 }
1024
1025 /* Note: If you think the test should be:
1026  *      return READ_ONCE(sk->sk_ack_backlog) >= READ_ONCE(sk->sk_max_ack_backlog);
1027  * Then please take a look at commit 64a146513f8f ("[NET]: Revert incorrect accept queue backlog changes.")
1028  */
1029 static inline bool sk_acceptq_is_full(const struct sock *sk)
1030 {
1031         return READ_ONCE(sk->sk_ack_backlog) > READ_ONCE(sk->sk_max_ack_backlog);
1032 }
1033
1034 /*
1035  * Compute minimal free write space needed to queue new packets.
1036  */
1037 static inline int sk_stream_min_wspace(const struct sock *sk)
1038 {
1039         return READ_ONCE(sk->sk_wmem_queued) >> 1;
1040 }
1041
1042 static inline int sk_stream_wspace(const struct sock *sk)
1043 {
1044         return READ_ONCE(sk->sk_sndbuf) - READ_ONCE(sk->sk_wmem_queued);
1045 }
1046
1047 static inline void sk_wmem_queued_add(struct sock *sk, int val)
1048 {
1049         WRITE_ONCE(sk->sk_wmem_queued, sk->sk_wmem_queued + val);
1050 }
1051
1052 void sk_stream_write_space(struct sock *sk);
1053
1054 /* OOB backlog add */
1055 static inline void __sk_add_backlog(struct sock *sk, struct sk_buff *skb)
1056 {
1057         /* dont let skb dst not refcounted, we are going to leave rcu lock */
1058         skb_dst_force(skb);
1059
1060         if (!sk->sk_backlog.tail)
1061                 WRITE_ONCE(sk->sk_backlog.head, skb);
1062         else
1063                 sk->sk_backlog.tail->next = skb;
1064
1065         WRITE_ONCE(sk->sk_backlog.tail, skb);
1066         skb->next = NULL;
1067 }
1068
1069 /*
1070  * Take into account size of receive queue and backlog queue
1071  * Do not take into account this skb truesize,
1072  * to allow even a single big packet to come.
1073  */
1074 static inline bool sk_rcvqueues_full(const struct sock *sk, unsigned int limit)
1075 {
1076         unsigned int qsize = sk->sk_backlog.len + atomic_read(&sk->sk_rmem_alloc);
1077
1078         return qsize > limit;
1079 }
1080
1081 /* The per-socket spinlock must be held here. */
1082 static inline __must_check int sk_add_backlog(struct sock *sk, struct sk_buff *skb,
1083                                               unsigned int limit)
1084 {
1085         if (sk_rcvqueues_full(sk, limit))
1086                 return -ENOBUFS;
1087
1088         /*
1089          * If the skb was allocated from pfmemalloc reserves, only
1090          * allow SOCK_MEMALLOC sockets to use it as this socket is
1091          * helping free memory
1092          */
1093         if (skb_pfmemalloc(skb) && !sock_flag(sk, SOCK_MEMALLOC))
1094                 return -ENOMEM;
1095
1096         __sk_add_backlog(sk, skb);
1097         sk->sk_backlog.len += skb->truesize;
1098         return 0;
1099 }
1100
1101 int __sk_backlog_rcv(struct sock *sk, struct sk_buff *skb);
1102
1103 INDIRECT_CALLABLE_DECLARE(int tcp_v4_do_rcv(struct sock *sk, struct sk_buff *skb));
1104 INDIRECT_CALLABLE_DECLARE(int tcp_v6_do_rcv(struct sock *sk, struct sk_buff *skb));
1105
1106 static inline int sk_backlog_rcv(struct sock *sk, struct sk_buff *skb)
1107 {
1108         if (sk_memalloc_socks() && skb_pfmemalloc(skb))
1109                 return __sk_backlog_rcv(sk, skb);
1110
1111         return INDIRECT_CALL_INET(sk->sk_backlog_rcv,
1112                                   tcp_v6_do_rcv,
1113                                   tcp_v4_do_rcv,
1114                                   sk, skb);
1115 }
1116
1117 static inline void sk_incoming_cpu_update(struct sock *sk)
1118 {
1119         int cpu = raw_smp_processor_id();
1120
1121         if (unlikely(READ_ONCE(sk->sk_incoming_cpu) != cpu))
1122                 WRITE_ONCE(sk->sk_incoming_cpu, cpu);
1123 }
1124
1125 static inline void sock_rps_record_flow_hash(__u32 hash)
1126 {
1127 #ifdef CONFIG_RPS
1128         struct rps_sock_flow_table *sock_flow_table;
1129
1130         rcu_read_lock();
1131         sock_flow_table = rcu_dereference(rps_sock_flow_table);
1132         rps_record_sock_flow(sock_flow_table, hash);
1133         rcu_read_unlock();
1134 #endif
1135 }
1136
1137 static inline void sock_rps_record_flow(const struct sock *sk)
1138 {
1139 #ifdef CONFIG_RPS
1140         if (static_branch_unlikely(&rfs_needed)) {
1141                 /* Reading sk->sk_rxhash might incur an expensive cache line
1142                  * miss.
1143                  *
1144                  * TCP_ESTABLISHED does cover almost all states where RFS
1145                  * might be useful, and is cheaper [1] than testing :
1146                  *      IPv4: inet_sk(sk)->inet_daddr
1147                  *      IPv6: ipv6_addr_any(&sk->sk_v6_daddr)
1148                  * OR   an additional socket flag
1149                  * [1] : sk_state and sk_prot are in the same cache line.
1150                  */
1151                 if (sk->sk_state == TCP_ESTABLISHED)
1152                         sock_rps_record_flow_hash(sk->sk_rxhash);
1153         }
1154 #endif
1155 }
1156
1157 static inline void sock_rps_save_rxhash(struct sock *sk,
1158                                         const struct sk_buff *skb)
1159 {
1160 #ifdef CONFIG_RPS
1161         if (unlikely(sk->sk_rxhash != skb->hash))
1162                 sk->sk_rxhash = skb->hash;
1163 #endif
1164 }
1165
1166 static inline void sock_rps_reset_rxhash(struct sock *sk)
1167 {
1168 #ifdef CONFIG_RPS
1169         sk->sk_rxhash = 0;
1170 #endif
1171 }
1172
1173 #define sk_wait_event(__sk, __timeo, __condition, __wait)               \
1174         ({      int __rc;                                               \
1175                 __sk->sk_wait_pending++;                                \
1176                 release_sock(__sk);                                     \
1177                 __rc = __condition;                                     \
1178                 if (!__rc) {                                            \
1179                         *(__timeo) = wait_woken(__wait,                 \
1180                                                 TASK_INTERRUPTIBLE,     \
1181                                                 *(__timeo));            \
1182                 }                                                       \
1183                 sched_annotate_sleep();                                 \
1184                 lock_sock(__sk);                                        \
1185                 __sk->sk_wait_pending--;                                \
1186                 __rc = __condition;                                     \
1187                 __rc;                                                   \
1188         })
1189
1190 int sk_stream_wait_connect(struct sock *sk, long *timeo_p);
1191 int sk_stream_wait_memory(struct sock *sk, long *timeo_p);
1192 void sk_stream_wait_close(struct sock *sk, long timeo_p);
1193 int sk_stream_error(struct sock *sk, int flags, int err);
1194 void sk_stream_kill_queues(struct sock *sk);
1195 void sk_set_memalloc(struct sock *sk);
1196 void sk_clear_memalloc(struct sock *sk);
1197
1198 void __sk_flush_backlog(struct sock *sk);
1199
1200 static inline bool sk_flush_backlog(struct sock *sk)
1201 {
1202         if (unlikely(READ_ONCE(sk->sk_backlog.tail))) {
1203                 __sk_flush_backlog(sk);
1204                 return true;
1205         }
1206         return false;
1207 }
1208
1209 int sk_wait_data(struct sock *sk, long *timeo, const struct sk_buff *skb);
1210
1211 struct request_sock_ops;
1212 struct timewait_sock_ops;
1213 struct inet_hashinfo;
1214 struct raw_hashinfo;
1215 struct smc_hashinfo;
1216 struct module;
1217 struct sk_psock;
1218
1219 /*
1220  * caches using SLAB_TYPESAFE_BY_RCU should let .next pointer from nulls nodes
1221  * un-modified. Special care is taken when initializing object to zero.
1222  */
1223 static inline void sk_prot_clear_nulls(struct sock *sk, int size)
1224 {
1225         if (offsetof(struct sock, sk_node.next) != 0)
1226                 memset(sk, 0, offsetof(struct sock, sk_node.next));
1227         memset(&sk->sk_node.pprev, 0,
1228                size - offsetof(struct sock, sk_node.pprev));
1229 }
1230
1231 /* Networking protocol blocks we attach to sockets.
1232  * socket layer -> transport layer interface
1233  */
1234 struct proto {
1235         void                    (*close)(struct sock *sk,
1236                                         long timeout);
1237         int                     (*pre_connect)(struct sock *sk,
1238                                         struct sockaddr *uaddr,
1239                                         int addr_len);
1240         int                     (*connect)(struct sock *sk,
1241                                         struct sockaddr *uaddr,
1242                                         int addr_len);
1243         int                     (*disconnect)(struct sock *sk, int flags);
1244
1245         struct sock *           (*accept)(struct sock *sk, int flags, int *err,
1246                                           bool kern);
1247
1248         int                     (*ioctl)(struct sock *sk, int cmd,
1249                                          unsigned long arg);
1250         int                     (*init)(struct sock *sk);
1251         void                    (*destroy)(struct sock *sk);
1252         void                    (*shutdown)(struct sock *sk, int how);
1253         int                     (*setsockopt)(struct sock *sk, int level,
1254                                         int optname, sockptr_t optval,
1255                                         unsigned int optlen);
1256         int                     (*getsockopt)(struct sock *sk, int level,
1257                                         int optname, char __user *optval,
1258                                         int __user *option);
1259         void                    (*keepalive)(struct sock *sk, int valbool);
1260 #ifdef CONFIG_COMPAT
1261         int                     (*compat_ioctl)(struct sock *sk,
1262                                         unsigned int cmd, unsigned long arg);
1263 #endif
1264         int                     (*sendmsg)(struct sock *sk, struct msghdr *msg,
1265                                            size_t len);
1266         int                     (*recvmsg)(struct sock *sk, struct msghdr *msg,
1267                                            size_t len, int flags, int *addr_len);
1268         int                     (*sendpage)(struct sock *sk, struct page *page,
1269                                         int offset, size_t size, int flags);
1270         int                     (*bind)(struct sock *sk,
1271                                         struct sockaddr *addr, int addr_len);
1272         int                     (*bind_add)(struct sock *sk,
1273                                         struct sockaddr *addr, int addr_len);
1274
1275         int                     (*backlog_rcv) (struct sock *sk,
1276                                                 struct sk_buff *skb);
1277         bool                    (*bpf_bypass_getsockopt)(int level,
1278                                                          int optname);
1279
1280         void            (*release_cb)(struct sock *sk);
1281
1282         /* Keeping track of sk's, looking them up, and port selection methods. */
1283         int                     (*hash)(struct sock *sk);
1284         void                    (*unhash)(struct sock *sk);
1285         void                    (*rehash)(struct sock *sk);
1286         int                     (*get_port)(struct sock *sk, unsigned short snum);
1287         void                    (*put_port)(struct sock *sk);
1288 #ifdef CONFIG_BPF_SYSCALL
1289         int                     (*psock_update_sk_prot)(struct sock *sk,
1290                                                         struct sk_psock *psock,
1291                                                         bool restore);
1292 #endif
1293
1294         /* Keeping track of sockets in use */
1295 #ifdef CONFIG_PROC_FS
1296         unsigned int            inuse_idx;
1297 #endif
1298
1299 #if IS_ENABLED(CONFIG_MPTCP)
1300         int                     (*forward_alloc_get)(const struct sock *sk);
1301 #endif
1302
1303         bool                    (*stream_memory_free)(const struct sock *sk, int wake);
1304         bool                    (*sock_is_readable)(struct sock *sk);
1305         /* Memory pressure */
1306         void                    (*enter_memory_pressure)(struct sock *sk);
1307         void                    (*leave_memory_pressure)(struct sock *sk);
1308         atomic_long_t           *memory_allocated;      /* Current allocated memory. */
1309         int  __percpu           *per_cpu_fw_alloc;
1310         struct percpu_counter   *sockets_allocated;     /* Current number of sockets. */
1311
1312         /*
1313          * Pressure flag: try to collapse.
1314          * Technical note: it is used by multiple contexts non atomically.
1315          * All the __sk_mem_schedule() is of this nature: accounting
1316          * is strict, actions are advisory and have some latency.
1317          */
1318         unsigned long           *memory_pressure;
1319         long                    *sysctl_mem;
1320
1321         int                     *sysctl_wmem;
1322         int                     *sysctl_rmem;
1323         u32                     sysctl_wmem_offset;
1324         u32                     sysctl_rmem_offset;
1325
1326         int                     max_header;
1327         bool                    no_autobind;
1328
1329         struct kmem_cache       *slab;
1330         unsigned int            obj_size;
1331         slab_flags_t            slab_flags;
1332         unsigned int            useroffset;     /* Usercopy region offset */
1333         unsigned int            usersize;       /* Usercopy region size */
1334
1335         unsigned int __percpu   *orphan_count;
1336
1337         struct request_sock_ops *rsk_prot;
1338         struct timewait_sock_ops *twsk_prot;
1339
1340         union {
1341                 struct inet_hashinfo    *hashinfo;
1342                 struct udp_table        *udp_table;
1343                 struct raw_hashinfo     *raw_hash;
1344                 struct smc_hashinfo     *smc_hash;
1345         } h;
1346
1347         struct module           *owner;
1348
1349         char                    name[32];
1350
1351         struct list_head        node;
1352 #ifdef SOCK_REFCNT_DEBUG
1353         atomic_t                socks;
1354 #endif
1355         int                     (*diag_destroy)(struct sock *sk, int err);
1356 } __randomize_layout;
1357
1358 int proto_register(struct proto *prot, int alloc_slab);
1359 void proto_unregister(struct proto *prot);
1360 int sock_load_diag_module(int family, int protocol);
1361
1362 #ifdef SOCK_REFCNT_DEBUG
1363 static inline void sk_refcnt_debug_inc(struct sock *sk)
1364 {
1365         atomic_inc(&sk->sk_prot->socks);
1366 }
1367
1368 static inline void sk_refcnt_debug_dec(struct sock *sk)
1369 {
1370         atomic_dec(&sk->sk_prot->socks);
1371         printk(KERN_DEBUG "%s socket %p released, %d are still alive\n",
1372                sk->sk_prot->name, sk, atomic_read(&sk->sk_prot->socks));
1373 }
1374
1375 static inline void sk_refcnt_debug_release(const struct sock *sk)
1376 {
1377         if (refcount_read(&sk->sk_refcnt) != 1)
1378                 printk(KERN_DEBUG "Destruction of the %s socket %p delayed, refcnt=%d\n",
1379                        sk->sk_prot->name, sk, refcount_read(&sk->sk_refcnt));
1380 }
1381 #else /* SOCK_REFCNT_DEBUG */
1382 #define sk_refcnt_debug_inc(sk) do { } while (0)
1383 #define sk_refcnt_debug_dec(sk) do { } while (0)
1384 #define sk_refcnt_debug_release(sk) do { } while (0)
1385 #endif /* SOCK_REFCNT_DEBUG */
1386
1387 INDIRECT_CALLABLE_DECLARE(bool tcp_stream_memory_free(const struct sock *sk, int wake));
1388
1389 static inline int sk_forward_alloc_get(const struct sock *sk)
1390 {
1391 #if IS_ENABLED(CONFIG_MPTCP)
1392         if (sk->sk_prot->forward_alloc_get)
1393                 return sk->sk_prot->forward_alloc_get(sk);
1394 #endif
1395         return sk->sk_forward_alloc;
1396 }
1397
1398 static inline bool __sk_stream_memory_free(const struct sock *sk, int wake)
1399 {
1400         if (READ_ONCE(sk->sk_wmem_queued) >= READ_ONCE(sk->sk_sndbuf))
1401                 return false;
1402
1403         return sk->sk_prot->stream_memory_free ?
1404                 INDIRECT_CALL_INET_1(sk->sk_prot->stream_memory_free,
1405                                      tcp_stream_memory_free, sk, wake) : true;
1406 }
1407
1408 static inline bool sk_stream_memory_free(const struct sock *sk)
1409 {
1410         return __sk_stream_memory_free(sk, 0);
1411 }
1412
1413 static inline bool __sk_stream_is_writeable(const struct sock *sk, int wake)
1414 {
1415         return sk_stream_wspace(sk) >= sk_stream_min_wspace(sk) &&
1416                __sk_stream_memory_free(sk, wake);
1417 }
1418
1419 static inline bool sk_stream_is_writeable(const struct sock *sk)
1420 {
1421         return __sk_stream_is_writeable(sk, 0);
1422 }
1423
1424 static inline int sk_under_cgroup_hierarchy(struct sock *sk,
1425                                             struct cgroup *ancestor)
1426 {
1427 #ifdef CONFIG_SOCK_CGROUP_DATA
1428         return cgroup_is_descendant(sock_cgroup_ptr(&sk->sk_cgrp_data),
1429                                     ancestor);
1430 #else
1431         return -ENOTSUPP;
1432 #endif
1433 }
1434
1435 static inline bool sk_has_memory_pressure(const struct sock *sk)
1436 {
1437         return sk->sk_prot->memory_pressure != NULL;
1438 }
1439
1440 static inline bool sk_under_memory_pressure(const struct sock *sk)
1441 {
1442         if (!sk->sk_prot->memory_pressure)
1443                 return false;
1444
1445         if (mem_cgroup_sockets_enabled && sk->sk_memcg &&
1446             mem_cgroup_under_socket_pressure(sk->sk_memcg))
1447                 return true;
1448
1449         return !!*sk->sk_prot->memory_pressure;
1450 }
1451
1452 static inline long
1453 proto_memory_allocated(const struct proto *prot)
1454 {
1455         return max(0L, atomic_long_read(prot->memory_allocated));
1456 }
1457
1458 static inline long
1459 sk_memory_allocated(const struct sock *sk)
1460 {
1461         return proto_memory_allocated(sk->sk_prot);
1462 }
1463
1464 /* 1 MB per cpu, in page units */
1465 #define SK_MEMORY_PCPU_RESERVE (1 << (20 - PAGE_SHIFT))
1466
1467 static inline void
1468 sk_memory_allocated_add(struct sock *sk, int amt)
1469 {
1470         int local_reserve;
1471
1472         preempt_disable();
1473         local_reserve = __this_cpu_add_return(*sk->sk_prot->per_cpu_fw_alloc, amt);
1474         if (local_reserve >= SK_MEMORY_PCPU_RESERVE) {
1475                 __this_cpu_sub(*sk->sk_prot->per_cpu_fw_alloc, local_reserve);
1476                 atomic_long_add(local_reserve, sk->sk_prot->memory_allocated);
1477         }
1478         preempt_enable();
1479 }
1480
1481 static inline void
1482 sk_memory_allocated_sub(struct sock *sk, int amt)
1483 {
1484         int local_reserve;
1485
1486         preempt_disable();
1487         local_reserve = __this_cpu_sub_return(*sk->sk_prot->per_cpu_fw_alloc, amt);
1488         if (local_reserve <= -SK_MEMORY_PCPU_RESERVE) {
1489                 __this_cpu_sub(*sk->sk_prot->per_cpu_fw_alloc, local_reserve);
1490                 atomic_long_add(local_reserve, sk->sk_prot->memory_allocated);
1491         }
1492         preempt_enable();
1493 }
1494
1495 #define SK_ALLOC_PERCPU_COUNTER_BATCH 16
1496
1497 static inline void sk_sockets_allocated_dec(struct sock *sk)
1498 {
1499         percpu_counter_add_batch(sk->sk_prot->sockets_allocated, -1,
1500                                  SK_ALLOC_PERCPU_COUNTER_BATCH);
1501 }
1502
1503 static inline void sk_sockets_allocated_inc(struct sock *sk)
1504 {
1505         percpu_counter_add_batch(sk->sk_prot->sockets_allocated, 1,
1506                                  SK_ALLOC_PERCPU_COUNTER_BATCH);
1507 }
1508
1509 static inline u64
1510 sk_sockets_allocated_read_positive(struct sock *sk)
1511 {
1512         return percpu_counter_read_positive(sk->sk_prot->sockets_allocated);
1513 }
1514
1515 static inline int
1516 proto_sockets_allocated_sum_positive(struct proto *prot)
1517 {
1518         return percpu_counter_sum_positive(prot->sockets_allocated);
1519 }
1520
1521 static inline bool
1522 proto_memory_pressure(struct proto *prot)
1523 {
1524         if (!prot->memory_pressure)
1525                 return false;
1526         return !!*prot->memory_pressure;
1527 }
1528
1529
1530 #ifdef CONFIG_PROC_FS
1531 #define PROTO_INUSE_NR  64      /* should be enough for the first time */
1532 struct prot_inuse {
1533         int all;
1534         int val[PROTO_INUSE_NR];
1535 };
1536
1537 static inline void sock_prot_inuse_add(const struct net *net,
1538                                        const struct proto *prot, int val)
1539 {
1540         this_cpu_add(net->core.prot_inuse->val[prot->inuse_idx], val);
1541 }
1542
1543 static inline void sock_inuse_add(const struct net *net, int val)
1544 {
1545         this_cpu_add(net->core.prot_inuse->all, val);
1546 }
1547
1548 int sock_prot_inuse_get(struct net *net, struct proto *proto);
1549 int sock_inuse_get(struct net *net);
1550 #else
1551 static inline void sock_prot_inuse_add(const struct net *net,
1552                                        const struct proto *prot, int val)
1553 {
1554 }
1555
1556 static inline void sock_inuse_add(const struct net *net, int val)
1557 {
1558 }
1559 #endif
1560
1561
1562 /* With per-bucket locks this operation is not-atomic, so that
1563  * this version is not worse.
1564  */
1565 static inline int __sk_prot_rehash(struct sock *sk)
1566 {
1567         sk->sk_prot->unhash(sk);
1568         return sk->sk_prot->hash(sk);
1569 }
1570
1571 /* About 10 seconds */
1572 #define SOCK_DESTROY_TIME (10*HZ)
1573
1574 /* Sockets 0-1023 can't be bound to unless you are superuser */
1575 #define PROT_SOCK       1024
1576
1577 #define SHUTDOWN_MASK   3
1578 #define RCV_SHUTDOWN    1
1579 #define SEND_SHUTDOWN   2
1580
1581 #define SOCK_BINDADDR_LOCK      4
1582 #define SOCK_BINDPORT_LOCK      8
1583
1584 struct socket_alloc {
1585         struct socket socket;
1586         struct inode vfs_inode;
1587 };
1588
1589 static inline struct socket *SOCKET_I(struct inode *inode)
1590 {
1591         return &container_of(inode, struct socket_alloc, vfs_inode)->socket;
1592 }
1593
1594 static inline struct inode *SOCK_INODE(struct socket *socket)
1595 {
1596         return &container_of(socket, struct socket_alloc, socket)->vfs_inode;
1597 }
1598
1599 /*
1600  * Functions for memory accounting
1601  */
1602 int __sk_mem_raise_allocated(struct sock *sk, int size, int amt, int kind);
1603 int __sk_mem_schedule(struct sock *sk, int size, int kind);
1604 void __sk_mem_reduce_allocated(struct sock *sk, int amount);
1605 void __sk_mem_reclaim(struct sock *sk, int amount);
1606
1607 #define SK_MEM_SEND     0
1608 #define SK_MEM_RECV     1
1609
1610 /* sysctl_mem values are in pages */
1611 static inline long sk_prot_mem_limits(const struct sock *sk, int index)
1612 {
1613         return READ_ONCE(sk->sk_prot->sysctl_mem[index]);
1614 }
1615
1616 static inline int sk_mem_pages(int amt)
1617 {
1618         return (amt + PAGE_SIZE - 1) >> PAGE_SHIFT;
1619 }
1620
1621 static inline bool sk_has_account(struct sock *sk)
1622 {
1623         /* return true if protocol supports memory accounting */
1624         return !!sk->sk_prot->memory_allocated;
1625 }
1626
1627 static inline bool sk_wmem_schedule(struct sock *sk, int size)
1628 {
1629         int delta;
1630
1631         if (!sk_has_account(sk))
1632                 return true;
1633         delta = size - sk->sk_forward_alloc;
1634         return delta <= 0 || __sk_mem_schedule(sk, delta, SK_MEM_SEND);
1635 }
1636
1637 static inline bool
1638 sk_rmem_schedule(struct sock *sk, struct sk_buff *skb, int size)
1639 {
1640         int delta;
1641
1642         if (!sk_has_account(sk))
1643                 return true;
1644         delta = size - sk->sk_forward_alloc;
1645         return delta <= 0 || __sk_mem_schedule(sk, delta, SK_MEM_RECV) ||
1646                 skb_pfmemalloc(skb);
1647 }
1648
1649 static inline int sk_unused_reserved_mem(const struct sock *sk)
1650 {
1651         int unused_mem;
1652
1653         if (likely(!sk->sk_reserved_mem))
1654                 return 0;
1655
1656         unused_mem = sk->sk_reserved_mem - sk->sk_wmem_queued -
1657                         atomic_read(&sk->sk_rmem_alloc);
1658
1659         return unused_mem > 0 ? unused_mem : 0;
1660 }
1661
1662 static inline void sk_mem_reclaim(struct sock *sk)
1663 {
1664         int reclaimable;
1665
1666         if (!sk_has_account(sk))
1667                 return;
1668
1669         reclaimable = sk->sk_forward_alloc - sk_unused_reserved_mem(sk);
1670
1671         if (reclaimable >= (int)PAGE_SIZE)
1672                 __sk_mem_reclaim(sk, reclaimable);
1673 }
1674
1675 static inline void sk_mem_reclaim_final(struct sock *sk)
1676 {
1677         sk->sk_reserved_mem = 0;
1678         sk_mem_reclaim(sk);
1679 }
1680
1681 static inline void sk_mem_charge(struct sock *sk, int size)
1682 {
1683         if (!sk_has_account(sk))
1684                 return;
1685         sk->sk_forward_alloc -= size;
1686 }
1687
1688 static inline void sk_mem_uncharge(struct sock *sk, int size)
1689 {
1690         if (!sk_has_account(sk))
1691                 return;
1692         sk->sk_forward_alloc += size;
1693         sk_mem_reclaim(sk);
1694 }
1695
1696 /*
1697  * Macro so as to not evaluate some arguments when
1698  * lockdep is not enabled.
1699  *
1700  * Mark both the sk_lock and the sk_lock.slock as a
1701  * per-address-family lock class.
1702  */
1703 #define sock_lock_init_class_and_name(sk, sname, skey, name, key)       \
1704 do {                                                                    \
1705         sk->sk_lock.owned = 0;                                          \
1706         init_waitqueue_head(&sk->sk_lock.wq);                           \
1707         spin_lock_init(&(sk)->sk_lock.slock);                           \
1708         debug_check_no_locks_freed((void *)&(sk)->sk_lock,              \
1709                         sizeof((sk)->sk_lock));                         \
1710         lockdep_set_class_and_name(&(sk)->sk_lock.slock,                \
1711                                 (skey), (sname));                               \
1712         lockdep_init_map(&(sk)->sk_lock.dep_map, (name), (key), 0);     \
1713 } while (0)
1714
1715 static inline bool lockdep_sock_is_held(const struct sock *sk)
1716 {
1717         return lockdep_is_held(&sk->sk_lock) ||
1718                lockdep_is_held(&sk->sk_lock.slock);
1719 }
1720
1721 void lock_sock_nested(struct sock *sk, int subclass);
1722
1723 static inline void lock_sock(struct sock *sk)
1724 {
1725         lock_sock_nested(sk, 0);
1726 }
1727
1728 void __lock_sock(struct sock *sk);
1729 void __release_sock(struct sock *sk);
1730 void release_sock(struct sock *sk);
1731
1732 /* BH context may only use the following locking interface. */
1733 #define bh_lock_sock(__sk)      spin_lock(&((__sk)->sk_lock.slock))
1734 #define bh_lock_sock_nested(__sk) \
1735                                 spin_lock_nested(&((__sk)->sk_lock.slock), \
1736                                 SINGLE_DEPTH_NESTING)
1737 #define bh_unlock_sock(__sk)    spin_unlock(&((__sk)->sk_lock.slock))
1738
1739 bool __lock_sock_fast(struct sock *sk) __acquires(&sk->sk_lock.slock);
1740
1741 /**
1742  * lock_sock_fast - fast version of lock_sock
1743  * @sk: socket
1744  *
1745  * This version should be used for very small section, where process wont block
1746  * return false if fast path is taken:
1747  *
1748  *   sk_lock.slock locked, owned = 0, BH disabled
1749  *
1750  * return true if slow path is taken:
1751  *
1752  *   sk_lock.slock unlocked, owned = 1, BH enabled
1753  */
1754 static inline bool lock_sock_fast(struct sock *sk)
1755 {
1756         /* The sk_lock has mutex_lock() semantics here. */
1757         mutex_acquire(&sk->sk_lock.dep_map, 0, 0, _RET_IP_);
1758
1759         return __lock_sock_fast(sk);
1760 }
1761
1762 /* fast socket lock variant for caller already holding a [different] socket lock */
1763 static inline bool lock_sock_fast_nested(struct sock *sk)
1764 {
1765         mutex_acquire(&sk->sk_lock.dep_map, SINGLE_DEPTH_NESTING, 0, _RET_IP_);
1766
1767         return __lock_sock_fast(sk);
1768 }
1769
1770 /**
1771  * unlock_sock_fast - complement of lock_sock_fast
1772  * @sk: socket
1773  * @slow: slow mode
1774  *
1775  * fast unlock socket for user context.
1776  * If slow mode is on, we call regular release_sock()
1777  */
1778 static inline void unlock_sock_fast(struct sock *sk, bool slow)
1779         __releases(&sk->sk_lock.slock)
1780 {
1781         if (slow) {
1782                 release_sock(sk);
1783                 __release(&sk->sk_lock.slock);
1784         } else {
1785                 mutex_release(&sk->sk_lock.dep_map, _RET_IP_);
1786                 spin_unlock_bh(&sk->sk_lock.slock);
1787         }
1788 }
1789
1790 void sockopt_lock_sock(struct sock *sk);
1791 void sockopt_release_sock(struct sock *sk);
1792 bool sockopt_ns_capable(struct user_namespace *ns, int cap);
1793 bool sockopt_capable(int cap);
1794
1795 /* Used by processes to "lock" a socket state, so that
1796  * interrupts and bottom half handlers won't change it
1797  * from under us. It essentially blocks any incoming
1798  * packets, so that we won't get any new data or any
1799  * packets that change the state of the socket.
1800  *
1801  * While locked, BH processing will add new packets to
1802  * the backlog queue.  This queue is processed by the
1803  * owner of the socket lock right before it is released.
1804  *
1805  * Since ~2.3.5 it is also exclusive sleep lock serializing
1806  * accesses from user process context.
1807  */
1808
1809 static inline void sock_owned_by_me(const struct sock *sk)
1810 {
1811 #ifdef CONFIG_LOCKDEP
1812         WARN_ON_ONCE(!lockdep_sock_is_held(sk) && debug_locks);
1813 #endif
1814 }
1815
1816 static inline bool sock_owned_by_user(const struct sock *sk)
1817 {
1818         sock_owned_by_me(sk);
1819         return sk->sk_lock.owned;
1820 }
1821
1822 static inline bool sock_owned_by_user_nocheck(const struct sock *sk)
1823 {
1824         return sk->sk_lock.owned;
1825 }
1826
1827 static inline void sock_release_ownership(struct sock *sk)
1828 {
1829         if (sock_owned_by_user_nocheck(sk)) {
1830                 sk->sk_lock.owned = 0;
1831
1832                 /* The sk_lock has mutex_unlock() semantics: */
1833                 mutex_release(&sk->sk_lock.dep_map, _RET_IP_);
1834         }
1835 }
1836
1837 /* no reclassification while locks are held */
1838 static inline bool sock_allow_reclassification(const struct sock *csk)
1839 {
1840         struct sock *sk = (struct sock *)csk;
1841
1842         return !sock_owned_by_user_nocheck(sk) &&
1843                 !spin_is_locked(&sk->sk_lock.slock);
1844 }
1845
1846 struct sock *sk_alloc(struct net *net, int family, gfp_t priority,
1847                       struct proto *prot, int kern);
1848 void sk_free(struct sock *sk);
1849 void sk_destruct(struct sock *sk);
1850 struct sock *sk_clone_lock(const struct sock *sk, const gfp_t priority);
1851 void sk_free_unlock_clone(struct sock *sk);
1852
1853 struct sk_buff *sock_wmalloc(struct sock *sk, unsigned long size, int force,
1854                              gfp_t priority);
1855 void __sock_wfree(struct sk_buff *skb);
1856 void sock_wfree(struct sk_buff *skb);
1857 struct sk_buff *sock_omalloc(struct sock *sk, unsigned long size,
1858                              gfp_t priority);
1859 void skb_orphan_partial(struct sk_buff *skb);
1860 void sock_rfree(struct sk_buff *skb);
1861 void sock_efree(struct sk_buff *skb);
1862 #ifdef CONFIG_INET
1863 void sock_edemux(struct sk_buff *skb);
1864 void sock_pfree(struct sk_buff *skb);
1865 #else
1866 #define sock_edemux sock_efree
1867 #endif
1868
1869 int sk_setsockopt(struct sock *sk, int level, int optname,
1870                   sockptr_t optval, unsigned int optlen);
1871 int sock_setsockopt(struct socket *sock, int level, int op,
1872                     sockptr_t optval, unsigned int optlen);
1873
1874 int sk_getsockopt(struct sock *sk, int level, int optname,
1875                   sockptr_t optval, sockptr_t optlen);
1876 int sock_getsockopt(struct socket *sock, int level, int op,
1877                     char __user *optval, int __user *optlen);
1878 int sock_gettstamp(struct socket *sock, void __user *userstamp,
1879                    bool timeval, bool time32);
1880 struct sk_buff *sock_alloc_send_pskb(struct sock *sk, unsigned long header_len,
1881                                      unsigned long data_len, int noblock,
1882                                      int *errcode, int max_page_order);
1883
1884 static inline struct sk_buff *sock_alloc_send_skb(struct sock *sk,
1885                                                   unsigned long size,
1886                                                   int noblock, int *errcode)
1887 {
1888         return sock_alloc_send_pskb(sk, size, 0, noblock, errcode, 0);
1889 }
1890
1891 void *sock_kmalloc(struct sock *sk, int size, gfp_t priority);
1892 void sock_kfree_s(struct sock *sk, void *mem, int size);
1893 void sock_kzfree_s(struct sock *sk, void *mem, int size);
1894 void sk_send_sigurg(struct sock *sk);
1895
1896 static inline void sock_replace_proto(struct sock *sk, struct proto *proto)
1897 {
1898         if (sk->sk_socket)
1899                 clear_bit(SOCK_SUPPORT_ZC, &sk->sk_socket->flags);
1900         WRITE_ONCE(sk->sk_prot, proto);
1901 }
1902
1903 struct sockcm_cookie {
1904         u64 transmit_time;
1905         u32 mark;
1906         u16 tsflags;
1907 };
1908
1909 static inline void sockcm_init(struct sockcm_cookie *sockc,
1910                                const struct sock *sk)
1911 {
1912         *sockc = (struct sockcm_cookie) { .tsflags = sk->sk_tsflags };
1913 }
1914
1915 int __sock_cmsg_send(struct sock *sk, struct msghdr *msg, struct cmsghdr *cmsg,
1916                      struct sockcm_cookie *sockc);
1917 int sock_cmsg_send(struct sock *sk, struct msghdr *msg,
1918                    struct sockcm_cookie *sockc);
1919
1920 /*
1921  * Functions to fill in entries in struct proto_ops when a protocol
1922  * does not implement a particular function.
1923  */
1924 int sock_no_bind(struct socket *, struct sockaddr *, int);
1925 int sock_no_connect(struct socket *, struct sockaddr *, int, int);
1926 int sock_no_socketpair(struct socket *, struct socket *);
1927 int sock_no_accept(struct socket *, struct socket *, int, bool);
1928 int sock_no_getname(struct socket *, struct sockaddr *, int);
1929 int sock_no_ioctl(struct socket *, unsigned int, unsigned long);
1930 int sock_no_listen(struct socket *, int);
1931 int sock_no_shutdown(struct socket *, int);
1932 int sock_no_sendmsg(struct socket *, struct msghdr *, size_t);
1933 int sock_no_sendmsg_locked(struct sock *sk, struct msghdr *msg, size_t len);
1934 int sock_no_recvmsg(struct socket *, struct msghdr *, size_t, int);
1935 int sock_no_mmap(struct file *file, struct socket *sock,
1936                  struct vm_area_struct *vma);
1937 ssize_t sock_no_sendpage(struct socket *sock, struct page *page, int offset,
1938                          size_t size, int flags);
1939 ssize_t sock_no_sendpage_locked(struct sock *sk, struct page *page,
1940                                 int offset, size_t size, int flags);
1941
1942 /*
1943  * Functions to fill in entries in struct proto_ops when a protocol
1944  * uses the inet style.
1945  */
1946 int sock_common_getsockopt(struct socket *sock, int level, int optname,
1947                                   char __user *optval, int __user *optlen);
1948 int sock_common_recvmsg(struct socket *sock, struct msghdr *msg, size_t size,
1949                         int flags);
1950 int sock_common_setsockopt(struct socket *sock, int level, int optname,
1951                            sockptr_t optval, unsigned int optlen);
1952
1953 void sk_common_release(struct sock *sk);
1954
1955 /*
1956  *      Default socket callbacks and setup code
1957  */
1958
1959 /* Initialise core socket variables using an explicit uid. */
1960 void sock_init_data_uid(struct socket *sock, struct sock *sk, kuid_t uid);
1961
1962 /* Initialise core socket variables.
1963  * Assumes struct socket *sock is embedded in a struct socket_alloc.
1964  */
1965 void sock_init_data(struct socket *sock, struct sock *sk);
1966
1967 /*
1968  * Socket reference counting postulates.
1969  *
1970  * * Each user of socket SHOULD hold a reference count.
1971  * * Each access point to socket (an hash table bucket, reference from a list,
1972  *   running timer, skb in flight MUST hold a reference count.
1973  * * When reference count hits 0, it means it will never increase back.
1974  * * When reference count hits 0, it means that no references from
1975  *   outside exist to this socket and current process on current CPU
1976  *   is last user and may/should destroy this socket.
1977  * * sk_free is called from any context: process, BH, IRQ. When
1978  *   it is called, socket has no references from outside -> sk_free
1979  *   may release descendant resources allocated by the socket, but
1980  *   to the time when it is called, socket is NOT referenced by any
1981  *   hash tables, lists etc.
1982  * * Packets, delivered from outside (from network or from another process)
1983  *   and enqueued on receive/error queues SHOULD NOT grab reference count,
1984  *   when they sit in queue. Otherwise, packets will leak to hole, when
1985  *   socket is looked up by one cpu and unhasing is made by another CPU.
1986  *   It is true for udp/raw, netlink (leak to receive and error queues), tcp
1987  *   (leak to backlog). Packet socket does all the processing inside
1988  *   BR_NETPROTO_LOCK, so that it has not this race condition. UNIX sockets
1989  *   use separate SMP lock, so that they are prone too.
1990  */
1991
1992 /* Ungrab socket and destroy it, if it was the last reference. */
1993 static inline void sock_put(struct sock *sk)
1994 {
1995         if (refcount_dec_and_test(&sk->sk_refcnt))
1996                 sk_free(sk);
1997 }
1998 /* Generic version of sock_put(), dealing with all sockets
1999  * (TCP_TIMEWAIT, TCP_NEW_SYN_RECV, ESTABLISHED...)
2000  */
2001 void sock_gen_put(struct sock *sk);
2002
2003 int __sk_receive_skb(struct sock *sk, struct sk_buff *skb, const int nested,
2004                      unsigned int trim_cap, bool refcounted);
2005 static inline int sk_receive_skb(struct sock *sk, struct sk_buff *skb,
2006                                  const int nested)
2007 {
2008         return __sk_receive_skb(sk, skb, nested, 1, true);
2009 }
2010
2011 static inline void sk_tx_queue_set(struct sock *sk, int tx_queue)
2012 {
2013         /* sk_tx_queue_mapping accept only upto a 16-bit value */
2014         if (WARN_ON_ONCE((unsigned short)tx_queue >= USHRT_MAX))
2015                 return;
2016         sk->sk_tx_queue_mapping = tx_queue;
2017 }
2018
2019 #define NO_QUEUE_MAPPING        USHRT_MAX
2020
2021 static inline void sk_tx_queue_clear(struct sock *sk)
2022 {
2023         sk->sk_tx_queue_mapping = NO_QUEUE_MAPPING;
2024 }
2025
2026 static inline int sk_tx_queue_get(const struct sock *sk)
2027 {
2028         if (sk && sk->sk_tx_queue_mapping != NO_QUEUE_MAPPING)
2029                 return sk->sk_tx_queue_mapping;
2030
2031         return -1;
2032 }
2033
2034 static inline void __sk_rx_queue_set(struct sock *sk,
2035                                      const struct sk_buff *skb,
2036                                      bool force_set)
2037 {
2038 #ifdef CONFIG_SOCK_RX_QUEUE_MAPPING
2039         if (skb_rx_queue_recorded(skb)) {
2040                 u16 rx_queue = skb_get_rx_queue(skb);
2041
2042                 if (force_set ||
2043                     unlikely(READ_ONCE(sk->sk_rx_queue_mapping) != rx_queue))
2044                         WRITE_ONCE(sk->sk_rx_queue_mapping, rx_queue);
2045         }
2046 #endif
2047 }
2048
2049 static inline void sk_rx_queue_set(struct sock *sk, const struct sk_buff *skb)
2050 {
2051         __sk_rx_queue_set(sk, skb, true);
2052 }
2053
2054 static inline void sk_rx_queue_update(struct sock *sk, const struct sk_buff *skb)
2055 {
2056         __sk_rx_queue_set(sk, skb, false);
2057 }
2058
2059 static inline void sk_rx_queue_clear(struct sock *sk)
2060 {
2061 #ifdef CONFIG_SOCK_RX_QUEUE_MAPPING
2062         WRITE_ONCE(sk->sk_rx_queue_mapping, NO_QUEUE_MAPPING);
2063 #endif
2064 }
2065
2066 static inline int sk_rx_queue_get(const struct sock *sk)
2067 {
2068 #ifdef CONFIG_SOCK_RX_QUEUE_MAPPING
2069         if (sk) {
2070                 int res = READ_ONCE(sk->sk_rx_queue_mapping);
2071
2072                 if (res != NO_QUEUE_MAPPING)
2073                         return res;
2074         }
2075 #endif
2076
2077         return -1;
2078 }
2079
2080 static inline void sk_set_socket(struct sock *sk, struct socket *sock)
2081 {
2082         sk->sk_socket = sock;
2083 }
2084
2085 static inline wait_queue_head_t *sk_sleep(struct sock *sk)
2086 {
2087         BUILD_BUG_ON(offsetof(struct socket_wq, wait) != 0);
2088         return &rcu_dereference_raw(sk->sk_wq)->wait;
2089 }
2090 /* Detach socket from process context.
2091  * Announce socket dead, detach it from wait queue and inode.
2092  * Note that parent inode held reference count on this struct sock,
2093  * we do not release it in this function, because protocol
2094  * probably wants some additional cleanups or even continuing
2095  * to work with this socket (TCP).
2096  */
2097 static inline void sock_orphan(struct sock *sk)
2098 {
2099         write_lock_bh(&sk->sk_callback_lock);
2100         sock_set_flag(sk, SOCK_DEAD);
2101         sk_set_socket(sk, NULL);
2102         sk->sk_wq  = NULL;
2103         write_unlock_bh(&sk->sk_callback_lock);
2104 }
2105
2106 static inline void sock_graft(struct sock *sk, struct socket *parent)
2107 {
2108         WARN_ON(parent->sk);
2109         write_lock_bh(&sk->sk_callback_lock);
2110         rcu_assign_pointer(sk->sk_wq, &parent->wq);
2111         parent->sk = sk;
2112         sk_set_socket(sk, parent);
2113         sk->sk_uid = SOCK_INODE(parent)->i_uid;
2114         security_sock_graft(sk, parent);
2115         write_unlock_bh(&sk->sk_callback_lock);
2116 }
2117
2118 kuid_t sock_i_uid(struct sock *sk);
2119 unsigned long sock_i_ino(struct sock *sk);
2120
2121 static inline kuid_t sock_net_uid(const struct net *net, const struct sock *sk)
2122 {
2123         return sk ? sk->sk_uid : make_kuid(net->user_ns, 0);
2124 }
2125
2126 static inline u32 net_tx_rndhash(void)
2127 {
2128         u32 v = get_random_u32();
2129
2130         return v ?: 1;
2131 }
2132
2133 static inline void sk_set_txhash(struct sock *sk)
2134 {
2135         /* This pairs with READ_ONCE() in skb_set_hash_from_sk() */
2136         WRITE_ONCE(sk->sk_txhash, net_tx_rndhash());
2137 }
2138
2139 static inline bool sk_rethink_txhash(struct sock *sk)
2140 {
2141         if (sk->sk_txhash && sk->sk_txrehash == SOCK_TXREHASH_ENABLED) {
2142                 sk_set_txhash(sk);
2143                 return true;
2144         }
2145         return false;
2146 }
2147
2148 static inline struct dst_entry *
2149 __sk_dst_get(struct sock *sk)
2150 {
2151         return rcu_dereference_check(sk->sk_dst_cache,
2152                                      lockdep_sock_is_held(sk));
2153 }
2154
2155 static inline struct dst_entry *
2156 sk_dst_get(struct sock *sk)
2157 {
2158         struct dst_entry *dst;
2159
2160         rcu_read_lock();
2161         dst = rcu_dereference(sk->sk_dst_cache);
2162         if (dst && !atomic_inc_not_zero(&dst->__refcnt))
2163                 dst = NULL;
2164         rcu_read_unlock();
2165         return dst;
2166 }
2167
2168 static inline void __dst_negative_advice(struct sock *sk)
2169 {
2170         struct dst_entry *ndst, *dst = __sk_dst_get(sk);
2171
2172         if (dst && dst->ops->negative_advice) {
2173                 ndst = dst->ops->negative_advice(dst);
2174
2175                 if (ndst != dst) {
2176                         rcu_assign_pointer(sk->sk_dst_cache, ndst);
2177                         sk_tx_queue_clear(sk);
2178                         sk->sk_dst_pending_confirm = 0;
2179                 }
2180         }
2181 }
2182
2183 static inline void dst_negative_advice(struct sock *sk)
2184 {
2185         sk_rethink_txhash(sk);
2186         __dst_negative_advice(sk);
2187 }
2188
2189 static inline void
2190 __sk_dst_set(struct sock *sk, struct dst_entry *dst)
2191 {
2192         struct dst_entry *old_dst;
2193
2194         sk_tx_queue_clear(sk);
2195         sk->sk_dst_pending_confirm = 0;
2196         old_dst = rcu_dereference_protected(sk->sk_dst_cache,
2197                                             lockdep_sock_is_held(sk));
2198         rcu_assign_pointer(sk->sk_dst_cache, dst);
2199         dst_release(old_dst);
2200 }
2201
2202 static inline void
2203 sk_dst_set(struct sock *sk, struct dst_entry *dst)
2204 {
2205         struct dst_entry *old_dst;
2206
2207         sk_tx_queue_clear(sk);
2208         sk->sk_dst_pending_confirm = 0;
2209         old_dst = xchg((__force struct dst_entry **)&sk->sk_dst_cache, dst);
2210         dst_release(old_dst);
2211 }
2212
2213 static inline void
2214 __sk_dst_reset(struct sock *sk)
2215 {
2216         __sk_dst_set(sk, NULL);
2217 }
2218
2219 static inline void
2220 sk_dst_reset(struct sock *sk)
2221 {
2222         sk_dst_set(sk, NULL);
2223 }
2224
2225 struct dst_entry *__sk_dst_check(struct sock *sk, u32 cookie);
2226
2227 struct dst_entry *sk_dst_check(struct sock *sk, u32 cookie);
2228
2229 static inline void sk_dst_confirm(struct sock *sk)
2230 {
2231         if (!READ_ONCE(sk->sk_dst_pending_confirm))
2232                 WRITE_ONCE(sk->sk_dst_pending_confirm, 1);
2233 }
2234
2235 static inline void sock_confirm_neigh(struct sk_buff *skb, struct neighbour *n)
2236 {
2237         if (skb_get_dst_pending_confirm(skb)) {
2238                 struct sock *sk = skb->sk;
2239
2240                 if (sk && READ_ONCE(sk->sk_dst_pending_confirm))
2241                         WRITE_ONCE(sk->sk_dst_pending_confirm, 0);
2242                 neigh_confirm(n);
2243         }
2244 }
2245
2246 bool sk_mc_loop(struct sock *sk);
2247
2248 static inline bool sk_can_gso(const struct sock *sk)
2249 {
2250         return net_gso_ok(sk->sk_route_caps, sk->sk_gso_type);
2251 }
2252
2253 void sk_setup_caps(struct sock *sk, struct dst_entry *dst);
2254
2255 static inline void sk_gso_disable(struct sock *sk)
2256 {
2257         sk->sk_gso_disabled = 1;
2258         sk->sk_route_caps &= ~NETIF_F_GSO_MASK;
2259 }
2260
2261 static inline int skb_do_copy_data_nocache(struct sock *sk, struct sk_buff *skb,
2262                                            struct iov_iter *from, char *to,
2263                                            int copy, int offset)
2264 {
2265         if (skb->ip_summed == CHECKSUM_NONE) {
2266                 __wsum csum = 0;
2267                 if (!csum_and_copy_from_iter_full(to, copy, &csum, from))
2268                         return -EFAULT;
2269                 skb->csum = csum_block_add(skb->csum, csum, offset);
2270         } else if (sk->sk_route_caps & NETIF_F_NOCACHE_COPY) {
2271                 if (!copy_from_iter_full_nocache(to, copy, from))
2272                         return -EFAULT;
2273         } else if (!copy_from_iter_full(to, copy, from))
2274                 return -EFAULT;
2275
2276         return 0;
2277 }
2278
2279 static inline int skb_add_data_nocache(struct sock *sk, struct sk_buff *skb,
2280                                        struct iov_iter *from, int copy)
2281 {
2282         int err, offset = skb->len;
2283
2284         err = skb_do_copy_data_nocache(sk, skb, from, skb_put(skb, copy),
2285                                        copy, offset);
2286         if (err)
2287                 __skb_trim(skb, offset);
2288
2289         return err;
2290 }
2291
2292 static inline int skb_copy_to_page_nocache(struct sock *sk, struct iov_iter *from,
2293                                            struct sk_buff *skb,
2294                                            struct page *page,
2295                                            int off, int copy)
2296 {
2297         int err;
2298
2299         err = skb_do_copy_data_nocache(sk, skb, from, page_address(page) + off,
2300                                        copy, skb->len);
2301         if (err)
2302                 return err;
2303
2304         skb_len_add(skb, copy);
2305         sk_wmem_queued_add(sk, copy);
2306         sk_mem_charge(sk, copy);
2307         return 0;
2308 }
2309
2310 /**
2311  * sk_wmem_alloc_get - returns write allocations
2312  * @sk: socket
2313  *
2314  * Return: sk_wmem_alloc minus initial offset of one
2315  */
2316 static inline int sk_wmem_alloc_get(const struct sock *sk)
2317 {
2318         return refcount_read(&sk->sk_wmem_alloc) - 1;
2319 }
2320
2321 /**
2322  * sk_rmem_alloc_get - returns read allocations
2323  * @sk: socket
2324  *
2325  * Return: sk_rmem_alloc
2326  */
2327 static inline int sk_rmem_alloc_get(const struct sock *sk)
2328 {
2329         return atomic_read(&sk->sk_rmem_alloc);
2330 }
2331
2332 /**
2333  * sk_has_allocations - check if allocations are outstanding
2334  * @sk: socket
2335  *
2336  * Return: true if socket has write or read allocations
2337  */
2338 static inline bool sk_has_allocations(const struct sock *sk)
2339 {
2340         return sk_wmem_alloc_get(sk) || sk_rmem_alloc_get(sk);
2341 }
2342
2343 /**
2344  * skwq_has_sleeper - check if there are any waiting processes
2345  * @wq: struct socket_wq
2346  *
2347  * Return: true if socket_wq has waiting processes
2348  *
2349  * The purpose of the skwq_has_sleeper and sock_poll_wait is to wrap the memory
2350  * barrier call. They were added due to the race found within the tcp code.
2351  *
2352  * Consider following tcp code paths::
2353  *
2354  *   CPU1                CPU2
2355  *   sys_select          receive packet
2356  *   ...                 ...
2357  *   __add_wait_queue    update tp->rcv_nxt
2358  *   ...                 ...
2359  *   tp->rcv_nxt check   sock_def_readable
2360  *   ...                 {
2361  *   schedule               rcu_read_lock();
2362  *                          wq = rcu_dereference(sk->sk_wq);
2363  *                          if (wq && waitqueue_active(&wq->wait))
2364  *                              wake_up_interruptible(&wq->wait)
2365  *                          ...
2366  *                       }
2367  *
2368  * The race for tcp fires when the __add_wait_queue changes done by CPU1 stay
2369  * in its cache, and so does the tp->rcv_nxt update on CPU2 side.  The CPU1
2370  * could then endup calling schedule and sleep forever if there are no more
2371  * data on the socket.
2372  *
2373  */
2374 static inline bool skwq_has_sleeper(struct socket_wq *wq)
2375 {
2376         return wq && wq_has_sleeper(&wq->wait);
2377 }
2378
2379 /**
2380  * sock_poll_wait - place memory barrier behind the poll_wait call.
2381  * @filp:           file
2382  * @sock:           socket to wait on
2383  * @p:              poll_table
2384  *
2385  * See the comments in the wq_has_sleeper function.
2386  */
2387 static inline void sock_poll_wait(struct file *filp, struct socket *sock,
2388                                   poll_table *p)
2389 {
2390         if (!poll_does_not_wait(p)) {
2391                 poll_wait(filp, &sock->wq.wait, p);
2392                 /* We need to be sure we are in sync with the
2393                  * socket flags modification.
2394                  *
2395                  * This memory barrier is paired in the wq_has_sleeper.
2396                  */
2397                 smp_mb();
2398         }
2399 }
2400
2401 static inline void skb_set_hash_from_sk(struct sk_buff *skb, struct sock *sk)
2402 {
2403         /* This pairs with WRITE_ONCE() in sk_set_txhash() */
2404         u32 txhash = READ_ONCE(sk->sk_txhash);
2405
2406         if (txhash) {
2407                 skb->l4_hash = 1;
2408                 skb->hash = txhash;
2409         }
2410 }
2411
2412 void skb_set_owner_w(struct sk_buff *skb, struct sock *sk);
2413
2414 /*
2415  *      Queue a received datagram if it will fit. Stream and sequenced
2416  *      protocols can't normally use this as they need to fit buffers in
2417  *      and play with them.
2418  *
2419  *      Inlined as it's very short and called for pretty much every
2420  *      packet ever received.
2421  */
2422 static inline void skb_set_owner_r(struct sk_buff *skb, struct sock *sk)
2423 {
2424         skb_orphan(skb);
2425         skb->sk = sk;
2426         skb->destructor = sock_rfree;
2427         atomic_add(skb->truesize, &sk->sk_rmem_alloc);
2428         sk_mem_charge(sk, skb->truesize);
2429 }
2430
2431 static inline __must_check bool skb_set_owner_sk_safe(struct sk_buff *skb, struct sock *sk)
2432 {
2433         if (sk && refcount_inc_not_zero(&sk->sk_refcnt)) {
2434                 skb_orphan(skb);
2435                 skb->destructor = sock_efree;
2436                 skb->sk = sk;
2437                 return true;
2438         }
2439         return false;
2440 }
2441
2442 static inline struct sk_buff *skb_clone_and_charge_r(struct sk_buff *skb, struct sock *sk)
2443 {
2444         skb = skb_clone(skb, sk_gfp_mask(sk, GFP_ATOMIC));
2445         if (skb) {
2446                 if (sk_rmem_schedule(sk, skb, skb->truesize)) {
2447                         skb_set_owner_r(skb, sk);
2448                         return skb;
2449                 }
2450                 __kfree_skb(skb);
2451         }
2452         return NULL;
2453 }
2454
2455 static inline void skb_prepare_for_gro(struct sk_buff *skb)
2456 {
2457         if (skb->destructor != sock_wfree) {
2458                 skb_orphan(skb);
2459                 return;
2460         }
2461         skb->slow_gro = 1;
2462 }
2463
2464 void sk_reset_timer(struct sock *sk, struct timer_list *timer,
2465                     unsigned long expires);
2466
2467 void sk_stop_timer(struct sock *sk, struct timer_list *timer);
2468
2469 void sk_stop_timer_sync(struct sock *sk, struct timer_list *timer);
2470
2471 int __sk_queue_drop_skb(struct sock *sk, struct sk_buff_head *sk_queue,
2472                         struct sk_buff *skb, unsigned int flags,
2473                         void (*destructor)(struct sock *sk,
2474                                            struct sk_buff *skb));
2475 int __sock_queue_rcv_skb(struct sock *sk, struct sk_buff *skb);
2476
2477 int sock_queue_rcv_skb_reason(struct sock *sk, struct sk_buff *skb,
2478                               enum skb_drop_reason *reason);
2479
2480 static inline int sock_queue_rcv_skb(struct sock *sk, struct sk_buff *skb)
2481 {
2482         return sock_queue_rcv_skb_reason(sk, skb, NULL);
2483 }
2484
2485 int sock_queue_err_skb(struct sock *sk, struct sk_buff *skb);
2486 struct sk_buff *sock_dequeue_err_skb(struct sock *sk);
2487
2488 /*
2489  *      Recover an error report and clear atomically
2490  */
2491
2492 static inline int sock_error(struct sock *sk)
2493 {
2494         int err;
2495
2496         /* Avoid an atomic operation for the common case.
2497          * This is racy since another cpu/thread can change sk_err under us.
2498          */
2499         if (likely(data_race(!sk->sk_err)))
2500                 return 0;
2501
2502         err = xchg(&sk->sk_err, 0);
2503         return -err;
2504 }
2505
2506 void sk_error_report(struct sock *sk);
2507
2508 static inline unsigned long sock_wspace(struct sock *sk)
2509 {
2510         int amt = 0;
2511
2512         if (!(sk->sk_shutdown & SEND_SHUTDOWN)) {
2513                 amt = sk->sk_sndbuf - refcount_read(&sk->sk_wmem_alloc);
2514                 if (amt < 0)
2515                         amt = 0;
2516         }
2517         return amt;
2518 }
2519
2520 /* Note:
2521  *  We use sk->sk_wq_raw, from contexts knowing this
2522  *  pointer is not NULL and cannot disappear/change.
2523  */
2524 static inline void sk_set_bit(int nr, struct sock *sk)
2525 {
2526         if ((nr == SOCKWQ_ASYNC_NOSPACE || nr == SOCKWQ_ASYNC_WAITDATA) &&
2527             !sock_flag(sk, SOCK_FASYNC))
2528                 return;
2529
2530         set_bit(nr, &sk->sk_wq_raw->flags);
2531 }
2532
2533 static inline void sk_clear_bit(int nr, struct sock *sk)
2534 {
2535         if ((nr == SOCKWQ_ASYNC_NOSPACE || nr == SOCKWQ_ASYNC_WAITDATA) &&
2536             !sock_flag(sk, SOCK_FASYNC))
2537                 return;
2538
2539         clear_bit(nr, &sk->sk_wq_raw->flags);
2540 }
2541
2542 static inline void sk_wake_async(const struct sock *sk, int how, int band)
2543 {
2544         if (sock_flag(sk, SOCK_FASYNC)) {
2545                 rcu_read_lock();
2546                 sock_wake_async(rcu_dereference(sk->sk_wq), how, band);
2547                 rcu_read_unlock();
2548         }
2549 }
2550
2551 /* Since sk_{r,w}mem_alloc sums skb->truesize, even a small frame might
2552  * need sizeof(sk_buff) + MTU + padding, unless net driver perform copybreak.
2553  * Note: for send buffers, TCP works better if we can build two skbs at
2554  * minimum.
2555  */
2556 #define TCP_SKB_MIN_TRUESIZE    (2048 + SKB_DATA_ALIGN(sizeof(struct sk_buff)))
2557
2558 #define SOCK_MIN_SNDBUF         (TCP_SKB_MIN_TRUESIZE * 2)
2559 #define SOCK_MIN_RCVBUF          TCP_SKB_MIN_TRUESIZE
2560
2561 static inline void sk_stream_moderate_sndbuf(struct sock *sk)
2562 {
2563         u32 val;
2564
2565         if (sk->sk_userlocks & SOCK_SNDBUF_LOCK)
2566                 return;
2567
2568         val = min(sk->sk_sndbuf, sk->sk_wmem_queued >> 1);
2569         val = max_t(u32, val, sk_unused_reserved_mem(sk));
2570
2571         WRITE_ONCE(sk->sk_sndbuf, max_t(u32, val, SOCK_MIN_SNDBUF));
2572 }
2573
2574 /**
2575  * sk_page_frag - return an appropriate page_frag
2576  * @sk: socket
2577  *
2578  * Use the per task page_frag instead of the per socket one for
2579  * optimization when we know that we're in process context and own
2580  * everything that's associated with %current.
2581  *
2582  * Both direct reclaim and page faults can nest inside other
2583  * socket operations and end up recursing into sk_page_frag()
2584  * while it's already in use: explicitly avoid task page_frag
2585  * usage if the caller is potentially doing any of them.
2586  * This assumes that page fault handlers use the GFP_NOFS flags.
2587  *
2588  * Return: a per task page_frag if context allows that,
2589  * otherwise a per socket one.
2590  */
2591 static inline struct page_frag *sk_page_frag(struct sock *sk)
2592 {
2593         if ((sk->sk_allocation & (__GFP_DIRECT_RECLAIM | __GFP_MEMALLOC | __GFP_FS)) ==
2594             (__GFP_DIRECT_RECLAIM | __GFP_FS))
2595                 return &current->task_frag;
2596
2597         return &sk->sk_frag;
2598 }
2599
2600 bool sk_page_frag_refill(struct sock *sk, struct page_frag *pfrag);
2601
2602 /*
2603  *      Default write policy as shown to user space via poll/select/SIGIO
2604  */
2605 static inline bool sock_writeable(const struct sock *sk)
2606 {
2607         return refcount_read(&sk->sk_wmem_alloc) < (READ_ONCE(sk->sk_sndbuf) >> 1);
2608 }
2609
2610 static inline gfp_t gfp_any(void)
2611 {
2612         return in_softirq() ? GFP_ATOMIC : GFP_KERNEL;
2613 }
2614
2615 static inline gfp_t gfp_memcg_charge(void)
2616 {
2617         return in_softirq() ? GFP_ATOMIC : GFP_KERNEL;
2618 }
2619
2620 static inline long sock_rcvtimeo(const struct sock *sk, bool noblock)
2621 {
2622         return noblock ? 0 : sk->sk_rcvtimeo;
2623 }
2624
2625 static inline long sock_sndtimeo(const struct sock *sk, bool noblock)
2626 {
2627         return noblock ? 0 : sk->sk_sndtimeo;
2628 }
2629
2630 static inline int sock_rcvlowat(const struct sock *sk, int waitall, int len)
2631 {
2632         int v = waitall ? len : min_t(int, READ_ONCE(sk->sk_rcvlowat), len);
2633
2634         return v ?: 1;
2635 }
2636
2637 /* Alas, with timeout socket operations are not restartable.
2638  * Compare this to poll().
2639  */
2640 static inline int sock_intr_errno(long timeo)
2641 {
2642         return timeo == MAX_SCHEDULE_TIMEOUT ? -ERESTARTSYS : -EINTR;
2643 }
2644
2645 struct sock_skb_cb {
2646         u32 dropcount;
2647 };
2648
2649 /* Store sock_skb_cb at the end of skb->cb[] so protocol families
2650  * using skb->cb[] would keep using it directly and utilize its
2651  * alignement guarantee.
2652  */
2653 #define SOCK_SKB_CB_OFFSET ((sizeof_field(struct sk_buff, cb) - \
2654                             sizeof(struct sock_skb_cb)))
2655
2656 #define SOCK_SKB_CB(__skb) ((struct sock_skb_cb *)((__skb)->cb + \
2657                             SOCK_SKB_CB_OFFSET))
2658
2659 #define sock_skb_cb_check_size(size) \
2660         BUILD_BUG_ON((size) > SOCK_SKB_CB_OFFSET)
2661
2662 static inline void
2663 sock_skb_set_dropcount(const struct sock *sk, struct sk_buff *skb)
2664 {
2665         SOCK_SKB_CB(skb)->dropcount = sock_flag(sk, SOCK_RXQ_OVFL) ?
2666                                                 atomic_read(&sk->sk_drops) : 0;
2667 }
2668
2669 static inline void sk_drops_add(struct sock *sk, const struct sk_buff *skb)
2670 {
2671         int segs = max_t(u16, 1, skb_shinfo(skb)->gso_segs);
2672
2673         atomic_add(segs, &sk->sk_drops);
2674 }
2675
2676 static inline ktime_t sock_read_timestamp(struct sock *sk)
2677 {
2678 #if BITS_PER_LONG==32
2679         unsigned int seq;
2680         ktime_t kt;
2681
2682         do {
2683                 seq = read_seqbegin(&sk->sk_stamp_seq);
2684                 kt = sk->sk_stamp;
2685         } while (read_seqretry(&sk->sk_stamp_seq, seq));
2686
2687         return kt;
2688 #else
2689         return READ_ONCE(sk->sk_stamp);
2690 #endif
2691 }
2692
2693 static inline void sock_write_timestamp(struct sock *sk, ktime_t kt)
2694 {
2695 #if BITS_PER_LONG==32
2696         write_seqlock(&sk->sk_stamp_seq);
2697         sk->sk_stamp = kt;
2698         write_sequnlock(&sk->sk_stamp_seq);
2699 #else
2700         WRITE_ONCE(sk->sk_stamp, kt);
2701 #endif
2702 }
2703
2704 void __sock_recv_timestamp(struct msghdr *msg, struct sock *sk,
2705                            struct sk_buff *skb);
2706 void __sock_recv_wifi_status(struct msghdr *msg, struct sock *sk,
2707                              struct sk_buff *skb);
2708
2709 static inline void
2710 sock_recv_timestamp(struct msghdr *msg, struct sock *sk, struct sk_buff *skb)
2711 {
2712         ktime_t kt = skb->tstamp;
2713         struct skb_shared_hwtstamps *hwtstamps = skb_hwtstamps(skb);
2714
2715         /*
2716          * generate control messages if
2717          * - receive time stamping in software requested
2718          * - software time stamp available and wanted
2719          * - hardware time stamps available and wanted
2720          */
2721         if (sock_flag(sk, SOCK_RCVTSTAMP) ||
2722             (sk->sk_tsflags & SOF_TIMESTAMPING_RX_SOFTWARE) ||
2723             (kt && sk->sk_tsflags & SOF_TIMESTAMPING_SOFTWARE) ||
2724             (hwtstamps->hwtstamp &&
2725              (sk->sk_tsflags & SOF_TIMESTAMPING_RAW_HARDWARE)))
2726                 __sock_recv_timestamp(msg, sk, skb);
2727         else
2728                 sock_write_timestamp(sk, kt);
2729
2730         if (sock_flag(sk, SOCK_WIFI_STATUS) && skb->wifi_acked_valid)
2731                 __sock_recv_wifi_status(msg, sk, skb);
2732 }
2733
2734 void __sock_recv_cmsgs(struct msghdr *msg, struct sock *sk,
2735                        struct sk_buff *skb);
2736
2737 #define SK_DEFAULT_STAMP (-1L * NSEC_PER_SEC)
2738 static inline void sock_recv_cmsgs(struct msghdr *msg, struct sock *sk,
2739                                    struct sk_buff *skb)
2740 {
2741 #define FLAGS_RECV_CMSGS ((1UL << SOCK_RXQ_OVFL)                        | \
2742                            (1UL << SOCK_RCVTSTAMP)                      | \
2743                            (1UL << SOCK_RCVMARK))
2744 #define TSFLAGS_ANY       (SOF_TIMESTAMPING_SOFTWARE                    | \
2745                            SOF_TIMESTAMPING_RAW_HARDWARE)
2746
2747         if (sk->sk_flags & FLAGS_RECV_CMSGS || sk->sk_tsflags & TSFLAGS_ANY)
2748                 __sock_recv_cmsgs(msg, sk, skb);
2749         else if (unlikely(sock_flag(sk, SOCK_TIMESTAMP)))
2750                 sock_write_timestamp(sk, skb->tstamp);
2751         else if (unlikely(sock_read_timestamp(sk) == SK_DEFAULT_STAMP))
2752                 sock_write_timestamp(sk, 0);
2753 }
2754
2755 void __sock_tx_timestamp(__u16 tsflags, __u8 *tx_flags);
2756
2757 /**
2758  * _sock_tx_timestamp - checks whether the outgoing packet is to be time stamped
2759  * @sk:         socket sending this packet
2760  * @tsflags:    timestamping flags to use
2761  * @tx_flags:   completed with instructions for time stamping
2762  * @tskey:      filled in with next sk_tskey (not for TCP, which uses seqno)
2763  *
2764  * Note: callers should take care of initial ``*tx_flags`` value (usually 0)
2765  */
2766 static inline void _sock_tx_timestamp(struct sock *sk, __u16 tsflags,
2767                                       __u8 *tx_flags, __u32 *tskey)
2768 {
2769         if (unlikely(tsflags)) {
2770                 __sock_tx_timestamp(tsflags, tx_flags);
2771                 if (tsflags & SOF_TIMESTAMPING_OPT_ID && tskey &&
2772                     tsflags & SOF_TIMESTAMPING_TX_RECORD_MASK)
2773                         *tskey = atomic_inc_return(&sk->sk_tskey) - 1;
2774         }
2775         if (unlikely(sock_flag(sk, SOCK_WIFI_STATUS)))
2776                 *tx_flags |= SKBTX_WIFI_STATUS;
2777 }
2778
2779 static inline void sock_tx_timestamp(struct sock *sk, __u16 tsflags,
2780                                      __u8 *tx_flags)
2781 {
2782         _sock_tx_timestamp(sk, tsflags, tx_flags, NULL);
2783 }
2784
2785 static inline void skb_setup_tx_timestamp(struct sk_buff *skb, __u16 tsflags)
2786 {
2787         _sock_tx_timestamp(skb->sk, tsflags, &skb_shinfo(skb)->tx_flags,
2788                            &skb_shinfo(skb)->tskey);
2789 }
2790
2791 static inline bool sk_is_tcp(const struct sock *sk)
2792 {
2793         return sk->sk_type == SOCK_STREAM && sk->sk_protocol == IPPROTO_TCP;
2794 }
2795
2796 /**
2797  * sk_eat_skb - Release a skb if it is no longer needed
2798  * @sk: socket to eat this skb from
2799  * @skb: socket buffer to eat
2800  *
2801  * This routine must be called with interrupts disabled or with the socket
2802  * locked so that the sk_buff queue operation is ok.
2803 */
2804 static inline void sk_eat_skb(struct sock *sk, struct sk_buff *skb)
2805 {
2806         __skb_unlink(skb, &sk->sk_receive_queue);
2807         __kfree_skb(skb);
2808 }
2809
2810 static inline bool
2811 skb_sk_is_prefetched(struct sk_buff *skb)
2812 {
2813 #ifdef CONFIG_INET
2814         return skb->destructor == sock_pfree;
2815 #else
2816         return false;
2817 #endif /* CONFIG_INET */
2818 }
2819
2820 /* This helper checks if a socket is a full socket,
2821  * ie _not_ a timewait or request socket.
2822  */
2823 static inline bool sk_fullsock(const struct sock *sk)
2824 {
2825         return (1 << sk->sk_state) & ~(TCPF_TIME_WAIT | TCPF_NEW_SYN_RECV);
2826 }
2827
2828 static inline bool
2829 sk_is_refcounted(struct sock *sk)
2830 {
2831         /* Only full sockets have sk->sk_flags. */
2832         return !sk_fullsock(sk) || !sock_flag(sk, SOCK_RCU_FREE);
2833 }
2834
2835 /**
2836  * skb_steal_sock - steal a socket from an sk_buff
2837  * @skb: sk_buff to steal the socket from
2838  * @refcounted: is set to true if the socket is reference-counted
2839  */
2840 static inline struct sock *
2841 skb_steal_sock(struct sk_buff *skb, bool *refcounted)
2842 {
2843         if (skb->sk) {
2844                 struct sock *sk = skb->sk;
2845
2846                 *refcounted = true;
2847                 if (skb_sk_is_prefetched(skb))
2848                         *refcounted = sk_is_refcounted(sk);
2849                 skb->destructor = NULL;
2850                 skb->sk = NULL;
2851                 return sk;
2852         }
2853         *refcounted = false;
2854         return NULL;
2855 }
2856
2857 /* Checks if this SKB belongs to an HW offloaded socket
2858  * and whether any SW fallbacks are required based on dev.
2859  * Check decrypted mark in case skb_orphan() cleared socket.
2860  */
2861 static inline struct sk_buff *sk_validate_xmit_skb(struct sk_buff *skb,
2862                                                    struct net_device *dev)
2863 {
2864 #ifdef CONFIG_SOCK_VALIDATE_XMIT
2865         struct sock *sk = skb->sk;
2866
2867         if (sk && sk_fullsock(sk) && sk->sk_validate_xmit_skb) {
2868                 skb = sk->sk_validate_xmit_skb(sk, dev, skb);
2869 #ifdef CONFIG_TLS_DEVICE
2870         } else if (unlikely(skb->decrypted)) {
2871                 pr_warn_ratelimited("unencrypted skb with no associated socket - dropping\n");
2872                 kfree_skb(skb);
2873                 skb = NULL;
2874 #endif
2875         }
2876 #endif
2877
2878         return skb;
2879 }
2880
2881 /* This helper checks if a socket is a LISTEN or NEW_SYN_RECV
2882  * SYNACK messages can be attached to either ones (depending on SYNCOOKIE)
2883  */
2884 static inline bool sk_listener(const struct sock *sk)
2885 {
2886         return (1 << sk->sk_state) & (TCPF_LISTEN | TCPF_NEW_SYN_RECV);
2887 }
2888
2889 void sock_enable_timestamp(struct sock *sk, enum sock_flags flag);
2890 int sock_recv_errqueue(struct sock *sk, struct msghdr *msg, int len, int level,
2891                        int type);
2892
2893 bool sk_ns_capable(const struct sock *sk,
2894                    struct user_namespace *user_ns, int cap);
2895 bool sk_capable(const struct sock *sk, int cap);
2896 bool sk_net_capable(const struct sock *sk, int cap);
2897
2898 void sk_get_meminfo(const struct sock *sk, u32 *meminfo);
2899
2900 /* Take into consideration the size of the struct sk_buff overhead in the
2901  * determination of these values, since that is non-constant across
2902  * platforms.  This makes socket queueing behavior and performance
2903  * not depend upon such differences.
2904  */
2905 #define _SK_MEM_PACKETS         256
2906 #define _SK_MEM_OVERHEAD        SKB_TRUESIZE(256)
2907 #define SK_WMEM_MAX             (_SK_MEM_OVERHEAD * _SK_MEM_PACKETS)
2908 #define SK_RMEM_MAX             (_SK_MEM_OVERHEAD * _SK_MEM_PACKETS)
2909
2910 extern __u32 sysctl_wmem_max;
2911 extern __u32 sysctl_rmem_max;
2912
2913 extern int sysctl_tstamp_allow_data;
2914 extern int sysctl_optmem_max;
2915
2916 extern __u32 sysctl_wmem_default;
2917 extern __u32 sysctl_rmem_default;
2918
2919 #define SKB_FRAG_PAGE_ORDER     get_order(32768)
2920 DECLARE_STATIC_KEY_FALSE(net_high_order_alloc_disable_key);
2921
2922 static inline int sk_get_wmem0(const struct sock *sk, const struct proto *proto)
2923 {
2924         /* Does this proto have per netns sysctl_wmem ? */
2925         if (proto->sysctl_wmem_offset)
2926                 return READ_ONCE(*(int *)((void *)sock_net(sk) + proto->sysctl_wmem_offset));
2927
2928         return READ_ONCE(*proto->sysctl_wmem);
2929 }
2930
2931 static inline int sk_get_rmem0(const struct sock *sk, const struct proto *proto)
2932 {
2933         /* Does this proto have per netns sysctl_rmem ? */
2934         if (proto->sysctl_rmem_offset)
2935                 return READ_ONCE(*(int *)((void *)sock_net(sk) + proto->sysctl_rmem_offset));
2936
2937         return READ_ONCE(*proto->sysctl_rmem);
2938 }
2939
2940 /* Default TCP Small queue budget is ~1 ms of data (1sec >> 10)
2941  * Some wifi drivers need to tweak it to get more chunks.
2942  * They can use this helper from their ndo_start_xmit()
2943  */
2944 static inline void sk_pacing_shift_update(struct sock *sk, int val)
2945 {
2946         if (!sk || !sk_fullsock(sk) || READ_ONCE(sk->sk_pacing_shift) == val)
2947                 return;
2948         WRITE_ONCE(sk->sk_pacing_shift, val);
2949 }
2950
2951 /* if a socket is bound to a device, check that the given device
2952  * index is either the same or that the socket is bound to an L3
2953  * master device and the given device index is also enslaved to
2954  * that L3 master
2955  */
2956 static inline bool sk_dev_equal_l3scope(struct sock *sk, int dif)
2957 {
2958         int bound_dev_if = READ_ONCE(sk->sk_bound_dev_if);
2959         int mdif;
2960
2961         if (!bound_dev_if || bound_dev_if == dif)
2962                 return true;
2963
2964         mdif = l3mdev_master_ifindex_by_index(sock_net(sk), dif);
2965         if (mdif && mdif == bound_dev_if)
2966                 return true;
2967
2968         return false;
2969 }
2970
2971 void sock_def_readable(struct sock *sk);
2972
2973 int sock_bindtoindex(struct sock *sk, int ifindex, bool lock_sk);
2974 void sock_set_timestamp(struct sock *sk, int optname, bool valbool);
2975 int sock_set_timestamping(struct sock *sk, int optname,
2976                           struct so_timestamping timestamping);
2977
2978 void sock_enable_timestamps(struct sock *sk);
2979 void sock_no_linger(struct sock *sk);
2980 void sock_set_keepalive(struct sock *sk);
2981 void sock_set_priority(struct sock *sk, u32 priority);
2982 void sock_set_rcvbuf(struct sock *sk, int val);
2983 void sock_set_mark(struct sock *sk, u32 val);
2984 void sock_set_reuseaddr(struct sock *sk);
2985 void sock_set_reuseport(struct sock *sk);
2986 void sock_set_sndtimeo(struct sock *sk, s64 secs);
2987
2988 int sock_bind_add(struct sock *sk, struct sockaddr *addr, int addr_len);
2989
2990 int sock_get_timeout(long timeo, void *optval, bool old_timeval);
2991 int sock_copy_user_timeval(struct __kernel_sock_timeval *tv,
2992                            sockptr_t optval, int optlen, bool old_timeval);
2993
2994 static inline bool sk_is_readable(struct sock *sk)
2995 {
2996         if (sk->sk_prot->sock_is_readable)
2997                 return sk->sk_prot->sock_is_readable(sk);
2998         return false;
2999 }
3000 #endif  /* _SOCK_H */