1 /*- 2 * SPDX-License-Identifier: BSD-2-Clause-FreeBSD 3 * 4 * Copyright (c) 2009-2010 5 * Swinburne University of Technology, Melbourne, Australia 6 * Copyright (c) 2010 Lawrence Stewart <lstewart@freebsd.org> 7 * Copyright (c) 2010-2011 The FreeBSD Foundation 8 * All rights reserved. 9 * 10 * This software was developed at the Centre for Advanced Internet 11 * Architectures, Swinburne University of Technology, by David Hayes and 12 * Lawrence Stewart, made possible in part by a grant from the Cisco University 13 * Research Program Fund at Community Foundation Silicon Valley. 14 * 15 * Portions of this software were developed at the Centre for Advanced Internet 16 * Architectures, Swinburne University of Technology, Melbourne, Australia by 17 * David Hayes under sponsorship from the FreeBSD Foundation. 18 * 19 * Redistribution and use in source and binary forms, with or without 20 * modification, are permitted provided that the following conditions 21 * are met: 22 * 1. Redistributions of source code must retain the above copyright 23 * notice, this list of conditions and the following disclaimer. 24 * 2. Redistributions in binary form must reproduce the above copyright 25 * notice, this list of conditions and the following disclaimer in the 26 * documentation and/or other materials provided with the distribution. 27 * 28 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND 29 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 30 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 31 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE 32 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 33 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 34 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 35 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 36 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 37 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 38 * SUCH DAMAGE. 39 */ 40 41 /* 42 * An implementation of the Vegas congestion control algorithm for FreeBSD, 43 * based on L. S. Brakmo and L. L. Peterson, "TCP Vegas: end to end congestion 44 * avoidance on a global internet", IEEE J. Sel. Areas Commun., vol. 13, no. 8, 45 * pp. 1465-1480, Oct. 1995. The original Vegas duplicate ack policy has not 46 * been implemented, since clock ticks are not as coarse as they were (i.e. 47 * 500ms) when Vegas was designed. Also, packets are timed once per RTT as in 48 * the original paper. 49 * 50 * Originally released as part of the NewTCP research project at Swinburne 51 * University of Technology's Centre for Advanced Internet Architectures, 52 * Melbourne, Australia, which was made possible in part by a grant from the 53 * Cisco University Research Program Fund at Community Foundation Silicon 54 * Valley. More details are available at: 55 * http://caia.swin.edu.au/urp/newtcp/ 56 */ 57 58 #include <sys/cdefs.h> 59 __FBSDID("$FreeBSD$"); 60 61 #include <sys/param.h> 62 #include <sys/kernel.h> 63 #include <sys/khelp.h> 64 #include <sys/malloc.h> 65 #include <sys/module.h> 66 #include <sys/queue.h> 67 #include <sys/socket.h> 68 #include <sys/socketvar.h> 69 #include <sys/sysctl.h> 70 #include <sys/systm.h> 71 72 #include <net/vnet.h> 73 74 #include <netinet/tcp.h> 75 #include <netinet/tcp_timer.h> 76 #include <netinet/tcp_var.h> 77 #include <netinet/cc/cc.h> 78 #include <netinet/cc/cc_module.h> 79 80 #include <netinet/khelp/h_ertt.h> 81 82 #define CAST_PTR_INT(X) (*((int*)(X))) 83 84 /* 85 * Private signal type for rate based congestion signal. 86 * See <netinet/cc.h> for appropriate bit-range to use for private signals. 87 */ 88 #define CC_VEGAS_RATE 0x01000000 89 90 static void vegas_ack_received(struct cc_var *ccv, uint16_t ack_type); 91 static void vegas_cb_destroy(struct cc_var *ccv); 92 static int vegas_cb_init(struct cc_var *ccv); 93 static void vegas_cong_signal(struct cc_var *ccv, uint32_t signal_type); 94 static void vegas_conn_init(struct cc_var *ccv); 95 static int vegas_mod_init(void); 96 97 struct vegas { 98 int slow_start_toggle; 99 }; 100 101 static int32_t ertt_id; 102 103 VNET_DEFINE_STATIC(uint32_t, vegas_alpha) = 1; 104 VNET_DEFINE_STATIC(uint32_t, vegas_beta) = 3; 105 #define V_vegas_alpha VNET(vegas_alpha) 106 #define V_vegas_beta VNET(vegas_beta) 107 108 static MALLOC_DEFINE(M_VEGAS, "vegas data", 109 "Per connection data required for the Vegas congestion control algorithm"); 110 111 struct cc_algo vegas_cc_algo = { 112 .name = "vegas", 113 .ack_received = vegas_ack_received, 114 .cb_destroy = vegas_cb_destroy, 115 .cb_init = vegas_cb_init, 116 .cong_signal = vegas_cong_signal, 117 .conn_init = vegas_conn_init, 118 .mod_init = vegas_mod_init 119 }; 120 121 /* 122 * The vegas window adjustment is done once every RTT, as indicated by the 123 * ERTT_NEW_MEASUREMENT flag. This flag is reset once the new measurment data 124 * has been used. 125 */ 126 static void 127 vegas_ack_received(struct cc_var *ccv, uint16_t ack_type) 128 { 129 struct ertt *e_t; 130 struct vegas *vegas_data; 131 long actual_tx_rate, expected_tx_rate, ndiff; 132 133 e_t = khelp_get_osd(CCV(ccv, osd), ertt_id); 134 vegas_data = ccv->cc_data; 135 136 if (e_t->flags & ERTT_NEW_MEASUREMENT) { /* Once per RTT. */ 137 if (e_t->minrtt && e_t->markedpkt_rtt) { 138 expected_tx_rate = e_t->marked_snd_cwnd / e_t->minrtt; 139 actual_tx_rate = e_t->bytes_tx_in_marked_rtt / 140 e_t->markedpkt_rtt; 141 ndiff = (expected_tx_rate - actual_tx_rate) * 142 e_t->minrtt / CCV(ccv, t_maxseg); 143 144 if (ndiff < V_vegas_alpha) { 145 if (CCV(ccv, snd_cwnd) <= 146 CCV(ccv, snd_ssthresh)) { 147 vegas_data->slow_start_toggle = 148 vegas_data->slow_start_toggle ? 149 0 : 1; 150 } else { 151 vegas_data->slow_start_toggle = 0; 152 CCV(ccv, snd_cwnd) = 153 min(CCV(ccv, snd_cwnd) + 154 CCV(ccv, t_maxseg), 155 TCP_MAXWIN << CCV(ccv, snd_scale)); 156 } 157 } else if (ndiff > V_vegas_beta) { 158 /* Rate-based congestion. */ 159 vegas_cong_signal(ccv, CC_VEGAS_RATE); 160 vegas_data->slow_start_toggle = 0; 161 } 162 } 163 e_t->flags &= ~ERTT_NEW_MEASUREMENT; 164 } 165 166 if (vegas_data->slow_start_toggle) 167 newreno_cc_algo.ack_received(ccv, ack_type); 168 } 169 170 static void 171 vegas_cb_destroy(struct cc_var *ccv) 172 { 173 free(ccv->cc_data, M_VEGAS); 174 } 175 176 static int 177 vegas_cb_init(struct cc_var *ccv) 178 { 179 struct vegas *vegas_data; 180 181 vegas_data = malloc(sizeof(struct vegas), M_VEGAS, M_NOWAIT); 182 183 if (vegas_data == NULL) 184 return (ENOMEM); 185 186 vegas_data->slow_start_toggle = 1; 187 ccv->cc_data = vegas_data; 188 189 return (0); 190 } 191 192 /* 193 * If congestion has been triggered triggered by the Vegas measured rates, it is 194 * handled here, otherwise it falls back to newreno's congestion handling. 195 */ 196 static void 197 vegas_cong_signal(struct cc_var *ccv, uint32_t signal_type) 198 { 199 struct vegas *vegas_data; 200 int presignalrecov; 201 202 vegas_data = ccv->cc_data; 203 204 if (IN_RECOVERY(CCV(ccv, t_flags))) 205 presignalrecov = 1; 206 else 207 presignalrecov = 0; 208 209 switch(signal_type) { 210 case CC_VEGAS_RATE: 211 if (!IN_RECOVERY(CCV(ccv, t_flags))) { 212 CCV(ccv, snd_cwnd) = max(2 * CCV(ccv, t_maxseg), 213 CCV(ccv, snd_cwnd) - CCV(ccv, t_maxseg)); 214 if (CCV(ccv, snd_cwnd) < CCV(ccv, snd_ssthresh)) 215 /* Exit slow start. */ 216 CCV(ccv, snd_ssthresh) = CCV(ccv, snd_cwnd); 217 } 218 break; 219 220 default: 221 newreno_cc_algo.cong_signal(ccv, signal_type); 222 } 223 224 if (IN_RECOVERY(CCV(ccv, t_flags)) && !presignalrecov) 225 vegas_data->slow_start_toggle = 226 (CCV(ccv, snd_cwnd) < CCV(ccv, snd_ssthresh)) ? 1 : 0; 227 } 228 229 static void 230 vegas_conn_init(struct cc_var *ccv) 231 { 232 struct vegas *vegas_data; 233 234 vegas_data = ccv->cc_data; 235 vegas_data->slow_start_toggle = 1; 236 } 237 238 static int 239 vegas_mod_init(void) 240 { 241 242 ertt_id = khelp_get_id("ertt"); 243 if (ertt_id <= 0) { 244 printf("%s: h_ertt module not found\n", __func__); 245 return (ENOENT); 246 } 247 248 vegas_cc_algo.after_idle = newreno_cc_algo.after_idle; 249 vegas_cc_algo.post_recovery = newreno_cc_algo.post_recovery; 250 251 return (0); 252 } 253 254 static int 255 vegas_alpha_handler(SYSCTL_HANDLER_ARGS) 256 { 257 int error; 258 uint32_t new; 259 260 new = V_vegas_alpha; 261 error = sysctl_handle_int(oidp, &new, 0, req); 262 if (error == 0 && req->newptr != NULL) { 263 if (CAST_PTR_INT(req->newptr) < 1 || 264 CAST_PTR_INT(req->newptr) > V_vegas_beta) 265 error = EINVAL; 266 else 267 V_vegas_alpha = new; 268 } 269 270 return (error); 271 } 272 273 static int 274 vegas_beta_handler(SYSCTL_HANDLER_ARGS) 275 { 276 int error; 277 uint32_t new; 278 279 new = V_vegas_beta; 280 error = sysctl_handle_int(oidp, &new, 0, req); 281 if (error == 0 && req->newptr != NULL) { 282 if (CAST_PTR_INT(req->newptr) < 1 || 283 CAST_PTR_INT(req->newptr) < V_vegas_alpha) 284 error = EINVAL; 285 else 286 V_vegas_beta = new; 287 } 288 289 return (error); 290 } 291 292 SYSCTL_DECL(_net_inet_tcp_cc_vegas); 293 SYSCTL_NODE(_net_inet_tcp_cc, OID_AUTO, vegas, CTLFLAG_RW, NULL, 294 "Vegas related settings"); 295 296 SYSCTL_PROC(_net_inet_tcp_cc_vegas, OID_AUTO, alpha, 297 CTLFLAG_VNET | CTLTYPE_UINT | CTLFLAG_RW, 298 &VNET_NAME(vegas_alpha), 1, &vegas_alpha_handler, "IU", 299 "vegas alpha, specified as number of \"buffers\" (0 < alpha < beta)"); 300 301 SYSCTL_PROC(_net_inet_tcp_cc_vegas, OID_AUTO, beta, 302 CTLFLAG_VNET | CTLTYPE_UINT | CTLFLAG_RW, 303 &VNET_NAME(vegas_beta), 3, &vegas_beta_handler, "IU", 304 "vegas beta, specified as number of \"buffers\" (0 < alpha < beta)"); 305 306 DECLARE_CC_MODULE(vegas, &vegas_cc_algo); 307 MODULE_DEPEND(vegas, ertt, 1, 1, 1); 308