net/ipv4/tcp_westwood.c

   1 /*
   2  * TCP Westwood+: end-to-end bandwidth estimation for TCP
   3  *
   4  *      Angelo Dell'Aera: author of the first version of TCP Westwood+ in Linux 2.4
   5  *
   6  * Support at http://c3lab.poliba.it/index.php/Westwood
   7  * Main references in literature:
   8  *
   9  * - Mascolo S, Casetti, M. Gerla et al.
  10  *   "TCP Westwood: bandwidth estimation for TCP" Proc. ACM Mobicom 2001
  11  *
  12  * - A. Grieco, s. Mascolo
  13  *   "Performance evaluation of New Reno, Vegas, Westwood+ TCP" ACM Computer
  14  *     Comm. Review, 2004
  15  *
  16  * - A. Dell'Aera, L. Grieco, S. Mascolo.
  17  *   "Linux 2.4 Implementation of Westwood+ TCP with Rate-Halving :
  18  *    A Performance Evaluation Over the Internet" (ICC 2004), Paris, June 2004
  19  *
  20  * Westwood+ employs end-to-end bandwidth measurement to set cwnd and
  21  * ssthresh after packet loss. The probing phase is as the original Reno.
  22  */
  23
  24 #include <linux/config.h>
  25 #include <linux/mm.h>
  26 #include <linux/module.h>
  27 #include <linux/skbuff.h>
  28 #include <linux/inet_diag.h>
  29 #include <net/tcp.h>
  30
  31 /* TCP Westwood structure */
  32 struct westwood {
  33         u32    bw_ns_est;        /* first bandwidth estimation..not too smoothed 8) */
  34         u32    bw_est;           /* bandwidth estimate */
  35         u32    rtt_win_sx;       /* here starts a new evaluation... */
  36         u32    bk;
  37         u32    snd_una;          /* used for evaluating the number of acked bytes */
  38         u32    cumul_ack;
  39         u32    accounted;
  40         u32    rtt;
  41         u32    rtt_min;          /* minimum observed RTT */
  42         u8     first_ack;        /* flag which infers that this is the first ack */
  43 };
  44
  45
  46 /* TCP Westwood functions and constants */
  47 #define TCP_WESTWOOD_RTT_MIN   (HZ/20)  /* 50ms */
  48 #define TCP_WESTWOOD_INIT_RTT  (20*HZ)  /* maybe too conservative?! */
  49
  50 /*
  51  * @tcp_westwood_create
  52  * This function initializes fields used in TCP Westwood+,
  53  * it is called after the initial SYN, so the sequence numbers
  54  * are correct but new passive connections we have no
  55  * information about RTTmin at this time so we simply set it to
  56  * TCP_WESTWOOD_INIT_RTT. This value was chosen to be too conservative
  57  * since in this way we're sure it will be updated in a consistent
  58  * way as soon as possible. It will reasonably happen within the first
  59  * RTT period of the connection lifetime.
  60  */
  61 static void tcp_westwood_init(struct sock *sk)
  62 {
  63         struct westwood *w = inet_csk_ca(sk);
  64
  65         w->bk = 0;
  66         w->bw_ns_est = 0;
  67         w->bw_est = 0;
  68         w->accounted = 0;
  69         w->cumul_ack = 0;
  70         w->rtt_min = w->rtt = TCP_WESTWOOD_INIT_RTT;
  71         w->rtt_win_sx = tcp_time_stamp;
  72         w->snd_una = tcp_sk(sk)->snd_una;
  73         w->first_ack = 1;
  74 }
  75
  76 /*
  77  * @westwood_do_filter
  78  * Low-pass filter. Implemented using constant coefficients.
  79  */
  80 static inline u32 westwood_do_filter(u32 a, u32 b)
  81 {
  82         return (((7 * a) + b) >> 3);
  83 }
  84
  85 static void westwood_filter(struct westwood *w, u32 delta)
  86 {
  87         /* If the filter is empty fill it with the first sample of bandwidth  */
  88         if (w->bw_ns_est == 0 && w->bw_est == 0) {
  89                 w->bw_ns_est = w->bk / delta;
  90                 w->bw_est = w->bw_ns_est;
  91         } else {
  92                 w->bw_ns_est = westwood_do_filter(w->bw_ns_est, w->bk / delta);
  93                 w->bw_est = westwood_do_filter(w->bw_est, w->bw_ns_est);
  94         }
  95 }
  96
  97 /*
  98  * @westwood_pkts_acked
  99  * Called after processing group of packets.
 100  * but all westwood needs is the last sample of srtt.
 101  */
 102 static void tcp_westwood_pkts_acked(struct sock *sk, u32 cnt)
 103 {
 104         struct westwood *w = inet_csk_ca(sk);
 105         if (cnt > 0)
 106                 w->rtt = tcp_sk(sk)->srtt >> 3;
 107 }
 108
 109 /*
 110  * @westwood_update_window
 111  * It updates RTT evaluation window if it is the right moment to do
 112  * it. If so it calls filter for evaluating bandwidth.
 113  */
 114 static void westwood_update_window(struct sock *sk)
 115 {
 116         struct westwood *w = inet_csk_ca(sk);
 117         s32 delta = tcp_time_stamp - w->rtt_win_sx;
 118
 119         /* Initialize w->snd_una with the first acked sequence number in order
 120          * to fix mismatch between tp->snd_una and w->snd_una for the first
 121          * bandwidth sample
 122          */
 123         if (w->first_ack) {
 124                 w->snd_una = tcp_sk(sk)->snd_una;
 125                 w->first_ack = 0;
 126         }
 127
 128         /*
 129          * See if a RTT-window has passed.
 130          * Be careful since if RTT is less than
 131          * 50ms we don't filter but we continue 'building the sample'.
 132          * This minimum limit was chosen since an estimation on small
 133          * time intervals is better to avoid...
 134          * Obviously on a LAN we reasonably will always have
 135          * right_bound = left_bound + WESTWOOD_RTT_MIN
 136          */
 137         if (w->rtt && delta > max_t(u32, w->rtt, TCP_WESTWOOD_RTT_MIN)) {
 138                 westwood_filter(w, delta);
 139
 140                 w->bk = 0;
 141                 w->rtt_win_sx = tcp_time_stamp;
 142         }
 143 }
 144
 145 /*
 146  * @westwood_fast_bw
 147  * It is called when we are in fast path. In particular it is called when
 148  * header prediction is successful. In such case in fact update is
 149  * straight forward and doesn't need any particular care.
 150  */
 151 static inline void westwood_fast_bw(struct sock *sk)
 152 {
 153         const struct tcp_sock *tp = tcp_sk(sk);
 154         struct westwood *w = inet_csk_ca(sk);
 155
 156         westwood_update_window(sk);
 157
 158         w->bk += tp->snd_una - w->snd_una;
 159         w->snd_una = tp->snd_una;
 160         w->rtt_min = min(w->rtt, w->rtt_min);
 161 }
 162
 163 /*
 164  * @westwood_acked_count
 165  * This function evaluates cumul_ack for evaluating bk in case of
 166  * delayed or partial acks.
 167  */
 168 static inline u32 westwood_acked_count(struct sock *sk)
 169 {
 170         const struct tcp_sock *tp = tcp_sk(sk);
 171         struct westwood *w = inet_csk_ca(sk);
 172
 173         w->cumul_ack = tp->snd_una - w->snd_una;
 174
 175         /* If cumul_ack is 0 this is a dupack since it's not moving
 176          * tp->snd_una.
 177          */
 178         if (!w->cumul_ack) {
 179                 w->accounted += tp->mss_cache;
 180                 w->cumul_ack = tp->mss_cache;
 181         }
 182
 183         if (w->cumul_ack > tp->mss_cache) {
 184                 /* Partial or delayed ack */
 185                 if (w->accounted >= w->cumul_ack) {
 186                         w->accounted -= w->cumul_ack;
 187                         w->cumul_ack = tp->mss_cache;
 188                 } else {
 189                         w->cumul_ack -= w->accounted;
 190                         w->accounted = 0;
 191                 }
 192         }
 193
 194         w->snd_una = tp->snd_una;
 195
 196         return w->cumul_ack;
 197 }
 198
 199
 200 /*
 201  * TCP Westwood
 202  * Here limit is evaluated as Bw estimation*RTTmin (for obtaining it
 203  * in packets we use mss_cache). Rttmin is guaranteed to be >= 2
 204  * so avoids ever returning 0.
 205  */
 206 static u32 tcp_westwood_bw_rttmin(const struct sock *sk)
 207 {
 208         const struct tcp_sock *tp = tcp_sk(sk);
 209         const struct westwood *w = inet_csk_ca(sk);
 210         return max_t(u32, (w->bw_est * w->rtt_min) / tp->mss_cache, 2);
 211 }
 212
 213 static void tcp_westwood_event(struct sock *sk, enum tcp_ca_event event)
 214 {
 215         struct tcp_sock *tp = tcp_sk(sk);
 216         struct westwood *w = inet_csk_ca(sk);
 217
 218         switch(event) {
 219         case CA_EVENT_FAST_ACK:
 220                 westwood_fast_bw(sk);
 221                 break;
 222
 223         case CA_EVENT_COMPLETE_CWR:
 224                 tp->snd_cwnd = tp->snd_ssthresh = tcp_westwood_bw_rttmin(sk);
 225                 break;
 226
 227         case CA_EVENT_FRTO:
 228                 tp->snd_ssthresh = tcp_westwood_bw_rttmin(sk);
 229                 break;
 230
 231         case CA_EVENT_SLOW_ACK:
 232                 westwood_update_window(sk);
 233                 w->bk += westwood_acked_count(sk);
 234                 w->rtt_min = min(w->rtt, w->rtt_min);
 235                 break;
 236
 237         default:
 238                 /* don't care */
 239                 break;
 240         }
 241 }
 242
 243
 244 /* Extract info for Tcp socket info provided via netlink. */
 245 static void tcp_westwood_info(struct sock *sk, u32 ext,
 246                               struct sk_buff *skb)
 247 {
 248         const struct westwood *ca = inet_csk_ca(sk);
 249         if (ext & (1 << (INET_DIAG_VEGASINFO - 1))) {
 250                 struct rtattr *rta;
 251                 struct tcpvegas_info *info;
 252
 253                 rta = __RTA_PUT(skb, INET_DIAG_VEGASINFO, sizeof(*info));
 254                 info = RTA_DATA(rta);
 255                 info->tcpv_enabled = 1;
 256                 info->tcpv_rttcnt = 0;
 257                 info->tcpv_rtt = jiffies_to_usecs(ca->rtt);
 258                 info->tcpv_minrtt = jiffies_to_usecs(ca->rtt_min);
 259         rtattr_failure: ;
 260         }
 261 }
 262
 263
 264 static struct tcp_congestion_ops tcp_westwood = {
 265         .init           = tcp_westwood_init,
 266         .ssthresh       = tcp_reno_ssthresh,
 267         .cong_avoid     = tcp_reno_cong_avoid,
 268         .min_cwnd       = tcp_westwood_bw_rttmin,
 269         .cwnd_event     = tcp_westwood_event,
 270         .get_info       = tcp_westwood_info,
 271         .pkts_acked     = tcp_westwood_pkts_acked,
 272
 273         .owner          = THIS_MODULE,
 274         .name           = "westwood"
 275 };
 276
 277 static int __init tcp_westwood_register(void)
 278 {
 279         BUG_ON(sizeof(struct westwood) > ICSK_CA_PRIV_SIZE);
 280         return tcp_register_congestion_control(&tcp_westwood);
 281 }
 282
 283 static void __exit tcp_westwood_unregister(void)
 284 {
 285         tcp_unregister_congestion_control(&tcp_westwood);
 286 }
 287
 288 module_init(tcp_westwood_register);
 289 module_exit(tcp_westwood_unregister);
 290
 291 MODULE_AUTHOR("Stephen Hemminger, Angelo Dell'Aera");
 292 MODULE_LICENSE("GPL");
 293 MODULE_DESCRIPTION("TCP Westwood+");