[INET]: Generalise the TCP sock ID lookup routines
[linux-2.6.git] / include / net / inet_timewait_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 a generic INET TIMEWAIT sock
7  *
8  *              From code originally in net/tcp.h
9  *
10  *              This program is free software; you can redistribute it and/or
11  *              modify it under the terms of the GNU General Public License
12  *              as published by the Free Software Foundation; either version
13  *              2 of the License, or (at your option) any later version.
14  */
15 #ifndef _INET_TIMEWAIT_SOCK_
16 #define _INET_TIMEWAIT_SOCK_
17
18 #include <linux/config.h>
19
20 #include <linux/ip.h>
21 #include <linux/list.h>
22 #include <linux/types.h>
23
24 #include <net/sock.h>
25 #include <net/tcp_states.h>
26
27 #include <asm/atomic.h>
28
29 #if (BITS_PER_LONG == 64)
30 #define INET_TIMEWAIT_ADDRCMP_ALIGN_BYTES 8
31 #else
32 #define INET_TIMEWAIT_ADDRCMP_ALIGN_BYTES 4
33 #endif
34
35 struct inet_bind_bucket;
36 struct inet_hashinfo;
37
38 /*
39  * This is a TIME_WAIT sock. It works around the memory consumption
40  * problems of sockets in such a state on heavily loaded servers, but
41  * without violating the protocol specification.
42  */
43 struct inet_timewait_sock {
44         /*
45          * Now struct sock also uses sock_common, so please just
46          * don't add nothing before this first member (__tw_common) --acme
47          */
48         struct sock_common      __tw_common;
49 #define tw_family               __tw_common.skc_family
50 #define tw_state                __tw_common.skc_state
51 #define tw_reuse                __tw_common.skc_reuse
52 #define tw_bound_dev_if         __tw_common.skc_bound_dev_if
53 #define tw_node                 __tw_common.skc_node
54 #define tw_bind_node            __tw_common.skc_bind_node
55 #define tw_refcnt               __tw_common.skc_refcnt
56 #define tw_prot                 __tw_common.skc_prot
57         volatile unsigned char  tw_substate;
58         /* 3 bits hole, try to pack */
59         unsigned char           tw_rcv_wscale;
60         /* Socket demultiplex comparisons on incoming packets. */
61         /* these five are in inet_sock */
62         __u16                   tw_sport;
63         __u32                   tw_daddr __attribute__((aligned(INET_TIMEWAIT_ADDRCMP_ALIGN_BYTES)));
64         __u32                   tw_rcv_saddr;
65         __u16                   tw_dport;
66         __u16                   tw_num;
67         /* And these are ours. */
68         __u8                    tw_ipv6only:1;
69         /* 31 bits hole, try to pack */
70         int                     tw_hashent;
71         int                     tw_timeout;
72         unsigned long           tw_ttd;
73         struct inet_bind_bucket *tw_tb;
74         struct hlist_node       tw_death_node;
75 };
76
77 static inline void inet_twsk_add_node(struct inet_timewait_sock *tw,
78                                       struct hlist_head *list)
79 {
80         hlist_add_head(&tw->tw_node, list);
81 }
82
83 static inline void inet_twsk_add_bind_node(struct inet_timewait_sock *tw,
84                                            struct hlist_head *list)
85 {
86         hlist_add_head(&tw->tw_bind_node, list);
87 }
88
89 static inline int inet_twsk_dead_hashed(const struct inet_timewait_sock *tw)
90 {
91         return tw->tw_death_node.pprev != NULL;
92 }
93
94 static inline void inet_twsk_dead_node_init(struct inet_timewait_sock *tw)
95 {
96         tw->tw_death_node.pprev = NULL;
97 }
98
99 static inline void __inet_twsk_del_dead_node(struct inet_timewait_sock *tw)
100 {
101         __hlist_del(&tw->tw_death_node);
102         inet_twsk_dead_node_init(tw);
103 }
104
105 static inline int inet_twsk_del_dead_node(struct inet_timewait_sock *tw)
106 {
107         if (inet_twsk_dead_hashed(tw)) {
108                 __inet_twsk_del_dead_node(tw);
109                 return 1;
110         }
111         return 0;
112 }
113
114 #define inet_twsk_for_each(tw, node, head) \
115         hlist_for_each_entry(tw, node, head, tw_node)
116
117 #define inet_twsk_for_each_inmate(tw, node, jail) \
118         hlist_for_each_entry(tw, node, jail, tw_death_node)
119
120 #define inet_twsk_for_each_inmate_safe(tw, node, safe, jail) \
121         hlist_for_each_entry_safe(tw, node, safe, jail, tw_death_node)
122
123 static inline struct inet_timewait_sock *inet_twsk(const struct sock *sk)
124 {
125         return (struct inet_timewait_sock *)sk;
126 }
127
128 static inline u32 inet_rcv_saddr(const struct sock *sk)
129 {
130         return likely(sk->sk_state != TCP_TIME_WAIT) ?
131                 inet_sk(sk)->rcv_saddr : inet_twsk(sk)->tw_rcv_saddr;
132 }
133
134 static inline void inet_twsk_put(struct inet_timewait_sock *tw)
135 {
136         if (atomic_dec_and_test(&tw->tw_refcnt)) {
137 #ifdef SOCK_REFCNT_DEBUG
138                 printk(KERN_DEBUG "%s timewait_sock %p released\n",
139                        tw->tw_prot->name, tw);
140 #endif
141                 kmem_cache_free(tw->tw_prot->twsk_slab, tw);
142         }
143 }
144
145 extern void __inet_twsk_kill(struct inet_timewait_sock *tw,
146                              struct inet_hashinfo *hashinfo);
147
148 extern void __inet_twsk_hashdance(struct inet_timewait_sock *tw,
149                                   struct sock *sk,
150                                   struct inet_hashinfo *hashinfo);
151 #endif  /* _INET_TIMEWAIT_SOCK_ */