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