blob: 82f0d9ed60f50f27854fdb62a95281beed9df819 [file] [log] [blame]
Baruch Evena7868ea2005-06-23 12:28:11 -07001/*
2 * H-TCP congestion control. The algorithm is detailed in:
3 * R.N.Shorten, D.J.Leith:
4 * "H-TCP: TCP for high-speed and long-distance networks"
5 * Proc. PFLDnet, Argonne, 2004.
6 * http://www.hamilton.ie/net/htcp3.pdf
7 */
8
Baruch Evena7868ea2005-06-23 12:28:11 -07009#include <linux/mm.h>
10#include <linux/module.h>
11#include <net/tcp.h>
12
Stephen Hemminger9121c7772007-02-12 13:34:03 -080013#define ALPHA_BASE (1<<7) /* 1.0 with shift << 7 */
14#define BETA_MIN (1<<6) /* 0.5 with shift << 7 */
Baruch Evena7868ea2005-06-23 12:28:11 -070015#define BETA_MAX 102 /* 0.8 with shift << 7 */
16
Stephen Hemminger9121c7772007-02-12 13:34:03 -080017static int use_rtt_scaling __read_mostly = 1;
Baruch Evena7868ea2005-06-23 12:28:11 -070018module_param(use_rtt_scaling, int, 0644);
19MODULE_PARM_DESC(use_rtt_scaling, "turn on/off RTT scaling");
20
Stephen Hemminger9121c7772007-02-12 13:34:03 -080021static int use_bandwidth_switch __read_mostly = 1;
Baruch Evena7868ea2005-06-23 12:28:11 -070022module_param(use_bandwidth_switch, int, 0644);
23MODULE_PARM_DESC(use_bandwidth_switch, "turn on/off bandwidth switcher");
24
25struct htcp {
Gavin McCullagh2a272f92006-10-25 23:05:52 -070026 u32 alpha; /* Fixed point arith, << 7 */
Baruch Evena7868ea2005-06-23 12:28:11 -070027 u8 beta; /* Fixed point arith, << 7 */
Stephen Hemminger9121c7772007-02-12 13:34:03 -080028 u8 modeswitch; /* Delay modeswitch
29 until we had at least one congestion event */
Baruch Even0bc6d902006-03-20 22:22:47 -080030 u16 pkts_acked;
31 u32 packetcount;
Baruch Evena7868ea2005-06-23 12:28:11 -070032 u32 minRTT;
33 u32 maxRTT;
David S. Miller24040432006-11-10 15:01:14 -080034 u32 last_cong; /* Time since last congestion event end */
35 u32 undo_last_cong;
Baruch Evena7868ea2005-06-23 12:28:11 -070036
37 u32 undo_maxRTT;
38 u32 undo_old_maxB;
39
40 /* Bandwidth estimation */
41 u32 minB;
42 u32 maxB;
43 u32 old_maxB;
44 u32 Bi;
45 u32 lasttime;
46};
47
Stephen Hemminger9121c7772007-02-12 13:34:03 -080048static inline u32 htcp_cong_time(const struct htcp *ca)
Baruch Even50bf3e22006-03-20 22:23:10 -080049{
50 return jiffies - ca->last_cong;
51}
52
Stephen Hemminger9121c7772007-02-12 13:34:03 -080053static inline u32 htcp_ccount(const struct htcp *ca)
Baruch Even50bf3e22006-03-20 22:23:10 -080054{
Stephen Hemminger9121c7772007-02-12 13:34:03 -080055 return htcp_cong_time(ca) / ca->minRTT;
Baruch Even50bf3e22006-03-20 22:23:10 -080056}
57
Baruch Evena7868ea2005-06-23 12:28:11 -070058static inline void htcp_reset(struct htcp *ca)
59{
Baruch Even50bf3e22006-03-20 22:23:10 -080060 ca->undo_last_cong = ca->last_cong;
Baruch Evena7868ea2005-06-23 12:28:11 -070061 ca->undo_maxRTT = ca->maxRTT;
62 ca->undo_old_maxB = ca->old_maxB;
63
Baruch Even50bf3e22006-03-20 22:23:10 -080064 ca->last_cong = jiffies;
Baruch Evena7868ea2005-06-23 12:28:11 -070065}
66
Arnaldo Carvalho de Melo6687e982005-08-10 04:03:31 -030067static u32 htcp_cwnd_undo(struct sock *sk)
Baruch Evena7868ea2005-06-23 12:28:11 -070068{
Arnaldo Carvalho de Melo6687e982005-08-10 04:03:31 -030069 const struct tcp_sock *tp = tcp_sk(sk);
70 struct htcp *ca = inet_csk_ca(sk);
Stephen Hemminger9121c7772007-02-12 13:34:03 -080071
Doug Leith8f65b532008-11-12 01:41:09 -080072 if (ca->undo_last_cong) {
73 ca->last_cong = ca->undo_last_cong;
74 ca->maxRTT = ca->undo_maxRTT;
75 ca->old_maxB = ca->undo_old_maxB;
76 ca->undo_last_cong = 0;
77 }
Stephen Hemminger9121c7772007-02-12 13:34:03 -080078
79 return max(tp->snd_cwnd, (tp->snd_ssthresh << 7) / ca->beta);
Baruch Evena7868ea2005-06-23 12:28:11 -070080}
81
Stephen Hemminger113bbbd2007-07-25 23:50:28 -070082static inline void measure_rtt(struct sock *sk, u32 srtt)
Baruch Evena7868ea2005-06-23 12:28:11 -070083{
Arnaldo Carvalho de Melo6687e982005-08-10 04:03:31 -030084 const struct inet_connection_sock *icsk = inet_csk(sk);
Arnaldo Carvalho de Melo6687e982005-08-10 04:03:31 -030085 struct htcp *ca = inet_csk_ca(sk);
Baruch Evena7868ea2005-06-23 12:28:11 -070086
87 /* keep track of minimum RTT seen so far, minRTT is zero at first */
88 if (ca->minRTT > srtt || !ca->minRTT)
89 ca->minRTT = srtt;
90
91 /* max RTT */
Stephen Hemmingerf34d1952007-08-07 18:29:05 -070092 if (icsk->icsk_ca_state == TCP_CA_Open) {
Baruch Evena7868ea2005-06-23 12:28:11 -070093 if (ca->maxRTT < ca->minRTT)
94 ca->maxRTT = ca->minRTT;
Joe Perches9d4fb272009-11-23 10:41:23 -080095 if (ca->maxRTT < srtt &&
96 srtt <= ca->maxRTT + msecs_to_jiffies(20))
Baruch Evena7868ea2005-06-23 12:28:11 -070097 ca->maxRTT = srtt;
98 }
99}
100
stephen hemminger688d1942014-08-29 23:32:05 -0700101static void measure_achieved_throughput(struct sock *sk,
102 u32 pkts_acked, s32 rtt)
Baruch Evena7868ea2005-06-23 12:28:11 -0700103{
Arnaldo Carvalho de Melo6687e982005-08-10 04:03:31 -0300104 const struct inet_connection_sock *icsk = inet_csk(sk);
105 const struct tcp_sock *tp = tcp_sk(sk);
106 struct htcp *ca = inet_csk_ca(sk);
Baruch Evena7868ea2005-06-23 12:28:11 -0700107 u32 now = tcp_time_stamp;
108
Baruch Even0bc6d902006-03-20 22:22:47 -0800109 if (icsk->icsk_ca_state == TCP_CA_Open)
110 ca->pkts_acked = pkts_acked;
111
Stephen Hemminger113bbbd2007-07-25 23:50:28 -0700112 if (rtt > 0)
113 measure_rtt(sk, usecs_to_jiffies(rtt));
114
Baruch Even0bc6d902006-03-20 22:22:47 -0800115 if (!use_bandwidth_switch)
116 return;
117
Baruch Evena7868ea2005-06-23 12:28:11 -0700118 /* achieved throughput calculations */
Ilpo Järvinen571a5dd2009-02-28 04:44:36 +0000119 if (!((1 << icsk->icsk_ca_state) & (TCPF_CA_Open | TCPF_CA_Disorder))) {
Baruch Evena7868ea2005-06-23 12:28:11 -0700120 ca->packetcount = 0;
121 ca->lasttime = now;
122 return;
123 }
124
125 ca->packetcount += pkts_acked;
126
Joe Perches9d4fb272009-11-23 10:41:23 -0800127 if (ca->packetcount >= tp->snd_cwnd - (ca->alpha >> 7 ? : 1) &&
128 now - ca->lasttime >= ca->minRTT &&
129 ca->minRTT > 0) {
Stephen Hemminger9121c7772007-02-12 13:34:03 -0800130 __u32 cur_Bi = ca->packetcount * HZ / (now - ca->lasttime);
131
Baruch Even50bf3e22006-03-20 22:23:10 -0800132 if (htcp_ccount(ca) <= 3) {
Baruch Evena7868ea2005-06-23 12:28:11 -0700133 /* just after backoff */
134 ca->minB = ca->maxB = ca->Bi = cur_Bi;
135 } else {
Stephen Hemminger9121c7772007-02-12 13:34:03 -0800136 ca->Bi = (3 * ca->Bi + cur_Bi) / 4;
Baruch Evena7868ea2005-06-23 12:28:11 -0700137 if (ca->Bi > ca->maxB)
138 ca->maxB = ca->Bi;
139 if (ca->minB > ca->maxB)
140 ca->minB = ca->maxB;
141 }
142 ca->packetcount = 0;
143 ca->lasttime = now;
144 }
145}
146
147static inline void htcp_beta_update(struct htcp *ca, u32 minRTT, u32 maxRTT)
148{
149 if (use_bandwidth_switch) {
150 u32 maxB = ca->maxB;
151 u32 old_maxB = ca->old_maxB;
Baruch Evena7868ea2005-06-23 12:28:11 -0700152
stephen hemminger688d1942014-08-29 23:32:05 -0700153 ca->old_maxB = ca->maxB;
Stephen Hemminger9121c7772007-02-12 13:34:03 -0800154 if (!between(5 * maxB, 4 * old_maxB, 6 * old_maxB)) {
Baruch Evena7868ea2005-06-23 12:28:11 -0700155 ca->beta = BETA_MIN;
156 ca->modeswitch = 0;
157 return;
158 }
159 }
160
Baruch Evenc33ad6e2006-03-20 22:22:20 -0800161 if (ca->modeswitch && minRTT > msecs_to_jiffies(10) && maxRTT) {
Stephen Hemminger9121c7772007-02-12 13:34:03 -0800162 ca->beta = (minRTT << 7) / maxRTT;
Baruch Evena7868ea2005-06-23 12:28:11 -0700163 if (ca->beta < BETA_MIN)
164 ca->beta = BETA_MIN;
165 else if (ca->beta > BETA_MAX)
166 ca->beta = BETA_MAX;
167 } else {
168 ca->beta = BETA_MIN;
169 ca->modeswitch = 1;
170 }
171}
172
173static inline void htcp_alpha_update(struct htcp *ca)
174{
175 u32 minRTT = ca->minRTT;
176 u32 factor = 1;
Baruch Even50bf3e22006-03-20 22:23:10 -0800177 u32 diff = htcp_cong_time(ca);
Baruch Evena7868ea2005-06-23 12:28:11 -0700178
179 if (diff > HZ) {
180 diff -= HZ;
Stephen Hemminger9121c7772007-02-12 13:34:03 -0800181 factor = 1 + (10 * diff + ((diff / 2) * (diff / 2) / HZ)) / HZ;
Baruch Evena7868ea2005-06-23 12:28:11 -0700182 }
183
184 if (use_rtt_scaling && minRTT) {
Stephen Hemminger9121c7772007-02-12 13:34:03 -0800185 u32 scale = (HZ << 3) / (10 * minRTT);
186
187 /* clamping ratio to interval [0.5,10]<<3 */
188 scale = min(max(scale, 1U << 2), 10U << 3);
189 factor = (factor << 3) / scale;
Baruch Evena7868ea2005-06-23 12:28:11 -0700190 if (!factor)
191 factor = 1;
192 }
193
Stephen Hemminger9121c7772007-02-12 13:34:03 -0800194 ca->alpha = 2 * factor * ((1 << 7) - ca->beta);
Baruch Evena7868ea2005-06-23 12:28:11 -0700195 if (!ca->alpha)
196 ca->alpha = ALPHA_BASE;
197}
198
Stephen Hemminger9121c7772007-02-12 13:34:03 -0800199/*
200 * After we have the rtt data to calculate beta, we'd still prefer to wait one
Baruch Evena7868ea2005-06-23 12:28:11 -0700201 * rtt before we adjust our beta to ensure we are working from a consistent
202 * data.
203 *
204 * This function should be called when we hit a congestion event since only at
205 * that point do we really have a real sense of maxRTT (the queues en route
206 * were getting just too full now).
207 */
Arnaldo Carvalho de Melo6687e982005-08-10 04:03:31 -0300208static void htcp_param_update(struct sock *sk)
Baruch Evena7868ea2005-06-23 12:28:11 -0700209{
Arnaldo Carvalho de Melo6687e982005-08-10 04:03:31 -0300210 struct htcp *ca = inet_csk_ca(sk);
Baruch Evena7868ea2005-06-23 12:28:11 -0700211 u32 minRTT = ca->minRTT;
212 u32 maxRTT = ca->maxRTT;
213
214 htcp_beta_update(ca, minRTT, maxRTT);
215 htcp_alpha_update(ca);
216
Stephen Hemminger9121c7772007-02-12 13:34:03 -0800217 /* add slowly fading memory for maxRTT to accommodate routing changes */
Baruch Evena7868ea2005-06-23 12:28:11 -0700218 if (minRTT > 0 && maxRTT > minRTT)
Stephen Hemminger9121c7772007-02-12 13:34:03 -0800219 ca->maxRTT = minRTT + ((maxRTT - minRTT) * 95) / 100;
Baruch Evena7868ea2005-06-23 12:28:11 -0700220}
221
Arnaldo Carvalho de Melo6687e982005-08-10 04:03:31 -0300222static u32 htcp_recalc_ssthresh(struct sock *sk)
Baruch Evena7868ea2005-06-23 12:28:11 -0700223{
Arnaldo Carvalho de Melo6687e982005-08-10 04:03:31 -0300224 const struct tcp_sock *tp = tcp_sk(sk);
225 const struct htcp *ca = inet_csk_ca(sk);
Stephen Hemminger9121c7772007-02-12 13:34:03 -0800226
Arnaldo Carvalho de Melo6687e982005-08-10 04:03:31 -0300227 htcp_param_update(sk);
Baruch Evena7868ea2005-06-23 12:28:11 -0700228 return max((tp->snd_cwnd * ca->beta) >> 7, 2U);
229}
230
Eric Dumazet24901552014-05-02 21:18:05 -0700231static void htcp_cong_avoid(struct sock *sk, u32 ack, u32 acked)
Baruch Evena7868ea2005-06-23 12:28:11 -0700232{
Arnaldo Carvalho de Melo6687e982005-08-10 04:03:31 -0300233 struct tcp_sock *tp = tcp_sk(sk);
234 struct htcp *ca = inet_csk_ca(sk);
Baruch Evena7868ea2005-06-23 12:28:11 -0700235
Eric Dumazet24901552014-05-02 21:18:05 -0700236 if (!tcp_is_cwnd_limited(sk))
Baruch Evena7868ea2005-06-23 12:28:11 -0700237 return;
238
Yuchung Cheng071d5082015-07-09 13:16:29 -0700239 if (tcp_in_slow_start(tp))
Yuchung Cheng9f9843a72013-10-31 11:07:31 -0700240 tcp_slow_start(tp, acked);
Stephen Hemminger7faffa12005-11-10 17:07:24 -0800241 else {
Stephen Hemminger7faffa12005-11-10 17:07:24 -0800242 /* In dangerous area, increase slowly.
Baruch Evena7868ea2005-06-23 12:28:11 -0700243 * In theory this is tp->snd_cwnd += alpha / tp->snd_cwnd
244 */
Baruch Even0bc6d902006-03-20 22:22:47 -0800245 if ((tp->snd_cwnd_cnt * ca->alpha)>>7 >= tp->snd_cwnd) {
Baruch Evena7868ea2005-06-23 12:28:11 -0700246 if (tp->snd_cwnd < tp->snd_cwnd_clamp)
247 tp->snd_cwnd++;
248 tp->snd_cwnd_cnt = 0;
Baruch Even50bf3e22006-03-20 22:23:10 -0800249 htcp_alpha_update(ca);
Baruch Even0bc6d902006-03-20 22:22:47 -0800250 } else
251 tp->snd_cwnd_cnt += ca->pkts_acked;
252
253 ca->pkts_acked = 1;
Baruch Evena7868ea2005-06-23 12:28:11 -0700254 }
255}
256
Arnaldo Carvalho de Melo6687e982005-08-10 04:03:31 -0300257static void htcp_init(struct sock *sk)
Baruch Evena7868ea2005-06-23 12:28:11 -0700258{
Arnaldo Carvalho de Melo6687e982005-08-10 04:03:31 -0300259 struct htcp *ca = inet_csk_ca(sk);
Baruch Evena7868ea2005-06-23 12:28:11 -0700260
261 memset(ca, 0, sizeof(struct htcp));
262 ca->alpha = ALPHA_BASE;
263 ca->beta = BETA_MIN;
Baruch Even0bc6d902006-03-20 22:22:47 -0800264 ca->pkts_acked = 1;
Baruch Even50bf3e22006-03-20 22:23:10 -0800265 ca->last_cong = jiffies;
Baruch Evena7868ea2005-06-23 12:28:11 -0700266}
267
Arnaldo Carvalho de Melo6687e982005-08-10 04:03:31 -0300268static void htcp_state(struct sock *sk, u8 new_state)
Baruch Evena7868ea2005-06-23 12:28:11 -0700269{
270 switch (new_state) {
Baruch Even50bf3e22006-03-20 22:23:10 -0800271 case TCP_CA_Open:
272 {
273 struct htcp *ca = inet_csk_ca(sk);
stephen hemminger688d1942014-08-29 23:32:05 -0700274
Doug Leith8f65b532008-11-12 01:41:09 -0800275 if (ca->undo_last_cong) {
276 ca->last_cong = jiffies;
277 ca->undo_last_cong = 0;
278 }
Baruch Even50bf3e22006-03-20 22:23:10 -0800279 }
280 break;
Baruch Evena7868ea2005-06-23 12:28:11 -0700281 case TCP_CA_CWR:
282 case TCP_CA_Recovery:
283 case TCP_CA_Loss:
Arnaldo Carvalho de Melo6687e982005-08-10 04:03:31 -0300284 htcp_reset(inet_csk_ca(sk));
Baruch Evena7868ea2005-06-23 12:28:11 -0700285 break;
286 }
287}
288
Stephen Hemmingera252beb2011-03-10 00:40:17 -0800289static struct tcp_congestion_ops htcp __read_mostly = {
Baruch Evena7868ea2005-06-23 12:28:11 -0700290 .init = htcp_init,
291 .ssthresh = htcp_recalc_ssthresh,
Baruch Evena7868ea2005-06-23 12:28:11 -0700292 .cong_avoid = htcp_cong_avoid,
293 .set_state = htcp_state,
294 .undo_cwnd = htcp_cwnd_undo,
295 .pkts_acked = measure_achieved_throughput,
296 .owner = THIS_MODULE,
297 .name = "htcp",
298};
299
300static int __init htcp_register(void)
301{
Alexey Dobriyan74975d42006-08-25 17:10:33 -0700302 BUILD_BUG_ON(sizeof(struct htcp) > ICSK_CA_PRIV_SIZE);
Baruch Evena7868ea2005-06-23 12:28:11 -0700303 BUILD_BUG_ON(BETA_MIN >= BETA_MAX);
Baruch Evena7868ea2005-06-23 12:28:11 -0700304 return tcp_register_congestion_control(&htcp);
305}
306
307static void __exit htcp_unregister(void)
308{
309 tcp_unregister_congestion_control(&htcp);
310}
311
312module_init(htcp_register);
313module_exit(htcp_unregister);
314
315MODULE_AUTHOR("Baruch Even");
316MODULE_LICENSE("GPL");
317MODULE_DESCRIPTION("H-TCP");