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