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.
6 * Generic TIME_WAIT sockets functions
8 * From code orinally in TCP
11 #include <linux/kernel.h>
12 #include <net/inet_hashtables.h>
13 #include <net/inet_timewait_sock.h>
16 /* Must be called with locally disabled BHs. */
17 static void __inet_twsk_kill(struct inet_timewait_sock *tw,
18 struct inet_hashinfo *hashinfo)
20 struct inet_bind_hashbucket *bhead;
21 struct inet_bind_bucket *tb;
22 /* Unlink from established hashes. */
23 rwlock_t *lock = inet_ehash_lockp(hashinfo, tw->tw_hash);
26 if (hlist_unhashed(&tw->tw_node)) {
30 __hlist_del(&tw->tw_node);
31 sk_node_init(&tw->tw_node);
34 /* Disassociate with bind bucket. */
35 bhead = &hashinfo->bhash[inet_bhashfn(tw->tw_num, hashinfo->bhash_size)];
36 spin_lock(&bhead->lock);
38 __hlist_del(&tw->tw_bind_node);
40 inet_bind_bucket_destroy(hashinfo->bind_bucket_cachep, tb);
41 spin_unlock(&bhead->lock);
42 #ifdef SOCK_REFCNT_DEBUG
43 if (atomic_read(&tw->tw_refcnt) != 1) {
44 printk(KERN_DEBUG "%s timewait_sock %p refcnt=%d\n",
45 tw->tw_prot->name, tw, atomic_read(&tw->tw_refcnt));
51 void inet_twsk_put(struct inet_timewait_sock *tw)
53 if (atomic_dec_and_test(&tw->tw_refcnt)) {
54 struct module *owner = tw->tw_prot->owner;
55 twsk_destructor((struct sock *)tw);
56 #ifdef SOCK_REFCNT_DEBUG
57 printk(KERN_DEBUG "%s timewait_sock %p released\n",
58 tw->tw_prot->name, tw);
60 kmem_cache_free(tw->tw_prot->twsk_prot->twsk_slab, tw);
64 EXPORT_SYMBOL_GPL(inet_twsk_put);
67 * Enter the time wait state. This is called with locally disabled BH.
68 * Essentially we whip up a timewait bucket, copy the relevant info into it
69 * from the SK, and mess with hash chains and list linkage.
71 void __inet_twsk_hashdance(struct inet_timewait_sock *tw, struct sock *sk,
72 struct inet_hashinfo *hashinfo)
74 const struct inet_sock *inet = inet_sk(sk);
75 const struct inet_connection_sock *icsk = inet_csk(sk);
76 struct inet_ehash_bucket *ehead = inet_ehash_bucket(hashinfo, sk->sk_hash);
77 rwlock_t *lock = inet_ehash_lockp(hashinfo, sk->sk_hash);
78 struct inet_bind_hashbucket *bhead;
79 /* Step 1: Put TW into bind hash. Original socket stays there too.
80 Note, that any socket with inet->num != 0 MUST be bound in
81 binding cache, even if it is closed.
83 bhead = &hashinfo->bhash[inet_bhashfn(inet->num, hashinfo->bhash_size)];
84 spin_lock(&bhead->lock);
85 tw->tw_tb = icsk->icsk_bind_hash;
86 BUG_TRAP(icsk->icsk_bind_hash);
87 inet_twsk_add_bind_node(tw, &tw->tw_tb->owners);
88 spin_unlock(&bhead->lock);
92 /* Step 2: Remove SK from established hash. */
93 if (__sk_del_node_init(sk))
94 sock_prot_inuse_add(sk->sk_prot, -1);
96 /* Step 3: Hash TW into TIMEWAIT chain. */
97 inet_twsk_add_node(tw, &ehead->twchain);
98 atomic_inc(&tw->tw_refcnt);
103 EXPORT_SYMBOL_GPL(__inet_twsk_hashdance);
105 struct inet_timewait_sock *inet_twsk_alloc(const struct sock *sk, const int state)
107 struct inet_timewait_sock *tw =
108 kmem_cache_alloc(sk->sk_prot_creator->twsk_prot->twsk_slab,
111 const struct inet_sock *inet = inet_sk(sk);
113 /* Give us an identity. */
114 tw->tw_daddr = inet->daddr;
115 tw->tw_rcv_saddr = inet->rcv_saddr;
116 tw->tw_bound_dev_if = sk->sk_bound_dev_if;
117 tw->tw_num = inet->num;
118 tw->tw_state = TCP_TIME_WAIT;
119 tw->tw_substate = state;
120 tw->tw_sport = inet->sport;
121 tw->tw_dport = inet->dport;
122 tw->tw_family = sk->sk_family;
123 tw->tw_reuse = sk->sk_reuse;
124 tw->tw_hash = sk->sk_hash;
126 tw->tw_prot = sk->sk_prot_creator;
127 atomic_set(&tw->tw_refcnt, 1);
128 inet_twsk_dead_node_init(tw);
129 __module_get(tw->tw_prot->owner);
135 EXPORT_SYMBOL_GPL(inet_twsk_alloc);
137 /* Returns non-zero if quota exceeded. */
138 static int inet_twdr_do_twkill_work(struct inet_timewait_death_row *twdr,
141 struct inet_timewait_sock *tw;
142 struct hlist_node *node;
146 /* NOTE: compare this to previous version where lock
147 * was released after detaching chain. It was racy,
148 * because tw buckets are scheduled in not serialized context
149 * in 2.3 (with netfilter), and with softnet it is common, because
150 * soft irqs are not sequenced.
155 inet_twsk_for_each_inmate(tw, node, &twdr->cells[slot]) {
156 __inet_twsk_del_dead_node(tw);
157 spin_unlock(&twdr->death_lock);
158 __inet_twsk_kill(tw, twdr->hashinfo);
161 spin_lock(&twdr->death_lock);
162 if (killed > INET_TWDR_TWKILL_QUOTA) {
167 /* While we dropped twdr->death_lock, another cpu may have
168 * killed off the next TW bucket in the list, therefore
169 * do a fresh re-read of the hlist head node with the
170 * lock reacquired. We still use the hlist traversal
171 * macro in order to get the prefetches.
176 twdr->tw_count -= killed;
177 NET_ADD_STATS_BH(LINUX_MIB_TIMEWAITED, killed);
182 void inet_twdr_hangman(unsigned long data)
184 struct inet_timewait_death_row *twdr;
185 int unsigned need_timer;
187 twdr = (struct inet_timewait_death_row *)data;
188 spin_lock(&twdr->death_lock);
190 if (twdr->tw_count == 0)
194 if (inet_twdr_do_twkill_work(twdr, twdr->slot)) {
195 twdr->thread_slots |= (1 << twdr->slot);
196 schedule_work(&twdr->twkill_work);
199 /* We purged the entire slot, anything left? */
203 twdr->slot = ((twdr->slot + 1) & (INET_TWDR_TWKILL_SLOTS - 1));
205 mod_timer(&twdr->tw_timer, jiffies + twdr->period);
207 spin_unlock(&twdr->death_lock);
210 EXPORT_SYMBOL_GPL(inet_twdr_hangman);
212 void inet_twdr_twkill_work(struct work_struct *work)
214 struct inet_timewait_death_row *twdr =
215 container_of(work, struct inet_timewait_death_row, twkill_work);
218 BUILD_BUG_ON((INET_TWDR_TWKILL_SLOTS - 1) >
219 (sizeof(twdr->thread_slots) * 8));
221 while (twdr->thread_slots) {
222 spin_lock_bh(&twdr->death_lock);
223 for (i = 0; i < INET_TWDR_TWKILL_SLOTS; i++) {
224 if (!(twdr->thread_slots & (1 << i)))
227 while (inet_twdr_do_twkill_work(twdr, i) != 0) {
228 if (need_resched()) {
229 spin_unlock_bh(&twdr->death_lock);
231 spin_lock_bh(&twdr->death_lock);
235 twdr->thread_slots &= ~(1 << i);
237 spin_unlock_bh(&twdr->death_lock);
241 EXPORT_SYMBOL_GPL(inet_twdr_twkill_work);
243 /* These are always called from BH context. See callers in
244 * tcp_input.c to verify this.
247 /* This is for handling early-kills of TIME_WAIT sockets. */
248 void inet_twsk_deschedule(struct inet_timewait_sock *tw,
249 struct inet_timewait_death_row *twdr)
251 spin_lock(&twdr->death_lock);
252 if (inet_twsk_del_dead_node(tw)) {
254 if (--twdr->tw_count == 0)
255 del_timer(&twdr->tw_timer);
257 spin_unlock(&twdr->death_lock);
258 __inet_twsk_kill(tw, twdr->hashinfo);
261 EXPORT_SYMBOL(inet_twsk_deschedule);
263 void inet_twsk_schedule(struct inet_timewait_sock *tw,
264 struct inet_timewait_death_row *twdr,
265 const int timeo, const int timewait_len)
267 struct hlist_head *list;
270 /* timeout := RTO * 3.5
272 * 3.5 = 1+2+0.5 to wait for two retransmits.
274 * RATIONALE: if FIN arrived and we entered TIME-WAIT state,
275 * our ACK acking that FIN can be lost. If N subsequent retransmitted
276 * FINs (or previous seqments) are lost (probability of such event
277 * is p^(N+1), where p is probability to lose single packet and
278 * time to detect the loss is about RTO*(2^N - 1) with exponential
279 * backoff). Normal timewait length is calculated so, that we
280 * waited at least for one retransmitted FIN (maximal RTO is 120sec).
281 * [ BTW Linux. following BSD, violates this requirement waiting
282 * only for 60sec, we should wait at least for 240 secs.
283 * Well, 240 consumes too much of resources 8)
285 * This interval is not reduced to catch old duplicate and
286 * responces to our wandering segments living for two MSLs.
287 * However, if we use PAWS to detect
288 * old duplicates, we can reduce the interval to bounds required
289 * by RTO, rather than MSL. So, if peer understands PAWS, we
290 * kill tw bucket after 3.5*RTO (it is important that this number
291 * is greater than TS tick!) and detect old duplicates with help
294 slot = (timeo + (1 << INET_TWDR_RECYCLE_TICK) - 1) >> INET_TWDR_RECYCLE_TICK;
296 spin_lock(&twdr->death_lock);
298 /* Unlink it, if it was scheduled */
299 if (inet_twsk_del_dead_node(tw))
302 atomic_inc(&tw->tw_refcnt);
304 if (slot >= INET_TWDR_RECYCLE_SLOTS) {
305 /* Schedule to slow timer */
306 if (timeo >= timewait_len) {
307 slot = INET_TWDR_TWKILL_SLOTS - 1;
309 slot = DIV_ROUND_UP(timeo, twdr->period);
310 if (slot >= INET_TWDR_TWKILL_SLOTS)
311 slot = INET_TWDR_TWKILL_SLOTS - 1;
313 tw->tw_ttd = jiffies + timeo;
314 slot = (twdr->slot + slot) & (INET_TWDR_TWKILL_SLOTS - 1);
315 list = &twdr->cells[slot];
317 tw->tw_ttd = jiffies + (slot << INET_TWDR_RECYCLE_TICK);
319 if (twdr->twcal_hand < 0) {
320 twdr->twcal_hand = 0;
321 twdr->twcal_jiffie = jiffies;
322 twdr->twcal_timer.expires = twdr->twcal_jiffie +
323 (slot << INET_TWDR_RECYCLE_TICK);
324 add_timer(&twdr->twcal_timer);
326 if (time_after(twdr->twcal_timer.expires,
327 jiffies + (slot << INET_TWDR_RECYCLE_TICK)))
328 mod_timer(&twdr->twcal_timer,
329 jiffies + (slot << INET_TWDR_RECYCLE_TICK));
330 slot = (twdr->twcal_hand + slot) & (INET_TWDR_RECYCLE_SLOTS - 1);
332 list = &twdr->twcal_row[slot];
335 hlist_add_head(&tw->tw_death_node, list);
337 if (twdr->tw_count++ == 0)
338 mod_timer(&twdr->tw_timer, jiffies + twdr->period);
339 spin_unlock(&twdr->death_lock);
342 EXPORT_SYMBOL_GPL(inet_twsk_schedule);
344 void inet_twdr_twcal_tick(unsigned long data)
346 struct inet_timewait_death_row *twdr;
349 unsigned long now = jiffies;
353 twdr = (struct inet_timewait_death_row *)data;
355 spin_lock(&twdr->death_lock);
356 if (twdr->twcal_hand < 0)
359 slot = twdr->twcal_hand;
360 j = twdr->twcal_jiffie;
362 for (n = 0; n < INET_TWDR_RECYCLE_SLOTS; n++) {
363 if (time_before_eq(j, now)) {
364 struct hlist_node *node, *safe;
365 struct inet_timewait_sock *tw;
367 inet_twsk_for_each_inmate_safe(tw, node, safe,
368 &twdr->twcal_row[slot]) {
369 __inet_twsk_del_dead_node(tw);
370 __inet_twsk_kill(tw, twdr->hashinfo);
377 twdr->twcal_jiffie = j;
378 twdr->twcal_hand = slot;
381 if (!hlist_empty(&twdr->twcal_row[slot])) {
382 mod_timer(&twdr->twcal_timer, j);
386 j += 1 << INET_TWDR_RECYCLE_TICK;
387 slot = (slot + 1) & (INET_TWDR_RECYCLE_SLOTS - 1);
389 twdr->twcal_hand = -1;
392 if ((twdr->tw_count -= killed) == 0)
393 del_timer(&twdr->tw_timer);
394 NET_ADD_STATS_BH(LINUX_MIB_TIMEWAITKILLED, killed);
395 spin_unlock(&twdr->death_lock);
398 EXPORT_SYMBOL_GPL(inet_twdr_twcal_tick);