net/ipv4/tcp_dctcp.c

   1 /* DataCenter TCP (DCTCP) congestion control.
   2  *
   3  * http://simula.stanford.edu/~alizade/Site/DCTCP.html
   4  *
   5  * This is an implementation of DCTCP over Reno, an enhancement to the
   6  * TCP congestion control algorithm designed for data centers. DCTCP
   7  * leverages Explicit Congestion Notification (ECN) in the network to
   8  * provide multi-bit feedback to the end hosts. DCTCP's goal is to meet
   9  * the following three data center transport requirements:
  10  *
  11  *  - High burst tolerance (incast due to partition/aggregate)
  12  *  - Low latency (short flows, queries)
  13  *  - High throughput (continuous data updates, large file transfers)
  14  *    with commodity shallow buffered switches
  15  *
  16  * The algorithm is described in detail in the following two papers:
  17  *
  18  * 1) Mohammad Alizadeh, Albert Greenberg, David A. Maltz, Jitendra Padhye,
  19  *    Parveen Patel, Balaji Prabhakar, Sudipta Sengupta, and Murari Sridharan:
  20  *      "Data Center TCP (DCTCP)", Data Center Networks session
  21  *      Proc. ACM SIGCOMM, New Delhi, 2010.
  22  *   http://simula.stanford.edu/~alizade/Site/DCTCP_files/dctcp-final.pdf
  23  *
  24  * 2) Mohammad Alizadeh, Adel Javanmard, and Balaji Prabhakar:
  25  *      "Analysis of DCTCP: Stability, Convergence, and Fairness"
  26  *      Proc. ACM SIGMETRICS, San Jose, 2011.
  27  *   http://simula.stanford.edu/~alizade/Site/DCTCP_files/dctcp_analysis-full.pdf
  28  *
  29  * Initial prototype from Abdul Kabbani, Masato Yasuda and Mohammad Alizadeh.
  30  *
  31  * Authors:
  32  *
  33  *      Daniel Borkmann <dborkman@redhat.com>
  34  *      Florian Westphal <fw@strlen.de>
  35  *      Glenn Judd <glenn.judd@morganstanley.com>
  36  *
  37  * This program is free software; you can redistribute it and/or modify
  38  * it under the terms of the GNU General Public License as published by
  39  * the Free Software Foundation; either version 2 of the License, or (at
  40  * your option) any later version.
  41  */
  42
  43 #include <linux/module.h>
  44 #include <linux/mm.h>
  45 #include <net/tcp.h>
  46 #include <linux/inet_diag.h>
  47
  48 #define DCTCP_MAX_ALPHA 1024U
  49
  50 struct dctcp {
  51         u32 acked_bytes_ecn;
  52         u32 acked_bytes_total;
  53         u32 prior_snd_una;
  54         u32 prior_rcv_nxt;
  55         u32 dctcp_alpha;
  56         u32 next_seq;
  57         u32 ce_state;
  58         u32 delayed_ack_reserved;
  59         u32 loss_cwnd;
  60 };
  61
  62 static unsigned int dctcp_shift_g __read_mostly = 4; /* g = 1/2^4 */
  63 module_param(dctcp_shift_g, uint, 0644);
  64 MODULE_PARM_DESC(dctcp_shift_g, "parameter g for updating dctcp_alpha");
  65
  66 static unsigned int dctcp_alpha_on_init __read_mostly = DCTCP_MAX_ALPHA;
  67 module_param(dctcp_alpha_on_init, uint, 0644);
  68 MODULE_PARM_DESC(dctcp_alpha_on_init, "parameter for initial alpha value");
  69
  70 static unsigned int dctcp_clamp_alpha_on_loss __read_mostly;
  71 module_param(dctcp_clamp_alpha_on_loss, uint, 0644);
  72 MODULE_PARM_DESC(dctcp_clamp_alpha_on_loss,
  73                  "parameter for clamping alpha on loss");
  74
  75 static struct tcp_congestion_ops dctcp_reno;
  76
  77 static void dctcp_reset(const struct tcp_sock *tp, struct dctcp *ca)
  78 {
  79         ca->next_seq = tp->snd_nxt;
  80
  81         ca->acked_bytes_ecn = 0;
  82         ca->acked_bytes_total = 0;
  83 }
  84
  85 static void dctcp_init(struct sock *sk)
  86 {
  87         const struct tcp_sock *tp = tcp_sk(sk);
  88
  89         if ((tp->ecn_flags & TCP_ECN_OK) ||
  90             (sk->sk_state == TCP_LISTEN ||
  91              sk->sk_state == TCP_CLOSE)) {
  92                 struct dctcp *ca = inet_csk_ca(sk);
  93
  94                 ca->prior_snd_una = tp->snd_una;
  95                 ca->prior_rcv_nxt = tp->rcv_nxt;
  96
  97                 ca->dctcp_alpha = min(dctcp_alpha_on_init, DCTCP_MAX_ALPHA);
  98
  99                 ca->delayed_ack_reserved = 0;
 100                 ca->loss_cwnd = 0;
 101                 ca->ce_state = 0;
 102
 103                 dctcp_reset(tp, ca);
 104                 return;
 105         }
 106
 107         /* No ECN support? Fall back to Reno. Also need to clear
 108          * ECT from sk since it is set during 3WHS for DCTCP.
 109          */
 110         inet_csk(sk)->icsk_ca_ops = &dctcp_reno;
 111         INET_ECN_dontxmit(sk);
 112 }
 113
 114 static u32 dctcp_ssthresh(struct sock *sk)
 115 {
 116         struct dctcp *ca = inet_csk_ca(sk);
 117         struct tcp_sock *tp = tcp_sk(sk);
 118
 119         ca->loss_cwnd = tp->snd_cwnd;
 120         return max(tp->snd_cwnd - ((tp->snd_cwnd * ca->dctcp_alpha) >> 11U), 2U);
 121 }
 122
 123 /* Minimal DCTP CE state machine:
 124  *
 125  * S:   0 <- last pkt was non-CE
 126  *      1 <- last pkt was CE
 127  */
 128
 129 static void dctcp_ce_state_0_to_1(struct sock *sk)
 130 {
 131         struct dctcp *ca = inet_csk_ca(sk);
 132         struct tcp_sock *tp = tcp_sk(sk);
 133
 134         /* State has changed from CE=0 to CE=1 and delayed
 135          * ACK has not sent yet.
 136          */
 137         if (!ca->ce_state &&
 138             inet_csk(sk)->icsk_ack.pending & ICSK_ACK_TIMER) {
 139                 u32 tmp_rcv_nxt;
 140
 141                 /* Save current rcv_nxt. */
 142                 tmp_rcv_nxt = tp->rcv_nxt;
 143
 144                 /* Generate previous ack with CE=0. */
 145                 tp->ecn_flags &= ~TCP_ECN_DEMAND_CWR;
 146                 tp->rcv_nxt = ca->prior_rcv_nxt;
 147
 148                 tcp_send_ack(sk);
 149
 150                 /* Recover current rcv_nxt. */
 151                 tp->rcv_nxt = tmp_rcv_nxt;
 152         }
 153
 154         ca->prior_rcv_nxt = tp->rcv_nxt;
 155         ca->ce_state = 1;
 156
 157         tp->ecn_flags |= TCP_ECN_DEMAND_CWR;
 158 }
 159
 160 static void dctcp_ce_state_1_to_0(struct sock *sk)
 161 {
 162         struct dctcp *ca = inet_csk_ca(sk);
 163         struct tcp_sock *tp = tcp_sk(sk);
 164
 165         /* State has changed from CE=1 to CE=0 and delayed
 166          * ACK has not sent yet.
 167          */
 168         if (ca->ce_state &&
 169             inet_csk(sk)->icsk_ack.pending & ICSK_ACK_TIMER) {
 170                 u32 tmp_rcv_nxt;
 171
 172                 /* Save current rcv_nxt. */
 173                 tmp_rcv_nxt = tp->rcv_nxt;
 174
 175                 /* Generate previous ack with CE=1. */
 176                 tp->ecn_flags |= TCP_ECN_DEMAND_CWR;
 177                 tp->rcv_nxt = ca->prior_rcv_nxt;
 178
 179                 tcp_send_ack(sk);
 180
 181                 /* Recover current rcv_nxt. */
 182                 tp->rcv_nxt = tmp_rcv_nxt;
 183         }
 184
 185         ca->prior_rcv_nxt = tp->rcv_nxt;
 186         ca->ce_state = 0;
 187
 188         tp->ecn_flags &= ~TCP_ECN_DEMAND_CWR;
 189 }
 190
 191 static void dctcp_update_alpha(struct sock *sk, u32 flags)
 192 {
 193         const struct tcp_sock *tp = tcp_sk(sk);
 194         struct dctcp *ca = inet_csk_ca(sk);
 195         u32 acked_bytes = tp->snd_una - ca->prior_snd_una;
 196
 197         /* If ack did not advance snd_una, count dupack as MSS size.
 198          * If ack did update window, do not count it at all.
 199          */
 200         if (acked_bytes == 0 && !(flags & CA_ACK_WIN_UPDATE))
 201                 acked_bytes = inet_csk(sk)->icsk_ack.rcv_mss;
 202         if (acked_bytes) {
 203                 ca->acked_bytes_total += acked_bytes;
 204                 ca->prior_snd_una = tp->snd_una;
 205
 206                 if (flags & CA_ACK_ECE)
 207                         ca->acked_bytes_ecn += acked_bytes;
 208         }
 209
 210         /* Expired RTT */
 211         if (!before(tp->snd_una, ca->next_seq)) {
 212                 u64 bytes_ecn = ca->acked_bytes_ecn;
 213                 u32 alpha = ca->dctcp_alpha;
 214
 215                 /* alpha = (1 - g) * alpha + g * F */
 216
 217                 alpha -= min_not_zero(alpha, alpha >> dctcp_shift_g);
 218                 if (bytes_ecn) {
 219                         /* If dctcp_shift_g == 1, a 32bit value would overflow
 220                          * after 8 Mbytes.
 221                          */
 222                         bytes_ecn <<= (10 - dctcp_shift_g);
 223                         do_div(bytes_ecn, max(1U, ca->acked_bytes_total));
 224
 225                         alpha = min(alpha + (u32)bytes_ecn, DCTCP_MAX_ALPHA);
 226                 }
 227                 /* dctcp_alpha can be read from dctcp_get_info() without
 228                  * synchro, so we ask compiler to not use dctcp_alpha
 229                  * as a temporary variable in prior operations.
 230                  */
 231                 WRITE_ONCE(ca->dctcp_alpha, alpha);
 232                 dctcp_reset(tp, ca);
 233         }
 234 }
 235
 236 static void dctcp_state(struct sock *sk, u8 new_state)
 237 {
 238         if (dctcp_clamp_alpha_on_loss && new_state == TCP_CA_Loss) {
 239                 struct dctcp *ca = inet_csk_ca(sk);
 240
 241                 /* If this extension is enabled, we clamp dctcp_alpha to
 242                  * max on packet loss; the motivation is that dctcp_alpha
 243                  * is an indicator to the extend of congestion and packet
 244                  * loss is an indicator of extreme congestion; setting
 245                  * this in practice turned out to be beneficial, and
 246                  * effectively assumes total congestion which reduces the
 247                  * window by half.
 248                  */
 249                 ca->dctcp_alpha = DCTCP_MAX_ALPHA;
 250         }
 251 }
 252
 253 static void dctcp_update_ack_reserved(struct sock *sk, enum tcp_ca_event ev)
 254 {
 255         struct dctcp *ca = inet_csk_ca(sk);
 256
 257         switch (ev) {
 258         case CA_EVENT_DELAYED_ACK:
 259                 if (!ca->delayed_ack_reserved)
 260                         ca->delayed_ack_reserved = 1;
 261                 break;
 262         case CA_EVENT_NON_DELAYED_ACK:
 263                 if (ca->delayed_ack_reserved)
 264                         ca->delayed_ack_reserved = 0;
 265                 break;
 266         default:
 267                 /* Don't care for the rest. */
 268                 break;
 269         }
 270 }
 271
 272 static void dctcp_cwnd_event(struct sock *sk, enum tcp_ca_event ev)
 273 {
 274         switch (ev) {
 275         case CA_EVENT_ECN_IS_CE:
 276                 dctcp_ce_state_0_to_1(sk);
 277                 break;
 278         case CA_EVENT_ECN_NO_CE:
 279                 dctcp_ce_state_1_to_0(sk);
 280                 break;
 281         case CA_EVENT_DELAYED_ACK:
 282         case CA_EVENT_NON_DELAYED_ACK:
 283                 dctcp_update_ack_reserved(sk, ev);
 284                 break;
 285         default:
 286                 /* Don't care for the rest. */
 287                 break;
 288         }
 289 }
 290
 291 static size_t dctcp_get_info(struct sock *sk, u32 ext, int *attr,
 292                              union tcp_cc_info *info)
 293 {
 294         const struct dctcp *ca = inet_csk_ca(sk);
 295
 296         /* Fill it also in case of VEGASINFO due to req struct limits.
 297          * We can still correctly retrieve it later.
 298          */
 299         if (ext & (1 << (INET_DIAG_DCTCPINFO - 1)) ||
 300             ext & (1 << (INET_DIAG_VEGASINFO - 1))) {
 301                 memset(&info->dctcp, 0, sizeof(info->dctcp));
 302                 if (inet_csk(sk)->icsk_ca_ops != &dctcp_reno) {
 303                         info->dctcp.dctcp_enabled = 1;
 304                         info->dctcp.dctcp_ce_state = (u16) ca->ce_state;
 305                         info->dctcp.dctcp_alpha = ca->dctcp_alpha;
 306                         info->dctcp.dctcp_ab_ecn = ca->acked_bytes_ecn;
 307                         info->dctcp.dctcp_ab_tot = ca->acked_bytes_total;
 308                 }
 309
 310                 *attr = INET_DIAG_DCTCPINFO;
 311                 return sizeof(info->dctcp);
 312         }
 313         return 0;
 314 }
 315
 316 static u32 dctcp_cwnd_undo(struct sock *sk)
 317 {
 318         const struct dctcp *ca = inet_csk_ca(sk);
 319
 320         return max(tcp_sk(sk)->snd_cwnd, ca->loss_cwnd);
 321 }
 322
 323 static struct tcp_congestion_ops dctcp __read_mostly = {
 324         .init           = dctcp_init,
 325         .in_ack_event   = dctcp_update_alpha,
 326         .cwnd_event     = dctcp_cwnd_event,
 327         .ssthresh       = dctcp_ssthresh,
 328         .cong_avoid     = tcp_reno_cong_avoid,
 329         .undo_cwnd      = dctcp_cwnd_undo,
 330         .set_state      = dctcp_state,
 331         .get_info       = dctcp_get_info,
 332         .flags          = TCP_CONG_NEEDS_ECN,
 333         .owner          = THIS_MODULE,
 334         .name           = "dctcp",
 335 };
 336
 337 static struct tcp_congestion_ops dctcp_reno __read_mostly = {
 338         .ssthresh       = tcp_reno_ssthresh,
 339         .cong_avoid     = tcp_reno_cong_avoid,
 340         .undo_cwnd      = tcp_reno_undo_cwnd,
 341         .get_info       = dctcp_get_info,
 342         .owner          = THIS_MODULE,
 343         .name           = "dctcp-reno",
 344 };
 345
 346 static int __init dctcp_register(void)
 347 {
 348         BUILD_BUG_ON(sizeof(struct dctcp) > ICSK_CA_PRIV_SIZE);
 349         return tcp_register_congestion_control(&dctcp);
 350 }
 351
 352 static void __exit dctcp_unregister(void)
 353 {
 354         tcp_unregister_congestion_control(&dctcp);
 355 }
 356
 357 module_init(dctcp_register);
 358 module_exit(dctcp_unregister);
 359
 360 MODULE_AUTHOR("Daniel Borkmann <dborkman@redhat.com>");
 361 MODULE_AUTHOR("Florian Westphal <fw@strlen.de>");
 362 MODULE_AUTHOR("Glenn Judd <glenn.judd@morganstanley.com>");
 363
 364 MODULE_LICENSE("GPL v2");
 365 MODULE_DESCRIPTION("DataCenter TCP (DCTCP)");