2 * Plugable TCP congestion control support and newReno
4 * Based on ideas from I/O scheduler suport and Web100.
6 * Copyright (C) 2005 Stephen Hemminger <shemminger@osdl.org>
9 #include <linux/module.h>
11 #include <linux/types.h>
12 #include <linux/list.h>
15 int sysctl_tcp_max_ssthresh = 0;
17 static DEFINE_SPINLOCK(tcp_cong_list_lock);
18 static LIST_HEAD(tcp_cong_list);
20 /* Simple linear search, don't expect many entries! */
21 static struct tcp_congestion_ops *tcp_ca_find(const char *name)
23 struct tcp_congestion_ops *e;
25 list_for_each_entry_rcu(e, &tcp_cong_list, list) {
26 if (strcmp(e->name, name) == 0)
34 * Attach new congestion control algorithm to the list
35 * of available options.
37 int tcp_register_congestion_control(struct tcp_congestion_ops *ca)
41 /* all algorithms must implement ssthresh and cong_avoid ops */
42 if (!ca->ssthresh || !ca->cong_avoid) {
43 printk(KERN_ERR "TCP %s does not implement required ops\n",
48 spin_lock(&tcp_cong_list_lock);
49 if (tcp_ca_find(ca->name)) {
50 printk(KERN_NOTICE "TCP %s already registered\n", ca->name);
53 list_add_tail_rcu(&ca->list, &tcp_cong_list);
54 printk(KERN_INFO "TCP %s registered\n", ca->name);
56 spin_unlock(&tcp_cong_list_lock);
60 EXPORT_SYMBOL_GPL(tcp_register_congestion_control);
63 * Remove congestion control algorithm, called from
64 * the module's remove function. Module ref counts are used
65 * to ensure that this can't be done till all sockets using
66 * that method are closed.
68 void tcp_unregister_congestion_control(struct tcp_congestion_ops *ca)
70 spin_lock(&tcp_cong_list_lock);
71 list_del_rcu(&ca->list);
72 spin_unlock(&tcp_cong_list_lock);
74 EXPORT_SYMBOL_GPL(tcp_unregister_congestion_control);
76 /* Assign choice of congestion control. */
77 void tcp_init_congestion_control(struct sock *sk)
79 struct inet_connection_sock *icsk = inet_csk(sk);
80 struct tcp_congestion_ops *ca;
82 /* if no choice made yet assign the current value set as default */
83 if (icsk->icsk_ca_ops == &tcp_init_congestion_ops) {
85 list_for_each_entry_rcu(ca, &tcp_cong_list, list) {
86 if (try_module_get(ca->owner)) {
87 icsk->icsk_ca_ops = ca;
91 /* fallback to next available */
96 if (icsk->icsk_ca_ops->init)
97 icsk->icsk_ca_ops->init(sk);
100 /* Manage refcounts on socket close. */
101 void tcp_cleanup_congestion_control(struct sock *sk)
103 struct inet_connection_sock *icsk = inet_csk(sk);
105 if (icsk->icsk_ca_ops->release)
106 icsk->icsk_ca_ops->release(sk);
107 module_put(icsk->icsk_ca_ops->owner);
110 /* Used by sysctl to change default congestion control */
111 int tcp_set_default_congestion_control(const char *name)
113 struct tcp_congestion_ops *ca;
116 spin_lock(&tcp_cong_list_lock);
117 ca = tcp_ca_find(name);
119 if (!ca && capable(CAP_SYS_MODULE)) {
120 spin_unlock(&tcp_cong_list_lock);
122 request_module("tcp_%s", name);
123 spin_lock(&tcp_cong_list_lock);
124 ca = tcp_ca_find(name);
129 ca->flags |= TCP_CONG_NON_RESTRICTED; /* default is always allowed */
130 list_move(&ca->list, &tcp_cong_list);
133 spin_unlock(&tcp_cong_list_lock);
138 /* Set default value from kernel configuration at bootup */
139 static int __init tcp_congestion_default(void)
141 return tcp_set_default_congestion_control(CONFIG_DEFAULT_TCP_CONG);
143 late_initcall(tcp_congestion_default);
146 /* Build string with list of available congestion control values */
147 void tcp_get_available_congestion_control(char *buf, size_t maxlen)
149 struct tcp_congestion_ops *ca;
153 list_for_each_entry_rcu(ca, &tcp_cong_list, list) {
154 offs += snprintf(buf + offs, maxlen - offs,
156 offs == 0 ? "" : " ", ca->name);
162 /* Get current default congestion control */
163 void tcp_get_default_congestion_control(char *name)
165 struct tcp_congestion_ops *ca;
166 /* We will always have reno... */
167 BUG_ON(list_empty(&tcp_cong_list));
170 ca = list_entry(tcp_cong_list.next, struct tcp_congestion_ops, list);
171 strncpy(name, ca->name, TCP_CA_NAME_MAX);
175 /* Built list of non-restricted congestion control values */
176 void tcp_get_allowed_congestion_control(char *buf, size_t maxlen)
178 struct tcp_congestion_ops *ca;
183 list_for_each_entry_rcu(ca, &tcp_cong_list, list) {
184 if (!(ca->flags & TCP_CONG_NON_RESTRICTED))
186 offs += snprintf(buf + offs, maxlen - offs,
188 offs == 0 ? "" : " ", ca->name);
194 /* Change list of non-restricted congestion control */
195 int tcp_set_allowed_congestion_control(char *val)
197 struct tcp_congestion_ops *ca;
201 clone = kstrdup(val, GFP_USER);
205 spin_lock(&tcp_cong_list_lock);
206 /* pass 1 check for bad entries */
207 while ((name = strsep(&clone, " ")) && *name) {
208 ca = tcp_ca_find(name);
215 /* pass 2 clear old values */
216 list_for_each_entry_rcu(ca, &tcp_cong_list, list)
217 ca->flags &= ~TCP_CONG_NON_RESTRICTED;
219 /* pass 3 mark as allowed */
220 while ((name = strsep(&val, " ")) && *name) {
221 ca = tcp_ca_find(name);
224 ca->flags |= TCP_CONG_NON_RESTRICTED;
227 spin_unlock(&tcp_cong_list_lock);
233 /* Change congestion control for socket */
234 int tcp_set_congestion_control(struct sock *sk, const char *name)
236 struct inet_connection_sock *icsk = inet_csk(sk);
237 struct tcp_congestion_ops *ca;
241 ca = tcp_ca_find(name);
243 /* no change asking for existing value */
244 if (ca == icsk->icsk_ca_ops)
248 /* not found attempt to autoload module */
249 if (!ca && capable(CAP_SYS_MODULE)) {
251 request_module("tcp_%s", name);
253 ca = tcp_ca_find(name);
259 else if (!((ca->flags & TCP_CONG_NON_RESTRICTED) || capable(CAP_NET_ADMIN)))
262 else if (!try_module_get(ca->owner))
266 tcp_cleanup_congestion_control(sk);
267 icsk->icsk_ca_ops = ca;
269 if (sk->sk_state != TCP_CLOSE && icsk->icsk_ca_ops->init)
270 icsk->icsk_ca_ops->init(sk);
279 * Slow start is used when congestion window is less than slow start
280 * threshold. This version implements the basic RFC2581 version
281 * and optionally supports:
282 * RFC3742 Limited Slow Start - growth limited to max_ssthresh
283 * RFC3465 Appropriate Byte Counting - growth limited by bytes acknowledged
285 void tcp_slow_start(struct tcp_sock *tp)
287 int cnt; /* increase in packets */
289 /* RFC3465: ABC Slow start
290 * Increase only after a full MSS of bytes is acked
292 * TCP sender SHOULD increase cwnd by the number of
293 * previously unacknowledged bytes ACKed by each incoming
294 * acknowledgment, provided the increase is not more than L
296 if (sysctl_tcp_abc && tp->bytes_acked < tp->mss_cache)
299 if (sysctl_tcp_max_ssthresh > 0 && tp->snd_cwnd > sysctl_tcp_max_ssthresh)
300 cnt = sysctl_tcp_max_ssthresh >> 1; /* limited slow start */
302 cnt = tp->snd_cwnd; /* exponential increase */
305 * We MAY increase by 2 if discovered delayed ack
307 if (sysctl_tcp_abc > 1 && tp->bytes_acked >= 2*tp->mss_cache)
311 tp->snd_cwnd_cnt += cnt;
312 while (tp->snd_cwnd_cnt >= tp->snd_cwnd) {
313 tp->snd_cwnd_cnt -= tp->snd_cwnd;
314 if (tp->snd_cwnd < tp->snd_cwnd_clamp)
318 EXPORT_SYMBOL_GPL(tcp_slow_start);
321 * TCP Reno congestion control
322 * This is special case used for fallback as well.
324 /* This is Jacobson's slow start and congestion avoidance.
325 * SIGCOMM '88, p. 328.
327 void tcp_reno_cong_avoid(struct sock *sk, u32 ack, u32 in_flight)
329 struct tcp_sock *tp = tcp_sk(sk);
331 if (!tcp_is_cwnd_limited(sk, in_flight))
334 /* In "safe" area, increase. */
335 if (tp->snd_cwnd <= tp->snd_ssthresh)
338 /* In dangerous area, increase slowly. */
339 else if (sysctl_tcp_abc) {
340 /* RFC3465: Appropriate Byte Count
341 * increase once for each full cwnd acked
343 if (tp->bytes_acked >= tp->snd_cwnd*tp->mss_cache) {
344 tp->bytes_acked -= tp->snd_cwnd*tp->mss_cache;
345 if (tp->snd_cwnd < tp->snd_cwnd_clamp)
349 /* In theory this is tp->snd_cwnd += 1 / tp->snd_cwnd */
350 if (tp->snd_cwnd_cnt >= tp->snd_cwnd) {
351 if (tp->snd_cwnd < tp->snd_cwnd_clamp)
353 tp->snd_cwnd_cnt = 0;
358 EXPORT_SYMBOL_GPL(tcp_reno_cong_avoid);
360 /* Slow start threshold is half the congestion window (min 2) */
361 u32 tcp_reno_ssthresh(struct sock *sk)
363 const struct tcp_sock *tp = tcp_sk(sk);
364 return max(tp->snd_cwnd >> 1U, 2U);
366 EXPORT_SYMBOL_GPL(tcp_reno_ssthresh);
368 /* Lower bound on congestion window with halving. */
369 u32 tcp_reno_min_cwnd(const struct sock *sk)
371 const struct tcp_sock *tp = tcp_sk(sk);
372 return tp->snd_ssthresh/2;
374 EXPORT_SYMBOL_GPL(tcp_reno_min_cwnd);
376 struct tcp_congestion_ops tcp_reno = {
377 .flags = TCP_CONG_NON_RESTRICTED,
379 .owner = THIS_MODULE,
380 .ssthresh = tcp_reno_ssthresh,
381 .cong_avoid = tcp_reno_cong_avoid,
382 .min_cwnd = tcp_reno_min_cwnd,
385 /* Initial congestion control used (until SYN)
386 * really reno under another name so we can tell difference
387 * during tcp_set_default_congestion_control
389 struct tcp_congestion_ops tcp_init_congestion_ops = {
391 .owner = THIS_MODULE,
392 .ssthresh = tcp_reno_ssthresh,
393 .cong_avoid = tcp_reno_cong_avoid,
394 .min_cwnd = tcp_reno_min_cwnd,
396 EXPORT_SYMBOL_GPL(tcp_init_congestion_ops);