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