xref: /dflybsd-src/share/man/man4/altq.4 (revision 86d7f5d305c6adaa56ff4582ece9859d73106103)

.\"
.\" Copyright (c) 2004 Max Laier <mlaier@FreeBSD.org>
.\" All rights reserved.
.\"
.\" Redistribution and use in source and binary forms, with or without
.\" modification, are permitted provided that the following conditions
.\" are met:
.\" 1. Redistributions of source code must retain the above copyright
.\"    notice, this list of conditions and the following disclaimer.
.\" 2. Redistributions in binary form must reproduce the above copyright
.\"    notice, this list of conditions and the following disclaimer in the
.\"    documentation and/or other materials provided with the distribution.
.\"
.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
.\" SUCH DAMAGE.
.\"
.\" $FreeBSD: src/share/man/man4/altq.4,v 1.16 2006/03/02 19:45:59 thompsa Exp $
.\" $DragonFly: src/share/man/man4/altq.4,v 1.5 2008/04/06 19:29:47 swildner Exp $
.\"
.Dd April 6, 2008
.Dt ALTQ 4
.Os
.Sh NAME
.Nm ALTQ
.Nd "alternate queuing of network packets"
.Sh SYNOPSIS
.Cd options ALTQ
.Pp
.Cd options ALTQ_CBQ
.Cd options ALTQ_RED
.Cd options ALTQ_RIO
.Cd options ALTQ_HFSC
.\".Cd options ALTQ_CDNR
.Cd options ALTQ_PRIQ
.Cd options ALTQ_FAIRQ
.Cd options ALTQ_NOPCC
.Cd options ALTQ_DEBUG
.Sh DESCRIPTION
The
.Nm
framework provides several disciplines for queuing outgoing network packets.
This is done by modifications to the interface packet queues.
See
.Xr altq 9
for details.
.Pp
The user interface for
.Nm
is implemented by the
.Xr pfctl 8
utility, so please refer to the
.Xr pfctl 8
and the
.Xr pf.conf 5
manpages for a complete description of the
.Nm
capabilities and how to use it.
.Ss Kernel Options
The following options in the kernel configuration file are related to
.Nm
operation:
.Pp
.Bl -tag -width ".Dv ALTQ_DEBUG" -compact
.It Dv ALTQ
Enable
.Nm .
.It Dv ALTQ_CBQ
Build the
.Dq "Class Based Queuing"
discipline.
.It Dv ALTQ_RED
Build the
.Dq "Random Early Detection"
extension.
.It Dv ALTQ_RIO
Build
.Dq "Random Early Drop"
for input and output.
.It Dv ALTQ_HFSC
Build the
.Dq "Hierarchical Packet Scheduler"
discipline.
.\".It Dv ALTQ_CDNR
.\"Build the traffic conditioner.
.\"This option is meaningless at the moment as the conditioner is not used by
.\"any of the available disciplines or consumers.
.It Dv ALTQ_PRIQ
Build the
.Dq "Priority Queuing"
discipline.
.It Dv ALTQ_FAIRQ
Build the
.Dq "Fair Queuing"
discipline.
.It Dv ALTQ_NOPCC
Required if the TSC is unusable.
.It Dv ALTQ_DEBUG
Enable additional debugging facilities.
.El
.Pp
Note that
.Nm Ns -disciplines
cannot be loaded as kernel modules.
In order to use a certain discipline you have to build it into a custom
kernel.
The
.Xr pf 4
interface, that is required for the configuration process of
.Nm
can be loaded as a module.
.Sh SEE ALSO
.Xr pf 4 ,
.Xr pf.conf 5 ,
.Xr ipfw 8 ,
.Xr pfctl 8 ,
.Xr altq 9