share/man/man4/cc.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, Melbourne, Australia by David Hayes and
   7 .\" Lawrence Stewart 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 February 15, 2011
  33 .Dt cc 4
  34 .Os
  35 .Sh NAME
  36 .Nm cc
  37 .Nd Modular congestion control
  38 .Sh DESCRIPTION
  39 The modular congestion control framework allows the TCP implementation to
  40 dynamically change the congestion control algorithm used by new and existing
  41 connections.
  42 Algorithms are identified by a unique
  43 .Xr ascii 7
  44 name.
  45 Algorithm modules can be compiled into the kernel or loaded as kernel modules
  46 using the
  47 .Xr kld 4
  48 facility.
  49 .Pp
  50 The default algorithm is NewReno, and all connections use the default unless
  51 explicitly overridden using the TCP_CONGESTION socket option (see
  52 .Xr tcp 4
  53 for details).
  54 The default can be changed using a
  55 .Xr sysctl 3
  56 MIB variable detailed in the
  57 .Sx MIB Variables
  58 section below.
  59 .Sh MIB Variables
  60 The framework exposes the following variables in the
  61 .Va net.inet.tcp.cc
  62 branch of the
  63 .Xr sysctl 3
  64 MIB:
  65 .Bl -tag -width ".Va available"
  66 .It Va available
  67 Read-only list of currently available congestion control algorithms by name.
  68 .It Va algorithm
  69 Returns the current default congestion control algorithm when read, and changes
  70 the default when set.
  71 When attempting to change the default algorithm, this variable should be set to
  72 one of the names listed by the
  73 .Va net.inet.tcp.cc.available
  74 MIB variable.
  75 .El
  76 .Sh SEE ALSO
  77 .Xr cc_chd 4 ,
  78 .Xr cc_cubic 4 ,
  79 .Xr cc_hd 4 ,
  80 .Xr cc_htcp 4 ,
  81 .Xr cc_newreno 4 ,
  82 .Xr cc_vegas 4 ,
  83 .Xr tcp 4 ,
  84 .Xr cc 9
  85 .Sh ACKNOWLEDGEMENTS
  86 Development and testing of this software were made possible in part by grants
  87 from the FreeBSD Foundation and Cisco University Research Program Fund at
  88 Community Foundation Silicon Valley.
  89 .Sh HISTORY
  90 The
  91 .Nm
  92 modular congestion control framework first appeared in
  93 .Fx 9.0 .
  94 .Pp
  95 The framework was first released in 2007 by James Healy and Lawrence Stewart
  96 whilst working on the NewTCP research project at Swinburne University's Centre
  97 for Advanced Internet Architectures, Melbourne, Australia, which was made
  98 possible in part by a grant from the Cisco University Research Program Fund at
  99 Community Foundation Silicon Valley.
 100 More details are available at:
 101 .Pp
 102 http://caia.swin.edu.au/urp/newtcp/
 103 .Sh AUTHORS
 104 .An -nosplit
 105 The
 106 .Nm
 107 facility was written by
 108 .An Lawrence Stewart Aq lstewart@FreeBSD.org ,
 109 .An James Healy Aq jimmy@deefa.com
 110 and
 111 .An David Hayes Aq david.hayes@ieee.org .
 112 .Pp
 113 This manual page was written by
 114 .An David Hayes Aq david.hayes@ieee.org
 115 and
 116 .An Lawrence Stewart Aq lstewart@FreeBSD.org .