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