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