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