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 <linux/kmemcheck.h>
13 #include <net/inet_hashtables.h>
14 #include <net/inet_timewait_sock.h>
17 /* Must be called with locally disabled BHs. */
18 static void __inet_twsk_kill(struct inet_timewait_sock *tw,
19 struct inet_hashinfo *hashinfo)
21 struct inet_bind_hashbucket *bhead;
22 struct inet_bind_bucket *tb;
23 /* Unlink from established hashes. */
24 spinlock_t *lock = inet_ehash_lockp(hashinfo, tw->tw_hash);
27 if (hlist_nulls_unhashed(&tw->tw_node)) {
31 hlist_nulls_del_rcu(&tw->tw_node);
32 sk_nulls_node_init(&tw->tw_node);
35 /* Disassociate with bind bucket. */
36 bhead = &hashinfo->bhash[inet_bhashfn(twsk_net(tw), tw->tw_num,
37 hashinfo->bhash_size)];
38 spin_lock(&bhead->lock);
40 __hlist_del(&tw->tw_bind_node);
42 inet_bind_bucket_destroy(hashinfo->bind_bucket_cachep, tb);
43 spin_unlock(&bhead->lock);
44 #ifdef SOCK_REFCNT_DEBUG
45 if (atomic_read(&tw->tw_refcnt) != 1) {
46 printk(KERN_DEBUG "%s timewait_sock %p refcnt=%d\n",
47 tw->tw_prot->name, tw, atomic_read(&tw->tw_refcnt));
53 static noinline void inet_twsk_free(struct inet_timewait_sock *tw)
55 struct module *owner = tw->tw_prot->owner;
56 twsk_destructor((struct sock *)tw);
57 #ifdef SOCK_REFCNT_DEBUG
58 pr_debug("%s timewait_sock %p released\n", tw->tw_prot->name, tw);
60 release_net(twsk_net(tw));
61 kmem_cache_free(tw->tw_prot->twsk_prot->twsk_slab, tw);
65 void inet_twsk_put(struct inet_timewait_sock *tw)
67 if (atomic_dec_and_test(&tw->tw_refcnt))
70 EXPORT_SYMBOL_GPL(inet_twsk_put);
73 * Enter the time wait state. This is called with locally disabled BH.
74 * Essentially we whip up a timewait bucket, copy the relevant info into it
75 * from the SK, and mess with hash chains and list linkage.
77 void __inet_twsk_hashdance(struct inet_timewait_sock *tw, struct sock *sk,
78 struct inet_hashinfo *hashinfo)
80 const struct inet_sock *inet = inet_sk(sk);
81 const struct inet_connection_sock *icsk = inet_csk(sk);
82 struct inet_ehash_bucket *ehead = inet_ehash_bucket(hashinfo, sk->sk_hash);
83 spinlock_t *lock = inet_ehash_lockp(hashinfo, sk->sk_hash);
84 struct inet_bind_hashbucket *bhead;
85 /* Step 1: Put TW into bind hash. Original socket stays there too.
86 Note, that any socket with inet->num != 0 MUST be bound in
87 binding cache, even if it is closed.
89 bhead = &hashinfo->bhash[inet_bhashfn(twsk_net(tw), inet->num,
90 hashinfo->bhash_size)];
91 spin_lock(&bhead->lock);
92 tw->tw_tb = icsk->icsk_bind_hash;
93 WARN_ON(!icsk->icsk_bind_hash);
94 inet_twsk_add_bind_node(tw, &tw->tw_tb->owners);
95 spin_unlock(&bhead->lock);
100 * Step 2: Hash TW into TIMEWAIT chain.
101 * Should be done before removing sk from established chain
102 * because readers are lockless and search established first.
104 atomic_inc(&tw->tw_refcnt);
105 inet_twsk_add_node_rcu(tw, &ehead->twchain);
107 /* Step 3: Remove SK from established hash. */
108 if (__sk_nulls_del_node_init_rcu(sk))
109 sock_prot_inuse_add(sock_net(sk), sk->sk_prot, -1);
114 EXPORT_SYMBOL_GPL(__inet_twsk_hashdance);
116 struct inet_timewait_sock *inet_twsk_alloc(const struct sock *sk, const int state)
118 struct inet_timewait_sock *tw =
119 kmem_cache_alloc(sk->sk_prot_creator->twsk_prot->twsk_slab,
122 const struct inet_sock *inet = inet_sk(sk);
124 kmemcheck_annotate_bitfield(tw, flags);
126 /* Give us an identity. */
127 tw->tw_daddr = inet->daddr;
128 tw->tw_rcv_saddr = inet->rcv_saddr;
129 tw->tw_bound_dev_if = sk->sk_bound_dev_if;
130 tw->tw_num = inet->num;
131 tw->tw_state = TCP_TIME_WAIT;
132 tw->tw_substate = state;
133 tw->tw_sport = inet->sport;
134 tw->tw_dport = inet->dport;
135 tw->tw_family = sk->sk_family;
136 tw->tw_reuse = sk->sk_reuse;
137 tw->tw_hash = sk->sk_hash;
139 tw->tw_transparent = inet->transparent;
140 tw->tw_prot = sk->sk_prot_creator;
141 twsk_net_set(tw, hold_net(sock_net(sk)));
142 atomic_set(&tw->tw_refcnt, 1);
143 inet_twsk_dead_node_init(tw);
144 __module_get(tw->tw_prot->owner);
150 EXPORT_SYMBOL_GPL(inet_twsk_alloc);
152 /* Returns non-zero if quota exceeded. */
153 static int inet_twdr_do_twkill_work(struct inet_timewait_death_row *twdr,
156 struct inet_timewait_sock *tw;
157 struct hlist_node *node;
161 /* NOTE: compare this to previous version where lock
162 * was released after detaching chain. It was racy,
163 * because tw buckets are scheduled in not serialized context
164 * in 2.3 (with netfilter), and with softnet it is common, because
165 * soft irqs are not sequenced.
170 inet_twsk_for_each_inmate(tw, node, &twdr->cells[slot]) {
171 __inet_twsk_del_dead_node(tw);
172 spin_unlock(&twdr->death_lock);
173 __inet_twsk_kill(tw, twdr->hashinfo);
175 NET_INC_STATS_BH(twsk_net(tw), LINUX_MIB_TIMEWAITED);
179 spin_lock(&twdr->death_lock);
180 if (killed > INET_TWDR_TWKILL_QUOTA) {
185 /* While we dropped twdr->death_lock, another cpu may have
186 * killed off the next TW bucket in the list, therefore
187 * do a fresh re-read of the hlist head node with the
188 * lock reacquired. We still use the hlist traversal
189 * macro in order to get the prefetches.
194 twdr->tw_count -= killed;
195 #ifndef CONFIG_NET_NS
196 NET_ADD_STATS_BH(&init_net, LINUX_MIB_TIMEWAITED, killed);
201 void inet_twdr_hangman(unsigned long data)
203 struct inet_timewait_death_row *twdr;
204 int unsigned need_timer;
206 twdr = (struct inet_timewait_death_row *)data;
207 spin_lock(&twdr->death_lock);
209 if (twdr->tw_count == 0)
213 if (inet_twdr_do_twkill_work(twdr, twdr->slot)) {
214 twdr->thread_slots |= (1 << twdr->slot);
215 schedule_work(&twdr->twkill_work);
218 /* We purged the entire slot, anything left? */
222 twdr->slot = ((twdr->slot + 1) & (INET_TWDR_TWKILL_SLOTS - 1));
224 mod_timer(&twdr->tw_timer, jiffies + twdr->period);
226 spin_unlock(&twdr->death_lock);
229 EXPORT_SYMBOL_GPL(inet_twdr_hangman);
231 void inet_twdr_twkill_work(struct work_struct *work)
233 struct inet_timewait_death_row *twdr =
234 container_of(work, struct inet_timewait_death_row, twkill_work);
237 BUILD_BUG_ON((INET_TWDR_TWKILL_SLOTS - 1) >
238 (sizeof(twdr->thread_slots) * 8));
240 while (twdr->thread_slots) {
241 spin_lock_bh(&twdr->death_lock);
242 for (i = 0; i < INET_TWDR_TWKILL_SLOTS; i++) {
243 if (!(twdr->thread_slots & (1 << i)))
246 while (inet_twdr_do_twkill_work(twdr, i) != 0) {
247 if (need_resched()) {
248 spin_unlock_bh(&twdr->death_lock);
250 spin_lock_bh(&twdr->death_lock);
254 twdr->thread_slots &= ~(1 << i);
256 spin_unlock_bh(&twdr->death_lock);
260 EXPORT_SYMBOL_GPL(inet_twdr_twkill_work);
262 /* These are always called from BH context. See callers in
263 * tcp_input.c to verify this.
266 /* This is for handling early-kills of TIME_WAIT sockets. */
267 void inet_twsk_deschedule(struct inet_timewait_sock *tw,
268 struct inet_timewait_death_row *twdr)
270 spin_lock(&twdr->death_lock);
271 if (inet_twsk_del_dead_node(tw)) {
273 if (--twdr->tw_count == 0)
274 del_timer(&twdr->tw_timer);
276 spin_unlock(&twdr->death_lock);
277 __inet_twsk_kill(tw, twdr->hashinfo);
280 EXPORT_SYMBOL(inet_twsk_deschedule);
282 void inet_twsk_schedule(struct inet_timewait_sock *tw,
283 struct inet_timewait_death_row *twdr,
284 const int timeo, const int timewait_len)
286 struct hlist_head *list;
289 /* timeout := RTO * 3.5
291 * 3.5 = 1+2+0.5 to wait for two retransmits.
293 * RATIONALE: if FIN arrived and we entered TIME-WAIT state,
294 * our ACK acking that FIN can be lost. If N subsequent retransmitted
295 * FINs (or previous seqments) are lost (probability of such event
296 * is p^(N+1), where p is probability to lose single packet and
297 * time to detect the loss is about RTO*(2^N - 1) with exponential
298 * backoff). Normal timewait length is calculated so, that we
299 * waited at least for one retransmitted FIN (maximal RTO is 120sec).
300 * [ BTW Linux. following BSD, violates this requirement waiting
301 * only for 60sec, we should wait at least for 240 secs.
302 * Well, 240 consumes too much of resources 8)
304 * This interval is not reduced to catch old duplicate and
305 * responces to our wandering segments living for two MSLs.
306 * However, if we use PAWS to detect
307 * old duplicates, we can reduce the interval to bounds required
308 * by RTO, rather than MSL. So, if peer understands PAWS, we
309 * kill tw bucket after 3.5*RTO (it is important that this number
310 * is greater than TS tick!) and detect old duplicates with help
313 slot = (timeo + (1 << INET_TWDR_RECYCLE_TICK) - 1) >> INET_TWDR_RECYCLE_TICK;
315 spin_lock(&twdr->death_lock);
317 /* Unlink it, if it was scheduled */
318 if (inet_twsk_del_dead_node(tw))
321 atomic_inc(&tw->tw_refcnt);
323 if (slot >= INET_TWDR_RECYCLE_SLOTS) {
324 /* Schedule to slow timer */
325 if (timeo >= timewait_len) {
326 slot = INET_TWDR_TWKILL_SLOTS - 1;
328 slot = DIV_ROUND_UP(timeo, twdr->period);
329 if (slot >= INET_TWDR_TWKILL_SLOTS)
330 slot = INET_TWDR_TWKILL_SLOTS - 1;
332 tw->tw_ttd = jiffies + timeo;
333 slot = (twdr->slot + slot) & (INET_TWDR_TWKILL_SLOTS - 1);
334 list = &twdr->cells[slot];
336 tw->tw_ttd = jiffies + (slot << INET_TWDR_RECYCLE_TICK);
338 if (twdr->twcal_hand < 0) {
339 twdr->twcal_hand = 0;
340 twdr->twcal_jiffie = jiffies;
341 twdr->twcal_timer.expires = twdr->twcal_jiffie +
342 (slot << INET_TWDR_RECYCLE_TICK);
343 add_timer(&twdr->twcal_timer);
345 if (time_after(twdr->twcal_timer.expires,
346 jiffies + (slot << INET_TWDR_RECYCLE_TICK)))
347 mod_timer(&twdr->twcal_timer,
348 jiffies + (slot << INET_TWDR_RECYCLE_TICK));
349 slot = (twdr->twcal_hand + slot) & (INET_TWDR_RECYCLE_SLOTS - 1);
351 list = &twdr->twcal_row[slot];
354 hlist_add_head(&tw->tw_death_node, list);
356 if (twdr->tw_count++ == 0)
357 mod_timer(&twdr->tw_timer, jiffies + twdr->period);
358 spin_unlock(&twdr->death_lock);
361 EXPORT_SYMBOL_GPL(inet_twsk_schedule);
363 void inet_twdr_twcal_tick(unsigned long data)
365 struct inet_timewait_death_row *twdr;
368 unsigned long now = jiffies;
372 twdr = (struct inet_timewait_death_row *)data;
374 spin_lock(&twdr->death_lock);
375 if (twdr->twcal_hand < 0)
378 slot = twdr->twcal_hand;
379 j = twdr->twcal_jiffie;
381 for (n = 0; n < INET_TWDR_RECYCLE_SLOTS; n++) {
382 if (time_before_eq(j, now)) {
383 struct hlist_node *node, *safe;
384 struct inet_timewait_sock *tw;
386 inet_twsk_for_each_inmate_safe(tw, node, safe,
387 &twdr->twcal_row[slot]) {
388 __inet_twsk_del_dead_node(tw);
389 __inet_twsk_kill(tw, twdr->hashinfo);
391 NET_INC_STATS_BH(twsk_net(tw), LINUX_MIB_TIMEWAITKILLED);
399 twdr->twcal_jiffie = j;
400 twdr->twcal_hand = slot;
403 if (!hlist_empty(&twdr->twcal_row[slot])) {
404 mod_timer(&twdr->twcal_timer, j);
408 j += 1 << INET_TWDR_RECYCLE_TICK;
409 slot = (slot + 1) & (INET_TWDR_RECYCLE_SLOTS - 1);
411 twdr->twcal_hand = -1;
414 if ((twdr->tw_count -= killed) == 0)
415 del_timer(&twdr->tw_timer);
416 #ifndef CONFIG_NET_NS
417 NET_ADD_STATS_BH(&init_net, LINUX_MIB_TIMEWAITKILLED, killed);
419 spin_unlock(&twdr->death_lock);
422 EXPORT_SYMBOL_GPL(inet_twdr_twcal_tick);
424 void inet_twsk_purge(struct net *net, struct inet_hashinfo *hashinfo,
425 struct inet_timewait_death_row *twdr, int family)
427 struct inet_timewait_sock *tw;
429 struct hlist_nulls_node *node;
433 for (h = 0; h < (hashinfo->ehash_size); h++) {
434 struct inet_ehash_bucket *head =
435 inet_ehash_bucket(hashinfo, h);
436 spinlock_t *lock = inet_ehash_lockp(hashinfo, h);
439 sk_nulls_for_each(sk, node, &head->twchain) {
442 if (!net_eq(twsk_net(tw), net) ||
443 tw->tw_family != family)
446 atomic_inc(&tw->tw_refcnt);
448 inet_twsk_deschedule(tw, twdr);
457 EXPORT_SYMBOL_GPL(inet_twsk_purge);