Blame man/man8/tc-hfsc.8

Packit d3f73b
.TH HFSC 8 "31 October 2011" iproute2 Linux
Packit d3f73b
.
Packit d3f73b
.SH NAME
Packit d3f73b
HFSC \- Hierarchical Fair Service Curve's control under linux
Packit d3f73b
.
Packit d3f73b
.SH SYNOPSIS
Packit d3f73b
.nf
Packit d3f73b
tc qdisc add ... hfsc [ \fBdefault\fR CLASSID ]
Packit d3f73b
Packit d3f73b
tc class add ... hfsc [ [ \fBrt\fR SC ] [ \fBls\fR SC ] | [ \fBsc\fR SC ] ] [ \fBul\fR SC ]
Packit d3f73b
Packit d3f73b
\fBrt\fR : realtime service curve
Packit d3f73b
\fBls\fR : linkshare service curve
Packit d3f73b
\fBsc\fR : rt+ls service curve
Packit d3f73b
\fBul\fR : upperlimit service curve
Packit d3f73b
Packit d3f73b
\(bu at least one of \fBrt\fR, \fBls\fR or \fBsc\fR must be specified
Packit d3f73b
\(bu \fBul\fR can only be specified with \fBls\fR or \fBsc\fR
Packit d3f73b
.
Packit d3f73b
.IP "SC := [ [ \fBm1\fR BPS ] \fBd\fR SEC ] \fBm2\fR BPS"
Packit d3f73b
\fBm1\fR : slope of the first segment
Packit d3f73b
\fBd\fR  : x\-coordinate of intersection
Packit d3f73b
\fBm2\fR : slope of the second segment
Packit d3f73b
.PP
Packit d3f73b
.IP "SC := [ [ \fBumax\fR BYTE ] \fBdmax\fR SEC ] \fBrate\fR BPS"
Packit d3f73b
\fBumax\fR : maximum unit of work
Packit d3f73b
\fBdmax\fR : maximum delay
Packit d3f73b
\fBrate\fR : rate
Packit d3f73b
.PP
Packit d3f73b
.fi
Packit d3f73b
For description of BYTE, BPS and SEC \- please see \fBUNITS\fR
Packit d3f73b
section of \fBtc\fR(8).
Packit d3f73b
.
Packit d3f73b
.SH DESCRIPTION (qdisc)
Packit d3f73b
HFSC qdisc has only one optional parameter \- \fBdefault\fR. CLASSID specifies
Packit d3f73b
the minor part of the default classid, where packets not classified by other
Packit d3f73b
means (e.g. u32 filter, CLASSIFY target of iptables) will be enqueued. If
Packit d3f73b
\fBdefault\fR is not specified, unclassified packets will be dropped.
Packit d3f73b
.
Packit d3f73b
.SH DESCRIPTION (class)
Packit d3f73b
HFSC class is used to create a class hierarchy for HFSC scheduler. For
Packit d3f73b
explanation of the algorithm, and the meaning behind \fBrt\fR, \fBls\fR,
Packit d3f73b
\fBsc\fR and \fBul\fR service curves \- please refer to \fBtc\-hfsc\fR(7).
Packit d3f73b
Packit d3f73b
As you can see in \fBSYNOPSIS\fR, service curve (SC) can be specified in two
Packit d3f73b
ways. Either as maximum delay for certain amount of work, or as a bandwidth
Packit d3f73b
assigned for certain amount of time. Obviously, \fBm1\fR is simply
Packit d3f73b
\fBumax\fR/\fBdmax\fR.
Packit d3f73b
Packit d3f73b
Both \fBm2\fR and \fBrate\fR are mandatory. If you omit other
Packit d3f73b
parameters, you will specify linear service curve.
Packit d3f73b
.
Packit d3f73b
.SH "SEE ALSO"
Packit d3f73b
.
Packit d3f73b
\fBtc\fR(8), \fBtc\-hfsc\fR(7), \fBtc\-stab\fR(8)
Packit d3f73b
Packit d3f73b
Please direct bugreports and patches to: <netdev@vger.kernel.org>
Packit d3f73b
.
Packit d3f73b
.SH "AUTHOR"
Packit d3f73b
.
Packit d3f73b
Manpage created by Michal Soltys (soltys@ziu.info)