blob: 6c566034e26d9bed72bfbcce39a308b9e315d2bb [file] [log] [blame]
Arnaldo Carvalho de Melo8feaf0c02005-08-09 20:09:30 -07001/*
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
Arnaldo Carvalho de Melo8feaf0c02005-08-09 20:09:30 -070018
Vegard Nossum9e337b02008-10-18 17:37:51 +020019#include <linux/kmemcheck.h>
Arnaldo Carvalho de Melo8feaf0c02005-08-09 20:09:30 -070020#include <linux/list.h>
Arnaldo Carvalho de Melo295ff7e2005-08-09 20:44:40 -070021#include <linux/timer.h>
Arnaldo Carvalho de Melo8feaf0c02005-08-09 20:09:30 -070022#include <linux/types.h>
Arnaldo Carvalho de Melo295ff7e2005-08-09 20:44:40 -070023#include <linux/workqueue.h>
Arnaldo Carvalho de Melo8feaf0c02005-08-09 20:09:30 -070024
Arnaldo Carvalho de Melo14c85022005-12-27 02:43:12 -020025#include <net/inet_sock.h>
Arnaldo Carvalho de Melo8feaf0c02005-08-09 20:09:30 -070026#include <net/sock.h>
27#include <net/tcp_states.h>
Arnaldo Carvalho de Melo6d6ee432005-12-13 23:25:19 -080028#include <net/timewait_sock.h>
Arnaldo Carvalho de Melo8feaf0c02005-08-09 20:09:30 -070029
Arun Sharma600634972011-07-26 16:09:06 -070030#include <linux/atomic.h>
Arnaldo Carvalho de Melo8feaf0c02005-08-09 20:09:30 -070031
Arnaldo Carvalho de Melo295ff7e2005-08-09 20:44:40 -070032struct inet_hashinfo;
33
34#define INET_TWDR_RECYCLE_SLOTS_LOG 5
35#define INET_TWDR_RECYCLE_SLOTS (1 << INET_TWDR_RECYCLE_SLOTS_LOG)
36
37/*
38 * If time > 4sec, it is "slow" path, no recycling is required,
39 * so that we select tick to get range about 4 seconds.
40 */
41#if HZ <= 16 || HZ > 4096
42# error Unsupported: HZ <= 16 or HZ > 4096
43#elif HZ <= 32
44# define INET_TWDR_RECYCLE_TICK (5 + 2 - INET_TWDR_RECYCLE_SLOTS_LOG)
45#elif HZ <= 64
46# define INET_TWDR_RECYCLE_TICK (6 + 2 - INET_TWDR_RECYCLE_SLOTS_LOG)
47#elif HZ <= 128
48# define INET_TWDR_RECYCLE_TICK (7 + 2 - INET_TWDR_RECYCLE_SLOTS_LOG)
49#elif HZ <= 256
50# define INET_TWDR_RECYCLE_TICK (8 + 2 - INET_TWDR_RECYCLE_SLOTS_LOG)
51#elif HZ <= 512
52# define INET_TWDR_RECYCLE_TICK (9 + 2 - INET_TWDR_RECYCLE_SLOTS_LOG)
53#elif HZ <= 1024
54# define INET_TWDR_RECYCLE_TICK (10 + 2 - INET_TWDR_RECYCLE_SLOTS_LOG)
55#elif HZ <= 2048
56# define INET_TWDR_RECYCLE_TICK (11 + 2 - INET_TWDR_RECYCLE_SLOTS_LOG)
57#else
58# define INET_TWDR_RECYCLE_TICK (12 + 2 - INET_TWDR_RECYCLE_SLOTS_LOG)
59#endif
60
Eric Dumazet96f817f2013-10-03 14:27:25 -070061static inline u32 inet_tw_time_stamp(void)
62{
63 return jiffies;
64}
65
Arnaldo Carvalho de Melo295ff7e2005-08-09 20:44:40 -070066/* TIME_WAIT reaping mechanism. */
67#define INET_TWDR_TWKILL_SLOTS 8 /* Please keep this a power of 2. */
68
69#define INET_TWDR_TWKILL_QUOTA 100
70
71struct inet_timewait_death_row {
72 /* Short-time timewait calendar */
73 int twcal_hand;
Eric Dumazet187f5f842007-03-05 13:32:48 -080074 unsigned long twcal_jiffie;
Arnaldo Carvalho de Melo295ff7e2005-08-09 20:44:40 -070075 struct timer_list twcal_timer;
76 struct hlist_head twcal_row[INET_TWDR_RECYCLE_SLOTS];
77
78 spinlock_t death_lock;
79 int tw_count;
80 int period;
81 u32 thread_slots;
82 struct work_struct twkill_work;
83 struct timer_list tw_timer;
84 int slot;
85 struct hlist_head cells[INET_TWDR_TWKILL_SLOTS];
86 struct inet_hashinfo *hashinfo;
87 int sysctl_tw_recycle;
88 int sysctl_max_tw_buckets;
89};
90
Joe Perches1fd51152013-09-21 10:22:41 -070091void inet_twdr_hangman(unsigned long data);
92void inet_twdr_twkill_work(struct work_struct *work);
93void inet_twdr_twcal_tick(unsigned long data);
Arnaldo Carvalho de Melo696ab2d2005-08-09 20:45:03 -070094
Arnaldo Carvalho de Melo8feaf0c02005-08-09 20:09:30 -070095struct inet_bind_bucket;
96
97/*
98 * This is a TIME_WAIT sock. It works around the memory consumption
99 * problems of sockets in such a state on heavily loaded servers, but
100 * without violating the protocol specification.
101 */
102struct inet_timewait_sock {
103 /*
104 * Now struct sock also uses sock_common, so please just
105 * don't add nothing before this first member (__tw_common) --acme
106 */
107 struct sock_common __tw_common;
108#define tw_family __tw_common.skc_family
109#define tw_state __tw_common.skc_state
110#define tw_reuse __tw_common.skc_reuse
Eric Dumazet9fe516b2014-06-27 08:36:16 -0700111#define tw_ipv6only __tw_common.skc_ipv6only
Arnaldo Carvalho de Melo8feaf0c02005-08-09 20:09:30 -0700112#define tw_bound_dev_if __tw_common.skc_bound_dev_if
Eric Dumazet3ab5aee2008-11-16 19:40:17 -0800113#define tw_node __tw_common.skc_nulls_node
Arnaldo Carvalho de Melo8feaf0c02005-08-09 20:09:30 -0700114#define tw_bind_node __tw_common.skc_bind_node
115#define tw_refcnt __tw_common.skc_refcnt
Eric Dumazet81c3d542005-10-03 14:13:38 -0700116#define tw_hash __tw_common.skc_hash
Arnaldo Carvalho de Melo8feaf0c02005-08-09 20:09:30 -0700117#define tw_prot __tw_common.skc_prot
Eric W. Biederman07feaeb2007-09-12 11:58:02 +0200118#define tw_net __tw_common.skc_net
Eric Dumazet68835ab2010-11-30 19:04:07 +0000119#define tw_daddr __tw_common.skc_daddr
Eric Dumazetefe42082013-10-03 15:42:29 -0700120#define tw_v6_daddr __tw_common.skc_v6_daddr
Eric Dumazet68835ab2010-11-30 19:04:07 +0000121#define tw_rcv_saddr __tw_common.skc_rcv_saddr
Eric Dumazetefe42082013-10-03 15:42:29 -0700122#define tw_v6_rcv_saddr __tw_common.skc_v6_rcv_saddr
Eric Dumazetce43b032012-11-30 09:49:27 +0000123#define tw_dport __tw_common.skc_dport
124#define tw_num __tw_common.skc_num
Eric Dumazetce43b032012-11-30 09:49:27 +0000125
Arnaldo Carvalho de Meload8bb782008-02-03 04:08:26 -0800126 int tw_timeout;
Arnaldo Carvalho de Melo8feaf0c02005-08-09 20:09:30 -0700127 volatile unsigned char tw_substate;
Arnaldo Carvalho de Melo8feaf0c02005-08-09 20:09:30 -0700128 unsigned char tw_rcv_wscale;
Eric Dumazet68835ab2010-11-30 19:04:07 +0000129
Arnaldo Carvalho de Melo8feaf0c02005-08-09 20:09:30 -0700130 /* Socket demultiplex comparisons on incoming packets. */
Eric Dumazet68835ab2010-11-30 19:04:07 +0000131 /* these three are in inet_sock */
Al Viro23f33c22006-09-27 18:43:50 -0700132 __be16 tw_sport;
Vegard Nossum9e337b02008-10-18 17:37:51 +0200133 kmemcheck_bitfield_begin(flags);
Arnaldo Carvalho de Melo8feaf0c02005-08-09 20:09:30 -0700134 /* And these are ours. */
Eric Dumazet9fe516b2014-06-27 08:36:16 -0700135 unsigned int tw_pad0 : 1, /* 1 bit hole */
Eric Dumazetabf90cc2009-10-18 22:48:51 +0000136 tw_transparent : 1,
Florent Fourcot1d13a962014-01-16 17:21:22 +0100137 tw_flowlabel : 20,
138 tw_pad : 2, /* 2 bits hole */
139 tw_tos : 8;
Vegard Nossum9e337b02008-10-18 17:37:51 +0200140 kmemcheck_bitfield_end(flags);
Eric Dumazet96f817f2013-10-03 14:27:25 -0700141 u32 tw_ttd;
Arnaldo Carvalho de Melo8feaf0c02005-08-09 20:09:30 -0700142 struct inet_bind_bucket *tw_tb;
143 struct hlist_node tw_death_node;
144};
Eric Dumazetb903d322011-10-27 00:44:35 -0400145#define tw_tclass tw_tos
Arnaldo Carvalho de Melo8feaf0c02005-08-09 20:09:30 -0700146
Arnaldo Carvalho de Melo8feaf0c02005-08-09 20:09:30 -0700147static inline int inet_twsk_dead_hashed(const struct inet_timewait_sock *tw)
148{
Akinobu Mitada753be2006-04-28 15:21:23 -0700149 return !hlist_unhashed(&tw->tw_death_node);
Arnaldo Carvalho de Melo8feaf0c02005-08-09 20:09:30 -0700150}
151
152static inline void inet_twsk_dead_node_init(struct inet_timewait_sock *tw)
153{
154 tw->tw_death_node.pprev = NULL;
155}
156
157static inline void __inet_twsk_del_dead_node(struct inet_timewait_sock *tw)
158{
159 __hlist_del(&tw->tw_death_node);
160 inet_twsk_dead_node_init(tw);
161}
162
163static inline int inet_twsk_del_dead_node(struct inet_timewait_sock *tw)
164{
165 if (inet_twsk_dead_hashed(tw)) {
166 __inet_twsk_del_dead_node(tw);
167 return 1;
168 }
169 return 0;
170}
171
172#define inet_twsk_for_each(tw, node, head) \
Eric Dumazet3ab5aee2008-11-16 19:40:17 -0800173 hlist_nulls_for_each_entry(tw, node, head, tw_node)
Arnaldo Carvalho de Melo8feaf0c02005-08-09 20:09:30 -0700174
Sasha Levinb67bfe02013-02-27 17:06:00 -0800175#define inet_twsk_for_each_inmate(tw, jail) \
176 hlist_for_each_entry(tw, jail, tw_death_node)
Arnaldo Carvalho de Melo8feaf0c02005-08-09 20:09:30 -0700177
Sasha Levinb67bfe02013-02-27 17:06:00 -0800178#define inet_twsk_for_each_inmate_safe(tw, safe, jail) \
179 hlist_for_each_entry_safe(tw, safe, jail, tw_death_node)
Arnaldo Carvalho de Melo8feaf0c02005-08-09 20:09:30 -0700180
181static inline struct inet_timewait_sock *inet_twsk(const struct sock *sk)
182{
183 return (struct inet_timewait_sock *)sk;
184}
185
Eric Dumazet05dbc7b2013-10-03 00:22:02 -0700186void inet_twsk_free(struct inet_timewait_sock *tw);
Joe Perches1fd51152013-09-21 10:22:41 -0700187void inet_twsk_put(struct inet_timewait_sock *tw);
Arnaldo Carvalho de Meloe48c4142005-08-09 20:09:46 -0700188
Joe Perches1fd51152013-09-21 10:22:41 -0700189int inet_twsk_unhash(struct inet_timewait_sock *tw);
Eric Dumazet13475a32009-12-02 22:31:19 +0000190
Joe Perches1fd51152013-09-21 10:22:41 -0700191int inet_twsk_bind_unhash(struct inet_timewait_sock *tw,
192 struct inet_hashinfo *hashinfo);
Eric Dumazet3cdaeda2009-12-04 03:47:42 +0000193
Joe Perches1fd51152013-09-21 10:22:41 -0700194struct inet_timewait_sock *inet_twsk_alloc(const struct sock *sk,
195 const int state);
Arnaldo Carvalho de Meloc6762702005-08-09 20:09:59 -0700196
Joe Perches1fd51152013-09-21 10:22:41 -0700197void __inet_twsk_hashdance(struct inet_timewait_sock *tw, struct sock *sk,
198 struct inet_hashinfo *hashinfo);
Arnaldo Carvalho de Melo696ab2d2005-08-09 20:45:03 -0700199
Joe Perches1fd51152013-09-21 10:22:41 -0700200void inet_twsk_schedule(struct inet_timewait_sock *tw,
201 struct inet_timewait_death_row *twdr,
202 const int timeo, const int timewait_len);
203void inet_twsk_deschedule(struct inet_timewait_sock *tw,
204 struct inet_timewait_death_row *twdr);
YOSHIFUJI Hideaki3b1e0a62008-03-26 02:26:21 +0900205
Joe Perches1fd51152013-09-21 10:22:41 -0700206void inet_twsk_purge(struct inet_hashinfo *hashinfo,
207 struct inet_timewait_death_row *twdr, int family);
Daniel Lezcanod3154922008-09-08 13:17:27 -0700208
YOSHIFUJI Hideaki3b1e0a62008-03-26 02:26:21 +0900209static inline
210struct net *twsk_net(const struct inet_timewait_sock *twsk)
211{
Eric Dumazetf943cbe2011-12-14 04:58:33 +0000212 return read_pnet(&twsk->tw_net);
YOSHIFUJI Hideaki3b1e0a62008-03-26 02:26:21 +0900213}
214
215static inline
Denis V. Lunevf5aa23f2008-03-26 00:48:17 -0700216void twsk_net_set(struct inet_timewait_sock *twsk, struct net *net)
YOSHIFUJI Hideaki3b1e0a62008-03-26 02:26:21 +0900217{
Eric Dumazetf943cbe2011-12-14 04:58:33 +0000218 write_pnet(&twsk->tw_net, net);
YOSHIFUJI Hideaki3b1e0a62008-03-26 02:26:21 +0900219}
Arnaldo Carvalho de Melo8feaf0c02005-08-09 20:09:30 -0700220#endif /* _INET_TIMEWAIT_SOCK_ */