share/man/man4/cc_vegas.4

   1 .\"
   2 .\" Copyright (c) 2010-2011 The FreeBSD Foundation
   3 .\" All rights reserved.
   4 .\"
   5 .\" This documentation was written at the Centre for Advanced Internet
   6 .\" Architectures, Swinburne University of Technology, Melbourne, Australia by
   7 .\" David Hayes under sponsorship from the FreeBSD Foundation.
   8 .\"
   9 .\" Redistribution and use in source and binary forms, with or without
  10 .\" modification, are permitted provided that the following conditions
  11 .\" are met:
  12 .\" 1. Redistributions of source code must retain the above copyright
  13 .\"    notice, this list of conditions and the following disclaimer.
  14 .\" 2. Redistributions in binary form must reproduce the above copyright
  15 .\"    notice, this list of conditions and the following disclaimer in the
  16 .\"    documentation and/or other materials provided with the distribution.
  17 .\"
  18 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  19 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  20 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  21 .\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE FOR
  22 .\" ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  23 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  24 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  25 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  26 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  27 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  28 .\" SUCH DAMAGE.
  29 .\"
  30 .\" $FreeBSD$
  31 .\"
  32 .Dd May 13, 2021
  33 .Dt CC_VEGAS 4
  34 .Os
  35 .Sh NAME
  36 .Nm cc_vegas
  37 .Nd Vegas Congestion Control Algorithm
  38 .Sh DESCRIPTION
  39 The Vegas congestion control algorithm uses what the authors term the actual and
  40 expected transmission rates to determine whether there is congestion along the
  41 network path i.e.
  42 .Bl -item -offset indent
  43 .It
  44 actual rate = (total data sent in a RTT) / RTT
  45 .It
  46 expected rate = cwnd / RTTmin
  47 .It
  48 diff = expected - actual
  49 .El
  50 .Pp
  51 where RTT is the measured instantaneous round trip time and RTTmin is the
  52 smallest round trip time observed during the connection.
  53 .Pp
  54 The algorithm aims to keep diff between two parameters alpha and beta, such
  55 that:
  56 .Bl -item -offset indent
  57 .It
  58 alpha < diff < beta
  59 .El
  60 .Pp
  61 If diff > beta, congestion is inferred and cwnd is decremented by one packet (or
  62 the maximum TCP segment size).
  63 If diff < alpha, then cwnd is incremented by one packet.
  64 Alpha and beta govern the amount of buffering along the path.
  65 .Pp
  66 The implementation was done in a clean-room fashion, and is based on the
  67 paper referenced in the
  68 .Sx SEE ALSO
  69 section below.
  70 .Sh IMPLEMENTATION NOTES
  71 The time from the transmission of a marked packet until the receipt of an
  72 acknowledgement for that packet is measured once per RTT.
  73 This implementation does not implement Brakmo's and Peterson's original
  74 duplicate ACK policy since clock ticks in today's machines are not as coarse as
  75 they were (i.e. 500ms) when Vegas was originally designed.
  76 Note that modern TCP recovery processes such as fast retransmit and SACK are
  77 enabled by default in the TCP stack.
  78 .Sh MIB Variables
  79 The algorithm exposes the following tunable variables in the
  80 .Va net.inet.tcp.cc.vegas
  81 branch of the
  82 .Xr sysctl 3
  83 MIB:
  84 .Bl -tag -width ".Va alpha"
  85 .It Va alpha
  86 Query or set the Vegas alpha parameter as a number of buffers on the path.
  87 When setting alpha, the value must satisfy: 0 < alpha < beta.
  88 Default is 1.
  89 .It Va beta
  90 Query or set the Vegas beta parameter as a number of buffers on the path.
  91 When setting beta, the value must satisfy: 0 < alpha < beta.
  92 Default is 3.
  93 .El
  94 .Sh SEE ALSO
  95 .Xr cc_cdg 4 ,
  96 .Xr cc_chd 4 ,
  97 .Xr cc_cubic 4 ,
  98 .Xr cc_dctcp 4 ,
  99 .Xr cc_hd 4 ,
 100 .Xr cc_htcp 4 ,
 101 .Xr cc_newreno 4 ,
 102 .Xr h_ertt 4 ,
 103 .Xr mod_cc 4 ,
 104 .Xr tcp 4 ,
 105 .Xr khelp 9 ,
 106 .Xr mod_cc 9
 107 .Rs
 108 .%A "L. S. Brakmo"
 109 .%A "L. L. Peterson"
 110 .%T "TCP Vegas: end to end congestion avoidance on a global internet"
 111 .%J "IEEE J. Sel. Areas Commun."
 112 .%D "October 1995"
 113 .%V "13"
 114 .%N "8"
 115 .%P "1465-1480"
 116 .Re
 117 .Sh ACKNOWLEDGEMENTS
 118 Development and testing of this software were made possible in part by grants
 119 from the FreeBSD Foundation and Cisco University Research Program Fund at
 120 Community Foundation Silicon Valley.
 121 .Sh HISTORY
 122 The
 123 .Nm
 124 congestion control module first appeared in
 125 .Fx 9.0 .
 126 .Pp
 127 The module was first released in 2010 by David Hayes whilst working on the
 128 NewTCP research project at Swinburne University of Technology's Centre for
 129 Advanced Internet Architectures, Melbourne, Australia.
 130 More details are available at:
 131 .Pp
 132 http://caia.swin.edu.au/urp/newtcp/
 133 .Sh AUTHORS
 134 .An -nosplit
 135 The
 136 .Nm
 137 congestion control module and this manual page were written by
 138 .An David Hayes Aq Mt david.hayes@ieee.org .