2 .\" Copyright (c) 2004 Max Laier <mlaier@FreeBSD.org>
3 .\" All rights reserved.
5 .\" Redistribution and use in source and binary forms, with or without
6 .\" modification, are permitted provided that the following conditions
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.
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
33 .Nd "alternate queuing of network packets"
38 .Cd options ALTQ_CODEL
44 .Cd options ALTQ_FAIRQ
48 system is a framework which provides several disciplines for queuing outgoing
50 This is done by modifications to the interface packet queues.
55 The user interface for
59 utility, so please refer to the
63 man pages for a complete description of the
65 capabilities and how to use it.
67 The following options in the kernel configuration file are related to
71 .Bl -tag -width ".Dv ALTQ_DEBUG" -compact
77 .Dq "Class Based Queuing"
81 .Dq "Controlled Delay"
85 .Dq "Random Early Detection"
89 .Dq "Random Early Drop"
93 .Dq "Hierarchical Packet Scheduler"
96 Build the traffic conditioner.
97 This option is meaningless at the moment as the conditioner is not used by
98 any of the available disciplines or consumers.
101 .Dq "Priority Queuing"
108 Required if the TSC is unusable.
110 Enable additional debugging facilities.
115 cannot be loaded as kernel modules.
116 In order to use a certain discipline you have to build it into a custom
120 interface, that is required for the configuration process of
122 can be loaded as a module.
123 .Sh SUPPORTED DEVICES
124 The driver modifications described in
126 are required to use a certain network card with
128 They have been applied to the following hardware drivers:
179 pseudo drivers also do support
184 driver does not directly support
186 but as packets (mbufs) are passed to the underlying interface, a queue
187 can be defined for the underlying interface, and any packets directed
188 to the queue will be processed at the interface level.
190 .Bd -literal -offset indent
191 altq on igb0 cbq queue { def aq }
192 queue def bandwidth 90% cbq (default borrow)
193 queue aq bandwidth 10Mb cbq
195 pass in on igb0.10 proto udp all queue aq keep state
206 system first appeared in March 1997 and found home in the KAME project
207 (https://www.kame.net).