1
.TH HTB 8 "10 January 2002" "iproute2" "Linux"
3
HTB \- Hierarchy Token Bucket
34
HTB is meant as a more understandable and intuitive replacement for
35
the CBQ qdisc in Linux. Both CBQ and HTB help you to control the use
36
of the outbound bandwidth on a given link. Both allow you to use one
37
physical link to simulate several slower links and to send different
38
kinds of traffic on different simulated links. In both cases, you have
39
to specify how to divide the physical link into simulated links and
40
how to decide which simulated link to use for a given packet to be sent.
42
Unlike CBQ, HTB shapes traffic based on the Token Bucket Filter algorithm
43
which does not depend on interface characteristics and so does not need to
44
know the underlying bandwidth of the outgoing interface.
47
Shaping works as documented in
51
Within the one HRB instance many classes may exist. Each of these classes
52
contains another qdisc, by default
55
When enqueueing a packet, HTB starts at the root and uses various methods to
56
determine which class should receive the data.
58
In the absence of uncommon configuration options, the process is rather easy.
59
At each node we look for an instruction, and then go to the class the
60
instruction refers us to. If the class found is a barren leaf-node (without
61
children), we enqueue the packet there. If it is not yet a leaf node, we do
62
the whole thing over again starting from that node.
64
The following actions are performed, in order at each node we visit, until one
65
sends us to another node, or terminates the process.
68
Consult filters attached to the class. If sent to a leafnode, we are done.
72
If none of the above returned with an instruction, enqueue at this node.
74
This algorithm makes sure that a packet always ends up somewhere, even while
75
you are busy building your configuration.
77
.SH LINK SHARING ALGORITHM
81
The root of a HTB qdisc class tree has the following parameters:
84
parent major:minor | root
85
This mandatory parameter determines the place of the HTB instance, either at the
87
of an interface or within an existing class.
90
Like all other qdiscs, the HTB can be assigned a handle. Should consist only
91
of a major number, followed by a colon. Optional, but very useful if classes
92
will be generated within this qdisc.
95
Unclassified traffic gets sent to the class with this minor-id.
98
Classes have a host of parameters to configure their operation.
102
Place of this class within the hierarchy. If attached directly to a qdisc
103
and not to another class, minor can be omitted. Mandatory.
106
Like qdiscs, classes can be named. The major number must be equal to the
107
major number of the qdisc to which it belongs. Optional, but needed if this
108
class is going to have children.
111
In the round-robin process, classes with the lowest priority field are tried
112
for packets first. Mandatory.
116
Maximum rate this class and all its children are guaranteed. Mandatory.
120
Maximum rate at which a class can send, if its parent has bandwidth to spare.
121
Defaults to the configured rate, which implies no borrowing
125
Amount of bytes that can be burst at
127
speed, in excess of the configured
129
Should be at least as high as the highest burst of all children.
133
Amount of bytes that can be burst at 'infinite' speed, in other words, as fast
134
as the interface can transmit them. For perfect evening out, should be equal to at most one average
135
packet. Should be at least as high as the highest cburst of all children.
138
Due to Unix timing constraints, the maximum ceil rate is not infinite and may in fact be quite low. On Intel,
139
there are 100 timer events per second, the maximum rate is that rate at which 'burst' bytes are sent each timer tick.
140
From this, the mininum burst size for a specified rate can be calculated. For i386, a 10mbit rate requires a 12 kilobyte
141
burst as 100*12kb*8 equals 10mbit.
146
HTB website: http://luxik.cdi.cz/~devik/qos/htb/
148
Martin Devera <devik@cdi.cz>. This manpage maintained by bert hubert <ahu@ds9a.nl>