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