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