share/man/man4/cc_newreno.4

   1 .\"
   2 .\" Copyright (c) 2009 Lawrence Stewart <lstewart@FreeBSD.org>
   3 .\" Copyright (c) 2011 The FreeBSD Foundation
   4 .\" All rights reserved.
   5 .\"
   6 .\" Portions of this documentation were written at the Centre for Advanced
   7 .\" Internet Architectures, Swinburne University of Technology, Melbourne,
   8 .\" Australia by Lawrence Stewart under sponsorship from the FreeBSD Foundation.
   9 .\"
  10 .\" Redistribution and use in source and binary forms, with or without
  11 .\" modification, are permitted provided that the following conditions
  12 .\" are met:
  13 .\" 1. Redistributions of source code must retain the above copyright
  14 .\"    notice, this list of conditions and the following disclaimer.
  15 .\" 2. Redistributions in binary form must reproduce the above copyright
  16 .\"    notice, this list of conditions and the following disclaimer in the
  17 .\"    documentation and/or other materials provided with the distribution.
  18 .\"
  19 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  20 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  21 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  22 .\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE FOR
  23 .\" ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  24 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  25 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  26 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  27 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  28 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  29 .\" SUCH DAMAGE.
  30 .\"
  31 .\" $FreeBSD$
  32 .\"
  33 .Dd August 6, 2019
  34 .Dt CC_NEWRENO 4
  35 .Os
  36 .Sh NAME
  37 .Nm cc_newreno
  38 .Nd NewReno Congestion Control Algorithm
  39 .Sh SYNOPSIS
  40 .In netinet/cc/cc_newreno.h
  41 .Sh DESCRIPTION
  42 The NewReno congestion control algorithm is the default for TCP.
  43 Details about the algorithm can be found in RFC5681.
  44 .Sh Socket Options
  45 The
  46 .Nm
  47 module supports a number of socket options under TCP_CCALGOOPT (refer to
  48 .Xr tcp 4
  49 and
  50 .Xr moc_cc 9 for details)
  51 which can
  52 be set with
  53 .Xr setsockopt 2
  54 and tested with
  55 .Xr getsockopt 2 .
  56 The
  57 .Nm
  58 socket options use this structure defined in
  59 <sys/netinet/cc/cc_newreno.h>:
  60 .Bd -literal
  61 struct cc_newreno_opts {
  62         int name;
  63         uint32_t val;
  64 }
  65 .Ed
  66 .Bl -tag -width ".Va CC_NEWRENO_BETA_ECN"
  67 .It Va CC_NEWRENO_BETA
  68 Multiplicative window decrease factor, specified as a percentage, applied to
  69 the congestion window in response to a congestion signal per: cwnd = (cwnd *
  70 CC_NEWRENO_BETA) / 100.
  71 Default is 50.
  72 .It Va CC_NEWRENO_BETA_ECN
  73 Multiplicative window decrease factor, specified as a percentage, applied to
  74 the congestion window in response to an ECN congestion signal when
  75 .Va net.inet.tcp.cc.abe=1
  76 per: cwnd = (cwnd * CC_NEWRENO_BETA_ECN) / 100.
  77 Default is 80.
  78 .El
  79 .Sh MIB Variables
  80 The algorithm exposes these variables in the
  81 .Va net.inet.tcp.cc.newreno
  82 branch of the
  83 .Xr sysctl 3
  84 MIB:
  85 .Bl -tag -width ".Va beta_ecn"
  86 .It Va beta
  87 Multiplicative window decrease factor, specified as a percentage, applied to
  88 the congestion window in response to a congestion signal per: cwnd = (cwnd *
  89 beta) / 100.
  90 Default is 50.
  91 .It Va beta_ecn
  92 Multiplicative window decrease factor, specified as a percentage, applied to
  93 the congestion window in response to an ECN congestion signal when
  94 .Va net.inet.tcp.cc.abe=1
  95 per: cwnd = (cwnd * beta_ecn) / 100.
  96 Default is 80.
  97 .El
  98 .Sh SEE ALSO
  99 .Xr cc_chd 4 ,
 100 .Xr cc_cubic 4 ,
 101 .Xr cc_hd 4 ,
 102 .Xr cc_htcp 4 ,
 103 .Xr cc_vegas 4 ,
 104 .Xr mod_cc 4 ,
 105 .Xr tcp 4 ,
 106 .Xr mod_cc 9
 107 .Rs
 108 .%A "Mark Allman"
 109 .%A "Vern Paxson"
 110 .%A "Ethan Blanton"
 111 .%T "TCP Congestion Control"
 112 .%O "RFC 5681"
 113 .Re
 114 .Rs
 115 .%A "Naeem Khademi"
 116 .%A "Michael Welzl"
 117 .%A "Grenville Armitage"
 118 .%A "Gorry Fairhurst"
 119 .%T "TCP Alternative Backoff with ECN (ABE)"
 120 .%O "RFC 8511"
 121 .Re
 122 .Sh ACKNOWLEDGEMENTS
 123 Development and testing of this software were made possible in part by grants
 124 from the FreeBSD Foundation and Cisco University Research Program Fund at
 125 Community Foundation Silicon Valley.
 126 .Sh HISTORY
 127 The
 128 .Nm
 129 congestion control algorithm first appeared in its modular form in
 130 .Fx 9.0 .
 131 .Pp
 132 The module was first released in 2007 by James Healy and Lawrence Stewart whilst
 133 working on the NewTCP research project at Swinburne University of Technology's
 134 Centre for Advanced Internet Architectures, Melbourne, Australia, which was made
 135 possible in part by a grant from the Cisco University Research Program Fund at
 136 Community Foundation Silicon Valley.
 137 More details are available at:
 138 .Pp
 139 http://caia.swin.edu.au/urp/newtcp/
 140 .Sh AUTHORS
 141 .An -nosplit
 142 The
 143 .Nm
 144 congestion control module was written by
 145 .An James Healy Aq Mt jimmy@deefa.com ,
 146 .An Lawrence Stewart Aq Mt lstewart@FreeBSD.org
 147 and
 148 .An David Hayes Aq Mt david.hayes@ieee.org .
 149 .Pp
 150 Support for TCP ABE was added by
 151 .An Tom Jones Aq Mt tj@enoti.me .
 152 .Pp
 153 This manual page was written by
 154 .An Lawrence Stewart Aq Mt lstewart@FreeBSD.org .