share/man/man4/altq.4

   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 July 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_CODEL
  39 .Cd options ALTQ_RED
  40 .Cd options ALTQ_RIO
  41 .Cd options ALTQ_HFSC
  42 .Cd options ALTQ_CDNR
  43 .Cd options ALTQ_PRIQ
  44 .Cd options ALTQ_FAIRQ
  45 .Sh DESCRIPTION
  46 The
  47 .Nm
  48 framework provides several disciplines for queuing outgoing network packets.
  49 This is done by modifications to the interface packet queues.
  50 See
  51 .Xr altq 9
  52 for details.
  53 .Pp
  54 The user interface for
  55 .Nm
  56 is implemented by the
  57 .Xr pfctl 8
  58 utility, so please refer to the
  59 .Xr pfctl 8
  60 and the
  61 .Xr pf.conf 5
  62 manpages for a complete description of the
  63 .Nm
  64 capabilities and how to use it.
  65 .Ss Kernel Options
  66 The following options in the kernel configuration file are related to
  67 .Nm
  68 operation:
  69 .Pp
  70 .Bl -tag -width ".Dv ALTQ_DEBUG" -compact
  71 .It Dv ALTQ
  72 Enable
  73 .Nm .
  74 .It Dv ALTQ_CBQ
  75 Build the
  76 .Dq "Class Based Queuing"
  77 discipline.
  78 .It Dv ALTQ_CODEL
  79 Build the
  80 .Dq "Controlled Delay"
  81 discipline.
  82 .It Dv ALTQ_RED
  83 Build the
  84 .Dq "Random Early Detection"
  85 extension.
  86 .It Dv ALTQ_RIO
  87 Build
  88 .Dq "Random Early Drop"
  89 for input and output.
  90 .It Dv ALTQ_HFSC
  91 Build the
  92 .Dq "Hierarchical Packet Scheduler"
  93 discipline.
  94 .It Dv ALTQ_CDNR
  95 Build the traffic conditioner.
  96 This option is meaningless at the moment as the conditioner is not used by
  97 any of the available disciplines or consumers.
  98 .It Dv ALTQ_PRIQ
  99 Build the
 100 .Dq "Priority Queuing"
 101 discipline.
 102 .It Dv ALTQ_FAIRQ
 103 Build the
 104 .Dq "Fair Queuing"
 105 discipline.
 106 .It Dv ALTQ_NOPCC
 107 Required if the TSC is unusable.
 108 .It Dv ALTQ_DEBUG
 109 Enable additional debugging facilities.
 110 .El
 111 .Pp
 112 Note that
 113 .Nm Ns -disciplines
 114 cannot be loaded as kernel modules.
 115 In order to use a certain discipline you have to build it into a custom
 116 kernel.
 117 The
 118 .Xr pf 4
 119 interface, that is required for the configuration process of
 120 .Nm
 121 can be loaded as a module.
 122 .Sh SUPPORTED DEVICES
 123 The driver modifications described in
 124 .Xr altq 9
 125 are required to use a certain network card with
 126 .Nm .
 127 They have been applied to the following hardware drivers:
 128 .Xr ae 4 ,
 129 .Xr age 4 ,
 130 .Xr alc 4 ,
 131 .Xr ale 4 ,
 132 .Xr an 4 ,
 133 .Xr ath 4 ,
 134 .Xr aue 4 ,
 135 .Xr axe 4 ,
 136 .Xr bce 4 ,
 137 .Xr bfe 4 ,
 138 .Xr bge 4 ,
 139 .Xr bxe 4 ,
 140 .Xr cas 4 ,
 141 .Xr cxgbe 4 ,
 142 .Xr dc 4 ,
 143 .Xr de 4 ,
 144 .Xr ed 4 ,
 145 .Xr em 4 ,
 146 .Xr ep 4 ,
 147 .Xr epair 4 ,
 148 .Xr et 4 ,
 149 .Xr fxp 4 ,
 150 .Xr gem 4 ,
 151 .Xr hme 4 ,
 152 .Xr igb 4 ,
 153 .Xr ipw 4 ,
 154 .Xr iwi 4 ,
 155 .Xr ixgbe 4 ,
 156 .Xr jme 4 ,
 157 .Xr le 4 ,
 158 .Xr msk 4 ,
 159 .Xr mxge 4 ,
 160 .Xr my 4 ,
 161 .Xr nfe 4 ,
 162 .Xr nge 4 ,
 163 .Xr npe 4 ,
 164 .Xr nve 4 ,
 165 .Xr qlxgb 4 ,
 166 .Xr ral 4 ,
 167 .Xr re 4 ,
 168 .Xr rl 4 ,
 169 .Xr rum 4 ,
 170 .Xr sf 4 ,
 171 .Xr sge 4 ,
 172 .Xr sis 4 ,
 173 .Xr sk 4 ,
 174 .Xr ste 4 ,
 175 .Xr stge 4 ,
 176 .Xr ti 4 ,
 177 .Xr txp 4 ,
 178 .Xr udav 4 ,
 179 .Xr ural 4 ,
 180 .Xr vge 4 ,
 181 .Xr vr 4 ,
 182 .Xr vte 4 ,
 183 .Xr wi 4 ,
 184 and
 185 .Xr xl 4 .
 186 .Pp
 187 The
 188 .Xr ndis 4
 189 framework also has support for
 190 .Nm
 191 and thus all encapsulated drivers.
 192 .Pp
 193 The
 194 .Xr tun 4
 195 and
 196 .Xr ng_iface 4
 197 pseudo drivers also do support
 198 .Nm .
 199 .Sh SEE ALSO
 200 .Xr pf 4 ,
 201 .Xr pf.conf 5 ,
 202 .Xr ipfw 8 ,
 203 .Xr pfctl 8 ,
 204 .Xr altq 9