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