net/ipv4/tcp_cong.c

   1 /*
   2  * Pluggable TCP congestion control support and newReno
   3  * congestion control.
   4  * Based on ideas from I/O scheduler support and Web100.
   5  *
   6  * Copyright (C) 2005 Stephen Hemminger <shemminger@osdl.org>
   7  */
   8
   9 #define pr_fmt(fmt) "TCP: " fmt
  10
  11 #include <linux/module.h>
  12 #include <linux/mm.h>
  13 #include <linux/types.h>
  14 #include <linux/list.h>
  15 #include <linux/gfp.h>
  16 #include <linux/jhash.h>
  17 #include <net/tcp.h>
  18
  19 static DEFINE_SPINLOCK(tcp_cong_list_lock);
  20 static LIST_HEAD(tcp_cong_list);
  21
  22 /* Simple linear search, don't expect many entries! */
  23 static struct tcp_congestion_ops *tcp_ca_find(const char *name)
  24 {
  25         struct tcp_congestion_ops *e;
  26
  27         list_for_each_entry_rcu(e, &tcp_cong_list, list) {
  28                 if (strcmp(e->name, name) == 0)
  29                         return e;
  30         }
  31
  32         return NULL;
  33 }
  34
  35 /* Must be called with rcu lock held */
  36 static struct tcp_congestion_ops *tcp_ca_find_autoload(struct net *net,
  37                                                        const char *name)
  38 {
  39         struct tcp_congestion_ops *ca = tcp_ca_find(name);
  40
  41 #ifdef CONFIG_MODULES
  42         if (!ca && capable(CAP_NET_ADMIN)) {
  43                 rcu_read_unlock();
  44                 request_module("tcp_%s", name);
  45                 rcu_read_lock();
  46                 ca = tcp_ca_find(name);
  47         }
  48 #endif
  49         return ca;
  50 }
  51
  52 /* Simple linear search, not much in here. */
  53 struct tcp_congestion_ops *tcp_ca_find_key(u32 key)
  54 {
  55         struct tcp_congestion_ops *e;
  56
  57         list_for_each_entry_rcu(e, &tcp_cong_list, list) {
  58                 if (e->key == key)
  59                         return e;
  60         }
  61
  62         return NULL;
  63 }
  64
  65 /*
  66  * Attach new congestion control algorithm to the list
  67  * of available options.
  68  */
  69 int tcp_register_congestion_control(struct tcp_congestion_ops *ca)
  70 {
  71         int ret = 0;
  72
  73         /* all algorithms must implement these */
  74         if (!ca->ssthresh || !ca->undo_cwnd ||
  75             !(ca->cong_avoid || ca->cong_control)) {
  76                 pr_err("%s does not implement required ops\n", ca->name);
  77                 return -EINVAL;
  78         }
  79
  80         ca->key = jhash(ca->name, sizeof(ca->name), strlen(ca->name));
  81
  82         spin_lock(&tcp_cong_list_lock);
  83         if (ca->key == TCP_CA_UNSPEC || tcp_ca_find_key(ca->key)) {
  84                 pr_notice("%s already registered or non-unique key\n",
  85                           ca->name);
  86                 ret = -EEXIST;
  87         } else {
  88                 list_add_tail_rcu(&ca->list, &tcp_cong_list);
  89                 pr_debug("%s registered\n", ca->name);
  90         }
  91         spin_unlock(&tcp_cong_list_lock);
  92
  93         return ret;
  94 }
  95 EXPORT_SYMBOL_GPL(tcp_register_congestion_control);
  96
  97 /*
  98  * Remove congestion control algorithm, called from
  99  * the module's remove function.  Module ref counts are used
 100  * to ensure that this can't be done till all sockets using
 101  * that method are closed.
 102  */
 103 void tcp_unregister_congestion_control(struct tcp_congestion_ops *ca)
 104 {
 105         spin_lock(&tcp_cong_list_lock);
 106         list_del_rcu(&ca->list);
 107         spin_unlock(&tcp_cong_list_lock);
 108
 109         /* Wait for outstanding readers to complete before the
 110          * module gets removed entirely.
 111          *
 112          * A try_module_get() should fail by now as our module is
 113          * in "going" state since no refs are held anymore and
 114          * module_exit() handler being called.
 115          */
 116         synchronize_rcu();
 117 }
 118 EXPORT_SYMBOL_GPL(tcp_unregister_congestion_control);
 119
 120 u32 tcp_ca_get_key_by_name(struct net *net, const char *name, bool *ecn_ca)
 121 {
 122         const struct tcp_congestion_ops *ca;
 123         u32 key = TCP_CA_UNSPEC;
 124
 125         might_sleep();
 126
 127         rcu_read_lock();
 128         ca = tcp_ca_find_autoload(net, name);
 129         if (ca) {
 130                 key = ca->key;
 131                 *ecn_ca = ca->flags & TCP_CONG_NEEDS_ECN;
 132         }
 133         rcu_read_unlock();
 134
 135         return key;
 136 }
 137 EXPORT_SYMBOL_GPL(tcp_ca_get_key_by_name);
 138
 139 char *tcp_ca_get_name_by_key(u32 key, char *buffer)
 140 {
 141         const struct tcp_congestion_ops *ca;
 142         char *ret = NULL;
 143
 144         rcu_read_lock();
 145         ca = tcp_ca_find_key(key);
 146         if (ca)
 147                 ret = strncpy(buffer, ca->name,
 148                               TCP_CA_NAME_MAX);
 149         rcu_read_unlock();
 150
 151         return ret;
 152 }
 153 EXPORT_SYMBOL_GPL(tcp_ca_get_name_by_key);
 154
 155 /* Assign choice of congestion control. */
 156 void tcp_assign_congestion_control(struct sock *sk)
 157 {
 158         struct net *net = sock_net(sk);
 159         struct inet_connection_sock *icsk = inet_csk(sk);
 160         const struct tcp_congestion_ops *ca;
 161
 162         rcu_read_lock();
 163         ca = rcu_dereference(net->ipv4.tcp_congestion_control);
 164         if (unlikely(!try_module_get(ca->owner)))
 165                 ca = &tcp_reno;
 166         icsk->icsk_ca_ops = ca;
 167         rcu_read_unlock();
 168
 169         memset(icsk->icsk_ca_priv, 0, sizeof(icsk->icsk_ca_priv));
 170         if (ca->flags & TCP_CONG_NEEDS_ECN)
 171                 INET_ECN_xmit(sk);
 172         else
 173                 INET_ECN_dontxmit(sk);
 174 }
 175
 176 void tcp_init_congestion_control(struct sock *sk)
 177 {
 178         const struct inet_connection_sock *icsk = inet_csk(sk);
 179
 180         tcp_sk(sk)->prior_ssthresh = 0;
 181         if (icsk->icsk_ca_ops->init)
 182                 icsk->icsk_ca_ops->init(sk);
 183         if (tcp_ca_needs_ecn(sk))
 184                 INET_ECN_xmit(sk);
 185         else
 186                 INET_ECN_dontxmit(sk);
 187 }
 188
 189 static void tcp_reinit_congestion_control(struct sock *sk,
 190                                           const struct tcp_congestion_ops *ca)
 191 {
 192         struct inet_connection_sock *icsk = inet_csk(sk);
 193
 194         tcp_cleanup_congestion_control(sk);
 195         icsk->icsk_ca_ops = ca;
 196         icsk->icsk_ca_setsockopt = 1;
 197         memset(icsk->icsk_ca_priv, 0, sizeof(icsk->icsk_ca_priv));
 198
 199         if (ca->flags & TCP_CONG_NEEDS_ECN)
 200                 INET_ECN_xmit(sk);
 201         else
 202                 INET_ECN_dontxmit(sk);
 203
 204         if (!((1 << sk->sk_state) & (TCPF_CLOSE | TCPF_LISTEN)))
 205                 tcp_init_congestion_control(sk);
 206 }
 207
 208 /* Manage refcounts on socket close. */
 209 void tcp_cleanup_congestion_control(struct sock *sk)
 210 {
 211         struct inet_connection_sock *icsk = inet_csk(sk);
 212
 213         if (icsk->icsk_ca_ops->release)
 214                 icsk->icsk_ca_ops->release(sk);
 215         module_put(icsk->icsk_ca_ops->owner);
 216 }
 217
 218 /* Used by sysctl to change default congestion control */
 219 int tcp_set_default_congestion_control(struct net *net, const char *name)
 220 {
 221         struct tcp_congestion_ops *ca;
 222         const struct tcp_congestion_ops *prev;
 223         int ret;
 224
 225         rcu_read_lock();
 226         ca = tcp_ca_find_autoload(net, name);
 227         if (!ca) {
 228                 ret = -ENOENT;
 229         } else if (!try_module_get(ca->owner)) {
 230                 ret = -EBUSY;
 231         } else if (!net_eq(net, &init_net) &&
 232                         !(ca->flags & TCP_CONG_NON_RESTRICTED)) {
 233                 /* Only init netns can set default to a restricted algorithm */
 234                 ret = -EPERM;
 235         } else {
 236                 prev = xchg(&net->ipv4.tcp_congestion_control, ca);
 237                 if (prev)
 238                         module_put(prev->owner);
 239
 240                 ca->flags |= TCP_CONG_NON_RESTRICTED;
 241                 ret = 0;
 242         }
 243         rcu_read_unlock();
 244
 245         return ret;
 246 }
 247
 248 /* Set default value from kernel configuration at bootup */
 249 static int __init tcp_congestion_default(void)
 250 {
 251         return tcp_set_default_congestion_control(&init_net,
 252                                                   CONFIG_DEFAULT_TCP_CONG);
 253 }
 254 late_initcall(tcp_congestion_default);
 255
 256 /* Build string with list of available congestion control values */
 257 void tcp_get_available_congestion_control(char *buf, size_t maxlen)
 258 {
 259         struct tcp_congestion_ops *ca;
 260         size_t offs = 0;
 261
 262         rcu_read_lock();
 263         list_for_each_entry_rcu(ca, &tcp_cong_list, list) {
 264                 offs += snprintf(buf + offs, maxlen - offs,
 265                                  "%s%s",
 266                                  offs == 0 ? "" : " ", ca->name);
 267         }
 268         rcu_read_unlock();
 269 }
 270
 271 /* Get current default congestion control */
 272 void tcp_get_default_congestion_control(struct net *net, char *name)
 273 {
 274         const struct tcp_congestion_ops *ca;
 275
 276         rcu_read_lock();
 277         ca = rcu_dereference(net->ipv4.tcp_congestion_control);
 278         strncpy(name, ca->name, TCP_CA_NAME_MAX);
 279         rcu_read_unlock();
 280 }
 281
 282 /* Built list of non-restricted congestion control values */
 283 void tcp_get_allowed_congestion_control(char *buf, size_t maxlen)
 284 {
 285         struct tcp_congestion_ops *ca;
 286         size_t offs = 0;
 287
 288         *buf = '\0';
 289         rcu_read_lock();
 290         list_for_each_entry_rcu(ca, &tcp_cong_list, list) {
 291                 if (!(ca->flags & TCP_CONG_NON_RESTRICTED))
 292                         continue;
 293                 offs += snprintf(buf + offs, maxlen - offs,
 294                                  "%s%s",
 295                                  offs == 0 ? "" : " ", ca->name);
 296         }
 297         rcu_read_unlock();
 298 }
 299
 300 /* Change list of non-restricted congestion control */
 301 int tcp_set_allowed_congestion_control(char *val)
 302 {
 303         struct tcp_congestion_ops *ca;
 304         char *saved_clone, *clone, *name;
 305         int ret = 0;
 306
 307         saved_clone = clone = kstrdup(val, GFP_USER);
 308         if (!clone)
 309                 return -ENOMEM;
 310
 311         spin_lock(&tcp_cong_list_lock);
 312         /* pass 1 check for bad entries */
 313         while ((name = strsep(&clone, " ")) && *name) {
 314                 ca = tcp_ca_find(name);
 315                 if (!ca) {
 316                         ret = -ENOENT;
 317                         goto out;
 318                 }
 319         }
 320
 321         /* pass 2 clear old values */
 322         list_for_each_entry_rcu(ca, &tcp_cong_list, list)
 323                 ca->flags &= ~TCP_CONG_NON_RESTRICTED;
 324
 325         /* pass 3 mark as allowed */
 326         while ((name = strsep(&val, " ")) && *name) {
 327                 ca = tcp_ca_find(name);
 328                 WARN_ON(!ca);
 329                 if (ca)
 330                         ca->flags |= TCP_CONG_NON_RESTRICTED;
 331         }
 332 out:
 333         spin_unlock(&tcp_cong_list_lock);
 334         kfree(saved_clone);
 335
 336         return ret;
 337 }
 338
 339 /* Change congestion control for socket. If load is false, then it is the
 340  * responsibility of the caller to call tcp_init_congestion_control or
 341  * tcp_reinit_congestion_control (if the current congestion control was
 342  * already initialized.
 343  */
 344 int tcp_set_congestion_control(struct sock *sk, const char *name, bool load,
 345                                bool reinit, bool cap_net_admin)
 346 {
 347         struct inet_connection_sock *icsk = inet_csk(sk);
 348         const struct tcp_congestion_ops *ca;
 349         int err = 0;
 350
 351         if (icsk->icsk_ca_dst_locked)
 352                 return -EPERM;
 353
 354         rcu_read_lock();
 355         if (!load)
 356                 ca = tcp_ca_find(name);
 357         else
 358                 ca = tcp_ca_find_autoload(sock_net(sk), name);
 359
 360         /* No change asking for existing value */
 361         if (ca == icsk->icsk_ca_ops) {
 362                 icsk->icsk_ca_setsockopt = 1;
 363                 goto out;
 364         }
 365
 366         if (!ca) {
 367                 err = -ENOENT;
 368         } else if (!load) {
 369                 const struct tcp_congestion_ops *old_ca = icsk->icsk_ca_ops;
 370
 371                 if (try_module_get(ca->owner)) {
 372                         if (reinit) {
 373                                 tcp_reinit_congestion_control(sk, ca);
 374                         } else {
 375                                 icsk->icsk_ca_ops = ca;
 376                                 module_put(old_ca->owner);
 377                         }
 378                 } else {
 379                         err = -EBUSY;
 380                 }
 381         } else if (!((ca->flags & TCP_CONG_NON_RESTRICTED) || cap_net_admin)) {
 382                 err = -EPERM;
 383         } else if (!try_module_get(ca->owner)) {
 384                 err = -EBUSY;
 385         } else {
 386                 tcp_reinit_congestion_control(sk, ca);
 387         }
 388  out:
 389         rcu_read_unlock();
 390         return err;
 391 }
 392
 393 /* Slow start is used when congestion window is no greater than the slow start
 394  * threshold. We base on RFC2581 and also handle stretch ACKs properly.
 395  * We do not implement RFC3465 Appropriate Byte Counting (ABC) per se but
 396  * something better;) a packet is only considered (s)acked in its entirety to
 397  * defend the ACK attacks described in the RFC. Slow start processes a stretch
 398  * ACK of degree N as if N acks of degree 1 are received back to back except
 399  * ABC caps N to 2. Slow start exits when cwnd grows over ssthresh and
 400  * returns the leftover acks to adjust cwnd in congestion avoidance mode.
 401  */
 402 u32 tcp_slow_start(struct tcp_sock *tp, u32 acked)
 403 {
 404         u32 cwnd = min(tp->snd_cwnd + acked, tp->snd_ssthresh);
 405
 406         acked -= cwnd - tp->snd_cwnd;
 407         tp->snd_cwnd = min(cwnd, tp->snd_cwnd_clamp);
 408
 409         return acked;
 410 }
 411 EXPORT_SYMBOL_GPL(tcp_slow_start);
 412
 413 /* In theory this is tp->snd_cwnd += 1 / tp->snd_cwnd (or alternative w),
 414  * for every packet that was ACKed.
 415  */
 416 void tcp_cong_avoid_ai(struct tcp_sock *tp, u32 w, u32 acked)
 417 {
 418         /* If credits accumulated at a higher w, apply them gently now. */
 419         if (tp->snd_cwnd_cnt >= w) {
 420                 tp->snd_cwnd_cnt = 0;
 421                 tp->snd_cwnd++;
 422         }
 423
 424         tp->snd_cwnd_cnt += acked;
 425         if (tp->snd_cwnd_cnt >= w) {
 426                 u32 delta = tp->snd_cwnd_cnt / w;
 427
 428                 tp->snd_cwnd_cnt -= delta * w;
 429                 tp->snd_cwnd += delta;
 430         }
 431         tp->snd_cwnd = min(tp->snd_cwnd, tp->snd_cwnd_clamp);
 432 }
 433 EXPORT_SYMBOL_GPL(tcp_cong_avoid_ai);
 434
 435 /*
 436  * TCP Reno congestion control
 437  * This is special case used for fallback as well.
 438  */
 439 /* This is Jacobson's slow start and congestion avoidance.
 440  * SIGCOMM '88, p. 328.
 441  */
 442 void tcp_reno_cong_avoid(struct sock *sk, u32 ack, u32 acked)
 443 {
 444         struct tcp_sock *tp = tcp_sk(sk);
 445
 446         if (!tcp_is_cwnd_limited(sk))
 447                 return;
 448
 449         /* In "safe" area, increase. */
 450         if (tcp_in_slow_start(tp)) {
 451                 acked = tcp_slow_start(tp, acked);
 452                 if (!acked)
 453                         return;
 454         }
 455         /* In dangerous area, increase slowly. */
 456         tcp_cong_avoid_ai(tp, tp->snd_cwnd, acked);
 457 }
 458 EXPORT_SYMBOL_GPL(tcp_reno_cong_avoid);
 459
 460 /* Slow start threshold is half the congestion window (min 2) */
 461 u32 tcp_reno_ssthresh(struct sock *sk)
 462 {
 463         const struct tcp_sock *tp = tcp_sk(sk);
 464
 465         return max(tp->snd_cwnd >> 1U, 2U);
 466 }
 467 EXPORT_SYMBOL_GPL(tcp_reno_ssthresh);
 468
 469 u32 tcp_reno_undo_cwnd(struct sock *sk)
 470 {
 471         const struct tcp_sock *tp = tcp_sk(sk);
 472
 473         return max(tp->snd_cwnd, tp->prior_cwnd);
 474 }
 475 EXPORT_SYMBOL_GPL(tcp_reno_undo_cwnd);
 476
 477 struct tcp_congestion_ops tcp_reno = {
 478         .flags          = TCP_CONG_NON_RESTRICTED,
 479         .name           = "reno",
 480         .owner          = THIS_MODULE,
 481         .ssthresh       = tcp_reno_ssthresh,
 482         .cong_avoid     = tcp_reno_cong_avoid,
 483         .undo_cwnd      = tcp_reno_undo_cwnd,
 484 };