1.\" 2.\" Copyright (c) 2004 Max Laier <mlaier@FreeBSD.org> 3.\" All rights reserved. 4.\" 5.\" Redistribution and use in source and binary forms, with or without 6.\" modification, are permitted provided that the following conditions 7.\" are met: 8.\" 1. Redistributions of source code must retain the above copyright 9.\" notice, this list of conditions and the following disclaimer. 10.\" 2. Redistributions in binary form must reproduce the above copyright 11.\" notice, this list of conditions and the following disclaimer in the 12.\" documentation and/or other materials provided with the distribution. 13.\" 14.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND 15.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 16.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 17.\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE 18.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 19.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 20.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 21.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 22.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 23.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 24.\" SUCH DAMAGE. 25.\" 26.\" $FreeBSD$ 27.\" 28.Dd June 24, 2015 29.Dt ALTQ 4 30.Os 31.Sh NAME 32.Nm ALTQ 33.Nd "alternate queuing of network packets" 34.Sh SYNOPSIS 35.Cd options ALTQ 36.Pp 37.Cd options ALTQ_CBQ 38.Cd options ALTQ_RED 39.Cd options ALTQ_RIO 40.Cd options ALTQ_HFSC 41.Cd options ALTQ_CDNR 42.Cd options ALTQ_PRIQ 43.Cd options ALTQ_FAIRQ 44.Sh DESCRIPTION 45The 46.Nm 47framework provides several disciplines for queuing outgoing network packets. 48This is done by modifications to the interface packet queues. 49See 50.Xr altq 9 51for details. 52.Pp 53The user interface for 54.Nm 55is implemented by the 56.Xr pfctl 8 57utility, so please refer to the 58.Xr pfctl 8 59and the 60.Xr pf.conf 5 61manpages for a complete description of the 62.Nm 63capabilities and how to use it. 64.Ss Kernel Options 65The following options in the kernel configuration file are related to 66.Nm 67operation: 68.Pp 69.Bl -tag -width ".Dv ALTQ_DEBUG" -compact 70.It Dv ALTQ 71Enable 72.Nm . 73.It Dv ALTQ_CBQ 74Build the 75.Dq "Class Based Queuing" 76discipline. 77.It Dv ALTQ_RED 78Build the 79.Dq "Random Early Detection" 80extension. 81.It Dv ALTQ_RIO 82Build 83.Dq "Random Early Drop" 84for input and output. 85.It Dv ALTQ_HFSC 86Build the 87.Dq "Hierarchical Packet Scheduler" 88discipline. 89.It Dv ALTQ_CDNR 90Build the traffic conditioner. 91This option is meaningless at the moment as the conditioner is not used by 92any of the available disciplines or consumers. 93.It Dv ALTQ_PRIQ 94Build the 95.Dq "Priority Queuing" 96discipline. 97.It Dv ALTQ_FAIRQ 98Build the 99.Dq "Fair Queuing" 100discipline. 101.It Dv ALTQ_NOPCC 102Required if the TSC is unusable. 103.It Dv ALTQ_DEBUG 104Enable additional debugging facilities. 105.El 106.Pp 107Note that 108.Nm Ns -disciplines 109cannot be loaded as kernel modules. 110In order to use a certain discipline you have to build it into a custom 111kernel. 112The 113.Xr pf 4 114interface, that is required for the configuration process of 115.Nm 116can be loaded as a module. 117.Sh SUPPORTED DEVICES 118The driver modifications described in 119.Xr altq 9 120are required to use a certain network card with 121.Nm . 122They have been applied to the following hardware drivers: 123.Xr ae 4 , 124.Xr age 4 , 125.Xr alc 4 , 126.Xr ale 4 , 127.Xr an 4 , 128.Xr ath 4 , 129.Xr aue 4 , 130.Xr axe 4 , 131.Xr bce 4 , 132.Xr bfe 4 , 133.Xr bge 4 , 134.Xr bxe 4 , 135.Xr cas 4 , 136.Xr cxgbe 4 , 137.Xr dc 4 , 138.Xr de 4 , 139.Xr ed 4 , 140.Xr em 4 , 141.Xr ep 4 , 142.Xr epair 4 , 143.Xr et 4 , 144.Xr fxp 4 , 145.Xr gem 4 , 146.Xr hme 4 , 147.Xr igb 4 , 148.Xr ipw 4 , 149.Xr iwi 4 , 150.Xr ixgbe 4 , 151.Xr jme 4 , 152.Xr le 4 , 153.Xr msk 4 , 154.Xr mxge 4 , 155.Xr my 4 , 156.Xr nfe 4 , 157.Xr nge 4 , 158.Xr npe 4 , 159.Xr qlxgb 4 , 160.Xr ral 4 , 161.Xr re 4 , 162.Xr rl 4 , 163.Xr rum 4 , 164.Xr sf 4 , 165.Xr sge 4 , 166.Xr sis 4 , 167.Xr sk 4 , 168.Xr ste 4 , 169.Xr stge 4 , 170.Xr ti 4 , 171.Xr txp 4 , 172.Xr udav 4 , 173.Xr ural 4 , 174.Xr vge 4 , 175.Xr vr 4 , 176.Xr vte 4 , 177.Xr wi 4 , 178and 179.Xr xl 4 . 180.Pp 181The 182.Xr ndis 4 183framework also has support for 184.Nm 185and thus all encapsulated drivers. 186.Pp 187The 188.Xr tun 4 189and 190.Xr ng_iface 4 191pseudo drivers also do support 192.Nm . 193.Sh SEE ALSO 194.Xr pf 4 , 195.Xr pf.conf 5 , 196.Xr ipfw 8 , 197.Xr pfctl 8 , 198.Xr altq 9 199